pagestats: rename disp to show, and document it

[git.ikiwiki.info.git] / IkiWiki / Plugin / tag.pm

diff --git a/IkiWiki/Plugin/tag.pm b/IkiWiki/Plugin/tag.pm
index cdcfaf536082825444b3e8d3f27b406bc413cd53..605f415994e73bee121faab9fb7e5e64f1a02182 100644 (file)
--- a/IkiWiki/Plugin/tag.pm
+++ b/IkiWiki/Plugin/tag.pm
@@ -6,14 +6,15 @@ use warnings;
 use strict;
 use IkiWiki 3.00;
 
-my %tags;
-
 sub import {
+       hook(type => "checkconfig", id => "tag", call => \&checkconfig);
        hook(type => "getopt", id => "tag", call => \&getopt);
        hook(type => "getsetup", id => "tag", call => \&getsetup);
        hook(type => "preprocess", id => "tag", call => \&preprocess_tag, scan => 1);
        hook(type => "preprocess", id => "taglink", call => \&preprocess_taglink, scan => 1);
        hook(type => "pagetemplate", id => "tag", call => \&pagetemplate);
+
+       IkiWiki::loadplugin("transient");
 }
 
 sub getopt () {
@@ -36,12 +37,33 @@ sub getsetup () {
                        safe => 1,
                        rebuild => 1,
                },
+               tag_autocreate => {
+                       type => "boolean",
+                       example => 1,
+                       description => "autocreate new tag pages?",
+                       safe => 1,
+                       rebuild => undef,
+               },
+               tag_autocreate_commit => {
+                       type => "boolean",
+                       example => 1,
+                       default => 1,
+                       description => "commit autocreated tag pages",
+                       safe => 1,
+                       rebuild => 0,
+               },
 }
 
-sub tagpage ($) {
+sub checkconfig () {
+       if (! defined $config{tag_autocreate_commit}) {
+               $config{tag_autocreate_commit} = 1;
+       }
+}
+
+sub taglink ($) {
        my $tag=shift;
-                       
-       if ($tag !~ m{^\.?/} &&
+       
+       if ($tag !~ m{^/} &&
            defined $config{tagbase}) {
                $tag="/".$config{tagbase}."/".$tag;
                $tag=~y#/#/#s; # squash dups
@@ -50,13 +72,66 @@ sub tagpage ($) {
        return $tag;
 }
 
-sub taglink ($$$;@) {
+# Returns a tag name from a tag link
+sub tagname ($) {
+       my $tag=shift;
+       if (defined $config{tagbase}) {
+               $tag =~ s!^/\Q$config{tagbase}\E/!!;
+       } else {
+               $tag =~ s!^\.?/!!;
+       }
+       return pagetitle($tag, 1);
+}
+
+sub htmllink_tag ($$$;@) {
        my $page=shift;
        my $destpage=shift;
        my $tag=shift;
        my %opts=@_;
 
-       return htmllink($page, $destpage, tagpage($tag), %opts);
+       return htmllink($page, $destpage, taglink($tag), %opts);
+}
+
+sub gentag ($) {
+       my $tag=shift;
+
+       if ($config{tag_autocreate} ||
+           ($config{tagbase} && ! defined $config{tag_autocreate})) {
+               my $tagpage=taglink($tag);
+               if ($tagpage=~/^\.\/(.*)/) {
+                       $tagpage=$1;
+               }
+               else {
+                       $tagpage=~s/^\///;
+               }
+               if (exists $IkiWiki::pagecase{lc $tagpage}) {
+                       $tagpage=$IkiWiki::pagecase{lc $tagpage}
+               }
+
+               my $tagfile = newpagefile($tagpage, $config{default_pageext});
+
+               add_autofile($tagfile, "tag", sub {
+                       my $message=sprintf(gettext("creating tag page %s"), $tagpage);
+                       debug($message);
+
+                       my $template=template("autotag.tmpl");
+                       $template->param(tagname => tagname($tag));
+                       $template->param(tag => $tag);
+
+                       my $dir = $config{srcdir};
+                       if (! $config{tag_autocreate_commit}) {
+                               $dir = $IkiWiki::Plugin::transient::transientdir;
+                       }
+
+                       writefile($tagfile, $dir, $template->output);
+                       if ($config{rcs} && $config{tag_autocreate_commit}) {
+                               IkiWiki::disable_commit_hook();
+                               IkiWiki::rcs_add($tagfile);
+                               IkiWiki::rcs_commit_staged(message => $message);
+                               IkiWiki::enable_commit_hook();
+                       }
+               });
+       }
 }
 
 sub preprocess_tag (@) {
@@ -71,9 +146,11 @@ sub preprocess_tag (@) {
 
        foreach my $tag (keys %params) {
                $tag=linkpage($tag);
-               $tags{$page}{$tag}=1;
+               
                # hidden WikiLink
-               add_link($page, tagpage($tag));
+               add_link($page, taglink($tag), 'tag');
+               
+               gentag($tag);
        }
                
        return "";
@@ -87,16 +164,16 @@ sub preprocess_taglink (@) {
        return join(" ", map {
                if (/(.*)\|(.*)/) {
                        my $tag=linkpage($2);
-                       $tags{$params{page}}{$tag}=1;
-                       add_link($params{page}, tagpage($tag));
-                       return taglink($params{page}, $params{destpage}, $tag,
+                       add_link($params{page}, taglink($tag), 'tag');
+                       gentag($tag);
+                       return htmllink_tag($params{page}, $params{destpage}, $tag,
                                linktext => pagetitle($1));
                }
                else {
                        my $tag=linkpage($_);
-                       $tags{$params{page}}{$tag}=1;
-                       add_link($params{page}, tagpage($tag));
-                       return taglink($params{page}, $params{destpage}, $tag);
+                       add_link($params{page}, taglink($tag), 'tag');
+                       gentag($tag);
+                       return htmllink_tag($params{page}, $params{destpage}, $tag);
                }
        }
        grep {
@@ -110,17 +187,22 @@ sub pagetemplate (@) {
        my $destpage=$params{destpage};
        my $template=$params{template};
 
+       my $tags = $typedlinks{$page}{tag};
+
        $template->param(tags => [
                map { 
-                       link => taglink($page, $destpage, $_, rel => "tag")
-               }, sort keys %{$tags{$page}}
-       ]) if exists $tags{$page} && %{$tags{$page}} && $template->query(name => "tags");
+                       link => htmllink_tag($page, $destpage, $_,
+                                       rel => "tag", linktext => tagname($_))
+               }, sort keys %$tags
+       ]) if defined $tags && %$tags && $template->query(name => "tags");
 
        if ($template->query(name => "categories")) {
                # It's an rss/atom template. Add any categories.
-               if (exists $tags{$page} && %{$tags{$page}}) {
-                       $template->param(categories => [map { category => $_ },
-                               sort keys %{$tags{$page}}]);
+               if (defined $tags && %$tags) {
+                       eval q{use HTML::Entities};
+                       $template->param(categories =>
+                               [map { category => HTML::Entities::encode_entities_numeric(tagname($_)) },
+                                       sort keys %$tags]);
                }
        }
 }
@@ -128,9 +210,9 @@ sub pagetemplate (@) {
 package IkiWiki::PageSpec;
 
 sub match_tagged ($$;@) {
-       my $page = shift;
-       my $glob = shift;
-       return match_link($page, IkiWiki::Plugin::tag::tagpage($glob));
+       my $page=shift;
+       my $glob=IkiWiki::Plugin::tag::taglink(shift);
+       return match_link($page, $glob, linktype => 'tag', @_);
 }
 
 1