Bug 158658 - relogin.cgi should use a template. This also adds the ability to localise messages. Patch by gerv; r=burnus.

4 files changed, 63 insertions, 16 deletions

diff --git a/relogin.cgi b/relogin.cgi
index d3023c850..3bab9fdc5 100755
--- a/relogin.cgi
+++ b/relogin.cgi
@@ -57,18 +57,12 @@ Set-Cookie: Bugzilla_logincookie= ; path=$cookiepath; expires=Sun, 30-Jun-80 00:
 
 delete $::COOKIE{"Bugzilla_login"};
 
-    $vars->{'title'} = "Logged Out";
-    $vars->{'message'} = "<b>Your login has been forgotten</b>.
-                          The cookie that was remembering your login is 
-                          now gone. You will be prompted for a login the 
-                          next time it is required.";
-    $vars->{'url'} = "query.cgi?GoAheadAndLogIn=1";
-    $vars->{'link'} = "Log in again here";
-    $vars->{'user'} = {};
-    
-    print "Content-Type: text/html\n\n";
-    $template->process("global/message.html.tmpl", $vars)
-      || ThrowTemplateError($template->error());
+$vars->{'message'} = "logged_out";                          
+$vars->{'user'} = {};
+
+print "Content-Type: text/html\n\n";
+$template->process("global/message.html.tmpl", $vars)
+  || ThrowTemplateError($template->error());
 
 exit;
 
diff --git a/template/en/default/global/header.html.tmpl b/template/en/default/global/header.html.tmpl
index a6fe70190..d4cd092f9 100644
--- a/template/en/default/global/header.html.tmpl
+++ b/template/en/default/global/header.html.tmpl
@@ -33,6 +33,10 @@
   # message: string. A message to display to the user. May contain HTML.
   #%]
 
+[% IF message %]
+  [% PROCESS global/messages.html.tmpl %]
+[% END %]
+
 [% DEFAULT
   h1 = title
   h2 = ""
diff --git a/template/en/default/global/message.html.tmpl b/template/en/default/global/message.html.tmpl
index 14e1f10d0..f6cb321c6 100644
--- a/template/en/default/global/message.html.tmpl
+++ b/template/en/default/global/message.html.tmpl
@@ -28,11 +28,10 @@
 
 [% PROCESS global/header.html.tmpl %]
 
-[%# The "header" template automatically displays the contents of a "message"
-    variable if it finds one, so it is not necessary to display the message
-    here. %]
+[%# The "header" template automatically displays a message if it finds one.
+    Note that the global messages list is in messages.html.tmpl. %]
 
-[%# Display a URL if the calling script has included one. %]
+[%# Display a URL if the calling script or message block has included one. %]
 [% IF url && link %]
   <p>
     <a href="[% url %]">[% link %]</a>
diff --git a/template/en/default/global/messages.html.tmpl b/template/en/default/global/messages.html.tmpl
new file mode 100644
index 000000000..2cc25e0c5
--- /dev/null
+++ b/template/en/default/global/messages.html.tmpl
@@ -0,0 +1,50 @@
+<!-- 1.0@bugzilla.org -->
+[%# The contents of this file are subject to the Mozilla Public
+  # License Version 1.1 (the "License"); you may not use this file
+  # except in compliance with the License. You may obtain a copy of
+  # the License at http://www.mozilla.org/MPL/
+  #
+  # Software distributed under the License is distributed on an "AS
+  # IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
+  # implied. See the License for the specific language governing
+  # rights and limitations under the License.
+  #
+  # The Original Code is the Bugzilla Bug Tracking System.
+  #
+  # The Initial Developer of the Original Code is Netscape Communications
+  # Corporation. Portions created by Netscape are
+  # Copyright (C) 1998 Netscape Communications Corporation. All
+  # Rights Reserved.
+  #
+  # Contributor(s): Gervase Markham <gerv@gerv.net>
+  #%]
+  
+[%# This is a list of all the possible messages. Please keep them in
+  # alphabetical order by message tag, and leave a blank line between messages.
+  #%]  
+  
+[% message_tag = message %]
+
+[% message = BLOCK %]
+  [% IF    message_tag == "aaa_example_message_tag" %]
+    [% title = "Example Message" %]
+    This is an example message. The title is set above. This text is the body
+    of the message. It can contain arbitrary <b>HTML</b>, and also references
+    to any [% parameters %] which you may have set.
+
+  [% ELSIF message_tag == "logged_out" %]
+    [% title = "Logged Out" %]
+    [% url = "query.cgi?GoAheadAndLogIn=1" %]
+    [% link = "Log in again." %]
+    <b>Your login has been forgotten</b>.
+    The cookie that was remembering your login is now gone. You will be 
+    prompted for a login the next time it is required.
+
+  [% ELSE %]
+    [%# Cope with legacy calling convention, where "message" was the string
+      # to print. 
+      #%]        
+    [% message_tag %]
+    
+  [% END %]
+[% END %]