also tag 'patch/core', considering that over half of the changes are there
[ikiwiki] / doc / todo / tracking_bugs_with_dependencies.mdwn
1 [[!tag patch patch/core]]
2
3 I like the idea of [[tips/integrated_issue_tracking_with_ikiwiki]], and I do so on several wikis.  However, as far as I can tell, ikiwiki has no functionality which can represent dependencies between bugs and allow pagespecs to select based on dependencies.  For instance, I can't write a pagespec which selects all bugs with no dependencies on bugs not marked as done.  --[[JoshTriplett]]
4
5 > I started having a think about this.  I'm going to start with the idea that expanding
6 > the pagespec syntax is the way to attack this.  It seems that any pagespec that is going
7 > to represent "all bugs with no dependencies on bugs not marked as done" is going to
8 > need some way to represent "bugs not marked as done" as a collection of pages, and
9 > then represent "bugs which do not link to pages in the previous collection".
10 >
11 > One way to do this would be to introduce variables into the pagespec, along with
12 > universal and/or existential [[!wikipedia Quantification]].  That looks quite complex.
13 >
14 >> I thought about this briefly, and got about that far.. glad you got
15 >> further. :-) --[[Joey]]
16
17 >> Or, one [[!taglink could_also_refer|pagespec_in_DL_style]] to the language of [[!wikipedia description logics]]: their formulas actually define classes of objects through quantified relations to other classes. --Ivan Z.
18
19 > Another option would be go with a more functional syntax.  The concept here would
20 > be to allow a pagespec to appear in a 'pagespec function' anywhere a page can.  e.g.
21 > I could pass a pagespec to `link()` and that would return true if there is a link to any
22 > page matching the pagespec.  This makes the variables and existential quantification
23 > implicit.  It would allow the example requested above:
24 >
25 >> `bugs/* and !*/Discussion and !link(bugs/* and !*/Discussion and !link(done))`
26 >
27 > Unfortunately, this is also going to make the pagespec parsing more complex because
28 > we now need to parse nested sets of parentheses to know when the nested pagespec
29 > ends, and that isn't a regular language (we can't use regular expression matching for
30 > easy parsing).
31 >
32 >> Also, it may cause ambiguities with page names that contain parens
33 >> (though some such ambigutities already exist with the pagespec syntax).
34 >
35 > One simplification of that would be to introduce some pagespec [[shortcuts]].  We could
36 > then allow pagespec functions to take either pages, or named pagespec shortcuts.  The
37 > pagespec shortcuts would just be listed on a special page, like current [[shortcuts]].
38 > (It would probably be a good idea to require that shortcuts on that page can only refer
39 > to named pagespecs higher up that page than themselves.  That would stop some
40 > looping issues...)  These shortcuts would be used as follows: when trying to match
41 > a page (without globs) you look to see if the page exists.  If it does then you have a
42 > match.  If it doesn't, then you look to see if a similarly named pagespec shortcut
43 > exists.  If it does, then you check that pagespec recursively to see if you have a match.
44 > The ordering requirement on named pagespecs stops infinite recursion.
45 >
46 > Does that seem like a reasonable first approach?
47 >
48 > -- [[Will]]
49
50 >> Having a separate page for the shortcuts feels unwieldly.. perhaps
51 >> instead the shortcut could be defined earlier in the scope of the same
52 >> pagespec that uses it?
53 >> 
54 >> Example: `define(~bugs, bugs/* and !*/Discussion) and define(~openbugs, ~bugs and !link(done)) and ~openbugs and !link(~openbugs)`
55
56 >>> That could work.  parens are only ever nested 1 deep in that grammar so it is regular and the current parsing would be ok.
57
58 >> Note that I made the "~" explicit, not implicit, so it could be left out. In the case of ambiguity between
59 >> a definition and a page name, the definition would win.
60
61 >>> That was my initial thought too :), but when implementing it I decided that requiring the ~ made things easier.  I'll probably require the ~ for the first pass at least.
62
63 >> So, equivilant example: `define(bugs, bugs/* and !*/Discussion) and define(openbugs, bugs and !link(done)) and openbugs and !link(openbugs)`
64 >> 
65
66 >> Re recursion, it is avoided.. but building a pagespec that is O(N^X) where N is the
67 >> number of pages in the wiki is not avoided. Probably need to add DOS prevention.
68 >>  --[[Joey]]
69
70 >>> If you memoize the outcomes of the named pagespecs you can make in O(N.X), no?
71 >>> -- [[Will]]
72
73 >>>> Yeah, guess that'd work. :-)
74
75 > <a id="another_kind_of_links" />One quick further thought.  All the above discussion assumes that 'dependency' is the
76 > same as 'links to', which is not really true.  For example, you'd like to be able to say
77 > "This bug does not depend upon [ [ link to other bug ] ]" and not have a dependency.
78 > Without having different types of links, I don't see how this would be possible.
79 >
80 > -- [[Will]]
81
82 >> I saw that this issue is targeted at by the work on [[structured page data#another_kind_of_links]]. --Ivan Z.
83
84 Okie - I've had a quick attempt at this.  Initial patch attached.  This one doesn't quite work.
85 And there is still a lot of debugging stuff in there.
86
87 At the moment I've added a new preprocessor plugin, `definepagespec`, which is like
88 shortcut for pagespecs.  To reference a named pagespec, use `~` like this:
89
90     [ [!definepagespec name="bugs" spec="bugs/* and !*/Discussion"]]
91     [ [!definepagespec name="openbugs" spec="~bugs and !link(done)"]]
92     [ [!definepagespec name="readybugs" spec="~openbugs and !link(~openbugs)"]]
93
94 At the moment the problem is in `match_link()` when we're trying to find a sub-page that
95 matches the appropriate page spec.  There is no good list of pages available to iterate over.
96
97     foreach my $nextpage (keys %IkiWiki::pagesources)
98
99 does not give me a good list of pages.  I found the same thing when I was working on
100 this todo [[todo/Add_a_plugin_to_list_available_pre-processor_commands]].
101
102 > I'm not sure why iterating over `%pagesources` wouldn't work here, it's the same method
103 > used by anything that needs to match a pagespec against all pages..? --[[Joey]]
104
105 >> My uchecked hypothesis is that %pagesources is created after the refresh hook.
106 >> I've also been concerned about how globally defined pagespec shortcuts would interact with
107 >> the page dependancy system.  Your idea of internally defined shortcuts should fix that. -- [[Will]]
108
109 >>> You're correct, the refresh hook is run very early, before pagesources
110 >>> is populated. (It will be partially populated on a refresh, but will
111 >>> not be updated to reflect new pages.) Agree that internally defined
112 >>> seems the way to go. --[[Joey]]
113
114 Immediately below is a patch which seems to basically work.  Lots of debugging code is still there
115 and it needs a cleanup, but I thought it worth posting at this point.  (I was having problems
116 with old style glob lists, so i just switched them off for the moment.)
117
118 The following three inlines work for me with this patch:
119
120     Bugs:
121     
122     [ [!inline pages="define(~bugs, bugs/* and ! */Discussion) and ~bugs" archive="yes"]]
123     
124     OpenBugs:
125     
126     [ [!inline pages="define(~bugs, bugs/* and ! */Discussion) and define(~openbugs,~bugs and !link(done)) and ~openbugs" archive="yes"]]
127     
128     ReadyBugs:
129     
130     [ [!inline pages="define(~bugs, bugs/* and ! */Discussion) and define(~openbugs,~bugs and !link(done)) and define(~readybugs,~openbugs and !link(~openbugs)) and ~readybugs" archive="yes"]]
131
132 > Nice! Could the specfuncsref be passed in %params? I'd like to avoid
133 > needing to change the prototype of every pagespec function, since several
134 > plugins define them too. --[[Joey]]
135
136 >> Maybe - it needs more thought.  I also considered it when I was going though changing all those plugins :).
137 >> My concern was that `%params` can contain other user-defined parameters,
138 >> e.g. `link(target, otherparameter)`, and that means that the specFuncs could be clobbered by a user (or other
139 >> weird security hole).  I thought it better to separate it, but I didn't think about it too hard.  I might move it to
140 >> the first parameter rather than the second.  Ikiwiki is my first real perl hacking and I'm still discovering
141 >> good ways to write things in perl.
142 >>
143 >>>> `%params` contains the parameters passed to `pagespec_match`, not
144 >>>> user-supplied parameters. The user-supplied parameter to a function
145 >>>> like `match_glob()` or `match_link()` is passed in the second positional parameter. --[[Joey]]
146
147 >>>>> OK.  That seems reasonable then.  The only problem is that my PERLfu is not strong enough to make it
148 >>>>> work.  I really have to wonder what substance was influencing the designers of PERL...
149 >>>>> I can't figure out how to use the %params.  And I'm pissed off enough with PERL that I'm not going
150 >>>>> to try and figure it out any more.  There are two patches below now.  The first one uses an extra
151 >>>>> argument and works.  The second one tries to use %params and doesn't - take your pick :-). -- [[Will]]
152
153 >> What do you think is best to do about `is_globlist()`?  At the moment it requires that the 'second word', as
154 >> delimited by a space and ignoring parens, is 'and' or 'or'.  This doesn't hold in the above example pagespecs (so I just hard wired it to 0 to test my patch).
155 >> My thought was just to search for 'and' or 'or' as words anywhere in the pagespec.  Thoughts?
156
157 >>> Dunno, we could just finish deprecating it. Or change the regexp to
158 >>> skip over spaces in parens. (`/[^\s]+\s+([^)]+)/`) --[[Joey]]
159
160 >>>> I think I have a working regexp now.
161
162 >> Oh, one more thing.  In pagespec_translate (now pagespec_makeperl), there is a part of the regular expression for `# any other text`.
163 >> This contained `()`, which has no effect.  I replaced that with `\(\)`, but that is a change in the definition of pagespecs unrelated to the
164 >> rest of this patch. In a related change, commands were not able to contain `)` in their parameters.  I've extended that so the cannot
165 >> contain `(` or `)`.  -- [[Will]]
166
167 >>> `[^\s()]+` is a character class matching all characters not spaces or
168 >>> parens. Since the pervious terminals in the regexp consume most
169 >>> occurances of an open paren or close paren, it's unlikely for one to
170 >>> get through to that part of the regexp. For example, "foo()" will be
171 >>> matched by the command matcher; "(foo)" will be matched by the open
172 >>> paren literal terminal. "foo(" and "foo)" can get through to the
173 >>> end, and would be matched as a page name, if it didn't exclude parens.
174 >>>
175 >>> So why exclude them? Well, consider "foo and(bar and baz)". We don't
176 >>> want it to match "and(" as a page name!
177 >>> 
178 >>> Escaping the parens in the character class actually changes nothing; the
179 >>> changed character class still matches all characters not spaces or
180 >>> parens. (Try it!).
181 >>> 
182 >>> Re commands containing '(', I don't really see any reason not to
183 >>> allow that, unless it breaks something. --[[Joey]]
184
185 >>>> Oh, I didn't realise you didn't need to escape parens inside [].  All else I
186 >>>> I understood.  I have stopped commands from containing parens because
187 >>>> once you allow that then you might have a extra level of depth in the parsing
188 >>>> of define() statements. -- [[Will]]
189
190 >>> Updated patch.  Moved the specFuncsRef to the front of the arg list.  Still haven't thought through the security implications of
191 >>> having it in `%params`.  I've also removed all the debugging `print` statements.  And I've updated the `is_globlist()` function.
192 >>> I think this is ready for people other than me to have a play.  It is not well enough tested to commit just yet.
193 >>> -- [[Will]]
194
195 I've lost track of the indent level, so I'm going back to not indented - I think this is a working [[patch]] taking into
196 account all comments above (which doesn't mean it is above reproach :) ).  --[[Will]]
197
198 > Very belated code review of last version of the patch:
199
200 > * `is_globlist` is no longer needed
201
202 >> Good :)
203
204 > * I don't understand why the pagespec match regexp is changed
205 >   from having flags `igx` to `ixgs`. Don't see why you
206 >   want `.` to match '\n` in it, and don't see any `.` in the regexp 
207 >   anyway?
208
209 >> Because you have to define all the named pagespecs in the pagespec, you sometimes end up with very long pagespecs.  I found it useful to split them over multiple lines.  That didn't work at one point and I added the 's' to make it work.  I may have further altered the regex since then to make the 's' redundant.  Remove it and see if multi-line pagespecs still work. :)
210
211 >>> Well, I can tell you that multi-line pagespecs are supported w/o
212 >>> your patch .. I use them all the time. The reason I find your
213 >>> use of `/s` unlikely is because without it `\s` already matches
214 >>> a newline. Only if you want to treat a newline as non-whitespace
215 >>> is `/s` typically necessary. --[[Joey]] 
216
217 > * Some changes of `@_` to `%params` in `pagespec_makeperl` do not
218 >   make sense to me. I don't see where \%params is defined and populated,
219 >   except with `\$params{specFunc}`.
220
221 >> I'm not a perl hacker.  This was a mighty battle for me to get going.
222 >> There is probably some battlefield carnage from my early struggles
223 >> learning perl left here. Part of this is that @_ / @params already
224 >> existed as a way of passing in extra parameters.  I didn't want to
225 >> pollute that top level namespace - just at my own parameter (a hash)
226 >> which contained the data I needed.
227
228 >>> I think I understand how the various `%params`
229 >>> (there's not just one) work in your code now, but it's really a mess.
230 >>> Explaining it in words would take pages.. It could be fixed by,
231 >>> in `pagespec_makeperl` something like:
232 >>> 
233 >>>     my %specFuncs;
234 >>>     push @_, specFuncs => \%specFuncs;
235 >>> 
236 >>> With that you have the hash locally available for populating
237 >>> inside `pagespec_makeperl`, and when the `match_*` functions
238 >>> are called the same hash data will be available inside their
239 >>> `@_` or `%params`. No need to change how the functions are called
240 >>> or do any of the other hacks.
241 >>>
242 >>> Currently, specFuncs is populated by building up code
243 >>> that recursively calls `pagespec_makeperl`, and is then
244 >>> evaluated when the pagespec gets evaluated. My suggested
245 >>> change to `%params` will break that, but that had to change 
246 >>> anyway.
247 >>>
248 >>> It probably has a security hole, and is certianly inviting
249 >>> one, since the pagespec definition is matched by a loose regexp (`.*`)
250 >>> and then subject to string interpolation before being evaluated
251 >>> inside perl code. I recently changed ikiwiki to never interpolate
252 >>> user-supplied strings when translating pagespecs, and that
253 >>> needs to happen here too. The obvious way, it seems to me,
254 >>> is to not generate perl code, but just directly run perl code that
255 >>> populates specFuncs.
256
257 >>>> I don't think this is as bad as you make out, but your addition of the
258 >>>> data array will break with the recursion my patch adds in pagespec_makeperl.
259 >>>> To fix that I'll need to pass a reference to that array into pagespec_makeperl.
260 >>>> I think I can then do the same thing to $params{specFuncs}.  -- [[Will]]
261
262 >>>>> You're right -- I did not think the recursive case through.
263 >>>>> --[[Joey]] 
264
265 > * Seems that the only reason `match_glob` has to check for `~` is
266 >   because when a named spec appears in a pagespec, it is translated
267 >   to `match_glob("~foo")`. If, instead, `pagespec_makeperl` checked
268 >   for named specs, it could convert them into `check_named_spec("foo")`
269 >   and avoid that ugliness.
270
271 >> Yeah - I wanted to make named specs syntactically different on my first pass.  You are right in that this could be made a fallback - named specs always override pagenames.
272
273 > * The changes to `match_link` seem either unecessary, or incomplete.
274 >   Shouldn't it check for named specs and call
275 >   `check_named_spec_existential`?
276
277 >>  An earlier version did.  Then I realised it wasn't actually needed in that case - match_link() already included a loop that was like a type of existential matching.  Each time through the loop it would
278 >> call match_glob().  match_glob() in turn will handle the named spec.  I tested this version briefly and it seemed to work.  I remember looking at this again later and wondering if I had mis-understood
279 >> some of the logic in match_link(), which might mean there are cases where you would need an explicit call to check_named_spec_existential() - I never checked it properly after having that thought.
280
281 >>> In the common case, `match_link` does not call `match_glob`,
282 >>> because the link target it is being asked to check for is a single
283 >>> page name, not a glob.
284
285 >>>> A named pagespec should fall into the glob case.  These two pagespecs should be the same:
286
287     link(a*)
288
289 >>>> and
290
291     define(aStar, a*) and link(~aStar)
292
293 >>>> In the first case, we want the pagespec to match any page that links to a page matching the glob.
294 >>>> In the second case, we want the pagespec to match any page that links to a page matching the named spec.
295 >>>> match_link() was already doing existential part.  The patches to this code were simply to remove the `lc()`
296 >>>> call from the named pagespec name.  Can that `lc` be removed entirely? -- [[Will]]
297
298 >>>>> I think we could get rid of it. `bestlink` will lc it itself
299 >>>>> if the uppercase version does not exist; `match_glob` matches
300 >>>>> insensitively.
301 >>>>> --[[Joey]] 
302
303 > * Generally, the need to modify `match_*` functions so that they
304 >   check for and handle named pagespecs seems suboptimal, if
305 >   only because there might be others people may want to use named
306 >   pagespecs with. It would be possible to move this check
307 >   to `pagespec_makeperl`, by having it check if the parameter
308 >   passed to a pagespec function looked like a named pagespec.
309 >   The only issue is that some pagespec functions take a parameter
310 >   that is not a page name at all, and it could be weird
311 >   if such a parameter were accidentially interpreted as a named
312 >   pagespec. (But, that seems unlikely to happen.)
313
314 >> Possibly.  I'm not sure which I prefer between the current solution and that one.  Each have advantages and disadvantages.
315 >> It really isn't much code for the match functions to add a call to check_named_spec_existential().
316
317 >>> But if a plugin adds its own match function, it has
318 >>> to explicitly call that code to support named pagespecs.
319
320 >>>> Yes, and it can do that in just three lines of code.  But if we automatically check for named pagespecs all the time we
321 >>>> potentially break any matching function that doesn't accept pages, or wants to use multiple arguments.
322
323 >>>>> 3 lines of code, plus the functions called become part of the API,
324 >>>>> don't forget about that..
325 >>>>>
326 >>>>> Yes, I think that is the tradeoff, the question is whether to export
327 >>>>> the additional complexity needed for that flexability.
328 >>>>>
329 >>>>> I'd be suprised if multiple argument pagespecs become necessary..
330 >>>>> with the exception of this patch there has been no need for them yet.
331 >>>>>
332 >>>>> There are lots of pagespecs that take data other than pages,
333 >>>>> indeed, that's really the common case. So far, none of them 
334 >>>>> seem likely to take data that starts with a `~`. Perhaps
335 >>>>> the thing to do would be to check if `~foo` is a known,
336 >>>>> named pagespec, and if not, just pass it through unchanged.
337 >>>>> Then there's little room for ambiguity, and this also allows
338 >>>>> pagespecs like `glob(~foo*)` to match the literal page `~foo`.
339 >>>>> (It will make pagespec_merge even harder tho.. see below.)
340 >>>>> --[[Joey]] 
341
342 >>>>>> I've already used multi-argument pagespec match functions in
343 >>>>>> my data plugin.  It is used for having different types of links.  If
344 >>>>>> you want to have multiple types of links, then the match function
345 >>>>>> for them needs to take both the link name and the link type.
346 >>>>>> I'm trying to think of a way we could have both - automatically
347 >>>>>> handle the existential case unless the function indicates somehow
348 >>>>>> that it'll do it itself.  Any ideas?  -- [[Will]]
349
350 > * I need to check if your trick to avoid infinite recursion
351 >   works if there are two named specs that recursively
352 >   call one-another. I suspect it does, but will test this
353 >   myself..
354
355 >> It worked for me. :)
356
357 > * I also need to verify if memoizing the named pagespecs has
358 >   really guarded against very expensive pagespecs DOSing the wiki..
359
360 > --[[Joey]] 
361
362 >>  There is one issue that I've been thinking about that I haven't raised anywhere (or checked myself), and that is how this all interacts with page dependencies.
363 >> 
364 >>> I've moved the discussion of that to [[dependency_types]]. --[[Joey]] 
365 >>
366 >>  I'm not sure anymore that the `pagespec_merge` function will continue to work in all cases.
367
368 >>> The problem I can see there is that if two pagespecs
369 >>> get merged and both use `~foo` but define it differently,
370 >>> then the second definition might be used at a point when
371 >>> it shouldn't (but I haven't verified that really happens).
372 >>> That could certianly be a show-stopper. --[[Joey]] 
373
374 >>>> I think this can happen in the new closure based code.  I don't think this could happen in the old code.  -- [[Will]]
375
376 >>>> Even if that works, this is a good argument for having a syntactic difference between named pagespecs and normal pages.
377 >>>> If you're joining two pagespecs with 'or', you don't want a named pagespec in the first part overriding a page name in the
378 >>>> second part.  Oh, and I assume 'or' has the right operator precedence that "a and b or c" is "(a and b) or c", and not "a and (b or c)" -- [[Will]]
379
380 >>>>> Looks like its bracketed in the code anyway... -- [[Will]]
381
382 >>>> Perhaps the thing to do is to have a `clear_defines()`
383 >>>> function, then merging `A` and `B` yields `(A) or (clear_defines() and (B))`
384 >>>> That would deal with both the cases where `A` and `B` differently
385 >>>> define `~foo` as well as with the case where `A` defines `~foo` while
386 >>>> `B` uses it to refer to a literal page.
387 >>>> --[[Joey]]
388
389 >>>>> I don't think this will work with the new patch, and I don't think it was needed with the old one.
390 >>>>> Under the old patch, pagespec_makeperl() generated a string of unevaluated, self-contained, perl
391 >>>>> code.  When a new named pagespec was defined, a recursive call was made to get the perl code
392 >>>>> for the pagespec, and then that code was used to add something like `$params{specFuncs}->{name} = sub {recursive code} and `
393 >>>>> to the result of the calling function.  This means that at pagespec testing time, when this code is executed, the
394 >>>>> specFuncs hash is built up as the pagespec is checked.  In the case of the 'or' used above, later redefinitions of
395 >>>>> a named pagespec would have redefined the specFunc at the right time.  It should have just worked.  However...
396
397 >>>>> Since my original patch, you started using closures for security reasons (and I can see the case for that).  Unfortunately this
398 >>>>> means that the generated perl code is no longer self-contained - it needs to be evaluated in the same closure it was generated
399 >>>>> so that it has access to the data array.  To make this work with the recursive call I had two options: a) make the data array a
400 >>>>> reference that I pass around through the pagespec_makeperl() functions and have available when the code is finally evaluated
401 >>>>> in pagespec_translate(), or b) make sure that each pagespec is evaluated in its correct closure and a perl function is returned, not a
402 >>>>> string containing unevaluated perl code.
403
404 >>>>> I went with option b).  I did it in such a way that the hash of specfuncs is built up at translation time, not at execution time.  This
405 >>>>> means that with the new code you can call specfuncs that get defined out of order:
406
407     ~test and define(~test, blah)
408
409 >>>>> but it also means that using a simple 'or' to join two pagespecs wont work.  If you do something like this:
410
411     ~test and define(~test, foo) and define(~test, baz)
412
413 >>>>> then the last definition (baz) takes precedence.
414 >>>>> In the process of writing this I think I've come up with a way to change this back the way it was, still using closures. -- [[Will]]
415
416 >>> My [[remove-pagespec-merge|should_optimise_pagespecs]] branch has now
417 >>> solved all this by deleting the offending function :-) --[[smcv]]
418
419
420
421 Patch updated to use closures rather than inline generated code for named pagespecs.  Also includes some new use of ErrorReason where appropriate. -- [[Will]]
422
423 > * Perl really doesn't need forward declarations, honest!
424
425 >> It complained (warning, not error) when I didn't use the forward declaration. :(
426
427 > * I have doubts about memoizing the anonymous sub created by
428 >   `pagespec_translate`.
429
430 >> This is there explicitly to make sure that runtime is polynomial and not exponential.
431
432 > * Think where you wrote `+{}` you can just write `{}`
433
434 >> Possibly :) -- [[Will]]
435
436 ----
437
438     diff --git a/IkiWiki.pm b/IkiWiki.pm
439     index 061a1c6..1e78a63 100644
440     --- a/IkiWiki.pm
441     +++ b/IkiWiki.pm
442     @@ -1774,8 +1774,12 @@ sub pagespec_merge ($$) {
443         return "($a) or ($b)";
444      }
445      
446     -sub pagespec_translate ($) {
447     +# is perl really so dumb it requires a forward declaration for recursive calls?
448     +sub pagespec_translate ($$);
449     +
450     +sub pagespec_translate ($$) {
451         my $spec=shift;
452     +   my $specFuncsRef=shift;
453      
454         # Convert spec to perl code.
455         my $code="";
456     @@ -1789,7 +1793,9 @@ sub pagespec_translate ($) {
457                 |
458                         \)              # )
459                 |
460     -                   \w+\([^\)]*\)   # command(params)
461     +                   define\(\s*~\w+\s*,((\([^()]*\)) | ([^()]+))+\) # define(~specName, spec) - spec can contain parens 1 deep
462     +           |
463     +                   \w+\([^()]*\)   # command(params) - params cannot contain parens
464                 |
465                         [^\s()]+        # any other text
466                 )
467     @@ -1805,10 +1811,19 @@ sub pagespec_translate ($) {
468                 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
469                         $code.=' '.$word;
470                 }
471     -           elsif ($word =~ /^(\w+)\((.*)\)$/) {
472     +           elsif ($word =~ /^define\(\s*(~\w+)\s*,(.*)\)$/s) {
473     +                   my $name = $1;
474     +                   my $subSpec = $2;
475     +                   my $newSpecFunc = pagespec_translate($subSpec, $specFuncsRef);
476     +                   return if $@ || ! defined $newSpecFunc;
477     +                   $specFuncsRef->{$name} = $newSpecFunc;
478     +                   push @data, qq{Created named pagespec "$name"};
479     +                   $code.="IkiWiki::SuccessReason->new(\$data[$#data])";
480     +           }
481     +           elsif ($word =~ /^(\w+)\((.*)\)$/s) {
482                         if (exists $IkiWiki::PageSpec::{"match_$1"}) {
483                                 push @data, $2;
484     -                           $code.="IkiWiki::PageSpec::match_$1(\$page, \$data[$#data], \@_)";
485     +                           $code.="IkiWiki::PageSpec::match_$1(\$page, \$data[$#data], \@_, specFuncs => \$specFuncsRef)";
486                         }
487                         else {
488                                 push @data, qq{unknown function in pagespec "$word"};
489     @@ -1817,7 +1832,7 @@ sub pagespec_translate ($) {
490                 }
491                 else {
492                         push @data, $word;
493     -                   $code.=" IkiWiki::PageSpec::match_glob(\$page, \$data[$#data], \@_)";
494     +                   $code.=" IkiWiki::PageSpec::match_glob(\$page, \$data[$#data], \@_, specFuncs => \$specFuncsRef)";
495                 }
496         }
497      
498     @@ -1826,7 +1841,7 @@ sub pagespec_translate ($) {
499         }
500      
501         no warnings;
502     -   return eval 'sub { my $page=shift; '.$code.' }';
503     +   return eval 'memoize (sub { my $page=shift; '.$code.' })';
504      }
505      
506      sub pagespec_match ($$;@) {
507     @@ -1839,7 +1854,7 @@ sub pagespec_match ($$;@) {
508                 unshift @params, 'location';
509         }
510      
511     -   my $sub=pagespec_translate($spec);
512     +   my $sub=pagespec_translate($spec, +{});
513         return IkiWiki::ErrorReason->new("syntax error in pagespec \"$spec\"")
514                 if $@ || ! defined $sub;
515         return $sub->($page, @params);
516     @@ -1850,7 +1865,7 @@ sub pagespec_match_list ($$;@) {
517         my $spec=shift;
518         my @params=@_;
519      
520     -   my $sub=pagespec_translate($spec);
521     +   my $sub=pagespec_translate($spec, +{});
522         error "syntax error in pagespec \"$spec\""
523                 if $@ || ! defined $sub;
524         
525     @@ -1872,7 +1887,7 @@ sub pagespec_match_list ($$;@) {
526      sub pagespec_valid ($) {
527         my $spec=shift;
528      
529     -   my $sub=pagespec_translate($spec);
530     +   my $sub=pagespec_translate($spec, +{});
531         return ! $@;
532      }
533      
534     @@ -1919,6 +1934,68 @@ sub new {
535      
536      package IkiWiki::PageSpec;
537      
538     +sub check_named_spec($$;@) {
539     +   my $page=shift;
540     +   my $specName=shift;
541     +   my %params=@_;
542     +
543     +   return IkiWiki::ErrorReason->new("Unable to find specFuncs in params to check_named_spec()!")
544     +           unless exists $params{specFuncs};
545     +
546     +   my $specFuncsRef=$params{specFuncs};
547     +
548     +   return IkiWiki::ErrorReason->new("Named page spec '$specName' is not valid")
549     +           unless (substr($specName, 0, 1) eq '~');
550     +
551     +   if (exists $specFuncsRef->{$specName}) {
552     +           # remove the named spec from the spec refs
553     +           # when we recurse to avoid infinite recursion
554     +           my $sub = $specFuncsRef->{$specName};
555     +           delete $specFuncsRef->{$specName};
556     +           my $result = $sub->($page, %params);
557     +           $specFuncsRef->{$specName} = $sub;
558     +           return $result;
559     +   } else {
560     +           return IkiWiki::ErrorReason->new("Page spec '$specName' does not exist");
561     +   }
562     +}
563     +
564     +sub check_named_spec_existential($$$;@) {
565     +   my $page=shift;
566     +   my $specName=shift;
567     +   my $funcref=shift;
568     +   my %params=@_;
569     +
570     +   return IkiWiki::ErrorReason->new("Unable to find specFuncs in params to check_named_spec_existential()!")
571     +                   unless exists $params{specFuncs};
572     +   my $specFuncsRef=$params{specFuncs};
573     +   
574     +   return IkiWiki::ErrorReason->new("Named page spec '$specName' is not valid")
575     +           unless (substr($specName, 0, 1) eq '~');
576     +
577     +   if (exists $specFuncsRef->{$specName}) {
578     +           # remove the named spec from the spec refs
579     +           # when we recurse to avoid infinite recursion
580     +           my $sub = $specFuncsRef->{$specName};
581     +           delete $specFuncsRef->{$specName};
582     +           
583     +           foreach my $nextpage (keys %IkiWiki::pagesources) {
584     +                   if ($sub->($nextpage, %params)) {
585     +                           my $tempResult = $funcref->($page, $nextpage, %params);
586     +                           if ($tempResult) {
587     +                                   $specFuncsRef->{$specName} = $sub;
588     +                                   return IkiWiki::SuccessReason->new("Existential check of '$specName' matches because $tempResult");
589     +                           }
590     +                   }
591     +           }
592     +           
593     +           $specFuncsRef->{$specName} = $sub;
594     +           return IkiWiki::FailReason->new("No page in spec '$specName' was successfully matched");
595     +   } else {
596     +           return IkiWiki::ErrorReason->new("Named page spec '$specName' does not exist");
597     +   }
598     +}
599     +
600      sub derel ($$) {
601         my $path=shift;
602         my $from=shift;
603     @@ -1937,6 +2014,10 @@ sub match_glob ($$;@) {
604         my $glob=shift;
605         my %params=@_;
606         
607     +   if (substr($glob, 0, 1) eq '~') {
608     +           return check_named_spec($page, $glob, %params);
609     +   }
610     +
611         $glob=derel($glob, $params{location});
612      
613         my $regexp=IkiWiki::glob2re($glob);
614     @@ -1959,8 +2040,9 @@ sub match_internal ($$;@) {
615      
616      sub match_link ($$;@) {
617         my $page=shift;
618     -   my $link=lc(shift);
619     +   my $fullLink=shift;
620         my %params=@_;
621     +   my $link=lc($fullLink);
622      
623         $link=derel($link, $params{location});
624         my $from=exists $params{location} ? $params{location} : '';
625     @@ -1975,25 +2057,37 @@ sub match_link ($$;@) {
626                 }
627                 else {
628                         return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
629     -                           if match_glob($p, $link, %params);
630     +                           if match_glob($p, $fullLink, %params);
631                         $p=~s/^\///;
632                         $link=~s/^\///;
633                         return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
634     -                           if match_glob($p, $link, %params);
635     +                           if match_glob($p, $fullLink, %params);
636                 }
637         }
638         return IkiWiki::FailReason->new("$page does not link to $link");
639      }
640      
641      sub match_backlink ($$;@) {
642     -   return match_link($_[1], $_[0], @_);
643     +   my $page=shift;
644     +   my $backlink=shift;
645     +   my @params=@_;
646     +
647     +   if (substr($backlink, 0, 1) eq '~') {
648     +           return check_named_spec_existential($page, $backlink, \&match_backlink, @params);
649     +   }
650     +
651     +   return match_link($backlink, $page, @params);
652      }
653      
654      sub match_created_before ($$;@) {
655         my $page=shift;
656         my $testpage=shift;
657         my %params=@_;
658     -   
659     +
660     +   if (substr($testpage, 0, 1) eq '~') {
661     +           return check_named_spec_existential($page, $testpage, \&match_created_before, %params);
662     +   }
663     +
664         $testpage=derel($testpage, $params{location});
665      
666         if (exists $IkiWiki::pagectime{$testpage}) {
667     @@ -2014,6 +2108,10 @@ sub match_created_after ($$;@) {
668         my $testpage=shift;
669         my %params=@_;
670         
671     +   if (substr($testpage, 0, 1) eq '~') {
672     +           return check_named_spec_existential($page, $testpage, \&match_created_after, %params);
673     +   }
674     +
675         $testpage=derel($testpage, $params{location});
676      
677         if (exists $IkiWiki::pagectime{$testpage}) {