summaryrefslogtreecommitdiff
path: root/modules/update/update.fetch.inc
diff options
context:
space:
mode:
authorDries Buytaert <dries@buytaert.net>2007-07-11 15:15:40 +0000
committerDries Buytaert <dries@buytaert.net>2007-07-11 15:15:40 +0000
commit6ec2ff7e1563f7da82f9411878e2c7482b671983 (patch)
tree484b05be33ba384db140fa8f3f3c7386fa2c63f9 /modules/update/update.fetch.inc
parent70f9297c100eaa1736b8e136a2e32c9d87b56de4 (diff)
downloadbrdo-6ec2ff7e1563f7da82f9411878e2c7482b671983.tar.gz
brdo-6ec2ff7e1563f7da82f9411878e2c7482b671983.tar.bz2
- Patch #94154 by dww, Earl et al: update notifications for Drupal!
Woot, woot! :)
Diffstat (limited to 'modules/update/update.fetch.inc')
-rw-r--r--modules/update/update.fetch.inc223
1 files changed, 223 insertions, 0 deletions
diff --git a/modules/update/update.fetch.inc b/modules/update/update.fetch.inc
new file mode 100644
index 000000000..c6b108c0b
--- /dev/null
+++ b/modules/update/update.fetch.inc
@@ -0,0 +1,223 @@
+<?php
+// $Id$
+
+/**
+ * @file
+ * Code required only when fetching information about available updates.
+ */
+
+/**
+ * Callback to manually check the update status without cron.
+ */
+function update_manual_status() {
+ if (_update_refresh()) {
+ drupal_set_message(t('Fetched information about all available new releases and updates.'));
+ }
+ else {
+ drupal_set_message(t('Unable to fetch any information on available new releases and updates.'), 'error');
+ }
+ drupal_goto('admin/logs/updates');
+}
+
+/**
+ * Fetch project info via XML from a central server.
+ */
+function _update_refresh() {
+ global $base_url;
+ include_once './modules/update/update.compare.inc';
+
+ $available = array();
+ $data = array();
+ $site_key = '';
+ $drupal_private_key = variable_get('drupal_private_key', '');
+ $site_key = md5($base_url . $drupal_private_key);
+ $projects = update_get_projects();
+
+ foreach ($projects as $key => $project) {
+ $url = _update_build_fetch_url($project, $site_key);
+ $xml = drupal_http_request($url);
+ if (isset($xml->data)) {
+ $data[] = $xml->data;
+ }
+ }
+
+ if ($data) {
+ $parser = new update_xml_parser;
+ $available = $parser->parse($data);
+ $frequency = variable_get('update_check_frequency', 1);
+ cache_set('update_info', $available, 'cache_update', time() + (60 * 60 * 24 * $frequency));
+ variable_set('update_last_check', time());
+ watchdog('update', 'Fetched information on all available new releases and updates.', array(), WATCHDOG_NOTICE, l('view', 'admin/logs/updates'));
+ }
+ else {
+ watchdog('update', 'Unable to fetch any information on available new releases and updates.', array(), WATCHDOG_ERROR, l('view', 'admin/logs/updates'));
+ }
+ return $available;
+}
+
+/**
+ * Generates the URL to fetch information about project updates.
+ *
+ * This figures out the right URL to use, based on the project's .info file
+ * and the global defaults. Appends optional query arguments when the site is
+ * configured to report usage stats.
+ *
+ * @param $project
+ * The array of project information from update_get_projects().
+ * @param $site_key
+ * The anonymous site key hash (optional).
+ *
+ * @see update_refresh()
+ * @see update_get_projects()
+ */
+function _update_build_fetch_url($project, $site_key = '') {
+ $default_url = variable_get('update_fetch_url', UPDATE_DEFAULT_URL);
+ if (!isset($project['info']['project status url'])) {
+ $project['info']['project status url'] = $default_url;
+ }
+ $name = $project['name'];
+ $url = $project['info']['project status url'];
+ $url .= '/'. $name .'/'. DRUPAL_CORE_COMPATIBILITY;
+ if (!empty($site_key)) {
+ $url .= (strpos($url, '?') === TRUE) ? '&' : '?';
+ $url .= 'site_key=';
+ $url .= drupal_urlencode($site_key);
+ if (!empty($project['info']['version'])) {
+ $url .= '&version=';
+ $url .= drupal_urlencode($project['info']['version']);
+ }
+ }
+ return $url;
+}
+
+/**
+ * Perform any notifications that should be done once cron fetches new data.
+ *
+ * This method checks the status of the site using the new data and depending
+ * on the configuration of the site, notifys administrators via email if there
+ * are new releases or missing security updates.
+ *
+ * @see update_requirements()
+ */
+function _update_cron_notify() {
+ include_once './includes/install.inc';
+ $status = update_requirements('runtime');
+ $params = array();
+ foreach (array('core', 'contrib') as $report_type) {
+ $type = 'update_'. $report_type;
+ if (isset($status[$type]['severity'])
+ && $status[$type]['severity'] == REQUIREMENT_ERROR) {
+ $params[$report_type] = $status[$type]['reason'];
+ }
+ }
+ if (!empty($params)) {
+ $notify_list = variable_get('update_notify_emails', '');
+ if (!empty($notify_list)) {
+ $default_language = language_default();
+ foreach ($notify_list as $target) {
+ if ($target_user = user_load(array('mail' => $target))) {
+ $target_language = user_preferred_language($target_user);
+ }
+ else {
+ $target_language = $default_language;
+ }
+ drupal_mail('update', 'status_notify', $target, $target_language, $params);
+ }
+ }
+ }
+}
+
+/**
+ * XML Parser object to read Drupal's release history info files.
+ * This uses PHP4's lame XML parsing, but it works.
+ */
+class update_xml_parser {
+ var $projects = array();
+ var $current_project;
+ var $current_release;
+ var $current_term;
+ var $current_tag;
+ var $current_object;
+
+ /**
+ * Parse an array of XML data files.
+ */
+ function parse($data) {
+ foreach ($data as $datum) {
+ $parser = xml_parser_create();
+ xml_set_object($parser, $this);
+ xml_set_element_handler($parser, 'start', 'end');
+ xml_set_character_data_handler($parser, "data");
+ xml_parse($parser, $datum);
+ xml_parser_free($parser);
+ }
+ return $this->projects;
+ }
+
+ function start($parser, $name, $attr) {
+ $this->current_tag = $name;
+ switch ($name) {
+ case 'PROJECT':
+ unset($this->current_object);
+ $this->current_project = array();
+ $this->current_object = &$this->current_project;
+ break;
+ case 'RELEASE':
+ unset($this->current_object);
+ $this->current_release = array();
+ $this->current_object = &$this->current_release;
+ break;
+ case 'TERM':
+ unset($this->current_object);
+ $this->current_term = array();
+ $this->current_object = &$this->current_term;
+ break;
+ }
+ }
+
+ function end($parser, $name) {
+ switch ($name) {
+ case 'PROJECT':
+ unset($this->current_object);
+ $this->projects[$this->current_project['short_name']] = $this->current_project;
+ $this->current_project = array();
+ break;
+ case 'RELEASE':
+ unset($this->current_object);
+ $this->current_project['releases'][$this->current_release['version']] = $this->current_release;
+ break;
+ case 'RELEASES':
+ $this->current_object = &$this->current_project;
+ break;
+ case 'TERM':
+ unset($this->current_object);
+ $term_name = $this->current_term['name'];
+ if (!isset($this->current_release['terms'])) {
+ $this->current_release['terms'] = array();
+ }
+ if (!isset($this->current_release['terms'][$term_name])) {
+ $this->current_release['terms'][$term_name] = array();
+ }
+ $this->current_release['terms'][$term_name][] = $this->current_term['value'];
+ break;
+ case 'TERMS':
+ $this->current_object = &$this->current_release;
+ break;
+ default:
+ $this->current_object[strtolower($this->current_tag)] = trim($this->current_object[strtolower($this->current_tag)]);
+ $this->current_tag = '';
+ }
+ }
+
+ function data($parser, $data) {
+ if ($this->current_tag && !in_array($this->current_tag, array('PROJECT', 'RELEASE', 'RELEASES', 'TERM', 'TERMS'))) {
+ $tag = strtolower($this->current_tag);
+ if (isset($this->current_object[$tag])) {
+ $this->current_object[$tag] .= $data;
+ }
+ else {
+ $this->current_object[$tag] = $data;
+ }
+ }
+ }
+}