Log.java 15.7 KB
Newer Older
Matt Tucker's avatar
Matt Tucker committed
1 2 3 4 5
/**
 * $RCSfile$
 * $Revision$
 * $Date$
 *
6
 * Copyright (C) 1999-2004 Jive Software. All rights reserved.
Matt Tucker's avatar
Matt Tucker committed
7
 *
8 9
 * This software is the proprietary information of Jive Software.
 * Use is subject to license terms.
Matt Tucker's avatar
Matt Tucker committed
10
 */
11

Matt Tucker's avatar
Matt Tucker committed
12 13
package org.jivesoftware.util;

14 15 16 17
import org.jivesoftware.util.log.Hierarchy;
import org.jivesoftware.util.log.LogTarget;
import org.jivesoftware.util.log.Logger;
import org.jivesoftware.util.log.Priority;
18
import org.jivesoftware.util.log.format.ExtendedPatternFormatter;
19 20 21 22 23 24 25 26 27
import org.jivesoftware.util.log.output.io.StreamTarget;
import org.jivesoftware.util.log.output.io.rotate.RevolvingFileStrategy;
import org.jivesoftware.util.log.output.io.rotate.RotateStrategyBySize;
import org.jivesoftware.util.log.output.io.rotate.RotatingFileTarget;

import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
28 29
import java.util.ArrayList;
import java.util.List;
30 31 32
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.LogRecord;
Matt Tucker's avatar
Matt Tucker committed
33 34 35 36 37 38 39 40

/**
 * Simple wrapper to the incorporated LogKit to log under a single logging name.
 *
 * @author Bruce Ritchie
 */
public class Log {

41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
    private static final Logger debugLog = Hierarchy.getDefaultHierarchy().getLoggerFor("Jive-DEBUG");
    private static final Logger infoLog = Hierarchy.getDefaultHierarchy().getLoggerFor("Jive-INFO");
    private static final Logger warnLog = Hierarchy.getDefaultHierarchy().getLoggerFor("Jive-WARN");
    private static final Logger errorLog = Hierarchy.getDefaultHierarchy().getLoggerFor("Jive-ERR");

    private static String logNameDebug = null;
    private static String logNameInfo = null;
    private static String logNameWarn = null;
    private static String logNameError = null;
    private static String debugPattern = null;
    private static String infoPattern = null;
    private static String warnPattern = null;
    private static String errorPattern = null;
    private static String logDirectory = null;

    private static long maxDebugSize = 1024;
    private static long maxInfoSize = 1024;
    private static long maxWarnSize = 1024;
    private static long maxErrorSize = 1024;

    private static boolean debugEnabled;
Matt Tucker's avatar
Matt Tucker committed
62 63

    static {
64 65 66 67
        initLog();
    }

    private Log() { }
Matt Tucker's avatar
Matt Tucker committed
68

69 70 71
    /**
     * This method is used to initialize the Log class. For normal operations this method
     * should <b>never</b> be called, rather it's only publically available so that the class
72
     * can be reset by the setup process once the home directory has been specified.
73 74
     */
    public static void initLog() {
Matt Tucker's avatar
Matt Tucker committed
75
        try {
76
            logDirectory = JiveGlobals.getXMLProperty("log.directory");
77
            if (logDirectory == null) {
78 79
                if (JiveGlobals.getHomeDirectory() != null) {
                    File messengerHome = new File(JiveGlobals.getHomeDirectory());
Matt Tucker's avatar
Matt Tucker committed
80 81
                    if (messengerHome.exists() && messengerHome.canWrite()) {
                        logDirectory = (new File(messengerHome, "logs")).toString();
82 83 84 85 86 87 88 89
                    }
                }
            }

            if (!logDirectory.endsWith(File.separator)) {
                logDirectory = logDirectory + File.separator;
            }

Matt Tucker's avatar
Matt Tucker committed
90
            // Make sure the logs directory exists. If not, make it:
91
            File logDir = new File(logDirectory);
Matt Tucker's avatar
Matt Tucker committed
92
            if (!logDir.exists()) {
93
                logDir.mkdir();
Matt Tucker's avatar
Matt Tucker committed
94
            }
95

Matt Tucker's avatar
Matt Tucker committed
96 97 98 99
            logNameDebug = logDirectory + "debug.log";
            logNameInfo = logDirectory + "info.log";
            logNameWarn = logDirectory + "warn.log";
            logNameError = logDirectory + "error.log";
100

101 102 103 104
            debugPattern = JiveGlobals.getXMLProperty("log.debug.format");
            infoPattern = JiveGlobals.getXMLProperty("log.info.format");
            warnPattern = JiveGlobals.getXMLProperty("log.warn.format");
            errorPattern = JiveGlobals.getXMLProperty("log.error.format");
105

106
            try { maxDebugSize = Long.parseLong(JiveGlobals.getXMLProperty("log.debug.size")); }
107
            catch (NumberFormatException e) { /* ignore */ }
108
            try { maxInfoSize = Long.parseLong(JiveGlobals.getXMLProperty("log.info.size")); }
109
            catch (NumberFormatException e) { /* ignore */ }
110
            try { maxWarnSize = Long.parseLong(JiveGlobals.getXMLProperty("log.warn.size")); }
111
            catch (NumberFormatException e) { /* ignore */ }
112
            try { maxErrorSize = Long.parseLong(JiveGlobals.getXMLProperty("log.error.size")); }
113 114
            catch (NumberFormatException e) { /* ignore */ }

115
            debugEnabled = "true".equals(JiveGlobals.getXMLProperty("log.debug.enabled"));
116 117
        }
        catch (Exception e) {
118
            // we'll get an exception if home isn't setup yet - we ignore that since
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
            // it's sure to be logged elsewhere :)
        }

        if (debugPattern == null) {
            debugPattern = "%{time:yyyy.MM.dd HH:mm:ss} %{message}\\n%{throwable}";
        }
        if (infoPattern == null) {
            infoPattern = "%{time:yyyy.MM.dd HH:mm:ss} %{message}\\n%{throwable}";
        }
        if (warnPattern == null) {
            warnPattern = "%{time:yyyy.MM.dd HH:mm:ss} %{message}\\n%{throwable}";
        }
        if (errorPattern == null) {
            errorPattern = "%{time:yyyy.MM.dd HH:mm:ss} [%{method}] %{message}\\n%{throwable}";
        }

        createLogger(debugPattern, logNameDebug, maxDebugSize, debugLog, Priority.DEBUG);
        createLogger(infoPattern, logNameInfo, maxInfoSize, infoLog, Priority.INFO);
        createLogger(warnPattern, logNameWarn, maxWarnSize, warnLog, Priority.WARN);
        createLogger(errorPattern, logNameError, maxErrorSize, errorLog, Priority.ERROR);
139 140 141

        // set up the ties into jdk logging
        Handler jdkLogHandler = new JiveLogHandler();
Andrew Wright's avatar
Andrew Wright committed
142
        jdkLogHandler.setLevel(Level.ALL);
143
        java.util.logging.Logger.getLogger("").addHandler(jdkLogHandler);
144 145 146 147 148 149 150 151 152 153 154
    }

    private static void createLogger(String pattern, String logName, long maxLogSize,
            Logger logger, Priority priority)
    {
        // debug log file
        ExtendedPatternFormatter formatter = new ExtendedPatternFormatter(pattern);
        StreamTarget target = null;
        Exception ioe = null;

        try {
155
            // home was not setup correctly
156
            if (logName == null) {
Matt Tucker's avatar
Matt Tucker committed
157
                throw new IOException("LogName was null - MessengerHome not set?");
158 159 160 161 162
            }
            else {
                RevolvingFileStrategy fileStrategy = new RevolvingFileStrategy(logName, 5);
                RotateStrategyBySize rotateStrategy = new RotateStrategyBySize(maxLogSize * 1024);
                target = new RotatingFileTarget(formatter, rotateStrategy, fileStrategy);
Matt Tucker's avatar
Matt Tucker committed
163 164
            }
        }
165 166 167 168 169 170 171 172 173 174 175
        catch (IOException e) {
            ioe = e;
            // can't log to file, log to stderr
            target = new StreamTarget(System.err, formatter);
        }

        logger.setLogTargets(new LogTarget[] { target } );
        logger.setPriority(priority);

        if (ioe != null) {
            logger.debug("Error occurred opening log file: " + ioe.getMessage());
Matt Tucker's avatar
Matt Tucker committed
176 177 178
        }
    }

179 180 181 182 183 184 185 186 187 188 189 190
    public static void setProductName(String productName) {
        debugPattern = productName + " " + debugPattern;
        infoPattern = productName + " " + infoPattern;
        warnPattern = productName + " " + warnPattern;
        errorPattern = productName + " " + errorPattern;

        createLogger(debugPattern, logNameDebug, maxDebugSize, debugLog, Priority.DEBUG);
        createLogger(infoPattern, logNameInfo, maxInfoSize, infoLog, Priority.INFO);
        createLogger(warnPattern, logNameWarn, maxWarnSize, warnLog, Priority.WARN);
        createLogger(errorPattern, logNameError, maxErrorSize, errorLog, Priority.ERROR);
    }

Matt Tucker's avatar
Matt Tucker committed
191 192 193 194
    public static boolean isErrorEnabled() {
        return errorLog.isErrorEnabled();
    }

195 196 197 198 199 200 201 202 203
    public static boolean isFatalEnabled() {
        return errorLog.isFatalErrorEnabled();
    }

    public static boolean isDebugEnabled() {
        return debugEnabled;
    }

    public static void setDebugEnabled(boolean enabled) {
204
        JiveGlobals.setXMLProperty("log.debug.enabled", Boolean.toString(enabled));
205 206 207
        debugEnabled = enabled;
    }

Matt Tucker's avatar
Matt Tucker committed
208 209 210 211 212 213 214 215
    public static boolean isInfoEnabled() {
        return infoLog.isInfoEnabled();
    }

    public static boolean isWarnEnabled() {
        return warnLog.isWarnEnabled();
    }

216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
    public static void debug(String s) {
        if (isDebugEnabled()) {
            debugLog.debug(s);
        }
    }

    public static void debug(Throwable throwable) {
        if (isDebugEnabled()) {
            debugLog.debug("", throwable);
        }
    }

    public static void debug(String s, Throwable throwable) {
        if (isDebugEnabled()) {
            debugLog.debug(s, throwable);
        }
    }

234
    public static void markDebugLogFile(String username) {
235
        RotatingFileTarget target = (RotatingFileTarget) debugLog.getLogTargets()[0];
236
        markLogFile(username, target);
237 238 239 240 241 242 243 244 245 246 247 248 249
    }

    public static void rotateDebugLogFile() {
        RotatingFileTarget target = (RotatingFileTarget) debugLog.getLogTargets()[0];
        try {
            target.rotate();
        }
        catch (IOException e) {
            System.err.println("Warning: There was an error rotating the Jive debug log file. " +
                    "Logging may not work correctly until a restart happens.");
        }
    }

Matt Tucker's avatar
Matt Tucker committed
250
    public static void info(String s) {
251 252 253
        if (isInfoEnabled()) {
            infoLog.info(s);
        }
Matt Tucker's avatar
Matt Tucker committed
254 255 256
    }

    public static void info(Throwable throwable) {
257 258 259
        if (isInfoEnabled()) {
            infoLog.info("", throwable);
        }
Matt Tucker's avatar
Matt Tucker committed
260 261 262
    }

    public static void info(String s, Throwable throwable) {
263 264 265 266 267
        if (isInfoEnabled()) {
            infoLog.info(s, throwable);
        }
    }

268
    public static void markInfoLogFile(String username) {
269
        RotatingFileTarget target = (RotatingFileTarget) infoLog.getLogTargets()[0];
270
        markLogFile(username, target);
271 272 273 274 275 276 277 278 279 280 281
    }

    public static void rotateInfoLogFile() {
        RotatingFileTarget target = (RotatingFileTarget) infoLog.getLogTargets()[0];
        try {
            target.rotate();
        }
        catch (IOException e) {
            System.err.println("Warning: There was an error rotating the Jive info log file. " +
                    "Logging may not work correctly until a restart happens.");
        }
Matt Tucker's avatar
Matt Tucker committed
282 283 284
    }

    public static void warn(String s) {
285 286 287
        if (isWarnEnabled()) {
            warnLog.warn(s);
        }
Matt Tucker's avatar
Matt Tucker committed
288 289 290
    }

    public static void warn(Throwable throwable) {
291 292 293
        if (isWarnEnabled()) {
            warnLog.warn("", throwable);
        }
Matt Tucker's avatar
Matt Tucker committed
294 295 296
    }

    public static void warn(String s, Throwable throwable) {
297 298 299 300 301
        if (isWarnEnabled()) {
            warnLog.warn(s, throwable);
        }
    }

302
    public static void markWarnLogFile(String username) {
303
        RotatingFileTarget target = (RotatingFileTarget) warnLog.getLogTargets()[0];
304
        markLogFile(username, target);
305 306 307 308 309 310 311 312 313 314 315
    }

    public static void rotateWarnLogFile() {
        RotatingFileTarget target = (RotatingFileTarget) warnLog.getLogTargets()[0];
        try {
            target.rotate();
        }
        catch (IOException e) {
            System.err.println("Warning: There was an error rotating the Jive warn log file. " +
                    "Logging may not work correctly until a restart happens.");
        }
Matt Tucker's avatar
Matt Tucker committed
316 317 318
    }

    public static void error(String s) {
319 320 321 322 323 324
        if (isErrorEnabled()) {
            errorLog.error(s);
            if (isDebugEnabled()) {
                printToStdErr(s, null);
            }
        }
Matt Tucker's avatar
Matt Tucker committed
325 326 327
    }

    public static void error(Throwable throwable) {
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
        if (isErrorEnabled()) {
            errorLog.error("", throwable);
            if (isDebugEnabled()) {
                printToStdErr(null, throwable);
            }
        }
    }

    public static void error(String s, Throwable throwable) {
        if (isErrorEnabled()) {
            errorLog.error(s, throwable);
            if (isDebugEnabled()) {
                printToStdErr(s, throwable);
            }
        }
    }

345
    public static void markErrorLogFile(String username) {
346
        RotatingFileTarget target = (RotatingFileTarget) errorLog.getLogTargets()[0];
347
        markLogFile(username, target);
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
    }

    public static void rotateErrorLogFile() {
        RotatingFileTarget target = (RotatingFileTarget) errorLog.getLogTargets()[0];
        try {
            target.rotate();
        }
        catch (IOException e) {
            System.err.println("Warning: There was an error rotating the Jive error log file. " +
                    "Logging may not work correctly until a restart happens.");
        }
    }

    public static void fatal(String s) {
        if (isFatalEnabled()) {
            errorLog.fatalError(s);
            if (isDebugEnabled()) {
                printToStdErr(s, null);
            }
        }
    }

    public static void fatal(Throwable throwable) {
        if (isFatalEnabled()) {
            errorLog.fatalError("", throwable);
            if (isDebugEnabled()) {
                printToStdErr(null, throwable);
            }
        }
    }

    public static void fatal(String s, Throwable throwable) {
        if (isFatalEnabled()) {
            errorLog.fatalError(s, throwable);
            if (isDebugEnabled()) {
                printToStdErr(s, throwable);
            }
        }
Matt Tucker's avatar
Matt Tucker committed
386 387 388
    }

    /**
389 390
     * Returns the directory that log files exist in. The directory name will
     * have a File.separator as the last character in the string.
Matt Tucker's avatar
Matt Tucker committed
391
     *
392
     * @return the directory that log files exist in.
Matt Tucker's avatar
Matt Tucker committed
393
     */
394 395 396 397
    public static String getLogDirectory() {
        return logDirectory;
    }

398
    private static void markLogFile(String username, RotatingFileTarget target) {
399
        List args = new ArrayList();
400
        args.add(username);
401 402 403 404
        args.add(JiveGlobals.formatDateTime(new java.util.Date()));
        target.write(LocaleUtils.getLocalizedString("log.marker_inserted_by", args) + "\n");
    }

405 406 407 408 409 410 411 412 413 414 415
    private static void printToStdErr(String s, Throwable throwable) {
        if (s != null) {
            System.err.println(s);
        }
        if (throwable != null) {
            StringWriter sw = new StringWriter();
            PrintWriter pw = new PrintWriter(sw);
            throwable.printStackTrace(pw);
            System.err.print(sw.toString());
            System.err.print("\n");
        }
Matt Tucker's avatar
Matt Tucker committed
416
    }
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478

    private static final class JiveLogHandler extends Handler {

        public void publish(LogRecord record) {

            Level level = record.getLevel();
            Throwable throwable = record.getThrown();


            if (Level.SEVERE.equals(level)) {

                if (throwable != null) {
                    Log.error(record.getMessage(), throwable);
                }
                else {
                    Log.error(record.getMessage());
                }

            }
            else if (Level.WARNING.equals(level)) {

                if (throwable != null) {
                    Log.warn(record.getMessage(), throwable);
                }
                else {
                    Log.warn(record.getMessage());
                }


            }
            else if (Level.INFO.equals(level)) {

                if (throwable != null) {
                    Log.info(record.getMessage(), throwable);
                }
                else {
                    Log.info(record.getMessage());
                }

            }
            else {
                // else FINE,FINER,FINEST

                if (throwable != null) {
                    Log.debug(record.getMessage(), throwable);
                }
                else {
                    Log.debug(record.getMessage());
                }

            }
        }

        public void flush() {
            // do nothing
        }

        public void close() throws SecurityException {
            // do nothing
        }
    }

479
}