View Javadoc

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.audit;
35  
36  import info.magnolia.cms.core.ItemType;
37  import info.magnolia.cms.security.UserManager;
38  import info.magnolia.cms.security.auth.login.FormLogin;
39  import info.magnolia.cms.security.auth.login.LoginResult;
40  import info.magnolia.context.MgnlContext;
41  import info.magnolia.context.UserContext;
42  
43  import javax.jcr.nodetype.NodeType;
44  import javax.servlet.http.HttpServletRequest;
45  
46  /**
47   * Utilities class used to log 'auditory actions'.
48   *
49   * @author tmiyar
50   */
51  public class AuditLoggingUtil {
52  
53      public static final String ACTION_CREATE = "create";
54      public static final String ACTION_MODIFY = "modify";
55      public static final String ACTION_DELETE = "delete";
56      public static final String ACTION_COPY = "copy";
57      public static final String ACTION_MOVE = "move";
58      public static final String ACTION_ACTIVATE = "activate";
59      public static final String ACTION_DEACTIVATE = "deactivate";
60      public static final String ACTION_LOGIN = "login";
61      public static final String ACTION_LOGOUT = "logout";
62      public static final String ACTION_SECURITY = "security";
63  
64      /**
65       * Log activate, deactivate incl. node type.
66       *
67       * @deprecated since 4.5, use {@link #log(String, String, NodeType, String)} instead.
68       */
69      @Deprecated
70      public static void log(String action, String workspaceName, ItemType nodeType, String nodePath) {
71          AuditLoggingUtil.log(action, new String[]{AuditLoggingUtil.getUser(), workspaceName, nodeType == null ? "" : nodeType.getSystemName(), nodePath});
72      }
73  
74      /**
75       * Log activate, deactivate incl. node type.
76       */
77      public static void log(String action, String workspaceName, NodeType nodeType, String nodePath) {
78          AuditLoggingUtil.log(action, new String[] { AuditLoggingUtil.getUser(), workspaceName, nodeType == null ? "" : nodeType.getName(), nodePath });
79      }
80  
81      /**
82       * Log copy, move.
83       */
84      public static void log(String action, String workspaceName, String nodePathFrom, String nodePathTo ) {
85          AuditLoggingUtil.log(action, new String[]{AuditLoggingUtil.getUser(), workspaceName, nodePathFrom, nodePathTo});
86      }
87  
88      /**
89       * Log create, modify, delete and move in session.
90       */
91      public static void log(String action, long timeStamp, String workspaceName, NodeType nodeType, String path, String pathTo) {
92          AuditLoggingUtil.log(action, new String[] { String.valueOf(timeStamp), AuditLoggingUtil.getUser(), workspaceName, nodeType == null ? "" : nodeType.getName(), path, pathTo == null ? "" : pathTo });
93      }
94  
95      /**
96       * Log copy to another workspace.
97       */
98      public static void log(String action, String workspaceFrom, String workspaceTo, String nodePathFrom, String nodePathTo) {
99          AuditLoggingUtil.log(action, new String[] { AuditLoggingUtil.getUser(), workspaceFrom, workspaceTo, nodePathFrom, nodePathTo });
100     }
101 
102     /**
103      * Log user logout.
104      */
105     public static void log(final UserContext userContext ) {
106         AuditLoggingUtil.log(AuditLoggingUtil.ACTION_LOGOUT, null, (String) null, null);
107     }
108 
109     /**
110      * Log user login.
111      */
112     public static void log(final LoginResult loginResult, final HttpServletRequest request ) {
113         if(loginResult.getStatus() == LoginResult.STATUS_SUCCEEDED || loginResult.getStatus() == LoginResult.STATUS_FAILED) {
114             // need request as if the user is not logged yet, the id is not in the context
115             String userid = request.getParameter(FormLogin.PARAMETER_USER_ID);
116             if (UserManager.ANONYMOUS_USER.equals(userid)) {
117                 // do not log for anonymous
118                 return;
119             }
120 
121             String result;
122             if(loginResult.getStatus() == LoginResult.STATUS_SUCCEEDED) {
123                 result = "Success";
124             } else {
125                 result = "Failure " + loginResult.getLoginException().getLocalizedMessage();
126             }
127             AuditLoggingUtil.log(AuditLoggingUtil.ACTION_LOGIN, new String[]{userid, request.getRemoteAddr(), result});
128         }
129 
130     }
131 
132     /**
133      * Log a security event.
134      */
135     public static void logSecurity(String ipAddress, String securityEventType, String securityEventdetails) {
136         AuditLoggingUtil.log(AuditLoggingUtil.ACTION_SECURITY, new String[]{getUser(), ipAddress, securityEventType, securityEventdetails});
137     }
138 
139     private static void log(String action, String[] data) {
140         AuditLoggingManager manager = AuditLoggingManager.getInstance();
141         if(manager != null) {
142             manager.log(action, data);
143         }
144     }
145 
146     private static String getUser() {
147         if (MgnlContext.isSystemInstance()) {
148             return "SystemUser";
149         }
150         try {
151             if(MgnlContext.hasInstance() && MgnlContext.getUser() != null) {
152                 return MgnlContext.getUser().getName();
153             }
154         }catch (Exception e) {
155             return "system user";
156         }
157         return "user not set";
158     }
159 
160 }