1 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]]
3 > I started having a think about this. I'm going to start with the idea that expanding
4 > the pagespec syntax is the way to attack this. It seems that any pagespec that is going
5 > to represent "all bugs with no dependencies on bugs not marked as done" is going to
6 > need some way to represent "bugs not marked as done" as a collection of pages, and
7 > then represent "bugs which do not link to pages in the previous collection".
9 > One way to do this would be to introduce variables into the pagespec, along with
10 > universal and/or existential [[!wikipedia Quantification]]. That looks quite complex.
12 >> I thought about this briefly, and got about that far.. glad you got
13 >> further. :-) --[[Joey]]
15 >> 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.
17 > Another option would be go with a more functional syntax. The concept here would
18 > be to allow a pagespec to appear in a 'pagespec function' anywhere a page can. e.g.
19 > I could pass a pagespec to `link()` and that would return true if there is a link to any
20 > page matching the pagespec. This makes the variables and existential quantification
21 > implicit. It would allow the example requested above:
23 >> `bugs/* and !*/Discussion and !link(bugs/* and !*/Discussion and !link(done))`
25 > Unfortunately, this is also going to make the pagespec parsing more complex because
26 > we now need to parse nested sets of parentheses to know when the nested pagespec
27 > ends, and that isn't a regular language (we can't use regular expression matching for
30 >> Also, it may cause ambiguities with page names that contain parens
31 >> (though some such ambigutities already exist with the pagespec syntax).
33 > One simplification of that would be to introduce some pagespec [[shortcuts]]. We could
34 > then allow pagespec functions to take either pages, or named pagespec shortcuts. The
35 > pagespec shortcuts would just be listed on a special page, like current [[shortcuts]].
36 > (It would probably be a good idea to require that shortcuts on that page can only refer
37 > to named pagespecs higher up that page than themselves. That would stop some
38 > looping issues...) These shortcuts would be used as follows: when trying to match
39 > a page (without globs) you look to see if the page exists. If it does then you have a
40 > match. If it doesn't, then you look to see if a similarly named pagespec shortcut
41 > exists. If it does, then you check that pagespec recursively to see if you have a match.
42 > The ordering requirement on named pagespecs stops infinite recursion.
44 > Does that seem like a reasonable first approach?
48 >> Having a separate page for the shortcuts feels unwieldly.. perhaps
49 >> instead the shortcut could be defined earlier in the scope of the same
50 >> pagespec that uses it?
52 >> Example: `define(~bugs, bugs/* and !*/Discussion) and define(~openbugs, ~bugs and !link(done)) and ~openbugs and !link(~openbugs)`
54 >>> That could work. parens are only ever nested 1 deep in that grammar so it is regular and the current parsing would be ok.
56 >> Note that I made the "~" explicit, not implicit, so it could be left out. In the case of ambiguity between
57 >> a definition and a page name, the definition would win.
59 >>> 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.
61 >> So, equivilant example: `define(bugs, bugs/* and !*/Discussion) and define(openbugs, bugs and !link(done)) and openbugs and !link(openbugs)`
64 >> Re recursion, it is avoided.. but building a pagespec that is O(N^X) where N is the
65 >> number of pages in the wiki is not avoided. Probably need to add DOS prevention.
68 >>> If you memoize the outcomes of the named pagespecs you can make in O(N.X), no?
71 >>>> Yeah, guess that'd work. :-)
73 > <a id="another_kind_of_links" />One quick further thought. All the above discussion assumes that 'dependency' is the
74 > same as 'links to', which is not really true. For example, you'd like to be able to say
75 > "This bug does not depend upon [ [ link to other bug ] ]" and not have a dependency.
76 > Without having different types of links, I don't see how this would be possible.
80 >> I saw that this issue is targeted at by the work on [[structured page data#another_kind_of_links]]. --Ivan Z.
82 Okie - I've had a quick attempt at this. Initial patch attached. This one doesn't quite work.
83 And there is still a lot of debugging stuff in there.
85 At the moment I've added a new preprocessor plugin, `definepagespec`, which is like
86 shortcut for pagespecs. To reference a named pagespec, use `~` like this:
88 [ [!definepagespec name="bugs" spec="bugs/* and !*/Discussion"]]
89 [ [!definepagespec name="openbugs" spec="~bugs and !link(done)"]]
90 [ [!definepagespec name="readybugs" spec="~openbugs and !link(~openbugs)"]]
92 At the moment the problem is in `match_link()` when we're trying to find a sub-page that
93 matches the appropriate page spec. There is no good list of pages available to iterate over.
95 foreach my $nextpage (keys %IkiWiki::pagesources)
97 does not give me a good list of pages. I found the same thing when I was working on
98 this todo [[todo/Add_a_plugin_to_list_available_pre-processor_commands]].
100 > I'm not sure why iterating over `%pagesources` wouldn't work here, it's the same method
101 > used by anything that needs to match a pagespec against all pages..? --[[Joey]]
103 >> My uchecked hypothesis is that %pagesources is created after the refresh hook.
104 >> I've also been concerned about how globally defined pagespec shortcuts would interact with
105 >> the page dependancy system. Your idea of internally defined shortcuts should fix that. -- [[Will]]
107 >>> You're correct, the refresh hook is run very early, before pagesources
108 >>> is populated. (It will be partially populated on a refresh, but will
109 >>> not be updated to reflect new pages.) Agree that internally defined
110 >>> seems the way to go. --[[Joey]]
112 Immediately below is a patch which seems to basically work. Lots of debugging code is still there
113 and it needs a cleanup, but I thought it worth posting at this point. (I was having problems
114 with old style glob lists, so i just switched them off for the moment.)
116 The following three inlines work for me with this patch:
120 [ [!inline pages="define(~bugs, bugs/* and ! */Discussion) and ~bugs" archive="yes"]]
124 [ [!inline pages="define(~bugs, bugs/* and ! */Discussion) and define(~openbugs,~bugs and !link(done)) and ~openbugs" archive="yes"]]
128 [ [!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"]]
130 > Nice! Could the specfuncsref be passed in %params? I'd like to avoid
131 > needing to change the prototype of every pagespec function, since several
132 > plugins define them too. --[[Joey]]
134 >> Maybe - it needs more thought. I also considered it when I was going though changing all those plugins :).
135 >> My concern was that `%params` can contain other user-defined parameters,
136 >> e.g. `link(target, otherparameter)`, and that means that the specFuncs could be clobbered by a user (or other
137 >> weird security hole). I thought it better to separate it, but I didn't think about it too hard. I might move it to
138 >> the first parameter rather than the second. Ikiwiki is my first real perl hacking and I'm still discovering
139 >> good ways to write things in perl.
141 >>>> `%params` contains the parameters passed to `pagespec_match`, not
142 >>>> user-supplied parameters. The user-supplied parameter to a function
143 >>>> like `match_glob()` or `match_link()` is passed in the second positional parameter. --[[Joey]]
145 >>>>> OK. That seems reasonable then. The only problem is that my PERLfu is not strong enough to make it
146 >>>>> work. I really have to wonder what substance was influencing the designers of PERL...
147 >>>>> I can't figure out how to use the %params. And I'm pissed off enough with PERL that I'm not going
148 >>>>> to try and figure it out any more. There are two patches below now. The first one uses an extra
149 >>>>> argument and works. The second one tries to use %params and doesn't - take your pick :-). -- [[Will]]
151 >> What do you think is best to do about `is_globlist()`? At the moment it requires that the 'second word', as
152 >> 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).
153 >> My thought was just to search for 'and' or 'or' as words anywhere in the pagespec. Thoughts?
155 >>> Dunno, we could just finish deprecating it. Or change the regexp to
156 >>> skip over spaces in parens. (`/[^\s]+\s+([^)]+)/`) --[[Joey]]
158 >>>> I think I have a working regexp now.
160 >> Oh, one more thing. In pagespec_translate (now pagespec_makeperl), there is a part of the regular expression for `# any other text`.
161 >> This contained `()`, which has no effect. I replaced that with `\(\)`, but that is a change in the definition of pagespecs unrelated to the
162 >> rest of this patch. In a related change, commands were not able to contain `)` in their parameters. I've extended that so the cannot
163 >> contain `(` or `)`. -- [[Will]]
165 >>> `[^\s()]+` is a character class matching all characters not spaces or
166 >>> parens. Since the pervious terminals in the regexp consume most
167 >>> occurances of an open paren or close paren, it's unlikely for one to
168 >>> get through to that part of the regexp. For example, "foo()" will be
169 >>> matched by the command matcher; "(foo)" will be matched by the open
170 >>> paren literal terminal. "foo(" and "foo)" can get through to the
171 >>> end, and would be matched as a page name, if it didn't exclude parens.
173 >>> So why exclude them? Well, consider "foo and(bar and baz)". We don't
174 >>> want it to match "and(" as a page name!
176 >>> Escaping the parens in the character class actually changes nothing; the
177 >>> changed character class still matches all characters not spaces or
178 >>> parens. (Try it!).
180 >>> Re commands containing '(', I don't really see any reason not to
181 >>> allow that, unless it breaks something. --[[Joey]]
183 >>>> Oh, I didn't realise you didn't need to escape parens inside []. All else I
184 >>>> I understood. I have stopped commands from containing parens because
185 >>>> once you allow that then you might have a extra level of depth in the parsing
186 >>>> of define() statements. -- [[Will]]
188 >>> Updated patch. Moved the specFuncsRef to the front of the arg list. Still haven't thought through the security implications of
189 >>> having it in `%params`. I've also removed all the debugging `print` statements. And I've updated the `is_globlist()` function.
190 >>> 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 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
194 account all comments above (which doesn't mean it is above reproach :) ). --[[Will]]
196 > Very belated code review of last version of the patch:
198 > * `is_globlist` is no longer needed
202 > * I don't understand why the pagespec match regexp is changed
203 > from having flags `igx` to `ixgs`. Don't see why you
204 > want `.` to match '\n` in it, and don't see any `.` in the regexp
207 >> 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. :)
209 >>> Well, I can tell you that multi-line pagespecs are supported w/o
210 >>> your patch .. I use them all the time. The reason I find your
211 >>> use of `/s` unlikely is because without it `\s` already matches
212 >>> a newline. Only if you want to treat a newline as non-whitespace
213 >>> is `/s` typically necessary. --[[Joey]]
215 > * Some changes of `@_` to `%params` in `pagespec_makeperl` do not
216 > make sense to me. I don't see where \%params is defined and populated,
217 > except with `\$params{specFunc}`.
219 >> I'm not a perl hacker. This was a mighty battle for me to get going.
220 >> There is probably some battlefield carnage from my early struggles
221 >> learning perl left here. Part of this is that @_ / @params already
222 >> existed as a way of passing in extra parameters. I didn't want to
223 >> pollute that top level namespace - just at my own parameter (a hash)
224 >> which contained the data I needed.
226 >>> I think I understand how the various `%params`
227 >>> (there's not just one) work in your code now, but it's really a mess.
228 >>> Explaining it in words would take pages.. It could be fixed by,
229 >>> in `pagespec_makeperl` something like:
232 >>> push @_, specFuncs => \%specFuncs;
234 >>> With that you have the hash locally available for populating
235 >>> inside `pagespec_makeperl`, and when the `match_*` functions
236 >>> are called the same hash data will be available inside their
237 >>> `@_` or `%params`. No need to change how the functions are called
238 >>> or do any of the other hacks.
240 >>> Currently, specFuncs is populated by building up code
241 >>> that recursively calls `pagespec_makeperl`, and is then
242 >>> evaluated when the pagespec gets evaluated. My suggested
243 >>> change to `%params` will break that, but that had to change
246 >>> It probably has a security hole, and is certianly inviting
247 >>> one, since the pagespec definition is matched by a loose regexp (`.*`)
248 >>> and then subject to string interpolation before being evaluated
249 >>> inside perl code. I recently changed ikiwiki to never interpolate
250 >>> user-supplied strings when translating pagespecs, and that
251 >>> needs to happen here too. The obvious way, it seems to me,
252 >>> is to not generate perl code, but just directly run perl code that
253 >>> populates specFuncs.
255 > * Seems that the only reason `match_glob` has to check for `~` is
256 > because when a named spec appears in a pagespec, it is translated
257 > to `match_glob("~foo")`. If, instead, `pagespec_makeperl` checked
258 > for named specs, it could convert them into `check_named_spec("foo")`
259 > and avoid that ugliness.
261 >> 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.
263 > * The changes to `match_link` seem either unecessary, or incomplete.
264 > Shouldn't it check for named specs and call
265 > `check_named_spec_existential`?
267 >> 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
268 >> 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
269 >> 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.
271 >>> In the common case, `match_link` does not call `match_glob`,
272 >>> because the link target it is being asked to check for is a single
273 >>> page name, not a glob.
275 > * Generally, the need to modify `match_*` functions so that they
276 > check for and handle named pagespecs seems suboptimal, if
277 > only because there might be others people may want to use named
278 > pagespecs with. It would be possible to move this check
279 > to `pagespec_makeperl`, by having it check if the parameter
280 > passed to a pagespec function looked like a named pagespec.
281 > The only issue is that some pagespec functions take a parameter
282 > that is not a page name at all, and it could be weird
283 > if such a parameter were accidentially interpreted as a named
284 > pagespec. (But, that seems unlikely to happen.)
286 >> Possibly. I'm not sure which I prefer between the current solution and that one. Each have advantages and disadvantages.
287 >> It really isn't much code for the match functions to add a call to check_named_spec_existential().
289 >>> But if a plugin adds its own match function, it has
290 >>> to explicitly call that code to support named pagespecs.
292 > * I need to check if your trick to avoid infinite recursion
293 > works if there are two named specs that recursively
294 > call one-another. I suspect it does, but will test this
297 >> It worked for me. :)
299 > * I also need to verify if memoizing the named pagespecs has
300 > really guarded against very expensive pagespecs DOSing the wiki..
304 >> 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.
305 >> Firstly, I'm not sure anymore that the `pagespec_merge` function will continue to work in all cases.
307 >>> The problem I can see there is that if two pagespecs
308 >>> get merged and both use `~foo` but define it differently,
309 >>> then the second definition might be used at a point when
310 >>> it shouldn't (but I haven't verified that really happens).
311 >>> That could certianly be a show-stopper. --[[Joey]]
313 >>>> Even if that works, this is a good argument for having a syntactic difference between named pagespecs and normal pages.
314 >>>> 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
315 >>>> 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]]
317 >> Secondly, it seems that there are two types of dependency, and ikiwiki
318 >> currently only handles one of them. The first type is "Rebuild this
319 >> page when any of these other pages changes" - ikiwiki handles this.
320 >> The second type is "rebuild this page when set of pages referred to by
321 >> this pagespec changes" - ikiwiki doesn't seem to handle this. I
322 >> suspect that named pagespecs would make that second type of dependency
323 >> more important. I'll try to come up with a good example. -- [[Will]]
325 >>> Hrm, I was going to build an example of this with backlinks, but it
326 >>> looks like that is handled as a special case at the moment (line 458 of
327 >>> render.pm). I'll see if I can breapk
328 >>> things another way. Fixing this properly would allow removal of that special case. -- [[Will]]
330 >>>> I can't quite understand the distinction you're trying to draw
331 >>>> between the two types of dependencies. Backlinks are a very special
332 >>>> case though and I'll be suprised if they fit well into pagespecs.
335 >>>>> The issue is that the existential pagespec matching allows you to build things that have similar
336 >>>>> problems to backlinks.
337 >>>>> e.g. the following inline:
339 \[[!inline pages="define(~done, link(done)) and link(~done)" archive=yes]]
341 >>>>> includes any page that links to a page that links to done. Now imagine I add a new link to 'done' on
342 >>>>> some random page somewhere - a page which some other page links to which didn't previously get included - the set of pages accepted by the pagespec, and hence the set of
343 >>>>> pages inlined, will change. But, there is no dependency anywhere on the page that I altered, so
344 >>>>> ikiwiki will not rebuild the page with the inline in it. What is happening is that the page that I altered affects
345 >>>>> the set of pages matched by the pagespec without itself being matched by the pagespec, and hence included in the dependency list.
347 >>>>> For another example, imagine I added a `match_word()` function. It matches any page that contains the given word. As with a backlink,
348 >>>>> it is now possible to change the set of pages referred to by a pagespec without changing any of the pages currently referred to by the
349 >>>>> pagespec. If I have an inline of all pages that include the word "abracadabra", then it would have to depend upon all pages to detect
350 >>>>> any new uses of that word.
352 >>>>> To make this work well, I think you need to recognise two types of dependencies for each page (and no
353 >>>>> special cases for particular types of links, eg backlinks). The first type of dependency says, "The content of
354 >>>>> this page depends upon the content of these other pages". The `add_depends()` in the shortcuts
355 >>>>> plugin is of this form: any time the shortcuts page is edited, any page with a shortcut on it
356 >>>>> is rebuilt. The inline plugin also needs to add dependencies of this form to detect when the inlined
357 >>>>> content changes. By contrast, the map plugin does not need a dependency of this form, because it
358 >>>>> doesn't actually care about the content of any pages, just which pages it needs to include (which we'll handle next).
360 >>>>> The second type of dependency says, "The content of this page depends upon the exact set of pages matched
361 >>>>> by this pagespec". The first type of dependency was about the content of some pages, the second type is about
362 >>>>> which pages get matched by a pagespec. This is the type of dependency tracking that the map plugin needs.
363 >>>>> If the set of pages matched by map pagespec changes, then the page with the map on it needs to be rebuilt to show a different list of pages.
364 >>>>> Inline needs this type of dependency as well as the previous type - This type handles a change in which pages
365 >>>>> are inlined, the previous type handles a change in the content of any of those pages. Shortcut does not need this type of
366 >>>>> dependency. Most of the places that use `add_depends()` seem to need this type of dependency rather than the first type.
368 >>>>> Implementation Details: The first type of dependency can be handled very similarly to the current
369 >>>>> dependency system. You just need to keep a list of pages that the content depends upon. You could
370 >>>>> keep that list as a pagespec, but if you do this you might want to check that the pagespec doesn't change,
371 >>>>> possibly by adding a dependency of the second type along with the dependency of the first type.
373 >>>>> The second type of dependency is a little more tricky. For each page, we'd need a list of pagespecs that
374 >>>>> the page depended on, and for each pagespec you'd want to store the list of pages that currently match it.
375 >>>>> On refresh, you'd need to check each pagespec to see if the set of pages that match it has changed, and if
376 >>>>> that set has changed, then rebuild the dependent page(s). Oh, and for this second type of dependency, I
377 >>>>> don't think you can merge pagespecs. If I wanted to know if either "*" or "link(done)" changes, then just checking
378 >>>>> to see if the set of pages matched by "* or link(done)" changes doesn't work.
380 >>>>> The current system works because even though you usually want dependencies of the second type, the set of pages
381 >>>>> referred to by a pagespec can only change if one of those pages itself changes. i.e. A dependency check of the
382 >>>>> first type will catch a dependency change of the second type with current pagespecs.
383 >>>>> This doesn't work with backlinks, and it doesn't work with existential matching. Backlinks are currently special-cased. I don't know
384 >>>>> how to special-case existential matching - I suspect you're better off just getting the dependency tracking right.
386 >>>>> I also tried to come up with other possible solutions: e.g. can we find the dependencies for a pagespec? That
387 >>>>> would be the set of pages where a change on one of those pages could lead to a change in the set of pages matched by the pagespec.
388 >>>>> For old-style pagespecs without backlinks, the dependency set for a pagespec is the same as the set of pages the pagespec matches.
389 >>>>> Unfortunately, with existential matching, the set of pages that each
390 >>>>> pagespec depends upon can quickly become "*", which is not very useful. -- [[Will]]
394 diff --git a/IkiWiki.pm b/IkiWiki.pm
395 index 4e4da11..8b3cdfe 100644
398 @@ -1550,7 +1550,16 @@ sub globlist_to_pagespec ($) {
400 sub is_globlist ($) {
402 - return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
405 + [^\s(]+ # single item
406 + (\( # possibly with parens after it
407 + ([^)]* # with stuff inside those parens
408 + (\([^)]*\))*)* # maybe even nested parens
411 + (\s and \s) | (\s or \s) # or we find 'and' or 'or' somewhere
416 @@ -1631,7 +1640,7 @@ sub pagespec_merge ($$) {
417 return "($a) or ($b)";
420 -sub pagespec_translate ($) {
421 +sub pagespec_makeperl ($) {
424 # Support for old-style GlobLists.
425 @@ -1650,12 +1659,14 @@ sub pagespec_translate ($) {
429 - \w+\([^\)]*\) # command(params)
430 + define\(\s*~\w+\s*,((\([^()]*\)) | ([^()]+))+\) # define(~specName, spec) - spec can contain parens 1 deep
432 + \w+\([^()]*\) # command(params) - params cannot contain parens
434 [^\s()]+ # any other text
436 \s* # ignore whitespace
440 if (lc $word eq 'and') {
442 @@ -1666,16 +1677,23 @@ sub pagespec_translate ($) {
443 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
446 - elsif ($word =~ /^(\w+)\((.*)\)$/) {
447 + elsif ($word =~ /^define\(\s*~(\w+)\s*,(.*)\)$/s) {
448 + $code .= " (\$params{specFuncs}->{$1}="; # (exists \$params{specFuncs}) &&
449 + $code .= "memoize(";
450 + $code .= &pagespec_makeperl($2);
454 + elsif ($word =~ /^(\w+)\((.*)\)$/s) {
455 if (exists $IkiWiki::PageSpec::{"match_$1"}) {
456 - $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@_)";
457 + $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \%params)";
464 - $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
465 + $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \%params)";
469 @@ -1683,8 +1701,18 @@ sub pagespec_translate ($) {
473 + return 'sub { my $page=shift; my %params = @_; '.$code.' }';
476 +sub pagespec_translate ($) {
479 + my $code = pagespec_makeperl($spec);
481 + # print STDERR "Spec '$spec' generated code '$code'\n";
484 - return eval 'sub { my $page=shift; '.$code.' }';
488 sub pagespec_match ($$;@) {
489 @@ -1699,7 +1727,7 @@ sub pagespec_match ($$;@) {
491 my $sub=pagespec_translate($spec);
492 return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
493 - return $sub->($page, @params);
494 + return $sub->($page, @params, specFuncs => {});
497 sub pagespec_valid ($) {
498 @@ -1748,11 +1776,78 @@ sub new {
500 package IkiWiki::PageSpec;
502 +sub check_named_spec($$;@) {
504 + my $specName=shift;
507 + error("Unable to find specFuncs in params to check_named_spec()!") unless exists $params{specFuncs};
509 + my $specFuncsRef=$params{specFuncs};
511 + return IkiWiki::FailReason->new("Named page spec '$specName' is not valid")
512 + unless (substr($specName, 0, 1) eq '~');
514 + $specName = substr($specName, 1);
516 + if (exists $specFuncsRef->{$specName}) {
517 + # remove the named spec from the spec refs
518 + # when we recurse to avoid infinite recursion
519 + my $sub = $specFuncsRef->{$specName};
520 + delete $specFuncsRef->{$specName};
521 + my $result = $sub->($page, %params);
522 + $specFuncsRef->{$specName} = $sub;
525 + return IkiWiki::FailReason->new("Page spec '$specName' does not exist");
529 +sub check_named_spec_existential($$$;@) {
531 + my $specName=shift;
535 + error("Unable to find specFuncs in params to check_named_spec_existential()!") unless exists $params{specFuncs};
536 + my $specFuncsRef=$params{specFuncs};
538 + return IkiWiki::FailReason->new("Named page spec '$specName' is not valid")
539 + unless (substr($specName, 0, 1) eq '~');
540 + $specName = substr($specName, 1);
542 + if (exists $specFuncsRef->{$specName}) {
543 + # remove the named spec from the spec refs
544 + # when we recurse to avoid infinite recursion
545 + my $sub = $specFuncsRef->{$specName};
546 + delete $specFuncsRef->{$specName};
548 + foreach my $nextpage (keys %IkiWiki::pagesources) {
549 + if ($sub->($nextpage, %params)) {
550 + my $tempResult = $funcref->($page, $nextpage, %params);
552 + $specFuncsRef->{$specName} = $sub;
553 + return $tempResult;
558 + $specFuncsRef->{$specName} = $sub;
559 + return IkiWiki::FailReason->new("No page in spec '$specName' was successfully matched");
561 + return IkiWiki::FailReason->new("Named page spec '$specName' does not exist");
565 sub match_glob ($$;@) {
570 + if (substr($glob, 0, 1) eq '~') {
571 + return check_named_spec($page, $glob, %params);
574 my $from=exists $params{location} ? $params{location} : '';
577 @@ -1782,11 +1877,12 @@ sub match_internal ($$;@) {
579 sub match_link ($$;@) {
581 - my $link=lc(shift);
582 + my $fulllink=shift;
584 + my $link=lc($fulllink);
586 my $from=exists $params{location} ? $params{location} : '';
590 if ($link =~ m!^\.! && defined $from) {
592 @@ -1804,19 +1900,32 @@ sub match_link ($$;@) {
595 return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
596 - if match_glob($p, $link, %params);
597 + if match_glob($p, $fulllink, %params);
600 return IkiWiki::FailReason->new("$page does not link to $link");
603 sub match_backlink ($$;@) {
604 - return match_link($_[1], $_[0], @_);
606 + my $backlink=shift;
609 + if (substr($backlink, 0, 1) eq '~') {
610 + return check_named_spec_existential($page, $backlink, \&match_backlink, @params);
613 + return match_link($backlink, $page, @params);
616 sub match_created_before ($$;@) {
621 + if (substr($testpage, 0, 1) eq '~') {
622 + return check_named_spec_existential($page, $testpage, \&match_created_before, @params);
625 if (exists $IkiWiki::pagectime{$testpage}) {
626 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
627 @@ -1834,6 +1943,11 @@ sub match_created_before ($$;@) {
628 sub match_created_after ($$;@) {
633 + if (substr($testpage, 0, 1) eq '~') {
634 + return check_named_spec_existential($page, $testpage, \&match_created_after, @params);
637 if (exists $IkiWiki::pagectime{$testpage}) {
638 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {