Changeset 953

Timestamp:

03/19/07 23:57:48 (20 months ago)

Author:

kake

Message:

Add config option to suppress inline maps on geotagged nodes (#188). Fix preferences to take notice of users turning off inline Google maps (#189).

Location:

trunk

Files:

• Build.PL (modified) (2 diffs)
• Changes (modified) (1 diff)
• INSTALL (modified) (1 diff)
• MANIFEST (modified) (1 diff)
• README.GMAPS (modified) (1 diff)
• lib/OpenGuides.pm (modified) (1 diff)
• lib/OpenGuides/CGI.pm (modified) (1 diff)
• lib/OpenGuides/Config.pm (modified) (4 diffs)
• t/13_cookies.t (modified) (3 diffs)
• t/46_map_in_node_display.t (added)

trunk/Build.PL

@@ -41 +41 @@
    qw(use_plucene enable_page_deletion navbar_on_home_page backlinks_in_title
       moderation_requires_password enable_node_image enable_common_categories
-      enable_common_locales recent_changes_on_home_page);
+      enable_common_locales recent_changes_on_home_page
+      show_gmap_in_node_display);
 
 my $skip_config = Module::Build->y_n("Skip OpenGuides configuration?", "n");
@@ -98 +99 @@
    site_desc default_city default_country contact_email default_language
    formatting_rules_node backlinks_in_title gmaps_api_key centre_long
-   centre_lat default_gmaps_zoom default_gmaps_search_zoom force_wgs84
+   centre_lat show_gmap_in_node_display default_gmaps_zoom
+   default_gmaps_search_zoom force_wgs84
    licence_name licence_url licence_info_url moderation_requires_password
    enable_node_image enable_common_categories enable_common_locales

trunk/Changes

@@ -17 +17 @@
           to make it easier for people to change the order in a custom template
         Move common categories/locales into navbar.
+        Add config option to suppress inline maps on geotagged nodes.
+        Fix preferences to take notice of users turning off inline Google maps.
         Write tests for and fix:
           #48 (Edit conflict page erroneously converts lat/lon to os_x, os_y).

trunk/INSTALL

@@ -220 +220 @@
 The defaults are probably appropriate in most cases.
 
+  "Would you like to display a Google Map on every node that has geodata?"
+
+Answer "y" or "n".  Note that an answer of "y" will only take effect if you've
+supplied a Google Maps API key above.  Note further that users can choose to
+turn this off in their preferences.
+ 
   "Forcibly treat stored lat/long data as if they used the WGS84 ellipsoid?"
 

trunk/MANIFEST

@@ -106 +106 @@
 t/44_node_image.t
 t/45_home_recent_changes.t
+t/46_map_in_node_display.t
 t/51_display_node.t
 t/52_display_diffs.t

trunk/README.GMAPS

@@ -6 +6 @@
 http://www.google.com/apis/maps/signup.html. When you've put this value into
 the config file as gmaps_api_key, the maps become available to you in two
-places. Firstly, if the user has set the user preference to display Google
-Maps, any node which has location information will get an inset map
-pinpointing the location. Secondly, the URL
+places. Firstly, if you've set "show_gmap_in_node_display", and if the user
+has set their preferences to display Google Maps, any node which has
+location information will get an inset map pinpointing the location.
+Secondly, the URL
 http://.../wiki.cgi?action=index;format=map becomes a large map with a list
 of all nodes (regardless of the user settings). The latter will become very

trunk/lib/OpenGuides.pm

@@ -240 +240 @@
                    oldid         => $oldid,
                    enable_gmaps  => 1,
-                   display_google_maps => $self->get_cookie("display_google_maps"),
                    wgs84_long    => $wgs84_long,
                    wgs84_lat     => $wgs84_lat
                );
+
+    if ( $config->show_gmap_in_node_display
+           && $self->get_cookie( "display_google_maps" ) ) {
+        $tt_vars{display_google_maps} = 1;
+    }
 
     # Should we include a standard list of categories or locales?

trunk/lib/OpenGuides/CGI.pm

@@ -156 +156 @@
         %data = $cookies{$cookie_name}->value; # call ->value in list context
     }
-    return ( username                   => $data{user}       || "Anonymous",
-             include_geocache_link      => $data{gclink}     || 0,
-             preview_above_edit_box     => $data{prevab}     || 0,
-             latlong_traditional        => $data{lltrad}     || 0,
-             omit_help_links            => $data{omithlplks} || 0,
-             show_minor_edits_in_rc     => $data{rcmined}    || 0,
-             default_edit_type          => $data{defedit}    || "normal",
-             cookie_expires             => $data{exp}        || "month",
-             track_recent_changes_views => $data{trackrc}    || 0,
-             display_google_maps        => $data{gmaps}      || 1
-           );
+    my %defaults = (
+                     username                   => "Anonymous",
+                     include_geocache_link      => 0,
+                     preview_above_edit_box     => 0,
+                     latlong_traditional        => 0,
+                     omit_help_links            => 0,
+                     show_minor_edits_in_rc     => 0,
+                     default_edit_type          => "normal",
+                     cookie_expires             => "month",
+                     track_recent_changes_views => 0,
+                     display_google_maps        => 1,
+                   );
+    my %long_forms = (
+                       user       => "username",
+                       gclink     => "include_geocache_link",
+                       prevab     => "preview_above_edit_box",
+                       lltrad     => "latlong_traditional",
+                       omithlplks => "omit_help_links",
+                       rcmined    => "show_minor_edits_in_rc",
+                       defedit    => "default_edit_type",
+                       exp        => "cookie_expires",
+                       trackrc    => "track_recent_changes_views",
+                       gmaps      => "display_google_maps",
+                     );
+    my %return;
+    foreach my $key ( keys %long_forms ) {
+        my $long_key = $long_forms{$key};
+        if ( defined $data{$key} ) {
+            $return{$long_key} = $data{$key};
+        } else {
+            $return{$long_key} = $defaults{$long_key};
+        }
+    }
+    return %return;
 }
 

trunk/lib/OpenGuides/Config.pm

@@ -17 +17 @@
    formatting_rules_node formatting_rules_link backlinks_in_title template_path
    custom_template_path geo_handler ellipsoid gmaps_api_key centre_long
+   show_gmap_in_node_display
    centre_lat default_gmaps_zoom default_gmaps_search_zoom force_wgs84
    licence_name licence_url licence_info_url moderation_requires_password
@@ -93 +94 @@
                      geo_handler => 1,
                      ellipsoid => "WGS-84",
+                     show_gmap_in_node_display => 1,
                      centre_long => 0,
                      centre_lat => 0,
@@ -172 +174 @@
         default_gmaps_zoom => "What default zoom level shall we use for Google Maps? (This question can be ignored if you aren't using Google Maps)",
         default_gmaps_search_zoom => "What default zoom level shall we use for Google Maps in the search results? (This question can be ignored if you aren't using Google Maps)",
+        show_gmap_in_node_display => "Would you like to display a Google Map on every node that has geodata? (This question can be ignored if you aren't using Google Maps)",
         force_wgs84 => "Forcibly treat stored lat/long data as if they used the WGS84 ellipsoid?",
         licence_name => "What licence will you use for the guide?",
@@ -282 +285 @@
 =item * default_gmaps_search_zoom
 
+=item * show_gmap_in_node_display
+
 =item * force_wgs84
 

trunk/t/13_cookies.t

@@ -4 +4 @@
 use Time::Piece;
 use Time::Seconds;
-use Test::More tests => 20;
+use Test::More tests => 27;
 
 eval { OpenGuides::CGI->make_prefs_cookie; };
@@ -17 +17 @@
 is( $@, "", "...but not if it is" );
 
+# Use nonsense values here to make sure the test is a good one regardless
+# of defaults - can't do this for cookie_expires, unfortunately.
 my $cookie = OpenGuides::CGI->make_prefs_cookie(
     config                     => $config,
-    username                   => "Kake",
-    include_geocache_link      => 1,
-    preview_above_edit_box     => 1,
-    latlong_traditional        => 1,
-    omit_help_links            => 1,
-    show_minor_edits_in_rc     => 1,
-    default_edit_type          => "tidying",
+    username                   => "un_pref",
+    include_geocache_link      => "gc_pref",
+    preview_above_edit_box     => "pv_pref",
+    latlong_traditional        => "ll_pref",
+    omit_help_links            => "hl_pref",
+    show_minor_edits_in_rc     => "me_pref",
+    default_edit_type          => "et_pref",
     cookie_expires             => "never",
-    track_recent_changes_views => 1,
-    display_google_maps => 1
+    track_recent_changes_views => "rc_pref",
+    display_google_maps        => "gm_pref",
 );
 isa_ok( $cookie, "CGI::Cookie", "->make_prefs_cookie returns a cookie" );
@@ -55 +57 @@
 
 my %prefs = OpenGuides::CGI->get_prefs_from_cookie( config => $config );
-is( $prefs{username}, "Kake",
-    "get_prefs_from_cookie can find username" );
-is( $prefs{include_geocache_link}, 1, "...and geocache prefs" );
-is( $prefs{preview_above_edit_box}, 1, "...and preview prefs" );
-is( $prefs{latlong_traditional}, 1, "...and latlong prefs" );
-is( $prefs{omit_help_links}, 1, "...and help link prefs" );
-is( $prefs{show_minor_edits_in_rc}, 1, "...and minor edits prefs" );
-is( $prefs{default_edit_type}, "tidying", "...and default edit prefs" );
+is( $prefs{username}, "un_pref", "get_prefs_from_cookie can find username" );
+is( $prefs{include_geocache_link}, "gc_pref", "...and geocache prefs" );
+is( $prefs{preview_above_edit_box}, "pv_pref", "...and preview prefs" );
+is( $prefs{latlong_traditional}, "ll_pref", "...and latlong prefs" );
+is( $prefs{omit_help_links}, "hl_pref", "...and help link prefs" );
+is( $prefs{show_minor_edits_in_rc}, "me_pref", "...and minor edits prefs" );
+is( $prefs{default_edit_type}, "et_pref", "...and default edit prefs" );
 is( $prefs{cookie_expires}, "never", "...and requested cookie expiry" );
-ok( $prefs{track_recent_changes_views}, "...and recent changes tracking" );
-is( $prefs{display_google_maps}, 1, "...and Google Maps display preference" );
+is( $prefs{track_recent_changes_views}, "rc_pref",
+                                     "...and recent changes tracking" );
+is( $prefs{display_google_maps}, "gm_pref",
+                                     "...and Google Maps display preference" );
+
+# Now make sure that true/false preferences are taken account of when
+# they're false.
+$cookie = OpenGuides::CGI->make_prefs_cookie(
+    config                     => $config,
+    include_geocache_link      => 0,
+    preview_above_edit_box     => 0,
+    latlong_traditional        => 0,
+    omit_help_links            => 0,
+    show_minor_edits_in_rc     => 0,
+    track_recent_changes_views => 0,
+    display_google_maps        => 0,
+);
+
+$ENV{HTTP_COOKIE} = $cookie;
+
+%prefs = OpenGuides::CGI->get_prefs_from_cookie( config => $config );
+ok( !$prefs{include_geocache_link}, "geocache prefs taken note of when false");
+ok( !$prefs{preview_above_edit_box}, "...and preview prefs" );
+ok( !$prefs{latlong_traditional}, "...and latlong prefs" );
+ok( !$prefs{omit_help_links}, "...and help link prefs" );
+ok( !$prefs{show_minor_edits_in_rc}, "...and minor edits prefs" );
+ok( !$prefs{track_recent_changes_views}, "...and recent changes prefs" );
+ok( !$prefs{display_google_maps}, "...and Google Maps prefs" );
 
 # Check that cookie parsing fails nicely if no cookie set.