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

9
10
define('VERSION', '4.8.0 dev');

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
24
      $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>
<li>activate your cron job on the cron page <a href="%file-cron">cron.php</a>.</li>
25
<li>read how to <a href="%external-http-drupal-org-cron">configure cron jobs</a>.</li>
26
<li>administer cache settings in <a href="%admin-settings">administer &gt;&gt; site configuration &gt;&gt; page caching</a>.</li>
27
28
<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/settings/cron-status'), '%cron-manually' => url('admin/settings/cron-status/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/settings/modules#description':
34
      return t('Handles general site configuration for administrators.');
35
    case 'admin':
36
37
      return t('<p>Welcome to the administration section. Here you may control how your site functions.</p>');
    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
45
      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')));
    case 'admin/settings/modules':
46
      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>
47
<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'));
48
  }
Dries's avatar
   
Dries committed
49
50
}

Dries's avatar
   
Dries committed
51
52
53
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
54
function system_perm() {
55
  return array('administer site configuration', 'access administration pages', 'select different theme');
Dries's avatar
   
Dries committed
56
57
}

58
59
60
61
62
/**
 * Implementation of hook_elements().
 */
function system_elements() {
  // Top level form
63
  $type['form'] = array('#method' => 'post', '#action' => request_uri());
64
65

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

  // Form structure
  $type['item'] = array();
83
84
85
86
  $type['hidden'] = array('#input' => TRUE);
  $type['value'] = array('#input' => TRUE);
  $type['markup'] = array('#prefix' => '', '#suffix' => '');
  $type['fieldset'] = array('#collapsible' => FALSE, '#collapsed' => FALSE);
87
88
89
  return $type;
}

Dries's avatar
   
Dries committed
90
/**
Dries's avatar
   
Dries committed
91
 * Implementation of hook_menu().
Dries's avatar
   
Dries committed
92
 */
Dries's avatar
   
Dries committed
93
function system_menu($may_cache) {
Dries's avatar
   
Dries committed
94
  $items = array();
Dries's avatar
   
Dries committed
95

Dries's avatar
   
Dries committed
96
97
98
99
100
101
102
103
  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');

104
105
    $items[] = array('path' => 'admin', 'title' => t('administer'),
      'access' => user_access('access administration pages'),
106
      'callback' => 'system_main_admin_page',
107
      'weight' => 9);
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
    $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',
133
      'title' => t('administration theme'),
134
135
      'description' => t('Settings for how your administrative pages should look.'),
      'position' => 'left',
136
137
      'callback' => 'system_admin_theme_settings',
      'block callback' => 'system_admin_theme_settings',
138
      'access' => $access);
139

Dries's avatar
   
Dries committed
140
    // Themes:
141
142
143
144
    $items[] = array(
      'path' => 'admin/build/themes',
      'title' => t('themes'),
      'description' => t('Change which theme your site uses or allows users to set.'),
Dries's avatar
   
Dries committed
145
146
      'callback' => 'system_themes', 'access' => $access);

147
148
149
150
151
152
153
154
155
156
157
158
159
    $items[] = array(
      'path' => 'admin/build/themes/select',
      'title' => t('list'),
      'description' => t('Select the default theme.'),
      'callback' => 'system_themes',
      'access' => $access,
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => -1);

    $items[] = array('path' => 'admin/build/themes/settings',
      'title' => t('configure'),
      'callback' => 'system_theme_settings',
      'access' => $access,
Dries's avatar
   
Dries committed
160
161
162
      'type' => MENU_LOCAL_TASK);

    // Theme configuration subtabs
163
    $items[] = array('path' => 'admin/build/themes/settings/global', 'title' => t('global settings'),
Dries's avatar
   
Dries committed
164
165
166
167
      'callback' => 'system_theme_settings', 'access' => $access,
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -1);

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

    // Modules:
176
177
178
179
180
181
    $items[] = array('path' => 'admin/settings/modules',
      'title' => t('modules'),
      'description' => t('Enable or disable add-on modules for your site.'),
      'weight' => -10,
      'callback' => 'system_modules',
      'access' => $access);
Dries's avatar
Dries committed
182
183
184
185
186

    // Settings:
    $items[] = array(
      'path' => 'admin/settings/site-information',
      'title' => t('site information'),
187
      'description' => t('Change basic site information, such as the site name, slogan, e-mail address, mission, front page and more.'),
Dries's avatar
Dries committed
188
189
190
191
      'callback' => 'system_site_information_settings');
    $items[] = array(
      'path' => 'admin/settings/error-reporting',
      'title' => t('error reporting'),
192
      'description' => t('Control how Drupal deals with errors including 403/404 erros as well as PHP error reporting.'),
Dries's avatar
Dries committed
193
194
195
196
      'callback' => 'system_error_reporting_settings');
    $items[] = array(
      'path' => 'admin/settings/page-caching',
      'title' => t('page caching'),
197
      'description' => t('Enable or disable page caching for anonymous users.'),
Dries's avatar
Dries committed
198
199
200
201
      'callback' => 'system_page_caching_settings');
    $items[] = array(
      'path' => 'admin/settings/file-system',
      'title' => t('file system'),
202
      'description' => t('Tell Drupal where to store uploaded files and how they are accessed.'),
Dries's avatar
Dries committed
203
204
205
206
      'callback' => 'system_file_system_settings');
    $items[] = array(
      'path' => 'admin/settings/image-toolkit',
      'title' => t('image toolkit'),
207
      'description' => t('Choose which image toolkit to use if you have installed optional toolkits.'),
Dries's avatar
Dries committed
208
209
      'callback' => 'system_image_toolkit_settings');
    $items[] = array(
210
      'path' => 'admin/content/rss-feed',
Dries's avatar
Dries committed
211
      'title' => t('RSS feeds'),
212
      'description' => t('Configure the number of items per feed and whether feeds should be titles/teasers/full-text.'),
Dries's avatar
Dries committed
213
214
215
216
      'callback' => 'system_rss_feeds_settings');
    $items[] = array(
      'path' => 'admin/settings/date-time',
      'title' => t('date and time'),
217
      'description' => t('Settings for how Drupal displays date and time, as well as the system\'s default timezone.'),
Dries's avatar
Dries committed
218
219
220
221
      'callback' => 'system_date_time_settings');
    $items[] = array(
      'path' => 'admin/settings/site-status',
      'title' => t('site status'),
222
      'description' => t('Take the site off-line for maintenance or bring it back online.'),
Dries's avatar
Dries committed
223
224
225
226
      'callback' => 'system_site_status_settings');
    $items[] = array(
      'path' => 'admin/settings/unicode',
      'title' => t('unicode'),
227
      'description' => t('Unicode string handling settings.'),
Dries's avatar
Dries committed
228
229
230
231
      'callback' => 'system_unicode_settings');
    $items[] = array(
      'path' => 'admin/settings/cron-status',
      'title' => t('cron status'),
232
      'description' => t('Check cron status or run cron manually.'),
Dries's avatar
Dries committed
233
234
235
236
      'callback' => 'system_cron_status');
    $items[] = array(
      'path' => 'admin/settings/clean-urls',
      'title' => t('clean URLs'),
237
      'description' => t('Enable or disable clean URLs for your site.'),
Dries's avatar
Dries committed
238
      'callback' => 'system_clean_url_settings');
Dries's avatar
   
Dries committed
239
  }
240
241
242
243
244
245
246
247
248
  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');
    }
  }
249
250
251
252
253
254
  else {
    // Add the CSS for this module
    // We put this in !$may_cache so it's only added once per request
    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
255
256

  return $items;
Dries's avatar
 
Dries committed
257
258
}

Dries's avatar
   
Dries committed
259
260
261
262
263
/**
 * Implementation of hook_user().
 *
 * Allows users to individually set their theme and time zone.
 */
264
function system_user($type, $edit, &$user, $category = NULL) {
Dries's avatar
Dries committed
265
  if ($type == 'form' && $category == 'account') {
266
    $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
267

268
    if (variable_get('configurable_timezones', 1)) {
Steven Wittens's avatar
Steven Wittens committed
269
      $zones = _system_zonelist();
270
271
      $form['timezone'] = array('#type'=>'fieldset', '#title' => t('Locale settings'), '#weight' => 6);
      $form['timezone']['timezone'] = array(
272
        '#type' => 'select', '#title' => t('Time zone'), '#default_value' => strlen($edit['timezone']) ? $edit['timezone'] : variable_get('date_default_timezone', 0),
273
        '#options' => $zones, '#description' => t('Select your current local time. Dates and times throughout this site will be displayed using this time zone.')
274
      );
Dries's avatar
   
Dries committed
275
    }
Dries's avatar
Dries committed
276

277
    return $form;
Dries's avatar
   
Dries committed
278
  }
Dries's avatar
   
Dries committed
279
280
}

281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
/**
 * 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();
  }

  $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.
327
 * For example, 'admin/content/types' needs to have a destination to be valid
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 * 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');
}
344

345
/**
346
 * This function allows selection of the theme to show in administration sections.
347
 */
348
function system_admin_theme_settings() {
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
  $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.
367
  $form['#submit']['system_admin_theme_submit'] = array();
368
369
  $form['#submit']['system_settings_form_submit'] = array();

370
  return system_settings_form('system_admin_theme_form', $form);
371
372
373
}


374
function system_admin_theme_submit($form_id, $form_values) {
375
376
377
378
379
380
381
382
383
  // 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']);
    }
  }
}

384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
/*
 * 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
408
409
410
411
        '#type' => 'fieldset',
        '#title' => t('Theme configuration'),
        '#description' => $description,
        '#collapsible' => TRUE,
412
413
414
415
416
417
418
419
        '#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';
420
        $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');
421
422
423
424
425
426
427
428
429
430
431
432
433
434

        $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) {
435
436
437
  foreach (element_children($form) as $key) {
    $row = array();
    if (is_array($form[$key]['description'])) {
438
439
440
      $row[] = drupal_render($form[$key]['screenshot']);
      $row[] = drupal_render($form[$key]['description']);
      $row[] = drupal_render($form['theme'][$key]);
441
442
443
444
    }
    $rows[] = $row;
  }

445
  $header = array(t('Screenshot'), t('Name'), t('Selected'));
446
447
448
449
  $output = theme('table', $header, $rows);
  return $output;
}

Steven Wittens's avatar
Steven Wittens committed
450
451
452
453
454
455
456
457
458
459
460
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
461
462
463
464
465
466
467
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
468
  );
Dries's avatar
Dries committed
469
470
471
472
  $form['site_mail'] = array(
    '#type' => 'textfield',
    '#title' => t('E-mail address'),
    '#default_value' => variable_get('site_mail', ini_get('sendmail_from')),
473
    '#description' => t('A valid e-mail address for this website, used by the auto-mailer during registration, new password requests, notifications, etc.')
474
  );
Dries's avatar
Dries committed
475
476
477
478
  $form['site_slogan'] = array(
    '#type' => 'textfield',
    '#title' => t('Slogan'),
    '#default_value' => variable_get('site_slogan', ''),
479
    '#description' => t('The slogan of this website. Some themes display a slogan when available.')
480
481
  );

Dries's avatar
Dries committed
482
483
484
485
  $form['site_mission'] = array(
    '#type' => 'textarea',
    '#title' => t('Mission'),
    '#default_value' => variable_get('site_mission', ''),
486
    '#description' => t('Your site\'s mission statement or focus.')
487
  );
Dries's avatar
Dries committed
488
489
490
491
  $form['site_footer'] = array(
    '#type' => 'textarea',
    '#title' => t('Footer message'),
    '#default_value' => variable_get('site_footer', ''),
492
    '#description' => t('This text will be displayed at the bottom of each page. Useful for adding a copyright notice to your pages.')
493
  );
Dries's avatar
Dries committed
494
495
496
497
  $form['anonymous'] = array(
    '#type' => 'textfield',
    '#title' => t('Anonymous user'),
    '#default_value' => variable_get('anonymous', 'Anonymous'),
498
    '#description' => t('The name used to indicate anonymous users.')
499
  );
Dries's avatar
Dries committed
500
501
502
503
  $form['site_frontpage'] = array(
    '#type' => 'textfield',
    '#title' => t('Default front page'),
    '#default_value' => variable_get('site_frontpage', 'node'),
504
    '#description' => t('The home page displays content from this relative URL. If you are not using clean URLs, specify the part after "?q=". If unsure, specify "node".')
505
  );
506

Dries's avatar
Dries committed
507
508
509
510
  return system_settings_form('system_site_information_settings', $form);
}

function system_clean_url_settings() {
511
  // We check for clean URL support using an image on the client side.
Dries's avatar
Dries committed
512
  $form['clean_url'] = array(
513
514
515
516
517
518
    '#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.)'),
  );
519

520
521
  if (!variable_get('clean_url', 0)) {
    if (strpos(request_uri(), '?q=') !== FALSE) {
522
      $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>'));
Dries's avatar
Dries committed
523
      $form['clean_url']['#attributes'] = array('disabled' => 'disabled');
524
525
    }
    else {
Dries's avatar
Dries committed
526
527
      $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;
528
529
    }
  }
Dries's avatar
   
Dries committed
530

Dries's avatar
Dries committed
531
532
533
534
  return system_settings_form('system_clean_url_settings', $form);
}

function system_error_reporting_settings() {
535

Dries's avatar
Dries committed
536
537
538
539
  $form['site_403'] = array(
    '#type' => 'textfield',
    '#title' => t('Default 403 (access denied) page'),
    '#default_value' => variable_get('site_403', ''),
540
    '#description' => t('This page is displayed when the requested document is denied to the current user. If you are not using clean URLs, specify the part after "?q=". If unsure, specify nothing.')
541
542
  );

Dries's avatar
Dries committed
543
544
545
546
  $form['site_404'] = array(
    '#type' => 'textfield',
    '#title' => t('Default 404 (not found) page'),
    '#default_value' =>  variable_get('site_404', ''),
547
    '#description' => t('This page is displayed when no other content matches the requested document. If you are not using clean URLs, specify the part after "?q=". If unsure, specify nothing.')
548
549
  );

Dries's avatar
Dries committed
550
  $form['error_level'] = array(
551
552
553
    '#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')),
    '#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.')
554
555
  );

Dries's avatar
   
Dries committed
556
557
  $period = drupal_map_assoc(array(3600, 10800, 21600, 32400, 43200, 86400, 172800, 259200, 604800, 1209600, 2419200), 'format_interval');
  $period['1000000000'] = t('Never');
Dries's avatar
Dries committed
558
559
560
561
562
  $form['watchdog_clear'] = array(
    '#type' => 'select',
    '#title' => t('Discard log entries older than'),
    '#default_value' => variable_get('watchdog_clear', 604800),
    '#options' => $period,
563
    '#description' => t('The time log entries should be kept. Older entries will be automatically discarded. Requires crontab.')
564
  );
Dries's avatar
   
Dries committed
565

Dries's avatar
Dries committed
566
567
  return system_settings_form('system_error_reporting_settings', $form);
}
Dries's avatar
 
Dries committed
568

Dries's avatar
Dries committed
569
function system_page_caching_settings() {
570

Dries's avatar
Dries committed
571
572
573
574
  $form['cache'] = array(
    '#type' => 'radios',
    '#title' => t('Page cache'),
    '#default_value' => variable_get('cache', CACHE_DISABLED),
575
    '#options' => array(CACHE_DISABLED => t('Disabled'), CACHE_ENABLED => t('Enabled')),
576
    '#description' => t("Drupal has a caching mechanism which stores dynamically generated web pages in a database. By caching a web page, Drupal 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 \"anonymous\" users are cached. In order to reduce server load and save bandwidth, Drupal stores and sends compressed cached pages.")
577
578
  );

579
580
  $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
581
582
583
584
585
  $form['cache_lifetime'] = array(
    '#type' => 'select',
    '#title' => t('Minimum cache lifetime'),
    '#default_value' => variable_get('cache_lifetime', 0),
    '#options' => $period,
586
    '#description' => t('Enabling the cache will offer a sufficient performance boost for most low-traffic and medium-traffic sites. 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.')
587
  );
Dries's avatar
   
Dries committed
588

Dries's avatar
Dries committed
589
590
  return system_settings_form('system_page_caching_settings', $form);
}
Dries's avatar
   
Dries committed
591

Dries's avatar
Dries committed
592
function system_file_system_settings() {
593

Dries's avatar
Dries committed
594
  $form['file_directory_path'] = array(
595
596
597
598
599
    '#type' => 'textfield',
    '#title' => t('File system path'),
    '#default_value' => file_directory_path(),
    '#maxlength' => 255,
    '#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 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.'),
600
    '#after_build' => array('system_check_directory'),
601
602
  );

Dries's avatar
Dries committed
603
  $form['file_directory_temp'] = array(
604
605
606
607
608
    '#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.'),
609
    '#after_build' => array('system_check_directory'),
610
611
  );

Dries's avatar
Dries committed
612
613
614
615
  $form['file_downloads'] = array(
    '#type' => 'radios',
    '#title' => t('Download method'),
    '#default_value' => variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC),
616
617
    '#options' => array(FILE_DOWNLOADS_PUBLIC => t('Public - files are available using http directly.'), FILE_DOWNLOADS_PRIVATE => t('Private - files are transferred by Drupal.')),
    '#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.')
618
  );
Dries's avatar
   
Dries committed
619

Dries's avatar
Dries committed
620
621
622
623
  return system_settings_form('system_file_system_settings', $form);
}

function system_image_toolkit_settings() {
624
625
  $toolkits_available = image_get_available_toolkits();
  if (count($toolkits_available) > 1) {
Dries's avatar
Dries committed
626
627
628
629
630
    $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
631
    );
Dries's avatar
Dries committed
632
633

    return system_settings_form('system_image_toolkit_settings', $form);
634
  }
Dries's avatar
Dries committed
635
636
637
638
639
640
  else {
    return '<p>'. t("No image toolkits found.  Drupal will use PHP's built-in GD library for image handling.") .'</p>';
  }
}

function system_rss_feeds_settings() {
641

Dries's avatar
Dries committed
642
643
644
645
  $form['feed_default_items'] = array(
    '#type' => 'select',
    '#title' => t('Number of items per feed'),
    '#default_value' => variable_get('feed_default_items', 10),
646
647
    '#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.')
648
  );
Dries's avatar
Dries committed
649
650
651
652
  $form['feed_item_length'] = array(
    '#type' => 'select',
    '#title' => t('Display of XML feed items'),
    '#default_value' => variable_get('feed_item_length','teaser'),
653
654
    '#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.')
655
  );
656

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

function system_date_time_settings() {
661
  // Date settings:
Steven Wittens's avatar
Steven Wittens committed
662
  $zones = _system_zonelist();
663

664
  // Date settings: possible date formats
Dries's avatar
   
Dries committed
665
  $dateshort = array('Y-m-d H:i','m/d/Y - H:i', 'd/m/Y - H:i', 'Y/m/d - H:i',
666
           '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
667
668
           '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
669
670
  $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
671
          'D, m/d/Y - g:ia', 'D, d/m/Y - g:ia', 'D, Y/m/d - g:ia',
672
          '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
673
  $datelong = array('l, F j, Y - H:i', 'l, j F, Y - H:i', 'l, Y,  F j - H:i',
674
        '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
675

676
  // Date settings: construct choices for user
Dries's avatar
   
Dries committed
677
  foreach ($dateshort as $f) {
Dries's avatar
   
Dries committed
678
    $dateshortchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
   
Dries committed
679
680
  }
  foreach ($datemedium as $f) {
Dries's avatar
   
Dries committed
681
    $datemediumchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
   
Dries committed
682
683
  }
  foreach ($datelong as $f) {
Dries's avatar
   
Dries committed
684
    $datelongchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
   
Dries committed
685
686
  }

Dries's avatar
Dries committed
687
688
689
690
691
692
  $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.')
693
694
  );

Dries's avatar
Dries committed
695
696
697
698
699
  $form['configurable_timezones'] = array(
    '#type' => 'radios',
    '#title' => t('Configurable time zones'),
    '#default_value' => variable_get('configurable_timezones', 1),
    '#options' => array(t('Disabled'), t('Enabled')),
700
    '#description' => t('Enable or disable user-configurable time zones. When enabled, users can set their own time zone and dates will be updated accordingly.')
701
702
  );

Dries's avatar
Dries committed
703
704
705
706
707
708
  $form['date_format_short'] = array(
    '#type' => 'select',
    '#title' => t('Short date format'),
    '#default_value' => variable_get('date_format_short', $dateshort[0]),
    '#options' => $dateshortchoices,
    '#description' => t('The short format of date display.')
709
710
  );

Dries's avatar
Dries committed
711
712
713
714
715
716
  $form['date_format_medium'] = array(
    '#type' => 'select',
    '#title' => t('Medium date format'),
    '#default_value' => variable_get('date_format_medium', $datemedium[0]),
    '#options' => $datemediumchoices,
    '#description' => t('The medium sized date display.')
717
718
  );

Dries's avatar
Dries committed
719
720
721
722
723
724
  $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.')
725
726
  );

Dries's avatar
Dries committed
727
728
729
730
  $form['date_first_day'] = array(
    '#type' => 'select',
    '#title' => t('First day of week'),
    '#default_value' => variable_get('date_first_day', 0),
731
732
    '#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.')
733
  );
Dries's avatar
   
Dries committed
734

Dries's avatar
Dries committed
735
736
  return system_settings_form('system_date_time_settings', $form);
}
Dries's avatar
 
Dries committed
737

Dries's avatar
Dries committed
738
function system_site_status_settings() {
739

Dries's avatar
Dries committed
740
  $form['site_offline'] = array(
741
742
743
    '#type' => 'radios',
    '#title' => t('Site status'),
    '#default_value' => variable_get('site_offline', 0),
744
745
    '#options' => array(t('Online'), t('Off-line')),
    '#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'))),
746
747
  );

Dries's avatar
Dries committed
748
  $form['site_offline_message'] = array(
749
    '#type' => 'textarea',
750
    '#title' => t('Site off-line message'),
751
    '#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'))))),
752
    '#description' => t('Message to show visitors when the site is in off-line mode.')
753
754
  );

Dries's avatar
Dries committed
755
756
757
758
759
760
  return system_settings_form('system_site_status_settings', $form);
}

function system_unicode_settings() {
  return system_settings_form('system_unicode_settings', unicode_settings());
}
761

762
763
764
765
766
767
768
769
770
771
772
function system_cron_status($cron = '') {
  if ($cron == 'cron') {
    // Run cron manually
    if (drupal_cron_run()) {
      drupal_set_message(t('Cron ran successfully'));
    }
    else {
      drupal_set_message(t('Cron run failed'));
    }
    drupal_goto('admin/settings/cron-status');
  }
773

774
  $cron_last = variable_get('cron_last', NULL);
Dries's avatar
Dries committed
775
776
777
778
779
  if (is_numeric($cron_last)) {
    $status = t('Cron is running. The last cron job ran %time ago.', array('%time' => format_interval(time() - $cron_last)));
  }
  else {
    $status = t('Cron has not run. It appears cron jobs have not been setup on your system. Please check the help pages for <a href="%url">configuring cron jobs</a>.', array('%url' => 'http://drupal.org/cron'));
780
  }
781
  $status .= ' '. t('Cron can, if necessary, also be run <a href="%cron">manually</a>.', array('%cron' => url('admin/settings/cron-status/cron')));
Dries's avatar
Dries committed
782
783

  return $status;
Dries's avatar
   
Dries committed
784
785
}

786
787
/**
 * Checks the existence of the directory specified in $form_element. This
Dries's avatar
Dries committed
788
 * function is called from the system_settings form to check both the
789
790
791
792
793
794
795
 * 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.
 */
796
function system_check_directory($form_element) {
797
798
799
800
  file_check_directory($form_element['#value'], FILE_CREATE_DIRECTORY, $form_element['#parents'][0]);
  return $form_element;
}

Dries's avatar
   
Dries committed
801
802
803
804
/**
 * 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
805
  // Extract current files from database.
806
  $result = db_query("SELECT filename, name, type, status, throttle, schema_version FROM {system} WHERE type = '%s'", $type);
Dries's avatar
   
Dries committed
807
  while ($file = db_fetch_object($result)) {
808
    if (isset($files[$file->name]) && is_object($files[$file->name])) {
809
      $file->old_filename = $file->filename;
Dries's avatar
   
Dries committed
810
      foreach ($file as $key => $value) {
811
        if (!isset($files[$file->name]) || !isset($files[$file->name]->$key)) {
Dries's avatar
Dries committed
812
813
          $files[$file->name]->$key = $value;
        }
Dries's avatar
   
Dries committed
814
      }
815
    }
Dries's avatar
 
Dries committed
816
  }
Dries's avatar
   
Dries committed
817
}
Dries's avatar
 
Dries committed
818

Dries's avatar
   
Dries committed
819
820
821
/**
 * Collect data about all currently available themes
 */
Dries's avatar
Dries committed
822
823
824
825
function system_theme_data() {
  // Find themes
  $themes = system_listing('\.theme$', 'themes');

Dries's avatar
   
Dries committed
826
  // Find theme engines
Dries's avatar
Dries committed
827
828
829
830
831
832
833
834
835
  $engines = system_listing('\.engine$', 'themes/engines');

  // can't iterate over array itself as it uses a copy of the array items
  foreach (array_keys($themes) as $key) {
    drupal_get_filename('theme', $themes[$key]->name, $themes[$key]->filename);
    drupal_load('theme', $themes[$key]->name);
    $themes[$key]->owner = $themes[$key]->filename;
    $themes[$key]->prefix = $key;
  }
Dries's avatar
   
Dries committed
836

Dries's avatar
Dries committed
837
838
  // Remove all theme engines from the system table
  db_query("DELETE FROM {system} WHERE type = 'theme_engine'");
Dries's avatar
   
Dries committed
839
840

  foreach ($engines as $engine) {
Dries's avatar
   
Dries committed
841
    // Insert theme engine into system table
Dries's avatar
Dries committed
842
843
844
845
    drupal_get_filename('theme_engine', $engine->name, $engine->filename);
    drupal_load('theme_engine', $engine->name);
    db_query("INSERT INTO {system} (name, type, filename, status, throttle, bootstrap) VALUES ('%s', '%s', '%s', %d, %d, %d)", $engine->name, 'theme_engine', $engine->filename, 1, 0, 0);

Dries's avatar
   
Dries committed
846
    // Add templates to the site listing
Dries's avatar
Dries committed
847
    foreach (call_user_func($engine->name . '_templates') as $template) {
848
849
      // Do not double-insert templates with theme files in their directory,
      // but do register their engine data.
Dries's avatar
   
Dries committed
850
      if (array_key_exists($template->name, $themes)) {
851
852
853
854
855
856
857
858
859
860
861
        $themes[$template->name]->template = TRUE;
        $themes[$template->name]->owner = $engine->filename;
        $themes[$template->name]->prefix = $engine->name;
      }
      else {
        $template->template = TRUE;
        $template->name = basename(dirname($template->filename));
        $template->owner = $engine->filename;
        $template->prefix = $engine->name;

        $themes[$template->name] = $template;
Dries's avatar
   
Dries committed
862
      }
Dries's avatar
   
Dries committed
863
864
865
866
    }
  }

  // Find styles in each theme's directory.
Dries's avatar
Dries committed
867
868
  foreach ($themes as $theme) {
    foreach (file_scan_directory(dirname($theme->filename), 'style.css$') as $style) {
Dries's avatar
   
Dries committed
869
      $style->style = TRUE;
870
      $style->template = isset($theme->template) ? $theme->template : FALSE;
Dries's avatar
   
Dries committed
871
872
873
874
875
876
      $style->name = basename(dirname($style->filename));
      $style->owner = $theme->filename;
      $style->prefix = $theme->template ? $theme->prefix : $theme->name;
      // do not double-insert styles with theme files in their directory
      if (array_key_exists($style->name, $themes)) {
        continue;
Dries's avatar
   
Dries committed
877
      }
Dries's avatar
   
Dries committed
878
      $themes[$style->name] = $style;
Dries's avatar
   
Dries committed
879
    }
Dries's avatar
   
Dries committed
880
  }
Dries's avatar
   
Dries committed
881
882

  // Extract current files from database.
Dries's avatar
Dries committed
883
884
885
  system_get_files_database($themes, 'theme');

  db_query("DELETE FROM {system} WHERE type = 'theme'");
Dries's avatar
   
Dries committed
886

Dries's avatar
Dries committed
887
888
889
890
891
892
893
  foreach ($themes as $theme) {
    db_query("INSERT INTO {system} (name, description, type, filename, status, throttle, bootstrap) VALUES ('%s', '%s', '%s', '%s', %d, %d, %d)", $theme->name, $theme->owner, 'theme', $theme->filename, $theme->status, 0, 0);
  }

  return $themes;
}

894
895
896
/**
 * Get a list of available regions from a specified theme.
 *
897
 * @param $theme_key
898
899
900
901
 *   The name of a theme.
 * @return
 *   An array of regions in the form $region['name'] = 'description'.
 */
902
function system_region_list($theme_key) {
903
904
  static $list = array();

905
  if (!array_key_exists($theme_key, $list)) {
906
    $theme = db_fetch_object(db_query("SELECT * FROM {system} WHERE type = 'theme' AND name = '%s'", $theme_key));
907

908
    // Stylesheets can't have regions; use its theme.
909
    if (strpos($theme->filename, '.css')) {
910
      return system_region_list(basename(dirname($theme->description)));
911
    }
912
913

    // If this is a custom theme, load it in before moving on.
914
    if (file_exists($file = dirname($theme->filename) .'/' . $theme_key . '.theme')) {
915
      include_once "./$file";
916
917
    }

918
919
920
921
922
923
924
925
926
    $regions = array();

    // This theme has defined its own regions.
    if (function_exists($theme_key . '_regions')) {
      $regions = call_user_func($theme_key . '_regions');
    }
    // File is an engine; include its regions.
    else if (strpos($theme->description, '.engine')) {
      include_once './' . $theme->description;
927
      $theme_engine = basename($theme->description, '.engine');
928
      $regions = function_exists($theme_engine . '_regions') ? call_user_func($theme_engine . '_regions') : array();
929
930
    }

931
    $list[$theme_key] = $regions;
932
933
  }

934
  return $list[$theme_key];
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
}

/**
 * Get the name of the default region for a given theme.
 *
 * @param $theme
 *   The name of a theme.
 * @return
 *   A string that is the region name.
 */
function system_default_region($theme) {
  $regions = array_keys(system_region_list($theme));
  return $regions[0];
}

Dries's avatar
Dries committed
950
/**
951
 * Returns an array of files objects of the given type from the site-wide
952
953
954
955
956
957
958
 * directory (i.e. modules/), the all-sites directory (i.e.
 * sites/all/modules/), the profiles directory, and site-specific directory
 * (i.e. sites/somesite/modules/). The returned array will be keyed using the
 * key specified (name, basename, filename). Using name or basename will cause
 * site-specific files to be prioritized over similar files in the default
 * directories. That is, if a file with the same name appears in both the
 * site-wide directory and site-specific directory, only the site-specific
959
 * version will be included.
Dries's avatar
Dries committed
960
961
962
963
 *
 * @param $mask
 *   The regular expression of the files to find.
 * @param $directory
964
 *   The subdirectory name in which the files are found. For example,
Dries's avatar
Dries committed
965
966
967
968
 *   'modules' will search in both modules/ and
 *   sites/somesite/modules/.
 * @param $key
 *   The key to be passed to file_scan_directory().
969
970
 * @param $min_depth
 *   Minimum depth of directories to return files from.
Dries's avatar
Dries committed
971
972
973
974
 *
 * @return
 *   An array of file objects of the specified type.
 */
975
function system_listing($mask, $directory, $key = 'name', $min_depth = 1) {
976
  $config = conf_path();
977
  $profile = variable_get('install_profile', 'default');
Dries's avatar
Dries committed
978
979
980
  $searchdir = array($directory);
  $files = array();

981
982
  // Always search sites/all/* as well as the global directories
  $searchdir[] = 'sites/all';
983

984
985
986
987
  // The 'profiles' directory contains pristine collections of modules and
  // themes as organized by a distribution.  It is pristine in the same way
  // that /modules is pristine for core; users should avoid changing anything
  // there in favor of sites/all or sites/<domain> directories.
988
989
990
991
  if (file_exists("profiles/$profile/$directory")) {
    $searchdir[] = "profiles/$profile/$directory";
  }

Dries's avatar
Dries committed
992
993
994
995
996
997
  if (file_exists("$config/$directory")) {
    $searchdir[] = "$config/$directory";
  }

  // Get current list of items
  foreach ($searchdir as $dir) {
998
    $files = array_merge($files, file_scan_directory($dir, $mask, array('.', '..', 'CVS'), 0, TRUE, $key, $min_depth));
Dries's avatar
Dries committed
999
1000
  }