1 /**
2 * This file Copyright (c) 2003-2011 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.context;
35
36 import info.magnolia.cms.security.PrincipalUtil;
37 import info.magnolia.cms.security.Security;
38 import info.magnolia.cms.security.User;
39 import info.magnolia.cms.security.UserManager;
40
41 import java.util.Locale;
42
43 import javax.security.auth.Subject;
44
45 import org.apache.commons.lang.LocaleUtils;
46
47 /**
48 * User aware context implementation able to release and discard all kept info upon user logout. Also changes the locale
49 * from default one to the one preferred by the logged in user. Sets the Subject for the logged in user in session for
50 * subsequent requests to pick up. When no user has logged in this class returns the anonymous user.
51 *
52 * @version $Id$
53 */
54 public class UserContextImpl extends AbstractContext implements UserContext {
55
56 private static final long serialVersionUID = 222L;
57
58 private static final String SESSION_SUBJECT = Subject.class.getName();
59
60 private User user;
61 private Subject subject;
62
63 public UserContextImpl() {
64
65 }
66
67 @Override
68 public Locale getLocale() {
69 if (locale == null) {
70 setLocaleFor(getUser());
71 }
72 return locale;
73 }
74
75 @Override
76 public User getUser() {
77 if (user != null) {
78 return user;
79 }
80
81 user = PrincipalUtil.findPrincipal(getSubject(), User.class);
82 if (user == null) {
83 throw new IllegalStateException("Subject must have a info.magnolia.cms.security.User principal.");
84 }
85 return user;
86 }
87
88 @Override
89 public Subject getSubject() {
90 if (subject != null) {
91 return this.subject;
92 }
93
94 // were we logged in by a previous request?
95 subject = (Subject) getAttribute(SESSION_SUBJECT, Context.SESSION_SCOPE);
96 if (subject != null) {
97 return this.subject;
98 }
99
100 // default to anonymous user
101 login(Security.getAnonymousSubject());
102 return subject;
103 }
104
105 @Override
106 public void login(Subject subject) {
107 User user = PrincipalUtil.findPrincipal(subject, User.class);
108 if (user == null) {
109 throw new IllegalArgumentException("When logging in the Subject must have a info.magnolia.cms.security.User principal.");
110 }
111 this.subject = subject;
112 this.user = user;
113 setLocaleFor(user);
114 // set the subject in session for subsequent requests
115 if (!user.getName().equals(UserManager.ANONYMOUS_USER)) {
116 setAttribute(SESSION_SUBJECT, subject, Context.SESSION_SCOPE);
117 }
118 }
119
120 @Override
121 public void logout() {
122 subject = null;
123 user = null;
124 locale = null;
125 removeAttribute(SESSION_SUBJECT, Context.SESSION_SCOPE);
126 }
127
128 protected void setLocaleFor(User user) {
129 // despite this property being called "language", it sometimes contains the country (i.e. fr_CH), so we need to parse it
130 final String userLanguage = user.getLanguage();
131 setLocale(LocaleUtils.toLocale(userLanguage));
132 }
133
134 }