parserrules.py

   1 #!/usr/bin/python
   2 #
   3 # Copyright (c) 2011 James French <[email protected]>
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining a copy
   6 # of this software and associated documentation files (the "Software"), to deal
   7 # in the Software without restriction, including without limitation the rights
   8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 # copies of the Software, and to permit persons to whom the Software is
  10 # furnished to do so, subject to the following conditions:
  11 #
  12 # The above copyright notice and this permission notice shall be included in
  13 # all copies or substantial portions of the Software.
  14 #
  15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 # THE SOFTWARE.
  22
  23 # This file describes a series of rules which must handle a vobject object and
  24 # return it to the calling script
  25
  26 # The doc string will be presented to the user when run as verbose, so
  27 # please be polite
  28
  29 import vobject
  30
  31 def facebookOrganiser(cal):
  32         '''Adds organiser details to the body of facebook calendars.'''
  33
  34         if cal.contents.has_key(u'prodid'):
  35                 if not "Facebook" in cal.prodid.value: return cal
  36
  37         for event in cal.vevent_list:
  38                 if not event.contents.has_key(u'organizer'): continue
  39                 try:
  40                         a = event.organizer.cn_paramlist
  41                         organizer = "Organised by: " + event.organizer.cn_param + " ("
  42                         organizer += event.organizer.value.lstrip('MAILTO:') + ")\n\n"
  43                         event.description.value = organizer + event.description.value
  44                 except AttributeError:
  45                         organizer = "Organized by: " + event.organizer.value
  46                         event.description.value = organizer + "\n\n" + event.description.value
  47         return cal
  48
  49 def whatPrivacy(cal):
  50         '''Marks events public so google calendar doesn't have a sad about them.'''
  51
  52         for event in cal.vevent_list:
  53                 if event.contents.has_key(u'class'):
  54                         # Bit of a hack as class is a reserved word in python
  55                         del event.contents[u'class']
  56                         event.add('class').value = "PUBLIC"
  57
  58         return cal
  59
  60 def dropAttributes(cal):
  61         '''Removing unwanted metadata'''
  62
  63         eventBlacklist = [x.lower() for x in [
  64                 "X-ALT-DESC",
  65                 "X-MICROSOFT-CDO-BUSYSTATUS",
  66                 "X-MICROSOFT-CDO-IMPORTANCE",
  67                 "X-MICROSOFT-DISALLOW-COUNTER",
  68                 "X-MS-OLK-ALLOWEXTERNCHECK",
  69                 "X-MS-OLK-AUTOSTARTCHECK",
  70                 "X-MS-OLK-CONFTYPE",
  71                 "X-MS-OLK-AUTOFILLLOCATION",
  72                 "TRANSP",
  73                 "SEQUENCE",
  74                 "PRIORITY"
  75         ]]
  76
  77         mainBlacklist = [x.lower() for x in [
  78                 "X-CLIPSTART",
  79                 "X-CALSTART",
  80                 "X-OWNER",
  81                 "X-MS-OLK-WKHRSTART",
  82                 "X-MS-OLK-WKHREND",
  83                 "X-WR-RELCALID",
  84                 "X-MS-OLK-WKHRDAYS",
  85                 "X-MS-OLK-APPTSEQTIME",
  86                 "X-CLIPEND",
  87                 "X-CALEND",
  88                 "VTIMEZONE",
  89                 "X-PRIMARY-CALENDAR"
  90         ]]
  91
  92         for event in cal.vevent_list:
  93                 for blacklist in eventBlacklist:
  94                         if event.contents.has_key(blacklist): del event.contents[blacklist]
  95
  96         for blkl in mainBlacklist:
  97                 while blkl in cal.contents: del cal.contents[blkl]
  98
  99         return cal
 100
 101 def exDate(cal):
 102         '''Replacing multi-value EXDATES with multiple single-value EXDATES'''
 103
 104         from datetime import datetime
 105         from pytz import timezone
 106
 107         default = timezone('Australia/Perth')
 108
 109
 110         for event in cal.vevent_list:
 111                 if not event.contents.has_key(u'exdate'): continue
 112                 dates = event.exdate.value
 113
 114                 del event.contents[u'exdate']
 115
 116                 for date in dates:
 117                         if isinstance(date, datetime):
 118                                 if date.tzinfo is None: date = date.replace(tzinfo = default)
 119                                 date = date.astimezone(vobject.icalendar.utc)
 120                         entry = event.add(u'exdate')
 121                         entry.value = [date]
 122
 123         return cal
 124
 125 def utcise(cal):
 126         '''Removing local timezones in favour of UTC'''
 127
 128         from datetime import datetime
 129         from pytz import timezone
 130
 131         default = timezone('Australia/Perth')
 132
 133         for event in cal.vevent_list:
 134                 dtstart = getattr(event, 'dtstart', None)
 135                 dtend = getattr(event, 'dtend', None)
 136
 137                 for i in (dtstart, dtend):
 138                         if not i: continue
 139                         dt = i.value
 140                         if isinstance(dt, datetime):
 141                                 if dt.tzinfo is None: dt = dt.replace(tzinfo = default)
 142                                 i.value = dt.astimezone(vobject.icalendar.utc)
 143
 144         return cal
 145
 146 def unwantedParams(cal):
 147         '''Removing unwanted parameters'''
 148
 149         blklist = [
 150                 "LANGUAGE",
 151                 "X-VOBJ-ORIGINAL-TZID",
 152                 "TZID"
 153         ]
 154
 155         for event in cal.vevent_list:
 156                 for attr in event.contents:
 157                         attr = getattr(event, attr)
 158                         try:
 159                                 for i in blklist:
 160                                         while i in attr.params: del attr.params[i]
 161                         except AttributeError: continue
 162
 163         return cal
 164
 165 def exDate(cal):
 166         '''Changes multi-EXDATE into singles (apple can't obey even simple specs)'''
 167
 168         for event in cal.vevent_list:
 169                 if not event.contents.has_key(u'exdate'): continue
 170                 dates = event.exdate.value
 171                 try: tzid = event.exdate.tzid_param
 172                 except AttributeError: tzid = ''
 173
 174                 del event.contents[u'exdate']
 175
 176                 for date in dates:
 177                         entry = event.add(u'exdate')
 178                         entry.value = [date]
 179                         if tzid: entry.tzid_param = tzid
 180
 181         return cal