aggregator.module 7.82 KB
Newer Older
1
<?php
Dries's avatar
Dries committed
2

Dries's avatar
Dries committed
3 4
/**
 * @file
5
 * Used to aggregate syndicated content (RSS, RDF, and Atom).
Dries's avatar
Dries committed
6 7
 */

8
use Drupal\aggregator\Entity\Feed;
9
use Drupal\Component\Utility\Xss;
10
use Drupal\Core\Routing\RouteMatchInterface;
11

12 13 14
/**
 * Denotes that a feed's items should never expire.
 */
15
const AGGREGATOR_CLEAR_NEVER = 0;
16

Dries's avatar
Dries committed
17
/**
18
 * Implements hook_help().
Dries's avatar
Dries committed
19
 */
20
function aggregator_help($route_name, RouteMatchInterface $route_match) {
21 22
  switch ($route_name) {
    case 'help.page.aggregator':
23
      $path_validator = \Drupal::pathValidator();
24 25
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
26
      $output .= '<p>' . t('The Aggregator module is an on-site syndicator and news reader that gathers and displays fresh content from RSS-, RDF-, and Atom-based feeds made available across the web. Thousands of sites (particularly news sites and blogs) publish their latest headlines in feeds, using a number of standardized XML-based formats. For more information, see the <a href="!aggregator-module">online documentation for the Aggregator module</a>.', array('!aggregator-module' => 'https://drupal.org/documentation/modules/aggregator')) . '</p>';
27 28
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
29
      // Check if the aggregator sources View is enabled.
30 31 32 33
      if ($url = $path_validator->getUrlIfValid('aggregator/sources')) {
        $output .= '<dt>' . t('Viewing feeds') . '</dt>';
        $output .= '<dd>' . t('Users view feed content in the <a href="!aggregator">main aggregator display</a>, or by <a href="!aggregator-sources">their source</a> (usually via an RSS feed reader). The most recent content in a feed can be displayed as a block through the <a href="!admin-block">Blocks administration page</a>.', array('!aggregator' => \Drupal::url('aggregator.page_last'), '!aggregator-sources' => $url->toString(), '!admin-block' => \Drupal::url('block.admin_display'))) . '</dd>';
      }
34
      $output .= '<dt>' . t('Adding, editing, and deleting feeds') . '</dt>';
35 36
      $output .= '<dd>' . t('Administrators can add, edit, and delete feeds, and choose how often to check each feed for newly updated items on the <a href="!feededit">Feed aggregator administration page</a>.', array('!feededit' => \Drupal::url('aggregator.admin_overview'))) . '</dd>';
      $output .= '<dt>' . t('<abbr title="Outline Processor Markup Language">OPML</abbr> integration') . '</dt>';
37
      // Check if the aggregator opml View is enabled.
38 39 40
      if ($url = $path_validator->getUrlIfValid('aggregator/opml')) {
        $output .= '<dd>' . t('A <a href="!aggregator-opml">machine-readable OPML file</a> of all feeds is available. OPML is an XML-based file format used to share outline-structured information such as a list of RSS feeds. Feeds can also be <a href="!import-opml">imported via an OPML file</a>.', array('!aggregator-opml' => $url->toString(), '!import-opml' => \Drupal::url('aggregator.opml_add'))) . '</dd>';
      }
41
      $output .= '<dt>' . t('Configuring cron') . '</dt>';
42
      $output .= '<dd>' . t('A working <a href="!cron">cron maintenance task</a> is required to update feeds automatically.', array('!cron' => \Drupal::url('system.cron_settings'))) . '</dd>';
43
      $output .= '</dl>';
44
      return $output;
45 46

    case 'aggregator.admin_overview':
47
      // Don't use placeholders for possibility to change URLs for translators.
48
      $output = '<p>' . t('Many sites publish their headlines and posts in feeds, using a number of standardized XML-based formats. The aggregator supports <a href="http://en.wikipedia.org/wiki/Rss">RSS</a>, <a href="http://en.wikipedia.org/wiki/Resource_Description_Framework">RDF</a>, and <a href="http://en.wikipedia.org/wiki/Atom_%28standard%29">Atom</a>.') . '</p>';
49
      $output .= '<p>' . t('Current feeds are listed below, and <a href="!addfeed">new feeds may be added</a>. For each feed, the <em>latest items</em> block may be enabled at the <a href="!block">blocks administration page</a>.', array('!addfeed' =>  \Drupal::url('aggregator.feed_add'), '!block' => \Drupal::url('block.admin_display'))) . '</p>';
50
      return $output;
51 52

    case 'aggregator.feed_add':
53
      return '<p>' . t('Add a feed in RSS, RDF or Atom format. A feed may only have one entry.') . '</p>';
54 55

    case 'aggregator.opml_add':
56
      return '<p>' . t('<abbr title="Outline Processor Markup Language">OPML</abbr> is an XML format for exchanging feeds between aggregators. A single OPML document may contain many feeds. Aggregator uses this file to import all feeds at once. Upload a file from your computer or enter a URL where the OPML file can be downloaded.') . '</p>';
Dries's avatar
Dries committed
57
  }
58 59
}

60
/**
61
 * Implements hook_theme().
62 63 64
 */
function aggregator_theme() {
  return array(
65 66
    'aggregator_feed' => array(
      'render element' => 'elements',
67
      'file' => 'aggregator.theme.inc',
68 69
    ),
    'aggregator_block_item' => array(
70
      'variables' => array('item' => NULL, 'feed' => 0),
71
      'file' => 'aggregator.theme.inc',
72
    ),
73
    'aggregator_item' => array(
74
      'render element' => 'elements',
75
      'file' => 'aggregator.theme.inc',
76
    ),
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
  );
}

/**
 * Implements hook_entity_extra_field_info().
 */
function aggregator_entity_extra_field_info() {
  $extra = array();

  $extra['aggregator_feed']['aggregator_feed'] = array(
    'display' => array(
      'items' => array(
        'label' => t('Items'),
        'description' => t('Items associated with this feed'),
        'weight' => 0,
      ),
      // @todo Move to a formatter at https://www.drupal.org/node/2339917.
      'image' => array(
        'label' => t('Image'),
        'description' => t('The feed image'),
        'weight' => 2,
      ),
      // @todo Move to a formatter at https://drupal.org/node/2149845.
      'description' => array(
        'label' => t('Description'),
        'description' => t('The description of this feed'),
        'weight' => 3,
      ),
      'more_link' => array(
        'label' => t('More link'),
        'description' => t('A more link to the feed detail page'),
        'weight' => 5,
      ),
      'feed_icon' => array(
        'label' => t('Feed icon'),
        'description' => t('An icon that links to the feed url'),
        'weight' => 6,
      ),
115 116
    ),
  );
117 118 119 120 121 122 123 124 125 126 127 128 129

  $extra['aggregator_item']['aggregator_item'] = array(
    'display' => array(
      // @todo Move to a formatter at https://drupal.org/node/2149845.
      'description' => array(
        'label' => t('Description'),
        'description' => t('The description of this feed item'),
        'weight' => 2,
      ),
    ),
  );

  return $extra;
130
}
131

Dries's avatar
Dries committed
132
/**
133
 * Implements hook_cron().
Dries's avatar
Dries committed
134
 *
135
 * Queues news feeds for updates once their refresh interval has elapsed.
Dries's avatar
Dries committed
136
 */
Dries's avatar
Dries committed
137
function aggregator_cron() {
138
  $queue = \Drupal::queue('aggregator_feeds');
139

140 141
  $ids = \Drupal::entityManager()->getStorage('aggregator_feed')->getFeedIdsToRefresh();
  foreach (Feed::loadMultiple($ids) as $feed) {
142 143
    if ($queue->createItem($feed)) {
      // Add timestamp to avoid queueing item more than once.
144
      $feed->setQueuedTime(REQUEST_TIME);
145
      $feed->save();
146
    }
Dries's avatar
Dries committed
147
  }
148

149
  // Delete queued timestamp after 6 hours assuming the update has failed.
150
  $ids = \Drupal::entityQuery('aggregator_feed')
151 152
    ->condition('queued', REQUEST_TIME - (3600 * 6), '<')
    ->execute();
153

154 155
  if ($ids) {
    $feeds = Feed::loadMultiple($ids);
156 157 158 159 160
    foreach ($feeds as $feed) {
      $feed->setQueuedTime(0);
      $feed->save();
    }
  }
Dries's avatar
Dries committed
161 162
}

163
/**
164
 * Renders the HTML content safely, as allowed.
165
 *
166
 * @param string $value
167
 *   The content to be filtered.
168
 *
169
 * @return string
170
 *   The filtered content.
171 172
 */
function aggregator_filter_xss($value) {
173
  return Xss::filter($value, preg_split('/\s+|<|>/', \Drupal::config('aggregator.settings')->get('items.allowed_html'), -1, PREG_SPLIT_NO_EMPTY));
174
}
175

176
/**
177
 * Implements hook_preprocess_HOOK() for block templates.
178 179
 */
function aggregator_preprocess_block(&$variables) {
180
  if ($variables['configuration']['provider'] == 'aggregator') {
181
    $variables['attributes']['role'] = 'complementary';
182 183
  }
}