#!/usr/bin/python2 ## (the icalendar library is not ported to python3?) import argparse import urlparse import pytz import tzlocal import time from datetime import datetime, timedelta import dateutil.parser from icalendar import Calendar,Event import caldav import uuid import json import os import logging import sys __version__ = "0.7" __author__ = "Tobias Brox" __author_short__ = "tobixen" __copyright__ = "Copyright 2013, Tobias Brox" #__credits__ = [] __license__ = "GPLv3+" __maintainer__ = "Tobias Brox" __author_email__ = "t-calendar-cli@tobixen.no" __status__ = "Development" __product__ = "calendar-cli" def niy(*args, **kwargs): if 'feature' in kwargs: raise NotImplementedError("This feature is not implemented yet: %(feature)s" % kwargs) raise NotImplementedError def caldav_connect(args): # Create the account return caldav.DAVClient(url=args.caldav_url, username=args.caldav_user, password=args.caldav_pass) def find_calendar(caldav_conn, args): if args.calendar_url: if '/' in args.calendar_url: return caldav.Calendar(client=caldav_conn, url=args.calendar_url) else: return caldav.Principal(caldav_conn).calendar(name=args.calendar_url) else: ## Find default calendar return caldav.Principal(caldav_conn).calendars()[0] def _calendar_addics(caldav_conn, ics, uid, args): """" "Internal" method for adding a calendar object item to the caldav server through a PUT. ASSUMES the ics conforms to rfc4791.txt section 4.1 Handles --calendar-url and --icalendar from the args """ if args.icalendar and args.nocaldav: print(ics) return if args.icalendar or args.nocaldav: raise ValueError("Nothing to do/invalid option combination for 'calendar add'-mode; either both --icalendar and --nocaldav should be set, or none of them") return c = find_calendar(caldav_conn, args) c.add_event(ics) def calendar_addics(caldav_conn, args): """ Takes an ics from external source and puts it into the calendar. From the CalDAV RFC: Calendar components in a calendar collection that have different UID property values MUST be stored in separate calendar object resources. This means the inbound .ics has to be split up into one .ics for each event as long as the uid is different. """ if args.file == '-': input_ical = sys.stdin.read() else: with open(args.file, 'r') as f: input_ical = f.read() c = Calendar.from_ical(input_ical) ## unfortunately we need to mess around with the object internals, ## since the icalendar library doesn't offer methods out of the ## hat for doing such kind of things entries = c.subcomponents ## Timezones should be duplicated into each ics, ref the RFC timezones = [x for x in entries if x.name == 'VTIMEZONE'] ## Make a mapping from UID to the other components uids = {} for x in entries: if x.name == 'VTIMEZONE' or not 'UID' in x: continue uid = x['UID'].to_ical() uids[uid] = uids.get(uid, []) + [x] for uid in uids: c.subcomponents = timezones + uids[uid] _calendar_addics(caldav_conn, c.to_ical(), uid, args) def interactive_config(args, config, remaining_argv): import readline new_config = False section = 'default' backup = {} modified = False print("Welcome to the interactive calendar configuration mode") print("Warning - untested code ahead, raise issues at t-calendar-cli@tobixen.no") if not config or not hasattr(config, 'keys'): config = {} print("No valid existing configuration found") new_config = True if config: print("The following sections have been found: ") print("\n".join(config.keys())) if args.config_section and args.config_section != 'default': section = args.config_section else: ## TODO: tab completion section = raw_input("Chose one of those, or a new name / no name for a new configuration section: ") if section in config: backup = config[section].copy() print("Using section " + section) else: section = 'default' if not section in config: config[section] = {} for config_key in ('caldav_url', 'caldav_user', 'caldav_pass', 'language', 'timezone'): print("Config option %s - old value: %s" % (config_key, config[section].get(config_key, '(None)'))) value = raw_input("Enter new value (or just enter to keep the old): ") if value: config[section][config_key] = value modified = True if not modified: print("No configuration changes have been done") else: options = [] if section: options.append(('save', 'save configuration into section %s' % section)) if backup or not section: options.append(('save_other', 'add this new configuration into a new section in the configuration file')) if remaining_argv: options.append(('use', 'use this configuration without saving')) options.append(('abort', 'abort without saving')) print("CONFIGURATION DONE ...") for o in options: print("Type %s if you want to %s" % o) cmd = raw_input("Enter a command: ") if cmd in ('save', 'save_other'): if cmd == 'save_other': new_section = raw_input("New config section name: ") config[new_section] = config[section] if backup: config[section] = backup else: del config[section] section = new_section if os.path.isfile(args.config_file): os.rename(args.config_file, "%s.%s.bak" % (args.config_file, int(time.time()))) with open(args.config_file, 'w') as outfile: json.dump(config, outfile, indent=4) if args.config_section == 'default' and section != 'default': config['default'] = config[section] return config def calendar_add(caldav_conn, args): cal = Calendar() cal.add('prodid', '-//{author_short}//{product}//{language}'.format(author_short=__author_short__, product=__product__, language=args.language)) cal.add('version', '2.0') event = Event() ## TODO: timezone ## read timestamps from arguments dtstart = dateutil.parser.parse(args.event_time) event.add('dtstart', dtstart) ## TODO: handle duration and end-time as options. default 3600s by now. event.add('dtend', dtstart + timedelta(0,3600)) ## not really correct, and it breaks i.e. with google calendar #event.add('dtstamp', datetime.now()) ## maybe we should generate some uid? uid = uuid.uuid1() event.add('uid', str(uid)) event.add('summary', ' '.join(args.description)) cal.add_component(event) _calendar_addics(caldav_conn, cal.to_ical(), uid, args) print("Added event with uid=%s" % uid) def calendar_delete(caldav_conn, args): cal = find_calendar(caldav_conn, args) if args.event_uid: event = cal.event_by_uid(args.event_uid) elif args.event_url: event = cal.event_by_url(args.event_url) elif args.event_timestamp: raise NotImplementedError("this hasn't been implemented yet - see code comments") ## It seems that at least DAViCal requires the end of the ## search to be beyond the event dtend, which makes deletion ## by event_timestamp a bit more complex to implement. dtstart = dateutil.parser.parse(args.event_timestamp) #dtend = dtstart + timedelta(1,0,0,1) events = cal.date_search(dtstart, dtend) if len(events)>1: raise NotImplementedError("Several events found with that timestamp; cowardly refusing to delete anything") elif not len(events): raise caldav.lib.error.NotFoundError("Couldn't find any event at %s" % dtstart) else: event = events[0] else: raise ValueError("Event deletion failed: either uid, url or timestamp is needed") event.delete() def calendar_agenda(caldav_conn, args): if args.nocaldav and args.icalendar: niy(feature="Read events from stdin in ical format") if args.nocaldav: raise ValueError("Agenda with --nocaldav only makes sense together with --icalendar") if args.from_time: dtstart = dateutil.parser.parse(args.from_time) else: dtstart = datetime.now() if args.to_time: dtend = dateutil.parser.parse(args.to_time) elif args.agenda_mins: dtend = dtstart + timedelta(0,0,args.agenda_mins) elif args.agenda_days: dtend = dtstart + timedelta(args.agenda_days) ## TODO: time zone events_ = find_calendar(caldav_conn, args).date_search(dtstart, dtend) events = [] if args.icalendar: for ical in events_: print ical.data else: ## flatten. A recurring event may be a list of events. for event_cal in events_: for event in event_cal.instance.components(): dtstart = event.dtstart.value if not dtstart.tzinfo: dtstart = args.timezone.localize(dtstart) events.append({'dtstart': dtstart, 'instance': event}) events.sort(lambda a,b: cmp(a['dtstart'], b['dtstart'])) for event in events: event['dstart_sql'] = event['dtstart'].strftime("%F %H:%M") for summary_attr in ('summary', 'location'): if hasattr(event['instance'], summary_attr): event['description'] = getattr(event['instance'], summary_attr).value break event['uid'] = event['instance'].uid.value ## TODO: this will probably break and is probably moot on python3? if hasattr(event['description'], 'encode'): event['description'] = event['description'].encode('utf-8') print(args.event_template.format(**event)) def main(): """ the main function does (almost) nothing but parsing command line parameters """ ## This boilerplate pattern is from ## http://stackoverflow.com/questions/3609852 ## We want defaults for the command line options to be fetched from the config file # Parse any conf_file specification # We make this parser with add_help=False so that # it doesn't parse -h and print help. conf_parser = argparse.ArgumentParser( description=__doc__, # printed with -h/--help # Don't mess with format of description formatter_class=argparse.RawDescriptionHelpFormatter, # Turn off help, so we print all options in response to -h add_help=False ) conf_parser.add_argument("--config-file", help="Specify config file", metavar="FILE", default=os.getenv('XDG_CONFIG_HOME', os.getenv('HOME', '~') + '/.config')+'/calendar.conf') conf_parser.add_argument("--config-section", help="Specify config section; allows several caldav servers to be configured in the same config file", default='default') conf_parser.add_argument("--interactive-config", help="Interactively ask for configuration", action="store_true") args, remaining_argv = conf_parser.parse_known_args() config = {} try: with open(args.config_file) as config_file: config = json.load(config_file) except IOError: ## File not found logging.info("no config file found") except ValueError: if args.interactive_config: logging.error("error in config file. Be aware that the current config file will be ignored and overwritten", exc_info=True) else: logging.error("error in config file. You may want to run --interactive-config or fix the config file", exc_info=True) if args.interactive_config: config = interactive_config(args, config, remaining_argv) if not remaining_argv: return else: defaults = config.get(args.config_section, {}) # Parse rest of arguments # Don't suppress add_help here so it will handle -h parser = argparse.ArgumentParser( # Inherit options from config_parser parents=[conf_parser] ) parser.set_defaults(**defaults) ## Global options parser.add_argument("--nocaldav", help="Do not connect to CalDAV server, but read/write icalendar format from stdin/stdout", action="store_true") parser.add_argument("--icalendar", help="Read/write icalendar format from stdin/stdout", action="store_true") parser.add_argument("--timezone", help="Timezone to use") parser.add_argument('--language', help="language used", default="EN") parser.add_argument("--caldav-url", help="Full URL to the caldav server", metavar="URL") parser.add_argument("--caldav-user", help="username to log into the caldav server", metavar="USER") parser.add_argument("--caldav-pass", help="password to log into the caldav server", metavar="PASS") parser.add_argument("--debug-logging", help="turn on debug logging", action="store_true") ## TODO: check sys.argv[0] to find command ## TODO: set up logging subparsers = parser.add_subparsers(title='command') calendar_parser = subparsers.add_parser('calendar') calendar_parser.add_argument("--calendar-url", help="URL for calendar to be used (may be absolute or relative to caldav URL, or just the name of the calendar)") calendar_subparsers = calendar_parser.add_subparsers(title='subcommand') calendar_add_parser = calendar_subparsers.add_parser('add') calendar_add_parser.add_argument('event_time', help="Timestamp and duration of the event. See the documentation for event_time specifications") calendar_add_parser.add_argument('description', nargs='+') calendar_add_parser.set_defaults(func=calendar_add) calendar_addics_parser = calendar_subparsers.add_parser('addics') calendar_addics_parser.add_argument('--file', help="ICS file to upload", default='-') calendar_addics_parser.set_defaults(func=calendar_addics) calendar_agenda_parser = calendar_subparsers.add_parser('agenda') calendar_agenda_parser.add_argument('--from-time', help="Fetch calendar events from this timestamp. See the documentation for time specifications. Defaults to now") calendar_agenda_parser.add_argument('--to-time', help="Fetch calendar until this timestamp") calendar_agenda_parser.add_argument('--agenda-mins', help="Fetch calendar for so many minutes", type=int) calendar_agenda_parser.add_argument('--agenda-days', help="Fetch calendar for so many days", type=int, default=7) calendar_agenda_parser.add_argument('--event-template', help="Template for printing out the event", default="{dstart_sql} {description}") calendar_agenda_parser.set_defaults(func=calendar_agenda) calendar_delete_parser = calendar_subparsers.add_parser('delete') calendar_delete_parser.add_argument('--event-uid') calendar_delete_parser.add_argument('--event-url') calendar_delete_parser.add_argument('--event-timestamp') calendar_delete_parser.set_defaults(func=calendar_delete) todo_parser = subparsers.add_parser('todo') todo_parser.set_defaults(func=niy) args = parser.parse_args(remaining_argv) if args.timezone: args.timezone = pytz.timezone(args.timezone) else: args.timezone = tzlocal.get_localzone() if not args.nocaldav: caldav_conn = caldav_connect(args) ret = args.func(caldav_conn, args) if __name__ == '__main__': main()