function upgrade_status_calculate_project_data in Upgrade Status 5
Same name and namespace in other branches
- 6 upgrade_status.compare.inc \upgrade_status_calculate_project_data()
- 7 upgrade_status.compare.inc \upgrade_status_calculate_project_data()
Given the installed projects and the available release data retrieved from remote servers, calculate the current status.
This function is the heart of the update status feature. It iterates over every currently installed project. For each one, it first checks if the project has been flagged with a special status like "unsupported" or "insecure", or if the project node itself has been unpublished. In any of those cases, the project is marked with an error and the next project is considered.
Parameters
$available: Array of data about available project releases.
See also
upgrade_status_get_available()
update_status_process_project_info()
1 call to upgrade_status_calculate_project_data()
- _upgrade_status_status in ./
upgrade_status.admin.inc - Menu callback. Generate a page about the upgrade status of projects.
File
- ./
upgrade_status.admin.inc, line 86 - Checks to see if your installed modules are available for the next major release of Drupal.
Code
function upgrade_status_calculate_project_data($available) {
// Retrieve the projects from cache, if present.
$projects = upgrade_status_project_cache('upgrade_status_data');
// If $projects is empty, then the cache must be rebuilt.
// Otherwise, return the cached data and skip the rest of the function.
if (!empty($projects)) {
return $projects;
}
$projects = update_status_get_projects();
update_status_process_project_info($projects);
$settings = variable_get('upgrade_status_settings', array());
foreach ($projects as $project => $project_info) {
if (isset($available[$project])) {
// If the project status is marked as something bad, there's nothing
// else to consider.
if (isset($available[$project]['project_status'])) {
switch ($available[$project]['project_status']) {
case 'unpublished':
case 'revoked':
case 'unsupported':
$projects[$project]['status'] = UPDATE_STATUS_NOT_SUPPORTED;
if (empty($projects[$project]['extra'])) {
$projects[$project]['extra'] = array();
}
$projects[$project]['extra'][] = array(
'class' => 'project-not-supported',
'label' => t('Project not supported'),
'data' => t('This project is no longer supported, and is no longer available for download. Disabling everything included by this project is strongly recommended!'),
);
break;
}
}
if (!empty($projects[$project]['status'])) {
// We already know the status for this project, so there's nothing
// else to compute. Just record everything else we fetched from the
// XML file into our projects array and move to the next project.
$projects[$project] += $available[$project];
continue;
}
// Figure out the target major version.
$existing_major = $project_info['existing_major'];
$supported_majors = array();
if (isset($available[$project]['supported_majors'])) {
$supported_majors = explode(',', $available[$project]['supported_majors']);
}
if (isset($available[$project]['recommended_major'])) {
$target_major = $available[$project]['recommended_major'];
}
elseif (isset($available[$project]['default_major'])) {
// Older release history XML file without recommended, so recommend
// the currently defined "default_major" version.
$target_major = $available[$project]['default_major'];
}
else {
// Malformed XML file? Stick with the current version.
$target_major = $existing_major;
}
$version_patch_changed = '';
$patch = '';
// Defend ourselves from XML history files that contain no releases.
if (empty($available[$project]['releases'])) {
$projects[$project]['status'] = UPDATE_STATUS_UNKNOWN;
$projects[$project]['reason'] = t('No available releases found');
continue;
}
foreach ($available[$project]['releases'] as $version => $release) {
// Otherwise, ignore unpublished, insecure, or unsupported releases.
if ($release['status'] == 'unpublished' || isset($release['terms']['Release type']) && (in_array('Insecure', $release['terms']['Release type']) || in_array('Unsupported', $release['terms']['Release type']))) {
continue;
}
// See if this is a higher major version than our target and yet still
// supported. If so, record it as an "Also available" release.
if ($release['version_major'] > $target_major) {
if (in_array($release['version_major'], $supported_majors)) {
if (!isset($available[$project]['also'])) {
$available[$project]['also'] = array();
}
if (!isset($available[$project]['also'][$release['version_major']])) {
$available[$project]['also'][$release['version_major']] = $version;
}
}
// Otherwise, this release can't matter to us, since it's neither
// from the release series we're currently using nor the recommended
// release. We don't even care about security updates for this
// branch, since if a project maintainer puts out a security release
// at a higher major version and not at the lower major version,
// they must change the default major release at the same time, in
// which case we won't hit this code.
continue;
}
// Look for the 'latest version' if we haven't found it yet. Latest is
// defined as the most recent version for the target major version.
if (!isset($available[$project]['latest_version']) && $release['version_major'] == $target_major) {
$available[$project]['latest_version'] = $version;
}
// Look for the development snapshot release for this branch.
if (!isset($available[$project]['dev_version']) && isset($release['version_extra']) && $release['version_extra'] == 'dev') {
$available[$project]['dev_version'] = $version;
}
// Look for the 'recommended' version if we haven't found it yet (see
// phpdoc at the top of this function for the definition).
if (!isset($available[$project]['recommended']) && $release['version_major'] == $target_major && isset($release['version_patch'])) {
if ($patch != $release['version_patch']) {
$patch = $release['version_patch'];
$version_patch_changed = $release['version'];
}
if (empty($release['version_extra']) && $patch == $release['version_patch']) {
$available[$project]['recommended'] = $version_patch_changed;
}
}
}
// If we were unable to find a recommended version, then make the latest
// version the recommended version if possible.
if (!isset($available[$project]['recommended']) && isset($available[$project]['latest_version'])) {
$available[$project]['recommended'] = $available[$project]['latest_version'];
$projects[$project]['status'] = UPGRADE_STATUS_DEVELOPMENT;
$projects[$project]['reason'] = t('In development');
}
// Stash the info about available releases into our $projects array.
$projects[$project] += $available[$project];
if (isset($projects[$project]['status'])) {
// If we already know the status, we're done.
continue;
}
// If we don't know what to recommend, there's nothing we can report.
// Bail out early.
if (!isset($projects[$project]['recommended'])) {
$projects[$project]['status'] = UPDATE_STATUS_UNKNOWN;
$projects[$project]['reason'] = t('No available releases found');
continue;
}
// Figure out the status, based on what we've seen and the install type.
// Note: If we were not yet able to assign a status, this project already
// provides a stable release.
switch ($projects[$project]['type']) {
case 'official':
case 'dev':
$projects[$project]['status'] = UPGRADE_STATUS_STABLE;
$projects[$project]['reason'] = t('Available');
break;
default:
$projects[$project]['status'] = UPDATE_STATUS_UNKNOWN;
$projects[$project]['reason'] = t('Invalid info');
}
}
elseif (!upgrade_status_moved_into_core($projects, $project)) {
$projects[$project]['status'] = UPGRADE_STATUS_NOT_PORTED;
$projects[$project]['reason'] = t('Not ported yet');
}
}
cache_set('upgrade_status_data', 'cache', serialize($projects), time() + 60 * 60);
return $projects;
}