collective.workspace 4.0.0__py3-none-any.whl

collective/workspace/__init__.py

@@ -0,0 +1,22 @@
+from AccessControl.Permissions import add_user_folders
+from collective.workspace import pas
+from Products.PluggableAuthService import registerMultiPlugin
+from zope.i18nmessageid import MessageFactory
+
+workspaceMessageFactory = MessageFactory("collective.workspace")
+
+
+registerMultiPlugin(pas.WorkspaceGroupManager.meta_type)
+
+
+def initialize(context):
+
+    context.registerClass(
+        pas.WorkspaceGroupManager,
+        permission=add_user_folders,
+        constructors=(
+            pas.manage_addWorkspaceGroupManagerForm,
+            pas.addWorkspaceGroupManager,
+        ),
+        visibility=None,
+    )

collective/workspace/adapters.py

@@ -0,0 +1,21 @@
+from collective.workspace.interfaces import IHasWorkspace
+from plone import api
+from plone.app.dexterity.permissions import DXFieldPermissionChecker
+from zope.component import adapter
+
+
+@adapter(IHasWorkspace)
+class WorkspaceFieldPermissionChecker(DXFieldPermissionChecker):
+    def validate(self, field_name, vocabulary_name=None):
+        """Override the permission checker to allow querying the users
+        vocabulary even if there is no user field in this context
+        """
+        if (
+            field_name == "user"
+            and vocabulary_name == "plone.app.vocabularies.Users"
+            and api.user.has_permission(
+                "collective.workspace: Manage roster", obj=self.context
+            )
+        ):
+            return True
+        return super().validate(field_name, vocabulary_name)

collective/workspace/browser.py

@@ -0,0 +1,172 @@
+from AccessControl import getSecurityManager
+from collections import namedtuple
+from collective.workspace import workspaceMessageFactory as _
+from collective.workspace.interfaces import IRosterView
+from collective.workspace.interfaces import IWorkspace
+from plone.autoform.base import AutoFields
+from plone.autoform.form import AutoExtensibleForm
+from plone.z3cform import z2
+from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
+from Products.statusmessages.interfaces import IStatusMessage
+from z3c.form import button
+from z3c.form.form import DisplayForm
+from z3c.form.form import EditForm
+from z3c.form.interfaces import ActionExecutionError
+from zope.cachedescriptors.property import Lazy as lazy_property
+from zope.interface import implementer
+from zope.publisher.interfaces.browser import IPublishTraverse
+
+import transaction
+
+Action = namedtuple("Action", "label view_name permission")
+
+
+@implementer(IRosterView)
+class TeamRosterView(AutoFields, DisplayForm):
+    """Display the roster as a table."""
+
+    row_template = ViewPageTemplateFile("templates/team_roster_row.pt")
+
+    row_actions = (
+        Action("Edit", "edit-roster", "collective.workspace: Manage roster"),
+    )
+
+    table_actions = ()
+
+    def __init__(self, context, request):
+        self.context = context
+        self.request = request
+        self.workspace = IWorkspace(self.context)
+
+    @property
+    def label(self):
+        return _("Roster: ${title}", mapping={"title": self.context.Title()})
+
+    @lazy_property
+    def schema(self):
+        return self.workspace.membership_schema
+
+    ignoreContext = True
+
+    def getContent(self):
+        return self.context
+
+    def row_views(self):
+        for membership in self.workspace:
+            for widget in self.widgets.values():
+                widget.ignoreContext = False
+                widget.context = membership
+                widget.update()
+            yield self.row_template(membership=membership)
+
+    @lazy_property
+    def can_edit_roster(self):
+        return getSecurityManager().checkPermission(
+            "collective.workspace: Manage roster", self.context
+        )
+
+    def update(self):
+        z2.switch_on(self)
+        self.updateFieldsFromSchemata()
+        self.updateWidgets()
+
+    def render(self):
+        return self.index()
+
+    def __call__(self):
+        self.update()
+        return self.render()
+
+
+@implementer(IPublishTraverse)
+class TeamMemberEditForm(AutoExtensibleForm, EditForm):
+    def __init__(self, context, request):
+        self.context = context
+        self.request = request
+        self.workspace = IWorkspace(self.context)
+
+    key = None
+
+    def publishTraverse(self, request, name):
+        self.key = name
+        return self
+
+    @lazy_property
+    def schema(self):
+        return self.workspace.membership_schema
+
+    def updateFields(self):
+        super().updateFields()
+        # don't show the user field if we are editing
+        if self.key:
+            del self.fields["user"]
+
+    @lazy_property
+    def ignoreContext(self):
+        return not bool(self.key)
+
+    @lazy_property
+    def label(self):
+        if self.key:
+            return self.getContent()._title
+        else:
+            return _("Add Person to Roster")
+
+    @lazy_property
+    def _content(self):
+        if not self.key:
+            return self.context
+        workspace = self.workspace
+        memberdata = workspace.members[self.key]
+        return workspace.membership_factory(workspace, memberdata)
+
+    def getContent(self):
+        return self._content
+
+    def validateInvariants(self, membership):
+        pass
+
+    @button.buttonAndHandler(_("Save"))
+    def handleSave(self, action):
+        data, errors = self.extractData()
+        if errors:
+            self.status = self.formErrorsMessage
+            return
+
+        status = _("Changes saved")
+
+        if self.key:
+            membership = self.getContent()
+            membership.update(data)
+        else:
+            # Add new roster member
+            membership = self.workspace.add_to_team(**data)
+            status = _("User added")
+
+        try:
+            self.validateInvariants(membership)
+        except ActionExecutionError:
+            # make sure above changes won't be persisted
+            transaction.abort()
+            raise
+
+        self._finished = True
+        IStatusMessage(self.request).addStatusMessage(status, "info")
+
+    @property
+    def can_remove(self):
+        return self.key
+
+    @button.buttonAndHandler(_("Remove"), condition=lambda self: self.can_remove)
+    def handleRemove(self, action):
+        membership = self.getContent()
+        membership.remove_from_team()
+        self._finished = True
+        IStatusMessage(self.request).addStatusMessage(_("User removed"), "info")
+
+    _finished = False
+
+    def render(self):
+        if self._finished:
+            return " "
+        return super().render()

collective/workspace/catalog.py

@@ -0,0 +1,15 @@
+from .interfaces import IHasWorkspace
+from .interfaces import IWorkspace
+from plone.indexer import indexer
+from zope.interface import Interface
+
+
+@indexer(IHasWorkspace)
+def workspace_members(self):
+    workspace = IWorkspace(self)
+    return set(workspace.members or [])
+
+
+@indexer(Interface)
+def null_indexer(self):
+    raise AttributeError

collective/workspace/configure.zcml

@@ -0,0 +1,117 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:browser="http://namespaces.zope.org/browser"
+    xmlns:five="http://namespaces.zope.org/five"
+    xmlns:genericsetup="http://namespaces.zope.org/genericsetup"
+    xmlns:i18n="http://namespaces.zope.org/i18n"
+    xmlns:plone="http://namespaces.plone.org/plone"
+    i18n_domain="collective.workspace"
+    >
+
+  <five:registerPackage
+      package="."
+      initialize=".initialize"
+      />
+  <i18n:registerTranslations directory="locales" />
+
+  <include package="plone.app.dexterity" />
+
+  <permission
+      id="collective.workspace.ViewRoster"
+      title="collective.workspace: View roster"
+      >
+    <role name="TeamMember" />
+    <role name="TeamGuest" />
+    <role name="TeamManager" />
+    <role name="Site Administrator" />
+    <role name="Manager" />
+    <role name="Owner" />
+  </permission>
+
+  <permission
+      id="collective.workspace.ManageRoster"
+      title="collective.workspace: Manage roster"
+      >
+    <role name="TeamManager" />
+    <role name="Site Administrator" />
+    <role name="Manager" />
+    <role name="Owner" />
+  </permission>
+
+  <genericsetup:registerProfile
+      name="default"
+      title="collective.workspace"
+      description="Installs the collective.workspace package"
+      provides="Products.GenericSetup.interfaces.EXTENSION"
+      directory="profiles/default"
+      />
+
+  <genericsetup:importStep
+      name="collective.workspace_various"
+      title="collective.workspace various"
+      description=""
+      handler=".setuphandlers.setup_pas"
+      />
+
+  <plone:behavior
+      name="collective.workspace.team_workspace"
+      title="Team workspace"
+      description="This item is a team workspace."
+      factory=".workspace.Workspace"
+      provides=".interfaces.IWorkspace"
+      for="plone.dexterity.interfaces.IDexterityContent"
+      marker=".interfaces.IHasWorkspace"
+      />
+
+  <browser:page
+      name="team-roster"
+      for=".interfaces.IHasWorkspace"
+      class=".browser.TeamRosterView"
+      template="templates/team_roster.pt"
+      permission="collective.workspace.ViewRoster"
+      />
+
+  <browser:page
+      name="edit-roster"
+      for=".interfaces.IHasWorkspace"
+      class=".browser.TeamMemberEditForm"
+      permission="collective.workspace.ManageRoster"
+      />
+
+  <utility
+      name="collective.workspace.groups"
+      component=".vocabs.TeamGroupsVocabulary"
+      />
+
+  <adapter factory=".adapters.WorkspaceFieldPermissionChecker" />
+
+  <adapter
+      factory=".pas.WorkspaceRoles"
+      for=".interfaces.IHasWorkspace"
+      name="collective.workspace"
+      />
+
+  <adapter factory=".membership.workspace_from_membership" />
+
+  <utility
+      factory=".pas.TeamManagerRoleDelegation"
+      provides="plone.app.workflow.interfaces.ISharingPageRole"
+      name="TeamManager"
+      />
+
+  <adapter
+      factory=".catalog.workspace_members"
+      name="workspace_members"
+      />
+  <adapter
+      factory=".catalog.null_indexer"
+      name="workspace_members"
+      />
+
+  <subscriber handler=".workspace.handle_workspace_added" />
+  <subscriber handler=".workspace.handle_workspace_modified" />
+  <subscriber handler=".workspace.handle_workspace_removed" />
+  <subscriber handler=".workspace.handle_workspace_copied" />
+  <subscriber handler=".workspace.handle_principal_deleted" />
+
+</configure>

collective/workspace/events.py

@@ -0,0 +1,27 @@
+from zope.interface.interfaces import ObjectEvent
+
+
+class TeamMemberEvent(ObjectEvent):
+    """Base for team member events.
+
+    This is used instead of normal Zope object lifecycle
+    events so it can be dispatched based on the workspace
+    rather than based on the modified object (which is
+    just a dictionary in this case).
+    """
+
+    def __init__(self, object, membership):
+        self.object = object
+        self.membership = membership
+
+
+class TeamMemberAddedEvent(TeamMemberEvent):
+    """Event for when a member is added."""
+
+
+class TeamMemberRemovedEvent(TeamMemberEvent):
+    """Event for when a member is removed."""
+
+
+class TeamMemberModifiedEvent(TeamMemberEvent):
+    """Event for when a member is modified."""

collective/workspace/i18n.sh

@@ -0,0 +1,79 @@
+#!/bin/sh
+#
+# Shell script to manage .po files.
+#
+# Run this file in the folder main __init__.py of product
+#
+# E.g. if your product is yourproduct.name
+# you run this file in yourproduct.name/yourproduct/name
+#
+#
+# Copyright 2010 mFabrik http://mfabrik.com
+#
+# http://plone.org/documentation/manual/plone-community-developer-documentation/i18n/localization
+#
+
+# Assume the product name is the current folder name
+CURRENT_PATH=`pwd`
+CATALOGNAMES="collective.workspace plone"
+
+# List of languages
+LANGUAGES="de"
+
+# Create locales folder structure for languages
+install -d locales
+for lang in $LANGUAGES; do
+    install -d locales/$lang/LC_MESSAGES
+done
+
+I18NDUDE=~/Plone/zinstance/bin/i18ndude
+
+if test ! -e $I18NDUDE; then
+        echo "You must install i18ndude with buildout"
+        echo "See https://github.com/collective/collective.developermanual/blob/master/source/i18n/localization.txt"
+        exit
+fi
+
+#
+# Do we need to merge manual PO entries from a file called manual.pot.
+# this option is later passed to i18ndude
+#
+
+for catalogname in $CATALOGNAMES; do
+    echo "Catalog: ${catalogname}"
+    if test -e locales/manual-${catalogname}.pot; then
+            echo "Manual PO entries detected"
+            MERGE="--merge locales/manual-${catalogname}.pot"
+    else
+            echo "No manual PO entries detected"
+            MERGE=""
+    fi
+    $I18NDUDE rebuild-pot --pot locales/$catalogname.pot $MERGE --create $catalogname .
+    echo ""
+done
+
+# Rebuild .pot
+
+
+# Compile po files
+for lang in $(find locales -mindepth 1 -maxdepth 1 -type d); do
+
+    if test -d $lang/LC_MESSAGES; then
+
+        for catalogname in $CATALOGNAMES; do
+
+            PO=$lang/LC_MESSAGES/${catalogname}.po
+
+            # Create po file if not exists
+            touch $PO
+
+            # Sync po file
+            echo "Syncing $PO"
+            $I18NDUDE sync --pot locales/$catalogname.pot $PO
+            echo ""
+
+        done
+    fi
+
+done
+#!/bin/sh

collective/workspace/interfaces.py

@@ -0,0 +1,16 @@
+from zope.i18nmessageid import MessageFactory
+from zope.interface import Interface
+
+_ = MessageFactory("collective.workspace")
+
+
+class IHasWorkspace(Interface):
+    """Marker for team workspaces."""
+
+
+class IWorkspace(Interface):
+    """Interface for interacting with an item's workspace features."""
+
+
+class IRosterView(Interface):
+    """Marker for display view of a roster."""

collective/workspace/locales/collective.workspace.pot

@@ -0,0 +1,95 @@
+# --- PLEASE EDIT THE LINES BELOW CORRECTLY ---
+# SOME DESCRIPTIVE TITLE.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"POT-Creation-Date: 2017-06-14 09:07+0000\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI +ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=1; plural=0\n"
+"Language-Code: en\n"
+"Language-Name: English\n"
+"Preferred-Encodings: utf-8 latin1\n"
+"Domain: DOMAIN\n"
+
+#: collective/workspace/templates/team_roster.pt:15
+msgid "&#43; Add person to roster"
+msgstr ""
+
+#: collective/workspace/browser.py:119
+msgid "Add Person to Roster"
+msgstr ""
+
+msgid "Admins"
+msgstr ""
+
+#: collective/workspace/pas.py:333
+msgid "Can edit roster"
+msgstr ""
+
+#: collective/workspace/browser.py:141
+msgid "Changes saved"
+msgstr ""
+
+msgid "Edit"
+msgstr ""
+
+#: collective/workspace/membership.py:37
+msgid "Groups"
+msgstr ""
+
+msgid "Guests"
+msgstr ""
+
+#: collective/workspace/configure.zcml:42
+msgid "Installs the collective.workspace package"
+msgstr ""
+
+#: collective/workspace/membership.py:31
+msgid "Position"
+msgstr ""
+
+#: collective/workspace/browser.py:166
+msgid "Remove"
+msgstr ""
+
+#: collective/workspace/browser.py:44
+msgid "Roster: ${title}"
+msgstr ""
+
+#: collective/workspace/browser.py:135
+msgid "Save"
+msgstr ""
+
+#: collective/workspace/templates/team_roster.pt:46
+msgid "Selected people:"
+msgstr ""
+
+#: collective/workspace/configure.zcml:57
+msgid "Team workspace"
+msgstr ""
+
+#: collective/workspace/configure.zcml:57
+msgid "This item is a team workspace."
+msgstr ""
+
+#: collective/workspace/membership.py:26
+msgid "User"
+msgstr ""
+
+#: collective/workspace/browser.py:149
+msgid "User added"
+msgstr ""
+
+#: collective/workspace/browser.py:172
+msgid "User removed"
+msgstr ""
+
+#: collective/workspace/configure.zcml:42
+msgid "collective.workspace"
+msgstr ""

collective/workspace/locales/de/LC_MESSAGES/collective.workspace.po

@@ -0,0 +1,92 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"POT-Creation-Date: 2017-06-14 09:07+0000\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI +ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=1; plural=0\n"
+"Language-Code: en\n"
+"Language-Name: English\n"
+"Preferred-Encodings: utf-8 latin1\n"
+"Domain: DOMAIN\n"
+
+#: collective/workspace/templates/team_roster.pt:15
+msgid "&#43; Add person to roster"
+msgstr "&#43; Person zum Team hinzufügen"
+
+#: collective/workspace/browser.py:119
+msgid "Add Person to Roster"
+msgstr "Eine Person zum Team hinzufügen"
+
+msgid "Admins"
+msgstr ""
+
+#: collective/workspace/pas.py:333
+msgid "Can edit roster"
+msgstr "Kann Team bearbeiten"
+
+#: collective/workspace/browser.py:141
+msgid "Changes saved"
+msgstr "Änderungen gespeichert"
+
+msgid "Edit"
+msgstr "Bearbeiten"
+
+#: collective/workspace/membership.py:37
+msgid "Groups"
+msgstr "Gruppen"
+
+msgid "Guests"
+msgstr ""
+
+#: collective/workspace/configure.zcml:42
+msgid "Installs the collective.workspace package"
+msgstr ""
+
+#: collective/workspace/membership.py:31
+msgid "Position"
+msgstr "Position"
+
+#: collective/workspace/browser.py:166
+msgid "Remove"
+msgstr "Entfernen"
+
+#: collective/workspace/browser.py:44
+msgid "Roster: ${title}"
+msgstr "Teamverwaltung: ${title}"
+
+#: collective/workspace/browser.py:135
+msgid "Save"
+msgstr "Speichern"
+
+#: collective/workspace/templates/team_roster.pt:46
+msgid "Selected people:"
+msgstr "Ausgewählte Personen"
+
+#: collective/workspace/configure.zcml:57
+msgid "Team workspace"
+msgstr ""
+
+#: collective/workspace/configure.zcml:57
+msgid "This item is a team workspace."
+msgstr ""
+
+#: collective/workspace/membership.py:26
+msgid "User"
+msgstr "Benutzer"
+
+#: collective/workspace/browser.py:149
+msgid "User added"
+msgstr ""
+
+#: collective/workspace/browser.py:172
+msgid "User removed"
+msgstr "Benutzer entfernt"
+
+#: collective/workspace/configure.zcml:42
+msgid "collective.workspace"
+msgstr ""