system.module 52.5 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
10
11
12
/**
 * Implementation of hook_help().
 */
function system_help($section) {
Dries's avatar
   
Dries committed
13
  global $base_url;
Dries's avatar
   
Dries committed
14

15
  switch ($section) {
16
17
    case 'admin':
      return t('<p>Welcome to the administration section. Below are the most recent system events.</p>');
18
    case 'admin/settings':
19
      return t('<p>General configuration options for your site. Set up the name of the site, e-mail address used in mail-outs, clean URL options, caching, etc.</p>');
Dries's avatar
   
Dries committed
20
    case 'admin/themes':
21
      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>');
Dries's avatar
   
Dries committed
22
    case 'admin/themes/settings':
23
      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>');
Dries's avatar
   
Dries committed
24
    case 'admin/themes/settings/'. arg(3):
25
26
      $reference = explode('.', arg(3), 2);
      $theme = array_pop($reference);
27
      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/themes/settings')));
Dries's avatar
   
Dries committed
28
    case 'admin/modules':
29
      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>', array('%permissions' => url('admin/access/permissions'), '%throttle' => url('admin/settings/throttle')));
Dries's avatar
   
Dries committed
30
    case 'admin/help#system':
Dries's avatar
   
Dries committed
31
      return t("
Dries's avatar
   
Dries committed
32
33
34
35
36
37
38
      <p>Drupal comes with system-wide defaults but the setting-module provides control over many Drupal preferences, behaviours including visual and operational settings.</p>
      <h3><a id=\"cron\">Cron</a></h3>
      <p>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).   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.</p>
      <p>The recommended way to set up your cron system is to set up a Unix/Linux crontab entry (see \"man crontab\") that frequently visits %cron-link.  Note that cron does not guarantee the commands will be executed at the specified interval.  However, Drupal will try its best to run the tasks as close to the specified intervals as possible.  The more you visit cron.php, the more accurate cron will be.</p>
      <p>If your hosting company does not allow you to set up crontab entries, you can always ask someone else to set up an entry for you. After all, virtually any Unix/Linux machine with access to the internet can set up a crontab entry to frequently visit %cron-link.</p>
      <p>For the Unix/Linux crontab itself, use a browser like <a href=\"%lynx\">lynx</a> or <a href=\"%wget\">wget</a> but make sure the process terminates: either use <code>/usr/bin/lynx -source %base_url/cron.php</code> or <code>/usr/bin/wget -o /dev/null -O /dev/null %cron-link</code>.  Take a look at the example scripts in the <code>scripts</code>-directory. Make sure to adjust them to fit your needs.  A good crontab line to run the cron script once every hour would be:
      <pre>     00 * * * * /home/www/drupal/scripts/cron-lynx.sh</pre>
39
      Note that it is essential to access <code>cron.php</code> using a browser on the web site's domain; do not run it using command line PHP and avoid using <code>localhost</code> or <code>127.0.0.1</code> or some of the environment variables will not be set correctly and features may not work as expected.</p>", array('%base_url' => $base_url, '%cron-link' => "<a href=\"$base_url/cron.php\">$base_url/cron.php</a>", '%lynx' => 'http://lynx.browser.org', '%wget' => 'http://www.gnu.org/software/wget/wget.html' ));
Dries's avatar
   
Dries committed
40
    case 'admin/modules#description':
41
      return t('Handles general site configuration for administrators.');
42
  }
Dries's avatar
   
Dries committed
43
44
}

Dries's avatar
   
Dries committed
45
46
47
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
48
function system_perm() {
49
  return array('administer site configuration', 'access administration pages', 'bypass input data check');
Dries's avatar
   
Dries committed
50
51
}

52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/**
 * Implementation of hook_elements().
 */
function system_elements() {
  // Top level form
  $type['form'] = array(method => 'POST', action => request_uri());

  // Inputs
  $type['checkbox'] = array(input => TRUE, return_value => 1);
  $type['submit'] = array(input => TRUE, name => 'op', button_type => 'submit', execute => TRUE);
  $type['button'] = array(input => TRUE, name => 'op', button_type => 'submit', exexute => FALSE);
  $type['textfield'] = array(input => TRUE, size => 60, maxlength => 70, autocomplete_path => FALSE);
  $type['password'] = array(input => TRUE, size => 60, maxlength => 70);
  $type['textarea'] = array(input => TRUE, cols => 60, rows => 20);
  $type['radios'] = array(input => TRUE, process => 'expand_radios');
  $type['radio'] = array(input => TRUE);
  $type['checkboxes'] = array(input => TRUE, process => 'expand_checkboxes', tree => TRUE);
  $type['select'] = array(input => TRUE);
  $type['weight'] = array(input => TRUE, delta => 10);
  $type['date'] = array(input => TRUE, process => 'expand_date');
  $type['file'] = array(input => TRUE, size => 60);

  // Form structure
  $type['item'] = array();
  $type['hidden'] = array(input => TRUE);
  $type['value'] = array(input => TRUE);
  $type['markup'] = array(prefix => '', suffix => '');
  $type['fieldset'] = array(collapsible => FALSE, collapsed => FALSE);
  return $type;
}

Dries's avatar
   
Dries committed
83
/**
Dries's avatar
   
Dries committed
84
 * Implementation of hook_menu().
Dries's avatar
   
Dries committed
85
 */
Dries's avatar
   
Dries committed
86
function system_menu($may_cache) {
Dries's avatar
   
Dries committed
87
  $items = array();
Dries's avatar
   
Dries committed
88

Dries's avatar
   
Dries committed
89
90
91
92
93
94
  if ($may_cache) {
    $items[] = array('path' => 'system/files', 'title' => t('file download'),
      'callback' => 'file_download',
      'access' => TRUE,
      'type' => MENU_CALLBACK);

95
96
97
98
99
100
    // Clean URL tester
    $items[] = array('path' => 'system/test',
      'callback' => 'system_test',
      'access' => TRUE,
      'type' => MENU_CALLBACK);

Dries's avatar
   
Dries committed
101
102
    $access = user_access('administer site configuration');

103
104
    $items[] = array('path' => 'admin', 'title' => t('administer'),
      'access' => user_access('access administration pages'),
Dries's avatar
   
Dries committed
105
      'callback' => 'watchdog_overview',
106
107
      'weight' => 9);

Dries's avatar
   
Dries committed
108
109
110
111
    // Themes:
    $items[] = array('path' => 'admin/themes', 'title' => t('themes'),
      'callback' => 'system_themes', 'access' => $access);

Dries's avatar
   
Dries committed
112
    $items[] = array('path' => 'admin/themes/select', 'title' => t('list'),
Dries's avatar
   
Dries committed
113
114
115
116
117
118
119
120
121
122
123
124
125
      'callback' => 'system_themes', 'access' => $access,
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -1);

    $items[] = array('path' => 'admin/themes/settings', 'title' => t('configure'),
      'callback' => 'system_theme_settings', 'access' => $access,
      'type' => MENU_LOCAL_TASK);

    // Theme configuration subtabs
    $items[] = array('path' => 'admin/themes/settings/global', 'title' => t('global settings'),
      'callback' => 'system_theme_settings', 'access' => $access,
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -1);

    foreach (list_themes() as $theme) {
Dries's avatar
   
Dries committed
126
       $items[] = array('path' => 'admin/themes/settings/'. $theme->name, 'title' => $theme->name,
127
       'callback' => 'system_theme_settings', 'callback arguments' => array($theme->name), 'access' => $access,
Dries's avatar
   
Dries committed
128
129
130
131
132
133
134
135
136
137
       'type' => MENU_LOCAL_TASK);
    }

    // Modules:
    $items[] = array('path' => 'admin/settings', 'title' => t('settings'),
      'callback' => 'system_site_settings', 'access' => $access);
    foreach (module_list() as $name) {
      if (module_hook($name, 'settings')) {
        $items[] = array('path' => 'admin/settings/'. $name, 'title' => t($name));
      }
Dries's avatar
   
Dries committed
138
    }
Dries's avatar
   
Dries committed
139
140
    $items[] = array('path' => 'admin/modules', 'title' => t('modules'),
      'callback' => 'system_modules', 'access' => $access);
Dries's avatar
   
Dries committed
141
  }
Dries's avatar
   
Dries committed
142
143

  return $items;
Dries's avatar
 
Dries committed
144
145
}

146
147
148
149
/**
 * Menu callback: dummy clean URL tester.
 */
function system_test() {
150
151
  variable_set('clean_url_ok', 1);
  exit;
152
153
}

Dries's avatar
   
Dries committed
154
155
156
157
158
/**
 * Implementation of hook_user().
 *
 * Allows users to individually set their theme and time zone.
 */
159
160
function system_user($type, $edit, &$user, $category = NULL) {
  if ($type == 'form' && $category == 'account') {
161
162
    $themes = list_themes();
    ksort($themes);
163

164
165
166
167
168
169
170
    // Reset to follow site default theme if user selects the site default
    if ($key == variable_get('theme_default', 'bluemarine')) {
      $key = '';
      if ($edit['theme'] == variable_get('theme_default', 'bluemarine')) {
        $edit['theme'] = '';
      }
    }
Dries's avatar
   
Dries committed
171

172
173
174
    $form['themes'] = array(
      type => 'fieldset', title => t('Theme configuration'), description => t('Selecting a different theme will change the look and feel of the site.'), weight => 2, collapsible => TRUE, collapsed => FALSE
    );
Dries's avatar
   
Dries committed
175

176
177
178
    foreach ($themes as $info) {
      $info->screenshot = dirname($info->filename) . '/screenshot.png';
      $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');
Dries's avatar
   
Dries committed
179

180
181
182
      $form['themes'][$info->name]['screenshot'] = array(type => 'markup', value => $screenshot);
      $form['themes'][$info->name]['description'] = array(type => 'item', title => $info->name,  value => dirname($info->filename));
      $options[$info->name] = '';
Dries's avatar
   
Dries committed
183
    }
184

185
186
    $form['themes']['theme'] = array(type => 'radios', options => $options, default_value => $edit['theme']);

187
    if (variable_get('configurable_timezones', 1)) {
Steven Wittens's avatar
Steven Wittens committed
188
      $zones = _system_zonelist();
189
190
191
192
193
      $form['locale'] = array(type=>'item', title => t('Locale settings'), weight => 6);
      $form['locale']['timezone'] = array(
        type => 'select', title => t('Time zone'), default_value => strlen($edit['timezone']) ? $edit['timezone'] : variable_get('date_default_timezone', 0),
        options => $zones, descriptions => t('Select your current local time. Dates and times throughout this site will be displayed using this time zone.')
      );
Dries's avatar
   
Dries committed
194
    }
195
    return $form;
Dries's avatar
   
Dries committed
196
  }
Dries's avatar
   
Dries committed
197
198
}

Steven Wittens's avatar
Steven Wittens committed
199
200
201
202
203
204
205
206
207
208
209
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
210
function system_view_general() {
211
  // General settings:
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
  $form['general'] = array(
    type => 'fieldset', title => t('General settings'),
    collapsible => TRUE, collapsed => TRUE
  );
  $form['general']['site_name'] = array(
    type => 'textfield', title => t('Name'), default_value => variable_get('site_name', 'drupal'),
    description => t('The name of this web site.')
  );
  $form['general']['site_mail'] = array(
    type => 'textfield', title => t('E-mail address'), default_value => variable_get('site_mail', ini_get('sendmail_from')), maxlength => 128,
    description => t('A valid e-mail address for this website, used by the auto-mailer during registration, new password requests, notifications, etc.')
  );
  $form['general']['site_slogan'] = array(
    type => 'textfield', title => t('Slogan'), default_value => variable_get('site_slogan', ''),
    maxlength => 128, description => t('The slogan of this website. Some themes display a slogan when available.')
  );

  $form['general']['site_mission'] = array(
    type => 'textarea', title => t('Mission'), default_value => variable_get('site_mission', ''),
    rows => 5, description => t('Your site\'s mission statement or focus.')
  );
  $form['general']['site_footer'] = array(
    type => 'textarea', title => t('Footer message'), default_value => variable_get('site_footer', ''), rows => 5,
    description => t('This text will be displayed at the bottom of each page.  Useful for adding a copyright notice to your pages.')
  );
  $form['general']['anonymous'] = array(
    type => 'textfield', title => t('Anonymous user'), default_value => variable_get('anonymous', 'Anonymous'),
    description => t('The name used to indicate anonymous users.')
  );
  $form['general']['site_frontpage'] = array(
    type => 'textfield', title => t('Default front page'), default_value => variable_get('site_frontpage', 'node'),
    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".')
  );
245

246
  // We check for clean URL support using an image on the client side.
247
248
249
250
251
  $form['general']['clean_url'] = array(
    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). You\'ll need <code>ModRewrite</code> support for this to work. See the <code>.htaccess</code> file in Drupal\'s top-level directory for more information.')
  );

252
253
254
  variable_set('clean_url_ok', 0);
  global $base_url;
  // We will use a random URL so there is no way a proxy or a browser could cache the "no such image" answer.
255
  $form['general']['clean_url_test'] = array(type => 'markup', value => '<img style="position: relative; left: -1000em;" src="'. $base_url. '/system/test/'. user_password(20) .'.png" alt="" />');
Dries's avatar
   
Dries committed
256

257
  // Error handling:
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275

  $form['errors'] = array( type => 'fieldset', title =>t('Error handling'), collapsible => TRUE, collapsed => TRUE );
  $form['errors']['site_403'] = array(
    type => 'textfield', title => t('Default 403 (access denied) page'), default_value => variable_get('site_403', ''),
    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.')
  );

  $form['errors']['site_404'] = array(
    type => 'textfield', title => t('Default 404 (not found) page'), default_value =>  variable_get('site_404', ''),
    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.')
  );

  $form['errors']['error_level'] = array(
    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.')
  );

Dries's avatar
   
Dries committed
276
277
  $period = drupal_map_assoc(array(3600, 10800, 21600, 32400, 43200, 86400, 172800, 259200, 604800, 1209600, 2419200), 'format_interval');
  $period['1000000000'] = t('Never');
278
279
280
281
  $form['errors']['watchdog_clear'] = array(
    type => 'select', title => t('Discard log entries older than'), default_value => variable_get('watchdog_clear', 604800), options => $period,
    description => t('The time log entries should be kept.  Older entries will be automatically discarded.  Requires crontab.')
  );
Dries's avatar
   
Dries committed
282

Dries's avatar
 
Dries committed
283

284
  // Caching:
285
286
287
288
289
290
291
292
  $form['cache'] = array(type => 'fieldset', title => t('Cache settings'), collapsible => TRUE, collapsed => TRUE);

  $form['cache']['cache']  = array(
    type => 'radios',  title => t('Page cache'), default_value => variable_get('cache', CACHE_DISABLED),
    options => array(CACHE_DISABLED => t('Disabled'), CACHE_ENABLED => t('Enabled')),
    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.")
  );

293
294
  $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');
295
296
297
298
  $form['cache']['cache_lifetime'] = array(
    type => 'select', title => t('Minimum cache lifetime'), default_value => variable_get('cache_lifetime', 0), options => $period,
    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.')
  );
Dries's avatar
   
Dries committed
299

Dries's avatar
   
Dries committed
300

301
  // File system:
302
303
  $form['files'] = array(type => 'fieldset', title => t('File system settings'), collapsible => TRUE, collapsed => TRUE);

Dries's avatar
   
Dries committed
304
  $directory_path = variable_get('file_directory_path', 'files');
Dries's avatar
   
Dries committed
305
  file_check_directory($directory_path, FILE_CREATE_DIRECTORY, 'file_directory_path');
Dries's avatar
   
Dries committed
306

307
308
309
310
311
  $form['files']['file_directory_path'] = array(
    type => 'textfield', title => t('File system path'), default_value => $directory_path, maxlength => 255, valid => 'directory',
    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.')
  );

Steven Wittens's avatar
Steven Wittens committed
312
  $directory_temp = variable_get('file_directory_temp', FILE_DIRECTORY_TEMP);
313
  file_check_directory($directory_temp, FILE_CREATE_DIRECTORY, 'file_directory_temp');
Dries's avatar
   
Dries committed
314

315
316
317
318
319
320
321
322
323
324
  $form['files']['file_directory_tmp'] = array(
    type => 'textfield', title => t('Temporary directory'), default_value => $directory_temp, maxlength => 255, valid => 'directory',
    description => t('Location where uploaded files will be kept during previews. Relative paths will be resolved relative to the file system path.')
  );

  $form['files']['file_downloads'] = array(
    type => 'radios', title => t('Download method'), default_value => variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC),
    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.')
  );
Dries's avatar
   
Dries committed
325

326
  /*
327
  // Image handling:
328
  $group = array();
329
330
  $toolkits_available = image_get_available_toolkits();
  if (count($toolkits_available) > 1) {
331
332
333
334
    $group['image_toolkit'] = array(
      type => 'radios', title => t('Select an image processing toolkit'),
      default_value => variable_get('image_toolkit', image_get_toolkit()), options => $toolkits_available
    );
335
  }
336
337
338
339
  $group['toolkit'] = image_toolkit_invoke('settings');
  if (is_array($group)) {
    $form['image'] = array(type => 'fieldset', title => t('Image handling'), collapsible => TRUE, collapsed => true);
    $form['image'] = array_merge($form['image'], $group);
340
  }
341
  */
342

343
  // Feed settings
344
345
346
347
348
349
350
351
352
353
354
  $form['feed'] = array(type => 'fieldset', title => t('RSS feed settings'), collapsible => TRUE, collapsed => TRUE);
  $form['feed']['feed_default_items'] = array(
    type => 'select', title => t('Number of items per feed'), default_value => variable_get('feed_default_items', 10),
    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.')
  );
  $form['feed']['feed_item_length'] = array(
    type => 'select', title => t('Display of XML feed items'), default_value => variable_get('feed_item_length','teaser'),
    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.')
  );
355

356
  // Date settings:
Steven Wittens's avatar
Steven Wittens committed
357
  $zones = _system_zonelist();
358

359
  // Date settings: possible date formats
Dries's avatar
   
Dries committed
360
  $dateshort = array('Y-m-d H:i','m/d/Y - H:i', 'd/m/Y - H:i', 'Y/m/d - H:i',
Dries's avatar
   
Dries committed
361
362
363
           'm/d/Y - g:ia', 'd/m/Y - g:ia', 'Y/m/d - g:ia',
           '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
364
365
  $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
366
367
368
369
          'D, m/d/Y - g:ia', 'D, d/m/Y - g:ia', 'D, Y/m/d - g:ia',
          'F j, Y - g:ia', 'j F, Y - g:ia', 'Y, F j - g:ia');
  $datelong = array('l, F j, Y - H:i', 'l, j F, Y - H:i', 'l, Y,  F j - H:i',
        'l, F j, Y - g:ia', 'l, j F, Y - g:ia', 'l, Y,  F j - g:ia');
Dries's avatar
   
Dries committed
370

371
  // Date settings: construct choices for user
Dries's avatar
   
Dries committed
372
  foreach ($dateshort as $f) {
Dries's avatar
   
Dries committed
373
    $dateshortchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
   
Dries committed
374
375
  }
  foreach ($datemedium as $f) {
Dries's avatar
   
Dries committed
376
    $datemediumchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
   
Dries committed
377
378
  }
  foreach ($datelong as $f) {
Dries's avatar
   
Dries committed
379
    $datelongchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
   
Dries committed
380
381
  }

382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
  $form['dates'] = array(type => 'fieldset', title => t('Date settings'), collapsible => TRUE, collapsed => TRUE);
  $form['dates']['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.')
  );

  $form['dates']['configurable_timezones'] = array(
    type => 'radios', title => t('Configurable time zones'), default_value => variable_get('configurable_timezones', 1), options => array(t('Disabled'), t('Enabled')),
    description => t('Enable or disable user-configurable time zones.  When enabled, users can set their own time zone and dates will be updated accordingly.')
  );

  $form['dates']['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.')
  );

  $form['dates']['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.')
  );

  $form['dates']['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.')
  );

  $form['dates']['date_first_day'] = array(
    type => 'select', title => t('First day of week'), default_value => variable_get('date_first_day', 0),
    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.')
  );
Dries's avatar
   
Dries committed
413

Dries's avatar
 
Dries committed
414

415
  // String handling: report status and errors.
416
417
  $form['strings'] = array(type => 'fieldset', title => t('String handling'), collapsible => TRUE, collapsed => TRUE);
  $form['strings'] = array_merge($form['strings'], unicode_settings());
418

419
  return $form;
Dries's avatar
   
Dries committed
420
421
}

Dries's avatar
   
Dries committed
422
423
424
425
/**
 * 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
426
  // Extract current files from database.
Dries's avatar
Dries committed
427
  $result = db_query("SELECT name, type, status, throttle FROM {system} WHERE type = '%s'", $type);
Dries's avatar
   
Dries committed
428
  while ($file = db_fetch_object($result)) {
429
    if (isset($files[$file->name]) && is_object($files[$file->name])) {
Dries's avatar
   
Dries committed
430
      foreach ($file as $key => $value) {
431
        if (!isset($files[$file->name]) || !isset($files[$file->name]->$key)) {
Dries's avatar
Dries committed
432
433
          $files[$file->name]->$key = $value;
        }
Dries's avatar
   
Dries committed
434
      }
435
    }
Dries's avatar
 
Dries committed
436
  }
Dries's avatar
   
Dries committed
437
}
Dries's avatar
 
Dries committed
438

Dries's avatar
   
Dries committed
439
440
441
/**
 * Collect data about all currently available themes
 */
Dries's avatar
Dries committed
442
443
444
445
function system_theme_data() {
  // Find themes
  $themes = system_listing('\.theme$', 'themes');

Dries's avatar
   
Dries committed
446
  // Find theme engines
Dries's avatar
Dries committed
447
448
449
450
451
452
453
454
455
  $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
456

Dries's avatar
Dries committed
457
458
  // Remove all theme engines from the system table
  db_query("DELETE FROM {system} WHERE type = 'theme_engine'");
Dries's avatar
   
Dries committed
459
460

  foreach ($engines as $engine) {
Dries's avatar
   
Dries committed
461
    // Insert theme engine into system table
Dries's avatar
Dries committed
462
463
464
465
    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
466
    // Add templates to the site listing
Dries's avatar
Dries committed
467
    foreach (call_user_func($engine->name . '_templates') as $template) {
468
469
      // Do not double-insert templates with theme files in their directory,
      // but do register their engine data.
Dries's avatar
   
Dries committed
470
      if (array_key_exists($template->name, $themes)) {
471
472
473
474
475
476
477
478
479
480
481
        $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
482
      }
Dries's avatar
   
Dries committed
483
484
485
486
    }
  }

  // Find styles in each theme's directory.
Dries's avatar
Dries committed
487
488
  foreach ($themes as $theme) {
    foreach (file_scan_directory(dirname($theme->filename), 'style.css$') as $style) {
Dries's avatar
   
Dries committed
489
490
491
492
493
494
495
496
      $style->style = TRUE;
      $style->template = $theme->template;
      $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
497
      }
Dries's avatar
   
Dries committed
498
      $themes[$style->name] = $style;
Dries's avatar
   
Dries committed
499
    }
Dries's avatar
   
Dries committed
500
  }
Dries's avatar
   
Dries committed
501
502

  // Extract current files from database.
Dries's avatar
Dries committed
503
504
505
  system_get_files_database($themes, 'theme');

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

Dries's avatar
Dries committed
507
508
509
510
511
512
513
  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;
}

514
515
516
/**
 * Get a list of available regions from a specified theme.
 *
517
 * @param $theme_key
518
519
520
521
 *   The name of a theme.
 * @return
 *   An array of regions in the form $region['name'] = 'description'.
 */
522
function system_region_list($theme_key) {
523
524
  static $list = array();

525
  if(!array_key_exists($theme_key, $list)) {
526

527
528
    $result = db_query("SELECT * FROM {system} WHERE type = 'theme' AND name = '%s'", $theme_key);
    $theme = db_fetch_object($result);
529

530
    if (strpos($theme->filename, '.css')) {
531
      // File is a style, which can't have its own regions; use its theme instead.
532
533
      $list[$theme_key] = system_region_list(basename(dirname($theme->description)));
      return $list[$theme_key];
534
    }
535
    if (file_exists($file = dirname($theme->filename) .'/' . $theme_key . '.theme')) {
536
    include_once "./$file";
537
538
    }

539
540
    $regions = function_exists($theme_key . '_regions') ? call_user_func($theme_key . '_regions') : array();
    if (strpos($theme->description, '.engine')) {
541
      // File is a template; include its engine's regions.
542
    include_once './' . $theme->description;
543
      $theme_engine = basename($theme->description, '.engine');
544
545
546
547
      $engine_regions = function_exists($theme_engine . '_regions') ? call_user_func($theme_engine . '_regions') : array();
      $regions = array_merge($engine_regions, $regions);
    }

548
    $list[$theme_key] = $regions;
549
550
  }

551
  return $list[$theme_key];
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
}

/**
 * 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
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
/**
 * Returns an array of files objects of the given type from both the
 * site-wide directory (i.e. modules/) 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 shadow files in the
 * default directories.  That is, if a file with the same name appears
 * in both location, only the site-specific version will be included.
 *
 * @param $mask
 *   The regular expression of the files to find.
 * @param $directory
 *   The subdirectory name in which the files are found.  For example,
 *   'modules' will search in both modules/ and
 *   sites/somesite/modules/.
 * @param $key
 *   The key to be passed to file_scan_directory().
584
585
 * @param $min_depth
 *   Minimum depth of directories to return files from.
Dries's avatar
Dries committed
586
587
588
589
 *
 * @return
 *   An array of file objects of the specified type.
 */
590
function system_listing($mask, $directory, $key = 'name', $min_depth = 1) {
Dries's avatar
Dries committed
591
592
593
594
595
596
597
598
599
600
  $config = conf_init();
  $searchdir = array($directory);
  $files = array();

  if (file_exists("$config/$directory")) {
    $searchdir[] = "$config/$directory";
  }

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

  return $files;
Dries's avatar
   
Dries committed
605
606
607
}

/**
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
 * Assign an initial, default set of blocks for a theme.
 *
 * This function is called the first time a new theme is enabled.  The new theme
 * gets a copy of the default theme's blocks, with the difference that if a
 * particular region isn't available in the new theme, the block is assigned
 * to the new theme's default region.
 *
 * @param $theme
 *   The name of a theme.
 */
function system_initialize_theme_blocks($theme) {
  // Initialize theme's blocks if none already registered.
  if (!(db_num_rows(db_query("SELECT module FROM {blocks} WHERE theme = '%s'", $theme)))) {
    $default_theme = variable_get('theme_default', 'bluemarine');
    $regions = system_region_list($theme);
    $result = db_query("SELECT * FROM {blocks} WHERE theme = '%s'", $default_theme);
    while($block = db_fetch_array($result)) {
      // If the region isn't supported by the theme, assign the block to the theme's default region.
      if (!array_key_exists($block['region'], $regions)) {
        $block['region'] = system_default_region($theme);
      }
      db_query("INSERT INTO {blocks} (module, delta, theme, status, weight, region, visibility, pages, custom, throttle) VALUES ('%s', '%s', '%s', %d, %d, '%s', %d, '%s', %d, %d)",
          $block['module'], $block['delta'], $theme, $block['status'], $block['weight'], $block['region'], $block['visibility'], $block['pages'], $block['custom'], $block['throttle']);
    }
  }
}

// Add the submit / reset buttons and run drupal_get_form()
function system_settings_form($form_id, $form) {
  $form['buttons']['submit'] = array(type => 'submit', value => t('Save configuration') );
  $form['buttons']['reset'] = array(type => 'submit', value => t('Reset to defaults') );

640
641
642
643
  if (!empty($_POST) && form_get_errors()) {
    drupal_set_message(t('Your settings are not saved because of the errors above'), 'error');
  }

644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
  return drupal_get_form($form_id, $form, 'system_settings_form');
}

/**
 * Execute the system_settings_form.
 *
 * Due to specific handling of checkboxes, this function does not handle 'tree' based forms.
 */
function system_settings_form_execute($form_id, $values) {
  $op = isset($_POST['op']) ? $_POST['op'] : '';

  foreach ($values as $key => $value) {
    if ($op == t('Reset to defaults')) {
      variable_del($key);
    }
    else {
      if (is_array($value)) {
        $value = array_keys(array_filter($value));
      }
      variable_set($key, $value);
    }
  }
  if ($op == t('Reset to defaults')) {
    drupal_set_message(t('The configuration options have been reset to their default values.'));
  } else {
    drupal_set_message(t('The configuration options have been saved.'));
  }
}

/**
 * Do the clean url validation, changing the form property if it doesn't work.
Dries's avatar
   
Dries committed
675
 */
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
function system_settings_validate($form_id, &$form) {
 #TODO .. fix here.
 if ($edit['clean_url'] && !variable_get('clean_url_ok', 0)) {
   drupal_set_message(t('It appears your host is not configured correctly for Clean URLs. Please check for <code>ModRewrite</code> support with your administrator.'), 'error');
   $edit['clean_url'] = 0;
 }

}




/**
 * Menu callback; displays a listing of all themes.
 */
function system_themes() {
Dries's avatar
Dries committed
692
  $themes = system_theme_data();
Dries's avatar
   
Dries committed
693
694
  ksort($themes);

Dries's avatar
   
Dries committed
695
  foreach ($themes as $info) {
Dries's avatar
Dries committed
696
    $info->screenshot = dirname($info->filename) . '/screenshot.png';
697
    $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');
Dries's avatar
   
Dries committed
698

699
700
701
702
703
704
    $form[$info->name]['screenshot'] = array(type => 'markup', value => $screenshot);
    $form[$info->name]['description'] = array(type => 'item', title => $info->name,  value => dirname($info->filename));
    $options[$info->name] = '';
    if ($info->status) {
      $status[] = $info->name;
    }
705
    if ($info->status && (function_exists($info->prefix . '_settings') || function_exists($info->prefix . '_features'))) {
706
      $form[$info->name]['operations'] = array(type => 'markup', value => l(t('configure'), 'admin/themes/settings/' . $info->name) );
Dries's avatar
   
Dries committed
707
708
    }
    else {
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
      // Dummy element for form_render. Cleaner than adding a check in the theme function.
      $form[$info->name]['operations'] = array();
    }
  }

  $form['status'] = array(type => 'checkboxes', options => $options, default_value => $status);
  $form['theme_default'] = array(type => 'radios', options => $options, default_value => variable_get('theme_default', 'bluemarine'));
  $form['buttons']['submit'] = array(type => 'submit', value => t('Save configuration') );
  $form['buttons']['reset'] = array(type => 'submit', value => t('Reset to defaults') );

  return drupal_get_form('system_themes', $form);
}

function theme_system_themes($form) {
  foreach (element_children($form) as $key) {
    $row = array();
    if (is_array($form[$key]['description'])) {
      $row[] = form_render($form[$key]['screenshot']);
      $row[] = form_render($form[$key]['description']);
      $row[] = array('data' => form_render($form['status'][$key]), 'align' => 'center');
      if ($form['theme_default']) {
        $row[] = array('data' => form_render($form['theme_default'][$key]), 'align' => 'center');
        $row[] = array('data' => form_render($form[$key]['operations']), 'align' => 'center');
      }
Dries's avatar
   
Dries committed
733
734
735
736
737
    }
    $rows[] = $row;
  }

  $header = array(t('Screenshot'), t('Name'), t('Enabled'), t('Default'), t('Operations'));
738
739
  $output = theme('table', $header, $rows);
  $output .= form_render($form);
Dries's avatar
   
Dries committed
740
741
742
  return $output;
}

743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765

function system_themes_execute($form_id, $values) {

  db_query("UPDATE {system} SET status = 0 WHERE type = 'theme'");

  if ($_POST['op'] == t('Save configuration')) {
    variable_set('theme_default', $values['theme_default']);
    if (is_array($values['status'])) {
      foreach ($values['status'] as $key => $choice) {
        if ($choice) {
          db_query("UPDATE {system} SET status = 1 WHERE type = 'theme' and name = '%s'", $key);
        }
      }
    }
  }
  else {
    variable_del('theme_default');
  }

  drupal_set_message(t('The configuration options have been saved.'));
  drupal_goto('admin/themes');
}

Dries's avatar
   
Dries committed
766
/**
767
 * Menu callback; displays a listing of all modules.
Dries's avatar
   
Dries committed
768
 */
769
function system_modules() {
Dries's avatar
   
Dries committed
770
  // Get current list of modules
771
  $files = system_listing('\.module$', 'modules', 'name', 0);
Dries's avatar
   
Dries committed
772
773
774
775
776
777

  // Extract current files from database.
  system_get_files_database($files, 'module');

  ksort($files);

Dries's avatar
   
Dries committed
778
  foreach ($files as $filename => $file) {
Dries's avatar
Dries committed
779
780
781
782
    drupal_get_filename('module', $file->name, $file->filename);
    drupal_load('module', $file->name);

    $file->description = module_invoke($file->name, 'help', 'admin/modules#description');
Dries's avatar
   
Dries committed
783

784
785
786
787
788
789
790
791
792
793
    $form['name'][$file->name] = array(value => $file->name);
    $form['description'][$file->name] = array(value => $file->description);
    $options[$file->name] = '';
    if ($file->status) {
      $status[] = $file->name;
    }
    if ($file->throttle) {
      $throttle[] = $file->name;
    }

Dries's avatar
   
Dries committed
794
795
796
797
798
799
    // log the critical hooks implemented by this module
    $bootstrap = 0;
    foreach (bootstrap_hooks() as $hook) {
      if (module_hook($file->name, $hook)) {
        $bootstrap = 1;
        break;
Dries's avatar
   
Dries committed
800
      }
801
802
    }

Dries's avatar
   
Dries committed
803
    // Update the contents of the system table:
Dries's avatar
Dries committed
804
805
    db_query("DELETE FROM {system} WHERE name = '%s' AND type = '%s'", $file->name, 'module');
    db_query("INSERT INTO {system} (name, description, type, filename, status, throttle, bootstrap) VALUES ('%s', '%s', '%s', '%s', %d, %d, %d)", $file->name, $file->description, 'module', $file->filename, $file->status, $file->throttle, $bootstrap);
806
  }
Dries's avatar
   
Dries committed
807

Dries's avatar
   
Dries committed
808

809
810
811
812
813
814
815
816
  /**
   * Handle status checkboxes, including overriding the generated checkboxes for required modules.
   */
   $form['status'] = array(type => 'checkboxes', default_value => $status, options => $options, tree => TRUE);
  $required = array('block', 'filter', 'system', 'user', 'watchdog');
  foreach ($required as $require) {
    $form['status'][$require] = array(type => 'hidden', value => 1, suffix => t('required'));
  }
Dries's avatar
Dries committed
817

818
819
820
821
822
823
824
825
  /**
   * Handle throttle checkboxes, including overriding the generated checkboxes for required modules.
   */
  if (module_exist('throttle')) {
    $form['throttle'] = array(type => 'checkboxes', default_value => $throttle, options => $options, tree => TRUE);
    $throttle_required = array_merge($required, array('throttle'));
    foreach ($throttle_required as $require) {
      $form['throttle'][$require] = array(type => 'hidden', value => 1, suffix => t('required'));
826
    }
827
  }
828

829
  $form['buttons']['submit'] = array(type => 'submit', value => t('Save configuration'));
830

831
  return drupal_get_form('system_modules', $form);
832
}
833
834
835
836
837
838
839
840
841
842

function theme_system_modules($form) {
  foreach (element_children($form['name']) as $key) {
    $row = array();
    $row[] = form_render($form['name'][$key]);
    $row[] = form_render($form['description'][$key]);
    $row[] = array('data' => form_render($form['status'][$key]), 'align' => 'center');

    if (module_exist('throttle')) {
      $row[] = array('data' => form_render($form['throttle'][$key]), 'align' => 'center');
843
    }
844
    $rows[] = $row;
845
  }
846

847
848
849
850
  $header = array(t('Name'), t('Description'), t('Enabled'));
  if (module_exist('throttle')) {
    $header[] = t('Throttle');
  }
851

852
853
854
  $output = theme('table', $header, $rows);
  $output .= form_render($form);
  return $output;
855
856
}

Dries's avatar
   
Dries committed
857

858
859
860
861
862
863
function system_modules_execute($form_id, $edit) {
  db_query("update {system} set status = 0, throttle = 0 where type = 'module'");

  foreach ($edit['status'] as $key => $choice) {
    if ($choice) {
      db_query("update {system} set status = 1 where type = 'module' and name = '%s'", $key);
864
865
    }
  }
866
867
868
869
870

  if (is_array($edit['throttle'])) {
    foreach ($edit['throttle'] as $key => $choice) {
      if ($choice) {
        db_query("UPDATE {system} SET throttle = 1 WHERE type = 'module' and name = '%s'", $key);
Dries's avatar
   
Dries committed
871
      }
Dries's avatar
   
Dries committed
872
    }
873
874
  }

875
876
877
  menu_rebuild();
  drupal_set_message(t('The configuration options have been saved.'));
  drupal_goto('admin/modules');
Dries's avatar
   
Dries committed
878
879
880
}


881
/**
Dries's avatar
   
Dries committed
882
 * Menu callback; displays a module's settings page.
883
 */
Dries's avatar
   
Dries committed
884
function system_site_settings($module = NULL) {
885

Dries's avatar
   
Dries committed
886
887
888
889
890
  if ($module) {
    $form = module_invoke($module, 'settings');
  }
  else {
    $form = system_view_general();
891
    $module = 'system';
892
893
  }

894
  return system_settings_form($module . '_settings_form', $form);
895
896
}

Dries's avatar
   
Dries committed
897
/**
Dries's avatar
   
Dries committed
898
 * Menu callback; display theme configuration for entire site and individual themes.
Dries's avatar
   
Dries committed
899
 */
Dries's avatar
   
Dries committed
900
function system_theme_settings($key = '') {
901
902
903
  $directory_path = variable_get('file_directory_path', 'files');
  file_check_directory($directory_path, FILE_CREATE_DIRECTORY, 'file_directory_path');

Dries's avatar
   
Dries committed
904
  // Default settings are defined in theme_get_settings() in includes/theme.inc
Dries's avatar
   
Dries committed
905
  if ($key) {
906
    $settings = theme_get_settings($key);
Dries's avatar
   
Dries committed
907
    $var = str_replace('/', '_', 'theme_'. $key .'_settings');
Dries's avatar
Dries committed
908
909
    $themes = system_theme_data();
    $features = function_exists($themes[$key]->prefix . '_features') ? call_user_func($themes[$key]->prefix . '_features') : array();
Dries's avatar
   
Dries committed
910
911
  }
  else {
912
    $settings = theme_get_settings('');
Dries's avatar
   
Dries committed
913
914
915
    $var = 'theme_settings';
  }

916
917
  $form['var'] = array(type => 'hidden', value => $var);

Dries's avatar
   
Dries committed
918
919
  // Check for a new uploaded logo, and use that instead.
  if ($file = file_check_upload('logo_upload')) {
920
    if ($info = image_get_info($file->filepath)) {
Dries's avatar
   
Dries committed
921
922
923
924
      $parts = pathinfo($file->filename);
      $filename = ($key) ? str_replace('/', '_', $key) . '_logo.' . $parts['extension'] : 'logo.' . $parts['extension'];

      if ($file = file_save_upload('logo_upload', $filename, 1)) {
925
926
        $_POST['edit']['default_logo'] = 0;
        $_POST['edit']['logo_path'] = $file->filepath;
Dries's avatar
   
Dries committed
927
928
929
930
931
932
933
      }
    }
    else {
      form_set_error('file_upload', t('Only JPEG, PNG and GIF images are allowed to be used as logos.'));
    }
  }

934
935
936
937
938
939
  // Check for a new uploaded favicon, and use that instead.
  if ($file = file_check_upload('favicon_upload')) {
    $parts = pathinfo($file->filename);
    $filename = ($key) ? str_replace('/', '_', $key) . '_favicon.' . $parts['extension'] : 'favicon.' . $parts['extension'];

    if ($file = file_save_upload('favicon_upload', $filename, 1)) {
940
941
      $_POST['edit']['default_favicon'] = 0;
      $_POST['edit']['favicon_path'] = $file->filepath;
942
943
    }
  }
Dries's avatar
   
Dries committed
944

Dries's avatar
   
Dries committed
945
946
947

  // Logo settings
  if ((!$key) || in_array('logo', $features)) {
948
949
950
951
952
953
954
955
956
957
958
959
960
    $form['logo'] = array(type => 'fieldset', title => t('Logo image settings'));
    $form['logo']["default_logo"] = array(
      type => 'checkbox', title => t('Use the default logo'), default_value => $settings['default_logo'], tree => FALSE,
      description => t('Check here if you want the theme to use the logo supplied with it.')
    );
    $form['logo']['logo_path'] = array(
      type => 'textfield', title => t('Path to custom logo'), size => 60, maxlength => 128,
      description => t('The path to the file you would like to use as your logo file instead of the default logo.'));

    $form['logo']['logo_upload'] = array(
      type => 'file', title => t('Upload logo image'), maxlength => 40,
      description => t("If you don't have direct file access to the server, use this field to upload your logo.")
    );
961
962
963
964
  }

  // Icon settings
  if ((!$key) || in_array('toggle_favicon', $features)) {
965
966
967
968
969
970
971
972
973
974
975
976
977
978
    $form['favicon'] = array(type => 'fieldset', title => t('Shortcut icon settings'));
    $form['favicon']['text'] = array(value => t('Your shortcut icon or \'favicon\' is displayed in the address bar and bookmarks of most browsers.'));
    $form['favicon']['default_favicon'] = array(
      type => 'checkbox', title => t('Use the default shortcut icon.'), default_value => $settings['default_favicon'],
      description => t('Check here if you want the theme to use the default shortcut icon.')
    );
    $form['favicon']['favicon_path'] = array(
      type => 'textfield', title => t('Path to custom icon'), default_value =>  $settings['favicon_path'],
      description => t('The path to the image file you would like to use as your custom shortcut icon.')
    );

    $form['favicon']['favicon_upload'] = array(
      type => 'file', title => t('Upload icon image'), description => t("If you don't have direct file access to the server, use this field to upload your shortcut icon.")
    );
Dries's avatar
   
Dries committed
979
980
981
982
983
  }

  // System wide only settings.
  if (!$key) {
    // Menu settings
984

985
986
    $form['primary_links'] = system_navigation_links_form('primary', 'Primary');
    $form['secondary_links'] = system_navigation_links_form('secondary', 'Secondary');
Dries's avatar
   
Dries committed
987
988

    // Toggle node display.
989
    $node_types = module_invoke('node', 'get_types');
990
    if ($node_types) {
991
      $group = '';
992
      $form['node_info'] = array(type => 'fieldset', title => t('Display post information on'), description =>  t('Enable or disable the "submitted by Username on date" text when displaying posts of the above type'));
993
      foreach ($node_types as $type => $name) {
994
        $form['node_info']["toggle_node_info_$type"] = array(type => 'checkbox', title => $name, default_value => $settings["toggle_node_info_$type"]);
995
      }
Dries's avatar
   
Dries committed
996
997
998
999
1000
1001
    }
  }

  $group = '';

  // Toggle settings
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
  $toggles = array(
    'toggle_name'                 => t('Site name'),
    'toggle_slogan'               => t('Site slogan'),
    'toggle_mission'              => t('Mission statement'),
    'toggle_primary_links'        => t('Primary links'),
    'toggle_secondary_links'      => t('Secondary links'),
    'toggle_node_user_picture'    => t('User pictures in posts'),
    'toggle_comment_user_picture' => t('User pictures in comments'),
    'toggle_search'               => t('Search box'),
    'toggle_favicon'              => t('Shortcut icon')
  );

Dries's avatar
Dries committed
1014
  // Some features are not always available
1015
1016
1017
1018
1019
1020
1021
1022
  $disabled = array();
  if (!variable_get('user_pictures', 0)) {
    $disabled['toggle_node_user_picture'] = true;
    $disabled['toggle_comment_user_picture'] = true;
  }
  if (!module_exist('search')) {
    $disabled['toggle_search'] = true;
  }
Dries's avatar
   
Dries committed
1023

1024
  $form['toggles'] = array(type => 'fieldset', title => t('Toggle display'), description => t('Enable or disable the display of certain page elements.'));
Dries's avatar
   
Dries committed
1025
1026
  foreach ($toggles as $name => $title) {
    if ((!$key) || in_array($name, $features)) {
Dries's avatar
   
Dries committed
1027
      // disable search box if search.module is disabled
1028
      $form['toggles'][$name] = array(type => 'checkbox', title => $title, default_value => $settings[$name], attributes =>  isset($disabled[$name]) ? array('disabled' => 'disabled') : NULL);
Dries's avatar
   
Dries committed
1029
1030
1031
1032
1033
    }
  }

  if ($key) {
    // Template-specific settings
Dries's avatar
   
Dries committed
1034
    $function = $themes[$key]->prefix .'_settings';
Dries's avatar
   
Dries committed
1035
    if (function_exists($function)) {
Dries's avatar
   
Dries committed
1036
1037
      if ($themes[$key]->template) {
        // file is a template or a style of a template
1038
        $form['specific'] = array(type => 'fieldset', title => t('Engine-specific settings'), description => t('These settings only exist for all the templates and styles based on the %engine theme engine.', array('%engine' => $themes[$key]->prefix)));
Dries's avatar
   
Dries committed
1039
1040
      }
      else {
Dries's avatar
   
Dries committed
1041
        // file is a theme or a style of a theme
1042
        $form['specific'] = array(type => 'fieldset', title => t('Theme-specific settings'), description => t('These settings only exist for the %theme theme and all the styles based on it.', array('%theme' => $themes[$key]->prefix)));
Dries's avatar
   
Dries committed
1043
      }
1044
1045
      $group = $function();
      $form['specific'] = array_merge($form['specific'], (is_array($group) ? $group : array()));
Dries's avatar
   
Dries committed
1046
    }
Dries's avatar
   
Dries committed
1047
  }
1048
  $form[attributes] = array('enctype' => 'multipart/form-data');
Dries's avatar
   
Dries committed
1049

1050
  return system_settings_form('system_theme_settings', $form);
Dries's avatar
   
Dries committed
1051

Dries's avatar
 
Dries committed
1052
}
Dries's avatar
   
Dries committed
1053

1054
1055
1056
function system_navigation_links_form($type, $utype) {
  $settings = theme_get_settings('');
  $value = $settings[$type . '_links'];
1057

1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
  if (!is_array($value)) {
    $value = array();
  }
  // Increment the link count, if the user has requested more links.
  if (variable_get($type . '_links_more', false)) {
    variable_del($type . '_links_more');
    variable_set($type . '_link_count', variable_get($type . '_link_count', 5) + 5);
  }

  // Get the amount of links to show, possibly expanding if there are more links defined than the count specifies.
  $count = variable_get($type . '_link_count', 5);
  $count = ($count > sizeof($value['link'])) ? $count : sizeof($value['link']);

  if (variable_get($type . '_link_count', 5) != $count) {
    variable_set($type . '_link_count', $count);
  }
  $form = array(
    type => 'item', title => t('_TYPE_ link settings', array('_TYPE_' => $utype)), theme => 'system_navigation_links_form',
    description => t('You can specify your _TYPE_ links here, one link per line.<br /> The link text field is the text you want to link.<br /> The url field is the location the link points to.<br /> The description field is an optional description of where the link points.', array('_TYPE_' => $type))
  );

  $form[tree] = TRUE;

  for ($i = 0; $i < $count; $i++) {
    foreach (array('text', 'link', 'description') as $field) {
      $form[$field][$i] = array(type => 'textfield', default_value => $value[$field][$i], size => 15, maxlength => 90);
    }
  }

  $form[$type . '_links_more'] = array(
    type => 'checkbox', title => t('I need more _TYPE_ links.', array('_TYPE_' => $type)), default_value => FALSE,
    description => t('Checking this box will give you 5 additional _TYPE_ links.', array('_TYPE_' => $type))
  );
  return $form;
}

function theme_system_navigation_links_form(&$form) {
  $header = array(t('link text'), t('url'), t('description'));
  foreach (element_children($form['text']) as $key) {
    $row = array();
    $row[] = form_render($form['text'][$key]);
    $row[] = form_render($form['link'][$key]);
    $row[] = form_render($form['description'][$key]);
    $rows[] = $row;

  }
  $output = theme('table', $header, $rows);
  $output .= form_render($form);
  return $output;
}


function search_box() {
  $form[action] = url('search');
  $form['keys'] = array(type => 'textfield', size=> 15, value => '', attributes => array('alt' => t('Enter the terms you wish to search for.'), 'class' => 'form-text'));
  $form['submit'] = array(type => 'submit', value => t('search'));
  return drupal_get_form('search_box', $form);
}

function theme_search_box($form) {
  $output = '<div id="search">';
  $output .= form_render($form);
  $output .= '</div>';
  return $output;
}

/**
 * Output a confirmation form
 *
 * This function outputs a complete form for confirming an action. A link is
 * offered to go back to the item that is being changed in case the user changes
 * his/her mind.
 *
 * You should use $GLOBALS['values']['edit'][$name] (where $name is usually 'confirm') to
 * check if the confirmation was successful.
 *
 * @param $form_id
 *   The unique form identifier. Used by the form API to construct the theme.
 * @param $form
 *   Additional elements to inject into the form, for example hidden elements.
 * @param $question
 *   The question to ask the user (e.g. "Are you sure you want to delete the
 *   block <em>foo</em>?").
 * @param $path
 *   The page to go to if the user denies the action.
 * @param $description
 *   Additional text to display (defaults to "This action cannot be undone.").
 * @param $yes
 *   A caption for the button which confirms the action (e.g. "Delete",
 *   "Replace", ...).
 * @param $no
 *   A caption for the link which denies the action (e.g. "Cancel").
 * @param $name
 *   The internal name used to refer to the confirmation item.
 * @return