1 /* ***** BEGIN LICENSE BLOCK *****
  2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3  *
  4  * The contents of this file are subject to the Mozilla Public License Version
  5  * 1.1 (the "License"); you may not use this file except in compliance with
  6  * the License. You may obtain a copy of the License at
  7  * http://www.mozilla.org/MPL/
  8  *
  9  * Software distributed under the License is distributed on an "AS IS" basis,
 10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 11  * for the specific language governing rights and limitations under the
 12  * License.
 13  *
 14  * The Original Code is gContactSync.
 15  *
 16  * The Initial Developer of the Original Code is
 17  * Josh Geenen <gcontactsync@pirules.org>.
 18  * Portions created by the Initial Developer are Copyright (C) 2008-2009
 19  * the Initial Developer. All Rights Reserved.
 20  *
 21  * Contributor(s):
 22  *
 23  * Alternatively, the contents of this file may be used under the terms of
 24  * either the GNU General Public License Version 2 or later (the "GPL"), or
 25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 26  * in which case the provisions of the GPL or the LGPL are applicable instead
 27  * of those above. If you wish to allow use of your version of this file only
 28  * under the terms of either the GPL or the LGPL, and not to allow others to
 29  * use your version of this file under the terms of the MPL, indicate your
 30  * decision by deleting the provisions above and replace them with the notice
 31  * and other provisions required by the GPL or the LGPL. If you do not delete
 32  * the provisions above, a recipient may use your version of this file under
 33  * the terms of any one of the MPL, the GPL or the LGPL.
 34  *
 35  * ***** END LICENSE BLOCK ***** */
 36 
 37 if (!com) var com = {}; // A generic wrapper variable
 38 // A wrapper for all GCS functions and variables
 39 if (!com.gContactSync) com.gContactSync = {};
 40 
 41 /**
 42  * A simple class that logs messages.
 43  * @class
 44  */
 45 com.gContactSync.LOGGER = {
 46   /** The number of errors logged */
 47   mErrorCount:   0,
 48   /** The number of warnings logged */
 49   mWarningCount: 0,
 50   /** The console service (for logging to the error console) */
 51   mConsoleService: Components.classes['@mozilla.org/consoleservice;1']
 52                              .getService(Components.interfaces.nsIConsoleService),
 53   /**
 54    * Appends the message to the log file and adds a newline character after the
 55    * message.
 56    * @param aMessage {string} The message to append.
 57    */
 58   LOG: function LOGGER_LOG(aMessage) {
 59     if (!aMessage)
 60       return;
 61     // this can fail if called before FileIO is initialized
 62     try {
 63       com.gContactSync.FileIO.appendToFile(com.gContactSync.FileIO.mLogFile,
 64                                            aMessage + "\n");
 65     } catch (e) {}
 66   },
 67   /**
 68    * Logs the message if verbose logging is enabled.
 69    * @param aMessage {string} The message to log.
 70    */
 71   VERBOSE_LOG: function LOGGER_VERBOSE_LOG(aMessage) {
 72     if (com.gContactSync.Preferences.mSyncPrefs.verboseLog.value)
 73       this.LOG(aMessage);
 74   },
 75   /**
 76    * Logs an error and increments the error count.
 77    * @param aMessage {string} The error message.
 78    * @param aError   {string} Optional.  The exception caught.
 79    */
 80   LOG_ERROR: function LOGGER_LOG_ERROR(aMessage, aError) {
 81     var str = "***ERROR: " + aMessage;
 82     if (aError)
 83       str += "\nError Message:\n" + aError;
 84     str += com.gContactSync.StringBundle.getStr("pleaseReport");
 85     this.LOG(str);
 86     this.mErrorCount++;
 87     this.mConsoleService.logStringMessage("gContactSync: " + str);
 88   },
 89   /**
 90    * Logs a warning and updates the warning count.
 91    * @param aWarningMessage {string} The warning message with info about the
 92    *                                 problem.
 93    * @param aError          {string} Optional.  The exception caught.
 94    */
 95   LOG_WARNING: function LOGGER_LOG_WARNING(aWarningMessage, aError) {
 96     var str = "***WARNING: " + aWarningMessage;
 97     if (aError)
 98       str += "\nError Message:\n" + aError;
 99     //str += "\n" + com.gContactSync.StringBundle.getStr("pleaseReport");
100     this.LOG(str);
101     this.mWarningCount++;
102   }
103 };
104