document external links

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

diff --git a/IkiWiki/Plugin/link.pm b/IkiWiki/Plugin/link.pm
index 2ea6aa19eebbfdb17b0a1859eb79ca511ced8504..d41965bd38b2ce12c4f59f300af3cf80fce9ac12 100644 (file)
--- a/IkiWiki/Plugin/link.pm
+++ b/IkiWiki/Plugin/link.pm
@@ -3,18 +3,31 @@ package IkiWiki::Plugin::link;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 
 my $link_regexp;
 
-sub import { #{{{
+my $email_regexp = qr/^(?:[a-z0-9!#$%&'*+\/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+\/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$/i; 
+my $url_regexp = qr/^(?:[^:]+:\/\/|mailto:).*/i;
+
+sub import {
+       hook(type => "getsetup", id => "link", call => \&getsetup);
        hook(type => "checkconfig", id => "link", call => \&checkconfig);
        hook(type => "linkify", id => "link", call => \&linkify);
        hook(type => "scan", id => "link", call => \&scan);
        hook(type => "renamepage", id => "link", call => \&renamepage);
-} # }}}
+}
+
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => 1,
+                       section => "core",
+               },
+}
 
-sub checkconfig () { #{{{
+sub checkconfig () {
        if ($config{prefix_directives}) {
                $link_regexp = qr{
                        \[\[(?=[^!])            # beginning of link
@@ -47,11 +60,45 @@ sub checkconfig () { #{{{
                        )?                      # optional
 
                        \]\]                    # end of link
-               }x,
+               }x;
+       }
+}
+
+sub is_externallink ($$) {
+       my $page = shift;
+       my $url = shift;
+       if ($url =~ /$email_regexp/) {
+               # url looks like an email address, so we assume it
+               # is supposed to be an external link if there is no
+               # page with that name.
+               $url =~ s/#.*//;
+               return (! (bestlink($page, linkpage($url))))
+       }
+       return ($url =~ /$url_regexp/)
+}
+
+sub externallink ($;@) {
+       my $url = shift;
+       my $pagetitle = shift;
+
+       # build pagetitle
+       if (!($pagetitle)) {
+               $pagetitle = $url;
+               # use only the email address as title for mailto: urls
+               if ($pagetitle =~ /^mailto:.*/) {
+                       $pagetitle =~ s/^mailto:([^?]+).*/$1/;
+               }
+       }
+
+       # handle email-addresses (without mailto:):
+       if ($url =~ /$email_regexp/) {
+               $url = "mailto:" . $url;
        }
-} #}}}
 
-sub linkify (@) { #{{{
+       return "<a href=\"$url\">$pagetitle</a>";
+}
+
+sub linkify (@) {
        my %params=@_;
        my $page=$params{page};
        my $destpage=$params{destpage};
@@ -60,55 +107,63 @@ sub linkify (@) { #{{{
                defined $2
                        ? ( $1 
                                ? "[[$2|$3".($4 ? "#$4" : "")."]]" 
-                               : htmllink($page, $destpage, IkiWiki::linkpage($3),
-                                       anchor => $4, linktext => IkiWiki::pagetitle($2)))
+                               : is_externallink($page, $3 . ($4 ? "#$4" : ""))
+                                       ? externallink("$3" . ($4 ? "#$4" : ""), $2)
+                                       : htmllink($page, $destpage, linkpage($3),
+                                               anchor => $4, linktext => pagetitle($2)))
                        : ( $1 
                                ? "[[$3".($4 ? "#$4" : "")."]]"
-                               : htmllink($page, $destpage, IkiWiki::linkpage($3),
-                                       anchor => $4))
+                               : is_externallink($page, $3 . ($4 ? "#$4" : ""))
+                                       ? externallink("$3" . ($4 ? "#$4" : ""))
+                                       : htmllink($page, $destpage, linkpage($3),
+                                               anchor => $4))
        }eg;
        
        return $params{content};
-} #}}}
+}
 
-sub scan (@) { #{{{
+sub scan (@) {
        my %params=@_;
        my $page=$params{page};
        my $content=$params{content};
 
        while ($content =~ /(?<!\\)$link_regexp/g) {
-               push @{$links{$page}}, IkiWiki::linkpage($2);
+               if (! is_externallink($page, $2 . ($3 ? "#$3" : ""))) {
+                       add_link($page, linkpage($2));
+               }
        }
-} # }}}
+}
 
-sub renamepage (@) { #{{{
+sub renamepage (@) {
        my %params=@_;
        my $page=$params{page};
        my $old=$params{oldpage};
        my $new=$params{newpage};
 
        $params{content} =~ s{(?<!\\)$link_regexp}{
-               my $linktext=$2;
-               my $link=$linktext;
-               if (bestlink($page, IkiWiki::linkpage($linktext)) eq $old) {
-                       $link=IkiWiki::pagetitle($new, 1);
-                       $link=~s/ /_/g;
-                       if ($linktext =~ m/.*\/*?[A-Z]/) {
-                               # preserve leading cap of last component
-                               my @bits=split("/", $link);
-                               $link=join("/", @bits[0..$#bits-1], ucfirst($bits[$#bits]));
-                       }
-                       if (index($linktext, "/") == 0) {
-                               # absolute link
-                               $link="/$link";
+               if (! is_externallink($page, $2 . ($3 ? "#$3" : ""))) {
+                       my $linktext=$2;
+                       my $link=$linktext;
+                       if (bestlink($page, linkpage($linktext)) eq $old) {
+                               $link=pagetitle($new, 1);
+                               $link=~s/ /_/g;
+                               if ($linktext =~ m/.*\/*?[A-Z]/) {
+                                       # preserve leading cap of last component
+                                       my @bits=split("/", $link);
+                                       $link=join("/", @bits[0..$#bits-1], ucfirst($bits[$#bits]));
+                               }
+                               if (index($linktext, "/") == 0) {
+                                       # absolute link
+                                       $link="/$link";
+                               }
                        }
+                       defined $1
+                               ? ( "[[$1|$link".($3 ? "#$3" : "")."]]" )
+                               : ( "[[$link".   ($3 ? "#$3" : "")."]]" )
                }
-               defined $1
-                       ? ( "[[$1|$link".($3 ? "#$3" : "")."]]" )
-                       : ( "[[$link".   ($3 ? "#$3" : "")."]]" )
        }eg;
 
        return $params{content};
-} #}}}
+}
 
 1