aggregator.pages.inc 17.3 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 19 20
  $items = aggregator_feed_items_load('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');

  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 38 39 40
 */
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.
  $feed = is_array($arg2) ? $arg2 : $arg1;
  $feed = (object)$feed;
  drupal_set_title(check_plain($feed->title));
41
  $feed_source = theme('aggregator_feed_source', $feed);
42

43
  // It is safe to include the fid in the query because it's loaded from the
44
  // database by aggregator_feed_load.
45
  $items = aggregator_feed_items_load('SELECT * FROM {aggregator_item} WHERE fid = ' . $feed->fid . ' ORDER BY timestamp DESC, iid DESC');
46

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

/**
 * Menu callback; displays all the items aggregated in a particular category.
52 53 54 55 56 57 58 59 60
 *
 * 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.
61 62 63 64 65 66
 */
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;

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

  // It is safe to include the cid in the query because it's loaded from the
70
  // database by aggregator_category_load.
71
  $items = aggregator_feed_items_load('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 = ' . $category['cid'] . ' ORDER BY timestamp DESC, i.iid DESC');
72

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

/**
77 78 79 80 81 82
 * Load feed items by passing a SQL query.
 *
 * @param $sql
 *   The query to be executed.
 * @return
 *   An array of the feed items.
83
 */
84
function aggregator_feed_items_load($sql) {
85 86 87 88 89 90 91 92 93 94 95 96
  $items = array();
  if (isset($sql)) {
    $result = pager_query($sql, 20);
    while ($item = db_fetch_object($result)) {
      $result_category = 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 = %d ORDER BY c.title', $item->iid);
      $item->categories = array();
      while ($item_categories = db_fetch_object($result_category)) {
        $item->categories[] = $item_categories;
      }
      $items[$item->iid] = $item;
    }
  }
97

98
  return $items;
99 100 101
}

/**
102 103 104 105 106 107 108 109 110 111 112 113
 * 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.
114
 */
115 116 117 118
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);
119 120
  }
  else {
121
    // Assemble themed output.
122
    $output = $feed_source;
123 124
    foreach ($items as $item) {
      $output .= theme('aggregator_item', $item);
125
    }
126
    $output = theme('aggregator_wrapper', $output);
127
  }
128

129
  return $output;
130 131 132 133 134
}

/**
 * Form builder; build the page list form.
 *
135 136 137 138 139 140
 * @param $items
 *   An array of the feed items.
 * @param $feed_source
 *   The feed source URL.
 * @return
 *   The form structure.
141
 * @ingroup forms
142 143
 * @see aggregator_categorize_items_validate()
 * @see aggregator_categorize_items_submit()
144
 */
145 146 147 148
function aggregator_categorize_items($items, $feed_source = '') {
  $form['#submit'][] = 'aggregator_categorize_items_submit';
  $form['#validate'][] = 'aggregator_categorize_items_validate';
  $form['#theme'] = 'aggregator_categorize_items';
149 150 151
  $form['feed_source'] = array(
    '#value' => $feed_source,
  );
152 153 154
  $categories = array();
  $done = FALSE;
  $form['items'] = array();
155 156 157
  $form['categories'] = array(
    '#tree' => TRUE,
  );
158
  foreach ($items as $item) {
159
    $form['items'][$item->iid] = array('#markup' => theme('aggregator_item', $item));
160
    $form['categories'][$item->iid] = array();
161 162 163 164 165 166 167 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 = %d', $item->iid);
    $selected = array();
    while ($category = db_fetch_object($categories_result)) {
      if (!$done) {
        $categories[$category->cid] = check_plain($category->title);
      }
      if ($category->iid) {
        $selected[] = $category->cid;
169 170
      }
    }
171 172 173 174 175 176 177 178
    $done = TRUE;
    $form['categories'][$item->iid] = array(
      '#type' => variable_get('aggregator_category_selector', 'checkboxes'),
      '#default_value' => $selected,
      '#options' => $categories,
      '#size' => 10,
      '#multiple' => TRUE
    );
179 180 181 182 183 184
  }
  $form['submit'] = array('#type' => 'submit', '#value' => t('Save categories'));

  return $form;
}

185
/**
186
 * Validate aggregator_categorize_items() form submissions.
187
 */
188
function aggregator_categorize_items_validate($form, &$form_state) {
189 190 191 192 193
  if (!user_access('administer news feeds')) {
    form_error($form, t('You are not allowed to categorize this feed item.'));
  }
}

194
/**
195
 * Process aggregator_categorize_items() form submissions.
196
 */
197
function aggregator_categorize_items_submit($form, &$form_state) {
198 199 200 201 202 203 204
  if (!empty($form_state['values']['categories'])) {
    foreach ($form_state['values']['categories'] as $iid => $selection) {
      db_query('DELETE FROM {aggregator_category_item} WHERE iid = %d', $iid);
      foreach ($selection as $cid) {
        if ($cid) {
          db_query('INSERT INTO {aggregator_category_item} (cid, iid) VALUES (%d, %d)', $cid, $iid);
        }
205 206 207 208 209 210 211
      }
    }
  }
  drupal_set_message(t('The categories have been saved.'));
}

/**
212
 * Theme the page list form for assigning categories.
213
 *
214 215 216 217
 * @param $form
 *   An associative array containing the structure of the form.
 * @return
 *   The output HTML.
218 219
 * @ingroup themeable
 */
220 221
function theme_aggregator_categorize_items($form) {
  $output = drupal_render($form['feed_source']);
222 223 224 225
  $rows = array();
  if ($form['items']) {
    foreach (element_children($form['items']) as $key) {
      if (is_array($form['items'][$key])) {
226 227 228 229
        $rows[] = array(
          drupal_render($form['items'][$key]),
          array('data' => drupal_render($form['categories'][$key]), 'class' => 'categorize-item'),
        );
230 231 232 233 234 235
      }
    }
  }
  $output .= theme('table', array('', t('Categorize')), $rows);
  $output .= drupal_render($form['submit']);
  $output .= drupal_render($form);
236

237
  return theme('aggregator_wrapper', $output);
238 239
}

240 241 242 243 244 245 246 247
/**
 * Process variables for aggregator-wrapper.tpl.php.
 *
 * @see aggregator-wrapper.tpl.php
 */
function template_preprocess_aggregator_wrapper(&$variables) {
  $variables['pager'] = theme('pager', NULL, 20, 0);
}
248 249

/**
250
 * Process variables for aggregator-item.tpl.php.
251
 *
252
 * @see aggregator-item.tpl.php
253
 */
254 255 256 257 258 259
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);
260

261 262
  $variables['source_url'] = '';
  $variables['source_title'] = '';
263
  if (isset($item->ftitle) && isset($item->fid)) {
264 265
    $variables['source_url'] = url("aggregator/sources/$item->fid");
    $variables['source_title'] = check_plain($item->ftitle);
266 267
  }
  if (date('Ymd', $item->timestamp) == date('Ymd')) {
268
    $variables['source_date'] = t('%ago ago', array('%ago' => format_interval($_SERVER['REQUEST_TIME'] - $item->timestamp)));
269 270
  }
  else {
271
    $variables['source_date'] = format_date($item->timestamp, 'custom', variable_get('date_format_medium', 'D, m/d/Y - H:i'));
272 273
  }

274 275
  $variables['categories'] = array();
  foreach ($item->categories as $category) {
276
    $variables['categories'][$category->cid] = l($category->title, 'aggregator/categories/' . $category->cid);
277 278 279 280 281 282 283 284 285
  }
}

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

286 287
  $output = '';
  while ($feed = db_fetch_object($result)) {
288
    // Most recent items:
289
    $summary_items = array();
290 291 292
    if (variable_get('aggregator_summary_items', 3)) {
      $items = db_query_range('SELECT i.title, i.timestamp, i.link FROM {aggregator_item} i WHERE i.fid = %d ORDER BY i.timestamp DESC', $feed->fid, 0, variable_get('aggregator_summary_items', 3));
      while ($item = db_fetch_object($items)) {
293
        $summary_items[] = theme('aggregator_summary_item', $item);
294 295
      }
    }
296
    $feed->url = url('aggregator/sources/' . $feed->fid);
297
    $output .= theme('aggregator_summary_items', $summary_items, $feed);
298 299
  }
  $output .= theme('feed_icon', url('aggregator/opml'), t('OPML feed'));
300 301

  return theme('aggregator_wrapper', $output);
302 303 304 305 306 307 308 309
}

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

310
  $output = '';
311 312
  while ($category = db_fetch_object($result)) {
    if (variable_get('aggregator_summary_items', 3)) {
313
      $summary_items = array();
314 315
      $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 = %d ORDER BY i.timestamp DESC', $category->cid, 0, variable_get('aggregator_summary_items', 3));
      while ($item = db_fetch_object($items)) {
316
        $summary_items[] = theme('aggregator_summary_item', $item);
317 318
      }
    }
319
    $category->url = url('aggregator/categories/' . $category->cid);
320
    $output .= theme('aggregator_summary_items', $summary_items, $category);
321 322
  }

323
  return theme('aggregator_wrapper', $output);
324 325 326 327 328 329 330
}

/**
 * Menu callback; generate an RSS 0.92 feed of aggregator items or categories.
 */
function aggregator_page_rss() {
  $result = NULL;
331
  // arg(2) is the passed cid, only select for that category.
332 333 334 335 336
  if (arg(2)) {
    $category = db_fetch_object(db_query('SELECT cid, title FROM {aggregator_category} WHERE cid = %d', arg(2)));
    $sql = '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 = %d ORDER BY timestamp DESC, i.iid DESC';
    $result = db_query_range($sql, $category->cid, 0, variable_get('feed_default_items', 10));
  }
337
  // Or, get the default aggregator items.
338
  else {
339
    $category = NULL;
340 341 342
    $sql = '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';
    $result = db_query_range($sql, 0, variable_get('feed_default_items', 10));
  }
343

344
  $feeds = array();
345
  while ($item = db_fetch_object($result)) {
346 347
    $feeds[] = $item;
  }
348

349 350 351 352
  return theme('aggregator_page_rss', $feeds, $category);
}

/**
353
 * Theme the RSS output.
354
 *
355 356 357 358
 * @param $feeds
 *   An array of the feeds to theme.
 * @param $category
 *   A common category, if any, for all the feeds.
359 360 361 362 363 364 365 366 367
 * @ingroup themeable
 */
function theme_aggregator_page_rss($feeds, $category = NULL) {
  drupal_set_header('Content-Type: application/rss+xml; charset=utf-8');

  $items = '';
  $feed_length = variable_get('feed_item_length', 'teaser');
  foreach ($feeds as $feed) {
    switch ($feed_length) {
368
      case 'teaser':
369 370
        $teaser = node_teaser($feed->description);
        if ($teaser != $feed->description) {
371
          $teaser .= '<p><a href="' . check_url($feed->link) . '">' . t('read more') . "</a></p>\n";
372
        }
373
        $feed->description = $teaser;
374 375
        break;
      case 'title':
376
        $feed->description = '';
377 378
        break;
    }
379
    $items .= format_rss_item($feed->ftitle . ': ' . $feed->title, $feed->link, $feed->description, array('pubDate' => date('r', $feed->timestamp)));
380 381
  }

382
  $site_name = variable_get('site_name', 'Drupal');
383
  $url = url((isset($category) ? 'aggregator/categories/' . $category->cid : 'aggregator'), array('absolute' => TRUE));
384
  $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));
385

386
  $output  = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n";
387
  $output .= "<rss version=\"2.0\">\n";
388
  $output .= format_rss_channel(t('@site_name aggregator', array('@site_name' => $site_name)), $url, $description, $items);
389 390 391 392 393 394 395
  $output .= "</rss>\n";

  print $output;
}

/**
 * Menu callback; generates an OPML representation of all feeds.
396 397 398 399 400
 *
 * @param $cid
 *   If set, feeds are exported only from a category with this ID. Otherwise, all feeds are exported.
 * @return
 *   The output XML.
401 402 403 404 405 406 407 408
 */
function aggregator_page_opml($cid = NULL) {
  if ($cid) {
    $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 = %d ORDER BY title', $cid);
  }
  else {
    $result = db_query('SELECT * FROM {aggregator_feed} ORDER BY title');
  }
409

410
  $feeds = array();
411 412 413
  while ($item = db_fetch_object($result)) {
    $feeds[] = $item;
  }
414

415 416 417 418
  return theme('aggregator_page_opml', $feeds);
}

/**
419
 * Theme the OPML feed output.
420
 *
421 422
 * @param $feeds
 *   An array of the feeds to theme.
423 424 425 426
 * @ingroup themeable
 */
function theme_aggregator_page_opml($feeds) {
  drupal_set_header('Content-Type: text/xml; charset=utf-8');
427

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

  print $output;
}

/**
445
 * Process variables for aggregator-summary-items.tpl.php.
446
 *
447 448 449 450 451 452 453 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);
  $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
459
 */
460 461 462 463 464
function template_preprocess_aggregator_summary_item(&$variables) {
  $item = $variables['item'];

  $variables['feed_url'] = check_url($item->link);
  $variables['feed_title'] = check_plain($item->title);
465
  $variables['feed_age'] = t('%age old', array('%age' => format_interval($_SERVER['REQUEST_TIME'] - $item->timestamp)));
466 467 468

  $variables['source_url'] = '';
  $variables['source_title'] = '';
469
  if (!empty($item->feed_link)) {
470 471
    $variables['source_url'] = check_url($item->feed_link);
    $variables['source_title'] = check_plain($item->feed_title);
472 473 474 475
  }
}

/**
476
 * Process variables for aggregator-feed-source.tpl.php.
477
 *
478
 * @see aggregator-feed-source.tpl.php
479
 */
480 481
function template_preprocess_aggregator_feed_source(&$variables) {
  $feed = $variables['feed'];
482

483 484 485 486
  $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)));
487 488

  if ($feed->checked) {
489
    $variables['last_checked'] = t('@time ago', array('@time' => format_interval($_SERVER['REQUEST_TIME'] - $feed->checked)));
490 491
  }
  else {
492
    $variables['last_checked'] = t('never');
493 494 495
  }

  if (user_access('administer news feeds')) {
496
    $variables['last_checked'] = l($variables['last_checked'], 'admin/content/aggregator');
497 498
  }
}