aggregator.pages.inc 18.1 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', array('feed' => $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
  $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':
93
      $result = db_query_range('SELECT * FROM {aggregator_item} WHERE fid = :fid ORDER BY timestamp DESC, iid DESC', 0, $range_limit, array(':fid' => $data->fid));
94 95
      break;
    case 'category':
96
      $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', 0, $range_limit, array(':cid' => $data['cid']));
97 98 99 100 101 102
      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
    foreach ($items as $item) {
131
      $output .= theme('aggregator_item', array('item' => $item));
132
    }
133
    $output = theme('aggregator_wrapper', array('content' => $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
 * @see aggregator_categorize_items_submit()
150
 */
151 152 153
function aggregator_categorize_items($items, $feed_source = '') {
  $form['#submit'][] = 'aggregator_categorize_items_submit';
  $form['#theme'] = 'aggregator_categorize_items';
154 155 156
  $form['feed_source'] = array(
    '#value' => $feed_source,
  );
157 158 159
  $categories = array();
  $done = FALSE;
  $form['items'] = array();
160 161 162
  $form['categories'] = array(
    '#tree' => TRUE,
  );
163
  foreach ($items as $item) {
164
    $form['items'][$item->iid] = array('#markup' => theme('aggregator_item', array('item' => $item)));
165
    $form['categories'][$item->iid] = array();
166
    $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));
167
    $selected = array();
168
    foreach ($categories_result as $category) {
169 170 171 172 173
      if (!$done) {
        $categories[$category->cid] = check_plain($category->title);
      }
      if ($category->iid) {
        $selected[] = $category->cid;
174 175
      }
    }
176 177 178 179 180 181 182 183
    $done = TRUE;
    $form['categories'][$item->iid] = array(
      '#type' => variable_get('aggregator_category_selector', 'checkboxes'),
      '#default_value' => $selected,
      '#options' => $categories,
      '#size' => 10,
      '#multiple' => TRUE
    );
184
  }
185 186
  $form['actions'] = array('#type' => 'container', '#attributes' => array('class' => array('form-actions')));
  $form['actions']['submit'] = array('#type' => 'submit', '#value' => t('Save categories'));
187 188 189 190

  return $form;
}

191
/**
192
 * Process aggregator_categorize_items() form submissions.
193
 */
194
function aggregator_categorize_items_submit($form, &$form_state) {
195 196
  if (!empty($form_state['values']['categories'])) {
    foreach ($form_state['values']['categories'] as $iid => $selection) {
197 198 199 200 201
      db_delete('aggregator_category_item')
        ->condition('iid', $iid)
        ->execute();
      $insert = db_insert('aggregator_category_item')->fields(array('iid', 'cid'));
      $has_values = FALSE;
202
      foreach ($selection as $cid) {
203 204 205 206 207 208
        if ($cid && $iid) {
          $has_values = TRUE;
          $insert->values(array(
            'iid' => $iid,
            'cid' => $cid,
          ));
209
        }
210
      }
211 212 213
      if ($has_values) {
        $insert->execute();
      }
214 215 216 217 218 219
    }
  }
  drupal_set_message(t('The categories have been saved.'));
}

/**
220
 * Theme the page list form for assigning categories.
221
 *
222 223 224 225
 * @param $variables
 *   An associative array containing:
 *   - form: An associative array containing the structure of the form.
 *
226 227
 * @return
 *   The output HTML.
228 229
 * @ingroup themeable
 */
230 231 232
function theme_aggregator_categorize_items($variables) {
  $form = $variables['form'];

233
  $output = drupal_render($form['feed_source']);
234
  $rows = array();
235
  if (!empty($form['items'])) {
236
    foreach (element_children($form['items']) as $key) {
237 238
      $rows[] = array(
        drupal_render($form['items'][$key]),
239
        array('data' => drupal_render($form['categories'][$key]), 'class' => array('categorize-item')),
240
      );
241 242
    }
  }
243
  $output .= theme('table', array('header' => array('', t('Categorize')), 'rows' => $rows));
244
  $output .= drupal_render($form['submit']);
245
  $output .= drupal_render_children($form);
246

247
  return theme('aggregator_wrapper', array('content' => $output));
248 249
}

250 251 252 253 254 255
/**
 * Process variables for aggregator-wrapper.tpl.php.
 *
 * @see aggregator-wrapper.tpl.php
 */
function template_preprocess_aggregator_wrapper(&$variables) {
256
  $variables['pager'] = theme('pager', array('tags' => NULL));
257
}
258 259

/**
260
 * Process variables for aggregator-item.tpl.php.
261
 *
262
 * @see aggregator-item.tpl.php
263
 */
264 265 266 267 268 269
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);
270

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

284 285
  $variables['categories'] = array();
  foreach ($item->categories as $category) {
286
    $variables['categories'][$category->cid] = l($category->title, 'aggregator/categories/' . $category->cid);
287 288 289 290 291 292 293 294 295
  }
}

/**
 * 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');

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

311
  return theme('aggregator_wrapper', array('content' => $output));
312 313 314 315 316 317 318 319
}

/**
 * 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');

320
  $output = '';
321
  foreach ($result as $category) {
322
    if (variable_get('aggregator_summary_items', 3)) {
323
      $summary_items = array();
324
      $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', 0, variable_get('aggregator_summary_items', 3), array(':cid' => $category->cid));
325
      foreach ($items as $item) {
326
        $summary_items[] = theme('aggregator_summary_item', array('item' => $item));
327 328
      }
    }
329
    $category->url = url('aggregator/categories/' . $category->cid);
330
    $output .= theme('aggregator_summary_items', array('summary_items' => $summary_items, 'source' => $category));
331 332
  }

333
  return theme('aggregator_wrapper', array('content' => $output));
334 335 336 337 338 339 340
}

/**
 * Menu callback; generate an RSS 0.92 feed of aggregator items or categories.
 */
function aggregator_page_rss() {
  $result = NULL;
341
  // arg(2) is the passed cid, only select for that category.
342
  if (arg(2)) {
343
    $category = db_query('SELECT cid, title FROM {aggregator_category} WHERE cid = :cid', array(':cid' => arg(2)))->fetchObject();
344
    $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', 0, variable_get('feed_default_items', 10), array(':cid' => $category->cid));
345
  }
346
  // Or, get the default aggregator items.
347
  else {
348
    $category = NULL;
349
    $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));
350
  }
351

352
  $feeds = $result->fetchAll();
353
  return theme('aggregator_page_rss', array('feeds' => $feeds, 'category' => $category));
354 355 356
}

/**
357
 * Theme the RSS output.
358
 *
359 360 361 362 363
 * @param $variables
 *   An associative array containing:
 *   - feeds: An array of the feeds to theme.
 *   - category: A common category, if any, for all the feeds.
 *
364 365
 * @ingroup themeable
 */
366 367 368 369
function theme_aggregator_page_rss($variables) {
  $feeds = $variables['feeds'];
  $category = $variables['category'];

370
  drupal_add_http_header('Content-Type', 'application/rss+xml; charset=utf-8');
371 372

  $items = '';
373
  $feed_length = variable_get('feed_item_length', 'fulltext');
374 375
  foreach ($feeds as $feed) {
    switch ($feed_length) {
376
      case 'teaser':
377 378 379
        $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";
380
        }
381
        $feed->description = $summary;
382 383
        break;
      case 'title':
384
        $feed->description = '';
385 386
        break;
    }
387
    $items .= format_rss_item($feed->ftitle . ': ' . $feed->title, $feed->link, $feed->description, array('pubDate' => date('r', $feed->timestamp)));
388 389
  }

390
  $site_name = variable_get('site_name', 'Drupal');
391
  $url = url((isset($category) ? 'aggregator/categories/' . $category->cid : 'aggregator'), array('absolute' => TRUE));
392
  $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));
393

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

  print $output;
}

/**
 * Menu callback; generates an OPML representation of all feeds.
404 405 406 407 408
 *
 * @param $cid
 *   If set, feeds are exported only from a category with this ID. Otherwise, all feeds are exported.
 * @return
 *   The output XML.
409 410 411
 */
function aggregator_page_opml($cid = NULL) {
  if ($cid) {
412
    $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));
413 414 415 416
  }
  else {
    $result = db_query('SELECT * FROM {aggregator_feed} ORDER BY title');
  }
417

418
  $feeds = $result->fetchAll();
419
  return theme('aggregator_page_opml', array('feeds' => $feeds));
420 421 422
}

/**
423
 * Theme the OPML feed output.
424
 *
425 426 427 428
 * @param $variables
 *   An associative array containing:
 *   - feeds: An array of the feeds to theme.
 *
429 430
 * @ingroup themeable
 */
431 432 433
function theme_aggregator_page_opml($variables) {
  $feeds = $variables['feeds'];

434
  drupal_add_http_header('Content-Type', 'text/xml; charset=utf-8');
435

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

  print $output;
}

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

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

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

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

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

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

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

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