View Javadoc
1   /**
2    * This file Copyright (c) 2003-2015 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.objectfactory.Components;
37  
38  import java.util.ArrayList;
39  import java.util.Iterator;
40  import java.util.List;
41  
42  import org.apache.commons.lang3.StringUtils;
43  import org.slf4j.Logger;
44  import org.slf4j.LoggerFactory;
45  
46  /**
47   * Class for auditory logging, it's optional to define it, configured in mgnl-beans.properties.
48   */
49  public class AuditLoggingManager {
50  
51      private List<LogConfiguration> logConfigurations = new ArrayList<LogConfiguration>();
52  
53      private String defaultSeparator = ", ";
54  
55      private static Logger applog = LoggerFactory.getLogger(AuditLoggingManager.class);
56  
57      public static AuditLoggingManager getInstance() {
58          try {
59              return Components.getComponent(AuditLoggingManager.class);
60          } catch (Exception e) {
61              // if not defined skip and return null
62              applog.info("Class AuditLoggingManager not defined");
63              return null;
64          }
65      }
66  
67      public void addLogConfigurations(LogConfiguration action) {
68          this.logConfigurations.add(action);
69      }
70  
71      public List<LogConfiguration> getLogConfigurations() {
72          return logConfigurations;
73      }
74  
75      public void setLogConfigurations(List<LogConfiguration> logConfigurations) {
76          this.logConfigurations = logConfigurations;
77      }
78  
79      public LogConfiguration getLogConfiguration(String action) {
80          Iterator<LogConfiguration> iterator = this.logConfigurations.iterator();
81          while (iterator.hasNext()) {
82              final LogConfiguration trail = iterator.next();
83              if (StringUtils.equals(trail.getName(), action)) {
84                  return trail;
85              }
86          }
87          return null;
88      }
89  
90      /**
91       * AuditLogging is active when at least one of log configurations is active.
92       */
93      public boolean isAuditLoggingActive() {
94          Iterator<LogConfiguration> iterator = this.logConfigurations.iterator();
95          while (iterator.hasNext()) {
96              final LogConfiguration trail = iterator.next();
97              if (trail.isActive()) {
98                  return true;
99              }
100         }
101         return false;
102     }
103 
104     public void log(String action, String[] data) {
105         StringBuilder message = new StringBuilder();
106         LogConfiguration trail = this.getLogConfiguration(action);
107         if (trail == null) {
108             applog.trace("Can't get log configuration");
109         } else {
110             String separator = defaultSeparator;
111             if (!StringUtils.isEmpty(trail.getSeparator())) {
112                 separator = trail.getSeparator();
113             }
114             message.append(separator).append(action);
115             if (trail.isActive()) {
116                 for (int i = 0; i < data.length; i++) {
117                     if (StringUtils.isNotEmpty(data[i])) {
118                         message.append(separator).append(data[i]);
119                     }
120 
121                 }
122                 org.apache.log4j.Logger.getLogger(trail.getLogName()).log(LoggingLevel.AUDIT_TRAIL, message.toString());
123             }
124         }
125     }
126 
127     public String getDefaultSeparator() {
128         return defaultSeparator;
129     }
130 
131     public void setDefaultSeparator(String defaultSeparator) {
132         this.defaultSeparator = defaultSeparator;
133     }
134 }