ikiwiki-comment: optionally override parameters.

[git.ikiwiki.info.git] / ikiwiki-comment.in

diff --git a/ikiwiki-comment.in b/ikiwiki-comment.in
index b0cea4a4ae03fe17d6ad7a382b097f114f89c557..c742d7063fa89fc2de6358db06f64ae19bb5cd89 100755 (executable)
--- a/ikiwiki-comment.in
+++ b/ikiwiki-comment.in
@@ -4,49 +4,115 @@ use strict;
 use lib '.'; # For use in nonstandard directory, munged by Makefile.
 use IkiWiki;
 use IkiWiki::Plugin::comments;
 use lib '.'; # For use in nonstandard directory, munged by Makefile.
 use IkiWiki;
 use IkiWiki::Plugin::comments;

+use Getopt::Long;

 
 

-sub usage () {
-       die gettext("usage: ikiwiki-comment pagefile"), "\n";
+sub usage {
+       die gettext("usage: ikiwiki-comment pagefile [options]") . "\n";

 }
 
 }
 

-my $pagefile=shift || usage ();
+sub main {
+       my $pagefile=shift || usage();
+       my $interactive = -t STDIN;
+       my $content;
+       my ($format, $username, $subject, $date);
+       GetOptions(
+               'format:s'      => \$format,
+               'username:s'    => \$username,
+               'subject:s'     => \$subject,
+               'date:s'        => \$date,
+       ) || usage();

 
 

-my $dir=IkiWiki::dirname($pagefile);
-$dir="." unless length $dir;
-my $page=IkiWiki::basename($pagefile);
-if (! -d $pagefile) {
-       $page=~s/\.[^.]+$//;
-}
+       my $dir=get_dir($pagefile);
+       my $page=get_page($pagefile);
+
+       IkiWiki::Plugin::comments::checkconfig();
+
+       if ($interactive) {
+               $format         ||= 'mdwn';
+               $username       ||= get_username();
+               $subject        ||= get_subject($page, $dir);
+               $date           ||= get_date();
+       } else {
+               $format         ||= undef;
+               die "must supply username" unless defined $username;
+               $subject        ||= get_subject($page, $dir);
+               die "must supply date" unless defined $date;
+               chomp($content = join('', <STDIN>));
+       }
+
+       my $comment=get_comment($format, $username, $subject, $date, $content);

 
 

-IkiWiki::Plugin::comments::checkconfig();
-my $comment_num=1 + IkiWiki::Plugin::comments::num_comments($page, $dir);
+       # For interactive use, this will yield a hash of the comment before
+       # it's edited, but that's ok; the date provides sufficient entropy
+       # to avoid collisions, and the hash of a comment does not need to
+       # match its actual content.
+       # Doing it this way avoids needing to move the file to a final
+       # location after it's edited.
+       my $location=IkiWiki::Plugin::comments::unique_comment_location($page, $comment, $dir)."._comment";

 
 

-my $username = getpwuid($<);
-if (! defined $username) { $username="" }
+       IkiWiki::writefile($location, $dir, $comment);
+       exec_editor("$dir/$location") if $interactive;
+}
+
+sub get_dir {
+       my ($file) = @_;
+       my $dir=IkiWiki::dirname($file);
+       $dir="." unless length $dir;
+       return $dir;
+}

 
 

-my $comment="[[!comment format=mdwn\n";
-$comment.=" username=\"$username\"\n";
-$comment.=" subject=\"\"\"comment $comment_num\"\"\"\n";
-$comment.=" " . IkiWiki::Plugin::comments::commentdate() . "\n";
-$comment.=" content=\"\"\"\n\n\"\"\"]]\n";
+sub get_page {
+       my ($file) = @_;
+       my $page=IkiWiki::basename($file);
+       $page=~s/\.[^.]+$// unless -d $file;
+       return $page;
+}

 
 

-# This will yield a hash of the comment before it's edited,
-# but that's ok; the date provides sufficient entropy to avoid collisions,
-# and the hash of a comment does not need to match its actual content.
-# Doing it this way avoids needing to move the file to a final
-# location after it's edited.
-my $location=IkiWiki::Plugin::comments::unique_comment_location($page, $comment, $dir)."._comment";
+sub get_username {
+       my $username = getpwuid($<);
+       $username="" unless defined $username;
+       return $username;
+}

 
 

-IkiWiki::writefile($location, $dir, $comment);
+sub get_subject {
+       my ($page, $dir) = @_;
+       my $comment_num=1+IkiWiki::Plugin::comments::num_comments($page, $dir);
+       return "comment $comment_num";
+}

 
 

-my @editor="vi";
-if (-x "/usr/bin/editor") {
-       @editor="/usr/bin/editor";
+sub get_date {
+       my $date = IkiWiki::Plugin::comments::commentdate();
+       $date =~ s|^date=\\"||;
+       $date =~ s|\\"$||;
+       return $date;

 }
 }

-if (exists $ENV{EDITOR}) {
-       @editor=split(' ', $ENV{EDITOR});
+
+sub get_comment {
+       my ($format, $username, $subject, $date, $content) = @_;
+       $format = defined $format ? $format = " format=$format" : q{};
+       $content = '' unless defined $content;
+       my $comment="[[!comment$format\n";
+       $comment.=" username=\"$username\"\n";
+       $comment.=" subject=\"\"\"$subject\"\"\"\n";
+       $comment.=" date=\"$date\"\n";
+       $comment.=" content=\"\"\"\n$content\n\"\"\"]]\n";
+       return $comment;

 }
 }

-if (exists $ENV{VISUAL}) {
-@editor=split(' ', $ENV{VISUAL});
+
+sub exec_editor {
+       my ($file) = @_;
+
+       my @editor="vi";
+       if (-x "/usr/bin/editor") {
+               @editor="/usr/bin/editor";
+       }
+       if (exists $ENV{EDITOR}) {
+               @editor=split(' ', $ENV{EDITOR});
+       }
+       if (exists $ENV{VISUAL}) {
+       @editor=split(' ', $ENV{VISUAL});
+       }
+       exec(@editor, $file);

 }
 }

-exec(@editor, "$dir/$location");
+
+main(@ARGV);