add news item for ikiwiki 3.20110328

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

diff --git a/IkiWiki/Plugin/tag.pm b/IkiWiki/Plugin/tag.pm
index 36b434f675c5d0303aa9bd4962bd7302e85afdd0..13dabce0c16cef34b85eab82fcc8c6c9aab2af54 100644 (file)
--- a/IkiWiki/Plugin/tag.pm
+++ b/IkiWiki/Plugin/tag.pm
@@ -4,27 +4,32 @@ package IkiWiki::Plugin::tag;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

-use IkiWiki 2.00;
+use IkiWiki 3.00;

 
 

-my %tags;
-
-sub import { #{{{
+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);
        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);

-} # }}}

 
 

-sub getopt () { #{{{
+       IkiWiki::loadplugin("transient");
+}
+
+sub getopt () {

        eval q{use Getopt::Long};
        error($@) if $@;
        Getopt::Long::Configure('pass_through');
        GetOptions("tagbase=s" => \$config{tagbase});
        eval q{use Getopt::Long};
        error($@) if $@;
        Getopt::Long::Configure('pass_through');
        GetOptions("tagbase=s" => \$config{tagbase});

-} #}}}
+}

 
 

-sub getsetup () { #{{{
+sub getsetup () {

        return
        return

+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+               },

                tagbase => {
                        type => "string",
                        example => "tag",
                tagbase => {
                        type => "string",
                        example => "tag",


@@ -32,21 +37,101 @@ sub getsetup () { #{{{
                        safe => 1,
                        rebuild => 1,
                },
                        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;
        my $tag=shift;

-                       
-       if ($tag !~ m{^\.?/} &&
-           exists $config{tagbase} &&
+       
+       if ($tag !~ m{^/} &&

            defined $config{tagbase}) {
            defined $config{tagbase}) {

-               $tag=$config{tagbase}."/".$tag;
+               $tag="/".$config{tagbase}."/".$tag;
+               $tag=~y#/#/#s; # squash dups

        }
 
        return $tag;
        }
 
        return $tag;

-} #}}}
+}
+
+# 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 preprocess_tag (@) { #{{{
+sub htmllink_tag ($$$;@) {
+       my $page=shift;
+       my $destpage=shift;
+       my $tag=shift;
+       my %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/^\///;
+               }
+
+               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 (@) {

        if (! @_) {
                return "";
        }
        if (! @_) {
                return "";
        }


@@ -57,62 +142,72 @@ sub preprocess_tag (@) { #{{{
        delete $params{preview};
 
        foreach my $tag (keys %params) {
        delete $params{preview};
 
        foreach my $tag (keys %params) {

-               $tag=IkiWiki::linkpage($tag);
-               $tags{$page}{$tag}=1;
+               $tag=linkpage($tag);
+               

                # hidden WikiLink
                # hidden WikiLink

-               push @{$links{$page}}, tagpage($tag);
+               add_link($page, taglink($tag), 'tag');
+               
+               gentag($tag);

        }
                
        return "";
        }
                
        return "";

-} # }}}
+}

 
 

-sub preprocess_taglink (@) { #{{{
+sub preprocess_taglink (@) {

        if (! @_) {
                return "";
        }
        my %params=@_;
        return join(" ", map {
                if (/(.*)\|(.*)/) {
        if (! @_) {
                return "";
        }
        my %params=@_;
        return join(" ", map {
                if (/(.*)\|(.*)/) {

-                       my $tag=IkiWiki::linkpage($2);
-                       $tags{$params{page}}{$tag}=1;
-                       push @{$links{$params{page}}}, tagpage($tag);
-                       return htmllink($params{page}, $params{destpage},
-                               tagpage($tag),
-                               linktext => IkiWiki::pagetitle($1));
+                       my $tag=linkpage($2);
+                       add_link($params{page}, taglink($tag), 'tag');
+                       gentag($tag);
+                       return htmllink_tag($params{page}, $params{destpage}, $tag,
+                               linktext => pagetitle($1));

                }
                else {
                }
                else {

-                       my $tag=IkiWiki::linkpage($_);
-                       $tags{$params{page}}{$tag}=1;
-                       push @{$links{$params{page}}}, tagpage($tag);
-                       return htmllink($params{page}, $params{destpage},
-                               tagpage($tag));
+                       my $tag=linkpage($_);
+                       add_link($params{page}, taglink($tag), 'tag');
+                       gentag($tag);
+                       return htmllink_tag($params{page}, $params{destpage}, $tag);

                }
        }
        grep {
                $_ ne 'page' && $_ ne 'destpage' && $_ ne 'preview'
        } keys %params);
                }
        }
        grep {
                $_ ne 'page' && $_ ne 'destpage' && $_ ne 'preview'
        } keys %params);

-} # }}}
+}

 
 

-sub pagetemplate (@) { #{{{
+sub pagetemplate (@) {

        my %params=@_;
        my $page=$params{page};
        my $destpage=$params{destpage};
        my $template=$params{template};
 
        my %params=@_;
        my $page=$params{page};
        my $destpage=$params{destpage};
        my $template=$params{template};
 

+       my $tags = $typedlinks{$page}{tag};
+

        $template->param(tags => [
                map { 
        $template->param(tags => [
                map { 

-                       link => htmllink($page, $destpage, tagpage($_),
-                                       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 ($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) {
+                       $template->param(categories => [map { category => tagname($_) },
+                               sort keys %$tags]);

                }
        }
                }
        }

-} # }}}
+}
+
+package IkiWiki::PageSpec;
+
+sub match_tagged ($$;@) {
+       my $page=shift;
+       my $glob=IkiWiki::Plugin::tag::taglink(shift);
+       return match_link($page, $glob, linktype => 'tag', @_);
+}

 
 1
 
 1