org.argeo.cms/src/org/argeo/cms/internal/kernel/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                                 sb.append(" " + KernelConstants.WHITEBOARD_PATTERN_PROP + ": "
 182                                                 + arrayToString((String[]) whiteBoardPattern));
 183                         // RWT
 184                         Object contextName = sr.getProperty(KernelConstants.CONTEXT_NAME_PROP);
 185                         if (contextName != null)
 186                                 sb.append(" " + KernelConstants.CONTEXT_NAME_PROP + ": " + contextName);
 187
 188                         // user directories
 189                         Object baseDn = sr.getProperty(UserAdminConf.baseDn.name());
 190                         if (baseDn != null)
 191                                 sb.append(" " + UserAdminConf.baseDn.name() + ": " + baseDn);
 192
 193                 }
 194                 return sb.toString();
 195         }
 196
 197         private String arrayToString(Object[] arr) {
 198                 StringBuilder sb = new StringBuilder();
 199                 sb.append('{');
 200                 for (int i = 0; i < arr.length; i++) {
 201                         if (i != 0)
 202                                 sb.append(',');
 203                         sb.append(arr[i]);
 204                 }
 205                 sb.append('}');
 206                 return sb.toString();
 207         }
 208
 209         private boolean isSpringApplicationContext(String[] objectClasses) {
 210                 for (String clss : objectClasses) {
 211                         if (clss.equals("org.eclipse.gemini.blueprint.context.DelegatedExecutionOsgiBundleApplicationContext")) {
 212                                 return true;
 213                         }
 214                 }
 215                 return false;
 216         }
 217
 218         //
 219         // ARGEO LOGGER
 220         //
 221
 222         public synchronized void register(ArgeoLogListener listener, Integer numberOfPreviousEvents) {
 223                 String username = CurrentUser.getUsername();
 224                 if (username == null)
 225                         throw new CmsException("Only authenticated users can register a log listener");
 226
 227                 if (!userListeners.containsKey(username)) {
 228                         List<ArgeoLogListener> lst = Collections.synchronizedList(new ArrayList<ArgeoLogListener>());
 229                         userListeners.put(username, lst);
 230                 }
 231                 userListeners.get(username).add(listener);
 232                 List<LogEvent> lastEvents = logDispatcherThread.getLastEvents(username, numberOfPreviousEvents);
 233                 for (LogEvent evt : lastEvents)
 234                         dispatchEvent(listener, evt);
 235         }
 236
 237         public synchronized void registerForAll(ArgeoLogListener listener, Integer numberOfPreviousEvents,
 238                         boolean everything) {
 239                 if (everything)
 240                         everythingListeners.add(listener);
 241                 else
 242                         allUsersListeners.add(listener);
 243                 List<LogEvent> lastEvents = logDispatcherThread.getLastEvents(null, numberOfPreviousEvents);
 244                 for (LogEvent evt : lastEvents)
 245                         if (everything || evt.getUsername() != null)
 246                                 dispatchEvent(listener, evt);
 247         }
 248
 249         public synchronized void unregister(ArgeoLogListener listener) {
 250                 String username = CurrentUser.getUsername();
 251                 if (username == null)// FIXME
 252                         return;
 253                 if (!userListeners.containsKey(username))
 254                         throw new CmsException("No user listeners " + listener + " registered for user " + username);
 255                 if (!userListeners.get(username).contains(listener))
 256                         throw new CmsException("No user listeners " + listener + " registered for user " + username);
 257                 userListeners.get(username).remove(listener);
 258                 if (userListeners.get(username).isEmpty())
 259                         userListeners.remove(username);
 260
 261         }
 262
 263         public synchronized void unregisterForAll(ArgeoLogListener listener) {
 264                 everythingListeners.remove(listener);
 265                 allUsersListeners.remove(listener);
 266         }
 267
 268         /** For development purpose, since using regular logging is not easy here */
 269         static void stdOut(Object obj) {
 270                 System.out.println(obj);
 271         }
 272
 273         // public void setPattern(String pattern) {
 274         // this.pattern = pattern;
 275         // }
 276
 277         public void setDisabled(Boolean disabled) {
 278                 this.disabled = disabled;
 279         }
 280
 281         public void setLevel(String level) {
 282                 this.level = level;
 283         }
 284
 285         public void setConfiguration(Properties configuration) {
 286                 this.configuration = configuration;
 287         }
 288
 289         public void updateConfiguration(Properties configuration) {
 290                 setConfiguration(configuration);
 291                 reloadConfiguration();
 292         }
 293
 294         public Properties getConfiguration() {
 295                 return configuration;
 296         }
 297
 298         /**
 299          * Reloads configuration (if the configuration {@link Properties} is set)
 300          */
 301         protected void reloadConfiguration() {
 302                 if (configuration != null) {
 303                         LogManager.resetConfiguration();
 304                         PropertyConfigurator.configure(configuration);
 305                 }
 306         }
 307
 308         protected synchronized void processLoggingEvent(LogEvent event) {
 309                 if (disabled)
 310                         return;
 311
 312                 if (dispatching.get())
 313                         return;
 314
 315                 if (level != null && !level.trim().equals("")) {
 316                         if (log4jLevel == null || !log4jLevel.toString().equals(level))
 317                                 try {
 318                                         log4jLevel = Level.toLevel(level);
 319                                 } catch (Exception e) {
 320                                         System.err.println("Log4j level could not be set for level '" + level + "', resetting it to null.");
 321                                         e.printStackTrace();
 322                                         level = null;
 323                                 }
 324
 325                         if (log4jLevel != null && !event.getLoggingEvent().getLevel().isGreaterOrEqual(log4jLevel)) {
 326                                 return;
 327                         }
 328                 }
 329
 330                 try {
 331                         // admin listeners
 332                         Iterator<ArgeoLogListener> everythingIt = everythingListeners.iterator();
 333                         while (everythingIt.hasNext())
 334                                 dispatchEvent(everythingIt.next(), event);
 335
 336                         if (event.getUsername() != null) {
 337                                 Iterator<ArgeoLogListener> allUsersIt = allUsersListeners.iterator();
 338                                 while (allUsersIt.hasNext())
 339                                         dispatchEvent(allUsersIt.next(), event);
 340
 341                                 if (userListeners.containsKey(event.getUsername())) {
 342                                         Iterator<ArgeoLogListener> userIt = userListeners.get(event.getUsername()).iterator();
 343                                         while (userIt.hasNext())
 344                                                 dispatchEvent(userIt.next(), event);
 345                                 }
 346                         }
 347                 } catch (Exception e) {
 348                         stdOut("Cannot process logging event");
 349                         e.printStackTrace();
 350                 }
 351         }
 352
 353         protected void dispatchEvent(ArgeoLogListener logListener, LogEvent evt) {
 354                 LoggingEvent event = evt.getLoggingEvent();
 355                 logListener.appendLog(evt.getUsername(), event.getTimeStamp(), event.getLevel().toString(),
 356                                 event.getLoggerName(), event.getThreadName(), event.getMessage(), event.getThrowableStrRep());
 357         }
 358
 359         private class AppenderImpl extends AppenderSkeleton {
 360                 public boolean requiresLayout() {
 361                         return false;
 362                 }
 363
 364                 public void close() {
 365                 }
 366
 367                 @Override
 368                 protected void append(LoggingEvent event) {
 369                         if (events != null) {
 370                                 try {
 371                                         String username = CurrentUser.getUsername();
 372                                         events.put(new LogEvent(username, event));
 373                                 } catch (InterruptedException e) {
 374                                         // silent
 375                                 }
 376                         }
 377                 }
 378
 379         }
 380
 381         private class LogDispatcherThread extends Thread {
 382                 /** encapsulated in order to simplify concurrency management */
 383                 private LinkedList<LogEvent> lastEvents = new LinkedList<LogEvent>();
 384
 385                 public LogDispatcherThread() {
 386                         super("Argeo Logging Dispatcher Thread");
 387                 }
 388
 389                 public void run() {
 390                         while (events != null) {
 391                                 try {
 392                                         LogEvent loggingEvent = events.take();
 393                                         processLoggingEvent(loggingEvent);
 394                                         addLastEvent(loggingEvent);
 395                                 } catch (InterruptedException e) {
 396                                         if (events == null)
 397                                                 return;
 398                                 }
 399                         }
 400                 }
 401
 402                 protected synchronized void addLastEvent(LogEvent loggingEvent) {
 403                         if (lastEvents.size() >= maxLastEventsCount)
 404                                 lastEvents.poll();
 405                         lastEvents.add(loggingEvent);
 406                 }
 407
 408                 public synchronized List<LogEvent> getLastEvents(String username, Integer maxCount) {
 409                         LinkedList<LogEvent> evts = new LinkedList<LogEvent>();
 410                         ListIterator<LogEvent> it = lastEvents.listIterator(lastEvents.size());
 411                         int count = 0;
 412                         while (it.hasPrevious() && (count < maxCount)) {
 413                                 LogEvent evt = it.previous();
 414                                 if (username == null || username.equals(evt.getUsername())) {
 415                                         evts.push(evt);
 416                                         count++;
 417                                 }
 418                         }
 419                         return evts;
 420                 }
 421         }
 422
 423         private class LogEvent {
 424                 private final String username;
 425                 private final LoggingEvent loggingEvent;
 426
 427                 public LogEvent(String username, LoggingEvent loggingEvent) {
 428                         super();
 429                         this.username = username;
 430                         this.loggingEvent = loggingEvent;
 431                 }
 432
 433                 @Override
 434                 public int hashCode() {
 435                         return loggingEvent.hashCode();
 436                 }
 437
 438                 @Override
 439                 public boolean equals(Object obj) {
 440                         return loggingEvent.equals(obj);
 441                 }
 442
 443                 @Override
 444                 public String toString() {
 445                         return username + "@ " + loggingEvent.toString();
 446                 }
 447
 448                 public String getUsername() {
 449                         return username;
 450                 }
 451
 452                 public LoggingEvent getLoggingEvent() {
 453                         return loggingEvent;
 454                 }
 455
 456         }
 457 }