imip-agent

Annotated imiptools/stores/file.py

1077:dd4f59a7fea5
1076:b3f671605810
1071:9cb80c0c685c 1075:9c9c0a802ad1
2016-03-07 Paul Boddie file changeset files shortlog Merged changes from the default branch. freebusy-collections
paul@2 1 
#!/usr/bin/env python
paul@2 2 
 
 paul@146      3 
"""
 
 paul@146      4 
A simple filesystem-based store of calendar data.
 
 paul@146      5 
 
 paul@1039      6 
Copyright (C) 2014, 2015, 2016 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@1069     22 
from imiptools.stores import StoreBase, PublisherBase, JournalBase
 
 paul@1069     23 
 
 paul@30     24 
from datetime import datetime
 
 paul@1039     25 
from imiptools.config import STORE_DIR, PUBLISH_DIR, JOURNAL_DIR
 
 paul@301     26 
from imiptools.data import make_calendar, parse_object, to_stream
 
 paul@740     27 
from imiptools.dates import format_datetime, get_datetime, to_timezone
 
 paul@147     28 
from imiptools.filesys import fix_permissions, FileBase
 
 paul@1062     29 
from imiptools.period import FreeBusyPeriod, FreeBusyCollection
 
 paul@1046     30 
from imiptools.text import parse_line
 
 paul@808     31 
from os.path import isdir, isfile, join
 
 paul@343     32 
from os import listdir, remove, rmdir
 
 paul@395     33 
import codecs
 
 paul@15     34 
 
 paul@1039     35 
class FileStoreBase(FileBase):
 
 paul@50     36 
 
 paul@1039     37 
    "A file store supporting user-specific locking and tabular data."
 
 paul@147     38 
 
 paul@303     39 
    def acquire_lock(self, user, timeout=None):
 
 paul@303     40 
        FileBase.acquire_lock(self, timeout, user)
 
 paul@303     41 
 
 paul@303     42 
    def release_lock(self, user):
 
 paul@303     43 
        FileBase.release_lock(self, user)
 
 paul@303     44 
 
 paul@648     45 
    # Utility methods.
 
 paul@648     46 
 
 paul@343     47 
    def _set_defaults(self, t, empty_defaults):
 
 paul@343     48 
        for i, default in empty_defaults:
 
 paul@343     49 
            if i >= len(t):
 
 paul@343     50 
                t += [None] * (i - len(t) + 1)
 
 paul@343     51 
            if not t[i]:
 
 paul@343     52 
                t[i] = default
 
 paul@343     53 
        return t
 
 paul@343     54 
 
 paul@1046     55 
    def _get_table(self, user, filename, empty_defaults=None, tab_separated=True):
 
 paul@343     56 
 
 paul@343     57 
        """
 
 paul@343     58 
        From the file for the given 'user' having the given 'filename', return
 
 paul@343     59 
        a list of tuples representing the file's contents.
 
 paul@343     60 
 
 paul@343     61 
        The 'empty_defaults' is a list of (index, value) tuples indicating the
 
 paul@343     62 
        default value where a column either does not exist or provides an empty
 
 paul@343     63 
        value.
 
 paul@1046     64 
 
 paul@1046     65 
        If 'tab_separated' is specified and is a false value, line parsing using
 
 paul@1046     66 
        the imiptools.text.parse_line function will be performed instead of
 
 paul@1046     67 
        splitting each line of the file using tab characters as separators.
 
 paul@343     68 
        """
 
 paul@343     69 
 
 paul@702     70 
        f = codecs.open(filename, "rb", encoding="utf-8")
 
 paul@702     71 
        try:
 
 paul@702     72 
            l = []
 
 paul@702     73 
            for line in f.readlines():
 
 paul@1046     74 
                line = line.strip(" \r\n")
 
 paul@1046     75 
                if tab_separated:
 
 paul@1046     76 
                    t = line.split("\t")
 
 paul@1046     77 
                else:
 
 paul@1046     78 
                    t = parse_line(line)
 
 paul@702     79 
                if empty_defaults:
 
 paul@702     80 
                    t = self._set_defaults(t, empty_defaults)
 
 paul@702     81 
                l.append(tuple(t))
 
 paul@702     82 
            return l
 
 paul@702     83 
        finally:
 
 paul@702     84 
            f.close()
 
 paul@702     85 
 
 paul@1046     86 
    def _get_table_atomic(self, user, filename, empty_defaults=None, tab_separated=True):
 
 paul@702     87 
 
 paul@702     88 
        """
 
 paul@702     89 
        From the file for the given 'user' having the given 'filename', return
 
 paul@702     90 
        a list of tuples representing the file's contents.
 
 paul@702     91 
 
 paul@702     92 
        The 'empty_defaults' is a list of (index, value) tuples indicating the
 
 paul@702     93 
        default value where a column either does not exist or provides an empty
 
 paul@702     94 
        value.
 
 paul@1046     95 
 
 paul@1046     96 
        If 'tab_separated' is specified and is a false value, line parsing using
 
 paul@1046     97 
        the imiptools.text.parse_line function will be performed instead of
 
 paul@1046     98 
        splitting each line of the file using tab characters as separators.
 
 paul@702     99 
        """
 
 paul@702    100 
 
 paul@343    101 
        self.acquire_lock(user)
 
 paul@343    102 
        try:
 
 paul@1046    103 
            return self._get_table(user, filename, empty_defaults, tab_separated)
 
 paul@343    104 
        finally:
 
 paul@343    105 
            self.release_lock(user)
 
 paul@343    106 
 
 paul@343    107 
    def _set_table(self, user, filename, items, empty_defaults=None):
 
 paul@343    108 
 
 paul@343    109 
        """
 
 paul@343    110 
        For the given 'user', write to the file having the given 'filename' the
 
 paul@343    111 
        'items'.
 
 paul@343    112 
 
 paul@343    113 
        The 'empty_defaults' is a list of (index, value) tuples indicating the
 
 paul@343    114 
        default value where a column either does not exist or provides an empty
 
 paul@343    115 
        value.
 
 paul@343    116 
        """
 
 paul@343    117 
 
 paul@702    118 
        f = codecs.open(filename, "wb", encoding="utf-8")
 
 paul@702    119 
        try:
 
 paul@702    120 
            for item in items:
 
 paul@747    121 
                self._set_table_item(f, item, empty_defaults)
 
 paul@702    122 
        finally:
 
 paul@702    123 
            f.close()
 
 paul@702    124 
            fix_permissions(filename)
 
 paul@702    125 
 
 paul@747    126 
    def _set_table_item(self, f, item, empty_defaults=None):
 
 paul@747    127 
 
 paul@747    128 
        "Set in table 'f' the given 'item', using any 'empty_defaults'."
 
 paul@747    129 
 
 paul@747    130 
        if empty_defaults:
 
 paul@747    131 
            item = self._set_defaults(list(item), empty_defaults)
 
 paul@747    132 
        f.write("\t".join(item) + "\n")
 
 paul@747    133 
 
 paul@702    134 
    def _set_table_atomic(self, user, filename, items, empty_defaults=None):
 
 paul@702    135 
 
 paul@702    136 
        """
 
 paul@702    137 
        For the given 'user', write to the file having the given 'filename' the
 
 paul@702    138 
        'items'.
 
 paul@702    139 
 
 paul@702    140 
        The 'empty_defaults' is a list of (index, value) tuples indicating the
 
 paul@702    141 
        default value where a column either does not exist or provides an empty
 
 paul@702    142 
        value.
 
 paul@702    143 
        """
 
 paul@702    144 
 
 paul@343    145 
        self.acquire_lock(user)
 
 paul@343    146 
        try:
 
 paul@702    147 
            self._set_table(user, filename, items, empty_defaults)
 
 paul@343    148 
        finally:
 
 paul@343    149 
            self.release_lock(user)
 
 paul@343    150 
 
 paul@1069    151 
class FileStore(FileStoreBase, StoreBase):
 
 paul@1039    152 
 
 paul@1039    153 
    "A file store of tabular free/busy data and objects."
 
 paul@1039    154 
 
 paul@1039    155 
    def __init__(self, store_dir=None):
 
 paul@1039    156 
        FileBase.__init__(self, store_dir or STORE_DIR)
 
 paul@1039    157 
 
 paul@648    158 
    # Store object access.
 
 paul@648    159 
 
 paul@329    160 
    def _get_object(self, user, filename):
 
 paul@329    161 
 
 paul@329    162 
        """
 
 paul@329    163 
        Return the parsed object for the given 'user' having the given
 
 paul@329    164 
        'filename'.
 
 paul@329    165 
        """
 
 paul@329    166 
 
 paul@329    167 
        self.acquire_lock(user)
 
 paul@329    168 
        try:
 
 paul@329    169 
            f = open(filename, "rb")
 
 paul@329    170 
            try:
 
 paul@329    171 
                return parse_object(f, "utf-8")
 
 paul@329    172 
            finally:
 
 paul@329    173 
                f.close()
 
 paul@329    174 
        finally:
 
 paul@329    175 
            self.release_lock(user)
 
 paul@329    176 
 
 paul@329    177 
    def _set_object(self, user, filename, node):
 
 paul@329    178 
 
 paul@329    179 
        """
 
 paul@329    180 
        Set an object for the given 'user' having the given 'filename', using
 
 paul@329    181 
        'node' to define the object.
 
 paul@329    182 
        """
 
 paul@329    183 
 
 paul@329    184 
        self.acquire_lock(user)
 
 paul@329    185 
        try:
 
 paul@329    186 
            f = open(filename, "wb")
 
 paul@329    187 
            try:
 
 paul@329    188 
                to_stream(f, node)
 
 paul@329    189 
            finally:
 
 paul@329    190 
                f.close()
 
 paul@329    191 
                fix_permissions(filename)
 
 paul@329    192 
        finally:
 
 paul@329    193 
            self.release_lock(user)
 
 paul@329    194 
 
 paul@329    195 
        return True
 
 paul@329    196 
 
 paul@329    197 
    def _remove_object(self, filename):
 
 paul@329    198 
 
 paul@329    199 
        "Remove the object with the given 'filename'."
 
 paul@329    200 
 
 paul@329    201 
        try:
 
 paul@329    202 
            remove(filename)
 
 paul@329    203 
        except OSError:
 
 paul@329    204 
            return False
 
 paul@329    205 
 
 paul@329    206 
        return True
 
 paul@329    207 
 
 paul@343    208 
    def _remove_collection(self, filename):
 
 paul@343    209 
 
 paul@343    210 
        "Remove the collection with the given 'filename'."
 
 paul@343    211 
 
 paul@343    212 
        try:
 
 paul@343    213 
            rmdir(filename)
 
 paul@343    214 
        except OSError:
 
 paul@343    215 
            return False
 
 paul@343    216 
 
 paul@343    217 
        return True
 
 paul@343    218 
 
 paul@670    219 
    # User discovery.
 
 paul@670    220 
 
 paul@670    221 
    def get_users(self):
 
 paul@670    222 
 
 paul@670    223 
        "Return a list of users."
 
 paul@670    224 
 
 paul@670    225 
        return listdir(self.store_dir)
 
 paul@670    226 
 
 paul@648    227 
    # Event and event metadata access.
 
 paul@648    228 
 
 paul@119    229 
    def get_events(self, user):
 
 paul@119    230 
 
 paul@119    231 
        "Return a list of event identifiers."
 
 paul@119    232 
 
 paul@138    233 
        filename = self.get_object_in_store(user, "objects")
 
 paul@808    234 
        if not filename or not isdir(filename):
 
 paul@119    235 
            return None
 
 paul@119    236 
 
 paul@119    237 
        return [name for name in listdir(filename) if isfile(join(filename, name))]
 
 paul@119    238 
 
 paul@760    239 
    def get_event_filename(self, user, uid, recurrenceid=None, dirname=None, username=None):
 
 paul@648    240 
 
 paul@694    241 
        """
 
 paul@694    242 
        Get the filename providing the event for the given 'user' with the given
 
 paul@694    243 
        'uid'. If the optional 'recurrenceid' is specified, a specific instance
 
 paul@694    244 
        or occurrence of an event is returned.
 
 paul@648    245 
 
 paul@694    246 
        Where 'dirname' is specified, the given directory name is used as the
 
 paul@694    247 
        base of the location within which any filename will reside.
 
 paul@694    248 
        """
 
 paul@648    249 
 
 paul@694    250 
        if recurrenceid:
 
 paul@760    251 
            return self.get_recurrence_filename(user, uid, recurrenceid, dirname, username)
 
 paul@694    252 
        else:
 
 paul@760    253 
            return self.get_complete_event_filename(user, uid, dirname, username)
 
 paul@648    254 
 
 paul@858    255 
    def get_event(self, user, uid, recurrenceid=None, dirname=None):
 
 paul@343    256 
 
 paul@343    257 
        """
 
 paul@343    258 
        Get the event for the given 'user' with the given 'uid'. If
 
 paul@343    259 
        the optional 'recurrenceid' is specified, a specific instance or
 
 paul@343    260 
        occurrence of an event is returned.
 
 paul@343    261 
        """
 
 paul@343    262 
 
 paul@858    263 
        filename = self.get_event_filename(user, uid, recurrenceid, dirname)
 
 paul@808    264 
        if not filename or not isfile(filename):
 
 paul@694    265 
            return None
 
 paul@694    266 
 
 paul@694    267 
        return filename and self._get_object(user, filename)
 
 paul@694    268 
 
 paul@760    269 
    def get_complete_event_filename(self, user, uid, dirname=None, username=None):
 
 paul@694    270 
 
 paul@694    271 
        """
 
 paul@694    272 
        Get the filename providing the event for the given 'user' with the given
 
 paul@694    273 
        'uid'. 
 
 paul@694    274 
 
 paul@694    275 
        Where 'dirname' is specified, the given directory name is used as the
 
 paul@694    276 
        base of the location within which any filename will reside.
 
 paul@760    277 
 
 paul@760    278 
        Where 'username' is specified, the event details will reside in a file
 
 paul@760    279 
        bearing that name within a directory having 'uid' as its name.
 
 paul@694    280 
        """
 
 paul@694    281 
 
 paul@760    282 
        return self.get_object_in_store(user, dirname, "objects", uid, username)
 
 paul@343    283 
 
 paul@343    284 
    def get_complete_event(self, user, uid):
 
 paul@50    285 
 
 paul@50    286 
        "Get the event for the given 'user' with the given 'uid'."
 
 paul@50    287 
 
 paul@694    288 
        filename = self.get_complete_event_filename(user, uid)
 
 paul@808    289 
        if not filename or not isfile(filename):
 
 paul@50    290 
            return None
 
 paul@50    291 
 
 paul@694    292 
        return filename and self._get_object(user, filename)
 
 paul@50    293 
 
 paul@343    294 
    def set_complete_event(self, user, uid, node):
 
 paul@50    295 
 
 paul@50    296 
        "Set an event for 'user' having the given 'uid' and 'node'."
 
 paul@50    297 
 
 paul@138    298 
        filename = self.get_object_in_store(user, "objects", uid)
 
 paul@50    299 
        if not filename:
 
 paul@50    300 
            return False
 
 paul@50    301 
 
 paul@329    302 
        return self._set_object(user, filename, node)
 
 paul@15    303 
 
 paul@1068    304 
    def remove_parent_event(self, user, uid):
 
 paul@1068    305 
 
 paul@1068    306 
        "Remove the parent event for 'user' having the given 'uid'."
 
 paul@369    307 
 
 paul@234    308 
        filename = self.get_object_in_store(user, "objects", uid)
 
 paul@234    309 
        if not filename:
 
 paul@234    310 
            return False
 
 paul@234    311 
 
 paul@329    312 
        return self._remove_object(filename)
 
 paul@234    313 
 
 paul@334    314 
    def get_recurrences(self, user, uid):
 
 paul@334    315 
 
 paul@334    316 
        """
 
 paul@334    317 
        Get additional event instances for an event of the given 'user' with the
 
 paul@694    318 
        indicated 'uid'. Both active and cancelled recurrences are returned.
 
 paul@694    319 
        """
 
 paul@694    320 
 
 paul@694    321 
        return self.get_active_recurrences(user, uid) + self.get_cancelled_recurrences(user, uid)
 
 paul@694    322 
 
 paul@694    323 
    def get_active_recurrences(self, user, uid):
 
 paul@694    324 
 
 paul@694    325 
        """
 
 paul@694    326 
        Get additional event instances for an event of the given 'user' with the
 
 paul@694    327 
        indicated 'uid'. Cancelled recurrences are not returned.
 
 paul@334    328 
        """
 
 paul@334    329 
 
 paul@334    330 
        filename = self.get_object_in_store(user, "recurrences", uid)
 
 paul@808    331 
        if not filename or not isdir(filename):
 
 paul@347    332 
            return []
 
 paul@334    333 
 
 paul@334    334 
        return [name for name in listdir(filename) if isfile(join(filename, name))]
 
 paul@334    335 
 
 paul@694    336 
    def get_cancelled_recurrences(self, user, uid):
 
 paul@694    337 
 
 paul@694    338 
        """
 
 paul@694    339 
        Get additional event instances for an event of the given 'user' with the
 
 paul@694    340 
        indicated 'uid'. Only cancelled recurrences are returned.
 
 paul@694    341 
        """
 
 paul@694    342 
 
 paul@782    343 
        filename = self.get_object_in_store(user, "cancellations", "recurrences", uid)
 
 paul@808    344 
        if not filename or not isdir(filename):
 
 paul@694    345 
            return []
 
 paul@694    346 
 
 paul@694    347 
        return [name for name in listdir(filename) if isfile(join(filename, name))]
 
 paul@694    348 
 
 paul@760    349 
    def get_recurrence_filename(self, user, uid, recurrenceid, dirname=None, username=None):
 
 paul@694    350 
 
 paul@694    351 
        """
 
 paul@694    352 
        For the event of the given 'user' with the given 'uid', return the
 
 paul@694    353 
        filename providing the recurrence with the given 'recurrenceid'.
 
 paul@694    354 
 
 paul@694    355 
        Where 'dirname' is specified, the given directory name is used as the
 
 paul@694    356 
        base of the location within which any filename will reside.
 
 paul@760    357 
 
 paul@760    358 
        Where 'username' is specified, the event details will reside in a file
 
 paul@760    359 
        bearing that name within a directory having 'uid' as its name.
 
 paul@694    360 
        """
 
 paul@694    361 
 
 paul@760    362 
        return self.get_object_in_store(user, dirname, "recurrences", uid, recurrenceid, username)
 
 paul@694    363 
 
 paul@334    364 
    def get_recurrence(self, user, uid, recurrenceid):
 
 paul@334    365 
 
 paul@334    366 
        """
 
 paul@334    367 
        For the event of the given 'user' with the given 'uid', return the
 
 paul@334    368 
        specific recurrence indicated by the 'recurrenceid'.
 
 paul@334    369 
        """
 
 paul@334    370 
 
 paul@694    371 
        filename = self.get_recurrence_filename(user, uid, recurrenceid)
 
 paul@808    372 
        if not filename or not isfile(filename):
 
 paul@334    373 
            return None
 
 paul@334    374 
 
 paul@694    375 
        return filename and self._get_object(user, filename)
 
 paul@334    376 
 
 paul@334    377 
    def set_recurrence(self, user, uid, recurrenceid, node):
 
 paul@334    378 
 
 paul@334    379 
        "Set an event for 'user' having the given 'uid' and 'node'."
 
 paul@334    380 
 
 paul@334    381 
        filename = self.get_object_in_store(user, "recurrences", uid, recurrenceid)
 
 paul@334    382 
        if not filename:
 
 paul@334    383 
            return False
 
 paul@334    384 
 
 paul@334    385 
        return self._set_object(user, filename, node)
 
 paul@334    386 
 
 paul@334    387 
    def remove_recurrence(self, user, uid, recurrenceid):
 
 paul@334    388 
 
 paul@378    389 
        """
 
 paul@378    390 
        Remove a special recurrence from an event stored by 'user' having the
 
 paul@378    391 
        given 'uid' and 'recurrenceid'.
 
 paul@378    392 
        """
 
 paul@334    393 
 
 paul@378    394 
        filename = self.get_object_in_store(user, "recurrences", uid, recurrenceid)
 
 paul@334    395 
        if not filename:
 
 paul@334    396 
            return False
 
 paul@334    397 
 
 paul@334    398 
        return self._remove_object(filename)
 
 paul@334    399 
 
 paul@1068    400 
    def remove_recurrence_collection(self, user, uid):
 
 paul@1068    401 
 
 paul@1068    402 
        """
 
 paul@1068    403 
        Remove the collection of recurrences stored by 'user' having the given
 
 paul@1068    404 
        'uid'.
 
 paul@1068    405 
        """
 
 paul@1068    406 
 
 paul@378    407 
        recurrences = self.get_object_in_store(user, "recurrences", uid)
 
 paul@378    408 
        if recurrences:
 
 paul@378    409 
            return self._remove_collection(recurrences)
 
 paul@378    410 
 
 paul@378    411 
        return True
 
 paul@378    412 
 
 paul@652    413 
    # Free/busy period providers, upon extension of the free/busy records.
 
 paul@652    414 
 
 paul@672    415 
    def _get_freebusy_providers(self, user):
 
 paul@672    416 
 
 paul@672    417 
        """
 
 paul@672    418 
        Return the free/busy providers for the given 'user'.
 
 paul@672    419 
 
 paul@672    420 
        This function returns any stored datetime and a list of providers as a
 
 paul@672    421 
        2-tuple. Each provider is itself a (uid, recurrenceid) tuple.
 
 paul@672    422 
        """
 
 paul@672    423 
 
 paul@672    424 
        filename = self.get_object_in_store(user, "freebusy-providers")
 
 paul@808    425 
        if not filename or not isfile(filename):
 
 paul@672    426 
            return None
 
 paul@672    427 
 
 paul@672    428 
        # Attempt to read providers, with a declaration of the datetime
 
 paul@672    429 
        # from which such providers are considered as still being active.
 
 paul@672    430 
 
 paul@702    431 
        t = self._get_table_atomic(user, filename, [(1, None)])
 
 paul@672    432 
        try:
 
 paul@672    433 
            dt_string = t[0][0]
 
 paul@672    434 
        except IndexError:
 
 paul@672    435 
            return None
 
 paul@672    436 
 
 paul@672    437 
        return dt_string, t[1:]
 
 paul@672    438 
 
 paul@672    439 
    def _set_freebusy_providers(self, user, dt_string, t):
 
 paul@672    440 
 
 paul@672    441 
        "Set the given provider timestamp 'dt_string' and table 't'."
 
 paul@672    442 
 
 paul@652    443 
        filename = self.get_object_in_store(user, "freebusy-providers")
 
 paul@672    444 
        if not filename:
 
 paul@672    445 
            return False
 
 paul@652    446 
 
 paul@672    447 
        t.insert(0, (dt_string,))
 
 paul@702    448 
        self._set_table_atomic(user, filename, t, [(1, "")])
 
 paul@672    449 
        return True
 
 paul@652    450 
 
 paul@648    451 
    # Free/busy period access.
 
 paul@648    452 
 
 paul@1071    453 
    def get_freebusy(self, user, name=None, mutable=False):
 
 paul@15    454 
 
 paul@15    455 
        "Get free/busy details for the given 'user'."
 
 paul@15    456 
 
 paul@702    457 
        filename = self.get_object_in_store(user, name or "freebusy")
 
 paul@1062    458 
 
 paul@808    459 
        if not filename or not isfile(filename):
 
 paul@1062    460 
            periods = []
 
 paul@112    461 
        else:
 
 paul@1062    462 
            periods = map(lambda t: FreeBusyPeriod(*t),
 
 paul@1066    463 
                self._get_table_atomic(user, filename))
 
 paul@702    464 
 
 paul@1071    465 
        return FreeBusyCollection(periods, mutable)
 
 paul@1071    466 
 
 paul@1071    467 
    def get_freebusy_for_update(self, user, name=None):
 
 paul@1062    468 
 
 paul@1071    469 
        "Get free/busy details for the given 'user'."
 
 paul@1071    470 
 
 paul@1071    471 
        return self.get_freebusy(user, name, True)
 
 paul@1071    472 
 
 paul@1071    473 
    def get_freebusy_for_other(self, user, other, mutable=False):
 
 paul@112    474 
 
 paul@112    475 
        "For the given 'user', get free/busy details for the 'other' user."
 
 paul@112    476 
 
 paul@112    477 
        filename = self.get_object_in_store(user, "freebusy-other", other)
 
 paul@1062    478 
 
 paul@808    479 
        if not filename or not isfile(filename):
 
 paul@1062    480 
            periods = []
 
 paul@112    481 
        else:
 
 paul@1062    482 
            periods = map(lambda t: FreeBusyPeriod(*t),
 
 paul@1066    483 
                self._get_table_atomic(user, filename))
 
 paul@702    484 
 
 paul@1071    485 
        return FreeBusyCollection(periods, mutable)
 
 paul@1071    486 
 
 paul@1071    487 
    def get_freebusy_for_other_for_update(self, user, other):
 
 paul@1071    488 
 
 paul@1071    489 
        "For the given 'user', get free/busy details for the 'other' user."
 
 paul@1071    490 
 
 paul@1071    491 
        return self.get_freebusy_for_other(user, other, True)
 
 paul@1062    492 
 
 paul@1064    493 
    def set_freebusy(self, user, freebusy, name=None):
 
 paul@15    494 
 
 paul@15    495 
        "For the given 'user', set 'freebusy' details."
 
 paul@15    496 
 
 paul@702    497 
        filename = self.get_object_in_store(user, name or "freebusy")
 
 paul@15    498 
        if not filename:
 
 paul@15    499 
            return False
 
 paul@15    500 
 
 paul@1064    501 
        self._set_table_atomic(user, filename,
 
 paul@1062    502 
            map(lambda fb: fb.as_tuple(strings_only=True), freebusy.periods))
 
 paul@15    503 
        return True
 
 paul@15    504 
 
 paul@1064    505 
    def set_freebusy_for_other(self, user, freebusy, other):
 
 paul@110    506 
 
 paul@110    507 
        "For the given 'user', set 'freebusy' details for the 'other' user."
 
 paul@110    508 
 
 paul@110    509 
        filename = self.get_object_in_store(user, "freebusy-other", other)
 
 paul@110    510 
        if not filename:
 
 paul@110    511 
            return False
 
 paul@110    512 
 
 paul@1064    513 
        self._set_table_atomic(user, filename,
 
 paul@1062    514 
            map(lambda fb: fb.as_tuple(strings_only=True), freebusy.periods))
 
 paul@112    515 
        return True
 
 paul@112    516 
 
 paul@710    517 
    # Tentative free/busy periods related to countering.
 
 paul@710    518 
 
 paul@1071    519 
    def get_freebusy_offers(self, user, mutable=False):
 
 paul@710    520 
 
 paul@710    521 
        "Get free/busy offers for the given 'user'."
 
 paul@710    522 
 
 paul@710    523 
        offers = []
 
 paul@710    524 
        expired = []
 
 paul@741    525 
        now = to_timezone(datetime.utcnow(), "UTC")
 
 paul@710    526 
 
 paul@710    527 
        # Expire old offers and save the collection if modified.
 
 paul@710    528 
 
 paul@730    529 
        self.acquire_lock(user)
 
 paul@710    530 
        try:
 
 paul@730    531 
            l = self.get_freebusy(user, "freebusy-offers")
 
 paul@710    532 
            for fb in l:
 
 paul@710    533 
                if fb.expires and get_datetime(fb.expires) <= now:
 
 paul@710    534 
                    expired.append(fb)
 
 paul@710    535 
                else:
 
 paul@710    536 
                    offers.append(fb)
 
 paul@710    537 
 
 paul@710    538 
            if expired:
 
 paul@730    539 
                self.set_freebusy_offers(user, offers)
 
 paul@710    540 
        finally:
 
 paul@730    541 
            self.release_lock(user)
 
 paul@710    542 
 
 paul@1071    543 
        return FreeBusyCollection(offers, mutable)
 
 paul@1071    544 
 
 paul@1071    545 
    def get_freebusy_offers_for_update(self, user):
 
 paul@1071    546 
 
 paul@1071    547 
        "Get free/busy offers for the given 'user'."
 
 paul@1071    548 
 
 paul@1071    549 
        return self.get_freebusy_offers(user, True)
 
 paul@710    550 
 
 paul@710    551 
    def set_freebusy_offers(self, user, freebusy):
 
 paul@710    552 
 
 paul@710    553 
        "For the given 'user', set 'freebusy' offers."
 
 paul@710    554 
 
 paul@710    555 
        return self.set_freebusy(user, freebusy, "freebusy-offers")
 
 paul@710    556 
 
 paul@747    557 
    # Requests and counter-proposals.
 
 paul@648    558 
 
 paul@142    559 
    def _get_requests(self, user, queue):
 
 paul@66    560 
 
 paul@142    561 
        "Get requests for the given 'user' from the given 'queue'."
 
 paul@66    562 
 
 paul@142    563 
        filename = self.get_object_in_store(user, queue)
 
 paul@808    564 
        if not filename or not isfile(filename):
 
 paul@66    565 
            return None
 
 paul@66    566 
 
 paul@747    567 
        return self._get_table_atomic(user, filename, [(1, None), (2, None)])
 
 paul@66    568 
 
 paul@142    569 
    def get_requests(self, user):
 
 paul@142    570 
 
 paul@142    571 
        "Get requests for the given 'user'."
 
 paul@142    572 
 
 paul@142    573 
        return self._get_requests(user, "requests")
 
 paul@142    574 
 
 paul@142    575 
    def _set_requests(self, user, requests, queue):
 
 paul@66    576 
 
 paul@142    577 
        """
 
 paul@142    578 
        For the given 'user', set the list of queued 'requests' in the given
 
 paul@142    579 
        'queue'.
 
 paul@142    580 
        """
 
 paul@142    581 
 
 paul@142    582 
        filename = self.get_object_in_store(user, queue)
 
 paul@66    583 
        if not filename:
 
 paul@66    584 
            return False
 
 paul@66    585 
 
 paul@747    586 
        self._set_table_atomic(user, filename, requests, [(1, ""), (2, "")])
 
 paul@66    587 
        return True
 
 paul@66    588 
 
 paul@142    589 
    def set_requests(self, user, requests):
 
 paul@142    590 
 
 paul@142    591 
        "For the given 'user', set the list of queued 'requests'."
 
 paul@142    592 
 
 paul@142    593 
        return self._set_requests(user, requests, "requests")
 
 paul@142    594 
 
 paul@747    595 
    def _set_request(self, user, request, queue):
 
 paul@142    596 
 
 paul@343    597 
        """
 
 paul@747    598 
        For the given 'user', set the given 'request' in the given 'queue'.
 
 paul@343    599 
        """
 
 paul@142    600 
 
 paul@142    601 
        filename = self.get_object_in_store(user, queue)
 
 paul@55    602 
        if not filename:
 
 paul@55    603 
            return False
 
 paul@55    604 
 
 paul@303    605 
        self.acquire_lock(user)
 
 paul@55    606 
        try:
 
 paul@747    607 
            f = codecs.open(filename, "ab", encoding="utf-8")
 
 paul@303    608 
            try:
 
 paul@747    609 
                self._set_table_item(f, request, [(1, ""), (2, "")])
 
 paul@303    610 
            finally:
 
 paul@303    611 
                f.close()
 
 paul@303    612 
                fix_permissions(filename)
 
 paul@55    613 
        finally:
 
 paul@303    614 
            self.release_lock(user)
 
 paul@55    615 
 
 paul@55    616 
        return True
 
 paul@55    617 
 
 paul@747    618 
    def set_request(self, user, uid, recurrenceid=None, type=None):
 
 paul@142    619 
 
 paul@747    620 
        """
 
 paul@747    621 
        For the given 'user', set the queued 'uid' and 'recurrenceid',
 
 paul@747    622 
        indicating a request, along with any given 'type'.
 
 paul@747    623 
        """
 
 paul@142    624 
 
 paul@747    625 
        return self._set_request(user, (uid, recurrenceid, type), "requests")
 
 paul@747    626 
 
 paul@760    627 
    def get_counters(self, user, uid, recurrenceid=None):
 
 paul@754    628 
 
 paul@754    629 
        """
 
 paul@766    630 
        For the given 'user', return a list of users from whom counter-proposals
 
 paul@766    631 
        have been received for the given 'uid' and optional 'recurrenceid'.
 
 paul@754    632 
        """
 
 paul@754    633 
 
 paul@754    634 
        filename = self.get_event_filename(user, uid, recurrenceid, "counters")
 
 paul@808    635 
        if not filename or not isdir(filename):
 
 paul@754    636 
            return False
 
 paul@754    637 
 
 paul@766    638 
        return [name for name in listdir(filename) if isfile(join(filename, name))]
 
 paul@760    639 
 
 paul@760    640 
    def get_counter(self, user, other, uid, recurrenceid=None):
 
 paul@105    641 
 
 paul@343    642 
        """
 
 paul@760    643 
        For the given 'user', return the counter-proposal from 'other' for the
 
 paul@760    644 
        given 'uid' and optional 'recurrenceid'.
 
 paul@760    645 
        """
 
 paul@760    646 
 
 paul@760    647 
        filename = self.get_event_filename(user, uid, recurrenceid, "counters", other)
 
 paul@760    648 
        if not filename:
 
 paul@760    649 
            return False
 
 paul@760    650 
 
 paul@760    651 
        return self._get_object(user, filename)
 
 paul@760    652 
 
 paul@760    653 
    def set_counter(self, user, other, node, uid, recurrenceid=None):
 
 paul@760    654 
 
 paul@760    655 
        """
 
 paul@760    656 
        For the given 'user', store a counter-proposal received from 'other' the
 
 paul@760    657 
        given 'node' representing that proposal for the given 'uid' and
 
 paul@760    658 
        'recurrenceid'.
 
 paul@760    659 
        """
 
 paul@760    660 
 
 paul@760    661 
        filename = self.get_event_filename(user, uid, recurrenceid, "counters", other)
 
 paul@760    662 
        if not filename:
 
 paul@760    663 
            return False
 
 paul@760    664 
 
 paul@760    665 
        return self._set_object(user, filename, node)
 
 paul@760    666 
 
 paul@760    667 
    def remove_counters(self, user, uid, recurrenceid=None):
 
 paul@760    668 
 
 paul@760    669 
        """
 
 paul@760    670 
        For the given 'user', remove all counter-proposals associated with the
 
 paul@760    671 
        given 'uid' and 'recurrenceid'.
 
 paul@343    672 
        """
 
 paul@105    673 
 
 paul@747    674 
        filename = self.get_event_filename(user, uid, recurrenceid, "counters")
 
 paul@808    675 
        if not filename or not isdir(filename):
 
 paul@747    676 
            return False
 
 paul@747    677 
 
 paul@760    678 
        removed = False
 
 paul@747    679 
 
 paul@760    680 
        for other in listdir(filename):
 
 paul@760    681 
            counter_filename = self.get_event_filename(user, uid, recurrenceid, "counters", other)
 
 paul@760    682 
            removed = removed or self._remove_object(counter_filename)
 
 paul@760    683 
 
 paul@760    684 
        return removed
 
 paul@760    685 
 
 paul@760    686 
    def remove_counter(self, user, other, uid, recurrenceid=None):
 
 paul@105    687 
 
 paul@747    688 
        """
 
 paul@760    689 
        For the given 'user', remove any counter-proposal from 'other'
 
 paul@760    690 
        associated with the given 'uid' and 'recurrenceid'.
 
 paul@747    691 
        """
 
 paul@747    692 
 
 paul@760    693 
        filename = self.get_event_filename(user, uid, recurrenceid, "counters", other)
 
 paul@808    694 
        if not filename or not isfile(filename):
 
 paul@105    695 
            return False
 
 paul@747    696 
 
 paul@747    697 
        return self._remove_object(filename)
 
 paul@747    698 
 
 paul@747    699 
    # Event cancellation.
 
 paul@105    700 
 
 paul@343    701 
    def cancel_event(self, user, uid, recurrenceid=None):
 
 paul@142    702 
 
 paul@343    703 
        """
 
 paul@694    704 
        Cancel an event for 'user' having the given 'uid'. If the optional
 
 paul@694    705 
        'recurrenceid' is specified, a specific instance or occurrence of an
 
 paul@694    706 
        event is cancelled.
 
 paul@343    707 
        """
 
 paul@142    708 
 
 paul@694    709 
        filename = self.get_event_filename(user, uid, recurrenceid)
 
 paul@694    710 
        cancelled_filename = self.get_event_filename(user, uid, recurrenceid, "cancellations")
 
 paul@142    711 
 
 paul@808    712 
        if filename and cancelled_filename and isfile(filename):
 
 paul@694    713 
            return self.move_object(filename, cancelled_filename)
 
 paul@142    714 
 
 paul@142    715 
        return False
 
 paul@142    716 
 
 paul@863    717 
    def uncancel_event(self, user, uid, recurrenceid=None):
 
 paul@863    718 
 
 paul@863    719 
        """
 
 paul@863    720 
        Uncancel an event for 'user' having the given 'uid'. If the optional
 
 paul@863    721 
        'recurrenceid' is specified, a specific instance or occurrence of an
 
 paul@863    722 
        event is uncancelled.
 
 paul@863    723 
        """
 
 paul@863    724 
 
 paul@863    725 
        filename = self.get_event_filename(user, uid, recurrenceid)
 
 paul@863    726 
        cancelled_filename = self.get_event_filename(user, uid, recurrenceid, "cancellations")
 
 paul@863    727 
 
 paul@863    728 
        if filename and cancelled_filename and isfile(cancelled_filename):
 
 paul@863    729 
            return self.move_object(cancelled_filename, filename)
 
 paul@863    730 
 
 paul@863    731 
        return False
 
 paul@863    732 
 
 paul@796    733 
    def remove_cancellation(self, user, uid, recurrenceid=None):
 
 paul@796    734 
 
 paul@796    735 
        """
 
 paul@796    736 
        Remove a cancellation for 'user' for the event having the given 'uid'.
 
 paul@796    737 
        If the optional 'recurrenceid' is specified, a specific instance or
 
 paul@796    738 
        occurrence of an event is affected.
 
 paul@796    739 
        """
 
 paul@796    740 
 
 paul@796    741 
        # Remove any parent event cancellation or a specific recurrence
 
 paul@796    742 
        # cancellation if indicated.
 
 paul@796    743 
 
 paul@796    744 
        filename = self.get_event_filename(user, uid, recurrenceid, "cancellations")
 
 paul@796    745 
 
 paul@808    746 
        if filename and isfile(filename):
 
 paul@796    747 
            return self._remove_object(filename)
 
 paul@796    748 
 
 paul@796    749 
        return False
 
 paul@796    750 
 
 paul@1069    751 
class FilePublisher(FileBase, PublisherBase):
 
 paul@30    752 
 
 paul@30    753 
    "A publisher of objects."
 
 paul@30    754 
 
 paul@597    755 
    def __init__(self, store_dir=None):
 
 paul@597    756 
        FileBase.__init__(self, store_dir or PUBLISH_DIR)
 
 paul@30    757 
 
 paul@30    758 
    def set_freebusy(self, user, freebusy):
 
 paul@30    759 
 
 paul@30    760 
        "For the given 'user', set 'freebusy' details."
 
 paul@30    761 
 
 paul@52    762 
        filename = self.get_object_in_store(user, "freebusy")
 
 paul@30    763 
        if not filename:
 
 paul@30    764 
            return False
 
 paul@30    765 
 
 paul@30    766 
        record = []
 
 paul@30    767 
        rwrite = record.append
 
 paul@30    768 
 
 paul@30    769 
        rwrite(("ORGANIZER", {}, user))
 
 paul@30    770 
        rwrite(("UID", {}, user))
 
 paul@30    771 
        rwrite(("DTSTAMP", {}, datetime.utcnow().strftime("%Y%m%dT%H%M%SZ")))
 
 paul@30    772 
 
 paul@458    773 
        for fb in freebusy:
 
 paul@458    774 
            if not fb.transp or fb.transp == "OPAQUE":
 
 paul@529    775 
                rwrite(("FREEBUSY", {"FBTYPE" : "BUSY"}, "/".join(
 
 paul@563    776 
                    map(format_datetime, [fb.get_start_point(), fb.get_end_point()]))))
 
 paul@30    777 
 
 paul@395    778 
        f = open(filename, "wb")
 
 paul@30    779 
        try:
 
 paul@30    780 
            to_stream(f, make_calendar([("VFREEBUSY", {}, record)], "PUBLISH"))
 
 paul@30    781 
        finally:
 
 paul@30    782 
            f.close()
 
 paul@103    783 
            fix_permissions(filename)
 
 paul@30    784 
 
 paul@30    785 
        return True
 
 paul@30    786 
 
 paul@1069    787 
class FileJournal(FileStoreBase, JournalBase):
 
 paul@1039    788 
 
 paul@1039    789 
    "A journal system to support quotas."
 
 paul@1039    790 
 
 paul@1039    791 
    def __init__(self, store_dir=None):
 
 paul@1039    792 
        FileBase.__init__(self, store_dir or JOURNAL_DIR)
 
 paul@1039    793 
 
 paul@1049    794 
    # Quota and user identity/group discovery.
 
 paul@1049    795 
 
 paul@1049    796 
    def get_quotas(self):
 
 paul@1049    797 
 
 paul@1049    798 
        "Return a list of quotas."
 
 paul@1049    799 
 
 paul@1049    800 
        return listdir(self.store_dir)
 
 paul@1049    801 
 
 paul@1049    802 
    def get_quota_users(self, quota):
 
 paul@1049    803 
 
 paul@1049    804 
        "Return a list of quota users."
 
 paul@1049    805 
 
 paul@1049    806 
        filename = self.get_object_in_store(quota, "journal")
 
 paul@1049    807 
        if not filename or not isdir(filename):
 
 paul@1049    808 
            return []
 
 paul@1049    809 
 
 paul@1049    810 
        return listdir(filename)
 
 paul@1049    811 
 
 paul@1039    812 
    # Groups of users sharing quotas.
 
 paul@1039    813 
 
 paul@1039    814 
    def get_groups(self, quota):
 
 paul@1039    815 
 
 paul@1039    816 
        "Return the identity mappings for the given 'quota' as a dictionary."
 
 paul@1039    817 
 
 paul@1039    818 
        filename = self.get_object_in_store(quota, "groups")
 
 paul@1039    819 
        if not filename or not isfile(filename):
 
 paul@1039    820 
            return {}
 
 paul@1039    821 
 
 paul@1046    822 
        return dict(self._get_table_atomic(quota, filename, tab_separated=False))
 
 paul@1039    823 
 
 paul@1039    824 
    def get_limits(self, quota):
 
 paul@1039    825 
 
 paul@1039    826 
        """
 
 paul@1039    827 
        Return the limits for the 'quota' as a dictionary mapping identities or
 
 paul@1039    828 
        groups to durations.
 
 paul@1039    829 
        """
 
 paul@1039    830 
 
 paul@1039    831 
        filename = self.get_object_in_store(quota, "limits")
 
 paul@1039    832 
        if not filename or not isfile(filename):
 
 paul@1039    833 
            return None
 
 paul@1039    834 
 
 paul@1046    835 
        return dict(self._get_table_atomic(quota, filename, tab_separated=False))
 
 paul@1039    836 
 
 paul@1048    837 
    # Free/busy period access for users within quota groups.
 
 paul@1039    838 
 
 paul@1071    839 
    def get_freebusy(self, quota, user, mutable=False):
 
 paul@1039    840 
 
 paul@1039    841 
        "Get free/busy details for the given 'quota' and 'user'."
 
 paul@1039    842 
 
 paul@1039    843 
        filename = self.get_object_in_store(quota, "freebusy", user)
 
 paul@1059    844 
 
 paul@1039    845 
        if not filename or not isfile(filename):
 
 paul@1062    846 
            periods = []
 
 paul@1062    847 
        else:
 
 paul@1062    848 
            periods = map(lambda t: FreeBusyPeriod(*t),
 
 paul@1067    849 
                self._get_table_atomic(quota, filename))
 
 paul@1059    850 
 
 paul@1071    851 
        return FreeBusyCollection(periods, mutable)
 
 paul@1071    852 
 
 paul@1071    853 
    def get_freebusy_for_update(self, quota, user):
 
 paul@1071    854 
 
 paul@1071    855 
        "Get free/busy details for the given 'quota' and 'user'."
 
 paul@1071    856 
 
 paul@1071    857 
        return self.get_freebusy(quota, user, True)
 
 paul@1039    858 
 
 paul@1064    859 
    def set_freebusy(self, quota, user, freebusy):
 
 paul@1039    860 
 
 paul@1039    861 
        "For the given 'quota' and 'user', set 'freebusy' details."
 
 paul@1039    862 
 
 paul@1039    863 
        filename = self.get_object_in_store(quota, "freebusy", user)
 
 paul@1039    864 
        if not filename:
 
 paul@1039    865 
            return False
 
 paul@1039    866 
 
 paul@1064    867 
        self._set_table_atomic(quota, filename,
 
 paul@1062    868 
            map(lambda fb: fb.as_tuple(strings_only=True), freebusy.periods))
 
 paul@1039    869 
        return True
 
 paul@1039    870 
 
 paul@1039    871 
    # Journal entry methods.
 
 paul@1039    872 
 
 paul@1071    873 
    def get_entries(self, quota, group, mutable=False):
 
 paul@1039    874 
 
 paul@1039    875 
        """
 
 paul@1039    876 
        Return a list of journal entries for the given 'quota' for the indicated
 
 paul@1039    877 
        'group'.
 
 paul@1039    878 
        """
 
 paul@1039    879 
 
 paul@1039    880 
        filename = self.get_object_in_store(quota, "journal", group)
 
 paul@1039    881 
 
 paul@1039    882 
        if not filename or not isfile(filename):
 
 paul@1062    883 
            periods = []
 
 paul@1062    884 
        else:
 
 paul@1062    885 
            periods = map(lambda t: FreeBusyPeriod(*t),
 
 paul@1067    886 
                self._get_table_atomic(quota, filename))
 
 paul@1062    887 
 
 paul@1071    888 
        return FreeBusyCollection(periods, mutable)
 
 paul@1039    889 
 
 paul@1071    890 
    def get_entries_for_update(self, quota, group):
 
 paul@1071    891 
 
 paul@1071    892 
        """
 
 paul@1071    893 
        Return a list of journal entries for the given 'quota' for the indicated
 
 paul@1071    894 
        'group'.
 
 paul@1071    895 
        """
 
 paul@1071    896 
 
 paul@1071    897 
        return self.get_entries(quota, group, True)
 
 paul@1039    898 
 
 paul@1039    899 
    def set_entries(self, quota, group, entries):
 
 paul@1039    900 
 
 paul@1039    901 
        """
 
 paul@1039    902 
        For the given 'quota' and indicated 'group', set the list of journal
 
 paul@1039    903 
        'entries'.
 
 paul@1039    904 
        """
 
 paul@1039    905 
 
 paul@1039    906 
        filename = self.get_object_in_store(quota, "journal", group)
 
 paul@1039    907 
        if not filename:
 
 paul@1039    908 
            return False
 
 paul@1039    909 
 
 paul@1059    910 
        self._set_table_atomic(quota, filename,
 
 paul@1062    911 
            map(lambda fb: fb.as_tuple(strings_only=True), entries.periods))
 
 paul@1039    912 
        return True
 
 paul@1039    913 
 
 paul@2    914 
# vim: tabstop=4 expandtab shiftwidth=4