Merge pull request #878 from d7415/vcf_dates

Add support for other VCARD dates (e.g. X-ANNIVERSARY)

Author: geier

AUTHORS.txt

@@ -36,4 +36,5 @@ Tobias Brummer - hallo [at] t0bybr.de - https://t0bybr.de
 Amanda Hickman - amanda [at] velociraptor [dot] info
 Raef Coles - raefcoles [at] gmail [dot] com
 Nito Martinez - nito [at] qindel [dot] com - http://qindel.com http://theqvd.com
-Florian Wehner - florian [at] whnr [dot] de
+Florian Wehner - florian [at] whnr [dot] de
+Martin Stone

CHANGELOG.rst

@@ -8,6 +8,13 @@ may want to subscribe to `GitHub's tag feed
 <https://github.com/geier/khal/tags.atom>`_.
 
 
+0.10.2
+======
+not released
+
+* NEW Parse `X-ANNIVERSARY`, `ANNIVERSARY` and `X-ABDATE` fields from vcards.
+
+
 0.10.1
 ======
 2019-03-30

khal/khalendar/backend.py

@@ -240,58 +240,83 @@ def update(self, vevent_str: str, href: str, etag: str='', calendar: str=None) -
         stuple = (vevent_str, etag, href, calendar)
         self.sql_ex(sql_s, stuple)
 
-    def update_birthday(self, vevent_str: str, href: str, etag: str='', calendar: str=None) -> None:
-        """
-        XXX write docstring
+    def update_vcf_dates(self, vevent_str: str, href: str, etag: str='',
+                         calendar: str=None) -> None:
+        """insert events from a vcard into the db
+
+        This is will parse BDAY, ANNIVERSARY, X-ANNIVERSARY and X-ABDATE fields.
+        It will also look for any X-ABLABEL fields associated with an X-ABDATE
+        and use that in the event description.
+
+        :param vevent_str: contact (vcard) to be parsed.
+        :param href: href of the card on the server, if this href already
+            exists in the db the card gets updated. If no href is given, a
+            random href is chosen and it is implied that this card does not yet
+            exist on the server, but will be uploaded there on next sync.
+        :param etag: the etag of the vcard, if this etag does not match the
+            remote etag on next sync, this card will be updated from the server.
+            For locally created vcards this should not be set
         """
         assert calendar is not None
         assert href is not None
-        self.delete(href, calendar=calendar)
+        # Delete all event entries for this contact
+        self.deletelike(href + '%', calendar=calendar)
         ical = utils.cal_from_ics(vevent_str)
         vcard = ical.walk()[0]
-        if 'BDAY' in vcard.keys():
-            bday = vcard['BDAY']
-            if isinstance(bday, list):
-                logger.warning(
-                    'Vcard {0} in collection {1} has more than one '
-                    'BIRTHDAY, will be skipped and not be available '
-                    'in khal.'.format(href, calendar)
-                )
-                return
-            try:
-                if bday[0:2] == '--' and bday[3] != '-':
-                    bday = '1900' + bday[2:]
-                    orig_bday = False
+        for key in vcard.keys():
+            if key in ['BDAY', 'X-ANNIVERSARY', 'ANNIVERSARY'] or key.endswith('X-ABDATE'):
+                date = vcard[key]
+                if isinstance(date, list):
+                    logger.warning(
+                        'Vcard {0} in collection {1} has more than one '
+                        '{2}, will be skipped and not be available '
+                        'in khal.'.format(href, calendar, key)
+                    )
+                    continue
+                try:
+                    if date[0:2] == '--' and date[3] != '-':
+                        date = '1900' + date[2:]
+                        orig_date = False
+                    else:
+                        orig_date = True
+                    date = parser.parse(date).date()
+                except ValueError:
+                    logger.warning(
+                        'cannot parse {0} in {1} in collection {2}'.format(key, href, calendar))
+                    continue
+                if 'FN' in vcard:
+                    name = vcard['FN']
                 else:
-                    orig_bday = True
-                bday = parser.parse(bday).date()
-            except ValueError:
-                logger.warning(
-                    'cannot parse BIRTHDAY in {0} in collection {1}'.format(href, calendar))
-                return
-            if 'FN' in vcard:
-                name = vcard['FN']
-            else:
-                n = vcard['N'].split(';')
-                name = ' '.join([n[1], n[2], n[0]])
-            vevent = icalendar.Event()
-            vevent.add('dtstart', bday)
-            vevent.add('dtend', bday + dt.timedelta(days=1))
-            if bday.month == 2 and bday.day == 29:  # leap year
-                vevent.add('rrule', {'freq': 'YEARLY', 'BYYEARDAY': 60})
-            else:
-                vevent.add('rrule', {'freq': 'YEARLY'})
-            if orig_bday:
-                vevent.add('x-birthday',
-                           '{:04}{:02}{:02}'.format(bday.year, bday.month, bday.day))
-                vevent.add('x-fname', name)
-            vevent.add('summary', '{0}\'s birthday'.format(name))
-            vevent.add('uid', href)
-            vevent_str = vevent.to_ical().decode('utf-8')
-            self._update_impl(vevent, href, calendar)
-            sql_s = ('INSERT INTO events (item, etag, href, calendar) VALUES (?, ?, ?, ?);')
-            stuple = (vevent_str, etag, href, calendar)
-            self.sql_ex(sql_s, stuple)
+                    n = vcard['N'].split(';')
+                    name = ' '.join([n[1], n[2], n[0]])
+                vevent = icalendar.Event()
+                vevent.add('dtstart', date)
+                vevent.add('dtend', date + dt.timedelta(days=1))
+                if date.month == 2 and date.day == 29:  # leap year
+                    vevent.add('rrule', {'freq': 'YEARLY', 'BYYEARDAY': 60})
+                else:
+                    vevent.add('rrule', {'freq': 'YEARLY'})
+                description = get_vcard_event_description(vcard, key)
+                if orig_date:
+                    if key == 'BDAY':
+                        xtag = 'x-birthday'
+                    elif key.endswith('ANNIVERSARY'):
+                        xtag = 'x-anniversary'
+                    else:
+                        xtag = 'x-abdate'
+                        vevent.add('x-ablabel', description)
+                    vevent.add(xtag,
+                               '{:04}{:02}{:02}'.format(date.year, date.month, date.day))
+                    vevent.add('x-fname', name)
+                vevent.add('summary',
+                           '{0}\'s {1}'.format(name, description))
+                vevent.add('uid', href + key)
+                vevent_str = vevent.to_ical().decode('utf-8')
+                self._update_impl(vevent, href + key, calendar)
+                sql_s = ('INSERT INTO events (item, etag, href, calendar)'
+                         ' VALUES (?, ?, ?, ?);')
+                stuple = (vevent_str, etag, href + key, calendar)
+                self.sql_ex(sql_s, stuple)
 
     def _update_impl(self, vevent: icalendar.cal.Event, href: str, calendar: str) -> None:
         """insert `vevent` into the database
@@ -407,6 +432,23 @@ def delete(self, href: str, etag: Any=None, calendar: str=None):
         sql_s = 'DELETE FROM events WHERE href = ? AND calendar = ?;'
         self.sql_ex(sql_s, (href, calendar))
 
+    def deletelike(self, href: str, etag: Any=None, calendar: str=None):
+        """
+        removes events from the db that match an SQL 'like' statement,
+
+        :param href: The pattern of hrefs to delete. May contain SQL wildcards
+                     like '%'
+        :param etag: only there for compatibility with vdirsyncer's Storage,
+                     we always delete
+        :returns: None
+        """
+        assert calendar is not None
+        for table in ['recs_loc', 'recs_float']:
+            sql_s = 'DELETE FROM {0} WHERE href LIKE ? AND calendar = ?;'.format(table)
+            self.sql_ex(sql_s, (href, calendar))
+        sql_s = 'DELETE FROM events WHERE href LIKE ? AND calendar = ?;'
+        self.sql_ex(sql_s, (href, calendar))
+
     def list(self, calendar):
         """ list all events in `calendar`
 
@@ -611,3 +653,22 @@ def calc_shift_deltas(vevent: icalendar.Event) -> Tuple[dt.timedelta, dt.timedel
     except KeyError:
         duration = vevent['DURATION'].dt
     return start_shift, duration
+
+
+def get_vcard_event_description(vcard: icalendar.cal.Component, key: str) -> str:
+    if key == 'BDAY':
+        return 'birthday'
+    elif key.endswith('ANNIVERSARY'):
+        return 'anniversary'
+    elif key.endswith('X-ABDATE'):
+        desc_key = key[:-8] + 'X-ABLABEL'
+        if desc_key in vcard.keys():
+            return vcard[desc_key]
+        else:
+            desc_key = key[:-8] + 'X-ABLabel'
+            if desc_key in vcard.keys():
+                return vcard[desc_key]
+            else:
+                return 'custom event from vcard'
+    else:
+        return 'unknown event from vcard'

khal/khalendar/event.py

@@ -351,11 +351,23 @@ def export_ics(self, path):
 
     @property
     def summary(self):
-        bday = self._vevents[self.ref].get('x-birthday', None)
-        if bday:
-            number = self.start_local.year - int(bday[:4])
+        description = None
+        date = self._vevents[self.ref].get('x-birthday', None)
+        if date:
+            description = 'birthday'
+        else:
+            date = self._vevents[self.ref].get('x-anniversary', None)
+            if date:
+                description = 'anniversary'
+            else:
+                date = self._vevents[self.ref].get('x-abdate', None)
+                if date:
+                    description = self._vevents[self.ref].get('x-ablabel', 'custom event')
+
+        if date:
+            number = self.start_local.year - int(date[:4])
             name = self._vevents[self.ref].get('x-fname', None)
-            if int(bday[4:6]) == 2 and int(bday[6:8]) == 29:
+            if int(date[4:6]) == 2 and int(date[6:8]) == 29:
                 leap = ' (29th of Feb.)'
             else:
                 leap = ''
@@ -367,8 +379,8 @@ def summary(self):
                 suffix = 'rd'
             else:
                 suffix = 'th'
-            return '{name}\'s {number}{suffix} birthday{leap}'.format(
-                name=name, number=number, suffix=suffix, leap=leap,
+            return '{name}\'s {number}{suffix} {desc}{leap}'.format(
+                name=name, number=number, suffix=suffix, desc=description, leap=leap,
             )
         else:
             return self._vevents[self.ref].get('SUMMARY', '')

khal/khalendar/khalendar.py

@@ -305,6 +305,7 @@ def _db_update(self, calendar: str):
         local_ctag = self._local_ctag(calendar)
         db_hrefs = set(href for href, etag in self._backend.list(calendar))
         storage_hrefs = set()
+        bdays = self._calendars[calendar].get('ctype') == 'birthdays'
 
         with self._backend.at_once():
             for href, etag in self._storages[calendar].list():
@@ -314,7 +315,14 @@ def _db_update(self, calendar: str):
                     logger.debug('Updating {0} because {1} != {2}'.format(href, etag, db_etag))
                     self._update_vevent(href, calendar=calendar)
             for href in db_hrefs - storage_hrefs:
-                self._backend.delete(href, calendar=calendar)
+                if bdays:
+                    for sh in storage_hrefs:
+                        if href.startswith(sh):
+                            break
+                    else:
+                        self._backend.delete(href, calendar=calendar)
+                else:
+                    self._backend.delete(href, calendar=calendar)
             self._backend.set_ctag(local_ctag, calendar=calendar)
             self._last_ctags[calendar] = local_ctag
 
@@ -324,7 +332,7 @@ def _update_vevent(self, href: str, calendar: str) -> bool:
         event, etag = self._storages[calendar].get(href)
         try:
             if self._calendars[calendar].get('ctype') == 'birthdays':
-                update = self._backend.update_birthday
+                update = self._backend.update_vcf_dates
             else:
                 update = self._backend.update
             update(event.raw, href=href, etag=etag, calendar=calendar)