plone.app.event 1.0b2

Event content type for plone

plone.app.event

Plone.app.event is the calendaring implementation for Plone. It provides Event Content Types (Archetypes based as well as Dexterity Behaviors), Timezone support, RFC5545 icalendar export, Recurrence support and a lot more.

The ATContentType and dexterity features are automatically enabled depending on installed packages.

Note

Please set your timezone in the @@event-settings controlpanel. Otherwise there some weired behavior can occur, like you’re apparently unable to set the time for dexterity types not to what you want. For timezone handling, we use pytz.

Installation for Plone 4.2

Just run the buildout.cfg, which is included with plone.app.event. There is also a dev.cfg buildout file, which includes the sources of Plone core package branches with integration changes for plone.app.event.

Or include the plone.app.event egg:

eggs +=
    plone.app.event [ploneintegration,archetypes,dexterity]

Last, instal Plone with the “plone.app.event Plone4 integration” profile or depend in Generic Setup in metadata.xml like so:

<dependency>profile-plone.app.event.ploneintegration:default</dependency>

You can also install optionally or additionally the dexterity profile.

Warning

Upgrading from the old ATEvent type is not tested, so don’t rely on this.

Add some events, play with recurrence, whole day events and timezones, try out the calendar and event portlets…

Note

A limitation on recurrence is, that unlimited occurrences are not supported at the moment. The number of possible recurrences of an event is limited to 1000 at the moment, so indexing - and other operations - doesn’t take too long (see: plone.event.recurrence).

PLIP implementation

This packages and the other listed in sources.cfg are part of the PLIP 10886. See: http://dev.plone.org/plone/ticket/10886

Contributing

• Report issues: https://github.com/collective/plone.app.event

• Write code and tests.

Note

Please note, allowing pull requests require the signation of the contributor agreement.

Changelog

1.0b2 (2012-10-29)

• Fix ical export of RDATE and EXDATE recurrence definitions. Fixes #63. [thet]

• Align ATEvent more to Archetypes standards and avoid AnnotationStorage and ATFieldProperty. We needed to remove the ATFieldProperty for the timezone field for a custom setter. By doing so, the other two ATFieldProperties were changed too. This way, the ATEvent API gets more consistent. For a convenient access to ATEvent as well as dextterity based event types, use the IEventAccessor from plone.event.interfaces. Upgrade step from pre 1.0b2 based ATEvent types is provided. [thet]

• Treat start/end datetime input always as localized values. Changing the timezone now doesn’t convert the start/end values to the new zone (AT, DX). [thet]

• Fix moving start/end dates when saving an unchanged DX event (issue #62). [thet]

• Portlet assignment fix. Now both - calendar and event portlet - are installed. [thet]

1.0b1 (2012-10-12)

• Add the calendar portlet by default when installing plone.app.event. [thet]

• Backport changes from “merge plip-10888-kss branch” in plone.app.portlets. KSS attributes still left in place for backwards compatibility. [thet]

• Buildout infrastructure update. [thet]

• Icalendar export of attendees almost according to the RFC5545 standard. At the moment, we do not distinguish between CN and CAL-ADDRESS in Plone, so we just put the attendee value to the CN and CAL-ADDRESS parameter. Fixes #24. [thet]

• Support microseconds for DateTime conversions. For recurrence rules, timezones are not supported due to a python-datetime limitation. [thet]

• Don’t allow ambiguous timezones like ‘CET’, which also have implementation errors in DateTime. Force them to another zone. Timezones should be set explicitly anyways. [thet]

• Let EventOccurrenceAccessor return its own URL instead of its parent. Once again fixes #58. [thet]

• Fix calendar portlet header, which day names were shifted by one day since a incompatibility between the calendar module (0 is Monday) and the strftime function (0 is Sunday). [thet]

• Create an formated_date content provider, which takes an occurrence or event object when called and formats the start/end date and times for display. This content provider can be overridden for other contexts. E.g. the events portlet uses just shows the start date and not the end date. [thet]

• Let IRecurrenceSupport adapter’s occurrences method return as first occurrence the event object itself instead of an Occurrence object. Fixes #58. [thet]

• Include plone.event’s new configure.zcml. [thet]

• For the ATEvent type, use a more specific IATEvent interface with IEvent and P.ATCT’s IATEvent as bases. So we can provide adapters, overriding more general IEvent adapting adapters. [thet]

• Don’t show start occurrence in “More occurrences” section in event_view. [thet]

• Create adapter ICalendarLinkbase which returns links to calendar views and can be overridden through a more specific implementation by addon products. For example, the portlet_calendar and portlet_events links to the @@search view can be changed to URLs to a real calendar view, if one is installed. [thet]

• For portlet_calendar and portlet_events configuration, make the workflow state selection optional. If nothing is selected, all states are searched. [thet]

• Add search_base (select path to search for events) and state (select review state for events to search) to portlet_calendar settings and search_base to portlet_events. [thet]

• Limit the amount of occurrences in the event view if the event yields more than 7 occurrences. Show only 6 occurrences and the last occurrence. [romanofski]

• More minor fixes. [thet]

  • Don’t force DateTime conversion in query parameters of get_portal_events. The catalog index uses Python’s datetime anyways.

  • Only set end date in _prepare_range to next day, if it’s a date and not datetime.

  • Register the Archetypes postprocessing event subscribers also for IObjectCreatedEvent.

• Fix #51, logical error with range_end parameter in get_portal_events. [thet]

• Fix test startup by not depending on getSite().translate, which is a filesystem script. [thet]

• Backport changes from davilima: Add safety check for False all_events_links. [davilima6]

• Make get_occurrences_by_date work for events which do not have IRecurrenceSupport (e.g. Dexterity events without the recurrence behavior). [thet]

• Don’t run event handlers for ATEvent, if it doesn’t provide IEvent. [thet]

• Fix utf-8 encoding problem with icalendar export. [rnix]

• Unregister ics_view for ATFolder and ATBTreeFolder as well in ploneintegration. [rnix]

• Workaround for buggy strftime with timezone handling in DateTime. See: https://github.com/collective/plone.app.event/pull/47 [seanupton]

• Rebind portlet_calendar tooltips after ajax calendar reloads. [thet]

• Allow the refreshCalendar kss view also on Occurrence objects. [thet]

• Let portlet_events link to @@search for future and previous events for sites without the standard events folder. [thet]

• Moved docs/HISTORY.rst to CHANGES.txt. [seanupton]

• Calendar portlet search links now use @@search (from plone.app.search) instead of (since Plone 4.2) deprecated ./search (search.pt). Requires recent plone.app.search changes. [seanupton]

• Integrate the plone.app.event-ploneintegration functionality for Plone versions without plone.app.event core integration (all current version) into this package for simplification. [thet]

• IEventSummary behavior added for body text on Dexterity event type, as well as a SearchableText indexer adapter for the Dexterity event type. [seanupton]

• Filter calendar portlet search URLs for each day to a whitelist of event portal_type values. Prevents non-event add-on types with start/end fields from showing up in calendar, as defense against unintended consequences (add-ons could explicitly override this template if they define additional Event types). [seanupton]

• API refactoring: * Move all generic interfaces to plone.event, * Extend IEventAccessor adapters to also be able to set attributes. [thet]

• Copy plonetheme.sunburst styles for the calendar portlet to event.css. This way, the calendar portlet is nicely styled, even without sunburst theme applied. [thet]

• For Dexterity behaviors, use IEventRecurrence adapter to store attributes directly on the context. This fixes that recurrence occurrences start and end dates were not indexed, because the DateRecurringIndex had not access to the recurrence attribute. [thet]

• IRecurrence adapter returns now acquisition-wrapped occurrence objects. [romanofski]

• Event portlet is now showing occurrences, sorted by start date. [romanofski]

• Moved whole_day field in directly after the end date to get a more logical group. [thet]

• Added dedicated timezone validator with fallback zone.

• Added traverser for occurrences. The event view is used to show individual occurrences. [romanofski]

• Broken paging in the calendar portlet has been fixed (#11). [romanofski]

• Make the start DateTime timezone aware and fix an issue where the start date was after the end date. Fixes: #8. [romanofski]

1.0a2 (2012-03-28)

• Add portlet GenericSetup registration for calendar and event portlet. [thet]

• API CHANGE: Use zope.annotation for behaviors, remove unnecessary factories, create IRecurrence adapter for access to occurrences. [thet]

1.0a1 (2012-03-12)

• Initial alpha release. [thet]