Mercurial > defr > drupal > core

annotate modules/aggregator/aggregator.admin.inc @ 1:c1f4ac30525a 6.0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Drupal 6.0
author Franck Deroche <webmaster@defr.org>
date Tue, 23 Dec 2008 14:28:28 +0100
parents
children fff6d4c8c043
rev   line source
webmaster@1 1 <?php
webmaster@1 2 // $Id: aggregator.admin.inc,v 1.7 2008/01/10 22:47:17 goba Exp $
webmaster@1 3
webmaster@1 4 /**
webmaster@1 5 * @file
webmaster@1 6 * Admin page callbacks for the aggregator module.
webmaster@1 7 */
webmaster@1 8
webmaster@1 9 /**
webmaster@1 10 * Menu callback; displays the aggregator administration page.
webmaster@1 11 */
webmaster@1 12 function aggregator_admin_overview() {
webmaster@1 13 return aggregator_view();
webmaster@1 14 }
webmaster@1 15
webmaster@1 16 /**
webmaster@1 17 * Displays the aggregator administration page.
webmaster@1 18 *
webmaster@1 19 * @return
webmaster@1 20 * The page HTML.
webmaster@1 21 */
webmaster@1 22 function aggregator_view() {
webmaster@1 23 $result = db_query('SELECT f.*, COUNT(i.iid) AS items FROM {aggregator_feed} f LEFT JOIN {aggregator_item} i ON f.fid = i.fid GROUP BY f.fid, f.title, f.url, f.refresh, f.checked, f.link, f.description, f.etag, f.modified, f.image, f.block ORDER BY f.title');
webmaster@1 24
webmaster@1 25 $output = '<h3>'. t('Feed overview') .'</h3>';
webmaster@1 26
webmaster@1 27 $header = array(t('Title'), t('Items'), t('Last update'), t('Next update'), array('data' => t('Operations'), 'colspan' => '3'));
webmaster@1 28 $rows = array();
webmaster@1 29 while ($feed = db_fetch_object($result)) {
webmaster@1 30 $rows[] = array(l($feed->title, "aggregator/sources/$feed->fid"), format_plural($feed->items, '1 item', '@count items'), ($feed->checked ? t('@time ago', array('@time' => format_interval(time() - $feed->checked))) : t('never')), ($feed->checked ? t('%time left', array('%time' => format_interval($feed->checked + $feed->refresh - time()))) : t('never')), l(t('edit'), "admin/content/aggregator/edit/feed/$feed->fid"), l(t('remove items'), "admin/content/aggregator/remove/$feed->fid"), l(t('update items'), "admin/content/aggregator/update/$feed->fid"));
webmaster@1 31 }
webmaster@1 32 $output .= theme('table', $header, $rows);
webmaster@1 33
webmaster@1 34 $result = db_query('SELECT c.cid, c.title, count(ci.iid) as items FROM {aggregator_category} c LEFT JOIN {aggregator_category_item} ci ON c.cid = ci.cid GROUP BY c.cid, c.title ORDER BY title');
webmaster@1 35
webmaster@1 36 $output .= '<h3>'. t('Category overview') .'</h3>';
webmaster@1 37
webmaster@1 38 $header = array(t('Title'), t('Items'), t('Operations'));
webmaster@1 39 $rows = array();
webmaster@1 40 while ($category = db_fetch_object($result)) {
webmaster@1 41 $rows[] = array(l($category->title, "aggregator/categories/$category->cid"), format_plural($category->items, '1 item', '@count items'), l(t('edit'), "admin/content/aggregator/edit/category/$category->cid"));
webmaster@1 42 }
webmaster@1 43 $output .= theme('table', $header, $rows);
webmaster@1 44
webmaster@1 45 return $output;
webmaster@1 46 }
webmaster@1 47
webmaster@1 48 /**
webmaster@1 49 * Form builder; Generate a form to add/edit feed sources.
webmaster@1 50 *
webmaster@1 51 * @ingroup forms
webmaster@1 52 * @see aggregator_form_feed_validate()
webmaster@1 53 * @see aggregator_form_feed_submit()
webmaster@1 54 */
webmaster@1 55 function aggregator_form_feed(&$form_state, $edit = array('refresh' => 900, 'title' => '', 'url' => '', 'fid' => NULL)) {
webmaster@1 56 $period = drupal_map_assoc(array(900, 1800, 3600, 7200, 10800, 21600, 32400, 43200, 64800, 86400, 172800, 259200, 604800, 1209600, 2419200), 'format_interval');
webmaster@1 57
webmaster@1 58 if ($edit['refresh'] == '') {
webmaster@1 59 $edit['refresh'] = 3600;
webmaster@1 60 }
webmaster@1 61
webmaster@1 62 $form['title'] = array('#type' => 'textfield',
webmaster@1 63 '#title' => t('Title'),
webmaster@1 64 '#default_value' => $edit['title'],
webmaster@1 65 '#maxlength' => 255,
webmaster@1 66 '#description' => t('The name of the feed (or the name of the website providing the feed).'),
webmaster@1 67 '#required' => TRUE,
webmaster@1 68 );
webmaster@1 69 $form['url'] = array('#type' => 'textfield',
webmaster@1 70 '#title' => t('URL'),
webmaster@1 71 '#default_value' => $edit['url'],
webmaster@1 72 '#maxlength' => 255,
webmaster@1 73 '#description' => t('The fully-qualified URL of the feed.'),
webmaster@1 74 '#required' => TRUE,
webmaster@1 75 );
webmaster@1 76 $form['refresh'] = array('#type' => 'select',
webmaster@1 77 '#title' => t('Update interval'),
webmaster@1 78 '#default_value' => $edit['refresh'],
webmaster@1 79 '#options' => $period,
webmaster@1 80 '#description' => t('The length of time between feed updates. (Requires a correctly configured <a href="@cron">cron maintenance task</a>.)', array('@cron' => url('admin/reports/status'))),
webmaster@1 81 );
webmaster@1 82
webmaster@1 83 // Handling of categories:
webmaster@1 84 $options = array();
webmaster@1 85 $values = array();
webmaster@1 86 $categories = db_query('SELECT c.cid, c.title, f.fid FROM {aggregator_category} c LEFT JOIN {aggregator_category_feed} f ON c.cid = f.cid AND f.fid = %d ORDER BY title', $edit['fid']);
webmaster@1 87 while ($category = db_fetch_object($categories)) {
webmaster@1 88 $options[$category->cid] = check_plain($category->title);
webmaster@1 89 if ($category->fid) $values[] = $category->cid;
webmaster@1 90 }
webmaster@1 91 if ($options) {
webmaster@1 92 $form['category'] = array('#type' => 'checkboxes',
webmaster@1 93 '#title' => t('Categorize news items'),
webmaster@1 94 '#default_value' => $values,
webmaster@1 95 '#options' => $options,
webmaster@1 96 '#description' => t('New feed items are automatically filed in the checked categories.'),
webmaster@1 97 );
webmaster@1 98 }
webmaster@1 99 $form['submit'] = array('#type' => 'submit', '#value' => t('Save'));
webmaster@1 100
webmaster@1 101 if ($edit['fid']) {
webmaster@1 102 $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
webmaster@1 103 $form['fid'] = array('#type' => 'hidden', '#value' => $edit['fid']);
webmaster@1 104 }
webmaster@1 105
webmaster@1 106 return $form;
webmaster@1 107 }
webmaster@1 108
webmaster@1 109 /**
webmaster@1 110 * Validate aggregator_form_feed form submissions.
webmaster@1 111 */
webmaster@1 112 function aggregator_form_feed_validate($form, &$form_state) {
webmaster@1 113 if ($form_state['values']['op'] == t('Save')) {
webmaster@1 114 // Ensure URL is valid.
webmaster@1 115 if (!valid_url($form_state['values']['url'], TRUE)) {
webmaster@1 116 form_set_error('url', t('The URL %url is invalid. Please enter a fully-qualified URL, such as http://www.example.com/feed.xml.', array('%url' => $form_state['values']['url'])));
webmaster@1 117 }
webmaster@1 118 // Check for duplicate titles.
webmaster@1 119 if (isset($form_state['values']['fid'])) {
webmaster@1 120 $result = db_query("SELECT title, url FROM {aggregator_feed} WHERE (title = '%s' OR url='%s') AND fid != %d", $form_state['values']['title'], $form_state['values']['url'], $form_state['values']['fid']);
webmaster@1 121 }
webmaster@1 122 else {
webmaster@1 123 $result = db_query("SELECT title, url FROM {aggregator_feed} WHERE title = '%s' OR url='%s'", $form_state['values']['title'], $form_state['values']['url']);
webmaster@1 124 }
webmaster@1 125 while ($feed = db_fetch_object($result)) {
webmaster@1 126 if (strcasecmp($feed->title, $form_state['values']['title']) == 0) {
webmaster@1 127 form_set_error('title', t('A feed named %feed already exists. Please enter a unique title.', array('%feed' => $form_state['values']['title'])));
webmaster@1 128 }
webmaster@1 129 if (strcasecmp($feed->url, $form_state['values']['url']) == 0) {
webmaster@1 130 form_set_error('url', t('A feed with this URL %url already exists. Please enter a unique URL.', array('%url' => $form_state['values']['url'])));
webmaster@1 131 }
webmaster@1 132 }
webmaster@1 133 }
webmaster@1 134 }
webmaster@1 135
webmaster@1 136 /**
webmaster@1 137 * Process aggregator_form_feed form submissions.
webmaster@1 138 *
webmaster@1 139 * @todo Add delete confirmation dialog.
webmaster@1 140 */
webmaster@1 141 function aggregator_form_feed_submit($form, &$form_state) {
webmaster@1 142 if ($form_state['values']['op'] == t('Delete')) {
webmaster@1 143 $title = $form_state['values']['title'];
webmaster@1 144 // Unset the title:
webmaster@1 145 unset($form_state['values']['title']);
webmaster@1 146 }
webmaster@1 147 aggregator_save_feed($form_state['values']);
webmaster@1 148 if (isset($form_state['values']['fid'])) {
webmaster@1 149 if (isset($form_state['values']['title'])) {
webmaster@1 150 drupal_set_message(t('The feed %feed has been updated.', array('%feed' => $form_state['values']['title'])));
webmaster@1 151 if (arg(0) == 'admin') {
webmaster@1 152 $form_state['redirect'] = 'admin/content/aggregator/';
webmaster@1 153 return;
webmaster@1 154 }
webmaster@1 155 else {
webmaster@1 156 $form_state['redirect'] = 'aggregator/sources/'. $form_state['values']['fid'];
webmaster@1 157 return;
webmaster@1 158 }
webmaster@1 159 }
webmaster@1 160 else {
webmaster@1 161 watchdog('aggregator', 'Feed %feed deleted.', array('%feed' => $title));
webmaster@1 162 drupal_set_message(t('The feed %feed has been deleted.', array('%feed' => $title)));
webmaster@1 163 if (arg(0) == 'admin') {
webmaster@1 164 $form_state['redirect'] = 'admin/content/aggregator/';
webmaster@1 165 return;
webmaster@1 166 }
webmaster@1 167 else {
webmaster@1 168 $form_state['redirect'] = 'aggregator/sources/';
webmaster@1 169 return;
webmaster@1 170 }
webmaster@1 171 }
webmaster@1 172 }
webmaster@1 173 else {
webmaster@1 174 watchdog('aggregator', 'Feed %feed added.', array('%feed' => $form_state['values']['title']), WATCHDOG_NOTICE, l(t('view'), 'admin/content/aggregator'));
webmaster@1 175 drupal_set_message(t('The feed %feed has been added.', array('%feed' => $form_state['values']['title'])));
webmaster@1 176 }
webmaster@1 177 }
webmaster@1 178
webmaster@1 179 function aggregator_admin_remove_feed($form_state, $feed) {
webmaster@1 180 return confirm_form(
webmaster@1 181 array(
webmaster@1 182 'feed' => array(
webmaster@1 183 '#type' => 'value',
webmaster@1 184 '#value' => $feed,
webmaster@1 185 ),
webmaster@1 186 ),
webmaster@1 187 t('Are you sure you want to remove all items from the feed %feed?', array('%feed' => $feed['title'])),
webmaster@1 188 'admin/content/aggregator',
webmaster@1 189 t('This action cannot be undone.'),
webmaster@1 190 t('Remove items'),
webmaster@1 191 t('Cancel')
webmaster@1 192 );
webmaster@1 193 }
webmaster@1 194
webmaster@1 195 /**
webmaster@1 196 * Remove all items from a feed and redirect to the overview page.
webmaster@1 197 *
webmaster@1 198 * @param $feed
webmaster@1 199 * An associative array describing the feed to be cleared.
webmaster@1 200 */
webmaster@1 201 function aggregator_admin_remove_feed_submit($form, &$form_state) {
webmaster@1 202 aggregator_remove($form_state['values']['feed']);
webmaster@1 203 $form_state['redirect'] = 'admin/content/aggregator';
webmaster@1 204 }
webmaster@1 205
webmaster@1 206 /**
webmaster@1 207 * Menu callback; refreshes a feed, then redirects to the overview page.
webmaster@1 208 *
webmaster@1 209 * @param $feed
webmaster@1 210 * An associative array describing the feed to be refreshed.
webmaster@1 211 */
webmaster@1 212 function aggregator_admin_refresh_feed($feed) {
webmaster@1 213 aggregator_refresh($feed);
webmaster@1 214 drupal_goto('admin/content/aggregator');
webmaster@1 215 }
webmaster@1 216
webmaster@1 217 /**
webmaster@1 218 * Form builder; Configure the aggregator system.
webmaster@1 219 *
webmaster@1 220 * @ingroup forms
webmaster@1 221 * @see system_settings_form()
webmaster@1 222 */
webmaster@1 223 function aggregator_admin_settings() {
webmaster@1 224 $items = array(0 => t('none')) + drupal_map_assoc(array(3, 5, 10, 15, 20, 25), '_aggregator_items');
webmaster@1 225 $period = drupal_map_assoc(array(3600, 10800, 21600, 32400, 43200, 86400, 172800, 259200, 604800, 1209600, 2419200, 4838400, 9676800), 'format_interval');
webmaster@1 226
webmaster@1 227 $form['aggregator_allowed_html_tags'] = array(
webmaster@1 228 '#type' => 'textfield', '#title' => t('Allowed HTML tags'), '#size' => 80, '#maxlength' => 255,
webmaster@1 229 '#default_value' => variable_get('aggregator_allowed_html_tags', '<a> <b> <br> <dd> <dl> <dt> <em> <i> <li> <ol> <p> <strong> <u> <ul>'),
webmaster@1 230 '#description' => t('A space-separated list of HTML tags allowed in the content of feed items. (Tags in this list are not removed by Drupal.)')
webmaster@1 231 );
webmaster@1 232
webmaster@1 233 $form['aggregator_summary_items'] = array(
webmaster@1 234 '#type' => 'select', '#title' => t('Items shown in sources and categories pages') ,
webmaster@1 235 '#default_value' => variable_get('aggregator_summary_items', 3), '#options' => $items,
webmaster@1 236 '#description' => t('Number of feed items displayed in feed and category summary pages.')
webmaster@1 237 );
webmaster@1 238
webmaster@1 239 $form['aggregator_clear'] = array(
webmaster@1 240 '#type' => 'select', '#title' => t('Discard items older than'),
webmaster@1 241 '#default_value' => variable_get('aggregator_clear', 9676800), '#options' => $period,
webmaster@1 242 '#description' => t('The length of time to retain feed items before discarding. (Requires a correctly configured <a href="@cron">cron maintenance task</a>.)', array('@cron' => url('admin/reports/status')))
webmaster@1 243 );
webmaster@1 244
webmaster@1 245 $form['aggregator_category_selector'] = array(
webmaster@1 246 '#type' => 'radios', '#title' => t('Category selection type'), '#default_value' => variable_get('aggregator_category_selector', 'checkboxes'),
webmaster@1 247 '#options' => array('checkboxes' => t('checkboxes'), 'select' => t('multiple selector')),
webmaster@1 248 '#description' => t('The type of category selection widget displayed on categorization pages. (For a small number of categories, checkboxes are easier to use, while a multiple selector work well with large numbers of categories.)')
webmaster@1 249 );
webmaster@1 250
webmaster@1 251 return system_settings_form($form);
webmaster@1 252 }
webmaster@1 253
webmaster@1 254 /**
webmaster@1 255 * Form builder; Generate a form to add/edit/delete aggregator categories.
webmaster@1 256 *
webmaster@1 257 * @ingroup forms
webmaster@1 258 * @see aggregator_form_category_validate()
webmaster@1 259 * @see aggregator_form_category_submit()
webmaster@1 260 */
webmaster@1 261 function aggregator_form_category(&$form_state, $edit = array('title' => '', 'description' => '', 'cid' => NULL)) {
webmaster@1 262 $form['title'] = array('#type' => 'textfield',
webmaster@1 263 '#title' => t('Title'),
webmaster@1 264 '#default_value' => $edit['title'],
webmaster@1 265 '#maxlength' => 64,
webmaster@1 266 '#required' => TRUE,
webmaster@1 267 );
webmaster@1 268 $form['description'] = array('#type' => 'textarea',
webmaster@1 269 '#title' => t('Description'),
webmaster@1 270 '#default_value' => $edit['description'],
webmaster@1 271 );
webmaster@1 272 $form['submit'] = array('#type' => 'submit', '#value' => t('Save'));
webmaster@1 273
webmaster@1 274 if ($edit['cid']) {
webmaster@1 275 $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
webmaster@1 276 $form['cid'] = array('#type' => 'hidden', '#value' => $edit['cid']);
webmaster@1 277 }
webmaster@1 278
webmaster@1 279 return $form;
webmaster@1 280 }
webmaster@1 281
webmaster@1 282 /**
webmaster@1 283 * Validate aggregator_form_feed form submissions.
webmaster@1 284 */
webmaster@1 285 function aggregator_form_category_validate($form, &$form_state) {
webmaster@1 286 if ($form_state['values']['op'] == t('Save')) {
webmaster@1 287 // Check for duplicate titles
webmaster@1 288 if (isset($form_state['values']['cid'])) {
webmaster@1 289 $category = db_fetch_object(db_query("SELECT cid FROM {aggregator_category} WHERE title = '%s' AND cid != %d", $form_state['values']['title'], $form_state['values']['cid']));
webmaster@1 290 }
webmaster@1 291 else {
webmaster@1 292 $category = db_fetch_object(db_query("SELECT cid FROM {aggregator_category} WHERE title = '%s'", $form_state['values']['title']));
webmaster@1 293 }
webmaster@1 294 if ($category) {
webmaster@1 295 form_set_error('title', t('A category named %category already exists. Please enter a unique title.', array('%category' => $form_state['values']['title'])));
webmaster@1 296 }
webmaster@1 297 }
webmaster@1 298 }
webmaster@1 299
webmaster@1 300 /**
webmaster@1 301 * Process aggregator_form_category form submissions.
webmaster@1 302 *
webmaster@1 303 * @todo Add delete confirmation dialog.
webmaster@1 304 */
webmaster@1 305 function aggregator_form_category_submit($form, &$form_state) {
webmaster@1 306 if ($form_state['values']['op'] == t('Delete')) {
webmaster@1 307 $title = $form_state['values']['title'];
webmaster@1 308 // Unset the title:
webmaster@1 309 unset($form_state['values']['title']);
webmaster@1 310 }
webmaster@1 311 aggregator_save_category($form_state['values']);
webmaster@1 312 if (isset($form_state['values']['cid'])) {
webmaster@1 313 if (isset($form_state['values']['title'])) {
webmaster@1 314 drupal_set_message(t('The category %category has been updated.', array('%category' => $form_state['values']['title'])));
webmaster@1 315 if (arg(0) == 'admin') {
webmaster@1 316 $form_state['redirect'] = 'admin/content/aggregator/';
webmaster@1 317 return;
webmaster@1 318 }
webmaster@1 319 else {
webmaster@1 320 $form_state['redirect'] = 'aggregator/categories/'. $form_state['values']['cid'];
webmaster@1 321 return;
webmaster@1 322 }
webmaster@1 323 }
webmaster@1 324 else {
webmaster@1 325 watchdog('aggregator', 'Category %category deleted.', array('%category' => $title));
webmaster@1 326 drupal_set_message(t('The category %category has been deleted.', array('%category' => $title)));
webmaster@1 327 if (arg(0) == 'admin') {
webmaster@1 328 $form_state['redirect'] = 'admin/content/aggregator/';
webmaster@1 329 return;
webmaster@1 330 }
webmaster@1 331 else {
webmaster@1 332 $form_state['redirect'] = 'aggregator/categories/';
webmaster@1 333 return;
webmaster@1 334 }
webmaster@1 335 }
webmaster@1 336 }
webmaster@1 337 else {
webmaster@1 338 watchdog('aggregator', 'Category %category added.', array('%category' => $form_state['values']['title']), WATCHDOG_NOTICE, l(t('view'), 'admin/content/aggregator'));
webmaster@1 339 drupal_set_message(t('The category %category has been added.', array('%category' => $form_state['values']['title'])));
webmaster@1 340 }
webmaster@1 341 }