add plugin safe/rebuild info (part 3 of 3)

[ikiwiki.git] / IkiWiki / Plugin / smiley.pm

diff --git a/IkiWiki/Plugin/smiley.pm b/IkiWiki/Plugin/smiley.pm
index 5f05e3a4c2234aa053f6162f2c7eaf1028ede88b..7a9026025ed94f778aa4b6e666677b27595f605b 100644 (file)
--- a/IkiWiki/Plugin/smiley.pm
+++ b/IkiWiki/Plugin/smiley.pm
@@ -3,42 +3,102 @@ package IkiWiki::Plugin::smiley;
 
 use warnings;
 use strict;
-use IkiWiki;
+use IkiWiki 2.00;
 
 my %smileys;
 my $smiley_regexp;
 
 sub import { #{{{
-       IkiWiki::hook(type => "checkconfig", id => "smiley", call => \&setup);
+       add_underlay("smiley");
+       hook(type => "getsetup", id => "smiley", call => \&getsetup);
+       hook(type => "sanitize", id => "smiley", call => \&sanitize);
 } # }}}
 
-sub setup () { #{{{
-       my $list=IkiWiki::readfile(IkiWiki::srcfile("smileys.mdwn"));
-       while ($list =~ m/^\s*\*\s+\\([^\s]+)\s+\[\[([^]]+)\]\]/mg) {
-               $smileys{$1}=$2;
+sub getsetup () { #{{{
+       return
+               plugin => {
+                       safe => 1,
+                       # force a rebuild because turning it off
+                       # removes the smileys, which would break links
+                       rebuild => 1,
+               },
+} #}}}
+
+sub build_regexp () { #{{{
+       my $list=readfile(srcfile("smileys.mdwn"));
+       while ($list =~ m/^\s*\*\s+\\\\([^\s]+)\s+\[\[([^]]+)\]\]/mg) {
+               my $smiley=$1;
+               my $file=$2;
+
+               $smileys{$smiley}=$file;
+
+               # Add a version with < and > escaped, since they probably
+               # will be (by markdown) by the time the sanitize hook runs.
+               $smiley=~s/</&lt;/g;
+               $smiley=~s/>/&gt;/g;
+               $smileys{$smiley}=$file;
        }
        
        if (! %smileys) {
-               IkiWiki::debug("failed to parse any smileys, disabling plugin");
+               debug(gettext("failed to parse any smileys"));
+               $smiley_regexp='';
                return;
        }
        
-       IkiWiki::hook(type => "filter", id => "smiley", call => \&filter);
        # sort and reverse so that substrings come after longer strings
        # that contain them, in most cases.
        $smiley_regexp='('.join('|', map { quotemeta }
                reverse sort keys %smileys).')';
-       #IkiWiki::debug($smiley_regexp);
+       #debug($smiley_regexp);
 } #}}}
 
-sub filter (@) { #{{{
+sub sanitize (@) { #{{{
        my %params=@_;
+
+       build_regexp() unless defined $smiley_regexp;
        
-       $params{content} =~ s{(?<=\s)(\\?)$smiley_regexp(?=\s)}{
-               $1 ? $2 : IkiWiki::htmllink($params{page}, $smileys{$2}, 0, 0, $2)
-       }egs;
+       $_=$params{content};
+       return $_ unless length $smiley_regexp;
+                       
+MATCH: while (m{(?:^|(?<=\s|>))(\\?)$smiley_regexp(?:(?=\s|<)|$)}g) {
+               my $escape=$1;
+               my $smiley=$2;
+               my $epos=$-[1];
+               my $spos=$-[2];
+               
+               # Smilies are not allowed inside <pre> or <code>.
+               # For each tag in turn, match forward to find the next <tag>
+               # or </tag> after the smiley.
+               my $pos=pos;
+               foreach my $tag ("pre", "code") {
+                       if (m/<(\/)?\s*$tag\s*>/isg && defined $1) {
+                               # </tag> found first, so the smiley is
+                               # inside the tag, so do not expand it.
+                               next MATCH;
+                       }
+                       # Reset pos back to where it was before this test.
+                       pos=$pos;
+               }
        
-       return $params{content};
+               if ($escape) {
+                       # Remove escape.
+                       substr($_, $epos, 1)="";
+                       pos=$epos+1;
+               }
+               else {
+                       # Replace the smiley with its expanded value.
+                       substr($_, $spos, length($smiley))=
+                               htmllink($params{page}, $params{destpage},
+                                        $smileys{$smiley}, linktext => $smiley);
+                       pos=$epos+1;
+               }
+
+               # Breaks out at end, otherwise it will scan through again,
+               # replacing de-escaped ones.
+               #last unless defined pos;
+       }
+
+       return $_;
 } # }}}
 
 1