features.admin.inc in Features 7
Same filename and directory in other branches
@todo.
File
features.admin.incView source
<?php
/**
* @file
* @todo.
*/
/**
* 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()
* @see features_export_build_form_populate()
* @ingroup forms
*/
function features_export_form($form, $form_state, $feature = NULL) {
module_load_include('inc', 'features', 'features.export');
features_include();
$form = array(
'#attributes' => array(
'class' => array(
'features-export-form',
),
),
'#feature' => isset($feature) ? $feature : NULL,
);
$form['info'] = array(
'#type' => 'fieldset',
'#tree' => FALSE,
);
$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') . '<br/>' . t('May only contain lowercase letters, numbers and underscores. <strong>Try to avoid conflicts with the names of existing Drupal projects.</strong>'),
'#required' => TRUE,
'#default_value' => !empty($feature->name) ? $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['info']['project_status_url'] = array(
'#title' => t('URL of update XML'),
'#description' => t('Example: http://mywebsite.com/fserver'),
'#type' => 'textfield',
'#required' => FALSE,
'#default_value' => !empty($feature->info['project status url']) ? $feature->info['project status url'] : '',
'#size' => 30,
'#element_validate' => array(
'features_export_form_validate_field',
),
);
// User-selected feature source components.
$components = features_get_components();
uasort($components, 'features_compare_component_name');
$form['export'] = array(
'#type' => 'fieldset',
'#tree' => FALSE,
'#theme' => 'features_form_export',
);
$form['export']['components'] = array(
'#title' => t('Edit components'),
'#type' => 'select',
'#options' => array(
'------',
),
'#attributes' => array(
'class' => array(
'features-select-components',
),
),
);
$form['export']['sources'] = array(
'#tree' => TRUE,
'#theme' => 'features_form_components',
);
foreach ($components as $component => $component_info) {
$options = features_invoke($component, 'features_export_options');
if ($component === 'dependencies') {
$default_value = !empty($feature->info['dependencies']) ? $feature->info['dependencies'] : array();
}
else {
$default_value = !empty($feature->info['features'][$component]) ? $feature->info['features'][$component] : array();
}
if ($options) {
// 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]);
}
}
}
// Ensure all options are stripped of potentially bad values.
foreach ($options as $k => $v) {
$options[$k] = check_plain($v);
}
$label = isset($component_info['name']) ? $component_info['name'] . ": " . $component : $component;
$form['export']['components']['#options'][$component] = $label;
if (!empty($options)) {
$form['export']['sources'][$component] = array(
'#type' => 'checkboxes',
'#options' => features_dom_encode_options($options),
'#title' => check_plain($component),
'#default_value' => features_dom_encode_options($default_value, FALSE),
'#ajax' => array(
'callback' => 'features_export_build_form_populate',
'wrapper' => 'features-export-contents',
),
);
}
else {
$form['export']['sources'][$component] = array(
'#type' => 'item',
'#title' => check_plain($component),
'#value' => t('All components of this type are exported by other features or modules.'),
);
}
}
}
$form['export']['features'] = array(
'#tree' => TRUE,
'#prefix' => "<div id='features-export-populated'><div id='features-export-contents'>",
'#suffix' => "</div></div>",
'#markup' => !empty($feature->info) ? theme('features_components', array(
'info' => $feature->info,
'sources' => $feature->info['features'],
)) : "<div class='placeholder'></div>",
);
$form['buttons'] = array(
'#theme' => 'features_form_buttons',
'#tree' => FALSE,
);
$form['buttons']['submit'] = array(
'#type' => 'submit',
'#value' => t('Download feature'),
'#weight' => 10,
'#submit' => array(
'features_export_build_form_submit',
),
);
return $form;
}
/**
* 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.'));
}
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<core>\\d+\\.x)-(?P<major>\\d+)\\.(?P<patch>\\d+)-?(?P<extra>\\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' => '6.x-1.0',
)));
}
break;
}
}
/**
* Form submission handler for features_export_form().
*/
function features_export_build_form_submit($form, &$form_state) {
module_load_include('inc', 'features', 'features.export');
features_include();
// Assemble the combined component list
$stub = array();
$components = array_keys(features_get_components());
foreach ($components as $component) {
// User-selected components take precedence.
if (!empty($form_state['values']['sources'][$component])) {
$stub[$component] = features_dom_decode_options(array_filter($form_state['values']['sources'][$component]));
}
else {
if (!empty($form['#feature']->info['features'][$component])) {
$stub[$component] = $form['#feature']->info['features'][$component];
}
}
}
// Generate populated feature
$module_name = $form_state['values']['module_name'];
$export = features_populate($stub, $form_state['values']['sources']['dependencies'], $module_name);
// Directly copy the following attributes
$attr = array(
'name',
'description',
'package',
);
foreach ($attr as $key) {
$export[$key] = isset($form_state['values'][$key]) ? $form_state['values'][$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'];
}
// Generate download
if ($files = features_export_render($export, $module_name, TRUE)) {
$filename = (!empty($export['version']) ? "{$module_name}-{$export['version']}" : $module_name) . '.tar';
// 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}";
print features_tar_create("{$module_name}/{$module_name}.{$extension}", $file_contents);
}
if (features_get_modules($module_name, TRUE)) {
$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);
print features_tar_create("{$module_name}/{$filename}", $contents);
unset($contents);
}
}
}
print pack("a1024", "");
exit;
}
}
/**
* AJAX callback for features_export_form_build().
*/
function features_export_build_form_populate($form, $form_state) {
module_load_include('inc', 'features', 'features.export');
features_include();
$stub = array();
$submitted = $form_state['values'];
// Assemble the combined component list
$components = array_keys(features_get_components());
foreach ($components as $component) {
// User-selected components take precedence.
if (!empty($submitted['sources'][$component])) {
// Validate and set the default value for each selected option. This
foreach ($submitted['sources'][$component] as $key => $value) {
if (isset($form['export']['sources'][$component]['#options'][$key])) {
$form['export']['sources'][$component]['#default_value'][$key] = $value;
}
}
$stub[$component] = features_dom_decode_options(array_filter($submitted['sources'][$component]));
}
else {
if (!empty($form['export']['sources'][$component]) && !empty($form['#feature']->info['features'][$component])) {
$stub[$component] = $form['#feature']->info['features'][$component];
}
}
}
// Assemble dependencies
$dependencies = isset($submitted['sources']['dependencies']) ? $submitted['sources']['dependencies'] : array();
// Generate populated feature
$module_name = isset($form['#feature'], $form['#feature']->name) ? $form['#feature']->name : '';
$export = features_populate($stub, $dependencies, $module_name);
// Render component display
$components_rendered = theme('features_components', array(
'info' => $export,
'sources' => $stub,
));
$form['export']['features']['#markup'] = $components_rendered;
// @TODO: Reimplement this for D7.
// Re-cache form. This ensures that if the form fails to validate, selected
// values are preserved for the user.
// form_set_cache($submitted['form_build_id'], $form, $form_state);
return $form['export']['features'];
}
/**
* 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']) ? $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 .= "<div class='dependencies'>" . t('Unmet dependencies: @dependencies', array(
'@dependencies' => implode(', ', $unmet_dependencies),
)) . "</div>";
$disabled = TRUE;
}
}
if (!empty($module->dependents)) {
$disabled = TRUE;
$description .= "<div class='requirements'>" . t('Required by: @dependents', array(
'@dependents' => implode(', ', $module->dependents),
)) . "</div>";
}
// Detect potential conflicts
if (!empty($conflicts[$name])) {
$module_conflicts = array();
foreach (array_keys($conflicts[$name]) as $conflict) {
// 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,
));
// 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 .= "<div class='conflicts'>" . t('Conflicts with: @conflicts', array(
'@conflicts' => implode(', ', $module_conflicts),
)) . "</div>";
}
$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' => check_plain($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) ? "<div class='description'>{$version}</div>" : '';
$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('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();
foreach (array_filter($form_state['values']['revert']) as $component => $status) {
$revert[$module][] = $component;
drupal_set_message(t('Reverted all <strong>@component</strong> components for <strong>@module</strong>.', array(
'@component' => $component,
'@module' => $module,
)));
}
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 <strong>@component</strong> components for <strong>@module</strong> 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 disabling orphaned dependencies.
*/
function features_cleanup_form($form, $form_state, $cache_clear = FALSE) {
$form = array();
// 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();
}
// Retrieve orphaned modules and provide them as optional modules to be disabled.
// Exclude any modules that have been added to the 'ignored' list.
$options = array();
$orphans = features_get_orphans();
$ignored = variable_get('features_ignored_orphans', array());
if (!empty($orphans)) {
foreach ($orphans as $module) {
if (!in_array($module->name, $ignored, TRUE)) {
$options[$module->name] = check_plain($module->info['name']);
}
}
}
if (!empty($options)) {
$form['orphans'] = array(
'#title' => t('Orphaned dependencies'),
'#description' => t('These modules are dependencies of features that have been disabled. They may be disabled without affecting other components of your website.'),
'#type' => 'checkboxes',
'#options' => $options,
'#default_value' => array_keys($options),
);
$form['buttons'] = array(
'#tree' => TRUE,
'#theme' => 'features_form_buttons',
);
$form['buttons']['disable'] = array(
'#type' => 'submit',
'#value' => t('Disable selected modules'),
'#submit' => array(
'features_cleanup_form_disable',
),
);
$form['buttons']['ignore'] = array(
'#type' => 'submit',
'#value' => t('Leave enabled'),
'#submit' => array(
'features_cleanup_form_ignore',
),
);
}
else {
drupal_goto('admin/structure/features');
}
return $form;
}
/**
* Submit handler for disable action on features_cleanup_form().
*/
function features_cleanup_form_disable(&$form, &$form_state) {
if (!empty($form_state['values']['orphans'])) {
$disable = array_keys(array_filter($form_state['values']['orphans']));
$ignored = array_diff(array_keys($form_state['values']['orphans']), $disable);
// Disable any orphans that have been selected.
module_disable($disable);
drupal_flush_all_caches();
// Add enabled modules to ignored orphans list.
$ignored_orphans = variable_get('features_ignored_orphans', array());
foreach ($ignored as $module) {
$ignored_orphans[$module] = $module;
}
variable_set('features_ignored_orphans', $ignored_orphans);
}
$form_state['redirect'] = 'admin/structure/features/cleanup';
}
/**
* Submit handler for ignore action on features_cleanup_form().
*/
function features_cleanup_form_ignore(&$form, &$form_state) {
if (!empty($form_state['values']['orphans'])) {
$ignored = array_keys($form_state['values']['orphans']);
$ignored_orphans = variable_get('features_ignored_orphans', array());
foreach ($ignored as $module) {
$ignored_orphans[$module] = $module;
}
variable_set('features_ignored_orphans', $ignored_orphans);
}
$form_state['redirect'] = 'admin/structure/features/cleanup';
}
/**
* 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');
$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 = "<div class='features-empty'>" . t('No changes have been made to this feature.') . "</div>";
}
$output = array(
'page' => array(
'#markup' => "<div class='features-comparison'>{$output}</div>",
),
);
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;
}
/**
* 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('>') . '__',
);
}
/**
* 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);
}
Functions
Name | Description |
---|---|
features_admin_components | Display the components of a feature. |
features_admin_components_revert | Submit handler for revert form. |
features_admin_components_review | Submit handler for revert form. |
features_admin_form | Form constructor for the features configuration form. |
features_autocomplete_packages | Page callback: Autocomplete field for features package. |
features_cleanup_form | Form for disabling orphaned dependencies. |
features_cleanup_form_disable | Submit handler for disable action on features_cleanup_form(). |
features_cleanup_form_ignore | Submit handler for ignore action on features_cleanup_form(). |
features_compare_component_name | Compare the component names. Used to sort alphabetically. |
features_dom_decode_options | Decode an array of option values that have been encoded by features_dom_encode_options(). |
features_dom_encode_map | Returns encoding map for decode and encode options. |
features_dom_encode_options | 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. |
features_export_build_form_populate | AJAX callback for features_export_form_build(). |
features_export_build_form_submit | Form submission handler for features_export_form(). |
features_export_form | Form constructor for features export form. |
features_export_form_validate_field | Render API callback: Validates a project field. |
features_feature_diff | Page callback to display the differences between what's in code and what is in the db. |
features_feature_status | Javascript callback that returns the status of a feature. |
features_filter_hidden | array_filter() callback for excluding hidden modules. |
features_form_submit | Submit handler for the 'manage features' form |
features_form_validate | Validate handler for the 'manage features' form. |