commit c163af54c06a22e7f456add1c0a075841459c442 Author: Erik Stielstra Date: Mon Sep 2 20:37:41 2013 +0200 #57 diff --git a/core/includes/project.inc b/core/includes/project.inc index 9443953..6a160e5 100644 --- a/core/includes/project.inc +++ b/core/includes/project.inc @@ -70,166 +70,6 @@ function project_list() { return $projects; } - -/** - * Populates an array of project data. - * - * This iterates over a list of the installed modules or themes and groups them - * by project and status. A few parts of this function assume that enabled - * modules and themes are always processed first, and if disabled modules or - * themes are being processed (there is a setting to control if disabled code - * should be included or not in the 'Available updates' report), those are only - * processed after $projects has been populated with information about the - * enabled code. Modules and themes set as hidden are always ignored. This - * function also records the latest change time on the .info files for each - * module or theme, which is important data which is used when deciding if the - * cached available update data should be invalidated. - * - * @param $projects - * Reference to the array of project data of what's installed on this site. - * @param $list - * Array of data to process to add the relevant info to the $projects array. - * @param $project_type - * The kind of data in the list. Can be 'module' or 'theme'. - * @param $status - * Boolean that controls what status (enabled or disabled) to process out of - * the $list and add to the $projects array. - * - * @see update_get_projects() - */ -function project_process_info_list(&$projects, $list, $project_type, $status) { - foreach ($list as $file) { - // A disabled base theme of an enabled sub-theme still has all of its code - // run by the sub-theme, so we include it in our "enabled" projects list. - if ($status && !$file->status && !empty($file->sub_themes)) { - foreach ($file->sub_themes as $key => $name) { - // Build a list of enabled sub-themes. - if ($list[$key]->status) { - $file->enabled_sub_themes[$key] = $name; - } - } - // If there are no enabled subthemes, we should ignore this base theme - // for the enabled case. If the site is trying to display disabled - // themes, we'll catch it then. - if (empty($file->enabled_sub_themes)) { - continue; - } - } - // Otherwise, just add projects of the proper status to our list. - elseif ($file->status != $status) { - continue; - } - - - // Skip if the .info file is broken. - if (empty($file->info)) { - continue; - } - - // Skip if it's a hidden module or theme. - if (!empty($file->info['hidden'])) { - continue; - } - - // If the .info doesn't define the 'project', try to figure it out. - if (!isset($file->info['project'])) { - $file->info['project'] = project_file_get_name($file); - } - - // If we still don't know the 'project', give up. - if (empty($file->info['project'])) { - continue; - } - - // If we don't already know it, grab the change time on the .info file - // itself. Note: we need to use the ctime, not the mtime (modification - // time) since many (all?) tar implementations will go out of their way to - // set the mtime on the files it creates to the timestamps recorded in the - // tarball. We want to see the last time the file was changed on disk, - // which is left alone by tar and correctly set to the time the .info file - // was unpacked. - if (!isset($file->info['_info_file_ctime'])) { - $info_filename = dirname($file->uri) . '/' . $file->name . '.info'; - $file->info['_info_file_ctime'] = filectime($info_filename); - } - - if (!isset($file->info['datestamp'])) { - $file->info['datestamp'] = 0; - } - - $project_name = $file->info['project']; - - // Figure out what project type we're going to use to display this module - // or theme. If the project name is 'drupal', we don't want it to show up - // under the usual "Modules" section, we put it at a special "Drupal Core" - // section at the top of the report. - if ($project_name == 'drupal') { - $project_display_type = 'core'; - } - else { - $project_display_type = $project_type; - } - if (empty($status) && empty($file->enabled_sub_themes)) { - // If we're processing disabled modules or themes, append a suffix. - // However, we don't do this to a a base theme with enabled - // subthemes, since we treat that case as if it is enabled. - $project_display_type .= '-disabled'; - } - // Add a list of sub-themes that "depend on" the project and a list of base - // themes that are "required by" the project. - if ($project_name == 'drupal') { - // Drupal core is always required, so this extra info would be noise. - $sub_themes = array(); - $base_themes = array(); - } - else { - // Add list of enabled sub-themes. - $sub_themes = !empty($file->enabled_sub_themes) ? $file->enabled_sub_themes : array(); - // Add list of base themes. - $base_themes = !empty($file->base_themes) ? $file->base_themes : array(); - } - if (!isset($projects[$project_name])) { - // Only process this if we haven't done this project, since a single - // project can have multiple modules or themes. - $projects[$project_name] = array( - 'name' => $project_name, - // Only save attributes from the .info file we care about so we do not - // bloat our RAM usage needlessly. - 'info' => project_filter_info($file->info), - 'datestamp' => $file->info['datestamp'], - 'includes' => array($file->name => $file->info['name']), - 'project_type' => $project_display_type, - 'project_status' => $status, - 'sub_themes' => $sub_themes, - 'base_themes' => $base_themes, - ); - } - elseif ($projects[$project_name]['project_type'] == $project_display_type) { - // Only add the file we're processing to the 'includes' array for this - // project if it is of the same type and status (which is encoded in the - // $project_display_type). This prevents listing all the disabled - // modules included with an enabled project if we happen to be checking - // for disabled modules, too. - $projects[$project_name]['includes'][$file->name] = $file->info['name']; - $projects[$project_name]['info']['_info_file_ctime'] = max($projects[$project_name]['info']['_info_file_ctime'], $file->info['_info_file_ctime']); - $projects[$project_name]['datestamp'] = max($projects[$project_name]['datestamp'], $file->info['datestamp']); - if (!empty($sub_themes)) { - $projects[$project_name]['sub_themes'] += $sub_themes; - } - if (!empty($base_themes)) { - $projects[$project_name]['base_themes'] += $base_themes; - } - } - elseif (empty($status)) { - // If we have a project_name that matches, but the project_display_type - // does not, it means we're processing a disabled module or theme that - // belongs to a project that has some enabled code. In this case, we add - // the disabled thing into a separate array for separate display. - $projects[$project_name]['disabled'][$file->name] = $file->info['name']; - } - } -} - /** * Determines version and type information for currently installed projects. * @@ -280,57 +120,3 @@ function project_process_version_info(&$projects) { $projects[$key]['install_type'] = $install_type; } } - -/** - * Determines what project a given file object belongs to. - * - * @param $file - * A file object as returned by system_get_files_database(). - * - * @return - * The canonical project short name. - * - * @see system_get_files_database() - */ -function project_file_get_name($file) { - $project_name = ''; - if (isset($file->info['project'])) { - $project_name = $file->info['project']; - } - elseif (isset($file->info['package']) && (strpos($file->info['package'], 'Core') === 0)) { - $project_name = 'drupal'; - } - return $project_name; -} - -/** - * Filters the project .info data to only save attributes we need. - * - * The saved attributes will be a predefined list plus all the attributes - * whose name start with 'project'. - * - * @param array $info - * Array of .info file data as returned by drupal_parse_info_file(). - * - * @return - * Array of .info file data we need for the project list. - * - * @see project_process_info_list() - */ -function project_filter_info($info) { - $whitelist = array( - '_info_file_ctime', - 'datestamp', - 'major', - 'name', - 'package', - 'version', - ); - $return = array(); - foreach ($info as $name => $data) { - if (in_array($name, $whitelist) || strpos($name, 'project') === 0) { - $return[$name] = $data; - } - } - return $return; -} diff --git a/core/modules/system/system.api.php b/core/modules/system/system.api.php index 7c7e1ba..57b6dc0 100644 --- a/core/modules/system/system.api.php +++ b/core/modules/system/system.api.php @@ -1481,11 +1481,11 @@ function hook_system_info_alter(&$info, $file, $type) { * includes all the metadata documented in the comments below for each project * (either module or theme) that is currently enabled. The array is initially * populated inside project_list() with the help of - * project_process_info_list(), so look there for examples of how to populate - * the array with real values. + * \Drupal\Core\Utility\ProjectInfo::processInfoList(), so look there for + * examples of how to populate the array with real values. * * @see project_list() - * @see project_process_info_list() + * @see \Drupal\Core\Utility\ProjectInfo::processInfoList() * @see update_get_projects() * @see locale_translation_project_list() */