system.module 19.9 KB
Newer Older
1
<?php
2
// $Id$
3

4
function system_help($section = "admin/help#system") {
5
  global $base_url;
6 7
  $output = "";

8
  switch ($section) {
9
    case 'admin/system':
10
      $output = 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.");
11
      break;
12
    case 'admin/system/themes':
13
      $output = t("Select which themes are available to your users and specify the default theme.");
14
      break;
15
    case 'admin/system/modules':
16
      $output = 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 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/permission"), "%throttle" => url("admin/system/modules/throttle")));
17
      break;
18
    case 'admin/help#system':
19 20 21 22
      $output .= t("
      <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>
23
      <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>
24 25 26 27 28 29 30
      <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>
      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 varibles will not be set correctly and features may not work as expected.</p>
      <h3><a id=\"cache\">Cache</a></h3>
      <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.</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" ));
31 32 33
      break;
    case 'admin/system/modules#description':
      $output = t("Configuration system that lets administrators modify the workings of the site.");
34 35 36
      break;
  }

37
  return $output;
38 39
}

Dries's avatar
Dries committed
40
function system_help_page() {
41
  print theme("page", system_help());
Dries's avatar
Dries committed
42 43
}

44
function system_perm() {
45
  return array("administer site configuration", "access administration pages", "bypass input data check", "create php content");
Dries's avatar
Dries committed
46 47 48
}

function system_link($type) {
49
  if ($type == "system") {
50
    menu("system/files", t("file download"), "file_download", 0, MENU_HIDE);
51
    if (user_access("administer site configuration")) {
52

53 54
      menu("admin/system", t("configuration"), "system_admin", 3);
      menu("admin/system/themes", t("themes"), "system_admin", 2);
55

56 57
      foreach (list_themes() as $theme) {
        // TODO: reenable 'forced refresh' once we move the menu_build() later in the request. it added overhead with no benefit
58 59 60 61 62 63
        // NOTE: refresh the list because some themes might have been enabled/disabled.
        include_once "$theme->filename";
        $function = $theme->name ."_settings";
        if (function_exists($function)) {
          menu("admin/system/themes/$theme->name", $theme->name, "system_admin");
        }
64 65
      }

66
      menu("admin/system/modules", t("modules"), "system_admin", 3);
67 68
      foreach (module_list() as $name) {
        // TODO: reenable 'forced refresh' once we move the menu_build() later in the request.  it added overhead with no benefit
69 70
        // NOTE: refresh the list because some modules might have been enabled/disabled.
        if (module_hook($name, "settings")) {
71
          menu("admin/system/modules/$name", t($name), "system_admin");
72
        }
73
      }
Dries's avatar
Dries committed
74
      menu("admin/system/help", t("help"), "system_help_page", 9);
75
    }
Dries's avatar
Dries committed
76
  }
77 78
}

79
function system_user($type, $edit, &$user) {
80
  if ($type == "edit_form") {
81
    $options = "<option value=\"\">". t("Default theme") ."</option>\n";
Dries's avatar
Dries committed
82 83 84 85
    if (count($themes = list_themes()) > 1) {
      foreach ($themes as $key => $value) {
        $options .= "<option value=\"$key\"". (($edit["theme"] == $key) ? " selected=\"selected\"" : "") .">$key - $value->description</option>\n";
      }
86
      $data[t('Theme settings')] = form_item(t("Theme"), "<select name=\"edit[theme]\">$options</select>", t("Selecting a different theme will change the look and feel of the site."));
Dries's avatar
Dries committed
87
    }
88

89
    $timestamp = time();
90 91 92
    $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);
    foreach ($zonelist as $offset) {
      $zone = $offset * 3600;
93
      $zones[$zone] = format_date($timestamp, 'custom', variable_get('date_format_long', 'l, F j, Y - H:i') . ' O', $zone);
94
    }
95
    $data[t('Locale settings')] = form_select(t("Time zone"), "timezone", $edit["timezone"], $zones, t("Select what time you currently have and your time zone settings will be set appropriate."));
96 97 98 99
    return $data;
  }
  else {
    return $edit;
100 101 102
  }
}

103
function system_view_general() {
104
  global $conf;
105

106
  // general settings:
107 108 109 110 111 112 113
  $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'."));
114
  $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."));
115 116 117
  $group .= form_radios(t("Clean URLs"), "clean_url", variable_get("clean_url", 0), array(t("Disabled"), t("Enabled")), t("Enable or disable clean URLs.  If enabled, you'll need <code>ModRewrite</code> support.  See also the <code>.htaccess</code> file in Drupal's top-level directory."));

  $output = form_group(t("General settings"), $group);
118

Dries's avatar
Dries committed
119
  // caching:
120
  $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/system/help", NULL, NULL, "cache"))));
121 122

  $output .= form_group(t("Cache settings"), $group);
Dries's avatar
Dries committed
123

124 125 126 127
  // file system:
  if (!file_check_directory(variable_get('file_directory_path', 'files'))) {
    $error['file_directory_path'] = theme('error', t('Directory does not exist, or is not writable.'));
  }
Kjartan's avatar
Kjartan committed
128
  if (!file_check_directory(variable_get('file_directory_temp', (PHP_OS == 'WINNT' ? 'c:\\windows\\temp' : '/tmp')))) {
129 130 131 132 133 134
    $error['file_directory_temp'] = theme('error', t('Directory does not exist, or is not writable.'));
  }
  $group = form_textfield(t('File system path'), 'file_directory_path', variable_get('file_directory_path', 'files'), 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.') . $error['file_directory_path']);
  $group .= form_textfield(t('Temporary directory'), 'file_directory_temp', variable_get('file_directory_temp', (PHP_OS == 'WINNT' ? 'c:\\windows\\temp' : '/tmp')), 70, 255, t('Location where files can be saved temporarily. This directory should not be accessible from the web.') . $error['file_directory_temp']);
  $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 be transferred by Drupal.')), t('This setting can be changed at any time, however, all download URLs will change and there may be unexpected problems so it is not recommended.'));
  $output .= form_group(t('File system'), $group);
135

136
  // date settings:
137 138 139 140
  $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);
  foreach ($zonelist as $offset) {
    $zone = $offset * 3600;
141
    $zones[$zone] = format_date($timestamp, 'custom', variable_get('date_format_long', 'l, F j, Y - H:i') . ' O', $zone);
142 143
  }

Dries's avatar
Dries committed
144 145 146 147 148 149 150 151 152 153 154 155 156 157
  // date settings: possible date formats
  $dateshort = array("m/d/Y - H:i", "d/m/Y - H:i", "Y/m/d - H:i",
           "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");
  $datemedium = array("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",
          "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");

  // date settings: construct choices for user
  foreach ($dateshort as $f) {
158
    $dateshortchoices[$f] = format_date(time(), "custom", $f);
Dries's avatar
Dries committed
159 160
  }
  foreach ($datemedium as $f) {
161
    $datemediumchoices[$f] = format_date(time(), "custom", $f);
Dries's avatar
Dries committed
162 163
  }
  foreach ($datelong as $f) {
164
    $datelongchoices[$f] = format_date(time(), "custom", $f);
Dries's avatar
Dries committed
165 166
  }

167 168
  $group  = form_select(t("Time zone"), "date_default_timezone", variable_get('date_default_timezone', 0), $zones, t("Select the default site timezone."));
  $group .= form_select(t("Date format (short)"), "date_format_short", variable_get("date_format_short", $dateshort[0]), $dateshortchoices, t("The short format of date display."));
169 170
  $group .= form_select(t("Date format (medium)"), "date_format_medium", variable_get("date_format_medium", $datemedium[0]), $datemediumchoices, t("The medium sized date display."));
  $group .= form_select(t("Date format (long)"), "date_format_long", variable_get("date_format_long", $datelong[0]), $datelongchoices, t("Longer date format used for detailed display."));
171

172
  $output .= form_group(t("Date format settings"), $group);
173

174 175 176
  return $output;
}

177
function system_view_theme($name) {
178
  $themes = list_themes();
179 180
  $theme = $themes[$name];
  if ($theme) {
181
    include_once "$theme->filename";
182

183
    $function = $theme->name ."_settings";
184
    if (function_exists($function)) {
185
      $output .= $function();
186 187
    }
  }
188
  else {
189
    $output = t("Invalid theme specified");
190
  }
191 192 193
  return $output;
}

194 195 196 197 198 199 200
function system_view($type, $arg = "") {
  // The module/theme lists don't use the generic settings handler
  if (($type == "modules" || $type == "themes") && $arg == "") {
    system_listing_save();
    $form = system_listing($type);
    $form .= form_submit(t("Save configuration"));
    return form($form);
Dries's avatar
Dries committed
201 202
  }

203
  system_settings_save();
204 205

  switch ($type) {
206
    case "modules":
207
      $form = module_invoke($arg, "settings");
208
      break;
209
    case "themes":
210
      $form = system_view_theme($arg);
211
      break;
212
    default:
213 214
      $form = system_view_general();
      break;
215 216
  }

217
  return system_settings_form($form);
218 219
}

220 221 222 223 224 225 226 227 228 229 230 231 232
function system_listing($type) {
  // Pick appropriate directory and filetype
  switch ($type) {
    case "modules":
      $directory = "modules";
      $type = "module";
      break;
    case "themes":
    default:
      $directory = "themes";
      $type = "theme";
      break;
  }
233

Dries's avatar
Dries committed
234
  // Find files in the directory.
235
  $files = file_scan_directory($directory, "\.$type$");
236

Dries's avatar
Dries committed
237
  // Extract current files from database.
238
  $result = db_query("SELECT filename, type, status, throttle FROM {system} WHERE type = '%s'", $type);
Dries's avatar
Dries committed
239 240 241 242 243
  while ($file = db_fetch_object($result)) {
    if (is_object($files[$file->filename])) {
      foreach ($file as $key => $value) {
        $files[$file->filename]->$key = $value;
      }
244
    }
245 246
  }

Dries's avatar
Dries committed
247
  ksort($files);
248

249
  if ($type == "module") {
250
    $required = array("modules/admin.module", "modules/filter.module", "modules/system.module", "modules/user.module", "modules/watchdog.module");
251 252
    // the throttle mechanism requires additional modules always be enabled
    $throttle_required = array_merge($required, array("modules/statistics.module", "modules/throttle.module"));
253 254

    $header = array(t("name"), t("description"), t("status"), t("throttle"));
255 256
  }
  else {
257
    $required = array();
258 259
    $header = array(t("name"), t("description"), t("enable"), t("default"));
  }
Dries's avatar
Dries committed
260 261 262 263

  foreach ($files as $filename => $file) {
    include_once($filename);
    if ($type == "module") {
264 265
      $info->name = module_invoke($file->name, "help", "admin/system/modules#name") ? module_invoke($file->name, "help", "admin/system/modules#name") : module_invoke($file->name, "system", "name") ? module_invoke($file->name, "system", "name") : $file->name;
      $info->description = module_invoke($file->name, "help", "admin/system/modules#description") ? module_invoke($file->name, "help", "admin/system/modules#description") : module_invoke($file->name, "system", "description");
266 267 268 269 270 271 272 273
      // 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
274 275
    }
    elseif ($type == "theme") {
276 277 278 279 280 281 282 283
      $info->name = $file->name;
      $info->description = module_invoke($file->name, "help", "admin/system/themes#description");
      $themes[] = $info->name;

      // Enable the default theme:
      if ($info->name == variable_get("theme_default", 0)) {
        $file->status = 1;
      }
284 285
    }

Dries's avatar
Dries committed
286
    // Update the contents of the system table:
287
    db_query("DELETE FROM {system} WHERE filename = '%s' AND type = '%s'", $filename, $type);
288
    db_query("INSERT INTO {system} (name, description, type, filename, status, throttle, bootstrap) VALUES ('%s', '%s', '%s', '%s', %d, %d, %d)", $info->name, $info->description, $type, $filename, $file->status, $file->throttle, $bootstrap);
289

290
    $row = array($info->name, $info->description, array("data" => (in_array($filename, $required) ? form_hidden("status][$filename", 1) . t("required") : form_checkbox("", "status][$filename", 1, $file->status)), "align" => "center"));
291
    if ($type == "module") {
292
      $row[] = array("data" => (in_array($filename, $throttle_required) ? form_hidden("throttle][$filename", 0) . t("required") : form_checkbox(NULL, "throttle][$filename", 1, $file->throttle, NULL, module_exist('throttle') ? NULL : array("disabled" => "disabled"))), "align" => "center");
293 294
    }
    else if ($type == "theme") {
295
      $row[] = array("data" => form_radio("", "theme_default", $info->name, (variable_get("theme_default",0) == $info->name) ? 1 : 0), "align" => "center");
296 297
    }
    $rows[] = $row;
298
  }
299

300
  $output  = theme("table", $header, $rows);
301
  $output .= form_hidden("type", $type);
302

303
  return $output;
304
}
305

306
function system_listing_save($edit = array()) {
307 308
  $op = $_POST["op"];
  $edit = $_POST["edit"];
309

310 311 312 313
  if ($op == t("Save configuration")) {
    db_query("UPDATE {system} SET status = '0' WHERE type = '%s'", $edit["type"]);
    foreach ($edit["status"] as $filename => $status) {
      db_query("UPDATE {system} SET status = %d, throttle = %d WHERE filename = '$filename'", $status, $edit["throttle"]["$filename"]);
314
    }
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
    if ($edit["type"] == "theme") {
      variable_set("theme_default", $edit["theme_default"]);
    }

    cache_clear_all();

    drupal_set_message(t("the configuration options have been saved."));
  }
}

function system_settings_form($form) {
  $form .= form_submit(t("Save configuration"));
  $form .= form_submit(t("Reset to defaults"));

  return form($form);
}

function system_settings_save() {
  $op = $_POST["op"];
  $edit = $_POST["edit"];
335

336 337 338 339 340 341 342 343 344
  if ($op == t("Reset to defaults")) {
    foreach ($edit as $name => $value) {
      variable_del($name);
    }
    drupal_set_message(t("the configuration options have been reset to their default values."));
  }
  if ($op == t("Save configuration")) {
    foreach ($edit as $name => $value) {
      variable_set($name, $value);
345
    }
346 347 348 349 350
    drupal_set_message(t("the configuration options have been saved."));
  }
  else {
    return;
  }
351

352 353 354 355
  cache_clear_all();
}

function system_admin() {
356 357
  $output = system_view(arg(2), arg(3));
  print theme("page", $output);
358
}
359

Dries's avatar
Dries committed
360
?>