Vobject implementation
authorJames French <[email protected]>
Mon, 13 Jun 2011 15:28:56 +0000 (23:28 +0800)
committerJames French <[email protected]>
Mon, 13 Jun 2011 15:28:56 +0000 (23:28 +0800)
icalparse.py
parserrules.py
vobjectRules.py [deleted file]

index 3cdc7f1..c1078ec 100755 (executable)
 import sys
 import urlparse
 import os
+import vobject
 from cgi import parse_header
 
 
-class InvalidICS(Exception): pass
-class IncompleteICS(InvalidICS): pass
-
-def lineJoiner(oldcal, encoding='utf-8'):
-       '''Takes a string containing a calendar and returns an array of its lines'''
-       try:
-               oldcal = unicode(oldcal, encoding)
-               oldcal = oldcal.replace('\r\n ', '').replace('\r\n\t','')
-       except UnicodeDecodeError:
-               # This is probably a file with badly folded lines
-               oldcal = oldcal.replace('\r\n ', '').replace('\r\n\t','')
-               try: oldcal = unicode(oldcal, encoding)
-               except UnicodeDecodeError:
-                       sys.stderr.write('Malformed File')
-                       raise
-
-       if not oldcal[0:15] == 'BEGIN:VCALENDAR':
-               raise InvalidICS, "Does not appear to be a valid ICS file"
-
-       if not 'END:VCALENDAR' in oldcal[-15:-1]:
-               raise IncompleteICS, "File appears to be incomplete"
-
-       if list(oldcal) == oldcal:
-               oldcal = '\r\n'.join(oldcal)
-
-       return oldcal.split('\r\n')
-
-
-def lineFolder(oldcal, length=75):
-       '''Folds content lines to a specified length, returns a list'''
-
-       if length > 75:
-               sys.stderr.write('WARN: lines > 75 octets are not RFC compliant\n')
-
-       cal = []
-       sl = length - 1
-
-       for uline in oldcal:
-               line = uline.encode('utf-8')
-
-               # Line fits inside length, do nothing
-               if len(line) <= length:
-                       cal.append(line)
-
-               else:
-                       ll = length
-                       foldedline = []
-                       while uline:
-                               ufold = unicode(line[0:ll], 'utf-8', 'ignore')
-                               fold = ufold.encode('utf-8')
-                               uline = uline.replace(ufold,u'',1)
-                               line = uline.encode('utf-8')
-                               foldedline.append(fold)
-
-                               # Subsequent lines are shorter as they include a space
-                               ll = length - 1
-                       cal.append('\r\n '.join(foldedline))
-
-       return cal
-
-
-def splitFields(cal):
-       '''Takes a list of lines in a calendar file and returns a list of tuples
-       as (key, value) pairs'''
-
-       ical = []
-
-       # Check that we got 2 items on every line
-       for line in [tuple(x.split(':',1)) for x in cal]:
-               if not len(line) == 2 and line[0]:
-                       raise InvalidICS, 'Unusual content line: %s'%line
-               elif line[0]:
-                       ical.append(line)
-
-       return ical
-
-
-def joinFields(ical):
-       '''Takes a list of tuples that make up a calendar file and returns it to a
-       list of lines'''
-
-       return [':'.join(x) for x in ical]
-
-
 def getContent(url='',stdin=False):
        '''Generic content retriever, DO NOT use this function in a CGI script as
        it can read from the local disk (which you probably don't want it to).
@@ -210,38 +127,13 @@ def generateRules():
        return rules
 
 
-def applyRules(ical, rules=[], verbose=False):
+def applyRules(cal, rules=[], verbose=False):
        'Runs a series of rules on the lines in ical and mangles its output'
 
        for rule in rules:
-               output = []
-               if rule.__doc__ and verbose:
-                       print(rule.__doc__)
-               for line in ical:
-                       try:
-                               out = rule(line[0],line[1])
-                       except TypeError, e:
-                               output.append(line)
-                               print(e)
-                               continue
-
-                       # Drop lines that are boolean False
-                       if not out and not out == None: continue
-
-                       # If the rule did something and is a tuple or a list we'll accept it
-                       # otherwise, pay no attention to the man behind the curtain
-                       try:
-                               if tuple(out) == out or list(out) == out and len(out) == 2:
-                                       output.append(tuple(out))
-                               else:
-                                       output.append(line)
-                       except TypeError, e:
-                               output.append(line)
-
-               ical = output
-
-       return ical
+               cal = rule(cal)
 
+       return cal
 
 def writeOutput(cal, outfile=''):
        '''Takes a list of lines and outputs to the specified file'''
@@ -259,29 +151,11 @@ def writeOutput(cal, outfile=''):
                        sys.stderr.write('%s\n'%e)
                        sys.exit(1)
 
-       if cal[-1]: cal.append('')
-
-       out.write('\r\n'.join(cal))
+       cal.serialize(out)
 
        if not out == sys.stdout:
                out.close()
 
-
-def vobjectRules(ics):
-       '''Applies rules to the ICS file before we have our way with it'''
-
-       try:
-               import vobjectRules
-       except ImportError:
-               sys.stderr.write('Vobject rules file could not be imported\n')
-               return ics
-
-       for rule in vobjectRules.runRules:
-               ics = rule(ics)
-
-       return ics
-
-
 if __name__ == '__main__':
        from optparse import OptionParser
        # If the user passed us a 'stdin' argument, we'll go with that,
@@ -297,9 +171,6 @@ if __name__ == '__main__':
        parser.add_option('-m','--encoding', dest='encoding', default='',
                help='Specify a different character encoding'
                '(ignored if the remote server also specifies one)')
-       parser.add_option('-r','--vobject-rules',
-               action='store_true', dest='vobject',
-               help='Run rules written for vobject stored in vobjectRules.py')
 
        (options, args) = parser.parse_args()
 
@@ -313,8 +184,8 @@ if __name__ == '__main__':
 
        (content, encoding) = getContent(url, options.stdin)
        encoding = encoding or options.encoding or 'utf-8'
-       if options.vobject: content = vobjectRules(content)
-       cal = lineJoiner(content, encoding)
-       ical = applyRules(splitFields(cal), generateRules(), options.verbose)
-       output = lineFolder(joinFields(ical))
-       writeOutput(output, options.outfile)
+
+       cal = vobject.readOne(unicode(content, encoding))
+       cal = applyRules(cal, generateRules(), options.verbose)
+
+       writeOutput(cal, options.outfile)
index fb2c67e..cf0fbd6 100644 (file)
@@ -1,38 +1,71 @@
 #!/usr/bin/python
-#
-# Copyright (c) 2010 James French <[email protected]>
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-# This file describes a series of rules which will be called on an ics file as
-# rule(key, value)
-
-# Your functions are expected to return a (key, value) tuple or they will be
-# treated as if they don't exist (ie, the line will go through unhindered).
-# Returning any boolean false value other than a None will return the line from
-# the final iCalendar file
-
-# The doc string will be presented to the user when run as verbose, so
-# please be polite
-
-def markEventsPublic(key, value):
-       '''Marking private events public'''
-       # Required as google are strict about the CLASS:PRIVATE/CLASS:CONFIDENTIAL
-       # lines and Facebook like to set them
-       if key == 'CLASS': return (key, 'PUBLIC')
+
+# Rules for tackling facebook and google calendar - I want visibility of the
+# organiser... not useful Google!
+
+import vobject
+
+def facebookOrganiser(cal):
+       '''Adds organiser details to the body of facebook calendars.'''
+
+       if cal.contents.has_key(u'prodid'):
+               if not "Facebook" in cal.prodid.value: return cal
+
+       for event in cal.vevent_list:
+               if not event.contents.has_key(u'organizer'): continue
+               organizer = "Organised by: " + event.organizer.cn_param + " ("
+               organizer += event.organizer.value.lstrip('MAILTO:') + ")\n\n"
+
+               event.description.value = organizer + event.description.value
+
+       return cal
+
+def whatPrivacy(cal):
+       '''Marks events public so google calendar doesn't have a sad about them.'''
+
+       for event in cal.vevent_list:
+               if event.contents.has_key(u'class'):
+                       del event.contents[u'class']
+                       # Bit of a hack as class is a reserved word in python
+                       event.add('class').value = "PUBLIC"
+
+       return cal
+
+def dropMSKeys(cal):
+       '''Drops microsoft keys, good for outlook, just bandwidth when not.'''
+
+       eventBlacklist = [x.lower() for x in [
+               "X-ALT-DESC",
+               "X-MICROSOFT-CDO-BUSYSTATUS",
+               "X-MICROSOFT-CDO-IMPORTANCE",
+               "X-MICROSOFT-DISALLOW-COUNTER",
+               "X-MS-OLK-ALLOWEXTERNCHECK",
+               "X-MS-OLK-AUTOSTARTCHECK",
+               "X-MS-OLK-CONFTYPE",
+               "X-MS-OLK-AUTOFILLLOCATION"
+       ]]
+
+       vcalBlacklist = [x.lower() for x in [
+       "X-CALEND",
+       "X-CALSTART",
+       "X-CLIPEND",
+       "X-CLIPSTART",
+       "X-MS-OLK-WKHRDAYS",
+       "X-MS-OLK-WKHREND",
+       "X-MS-OLK-WKHRSTART",
+       "X-OWNER",
+       "X-PRIMARY-CALENDAR",
+       "X-PUBLISHED-TTL",
+       "X-WR-CALDESC",
+       "X-WR-CALNAME",
+       "X-WR-RELCALID"
+       ]]
+
+       for event in cal.vevent_list:
+               for blacklist in eventBlacklist:
+                       if event.contents.has_key(blacklist): del event.contents[blacklist]
+
+       for blacklist in vcalBlacklist:
+               if cal.contents.has_key(blacklist): del cal.contents[blacklist]
+
+       return cal
diff --git a/vobjectRules.py b/vobjectRules.py
deleted file mode 100644 (file)
index 33fb527..0000000
+++ /dev/null
@@ -1,26 +0,0 @@
-#!/usr/bin/python
-
-# Rules for tackling facebook and google calendar - I want visibility of the
-# organiser... not useful Google!
-
-import vobject
-import sys
-
-def facebookOrganiser(ics):
-       '''Adds organiser details to the body of facebook calendars.'''
-
-       cal = vobject.readOne(ics)
-
-       if cal.contents.has_key('PRODID'):
-               if not "Facebook" in cal.contents.prodid.value: return ics
-
-       for event in cal.vevent_list:
-               if not event.contents.has_key(u'organizer'): continue
-               organizer = "Organised by: " + event.organizer.cn_param + " ("
-               organizer += event.organizer.value.lstrip('MAILTO:') + ")\n\n"
-
-               event.description.value = organizer + event.description.value
-
-       return cal.serialize()
-
-runRules = [facebookOrganiser]

UCC git Repository :: git.ucc.asn.au