* Add an orphans plugin for finding pages that nothing links to.
[ikiwiki.git] / IkiWiki / Plugin / orphans.pm
1 #!/usr/bin/perl
2 # Provides a list of pages no other page links to.
3 package IkiWiki::Plugin::orphans;
4
5 use warnings;
6 use strict;
7
8 sub import { #{{{
9         IkiWiki::register_plugin("preprocess", "orphans", \&preprocess);
10 } # }}}
11
12 sub preprocess (@) { #{{{
13         my %params=@_;
14         $params{pages}="*" unless defined $params{pages};
15         
16         # Needs to update whenever a page is added or removed, so
17         # register a dependency.
18         IkiWiki::add_depends($params{page}, $params{pages});
19         
20         my %linkedto;
21         foreach my $p (keys %IkiWiki::links) {
22                 map { $linkedto{IkiWiki::bestlink($p, $_)}=1 if length $_ }
23                         @{$IkiWiki::links{$p}};
24         }
25         
26         my @orphans;
27         foreach my $page (keys %IkiWiki::renderedfiles) {
28                 next if $linkedto{$page};
29                 next unless IkiWiki::globlist_match($page, $params{pages});
30                 # If the page has a link to some other page, it's
31                 # indirectly linked to a page via that page's backlinks.
32                 next if grep { length $_ && $_ !~/\/Discussion$/i && IkiWiki::bestlink($page, $_) ne $page } @{$IkiWiki::links{$page}};
33                 push @orphans, $page;
34         }
35         
36         return "All pages are linked to by other pages." unless @orphans;
37         return "<ul>\n".join("\n", map { "<li>".IkiWiki::htmllink($params{page}, $_, 1)."</li>" } sort @orphans)."</ul>\n";
38 } # }}}
39
40 1