Remove dependency of portal_calendar tool

Author: rodfersou

CHANGES.rst

@@ -13,6 +13,9 @@ There's a frood who really knows where his towel is.
     All Layout tab helper views use now ``collective.cover.CanEditLayout`` permission.
     The ``BaseGrid`` class is now located in the ``collective.cover.grids`` module.
 
+- Remove dependency on portal_calendar tool for tile calendar.
+  [rodfersou]
+
 - Remove dependency on plone.directives.form.
   [l34marr]
 

src/collective/cover/testing.py

@@ -169,7 +169,7 @@ def setUpPloneSite(self, portal):
 
         portal_workflow = portal.portal_workflow
         portal_workflow.setChainForPortalTypes(
-            ['Collection'], ['simple_publication_workflow'])
+            ['Event', 'Collection'], ['simple_publication_workflow'])
 
         # Prevent kss validation errors in Plone 4.2
         portal_kss = getattr(portal, 'portal_kss', None)

src/collective/cover/tests/test_calendar_tile.py

@@ -2,6 +2,8 @@
 from collective.cover.tests.base import TestTileMixin
 from collective.cover.tiles.calendar import CalendarTile
 from collective.cover.tiles.calendar import ICalendarTile
+from datetime import datetime
+from plone import api
 
 import unittest
 
@@ -10,10 +12,28 @@ class CalendarTileTestCase(TestTileMixin, unittest.TestCase):
 
     def setUp(self):
         super(CalendarTileTestCase, self).setUp()
+
+        # Pin calendar to month 08/2016
+        self.request['year'] = 2016
+        self.request['month'] = 8
+
         self.tile = CalendarTile(self.cover, self.request)
         self.tile.__name__ = u'collective.cover.calendar'
         self.tile.id = u'test'
 
+        # Pin today as day 18
+        self.tile.isToday = lambda day: day == 18
+
+        # create some events
+        with api.env.adopt_roles(['Manager']):
+            for i in [3, 12, 21, 30]:
+                start = datetime(2016, 8, i, 10, 30)
+                end = datetime(2016, 8, i, 11, 30)
+                obj = api.content.create(
+                    container=self.portal, type='Event', id='e{0}'.format(i),
+                    startDate=start, endDate=end, start=start, end=end)
+                api.content.transition(obj, 'publish')
+
     @unittest.expectedFailure  # FIXME: raises BrokenImplementation
     def test_interface(self):
         self.interface = ICalendarTile
@@ -28,12 +48,79 @@ def test_default_configuration(self):
     def test_accepted_content_types(self):
         self.assertEqual(self.tile.accepted_ct(), [])
 
+    def test_getEventsForCalendar(self):
+        self.assertEqual(self.tile.getEventsForCalendar(), EXPECTED_CALENDAR)
+
+    def test_getYearAndMonthToDisplay(self):
+        self.assertEqual(self.tile.getYearAndMonthToDisplay(), (2016, 8))
+
+    def test_getWeekdays(self):
+        expected = [
+            u'weekday_mon_short', u'weekday_tue_short', u'weekday_wed_short',
+            u'weekday_thu_short', u'weekday_fri_short', u'weekday_sat_short',
+            u'weekday_sun_short']
+        self.assertEqual(self.tile.getWeekdays(), expected)
+
+    def test_getReviewStateString(self):
+        self.assertEqual(self.tile.getReviewStateString(), 'review_state=published&')
+
+    def test_getEventTypes(self):
+        self.assertEqual(self.tile.getEventTypes(), 'Type=Event&')
 
-# load tests only in Plone < 5
-def test_suite():
-    # FIXME: https://github.com/collective/collective.cover/issues/633
-    from collective.cover.config import IS_PLONE_5
-    if IS_PLONE_5:
-        return unittest.TestSuite()
 
-    return unittest.defaultTestLoader.loadTestsFromName(__name__)
+EXPECTED_CALENDAR = [
+    [{'day': 1, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 2, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'date_string': '2016-8-3',
+      'day': 3,
+      'event': 1,
+      'eventslist': [{'end': '11:30:00', 'start': '10:30:00', 'title': 'e3'}],
+      'eventstring': u'Aug 03, 2016\n 10:30-11:30 e3',
+      'is_today': False},
+     {'day': 4, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 5, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 6, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 7, 'event': 0, 'eventslist': [], 'is_today': False}],
+    [{'day': 8, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 9, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 10, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 11, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'date_string': '2016-8-12',
+      'day': 12,
+      'event': 1,
+      'eventslist': [{'end': '11:30:00', 'start': '10:30:00', 'title': 'e12'}],
+      'eventstring': u'Aug 12, 2016\n 10:30-11:30 e12',
+      'is_today': False},
+     {'day': 13, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 14, 'event': 0, 'eventslist': [], 'is_today': False}],
+    [{'day': 15, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 16, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 17, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 18, 'event': 0, 'eventslist': [], 'is_today': True},
+     {'day': 19, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 20, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'date_string': '2016-8-21',
+      'day': 21,
+      'event': 1,
+      'eventslist': [{'end': '11:30:00', 'start': '10:30:00', 'title': 'e21'}],
+      'eventstring': u'Aug 21, 2016\n 10:30-11:30 e21',
+      'is_today': False}],
+    [{'day': 22, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 23, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 24, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 25, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 26, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 27, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 28, 'event': 0, 'eventslist': [], 'is_today': False}],
+    [{'day': 29, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'date_string': '2016-8-30',
+      'day': 30,
+      'event': 1,
+      'eventslist': [{'end': '11:30:00', 'start': '10:30:00', 'title': 'e30'}],
+      'eventstring': u'Aug 30, 2016\n 10:30-11:30 e30',
+      'is_today': False},
+     {'day': 31, 'event': 0, 'eventslist': [], 'is_today': False},
+     {'day': 0, 'event': 0, 'eventslist': []},
+     {'day': 0, 'event': 0, 'eventslist': []},
+     {'day': 0, 'event': 0, 'eventslist': []},
+     {'day': 0, 'event': 0, 'eventslist': []}]]

src/collective/cover/tests/test_upgrades.py

@@ -524,8 +524,6 @@ def test_registrations(self):
         self.assertGreaterEqual(int(version), int(self.to_version))
         self.assertEqual(self._how_many_upgrades_to_do(), 4)
 
-    # FIXME: https://github.com/collective/collective.cover/issues/633
-    @unittest.skipIf(IS_PLONE_5, 'Upgrade step not supported under Plone 5')
     def test_register_calendar_tile(self):
         # address also an issue with Setup permission
         title = u'Register calendar tile'

src/collective/cover/tests/test_vocabularies.py

@@ -1,5 +1,4 @@
 # -*- coding: utf-8 -*-
-from collective.cover.config import IS_PLONE_5
 from collective.cover.controlpanel import ICoverSettings
 from collective.cover.testing import INTEGRATION_TESTING
 from plone.registry.interfaces import IRegistry
@@ -46,10 +45,6 @@ def test_available_tiles_vocabulary(self):
             'collective.cover.richtext',
         ]
 
-        # FIXME: https://github.com/collective/collective.cover/issues/633
-        if IS_PLONE_5:
-            expected.remove('collective.cover.calendar')
-
         self.assertEqual(len(tiles), len(expected))
         for i in expected:
             self.assertIn(i, tiles)
@@ -73,10 +68,6 @@ def test_enabled_tiles_vocabulary(self):
             'collective.cover.richtext',
         ]
 
-        # FIXME: https://github.com/collective/collective.cover/issues/633
-        if IS_PLONE_5:
-            expected.remove('collective.cover.calendar')
-
         self.assertEqual(len(tiles), len(expected))
         for i in expected:
             self.assertIn(i, tiles)

src/collective/cover/tiles/calendar.py

@@ -1,20 +1,28 @@
 # -*- coding: utf-8 -*-
+# Avoid to import wrong calendar module
+# http://stackoverflow.com/a/8280677/2116850
+from __future__ import absolute_import
 from Acquisition import aq_inner
 from collective.cover import _
 from collective.cover.tiles.base import IPersistentCoverTile
 from collective.cover.tiles.base import PersistentCoverTile
 from DateTime import DateTime
+from plone import api
+from plone.api.exc import InvalidParameterError
 from Products.CMFCore.utils import getToolByName
 from Products.CMFPlone.utils import safe_unicode
 from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
 from time import localtime
 from urllib import quote_plus
-from zope.component import getMultiAdapter
 from zope.i18nmessageid import MessageFactory
 from zope.interface import implementer
 
+import calendar
+
 
 PLMF = MessageFactory('plonelocales')
+EVENT_INTERFACES = [
+    'plone.event.interfaces.IEvent', 'Products.ATContentTypes.interfaces.event.IATEvent']
 
 
 class ICalendarTile(IPersistentCoverTile):
@@ -39,7 +47,6 @@ def __init__(self, context, request):
 
     def _setup(self):
         context = aq_inner(self.context)
-        self.calendar = getToolByName(context, 'portal_calendar')
         self._ts = getToolByName(context, 'translation_service')
         self.url_quote_plus = quote_plus
 
@@ -56,31 +63,57 @@ def _setup(self):
 
         self.monthName = PLMF(self._ts.month_msgid(month),
                               default=self._ts.month_english(month))
+        self._set_first_weekday()
+
+    def _set_first_weekday(self):
+        try:  # Plone 5.x
+            first_weekday = api.portal.get_registry_record('plone.first_weekday')
+        except InvalidParameterError:
+            try:  # plone.app.event
+                first_weekday = api.portal.get_registry_record('plone.app.event.first_weekday')
+            except InvalidParameterError:  # Plone 4.x
+                portal_calendar = api.portal.get_tool('portal_calendar')
+                first_weekday = getattr(portal_calendar, 'firstweekday', calendar.SUNDAY)
+        calendar.setfirstweekday(first_weekday)
 
     def accepted_ct(self):
         """Return an empty list as no content types are accepted."""
         return []
 
-    def getEventsForCalendar(self):
-        context = aq_inner(self.context)
-        year = self.year
-        month = self.month
-        portal_state = getMultiAdapter((self.context, self.request), name='plone_portal_state')
-        navigation_root_path = portal_state.navigation_root_path()
-        weeks = self.calendar.getEventsForCalendar(month, year, path=navigation_root_path)
-        for week in weeks:
-            for day in week:
-                daynumber = day['day']
-                if daynumber == 0:
-                    continue
-                day['is_today'] = self.isToday(daynumber)
-                if day['event']:
-                    cur_date = DateTime(year, month, daynumber)
-                    localized_date = [self._ts.ulocalized_time(cur_date, context=context, request=self.request)]
-                    day['eventstring'] = '\n'.join(localized_date + [
-                        ' {0}'.format(self.getEventString(e)) for e in day['eventslist']])
-                    day['date_string'] = '{0}-{1}-{2}'.format(year, month, daynumber)
+    def addEvents(self, day):
+        catalog = api.portal.get_tool('portal_catalog')
+        start = DateTime(self.year, self.month, day['day'])
+        end = start + 1
+        query = dict(
+            object_provides=EVENT_INTERFACES, review_state='published',
+            start={'query': (start, end), 'range': 'min:max'}, sort_on='start')
+        for brain in catalog(**query):
+            day['event'] += 1
+            day['date_string'] = '{0}-{1}-{2}'.format(self.year, self.month, day['day'])
+            if 'eventslist' not in day:
+                day['eventslist'] = []
+            event = dict(
+                start=brain.start.Time(), end=brain.end.Time(), title=brain.Title or brain.id)
+            day['eventslist'].append(event)
+            if 'eventstring' not in day:
+                localized_date = self._ts.ulocalized_time(
+                    start, context=self.context, request=self.request)
+                day['eventstring'] = localized_date
+            day['eventstring'] += '\n {0}'.format(self.getEventString(event))
+        return day
 
+    def getEventsForCalendar(self):
+        monthcalendar = calendar.monthcalendar(self.year, self.month)
+        weeks = []
+        for w in monthcalendar:
+            week = []
+            for d in w:
+                day = {'day': d, 'event': 0, 'eventslist': []}
+                if d > 0:
+                    day['is_today'] = self.isToday(d)
+                    day = self.addEvents(day)
+                week.append(day)
+            weeks.append(week)
         return weeks
 
     def getEventString(self, event):
@@ -100,22 +133,12 @@ def getEventString(self, event):
         return eventstring
 
     def getYearAndMonthToDisplay(self):
-        session = None
         request = self.request
 
         # First priority goes to the data in the REQUEST
         year = request.get('year', None)
         month = request.get('month', None)
 
-        # Next get the data from the SESSION
-        if self.calendar.getUseSession():
-            session = request.get('SESSION', None)
-            if session:
-                if not year:
-                    year = session.get('calendar_year', None)
-                if not month:
-                    month = session.get('calendar_month', None)
-
         # Last resort to today
         if not year:
             year = self.now[0]
@@ -129,11 +152,6 @@ def getYearAndMonthToDisplay(self):
         except (TypeError, ValueError):
             year, month = self.now[:2]
 
-        # Store the results in the session for next time
-        if session:
-            session.set('calendar_year', year)
-            session.set('calendar_month', month)
-
         # Finally return the results
         return year, month
 
@@ -153,12 +171,12 @@ def getNextMonth(self, year, month):
 
     def getWeekdays(self):
         """Returns a list of Messages for the weekday names."""
-        weekdays = []
-        # list of ordered weekdays as numbers
-        for day in self.calendar.getDayNumbers():
-            weekdays.append(PLMF(self._ts.day_msgid(day, format='s'),
-                                 default=self._ts.weekday_english(day, format='a')))
 
+        weekheaders = calendar.weekheader(3).split()
+        weekdays = []
+        for header in weekheaders:
+            weekdays.append(PLMF('weekday_{0}_short'.format(header.lower()),
+                                 default=header))
         return weekdays
 
     def isToday(self, day):
@@ -169,11 +187,13 @@ def isToday(self, day):
             self.now[2] == day and self.now[1] == self.month and self.now[0] == self.year)
 
     def getReviewStateString(self):
-        states = self.calendar.getCalendarStates()
+        states = ['published']
         return ''.join(map(lambda x: 'review_state={0}&'.format(self.url_quote_plus(x)), states))
 
     def getEventTypes(self):
-        types = self.calendar.getCalendarTypes()
+        catalog = api.portal.get_tool('portal_catalog')
+        query = dict(object_provides=EVENT_INTERFACES)
+        types = set([b.portal_type for b in catalog(**query)])
         return ''.join(map(lambda x: 'Type={0}&'.format(self.url_quote_plus(x)), types))
 
     def getQueryString(self):

src/collective/cover/vocabularies.py

@@ -1,5 +1,4 @@
 # -*- coding: utf-8 -*-
-from collective.cover.config import IS_PLONE_5
 from collective.cover.controlpanel import ICoverSettings
 from collective.cover.interfaces import IGridSystem
 from collective.cover.tiles.base import IPersistentCoverTile
@@ -36,10 +35,6 @@ def __call__(self, context):
         settings = registry.forInterface(ICoverSettings)
         tiles = settings.available_tiles
 
-        # FIXME: https://github.com/collective/collective.cover/issues/633
-        if IS_PLONE_5 and 'collective.cover.calendar' in tiles:
-            tiles.remove('collective.cover.calendar')
-
         items = [SimpleTerm(value=i, title=i) for i in tiles]
         return SimpleVocabulary(items)
 
@@ -59,10 +54,6 @@ class EnabledTilesVocabulary(object):
     """Return a list of tiles ready to work with collective.cover."""
 
     def _enabled(self, name):
-        # FIXME: https://github.com/collective/collective.cover/issues/633
-        if IS_PLONE_5 and name == 'collective.cover.calendar':
-            return False
-
         tile_type = queryUtility(ITileType, name)
         if tile_type:
             return issubclass(tile_type.schema, IPersistentCoverTile)