Projet

Général

Profil

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

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

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
      $filename = DRUPAL_ROOT . '/' . str_replace("/$theme.info", '', $themes[$theme]->filename) . '/theme-settings.php';
576
      if (file_exists($filename)) {
577
        require_once $filename;
578
      }
579

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
730
  if (empty($values['default_favicon']) && !empty($values['favicon_path'])) {
731
    $values['favicon_mimetype'] = file_get_mimetype($values['favicon_path']);
732
  }
733

    
734
  variable_set($key, $values);
735
  drupal_set_message(t('The configuration options have been saved.'));
736

    
737
  cache_clear_all();
738
}
739

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

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

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

    
800
  uasort($visible_files, 'system_sort_modules_by_info_name');
801

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

    
810
  $modules = array();
811
  $form['modules'] = array('#tree' => TRUE);
812

    
813
  // Used when checking if module implements a help page.
814
  $help_arg = module_exists('help') ? drupal_help_arg() : FALSE;
815

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

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

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

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

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

    
932
  // Lastly, sort all fieldsets by title.
933
  uasort($form['modules'], 'element_sort_by_title');
934

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

    
942
  return $form;
943
}
944

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

    
952
/**
953
 * Array sorting callback; sorts modules or themes by their name.
954
 */
955
function system_sort_themes($a, $b) {
956
  if ($a->is_default) {
957
    return -1;
958
  }
959
  if ($b->is_default) {
960
    return 1;
961
  }
962
  return strcasecmp($a->info['name'], $b->info['name']);
963
}
964

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

    
993
  // Check the compatibilities.
994
  $compatible = TRUE;
995
  $status_short = '';
996
  $status_long = '';
997

    
998
  // Check the core compatibility.
999
  if (!isset($info['core']) || $info['core'] != DRUPAL_CORE_COMPATIBILITY) {
1000
    $compatible = FALSE;
1001
    $status_short .= t('Incompatible with this version of Drupal core.');
1002
    $status_long .= t('This version is not compatible with Drupal !core_version and should be replaced.', array('!core_version' => DRUPAL_CORE_COMPATIBILITY));
1003
  }
1004

    
1005
  // Ensure this module is compatible with the currently installed version of PHP.
1006
  if (version_compare(phpversion(), $info['php']) < 0) {
1007
    $compatible = FALSE;
1008
    $status_short .= t('Incompatible with this version of PHP');
1009
    $php_required = $info['php'];
1010
    if (substr_count($info['php'], '.') < 2) {
1011
      $php_required .= '.*';
1012
    }
1013
    $status_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()));
1014
  }
1015

    
1016
  // If this module is compatible, present a checkbox indicating
1017
  // this module may be installed. Otherwise, show a big red X.
1018
  if ($compatible) {
1019
    $form['enable'] = array(
1020
      '#type' => 'checkbox',
1021
      '#title' => t('Enable'),
1022
      '#default_value' => $extra['enabled'],
1023
    );
1024
    if ($extra['disabled']) {
1025
      $form['enable']['#disabled'] = TRUE;
1026
    }
1027
  }
1028
  else {
1029
    $form['enable'] = array(
1030
      '#markup' =>  theme('image', array('path' => 'misc/watchdog-error.png', 'alt' => $status_short, 'title' => $status_short)),
1031
    );
1032
    $form['description']['#markup'] .= theme('system_modules_incompatible', array('message' => $status_long));
1033
  }
1034

    
1035
  // Build operation links.
1036
  foreach (array('help', 'permissions', 'configure') as $key) {
1037
    $form['links'][$key] = (isset($extra['links'][$key]) ? $extra['links'][$key] : array());
1038
  }
1039

    
1040
  return $form;
1041
}
1042

    
1043
/**
1044
 * Display confirmation form for required modules.
1045
 *
1046
 * @param $modules
1047
 *   Array of module file objects as returned from system_rebuild_module_data().
1048
 * @param $storage
1049
 *   The contents of $form_state['storage']; an array with two
1050
 *   elements: the list of required modules and the list of status
1051
 *   form field values from the previous screen.
1052
 * @ingroup forms
1053
 */
1054
function system_modules_confirm_form($modules, $storage) {
1055
  $items = array();
1056

    
1057
  $form['validation_modules'] = array('#type' => 'value', '#value' => $modules);
1058
  $form['status']['#tree'] = TRUE;
1059

    
1060
  foreach ($storage['more_required'] as $info) {
1061
    $t_argument = array(
1062
      '@module' => $info['name'],
1063
      '@required' => implode(', ', $info['requires']),
1064
    );
1065
    $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);
1066
  }
1067

    
1068
  foreach ($storage['missing_modules'] as $name => $info) {
1069
    $t_argument = array(
1070
      '@module' => $name,
1071
      '@depends' => implode(', ', $info['depends']),
1072
    );
1073
    $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);
1074
  }
1075

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

    
1078
  if ($form) {
1079
    // Set some default form values
1080
    $form = confirm_form(
1081
      $form,
1082
      t('Some required modules must be enabled'),
1083
      'admin/modules',
1084
      t('Would you like to continue with the above?'),
1085
      t('Continue'),
1086
      t('Cancel'));
1087
    return $form;
1088
  }
1089
}
1090

    
1091
/**
1092
 * Submit callback; handles modules form submission.
1093
 */
1094
function system_modules_submit($form, &$form_state) {
1095
  include_once DRUPAL_ROOT . '/includes/install.inc';
1096

    
1097
  // Builds list of modules.
1098
  $modules = array();
1099
  // If we're not coming from the confirmation form, build the list of modules.
1100
  if (empty($form_state['storage'])) {
1101
    // If we're not coming from the confirmation form, build the module list.
1102
    foreach ($form_state['values']['modules'] as $group_name => $group) {
1103
      foreach ($group as $module => $enabled) {
1104
        $modules[$module] = array('group' => $group_name, 'enabled' => $enabled['enable']);
1105
      }
1106
    }
1107
  }
1108
  else {
1109
    // If we are coming from the confirmation form, fetch
1110
    // the modules out of $form_state.
1111
    $modules = $form_state['storage']['modules'];
1112
  }
1113

    
1114
  // Collect data for all modules to be able to determine dependencies.
1115
  $files = system_rebuild_module_data();
1116

    
1117
  // Sorts modules by weight.
1118
  $sort = array();
1119
  foreach (array_keys($modules) as $module) {
1120
    $sort[$module] = $files[$module]->sort;
1121
  }
1122
  array_multisort($sort, $modules);
1123

    
1124
  // Makes sure all required modules are set to be enabled.
1125
  $more_required = array();
1126
  $missing_modules = array();
1127
  foreach ($modules as $name => $module) {
1128
    if ($module['enabled']) {
1129
      // Checks that all dependencies are set to be enabled.  Stores the ones
1130
      // that are not in $dependencies variable so that the user can be alerted
1131
      // in the confirmation form that more modules need to be enabled.
1132
      $dependencies = array();
1133
      foreach (array_keys($files[$name]->requires) as $required) {
1134
        if (empty($modules[$required]['enabled'])) {
1135
          if (isset($files[$required])) {
1136
            $dependencies[] = $files[$required]->info['name'];
1137
            $modules[$required]['enabled'] = TRUE;
1138
          }
1139
          else {
1140
            $missing_modules[$required]['depends'][] = $name;
1141
            $modules[$name]['enabled'] = FALSE;
1142
          }
1143
        }
1144
      }
1145

    
1146
      // Stores additional modules that need to be enabled in $more_required.
1147
      if (!empty($dependencies)) {
1148
        $more_required[$name] = array(
1149
          'name' => $files[$name]->info['name'],
1150
          'requires' => $dependencies,
1151
        );
1152
      }
1153
    }
1154
  }
1155

    
1156
  // Redirects to confirmation form if more modules need to be enabled.
1157
  if ((!empty($more_required) || !empty($missing_modules)) && !isset($form_state['values']['confirm'])) {
1158
    $form_state['storage'] = array(
1159
      'more_required' => $more_required,
1160
      'modules' => $modules,
1161
      'missing_modules' => $missing_modules,
1162
    );
1163
    $form_state['rebuild'] = TRUE;
1164
    return;
1165
  }
1166

    
1167
  // Invokes hook_requirements('install').  If failures are detected, makes sure
1168
  // the dependent modules aren't installed either.
1169
  foreach ($modules as $name => $module) {
1170
    // Only invoke hook_requirements() on modules that are going to be installed.
1171
    if ($module['enabled'] && drupal_get_installed_schema_version($name) == SCHEMA_UNINSTALLED) {
1172
      if (!drupal_check_module($name)) {
1173
        $modules[$name]['enabled'] = FALSE;
1174
        foreach (array_keys($files[$name]->required_by) as $required_by) {
1175
          $modules[$required_by]['enabled'] = FALSE;
1176
        }
1177
      }
1178
    }
1179
  }
1180

    
1181
  // Initializes array of actions.
1182
  $actions = array(
1183
    'enable' => array(),
1184
    'disable' => array(),
1185
    'install' => array(),
1186
  );
1187

    
1188
  // Builds arrays of modules that need to be enabled, disabled, and installed.
1189
  foreach ($modules as $name => $module) {
1190
    if ($module['enabled']) {
1191
      if (drupal_get_installed_schema_version($name) == SCHEMA_UNINSTALLED) {
1192
        $actions['install'][] = $name;
1193
        $actions['enable'][] = $name;
1194
      }
1195
      elseif (!module_exists($name)) {
1196
        $actions['enable'][] = $name;
1197
      }
1198
    }
1199
    elseif (module_exists($name)) {
1200
      $actions['disable'][] = $name;
1201
    }
1202
  }
1203

    
1204
  // Gets list of modules prior to install process, unsets $form_state['storage']
1205
  // so we don't get redirected back to the confirmation form.
1206
  $pre_install_list = module_list();
1207
  unset($form_state['storage']);
1208

    
1209
  // Reverse the 'enable' list, to order dependencies before dependents.
1210
  krsort($actions['enable']);
1211

    
1212
  // Installs, enables, and disables modules.
1213
  module_enable($actions['enable'], FALSE);
1214
  module_disable($actions['disable'], FALSE);
1215

    
1216
  // Gets module list after install process, flushes caches and displays a
1217
  // message if there are changes.
1218
  $post_install_list = module_list(TRUE);
1219
  if ($pre_install_list != $post_install_list) {
1220
    drupal_flush_all_caches();
1221
    drupal_set_message(t('The configuration options have been saved.'));
1222
  }
1223

    
1224
  $form_state['redirect'] = 'admin/modules';
1225
}
1226

    
1227
/**
1228
 * Uninstall functions
1229
 */
1230

    
1231
/**
1232
 * Builds a form of currently disabled modules.
1233
 *
1234
 * @ingroup forms
1235
 * @see system_modules_uninstall_validate()
1236
 * @see system_modules_uninstall_submit()
1237
 * @param $form_state['values']
1238
 *   Submitted form values.
1239
 * @return
1240
 *   A form array representing the currently disabled modules.
1241
 */
1242
function system_modules_uninstall($form, $form_state = NULL) {
1243
  // Make sure the install API is available.
1244
  include_once DRUPAL_ROOT . '/includes/install.inc';
1245

    
1246
  // Display the confirm form if any modules have been submitted.
1247
  if (!empty($form_state['storage']) && $confirm_form = system_modules_uninstall_confirm_form($form_state['storage'])) {
1248
    return $confirm_form;
1249
  }
1250

    
1251
  // Get a list of disabled, installed modules.
1252
  $all_modules = system_rebuild_module_data();
1253
  $disabled_modules = array();
1254
  foreach ($all_modules as $name => $module) {
1255
    if (empty($module->status) && $module->schema_version > SCHEMA_UNINSTALLED) {
1256
      $disabled_modules[$name] = $module;
1257
    }
1258
  }
1259

    
1260
  // Only build the rest of the form if there are any modules available to
1261
  // uninstall.
1262
  if (!empty($disabled_modules)) {
1263
    $profile = drupal_get_profile();
1264
    uasort($disabled_modules, 'system_sort_modules_by_info_name');
1265
    $form['uninstall'] = array('#tree' => TRUE);
1266
    foreach ($disabled_modules as $module) {
1267
      $module_name = $module->info['name'] ? $module->info['name'] : $module->name;
1268
      $form['modules'][$module->name]['#module_name'] = $module_name;
1269
      $form['modules'][$module->name]['name']['#markup'] = $module_name;
1270
      $form['modules'][$module->name]['description']['#markup'] = t($module->info['description']);
1271
      $form['uninstall'][$module->name] = array(
1272
        '#type' => 'checkbox',
1273
        '#title' => t('Uninstall @module module', array('@module' => $module_name)),
1274
        '#title_display' => 'invisible',
1275
      );
1276
      // All modules which depend on this one must be uninstalled first, before
1277
      // we can allow this module to be uninstalled. (The installation profile
1278
      // is excluded from this list.)
1279
      foreach (array_keys($module->required_by) as $dependent) {
1280
        if ($dependent != $profile && drupal_get_installed_schema_version($dependent) != SCHEMA_UNINSTALLED) {
1281
          $dependent_name = isset($all_modules[$dependent]->info['name']) ? $all_modules[$dependent]->info['name'] : $dependent;
1282
          $form['modules'][$module->name]['#required_by'][] = $dependent_name;
1283
          $form['uninstall'][$module->name]['#disabled'] = TRUE;
1284
        }
1285
      }
1286
    }
1287
    $form['actions'] = array('#type' => 'actions');
1288
    $form['actions']['submit'] = array(
1289
      '#type' => 'submit',
1290
      '#value' => t('Uninstall'),
1291
    );
1292
    $form['#action'] = url('admin/modules/uninstall/confirm');
1293
  }
1294
  else {
1295
    $form['modules'] = array();
1296
  }
1297

    
1298
  return $form;
1299
}
1300

    
1301
/**
1302
 * Confirm uninstall of selected modules.
1303
 *
1304
 * @ingroup forms
1305
 * @param $storage
1306
 *   An associative array of modules selected to be uninstalled.
1307
 * @return
1308
 *   A form array representing modules to confirm.
1309
 */
1310
function system_modules_uninstall_confirm_form($storage) {
1311
  // Nothing to build.
1312
  if (empty($storage)) {
1313
    return;
1314
  }
1315

    
1316
  // Construct the hidden form elements and list items.
1317
  foreach (array_filter($storage['uninstall']) as $module => $value) {
1318
    $info = drupal_parse_info_file(drupal_get_path('module', $module) . '/' . $module . '.info');
1319
    $uninstall[] = $info['name'];
1320
    $form['uninstall'][$module] = array('#type' => 'hidden',
1321
      '#value' => 1,
1322
    );
1323
  }
1324

    
1325
  // Display a confirm form if modules have been selected.
1326
  if (isset($uninstall)) {
1327
    $form['#confirmed'] = TRUE;
1328
    $form['uninstall']['#tree'] = TRUE;
1329
    $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)));
1330
    $form = confirm_form(
1331
      $form,
1332
      t('Confirm uninstall'),
1333
      'admin/modules/uninstall',
1334
      t('Would you like to continue with uninstalling the above?'),
1335
      t('Uninstall'),
1336
      t('Cancel'));
1337
    return $form;
1338
  }
1339
}
1340

    
1341
/**
1342
 * Validates the submitted uninstall form.
1343
 */
1344
function system_modules_uninstall_validate($form, &$form_state) {
1345
  // Form submitted, but no modules selected.
1346
  if (!count(array_filter($form_state['values']['uninstall']))) {
1347
    drupal_set_message(t('No modules selected.'), 'error');
1348
    drupal_goto('admin/modules/uninstall');
1349
  }
1350
}
1351

    
1352
/**
1353
 * Processes the submitted uninstall form.
1354
 */
1355
function system_modules_uninstall_submit($form, &$form_state) {
1356
  // Make sure the install API is available.
1357
  include_once DRUPAL_ROOT . '/includes/install.inc';
1358

    
1359
  if (!empty($form['#confirmed'])) {
1360
    // Call the uninstall routine for each selected module.
1361
    $modules = array_keys($form_state['values']['uninstall']);
1362
    drupal_uninstall_modules($modules);
1363
    drupal_set_message(t('The selected modules have been uninstalled.'));
1364

    
1365
    $form_state['redirect'] = 'admin/modules/uninstall';
1366
  }
1367
  else {
1368
    $form_state['storage'] = $form_state['values'];
1369
    $form_state['rebuild'] = TRUE;
1370
  }
1371
}
1372

    
1373
/**
1374
 * Menu callback. Display blocked IP addresses.
1375
 *
1376
 * @param $default_ip
1377
 *   Optional IP address to be passed on to drupal_get_form() for
1378
 *   use as the default value of the IP address form field.
1379
 */
1380
function system_ip_blocking($default_ip = '') {
1381
  $rows = array();
1382
  $header = array(t('Blocked IP addresses'), t('Operations'));
1383
  $result = db_query('SELECT * FROM {blocked_ips}');
1384
  foreach ($result as $ip) {
1385
    $rows[] = array(
1386
      $ip->ip,
1387
      l(t('delete'), "admin/config/people/ip-blocking/delete/$ip->iid"),
1388
    );
1389
  }
1390

    
1391
  $build['system_ip_blocking_form'] = drupal_get_form('system_ip_blocking_form', $default_ip);
1392

    
1393
  $build['system_ip_blocking_table'] = array(
1394
    '#theme' => 'table',
1395
    '#header' => $header,
1396
    '#rows' => $rows,
1397
    '#empty' => t('No blocked IP addresses available.'),
1398
  );
1399

    
1400
  return $build;
1401
}
1402

    
1403
/**
1404
 * Define the form for blocking IP addresses.
1405
 *
1406
 * @ingroup forms
1407
 * @see system_ip_blocking_form_validate()
1408
 * @see system_ip_blocking_form_submit()
1409
 */
1410
function system_ip_blocking_form($form, $form_state, $default_ip) {
1411
  $form['ip'] = array(
1412
    '#title' => t('IP address'),
1413
    '#type' => 'textfield',
1414
    '#size' => 48,
1415
    '#maxlength' => 40,
1416
    '#default_value' => $default_ip,
1417
    '#description' => t('Enter a valid IP address.'),
1418
  );
1419
  $form['actions'] = array('#type' => 'actions');
1420
  $form['actions']['submit'] = array(
1421
    '#type' => 'submit',
1422
    '#value' => t('Add'),
1423
  );
1424
  $form['#submit'][] = 'system_ip_blocking_form_submit';
1425
  $form['#validate'][] = 'system_ip_blocking_form_validate';
1426
  return $form;
1427
}
1428

    
1429
function system_ip_blocking_form_validate($form, &$form_state) {
1430
  $ip = trim($form_state['values']['ip']);
1431
  if (db_query("SELECT * FROM {blocked_ips} WHERE ip = :ip", array(':ip' => $ip))->fetchField()) {
1432
    form_set_error('ip', t('This IP address is already blocked.'));
1433
  }
1434
  elseif ($ip == ip_address()) {
1435
    form_set_error('ip', t('You may not block your own IP address.'));
1436
  }
1437
  elseif (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_NO_RES_RANGE) == FALSE) {
1438
    form_set_error('ip', t('Enter a valid IP address.'));
1439
  }
1440
}
1441

    
1442
function system_ip_blocking_form_submit($form, &$form_state) {
1443
  $ip = trim($form_state['values']['ip']);
1444
  db_insert('blocked_ips')
1445
    ->fields(array('ip' => $ip))
1446
    ->execute();
1447
  drupal_set_message(t('The IP address %ip has been blocked.', array('%ip' => $ip)));
1448
  $form_state['redirect'] = 'admin/config/people/ip-blocking';
1449
  return;
1450
}
1451

    
1452
/**
1453
 * IP deletion confirm page.
1454
 *
1455
 * @see system_ip_blocking_delete_submit()
1456
 */
1457
function system_ip_blocking_delete($form, &$form_state, $iid) {
1458
  $form['blocked_ip'] = array(
1459
    '#type' => 'value',
1460
    '#value' => $iid,
1461
  );
1462
  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'));
1463
}
1464

    
1465
/**
1466
 * Process system_ip_blocking_delete form submissions.
1467
 */
1468
function system_ip_blocking_delete_submit($form, &$form_state) {
1469
  $blocked_ip = $form_state['values']['blocked_ip'];
1470
  db_delete('blocked_ips')
1471
    ->condition('iid', $blocked_ip['iid'])
1472
    ->execute();
1473
  watchdog('user', 'Deleted %ip', array('%ip' => $blocked_ip['ip']));
1474
  drupal_set_message(t('The IP address %ip was deleted.', array('%ip' => $blocked_ip['ip'])));
1475
  $form_state['redirect'] = 'admin/config/people/ip-blocking';
1476
}
1477

    
1478
/**
1479
 * Form builder; The general site information form.
1480
 *
1481
 * @ingroup forms
1482
 * @see system_settings_form()
1483
 */
1484
function system_site_information_settings() {
1485
  $form['site_information'] = array(
1486
    '#type' => 'fieldset',
1487
    '#title' => t('Site details'),
1488
  );
1489
  $form['site_information']['site_name'] = array(
1490
    '#type' => 'textfield',
1491
    '#title' => t('Site name'),
1492
    '#default_value' => variable_get('site_name', 'Drupal'),
1493
    '#required' => TRUE
1494
  );
1495
  $form['site_information']['site_slogan'] = array(
1496
    '#type' => 'textfield',
1497
    '#title' => t('Slogan'),
1498
    '#default_value' => variable_get('site_slogan', ''),
1499
    '#description' => t("How this is used depends on your site's theme."),
1500
  );
1501
  $form['site_information']['site_mail'] = array(
1502
    '#type' => 'textfield',
1503
    '#title' => t('E-mail address'),
1504
    '#default_value' => variable_get('site_mail', ini_get('sendmail_from')),
1505
    '#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.)"),
1506
    '#required' => TRUE,
1507
  );
1508
  $form['front_page'] = array(
1509
    '#type' => 'fieldset',
1510
    '#title' => t('Front page'),
1511
  );
1512
  $form['front_page']['default_nodes_main'] = array(
1513
    '#type' => 'select', '#title' => t('Number of posts on front page'),
1514
    '#default_value' => variable_get('default_nodes_main', 10),
1515
    '#options' => drupal_map_assoc(array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30)),
1516
    '#description' => t('The maximum number of posts displayed on overview pages such as the front page.')
1517
  );
1518
  $form['front_page']['site_frontpage'] = array(
1519
    '#type' => 'textfield',
1520
    '#title' => t('Default front page'),
1521
    '#default_value' => (variable_get('site_frontpage')!='node'?drupal_get_path_alias(variable_get('site_frontpage', 'node')):''),
1522
    '#size' => 40,
1523
    '#description' => t('Optionally, specify a relative URL to display as the front page.  Leave blank to display the default content feed.'),
1524
    '#field_prefix' => url(NULL, array('absolute' => TRUE)) . (variable_get('clean_url', 0) ? '' : '?q='),
1525
  );
1526
  $form['error_page'] = array(
1527
    '#type' => 'fieldset',
1528
    '#title' => t('Error pages'),
1529
  );
1530
  $form['error_page']['site_403'] = array(
1531
    '#type' => 'textfield',
1532
    '#title' => t('Default 403 (access denied) page'),
1533
    '#default_value' => variable_get('site_403', ''),
1534
    '#size' => 40,
1535
    '#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.'),
1536
    '#field_prefix' => url(NULL, array('absolute' => TRUE)) . (variable_get('clean_url', 0) ? '' : '?q=')
1537
  );
1538
  $form['error_page']['site_404'] = array(
1539
    '#type' => 'textfield',
1540
    '#title' => t('Default 404 (not found) page'),
1541
    '#default_value' => variable_get('site_404', ''),
1542
    '#size' => 40,
1543
    '#description' => t('This page is displayed when no other content matches the requested document. Leave blank to display a generic "page not found" page.'),
1544
    '#field_prefix' => url(NULL, array('absolute' => TRUE)) . (variable_get('clean_url', 0) ? '' : '?q=')
1545
  );
1546

    
1547
  $form['#validate'][] = 'system_site_information_settings_validate';
1548

    
1549
  return system_settings_form($form);
1550
}
1551

    
1552
/**
1553
 * Validates the submitted site-information form.
1554
 */
1555
function system_site_information_settings_validate($form, &$form_state) {
1556
  // Validate the e-mail address.
1557
  if ($error = user_validate_mail($form_state['values']['site_mail'])) {
1558
    form_set_error('site_mail', $error);
1559
  }
1560
  // Check for empty front page path.
1561
  if (empty($form_state['values']['site_frontpage'])) {
1562
    // Set to default "node".
1563
    form_set_value($form['front_page']['site_frontpage'], 'node', $form_state);
1564
  }
1565
  else {
1566
    // Get the normal path of the front page.
1567
    form_set_value($form['front_page']['site_frontpage'], drupal_get_normal_path($form_state['values']['site_frontpage']), $form_state);
1568
  }
1569
  // Validate front page path.
1570
  if (!drupal_valid_path($form_state['values']['site_frontpage'])) {
1571
    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'])));
1572
  }
1573
  // Get the normal paths of both error pages.
1574
  if (!empty($form_state['values']['site_403'])) {
1575
    form_set_value($form['error_page']['site_403'], drupal_get_normal_path($form_state['values']['site_403']), $form_state);
1576
  }
1577
  if (!empty($form_state['values']['site_404'])) {
1578
    form_set_value($form['error_page']['site_404'], drupal_get_normal_path($form_state['values']['site_404']), $form_state);
1579
  }
1580
  // Validate 403 error path.
1581
  if (!empty($form_state['values']['site_403']) && !drupal_valid_path($form_state['values']['site_403'])) {
1582
    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'])));
1583
  }
1584
  // Validate 404 error path.
1585
  if (!empty($form_state['values']['site_404']) && !drupal_valid_path($form_state['values']['site_404'])) {
1586
    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'])));
1587
  }
1588
}
1589

    
1590
/**
1591
 * Form builder; Cron form.
1592
 *
1593
 * @see system_settings_form()
1594
 * @ingroup forms
1595
 */
1596
function system_cron_settings() {
1597
  global $base_url;
1598
  $form['description'] = array(
1599
    '#markup' => '<p>' . t('Cron takes care of running periodic tasks like checking for updates and indexing content for search.') . '</p>',
1600
  );
1601
  $form['run'] = array(
1602
    '#type' => 'submit',
1603
    '#value' => t('Run cron'),
1604
    '#submit' => array('system_run_cron_submit'),
1605
  );
1606
  $status = '<p>' . t('Last run: %cron-last ago.', array('%cron-last' => format_interval(REQUEST_TIME - variable_get('cron_last')),)) . '</p>';
1607
  $form['status'] = array(
1608
    '#markup' => $status,
1609
  );
1610

    
1611
  $form['cron_url'] = array(
1612
    '#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>',
1613
  );
1614

    
1615
  $form['cron'] = array(
1616
    '#type' => 'fieldset',
1617
  );
1618
  $form['cron']['cron_safe_threshold'] = array(
1619
    '#type' => 'select',
1620
    '#title' => t('Run cron every'),
1621
    '#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'))),
1622
    '#default_value' => variable_get('cron_safe_threshold', DRUPAL_CRON_DEFAULT_THRESHOLD),
1623
    '#options' => array(0 => t('Never')) + drupal_map_assoc(array(3600, 10800, 21600, 43200, 86400, 604800), 'format_interval'),
1624
  );
1625

    
1626
  return system_settings_form($form);
1627
}
1628

    
1629
/**
1630
 * Submit callback; run cron.
1631
 *
1632
 * @ingroup forms
1633
 */
1634
function system_run_cron_submit($form, &$form_state) {
1635
  // Run cron manually from Cron form.
1636
  if (drupal_cron_run()) {
1637
    drupal_set_message(t('Cron run successfully.'));
1638
  }
1639
  else {
1640
    drupal_set_message(t('Cron run failed.'), 'error');
1641
  }
1642

    
1643
  drupal_goto('admin/config/system/cron');
1644
}
1645

    
1646
/**
1647
 * Form builder; Configure error reporting settings.
1648
 *
1649
 * @ingroup forms
1650
 * @see system_settings_form()
1651
 */
1652
function system_logging_settings() {
1653
  $form['error_level'] = array(
1654
    '#type' => 'radios',
1655
    '#title' => t('Error messages to display'),
1656
    '#default_value' => variable_get('error_level', ERROR_REPORTING_DISPLAY_ALL),
1657
    '#options' => array(
1658
      ERROR_REPORTING_HIDE => t('None'),
1659
      ERROR_REPORTING_DISPLAY_SOME => t('Errors and warnings'),
1660
      ERROR_REPORTING_DISPLAY_ALL => t('All messages'),
1661
    ),
1662
    '#description' => t('It is recommended that sites running on production environments do not display any errors.'),
1663
  );
1664

    
1665
  return system_settings_form($form);
1666
}
1667

    
1668
/**
1669
 * Form builder; Configure site performance settings.
1670
 *
1671
 * @ingroup forms
1672
 * @see system_settings_form()
1673
 */
1674
function system_performance_settings() {
1675
  drupal_add_js(drupal_get_path('module', 'system') . '/system.js');
1676

    
1677
  $form['clear_cache'] = array(
1678
    '#type' => 'fieldset',
1679
    '#title' => t('Clear cache'),
1680
  );
1681

    
1682
  $form['clear_cache']['clear'] = array(
1683
    '#type' => 'submit',
1684
    '#value' => t('Clear all caches'),
1685
    '#submit' => array('system_clear_cache_submit'),
1686
  );
1687

    
1688
  $form['caching'] = array(
1689
    '#type' => 'fieldset',
1690
    '#title' => t('Caching'),
1691
  );
1692

    
1693
  $cache = variable_get('cache', 0);
1694
  $form['caching']['cache'] = array(
1695
    '#type' => 'checkbox',
1696
    '#title' => t('Cache pages for anonymous users'),
1697
    '#default_value' => $cache,
1698
    '#weight' => -2,
1699
  );
1700
  $period = drupal_map_assoc(array(0, 60, 180, 300, 600, 900, 1800, 2700, 3600, 10800, 21600, 32400, 43200, 86400), 'format_interval');
1701
  $period[0] = '<' . t('none') . '>';
1702
  $form['caching']['cache_lifetime'] = array(
1703
    '#type' => 'select',
1704
    '#title' => t('Minimum cache lifetime'),
1705
    '#default_value' => variable_get('cache_lifetime', 0),
1706
    '#options' => $period,
1707
    '#description' => t('Cached pages will not be re-created until at least this much time has elapsed.')
1708
  );
1709
  $form['caching']['page_cache_maximum_age'] = array(
1710
    '#type' => 'select',
1711
    '#title' => t('Expiration of cached pages'),
1712
    '#default_value' => variable_get('page_cache_maximum_age', 0),
1713
    '#options' => $period,
1714
    '#description' => t('The maximum time an external cache can use an old version of a page.')
1715
  );
1716

    
1717
  $directory = 'public://';
1718
  $is_writable = is_dir($directory) && is_writable($directory);
1719
  $disabled = !$is_writable;
1720
  $disabled_message = '';
1721
  if (!$is_writable) {
1722
    $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')));
1723
  }
1724

    
1725
  $form['bandwidth_optimization'] = array(
1726
    '#type' => 'fieldset',
1727
    '#title' => t('Bandwidth optimization'),
1728
    '#description' => t('External resources can be optimized automatically, which can reduce both the size and number of requests made to your website.') . $disabled_message,
1729
  );
1730

    
1731
  $js_hide = $cache ? '' : ' class="js-hide"';
1732
  $form['bandwidth_optimization']['page_compression'] = array(
1733
    '#type' => 'checkbox',
1734
    '#title' => t('Compress cached pages.'),
1735
    '#default_value' => variable_get('page_compression', TRUE),
1736
    '#prefix' => '<div id="page-compression-wrapper"' . $js_hide . '>',
1737
    '#suffix' => '</div>',
1738
  );
1739
  $form['bandwidth_optimization']['preprocess_css'] = array(
1740
    '#type' => 'checkbox',
1741
    '#title' => t('Aggregate and compress CSS files.'),
1742
    '#default_value' => intval(variable_get('preprocess_css', 0) && $is_writable),
1743
    '#disabled' => $disabled,
1744
  );
1745
  $form['bandwidth_optimization']['preprocess_js'] = array(
1746
    '#type' => 'checkbox',
1747
    '#title' => t('Aggregate JavaScript files.'),
1748
    '#default_value' => intval(variable_get('preprocess_js', 0) && $is_writable),
1749
    '#disabled' => $disabled,
1750
  );
1751

    
1752
  $form['#submit'][] = 'drupal_clear_css_cache';
1753
  $form['#submit'][] = 'drupal_clear_js_cache';
1754
  // This form allows page compression settings to be changed, which can
1755
  // invalidate the page cache, so it needs to be cleared on form submit.
1756
  $form['#submit'][] = 'system_clear_page_cache_submit';
1757

    
1758
  return system_settings_form($form);
1759
}
1760

    
1761
/**
1762
 * Submit callback; clear system caches.
1763
 *
1764
 * @ingroup forms
1765
 */
1766
function system_clear_cache_submit($form, &$form_state) {
1767
  drupal_flush_all_caches();
1768
  drupal_set_message(t('Caches cleared.'));
1769
}
1770

    
1771
/**
1772
 * Submit callback; clear the page cache.
1773
 *
1774
 * @ingroup forms
1775
 */
1776
function system_clear_page_cache_submit($form, &$form_state) {
1777
  cache_clear_all('*', 'cache_page', TRUE);
1778
}
1779

    
1780
/**
1781
 * Form builder; Configure the site file handling.
1782
 *
1783
 * @ingroup forms
1784
 * @see system_settings_form()
1785
 */
1786
function system_file_system_settings() {
1787
  $form['file_public_path'] = array(
1788
    '#type' => 'textfield',
1789
    '#title' => t('Public file system path'),
1790
    '#default_value' => variable_get('file_public_path', conf_path() . '/files'),
1791
    '#maxlength' => 255,
1792
    '#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.'),
1793
    '#after_build' => array('system_check_directory'),
1794
  );
1795

    
1796
  $form['file_private_path'] = array(
1797
    '#type' => 'textfield',
1798
    '#title' => t('Private file system path'),
1799
    '#default_value' => variable_get('file_private_path', ''),
1800
    '#maxlength' => 255,
1801
    '#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' => 'http://drupal.org/documentation/modules/file')),
1802
    '#after_build' => array('system_check_directory'),
1803
  );
1804

    
1805
  $form['file_temporary_path'] = array(
1806
    '#type' => 'textfield',
1807
    '#title' => t('Temporary directory'),
1808
    '#default_value' => variable_get('file_temporary_path', file_directory_temp()),
1809
    '#maxlength' => 255,
1810
    '#description' => t('A local file system path where temporary files will be stored. This directory should not be accessible over the web.'),
1811
    '#after_build' => array('system_check_directory'),
1812
  );
1813
  // Any visible, writeable wrapper can potentially be used for the files
1814
  // directory, including a remote file system that integrates with a CDN.
1815
  foreach (file_get_stream_wrappers(STREAM_WRAPPERS_WRITE_VISIBLE) as $scheme => $info) {
1816
    $options[$scheme] = check_plain($info['description']);
1817
  }
1818

    
1819
  if (!empty($options)) {
1820
    $form['file_default_scheme'] = array(
1821
      '#type' => 'radios',
1822
      '#title' => t('Default download method'),
1823
      '#default_value' => variable_get('file_default_scheme', isset($options['public']) ? 'public' : key($options)),
1824
      '#options' => $options,
1825
      '#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.'),
1826
    );
1827
  }
1828

    
1829
  return system_settings_form($form);
1830
}
1831

    
1832
/**
1833
 * Form builder; Configure site image toolkit usage.
1834
 *
1835
 * @ingroup forms
1836
 * @see system_settings_form()
1837
 */
1838
function system_image_toolkit_settings() {
1839
  $toolkits_available = image_get_available_toolkits();
1840
  $current_toolkit = image_get_toolkit();
1841

    
1842
  if (count($toolkits_available) == 0) {
1843
    variable_del('image_toolkit');
1844
    $form['image_toolkit_help'] = array(
1845
      '#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'))),
1846
    );
1847
    return $form;
1848
  }
1849

    
1850
  if (count($toolkits_available) > 1) {
1851
    $form['image_toolkit'] = array(
1852
      '#type' => 'radios',
1853
      '#title' => t('Select an image processing toolkit'),
1854
      '#default_value' => variable_get('image_toolkit', $current_toolkit),
1855
      '#options' => $toolkits_available
1856
    );
1857
  }
1858
  else {
1859
    variable_set('image_toolkit', key($toolkits_available));
1860
  }
1861

    
1862
  // Get the toolkit's settings form.
1863
  $function = 'image_' . $current_toolkit . '_settings';
1864
  if (function_exists($function)) {
1865
    $form['image_toolkit_settings'] = $function();
1866
  }
1867

    
1868
  return system_settings_form($form);
1869
}
1870

    
1871
/**
1872
 * Form builder; Configure how the site handles RSS feeds.
1873
 *
1874
 * @ingroup forms
1875
 * @see system_settings_form()
1876
 */
1877
function system_rss_feeds_settings() {
1878
  $form['feed_description'] = array(
1879
    '#type' => 'textarea',
1880
    '#title' => t('Feed description'),
1881
    '#default_value' => variable_get('feed_description', ''),
1882
    '#description' => t('Description of your site, included in each feed.')
1883
  );
1884
  $form['feed_default_items'] = array(
1885
    '#type' => 'select',
1886
    '#title' => t('Number of items in each feed'),
1887
    '#default_value' => variable_get('feed_default_items', 10),
1888
    '#options' => drupal_map_assoc(array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30)),
1889
    '#description' => t('Default number of items to include in each feed.')
1890
  );
1891
  $form['feed_item_length'] = array(
1892
    '#type' => 'select',
1893
    '#title' => t('Feed content'),
1894
    '#default_value' => variable_get('feed_item_length', 'fulltext'),
1895
    '#options' => array('title' => t('Titles only'), 'teaser' => t('Titles plus teaser'), 'fulltext' => t('Full text')),
1896
    '#description' => t('Global setting for the default display of content items in each feed.')
1897
  );
1898

    
1899
  return system_settings_form($form);
1900
}
1901

    
1902
/**
1903
 * Form builder; Configure the site regional settings.
1904
 *
1905
 * @ingroup forms
1906
 * @see system_settings_form()
1907
 * @see system_regional_settings_submit()
1908
 */
1909
function system_regional_settings() {
1910
  include_once DRUPAL_ROOT . '/includes/locale.inc';
1911
  $countries = country_get_list();
1912

    
1913
  // Date settings:
1914
  $zones = system_time_zones();
1915

    
1916
  $form['locale'] = array(
1917
    '#type' => 'fieldset',
1918
    '#title' => t('Locale'),
1919
  );
1920

    
1921
  $form['locale']['site_default_country'] = array(
1922
    '#type' => 'select',
1923
    '#title' => t('Default country'),
1924
    '#empty_value' => '',
1925
    '#default_value' => variable_get('site_default_country', ''),
1926
    '#options' => $countries,
1927
    '#attributes' => array('class' => array('country-detect')),
1928
  );
1929

    
1930
  $form['locale']['date_first_day'] = array(
1931
    '#type' => 'select',
1932
    '#title' => t('First day of week'),
1933
    '#default_value' => variable_get('date_first_day', 0),
1934
    '#options' => array(0 => t('Sunday'), 1 => t('Monday'), 2 => t('Tuesday'), 3 => t('Wednesday'), 4 => t('Thursday'), 5 => t('Friday'), 6 => t('Saturday')),
1935
  );
1936

    
1937
  $form['timezone'] = array(
1938
    '#type' => 'fieldset',
1939
    '#title' => t('Time zones'),
1940
  );
1941

    
1942
  $form['timezone']['date_default_timezone'] = array(
1943
    '#type' => 'select',
1944
    '#title' => t('Default time zone'),
1945
    '#default_value' => variable_get('date_default_timezone', date_default_timezone_get()),
1946
    '#options' => $zones,
1947
  );
1948

    
1949
  $configurable_timezones = variable_get('configurable_timezones', 1);
1950
  $form['timezone']['configurable_timezones'] = array(
1951
    '#type' => 'checkbox',
1952
    '#title' => t('Users may set their own time zone.'),
1953
    '#default_value' => $configurable_timezones,
1954
  );
1955

    
1956
  $form['timezone']['configurable_timezones_wrapper'] =  array(
1957
    '#type' => 'container',
1958
    '#states' => array(
1959
      // Hide the user configured timezone settings when users are forced to use
1960
      // the default setting.
1961
      'invisible' => array(
1962
        'input[name="configurable_timezones"]' => array('checked' => FALSE),
1963
      ),
1964
    ),
1965
  );
1966
  $form['timezone']['configurable_timezones_wrapper']['empty_timezone_message'] = array(
1967
    '#type' => 'checkbox',
1968
    '#title' => t('Remind users at login if their time zone is not set.'),
1969
    '#default_value' => variable_get('empty_timezone_message', 0),
1970
    '#description' => t('Only applied if users may set their own time zone.')
1971
  );
1972

    
1973
  $form['timezone']['configurable_timezones_wrapper']['user_default_timezone'] = array(
1974
    '#type' => 'radios',
1975
    '#title' => t('Time zone for new users'),
1976
    '#default_value' => variable_get('user_default_timezone', DRUPAL_USER_TIMEZONE_DEFAULT),
1977
    '#options' => array(
1978
      DRUPAL_USER_TIMEZONE_DEFAULT => t('Default time zone.'),
1979
      DRUPAL_USER_TIMEZONE_EMPTY   => t('Empty time zone.'),
1980
      DRUPAL_USER_TIMEZONE_SELECT  => t('Users may set their own time zone at registration.'),
1981
    ),
1982
    '#description' => t('Only applied if users may set their own time zone.')
1983
  );
1984

    
1985
  return system_settings_form($form);
1986
}
1987

    
1988
/**
1989
 * Form builder; Configure the site date and time settings.
1990
 *
1991
 * @ingroup forms
1992
 * @see system_settings_form()
1993
 */
1994
function system_date_time_settings() {
1995
  // Get list of all available date types.
1996
  drupal_static_reset('system_get_date_types');
1997
  $format_types = system_get_date_types();
1998

    
1999
  // Get list of all available date formats.
2000
  $all_formats = array();
2001
  drupal_static_reset('system_get_date_formats');
2002
  $date_formats = system_get_date_formats(); // Call this to rebuild the list, and to have default list.
2003
  foreach ($date_formats as $type => $format_info) {
2004
    $all_formats = array_merge($all_formats, $format_info);
2005
  }
2006
  $custom_formats = system_get_date_formats('custom');
2007
  if (!empty($format_types)) {
2008
    foreach ($format_types as $type => $type_info) {
2009
      // If a system type, only show the available formats for that type and
2010
      // custom ones.
2011
      if ($type_info['locked'] == 1) {
2012
        $formats = system_get_date_formats($type);
2013
        if (empty($formats)) {
2014
          $formats = $all_formats;
2015
        }
2016
        elseif (!empty($custom_formats)) {
2017
          $formats = array_merge($formats, $custom_formats);
2018
        }
2019
      }
2020
      // If a user configured type, show all available date formats.
2021
      else {
2022
        $formats = $all_formats;
2023
      }
2024

    
2025
      $choices = array();
2026
      foreach ($formats as $f => $format) {
2027
        $choices[$f] = format_date(REQUEST_TIME, 'custom', $f);
2028
      }
2029
      reset($formats);
2030
      $default = variable_get('date_format_' . $type, key($formats));
2031

    
2032
      // Get date type info for this date type.
2033
      $type_info = system_get_date_types($type);
2034
      $form['formats']['#theme'] = 'system_date_time_settings';
2035

    
2036
      // Show date format select list.
2037
      $form['formats']['format']['date_format_' . $type] = array(
2038
        '#type' => 'select',
2039
        '#title' => check_plain($type_info['title']),
2040
        '#attributes' => array('class' => array('date-format')),
2041
        '#default_value' => (isset($choices[$default]) ? $default : 'custom'),
2042
        '#options' => $choices,
2043
      );
2044

    
2045
      // If this isn't a system provided type, allow the user to remove it from
2046
      // the system.
2047
      if ($type_info['locked'] == 0) {
2048
        $form['formats']['delete']['date_format_' . $type . '_delete'] = array(
2049
          '#type' => 'link',
2050
          '#title' => t('delete'),
2051
          '#href' => 'admin/config/regional/date-time/types/' . $type . '/delete',
2052
        );
2053
      }
2054
    }
2055
  }
2056

    
2057
  // Display a message if no date types configured.
2058
  $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')));
2059

    
2060
  return system_settings_form($form);
2061
}
2062

    
2063
/**
2064
 * Returns HTML for the date settings form.
2065
 *
2066
 * @param $variables
2067
 *   An associative array containing:
2068
 *   - form: A render element representing the form.
2069
 *
2070
 * @ingroup themeable
2071
 */
2072
function theme_system_date_time_settings($variables) {
2073
  $form = $variables['form'];
2074
  $header = array(
2075
    t('Date type'),
2076
    t('Format'),
2077
    t('Operations'),
2078
  );
2079

    
2080
  foreach (element_children($form['format']) as $key) {
2081
    $delete_key = $key . '_delete';
2082
    $row = array();
2083
    $row[] = $form['format'][$key]['#title'];
2084
    $form['format'][$key]['#title_display'] = 'invisible';
2085
    $row[] = array('data' => drupal_render($form['format'][$key]));
2086
    $row[] = array('data' => drupal_render($form['delete'][$delete_key]));
2087
    $rows[] = $row;
2088
  }
2089

    
2090
  $output = theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('id' => 'system-date-types')));
2091
  $output .= drupal_render_children($form);
2092

    
2093
  return $output;
2094
}
2095

    
2096

    
2097
/**
2098
 * Add new date type.
2099
 *
2100
 * @ingroup forms
2101
 * @ingroup system_add_date_format_type_form_validate()
2102
 * @ingroup system_add_date_format_type_form_submit()
2103
 */
2104
function system_add_date_format_type_form($form, &$form_state) {
2105
  $form['date_type'] = array(
2106
    '#title' => t('Date type'),
2107
    '#type' => 'textfield',
2108
    '#required' => TRUE,
2109
  );
2110
  $form['machine_name'] = array(
2111
    '#type' => 'machine_name',
2112
    '#machine_name' => array(
2113
      'exists' => 'system_get_date_types',
2114
      'source' => array('date_type'),
2115
    ),
2116
  );
2117

    
2118
  // Get list of all available date formats.
2119
  $formats = array();
2120
  drupal_static_reset('system_get_date_formats');
2121
  $date_formats = system_get_date_formats(); // Call this to rebuild the list, and to have default list.
2122
  foreach ($date_formats as $type => $format_info) {
2123
    $formats = array_merge($formats, $format_info);
2124
  }
2125
  $custom_formats = system_get_date_formats('custom');
2126
  if (!empty($custom_formats)) {
2127
    $formats = array_merge($formats, $custom_formats);
2128
  }
2129
  $choices = array();
2130
  foreach ($formats as $f => $format) {
2131
    $choices[$f] = format_date(REQUEST_TIME, 'custom', $f);
2132
  }
2133
  // Show date format select list.
2134
  $form['date_format'] = array(
2135
    '#type' => 'select',
2136
    '#title' => t('Date format'),
2137
    '#attributes' => array('class' => array('date-format')),
2138
    '#options' => $choices,
2139
    '#required' => TRUE,
2140
  );
2141

    
2142
  $form['actions'] = array('#type' => 'actions');
2143
  $form['actions']['submit'] = array(
2144
    '#type' => 'submit',
2145
    '#value' => t('Add date type'),
2146
  );
2147

    
2148
  $form['#validate'][] = 'system_add_date_format_type_form_validate';
2149
  $form['#submit'][] = 'system_add_date_format_type_form_submit';
2150

    
2151
  return $form;
2152
}
2153

    
2154
/**
2155
 * Validate system_add_date_format_type form submissions.
2156
 */
2157
function system_add_date_format_type_form_validate($form, &$form_state) {
2158
  if (!empty($form_state['values']['machine_name']) && !empty($form_state['values']['date_type'])) {
2159
    if (!preg_match("/^[a-zA-Z0-9_]+$/", trim($form_state['values']['machine_name']))) {
2160
      form_set_error('machine_name', t('The date type must contain only alphanumeric characters and underscores.'));
2161
    }
2162
    $types = system_get_date_types();
2163
    if (in_array(trim($form_state['values']['machine_name']), array_keys($types))) {
2164
      form_set_error('machine_name', t('This date type already exists. Enter a unique type.'));
2165
    }
2166
  }
2167
}
2168

    
2169
/**
2170
 * Process system_add_date_format_type form submissions.
2171
 */
2172
function system_add_date_format_type_form_submit($form, &$form_state) {
2173
  $machine_name = trim($form_state['values']['machine_name']);
2174

    
2175
  $format_type = array();
2176
  $format_type['title'] = trim($form_state['values']['date_type']);
2177
  $format_type['type'] = $machine_name;
2178
  $format_type['locked'] = 0;
2179
  $format_type['is_new'] = 1;
2180
  system_date_format_type_save($format_type);
2181
  variable_set('date_format_' . $machine_name, $form_state['values']['date_format']);
2182

    
2183
  drupal_set_message(t('New date type added successfully.'));
2184
  $form_state['redirect'] = 'admin/config/regional/date-time';
2185
}
2186

    
2187
/**
2188
 * Return the date for a given format string via Ajax.
2189
 */
2190
function system_date_time_lookup() {
2191
  $result = format_date(REQUEST_TIME, 'custom', $_GET['format']);
2192
  drupal_json_output($result);
2193
}
2194

    
2195
/**
2196
 * Form builder; Configure the site's maintenance status.
2197
 *
2198
 * @ingroup forms
2199
 * @see system_settings_form()
2200
 */
2201
function system_site_maintenance_mode() {
2202
  $form['maintenance_mode'] = array(
2203
    '#type' => 'checkbox',
2204
    '#title' => t('Put site into maintenance mode'),
2205
    '#default_value' => variable_get('maintenance_mode', 0),
2206
    '#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'))),
2207
  );
2208
  $form['maintenance_mode_message'] = array(
2209
    '#type' => 'textarea',
2210
    '#title' => t('Maintenance mode message'),
2211
    '#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')))),
2212
    '#description' => t('Message to show visitors when the site is in maintenance mode.')
2213
  );
2214

    
2215
  return system_settings_form($form);
2216
}
2217

    
2218
/**
2219
 * Form builder; Configure clean URL settings.
2220
 *
2221
 * @ingroup forms
2222
 * @see system_settings_form()
2223
 */
2224
function system_clean_url_settings($form, &$form_state) {
2225
  $available = FALSE;
2226
  $conflict = FALSE;
2227

    
2228
  // If the request URI is a clean URL, clean URLs must be available.
2229
  // Otherwise, run a test.
2230
  if (strpos(request_uri(), '?q=') === FALSE && strpos(request_uri(), '&q=') === FALSE) {
2231
    $available = TRUE;
2232
  }
2233
  else {
2234
    $request = drupal_http_request($GLOBALS['base_url'] . '/admin/config/search/clean-urls/check');
2235
    // If the request returns HTTP 200, clean URLs are available.
2236
    if (isset($request->code) && $request->code == 200) {
2237
      $available = TRUE;
2238
      // If the user started the clean URL test, provide explicit feedback.
2239
      if (isset($form_state['input']['clean_url_test_execute'])) {
2240
        drupal_set_message(t('The clean URL test passed.'));
2241
      }
2242
    }
2243
    else {
2244
      // If the test failed while clean URLs are enabled, make sure clean URLs
2245
      // can be disabled.
2246
      if (variable_get('clean_url', 0)) {
2247
        $conflict = TRUE;
2248
        // Warn the user of a conflicting situation, unless after processing
2249
        // a submitted form.
2250
        if (!isset($form_state['input']['op'])) {
2251
          drupal_set_message(t('Clean URLs are enabled, but the clean URL test failed. Uncheck the box below to disable clean URLs.'), 'warning');
2252
        }
2253
      }
2254
      // If the user started the clean URL test, provide explicit feedback.
2255
      elseif (isset($form_state['input']['clean_url_test_execute'])) {
2256
        drupal_set_message(t('The clean URL test failed.'), 'warning');
2257
      }
2258
    }
2259
  }
2260

    
2261
  // Show the enable/disable form if clean URLs are available or if the user
2262
  // must be able to resolve a conflicting setting.
2263
  if ($available || $conflict) {
2264
    $form['clean_url'] = array(
2265
      '#type' => 'checkbox',
2266
      '#title' => t('Enable clean URLs'),
2267
      '#default_value' => variable_get('clean_url', 0),
2268
      '#description' => t('Use URLs like <code>example.com/user</code> instead of <code>example.com/?q=user</code>.'),
2269
    );
2270
    $form = system_settings_form($form);
2271
    if ($conflict) {
2272
      // $form_state['redirect'] needs to be set to the non-clean URL,
2273
      // otherwise the setting is not saved.
2274
      $form_state['redirect'] = url('', array('query' => array('q' => '/admin/config/search/clean-urls')));
2275
    }
2276
  }
2277
  // Show the clean URLs test form.
2278
  else {
2279
    drupal_add_js(drupal_get_path('module', 'system') . '/system.js');
2280

    
2281
    $form_state['redirect'] = url('admin/config/search/clean-urls');
2282
    $form['clean_url_description'] = array(
2283
      '#type' => 'markup',
2284
      '#markup' => '<p>' . t('Use URLs like <code>example.com/user</code> instead of <code>example.com/?q=user</code>.'),
2285
    );
2286
    // Explain why the user is seeing this page and what to expect after
2287
    // clicking the 'Run the clean URL test' button.
2288
    $form['clean_url_test_result'] = array(
2289
      '#type' => 'markup',
2290
      '#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>',
2291
    );
2292
    $form['actions'] = array(
2293
      '#type' => 'actions',
2294
      'clean_url_test' => array(
2295
        '#type' => 'submit',
2296
        '#value' => t('Run the clean URL test'),
2297
      ),
2298
    );
2299
    $form['clean_url_test_execute'] = array(
2300
      '#type' => 'hidden',
2301
      '#value' => 1,
2302
    );
2303
  }
2304

    
2305
  return $form;
2306
}
2307

    
2308
/**
2309
 * Menu callback: displays the site status report. Can also be used as a pure check.
2310
 *
2311
 * @param $check
2312
 *   If true, only returns a boolean whether there are system status errors.
2313
 */
2314
function system_status($check = FALSE) {
2315
  // Load .install files
2316
  include_once DRUPAL_ROOT . '/includes/install.inc';
2317
  drupal_load_updates();
2318

    
2319
  // Check run-time requirements and status information.
2320
  $requirements = module_invoke_all('requirements', 'runtime');
2321
  usort($requirements, '_system_sort_requirements');
2322

    
2323
  if ($check) {
2324
    return drupal_requirements_severity($requirements) == REQUIREMENT_ERROR;
2325
  }
2326
  // MySQL import might have set the uid of the anonymous user to autoincrement
2327
  // value. Let's try fixing it. See http://drupal.org/node/204411
2328
  db_update('users')
2329
    ->expression('uid', 'uid - uid')
2330
    ->condition('name', '')
2331
    ->condition('pass', '')
2332
    ->condition('status', 0)
2333
    ->execute();
2334
  return theme('status_report', array('requirements' => $requirements));
2335
}
2336

    
2337
/**
2338
 * Menu callback: run cron manually.
2339
 */
2340
function system_run_cron() {
2341
  // Run cron manually
2342
  if (drupal_cron_run()) {
2343
    drupal_set_message(t('Cron ran successfully.'));
2344
  }
2345
  else {
2346
    drupal_set_message(t('Cron run failed.'), 'error');
2347
  }
2348

    
2349
  drupal_goto('admin/reports/status');
2350
}
2351

    
2352
/**
2353
 * Menu callback: return information about PHP.
2354
 */
2355
function system_php() {
2356
  phpinfo();
2357
  drupal_exit();
2358
}
2359

    
2360
/**
2361
 * Default page callback for batches.
2362
 */
2363
function system_batch_page() {
2364
  require_once DRUPAL_ROOT . '/includes/batch.inc';
2365
  $output = _batch_page();
2366

    
2367
  if ($output === FALSE) {
2368
    drupal_access_denied();
2369
  }
2370
  elseif (isset($output)) {
2371
    // Force a page without blocks or messages to
2372
    // display a list of collected messages later.
2373
    drupal_set_page_content($output);
2374
    $page = element_info('page');
2375
    $page['#show_messages'] = FALSE;
2376
    return $page;
2377
  }
2378
}
2379

    
2380
/**
2381
 * Returns HTML for an administrative block for display.
2382
 *
2383
 * @param $variables
2384
 *   An associative array containing:
2385
 *   - block: An array containing information about the block:
2386
 *     - show: A Boolean whether to output the block. Defaults to FALSE.
2387
 *     - title: The block's title.
2388
 *     - content: (optional) Formatted content for the block.
2389
 *     - description: (optional) Description of the block. Only output if
2390
 *       'content' is not set.
2391
 *
2392
 * @ingroup themeable
2393
 */
2394
function theme_admin_block($variables) {
2395
  $block = $variables['block'];
2396
  $output = '';
2397

    
2398
  // Don't display the block if it has no content to display.
2399
  if (empty($block['show'])) {
2400
    return $output;
2401
  }
2402

    
2403
  $output .= '<div class="admin-panel">';
2404
  if (!empty($block['title'])) {
2405
    $output .= '<h3>' . $block['title'] . '</h3>';
2406
  }
2407
  if (!empty($block['content'])) {
2408
    $output .= '<div class="body">' . $block['content'] . '</div>';
2409
  }
2410
  else {
2411
    $output .= '<div class="description">' . $block['description'] . '</div>';
2412
  }
2413
  $output .= '</div>';
2414

    
2415
  return $output;
2416
}
2417

    
2418
/**
2419
 * Returns HTML for the content of an administrative block.
2420
 *
2421
 * @param $variables
2422
 *   An associative array containing:
2423
 *   - content: An array containing information about the block. Each element
2424
 *     of the array represents an administrative menu item, and must at least
2425
 *     contain the keys 'title', 'href', and 'localized_options', which are
2426
 *     passed to l(). A 'description' key may also be provided.
2427
 *
2428
 * @ingroup themeable
2429
 */
2430
function theme_admin_block_content($variables) {
2431
  $content = $variables['content'];
2432
  $output = '';
2433

    
2434
  if (!empty($content)) {
2435
    $class = 'admin-list';
2436
    if ($compact = system_admin_compact_mode()) {
2437
      $class .= ' compact';
2438
    }
2439
    $output .= '<dl class="' . $class . '">';
2440
    foreach ($content as $item) {
2441
      $output .= '<dt>' . l($item['title'], $item['href'], $item['localized_options']) . '</dt>';
2442
      if (!$compact && isset($item['description'])) {
2443
        $output .= '<dd>' . filter_xss_admin($item['description']) . '</dd>';
2444
      }
2445
    }
2446
    $output .= '</dl>';
2447
  }
2448
  return $output;
2449
}
2450

    
2451
/**
2452
 * Returns HTML for an administrative page.
2453
 *
2454
 * @param $variables
2455
 *   An associative array containing:
2456
 *   - blocks: An array of blocks to display. Each array should include a
2457
 *     'title', a 'description', a formatted 'content' and a 'position' which
2458
 *     will control which container it will be in. This is usually 'left' or
2459
 *     'right'.
2460
 *
2461
 * @ingroup themeable
2462
 */
2463
function theme_admin_page($variables) {
2464
  $blocks = $variables['blocks'];
2465

    
2466
  $stripe = 0;
2467
  $container = array();
2468

    
2469
  foreach ($blocks as $block) {
2470
    if ($block_output = theme('admin_block', array('block' => $block))) {
2471
      if (empty($block['position'])) {
2472
        // perform automatic striping.
2473
        $block['position'] = ++$stripe % 2 ? 'left' : 'right';
2474
      }
2475
      if (!isset($container[$block['position']])) {
2476
        $container[$block['position']] = '';
2477
      }
2478
      $container[$block['position']] .= $block_output;
2479
    }
2480
  }
2481

    
2482
  $output = '<div class="admin clearfix">';
2483
  $output .= theme('system_compact_link');
2484

    
2485
  foreach ($container as $id => $data) {
2486
    $output .= '<div class="' . $id . ' clearfix">';
2487
    $output .= $data;
2488
    $output .= '</div>';
2489
  }
2490
  $output .= '</div>';
2491
  return $output;
2492
}
2493

    
2494
/**
2495
 * Returns HTML for the output of the dashboard page.
2496
 *
2497
 * @param $variables
2498
 *   An associative array containing:
2499
 *   - menu_items: An array of modules to be displayed.
2500
 *
2501
 * @ingroup themeable
2502
 */
2503
function theme_system_admin_index($variables) {
2504
  $menu_items = $variables['menu_items'];
2505

    
2506
  $stripe = 0;
2507
  $container = array('left' => '', 'right' => '');
2508
  $flip = array('left' => 'right', 'right' => 'left');
2509
  $position = 'left';
2510

    
2511
  // Iterate over all modules.
2512
  foreach ($menu_items as $module => $block) {
2513
    list($description, $items) = $block;
2514

    
2515
    // Output links.
2516
    if (count($items)) {
2517
      $block = array();
2518
      $block['title'] = $module;
2519
      $block['content'] = theme('admin_block_content', array('content' => $items));
2520
      $block['description'] = t($description);
2521
      $block['show'] = TRUE;
2522

    
2523
      if ($block_output = theme('admin_block', array('block' => $block))) {
2524
        if (!isset($block['position'])) {
2525
          // Perform automatic striping.
2526
          $block['position'] = $position;
2527
          $position = $flip[$position];
2528
        }
2529
        $container[$block['position']] .= $block_output;
2530
      }
2531
    }
2532
  }
2533

    
2534
  $output = '<div class="admin clearfix">';
2535
  $output .= theme('system_compact_link');
2536
  foreach ($container as $id => $data) {
2537
    $output .= '<div class="' . $id . ' clearfix">';
2538
    $output .= $data;
2539
    $output .= '</div>';
2540
  }
2541
  $output .= '</div>';
2542

    
2543
  return $output;
2544
}
2545

    
2546
/**
2547
 * Returns HTML for the status report.
2548
 *
2549
 * @param $variables
2550
 *   An associative array containing:
2551
 *   - requirements: An array of requirements.
2552
 *
2553
 * @ingroup themeable
2554
 */
2555
function theme_status_report($variables) {
2556
  $requirements = $variables['requirements'];
2557
  $severities = array(
2558
    REQUIREMENT_INFO => array(
2559
      'title' => t('Info'),
2560
      'class' => 'info',
2561
    ),
2562
    REQUIREMENT_OK => array(
2563
      'title' => t('OK'),
2564
      'class' => 'ok',
2565
    ),
2566
    REQUIREMENT_WARNING => array(
2567
      'title' => t('Warning'),
2568
      'class' => 'warning',
2569
    ),
2570
    REQUIREMENT_ERROR => array(
2571
      'title' => t('Error'),
2572
      'class' => 'error',
2573
    ),
2574
  );
2575
  $output = '<table class="system-status-report">';
2576

    
2577
  foreach ($requirements as $requirement) {
2578
    if (empty($requirement['#type'])) {
2579
      $severity = $severities[isset($requirement['severity']) ? (int) $requirement['severity'] : REQUIREMENT_OK];
2580
      $severity['icon'] = '<div title="' . $severity['title'] . '"><span class="element-invisible">' . $severity['title'] . '</span></div>';
2581

    
2582
      // Output table row(s)
2583
      if (!empty($requirement['description'])) {
2584
        $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>';
2585
        $output .= '<tr class="' . $severity['class'] . ' merge-up"><td colspan="3" class="status-description">' . $requirement['description'] . '</td></tr>';
2586
      }
2587
      else {
2588
        $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>';
2589
      }
2590
    }
2591
  }
2592

    
2593
  $output .= '</table>';
2594
  return $output;
2595
}
2596

    
2597
/**
2598
 * Returns HTML for the modules form.
2599
 *
2600
 * @param $variables
2601
 *   An associative array containing:
2602
 *   - form: A render element representing the form.
2603
 *
2604
 * @ingroup themeable
2605
 */
2606
function theme_system_modules_fieldset($variables) {
2607
  $form = $variables['form'];
2608

    
2609
  // Individual table headers.
2610
  $rows = array();
2611
  // Iterate through all the modules, which are
2612
  // children of this fieldset.
2613
  foreach (element_children($form) as $key) {
2614
    // Stick it into $module for easier accessing.
2615
    $module = $form[$key];
2616
    $row = array();
2617
    unset($module['enable']['#title']);
2618
    $row[] = array('class' => array('checkbox'), 'data' => drupal_render($module['enable']));
2619
    $label = '<label';
2620
    if (isset($module['enable']['#id'])) {
2621
      $label .= ' for="' . $module['enable']['#id'] . '"';
2622
    }
2623
    $row[] = $label . '><strong>' . drupal_render($module['name']) . '</strong></label>';
2624
    $row[] = drupal_render($module['version']);
2625
    // Add the description, along with any modules it requires.
2626
    $description = drupal_render($module['description']);
2627
    if ($module['#requires']) {
2628
      $description .= '<div class="admin-requirements">' . t('Requires: !module-list', array('!module-list' => implode(', ', $module['#requires']))) . '</div>';
2629
    }
2630
    if ($module['#required_by']) {
2631
      $description .= '<div class="admin-requirements">' . t('Required by: !module-list', array('!module-list' => implode(', ', $module['#required_by']))) . '</div>';
2632
    }
2633
    $row[] = array('data' => $description, 'class' => array('description'));
2634
    // Display links (such as help or permissions) in their own columns.
2635
    foreach (array('help', 'permissions', 'configure') as $key) {
2636
      $row[] = array('data' => drupal_render($module['links'][$key]), 'class' => array($key));
2637
    }
2638
    $rows[] = $row;
2639
  }
2640

    
2641
  return theme('table', array('header' => $form['#header'], 'rows' => $rows));
2642
}
2643

    
2644
/**
2645
 * Returns HTML for a message about incompatible modules.
2646
 *
2647
 * @param $variables
2648
 *   An associative array containing:
2649
 *   - message: The form array representing the currently disabled modules.
2650
 *
2651
 * @ingroup themeable
2652
 */
2653
function theme_system_modules_incompatible($variables) {
2654
  return '<div class="incompatible">' . $variables['message'] . '</div>';
2655
}
2656

    
2657
/**
2658
 * Returns HTML for a table of currently disabled modules.
2659
 *
2660
 * @param $variables
2661
 *   An associative array containing:
2662
 *   - form: A render element representing the form.
2663
 *
2664
 * @ingroup themeable
2665
 */
2666
function theme_system_modules_uninstall($variables) {
2667
  $form = $variables['form'];
2668

    
2669
  // No theming for the confirm form.
2670
  if (isset($form['confirm'])) {
2671
    return drupal_render($form);
2672
  }
2673

    
2674
  // Table headers.
2675
  $header = array(t('Uninstall'),
2676
    t('Name'),
2677
    t('Description'),
2678
  );
2679

    
2680
  // Display table.
2681
  $rows = array();
2682
  foreach (element_children($form['modules']) as $module) {
2683
    if (!empty($form['modules'][$module]['#required_by'])) {
2684
      $disabled_message = format_plural(count($form['modules'][$module]['#required_by']),
2685
        'To uninstall @module, the following module must be uninstalled first: @required_modules',
2686
        'To uninstall @module, the following modules must be uninstalled first: @required_modules',
2687
        array('@module' => $form['modules'][$module]['#module_name'], '@required_modules' => implode(', ', $form['modules'][$module]['#required_by'])));
2688
      $disabled_message = '<div class="admin-requirements">' . $disabled_message . '</div>';
2689
    }
2690
    else {
2691
      $disabled_message = '';
2692
    }
2693
    $rows[] = array(
2694
      array('data' => drupal_render($form['uninstall'][$module]), 'align' => 'center'),
2695
      '<strong><label for="' . $form['uninstall'][$module]['#id'] . '">' . drupal_render($form['modules'][$module]['name']) . '</label></strong>',
2696
      array('data' => drupal_render($form['modules'][$module]['description']) . $disabled_message, 'class' => array('description')),
2697
    );
2698
  }
2699

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

    
2703
  return $output;
2704
}
2705

    
2706
/**
2707
 * Returns HTML for the Appearance page.
2708
 *
2709
 * @param $variables
2710
 *   An associative array containing:
2711
 *   - theme_groups: An associative array containing groups of themes.
2712
 *
2713
 * @ingroup themeable
2714
 */
2715
function theme_system_themes_page($variables) {
2716
  $theme_groups = $variables['theme_groups'];
2717

    
2718
  $output = '<div id="system-themes-page">';
2719

    
2720
  foreach ($variables['theme_group_titles'] as $state => $title) {
2721
    if (!count($theme_groups[$state])) {
2722
      // Skip this group of themes if no theme is there.
2723
      continue;
2724
    }
2725
    // Start new theme group.
2726
    $output .= '<div class="system-themes-list system-themes-list-'. $state .' clearfix"><h2>'. $title .'</h2>';
2727

    
2728
    foreach ($theme_groups[$state] as $theme) {
2729

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

    
2733
      // Localize the theme description.
2734
      $description = t($theme->info['description']);
2735

    
2736
      // Style theme info
2737
      $notes = count($theme->notes) ? ' (' . join(', ', $theme->notes) . ')' : '';
2738
      $theme->classes[] = 'theme-selector';
2739
      $theme->classes[] = 'clearfix';
2740
      $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>';
2741

    
2742
      // Make sure to provide feedback on compatibility.
2743
      if (!empty($theme->incompatible_core)) {
2744
        $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>';
2745
      }
2746
      elseif (!empty($theme->incompatible_php)) {
2747
        if (substr_count($theme->info['php'], '.') < 2) {
2748
          $theme->info['php'] .= '.*';
2749
        }
2750
        $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>';
2751
      }
2752
      else {
2753
        $output .= theme('links', array('links' => $theme->operations, 'attributes' => array('class' => array('operations', 'clearfix'))));
2754
      }
2755
      $output .= '</div></div>';
2756
    }
2757
    $output .= '</div>';
2758
  }
2759
  $output .= '</div>';
2760

    
2761
  return $output;
2762
}
2763

    
2764
/**
2765
 * Menu callback; present a form for deleting a date format.
2766
 */
2767
function system_date_delete_format_form($form, &$form_state, $dfid) {
2768
  $form['dfid'] = array(
2769
    '#type' => 'value',
2770
    '#value' => $dfid,
2771
  );
2772
  $format = system_get_date_format($dfid);
2773

    
2774
  $output = confirm_form($form,
2775
    t('Are you sure you want to remove the format %format?', array('%format' => format_date(REQUEST_TIME, 'custom', $format->format))),
2776
    'admin/config/regional/date-time/formats',
2777
    t('This action cannot be undone.'),
2778
    t('Remove'), t('Cancel'),
2779
    'confirm'
2780
  );
2781

    
2782
  return $output;
2783
}
2784

    
2785
/**
2786
 * Delete a configured date format.
2787
 */
2788
function system_date_delete_format_form_submit($form, &$form_state) {
2789
  if ($form_state['values']['confirm']) {
2790
    $format = system_get_date_format($form_state['values']['dfid']);
2791
    system_date_format_delete($form_state['values']['dfid']);
2792
    drupal_set_message(t('Removed date format %format.', array('%format' => format_date(REQUEST_TIME, 'custom', $format->format))));
2793
    $form_state['redirect'] = 'admin/config/regional/date-time/formats';
2794
  }
2795
}
2796

    
2797
/**
2798
 * Menu callback; present a form for deleting a date type.
2799
 */
2800
function system_delete_date_format_type_form($form, &$form_state, $format_type) {
2801
  $form['format_type'] = array(
2802
    '#type' => 'value',
2803
    '#value' => $format_type,
2804
  );
2805
  $type_info = system_get_date_types($format_type);
2806

    
2807
  $output = confirm_form($form,
2808
    t('Are you sure you want to remove the date type %type?', array('%type' => $type_info['title'])),
2809
    'admin/config/regional/date-time',
2810
    t('This action cannot be undone.'),
2811
    t('Remove'), t('Cancel'),
2812
    'confirm'
2813
  );
2814

    
2815
  return $output;
2816
}
2817

    
2818
/**
2819
 * Delete a configured date type.
2820
 */
2821
function system_delete_date_format_type_form_submit($form, &$form_state) {
2822
  if ($form_state['values']['confirm']) {
2823
    $type_info = system_get_date_types($form_state['values']['format_type']);
2824
    system_date_format_type_delete($form_state['values']['format_type']);
2825
    drupal_set_message(t('Removed date type %type.', array('%type' => $type_info['title'])));
2826
    $form_state['redirect'] = 'admin/config/regional/date-time';
2827
  }
2828
}
2829

    
2830

    
2831
/**
2832
 * Displays the date format strings overview page.
2833
 */
2834
function system_date_time_formats() {
2835
  $header = array(t('Format'), array('data' => t('Operations'), 'colspan' => '2'));
2836
  $rows = array();
2837

    
2838
  drupal_static_reset('system_get_date_formats');
2839
  $formats = system_get_date_formats('custom');
2840
  if (!empty($formats)) {
2841
    foreach ($formats as $format) {
2842
      $row = array();
2843
      $row[] = array('data' => format_date(REQUEST_TIME, 'custom', $format['format']));
2844
      $row[] = array('data' => l(t('edit'), 'admin/config/regional/date-time/formats/' . $format['dfid'] . '/edit'));
2845
      $row[] = array('data' => l(t('delete'), 'admin/config/regional/date-time/formats/' . $format['dfid'] . '/delete'));
2846
      $rows[] = $row;
2847
    }
2848
  }
2849

    
2850
  $build['date_formats_table'] = array(
2851
    '#theme' => 'table',
2852
    '#header' => $header,
2853
    '#rows' => $rows,
2854
    '#empty' => t('No custom date formats available. <a href="@link">Add date format</a>.', array('@link' => url('admin/config/regional/date-time/formats/add'))),
2855
  );
2856

    
2857
  return $build;
2858
}
2859

    
2860
/**
2861
 * Allow users to add additional date formats.
2862
 */
2863
function system_configure_date_formats_form($form, &$form_state, $dfid = 0) {
2864
  $js_settings = array(
2865
    'type' => 'setting',
2866
    'data' => array(
2867
      'dateTime' => array(
2868
        'date-format' => array(
2869
          'text' => t('Displayed as'),
2870
          'lookup' => url('admin/config/regional/date-time/formats/lookup'),
2871
        ),
2872
      ),
2873
    ),
2874
  );
2875

    
2876
  if ($dfid) {
2877
    $form['dfid'] = array(
2878
      '#type' => 'value',
2879
      '#value' => $dfid,
2880
    );
2881
    $format = system_get_date_format($dfid);
2882
  }
2883

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

    
2886
  $form['date_format'] = array(
2887
    '#type' => 'textfield',
2888
    '#title' => t('Format string'),
2889
    '#maxlength' => 100,
2890
    '#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')),
2891
    '#default_value' => ($dfid ? $format->format : ''),
2892
    '#field_suffix' => ' <small id="edit-date-format-suffix">' . $now . '</small>',
2893
    '#attached' => array(
2894
      'js' => array(drupal_get_path('module', 'system') . '/system.js', $js_settings),
2895
    ),
2896
    '#required' => TRUE,
2897
  );
2898

    
2899
  $form['actions'] = array('#type' => 'actions');
2900
  $form['actions']['update'] = array(
2901
    '#type' => 'submit',
2902
    '#value' => ($dfid ? t('Save format') : t('Add format')),
2903
  );
2904

    
2905
  $form['#validate'][] = 'system_add_date_formats_form_validate';
2906
  $form['#submit'][] = 'system_add_date_formats_form_submit';
2907

    
2908
  return $form;
2909
}
2910

    
2911
/**
2912
 * Validate new date format string submission.
2913
 */
2914
function system_add_date_formats_form_validate($form, &$form_state) {
2915
  $formats = system_get_date_formats('custom');
2916
  $format = trim($form_state['values']['date_format']);
2917
  if (!empty($formats) && in_array($format, array_keys($formats)) && (!isset($form_state['values']['dfid']) || $form_state['values']['dfid'] != $formats[$format]['dfid'])) {
2918
    form_set_error('date_format', t('This format already exists. Enter a unique format string.'));
2919
  }
2920
}
2921

    
2922
/**
2923
 * Process new date format string submission.
2924
 */
2925
function system_add_date_formats_form_submit($form, &$form_state) {
2926
  $format = array();
2927
  $format['format'] = trim($form_state['values']['date_format']);
2928
  $format['type'] = 'custom';
2929
  $format['locked'] = 0;
2930
  if (!empty($form_state['values']['dfid'])) {
2931
    system_date_format_save($format, $form_state['values']['dfid']);
2932
    drupal_set_message(t('Custom date format updated.'));
2933
  }
2934
  else {
2935
    $format['is_new'] = 1;
2936
    system_date_format_save($format);
2937
    drupal_set_message(t('Custom date format added.'));
2938
  }
2939

    
2940
  $form_state['redirect'] = 'admin/config/regional/date-time/formats';
2941
}
2942

    
2943
/**
2944
 * Menu callback; Displays an overview of available and configured actions.
2945
 */
2946
function system_actions_manage() {
2947
  actions_synchronize();
2948
  $actions = actions_list();
2949
  $actions_map = actions_actions_map($actions);
2950
  $options = array();
2951
  $unconfigurable = array();
2952

    
2953
  foreach ($actions_map as $key => $array) {
2954
    if ($array['configurable']) {
2955
      $options[$key] = $array['label'] . '...';
2956
    }
2957
    else {
2958
      $unconfigurable[] = $array;
2959
    }
2960
  }
2961

    
2962
  $row = array();
2963
  $instances_present = db_query("SELECT aid FROM {actions} WHERE parameters <> ''")->fetchField();
2964
  $header = array(
2965
    array('data' => t('Action type'), 'field' => 'type'),
2966
    array('data' => t('Label'), 'field' => 'label'),
2967
    array('data' => $instances_present ? t('Operations') : '', 'colspan' => '2')
2968
  );
2969
  $query = db_select('actions')->extend('PagerDefault')->extend('TableSort');
2970
  $result = $query
2971
    ->fields('actions')
2972
    ->limit(50)
2973
    ->orderByHeader($header)
2974
    ->execute();
2975

    
2976
  foreach ($result as $action) {
2977
    $row[] = array(
2978
      array('data' => $action->type),
2979
      array('data' => check_plain($action->label)),
2980
      array('data' => $action->parameters ? l(t('configure'), "admin/config/system/actions/configure/$action->aid") : ''),
2981
      array('data' => $action->parameters ? l(t('delete'), "admin/config/system/actions/delete/$action->aid") : '')
2982
    );
2983
  }
2984

    
2985
  if ($row) {
2986
    $pager = theme('pager');
2987
    if (!empty($pager)) {
2988
      $row[] = array(array('data' => $pager, 'colspan' => '3'));
2989
    }
2990
    $build['system_actions_header'] = array('#markup' => '<h3>' . t('Available actions:') . '</h3>');
2991
    $build['system_actions_table'] = array('#markup' => theme('table', array('header' => $header, 'rows' => $row)));
2992
  }
2993

    
2994
  if ($actions_map) {
2995
    $build['system_actions_manage_form'] = drupal_get_form('system_actions_manage_form', $options);
2996
  }
2997

    
2998
  return $build;
2999
}
3000

    
3001
/**
3002
 * Define the form for the actions overview page.
3003
 *
3004
 * @param $form_state
3005
 *   An associative array containing the current state of the form; not used.
3006
 * @param $options
3007
 *   An array of configurable actions.
3008
 * @return
3009
 *   Form definition.
3010
 *
3011
 * @ingroup forms
3012
 * @see system_actions_manage_form_submit()
3013
 */
3014
function system_actions_manage_form($form, &$form_state, $options = array()) {
3015
  $form['parent'] = array(
3016
    '#type' => 'fieldset',
3017
    '#title' => t('Create an advanced action'),
3018
    '#attributes' => array('class' => array('container-inline')),
3019
  );
3020
  $form['parent']['action'] = array(
3021
    '#type' => 'select',
3022
    '#title' => t('Action'),
3023
    '#title_display' => 'invisible',
3024
    '#options' => $options,
3025
    '#empty_option' => t('Choose an advanced action'),
3026
  );
3027
  $form['parent']['actions'] = array('#type' => 'actions');
3028
  $form['parent']['actions']['submit'] = array(
3029
    '#type' => 'submit',
3030
    '#value' => t('Create'),
3031
  );
3032
  return $form;
3033
}
3034

    
3035
/**
3036
 * Process system_actions_manage form submissions.
3037
 *
3038
 * @see system_actions_manage_form()
3039
 */
3040
function system_actions_manage_form_submit($form, &$form_state) {
3041
  if ($form_state['values']['action']) {
3042
    $form_state['redirect'] = 'admin/config/system/actions/configure/' . $form_state['values']['action'];
3043
  }
3044
}
3045

    
3046
/**
3047
 * Menu callback; Creates the form for configuration of a single action.
3048
 *
3049
 * We provide the "Description" field. The rest of the form is provided by the
3050
 * action. We then provide the Save button. Because we are combining unknown
3051
 * form elements with the action configuration form, we use an 'actions_' prefix
3052
 * on our elements.
3053
 *
3054
 * @param $action
3055
 *   Hash of an action ID or an integer. If it is a hash, we are
3056
 *   creating a new instance. If it is an integer, we are editing an existing
3057
 *   instance.
3058
 * @return
3059
 *   A form definition.
3060
 *
3061
 * @see system_actions_configure_validate()
3062
 * @see system_actions_configure_submit()
3063
 */
3064
function system_actions_configure($form, &$form_state, $action = NULL) {
3065
  if ($action === NULL) {
3066
    drupal_goto('admin/config/system/actions');
3067
  }
3068

    
3069
  $actions_map = actions_actions_map(actions_list());
3070
  $edit = array();
3071

    
3072
  // Numeric action denotes saved instance of a configurable action.
3073
  if (is_numeric($action)) {
3074
    $aid = $action;
3075
    // Load stored parameter values from database.
3076
    $data = db_query("SELECT * FROM {actions} WHERE aid = :aid", array(':aid' => $aid))->fetch();
3077
    $edit['actions_label'] = $data->label;
3078
    $edit['actions_type'] = $data->type;
3079
    $function = $data->callback;
3080
    $action = drupal_hash_base64($data->callback);
3081
    $params = unserialize($data->parameters);
3082
    if ($params) {
3083
      foreach ($params as $name => $val) {
3084
        $edit[$name] = $val;
3085
      }
3086
    }
3087
  }
3088
  // Otherwise, we are creating a new action instance.
3089
  else {
3090
    $function = $actions_map[$action]['callback'];
3091
    $edit['actions_label'] = $actions_map[$action]['label'];
3092
    $edit['actions_type'] = $actions_map[$action]['type'];
3093
  }
3094

    
3095
  $form['actions_label'] = array(
3096
    '#type' => 'textfield',
3097
    '#title' => t('Label'),
3098
    '#default_value' => $edit['actions_label'],
3099
    '#maxlength' => '255',
3100
    '#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.'),
3101
    '#weight' => -10
3102
  );
3103
  $action_form = $function . '_form';
3104
  $form = array_merge($form, $action_form($edit));
3105
  $form['actions_type'] = array(
3106
    '#type' => 'value',
3107
    '#value' => $edit['actions_type'],
3108
  );
3109
  $form['actions_action'] = array(
3110
    '#type' => 'hidden',
3111
    '#value' => $action,
3112
  );
3113
  // $aid is set when configuring an existing action instance.
3114
  if (isset($aid)) {
3115
    $form['actions_aid'] = array(
3116
      '#type' => 'hidden',
3117
      '#value' => $aid,
3118
    );
3119
  }
3120
  $form['actions_configured'] = array(
3121
    '#type' => 'hidden',
3122
    '#value' => '1',
3123
  );
3124
  $form['actions'] = array('#type' => 'actions');
3125
  $form['actions']['submit'] = array(
3126
    '#type' => 'submit',
3127
    '#value' => t('Save'),
3128
    '#weight' => 13
3129
  );
3130

    
3131
  return $form;
3132
}
3133

    
3134
/**
3135
 * Validate system_actions_configure() form submissions.
3136
 */
3137
function system_actions_configure_validate($form, &$form_state) {
3138
  $function = actions_function_lookup($form_state['values']['actions_action']) . '_validate';
3139
  // Hand off validation to the action.
3140
  if (function_exists($function)) {
3141
    $function($form, $form_state);
3142
  }
3143
}
3144

    
3145
/**
3146
 * Process system_actions_configure() form submissions.
3147
 */
3148
function system_actions_configure_submit($form, &$form_state) {
3149
  $function = actions_function_lookup($form_state['values']['actions_action']);
3150
  $submit_function = $function . '_submit';
3151

    
3152
  // Action will return keyed array of values to store.
3153
  $params = $submit_function($form, $form_state);
3154
  $aid = isset($form_state['values']['actions_aid']) ? $form_state['values']['actions_aid'] : NULL;
3155

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

    
3159
  $form_state['redirect'] = 'admin/config/system/actions/manage';
3160
}
3161

    
3162
/**
3163
 * Create the form for confirmation of deleting an action.
3164
 *
3165
 * @see system_actions_delete_form_submit()
3166
 * @ingroup forms
3167
 */
3168
function system_actions_delete_form($form, &$form_state, $action) {
3169
  $form['aid'] = array(
3170
    '#type' => 'hidden',
3171
    '#value' => $action->aid,
3172
  );
3173
  return confirm_form($form,
3174
    t('Are you sure you want to delete the action %action?', array('%action' => $action->label)),
3175
    'admin/config/system/actions/manage',
3176
    t('This cannot be undone.'),
3177
    t('Delete'),
3178
    t('Cancel')
3179
  );
3180
}
3181

    
3182
/**
3183
 * Process system_actions_delete form submissions.
3184
 *
3185
 * Post-deletion operations for action deletion.
3186
 */
3187
function system_actions_delete_form_submit($form, &$form_state) {
3188
  $aid = $form_state['values']['aid'];
3189
  $action = actions_load($aid);
3190
  actions_delete($aid);
3191
  watchdog('user', 'Deleted action %aid (%action)', array('%aid' => $aid, '%action' => $action->label));
3192
  drupal_set_message(t('Action %action was deleted', array('%action' => $action->label)));
3193
  $form_state['redirect'] = 'admin/config/system/actions/manage';
3194
}
3195

    
3196
/**
3197
 * Post-deletion operations for deleting action orphans.
3198
 *
3199
 * @param $orphaned
3200
 *   An array of orphaned actions.
3201
 */
3202
function system_action_delete_orphans_post($orphaned) {
3203
  foreach ($orphaned as $callback) {
3204
    drupal_set_message(t("Deleted orphaned action (%action).", array('%action' => $callback)));
3205
  }
3206
}
3207

    
3208
/**
3209
 * Remove actions that are in the database but not supported by any enabled module.
3210
 */
3211
function system_actions_remove_orphans() {
3212
  actions_synchronize(TRUE);
3213
  drupal_goto('admin/config/system/actions/manage');
3214
}