Changeset 1015

Timestamp:

04/03/07 02:13:11 (20 months ago)

Author:

kake

Message:

Add config options to let admins omit category and/or locale pages from the list of pages that can be returned by the Random Page link (first half of ticket #200).

Location:

trunk

Files:

• Build.PL (modified) (2 diffs)
• Changes (modified) (1 diff)
• INSTALL (modified) (1 diff)
• lib/OpenGuides.pm (modified) (1 diff)
• lib/OpenGuides/Config.pm (modified) (4 diffs)
• t/57_random_page.t (modified) (2 diffs)

trunk/Build.PL

@@ -42 +42 @@
       moderation_requires_password enable_node_image enable_common_categories
       enable_common_locales recent_changes_on_home_page
+      random_page_omits_locales random_page_omits_categories
       content_above_navbar_in_html show_gmap_in_node_display);
 
@@ -96 +97 @@
    custom_lib_path use_plucene indexing_directory enable_page_deletion
    admin_pass stylesheet_url site_name navbar_on_home_page
-   recent_changes_on_home_page content_above_navbar_in_html home_name
+   recent_changes_on_home_page random_page_omits_locales
+   random_page_omits_categories content_above_navbar_in_html home_name
    site_desc default_city default_country contact_email default_language
    formatting_rules_node backlinks_in_title gmaps_api_key centre_long

trunk/Changes

@@ -7 +7 @@
         Move random page functionality from wiki.cgi into OpenGuides.pm and
           add some tests.
+        Add config options to let admins omit category and/or locale pages
+          from the list of pages that can be returned by the Random Page link.
         Use full URLs for all links in navbar, so people can INCLUDE navbar.tt
           in their own scripts.  (May revisit this later using "base href".)

trunk/INSTALL

@@ -156 +156 @@
 
 Answer "y" or "n".
+
+
+  "Do you want the Random Page link to avoid returning a locale page?
+  "Do you want the Random Page link to avoid returning a category page?
+
+Answer "y" or "n".  The defaults are "n", which means that Random Page is as
+likely to return a category or locale page as anything else.  If the category
+and locale pages on your Guide are generally just lists of things in that
+category/locale, you probably want to pick "y" here.  If, on the other hand,
+your category/locale pages generally have substantial content of their own,
+you may prefer to choose "n".
 
 

trunk/lib/OpenGuides.pm

@@ -343 +343 @@
 sub display_random_page {
     my ( $self, %args ) = @_;
-    my @nodes = $self->wiki->list_all_nodes();
+    my $wiki = $self->wiki;
+    my $config = $self->config;
+
+    my @nodes = $wiki->list_all_nodes();
+
+    my $omit_cats = $config->random_page_omits_categories;
+    my $omit_locs = $config->random_page_omits_locales;
+
+    if ( $omit_cats || $omit_locs ) {
+        my %all_nodes = map { $_ => $_ } @nodes;
+        if ( $omit_cats ) {
+            my @cats = $wiki->list_nodes_by_metadata(
+                                                  metadata_type  => "category",
+                                                  metadata_value => "category",
+                                                  ignore_case => 1,
+            );
+            foreach my $omit ( @cats ) {
+                delete $all_nodes{$omit};
+            }
+        }
+        if ( $omit_locs ) {
+            my @locs = $wiki->list_nodes_by_metadata(
+                                                  metadata_type  => "category",
+                                                  metadata_value => "locales",
+                                                  ignore_case => 1,
+            );
+            foreach my $omit ( @locs ) {
+                delete $all_nodes{$omit};
+            }
+        }
+        @nodes = keys %all_nodes;
+    }
     my $node = $nodes[ rand @nodes ];
     my $output = $self->redirect_to_node( $node );

trunk/lib/OpenGuides/Config.pm

@@ -12 +12 @@
    custom_lib_path use_plucene indexing_directory enable_page_deletion
    admin_pass stylesheet_url site_name navbar_on_home_page
-   recent_changes_on_home_page content_above_navbar_in_html home_name
+   recent_changes_on_home_page random_page_omits_locales
+   random_page_omits_categories content_above_navbar_in_html home_name
    site_desc default_city default_country contact_email
    default_language http_charset ping_services
@@ -83 +84 @@
                      navbar_on_home_page => 1,
                      recent_changes_on_home_page => 1,
+                     random_page_omits_locales => 0,
+                     random_page_omits_categories => 0,
                      content_above_navbar_in_html => 0,
                      home_name => "Home",
@@ -159 +162 @@
         navbar_on_home_page => "Do you want the navigation bar included on the home page?",
         recent_changes_on_home_page => "Do you want the ten most recent changes included on the home page?",
+        random_page_omits_locales => "Do you want the \"Random Page\" link to avoid returning a locale page?",
+        random_page_omits_categories => "Do you want the \"Random Page\" link to avoid returning a category page?",
         content_above_navbar_in_html => "Do you want the content to appear above the navbar in the HTML?",
         home_name => "What should the home page of the wiki be called?",
@@ -254 +259 @@
 =item * recent_changes_on_home_page (default: true)
 
+=item * random_page_omits_locales (default: false)
+
+=item * random_page_omits_categories (default: false)
+
 =item * content_above_navbar_in_html (default: false)
 

trunk/t/57_random_page.t

@@ -11 +11 @@
 }
 
-plan tests => 2;
+plan tests => 4;
 
-# Clear out the database from any previous runs.
-unlink "t/node.db";
-unlink <t/indexes/*>;
+my ( $config, $guide, $wiki );
 
-Wiki::Toolkit::Setup::SQLite::setup( { dbname => "t/node.db" } );
-my $config = OpenGuides::Test->make_basic_config;
+# Clear out database from previous runs, set up a guide.
+refresh_db();
+$config = OpenGuides::Test->make_basic_config;
 $config->script_url( "http://www.example.com/" );
 $config->script_name( "wiki.cgi" );
-my $guide = OpenGuides->new( config => $config );
-my $wiki = $guide->wiki;
+$guide = OpenGuides->new( config => $config );
+$wiki = $guide->wiki;
 
 # Write some data.
@@ -41 +40 @@
       "->display_random_page makes a redirect" );
 
-my $node_param = $output;
-$node_param =~ s/^.*\?//s;
-$node_param =~ s/\s+$//;
-my $formatter = $guide->wiki->formatter;
-my $node = $formatter->node_param_to_node_name( $node_param );
+my $node = get_node_from_output( $output );
 print "# Random node chosen: $node\n";
 ok( $nodes{$node}, "...to an existing node" );
+
+# Clear the database and write some data including categories and locales.
+refresh_db();
+$config = OpenGuides::Test->make_basic_config;
+$config->script_url( "http://www.example.com/" );
+$config->script_name( "wiki.cgi" );
+$guide = OpenGuides->new( config => $config );
+$wiki = $guide->wiki;
+
+# Write data including some categories/locales.
+OpenGuides::Test->write_data(
+                              guide         => $guide,
+                              node          => "Red Lion",
+                              locales       => "Hammersmith",
+                              categories    => "Pubs",
+                              return_output => 1,
+                            );
+
+# Check we can turn off locales.
+$config = OpenGuides::Test->make_basic_config;
+$config->script_url( "http://www.example.com/" );
+$config->script_name( "wiki.cgi" );
+$config->random_page_omits_locales( 1 );
+$guide = OpenGuides->new( config => $config );
+$wiki = $guide->wiki;
+$output = $guide->display_random_page( return_output => 1 );
+$node = get_node_from_output( $output );
+print "# Random node chosen: $node\n";
+isnt( $node, "Locale Hammersmith", "locale nodes not picked up as random page "
+                       . "(this test may sometimes pass when it shouldn't)" );
+
+# Check we can turn off categories.
+$config = OpenGuides::Test->make_basic_config;
+$config->script_url( "http://www.example.com/" );
+$config->script_name( "wiki.cgi" );
+$config->random_page_omits_categories( 1 );
+$guide = OpenGuides->new( config => $config );
+$wiki = $guide->wiki;
+$output = $guide->display_random_page( return_output => 1 );
+$node = get_node_from_output( $output );
+print "# Random node chosen: $node\n";
+isnt( $node, "Category Pubs", "category nodes not picked up as random page "
+                       . "(this test may sometimes pass when it shouldn't)" );
+
+sub refresh_db {
+    unlink "t/node.db";
+    unlink <t/indexes/*>;
+    Wiki::Toolkit::Setup::SQLite::setup( { dbname => "t/node.db" } );
+}
+
+sub get_node_from_output {
+    my $node_param = shift;
+    $node_param =~ s/^.*\?//s;
+    $node_param =~ s/\s+$//;
+    my $formatter = $guide->wiki->formatter;
+    my $node = $formatter->node_param_to_node_name( $node_param );
+    return $node;
+}