View Javadoc

1   /**
2    * This file Copyright (c) 2003-2012 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  
63      /**
64       * Log activate, deactivate incl. node type.
65       *
66       * @deprecated since 4.5, use {@link #log(String, String, NodeType, String)} instead.
67       */
68      @Deprecated
69      public static void log(String action, String workspaceName, ItemType nodeType, String nodePath) {
70          AuditLoggingUtil.log(action, new String[]{AuditLoggingUtil.getUser(), workspaceName, nodeType == null ? "" : nodeType.getSystemName(), nodePath});
71      }
72  
73      /**
74       * Log activate, deactivate incl. node type.
75       */
76      public static void log(String action, String workspaceName, NodeType nodeType, String nodePath) {
77          AuditLoggingUtil.log(action, new String[] { AuditLoggingUtil.getUser(), workspaceName, nodeType == null ? "" : nodeType.getName(), nodePath });
78      }
79  
80      /**
81       * Log copy, move.
82       */
83      public static void log(String action, String workspaceName, String nodePathFrom, String nodePathTo ) {
84          AuditLoggingUtil.log(action, new String[]{AuditLoggingUtil.getUser(), workspaceName, nodePathFrom, nodePathTo});
85      }
86  
87      /**
88       * Log create, modify, delete and move in session.
89       */
90      public static void log(String action, long timeStamp, String workspaceName, NodeType nodeType, String path, String pathTo) {
91          AuditLoggingUtil.log(action, new String[] { String.valueOf(timeStamp), AuditLoggingUtil.getUser(), workspaceName, nodeType == null ? "" : nodeType.getName(), path, pathTo == null ? "" : pathTo });
92      }
93  
94      /**
95       * Log copy to another workspace.
96       */
97      public static void log(String action, String workspaceFrom, String workspaceTo, String nodePathFrom, String nodePathTo) {
98          AuditLoggingUtil.log(action, new String[] { AuditLoggingUtil.getUser(), workspaceFrom, workspaceTo, nodePathFrom, nodePathTo });
99      }
100 
101     /**
102      * Log user logout.
103      */
104     public static void log(final UserContext userContext ) {
105         AuditLoggingUtil.log(AuditLoggingUtil.ACTION_LOGOUT, null, (String) null, null);
106     }
107 
108     /**
109      * Log user login.
110      */
111     public static void log(final LoginResult loginResult, final HttpServletRequest request ) {
112         if(loginResult.getStatus() == LoginResult.STATUS_SUCCEEDED || loginResult.getStatus() == LoginResult.STATUS_FAILED) {
113             // need request as if the user is not logged yet, the id is not in the context
114             String userid = request.getParameter(FormLogin.PARAMETER_USER_ID);
115             if (UserManager.ANONYMOUS_USER.equals(userid)) {
116                 // do not log for anonymous
117                 return;
118             }
119 
120             String result;
121             if(loginResult.getStatus() == LoginResult.STATUS_SUCCEEDED) {
122                 result = "Success";
123             } else {
124                 result = "Failure " + loginResult.getLoginException().getLocalizedMessage();
125             }
126             AuditLoggingUtil.log(AuditLoggingUtil.ACTION_LOGIN, new String[]{userid, request.getRemoteAddr(), result});
127         }
128 
129     }
130 
131     private static void log(String action, String[] data) {
132         AuditLoggingManager manager = AuditLoggingManager.getInstance();
133         if(manager != null) {
134             manager.log(action, data);
135         }
136     }
137 
138     private static String getUser() {
139         if (MgnlContext.isSystemInstance()) {
140             return "SystemUser";
141         }
142         try {
143             if(MgnlContext.hasInstance() && MgnlContext.getUser() != null) {
144                 return MgnlContext.getUser().getName();
145             }
146         }catch (Exception e) {
147             return "system user";
148         }
149         return "user not set";
150     }
151 
152 }