Merge lp:~facundo/magicicada-gui/log-to-files into lp:magicicada-gui

[Facundo Batista]

Log to a file.

The file rotates when reachs 1MB, and everytime the program is started. After ten rotations, the oldest is removed.

[Natalia Bidart (nataliabidart)]

/me likes it

review: Approve

=== modified file 'magicicada/__init__.py'
--- magicicada/__init__.py	2010-06-04 02:07:15 +0000
+++ magicicada/__init__.py	2010-06-05 04:02:21 +0000
@@ -28,12 +28,15 @@
 from twisted.internet import gtk2reactor # for gtk-2.0
 gtk2reactor.install()
 
-from magicicada import syncdaemon
+from magicicada import syncdaemon, logger
 from magicicada.helpers import humanize_bytes, get_data_file, get_builder, NO_OP
 
 CONTENT_QUEUE = 'content'
 META_QUEUE = 'meta'
 
+# set up the logging for all the project
+logger.set_up()
+
 class MagicicadaUI(object):
 
     STATUS_JOINER = " - "
 
=== modified file 'magicicada/dbusiface.py'
--- magicicada/dbusiface.py	2010-05-31 16:45:45 +0000
+++ magicicada/dbusiface.py	2010-06-05 04:02:21 +0000
@@ -21,7 +21,6 @@
 import collections
 import logging
 import re
-import sys
 
 import dbus
 from dbus import SessionBus
@@ -31,14 +30,6 @@
 
 # log!
 logger = logging.getLogger('magicicada.dbusiface')
-handler = logging.StreamHandler(sys.stdout)
-logger.addHandler(handler)
-formatter = logging.Formatter("%(asctime)s %(name)s:%(lineno)-4d "
-                              "%(levelname)-8s %(message)s",
-                              '%Y-%m-%d %H:%M:%S')
-handler.setFormatter(formatter)
-logger.setLevel(logging.DEBUG)
-
 
 QueueData = collections.namedtuple('QueueData', 'operation path share node')
 FolderData = collections.namedtuple('FolderData',
 
=== added file 'magicicada/logger.py'
--- magicicada/logger.py	1970-01-01 00:00:00 +0000
+++ magicicada/logger.py	2010-06-05 04:02:21 +0000
@@ -0,0 +1,56 @@
+# logger.py
+#
+# Author: Facundo Batista <[e-mail]>
+#
+# Copyright 2010 Chicharreros
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Logging set up."""
+
+
+import logging
+import os
+
+from logging.handlers import RotatingFileHandler
+
+import xdg.BaseDirectory
+
+
+class CustomRotatingFH(RotatingFileHandler):
+    """Rotating handler that starts a new file for every run."""
+
+    def __init__(self, *args, **kwargs):
+        RotatingFileHandler.__init__(self, *args, **kwargs)
+        self.doRollover()
+
+
+def set_up():
+    """Set up the logging."""
+
+    # choose the folder to store the logs
+    cache = xdg.BaseDirectory.xdg_cache_home
+    logfolder = os.path.join(cache, 'magicicada')
+    if not os.path.exists(logfolder):
+        os.makedirs(logfolder)
+    logfile = os.path.join(logfolder, 'magicicada.log')
+
+    logger = logging.getLogger('magicicada')
+    handler = CustomRotatingFH(logfile, maxBytes=1e6, backupCount=10)
+    logger.addHandler(handler)
+    formatter = logging.Formatter("%(asctime)s %(name)-23s"
+                                  "%(levelname)-8s %(message)s",
+                                  '%Y-%m-%d %H:%M:%S')
+    handler.setFormatter(formatter)
+    logger.setLevel(logging.DEBUG)
+
 
=== modified file 'magicicada/syncdaemon.py'
--- magicicada/syncdaemon.py	2010-05-31 00:31:17 +0000
+++ magicicada/syncdaemon.py	2010-06-05 04:02:21 +0000
@@ -19,7 +19,6 @@
 """The backend that communicates Magicicada with the SyncDaemon."""
 
 import logging
-import sys
 
 from twisted.internet import defer, reactor
 
@@ -28,13 +27,6 @@
 
 # log!
 logger = logging.getLogger('magicicada.syncdaemon')
-handler = logging.StreamHandler(sys.stdout)
-logger.addHandler(handler)
-formatter = logging.Formatter("%(asctime)s %(name)s:%(lineno)-4d "
-                              "%(levelname)-8s %(message)s",
-                              '%Y-%m-%d %H:%M:%S')
-handler.setFormatter(formatter)
-logger.setLevel(logging.DEBUG)
 
 
 class State(object):