Changeset 1084

Timestamp:

06/16/07 22:33:16 (16 months ago)

Author:

ilmari

Message:

Preferences cleanup
- Separate preference defaulting from cookie parsing.
- Remove duplicate preference defaulting from the cgi.
- Use the prefs template variable in the template.

Location:

trunk

Files:

• lib/OpenGuides/CGI.pm (modified) (1 diff)
• preferences.cgi (modified) (3 diffs)
• templates/preferences.tt (modified) (15 diffs)

trunk/lib/OpenGuides/CGI.pm

@@ -156 +156 @@
         %data = $cookies{$cookie_name}->value; # call ->value in list context
     }
+
+    return $class->get_prefs_from_hash( %data );
+}
+
+sub get_prefs_from_hash {
+    my ($class, %data) = @_;
     my %defaults = (
                      username                   => "Anonymous",

trunk/preferences.cgi

@@ -23 +23 @@
 
 sub set_preferences {
-    my $username     = $cgi->param("username")                   || "";
-    my $gc_link      = $cgi->param("include_geocache_link")      || 0;
-    my $pre_above    = $cgi->param("preview_above_edit_box")     || 0;
-    my $latlong_trad = $cgi->param("latlong_traditional")        || 0;
-    my $omit_hlplnks = $cgi->param("omit_help_links")            || 0;
-    my $rc_minor_eds = $cgi->param("show_minor_edits_in_rc")     || 0;
-    my $edit_type    = $cgi->param("default_edit_type")          || "normal";
-    my $expires      = $cgi->param("cookie_expires")             || "month";
-    my $track_rc     = $cgi->param("track_recent_changes_views") || 0;
-    my $gmaps        = $cgi->param("display_google_maps")        || 0;
+    my %prefs = OpenGuides::CGI->get_prefs_from_hash( $cgi->Vars );
     my $prefs_cookie = OpenGuides::CGI->make_prefs_cookie(
         config => $config,
-        username => $username,
-        include_geocache_link  => $gc_link,
-        preview_above_edit_box => $pre_above,
-        latlong_traditional    => $latlong_trad,
-        omit_help_links        => $omit_hlplnks,
-        show_minor_edits_in_rc => $rc_minor_eds,
-        default_edit_type      => $edit_type,
-        cookie_expires         => $expires,
-        track_recent_changes_views => $track_rc,
-        display_google_maps    => $gmaps
+        %prefs,
     );
     my @cookies = ( $prefs_cookie );
@@ -63 +45 @@
         vars     => {
                       not_editable               => 1,
-                      username                   => $username,
-                      include_geocache_link      => $gc_link,
-                      preview_above_edit_box     => $pre_above,
-                      latlong_traditional        => $latlong_trad,
-                      omit_help_links            => $omit_hlplnks,
-                      show_minor_edits_in_rc     => $rc_minor_eds,
-                      default_edit_type          => $edit_type,
-                      cookie_expires             => $expires,
-                      track_recent_changes_views => $track_rc,
-                      display_google_maps        => $gmaps
+                      %prefs,
                     }
     );
@@ -78 +51 @@
 
 sub show_form {
-    # Get defaults for form fields from cookies.
-    my %prefs = OpenGuides::CGI->get_prefs_from_cookie( config => $config );
-
     print OpenGuides::Template->output(
         wiki     => $wiki,
         config   => $config,
         template => "preferences.tt",
-        vars     => { %prefs,
+        vars     => { 
                       not_editable => 1,
                       show_form    => 1

trunk/templates/preferences.tt

@@ -14 +14 @@
 
     <p>
-    [% IF preview_above_edit_box %]
+    [% IF prefs.preview_above_edit_box %]
       <input type="checkbox" id="preview_above" name="preview_above_edit_box" value="1" checked />
     [% ELSE %]
@@ -23 +23 @@
 
     <p>
-    [% IF include_geocache_link %]
+    [% IF prefs.include_geocache_link %]
       <input type="checkbox" id="geocache" name="include_geocache_link" value="1" checked />
     [% ELSE %]
@@ -32 +32 @@
 
     <p>
-    [% IF latlong_traditional %]
+    [% IF prefs.latlong_traditional %]
       <input type="checkbox" id="latlong" name="latlong_traditional" value="1" checked />
     [% ELSE %]
@@ -41 +41 @@
 
     <p>
-    [% IF omit_help_links %]
+    [% IF prefs.omit_help_links %]
       <input type="checkbox" id="omit_help" name="omit_help_links" value="1" checked />
     [% ELSE %]
@@ -50 +50 @@
 
     <p>
-    [% IF show_minor_edits_in_rc %]
+    [% IF prefs.show_minor_edits_in_rc %]
       <input type="checkbox" id="show_minor" name="show_minor_edits_in_rc" value="1" checked />
     [% ELSE %]
@@ -59 +59 @@
 
     <p>
-      [% IF track_recent_changes_views %]
+      [% IF prefs.track_recent_changes_views %]
         <input type="checkbox" id="track_recent_changes_views" name="track_recent_changes_views" value="1" checked="1" />
       [% ELSE %]
@@ -69 +69 @@
     [% IF gmaps_api_key AND config.show_gmap_in_node_display %]
       <p>
-        [% IF display_google_maps %]
+        [% IF prefs.display_google_maps %]
           <input type="checkbox" id="display_google_maps" name="display_google_maps" value="1" checked="1" />
         [% ELSE %]
@@ -81 +81 @@
       <label for="default_edit_type">Default edit type:</label>
       <select name="default_edit_type" id="default_edit_type">
-        [% IF default_edit_type == 'normal' %]
+        [% IF prefs.default_edit_type == 'normal' %]
           <option value="normal" selected="1">Normal edit</option>
           <option value="tidying">Minor tidying</option>
@@ -94 +94 @@
       <label for="cookie_expires">Preferences expire:</label>
       <select name="cookie_expires" id="cookie_expires">
-        [% IF cookie_expires == 'never' %]
+        [% IF prefs.cookie_expires == 'never' %]
           <option value="month">in one month</option>
           <option value="year">in one year</option>
           <option value="never" selected="1">never</option>
-        [% ELSIF cookie_expires == "year" %]
+        [% ELSIF prefs.cookie_expires == "year" %]
           <option value="month">in one month</option>
           <option value="year" selected="1">in one year</option>
@@ -121 +121 @@
 
   <p>Preview area shown
-    [% IF preview_above_edit_box %]
+    [% IF prefs.preview_above_edit_box %]
       above
     [% ELSE %]
@@ -133 +133 @@
 
   <p>Latitude and longitude displayed as
-    [% IF latlong_traditional %]
+    [% IF prefs.latlong_traditional %]
       degrees and minutes.
     [% ELSE %]
@@ -141 +141 @@
 
   <p>Help links will
-    [% IF omit_help_links %] not [% END %]
+    [% IF prefs.omit_help_links %] not [% END %]
     be included in navbar.
   </p>
@@ -153 +153 @@
   be tracked.</p>
 
-  [% IF gmaps_api_key AND config.show_gmap_in_node_display %]
+  [% IF prefs.gmaps_api_key AND config.show_gmap_in_node_display %]
     <p>Google Maps will
       [% UNLESS display_google_maps %] not [% END %]
@@ -160 +160 @@
 
   <p>Default edit type set to
-    [% IF default_edit_type == 'normal' %]
+    [% IF prefs.default_edit_type == 'normal' %]
       &#8220;Normal edit&#8221;.
     [% ELSE %]
@@ -168 +168 @@
 
   <p>Your preferences will
-    [% IF cookie_expires == 'never' %]
+    [% IF prefs.cookie_expires == 'never' %]
       never expire.
-    [% ELSIF cookie_expires == 'year' %]
+    [% ELSIF prefs.cookie_expires == 'year' %]
       expire in one year.
     [% ELSE %]