icalparse.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 import sys
  24 import urlparse
  25 import os
  26 import vobject
  27 from cgi import parse_header
  28
  29 def getContent(url='',stdin=False):
  30         '''Generic content retriever, DO NOT use this function in a CGI script as
  31         it can read from the local disk (which you probably don't want it to).
  32         '''
  33
  34         encoding = '' # If we don't populate this, the script will assume UTF-8
  35
  36         # Special case, if this is a HTTP url, return the data from it using
  37         # the HTTP functions which attempt to play a bit nicer.
  38         parsedURL = urlparse.urlparse(url)
  39         if 'http' in parsedURL[0]: return getHTTPContent(url)
  40
  41         if stdin:
  42                 content = sys.stdin.read()
  43                 return (content, encoding)
  44
  45         if not parsedURL[0]: url = 'file://' + os.path.abspath(url)
  46
  47         # If we've survived, use python's generic URL opening library to handle it
  48         import urllib2
  49         try:
  50                 res = urllib2.urlopen(url)
  51                 content = res.read()
  52                 ct = res.info().getplist()
  53                 res.close()
  54         except (urllib2.URLError, OSError), e:
  55                 sys.stderr.write('%s\n'%e)
  56                 sys.exit(1)
  57
  58         for param in ct:
  59                 if 'charset' in param:
  60                         encoding = param.split('=')[1]
  61                         break
  62
  63         return (content, encoding)
  64
  65
  66 def getHTTPContent(url='',cache='.httplib2-cache'):
  67         '''This function attempts to play nice when retrieving content from HTTP
  68         services. It's what you should use in a CGI script.'''
  69
  70         try:
  71                 import httplib2
  72         except ImportError:
  73                 import urllib2
  74
  75         if not url: return ('','')
  76
  77         if not 'http' in urlparse.urlparse(url)[0]: return ('','')
  78
  79         if 'httplib2' in sys.modules:
  80                 try: h = httplib2.Http('.httplib2-cache')
  81                 except OSError: h = httplib2.Http()
  82         else: h = False
  83
  84         if h:
  85                 try:
  86                         req = h.request(url)
  87                 except ValueError, e:
  88                         sys.stderr.write('%s\n'%e)
  89                         sys.exit(1)
  90
  91                 resp, content = req
  92                 if 'content-type' in resp:
  93                         ct = 'Content-Type: %s'%req[0]['content-type']
  94                         ct = parse_header(ct)
  95                         if 'charset' in ct[1]: encoding = ct[1]['charset']
  96                         else: encoding = ''
  97                 else:
  98                         ct = ''
  99                         encoding = ''
 100
 101         else:
 102                 try:
 103                         req = urllib2.urlopen(url)
 104                 except urllib2.URLError, e:
 105                         sys.stderr.write('%s\n'%e)
 106                         sys.exit(1)
 107
 108                 content = req.read()
 109                 ct = req.info().getplist()
 110                 for param in ct:
 111                         if 'charset' in param:
 112                                 encoding = param.split('=')[1]
 113                                 break
 114
 115         return (content, encoding)
 116
 117
 118 def generateRules(ruleConfig):
 119         '''Attempts to load a series of rules into a list'''
 120         try:
 121                 import parserrules
 122         except ImportError:
 123                 return []
 124
 125         for conf in ruleConfig:
 126                 parserrules.ruleConfig[conf] = ruleConfig[conf]
 127
 128         rules = [getattr(parserrules, rule) for rule in dir(parserrules) if callable(getattr(parserrules, rule))]
 129         return rules
 130
 131
 132 def applyRules(cal, rules=[], verbose=False):
 133         'Runs a series of rules on the lines in ical and mangles its output'
 134
 135         for rule in rules:
 136                 cal = rule(cal)
 137
 138         return cal
 139
 140 def writeOutput(cal, outfile=''):
 141         '''Takes a list of lines and outputs to the specified file'''
 142
 143         if not cal:
 144                 sys.stderr.write('Refusing to write out an empty file')
 145                 sys.exit(0)
 146
 147         if not outfile:
 148                 out = sys.stdout
 149         else:
 150                 try:
 151                         out = open(outfile, 'w')
 152                 except (IOError, OSError), e:
 153                         sys.stderr.write('%s\n'%e)
 154                         sys.exit(1)
 155
 156         cal.serialize(out)
 157
 158         if not out == sys.stdout:
 159                 out.close()
 160
 161 def exitQuiet(exitstate=0):
 162         '''When called as a CGI script, exit quietly if theres any errors'''
 163         print('Content-Type: text/html\n')
 164         sys.exit(exitstate)
 165
 166 def runLocal():
 167         '''Main run function if this script is called locally'''
 168
 169         from optparse import OptionParser
 170
 171         parser = OptionParser('usage: %prog [options] url')
 172         parser.add_option('-s', '--stdin', action='store_true', dest='stdin',
 173                 default=False, help='Take a calendar from standard input')
 174         parser.add_option('-v', '--verbose', action='store_true', dest='verbose',
 175                 default=False, help='Be verbose when rules are being applied')
 176         parser.add_option('-o', '--output', dest='outfile', default='',
 177                 help='Specify output file (defaults to standard output)')
 178         parser.add_option('-m','--encoding', dest='encoding', default='',
 179                 help='Specify a different character encoding'
 180                 '(ignored if the remote server also specifies one)')
 181         parser.add_option('-t','--timezone', dest='timezone', default=ruleConfig["defaultTZ"],
 182                 help='Specify a timezone to use if the remote calendar doesn\'t set it properly')
 183
 184         (options, args) = parser.parse_args()
 185         ruleConfig["defaultTZ"] = options.timezone
 186
 187         # If the user passed us a 'stdin' argument, we'll go with that,
 188         # otherwise we'll try for a url opener
 189         if not args and not options.stdin:
 190                 parser.print_usage()
 191                 sys.exit(0)
 192         elif not options.stdin:
 193                 url = args[0]
 194         else:
 195                 url = ''
 196
 197         (content, encoding) = getContent(url, options.stdin)
 198         encoding = encoding or options.encoding or 'utf-8'
 199
 200         cal = vobject.readOne(unicode(content, encoding))
 201         cal = applyRules(cal, generateRules(ruleConfig), options.verbose)
 202
 203         writeOutput(cal, options.outfile)
 204
 205
 206 def runCGI():
 207         '''Main run function if this script is called as a CGI script'''
 208         pass
 209
 210 if __name__ == '__main__':
 211         # Ensure the rules process using the desired timezone
 212         ruleConfig = {}
 213         ruleConfig["defaultTZ"] = 'Australia/Perth'
 214
 215         # Detect if this script has been called by CGI and proceed accordingly
 216         if 'REQUEST_METHOD' in os.environ:
 217                 runCGI()
 218         else:
 219                 runLocal()