2 * Copyright (C) 2007-2012 Argeo GmbH
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 package org
.argeo
.cms
.internal
.kernel
;
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
;
28 import java
.util
.Properties
;
29 import java
.util
.concurrent
.BlockingQueue
;
30 import java
.util
.concurrent
.LinkedBlockingQueue
;
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
;
54 /** Not meant to be used directly in standard log4j config */
55 class NodeLogger
implements ArgeoLogger
, LogListener
{
57 private Boolean disabled
= false;
59 private String level
= null;
61 private Level log4jLevel
= null;
62 // private Layout layout;
64 private Properties configuration
;
66 private AppenderImpl appender
;
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
>>());
75 private BlockingQueue
<LogEvent
> events
;
76 private LogDispatcherThread logDispatcherThread
= new LogDispatcherThread();
78 private Integer maxLastEventsCount
= 10 * 1000;
80 /** Marker to prevent stack overflow */
81 private ThreadLocal
<Boolean
> dispatching
= new ThreadLocal
<Boolean
>() {
84 protected Boolean
initialValue() {
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);
99 events
= new LinkedBlockingQueue
<LogEvent
>();
101 // if (layout != null)
102 // setLayout(layout);
104 // setLayout(new PatternLayout(pattern));
105 appender
= new AppenderImpl();
106 reloadConfiguration();
107 Logger
.getRootLogger().addAppender(appender
);
109 logDispatcherThread
= new LogDispatcherThread();
110 logDispatcherThread
.start();
111 } catch (Exception e
) {
112 throw new CmsException("Cannot initialize log4j");
116 public void destroy() throws Exception
{
117 Logger
.getRootLogger().removeAppender(appender
);
118 allUsersListeners
.clear();
119 for (List
<ArgeoLogListener
> lst
: userListeners
.values())
121 userListeners
.clear();
125 logDispatcherThread
.interrupt();
128 // public void setLayout(Layout layout) {
129 // this.layout = layout;
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
)
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());
152 private String
msg(LogEntry status
) {
153 StringBuilder sb
= new StringBuilder();
154 sb
.append(status
.getMessage());
155 ServiceReference
<?
> sr
= status
.getServiceReference();
158 String
[] objectClasses
= (String
[]) sr
.getProperty(Constants
.OBJECTCLASS
);
159 sb
.append(arrayToString(objectClasses
));
160 Object cn
= sr
.getProperty(NodeConstants
.CN
);
162 sb
.append(" " + NodeConstants
.CN
+ ": " + cn
);
163 Object factoryPid
= sr
.getProperty(ConfigurationAdmin
.SERVICE_FACTORYPID
);
164 if (factoryPid
!= null)
165 sb
.append(" " + ConfigurationAdmin
.SERVICE_FACTORYPID
+ ": " + factoryPid
);
167 // Object servicePid = sr.getProperty(Constants.SERVICE_PID);
168 // if (servicePid != null)
169 // sb.append(" " + Constants.SERVICE_PID + ": " + servicePid);
172 Object whiteBoardPattern
= sr
.getProperty(KernelConstants
.WHITEBOARD_PATTERN_PROP
);
173 if (whiteBoardPattern
!= null)
174 sb
.append(" " + KernelConstants
.WHITEBOARD_PATTERN_PROP
+ ": "
175 + arrayToString((String
[]) whiteBoardPattern
));
177 Object contextName
= sr
.getProperty(KernelConstants
.CONTEXT_NAME_PROP
);
178 if (contextName
!= null)
179 sb
.append(" " + KernelConstants
.CONTEXT_NAME_PROP
+ ": " + contextName
);
182 Object baseDn
= sr
.getProperty(UserAdminConf
.baseDn
.name());
184 sb
.append(" " + UserAdminConf
.baseDn
.name() + ": " + baseDn
);
186 return sb
.toString();
189 private String
arrayToString(Object
[] arr
) {
190 StringBuilder sb
= new StringBuilder();
192 for (int i
= 0; i
< arr
.length
; i
++) {
198 return sb
.toString();
205 public synchronized void register(ArgeoLogListener listener
, Integer numberOfPreviousEvents
) {
206 String username
= CurrentUser
.getUsername();
207 if (username
== null)
208 throw new CmsException("Only authenticated users can register a log listener");
210 if (!userListeners
.containsKey(username
)) {
211 List
<ArgeoLogListener
> lst
= Collections
.synchronizedList(new ArrayList
<ArgeoLogListener
>());
212 userListeners
.put(username
, lst
);
214 userListeners
.get(username
).add(listener
);
215 List
<LogEvent
> lastEvents
= logDispatcherThread
.getLastEvents(username
, numberOfPreviousEvents
);
216 for (LogEvent evt
: lastEvents
)
217 dispatchEvent(listener
, evt
);
220 public synchronized void registerForAll(ArgeoLogListener listener
, Integer numberOfPreviousEvents
,
221 boolean everything
) {
223 everythingListeners
.add(listener
);
225 allUsersListeners
.add(listener
);
226 List
<LogEvent
> lastEvents
= logDispatcherThread
.getLastEvents(null, numberOfPreviousEvents
);
227 for (LogEvent evt
: lastEvents
)
228 if (everything
|| evt
.getUsername() != null)
229 dispatchEvent(listener
, evt
);
232 public synchronized void unregister(ArgeoLogListener listener
) {
233 String username
= CurrentUser
.getUsername();
234 if (username
== null)// FIXME
236 if (!userListeners
.containsKey(username
))
237 throw new CmsException("No user listeners " + listener
+ " registered for user " + username
);
238 if (!userListeners
.get(username
).contains(listener
))
239 throw new CmsException("No user listeners " + listener
+ " registered for user " + username
);
240 userListeners
.get(username
).remove(listener
);
241 if (userListeners
.get(username
).isEmpty())
242 userListeners
.remove(username
);
246 public synchronized void unregisterForAll(ArgeoLogListener listener
) {
247 everythingListeners
.remove(listener
);
248 allUsersListeners
.remove(listener
);
251 /** For development purpose, since using regular logging is not easy here */
252 static void stdOut(Object obj
) {
253 System
.out
.println(obj
);
256 // public void setPattern(String pattern) {
257 // this.pattern = pattern;
260 public void setDisabled(Boolean disabled
) {
261 this.disabled
= disabled
;
264 public void setLevel(String level
) {
268 public void setConfiguration(Properties configuration
) {
269 this.configuration
= configuration
;
272 public void updateConfiguration(Properties configuration
) {
273 setConfiguration(configuration
);
274 reloadConfiguration();
277 public Properties
getConfiguration() {
278 return configuration
;
282 * Reloads configuration (if the configuration {@link Properties} is set)
284 protected void reloadConfiguration() {
285 if (configuration
!= null) {
286 LogManager
.resetConfiguration();
287 PropertyConfigurator
.configure(configuration
);
291 protected synchronized void processLoggingEvent(LogEvent event
) {
295 if (dispatching
.get())
298 if (level
!= null && !level
.trim().equals("")) {
299 if (log4jLevel
== null || !log4jLevel
.toString().equals(level
))
301 log4jLevel
= Level
.toLevel(level
);
302 } catch (Exception e
) {
303 System
.err
.println("Log4j level could not be set for level '" + level
+ "', resetting it to null.");
308 if (log4jLevel
!= null && !event
.getLoggingEvent().getLevel().isGreaterOrEqual(log4jLevel
)) {
315 Iterator
<ArgeoLogListener
> everythingIt
= everythingListeners
.iterator();
316 while (everythingIt
.hasNext())
317 dispatchEvent(everythingIt
.next(), event
);
319 if (event
.getUsername() != null) {
320 Iterator
<ArgeoLogListener
> allUsersIt
= allUsersListeners
.iterator();
321 while (allUsersIt
.hasNext())
322 dispatchEvent(allUsersIt
.next(), event
);
324 if (userListeners
.containsKey(event
.getUsername())) {
325 Iterator
<ArgeoLogListener
> userIt
= userListeners
.get(event
.getUsername()).iterator();
326 while (userIt
.hasNext())
327 dispatchEvent(userIt
.next(), event
);
330 } catch (Exception e
) {
331 stdOut("Cannot process logging event");
336 protected void dispatchEvent(ArgeoLogListener logListener
, LogEvent evt
) {
337 LoggingEvent event
= evt
.getLoggingEvent();
338 logListener
.appendLog(evt
.getUsername(), event
.getTimeStamp(), event
.getLevel().toString(),
339 event
.getLoggerName(), event
.getThreadName(), event
.getMessage(), event
.getThrowableStrRep());
342 private class AppenderImpl
extends AppenderSkeleton
{
343 public boolean requiresLayout() {
347 public void close() {
351 protected void append(LoggingEvent event
) {
352 if (events
!= null) {
354 String username
= CurrentUser
.getUsername();
355 events
.put(new LogEvent(username
, event
));
356 } catch (InterruptedException e
) {
364 private class LogDispatcherThread
extends Thread
{
365 /** encapsulated in order to simplify concurrency management */
366 private LinkedList
<LogEvent
> lastEvents
= new LinkedList
<LogEvent
>();
368 public LogDispatcherThread() {
369 super("Argeo Logging Dispatcher Thread");
373 while (events
!= null) {
375 LogEvent loggingEvent
= events
.take();
376 processLoggingEvent(loggingEvent
);
377 addLastEvent(loggingEvent
);
378 } catch (InterruptedException e
) {
385 protected synchronized void addLastEvent(LogEvent loggingEvent
) {
386 if (lastEvents
.size() >= maxLastEventsCount
)
388 lastEvents
.add(loggingEvent
);
391 public synchronized List
<LogEvent
> getLastEvents(String username
, Integer maxCount
) {
392 LinkedList
<LogEvent
> evts
= new LinkedList
<LogEvent
>();
393 ListIterator
<LogEvent
> it
= lastEvents
.listIterator(lastEvents
.size());
395 while (it
.hasPrevious() && (count
< maxCount
)) {
396 LogEvent evt
= it
.previous();
397 if (username
== null || username
.equals(evt
.getUsername())) {
406 private class LogEvent
{
407 private final String username
;
408 private final LoggingEvent loggingEvent
;
410 public LogEvent(String username
, LoggingEvent loggingEvent
) {
412 this.username
= username
;
413 this.loggingEvent
= loggingEvent
;
417 public int hashCode() {
418 return loggingEvent
.hashCode();
422 public boolean equals(Object obj
) {
423 return loggingEvent
.equals(obj
);
427 public String
toString() {
428 return username
+ "@ " + loggingEvent
.toString();
431 public String
getUsername() {
435 public LoggingEvent
getLoggingEvent() {