IkiWiki/Plugin/brokenlinks.pm

   1 #!/usr/bin/perl
   2 # Provides a list of broken links.
   3 package IkiWiki::Plugin::brokenlinks;
   4
   5 use warnings;
   6 use strict;
   7 use IkiWiki 3.00;
   8
   9 sub import {
  10         hook(type => "getsetup", id => "brokenlinks", call => \&getsetup);
  11         hook(type => "preprocess", id => "brokenlinks", call => \&preprocess);
  12 }
  13
  14 sub getsetup {
  15         return
  16                 plugin => {
  17                         safe => 1,
  18                         rebuild => undef,
  19                 },
  20 }
  21
  22 sub preprocess (@) {
  23         my %params=@_;
  24         $params{pages}="*" unless defined $params{pages};
  25
  26         # Needs to update whenever a page is added or removed, so
  27         # register a dependency.
  28         add_depends($params{page}, $params{pages});
  29
  30         my %broken;
  31         foreach my $page (pagespec_match_list([keys %links],
  32                         $params{pages}, location => $params{page})) {
  33                 my %seen;
  34                 foreach my $link (@{$links{$page}}) {
  35                         next if $seen{$link};
  36                         $seen{$link}=1;
  37                         next if $link =~ /.*\/\Q$config{discussionpage}\E/i && $config{discussion};
  38                         my $bestlink=bestlink($page, $link);
  39                         next if length $bestlink;
  40                         push @{$broken{$link}}, $page;
  41                 }
  42         }
  43
  44         my @broken;
  45         foreach my $link (keys %broken) {
  46                 my $page=$broken{$link}->[0];
  47                 push @broken, sprintf(gettext("%s from %s"),
  48                         htmllink($page, $params{destpage}, $link, noimageinline => 1),
  49                         join(", ", map {
  50                                 htmllink($params{page}, $params{destpage}, $_,  noimageinline => 1)
  51                         } @{$broken{$link}}));
  52         }
  53
  54         return gettext("There are no broken links!") unless %broken;
  55         return "<ul>\n"
  56                 .join("\n",
  57                         map {
  58                                 "<li>$_</li>"
  59                         }
  60                         sort @broken)
  61                 ."</ul>\n";
  62 }
  63
  64 1