aggregator.pages.inc 17.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
<?php
// $Id$

/**
 * @file
 * User page callbacks for the aggregator module.
 */

/**
 * Menu callback; displays the most recent items gathered from any feed.
11 12 13
 *
 * @return
 *   The items HTML.
14 15
 */
function aggregator_page_last() {
16
  drupal_add_feed(url('aggregator/rss'), variable_get('site_name', 'Drupal') . ' ' . t('aggregator'));
17

18
  $items = aggregator_feed_items_load('sum');
19 20

  return _aggregator_page_list($items, arg(1));
21 22 23 24
}

/**
 * Menu callback; displays all the items captured from a particular feed.
25 26 27 28 29 30 31 32
 *
 * If there are two arguments then this function is the categorize form.
 *
 * @param $arg1
 *   If there are two arguments then $arg1 is $form_state. Otherwise, $arg1 is $feed.
 * @param $arg2
 *   If there are two arguments then $arg2 is feed.
 * @return
33
 *   The item's HTML.
34 35 36 37
 */
function aggregator_page_source($arg1, $arg2 = NULL) {
  // If there are two arguments then this function is the categorize form, and
  // $arg1 is $form_state and $arg2 is $feed. Otherwise, $arg1 is $feed.
38
  $feed = is_object($arg2) ? $arg2 : $arg1;
39
  drupal_set_title($feed->title);
40
  $feed_source = theme('aggregator_feed_source', $feed);
41

42
  // It is safe to include the fid in the query because it's loaded from the
43
  // database by aggregator_feed_load.
44
  $items = aggregator_feed_items_load('source', $feed);
45

46
  return _aggregator_page_list($items, arg(3), $feed_source);
47 48 49 50
}

/**
 * Menu callback; displays all the items aggregated in a particular category.
51 52 53 54 55 56 57 58 59
 *
 * If there are two arguments then this function is called as a form.
 *
 * @param $arg1
 *   If there are two arguments then $arg1 is $form_state. Otherwise, $arg1 is $category.
 * @param $arg2
 *   If there are two arguments then $arg2 is $category.
 * @return
 *   The items HTML.
60 61 62 63 64 65
 */
function aggregator_page_category($arg1, $arg2 = NULL) {
  // If there are two arguments then we are called as a form, $arg1 is
  // $form_state and $arg2 is $category. Otherwise, $arg1 is $category.
  $category = is_array($arg2) ? $arg2 : $arg1;

66
  drupal_add_feed(url('aggregator/rss/' . $category['cid']), variable_get('site_name', 'Drupal') . ' ' . t('aggregator - @title', array('@title' => $category['title'])));
67 68

  // It is safe to include the cid in the query because it's loaded from the
69
  // database by aggregator_category_load.
70
  $items = aggregator_feed_items_load('category', $category);
71

72 73 74 75
  return _aggregator_page_list($items, arg(3));
}

/**
76
 * Load feed items
77
 *
78 79 80 81
 * @param $type
 *   The filter for the items. Possible values: 'sum', 'source', 'category'
 * @param $data
 *   Feed or category data for filtering
82 83
 * @return
 *   An array of the feed items.
84
 */
85
function aggregator_feed_items_load($type, $data = NULL) {
86
  $items = array();
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
  $range_limit = 20;
  switch ($type) {
    case 'sum':
      $result = db_query_range('SELECT i.*, f.title AS ftitle, f.link AS flink FROM {aggregator_item} i INNER JOIN {aggregator_feed} f ON i.fid = f.fid ORDER BY i.timestamp DESC, i.iid DESC', 0, $range_limit);
      break;
    case 'source':
      $result = db_query_range('SELECT * FROM {aggregator_item} WHERE fid = :fid ORDER BY timestamp DESC, iid DESC', array(':fid' => $data->fid), 0, $range_limit);
      break;
    case 'category':
      $result = db_query_range('SELECT i.*, f.title AS ftitle, f.link AS flink FROM {aggregator_category_item} c LEFT JOIN {aggregator_item} i ON c.iid = i.iid LEFT JOIN {aggregator_feed} f ON i.fid = f.fid WHERE cid = :cid ORDER BY timestamp DESC, i.iid DESC', array(':cid' => $data['cid']), 0, $range_limit);
      break;
  }

  foreach ($result as $item) {
    $item->categories = db_query('SELECT c.title, c.cid FROM {aggregator_category_item} ci LEFT JOIN {aggregator_category} c ON ci.cid = c.cid WHERE ci.iid = :iid ORDER BY c.title', array(':iid' => $item->iid))->fetchAll();
    $items[] = $item;
103
  }
104

105
  return $items;
106 107 108
}

/**
109 110 111 112 113 114 115 116 117 118 119 120
 * Prints an aggregator page listing a number of feed items.
 *
 * Various menu callbacks use this function to print their feeds.
 *
 * @param $items
 *   The items to be listed.
 * @param $op
 *   Which form should be added to the items. Only 'categorize' is now recognized.
 * @param $feed_source
 *   The feed source URL.
 * @return
 *   The items HTML.
121
 */
122 123 124 125
function _aggregator_page_list($items, $op, $feed_source = '') {
  if (user_access('administer news feeds') && ($op == 'categorize')) {
    // Get form data.
    $output = aggregator_categorize_items($items, $feed_source);
126 127
  }
  else {
128
    // Assemble themed output.
129
    $output = $feed_source;
130 131
    foreach ($items as $item) {
      $output .= theme('aggregator_item', $item);
132
    }
133
    $output = theme('aggregator_wrapper', $output);
134
  }
135

136
  return $output;
137 138 139 140 141
}

/**
 * Form builder; build the page list form.
 *
142 143 144 145 146 147
 * @param $items
 *   An array of the feed items.
 * @param $feed_source
 *   The feed source URL.
 * @return
 *   The form structure.
148
 * @ingroup forms
149 150
 * @see aggregator_categorize_items_validate()
 * @see aggregator_categorize_items_submit()
151
 */
152 153 154 155
function aggregator_categorize_items($items, $feed_source = '') {
  $form['#submit'][] = 'aggregator_categorize_items_submit';
  $form['#validate'][] = 'aggregator_categorize_items_validate';
  $form['#theme'] = 'aggregator_categorize_items';
156 157 158
  $form['feed_source'] = array(
    '#value' => $feed_source,
  );
159 160 161
  $categories = array();
  $done = FALSE;
  $form['items'] = array();
162 163 164
  $form['categories'] = array(
    '#tree' => TRUE,
  );
165
  foreach ($items as $item) {
166
    $form['items'][$item->iid] = array('#markup' => theme('aggregator_item', $item));
167
    $form['categories'][$item->iid] = array();
168
    $categories_result = db_query('SELECT c.cid, c.title, ci.iid FROM {aggregator_category} c LEFT JOIN {aggregator_category_item} ci ON c.cid = ci.cid AND ci.iid = :iid', array(':iid' => $item->iid));
169
    $selected = array();
170
    foreach ($categories_result as $category) {
171 172 173 174 175
      if (!$done) {
        $categories[$category->cid] = check_plain($category->title);
      }
      if ($category->iid) {
        $selected[] = $category->cid;
176 177
      }
    }
178 179 180 181 182 183 184 185
    $done = TRUE;
    $form['categories'][$item->iid] = array(
      '#type' => variable_get('aggregator_category_selector', 'checkboxes'),
      '#default_value' => $selected,
      '#options' => $categories,
      '#size' => 10,
      '#multiple' => TRUE
    );
186 187 188 189 190 191
  }
  $form['submit'] = array('#type' => 'submit', '#value' => t('Save categories'));

  return $form;
}

192
/**
193
 * Validate aggregator_categorize_items() form submissions.
194
 */
195
function aggregator_categorize_items_validate($form, &$form_state) {
196 197 198 199 200
  if (!user_access('administer news feeds')) {
    form_error($form, t('You are not allowed to categorize this feed item.'));
  }
}

201
/**
202
 * Process aggregator_categorize_items() form submissions.
203
 */
204
function aggregator_categorize_items_submit($form, &$form_state) {
205 206
  if (!empty($form_state['values']['categories'])) {
    foreach ($form_state['values']['categories'] as $iid => $selection) {
207 208 209 210 211
      db_delete('aggregator_category_item')
        ->condition('iid', $iid)
        ->execute();
      $insert = db_insert('aggregator_category_item')->fields(array('iid', 'cid'));
      $has_values = FALSE;
212
      foreach ($selection as $cid) {
213 214 215 216 217 218
        if ($cid && $iid) {
          $has_values = TRUE;
          $insert->values(array(
            'iid' => $iid,
            'cid' => $cid,
          ));
219
        }
220
      }
221 222 223
      if ($has_values) {
        $insert->execute();
      }
224 225 226 227 228 229
    }
  }
  drupal_set_message(t('The categories have been saved.'));
}

/**
230
 * Theme the page list form for assigning categories.
231
 *
232 233 234 235
 * @param $form
 *   An associative array containing the structure of the form.
 * @return
 *   The output HTML.
236 237
 * @ingroup themeable
 */
238 239
function theme_aggregator_categorize_items($form) {
  $output = drupal_render($form['feed_source']);
240
  $rows = array();
241
  if (!empty($form['items'])) {
242
    foreach (element_children($form['items']) as $key) {
243 244
      $rows[] = array(
        drupal_render($form['items'][$key]),
245
        array('data' => drupal_render($form['categories'][$key]), 'class' => array('categorize-item')),
246
      );
247 248 249 250
    }
  }
  $output .= theme('table', array('', t('Categorize')), $rows);
  $output .= drupal_render($form['submit']);
251
  $output .= drupal_render_children($form);
252

253
  return theme('aggregator_wrapper', $output);
254 255
}

256 257 258 259 260 261
/**
 * Process variables for aggregator-wrapper.tpl.php.
 *
 * @see aggregator-wrapper.tpl.php
 */
function template_preprocess_aggregator_wrapper(&$variables) {
262
  $variables['pager'] = theme('pager', NULL);
263
}
264 265

/**
266
 * Process variables for aggregator-item.tpl.php.
267
 *
268
 * @see aggregator-item.tpl.php
269
 */
270 271 272 273 274 275
function template_preprocess_aggregator_item(&$variables) {
  $item = $variables['item'];

  $variables['feed_url'] = check_url($item->link);
  $variables['feed_title'] = check_plain($item->title);
  $variables['content'] = aggregator_filter_xss($item->description);
276

277 278
  $variables['source_url'] = '';
  $variables['source_title'] = '';
279
  if (isset($item->ftitle) && isset($item->fid)) {
280 281
    $variables['source_url'] = url("aggregator/sources/$item->fid");
    $variables['source_title'] = check_plain($item->ftitle);
282 283
  }
  if (date('Ymd', $item->timestamp) == date('Ymd')) {
284
    $variables['source_date'] = t('%ago ago', array('%ago' => format_interval(REQUEST_TIME - $item->timestamp)));
285 286
  }
  else {
287
    $variables['source_date'] = format_date($item->timestamp, 'custom', variable_get('date_format_medium', 'D, m/d/Y - H:i'));
288 289
  }

290 291
  $variables['categories'] = array();
  foreach ($item->categories as $category) {
292
    $variables['categories'][$category->cid] = l($category->title, 'aggregator/categories/' . $category->cid);
293 294 295 296 297 298 299 300 301
  }
}

/**
 * Menu callback; displays all the feeds used by the aggregator.
 */
function aggregator_page_sources() {
  $result = db_query('SELECT f.fid, f.title, f.description, f.image, MAX(i.timestamp) AS last FROM {aggregator_feed} f LEFT JOIN {aggregator_item} i ON f.fid = i.fid GROUP BY f.fid, f.title, f.description, f.image ORDER BY last DESC, f.title');

302
  $output = '';
303
  foreach ($result as $feed) {
304
    // Most recent items:
305
    $summary_items = array();
306
    if (variable_get('aggregator_summary_items', 3)) {
307 308
      $items = db_query_range('SELECT i.title, i.timestamp, i.link FROM {aggregator_item} i WHERE i.fid = :fid ORDER BY i.timestamp DESC', array(':fid' => $feed->fid), 0, variable_get('aggregator_summary_items', 3));
      foreach ($items as $item) {
309
        $summary_items[] = theme('aggregator_summary_item', $item);
310 311
      }
    }
312
    $feed->url = url('aggregator/sources/' . $feed->fid);
313
    $output .= theme('aggregator_summary_items', $summary_items, $feed);
314 315
  }
  $output .= theme('feed_icon', url('aggregator/opml'), t('OPML feed'));
316 317

  return theme('aggregator_wrapper', $output);
318 319 320 321 322 323 324 325
}

/**
 * Menu callback; displays all the categories used by the aggregator.
 */
function aggregator_page_categories() {
  $result = db_query('SELECT c.cid, c.title, c.description FROM {aggregator_category} c LEFT JOIN {aggregator_category_item} ci ON c.cid = ci.cid LEFT JOIN {aggregator_item} i ON ci.iid = i.iid GROUP BY c.cid, c.title, c.description');

326
  $output = '';
327
  foreach ($result as $category) {
328
    if (variable_get('aggregator_summary_items', 3)) {
329
      $summary_items = array();
330 331
      $items = db_query_range('SELECT i.title, i.timestamp, i.link, f.title as feed_title, f.link as feed_link FROM {aggregator_category_item} ci LEFT JOIN {aggregator_item} i ON i.iid = ci.iid LEFT JOIN {aggregator_feed} f ON i.fid = f.fid WHERE ci.cid = :cid ORDER BY i.timestamp DESC', array(':cid' => $category->cid), 0, variable_get('aggregator_summary_items', 3));
      foreach ($items as $item) {
332
        $summary_items[] = theme('aggregator_summary_item', $item);
333 334
      }
    }
335
    $category->url = url('aggregator/categories/' . $category->cid);
336
    $output .= theme('aggregator_summary_items', $summary_items, $category);
337 338
  }

339
  return theme('aggregator_wrapper', $output);
340 341 342 343 344 345 346
}

/**
 * Menu callback; generate an RSS 0.92 feed of aggregator items or categories.
 */
function aggregator_page_rss() {
  $result = NULL;
347
  // arg(2) is the passed cid, only select for that category.
348
  if (arg(2)) {
349 350
    $category = db_query('SELECT cid, title FROM {aggregator_category} WHERE cid = :cid', array(':cid' => arg(2)))->fetchObject();
    $result = db_query_range('SELECT i.*, f.title AS ftitle, f.link AS flink FROM {aggregator_category_item} c LEFT JOIN {aggregator_item} i ON c.iid = i.iid LEFT JOIN {aggregator_feed} f ON i.fid = f.fid WHERE cid = :cid ORDER BY timestamp DESC, i.iid DESC', array(':cid' => $category->cid), 0, variable_get('feed_default_items', 10));
351
  }
352
  // Or, get the default aggregator items.
353
  else {
354
    $category = NULL;
355
    $result = db_query_range('SELECT i.*, f.title AS ftitle, f.link AS flink FROM {aggregator_item} i INNER JOIN {aggregator_feed} f ON i.fid = f.fid ORDER BY i.timestamp DESC, i.iid DESC', 0, variable_get('feed_default_items', 10));
356
  }
357

358
  $feeds = $result->fetchAll();
359 360 361 362
  return theme('aggregator_page_rss', $feeds, $category);
}

/**
363
 * Theme the RSS output.
364
 *
365 366 367 368
 * @param $feeds
 *   An array of the feeds to theme.
 * @param $category
 *   A common category, if any, for all the feeds.
369 370 371
 * @ingroup themeable
 */
function theme_aggregator_page_rss($feeds, $category = NULL) {
372
  drupal_set_header('Content-Type', 'application/rss+xml; charset=utf-8');
373 374 375 376 377

  $items = '';
  $feed_length = variable_get('feed_item_length', 'teaser');
  foreach ($feeds as $feed) {
    switch ($feed_length) {
378
      case 'teaser':
379 380 381
        $summary = text_summary($feed->description, NULL, variable_get('aggregator_teaser_length', 600));
        if ($summary != $feed->description) {
          $summary .= '<p><a href="' . check_url($feed->link) . '">' . t('read more') . "</a></p>\n";
382
        }
383
        $feed->description = $summary;
384 385
        break;
      case 'title':
386
        $feed->description = '';
387 388
        break;
    }
389
    $items .= format_rss_item($feed->ftitle . ': ' . $feed->title, $feed->link, $feed->description, array('pubDate' => date('r', $feed->timestamp)));
390 391
  }

392
  $site_name = variable_get('site_name', 'Drupal');
393
  $url = url((isset($category) ? 'aggregator/categories/' . $category->cid : 'aggregator'), array('absolute' => TRUE));
394
  $description = isset($category) ? t('@site_name - aggregated feeds in category @title', array('@site_name' => $site_name, '@title' => $category->title)) : t('@site_name - aggregated feeds', array('@site_name' => $site_name));
395

396
  $output  = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n";
397
  $output .= "<rss version=\"2.0\">\n";
398
  $output .= format_rss_channel(t('@site_name aggregator', array('@site_name' => $site_name)), $url, $description, $items);
399 400 401 402 403 404 405
  $output .= "</rss>\n";

  print $output;
}

/**
 * Menu callback; generates an OPML representation of all feeds.
406 407 408 409 410
 *
 * @param $cid
 *   If set, feeds are exported only from a category with this ID. Otherwise, all feeds are exported.
 * @return
 *   The output XML.
411 412 413
 */
function aggregator_page_opml($cid = NULL) {
  if ($cid) {
414
    $result = db_query('SELECT f.title, f.url FROM {aggregator_feed} f LEFT JOIN {aggregator_category_feed} c on f.fid = c.fid WHERE c.cid = :cid ORDER BY title', array(':cid' => $cid));
415 416 417 418
  }
  else {
    $result = db_query('SELECT * FROM {aggregator_feed} ORDER BY title');
  }
419

420
  $feeds = $result->fetchAll();
421 422 423 424
  return theme('aggregator_page_opml', $feeds);
}

/**
425
 * Theme the OPML feed output.
426
 *
427 428
 * @param $feeds
 *   An array of the feeds to theme.
429 430 431
 * @ingroup themeable
 */
function theme_aggregator_page_opml($feeds) {
432
  drupal_set_header('Content-Type', 'text/xml; charset=utf-8');
433

434
  $output  = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n";
435 436
  $output .= "<opml version=\"1.1\">\n";
  $output .= "<head>\n";
437 438
  $output .= '<title>' . check_plain(variable_get('site_name', 'Drupal')) . "</title>\n";
  $output .= '<dateModified>' . gmdate('r') . "</dateModified>\n";
439 440
  $output .= "</head>\n";
  $output .= "<body>\n";
441
  foreach ($feeds as $feed) {
442
    $output .= '<outline text="' . check_plain($feed->title) . '" xmlUrl="' . check_url($feed->url) . "\" />\n";
443 444 445 446 447 448 449 450
  }
  $output .= "</body>\n";
  $output .= "</opml>\n";

  print $output;
}

/**
451
 * Process variables for aggregator-summary-items.tpl.php.
452
 *
453 454 455 456 457 458 459 460 461 462 463 464
 * @see aggregator-summary-item.tpl.php
 */
function template_preprocess_aggregator_summary_items(&$variables) {
  $variables['title'] = check_plain($variables['source']->title);
  $variables['summary_list'] = theme('item_list', $variables['summary_items']);
  $variables['source_url'] = $variables['source']->url;
}

/**
 * Process variables for aggregator-summary-item.tpl.php.
 *
 * @see aggregator-summary-item.tpl.php
465
 */
466 467 468 469 470
function template_preprocess_aggregator_summary_item(&$variables) {
  $item = $variables['item'];

  $variables['feed_url'] = check_url($item->link);
  $variables['feed_title'] = check_plain($item->title);
471
  $variables['feed_age'] = t('%age old', array('%age' => format_interval(REQUEST_TIME - $item->timestamp)));
472 473 474

  $variables['source_url'] = '';
  $variables['source_title'] = '';
475
  if (!empty($item->feed_link)) {
476 477
    $variables['source_url'] = check_url($item->feed_link);
    $variables['source_title'] = check_plain($item->feed_title);
478 479 480 481
  }
}

/**
482
 * Process variables for aggregator-feed-source.tpl.php.
483
 *
484
 * @see aggregator-feed-source.tpl.php
485
 */
486 487
function template_preprocess_aggregator_feed_source(&$variables) {
  $feed = $variables['feed'];
488

489 490 491 492
  $variables['source_icon'] = theme('feed_icon', $feed->url, t('!title feed', array('!title' => $feed->title)));
  $variables['source_image'] = $feed->image;
  $variables['source_description'] = aggregator_filter_xss($feed->description);
  $variables['source_url'] = check_url(url($feed->link, array('absolute' => TRUE)));
493 494

  if ($feed->checked) {
495
    $variables['last_checked'] = t('@time ago', array('@time' => format_interval(REQUEST_TIME - $feed->checked)));
496 497
  }
  else {
498
    $variables['last_checked'] = t('never');
499 500 501
  }

  if (user_access('administer news feeds')) {
502
    $variables['last_checked'] = l($variables['last_checked'], 'admin/config/services/aggregator');
503 504
  }
}