imip-agent

Annotated imip_manager.py

300:8d0c013ef527
2015-02-09 Paul Boddie Added support for switching between date-only and date-plus-time event periods.
paul@69 1
#!/usr/bin/env python
paul@69 2
paul@146 3
"""
paul@146 4
A Web interface to a user's calendar.
paul@146 5
paul@146 6
Copyright (C) 2014, 2015 Paul Boddie <paul@boddie.org.uk>
paul@146 7
paul@146 8
This program is free software; you can redistribute it and/or modify it under
paul@146 9
the terms of the GNU General Public License as published by the Free Software
paul@146 10
Foundation; either version 3 of the License, or (at your option) any later
paul@146 11
version.
paul@146 12
paul@146 13
This program is distributed in the hope that it will be useful, but WITHOUT
paul@146 14
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
paul@146 15
FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
paul@146 16
details.
paul@146 17
paul@146 18
You should have received a copy of the GNU General Public License along with
paul@146 19
this program.  If not, see <http://www.gnu.org/licenses/>.
paul@146 20
"""
paul@146 21
paul@146 22
# Edit this path to refer to the location of the imiptools libraries, if
paul@146 23
# necessary.
paul@146 24
paul@146 25
LIBRARY_PATH = "/var/lib/imip-agent"
paul@146 26
paul@232 27
from datetime import date, datetime, timedelta
paul@149 28
import babel.dates
paul@149 29
import cgi, os, sys
paul@69 30
paul@146 31
sys.path.append(LIBRARY_PATH)
paul@69 32
paul@213 33
from imiptools.content import Handler
paul@222 34
from imiptools.data import get_address, get_uri, make_freebusy, parse_object, \
paul@222 35
                           Object, to_part
paul@286 36
from imiptools.dates import format_datetime, format_time, get_date, get_datetime, \
paul@291 37
                            get_datetime_item, get_default_timezone, \
paul@241 38
                            get_end_of_day, get_start_of_day, get_start_of_next_day, \
paul@274 39
                            get_timestamp, ends_on_same_day, to_timezone
paul@83 40
from imiptools.mail import Messenger
paul@279 41
from imiptools.period import add_day_start_points, add_empty_days, add_slots, \
paul@279 42
                             convert_periods, get_freebusy_details, \
paul@162 43
                             get_scale, have_conflict, get_slots, get_spans, \
paul@296 44
                             partition_by_day, remove_from_freebusy, update_freebusy
paul@147 45
from imiptools.profile import Preferences
paul@213 46
import imip_store
paul@69 47
import markup
paul@69 48
paul@69 49
getenv = os.environ.get
paul@69 50
setenv = os.environ.__setitem__
paul@69 51
paul@69 52
class CGIEnvironment:
paul@69 53
paul@69 54
    "A CGI-compatible environment."
paul@69 55
paul@212 56
    def __init__(self, charset=None):
paul@212 57
        self.charset = charset
paul@69 58
        self.args = None
paul@69 59
        self.method = None
paul@69 60
        self.path = None
paul@69 61
        self.path_info = None
paul@69 62
        self.user = None
paul@69 63
paul@69 64
    def get_args(self):
paul@69 65
        if self.args is None:
paul@69 66
            if self.get_method() != "POST":
paul@69 67
                setenv("QUERY_STRING", "")
paul@212 68
            args = cgi.parse(keep_blank_values=True)
paul@212 69
paul@212 70
            if not self.charset:
paul@212 71
                self.args = args
paul@212 72
            else:
paul@212 73
                self.args = {}
paul@212 74
                for key, values in args.items():
paul@212 75
                    self.args[key] = [unicode(value, self.charset) for value in values]
paul@212 76
paul@69 77
        return self.args
paul@69 78
paul@69 79
    def get_method(self):
paul@69 80
        if self.method is None:
paul@69 81
            self.method = getenv("REQUEST_METHOD") or "GET"
paul@69 82
        return self.method
paul@69 83
paul@69 84
    def get_path(self):
paul@69 85
        if self.path is None:
paul@69 86
            self.path = getenv("SCRIPT_NAME") or ""
paul@69 87
        return self.path
paul@69 88
paul@69 89
    def get_path_info(self):
paul@69 90
        if self.path_info is None:
paul@69 91
            self.path_info = getenv("PATH_INFO") or ""
paul@69 92
        return self.path_info
paul@69 93
paul@69 94
    def get_user(self):
paul@69 95
        if self.user is None:
paul@69 96
            self.user = getenv("REMOTE_USER") or ""
paul@69 97
        return self.user
paul@69 98
paul@69 99
    def get_output(self):
paul@69 100
        return sys.stdout
paul@69 101
paul@69 102
    def get_url(self):
paul@69 103
        path = self.get_path()
paul@69 104
        path_info = self.get_path_info()
paul@69 105
        return "%s%s" % (path.rstrip("/"), path_info)
paul@69 106
paul@154 107
    def new_url(self, path_info):
paul@154 108
        path = self.get_path()
paul@154 109
        return "%s/%s" % (path.rstrip("/"), path_info.lstrip("/"))
paul@154 110
paul@222 111
class ManagerHandler(Handler):
paul@79 112
paul@121 113
    """
paul@121 114
    A content handler for use by the manager, as opposed to operating within the
paul@121 115
    mail processing pipeline.
paul@121 116
    """
paul@79 117
paul@121 118
    def __init__(self, obj, user, messenger):
paul@224 119
        Handler.__init__(self, messenger=messenger)
paul@224 120
        self.set_object(obj)
paul@79 121
        self.user = user
paul@82 122
paul@213 123
        self.organiser = self.obj.get_value("ORGANIZER")
paul@213 124
        self.attendees = self.obj.get_values("ATTENDEE")
paul@79 125
paul@79 126
    # Communication methods.
paul@79 127
paul@253 128
    def send_message(self, method, sender, for_organiser):
paul@79 129
paul@79 130
        """
paul@207 131
        Create a full calendar object employing the given 'method', and send it
paul@253 132
        to the appropriate recipients, also sending a copy to the 'sender'. The
paul@253 133
        'for_organiser' value indicates whether the organiser is sending this
paul@253 134
        message.
paul@79 135
        """
paul@79 136
paul@219 137
        parts = [self.obj.to_part(method)]
paul@207 138
paul@260 139
        # As organiser, send an invitation to attendees, excluding oneself if
paul@260 140
        # also attending. The updated event will be saved by the outgoing
paul@260 141
        # handler.
paul@260 142
paul@253 143
        if for_organiser:
paul@260 144
            recipients = [get_address(attendee) for attendee in self.attendees if attendee != self.user]
paul@207 145
        else:
paul@207 146
            recipients = [get_address(self.organiser)]
paul@207 147
paul@219 148
        # Bundle free/busy information if appropriate.
paul@219 149
paul@219 150
        preferences = Preferences(self.user)
paul@219 151
paul@219 152
        if preferences.get("freebusy_sharing") == "share" and \
paul@219 153
           preferences.get("freebusy_bundling") == "always":
paul@219 154
paul@222 155
            # Invent a unique identifier.
paul@222 156
paul@222 157
            utcnow = get_timestamp()
paul@222 158
            uid = "imip-agent-%s-%s" % (utcnow, get_address(self.user))
paul@222 159
paul@222 160
            freebusy = self.store.get_freebusy(self.user)
paul@292 161
            user_attr = self.messenger and self.messenger.sender != get_address(self.user) and \
paul@292 162
                {"SENT-BY" : get_uri(self.messenger.sender)} or {}
paul@292 163
paul@292 164
            parts.append(to_part("PUBLISH", [
paul@292 165
                make_freebusy(freebusy, uid, self.user, user_attr)
paul@292 166
                ]))
paul@219 167
paul@219 168
        message = self.messenger.make_outgoing_message(parts, recipients, outgoing_bcc=sender)
paul@207 169
        self.messenger.sendmail(recipients, message.as_string(), outgoing_bcc=sender)
paul@79 170
paul@79 171
    # Action methods.
paul@79 172
paul@266 173
    def process_received_request(self, update=False):
paul@79 174
paul@79 175
        """
paul@266 176
        Process the current request for the given 'user'. Return whether any
paul@79 177
        action was taken.
paul@155 178
paul@155 179
        If 'update' is given, the sequence number will be incremented in order
paul@155 180
        to override any previous response.
paul@79 181
        """
paul@79 182
paul@266 183
        # Reply only on behalf of this user.
paul@79 184
paul@213 185
        for attendee, attendee_attr in self.obj.get_items("ATTENDEE"):
paul@79 186
paul@79 187
            if attendee == self.user:
paul@266 188
                if attendee_attr.has_key("RSVP"):
paul@266 189
                    del attendee_attr["RSVP"]
paul@128 190
                if self.messenger and self.messenger.sender != get_address(attendee):
paul@128 191
                    attendee_attr["SENT-BY"] = get_uri(self.messenger.sender)
paul@213 192
                self.obj["ATTENDEE"] = [(attendee, attendee_attr)]
paul@273 193
paul@158 194
                self.update_dtstamp()
paul@273 195
                self.set_sequence(update)
paul@155 196
paul@253 197
                self.send_message("REPLY", get_address(attendee), for_organiser=False)
paul@79 198
paul@79 199
                return True
paul@79 200
paul@79 201
        return False
paul@79 202
paul@255 203
    def process_created_request(self, method, update=False):
paul@207 204
paul@207 205
        """
paul@207 206
        Process the current request for the given 'user', sending a created
paul@255 207
        request of the given 'method' to attendees. Return whether any action
paul@255 208
        was taken.
paul@207 209
paul@207 210
        If 'update' is given, the sequence number will be incremented in order
paul@207 211
        to override any previous message.
paul@207 212
        """
paul@207 213
paul@213 214
        organiser, organiser_attr = self.obj.get_item("ORGANIZER")
paul@213 215
paul@213 216
        if self.messenger and self.messenger.sender != get_address(organiser):
paul@213 217
            organiser_attr["SENT-BY"] = get_uri(self.messenger.sender)
paul@273 218
paul@207 219
        self.update_dtstamp()
paul@273 220
        self.set_sequence(update)
paul@207 221
paul@255 222
        self.send_message(method, get_address(self.organiser), for_organiser=True)
paul@207 223
        return True
paul@207 224
paul@69 225
class Manager:
paul@69 226
paul@69 227
    "A simple manager application."
paul@69 228
paul@82 229
    def __init__(self, messenger=None):
paul@82 230
        self.messenger = messenger or Messenger()
paul@82 231
paul@212 232
        self.encoding = "utf-8"
paul@212 233
        self.env = CGIEnvironment(self.encoding)
paul@212 234
paul@69 235
        user = self.env.get_user()
paul@77 236
        self.user = user and get_uri(user) or None
paul@147 237
        self.preferences = None
paul@149 238
        self.locale = None
paul@121 239
        self.requests = None
paul@121 240
paul@69 241
        self.out = self.env.get_output()
paul@69 242
        self.page = markup.page()
paul@69 243
paul@77 244
        self.store = imip_store.FileStore()
paul@162 245
        self.objects = {}
paul@77 246
paul@77 247
        try:
paul@77 248
            self.publisher = imip_store.FilePublisher()
paul@77 249
        except OSError:
paul@77 250
            self.publisher = None
paul@77 251
paul@121 252
    def _get_uid(self, path_info):
paul@121 253
        return path_info.lstrip("/").split("/", 1)[0]
paul@121 254
paul@117 255
    def _get_object(self, uid):
paul@162 256
        if self.objects.has_key(uid):
paul@162 257
            return self.objects[uid]
paul@162 258
paul@117 259
        f = uid and self.store.get_event(self.user, uid) or None
paul@117 260
paul@117 261
        if not f:
paul@117 262
            return None
paul@117 263
paul@213 264
        fragment = parse_object(f, "utf-8")
paul@213 265
        obj = self.objects[uid] = fragment and Object(fragment)
paul@117 266
paul@121 267
        return obj
paul@121 268
paul@121 269
    def _get_requests(self):
paul@121 270
        if self.requests is None:
paul@121 271
            self.requests = self.store.get_requests(self.user)
paul@121 272
        return self.requests
paul@117 273
paul@162 274
    def _get_request_summary(self):
paul@162 275
        summary = []
paul@162 276
        for uid in self._get_requests():
paul@162 277
            obj = self._get_object(uid)
paul@162 278
            if obj:
paul@162 279
                summary.append((
paul@213 280
                    obj.get_value("DTSTART"),
paul@213 281
                    obj.get_value("DTEND"),
paul@162 282
                    uid
paul@162 283
                    ))
paul@162 284
        return summary
paul@162 285
paul@147 286
    # Preference methods.
paul@147 287
paul@149 288
    def get_user_locale(self):
paul@149 289
        if not self.locale:
paul@149 290
            self.locale = self.get_preferences().get("LANG", "C")
paul@149 291
        return self.locale
paul@147 292
paul@147 293
    def get_preferences(self):
paul@147 294
        if not self.preferences:
paul@147 295
            self.preferences = Preferences(self.user)
paul@147 296
        return self.preferences
paul@147 297
paul@244 298
    def get_tzid(self):
paul@244 299
        prefs = self.get_preferences()
paul@291 300
        return prefs.get("TZID") or get_default_timezone()
paul@244 301
paul@162 302
    # Prettyprinting of dates and times.
paul@162 303
paul@149 304
    def format_date(self, dt, format):
paul@149 305
        return self._format_datetime(babel.dates.format_date, dt, format)
paul@149 306
paul@149 307
    def format_time(self, dt, format):
paul@149 308
        return self._format_datetime(babel.dates.format_time, dt, format)
paul@149 309
paul@149 310
    def format_datetime(self, dt, format):
paul@232 311
        return self._format_datetime(
paul@232 312
            isinstance(dt, datetime) and babel.dates.format_datetime or babel.dates.format_date,
paul@232 313
            dt, format)
paul@232 314
paul@149 315
    def _format_datetime(self, fn, dt, format):
paul@149 316
        return fn(dt, format=format, locale=self.get_user_locale())
paul@149 317
paul@78 318
    # Data management methods.
paul@78 319
paul@78 320
    def remove_request(self, uid):
paul@105 321
        return self.store.dequeue_request(self.user, uid)
paul@78 322
paul@234 323
    def remove_event(self, uid):
paul@234 324
        return self.store.remove_event(self.user, uid)
paul@234 325
paul@296 326
    def update_freebusy(self, uid, obj):
paul@296 327
        tzid = self.get_tzid()
paul@296 328
        freebusy = self.store.get_freebusy(self.user)
paul@296 329
        update_freebusy(freebusy, self.user, obj.get_periods_for_freebusy(tzid),
paul@296 330
            obj.get_value("TRANSP"), uid, self.store)
paul@296 331
paul@296 332
    def remove_from_freebusy(self, uid):
paul@296 333
        freebusy = self.store.get_freebusy(self.user)
paul@296 334
        remove_from_freebusy(freebusy, self.user, uid, self.store)
paul@296 335
paul@78 336
    # Presentation methods.
paul@78 337
paul@69 338
    def new_page(self, title):
paul@192 339
        self.page.init(title=title, charset=self.encoding, css=self.env.new_url("styles.css"))
paul@69 340
paul@69 341
    def status(self, code, message):
paul@123 342
        self.header("Status", "%s %s" % (code, message))
paul@123 343
paul@123 344
    def header(self, header, value):
paul@123 345
        print >>self.out, "%s: %s" % (header, value)
paul@69 346
paul@69 347
    def no_user(self):
paul@69 348
        self.status(403, "Forbidden")
paul@69 349
        self.new_page(title="Forbidden")
paul@69 350
        self.page.p("You are not logged in and thus cannot access scheduling requests.")
paul@69 351
paul@70 352
    def no_page(self):
paul@70 353
        self.status(404, "Not Found")
paul@70 354
        self.new_page(title="Not Found")
paul@70 355
        self.page.p("No page is provided at the given address.")
paul@70 356
paul@123 357
    def redirect(self, url):
paul@123 358
        self.status(302, "Redirect")
paul@123 359
        self.header("Location", url)
paul@123 360
        self.new_page(title="Redirect")
paul@123 361
        self.page.p("Redirecting to: %s" % url)
paul@123 362
paul@246 363
    # Request logic methods.
paul@121 364
paul@202 365
    def handle_newevent(self):
paul@202 366
paul@207 367
        """
paul@207 368
        Handle any new event operation, creating a new event and redirecting to
paul@207 369
        the event page for further activity.
paul@207 370
        """
paul@202 371
paul@202 372
        # Handle a submitted form.
paul@202 373
paul@202 374
        args = self.env.get_args()
paul@202 375
paul@202 376
        if not args.has_key("newevent"):
paul@202 377
            return
paul@202 378
paul@202 379
        # Create a new event using the available information.
paul@202 380
paul@236 381
        slots = args.get("slot", [])
paul@202 382
        participants = args.get("participants", [])
paul@202 383
paul@236 384
        if not slots:
paul@202 385
            return
paul@202 386
paul@273 387
        # Obtain the user's timezone.
paul@273 388
paul@273 389
        tzid = self.get_tzid()
paul@273 390
paul@236 391
        # Coalesce the selected slots.
paul@236 392
paul@236 393
        slots.sort()
paul@236 394
        coalesced = []
paul@236 395
        last = None
paul@236 396
paul@236 397
        for slot in slots:
paul@236 398
            start, end = slot.split("-")
paul@273 399
            start = get_datetime(start, {"TZID" : tzid})
paul@273 400
            end = end and get_datetime(end, {"TZID" : tzid}) or get_start_of_next_day(start, tzid)
paul@248 401
paul@236 402
            if last:
paul@248 403
                last_start, last_end = last
paul@248 404
paul@248 405
                # Merge adjacent dates and datetimes.
paul@248 406
paul@273 407
                if start == last_end or get_start_of_day(last_end, tzid) == get_start_of_day(start, tzid):
paul@248 408
                    last = last_start, end
paul@236 409
                    continue
paul@248 410
paul@248 411
                # Handle datetimes within dates.
paul@248 412
                # Datetime periods are within single days and are therefore
paul@248 413
                # discarded.
paul@248 414
paul@273 415
                elif get_start_of_day(start, tzid) == get_start_of_day(last_start, tzid):
paul@248 416
                    continue
paul@248 417
paul@248 418
                # Add separate dates and datetimes.
paul@248 419
paul@236 420
                else:
paul@236 421
                    coalesced.append(last)
paul@248 422
paul@236 423
            last = start, end
paul@236 424
paul@236 425
        if last:
paul@236 426
            coalesced.append(last)
paul@202 427
paul@202 428
        # Invent a unique identifier.
paul@202 429
paul@222 430
        utcnow = get_timestamp()
paul@202 431
        uid = "imip-agent-%s-%s" % (utcnow, get_address(self.user))
paul@202 432
paul@236 433
        # Define a single occurrence if only one coalesced slot exists.
paul@236 434
        # Otherwise, many occurrences are defined.
paul@202 435
paul@236 436
        for i, (start, end) in enumerate(coalesced):
paul@236 437
            this_uid = "%s-%s" % (uid, i)
paul@236 438
paul@252 439
            start_value, start_attr = get_datetime_item(start, tzid)
paul@252 440
            end_value, end_attr = get_datetime_item(end, tzid)
paul@239 441
paul@236 442
            # Create a calendar object and store it as a request.
paul@236 443
paul@236 444
            record = []
paul@236 445
            rwrite = record.append
paul@202 446
paul@236 447
            rwrite(("UID", {}, this_uid))
paul@236 448
            rwrite(("SUMMARY", {}, "New event at %s" % utcnow))
paul@236 449
            rwrite(("DTSTAMP", {}, utcnow))
paul@239 450
            rwrite(("DTSTART", start_attr, start_value))
paul@239 451
            rwrite(("DTEND", end_attr, end_value))
paul@236 452
            rwrite(("ORGANIZER", {}, self.user))
paul@202 453
paul@236 454
            for participant in participants:
paul@236 455
                if not participant:
paul@236 456
                    continue
paul@236 457
                participant = get_uri(participant)
paul@253 458
                rwrite(("ATTENDEE", {"RSVP" : "TRUE", "PARTSTAT" : "NEEDS-ACTION"}, participant))
paul@202 459
paul@236 460
            obj = ("VEVENT", {}, record)
paul@236 461
paul@236 462
            self.store.set_event(self.user, this_uid, obj)
paul@236 463
            self.store.queue_request(self.user, this_uid)
paul@202 464
paul@236 465
        # Redirect to the object (or the first of the objects), where instead of
paul@236 466
        # attendee controls, there will be organiser controls.
paul@236 467
paul@236 468
        self.redirect(self.env.new_url("%s-0" % uid))
paul@202 469
paul@286 470
    def handle_request(self, uid, obj):
paul@121 471
paul@299 472
        """
paul@299 473
        Handle actions involving the given 'uid' and 'obj' object, returning an
paul@299 474
        error if one occurred, or None if the request was successfully handled.
paul@299 475
        """
paul@121 476
paul@121 477
        # Handle a submitted form.
paul@121 478
paul@121 479
        args = self.env.get_args()
paul@299 480
paul@299 481
        # Get the possible actions.
paul@299 482
paul@299 483
        reply = args.has_key("reply")
paul@299 484
        discard = args.has_key("discard")
paul@299 485
        invite = args.has_key("invite")
paul@299 486
        cancel = args.has_key("cancel")
paul@299 487
        save = args.has_key("save")
paul@299 488
paul@299 489
        have_action = reply or discard or invite or cancel or save
paul@299 490
paul@299 491
        if not have_action:
paul@299 492
            return ["action"]
paul@121 493
paul@212 494
        # Update the object.
paul@212 495
paul@212 496
        if args.has_key("summary"):
paul@213 497
            obj["SUMMARY"] = [(args["summary"][0], {})]
paul@212 498
paul@257 499
        if args.has_key("partstat"):
paul@277 500
            organisers = obj.get_value_map("ORGANIZER")
paul@257 501
            attendees = obj.get_value_map("ATTENDEE")
paul@286 502
            for d in attendees, organisers:
paul@286 503
                if d.has_key(self.user):
paul@286 504
                    d[self.user]["PARTSTAT"] = args["partstat"][0]
paul@286 505
                    if d[self.user].has_key("RSVP"):
paul@286 506
                        del d[self.user]["RSVP"]
paul@286 507
paul@286 508
        is_organiser = obj.get_value("ORGANIZER") == self.user
paul@286 509
paul@286 510
        # Obtain the user's timezone and process datetime values.
paul@286 511
paul@286 512
        update = False
paul@286 513
paul@286 514
        if is_organiser:
paul@300 515
            dtend_enabled = args.get("dtend-control", [None])[0] == "enable"
paul@300 516
            dttimes_enabled = args.get("dttimes-control", [None])[0] == "enable"
paul@300 517
paul@300 518
            t = self.handle_date_controls("dtstart", dttimes_enabled)
paul@286 519
            if t:
paul@290 520
                dtstart, attr = t
paul@300 521
                update = self.set_datetime_in_object(dtstart, attr.get("TZID"), "DTSTART", obj) or update
paul@286 522
            else:
paul@299 523
                return ["dtstart"]
paul@290 524
paul@290 525
            # Handle specified end datetimes.
paul@290 526
paul@300 527
            if dtend_enabled:
paul@300 528
                t = self.handle_date_controls("dtend", dttimes_enabled)
paul@290 529
                if t:
paul@290 530
                    dtend, attr = t
paul@290 531
paul@290 532
                    # Convert end dates to iCalendar "next day" dates.
paul@286 533
paul@290 534
                    if not isinstance(dtend, datetime):
paul@290 535
                        dtend += timedelta(1)
paul@300 536
                    update = self.set_datetime_in_object(dtend, attr.get("TZID"), "DTEND", obj) or update
paul@290 537
                else:
paul@299 538
                    return ["dtend"]
paul@290 539
paul@299 540
            # Otherwise, treat the end date as the start date. Datetimes are
paul@299 541
            # handled by making the event occupy the rest of the day.
paul@290 542
paul@286 543
            else:
paul@299 544
                dtend = dtstart + timedelta(1)
paul@290 545
                if isinstance(dtstart, datetime):
paul@299 546
                    dtend = get_start_of_day(dtend, attr["TZID"])
paul@300 547
                update = self.set_datetime_in_object(dtend, attr.get("TZID"), "DTEND", obj) or update
paul@286 548
paul@290 549
            if dtstart >= dtend:
paul@299 550
                return ["dtstart", "dtend"]
paul@257 551
paul@212 552
        # Process any action.
paul@212 553
paul@299 554
        handled = True
paul@121 555
paul@266 556
        if reply or invite or cancel:
paul@121 557
paul@212 558
            handler = ManagerHandler(obj, self.user, self.messenger)
paul@121 559
paul@212 560
            # Process the object and remove it from the list of requests.
paul@121 561
paul@266 562
            if reply and handler.process_received_request(update) or \
paul@255 563
               (invite or cancel) and handler.process_created_request(invite and "REQUEST" or "CANCEL", update):
paul@121 564
paul@121 565
                self.remove_request(uid)
paul@121 566
paul@257 567
        # Save single user events.
paul@121 568
paul@257 569
        elif save:
paul@257 570
            self.store.set_event(self.user, uid, obj.to_node())
paul@296 571
            self.update_freebusy(uid, obj)
paul@257 572
            self.remove_request(uid)
paul@121 573
paul@257 574
        # Remove the request and the object.
paul@257 575
paul@257 576
        elif discard:
paul@296 577
            self.remove_from_freebusy(uid)
paul@234 578
            self.remove_event(uid)
paul@121 579
            self.remove_request(uid)
paul@121 580
paul@121 581
        else:
paul@123 582
            handled = False
paul@121 583
paul@212 584
        # Upon handling an action, redirect to the main page.
paul@212 585
paul@123 586
        if handled:
paul@123 587
            self.redirect(self.env.get_path())
paul@123 588
paul@299 589
        return None
paul@121 590
paul@300 591
    def handle_date_controls(self, name, with_time=True):
paul@155 592
paul@155 593
        """
paul@286 594
        Handle date control information for fields starting with 'name',
paul@290 595
        returning a (datetime, attr) tuple or None if the fields cannot be used
paul@286 596
        to construct a datetime object.
paul@155 597
        """
paul@155 598
paul@286 599
        args = self.env.get_args()
paul@286 600
paul@286 601
        if args.has_key("%s-date" % name):
paul@286 602
            date = args["%s-date" % name][0]
paul@300 603
paul@300 604
            if with_time:
paul@300 605
                hour = args.get("%s-hour" % name, [None])[0]
paul@300 606
                minute = args.get("%s-minute" % name, [None])[0]
paul@300 607
                second = args.get("%s-second" % name, [None])[0]
paul@300 608
                tzid = args.get("%s-tzid" % name, [self.get_tzid()])[0]
paul@286 609
paul@300 610
                time = (hour or minute or second) and "T%s%s%s" % (hour, minute, second) or ""
paul@300 611
                value = "%s%s" % (date, time)
paul@300 612
                attr = {"TZID" : tzid, "VALUE" : "DATE-TIME"}
paul@300 613
                dt = get_datetime(value, attr)
paul@300 614
            else:
paul@300 615
                attr = {"VALUE" : "DATE"}
paul@300 616
                dt = get_datetime(date)
paul@300 617
paul@286 618
            if dt:
paul@290 619
                return dt, attr
paul@286 620
paul@286 621
        return None
paul@286 622
paul@286 623
    def set_datetime_in_object(self, dt, tzid, property, obj):
paul@286 624
paul@286 625
        """
paul@286 626
        Set 'dt' and 'tzid' for the given 'property' in 'obj', returning whether
paul@286 627
        an update has occurred.
paul@286 628
        """
paul@286 629
paul@286 630
        if dt:
paul@286 631
            old_value = obj.get_value(property)
paul@286 632
            obj[property] = [get_datetime_item(dt, tzid)]
paul@286 633
            return format_datetime(dt) != old_value
paul@286 634
paul@286 635
        return False
paul@286 636
paul@286 637
    # Page fragment methods.
paul@286 638
paul@286 639
    def show_request_controls(self, obj):
paul@286 640
paul@286 641
        "Show form controls for a request concerning 'obj'."
paul@286 642
paul@212 643
        page = self.page
paul@212 644
paul@213 645
        is_organiser = obj.get_value("ORGANIZER") == self.user
paul@207 646
paul@253 647
        attendees = obj.get_value_map("ATTENDEE")
paul@253 648
        is_attendee = attendees.has_key(self.user)
paul@253 649
        attendee_attr = attendees.get(self.user)
paul@121 650
paul@276 651
        is_request = obj.get_value("UID") in self._get_requests()
paul@276 652
paul@257 653
        have_other_attendees = len(attendees) > (is_attendee and 1 or 0)
paul@257 654
paul@257 655
        # Show appropriate options depending on the role of the user.
paul@257 656
paul@257 657
        if is_attendee and not is_organiser:
paul@286 658
            page.p("An action is required for this request:")
paul@253 659
paul@255 660
            page.p()
paul@266 661
            page.input(name="reply", type="submit", value="Reply")
paul@255 662
            page.add(" ")
paul@255 663
            page.input(name="discard", type="submit", value="Discard")
paul@255 664
            page.p.close()
paul@207 665
paul@255 666
        if is_organiser:
paul@257 667
            if have_other_attendees:
paul@286 668
                page.p("As organiser, you can perform the following:")
paul@255 669
paul@257 670
                page.p()
paul@257 671
                page.input(name="invite", type="submit", value="Invite")
paul@257 672
                page.add(" ")
paul@276 673
                if is_request:
paul@276 674
                    page.input(name="discard", type="submit", value="Discard")
paul@276 675
                else:
paul@276 676
                    page.input(name="cancel", type="submit", value="Cancel")
paul@257 677
                page.p.close()
paul@257 678
            else:
paul@257 679
                page.p()
paul@257 680
                page.input(name="save", type="submit", value="Save")
paul@276 681
                page.add(" ")
paul@276 682
                page.input(name="discard", type="submit", value="Discard")
paul@257 683
                page.p.close()
paul@207 684
paul@287 685
    property_items = [
paul@287 686
        ("SUMMARY", "Summary"),
paul@287 687
        ("DTSTART", "Start"),
paul@287 688
        ("DTEND", "End"),
paul@287 689
        ("ORGANIZER", "Organiser"),
paul@287 690
        ("ATTENDEE", "Attendee"),
paul@287 691
        ]
paul@210 692
paul@257 693
    partstat_items = [
paul@257 694
        ("NEEDS-ACTION", "Not confirmed"),
paul@257 695
        ("ACCEPTED", "Attending"),
paul@259 696
        ("TENTATIVE", "Tentatively attending"),
paul@257 697
        ("DECLINED", "Not attending"),
paul@277 698
        ("DELEGATED", "Delegated"),
paul@257 699
        ]
paul@257 700
paul@299 701
    def show_object_on_page(self, uid, obj, error=None):
paul@121 702
paul@121 703
        """
paul@121 704
        Show the calendar object with the given 'uid' and representation 'obj'
paul@299 705
        on the current page. If 'error' is given, show a suitable message.
paul@121 706
        """
paul@121 707
paul@210 708
        page = self.page
paul@212 709
        page.form(method="POST")
paul@210 710
paul@154 711
        # Obtain the user's timezone.
paul@154 712
paul@244 713
        tzid = self.get_tzid()
paul@121 714
paul@290 715
        # Provide controls to change the displayed object.
paul@290 716
paul@290 717
        args = self.env.get_args()
paul@300 718
        dtend_control = args.get("dtend-control", [None])[0]
paul@300 719
        dttimes_control = args.get("dttimes-control", [None])[0]
paul@300 720
        with_time = dttimes_control == "enable"
paul@290 721
paul@300 722
        t = self.handle_date_controls("dtstart", with_time)
paul@290 723
        if t:
paul@290 724
            dtstart, dtstart_attr = t
paul@290 725
        else:
paul@290 726
            dtstart, dtstart_attr = obj.get_datetime_item("DTSTART")
paul@290 727
paul@297 728
        if dtend_control == "enable":
paul@300 729
            t = self.handle_date_controls("dtend", with_time)
paul@290 730
            if t:
paul@290 731
                dtend, dtend_attr = t
paul@297 732
            else:
paul@297 733
                dtend, dtend_attr = None, {}
paul@297 734
        elif dtend_control == "disable":
paul@297 735
            dtend, dtend_attr = None, {}
paul@297 736
        else:
paul@290 737
            dtend, dtend_attr = obj.get_datetime_item("DTEND")
paul@290 738
paul@290 739
        # Change end dates to refer to the actual dates, not the iCalendar
paul@290 740
        # "next day" dates.
paul@290 741
paul@290 742
        if dtend and not isinstance(dtend, datetime):
paul@290 743
            dtend -= timedelta(1)
paul@290 744
paul@297 745
        # Show the end datetime controls if already active or if an object needs
paul@297 746
        # them.
paul@297 747
paul@300 748
        dtend_enabled = dtend_control == "enable" or isinstance(dtend, datetime) or dtstart != dtend
paul@300 749
        dttimes_enabled = dttimes_control == "enable" or isinstance(dtstart, datetime) or isinstance(dtend, datetime)
paul@297 750
paul@300 751
        if dtend_enabled:
paul@290 752
            page.input(name="dtend-control", type="radio", value="enable", id="dtend-enable", checked="checked")
paul@290 753
            page.input(name="dtend-control", type="radio", value="disable", id="dtend-disable")
paul@290 754
        else:
paul@290 755
            page.input(name="dtend-control", type="radio", value="enable", id="dtend-enable")
paul@290 756
            page.input(name="dtend-control", type="radio", value="disable", id="dtend-disable", checked="checked")
paul@290 757
paul@300 758
        if dttimes_enabled:
paul@300 759
            page.input(name="dttimes-control", type="radio", value="enable", id="dttimes-enable", checked="checked")
paul@300 760
            page.input(name="dttimes-control", type="radio", value="disable", id="dttimes-disable")
paul@300 761
        else:
paul@300 762
            page.input(name="dttimes-control", type="radio", value="enable", id="dttimes-enable")
paul@300 763
            page.input(name="dttimes-control", type="radio", value="disable", id="dttimes-disable", checked="checked")
paul@300 764
paul@121 765
        # Provide a summary of the object.
paul@121 766
paul@230 767
        page.table(class_="object", cellspacing=5, cellpadding=5)
paul@212 768
        page.thead()
paul@212 769
        page.tr()
paul@286 770
        page.th("Event", class_="mainheading", colspan=2)
paul@212 771
        page.tr.close()
paul@212 772
        page.thead.close()
paul@212 773
        page.tbody()
paul@121 774
paul@269 775
        is_organiser = obj.get_value("ORGANIZER") == self.user
paul@269 776
paul@287 777
        for name, label in self.property_items:
paul@210 778
            page.tr()
paul@210 779
paul@210 780
            # Handle datetimes specially.
paul@210 781
paul@147 782
            if name in ["DTSTART", "DTEND"]:
paul@299 783
                field = name.lower()
paul@290 784
paul@299 785
                page.th(label, class_="objectheading %s%s" % (field, error and field in error and " error" or ""))
paul@290 786
paul@297 787
                # Obtain the datetime.
paul@297 788
paul@290 789
                if name == "DTSTART":
paul@290 790
                    dt, attr, event_tzid = dtstart, dtstart_attr, dtstart_attr.get("TZID", tzid)
paul@297 791
paul@297 792
                # Where no end datetime exists, use the start datetime as the
paul@297 793
                # basis of any potential datetime specified if dt-control is
paul@297 794
                # set.
paul@297 795
paul@290 796
                else:
paul@293 797
                    dt, attr, event_tzid = dtend or dtstart, dtend_attr or dtstart_attr, (dtend_attr or dtstart_attr).get("TZID", tzid)
paul@293 798
paul@300 799
                # Show controls for editing as organiser.
paul@286 800
paul@286 801
                if is_organiser:
paul@300 802
                    value = format_datetime(dt)
paul@300 803
paul@299 804
                    page.td(class_="objectvalue %s" % field)
paul@290 805
                    if name == "DTEND":
paul@300 806
                        page.div(class_="dt disabled")
paul@290 807
                        page.label("Specify end date", for_="dtend-enable", class_="enable")
paul@290 808
                        page.div.close()
paul@290 809
paul@300 810
                    page.div(class_="dt enabled")
paul@299 811
                    self._show_date_controls(field, value, attr, tzid)
paul@300 812
                    if name == "DTSTART":
paul@300 813
                        page.label("Specify times", for_="dttimes-enable", class_="time disabled enable")
paul@300 814
                        page.label("Specify dates only", for_="dttimes-disable", class_="time enabled disable")
paul@300 815
                    elif name == "DTEND":
paul@290 816
                        page.label("End on same day", for_="dtend-disable", class_="disable")
paul@290 817
                    page.div.close()
paul@290 818
paul@286 819
                    page.td.close()
paul@300 820
paul@300 821
                # Show a label as attendee.
paul@300 822
paul@286 823
                else:
paul@300 824
                    page.td(self.format_datetime(dt, "full"))
paul@286 825
paul@210 826
                page.tr.close()
paul@210 827
paul@212 828
            # Handle the summary specially.
paul@212 829
paul@212 830
            elif name == "SUMMARY":
paul@290 831
                value = args.get("summary", [obj.get_value(name)])[0]
paul@290 832
paul@212 833
                page.th(label, class_="objectheading")
paul@286 834
                page.td()
paul@269 835
                if is_organiser:
paul@269 836
                    page.input(name="summary", type="text", value=value, size=80)
paul@269 837
                else:
paul@269 838
                    page.add(value)
paul@212 839
                page.td.close()
paul@212 840
                page.tr.close()
paul@212 841
paul@210 842
            # Handle potentially many values.
paul@210 843
paul@147 844
            else:
paul@213 845
                items = obj.get_items(name)
paul@233 846
                if not items:
paul@233 847
                    continue
paul@233 848
paul@210 849
                page.th(label, class_="objectheading", rowspan=len(items))
paul@210 850
paul@210 851
                first = True
paul@210 852
paul@210 853
                for value, attr in items:
paul@210 854
                    if not first:
paul@210 855
                        page.tr()
paul@210 856
                    else:
paul@210 857
                        first = False
paul@121 858
paul@277 859
                    if name in ("ATTENDEE", "ORGANIZER"):
paul@265 860
                        page.td(class_="objectattribute")
paul@265 861
                        page.add(value)
paul@286 862
                        page.add(" ")
paul@210 863
paul@210 864
                        partstat = attr.get("PARTSTAT")
paul@286 865
                        if value == self.user and (not is_organiser or name == "ORGANIZER"):
paul@257 866
                            self._show_menu("partstat", partstat, self.partstat_items)
paul@265 867
                        else:
paul@286 868
                            page.span(dict(self.partstat_items).get(partstat, ""), class_="partstat")
paul@265 869
                    else:
paul@286 870
                        page.td(class_="objectattribute")
paul@265 871
                        page.add(value)
paul@210 872
paul@210 873
                    page.td.close()
paul@210 874
                    page.tr.close()
paul@210 875
paul@212 876
        page.tbody.close()
paul@210 877
        page.table.close()
paul@121 878
paul@213 879
        dtstart = format_datetime(obj.get_utc_datetime("DTSTART"))
paul@213 880
        dtend = format_datetime(obj.get_utc_datetime("DTEND"))
paul@121 881
paul@121 882
        # Indicate whether there are conflicting events.
paul@121 883
paul@121 884
        freebusy = self.store.get_freebusy(self.user)
paul@121 885
paul@121 886
        if freebusy:
paul@121 887
paul@121 888
            # Obtain any time zone details from the suggested event.
paul@121 889
paul@213 890
            _dtstart, attr = obj.get_item("DTSTART")
paul@154 891
            tzid = attr.get("TZID", tzid)
paul@121 892
paul@121 893
            # Show any conflicts.
paul@121 894
paul@121 895
            for t in have_conflict(freebusy, [(dtstart, dtend)], True):
paul@121 896
                start, end, found_uid = t[:3]
paul@154 897
paul@154 898
                # Provide details of any conflicting event.
paul@154 899
paul@121 900
                if uid != found_uid:
paul@149 901
                    start = self.format_datetime(to_timezone(get_datetime(start), tzid), "full")
paul@149 902
                    end = self.format_datetime(to_timezone(get_datetime(end), tzid), "full")
paul@210 903
                    page.p("Event conflicts with another from %s to %s: " % (start, end))
paul@154 904
paul@154 905
                    # Show the event summary for the conflicting event.
paul@154 906
paul@154 907
                    found_obj = self._get_object(found_uid)
paul@154 908
                    if found_obj:
paul@213 909
                        page.a(found_obj.get_value("SUMMARY"), href=self.env.new_url(found_uid))
paul@121 910
paul@286 911
        self.show_request_controls(obj)
paul@212 912
        page.form.close()
paul@212 913
paul@121 914
    def show_requests_on_page(self):
paul@69 915
paul@69 916
        "Show requests for the current user."
paul@69 917
paul@69 918
        # NOTE: This list could be more informative, but it is envisaged that
paul@69 919
        # NOTE: the requests would be visited directly anyway.
paul@69 920
paul@121 921
        requests = self._get_requests()
paul@70 922
paul@185 923
        self.page.div(id="pending-requests")
paul@185 924
paul@80 925
        if requests:
paul@114 926
            self.page.p("Pending requests:")
paul@114 927
paul@80 928
            self.page.ul()
paul@69 929
paul@80 930
            for request in requests:
paul@165 931
                obj = self._get_object(request)
paul@165 932
                if obj:
paul@165 933
                    self.page.li()
paul@213 934
                    self.page.a(obj.get_value("SUMMARY"), href="#request-%s" % request)
paul@165 935
                    self.page.li.close()
paul@80 936
paul@80 937
            self.page.ul.close()
paul@80 938
paul@80 939
        else:
paul@80 940
            self.page.p("There are no pending requests.")
paul@69 941
paul@185 942
        self.page.div.close()
paul@185 943
paul@185 944
    def show_participants_on_page(self):
paul@185 945
paul@185 946
        "Show participants for scheduling purposes."
paul@185 947
paul@185 948
        args = self.env.get_args()
paul@185 949
        participants = args.get("participants", [])
paul@185 950
paul@185 951
        try:
paul@185 952
            for name, value in args.items():
paul@185 953
                if name.startswith("remove-participant-"):
paul@185 954
                    i = int(name[len("remove-participant-"):])
paul@185 955
                    del participants[i]
paul@185 956
                    break
paul@185 957
        except ValueError:
paul@185 958
            pass
paul@185 959
paul@185 960
        # Trim empty participants.
paul@185 961
paul@185 962
        while participants and not participants[-1].strip():
paul@185 963
            participants.pop()
paul@185 964
paul@185 965
        # Show any specified participants together with controls to remove and
paul@185 966
        # add participants.
paul@185 967
paul@185 968
        self.page.div(id="participants")
paul@185 969
paul@185 970
        self.page.p("Participants for scheduling:")
paul@185 971
paul@185 972
        for i, participant in enumerate(participants):
paul@185 973
            self.page.p()
paul@185 974
            self.page.input(name="participants", type="text", value=participant)
paul@185 975
            self.page.input(name="remove-participant-%d" % i, type="submit", value="Remove")
paul@185 976
            self.page.p.close()
paul@185 977
paul@185 978
        self.page.p()
paul@185 979
        self.page.input(name="participants", type="text")
paul@185 980
        self.page.input(name="add-participant", type="submit", value="Add")
paul@185 981
        self.page.p.close()
paul@185 982
paul@185 983
        self.page.div.close()
paul@185 984
paul@185 985
        return participants
paul@185 986
paul@121 987
    # Full page output methods.
paul@70 988
paul@121 989
    def show_object(self, path_info):
paul@70 990
paul@121 991
        "Show an object request using the given 'path_info' for the current user."
paul@70 992
paul@121 993
        uid = self._get_uid(path_info)
paul@121 994
        obj = self._get_object(uid)
paul@121 995
paul@121 996
        if not obj:
paul@70 997
            return False
paul@70 998
paul@299 999
        error = self.handle_request(uid, obj)
paul@77 1000
paul@299 1001
        if not error:
paul@123 1002
            return True
paul@73 1003
paul@123 1004
        self.new_page(title="Event")
paul@299 1005
        self.show_object_on_page(uid, obj, error)
paul@73 1006
paul@70 1007
        return True
paul@70 1008
paul@114 1009
    def show_calendar(self):
paul@114 1010
paul@114 1011
        "Show the calendar for the current user."
paul@114 1012
paul@202 1013
        handled = self.handle_newevent()
paul@202 1014
paul@114 1015
        self.new_page(title="Calendar")
paul@162 1016
        page = self.page
paul@162 1017
paul@196 1018
        # Form controls are used in various places on the calendar page.
paul@196 1019
paul@196 1020
        page.form(method="POST")
paul@196 1021
paul@121 1022
        self.show_requests_on_page()
paul@185 1023
        participants = self.show_participants_on_page()
paul@114 1024
paul@196 1025
        # Show a button for scheduling a new event.
paul@196 1026
paul@230 1027
        page.p(class_="controls")
paul@196 1028
        page.input(name="newevent", type="submit", value="New event", id="newevent")
paul@258 1029
        page.input(name="reset", type="submit", value="Clear selections", id="reset")
paul@196 1030
        page.p.close()
paul@196 1031
paul@280 1032
        # Show controls for hiding empty days and busy slots.
paul@203 1033
        # The positioning of the control, paragraph and table are important here.
paul@203 1034
paul@288 1035
        page.input(name="showdays", type="checkbox", value="show", id="showdays", accesskey="D")
paul@282 1036
        page.input(name="hidebusy", type="checkbox", value="hide", id="hidebusy", accesskey="B")
paul@203 1037
paul@230 1038
        page.p(class_="controls")
paul@237 1039
        page.label("Hide busy time periods", for_="hidebusy", class_="hidebusy enable")
paul@237 1040
        page.label("Show busy time periods", for_="hidebusy", class_="hidebusy disable")
paul@288 1041
        page.label("Show empty days", for_="showdays", class_="showdays disable")
paul@288 1042
        page.label("Hide empty days", for_="showdays", class_="showdays enable")
paul@203 1043
        page.p.close()
paul@203 1044
paul@114 1045
        freebusy = self.store.get_freebusy(self.user)
paul@114 1046
paul@114 1047
        if not freebusy:
paul@114 1048
            page.p("No events scheduled.")
paul@114 1049
            return
paul@114 1050
paul@154 1051
        # Obtain the user's timezone.
paul@147 1052
paul@244 1053
        tzid = self.get_tzid()
paul@147 1054
paul@114 1055
        # Day view: start at the earliest known day and produce days until the
paul@114 1056
        # latest known day, perhaps with expandable sections of empty days.
paul@114 1057
paul@114 1058
        # Month view: start at the earliest known month and produce months until
paul@114 1059
        # the latest known month, perhaps with expandable sections of empty
paul@114 1060
        # months.
paul@114 1061
paul@114 1062
        # Details of users to invite to new events could be superimposed on the
paul@114 1063
        # calendar.
paul@114 1064
paul@185 1065
        # Requests are listed and linked to their tentative positions in the
paul@185 1066
        # calendar. Other participants are also shown.
paul@185 1067
paul@185 1068
        request_summary = self._get_request_summary()
paul@185 1069
paul@185 1070
        period_groups = [request_summary, freebusy]
paul@185 1071
        period_group_types = ["request", "freebusy"]
paul@185 1072
        period_group_sources = ["Pending requests", "Your schedule"]
paul@185 1073
paul@187 1074
        for i, participant in enumerate(participants):
paul@185 1075
            period_groups.append(self.store.get_freebusy_for_other(self.user, get_uri(participant)))
paul@187 1076
            period_group_types.append("freebusy-part%d" % i)
paul@185 1077
            period_group_sources.append(participant)
paul@114 1078
paul@162 1079
        groups = []
paul@162 1080
        group_columns = []
paul@185 1081
        group_types = period_group_types
paul@185 1082
        group_sources = period_group_sources
paul@162 1083
        all_points = set()
paul@162 1084
paul@162 1085
        # Obtain time point information for each group of periods.
paul@162 1086
paul@185 1087
        for periods in period_groups:
paul@162 1088
            periods = convert_periods(periods, tzid)
paul@162 1089
paul@162 1090
            # Get the time scale with start and end points.
paul@162 1091
paul@162 1092
            scale = get_scale(periods)
paul@162 1093
paul@162 1094
            # Get the time slots for the periods.
paul@162 1095
paul@162 1096
            slots = get_slots(scale)
paul@162 1097
paul@162 1098
            # Add start of day time points for multi-day periods.
paul@162 1099
paul@244 1100
            add_day_start_points(slots, tzid)
paul@162 1101
paul@162 1102
            # Record the slots and all time points employed.
paul@162 1103
paul@162 1104
            groups.append(slots)
paul@201 1105
            all_points.update([point for point, active in slots])
paul@162 1106
paul@162 1107
        # Partition the groups into days.
paul@162 1108
paul@162 1109
        days = {}
paul@162 1110
        partitioned_groups = []
paul@171 1111
        partitioned_group_types = []
paul@185 1112
        partitioned_group_sources = []
paul@162 1113
paul@185 1114
        for slots, group_type, group_source in zip(groups, group_types, group_sources):
paul@162 1115
paul@162 1116
            # Propagate time points to all groups of time slots.
paul@162 1117
paul@162 1118
            add_slots(slots, all_points)
paul@162 1119
paul@162 1120
            # Count the number of columns employed by the group.
paul@162 1121
paul@162 1122
            columns = 0
paul@162 1123
paul@162 1124
            # Partition the time slots by day.
paul@162 1125
paul@162 1126
            partitioned = {}
paul@162 1127
paul@162 1128
            for day, day_slots in partition_by_day(slots).items():
paul@201 1129
                intervals = []
paul@201 1130
                last = None
paul@201 1131
paul@201 1132
                for point, active in day_slots:
paul@201 1133
                    columns = max(columns, len(active))
paul@201 1134
                    if last:
paul@201 1135
                        intervals.append((last, point))
paul@201 1136
                    last = point
paul@201 1137
paul@201 1138
                if last:
paul@201 1139
                    intervals.append((last, None))
paul@162 1140
paul@162 1141
                if not days.has_key(day):
paul@162 1142
                    days[day] = set()
paul@162 1143
paul@162 1144
                # Convert each partition to a mapping from points to active
paul@162 1145
                # periods.
paul@162 1146
paul@201 1147
                partitioned[day] = dict(day_slots)
paul@201 1148
paul@201 1149
                # Record the divisions or intervals within each day.
paul@201 1150
paul@201 1151
                days[day].update(intervals)
paul@162 1152
paul@194 1153
            if group_type != "request" or columns:
paul@194 1154
                group_columns.append(columns)
paul@194 1155
                partitioned_groups.append(partitioned)
paul@194 1156
                partitioned_group_types.append(group_type)
paul@194 1157
                partitioned_group_sources.append(group_source)
paul@114 1158
paul@279 1159
        # Add empty days.
paul@279 1160
paul@283 1161
        add_empty_days(days, tzid)
paul@279 1162
paul@279 1163
        # Show the controls permitting day selection.
paul@279 1164
paul@243 1165
        self.show_calendar_day_controls(days)
paul@243 1166
paul@279 1167
        # Show the calendar itself.
paul@279 1168
paul@230 1169
        page.table(cellspacing=5, cellpadding=5, class_="calendar")
paul@188 1170
        self.show_calendar_participant_headings(partitioned_group_types, partitioned_group_sources, group_columns)
paul@171 1171
        self.show_calendar_days(days, partitioned_groups, partitioned_group_types, group_columns)
paul@162 1172
        page.table.close()
paul@114 1173
paul@196 1174
        # End the form region.
paul@196 1175
paul@196 1176
        page.form.close()
paul@196 1177
paul@246 1178
    # More page fragment methods.
paul@246 1179
paul@243 1180
    def show_calendar_day_controls(self, days):
paul@243 1181
paul@243 1182
        "Show controls for the given 'days' in the calendar."
paul@243 1183
paul@243 1184
        page = self.page
paul@243 1185
        slots = self.env.get_args().get("slot", [])
paul@243 1186
paul@243 1187
        for day in days:
paul@243 1188
            value, identifier = self._day_value_and_identifier(day)
paul@243 1189
            self._slot_selector(value, identifier, slots)
paul@243 1190
paul@243 1191
        # Generate a dynamic stylesheet to allow day selections to colour
paul@243 1192
        # specific days.
paul@243 1193
        # NOTE: The style details need to be coordinated with the static
paul@243 1194
        # NOTE: stylesheet.
paul@243 1195
paul@243 1196
        page.style(type="text/css")
paul@243 1197
paul@243 1198
        for day in days:
paul@243 1199
            daystr = format_datetime(day)
paul@243 1200
            page.add("""\
paul@249 1201
input.newevent.selector#day-%s-:checked ~ table label.day.day-%s,
paul@249 1202
input.newevent.selector#day-%s-:checked ~ table label.timepoint.day-%s {
paul@243 1203
    background-color: #5f4;
paul@243 1204
    text-decoration: underline;
paul@243 1205
}
paul@243 1206
""" % (daystr, daystr, daystr, daystr))
paul@243 1207
paul@243 1208
        page.style.close()
paul@243 1209
paul@188 1210
    def show_calendar_participant_headings(self, group_types, group_sources, group_columns):
paul@186 1211
paul@186 1212
        """
paul@186 1213
        Show headings for the participants and other scheduling contributors,
paul@188 1214
        defined by 'group_types', 'group_sources' and 'group_columns'.
paul@186 1215
        """
paul@186 1216
paul@185 1217
        page = self.page
paul@185 1218
paul@188 1219
        page.colgroup(span=1, id="columns-timeslot")
paul@186 1220
paul@188 1221
        for group_type, columns in zip(group_types, group_columns):
paul@191 1222
            page.colgroup(span=max(columns, 1), id="columns-%s" % group_type)
paul@186 1223
paul@185 1224
        page.thead()
paul@185 1225
        page.tr()
paul@185 1226
        page.th("", class_="emptyheading")
paul@185 1227
paul@193 1228
        for group_type, source, columns in zip(group_types, group_sources, group_columns):
paul@193 1229
            page.th(source,
paul@193 1230
                class_=(group_type == "request" and "requestheading" or "participantheading"),
paul@193 1231
                colspan=max(columns, 1))
paul@185 1232
paul@185 1233
        page.tr.close()
paul@185 1234
        page.thead.close()
paul@185 1235
paul@171 1236
    def show_calendar_days(self, days, partitioned_groups, partitioned_group_types, group_columns):
paul@186 1237
paul@186 1238
        """
paul@186 1239
        Show calendar days, defined by a collection of 'days', the contributing
paul@186 1240
        period information as 'partitioned_groups' (partitioned by day), the
paul@186 1241
        'partitioned_group_types' indicating the kind of contribution involved,
paul@186 1242
        and the 'group_columns' defining the number of columns in each group.
paul@186 1243
        """
paul@186 1244
paul@162 1245
        page = self.page
paul@162 1246
paul@191 1247
        # Determine the number of columns required. Where participants provide
paul@191 1248
        # no columns for events, one still needs to be provided for the
paul@191 1249
        # participant itself.
paul@147 1250
paul@191 1251
        all_columns = sum([max(columns, 1) for columns in group_columns])
paul@191 1252
paul@191 1253
        # Determine the days providing time slots.
paul@191 1254
paul@162 1255
        all_days = days.items()
paul@162 1256
        all_days.sort()
paul@162 1257
paul@162 1258
        # Produce a heading and time points for each day.
paul@162 1259
paul@201 1260
        for day, intervals in all_days:
paul@279 1261
            groups_for_day = [partitioned.get(day) for partitioned in partitioned_groups]
paul@279 1262
            is_empty = True
paul@279 1263
paul@279 1264
            for slots in groups_for_day:
paul@279 1265
                if not slots:
paul@279 1266
                    continue
paul@279 1267
paul@279 1268
                for active in slots.values():
paul@279 1269
                    if active:
paul@279 1270
                        is_empty = False
paul@279 1271
                        break
paul@279 1272
paul@282 1273
            page.thead(class_="separator%s" % (is_empty and " empty" or ""))
paul@282 1274
            page.tr()
paul@243 1275
            page.th(class_="dayheading container", colspan=all_columns+1)
paul@239 1276
            self._day_heading(day)
paul@114 1277
            page.th.close()
paul@153 1278
            page.tr.close()
paul@186 1279
            page.thead.close()
paul@114 1280
paul@282 1281
            page.tbody(class_="points%s" % (is_empty and " empty" or ""))
paul@280 1282
            self.show_calendar_points(intervals, groups_for_day, partitioned_group_types, group_columns)
paul@186 1283
            page.tbody.close()
paul@185 1284
paul@280 1285
    def show_calendar_points(self, intervals, groups, group_types, group_columns):
paul@186 1286
paul@186 1287
        """
paul@201 1288
        Show the time 'intervals' along with period information from the given
paul@186 1289
        'groups', having the indicated 'group_types', each with the number of
paul@186 1290
        columns given by 'group_columns'.
paul@186 1291
        """
paul@186 1292
paul@162 1293
        page = self.page
paul@162 1294
paul@244 1295
        # Obtain the user's timezone.
paul@244 1296
paul@244 1297
        tzid = self.get_tzid()
paul@244 1298
paul@203 1299
        # Produce a row for each interval.
paul@162 1300
paul@201 1301
        intervals = list(intervals)
paul@201 1302
        intervals.sort()
paul@162 1303
paul@201 1304
        for point, endpoint in intervals:
paul@244 1305
            continuation = point == get_start_of_day(point, tzid)
paul@153 1306
paul@203 1307
            # Some rows contain no period details and are marked as such.
paul@203 1308
paul@283 1309
            have_active = reduce(lambda x, y: x or y, [slots and slots.get(point) for slots in groups], None)
paul@203 1310
paul@203 1311
            css = " ".join(
paul@203 1312
                ["slot"] +
paul@231 1313
                (have_active and ["busy"] or ["empty"]) +
paul@203 1314
                (continuation and ["daystart"] or [])
paul@203 1315
                )
paul@203 1316
paul@203 1317
            page.tr(class_=css)
paul@162 1318
            page.th(class_="timeslot")
paul@201 1319
            self._time_point(point, endpoint)
paul@162 1320
            page.th.close()
paul@162 1321
paul@162 1322
            # Obtain slots for the time point from each group.
paul@162 1323
paul@171 1324
            for columns, slots, group_type in zip(group_columns, groups, group_types):
paul@162 1325
                active = slots and slots.get(point)
paul@162 1326
paul@191 1327
                # Where no periods exist for the given time interval, generate
paul@191 1328
                # an empty cell. Where a participant provides no periods at all,
paul@191 1329
                # the colspan is adjusted to be 1, not 0.
paul@191 1330
paul@162 1331
                if not active:
paul@196 1332
                    page.td(class_="empty container", colspan=max(columns, 1))
paul@201 1333
                    self._empty_slot(point, endpoint)
paul@196 1334
                    page.td.close()
paul@162 1335
                    continue
paul@162 1336
paul@162 1337
                slots = slots.items()
paul@162 1338
                slots.sort()
paul@162 1339
                spans = get_spans(slots)
paul@162 1340
paul@278 1341
                empty = 0
paul@278 1342
paul@162 1343
                # Show a column for each active period.
paul@117 1344
paul@153 1345
                for t in active:
paul@185 1346
                    if t and len(t) >= 2:
paul@278 1347
paul@278 1348
                        # Flush empty slots preceding this one.
paul@278 1349
paul@278 1350
                        if empty:
paul@278 1351
                            page.td(class_="empty container", colspan=empty)
paul@278 1352
                            self._empty_slot(point, endpoint)
paul@278 1353
                            page.td.close()
paul@278 1354
                            empty = 0
paul@278 1355
paul@185 1356
                        start, end, uid, key = get_freebusy_details(t)
paul@185 1357
                        span = spans[key]
paul@171 1358
paul@171 1359
                        # Produce a table cell only at the start of the period
paul@171 1360
                        # or when continued at the start of a day.
paul@171 1361
paul@153 1362
                        if point == start or continuation:
paul@153 1363
paul@275 1364
                            obj = self._get_object(uid)
paul@275 1365
paul@195 1366
                            has_continued = continuation and point != start
paul@244 1367
                            will_continue = not ends_on_same_day(point, end, tzid)
paul@291 1368
                            is_organiser = obj and obj.get_value("ORGANIZER") == self.user
paul@275 1369
paul@195 1370
                            css = " ".join(
paul@195 1371
                                ["event"] +
paul@195 1372
                                (has_continued and ["continued"] or []) +
paul@275 1373
                                (will_continue and ["continues"] or []) +
paul@275 1374
                                (is_organiser and ["organising"] or ["attending"])
paul@195 1375
                                )
paul@195 1376
paul@189 1377
                            # Only anchor the first cell of events.
paul@189 1378
paul@189 1379
                            if point == start:
paul@195 1380
                                page.td(class_=css, rowspan=span, id="%s-%s" % (group_type, uid))
paul@189 1381
                            else:
paul@195 1382
                                page.td(class_=css, rowspan=span)
paul@171 1383
paul@185 1384
                            if not obj:
paul@291 1385
                                page.span("(Participant is busy)")
paul@185 1386
                            else:
paul@213 1387
                                summary = obj.get_value("SUMMARY")
paul@171 1388
paul@171 1389
                                # Only link to events if they are not being
paul@171 1390
                                # updated by requests.
paul@171 1391
paul@171 1392
                                if uid in self._get_requests() and group_type != "request":
paul@189 1393
                                    page.span(summary)
paul@164 1394
                                else:
paul@171 1395
                                    href = "%s/%s" % (self.env.get_url().rstrip("/"), uid)
paul@189 1396
                                    page.a(summary, href=href)
paul@171 1397
paul@153 1398
                            page.td.close()
paul@153 1399
                    else:
paul@278 1400
                        empty += 1
paul@114 1401
paul@166 1402
                # Pad with empty columns.
paul@166 1403
paul@278 1404
                empty = columns - len(active)
paul@278 1405
paul@278 1406
                if empty:
paul@278 1407
                    page.td(class_="empty container", colspan=empty)
paul@201 1408
                    self._empty_slot(point, endpoint)
paul@196 1409
                    page.td.close()
paul@166 1410
paul@162 1411
            page.tr.close()
paul@114 1412
paul@239 1413
    def _day_heading(self, day):
paul@243 1414
paul@243 1415
        """
paul@243 1416
        Generate a heading for 'day' of the following form:
paul@243 1417
paul@243 1418
        <label class="day day-20150203" for="day-20150203">Tuesday, 3 February 2015</label>
paul@243 1419
        """
paul@243 1420
paul@239 1421
        page = self.page
paul@243 1422
        daystr = format_datetime(day)
paul@239 1423
        value, identifier = self._day_value_and_identifier(day)
paul@243 1424
        page.label(self.format_date(day, "full"), class_="day day-%s" % daystr, for_=identifier)
paul@239 1425
paul@201 1426
    def _time_point(self, point, endpoint):
paul@243 1427
paul@243 1428
        """
paul@243 1429
        Generate headings for the 'point' to 'endpoint' period of the following
paul@243 1430
        form:
paul@243 1431
paul@243 1432
        <label class="timepoint day-20150203" for="slot-20150203T090000-20150203T100000">09:00:00 CET</label>
paul@243 1433
        <span class="endpoint">10:00:00 CET</span>
paul@243 1434
        """
paul@243 1435
paul@201 1436
        page = self.page
paul@244 1437
        tzid = self.get_tzid()
paul@243 1438
        daystr = format_datetime(point.date())
paul@201 1439
        value, identifier = self._slot_value_and_identifier(point, endpoint)
paul@238 1440
        slots = self.env.get_args().get("slot", [])
paul@239 1441
        self._slot_selector(value, identifier, slots)
paul@243 1442
        page.label(self.format_time(point, "long"), class_="timepoint day-%s" % daystr, for_=identifier)
paul@244 1443
        page.span(self.format_time(endpoint or get_end_of_day(point, tzid), "long"), class_="endpoint")
paul@239 1444
paul@239 1445
    def _slot_selector(self, value, identifier, slots):
paul@258 1446
        reset = self.env.get_args().has_key("reset")
paul@239 1447
        page = self.page
paul@258 1448
        if not reset and value in slots:
paul@249 1449
            page.input(name="slot", type="checkbox", value=value, id=identifier, class_="newevent selector", checked="checked")
paul@202 1450
        else:
paul@249 1451
            page.input(name="slot", type="checkbox", value=value, id=identifier, class_="newevent selector")
paul@201 1452
paul@201 1453
    def _empty_slot(self, point, endpoint):
paul@197 1454
        page = self.page
paul@201 1455
        value, identifier = self._slot_value_and_identifier(point, endpoint)
paul@236 1456
        page.label("Select/deselect period", class_="newevent popup", for_=identifier)
paul@196 1457
paul@239 1458
    def _day_value_and_identifier(self, day):
paul@239 1459
        value = "%s-" % format_datetime(day)
paul@239 1460
        identifier = "day-%s" % value
paul@239 1461
        return value, identifier
paul@239 1462
paul@201 1463
    def _slot_value_and_identifier(self, point, endpoint):
paul@202 1464
        value = "%s-%s" % (format_datetime(point), endpoint and format_datetime(endpoint) or "")
paul@201 1465
        identifier = "slot-%s" % value
paul@201 1466
        return value, identifier
paul@196 1467
paul@286 1468
    def _show_menu(self, name, default, items):
paul@257 1469
        page = self.page
paul@286 1470
        values = self.env.get_args().get(name, [default])
paul@257 1471
        page.select(name=name)
paul@257 1472
        for v, label in items:
paul@257 1473
            if v in values:
paul@257 1474
                page.option(label, value=v, selected="selected")
paul@257 1475
            else:
paul@257 1476
                page.option(label, value=v)
paul@257 1477
        page.select.close()
paul@257 1478
paul@286 1479
    def _show_date_controls(self, name, default, attr, tzid):
paul@286 1480
paul@286 1481
        """
paul@286 1482
        Show date controls for a field with the given 'name' and 'default' value
paul@286 1483
        and 'attr', with the given 'tzid' being used if no other time regime
paul@286 1484
        information is provided.
paul@286 1485
        """
paul@286 1486
paul@286 1487
        page = self.page
paul@286 1488
        args = self.env.get_args()
paul@286 1489
paul@286 1490
        event_tzid = attr.get("TZID", tzid)
paul@286 1491
        dt = get_datetime(default, attr)
paul@286 1492
paul@286 1493
        # Show dates for up to one week around the current date.
paul@286 1494
paul@286 1495
        base = get_date(dt)
paul@286 1496
        items = []
paul@286 1497
        for i in range(-7, 8):
paul@286 1498
            d = base + timedelta(i)
paul@286 1499
            items.append((format_datetime(d), self.format_date(d, "full")))
paul@286 1500
paul@286 1501
        self._show_menu("%s-date" % name, format_datetime(base), items)
paul@286 1502
paul@286 1503
        # Show time details.
paul@286 1504
paul@300 1505
        dt_time = isinstance(dt, datetime) and dt or None
paul@300 1506
        hour = args.get("%s-hour" % name, "%02d" % (dt_time and dt_time.hour or 0))
paul@300 1507
        minute = args.get("%s-minute" % name, "%02d" % (dt_time and dt_time.minute or 0))
paul@300 1508
        second = args.get("%s-second" % name, "%02d" % (dt_time and dt_time.second or 0))
paul@300 1509
paul@300 1510
        page.span(class_="time enabled")
paul@300 1511
        page.input(name="%s-hour" % name, type="text", value=hour, maxlength=2, size=2)
paul@300 1512
        page.add(":")
paul@300 1513
        page.input(name="%s-minute" % name, type="text", value=minute, maxlength=2, size=2)
paul@300 1514
        page.add(":")
paul@300 1515
        page.input(name="%s-second" % name, type="text", value=second, maxlength=2, size=2)
paul@300 1516
        page.add(" ")
paul@300 1517
        self._show_menu("%s-tzid" % name, event_tzid,
paul@300 1518
            [(event_tzid, event_tzid)] + (
paul@300 1519
            event_tzid != tzid and [(tzid, tzid)] or []
paul@300 1520
            ))
paul@300 1521
        page.span.close()
paul@286 1522
paul@246 1523
    # Incoming HTTP request direction.
paul@246 1524
paul@69 1525
    def select_action(self):
paul@69 1526
paul@69 1527
        "Select the desired action and show the result."
paul@69 1528
paul@121 1529
        path_info = self.env.get_path_info().strip("/")
paul@121 1530
paul@69 1531
        if not path_info:
paul@114 1532
            self.show_calendar()
paul@121 1533
        elif self.show_object(path_info):
paul@70 1534
            pass
paul@70 1535
        else:
paul@70 1536
            self.no_page()
paul@69 1537
paul@82 1538
    def __call__(self):
paul@69 1539
paul@69 1540
        "Interpret a request and show an appropriate response."
paul@69 1541
paul@69 1542
        if not self.user:
paul@69 1543
            self.no_user()
paul@69 1544
        else:
paul@69 1545
            self.select_action()
paul@69 1546
paul@70 1547
        # Write the headers and actual content.
paul@70 1548
paul@69 1549
        print >>self.out, "Content-Type: text/html; charset=%s" % self.encoding
paul@69 1550
        print >>self.out
paul@69 1551
        self.out.write(unicode(self.page).encode(self.encoding))
paul@69 1552
paul@69 1553
if __name__ == "__main__":
paul@128 1554
    Manager()()
paul@69 1555
paul@69 1556
# vim: tabstop=4 expandtab shiftwidth=4