check in some skeletal code + notes, nothing concrete or working yet

svn path=/plone.app.discussion/trunk/; revision=26892

README.txt

@@ -0,0 +1,4 @@
+Introduction
+============
+
+

docs/HISTORY.txt

@@ -0,0 +1,7 @@
+Changelog
+=========
+
+1.0a1 (xxxx-xx-xx)
+------------------
+
+* Initial release

docs/INSTALL.txt

@@ -0,0 +1,40 @@
+plone.app.discussion Installation
+=======================
+
+ * When you're reading this you have probably already run
+   ``easy_install plone.app.discussion``. Find out how to install setuptools
+   (and EasyInstall) here:
+   http://peak.telecommunity.com/DevCenter/EasyInstall
+
+ * Create a file called ``plone.app.discussion-configure.zcml`` in the
+   ``/path/to/instance/etc/package-includes`` directory.  The file
+   should only contain this::
+
+       <include package="plone.app.discussion" />
+
+
+Alternatively, if you are using zc.buildout and the plone.recipe.zope2instance
+recipe to manage your project, you can do this:
+
+ * Add ``plone.app.discussion`` to the list of eggs to install, e.g.:
+
+    [buildout]
+    ...
+    eggs =
+        ...
+        plone.app.discussion
+
+  * Tell the plone.recipe.zope2instance recipe to install a ZCML slug:
+
+    [instance]
+    recipe = plone.recipe.zope2instance
+    ...
+    zcml =
+        plone.app.discussion
+
+  * Re-run buildout, e.g. with:
+
+    $ ./bin/buildout
+
+You can skip the ZCML slug if you are going to explicitly include the package
+from another package's configure.zcml file.

docs/LICENSE.GPL

@@ -0,0 +1,222 @@
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS

docs/LICENSE.txt

@@ -0,0 +1,16 @@
+  plone.app.discussion is copyright Timo Stollenwerk
+
+  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.

plone/__init__.py

@@ -0,0 +1,6 @@
+# See http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages
+try:
+    __import__('pkg_resources').declare_namespace(__name__)
+except ImportError:
+    from pkgutil import extend_path
+    __path__ = extend_path(__path__, __name__)

plone/app/__init__.py

@@ -0,0 +1,6 @@
+# See http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages
+try:
+    __import__('pkg_resources').declare_namespace(__name__)
+except ImportError:
+    from pkgutil import extend_path
+    __path__ = extend_path(__path__, __name__)

plone/app/discussion/NOTES.txt

@@ -0,0 +1,169 @@
+=================================
+plone.app.discussion design notes
+=================================
+
+This document contains design notes for plone.app.discussion.
+
+The Comment class
+-----------------
+
+The inheritance tree for DiscussionItem is shown below. Classes we want to 
+mix in and interface we want to implement in the Comment class are marked
+with [x].
+
+    [ ] DiscussionItem
+        [ ] Document
+            [ ] PortalContent                       = [ ] IContentish
+                [ ] DynamicType                     = [ ] IDynamicType
+                [ ] CMFCatalogAware                 = [ ] <no interface>
+                [ ] SimpleItem                      = [ ] ISimpleItem
+                    [ ] Item                          [ ] 
+                        [?] Base                    = [ ] <no interface>
+                        [ ] Resource                = [ ] <no interface>
+                        [ ] CopySource              = [ ] ICopySource 
+                        [ ] Tabs                    = [ ] <no interface>
+                        [x] Traversable             = [ ] ITraversable
+                        [ ] Element                 = [ ] <no interface>
+                        [x] Owned                   = [ ] IOwned
+                        [ ] UndoSupport             = [ ] IUndoSupport
+                    [ ] Persistent                    [ ] 
+                    [ ] Implicit                      [ ] 
+                    [x] RoleManager                 = [ ] IRoleManager
+                        [ ] RoleManager             = [ ] IPermissionMappingSupport
+            [ ] DefaultDublinCoreImpl               = [ ] IDublinCore
+                                                      [ ] ICatalogableDublinCore
+                                                      [ ] IMutableDublinCore
+                [ ] PropertyManager                 = [ ] IPropertyManager
+
+Thus, we want:
+
+  * Traversable, to get absolute_url() and friends
+        - this requires a good acquisition chain at all times
+  * Acquisition.Explicit, to support acquisition
+        - we do not want implicit acquisition
+  * Owned, to be able to track ownership
+  * RoleManager, to support permissions and local roles
+  
+We also want to use a number of custom indexers for most of the standard
+metadata such as creator, effective date etc.
+
+Finally, we'll need event handlers to perform the actual indexing.
+
+The Discussable class
+---------------------
+
+To obtain comments for a content item, we adapt the content to IDiscussable.
+This has a 'replies' BTree.
+
+To support __parent__ pointer integrity and stable URLs, we will implement
+IDiscussable as a persistent object stored in an annotation. Comments directly
+in reply to the content item have a __parent__ pointing to this, which in turn
+has a __parent__ pointing at the content item.
+
+The IDiscussable interface also maintains information about the total number
+of comments and the unique set of commenters' usernames. These are indexed in
+the catalog, allowing queries like "recently commented-upon content items",
+"my comments", or "all comments by user X". These values need to be stored and
+maintained by event handlers, not calculated on the fly.
+
+See collective.discussionplus for inspiration.
+
+Traversal and acquisition
+--------------------------
+
+A comment may have a URL such as:
+
+    http://localhost:8080/site/content/++comments++/1/2/3
+    
+For this traversal to work, we have:
+
+    - a namespace traversal adapter for ++comments++ that looks up an
+      IDiscussable adapter on the context and returns this
+
+    - an IPublishTraverse adapter for IHasReplies (inherited by IDiscussable
+      and IComment), which looks up values in the 'replies' dictionary and
+      acquisition-wraps them.
+        
+    - the IDiscussable adapter needs to have an id of ++comment++
+
+XXX: unrestrictedTraverse() does not take IPublishTraverse adapters into
+account. This may mean we need to implement __getitem__ on comments instead
+of/in addition to using a custom IPublishTraverse for IHasReplies.
+
+Discussion settings
+-------------------
+
+Discussion can be enabled per-type and per-instance, via values in the FTI
+(allow_discussion) and on the object. These will remain unchanged. The
+IDiscussable object's 'enabled' property should consult these.
+
+Global settings should be managed using plone.registry. A control panel
+can be generated from this as well, using the helper class in
+plone.app.registry.
+
+Note that some settings, notably those to do with permissions and workflow,
+will need to be wired up as custom form fields with custom data mangers
+or similar.
+
+Workflow and permissions
+------------------------
+
+Where possible, we should use existing permissions:
+
+  * View
+  * Reply to Item
+  * Modify Portal Content
+  * Request Review
+
+In addition, we'll need a 'Moderator' role and a moderation permission,
+
+  * Moderate comment
+  * Bypass moderation
+  
+To control whether Anonymous can post comments, we manage the 'Reply to Item'
+permission. To control whether moderation is required for various roles, we
+could manage the 'Bypass moderation' permission.
+
+These could work in a workflow like this:
+
+  * --> [posted] -- {publish} --> [published]--> *
+           |                          ^
+           |                          |
+           +----- {auto-publish} -----+
+           |                          |
+           +----- {auto-moderate} ----+
+    
+The 'posted' state is the initial state. 'published' is the state where the
+comment is visible to non-reviewers.
+
+The 'publish' transition would be protected by the 'Moderate comment'
+permission. We could have states and transition for 'rejected', etc, but it
+is probably just as good to delete comments that are rejected.
+
+The 'auto-publish' transition would be an automatic transition protected by
+the 'Bypass moderation' permission.
+
+The 'auto-moderate' transition would be another automatic transition protected
+by an expression (e.g. calling a view) that returns True if the user is on
+an auto-moderation 'white-list', e.g. by email address or username.
+  
+Forms and UI
+------------
+
+The basic commenting display/reply form should be placed in a viewlet.
+
+Ideally, the reply form should be inline, perhaps revealed with JavaScript
+if enabled. This allows full contextualisation of replies. The current
+solution, with a separate form that shows some context, is brittle and
+over-complicated.
+
+If we support quoting of comments in replies, we can load the text to quote
+using JavaScript as well.
+
+As a fall-back for non-JavaScript enabled browsers, it is probably OK not to
+support quoting and/or viewing of context, e.g. the user is taken to a standalone
+'comment reply' form.
+
+All actual forms should be handled using z3c.form and plone.z3cform's
+ExtensibleForm support. This makes it possible to plug in additional fields
+declaratively, e.g. to include spam protection.

plone/app/discussion/PRINCIPLES.txt

@@ -0,0 +1,77 @@
+=============================================
+plone.app.discussion architectural principles
+=============================================
+
+This document outlines architectural principles used in the design of
+plone.app.discussion.
+
+  Discussion items have a portal_type
+    This makes it easier to search for them and manage them using existing
+    CMF and Plone UI constructs.
+
+  Discussion items are cataloged
+    It should be possible to search for discussion items like any other
+    type of content.
+
+  Discussion items are subject to workflow and permission
+    Moderation, anonymous commenting, and auto approve/reject should be
+    handled using workflow states, automatic and manual transitions, and
+    permissions.
+
+  Discussion items are light weight objects
+    All discussion item objects should be as light weight as possible. 
+    Ideally, a discussion item should be as lightweight as a catalog brain.
+    This may mean that we forego convenience base classes and re-implement
+    certain interfaces. Comments should not provide the full set of dublin
+    core metadata, though custom indexers can be used to provide values for
+    standard catalog indexes.
+
+  Optimise for retrival speed
+    HTML filtering and other processing should happen on save, not on render,
+    to make rendering quick.
+
+  Settings are stored using plone.registry 
+    Any global setting should be stored in plone.registry records
+    
+  Forms are constructed using extensible z3c.form forms
+    This allows plugins (such as spam protection algorithms) to provide
+    additional validation
+
+  Discussion items are stored in a BTree container
+    This allows faster lookup and manipulation
+
+  Discussion items are accessed using a dict-like interface
+    This makes iteration and manipulation more natural. Even if comments are
+    not stored threaded, the dict interface should act as if they are, i.e.
+    calling items() on a comment should return the replies to that comment
+    (in order).
+    
+  Discussion items are retrieved in reverse creation date order
+    Discussion items do not need to support explicit ordering. They should
+    always be retrieved in reverse creation date order (most recent for).
+    They can be stored with keys so that this is always true.
+    
+  Discussion items do not need readable ids
+    Ids can be based on the creation date.
+    
+  Discussion items send events
+    The usual zope.lifecycleevent and zope.app.container events should be
+    fired when discussion items are added, removed, or modified.
+
+Outstanding questions
+---------------------
+
+  * Should comments use the 'talkback' URL structure currently used in CMF,
+    or a ++comments++ namespace?
+
+  * Should discussion items be stored in one container, maintaining parent
+    pointers as references or attributes, or in a nested structure?
+
+    - it may be possible to use the navtree algorithm to turn a search of
+      comments into a nested structure
+
+  * How can we ensure that discussion items are not removed from the catalog
+    when the user initiates a "clear and rebuild"?
+
+  * Can we find a way to avoid having to explicitly migrate all existing
+    comments?

plone/app/discussion/__init__.py

@@ -0,0 +1 @@
+

plone/app/discussion/browser/configure.zcml

@@ -0,0 +1,7 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:browser="http://namespaces.zope.org/browser"
+    i18n_domain="plone.app.discussion">
+
+
+</configure>

plone/app/discussion/browser/traversal.py

@@ -0,0 +1,5 @@
+"""Implement an IPublishTraverse adapter for discussion items that allows
+traversal into the 'replies' dictionary, as well as the ++comments++ traversal
+namespace.
+"""
+

plone/app/discussion/catalog.py

@@ -0,0 +1,6 @@
+"""Catalog indexers, using plone.indexer. These will populate standard catalog
+indexes with values based on the IComment interface.
+
+Also provide event handlers to actually catalog the comments.
+"""
+

plone/app/discussion/comment.py

@@ -0,0 +1,74 @@
+"""Discussion items and replies
+"""
+
+from zope.interface import implements, alsoProvides
+
+from BTrees.OOBTree import OOBTree
+
+from Acquisition import Explicit
+from OFS.Traversable import Traversable
+from AccessControl.Role import RoleManager
+from AccessControl.Owned import Owned
+
+from plone.app.discussion.interfaces import IReplies, IComment
+
+def Replies():
+    """Create a new replies object. Acts like a constructor, but actually
+    returns a BTree marked with an interface. We do this because subclassing
+    an OOBTree does not work properly.
+    """
+    
+    replies = OOBTree()
+    alsoProvides(replies, IReplies)
+    return replies
+
+class Comment(Explicit, Traversable, RoleManager, Owned):
+    """A comment.
+    
+    This object attempts to be as lightweight as possible. We implement a
+    number of standard methods instead of subclassing, to have total control
+    over what goes into the object.
+    """
+    
+    implements(IComment)
+    
+    meta_type = portal_type = 'Discussion Item'
+    
+    __parent__ = None
+    __name__ = None
+    ancestor = None
+
+    title = u""
+    mime_type = "text/plain"
+    
+    text = u""
+    
+    creator = None
+    creation_date = None
+    modification_date = None
+    
+    author_username = None
+    
+    author_name = None
+    author_email = None
+    
+    replies = None
+    
+    def __init__(self, id, ancestor, parent, **kw):
+        self.__name__ = id
+        self.__parent__ = parent
+        self.ancestor = ancestor
+        
+        for k, v in kw:
+            setattr(self, k, v)
+        
+        replies = Replies()
+    
+    # convenience functions
+    
+    @property
+    def id(self):
+        return self.__name__
+    
+    def getId(self):
+        return self.__name__

plone/app/discussion/configure.zcml

@@ -0,0 +1,6 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    i18n_domain="plone.app.discussion">
+
+
+</configure>

plone/app/discussion/discussable.py

@@ -0,0 +1,3 @@
+"""Default implementation of the IDiscussable adapter.
+"""
+

plone/app/discussion/interfaces.py

@@ -0,0 +1,68 @@
+from zope.interface import Interface
+from zope.interface.common.mapping import IIterableMapping, IWriteMapping
+from zope import schema
+
+from zope.i18nmessageid import MessageFactory
+
+_ = MessageFactory('plone.app.discussion')
+
+class IReplies(IIterableMapping, IWriteMapping):
+    """A set of related comments
+    
+    This acts as a mapping (dict) with string keys and values being other
+    discussion items in reply to this discussion item.
+    """
+
+class IHasReplies(Interface):
+    """Common interface for objects that have replies.
+    """
+
+    replies = schema.Object(title=_(u"Replies"), schema=IReplies)
+
+class IComment(IHasReplies):
+    """A comment
+    """
+
+    portal_type = schema.ASCIILine(title=_(u"Portal type"), default="Discussion Item")
+    
+    __parent__ = schema.Object(title=_(u"In reply to"), description=_(u"Another comment or a content item"), schema=Interface)
+    __name__ = schema.TextLine(title=_(u"Name"))
+    
+    ancestor = schema.Object(title=_(u"The original content object the comment is for"), schema=Interface)
+    
+    title = schema.TextLine(title=_(u"Subject"))
+    
+    mime_type = schema.ASCIILine(title=_(u"MIME type"), default="text/plain")
+    text = schema.Text(title=_(u"Comment text"))
+    
+    creator = schema.TextLine(title=_(u"Author name (for display)"))
+    creation_date = schema.Date(title=_(u"Creation date"))
+    modification_date = schema.Date(title=_(u"Modification date"))
+
+    # for logged in comments - set to None for anonymous
+    author_username = schema.TextLine(title=_(u"Author username"), required=False)
+    
+    # for anonymous comments only, set to None for logged in comments
+    author_name = schema.TextLine(title=_(u"Author name"), required=False)
+    author_email = schema.TextLine(title=_(u"Author email address"), required=False)
+
+class IDiscussable(IHasReplies):
+    """Adapt a content item to this interface to determine whether discussions
+    are currently enabled, and obtain a list of comments.
+    """
+    
+    enabled = schema.Bool(title=_(u"Is commenting enabled?"))
+    
+    total_comments = schema.Int(title=_(u"Total number of comments on this item"), min=0, readonly=True)
+    last_comment_date = schema.Date(title=_(u"Date of the most recent comment"), readonly=True)
+    commentators = schema.Set(title=_(u"The set of unique commentators (usernames)"), readonly=True)
+
+class IDiscussionSettings(Interface):
+    """Global discussion settings. This describes records stored in the
+    configuration registry and obtainable via plone.registry.
+    """
+
+    globally_enabled = schema.Bool(title=_(u"Globally enabled"),
+                                   description=_(u"Use this setting to enable or disable comments globally"),
+                                   default=True)
+

plone/app/discussion/profiles/default/metadata.xml

@@ -0,0 +1,3 @@
+<metadata>
+    <version>1.0a1</version>
+</metadata>

plone/app/discussion/version.txt

@@ -0,0 +1 @@
+1.0a1

setup.cfg

@@ -0,0 +1,3 @@
+[egg_info]
+tag_build = dev
+tag_svn_revision = true

setup.py

@@ -0,0 +1,33 @@
+from setuptools import setup, find_packages
+import os
+
+version = '1.0a1'
+
+setup(name='plone.app.discussion',
+      version=version,
+      description="Enhanced discussion support for Plone",
+      long_description=open("README.txt").read() + "\n" +
+                       open(os.path.join("docs", "HISTORY.txt")).read(),
+      # Get more strings from http://www.python.org/pypi?%3Aaction=list_classifiers
+      classifiers=[
+        "Framework :: Plone",
+        "Programming Language :: Python",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+        ],
+      keywords='',
+      author='Timo Stollenwerk',
+      author_email='plone-developers@lists.sourceforge.net',
+      url='http://pypi.python.org/pypi/plone.app.discussion',
+      license='GPL',
+      packages=find_packages(exclude=['ez_setup']),
+      namespace_packages=['plone', 'plone.app'],
+      include_package_data=True,
+      zip_safe=False,
+      install_requires=[
+          'setuptools',
+          # -*- Extra requirements: -*-
+      ],
+      entry_points="""
+      # -*- Entry points: -*-
+      """,
+      )