imip-agent

Annotated imip_manager.py

232:58602ad6f673
2015-02-02 Paul Boddie Added some support for full day events, particularly in the manager interface.
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@153 36
from imiptools.dates import format_datetime, get_datetime, get_start_of_day, \
paul@222 37
                            get_end_of_day, get_timestamp, ends_on_same_day, \
paul@222 38
                            to_timezone
paul@83 39
from imiptools.mail import Messenger
paul@162 40
from imiptools.period import add_day_start_points, add_slots, convert_periods, \
paul@185 41
                             get_freebusy_details, \
paul@162 42
                             get_scale, have_conflict, get_slots, get_spans, \
paul@162 43
                             partition_by_day
paul@147 44
from imiptools.profile import Preferences
paul@213 45
import imip_store
paul@69 46
import markup
paul@69 47
paul@69 48
getenv = os.environ.get
paul@69 49
setenv = os.environ.__setitem__
paul@69 50
paul@69 51
class CGIEnvironment:
paul@69 52
paul@69 53
    "A CGI-compatible environment."
paul@69 54
paul@212 55
    def __init__(self, charset=None):
paul@212 56
        self.charset = charset
paul@69 57
        self.args = None
paul@69 58
        self.method = None
paul@69 59
        self.path = None
paul@69 60
        self.path_info = None
paul@69 61
        self.user = None
paul@69 62
paul@69 63
    def get_args(self):
paul@69 64
        if self.args is None:
paul@69 65
            if self.get_method() != "POST":
paul@69 66
                setenv("QUERY_STRING", "")
paul@212 67
            args = cgi.parse(keep_blank_values=True)
paul@212 68
paul@212 69
            if not self.charset:
paul@212 70
                self.args = args
paul@212 71
            else:
paul@212 72
                self.args = {}
paul@212 73
                for key, values in args.items():
paul@212 74
                    self.args[key] = [unicode(value, self.charset) for value in values]
paul@212 75
paul@69 76
        return self.args
paul@69 77
paul@69 78
    def get_method(self):
paul@69 79
        if self.method is None:
paul@69 80
            self.method = getenv("REQUEST_METHOD") or "GET"
paul@69 81
        return self.method
paul@69 82
paul@69 83
    def get_path(self):
paul@69 84
        if self.path is None:
paul@69 85
            self.path = getenv("SCRIPT_NAME") or ""
paul@69 86
        return self.path
paul@69 87
paul@69 88
    def get_path_info(self):
paul@69 89
        if self.path_info is None:
paul@69 90
            self.path_info = getenv("PATH_INFO") or ""
paul@69 91
        return self.path_info
paul@69 92
paul@69 93
    def get_user(self):
paul@69 94
        if self.user is None:
paul@69 95
            self.user = getenv("REMOTE_USER") or ""
paul@69 96
        return self.user
paul@69 97
paul@69 98
    def get_output(self):
paul@69 99
        return sys.stdout
paul@69 100
paul@69 101
    def get_url(self):
paul@69 102
        path = self.get_path()
paul@69 103
        path_info = self.get_path_info()
paul@69 104
        return "%s%s" % (path.rstrip("/"), path_info)
paul@69 105
paul@154 106
    def new_url(self, path_info):
paul@154 107
        path = self.get_path()
paul@154 108
        return "%s/%s" % (path.rstrip("/"), path_info.lstrip("/"))
paul@154 109
paul@222 110
class ManagerHandler(Handler):
paul@79 111
paul@121 112
    """
paul@121 113
    A content handler for use by the manager, as opposed to operating within the
paul@121 114
    mail processing pipeline.
paul@121 115
    """
paul@79 116
paul@121 117
    def __init__(self, obj, user, messenger):
paul@224 118
        Handler.__init__(self, messenger=messenger)
paul@224 119
        self.set_object(obj)
paul@79 120
        self.user = user
paul@82 121
paul@213 122
        self.organiser = self.obj.get_value("ORGANIZER")
paul@213 123
        self.attendees = self.obj.get_values("ATTENDEE")
paul@79 124
paul@79 125
    # Communication methods.
paul@79 126
paul@207 127
    def send_message(self, method, sender):
paul@79 128
paul@79 129
        """
paul@207 130
        Create a full calendar object employing the given 'method', and send it
paul@207 131
        to the appropriate recipients, also sending a copy to the 'sender'.
paul@79 132
        """
paul@79 133
paul@219 134
        parts = [self.obj.to_part(method)]
paul@207 135
paul@222 136
        if self.user == self.organiser:
paul@207 137
            recipients = map(get_address, self.attendees)
paul@207 138
        else:
paul@207 139
            recipients = [get_address(self.organiser)]
paul@207 140
paul@219 141
        # Bundle free/busy information if appropriate.
paul@219 142
paul@219 143
        preferences = Preferences(self.user)
paul@219 144
paul@219 145
        if preferences.get("freebusy_sharing") == "share" and \
paul@219 146
           preferences.get("freebusy_bundling") == "always":
paul@219 147
paul@222 148
            # Invent a unique identifier.
paul@222 149
paul@222 150
            utcnow = get_timestamp()
paul@222 151
            uid = "imip-agent-%s-%s" % (utcnow, get_address(self.user))
paul@222 152
paul@222 153
            freebusy = self.store.get_freebusy(self.user)
paul@222 154
            parts.append(to_part("PUBLISH", [make_freebusy(freebusy, uid, self.user)]))
paul@219 155
paul@219 156
        message = self.messenger.make_outgoing_message(parts, recipients, outgoing_bcc=sender)
paul@207 157
        self.messenger.sendmail(recipients, message.as_string(), outgoing_bcc=sender)
paul@79 158
paul@79 159
    # Action methods.
paul@79 160
paul@207 161
    def process_received_request(self, accept, update=False):
paul@79 162
paul@79 163
        """
paul@79 164
        Process the current request for the given 'user', accepting any request
paul@79 165
        when 'accept' is true, declining requests otherwise. Return whether any
paul@79 166
        action was taken.
paul@155 167
paul@155 168
        If 'update' is given, the sequence number will be incremented in order
paul@155 169
        to override any previous response.
paul@79 170
        """
paul@79 171
paul@79 172
        # When accepting or declining, do so only on behalf of this user,
paul@79 173
        # preserving any other attributes set as an attendee.
paul@79 174
paul@213 175
        for attendee, attendee_attr in self.obj.get_items("ATTENDEE"):
paul@79 176
paul@79 177
            if attendee == self.user:
paul@79 178
                attendee_attr["PARTSTAT"] = accept and "ACCEPTED" or "DECLINED"
paul@128 179
                if self.messenger and self.messenger.sender != get_address(attendee):
paul@128 180
                    attendee_attr["SENT-BY"] = get_uri(self.messenger.sender)
paul@213 181
                self.obj["ATTENDEE"] = [(attendee, attendee_attr)]
paul@155 182
                if update:
paul@213 183
                    sequence = self.obj.get_value("SEQUENCE") or "0"
paul@213 184
                    self.obj["SEQUENCE"] = [(str(int(sequence) + 1), {})]
paul@158 185
                self.update_dtstamp()
paul@155 186
paul@207 187
                self.send_message("REPLY", get_address(attendee))
paul@79 188
paul@79 189
                return True
paul@79 190
paul@79 191
        return False
paul@79 192
paul@207 193
    def process_created_request(self, update=False):
paul@207 194
paul@207 195
        """
paul@207 196
        Process the current request for the given 'user', sending a created
paul@207 197
        request to attendees. Return whether any action was taken.
paul@207 198
paul@207 199
        If 'update' is given, the sequence number will be incremented in order
paul@207 200
        to override any previous message.
paul@207 201
        """
paul@207 202
paul@213 203
        organiser, organiser_attr = self.obj.get_item("ORGANIZER")
paul@213 204
paul@213 205
        if self.messenger and self.messenger.sender != get_address(organiser):
paul@213 206
            organiser_attr["SENT-BY"] = get_uri(self.messenger.sender)
paul@207 207
        if update:
paul@213 208
            sequence = self.obj.get_value("SEQUENCE") or "0"
paul@213 209
            self.obj["SEQUENCE"] = [(str(int(sequence) + 1), {})]
paul@207 210
        self.update_dtstamp()
paul@207 211
paul@207 212
        self.send_message("REQUEST", get_address(self.organiser))
paul@207 213
paul@207 214
        return True
paul@207 215
paul@69 216
class Manager:
paul@69 217
paul@69 218
    "A simple manager application."
paul@69 219
paul@82 220
    def __init__(self, messenger=None):
paul@82 221
        self.messenger = messenger or Messenger()
paul@82 222
paul@212 223
        self.encoding = "utf-8"
paul@212 224
        self.env = CGIEnvironment(self.encoding)
paul@212 225
paul@69 226
        user = self.env.get_user()
paul@77 227
        self.user = user and get_uri(user) or None
paul@147 228
        self.preferences = None
paul@149 229
        self.locale = None
paul@121 230
        self.requests = None
paul@121 231
paul@69 232
        self.out = self.env.get_output()
paul@69 233
        self.page = markup.page()
paul@69 234
paul@77 235
        self.store = imip_store.FileStore()
paul@162 236
        self.objects = {}
paul@77 237
paul@77 238
        try:
paul@77 239
            self.publisher = imip_store.FilePublisher()
paul@77 240
        except OSError:
paul@77 241
            self.publisher = None
paul@77 242
paul@121 243
    def _get_uid(self, path_info):
paul@121 244
        return path_info.lstrip("/").split("/", 1)[0]
paul@121 245
paul@117 246
    def _get_object(self, uid):
paul@162 247
        if self.objects.has_key(uid):
paul@162 248
            return self.objects[uid]
paul@162 249
paul@117 250
        f = uid and self.store.get_event(self.user, uid) or None
paul@117 251
paul@117 252
        if not f:
paul@117 253
            return None
paul@117 254
paul@213 255
        fragment = parse_object(f, "utf-8")
paul@213 256
        obj = self.objects[uid] = fragment and Object(fragment)
paul@117 257
paul@121 258
        return obj
paul@121 259
paul@121 260
    def _get_requests(self):
paul@121 261
        if self.requests is None:
paul@121 262
            self.requests = self.store.get_requests(self.user)
paul@121 263
        return self.requests
paul@117 264
paul@162 265
    def _get_request_summary(self):
paul@162 266
        summary = []
paul@162 267
        for uid in self._get_requests():
paul@162 268
            obj = self._get_object(uid)
paul@162 269
            if obj:
paul@162 270
                summary.append((
paul@213 271
                    obj.get_value("DTSTART"),
paul@213 272
                    obj.get_value("DTEND"),
paul@162 273
                    uid
paul@162 274
                    ))
paul@162 275
        return summary
paul@162 276
paul@147 277
    # Preference methods.
paul@147 278
paul@149 279
    def get_user_locale(self):
paul@149 280
        if not self.locale:
paul@149 281
            self.locale = self.get_preferences().get("LANG", "C")
paul@149 282
        return self.locale
paul@147 283
paul@147 284
    def get_preferences(self):
paul@147 285
        if not self.preferences:
paul@147 286
            self.preferences = Preferences(self.user)
paul@147 287
        return self.preferences
paul@147 288
paul@162 289
    # Prettyprinting of dates and times.
paul@162 290
paul@149 291
    def format_date(self, dt, format):
paul@149 292
        return self._format_datetime(babel.dates.format_date, dt, format)
paul@149 293
paul@149 294
    def format_time(self, dt, format):
paul@149 295
        return self._format_datetime(babel.dates.format_time, dt, format)
paul@149 296
paul@149 297
    def format_datetime(self, dt, format):
paul@232 298
        return self._format_datetime(
paul@232 299
            isinstance(dt, datetime) and babel.dates.format_datetime or babel.dates.format_date,
paul@232 300
            dt, format)
paul@232 301
paul@232 302
    def format_end_datetime(self, dt, format):
paul@232 303
        if isinstance(dt, date):
paul@232 304
            dt = dt - timedelta(1)
paul@232 305
        return self.format_datetime(dt, format)
paul@149 306
paul@149 307
    def _format_datetime(self, fn, dt, format):
paul@149 308
        return fn(dt, format=format, locale=self.get_user_locale())
paul@149 309
paul@78 310
    # Data management methods.
paul@78 311
paul@78 312
    def remove_request(self, uid):
paul@105 313
        return self.store.dequeue_request(self.user, uid)
paul@78 314
paul@78 315
    # Presentation methods.
paul@78 316
paul@69 317
    def new_page(self, title):
paul@192 318
        self.page.init(title=title, charset=self.encoding, css=self.env.new_url("styles.css"))
paul@69 319
paul@69 320
    def status(self, code, message):
paul@123 321
        self.header("Status", "%s %s" % (code, message))
paul@123 322
paul@123 323
    def header(self, header, value):
paul@123 324
        print >>self.out, "%s: %s" % (header, value)
paul@69 325
paul@69 326
    def no_user(self):
paul@69 327
        self.status(403, "Forbidden")
paul@69 328
        self.new_page(title="Forbidden")
paul@69 329
        self.page.p("You are not logged in and thus cannot access scheduling requests.")
paul@69 330
paul@70 331
    def no_page(self):
paul@70 332
        self.status(404, "Not Found")
paul@70 333
        self.new_page(title="Not Found")
paul@70 334
        self.page.p("No page is provided at the given address.")
paul@70 335
paul@123 336
    def redirect(self, url):
paul@123 337
        self.status(302, "Redirect")
paul@123 338
        self.header("Location", url)
paul@123 339
        self.new_page(title="Redirect")
paul@123 340
        self.page.p("Redirecting to: %s" % url)
paul@123 341
paul@121 342
    # Request logic and page fragment methods.
paul@121 343
paul@202 344
    def handle_newevent(self):
paul@202 345
paul@207 346
        """
paul@207 347
        Handle any new event operation, creating a new event and redirecting to
paul@207 348
        the event page for further activity.
paul@207 349
        """
paul@202 350
paul@202 351
        # Handle a submitted form.
paul@202 352
paul@202 353
        args = self.env.get_args()
paul@202 354
paul@202 355
        if not args.has_key("newevent"):
paul@202 356
            return
paul@202 357
paul@202 358
        # Create a new event using the available information.
paul@202 359
paul@202 360
        slot = args.get("slot", [None])[0]
paul@202 361
        participants = args.get("participants", [])
paul@202 362
paul@202 363
        if not slot:
paul@202 364
            return
paul@202 365
paul@202 366
        start, end = slot.split("-")
paul@202 367
paul@202 368
        # Obtain the user's timezone.
paul@202 369
paul@202 370
        prefs = self.get_preferences()
paul@202 371
        tzid = prefs.get("TZID", "UTC")
paul@202 372
paul@202 373
        # Invent a unique identifier.
paul@202 374
paul@222 375
        utcnow = get_timestamp()
paul@202 376
        uid = "imip-agent-%s-%s" % (utcnow, get_address(self.user))
paul@202 377
paul@202 378
        # Create a calendar object and store it as a request.
paul@202 379
paul@202 380
        record = []
paul@202 381
        rwrite = record.append
paul@202 382
paul@202 383
        rwrite(("UID", {}, uid))
paul@202 384
        rwrite(("SUMMARY", {}, "New event at %s" % utcnow))
paul@202 385
        rwrite(("DTSTAMP", {}, utcnow))
paul@207 386
        rwrite(("DTSTART", {"VALUE" : "DATE-TIME", "TZID" : tzid}, start))
paul@207 387
        rwrite(("DTEND", {"VALUE" : "DATE-TIME", "TZID" : tzid}, end or
paul@202 388
            format_datetime(get_end_of_day(get_datetime(start, {"TZID" : tzid})))
paul@202 389
            ))
paul@202 390
        rwrite(("ORGANIZER", {}, self.user))
paul@202 391
paul@202 392
        for participant in participants:
paul@202 393
            if not participant:
paul@202 394
                continue
paul@202 395
            participant = get_uri(participant)
paul@202 396
            if participant != self.user:
paul@202 397
                rwrite(("ATTENDEE", {}, participant))
paul@202 398
paul@202 399
        obj = ("VEVENT", {}, record)
paul@202 400
paul@202 401
        self.store.set_event(self.user, uid, obj)
paul@202 402
        self.store.queue_request(self.user, uid)
paul@202 403
paul@202 404
        # Redirect to the object, where instead of attendee controls,
paul@202 405
        # there will be organiser controls.
paul@202 406
paul@202 407
        self.redirect(self.env.new_url(uid))
paul@202 408
paul@212 409
    def handle_request(self, uid, obj, queued):
paul@121 410
paul@155 411
        """
paul@212 412
        Handle actions involving the given 'uid' and 'obj' object, where
paul@155 413
        'queued' indicates that the object has not yet been handled.
paul@155 414
        """
paul@121 415
paul@121 416
        # Handle a submitted form.
paul@121 417
paul@121 418
        args = self.env.get_args()
paul@123 419
        handled = True
paul@121 420
paul@212 421
        # Update the object.
paul@212 422
paul@212 423
        if args.has_key("summary"):
paul@213 424
            obj["SUMMARY"] = [(args["summary"][0], {})]
paul@212 425
paul@212 426
        # Process any action.
paul@212 427
paul@121 428
        accept = args.has_key("accept")
paul@121 429
        decline = args.has_key("decline")
paul@207 430
        invite = args.has_key("invite")
paul@155 431
        update = not queued and args.has_key("update")
paul@121 432
paul@207 433
        if accept or decline or invite:
paul@121 434
paul@212 435
            handler = ManagerHandler(obj, self.user, self.messenger)
paul@121 436
paul@212 437
            # Process the object and remove it from the list of requests.
paul@121 438
paul@207 439
            if (accept or decline) and handler.process_received_request(accept, update) or \
paul@207 440
                invite and handler.process_created_request(update):
paul@121 441
paul@121 442
                self.remove_request(uid)
paul@121 443
paul@207 444
        elif args.has_key("discard"):
paul@121 445
paul@121 446
            # Remove the request from the list.
paul@121 447
paul@121 448
            self.remove_request(uid)
paul@121 449
paul@121 450
        else:
paul@123 451
            handled = False
paul@121 452
paul@212 453
        # Upon handling an action, redirect to the main page.
paul@212 454
paul@123 455
        if handled:
paul@123 456
            self.redirect(self.env.get_path())
paul@123 457
paul@123 458
        return handled
paul@121 459
paul@212 460
    def show_request_controls(self, obj, needs_action):
paul@155 461
paul@155 462
        """
paul@212 463
        Show form controls for a request concerning 'obj', indicating whether
paul@212 464
        action is needed if 'needs_action' is specified as a true value.
paul@155 465
        """
paul@155 466
paul@212 467
        page = self.page
paul@212 468
paul@213 469
        is_organiser = obj.get_value("ORGANIZER") == self.user
paul@207 470
paul@207 471
        if not is_organiser:
paul@213 472
            attendees = obj.get_value_map("ATTENDEE")
paul@207 473
            attendee_attr = attendees.get(self.user)
paul@121 474
paul@207 475
            if attendee_attr:
paul@207 476
                partstat = attendee_attr.get("PARTSTAT")
paul@207 477
                if partstat == "ACCEPTED":
paul@212 478
                    page.p("This request has been accepted.")
paul@207 479
                elif partstat == "DECLINED":
paul@212 480
                    page.p("This request has been declined.")
paul@207 481
                else:
paul@212 482
                    page.p("This request has not yet been dealt with.")
paul@121 483
paul@155 484
        if needs_action:
paul@212 485
            page.p("An action is required for this request:")
paul@155 486
        else:
paul@212 487
            page.p("This request can be updated as follows:")
paul@155 488
paul@212 489
        page.p()
paul@207 490
paul@207 491
        # Show appropriate options depending on the role of the user.
paul@207 492
paul@207 493
        if is_organiser:
paul@212 494
            page.input(name="invite", type="submit", value="Invite")
paul@207 495
        else:
paul@212 496
            page.input(name="accept", type="submit", value="Accept")
paul@212 497
            page.add(" ")
paul@212 498
            page.input(name="decline", type="submit", value="Decline")
paul@207 499
paul@212 500
        page.add(" ")
paul@212 501
        page.input(name="discard", type="submit", value="Discard")
paul@207 502
paul@207 503
        # Updated objects need to have details updated upon sending.
paul@207 504
paul@155 505
        if not needs_action:
paul@212 506
            page.input(name="update", type="hidden", value="true")
paul@207 507
paul@212 508
        page.p.close()
paul@121 509
paul@210 510
    object_labels = {
paul@210 511
        "SUMMARY"   : "Summary",
paul@210 512
        "DTSTART"   : "Start",
paul@210 513
        "DTEND"     : "End",
paul@210 514
        "ORGANIZER" : "Organiser",
paul@210 515
        "ATTENDEE"  : "Attendee",
paul@210 516
        }
paul@210 517
paul@212 518
    def show_object_on_page(self, uid, obj, needs_action):
paul@121 519
paul@121 520
        """
paul@121 521
        Show the calendar object with the given 'uid' and representation 'obj'
paul@121 522
        on the current page.
paul@121 523
        """
paul@121 524
paul@210 525
        page = self.page
paul@212 526
        page.form(method="POST")
paul@210 527
paul@154 528
        # Obtain the user's timezone.
paul@154 529
paul@154 530
        prefs = self.get_preferences()
paul@154 531
        tzid = prefs.get("TZID", "UTC")
paul@121 532
paul@121 533
        # Provide a summary of the object.
paul@121 534
paul@230 535
        page.table(class_="object", cellspacing=5, cellpadding=5)
paul@212 536
        page.thead()
paul@212 537
        page.tr()
paul@212 538
        page.th("Event", class_="mainheading", colspan=2)
paul@212 539
        page.tr.close()
paul@212 540
        page.thead.close()
paul@212 541
        page.tbody()
paul@121 542
paul@121 543
        for name in ["SUMMARY", "DTSTART", "DTEND", "ORGANIZER", "ATTENDEE"]:
paul@210 544
            page.tr()
paul@210 545
paul@210 546
            label = self.object_labels.get(name, name)
paul@210 547
paul@210 548
            # Handle datetimes specially.
paul@210 549
paul@147 550
            if name in ["DTSTART", "DTEND"]:
paul@213 551
                value, attr = obj.get_item(name)
paul@154 552
                tzid = attr.get("TZID", tzid)
paul@232 553
                value = (
paul@232 554
                    name == "DTSTART" and self.format_datetime or self.format_end_datetime
paul@232 555
                    )(to_timezone(get_datetime(value), tzid), "full")
paul@210 556
                page.th(label, class_="objectheading")
paul@210 557
                page.td(value)
paul@210 558
                page.tr.close()
paul@210 559
paul@212 560
            # Handle the summary specially.
paul@212 561
paul@212 562
            elif name == "SUMMARY":
paul@213 563
                value = obj.get_value(name)
paul@212 564
                page.th(label, class_="objectheading")
paul@212 565
                page.td()
paul@212 566
                page.input(name="summary", type="text", value=value, size=80)
paul@212 567
                page.td.close()
paul@212 568
                page.tr.close()
paul@212 569
paul@210 570
            # Handle potentially many values.
paul@210 571
paul@147 572
            else:
paul@213 573
                items = obj.get_items(name)
paul@210 574
                page.th(label, class_="objectheading", rowspan=len(items))
paul@210 575
paul@210 576
                first = True
paul@210 577
paul@210 578
                for value, attr in items:
paul@210 579
                    if not first:
paul@210 580
                        page.tr()
paul@210 581
                    else:
paul@210 582
                        first = False
paul@121 583
paul@210 584
                    page.td()
paul@210 585
                    page.add(value)
paul@210 586
paul@210 587
                    if name == "ATTENDEE":
paul@210 588
                        partstat = attr.get("PARTSTAT")
paul@210 589
                        if partstat:
paul@210 590
                            page.add(" (%s)" % partstat)
paul@210 591
paul@210 592
                    page.td.close()
paul@210 593
                    page.tr.close()
paul@210 594
paul@212 595
        page.tbody.close()
paul@210 596
        page.table.close()
paul@121 597
paul@213 598
        dtstart = format_datetime(obj.get_utc_datetime("DTSTART"))
paul@213 599
        dtend = format_datetime(obj.get_utc_datetime("DTEND"))
paul@121 600
paul@121 601
        # Indicate whether there are conflicting events.
paul@121 602
paul@121 603
        freebusy = self.store.get_freebusy(self.user)
paul@121 604
paul@121 605
        if freebusy:
paul@121 606
paul@121 607
            # Obtain any time zone details from the suggested event.
paul@121 608
paul@213 609
            _dtstart, attr = obj.get_item("DTSTART")
paul@154 610
            tzid = attr.get("TZID", tzid)
paul@121 611
paul@121 612
            # Show any conflicts.
paul@121 613
paul@121 614
            for t in have_conflict(freebusy, [(dtstart, dtend)], True):
paul@121 615
                start, end, found_uid = t[:3]
paul@154 616
paul@154 617
                # Provide details of any conflicting event.
paul@154 618
paul@121 619
                if uid != found_uid:
paul@149 620
                    start = self.format_datetime(to_timezone(get_datetime(start), tzid), "full")
paul@149 621
                    end = self.format_datetime(to_timezone(get_datetime(end), tzid), "full")
paul@210 622
                    page.p("Event conflicts with another from %s to %s: " % (start, end))
paul@154 623
paul@154 624
                    # Show the event summary for the conflicting event.
paul@154 625
paul@154 626
                    found_obj = self._get_object(found_uid)
paul@154 627
                    if found_obj:
paul@213 628
                        page.a(found_obj.get_value("SUMMARY"), href=self.env.new_url(found_uid))
paul@121 629
paul@212 630
        self.show_request_controls(obj, needs_action)
paul@212 631
        page.form.close()
paul@212 632
paul@121 633
    def show_requests_on_page(self):
paul@69 634
paul@69 635
        "Show requests for the current user."
paul@69 636
paul@69 637
        # NOTE: This list could be more informative, but it is envisaged that
paul@69 638
        # NOTE: the requests would be visited directly anyway.
paul@69 639
paul@121 640
        requests = self._get_requests()
paul@70 641
paul@185 642
        self.page.div(id="pending-requests")
paul@185 643
paul@80 644
        if requests:
paul@114 645
            self.page.p("Pending requests:")
paul@114 646
paul@80 647
            self.page.ul()
paul@69 648
paul@80 649
            for request in requests:
paul@165 650
                obj = self._get_object(request)
paul@165 651
                if obj:
paul@165 652
                    self.page.li()
paul@213 653
                    self.page.a(obj.get_value("SUMMARY"), href="#request-%s" % request)
paul@165 654
                    self.page.li.close()
paul@80 655
paul@80 656
            self.page.ul.close()
paul@80 657
paul@80 658
        else:
paul@80 659
            self.page.p("There are no pending requests.")
paul@69 660
paul@185 661
        self.page.div.close()
paul@185 662
paul@185 663
    def show_participants_on_page(self):
paul@185 664
paul@185 665
        "Show participants for scheduling purposes."
paul@185 666
paul@185 667
        args = self.env.get_args()
paul@185 668
        participants = args.get("participants", [])
paul@185 669
paul@185 670
        try:
paul@185 671
            for name, value in args.items():
paul@185 672
                if name.startswith("remove-participant-"):
paul@185 673
                    i = int(name[len("remove-participant-"):])
paul@185 674
                    del participants[i]
paul@185 675
                    break
paul@185 676
        except ValueError:
paul@185 677
            pass
paul@185 678
paul@185 679
        # Trim empty participants.
paul@185 680
paul@185 681
        while participants and not participants[-1].strip():
paul@185 682
            participants.pop()
paul@185 683
paul@185 684
        # Show any specified participants together with controls to remove and
paul@185 685
        # add participants.
paul@185 686
paul@185 687
        self.page.div(id="participants")
paul@185 688
paul@185 689
        self.page.p("Participants for scheduling:")
paul@185 690
paul@185 691
        for i, participant in enumerate(participants):
paul@185 692
            self.page.p()
paul@185 693
            self.page.input(name="participants", type="text", value=participant)
paul@185 694
            self.page.input(name="remove-participant-%d" % i, type="submit", value="Remove")
paul@185 695
            self.page.p.close()
paul@185 696
paul@185 697
        self.page.p()
paul@185 698
        self.page.input(name="participants", type="text")
paul@185 699
        self.page.input(name="add-participant", type="submit", value="Add")
paul@185 700
        self.page.p.close()
paul@185 701
paul@185 702
        self.page.div.close()
paul@185 703
paul@185 704
        return participants
paul@185 705
paul@121 706
    # Full page output methods.
paul@70 707
paul@121 708
    def show_object(self, path_info):
paul@70 709
paul@121 710
        "Show an object request using the given 'path_info' for the current user."
paul@70 711
paul@121 712
        uid = self._get_uid(path_info)
paul@121 713
        obj = self._get_object(uid)
paul@121 714
paul@121 715
        if not obj:
paul@70 716
            return False
paul@70 717
paul@123 718
        is_request = uid in self._get_requests()
paul@155 719
        handled = self.handle_request(uid, obj, is_request)
paul@77 720
paul@123 721
        if handled:
paul@123 722
            return True
paul@73 723
paul@123 724
        self.new_page(title="Event")
paul@212 725
        self.show_object_on_page(uid, obj, is_request and not handled)
paul@73 726
paul@70 727
        return True
paul@70 728
paul@114 729
    def show_calendar(self):
paul@114 730
paul@114 731
        "Show the calendar for the current user."
paul@114 732
paul@202 733
        handled = self.handle_newevent()
paul@202 734
paul@114 735
        self.new_page(title="Calendar")
paul@162 736
        page = self.page
paul@162 737
paul@196 738
        # Form controls are used in various places on the calendar page.
paul@196 739
paul@196 740
        page.form(method="POST")
paul@196 741
paul@121 742
        self.show_requests_on_page()
paul@185 743
        participants = self.show_participants_on_page()
paul@114 744
paul@196 745
        # Show a button for scheduling a new event.
paul@196 746
paul@230 747
        page.p(class_="controls")
paul@196 748
        page.input(name="newevent", type="submit", value="New event", id="newevent")
paul@196 749
        page.p.close()
paul@196 750
paul@231 751
        # Show controls for hiding empty and busy slots.
paul@203 752
        # The positioning of the control, paragraph and table are important here.
paul@203 753
paul@203 754
        page.input(name="hideslots", type="checkbox", value="hide", id="hideslots")
paul@231 755
        page.input(name="hidebusy", type="checkbox", value="hide", id="hidebusy")
paul@203 756
paul@230 757
        page.p(class_="controls")
paul@231 758
        page.label("Hide busy time periods", for_="hidebusy", class_="enable")
paul@231 759
        page.label("Show busy time periods", for_="hidebusy", class_="disable")
paul@203 760
        page.label("Hide unused time periods", for_="hideslots", class_="enable")
paul@203 761
        page.label("Show unused time periods", for_="hideslots", class_="disable")
paul@203 762
        page.p.close()
paul@203 763
paul@114 764
        freebusy = self.store.get_freebusy(self.user)
paul@114 765
paul@114 766
        if not freebusy:
paul@114 767
            page.p("No events scheduled.")
paul@114 768
            return
paul@114 769
paul@154 770
        # Obtain the user's timezone.
paul@147 771
paul@147 772
        prefs = self.get_preferences()
paul@153 773
        tzid = prefs.get("TZID", "UTC")
paul@147 774
paul@114 775
        # Day view: start at the earliest known day and produce days until the
paul@114 776
        # latest known day, perhaps with expandable sections of empty days.
paul@114 777
paul@114 778
        # Month view: start at the earliest known month and produce months until
paul@114 779
        # the latest known month, perhaps with expandable sections of empty
paul@114 780
        # months.
paul@114 781
paul@114 782
        # Details of users to invite to new events could be superimposed on the
paul@114 783
        # calendar.
paul@114 784
paul@185 785
        # Requests are listed and linked to their tentative positions in the
paul@185 786
        # calendar. Other participants are also shown.
paul@185 787
paul@185 788
        request_summary = self._get_request_summary()
paul@185 789
paul@185 790
        period_groups = [request_summary, freebusy]
paul@185 791
        period_group_types = ["request", "freebusy"]
paul@185 792
        period_group_sources = ["Pending requests", "Your schedule"]
paul@185 793
paul@187 794
        for i, participant in enumerate(participants):
paul@185 795
            period_groups.append(self.store.get_freebusy_for_other(self.user, get_uri(participant)))
paul@187 796
            period_group_types.append("freebusy-part%d" % i)
paul@185 797
            period_group_sources.append(participant)
paul@114 798
paul@162 799
        groups = []
paul@162 800
        group_columns = []
paul@185 801
        group_types = period_group_types
paul@185 802
        group_sources = period_group_sources
paul@162 803
        all_points = set()
paul@162 804
paul@162 805
        # Obtain time point information for each group of periods.
paul@162 806
paul@185 807
        for periods in period_groups:
paul@162 808
            periods = convert_periods(periods, tzid)
paul@162 809
paul@162 810
            # Get the time scale with start and end points.
paul@162 811
paul@162 812
            scale = get_scale(periods)
paul@162 813
paul@162 814
            # Get the time slots for the periods.
paul@162 815
paul@162 816
            slots = get_slots(scale)
paul@162 817
paul@162 818
            # Add start of day time points for multi-day periods.
paul@162 819
paul@162 820
            add_day_start_points(slots)
paul@162 821
paul@162 822
            # Record the slots and all time points employed.
paul@162 823
paul@162 824
            groups.append(slots)
paul@201 825
            all_points.update([point for point, active in slots])
paul@162 826
paul@162 827
        # Partition the groups into days.
paul@162 828
paul@162 829
        days = {}
paul@162 830
        partitioned_groups = []
paul@171 831
        partitioned_group_types = []
paul@185 832
        partitioned_group_sources = []
paul@162 833
paul@185 834
        for slots, group_type, group_source in zip(groups, group_types, group_sources):
paul@162 835
paul@162 836
            # Propagate time points to all groups of time slots.
paul@162 837
paul@162 838
            add_slots(slots, all_points)
paul@162 839
paul@162 840
            # Count the number of columns employed by the group.
paul@162 841
paul@162 842
            columns = 0
paul@162 843
paul@162 844
            # Partition the time slots by day.
paul@162 845
paul@162 846
            partitioned = {}
paul@162 847
paul@162 848
            for day, day_slots in partition_by_day(slots).items():
paul@201 849
                intervals = []
paul@201 850
                last = None
paul@201 851
paul@201 852
                for point, active in day_slots:
paul@201 853
                    columns = max(columns, len(active))
paul@201 854
                    if last:
paul@201 855
                        intervals.append((last, point))
paul@201 856
                    last = point
paul@201 857
paul@201 858
                if last:
paul@201 859
                    intervals.append((last, None))
paul@162 860
paul@162 861
                if not days.has_key(day):
paul@162 862
                    days[day] = set()
paul@162 863
paul@162 864
                # Convert each partition to a mapping from points to active
paul@162 865
                # periods.
paul@162 866
paul@201 867
                partitioned[day] = dict(day_slots)
paul@201 868
paul@201 869
                # Record the divisions or intervals within each day.
paul@201 870
paul@201 871
                days[day].update(intervals)
paul@162 872
paul@194 873
            if group_type != "request" or columns:
paul@194 874
                group_columns.append(columns)
paul@194 875
                partitioned_groups.append(partitioned)
paul@194 876
                partitioned_group_types.append(group_type)
paul@194 877
                partitioned_group_sources.append(group_source)
paul@114 878
paul@230 879
        page.table(cellspacing=5, cellpadding=5, class_="calendar")
paul@188 880
        self.show_calendar_participant_headings(partitioned_group_types, partitioned_group_sources, group_columns)
paul@171 881
        self.show_calendar_days(days, partitioned_groups, partitioned_group_types, group_columns)
paul@162 882
        page.table.close()
paul@114 883
paul@196 884
        # End the form region.
paul@196 885
paul@196 886
        page.form.close()
paul@196 887
paul@188 888
    def show_calendar_participant_headings(self, group_types, group_sources, group_columns):
paul@186 889
paul@186 890
        """
paul@186 891
        Show headings for the participants and other scheduling contributors,
paul@188 892
        defined by 'group_types', 'group_sources' and 'group_columns'.
paul@186 893
        """
paul@186 894
paul@185 895
        page = self.page
paul@185 896
paul@188 897
        page.colgroup(span=1, id="columns-timeslot")
paul@186 898
paul@188 899
        for group_type, columns in zip(group_types, group_columns):
paul@191 900
            page.colgroup(span=max(columns, 1), id="columns-%s" % group_type)
paul@186 901
paul@185 902
        page.thead()
paul@185 903
        page.tr()
paul@185 904
        page.th("", class_="emptyheading")
paul@185 905
paul@193 906
        for group_type, source, columns in zip(group_types, group_sources, group_columns):
paul@193 907
            page.th(source,
paul@193 908
                class_=(group_type == "request" and "requestheading" or "participantheading"),
paul@193 909
                colspan=max(columns, 1))
paul@185 910
paul@185 911
        page.tr.close()
paul@185 912
        page.thead.close()
paul@185 913
paul@171 914
    def show_calendar_days(self, days, partitioned_groups, partitioned_group_types, group_columns):
paul@186 915
paul@186 916
        """
paul@186 917
        Show calendar days, defined by a collection of 'days', the contributing
paul@186 918
        period information as 'partitioned_groups' (partitioned by day), the
paul@186 919
        'partitioned_group_types' indicating the kind of contribution involved,
paul@186 920
        and the 'group_columns' defining the number of columns in each group.
paul@186 921
        """
paul@186 922
paul@162 923
        page = self.page
paul@162 924
paul@191 925
        # Determine the number of columns required. Where participants provide
paul@191 926
        # no columns for events, one still needs to be provided for the
paul@191 927
        # participant itself.
paul@147 928
paul@191 929
        all_columns = sum([max(columns, 1) for columns in group_columns])
paul@191 930
paul@191 931
        # Determine the days providing time slots.
paul@191 932
paul@162 933
        all_days = days.items()
paul@162 934
        all_days.sort()
paul@162 935
paul@162 936
        # Produce a heading and time points for each day.
paul@162 937
paul@201 938
        for day, intervals in all_days:
paul@186 939
            page.thead()
paul@114 940
            page.tr()
paul@171 941
            page.th(class_="dayheading", colspan=all_columns+1)
paul@153 942
            page.add(self.format_date(day, "full"))
paul@114 943
            page.th.close()
paul@153 944
            page.tr.close()
paul@186 945
            page.thead.close()
paul@114 946
paul@162 947
            groups_for_day = [partitioned.get(day) for partitioned in partitioned_groups]
paul@162 948
paul@186 949
            page.tbody()
paul@201 950
            self.show_calendar_points(intervals, groups_for_day, partitioned_group_types, group_columns)
paul@186 951
            page.tbody.close()
paul@185 952
paul@201 953
    def show_calendar_points(self, intervals, groups, group_types, group_columns):
paul@186 954
paul@186 955
        """
paul@201 956
        Show the time 'intervals' along with period information from the given
paul@186 957
        'groups', having the indicated 'group_types', each with the number of
paul@186 958
        columns given by 'group_columns'.
paul@186 959
        """
paul@186 960
paul@162 961
        page = self.page
paul@162 962
paul@203 963
        # Produce a row for each interval.
paul@162 964
paul@201 965
        intervals = list(intervals)
paul@201 966
        intervals.sort()
paul@162 967
paul@201 968
        for point, endpoint in intervals:
paul@162 969
            continuation = point == get_start_of_day(point)
paul@153 970
paul@203 971
            # Some rows contain no period details and are marked as such.
paul@203 972
paul@203 973
            have_active = reduce(lambda x, y: x or y, [slots.get(point) for slots in groups], None)
paul@203 974
paul@203 975
            css = " ".join(
paul@203 976
                ["slot"] +
paul@231 977
                (have_active and ["busy"] or ["empty"]) +
paul@203 978
                (continuation and ["daystart"] or [])
paul@203 979
                )
paul@203 980
paul@203 981
            page.tr(class_=css)
paul@162 982
            page.th(class_="timeslot")
paul@201 983
            self._time_point(point, endpoint)
paul@162 984
            page.th.close()
paul@162 985
paul@162 986
            # Obtain slots for the time point from each group.
paul@162 987
paul@171 988
            for columns, slots, group_type in zip(group_columns, groups, group_types):
paul@162 989
                active = slots and slots.get(point)
paul@162 990
paul@191 991
                # Where no periods exist for the given time interval, generate
paul@191 992
                # an empty cell. Where a participant provides no periods at all,
paul@191 993
                # the colspan is adjusted to be 1, not 0.
paul@191 994
paul@162 995
                if not active:
paul@196 996
                    page.td(class_="empty container", colspan=max(columns, 1))
paul@201 997
                    self._empty_slot(point, endpoint)
paul@196 998
                    page.td.close()
paul@162 999
                    continue
paul@162 1000
paul@162 1001
                slots = slots.items()
paul@162 1002
                slots.sort()
paul@162 1003
                spans = get_spans(slots)
paul@162 1004
paul@162 1005
                # Show a column for each active period.
paul@117 1006
paul@153 1007
                for t in active:
paul@185 1008
                    if t and len(t) >= 2:
paul@185 1009
                        start, end, uid, key = get_freebusy_details(t)
paul@185 1010
                        span = spans[key]
paul@171 1011
paul@171 1012
                        # Produce a table cell only at the start of the period
paul@171 1013
                        # or when continued at the start of a day.
paul@171 1014
paul@153 1015
                        if point == start or continuation:
paul@153 1016
paul@195 1017
                            has_continued = continuation and point != start
paul@195 1018
                            will_continue = not ends_on_same_day(point, end)
paul@195 1019
                            css = " ".join(
paul@195 1020
                                ["event"] +
paul@195 1021
                                (has_continued and ["continued"] or []) +
paul@195 1022
                                (will_continue and ["continues"] or [])
paul@195 1023
                                )
paul@195 1024
paul@189 1025
                            # Only anchor the first cell of events.
paul@189 1026
paul@189 1027
                            if point == start:
paul@195 1028
                                page.td(class_=css, rowspan=span, id="%s-%s" % (group_type, uid))
paul@189 1029
                            else:
paul@195 1030
                                page.td(class_=css, rowspan=span)
paul@171 1031
paul@153 1032
                            obj = self._get_object(uid)
paul@185 1033
paul@185 1034
                            if not obj:
paul@185 1035
                                page.span("")
paul@185 1036
                            else:
paul@213 1037
                                summary = obj.get_value("SUMMARY")
paul@171 1038
paul@171 1039
                                # Only link to events if they are not being
paul@171 1040
                                # updated by requests.
paul@171 1041
paul@171 1042
                                if uid in self._get_requests() and group_type != "request":
paul@189 1043
                                    page.span(summary)
paul@164 1044
                                else:
paul@171 1045
                                    href = "%s/%s" % (self.env.get_url().rstrip("/"), uid)
paul@189 1046
                                    page.a(summary, href=href)
paul@171 1047
paul@153 1048
                            page.td.close()
paul@153 1049
                    else:
paul@196 1050
                        page.td(class_="empty container")
paul@201 1051
                        self._empty_slot(point, endpoint)
paul@196 1052
                        page.td.close()
paul@114 1053
paul@166 1054
                # Pad with empty columns.
paul@166 1055
paul@166 1056
                i = columns - len(active)
paul@166 1057
                while i > 0:
paul@166 1058
                    i -= 1
paul@196 1059
                    page.td(class_="empty container")
paul@201 1060
                    self._empty_slot(point, endpoint)
paul@196 1061
                    page.td.close()
paul@166 1062
paul@162 1063
            page.tr.close()
paul@114 1064
paul@201 1065
    def _time_point(self, point, endpoint):
paul@201 1066
        page = self.page
paul@201 1067
        value, identifier = self._slot_value_and_identifier(point, endpoint)
paul@202 1068
        slot = self.env.get_args().get("slot", [None])[0]
paul@202 1069
        if slot == value:
paul@202 1070
            page.input(name="slot", type="radio", value=value, id=identifier, class_="newevent", checked="checked")
paul@202 1071
        else:
paul@202 1072
            page.input(name="slot", type="radio", value=value, id=identifier, class_="newevent")
paul@201 1073
        page.label(self.format_time(point, "long"), class_="timepoint", for_=identifier)
paul@201 1074
paul@201 1075
    def _empty_slot(self, point, endpoint):
paul@197 1076
        page = self.page
paul@201 1077
        value, identifier = self._slot_value_and_identifier(point, endpoint)
paul@201 1078
        page.label("Make a new event in this period", class_="newevent popup", for_=identifier)
paul@196 1079
paul@201 1080
    def _slot_value_and_identifier(self, point, endpoint):
paul@202 1081
        value = "%s-%s" % (format_datetime(point), endpoint and format_datetime(endpoint) or "")
paul@201 1082
        identifier = "slot-%s" % value
paul@201 1083
        return value, identifier
paul@196 1084
paul@69 1085
    def select_action(self):
paul@69 1086
paul@69 1087
        "Select the desired action and show the result."
paul@69 1088
paul@121 1089
        path_info = self.env.get_path_info().strip("/")
paul@121 1090
paul@69 1091
        if not path_info:
paul@114 1092
            self.show_calendar()
paul@121 1093
        elif self.show_object(path_info):
paul@70 1094
            pass
paul@70 1095
        else:
paul@70 1096
            self.no_page()
paul@69 1097
paul@82 1098
    def __call__(self):
paul@69 1099
paul@69 1100
        "Interpret a request and show an appropriate response."
paul@69 1101
paul@69 1102
        if not self.user:
paul@69 1103
            self.no_user()
paul@69 1104
        else:
paul@69 1105
            self.select_action()
paul@69 1106
paul@70 1107
        # Write the headers and actual content.
paul@70 1108
paul@69 1109
        print >>self.out, "Content-Type: text/html; charset=%s" % self.encoding
paul@69 1110
        print >>self.out
paul@69 1111
        self.out.write(unicode(self.page).encode(self.encoding))
paul@69 1112
paul@69 1113
if __name__ == "__main__":
paul@128 1114
    Manager()()
paul@69 1115
paul@69 1116
# vim: tabstop=4 expandtab shiftwidth=4