system.module 92.3 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
      $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
    case 'admin/build/themes/settings/'. arg(3):
33
34
      $reference = explode('.', arg(3), 2);
      $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' => 30);
66
  $type['password_confirm'] = array('#input' => TRUE, '#process' => array('expand_password_confirm' => array()));
67
  $type['textarea'] = array('#input' => TRUE, '#cols' => 60, '#rows' => 5);
68
  $type['radios'] = array('#input' => TRUE, '#process' => array('expand_radios' => array()));
69
  $type['radio'] = array('#input' => TRUE);
70
  $type['checkboxes'] = array('#input' => TRUE, '#process' => array('expand_checkboxes' => array()), '#tree' => TRUE);
71
  $type['select'] = array('#input' => TRUE);
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
77

  // Form structure
  $type['item'] = array();
78
79
80
81
  $type['hidden'] = array('#input' => TRUE);
  $type['value'] = array('#input' => TRUE);
  $type['markup'] = array('#prefix' => '', '#suffix' => '');
  $type['fieldset'] = array('#collapsible' => FALSE, '#collapsed' => FALSE);
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
 */
Dries's avatar
   
Dries committed
89
function system_menu($may_cache) {
Dries's avatar
   
Dries committed
90
  $items = array();
Dries's avatar
   
Dries committed
91

Dries's avatar
   
Dries committed
92
  if ($may_cache) {
93
    $items[] = array('path' => 'system/files', 'title' => t('File download'),
Dries's avatar
   
Dries committed
94
95
96
97
98
99
      'callback' => 'file_download',
      'access' => TRUE,
      'type' => MENU_CALLBACK);

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

100
    $items[] = array('path' => 'admin', 'title' => t('Administer'),
101
      'access' => user_access('access administration pages'),
102
      'callback' => 'system_main_admin_page',
103
      'weight' => 9);
104
    $items[] = array('path' => 'admin/compact', 'title' => t('Compact mode'),
105
106
107
      'access' => user_access('access administration pages'),
      'callback' => 'system_admin_compact_page',
      'type' => MENU_CALLBACK);
108
    $items[] = array('path' => 'admin/by-task', 'title' => t('By task'),
109
110
      'callback' => 'system_main_admin_page',
      'type' => MENU_DEFAULT_LOCAL_TASK);
111
    $items[] = array('path' => 'admin/by-module', 'title' => t('By module'),
112
113
114
      'callback' => 'system_admin_by_module',
      'type' => MENU_LOCAL_TASK,
      'weight' => 2);
115
116
117
118

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

    $items[] = array('path' => 'admin/build',
127
      'title' => t('Site building'),
128
129
130
131
132
133
134
135
      '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',
136
      'title' => t('Administration theme'),
137
138
      'description' => t('Settings for how your administrative pages should look.'),
      'position' => 'left',
139
140
      'callback' => 'drupal_get_form',
      'callback arguments' => array('system_admin_theme_settings'),
141
      'block callback' => 'system_admin_theme_settings',
142
      'access' => $access);
143

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

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

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

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

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

    // Modules:
187
    $items[] = array('path' => 'admin/build/modules',
188
      'title' => t('Modules'),
189
      'description' => t('Enable or disable add-on modules for your site.'),
190
191
      'callback' => 'drupal_get_form',
      'callback arguments' => array('system_modules'),
192
      'access' => $access);
193
194
195
196
    $items[] = array('path' => 'admin/build/modules/list',
      'title' => t('List'),
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'access' => $access);
197
198
199
200
201
202
    $items[] = array('path' => 'admin/build/modules/list/confirm',
      'title' => t('List'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('system_modules'),
      'type' => MENU_CALLBACK,
      'access' => $access);
203
204
205
206
207
208
    $items[] = array('path' => 'admin/build/modules/uninstall',
      'title' => t('Uninstall'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('system_modules_uninstall'),
      'type' => MENU_LOCAL_TASK,
      'access' => $access);
209
210
211
212
213
214
    $items[] = array('path' => 'admin/build/modules/uninstall/confirm',
      'title' => t('Uninstall'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('system_modules_uninstall'),
      'type' => MENU_CALLBACK,
      'access' => $access);
Dries's avatar
Dries committed
215
216
217
218

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


    // Logs:
    $items[] = array(
      'path' => 'admin/logs',
276
      'title' => t('Logs'),
277
278
279
280
281
282
      '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',
283
      'title' => t('Status report'),
284
      'description' => t("Get a status report about your site's operation and any detected problems."),
285
      'callback' => 'system_status',
286
      'weight' => 10,
287
288
289
      'access' => $access);
    $items[] = array(
      'path' => 'admin/logs/status/run-cron',
290
      'title' => t('Run cron'),
291
292
293
294
295
296
297
298
299
300
301
302
      '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
303
  }
304
305
306
307
308
309
  else {
    /**
     * Use the administrative theme if the user is looking at a page in the admin/* path.
     */
    if (arg(0) == 'admin') {
      global $custom_theme;
310
      $custom_theme = variable_get('admin_theme', '0');
311
      drupal_add_css(drupal_get_path('module', 'system') .'/admin.css', 'module');
312
    }
drumm's avatar
drumm committed
313
314
315

    // Add the CSS for this module. We put this in !$may_cache so it is only
    // added once per request.
316
317
    drupal_add_css(drupal_get_path('module', 'system') .'/defaults.css', 'module');
    drupal_add_css(drupal_get_path('module', 'system') .'/system.css', 'module');
318
  }
Dries's avatar
   
Dries committed
319
320

  return $items;
Dries's avatar
   
Dries committed
321
322
}

Dries's avatar
   
Dries committed
323
324
325
326
327
/**
 * Implementation of hook_user().
 *
 * Allows users to individually set their theme and time zone.
 */
328
function system_user($type, $edit, &$user, $category = NULL) {
Dries's avatar
Dries committed
329
  if ($type == 'form' && $category == 'account') {
330
    $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
331

332
    if (variable_get('configurable_timezones', 1)) {
Steven Wittens's avatar
Steven Wittens committed
333
      $zones = _system_zonelist();
334
335
      $form['timezone'] = array('#type'=>'fieldset', '#title' => t('Locale settings'), '#weight' => 6);
      $form['timezone']['timezone'] = array(
336
        '#type' => 'select', '#title' => t('Time zone'), '#default_value' => strlen($edit['timezone']) ? $edit['timezone'] : variable_get('date_default_timezone', 0),
337
        '#options' => $zones, '#description' => t('Select your current local time. Dates and times throughout this site will be displayed using this time zone.')
338
      );
Dries's avatar
   
Dries committed
339
    }
Dries's avatar
Dries committed
340

341
    return $form;
Dries's avatar
   
Dries committed
342
  }
Dries's avatar
   
Dries committed
343
344
}

345
346
347
348
349
350
351
/**
 * 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.
352
  if (isset($arg) && substr($arg, 0, 3) != 'by-') {
353
354
355
    return drupal_not_found();
  }

356
357
358
359
360
361
  // 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');
  }


362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
  $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);
386
      if (($item['type'] & MENU_VISIBLE_IN_TREE) && _menu_item_is_accessible($mid)) {
387
388
389
390
391
392
393
394
395
396
        $content[] = $item;
      }
    }
  }
  return $content;
}

/**
 * Provide a single block from the administration menu as a page.
 * This function is often a destination for these blocks.
397
 * For example, 'admin/content/types' needs to have a destination to be valid
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 * 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');
}
414

415
/**
416
 * This function allows selection of the theme to show in administration sections.
417
 */
418
function system_admin_theme_settings() {
419
420
421
422
423
424
425
426
427
428
429
  $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'),
430
    '#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.'),
431
    '#default_value' => variable_get('admin_theme', '0'),
432
433
434
435
436
  );

  // 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.
437
  $form['#submit']['system_admin_theme_submit'] = array();
438
  $form['#submit']['system_settings_form_submit'] = array();
439
  return system_settings_form($form);
440
441
442
}


443
function system_admin_theme_submit($form_id, $form_values) {
444
  // If we're changing themes, make sure the theme has its blocks initialized.
445
  if ($form_values['admin_theme'] != variable_get('admin_theme', '0')) {
446
447
448
449
450
451
452
    $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']);
    }
  }
}

453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
/*
 * 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
477
478
479
480
        '#type' => 'fieldset',
        '#title' => t('Theme configuration'),
        '#description' => $description,
        '#collapsible' => TRUE,
481
482
483
484
485
        '#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.
486
        $info->key = $info->name == variable_get('theme_default', 'garland') ? '' : $info->name;
487
488

        $info->screenshot = dirname($info->filename) . '/screenshot.png';
489
        $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');
490

491
        $form['themes'][$info->key]['screenshot'] = array('#value' => $screenshot);
492
        $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>' : ''));
493
494
495
496
497
498
499
500
501
502
503
        $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) {
504
505
506
  foreach (element_children($form) as $key) {
    $row = array();
    if (is_array($form[$key]['description'])) {
507
508
509
      $row[] = drupal_render($form[$key]['screenshot']);
      $row[] = drupal_render($form[$key]['description']);
      $row[] = drupal_render($form['theme'][$key]);
510
511
512
513
    }
    $rows[] = $row;
  }

514
  $header = array(t('Screenshot'), t('Name'), t('Selected'));
515
516
517
518
  $output = theme('table', $header, $rows);
  return $output;
}

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

Dries's avatar
Dries committed
551
552
553
554
  $form['site_mission'] = array(
    '#type' => 'textarea',
    '#title' => t('Mission'),
    '#default_value' => variable_get('site_mission', ''),
555
    '#description' => t('Your site\'s mission statement or focus.')
556
  );
Dries's avatar
Dries committed
557
558
559
560
  $form['site_footer'] = array(
    '#type' => 'textarea',
    '#title' => t('Footer message'),
    '#default_value' => variable_get('site_footer', ''),
561
    '#description' => t('This text will be displayed at the bottom of each page. Useful for adding a copyright notice to your pages.')
562
  );
Dries's avatar
Dries committed
563
564
565
  $form['anonymous'] = array(
    '#type' => 'textfield',
    '#title' => t('Anonymous user'),
566
    '#default_value' => variable_get('anonymous', t('Anonymous')),
567
    '#description' => t('The name used to indicate anonymous users.')
568
  );
Dries's avatar
Dries committed
569
570
571
572
  $form['site_frontpage'] = array(
    '#type' => 'textfield',
    '#title' => t('Default front page'),
    '#default_value' => variable_get('site_frontpage', 'node'),
573
574
575
    '#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=')
576
  );
577

578
  return system_settings_form($form);
Dries's avatar
Dries committed
579
580
581
}

function system_clean_url_settings() {
582
  // We check for clean URL support using an image on the client side.
Dries's avatar
Dries committed
583
  $form['clean_url'] = array(
584
585
586
587
588
589
    '#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.)'),
  );
590

591
592
  if (!variable_get('clean_url', 0)) {
    if (strpos(request_uri(), '?q=') !== FALSE) {
593
      $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>'));
594
      $form['clean_url']['#disabled'] = TRUE;
595
596
    }
    else {
597
      $form['clean_url']['#description'] .= t(' You have successfully demonstrated that clean URLs work on your server. You may enable/disable them as you wish.');
Dries's avatar
Dries committed
598
      $form['#collapsed'] = FALSE;
599
600
    }
  }
Dries's avatar
   
Dries committed
601

602
  return system_settings_form($form);
Dries's avatar
Dries committed
603
604
605
}

function system_error_reporting_settings() {
drumm's avatar
drumm committed
606
607

  $form['site_403'] = array(
Dries's avatar
Dries committed
608
    '#type' => 'textfield',
drumm's avatar
drumm committed
609
    '#title' => t('Default 403 (access denied) page'),
Dries's avatar
Dries committed
610
    '#default_value' => variable_get('site_403', ''),
611
612
613
    '#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=')
614
  );
drumm's avatar
drumm committed
615
616

  $form['site_404'] = array(
Dries's avatar
Dries committed
617
    '#type' => 'textfield',
drumm's avatar
drumm committed
618
    '#title' => t('Default 404 (not found) page'),
Dries's avatar
Dries committed
619
    '#default_value' =>  variable_get('site_404', ''),
620
621
622
    '#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=')
623
  );
drumm's avatar
drumm committed
624
625

  $form['error_level'] = array(
626
627
    '#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
628
    '#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.')
629
  );
drumm's avatar
drumm committed
630

Dries's avatar
   
Dries committed
631
632
  $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
633
  $form['watchdog_clear'] = array(
Dries's avatar
Dries committed
634
635
636
637
    '#type' => 'select',
    '#title' => t('Discard log entries older than'),
    '#default_value' => variable_get('watchdog_clear', 604800),
    '#options' => $period,
drumm's avatar
drumm committed
638
    '#description' => t('The time log entries should be kept. Older entries will be automatically discarded. Requires crontab.')
639
  );
Dries's avatar
   
Dries committed
640

641
  return system_settings_form($form);
Dries's avatar
Dries committed
642
}
Dries's avatar
   
Dries committed
643

644
function system_performance_settings() {
645

646
647
648
649
650
651
  $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) {
652
    $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>';
653
654
  }
  else {
655
    $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>';
656
  }
657
658
659
660
661
  $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.'),
  );
662

663
  $form['page_cache']['cache'] = array(
Dries's avatar
Dries committed
664
    '#type' => 'radios',
665
    '#title' => t('Caching mode'),
Dries's avatar
Dries committed
666
    '#default_value' => variable_get('cache', CACHE_DISABLED),
667
668
    '#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
669
670
  );

671
672
  $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');
673
  $form['page_cache']['cache_lifetime'] = array(
Dries's avatar
Dries committed
674
675
676
677
    '#type' => 'select',
    '#title' => t('Minimum cache lifetime'),
    '#default_value' => variable_get('cache_lifetime', 0),
    '#options' => $period,
678
    '#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.')
679
  );
680

681
682
683
684
685
  $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.')
  );
686

687
  $directory = file_directory_path();
688
  $is_writable = is_dir($directory) && is_writable($directory) && (variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC) == FILE_DOWNLOADS_PUBLIC);
689
690
691
692
693
694
695
696
697
698
699
  $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
700

701
  return system_settings_form($form);
Dries's avatar
Dries committed
702
}
Dries's avatar
   
Dries committed
703

Dries's avatar
Dries committed
704
function system_file_system_settings() {
705

Dries's avatar
Dries committed
706
  $form['file_directory_path'] = array(
707
708
709
710
    '#type' => 'textfield',
    '#title' => t('File system path'),
    '#default_value' => file_directory_path(),
    '#maxlength' => 255,
711
    '#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.'),
712
    '#after_build' => array('system_check_directory'),
713
714
  );

Dries's avatar
Dries committed
715
  $form['file_directory_temp'] = array(
716
717
718
719
720
    '#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.'),
721
    '#after_build' => array('system_check_directory'),
722
723
  );

Dries's avatar
Dries committed
724
725
726
727
  $form['file_downloads'] = array(
    '#type' => 'radios',
    '#title' => t('Download method'),
    '#default_value' => variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC),
728
    '#options' => array(FILE_DOWNLOADS_PUBLIC => t('Public - files are available using HTTP directly.'), FILE_DOWNLOADS_PRIVATE => t('Private - files are transferred by Drupal.')),
729
    '#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.')
730
  );
Dries's avatar
   
Dries committed
731

732
  return system_settings_form($form);
Dries's avatar
Dries committed
733
734
735
}

function system_image_toolkit_settings() {
736
737
  $toolkits_available = image_get_available_toolkits();
  if (count($toolkits_available) > 1) {
Dries's avatar
Dries committed
738
739
740
741
742
    $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
743
    );
744
    $form['image_toolkit_settings'] = image_toolkit_invoke('settings');
Dries's avatar
Dries committed
745

746
    return system_settings_form($form);
747
  }
Dries's avatar
Dries committed
748
  else {
749
750
    $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
751
752
753
754
  }
}

function system_rss_feeds_settings() {
755

Dries's avatar
Dries committed
756
757
758
759
  $form['feed_default_items'] = array(
    '#type' => 'select',
    '#title' => t('Number of items per feed'),
    '#default_value' => variable_get('feed_default_items', 10),
760
761
    '#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.')
762
  );
Dries's avatar
Dries committed
763
764
765
766
  $form['feed_item_length'] = array(
    '#type' => 'select',
    '#title' => t('Display of XML feed items'),
    '#default_value' => variable_get('feed_item_length','teaser'),
767
768
    '#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.')
769
  );
770

771
  return system_settings_form($form);
Dries's avatar
Dries committed
772
773
774
}

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

778
  // Date settings: possible date formats
779
  $dateshort = array('Y-m-d H:i', 'm/d/Y - H:i', 'd/m/Y - H:i', 'Y/m/d - H:i',
780
           '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
781
782
           '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
783
784
  $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
785
          'D, m/d/Y - g:ia', 'D, d/m/Y - g:ia', 'D, Y/m/d - g:ia',
786
          '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
787
  $datelong = array('l, F j, Y - H:i', 'l, j F, Y - H:i', 'l, Y,  F j - H:i',
788
        '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
789

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

Dries's avatar
Dries committed
801
802
803
804
805
806
  $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.')
807
808
  );

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

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

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

Dries's avatar
Dries committed
833
834
835
836
837
838
  $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.')
839
840
  );

Dries's avatar
Dries committed
841
842
843
844
  $form['date_first_day'] = array(
    '#type' => 'select',
    '#title' => t('First day of week'),
    '#default_value' => variable_get('date_first_day', 0),
845
846
    '#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.')
847
  );
Dries's avatar
   
Dries committed
848

849
  return system_settings_form($form);
Dries's avatar
Dries committed
850
}
Dries's avatar
   
Dries committed
851

852
function system_site_maintenance_settings() {
853

Dries's avatar
Dries committed
854
  $form['site_offline'] = array(
855
    '#type' => 'radios',
856
    '#title' => t('Site status'),
857
    '#default_value' => variable_get('site_offline', 0),
858
    '#options' => array(t('Online'), t('Off-line')),
859
    '#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'))),
860
861
  );

Dries's avatar
Dries committed
862
  $form['site_offline_message'] = array(
863
    '#type' => 'textarea',
864
    '#title' => t('Site off-line message'),
865
    '#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')))),
866
    '#description' => t('Message to show visitors when the site is in off-line mode.')
867
868
  );

869
  return system_settings_form($form);
Dries's avatar
Dries committed
870
871
}

872
873
/**
 * Checks the existence of the directory specified in $form_element. This
Dries's avatar
Dries committed
874
 * function is called from the system_settings form to check both the
875
876
877
878
879
880
881
 * 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.
 */
882
function system_check_directory($form_element) {
883
884
885
886
  file_check_directory($form_element['#value'], FILE_CREATE_DIRECTORY, $form_element['#parents'][0]);
  return $form_element;
}

Dries's avatar
   
Dries committed
887
888
889
890
/**
 * 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
891
  // Extract current files from database.
892
  $result = db_query("SELECT filename, name, type, status, throttle, schema_version FROM {system} WHERE type = '%s'", $type);
Dries's avatar
   
Dries committed
893
  while ($file = db_fetch_object($result)) {
894
    if (isset($files[$file->name]) && is_object($files[$file->name])) {
895
      $file->old_filename = $file->filename;
Dries's avatar
   
Dries committed
896
      foreach ($file as $key => $value) {
897
        if (!isset($files[$file->name]) || !isset($files[$file->name]->$key)) {
Dries's avatar
Dries committed
898
899
          $files[$file->name]->$key = $value;
        }
Dries's avatar
   
Dries committed
900
      }
901
    }
Dries's avatar
   
Dries committed