Merge branch 'master' into comments
[ikiwiki.git] / doc / bugs / inline_sort_order_and_meta_date_value.mdwn
1 I have a directory containing two files. f1 (<http://alcopop.org/~jon/repro2/src/blog/debgtd.html>) has 
2
3     meta date="2008-07-02 14:13:17"
4
5 f2 (<http://alcopop.org/~jon/repro2/src/blog/moving.html>) has
6
7     meta date="2008-07-02 21:04:21"
8
9 They have both been modified recently:
10
11     >>> stat(f1)
12     (33188, 459250L, 65027L, 1, 1000, 1000, 1686L, 1227967177, 1227966706, 1227966706)
13     >>> stat(f2)
14     (33188, 458868L, 65027L, 1, 1000, 1000, 938L, 1227967187, 1227966705, 1227966705)
15
16 Note that f1 is fractionally newer than f2 in terms of ctime and mtime, but f2 is much newer in terms of the meta information.
17
18 Another page includes them both via inline:
19
20     inline pages="blog/*" show=5
21
22 The resulting page is rendered with f1 above f2, seemingly not using the meta directive information: <http://alcopop.org/~jon/repro2/dest/blog/>. The footer in the inline pages does use the correct time e.g. <em>Posted Wed 02 Jul 2008 14:13:17 BST</em>.
23
24 If I instead include them using creation_year in the pagespec, they are ordered correctly.
25
26 <http://alcopop.org/~jon/repro2/> contains the src used to reproduce this, the precise ikiwiki invocation (inside Makefile) and the results (dest).
27
28 -- [[users/Jon]]
29
30
31 > On Ikiwiki 2.53.3 (Debian Lenny), my inlines are also sorted using mtime
32 > by default -- despite what the [[documentation|/ikiwiki/directive/inline]]
33 > says -- but setting the supposed default sort order manually produces the
34 > correct results.  For example, the following inline sorts my blog
35 > entires using their meta date or ctime:
36
37 >     inline pages="blog/*" show="10" sort="age"
38
39 > I'll try to look at the code this weekend and see if age is really the
40 > default sort order.
41
42 > -- [David A. Harding](http://dtrt.org), 2008-12-20
43
44 Here is the code. As you can see, sort="age" is equivilant to leaving
45 out the sort option. --[[Joey]] 
46
47         if (exists $params{sort} && $params{sort} eq 'title') {
48                 @list=sort { pagetitle(basename($a)) cmp pagetitle(basename($b)) } @list;
49         }
50         elsif (exists $params{sort} && $params{sort} eq 'mtime') {
51                 @list=sort { $pagemtime{$b} <=> $pagemtime{$a} } @list;
52         }
53         elsif (! exists $params{sort} || $params{sort} eq 'age') {
54                 @list=sort { $pagectime{$b} <=> $pagectime{$a} } @list;
55         }
56         else {
57                 return sprintf(gettext("unknown sort type %s"), $params{sort});
58         }
59
60 > On further testing, I find that the bug is limited to the first time
61 > creation time should be used and has nothing to do with setting the sort
62 > parameter. Revised steps to reproduce: --[David A.  Harding](http://dtrt.org), 2008-12-20
63
64 > 1. Create pages that sort different by mtime and ctime
65
66 > 2. inline pages="somepages/*"
67
68 > 3. ikiwiki --setup setup_file
69
70 > 4. Pages are output incorrectly in mtime order
71
72 > 5. ikiwiki --setup setup_file
73
74 > 6. Pages are output correctly in ctime order
75
76 > 7. Create new page in somepages/, set its ctime to earlier than another
77 >    page in sompages/
78
79 > 8. ikiwiki --setup setup_file
80
81 > 9. All previously sorted pages output correctly in ctime order but new
82 >    page is output incorrectly at the top as if its mtime was its ctime
83
84 > 10. ikiwiki --setup setup_file
85
86 > 11. All pages, including new page, are output correctly in ctime order
87
88 You're confusing ctime and creation time. This is perhaps not suprising, as
89 ikiwiki uses the term 'ctime' to refer to creation time. However, the unix
90 ctime value is not the same thing. Unix ctime can change if a file changes
91 owner, or in some cases, permissions. Unix ctime also always changes
92 when the file is modified. Ikiwiki wants a first creation date of the file,
93 and it accomplishes this by recording the initial ctime of a file the first
94 time it processes it, and *preserving* that creation time forever, ignoring
95 later ctime changes.
96
97 I suspect that this, coupled with the fact that ikiwiki sorts newest pages
98 first, explains everything you describe. If not, please send me a shell script
99 test case I can run, as instructions like "Create pages that sort different by
100 mtime and ctime" are not ones that I know how to follow (given that touch sets
101 *both*). --[[Joey]]