Blame view

sources/3rdparty/sabre/dav/lib/Sabre/CalDAV/Property/Invite.php 7.42 KB
03e52840d   Kload   Init
1
  <?php
6d9380f96   Cédric Dupont   Update sources OC...
2
3
4
5
6
  namespace Sabre\CalDAV\Property;
  
  use Sabre\CalDAV\SharingPlugin as SharingPlugin;
  use Sabre\DAV;
  use Sabre\CalDAV;
03e52840d   Kload   Init
7
8
9
10
11
12
13
14
  
  /**
   * Invite property
   *
   * This property encodes the 'invite' property, as defined by
   * the 'caldav-sharing-02' spec, in the http://calendarserver.org/ns/
   * namespace.
   *
03e52840d   Kload   Init
15
   * @see https://trac.calendarserver.org/browser/CalendarServer/trunk/doc/Extensions/caldav-sharing-02.txt
6d9380f96   Cédric Dupont   Update sources OC...
16
17
18
   * @copyright Copyright (C) 2007-2014 fruux GmbH (https://fruux.com/).
   * @author Evert Pot (http://evertpot.com/)
   * @license http://sabre.io/license/ Modified BSD License
03e52840d   Kload   Init
19
   */
6d9380f96   Cédric Dupont   Update sources OC...
20
  class Invite extends DAV\Property {
03e52840d   Kload   Init
21
22
23
24
25
26
27
28
29
  
      /**
       * The list of users a calendar has been shared to.
       *
       * @var array
       */
      protected $users;
  
      /**
6d9380f96   Cédric Dupont   Update sources OC...
30
31
32
33
34
35
36
37
       * The organizer contains information about the person who shared the
       * object.
       *
       * @var array
       */
      protected $organizer;
  
      /**
03e52840d   Kload   Init
38
39
40
41
42
43
44
45
46
47
48
       * Creates the property.
       *
       * Users is an array. Each element of the array has the following
       * properties:
       *
       *   * href - Often a mailto: address
       *   * commonName - Optional, for example a first and lastname for a user.
       *   * status - One of the SharingPlugin::STATUS_* constants.
       *   * readOnly - true or false
       *   * summary - Optional, description of the share
       *
6d9380f96   Cédric Dupont   Update sources OC...
49
50
51
52
53
54
55
56
57
58
59
60
       * The organizer key is optional to specify. It's only useful when a
       * 'sharee' requests the sharing information.
       *
       * The organizer may have the following properties:
       *   * href - Often a mailto: address.
       *   * commonName - Optional human-readable name.
       *   * firstName - Optional first name.
       *   * lastName - Optional last name.
       *
       * If you wonder why these two structures are so different, I guess a
       * valid answer is that the current spec is still a draft.
       *
03e52840d   Kload   Init
61
62
       * @param array $users
       */
6d9380f96   Cédric Dupont   Update sources OC...
63
      public function __construct(array $users, array $organizer = null) {
03e52840d   Kload   Init
64
65
  
          $this->users = $users;
6d9380f96   Cédric Dupont   Update sources OC...
66
          $this->organizer = $organizer;
03e52840d   Kload   Init
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
  
      }
  
      /**
       * Returns the list of users, as it was passed to the constructor.
       *
       * @return array
       */
      public function getValue() {
  
          return $this->users;
  
      }
  
      /**
       * Serializes the property in a DOMDocument
       *
6d9380f96   Cédric Dupont   Update sources OC...
84
85
       * @param DAV\Server $server
       * @param \DOMElement $node
03e52840d   Kload   Init
86
87
       * @return void
       */
6d9380f96   Cédric Dupont   Update sources OC...
88
      public function serialize(DAV\Server $server,\DOMElement $node) {
03e52840d   Kload   Init
89
90
  
         $doc = $node->ownerDocument;
6d9380f96   Cédric Dupont   Update sources OC...
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
  
         if (!is_null($this->organizer)) {
  
             $xorganizer = $doc->createElement('cs:organizer');
  
             $href = $doc->createElement('d:href');
             $href->appendChild($doc->createTextNode($this->organizer['href']));
             $xorganizer->appendChild($href);
  
             if (isset($this->organizer['commonName']) && $this->organizer['commonName']) {
                 $commonName = $doc->createElement('cs:common-name');
                 $commonName->appendChild($doc->createTextNode($this->organizer['commonName']));
                 $xorganizer->appendChild($commonName);
             }
             if (isset($this->organizer['firstName']) && $this->organizer['firstName']) {
                 $firstName = $doc->createElement('cs:first-name');
                 $firstName->appendChild($doc->createTextNode($this->organizer['firstName']));
                 $xorganizer->appendChild($firstName);
             }
             if (isset($this->organizer['lastName']) && $this->organizer['lastName']) {
                 $lastName = $doc->createElement('cs:last-name');
                 $lastName->appendChild($doc->createTextNode($this->organizer['lastName']));
                 $xorganizer->appendChild($lastName);
             }
  
             $node->appendChild($xorganizer);
  
  
         }
03e52840d   Kload   Init
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
         foreach($this->users as $user) {
  
             $xuser = $doc->createElement('cs:user');
  
             $href = $doc->createElement('d:href');
             $href->appendChild($doc->createTextNode($user['href']));
             $xuser->appendChild($href);
  
             if (isset($user['commonName']) && $user['commonName']) {
                 $commonName = $doc->createElement('cs:common-name');
                 $commonName->appendChild($doc->createTextNode($user['commonName']));
                 $xuser->appendChild($commonName);
             }
  
             switch($user['status']) {
  
                 case SharingPlugin::STATUS_ACCEPTED :
                     $status = $doc->createElement('cs:invite-accepted');
                     $xuser->appendChild($status);
                     break;
                 case SharingPlugin::STATUS_DECLINED :
                     $status = $doc->createElement('cs:invite-declined');
                     $xuser->appendChild($status);
                     break;
                 case SharingPlugin::STATUS_NORESPONSE :
                     $status = $doc->createElement('cs:invite-noresponse');
                     $xuser->appendChild($status);
                     break;
                 case SharingPlugin::STATUS_INVALID :
                     $status = $doc->createElement('cs:invite-invalid');
                     $xuser->appendChild($status);
                     break;
  
             }
  
             $xaccess = $doc->createElement('cs:access');
  
             if ($user['readOnly']) {
                  $xaccess->appendChild(
                      $doc->createElement('cs:read')
                  );
             } else {
                  $xaccess->appendChild(
                      $doc->createElement('cs:read-write')
                  );
             }
             $xuser->appendChild($xaccess);
  
             if (isset($user['summary']) && $user['summary']) {
                 $summary = $doc->createElement('cs:summary');
                 $summary->appendChild($doc->createTextNode($user['summary']));
                 $xuser->appendChild($summary);
             }
  
             $node->appendChild($xuser);
  
         }
6d9380f96   Cédric Dupont   Update sources OC...
177

03e52840d   Kload   Init
178
179
180
181
182
183
184
      }
  
      /**
       * Unserializes the property.
       *
       * This static method should return a an instance of this object.
       *
6d9380f96   Cédric Dupont   Update sources OC...
185
186
       * @param \DOMElement $prop
       * @return DAV\IProperty
03e52840d   Kload   Init
187
       */
6d9380f96   Cédric Dupont   Update sources OC...
188
      static function unserialize(\DOMElement $prop) {
03e52840d   Kload   Init
189
190
  
          $xpath = new \DOMXPath($prop->ownerDocument);
6d9380f96   Cédric Dupont   Update sources OC...
191
          $xpath->registerNamespace('cs', CalDAV\Plugin::NS_CALENDARSERVER);
03e52840d   Kload   Init
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
          $xpath->registerNamespace('d',  'urn:DAV');
  
          $users = array();
  
          foreach($xpath->query('cs:user', $prop) as $user) {
  
              $status = null;
              if ($xpath->evaluate('boolean(cs:invite-accepted)', $user)) {
                  $status = SharingPlugin::STATUS_ACCEPTED;
              } elseif ($xpath->evaluate('boolean(cs:invite-declined)', $user)) {
                  $status = SharingPlugin::STATUS_DECLINED;
              } elseif ($xpath->evaluate('boolean(cs:invite-noresponse)', $user)) {
                  $status = SharingPlugin::STATUS_NORESPONSE;
              } elseif ($xpath->evaluate('boolean(cs:invite-invalid)', $user)) {
                  $status = SharingPlugin::STATUS_INVALID;
              } else {
6d9380f96   Cédric Dupont   Update sources OC...
208
                  throw new DAV\Exception('Every cs:user property must have one of cs:invite-accepted, cs:invite-declined, cs:invite-noresponse or cs:invite-invalid');
03e52840d   Kload   Init
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
              }
              $users[] = array(
                  'href' => $xpath->evaluate('string(d:href)', $user),
                  'commonName' => $xpath->evaluate('string(cs:common-name)', $user),
                  'readOnly' => $xpath->evaluate('boolean(cs:access/cs:read)', $user),
                  'summary' => $xpath->evaluate('string(cs:summary)', $user),
                  'status' => $status,
              );
  
          }
  
          return new self($users);
  
      }
  
  }