ftw.participation 1.6.0

Invite other users (registered or unregistered) to a context in plone.

ftw.participation

With ftw.participation users can invite other users to a participate in a area (e.g. Workspace) of a Plone installation.

A privileges user is able to invite another person by going to the invite view and entering the e-mail address of the other person. The person receives a email with a link to the Plone installation where he / she can log in with a existing user or create a new one. On the invitations view he / she can now accept or deny the invitation. When the invitation is accepted the user gets the configured privileges on the context where he / she is invited.

The invitations are stored in a special container in the annotations of the plone site root.

Each invitation has its own unique id, which is used in the URL sent to the invited person. When the plone site is accessed using this link the invitation is assigned to the users session. That’s why he can accept the invitation although he may be logged in with another user ID.

Activating

First you need to import the generic setup profile, which adds some actions, a browser layer and other stuff.

For activating the participation on a folderish content object give it the Interface ftw.participation.interfaces.IParticipationSupport which enables the participation on this context. This adds a new action “Manage participants” on this context and you can invite other people.

A invited person will receive a e-mail containing a link to the platform, containing the invitation id. After registering / logging in there is a new action “My invitations” in the user menu, where the user can accept or reject the invitation.

Using Quotas

Providing the interface ftw.participation.interfaces.IParticipationQuotaSupport adds a “Maximum amount of participaants” field to the schema which defines how many other users can be invited.

When a quota is set the user can only invite that amount of user to this context. There is a validator on the invitation form which ensures that the quota will not be crossed.

When setting the quota to 5 it is only possible to invite 4 other users because the first participant is the owner, which usually already exists. Inviting the same user multiple times counts also multiple times, but the invitor is able to retract the invitation on the “My invitations” view.

Customizing email messages

If a person is invitied to a context he gets a e-mail notification. If this person accepts or rejects the invitation the inviter is notified by e-mail. Those e-mails are multipart emails containing a HTML part and a plaintext fallback part.

The messages may be customized eather by overwriting the translations or by customizing the mail templates in ftw.participation.browser.

Installing

• Just add ftw.participation to the eggs in your buildout configuration:

[instance]
eggs +=
    ftw.participation

• Install the generic setup profile.

Events

• ftw.participation.events.IInvitationCreatedEvent: An invitation was created.

• ftw.participation.events.IInvitationAcceptedEvent: An invitation was accepted.

• ftw.participation.events.IInvitationRejectedEvent: An invitation was rejected.

• ftw.participation.events.IInvitationRetractedEvent: An invitation was retracted.

• ftw.participation.events.IRolesChangedEvent: The roles of a participant was changed.

• ftw.participation.events.ILocalRoleRemoved: A local role was removed.

Links

• Github: https://github.com/4teamwork/ftw.participation

• Issues: https://github.com/4teamwork/ftw.participation/issues

• Pypi: http://pypi.python.org/pypi/ftw.participation

• Continuous integration: https://jenkins.4teamwork.ch/search?q=ftw.participation

Copyright

This package is copyright by 4teamwork.

ftw.participation is licensed under GNU General Public License, version 2.

Changelog

1.6.0 (2020-02-10)

• Add reminder button for pending invitations. [2e12]

• Use unittest instead of unittest2. [busykoala]

1.5.3 (2017-06-24)

• Fix AttributeError “get_target” when accepting. [jone]

1.5.2 (2017-04-06)

• Fixes an issue where it was not possible to invite an existing user whose userid was not equal to his loginname. [elioschmutz]

1.5.1 (2017-03-02)

• Prevent crash when changing roles of participants if “Products.PloneHotfix20160830” is installed. [mbaechtold]

• Prevent crash if “ftw.activity” 1.x is installed. [mbaechtold]

1.5.0 (2016-12-20)

• Improve ftw.lawgiver support for translated role titles. [jone]

1.4.1 (2016-12-09)

• Fix unicode errors in activity renderer. [jone]

1.4.0 (2016-11-30)

• Add ftw.activity support for participation events. [jone]

• Add events. [jone]

• Drop Plone 4.1 and 4.2 support. [jone]

1.3.8 (2016-11-11)

• Change german translation for the InvitationAccepted text. [raphael-s]

• Check if we actually have a invitation for an id in the session. [tschanzt]

1.3.7 (2014-12-11)

• Fix condition for invite_participants view. Only raise NotFound if both options (invite email/member) are disabled. [mathias.leimgruber]

1.3.6 (2014-12-08)

• BugFix: Pass email_from as string, not as email.header instance. This fixes sending emails with an Exchange. [mathias.leimgruber]

• Do not show invite link, if internal user and email invitation is disabled. [mathias.leimgruber]

1.3.5 (2014-09-15)

• Update Translations.

1.3.4 (2014-08-07)

• Participants: fix table layout for read-only users. [jone]

• Participants: hide users without roles. This can happen when inheriting the Owner, because inherited Owner roles are removed. [jone]

1.3.3 (2014-08-07)

• Fix some grammar mistakes in translations. [tschanzt]

• Do not encode from address only name. [tschanzt]

1.3.2 (2014-06-02)

• Show inherited roles on participants tab. [mathias.leimgruber]

• Make sure the participation-tab has no manipulation control elements if IParticipationSupport is not active. [mathias.leimgruber]

• The participants-tab now also works without IParticipationSupport (read only). [mathias.leimgruber]

1.3.1 (2014-03-14)

• When allow_multiple_roles is disabled, the Reader role should not be added to the selected role as default role, since it does not make sense to have multiple roles in this case. [jone]

1.3.0 (2014-03-14)

• Add possibility to change the roles thru the participants view. [mathias.leimgruber]

1.2.2 (2014-03-12)

• Fix view-registrations if accessing e.g. on subsites. [elioschmutz]

1.2.1 (2014-02-10)

• Encode Mailheaders correctly. [tschanzt]

1.2.0 (2014-02-03)

• Make participants view available for normal users. The view removes the management UI (invite / remove participants) when the user has not enough privileges. The link to the participants view is still protected, a link can be placed on integration level when needed. [jone]

• Add French and English translations. [jone]

• Update German translations. [jone]

• Add dexterity support. [jone]

1.1.3 (2014-01-09)

• Owners cannot be removed with the participants view. [mathias.leimgruber]

1.1.2 (2013-09-16)

• Fix unicode decode error on participants view. [jone]

1.1.1 (2013-08-28)

• Participants view: show the invitors fullname instead of his id. [jone]

1.1 (2013-08-26)

• Add possibility to remove pending invitations on participants view. [mathias.leimgruber]

• Fix UnicodeDecodeError in participants listing. [mathias.leimgruber]

• Set roles field on invitation form to required if multiple roles is disabled. [mathias.leimgruber]

• Allow granting “Reader” role when single roles is configured. [jone]

• Possibility to configure if only one or multiple roles can be passed on invite form. [mathias.leimgruber]

• Remove unnecessary informations on participants view, add better description [mathias.leimgruber]

• Open invite form in a overlay. [mathias.leimgruber]

• Show all participants and pending invitations on participants overview. [mathias.leimgruber]

1.0.6 (2013-04-23)

• Fixed typo in translation. [Julian Infanger]

• Fix redirect to login form when hitting @@invitations anonymously. [jone]

1.0.5 (2013-03-27)

• Added class for button in participants tab. [Julian Infanger]

1.0.4 (2013-01-21)

• Use fieldsets for a better ui experience. [mathias.leimgruber]

• Some german translations. [mathias.leimgruber]

1.0.2 (2012-10-10)

• Fixed javascript to select and deselect all checkboxes. [Julian Infanger]

• Added default classes to buttons in invitations view, so they are styled in theme. [Julian Infanger]

• Extend invitation send message by email addresses. [mathias.leimgruber]

• Accept view: add optional argument for disabling the redirect. This is necessary when the view is called in another process, such as registration. [jone]

• Fix redirection loop: redirect to root when there are no invitations. [jone]

1.0.1 (2012-03-05)

• Fixed unicode-error in email header. [jinfanger]

1.0b2 (2011-03-29)

• Fix setters roles method, for old invitations without roles attr. [mathias.leimgruber]

1.0b1 (2011-02-10)

• Set “came_from” if user was invited. [mathias.leimgruber]

• Select additional roles for invitations [mathias.leimgruber]

• Added condition for invalid invitations. [mathias.leimgruber]

1.0a3 (2010-12-22)

• Fix in participation.pt - don’t show groups [mathias.leimgruber]

1.0a2 (2010-11-30)

• load plone.app.workflow [mathias.leimgruber]

1.0a1 (2010-10-26)

• Initial implementation [jbaumann]