annotate sites/all/modules/features/features.admin.inc @ 9:830c812b520f

added smtp module
author root <root@paio.local>
date Mon, 28 Oct 2013 15:34:27 +0000
parents ce11bbd8f642
children
rev   line source
danielebarchiesi@4 1 <?php
danielebarchiesi@4 2
danielebarchiesi@4 3 /**
danielebarchiesi@4 4 * @file
danielebarchiesi@4 5 * Forms for Features admin screens
danielebarchiesi@4 6 */
danielebarchiesi@4 7
danielebarchiesi@4 8
danielebarchiesi@4 9 /**
danielebarchiesi@4 10 * Settings form for features
danielebarchiesi@4 11 */
danielebarchiesi@4 12 function features_settings_form($form, $form_state) {
danielebarchiesi@4 13 $form = array();
danielebarchiesi@4 14
danielebarchiesi@4 15 $components = features_get_components();
danielebarchiesi@4 16 uasort($components, 'features_compare_component_name');
danielebarchiesi@4 17 $form['show_components'] = array(
danielebarchiesi@4 18 '#type' => 'fieldset',
danielebarchiesi@4 19 '#title' => t('Show components on create/edit feature form.'),
danielebarchiesi@4 20 '#description' => t('Components with no options will not be shown no matter the setting below. Disabled components cannot be used with admin form.')
danielebarchiesi@4 21 );
danielebarchiesi@4 22 foreach ($components as $compontent => $info) {
danielebarchiesi@4 23 if (empty($info['feature_source']) && empty($info['features_source'])) {
danielebarchiesi@4 24 continue;
danielebarchiesi@4 25 }
danielebarchiesi@4 26 $form['show_components']['features_admin_show_component_' . $compontent] = array(
danielebarchiesi@4 27 '#title' => t('@name (@machine)', array('@name' => $info['name'], '@machine' => $compontent)),
danielebarchiesi@4 28 '#type' => 'checkbox',
danielebarchiesi@4 29 '#default_value' => variable_get('features_admin_show_component_' . $compontent, TRUE),
danielebarchiesi@4 30 );
danielebarchiesi@4 31 if ($compontent == 'menu_links' && ($menus = menu_get_menus())) {
danielebarchiesi@4 32 $form['show_components']['features_admin_menu_links'] = array(
danielebarchiesi@4 33 '#title' => t('Advanced Menu Link Settings'),
danielebarchiesi@4 34 '#type' => 'fieldset',
danielebarchiesi@4 35 '#collapsed' => TRUE,
danielebarchiesi@4 36 '#collapsible' => TRUE,
danielebarchiesi@4 37 '#states' => array(
danielebarchiesi@4 38 'invisible' => array(
danielebarchiesi@4 39 'input[name="features_admin_show_component_menu_links"]' => array('checked' => FALSE),
danielebarchiesi@4 40 ),
danielebarchiesi@4 41 ),
danielebarchiesi@4 42 );
danielebarchiesi@4 43 $form['show_components']['features_admin_menu_links']['features_admin_menu_links_menus'] = array(
danielebarchiesi@4 44 '#title' => t('Allowed menus for menu links'),
danielebarchiesi@4 45 '#type' => 'checkboxes',
danielebarchiesi@4 46 '#options' => array_map('check_plain', $menus),
danielebarchiesi@4 47 '#default_value' => variable_get('features_admin_menu_links_menus', array_keys(menu_get_menus())),
danielebarchiesi@4 48 );
danielebarchiesi@4 49 }
danielebarchiesi@4 50 }
danielebarchiesi@4 51
danielebarchiesi@4 52 $form['features_rebuild_on_flush'] = array(
danielebarchiesi@4 53 '#type' => 'checkbox',
danielebarchiesi@4 54 '#title' => t('Rebuild features on cache clear'),
danielebarchiesi@4 55 '#default_value' => variable_get('features_rebuild_on_flush', TRUE),
danielebarchiesi@4 56 '#description' => t('If you have a large site with many features, you may experience lag on full cache clear. If disabled, features will rebuild only when viewing the features list or saving the modules list.'),
danielebarchiesi@4 57 );
danielebarchiesi@4 58
danielebarchiesi@4 59 return system_settings_form($form);
danielebarchiesi@4 60 }
danielebarchiesi@4 61
danielebarchiesi@4 62 /**
danielebarchiesi@4 63 * Form constructor for features export form.
danielebarchiesi@4 64 *
danielebarchiesi@4 65 * Acts as a router based on the form_state.
danielebarchiesi@4 66 *
danielebarchiesi@4 67 * @param object|null $feature
danielebarchiesi@4 68 * The feature object, if available. NULL by default.
danielebarchiesi@4 69 *
danielebarchiesi@4 70 * @see features_export_build_form_submit()
danielebarchiesi@4 71 * @ingroup forms
danielebarchiesi@4 72 */
danielebarchiesi@4 73 function features_export_form($form, $form_state, $feature = NULL) {
danielebarchiesi@4 74 module_load_include('inc', 'features', 'features.export');
danielebarchiesi@4 75 features_include();
danielebarchiesi@4 76
danielebarchiesi@4 77 $feature_name = !empty($feature->name) ? $feature->name : '';
danielebarchiesi@4 78 $form = array(
danielebarchiesi@4 79 '#attributes' => array('class' => array('features-export-form')),
danielebarchiesi@4 80 '#feature' => isset($feature) ? $feature : NULL,
danielebarchiesi@4 81 );
danielebarchiesi@4 82 $form['info'] = array(
danielebarchiesi@4 83 '#type' => 'fieldset',
danielebarchiesi@4 84 '#title' => t('General Information'),
danielebarchiesi@4 85 '#tree' => FALSE,
danielebarchiesi@4 86 '#weight' => 2,
danielebarchiesi@4 87 '#collapsible' => FALSE,
danielebarchiesi@4 88 '#collapsed' => FALSE,
danielebarchiesi@4 89 '#prefix' => "<div id='features-export-info'>",
danielebarchiesi@4 90 '#suffix' => '</div>',
danielebarchiesi@4 91 );
danielebarchiesi@4 92 $form['info']['name'] = array(
danielebarchiesi@4 93 '#title' => t('Name'),
danielebarchiesi@4 94 '#description' => t('Example: Image gallery') . ' (' . t('Do not begin name with numbers.') . ')',
danielebarchiesi@4 95 '#type' => 'textfield',
danielebarchiesi@4 96 '#default_value' => !empty($feature->info['name']) ? $feature->info['name'] : '',
danielebarchiesi@4 97 '#attributes' => array('class' => array('feature-name')),
danielebarchiesi@4 98 );
danielebarchiesi@4 99 $form['info']['module_name'] = array(
danielebarchiesi@4 100 '#type' => 'textfield',
danielebarchiesi@4 101 '#title' => t('Machine-readable name'),
danielebarchiesi@4 102 '#description' => t('Example: image_gallery') . '<br/>' . t('May only contain lowercase letters, numbers and underscores. <strong>Try to avoid conflicts with the names of existing Drupal projects.</strong>'),
danielebarchiesi@4 103 '#required' => TRUE,
danielebarchiesi@4 104 '#default_value' => $feature_name,
danielebarchiesi@4 105 '#attributes' => array('class' => array('feature-module-name')),
danielebarchiesi@4 106 '#element_validate' => array('features_export_form_validate_field'),
danielebarchiesi@4 107 );
danielebarchiesi@4 108 // If recreating this feature, disable machine name field and blank out
danielebarchiesi@4 109 // js-attachment classes to ensure the machine name cannot be changed.
danielebarchiesi@4 110 if (isset($feature)) {
danielebarchiesi@4 111 $form['info']['module_name']['#value'] = $feature_name;
danielebarchiesi@4 112 $form['info']['module_name']['#disabled'] = TRUE;
danielebarchiesi@4 113 $form['info']['name']['#attributes'] = array();
danielebarchiesi@4 114 }
danielebarchiesi@4 115 $form['info']['description'] = array(
danielebarchiesi@4 116 '#title' => t('Description'),
danielebarchiesi@4 117 '#description' => t('Provide a short description of what users should expect when they enable your feature.'),
danielebarchiesi@4 118 '#type' => 'textfield',
danielebarchiesi@4 119 '#default_value' => !empty($feature->info['description']) ? $feature->info['description'] : '',
danielebarchiesi@4 120 );
danielebarchiesi@4 121 $form['info']['package'] = array(
danielebarchiesi@4 122 '#title' => t('Package'),
danielebarchiesi@4 123 '#description' => t('Organize your features in groups.'),
danielebarchiesi@4 124 '#type' => 'textfield',
danielebarchiesi@4 125 '#autocomplete_path' => 'features/autocomplete/packages',
danielebarchiesi@4 126 '#default_value' => !empty($feature->info['package']) ? $feature->info['package'] : 'Features',
danielebarchiesi@4 127 );
danielebarchiesi@4 128 $form['info']['version'] = array(
danielebarchiesi@4 129 '#title' => t('Version'),
danielebarchiesi@4 130 '#description' => t('Examples: 7.x-1.0, 7.x-1.0-beta1'),
danielebarchiesi@4 131 '#type' => 'textfield',
danielebarchiesi@4 132 '#required' => FALSE,
danielebarchiesi@4 133 '#default_value' => !empty($feature->info['version']) ? $feature->info['version'] : '',
danielebarchiesi@4 134 '#size' => 30,
danielebarchiesi@4 135 '#element_validate' => array('features_export_form_validate_field'),
danielebarchiesi@4 136 );
danielebarchiesi@4 137 $form['advanced'] = array(
danielebarchiesi@4 138 '#type' => 'fieldset',
danielebarchiesi@4 139 '#title' => t('Advanced Options'),
danielebarchiesi@4 140 '#tree' => FALSE,
danielebarchiesi@4 141 '#collapsible' => TRUE,
danielebarchiesi@4 142 '#collapsed' => TRUE,
danielebarchiesi@4 143 '#weight' => 10,
danielebarchiesi@4 144 '#prefix' => "<div id='features-export-advanced'>",
danielebarchiesi@4 145 '#suffix' => '</div>',
danielebarchiesi@4 146 );
danielebarchiesi@4 147 $form['advanced']['project_status_url'] = array(
danielebarchiesi@4 148 '#title' => t('URL of update XML'),
danielebarchiesi@4 149 '#description' => t('URL of Feature Server. For Example: http://mywebsite.com/fserver'),
danielebarchiesi@4 150 '#type' => 'textfield',
danielebarchiesi@4 151 '#required' => FALSE,
danielebarchiesi@4 152 '#default_value' => !empty($feature->info['project status url']) ? $feature->info['project status url'] : '',
danielebarchiesi@4 153 '#element_validate' => array('features_export_form_validate_field'),
danielebarchiesi@4 154 );
danielebarchiesi@4 155 $directory = (!empty($feature->filename)) ? dirname($feature->filename) : 'sites/all/modules/features';
danielebarchiesi@4 156 if (!empty($feature_name) && substr_compare($directory, $feature_name, strlen($directory)-strlen($feature_name), strlen($feature_name)) === 0) {
danielebarchiesi@4 157 // if path ends with module_name, strip it
danielebarchiesi@4 158 $directory = dirname($directory);
danielebarchiesi@4 159 }
danielebarchiesi@4 160 if (user_access('generate features')) {
danielebarchiesi@4 161 $form['advanced']['generate_path'] = array(
danielebarchiesi@4 162 '#title' => t('Path to Generate feature module'),
danielebarchiesi@4 163 '#description' => t('File path for feature module. For Example: sites/all/modules/features or /tmp. ' .
danielebarchiesi@4 164 t('Leave blank for <strong>@path</strong>', array('@path' => $directory))),
danielebarchiesi@4 165 '#type' => 'textfield',
danielebarchiesi@4 166 '#required' => FALSE,
danielebarchiesi@4 167 '#default_value' => !empty($feature->info['project path']) ? $feature->info['project path'] : '',
danielebarchiesi@4 168 );
danielebarchiesi@4 169 $form['advanced']['generate'] = array(
danielebarchiesi@4 170 '#type' => 'submit',
danielebarchiesi@4 171 '#value' => t('Generate feature'),
danielebarchiesi@4 172 '#submit' => array('features_export_build_form_submit'),
danielebarchiesi@4 173 );
danielebarchiesi@4 174 }
danielebarchiesi@4 175 // build the Component Listing panel on the right
danielebarchiesi@4 176 _features_export_form_components($form, $form_state);
danielebarchiesi@4 177
danielebarchiesi@4 178 $form['advanced']['info-preview'] = array(
danielebarchiesi@4 179 '#type' => 'button',
danielebarchiesi@4 180 '#value' => t('Preview .info file'),
danielebarchiesi@4 181 '#ajax' => array(
danielebarchiesi@4 182 'callback' => 'features_info_file_preview',
danielebarchiesi@4 183 'wrapper' => 'features-export-wrapper',
danielebarchiesi@4 184 ),
danielebarchiesi@4 185 );
danielebarchiesi@4 186 //Info dialog
danielebarchiesi@4 187 $form['advanced']['info-file'] = array(
danielebarchiesi@4 188 '#prefix' => '<div id="features-info-file" title="Export .info file preview">',
danielebarchiesi@4 189 'text' => array(
danielebarchiesi@4 190 '#type' => 'textarea',
danielebarchiesi@4 191 '#default_value' => '',
danielebarchiesi@4 192 '#resizable' => FALSE,
danielebarchiesi@4 193 ),
danielebarchiesi@4 194 '#suffix' => '</div>',
danielebarchiesi@4 195 );
danielebarchiesi@4 196
danielebarchiesi@4 197 $form['buttons'] = array(
danielebarchiesi@4 198 '#theme' => 'features_form_buttons',
danielebarchiesi@4 199 '#tree' => FALSE,
danielebarchiesi@4 200 '#weight' => 99,
danielebarchiesi@4 201 '#prefix' => "<div id='features-export-buttons'>",
danielebarchiesi@4 202 '#suffix' => '</div>',
danielebarchiesi@4 203 );
danielebarchiesi@4 204 $form['buttons']['submit'] = array(
danielebarchiesi@4 205 '#type' => 'submit',
danielebarchiesi@4 206 '#value' => t('Download feature'),
danielebarchiesi@4 207 '#weight' => 10,
danielebarchiesi@4 208 '#submit' => array('features_export_build_form_submit'),
danielebarchiesi@4 209 );
danielebarchiesi@4 210
danielebarchiesi@4 211 $form['#attached']['library'][] = array('system', 'ui.dialog');
danielebarchiesi@4 212
danielebarchiesi@4 213 return $form;
danielebarchiesi@4 214 }
danielebarchiesi@4 215
danielebarchiesi@4 216 /**
danielebarchiesi@4 217 * Return the render array elements for the Components selection on the Export form
danielebarchiesi@4 218 * @param array $feature - feature associative array
danielebarchiesi@4 219 * @param array $components - array of components in feature
danielebarchiesi@4 220 */
danielebarchiesi@4 221 function _features_export_form_components(&$form, &$form_state) {
danielebarchiesi@4 222 global $features_ignore_conflicts;
danielebarchiesi@4 223 drupal_add_css(drupal_get_path('module', 'features') . '/features.css');
danielebarchiesi@4 224 drupal_add_js(drupal_get_path('module', 'features') . '/features.js');
danielebarchiesi@4 225
danielebarchiesi@4 226 $feature = $form['#feature'];
danielebarchiesi@4 227
danielebarchiesi@4 228 // keep the allow_conflict variable around in the session
danielebarchiesi@4 229 if (isset($form_state['values']['features_allow_conflicts'])) {
danielebarchiesi@4 230 $_SESSION['features_allow_conflicts'] = $form_state['values']['features_allow_conflicts'];
danielebarchiesi@4 231 $features_ignore_conflicts = $_SESSION['features_allow_conflicts'];
danielebarchiesi@4 232 }
danielebarchiesi@4 233
danielebarchiesi@4 234 $form['export'] = array(
danielebarchiesi@4 235 '#type' => 'fieldset',
danielebarchiesi@4 236 '#title' => t('Components'),
danielebarchiesi@4 237 '#description' => t('Expand each component section and select which items should be included in this feature export.'),
danielebarchiesi@4 238 '#tree' => FALSE,
danielebarchiesi@4 239 '#prefix' => "<div id='features-export-wrapper'>",
danielebarchiesi@4 240 '#suffix' => '</div>',
danielebarchiesi@4 241 '#collapsible' => FALSE,
danielebarchiesi@4 242 '#collapsed' => FALSE,
danielebarchiesi@4 243 '#weight' => 1,
danielebarchiesi@4 244 );
danielebarchiesi@4 245
danielebarchiesi@4 246 // filter field used in javascript, so javascript will unhide it
danielebarchiesi@4 247 $form['export']['features_filter_wrapper'] = array(
danielebarchiesi@4 248 '#type' => 'fieldset',
danielebarchiesi@4 249 '#title' => t('Filters'),
danielebarchiesi@4 250 '#tree' => FALSE,
danielebarchiesi@4 251 '#prefix' => "<div id='features-filter' class='element-invisible'>",
danielebarchiesi@4 252 '#suffix' => '</div>',
danielebarchiesi@4 253 '#collapsible' => FALSE,
danielebarchiesi@4 254 '#collapsed' => FALSE,
danielebarchiesi@4 255 '#weight' => -10,
danielebarchiesi@4 256 );
danielebarchiesi@4 257 $form['export']['features_filter_wrapper']['features_filter'] = array(
danielebarchiesi@4 258 '#type' => 'textfield',
danielebarchiesi@4 259 '#title' => t('Search'),
danielebarchiesi@4 260 '#hidden' => TRUE,
danielebarchiesi@4 261 '#default_value' => '',
danielebarchiesi@4 262 '#suffix' => "<span class='features-filter-clear'>". t('Clear') ."</span>",
danielebarchiesi@4 263 );
danielebarchiesi@4 264 $form['export']['features_filter_wrapper']['checkall'] = array(
danielebarchiesi@4 265 '#type' => 'checkbox',
danielebarchiesi@4 266 '#default_value' => FALSE,
danielebarchiesi@4 267 '#hidden' => TRUE,
danielebarchiesi@4 268 '#title' => t('Select all'),
danielebarchiesi@4 269 '#attributes' => array(
danielebarchiesi@4 270 'class' => array('features-checkall'),
danielebarchiesi@4 271 )
danielebarchiesi@4 272 );
danielebarchiesi@4 273
danielebarchiesi@4 274 $form['advanced']['features_autodetect_wrapper'] = array(
danielebarchiesi@4 275 '#type' => 'fieldset',
danielebarchiesi@4 276 '#tree' => FALSE,
danielebarchiesi@4 277 '#prefix' => "<div id='features-autodetect'>",
danielebarchiesi@4 278 '#suffix' => '</div>',
danielebarchiesi@4 279 '#collapsible' => FALSE,
danielebarchiesi@4 280 '#collapsed' => FALSE,
danielebarchiesi@4 281 );
danielebarchiesi@4 282 $form['advanced']['features_autodetect_wrapper']['autodetect'] = array(
danielebarchiesi@4 283 '#title' => t('Add auto-detected dependencies'),
danielebarchiesi@4 284 '#type' => 'checkbox',
danielebarchiesi@4 285 '#default_value' => !empty($feature->info['no autodetect']) ? FALSE : TRUE,
danielebarchiesi@4 286 );
danielebarchiesi@4 287
danielebarchiesi@4 288 // this refresh button will rebuild the form.
danielebarchiesi@4 289 // this button is hidden by javascript since it is only needed when
danielebarchiesi@4 290 // javascript is not available
danielebarchiesi@4 291 $form['advanced']['features_autodetect_wrapper']['features_refresh'] = array(
danielebarchiesi@4 292 '#type' => 'submit',
danielebarchiesi@4 293 '#value' => t('Refresh'),
danielebarchiesi@4 294 '#name' => 'features-refresh',
danielebarchiesi@4 295 '#attributes' => array(
danielebarchiesi@4 296 'title' => t("Refresh the list of auto-detected items."),
danielebarchiesi@4 297 'class' => array('features-refresh-button'),
danielebarchiesi@4 298 ),
danielebarchiesi@4 299 '#submit' => array('features_export_form_rebuild'),
danielebarchiesi@4 300 '#prefix' => "<div class='features-refresh-wrapper'>",
danielebarchiesi@4 301 '#suffix' => "</div>",
danielebarchiesi@4 302 '#ajax' => array(
danielebarchiesi@4 303 'callback' => 'features_export_form_ajax',
danielebarchiesi@4 304 'wrapper' => 'features-export-wrapper',
danielebarchiesi@4 305 ),
danielebarchiesi@4 306 );
danielebarchiesi@4 307
danielebarchiesi@4 308 // generate the export array for the current feature and user selections
danielebarchiesi@4 309 $export = _features_export_build($feature, $form_state);
danielebarchiesi@4 310
danielebarchiesi@4 311 $form['advanced']['features_allow_conflicts'] = array(
danielebarchiesi@4 312 '#title' => t('Allow conflicts to be added'),
danielebarchiesi@4 313 '#type' => 'checkbox',
danielebarchiesi@4 314 '#default_value' => $features_ignore_conflicts,
danielebarchiesi@4 315 '#ajax' => array(
danielebarchiesi@4 316 'callback' => 'features_export_form_ajax',
danielebarchiesi@4 317 'wrapper' => 'features-export-wrapper',
danielebarchiesi@4 318 ),
danielebarchiesi@4 319 );
danielebarchiesi@4 320
danielebarchiesi@4 321 if (isset($form_state['values']['op']) && ($form_state['values']['op'] == $form_state['values']['info-preview'])) {
danielebarchiesi@4 322 // handle clicking Preview button
danielebarchiesi@4 323 module_load_include('inc', 'features', 'features.export');
danielebarchiesi@4 324
danielebarchiesi@4 325 $feature_export = _features_export_generate($export, $form_state, $feature);
danielebarchiesi@4 326 $feature_export = features_export_prepare($feature_export, $feature->name, TRUE);
danielebarchiesi@4 327 $info = features_export_info($feature_export);
danielebarchiesi@4 328
danielebarchiesi@4 329 drupal_add_js(array('features' => array('info' => $info)), 'setting');
danielebarchiesi@4 330 }
danielebarchiesi@4 331
danielebarchiesi@4 332 // determine any components that are deprecated
danielebarchiesi@4 333 $deprecated = features_get_deprecated($export['components']);
danielebarchiesi@4 334
danielebarchiesi@4 335 $sections = array('included', 'detected', 'added');
danielebarchiesi@4 336 foreach ($export['components'] as $component => $component_info) {
danielebarchiesi@4 337 if (!variable_get('features_admin_show_component_' . $component, TRUE)) {
danielebarchiesi@4 338 continue;
danielebarchiesi@4 339 }
danielebarchiesi@4 340 $label = (isset($component_info['name']) ?
danielebarchiesi@4 341 $component_info['name'] . " <span>(" . check_plain($component) . ")</span>" : check_plain($component));
danielebarchiesi@4 342
danielebarchiesi@4 343 $count = 0;
danielebarchiesi@4 344 foreach ($sections as $section) {
danielebarchiesi@4 345 $count += count($component_info['options'][$section]);
danielebarchiesi@4 346 }
danielebarchiesi@4 347 $extra_class = ($count == 0) ? 'features-export-empty' : '';
danielebarchiesi@4 348 $component_name = str_replace('_', '-', check_plain($component));
danielebarchiesi@4 349
danielebarchiesi@4 350 if ($count + count($component_info['options']['sources']) > 0) {
danielebarchiesi@4 351
danielebarchiesi@4 352 if (!empty($deprecated[$component])) {
danielebarchiesi@4 353 // only show deprecated component if it has some exports
danielebarchiesi@4 354 if (!empty($component_info['options']['included'])) {
danielebarchiesi@4 355 $form['export'][$component] = array(
danielebarchiesi@4 356 '#markup' => '',
danielebarchiesi@4 357 '#tree' => TRUE,
danielebarchiesi@4 358 );
danielebarchiesi@4 359
danielebarchiesi@4 360 $form['export'][$component]['deprecated'] = array(
danielebarchiesi@4 361 '#type' => 'fieldset',
danielebarchiesi@4 362 '#title' => $label . "<span class='features-conflict'> (" . t('DEPRECATED') . ")</span>",
danielebarchiesi@4 363 '#tree' => TRUE,
danielebarchiesi@4 364 '#collapsible' => TRUE,
danielebarchiesi@4 365 '#collapsed' => TRUE,
danielebarchiesi@4 366 '#attributes' => array('class' => array('features-export-component')),
danielebarchiesi@4 367 );
danielebarchiesi@4 368 $list = ' ';
danielebarchiesi@4 369 foreach ($component_info['options']['included'] as $key) {
danielebarchiesi@4 370 $list .= "<span class='form-type-checkbox features-conflict'>$key</span>";
danielebarchiesi@4 371 }
danielebarchiesi@4 372 $form['export'][$component]['deprecated']['selected'] = array(
danielebarchiesi@4 373 '#prefix' => "<div class='component-detected'>",
danielebarchiesi@4 374 '#markup' => $list,
danielebarchiesi@4 375 '#suffix' => "</div>",
danielebarchiesi@4 376 );
danielebarchiesi@4 377 }
danielebarchiesi@4 378 }
danielebarchiesi@4 379 else {
danielebarchiesi@4 380 $form['export'][$component] = array(
danielebarchiesi@4 381 '#markup' => '',
danielebarchiesi@4 382 '#tree' => TRUE,
danielebarchiesi@4 383 );
danielebarchiesi@4 384
danielebarchiesi@4 385 $form['export'][$component]['sources'] = array(
danielebarchiesi@4 386 '#type' => 'fieldset',
danielebarchiesi@4 387 '#title' => $label,
danielebarchiesi@4 388 '#tree' => TRUE,
danielebarchiesi@4 389 '#collapsible' => TRUE,
danielebarchiesi@4 390 '#collapsed' => TRUE,
danielebarchiesi@4 391 '#attributes' => array('class' => array('features-export-component')),
danielebarchiesi@4 392 '#prefix' => "<div class='features-export-parent component-$component'>",
danielebarchiesi@4 393 );
danielebarchiesi@4 394 $form['export'][$component]['sources']['selected'] = array(
danielebarchiesi@4 395 '#type' => 'checkboxes',
danielebarchiesi@4 396 '#id' => "edit-sources-$component_name",
danielebarchiesi@4 397 '#options' => features_dom_encode_options($component_info['options']['sources']),
danielebarchiesi@4 398 '#default_value' => features_dom_encode_options($component_info['selected']['sources'], FALSE),
danielebarchiesi@4 399 '#attributes' => array(
danielebarchiesi@4 400 'class' => array('component-select'),
danielebarchiesi@4 401 ),
danielebarchiesi@4 402 );
danielebarchiesi@4 403
danielebarchiesi@4 404 foreach ($sections as $section) {
danielebarchiesi@4 405 $form['export'][$component][$section] = array(
danielebarchiesi@4 406 '#type' => 'checkboxes',
danielebarchiesi@4 407 '#options' => !empty($component_info['options'][$section]) ?
danielebarchiesi@4 408 features_dom_encode_options($component_info['options'][$section]) : array(),
danielebarchiesi@4 409 '#default_value' => !empty($component_info['selected'][$section]) ?
danielebarchiesi@4 410 features_dom_encode_options($component_info['selected'][$section], FALSE) : array(),
danielebarchiesi@4 411 '#attributes' => array('class' => array('component-' . $section)),
danielebarchiesi@4 412 );
danielebarchiesi@4 413 }
danielebarchiesi@4 414 $form['export'][$component][$sections[0]]['#prefix'] =
danielebarchiesi@4 415 "<div class='component-list features-export-list $extra_class'>";
danielebarchiesi@4 416 $form['export'][$component][$sections[count($sections)-1]]['#suffix'] = '</div></div>';
danielebarchiesi@4 417 }
danielebarchiesi@4 418 }
danielebarchiesi@4 419 }
danielebarchiesi@4 420 $form['export']['features_legend'] = array(
danielebarchiesi@4 421 '#type' => 'fieldset',
danielebarchiesi@4 422 '#title' => t('Legend'),
danielebarchiesi@4 423 '#tree' => FALSE,
danielebarchiesi@4 424 '#prefix' => "<div id='features-legend'>",
danielebarchiesi@4 425 '#suffix' => '</div>',
danielebarchiesi@4 426 '#collapsible' => FALSE,
danielebarchiesi@4 427 '#collapsed' => FALSE,
danielebarchiesi@4 428 );
danielebarchiesi@4 429 $form['export']['features_legend']['legend'] = array(
danielebarchiesi@4 430 '#markup' =>
danielebarchiesi@4 431 "<span class='component-included'>Normal</span> " .
danielebarchiesi@4 432 "<span class='component-added'>Changed</span> " .
danielebarchiesi@4 433 "<span class='component-detected'>Auto detected</span> " .
danielebarchiesi@4 434 "<span class='features-conflict'>Conflict</span> ",
danielebarchiesi@4 435 );
danielebarchiesi@4 436 }
danielebarchiesi@4 437
danielebarchiesi@4 438 /**
danielebarchiesi@4 439 * Return the full feature export array based upon user selections in form_state
danielebarchiesi@4 440 * @param array $feature Feature array to be exported
danielebarchiesi@4 441 * @param array $form_state Optional form_state information for user selections
danielebarchiesi@4 442 * can be updated to reflect new selection status
danielebarchiesi@4 443 * @return array New export array to be exported
danielebarchiesi@4 444 * array['components'][$component_name] = $component_info
danielebarchiesi@4 445 * $component_info['options'][$section] is list of available options
danielebarchiesi@4 446 * $component_info['selected'][$section] is option state TRUE/FALSE
danielebarchiesi@4 447 * $section = array('sources', included', 'detected', 'added')
danielebarchiesi@4 448 * sources - options that are available to be added to the feature
danielebarchiesi@4 449 * included - options that have been previously exported to the feature
danielebarchiesi@4 450 * detected - options that have been auto-detected
danielebarchiesi@4 451 * added - newly added options to the feature
danielebarchiesi@4 452 *
danielebarchiesi@4 453 * NOTE: This routine gets a bit complex to handle all of the different possible
danielebarchiesi@4 454 * user checkbox selections and de-selections.
danielebarchiesi@4 455 * Cases to test:
danielebarchiesi@4 456 * 1a) uncheck Included item -> mark as Added but unchecked
danielebarchiesi@4 457 * 1b) re-check unchecked Added item -> return it to Included check item
danielebarchiesi@4 458 * 2a) check Sources item -> mark as Added and checked
danielebarchiesi@4 459 * 2b) uncheck Added item -> return it to Sources as unchecked
danielebarchiesi@4 460 * 3a) uncheck Included item that still exists as auto-detect -> mark as Detected but unchecked
danielebarchiesi@4 461 * 3b) re-check Detected item -> return it to Included and checked
danielebarchiesi@4 462 * 4a) check Sources item should also add any auto-detect items as Detected and checked
danielebarchiesi@4 463 * 4b) uncheck Sources item with auto-detect and auto-detect items should return to Sources and unchecked
danielebarchiesi@4 464 * 5a) uncheck a Detected item -> refreshing page should keep it as unchecked Detected
danielebarchiesi@4 465 * 6) when nothing changes, refresh should not change any state
danielebarchiesi@4 466 * 7) should never see an unchecked Included item
danielebarchiesi@4 467 */
danielebarchiesi@4 468 function _features_export_build($feature, &$form_state) {
danielebarchiesi@4 469 global $features_ignore_conflicts;
danielebarchiesi@4 470 // set a global to effect features_get_component_map when building feature
danielebarchiesi@4 471 // hate to use a global, but it's just for an admin screen so probably ok
danielebarchiesi@4 472 if (isset($_SESSION['features_allow_conflicts'])) {
danielebarchiesi@4 473 $features_ignore_conflicts = $_SESSION['features_allow_conflicts'];
danielebarchiesi@4 474 }
danielebarchiesi@4 475
danielebarchiesi@4 476 $feature_name = isset($feature->name) ? $feature->name : NULL;
danielebarchiesi@4 477 $conflicts = _features_get_used($feature_name);
danielebarchiesi@4 478 $reset = FALSE;
danielebarchiesi@4 479 if (isset($form_state['triggering_element']['#name']) && ($form_state['triggering_element']['#name'] == 'features_allow_conflicts')) {
danielebarchiesi@4 480 // when clicking the Allow Conflicts button, reset the feature back to it's original state
danielebarchiesi@4 481 $reset = TRUE;
danielebarchiesi@4 482 }
danielebarchiesi@4 483
danielebarchiesi@4 484 module_load_include('inc', 'features', 'features.export');
danielebarchiesi@4 485 features_include();
danielebarchiesi@4 486
danielebarchiesi@4 487 $components = features_get_components();
danielebarchiesi@4 488 uasort($components, 'features_compare_component_name');
danielebarchiesi@4 489
danielebarchiesi@4 490 // Assemble the combined component list
danielebarchiesi@4 491 $stub = array();
danielebarchiesi@4 492 $sections = array('sources', 'included', 'detected', 'added');
danielebarchiesi@4 493
danielebarchiesi@4 494 // create a new feature "stub" to populate
danielebarchiesi@4 495
danielebarchiesi@4 496 $stub_count = array();
danielebarchiesi@4 497 foreach ($components as $component => $component_info) {
danielebarchiesi@4 498 if ($reset) {
danielebarchiesi@4 499 unset($form_state['values'][$component]);
danielebarchiesi@4 500 }
danielebarchiesi@4 501 if (!variable_get('features_admin_show_component_' . $component, TRUE)) {
danielebarchiesi@4 502 unset($components[$component]);
danielebarchiesi@4 503 continue;
danielebarchiesi@4 504 }
danielebarchiesi@4 505 // User-selected components take precedence.
danielebarchiesi@4 506 $stub[$component] = array();
danielebarchiesi@4 507 $stub_count[$component] = 0;
danielebarchiesi@4 508 // add selected items from Sources checkboxes
danielebarchiesi@4 509 if (!empty($form_state['values'][$component]['sources']['selected'])) {
danielebarchiesi@4 510 $stub[$component] = array_merge($stub[$component], features_dom_decode_options(array_filter($form_state['values'][$component]['sources']['selected'])));
danielebarchiesi@4 511 $stub_count[$component]++;
danielebarchiesi@4 512 }
danielebarchiesi@4 513 // add selected items from already Included and newly Added checkboxes
danielebarchiesi@4 514 foreach (array('included', 'added') as $section) {
danielebarchiesi@4 515 if (!empty($form_state['values'][$component][$section])) {
danielebarchiesi@4 516 $stub[$component] = array_merge($stub[$component], features_dom_decode_options(array_filter($form_state['values'][$component][$section])));
danielebarchiesi@4 517 $stub_count[$component]++;
danielebarchiesi@4 518 }
danielebarchiesi@4 519 }
danielebarchiesi@4 520 // count any detected items
danielebarchiesi@4 521 if (!empty($form_state['values'][$component]['detected'])) {
danielebarchiesi@4 522 $stub_count[$component]++;
danielebarchiesi@4 523 }
danielebarchiesi@4 524 // Only fallback to an existing feature's values if there are no export options for the component.
danielebarchiesi@4 525 if ($component == 'dependencies') {
danielebarchiesi@4 526 if (($stub_count[$component] == 0) && !empty($feature->info['dependencies'])) {
danielebarchiesi@4 527 $stub[$component] = drupal_map_assoc($feature->info['dependencies']);
danielebarchiesi@4 528 }
danielebarchiesi@4 529 }
danielebarchiesi@4 530 elseif (($stub_count[$component] == 0) && !empty($feature->info['features'][$component])) {
danielebarchiesi@4 531 $stub[$component] = drupal_map_assoc($feature->info['features'][$component]);
danielebarchiesi@4 532 }
danielebarchiesi@4 533 }
danielebarchiesi@4 534 // Generate new populated feature
danielebarchiesi@4 535 $export = features_populate(array('features' => $stub, 'dependencies' => $stub['dependencies']), $feature_name);
danielebarchiesi@4 536
danielebarchiesi@4 537 // Components that are already exported to feature
danielebarchiesi@4 538 $exported_features_info = !empty($feature->info['features']) ? $feature->info['features'] : array();
danielebarchiesi@4 539 $exported_features_info['dependencies'] = !empty($feature->info['dependencies']) ? $feature->info['dependencies'] : array();
danielebarchiesi@4 540 // Components that should be exported
danielebarchiesi@4 541 $new_features_info = !empty($export['features']) ? $export['features'] : array();
danielebarchiesi@4 542 $new_features_info['dependencies'] = !empty($export['dependencies']) ? $export['dependencies'] : array();
danielebarchiesi@4 543 $excluded = !empty($feature->info['features_exclude']) ? $feature->info['features_exclude'] : array();
danielebarchiesi@4 544
danielebarchiesi@4 545 // now fill the $export with categorized sections of component options
danielebarchiesi@4 546 // based upon user selections and de-selections
danielebarchiesi@4 547
danielebarchiesi@4 548 foreach ($components as $component => $component_info) {
danielebarchiesi@4 549 $component_export = $component_info;
danielebarchiesi@4 550 foreach ($sections as $section) {
danielebarchiesi@4 551 $component_export['options'][$section] = array();
danielebarchiesi@4 552 $component_export['selected'][$section] = array();
danielebarchiesi@4 553 }
danielebarchiesi@4 554 $options = features_invoke($component, 'features_export_options');
danielebarchiesi@4 555 if (!empty($options)) {
danielebarchiesi@4 556 $exported_components = !empty($exported_features_info[$component]) ? $exported_features_info[$component] : array();
danielebarchiesi@4 557 $new_components = !empty($new_features_info[$component]) ? $new_features_info[$component] : array();
danielebarchiesi@4 558
danielebarchiesi@4 559 // Find all default components that are not provided by this feature and
danielebarchiesi@4 560 // strip them out of the possible options.
danielebarchiesi@4 561 if ($map = features_get_default_map($component)) {
danielebarchiesi@4 562 foreach ($map as $k => $v) {
danielebarchiesi@4 563 if (isset($options[$k]) && (!isset($feature->name) || $v !== $feature->name)) {
danielebarchiesi@4 564 unset($options[$k]);
danielebarchiesi@4 565 }
danielebarchiesi@4 566 }
danielebarchiesi@4 567 }
danielebarchiesi@4 568 foreach ($options as $key => $value) {
danielebarchiesi@4 569 // use the $clean_key when accessing $form_state
danielebarchiesi@4 570 $clean_key = features_dom_encode($key);
danielebarchiesi@4 571 // if checkbox in Sources is checked, move it to Added section
danielebarchiesi@4 572 if (!empty($form_state['values'][$component]['sources']['selected'][$clean_key])) {
danielebarchiesi@4 573 unset($form_state['input'][$component]['sources']['selected'][$clean_key]);
danielebarchiesi@4 574 $form_state['values'][$component]['sources']['selected'][$clean_key] = FALSE;
danielebarchiesi@4 575 $form_state['values'][$component]['added'][$clean_key] = 1;
danielebarchiesi@4 576 $form_state['input'][$component]['added'][$clean_key] = $clean_key;
danielebarchiesi@4 577 $component_export['options']['added'][$key] = check_plain($value);
danielebarchiesi@4 578 $component_export['selected']['added'][$key] = $key;
danielebarchiesi@4 579 }
danielebarchiesi@4 580 elseif (in_array($key, $new_components)) {
danielebarchiesi@4 581 // option is in the New exported array
danielebarchiesi@4 582 if (in_array($key, $exported_components)) {
danielebarchiesi@4 583 // option was already previously exported
danielebarchiesi@4 584 // so it's part of the Included checkboxes
danielebarchiesi@4 585 $section = 'included';
danielebarchiesi@4 586 $default_value = $key;
danielebarchiesi@4 587 if ($reset) {
danielebarchiesi@4 588 // leave it included
danielebarchiesi@4 589 }
danielebarchiesi@4 590 // if Included item was un-selected (removed from export $stub)
danielebarchiesi@4 591 // but was re-detected in the $new_components
danielebarchiesi@4 592 // means it was an auto-detect that was previously part of the export
danielebarchiesi@4 593 // and is now de-selected in UI
danielebarchiesi@4 594 elseif (!empty($form_state['values']) &&
danielebarchiesi@4 595 (isset($form_state['values'][$component]['included'][$clean_key]) ||
danielebarchiesi@4 596 empty($form_state['values'][$component]['detected'][$clean_key])) &&
danielebarchiesi@4 597 empty($stub[$component][$key])) {
danielebarchiesi@4 598 $section = 'detected';
danielebarchiesi@4 599 $default_value = FALSE;
danielebarchiesi@4 600 }
danielebarchiesi@4 601 // unless it's unchecked in the form, then move it to Newly disabled item
danielebarchiesi@4 602 elseif (!empty($form_state['values']) &&
danielebarchiesi@4 603 empty($form_state['values'][$component]['added'][$clean_key]) &&
danielebarchiesi@4 604 empty($form_state['values'][$component]['detected'][$clean_key]) &&
danielebarchiesi@4 605 empty($form_state['values'][$component]['included'][$clean_key])) {
danielebarchiesi@4 606 $section = 'added';
danielebarchiesi@4 607 $default_value = FALSE;
danielebarchiesi@4 608 }
danielebarchiesi@4 609 }
danielebarchiesi@4 610 else {
danielebarchiesi@4 611 // option was in New exported array, but NOT in already exported
danielebarchiesi@4 612 // so it's a user-selected or an auto-detect item
danielebarchiesi@4 613 $section = 'detected';
danielebarchiesi@4 614 // check for item explicity excluded
danielebarchiesi@4 615 if (isset($excluded[$component][$key]) && !isset($form_state['values'][$component]['detected'][$clean_key])) {
danielebarchiesi@4 616 $default_value = FALSE;
danielebarchiesi@4 617 }
danielebarchiesi@4 618 else {
danielebarchiesi@4 619 $default_value = $key;
danielebarchiesi@4 620 }
danielebarchiesi@4 621 // if it's already checked in Added or Sources, leave it in Added as checked
danielebarchiesi@4 622 if (!empty($form_state['values']) &&
danielebarchiesi@4 623 (!empty($form_state['values'][$component]['added'][$clean_key]) ||
danielebarchiesi@4 624 !empty($form_state['values'][$component]['sources']['selected'][$clean_key]))) {
danielebarchiesi@4 625 $section = 'added';
danielebarchiesi@4 626 $default_value = $key;
danielebarchiesi@4 627 }
danielebarchiesi@4 628 // if it's already been unchecked, leave it unchecked
danielebarchiesi@4 629 elseif (!empty($form_state['values']) &&
danielebarchiesi@4 630 empty($form_state['values'][$component]['sources']['selected'][$clean_key]) &&
danielebarchiesi@4 631 empty($form_state['values'][$component]['detected'][$clean_key]) &&
danielebarchiesi@4 632 !isset($form_state['values'][$component]['added'][$clean_key])) {
danielebarchiesi@4 633 $section = 'detected';
danielebarchiesi@4 634 $default_value = FALSE;
danielebarchiesi@4 635 }
danielebarchiesi@4 636 }
danielebarchiesi@4 637 $component_export['options'][$section][$key] = check_plain($value);
danielebarchiesi@4 638 $component_export['selected'][$section][$key] = $default_value;
danielebarchiesi@4 639 // save which dependencies are specifically excluded from auto-detection
danielebarchiesi@4 640 if (($section == 'detected') && ($default_value === FALSE)) {
danielebarchiesi@4 641 $excluded[$component][$key] = $key;
danielebarchiesi@4 642 // remove excluded item from export
danielebarchiesi@4 643 if ($component == 'dependencies') {
danielebarchiesi@4 644 unset($export['dependencies'][$key]);
danielebarchiesi@4 645 }
danielebarchiesi@4 646 else {
danielebarchiesi@4 647 unset($export['features'][$component][$key]);
danielebarchiesi@4 648 }
danielebarchiesi@4 649 }
danielebarchiesi@4 650 else {
danielebarchiesi@4 651 unset($excluded[$component][$key]);
danielebarchiesi@4 652 }
danielebarchiesi@4 653 // remove the 'input' and set the 'values' so Drupal stops looking at 'input'
danielebarchiesi@4 654 if (isset($form_state['values'])) {
danielebarchiesi@4 655 if (!$default_value) {
danielebarchiesi@4 656 unset($form_state['input'][$component][$section][$clean_key]);
danielebarchiesi@4 657 $form_state['values'][$component][$section][$clean_key] = FALSE;
danielebarchiesi@4 658 }
danielebarchiesi@4 659 else {
danielebarchiesi@4 660 $form_state['input'][$component][$section][$clean_key] = $clean_key;
danielebarchiesi@4 661 $form_state['values'][$component][$section][$clean_key] = 1;
danielebarchiesi@4 662 }
danielebarchiesi@4 663 }
danielebarchiesi@4 664 }
danielebarchiesi@4 665 else {
danielebarchiesi@4 666 // option was not part of the new export
danielebarchiesi@4 667 $added = FALSE;
danielebarchiesi@4 668 foreach (array('included', 'added') as $section) {
danielebarchiesi@4 669 // restore any user-selected checkboxes
danielebarchiesi@4 670 if (!empty($form_state['values'][$component][$section][$clean_key])) {
danielebarchiesi@4 671 $component_export['options'][$section][$key] = check_plain($value);
danielebarchiesi@4 672 $component_export['selected'][$section][$key] = $key;
danielebarchiesi@4 673 $added = TRUE;
danielebarchiesi@4 674 }
danielebarchiesi@4 675 }
danielebarchiesi@4 676 if (!$added) {
danielebarchiesi@4 677 // if not Included or Added, then put it back in the unchecked Sources checkboxes
danielebarchiesi@4 678 $component_export['options']['sources'][$key] = check_plain($value);
danielebarchiesi@4 679 $component_export['selected']['sources'][$key] = FALSE;
danielebarchiesi@4 680 }
danielebarchiesi@4 681 }
danielebarchiesi@4 682 }
danielebarchiesi@4 683 }
danielebarchiesi@4 684 $export['components'][$component] = $component_export;
danielebarchiesi@4 685 }
danielebarchiesi@4 686 $export['features_exclude'] = $excluded;
danielebarchiesi@4 687
danielebarchiesi@4 688 // make excluded list and conflicts available for javascript to pass to our ajax callback
danielebarchiesi@4 689 drupal_add_js(array('features' => array(
danielebarchiesi@4 690 'excluded' => $excluded,
danielebarchiesi@4 691 'conflicts' => $conflicts,
danielebarchiesi@4 692 )), 'setting');
danielebarchiesi@4 693
danielebarchiesi@4 694 return $export;
danielebarchiesi@4 695 }
danielebarchiesi@4 696
danielebarchiesi@4 697 /**
danielebarchiesi@4 698 * AJAX callback for features_export_form.
danielebarchiesi@4 699 */
danielebarchiesi@4 700 function features_export_form_ajax($form, &$form_state) {
danielebarchiesi@4 701 return $form['export'];
danielebarchiesi@4 702 }
danielebarchiesi@4 703
danielebarchiesi@4 704 /**
danielebarchiesi@4 705 * Tells the ajax form submission to rebuild form state.
danielebarchiesi@4 706 */
danielebarchiesi@4 707 function features_export_form_rebuild($form, &$form_state) {
danielebarchiesi@4 708 $form_state['rebuild'] = TRUE;
danielebarchiesi@4 709 }
danielebarchiesi@4 710
danielebarchiesi@4 711 function features_export_components_json($feature_name) {
danielebarchiesi@4 712 module_load_include('inc', 'features', 'features.export');
danielebarchiesi@4 713 $export = array();
danielebarchiesi@4 714 if (!empty($_POST['items'])) {
danielebarchiesi@4 715 $excluded = (!empty($_POST['excluded'])) ? $_POST['excluded'] : array();
danielebarchiesi@4 716 $stub = array();
danielebarchiesi@4 717 foreach ($_POST['items'] as $key) {
danielebarchiesi@4 718 preg_match('/^([^\[]+)(\[.+\])?\[(.+)\]\[(.+)\]$/', $key, $matches);
danielebarchiesi@4 719 if (!empty($matches[1]) && !empty($matches[4])) {
danielebarchiesi@4 720 $component = $matches[1];
danielebarchiesi@4 721 $item = features_dom_decode($matches[4]);
danielebarchiesi@4 722 if (empty($stub[$component])) {
danielebarchiesi@4 723 $stub[$component] = array($item);
danielebarchiesi@4 724 }
danielebarchiesi@4 725 else {
danielebarchiesi@4 726 $stub[$component] = array_merge($stub[$component], array($item));
danielebarchiesi@4 727 }
danielebarchiesi@4 728 }
danielebarchiesi@4 729 }
danielebarchiesi@4 730
danielebarchiesi@4 731 $stub['dependencies'] = isset($stub['dependencies']) ? $stub['dependencies'] : array();
danielebarchiesi@4 732 $export = features_populate(array('features' => $stub, 'dependencies' => $stub['dependencies']), $feature_name);
danielebarchiesi@4 733 $export['features']['dependencies'] = $export['dependencies'];
danielebarchiesi@4 734
danielebarchiesi@4 735 // uncheck any detected item that is in the excluded list
danielebarchiesi@4 736 foreach ($export['features'] as $component => $value) {
danielebarchiesi@4 737 foreach ($value as $key => $item) {
danielebarchiesi@4 738 $clean_key = features_dom_encode($key);
danielebarchiesi@4 739 if ($key != $clean_key) {
danielebarchiesi@4 740 // need to move key to a cleankey for javascript
danielebarchiesi@4 741 $export['features'][$component][$clean_key] = $export['features'][$component][$key];
danielebarchiesi@4 742 unset($export['features'][$component][$key]);
danielebarchiesi@4 743 }
danielebarchiesi@4 744 if (isset($excluded[$component][$key])) {
danielebarchiesi@4 745 $export['features'][$component][$clean_key] = FALSE;
danielebarchiesi@4 746 }
danielebarchiesi@4 747 }
danielebarchiesi@4 748 }
danielebarchiesi@4 749 }
danielebarchiesi@4 750 print drupal_json_encode($export['features']);
danielebarchiesi@4 751 }
danielebarchiesi@4 752
danielebarchiesi@4 753 /**
danielebarchiesi@4 754 * AJAX callback to get .info file preview.
danielebarchiesi@4 755 */
danielebarchiesi@4 756 function features_info_file_preview($form, &$form_state){
danielebarchiesi@4 757 return $form['export'];
danielebarchiesi@4 758 }
danielebarchiesi@4 759
danielebarchiesi@4 760 /**
danielebarchiesi@4 761 * Render API callback: Validates a project field.
danielebarchiesi@4 762 *
danielebarchiesi@4 763 * This function is assigned as an #element_validate callback in
danielebarchiesi@4 764 * features_export_form().
danielebarchiesi@4 765 */
danielebarchiesi@4 766 function features_export_form_validate_field($element, &$form_state) {
danielebarchiesi@4 767 switch ($element['#name']) {
danielebarchiesi@4 768 case 'module_name':
danielebarchiesi@4 769 if (!preg_match('!^[a-z0-9_]+$!', $element['#value'])) {
danielebarchiesi@4 770 form_error($element, t('The machine-readable name must contain only lowercase letters, numbers, and underscores.'));
danielebarchiesi@4 771 }
danielebarchiesi@4 772 // If user is filling out the feature name for the first time and uses
danielebarchiesi@4 773 // the name of an existing module throw an error.
danielebarchiesi@4 774 else if (empty($element['#default_value']) && features_get_info('module', $element['#value'])) {
danielebarchiesi@4 775 form_error($element, t('A module by the name @name already exists on your site. Please choose a different name.', array('@name' => $element['#value'])));
danielebarchiesi@4 776 }
danielebarchiesi@4 777 break;
danielebarchiesi@4 778 case 'project_status_url':
danielebarchiesi@4 779 if (!empty($element['#value']) && !valid_url($element['#value'])) {
danielebarchiesi@4 780 form_error($element, t('The URL %url is invalid. Please enter a fully-qualified URL, such as http://www.example.com/feed.xml.', array('%url' => $element['#value'])));
danielebarchiesi@4 781 }
danielebarchiesi@4 782 break;
danielebarchiesi@4 783 case 'version':
danielebarchiesi@4 784 preg_match('/^(?P<core>\d+\.x)-(?P<major>\d+)\.(?P<patch>\d+)-?(?P<extra>\w+)?$/', $element['#value'], $matches);
danielebarchiesi@4 785 if (!empty($element['#value']) && !isset($matches['core'], $matches['major'])) {
danielebarchiesi@4 786 form_error($element, t('Please enter a valid version with core and major version number. Example: @example', array('@example' => '7.x-1.0')));
danielebarchiesi@4 787 };
danielebarchiesi@4 788 break;
danielebarchiesi@4 789 }
danielebarchiesi@4 790 }
danielebarchiesi@4 791
danielebarchiesi@4 792 /**
danielebarchiesi@4 793 * Return the $export array to be rendered for the feature export
danielebarchiesi@4 794 */
danielebarchiesi@4 795 function _features_export_generate($export, $form_state, $feature = NULL) {
danielebarchiesi@4 796 unset($export['components']); // remove the UI data that we are not saving to disk
danielebarchiesi@4 797
danielebarchiesi@4 798 $module_name = $form_state['values']['module_name'];
danielebarchiesi@4 799 // Directly copy the following attributes from form_state
danielebarchiesi@4 800 $attr = array('name', 'description', 'package', 'project path');
danielebarchiesi@4 801 foreach ($attr as $key) {
danielebarchiesi@4 802 $export[$key] = isset($form_state['values'][$key]) ? $form_state['values'][$key] : NULL;
danielebarchiesi@4 803 }
danielebarchiesi@4 804 // Directly copy the following attributes from the original feature
danielebarchiesi@4 805 $attr = array('scripts' , 'stylesheets');
danielebarchiesi@4 806 foreach ($attr as $key) {
danielebarchiesi@4 807 $export[$key] = isset($feature->info[$key]) ? $feature->info[$key] : NULL;
danielebarchiesi@4 808 }
danielebarchiesi@4 809 // If either update status-related keys are provided, add a project key
danielebarchiesi@4 810 // corresponding to the module name.
danielebarchiesi@4 811 if (!empty($form_state['values']['version']) || !empty($form_state['values']['project_status_url'])) {
danielebarchiesi@4 812 $export['project'] = $form_state['values']['module_name'];
danielebarchiesi@4 813 }
danielebarchiesi@4 814 if (!empty($form_state['values']['version'])) {
danielebarchiesi@4 815 $export['version'] = $form_state['values']['version'];
danielebarchiesi@4 816 }
danielebarchiesi@4 817 if (!empty($form_state['values']['project_status_url'])) {
danielebarchiesi@4 818 $export['project status url'] = $form_state['values']['project_status_url'];
danielebarchiesi@4 819 }
danielebarchiesi@4 820 $export['no autodetect'] = empty($form_state['values']['autodetect']) ? 1 : NULL;
danielebarchiesi@4 821 $export['project path'] = !empty($form_state['values']['generate_path']) ? $form_state['values']['generate_path'] : NULL;
danielebarchiesi@4 822 return $export;
danielebarchiesi@4 823 }
danielebarchiesi@4 824
danielebarchiesi@4 825 /**
danielebarchiesi@4 826 * Form submission handler for features_export_form().
danielebarchiesi@4 827 */
danielebarchiesi@4 828 function features_export_build_form_submit($form, &$form_state) {
danielebarchiesi@4 829 $feature = $form['#feature'];
danielebarchiesi@4 830 $export = _features_export_build($feature, $form_state);
danielebarchiesi@4 831 $export = _features_export_generate($export, $form_state, $feature);
danielebarchiesi@4 832 $generate = ($form_state['values']['op'] == $form_state['values']['generate']);
danielebarchiesi@4 833 $module_name = $form_state['values']['module_name'];
danielebarchiesi@4 834
danielebarchiesi@4 835 if ($generate && !user_access('generate features')) {
danielebarchiesi@4 836 drupal_set_message(t("No permission for generating features."));
danielebarchiesi@4 837 return;
danielebarchiesi@4 838 }
danielebarchiesi@4 839
danielebarchiesi@4 840 // Generate download
danielebarchiesi@4 841 if ($files = features_export_render($export, $module_name, TRUE)) {
danielebarchiesi@4 842 $filename = (!empty($export['version']) ? "{$module_name}-{$export['version']}" : $module_name) . '.tar';
danielebarchiesi@4 843
danielebarchiesi@4 844 if ($generate) {
danielebarchiesi@4 845 $success = TRUE;
danielebarchiesi@4 846 $destination = 'sites/all/modules/features';
danielebarchiesi@4 847 $directory = (!empty($export['project path'])) ? $export['project path'] . '/' . $module_name :
danielebarchiesi@4 848 (isset($feature->filename) ? dirname($feature->filename) : $destination . '/' . $module_name);
danielebarchiesi@4 849 if (!is_dir($directory)) {
danielebarchiesi@4 850 if (mkdir($directory, 0777, true) === FALSE) {
danielebarchiesi@4 851 $success = FALSE;
danielebarchiesi@4 852 }
danielebarchiesi@4 853 }
danielebarchiesi@4 854 }
danielebarchiesi@4 855 else {
danielebarchiesi@4 856 // Clear out output buffer to remove any garbage from tar output.
danielebarchiesi@4 857 if (ob_get_level()) {
danielebarchiesi@4 858 ob_end_clean();
danielebarchiesi@4 859 }
danielebarchiesi@4 860
danielebarchiesi@4 861 drupal_add_http_header('Content-type', 'application/x-tar');
danielebarchiesi@4 862 drupal_add_http_header('Content-Disposition', 'attachment; filename="'. $filename .'"');
danielebarchiesi@4 863 drupal_send_headers();
danielebarchiesi@4 864 }
danielebarchiesi@4 865
danielebarchiesi@4 866 $tar = array();
danielebarchiesi@4 867 $filenames = array();
danielebarchiesi@4 868 foreach ($files as $extension => $file_contents) {
danielebarchiesi@4 869 if (!in_array($extension, array('module', 'info'))) {
danielebarchiesi@4 870 $extension .= '.inc';
danielebarchiesi@4 871 }
danielebarchiesi@4 872 $filenames[] = "{$module_name}.$extension";
danielebarchiesi@4 873 if ($generate) {
danielebarchiesi@4 874 if (file_put_contents("{$directory}/{$module_name}.$extension", $file_contents) === FALSE) {
danielebarchiesi@4 875 $success = FALSE;
danielebarchiesi@4 876 }
danielebarchiesi@4 877 }
danielebarchiesi@4 878 else {
danielebarchiesi@4 879 print features_tar_create("{$module_name}/{$module_name}.$extension", $file_contents);
danielebarchiesi@4 880 }
danielebarchiesi@4 881 }
danielebarchiesi@4 882 if (features_get_modules($module_name, TRUE)) {
danielebarchiesi@4 883 // prevent deprecated component files from being included in download
danielebarchiesi@4 884 $deprecated = features_get_deprecated();
danielebarchiesi@4 885 foreach ($deprecated as $component) {
danielebarchiesi@4 886 $info = features_get_components($component);
danielebarchiesi@4 887 $filename = isset($info['default_file']) && $info['default_file'] == FEATURES_DEFAULTS_CUSTOM ? $info['default_filename'] : "features.{$component}";
danielebarchiesi@4 888 $filename .= '.inc';
danielebarchiesi@4 889 $filenames[] = "{$module_name}.$filename";
danielebarchiesi@4 890 }
danielebarchiesi@4 891 $module_path = drupal_get_path('module', $module_name);
danielebarchiesi@4 892 // file_scan_directory() can throw warnings when using PHP 5.3, messing
danielebarchiesi@4 893 // up the output of our file stream. Suppress errors in this one case in
danielebarchiesi@4 894 // order to produce valid output.
danielebarchiesi@4 895 foreach (@file_scan_directory($module_path, '/.*/') as $file) {
danielebarchiesi@4 896 $filename = substr($file->uri, strlen($module_path) + 1);
danielebarchiesi@4 897 if (!in_array($filename, $filenames)) {
danielebarchiesi@4 898 // Add this file.
danielebarchiesi@4 899 $contents = file_get_contents($file->uri);
danielebarchiesi@4 900 if ($generate) {
danielebarchiesi@4 901 if (file_put_contents("{$directory}/{$filename}", $contents) === FALSE) {
danielebarchiesi@4 902 $success = FALSE;
danielebarchiesi@4 903 }
danielebarchiesi@4 904 }
danielebarchiesi@4 905 else {
danielebarchiesi@4 906 print features_tar_create("{$module_name}/{$filename}", $contents);
danielebarchiesi@4 907 }
danielebarchiesi@4 908 unset($contents);
danielebarchiesi@4 909 }
danielebarchiesi@4 910 }
danielebarchiesi@4 911 }
danielebarchiesi@4 912 if ($generate) {
danielebarchiesi@4 913 if ($success) {
danielebarchiesi@4 914 drupal_set_message(t("Module @name written to @directory",
danielebarchiesi@4 915 array('@name' => $export['name'], '@directory' => $directory)));
danielebarchiesi@4 916 }
danielebarchiesi@4 917 else {
danielebarchiesi@4 918 drupal_set_message(
danielebarchiesi@4 919 t("Could not write module to @path. ", array('@path' => $directory)) .
danielebarchiesi@4 920 t("Ensure your file permissions allow the web server to write to that directory."), "error");
danielebarchiesi@4 921 }
danielebarchiesi@4 922 }
danielebarchiesi@4 923 else {
danielebarchiesi@4 924 print pack("a1024","");
danielebarchiesi@4 925 exit;
danielebarchiesi@4 926 }
danielebarchiesi@4 927 }
danielebarchiesi@4 928 }
danielebarchiesi@4 929
danielebarchiesi@4 930 /**
danielebarchiesi@4 931 * array_filter() callback for excluding hidden modules.
danielebarchiesi@4 932 */
danielebarchiesi@4 933 function features_filter_hidden($module) {
danielebarchiesi@4 934 return empty($module->info['hidden']);
danielebarchiesi@4 935 }
danielebarchiesi@4 936
danielebarchiesi@4 937 /**
danielebarchiesi@4 938 * Form constructor for the features configuration form.
danielebarchiesi@4 939 */
danielebarchiesi@4 940 function features_admin_form($form, $form_state) {
danielebarchiesi@4 941 // Load export functions to use in comparison.
danielebarchiesi@4 942 module_load_include('inc', 'features', 'features.export');
danielebarchiesi@4 943
danielebarchiesi@4 944 // Clear & rebuild key caches
danielebarchiesi@4 945 features_get_info(NULL, NULL, TRUE);
danielebarchiesi@4 946 features_rebuild();
danielebarchiesi@4 947
danielebarchiesi@4 948 $modules = array_filter(features_get_modules(), 'features_filter_hidden');
danielebarchiesi@4 949 $features = array_filter(features_get_features(), 'features_filter_hidden');
danielebarchiesi@4 950 $conflicts = features_get_conflicts();
danielebarchiesi@4 951
danielebarchiesi@4 952 foreach ($modules as $key => $module) {
danielebarchiesi@4 953 if ($module->status && !empty($module->info['dependencies'])) {
danielebarchiesi@4 954 foreach ($module->info['dependencies'] as $dependent) {
danielebarchiesi@4 955 if (isset($features[$dependent])) {
danielebarchiesi@4 956 $features[$dependent]->dependents[$key] = $module->info['name'];
danielebarchiesi@4 957 }
danielebarchiesi@4 958 }
danielebarchiesi@4 959 }
danielebarchiesi@4 960 }
danielebarchiesi@4 961
danielebarchiesi@4 962 if ( empty($features) ) {
danielebarchiesi@4 963 $form['no_features'] = array(
danielebarchiesi@4 964 '#markup' => t('No Features were found. Please use the !create_link link to create
danielebarchiesi@4 965 a new Feature module, or upload an existing Feature to your modules directory.',
danielebarchiesi@4 966 array('!create_link' => l(t('Create Feature'), 'admin/structure/features/create'))),
danielebarchiesi@4 967 );
danielebarchiesi@4 968 return $form ;
danielebarchiesi@4 969 }
danielebarchiesi@4 970
danielebarchiesi@4 971 $form = array('#features' => $features);
danielebarchiesi@4 972
danielebarchiesi@4 973 // Generate features form. Features are sorted by dependencies, resort alpha
danielebarchiesi@4 974 ksort($features);
danielebarchiesi@4 975 foreach ($features as $name => $module) {
danielebarchiesi@4 976 $package_title = !empty($module->info['package']) ? $module->info['package'] : t('Other');
danielebarchiesi@4 977 $package = strtolower(preg_replace('/[^a-zA-Z0-9-]+/', '-', $package_title));
danielebarchiesi@4 978
danielebarchiesi@4 979 // Set up package elements
danielebarchiesi@4 980 if (!isset($form[$package])) {
danielebarchiesi@4 981 $form[$package] = array(
danielebarchiesi@4 982 '#tree' => FALSE,
danielebarchiesi@4 983 '#title' => check_plain($package_title),
danielebarchiesi@4 984 '#theme' => 'features_form_package',
danielebarchiesi@4 985 '#type' => 'fieldset',
danielebarchiesi@4 986 '#group' => 'packages',
danielebarchiesi@4 987 );
danielebarchiesi@4 988 $form[$package]['links'] =
danielebarchiesi@4 989 $form[$package]['version'] =
danielebarchiesi@4 990 $form[$package]['weight'] =
danielebarchiesi@4 991 $form[$package]['status'] =
danielebarchiesi@4 992 $form[$package]['action'] = array('#tree' => TRUE);
danielebarchiesi@4 993 }
danielebarchiesi@4 994
danielebarchiesi@4 995 $disabled = FALSE;
danielebarchiesi@4 996 $description = isset($module->info['description']) ? check_plain($module->info['description']) : '';
danielebarchiesi@4 997
danielebarchiesi@4 998 // Detect unmet dependencies
danielebarchiesi@4 999 if (!empty($module->info['dependencies'])) {
danielebarchiesi@4 1000 $unmet_dependencies = array();
danielebarchiesi@4 1001 $dependencies = _features_export_maximize_dependencies($module->info['dependencies']);
danielebarchiesi@4 1002 foreach ($dependencies as $dependency) {
danielebarchiesi@4 1003 if (empty($modules[$dependency])) {
danielebarchiesi@4 1004 $unmet_dependencies[] = theme('features_module_status', array('status' => FEATURES_MODULE_MISSING, 'module' => $dependency));
danielebarchiesi@4 1005 }
danielebarchiesi@4 1006 }
danielebarchiesi@4 1007 if (!empty($unmet_dependencies)) {
danielebarchiesi@4 1008 $description .= "<div class='dependencies'>" . t('Unmet dependencies: !dependencies', array('!dependencies' => implode(', ', $unmet_dependencies))) . "</div>";
danielebarchiesi@4 1009 $disabled = TRUE;
danielebarchiesi@4 1010 }
danielebarchiesi@4 1011 }
danielebarchiesi@4 1012
danielebarchiesi@4 1013 if (!empty($module->dependents)) {
danielebarchiesi@4 1014 $disabled = TRUE;
danielebarchiesi@4 1015 $description .= "<div class='requirements'>". t('Required by: !dependents', array('!dependents' => implode(', ', $module->dependents))) ."</div>";
danielebarchiesi@4 1016 }
danielebarchiesi@4 1017
danielebarchiesi@4 1018 // Detect potential conflicts
danielebarchiesi@4 1019 if (!empty($conflicts[$name])) {
danielebarchiesi@4 1020 $module_conflicts = array();
danielebarchiesi@4 1021 foreach ($conflicts[$name] as $conflict => $components) {
danielebarchiesi@4 1022 $component_strings = array();
danielebarchiesi@4 1023 foreach ($components as $component => $component_conflicts) {
danielebarchiesi@4 1024 $component_strings[] = t('@component [@items]', array('@component' => $component, '@items' => implode(', ', $component_conflicts)));
danielebarchiesi@4 1025 }
danielebarchiesi@4 1026 $component_strings = implode(', ', $component_strings);
danielebarchiesi@4 1027 // If conflicting module is disabled, indicate so in feature listing
danielebarchiesi@4 1028 $status = !module_exists($conflict) ? FEATURES_MODULE_DISABLED : FEATURES_MODULE_CONFLICT;
danielebarchiesi@4 1029 $module_conflicts[] = theme('features_module_status', array('status' => $status, 'module' => $conflict)) . t(' in ') . $component_strings;
danielebarchiesi@4 1030 // Only disable modules with conflicts if they are not already enabled.
danielebarchiesi@4 1031 // If they are already enabled, somehow the user got themselves into a
danielebarchiesi@4 1032 // bad situation and they need to be able to disable a conflicted module.
danielebarchiesi@4 1033 if (module_exists($conflict) && !module_exists($name)) {
danielebarchiesi@4 1034 $disabled = TRUE;
danielebarchiesi@4 1035 }
danielebarchiesi@4 1036 }
danielebarchiesi@4 1037 $description .= "<div class='conflicts'>". t('Conflicts with: !conflicts', array('!conflicts' => implode(', ', $module_conflicts))) ."</div>";
danielebarchiesi@4 1038 }
danielebarchiesi@4 1039
danielebarchiesi@4 1040 $href = "admin/structure/features/{$name}";
danielebarchiesi@4 1041 $module_name = (user_access('administer features')) ? l($module->info['name'], $href) : $module->info['name'];
danielebarchiesi@4 1042 $form[$package]['status'][$name] = array(
danielebarchiesi@4 1043 '#type' => 'checkbox',
danielebarchiesi@4 1044 '#title' => $module_name,
danielebarchiesi@4 1045 '#description' => $description,
danielebarchiesi@4 1046 '#default_value' => $module->status,
danielebarchiesi@4 1047 '#disabled' => $disabled,
danielebarchiesi@4 1048 );
danielebarchiesi@4 1049
danielebarchiesi@4 1050 if (!empty($module->info['project status url'])) {
danielebarchiesi@4 1051 $uri = l(truncate_utf8($module->info['project status url'], 35, TRUE, TRUE), $module->info['project status url']);
danielebarchiesi@4 1052 }
danielebarchiesi@4 1053 else if (isset($module->info['project'], $module->info['version'], $module->info['datestamp'])) {
danielebarchiesi@4 1054 $uri = l('http://drupal.org', 'http://drupal.org/project/' . $module->info['project']);
danielebarchiesi@4 1055 }
danielebarchiesi@4 1056 else {
danielebarchiesi@4 1057 $uri = t('Unavailable');
danielebarchiesi@4 1058 }
danielebarchiesi@4 1059 $version = !empty($module->info['version']) ? $module->info['version'] : '';
danielebarchiesi@4 1060 $version = !empty($version) ? "<div class='description'>$version</div>" : '';
danielebarchiesi@4 1061 $form[$package]['sign'][$name] = array('#markup' => "{$uri} {$version}");
danielebarchiesi@4 1062
danielebarchiesi@4 1063 if (user_access('administer features')) {
danielebarchiesi@4 1064 // Add status link
danielebarchiesi@4 1065 if ($module->status) {
danielebarchiesi@4 1066 $state = theme('features_storage_link', array('storage' => FEATURES_CHECKING, 'path' => $href));
danielebarchiesi@4 1067 $state .= l(t('Check'), "admin/structure/features/{$name}/status", array('attributes' => array('class' => array('admin-check'))));
danielebarchiesi@4 1068 $state .= theme('features_storage_link', array('storage' => FEATURES_REBUILDING, 'path' => $href));
danielebarchiesi@4 1069 $state .= theme('features_storage_link', array('storage' => FEATURES_NEEDS_REVIEW, 'path' => $href));
danielebarchiesi@4 1070 $state .= theme('features_storage_link', array('storage' => FEATURES_OVERRIDDEN, 'path' => $href));
danielebarchiesi@4 1071 $state .= theme('features_storage_link', array('storage' => FEATURES_DEFAULT, 'path' => $href));
danielebarchiesi@4 1072 }
danielebarchiesi@4 1073 elseif (!empty($conflicts[$name])) {
danielebarchiesi@4 1074 $state = theme('features_storage_link', array('storage' => FEATURES_CONFLICT, 'path' => $href));
danielebarchiesi@4 1075 }
danielebarchiesi@4 1076 else {
danielebarchiesi@4 1077 $state = theme('features_storage_link', array('storage' => FEATURES_DISABLED, 'path' => $href));
danielebarchiesi@4 1078 }
danielebarchiesi@4 1079 $form[$package]['state'][$name] = array(
danielebarchiesi@4 1080 '#markup' => !empty($state) ? $state : '',
danielebarchiesi@4 1081 );
danielebarchiesi@4 1082
danielebarchiesi@4 1083 // Add in recreate link
danielebarchiesi@4 1084 $form[$package]['actions'][$name] = array(
danielebarchiesi@4 1085 '#markup' => l(t('Recreate'), "admin/structure/features/{$name}/recreate", array('attributes' => array('class' => array('admin-update')))),
danielebarchiesi@4 1086 );
danielebarchiesi@4 1087 }
danielebarchiesi@4 1088 }
danielebarchiesi@4 1089 ksort($form);
danielebarchiesi@4 1090
danielebarchiesi@4 1091 // As of 7.0 beta 2 it matters where the "vertical_tabs" element lives on the
danielebarchiesi@4 1092 // the array. We add it late, but at the beginning of the array because that
danielebarchiesi@4 1093 // keeps us away from trouble.
danielebarchiesi@4 1094 $form = array('packages' => array('#type' => 'vertical_tabs')) + $form;
danielebarchiesi@4 1095
danielebarchiesi@4 1096 $form['buttons'] = array(
danielebarchiesi@4 1097 '#theme' => 'features_form_buttons',
danielebarchiesi@4 1098 );
danielebarchiesi@4 1099 $form['buttons']['submit'] = array(
danielebarchiesi@4 1100 '#type' => 'submit',
danielebarchiesi@4 1101 '#value' => t('Save settings'),
danielebarchiesi@4 1102 '#submit' => array('features_form_submit'),
danielebarchiesi@4 1103 '#validate' => array('features_form_validate'),
danielebarchiesi@4 1104 );
danielebarchiesi@4 1105 return $form;
danielebarchiesi@4 1106 }
danielebarchiesi@4 1107
danielebarchiesi@4 1108 /**
danielebarchiesi@4 1109 * Display the components of a feature.
danielebarchiesi@4 1110 */
danielebarchiesi@4 1111 function features_admin_components($form, $form_state, $feature) {
danielebarchiesi@4 1112 // Breadcrumb navigation
danielebarchiesi@4 1113 $breadcrumb[] = l(t('Home'), NULL);
danielebarchiesi@4 1114 $breadcrumb[] = l(t('Administration'), 'admin');
danielebarchiesi@4 1115 $breadcrumb[] = l(t('Structure'), 'admin/structure');
danielebarchiesi@4 1116 $breadcrumb[] = l(t('Features'), 'admin/structure/features');
danielebarchiesi@4 1117 drupal_set_breadcrumb($breadcrumb);
danielebarchiesi@4 1118
danielebarchiesi@4 1119 module_load_include('inc', 'features', 'features.export');
danielebarchiesi@4 1120 $form = array();
danielebarchiesi@4 1121
danielebarchiesi@4 1122 // Store feature info for theme layer.
danielebarchiesi@4 1123 $form['module'] = array('#type' => 'value', '#value' => $feature->name);
danielebarchiesi@4 1124 $form['#info'] = $feature->info;
danielebarchiesi@4 1125 $form['#dependencies'] = array();
danielebarchiesi@4 1126 if (!empty($feature->info['dependencies'])) {
danielebarchiesi@4 1127 foreach ($feature->info['dependencies'] as $dependency) {
danielebarchiesi@4 1128 $parsed_dependency = drupal_parse_dependency($dependency);
danielebarchiesi@4 1129 $dependency = $parsed_dependency['name'];
danielebarchiesi@4 1130 $status = features_get_module_status($dependency);
danielebarchiesi@4 1131 $form['#dependencies'][$dependency] = $status;
danielebarchiesi@4 1132 }
danielebarchiesi@4 1133 }
danielebarchiesi@4 1134
danielebarchiesi@4 1135 $conflicts = features_get_conflicts();
danielebarchiesi@4 1136 if (!module_exists($form['module']['#value']) && isset($form['module']['#value']) && !empty($conflicts[$form['module']['#value']])) {
danielebarchiesi@4 1137 $module_conflicts = $conflicts[$form['module']['#value']];
danielebarchiesi@4 1138 $conflicts = array();
danielebarchiesi@4 1139 foreach ($module_conflicts as $conflict) {
danielebarchiesi@4 1140 $conflicts = array_merge_recursive($conflict, $conflicts);
danielebarchiesi@4 1141 }
danielebarchiesi@4 1142 }
danielebarchiesi@4 1143 else {
danielebarchiesi@4 1144 $conflicts = array();
danielebarchiesi@4 1145 }
danielebarchiesi@4 1146 $form['#conflicts'] = $conflicts;
danielebarchiesi@4 1147
danielebarchiesi@4 1148 $review = $revert = FALSE;
danielebarchiesi@4 1149
danielebarchiesi@4 1150 // Iterate over components and retrieve status for display
danielebarchiesi@4 1151 $states = features_get_component_states(array($feature->name), FALSE);
danielebarchiesi@4 1152 $form['revert']['#tree'] = TRUE;
danielebarchiesi@4 1153 foreach ($feature->info['features'] as $component => $items) {
danielebarchiesi@4 1154 if (user_access('administer features') && array_key_exists($component, $states[$feature->name]) && in_array($states[$feature->name][$component], array(FEATURES_OVERRIDDEN, FEATURES_NEEDS_REVIEW))) {
danielebarchiesi@4 1155 switch ($states[$feature->name][$component]) {
danielebarchiesi@4 1156 case FEATURES_OVERRIDDEN:
danielebarchiesi@4 1157 $revert = TRUE;
danielebarchiesi@4 1158 break;
danielebarchiesi@4 1159 case FEATURES_NEEDS_REVIEW:
danielebarchiesi@4 1160 $review = TRUE;
danielebarchiesi@4 1161 break;
danielebarchiesi@4 1162 }
danielebarchiesi@4 1163 $form['revert'][$component] = array(
danielebarchiesi@4 1164 '#type' => 'checkbox',
danielebarchiesi@4 1165 '#default_value' => FALSE,
danielebarchiesi@4 1166 );
danielebarchiesi@4 1167 }
danielebarchiesi@4 1168 if (module_exists('diff')) {
danielebarchiesi@4 1169 $diffpath = "admin/structure/features/{$feature->name}/diff/{$component}";
danielebarchiesi@4 1170 $item = menu_get_item($diffpath);
danielebarchiesi@4 1171 $path = ($item && $item['access']) ? $diffpath : NULL;
danielebarchiesi@4 1172 }
danielebarchiesi@4 1173 else {
danielebarchiesi@4 1174 $path = NULL;
danielebarchiesi@4 1175 }
danielebarchiesi@4 1176
danielebarchiesi@4 1177 $storage = FEATURES_DEFAULT;
danielebarchiesi@4 1178 if (array_key_exists($component, $states[$feature->name])) {
danielebarchiesi@4 1179 $storage = $states[$feature->name][$component];
danielebarchiesi@4 1180 }
danielebarchiesi@4 1181 else if (array_key_exists($component, $conflicts)) {
danielebarchiesi@4 1182 $storage = FEATURES_CONFLICT;
danielebarchiesi@4 1183 }
danielebarchiesi@4 1184 $form['components'][$component] = array(
danielebarchiesi@4 1185 '#markup' => theme('features_storage_link', array('storage' => $storage, 'path' => $path)),
danielebarchiesi@4 1186 );
danielebarchiesi@4 1187 }
danielebarchiesi@4 1188
danielebarchiesi@4 1189 if ($review || $revert) {
danielebarchiesi@4 1190 $form['buttons'] = array('#theme' => 'features_form_buttons', '#tree' => TRUE);
danielebarchiesi@4 1191 if ($revert || $review) {
danielebarchiesi@4 1192 $form['buttons']['revert'] = array(
danielebarchiesi@4 1193 '#type' => 'submit',
danielebarchiesi@4 1194 '#value' => t('Revert components'),
danielebarchiesi@4 1195 '#submit' => array('features_admin_components_revert'),
danielebarchiesi@4 1196 );
danielebarchiesi@4 1197 }
danielebarchiesi@4 1198 if ($review) {
danielebarchiesi@4 1199 $form['buttons']['review'] = array(
danielebarchiesi@4 1200 '#type' => 'submit',
danielebarchiesi@4 1201 '#value' => t('Mark as reviewed'),
danielebarchiesi@4 1202 '#submit' => array('features_admin_components_review'),
danielebarchiesi@4 1203 );
danielebarchiesi@4 1204 }
danielebarchiesi@4 1205 }
danielebarchiesi@4 1206 return $form;
danielebarchiesi@4 1207 }
danielebarchiesi@4 1208
danielebarchiesi@4 1209 /**
danielebarchiesi@4 1210 * Submit handler for revert form.
danielebarchiesi@4 1211 */
danielebarchiesi@4 1212 function features_admin_components_revert(&$form, &$form_state) {
danielebarchiesi@4 1213 module_load_include('inc', 'features', 'features.export');
danielebarchiesi@4 1214 features_include();
danielebarchiesi@4 1215 $module = $form_state['values']['module'];
danielebarchiesi@4 1216 $revert = array($module => array());
danielebarchiesi@4 1217 foreach (array_filter($form_state['values']['revert']) as $component => $status) {
danielebarchiesi@4 1218 $revert[$module][] = $component;
danielebarchiesi@4 1219 drupal_set_message(t('Reverted all <strong>@component</strong> components for <strong>@module</strong>.', array('@component' => $component, '@module' => $module)));
danielebarchiesi@4 1220 }
danielebarchiesi@4 1221 if (empty($revert[$module])) {
danielebarchiesi@4 1222 drupal_set_message(t('Please select which components to revert.'), 'warning');
danielebarchiesi@4 1223 }
danielebarchiesi@4 1224 features_revert($revert);
danielebarchiesi@4 1225 $form_state['redirect'] = 'admin/structure/features/' . $module;
danielebarchiesi@4 1226 }
danielebarchiesi@4 1227
danielebarchiesi@4 1228 /**
danielebarchiesi@4 1229 * Submit handler for revert form.
danielebarchiesi@4 1230 */
danielebarchiesi@4 1231 function features_admin_components_review(&$form, &$form_state) {
danielebarchiesi@4 1232 module_load_include('inc', 'features', 'features.export');
danielebarchiesi@4 1233 features_include();
danielebarchiesi@4 1234 $module = $form_state['values']['module'];
danielebarchiesi@4 1235 $revert = array();
danielebarchiesi@4 1236 foreach (array_filter($form_state['values']['revert']) as $component => $status) {
danielebarchiesi@4 1237 features_set_signature($module, $component);
danielebarchiesi@4 1238 drupal_set_message(t('All <strong>@component</strong> components for <strong>@module</strong> reviewed.', array('@component' => $component, '@module' => $module)));
danielebarchiesi@4 1239 }
danielebarchiesi@4 1240 $form_state['redirect'] = 'admin/structure/features/' . $module;
danielebarchiesi@4 1241 }
danielebarchiesi@4 1242
danielebarchiesi@4 1243 /**
danielebarchiesi@4 1244 * Validate handler for the 'manage features' form.
danielebarchiesi@4 1245 */
danielebarchiesi@4 1246 function features_form_validate(&$form, &$form_state) {
danielebarchiesi@4 1247 include_once './includes/install.inc';
danielebarchiesi@4 1248 $conflicts = features_get_conflicts();
danielebarchiesi@4 1249 foreach ($form_state['values']['status'] as $module => $status) {
danielebarchiesi@4 1250 if ($status) {
danielebarchiesi@4 1251 if (!empty($conflicts[$module])) {
danielebarchiesi@4 1252 foreach (array_keys($conflicts[$module]) as $conflict) {
danielebarchiesi@4 1253 if (!empty($form_state['values']['status'][$conflict])) {
danielebarchiesi@4 1254 form_set_error('status', t('The feature @module cannot be enabled because it conflicts with @conflict.', array('@module' => $module, '@conflict' => $conflict)));
danielebarchiesi@4 1255 }
danielebarchiesi@4 1256 }
danielebarchiesi@4 1257 }
danielebarchiesi@4 1258 if (!drupal_check_module($module)) {
danielebarchiesi@4 1259 form_set_error('status', t('The feature @module cannot be enabled because it has unmet requirements.', array('@module' => $module)));
danielebarchiesi@4 1260 }
danielebarchiesi@4 1261 }
danielebarchiesi@4 1262 }
danielebarchiesi@4 1263 }
danielebarchiesi@4 1264
danielebarchiesi@4 1265 /**
danielebarchiesi@4 1266 * Submit handler for the 'manage features' form
danielebarchiesi@4 1267 */
danielebarchiesi@4 1268 function features_form_submit(&$form, &$form_state) {
danielebarchiesi@4 1269 // Clear drupal caches after enabling a feature. We do this in a separate
danielebarchiesi@4 1270 // page callback rather than as part of the submit handler as some modules
danielebarchiesi@4 1271 // have includes/other directives of importance in hooks that have already
danielebarchiesi@4 1272 // been called in this page load.
danielebarchiesi@4 1273 $form_state['redirect'] = 'admin/structure/features/cleanup/clear';
danielebarchiesi@4 1274
danielebarchiesi@4 1275 $features = $form['#features'];
danielebarchiesi@4 1276 if (!empty($features)) {
danielebarchiesi@4 1277 $status = $form_state['values']['status'];
danielebarchiesi@4 1278 $install = array_keys(array_filter($status));
danielebarchiesi@4 1279 $disable = array_diff(array_keys($status), $install);
danielebarchiesi@4 1280
danielebarchiesi@4 1281 // Disable first. If there are any features that are disabled that are
danielebarchiesi@4 1282 // dependencies of features that have been queued for install, they will
danielebarchiesi@4 1283 // be re-enabled.
danielebarchiesi@4 1284 module_disable($disable);
danielebarchiesi@4 1285 features_install_modules($install);
danielebarchiesi@4 1286 }
danielebarchiesi@4 1287 }
danielebarchiesi@4 1288
danielebarchiesi@4 1289 /**
danielebarchiesi@4 1290 * Form for clearing cache after enabling a feature.
danielebarchiesi@4 1291 */
danielebarchiesi@4 1292 function features_cleanup_form($form, $form_state, $cache_clear = FALSE) {
danielebarchiesi@4 1293 // Clear caches if we're getting a post-submit redirect that requests it.
danielebarchiesi@4 1294 if ($cache_clear) {
danielebarchiesi@4 1295 drupal_flush_all_caches();
danielebarchiesi@4 1296
danielebarchiesi@4 1297 // The following functions need to be run because drupal_flush_all_caches()
danielebarchiesi@4 1298 // runs rebuilds in the wrong order. The node type cache is rebuilt *after*
danielebarchiesi@4 1299 // the menu is rebuilt, meaning that the menu tree is stale in certain
danielebarchiesi@4 1300 // circumstances after drupal_flush_all_caches(). We rebuild again.
danielebarchiesi@4 1301 menu_rebuild();
danielebarchiesi@4 1302 }
danielebarchiesi@4 1303
danielebarchiesi@4 1304 drupal_goto('admin/structure/features');
danielebarchiesi@4 1305 }
danielebarchiesi@4 1306
danielebarchiesi@4 1307 /**
danielebarchiesi@4 1308 * Page callback to display the differences between what's in code and
danielebarchiesi@4 1309 * what is in the db.
danielebarchiesi@4 1310 *
danielebarchiesi@4 1311 * @param $feature
danielebarchiesi@4 1312 * A loaded feature object to display differences for.
danielebarchiesi@4 1313 * @param $component
danielebarchiesi@4 1314 * (optional) Specific component to display differences for. If excluded, all
danielebarchiesi@4 1315 * components are used.
danielebarchiesi@4 1316 *
danielebarchiesi@4 1317 * @return
danielebarchiesi@4 1318 * Themed display of what is different.
danielebarchiesi@4 1319 */
danielebarchiesi@4 1320 function features_feature_diff($feature, $component = NULL) {
danielebarchiesi@4 1321 drupal_add_css(drupal_get_path('module', 'features') . '/features.css');
danielebarchiesi@4 1322 module_load_include('inc', 'features', 'features.export');
danielebarchiesi@4 1323 drupal_set_title($feature->info['name']);
danielebarchiesi@4 1324
danielebarchiesi@4 1325 $overrides = features_detect_overrides($feature);
danielebarchiesi@4 1326
danielebarchiesi@4 1327 $output = '';
danielebarchiesi@4 1328 if (!empty($overrides)) {
danielebarchiesi@4 1329 // Filter overrides down to specified component.
danielebarchiesi@4 1330 if (isset($component) && isset($overrides[$component])) {
danielebarchiesi@4 1331 $overrides = array($component => $overrides[$component]);
danielebarchiesi@4 1332 }
danielebarchiesi@4 1333
danielebarchiesi@4 1334 module_load_include('inc', 'diff', 'diff.engine');
danielebarchiesi@4 1335 $formatter = new DrupalDiffFormatter();
danielebarchiesi@4 1336
danielebarchiesi@4 1337 $rows = array();
danielebarchiesi@4 1338 foreach ($overrides as $component => $items) {
danielebarchiesi@4 1339 $rows[] = array(array('data' => $component, 'colspan' => 4, 'header' => TRUE));
danielebarchiesi@4 1340 $diff = new Diff(explode("\n", $items['default']), explode("\n", $items['normal']));
danielebarchiesi@4 1341 $rows = array_merge($rows, $formatter->format($diff));
danielebarchiesi@4 1342 }
danielebarchiesi@4 1343 $header = array(
danielebarchiesi@4 1344 array('data' => t('Default'), 'colspan' => 2),
danielebarchiesi@4 1345 array('data' => t('Overrides'), 'colspan' => 2),
danielebarchiesi@4 1346 );
danielebarchiesi@4 1347 $output .= theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('class' => array('diff', 'features-diff'))));
danielebarchiesi@4 1348 }
danielebarchiesi@4 1349 else {
danielebarchiesi@4 1350 $output = "<div class='features-empty'>" . t('No changes have been made to this feature.') . "</div>";
danielebarchiesi@4 1351 }
danielebarchiesi@4 1352 $output = array('page' => array('#markup' => "<div class='features-comparison'>{$output}</div>"));
danielebarchiesi@4 1353 return $output;
danielebarchiesi@4 1354 }
danielebarchiesi@4 1355
danielebarchiesi@4 1356 /**
danielebarchiesi@4 1357 * Compare the component names. Used to sort alphabetically.
danielebarchiesi@4 1358 */
danielebarchiesi@4 1359 function features_compare_component_name($a, $b) {
danielebarchiesi@4 1360 return strcasecmp($a['name'], $b['name']);
danielebarchiesi@4 1361 }
danielebarchiesi@4 1362
danielebarchiesi@4 1363 /**
danielebarchiesi@4 1364 * Javascript callback that returns the status of a feature.
danielebarchiesi@4 1365 */
danielebarchiesi@4 1366 function features_feature_status($feature) {
danielebarchiesi@4 1367 module_load_include('inc', 'features', 'features.export');
danielebarchiesi@4 1368 return drupal_json_output(array('storage' => features_get_storage($feature->name)));
danielebarchiesi@4 1369 }
danielebarchiesi@4 1370
danielebarchiesi@4 1371 /**
danielebarchiesi@4 1372 * Make a Drupal options array safe for usage with jQuery DOM selectors.
danielebarchiesi@4 1373 * Encodes known bad characters into __[ordinal]__ so that they may be
danielebarchiesi@4 1374 * safely referenced by JS behaviors.
danielebarchiesi@4 1375 */
danielebarchiesi@4 1376 function features_dom_encode_options($options = array(), $keys_only = TRUE) {
danielebarchiesi@4 1377 $replacements = features_dom_encode_map();
danielebarchiesi@4 1378 $encoded = array();
danielebarchiesi@4 1379 foreach ($options as $key => $value) {
danielebarchiesi@4 1380 $encoded[strtr($key, $replacements)] = $keys_only ? $value : strtr($value, $replacements);
danielebarchiesi@4 1381 }
danielebarchiesi@4 1382 return $encoded;
danielebarchiesi@4 1383 }
danielebarchiesi@4 1384
danielebarchiesi@4 1385 function features_dom_encode($key) {
danielebarchiesi@4 1386 $replacements = features_dom_encode_map();
danielebarchiesi@4 1387 return strtr($key, $replacements);
danielebarchiesi@4 1388 }
danielebarchiesi@4 1389
danielebarchiesi@4 1390 function features_dom_decode($key) {
danielebarchiesi@4 1391 $replacements = array_flip(features_dom_encode_map());
danielebarchiesi@4 1392 return strtr($key, $replacements);
danielebarchiesi@4 1393 }
danielebarchiesi@4 1394
danielebarchiesi@4 1395 /**
danielebarchiesi@4 1396 * Decode an array of option values that have been encoded by
danielebarchiesi@4 1397 * features_dom_encode_options().
danielebarchiesi@4 1398 */
danielebarchiesi@4 1399 function features_dom_decode_options($options, $keys_only = FALSE) {
danielebarchiesi@4 1400 $replacements = array_flip(features_dom_encode_map());
danielebarchiesi@4 1401 $encoded = array();
danielebarchiesi@4 1402 foreach ($options as $key => $value) {
danielebarchiesi@4 1403 $encoded[strtr($key, $replacements)] = $keys_only ? $value : strtr($value, $replacements);
danielebarchiesi@4 1404 }
danielebarchiesi@4 1405 return $encoded;
danielebarchiesi@4 1406 }
danielebarchiesi@4 1407
danielebarchiesi@4 1408 /**
danielebarchiesi@4 1409 * Returns encoding map for decode and encode options.
danielebarchiesi@4 1410 */
danielebarchiesi@4 1411 function features_dom_encode_map() {
danielebarchiesi@4 1412 return array(
danielebarchiesi@4 1413 ':' => '__' . ord(':') . '__',
danielebarchiesi@4 1414 '/' => '__' . ord('/') . '__',
danielebarchiesi@4 1415 ',' => '__' . ord(',') . '__',
danielebarchiesi@4 1416 '.' => '__' . ord('.') . '__',
danielebarchiesi@4 1417 '<' => '__' . ord('<') . '__',
danielebarchiesi@4 1418 '>' => '__' . ord('>') . '__',
danielebarchiesi@4 1419 '%' => '__' . ord('%') . '__',
danielebarchiesi@4 1420 ')' => '__' . ord(')') . '__',
danielebarchiesi@4 1421 '(' => '__' . ord('(') . '__',
danielebarchiesi@4 1422 );
danielebarchiesi@4 1423 }
danielebarchiesi@4 1424
danielebarchiesi@4 1425 /**
danielebarchiesi@4 1426 * Page callback: Autocomplete field for features package.
danielebarchiesi@4 1427 *
danielebarchiesi@4 1428 * @param $search_string
danielebarchiesi@4 1429 * The char or string that user have written in autocomplete field,
danielebarchiesi@4 1430 * this is the string this function uses for filter.
danielebarchiesi@4 1431 *
danielebarchiesi@4 1432 * @see features_menu()
danielebarchiesi@4 1433 */
danielebarchiesi@4 1434 function features_autocomplete_packages($search_string) {
danielebarchiesi@4 1435 $matched_packages = array();
danielebarchiesi@4 1436 //fetch all modules that are features and copy the package name into a new array.
danielebarchiesi@4 1437 foreach (features_get_features(NULL, TRUE) as $value) {
danielebarchiesi@4 1438 if (preg_match('/' . $search_string . '/i', $value->info['package'])) {
danielebarchiesi@4 1439 $matched_packages[$value->info['package']] = $value->info['package'];
danielebarchiesi@4 1440 }
danielebarchiesi@4 1441 }
danielebarchiesi@4 1442 //removes duplicated package, we wont a list of all unique packages.
danielebarchiesi@4 1443 $matched_packages = array_unique($matched_packages);
danielebarchiesi@4 1444 drupal_json_output($matched_packages);
danielebarchiesi@4 1445 }
danielebarchiesi@4 1446
danielebarchiesi@4 1447 /**
danielebarchiesi@4 1448 * Return a list of all used components/items not matching a given feature module
danielebarchiesi@4 1449 * similar to features_get_conflicts but returns all component items "in use"
danielebarchiesi@4 1450 */
danielebarchiesi@4 1451 function _features_get_used($module_name = NULL) {
danielebarchiesi@4 1452
danielebarchiesi@4 1453 global $features_ignore_conflicts;
danielebarchiesi@4 1454 // make sure we turn off the ignore_conflicts global to get full list of used components
danielebarchiesi@4 1455 // hate to use global, but since this is just for an admin screen it's not a real problem
danielebarchiesi@4 1456 $old_value = $features_ignore_conflicts;
danielebarchiesi@4 1457 $features_ignore_conflicts = FALSE;
danielebarchiesi@4 1458
danielebarchiesi@4 1459 $conflicts = array();
danielebarchiesi@4 1460 $component_info = features_get_components();
danielebarchiesi@4 1461 $map = features_get_component_map();
danielebarchiesi@4 1462
danielebarchiesi@4 1463 foreach ($map as $type => $components) {
danielebarchiesi@4 1464 // Only check conflicts for components we know about.
danielebarchiesi@4 1465 if (isset($component_info[$type])) {
danielebarchiesi@4 1466 foreach ($components as $component => $modules) {
danielebarchiesi@4 1467 foreach ($modules as $module) {
danielebarchiesi@4 1468 // only for enabled modules
danielebarchiesi@4 1469 if (module_exists($module) && (empty($module_name) || ($module_name != $module))) {
danielebarchiesi@4 1470 if (!isset($conflicts[$module])) {
danielebarchiesi@4 1471 $conflicts[$module] = array();
danielebarchiesi@4 1472 }
danielebarchiesi@4 1473 $conflicts[$module][$type][] = $component;
danielebarchiesi@4 1474 }
danielebarchiesi@4 1475 }
danielebarchiesi@4 1476 }
danielebarchiesi@4 1477 }
danielebarchiesi@4 1478 }
danielebarchiesi@4 1479
danielebarchiesi@4 1480 // restore previous value of global
danielebarchiesi@4 1481 $features_ignore_conflicts = $old_value;
danielebarchiesi@4 1482 return $conflicts;
danielebarchiesi@4 1483 }