system.module 81 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.
 */

Dries's avatar
Dries committed
9
define('VERSION', '5.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 web site 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 web site 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 22 23
      $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>';
      $output .= t('<p>You can</p>
<ul>
24 25 26 27 28
<li>activate your cron job on the cron page <a href="@file-cron">cron.php</a>.</li>
<li>read how to <a href="@external-http-drupal-org-cron">configure cron jobs</a>.</li>
<li>administer cache settings in <a href="@admin-settings">administer &gt;&gt; site configuration &gt;&gt; page caching</a>.</li>
<li><a href="@cron-status">view</a> whether or not cron is running on your site.</li>
<li>run cron <a href="@cron-manually">manually</a>.</li>
29
</ul>
30
', array('@file-cron' => 'cron.php', '@external-http-drupal-org-cron' => 'http://drupal.org/cron', '@cron-status' => url('admin/logs/status'), '@cron-manually' => url('admin/logs/status/run-cron'), '@admin-settings' => url('admin/settings/page-caching')));
31
      $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>';
32
      return $output;
33
    case 'admin':
34
      return t('<p>Welcome to the administration section. Here you may control how your site functions.</p>');
35 36
    case 'admin/settings/page-caching':
      return t('Enabling the cache will offer a sufficient performance boost. Drupal can store and send compressed cached pages requested by "anonymous" users. By caching a web page, Drupal does not have to create the page each time someone wants to view it.');
37
    case 'admin/build/themes':
38
      return t('<p>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>');
39
    case 'admin/build/themes/settings':
40
      return t('<p>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>');
41
    case 'admin/build/themes/settings/'. arg(3):
42 43
      $reference = explode('.', arg(3), 2);
      $theme = array_pop($reference);
44
      return t('<p>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.</p>', array('%template' => $theme, '@global' => url('admin/build/themes/settings')));
45
    case 'admin/settings/modules':
46 47
      if (empty($_POST) || $_POST['op'] != t('Save configuration')) {
        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>
48
<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>', array('@permissions' => url('admin/user/access'), '@throttle' => url('admin/settings/throttle'), '@update-php' => $base_url .'/update.php'));
49 50
      }
      break;
51
    case 'admin/logs/status':
Steven Wittens's avatar
Steven Wittens committed
52
      return t('<p>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>');
53
  }
Dries's avatar
 
Dries committed
54 55
}

Dries's avatar
 
Dries committed
56 57 58
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
59
function system_perm() {
60
  return array('administer site configuration', 'access administration pages', 'select different theme');
Dries's avatar
 
Dries committed
61 62
}

63 64 65 66 67
/**
 * Implementation of hook_elements().
 */
function system_elements() {
  // Top level form
68
  $type['form'] = array('#method' => 'post', '#action' => request_uri());
69 70

  // Inputs
71
  $type['checkbox'] = array('#input' => TRUE, '#return_value' => 1);
72 73
  $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);
74
  $type['textfield'] = array('#input' => TRUE, '#size' => 60, '#maxlength' => 128, '#autocomplete_path' => FALSE);
75
  $type['password'] = array('#input' => TRUE, '#size' => 30);
76
  $type['password_confirm'] = array('#input' => TRUE, '#process' => array('expand_password_confirm' => array()));
77
  $type['textarea'] = array('#input' => TRUE, '#cols' => 60, '#rows' => 5);
78
  $type['radios'] = array('#input' => TRUE, '#process' => array('expand_radios' => array()));
79
  $type['radio'] = array('#input' => TRUE);
80
  $type['checkboxes'] = array('#input' => TRUE, '#process' => array('expand_checkboxes' => array()), '#tree' => TRUE);
81
  $type['select'] = array('#input' => TRUE);
82
  $type['weight'] = array('#input' => TRUE, '#delta' => 10, '#default_value' => 0, '#process' => array('process_weight' => array()));
83
  $type['date'] = array('#input' => TRUE, '#process' => array('expand_date' => array()), '#validate' => array('date_validate' => array()));
84
  $type['file'] = array('#input' => TRUE, '#size' => 60);
85 86 87

  // Form structure
  $type['item'] = array();
88 89 90 91
  $type['hidden'] = array('#input' => TRUE);
  $type['value'] = array('#input' => TRUE);
  $type['markup'] = array('#prefix' => '', '#suffix' => '');
  $type['fieldset'] = array('#collapsible' => FALSE, '#collapsed' => FALSE);
92 93 94
  return $type;
}

Dries's avatar
 
Dries committed
95
/**
Dries's avatar
 
Dries committed
96
 * Implementation of hook_menu().
Dries's avatar
 
Dries committed
97
 */
Dries's avatar
 
Dries committed
98
function system_menu($may_cache) {
Dries's avatar
 
Dries committed
99
  $items = array();
Dries's avatar
 
Dries committed
100

Dries's avatar
 
Dries committed
101 102 103 104 105 106 107 108
  if ($may_cache) {
    $items[] = array('path' => 'system/files', 'title' => t('file download'),
      'callback' => 'file_download',
      'access' => TRUE,
      'type' => MENU_CALLBACK);

    $access = user_access('administer site configuration');

109 110
    $items[] = array('path' => 'admin', 'title' => t('administer'),
      'access' => user_access('access administration pages'),
111
      'callback' => 'system_main_admin_page',
112
      'weight' => 9);
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
    $items[] = array('path' => 'admin/compact', 'title' => t('compact mode'),
      'access' => user_access('access administration pages'),
      'callback' => 'system_admin_compact_page',
      'type' => MENU_CALLBACK);

    // menu items that are basically just menu blocks
    $items[] = array(
      'path' => 'admin/settings',
      'title' => t('site configuration'),
      'description' => t('Adjust basic site configuration options.'),
      'position' => 'right',
      'weight' => -5,
      'callback' => 'system_settings_overview',
      'access' => $access);

    $items[] = array('path' => 'admin/build',
      'title' => t('site building'),
      'description' => t('Control how your site looks and feels.'),
      'position' => 'right',
      'weight' => -10,
      'callback' => 'system_admin_menu_block_page',
      'access' => $access);

    $items[] = array(
      'path' => 'admin/settings/admin',
138
      'title' => t('administration theme'),
139 140
      'description' => t('Settings for how your administrative pages should look.'),
      'position' => 'left',
141 142
      'callback' => 'drupal_get_form',
      'callback arguments' => array('system_admin_theme_settings'),
143
      'block callback' => 'system_admin_theme_settings',
144
      'access' => $access);
145

Dries's avatar
 
Dries committed
146
    // Themes:
147 148 149 150
    $items[] = array(
      'path' => 'admin/build/themes',
      'title' => t('themes'),
      'description' => t('Change which theme your site uses or allows users to set.'),
151 152 153
      'callback' => 'drupal_get_form',
      'callback arguments' => array('system_themes'),
      'access' => $access);
Dries's avatar
 
Dries committed
154

155 156 157 158
    $items[] = array(
      'path' => 'admin/build/themes/select',
      'title' => t('list'),
      'description' => t('Select the default theme.'),
159 160
      'callback' => 'drupal_get_form',
      'callback arguments' => array('system_themes'),
161 162 163 164 165 166
      'access' => $access,
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => -1);

    $items[] = array('path' => 'admin/build/themes/settings',
      'title' => t('configure'),
167 168
      'callback' => 'drupal_get_form',
      'callback arguments' => array('system_theme_settings'),
169
      'access' => $access,
Dries's avatar
 
Dries committed
170 171 172
      'type' => MENU_LOCAL_TASK);

    // Theme configuration subtabs
173
    $items[] = array('path' => 'admin/build/themes/settings/global', 'title' => t('global settings'),
174 175 176 177 178
      'callback' => 'drupal_get_form',
      'callback arguments' => array('system_theme_settings'),
      'access' => $access,
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => -1);
Dries's avatar
 
Dries committed
179 180

    foreach (list_themes() as $theme) {
181
      if ($theme->status) {
182
        $items[] = array('path' => 'admin/build/themes/settings/'. $theme->name, 'title' => $theme->name,
183 184
        'callback' => 'drupal_get_form', 'callback arguments' => array('system_theme_settings', $theme->name),
        'access' => $access, 'type' => MENU_LOCAL_TASK);
185
      }
Dries's avatar
 
Dries committed
186 187 188
    }

    // Modules:
189 190 191 192
    $items[] = array('path' => 'admin/settings/modules',
      'title' => t('modules'),
      'description' => t('Enable or disable add-on modules for your site.'),
      'weight' => -10,
193 194
      'callback' => 'drupal_get_form',
      'callback arguments' => array('system_modules'),
195
      'access' => $access);
Dries's avatar
Dries committed
196 197 198 199 200

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


    // Logs:
    $items[] = array(
      'path' => 'admin/logs',
      'title' => t('logs'),
      'description' => t('View system logs and other status information.'),
      'callback' => 'system_admin_menu_block_page',
      'weight' => 5,
      'position' => 'left');
    $items[] = array(
      'path' => 'admin/logs/status',
      'title' => t('status report'),
      'description' => t('Get a status report about your site\'s operation and any detected problems.'),
      'callback' => 'system_status',
267
      'weight' => 10,
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
      'access' => $access);
    $items[] = array(
      'path' => 'admin/logs/status/run-cron',
      'title' => t('run cron'),
      'callback' => 'system_run_cron',
      'type' => MENU_CALLBACK);
    $items[] = array(
      'path' => 'admin/logs/status/php',
      'title' => t('PHP'),
      'callback' => 'system_php',
      'type' => MENU_CALLBACK);
    $items[] = array(
      'path' => 'admin/logs/status/sql',
      'title' => t('SQL'),
      'callback' => 'system_sql',
      'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
284
  }
285 286 287 288 289 290 291
  else {
    /**
     * 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', 'bluemarine');
292
      drupal_add_css(drupal_get_path('module', 'system') .'/admin.css', 'core');
293
    }
drumm's avatar
drumm committed
294 295 296

    // Add the CSS for this module. We put this in !$may_cache so it is only
    // added once per request.
297 298 299
    drupal_add_css(drupal_get_path('module', 'system') .'/defaults.css', 'core');
    drupal_add_css(drupal_get_path('module', 'system') .'/system.css', 'core');
  }
Dries's avatar
 
Dries committed
300 301

  return $items;
Dries's avatar
 
Dries committed
302 303
}

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

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

322
    return $form;
Dries's avatar
 
Dries committed
323
  }
Dries's avatar
 
Dries committed
324 325
}

326 327 328 329 330 331 332 333 334 335 336
/**
 * Provide the administration overview page.
 */
function system_main_admin_page($arg = NULL) {
  // 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.
  if ($arg !== NULL) {
    return drupal_not_found();
  }

337 338 339 340 341 342
  // 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');
  }


343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
  $menu = menu_get_item(NULL, 'admin');
  usort($menu['children'], '_menu_sort');
  foreach ($menu['children'] as $mid) {
    $block = menu_get_item($mid);
    if ($block['block callback'] && function_exists($block['block callback'])) {
      $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) {
  $content = array();
  if (is_array($block['children'])) {
    usort($block['children'], '_menu_sort');
    foreach ($block['children'] as $mid) {
      $item = menu_get_item($mid);
      if ($item['type'] & MENU_VISIBLE_IN_TREE) {
        $content[] = $item;
      }
    }
  }
  return $content;
}

/**
 * Provide a single block from the administration menu as a page.
 * This function is often a destination for these blocks.
378
 * For example, 'admin/content/types' needs to have a destination to be valid
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
 * 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() {
  $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');
}
395

396
/**
397
 * This function allows selection of the theme to show in administration sections.
398
 */
399
function system_admin_theme_settings() {
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
  $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'),
    '#description' => t('Choose which theme the administration pages should display in. If you choose "System default" the administration pages theme will display in the same theme the rest of the site uses.'),
    '#default_value' => variable_get('admin_theme', 'bluemarine'),
  );

  // 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.
418
  $form['#submit']['system_admin_theme_submit'] = array();
419
  $form['#submit']['system_settings_form_submit'] = array();
420
  return system_settings_form($form);
421 422 423
}


424
function system_admin_theme_submit($form_id, $form_values) {
425 426 427 428 429 430 431 432 433
  // If we're changing themes, make sure the theme has its blocks initialized.
  if ($form_values['admin_theme'] != variable_get('admin_theme', 'bluemarine')) {
    $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']);
    }
  }
}

434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
/*
 * 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
458 459 460 461
        '#type' => 'fieldset',
        '#title' => t('Theme configuration'),
        '#description' => $description,
        '#collapsible' => TRUE,
462 463 464 465 466 467 468 469
        '#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.
        $info->key = $info->name == variable_get('theme_default', 'bluemarine') ? '' : $info->name;

        $info->screenshot = dirname($info->filename) . '/screenshot.png';
470
        $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');
471 472 473 474 475 476 477 478 479 480 481 482 483 484

        $form['themes'][$info->key]['screenshot'] = array('#type' => 'markup', '#value' => $screenshot);
        $form['themes'][$info->key]['description'] = array('#type' => 'item', '#title' => $info->name,  '#value' => dirname($info->filename) . ($info->name == variable_get('theme_default', 'bluemarine') ? t('<br /> <em>(site default theme)</em>') : ''));
        $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) {
485 486 487
  foreach (element_children($form) as $key) {
    $row = array();
    if (is_array($form[$key]['description'])) {
488 489 490
      $row[] = drupal_render($form[$key]['screenshot']);
      $row[] = drupal_render($form[$key]['description']);
      $row[] = drupal_render($form['theme'][$key]);
491 492 493 494
    }
    $rows[] = $row;
  }

495
  $header = array(t('Screenshot'), t('Name'), t('Selected'));
496 497 498 499
  $output = theme('table', $header, $rows);
  return $output;
}

Steven Wittens's avatar
Steven Wittens committed
500 501 502 503 504 505 506 507 508 509 510
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;
    $zones[$zone] = format_date($timestamp, 'custom', variable_get('date_format_long', 'l, F j, Y - H:i') . ' O', $zone);
  }
  return $zones;
}

Dries's avatar
Dries committed
511 512 513 514 515 516 517
function system_site_information_settings() {
  $form['site_name'] = array(
    '#type' => 'textfield',
    '#title' => t('Name'),
    '#default_value' => variable_get('site_name', 'drupal'),
    '#description' => t('The name of this web site.'),
    '#required' => TRUE
518
  );
Dries's avatar
Dries committed
519 520 521 522
  $form['site_mail'] = array(
    '#type' => 'textfield',
    '#title' => t('E-mail address'),
    '#default_value' => variable_get('site_mail', ini_get('sendmail_from')),
523
    '#description' => t('A valid e-mail address for this website, used by the auto-mailer during registration, new password requests, notifications, etc.')
524
  );
Dries's avatar
Dries committed
525 526 527 528
  $form['site_slogan'] = array(
    '#type' => 'textfield',
    '#title' => t('Slogan'),
    '#default_value' => variable_get('site_slogan', ''),
529
    '#description' => t('The slogan of this website. Some themes display a slogan when available.')
530 531
  );

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

559
  return system_settings_form($form);
Dries's avatar
Dries committed
560 561 562
}

function system_clean_url_settings() {
563
  // We check for clean URL support using an image on the client side.
Dries's avatar
Dries committed
564
  $form['clean_url'] = array(
565 566 567 568 569 570
    '#type' => 'radios',
    '#title' => t('Clean URLs'),
    '#default_value' => variable_get('clean_url', 0),
    '#options' => array(t('Disabled'), t('Enabled')),
    '#description' => t('This option makes Drupal emit "clean" URLs (i.e. without <code>?q=</code> in the URL.)'),
  );
571

572 573
  if (!variable_get('clean_url', 0)) {
    if (strpos(request_uri(), '?q=') !== FALSE) {
574
      $form['clean_url']['#description'] .= 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. !run-test', array('@handbook' => 'http://drupal.org/node/15365', '!run-test' => '<a href ="'. base_path() . 'admin/settings/clean-urls">'. t('Run the clean URL test') .'</a>'));
575
      $form['clean_url']['#disabled'] = TRUE;
576 577
    }
    else {
Dries's avatar
Dries committed
578 579
      $form['clean_url']['#description'] .= t(' You have successfully demonstrated that clean URLs work on your server. You are welcome to enable/disable them as you wish.');
      $form['#collapsed'] = FALSE;
580 581
    }
  }
Dries's avatar
 
Dries committed
582

583
  return system_settings_form($form);
Dries's avatar
Dries committed
584 585 586
}

function system_error_reporting_settings() {
drumm's avatar
drumm committed
587 588

  $form['site_403'] = array(
Dries's avatar
Dries committed
589
    '#type' => 'textfield',
drumm's avatar
drumm committed
590
    '#title' => t('Default 403 (access denied) page'),
Dries's avatar
Dries committed
591
    '#default_value' => variable_get('site_403', ''),
592 593 594
    '#size' => 40,
    '#description' => t('This page is displayed when the requested document is denied to the current user. If unsure, specify nothing.'),
    '#field_prefix' => url(NULL, NULL, NULL, TRUE) . (variable_get('clean_url', 0) ? '' : '?q=')
595
  );
drumm's avatar
drumm committed
596 597

  $form['site_404'] = array(
Dries's avatar
Dries committed
598
    '#type' => 'textfield',
drumm's avatar
drumm committed
599
    '#title' => t('Default 404 (not found) page'),
Dries's avatar
Dries committed
600
    '#default_value' =>  variable_get('site_404', ''),
601 602 603
    '#size' => 40,
    '#description' => t('This page is displayed when no other content matches the requested document. If unsure, specify nothing.'),
    '#field_prefix' => url(NULL, NULL, NULL, TRUE) . (variable_get('clean_url', 0) ? '' : '?q=')
604
  );
drumm's avatar
drumm committed
605 606

  $form['error_level'] = array(
607 608
    '#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
609
    '#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.')
610
  );
drumm's avatar
drumm committed
611

Dries's avatar
 
Dries committed
612 613
  $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
614
  $form['watchdog_clear'] = array(
Dries's avatar
Dries committed
615 616 617 618
    '#type' => 'select',
    '#title' => t('Discard log entries older than'),
    '#default_value' => variable_get('watchdog_clear', 604800),
    '#options' => $period,
drumm's avatar
drumm committed
619
    '#description' => t('The time log entries should be kept. Older entries will be automatically discarded. Requires crontab.')
620
  );
Dries's avatar
 
Dries committed
621

622
  return system_settings_form($form);
Dries's avatar
Dries committed
623
}
Dries's avatar
 
Dries committed
624

Dries's avatar
Dries committed
625
function system_page_caching_settings() {
626

627 628 629 630 631 632 633 634 635 636 637 638
  $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) {
    $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>';
  }
  else {
    $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'll need to check this page again to ensure compatibility.") .'</p>';
  }

Dries's avatar
Dries committed
639 640
  $form['cache'] = array(
    '#type' => 'radios',
641
    '#title' => t('Caching mode'),
Dries's avatar
Dries committed
642
    '#default_value' => variable_get('cache', CACHE_DISABLED),
643 644
    '#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
645 646
  );

647 648
  $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');
Dries's avatar
Dries committed
649 650 651 652 653
  $form['cache_lifetime'] = array(
    '#type' => 'select',
    '#title' => t('Minimum cache lifetime'),
    '#default_value' => variable_get('cache_lifetime', 0),
    '#options' => $period,
654
    '#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.')
655
  );
Dries's avatar
 
Dries committed
656

657
  return system_settings_form($form);
Dries's avatar
Dries committed
658
}
Dries's avatar
 
Dries committed
659

Dries's avatar
Dries committed
660
function system_file_system_settings() {
661

Dries's avatar
Dries committed
662
  $form['file_directory_path'] = array(
663 664 665 666
    '#type' => 'textfield',
    '#title' => t('File system path'),
    '#default_value' => file_directory_path(),
    '#maxlength' => 255,
667
    '#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.'),
668
    '#after_build' => array('system_check_directory'),
669 670
  );

Dries's avatar
Dries committed
671
  $form['file_directory_temp'] = array(
672 673 674 675 676
    '#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.'),
677
    '#after_build' => array('system_check_directory'),
678 679
  );

Dries's avatar
Dries committed
680 681 682 683
  $form['file_downloads'] = array(
    '#type' => 'radios',
    '#title' => t('Download method'),
    '#default_value' => variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC),
684
    '#options' => array(FILE_DOWNLOADS_PUBLIC => t('Public - files are available using HTTP directly.'), FILE_DOWNLOADS_PRIVATE => t('Private - files are transferred by Drupal.')),
685
    '#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.')
686
  );
Dries's avatar
 
Dries committed
687

688
  return system_settings_form($form);
Dries's avatar
Dries committed
689 690 691
}

function system_image_toolkit_settings() {
692 693
  $toolkits_available = image_get_available_toolkits();
  if (count($toolkits_available) > 1) {
Dries's avatar
Dries committed
694 695 696 697 698
    $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
699
    );
Dries's avatar
Dries committed
700

701
    return system_settings_form($form);
702
  }
Dries's avatar
Dries committed
703
  else {
704 705
    $form['error'] = array('#value' => '<p>'. t("No image toolkits found.  Drupal will use PHP's built-in GD library for image handling.") .'</p>');
    return $form;
Dries's avatar
Dries committed
706 707 708 709
  }
}

function system_rss_feeds_settings() {
710

Dries's avatar
Dries committed
711 712 713 714
  $form['feed_default_items'] = array(
    '#type' => 'select',
    '#title' => t('Number of items per feed'),
    '#default_value' => variable_get('feed_default_items', 10),
715 716
    '#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.')
717
  );
Dries's avatar
Dries committed
718 719 720 721
  $form['feed_item_length'] = array(
    '#type' => 'select',
    '#title' => t('Display of XML feed items'),
    '#default_value' => variable_get('feed_item_length','teaser'),
722 723
    '#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.')
724
  );
725

726
  return system_settings_form($form);
Dries's avatar
Dries committed
727 728 729
}

function system_date_time_settings() {
730
  // Date settings:
Steven Wittens's avatar
Steven Wittens committed
731
  $zones = _system_zonelist();
732

733
  // Date settings: possible date formats
734
  $dateshort = array('Y-m-d H:i', 'm/d/Y - H:i', 'd/m/Y - H:i', 'Y/m/d - H:i',
735
           '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
736 737
           '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
738 739
  $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
740
          'D, m/d/Y - g:ia', 'D, d/m/Y - g:ia', 'D, Y/m/d - g:ia',
741
          '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
742
  $datelong = array('l, F j, Y - H:i', 'l, j F, Y - H:i', 'l, Y,  F j - H:i',
743
        '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
744

745
  // Date settings: construct choices for user
Dries's avatar
 
Dries committed
746
  foreach ($dateshort as $f) {
Dries's avatar
 
Dries committed
747
    $dateshortchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
 
Dries committed
748 749
  }
  foreach ($datemedium as $f) {
Dries's avatar
 
Dries committed
750
    $datemediumchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
 
Dries committed
751 752
  }
  foreach ($datelong as $f) {
Dries's avatar
 
Dries committed
753
    $datelongchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
 
Dries committed
754 755
  }

Dries's avatar
Dries committed
756 757 758 759 760 761
  $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.')
762 763
  );

Dries's avatar
Dries committed
764 765 766 767 768
  $form['configurable_timezones'] = array(
    '#type' => 'radios',
    '#title' => t('Configurable time zones'),
    '#default_value' => variable_get('configurable_timezones', 1),
    '#options' => array(t('Disabled'), t('Enabled')),
769
    '#description' => t('Enable or disable user-configurable time zones. When enabled, users can set their own time zone and dates will be updated accordingly.')
770 771
  );

Dries's avatar
Dries committed
772 773 774
  $form['date_format_short'] = array(
    '#type' => 'select',
    '#title' => t('Short date format'),
775
    '#default_value' => variable_get('date_format_short', $dateshort[1]),
Dries's avatar
Dries committed
776 777
    '#options' => $dateshortchoices,
    '#description' => t('The short format of date display.')
778 779
  );

Dries's avatar
Dries committed
780 781 782
  $form['date_format_medium'] = array(
    '#type' => 'select',
    '#title' => t('Medium date format'),
783
    '#default_value' => variable_get('date_format_medium', $datemedium[1]),
Dries's avatar
Dries committed
784 785
    '#options' => $datemediumchoices,
    '#description' => t('The medium sized date display.')
786 787
  );

Dries's avatar
Dries committed
788 789 790 791 792 793
  $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.')
794 795
  );

Dries's avatar
Dries committed
796 797 798 799
  $form['date_first_day'] = array(
    '#type' => 'select',
    '#title' => t('First day of week'),
    '#default_value' => variable_get('date_first_day', 0),
800 801
    '#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.')
802
  );
Dries's avatar
 
Dries committed
803

804
  return system_settings_form($form);
Dries's avatar
Dries committed
805
}
Dries's avatar
 
Dries committed
806

807
function system_site_maintenance_settings() {
808

Dries's avatar
Dries committed
809
  $form['site_offline'] = array(
810
    '#type' => 'radios',
811
    '#title' => t('Site maintenance'),
812
    '#default_value' => variable_get('site_offline', 0),
813
    '#options' => array(t('Online'), t('Off-line')),
814
    '#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'))),
815 816
  );

Dries's avatar
Dries committed
817
  $form['site_offline_message'] = array(
818
    '#type' => 'textarea',
819
    '#title' => t('Site off-line message'),
820
    '#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', t('This Drupal site'))))),
821
    '#description' => t('Message to show visitors when the site is in off-line mode.')
822 823
  );

824
  return system_settings_form($form);
Dries's avatar
Dries committed
825 826
}

827 828
/**
 * Checks the existence of the directory specified in $form_element. This
Dries's avatar
Dries committed
829
 * function is called from the system_settings form to check both the
830 831 832 833 834 835 836
 * 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.
 */
837
function system_check_directory($form_element) {
838 839 840 841
  file_check_directory($form_element['#value'], FILE_CREATE_DIRECTORY, $form_element['#parents'][0]);
  return $form_element;
}

Dries's avatar
 
Dries committed
842 843 844 845
/**
 * 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
846
  // Extract current files from database.
847
  $result = db_query("SELECT filename, name, type, status, throttle, schema_version FROM {system} WHERE type = '%s'", $type);
Dries's avatar
 
Dries committed
848
  while ($file = db_fetch_object($result)) {
849
    if (isset($files[$file->name]) && is_object($files[$file->name])) {
850
      $file->old_filename = $file->filename;
Dries's avatar
 
Dries committed
851
      foreach ($file as $key => $value) {
852
        if (!isset($files[$file->name]) || !isset($files[$file->name]->$key)) {
Dries's avatar
Dries committed
853 854