esdrt.content 2.0.3__py3-none-any.whl

esdrt/content/INTEGRATION.txt

@@ -0,0 +1,36 @@
+Integration Tests
+-----------------
+
+This is a DocTest file, using the Python doctest format.
+
+In an integration test, here's some of the globals you have to work with::
+
+    >>> portal
+    <PloneSite at /plone>
+    
+    >>> portal_name
+    'plone'
+    
+    >>> folder
+    <ATFolder at /plone/Members/test_user_1_>
+    
+    >>> user_name
+    'test_user_1_'
+    
+    >>> user_password
+    'secret'
+    
+    >>> user_role
+    'test_role_1_'
+
+    >>> app.REQUEST
+    <HTTPRequest, URL=http://nohost>
+    
+    >>> app
+    <Application at >
+    
+Now, let's demonstrate a failing test::
+
+    >>> 1 == 2
+    True
+

esdrt/content/__init__.py

@@ -0,0 +1,5 @@
+from zope.i18nmessageid import MessageFactory
+
+# Set up the i18n message factory for our package
+_ = MessageFactory('esdrt.content')
+from . import patches

esdrt/content/adapters/configure.zcml

@@ -0,0 +1,11 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:plone="http://namespaces.plone.org/plone">
+
+    <adapter
+        for="esdrt.content.reviewfolder.IReviewFolder"
+        provides="zope.container.interfaces.INameChooser"
+        factory=".reference_number.ReferenceNumberCreator"
+    />
+
+</configure>

esdrt/content/adapters/reference_number.py

@@ -0,0 +1,42 @@
+from zope.component import adapter
+from zope.interface import implementer
+
+from esdrt.content.observation import IObservation
+from plone.app.content.interfaces import INameFromTitle
+from plone.app.content.namechooser import NormalizingNameChooser
+
+
+ATTEMPTS = 100
+
+
+class INameFromData(INameFromTitle):
+    pass
+
+@adapter(IObservation)
+@implementer(INameFromData)
+class ReferenceNumberCreator(NormalizingNameChooser):
+    """A name chooser for a Zope object manager.
+
+    If the object is adaptable to or provides INameFromTitle, use the
+    title to generate a name.
+    """
+
+    def chooseName(self, name, object):
+        parent = self.context
+        items = []
+        items.append(object.country.upper())
+        items.append(object.crf_code)
+        items.append(str(object.review_year))
+        prename = '-'.join(items)
+        number = 1
+        observations = [k for k in list(parent.keys()) if k.startswith(prename)]
+        if observations:
+            observations.sort()
+            last_observation = observations[-1]
+            number = int(last_observation.split('-')[-1])
+            number = number + 1
+        last_part = '%04d' % number
+        name = prename + '-' + last_part
+
+        # OFS.ObjectManager.checkValidId fails unless the id is str
+        return str(name)

esdrt/content/browser/__init__.py

@@ -0,0 +1 @@
+ 

esdrt/content/browser/attachmentdownload.py

@@ -0,0 +1,22 @@
+from plone.namedfile.browser import Download as Base
+from plone.rfc822.interfaces import IPrimaryFieldInfo
+from zope.publisher.interfaces import NotFound
+
+
+class Download(Base):
+    def _getFile(self):
+        if not self.fieldname:
+            info = IPrimaryFieldInfo(self.context, None)
+            if info is None:
+                # Ensure that we have at least a filedname
+                raise NotFound(self, '', self.request)
+            self.fieldname = info.fieldname
+            file = info.value
+        else:
+            context = getattr(self.context, 'aq_explicit', self.context)
+            file = getattr(context, self.fieldname, None)
+
+        if file is None:
+            raise NotFound(self, self.fieldname, self.request)
+
+        return file

esdrt/content/browser/carryover.py

@@ -0,0 +1,247 @@
+from functools import partial
+from itertools import takewhile
+from logging import getLogger
+
+import openpyxl
+import plone.api as api
+from DateTime import DateTime
+from Products.CMFCore.utils import getToolByName
+from Products.Five.browser import BrowserView
+from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
+from Products.statusmessages.interfaces import IStatusMessage
+from zope.component.hooks import getSite
+
+from esdrt.content.roles.localrolesubscriber import grant_local_roles
+
+LOG = getLogger("esdrt.content.carryover")
+
+
+def _read_col(row, nr):
+    val = row[nr].value
+    return val.strip() if val else val
+
+
+def _clear_local_roles(obj):
+    obj.__ac_local_roles__ = None
+
+
+def clear_and_grant_roles(obj):
+    """Clear any local roles already granted and grant just those
+    that make sense in the current review folder context.
+
+    [refs #105604] This makes sure that users that were granted
+    local roles on the old observation will not continue to
+    have them (e.g. CounterPart).
+    """
+    _clear_local_roles(obj)
+    grant_local_roles(obj)
+
+
+def _copy_obj(target, ob, new_id=None):
+    orig_ob = ob
+    ob_id = new_id or orig_ob.getId()
+    ob = ob._getCopy(target)
+    ob._setId(ob_id)
+    target._setObject(ob_id, ob, suppress_events=True)
+    return target[ob_id]
+
+
+def _copy_and_flag(context, obj, new_id=None):
+    _, _, year, index = (new_id or obj.getId()).split("-")
+    ob = _copy_obj(context, obj, new_id=new_id)
+    ob.carryover_from = year
+    ob.review_year = int(year)
+
+    LOG.info(
+        "Copied %s -> %s",
+        obj.absolute_url(1),
+        ob.absolute_url(1),
+    )
+
+    return ob
+
+
+def _obj_from_url(context, site_url, url):
+    traversable = str(url.split(site_url)[-1][1:])
+    return context.unrestrictedTraverse(traversable)
+
+
+def replace_conclusion_text(workflows, obj, text):
+    wft = workflows["tool"]
+    in_phase2 = wft.getInfoFor(obj, "review_state").startswith("phase2")
+    conclusion = obj.get_conclusion_phase2() if in_phase2 else obj.get_conclusion()
+    if text and conclusion:
+        conclusion.text = text
+
+
+def prepend_qa(target, source):
+    source_qa = source.get_question()
+    target_qa = target.get_question()
+
+    if source_qa and target_qa:
+        for comment in list(source_qa.values()):
+            _copy_obj(target_qa, comment)
+
+        ordering = target_qa.getOrdering()
+        ordering.orderObjects(key="creation_date")
+
+    elif source_qa and not target_qa:
+        _copy_obj(target, source_qa)
+
+
+def add_to_wh(wf, obj, action, state, actor):
+    wh = obj.workflow_history
+    wf_id = wf.getId()
+    wh[wf_id] = tuple(wh[wf_id]) + (
+        {
+            "comments": "Carryover force state",
+            "actor": actor,
+            "time": DateTime(),
+            "action": action,
+            "review_state": state,
+        },
+    )
+    wf.updateRoleMappingsFor(obj)
+
+
+def reopen_with_qa(workflows, obj, actor):
+    wft = workflows["tool"]
+    in_phase2 = wft.getInfoFor(obj, "review_state").startswith("phase2")
+
+    action_obj = "phase1-reopen"
+    action_question = "phase1-reopen"
+    new_state_obj = "phase1-carried-over"
+    new_state_question = "phase1-draft"
+
+    add_to_wh(workflows["observation"], obj, action_obj, new_state_obj, actor)
+    question = obj.get_question()
+    if question:
+        add_to_wh(
+            workflows["question"],
+            question,
+            action_question,
+            new_state_question,
+            actor,
+        )
+
+    if in_phase2:
+        wf_conclusion = workflows["conclusion2"]
+        conclusion = obj.get_conclusion_phase2()
+    else:
+        wf_conclusion = workflows["conclusion"]
+        conclusion = obj.get_conclusion()
+
+    if conclusion:
+        add_to_wh(wf_conclusion, conclusion, "redraft", "draft", actor)
+
+
+def override_owner(obj, owner):
+    if owner:
+        user = api.portal.get_tool("acl_users").getUserById(owner)
+        if user:
+            userid = user.getId()
+            obj.changeOwnership(user)
+            obj.setCreators([userid])
+            obj.manage_setLocalRoles(
+                userid,
+                [
+                    "Owner",
+                ],
+            )
+
+
+def catalog_with_children(catalog, obj):
+    catalog.catalog_object(obj)
+    for child in obj.objectValues():
+        catalog_with_children(catalog, child)
+
+
+def copy_direct(context, catalog, workflows, obj_from_url, row):
+    source = _read_col(row, 0)
+    conclusion_text = _read_col(row, 1)
+    actor = _read_col(row, 2)
+    owner = _read_col(row, 3)
+
+    obj = obj_from_url(source)
+    ob = _copy_and_flag(context, obj)
+    override_owner(ob, owner)
+
+    replace_conclusion_text(workflows, ob, conclusion_text)
+    clear_and_grant_roles(ob)
+    reopen_with_qa(workflows, ob, actor, has_step2=context.enable_steps)
+
+    catalog_with_children(catalog, ob)
+
+
+def copy_complex(context, catalog, workflows, obj_from_url, row):
+    source = _read_col(row, 0)
+    older_source = _read_col(row, 1)
+    conclusion_text = _read_col(row, 2)
+    actor = _read_col(row, 3)
+    owner = _read_col(row, 4)
+
+    obj = obj_from_url(source)
+    older_obj = obj_from_url(older_source)
+
+    ob = _copy_and_flag(context, obj, older_obj.getId())
+    override_owner(ob, owner)
+
+    replace_conclusion_text(workflows, ob, conclusion_text)
+    prepend_qa(ob, older_obj)
+    clear_and_grant_roles(ob)
+    reopen_with_qa(workflows, ob, actor, has_step2=context.enable_steps)
+
+    catalog_with_children(catalog, ob)
+
+
+class CarryOverView(BrowserView):
+    index = ViewPageTemplateFile("templates/carryover.pt")
+
+    def __call__(self):
+        return self.index()
+
+    def start(self, action, xls):
+        portal = getSite()
+        wb = openpyxl.load_workbook(xls, read_only=True, data_only=True)
+        sheet = wb.worksheets[0]
+
+        sheet_rows = sheet.rows
+        next(sheet_rows)  # skip first row (header)
+        # extract rows with values
+        valid_rows = tuple(takewhile(lambda row: any(c.value for c in row), sheet_rows))
+
+        context = self.context
+        site_url = portal.absolute_url()
+        obj_from_url = partial(_obj_from_url, context, site_url)
+        catalog = getToolByName(portal, "portal_catalog")
+        wft = getToolByName(portal, "portal_workflow")
+
+        wf_obs = wft.getWorkflowById(wft.getChainFor("Observation")[0])
+        wf_question = wft.getWorkflowById(wft.getChainFor("Question")[0])
+        wf_conclusion = wft.getWorkflowById(wft.getChainFor("Conclusion")[0])
+        wf_conclusion2 = wft.getWorkflowById(wft.getChainFor("ConclusionsPhase2")[0])
+
+        actions = dict(direct=copy_direct, complex=copy_complex)
+        workflows = dict(
+            tool=wft,
+            observation=wf_obs,
+            question=wf_question,
+            conclusion=wf_conclusion,
+            conclusion2=wf_conclusion2,
+        )
+        copy_func = partial(
+            actions[action],
+            context,
+            catalog,
+            workflows,
+            obj_from_url,
+        )
+
+        for row in valid_rows:
+            copy_func(row)
+
+        if len(valid_rows) > 0:
+            (IStatusMessage(self.request).add("Carryover successfull!", type="info"))
+        else:
+            (IStatusMessage(self.request).add("No data provided!", type="warn"))
+        self.request.RESPONSE.redirect(context.absolute_url())

esdrt/content/browser/comments.py

@@ -0,0 +1,22 @@
+from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
+from plone.app.discussion.browser.comments import CommentForm as BaseForm
+from plone.app.discussion.browser.comments import CommentsViewlet as BaseViewlet
+
+
+class CommentForm(BaseForm):
+
+    def updateWidgets(self):
+        super(CommentForm, self).updateWidgets()
+        self.widgets['text'].rows = 15
+
+    def updateActions(self):
+        super(CommentForm, self).updateActions()
+        self.actions['comment'].title = 'Save Comment'
+        for k in list(self.actions.keys()):
+            self.actions[k].addClass('standardButton')
+            self.actions[k].addClass('defaultWFButton')
+
+
+class CommentsViewlet(BaseViewlet):
+    index = ViewPageTemplateFile("./templates/comments.pt")
+    form = CommentForm

esdrt/content/browser/configure.zcml

@@ -0,0 +1,233 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:browser="http://namespaces.zope.org/browser"
+    xmlns:i18n="http://namespaces.zope.org/i18n"
+    i18n_domain="esdrt.content">
+
+  <!-- -*- extra stuff goes here -*- -->
+
+  <browser:page
+    name="tableau_dashboard"
+    for="..reviewfolder.IReviewFolder"
+    class=".tableau.DashboardView"
+    permission="zope2.View"
+  />
+
+  <browser:page
+      name="view"
+      for="..reviewfolder.IReviewFolder"
+      class="..reviewfolder.ReviewFolderView"
+      permission="zope2.View"
+      template="templates/reviewfolderview.pt"
+  />
+
+  <browser:page
+      name="reindex_context"
+      for="*"
+      class=".management.ReindexContext"
+      permission="cmf.ManagePortal"
+    />
+
+  <browser:page
+      name="fix_carryover_2026"
+      for="*"
+      class=".management.FixCarryover"
+      permission="cmf.ManagePortal"
+    />
+
+  <browser:page
+      name="get_table"
+      for="..reviewfolder.IReviewFolder"
+      class="..reviewfolder.ReviewFolderBrowserView"
+      permission="zope2.View"
+      attribute="render"
+  />
+
+  <browser:page
+      name="export_as_xls"
+      for="..reviewfolder.IReviewFolder"
+      class="..reviewfolder.ExportReviewFolderFormView"
+      permission="esdrt.content.ExportObservations"
+  />
+
+  <browser:page
+      name="inboxview"
+      for="..reviewfolder.IReviewFolder"
+      class="..reviewfolder.InboxReviewFolderView"
+      permission="zope2.View"
+      template="templates/inboxreviewfolderview.pt"
+  />
+
+  <browser:page
+      name="finalisedfolderview"
+      for="..reviewfolder.IReviewFolder"
+      class="..reviewfolder.FinalisedFolderView"
+      permission="zope2.View"
+      template="templates/finalisedfolderview.pt"
+  />
+
+  <browser:page
+        name="assign_counterpart_form"
+        for="..question.IQuestion"
+        class=".statechange.AssignCounterPartForm"
+        permission="zope2.View"
+        />
+
+    <browser:page
+        name="reassign_counterpart_form"
+        for="..question.IQuestion"
+        class=".statechange.ReAssignCounterPartForm"
+        permission="zope2.View"
+        />
+
+    <browser:page
+        name="assign_answerer_form"
+        for="..question.IQuestion"
+        class=".statechange.AssignAnswererForm"
+        permission="zope2.View"
+        />
+
+    <browser:page
+        name="select-new-mse"
+        for="..question.IQuestion"
+        class=".statechange.ReAssignMSExpertsForm"
+        permission="zope2.View"
+        />
+
+    <browser:page
+        name="request-redraft"
+        for="..question.IQuestion"
+        class=".statechange.RequestRedraftReasonForm"
+        permission="zope2.View"
+        />
+
+    <browser:page
+        name="assign_conclusion_reviewer_form"
+        for="..observation.IObservation"
+        class=".statechange.AssignConclusionReviewerForm"
+        permission="zope2.View"
+        />
+
+
+    <browser:page
+        name="request-finish-observation"
+        for="..observation.IObservation"
+        class=".statechange.FinishObservationReasonForm"
+        permission="zope2.View"
+        />
+
+    <browser:page
+        name="deny-finish-observation"
+        for="..observation.IObservation"
+        class=".statechange.DenyFinishObservationReasonForm"
+        permission="zope2.View"
+        />
+
+    <browser:viewletManager
+        name="esdrt.content.commentmanager"
+        provides=".interfaces.ICommentDiscussion"
+        permission="zope2.View"
+        class="plone.app.viewletmanager.manager.BaseOrderedViewletManager"
+        />
+
+
+     <browser:viewlet
+        name="plone.comments"
+        for="..comment.IComment"
+        layer="plone.app.discussion.interfaces.IDiscussionLayer"
+        manager=".interfaces.ICommentDiscussion"
+        view="plone.app.layout.globals.interfaces.IViewView"
+        class=".comments.CommentsViewlet"
+        permission="esdrt.content.ViewCommentDiscussion"
+        />
+
+     <browser:viewlet
+        name="plone.comments"
+        for="..commentanswer.ICommentAnswer"
+        layer="plone.app.discussion.interfaces.IDiscussionLayer"
+        manager=".interfaces.ICommentDiscussion"
+        view="plone.app.layout.globals.interfaces.IViewView"
+        class=".comments.CommentsViewlet"
+        permission="esdrt.content.ViewAnswerDiscussion"
+        />
+
+     <browser:viewlet
+        name="plone.comments"
+        for="..conclusion.IConclusion"
+        layer="plone.app.discussion.interfaces.IDiscussionLayer"
+        manager=".interfaces.ICommentDiscussion"
+        view="plone.app.layout.globals.interfaces.IViewView"
+        class=".comments.CommentsViewlet"
+        permission="esdrt.content.ViewConclusionDiscussion"
+        />
+
+     <browser:viewlet
+        name="plone.comments"
+        for="..conclusionsphase2.IConclusionsPhase2"
+        layer="plone.app.discussion.interfaces.IDiscussionLayer"
+        manager=".interfaces.ICommentDiscussion"
+        view="plone.app.layout.globals.interfaces.IViewView"
+        class=".comments.CommentsViewlet"
+        permission="esdrt.content.ViewConclusionDiscussion"
+        />
+
+    <browser:page
+        name="download"
+        for="plone.app.discussion.interfaces.IComment"
+        class=".attachmentdownload.Download"
+        permission="zope2.View"
+        />
+
+    <browser:page
+        name="manage_forcing_workflow_state"
+        for="*"
+        class=".statechange.UpdateWorkflow"
+        permission="cmf.ManagePortal"
+        />
+
+    <browser:page
+        name="observation_import_form"
+        for="esdrt.content.reviewfolder.IReviewFolder"
+        template="templates/import_observation.pt"
+        permission="cmf.ManagePortal"
+        />
+
+    <browser:page
+        name="observation_import"
+        for="esdrt.content.reviewfolder.IReviewFolder"
+        class=".observation_import.ObservationXLSImport"
+        attribute="do_import"
+        permission="cmf.ManagePortal"
+        />
+
+    <browser:page
+        name="get_sample_xls"
+        for="esdrt.content.reviewfolder.IReviewFolder"
+        class=".get_sample_xls.GetSampleXLS"
+        permission="cmf.ManagePortal"
+        />
+
+    <browser:page
+        name="macros"
+        for="..reviewfolder.IReviewFolder"
+        template="templates/macros.pt"
+        class=".macros.MacrosView"
+        permission="zope2.View"
+        />
+
+    <browser:page
+      name="carryover-form"
+      for="esdrt.content.reviewfolder.IReviewFolder"
+      class=".carryover.CarryOverView"
+      permission="cmf.ManagePortal"
+      />
+
+    <browser:page
+      name="carryover"
+      for="esdrt.content.reviewfolder.IReviewFolder"
+      class=".carryover.CarryOverView"
+      permission="cmf.ManagePortal"
+      attribute="start"
+      />
+
+</configure>

esdrt/content/browser/copyfiles.py

@@ -0,0 +1,22 @@
+from Acquisition import aq_inner
+from Acquisition import aq_parent
+from Products.Five import BrowserView
+
+
+class CopyFileToAnswer(BrowserView):
+
+    def render(self):
+        context = aq_inner(self.context)
+        conversation = aq_parent(context)
+        answer = aq_parent(conversation)
+        file = getattr(context, 'attachment', None)
+        candidate_id = file.filename
+        while candidate_id in list(answer.keys()):
+            candidate_id += '-1'
+
+        filename = answer.invokeFactory(
+            id=candidate_id,
+            type_name='ESDRTFile',
+            file=file,
+        )
+        return self.request.response.redirect(context.absolute_url())