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_orig'] = $dtstart;
129  if ( (!isset($dtstart) || $dtstart == '') && $first->GetPValue('DUE') != '' ) {
130  $dtstart = $first->GetPValue('DUE');
131  }
132 
133  $dtend = $first->GetPValue('DTEND');
134  $calitem_params[':dtend_orig'] = $dtend;
135  if ( isset($dtend) && $dtend != '' ) {
136  dbg_error_log( 'PUT', ' DTEND: "%s", DTSTART: "%s", DURATION: "%s"', $dtend, $first->GetPValue('DTSTART'), $first->GetPValue('DURATION') );
137  $calitem_params[':dtend'] = $dtend;
138  $dtend = ':dtend';
139  }
140  else {
141  $dtend = 'NULL';
142  if ( $first->GetPValue('DURATION') != '' AND $dtstart != '' ) {
143  $duration = preg_replace( '#[PT]#', '', $first->GetPValue('DURATION') );
144  if ($duration == '') $duration = '0 seconds';
145  $dtend = '(:dtstart::timestamp with time zone + :duration::interval)';
146  $calitem_params[':duration'] = $duration;
147  }
148  elseif ( $first->GetType() == 'VEVENT' ) {
162  $value_type = $first->GetProperty('DTSTART')->GetParameterValue('VALUE');
163  dbg_error_log('PUT','DTSTART without DTEND. DTSTART value type is %s', $value_type );
164  if ( isset($value_type) && $value_type == 'DATE' )
165  $dtend = '(:dtstart::timestamp with time zone::date + \'1 day\'::interval)';
166  else
167  $dtend = ':dtstart';
168  }
169  }
170 
171  $last_modified = $first->GetPValue('LAST-MODIFIED');
172  if ( !isset($last_modified) || $last_modified == '' ) {
173  $last_modified = gmdate( 'Ymd\THis\Z' );
174  }
175  $calitem_params[':modified'] = $last_modified;
176 
177  $dtstamp = $first->GetPValue('DTSTAMP');
178  if ( !isset($dtstamp) || $dtstamp == '' ) {
179  $dtstamp = $last_modified;
180  }
181  $calitem_params[':dtstamp'] = $dtstamp;
182 
183  $class = $first->GetPValue('CLASS');
184  if ( $this->IsPublicOnly() && isset($class)) {
185  $class = 'PUBLIC';
186  }
187  $calitem_params[':class'] = $class;
188 
190  $last_olson = 'Turkmenikikamukau'; // I really hope this location doesn't exist!
191  $tzid = self::GetTZID($first);
192  if ( !empty($tzid) ) {
193  $tz = $vcal->GetTimeZone($tzid);
194  $olson = $vcal->GetOlsonName($tz);
195 
196  if ( !empty($olson) && ($olson != $last_olson) ) {
197  dbg_error_log( 'PUT', ' Setting timezone to %s', $olson );
198  $qry->QDo('SET TIMEZONE TO \''.$olson."'" );
199  $last_olson = $olson;
200  }
201  }
202 
203  $created = $first->GetPValue('CREATED');
204  if ( $created == '00001231T000000Z' ) $created = '20001231T000000Z';
205  $calitem_params[':created'] = $created;
206 
207  $calitem_params[':tzid'] = $tzid;
208  $calitem_params[':uid'] = $uid;
209  $calitem_params[':url'] = $first->GetPValue('URL');
210  $calitem_params[':due'] = $first->GetPValue('DUE');
211  $calitem_params[':rrule'] = $first->GetPValue('RRULE');
212  $calitem_params[':dtstart'] = $first->GetPValue('DTSTART');
213  $calitem_params[':summary'] = $first->GetPValue('SUMMARY');
214  $calitem_params[':location'] = $first->GetPValue('LOCATION');
215  $calitem_params[':transp'] = $first->GetPValue('TRANSP');
216  $calitem_params[':status'] = $first->GetPValue('STATUS');
217  $calitem_params[':priority'] = $first->GetPValue('PRIORITY');
218  $calitem_params[':description'] = $first->GetPValue('DESCRIPTION');
219  $calitem_params[':percent_complete'] = $first->GetPValue('PERCENT-COMPLETE');
220 
221  $range = getVCalendarRange($vcal, $this->timezone_name());
222  $calitem_params[':first_instance_start'] = isset($range->from) ? $range->from->UTC() : null;
223  $calitem_params[':last_instance_end'] = isset($range->until) ? $range->until->UTC() : null;
224 
225  if ( $create_resource ) {
226  $sql = <<<EOSQL
227 INSERT INTO calendar_item (user_no, dav_name, dav_id, dav_etag, uid, dtstamp,
228  dtstart, dtstart_orig, dtend, dtend_orig, summary, location, class, transp,
229  description, rrule, tz_id, last_modified, url, priority, created, due,
230  percent_complete, status, collection_id, first_instance_start,
231  last_instance_end )
232 VALUES ( :user_no, :dav_name, currval('dav_id_seq'), :etag, :uid, :dtstamp,
233  :dtstart, :dtstart_orig, $dtend, :dtend_orig, :summary, :location, :class,
234  :transp, :description, :rrule, :tzid, :modified, :url, :priority,
235  :created, :due, :percent_complete, :status, $collection_id,
236  :first_instance_start, :last_instance_end)
237 EOSQL;
238  $sync_change = 201;
239  }
240  else {
241  $sql = <<<EOSQL
242 UPDATE calendar_item SET dav_etag=:etag, uid=:uid, dtstamp=:dtstamp,
243  dtstart=:dtstart, dtstart_orig=:dtstart_orig, dtend=$dtend,
244  dtend_orig=:dtend_orig, summary=:summary, location=:location, class=:class,
245  transp=:transp, description=:description, rrule=:rrule, tz_id=:tzid,
246  last_modified=:modified, url=:url, priority=:priority, created=:created,
247  due=:due, percent_complete=:percent_complete, status=:status,
248  first_instance_start=:first_instance_start,
249  last_instance_end=:last_instance_end
250 WHERE user_no=:user_no AND dav_name=:dav_name
251 EOSQL;
252  $sync_change = 200;
253  }
254 
255  if ( !$this->IsSchedulingCollection() ) {
256  $this->WriteCalendarAlarms($dav_id, $vcal);
257  $this->WriteCalendarAttendees($dav_id, $vcal);
258  $put_action_type = ($create_resource ? 'INSERT' : 'UPDATE');
259  if ( $log_action && function_exists('log_caldav_action') ) {
260  log_caldav_action( $put_action_type, $first->GetPValue('UID'), $user_no, $collection_id, $path );
261  }
262  else if ( $log_action ) {
263  dbg_error_log( 'PUT', 'No log_caldav_action( %s, %s, %s, %s, %s) can be called.',
264  $put_action_type, $first->GetPValue('UID'), $user_no, $collection_id, $path );
265  }
266  }
267 
268  $qry = new AwlQuery( $sql, $calitem_params );
269  if ( !$qry->Exec('PUT',__LINE__,__FILE__) ) {
270  rollback_on_error( $caldav_context, $user_no, $path);
271  return false;
272  }
273  $qry->QDo("SELECT write_sync_change( $collection_id, $sync_change, :dav_name)", array(':dav_name' => $path ) );
274  if ( $existing_transaction_state == 0 ) $qry->Commit();
275 
276  dbg_error_log( 'PUT', 'User: %d, ETag: %s, Path: %s', $session->user_no, $etag, $path);
277 
278 
279  return $segment_name;
280  }
281 
297  function WriteMember( $resource, $create_resource, $segment_name = null, $log_action=true ) {
298  if ( ! $this->IsCollection() ) {
299  dbg_error_log( 'PUT', '"%s" is not a collection path', $this->dav_name);
300  return false;
301  }
302  if ( ! is_object($resource) ) {
303  dbg_error_log( 'PUT', 'No data supplied!' );
304  return false;
305  }
306 
307  if ( $resource instanceof vCalendar ) {
308  return $this->WriteCalendarMember($resource,$create_resource,true,$segment_name,$log_action);
309  }
310  else if ( $resource instanceof VCard )
311  trace_bug( "Calling undefined function WriteAddressbookMember!? Please report this to the davical project: davical-general@lists.sourceforge.net" );
312  return $this->WriteAddressbookMember($resource,$create_resource,$segment_name, $log_action);
313 
314  return $segment_name;
315  }
316 
317 
324  function WriteCalendarAlarms( $dav_id, vCalendar $vcal ) {
325  $qry = new AwlQuery('DELETE FROM calendar_alarm WHERE dav_id = '.$dav_id );
326  $qry->Exec('PUT',__LINE__,__FILE__);
327 
328  $components = $vcal->GetComponents();
329 
330  $qry->SetSql('INSERT INTO calendar_alarm ( dav_id, count, action, trigger, summary, description, component, next_trigger )
331  VALUES( '.$dav_id.', :count, :action, :trigger, :summary, :description, :component,
332  :related::timestamp with time zone + :related_trigger::interval )' );
333  $qry->Prepare();
334  $count = 0;
335  foreach( $components AS $component ) {
336  if ( $component->GetType() == 'VTIMEZONE' ) continue;
337  $alarms = $component->GetComponents('VALARM');
338  if ( count($alarms) < 1 ) return;
339 
340  foreach( $alarms AS $v ) {
341  $trigger = array_merge($v->GetProperties('TRIGGER'));
342  if ( $trigger == null ) continue; // Bogus data.
343  $trigger = $trigger[0];
344  $related = null;
345  $related_trigger = '0M';
346  $trigger_type = $trigger->GetParameterValue('VALUE');
347  if ( !isset($trigger_type) || $trigger_type == 'DURATION' ) {
348  switch ( $trigger->GetParameterValue('RELATED') ) {
349  case 'DTEND': $related = $component->GetPValue('DTEND'); break;
350  case 'DUE': $related = $component->GetPValue('DUE'); break;
351  default: $related = $component->GetPValue('DTSTART');
352  }
353  $duration = $trigger->Value();
354  if ( !preg_match('{^-?P(:?\d+W)?(:?\d+D)?(:?T(:?\d+H)?(:?\d+M)?(:?\d+S)?)?$}', $duration ) ) continue;
355  $minus = (substr($duration,0,1) == '-');
356  $related_trigger = trim(preg_replace( '#[PT-]#', ' ', $duration ));
357  if ($related_trigger == '') $related_trigger = '0 seconds';
358  if ( $minus ) {
359  $related_trigger = preg_replace( '{(\d+[WDHMS])}', '-$1 ', $related_trigger );
360  }
361  else {
362  $related_trigger = preg_replace( '{(\d+[WDHMS])}', '$1 ', $related_trigger );
363  }
364  }
365  else {
366  if ( false === strtotime($trigger->Value()) ) continue; // Invalid date.
367  }
368  $qry->Bind(':action', $v->GetPValue('ACTION'));
369  $qry->Bind(':trigger', $trigger->Render());
370  $qry->Bind(':summary', $v->GetPValue('SUMMARY'));
371  $qry->Bind(':description', $v->GetPValue('DESCRIPTION'));
372  $qry->Bind(':component', $v->Render());
373  $qry->Bind(':related', $related );
374  $qry->Bind(':related_trigger', $related_trigger );
375  $qry->Bind(':count', $count++ );
376  $qry->Exec('PUT',__LINE__,__FILE__);
377  }
378  }
379  }
380 
381 
389  function WriteCalendarAttendees( $dav_id, vCalendar $vcal ) {
390  $qry = new AwlQuery('DELETE FROM calendar_attendee WHERE dav_id = '.$dav_id );
391  $qry->Exec('PUT',__LINE__,__FILE__);
392 
393  $attendees = $vcal->GetAttendees();
394  if ( count($attendees) < 1 ) return;
395 
396  $qry->SetSql('INSERT INTO calendar_attendee ( dav_id, status, partstat, cn, attendee, role, rsvp, property )
397  VALUES( '.$dav_id.', :status, :partstat, :cn, :attendee, :role, :rsvp, :property )' );
398  $qry->Prepare();
399  $processed = array();
400  foreach( $attendees AS $v ) {
401  $attendee = $v->Value();
402  if ( isset($processed[$attendee]) ) {
403  dbg_error_log( 'LOG', 'Duplicate attendee "%s" in resource "%d"', $attendee, $dav_id );
404  dbg_error_log( 'LOG', 'Original: "%s"', $processed[$attendee] );
405  dbg_error_log( 'LOG', 'Duplicate: "%s"', $v->Render() );
406  continue;
407  }
408  $qry->Bind(':attendee', $attendee );
409  $qry->Bind(':status', $v->GetParameterValue('STATUS') );
410  $qry->Bind(':partstat', $v->GetParameterValue('PARTSTAT') );
411  $qry->Bind(':cn', $v->GetParameterValue('CN') );
412  $qry->Bind(':role', $v->GetParameterValue('ROLE') );
413  $qry->Bind(':rsvp', $v->GetParameterValue('RSVP') );
414  $qry->Bind(':property', $v->Render() );
415  $qry->Exec('PUT',__LINE__,__FILE__);
416  $processed[$attendee] = $v->Render();
417  }
418  }
419 
427  function actualDeleteCalendarMember( $member_dav_name ) {
428  global $session, $caldav_context;
429 
430  // A quick sanity check...
431  $segment_name = str_replace( $this->dav_name(), '', $member_dav_name );
432  if ( strstr($segment_name, '/') !== false ) {
433  @dbg_error_log( "DELETE", "DELETE: Refused to delete member '%s' from calendar '%s'!", $member_dav_name, $this->dav_name() );
434  return false;
435  }
436 
437  // We need to serialise access to this process just for this collection
438  $cache = getCacheInstance();
439  $myLock = $cache->acquireLock('collection-'.$this->dav_name());
440 
441  $qry = new AwlQuery();
442  $params = array( ':dav_name' => $member_dav_name );
443 
444  if ( $qry->QDo("SELECT write_sync_change(collection_id, 404, caldav_data.dav_name) FROM caldav_data WHERE dav_name = :dav_name", $params )
445  && $qry->QDo("DELETE FROM property WHERE dav_name = :dav_name", $params )
446  && $qry->QDo("DELETE FROM locks WHERE dav_name = :dav_name", $params )
447  && $qry->QDo("DELETE FROM caldav_data WHERE dav_name = :dav_name", $params ) ) {
448  @dbg_error_log( "DELETE", "DELETE: Calendar member %s deleted from calendar '%s'", $member_dav_name, $this->dav_name() );
449 
450  $cache->releaseLock($myLock);
451 
452  return true;
453  }
454 
455  $cache->releaseLock($myLock);
456  return false;
457 
458  }
459 
460 
465  public function whatChangedSince( $some_old_token ) {
466  $params = array( ':collection_id' => $this->collection_id() );
467  if ( $some_old_token == 0 || empty($some_old_token) ) {
468  $sql = <<<EOSQL
469  SELECT calendar_item.*, caldav_data.*, addressbook_resource.*, 201 AS sync_status,
470  COALESCE(addressbook_resource.uid,calendar_item.uid) AS uid
471  FROM caldav_data
472  LEFT JOIN calendar_item USING (dav_id)
473  LEFT JOIN addressbook_resource USING (dav_id)
474  WHERE caldav_data.collection_id = :collection_id
475  ORDER BY caldav_data.collection_id, caldav_data.dav_id
476 EOSQL;
477  }
478  else {
479  $params[':sync_token'] = $some_old_token;
480  $sql = <<<EOSQL
481  SELECT calendar_item.*, caldav_data.*, addressbook_resource.*, sync_changes.*,
482  COALESCE(addressbook_resource.uid,calendar_item.uid) AS uid
483  FROM sync_changes
484  LEFT JOIN caldav_data USING (collection_id,dav_id)
485  LEFT JOIN calendar_item USING (collection_id,dav_id)
486  LEFT JOIN addressbook_resource USING (dav_id)
487  WHERE sync_changes.collection_id = :collection_id
488  AND sync_time >= (SELECT modification_time FROM sync_tokens WHERE sync_token = :sync_token)
489  ORDER BY sync_changes.collection_id, sync_changes.dav_id, sync_changes.sync_time
490 EOSQL;
491 
492  }
493  $qry = new AwlQuery($sql, $params );
494 
495  $changes = array();
496  if ( $qry->Exec('WritableCollection') && $qry->rows() ) {
497  while( $change = $qry->Fetch() ) {
498  $changes[$change->uid] = $change;
499  }
500  }
501 
502  return $changes;
503  }
504 }
WriteCalendarAlarms( $dav_id, vCalendar $vcal)
static GetTZID(vComponent $comp)
IsSchedulingCollection( $type='any')
WriteCalendarMember(vCalendar $vcal, $create_resource, $do_scheduling=false, $segment_name=null, $log_action=false)
WriteMember( $resource, $create_resource, $segment_name=null, $log_action=true)
whatChangedSince( $some_old_token)
sync_token( $cachedOK=true)
actualDeleteCalendarMember( $member_dav_name)
WriteCalendarAttendees( $dav_id, vCalendar $vcal)
Definition: vcard.php:9