annotate modules/update/update.fetch.inc @ 20:e3d20ebd63d1 tip

Added tag 6.9 for changeset 3edae6ecd6c6
author Franck Deroche <franck@defr.org>
date Thu, 15 Jan 2009 10:16:10 +0100
parents 3edae6ecd6c6
children
rev   line source
webmaster@1 1 <?php
franck@19 2 // $Id: update.fetch.inc,v 1.7.2.2 2009/01/14 21:36:16 goba Exp $
webmaster@1 3
webmaster@1 4 /**
webmaster@1 5 * @file
webmaster@1 6 * Code required only when fetching information about available updates.
webmaster@1 7 */
webmaster@1 8
webmaster@1 9 /**
webmaster@1 10 * Callback to manually check the update status without cron.
webmaster@1 11 */
webmaster@1 12 function update_manual_status() {
webmaster@1 13 if (_update_refresh()) {
webmaster@1 14 drupal_set_message(t('Fetched information about all available new releases and updates.'));
webmaster@1 15 }
webmaster@1 16 else {
webmaster@1 17 drupal_set_message(t('Unable to fetch any information about available new releases and updates.'), 'error');
webmaster@1 18 }
webmaster@1 19 drupal_goto('admin/reports/updates');
webmaster@1 20 }
webmaster@1 21
webmaster@1 22 /**
webmaster@1 23 * Fetch project info via XML from a central server.
webmaster@1 24 */
webmaster@1 25 function _update_refresh() {
webmaster@1 26 global $base_url;
webmaster@1 27 module_load_include('inc', 'update', 'update.compare');
webmaster@1 28
webmaster@1 29 // Since we're fetching new available update data, we want to clear
webmaster@1 30 // everything in our cache, to ensure we recompute the status. Note that
webmaster@1 31 // this does not cause update_get_projects() to be recomputed twice in the
webmaster@1 32 // same page load (e.g. when manually checking) since that function stashes
webmaster@1 33 // its answer in a static array.
webmaster@1 34 update_invalidate_cache();
webmaster@1 35
webmaster@1 36 $available = array();
webmaster@1 37 $data = array();
webmaster@1 38 $site_key = md5($base_url . drupal_get_private_key());
webmaster@1 39 $projects = update_get_projects();
webmaster@1 40
webmaster@1 41 foreach ($projects as $key => $project) {
webmaster@1 42 $url = _update_build_fetch_url($project, $site_key);
webmaster@1 43 $xml = drupal_http_request($url);
webmaster@1 44 if (isset($xml->data)) {
webmaster@1 45 $data[] = $xml->data;
webmaster@1 46 }
webmaster@1 47 }
webmaster@1 48
webmaster@1 49 if ($data) {
webmaster@1 50 $parser = new update_xml_parser;
webmaster@1 51 $available = $parser->parse($data);
webmaster@1 52 }
webmaster@1 53 if (!empty($available) && is_array($available)) {
webmaster@1 54 $frequency = variable_get('update_check_frequency', 1);
webmaster@1 55 cache_set('update_info', $available, 'cache_update', time() + (60 * 60 * 24 * $frequency));
webmaster@1 56 variable_set('update_last_check', time());
webmaster@5 57 watchdog('update', 'Fetched information about all available new releases and updates.', array(), WATCHDOG_NOTICE, l(t('view'), 'admin/reports/updates'));
webmaster@1 58 }
webmaster@1 59 else {
webmaster@5 60 watchdog('update', 'Unable to fetch any information about available new releases and updates.', array(), WATCHDOG_ERROR, l(t('view'), 'admin/reports/updates'));
webmaster@1 61 }
webmaster@1 62 return $available;
webmaster@1 63 }
webmaster@1 64
webmaster@1 65 /**
webmaster@1 66 * Generates the URL to fetch information about project updates.
webmaster@1 67 *
webmaster@1 68 * This figures out the right URL to use, based on the project's .info file
webmaster@1 69 * and the global defaults. Appends optional query arguments when the site is
webmaster@1 70 * configured to report usage stats.
webmaster@1 71 *
webmaster@1 72 * @param $project
webmaster@1 73 * The array of project information from update_get_projects().
webmaster@1 74 * @param $site_key
webmaster@1 75 * The anonymous site key hash (optional).
webmaster@1 76 *
webmaster@1 77 * @see update_refresh()
webmaster@1 78 * @see update_get_projects()
webmaster@1 79 */
webmaster@1 80 function _update_build_fetch_url($project, $site_key = '') {
webmaster@1 81 $default_url = variable_get('update_fetch_url', UPDATE_DEFAULT_URL);
webmaster@1 82 if (!isset($project['info']['project status url'])) {
webmaster@1 83 $project['info']['project status url'] = $default_url;
webmaster@1 84 }
webmaster@1 85 $name = $project['name'];
webmaster@1 86 $url = $project['info']['project status url'];
webmaster@1 87 $url .= '/'. $name .'/'. DRUPAL_CORE_COMPATIBILITY;
webmaster@1 88 if (!empty($site_key)) {
webmaster@1 89 $url .= (strpos($url, '?') === TRUE) ? '&' : '?';
webmaster@1 90 $url .= 'site_key=';
webmaster@1 91 $url .= drupal_urlencode($site_key);
webmaster@1 92 if (!empty($project['info']['version'])) {
webmaster@1 93 $url .= '&version=';
webmaster@1 94 $url .= drupal_urlencode($project['info']['version']);
webmaster@1 95 }
webmaster@1 96 }
webmaster@1 97 return $url;
webmaster@1 98 }
webmaster@1 99
webmaster@1 100 /**
webmaster@1 101 * Perform any notifications that should be done once cron fetches new data.
webmaster@1 102 *
webmaster@1 103 * This method checks the status of the site using the new data and depending
webmaster@1 104 * on the configuration of the site, notifys administrators via email if there
webmaster@1 105 * are new releases or missing security updates.
webmaster@1 106 *
webmaster@1 107 * @see update_requirements()
webmaster@1 108 */
webmaster@1 109 function _update_cron_notify() {
webmaster@1 110 include_once './includes/install.inc';
webmaster@1 111 $status = update_requirements('runtime');
webmaster@1 112 $params = array();
webmaster@1 113 foreach (array('core', 'contrib') as $report_type) {
webmaster@1 114 $type = 'update_'. $report_type;
webmaster@1 115 if (isset($status[$type]['severity'])
webmaster@1 116 && $status[$type]['severity'] == REQUIREMENT_ERROR) {
webmaster@1 117 $params[$report_type] = $status[$type]['reason'];
webmaster@1 118 }
webmaster@1 119 }
webmaster@1 120 if (!empty($params)) {
webmaster@1 121 $notify_list = variable_get('update_notify_emails', '');
webmaster@1 122 if (!empty($notify_list)) {
webmaster@1 123 $default_language = language_default();
webmaster@1 124 foreach ($notify_list as $target) {
webmaster@1 125 if ($target_user = user_load(array('mail' => $target))) {
webmaster@1 126 $target_language = user_preferred_language($target_user);
webmaster@1 127 }
webmaster@1 128 else {
webmaster@1 129 $target_language = $default_language;
webmaster@1 130 }
webmaster@1 131 drupal_mail('update', 'status_notify', $target, $target_language, $params);
webmaster@1 132 }
webmaster@1 133 }
webmaster@1 134 }
webmaster@1 135 }
webmaster@1 136
webmaster@1 137 /**
webmaster@1 138 * XML Parser object to read Drupal's release history info files.
webmaster@1 139 * This uses PHP4's lame XML parsing, but it works.
webmaster@1 140 */
webmaster@1 141 class update_xml_parser {
webmaster@1 142 var $projects = array();
webmaster@1 143 var $current_project;
webmaster@1 144 var $current_release;
webmaster@1 145 var $current_term;
webmaster@1 146 var $current_tag;
webmaster@1 147 var $current_object;
webmaster@1 148
webmaster@1 149 /**
webmaster@1 150 * Parse an array of XML data files.
webmaster@1 151 */
webmaster@1 152 function parse($data) {
webmaster@1 153 foreach ($data as $datum) {
webmaster@1 154 $parser = xml_parser_create();
webmaster@1 155 xml_set_object($parser, $this);
webmaster@1 156 xml_set_element_handler($parser, 'start', 'end');
webmaster@1 157 xml_set_character_data_handler($parser, "data");
webmaster@1 158 xml_parse($parser, $datum);
webmaster@1 159 xml_parser_free($parser);
webmaster@1 160 }
webmaster@1 161 return $this->projects;
webmaster@1 162 }
webmaster@1 163
webmaster@1 164 function start($parser, $name, $attr) {
webmaster@1 165 $this->current_tag = $name;
webmaster@1 166 switch ($name) {
webmaster@1 167 case 'PROJECT':
webmaster@1 168 unset($this->current_object);
webmaster@1 169 $this->current_project = array();
webmaster@1 170 $this->current_object = &$this->current_project;
webmaster@1 171 break;
webmaster@1 172 case 'RELEASE':
webmaster@1 173 unset($this->current_object);
webmaster@1 174 $this->current_release = array();
webmaster@1 175 $this->current_object = &$this->current_release;
webmaster@1 176 break;
webmaster@1 177 case 'TERM':
webmaster@1 178 unset($this->current_object);
webmaster@1 179 $this->current_term = array();
webmaster@1 180 $this->current_object = &$this->current_term;
webmaster@1 181 break;
webmaster@1 182 }
webmaster@1 183 }
webmaster@1 184
webmaster@1 185 function end($parser, $name) {
webmaster@1 186 switch ($name) {
webmaster@1 187 case 'PROJECT':
webmaster@1 188 unset($this->current_object);
webmaster@1 189 $this->projects[$this->current_project['short_name']] = $this->current_project;
webmaster@1 190 $this->current_project = array();
webmaster@1 191 break;
webmaster@1 192 case 'RELEASE':
webmaster@1 193 unset($this->current_object);
webmaster@1 194 $this->current_project['releases'][$this->current_release['version']] = $this->current_release;
webmaster@1 195 break;
webmaster@1 196 case 'RELEASES':
webmaster@1 197 $this->current_object = &$this->current_project;
webmaster@1 198 break;
webmaster@1 199 case 'TERM':
webmaster@1 200 unset($this->current_object);
webmaster@1 201 $term_name = $this->current_term['name'];
webmaster@1 202 if (!isset($this->current_release['terms'])) {
webmaster@1 203 $this->current_release['terms'] = array();
webmaster@1 204 }
webmaster@1 205 if (!isset($this->current_release['terms'][$term_name])) {
webmaster@1 206 $this->current_release['terms'][$term_name] = array();
webmaster@1 207 }
webmaster@1 208 $this->current_release['terms'][$term_name][] = $this->current_term['value'];
webmaster@1 209 break;
webmaster@1 210 case 'TERMS':
webmaster@1 211 $this->current_object = &$this->current_release;
webmaster@1 212 break;
webmaster@1 213 default:
webmaster@1 214 $this->current_object[strtolower($this->current_tag)] = trim($this->current_object[strtolower($this->current_tag)]);
webmaster@1 215 $this->current_tag = '';
webmaster@1 216 }
webmaster@1 217 }
webmaster@1 218
webmaster@1 219 function data($parser, $data) {
webmaster@1 220 if ($this->current_tag && !in_array($this->current_tag, array('PROJECT', 'RELEASE', 'RELEASES', 'TERM', 'TERMS'))) {
webmaster@1 221 $tag = strtolower($this->current_tag);
webmaster@1 222 if (isset($this->current_object[$tag])) {
webmaster@1 223 $this->current_object[$tag] .= $data;
webmaster@1 224 }
webmaster@1 225 else {
webmaster@1 226 $this->current_object[$tag] = $data;
webmaster@1 227 }
webmaster@1 228 }
webmaster@1 229 }
webmaster@1 230 }