source: main/waeup.kofa/trunk/src/waeup/kofa/objecthistory.py @ 15505

Last change on this file since 15505 was 11068, checked in by Henrik Bettermann, 11 years ago

Hide user name in history if necessary (not used in base package).

  • Property svn:keywords set to Id
File size: 4.0 KB
RevLine 
[7193]1## $Id: objecthistory.py 11068 2014-02-11 07:34:30Z henrik $
[6338]2##
[7193]3## Copyright (C) 2011 Uli Fouquet & Henrik Bettermann
[6338]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.
[7193]8##
[6338]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.
[7193]13##
[6338]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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17##
18import grok
[6468]19from datetime import datetime
[6338]20from persistent.list import PersistentList
[7679]21from zope.component import getUtility
22from zope.i18n import translate
[6338]23from zope.annotation.interfaces import IAnnotations
[7819]24from waeup.kofa.interfaces import IObjectHistory, IKofaObject, IKofaUtils
[8186]25from waeup.kofa.utils.helpers import get_current_principal, now
[6338]26
[7811]27from waeup.kofa.interfaces import MessageFactory as _
[7679]28
[6338]29class ObjectHistory(grok.Adapter):
30    """A history for objects.
[6468]31
[7819]32    For any object implementing `IKofaObject` which is annotatable,
[6468]33    we provide histories. A history for such an object can be obtained
34    by adapting it to `IObjectHistory`.
[6338]35    """
[7819]36    grok.context(IKofaObject)
[6468]37    grok.implements(IObjectHistory)
[6338]38
39    history_key = 'waeup.history'
40
41    def __init__(self, context):
42        from zope.security.proxy import removeSecurityProxy
43        self.context = removeSecurityProxy(context)
44        self._annotations = IAnnotations(self.context)
45
46    def _getMessages(self):
47        return self._annotations.get(self.history_key, PersistentList())
48
49    @property
50    def messages(self):
[6468]51        """Get all messages as a persistent list of strings.
52        """
[6338]53        return self._getMessages()
54
[11068]55    def addMessage(self, msg, user=None):
[6468]56        """Add the message (history entry) in msg.
57
58        Any message will be stored with a timestamp and the current
[11068]59        user (principal) if user parameter is None.
[6468]60        """
[6338]61        msgs = self._getMessages()
[8183]62        tz = getUtility(IKofaUtils).tzinfo
[8234]63        timestamp = now(tz).strftime("%Y-%m-%d %H:%M:%S %Z")
[7819]64        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
[11068]65        msg = translate(msg,'waeup.kofa',target_language=portal_language)
[7959]66        by = translate(_('by'),'waeup.kofa',target_language=portal_language)
[11068]67        if user == None:
68            user = get_current_principal()
69            if user is None:
70                usertitle = 'system'
71            elif user.id == 'zope.anybody':
72                usertitle = 'Anonymous'
73            else:
74                usertitle = getattr(user, 'public_name', None)
75                if not usertitle:
76                    usertitle = user.title
77            msg = u'%s - %s %s %s' % (timestamp, msg, by, usertitle)
78        elif user == 'undisclosed':
79            msg = u'%s - %s' % (timestamp, msg)
80        else:
81            msg = u'%s - %s %s %s' % (timestamp, msg, by, user)
[6338]82        msgs.append(msg)
83        self._annotations[self.history_key] = msgs
84        return
[9012]85
86    def modifyMessages(self, old, new):
[9013]87        """Replaces history messages.
[9012]88
[9013]89        Substring 'old' will be replaced by 'new' in all
[9012]90        messages.
91        """
92        old_msgs = self._getMessages()
93        new_msgs = PersistentList()
94        for msg in old_msgs:
95            new_msg = msg.replace(old, new)
96            new_msgs.append(new_msg)
97        self._annotations[self.history_key] = new_msgs
[9125]98        return
99
100    def removeMessage(self, number):
101        """Removes a single history message.
102
103        """
104        msgs = self._getMessages()
[9126]105        if not isinstance(number, int):
106            return False, 'Not a number'
107        try:
108            line = msgs[number]
109        except IndexError:
110            return False, 'Number out of range'
[9125]111        msgs.pop(number)
112        self._annotations[self.history_key] = msgs
[9126]113        return True, line
Note: See TracBrowser for help on using the repository browser.