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

function system_help() {
Dries's avatar
 
Dries committed
5
  $output .= "<p>Drupal comes with system-wide defaults but the setting-module provides control over many Drupal preferences, behaviors including visual and operational settings.</p>";
Dries's avatar
 
Dries committed
6 7
  $output .= "<h3>Cache</h3>". system_help_cache();
  $output .= "<h3>Cron</h3>". system_help_cron();
Dries's avatar
 
Dries committed
8 9 10
  return $output;
}

11
function system_system($field){
Dries's avatar
 
Dries committed
12
  $system["description"] = t("Configuration system that lets administrators modify the workings of the site.");
13 14 15
  return $system[$field];
}

Dries's avatar
 
Dries committed
16
function system_help_cache() {
Dries's avatar
 
Dries committed
17
  $output .= "<p>Drupal has a caching mechanism that stores dynamically generated pages in a database.  By caching a page, Drupal does not have to generate the page each time it is requested.  Only pages requested by anonymous users are being cached.  When a cached page is accessed, Drupal will retrieve that page with minimal overhead using one SQL query only, thus reducing both the server load and the response time.</p>";
Dries's avatar
 
Dries committed
18
  $output .= "<p>Drupal's caching mechanism can be enabled and disabled by the site administrators from the 'settings' page.  Site administrators can also define how long cached pages should be kept.</p>";
Dries's avatar
 
Dries committed
19
  return $output;
Dries's avatar
 
Dries committed
20 21 22
}

function system_help_cron() {
Dries's avatar
 
Dries committed
23 24 25 26
  $output .= "<p>Some settings require a <i>cron</i> or <i>crontab</i>.  Cron, which stands for chronograph, is a periodic command scheduler: it executes 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 of <i>n</i> 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>";
  $output .= "<p>Whenever <a href=\"". path_uri() ."cron.php\">". path_uri() ."cron.php</a> is accessed, cron will run: it checks for the jobs cron controls, and their periods in seconds.  If a certain task wasn't executed in the last n seconds, where n is the period of that job, it will be executed.  When all the executed commands terminate, cron is done.</p>";
  $output .= "<p>The recommended way to setup your cron system is to setup a Unix/Linux crontab that frequently visits <a href=\"". path_uri() ."cron.php\">". path_uri() ."cron.php</a>.  Note that cron does not guarantee the commands will be executed at the specified interval.  However, Drupal will try his best and run the crons as close to the specified intervals as possible.  The more you visit cron.php, the more accurate cron will be.</p>";
  $output .= "<p>If your hosting company does not allow you to setup crontabs, you can always ask someone else to setup a crontab for you. After all, virtually any Unix/Linux machine with access to the internet can setup a crontab to frequently visit <a href=\"". path_uri() ."cron.php\">". path_uri() ."cron.php</a>.</p>";
Dries's avatar
 
Dries committed
27
  $output .= "<p>For the Unix/Linux crontab itself, use a browser like <i>lynx</i> or <i>wget</i> but make sure the process terminates: either use <code>/usr/bin/lynx -source <?php echo path_uri(); ?>cron.php</code> or <code>/usr/bin/wget -O /dev/null <?php echo path_uri(); ?>cron.php</code>.  Take a look at the example scripts in the <code>scripts</code>-directory and make sure to adjust them to 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; don't run it using command line PHP and avoid using <code>localhost</code> or <code>127.0.0.1</code>, or some features won't work as expected.  For all the environment variables to be correct; use a browser to access <code>cron.php</code> on a publicly accessible domain.</p>";
Dries's avatar
 
Dries committed
28
  return $output;
Dries's avatar
 
Dries committed
29 30 31
}

function system_perm() {
Dries's avatar
 
Dries committed
32
  return array("administer site configuration", "access administration pages", "create php content");
Dries's avatar
 
Dries committed
33 34 35
}

function system_link($type) {
Dries's avatar
 
Dries committed
36
  if ($type == "admin" && user_access("administer site configuration")) {
Dries's avatar
 
Dries committed
37
    menu_add("site configuration", url("admin/system"), "Site configuration.", NULL, NULL, 2);
Dries's avatar
 
Dries committed
38 39 40 41 42
     menu_add("module selector", url("admin/system/modules/selector"), "Module selector.", NULL, "site configuration", 1);
     menu_add("module settings", url("admin/system/modules/settings"), "Site settings.", NULL, "site configuration", 2);
     menu_add("theme selector", url("admin/system/themes/selector"), "Theme selector.", NULL, "site configuration", 3);
     // menu_add("theme settings", url("admin/system/themes/settings"), "Theme selector.", NULL, "site configuration", 4);
     menu_add("content filters", url("admin/system/filters"), "Content filters.", NULL, "site configuration", 5);
Dries's avatar
 
Dries committed
43
     menu_add("help", url("admin/system/help"), "Help.", NULL, "site configuration", 9);
Dries's avatar
 
Dries committed
44
  }
Dries's avatar
 
Dries committed
45 46
}

Dries's avatar
 
Dries committed
47
function system_view_modules() {
48
  global $conf, $cmodes, $corder;
Dries's avatar
 
Dries committed
49

Dries's avatar
 
Dries committed
50
  // general settings:
Dries's avatar
 
Dries committed
51 52 53 54 55 56 57
  $output .= "<h3>" . t("General settings") . "</h3>\n";
  $output .= form_textfield(t("Name"), "site_name", variable_get("site_name", "drupal"), 55, 55, t("The name of this website."));
  $output .= form_textfield(t("E-mail address"), "site_mail", variable_get("site_mail", ini_get("sendmail_from")), 55, 128, t("A valid e-mail address for this website, used by the auto-mailer during registration, new password requests, notifications, etc."));
  $output .= form_textfield(t("Slogan"), "site_slogan", variable_get("site_slogan", ""), 55, 128, t("The slogan of this website. Some themes display a slogan when available."));
  $output .= form_textarea(t("Mission"), "site_mission", variable_get("site_mission", ""), 55, 5, t("Your site's mission statement or focus."));
  $output .= form_textarea(t("Footer message"), "site_footer", variable_get("site_footer", ""), 55, 5, t("This text will be displayed at the bottom of each page.  Useful for adding a copyright notice to your pages."));
  $output .= form_textfield(t("Anonymous user"), "anonymous", variable_get("anonymous", "Anonymous"), 55, 55, t("The name used to indicate anonymous users."));
58
  foreach (module_list() as $name) { if (module_hook($name, "page")) $pages[$name] = $name; }
Dries's avatar
 
Dries committed
59
  $output .= form_select(t("Default front page"), "site_frontpage", variable_get("site_frontpage", "node"), $pages, t("The home page displays content from this module (usually node)."));
Dries's avatar
 
Dries committed
60
  $output .= "<hr />\n";
Dries's avatar
 
Dries committed
61

Dries's avatar
 
Dries committed
62
  // caching:
Dries's avatar
 
Dries committed
63
  $output .= "<h3>" . t("Cache settings") . "</h3>\n";
Dries's avatar
 
Dries committed
64
  $period = array(10 => format_interval(10), 20 => format_interval(20), 30 => format_interval(30), 40 => format_interval(40), 50 => format_interval(50), 50 => format_interval(50), 60 => format_interval(60), 90 => format_interval(90), 120 => format_interval(120), 150 => format_interval(150), 180 => format_interval(180), 210 => format_interval(210), 240 => format_interval(240), 270 => format_interval(270), 300 => format_interval(300), 360 => format_interval(360), 420 => format_interval(420), 480 => format_interval(480), 540 => format_interval(540), 600 => format_interval(600), 1800 => format_interval(1800), 3600 => format_interval(3600), 7200 => format_interval(7200));
Dries's avatar
 
Dries committed
65
  $output .= form_select(t("Cache support"), "cache", variable_get("cache", 0), array(t("Disabled"), t("Enabled")), t("Enable or disable the caching of pages."));
Dries's avatar
 
Dries committed
66
  $output .= form_select(t("Discard cached pages older than"), "cache_clear", variable_get("cache_clear", 120), $period, t("The time cached pages should be kept.  Older pages are automatically refreshed."));
Dries's avatar
 
Dries committed
67
  $output .= "<hr />\n";
Dries's avatar
 
Dries committed
68

Dries's avatar
 
Dries committed
69
  // submission settings:
Dries's avatar
 
Dries committed
70
  $output .= "<h3>" . t("Submission settings") . "</h3>\n";
Dries's avatar
 
Dries committed
71
  $rate = array(-10000 => "Disabled", 1 => "Maximum 1 every second", 5 => "Maximum 1 every 5 seconds", 15 => "Maximum 1 every 15 seconds", 30 => "Maximum 1 every 30 seconds", 60 => "Maximum 1 every minute", 300 => "Maximum 1 every 5 minutes", 900 => "Maximum 1 every 15 minutes", 1800 => "Maximum 1 every 30 minutes", 3600 => "Maximum 1 every hour", 21600 => "Maximum 1 every 6 hours", 43200 => "Maximum 1 every 12 hours");
Dries's avatar
 
Dries committed
72 73
  $output .= form_select(t("Maximum node rate"), "max_node_rate", variable_get("max_node_rate", 900), $rate, t("The maximum submission rate for nodes.  Its purpose is to stop potential abuse or denial of service attacks."));
  $output .= form_select(t("Maximum comment rate"), "max_comment_rate", variable_get("max_comment_rate", 120), $rate, t("The maximum submission rate for comments.  Its purpose is to stop potential abuse or denial of service attacks."));
Dries's avatar
 
Dries committed
74
  $output .= "<hr />\n";
Dries's avatar
 
Dries committed
75

Dries's avatar
 
Dries committed
76
  // date settings:
Dries's avatar
 
Dries committed
77 78
  $output .= "<h3>" . t("Date format setting") . "</h3>\n";
  $output .= form_select(t("Date format"), "date_format", variable_get("date_format", "m/d/Y - H:i"), array("m/d/Y - H:i" => "m/d/Y - H:i", "d/m/Y - H:i" => "d/m/Y - H:i", "Y/m/d - H:i" => "Y/m/d - H:i"), t("The format in which dates are displayed"));
Dries's avatar
 
Dries committed
79 80
  $output .= "<hr />\n";

Dries's avatar
 
Dries committed
81
  // layout settings:
Dries's avatar
 
Dries committed
82
  $output .= "<h3>" . t("Layout settings") . "</h3>\n";
83
  foreach (theme_list() as $key => $value) $options .= "<option value=\"$key\"". (variable_get("theme_default", 0) == $key ? " selected=\"selected\"" : "") .">$key</option>\n";
Dries's avatar
 
Dries committed
84
  $output .= form_item(t("Default theme"), "<select name=\"edit[theme_default]\">$options</select>", t("The default theme as seen by visitors or anonymous users."));
Dries's avatar
 
Dries committed
85
  $output .= "<hr />\n";
Dries's avatar
 
Dries committed
86 87 88

  foreach (module_list() as $name) {
    if (module_hook($name, "conf_options")) {
Dries's avatar
 
Dries committed
89
      $output .= "<h3><a name=\"$name\">". ucfirst(t("$name")) ." " . t("settings") . "</a></h3>". module_invoke($name, "conf_options") ."<hr />\n";
Dries's avatar
 
Dries committed
90 91
    }
  }
Dries's avatar
 
Dries committed
92 93 94 95 96 97 98 99 100 101 102

  return $output;
}

function system_view_themes() {
  foreach (theme_list() as $name) {
    if (module_hook($name, "conf_options")) {
      $output .= "<h3><a name=\"$name\">". ucfirst(t("$name")) ." " . t("settings") . "</a></h3>". module_invoke($name, "conf_options") ."<hr />\n";
    }
  }

Dries's avatar
 
Dries committed
103 104 105 106 107 108 109 110 111 112 113 114
  return $output;
}

function system_view_filters() {
  foreach (module_list() as $name) {
    if (module_hook($name, "conf_filters")) {
      $output .= module_invoke($name, "conf_filters");
    }
  }
  return $output;
}

Dries's avatar
 
Dries committed
115
function system_save_settings($edit = array()) {
Dries's avatar
 
Dries committed
116 117 118 119
  foreach ($edit as $name => $value) {
    variable_set($name, $value);
  }

Dries's avatar
 
Dries committed
120 121 122 123 124 125 126 127 128 129 130 131 132
  cache_clear_all();

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

function system_save_selector($type, $edit = array()) {
  db_query("UPDATE system SET status = '0' WHERE type = '%s'", $type);
  foreach ($edit["status"] as $filename => $status) {
    db_query("UPDATE system SET status = '%d' WHERE filename = '$filename'", $status);
  }

  cache_clear_all();

Dries's avatar
 
Dries committed
133
  return t("the configuration options have been saved.");
Dries's avatar
 
Dries committed
134 135
}

Dries's avatar
 
Dries committed
136
function system_reset_default($edit = array()) {
Dries's avatar
 
Dries committed
137 138 139 140
  foreach ($edit as $name => $value) {
    variable_del($name);
  }

Dries's avatar
 
Dries committed
141 142
  cache_clear_all();

Dries's avatar
 
Dries committed
143
  return t("the configuration options have been reset to their default values.");
Dries's avatar
 
Dries committed
144 145 146 147
}

function system_view($type) {

Dries's avatar
 
Dries committed
148 149
  $links = array();

Dries's avatar
 
Dries committed
150
  switch ($type) {
Dries's avatar
 
Dries committed
151
    case "filters":
Dries's avatar
 
Dries committed
152 153
      $form = system_view_filters();
      break;
Dries's avatar
 
Dries committed
154 155 156
    case "themes":
     $form = system_view_themes();
      break;
Dries's avatar
 
Dries committed
157
    default:
Dries's avatar
 
Dries committed
158 159
      foreach (module_list() as $name) {
        if (module_hook($name, "conf_options")) {
Dries's avatar
 
Dries committed
160
          $links[] = "<a href=\"#$name\">". t("$name") ."</a>";
Dries's avatar
 
Dries committed
161 162
        }
      }
Dries's avatar
 
Dries committed
163
      $form = system_view_modules();
Dries's avatar
 
Dries committed
164 165
  }

Dries's avatar
 
Dries committed
166 167
  $form .= form_submit(t("Save configuration"));
  $form .= form_submit(t("Reset to defaults"));
Dries's avatar
 
Dries committed
168

Dries's avatar
 
Dries committed
169
  print implode(" &middot; ", $links) ."<br />". form($form);
Dries's avatar
 
Dries committed
170 171
}

Dries's avatar
 
Dries committed
172 173 174
function system_dirscan($dir, $mask, $nomask = array(".", "..", "CVS")) {
  $files = array();
  if (is_dir($dir) && $handle = opendir($dir)) {
175
    while ($file = readdir($handle)) {
Dries's avatar
 
Dries committed
176 177 178 179 180 181 182 183 184
      if (!in_array($file, $nomask)) {
        if (is_dir("$dir/$file")) {
          $files = array_merge($files, system_dirscan("$dir/$file", $mask, $nomask));
        }
        elseif (ereg($mask, $file)) {
          $name = basename($file);
          $files["$dir/$file"]->filename = "$dir/$file";
          $files["$dir/$file"]->name = substr($name, 0, strrpos($name, '.'));
        }
185 186 187 188
      }
    }
    closedir($handle);
  }
Dries's avatar
 
Dries committed
189 190
  return $files;
}
191

Dries's avatar
 
Dries committed
192 193 194
function system_listing($type, $directory, $required = array()) {
  // Make sure we set $type correctly
  $type = $type != 'theme' ? "module" : "theme";
Dries's avatar
 
Dries committed
195

Dries's avatar
 
Dries committed
196 197
  // Find files in the directory.
  $files = system_dirscan($directory, "\.$type$");
198

Dries's avatar
 
Dries committed
199 200 201 202 203 204 205
  // Extract current files from database.
  $result = db_query("SELECT filename, type, status FROM system WHERE type = '%s'", $type);
  while ($file = db_fetch_object($result)) {
    if (is_object($files[$file->filename])) {
      foreach ($file as $key => $value) {
        $files[$file->filename]->$key = $value;
      }
206
    }
Dries's avatar
 
Dries committed
207 208
  }

Dries's avatar
 
Dries committed
209
  ksort($files);
210

Dries's avatar
 
Dries committed
211
  $header = array(t("name"), t("description"), t("status"));
Dries's avatar
 
Dries committed
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227

  foreach ($files as $filename => $file) {
    include_once($filename);
    if ($type == "module") {
      $info->name = module_invoke($file->name, "system", "name") ? module_invoke($file->name, "system", "name") : $file->name;
      $info->description = module_invoke($file->name, "system", "description");
    }
    elseif ($type == "theme") {
      $class = "Theme_$file->name";
      if (class_exists($class)) {
        $theme =& new $class;
        $info->name = $theme->system("name") ? $theme->system("name") : $file->name;
        $info->description = $theme->system("description");
      }
      else {
        unset($files[$filename]);
228 229 230
      }
    }

Dries's avatar
 
Dries committed
231
    // Update the contents of the system table:
232
    db_query("DELETE FROM system WHERE filename = '%s' AND type = '%s'", $filename, $type);
Dries's avatar
 
Dries committed
233
    db_query("INSERT INTO system (name, description, type, filename, status) VALUES ('%s', '%s', '%s', '%s', %d)", $info->name, $info->description, $type, $filename, $file->status);
234

Dries's avatar
 
Dries committed
235
    $rows[] = 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"));
236
  }
Dries's avatar
 
Dries committed
237 238

  $output = table($header, $rows) . form_submit(t("Save $type settings"));
239

Dries's avatar
 
Dries committed
240 241 242
  print form($output);

  return $message;
Dries's avatar
 
Dries committed
243 244 245
}

function system_admin() {
Dries's avatar
 
Dries committed
246
  global $op, $edit;
Dries's avatar
 
Dries committed
247

Dries's avatar
 
Dries committed
248
  if (user_access("administer site configuration")) {
Dries's avatar
 
Dries committed
249 250 251 252

    // NOTE: changing this also requires changing module_init() @ "includes/module.inc".
    $required = array("modules/admin.module", "modules/user.module", "modules/system.module", "modules/watchdog.module");

Dries's avatar
 
Dries committed
253 254 255 256
    if (empty($op)) {
      $op = arg(2);
    }

Dries's avatar
 
Dries committed
257 258
    switch ($op) {
      case "help":
Dries's avatar
 
Dries committed
259
        print system_help();
Dries's avatar
 
Dries committed
260 261
        break;
      case "modules":
Dries's avatar
 
Dries committed
262
        if (arg(3) == "settings") {
Dries's avatar
 
Dries committed
263
          print system_view("modules");
264
        }
Dries's avatar
 
Dries committed
265
        else {
Dries's avatar
 
Dries committed
266
          print system_listing("module", "modules", $required);
Dries's avatar
 
Dries committed
267 268
        }
        break;
269
      case "themes":
Dries's avatar
 
Dries committed
270
        if (arg(3) == "settings") {
Dries's avatar
 
Dries committed
271
          print system_view("themes");
Dries's avatar
 
Dries committed
272 273
        }
        else {
Dries's avatar
 
Dries committed
274
          print system_listing("theme", "themes");
Dries's avatar
 
Dries committed
275
        }
276
        break;
Dries's avatar
 
Dries committed
277 278 279 280 281 282 283 284
      case t("Save module settings"):
        print status(system_save_selector("module", $edit));
        print system_listing("module", "modules", $required);
        break;
      case t("Save theme settings"):
        print status(system_save_selector("theme", $edit));
        print system_listing("theme", "themes");
        break;
Dries's avatar
 
Dries committed
285
      case t("Reset to defaults"):
Dries's avatar
 
Dries committed
286
        print status(system_reset_default($edit));
Dries's avatar
 
Dries committed
287
        print system_view(arg(2));
Dries's avatar
 
Dries committed
288
        break;
Dries's avatar
 
Dries committed
289
      case t("Save configuration"):
Dries's avatar
 
Dries committed
290
        print status(system_save_settings($edit));
Dries's avatar
 
Dries committed
291
        print system_view(arg(2));
Dries's avatar
 
Dries committed
292 293
        break;
      default:
Dries's avatar
 
Dries committed
294
        print system_view(arg(2));
Dries's avatar
 
Dries committed
295 296 297 298 299 300
    }
  }
  else {
    print message_access();
  }
}
Dries's avatar
 
Dries committed
301

Dries's avatar
 
Dries committed
302
?>