commit eb719018a2bff0cf05b31f004b45a97b580a8380 Author: Erik Stielstra Date: Sun Jan 6 22:23:12 2013 +0100 Working code diff --git a/core/includes/project.inc b/core/includes/project.inc index a4ed278..b87cb91 100644 --- a/core/includes/project.inc +++ b/core/includes/project.inc @@ -94,7 +94,7 @@ function project_list() { */ 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 + // 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) { @@ -115,7 +115,6 @@ function project_process_info_list(&$projects, $list, $project_type, $status) { continue; } - // Skip if the .info file is broken. if (empty($file->info)) { continue; @@ -187,16 +186,16 @@ function project_process_info_list(&$projects, $list, $project_type, $status) { // 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, + '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) { diff --git a/core/lib/Drupal/Core/Project/Project.php b/core/lib/Drupal/Core/Project/Project.php new file mode 100644 index 0000000..c374443 --- /dev/null +++ b/core/lib/Drupal/Core/Project/Project.php @@ -0,0 +1,221 @@ +type = $type; + $this->name = $name; + } + + /** + * @todo + */ + public function getName() { + return $this->name; + } + + /** + * @todo + */ + public function getInfo($key = NULL) { + if (isset($key)) { + return isset($this->info[$key]) ? $this->info[$key] : NULL; + } + return $this->info; + } + + /** + * @todo + */ + public function getDatestamp() { + return $this->datestamp; + } + + /** + * @todo + */ + public function getIncludes() { + return $this->includes; + } + + /** + * @todo + */ + public function getDisabled() { + return $this->disabled; + } + + /** + * @todo + */ + public function getType() { + return $this->type; + } + + /** + * @todo + */ + public function getStatus() { + return $this->status; + } + + /** + * @todo + */ + public function getSubThemes() { + return $this->sub_themes; + } + + /** + * @todo + */ + public function getBaseThemes() { + return $this->base_themes; + } + + + /** + * @todo + */ + public function setInfo(array $info) { + if (empty($this->info)) { + $this->info = $info; + } + else { + $this->info += $info; + } + } + + /** + * @todo + */ + public function setDatestamp($timestamp) { + $this->datestamp = $timestamp; + } + + /** + * @todo + */ + public function setIncludes(array $includes) { + if (empty($this->includes)) { + $this->includes = $includes; + } + else { + $this->includes += $includes; + } + } + + /** + * @todo + */ + public function setDisabled(array $disabled) { + if (empty($this->includes)) { + $this->disabled = $disabled; + } + else { + $this->disabled += $disabled; + } + } + + /** + * @todo + */ + public function setStatus($status) { + $this->status = $status; + } + + /** + * @todo + */ + public function setSubThemes($sub_themes) { + if (empty($this->sub_themes)) { + $this->sub_themes = $sub_themes; + } + else { + $this->sub_themes += $sub_themes; + } + } + + /** + * @todo + */ + public function setBaseThemes($base_themes) { + if (empty($this->base_themes)) { + $this->base_themes = $base_themes; + } + else { + $this->base_themes += $base_themes; + } + } + +} \ No newline at end of file diff --git a/core/lib/Drupal/Core/Project/ProjectFactory.php b/core/lib/Drupal/Core/Project/ProjectFactory.php new file mode 100644 index 0000000..4ceb1f6 --- /dev/null +++ b/core/lib/Drupal/Core/Project/ProjectFactory.php @@ -0,0 +1,304 @@ +projects; + drupal_alter('project_list', $projects); + return $projects; + } + + /** + * @todo + */ + public function getProject($name) { + if (isset($this->projects[$name])) { + return $this->projects[$name]; + } + return FALSE; + } + + /** + * @todo + */ + public function setProject($project) { + // @todo better verification. + if (!empty($project)) { + $this->projects[$project->getName()] = $project; + } + } + + /** + * Parse project list and retrieve 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 $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. + */ + public function parse($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'] = $this->fileGetName($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 (!$project = $this->getProject($project_name)) { + // Only process this if we haven't done this project, since a single + // project can have multiple modules or themes. + $project = new Project($project_name, $project_display_type); + // Only save attributes from the .info file we care about so we do not + // bloat our RAM usage needlessly. + $project->setInfo($this->filterInfo($file->info)); + $project->setDatestamp($file->info['datestamp']); + $project->setIncludes(array($file->name => $file->info['name'])); + $project->setStatus($status); + $project->setSubThemes($sub_themes); + $project->setBaseThemes($base_themes); + } + elseif ($project->getType() == $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. + $project->setIncludes(array($file->name => $file->info['name'])); + $project->setInfo(array('_info_file_ctime' => max($this->getProject($project_name)->getInfo('_info_file_ctime'), $file->info['_info_file_ctime']))); + $project->setDatestamp(max($project->getDatestamp(), $file->info['datestamp'])); + if (!empty($sub_themes)) { + $project->setSubThemes($sub_themes); + } + if (!empty($base_themes)) { + $project->setBaseThemes($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. + $project->setDisabled(array($file->name => $file->info['name'])); + } + + // Store or update the project. + if (!empty($project)) { + $this->setProject($project); + } + } + } + + /** + * Determines version and type information for currently installed projects. + * + * Processes the list of projects on the system to figure out the currently + * installed versions, and other information that is required before we can + * compare against the available releases to produce the status report. + */ + // @todo Move this function to UpdateProjectFactory + protected function processVersionInfo() { + foreach ($this->projects as $key => $project) { + // Assume an official release until we see otherwise. + $install_type = 'official'; + + $info = $project['info']; + + if (isset($info['version'])) { + // Check for development snapshots + if (preg_match('@(dev|HEAD)@', $info['version'])) { + $install_type = 'dev'; + } + + // Figure out what the currently installed major version is. We need + // to handle both contribution (e.g. "5.x-1.3", major = 1) and core + // (e.g. "5.1", major = 5) version strings. + $matches = array(); + if (preg_match('/^(\d+\.x-)?(\d+)\..*$/', $info['version'], $matches)) { + $info['major'] = $matches[2]; + } + elseif (!isset($info['major'])) { + // This would only happen for version strings that don't follow the + // drupal.org convention. We let contribs define "major" in their + // .info in this case, and only if that's missing would we hit this. + $info['major'] = -1; + } + } + else { + // No version info available at all. + $install_type = 'unknown'; + $info['version'] = t('Unknown'); + $info['major'] = -1; + } + + // Finally, save the results we care about into the projects array. + $this->projects[$key]['existing_version'] = $info['version']; + $this->projects[$key]['existing_major'] = $info['major']; + $this->projects[$key]->setType($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. + */ + protected function fileGetName($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. + */ + protected function filterInfo($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; + } +} \ No newline at end of file diff --git a/core/modules/locale/locale.compare.inc b/core/modules/locale/locale.compare.inc index 4be14d5..7d93d00 100644 --- a/core/modules/locale/locale.compare.inc +++ b/core/modules/locale/locale.compare.inc @@ -134,6 +134,7 @@ function locale_translation_build_projects() { function locale_translation_project_list() { $projects = &drupal_static(__FUNCTION__, array()); if (empty($projects)) { + $include_disabled = config('locale.settings')->get('translation.check_disabled_modules'); $projects = array_filter(project_list(), function ($project) use ($include_disabled) { return ($include_disabled || !empty($project['project_status'])) &&