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

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

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

15
  switch ($section) {
16
    case 'admin/settings':
Dries Buytaert's avatar
   
Dries Buytaert committed
17
18
      return t('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.');
    case 'admin/themes':
Dries Buytaert's avatar
   
Dries Buytaert committed
19
20
21
22
23
24
      return t('Select which themes are available to your users and specify the default theme. To configure site-wide display settings, click the "configure" task above. Alternately, to override these settings in a specific theme, click the "configure" link for the corresponding theme.');
    case 'admin/themes/settings':
      return t('These options control the default display settings for your entire site, across all themes. Unless they have been overridden by a specific theme, these settings will be used.');
    case 'admin/themes/settings/'. arg(3):
      $theme = array_pop(explode('.', arg(3), 2));
      return t('These options control the display settings for the <code>%template</code> theme. When your site is displayed using this theme, these settings will be used. By clicking "Reset to defaults," you can choose to use the <a href="%global">global settings</a> for this theme.', array('%template' => $theme, '%global' => url('admin/themes/settings')));
Dries Buytaert's avatar
   
Dries Buytaert committed
25
    case 'admin/modules':
Dries Buytaert's avatar
   
Dries Buytaert committed
26
      return t("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.", array('%permissions' => url('admin/user/configure/permission'), '%throttle' => url('admin/settings/throttle')));
Dries Buytaert's avatar
   
Dries Buytaert committed
27
    case 'admin/help#system':
Dries Buytaert's avatar
   
Dries Buytaert committed
28
      return t("
Dries Buytaert's avatar
   
Dries Buytaert committed
29
30
31
      <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>
32
      <p>Whenever %cron-link is accessed, cron will run: it calls the _cron hook in each module allowing the module to run tasks if they have not been executed in the last <em>n</em> seconds, where n is the period of that task.  When all the tasks are finished, cron is done.</p>
Dries Buytaert's avatar
   
Dries Buytaert committed
33
34
35
36
      <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>
37
      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>
Dries Buytaert's avatar
   
Dries Buytaert committed
38
      <h3><a id=\"cache\">Cache</a></h3>
Dries Buytaert's avatar
   
Dries Buytaert committed
39
      <p>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 cached pages compressed.</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 Buytaert's avatar
   
Dries Buytaert committed
40
41
    case 'admin/modules#description':
      return t('Configuration system that lets administrators modify the workings of the site.');
42
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
43
44
}

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

Dries Buytaert's avatar
   
Dries Buytaert committed
52
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
53
 * Implementation of hook_menu().
Dries Buytaert's avatar
   
Dries Buytaert committed
54
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
55
function system_menu($may_cache) {
Dries Buytaert's avatar
   
Dries Buytaert committed
56
  $items = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
57

Dries Buytaert's avatar
   
Dries Buytaert committed
58
59
60
61
62
63
  if ($may_cache) {
    $items[] = array('path' => 'system/files', 'title' => t('file download'),
      'callback' => 'file_download',
      'access' => TRUE,
      'type' => MENU_CALLBACK);

64
65
66
67
68
69
    // Clean URL tester
    $items[] = array('path' => 'system/test',
      'callback' => 'system_test',
      'access' => TRUE,
      'type' => MENU_CALLBACK);

Dries Buytaert's avatar
   
Dries Buytaert committed
70
71
72
73
74
75
    $access = user_access('administer site configuration');

    // Themes:
    $items[] = array('path' => 'admin/themes', 'title' => t('themes'),
      'callback' => 'system_themes', 'access' => $access);

Dries Buytaert's avatar
   
Dries Buytaert committed
76
    $items[] = array('path' => 'admin/themes/select', 'title' => t('list'),
Dries Buytaert's avatar
   
Dries Buytaert committed
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
      '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) {
       $theme_path = str_replace('/', '.', $theme->name);
       $items[] = array('path' => 'admin/themes/settings/'. $theme_path, 'title' => basename($theme->name),
       'callback' => 'system_theme_settings', 'access' => $access,
       '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 Buytaert's avatar
   
Dries Buytaert committed
103
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
104
105
    $items[] = array('path' => 'admin/modules', 'title' => t('modules'),
      'callback' => 'system_modules', 'access' => $access);
Dries Buytaert's avatar
   
Dries Buytaert committed
106
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
107
108

  return $items;
Dries Buytaert's avatar
 
Dries Buytaert committed
109
110
}

111
112
113
114
115
116
/**
 * Menu callback: dummy clean URL tester.
 */
function system_test() {
}

Dries Buytaert's avatar
   
Dries Buytaert committed
117
118
119
120
121
/**
 * Implementation of hook_user().
 *
 * Allows users to individually set their theme and time zone.
 */
122
123
function system_user($type, $edit, &$user, $category = NULL) {
  if ($type == 'form' && $category == 'account') {
124
125
126
127
128
129
130
131
132
133
    $allthemes = list_themes();

    // list only active themes
    foreach ($allthemes as $key => $theme) {
      if ($theme->status) {
        $themes[$key] = $theme;
      }
    }

    if (count($themes) > 1) {
Dries Buytaert's avatar
   
Dries Buytaert committed
134
      $rows = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
135
      foreach ($themes as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
136
137
138
139
        $row = array();

        // Screenshot column.
        $screenshot = dirname($value->filename) .'/screenshot.png';
140
        $row[] = file_exists($screenshot) ? theme('image', $screenshot, t('Screenshot for %theme theme', array('%theme' => $value->name)), '', 'class="screenshot"', false) : t('no screenshot');
Dries Buytaert's avatar
   
Dries Buytaert committed
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

        // Information field.
        $field = '<strong>'. basename($value->name) .'</strong>';
        $row[] = $field;

        // 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'] = '';
          }
        }

        // Selected column.
        $row[] = array('data' => form_radio('', 'theme', $key, ($edit['theme'] == $key) ? 1 : 0), 'align' => 'center');

        $rows[] = $row;
Dries Buytaert's avatar
   
Dries Buytaert committed
158
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
159
160
      $header = array(t('Screenshot'), t('Name'), t('Selected'));
      $data[] = array('title' => t('Theme settings'), 'data' => form_item('', theme('table', $header, $rows), t('Selecting a different theme will change the look and feel of the site.')), 'weight' => 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
161
    }
162

163
    if (variable_get('configurable_timezones', 1)) {
Steven Wittens's avatar
Steven Wittens committed
164
      $zones = _system_zonelist();
Steven Wittens's avatar
Steven Wittens committed
165
      $data[] = array('title' => t('Locale settings'), 'data' => form_select(t('Time zone'), 'timezone', strlen($edit['timezone']) ? $edit['timezone'] : variable_get('date_default_timezone', 0), $zones, t('Select your current local time. Dates and times throughout this site will be displayed using this time zone.')), 'weight' => 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
166
    }
167
    return $data;
Dries Buytaert's avatar
   
Dries Buytaert committed
168
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
169
170
}

Steven Wittens's avatar
Steven Wittens committed
171
172
173
174
175
176
177
178
179
180
181
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 Buytaert's avatar
   
Dries Buytaert committed
182
function system_view_general() {
Dries Buytaert's avatar
   
Dries Buytaert committed
183
  global $conf;
Dries Buytaert's avatar
   
Dries Buytaert committed
184

Dries Buytaert's avatar
 
Dries Buytaert committed
185
  // general settings:
Dries Buytaert's avatar
   
Dries Buytaert committed
186
187
188
189
190
191
192
  $group  = form_textfield(t('Name'), 'site_name', variable_get('site_name', 'drupal'), 70, 70, t('The name of this web site.'));
  $group .= form_textfield(t('E-mail address'), 'site_mail', variable_get('site_mail', ini_get('sendmail_from')), 70, 128, t('A valid e-mail address for this website, used by the auto-mailer during registration, new password requests, notifications, etc.'));
  $group .= form_textfield(t('Slogan'), 'site_slogan', variable_get('site_slogan', ''), 70, 128, t('The slogan of this website. Some themes display a slogan when available.'));
  $group .= form_textarea(t('Mission'), 'site_mission', variable_get('site_mission', ''), 70, 5, t('Your site\'s mission statement or focus.'));
  $group .= form_textarea(t('Footer message'), 'site_footer', variable_get('site_footer', ''), 70, 5, t('This text will be displayed at the bottom of each page.  Useful for adding a copyright notice to your pages.'));
  $group .= form_textfield(t('Anonymous user'), 'anonymous', variable_get('anonymous', 'Anonymous'), 70, 70, t('The name used to indicate anonymous users.'));
  $group .= form_textfield(t('Default front page'), 'site_frontpage', variable_get('site_frontpage', 'node'), 70, 70, 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".'));
193
194
195
196
197

  // check if clean URLs are supported (HTTP 200 = Ok)
  $request = drupal_http_request($GLOBALS['base_url'] . '/system/test');
  $supported = $request->code == 200;
  $group .= form_radios(t('Clean URLs'), 'clean_url', variable_get('clean_url', 0), array(t('Disabled'), t('Enabled')), 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.'), false, $supported ? NULL : array('disabled' => 'disabled'));
Dries Buytaert's avatar
   
Dries Buytaert committed
198

Dries Buytaert's avatar
   
Dries Buytaert committed
199
200
201
  $output = form_group(t('General settings'), $group);

  // error handling:
Dries Buytaert's avatar
   
Dries Buytaert committed
202
203
  $period = drupal_map_assoc(array(3600, 10800, 21600, 32400, 43200, 86400, 172800, 259200, 604800, 1209600, 2419200), 'format_interval');
  $period['1000000000'] = t('Never');
Dries Buytaert's avatar
   
Dries Buytaert committed
204
205
  $group = form_textfield(t('Default 403 (access denied) page'), 'site_403', variable_get('site_403', ''), 70, 70, 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.'));
  $group .= form_textfield(t('Default 404 (not found) page'), 'site_404', variable_get('site_404', ''), 70, 70, 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.'));
Steven Wittens's avatar
Steven Wittens committed
206
  $group .= form_select(t('Error reporting'), 'error_level', variable_get('error_level', 1), array(t('Write errors to the log'), t('Write errors to the log and to the screen')), 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 Buytaert's avatar
   
Dries Buytaert committed
207
  $group .= form_select(t('Discard log entries older than'), 'watchdog_clear', variable_get('watchdog_clear', 604800), $period, t('The time log entries should be kept.  Older entries will be automatically discarded.  Requires crontab.'));
Dries Buytaert's avatar
   
Dries Buytaert committed
208

Dries Buytaert's avatar
   
Dries Buytaert committed
209
  $output .= form_group(t('Error handling'), $group);
Dries Buytaert's avatar
 
Dries Buytaert committed
210

Dries Buytaert's avatar
   
Dries Buytaert committed
211
  // caching:
Dries Buytaert's avatar
   
Dries Buytaert committed
212
  $group  = form_radios(t('Cache support'), 'cache', variable_get('cache', 0), array(t('Disabled'), t('Enabled')), t('Enable or disable the caching of rendered pages.  When caching is enabled, Drupal will flush the cache when required to make sure updates take effect immediately.  Check the <a href="%documentation">cache documentation</a> for information on Drupal\'s cache system.', array('%documentation' => url('admin/help', NULL, NULL, 'cache'))));
Dries Buytaert's avatar
   
Dries Buytaert committed
213

Dries Buytaert's avatar
   
Dries Buytaert committed
214
  $output .= form_group(t('Cache settings'), $group);
Dries Buytaert's avatar
   
Dries Buytaert committed
215

Dries Buytaert's avatar
   
Dries Buytaert committed
216
  // file system:
Dries Buytaert's avatar
   
Dries Buytaert committed
217
  $directory_path = variable_get('file_directory_path', 'files');
Dries Buytaert's avatar
   
Dries Buytaert committed
218
  file_check_directory($directory_path, FILE_CREATE_DIRECTORY, 'file_directory_path');
Dries Buytaert's avatar
   
Dries Buytaert committed
219

Steven Wittens's avatar
Steven Wittens committed
220
  $directory_temp = variable_get('file_directory_temp', FILE_DIRECTORY_TEMP);
Dries Buytaert's avatar
   
Dries Buytaert committed
221
  file_check_directory(file_create_path($directory_temp), FILE_CREATE_DIRECTORY, 'file_directory_temp');
Dries Buytaert's avatar
   
Dries Buytaert committed
222
223

  $group = form_textfield(t('File system path'), 'file_directory_path', $directory_path, 70, 255, 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
224
  $group .= form_textfield(t('Temporary directory'), 'file_directory_temp', $directory_temp, 70, 255, t('Location where uploaded files will be kept during previews. Relative paths will be resolved relative to the file system path.'));
225
  $group .= form_radios(t('Download method'), 'file_downloads', variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC), array(FILE_DOWNLOADS_PUBLIC => t('Public - files are available using http directly.'), FILE_DOWNLOADS_PRIVATE => t('Private - files are transferred by Drupal.')), 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 Buytaert's avatar
   
Dries Buytaert committed
226
  $output .= form_group(t('File system settings'), $group);
Dries Buytaert's avatar
   
Dries Buytaert committed
227

Dries Buytaert's avatar
   
Dries Buytaert committed
228
  // date settings:
Steven Wittens's avatar
Steven Wittens committed
229
  $zones = _system_zonelist();
230

Dries Buytaert's avatar
   
Dries Buytaert committed
231
  // date settings: possible date formats
Dries Buytaert's avatar
   
Dries Buytaert committed
232
  $dateshort = array('Y-m-d H:i','m/d/Y - H:i', 'd/m/Y - H:i', 'Y/m/d - H:i',
Dries Buytaert's avatar
   
Dries Buytaert committed
233
234
235
           '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 Buytaert's avatar
   
Dries Buytaert committed
236
237
  $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 Buytaert's avatar
   
Dries Buytaert committed
238
239
240
241
          '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 Buytaert's avatar
   
Dries Buytaert committed
242
243
244

  // date settings: construct choices for user
  foreach ($dateshort as $f) {
Dries Buytaert's avatar
   
Dries Buytaert committed
245
    $dateshortchoices[$f] = format_date(time(), 'custom', $f);
Dries Buytaert's avatar
   
Dries Buytaert committed
246
247
  }
  foreach ($datemedium as $f) {
Dries Buytaert's avatar
   
Dries Buytaert committed
248
    $datemediumchoices[$f] = format_date(time(), 'custom', $f);
Dries Buytaert's avatar
   
Dries Buytaert committed
249
250
  }
  foreach ($datelong as $f) {
Dries Buytaert's avatar
   
Dries Buytaert committed
251
    $datelongchoices[$f] = format_date(time(), 'custom', $f);
Dries Buytaert's avatar
   
Dries Buytaert committed
252
253
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
254
255
256
257
258
  $group  = form_select(t('Default time zone'), 'date_default_timezone', variable_get('date_default_timezone', 0), $zones, t('Select the default site time zone.'));
  $group .= form_radios(t('Configurable time zones'), 'configurable_timezones', variable_get('configurable_timezones', 1), array(t('Disabled'), t('Enabled')), t('Enable or disable user-configurable time zones.  When enabled, users can set their own time zone and dates will be updated accordingly.'));
  $group .= form_select(t('Short date format'), 'date_format_short', variable_get('date_format_short', $dateshort[0]), $dateshortchoices, t('The short format of date display.'));
  $group .= form_select(t('Medium date format'), 'date_format_medium', variable_get('date_format_medium', $datemedium[0]), $datemediumchoices, t('The medium sized date display.'));
  $group .= form_select(t('Long date format'), 'date_format_long', variable_get('date_format_long', $datelong[0]), $datelongchoices, t('Longer date format used for detailed display.'));
259
  $group .= form_select(t('First day of week'), 'date_first_day', variable_get('date_first_day', 0), array(0 => t('Sunday'), 1 => t('Monday'), 2 => t('Tuesday'), 3 => t('Wednesday'), 4 => t('Thursday'), 5 => t('Friday'), 6 => t('Saturday')), t('The first day of the week for calendar views.'));
Dries Buytaert's avatar
   
Dries Buytaert committed
260

Dries Buytaert's avatar
   
Dries Buytaert committed
261
  $output .= form_group(t('Date settings'), $group);
Dries Buytaert's avatar
 
Dries Buytaert committed
262

Dries Buytaert's avatar
   
Dries Buytaert committed
263
264
265
  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
266
267
268
269
/**
 * Retrieves the current status of an array of files in the system table.
 */
function system_get_files_database(&$files, $type) {
Dries Buytaert's avatar
   
Dries Buytaert committed
270
  // Extract current files from database.
271
  $result = db_query("SELECT name, type, status, throttle FROM {system} WHERE type = '%s'", $type);
Dries Buytaert's avatar
   
Dries Buytaert committed
272
  while ($file = db_fetch_object($result)) {
273
    if (is_object($files[$file->name])) {
Dries Buytaert's avatar
   
Dries Buytaert committed
274
      foreach ($file as $key => $value) {
275
276
277
        if (!$files[$file->name]->$key) {
          $files[$file->name]->$key = $value;
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
278
      }
279
    }
Dries Buytaert's avatar
 
Dries Buytaert committed
280
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
281
}
Dries Buytaert's avatar
 
Dries Buytaert committed
282

Dries Buytaert's avatar
   
Dries Buytaert committed
283
284
285
/**
 * Collect data about all currently available themes
 */
286
287
288
289
function system_theme_data() {
  // Find themes
  $themes = system_listing('\.theme$', 'themes');

Dries Buytaert's avatar
   
Dries Buytaert committed
290
  // Find theme engines
291
292
293
294
295
296
297
298
299
300
  $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]->description = dirname($themes[$key]->filename);
    $themes[$key]->owner = $themes[$key]->filename;
    $themes[$key]->prefix = $key;
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
301

302
303
  // Remove all theme engines from the system table
  db_query("DELETE FROM {system} WHERE type = 'theme_engine'");
Dries Buytaert's avatar
   
Dries Buytaert committed
304
305

  foreach ($engines as $engine) {
Dries Buytaert's avatar
   
Dries Buytaert committed
306
    // Insert theme engine into system table
307
308
309
310
    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 Buytaert's avatar
   
Dries Buytaert committed
311
    // Add templates to the site listing
312
313
314
315
316
317
318
    foreach (call_user_func($engine->name . '_templates') as $template) {
      $template->template = TRUE;
      $template->name = basename(dirname($template->filename));
      $template->basename = $template->name;
      $template->description = dirname($template->filename);
      $template->owner = $engine->filename;
      $template->prefix = $engine->name;
Dries Buytaert's avatar
   
Dries Buytaert committed
319
320
321
322
323
324
      // do not double-insert templates with theme files in their directory
      foreach ($themes as $theme) {
        if (dirname($template->filename) == dirname($theme->filename)) {
          continue 2;
        }
      }
325
      $themes[$template->name] = $template;
Dries Buytaert's avatar
   
Dries Buytaert committed
326
327
328
329
    }
  }

  // Find styles in each theme's directory.
330
331
  foreach ($themes as $theme) {
    foreach (file_scan_directory(dirname($theme->filename), 'style.css$') as $style) {
Dries Buytaert's avatar
   
Dries Buytaert committed
332
      // do not double-insert themes with css files in their directory
333
334
      if (dirname($style->filename) != dirname($theme->filename)) {
        $style->style = TRUE;
Dries Buytaert's avatar
   
Dries Buytaert committed
335
        $style->template = $theme->template;
336
337
338
        $style->name = basename(dirname($style->filename));
        $style->description = dirname($style->filename);
        $style->owner = $theme->filename;
Dries Buytaert's avatar
   
Dries Buytaert committed
339
        $style->prefix = $theme->template ? $theme->prefix : $theme->name;
340
        $themes[$style->name] = $style;
Dries Buytaert's avatar
   
Dries Buytaert committed
341
342
      }
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
343
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
344
345

  // Extract current files from database.
346
347
348
  system_get_files_database($themes, 'theme');

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

350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
  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;
}

/**
 * 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().
 *
 * @return
 *   An array of file objects of the specified type.
 */
function system_listing($mask, $directory, $key = 'name') {
  $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) {
    $files = array_merge($files, file_scan_directory($dir, $mask, array('.', '..', 'CVS'), 0, TRUE, $key));
  }

  return $files;
Dries Buytaert's avatar
   
Dries Buytaert committed
393
394
395
396
397
398
}

/**
 * Generate a list of all the available theme/style combinations.
 */
function system_theme_listing() {
399
  $themes = system_theme_data();
Dries Buytaert's avatar
   
Dries Buytaert committed
400
401
  ksort($themes);

402
403
  foreach ($themes as $name => $info) {
    $info->screenshot = dirname($info->filename) . '/screenshot.png';
Dries Buytaert's avatar
   
Dries Buytaert committed
404
405
406
    $row = array();

    // Screenshot column.
407
    $row[] = file_exists($info->screenshot) ? theme('image', $info->screenshot, t('Screenshot for %theme theme', array('%theme' => $info->name)), '', 'class="screenshot"', false) : t('no screenshot');
Dries Buytaert's avatar
   
Dries Buytaert committed
408
409

    // Information field.
410
    $row[] = "<strong>$info->name</strong><br /><em>$info->description</em>";
Dries Buytaert's avatar
   
Dries Buytaert committed
411
412

    // enabled, default, and operations columns
413
414
415
416
    $row[] = array('data' => form_checkbox('', 'status]['. $info->name, 1, $info->status), 'align' => 'center');
    $row[] = array('data' => form_radio('', 'theme_default', $info->name, (variable_get('theme_default', 'bluemarine') == $name) ? 1 : 0), 'align' => 'center');
    if (function_exists($info->prefix . '_settings') || function_exists($info->prefix . '_features')) {
      $row[] = array('data' => l(t('configure'), 'admin/themes/settings/' . str_replace('/', '.', preg_replace('<^.*themes/(.*)$>', '$1', $info->description))), 'align' => 'center');
Dries Buytaert's avatar
   
Dries Buytaert committed
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
    }
    else {
      $row[] = '';
    }
    $rows[] = $row;
  }

  $header = array(t('Screenshot'), t('Name'), t('Enabled'), t('Default'), t('Operations'));
  $output = form_hidden('type', 'theme');
  $output .= theme('table', $header, $rows);
  return $output;
}

/**
 * Generate a list of all the available modules, as well as update the system list.
 */
function system_module_listing() {
  // Get current list of modules
435
  $files = system_listing('\.module$', 'modules');
Dries Buytaert's avatar
   
Dries Buytaert committed
436
437
438
439
440
441

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

  ksort($files);

442
443
  $required = array('admin', 'block', 'filter', 'system', 'user', 'watchdog');
  $throttle_required = array_merge($required, array('throttle'));
Dries Buytaert's avatar
   
Dries Buytaert committed
444

Dries Buytaert's avatar
   
Dries Buytaert committed
445
446
447
448
  $header = array(t('Name'), t('Description'), t('Enabled'));
  if (module_exist('throttle')) {
    $header[] = t('Throttle');
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
449
450

  foreach ($files as $filename => $file) {
451
452
453
454
    drupal_get_filename('module', $file->name, $file->filename);
    drupal_load('module', $file->name);

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

Dries Buytaert's avatar
   
Dries Buytaert committed
456
457
458
459
460
461
    // 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 Buytaert's avatar
   
Dries Buytaert committed
462
      }
463
464
    }

Dries Buytaert's avatar
   
Dries Buytaert committed
465
    // Update the contents of the system table:
466
467
    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);
468

469
    $row = array($file->name, $file->description, array('data' => (in_array($file->name, $required) ? form_hidden("status][$file->name", 1) . t('required') : form_checkbox('', "status][$file->name", 1, $file->status)), 'align' => 'center'));
Dries Buytaert's avatar
   
Dries Buytaert committed
470
    if (module_exist('throttle')) {
471
      $row[] = array('data' => (in_array($file->name, $throttle_required) ? form_hidden("throttle][$file->name", 0) . t('required') : form_checkbox(NULL, "throttle][$file->name", 1, $file->throttle, NULL)), 'align' => 'center');
Dries Buytaert's avatar
   
Dries Buytaert committed
472
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
473
    $rows[] = $row;
474
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
475

Dries Buytaert's avatar
   
Dries Buytaert committed
476
  $output  = theme('table', $header, $rows);
Dries Buytaert's avatar
   
Dries Buytaert committed
477
  $output .= form_hidden('type', 'module');
Dries Buytaert's avatar
   
Dries Buytaert committed
478

Dries Buytaert's avatar
   
Dries Buytaert committed
479
  return $output;
Dries Buytaert's avatar
 
Dries Buytaert committed
480
}
Dries Buytaert's avatar
   
Dries Buytaert committed
481

482
function system_listing_save($edit = array()) {
Dries Buytaert's avatar
   
Dries Buytaert committed
483
484
  $op = $_POST['op'];
  $edit = $_POST['edit'];
Dries Buytaert's avatar
   
Dries Buytaert committed
485

Dries Buytaert's avatar
   
Dries Buytaert committed
486
487
  if ($op == t('Save configuration')) {
    db_query("UPDATE {system} SET status = 0 WHERE type = '%s'", $edit['type']);
488
    foreach ($edit['status'] as $name => $status) {
Dries Buytaert's avatar
   
Dries Buytaert committed
489
      // Make certain that the default theme is enabled to avoid user error
490
      if (($edit['type'] == 'theme') && ($edit['theme_default'] == $name)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
491
492
493
        $status = 1;
      }

494
      db_query("UPDATE {system} SET status = %d, throttle = %d WHERE type = '%s' AND name = '%s'", $status, $edit['throttle'][$name], $edit['type'], $name);
Dries Buytaert's avatar
   
Dries Buytaert committed
495
    }
496

Dries Buytaert's avatar
   
Dries Buytaert committed
497
    if ($edit['type'] == 'theme') {
498
      variable_set('theme_default', $edit['theme_default']);
499
500
501
    }

    cache_clear_all();
Dries Buytaert's avatar
   
Dries Buytaert committed
502
    menu_rebuild();
503

Dries Buytaert's avatar
   
Dries Buytaert committed
504
    drupal_set_message(t('The configuration options have been saved.'));
Steven Wittens's avatar
Steven Wittens committed
505
    drupal_goto($_GET['q']);
506
507
508
509
  }
}

function system_settings_form($form) {
Dries Buytaert's avatar
   
Dries Buytaert committed
510
511
  $form .= form_submit(t('Save configuration'));
  $form .= form_submit(t('Reset to defaults'));
512
513
514
515
516

  return form($form);
}

function system_settings_save() {
Dries Buytaert's avatar
   
Dries Buytaert committed
517
518
  $op = $_POST['op'];
  $edit = $_POST['edit'];
Dries Buytaert's avatar
   
Dries Buytaert committed
519

Dries Buytaert's avatar
   
Dries Buytaert committed
520
  if ($op == t('Reset to defaults')) {
Dries Buytaert's avatar
   
Dries Buytaert committed
521
522
523
524
    if (is_array($edit)) {
      foreach ($edit as $name => $value) {
        variable_del($name);
      }
525
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
526
    drupal_set_message(t('The configuration options have been reset to their default values.'));
527
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
528
  if ($op == t('Save configuration')) {
Dries Buytaert's avatar
   
Dries Buytaert committed
529
530
531
532
    if (is_array($edit)) {
      foreach ($edit as $name => $value) {
        variable_set($name, $value);
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
533
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
534
    drupal_set_message(t('The configuration options have been saved.'));
535
536
537
538
539
  }
  else {
    return;
  }
  cache_clear_all();
Dries Buytaert's avatar
   
Dries Buytaert committed
540
  menu_rebuild();
Steven Wittens's avatar
Steven Wittens committed
541
  drupal_goto($_GET['q']);
542
543
}

Dries Buytaert's avatar
   
Dries Buytaert committed
544
545
546
547
548
/**
 * Menu callback; displays a listing of all themes.
 */
function system_themes() {
  system_listing_save();
Dries Buytaert's avatar
   
Dries Buytaert committed
549
  $form = system_theme_listing();
Dries Buytaert's avatar
   
Dries Buytaert committed
550
551
552
553
554
555
556
557
558
  $form .= form_submit(t('Save configuration'));
  print theme('page', form($form));
}

/**
 * Menu callback; displays a listing of all modules.
 */
function system_modules() {
  system_listing_save();
Dries Buytaert's avatar
   
Dries Buytaert committed
559
  $form = system_module_listing();
Dries Buytaert's avatar
   
Dries Buytaert committed
560
561
562
563
  $form .= form_submit(t('Save configuration'));
  print theme('page', form($form));
}

564
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
565
 * Menu callback; displays a module's settings page.
566
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
567
function system_site_settings($module = NULL) {
568
569
  system_settings_save();

Dries Buytaert's avatar
   
Dries Buytaert committed
570
571
572
573
574
  if ($module) {
    $form = module_invoke($module, 'settings');
  }
  else {
    $form = system_view_general();
575
576
577
578
579
  }

  print theme('page', system_settings_form($form));
}

Dries Buytaert's avatar
   
Dries Buytaert committed
580
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
581
 * Menu callback; display theme configuration for entire site and individual themes.
Dries Buytaert's avatar
   
Dries Buytaert committed
582
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
583
function system_theme_settings() {
Dries Buytaert's avatar
   
Dries Buytaert committed
584
  system_settings_save();
Dries Buytaert's avatar
   
Dries Buytaert committed
585

Dries Buytaert's avatar
   
Dries Buytaert committed
586
587
588
  // Default settings are defined in _theme_settings() in includes/theme.inc
  $key = str_replace('.', '/', arg(3));
  if ($key) {
589
    $settings = theme_get_settings($key);
Dries Buytaert's avatar
   
Dries Buytaert committed
590
    $var = str_replace('/', '_', 'theme_'. $key .'_settings');
591
592
    $themes = system_theme_data();
    $features = function_exists($themes[$key]->prefix . '_features') ? call_user_func($themes[$key]->prefix . '_features') : array();
Dries Buytaert's avatar
   
Dries Buytaert committed
593
594
  }
  else {
595
    $settings = theme_get_settings('');
Dries Buytaert's avatar
   
Dries Buytaert committed
596
597
598
    $var = 'theme_settings';
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
  // Check for a new uploaded logo, and use that instead.
  if ($file = file_check_upload('logo_upload')) {
    if (in_array($file->filemime, array('image/jpeg', 'image/gif', 'image/png'))) {
      $parts = pathinfo($file->filename);
      $filename = ($key) ? str_replace('/', '_', $key) . '_logo.' . $parts['extension'] : 'logo.' . $parts['extension'];

      if ($file = file_save_upload('logo_upload', $filename, 1)) {
        $settings['default_logo'] = 0;
        $settings['logo_path'] = $file->filepath;

        // Update the variable table with the new settings so that they take effect immediately.
        variable_set($var, $settings);
      }
    }
    else {
      form_set_error('file_upload', t('Only JPEG, PNG and GIF images are allowed to be used as logos.'));
    }
  }


Dries Buytaert's avatar
   
Dries Buytaert committed
619
620
621
622
623
  $form = '';

  // Logo settings
  if ((!$key) || in_array('logo', $features)) {
    $group = form_checkbox(t('Use the default logo'), "$var][default_logo", 1, $settings['default_logo'], t('Check here if you want the theme to use the logo supplied with it.'));
624
    $group .= form_textfield(t('Path to custom logo'), "$var][logo_path", $settings['logo_path'], 50, 128, t('The path to the file you would like to use as your logo file instead of the default logo.'));
Dries Buytaert's avatar
   
Dries Buytaert committed
625
626
627
628
629

    file_check_directory(variable_get('file_directory_path', 'files'), FILE_CREATE_DIRECTORY, 'file_directory_path');
    $group .= form_file(t('Upload logo image'), 'logo_upload', 40, t("If you don't have direct file access to the server, use this field to upload your logo."));
    $group .= form_button(t('Upload'), 'fileop');

Dries Buytaert's avatar
   
Dries Buytaert committed
630
    $form = form_group(t('Logo image settings'), $group);
Dries Buytaert's avatar
   
Dries Buytaert committed
631

Dries Buytaert's avatar
   
Dries Buytaert committed
632
633
634
635
636
637
638
639
640
641
642
643
  }

  // System wide only settings.
  if (!$key) {
    // Menu settings
    $group = form_textarea(t('Primary links'), "$var][primary_links", $settings['primary_links'], 70, 8, t('The HTML code for the primary links. If this field is empty, Drupal will automatically generate a set of links based on which modules are enabled.'));
    $group .= form_textarea(t('Secondary links'), "$var][secondary_links", $settings['secondary_links'], 70, 8, t('The HTML code for the secondary links.'));
    $form .= form_group(t('Menu Settings'), $group, t('Customize the menus that are displayed at the top and/or bottom of the page. This configuration screen is only available in the site wide display configuration.'));

    // Toggle node display.
    $group = '';
    foreach (node_list() as $type) {
644
      $group .= form_checkbox(node_invoke($type, 'node_name'), "$var][toggle_node_info_$type", 1, $settings["toggle_node_info_$type"]);
Dries Buytaert's avatar
   
Dries Buytaert committed
645
646
647
648
649
650
651
652
653
654
655
656
657
658
    }
    $form .= form_group(t('Display post information on'), $group, t('Enable or disable the "submitted by Username on date" text when displaying posts of the above type'));
  }

  $group = '';

  // Toggle settings
  $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'));
659
660
661
662
  // Only offer search box if search;module is enabled.
  if (module_exist('search')) {
    $toggles['toggle_search'] = t('Search box');
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
663
664
665
666
667
668
669
670
671
672
673
674

  foreach ($toggles as $name => $title) {
    if ((!$key) || in_array($name, $features)) {
      $group .= form_checkbox($title, "$var][$name", 1, $settings[$name]);
    }
  }
  if ($group) {
    $form .= form_group(t('Toggle display'), $group, t('Enable or disable the display of certain page elements.'));
  }

  if ($key) {
    // Template-specific settings
Dries Buytaert's avatar
   
Dries Buytaert committed
675
    $function = $themes[$key]->prefix .'_settings';
Dries Buytaert's avatar
   
Dries Buytaert committed
676
677
    if (function_exists($function)) {
      $group = $function();
Dries Buytaert's avatar
   
Dries Buytaert committed
678
679
680
      if ($themes[$key]->template) {
        // file is a template or a style of a template
        $form .= form_group(t('Engine-specific settings'), $group, t('These settings only exist for all the templates and styles based on the %engine theme engine.', array('%engine' => $themes[$key]->prefix)));
Dries Buytaert's avatar
   
Dries Buytaert committed
681
682
      }
      else {
Dries Buytaert's avatar
   
Dries Buytaert committed
683
684
        // file is a theme or a style of a theme
        $form .= form_group(t('Theme-specific settings'), $group, t('These settings only exist for the %theme theme and all the styles based on it.', array('%theme' => $themes[$key]->prefix)));
Dries Buytaert's avatar
   
Dries Buytaert committed
685
686
      }
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
687
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
688
689
690
691
  $form .= form_submit(t('Save configuration'));
  $form .= form_submit(t('Reset to defaults'));

  print theme('page', form($form, 'post', null, array('enctype' => 'multipart/form-data')));
Dries Buytaert's avatar
   
Dries Buytaert committed
692

Dries Buytaert's avatar
 
Dries Buytaert committed
693
}
Dries Buytaert's avatar
   
Dries Buytaert committed
694

Dries Buytaert's avatar
   
Dries Buytaert committed
695
?>