ParserVcalendar.inc 15.9 KB
Newer Older
Robert Rollins's avatar
Robert Rollins committed
1 2 3 4 5 6 7 8
<?php
/**
 * @file
 * Defines a class that parses iCalcreator vcalendar objects into
 * Feeds-compatible data arrays.
 */

class ParserVcalendar {
9 10 11
  /**
   * Variables used for parsing.
   */
Robert Rollins's avatar
Robert Rollins committed
12 13
  protected $calendar;
  protected $source;
14
  protected $fetcherResult;
Robert Rollins's avatar
Robert Rollins committed
15 16 17
  protected $config;
  protected $timezones = array();
  protected $xtimezone;
18 19 20 21 22 23 24
  
  /**
   * Variables used for batch processing.
   */
  protected $totalComponents = 0;
  protected $lastComponentParsed = 0;
  
25 26 27
  /**
   * Constructor.
   */
Robert Rollins's avatar
Robert Rollins committed
28 29 30
  public function __construct($calendar, $source, $fetcher_result, $config) {
    $this->calendar = $calendar;
    $this->source = $source;
31
    $this->fetcherResult = $fetcher_result;
Robert Rollins's avatar
Robert Rollins committed
32 33 34 35 36 37
    $this->config = $config;
  }

  /**
   * Parses the vcalendar object into an array of event data arrays.
   *
38
   * @param int $offset
39
   *   Specifies which section of the feed to start parsing at.
40 41
   *
   * @param int $limit
42
   *   Specifies how many components to parse on this run.
43
   *
Robert Rollins's avatar
Robert Rollins committed
44
   * @return array
45
   *   An array of parsed event data keyed by the same strings as the array
46
   *   returned by DateiCalFeedsParser::getiCalMappingSources().
Robert Rollins's avatar
Robert Rollins committed
47
   */
48
  public function parse($offset, $limit) {
Robert Rollins's avatar
Robert Rollins committed
49 50 51 52 53 54 55 56 57 58 59 60
    // Sometimes, the feed will set a timezone for every event in the calendar
    // using the non-standard X-WR-TIMEZONE property. Date iCal uses this
    // timezone only if the date property is not in UTC and has no TZID.
    $xtimezone = $this->calendar->getProperty('X-WR-TIMEZONE');
    if (!empty($xtimezone[1])) {
      // Allow modules to alter the timezone string before it gets converted
      // into a DateTimeZone.
      $context = array(
        'property_key' => NULL,
        'calendar_component' => NULL,
        'calendar' => $this->calendar,
        'feeeds_source' => $this->source,
61
        'feeds_fetcher_result' => $this->fetcherResult,
Robert Rollins's avatar
Robert Rollins committed
62 63 64 65 66 67 68 69 70
      );
      drupal_alter('date_ical_import_timezone', $xtimezone[1], $context);
      $this->xtimezone = $this->_tzid_to_datetimezone($xtimezone[1]);
    }

    // Collect the timezones into an array, for easier access.
    while ($component = $this->calendar->getComponent('VTIMEZONE')) {
      $this->timezones[] = $component;
    }
71 72 73
    
    // Collect each component, so we can batch them properly in the next loop.
    $raw_components = array();
74 75 76
    $types = array('VEVENT', 'VTODO', 'VJOURNAL', 'VFREEBUSY', 'VALARM');
    foreach ($types as $type) {
      while ($vcalendar_component = $this->calendar->getComponent($type)) {
Robert Rollins's avatar
Robert Rollins committed
77 78 79 80 81
        // Allow modules to alter the vcalendar component before we parse it
        // into a Feeds-compatible data array.
        $context = array(
          'calendar' => $this->calendar,
          'source' => $this->source,
82
          'fetcher_result' => $this->fetcherResult,
Robert Rollins's avatar
Robert Rollins committed
83 84
        );
        drupal_alter('date_ical_import_component', $vcalendar_component, $context);
85
        $raw_components[] = $vcalendar_component;
Robert Rollins's avatar
Robert Rollins committed
86 87
      }
    }
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
    
    // Store this for use by DateiCalFeedsParser's batch processing code.
    $this->totalComponents = count($raw_components);
    
    // Parse each raw component in the current batch into a Feeds-compatible
    // event data array.
    $events = array();
    $sources = DateiCalFeedsParser::getiCalMappingSources();
    $batch = array_slice($raw_components, $offset, $limit, TRUE);
    foreach ($batch as $ndx => $raw_component) {
      $parsed_component = array();
      foreach ($sources as $property_key => $data) {
        $handler = $data['date_ical_parse_handler'];
        $parsed_component[$property_key] = $this->$handler($property_key, $raw_component);
      }
      $events[] = $parsed_component;
      // The indices of the original $raw_components array are preserved in
      // $batch, so using the $ndx value here lets us communicate our progress
106
      // through the full collection of components.
107 108 109
      $this->lastComponentParsed = $ndx;
    }
    
Robert Rollins's avatar
Robert Rollins committed
110 111
    return $events;
  }
112
  
113 114 115
  /**
   * Getter for the protected totalComponents property.
   */
116 117 118 119
  public function getTotalComponents() {
    return $this->totalComponents;
  }
  
120 121 122
  /**
   * Getter for the protected lastComponentParsed property.
   */
123 124 125 126
  public function getLastComponentParsed() {
    return $this->lastComponentParsed;
  }
  
Robert Rollins's avatar
Robert Rollins committed
127 128 129 130
  /**
   * Parses text fields.
   *
   * @return string
131
   *   The parsed text property.
Robert Rollins's avatar
Robert Rollins committed
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
   */
  public function parseTextProperty($property_key, $vcalendar_component) {
    $text = $vcalendar_component->getProperty($property_key);
    if ($text === FALSE) {
      if ($property_key == 'SUMMARY') {
        $uid = $vcalendar_component->getProperty('UID');
        throw new DateIcalParseException(t('The component with UID %uid is invalid because it has no SUMMARY (nodes require a title).', array('%uid' => $uid)));
      }
      // If the component doesn't have this property, return NULL.
      return NULL;
    }
    // Convert literal \n and \N into newline characters.
    $text = str_replace(array('\n', '\N'), "\n", $text);
    return $text;
  }

  /**
   * Parses field parameters.
   *
   * @return string
152
   *   The parsed field parameter.
Robert Rollins's avatar
Robert Rollins committed
153 154 155 156 157 158 159 160
   */
  public function parsePropertyParameter($property_key, $vcalendar_component) {
    list($key, $attr) = explode(':', $property_key);
    $property = $vcalendar_component->getProperty($key, FALSE, TRUE);
    if ($property === FALSE) {
      // If the component doesn't have this property, return NULL.
      return NULL;
    }
161
    return isset($property['params'][$attr]) ? $property['params'][$attr] : '';
Robert Rollins's avatar
Robert Rollins committed
162 163 164
  }

  /**
165
   * Parses DATE-TIME and DATE fields.
Robert Rollins's avatar
Robert Rollins committed
166 167
   *
   * @return FeedsDateTime
168
   *   The parsed datetime object.
Robert Rollins's avatar
Robert Rollins committed
169 170 171 172 173 174 175
   */
  public function parseDateTimeProperty($property_key, $vcalendar_component) {
    $property = $vcalendar_component->getProperty($property_key, FALSE, TRUE);
    // Gather all the other date properties, so we can work with them later.
    $duration = $vcalendar_component->getProperty('DURATION', FALSE, TRUE);
    $dtstart = $vcalendar_component->getProperty('DTSTART', FALSE, TRUE);
    $uid = $vcalendar_component->getProperty('UID');
176
    
177
    // DATE-type properties are treated as All Day events which can span over
178 179 180 181 182 183 184
    // multiple days.
    // The Date module's All Day event handling was never finalized
    // (http://drupal.org/node/874322), which requires us to do some some
    // special coddling later.
    $is_all_day = (isset($property['params']['VALUE']) && $property['params']['VALUE'] == 'DATE');
    
    // Cover various conditions in which either DTSTART or DTEND are not set.
Robert Rollins's avatar
Robert Rollins committed
185
    if ($property === FALSE) {
186
      // When DTEND isn't defined, we may need to emulate it.
Robert Rollins's avatar
Robert Rollins committed
187
      if ($property_key == 'DTEND') {
188 189 190 191 192
        // Unset DTENDs need to emulate the DATE type from DTSTART.
        $is_all_day = (isset($dtstart['params']['VALUE']) && $dtstart['params']['VALUE'] == 'DATE');
        
        if ($duration !== FALSE) {
          // If a DURATION is defined, emulate DTEND as DTSTART + DURATION.
193
          $property = array(
194 195 196 197
            'value' => iCalUtilityFunctions::_duration2date($dtstart['value'], $duration['value']),
            'params' => $dtstart['params'],
          );
        }
198
        elseif ($is_all_day) {
199 200
          // If this is an all-day event with no end or duration, treat this
          // as a single-day event by emulating DTEND as 1 day after DTSTART.
201 202
          $property = $dtstart;
          $property['value']['day'] = $dtstart['value']['day'] + 1;
203 204 205 206 207
        }
        else {
          // This event has no end date.
          return NULL;
        }
Robert Rollins's avatar
Robert Rollins committed
208
      }
209
      elseif ($property_key == 'DTSTART') {
210
        // DTSTART can only be legally unset in non-VEVENT components.
Robert Rollins's avatar
Robert Rollins committed
211 212 213 214 215 216 217 218
        if ($vcalendar_component->objName == 'vevent') {
          throw new DateIcalParseException(t('Feed import failed! The VEVENT with UID %uid is invalid: it has no DTSTART.', array('%uid' => $uid)));
        }
        else {
          return NULL;
        }
      }
    }
219 220 221 222 223
    
    // When iCalcreator parses a UTC date (one that ends with Z) from an iCal
    // feed, it stores that 'Z' into the $property['value']['tz'] value.
    if (isset($property['value']['tz'])) {
      $property['params']['TZID'] = 'UTC';
Robert Rollins's avatar
Robert Rollins committed
224
    }
225 226
    
    if ($is_all_day) {
Robert Rollins's avatar
Robert Rollins committed
227 228
      if ($property_key == 'DTEND') {
        if ($dtstart === FALSE) {
229 230
          // This will almost certainly never happen, but the error message in
          // this would be incomprehensible without this check.
Robert Rollins's avatar
Robert Rollins committed
231 232 233 234
          throw new DateIcalParseException(t('Feed import failed! The event with UID %uid is invalid: it has a DTEND but no DTSTART!', array('%uid' => $uid)));
        }

        if (module_exists('date_all_day')) {
235 236 237 238
          // If the Date All Day module is installed, single-day All Day events
          // will be displayed wrong unless we ignore the DTEND value. Yes, that
          // means we may be ignoring work done in other parts of this function,
          // but we need that work for when Date All Day isn't installed.
Robert Rollins's avatar
Robert Rollins committed
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
          $prev_day = iCalUtilityFunctions::_duration2date($property['value'], array('day' => -1));
          if ($dtstart['value'] == $prev_day) {
            return NULL;
          }
          else {
            // If Date All Day is installed and this All Day event spans
            // multiple days, we need to rewind the DTEND by one day, because
            // of the problem with FeedsDateTime mentioned below.
            $property['value'] = $prev_day;
          }
        }
      }

      // FeedsDateTime->setTimezone() ignores timezone changes made to dates
      // with no time element, which means we can't compensate for the Date
254 255 256
      // module's automatic timezone conversion when it writes to the DB. To
      // get around that, we must add 00:00:00 explicitly, even though this
      // causes other problems (see above and below).
Robert Rollins's avatar
Robert Rollins committed
257 258
      $date_string = sprintf('%d-%d-%d 00:00:00', $property['value']['year'], $property['value']['month'], $property['value']['day']);
      // Use the server's timezone rather than letting it default to UTC.
259 260 261 262 263 264 265 266 267
      // This will help ensure that the date value doesn't get messed up when
      // Date converts its timezone as it's read from the database.
      // This is *essential* for All Day events, because Date stores them as
      // '2013-10-03 00:00:00' in the database, rather than doing the sensible
      // thing and storing them as '2013-10-03'.
      // NOTE TO MAINTAINERS:
      // This will not work properly if the site is configured to allow users
      // to set their own timezone. Unfortunately, there isn't anything that
      // Date iCal can do about that, as far as I can tell. -- coredumperror
Robert Rollins's avatar
Robert Rollins committed
268 269 270 271 272
      $datetimezone = new DateTimeZone(date_default_timezone_get());
    }
    else {
      // This is a DATE-TIME property.
      $date_string = iCalUtilityFunctions::_format_date_time($property['value']);
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
      
      // Allow modules to alter the timezone string. This also allows for
      // setting a TZID when one was not originally set for this property.
      $tzid = isset($property['params']['TZID']) ? $property['params']['TZID'] : NULL;
      $context = array(
        'property_key' => $property_key,
        'calendar_component' => $vcalendar_component,
        'calendar' => $this->calendar,
        'feeeds_source' => $this->source,
        'feeds_fetcher_result' => $this->fetcherResult,
      );
      drupal_alter('date_ical_import_timezone', $tzid, $context);
      
      if (isset($tzid)) {
        $datetimezone = $this->_tzid_to_datetimezone($tzid);
Robert Rollins's avatar
Robert Rollins committed
288
      }
289
      elseif (isset($this->xtimezone)) {
Robert Rollins's avatar
Robert Rollins committed
290 291 292 293 294
        // No timezone was set on the parsed date property, so if a timezone
        // was detected for the entire iCal feed, use it.
        $datetimezone = $this->xtimezone;
      }
      else {
295 296
        $msg = t("No timezone was detected for one or more of the events in this feed, forcing Date iCal to use this server's timezone as a fallback.<br>
            To make timezone-less events use a different timezone, implement hook_date_ical_import_timezone_alter() in a custom module.");
297 298 299
        drupal_set_message($msg, 'status', FALSE);
        $this->source->log('parse', $msg, array(), WATCHDOG_NOTICE);
        $datetimezone = new DateTimeZone(date_default_timezone_get());
Robert Rollins's avatar
Robert Rollins committed
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
      }
    }

    return new FeedsDateTime($date_string, $datetimezone);
  }

  /**
   * Parses multi-value fields, like the CATEGORIES component.
   *
   * @return array
   *   An array of strings contaning the individual values.
   */
  public function parseMultivalueProperty($property_key, $vcalendar_component) {
    // Since we're not telling it to give us the params data, $property will
    // be either FALSE, a string, or an array of strings.
    $property = $vcalendar_component->getProperty($property_key);
    if (empty($property)) {
      // If this multi-value property is being mapped to a Taxonomy field,
      // Feeds will interpret anything besides empty array as an array of
      // empty values (e.g. array('')). This will create a term for that
      // empty value, rather than leaving the field blank.
      return array();
    }
    if (!is_array($property)) {
      $property = array($property);
    }
    return $property;
  }

  /**
   * Format RRULEs, which specify when and how often the event is repeated.
   *
   * @return string
   *   An RRULE string, with EXDATE and RDATE values separated by \n.
   *   This is to make the RRULE compatible with date_repeat_split_rrule().
   */
  public function parseRepeatProperty($property_key, $vcalendar_component) {
    if ($vcalendar_component->getProperty($property_key) === FALSE) {
      return NULL;
    }

    // Due to a few bugs and limitations with Date Repeat, we need to massage
    // the RRULE a bit.
    if (count($vcalendar_component->rrule) > 1) {
      drupal_set_message(t('The event with UID %uid has multiple RRULEs, but the Date Repeat module only supports one. Only the first RRULE in the event will be used.<br>
          If your events need to have a complex repeat pattern, using RDATEs should help.',
346 347 348 349 350
        array('%uid' => $vcalendar_component->getProperty('UID'))), 'warning'
      );
      // Date Repeat will get extremely confused if it's sent multiple RRULE
      // values, so we need to manually pare it down to only the first one.
      $vcalendar_component->rrule = array($vcalendar_component->rrule[0]);
Robert Rollins's avatar
Robert Rollins committed
351 352 353 354 355 356 357 358
    }
    foreach ($vcalendar_component->rrule as $ndx => &$rrule_data) {
      // RRULEs must have an INTERVAL, or Date Repeat will throw errors.
      if (!isset($rrule_data['value']['INTERVAL'])) {
        $rrule_data['value']['INTERVAL'] = '1';
      }

      if (!isset($rrule_data['value']['COUNT']) && !isset($rrule_data['value']['UNTIL'])) {
359 360
        drupal_set_message(t("The event with UID %uid has an indefinitely repeating RRULE, which the Date Repeat module doesn't support.<br>
            As a workaround, Date iCal set the repeat count to @count. This value can be customized in the iCal parser settings.",
Robert Rollins's avatar
Robert Rollins committed
361 362 363 364 365 366 367 368 369 370 371 372
          array('%uid' => $vcalendar_component->getProperty('UID'), '@count' => $this->config['indefinite_count'])), 'warning'
        );
        $rrule_data['value']['COUNT'] = $this->config['indefinite_count'];
      }
    }

    $rrule = trim($vcalendar_component->createRrule());
    $exdate = trim($vcalendar_component->createExdate());
    $rdate = trim($vcalendar_component->createRdate());
    return "$rrule\n$exdate\n$rdate";
  }

373 374 375
  /**
   * Internal helper function for creating DateTimeZone objects.
   */
Robert Rollins's avatar
Robert Rollins committed
376 377 378 379 380
  protected function _tzid_to_datetimezone($tzid) {
    try {
      $datetimezone = new DateTimeZone($tzid);
    }
    catch (Exception $e) {
381
      $link = l(t('here'), 'http://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List', array('absolute' => TRUE));
Robert Rollins's avatar
Robert Rollins committed
382 383 384 385 386 387 388
      $msg = t(
          '"@tz" is not a valid timezone (see the TZ column !here), so Date iCal used UTC (which is probably wrong!).<br>
          Try implementing hook_date_ical_import_timezone_alter() in a custom module to fix this problem.',
          array('@tz' => $tzid, '!here' => $link)
      );
      $this->source->log('parse', $msg, array(), WATCHDOG_WARNING);
      drupal_set_message($msg, 'warning', FALSE);
389
      $datetimezone = new DateTimeZone('UTC');
Robert Rollins's avatar
Robert Rollins committed
390 391 392 393
    }
    return $datetimezone;
  }
}