123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167 |
- <?php
- /**
- * @param $info - feature info array
- * @param $module_name
- * @return fully populated export array
- */
- function features_populate($info, $module_name) {
- // Sanitize items.
- $items = !empty($info['features']) ? array_filter($info['features']) : array();
- $items['dependencies'] = !empty($info['dependencies']) ? drupal_map_assoc(array_filter($info['dependencies'])) : array();
- // Populate stub
- $stub = array('features' => array(), 'dependencies' => array(), 'conflicts' => array()) + $info + array('features_exclude' => array());
- $export = _features_populate($items, $stub, $module_name, TRUE);
- // Add Features API version. Any module with this entry in the .info file
- // will be treated as a Feature and included in the admin/build/features UI.
- $export['features']['features_api']['api:' . FEATURES_API] = TRUE;
- // Allow other modules to alter the export.
- drupal_alter('features_export', $export, $module_name);
- // Clean up and standardize order
- foreach (array_keys($export['features']) as $k) {
- ksort($export['features'][$k]);
- }
- ksort($export['features']);
- ksort($export['dependencies']);
- ksort($export['features_exclude']);
- return $export;
- }
- /**
- * Iterate and descend into a feature definition to extract module
- * dependencies and feature definition. Calls hook_features_export for modules
- * that implement it.
- *
- * @param $pipe
- * Associative of array of module => info-for-module
- * @param $export
- * Associative array of items, and module dependencies which define a feature.
- * Passed by reference.
- *
- * @return fully populated $export array.
- */
- function _features_populate($pipe, &$export, $module_name = '', $reset = FALSE) {
- // Ensure that the export will be created in the english language.
- $language = _features_export_language();
- if ($reset) {
- drupal_static_reset(__FUNCTION__);
- }
- $processed = &drupal_static(__FUNCTION__, array());
- features_include();
- foreach ($pipe as $component => $data) {
- // Convert already defined items to dependencies.
- // _features_resolve_dependencies($data, $export, $module_name, $component);
- // Remove any excluded items.
- if (!empty($export['features_exclude'][$component])) {
- $data = array_diff($data, $export['features_exclude'][$component]);
- if ($component == 'dependencies' && !empty($export['dependencies'])) {
- $export['dependencies'] = array_diff($export['dependencies'], $export['features_exclude'][$component]);
- }
- }
- if (!empty($data) && $function = features_hook($component, 'features_export')) {
- // Pass module-specific data and export array.
- // We don't use features_invoke() here since we need to pass $export by reference.
- $more = $function($data, $export, $module_name, $component);
- // Add the context information.
- $export['component'] = $component;
- $export['module_name'] = $module_name;
- // Allow other modules to manipulate the pipe to add in additional modules.
- drupal_alter(array('features_pipe', 'features_pipe_' . $component), $more, $data, $export);
- // Remove the component information.
- unset($export['component']);
- unset($export['module_name']);
- // Allow for export functions to request additional exports, but avoid
- // circular references on already processed components.
- $processed[$component] = isset($processed[$component]) ? array_merge($processed[$component], $data) : $data;
- if (!empty($more)) {
- // Remove already processed components.
- foreach ($more as $component_name => $component_data) {
- if (isset($processed[$component_name])) {
- $more[$component_name] = array_diff($component_data, $processed[$component_name]);
- }
- }
- if ($more = array_filter($more)) {
- _features_populate($more, $export, $module_name);
- }
- }
- }
- }
- _features_export_language($language);
- return $export;
- }
- /**
- * Iterates over data and convert to dependencies if already defined elsewhere.
- */
- function _features_resolve_dependencies(&$data, &$export, $module_name, $component) {
- if ($map = features_get_default_map($component)) {
- foreach ($data as $key => $item) {
- // If this node type is provided by a different module, add it as a dependency
- if (isset($map[$item]) && $map[$item] != $module_name) {
- $export['dependencies'][$map[$item]] = $map[$item];
- unset($data[$key]);
- }
- }
- }
- }
- /**
- * Iterates over a list of dependencies and kills modules that are
- * captured by other modules 'higher up'.
- */
- function _features_export_minimize_dependencies($dependencies, $module_name = '') {
- // Ensure that the module doesn't depend upon itself
- if (!empty($module_name) && !empty($dependencies[$module_name])) {
- unset($dependencies[$module_name]);
- }
- // Do some cleanup:
- // - Remove modules required by Drupal core.
- // - Protect against direct circular dependencies.
- // - Remove "intermediate" dependencies.
- $required = drupal_required_modules();
- foreach ($dependencies as $k => $v) {
- if (empty($v) || in_array($v, $required)) {
- unset($dependencies[$k]);
- }
- else {
- $module = features_get_modules($v);
- if ($module && !empty($module->info['dependencies'])) {
- // If this dependency depends on the module itself, we have a circular dependency.
- // Don't let it happen. Only you can prevent forest fires.
- if (in_array($module_name, $module->info['dependencies'])) {
- unset($dependencies[$k]);
- }
- // Iterate through the dependency's dependencies and remove any dependencies
- // that are captured by it.
- else {
- foreach ($module->info['dependencies'] as $j => $dependency) {
- if (array_search($dependency, $dependencies) !== FALSE) {
- $position = array_search($dependency, $dependencies);
- unset($dependencies[$position]);
- }
- }
- }
- }
- }
- }
- return drupal_map_assoc(array_unique($dependencies));
- }
- /**
- * Iterates over a list of dependencies and maximize the list of modules.
- */
- function _features_export_maximize_dependencies($dependencies, $module_name = '', $maximized = array(), $first = TRUE) {
- foreach ($dependencies as $k => $v) {
- $parsed_dependency = drupal_parse_dependency($v);
- $name = $parsed_dependency['name'];
- if (!in_array($name, $maximized)) {
- $maximized[] = $name;
- $module = features_get_modules($name);
- if ($module && !empty($module->info['dependencies'])) {
- $maximized = array_merge($maximized, _features_export_maximize_dependencies($module->info['dependencies'], $module_name, $maximized, FALSE));
- }
- }
- }
- return array_unique($maximized);
- }
- /**
- * Prepare a feature export array into a finalized info array.
- * @param $export
- * An exported feature definition.
- * @param $module_name
- * The name of the module to be exported.
- * @param $reset
- * Boolean flag for resetting the module cache. Only set to true when
- * doing a final export for delivery.
- */
- function features_export_prepare($export, $module_name, $reset = FALSE, $add_deprecated = TRUE) {
- $existing = features_get_modules($module_name, $reset);
- // copy certain exports directly into info
- $copy_list = array('scripts', 'stylesheets');
- foreach ($copy_list as $item) {
- if(isset($export[$item])) {
- $existing->info[$item] = $export[$item];
- }
- }
- // Prepare info string -- if module exists, merge into its existing info file
- $defaults = !empty($existing->info) ? $existing->info : array('core' => '7.x', 'package' => 'Features');
- $export = array_merge($defaults, $export);
- $deprecated = features_get_deprecated();
- // Cleanup info array
- foreach ($export['features'] as $component => $data) {
- // if performing the final export, do not export deprecated components
- if (($reset || !$add_deprecated) && !empty($deprecated[$component])) {
- unset($export['features'][$component]);
- }
- else {
- $export['features'][$component] = array_keys($data);
- }
- }
- if (isset($export['dependencies'])) {
- $export['dependencies'] = array_values($export['dependencies']);
- }
- if (isset($export['conflicts'])) {
- unset($export['conflicts']);
- }
- // Order info array.
- $standard_info = array();
- foreach (array_merge(array('name', 'description', 'core', 'package', 'version', 'project', 'dependencies'), $copy_list) as $item) {
- if (isset($export[$item])) {
- $standard_info[$item] = $export[$item];
- }
- }
- if (isset($export['php']) && ($export['php'] != DRUPAL_MINIMUM_PHP)) {
- $standard_info['php'] = $export['php'];
- }
- unset($export['php']);
- $export = features_array_diff_assoc_recursive($export, $standard_info);
- ksort($export);
- return array_merge($standard_info, $export);
- }
- /**
- * Generate an array of hooks and their raw code.
- */
- function features_export_render_hooks($export, $module_name, $reset = FALSE) {
- features_include();
- $code = array();
- // Sort components to keep exported code consistent
- ksort($export['features']);
- foreach ($export['features'] as $component => $data) {
- if (!empty($data)) {
- // Sort the items so that we don't generate different exports based on order
- asort($data);
- if (features_hook($component, 'features_export_render')) {
- $hooks = features_invoke($component, 'features_export_render', $module_name, $data, $export);
- $code[$component] = $hooks;
- }
- }
- }
- return $code;
- }
- /**
- * Render feature export into an array representing its files.
- *
- * @param $export
- * An exported feature definition.
- * @param $module_name
- * The name of the module to be exported.
- * @param $reset
- * Boolean flag for resetting the module cache. Only set to true when
- * doing a final export for delivery.
- *
- * @return array of info file and module file contents.
- */
- function features_export_render($export, $module_name, $reset = FALSE) {
- $code = array();
- // Generate hook code
- $component_hooks = features_export_render_hooks($export, $module_name, $reset);
- $components = features_get_components();
- $deprecated = features_get_deprecated($components);
- // Group component code into their respective files
- foreach ($component_hooks as $component => $hooks) {
- if ($reset && !empty($deprecated[$component])) {
- // skip deprecated components on final export
- continue;
- }
- $file = array('name' => 'features');
- if (isset($components[$component]['default_file'])) {
- switch ($components[$component]['default_file']) {
- case FEATURES_DEFAULTS_INCLUDED:
- $file['name'] = "features.$component";
- break;
- case FEATURES_DEFAULTS_CUSTOM:
- $file['name'] = $components[$component]['default_filename'];
- break;
- }
- }
- if (!isset($code[$file['name']])) {
- $code[$file['name']] = array();
- }
- foreach ($hooks as $hook_name => $hook_info) {
- // These are purely files that will be copied over.
- if (is_array($hook_info) && (!empty($hook_info['file_path']) || !empty($hook_info['file_content']))) {
- $code['_files'][$hook_name] = $hook_info;
- continue;
- }
- $hook_code = is_array($hook_info) ? $hook_info['code'] : $hook_info;
- $hook_args = is_array($hook_info) && !empty($hook_info['args']) ? $hook_info['args'] : '';
- $hook_file = is_array($hook_info) && !empty($hook_info['file']) ? $hook_info['file'] : $file['name'];
- $code[$hook_file][$hook_name] = features_export_render_defaults($module_name, $hook_name, $hook_code, $hook_args);
- }
- }
- // Finalize strings to be written to files
- $code = array_filter($code);
- foreach ($code as $filename => $contents) {
- if ($filename != '_files') {
- $code[$filename] = "<?php\n/**\n * @file\n * {$module_name}.{$filename}.inc\n */\n\n". implode("\n\n", $contents) ."\n";
- }
- }
- // Allow extra files be added to feature.
- if ($files = module_invoke_all('features_export_files', $module_name, $export)) {
- $code['_files'] = !empty($code['_files']) ? $code['_files'] + $files : $files;
- }
- if (!empty($code['_files'])) {
- drupal_alter('features_export_files', $code['_files'], $module_name, $export);
- }
- // Generate info file output
- $export = features_export_prepare($export, $module_name, $reset);
- $code['info'] = features_export_info($export);
- // Used to create or manipulate the generated .module for features.inc.
- $modulefile_features_inc = "<?php\n/**\n * @file\n * Code for the {$export['name']} feature.\n */\n\ninclude_once '{$module_name}.features.inc';\n";
- $modulefile_blank = "<?php\n/**\n * @file\n * Drupal needs this blank file.\n */\n";
- // Prepare the module
- // If module exists, let it be and include it in the files
- if ($existing = features_get_modules($module_name, TRUE)) {
- $code['module'] = file_get_contents($existing->filename);
- // If the current module file does not reference the features.inc include,
- // @TODO this way of checking does not account for the possibility of inclusion instruction being commented out.
- if (isset($code['features']) && strpos($code['module'], "{$module_name}.features.inc") === FALSE) {
- // If .module does not begin with <?php\n, just add a warning.
- if (strpos($code['module'], "<?php\n") !== 0) {
- features_log(t('@module does not appear to include the @include file.', array('@module' => "{$module_name}.module", '@include' => "{$module_name}.features.inc")), 'warning');
- }
- else {
- // Remove the old message if it exists, else just remove the <?php
- $length = strpos($code['module'], $modulefile_blank) === 0 ? strlen($modulefile_blank) : 6;
- $code['module'] = $modulefile_features_inc . substr($code['module'], $length);
- }
- }
- if ($reset) {
- // only check for deprecated files on final export
- // Deprecated files. Display a message for any of these files letting the
- // user know that they may be removed.
- $deprecated_files = array(
- "{$module_name}.defaults",
- "{$module_name}.features.views",
- "{$module_name}.features.node"
- );
- // add deprecated components
- 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}";
- $deprecated_files[] = "{$module_name}.$filename";
- }
- foreach (file_scan_directory(drupal_get_path('module', $module_name), '/.*/') as $file) {
- if (in_array($file->name, $deprecated_files, TRUE)) {
- features_log(t('The file @filename has been deprecated and can be removed.', array('@filename' => $file->filename)), 'status');
- }
- elseif ($file->name === "{$module_name}.features" && empty($code['features'])) {
- // Try and remove features.inc include.
- if (strpos($code['module'], "{$module_name}.features.inc")) {
- $code['module'] = str_replace($modulefile_features_inc, $modulefile_blank, $code['module']);
- }
- // If unable to remove the include, add a message to remove.
- if (strpos($code['module'], "{$module_name}.features.inc")) {
- $code['features'] = "<?php\n\n// This file is deprecated and can be removed.\n// Please remove include_once('{$module_name}.features.inc') in {$module_name}.module as well.\n";
- }
- else {
- $code['features'] = "<?php\n\n// This file is deprecated and can be removed.\n";
- }
- }
- }
- }
- }
- // Add a stub module to include the defaults
- else if (!empty($code['features'])) {
- $code['module'] = $modulefile_features_inc;
- }
- else {
- $code['module'] = $modulefile_blank;
- }
- return $code;
- }
- /**
- * Detect differences between DB and code components of a feature.
- */
- function features_detect_overrides($module) {
- $cache = &drupal_static(__FUNCTION__, array());
- if (!isset($cache[$module->name])) {
- // Rebuild feature from .info file description and prepare an export from current DB state.
- $export = features_populate($module->info, $module->name);
- $export = features_export_prepare($export, $module->name, FALSE, FALSE);
- $overridden = array();
- // Compare feature info
- features_sanitize($module->info);
- features_sanitize($export);
- $compare = array('normal' => features_export_info($export), 'default' => features_export_info($module->info));
- if ($compare['normal'] !== $compare['default']) {
- $overridden['info'] = $compare;
- }
- // Collect differences at a per-component level
- $states = features_get_component_states(array($module->name), FALSE);
- foreach ($states[$module->name] as $component => $state) {
- if ($state != FEATURES_DEFAULT) {
- $normal = features_get_normal($component, $module->name);
- $default = features_get_default($component, $module->name);
- features_sanitize($normal, $component);
- features_sanitize($default, $component);
- $compare = array('normal' => features_var_export($normal), 'default' => features_var_export($default));
- if (_features_linetrim($compare['normal']) !== _features_linetrim($compare['default'])) {
- $overridden[$component] = $compare;
- }
- }
- }
- $cache[$module->name] = $overridden;
- }
- return $cache[$module->name];
- }
- /**
- * Gets the available default hooks keyed by components.
- */
- function features_get_default_hooks($component = NULL, $reset = FALSE) {
- return features_get_components($component, 'default_hook', $reset);
- }
- /**
- * Gets the available default hooks keyed by components.
- */
- function features_get_default_alter_hook($component) {
- $default_hook = features_get_components($component, 'default_hook');
- $alter_hook = features_get_components($component, 'alter_hook');
- $alter_type = features_get_components($component, 'alter_type');
- return empty($alter_type) || $alter_type != 'none' ? ($alter_hook ? $alter_hook : $default_hook) : FALSE;
- }
- /**
- * Return a code string representing an implementation of a defaults module hook.
- */
- function features_export_render_defaults($module, $hook, $code, $args = '') {
- $output = array();
- $output[] = "/**";
- $output[] = " * Implements hook_{$hook}().";
- $output[] = " */";
- $output[] = "function {$module}_{$hook}(" . $args . ") {";
- $output[] = $code;
- $output[] = "}";
- return implode("\n", $output);
- }
- /**
- * Generate code friendly to the Drupal .info format from a structured array.
- *
- * @param $info
- * An array or single value to put in a module's .info file.
- * @param $parents
- * Array of parent keys (internal use only).
- *
- * @return
- * A code string ready to be written to a module's .info file.
- */
- function features_export_info($info, $parents = array()) {
- $output = '';
- if (is_array($info)) {
- foreach ($info as $k => $v) {
- $child = $parents;
- $child[] = $k;
- $output .= features_export_info($v, $child);
- }
- }
- else if (!empty($info) && count($parents)) {
- $line = array_shift($parents);
- foreach ($parents as $key) {
- $line .= is_numeric($key) ? "[]" : "[{$key}]";
- }
- $line .= " = {$info}\n";
- return $line;
- }
- return $output;
- }
- /**
- * Tar creation function. Written by dmitrig01.
- *
- * @param $name
- * Filename of the file to be tarred.
- * @param $contents
- * String contents of the file.
- *
- * @return
- * A string of the tar file contents.
- */
- function features_tar_create($name, $contents) {
- /* http://www.mkssoftware.com/docs/man4/tar.4.asp */
- /* http://www.phpclasses.org/browse/file/21200.html */
- $tar = '';
- $bigheader = $header = '';
- if (strlen($name) > 100) {
- $bigheader = pack("a100a8a8a8a12a12a8a1a100a6a2a32a32a8a8a155a12",
- '././@LongLink', '0000000', '0000000', '0000000',
- sprintf("%011o", strlen($name)), '00000000000',
- ' ', 'L', '', 'ustar ', '0',
- '', '', '', '', '', '');
- $bigheader .= str_pad($name, floor((strlen($name) + 512 - 1) / 512) * 512, "\0");
- $checksum = 0;
- for ($i = 0; $i < 512; $i++) {
- $checksum += ord(substr($bigheader, $i, 1));
- }
- $bigheader = substr_replace($bigheader, sprintf("%06o", $checksum)."\0 ", 148, 8);
- }
- $header = pack("a100a8a8a8a12a12a8a1a100a6a2a32a32a8a8a155a12", // book the memorie area
- substr($name,0,100), // 0 100 File name
- '100644 ', // File permissions
- ' 765 ', // UID,
- ' 765 ', // GID,
- sprintf("%11s ", decoct(strlen($contents))), // Filesize,
- sprintf("%11s", decoct(REQUEST_TIME)), // Creation time
- ' ', // 148 8 Check sum for header block
- '', // 156 1 Link indicator / ustar Type flag
- '', // 157 100 Name of linked file
- 'ustar ', // 257 6 USTAR indicator "ustar"
- ' ', // 263 2 USTAR version "00"
- '', // 265 32 Owner user name
- '', // 297 32 Owner group name
- '', // 329 8 Device major number
- '', // 337 8 Device minor number
- '', // 345 155 Filename prefix
- ''); // 500 12 ??
- $checksum = 0;
- for ($i = 0; $i < 512; $i++) {
- $checksum += ord(substr($header, $i, 1));
- }
- $header = substr_replace($header, sprintf("%06o", $checksum)."\0 ", 148, 8);
- $tar = $bigheader.$header;
- $buffer = str_split($contents, 512);
- foreach ($buffer as $item) {
- $tar .= pack("a512", $item);
- }
- return $tar;
- }
- /**
- * Export var function -- from Views.
- */
- function features_var_export($var, $prefix = '', $init = TRUE, $count = 0) {
- if ($count > 50) {
- watchdog('features', 'Recursion depth reached in features_var_export', array());
- return '';
- }
- if (is_object($var)) {
- $output = method_exists($var, 'export') ? $var->export() : features_var_export((array) $var, '', FALSE, $count+1);
- }
- else if (is_array($var)) {
- if (empty($var)) {
- $output = 'array()';
- }
- else {
- $output = "array(\n";
- foreach ($var as $key => $value) {
- // Using normal var_export on the key to ensure correct quoting.
- $output .= " " . var_export($key, TRUE) . " => " . features_var_export($value, ' ', FALSE, $count+1) . ",\n";
- }
- $output .= ')';
- }
- }
- else if (is_bool($var)) {
- $output = $var ? 'TRUE' : 'FALSE';
- }
- else if (is_int($var)) {
- $output = intval($var);
- }
- else if (is_numeric($var)) {
- $floatval = floatval($var);
- if (is_string($var) && ((string) $floatval !== $var)) {
- // Do not convert a string to a number if the string
- // representation of that number is not identical to the
- // original value.
- $output = var_export($var, TRUE);
- }
- else {
- $output = $floatval;
- }
- }
- else if (is_string($var) && strpos($var, "\n") !== FALSE) {
- // Replace line breaks in strings with a token for replacement
- // at the very end. This protects whitespace in strings from
- // unintentional indentation.
- $var = str_replace("\n", "***BREAK***", $var);
- $output = var_export($var, TRUE);
- }
- else {
- $output = var_export($var, TRUE);
- }
- if ($prefix) {
- $output = str_replace("\n", "\n$prefix", $output);
- }
- if ($init) {
- $output = str_replace("***BREAK***", "\n", $output);
- }
- return $output;
- }
- /**
- * Helper function to return an array of t()'d translatables strings.
- * Useful for providing a separate array of translatables with your
- * export so that string extractors like potx can detect them.
- */
- function features_translatables_export($translatables, $indent = '') {
- $output = '';
- $translatables = array_filter(array_unique($translatables));
- if (!empty($translatables)) {
- $output .= "{$indent}// Translatables\n";
- $output .= "{$indent}// Included for use with string extractors like potx.\n";
- sort($translatables);
- foreach ($translatables as $string) {
- $output .= "{$indent}t(" . features_var_export($string) . ");\n";
- }
- }
- return $output;
- }
- /**
- * Get a summary storage state for a feature.
- */
- function features_get_storage($module_name) {
- // Get component states, and array_diff against array(FEATURES_DEFAULT).
- // If the returned array has any states that don't match FEATURES_DEFAULT,
- // return the highest state.
- $states = features_get_component_states(array($module_name), FALSE);
- $states = array_diff($states[$module_name], array(FEATURES_DEFAULT));
- $storage = !empty($states) ? max($states) : FEATURES_DEFAULT;
- return $storage;
- }
- /**
- * Wrapper around features_get_[storage] to return an md5hash of a normalized
- * defaults/normal object array. Can be used to compare normal/default states
- * of a module's component.
- */
- function features_get_signature($state = 'default', $module_name, $component, $reset = FALSE) {
- switch ($state) {
- case 'cache':
- $codecache = variable_get('features_codecache', array());
- return isset($codecache[$module_name][$component]) ? $codecache[$module_name][$component] : FALSE;
- case 'default':
- $objects = features_get_default($component, $module_name, TRUE, $reset);
- break;
- case 'normal':
- $objects = features_get_normal($component, $module_name, $reset);
- break;
- }
- if (!empty($objects)) {
- features_sanitize($objects, $component);
- return md5(_features_linetrim(features_var_export($objects)));
- }
- return FALSE;
- }
- /**
- * Set the signature of a module/component pair in the codecache.
- */
- function features_set_signature($module, $component, $signature = NULL) {
- $var_codecache = variable_get('features_codecache', array());
- $signature = isset($signature) ? $signature : features_get_signature('default', $module, $component, TRUE);
- $var_codecache[$module][$component] = $signature;
- variable_set('features_codecache', $var_codecache);
- }
- /**
- * Processing semaphore operations.
- */
- function features_semaphore($op, $component) {
- // Note: we don't use variable_get() here as the inited variable
- // static cache may be stale. Retrieving directly from the DB narrows
- // the possibility of collision.
- $semaphore = db_query("SELECT value FROM {variable} WHERE name = :name", array(':name' => 'features_semaphore'))->fetchField();
- $semaphore = !empty($semaphore) ? unserialize($semaphore) : array();
- switch ($op) {
- case 'get':
- return isset($semaphore[$component]) ? $semaphore[$component] : FALSE;
- case 'set':
- $semaphore[$component] = REQUEST_TIME;
- variable_set('features_semaphore', $semaphore);
- break;
- case 'del':
- if (isset($semaphore[$component])) {
- unset($semaphore[$component]);
- variable_set('features_semaphore', $semaphore);
- }
- break;
- }
- }
- /**
- * Get normal objects for a given module/component pair.
- */
- function features_get_normal($component, $module_name, $reset = FALSE) {
- if ($reset) {
- drupal_static_reset(__FUNCTION__);
- }
- $cache = &drupal_static(__FUNCTION__, array());
- if (!isset($cache[$module_name][$component])) {
- features_include();
- $code = NULL;
- $module = features_get_features($module_name);
- // Special handling for dependencies component.
- if ($component === 'dependencies') {
- $cache[$module_name][$component] = isset($module->info['dependencies']) ? array_filter($module->info['dependencies'], '_features_module_exists') : array();
- }
- // All other components.
- else {
- $default_hook = features_get_default_hooks($component);
- if ($module && $default_hook && isset($module->info['features'][$component]) && features_hook($component, 'features_export_render')) {
- $code = features_invoke($component, 'features_export_render', $module_name, $module->info['features'][$component], NULL);
- $cache[$module_name][$component] = isset($code[$default_hook]) ? eval($code[$default_hook]) : FALSE;
- }
- }
- // Clear out vars for memory's sake.
- unset($code);
- unset($module);
- }
- return isset($cache[$module_name][$component]) ? $cache[$module_name][$component] : FALSE;
- }
- /**
- * Helper function to determine if a module is enabled
- * @param $module
- * This module name comes from the .info file and can have version info in it.
- */
- function _features_module_exists($module) {
- $parsed_dependency = drupal_parse_dependency($module);
- $name = $parsed_dependency['name'];
- return module_exists($name);
- }
- /**
- * Get defaults for a given module/component pair.
- */
- function features_get_default($component, $module_name = NULL, $alter = TRUE, $reset = FALSE) {
- $cache = &drupal_static(__FUNCTION__, array());
- $alter = !empty($alter); // ensure $alter is a true/false boolean
- features_include();
- features_include_defaults($component);
- $default_hook = features_get_default_hooks($component);
- $components = features_get_components();
- // Collect defaults for all modules if no module name was specified.
- if (isset($module_name)) {
- $modules = array($module_name);
- }
- else {
- if ($component === 'dependencies') {
- $modules = array_keys(features_get_features());
- }
- else {
- $modules = array();
- foreach (features_get_component_map($component) as $component_modules) {
- $modules = array_merge($modules, $component_modules);
- }
- $modules = array_unique($modules);
- }
- }
- // Collect and cache information for each specified module.
- foreach ($modules as $m) {
- if (!isset($cache[$component][$alter][$m]) || $reset) {
- // Special handling for dependencies component.
- if ($component === 'dependencies') {
- $module = features_get_features($m);
- $cache[$component][$alter][$m] = isset($module->info['dependencies']) ? $module->info['dependencies'] : array();
- unset($module);
- }
- // All other components
- else {
- if ($default_hook && module_hook($m, $default_hook)) {
- $cache[$component][$alter][$m] = call_user_func("{$m}_{$default_hook}");
- if (is_array($cache[$component][$alter][$m])) {
- $alter_type = features_get_components('alter_type', $component);
- if ($alter && (!isset($alter_type) || $alter_type == FEATURES_ALTER_TYPE_NORMAL)) {
- if ($alter_hook = features_get_default_alter_hook($component)) {
- drupal_alter($alter_hook, $cache[$component][$alter][$m]);
- }
- }
- }
- else {
- $cache[$component][$alter][$m] = FALSE;
- }
- }
- else {
- $cache[$component][$alter][$m] = FALSE;
- }
- }
- }
- }
- // A specific module was specified. Retrieve only its components.
- if (isset($module_name)) {
- return isset($cache[$component][$alter][$module_name]) ? $cache[$component][$alter][$module_name] : FALSE;
- }
- // No module was specified. Retrieve all components.
- $all_defaults = array();
- if (isset($cache[$component][$alter])) {
- foreach (array_filter($cache[$component][$alter]) as $module_components) {
- $all_defaults = array_merge($all_defaults, $module_components);
- }
- }
- return $all_defaults;
- }
- /**
- * Get a map of components to their providing modules.
- *
- * @param string $component
- * @param string $attribute
- * @param callable $callback
- * @param bool $reset
- *
- * @return array|bool
- */
- function features_get_default_map($component, $attribute = NULL, $callback = NULL, $reset = FALSE) {
- $map = &drupal_static(__FUNCTION__, array());
- global $features_ignore_conflicts;
- if ($features_ignore_conflicts) {
- return FALSE;
- }
- features_include();
- features_include_defaults($component);
- if ((!isset($map[$component]) || $reset) && $default_hook = features_get_default_hooks($component)) {
- $map[$component] = array();
- foreach (module_implements($default_hook) as $module) {
- if ($defaults = features_get_default($component, $module)) {
- foreach ($defaults as $key => $object) {
- if (isset($callback)) {
- if ($object_key = $callback($object)) {
- $map[$component][$object_key] = $module;
- }
- }
- elseif (isset($attribute)) {
- if (is_object($object) && isset($object->{$attribute})) {
- $map[$component][$object->{$attribute}] = $module;
- }
- elseif (is_array($object) && isset($object[$attribute])) {
- $map[$component][$object[$attribute]] = $module;
- }
- }
- elseif (!isset($attribute) && !isset($callback)) {
- if (!is_numeric($key)) {
- $map[$component][$key] = $module;
- }
- }
- else {
- return FALSE;
- }
- }
- }
- }
- }
- return isset($map[$component]) ? $map[$component] : FALSE;
- }
- /**
- * Retrieve an array of features/components and their current states.
- */
- function features_get_component_states($features = array(), $rebuild_only = TRUE, $reset = FALSE) {
- // Ensure that the export will be created in the English language.
- $language = _features_export_language();
- if ($reset) {
- drupal_static_reset(__FUNCTION__);
- }
- $cache = &drupal_static(__FUNCTION__, array());
- $all_features = features_get_features();
- $features = !empty($features) ? $features : array_keys($all_features);
- // Retrieve only rebuildable components if requested.
- features_include();
- $components = array_keys(features_get_components(NULL, NULL, $reset));
- if ($rebuild_only) {
- foreach ($components as $k => $component) {
- if (!features_hook($component, 'features_rebuild')) {
- unset($components[$k]);
- }
- }
- }
- foreach ($features as $feature) {
- $cache[$feature] = isset($cache[$feature]) ? $cache[$feature] : array();
- if (module_exists($feature) && !empty($all_features[$feature]->components)) {
- foreach (array_intersect($all_features[$feature]->components, $components) as $component) {
- if (!isset($cache[$feature][$component])) {
- $normal = features_get_signature('normal', $feature, $component, $reset);
- $default = features_get_signature('default', $feature, $component, $reset);
- $codecache = features_get_signature('cache', $feature, $component, $reset);
- $semaphore = features_semaphore('get', $component);
- // DB and code states match, there is nothing more to check.
- if ($normal == $default) {
- $cache[$feature][$component] = FEATURES_DEFAULT;
- // Stale semaphores can be deleted.
- features_semaphore('del', $component);
- // Update code cache if it is stale, clear out semaphore if it stale.
- if ($default != $codecache) {
- features_set_signature($feature, $component, $default);
- }
- }
- // Component properly implements exportables.
- else if (!features_hook($component, 'features_rebuild')) {
- $cache[$feature][$component] = FEATURES_OVERRIDDEN;
- }
- // Component does not implement exportables.
- else {
- if (empty($semaphore)) {
- // Exception for dependencies. Dependencies are always rebuildable.
- if ($component === 'dependencies') {
- $cache[$feature][$component] = FEATURES_REBUILDABLE;
- }
- // All other rebuildable components require comparison.
- else {
- // Code has not changed, but DB does not match. User has DB overrides.
- if ($codecache == $default) {
- $cache[$feature][$component] = FEATURES_OVERRIDDEN;
- }
- // DB has no modifications to prior code state (or this is initial install).
- else if (empty($codecache) || $codecache == $normal) {
- $cache[$feature][$component] = FEATURES_REBUILDABLE;
- }
- // None of the states match. Requires user intervention.
- else if ($codecache != $default) {
- $cache[$feature][$component] = FEATURES_NEEDS_REVIEW;
- }
- }
- }
- else {
- // Semaphore is still within processing horizon. Do nothing.
- if ((REQUEST_TIME - $semaphore) < FEATURES_SEMAPHORE_TIMEOUT) {
- $cache[$feature][$component] = FEATURES_REBUILDING;
- }
- // A stale semaphore means a previous rebuild attempt did not complete.
- // Attempt to complete the rebuild.
- else {
- $cache[$feature][$component] = FEATURES_REBUILDABLE;
- }
- }
- }
- }
- }
- }
- }
- // Filter cached components on the way out to ensure that even if we have
- // cached more data than has been requested, the return value only reflects
- // the requested features/components.
- $return = $cache;
- $return = array_intersect_key($return, array_flip($features));
- foreach ($return as $k => $v) {
- $return[$k] = array_intersect_key($return[$k], array_flip($components));
- }
- _features_export_language($language);
- return $return;
- }
- /**
- * Helper function to eliminate whitespace differences in code.
- */
- function _features_linetrim($code) {
- $code = explode("\n", $code);
- foreach ($code as $k => $line) {
- $code[$k] = trim($line);
- }
- return implode("\n", $code);
- }
- /**
- * Helper function to "sanitize" an array or object.
- * Converts everything to an array, sorts the keys, removes recursion.
- * @param $array
- * @param $component string name of component
- * @param bool $remove_empty if set, remove null or empty values for assoc arrays.
- */
- function features_sanitize(&$array, $component = NULL, $remove_empty = TRUE) {
- $array = features_remove_recursion($array);
- if (isset($component)) {
- $ignore_keys = _features_get_ignore_keys($component);
- // remove keys to be ignored
- if (count($ignore_keys)) {
- _features_remove_ignores($array, $ignore_keys);
- }
- }
- _features_sanitize($array, $remove_empty);
- }
- /**
- * "Sanitizes" an array recursively, performing two key operations:
- * - Sort an array by its keys (assoc) or values (non-assoc)
- * @param bool $remove_empty if set, remove null or empty values for assoc arrays.
- */
- function _features_sanitize(&$array, $remove_empty = TRUE) {
- if (is_object($array)) {
- $array = get_object_vars($array);
- }
- if (is_array($array)) {
- $is_assoc = _features_is_assoc($array);
- if ($is_assoc) {
- ksort($array, SORT_STRING);
- if ($remove_empty) {
- $array = array_filter($array);
- }
- }
- else {
- sort($array);
- }
- foreach ($array as $k => $v) {
- if (is_array($v) or is_object($v)) {
- _features_sanitize($array[$k]);
- if ($remove_empty && $is_assoc && empty($array[$k])) {
- unset($array[$k]);
- }
- }
- }
- }
- }
- /**
- * Is the given array an associative array. This basically extracts the keys twice to get the
- * numerically ordered keys. It then does a diff with the original array and if there is no
- * key diff then the original array is not associative.
- *
- * NOTE: If you have non-sequential numerical keys, this will identify the array as assoc.
- *
- * Borrowed from: http://www.php.net/manual/en/function.is-array.php#96724
- *
- * @return True is the array is an associative array, false otherwise
- */
- function _features_is_assoc($array) {
- return (is_array($array) && (0 !== count(array_diff_key($array, array_keys(array_keys($array)))) || count($array)==0));
- }
- /**
- * Removes recursion from an object or array.
- *
- * Taken from https://code.google.com/p/formaldehyde/source/browse/trunk/formaldehyde.php
- * Also used in node_export module
- *
- * @param $o mixed
- * @return mixed
- * returns a copy of the object or array with recursion removed
- */
- function features_remove_recursion($o) {
- static $replace;
- if (!isset($replace)) {
- $replace = create_function(
- '$m',
- '$r="\x00{$m[1]}ecursion_features";return \'s:\'.strlen($r.$m[2]).\':"\'.$r.$m[2].\'";\';'
- );
- }
- if (is_array($o) || is_object($o)) {
- $re = '#(r|R):([0-9]+);#';
- $serialize = serialize($o);
- if (preg_match($re, $serialize)) {
- $last = $pos = 0;
- while (false !== ($pos = strpos($serialize, 's:', $pos))) {
- $chunk = substr($serialize, $last, $pos - $last);
- if (preg_match($re, $chunk)) {
- $length = strlen($chunk);
- $chunk = preg_replace_callback($re, $replace, $chunk);
- $serialize = substr($serialize, 0, $last) . $chunk . substr($serialize, $last + ($pos - $last));
- $pos += strlen($chunk) - $length;
- }
- $pos += 2;
- $last = strpos($serialize, ':', $pos);
- $length = substr($serialize, $pos, $last - $pos);
- $last += 4 + $length;
- $pos = $last;
- }
- $serialize = substr($serialize, 0, $last) . preg_replace_callback($re, $replace, substr($serialize, $last));
- $o = unserialize($serialize);
- }
- }
- return $o;
- }
- /**
- * Helper to removes a set of keys an object/array.
- *
- * @param $item
- * An object or array passed by reference.
- * @param $ignore_keys
- * Array of keys to be ignored. Values are the level of the key.
- * @param $level
- * Level of key to remove. Up to 2 levels deep because $item can still be
- * recursive
- */
- function _features_remove_ignores(&$item, $ignore_keys, $level = -1) {
- $is_object = is_object($item);
- if (!is_array($item) && !is_object($item)) {
- return;
- }
- foreach ($item as $key => &$value) {
- if (isset($ignore_keys[$key]) && ($ignore_keys[$key] == $level)) {
- if ($is_object) {
- unset($item->$key);
- }
- else {
- unset($item[$key]);
- }
- }
- elseif (($level < 2) && (is_array($value) || is_object($value))) {
- _features_remove_ignores($value, $ignore_keys, $level+1);
- }
- }
- unset($value);
- }
- /**
- * Returns an array of keys to be ignored for various exportables
- * @param $component
- * The component to retrieve ignore_keys from.
- */
- function _features_get_ignore_keys($component) {
- static $cache;
- if (!isset($cache[$component])) {
- $cache[$component] = module_invoke_all('features_ignore', $component);
- }
- return $cache[$component];
- }
|