ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / bugs / Exception:_Unknown_function___96__this__39___.mdwn
1 I'm very excited to try out ikiwiki, since it should fit my purposes extremely well, but I'm having trouble with the search plugin. I'm pretty sure that right after I installed ikiwiki and needed dependencies, the search plugin was working fine. However, now when I try to use search, I get "Exception: Unknown function `this'" error on a blank page. I'm not sure how I should go about debugging this issue - my server's (I use Lighttpd 1.4.22) error log has no mention of the exception and there's nothing in /var/log/syslog either.
2
3 What might be causing this exception and how I might go about debugging exceptions?
4
5 > Appears to be coming from your xapian omega cgi binary. If you
6 > run `strings /usr/lib/cgi-bin/omega/omega` you can see it has
7 > "Exception: " in it, and I have found some similar (but not identical)
8 > error messages from xapian in a web search.
9
10 > I donĀ“t know what to suggest, other than upgrade/downgrade/reinstall
11 > xapian-omega, and contacting the xapian developers for debugging.
12 > You could try rebuilding your wiki in case it is somehow
13 > caused by a problem with the xapian database. Failing everything, you
14 > could switch to [[google_search_plugin|plugins/google]]. --[[Joey]] 
15
16 >> Thanks, Joey. With your help I was able to figure out what was wrong. It's a fun little bug (or feature): the title of my wiki had string `$this` in title and that's what was causing the omega binary to choke. My wiki's title was inserted without escaping into the query template used by omega. Omega treated `$this` in the title as a function name and threw an exception because no such function was defined. To avoid this behavior, I used an html entity in the title, so `$this` became `$this`. I don't think that the wiki title should be inserted into the template without escaping - it can produce an error that's not trivial to debug. If users want to modify the html in the title, they should be editing respective templates, not typing html in the wiki title input. What do you think? --[[dkobozev]]
17
18 >>> Sounds like a bug in omega, and one that probably would affect other
19 >>> users of omega too. Ikiwiki could work around it by pre-escaping
20 >>> data before passing it to xapian. I have not quite managed to reproduce it though;
21 >>> tried setting a page title to '$this' and 'foo $this'.
22 >>> That's with version 1.0.18 of omega.
23 >>> --[[Joey]]
24
25 >>>> I tried it with both omega 1.0.13 and omega 1.0.18 and the issue is present in both. If I view the contents of {$srcdir}/.ikiwiki/xapian/templates/query, I can see that the wiki title is inserted verbatim and there are calls to `$setmap`, `$set` and `$def` etc in the template. --[[dkobozev]]
26
27 >>>>> I don't see how that's relevant. It would help if you showed me
28 >>>>> exactly something that could be inserted into a page to cause the
29 >>>>> problem. --[[Joey]] 
30
31 >>>>>> Correct me if I'm wrong: ikiwiki generates an Omega template from its own templates, such as searchquery.tmpl and puts it into {$srcdir}/.ikiwiki/xapian/templates/query. Omega has its own template syntax, where function names are prefixed with dollar signs (`$`). So, when I call my wiki `$foobar`, ikiwiki generates an Omega template that looks like this snippet:
32
33     <div id="container">
34         <div class="pageheader">
35             <div class="header">
36             <span>
37             <a href="http://example.com">$foobar</    a>/search
38             </span>
39             </div>
40         </div> <!-- .pageheader -->
41     
42         <div id="content">
43             $setmap{prefix,title,S}
44     $setmap{prefix,link,XLINK}
45     $set{thousand,$.}$set{decimal,.}$setmap{BN,,Any Country,uk,England,fr,France}
46     ${
47     $def{PREV,
48     $if{$ne{$topdoc,0},<INPUT TYPE=image NAME="&lt;" ALT="&lt;"
49     SRC="/images/xapian-omega/prev.png" BORDER=0 HEIGHT=30 WIDTH=30>,
50     <IMG ALT="" SRC="/images/xapian-omega/prevoff.png" HEIGHT=30 WIDTH=30>}
51
52 >>>>>> So `$foobar` clashes with Omega's template tags. Does this help?
53
54 >>>>>>> Ahh. I had somehow gotten it into my head that you were talking
55 >>>>>>> about the title of a single page, not of the whole wiki. But
56 >>>>>>> you were clear all along it was the wiki title. Sorry for
57 >>>>>>> misunderstanding. I've put in a complete fix for this problem.
58 >>>>>>> if this was in [[bugs]], I'd close it. :) --[[Joey]] 
59
60 >>>>>>>> Rather than escaping `$` as an HTML entity, it would be more natural
61 >>>>>>>> to escape it as `$$` (since you are escaping it for Omega, not for
62 >>>>>>>> the web browser.
63 >>>>>>>>
64 >>>>>>>> Also if ikiwiki can put arbitrary text inside the parameters of an
65 >>>>>>>> OmegaScript command, you should also escape `{`, `}` and `,` as
66 >>>>>>>> `$(`, `$)` and `$.`.  It's only necessary to do so inside the
67 >>>>>>>> parameters of a command, but it will work and be easier to escape
68 >>>>>>>> them in any substituted text. --OllyBetts
69
70 [[done]]