Changeset 49827 for CPS4/products/CPSRemoteController

Timestamp:

10/24/06 17:46:43 (2 years ago)

Author:

tziade

Message:

added publication api

Files:

• CPS4/products/CPSRemoteController/trunk/CHANGES (added)
• CPS4/products/CPSRemoteController/trunk/RemoteControllerTool.py (modified) (3 diffs)
• CPS4/products/CPSRemoteController/trunk/client/cps.py (modified) (1 diff)

CPS4/products/CPSRemoteController/trunk/RemoteControllerTool.py

@@ -31 +31 @@
-from Products.CMFCore.permissions import View
-
+from Products.CPSCore.EventServiceTool import getEventService
-from Products.CPSRemoteController.interfaces import IRemoteControllerTool
-from Products.CPSUtil.xmlrpc import toLatin9
@@ -36 +37 @@
-
-glog_key = 'RemoteControllerTool'
+EVENT_PUBLISH_DOCUMENT = 'remote_controller_publish_documents'
-
-class RemoteControllerTool(UniqueObject, Folder):
@@ -101 +103 @@
-
-
+    security.declarePrivate('_getPublishedDocuments')
+    def _getPublishedDocuments(self, rpath, published_docs=True):
+        """Return rpaths of the documents, published or not, through the history
+        of the document specified by the given path.
+        """
+        portal = self._getPortalObject()
+        portal_ppath = portal.getPhysicalPath()
+        proxy = self._restrictedTraverse(rpath)
+        states_info = proxy.getContentInfo(proxy=proxy, level=2)['states']
+        published_docs_rpaths = []
+        for state_info in states_info:
+            state = state_info['review_state']
+            if (published_docs and state == 'published'
+                or not published_docs and state != 'published'):
+                published_proxy = state_info['proxy']
+                published_proxy_path = '/'.join(
+                    published_proxy.getPhysicalPath()[len(portal_ppath):])
+                published_docs_rpaths.append(published_proxy_path)
+        return published_docs_rpaths
+
+    security.declareProtected(View, 'publishDocument')
+    def publishDocument(self, doc_rpath, rpaths_to_publish,
+                        wait_for_approval=False, comments=""):
+        """Publish the document specified by the given relative path.
+
+        document_rpath is of the form "workspaces/doc1" or "workspaces/folder/doc2".
+
+        rpaths_to_publish is a dictionary. The dictionary keys are the rpath
+        of where to publish the document. The rpath can be the rpath of a
+        section or the rpath of a document. The dictionary values are either the
+        empty string, "before", "after" or "replace". Those values have a
+        meaning only if the rpath is the one of a document.
+
+        "replace" is to be used so that the published document really replaces
+        another document, be it folder or document. The targeted document is
+        deleted and the document to published is inserted at the position of the
+        now deleted targeted document.
+
+        Returns a list of published doc full rpaths to keep a trace
+        """
+        portal = self._getPortalObject()
+        portal_ppath = portal.getPhysicalPath()
+        wftool = self.portal_workflow
+        proxy = self._restrictedTraverse(doc_rpath)
+
+        doc_id = proxy.getId()
+        context = proxy
+        workflow_action = 'copy_submit'
+        if wait_for_approval:
+            transition = 'submit'
+        else:
+            transition = 'publish'
+        allowed_transitions = wftool.getAllowedPublishingTransitions(context)
+        published_docs_rpaths = self._getPublishedDocuments(doc_rpath)
+        published_doc_ids = []
+
+        for target_rpath, placement in rpaths_to_publish.items():
+            target_doc = None
+            try:
+                object = self._restrictedTraverse(target_rpath)
+            except (KeyError, AttributeError):
+                continue
+            # XXX how to get rid of geidet:section here :(
+            if object.portal_type == 'geidet:section':
+                section_rpath = target_rpath
+                section = object
+            else:
+                try:
+                    target_doc = self._restrictedTraverse(target_rpath)
+                    target_doc_ppath = target_doc.getPhysicalPath()
+                    rppath = target_doc_ppath[len(portal_ppath):]
+                    object = self._restrictedTraverse(rppath[:-1])
+                except (KeyError, AttributeError):
+                    continue
+                # XXX how to get rid of geidet:section here :(
+                if object.portal_type == 'geidet:section':
+                    section_rpath = '/'.join(object.getPhysicalPath()[len(portal_ppath):])
+                    section = object
+                else:
+                    continue
+
+            published_doc_id = wftool.findNewId(section, doc_id)
+            published_doc_ids.append('%s/%s' % (target_rpath,
+                                                published_doc_id))
+
+            wftool.doActionFor(context, workflow_action,
+                               dest_container=section_rpath,
+                               initial_transition=transition,
+                               comment=comments)
+            # If the rpath provided was the one of a document then we will
+            # consider the placement value to optionally move the document or
+            # make it replace another one.
+            position = None
+            replace = False
+            update = False
+            if target_doc is not None:
+                target_id = target_doc.getId()
+                target_pos = section.getObjectPosition(target_id)
+                if placement == 'before':
+                    position = target_pos
+                elif placement == 'after':
+                    position = target_pos + 1
+                elif placement == 'replace':
+                    target_doc_rpath = self.portal_url\
+                                       .getRelativeContentURL(target_doc)
+                    position = target_pos
+                    replace = True
+                    if target_doc_rpath in published_docs_rpaths:
+                        update = True
+                    context = target_doc
+                    wftool.doActionFor(context, 'unpublish', comment=comments)
+                if position is not None:
+                    section.moveObjectToPosition(doc_id, position)
+            else:
+                # the path to publish is section - move document to top
+                # section.moveObjectsToTop(doc_id)
+                pass
+
+            # Sending events so that subscribers can react on commands sent to the
+            # remote controller tool.
+            info = {'dest_container': section_rpath,
+                    'wait_for_approval': wait_for_approval,
+                    'position': position,
+                    # This document comes as a replacement of a different
+                    # previous document that was located at the place where this
+                    # present document has been published.
+                    'replace': replace,
+                    # This document comes as an update of a previous version of
+                    # the same document.
+                    'update': update,
+                   }
+            evtool = getEventService(self)
+            evtool.notify(EVENT_PUBLISH_DOCUMENT, proxy, info)
+
+        return published_doc_ids
-
-    security.declareProtected(View, 'getProductVersion')

CPS4/products/CPSRemoteController/trunk/client/cps.py

@@ -57 +57 @@
-
-    @faultviewer
+    def publishDocument(self, doc_rpath, rpaths_to_publish,
+                        wait_for_approval=False, comments=""):
+        return self.proxy.publishDocument(doc_rpath, rpaths_to_publish,
+                                          wait_for_approval, comments)
+
+    @faultviewer
-    def search(self, query):
-        return self.proxy.search(query)