meta: generalize meta_title into meta(title); support author, updated, date

[ikiwiki.git] / IkiWiki / Plugin / meta.pm

diff --git a/IkiWiki/Plugin/meta.pm b/IkiWiki/Plugin/meta.pm
index 45d073e2881cfd544d676fea15bb9d2e5e13baf5..c9fdbc9341ac32f899be991a4956fa06b2a5b96c 100644 (file)
--- a/IkiWiki/Plugin/meta.pm
+++ b/IkiWiki/Plugin/meta.pm
@@ -20,6 +20,7 @@ sub getsetup () {
                plugin => {
                        safe => 1,
                        rebuild => undef,
+                       section => "core",
                },
 }
 
@@ -88,6 +89,12 @@ sub preprocess (@) {
        # Metadata collection that needs to happen during the scan pass.
        if ($key eq 'title') {
                $pagestate{$page}{meta}{title}=HTML::Entities::encode_numeric($value);
+               if (exists $params{sort}) {
+                       $pagestate{$page}{meta}{titlesort}=$params{sort};
+               }
+               else {
+                       $pagestate{$page}{meta}{titlesort}=$value;
+               }
                return "";
        }
        elsif ($key eq 'description') {
@@ -115,6 +122,12 @@ sub preprocess (@) {
        }
        elsif ($key eq 'author') {
                $pagestate{$page}{meta}{author}=$value;
+               if (exists $params{sort}) {
+                       $pagestate{$page}{meta}{authorsort}=$params{sort};
+               }
+               else {
+                       $pagestate{$page}{meta}{authorsort}=$value;
+               }
                # fallthorough
        }
        elsif ($key eq 'authorurl') {
@@ -267,7 +280,7 @@ sub pagetemplate (@) {
                $template->param(title_overridden => 1);
        }
 
-       foreach my $field (qw{author authorurl permalink}) {
+       foreach my $field (qw{author authorurl description permalink}) {
                $template->param($field => $pagestate{$page}{meta}{$field})
                        if exists $pagestate{$page}{meta}{$field} && $template->query(name => $field);
        }
@@ -281,6 +294,33 @@ sub pagetemplate (@) {
        }
 }
 
+sub get_sort_key {
+       my $page = $_[0];
+       my $meta = $_[1];
+
+       # e.g. titlesort (also makes sense for author)
+       my $key = $pagestate{$page}{meta}{$meta . "sort"};
+       return $key if defined $key;
+
+       # e.g. title
+       $key = $pagestate{$page}{meta}{$meta};
+       return $key if defined $key;
+
+       # fall back to closer-to-core things
+       if ($meta eq 'title') {
+               return pagetitle(IkiWiki::basename($page));
+       }
+       elsif ($meta eq 'date') {
+               return $IkiWiki::pagectime{$page};
+       }
+       elsif ($meta eq 'updated') {
+               return $IkiWiki::pagemtime{$page};
+       }
+       else {
+               return '';
+       }
+}
+
 sub match {
        my $field=shift;
        my $page=shift;
@@ -331,4 +371,29 @@ sub match_copyright ($$;@) {
        IkiWiki::Plugin::meta::match("copyright", @_);
 }
 
+package IkiWiki::SortSpec;
+
+sub cmp_meta {
+       my $left = $_[0];
+       my $right = $_[1];
+       my $meta = $_[2];
+       error(gettext("sort=meta requires a parameter")) unless defined $meta;
+
+       if ($meta eq 'updated' || $meta eq 'date') {
+               return IkiWiki::Plugin::meta::get_sort_key($left, $meta)
+                       <=>
+                       IkiWiki::Plugin::meta::get_sort_key($right, $meta);
+       }
+
+       return IkiWiki::Plugin::meta::get_sort_key($left, $meta)
+               cmp
+               IkiWiki::Plugin::meta::get_sort_key($right, $meta);
+}
+
+# A prototype of how sort=title could behave in 4.0 or something
+sub cmp_meta_title {
+       $_[2] = 'title';
+       return cmp_meta(@_);
+}
+
 1