webmaster@1: <?php
webmaster@5: // $Id: update.fetch.inc,v 1.7.2.1 2008/04/09 18:36:58 goba Exp $
webmaster@1: 
webmaster@1: /**
webmaster@1:  * @file
webmaster@1:  * Code required only when fetching information about available updates.
webmaster@1:  */
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Callback to manually check the update status without cron.
webmaster@1:  */
webmaster@1: function update_manual_status() {
webmaster@1:   if (_update_refresh()) {
webmaster@1:     drupal_set_message(t('Fetched information about all available new releases and updates.'));
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     drupal_set_message(t('Unable to fetch any information about available new releases and updates.'), 'error');
webmaster@1:   }
webmaster@1:   drupal_goto('admin/reports/updates');
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Fetch project info via XML from a central server.
webmaster@1:  */
webmaster@1: function _update_refresh() {
webmaster@1:   global $base_url;
webmaster@1:   module_load_include('inc', 'update', 'update.compare');
webmaster@1: 
webmaster@1:   // Since we're fetching new available update data, we want to clear
webmaster@1:   // everything in our cache, to ensure we recompute the status. Note that
webmaster@1:   // this does not cause update_get_projects() to be recomputed twice in the
webmaster@1:   // same page load (e.g. when manually checking) since that function stashes
webmaster@1:   // its answer in a static array.
webmaster@1:   update_invalidate_cache();
webmaster@1: 
webmaster@1:   $available = array();
webmaster@1:   $data = array();
webmaster@1:   $site_key = md5($base_url . drupal_get_private_key());
webmaster@1:   $projects = update_get_projects();
webmaster@1: 
webmaster@1:   foreach ($projects as $key => $project) {
webmaster@1:     $url = _update_build_fetch_url($project, $site_key);
webmaster@1:     $xml = drupal_http_request($url);
webmaster@1:     if (isset($xml->data)) {
webmaster@1:       $data[] = $xml->data;
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   if ($data) {
webmaster@1:     $parser = new update_xml_parser;
webmaster@1:     $available = $parser->parse($data);
webmaster@1:   }
webmaster@1:   if (!empty($available) && is_array($available)) {
webmaster@1:     $frequency = variable_get('update_check_frequency', 1);
webmaster@1:     cache_set('update_info', $available, 'cache_update', time() + (60 * 60 * 24 * $frequency));
webmaster@1:     variable_set('update_last_check', time());
webmaster@5:     watchdog('update', 'Fetched information about all available new releases and updates.', array(), WATCHDOG_NOTICE, l(t('view'), 'admin/reports/updates'));
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     module_invoke('system', 'check_http_request');
webmaster@5:     watchdog('update', 'Unable to fetch any information about available new releases and updates.', array(), WATCHDOG_ERROR, l(t('view'), 'admin/reports/updates'));
webmaster@1:   }
webmaster@1:   return $available;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Generates the URL to fetch information about project updates.
webmaster@1:  *
webmaster@1:  * This figures out the right URL to use, based on the project's .info file
webmaster@1:  * and the global defaults. Appends optional query arguments when the site is
webmaster@1:  * configured to report usage stats.
webmaster@1:  *
webmaster@1:  * @param $project
webmaster@1:  *   The array of project information from update_get_projects().
webmaster@1:  * @param $site_key
webmaster@1:  *   The anonymous site key hash (optional).
webmaster@1:  *
webmaster@1:  * @see update_refresh()
webmaster@1:  * @see update_get_projects()
webmaster@1:  */
webmaster@1: function _update_build_fetch_url($project, $site_key = '') {
webmaster@1:   $default_url = variable_get('update_fetch_url', UPDATE_DEFAULT_URL);
webmaster@1:   if (!isset($project['info']['project status url'])) {
webmaster@1:     $project['info']['project status url'] = $default_url;
webmaster@1:   }
webmaster@1:   $name = $project['name'];
webmaster@1:   $url = $project['info']['project status url'];
webmaster@1:   $url .= '/'. $name .'/'. DRUPAL_CORE_COMPATIBILITY;
webmaster@1:   if (!empty($site_key)) {
webmaster@1:     $url .= (strpos($url, '?') === TRUE) ? '&' : '?';
webmaster@1:     $url .= 'site_key=';
webmaster@1:     $url .= drupal_urlencode($site_key);
webmaster@1:     if (!empty($project['info']['version'])) {
webmaster@1:       $url .= '&version=';
webmaster@1:       $url .= drupal_urlencode($project['info']['version']);
webmaster@1:     }
webmaster@1:   }
webmaster@1:   return $url;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Perform any notifications that should be done once cron fetches new data.
webmaster@1:  *
webmaster@1:  * This method checks the status of the site using the new data and depending
webmaster@1:  * on the configuration of the site, notifys administrators via email if there
webmaster@1:  * are new releases or missing security updates.
webmaster@1:  *
webmaster@1:  * @see update_requirements()
webmaster@1:  */
webmaster@1: function _update_cron_notify() {
webmaster@1:   include_once './includes/install.inc';
webmaster@1:   $status = update_requirements('runtime');
webmaster@1:   $params = array();
webmaster@1:   foreach (array('core', 'contrib') as $report_type) {
webmaster@1:     $type = 'update_'. $report_type;
webmaster@1:     if (isset($status[$type]['severity'])
webmaster@1:         && $status[$type]['severity'] == REQUIREMENT_ERROR) {
webmaster@1:       $params[$report_type] = $status[$type]['reason'];
webmaster@1:     }
webmaster@1:   }
webmaster@1:   if (!empty($params)) {
webmaster@1:     $notify_list = variable_get('update_notify_emails', '');
webmaster@1:     if (!empty($notify_list)) {
webmaster@1:       $default_language = language_default();
webmaster@1:       foreach ($notify_list as $target) {
webmaster@1:         if ($target_user = user_load(array('mail' => $target))) {
webmaster@1:           $target_language = user_preferred_language($target_user);
webmaster@1:         }
webmaster@1:         else {
webmaster@1:           $target_language = $default_language;
webmaster@1:         }
webmaster@1:         drupal_mail('update', 'status_notify', $target, $target_language, $params);
webmaster@1:       }
webmaster@1:     }
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * XML Parser object to read Drupal's release history info files.
webmaster@1:  * This uses PHP4's lame XML parsing, but it works.
webmaster@1:  */
webmaster@1: class update_xml_parser {
webmaster@1:   var $projects = array();
webmaster@1:   var $current_project;
webmaster@1:   var $current_release;
webmaster@1:   var $current_term;
webmaster@1:   var $current_tag;
webmaster@1:   var $current_object;
webmaster@1: 
webmaster@1:   /**
webmaster@1:    * Parse an array of XML data files.
webmaster@1:    */
webmaster@1:   function parse($data) {
webmaster@1:     foreach ($data as $datum) {
webmaster@1:       $parser = xml_parser_create();
webmaster@1:       xml_set_object($parser, $this);
webmaster@1:       xml_set_element_handler($parser, 'start', 'end');
webmaster@1:       xml_set_character_data_handler($parser, "data");
webmaster@1:       xml_parse($parser, $datum);
webmaster@1:       xml_parser_free($parser);
webmaster@1:     }
webmaster@1:     return $this->projects;
webmaster@1:   }
webmaster@1: 
webmaster@1:   function start($parser, $name, $attr) {
webmaster@1:     $this->current_tag = $name;
webmaster@1:     switch ($name) {
webmaster@1:       case 'PROJECT':
webmaster@1:         unset($this->current_object);
webmaster@1:         $this->current_project = array();
webmaster@1:         $this->current_object = &$this->current_project;
webmaster@1:         break;
webmaster@1:       case 'RELEASE':
webmaster@1:         unset($this->current_object);
webmaster@1:         $this->current_release = array();
webmaster@1:         $this->current_object = &$this->current_release;
webmaster@1:         break;
webmaster@1:       case 'TERM':
webmaster@1:         unset($this->current_object);
webmaster@1:         $this->current_term = array();
webmaster@1:         $this->current_object = &$this->current_term;
webmaster@1:         break;
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   function end($parser, $name) {
webmaster@1:     switch ($name) {
webmaster@1:       case 'PROJECT':
webmaster@1:         unset($this->current_object);
webmaster@1:         $this->projects[$this->current_project['short_name']] = $this->current_project;
webmaster@1:         $this->current_project = array();
webmaster@1:         break;
webmaster@1:       case 'RELEASE':
webmaster@1:         unset($this->current_object);
webmaster@1:         $this->current_project['releases'][$this->current_release['version']] = $this->current_release;
webmaster@1:         break;
webmaster@1:       case 'RELEASES':
webmaster@1:         $this->current_object = &$this->current_project;
webmaster@1:         break;
webmaster@1:       case 'TERM':
webmaster@1:         unset($this->current_object);
webmaster@1:         $term_name = $this->current_term['name'];
webmaster@1:         if (!isset($this->current_release['terms'])) {
webmaster@1:           $this->current_release['terms'] = array();
webmaster@1:         }
webmaster@1:         if (!isset($this->current_release['terms'][$term_name])) {
webmaster@1:           $this->current_release['terms'][$term_name] = array();
webmaster@1:         }
webmaster@1:         $this->current_release['terms'][$term_name][] = $this->current_term['value'];
webmaster@1:         break;
webmaster@1:       case 'TERMS':
webmaster@1:         $this->current_object = &$this->current_release;
webmaster@1:         break;
webmaster@1:       default:
webmaster@1:         $this->current_object[strtolower($this->current_tag)] = trim($this->current_object[strtolower($this->current_tag)]);
webmaster@1:         $this->current_tag = '';
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   function data($parser, $data) {
webmaster@1:     if ($this->current_tag && !in_array($this->current_tag, array('PROJECT', 'RELEASE', 'RELEASES', 'TERM', 'TERMS'))) {
webmaster@1:       $tag = strtolower($this->current_tag);
webmaster@1:       if (isset($this->current_object[$tag])) {
webmaster@1:         $this->current_object[$tag] .= $data;
webmaster@1:       }
webmaster@1:       else {
webmaster@1:         $this->current_object[$tag] = $data;
webmaster@1:       }
webmaster@1:     }
webmaster@1:   }
webmaster@1: }