Projet

Général

Profil

Paste
Télécharger (115 ko) Statistiques
| Branche: | Révision:

root / drupal7 / modules / system / system.admin.inc @ cd5c298a

1
<?php
2

    
3
/**
4
 * @file
5
 * Admin page callbacks for the system module.
6
 */
7

    
8
/**
9
 * Menu callback; Provide the administration overview page.
10
 */
11
function system_admin_config_page() {
12
  // Check for status report errors.
13
  if (system_status(TRUE) && user_access('administer site configuration')) {
14
    drupal_set_message(t('One or more problems were detected with your Drupal installation. Check the <a href="@status">status report</a> for more information.', array('@status' => url('admin/reports/status'))), 'error');
15
  }
16
  $blocks = array();
17
  if ($admin = db_query("SELECT menu_name, mlid FROM {menu_links} WHERE link_path = 'admin/config' AND module = 'system'")->fetchAssoc()) {
18
    $result = db_query("
19
      SELECT m.*, ml.*
20
      FROM {menu_links} ml
21
      INNER JOIN {menu_router} m ON ml.router_path = m.path
22
      WHERE ml.link_path <> 'admin/help' AND menu_name = :menu_name AND ml.plid = :mlid AND hidden = 0", $admin, array('fetch' => PDO::FETCH_ASSOC));
23
    foreach ($result as $item) {
24
      _menu_link_translate($item);
25
      if (!$item['access']) {
26
        continue;
27
      }
28
      // The link description, either derived from 'description' in hook_menu()
29
      // or customized via menu module is used as title attribute.
30
      if (!empty($item['localized_options']['attributes']['title'])) {
31
        $item['description'] = $item['localized_options']['attributes']['title'];
32
        unset($item['localized_options']['attributes']['title']);
33
      }
34
      $block = $item;
35
      $block['content'] = '';
36
      $block['content'] .= theme('admin_block_content', array('content' => system_admin_menu_block($item)));
37
      if (!empty($block['content'])) {
38
        $block['show'] = TRUE;
39
      }
40

    
41
      // Prepare for sorting as in function _menu_tree_check_access().
42
      // The weight is offset so it is always positive, with a uniform 5-digits.
43
      $blocks[(50000 + $item['weight']) . ' ' . $item['title'] . ' ' . $item['mlid']] = $block;
44
    }
45
  }
46
  if ($blocks) {
47
    ksort($blocks);
48
    return theme('admin_page', array('blocks' => $blocks));
49
  }
50
  else {
51
    return t('You do not have any administrative items.');
52
  }
53
}
54

    
55
/**
56
 * Provide a single block from the administration menu as a page.
57
 *
58
 * This function is often a destination for these blocks.
59
 * For example, 'admin/structure/types' needs to have a destination to be valid
60
 * in the Drupal menu system, but too much information there might be
61
 * hidden, so we supply the contents of the block.
62
 *
63
 * @return
64
 *   The output HTML.
65
 */
66
function system_admin_menu_block_page() {
67
  $item = menu_get_item();
68
  if ($content = system_admin_menu_block($item)) {
69
    $output = theme('admin_block_content', array('content' => $content));
70
  }
71
  else {
72
    $output = t('You do not have any administrative items.');
73
  }
74
  return $output;
75
}
76

    
77
/**
78
 * Menu callback; prints a listing of admin tasks, organized by module.
79
 */
80
function system_admin_index() {
81
  $module_info = system_get_info('module');
82
  foreach ($module_info as $module => $info) {
83
    $module_info[$module] = new stdClass();
84
    $module_info[$module]->info = $info;
85
  }
86
  uasort($module_info, 'system_sort_modules_by_info_name');
87
  $menu_items = array();
88

    
89
  foreach ($module_info as $module => $info) {
90
    // Only display a section if there are any available tasks.
91
    if ($admin_tasks = system_get_module_admin_tasks($module, $info->info)) {
92
      // Sort links by title.
93
      uasort($admin_tasks, 'drupal_sort_title');
94
      // Move 'Configure permissions' links to the bottom of each section.
95
      $permission_key = "admin/people/permissions#module-$module";
96
      if (isset($admin_tasks[$permission_key])) {
97
        $permission_task = $admin_tasks[$permission_key];
98
        unset($admin_tasks[$permission_key]);
99
        $admin_tasks[$permission_key] = $permission_task;
100
      }
101

    
102
      $menu_items[$info->info['name']] = array($info->info['description'], $admin_tasks);
103
    }
104
  }
105
  return theme('system_admin_index', array('menu_items' => $menu_items));
106
}
107

    
108
/**
109
 * Displays the configuration overview page.
110
 *
111
 * This menu callback implementation is a legacy function that used to display
112
 * the configuration overview page at admin/config. It is currently unused and
113
 * will be removed in Drupal 8. The page at admin/config is now generated by
114
 * system_admin_config_page().
115
 *
116
 * @deprecated
117
 * @see system_admin_config_page()
118
 */
119
function system_settings_overview() {
120
  // Check database setup if necessary
121
  if (function_exists('db_check_setup') && empty($_POST)) {
122
    db_check_setup();
123
  }
124

    
125
  $item = menu_get_item('admin/config');
126
  $content = system_admin_menu_block($item);
127

    
128
  $output = theme('admin_block_content', array('content' => $content));
129

    
130
  return $output;
131
}
132

    
133
/**
134
 * Menu callback; displays a listing of all themes.
135
 */
136
function system_themes_page() {
137
  // Get current list of themes.
138
  $themes = system_rebuild_theme_data();
139
  uasort($themes, 'system_sort_modules_by_info_name');
140

    
141
  $theme_default = variable_get('theme_default', 'bartik');
142
  $theme_groups  = array();
143

    
144
  foreach ($themes as &$theme) {
145
    if (!empty($theme->info['hidden'])) {
146
      continue;
147
    }
148
    $admin_theme_options[$theme->name] = $theme->info['name'];
149
    $theme->is_default = ($theme->name == $theme_default);
150

    
151
    // Identify theme screenshot.
152
    $theme->screenshot = NULL;
153
    // Create a list which includes the current theme and all its base themes.
154
    if (isset($themes[$theme->name]->base_themes)) {
155
      $theme_keys = array_keys($themes[$theme->name]->base_themes);
156
      $theme_keys[] = $theme->name;
157
    }
158
    else {
159
      $theme_keys = array($theme->name);
160
    }
161
    // Look for a screenshot in the current theme or in its closest ancestor.
162
    foreach (array_reverse($theme_keys) as $theme_key) {
163
      if (isset($themes[$theme_key]) && file_exists($themes[$theme_key]->info['screenshot'])) {
164
        $theme->screenshot = array(
165
          'path' => $themes[$theme_key]->info['screenshot'],
166
          'alt' => t('Screenshot for !theme theme', array('!theme' => $theme->info['name'])),
167
          'title' => t('Screenshot for !theme theme', array('!theme' => $theme->info['name'])),
168
          'attributes' => array('class' => array('screenshot')),
169
        );
170
        break;
171
      }
172
    }
173

    
174
    if (empty($theme->status)) {
175
     // Ensure this theme is compatible with this version of core.
176
     // Require the 'content' region to make sure the main page
177
     // content has a common place in all themes.
178
      $theme->incompatible_core = !isset($theme->info['core']) || ($theme->info['core'] != DRUPAL_CORE_COMPATIBILITY) || (!isset($theme->info['regions']['content']));
179
      $theme->incompatible_php = version_compare(phpversion(), $theme->info['php']) < 0;
180
    }
181
    $query['token'] = drupal_get_token('system-theme-operation-link');
182
    $theme->operations = array();
183
    if (!empty($theme->status) || !$theme->incompatible_core && !$theme->incompatible_php) {
184
      // Create the operations links.
185
      $query['theme'] = $theme->name;
186
      if (drupal_theme_access($theme)) {
187
        $theme->operations[] = array(
188
          'title' => t('Settings'),
189
          'href' => 'admin/appearance/settings/' . $theme->name,
190
          'attributes' => array('title' => t('Settings for !theme theme', array('!theme' => $theme->info['name']))),
191
        );
192
      }
193
      if (!empty($theme->status)) {
194
        if (!$theme->is_default) {
195
          $theme->operations[] = array(
196
            'title' => t('Disable'),
197
            'href' => 'admin/appearance/disable',
198
            'query' => $query,
199
            'attributes' => array('title' => t('Disable !theme theme', array('!theme' => $theme->info['name']))),
200
          );
201
          $theme->operations[] = array(
202
            'title' => t('Set default'),
203
            'href' => 'admin/appearance/default',
204
            'query' => $query,
205
            'attributes' => array('title' => t('Set !theme as default theme', array('!theme' => $theme->info['name']))),
206
          );
207
        }
208
      }
209
      else {
210
        $theme->operations[] = array(
211
          'title' => t('Enable'),
212
          'href' => 'admin/appearance/enable',
213
          'query' => $query,
214
          'attributes' => array('title' => t('Enable !theme theme', array('!theme' => $theme->info['name']))),
215
        );
216
        $theme->operations[] = array(
217
          'title' => t('Enable and set default'),
218
          'href' => 'admin/appearance/default',
219
          'query' => $query,
220
          'attributes' => array('title' => t('Enable !theme as default theme', array('!theme' => $theme->info['name']))),
221
        );
222
      }
223
    }
224

    
225
    // Add notes to default and administration theme.
226
    $theme->notes = array();
227
    $theme->classes = array();
228
    if ($theme->is_default) {
229
      $theme->classes[] = 'theme-default';
230
      $theme->notes[] = t('default theme');
231
    }
232

    
233
    // Sort enabled and disabled themes into their own groups.
234
    $theme_groups[$theme->status ? 'enabled' : 'disabled'][] = $theme;
235
  }
236

    
237
  // There are two possible theme groups.
238
  $theme_group_titles = array(
239
    'enabled' => format_plural(count($theme_groups['enabled']), 'Enabled theme', 'Enabled themes'),
240
  );
241
  if (!empty($theme_groups['disabled'])) {
242
    $theme_group_titles['disabled'] = format_plural(count($theme_groups['disabled']), 'Disabled theme', 'Disabled themes');
243
  }
244

    
245
  uasort($theme_groups['enabled'], 'system_sort_themes');
246
  drupal_alter('system_themes_page', $theme_groups);
247

    
248
  $admin_form = drupal_get_form('system_themes_admin_form', $admin_theme_options);
249
  return theme('system_themes_page', array('theme_groups' => $theme_groups, 'theme_group_titles' => $theme_group_titles)) . drupal_render($admin_form);
250
}
251

    
252
/**
253
 * Form to select the administration theme.
254
 *
255
 * @ingroup forms
256
 * @see system_themes_admin_form_submit()
257
 */
258
function system_themes_admin_form($form, &$form_state, $theme_options) {
259
  // Administration theme settings.
260
  $form['admin_theme'] = array(
261
    '#type' => 'fieldset',
262
    '#title' => t('Administration theme'),
263
  );
264
  $form['admin_theme']['admin_theme'] = array(
265
    '#type' => 'select',
266
    '#options' => array(0 => t('Default theme')) + $theme_options,
267
    '#title' => t('Administration theme'),
268
    '#description' => t('Choose "Default theme" to always use the same theme as the rest of the site.'),
269
    '#default_value' => variable_get('admin_theme', 0),
270
  );
271
  $form['admin_theme']['node_admin_theme'] = array(
272
    '#type' => 'checkbox',
273
    '#title' => t('Use the administration theme when editing or creating content'),
274
    '#default_value' => variable_get('node_admin_theme', '0'),
275
  );
276
  $form['admin_theme']['actions'] = array('#type' => 'actions');
277
  $form['admin_theme']['actions']['submit'] = array(
278
    '#type' => 'submit',
279
    '#value' => t('Save configuration'),
280
  );
281
  return $form;
282
}
283

    
284
/**
285
 * Process system_themes_admin_form form submissions.
286
 */
287
function system_themes_admin_form_submit($form, &$form_state) {
288
  drupal_set_message(t('The configuration options have been saved.'));
289
  variable_set('admin_theme', $form_state['values']['admin_theme']);
290
  variable_set('node_admin_theme', $form_state['values']['node_admin_theme']);
291
}
292

    
293
/**
294
 * Menu callback; Enables a theme.
295
 */
296
function system_theme_enable() {
297
  if (isset($_REQUEST['theme']) && isset($_REQUEST['token']) && drupal_valid_token($_REQUEST['token'], 'system-theme-operation-link')) {
298
    $theme = $_REQUEST['theme'];
299
    // Get current list of themes.
300
    $themes = list_themes();
301

    
302
    // Check if the specified theme is one recognized by the system.
303
    if (!empty($themes[$theme])) {
304
      theme_enable(array($theme));
305
      drupal_set_message(t('The %theme theme has been enabled.', array('%theme' => $themes[$theme]->info['name'])));
306
    }
307
    else {
308
      drupal_set_message(t('The %theme theme was not found.', array('%theme' => $theme)), 'error');
309
    }
310
    drupal_goto('admin/appearance');
311
  }
312
  return MENU_ACCESS_DENIED;
313
}
314

    
315
/**
316
 * Menu callback; Disables a theme.
317
 */
318
function system_theme_disable() {
319
  if (isset($_REQUEST['theme']) && isset($_REQUEST['token']) && drupal_valid_token($_REQUEST['token'], 'system-theme-operation-link')) {
320
    $theme = $_REQUEST['theme'];
321
    // Get current list of themes.
322
    $themes = list_themes();
323

    
324
    // Check if the specified theme is one recognized by the system.
325
    if (!empty($themes[$theme])) {
326
      if ($theme == variable_get('theme_default', 'bartik')) {
327
        // Don't disable the default theme.
328
        drupal_set_message(t('%theme is the default theme and cannot be disabled.', array('%theme' => $themes[$theme]->info['name'])), 'error');
329
      }
330
      else {
331
        theme_disable(array($theme));
332
        drupal_set_message(t('The %theme theme has been disabled.', array('%theme' => $themes[$theme]->info['name'])));
333
      }
334
    }
335
    else {
336
      drupal_set_message(t('The %theme theme was not found.', array('%theme' => $theme)), 'error');
337
    }
338
    drupal_goto('admin/appearance');
339
  }
340
  return MENU_ACCESS_DENIED;
341
}
342

    
343
/**
344
 * Menu callback; Set the default theme.
345
 */
346
function system_theme_default() {
347
  if (isset($_REQUEST['theme']) && isset($_REQUEST['token']) && drupal_valid_token($_REQUEST['token'], 'system-theme-operation-link')) {
348
    $theme = $_REQUEST['theme'];
349
    // Get current list of themes.
350
    $themes = list_themes();
351

    
352
    // Check if the specified theme is one recognized by the system.
353
    if (!empty($themes[$theme])) {
354
      // Enable the theme if it is currently disabled.
355
      if (empty($themes[$theme]->status)) {
356
       theme_enable(array($theme));
357
      }
358
      // Set the default theme.
359
      variable_set('theme_default', $theme);
360

    
361
      // Rebuild the menu. This duplicates the menu_rebuild() in theme_enable().
362
      // However, modules must know the current default theme in order to use
363
      // this information in hook_menu() or hook_menu_alter() implementations,
364
      // and doing the variable_set() before the theme_enable() could result
365
      // in a race condition where the theme is default but not enabled.
366
      menu_rebuild();
367

    
368
      // The status message depends on whether an admin theme is currently in use:
369
      // a value of 0 means the admin theme is set to be the default theme.
370
      $admin_theme = variable_get('admin_theme', 0);
371
      if ($admin_theme != 0 && $admin_theme != $theme) {
372
        drupal_set_message(t('Please note that the administration theme is still set to the %admin_theme theme; consequently, the theme on this page remains unchanged. All non-administrative sections of the site, however, will show the selected %selected_theme theme by default.', array(
373
          '%admin_theme' => $themes[$admin_theme]->info['name'],
374
          '%selected_theme' => $themes[$theme]->info['name'],
375
        )));
376
      }
377
      else {
378
        drupal_set_message(t('%theme is now the default theme.', array('%theme' => $themes[$theme]->info['name'])));
379
      }
380
    }
381
    else {
382
      drupal_set_message(t('The %theme theme was not found.', array('%theme' => $theme)), 'error');
383
    }
384
    drupal_goto('admin/appearance');
385
  }
386
  return MENU_ACCESS_DENIED;
387
}
388

    
389
/**
390
 * Form builder; display theme configuration for entire site and individual themes.
391
 *
392
 * @param $key
393
 *   A theme name.
394
 * @return
395
 *   The form structure.
396
 * @ingroup forms
397
 * @see system_theme_settings_submit()
398
 */
399
function system_theme_settings($form, &$form_state, $key = '') {
400
  // Default settings are defined in theme_get_setting() in includes/theme.inc
401
  if ($key) {
402
    $var = 'theme_' . $key . '_settings';
403
    $themes = list_themes();
404
    $features = $themes[$key]->info['features'];
405
  }
406
  else {
407
    $var = 'theme_settings';
408
  }
409

    
410
  $form['var'] = array('#type' => 'hidden', '#value' => $var);
411

    
412
  // Toggle settings
413
  $toggles = array(
414
    'logo'                      => t('Logo'),
415
    'name'                      => t('Site name'),
416
    'slogan'                    => t('Site slogan'),
417
    'node_user_picture'         => t('User pictures in posts'),
418
    'comment_user_picture'      => t('User pictures in comments'),
419
    'comment_user_verification' => t('User verification status in comments'),
420
    'favicon'                   => t('Shortcut icon'),
421
    'main_menu'                 => t('Main menu'),
422
    'secondary_menu'            => t('Secondary menu'),
423
  );
424

    
425
  // Some features are not always available
426
  $disabled = array();
427
  if (!variable_get('user_pictures', 0)) {
428
    $disabled['toggle_node_user_picture'] = TRUE;
429
    $disabled['toggle_comment_user_picture'] = TRUE;
430
  }
431
  if (!module_exists('comment')) {
432
    $disabled['toggle_comment_user_picture'] = TRUE;
433
    $disabled['toggle_comment_user_verification'] = TRUE;
434
  }
435

    
436
  $form['theme_settings'] = array(
437
    '#type' => 'fieldset',
438
    '#title' => t('Toggle display'),
439
    '#description' => t('Enable or disable the display of certain page elements.'),
440
  );
441
  foreach ($toggles as $name => $title) {
442
    if ((!$key) || in_array($name, $features)) {
443
      $form['theme_settings']['toggle_' . $name] = array('#type' => 'checkbox', '#title' => $title, '#default_value' => theme_get_setting('toggle_' . $name, $key));
444
      // Disable checkboxes for features not supported in the current configuration.
445
      if (isset($disabled['toggle_' . $name])) {
446
        $form['theme_settings']['toggle_' . $name]['#disabled'] = TRUE;
447
      }
448
    }
449
  }
450

    
451
  if (!element_children($form['theme_settings'])) {
452
    // If there is no element in the theme settings fieldset then do not show
453
    // it -- but keep it in the form if another module wants to alter.
454
    $form['theme_settings']['#access'] = FALSE;
455
  }
456

    
457
  // Logo settings
458
  if ((!$key) || in_array('logo', $features)) {
459
    $form['logo'] = array(
460
      '#type' => 'fieldset',
461
      '#title' => t('Logo image settings'),
462
      '#description' => t('If toggled on, the following logo will be displayed.'),
463
      '#attributes' => array('class' => array('theme-settings-bottom')),
464
    );
465
    $form['logo']['default_logo'] = array(
466
      '#type' => 'checkbox',
467
      '#title' => t('Use the default logo'),
468
      '#default_value' => theme_get_setting('default_logo', $key),
469
      '#tree' => FALSE,
470
      '#description' => t('Check here if you want the theme to use the logo supplied with it.')
471
    );
472
    $form['logo']['settings'] = array(
473
      '#type' => 'container',
474
      '#states' => array(
475
        // Hide the logo settings when using the default logo.
476
        'invisible' => array(
477
          'input[name="default_logo"]' => array('checked' => TRUE),
478
        ),
479
      ),
480
    );
481
    $form['logo']['settings']['logo_path'] = array(
482
      '#type' => 'textfield',
483
      '#title' => t('Path to custom logo'),
484
      '#description' => t('The path to the file you would like to use as your logo file instead of the default logo.'),
485
      '#default_value' => theme_get_setting('logo_path', $key),
486
    );
487
    $form['logo']['settings']['logo_upload'] = array(
488
      '#type' => 'file',
489
      '#title' => t('Upload logo image'),
490
      '#maxlength' => 40,
491
      '#description' => t("If you don't have direct file access to the server, use this field to upload your logo.")
492
    );
493
  }
494

    
495
  if ((!$key) || in_array('favicon', $features)) {
496
    $form['favicon'] = array(
497
      '#type' => 'fieldset',
498
      '#title' => t('Shortcut icon settings'),
499
      '#description' => t("Your shortcut icon, or 'favicon', is displayed in the address bar and bookmarks of most browsers."),
500
    );
501
    $form['favicon']['default_favicon'] = array(
502
      '#type' => 'checkbox',
503
      '#title' => t('Use the default shortcut icon.'),
504
      '#default_value' => theme_get_setting('default_favicon', $key),
505
      '#description' => t('Check here if you want the theme to use the default shortcut icon.')
506
    );
507
    $form['favicon']['settings'] = array(
508
      '#type' => 'container',
509
      '#states' => array(
510
        // Hide the favicon settings when using the default favicon.
511
        'invisible' => array(
512
          'input[name="default_favicon"]' => array('checked' => TRUE),
513
        ),
514
      ),
515
    );
516
    $form['favicon']['settings']['favicon_path'] = array(
517
      '#type' => 'textfield',
518
      '#title' => t('Path to custom icon'),
519
      '#description' => t('The path to the image file you would like to use as your custom shortcut icon.'),
520
      '#default_value' => theme_get_setting('favicon_path', $key),
521
    );
522
    $form['favicon']['settings']['favicon_upload'] = array(
523
      '#type' => 'file',
524
      '#title' => t('Upload icon image'),
525
      '#description' => t("If you don't have direct file access to the server, use this field to upload your shortcut icon.")
526
    );
527
  }
528

    
529
  // Inject human-friendly values for logo and favicon.
530
  foreach (array('logo' => 'logo.png', 'favicon' => 'favicon.ico') as $type => $default) {
531
    if (isset($form[$type]['settings'][$type . '_path'])) {
532
      $element = &$form[$type]['settings'][$type . '_path'];
533

    
534
      // If path is a public:// URI, display the path relative to the files
535
      // directory; stream wrappers are not end-user friendly.
536
      $original_path = $element['#default_value'];
537
      $friendly_path = NULL;
538
      if (file_uri_scheme($original_path) == 'public') {
539
        $friendly_path = file_uri_target($original_path);
540
        $element['#default_value'] = $friendly_path;
541
      }
542
    }
543
  }
544

    
545
  if ($key) {
546
    // Call engine-specific settings.
547
    $function = $themes[$key]->prefix . '_engine_settings';
548
    if (function_exists($function)) {
549
      $form['engine_specific'] = array(
550
        '#type' => 'fieldset',
551
        '#title' => t('Theme-engine-specific settings'),
552
        '#description' => t('These settings only exist for the themes based on the %engine theme engine.', array('%engine' => $themes[$key]->prefix)),
553
      );
554
      $function($form, $form_state);
555
    }
556

    
557
    // Create a list which includes the current theme and all its base themes.
558
    if (isset($themes[$key]->base_themes)) {
559
      $theme_keys = array_keys($themes[$key]->base_themes);
560
      $theme_keys[] = $key;
561
    }
562
    else {
563
      $theme_keys = array($key);
564
    }
565

    
566
    // Save the name of the current theme (if any), so that we can temporarily
567
    // override the current theme and allow theme_get_setting() to work
568
    // without having to pass the theme name to it.
569
    $default_theme = !empty($GLOBALS['theme_key']) ? $GLOBALS['theme_key'] : NULL;
570
    $GLOBALS['theme_key'] = $key;
571

    
572
    // Process the theme and all its base themes.
573
    foreach ($theme_keys as $theme) {
574
      // Include the theme-settings.php file.
575
      $theme_settings_path = drupal_get_path('theme', $theme) . '/theme-settings.php';
576
      if (file_exists(DRUPAL_ROOT . '/' . $theme_settings_path)) {
577
        require_once DRUPAL_ROOT . '/' . $theme_settings_path;
578
        $form_state['build_info']['files'][] = $theme_settings_path;
579
      }
580

    
581
      // Call theme-specific settings.
582
      $function = $theme . '_form_system_theme_settings_alter';
583
      if (function_exists($function)) {
584
        $function($form, $form_state);
585
      }
586
    }
587

    
588
    // Restore the original current theme.
589
    if (isset($default_theme)) {
590
      $GLOBALS['theme_key'] = $default_theme;
591
    }
592
    else {
593
      unset($GLOBALS['theme_key']);
594
    }
595
  }
596

    
597
  $form = system_settings_form($form);
598
  // We don't want to call system_settings_form_submit(), so change #submit.
599
  array_pop($form['#submit']);
600
  $form['#submit'][] = 'system_theme_settings_submit';
601
  $form['#validate'][] = 'system_theme_settings_validate';
602
  return $form;
603
}
604

    
605
/**
606
 * Validator for the system_theme_settings() form.
607
 */
608
function system_theme_settings_validate($form, &$form_state) {
609
  // Handle file uploads.
610
  $validators = array('file_validate_is_image' => array());
611

    
612
  // Check for a new uploaded logo.
613
  $file = file_save_upload('logo_upload', $validators);
614
  if (isset($file)) {
615
    // File upload was attempted.
616
    if ($file) {
617
      // Put the temporary file in form_values so we can save it on submit.
618
      $form_state['values']['logo_upload'] = $file;
619
    }
620
    else {
621
      // File upload failed.
622
      form_set_error('logo_upload', t('The logo could not be uploaded.'));
623
    }
624
  }
625

    
626
  $validators = array('file_validate_extensions' => array('ico png gif jpg jpeg apng svg'));
627

    
628
  // Check for a new uploaded favicon.
629
  $file = file_save_upload('favicon_upload', $validators);
630
  if (isset($file)) {
631
    // File upload was attempted.
632
    if ($file) {
633
      // Put the temporary file in form_values so we can save it on submit.
634
      $form_state['values']['favicon_upload'] = $file;
635
    }
636
    else {
637
      // File upload failed.
638
      form_set_error('favicon_upload', t('The favicon could not be uploaded.'));
639
    }
640
  }
641

    
642
  // If the user provided a path for a logo or favicon file, make sure a file
643
  // exists at that path.
644
  if (!empty($form_state['values']['logo_path'])) {
645
    $path = _system_theme_settings_validate_path($form_state['values']['logo_path']);
646
    if (!$path) {
647
      form_set_error('logo_path', t('The custom logo path is invalid.'));
648
    }
649
  }
650
  if (!empty($form_state['values']['favicon_path'])) {
651
    $path = _system_theme_settings_validate_path($form_state['values']['favicon_path']);
652
    if (!$path) {
653
      form_set_error('favicon_path', t('The custom favicon path is invalid.'));
654
    }
655
  }
656
}
657

    
658
/**
659
 * Helper function for the system_theme_settings form.
660
 *
661
 * Attempts to validate normal system paths, paths relative to the public files
662
 * directory, or stream wrapper URIs. If the given path is any of the above,
663
 * returns a valid path or URI that the theme system can display.
664
 *
665
 * @param $path
666
 *   A path relative to the Drupal root or to the public files directory, or
667
 *   a stream wrapper URI.
668
 * @return mixed
669
 *   A valid path that can be displayed through the theme system, or FALSE if
670
 *   the path could not be validated.
671
 */
672
function _system_theme_settings_validate_path($path) {
673
  // Absolute local file paths are invalid.
674
  if (drupal_realpath($path) == $path) {
675
    return FALSE;
676
  }
677
  // A path relative to the Drupal root or a fully qualified URI is valid.
678
  if (is_file($path)) {
679
    return $path;
680
  }
681
  // Prepend 'public://' for relative file paths within public filesystem.
682
  if (file_uri_scheme($path) === FALSE) {
683
    $path = 'public://' . $path;
684
  }
685
  if (is_file($path)) {
686
    return $path;
687
  }
688
  return FALSE;
689
}
690

    
691
/**
692
 * Process system_theme_settings form submissions.
693
 */
694
function system_theme_settings_submit($form, &$form_state) {
695
  // Exclude unnecessary elements before saving.
696
  form_state_values_clean($form_state);
697

    
698
  $values = $form_state['values'];
699

    
700
  // Extract the name of the theme from the submitted form values, then remove
701
  // it from the array so that it is not saved as part of the variable.
702
  $key = $values['var'];
703
  unset($values['var']);
704

    
705
  // If the user uploaded a new logo or favicon, save it to a permanent location
706
  // and use it in place of the default theme-provided file.
707
  if (!empty($values['logo_upload'])) {
708
    $file = $values['logo_upload'];
709
    unset($values['logo_upload']);
710
    $filename = file_unmanaged_copy($file->uri);
711
    $values['default_logo'] = 0;
712
    $values['logo_path'] = $filename;
713
    $values['toggle_logo'] = 1;
714
  }
715
  if (!empty($values['favicon_upload'])) {
716
    $file = $values['favicon_upload'];
717
    unset($values['favicon_upload']);
718
    $filename = file_unmanaged_copy($file->uri);
719
    $values['default_favicon'] = 0;
720
    $values['favicon_path'] = $filename;
721
    $values['toggle_favicon'] = 1;
722
  }
723

    
724
  // If the user entered a path relative to the system files directory for
725
  // a logo or favicon, store a public:// URI so the theme system can handle it.
726
  if (!empty($values['logo_path'])) {
727
    $values['logo_path'] = _system_theme_settings_validate_path($values['logo_path']);
728
  }
729
  if (!empty($values['favicon_path'])) {
730
    $values['favicon_path'] = _system_theme_settings_validate_path($values['favicon_path']);
731
  }
732

    
733
  if (empty($values['default_favicon']) && !empty($values['favicon_path'])) {
734
    $values['favicon_mimetype'] = file_get_mimetype($values['favicon_path']);
735
  }
736

    
737
  variable_set($key, $values);
738
  drupal_set_message(t('The configuration options have been saved.'));
739

    
740
  cache_clear_all();
741
}
742

    
743
/**
744
 * Recursively check compatibility.
745
 *
746
 * @param $incompatible
747
 *   An associative array which at the end of the check contains all
748
 *   incompatible files as the keys, their values being TRUE.
749
 * @param $files
750
 *   The set of files that will be tested.
751
 * @param $file
752
 *   The file at which the check starts.
753
 * @return
754
 *   Returns TRUE if an incompatible file is found, NULL (no return value)
755
 *   otherwise.
756
 */
757
function _system_is_incompatible(&$incompatible, $files, $file) {
758
  if (isset($incompatible[$file->name])) {
759
    return TRUE;
760
  }
761
  // Recursively traverse required modules, looking for incompatible modules.
762
  foreach ($file->requires as $requires) {
763
    if (isset($files[$requires]) && _system_is_incompatible($incompatible, $files, $files[$requires])) {
764
      $incompatible[$file->name] = TRUE;
765
      return TRUE;
766
    }
767
  }
768
}
769

    
770
/**
771
 * Menu callback; provides module enable/disable interface.
772
 *
773
 * The list of modules gets populated by module.info files, which contain each
774
 * module's name, description, and information about which modules it requires.
775
 * See drupal_parse_info_file() for information on module.info descriptors.
776
 *
777
 * Dependency checking is performed to ensure that a module:
778
 * - can not be enabled if there are disabled modules it requires.
779
 * - can not be disabled if there are enabled modules which depend on it.
780
 *
781
 * @param $form_state
782
 *   An associative array containing the current state of the form.
783
 *
784
 * @return
785
 *   The form array.
786
 *
787
 * @ingroup forms
788
 * @see theme_system_modules()
789
 * @see system_modules_submit()
790
 */
791
function system_modules($form, $form_state = array()) {
792
  // Get current list of modules.
793
  $files = system_rebuild_module_data();
794

    
795
  // Remove hidden modules from display list.
796
  $visible_files = $files;
797
  foreach ($visible_files as $filename => $file) {
798
    if (!empty($file->info['hidden'])) {
799
      unset($visible_files[$filename]);
800
    }
801
  }
802

    
803
  uasort($visible_files, 'system_sort_modules_by_info_name');
804

    
805
  // If the modules form was submitted, then system_modules_submit() runs first
806
  // and if there are unfilled required modules, then $form_state['storage'] is
807
  // filled, triggering a rebuild. In this case we need to display a
808
  // confirmation form.
809
  if (!empty($form_state['storage'])) {
810
    return system_modules_confirm_form($visible_files, $form_state['storage']);
811
  }
812

    
813
  $modules = array();
814
  $form['modules'] = array('#tree' => TRUE);
815

    
816
  // Used when checking if module implements a help page.
817
  $help_arg = module_exists('help') ? drupal_help_arg() : FALSE;
818

    
819
  // Used when displaying modules that are required by the installation profile.
820
  require_once DRUPAL_ROOT . '/includes/install.inc';
821
  $distribution_name = check_plain(drupal_install_profile_distribution_name());
822

    
823
  // Iterate through each of the modules.
824
  foreach ($visible_files as $filename => $module) {
825
    $extra = array();
826
    $extra['enabled'] = (bool) $module->status;
827
    if (!empty($module->info['required'] )) {
828
      $extra['disabled'] = TRUE;
829
      $extra['required_by'][] = $distribution_name . (!empty($module->info['explanation']) ? ' ('. $module->info['explanation'] .')' : '');
830
    }
831

    
832
    // If this module requires other modules, add them to the array.
833
    foreach ($module->requires as $requires => $v) {
834
      if (!isset($files[$requires])) {
835
        $extra['requires'][$requires] = t('@module (<span class="admin-missing">missing</span>)', array('@module' => drupal_ucfirst($requires)));
836
        $extra['disabled'] = TRUE;
837
      }
838
      // Only display visible modules.
839
      elseif (isset($visible_files[$requires])) {
840
        $requires_name = $files[$requires]->info['name'];
841
        // Disable this module if it is incompatible with the dependency's version.
842
        if ($incompatible_version = drupal_check_incompatibility($v, str_replace(DRUPAL_CORE_COMPATIBILITY . '-', '', $files[$requires]->info['version']))) {
843
          $extra['requires'][$requires] = t('@module (<span class="admin-missing">incompatible with</span> version @version)', array(
844
            '@module' => $requires_name . $incompatible_version,
845
            '@version' => $files[$requires]->info['version'],
846
          ));
847
          $extra['disabled'] = TRUE;
848
        }
849
        // Disable this module if the dependency is incompatible with this
850
        // version of Drupal core.
851
        elseif ($files[$requires]->info['core'] != DRUPAL_CORE_COMPATIBILITY) {
852
          $extra['requires'][$requires] = t('@module (<span class="admin-missing">incompatible with</span> this version of Drupal core)', array(
853
            '@module' => $requires_name,
854
          ));
855
          $extra['disabled'] = TRUE;
856
        }
857
        elseif ($files[$requires]->status) {
858
          $extra['requires'][$requires] = t('@module (<span class="admin-enabled">enabled</span>)', array('@module' => $requires_name));
859
        }
860
        else {
861
          $extra['requires'][$requires] = t('@module (<span class="admin-disabled">disabled</span>)', array('@module' => $requires_name));
862
        }
863
      }
864
    }
865
    // Generate link for module's help page, if there is one.
866
    if ($help_arg && $module->status && in_array($filename, module_implements('help'))) {
867
      if (module_invoke($filename, 'help', "admin/help#$filename", $help_arg)) {
868
        $extra['links']['help'] = array(
869
          '#type' => 'link',
870
          '#title' => t('Help'),
871
          '#href' => "admin/help/$filename",
872
          '#options' => array('attributes' => array('class' =>  array('module-link', 'module-link-help'), 'title' => t('Help'))),
873
        );
874
      }
875
    }
876
    // Generate link for module's permission, if the user has access to it.
877
    if ($module->status && user_access('administer permissions') && in_array($filename, module_implements('permission'))) {
878
      $extra['links']['permissions'] = array(
879
        '#type' => 'link',
880
        '#title' => t('Permissions'),
881
        '#href' => 'admin/people/permissions',
882
        '#options' => array('fragment' => 'module-' . $filename, 'attributes' => array('class' => array('module-link', 'module-link-permissions'), 'title' => t('Configure permissions'))),
883
      );
884
    }
885
    // Generate link for module's configuration page, if the module provides
886
    // one.
887
    if ($module->status && isset($module->info['configure'])) {
888
      $configure_link = menu_get_item($module->info['configure']);
889
      if ($configure_link['access']) {
890
        $extra['links']['configure'] = array(
891
          '#type' => 'link',
892
          '#title' => t('Configure'),
893
          '#href' => $configure_link['href'],
894
          '#options' => array('attributes' => array('class' => array('module-link', 'module-link-configure'), 'title' => $configure_link['description'])),
895
        );
896
      }
897
    }
898

    
899
    // If this module is required by other modules, list those, and then make it
900
    // impossible to disable this one.
901
    foreach ($module->required_by as $required_by => $v) {
902
      // Hidden modules are unset already.
903
      if (isset($visible_files[$required_by])) {
904
        if ($files[$required_by]->status == 1 && $module->status == 1) {
905
          $extra['required_by'][] = t('@module (<span class="admin-enabled">enabled</span>)', array('@module' => $files[$required_by]->info['name']));
906
          $extra['disabled'] = TRUE;
907
        }
908
        else {
909
          $extra['required_by'][] = t('@module (<span class="admin-disabled">disabled</span>)', array('@module' => $files[$required_by]->info['name']));
910
        }
911
      }
912
    }
913
    $form['modules'][$module->info['package']][$filename] = _system_modules_build_row($module->info, $extra);
914
  }
915

    
916
  // Add basic information to the fieldsets.
917
  foreach (element_children($form['modules']) as $package) {
918
    $form['modules'][$package] += array(
919
      '#type' => 'fieldset',
920
      '#title' => t($package),
921
      '#collapsible' => TRUE,
922
      '#theme' => 'system_modules_fieldset',
923
      '#header' => array(
924
        array('data' => t('Enabled'), 'class' => array('checkbox')),
925
        t('Name'),
926
        t('Version'),
927
        t('Description'),
928
        array('data' => t('Operations'), 'colspan' => 3),
929
      ),
930
      // Ensure that the "Core" package fieldset comes first.
931
      '#weight' => $package == 'Core' ? -10 : NULL,
932
    );
933
  }
934

    
935
  // Lastly, sort all fieldsets by title.
936
  uasort($form['modules'], 'element_sort_by_title');
937

    
938
  $form['actions'] = array('#type' => 'actions');
939
  $form['actions']['submit'] = array(
940
    '#type' => 'submit',
941
    '#value' => t('Save configuration'),
942
  );
943
  $form['#action'] = url('admin/modules/list/confirm');
944

    
945
  return $form;
946
}
947

    
948
/**
949
 * Array sorting callback; sorts modules or themes by their name.
950
 */
951
function system_sort_modules_by_info_name($a, $b) {
952
  return strcasecmp($a->info['name'], $b->info['name']);
953
}
954

    
955
/**
956
 * Sorts themes by their names, with the default theme listed first.
957
 *
958
 * Callback for uasort() within system_themes_page().
959
 *
960
 * @see system_sort_modules_by_info_name().
961
 */
962
function system_sort_themes($a, $b) {
963
  if ($a->is_default) {
964
    return -1;
965
  }
966
  if ($b->is_default) {
967
    return 1;
968
  }
969
  return strcasecmp($a->info['name'], $b->info['name']);
970
}
971

    
972
/**
973
 * Build a table row for the system modules page.
974
 */
975
function _system_modules_build_row($info, $extra) {
976
  // Add in the defaults.
977
  $extra += array(
978
    'requires' => array(),
979
    'required_by' => array(),
980
    'disabled' => FALSE,
981
    'enabled' => FALSE,
982
    'links' => array(),
983
  );
984
  $form = array(
985
    '#tree' => TRUE,
986
  );
987
  // Set the basic properties.
988
  $form['name'] = array(
989
    '#markup' => $info['name'],
990
  );
991
  $form['description'] = array(
992
    '#markup' => t($info['description']),
993
  );
994
  $form['version'] = array(
995
    '#markup' => $info['version'],
996
  );
997
  $form['#requires'] = $extra['requires'];
998
  $form['#required_by'] = $extra['required_by'];
999

    
1000
  // Check the compatibilities.
1001
  $compatible = TRUE;
1002
  $status_short = '';
1003
  $status_long = '';
1004

    
1005
  // Initialize empty arrays of long and short reasons explaining why the
1006
  // module is incompatible.
1007
  // Add each reason as a separate element in both the arrays.
1008
  $reasons_short = array();
1009
  $reasons_long = array();
1010

    
1011
  // Check the core compatibility.
1012
  if (!isset($info['core']) || $info['core'] != DRUPAL_CORE_COMPATIBILITY) {
1013
    $compatible = FALSE;
1014
    $reasons_short[] = t('Incompatible with this version of Drupal core.');
1015
    $reasons_long[] = t('This version is not compatible with Drupal !core_version and should be replaced.', array('!core_version' => DRUPAL_CORE_COMPATIBILITY));
1016
  }
1017

    
1018
  // Ensure this module is compatible with the currently installed version of PHP.
1019
  if (version_compare(phpversion(), $info['php']) < 0) {
1020
    $compatible = FALSE;
1021
    $reasons_short[] = t('Incompatible with this version of PHP');
1022
    $php_required = $info['php'];
1023
    if (substr_count($info['php'], '.') < 2) {
1024
      $php_required .= '.*';
1025
    }
1026
    $reasons_long[] = t('This module requires PHP version @php_required and is incompatible with PHP version !php_version.', array('@php_required' => $php_required, '!php_version' => phpversion()));
1027
  }
1028

    
1029
  // If this module is compatible, present a checkbox indicating
1030
  // this module may be installed. Otherwise, show a big red X.
1031
  if ($compatible) {
1032
    $form['enable'] = array(
1033
      '#type' => 'checkbox',
1034
      '#title' => t('Enable'),
1035
      '#default_value' => $extra['enabled'],
1036
    );
1037
    if ($extra['disabled']) {
1038
      $form['enable']['#disabled'] = TRUE;
1039
    }
1040
  }
1041
  else {
1042
    $status_short = implode(' ', $reasons_short);
1043
    $status_long = implode(' ', $reasons_long);
1044
    $form['enable'] = array(
1045
      '#markup' =>  theme('image', array('path' => 'misc/watchdog-error.png', 'alt' => $status_short, 'title' => $status_short)),
1046
    );
1047
    $form['description']['#markup'] .= theme('system_modules_incompatible', array('message' => $status_long));
1048
  }
1049

    
1050
  // Build operation links.
1051
  foreach (array('help', 'permissions', 'configure') as $key) {
1052
    $form['links'][$key] = (isset($extra['links'][$key]) ? $extra['links'][$key] : array());
1053
  }
1054

    
1055
  return $form;
1056
}
1057

    
1058
/**
1059
 * Display confirmation form for required modules.
1060
 *
1061
 * @param $modules
1062
 *   Array of module file objects as returned from system_rebuild_module_data().
1063
 * @param $storage
1064
 *   The contents of $form_state['storage']; an array with two
1065
 *   elements: the list of required modules and the list of status
1066
 *   form field values from the previous screen.
1067
 * @ingroup forms
1068
 */
1069
function system_modules_confirm_form($modules, $storage) {
1070
  $items = array();
1071

    
1072
  $form['validation_modules'] = array('#type' => 'value', '#value' => $modules);
1073
  $form['status']['#tree'] = TRUE;
1074

    
1075
  foreach ($storage['more_required'] as $info) {
1076
    $t_argument = array(
1077
      '@module' => $info['name'],
1078
      '@required' => implode(', ', $info['requires']),
1079
    );
1080
    $items[] = format_plural(count($info['requires']), 'You must enable the @required module to install @module.', 'You must enable the @required modules to install @module.', $t_argument);
1081
  }
1082

    
1083
  foreach ($storage['missing_modules'] as $name => $info) {
1084
    $t_argument = array(
1085
      '@module' => $name,
1086
      '@depends' => implode(', ', $info['depends']),
1087
    );
1088
    $items[] = format_plural(count($info['depends']), 'The @module module is missing, so the following module will be disabled: @depends.', 'The @module module is missing, so the following modules will be disabled: @depends.', $t_argument);
1089
  }
1090

    
1091
  $form['text'] = array('#markup' => theme('item_list', array('items' => $items)));
1092

    
1093
  if ($form) {
1094
    // Set some default form values
1095
    $form = confirm_form(
1096
      $form,
1097
      t('Some required modules must be enabled'),
1098
      'admin/modules',
1099
      t('Would you like to continue with the above?'),
1100
      t('Continue'),
1101
      t('Cancel'));
1102
    return $form;
1103
  }
1104
}
1105

    
1106
/**
1107
 * Submit callback; handles modules form submission.
1108
 */
1109
function system_modules_submit($form, &$form_state) {
1110
  include_once DRUPAL_ROOT . '/includes/install.inc';
1111

    
1112
  // Builds list of modules.
1113
  $modules = array();
1114
  // If we're not coming from the confirmation form, build the list of modules.
1115
  if (empty($form_state['storage'])) {
1116
    // If we're not coming from the confirmation form, build the module list.
1117
    foreach ($form_state['values']['modules'] as $group_name => $group) {
1118
      foreach ($group as $module => $enabled) {
1119
        $modules[$module] = array('group' => $group_name, 'enabled' => $enabled['enable']);
1120
      }
1121
    }
1122
  }
1123
  else {
1124
    // If we are coming from the confirmation form, fetch
1125
    // the modules out of $form_state.
1126
    $modules = $form_state['storage']['modules'];
1127
  }
1128

    
1129
  // Collect data for all modules to be able to determine dependencies.
1130
  $files = system_rebuild_module_data();
1131

    
1132
  // Sorts modules by weight.
1133
  $sort = array();
1134
  foreach (array_keys($modules) as $module) {
1135
    $sort[$module] = $files[$module]->sort;
1136
  }
1137
  array_multisort($sort, $modules);
1138

    
1139
  // Makes sure all required modules are set to be enabled.
1140
  $more_required = array();
1141
  $missing_modules = array();
1142
  foreach ($modules as $name => $module) {
1143
    if ($module['enabled']) {
1144
      // Checks that all dependencies are set to be enabled.  Stores the ones
1145
      // that are not in $dependencies variable so that the user can be alerted
1146
      // in the confirmation form that more modules need to be enabled.
1147
      $dependencies = array();
1148
      foreach (array_keys($files[$name]->requires) as $required) {
1149
        if (empty($modules[$required]['enabled'])) {
1150
          if (isset($files[$required])) {
1151
            $dependencies[] = $files[$required]->info['name'];
1152
            $modules[$required]['enabled'] = TRUE;
1153
          }
1154
          else {
1155
            $missing_modules[$required]['depends'][] = $name;
1156
            $modules[$name]['enabled'] = FALSE;
1157
          }
1158
        }
1159
      }
1160

    
1161
      // Stores additional modules that need to be enabled in $more_required.
1162
      if (!empty($dependencies)) {
1163
        $more_required[$name] = array(
1164
          'name' => $files[$name]->info['name'],
1165
          'requires' => $dependencies,
1166
        );
1167
      }
1168
    }
1169
  }
1170

    
1171
  // Redirects to confirmation form if more modules need to be enabled.
1172
  if ((!empty($more_required) || !empty($missing_modules)) && !isset($form_state['values']['confirm'])) {
1173
    $form_state['storage'] = array(
1174
      'more_required' => $more_required,
1175
      'modules' => $modules,
1176
      'missing_modules' => $missing_modules,
1177
    );
1178
    $form_state['rebuild'] = TRUE;
1179
    return;
1180
  }
1181

    
1182
  // Invokes hook_requirements('install').  If failures are detected, makes sure
1183
  // the dependent modules aren't installed either.
1184
  foreach ($modules as $name => $module) {
1185
    // Only invoke hook_requirements() on modules that are going to be installed.
1186
    if ($module['enabled'] && drupal_get_installed_schema_version($name) == SCHEMA_UNINSTALLED) {
1187
      if (!drupal_check_module($name)) {
1188
        $modules[$name]['enabled'] = FALSE;
1189
        foreach (array_keys($files[$name]->required_by) as $required_by) {
1190
          $modules[$required_by]['enabled'] = FALSE;
1191
        }
1192
      }
1193
    }
1194
  }
1195

    
1196
  // Initializes array of actions.
1197
  $actions = array(
1198
    'enable' => array(),
1199
    'disable' => array(),
1200
    'install' => array(),
1201
  );
1202

    
1203
  // Builds arrays of modules that need to be enabled, disabled, and installed.
1204
  foreach ($modules as $name => $module) {
1205
    if ($module['enabled']) {
1206
      if (drupal_get_installed_schema_version($name) == SCHEMA_UNINSTALLED) {
1207
        $actions['install'][] = $name;
1208
        $actions['enable'][] = $name;
1209
      }
1210
      elseif (!module_exists($name)) {
1211
        $actions['enable'][] = $name;
1212
      }
1213
    }
1214
    elseif (module_exists($name)) {
1215
      $actions['disable'][] = $name;
1216
    }
1217
  }
1218

    
1219
  // Gets list of modules prior to install process, unsets $form_state['storage']
1220
  // so we don't get redirected back to the confirmation form.
1221
  $pre_install_list = module_list();
1222
  unset($form_state['storage']);
1223

    
1224
  // Reverse the 'enable' list, to order dependencies before dependents.
1225
  krsort($actions['enable']);
1226

    
1227
  // Installs, enables, and disables modules.
1228
  module_enable($actions['enable'], FALSE);
1229
  module_disable($actions['disable'], FALSE);
1230

    
1231
  // Gets module list after install process, flushes caches and displays a
1232
  // message if there are changes.
1233
  $post_install_list = module_list(TRUE);
1234
  if ($pre_install_list != $post_install_list) {
1235
    drupal_flush_all_caches();
1236
    drupal_set_message(t('The configuration options have been saved.'));
1237
  }
1238

    
1239
  $form_state['redirect'] = 'admin/modules';
1240
}
1241

    
1242
/**
1243
 * Uninstall functions
1244
 */
1245

    
1246
/**
1247
 * Builds a form of currently disabled modules.
1248
 *
1249
 * @ingroup forms
1250
 * @see system_modules_uninstall_validate()
1251
 * @see system_modules_uninstall_submit()
1252
 * @param $form_state['values']
1253
 *   Submitted form values.
1254
 * @return
1255
 *   A form array representing the currently disabled modules.
1256
 */
1257
function system_modules_uninstall($form, $form_state = NULL) {
1258
  // Make sure the install API is available.
1259
  include_once DRUPAL_ROOT . '/includes/install.inc';
1260

    
1261
  // Display the confirm form if any modules have been submitted.
1262
  if (!empty($form_state['storage']) && $confirm_form = system_modules_uninstall_confirm_form($form_state['storage'])) {
1263
    return $confirm_form;
1264
  }
1265

    
1266
  // Get a list of disabled, installed modules.
1267
  $all_modules = system_rebuild_module_data();
1268
  $disabled_modules = array();
1269
  foreach ($all_modules as $name => $module) {
1270
    if (empty($module->status) && $module->schema_version > SCHEMA_UNINSTALLED) {
1271
      $disabled_modules[$name] = $module;
1272
    }
1273
  }
1274

    
1275
  // Only build the rest of the form if there are any modules available to
1276
  // uninstall.
1277
  if (!empty($disabled_modules)) {
1278
    $profile = drupal_get_profile();
1279
    uasort($disabled_modules, 'system_sort_modules_by_info_name');
1280
    $form['uninstall'] = array('#tree' => TRUE);
1281
    foreach ($disabled_modules as $module) {
1282
      $module_name = $module->info['name'] ? $module->info['name'] : $module->name;
1283
      $form['modules'][$module->name]['#module_name'] = $module_name;
1284
      $form['modules'][$module->name]['name']['#markup'] = $module_name;
1285
      $form['modules'][$module->name]['description']['#markup'] = t($module->info['description']);
1286
      $form['uninstall'][$module->name] = array(
1287
        '#type' => 'checkbox',
1288
        '#title' => t('Uninstall @module module', array('@module' => $module_name)),
1289
        '#title_display' => 'invisible',
1290
      );
1291
      // All modules which depend on this one must be uninstalled first, before
1292
      // we can allow this module to be uninstalled. (The installation profile
1293
      // is excluded from this list.)
1294
      foreach (array_keys($module->required_by) as $dependent) {
1295
        if ($dependent != $profile && drupal_get_installed_schema_version($dependent) != SCHEMA_UNINSTALLED) {
1296
          $dependent_name = isset($all_modules[$dependent]->info['name']) ? $all_modules[$dependent]->info['name'] : $dependent;
1297
          $form['modules'][$module->name]['#required_by'][] = $dependent_name;
1298
          $form['uninstall'][$module->name]['#disabled'] = TRUE;
1299
        }
1300
      }
1301
    }
1302
    $form['actions'] = array('#type' => 'actions');
1303
    $form['actions']['submit'] = array(
1304
      '#type' => 'submit',
1305
      '#value' => t('Uninstall'),
1306
    );
1307
    $form['#action'] = url('admin/modules/uninstall/confirm');
1308
  }
1309
  else {
1310
    $form['modules'] = array();
1311
  }
1312

    
1313
  return $form;
1314
}
1315

    
1316
/**
1317
 * Confirm uninstall of selected modules.
1318
 *
1319
 * @ingroup forms
1320
 * @param $storage
1321
 *   An associative array of modules selected to be uninstalled.
1322
 * @return
1323
 *   A form array representing modules to confirm.
1324
 */
1325
function system_modules_uninstall_confirm_form($storage) {
1326
  // Nothing to build.
1327
  if (empty($storage)) {
1328
    return;
1329
  }
1330

    
1331
  // Construct the hidden form elements and list items.
1332
  foreach (array_filter($storage['uninstall']) as $module => $value) {
1333
    $info = drupal_parse_info_file(drupal_get_path('module', $module) . '/' . $module . '.info');
1334
    $uninstall[] = $info['name'];
1335
    $form['uninstall'][$module] = array('#type' => 'hidden',
1336
      '#value' => 1,
1337
    );
1338
  }
1339

    
1340
  // Display a confirm form if modules have been selected.
1341
  if (isset($uninstall)) {
1342
    $form['#confirmed'] = TRUE;
1343
    $form['uninstall']['#tree'] = TRUE;
1344
    $form['modules'] = array('#markup' => '<p>' . t('The following modules will be completely uninstalled from your site, and <em>all data from these modules will be lost</em>!') . '</p>' . theme('item_list', array('items' => $uninstall)));
1345
    $form = confirm_form(
1346
      $form,
1347
      t('Confirm uninstall'),
1348
      'admin/modules/uninstall',
1349
      t('Would you like to continue with uninstalling the above?'),
1350
      t('Uninstall'),
1351
      t('Cancel'));
1352
    return $form;
1353
  }
1354
}
1355

    
1356
/**
1357
 * Validates the submitted uninstall form.
1358
 */
1359
function system_modules_uninstall_validate($form, &$form_state) {
1360
  // Form submitted, but no modules selected.
1361
  if (!count(array_filter($form_state['values']['uninstall']))) {
1362
    drupal_set_message(t('No modules selected.'), 'error');
1363
    drupal_goto('admin/modules/uninstall');
1364
  }
1365
}
1366

    
1367
/**
1368
 * Processes the submitted uninstall form.
1369
 */
1370
function system_modules_uninstall_submit($form, &$form_state) {
1371
  // Make sure the install API is available.
1372
  include_once DRUPAL_ROOT . '/includes/install.inc';
1373

    
1374
  if (!empty($form['#confirmed'])) {
1375
    // Call the uninstall routine for each selected module.
1376
    $modules = array_keys($form_state['values']['uninstall']);
1377
    drupal_uninstall_modules($modules);
1378
    drupal_set_message(t('The selected modules have been uninstalled.'));
1379

    
1380
    $form_state['redirect'] = 'admin/modules/uninstall';
1381
  }
1382
  else {
1383
    $form_state['storage'] = $form_state['values'];
1384
    $form_state['rebuild'] = TRUE;
1385
  }
1386
}
1387

    
1388
/**
1389
 * Menu callback. Display blocked IP addresses.
1390
 *
1391
 * @param $default_ip
1392
 *   Optional IP address to be passed on to drupal_get_form() for
1393
 *   use as the default value of the IP address form field.
1394
 */
1395
function system_ip_blocking($default_ip = '') {
1396
  $rows = array();
1397
  $header = array(t('Blocked IP addresses'), t('Operations'));
1398
  $result = db_query('SELECT * FROM {blocked_ips}');
1399
  foreach ($result as $ip) {
1400
    $rows[] = array(
1401
      $ip->ip,
1402
      l(t('delete'), "admin/config/people/ip-blocking/delete/$ip->iid"),
1403
    );
1404
  }
1405

    
1406
  $build['system_ip_blocking_form'] = drupal_get_form('system_ip_blocking_form', $default_ip);
1407

    
1408
  $build['system_ip_blocking_table'] = array(
1409
    '#theme' => 'table',
1410
    '#header' => $header,
1411
    '#rows' => $rows,
1412
    '#empty' => t('No blocked IP addresses available.'),
1413
  );
1414

    
1415
  return $build;
1416
}
1417

    
1418
/**
1419
 * Define the form for blocking IP addresses.
1420
 *
1421
 * @ingroup forms
1422
 * @see system_ip_blocking_form_validate()
1423
 * @see system_ip_blocking_form_submit()
1424
 */
1425
function system_ip_blocking_form($form, $form_state, $default_ip) {
1426
  $form['ip'] = array(
1427
    '#title' => t('IP address'),
1428
    '#type' => 'textfield',
1429
    '#size' => 48,
1430
    '#maxlength' => 40,
1431
    '#default_value' => $default_ip,
1432
    '#description' => t('Enter a valid IP address.'),
1433
  );
1434
  $form['actions'] = array('#type' => 'actions');
1435
  $form['actions']['submit'] = array(
1436
    '#type' => 'submit',
1437
    '#value' => t('Add'),
1438
  );
1439
  $form['#submit'][] = 'system_ip_blocking_form_submit';
1440
  $form['#validate'][] = 'system_ip_blocking_form_validate';
1441
  return $form;
1442
}
1443

    
1444
function system_ip_blocking_form_validate($form, &$form_state) {
1445
  $ip = trim($form_state['values']['ip']);
1446
  if (db_query("SELECT * FROM {blocked_ips} WHERE ip = :ip", array(':ip' => $ip))->fetchField()) {
1447
    form_set_error('ip', t('This IP address is already blocked.'));
1448
  }
1449
  elseif ($ip == ip_address()) {
1450
    form_set_error('ip', t('You may not block your own IP address.'));
1451
  }
1452
  elseif (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_NO_RES_RANGE) == FALSE) {
1453
    form_set_error('ip', t('Enter a valid IP address.'));
1454
  }
1455
}
1456

    
1457
function system_ip_blocking_form_submit($form, &$form_state) {
1458
  $ip = trim($form_state['values']['ip']);
1459
  db_insert('blocked_ips')
1460
    ->fields(array('ip' => $ip))
1461
    ->execute();
1462
  drupal_set_message(t('The IP address %ip has been blocked.', array('%ip' => $ip)));
1463
  $form_state['redirect'] = 'admin/config/people/ip-blocking';
1464
  return;
1465
}
1466

    
1467
/**
1468
 * IP deletion confirm page.
1469
 *
1470
 * @see system_ip_blocking_delete_submit()
1471
 */
1472
function system_ip_blocking_delete($form, &$form_state, $iid) {
1473
  $form['blocked_ip'] = array(
1474
    '#type' => 'value',
1475
    '#value' => $iid,
1476
  );
1477
  return confirm_form($form, t('Are you sure you want to delete %ip?', array('%ip' => $iid['ip'])), 'admin/config/people/ip-blocking', t('This action cannot be undone.'), t('Delete'), t('Cancel'));
1478
}
1479

    
1480
/**
1481
 * Process system_ip_blocking_delete form submissions.
1482
 */
1483
function system_ip_blocking_delete_submit($form, &$form_state) {
1484
  $blocked_ip = $form_state['values']['blocked_ip'];
1485
  db_delete('blocked_ips')
1486
    ->condition('iid', $blocked_ip['iid'])
1487
    ->execute();
1488
  watchdog('user', 'Deleted %ip', array('%ip' => $blocked_ip['ip']));
1489
  drupal_set_message(t('The IP address %ip was deleted.', array('%ip' => $blocked_ip['ip'])));
1490
  $form_state['redirect'] = 'admin/config/people/ip-blocking';
1491
}
1492

    
1493
/**
1494
 * Form builder; The general site information form.
1495
 *
1496
 * @ingroup forms
1497
 * @see system_settings_form()
1498
 */
1499
function system_site_information_settings() {
1500
  $form['site_information'] = array(
1501
    '#type' => 'fieldset',
1502
    '#title' => t('Site details'),
1503
  );
1504
  $form['site_information']['site_name'] = array(
1505
    '#type' => 'textfield',
1506
    '#title' => t('Site name'),
1507
    '#default_value' => variable_get('site_name', 'Drupal'),
1508
    '#required' => TRUE
1509
  );
1510
  $form['site_information']['site_slogan'] = array(
1511
    '#type' => 'textfield',
1512
    '#title' => t('Slogan'),
1513
    '#default_value' => variable_get('site_slogan', ''),
1514
    '#description' => t("How this is used depends on your site's theme."),
1515
  );
1516
  $form['site_information']['site_mail'] = array(
1517
    '#type' => 'textfield',
1518
    '#title' => t('E-mail address'),
1519
    '#default_value' => variable_get('site_mail', ini_get('sendmail_from')),
1520
    '#description' => t("The <em>From</em> address in automated e-mails sent during registration and new password requests, and other notifications. (Use an address ending in your site's domain to help prevent this e-mail being flagged as spam.)"),
1521
    '#required' => TRUE,
1522
  );
1523
  $form['front_page'] = array(
1524
    '#type' => 'fieldset',
1525
    '#title' => t('Front page'),
1526
  );
1527
  $form['front_page']['default_nodes_main'] = array(
1528
    '#type' => 'select', '#title' => t('Number of posts on front page'),
1529
    '#default_value' => variable_get('default_nodes_main', 10),
1530
    '#options' => drupal_map_assoc(array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30)),
1531
    '#description' => t('The maximum number of posts displayed on overview pages such as the front page.')
1532
  );
1533
  $form['front_page']['site_frontpage'] = array(
1534
    '#type' => 'textfield',
1535
    '#title' => t('Default front page'),
1536
    '#default_value' => (variable_get('site_frontpage')!='node'?drupal_get_path_alias(variable_get('site_frontpage', 'node')):''),
1537
    '#size' => 40,
1538
    '#description' => t('Optionally, specify a relative URL to display as the front page.  Leave blank to display the default content feed.'),
1539
    '#field_prefix' => url(NULL, array('absolute' => TRUE)) . (variable_get('clean_url', 0) ? '' : '?q='),
1540
  );
1541
  $form['error_page'] = array(
1542
    '#type' => 'fieldset',
1543
    '#title' => t('Error pages'),
1544
  );
1545
  $form['error_page']['site_403'] = array(
1546
    '#type' => 'textfield',
1547
    '#title' => t('Default 403 (access denied) page'),
1548
    '#default_value' => variable_get('site_403', ''),
1549
    '#size' => 40,
1550
    '#description' => t('This page is displayed when the requested document is denied to the current user. Leave blank to display a generic "access denied" page.'),
1551
    '#field_prefix' => url(NULL, array('absolute' => TRUE)) . (variable_get('clean_url', 0) ? '' : '?q=')
1552
  );
1553
  $form['error_page']['site_404'] = array(
1554
    '#type' => 'textfield',
1555
    '#title' => t('Default 404 (not found) page'),
1556
    '#default_value' => variable_get('site_404', ''),
1557
    '#size' => 40,
1558
    '#description' => t('This page is displayed when no other content matches the requested document. Leave blank to display a generic "page not found" page.'),
1559
    '#field_prefix' => url(NULL, array('absolute' => TRUE)) . (variable_get('clean_url', 0) ? '' : '?q=')
1560
  );
1561

    
1562
  $form['#validate'][] = 'system_site_information_settings_validate';
1563

    
1564
  return system_settings_form($form);
1565
}
1566

    
1567
/**
1568
 * Validates the submitted site-information form.
1569
 */
1570
function system_site_information_settings_validate($form, &$form_state) {
1571
  // Validate the e-mail address.
1572
  if ($error = user_validate_mail($form_state['values']['site_mail'])) {
1573
    form_set_error('site_mail', $error);
1574
  }
1575
  // Check for empty front page path.
1576
  if (empty($form_state['values']['site_frontpage'])) {
1577
    // Set to default "node".
1578
    form_set_value($form['front_page']['site_frontpage'], 'node', $form_state);
1579
  }
1580
  else {
1581
    // Get the normal path of the front page.
1582
    form_set_value($form['front_page']['site_frontpage'], drupal_get_normal_path($form_state['values']['site_frontpage']), $form_state);
1583
  }
1584
  // Validate front page path.
1585
  if (!drupal_valid_path($form_state['values']['site_frontpage'])) {
1586
    form_set_error('site_frontpage', t("The path '%path' is either invalid or you do not have access to it.", array('%path' => $form_state['values']['site_frontpage'])));
1587
  }
1588
  // Get the normal paths of both error pages.
1589
  if (!empty($form_state['values']['site_403'])) {
1590
    form_set_value($form['error_page']['site_403'], drupal_get_normal_path($form_state['values']['site_403']), $form_state);
1591
  }
1592
  if (!empty($form_state['values']['site_404'])) {
1593
    form_set_value($form['error_page']['site_404'], drupal_get_normal_path($form_state['values']['site_404']), $form_state);
1594
  }
1595
  // Validate 403 error path.
1596
  if (!empty($form_state['values']['site_403']) && !drupal_valid_path($form_state['values']['site_403'])) {
1597
    form_set_error('site_403', t("The path '%path' is either invalid or you do not have access to it.", array('%path' => $form_state['values']['site_403'])));
1598
  }
1599
  // Validate 404 error path.
1600
  if (!empty($form_state['values']['site_404']) && !drupal_valid_path($form_state['values']['site_404'])) {
1601
    form_set_error('site_404', t("The path '%path' is either invalid or you do not have access to it.", array('%path' => $form_state['values']['site_404'])));
1602
  }
1603
}
1604

    
1605
/**
1606
 * Form builder; Cron form.
1607
 *
1608
 * @see system_settings_form()
1609
 * @ingroup forms
1610
 */
1611
function system_cron_settings() {
1612
  global $base_url;
1613
  $form['description'] = array(
1614
    '#markup' => '<p>' . t('Cron takes care of running periodic tasks like checking for updates and indexing content for search.') . '</p>',
1615
  );
1616
  $form['run'] = array(
1617
    '#type' => 'submit',
1618
    '#value' => t('Run cron'),
1619
    '#submit' => array('system_run_cron_submit'),
1620
  );
1621
  $status = '<p>' . t('Last run: %cron-last ago.', array('%cron-last' => format_interval(REQUEST_TIME - variable_get('cron_last')),)) . '</p>';
1622
  $form['status'] = array(
1623
    '#markup' => $status,
1624
  );
1625

    
1626
  $form['cron_url'] = array(
1627
    '#markup' => '<p>' . t('To run cron from outside the site, go to <a href="!cron">!cron</a>', array('!cron' => url($base_url . '/cron.php', array('external' => TRUE, 'query' => array('cron_key' => variable_get('cron_key', 'drupal')))))) . '</p>',
1628
  );
1629

    
1630
  $form['cron'] = array(
1631
    '#type' => 'fieldset',
1632
  );
1633
  $form['cron']['cron_safe_threshold'] = array(
1634
    '#type' => 'select',
1635
    '#title' => t('Run cron every'),
1636
    '#description' => t('More information about setting up scheduled tasks can be found by <a href="@url">reading the cron tutorial on drupal.org</a>.', array('@url' => url('http://drupal.org/cron'))),
1637
    '#default_value' => variable_get('cron_safe_threshold', DRUPAL_CRON_DEFAULT_THRESHOLD),
1638
    '#options' => array(0 => t('Never')) + drupal_map_assoc(array(3600, 10800, 21600, 43200, 86400, 604800), 'format_interval'),
1639
  );
1640

    
1641
  return system_settings_form($form);
1642
}
1643

    
1644
/**
1645
 * Submit callback; run cron.
1646
 *
1647
 * @ingroup forms
1648
 */
1649
function system_run_cron_submit($form, &$form_state) {
1650
  // Run cron manually from Cron form.
1651
  if (drupal_cron_run()) {
1652
    drupal_set_message(t('Cron run successfully.'));
1653
  }
1654
  else {
1655
    drupal_set_message(t('Cron run failed.'), 'error');
1656
  }
1657

    
1658
  drupal_goto('admin/config/system/cron');
1659
}
1660

    
1661
/**
1662
 * Form builder; Configure error reporting settings.
1663
 *
1664
 * @ingroup forms
1665
 * @see system_settings_form()
1666
 */
1667
function system_logging_settings() {
1668
  $form['error_level'] = array(
1669
    '#type' => 'radios',
1670
    '#title' => t('Error messages to display'),
1671
    '#default_value' => variable_get('error_level', ERROR_REPORTING_DISPLAY_ALL),
1672
    '#options' => array(
1673
      ERROR_REPORTING_HIDE => t('None'),
1674
      ERROR_REPORTING_DISPLAY_SOME => t('Errors and warnings'),
1675
      ERROR_REPORTING_DISPLAY_ALL => t('All messages'),
1676
    ),
1677
    '#description' => t('It is recommended that sites running on production environments do not display any errors.'),
1678
  );
1679

    
1680
  return system_settings_form($form);
1681
}
1682

    
1683
/**
1684
 * Form builder; Configure site performance settings.
1685
 *
1686
 * @ingroup forms
1687
 * @see system_settings_form()
1688
 */
1689
function system_performance_settings() {
1690
  drupal_add_js(drupal_get_path('module', 'system') . '/system.js');
1691

    
1692
  $form['clear_cache'] = array(
1693
    '#type' => 'fieldset',
1694
    '#title' => t('Clear cache'),
1695
  );
1696

    
1697
  $form['clear_cache']['clear'] = array(
1698
    '#type' => 'submit',
1699
    '#value' => t('Clear all caches'),
1700
    '#submit' => array('system_clear_cache_submit'),
1701
  );
1702

    
1703
  $form['caching'] = array(
1704
    '#type' => 'fieldset',
1705
    '#title' => t('Caching'),
1706
  );
1707

    
1708
  $cache = variable_get('cache', 0);
1709
  $form['caching']['cache'] = array(
1710
    '#type' => 'checkbox',
1711
    '#title' => t('Cache pages for anonymous users'),
1712
    '#default_value' => $cache,
1713
    '#weight' => -2,
1714
  );
1715
  $period = drupal_map_assoc(array(0, 60, 180, 300, 600, 900, 1800, 2700, 3600, 10800, 21600, 32400, 43200, 86400), 'format_interval');
1716
  $period[0] = '<' . t('none') . '>';
1717
  $form['caching']['cache_lifetime'] = array(
1718
    '#type' => 'select',
1719
    '#title' => t('Minimum cache lifetime'),
1720
    '#default_value' => variable_get('cache_lifetime', 0),
1721
    '#options' => $period,
1722
    '#description' => t('Cached pages will not be re-created until at least this much time has elapsed.')
1723
  );
1724
  $form['caching']['page_cache_maximum_age'] = array(
1725
    '#type' => 'select',
1726
    '#title' => t('Expiration of cached pages'),
1727
    '#default_value' => variable_get('page_cache_maximum_age', 0),
1728
    '#options' => $period,
1729
    '#description' => t('The maximum time an external cache can use an old version of a page.')
1730
  );
1731

    
1732
  $directory = 'public://';
1733
  $is_writable = is_dir($directory) && is_writable($directory);
1734
  $disabled = !$is_writable;
1735
  $disabled_message = '';
1736
  if (!$is_writable) {
1737
    $disabled_message = ' ' . t('<strong class="error">Set up the <a href="!file-system">public files directory</a> to make these optimizations available.</strong>', array('!file-system' => url('admin/config/media/file-system')));
1738
  }
1739

    
1740
  $form['bandwidth_optimization'] = array(
1741
    '#type' => 'fieldset',
1742
    '#title' => t('Bandwidth optimization'),
1743
    '#description' => t('External resources can be optimized automatically, which can reduce both the size and number of requests made to your website.') . $disabled_message,
1744
  );
1745

    
1746
  $js_hide = $cache ? '' : ' class="js-hide"';
1747
  $form['bandwidth_optimization']['page_compression'] = array(
1748
    '#type' => 'checkbox',
1749
    '#title' => t('Compress cached pages.'),
1750
    '#default_value' => variable_get('page_compression', TRUE),
1751
    '#prefix' => '<div id="page-compression-wrapper"' . $js_hide . '>',
1752
    '#suffix' => '</div>',
1753
  );
1754
  $form['bandwidth_optimization']['preprocess_css'] = array(
1755
    '#type' => 'checkbox',
1756
    '#title' => t('Aggregate and compress CSS files.'),
1757
    '#default_value' => intval(variable_get('preprocess_css', 0) && $is_writable),
1758
    '#disabled' => $disabled,
1759
  );
1760
  $form['bandwidth_optimization']['preprocess_js'] = array(
1761
    '#type' => 'checkbox',
1762
    '#title' => t('Aggregate JavaScript files.'),
1763
    '#default_value' => intval(variable_get('preprocess_js', 0) && $is_writable),
1764
    '#disabled' => $disabled,
1765
  );
1766

    
1767
  $form['#submit'][] = 'drupal_clear_css_cache';
1768
  $form['#submit'][] = 'drupal_clear_js_cache';
1769
  // This form allows page compression settings to be changed, which can
1770
  // invalidate the page cache, so it needs to be cleared on form submit.
1771
  $form['#submit'][] = 'system_clear_page_cache_submit';
1772

    
1773
  return system_settings_form($form);
1774
}
1775

    
1776
/**
1777
 * Submit callback; clear system caches.
1778
 *
1779
 * @ingroup forms
1780
 */
1781
function system_clear_cache_submit($form, &$form_state) {
1782
  drupal_flush_all_caches();
1783
  drupal_set_message(t('Caches cleared.'));
1784
}
1785

    
1786
/**
1787
 * Submit callback; clear the page cache.
1788
 *
1789
 * @ingroup forms
1790
 */
1791
function system_clear_page_cache_submit($form, &$form_state) {
1792
  cache_clear_all('*', 'cache_page', TRUE);
1793
}
1794

    
1795
/**
1796
 * Form builder; Configure the site file handling.
1797
 *
1798
 * @ingroup forms
1799
 * @see system_settings_form()
1800
 */
1801
function system_file_system_settings() {
1802
  $form['file_public_path'] = array(
1803
    '#type' => 'textfield',
1804
    '#title' => t('Public file system path'),
1805
    '#default_value' => variable_get('file_public_path', conf_path() . '/files'),
1806
    '#maxlength' => 255,
1807
    '#description' => t('A local file system path where public files will be stored. This directory must exist and be writable by Drupal. This directory must be relative to the Drupal installation directory and be accessible over the web.'),
1808
    '#after_build' => array('system_check_directory'),
1809
  );
1810

    
1811
  $form['file_private_path'] = array(
1812
    '#type' => 'textfield',
1813
    '#title' => t('Private file system path'),
1814
    '#default_value' => variable_get('file_private_path', ''),
1815
    '#maxlength' => 255,
1816
    '#description' => t('An existing local file system path for storing private files. It should be writable by Drupal and not accessible over the web. See the online handbook for <a href="@handbook">more information about securing private files</a>.', array('@handbook' => 'https://www.drupal.org/docs/7/core/modules/file/overview')),
1817
    '#after_build' => array('system_check_directory'),
1818
  );
1819

    
1820
  $form['file_temporary_path'] = array(
1821
    '#type' => 'textfield',
1822
    '#title' => t('Temporary directory'),
1823
    '#default_value' => variable_get('file_temporary_path', file_directory_temp()),
1824
    '#maxlength' => 255,
1825
    '#description' => t('A local file system path where temporary files will be stored. This directory should not be accessible over the web.'),
1826
    '#after_build' => array('system_check_directory'),
1827
  );
1828
  // Any visible, writeable wrapper can potentially be used for the files
1829
  // directory, including a remote file system that integrates with a CDN.
1830
  foreach (file_get_stream_wrappers(STREAM_WRAPPERS_WRITE_VISIBLE) as $scheme => $info) {
1831
    $options[$scheme] = check_plain($info['description']);
1832
  }
1833

    
1834
  if (!empty($options)) {
1835
    $form['file_default_scheme'] = array(
1836
      '#type' => 'radios',
1837
      '#title' => t('Default download method'),
1838
      '#default_value' => variable_get('file_default_scheme', isset($options['public']) ? 'public' : key($options)),
1839
      '#options' => $options,
1840
      '#description' => t('This setting is used as the preferred download method. The use of public files is more efficient, but does not provide any access control.'),
1841
    );
1842
  }
1843

    
1844
  return system_settings_form($form);
1845
}
1846

    
1847
/**
1848
 * Form builder; Configure site image toolkit usage.
1849
 *
1850
 * @ingroup forms
1851
 * @see system_settings_form()
1852
 */
1853
function system_image_toolkit_settings() {
1854
  $toolkits_available = image_get_available_toolkits();
1855
  $current_toolkit = image_get_toolkit();
1856

    
1857
  if (count($toolkits_available) == 0) {
1858
    variable_del('image_toolkit');
1859
    $form['image_toolkit_help'] = array(
1860
      '#markup' => t("No image toolkits were detected. Drupal includes support for <a href='!gd-link'>PHP's built-in image processing functions</a> but they were not detected on this system. You should consult your system administrator to have them enabled, or try using a third party toolkit.", array('!gd-link' => url('http://php.net/gd'))),
1861
    );
1862
    return $form;
1863
  }
1864

    
1865
  if (count($toolkits_available) > 1) {
1866
    $form['image_toolkit'] = array(
1867
      '#type' => 'radios',
1868
      '#title' => t('Select an image processing toolkit'),
1869
      '#default_value' => variable_get('image_toolkit', $current_toolkit),
1870
      '#options' => $toolkits_available
1871
    );
1872
  }
1873
  else {
1874
    variable_set('image_toolkit', key($toolkits_available));
1875
  }
1876

    
1877
  // Get the toolkit's settings form.
1878
  $function = 'image_' . $current_toolkit . '_settings';
1879
  if (function_exists($function)) {
1880
    $form['image_toolkit_settings'] = $function();
1881
  }
1882

    
1883
  return system_settings_form($form);
1884
}
1885

    
1886
/**
1887
 * Form builder; Configure how the site handles RSS feeds.
1888
 *
1889
 * @ingroup forms
1890
 * @see system_settings_form()
1891
 */
1892
function system_rss_feeds_settings() {
1893
  $form['feed_description'] = array(
1894
    '#type' => 'textarea',
1895
    '#title' => t('Feed description'),
1896
    '#default_value' => variable_get('feed_description', ''),
1897
    '#description' => t('Description of your site, included in each feed.')
1898
  );
1899
  $form['feed_default_items'] = array(
1900
    '#type' => 'select',
1901
    '#title' => t('Number of items in each feed'),
1902
    '#default_value' => variable_get('feed_default_items', 10),
1903
    '#options' => drupal_map_assoc(array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30)),
1904
    '#description' => t('Default number of items to include in each feed.')
1905
  );
1906
  $form['feed_item_length'] = array(
1907
    '#type' => 'select',
1908
    '#title' => t('Feed content'),
1909
    '#default_value' => variable_get('feed_item_length', 'fulltext'),
1910
    '#options' => array('title' => t('Titles only'), 'teaser' => t('Titles plus teaser'), 'fulltext' => t('Full text')),
1911
    '#description' => t('Global setting for the default display of content items in each feed.')
1912
  );
1913

    
1914
  return system_settings_form($form);
1915
}
1916

    
1917
/**
1918
 * Form builder; Configure the site regional settings.
1919
 *
1920
 * @ingroup forms
1921
 * @see system_settings_form()
1922
 * @see system_regional_settings_submit()
1923
 */
1924
function system_regional_settings() {
1925
  include_once DRUPAL_ROOT . '/includes/locale.inc';
1926
  $countries = country_get_list();
1927

    
1928
  // Date settings:
1929
  $zones = system_time_zones();
1930

    
1931
  $form['locale'] = array(
1932
    '#type' => 'fieldset',
1933
    '#title' => t('Locale'),
1934
  );
1935

    
1936
  $form['locale']['site_default_country'] = array(
1937
    '#type' => 'select',
1938
    '#title' => t('Default country'),
1939
    '#empty_value' => '',
1940
    '#default_value' => variable_get('site_default_country', ''),
1941
    '#options' => $countries,
1942
    '#attributes' => array('class' => array('country-detect')),
1943
  );
1944

    
1945
  $form['locale']['date_first_day'] = array(
1946
    '#type' => 'select',
1947
    '#title' => t('First day of week'),
1948
    '#default_value' => variable_get('date_first_day', 0),
1949
    '#options' => array(0 => t('Sunday'), 1 => t('Monday'), 2 => t('Tuesday'), 3 => t('Wednesday'), 4 => t('Thursday'), 5 => t('Friday'), 6 => t('Saturday')),
1950
  );
1951

    
1952
  $form['timezone'] = array(
1953
    '#type' => 'fieldset',
1954
    '#title' => t('Time zones'),
1955
  );
1956

    
1957
  $form['timezone']['date_default_timezone'] = array(
1958
    '#type' => 'select',
1959
    '#title' => t('Default time zone'),
1960
    '#default_value' => variable_get('date_default_timezone', date_default_timezone_get()),
1961
    '#options' => $zones,
1962
  );
1963

    
1964
  $configurable_timezones = variable_get('configurable_timezones', 1);
1965
  $form['timezone']['configurable_timezones'] = array(
1966
    '#type' => 'checkbox',
1967
    '#title' => t('Users may set their own time zone.'),
1968
    '#default_value' => $configurable_timezones,
1969
  );
1970

    
1971
  $form['timezone']['configurable_timezones_wrapper'] =  array(
1972
    '#type' => 'container',
1973
    '#states' => array(
1974
      // Hide the user configured timezone settings when users are forced to use
1975
      // the default setting.
1976
      'invisible' => array(
1977
        'input[name="configurable_timezones"]' => array('checked' => FALSE),
1978
      ),
1979
    ),
1980
  );
1981
  $form['timezone']['configurable_timezones_wrapper']['empty_timezone_message'] = array(
1982
    '#type' => 'checkbox',
1983
    '#title' => t('Remind users at login if their time zone is not set.'),
1984
    '#default_value' => variable_get('empty_timezone_message', 0),
1985
    '#description' => t('Only applied if users may set their own time zone.')
1986
  );
1987

    
1988
  $form['timezone']['configurable_timezones_wrapper']['user_default_timezone'] = array(
1989
    '#type' => 'radios',
1990
    '#title' => t('Time zone for new users'),
1991
    '#default_value' => variable_get('user_default_timezone', DRUPAL_USER_TIMEZONE_DEFAULT),
1992
    '#options' => array(
1993
      DRUPAL_USER_TIMEZONE_DEFAULT => t('Default time zone.'),
1994
      DRUPAL_USER_TIMEZONE_EMPTY   => t('Empty time zone.'),
1995
      DRUPAL_USER_TIMEZONE_SELECT  => t('Users may set their own time zone at registration.'),
1996
    ),
1997
    '#description' => t('Only applied if users may set their own time zone.')
1998
  );
1999

    
2000
  return system_settings_form($form);
2001
}
2002

    
2003
/**
2004
 * Form builder; Configure the site date and time settings.
2005
 *
2006
 * @ingroup forms
2007
 * @see system_settings_form()
2008
 */
2009
function system_date_time_settings() {
2010
  // Get list of all available date types.
2011
  drupal_static_reset('system_get_date_types');
2012
  $format_types = system_get_date_types();
2013

    
2014
  // Get list of all available date formats.
2015
  $all_formats = array();
2016
  drupal_static_reset('system_get_date_formats');
2017
  $date_formats = system_get_date_formats(); // Call this to rebuild the list, and to have default list.
2018
  foreach ($date_formats as $type => $format_info) {
2019
    $all_formats = array_merge($all_formats, $format_info);
2020
  }
2021
  $custom_formats = system_get_date_formats('custom');
2022
  if (!empty($format_types)) {
2023
    foreach ($format_types as $type => $type_info) {
2024
      // If a system type, only show the available formats for that type and
2025
      // custom ones.
2026
      if ($type_info['locked'] == 1) {
2027
        $formats = system_get_date_formats($type);
2028
        if (empty($formats)) {
2029
          $formats = $all_formats;
2030
        }
2031
        elseif (!empty($custom_formats)) {
2032
          $formats = array_merge($formats, $custom_formats);
2033
        }
2034
      }
2035
      // If a user configured type, show all available date formats.
2036
      else {
2037
        $formats = $all_formats;
2038
      }
2039

    
2040
      $choices = array();
2041
      foreach ($formats as $f => $format) {
2042
        $choices[$f] = format_date(REQUEST_TIME, 'custom', $f);
2043
      }
2044
      reset($formats);
2045
      $default = variable_get('date_format_' . $type, key($formats));
2046

    
2047
      // Get date type info for this date type.
2048
      $type_info = system_get_date_types($type);
2049
      $form['formats']['#theme'] = 'system_date_time_settings';
2050

    
2051
      // Show date format select list.
2052
      $form['formats']['format']['date_format_' . $type] = array(
2053
        '#type' => 'select',
2054
        '#title' => check_plain($type_info['title']),
2055
        '#attributes' => array('class' => array('date-format')),
2056
        '#default_value' => (isset($choices[$default]) ? $default : 'custom'),
2057
        '#options' => $choices,
2058
      );
2059

    
2060
      // If this isn't a system provided type, allow the user to remove it from
2061
      // the system.
2062
      if ($type_info['locked'] == 0) {
2063
        $form['formats']['delete']['date_format_' . $type . '_delete'] = array(
2064
          '#type' => 'link',
2065
          '#title' => t('delete'),
2066
          '#href' => 'admin/config/regional/date-time/types/' . $type . '/delete',
2067
        );
2068
      }
2069
    }
2070
  }
2071

    
2072
  // Display a message if no date types configured.
2073
  $form['#empty_text'] = t('No date types available. <a href="@link">Add date type</a>.', array('@link' => url('admin/config/regional/date-time/types/add')));
2074

    
2075
  return system_settings_form($form);
2076
}
2077

    
2078
/**
2079
 * Returns HTML for the date settings form.
2080
 *
2081
 * @param $variables
2082
 *   An associative array containing:
2083
 *   - form: A render element representing the form.
2084
 *
2085
 * @ingroup themeable
2086
 */
2087
function theme_system_date_time_settings($variables) {
2088
  $form = $variables['form'];
2089
  $header = array(
2090
    t('Date type'),
2091
    t('Format'),
2092
    t('Operations'),
2093
  );
2094

    
2095
  foreach (element_children($form['format']) as $key) {
2096
    $delete_key = $key . '_delete';
2097
    $row = array();
2098
    $row[] = $form['format'][$key]['#title'];
2099
    $form['format'][$key]['#title_display'] = 'invisible';
2100
    $row[] = array('data' => drupal_render($form['format'][$key]));
2101
    $row[] = array('data' => drupal_render($form['delete'][$delete_key]));
2102
    $rows[] = $row;
2103
  }
2104

    
2105
  $output = theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('id' => 'system-date-types')));
2106
  $output .= drupal_render_children($form);
2107

    
2108
  return $output;
2109
}
2110

    
2111

    
2112
/**
2113
 * Add new date type.
2114
 *
2115
 * @ingroup forms
2116
 * @ingroup system_add_date_format_type_form_validate()
2117
 * @ingroup system_add_date_format_type_form_submit()
2118
 */
2119
function system_add_date_format_type_form($form, &$form_state) {
2120
  $form['date_type'] = array(
2121
    '#title' => t('Date type'),
2122
    '#type' => 'textfield',
2123
    '#required' => TRUE,
2124
  );
2125
  $form['machine_name'] = array(
2126
    '#type' => 'machine_name',
2127
    '#machine_name' => array(
2128
      'exists' => 'system_get_date_types',
2129
      'source' => array('date_type'),
2130
    ),
2131
  );
2132

    
2133
  // Get list of all available date formats.
2134
  $formats = array();
2135
  drupal_static_reset('system_get_date_formats');
2136
  $date_formats = system_get_date_formats(); // Call this to rebuild the list, and to have default list.
2137
  foreach ($date_formats as $type => $format_info) {
2138
    $formats = array_merge($formats, $format_info);
2139
  }
2140
  $custom_formats = system_get_date_formats('custom');
2141
  if (!empty($custom_formats)) {
2142
    $formats = array_merge($formats, $custom_formats);
2143
  }
2144
  $choices = array();
2145
  foreach ($formats as $f => $format) {
2146
    $choices[$f] = format_date(REQUEST_TIME, 'custom', $f);
2147
  }
2148
  // Show date format select list.
2149
  $form['date_format'] = array(
2150
    '#type' => 'select',
2151
    '#title' => t('Date format'),
2152
    '#attributes' => array('class' => array('date-format')),
2153
    '#options' => $choices,
2154
    '#required' => TRUE,
2155
  );
2156

    
2157
  $form['actions'] = array('#type' => 'actions');
2158
  $form['actions']['submit'] = array(
2159
    '#type' => 'submit',
2160
    '#value' => t('Add date type'),
2161
  );
2162

    
2163
  $form['#validate'][] = 'system_add_date_format_type_form_validate';
2164
  $form['#submit'][] = 'system_add_date_format_type_form_submit';
2165

    
2166
  return $form;
2167
}
2168

    
2169
/**
2170
 * Validate system_add_date_format_type form submissions.
2171
 */
2172
function system_add_date_format_type_form_validate($form, &$form_state) {
2173
  if (!empty($form_state['values']['machine_name']) && !empty($form_state['values']['date_type'])) {
2174
    if (!preg_match("/^[a-zA-Z0-9_]+$/", trim($form_state['values']['machine_name']))) {
2175
      form_set_error('machine_name', t('The date type must contain only alphanumeric characters and underscores.'));
2176
    }
2177
    $types = system_get_date_types();
2178
    if (in_array(trim($form_state['values']['machine_name']), array_keys($types))) {
2179
      form_set_error('machine_name', t('This date type already exists. Enter a unique type.'));
2180
    }
2181
  }
2182
}
2183

    
2184
/**
2185
 * Process system_add_date_format_type form submissions.
2186
 */
2187
function system_add_date_format_type_form_submit($form, &$form_state) {
2188
  $machine_name = trim($form_state['values']['machine_name']);
2189

    
2190
  $format_type = array();
2191
  $format_type['title'] = trim($form_state['values']['date_type']);
2192
  $format_type['type'] = $machine_name;
2193
  $format_type['locked'] = 0;
2194
  $format_type['is_new'] = 1;
2195
  system_date_format_type_save($format_type);
2196
  variable_set('date_format_' . $machine_name, $form_state['values']['date_format']);
2197

    
2198
  drupal_set_message(t('New date type added successfully.'));
2199
  $form_state['redirect'] = 'admin/config/regional/date-time';
2200
}
2201

    
2202
/**
2203
 * Return the date for a given format string via Ajax.
2204
 */
2205
function system_date_time_lookup() {
2206
  // This callback is protected with a CSRF token because user input from the
2207
  // query string is reflected in the output.
2208
  if (!isset($_GET['token']) || !drupal_valid_token($_GET['token'], 'admin/config/regional/date-time/formats/lookup')) {
2209
    return MENU_ACCESS_DENIED;
2210
  }
2211
  $result = format_date(REQUEST_TIME, 'custom', $_GET['format']);
2212
  drupal_json_output($result);
2213
}
2214

    
2215
/**
2216
 * Form builder; Configure the site's maintenance status.
2217
 *
2218
 * @ingroup forms
2219
 * @see system_settings_form()
2220
 */
2221
function system_site_maintenance_mode() {
2222
  $form['maintenance_mode'] = array(
2223
    '#type' => 'checkbox',
2224
    '#title' => t('Put site into maintenance mode'),
2225
    '#default_value' => variable_get('maintenance_mode', 0),
2226
    '#description' => t('When enabled, only users with the "Use the site in maintenance mode" <a href="@permissions-url">permission</a> are able to access your site to perform maintenance; all other visitors see the maintenance mode message configured below. Authorized users can log in directly via the <a href="@user-login">user login</a> page.', array('@permissions-url' => url('admin/people/permissions'), '@user-login' => url('user'))),
2227
  );
2228
  $form['maintenance_mode_message'] = array(
2229
    '#type' => 'textarea',
2230
    '#title' => t('Maintenance mode message'),
2231
    '#default_value' => variable_get('maintenance_mode_message', t('@site is currently under maintenance. We should be back shortly. Thank you for your patience.', array('@site' => variable_get('site_name', 'Drupal')))),
2232
    '#description' => t('Message to show visitors when the site is in maintenance mode.')
2233
  );
2234

    
2235
  return system_settings_form($form);
2236
}
2237

    
2238
/**
2239
 * Form builder; Configure clean URL settings.
2240
 *
2241
 * @ingroup forms
2242
 * @see system_settings_form()
2243
 */
2244
function system_clean_url_settings($form, &$form_state) {
2245
  $available = FALSE;
2246
  $conflict = FALSE;
2247

    
2248
  // If the request URI is a clean URL, clean URLs must be available.
2249
  // Otherwise, run a test.
2250
  if (strpos(request_uri(), '?q=') === FALSE && strpos(request_uri(), '&q=') === FALSE) {
2251
    $available = TRUE;
2252
  }
2253
  else {
2254
    $request = drupal_http_request($GLOBALS['base_url'] . '/admin/config/search/clean-urls/check');
2255
    // If the request returns HTTP 200, clean URLs are available.
2256
    if (isset($request->code) && $request->code == 200) {
2257
      $available = TRUE;
2258
      // If the user started the clean URL test, provide explicit feedback.
2259
      if (isset($form_state['input']['clean_url_test_execute'])) {
2260
        drupal_set_message(t('The clean URL test passed.'));
2261
      }
2262
    }
2263
    else {
2264
      // If the test failed while clean URLs are enabled, make sure clean URLs
2265
      // can be disabled.
2266
      if (variable_get('clean_url', 0)) {
2267
        $conflict = TRUE;
2268
        // Warn the user of a conflicting situation, unless after processing
2269
        // a submitted form.
2270
        if (!isset($form_state['input']['op'])) {
2271
          drupal_set_message(t('Clean URLs are enabled, but the clean URL test failed. Uncheck the box below to disable clean URLs.'), 'warning');
2272
        }
2273
      }
2274
      // If the user started the clean URL test, provide explicit feedback.
2275
      elseif (isset($form_state['input']['clean_url_test_execute'])) {
2276
        drupal_set_message(t('The clean URL test failed.'), 'warning');
2277
      }
2278
    }
2279
  }
2280

    
2281
  // Show the enable/disable form if clean URLs are available or if the user
2282
  // must be able to resolve a conflicting setting.
2283
  if ($available || $conflict) {
2284
    $form['clean_url'] = array(
2285
      '#type' => 'checkbox',
2286
      '#title' => t('Enable clean URLs'),
2287
      '#default_value' => variable_get('clean_url', 0),
2288
      '#description' => t('Use URLs like <code>example.com/user</code> instead of <code>example.com/?q=user</code>.'),
2289
    );
2290
    $form = system_settings_form($form);
2291
    if ($conflict) {
2292
      // $form_state['redirect'] needs to be set to the non-clean URL,
2293
      // otherwise the setting is not saved.
2294
      $form_state['redirect'] = url('', array('query' => array('q' => '/admin/config/search/clean-urls')));
2295
    }
2296
  }
2297
  // Show the clean URLs test form.
2298
  else {
2299
    drupal_add_js(drupal_get_path('module', 'system') . '/system.js');
2300

    
2301
    $form_state['redirect'] = url('admin/config/search/clean-urls');
2302
    $form['clean_url_description'] = array(
2303
      '#type' => 'markup',
2304
      '#markup' => '<p>' . t('Use URLs like <code>example.com/user</code> instead of <code>example.com/?q=user</code>.'),
2305
    );
2306
    // Explain why the user is seeing this page and what to expect after
2307
    // clicking the 'Run the clean URL test' button.
2308
    $form['clean_url_test_result'] = array(
2309
      '#type' => 'markup',
2310
      '#markup' => '<p>' . t('Clean URLs cannot be enabled. If you are directed to this page or to a <em>Page not found (404)</em> error after testing for clean URLs, see the <a href="@handbook">online handbook</a>.', array('@handbook' => 'http://drupal.org/node/15365')) . '</p>',
2311
    );
2312
    $form['actions'] = array(
2313
      '#type' => 'actions',
2314
      'clean_url_test' => array(
2315
        '#type' => 'submit',
2316
        '#value' => t('Run the clean URL test'),
2317
      ),
2318
    );
2319
    $form['clean_url_test_execute'] = array(
2320
      '#type' => 'hidden',
2321
      '#value' => 1,
2322
    );
2323
  }
2324

    
2325
  return $form;
2326
}
2327

    
2328
/**
2329
 * Menu callback: displays the site status report. Can also be used as a pure check.
2330
 *
2331
 * @param $check
2332
 *   If true, only returns a boolean whether there are system status errors.
2333
 */
2334
function system_status($check = FALSE) {
2335
  // Load .install files
2336
  include_once DRUPAL_ROOT . '/includes/install.inc';
2337
  drupal_load_updates();
2338

    
2339
  // Check run-time requirements and status information.
2340
  $requirements = module_invoke_all('requirements', 'runtime');
2341
  usort($requirements, '_system_sort_requirements');
2342

    
2343
  if ($check) {
2344
    return drupal_requirements_severity($requirements) == REQUIREMENT_ERROR;
2345
  }
2346
  // MySQL import might have set the uid of the anonymous user to autoincrement
2347
  // value. Let's try fixing it. See http://drupal.org/node/204411
2348
  db_update('users')
2349
    ->expression('uid', 'uid - uid')
2350
    ->condition('name', '')
2351
    ->condition('pass', '')
2352
    ->condition('status', 0)
2353
    ->execute();
2354
  return theme('status_report', array('requirements' => $requirements));
2355
}
2356

    
2357
/**
2358
 * Menu callback: run cron manually.
2359
 */
2360
function system_run_cron() {
2361
  // Run cron manually
2362
  if (drupal_cron_run()) {
2363
    drupal_set_message(t('Cron ran successfully.'));
2364
  }
2365
  else {
2366
    drupal_set_message(t('Cron run failed.'), 'error');
2367
  }
2368

    
2369
  drupal_goto('admin/reports/status');
2370
}
2371

    
2372
/**
2373
 * Menu callback: return information about PHP.
2374
 */
2375
function system_php() {
2376
  phpinfo();
2377
  drupal_exit();
2378
}
2379

    
2380
/**
2381
 * Default page callback for batches.
2382
 */
2383
function system_batch_page() {
2384
  require_once DRUPAL_ROOT . '/includes/batch.inc';
2385
  $output = _batch_page();
2386

    
2387
  if ($output === FALSE) {
2388
    drupal_access_denied();
2389
  }
2390
  elseif (isset($output)) {
2391
    // Force a page without blocks or messages to
2392
    // display a list of collected messages later.
2393
    drupal_set_page_content($output);
2394
    $page = element_info('page');
2395
    $page['#show_messages'] = FALSE;
2396
    return $page;
2397
  }
2398
}
2399

    
2400
/**
2401
 * Returns HTML for an administrative block for display.
2402
 *
2403
 * @param $variables
2404
 *   An associative array containing:
2405
 *   - block: An array containing information about the block:
2406
 *     - show: A Boolean whether to output the block. Defaults to FALSE.
2407
 *     - title: The block's title.
2408
 *     - content: (optional) Formatted content for the block.
2409
 *     - description: (optional) Description of the block. Only output if
2410
 *       'content' is not set.
2411
 *
2412
 * @ingroup themeable
2413
 */
2414
function theme_admin_block($variables) {
2415
  $block = $variables['block'];
2416
  $output = '';
2417

    
2418
  // Don't display the block if it has no content to display.
2419
  if (empty($block['show'])) {
2420
    return $output;
2421
  }
2422

    
2423
  $output .= '<div class="admin-panel">';
2424
  if (!empty($block['title'])) {
2425
    $output .= '<h3>' . $block['title'] . '</h3>';
2426
  }
2427
  if (!empty($block['content'])) {
2428
    $output .= '<div class="body">' . $block['content'] . '</div>';
2429
  }
2430
  else {
2431
    $output .= '<div class="description">' . $block['description'] . '</div>';
2432
  }
2433
  $output .= '</div>';
2434

    
2435
  return $output;
2436
}
2437

    
2438
/**
2439
 * Returns HTML for the content of an administrative block.
2440
 *
2441
 * @param $variables
2442
 *   An associative array containing:
2443
 *   - content: An array containing information about the block. Each element
2444
 *     of the array represents an administrative menu item, and must at least
2445
 *     contain the keys 'title', 'href', and 'localized_options', which are
2446
 *     passed to l(). A 'description' key may also be provided.
2447
 *
2448
 * @ingroup themeable
2449
 */
2450
function theme_admin_block_content($variables) {
2451
  $content = $variables['content'];
2452
  $output = '';
2453

    
2454
  if (!empty($content)) {
2455
    $class = 'admin-list';
2456
    if ($compact = system_admin_compact_mode()) {
2457
      $class .= ' compact';
2458
    }
2459
    $output .= '<dl class="' . $class . '">';
2460
    foreach ($content as $item) {
2461
      $output .= '<dt>' . l($item['title'], $item['href'], $item['localized_options']) . '</dt>';
2462
      if (!$compact && isset($item['description'])) {
2463
        $output .= '<dd>' . filter_xss_admin($item['description']) . '</dd>';
2464
      }
2465
    }
2466
    $output .= '</dl>';
2467
  }
2468
  return $output;
2469
}
2470

    
2471
/**
2472
 * Returns HTML for an administrative page.
2473
 *
2474
 * @param $variables
2475
 *   An associative array containing:
2476
 *   - blocks: An array of blocks to display. Each array should include a
2477
 *     'title', a 'description', a formatted 'content' and a 'position' which
2478
 *     will control which container it will be in. This is usually 'left' or
2479
 *     'right'.
2480
 *
2481
 * @ingroup themeable
2482
 */
2483
function theme_admin_page($variables) {
2484
  $blocks = $variables['blocks'];
2485

    
2486
  $stripe = 0;
2487
  $container = array();
2488

    
2489
  foreach ($blocks as $block) {
2490
    if ($block_output = theme('admin_block', array('block' => $block))) {
2491
      if (empty($block['position'])) {
2492
        // perform automatic striping.
2493
        $block['position'] = ++$stripe % 2 ? 'left' : 'right';
2494
      }
2495
      if (!isset($container[$block['position']])) {
2496
        $container[$block['position']] = '';
2497
      }
2498
      $container[$block['position']] .= $block_output;
2499
    }
2500
  }
2501

    
2502
  $output = '<div class="admin clearfix">';
2503
  $output .= theme('system_compact_link');
2504

    
2505
  foreach ($container as $id => $data) {
2506
    $output .= '<div class="' . $id . ' clearfix">';
2507
    $output .= $data;
2508
    $output .= '</div>';
2509
  }
2510
  $output .= '</div>';
2511
  return $output;
2512
}
2513

    
2514
/**
2515
 * Returns HTML for the output of the dashboard page.
2516
 *
2517
 * @param $variables
2518
 *   An associative array containing:
2519
 *   - menu_items: An array of modules to be displayed.
2520
 *
2521
 * @ingroup themeable
2522
 */
2523
function theme_system_admin_index($variables) {
2524
  $menu_items = $variables['menu_items'];
2525

    
2526
  $stripe = 0;
2527
  $container = array('left' => '', 'right' => '');
2528
  $flip = array('left' => 'right', 'right' => 'left');
2529
  $position = 'left';
2530

    
2531
  // Iterate over all modules.
2532
  foreach ($menu_items as $module => $block) {
2533
    list($description, $items) = $block;
2534

    
2535
    // Output links.
2536
    if (count($items)) {
2537
      $block = array();
2538
      $block['title'] = $module;
2539
      $block['content'] = theme('admin_block_content', array('content' => $items));
2540
      $block['description'] = t($description);
2541
      $block['show'] = TRUE;
2542

    
2543
      if ($block_output = theme('admin_block', array('block' => $block))) {
2544
        if (!isset($block['position'])) {
2545
          // Perform automatic striping.
2546
          $block['position'] = $position;
2547
          $position = $flip[$position];
2548
        }
2549
        $container[$block['position']] .= $block_output;
2550
      }
2551
    }
2552
  }
2553

    
2554
  $output = '<div class="admin clearfix">';
2555
  $output .= theme('system_compact_link');
2556
  foreach ($container as $id => $data) {
2557
    $output .= '<div class="' . $id . ' clearfix">';
2558
    $output .= $data;
2559
    $output .= '</div>';
2560
  }
2561
  $output .= '</div>';
2562

    
2563
  return $output;
2564
}
2565

    
2566
/**
2567
 * Returns HTML for the status report.
2568
 *
2569
 * This theme function is dependent on install.inc being loaded, because
2570
 * that's where the constants are defined.
2571
 *
2572
 * @param $variables
2573
 *   An associative array containing:
2574
 *   - requirements: An array of requirements/status items. Each requirement
2575
 *     is an associative array containing the following elements:
2576
 *     - title: The name of the requirement.
2577
 *     - value: (optional) The current value (version, time, level, etc).
2578
 *     - description: (optional) The description of the requirement.
2579
 *     - severity: (optional) The requirement's result/severity level, one of:
2580
 *       - REQUIREMENT_INFO: Status information.
2581
 *       - REQUIREMENT_OK: The requirement is satisfied.
2582
 *       - REQUIREMENT_WARNING: The requirement failed with a warning.
2583
 *       - REQUIREMENT_ERROR: The requirement failed with an error.
2584
 *
2585
 * @ingroup themeable
2586
 */
2587
function theme_status_report($variables) {
2588
  $requirements = $variables['requirements'];
2589
  $severities = array(
2590
    REQUIREMENT_INFO => array(
2591
      'title' => t('Info'),
2592
      'class' => 'info',
2593
    ),
2594
    REQUIREMENT_OK => array(
2595
      'title' => t('OK'),
2596
      'class' => 'ok',
2597
    ),
2598
    REQUIREMENT_WARNING => array(
2599
      'title' => t('Warning'),
2600
      'class' => 'warning',
2601
    ),
2602
    REQUIREMENT_ERROR => array(
2603
      'title' => t('Error'),
2604
      'class' => 'error',
2605
    ),
2606
  );
2607
  $output = '<table class="system-status-report">';
2608

    
2609
  foreach ($requirements as $requirement) {
2610
    if (empty($requirement['#type'])) {
2611
      $severity = $severities[isset($requirement['severity']) ? (int) $requirement['severity'] : REQUIREMENT_OK];
2612
      $severity['icon'] = '<div title="' . $severity['title'] . '"><span class="element-invisible">' . $severity['title'] . '</span></div>';
2613
      // The requirement's 'value' key is optional, provide a default value.
2614
      $requirement['value'] = isset($requirement['value']) ? $requirement['value'] : '';
2615

    
2616
      // Output table row(s)
2617
      if (!empty($requirement['description'])) {
2618
        $output .= '<tr class="' . $severity['class'] . ' merge-down"><td class="status-icon">' . $severity['icon'] . '</td><td class="status-title">' . $requirement['title'] . '</td><td class="status-value">' . $requirement['value'] . '</td></tr>';
2619
        $output .= '<tr class="' . $severity['class'] . ' merge-up"><td colspan="3" class="status-description">' . $requirement['description'] . '</td></tr>';
2620
      }
2621
      else {
2622
        $output .= '<tr class="' . $severity['class'] . '"><td class="status-icon">' . $severity['icon'] . '</td><td class="status-title">' . $requirement['title'] . '</td><td class="status-value">' . $requirement['value'] . '</td></tr>';
2623
      }
2624
    }
2625
  }
2626

    
2627
  $output .= '</table>';
2628
  return $output;
2629
}
2630

    
2631
/**
2632
 * Returns HTML for the modules form.
2633
 *
2634
 * @param $variables
2635
 *   An associative array containing:
2636
 *   - form: A render element representing the form.
2637
 *
2638
 * @ingroup themeable
2639
 */
2640
function theme_system_modules_fieldset($variables) {
2641
  $form = $variables['form'];
2642

    
2643
  // Individual table headers.
2644
  $rows = array();
2645
  // Iterate through all the modules, which are
2646
  // children of this fieldset.
2647
  foreach (element_children($form) as $key) {
2648
    // Stick it into $module for easier accessing.
2649
    $module = $form[$key];
2650
    $row = array();
2651
    unset($module['enable']['#title']);
2652
    $row[] = array('class' => array('checkbox'), 'data' => drupal_render($module['enable']));
2653
    $label = '<label';
2654
    if (isset($module['enable']['#id'])) {
2655
      $label .= ' for="' . $module['enable']['#id'] . '"';
2656
    }
2657
    $row[] = $label . '><strong>' . drupal_render($module['name']) . '</strong></label>';
2658
    $row[] = drupal_render($module['version']);
2659
    // Add the description, along with any modules it requires.
2660
    $description = drupal_render($module['description']);
2661
    if ($module['#requires']) {
2662
      $description .= '<div class="admin-requirements">' . t('Requires: !module-list', array('!module-list' => implode(', ', $module['#requires']))) . '</div>';
2663
    }
2664
    if ($module['#required_by']) {
2665
      $description .= '<div class="admin-requirements">' . t('Required by: !module-list', array('!module-list' => implode(', ', $module['#required_by']))) . '</div>';
2666
    }
2667
    $row[] = array('data' => $description, 'class' => array('description'));
2668
    // Display links (such as help or permissions) in their own columns.
2669
    foreach (array('help', 'permissions', 'configure') as $link_type) {
2670
      $row[] = array('data' => drupal_render($module['links'][$link_type]), 'class' => array($link_type));
2671
    }
2672
    $rows[] = $row;
2673
  }
2674

    
2675
  return theme('table', array('header' => $form['#header'], 'rows' => $rows));
2676
}
2677

    
2678
/**
2679
 * Returns HTML for a message about incompatible modules.
2680
 *
2681
 * @param $variables
2682
 *   An associative array containing:
2683
 *   - message: The form array representing the currently disabled modules.
2684
 *
2685
 * @ingroup themeable
2686
 */
2687
function theme_system_modules_incompatible($variables) {
2688
  return '<div class="incompatible">' . $variables['message'] . '</div>';
2689
}
2690

    
2691
/**
2692
 * Returns HTML for a table of currently disabled modules.
2693
 *
2694
 * @param $variables
2695
 *   An associative array containing:
2696
 *   - form: A render element representing the form.
2697
 *
2698
 * @ingroup themeable
2699
 */
2700
function theme_system_modules_uninstall($variables) {
2701
  $form = $variables['form'];
2702

    
2703
  // No theming for the confirm form.
2704
  if (isset($form['confirm'])) {
2705
    return drupal_render($form);
2706
  }
2707

    
2708
  // Table headers.
2709
  $header = array(t('Uninstall'),
2710
    t('Name'),
2711
    t('Description'),
2712
  );
2713

    
2714
  // Display table.
2715
  $rows = array();
2716
  foreach (element_children($form['modules']) as $module) {
2717
    if (!empty($form['modules'][$module]['#required_by'])) {
2718
      $disabled_message = format_plural(count($form['modules'][$module]['#required_by']),
2719
        'To uninstall @module, the following module must be uninstalled first: @required_modules',
2720
        'To uninstall @module, the following modules must be uninstalled first: @required_modules',
2721
        array('@module' => $form['modules'][$module]['#module_name'], '@required_modules' => implode(', ', $form['modules'][$module]['#required_by'])));
2722
      $disabled_message = '<div class="admin-requirements">' . $disabled_message . '</div>';
2723
    }
2724
    else {
2725
      $disabled_message = '';
2726
    }
2727
    $rows[] = array(
2728
      array('data' => drupal_render($form['uninstall'][$module]), 'align' => 'center'),
2729
      '<strong><label for="' . $form['uninstall'][$module]['#id'] . '">' . drupal_render($form['modules'][$module]['name']) . '</label></strong>',
2730
      array('data' => drupal_render($form['modules'][$module]['description']) . $disabled_message, 'class' => array('description')),
2731
    );
2732
  }
2733

    
2734
  $output  = theme('table', array('header' => $header, 'rows' => $rows, 'empty' => t('No modules are available to uninstall.')));
2735
  $output .= drupal_render_children($form);
2736

    
2737
  return $output;
2738
}
2739

    
2740
/**
2741
 * Returns HTML for the Appearance page.
2742
 *
2743
 * @param $variables
2744
 *   An associative array containing:
2745
 *   - theme_groups: An associative array containing groups of themes.
2746
 *
2747
 * @ingroup themeable
2748
 */
2749
function theme_system_themes_page($variables) {
2750
  $theme_groups = $variables['theme_groups'];
2751

    
2752
  $output = '<div id="system-themes-page">';
2753

    
2754
  foreach ($variables['theme_group_titles'] as $state => $title) {
2755
    if (!count($theme_groups[$state])) {
2756
      // Skip this group of themes if no theme is there.
2757
      continue;
2758
    }
2759
    // Start new theme group.
2760
    $output .= '<div class="system-themes-list system-themes-list-'. $state .' clearfix"><h2>'. $title .'</h2>';
2761

    
2762
    foreach ($theme_groups[$state] as $theme) {
2763

    
2764
      // Theme the screenshot.
2765
      $screenshot = $theme->screenshot ? theme('image', $theme->screenshot) : '<div class="no-screenshot">' . t('no screenshot') . '</div>';
2766

    
2767
      // Localize the theme description.
2768
      $description = t($theme->info['description']);
2769

    
2770
      // Style theme info
2771
      $notes = count($theme->notes) ? ' (' . join(', ', $theme->notes) . ')' : '';
2772
      $theme->classes[] = 'theme-selector';
2773
      $theme->classes[] = 'clearfix';
2774
      $output .= '<div class="'. join(' ', $theme->classes) .'">' . $screenshot . '<div class="theme-info"><h3>' . $theme->info['name'] . ' ' . (isset($theme->info['version']) ? $theme->info['version'] : '') . $notes . '</h3><div class="theme-description">' . $description . '</div>';
2775

    
2776
      // Make sure to provide feedback on compatibility.
2777
      if (!empty($theme->incompatible_core)) {
2778
        $output .= '<div class="incompatible">' . t('This version is not compatible with Drupal !core_version and should be replaced.', array('!core_version' => DRUPAL_CORE_COMPATIBILITY)) . '</div>';
2779
      }
2780
      elseif (!empty($theme->incompatible_php)) {
2781
        if (substr_count($theme->info['php'], '.') < 2) {
2782
          $theme->info['php'] .= '.*';
2783
        }
2784
        $output .= '<div class="incompatible">' . t('This theme requires PHP version @php_required and is incompatible with PHP version !php_version.', array('@php_required' => $theme->info['php'], '!php_version' => phpversion())) . '</div>';
2785
      }
2786
      else {
2787
        $output .= theme('links', array('links' => $theme->operations, 'attributes' => array('class' => array('operations', 'clearfix'))));
2788
      }
2789
      $output .= '</div></div>';
2790
    }
2791
    $output .= '</div>';
2792
  }
2793
  $output .= '</div>';
2794

    
2795
  return $output;
2796
}
2797

    
2798
/**
2799
 * Menu callback; present a form for deleting a date format.
2800
 */
2801
function system_date_delete_format_form($form, &$form_state, $dfid) {
2802
  $form['dfid'] = array(
2803
    '#type' => 'value',
2804
    '#value' => $dfid,
2805
  );
2806
  $format = system_get_date_format($dfid);
2807

    
2808
  $output = confirm_form($form,
2809
    t('Are you sure you want to remove the format %format?', array('%format' => format_date(REQUEST_TIME, 'custom', $format->format))),
2810
    'admin/config/regional/date-time/formats',
2811
    t('This action cannot be undone.'),
2812
    t('Remove'), t('Cancel'),
2813
    'confirm'
2814
  );
2815

    
2816
  return $output;
2817
}
2818

    
2819
/**
2820
 * Delete a configured date format.
2821
 */
2822
function system_date_delete_format_form_submit($form, &$form_state) {
2823
  if ($form_state['values']['confirm']) {
2824
    $format = system_get_date_format($form_state['values']['dfid']);
2825
    system_date_format_delete($form_state['values']['dfid']);
2826
    drupal_set_message(t('Removed date format %format.', array('%format' => format_date(REQUEST_TIME, 'custom', $format->format))));
2827
    $form_state['redirect'] = 'admin/config/regional/date-time/formats';
2828
  }
2829
}
2830

    
2831
/**
2832
 * Menu callback; present a form for deleting a date type.
2833
 */
2834
function system_delete_date_format_type_form($form, &$form_state, $format_type) {
2835
  $form['format_type'] = array(
2836
    '#type' => 'value',
2837
    '#value' => $format_type,
2838
  );
2839
  $type_info = system_get_date_types($format_type);
2840

    
2841
  $output = confirm_form($form,
2842
    t('Are you sure you want to remove the date type %type?', array('%type' => $type_info['title'])),
2843
    'admin/config/regional/date-time',
2844
    t('This action cannot be undone.'),
2845
    t('Remove'), t('Cancel'),
2846
    'confirm'
2847
  );
2848

    
2849
  return $output;
2850
}
2851

    
2852
/**
2853
 * Delete a configured date type.
2854
 */
2855
function system_delete_date_format_type_form_submit($form, &$form_state) {
2856
  if ($form_state['values']['confirm']) {
2857
    $type_info = system_get_date_types($form_state['values']['format_type']);
2858
    system_date_format_type_delete($form_state['values']['format_type']);
2859
    drupal_set_message(t('Removed date type %type.', array('%type' => $type_info['title'])));
2860
    $form_state['redirect'] = 'admin/config/regional/date-time';
2861
  }
2862
}
2863

    
2864

    
2865
/**
2866
 * Displays the date format strings overview page.
2867
 */
2868
function system_date_time_formats() {
2869
  $header = array(t('Format'), array('data' => t('Operations'), 'colspan' => '2'));
2870
  $rows = array();
2871

    
2872
  drupal_static_reset('system_get_date_formats');
2873
  $formats = system_get_date_formats('custom');
2874
  if (!empty($formats)) {
2875
    foreach ($formats as $format) {
2876
      $row = array();
2877
      $row[] = array('data' => format_date(REQUEST_TIME, 'custom', $format['format']));
2878
      $row[] = array('data' => l(t('edit'), 'admin/config/regional/date-time/formats/' . $format['dfid'] . '/edit'));
2879
      $row[] = array('data' => l(t('delete'), 'admin/config/regional/date-time/formats/' . $format['dfid'] . '/delete'));
2880
      $rows[] = $row;
2881
    }
2882
  }
2883

    
2884
  $build['date_formats_table'] = array(
2885
    '#theme' => 'table',
2886
    '#header' => $header,
2887
    '#rows' => $rows,
2888
    '#empty' => t('No custom date formats available. <a href="@link">Add date format</a>.', array('@link' => url('admin/config/regional/date-time/formats/add'))),
2889
  );
2890

    
2891
  return $build;
2892
}
2893

    
2894
/**
2895
 * Allow users to add additional date formats.
2896
 */
2897
function system_configure_date_formats_form($form, &$form_state, $dfid = 0) {
2898
  $ajax_path = 'admin/config/regional/date-time/formats/lookup';
2899
  $js_settings = array(
2900
    'type' => 'setting',
2901
    'data' => array(
2902
      'dateTime' => array(
2903
        'date-format' => array(
2904
          'text' => t('Displayed as'),
2905
          'lookup' => url($ajax_path, array('query' => array('token' => drupal_get_token($ajax_path)))),
2906
        ),
2907
      ),
2908
    ),
2909
  );
2910

    
2911
  if ($dfid) {
2912
    $form['dfid'] = array(
2913
      '#type' => 'value',
2914
      '#value' => $dfid,
2915
    );
2916
    $format = system_get_date_format($dfid);
2917
  }
2918

    
2919
  $now = ($dfid ? t('Displayed as %date', array('%date' => format_date(REQUEST_TIME, 'custom', $format->format))) : '');
2920

    
2921
  $form['date_format'] = array(
2922
    '#type' => 'textfield',
2923
    '#title' => t('Format string'),
2924
    '#maxlength' => 100,
2925
    '#description' => t('A user-defined date format. See the <a href="@url">PHP manual</a> for available options.', array('@url' => 'http://php.net/manual/function.date.php')),
2926
    '#default_value' => ($dfid ? $format->format : ''),
2927
    '#field_suffix' => ' <small id="edit-date-format-suffix">' . $now . '</small>',
2928
    '#attached' => array(
2929
      'js' => array(drupal_get_path('module', 'system') . '/system.js', $js_settings),
2930
    ),
2931
    '#required' => TRUE,
2932
  );
2933

    
2934
  $form['actions'] = array('#type' => 'actions');
2935
  $form['actions']['update'] = array(
2936
    '#type' => 'submit',
2937
    '#value' => ($dfid ? t('Save format') : t('Add format')),
2938
  );
2939

    
2940
  $form['#validate'][] = 'system_add_date_formats_form_validate';
2941
  $form['#submit'][] = 'system_add_date_formats_form_submit';
2942

    
2943
  return $form;
2944
}
2945

    
2946
/**
2947
 * Validate new date format string submission.
2948
 */
2949
function system_add_date_formats_form_validate($form, &$form_state) {
2950
  $formats = system_get_date_formats('custom');
2951
  $format = trim($form_state['values']['date_format']);
2952
  if (!empty($formats) && in_array($format, array_keys($formats)) && (!isset($form_state['values']['dfid']) || $form_state['values']['dfid'] != $formats[$format]['dfid'])) {
2953
    form_set_error('date_format', t('This format already exists. Enter a unique format string.'));
2954
  }
2955
}
2956

    
2957
/**
2958
 * Process new date format string submission.
2959
 */
2960
function system_add_date_formats_form_submit($form, &$form_state) {
2961
  $format = array();
2962
  $format['format'] = trim($form_state['values']['date_format']);
2963
  $format['type'] = 'custom';
2964
  $format['locked'] = 0;
2965
  if (!empty($form_state['values']['dfid'])) {
2966
    system_date_format_save($format, $form_state['values']['dfid']);
2967
    drupal_set_message(t('Custom date format updated.'));
2968
  }
2969
  else {
2970
    $format['is_new'] = 1;
2971
    system_date_format_save($format);
2972
    drupal_set_message(t('Custom date format added.'));
2973
  }
2974

    
2975
  $form_state['redirect'] = 'admin/config/regional/date-time/formats';
2976
}
2977

    
2978
/**
2979
 * Menu callback; Displays an overview of available and configured actions.
2980
 */
2981
function system_actions_manage() {
2982
  actions_synchronize();
2983
  $actions = actions_list();
2984
  $actions_map = actions_actions_map($actions);
2985
  $options = array();
2986
  $unconfigurable = array();
2987

    
2988
  foreach ($actions_map as $key => $array) {
2989
    if ($array['configurable']) {
2990
      $options[$key] = $array['label'] . '...';
2991
    }
2992
    else {
2993
      $unconfigurable[] = $array;
2994
    }
2995
  }
2996

    
2997
  $row = array();
2998
  $instances_present = db_query("SELECT aid FROM {actions} WHERE parameters <> ''")->fetchField();
2999
  $header = array(
3000
    array('data' => t('Action type'), 'field' => 'type'),
3001
    array('data' => t('Label'), 'field' => 'label'),
3002
    array('data' => $instances_present ? t('Operations') : '', 'colspan' => '2')
3003
  );
3004
  $query = db_select('actions')->extend('PagerDefault')->extend('TableSort');
3005
  $result = $query
3006
    ->fields('actions')
3007
    ->limit(50)
3008
    ->orderByHeader($header)
3009
    ->execute();
3010

    
3011
  foreach ($result as $action) {
3012
    $row[] = array(
3013
      array('data' => $action->type),
3014
      array('data' => check_plain($action->label)),
3015
      array('data' => $action->parameters ? l(t('configure'), "admin/config/system/actions/configure/$action->aid") : ''),
3016
      array('data' => $action->parameters ? l(t('delete'), "admin/config/system/actions/delete/$action->aid") : '')
3017
    );
3018
  }
3019

    
3020
  if ($row) {
3021
    $pager = theme('pager');
3022
    if (!empty($pager)) {
3023
      $row[] = array(array('data' => $pager, 'colspan' => '3'));
3024
    }
3025
    $build['system_actions_header'] = array('#markup' => '<h3>' . t('Available actions:') . '</h3>');
3026
    $build['system_actions_table'] = array('#markup' => theme('table', array('header' => $header, 'rows' => $row)));
3027
  }
3028

    
3029
  if ($actions_map) {
3030
    $build['system_actions_manage_form'] = drupal_get_form('system_actions_manage_form', $options);
3031
  }
3032

    
3033
  return $build;
3034
}
3035

    
3036
/**
3037
 * Define the form for the actions overview page.
3038
 *
3039
 * @param $form_state
3040
 *   An associative array containing the current state of the form; not used.
3041
 * @param $options
3042
 *   An array of configurable actions.
3043
 * @return
3044
 *   Form definition.
3045
 *
3046
 * @ingroup forms
3047
 * @see system_actions_manage_form_submit()
3048
 */
3049
function system_actions_manage_form($form, &$form_state, $options = array()) {
3050
  $form['parent'] = array(
3051
    '#type' => 'fieldset',
3052
    '#title' => t('Create an advanced action'),
3053
    '#attributes' => array('class' => array('container-inline')),
3054
  );
3055
  $form['parent']['action'] = array(
3056
    '#type' => 'select',
3057
    '#title' => t('Action'),
3058
    '#title_display' => 'invisible',
3059
    '#options' => $options,
3060
    '#empty_option' => t('Choose an advanced action'),
3061
  );
3062
  $form['parent']['actions'] = array('#type' => 'actions');
3063
  $form['parent']['actions']['submit'] = array(
3064
    '#type' => 'submit',
3065
    '#value' => t('Create'),
3066
  );
3067
  return $form;
3068
}
3069

    
3070
/**
3071
 * Process system_actions_manage form submissions.
3072
 *
3073
 * @see system_actions_manage_form()
3074
 */
3075
function system_actions_manage_form_submit($form, &$form_state) {
3076
  if ($form_state['values']['action']) {
3077
    $form_state['redirect'] = 'admin/config/system/actions/configure/' . $form_state['values']['action'];
3078
  }
3079
}
3080

    
3081
/**
3082
 * Menu callback; Creates the form for configuration of a single action.
3083
 *
3084
 * We provide the "Description" field. The rest of the form is provided by the
3085
 * action. We then provide the Save button. Because we are combining unknown
3086
 * form elements with the action configuration form, we use an 'actions_' prefix
3087
 * on our elements.
3088
 *
3089
 * @param $action
3090
 *   Hash of an action ID or an integer. If it is a hash, we are
3091
 *   creating a new instance. If it is an integer, we are editing an existing
3092
 *   instance.
3093
 * @return
3094
 *   A form definition.
3095
 *
3096
 * @see system_actions_configure_validate()
3097
 * @see system_actions_configure_submit()
3098
 */
3099
function system_actions_configure($form, &$form_state, $action = NULL) {
3100
  if ($action === NULL) {
3101
    drupal_goto('admin/config/system/actions');
3102
  }
3103

    
3104
  $actions_map = actions_actions_map(actions_list());
3105
  $edit = array();
3106

    
3107
  // Numeric action denotes saved instance of a configurable action.
3108
  if (is_numeric($action)) {
3109
    $aid = $action;
3110
    // Load stored parameter values from database.
3111
    $data = db_query("SELECT * FROM {actions} WHERE aid = :aid", array(':aid' => $aid))->fetch();
3112
    $edit['actions_label'] = $data->label;
3113
    $edit['actions_type'] = $data->type;
3114
    $function = $data->callback;
3115
    $action = drupal_hash_base64($data->callback);
3116
    $params = unserialize($data->parameters);
3117
    if ($params) {
3118
      foreach ($params as $name => $val) {
3119
        $edit[$name] = $val;
3120
      }
3121
    }
3122
  }
3123
  // Otherwise, we are creating a new action instance.
3124
  else {
3125
    $function = $actions_map[$action]['callback'];
3126
    $edit['actions_label'] = $actions_map[$action]['label'];
3127
    $edit['actions_type'] = $actions_map[$action]['type'];
3128
  }
3129

    
3130
  $form['actions_label'] = array(
3131
    '#type' => 'textfield',
3132
    '#title' => t('Label'),
3133
    '#default_value' => $edit['actions_label'],
3134
    '#maxlength' => '255',
3135
    '#description' => t('A unique label for this advanced action. This label will be displayed in the interface of modules that integrate with actions, such as Trigger module.'),
3136
    '#weight' => -10
3137
  );
3138
  $action_form = $function . '_form';
3139
  $form = array_merge($form, $action_form($edit));
3140
  $form['actions_type'] = array(
3141
    '#type' => 'value',
3142
    '#value' => $edit['actions_type'],
3143
  );
3144
  $form['actions_action'] = array(
3145
    '#type' => 'hidden',
3146
    '#value' => $action,
3147
  );
3148
  // $aid is set when configuring an existing action instance.
3149
  if (isset($aid)) {
3150
    $form['actions_aid'] = array(
3151
      '#type' => 'hidden',
3152
      '#value' => $aid,
3153
    );
3154
  }
3155
  $form['actions_configured'] = array(
3156
    '#type' => 'hidden',
3157
    '#value' => '1',
3158
  );
3159
  $form['actions'] = array('#type' => 'actions');
3160
  $form['actions']['submit'] = array(
3161
    '#type' => 'submit',
3162
    '#value' => t('Save'),
3163
    '#weight' => 13
3164
  );
3165

    
3166
  return $form;
3167
}
3168

    
3169
/**
3170
 * Validate system_actions_configure() form submissions.
3171
 */
3172
function system_actions_configure_validate($form, &$form_state) {
3173
  $function = actions_function_lookup($form_state['values']['actions_action']) . '_validate';
3174
  // Hand off validation to the action.
3175
  if (function_exists($function)) {
3176
    $function($form, $form_state);
3177
  }
3178
}
3179

    
3180
/**
3181
 * Process system_actions_configure() form submissions.
3182
 */
3183
function system_actions_configure_submit($form, &$form_state) {
3184
  $function = actions_function_lookup($form_state['values']['actions_action']);
3185
  $submit_function = $function . '_submit';
3186

    
3187
  // Action will return keyed array of values to store.
3188
  $params = $submit_function($form, $form_state);
3189
  $aid = isset($form_state['values']['actions_aid']) ? $form_state['values']['actions_aid'] : NULL;
3190

    
3191
  actions_save($function, $form_state['values']['actions_type'], $params, $form_state['values']['actions_label'], $aid);
3192
  drupal_set_message(t('The action has been successfully saved.'));
3193

    
3194
  $form_state['redirect'] = 'admin/config/system/actions/manage';
3195
}
3196

    
3197
/**
3198
 * Create the form for confirmation of deleting an action.
3199
 *
3200
 * @see system_actions_delete_form_submit()
3201
 * @ingroup forms
3202
 */
3203
function system_actions_delete_form($form, &$form_state, $action) {
3204
  $form['aid'] = array(
3205
    '#type' => 'hidden',
3206
    '#value' => $action->aid,
3207
  );
3208
  return confirm_form($form,
3209
    t('Are you sure you want to delete the action %action?', array('%action' => $action->label)),
3210
    'admin/config/system/actions/manage',
3211
    t('This cannot be undone.'),
3212
    t('Delete'),
3213
    t('Cancel')
3214
  );
3215
}
3216

    
3217
/**
3218
 * Process system_actions_delete form submissions.
3219
 *
3220
 * Post-deletion operations for action deletion.
3221
 */
3222
function system_actions_delete_form_submit($form, &$form_state) {
3223
  $aid = $form_state['values']['aid'];
3224
  $action = actions_load($aid);
3225
  actions_delete($aid);
3226
  watchdog('user', 'Deleted action %aid (%action)', array('%aid' => $aid, '%action' => $action->label));
3227
  drupal_set_message(t('Action %action was deleted', array('%action' => $action->label)));
3228
  $form_state['redirect'] = 'admin/config/system/actions/manage';
3229
}
3230

    
3231
/**
3232
 * Post-deletion operations for deleting action orphans.
3233
 *
3234
 * @param $orphaned
3235
 *   An array of orphaned actions.
3236
 */
3237
function system_action_delete_orphans_post($orphaned) {
3238
  foreach ($orphaned as $callback) {
3239
    drupal_set_message(t("Deleted orphaned action (%action).", array('%action' => $callback)));
3240
  }
3241
}
3242

    
3243
/**
3244
 * Remove actions that are in the database but not supported by any enabled module.
3245
 */
3246
function system_actions_remove_orphans() {
3247
  actions_synchronize(TRUE);
3248
  drupal_goto('admin/config/system/actions/manage');
3249
}