Ticket #81: ticket_81.patch

trunk/templates/node.tt

@@ -26 +26 @@
 [% END %]
 
 [% IF current %]
-  [% IF backlinks_in_title AND is_indexable_node %]
-    <h2 class="node_name"><a href="[% cgi_url %]?action=index;index_type=[% CGI.escape(index_type) %];index_value=[% CGI.escape(index_value) %]">[% node_name %]</a></h2>
-  [% ELSIF backlinks_in_title %]
+  [% IF backlinks_in_title %]
     <h2 class="node_name"><a href="[% cgi_url %]?action=show_backlinks&id=[% CGI.escape(node_name) %]">[% node_name %]</a></h2>
   [% ELSE %]
     <h2 class="node_name">[% node_name %]</h2>

trunk/INSTALL

@@ -249 +249 @@
 National Grid, Geography::NationalGrid::IE to use the Irish National
 Grid, and Geo::Coordinates::UTM to use a UTM ellipsoid.
 
+
+  "Prefix to add to automatically generated category names?"
+  "Prefix to add to automatically generated locale names?"
+
+If a user specifies a category or locale for a node which does not exist, a
+node for that category or locale will be automatically generated. By default, a
+category of "Foo" will lead to a node titled "Category Foo", and a locale of
+"Bar" will lead to a node titled "Category Bar". These options allow this
+behaviour to be changed.
+
 * Dependency errors
 
 If, after you have answered these questions, the build script complains

trunk/lib/OpenGuides/Config.pm

@@ -12 +12 @@
    formatting_rules_node formatting_rules_link backlinks_in_title template_path
    custom_template_path geo_handler ellipsoid gmaps_api_key centre_long
    centre_lat default_gmaps_zoom default_gmaps_search_zoom force_wgs84
+   category_prefix locale_prefix
 );
 my @questions = map { $_ . "__qu" } @variables;
 OpenGuides::Config->mk_accessors( @variables );
@@ -82 +83 @@
                      centre_lat => 0,
                      default_gmaps_zoom => 5,
                      default_gmaps_search_zoom => 3,
-                     force_wgs84 => 0
+                     force_wgs84 => 0,
+                     category_prefix => "Category ",
+                     locale_prefix => "Locale ",
                    );
 
     # See if we already have some config variables set.
@@ -145 +148 @@
         centre_lat => "What is the latitude of the centre point of a map to draw for your guide? (This question can be ignored if you aren't using Google Maps)",
         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)",
-        force_wgs84 => "Forcibly treat stored lat/long data as if they used the WGS84 ellipsoid?"
+        force_wgs84 => "Forcibly treat stored lat/long data as if they used the WGS84 ellipsoid?",
+        category_prefix => "Prefix to add to automatically generated category names?",
+        locale_prefix => "Prefix to add to automatically generated locale names?"
     );
 
     foreach my $var ( keys %questions ) {
@@ -246 +251 @@
 
 =item * force_wgs84
 
+=item * category_prefix
+
+=item * locale_prefix
+
 =back
 
 =head1 AUTHOR

trunk/lib/OpenGuides/Template.pm

@@ -268 +268 @@
                         split("\r\n", $locales_text);
     }
 
+    my $category_prefix = ( $config->category_prefix ne '' ? $config->category_prefix . ' ' : '');
+    my $locale_prefix = ( $config->locale_prefix ne '' ? $config->locale_prefix . ' ' : '');
+
     my @categories = map { { name => $_,
-                             url  => "$script_name?Category_"
-            . uri_escape($formatter->node_name_to_node_param($_)) } } @catlist;
+                             url  => "$script_name?"
+            . uri_escape($formatter->node_name_to_node_param($category_prefix . $_)) } } @catlist;
 
     my @locales    = map { { name => $_,
-                             url  => "$script_name?Locale_"
-            . uri_escape($formatter->node_name_to_node_param($_)) } } @loclist;
+                             url  => "$script_name?"
+            . uri_escape($formatter->node_name_to_node_param($locale_prefix . $_)) } } @loclist;
 
     # The 'website' attribute might contain a URL so we wiki-format it here
     # rather than just CGI::escapeHTMLing it all in the template.

trunk/lib/OpenGuides/Utils.pm

@@ -113 +113 @@
     my $script_name = $config->script_name;
     my $search_url = $config->script_url . "search.cgi";
 
+    my $locale_prefix = $config->locale_prefix;
+    my $category_prefix = $config->category_prefix;
+
     my %macros = (
         '@SEARCHBOX' =>
             qq(<form action="$search_url" method="get"><input type="text" size="20" name="search"><input type="submit" name="Go" value="Search"></form>),
@@ -127 +130 @@
                   my $link_title = $_[2] || "View all pages in $_[0] $_[1]";
                   return qq(<a href="$script_name?action=index;index_type=) . uri_escape(lc($_[0])) . qq(;index_value=) . uri_escape($_[1]) . qq(">$link_title</a>);
                 },
+        qr/\@LOCALE_LINK\s+\[\[($locale_prefix)\s*([^\]|]+)\|?([^\]]+)?\]\]/ =>
+            sub {
+                  # We may be being called by CGI::Wiki::Plugin::Diff,
+                  # which doesn't know it has to pass us $wiki - and
+                  # we don't use it anyway.
+                  if ( UNIVERSAL::isa( $_[0], "CGI::Wiki" ) ) {
+                      shift; # just throw it away
+                  }
+                  my $localename = $_[0] || "Locale";
+                  my $link_title = $_[2] || "View all pages in $localename $_[1]";
+                  return qq(<a href="$script_name?action=index;index_type=category;index_value=) . uri_escape($_[1]) . qq(">$link_title</a>);
+                },
+        qr/\@CATEGORY_LINK\s+\[\[($category_prefix)\s*([^\]|]+)\|?([^\]]+)?\]\]/ =>
+            sub {
+                  # We may be being called by CGI::Wiki::Plugin::Diff,
+                  # which doesn't know it has to pass us $wiki - and
+                  # we don't use it anyway.
+                  if ( UNIVERSAL::isa( $_[0], "CGI::Wiki" ) ) {
+                      shift; # just throw it away
+                  }
+                  my $categoryname = $_[0] || "Category";
+                  my $link_title = $_[2] || "View all pages in $categoryname $_[1]";
+                  return qq(<a href="$script_name?action=index;index_type=category;index_value=) . uri_escape($_[1]) . qq(">$link_title</a>);
+                },
         qr/\@INDEX_LIST\s+\[\[(Category|Locale)\s+([^\]]+)]]/ =>
              sub {
                    my ($wiki, $type, $value) = @_;
@@ -135 +162 @@
                    # which doesn't know it has to pass us $wiki
                    unless ( UNIVERSAL::isa( $wiki, "CGI::Wiki" ) ) {
                        return "(unprocessed INDEX_LIST macro)";
-                   }
+                           }
 
                    my @nodes = sort $wiki->list_nodes_by_metadata(
                        metadata_type  => $type,
@@ -154 +181 @@
                                                                 link => $node,
                                                               )
                                 . "\n";
-                   }
+                       }
                    return $return;
                  },
         qr/\@RSS\s+(.+)/ => sub {

trunk/lib/OpenGuides.pm

@@ -147 +147 @@
 
     my %tt_vars;
 
-    if ( $id =~ /^(Category|Locale) (.*)$/ ) {
-        my $type = $1;
-        $tt_vars{is_indexable_node} = 1;
-        $tt_vars{index_type} = lc($type);
-        $tt_vars{index_value} = $2;
-        $tt_vars{"rss_".lc($type)."_url"} =
-                           $config->script_name . "?action=rc;format=rss;"
-                           . lc($type) . "=" . lc(CGI->escape($2));
-    }
-
     my %current_data = $wiki->retrieve_node( $id );
     my $current_version = $current_data{version};
     undef $version if ($version && $version == $current_version);
@@ -492 +482 @@
 sub show_index {
     my ($self, %args) = @_;
     my $wiki = $self->wiki;
+    my $config = $self->config;
     my $formatter = $wiki->formatter;
     my %tt_vars;
     my @selnodes;
@@ -512 +503 @@
                 metadata_value => $args{value},
                 ignore_case    => 1
             );
-            my $name = ucfirst($args{type}) . " $args{value}";
+            my $name_prefix;
+            my $type_prefix;
+            if ( $args{type} eq 'category' or $args{type} eq 'locale' ) {
+                $type_prefix = $config->category_prefix;
+                $type_prefix .= ' ' if ( $type_prefix ne '' );
+                $name_prefix = $type_prefix || $args{type};
+            } else {
+                # Not sure this should ever be reached, actually
+                $type_prefix = ucfirst($args{type}) . ' ';
+                $name_prefix = $type_prefix;
+            }
             my $url = $self->config->script_name
                       . "?"
-                      . ucfirst( $args{type} )
-                      . "_"
                       . uri_escape(
-                                      $formatter->node_name_to_node_param($args{value})
+                                      $formatter->node_name_to_node_param($type_prefix . $args{value})
                                   );
             $tt_vars{criterion} = {
                 type  => $args{type},
                 value => $args{value}, # for RDF version
-                name  => CGI->escapeHTML( $name ),
+                name  => CGI->escapeHTML($name_prefix . ' ' . $args{value}),
                 url   => $url
             };
             $tt_vars{not_editable} = 1;
@@ -759 +758 @@
     $metadata{longitude} = delete $metadata{longitude_unmunged}
         if $metadata{longitude_unmunged};
 
-    # Check to make sure all the indexable nodes are created
-    foreach my $type (qw(Category Locale)) {
-        my $lctype = lc($type);
-        foreach my $index (@{$metadata{$lctype}}) {
-            $index =~ s/(.*)/\u$1/;
-            my $node = $type . " " . $index;
-            # Uppercase the node name before checking for existence
-            $node =~ s/ (\S+)/ \u$1/g;
-            unless ( $wiki->node_exists($node) ) {
-                my $category = $type eq "Category" ? "Category" : "Locales";
-                $wiki->write_node(
-                                     $node,
-                                     "\@INDEX_LINK [[$node]]",
-                                     undef,
-                                     {
-                                         username => "Auto Create",
-                                         comment  => "Auto created $lctype stub page",
-                                         category => $category
-                                     }
-                                 );
+    # We must look at the categories and locales for our new nodes, and make
+    # sure that the nodes referenced are in category "Category" or "Locale"
+    # respectively.
+
+    foreach my $type (qw/category locale/) {
+        my $prefix = $type eq 'category' ? $config->category_prefix : $config->locale_prefix;
+        $prefix .= ' ' if ( $prefix ne '' );
+        # Look at all entries for "Categories" or "Locales" for our new node
+        foreach my $index (@{$metadata{$type}}) {
+            my $nodename = $prefix . $index;
+            my $category = $type eq 'category' ? 'Category' : 'Locales';
+            if ( $wiki->node_exists($nodename) ) {
+                # We need to make sure that this node is in the relevant category
+                my %referencednode = $wiki->retrieve_node($nodename);
+                if ( not grep { $_ eq $category } @{$referencednode{metadata}{category}} ) {
+                    # Add the required Category to the node, and write it
+                    my $uctype = uc($type);
+                    $referencednode{content} .= "\n\@${uctype}_LINK [[$nodename]]";
+                    push @{$referencednode{metadata}{category}}, $category;
+                    $referencednode{metadata}{username} = "Auto Create";
+                    $referencednode{metadata}{comment} = "Added to $type $category";
+                    $referencednode{metadata}{major_change} = 0;
+                    my $conflict = $wiki->write_node (
+                                        $nodename,
+                                        $referencednode{content},
+                                        $referencednode{checksum},
+                                        $referencednode{metadata}
+                                      );
+                    if ( $conflict == 0 ) {
+                        warn "Conflict while adding category $category to node $nodename, failing silently";
+                    }
+                }
+            } else {
+                # There is no node for our new node's category or locale, we must create it
+                my $uctype = uc($type);
+                $wiki->write_node (
+                                        $nodename,
+                                        "\@${uctype}_LINK [[$nodename]]",
+                                        undef,
+                                        {
+                                            username => "Auto Create",
+                                            comment => "Auto created $type stub page",
+                                            category => $category
+                                        }
+                                  );
             }
         }
     }
-    
+
     foreach my $var ( qw( summary username comment edit_type ) ) {
         $metadata{$var} = $q->param($var) || "";
     }

trunk/Changes

@@ -1 +1 @@
 0.52    
+        Added configuration options "category_prefix" and "locale_prefix", used
+          for automatically generated categories and locales, and to generate
+          links within nodes.
+        Added macros @CATEGORY_LINK and @LOCALE_LINK to replace @INDEX_LINK
         IMPORTANT CHANGE: "supersearch.cgi" is now simply "search.cgi". If you
           have customisations to your templates, you may need to make changes
           to reflect this.