first step to merge senslab upstream:

[sfa.git] / sfa / util / sfalogging.py

diff --git a/sfa/util/sfalogging.py b/sfa/util/sfalogging.py
old mode 100755 (executable)
new mode 100644 (file)
index 8810ee7..495a274
--- a/sfa/util/sfalogging.py
+++ b/sfa/util/sfalogging.py
@@ -1,5 +1,28 @@
 #!/usr/bin/python
 
+#----------------------------------------------------------------------
+# Copyright (c) 2008 Board of Trustees, Princeton University
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and/or hardware specification (the "Work") to
+# deal in the Work without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense,
+# and/or sell copies of the Work, and to permit persons to whom the Work
+# is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Work.
+#
+# THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
+# OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS 
+# IN THE WORK.
+#----------------------------------------------------------------------
+
 import os, sys
 import traceback
 import logging, logging.handlers
@@ -28,7 +51,16 @@ class _SfaLogger:
             # This is usually a permissions error becaue the file is
             # owned by root, but httpd is trying to access it.
             tmplogfile=os.getenv("TMPDIR", "/tmp") + os.path.sep + os.path.basename(logfile)
-            handler=logging.handlers.RotatingFileHandler(tmplogfile,maxBytes=1000000, backupCount=5) 
+            # In strange uses, 2 users on same machine might use same code,
+            # meaning they would clobber each others files
+            # We could (a) rename the tmplogfile, or (b)
+            # just log to the console in that case.
+            # Here we default to the console.
+            if os.path.exists(tmplogfile) and not os.access(tmplogfile,os.W_OK):
+                loggername = loggername + "-console"
+                handler = logging.StreamHandler()
+            else:
+                handler=logging.handlers.RotatingFileHandler(tmplogfile,maxBytes=1000000, backupCount=5) 
         handler.setFormatter(logging.Formatter("%(asctime)s - %(levelname)s - %(message)s"))
         self.logger=logging.getLogger(loggername)
         self.logger.setLevel(level)
@@ -41,7 +73,7 @@ class _SfaLogger:
 
         if not handler_exists:
             self.logger.addHandler(handler)
-            
+
         self.loggername=loggername
 
     def setLevel(self,level):
@@ -59,8 +91,11 @@ class _SfaLogger:
             self.logger.setLevel(logging.WARNING)
         elif verbose==1:
             self.logger.setLevel(logging.INFO)
-        elif verbose==2:
+        elif verbose>=2:
             self.logger.setLevel(logging.DEBUG)
+    # in case some other code needs a boolean
+    def getBoolVerboseFromOpt(self,verbose):
+        return verbose>=1
 
     ####################
     def info(self, msg):
@@ -71,6 +106,10 @@ class _SfaLogger:
         
     def warn(self, msg):
         self.logger.warn(msg)
+
+    # some code is using logger.warn(), some is using logger.warning()
+    def warning(self, msg):
+        self.logger.warning(msg)
    
     def error(self, msg):
         self.logger.error(msg)    
@@ -90,8 +129,14 @@ class _SfaLogger:
     # for investigation purposes, can be placed anywhere
     def log_stack(self,message):
         to_log="".join(traceback.format_stack())
-        self.debug("%s BEG STACK"%message+"\n"+to_log)
-        self.debug("%s END STACK"%message)
+        self.info("%s BEG STACK"%message+"\n"+to_log)
+        self.info("%s END STACK"%message)
+
+    def enable_console(self, stream=sys.stdout):
+        formatter = logging.Formatter("%(message)s")
+        handler = logging.StreamHandler(stream)
+        handler.setFormatter(formatter)
+        self.logger.addHandler(handler)
 
 
 info_logger = _SfaLogger(loggername='info', level=logging.INFO)
@@ -128,26 +173,29 @@ def profile(logger):
 
 if __name__ == '__main__': 
     print 'testing sfalogging into logger.log'
-    logger=_SfaLogger('logger.log')
-    logger2=_SfaLogger('logger.log', level=logging.DEBUG)
-    logger3=_SfaLogger('logger.log', level=logging.ERROR)
-    print logger.logger.handlers
+    logger1=_SfaLogger('logger.log', loggername='std(info)')
+    logger2=_SfaLogger('logger.log', loggername='error', level=logging.ERROR)
+    logger3=_SfaLogger('logger.log', loggername='debug', level=logging.DEBUG)
+    
+    for (logger,msg) in [ (logger1,"std(info)"),(logger2,"error"),(logger3,"debug")]:
+        
+        print "====================",msg, logger.logger.handlers
    
-    logger.critical("logger.critical")
-    logger.error("logger.error")
-    logger.warn("logger.warning")
-    logger.info("logger.info")
-    logger.debug("logger.debug")
-    logger.setLevel(logging.DEBUG)
-    logger.debug("logger.debug again")
+        logger.enable_console()
+        logger.critical("logger.critical")
+        logger.error("logger.error")
+        logger.warn("logger.warning")
+        logger.info("logger.info")
+        logger.debug("logger.debug")
+        logger.setLevel(logging.DEBUG)
+        logger.debug("logger.debug again")
     
-
-    @profile(logger)
-    def sleep(seconds = 1):
-        time.sleep(seconds)
-
-    logger.info('console.info')
-    sleep(0.5)
-    logger.setLevel(logging.DEBUG)
-    sleep(0.25)
+        @profile(logger)
+        def sleep(seconds = 1):
+            time.sleep(seconds)
+
+        logger.info('console.info')
+        sleep(0.5)
+        logger.setLevel(logging.DEBUG)
+        sleep(0.25)