ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / bugs / filecheck_failing_to_find_files.mdwn
1 Using the attachment plugin, when filecheck was checking the mime-type of the attachment before allowing the attachment to be removed, it was returning with an error saying that the mime-type of the file was "unknown" (when the mime-type definitely was known!)
2
3 It turns out that the filecheck plugin couldn't find the file, because it was merely using the $pagesources hash, rather than finding the absolute path of the file in question.
4
5 > I don't understand why the file was not in `%pagesources`. Do you?
6 > --[[Joey]]
7
8 >> The file *was* in `%pagesources`, but what returns from that is the filename relative to the `srcdir` directory; for example, `foo/bar.gif`.
9 >> When File::MimeInfo::Magic::magic is given that, it can't find the file.
10 >> But if it is given `/path/to/srcdir/foo/bar.gif` instead, then it *can* find the file, and returns the mime-type correctly.
11 >> --[[KathrynAndersen]]
12
13 >>> Ok, so it's not removal specific, can in fact be triggered by using
14 >>> testpagespec (or really anything besides attachment, which passes
15 >>> the filename parameter). Nor is it limited to mimetype, all the tests in 
16 >>> filecheck have the problem. --[[Joey]] 
17
18 >>>> Alas, not fixed.  It seems I was mistaken in some of my assumptions.
19 >>>> It still happens when attempting to remove attachments.
20 >>>> With your fix, the `IkiWiki::srcfile` function is only called when the filename is not passed in, but it appears that in the case of removing attachments, the filename IS passed in, but it is the relative filename as mentioned above.  Thus, the file is still not found, and the mime-type comes back as unknown.
21 >>>> The reason my patch worked is because, rather than checking whether a filename was passed in before applying IkiWiki::srcfile to the filename, it checks whether the file can be found, and if it cannot be found, then it applies IkiWiki::srcfile to the filename.
22 >>>> --[[KathrynAndersen]]
23
24 >>>>> Can you test if this patch fixes that? --[[Joey]]
25
26 >>>>>> Yes, it works! --[[KathrynAndersen]]
27
28 applied && [[done]]
29
30 <pre>
31 diff --git a/IkiWiki/Plugin/remove.pm b/IkiWiki/Plugin/remove.pm
32 index f59d026..0fc180f 100644
33 --- a/IkiWiki/Plugin/remove.pm
34 +++ b/IkiWiki/Plugin/remove.pm
35 @@ -49,7 +49,7 @@ sub check_canremove ($$$) {
36         # This is sorta overkill, but better safe than sorry.
37         if (! defined pagetype($pagesources{$page})) {
38                 if (IkiWiki::Plugin::attachment->can("check_canattach")) {
39 -                       IkiWiki::Plugin::attachment::check_canattach($session, $page, $file);
40 +                       IkiWiki::Plugin::attachment::check_canattach($session, $page, "$config{srcdir}/$file");
41                 }
42                 else {
43                         error("removal of attachments is not allowed");
44 diff --git a/IkiWiki/Plugin/rename.pm b/IkiWiki/Plugin/rename.pm
45 index 3908443..1a9da63 100644
46 --- a/IkiWiki/Plugin/rename.pm
47 +++ b/IkiWiki/Plugin/rename.pm
48 @@ -50,7 +50,7 @@ sub check_canrename ($$$$$$) {
49         IkiWiki::check_canedit($src, $q, $session);
50         if ($attachment) {
51                 if (IkiWiki::Plugin::attachment->can("check_canattach")) {
52 -                       IkiWiki::Plugin::attachment::check_canattach($session, $src, $srcfile);
53 +                       IkiWiki::Plugin::attachment::check_canattach($session, $src, "$config{srcdir}/$srcfile");
54                 }
55                 else {
56                         error("renaming of attachments is not allowed");
57 @@ -85,7 +85,7 @@ sub check_canrename ($$$$$$) {
58                 if ($attachment) {
59                         # Note that $srcfile is used here, not $destfile,
60                         # because it wants the current file, to check it.
61 -                       IkiWiki::Plugin::attachment::check_canattach($session, $dest, $srcfile);
62 +                       IkiWiki::Plugin::attachment::check_canattach($session, $dest, "$config{srcdir}/$srcfile");
63                 }
64         }
65 </pre>