← Back to branch summary

~ubuntu-branches/ubuntu/natty/miro/natty

« back to all changes in this revision

Viewing changes to portable/databaselog.py

  • Committer: Bazaar Package Importer
  • Author(s): Bryce Harrington
  • Date: 2011-01-22 02:46:33 UTC
  • mfrom: (1.4.10 upstream) (1.7.5 experimental)
  • Revision ID: james.westby@ubuntu.com-20110122024633-kjme8u93y2il5nmf
Tags: 3.5.1-1ubuntu1
* Merge from debian.  Remaining ubuntu changes:
  - Use python 2.7 instead of python 2.6
  - Relax dependency on python-dbus to >= 0.83.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
portable/databaselog.py
1
 
# Miro - an RSS based video player application
2
 
# Copyright (C) 2005-2010 Participatory Culture Foundation
3
 
#
4
 
# This program is free software; you can redistribute it and/or modify
5
 
# it under the terms of the GNU General Public License as published by
6
 
# the Free Software Foundation; either version 2 of the License, or
7
 
# (at your option) any later version.
8
 
#
9
 
# This program is distributed in the hope that it will be useful,
10
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
 
# GNU General Public License for more details.
13
 
#
14
 
# You should have received a copy of the GNU General Public License
15
 
# along with this program; if not, write to the Free Software
16
 
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
17
 
#
18
 
# In addition, as a special exception, the copyright holders give
19
 
# permission to link the code of portions of this program with the OpenSSL
20
 
# library.
21
 
#
22
 
# You must obey the GNU General Public License in all respects for all of
23
 
# the code used other than OpenSSL. If you modify file(s) with this
24
 
# exception, you may extend this exception to your version of the file(s),
25
 
# but you are not obligated to do so. If you do not wish to do so, delete
26
 
# this exception statement from your version. If you delete this exception
27
 
# statement from all source files in the program, then also delete it here.
28
 
 
29
 
"""Log events having to do with the database.
30
 
 
31
 
The purpose of this module is to help us keep track of the history of
32
 
a user's database.  This helps us doing customer support and debugging
33
 
weird databases because we have a better idea of the history of that
34
 
database.
35
 
 
36
 
See bug #12419 for more info.
37
 
 
38
 
.. note::
39
 
 
40
 
    We should try hard not to let loops fill up the log file with too
41
 
    much junk, or infinitely.  Take a look at
42
 
    ``item.move_orphaned_items()`` for one technique to avoid this.
43
 
"""
44
 
 
45
 
import time
46
 
import logging
47
 
 
48
 
from miro.database import DDBObject
49
 
 
50
 
# log levels
51
 
DEBUG = 10
52
 
INFO = 20
53
 
 
54
 
class DBLogEntry(DDBObject):
55
 
    def setup_new(self, priority, description):
56
 
        self.priority = priority
57
 
        self.description = description
58
 
        self.timestamp = time.time()
59
 
 
60
 
    @classmethod
61
 
    def notable_entries(cls):
62
 
        return cls.make_view('priority > ?', (DEBUG,), order_by='timestamp')
63
 
 
64
 
def _log(priority, message, *args):
65
 
    try:
66
 
        description = unicode(message) % args
67
 
    except UnicodeError:
68
 
        logging.warn("Unicode error when creating database log entry %s %s" % \
69
 
                     (message, args))
70
 
        return
71
 
    entry = DBLogEntry(priority, description)
72
 
    logging.dblog(description)
73
 
 
74
 
def info(message, *args):
75
 
    """Log a message to the database, using the 'info' priority.
76
 
 
77
 
    This should be used for entries that are fairly notable.  These
78
 
    entries will be printed out every time the user starts up Miro.
79
 
    """
80
 
    _log(INFO, message, *args)
81
 
 
82
 
def debug(message, *args):
83
 
    """Log a message to the database, using the 'debug' priority.
84
 
 
85
 
    This should be used for entries that are there for debugging
86
 
    purposes.  These will be only printed out to the current log file.
87
 
    """
88
 
    _log(DEBUG, message, *args)
89
 
 
90
 
def print_old_log_entries():
91
 
    """Printout old log entries to the log file.
92
 
    """
93
 
    old_entries = list(DBLogEntry.notable_entries())
94
 
    if not old_entries:
95
 
        return
96
 
    logging.dblog("start database log entries")
97
 
    for entry in old_entries:
98
 
        logging.dblog("* %s: %s", time.ctime(entry.timestamp),
99
 
                      entry.description)
100
 
    logging.dblog("end database log entries")