View Javadoc

1   /**
2    * This file Copyright (c) 2003-2010 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.logging;
35  
36  import javax.servlet.http.HttpServletRequest;
37  
38  import info.magnolia.cms.core.ItemType;
39  import info.magnolia.cms.security.auth.login.FormLogin;
40  import info.magnolia.cms.security.auth.login.LoginResult;
41  import info.magnolia.context.MgnlContext;
42  import info.magnolia.context.UserContext;
43  
44  /**
45   * Should be used to log 'auditory actions'
46   * @author tmiyar
47   *
48   */
49  public class AuditLoggingUtil {
50  
51      public static final String ACTION_CREATE = "create";
52      public static final String ACTION_MODIFY = "modify";
53      public static final String ACTION_DELETE = "delete";
54      public static final String ACTION_COPY = "copy";
55      public static final String ACTION_MOVE = "move";
56      public static final String ACTION_ACTIVATE = "activate";
57      public static final String ACTION_DEACTIVATE = "deactivate";
58      public static final String ACTION_LOGIN = "login";
59      public static final String ACTION_LOGOUT = "logout";
60  
61      /**
62       * log create, modify, activate, deactivate, delete incl. node type
63       */
64      public static void log(String action, String workspaceName, ItemType nodeType, String nodePath) {
65          AuditLoggingUtil.log(action, new String[]{AuditLoggingUtil.getUser(), workspaceName, nodeType == null ? "" : nodeType.getSystemName(), nodePath});
66      }
67  
68      /**
69       * log copy, move
70       */
71      public static void log(String action, String workspaceName, String nodePathFrom, String nodePathTo ) {
72          AuditLoggingUtil.log(action, new String[]{AuditLoggingUtil.getUser(), workspaceName, nodePathFrom, nodePathTo});
73      }
74  
75      /**
76       * log user logout
77       */
78      public static void log(final UserContext userContext ) {
79          AuditLoggingUtil.log(AuditLoggingUtil.ACTION_LOGOUT, null, (String) null, null);
80      }
81  
82      /**
83       * log user login
84       */
85      public static void log(final LoginResult loginResult, final HttpServletRequest request ) {
86          String userid = "";
87          String result = "";
88          if(loginResult.getStatus() == LoginResult.STATUS_SUCCEEDED
89                  || loginResult.getStatus() == LoginResult.STATUS_FAILED) {
90              //need request as if the user is not logged yet, the id is not in the context
91              userid = request.getParameter(FormLogin.PARAMETER_USER_ID);
92  
93              if(loginResult.getStatus() == LoginResult.STATUS_SUCCEEDED) {
94                  result = "Success";
95              } else {
96                  result = "Failure " + loginResult.getLoginException().getLocalizedMessage();
97              }
98              AuditLoggingUtil.log(AuditLoggingUtil.ACTION_LOGIN, new String[]{userid, request.getRemoteAddr(), result});
99          }
100 
101     }
102 
103     private static void log(String action, String[] data) {
104         AuditLoggingManager manager = AuditLoggingManager.getInstance();
105         if(manager != null) {
106             manager.log(action, data);
107         }
108     }
109 
110     private static String getUser() {
111         if (MgnlContext.isSystemInstance()) {
112             return "SystemUser";
113         }
114         try {
115             if(MgnlContext.hasInstance() && MgnlContext.getUser() != null) {
116                 return MgnlContext.getUser().getName();
117             }
118         }catch (Exception e) {
119             return "system user";
120         }
121         return "user not set";
122     }
123 
124 }