system.module 92.2 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2
// $Id$
Dries's avatar
 
Dries committed
3

Dries's avatar
 
Dries committed
4 5 6 7 8
/**
 * @file
 * Configuration system that lets administrators modify the workings of the site.
 */

Steven Wittens's avatar
Steven Wittens committed
9
define('VERSION', '6.0-dev');
10

Dries's avatar
 
Dries committed
11 12 13 14
/**
 * Implementation of hook_help().
 */
function system_help($section) {
15 16
  global $base_url;

17
  switch ($section) {
18
    case 'admin/help#system':
19
      $output = '<p>'. t('The system module provides system-wide defaults such as running jobs at a particular time, and storing web pages to improve efficiency. The ability to run scheduled jobs makes administering the website more usable, as administrators do not have to manually start jobs. The storing of web pages, or caching, allows the site to efficiently re-use web pages and improve website performance. The settings module provides control over preferences, behaviours including visual and operational settings.') .'</p>';
20
      $output .= '<p>'. t('Some modules require regularly scheduled actions, such as cleaning up logfiles. Cron, which stands for chronograph, is a periodic command scheduler executing commands at intervals specified in seconds. It can be used to control the execution of daily, weekly and monthly jobs (or anything with a period measured in seconds). The aggregator module periodically updates feeds using cron. Ping periodically notifies services of new content on your site. Search periodically indexes the content on your site. Automating tasks is one of the best ways to keep a system running smoothly, and if most of your administration does not require your direct involvement, cron is an ideal solution. Cron can, if necessary, also be run manually.') .'</p>';
21
      $output .= '<p>'. t("There is a caching mechanism which stores dynamically generated web pages in a database. By caching a web page, the system module does not have to create the page each time someone wants to view it, instead it takes only one SQL query to display it, reducing response time and the server's load. Only pages requested by <em>anonymous</em> users are cached. In order to reduce server load and save bandwidth, the system module stores and sends cached pages compressed.") .'</p>';
22
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="@system">System page</a>.', array('@system' => 'http://drupal.org/handbook/modules/system/')) .'</p>';
23
      return $output;
24
    case 'admin':
25
      return '<p>'. t('Welcome to the administration section. Here you may control how your site functions.') .'</p>';
26
    case 'admin/by-module':
27
      return '<p>'. t('This page shows you all available administration tasks for each module.') .'</p>';
28
    case 'admin/build/themes':
29
      return '<p>'. t('Select which themes are available to your users and specify the default theme. To configure site-wide display settings, click the "configure" task above. Alternately, to override these settings in a specific theme, click the "configure" link for the corresponding theme. Note that different themes may have different regions available for rendering content like blocks. If you want consistency in what your users see, you may wish to enable only one theme.') .'</p>';
30
    case 'admin/build/themes/settings':
31
      return '<p>'. t('These options control the default display settings for your entire site, across all themes. Unless they have been overridden by a specific theme, these settings will be used.') .'</p>';
32 33
    case 'admin/build/themes/settings/'. arg(4):
      $reference = explode('.', arg(4), 2);
34
      $theme = array_pop($reference);
35
      return '<p>'. t('These options control the display settings for the <code>%template</code> theme. When your site is displayed using this theme, these settings will be used. By clicking "Reset to defaults," you can choose to use the <a href="@global">global settings</a> for this theme.', array('%template' => $theme, '@global' => url('admin/build/themes/settings'))) .'</p>';
36
    case 'admin/build/modules':
37
      return t('<p>Modules are plugins for Drupal that extend its core functionality. Here you can select which modules are enabled. Click on the name of the module in the navigation menu for their individual configuration pages. Once a module is enabled, new <a href="@permissions">permissions</a> might be made available. Modules can automatically be temporarily disabled to reduce server load when your site becomes extremely busy by enabling the throttle.module and checking throttle. The auto-throttle functionality must be enabled on the <a href="@throttle">throttle configuration page</a> after having enabled the throttle module.</p>
38
<p>It is important that <a href="@update-php">update.php</a> is run every time a module is updated to a newer version.</p><p>You can find all administration tasks belonging to a particular module on the <a href="@by-module">administration by module page</a>.</p>', array('@permissions' => url('admin/user/access'), '@throttle' => url('admin/settings/throttle'), '@update-php' => $base_url .'/update.php', '@by-module' => url('admin/by-module')));
39
    case 'admin/build/modules/uninstall':
40
      return '<p>'. t('The uninstall process removes all data related to a module. To uninstall a module, you must first disable it. Not all modules support this feature.') .'</p>';
41
    case 'admin/logs/status':
42
      return '<p>'. t("Here you can find a short overview of your Drupal site's parameters as well as any problems detected with your installation. It is useful to copy/paste this information when you need support.") .'</p>';
43
  }
Dries's avatar
 
Dries committed
44 45
}

Dries's avatar
 
Dries committed
46 47 48
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
49
function system_perm() {
50
  return array('administer site configuration', 'access administration pages', 'select different theme');
Dries's avatar
 
Dries committed
51 52
}

53 54 55 56 57
/**
 * Implementation of hook_elements().
 */
function system_elements() {
  // Top level form
58
  $type['form'] = array('#method' => 'post', '#action' => request_uri());
59 60

  // Inputs
61
  $type['checkbox'] = array('#input' => TRUE, '#return_value' => 1);
62 63
  $type['submit'] = array('#input' => TRUE, '#name' => 'op', '#button_type' => 'submit', '#executes_submit_callback' => TRUE);
  $type['button'] = array('#input' => TRUE, '#name' => 'op', '#button_type' => 'submit', '#executes_submit_callback' => FALSE);
64
  $type['textfield'] = array('#input' => TRUE, '#size' => 60, '#maxlength' => 128, '#autocomplete_path' => FALSE);
65
  $type['password'] = array('#input' => TRUE, '#size' => 60, '#maxlength' => 128);
66
  $type['password_confirm'] = array('#input' => TRUE, '#process' => array('expand_password_confirm' => array()));
67
  $type['textarea'] = array('#input' => TRUE, '#cols' => 60, '#rows' => 5, '#resizable' => TRUE);
68
  $type['radios'] = array('#input' => TRUE, '#process' => array('expand_radios' => array()));
69
  $type['radio'] = array('#input' => TRUE, '#default_value' => NULL);
70
  $type['checkboxes'] = array('#input' => TRUE, '#process' => array('expand_checkboxes' => array()), '#tree' => TRUE);
71
  $type['select'] = array('#input' => TRUE, '#size' => 0, '#multiple' => FALSE);
72
  $type['weight'] = array('#input' => TRUE, '#delta' => 10, '#default_value' => 0, '#process' => array('process_weight' => array()));
73
  $type['date'] = array('#input' => TRUE, '#process' => array('expand_date' => array()), '#validate' => array('date_validate' => array()));
74
  $type['file'] = array('#input' => TRUE, '#size' => 60);
75 76

  // Form structure
77
  $type['item'] = array('#value' => '');
78 79 80
  $type['hidden'] = array('#input' => TRUE);
  $type['value'] = array('#input' => TRUE);
  $type['markup'] = array('#prefix' => '', '#suffix' => '');
81
  $type['fieldset'] = array('#collapsible' => FALSE, '#collapsed' => FALSE, '#value' => NULL);
Dries's avatar
Dries committed
82
  $type['token'] = array('#input' => TRUE);
83 84 85
  return $type;
}

Dries's avatar
 
Dries committed
86
/**
Dries's avatar
 
Dries committed
87
 * Implementation of hook_menu().
Dries's avatar
 
Dries committed
88
 */
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
function system_menu() {
  $items['system/files'] = array(
    'title' => t('File download'),
    'page callback' => 'file_download',
    'access callback' => TRUE,
    'type' => MENU_CALLBACK,
  );
  $items['admin'] = array(
    'title' => t('Administer'),
    'access arguments' => array('access administration pages'),
    'page callback' => 'system_main_admin_page',
    'weight' => 9,
  );
  $items['admin/compact'] = array(
    'title' => t('Compact mode'),
    'page callback' => 'system_admin_compact_page',
    'type' => MENU_CALLBACK,
  );
  $items['admin/by-task'] = array(
    'title' => t('By task'),
    'page callback' => 'system_main_admin_page',
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items['admin/by-module'] = array(
    'title' => t('By module'),
    'page callback' => 'system_admin_by_module',
    'type' => MENU_LOCAL_TASK,
    'weight' => 2,
  );
  // menu items that are basically just menu blocks
  $items['admin/settings'] = array(
    'title' => t('Site configuration'),
    'description' => t('Adjust basic site configuration options.'),
    'position' => 'right',
    'weight' => -5,
    'page callback' => 'system_settings_overview',
    'access arguments' => array('administer site configuration'),
  );
  $items['admin/build'] = array(
    'title' => t('Site building'),
    'description' => t('Control how your site looks and feels.'),
    'position' => 'right',
    'weight' => -10,
    'page callback' => 'system_admin_menu_block_page',
    'access arguments' => array('administer site configuration'),
  );
  $items['admin/settings/admin'] = array(
    'title' => t('Administration theme'),
    'description' => t('Settings for how your administrative pages should look.'),
    'position' => 'left',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('system_admin_theme_settings'),
    'block callback' => 'system_admin_theme_settings',
  );
  // Themes:
  $items['admin/build/themes'] = array(
    'title' => t('Themes'),
    'description' => t('Change which theme your site uses or allows users to set.'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('system_themes'),
  );
  $items['admin/build/themes/select'] = array(
    'title' => t('List'),
    'description' => t('Select the default theme.'),
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -1,
  );
  $items['admin/build/themes/settings'] = array(
    'title' => t('Configure'),
    'page arguments' => array('system_theme_settings'),
    'type' => MENU_LOCAL_TASK,
  );
  // Theme configuration subtabs
  $items['admin/build/themes/settings/global'] = array(
    'title' => t('Global settings'),
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -1,
  );
Dries's avatar
 
Dries committed
167

168 169 170 171 172 173 174
  foreach (list_themes() as $theme) {
    if ($theme->status) {
      $items['admin/build/themes/settings/'. $theme->name] = array(
        'title' => $theme->name,
        'page arguments' => array('system_theme_settings', $theme->name),
        'type' => MENU_LOCAL_TASK,
      );
Dries's avatar
 
Dries committed
175
    }
Dries's avatar
 
Dries committed
176
  }
drumm's avatar
drumm committed
177

178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
  // Modules:
  $items['admin/build/modules'] = array(
    'title' => t('Modules'),
    'description' => t('Enable or disable add-on modules for your site.'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('system_modules'),
  );
  $items['admin/build/modules/list'] = array(
    'title' => t('List'),
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items['admin/build/modules/list/confirm'] = array(
    'title' => t('List'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/build/modules/uninstall'] = array(
    'title' => t('Uninstall'),
    'page arguments' => array('system_modules_uninstall'),
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/build/modules/uninstall/confirm'] = array(
    'title' => t('Uninstall'),
    'type' => MENU_CALLBACK,
  );
Dries's avatar
 
Dries committed
202

203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
  // Settings:
  $items['admin/settings/site-information'] = array(
    'title' => t('Site information'),
    'description' => t('Change basic site information, such as the site name, slogan, e-mail address, mission, front page and more.'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('system_site_information_settings'),
  );
  $items['admin/settings/error-reporting'] = array(
    'title' => t('Error reporting'),
    'description' => t('Control how Drupal deals with errors including 403/404 errors as well as PHP error reporting.'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('system_error_reporting_settings'),
  );
  $items['admin/settings/performance'] = array(
    'title' => t('Performance'),
    'description' => t('Enable or disable page caching for anonymous users, and enable or disable CSS preprocessor.'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('system_performance_settings'),
  );
  $items['admin/settings/file-system'] = array(
    'title' => t('File system'),
    'description' => t('Tell Drupal where to store uploaded files and how they are accessed.'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('system_file_system_settings'),
  );
  $items['admin/settings/image-toolkit'] = array(
    'title' => t('Image toolkit'),
    'description' => t('Choose which image toolkit to use if you have installed optional toolkits.'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('system_image_toolkit_settings'),
  );
  $items['admin/content/rss-publishing'] = array(
    'title' => t('RSS publishing'),
    'description' => t('Configure the number of items per feed and whether feeds should be titles/teasers/full-text.'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('system_rss_feeds_settings'),
  );
  $items['admin/settings/date-time'] = array(
    'title' => t('Date and time'),
    'description' => t("Settings for how Drupal displays date and time, as well as the system's default timezone."),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('system_date_time_settings'),
  );
  $items['admin/settings/site-maintenance'] = array(
    'title' => t('Site maintenance'),
    'description' => t('Take the site off-line for maintenance or bring it back online.'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('system_site_maintenance_settings'),
  );
  $items['admin/settings/clean-urls'] = array(
    'title' => t('Clean URLs'),
    'description' => t('Enable or disable clean URLs for your site.'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('system_clean_url_settings'),
  );

  // Logs:
  $items['admin/logs'] = array(
    'title' => t('Logs'),
    'description' => t('View system logs and other status information.'),
    'page callback' => 'system_admin_menu_block_page',
    'weight' => 5,
    'position' => 'left',
  );
  $items['admin/logs/status'] = array(
    'title' => t('Status report'),
    'description' => t("Get a status report about your site's operation and any detected problems."),
    'page callback' => 'system_status',
    'weight' => 10,
    'access arguments' => array('administer site configuration'),
  );
  $items['admin/logs/status/run-cron'] = array(
    'title' => t('Run cron'),
    'page callback' => 'system_run_cron',
    'type' => MENU_CALLBACK,
  );
  $items['admin/logs/status/php'] = array(
    'title' => t('PHP'),
    'page callback' => 'system_php',
    'type' => MENU_CALLBACK,
  );
  $items['admin/logs/status/sql'] = array(
    'title' => t('SQL'),
    'page callback' => 'system_sql',
    'type' => MENU_CALLBACK,
  );
Dries's avatar
 
Dries committed
289
  return $items;
Dries's avatar
 
Dries committed
290 291
}

292 293 294 295 296 297 298 299 300 301 302 303 304
function system_init() {
  // Use the administrative theme if the user is looking at a page in the admin/* path.
  if (arg(0) == 'admin') {
    global $custom_theme;
    $custom_theme = variable_get('admin_theme', '0');
    drupal_add_css(drupal_get_path('module', 'system') .'/admin.css', 'module');
  }

  // Add the CSS for this module.
  drupal_add_css(drupal_get_path('module', 'system') .'/defaults.css', 'module');
  drupal_add_css(drupal_get_path('module', 'system') .'/system.css', 'module');
}

Dries's avatar
 
Dries committed
305 306 307 308 309
/**
 * Implementation of hook_user().
 *
 * Allows users to individually set their theme and time zone.
 */
310
function system_user($type, $edit, &$user, $category = NULL) {
Dries's avatar
Dries committed
311
  if ($type == 'form' && $category == 'account') {
312
    $form['theme_select'] = system_theme_select_form(t('Selecting a different theme will change the look and feel of the site.'), isset($edit['theme']) ? $edit['theme'] : NULL, 2);
Dries's avatar
Dries committed
313

314
    if (variable_get('configurable_timezones', 1)) {
Steven Wittens's avatar
Steven Wittens committed
315
      $zones = _system_zonelist();
316 317 318 319 320 321
      $form['timezone'] = array(
        '#type'=>'fieldset',
        '#title' => t('Locale settings'),
        '#weight' => 6,
        '#collapsible' => TRUE,
      );
322
      $form['timezone']['timezone'] = array(
323 324 325 326 327
        '#type' => 'select',
        '#title' => t('Time zone'),
        '#default_value' => strlen($edit['timezone']) ? $edit['timezone'] : variable_get('date_default_timezone', 0),
        '#options' => $zones,
        '#description' => t('Select your current local time. Dates and times throughout this site will be displayed using this time zone.'),
328
      );
Dries's avatar
 
Dries committed
329
    }
Dries's avatar
Dries committed
330

331
    return $form;
Dries's avatar
 
Dries committed
332
  }
Dries's avatar
 
Dries committed
333 334
}

335 336 337 338
/**
 * Provide the administration overview page.
 */
function system_main_admin_page($arg = NULL) {
339
  return 'This page awaits rewrite'; // TODO: this needs to be rewritten for the new menu system.
340 341 342
  // If we received an argument, they probably meant some other page.
  // Let's 404 them since the menu system cannot be told we do not
  // accept arguments.
343
  if (isset($arg) && substr($arg, 0, 3) != 'by-') {
344 345 346
    return drupal_not_found();
  }

347 348 349 350 351 352
  // Check for status report errors.
  if (system_status(TRUE)) {
    drupal_set_message(t('One or more problems were detected with your Drupal installation. Check the <a href="@status">status report</a> for more information.', array('@status' => url('admin/logs/status'))), 'error');
  }


353 354 355 356
  $menu = menu_get_item(NULL, 'admin');
  usort($menu['children'], '_menu_sort');
  foreach ($menu['children'] as $mid) {
    $block = menu_get_item($mid);
357
    if ($block['block callback'] && function_exists($block['block callback'])) {
358 359 360 361 362 363 364 365 366 367 368 369 370 371
      $arguments = isset($block['block arguments']) ? $block['block arguments'] : array();
      $block['content'] .= call_user_func_array($block['block callback'], $arguments);
    }
    $block['content'] .= theme('admin_block_content', system_admin_menu_block($block));
    $blocks[] = $block;
  }

  return theme('admin_page', $blocks);
}

/**
 * Provide a single block on the administration overview page.
 */
function system_admin_menu_block($block) {
372
  return 'This page awaits rewrite'; // TODO: this needs to be rewritten for the new menu system.
373
  $content = array();
374
  if (is_array($block['children'])) {
375 376 377
    usort($block['children'], '_menu_sort');
    foreach ($block['children'] as $mid) {
      $item = menu_get_item($mid);
378
      if (($item['type'] & MENU_VISIBLE_IN_TREE) && _menu_item_is_accessible($mid)) {
379 380 381 382 383 384 385 386 387 388
        $content[] = $item;
      }
    }
  }
  return $content;
}

/**
 * Provide a single block from the administration menu as a page.
 * This function is often a destination for these blocks.
389
 * For example, 'admin/content/types' needs to have a destination to be valid
390 391 392 393
 * in the Drupal menu system, but too much information there might be
 * hidden, so we supply the contents of the block.
 */
function system_admin_menu_block_page() {
394
  return 'This page awaits rewrite'; // TODO: this needs to be rewritten for the new menu system.
395 396 397 398 399 400 401 402 403 404 405 406
  $menu = menu_get_item(NULL, $_GET['q']);
  $content = system_admin_menu_block($menu);

  $output = theme('admin_block_content', $content);
  return $output;
}

function system_admin_compact_page($mode = 'off') {
  global $user;
  user_save($user, array('admin_compact_mode' => ($mode == 'on')));
  drupal_goto('admin');
}
407

408
/**
409
 * This function allows selection of the theme to show in administration sections.
410
 */
411
function system_admin_theme_settings() {
412 413 414 415 416 417 418 419 420 421 422
  $themes = system_theme_data();
  ksort($themes);
  $options[0] = t('System default');
  foreach ($themes as $theme) {
    $options[$theme->name] = $theme->name;
  }

  $form['admin_theme'] = array(
    '#type' => 'select',
    '#options' => $options,
    '#title' => t('Administration theme'),
423
    '#description' => t('Choose which theme the administration pages should display in. If you choose "System default" the administration pages will use the same theme as the rest of the site.'),
424
    '#default_value' => variable_get('admin_theme', '0'),
425 426 427 428 429
  );

  // In order to give it our own submit, we have to give it the default submit
  // too because the presence of a #submit will prevent the default #submit
  // from being used. Also we want ours first.
430
  $form['#submit']['system_admin_theme_submit'] = array();
431
  $form['#submit']['system_settings_form_submit'] = array();
432
  return system_settings_form($form);
433 434 435
}


436
function system_admin_theme_submit($form_id, $form_values) {
437
  // If we're changing themes, make sure the theme has its blocks initialized.
438
  if ($form_values['admin_theme'] != variable_get('admin_theme', '0')) {
439 440 441 442 443 444 445
    $result = db_query("SELECT status FROM {blocks} WHERE theme = '%s'", $form_values['admin_theme']);
    if (!db_num_rows($result)) {
      system_initialize_theme_blocks($form_values['admin_theme']);
    }
  }
}

446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
/*
 * Returns a fieldset containing the theme select form.
 *
 * @param $description
 *    description of the fieldset
 * @param $default_value
 *    default value of theme radios
 * @param $weight
 *    weight of the fieldset
 * @return
 *    a form array
 */
function system_theme_select_form($description = '', $default_value = '', $weight = 0) {
  if (user_access('select different theme')) {
    foreach (list_themes() as $theme) {
      if ($theme->status) {
        $enabled[] = $theme;
      }
    }

    if (count($enabled) > 1) {
      ksort($enabled);

      $form['themes'] = array(
Dries's avatar
Dries committed
470 471 472 473
        '#type' => 'fieldset',
        '#title' => t('Theme configuration'),
        '#description' => $description,
        '#collapsible' => TRUE,
474 475 476 477 478
        '#theme' => 'system_theme_select_form'
      );

      foreach ($enabled as $info) {
        // For the default theme, revert to an empty string so the user's theme updates when the site theme is changed.
479
        $info->key = $info->name == variable_get('theme_default', 'garland') ? '' : $info->name;
480

Dries's avatar
Dries committed
481
        $info->screenshot = dirname($info->filename) .'/screenshot.png';
482
        $screenshot = file_exists($info->screenshot) ? theme('image', $info->screenshot, t('Screenshot for %theme theme', array('%theme' => $info->name)), '', array('class' => 'screenshot'), FALSE) : t('no screenshot');
483

484
        $form['themes'][$info->key]['screenshot'] = array('#value' => $screenshot);
485
        $form['themes'][$info->key]['description'] = array('#type' => 'item', '#title' => $info->name,  '#value' => dirname($info->filename) . ($info->name == variable_get('theme_default', 'garland') ? '<br /> <em>'. t('(site default theme)') .'</em>' : ''));
486 487 488 489 490 491 492 493 494 495 496
        $options[$info->key] = '';
      }

      $form['themes']['theme'] = array('#type' => 'radios', '#options' => $options, '#default_value' => $default_value ? $default_value : '');
      $form['#weight'] = $weight;
      return $form;
    }
  }
}

function theme_system_theme_select_form($form) {
497 498
  foreach (element_children($form) as $key) {
    $row = array();
499
    if (isset($form[$key]['description']) && is_array($form[$key]['description'])) {
500 501 502
      $row[] = drupal_render($form[$key]['screenshot']);
      $row[] = drupal_render($form[$key]['description']);
      $row[] = drupal_render($form['theme'][$key]);
503 504 505 506
    }
    $rows[] = $row;
  }

507
  $header = array(t('Screenshot'), t('Name'), t('Selected'));
508 509 510 511
  $output = theme('table', $header, $rows);
  return $output;
}

Steven Wittens's avatar
Steven Wittens committed
512 513 514 515 516 517
function _system_zonelist() {
  $timestamp = time();
  $zonelist = array(-11, -10, -9.5, -9, -8, -7, -6, -5, -4, -3.5, -3, -2, -1, 0, 1, 2, 3, 3.5, 4, 5, 5.5, 5.75, 6, 6.5, 7, 8, 9, 9.5, 10, 10.5, 11, 11.5, 12, 12.75, 13, 14);
  $zones = array();
  foreach ($zonelist as $offset) {
    $zone = $offset * 3600;
Dries's avatar
Dries committed
518
    $zones[$zone] = format_date($timestamp, 'custom', variable_get('date_format_long', 'l, F j, Y - H:i') .' O', $zone);
Steven Wittens's avatar
Steven Wittens committed
519 520 521 522
  }
  return $zones;
}

Dries's avatar
Dries committed
523 524 525 526
function system_site_information_settings() {
  $form['site_name'] = array(
    '#type' => 'textfield',
    '#title' => t('Name'),
527
    '#default_value' => variable_get('site_name', 'Drupal'),
528
    '#description' => t('The name of this website.'),
Dries's avatar
Dries committed
529
    '#required' => TRUE
530
  );
Dries's avatar
Dries committed
531 532 533 534
  $form['site_mail'] = array(
    '#type' => 'textfield',
    '#title' => t('E-mail address'),
    '#default_value' => variable_get('site_mail', ini_get('sendmail_from')),
535
    '#description' => t('A valid e-mail address for this website, used by the auto-mailer during registration, new password requests, notifications, etc.')
536
  );
Dries's avatar
Dries committed
537 538 539 540
  $form['site_slogan'] = array(
    '#type' => 'textfield',
    '#title' => t('Slogan'),
    '#default_value' => variable_get('site_slogan', ''),
541
    '#description' => t('The slogan of this website. Some themes display a slogan when available.')
542 543
  );

Dries's avatar
Dries committed
544 545 546 547
  $form['site_mission'] = array(
    '#type' => 'textarea',
    '#title' => t('Mission'),
    '#default_value' => variable_get('site_mission', ''),
548
    '#description' => t('Your site\'s mission statement or focus.')
549
  );
Dries's avatar
Dries committed
550 551 552 553
  $form['site_footer'] = array(
    '#type' => 'textarea',
    '#title' => t('Footer message'),
    '#default_value' => variable_get('site_footer', ''),
554
    '#description' => t('This text will be displayed at the bottom of each page. Useful for adding a copyright notice to your pages.')
555
  );
Dries's avatar
Dries committed
556 557 558
  $form['anonymous'] = array(
    '#type' => 'textfield',
    '#title' => t('Anonymous user'),
559
    '#default_value' => variable_get('anonymous', t('Anonymous')),
560
    '#description' => t('The name used to indicate anonymous users.')
561
  );
Dries's avatar
Dries committed
562 563 564 565
  $form['site_frontpage'] = array(
    '#type' => 'textfield',
    '#title' => t('Default front page'),
    '#default_value' => variable_get('site_frontpage', 'node'),
566 567
    '#size' => 40,
    '#description' => t('The home page displays content from this relative URL. If unsure, specify "node".'),
568
    '#field_prefix' => url(NULL, array('absolute' => TRUE)) . (variable_get('clean_url', 0) ? '' : '?q=')
569
  );
570

571
  return system_settings_form($form);
Dries's avatar
Dries committed
572 573 574 575
}

function system_clean_url_settings() {
  $form['clean_url'] = array(
576 577 578 579
    '#type' => 'radios',
    '#title' => t('Clean URLs'),
    '#default_value' => variable_get('clean_url', 0),
    '#options' => array(t('Disabled'), t('Enabled')),
580
    '#description' => t('This option makes Drupal emit "clean" URLs (i.e. without <code>?q=</code> in the URL).'),
581
  );
582

583 584
  if (!variable_get('clean_url', 0)) {
    if (strpos(request_uri(), '?q=') !== FALSE) {
585 586 587 588 589 590 591 592 593 594 595 596
      drupal_add_js(array('cleanURL' => array('success' => t('Your server has been successfully tested to support this feature.'), 'failure' => t('Your system configuration does not currently support this feature. The <a href="http://drupal.org/node/15365">handbook page on Clean URLs</a> has additional troubleshooting information.'), 'testing' => t('Testing clean URLs...'))), 'setting');
      drupal_add_js(drupal_get_path('module', 'system') .'/system.js', 'module');
      drupal_add_js('
// Global Killswitch
if (Drupal.jsEnabled) {
  $(document).ready(function() {
    Drupal.cleanURLsSettingsCheck();
  });
}', 'inline');

      $form['clean_url']['#description'] .= ' <span>'. t('Before enabling clean URLs, you must perform a test to determine if your server is properly configured. If you are able to see this page again after clicking the "Run the clean URL test" link, the test has succeeded and the radio buttons above will be available. If instead you are directed to a "Page not found" error, you will need to change the configuration of your server. The <a href="@handbook">handbook page on Clean URLs</a> has additional troubleshooting information.', array('@handbook' => 'http://drupal.org/node/15365')) .'</span>';

597
      $form['clean_url']['#disabled'] = TRUE;
598 599
      $form['clean_url']['#prefix'] = '<div id="clean-url">';
      $form['clean_url']['#suffix'] = '<p>'. t('<a href="@clean_url">Run the clean url test</a>.', array('@clean_url' => base_path() .'admin/settings/clean-urls')) .'</p></div>';
600 601
    }
    else {
602
      $form['clean_url']['#description'] .= ' '. t('Your server has been successfully tested to support this feature.');
603 604
    }
  }
Dries's avatar
 
Dries committed
605

606
  return system_settings_form($form);
Dries's avatar
Dries committed
607 608 609
}

function system_error_reporting_settings() {
drumm's avatar
drumm committed
610 611

  $form['site_403'] = array(
Dries's avatar
Dries committed
612
    '#type' => 'textfield',
drumm's avatar
drumm committed
613
    '#title' => t('Default 403 (access denied) page'),
Dries's avatar
Dries committed
614
    '#default_value' => variable_get('site_403', ''),
615 616
    '#size' => 40,
    '#description' => t('This page is displayed when the requested document is denied to the current user. If unsure, specify nothing.'),
617
    '#field_prefix' => url(NULL, array('absolute' => TRUE)) . (variable_get('clean_url', 0) ? '' : '?q=')
618
  );
drumm's avatar
drumm committed
619 620

  $form['site_404'] = array(
Dries's avatar
Dries committed
621
    '#type' => 'textfield',
drumm's avatar
drumm committed
622
    '#title' => t('Default 404 (not found) page'),
Dries's avatar
Dries committed
623
    '#default_value' =>  variable_get('site_404', ''),
624 625
    '#size' => 40,
    '#description' => t('This page is displayed when no other content matches the requested document. If unsure, specify nothing.'),
626
    '#field_prefix' => url(NULL, array('absolute' => TRUE)) . (variable_get('clean_url', 0) ? '' : '?q=')
627
  );
drumm's avatar
drumm committed
628 629

  $form['error_level'] = array(
630 631
    '#type' => 'select', '#title' => t('Error reporting'), '#default_value' => variable_get('error_level', 1),
    '#options' => array(t('Write errors to the log'), t('Write errors to the log and to the screen')),
drumm's avatar
drumm committed
632
    '#description' =>  t('Where Drupal, PHP and SQL errors are logged. On a production server it is recommended that errors are only written to the error log. On a test server it can be helpful to write logs to the screen.')
633
  );
drumm's avatar
drumm committed
634

Dries's avatar
 
Dries committed
635 636
  $period = drupal_map_assoc(array(3600, 10800, 21600, 32400, 43200, 86400, 172800, 259200, 604800, 1209600, 2419200), 'format_interval');
  $period['1000000000'] = t('Never');
drumm's avatar
drumm committed
637
  $form['watchdog_clear'] = array(
Dries's avatar
Dries committed
638 639 640 641
    '#type' => 'select',
    '#title' => t('Discard log entries older than'),
    '#default_value' => variable_get('watchdog_clear', 604800),
    '#options' => $period,
drumm's avatar
drumm committed
642
    '#description' => t('The time log entries should be kept. Older entries will be automatically discarded. Requires crontab.')
643
  );
Dries's avatar
 
Dries committed
644

645
  return system_settings_form($form);
Dries's avatar
Dries committed
646
}
Dries's avatar
 
Dries committed
647

648
function system_performance_settings() {
649

650 651 652 653 654 655
  $description = '<p>'. t("The normal cache mode is suitable for most sites and does not cause any side effects. The aggressive cache mode causes Drupal to skip the loading (init) and unloading (exit) of enabled modules when serving a cached page. This results in an additional performance boost but can cause unwanted side effects.") .'</p>';

  $problem_modules = array_unique(array_merge(module_implements('init'), module_implements('exit')));
  sort($problem_modules);

  if (count($problem_modules) > 0) {
656
    $description .= '<p>'. t('<strong class="error">The following enabled modules are incompatible with aggressive mode caching and will not function properly: %modules</strong>', array('%modules' => implode(', ', $problem_modules))) .'.</p>';
657 658
  }
  else {
659
    $description .= '<p>'. t('<strong class="ok">Currently, all enabled modules are compatible with the aggressive caching policy.</strong> Please note, if you use aggressive caching and enable new modules, you will need to check this page again to ensure compatibility.') .'</p>';
660
  }
661 662 663 664 665
  $form['page_cache'] = array(
    '#type' => 'fieldset',
    '#title' => t('Page cache'),
    '#description' => t('Enabling the cache will offer a significant performance boost. Drupal can store and send compressed cached pages requested by <em>anonymous</em> users. By caching a web page, Drupal does not have to construct the page each time someone wants to view it.'),
  );
666

667
  $form['page_cache']['cache'] = array(
Dries's avatar
Dries committed
668
    '#type' => 'radios',
669
    '#title' => t('Caching mode'),
Dries's avatar
Dries committed
670
    '#default_value' => variable_get('cache', CACHE_DISABLED),
671 672
    '#options' => array(CACHE_DISABLED => t('Disabled'), CACHE_NORMAL => t('Normal (recommended, no side effects)'), CACHE_AGGRESSIVE => t('Aggressive (experts only, possible side effects)')),
    '#description' => $description
673 674
  );

675 676
  $period = drupal_map_assoc(array(0, 60, 180, 300, 600, 900, 1800, 2700, 3600, 10800, 21600, 32400, 43200, 86400), 'format_interval');
  $period[0] = t('none');
677
  $form['page_cache']['cache_lifetime'] = array(
Dries's avatar
Dries committed
678 679 680 681
    '#type' => 'select',
    '#title' => t('Minimum cache lifetime'),
    '#default_value' => variable_get('cache_lifetime', 0),
    '#options' => $period,
682
    '#description' => t('On high-traffic sites it can become necessary to enforce a minimum cache lifetime. The minimum cache lifetime is the minimum amount of time that will go by before the cache is emptied and recreated. A larger minimum cache lifetime offers better performance, but users will not see new content for a longer period of time.')
683
  );
684

685 686 687 688 689
  $form['bandwidth_optimizations'] = array(
    '#type' => 'fieldset',
    '#title' => t('Bandwidth optimizations'),
    '#description' => t('These options can help reduce both the size and number of requests made to your website. This can reduce the server load, the bandwidth used, and the average page loading time for your visitors.')
  );
690

691
  $directory = file_directory_path();
692
  $is_writable = is_dir($directory) && is_writable($directory) && (variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC) == FILE_DOWNLOADS_PUBLIC);
693 694 695 696 697 698 699 700 701 702 703
  $form['bandwidth_optimizations']['preprocess_css'] = array(
    '#type' => 'radios',
    '#title' => t('Aggregate and compress CSS files'),
    '#default_value' => variable_get('preprocess_css', FALSE) && $is_writable,
    '#disabled' => !$is_writable,
    '#options' => array(t('Disabled'), t('Enabled')),
    '#description' => t("Some Drupal modules include their own CSS files. When these modules are enabled, each module's CSS file adds an additional HTTP request to the page, which can increase the load time of each page. These HTTP requests can also slightly increase server load. It is recommended to only turn this option on when your site is in production, as it can interfere with theme development. This option is disabled if you have not set up your files directory, or if your download method is set to private."),
  );

  $form['#submit']['system_settings_form_submit'] = array();
  $form['#submit']['drupal_clear_css_cache'] = array();
Dries's avatar
 
Dries committed
704

705
  return system_settings_form($form);
Dries's avatar
Dries committed
706
}
Dries's avatar
 
Dries committed
707

Dries's avatar
Dries committed
708
function system_file_system_settings() {
709

Dries's avatar
Dries committed
710
  $form['file_directory_path'] = array(
711 712 713 714
    '#type' => 'textfield',
    '#title' => t('File system path'),
    '#default_value' => file_directory_path(),
    '#maxlength' => 255,
715
    '#description' => t('A file system path where the files will be stored. This directory has to exist and be writable by Drupal. If the download method is set to public this directory has to be relative to the Drupal installation directory, and be accessible over the web. When download method is set to private this directory should not be accessible over the web. Changing this location after the site has been in use will cause problems so only change this setting on an existing site if you know what you are doing.'),
716
    '#after_build' => array('system_check_directory'),
717 718
  );

Dries's avatar
Dries committed
719
  $form['file_directory_temp'] = array(
720 721 722 723 724
    '#type' => 'textfield',
    '#title' => t('Temporary directory'),
    '#default_value' => file_directory_temp(),
    '#maxlength' => 255,
    '#description' => t('Location where uploaded files will be kept during previews. Relative paths will be resolved relative to the Drupal installation directory.'),
725
    '#after_build' => array('system_check_directory'),
726 727
  );

Dries's avatar
Dries committed
728 729 730 731
  $form['file_downloads'] = array(
    '#type' => 'radios',
    '#title' => t('Download method'),
    '#default_value' => variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC),
732
    '#options' => array(FILE_DOWNLOADS_PUBLIC => t('Public - files are available using HTTP directly.'), FILE_DOWNLOADS_PRIVATE => t('Private - files are transferred by Drupal.')),
733
    '#description' => t('If you want any sort of access control on the downloading of files, this needs to be set to <em>private</em>. You can change this at any time, however all download URLs will change and there may be unexpected problems so it is not recommended.')
734
  );
Dries's avatar
 
Dries committed
735

736
  return system_settings_form($form);
Dries's avatar
Dries committed
737 738 739
}

function system_image_toolkit_settings() {
740 741
  $toolkits_available = image_get_available_toolkits();
  if (count($toolkits_available) > 1) {
Dries's avatar
Dries committed
742 743 744 745 746
    $form['image_toolkit'] = array(
      '#type' => 'radios',
      '#title' => t('Select an image processing toolkit'),
      '#default_value' => variable_get('image_toolkit', image_get_toolkit()),
      '#options' => $toolkits_available
747
    );
748
  }
Dries's avatar
Dries committed
749
  else {
750
    $form['image_toolkit'] = array('#value' => '<p>'. t("No image toolkits found. Drupal will use PHP's built-in GD library for image handling.") .'</p>');
Dries's avatar
Dries committed
751
  }
752 753
  $form['image_toolkit_settings'] = image_toolkit_invoke('settings');
  return system_settings_form($form);
Dries's avatar
Dries committed
754 755 756
}

function system_rss_feeds_settings() {
757

Dries's avatar
Dries committed
758 759 760 761
  $form['feed_default_items'] = array(
    '#type' => 'select',
    '#title' => t('Number of items per feed'),
    '#default_value' => variable_get('feed_default_items', 10),
762 763
    '#options' => drupal_map_assoc(array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30)),
    '#description' => t('The default number of items to include in a feed.')
764
  );
Dries's avatar
Dries committed
765 766 767
  $form['feed_item_length'] = array(
    '#type' => 'select',
    '#title' => t('Display of XML feed items'),
Dries's avatar
Dries committed
768
    '#default_value' => variable_get('feed_item_length', 'teaser'),
769 770
    '#options' => array('title' => t('Titles only'), 'teaser' => t('Titles plus teaser'), 'fulltext' => t('Full text')),
    '#description' => t('Global setting for the length of XML feed items that are output by default.')
771
  );
772

773
  return system_settings_form($form);
Dries's avatar
Dries committed
774 775 776
}

function system_date_time_settings() {
777
  // Date settings:
Steven Wittens's avatar
Steven Wittens committed
778
  $zones = _system_zonelist();
779

780
  // Date settings: possible date formats
781
  $dateshort = array('Y-m-d H:i', 'm/d/Y - H:i', 'd/m/Y - H:i', 'Y/m/d - H:i',
782
           'd.m.Y - H:i', 'm/d/Y - g:ia', 'd/m/Y - g:ia', 'Y/m/d - g:ia',
Dries's avatar
 
Dries committed
783 784
           'M j Y - H:i', 'j M Y - H:i', 'Y M j - H:i',
           'M j Y - g:ia', 'j M Y - g:ia', 'Y M j - g:ia');
Dries's avatar
 
Dries committed
785 786
  $datemedium = array('D, Y-m-d H:i', 'D, m/d/Y - H:i', 'D, d/m/Y - H:i',
          'D, Y/m/d - H:i', 'F j, Y - H:i', 'j F, Y - H:i', 'Y, F j - H:i',
Dries's avatar
 
Dries committed
787
          'D, m/d/Y - g:ia', 'D, d/m/Y - g:ia', 'D, Y/m/d - g:ia',
788
          'F j, Y - g:ia', 'j F Y - g:ia', 'Y, F j - g:ia', 'j. F Y - G:i');
Dries's avatar
 
Dries committed
789
  $datelong = array('l, F j, Y - H:i', 'l, j F, Y - H:i', 'l, Y,  F j - H:i',
790
        'l, F j, Y - g:ia', 'l, j F Y - g:ia', 'l, Y,  F j - g:ia', 'l, j. F Y - G:i');
Dries's avatar
 
Dries committed
791

792
  // Date settings: construct choices for user
Dries's avatar
 
Dries committed
793
  foreach ($dateshort as $f) {
Dries's avatar
 
Dries committed
794
    $dateshortchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
 
Dries committed
795 796
  }
  foreach ($datemedium as $f) {
Dries's avatar
 
Dries committed
797
    $datemediumchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
 
Dries committed
798 799
  }
  foreach ($datelong as $f) {
Dries's avatar
 
Dries committed
800
    $datelongchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
 
Dries committed
801 802
  }

Dries's avatar
Dries committed
803 804 805 806 807 808
  $form['date_default_timezone'] = array(
    '#type' => 'select',
    '#title' => t('Default time zone'),
    '#default_value' => variable_get('date_default_timezone', 0),
    '#options' => $zones,
    '#description' => t('Select the default site time zone.')
809 810
  );

Dries's avatar
Dries committed
811 812 813 814 815
  $form['configurable_timezones'] = array(
    '#type' => 'radios',
    '#title' => t('Configurable time zones'),
    '#default_value' => variable_get('configurable_timezones', 1),
    '#options' => array(t('Disabled'), t('Enabled')),
816
    '#description' => t('Enable or disable user-configurable time zones. When enabled, users can set their own time zone and dates will be updated accordingly.')
817 818
  );

Dries's avatar
Dries committed
819 820 821
  $form['date_format_short'] = array(
    '#type' => 'select',
    '#title' => t('Short date format'),
822
    '#default_value' => variable_get('date_format_short', $dateshort[1]),
Dries's avatar
Dries committed
823 824
    '#options' => $dateshortchoices,
    '#description' => t('The short format of date display.')
825 826
  );

Dries's avatar
Dries committed
827 828 829
  $form['date_format_medium'] = array(
    '#type' => 'select',
    '#title' => t('Medium date format'),
830
    '#default_value' => variable_get('date_format_medium', $datemedium[1]),
Dries's avatar
Dries committed
831 832
    '#options' => $datemediumchoices,
    '#description' => t('The medium sized date display.')
833 834
  );

Dries's avatar
Dries committed
835 836 837 838 839 840
  $form['date_format_long'] = array(
    '#type' => 'select',
    '#title' => t('Long date format'),
    '#default_value' => variable_get('date_format_long', $datelong[0]),
    '#options' => $datelongchoices,
    '#description' => t('Longer date format used for detailed display.')
841 842
  );

Dries's avatar
Dries committed
843 844 845 846
  $form['date_first_day'] = array(
    '#type' => 'select',
    '#title' => t('First day of week'),
    '#default_value' => variable_get('date_first_day', 0),
847 848
    '#options' => array(0 => t('Sunday'), 1 => t('Monday'), 2 => t('Tuesday'), 3 => t('Wednesday'), 4 => t('Thursday'), 5 => t('Friday'), 6 => t('Saturday')),
    '#description' => t('The first day of the week for calendar views.')
849
  );
Dries's avatar
 
Dries committed
850

851
  return system_settings_form($form);
Dries's avatar
Dries committed
852
}
Dries's avatar
 
Dries committed
853

854
function system_site_maintenance_settings() {
855

Dries's avatar
Dries committed
856
  $form['site_offline'] = array(
857
    '#type' => 'radios',
858
    '#title' => t('Site status'),
859
    '#default_value' => variable_get('site_offline', 0),
860
    '#options' => array(t('Online'), t('Off-line')),
861
    '#description' => t('When set to "Online", all visitors will be able to browse your site normally. When set to "Off-line", only users with the "administer site configuration" permission will be able to access your site to perform maintenance; all other visitors will see the site off-line message configured below. Authorized users can log in during "Off-line" mode directly via the <a href="@user-login">user login</a> page.', array('@user-login' => url('user'))),
862 863
  );

Dries's avatar
Dries committed
864
  $form['site_offline_message'] = array(
865
    '#type' => 'textarea',
866
    '#title' => t('Site off-line message'),
867
    '#default_value' => variable_get('site_offline_message', t('@site is currently under maintenance. We should be back shortly. Thank you for your patience.', array('@site' => variable_get('site_name', 'Drupal')))),
868
    '#description' => t('Message to show visitors when the site is in off-line mode.')
869 870
  );

871
  return system_settings_form($form);
Dries's avatar
Dries committed
872 873
}

874 875
/**
 * Checks the existence of the directory specified in $form_element. This
Dries's avatar
Dries committed
876
 * function is called from the system_settings form to check both the
877 878 879 880 881 882 883
 * file_directory_path and file_directory_temp directories. If validation
 * fails, the form element is flagged with an error from within the
 * file_check_directory function.
 *
 * @param $form_element
 *   The form element containing the name of the directory to check.
 */
884
function system_check_directory($form_element) {
885 886 887 888
  file_check_directory($form_element['#value'], FILE_CREATE_DIRECTORY, $form_element['#parents'][0]);
  return $form_element;
}

Dries's avatar
 
Dries committed
889 890 891 892
/**
 * Retrieves the current status of an array of files in the system table.
 */
function system_get_files_database(&$files, $type) {
Dries's avatar
 
Dries committed
893
  // Extract current files from database.
894
  $result = db_query("SELECT filename, name, type, status, throttle, schema_version FROM {system} WHERE type = '%s'", $type);
Dries's avatar
 
Dries committed
895
  while ($file = db_fetch_object($result)) {
896
    if (isset