chiark - git - matthewv - gooswapper/blob - gooswapper.py

   1 #!/usr/bin/env python3
   2
   3 import sys
   4 import getpass
   5 import os
   6 import pickle
   7 import collections
   8 import logging
   9 logger = logging.getLogger('gooswapper')
  10 logger.setLevel(logging.INFO)
  11 consolelog = logging.StreamHandler()
  12 consolelog.setLevel(logging.INFO)
  13 logformatter = logging.Formatter('%(name)s - %(levelname)s - %(message)s')
  14 consolelog.setFormatter(logformatter)
  15 logger.addHandler(consolelog)
  16 #We can't use this, because that way all the libraries' logs spam us
  17 #logging.basicConfig(level=logging.INFO)
  18
  19 #Exchange-related library
  20 sys.path.append("/upstreams/exchangelib")
  21 import exchangelib
  22
  23 #Google calendar-api libraries
  24 import httplib2
  25 import apiclient.discovery
  26 import oauth2client
  27 import oauth2client.file
  28 import oauth2client.client
  29 import googleapiclient.errors
  30
  31 #Not sure what the distribution approach here is...
  32 gcal_client_id = '805127902516-ptbbtgpq9o8pjr6r3k6hsm60j589o85u.apps.googleusercontent.com'
  33 gcal_client_secret = '8hpdxV3MauorryTDoZ1YK8JO'
  34
  35 #scope URL for r/w calendar access
  36 scope = 'https://www.googleapis.com/auth/calendar'
  37 #flow object, for doing OAuth2.0 stuff
  38 flow = oauth2client.client.OAuth2WebServerFlow(gcal_client_id,
  39                                                gcal_client_secret,
  40                                                scope)
  41
  42
  43 gcal_authpath=".gooswap_gcal_creds.dat"
  44
  45 cachepath=".gooswapcache"
  46
  47 exchange_credential = None
  48
  49 CachedExEvent=collections.namedtuple('CachedExEvent',
  50                                      ['changekey','gcal_link'])
  51
  52 class ex_gcal_link(exchangelib.ExtendedProperty):
  53     distinguished_property_set_id = 'PublicStrings'
  54     property_name = "google calendar event id"
  55     property_type = 'String'
  56
  57 try:
  58     exchangelib.CalendarItem.get_field_by_fieldname('gcal_link')
  59 except ValueError:
  60     exchangelib.CalendarItem.register('gcal_link',ex_gcal_link)
  61
  62 #useful if you want to replay an event
  63 def drop_from_ex_cache(itemid):
  64     with open(cachepath,"rb") as f:
  65         cache = pickle.load(f)
  66     cache.pop(itemid)
  67     with open(cachepath,"wb") as f:
  68         pickle.dump(cache,f)
  69
  70 def get_ex_event_by_itemid(calendar,itemid):
  71     return calendar.get(item_id=itemid)
  72
  73 def get_ex_event_by_id_and_changekey(acct,itemid,changekey):
  74     l=list(acct.fetch([(itemid,changekey)]))
  75     return list(acct.fetch([(itemid,changekey)]))[0]
  76
  77 def get_ex_cred(username="SANGER\mv3",password=None):
  78     if password is None:
  79         password = getpass.getpass(prompt="Password for user %s: " % username)
  80     return exchangelib.ServiceAccount(username,password)
  81
  82 def ex_login(emailaddr,ad_cache_path=None):
  83     global exchange_credential
  84     autodiscover = True
  85     if exchange_credential is None:
  86         exchange_credential = get_ex_cred()
  87     if ad_cache_path is not None:
  88         try:
  89             with open(ad_cache_path,"rb") as f:
  90                 url,auth_type = pickle.load(f)
  91                 autodiscover = False
  92         except FileNotFoundError:
  93             pass
  94
  95     if autodiscover:
  96         ex_ac = exchangelib.Account(emailaddr,
  97                                     credentials = exchange_credential,
  98                                     autodiscover = autodiscover)
  99         if ad_cache_path is not None:
 100             cache=(ex_ac.protocol.service_endpoint,
 101                    ex_ac.protocol.auth_type)
 102             with open(ad_cache_path,"wb") as f:
 103                 pickle.dump(cache,f)
 104     else:
 105         ex_conf = exchangelib.Configuration(service_endpoint=url,
 106                                             credentials=exchange_credential,
 107                                             auth_type=auth_type)
 108         ex_ac = exchangelib.Account(emailaddr,
 109                                     config=ex_conf,
 110                                     autodiscover=False,
 111                                     access_type=exchangelib.DELEGATE)
 112
 113     return ex_ac
 114
 115 def get_ex_events(calendar):
 116     ans={}
 117     for event in calendar.all().only('changekey','item_id','gcal_link'):
 118         if event.item_id in ans:
 119             logger.warning("Event item_id %s was duplicated!" % event.item_id)
 120         ans[event.item_id] = CachedExEvent(event.changekey,event.gcal_link)
 121     logger.info("%d events found" % len(ans))
 122     return ans
 123
 124 def ex_event_changes(old,new):
 125     olds = set(old.keys())
 126     news = set(new.keys())
 127     added = list(news-olds)
 128     deleted = list(olds-news)
 129     changed = []
 130     #intersection - i.e. common to both sets
 131     for event in olds & news:
 132         if old[event].changekey != new[event].changekey:
 133             changed.append(event)
 134     logger.info("%d events updated, %d added, %d deleted" % (len(changed),
 135                                                               len(added),
 136                                                               len(deleted)))
 137     return added, deleted, changed
 138
 139 def rrule_from_ex(event,gcal_tz):
 140     if event.type != "RecurringMaster":
 141         logger.error("Cannot make recurrence from not-recurring event")
 142         return None
 143     if event.recurrence is None:
 144         logger.error("Empty recurrence structure")
 145         return None
 146     if isinstance(event.recurrence.pattern,
 147                   exchangelib.recurrence.DailyPattern):
 148         rr = "RRULE:FREQ=DAILY;INTERVAL=%d" % event.recurrence.pattern.interval
 149     else:
 150         logger.error("Recurrence %s not supported" % event.recurrence)
 151         return None
 152     if isinstance(event.recurrence.boundary,
 153                   exchangelib.recurrence.EndDatePattern):
 154         rr += ";UNTIL={0:%Y}{0:%m}{0:%d}".format(event.recurrence.boundary.end)
 155     else:
 156         logger.error("Recurrence %s not supported" % event.recurrence)
 157         return None
 158     if event.modified_occurrences is not None or \
 159        event.deleted_occurrences is not None:
 160         logger.warning("Modified/Deleted recurrences not supported")
 161     return [rr]
 162
 163 def build_gcal_event_from_ex(event,gcal_tz):
 164     gevent={}
 165     gevent["summary"]=event.subject
 166     if event.is_all_day:
 167         gevent["end"]={"date": str(event.end.astimezone(gcal_tz).date())}
 168         gevent["start"]={"date": str(event.start.astimezone(gcal_tz).date())}
 169     else:
 170         gevent["end"]={"dateTime": event.end.astimezone(gcal_tz).isoformat(),
 171                        "timeZone": str(gcal_tz)}
 172         gevent["start"]={"dateTime": event.start.astimezone(gcal_tz).isoformat(),
 173                          "timeZone": str(gcal_tz)}
 174     if event.text_body is not None and event.text_body.strip() != '':
 175         gevent["description"] = event.text_body
 176     if event.location is not None:
 177         gevent["location"] = event.location
 178     gevent["extendedProperties"]={"shared": {"ex_id": event.item_id}}
 179     return gevent
 180
 181 def add_ex_to_gcal(ex_acct,
 182                    gcal_acct,gcal_tz,events,
 183                    added,
 184                    gcal_id="primary"):
 185     for ev_id in added:
 186         event = get_ex_event_by_itemid(ex_acct.calendar,ev_id)
 187         gevent = build_gcal_event_from_ex(event,gcal_tz)
 188         if event.type=="RecurringMaster":
 189             rr = rrule_from_ex(event,gcal_tz)
 190             if rr is not None:
 191                 gevent["recurrence"] = rr
 192                 print(gevent)
 193             else:
 194                 logger.warning("Unable to set recurrence for %s" % event.item_id)
 195                 continue #don't make the gcal event
 196         gevent = gcal_acct.events().insert(calendarId=gcal_id,
 197                                            body=gevent).execute()
 198         event.gcal_link = gevent.get("id")
 199         event.save(update_fields=["gcal_link"])
 200         events[event.item_id] = events[event.item_id]._replace(changekey=event.changekey,gcal_link=event.gcal_link)
 201
 202 def del_ex_to_gcal(ex_acct, gcal_acct, events, deleted, gcal_id="primary"):
 203     for ev_id in deleted:
 204         if events[ev_id].gcal_link is not None:
 205             gcal_acct.events().delete(calendarId=gcal_id,
 206                                       eventId=events[ev_id].gcal_link,
 207                                       sendUpdates="none").execute()
 208
 209 def update_ex_to_gcal(ex_acct,
 210                       gcal_acct,gcal_tz,
 211                       events,changed,
 212                       gcal_id="primary"):
 213     for ev_id in changed:
 214         event = get_ex_event_by_itemid(ex_acct.calendar,ev_id)
 215         if not event.is_recurring:
 216             gevent = build_gcal_event_from_ex(event,gcal_tz)
 217             gevent = gcal_acct.events().update(calendarId=gcal_id,
 218                                                eventId=event.gcal_link,
 219                                                body=gevent,
 220                                                sendUpdates="none").execute()
 221         else:
 222             logger.warning("recurring events not yet supported")
 223
 224 def match_ex_to_gcal(ex_acct,gcal_acct,gcal_tz,events,gcal_id="primary"):
 225     recur = 0
 226     matched = 0
 227     skipped = 0
 228     for ev_id in events:
 229         event = get_ex_event_by_itemid(ex_acct.calendar,ev_id)
 230         if event.is_recurring:
 231             recur += 1
 232             continue
 233         elif event.gcal_link is not None:
 234             skipped += 1
 235             continue
 236         matches = gcal_acct.events().list(calendarId=gcal_id,
 237                                           timeMin=event.start.isoformat(),
 238                                           timeMax=event.end.isoformat()).execute()
 239         for ge in matches['items']:
 240             if ge['summary'].strip()==event.subject.strip():
 241                 logger.info("Matching '%s' starting at %s" % (event.subject,
 242                                                               event.start.isoformat()))
 243                 event.gcal_link = ge['id']
 244                 event.save(update_fields=["gcal_link"])
 245                 events[event.item_id] = events[event.item_id]._replace(changekey=event.changekey,gcal_link=event.gcal_link)
 246                 gevent = {}
 247                 gevent["start"] = ge["start"]
 248                 gevent["end"] = ge["end"]
 249                 gevent["extendedProperties"]={"shared": {"ex_id": event.item_id}}
 250                 try:
 251                     gcal_acct.events().update(calendarId=gcal_id,
 252                                               eventId=event.gcal_link,
 253                                               body=gevent,
 254                                               sendUpdates="none").execute()
 255                 #this may fail if we don't own the event
 256                 except googleapiclient.errors.HttpError as err:
 257                     if err.resp.status == 403:
 258                         pass
 259                 matched += 1
 260                 break
 261     logger.info("Matched %d events, skipped %d with existing link, and %d recurring ones" % (matched,skipped,recur))
 262
 263 def get_gcal_cred():
 264     #each such file can only store a single credential
 265     storage = oauth2client.file.Storage(gcal_authpath)
 266     gcal_credential = storage.get()
 267     #if no credential found, or they're invalid (e.g. expired),
 268     #then get a new one; pass --noauth_local_webserver on the command line
 269     #if you don't want it to spawn a browser
 270     if gcal_credential is None or gcal_credential.invalid:
 271         gcal_credential = oauth2client.tools.run_flow(flow,
 272                                                       storage,
 273                                                       oauth2client.tools.argparser.parse_args())
 274     return gcal_credential
 275
 276 def gcal_login():
 277     gcal_credential = get_gcal_cred()
 278     # Object to handle http requests; could add proxy details
 279     http = httplib2.Http()
 280     http = gcal_credential.authorize(http)
 281     return apiclient.discovery.build('calendar', 'v3', http=http)
 282
 283 def get_gcal_timezone(gcal_account,calendarid="primary"):
 284     gcal = gcal_account.calendars().get(calendarId=calendarid).execute()
 285     return exchangelib.EWSTimeZone.timezone(gcal['timeZone'])
 286
 287 def main():
 288     try:
 289         with open(cachepath,"rb") as f:
 290             cache = pickle.load(f)
 291     except FileNotFoundError:
 292         cache = None
 293
 294     ex_account = ex_login("mv3@sanger.ac.uk",".gooswapper_exch_conf.dat")
 295     current = get_ex_events(ex_account.calendar)
 296
 297     gcal_account = gcal_login()
 298     gcal_tz = get_gcal_timezone(gcal_account)
 299
 300     if cache is not None:
 301         added,deleted,changed = ex_event_changes(cache,current)
 302         add_ex_to_gcal(ex_account,gcal_account,gcal_tz,current,added)
 303         #delete op needs the "cache" set, as that has the link ids in
 304         #for events that are now deleted
 305         del_ex_to_gcal(ex_account,gcal_account,cache,deleted)
 306         update_ex_to_gcal(ex_account,gcal_account,gcal_tz,current,changed)
 307     else:
 308         match_ex_to_gcal(ex_account,gcal_account,gcal_tz,current)
 309
 310     with open(cachepath,"wb") as f:
 311         pickle.dump(current,f)
 312
 313 if __name__ == "__main__":
 314     main()
 315
 316