1 /**
2 * This file Copyright (c) 2003-2014 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.cms.security;
35
36 import java.util.Date;
37
38 import javax.servlet.http.HttpServletRequest;
39 import javax.servlet.http.HttpSession;
40
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
43 import info.magnolia.context.MgnlContext;
44
45
46 /**
47 * Used to lock a session or the system. Currently checked in the {@link URISecurityFilter}. Should
48 * only be used with care.
49 * @version $Revision$ ($Author$)
50 */
51 public final class Lock {
52
53 private static Logger log = LoggerFactory.getLogger(Lock.class);
54
55 /**
56 * Session lock attribute.
57 */
58 private static final String SESSION_LOCK = "mgnlSessionLock"; //$NON-NLS-1$
59
60 /**
61 * System wide lock.
62 */
63 private static boolean isSystemLocked;
64
65 /**
66 * System wide lock creation time.
67 */
68 private static Date lockSetDate;
69
70 /**
71 * Utility class, don't instantiate.
72 */
73 private Lock() {
74 // unused
75 }
76
77 /**
78 * Set session based lock.
79 * @param request
80 */
81 public static void setSessionLock(HttpServletRequest request) {
82 log.info("Session lock enabled for user ( " //$NON-NLS-1$
83 + MgnlContext.getUser().getName()
84 + " ) on " //$NON-NLS-1$
85 + (new Date()).toString());
86 // @todo IMPORTANT remove use of http session
87 HttpSession httpsession = request.getSession(true);
88 httpsession.setAttribute(SESSION_LOCK, (new Date()).toString());
89 }
90
91 /**
92 * Returns true if this session is locked.
93 * @param request
94 * @return a boolean
95 */
96 public static boolean isSessionLocked(HttpServletRequest request) {
97 // @todo IMPORTANT remove use of http session
98 if (request.getSession(true).getAttribute(Lock.SESSION_LOCK) != null) {
99 return true;
100 }
101 return false;
102 }
103
104 /**
105 * Reset session lock.
106 * @param request
107 */
108 public static void resetSessionLock(HttpServletRequest request) {
109 if (!Lock.isSessionLocked(request)) {
110 if (log.isDebugEnabled()) {
111 log.debug("No Lock found to reset"); //$NON-NLS-1$
112 }
113 }
114 else {
115 if (log.isDebugEnabled()) {
116 log.debug("Resetting session lock"); //$NON-NLS-1$
117 }
118 Lock.isSystemLocked = false;
119 }
120 // @todo IMPORTANT remove use of http session
121 HttpSession httpsession = request.getSession(true);
122 httpsession.removeAttribute(Lock.SESSION_LOCK);
123 }
124
125 /**
126 * Set system wide lock.
127 */
128 public static void setSystemLock() {
129 if (Lock.isSystemLocked()) {
130 if (log.isDebugEnabled()) {
131 log.debug("System lock exist, created on " + Lock.lockSetDate.toString()); //$NON-NLS-1$
132 }
133 }
134 else {
135 Lock.isSystemLocked = true;
136 Lock.lockSetDate = new Date();
137 if (log.isDebugEnabled()) {
138 log.debug("New System lock created on " + Lock.lockSetDate.toString() + " )"); //$NON-NLS-1$
139 }
140 }
141 }
142
143 /**
144 * Reset system wide lock.
145 */
146 public static void resetSystemLock() {
147 if (!Lock.isSystemLocked()) {
148 log.debug("No Lock found to reset"); //$NON-NLS-1$
149 }
150 else {
151 if (log.isDebugEnabled()) {
152 log.debug("Resetting system lock created on " + Lock.lockSetDate.toString()); //$NON-NLS-1$
153 }
154 Lock.isSystemLocked = false;
155 }
156 }
157
158 /**
159 * Return true if system is locked.
160 * @return a boolean
161 */
162 public static boolean isSystemLocked() {
163 return Lock.isSystemLocked;
164 }
165 }