summaryrefslogtreecommitdiff
path: root/lib/Kolab/CardDAV/AddressBook.php
blob: 5c4a8309ef4e31832069070cfa47eb0dae6f9bff (plain)
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
<?php

/**
 * SabreDAV AddressBook derived class to encapsulate a Kolab storage folder
 *
 * @author Thomas Bruederli <bruederli@kolabsys.com>
 *
 * Copyright (C) 2013, Kolab Systems AG <contact@kolabsys.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

namespace Kolab\CardDAV;

use \PEAR;
use Sabre\DAV;
use Sabre\DAVACL;
use Sabre\CardDAV\Backend;

/**
 * The AddressBook class represents a CardDAV addressbook, owned by a specific user
 *
 */
class AddressBook extends \Sabre\CardDAV\AddressBook implements \Sabre\CardDAV\IAddressBook, DAV\IProperties, DAVACL\IACL
{
    public $id;
    public $storage;
    public $ready = false;


    /**
     * Constructor
     *
     * @param Backend\BackendInterface $carddavBackend
     * @param array $addressBookInfo
     */
    public function __construct(Backend\BackendInterface $carddavBackend, array $addressBookInfo)
    {
        parent::__construct($carddavBackend, $addressBookInfo);

        $this->id = $addressBookInfo['id'];
        $this->storage = $carddavBackend->get_storage_folder($this->id);
        $this->ready = is_object($this->storage) && is_a($this->storage, 'kolab_storage_folder');
    }


    /**
     * Renames the addressbook
     *
     * @param string $newName
     * @return void
     */
    public function setName($newName)
    {
        // TODO: implement this
        throw new DAV\Exception\MethodNotAllowed('Renaming addressbooks is not yet supported');
    }


    /**
     * Returns the owner principal
     *
     * This must be a url to a principal, or null if there's no owner
     *
     * @return string|null
     */
    public function getOwner()
    {
        if ($this->storage->get_namespace() == 'personal') {
            return $this->addressBookInfo['principaluri'];
        }
        else {
            return 'principals/' . $this->storage->get_owner();
        }
    }

    /**
     * Returns a list of ACE's for this node.
     *
     * Each ACE has the following properties:
     *   * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
     *     currently the only supported privileges
     *   * 'principal', a url to the principal who owns the node
     *   * 'protected' (optional), indicating that this ACE is not allowed to
     *      be updated.
     *
     * @return array
     */
    public function getACL()
    {
        // return ACL information based on IMAP MYRIGHTS
        $rights = $this->storage->get_myrights();
        if ($rights && !PEAR::isError($rights)) {
            // user has at least read access to calendar folders listed
            $acl = array(
                array(
                    'privilege' => '{DAV:}read',
                    'principal' => $this->addressBookInfo['principaluri'],
                    'protected' => true,
                ),
            );

            $owner = $this->getOwner();
            $is_owner = $owner == $this->calendarInfo['principaluri'];

            if ($is_owner || strpos($rights, 'i') !== false) {
                $acl[] = array(
                    'privilege' => '{DAV:}write',
                    'principal' => $this->addressBookInfo['principaluri'],
                    'protected' => true,
                );
            }

            return $acl;
        }
        else {
            // fallback to default ACL rules based on ownership
            return parent::getACL();
        }
    }

    /**
     * Updates the ACL
     *
     * This method will receive a list of new ACE's.
     *
     * @param array $acl
     * @return void
     */
    public function setACL(array $acl)
    {
        // TODO: implement this
        throw new DAV\Exception\MethodNotAllowed('Changing ACL is not yet supported');
    }

}