/usr/share/pyshared/schooltool/calendar/interfaces.py is in python-schooltool 1:2.1.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 | #
# SchoolTool - common information systems platform for school administration
# Copyright (c) 2005 Shuttleworth Foundation
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
"""
Interface definitions for SchoolTool calendars.
There are two interfaces for calendars: `ICalendar` for read-only calendars,
and `IEditCalendar` for read-write calendars.
Semantically calendars are unordered sets of events.
"""
import zope.schema
from zope.interface import Interface, Attribute
from zope.location.interfaces import ILocation, IContained
Unchanged = object() # marker
class ICalendar(Interface):
"""Calendar.
A calendar is a set of calendar events (see ICalendarEvent). Recurring
events are listed only once.
"""
def __len__():
"""Return the number of events in this calendar."""
def __iter__():
"""Return an iterator over all events in this calendar.
The order of events is not defined.
"""
def find(unique_id):
"""Return an event with the given unique id.
Raises a KeyError if there is no event with this id.
"""
def expand(first, last):
"""Return an iterator over all expanded events in a given time period.
"Expanding" here refers to expanding recurring events, that is,
creating objects for all occurrences of recurring events. If a
recurring event has occurreces that overlap the specified time
interval, every such occurrence is represented as a new calendar event
with the `dtstart` attribute replaced with the date and time of that
occurrence. These events provide IExpandedCalendarEvent and have an
additional attribute which points to the original event. Note that
only recurring events are replaced by proxies, nonrecurring events
are returned as-is.
`first` and `last` are datetime.datetimes and define a half-open
time interval.
The order of returned events is not defined.
"""
class IEditCalendar(ICalendar):
"""Editable calendar.
Calendar events are read-only, so to change an event you need to remove
the old event, and add a replacement event in the calendar.
"""
def clear():
"""Remove all events."""
def addEvent(event):
"""Add an event to the calendar.
Raises ValueError if an event with the same unique_id already exists
in the calendar.
Returns the newly added event (which may be a copy of the argument,
e.g. if the calendar needs its events to be instances of a particular
class).
It is perhaps not a good idea to add calendar events that have no
occurrences into calendars (see ICalendarEvent.hasOccurrences), as they
will be invisible in date-based of calendar views.
Do not call addEvent while iterating over the calendar.
"""
def removeEvent(event):
"""Remove event from the calendar.
Raises ValueError if event is not present in the calendar.
Do not call removeEvent while iterating over the calendar.
"""
class IRecurrenceRule(Interface):
"""Base interface of the recurrence rules.
Recurrence rules are stored as attributes of ICalendarEvent. They
are also immutable and comparable. To modify the recurrence
rule of an event, you need to create a new recurrence rule, and a new
event:
replacement_rule = event.recurrence.replace(count=3, until=None)
replacement_event = event.replace(recurrence=replacement_rule)
calendar.removeEvent(event)
calendar.addEvent(replacement_event)
"""
interval = zope.schema.Int(
title=u"Interval",
min=1,
description=u"""
Interval of recurrence (a positive integer).
For example, to indicate that an event occurs every second day,
you would create a DailyRecurrenceRule witl interval equal to 2.
""")
count = zope.schema.Int(
title=u"Count",
required=False,
description=u"""
Number of times the event is repeated.
Can be None or an integer value. If count is not None then
until must be None. If both count and until are None the
event repeats forever.
""")
until = zope.schema.Date(
title=u"Until",
required=False,
description=u"""
The date of the last recurrence of the event.
Can be None or a datetime.date instance. If until is not None
then count must be None. If both count and until are None the
event repeats forever.
""")
exceptions = zope.schema.List(
title=u"Exceptions",
value_type=zope.schema.Date(),
description=u"""
A list of days when this event does not occur.
Values in this list must be instances of datetime.date.
""")
def replace(interval=Unchanged, count=Unchanged, until=Unchanged,
exceptions=Unchanged):
"""Return a copy of this recurrence rule with new specified fields."""
def __eq__(other):
"""See if self == other."""
def __ne__(other):
"""See if self != other."""
def apply(event, startdate=None, enddate=None):
"""Apply this rule to an event.
This is a generator that returns the dates on which the event should
recur. Be careful when iterating over these dates -- rules that do not
have either 'until' or 'count' attributes will go on forever.
The optional enddate attribute can be used to set a range on the dates
generated by this function (inclusive).
"""
def iCalRepresentation(dtstart):
"""Return the rule in iCalendar format.
Returns a list of strings, each corresponding to a line of iCalendar.
The first line is for the recurrence rule itself, the following ones
(if any) describe exception dates.
dtstart is a datetime representing the date that the recurring
event starts on.
"""
class IDailyRecurrenceRule(IRecurrenceRule):
"""Daily recurrence."""
class IYearlyRecurrenceRule(IRecurrenceRule):
"""Yearly recurrence."""
class IWeeklyRecurrenceRule(IRecurrenceRule):
"""Weekly recurrence."""
weekdays = zope.schema.Set(
title=u"Weekdays",
value_type=zope.schema.Int(min=0, max=6),
description=u"""
A set of weekdays when this event occurs.
Weekdays are represented as integers from 0 (Monday) to 6 (Sunday).
This is what the `calendar` and `datetime` modules use.
The event repeats on the weekday of the first occurence even
if that weekday is not in this set.
""")
def replace(interval=Unchanged, count=Unchanged, until=Unchanged,
exceptions=Unchanged, weekdays=Unchanged):
"""Return a copy of this recurrence rule with new specified fields."""
class IMonthlyRecurrenceRule(IRecurrenceRule):
"""Monthly recurrence."""
monthly = zope.schema.Choice(
title=u"Type",
values=('monthday', 'weekday', 'lastweekday'),
description=u"""
Specification of a monthly occurence.
Can be one of three values: 'monthday', 'weekday', 'lastweekday'.
'monthday' specifies that the event recurs on the same day of month
(e.g., 25th day of a month).
'weekday' specifies that the event recurs on the same week
within a month on the same weekday, indexed from the
first (e.g. 3rd Friday of a month).
'lastweekday' specifies that the event recurs on the same week
within a month on the same weekday, indexed from the
end of month (e.g. 2nd last Friday of a month).
""")
def replace(interval=Unchanged, count=Unchanged, until=Unchanged,
exceptions=Unchanged, monthly=Unchanged):
"""Return a copy of this recurrence rule with new specified fields."""
class ICalendarEvent(Interface):
"""A calendar event.
Calendar events are comparable.
Events are compared in chronological order, so lists of events can be
sorted. If two events start at the same time, they are ordered according
to their titles.
While `unique_id` is a globally unique ID of a calendar event, you can
have several calendar event objects with the same value of `unique_id`,
and they will not be equal if any their attributes are different.
Semantically these objects are different versions of the same calendar
event.
"""
unique_id = zope.schema.TextLine(
title=u"UID",
description=u"""
A globally unique id for this calendar event.
iCalendar (RFC 2445) recommeds using the RFC 822 addr-spec syntax
for unique IDs. Put the current timestamp and a random number
on the left of the @ sign, and put the hostname on the right.
""")
dtstart = zope.schema.Datetime(
title=u"Start",
description=u"""
Date and time when the event starts.
""")
duration = zope.schema.Timedelta(
title=u"Duration",
description=u"""
The duration of the event (datetime.timedelta).
You can compute the event end date/time by adding duration to dtstart.
""")
title = zope.schema.TextLine(
title=u"Title",
description=u"""The title of the event.""")
description = zope.schema.Text(
title=u"Description",
required=False,
description=u"""A description of the event.""")
location = zope.schema.TextLine(
title=u"Location",
required=False,
description=u"""The location where this event takes place.""")
recurrence = zope.schema.Object(
title=u"Recurrence",
schema=IRecurrenceRule,
required=False,
description=u"""
The recurrence rule, if this is a recurring event, otherwise None.
""")
allday = zope.schema.Bool(
title=u"All Day Event",
required=False)
def __eq__(other):
"""See if self == other."""
def __ne__(other):
"""See if self != other."""
def __lt__(other):
"""See if self < other."""
def __gt__(other):
"""See if self > other."""
def __le__(other):
"""See if self <= other."""
def __ge__(other):
"""See if self >= other."""
def hasOccurrences():
"""Does the event have any occurrences?
Normally all events have at least one occurrence. However if you have
a repeating event that repeats a finite number of times, and all those
repetitions are listed as exceptions, then hasOccurrences() will return
False. There are other corner cases as well (e.g. a recurring event
with until date that is earlier than dtstart).
"""
def expand(first, last):
"""Return an iterator over all expanded events in a given time period.
"Expanding" here refers to expanding recurring events, that
is, creating objects for all occurrences of this event if it
is a recurring event. If a recurring event has occurreces
that overlap the specified time interval, every such
occurrence is represented as a new calendar event with the
`dtstart` attribute replaced with the date and time of that
occurrence. These events provide IExpandedCalendarEvent and
have an additional attribute which points to the original
event. Note that only recurring events are replaced by
proxies, nonrecurring events are returned as-is.
`first` and `last` are datetime.datetimes and define a half-open
time interval.
The order of returned events is not defined.
"""
class IExpandedCalendarEvent(ICalendarEvent):
"""A single occurrence of a recurring calendar event.
The original event is stored in the `original` attribute. The `dtstart`
attribute contains the date and time of this occurrence and may differ
from the `dtstart` attribute of the original event. All other attributes
are the same.
"""
dtstart = zope.schema.Datetime(
title=u"Start",
description=u"""
Date and time when this occurrence of the event starts.
""")
original = zope.schema.Object(
title=u"Original",
schema=ICalendarEvent,
description=u"""
The recurring event that generated this occurrence.
""")
class IWriteCalendar(Interface):
def write(data, charset='UTF-8'):
"""Update the calendar data
"""
class ISchoolToolCalendar(IEditCalendar, ILocation):
"""A SchoolTool calendar.
Calendars stored within all provide ISchoolToolCalendarEvent.
"""
title = zope.schema.TextLine(
title=u"Title",
description=u"Title of the calendar.")
class ISchoolToolCalendarEvent(ICalendarEvent, IContained):
"""An event that is contained in a SchoolTool calendar."""
resources = Attribute(
"""Resources that are booked by this event""")
owner = Attribute(
"""Object which this event belongs to.""")
def bookResource(resource):
"""Book a resource."""
def unbookResource(resource):
"""Book a resource."""
class IHaveCalendar(Interface):
"""Marker interface for components that can have calendars.
Components providing this interface are adaptable to
``ISchoolToolCalendar``.
"""
|