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 ruleConfig = {}
  32 ruleConfig["defaultTZ"] = "UTC"
  33
  34 def facebookOrganiser(cal):
  35         '''Adds organiser details to the body of facebook calendars.'''
  36
  37         if cal.contents.has_key(u'prodid'):
  38                 if not "Facebook" in cal.prodid.value: return cal
  39
  40         for event in cal.vevent_list:
  41                 if not event.contents.has_key(u'organizer'): continue
  42                 try:
  43                         a = event.organizer.cn_paramlist
  44                         organizer = "Organised by: " + event.organizer.cn_param + " ("
  45                         organizer += event.organizer.value.lstrip('MAILTO:') + ")\n\n"
  46                         event.description.value = organizer + event.description.value
  47                 except AttributeError:
  48                         organizer = "Organized by: " + event.organizer.value
  49                         event.description.value = organizer + "\n\n" + event.description.value
  50         return cal
  51
  52 def whatPrivacy(cal):
  53         '''Marks events public so google calendar doesn't have a sad about them.'''
  54
  55         for event in cal.vevent_list:
  56                 if event.contents.has_key(u'class'):
  57                         # Bit of a hack as class is a reserved word in python
  58                         del event.contents[u'class']
  59                         event.add('class').value = "PUBLIC"
  60
  61         return cal
  62
  63 def dropAttributes(cal):
  64         '''Removing unwanted metadata'''
  65         if "facebook" in ruleConfig:
  66                 if ruleConfig["facebook"] == True: return cal
  67
  68         eventBlacklist = [x.lower() for x in [
  69                 "X-ALT-DESC",
  70                 "X-MICROSOFT-CDO-BUSYSTATUS",
  71                 "X-MICROSOFT-CDO-IMPORTANCE",
  72                 "X-MICROSOFT-DISALLOW-COUNTER",
  73                 "X-MS-OLK-ALLOWEXTERNCHECK",
  74                 "X-MS-OLK-AUTOSTARTCHECK",
  75                 "X-MS-OLK-CONFTYPE",
  76                 "X-MS-OLK-AUTOFILLLOCATION",
  77                 "TRANSP",
  78                 "SEQUENCE",
  79                 "PRIORITY"
  80         ]]
  81
  82         mainBlacklist = [x.lower() for x in [
  83                 "X-CLIPSTART",
  84                 "X-CALSTART",
  85                 "X-OWNER",
  86                 "X-MS-OLK-WKHRSTART",
  87                 "X-MS-OLK-WKHREND",
  88                 "X-WR-RELCALID",
  89                 "X-MS-OLK-WKHRDAYS",
  90                 "X-MS-OLK-APPTSEQTIME",
  91                 "X-CLIPEND",
  92                 "X-CALEND",
  93                 "VTIMEZONE",
  94                 "X-PRIMARY-CALENDAR"
  95         ]]
  96
  97         for event in cal.vevent_list:
  98                 for blacklist in eventBlacklist:
  99                         if event.contents.has_key(blacklist): del event.contents[blacklist]
 100
 101         for blkl in mainBlacklist:
 102                 while blkl in cal.contents: del cal.contents[blkl]
 103
 104         return cal
 105
 106 def exDate(cal):
 107         '''Replacing multi-value EXDATES with multiple single-value EXDATES'''
 108         if "facebook" in ruleConfig:
 109                 if ruleConfig["facebook"] == True: return cal
 110
 111         from datetime import datetime
 112         from pytz import timezone
 113
 114         default = timezone(ruleConfig["defaultTZ"])
 115
 116         for event in cal.vevent_list:
 117                 if not event.contents.has_key(u'exdate'): continue
 118                 dates = event.exdate.value
 119
 120                 del event.contents[u'exdate']
 121
 122                 for date in dates:
 123                         if isinstance(date, datetime):
 124                                 if date.tzinfo is None: date = date.replace(tzinfo = default)
 125                                 date = date.astimezone(vobject.icalendar.utc)
 126                         entry = event.add(u'exdate')
 127                         entry.value = [date]
 128
 129         return cal
 130
 131 def utcise(cal):
 132         '''Removing local timezones in favour of UTC. If the remote calendar specifies a timezone
 133         then use it, otherwise assume it's in the user-specified or default values'''
 134
 135         from datetime import datetime
 136         from pytz import timezone
 137
 138         default = timezone(ruleConfig["defaultTZ"])
 139
 140         for event in cal.vevent_list:
 141                 dtstart = getattr(event, 'dtstart', None)
 142                 dtend = getattr(event, 'dtend', None)
 143
 144                 for i in (dtstart, dtend):
 145                         if not i: continue
 146                         dt = i.value
 147                         if isinstance(dt, datetime):
 148                                 if dt.tzinfo is None: dt = dt.replace(tzinfo = default)
 149                                 i.value = dt.astimezone(vobject.icalendar.utc)
 150
 151         return cal
 152
 153 def unwantedParams(cal):
 154         '''Removing unwanted parameters'''
 155
 156         blklist = [
 157                 "LANGUAGE",
 158                 "X-VOBJ-ORIGINAL-TZID",
 159                 "TZID"
 160         ]
 161
 162         for event in cal.vevent_list:
 163                 for attr in event.contents:
 164                         attr = getattr(event, attr)
 165                         try:
 166                                 for i in blklist:
 167                                         while i in attr.params: del attr.params[i]
 168                         except AttributeError: continue
 169
 170         return cal