DefaultProcessor.php 9.89 KB
Newer Older
1 2 3 4
<?php

namespace Drupal\aggregator\Plugin\aggregator\processor;

5
use Drupal\aggregator\Entity\Item;
6
use Drupal\aggregator\ItemStorageInterface;
7
use Drupal\aggregator\Plugin\AggregatorPluginSettingsBase;
8
use Drupal\aggregator\Plugin\ProcessorInterface;
9
use Drupal\aggregator\FeedInterface;
10
use Drupal\Component\Utility\Unicode;
11
use Drupal\Core\Config\ConfigFactoryInterface;
12
use Drupal\Core\Datetime\DateFormatterInterface;
13
use Drupal\Core\Entity\Query\QueryInterface;
14
use Drupal\Core\Form\ConfigFormBaseTrait;
15
use Drupal\Core\Form\FormStateInterface;
16
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
17
use Drupal\Core\Routing\UrlGeneratorTrait;
18
use Symfony\Component\DependencyInjection\ContainerInterface;
19 20 21 22 23 24

/**
 * Defines a default processor implementation.
 *
 * Creates lightweight records from feed items.
 *
25
 * @AggregatorProcessor(
26 27 28 29 30
 *   id = "aggregator",
 *   title = @Translation("Default processor"),
 *   description = @Translation("Creates lightweight records from feed items.")
 * )
 */
31
class DefaultProcessor extends AggregatorPluginSettingsBase implements ProcessorInterface, ContainerFactoryPluginInterface {
32
  use ConfigFormBaseTrait;
33 34
  use UrlGeneratorTrait;

35 36 37
  /**
   * Contains the configuration object factory.
   *
38
   * @var \Drupal\Core\Config\ConfigFactoryInterface
39 40 41
   */
  protected $configFactory;

42 43 44 45 46 47 48 49
  /**
   * The entity query object for feed items.
   *
   * @var \Drupal\Core\Entity\Query\QueryInterface
   */
  protected $itemQuery;

  /**
50
   * The entity storage for items.
51
   *
52
   * @var \Drupal\aggregator\ItemStorageInterface
53 54 55
   */
  protected $itemStorage;

56 57 58
  /**
   * The date formatter service.
   *
59
   * @var \Drupal\Core\Datetime\DateFormatterInterface
60 61 62
   */
  protected $dateFormatter;

63 64 65 66 67 68 69
  /**
   * Constructs a DefaultProcessor object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
70
   * @param mixed $plugin_definition
71
   *   The plugin implementation definition.
72
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config
73
   *   The configuration factory object.
74 75
   * @param \Drupal\Core\Entity\Query\QueryInterface $item_query
   *   The entity query object for feed items.
76 77
   * @param \Drupal\aggregator\ItemStorageInterface $item_storage
   *   The entity storage for feed items.
78
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
79
   *   The date formatter service.
80
   */
81
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config, QueryInterface $item_query, ItemStorageInterface $item_storage, DateFormatterInterface $date_formatter) {
82
    $this->configFactory = $config;
83 84
    $this->itemStorage = $item_storage;
    $this->itemQuery = $item_query;
85
    $this->dateFormatter = $date_formatter;
86 87 88 89 90 91 92 93
    // @todo Refactor aggregator plugins to ConfigEntity so merging
    //   the configuration here is not needed.
    parent::__construct($configuration + $this->getConfiguration(), $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
94
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
95 96 97 98
    return new static(
      $configuration,
      $plugin_id,
      $plugin_definition,
99 100
      $container->get('config.factory'),
      $container->get('entity.query')->get('aggregator_item'),
101
      $container->get('entity.manager')->getStorage('aggregator_item'),
102
      $container->get('date.formatter')
103 104
    );
  }
105

106 107 108 109 110 111 112
  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return ['aggregator.settings'];
  }

113
  /**
114
   * {@inheritdoc}
115
   */
116
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
117 118
    $config = $this->config('aggregator.settings');
    $processors = $config->get('processors');
119
    $info = $this->getPluginDefinition();
120 121
    $counts = array(3, 5, 10, 15, 20, 25);
    $items = array_map(function ($count) {
122
      return $this->formatPlural($count, '1 item', '@count items');
123 124
    }, array_combine($counts, $counts));
    $intervals = array(3600, 10800, 21600, 32400, 43200, 86400, 172800, 259200, 604800, 1209600, 2419200, 4838400, 9676800);
125
    $period = array_map(array($this->dateFormatter, 'formatInterval'), array_combine($intervals, $intervals));
126 127 128 129 130 131 132 133 134
    $period[AGGREGATOR_CLEAR_NEVER] = t('Never');

    $form['processors'][$info['id']] = array();
    // Only wrap into details if there is a basic configuration.
    if (isset($form['basic_conf'])) {
      $form['processors'][$info['id']] = array(
        '#type' => 'details',
        '#title' => t('Default processor settings'),
        '#description' => $info['description'],
135
        '#open' => in_array($info['id'], $processors),
136 137 138 139 140 141
      );
    }

    $form['processors'][$info['id']]['aggregator_summary_items'] = array(
      '#type' => 'select',
      '#title' => t('Number of items shown in listing pages'),
142
      '#default_value' => $config->get('source.list_max'),
143 144 145 146 147 148 149
      '#empty_value' => 0,
      '#options' => $items,
    );

    $form['processors'][$info['id']]['aggregator_clear'] = array(
      '#type' => 'select',
      '#title' => t('Discard items older than'),
150
      '#default_value' => $config->get('items.expire'),
151
      '#options' => $period,
152
      '#description' => t('Requires a correctly configured <a href=":cron">cron maintenance task</a>.', array(':cron' => $this->url('system.status'))),
153 154
    );

155 156
    $lengths = array(0, 200, 400, 600, 800, 1000, 1200, 1400, 1600, 1800, 2000);
    $options = array_map(function($length) {
157
      return ($length == 0) ? t('Unlimited') : $this->formatPlural($length, '1 character', '@count characters');
158 159
    }, array_combine($lengths, $lengths));

160 161 162
    $form['processors'][$info['id']]['aggregator_teaser_length'] = array(
      '#type' => 'select',
      '#title' => t('Length of trimmed description'),
163
      '#default_value' => $config->get('items.teaser_length'),
164
      '#options' => $options,
165
      '#description' => t('The maximum number of characters used in the trimmed version of content.'),
166 167 168 169 170
    );
    return $form;
  }

  /**
171
   * {@inheritdoc}
172
   */
173
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
174 175 176
    $this->configuration['items']['expire'] = $form_state->getValue('aggregator_clear');
    $this->configuration['items']['teaser_length'] = $form_state->getValue('aggregator_teaser_length');
    $this->configuration['source']['list_max'] = $form_state->getValue('aggregator_summary_items');
177 178
    // @todo Refactor aggregator plugins to ConfigEntity so this is not needed.
    $this->setConfiguration($this->configuration);
179 180 181
  }

  /**
182
   * {@inheritdoc}
183
   */
184
  public function process(FeedInterface $feed) {
185 186 187 188
    if (!is_array($feed->items)) {
      return;
    }
    foreach ($feed->items as $item) {
189
      // @todo: The default entity view builder always returns an empty
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
      //   array, which is ignored in aggregator_save_item() currently. Should
      //   probably be fixed.
      if (empty($item['title'])) {
        continue;
      }

      // Save this item. Try to avoid duplicate entries as much as possible. If
      // we find a duplicate entry, we resolve it and pass along its ID is such
      // that we can update it if needed.
      if (!empty($item['guid'])) {
        $values = array('fid' => $feed->id(), 'guid' => $item['guid']);
      }
      elseif ($item['link'] && $item['link'] != $feed->link && $item['link'] != $feed->url) {
        $values = array('fid' => $feed->id(), 'link' => $item['link']);
      }
      else {
        $values = array('fid' => $feed->id(), 'title' => $item['title']);
      }

      // Try to load an existing entry.
      if ($entry = entity_load_multiple_by_properties('aggregator_item', $values)) {
        $entry = reset($entry);
      }
      else {
214
        $entry = Item::create(array('langcode' => $feed->language()->getId()));
215 216
      }
      if ($item['timestamp']) {
217
        $entry->setPostedTime($item['timestamp']);
218 219 220
      }

      // Make sure the item title and author fit in the 255 varchar column.
221 222
      $entry->setTitle(Unicode::truncate($item['title'], 255, TRUE, TRUE));
      $entry->setAuthor(Unicode::truncate($item['author'], 255, TRUE, TRUE));
223

224 225 226
      $entry->setFeedId($feed->id());
      $entry->setLink($item['link']);
      $entry->setGuid($item['guid']);
227 228 229 230 231 232 233

      $description = '';
      if (!empty($item['description'])) {
        $description = $item['description'];
      }
      $entry->setDescription($description);

234 235 236 237 238
      $entry->save();
    }
  }

  /**
239
   * {@inheritdoc}
240
   */
241
  public function delete(FeedInterface $feed) {
242 243
    if ($items = $this->itemStorage->loadByFeed($feed->id())) {
      $this->itemStorage->delete($items);
244 245
    }
    // @todo This should be moved out to caller with a different message maybe.
246
    drupal_set_message(t('The news items from %site have been deleted.', array('%site' => $feed->label())));
247 248 249 250 251 252 253
  }

  /**
   * Implements \Drupal\aggregator\Plugin\ProcessorInterface::postProcess().
   *
   * Expires items from a feed depending on expiration settings.
   */
254
  public function postProcess(FeedInterface $feed) {
255
    $aggregator_clear = $this->configuration['items']['expire'];
256 257

    if ($aggregator_clear != AGGREGATOR_CLEAR_NEVER) {
258
      // Delete all items that are older than flush item timer.
259
      $age = REQUEST_TIME - $aggregator_clear;
260 261 262 263 264 265 266
      $result = $this->itemQuery
        ->condition('fid', $feed->id())
        ->condition('timestamp', $age, '<')
        ->execute();
      if ($result) {
        $entities = $this->itemStorage->loadMultiple($result);
        $this->itemStorage->delete($entities);
267 268 269 270
      }
    }
  }

271 272 273 274 275 276 277 278 279 280 281
  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return $this->configFactory->get('aggregator.settings')->get();
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
282
    $config = $this->config('aggregator.settings');
283 284 285 286 287 288
    foreach ($configuration as $key => $value) {
      $config->set($key, $value);
    }
    $config->save();
  }

289
}