function _update_process_info_list

1 update.compare.inc _update_process_info_list(&$projects, $list, $project_type, $status)

Populates an array of project data.

This function iterates over the list of installed modules, themes and layout templates, and groups them by project type and status.

Some parts of this function assume that enabled projects are always processed first, and if disabled projects are being processed (depending on the 'update_disabled_extensions' setting, as configured under admin/reports/updates/settings), those are only processed after $projects has been populated with information about the enabled code. Projects that are set as hidden are always ignored.

This function also records the latest change time on the .info files for each module, theme, or layout template. This timestamp is used when deciding if the cached available update data should be invalidated.

Parameters

$projects: Reference to the array of project data of what's installed on this site.

$list: Array of data to process to add the relevant info to the $projects array.

$project_type: The kind of data in the list. Can be 'module' or 'theme' or 'layout'.

$status: Boolean that controls what status (enabled or disabled) to process out of the $list and add to the $projects array.

File

core/modules/update/update.compare.inc, line 130: Code required only when comparing available updates to existing data.

Code

function _update_process_info_list(&$projects, $list, $project_type, $status) {
  $admin_theme = config_get('system.core', 'admin_theme');
  foreach ($list as $file) {
    // The admin theme is a special case. It should always be considered enabled
    // for the purposes of update checking.
    if ($file->name === $admin_theme) {
      $file->status = TRUE;
    }
    // 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, theme, or layout.
    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'] = update_get_project_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 'backdrop', we don't want it to show up
    // under the usual "Modules" section, we put it at a special "Core"
    // section at the top of the report.
    if ($project_name == 'backdrop') {
      $project_display_type = 'core';
    }
    else {
      $project_display_type = $project_type;
    }

    // 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 == 'backdrop') {
      // Backdrop 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();
    }

    // The file info arrays for modules and themes have the human-readable name
    // of the project in a 'name' key, whereas layout templates in a 'title'
    // key.
    // - the 'name' key holds the machine name for layouts
    // - the 'title' key is not present in modules/themes
    // @todo: Fix all that in https://github.com/backdrop/backdrop-issues/issues/2548
    $includes_name = isset($file->info['title']) ? $file->info['title'] : $file->info['name'];
    if (!isset($projects[$project_name])) {
      // Only process this if we haven't done this project, since a single
      // project can have multiple modules, themes, or layout templates.
      $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' => update_filter_project_info($file->info),
        'datestamp' => $file->info['datestamp'],
        'includes' => array($file->name => $includes_name),
        'project_type' => $project_name == 'backdrop' ? 'core' : $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 within an enabled project, if we happen to be checking for
      // disabled modules too.
      $projects[$project_name]['includes'][$file->name] = $includes_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, theme, or layout
      // 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] = $includes_name;
    }
  }
}

function _update_process_info_list

Parameters

See also

File

Code