summaryrefslogtreecommitdiff
path: root/.library
diff options
context:
space:
mode:
Diffstat (limited to '.library')
-rw-r--r--.library/IkiWiki/Plugin/copyright.pm60
-rw-r--r--.library/IkiWiki/Plugin/license.pm59
-rw-r--r--.library/IkiWiki/Plugin/reset_mtimes.pm84
-rw-r--r--.library/IkiWiki/Plugin/texinfo.pm226
4 files changed, 429 insertions, 0 deletions
diff --git a/.library/IkiWiki/Plugin/copyright.pm b/.library/IkiWiki/Plugin/copyright.pm
new file mode 100644
index 00000000..16acaccd
--- /dev/null
+++ b/.library/IkiWiki/Plugin/copyright.pm
@@ -0,0 +1,60 @@
+# A plugin for ikiwiki to implement adding a footer with copyright information
+# based on a default value taken out of a file.
+
+# Copyright © 2007, 2008 Thomas Schwinge <tschwinge@gnu.org>
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation; either version 2, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+# Unless overridden with the `meta' plugin, a footer with copyright information
+# will be added to every page using a source file `copyright' (e.g.,
+# `copyright.mdwn') (using the same ``locating rules'' as for the sidebar
+# plugin).
+#
+# The state which page's copyright text was gathered from which source is not
+# tracked, so you'll need a full wiki-rebuild if the `copyright' file is
+# changed.
+
+package IkiWiki::Plugin::copyright;
+
+use warnings;
+use strict;
+use IkiWiki 2.00;
+
+my %copyright;
+
+sub import
+{
+ hook (type => "scan", id => "copyright", call => \&scan);
+}
+
+sub scan (@)
+{
+ my %params = @_;
+ my $page = $params{page};
+
+ return if defined $pagestate{$page}{meta}{copyright};
+
+ my $content;
+ my $copyright_page = bestlink ($page, "copyright") || return;
+ my $copyright_file = $pagesources{$copyright_page} || return;
+
+ # Only an optimization to avoid reading the same file again and again.
+ $copyright{$copyright_file} = readfile (srcfile ($copyright_file))
+ unless defined $copyright{$copyright_file};
+
+ $pagestate{$page}{meta}{copyright} = $copyright{$copyright_file};
+}
+
+1
diff --git a/.library/IkiWiki/Plugin/license.pm b/.library/IkiWiki/Plugin/license.pm
new file mode 100644
index 00000000..651c039a
--- /dev/null
+++ b/.library/IkiWiki/Plugin/license.pm
@@ -0,0 +1,59 @@
+# A plugin for ikiwiki to implement adding a footer with licensing information
+# based on a default value taken out of a file.
+
+# Copyright © 2007, 2008 Thomas Schwinge <tschwinge@gnu.org>
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation; either version 2, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+# Unless overridden with the `meta' plugin, a footer with licensing information
+# will be added to every page using a source file `license' (e.g.,
+# `license.mdwn') (using the same ``locating rules'' as for the sidebar
+# plugin).
+#
+# The state which page's license text was gathered from which source is not
+# tracked, so you'll need a full wiki-rebuild if the `license' file is changed.
+
+package IkiWiki::Plugin::license;
+
+use warnings;
+use strict;
+use IkiWiki 2.00;
+
+my %license;
+
+sub import
+{
+ hook (type => "scan", id => "license", call => \&scan);
+}
+
+sub scan (@)
+{
+ my %params = @_;
+ my $page = $params{page};
+
+ return if defined $pagestate{$page}{meta}{license};
+
+ my $content;
+ my $license_page = bestlink ($page, "license") || return;
+ my $license_file = $pagesources{$license_page} || return;
+
+ # Only an optimization to avoid reading the same file again and again.
+ $license{$license_file} = readfile (srcfile ($license_file))
+ unless defined $license{$license_file};
+
+ $pagestate{$page}{meta}{license} = $license{$license_file};
+}
+
+1
diff --git a/.library/IkiWiki/Plugin/reset_mtimes.pm b/.library/IkiWiki/Plugin/reset_mtimes.pm
new file mode 100644
index 00000000..a168652b
--- /dev/null
+++ b/.library/IkiWiki/Plugin/reset_mtimes.pm
@@ -0,0 +1,84 @@
+# Copyright © 2010 Thomas Schwinge <thomas@schwinge.name>
+
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation; either version 2, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+package IkiWiki::Plugin::reset_mtimes;
+
+use warnings;
+use strict;
+use IkiWiki 3.00;
+
+# This plugin resets pages' / files' mtimes according to the RCS information
+# when using --refresh mode.
+#
+# Note that the files' mtimes are *always* set, even if the file has
+# un-committed changes.
+#
+# <http://ikiwiki.info/bugs/pagemtime_in_refresh_mode/>
+
+sub import
+{
+ hook (type => "needsbuild",
+ id => "reset_mtimes",
+ call => \&needsbuild);
+}
+
+sub needsbuild (@)
+{
+ # Only proceed if --gettime is in effect, as we're clearly not intersted in
+ # this functionality otherwise.
+ return unless $config{gettime};
+
+ my $files = shift;
+ foreach my $file (@$files)
+ {
+ # [TODO. Perhaps not necessary. Can this hook ever be called for
+ # removed pages -- that need to be ``rebuilt'' in the sense that
+ # they're to be removed?] Don't bother for pages that don't exist
+ # anymore.
+ next unless -e "$config{srcdir}/$file";
+
+ my $page = pagename ($file);
+ debug ("needsbuild: <$file> <$page>");
+
+ # Only ever update -- otherwise ikiwiki shall do its own thing.
+ if (defined $IkiWiki::pagemtime{$page})
+ {
+ debug ("pagemtime: " . $IkiWiki::pagemtime{$page});
+
+ my $mtime = 0;
+ eval
+ {
+ $mtime = IkiWiki::rcs_getmtime ($file);
+ };
+ if ($@)
+ {
+ print STDERR $@;
+ }
+ elsif ($mtime > 0)
+ {
+ $IkiWiki::pagemtime{$page} = $mtime;
+
+ # We have to set the actual file's mtime too, as otherwise
+ # ikiwiki will update it again and again.
+ utime($mtime, $mtime, "$config{srcdir}/$file");
+ }
+
+ debug ("pagemtime: " . $IkiWiki::pagemtime{$page});
+ }
+ }
+}
+
+1
diff --git a/.library/IkiWiki/Plugin/texinfo.pm b/.library/IkiWiki/Plugin/texinfo.pm
new file mode 100644
index 00000000..8c651160
--- /dev/null
+++ b/.library/IkiWiki/Plugin/texinfo.pm
@@ -0,0 +1,226 @@
+# A GNU Texinfo rendering plugin.
+
+# Copyright © 2007 Thomas Schwinge <tschwinge@gnu.org>
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation; either version 2, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+# http://ikiwiki.info/plugins/contrib/texinfo/
+
+package IkiWiki::Plugin::texinfo;
+
+use warnings;
+use strict;
+use IkiWiki 2.00;
+
+# From `Ikiwiki/Plugins/teximg.pm'.
+sub create_tmp_dir ($)
+{
+ # Create a temp directory, it will be removed when ikiwiki exits.
+ my $base = shift;
+
+ my $template = $base . ".XXXXXXXXXX";
+ use File::Temp qw (tempdir);
+ my $tmpdir = tempdir ($template, TMPDIR => 1, CLEANUP => 1);
+ return $tmpdir;
+}
+
+sub import
+{
+ hook (type => "filter", id => "texi", call => \&filter);
+ hook (type => "htmlize", id => "texi", call => \&htmlize);
+ hook (type => "pagetemplate", id => "texi", call => \&pagetemplate);
+}
+
+my %copyright;
+my %license;
+
+sub filter (@)
+{
+ my %params = @_;
+ my $page = $params{page};
+
+# TODO. For ``$page eq 'shortcuts''' this fails. Is this expected?
+ goto out unless defined $pagesources{$page};
+
+ # Only care for `.texi' files.
+ goto out unless pagetype ($pagesources{$page}) eq 'texi';
+
+ # No need to parse twice.
+ goto out if exists $copyright{$page};
+
+# TODO. Check the `meta' plugin about when to do this at all.
+ $copyright{$page} = undef;
+ $license{$page} = undef;
+ # We assume that the copyright and licensing information is to be taken
+ # from the main `.texi' file.
+ @_ = split /\n/, $params{content};
+ # Do some parsing to cut out the interesting bits, if there are any.
+ while (defined ($_ = shift @_))
+ {
+ # Did we find a start tag?
+ last if /^\@copying$/;
+ }
+ # Already at the end of the page?
+ goto out unless defined $_;
+ while (defined ($_ = shift @_))
+ {
+ # Already at the end of the copying section? (Shouldn't happen.)
+ goto out if /^\@end\ copying/;
+ # Found the ``^Copyright'' line?
+ last if /^Copyright/;
+ }
+ # Already at the end of the page? (Shouldn't happen.)
+ goto out unless defined $_;
+ # Copyright text will follow.
+ $copyright{$page} = $_;
+ while (defined ($_ = shift @_))
+ {
+ # Found the separator of copyright and licensind information?
+ last if /^$/;
+ # Already at the end of the copying section?
+ goto finish if /^\@end\ copying/;
+ $copyright{$page} .= ' ' . $_;
+ }
+ # Already at the end of the page? (Shouldn't happen.)
+ goto finish unless defined $_;
+ # Licensing text will follow.
+ while (defined ($_ = shift @_))
+ {
+ # Already at the end of the copying section?
+ last if /^\@end\ copying/;
+ $license{$page} .= ' ' . $_;
+ }
+
+ finish:
+ # ``Render'' by hand some stuff that is commonly found in this section.
+ if (defined $copyright{$page})
+ {
+ $copyright{$page} =~ s/\@copyright{}/©/g;
+ }
+ if (defined $license{$page})
+ {
+ $license{$page} =~ s/\@quotation//g;
+ $license{$page} =~ s/\@end\ quotation//g;
+ $license{$page} =~ s/\@ignore/<!--/g;
+ $license{$page} =~ s/\@end\ ignore/-->/g;
+ }
+
+ out:
+ return $params{content};
+}
+
+sub htmlize (@)
+{
+ my %params = @_;
+ my $page = $params{page};
+
+ my $home;
+ if (defined $pagesources{$page})
+ {
+ $home = $config{srcdir} . '/' . dirname ($pagesources{$page});
+ }
+ else
+ {
+ # This happens in the CGI web frontent, when freshly creating a
+ # `texi'-type page and selecting to ``Preview'' the page before doing a
+ # ``Save Page''.
+# TODO.
+ $home = $config{srcdir};
+ }
+
+ my $pid;
+ my $sigpipe = 0;
+ $SIG{PIPE} = sub
+ {
+ $sigpipe = 1;
+ };
+
+ my $tmp = eval
+ {
+ create_tmp_dir ("texinfo")
+ };
+ if (! $@ &&
+ # `makeinfo' can't work directly on stdin.
+ writefile ("texinfo.texi", $tmp, $params{content}) == 0)
+ {
+ return "couldn't write temporary file";
+ }
+
+ use File::Basename;
+ use IPC::Open2;
+ $pid = open2 (*IN, *OUT,
+ 'makeinfo',
+ '--html',
+ '--no-split', '--output=-',
+ # We might be run from a directory different from the one the
+ # `.texi' file is stored in.
+# TODO. Should we `cd' to this directory instead?
+ '-P', $home,
+# TODO. Adding the following allows for putting files like `gpl.texinfo' into
+# the top-level wiki directory.
+ '-I', $config{srcdir},
+ $tmp . "/texinfo.texi");
+ # open2 doesn't respect "use open ':utf8'"
+ binmode (IN, ':utf8');
+# binmode (OUT, ':utf8');
+
+# print OUT $params{content};
+ close OUT;
+
+ local $/ = undef;
+ my $ret = <IN>;
+ close IN;
+ waitpid $pid, 0;
+ $SIG{PIPE} = "DEFAULT";
+
+ return "failed to render" if $sigpipe;
+
+ # Cut out the interesting bits.
+ $ret =~ s/.*<body>//s;
+ $ret =~ s/<\/body>.*//s;
+
+ return $ret;
+}
+
+sub pagetemplate (@)
+{
+ my %params = @_;
+ my $page = $params{page};
+ my $destpage = $params{destpage};
+
+ my $template = $params{template};
+
+# TODO. Check the `meta' plugin about when to do this at all.
+ if ($template->query (name => "copyright") &&
+ ! defined $template->param ('copyright'))
+ {
+ if (defined $copyright{$page} && length $copyright{$page})
+ {
+ $template->param (copyright =>
+ IkiWiki::linkify ($page, $destpage, $copyright{$page}));
+ }
+ }
+ if ($template->query (name => "license") &&
+ ! defined $template->param ('license'))
+ {
+ if (defined $license{$page} && length $license{$page})
+ {
+ $template->param (license =>
+ IkiWiki::linkify ($page, $destpage, $license{$page}));
+ }
+ }
+}
+
+1
generated by cgit v1.2.3 (git 2.46.0) at 2025-03-12 22:33:24 +0000