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 > Another option would be go with a more functional syntax. The concept here would
16 > be to allow a pagespec to appear in a 'pagespec function' anywhere a page can. e.g.
17 > I could pass a pagespec to `link()` and that would return true if there is a link to any
18 > page matching the pagespec. This makes the variables and existential quantification
19 > implicit. It would allow the example requested above:
21 >> `bugs/* and !*/Discussion and !link(bugs/* and !*/Discussion and !link(done))`
23 > Unfortunately, this is also going to make the pagespec parsing more complex because
24 > we now need to parse nested sets of parentheses to know when the nested pagespec
25 > ends, and that isn't a regular language (we can't use regular expression matching for
28 >> Also, it may cause ambiguities with page names that contain parens
29 >> (though some such ambigutities already exist with the pagespec syntax).
31 > One simplification of that would be to introduce some pagespec [[shortcuts]]. We could
32 > then allow pagespec functions to take either pages, or named pagespec shortcuts. The
33 > pagespec shortcuts would just be listed on a special page, like current [[shortcuts]].
34 > (It would probably be a good idea to require that shortcuts on that page can only refer
35 > to named pagespecs higher up that page than themselves. That would stop some
36 > looping issues...) These shortcuts would be used as follows: when trying to match
37 > a page (without globs) you look to see if the page exists. If it does then you have a
38 > match. If it doesn't, then you look to see if a similarly named pagespec shortcut
39 > exists. If it does, then you check that pagespec recursively to see if you have a match.
40 > The ordering requirement on named pagespecs stops infinite recursion.
42 > Does that seem like a reasonable first approach?
46 >> Having a separate page for the shortcuts feels unwieldly.. perhaps
47 >> instead the shortcut could be defined earlier in the scope of the same
48 >> pagespec that uses it?
50 >> Example: `define(~bugs, bugs/* and !*/Discussion) and define(~openbugs, ~bugs and !link(done)) and ~openbugs and !link(~openbugs)`
52 >>> That could work. parens are only ever nested 1 deep in that grammar so it is regular and the current parsing would be ok.
54 >> Note that I made the "~" explicit, not implicit, so it could be left out. In the case of ambiguity between
55 >> a definition and a page name, the definition would win.
57 >>> 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.
59 >> So, equivilant example: `define(bugs, bugs/* and !*/Discussion) and define(openbugs, bugs and !link(done)) and openbugs and !link(openbugs)`
61 >> Re recursion, it is avoided.. but building a pagespec that is O(N^X) where N is the
62 >> number of pages in the wiki is not avoided. Probably need to add DOS prevention.
65 >>> If you memoize the outcomes of the named pagespecs you can make in O(N.X), no?
68 >>>> Yeah, guess that'd work. :-)
70 > One quick further thought. All the above discussion assumes that 'dependency' is the
71 > same as 'links to', which is not really true. For example, you'd like to be able to say
72 > "This bug does not depend upon [ [ link to other bug ] ]" and not have a dependency.
73 > Without having different types of links, I don't see how this would be possible.
77 Okie - I've had a quick attempt at this. Initial patch attached. This one doesn't quite work.
78 And there is still a lot of debugging stuff in there.
80 At the moment I've added a new preprocessor plugin, `definepagespec`, which is like
81 shortcut for pagespecs. To reference a named pagespec, use `~` like this:
83 [ [!definepagespec name="bugs" spec="bugs/* and !*/Discussion"]]
84 [ [!definepagespec name="openbugs" spec="~bugs and !link(done)"]]
85 [ [!definepagespec name="readybugs" spec="~openbugs and !link(~openbugs)"]]
87 At the moment the problem is in `match_link()` when we're trying to find a sub-page that
88 matches the appropriate page spec. There is no good list of pages available to iterate over.
90 foreach my $nextpage (keys %IkiWiki::pagesources)
92 does not give me a good list of pages. I found the same thing when I was working on
93 this todo [[todo/Add_a_plugin_to_list_available_pre-processor_commands]].
95 > I'm not sure why iterating over `%pagesources` wouldn't work here, it's the same method
96 > used by anything that needs to match a pagespec against all pages..? --[[Joey]]
98 >> My uchecked hypothesis is that %pagesources is created after the refresh hook.
99 >> I've also been concerned about how globally defined pagespec shortcuts would interact with
100 >> the page dependancy system. Your idea of internally defined shortcuts should fix that. -- [[Will]]
102 >>> You're correct, the refresh hook is run very early, before pagesources
103 >>> is populated. (It will be partially populated on a refresh, but will
104 >>> not be updated to reflect new pages.) Agree that internally defined
105 >>> seems the way to go. --[[Joey]]
107 Immediately below is a patch which seems to basically work. Lots of debugging code is still there
108 and it needs a cleanup, but I thought it worth posting at this point. (I was having problems
109 with old style glob lists, so i just switched them off for the moment.)
111 The following three inlines work for me with this patch:
115 [ [!inline pages="define(~bugs, bugs/* and ! */Discussion) and ~bugs" archive="yes"]]
119 [ [!inline pages="define(~bugs, bugs/* and ! */Discussion) and define(~openbugs,~bugs and !link(done)) and ~openbugs" archive="yes"]]
123 [ [!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"]]
125 > Nice! Could the specfuncsref be passed in %params? I'd like to avoid
126 > needing to change the prototype of every pagespec function, since several
127 > plugins define them too. --[[Joey]]
131 diff --git a/IkiWiki.pm b/IkiWiki.pm
132 index e476521..07b71d7 100644
135 @@ -1524,7 +1524,7 @@ sub globlist_to_pagespec ($) { #{{{
137 sub is_globlist ($) { #{{{
139 - return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
140 + return 0; #( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
143 sub safequote ($) { #{{{
144 @@ -1605,7 +1605,7 @@ sub pagespec_merge ($$) { #{{{
145 return "($a) or ($b)";
148 -sub pagespec_translate ($) { #{{{
149 +sub pagespec_makeperl ($) { #{{{
152 # Support for old-style GlobLists.
153 @@ -1624,9 +1624,11 @@ sub pagespec_translate ($) { #{{{
157 - \w+\([^\)]*\) # command(params)
158 + define\(\s*~\w+\s*,((\([^\(\)]*\)) | ([^\(\)]+))+\) # define(~specName, spec) - spec can contain parens 1 deep
160 + \w+\([^\(\)]*\) # command(params) - params cannot contain parens
162 - [^\s()]+ # any other text
163 + [^\s\(\)]+ # any other text
165 \s* # ignore whitespace
167 @@ -1640,16 +1642,23 @@ sub pagespec_translate ($) { #{{{
168 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
171 + elsif ($word =~ /^define\(\s*~(\w+)\s*,(.*)\)$/) {
172 + $code .= " (\$specFuncsRef->{$1}=";
173 + #$code .= "memoize(";
174 + $code .= pagespec_makeperl($2);
178 elsif ($word =~ /^(\w+)\((.*)\)$/) {
179 if (exists $IkiWiki::PageSpec::{"match_$1"}) {
180 - $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@_)";
181 + $code.="IkiWiki::PageSpec::match_$1(\$page, \$specFuncsRef, ".safequote($2).", \@_)";
188 - $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
189 + $code.=" IkiWiki::PageSpec::match_glob(\$page, \$specFuncsRef, ".safequote($word).", \@_)";
193 @@ -1657,8 +1666,18 @@ sub pagespec_translate ($) { #{{{
197 + return 'sub { my $page=shift; my $specFuncsRef=shift; '.$code.' }';
200 +sub pagespec_translate ($) { #{{{
203 + my $code = pagespec_makeperl($spec);
205 + print "Spec '$spec' led to perl '$code'\n";
208 - return eval 'sub { my $page=shift; '.$code.' }';
212 sub pagespec_match ($$;@) { #{{{
213 @@ -1673,7 +1692,7 @@ sub pagespec_match ($$;@) { #{{{
215 my $sub=pagespec_translate($spec);
216 return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
217 - return $sub->($page, @params);
218 + return $sub->($page, {}, @params);
221 sub pagespec_valid ($) { #{{{
222 @@ -1722,13 +1741,77 @@ sub new { #{{{
224 package IkiWiki::PageSpec;
226 -sub match_glob ($$;@) { #{{{
227 +sub check_named_spec($$$;@) {
229 + my $specFuncsRef=shift;
230 + my $specName=shift;
233 + return IkiWiki::FailReason->new("Named page spec '$specName' is not valid")
234 + unless (substr($specName, 0, 1) eq '~');
236 + $specName = substr($specName, 1);
237 + print "Checking pagespec named $specName against page $page\n";
238 + if (exists $specFuncsRef->{$specName}) {
239 + # remove the named spec from the spec refs
240 + # when we recurse to avoid infinite recursion
241 + my $sub = $specFuncsRef->{$specName};
242 + $specFuncsRef->{$specName} = undef;
243 + my $result = $sub->($page, $specFuncsRef, %params);
244 + $specFuncsRef->{$specName} = $sub;
247 + print "Couldn't find pagespec\n";
248 + return IkiWiki::FailReason->new("Page spec $specName does not exist");
252 +sub check_named_spec_existential($$$$;@) {
254 + my $specFuncsRef=shift;
255 + my $specName=shift;
259 + return IkiWiki::FailReason->new("Named page spec '$specName' is not valid")
260 + unless (substr($specName, 0, 1) eq '~');
261 + $specName = substr($specName, 1);
263 + print "Checking (existential) pagespec named $specName against page $page\n";
265 + if (exists $specFuncsRef->{$specName}) {
266 + # remove the named spec from the spec refs
267 + # when we recurse to avoid infinite recursion
268 + my $sub = $specFuncsRef->{$specName};
269 + $specFuncsRef->{$specName} = undef;
271 + foreach my $nextpage (keys %IkiWiki::pagesources) {
272 + print "Checking $nextpage against $specName\n";
273 + if ($sub->($nextpage, $specFuncsRef, %params)) {
274 + print "Match! Checking spec $nextpage against function from original page $page\n";
275 + my $tempResult = $funcref->($page, $specFuncsRef, $nextpage, %params);
276 + return $tempResult if ($tempResult);
280 + $specFuncsRef->{$specName} = $sub;
281 + return IkiWiki::FailReason->new("No page in spec $specName was successfully matched");
283 + print "Couldn't find pagespec\n";
284 + return IkiWiki::FailReason->new("Page spec $specName does not exist");
288 +sub match_glob ($$$;@) { #{{{
290 + my $specFuncsRef=shift;
294 my $from=exists $params{location} ? $params{location} : '';
296 + print "Matching glob $glob \n";
299 if ($glob =~ m!^\./!) {
301 @@ -1736,6 +1819,10 @@ sub match_glob ($$;@) { #{{{
302 $glob="$from/$glob" if length $from;
305 + if (substr($glob, 0, 1) eq '~') {
306 + return check_named_spec($page, $specFuncsRef, $glob);
309 my $regexp=IkiWiki::glob2re($glob);
310 if ($page=~/^$regexp$/i) {
311 if (! IkiWiki::isinternal($page) || $params{internal}) {
312 @@ -1750,17 +1837,29 @@ sub match_glob ($$;@) { #{{{
316 -sub match_internal ($$;@) { #{{{
317 - return match_glob($_[0], $_[1], @_, internal => 1)
318 +sub match_internal ($$$;@) { #{{{
320 + my $specFuncsRef=shift;
323 + return match_glob($page, $specFuncsRef, $glob, @_, internal => 1)
326 -sub match_link ($$;@) { #{{{
327 +sub match_link ($$$;@) { #{{{
329 - my $link=lc(shift);
330 + my $specFuncsRef=shift;
331 + my $fulllink=shift;
332 + my $link=lc($fulllink);
335 + print "Matching link $fulllink \n";
337 my $from=exists $params{location} ? $params{location} : '';
339 + if (substr($fulllink, 0, 1) eq '~') {
340 + return check_named_spec_existential($page, $specFuncsRef, $fulllink, \&match_link);
344 if ($link =~ m!^\.! && defined $from) {
346 @@ -1784,12 +1883,16 @@ sub match_link ($$;@) { #{{{
347 return IkiWiki::FailReason->new("$page does not link to $link");
350 -sub match_backlink ($$;@) { #{{{
351 - return match_link($_[1], $_[0], @_);
352 +sub match_backlink ($$$;@) { #{{{
354 + my $specFuncsRef=shift;
355 + my $backlink=shift;
356 + return match_link($backlink, $specFuncsRef, $page, @_);
359 -sub match_created_before ($$;@) { #{{{
360 +sub match_created_before ($$$;@) { #{{{
362 + my $specFuncsRef=shift;
365 if (exists $IkiWiki::pagectime{$testpage}) {
366 @@ -1805,8 +1908,9 @@ sub match_created_before ($$;@) { #{{{
370 -sub match_created_after ($$;@) { #{{{
371 +sub match_created_after ($$$;@) { #{{{
373 + my $specFuncsRef=shift;
376 if (exists $IkiWiki::pagectime{$testpage}) {
377 @@ -1822,8 +1926,12 @@ sub match_created_after ($$;@) { #{{{
381 -sub match_creation_day ($$;@) { #{{{
382 - if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
383 +sub match_creation_day ($$$;@) { #{{{
388 + if ((gmtime($IkiWiki::pagectime{$page}))[3] == $time) {
389 return IkiWiki::SuccessReason->new('creation_day matched');
392 @@ -1831,8 +1939,12 @@ sub match_creation_day ($$;@) { #{{{
396 -sub match_creation_month ($$;@) { #{{{
397 - if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
398 +sub match_creation_month ($$$;@) { #{{{
403 + if ((gmtime($IkiWiki::pagectime{$page}))[4] + 1 == $time) {
404 return IkiWiki::SuccessReason->new('creation_month matched');
407 @@ -1840,8 +1952,12 @@ sub match_creation_month ($$;@) { #{{{
411 -sub match_creation_year ($$;@) { #{{{
412 - if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
413 +sub match_creation_year ($$$;@) { #{{{
418 + if ((gmtime($IkiWiki::pagectime{$page}))[5] + 1900 == $time) {
419 return IkiWiki::SuccessReason->new('creation_year matched');
422 diff --git a/IkiWiki/Plugin/attachment.pm b/IkiWiki/Plugin/attachment.pm
423 index f1f792a..a410e48 100644
424 --- a/IkiWiki/Plugin/attachment.pm
425 +++ b/IkiWiki/Plugin/attachment.pm
426 @@ -291,7 +291,8 @@ sub attachment_list ($) { #{{{
428 package IkiWiki::PageSpec;
430 -sub match_user ($$;@) { #{{{
431 +sub match_user ($$$;@) { #{{{
436 @@ -311,7 +312,8 @@ sub match_user ($$;@) { #{{{
440 -sub match_ip ($$;@) { #{{{
441 +sub match_ip ($$$;@) { #{{{
446 diff --git a/IkiWiki/Plugin/conditional.pm b/IkiWiki/Plugin/conditional.pm
447 index 7716fce..2110ca0 100644
448 --- a/IkiWiki/Plugin/conditional.pm
449 +++ b/IkiWiki/Plugin/conditional.pm
450 @@ -70,7 +70,8 @@ sub preprocess_if (@) { #{{{
452 package IkiWiki::PageSpec;
454 -sub match_enabled ($$;@) { #{{{
455 +sub match_enabled ($$$;@) { #{{{
460 @@ -83,13 +84,14 @@ sub match_enabled ($$;@) { #{{{
464 -sub match_sourcepage ($$;@) { #{{{
465 +sub match_sourcepage ($$$;@) { #{{{
467 + my $specFuncsRef=shift;
471 return IkiWiki::FailReason->new("cannot match sourcepage") unless exists $params{sourcepage};
472 - if (match_glob($params{sourcepage}, $glob, @_)) {
473 + if (match_glob($params{sourcepage}, $specFuncsRef, $glob, @_)) {
474 return IkiWiki::SuccessReason->new("sourcepage matches $glob");
477 @@ -97,13 +99,14 @@ sub match_sourcepage ($$;@) { #{{{
481 -sub match_destpage ($$;@) { #{{{
482 +sub match_destpage ($$$;@) { #{{{
484 + my $specFuncsRef=shift;
488 return IkiWiki::FailReason->new("cannot match destpage") unless exists $params{destpage};
489 - if (match_glob($params{destpage}, $glob, @_)) {
490 + if (match_glob($params{destpage}, $specFuncsRef, $glob, @_)) {
491 return IkiWiki::SuccessReason->new("destpage matches $glob");
494 @@ -111,7 +114,8 @@ sub match_destpage ($$;@) { #{{{
498 -sub match_included ($$;@) { #{{{
499 +sub match_included ($$$;@) { #{{{
504 diff --git a/IkiWiki/Plugin/filecheck.pm b/IkiWiki/Plugin/filecheck.pm
505 index 6f71be3..bf472c5 100644
506 --- a/IkiWiki/Plugin/filecheck.pm
507 +++ b/IkiWiki/Plugin/filecheck.pm
508 @@ -66,8 +66,9 @@ sub humansize ($) { #{{{
510 package IkiWiki::PageSpec;
512 -sub match_maxsize ($$;@) { #{{{
513 +sub match_maxsize ($$$;@) { #{{{
516 my $maxsize=eval{IkiWiki::Plugin::attachment::parsesize(shift)};
518 return IkiWiki::FailReason->new("unable to parse maxsize (or number too large)");
519 @@ -87,8 +88,9 @@ sub match_maxsize ($$;@) { #{{{
523 -sub match_minsize ($$;@) { #{{{
524 +sub match_minsize ($$$;@) { #{{{
527 my $minsize=eval{IkiWiki::Plugin::attachment::parsesize(shift)};
529 return IkiWiki::FailReason->new("unable to parse minsize (or number too large)");
530 @@ -108,8 +110,9 @@ sub match_minsize ($$;@) { #{{{
534 -sub match_mimetype ($$;@) { #{{{
535 +sub match_mimetype ($$$;@) { #{{{
541 @@ -138,8 +141,9 @@ sub match_mimetype ($$;@) { #{{{
545 -sub match_virusfree ($$;@) { #{{{
546 +sub match_virusfree ($$$;@) { #{{{
552 @@ -180,7 +184,7 @@ sub match_virusfree ($$;@) { #{{{
556 -sub match_ispage ($$;@) { #{{{
557 +sub match_ispage ($$$;@) { #{{{
560 if (defined IkiWiki::pagetype($filename)) {
561 diff --git a/IkiWiki/Plugin/meta.pm b/IkiWiki/Plugin/meta.pm
562 index b2c85c8..1ee6a69 100644
563 --- a/IkiWiki/Plugin/meta.pm
564 +++ b/IkiWiki/Plugin/meta.pm
565 @@ -264,6 +264,7 @@ sub pagetemplate (@) { #{{{
571 # turn glob into a safe regexp
572 my $re=IkiWiki::glob2re(shift);
573 @@ -291,23 +292,23 @@ sub match { #{{{
575 package IkiWiki::PageSpec;
577 -sub match_title ($$;@) { #{{{
578 +sub match_title ($$$;@) { #{{{
579 IkiWiki::Plugin::meta::match("title", @_);
582 -sub match_author ($$;@) { #{{{
583 +sub match_author ($$$;@) { #{{{
584 IkiWiki::Plugin::meta::match("author", @_);
587 -sub match_authorurl ($$;@) { #{{{
588 +sub match_authorurl ($$$;@) { #{{{
589 IkiWiki::Plugin::meta::match("authorurl", @_);
592 -sub match_license ($$;@) { #{{{
593 +sub match_license ($$$;@) { #{{{
594 IkiWiki::Plugin::meta::match("license", @_);
597 -sub match_copyright ($$;@) { #{{{
598 +sub match_copyright ($$$;@) { #{{{
599 IkiWiki::Plugin::meta::match("copyright", @_);