NodeLogger.java

   1 /*
   2  * Copyright (C) 2007-2012 Argeo GmbH
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *         http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.argeo.cms.internal.kernel;
  17
  18 import java.security.SignatureException;
  19 import java.util.ArrayList;
  20 import java.util.Collections;
  21 import java.util.Enumeration;
  22 import java.util.HashMap;
  23 import java.util.Iterator;
  24 import java.util.LinkedList;
  25 import java.util.List;
  26 import java.util.ListIterator;
  27 import java.util.Map;
  28 import java.util.Properties;
  29 import java.util.concurrent.BlockingQueue;
  30 import java.util.concurrent.LinkedBlockingQueue;
  31
  32 import org.apache.commons.logging.Log;
  33 import org.apache.commons.logging.LogFactory;
  34 import org.apache.log4j.AppenderSkeleton;
  35 import org.apache.log4j.Level;
  36 import org.apache.log4j.LogManager;
  37 import org.apache.log4j.Logger;
  38 import org.apache.log4j.PropertyConfigurator;
  39 import org.apache.log4j.spi.LoggingEvent;
  40 import org.argeo.cms.CmsException;
  41 import org.argeo.cms.auth.CurrentUser;
  42 import org.argeo.node.ArgeoLogListener;
  43 import org.argeo.node.ArgeoLogger;
  44 import org.argeo.node.NodeConstants;
  45 import org.argeo.osgi.useradmin.UserAdminConf;
  46 import org.osgi.framework.Constants;
  47 import org.osgi.framework.ServiceReference;
  48 import org.osgi.service.cm.ConfigurationAdmin;
  49 import org.osgi.service.log.LogEntry;
  50 import org.osgi.service.log.LogListener;
  51 import org.osgi.service.log.LogReaderService;
  52 import org.osgi.service.log.LogService;
  53
  54 /** Not meant to be used directly in standard log4j config */
  55 class NodeLogger implements ArgeoLogger, LogListener {
  56
  57         private Boolean disabled = false;
  58
  59         private String level = null;
  60
  61         private Level log4jLevel = null;
  62         // private Layout layout;
  63
  64         private Properties configuration;
  65
  66         private AppenderImpl appender;
  67
  68         private final List<ArgeoLogListener> everythingListeners = Collections
  69                         .synchronizedList(new ArrayList<ArgeoLogListener>());
  70         private final List<ArgeoLogListener> allUsersListeners = Collections
  71                         .synchronizedList(new ArrayList<ArgeoLogListener>());
  72         private final Map<String, List<ArgeoLogListener>> userListeners = Collections
  73                         .synchronizedMap(new HashMap<String, List<ArgeoLogListener>>());
  74
  75         private BlockingQueue<LogEvent> events;
  76         private LogDispatcherThread logDispatcherThread = new LogDispatcherThread();
  77
  78         private Integer maxLastEventsCount = 10 * 1000;
  79
  80         /** Marker to prevent stack overflow */
  81         private ThreadLocal<Boolean> dispatching = new ThreadLocal<Boolean>() {
  82
  83                 @Override
  84                 protected Boolean initialValue() {
  85                         return false;
  86                 }
  87         };
  88
  89         @SuppressWarnings("unchecked")
  90         public NodeLogger(LogReaderService lrs) {
  91                 Enumeration<LogEntry> logEntries = lrs.getLog();
  92                 while (logEntries.hasMoreElements())
  93                         logged(logEntries.nextElement());
  94                 lrs.addLogListener(this);
  95         }
  96
  97         public void init() {
  98                 try {
  99                         events = new LinkedBlockingQueue<LogEvent>();
 100
 101                         // if (layout != null)
 102                         // setLayout(layout);
 103                         // else
 104                         // setLayout(new PatternLayout(pattern));
 105                         appender = new AppenderImpl();
 106                         reloadConfiguration();
 107                         Logger.getRootLogger().addAppender(appender);
 108
 109                         logDispatcherThread = new LogDispatcherThread();
 110                         logDispatcherThread.start();
 111                 } catch (Exception e) {
 112                         throw new CmsException("Cannot initialize log4j");
 113                 }
 114         }
 115
 116         public void destroy() throws Exception {
 117                 Logger.getRootLogger().removeAppender(appender);
 118                 allUsersListeners.clear();
 119                 for (List<ArgeoLogListener> lst : userListeners.values())
 120                         lst.clear();
 121                 userListeners.clear();
 122
 123                 events.clear();
 124                 events = null;
 125                 logDispatcherThread.interrupt();
 126         }
 127
 128         // public void setLayout(Layout layout) {
 129         // this.layout = layout;
 130         // }
 131
 132         //
 133         // OSGi LOGGER
 134         //
 135         @Override
 136         public void logged(LogEntry status) {
 137                 Log pluginLog = LogFactory.getLog(status.getBundle().getSymbolicName());
 138                 Integer severity = status.getLevel();
 139                 if (severity == LogService.LOG_ERROR) {
 140                         // FIXME Fix Argeo TP
 141                         if (status.getException() instanceof SignatureException)
 142                                 return;
 143                         pluginLog.error(msg(status), status.getException());
 144                 } else if (severity == LogService.LOG_WARNING)
 145                         pluginLog.warn(msg(status), status.getException());
 146                 else if (severity == LogService.LOG_INFO && pluginLog.isDebugEnabled())
 147                         pluginLog.debug(msg(status), status.getException());
 148                 else if (severity == LogService.LOG_DEBUG && pluginLog.isTraceEnabled())
 149                         pluginLog.trace(msg(status), status.getException());
 150         }
 151
 152         private String msg(LogEntry status) {
 153                 StringBuilder sb = new StringBuilder();
 154                 sb.append(status.getMessage());
 155                 ServiceReference<?> sr = status.getServiceReference();
 156                 if (sr != null) {
 157                         sb.append(' ');
 158                         String[] objectClasses = (String[]) sr.getProperty(Constants.OBJECTCLASS);
 159                         if (isSpringApplicationContext(objectClasses)) {
 160                                 sb.append("{org.springframework.context.ApplicationContext}");
 161                                 Object symbolicName = sr.getProperty(Constants.BUNDLE_SYMBOLICNAME);
 162                                 if (symbolicName != null)
 163                                         sb.append(" " + Constants.BUNDLE_SYMBOLICNAME + ": " + symbolicName);
 164                         } else {
 165                                 sb.append(arrayToString(objectClasses));
 166                         }
 167                         Object cn = sr.getProperty(NodeConstants.CN);
 168                         if (cn != null)
 169                                 sb.append(" " + NodeConstants.CN + ": " + cn);
 170                         Object factoryPid = sr.getProperty(ConfigurationAdmin.SERVICE_FACTORYPID);
 171                         if (factoryPid != null)
 172                                 sb.append(" " + ConfigurationAdmin.SERVICE_FACTORYPID + ": " + factoryPid);
 173                         // else {
 174                         // Object servicePid = sr.getProperty(Constants.SERVICE_PID);
 175                         // if (servicePid != null)
 176                         // sb.append(" " + Constants.SERVICE_PID + ": " + servicePid);
 177                         // }
 178                         // servlets
 179                         Object whiteBoardPattern = sr.getProperty(KernelConstants.WHITEBOARD_PATTERN_PROP);
 180                         if (whiteBoardPattern != null) {
 181                                 if (whiteBoardPattern instanceof String) {
 182                                         sb.append(" " + KernelConstants.WHITEBOARD_PATTERN_PROP + ": " + whiteBoardPattern);
 183                                 } else {
 184                                         sb.append(" " + KernelConstants.WHITEBOARD_PATTERN_PROP + ": "
 185                                                         + arrayToString((String[]) whiteBoardPattern));
 186                                 }
 187                         }
 188                         // RWT
 189                         Object contextName = sr.getProperty(KernelConstants.CONTEXT_NAME_PROP);
 190                         if (contextName != null)
 191                                 sb.append(" " + KernelConstants.CONTEXT_NAME_PROP + ": " + contextName);
 192
 193                         // user directories
 194                         Object baseDn = sr.getProperty(UserAdminConf.baseDn.name());
 195                         if (baseDn != null)
 196                                 sb.append(" " + UserAdminConf.baseDn.name() + ": " + baseDn);
 197
 198                 }
 199                 return sb.toString();
 200         }
 201
 202         private String arrayToString(Object[] arr) {
 203                 StringBuilder sb = new StringBuilder();
 204                 sb.append('{');
 205                 for (int i = 0; i < arr.length; i++) {
 206                         if (i != 0)
 207                                 sb.append(',');
 208                         sb.append(arr[i]);
 209                 }
 210                 sb.append('}');
 211                 return sb.toString();
 212         }
 213
 214         private boolean isSpringApplicationContext(String[] objectClasses) {
 215                 for (String clss : objectClasses) {
 216                         if (clss.equals("org.eclipse.gemini.blueprint.context.DelegatedExecutionOsgiBundleApplicationContext")) {
 217                                 return true;
 218                         }
 219                 }
 220                 return false;
 221         }
 222
 223         //
 224         // ARGEO LOGGER
 225         //
 226
 227         public synchronized void register(ArgeoLogListener listener, Integer numberOfPreviousEvents) {
 228                 String username = CurrentUser.getUsername();
 229                 if (username == null)
 230                         throw new CmsException("Only authenticated users can register a log listener");
 231
 232                 if (!userListeners.containsKey(username)) {
 233                         List<ArgeoLogListener> lst = Collections.synchronizedList(new ArrayList<ArgeoLogListener>());
 234                         userListeners.put(username, lst);
 235                 }
 236                 userListeners.get(username).add(listener);
 237                 List<LogEvent> lastEvents = logDispatcherThread.getLastEvents(username, numberOfPreviousEvents);
 238                 for (LogEvent evt : lastEvents)
 239                         dispatchEvent(listener, evt);
 240         }
 241
 242         public synchronized void registerForAll(ArgeoLogListener listener, Integer numberOfPreviousEvents,
 243                         boolean everything) {
 244                 if (everything)
 245                         everythingListeners.add(listener);
 246                 else
 247                         allUsersListeners.add(listener);
 248                 List<LogEvent> lastEvents = logDispatcherThread.getLastEvents(null, numberOfPreviousEvents);
 249                 for (LogEvent evt : lastEvents)
 250                         if (everything || evt.getUsername() != null)
 251                                 dispatchEvent(listener, evt);
 252         }
 253
 254         public synchronized void unregister(ArgeoLogListener listener) {
 255                 String username = CurrentUser.getUsername();
 256                 if (username == null)// FIXME
 257                         return;
 258                 if (!userListeners.containsKey(username))
 259                         throw new CmsException("No user listeners " + listener + " registered for user " + username);
 260                 if (!userListeners.get(username).contains(listener))
 261                         throw new CmsException("No user listeners " + listener + " registered for user " + username);
 262                 userListeners.get(username).remove(listener);
 263                 if (userListeners.get(username).isEmpty())
 264                         userListeners.remove(username);
 265
 266         }
 267
 268         public synchronized void unregisterForAll(ArgeoLogListener listener) {
 269                 everythingListeners.remove(listener);
 270                 allUsersListeners.remove(listener);
 271         }
 272
 273         /** For development purpose, since using regular logging is not easy here */
 274         static void stdOut(Object obj) {
 275                 System.out.println(obj);
 276         }
 277
 278         // public void setPattern(String pattern) {
 279         // this.pattern = pattern;
 280         // }
 281
 282         public void setDisabled(Boolean disabled) {
 283                 this.disabled = disabled;
 284         }
 285
 286         public void setLevel(String level) {
 287                 this.level = level;
 288         }
 289
 290         public void setConfiguration(Properties configuration) {
 291                 this.configuration = configuration;
 292         }
 293
 294         public void updateConfiguration(Properties configuration) {
 295                 setConfiguration(configuration);
 296                 reloadConfiguration();
 297         }
 298
 299         public Properties getConfiguration() {
 300                 return configuration;
 301         }
 302
 303         /**
 304          * Reloads configuration (if the configuration {@link Properties} is set)
 305          */
 306         protected void reloadConfiguration() {
 307                 if (configuration != null) {
 308                         LogManager.resetConfiguration();
 309                         PropertyConfigurator.configure(configuration);
 310                 }
 311         }
 312
 313         protected synchronized void processLoggingEvent(LogEvent event) {
 314                 if (disabled)
 315                         return;
 316
 317                 if (dispatching.get())
 318                         return;
 319
 320                 if (level != null && !level.trim().equals("")) {
 321                         if (log4jLevel == null || !log4jLevel.toString().equals(level))
 322                                 try {
 323                                         log4jLevel = Level.toLevel(level);
 324                                 } catch (Exception e) {
 325                                         System.err.println("Log4j level could not be set for level '" + level + "', resetting it to null.");
 326                                         e.printStackTrace();
 327                                         level = null;
 328                                 }
 329
 330                         if (log4jLevel != null && !event.getLoggingEvent().getLevel().isGreaterOrEqual(log4jLevel)) {
 331                                 return;
 332                         }
 333                 }
 334
 335                 try {
 336                         // admin listeners
 337                         Iterator<ArgeoLogListener> everythingIt = everythingListeners.iterator();
 338                         while (everythingIt.hasNext())
 339                                 dispatchEvent(everythingIt.next(), event);
 340
 341                         if (event.getUsername() != null) {
 342                                 Iterator<ArgeoLogListener> allUsersIt = allUsersListeners.iterator();
 343                                 while (allUsersIt.hasNext())
 344                                         dispatchEvent(allUsersIt.next(), event);
 345
 346                                 if (userListeners.containsKey(event.getUsername())) {
 347                                         Iterator<ArgeoLogListener> userIt = userListeners.get(event.getUsername()).iterator();
 348                                         while (userIt.hasNext())
 349                                                 dispatchEvent(userIt.next(), event);
 350                                 }
 351                         }
 352                 } catch (Exception e) {
 353                         stdOut("Cannot process logging event");
 354                         e.printStackTrace();
 355                 }
 356         }
 357
 358         protected void dispatchEvent(ArgeoLogListener logListener, LogEvent evt) {
 359                 LoggingEvent event = evt.getLoggingEvent();
 360                 logListener.appendLog(evt.getUsername(), event.getTimeStamp(), event.getLevel().toString(),
 361                                 event.getLoggerName(), event.getThreadName(), event.getMessage(), event.getThrowableStrRep());
 362         }
 363
 364         private class AppenderImpl extends AppenderSkeleton {
 365                 public boolean requiresLayout() {
 366                         return false;
 367                 }
 368
 369                 public void close() {
 370                 }
 371
 372                 @Override
 373                 protected void append(LoggingEvent event) {
 374                         if (events != null) {
 375                                 try {
 376                                         String username = CurrentUser.getUsername();
 377                                         events.put(new LogEvent(username, event));
 378                                 } catch (InterruptedException e) {
 379                                         // silent
 380                                 }
 381                         }
 382                 }
 383
 384         }
 385
 386         private class LogDispatcherThread extends Thread {
 387                 /** encapsulated in order to simplify concurrency management */
 388                 private LinkedList<LogEvent> lastEvents = new LinkedList<LogEvent>();
 389
 390                 public LogDispatcherThread() {
 391                         super("Argeo Logging Dispatcher Thread");
 392                 }
 393
 394                 public void run() {
 395                         while (events != null) {
 396                                 try {
 397                                         LogEvent loggingEvent = events.take();
 398                                         processLoggingEvent(loggingEvent);
 399                                         addLastEvent(loggingEvent);
 400                                 } catch (InterruptedException e) {
 401                                         if (events == null)
 402                                                 return;
 403                                 }
 404                         }
 405                 }
 406
 407                 protected synchronized void addLastEvent(LogEvent loggingEvent) {
 408                         if (lastEvents.size() >= maxLastEventsCount)
 409                                 lastEvents.poll();
 410                         lastEvents.add(loggingEvent);
 411                 }
 412
 413                 public synchronized List<LogEvent> getLastEvents(String username, Integer maxCount) {
 414                         LinkedList<LogEvent> evts = new LinkedList<LogEvent>();
 415                         ListIterator<LogEvent> it = lastEvents.listIterator(lastEvents.size());
 416                         int count = 0;
 417                         while (it.hasPrevious() && (count < maxCount)) {
 418                                 LogEvent evt = it.previous();
 419                                 if (username == null || username.equals(evt.getUsername())) {
 420                                         evts.push(evt);
 421                                         count++;
 422                                 }
 423                         }
 424                         return evts;
 425                 }
 426         }
 427
 428         private class LogEvent {
 429                 private final String username;
 430                 private final LoggingEvent loggingEvent;
 431
 432                 public LogEvent(String username, LoggingEvent loggingEvent) {
 433                         super();
 434                         this.username = username;
 435                         this.loggingEvent = loggingEvent;
 436                 }
 437
 438                 @Override
 439                 public int hashCode() {
 440                         return loggingEvent.hashCode();
 441                 }
 442
 443                 @Override
 444                 public boolean equals(Object obj) {
 445                         return loggingEvent.equals(obj);
 446                 }
 447
 448                 @Override
 449                 public String toString() {
 450                         return username + "@ " + loggingEvent.toString();
 451                 }
 452
 453                 public String getUsername() {
 454                         return username;
 455                 }
 456
 457                 public LoggingEvent getLoggingEvent() {
 458                         return loggingEvent;
 459                 }
 460
 461         }
 462 }