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