1 /**
2 * This file Copyright (c) 2003-2018 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.lang3.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 public class UserContextImpl extends AbstractContext implements UserContext {
53
54 private static final String SESSION_SUBJECT = Subject.class.getName();
55
56 private User user;
57 private Subject subject;
58
59 public UserContextImpl() {
60
61 }
62
63 @Override
64 public Locale getLocale() {
65 if (locale == null) {
66 setLocaleFor(getUser());
67 }
68 return locale;
69 }
70
71 @Override
72 public User getUser() {
73 if (user != null) {
74 return user;
75 }
76
77 user = PrincipalUtil.findPrincipal(getSubject(), User.class);
78 if (user == null) {
79 throw new IllegalStateException("Subject must have a info.magnolia.cms.security.User principal.");
80 }
81 return user;
82 }
83
84 @Override
85 public Subject getSubject() {
86 if (subject != null) {
87 return this.subject;
88 }
89
90 // were we logged in by a previous request?
91 subject = (Subject) getAttribute(SESSION_SUBJECT, Context.SESSION_SCOPE);
92 if (subject != null) {
93 return this.subject;
94 }
95
96 // default to anonymous user
97 login(Security.getAnonymousSubject());
98 return subject;
99 }
100
101 @Override
102 public void login(Subject subject) {
103 User user = PrincipalUtil.findPrincipal(subject, User.class);
104 if (user == null) {
105 throw new IllegalArgumentException("When logging in the Subject must have a info.magnolia.cms.security.User principal.");
106 }
107 this.subject = subject;
108 this.user = user;
109 setLocaleFor(user);
110 // set the subject in session for subsequent requests
111 if (!user.getName().equals(UserManager.ANONYMOUS_USER)) {
112 setAttribute(SESSION_SUBJECT, subject, Context.SESSION_SCOPE);
113 }
114 }
115
116 @Override
117 public void logout() {
118 subject = null;
119 user = null;
120 locale = null;
121 removeAttribute(SESSION_SUBJECT, Context.SESSION_SCOPE);
122 }
123
124 protected void setLocaleFor(User user) {
125 // despite this property being called "language", it sometimes contains the country (i.e. fr_CH), so we need to parse it
126 final String userLanguage = user.getLanguage();
127 setLocale(LocaleUtils.toLocale(userLanguage));
128 }
129
130 }