'fieldset', '#title' => t('Show components on create/edit feature form.'), '#description' => t('Components with no options will not be shown no matter the setting below. Disabled components cannot be used with admin form.') ); foreach ($components as $compontent => $info) { if (empty($info['feature_source']) && empty($info['features_source'])) { continue; } $form['show_components']['features_admin_show_component_' . $compontent] = array( '#title' => t('@name (@machine)', array('@name' => $info['name'], '@machine' => $compontent)), '#type' => 'checkbox', '#default_value' => variable_get('features_admin_show_component_' . $compontent, TRUE), ); if ($compontent == 'menu_links' && ($menus = menu_get_menus())) { $form['show_components']['features_admin_menu_links'] = array( '#title' => t('Advanced Menu Link Settings'), '#type' => 'fieldset', '#collapsed' => TRUE, '#collapsible' => TRUE, '#states' => array( 'invisible' => array( 'input[name="features_admin_show_component_menu_links"]' => array('checked' => FALSE), ), ), ); $form['show_components']['features_admin_menu_links']['features_admin_menu_links_menus'] = array( '#title' => t('Allowed menus for menu links'), '#type' => 'checkboxes', '#options' => array_map('check_plain', $menus), '#default_value' => variable_get('features_admin_menu_links_menus', array_keys(menu_get_menus())), ); } } $form['general'] = array( '#title' => t('General settings'), '#type' => 'fieldset', ); $form['general']['features_default_export_path'] = array( '#title' => t('Default export path'), '#type' => 'textfield', '#default_value' => variable_get('features_default_export_path', FEATURES_DEFAULT_EXPORT_PATH), '#description' => t('All feature exports will be automatically saved to this path, unless overridden on the individual feature.'), ); $form['general']['features_rebuild_on_flush'] = array( '#type' => 'checkbox', '#title' => t('Rebuild features on cache clear'), '#default_value' => variable_get('features_rebuild_on_flush', TRUE), '#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.'), ); return system_settings_form($form); } /** * Form constructor for features export form. * * Acts as a router based on the form_state. * * @param object|null $feature * The feature object, if available. NULL by default. * * @see features_export_build_form_submit() * @ingroup forms */ function features_export_form($form, $form_state, $feature = NULL) { module_load_include('inc', 'features', 'features.export'); features_include(); $feature_name = !empty($feature->name) ? $feature->name : ''; $form = array( '#attributes' => array('class' => array('features-export-form')), '#feature' => isset($feature) ? $feature : NULL, ); $form['info'] = array( '#type' => 'fieldset', '#title' => t('General Information'), '#tree' => FALSE, '#weight' => 2, '#collapsible' => FALSE, '#collapsed' => FALSE, '#prefix' => "
", '#suffix' => '
', ); $form['info']['name'] = array( '#title' => t('Name'), '#description' => t('Example: Image gallery') . ' (' . t('Do not begin name with numbers.') . ')', '#type' => 'textfield', '#default_value' => !empty($feature->info['name']) ? $feature->info['name'] : '', '#attributes' => array('class' => array('feature-name')), ); $form['info']['module_name'] = array( '#type' => 'textfield', '#title' => t('Machine-readable name'), '#description' => t('Example: image_gallery') . '
' . t('May only contain lowercase letters, numbers and underscores. Try to avoid conflicts with the names of existing Drupal projects.'), '#required' => TRUE, '#default_value' => $feature_name, '#attributes' => array('class' => array('feature-module-name')), '#element_validate' => array('features_export_form_validate_field'), ); // If recreating this feature, disable machine name field and blank out // js-attachment classes to ensure the machine name cannot be changed. if (isset($feature)) { $form['info']['module_name']['#value'] = $feature_name; $form['info']['module_name']['#disabled'] = TRUE; $form['info']['name']['#attributes'] = array(); } $form['info']['description'] = array( '#title' => t('Description'), '#description' => t('Provide a short description of what users should expect when they enable your feature.'), '#type' => 'textfield', '#default_value' => !empty($feature->info['description']) ? $feature->info['description'] : '', ); $form['info']['package'] = array( '#title' => t('Package'), '#description' => t('Organize your features in groups.'), '#type' => 'textfield', '#autocomplete_path' => 'features/autocomplete/packages', '#default_value' => !empty($feature->info['package']) ? $feature->info['package'] : 'Features', ); $form['info']['version'] = array( '#title' => t('Version'), '#description' => t('Examples: 7.x-1.0, 7.x-1.0-beta1'), '#type' => 'textfield', '#required' => FALSE, '#default_value' => !empty($feature->info['version']) ? $feature->info['version'] : '', '#size' => 30, '#element_validate' => array('features_export_form_validate_field'), ); $form['advanced'] = array( '#type' => 'fieldset', '#title' => t('Advanced Options'), '#tree' => FALSE, '#collapsible' => TRUE, '#collapsed' => TRUE, '#weight' => 10, '#prefix' => "
", '#suffix' => '
', ); $form['advanced']['project_status_url'] = array( '#title' => t('URL of update XML'), '#description' => t('URL of Feature Server. For Example: http://mywebsite.com/fserver'), '#type' => 'textfield', '#required' => FALSE, '#default_value' => !empty($feature->info['project status url']) ? $feature->info['project status url'] : '', '#element_validate' => array('features_export_form_validate_field'), ); $directory = (!empty($feature->filename)) ? dirname($feature->filename) : variable_get('features_default_export_path', FEATURES_DEFAULT_EXPORT_PATH); if (!empty($feature_name) && substr_compare($directory, $feature_name, strlen($directory)-strlen($feature_name), strlen($feature_name)) === 0) { // if path ends with module_name, strip it $directory = dirname($directory); } if (user_access('generate features')) { $form['advanced']['generate_path'] = array( '#title' => t('Path to Generate feature module'), '#description' => t('File path for feature module. For Example: sites/all/modules/features or /tmp. ' . t('Leave blank for @path', array('@path' => $directory))), '#type' => 'textfield', '#required' => FALSE, '#default_value' => !empty($feature->info['project path']) ? $feature->info['project path'] : '', ); $form['advanced']['generate'] = array( '#type' => 'submit', '#value' => t('Generate feature'), '#submit' => array('features_export_build_form_submit'), ); } // build the Component Listing panel on the right _features_export_form_components($form, $form_state); $form['advanced']['info-preview'] = array( '#type' => 'button', '#value' => t('Preview .info file'), '#ajax' => array( 'callback' => 'features_info_file_preview', 'wrapper' => 'features-export-wrapper', ), ); //Info dialog $form['advanced']['info-file'] = array( '#prefix' => '
', 'text' => array( '#type' => 'textarea', '#default_value' => '', '#resizable' => FALSE, ), '#suffix' => '
', ); $form['buttons'] = array( '#theme' => 'features_form_buttons', '#tree' => FALSE, '#weight' => 99, '#prefix' => "
", '#suffix' => '
', ); $form['buttons']['submit'] = array( '#type' => 'submit', '#value' => t('Download feature'), '#weight' => 10, '#submit' => array('features_export_build_form_submit'), ); $form['#attached']['library'][] = array('system', 'ui.dialog'); return $form; } /** * Return the render array elements for the Components selection on the Export form * @param array $feature - feature associative array * @param array $components - array of components in feature */ function _features_export_form_components(&$form, &$form_state) { global $features_ignore_conflicts; drupal_add_css(drupal_get_path('module', 'features') . '/features.css'); drupal_add_js(drupal_get_path('module', 'features') . '/features.js'); $feature = $form['#feature']; // keep the allow_conflict variable around in the session if (isset($form_state['values']['features_allow_conflicts'])) { $_SESSION['features_allow_conflicts'] = $form_state['values']['features_allow_conflicts']; $features_ignore_conflicts = $_SESSION['features_allow_conflicts']; } $form['export'] = array( '#type' => 'fieldset', '#title' => t('Components'), '#description' => t('Expand each component section and select which items should be included in this feature export.'), '#tree' => FALSE, '#prefix' => "
", '#suffix' => '
', '#collapsible' => FALSE, '#collapsed' => FALSE, '#weight' => 1, ); // filter field used in javascript, so javascript will unhide it $form['export']['features_filter_wrapper'] = array( '#type' => 'fieldset', '#title' => t('Filters'), '#tree' => FALSE, '#prefix' => "
", '#suffix' => '
', '#collapsible' => FALSE, '#collapsed' => FALSE, '#weight' => -10, ); $form['export']['features_filter_wrapper']['features_filter'] = array( '#type' => 'textfield', '#title' => t('Search'), '#hidden' => TRUE, '#default_value' => '', '#suffix' => "". t('Clear') ."", ); $form['export']['features_filter_wrapper']['checkall'] = array( '#type' => 'checkbox', '#default_value' => FALSE, '#hidden' => TRUE, '#title' => t('Select all'), '#attributes' => array( 'class' => array('features-checkall'), ) ); $form['advanced']['features_autodetect_wrapper'] = array( '#type' => 'fieldset', '#tree' => FALSE, '#prefix' => "
", '#suffix' => '
', '#collapsible' => FALSE, '#collapsed' => FALSE, ); $form['advanced']['features_autodetect_wrapper']['autodetect'] = array( '#title' => t('Add auto-detected dependencies'), '#type' => 'checkbox', '#default_value' => !empty($feature->info['no autodetect']) ? FALSE : TRUE, ); // this refresh button will rebuild the form. // this button is hidden by javascript since it is only needed when // javascript is not available $form['advanced']['features_autodetect_wrapper']['features_refresh'] = array( '#type' => 'submit', '#value' => t('Refresh'), '#name' => 'features-refresh', '#attributes' => array( 'title' => t("Refresh the list of auto-detected items."), 'class' => array('features-refresh-button'), ), '#submit' => array('features_export_form_rebuild'), '#prefix' => "
", '#suffix' => "
", '#ajax' => array( 'callback' => 'features_export_form_ajax', 'wrapper' => 'features-export-wrapper', ), ); // generate the export array for the current feature and user selections $export = _features_export_build($feature, $form_state); $form['advanced']['features_allow_conflicts'] = array( '#title' => t('Allow conflicts to be added'), '#type' => 'checkbox', '#default_value' => $features_ignore_conflicts, '#ajax' => array( 'callback' => 'features_export_form_ajax', 'wrapper' => 'features-export-wrapper', ), ); if (isset($form_state['values']['op']) && ($form_state['values']['op'] == $form_state['values']['info-preview'])) { // handle clicking Preview button module_load_include('inc', 'features', 'features.export'); $feature_export = _features_export_generate($export, $form_state, $feature); $feature_export = features_export_prepare($feature_export, $feature->name, TRUE); $info = features_export_info($feature_export); drupal_add_js(array('features' => array('info' => $info)), 'setting'); } // determine any components that are deprecated $deprecated = features_get_deprecated($export['components']); $sections = array('included', 'detected', 'added'); foreach ($export['components'] as $component => $component_info) { if (!variable_get('features_admin_show_component_' . $component, TRUE)) { continue; } $component_items_count = count($component_info['options']['sources']); $count_label = ' (' . $component_items_count . ')'; $label = (isset($component_info['name']) ? $component_info['name'] . $count_label . " (" . check_plain($component) . ")" : check_plain($component) . $count_label); $count = 0; foreach ($sections as $section) { $count += count($component_info['options'][$section]); } $extra_class = ($count == 0) ? 'features-export-empty' : ''; $component_name = str_replace('_', '-', check_plain($component)); if ($count + $component_items_count > 0) { if (!empty($deprecated[$component])) { // only show deprecated component if it has some exports if (!empty($component_info['options']['included'])) { $form['export'][$component] = array( '#markup' => '', '#tree' => TRUE, ); $form['export'][$component]['deprecated'] = array( '#type' => 'fieldset', '#title' => $label . " (" . t('DEPRECATED') . ")", '#tree' => TRUE, '#collapsible' => TRUE, '#collapsed' => TRUE, '#attributes' => array('class' => array('features-export-component')), ); $list = ' '; foreach ($component_info['options']['included'] as $key) { $list .= "$key"; } $form['export'][$component]['deprecated']['selected'] = array( '#prefix' => "
", '#markup' => $list, '#suffix' => "
", ); } } else { $form['export'][$component] = array( '#markup' => '', '#tree' => TRUE, ); $form['export'][$component]['sources'] = array( '#type' => 'fieldset', '#title' => $label, '#tree' => TRUE, '#collapsible' => TRUE, '#collapsed' => TRUE, '#attributes' => array('class' => array('features-export-component')), '#prefix' => "
", ); $form['export'][$component]['sources']['selected'] = array( '#type' => 'checkboxes', '#id' => "edit-sources-$component_name", '#options' => features_dom_encode_options($component_info['options']['sources']), '#default_value' => features_dom_encode_options($component_info['selected']['sources'], FALSE), '#attributes' => array( 'class' => array('component-select'), ), ); foreach ($sections as $section) { $form['export'][$component][$section] = array( '#type' => 'checkboxes', '#options' => !empty($component_info['options'][$section]) ? features_dom_encode_options($component_info['options'][$section]) : array(), '#default_value' => !empty($component_info['selected'][$section]) ? features_dom_encode_options($component_info['selected'][$section], FALSE) : array(), '#attributes' => array('class' => array('component-' . $section)), ); } $form['export'][$component][$sections[0]]['#prefix'] = "
"; $form['export'][$component][$sections[count($sections)-1]]['#suffix'] = '
'; } } } $form['export']['features_legend'] = array( '#type' => 'fieldset', '#title' => t('Legend'), '#tree' => FALSE, '#prefix' => "
", '#suffix' => '
', '#collapsible' => FALSE, '#collapsed' => FALSE, ); $form['export']['features_legend']['legend'] = array( '#markup' => "Normal " . "Changed " . "Auto detected " . "Conflict ", ); } /** * Return the full feature export array based upon user selections in form_state * @param array $feature Feature array to be exported * @param array $form_state Optional form_state information for user selections * can be updated to reflect new selection status * @return array New export array to be exported * array['components'][$component_name] = $component_info * $component_info['options'][$section] is list of available options * $component_info['selected'][$section] is option state TRUE/FALSE * $section = array('sources', included', 'detected', 'added') * sources - options that are available to be added to the feature * included - options that have been previously exported to the feature * detected - options that have been auto-detected * added - newly added options to the feature * * NOTE: This routine gets a bit complex to handle all of the different possible * user checkbox selections and de-selections. * Cases to test: * 1a) uncheck Included item -> mark as Added but unchecked * 1b) re-check unchecked Added item -> return it to Included check item * 2a) check Sources item -> mark as Added and checked * 2b) uncheck Added item -> return it to Sources as unchecked * 3a) uncheck Included item that still exists as auto-detect -> mark as Detected but unchecked * 3b) re-check Detected item -> return it to Included and checked * 4a) check Sources item should also add any auto-detect items as Detected and checked * 4b) uncheck Sources item with auto-detect and auto-detect items should return to Sources and unchecked * 5a) uncheck a Detected item -> refreshing page should keep it as unchecked Detected * 6) when nothing changes, refresh should not change any state * 7) should never see an unchecked Included item */ function _features_export_build($feature, &$form_state) { global $features_ignore_conflicts; // set a global to effect features_get_component_map when building feature // hate to use a global, but it's just for an admin screen so probably ok if (isset($_SESSION['features_allow_conflicts'])) { $features_ignore_conflicts = $_SESSION['features_allow_conflicts']; } $feature_name = isset($feature->name) ? $feature->name : NULL; $conflicts = _features_get_used($feature_name); $reset = FALSE; if (isset($form_state['triggering_element']['#name']) && ($form_state['triggering_element']['#name'] == 'features_allow_conflicts')) { // when clicking the Allow Conflicts button, reset the feature back to it's original state $reset = TRUE; } module_load_include('inc', 'features', 'features.export'); features_include(); $components = features_get_components(); uasort($components, 'features_compare_component_name'); // Assemble the combined component list $stub = array(); $sections = array('sources', 'included', 'detected', 'added'); // create a new feature "stub" to populate $stub_count = array(); foreach ($components as $component => $component_info) { if ($reset) { unset($form_state['values'][$component]); } if (!variable_get('features_admin_show_component_' . $component, TRUE)) { unset($components[$component]); continue; } // User-selected components take precedence. $stub[$component] = array(); $stub_count[$component] = 0; // add selected items from Sources checkboxes if (!empty($form_state['values'][$component]['sources']['selected'])) { $stub[$component] = array_merge($stub[$component], features_dom_decode_options(array_filter($form_state['values'][$component]['sources']['selected']))); $stub_count[$component]++; } // add selected items from already Included and newly Added checkboxes foreach (array('included', 'added') as $section) { if (!empty($form_state['values'][$component][$section])) { $stub[$component] = array_merge($stub[$component], features_dom_decode_options(array_filter($form_state['values'][$component][$section]))); $stub_count[$component]++; } } // count any detected items if (!empty($form_state['values'][$component]['detected'])) { $stub_count[$component]++; } // Only fallback to an existing feature's values if there are no export options for the component. if ($component == 'dependencies') { if (($stub_count[$component] == 0) && !empty($feature->info['dependencies'])) { $stub[$component] = drupal_map_assoc($feature->info['dependencies']); } } elseif (($stub_count[$component] == 0) && !empty($feature->info['features'][$component])) { $stub[$component] = drupal_map_assoc($feature->info['features'][$component]); } } // Generate new populated feature $export = features_populate(array('features' => $stub, 'dependencies' => $stub['dependencies']), $feature_name); // Components that are already exported to feature $exported_features_info = !empty($feature->info['features']) ? $feature->info['features'] : array(); $exported_features_info['dependencies'] = !empty($feature->info['dependencies']) ? $feature->info['dependencies'] : array(); // Components that should be exported $new_features_info = !empty($export['features']) ? $export['features'] : array(); $new_features_info['dependencies'] = !empty($export['dependencies']) ? $export['dependencies'] : array(); $excluded = !empty($feature->info['features_exclude']) ? $feature->info['features_exclude'] : array(); // now fill the $export with categorized sections of component options // based upon user selections and de-selections foreach ($components as $component => $component_info) { $component_export = $component_info; foreach ($sections as $section) { $component_export['options'][$section] = array(); $component_export['selected'][$section] = array(); } $options = features_invoke($component, 'features_export_options'); if (!empty($options)) { $exported_components = !empty($exported_features_info[$component]) ? $exported_features_info[$component] : array(); $new_components = !empty($new_features_info[$component]) ? $new_features_info[$component] : array(); // Find all default components that are not provided by this feature and // strip them out of the possible options. if ($map = features_get_default_map($component)) { foreach ($map as $k => $v) { if (isset($options[$k]) && (!isset($feature->name) || $v !== $feature->name)) { unset($options[$k]); } } } foreach ($options as $key => $value) { // use the $clean_key when accessing $form_state $clean_key = features_dom_encode($key); // if checkbox in Sources is checked, move it to Added section if (!empty($form_state['values'][$component]['sources']['selected'][$clean_key])) { unset($form_state['input'][$component]['sources']['selected'][$clean_key]); $form_state['values'][$component]['sources']['selected'][$clean_key] = FALSE; $form_state['values'][$component]['added'][$clean_key] = 1; $form_state['input'][$component]['added'][$clean_key] = $clean_key; $component_export['options']['added'][$key] = check_plain($value); $component_export['selected']['added'][$key] = $key; } elseif (in_array($key, $new_components)) { // option is in the New exported array if (in_array($key, $exported_components)) { // option was already previously exported // so it's part of the Included checkboxes $section = 'included'; $default_value = $key; if ($reset) { // leave it included } // if Included item was un-selected (removed from export $stub) // but was re-detected in the $new_components // means it was an auto-detect that was previously part of the export // and is now de-selected in UI elseif (!empty($form_state['values']) && (isset($form_state['values'][$component]['included'][$clean_key]) || empty($form_state['values'][$component]['detected'][$clean_key])) && empty($stub[$component][$key])) { $section = 'detected'; $default_value = FALSE; } // unless it's unchecked in the form, then move it to Newly disabled item elseif (!empty($form_state['values']) && empty($form_state['values'][$component]['added'][$clean_key]) && empty($form_state['values'][$component]['detected'][$clean_key]) && empty($form_state['values'][$component]['included'][$clean_key])) { $section = 'added'; $default_value = FALSE; } } else { // option was in New exported array, but NOT in already exported // so it's a user-selected or an auto-detect item $section = 'detected'; // check for item explicity excluded if (isset($excluded[$component][$key]) && !isset($form_state['values'][$component]['detected'][$clean_key])) { $default_value = FALSE; } else { $default_value = $key; } // if it's already checked in Added or Sources, leave it in Added as checked if (!empty($form_state['values']) && (!empty($form_state['values'][$component]['added'][$clean_key]) || !empty($form_state['values'][$component]['sources']['selected'][$clean_key]))) { $section = 'added'; $default_value = $key; } // if it's already been unchecked, leave it unchecked elseif (!empty($form_state['values']) && empty($form_state['values'][$component]['sources']['selected'][$clean_key]) && empty($form_state['values'][$component]['detected'][$clean_key]) && !isset($form_state['values'][$component]['added'][$clean_key])) { $section = 'detected'; $default_value = FALSE; } } $component_export['options'][$section][$key] = check_plain($value); $component_export['selected'][$section][$key] = $default_value; // save which dependencies are specifically excluded from auto-detection if (($section == 'detected') && ($default_value === FALSE)) { $excluded[$component][$key] = $key; // remove excluded item from export if ($component == 'dependencies') { unset($export['dependencies'][$key]); } else { unset($export['features'][$component][$key]); } } else { unset($excluded[$component][$key]); } // remove the 'input' and set the 'values' so Drupal stops looking at 'input' if (isset($form_state['values'])) { if (!$default_value) { unset($form_state['input'][$component][$section][$clean_key]); $form_state['values'][$component][$section][$clean_key] = FALSE; } else { $form_state['input'][$component][$section][$clean_key] = $clean_key; $form_state['values'][$component][$section][$clean_key] = 1; } } } else { // option was not part of the new export $added = FALSE; foreach (array('included', 'added') as $section) { // restore any user-selected checkboxes if (!empty($form_state['values'][$component][$section][$clean_key])) { $component_export['options'][$section][$key] = check_plain($value); $component_export['selected'][$section][$key] = $key; $added = TRUE; } } if (!$added) { // if not Included or Added, then put it back in the unchecked Sources checkboxes $component_export['options']['sources'][$key] = check_plain($value); $component_export['selected']['sources'][$key] = FALSE; } } } } $export['components'][$component] = $component_export; } $export['features_exclude'] = $excluded; // make excluded list and conflicts available for javascript to pass to our ajax callback drupal_add_js(array('features' => array( 'excluded' => $excluded, 'conflicts' => $conflicts, )), 'setting'); return $export; } /** * AJAX callback for features_export_form. */ function features_export_form_ajax($form, &$form_state) { return $form['export']; } /** * Tells the ajax form submission to rebuild form state. */ function features_export_form_rebuild($form, &$form_state) { $form_state['rebuild'] = TRUE; } function features_export_components_json($feature_name) { module_load_include('inc', 'features', 'features.export'); $export = array(); if (!empty($_POST['items'])) { $excluded = (!empty($_POST['excluded'])) ? $_POST['excluded'] : array(); $stub = array(); foreach ($_POST['items'] as $key) { preg_match('/^([^\[]+)(\[.+\])?\[(.+)\]\[(.+)\]$/', $key, $matches); if (!empty($matches[1]) && !empty($matches[4])) { $component = $matches[1]; $item = features_dom_decode($matches[4]); if (empty($stub[$component])) { $stub[$component] = array($item); } else { $stub[$component] = array_merge($stub[$component], array($item)); } } } $stub['dependencies'] = isset($stub['dependencies']) ? $stub['dependencies'] : array(); $export = features_populate(array('features' => $stub, 'dependencies' => $stub['dependencies']), $feature_name); $export['features']['dependencies'] = $export['dependencies']; // uncheck any detected item that is in the excluded list foreach ($export['features'] as $component => $value) { foreach ($value as $key => $item) { $clean_key = features_dom_encode($key); if ($key != $clean_key) { // need to move key to a cleankey for javascript $export['features'][$component][$clean_key] = $export['features'][$component][$key]; unset($export['features'][$component][$key]); } if (isset($excluded[$component][$key])) { $export['features'][$component][$clean_key] = FALSE; } } } } print drupal_json_encode($export['features']); } /** * AJAX callback to get .info file preview. */ function features_info_file_preview($form, &$form_state){ return $form['export']; } /** * Render API callback: Validates a project field. * * This function is assigned as an #element_validate callback in * features_export_form(). */ function features_export_form_validate_field($element, &$form_state) { switch ($element['#name']) { case 'module_name': if (!preg_match('!^[a-z0-9_]+$!', $element['#value'])) { form_error($element, t('The machine-readable name must contain only lowercase letters, numbers, and underscores.')); } // If user is filling out the feature name for the first time and uses // the name of an existing module throw an error. else if (empty($element['#default_value']) && features_get_info('module', $element['#value'])) { form_error($element, t('A module by the name @name already exists on your site. Please choose a different name.', array('@name' => $element['#value']))); } break; case 'project_status_url': if (!empty($element['#value']) && !valid_url($element['#value'])) { 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']))); } break; case 'version': preg_match('/^(?P\d+\.x)-(?P\d+)\.(?P\d+)-?(?P\w+)?$/', $element['#value'], $matches); if (!empty($element['#value']) && !isset($matches['core'], $matches['major'])) { form_error($element, t('Please enter a valid version with core and major version number. Example: @example', array('@example' => '7.x-1.0'))); }; break; } } /** * Return the $export array to be rendered for the feature export */ function _features_export_generate($export, $form_state, $feature = NULL) { unset($export['components']); // remove the UI data that we are not saving to disk $module_name = $form_state['values']['module_name']; // Directly copy the following attributes from form_state $attr = array('name', 'description', 'package', 'project path'); foreach ($attr as $key) { $export[$key] = isset($form_state['values'][$key]) ? $form_state['values'][$key] : NULL; } // Directly copy the following attributes from the original feature $attr = array('scripts' , 'stylesheets'); foreach ($attr as $key) { $export[$key] = isset($feature->info[$key]) ? $feature->info[$key] : NULL; } // If either update status-related keys are provided, add a project key // corresponding to the module name. if (!empty($form_state['values']['version']) || !empty($form_state['values']['project_status_url'])) { $export['project'] = $form_state['values']['module_name']; } if (!empty($form_state['values']['version'])) { $export['version'] = $form_state['values']['version']; } if (!empty($form_state['values']['project_status_url'])) { $export['project status url'] = $form_state['values']['project_status_url']; } $export['no autodetect'] = empty($form_state['values']['autodetect']) ? 1 : NULL; $export['project path'] = !empty($form_state['values']['generate_path']) ? $form_state['values']['generate_path'] : NULL; return $export; } /** * Form submission handler for features_export_form(). */ function features_export_build_form_submit($form, &$form_state) { $feature = $form['#feature']; $export = _features_export_build($feature, $form_state); $export = _features_export_generate($export, $form_state, $feature); $generate = ($form_state['values']['op'] == $form_state['values']['generate']); $module_name = $form_state['values']['module_name']; if ($generate && !user_access('generate features')) { drupal_set_message(t("No permission for generating features.")); return; } // Generate download if ($files = features_export_render($export, $module_name, TRUE)) { $filename = (!empty($export['version']) ? "{$module_name}-{$export['version']}" : $module_name) . '.tar'; if ($generate) { $success = TRUE; $destination = variable_get('features_default_export_path', FEATURES_DEFAULT_EXPORT_PATH); $directory = (!empty($export['project path'])) ? $export['project path'] . '/' . $module_name : (isset($feature->filename) ? dirname($feature->filename) : $destination . '/' . $module_name); if (!is_dir($directory)) { if (mkdir($directory, 0777, true) === FALSE) { $success = FALSE; } } } else { // Clear out output buffer to remove any garbage from tar output. if (ob_get_level()) { ob_end_clean(); } drupal_add_http_header('Content-type', 'application/x-tar'); drupal_add_http_header('Content-Disposition', 'attachment; filename="'. $filename .'"'); drupal_send_headers(); } $tar = array(); $filenames = array(); foreach ($files as $extension => $file_contents) { if (!in_array($extension, array('module', 'info'))) { $extension .= '.inc'; } $filenames[] = "{$module_name}.$extension"; if ($generate) { if (file_put_contents("{$directory}/{$module_name}.$extension", $file_contents) === FALSE) { $success = FALSE; } } else { print features_tar_create("{$module_name}/{$module_name}.$extension", $file_contents); } } if (features_get_modules($module_name, TRUE)) { // prevent deprecated component files from being included in download $deprecated = features_get_deprecated(); foreach ($deprecated as $component) { $info = features_get_components($component); $filename = isset($info['default_file']) && $info['default_file'] == FEATURES_DEFAULTS_CUSTOM ? $info['default_filename'] : "features.{$component}"; $filename .= '.inc'; $filenames[] = "{$module_name}.$filename"; } $module_path = drupal_get_path('module', $module_name); // file_scan_directory() can throw warnings when using PHP 5.3, messing // up the output of our file stream. Suppress errors in this one case in // order to produce valid output. foreach (@file_scan_directory($module_path, '/.*/') as $file) { $filename = substr($file->uri, strlen($module_path) + 1); if (!in_array($filename, $filenames)) { // Add this file. $contents = file_get_contents($file->uri); if ($generate) { if (file_put_contents("{$directory}/{$filename}", $contents) === FALSE) { $success = FALSE; } } else { print features_tar_create("{$module_name}/{$filename}", $contents); } unset($contents); } } } if ($generate) { if ($success) { drupal_set_message(t("Module @name written to @directory", array('@name' => $export['name'], '@directory' => $directory))); } else { drupal_set_message( t("Could not write module to @path. ", array('@path' => $directory)) . t("Ensure your file permissions allow the web server to write to that directory."), "error"); } } else { print pack("a1024",""); exit; } } } /** * array_filter() callback for excluding hidden modules. */ function features_filter_hidden($module) { return empty($module->info['hidden']); } /** * Form constructor for the features configuration form. */ function features_admin_form($form, $form_state) { // Load export functions to use in comparison. module_load_include('inc', 'features', 'features.export'); // Clear & rebuild key caches features_get_info(NULL, NULL, TRUE); features_rebuild(); $modules = array_filter(features_get_modules(), 'features_filter_hidden'); $features = array_filter(features_get_features(), 'features_filter_hidden'); $conflicts = features_get_conflicts(); foreach ($modules as $key => $module) { if ($module->status && !empty($module->info['dependencies'])) { foreach ($module->info['dependencies'] as $dependent) { if (isset($features[$dependent])) { $features[$dependent]->dependents[$key] = $module->info['name']; } } } } if ( empty($features) ) { $form['no_features'] = array( '#markup' => t('No Features were found. Please use the !create_link link to create a new Feature module, or upload an existing Feature to your modules directory.', array('!create_link' => l(t('Create Feature'), 'admin/structure/features/create'))), ); return $form ; } $form = array('#features' => $features); // Generate features form. Features are sorted by dependencies, resort alpha ksort($features); foreach ($features as $name => $module) { $package_title = !empty($module->info['package']) ? $module->info['package'] : t('Other'); $package = strtolower(preg_replace('/[^a-zA-Z0-9-]+/', '-', $package_title)); // Set up package elements if (!isset($form[$package])) { $form[$package] = array( '#tree' => FALSE, '#title' => check_plain($package_title), '#theme' => 'features_form_package', '#type' => 'fieldset', '#group' => 'packages', ); $form[$package]['links'] = $form[$package]['version'] = $form[$package]['weight'] = $form[$package]['status'] = $form[$package]['action'] = array('#tree' => TRUE); } $disabled = FALSE; $description = isset($module->info['description']) ? check_plain($module->info['description']) : ''; // Detect unmet dependencies if (!empty($module->info['dependencies'])) { $unmet_dependencies = array(); $dependencies = _features_export_maximize_dependencies($module->info['dependencies']); foreach ($dependencies as $dependency) { if (empty($modules[$dependency])) { $unmet_dependencies[] = theme('features_module_status', array('status' => FEATURES_MODULE_MISSING, 'module' => $dependency)); } } if (!empty($unmet_dependencies)) { $description .= "
" . t('Unmet dependencies: !dependencies', array('!dependencies' => implode(', ', $unmet_dependencies))) . "
"; $disabled = TRUE; } } if (!empty($module->dependents)) { $disabled = TRUE; $description .= "
". t('Required by: !dependents', array('!dependents' => implode(', ', $module->dependents))) ."
"; } // Detect potential conflicts if (!empty($conflicts[$name])) { $module_conflicts = array(); foreach ($conflicts[$name] as $conflict => $components) { $component_strings = array(); foreach ($components as $component => $component_conflicts) { $component_strings[] = t('@component [@items]', array('@component' => $component, '@items' => implode(', ', $component_conflicts))); } $component_strings = implode(', ', $component_strings); // If conflicting module is disabled, indicate so in feature listing $status = !module_exists($conflict) ? FEATURES_MODULE_DISABLED : FEATURES_MODULE_CONFLICT; $module_conflicts[] = theme('features_module_status', array('status' => $status, 'module' => $conflict)) . t(' in ') . $component_strings; // Only disable modules with conflicts if they are not already enabled. // If they are already enabled, somehow the user got themselves into a // bad situation and they need to be able to disable a conflicted module. if (module_exists($conflict) && !module_exists($name)) { $disabled = TRUE; } } $description .= "
". t('Conflicts with: !conflicts', array('!conflicts' => implode(', ', $module_conflicts))) ."
"; } $href = "admin/structure/features/{$name}"; $module_name = (user_access('administer features')) ? l($module->info['name'], $href) : $module->info['name']; $form[$package]['status'][$name] = array( '#type' => 'checkbox', '#title' => $module_name, '#description' => $description, '#default_value' => $module->status, '#disabled' => $disabled, ); if (!empty($module->info['project status url'])) { $uri = l(truncate_utf8($module->info['project status url'], 35, TRUE, TRUE), $module->info['project status url']); } else if (isset($module->info['project'], $module->info['version'], $module->info['datestamp'])) { $uri = l('http://drupal.org', 'http://drupal.org/project/' . $module->info['project']); } else { $uri = t('Unavailable'); } $version = !empty($module->info['version']) ? $module->info['version'] : ''; $version = !empty($version) ? "
$version
" : ''; $form[$package]['sign'][$name] = array('#markup' => "{$uri} {$version}"); if (user_access('administer features')) { // Add status link if ($module->status) { $state = theme('features_storage_link', array('storage' => FEATURES_CHECKING, 'path' => $href)); $state .= l(t('Check'), "admin/structure/features/{$name}/status", array('attributes' => array('class' => array('admin-check')))); $state .= theme('features_storage_link', array('storage' => FEATURES_REBUILDING, 'path' => $href)); $state .= theme('features_storage_link', array('storage' => FEATURES_NEEDS_REVIEW, 'path' => $href)); $state .= theme('features_storage_link', array('storage' => FEATURES_OVERRIDDEN, 'path' => $href)); $state .= theme('features_storage_link', array('storage' => FEATURES_DEFAULT, 'path' => $href)); } elseif (!empty($conflicts[$name])) { $state = theme('features_storage_link', array('storage' => FEATURES_CONFLICT, 'path' => $href)); } else { $state = theme('features_storage_link', array('storage' => FEATURES_DISABLED, 'path' => $href)); } $form[$package]['state'][$name] = array( '#markup' => !empty($state) ? $state : '', ); // Add in recreate link $form[$package]['actions'][$name] = array( '#markup' => l(t('Recreate'), "admin/structure/features/{$name}/recreate", array('attributes' => array('class' => array('admin-update')))), ); } } ksort($form); // As of 7.0 beta 2 it matters where the "vertical_tabs" element lives on the // the array. We add it late, but at the beginning of the array because that // keeps us away from trouble. $form = array('packages' => array('#type' => 'vertical_tabs')) + $form; $form['buttons'] = array( '#theme' => 'features_form_buttons', ); $form['buttons']['submit'] = array( '#type' => 'submit', '#value' => t('Save settings'), '#submit' => array('features_form_submit'), '#validate' => array('features_form_validate'), ); return $form; } /** * Display the components of a feature. */ function features_admin_components($form, $form_state, $feature) { // Breadcrumb navigation $breadcrumb[] = l(t('Home'), NULL); $breadcrumb[] = l(t('Administration'), 'admin'); $breadcrumb[] = l(t('Structure'), 'admin/structure'); $breadcrumb[] = l(t('Features'), 'admin/structure/features'); drupal_set_breadcrumb($breadcrumb); module_load_include('inc', 'features', 'features.export'); $form = array(); // Store feature info for theme layer. $form['module'] = array('#type' => 'value', '#value' => $feature->name); $form['#info'] = $feature->info; $form['#dependencies'] = array(); if (!empty($feature->info['dependencies'])) { foreach ($feature->info['dependencies'] as $dependency) { $parsed_dependency = drupal_parse_dependency($dependency); $dependency = $parsed_dependency['name']; $status = features_get_module_status($dependency); $form['#dependencies'][$dependency] = $status; } } $conflicts = features_get_conflicts(); if (!module_exists($form['module']['#value']) && isset($form['module']['#value']) && !empty($conflicts[$form['module']['#value']])) { $module_conflicts = $conflicts[$form['module']['#value']]; $conflicts = array(); foreach ($module_conflicts as $conflict) { $conflicts = array_merge_recursive($conflict, $conflicts); } } else { $conflicts = array(); } $form['#conflicts'] = $conflicts; $review = $revert = FALSE; // Iterate over components and retrieve status for display $states = features_get_component_states(array($feature->name), FALSE); $form['revert']['#tree'] = TRUE; foreach ($feature->info['features'] as $component => $items) { if (user_access('administer features') && array_key_exists($component, $states[$feature->name]) && in_array($states[$feature->name][$component], array(FEATURES_OVERRIDDEN, FEATURES_NEEDS_REVIEW))) { switch ($states[$feature->name][$component]) { case FEATURES_OVERRIDDEN: $revert = TRUE; break; case FEATURES_NEEDS_REVIEW: $review = TRUE; break; } $form['revert'][$component] = array( '#type' => 'checkbox', '#default_value' => FALSE, ); } if (module_exists('diff')) { $diffpath = "admin/structure/features/{$feature->name}/diff/{$component}"; $item = menu_get_item($diffpath); $path = ($item && $item['access']) ? $diffpath : NULL; } else { $path = NULL; } $storage = FEATURES_DEFAULT; if (array_key_exists($component, $states[$feature->name])) { $storage = $states[$feature->name][$component]; } else if (array_key_exists($component, $conflicts)) { $storage = FEATURES_CONFLICT; } $form['components'][$component] = array( '#markup' => theme('features_storage_link', array('storage' => $storage, 'path' => $path)), ); } if ($review || $revert) { $form['buttons'] = array('#theme' => 'features_form_buttons', '#tree' => TRUE); if ($revert || $review) { $form['buttons']['revert'] = array( '#type' => 'submit', '#value' => t('Revert components'), '#submit' => array('features_admin_components_revert'), ); } if ($review) { $form['buttons']['review'] = array( '#type' => 'submit', '#value' => t('Mark as reviewed'), '#submit' => array('features_admin_components_review'), ); } } return $form; } /** * Submit handler for revert form. */ function features_admin_components_revert(&$form, &$form_state) { module_load_include('inc', 'features', 'features.export'); features_include(); $module = $form_state['values']['module']; $revert = array($module => array()); foreach (array_filter($form_state['values']['revert']) as $component => $status) { $revert[$module][] = $component; drupal_set_message(t('Reverted all @component components for @module.', array('@component' => $component, '@module' => $module))); } if (empty($revert[$module])) { drupal_set_message(t('Please select which components to revert.'), 'warning'); } features_revert($revert); $form_state['redirect'] = 'admin/structure/features/' . $module; } /** * Submit handler for revert form. */ function features_admin_components_review(&$form, &$form_state) { module_load_include('inc', 'features', 'features.export'); features_include(); $module = $form_state['values']['module']; $revert = array(); foreach (array_filter($form_state['values']['revert']) as $component => $status) { features_set_signature($module, $component); drupal_set_message(t('All @component components for @module reviewed.', array('@component' => $component, '@module' => $module))); } $form_state['redirect'] = 'admin/structure/features/' . $module; } /** * Validate handler for the 'manage features' form. */ function features_form_validate(&$form, &$form_state) { include_once './includes/install.inc'; $conflicts = features_get_conflicts(); foreach ($form_state['values']['status'] as $module => $status) { if ($status) { if (!empty($conflicts[$module])) { foreach (array_keys($conflicts[$module]) as $conflict) { if (!empty($form_state['values']['status'][$conflict])) { form_set_error('status', t('The feature @module cannot be enabled because it conflicts with @conflict.', array('@module' => $module, '@conflict' => $conflict))); } } } if (!drupal_check_module($module)) { form_set_error('status', t('The feature @module cannot be enabled because it has unmet requirements.', array('@module' => $module))); } } } } /** * Submit handler for the 'manage features' form */ function features_form_submit(&$form, &$form_state) { // Clear drupal caches after enabling a feature. We do this in a separate // page callback rather than as part of the submit handler as some modules // have includes/other directives of importance in hooks that have already // been called in this page load. $form_state['redirect'] = 'admin/structure/features/cleanup/clear'; $features = $form['#features']; if (!empty($features)) { $status = $form_state['values']['status']; $install = array_keys(array_filter($status)); $disable = array_diff(array_keys($status), $install); // Disable first. If there are any features that are disabled that are // dependencies of features that have been queued for install, they will // be re-enabled. module_disable($disable); features_install_modules($install); } } /** * Form for clearing cache after enabling a feature. */ function features_cleanup_form($form, $form_state, $cache_clear = FALSE) { // Clear caches if we're getting a post-submit redirect that requests it. if ($cache_clear) { drupal_flush_all_caches(); // The following functions need to be run because drupal_flush_all_caches() // runs rebuilds in the wrong order. The node type cache is rebuilt *after* // the menu is rebuilt, meaning that the menu tree is stale in certain // circumstances after drupal_flush_all_caches(). We rebuild again. menu_rebuild(); } drupal_goto('admin/structure/features'); } /** * Page callback to display the differences between what's in code and * what is in the db. * * @param $feature * A loaded feature object to display differences for. * @param $component * (optional) Specific component to display differences for. If excluded, all * components are used. * * @return * Themed display of what is different. */ function features_feature_diff($feature, $component = NULL) { drupal_add_css(drupal_get_path('module', 'features') . '/features.css'); module_load_include('inc', 'features', 'features.export'); drupal_set_title($feature->info['name']); $overrides = features_detect_overrides($feature); $output = ''; if (!empty($overrides)) { // Filter overrides down to specified component. if (isset($component) && isset($overrides[$component])) { $overrides = array($component => $overrides[$component]); } module_load_include('inc', 'diff', 'diff.engine'); $formatter = new DrupalDiffFormatter(); $rows = array(); foreach ($overrides as $component => $items) { $rows[] = array(array('data' => $component, 'colspan' => 4, 'header' => TRUE)); $diff = new Diff(explode("\n", $items['default']), explode("\n", $items['normal'])); $rows = array_merge($rows, $formatter->format($diff)); } $header = array( array('data' => t('Default'), 'colspan' => 2), array('data' => t('Overrides'), 'colspan' => 2), ); $output .= theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('class' => array('diff', 'features-diff')))); } else { $output = "
" . t('No changes have been made to this feature.') . "
"; } $output = array('page' => array('#markup' => "
{$output}
")); return $output; } /** * Compare the component names. Used to sort alphabetically. */ function features_compare_component_name($a, $b) { return strcasecmp($a['name'], $b['name']); } /** * Javascript callback that returns the status of a feature. */ function features_feature_status($feature) { module_load_include('inc', 'features', 'features.export'); return drupal_json_output(array('storage' => features_get_storage($feature->name))); } /** * Make a Drupal options array safe for usage with jQuery DOM selectors. * Encodes known bad characters into __[ordinal]__ so that they may be * safely referenced by JS behaviors. */ function features_dom_encode_options($options = array(), $keys_only = TRUE) { $replacements = features_dom_encode_map(); $encoded = array(); foreach ($options as $key => $value) { $encoded[strtr($key, $replacements)] = $keys_only ? $value : strtr($value, $replacements); } return $encoded; } function features_dom_encode($key) { $replacements = features_dom_encode_map(); return strtr($key, $replacements); } function features_dom_decode($key) { $replacements = array_flip(features_dom_encode_map()); return strtr($key, $replacements); } /** * Decode an array of option values that have been encoded by * features_dom_encode_options(). */ function features_dom_decode_options($options, $keys_only = FALSE) { $replacements = array_flip(features_dom_encode_map()); $encoded = array(); foreach ($options as $key => $value) { $encoded[strtr($key, $replacements)] = $keys_only ? $value : strtr($value, $replacements); } return $encoded; } /** * Returns encoding map for decode and encode options. */ function features_dom_encode_map() { return array( ':' => '__' . ord(':') . '__', '/' => '__' . ord('/') . '__', ',' => '__' . ord(',') . '__', '.' => '__' . ord('.') . '__', '<' => '__' . ord('<') . '__', '>' => '__' . ord('>') . '__', '%' => '__' . ord('%') . '__', ')' => '__' . ord(')') . '__', '(' => '__' . ord('(') . '__', ); } /** * Page callback: Autocomplete field for features package. * * @param $search_string * The char or string that user have written in autocomplete field, * this is the string this function uses for filter. * * @see features_menu() */ function features_autocomplete_packages($search_string) { $matched_packages = array(); //fetch all modules that are features and copy the package name into a new array. foreach (features_get_features(NULL, TRUE) as $value) { if (preg_match('/' . $search_string . '/i', $value->info['package'])) { $matched_packages[$value->info['package']] = $value->info['package']; } } //removes duplicated package, we wont a list of all unique packages. $matched_packages = array_unique($matched_packages); drupal_json_output($matched_packages); } /** * Return a list of all used components/items not matching a given feature module * similar to features_get_conflicts but returns all component items "in use" */ function _features_get_used($module_name = NULL) { global $features_ignore_conflicts; // make sure we turn off the ignore_conflicts global to get full list of used components // hate to use global, but since this is just for an admin screen it's not a real problem $old_value = $features_ignore_conflicts; $features_ignore_conflicts = FALSE; $conflicts = array(); $component_info = features_get_components(); $map = features_get_component_map(); foreach ($map as $type => $components) { // Only check conflicts for components we know about. if (isset($component_info[$type])) { foreach ($components as $component => $modules) { foreach ($modules as $module) { // only for enabled modules if (module_exists($module) && (empty($module_name) || ($module_name != $module))) { if (!isset($conflicts[$module])) { $conflicts[$module] = array(); } $conflicts[$module][$type][] = $component; } } } } } // restore previous value of global $features_ignore_conflicts = $old_value; return $conflicts; }