From 8ce1eb7222ab8a0083a5814dac185dcf60c0b908 Mon Sep 17 00:00:00 2001
From: Helmut Merz <helmutm@cy55.de>
Date: Fri, 28 Feb 2014 17:11:22 +0100
Subject: [PATCH] comment system extensions: make comments stateful as basis
 for moderated comments

---
 organize/comment/README.txt     |  3 +++
 organize/comment/base.py        | 34 +++++++++++++++++++++++++++------
 organize/comment/configure.zcml |  4 ++++
 organize/comment/interfaces.py  | 26 +++++++++++++++++++++++++
 organize/tracking/browser.py    |  4 ++--
 5 files changed, 63 insertions(+), 8 deletions(-)
 create mode 100644 organize/comment/interfaces.py

diff --git a/organize/comment/README.txt b/organize/comment/README.txt
index f3a1df9..3fe1b52 100644
--- a/organize/comment/README.txt
+++ b/organize/comment/README.txt
@@ -45,6 +45,9 @@ to assign comments to this document.
   >>> home = views['home']
   >>> home.target = resources['d001.txt']
 
+  >>> from loops.organize.comment.base import commentStates
+  >>> component.provideUtility(commentStates(), name='organize.commentStates')
+
 Creating comments
 -----------------
 
diff --git a/organize/comment/base.py b/organize/comment/base.py
index 3ad956e..5b4ff95 100644
--- a/organize/comment/base.py
+++ b/organize/comment/base.py
@@ -1,5 +1,5 @@
 #
-#  Copyright (c) 2008 Helmut Merz helmutm@cy55.de
+#  Copyright (c) 2014 Helmut Merz helmutm@cy55.de
 #
 #  This program is free software; you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
@@ -18,24 +18,46 @@
 
 """
 Base classes for comments/discussions.
-
-$Id$
 """
 
 from zope.component import adapts
-from zope.interface import implements
+from zope.interface import implementer, implements
 
+from cybertools.stateful.definition import StatesDefinition
+from cybertools.stateful.definition import State, Transition
+from cybertools.stateful.interfaces import IStatesDefinition
 from cybertools.tracking.btree import Track
 from cybertools.tracking.interfaces import ITrackingStorage
-from cybertools.tracking.comment.interfaces import IComment
+from loops.organize.comment.interfaces import IComment
+from loops.organize.stateful.base import Stateful
 from loops import util
 
 
-class Comment(Track):
+@implementer(IStatesDefinition)
+def commentStates():
+    return StatesDefinition('commentStates',
+        State('new', 'new', ('accept', 'reject'), color='red'),
+        State('public', 'public', ('retract', 'reject'), color='green'),
+        State('rejected', 'rejected', ('accept'), color='grey'),
+        Transition('accept', 'accept', 'public'),
+        Transition('reject', 'reject', 'rejected'),
+        Transition('retract', 'retract', 'new'),
+        initialState='new')
+
+
+class Comment(Stateful, Track):
 
     implements(IComment)
 
+    metadata_attributes = Track.metadata_attributes + ('state',)
+    index_attributes = metadata_attributes
     typeName = 'Comment'
+    typeInterface = IComment
+    statesDefinition = 'organize.commentStates'
 
     contentType = 'text/restructured'
 
+    def __init__(self, taskId, runId, userName, data):
+        super(Comment, self).__init__(taskId, runId, userName, data)
+        self.state = self.getState()    # make initial state persistent
+
diff --git a/organize/comment/configure.zcml b/organize/comment/configure.zcml
index 74776fa..2b78430 100644
--- a/organize/comment/configure.zcml
+++ b/organize/comment/configure.zcml
@@ -12,6 +12,10 @@
              set_schema="cybertools.tracking.comment.interfaces.IComment" />
   </zope:class>
 
+  <zope:utility
+        factory="loops.organize.comment.base.commentStates"
+        name="organize.commentStates" />
+
   <!-- views -->
 
   <browser:page
diff --git a/organize/comment/interfaces.py b/organize/comment/interfaces.py
new file mode 100644
index 0000000..687e8c4
--- /dev/null
+++ b/organize/comment/interfaces.py
@@ -0,0 +1,26 @@
+#
+#  Copyright (c) 2014 Helmut Merz helmutm@cy55.de
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; either version 2 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY 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, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+
+"""
+Interface definitions for comments - discussions - forums.
+"""
+
+from zope.interface import Interface, Attribute
+from zope import schema
+
+from cybertools.tracking.comment.interfaces import IComment
diff --git a/organize/tracking/browser.py b/organize/tracking/browser.py
index c2f3b69..33e82bb 100644
--- a/organize/tracking/browser.py
+++ b/organize/tracking/browser.py
@@ -1,5 +1,5 @@
 #
-#  Copyright (c) 2013 Helmut Merz helmutm@cy55.de
+#  Copyright (c) 2014 Helmut Merz helmutm@cy55.de
 #
 #  This program is free software; you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
@@ -86,7 +86,7 @@ class BaseTrackView(TrackView):
 
     def getMetadataTarget(self, key):
         value = self.metadata.get(key)
-        if value.isdigit():
+        if value and value.isdigit():
             obj = util.getObjectForUid(value)
             if obj is not None:
                 url = ('%s/@@SelectedManagementView.html' %