protected function DefaultParser::parseFeed

Parses a feed and stores its items.

Parameters

string $data: The feed data.

\Drupal\aggregator\Plugin\Core\Entity\Feed $feed: An object describing the feed to be parsed.

Return value

bool FALSE on error, TRUE otherwise.

File

drupal/core/modules/aggregator/lib/Drupal/aggregator/Plugin/aggregator/parser/DefaultParser.php, line 113

Contains \Drupal\aggregator\Plugin\aggregator\parser\DefaultParser.

Class

DefaultParser

Defines a default parser implementation.

Namespace

Code

protected function parseFeed(&$data, Feed $feed) {

  // Parse the data.
  $xml_parser = drupal_xml_parser_create($data);
  xml_set_element_handler($xml_parser, array(
    $this,
    'elementStart',
  ), array(
    $this,
    'elementEnd',
  ));
  xml_set_character_data_handler($xml_parser, array(
    $this,
    'elementData',
  ));
  if (!xml_parse($xml_parser, $data, 1)) {
    watchdog('aggregator', 'The feed from %site seems to be broken due to an error "%error" on line %line.', array(
      '%site' => $feed
        ->label(),
      '%error' => xml_error_string(xml_get_error_code($xml_parser)),
      '%line' => xml_get_current_line_number($xml_parser),
    ), WATCHDOG_WARNING);
    drupal_set_message(t('The feed from %site seems to be broken because of error "%error" on line %line.', array(
      '%site' => $feed
        ->label(),
      '%error' => xml_error_string(xml_get_error_code($xml_parser)),
      '%line' => xml_get_current_line_number($xml_parser),
    )), 'error');
    return FALSE;
  }
  xml_parser_free($xml_parser);

  // We reverse the array such that we store the first item last, and the last
  // item first. In the database, the newest item should be at the top.
  $this->items = array_reverse($this->items);

  // Initialize items array.
  $feed->items = array();
  foreach ($this->items as $item) {

    // Prepare the item:
    foreach ($item as $key => $value) {
      $item[$key] = trim($value);
    }

    // Resolve the item's title. If no title is found, we use up to 40
    // characters of the description ending at a word boundary, but not
    // splitting potential entities.
    if (!empty($item['title'])) {
      $item['title'] = $item['title'];
    }
    elseif (!empty($item['description'])) {
      $item['title'] = preg_replace('/^(.*)[^\\w;&].*?$/', "\\1", truncate_utf8($item['description'], 40));
    }
    else {
      $item['title'] = '';
    }

    // Resolve the items link.
    if (!empty($item['link'])) {
      $item['link'] = $item['link'];
    }
    else {
      $item['link'] = $feed->link->value;
    }

    // Atom feeds have an ID tag instead of a GUID tag.
    if (!isset($item['guid'])) {
      $item['guid'] = isset($item['id']) ? $item['id'] : '';
    }

    // Atom feeds have a content and/or summary tag instead of a description tag.
    if (!empty($item['content:encoded'])) {
      $item['description'] = $item['content:encoded'];
    }
    elseif (!empty($item['summary'])) {
      $item['description'] = $item['summary'];
    }
    elseif (!empty($item['content'])) {
      $item['description'] = $item['content'];
    }

    // Try to resolve and parse the item's publication date.
    $date = '';
    foreach (array(
      'pubdate',
      'dc:date',
      'dcterms:issued',
      'dcterms:created',
      'dcterms:modified',
      'issued',
      'created',
      'modified',
      'published',
      'updated',
    ) as $key) {
      if (!empty($item[$key])) {
        $date = $item[$key];
        break;
      }
    }
    $item['timestamp'] = strtotime($date);
    if ($item['timestamp'] === FALSE) {
      $item['timestamp'] = $this
        ->parseW3cdtf($date);

      // Aggregator_parse_w3cdtf() returns FALSE on failure.
    }

    // Resolve dc:creator tag as the item author if author tag is not set.
    if (empty($item['author']) && !empty($item['dc:creator'])) {
      $item['author'] = $item['dc:creator'];
    }
    $item += array(
      'author' => '',
      'description' => '',
    );

    // Store on $feed object. This is where processors will look for parsed items.
    $feed->items[] = $item;
  }
  return TRUE;
}