From 2fe1db36b3ced43ca9b76a5fbc293c845fd13066 Mon Sep 17 00:00:00 2001 From: Frédéric Buclin Date: Mon, 28 Nov 2011 17:10:07 +0100 Subject: Bug 705393: Improve the error message thrown by Update.pm when updates.bugzilla.org is unavailable r=glob a=LpSolit --- Bugzilla/Constants.pm | 7 +++++++ Bugzilla/Update.pm | 26 +++++++++++++------------- template/en/default/index.html.tmpl | 16 +++++++++++----- 3 files changed, 31 insertions(+), 18 deletions(-) diff --git a/Bugzilla/Constants.pm b/Bugzilla/Constants.pm index 5c9fecc57..e44306520 100644 --- a/Bugzilla/Constants.pm +++ b/Bugzilla/Constants.pm @@ -40,6 +40,9 @@ use Memoize; @Bugzilla::Constants::EXPORT = qw( BUGZILLA_VERSION + REMOTE_FILE + LOCAL_FILE + bz_locations IS_NULL @@ -201,6 +204,10 @@ use Memoize; # Bugzilla version use constant BUGZILLA_VERSION => "4.1.3+"; +# Location of the remote and local XML files to track new releases. +use constant REMOTE_FILE => 'http://updates.bugzilla.org/bugzilla-update.xml'; +use constant LOCAL_FILE => 'bugzilla-update.xml'; # Relative to datadir. + # These are unique values that are unlikely to match a string or a number, # to be used in criteria for match() functions and other things. They start # and end with spaces because most Bugzilla stuff has trim() called on it, diff --git a/Bugzilla/Update.pm b/Bugzilla/Update.pm index a94fd167d..c9942a4f0 100644 --- a/Bugzilla/Update.pm +++ b/Bugzilla/Update.pm @@ -20,8 +20,6 @@ use strict; use Bugzilla::Constants; -use constant REMOTE_FILE => 'http://updates.bugzilla.org/bugzilla-update.xml'; -use constant LOCAL_FILE => "/bugzilla-update.xml"; # Relative to datadir. use constant TIME_INTERVAL => 86400; # Default is one day, in seconds. use constant TIMEOUT => 5; # Number of seconds before timeout. @@ -30,26 +28,25 @@ sub get_notifications { return if !Bugzilla->feature('updates'); return if (Bugzilla->params->{'upgrade_notification'} eq 'disabled'); - my $local_file = bz_locations()->{'datadir'} . LOCAL_FILE; + my $local_file = bz_locations()->{'datadir'} . '/' . LOCAL_FILE; # Update the local XML file if this one doesn't exist or if # the last modification time (stat[9]) is older than TIME_INTERVAL. if (!-e $local_file || (time() - (stat($local_file))[9] > TIME_INTERVAL)) { unlink $local_file; # Make sure the old copy is away. - if (-e $local_file) { - return { 'error' => 'no_update', xml_file => $local_file }; - } + return { 'error' => 'no_update' } if (-e $local_file); + my $error = _synchronize_data(); # If an error is returned, leave now. return $error if $error; } # If we cannot access the local XML file, ignore it. - return {'error' => 'no_access', 'xml_file' => $local_file} unless (-r $local_file); + return { 'error' => 'no_access' } unless (-r $local_file); my $twig = XML::Twig->new(); $twig->safe_parsefile($local_file); # If the XML file is invalid, return. - return {'error' => 'corrupted', 'xml_file' => $local_file} if $@; + return { 'error' => 'corrupted' } if $@; my $root = $twig->root; my @releases; @@ -119,7 +116,7 @@ sub get_notifications { } sub _synchronize_data { - my $local_file = bz_locations()->{'datadir'} . LOCAL_FILE; + my $local_file = bz_locations()->{'datadir'} . '/' . LOCAL_FILE; my $ua = LWP::UserAgent->new(); $ua->timeout(TIMEOUT); @@ -133,7 +130,7 @@ sub _synchronize_data { else { $ua->env_proxy; } - $ua->mirror(REMOTE_FILE, $local_file); + my $response = eval { $ua->mirror(REMOTE_FILE, $local_file) }; # $ua->mirror() forces the modification time of the local XML file # to match the modification time of the remote one. @@ -144,11 +141,14 @@ sub _synchronize_data { # Try to alter its last modification time. my $can_alter = utime(undef, undef, $local_file); # This error should never happen. - $can_alter || return {'error' => 'no_update', 'xml_file' => $local_file}; + $can_alter || return { 'error' => 'no_update' }; } - else { + elsif ($response && $response->is_error) { # We have been unable to download the file. - return {'error' => 'cannot_download', 'xml_file' => $local_file}; + return { 'error' => 'cannot_download', 'reason' => $response->status_line }; + } + else { + return { 'error' => 'no_write', 'reason' => $@ }; } # Everything went well. diff --git a/template/en/default/index.html.tmpl b/template/en/default/index.html.tmpl index b1370261f..98648e25e 100644 --- a/template/en/default/index.html.tmpl +++ b/template/en/default/index.html.tmpl @@ -92,18 +92,24 @@ YAHOO.util.Event.onDOMReady(onLoadActions); You can configure this notification from the Parameters page.

[% ELSIF release.error == "cannot_download" %] -

The local XML file '[% release.xml_file FILTER html %]' cannot be created. - Please make sure the web server can write in this directory and that you can access +

The remote file + [%~ constants.REMOTE_FILE FILTER html %] cannot be downloaded + (reason: [% release.reason FILTER html %]).
+ Either the remote server is temporarily unavailable, or your web server cannot access the web. If you are behind a proxy, set the proxy_url parameter correctly.

+ [% ELSIF release.error == "no_write" %] +

The local XML file '[% constants.LOCAL_FILE FILTER html %]' cannot be created + (reason: [% release.reason FILTER html %]).
+ Please make sure the web server can write into this directory. [% ELSIF release.error == "no_update" %] -

The local XML file '[% release.xml_file FILTER html %]' cannot be updated. +

The local XML file '[% constants.LOCAL_FILE FILTER html %]' cannot be updated. Please make sure the web server can edit this file.

[% ELSIF release.error == "no_access" %] -

The local XML file '[% release.xml_file FILTER html %]' cannot be read. +

The local XML file '[% constants.LOCAL_FILE FILTER html %]' cannot be read. Please make sure this file has the correct rights set on it.

[% ELSIF release.error == "corrupted" %] -

The local XML file '[% release.xml_file FILTER html %]' has an invalid XML format. +

The local XML file '[% constants.LOCAL_FILE FILTER html %]' has an invalid XML format. Please delete it and try accessing this page again.

[% ELSIF release.error == "unknown_parameter" %]

'[% Param("upgrade_notification") FILTER html %]' is not a valid notification -- cgit v1.2.3-24-g4f1b