402 lines
12 KiB
Python
402 lines
12 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# This file is part of Radicale Server - Calendar Server
|
|
# Copyright © 2008-2011 Guillaume Ayoub
|
|
# Copyright © 2008 Nicolas Kandel
|
|
# Copyright © 2008 Pascal Halter
|
|
#
|
|
# This library 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 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This library 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 Radicale. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
"""
|
|
Radicale calendar classes.
|
|
|
|
Define the main classes of a calendar as seen from the server.
|
|
|
|
"""
|
|
|
|
import codecs
|
|
from contextlib import contextmanager
|
|
import json
|
|
import os
|
|
import posixpath
|
|
import time
|
|
|
|
from radicale import config
|
|
|
|
|
|
FOLDER = os.path.expanduser(config.get("storage", "folder"))
|
|
|
|
|
|
# This function overrides the builtin ``open`` function for this module
|
|
# pylint: disable=W0622
|
|
def open(path, mode="r"):
|
|
"""Open file at ``path`` with ``mode``, automagically managing encoding."""
|
|
return codecs.open(path, mode, config.get("encoding", "stock"))
|
|
# pylint: enable=W0622
|
|
|
|
|
|
def serialize(headers=(), items=()):
|
|
"""Return an iCal text corresponding to given ``headers`` and ``items``."""
|
|
lines = ["BEGIN:VCALENDAR"]
|
|
for part in (headers, items):
|
|
if part:
|
|
lines.append("\n".join(item.text for item in part))
|
|
lines.append("END:VCALENDAR\n")
|
|
return "\n".join(lines)
|
|
|
|
|
|
def unfold(text):
|
|
"""Unfold multi-lines attributes.
|
|
|
|
Read rfc5545-3.1 for info.
|
|
|
|
"""
|
|
lines = []
|
|
for line in text.splitlines():
|
|
if lines and (line.startswith(" ") or line.startswith("\t")):
|
|
lines[-1] += line[1:]
|
|
else:
|
|
lines.append(line)
|
|
return lines
|
|
|
|
|
|
class Item(object):
|
|
"""Internal iCal item."""
|
|
def __init__(self, text, name=None):
|
|
"""Initialize object from ``text`` and different ``kwargs``."""
|
|
self.text = text
|
|
self._name = name
|
|
|
|
# We must synchronize the name in the text and in the object.
|
|
# An item must have a name, determined in order by:
|
|
#
|
|
# - the ``name`` parameter
|
|
# - the ``X-RADICALE-NAME`` iCal property (for Events, Todos, Journals)
|
|
# - the ``UID`` iCal property (for Events, Todos, Journals)
|
|
# - the ``TZID`` iCal property (for Timezones)
|
|
if not self._name:
|
|
for line in unfold(self.text):
|
|
if line.startswith("X-RADICALE-NAME:"):
|
|
self._name = line.replace("X-RADICALE-NAME:", "").strip()
|
|
break
|
|
elif line.startswith("TZID:"):
|
|
self._name = line.replace("TZID:", "").strip()
|
|
break
|
|
elif line.startswith("UID:"):
|
|
self._name = line.replace("UID:", "").strip()
|
|
# Do not break, a ``X-RADICALE-NAME`` can appear next
|
|
|
|
if "\nX-RADICALE-NAME:" in text:
|
|
for line in unfold(self.text):
|
|
if line.startswith("X-RADICALE-NAME:"):
|
|
self.text = self.text.replace(
|
|
line, "X-RADICALE-NAME:%s" % self._name)
|
|
else:
|
|
self.text = self.text.replace(
|
|
"\nUID:", "\nX-RADICALE-NAME:%s\nUID:" % self._name)
|
|
|
|
@property
|
|
def etag(self):
|
|
"""Item etag.
|
|
|
|
Etag is mainly used to know if an item has changed.
|
|
|
|
"""
|
|
return '"%s"' % hash(self.text)
|
|
|
|
@property
|
|
def name(self):
|
|
"""Item name.
|
|
|
|
Name is mainly used to give an URL to the item.
|
|
|
|
"""
|
|
return self._name
|
|
|
|
|
|
class Header(Item):
|
|
"""Internal header class."""
|
|
|
|
|
|
class Event(Item):
|
|
"""Internal event class."""
|
|
tag = "VEVENT"
|
|
|
|
|
|
class Todo(Item):
|
|
"""Internal todo class."""
|
|
# This is not a TODO!
|
|
# pylint: disable=W0511
|
|
tag = "VTODO"
|
|
# pylint: enable=W0511
|
|
|
|
|
|
class Journal(Item):
|
|
"""Internal journal class."""
|
|
tag = "VJOURNAL"
|
|
|
|
|
|
class Timezone(Item):
|
|
"""Internal timezone class."""
|
|
tag = "VTIMEZONE"
|
|
|
|
|
|
class Calendar(object):
|
|
"""Internal calendar class."""
|
|
tag = "VCALENDAR"
|
|
|
|
def __init__(self, path, principal=False):
|
|
"""Initialize the calendar with ``cal`` and ``user`` parameters."""
|
|
self.encoding = "utf-8"
|
|
split_path = path.split("/")
|
|
self.owner = split_path[0] if len(split_path) > 1 else None
|
|
self.path = os.path.join(FOLDER, path.replace("/", os.sep))
|
|
self.local_path = path
|
|
self.is_principal = principal
|
|
|
|
@classmethod
|
|
def from_path(cls, path, depth="infinite", include_container=True):
|
|
"""Return a list of calendars and/or sub-items under the given ``path``
|
|
relative to the storage folder. If ``depth`` is "0", only the actual
|
|
object under `path` is returned. Otherwise, also sub-items are appended
|
|
to the result. If `include_container` is True (the default), the
|
|
containing object is included in the result.
|
|
|
|
"""
|
|
attributes = posixpath.normpath(path.strip("/")).split("/")
|
|
if not attributes:
|
|
return None
|
|
if attributes[-1].endswith(".ics"):
|
|
attributes.pop()
|
|
|
|
result = []
|
|
|
|
path = "/".join(attributes[:min(len(attributes), 2)])
|
|
path = path.replace("/", os.sep)
|
|
abs_path = os.path.join(FOLDER, path)
|
|
if os.path.isdir(abs_path):
|
|
if depth == "0":
|
|
result.append(cls(path, principal=True))
|
|
else:
|
|
if include_container:
|
|
result.append(cls(path, principal=True))
|
|
for f in next(os.walk(abs_path))[2]:
|
|
f_path = os.path.join(path, f)
|
|
if cls.is_vcalendar(os.path.join(abs_path, f)):
|
|
result.append(cls(f_path))
|
|
else:
|
|
calendar = cls(path)
|
|
if depth == "0":
|
|
result.append(calendar)
|
|
else:
|
|
if include_container:
|
|
result.append(calendar)
|
|
result.extend(calendar.components)
|
|
return result
|
|
|
|
@staticmethod
|
|
def is_vcalendar(path):
|
|
"""Return `True` if there is a VCALENDAR file under `path`."""
|
|
with open(path) as f:
|
|
return 'BEGIN:VCALENDAR' == f.read(15)
|
|
|
|
@staticmethod
|
|
def _parse(text, item_types, name=None):
|
|
"""Find items with type in ``item_types`` in ``text`` text.
|
|
|
|
If ``name`` is given, give this name to new items in ``text``.
|
|
|
|
Return a list of items.
|
|
|
|
"""
|
|
item_tags = {}
|
|
for item_type in item_types:
|
|
item_tags[item_type.tag] = item_type
|
|
|
|
items = []
|
|
|
|
lines = unfold(text)
|
|
in_item = False
|
|
|
|
for line in lines:
|
|
if line.startswith("BEGIN:") and not in_item:
|
|
item_tag = line.replace("BEGIN:", "").strip()
|
|
if item_tag in item_tags:
|
|
in_item = True
|
|
item_lines = []
|
|
|
|
if in_item:
|
|
item_lines.append(line)
|
|
if line.startswith("END:%s" % item_tag):
|
|
in_item = False
|
|
item_type = item_tags[item_tag]
|
|
item_text = "\n".join(item_lines)
|
|
item_name = None if item_tag == "VTIMEZONE" else name
|
|
items.append(item_type(item_text, item_name))
|
|
|
|
return items
|
|
|
|
def get_item(self, name):
|
|
"""Get calendar item called ``name``."""
|
|
for item in self.items:
|
|
if item.name == name:
|
|
return item
|
|
|
|
def append(self, name, text):
|
|
"""Append items from ``text`` to calendar.
|
|
|
|
If ``name`` is given, give this name to new items in ``text``.
|
|
|
|
"""
|
|
items = self.items
|
|
|
|
for new_item in self._parse(
|
|
text, (Timezone, Event, Todo, Journal), name):
|
|
if new_item.name not in (item.name for item in items):
|
|
items.append(new_item)
|
|
|
|
self.write(items=items)
|
|
|
|
def remove(self, name):
|
|
"""Remove object named ``name`` from calendar."""
|
|
components = [
|
|
component for component in self.components
|
|
if component.name != name]
|
|
|
|
items = self.timezones + components
|
|
self.write(items=items)
|
|
|
|
def replace(self, name, text):
|
|
"""Replace content by ``text`` in objet named ``name`` in calendar."""
|
|
self.remove(name)
|
|
self.append(name, text)
|
|
|
|
def write(self, headers=None, items=None):
|
|
"""Write calendar with given parameters."""
|
|
headers = headers or self.headers or (
|
|
Header("PRODID:-//Radicale//NONSGML Radicale Server//EN"),
|
|
Header("VERSION:2.0"))
|
|
items = items if items is not None else self.items
|
|
|
|
# Create folder if absent
|
|
if not os.path.exists(os.path.dirname(self.path)):
|
|
os.makedirs(os.path.dirname(self.path))
|
|
|
|
text = serialize(headers, items)
|
|
return open(self.path, "w").write(text)
|
|
|
|
@property
|
|
def etag(self):
|
|
"""Etag from calendar."""
|
|
return '"%s"' % hash(self.text)
|
|
|
|
@property
|
|
def name(self):
|
|
"""Calendar name."""
|
|
with self.props as props:
|
|
return props.get('D:displayname',
|
|
self.path.split(os.path.sep)[-1])
|
|
|
|
@property
|
|
def text(self):
|
|
"""Calendar as plain text."""
|
|
try:
|
|
return open(self.path).read()
|
|
except IOError:
|
|
return ""
|
|
|
|
@property
|
|
def headers(self):
|
|
"""Find headers items in calendar."""
|
|
header_lines = []
|
|
|
|
lines = unfold(self.text)
|
|
for line in lines:
|
|
if line.startswith("PRODID:"):
|
|
header_lines.append(Header(line))
|
|
for line in lines:
|
|
if line.startswith("VERSION:"):
|
|
header_lines.append(Header(line))
|
|
|
|
return header_lines
|
|
|
|
@property
|
|
def items(self):
|
|
"""Get list of all items in calendar."""
|
|
return self._parse(self.text, (Event, Todo, Journal, Timezone))
|
|
|
|
@property
|
|
def components(self):
|
|
"""Get list of all components in calendar."""
|
|
return self._parse(self.text, (Event, Todo, Journal))
|
|
|
|
@property
|
|
def events(self):
|
|
"""Get list of ``Event`` items in calendar."""
|
|
return self._parse(self.text, (Event,))
|
|
|
|
@property
|
|
def todos(self):
|
|
"""Get list of ``Todo`` items in calendar."""
|
|
return self._parse(self.text, (Todo,))
|
|
|
|
@property
|
|
def journals(self):
|
|
"""Get list of ``Journal`` items in calendar."""
|
|
return self._parse(self.text, (Journal,))
|
|
|
|
@property
|
|
def timezones(self):
|
|
"""Get list of ``Timezome`` items in calendar."""
|
|
return self._parse(self.text, (Timezone,))
|
|
|
|
@property
|
|
def last_modified(self):
|
|
"""Get the last time the calendar has been modified.
|
|
|
|
The date is formatted according to rfc1123-5.2.14.
|
|
|
|
"""
|
|
# Create calendar if needed
|
|
if not os.path.exists(self.path):
|
|
self.write()
|
|
|
|
modification_time = time.gmtime(os.path.getmtime(self.path))
|
|
return time.strftime("%a, %d %b %Y %H:%M:%S +0000", modification_time)
|
|
|
|
@property
|
|
@contextmanager
|
|
def props(self):
|
|
props_path = self.path + '.props'
|
|
# on enter
|
|
properties = {}
|
|
if os.path.exists(props_path):
|
|
with open(props_path) as prop_file:
|
|
properties.update(json.load(prop_file))
|
|
yield properties
|
|
# on exit
|
|
with open(props_path, 'w') as prop_file:
|
|
json.dump(properties, prop_file)
|
|
|
|
@property
|
|
def owner_url(self):
|
|
if self.owner:
|
|
return '/{}/'.format(self.owner).replace('//', '/')
|
|
else:
|
|
return None
|
|
|
|
@property
|
|
def url(self):
|
|
return '/{}/'.format(self.local_path).replace('//', '/')
|