cone.calendar 1.1.0__py3-none-any.whl

cone/calendar/__init__.py

@@ -0,0 +1,20 @@
+from cone.app import main_hook
+from cone.calendar.browser import configure_resources
+import logging
+
+
+logger = logging.getLogger('cone.calendar')
+
+
+@main_hook
+def initialize_calendar(config, global_config, settings):
+    # application startup initialization
+
+    # static resources
+    configure_resources(config, settings)
+
+    # add translation
+    config.add_translation_dirs('cone.calendar:locale/')
+
+    # scan browser package
+    config.scan('cone.calendar.browser')

cone/calendar/browser/__init__.py

@@ -0,0 +1,88 @@
+from .calendar import CalendarEvents  # noqa
+from .calendar import CalendarTile  # noqa
+import os
+import webresource as wr
+
+
+resources_dir = os.path.join(os.path.dirname(__file__), 'static')
+
+# moment js
+moment_resources = wr.ResourceGroup(
+    name='cone.calendar-moment',
+    directory=os.path.join(resources_dir, 'moment'),
+    path='moment'
+)
+moment_resources.add(wr.ScriptResource(
+    name='moment-js',
+    resource='moment.min.js'
+))
+
+# fullcalendar
+fullcalendar_resources = wr.ResourceGroup(
+    name='cone.calendar-fullcalendar',
+    directory=os.path.join(resources_dir, 'fullcalendar'),
+    path='fullcalendar'
+)
+fullcalendar_resources.add(wr.ScriptResource(
+    name='fullcalendar-js',
+    depends=['moment-js', 'jquery-js'],
+    resource='fullcalendar.js',
+    compressed='fullcalendar.min.js'
+))
+fullcalendar_resources.add(wr.StyleResource(
+    name='fullcalendar-css',
+    resource='fullcalendar.css',
+    compressed='fullcalendar.min.css'
+))
+# XXX: print CSS needs to be delivered dynamically in dedicated print view
+# fullcalendar_resources.add(wr.StyleResource(
+#     name='fullcalendar-print-css',
+#     resource='fullcalendar.print.css',
+#     compressed='fullcalendar.print.min.css'
+# ))
+
+# cone calendar
+cone_calendar_resources = wr.ResourceGroup(
+    name='cone.calendar-calendar',
+    directory=os.path.join(resources_dir, 'calendar'),
+    path='calendar'
+)
+cone_calendar_resources.add(wr.ScriptResource(
+    name='cone-calendar-js',
+    depends='fullcalendar-js',
+    resource='cone.calendar.js',
+    compressed='cone.calendar.min.js'
+))
+cone_calendar_resources.add(wr.StyleResource(
+    name='cone-calendar-css',
+    depends='fullcalendar-css',
+    resource='cone.calendar.css'
+))
+
+
+def configure_resources(config, settings):
+    config.register_resource(moment_resources)
+    config.set_resource_include('moment-js', 'authenticated')
+
+    config.register_resource(fullcalendar_resources)
+    config.set_resource_include('fullcalendar-js', 'authenticated')
+    config.set_resource_include('fullcalendar-css', 'authenticated')
+
+    config.register_resource(cone_calendar_resources)
+    config.set_resource_include('cone-calendar-js', 'authenticated')
+    config.set_resource_include('cone-calendar-css', 'authenticated')
+
+    locales = settings.get('cone.calendar.locales')
+    if not locales:
+        return
+    locales_directory = os.path.join(resources_dir, 'fullcalendar', 'locale')
+    for locale in [loc.strip() for loc in locales.split(',') if loc]:
+        locale_name = 'fullcalendar-{}-js'.format(locale)
+        fullcalendar_resources.add(wr.ScriptResource(
+            name=locale_name,
+            depends='fullcalendar-js',
+            directory=locales_directory,
+            path='fullcalendar/locale',
+            resource='{}.js'.format(locale)
+        ))
+        config.set_resource_include(locale_name, 'authenticated')

cone/calendar/browser/calendar.pt

@@ -0,0 +1,16 @@
+<tal:block xmlns:tal="http://xml.zope.org/namespaces/tal"
+           xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+           xmlns:ajax="http://namespaces.conestack.org/ajax"
+           i18n:domain="cone.calendar"
+           omit-tag="True">
+
+  <tal:contextmenu condition="context.show_contextmenu"
+                   replace="structure tile('contextmenu')" />
+
+  <div id="calendar"
+       data-calendar_target='${context.target}'
+       data-calendar_options='${context.options}'
+       data-calendar_sources='${context.sources}'
+       data-calendar_actions='${context.actions}'></div>
+
+</tal:block>

cone/calendar/browser/calendar.py

@@ -0,0 +1,370 @@
+from cone.app.browser import render_main_template
+from cone.app.browser.utils import format_traceback
+from cone.tile import Tile
+from cone.tile import tile
+from datetime import datetime
+from pyramid.i18n import TranslationStringFactory
+from pyramid.view import view_config
+import json
+import logging
+
+
+logger = logging.getLogger('cone.calendar')
+_ = TranslationStringFactory('cone.calendar')
+
+
+def parse_date(seconds):
+    """Parse datetime from value received from fullcalendar.
+    """
+    return datetime.utcfromtimestamp(int(seconds))
+
+
+def format_date(dt):
+    """Format datetime suitable for fullcalendar.
+    """
+    return dt.isoformat()
+
+
+@tile(name='calendar', path='calendar.pt', permission='view')
+class CalendarTile(Tile):
+    """Tile rendering the fullcalendar widget.
+
+    Reference: https://fullcalendar.io/docs/v3
+
+    Configuration of the calendar is done via ``model.properties`` object.
+
+    Available configuration properties:
+
+    ``calendar_locale``:
+        Corresponds to ``locale`` option passed to fullcalendar.
+
+        See https://fullcalendar.io/docs/v3/locale
+
+        Note: Locale files must be preloaded in order to provide the desored
+        locales. The available locales are configured in the application ini
+        file.
+
+    ``calendar_header``:
+        Corresponds to ``header`` option passed to fullcalendar.
+
+        See https://fullcalendar.io/docs/v3/header
+
+    ``calendar_footer``:
+        Corresponds to ``footer`` option passed to fullcalendar.
+
+        See https://fullcalendar.io/docs/v3/footer
+
+    ``calendar_first_day``:
+        Corresponds to ``firstDay`` option passed to fullcalendar.
+
+        See https://fullcalendar.io/docs/v3/firstDay
+
+    ``calendar_weekends``:
+        Corresponds to ``weekends`` option passed to fullcalendar.
+
+        See https://fullcalendar.io/docs/v3/weekends
+
+    ``calendar_week_numbers``:
+        Corresponds to ``weekNumbers`` option passed to fullcalendar.
+
+        See https://fullcalendar.io/docs/v3/weekNumbers
+
+    ``calendar_week_numbers_within_days``:
+        Corresponds to ``weekNumbersWithinDays`` option passed to fullcalendar.
+
+        See https://fullcalendar.io/docs/v3/weekNumbersWithinDays
+
+    ``calendar_business_hours``:
+        Corresponds to ``businessHours`` option passed to fullcalendar.
+
+        See https://fullcalendar.io/docs/v3/businessHours
+
+    ``calendar_sources``:
+        A list of dictionaries containing event source configurations.
+
+        See https://fullcalendar.io/docs/v3/event-source-object
+
+        As ``events`` attribute, a JSON view name is expected. On the client
+        side a callback handler gets created using this view name for fetching
+        event data. The base class for implementing JSON event data is
+        ``CalendarEvents``.
+
+        If ``calendar_sources`` is not defined on model properties,
+        ``CalendarTile.default_sources`` is used.
+
+    ``calendar_actions``:
+        List of actions for clicking empty day/time in calendar.
+
+        Action definition format and behavior is the same as for the ``actions``
+        attribute of event data.
+
+        See ``CalendarEvents.events`` documentation for details.
+
+        As default target the calendar context target is used if not defined
+        explicitely on actions.
+
+        If ``calendar_actions`` is not defined on model properties,
+        ``CalendarTile.default_actions`` is used.
+    """
+    show_contextmenu = False
+    option_mapping = {
+        'calendar_locale': 'locale',
+        'calendar_header': 'header',
+        'calendar_footer': 'footer',
+        'calendar_first_day': 'firstDay',
+        'calendar_weekends': 'weekends',
+        'calendar_week_numbers': 'weekNumbers',
+        'calendar_week_numbers_within_days': 'weekNumbersWithinDays',
+        'calendar_business_hours': 'businessHours'
+    }
+    default_options = {
+        'calendar_locale': 'en'
+    }
+    default_sources = [{
+        'events': 'calendar_events'
+    }]
+    default_actions = []
+
+    @property
+    def target(self):
+        """Calendar context target. Gets used for querying event sources.
+        """
+        return self.nodeurl
+
+    @property
+    def options(self):
+        options = {}
+        for prop_name, option_name in self.option_mapping.items():
+            value = getattr(self.model.properties, prop_name)
+            if value is None:
+                value = self.default_options.get(prop_name)
+            if value is not None:
+                options[option_name] = value
+        return json.dumps(options, sort_keys=True) if options else None
+
+    @property
+    def sources(self):
+        sources = self.model.properties.calendar_sources
+        if not sources:
+            sources = self.default_sources
+        return json.dumps(sources)
+
+    @property
+    def actions(self):
+        actions = self.model.properties.calendar_actions
+        if not actions:
+            actions = self.default_actions
+        return json.dumps(actions)
+
+
+@view_config(name='calendar', permission='view')
+def calendar(model, request):
+    """Traversable view rendering the ``calendar`` tile to content area.
+    """
+    return render_main_template(model, request, 'calendar')
+
+
+class JSONView(object):
+    """Abstract JSON view.
+    """
+
+    def __init__(self, model, request):
+        self.model = model
+        self.request = request
+
+    def __call__(self):
+        """Return dict with JSON data result.
+
+        If success, dict contains data at key 'data'.
+
+        If an exception is raised while computing, dict contains flag indicating
+        error happends at key 'error' and the formatted traceback at key
+        'message'.
+        """
+        try:
+            return dict(data=self.data())
+        except Exception as e:
+            logger.exception(e)
+            return dict(
+                error=True,
+                message=format_traceback()
+            )
+
+    def data(self):
+        """Supposed to be implemented on subclass. Responsible to compute JSON
+        data delivered to client.
+        """
+        raise NotImplementedError(
+            'Abstract ``JSONView`` does not implement ``data``'
+        )
+
+
+@view_config(
+    name='calendar_events',
+    accept='application/json',
+    renderer='json',
+    permission='view')
+class CalendarEvents(JSONView):
+    """Abstract JSON event data view for fullcalendar.
+
+    Concrete even data providers must derive from this object and implement
+    ``events`` function.
+    """
+
+    @property
+    def range_start(self):
+        """Event range start as datetime.
+        """
+        start = self.request.params.get('start')
+        return parse_date(start)
+
+    @property
+    def range_end(self):
+        """Event range end as datetime.
+        """
+        end = self.request.params.get('end')
+        return parse_date(end)
+
+    def events(self, start, end):
+        """Return events for requested range.
+
+        Return format:
+
+        [{
+            'id': uuid.UUID,
+            'title': 'Event Title',
+            'start': datetime.datetime,
+            'end': datetime.datetime,
+            'target': 'https://example.com/path/to/event',
+            'actions': [{
+                'title': 'Edit',
+                'icon': 'glyphicons glyphicons-pencil',
+                'target': 'https://example.com/path/to/event?param=value',
+                'overlay': {
+                    'action': 'overlayedit',
+                    'selector': '#ajax-form',
+                    'content_selector': '.overlay_content',
+                    'css': 'overlay-form'
+                }
+            }, {
+                'title': 'Delete',
+                'icon': 'glyphicons glyphicons-remove-circle',
+                'confirm': 'Do you really want to delete this event?',
+                'action': {
+                    'name': 'delete',
+                    'selector': 'NONE',
+                    'mode': 'NONE'
+                }
+            }]
+        }]
+
+        For a full list of fullcalendar event attributes see
+        https://fullcalendar.io/docs/v3/event-object
+
+        The ``actions`` and ``target`` attributes are cone specific.
+
+        ``target`` defines the default target where actions get executed.
+        Target can be overwritten by specific actions. Target represents the URL of
+        the event without trailing view name and may contain a query string.
+        Target is mandatory if event is editable or actions are defined which
+        do not provide a target on their own.
+
+        ``actions`` defines a list of actions available for the specific event.
+
+        If one action is specified, it gets executed directly when event gets
+        clicked.
+
+        If multiple actions are specified, a dropdown menu containing the actions
+        as menu items gets rendered.
+
+        Action options:
+
+        ``title``
+            The action title as string.
+
+        ``icon``
+            Icon CSS class. Optional.
+
+        ``target``
+            Target on which the action gets executed. Target represents the URL
+            of the event without trailing view name and may contain a query
+            string. Optional, if skipped the default target is used.
+
+        ``action``
+            bdajax action definitions as dict containing:
+
+            {
+                'name': 'action_name',
+                'selector': '.some_selector',
+                'mode': 'replace'
+            }
+
+            At least one option out of ``action``, ``event`` or ``overlay`` must
+            be defined. An arbitrary combination is possible.
+
+        ``event``
+            bdajax event definitions as dict containing:
+
+            {
+                'name': 'eventname',
+                'selector': '.some_selector'
+            }
+
+            At least one option out of ``action``, ``event`` or ``overlay`` must
+            be defined. An arbitrary combination is possible.
+
+        ``overlay``
+            bdajax overlay definitions as dict containing:
+
+            {
+                'action': 'action_name',
+                'selector': '#ajax-form',
+                'content_selector': '.overlay_content',
+                'css': 'additional_overlay_css_class'
+            }
+
+            At least one option out of ``action``, ``event`` or ``overlay`` must
+            be defined. An arbitrary combination is possible.
+
+        ``confirm``
+            Confirmation message as string. Optional.
+        """
+        raise NotImplementedError(
+            'Abstract ``CalendarEvents`` does not implement ``events``'
+        )
+
+    def data(self):
+        events = self.events(self.range_start, self.range_end)
+        for event in events:
+            event['id'] = str(event['id'])
+            event['start'] = format_date(event['start'])
+            event['end'] = format_date(event['end'])
+        return events
+
+
+@view_config(
+    name='calendar_event_drop',
+    # context=IScheduled,
+    accept='application/json',
+    renderer='json',
+    permission='view')
+class CalendarEventDrop(JSONView):
+    """JSON view for modifying event start time.
+    """
+
+    def data(self):
+        return 'DROPPED'
+
+
+@view_config(
+    name='calendar_event_resize',
+    # context=IScheduled,
+    accept='application/json',
+    renderer='json',
+    permission='view')
+class CalendarEventResize(JSONView):
+    """JSON view for modifying event duration.
+    """
+
+    def data(self):
+        return 'RESIZED'

cone/calendar/browser/static/calendar/cone.calendar.css

@@ -0,0 +1,23 @@
+/* contextmenu */
+.calendar-contextmenu-wrapper {
+    position:absolute;
+    z-index:1000;
+    top:0;
+    left:0;
+    width:100%;
+}
+.calendar-contextmenu {
+    background-color:#fff;
+    position:absolute;
+    z-index:1000;
+}
+.calendar-contextmenu li {
+    padding-left:10px;
+    cursor:pointer;
+}
+.calendar-contextmenu li:hover {
+    background-color:#ccc;
+}
+.calendar-contextmenu li span {
+    margin-right:10px;
+}