DAViCal
WritableCollection.php
1 <?php
2 include_once('DAVResource.php');
3 
5 
11  private static function GetTZID( vComponent $comp ) {
12  $p = $comp->GetProperty('DTSTART');
13  if ( !isset($p) && $comp->GetType() == 'VTODO' ) {
14  $p = $comp->GetProperty('DUE');
15  }
16  if ( !isset($p) ) return null;
17  return $p->GetParameterValue('TZID');
18  }
19 
33  function WriteCalendarMember( vCalendar $vcal, $create_resource, $do_scheduling=false, $segment_name = null, $log_action=false ) {
34  if ( !$this->IsSchedulingCollection() && !$this->IsCalendar() ) {
35  dbg_error_log( 'PUT', '"%s" is not a calendar or scheduling collection!', $this->dav_name);
36  return false;
37  }
38 
39  global $session, $caldav_context;
40 
41  $resources = $vcal->GetComponents('VTIMEZONE',false); // Not matching VTIMEZONE
42  $user_no = $this->user_no();
43  $collection_id = $this->collection_id();
44 
45  if ( !isset($resources[0]) ) {
46  dbg_error_log( 'PUT', 'No calendar content!');
47  rollback_on_error( $caldav_context, $user_no, $this->dav_name.'/'.$segment_name, translate('No calendar content'), 412 );
48  return false;
49  }
50  else {
51  $first = $resources[0];
52  $resource_type = $first->GetType();
53  }
54 
55  $uid = $vcal->GetUID();
56  if ( empty($segment_name) ) {
57  $segment_name = $uid.'.ics';
58  }
59  $path = $this->dav_name() . $segment_name;
60 
61  $caldav_data = $vcal->Render();
62  $etag = md5($caldav_data);
63  $weak_etag = null;
64 
65  $qry = new AwlQuery();
66  $existing_transaction_state = $qry->TransactionState();
67  if ( $existing_transaction_state == 0 ) $qry->Begin();
68 
69 
70  if ( $create_resource ) {
71  $qry->QDo('SELECT nextval(\'dav_id_seq\') AS dav_id');
72  }
73  else {
74  $qry->QDo('SELECT dav_id FROM caldav_data WHERE dav_name = :dav_name ', array(':dav_name' => $path));
75  }
76  if ( $qry->rows() != 1 || !($row = $qry->Fetch()) ) {
77  if ( !$create_resource ) {
78  // Looks like we will have to create it, even if the caller thought we wouldn't
79  $qry->QDo('SELECT nextval(\'dav_id_seq\') AS dav_id');
80  if ( $qry->rows() != 1 || !($row = $qry->Fetch()) ) {
81  // No dav_id? => We're toast!
82  trace_bug( 'No dav_id for "%s" on %s!!!', $path, ($create_resource ? 'create': 'update'));
83  rollback_on_error( $caldav_context, $user_no, $path);
84  return false;
85  }
86  $create_resource = true;
87  dbg_error_log( 'PUT', 'Unexpected need to create resource at "%s"', $path);
88  }
89  }
90  $dav_id = $row->dav_id;
91 
92  $calitem_params = array(
93  ':dav_name' => $path,
94  ':user_no' => $user_no,
95  ':etag' => $etag,
96  ':dav_id' => $dav_id
97  );
98 
99  $dav_params = array_merge($calitem_params, array(
100  ':dav_data' => $caldav_data,
101  ':caldav_type' => $resource_type,
102  ':session_user' => $session->user_no,
103  ':weak_etag' => $weak_etag
104  ) );
105 
106  if ( !$this->IsSchedulingCollection() && $do_scheduling ) {
107  if ( do_scheduling_requests($vcal, $create_resource ) ) {
108  $dav_params[':dav_data'] = $vcal->Render(null, true);
109  $etag = null;
110  }
111  }
112 
113  if ( $create_resource ) {
114  $sql = 'INSERT INTO caldav_data ( dav_id, user_no, dav_name, dav_etag, caldav_data, caldav_type, logged_user, created, modified, collection_id, weak_etag )
115  VALUES( :dav_id, :user_no, :dav_name, :etag, :dav_data, :caldav_type, :session_user, current_timestamp, current_timestamp, :collection_id, :weak_etag )';
116  $dav_params[':collection_id'] = $collection_id;
117  }
118  else {
119  $sql = 'UPDATE caldav_data SET caldav_data=:dav_data, dav_etag=:etag, caldav_type=:caldav_type, logged_user=:session_user,
120  modified=current_timestamp, weak_etag=:weak_etag WHERE dav_id=:dav_id';
121  }
122  if ( !$qry->QDo($sql,$dav_params) ) {
123  rollback_on_error( $caldav_context, $user_no, $path);
124  return false;
125  }
126 
127  $dtstart = $first->GetPValue('DTSTART');
128  $calitem_params[':dtstart'] = $dtstart;
129  if ( (!isset($dtstart) || $dtstart == '') && $first->GetPValue('DUE') != '' ) {
130  $dtstart = $first->GetPValue('DUE');
131  }
132 
133  $dtend = $first->GetPValue('DTEND');
134  if ( isset($dtend) && $dtend != '' ) {
135  dbg_error_log( 'PUT', ' DTEND: "%s", DTSTART: "%s", DURATION: "%s"', $dtend, $dtstart, $first->GetPValue('DURATION') );
136  $calitem_params[':dtend'] = $dtend;
137  $dtend = ':dtend';
138  }
139  else {
140  $dtend = 'NULL';
141  if ( $first->GetPValue('DURATION') != '' AND $dtstart != '' ) {
142  $duration = preg_replace( '#[PT]#', '', $first->GetPValue('DURATION') );
143  if ($duration == '') $duration = '0 seconds';
144  $dtend = '(:dtstart::timestamp with time zone + :duration::interval)';
145  $calitem_params[':duration'] = $duration;
146  }
147  elseif ( $first->GetType() == 'VEVENT' ) {
161  $value_type = $first->GetProperty('DTSTART')->GetParameterValue('VALUE');
162  dbg_error_log('PUT','DTSTART without DTEND. DTSTART value type is %s', $value_type );
163  if ( isset($value_type) && $value_type == 'DATE' )
164  $dtend = '(:dtstart::timestamp with time zone::date + \'1 day\'::interval)';
165  else
166  $dtend = ':dtstart';
167  }
168  }
169 
170  $last_modified = $first->GetPValue('LAST-MODIFIED');
171  if ( !isset($last_modified) || $last_modified == '' ) {
172  $last_modified = gmdate( 'Ymd\THis\Z' );
173  }
174  $calitem_params[':modified'] = $last_modified;
175 
176  $dtstamp = $first->GetPValue('DTSTAMP');
177  if ( !isset($dtstamp) || $dtstamp == '' ) {
178  $dtstamp = $last_modified;
179  }
180  $calitem_params[':dtstamp'] = $dtstamp;
181 
182  $class = $first->GetPValue('CLASS');
183  /*
184  * It seems that some calendar clients don't set a class...
185  * RFC2445, 4.8.1.3: Default is PUBLIC
186  */
187  if ( $this->IsPublicOnly() || !isset($class) || $class == '' ) {
188  $class = 'PUBLIC';
189  }
190  $calitem_params[':class'] = $class;
191 
193  $last_olson = 'Turkmenikikamukau'; // I really hope this location doesn't exist!
194  $tzid = self::GetTZID($first);
195  if ( !empty($tzid) ) {
196  $tz = $vcal->GetTimeZone($tzid);
197  $olson = $vcal->GetOlsonName($tz);
198 
199  if ( !empty($olson) && ($olson != $last_olson) ) {
200  dbg_error_log( 'PUT', ' Setting timezone to %s', $olson );
201  $qry->QDo('SET TIMEZONE TO \''.$olson."'" );
202  $last_olson = $olson;
203  }
204  }
205 
206  $created = $first->GetPValue('CREATED');
207  if ( $created == '00001231T000000Z' ) $created = '20001231T000000Z';
208  $calitem_params[':created'] = $created;
209 
210  $calitem_params[':tzid'] = $tzid;
211  $calitem_params[':uid'] = $uid;
212  $calitem_params[':summary'] = $first->GetPValue('SUMMARY');
213  $calitem_params[':location'] = $first->GetPValue('LOCATION');
214  $calitem_params[':transp'] = $first->GetPValue('TRANSP');
215  $calitem_params[':description'] = $first->GetPValue('DESCRIPTION');
216  $calitem_params[':rrule'] = $first->GetPValue('RRULE');
217  $calitem_params[':url'] = $first->GetPValue('URL');
218  $calitem_params[':priority'] = $first->GetPValue('PRIORITY');
219  $calitem_params[':due'] = $first->GetPValue('DUE');
220  $calitem_params[':percent_complete'] = $first->GetPValue('PERCENT-COMPLETE');
221  $calitem_params[':status'] = $first->GetPValue('STATUS');
222 
223  $range = getVCalendarRange($vcal, $this->timezone_name());
224  $calitem_params[':first_instance_start'] = isset($range->from) ? $range->from->UTC() : null;
225  $calitem_params[':last_instance_end'] = isset($range->until) ? $range->until->UTC() : null;
226 
227  if ( $create_resource ) {
228  $sql = <<<EOSQL
229 INSERT INTO calendar_item (user_no, dav_name, dav_id, dav_etag, uid, dtstamp,
230  dtstart, dtend, summary, location, class, transp,
231  description, rrule, tz_id, last_modified, url, priority,
232  created, due, percent_complete, status, collection_id,
233  first_instance_start, last_instance_end )
234  VALUES ( :user_no, :dav_name, currval('dav_id_seq'), :etag, :uid, :dtstamp,
235  :dtstart, $dtend, :summary, :location, :class, :transp,
236  :description, :rrule, :tzid, :modified, :url, :priority,
237  :created, :due, :percent_complete, :status, $collection_id,
238  :first_instance_start, :last_instance_end)
239 EOSQL;
240  $sync_change = 201;
241  }
242  else {
243  $sql = <<<EOSQL
244 UPDATE calendar_item SET dav_etag=:etag, uid=:uid, dtstamp=:dtstamp,
245  dtstart=:dtstart, dtend=$dtend, summary=:summary, location=:location, class=:class, transp=:transp,
246  description=:description, rrule=:rrule, tz_id=:tzid, last_modified=:modified, url=:url, priority=:priority,
247  created=:created, due=:due, percent_complete=:percent_complete, status=:status,
248  first_instance_start=:first_instance_start, last_instance_end=:last_instance_end
249  WHERE user_no=:user_no AND dav_name=:dav_name
250 EOSQL;
251  $sync_change = 200;
252  }
253 
254  if ( !$this->IsSchedulingCollection() ) {
255  $this->WriteCalendarAlarms($dav_id, $vcal);
256  $this->WriteCalendarAttendees($dav_id, $vcal);
257  $put_action_type = ($create_resource ? 'INSERT' : 'UPDATE');
258  if ( $log_action && function_exists('log_caldav_action') ) {
259  log_caldav_action( $put_action_type, $first->GetPValue('UID'), $user_no, $collection_id, $path );
260  }
261  else if ( $log_action ) {
262  dbg_error_log( 'PUT', 'No log_caldav_action( %s, %s, %s, %s, %s) can be called.',
263  $put_action_type, $first->GetPValue('UID'), $user_no, $collection_id, $path );
264  }
265  }
266 
267  $qry = new AwlQuery( $sql, $calitem_params );
268  if ( !$qry->Exec('PUT',__LINE__,__FILE__) ) {
269  rollback_on_error( $caldav_context, $user_no, $path);
270  return false;
271  }
272  $qry->QDo("SELECT write_sync_change( $collection_id, $sync_change, :dav_name)", array(':dav_name' => $path ) );
273  if ( $existing_transaction_state == 0 ) $qry->Commit();
274 
275  dbg_error_log( 'PUT', 'User: %d, ETag: %s, Path: %s', $session->user_no, $etag, $path);
276 
277 
278  return $segment_name;
279  }
280 
296  function WriteMember( $resource, $create_resource, $segment_name = null, $log_action=true ) {
297  if ( ! $this->IsCollection() ) {
298  dbg_error_log( 'PUT', '"%s" is not a collection path', $this->dav_name);
299  return false;
300  }
301  if ( ! is_object($resource) ) {
302  dbg_error_log( 'PUT', 'No data supplied!' );
303  return false;
304  }
305 
306  if ( $resource instanceof vCalendar ) {
307  return $this->WriteCalendarMember($resource,$create_resource,true,$segment_name,$log_action);
308  }
309  else if ( $resource instanceof VCard )
310  trace_bug( "Calling undefined function WriteAddressbookMember!? Please report this to the davical project: davical-general@lists.sourceforge.net" );
311  return $this->WriteAddressbookMember($resource,$create_resource,$segment_name, $log_action);
312 
313  return $segment_name;
314  }
315 
316 
323  function WriteCalendarAlarms( $dav_id, vCalendar $vcal ) {
324  $qry = new AwlQuery('DELETE FROM calendar_alarm WHERE dav_id = '.$dav_id );
325  $qry->Exec('PUT',__LINE__,__FILE__);
326 
327  $components = $vcal->GetComponents();
328 
329  $qry->SetSql('INSERT INTO calendar_alarm ( dav_id, action, trigger, summary, description, component, next_trigger )
330  VALUES( '.$dav_id.', :action, :trigger, :summary, :description, :component,
331  :related::timestamp with time zone + :related_trigger::interval )' );
332  $qry->Prepare();
333  foreach( $components AS $component ) {
334  if ( $component->GetType() == 'VTIMEZONE' ) continue;
335  $alarms = $component->GetComponents('VALARM');
336  if ( count($alarms) < 1 ) return;
337 
338  foreach( $alarms AS $v ) {
339  $trigger = array_merge($v->GetProperties('TRIGGER'));
340  if ( $trigger == null ) continue; // Bogus data.
341  $trigger = $trigger[0];
342  $related = null;
343  $related_trigger = '0M';
344  $trigger_type = $trigger->GetParameterValue('VALUE');
345  if ( !isset($trigger_type) || $trigger_type == 'DURATION' ) {
346  switch ( $trigger->GetParameterValue('RELATED') ) {
347  case 'DTEND': $related = $component->GetPValue('DTEND'); break;
348  case 'DUE': $related = $component->GetPValue('DUE'); break;
349  default: $related = $component->GetPValue('DTSTART');
350  }
351  $duration = $trigger->Value();
352  if ( !preg_match('{^-?P(:?\d+W)?(:?\d+D)?(:?T(:?\d+H)?(:?\d+M)?(:?\d+S)?)?$}', $duration ) ) continue;
353  $minus = (substr($duration,0,1) == '-');
354  $related_trigger = trim(preg_replace( '#[PT-]#', ' ', $duration ));
355  if ($related_trigger == '') $related_trigger = '0 seconds';
356  if ( $minus ) {
357  $related_trigger = preg_replace( '{(\d+[WDHMS])}', '-$1 ', $related_trigger );
358  }
359  else {
360  $related_trigger = preg_replace( '{(\d+[WDHMS])}', '$1 ', $related_trigger );
361  }
362  }
363  else {
364  if ( false === strtotime($trigger->Value()) ) continue; // Invalid date.
365  }
366  $qry->Bind(':action', $v->GetPValue('ACTION'));
367  $qry->Bind(':trigger', $trigger->Render());
368  $qry->Bind(':summary', $v->GetPValue('SUMMARY'));
369  $qry->Bind(':description', $v->GetPValue('DESCRIPTION'));
370  $qry->Bind(':component', $v->Render());
371  $qry->Bind(':related', $related );
372  $qry->Bind(':related_trigger', $related_trigger );
373  $qry->Exec('PUT',__LINE__,__FILE__);
374  }
375  }
376  }
377 
378 
386  function WriteCalendarAttendees( $dav_id, vCalendar $vcal ) {
387  $qry = new AwlQuery('DELETE FROM calendar_attendee WHERE dav_id = '.$dav_id );
388  $qry->Exec('PUT',__LINE__,__FILE__);
389 
390  $attendees = $vcal->GetAttendees();
391  if ( count($attendees) < 1 ) return;
392 
393  $qry->SetSql('INSERT INTO calendar_attendee ( dav_id, status, partstat, cn, attendee, role, rsvp, property )
394  VALUES( '.$dav_id.', :status, :partstat, :cn, :attendee, :role, :rsvp, :property )' );
395  $qry->Prepare();
396  $processed = array();
397  foreach( $attendees AS $v ) {
398  $attendee = $v->Value();
399  if ( isset($processed[$attendee]) ) {
400  dbg_error_log( 'LOG', 'Duplicate attendee "%s" in resource "%d"', $attendee, $dav_id );
401  dbg_error_log( 'LOG', 'Original: "%s"', $processed[$attendee] );
402  dbg_error_log( 'LOG', 'Duplicate: "%s"', $v->Render() );
403  continue;
404  }
405  $qry->Bind(':attendee', $attendee );
406  $qry->Bind(':status', $v->GetParameterValue('STATUS') );
407  $qry->Bind(':partstat', $v->GetParameterValue('PARTSTAT') );
408  $qry->Bind(':cn', $v->GetParameterValue('CN') );
409  $qry->Bind(':role', $v->GetParameterValue('ROLE') );
410  $qry->Bind(':rsvp', $v->GetParameterValue('RSVP') );
411  $qry->Bind(':property', $v->Render() );
412  $qry->Exec('PUT',__LINE__,__FILE__);
413  $processed[$attendee] = $v->Render();
414  }
415  }
416 
424  function actualDeleteCalendarMember( $member_dav_name ) {
425  global $session, $caldav_context;
426 
427  // A quick sanity check...
428  $segment_name = str_replace( $this->dav_name(), '', $member_dav_name );
429  if ( strstr($segment_name, '/') !== false ) {
430  @dbg_error_log( "DELETE", "DELETE: Refused to delete member '%s' from calendar '%s'!", $member_dav_name, $this->dav_name() );
431  return false;
432  }
433 
434  // We need to serialise access to this process just for this collection
435  $cache = getCacheInstance();
436  $myLock = $cache->acquireLock('collection-'.$this->dav_name());
437 
438  $qry = new AwlQuery();
439  $params = array( ':dav_name' => $member_dav_name );
440 
441  if ( $qry->QDo("SELECT write_sync_change(collection_id, 404, caldav_data.dav_name) FROM caldav_data WHERE dav_name = :dav_name", $params )
442  && $qry->QDo("DELETE FROM property WHERE dav_name = :dav_name", $params )
443  && $qry->QDo("DELETE FROM locks WHERE dav_name = :dav_name", $params )
444  && $qry->QDo("DELETE FROM caldav_data WHERE dav_name = :dav_name", $params ) ) {
445  @dbg_error_log( "DELETE", "DELETE: Calendar member %s deleted from calendar '%s'", $member_dav_name, $this->dav_name() );
446 
447  $cache->releaseLock($myLock);
448 
449  return true;
450  }
451 
452  $cache->releaseLock($myLock);
453  return false;
454 
455  }
456 
457 
462  public function whatChangedSince( $some_old_token ) {
463  $params = array( ':collection_id' => $this->collection_id() );
464  if ( $some_old_token == 0 || empty($some_old_token) ) {
465  $sql = <<<EOSQL
466  SELECT calendar_item.*, caldav_data.*, addressbook_resource.*, 201 AS sync_status,
467  COALESCE(addressbook_resource.uid,calendar_item.uid) AS uid
468  FROM caldav_data
469  LEFT JOIN calendar_item USING (dav_id)
470  LEFT JOIN addressbook_resource USING (dav_id)
471  WHERE caldav_data.collection_id = :collection_id
472  ORDER BY caldav_data.collection_id, caldav_data.dav_id
473 EOSQL;
474  }
475  else {
476  $params[':sync_token'] = $some_old_token;
477  $sql = <<<EOSQL
478  SELECT calendar_item.*, caldav_data.*, addressbook_resource.*, sync_changes.*,
479  COALESCE(addressbook_resource.uid,calendar_item.uid) AS uid
480  FROM sync_changes
481  LEFT JOIN caldav_data USING (collection_id,dav_id)
482  LEFT JOIN calendar_item USING (collection_id,dav_id)
483  LEFT JOIN addressbook_resource USING (dav_id)
484  WHERE sync_changes.collection_id = :collection_id
485  AND sync_time >= (SELECT modification_time FROM sync_tokens WHERE sync_token = :sync_token)
486  ORDER BY sync_changes.collection_id, sync_changes.dav_id, sync_changes.sync_time
487 EOSQL;
488 
489  }
490  $qry = new AwlQuery($sql, $params );
491 
492  $changes = array();
493  if ( $qry->Exec('WritableCollection') && $qry->rows() ) {
494  while( $change = $qry->Fetch() ) {
495  $changes[$change->uid] = $change;
496  }
497  }
498 
499  return $changes;
500  }
501 }
WritableCollection
Definition: WritableCollection.php:4
DAVResource\dav_name
dav_name()
Definition: DAVResource.php:1227
WritableCollection\WriteMember
WriteMember( $resource, $create_resource, $segment_name=null, $log_action=true)
Definition: WritableCollection.php:296
WritableCollection\GetTZID
static GetTZID(vComponent $comp)
Definition: WritableCollection.php:11
VCard
Definition: vcard.php:9
DAVResource\sync_token
sync_token( $cachedOK=true)
Definition: DAVResource.php:1350
DAVResource\IsSchedulingCollection
IsSchedulingCollection( $type='any')
Definition: DAVResource.php:1137
DAVResource\IsCalendar
IsCalendar()
Definition: DAVResource.php:1116
DAVResource\IsCollection
IsCollection()
Definition: DAVResource.php:1100
DAVResource\url
url()
Definition: DAVResource.php:1215
DAVResource
Definition: DAVResource.php:24
DAVResource\IsPublicOnly
IsPublicOnly()
Definition: DAVResource.php:1379
WritableCollection\WriteCalendarAlarms
WriteCalendarAlarms( $dav_id, vCalendar $vcal)
Definition: WritableCollection.php:323
WritableCollection\actualDeleteCalendarMember
actualDeleteCalendarMember( $member_dav_name)
Definition: WritableCollection.php:424
WritableCollection\WriteCalendarMember
WriteCalendarMember(vCalendar $vcal, $create_resource, $do_scheduling=false, $segment_name=null, $log_action=false)
Definition: WritableCollection.php:33
DAVResource\collection_id
collection_id()
Definition: DAVResource.php:1292
WritableCollection\whatChangedSince
whatChangedSince( $some_old_token)
Definition: WritableCollection.php:462
DAVResource\user_no
user_no()
Definition: DAVResource.php:1283
WritableCollection\WriteCalendarAttendees
WriteCalendarAttendees( $dav_id, vCalendar $vcal)
Definition: WritableCollection.php:386
DAVResource\timezone_name
timezone_name()
Definition: DAVResource.php:1301