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]]
129 >> Maybe - it needs more thought. I also considered it when I was going though changing all those plugins :).
130 >> My concern was that `%params` can contain other user-defined parameters,
131 >> e.g. `link(target, otherparameter)`, and that means that the specFuncs could be clobbered by a user (or other
132 >> weird security hole). I thought it better to separate it, but I didn't think about it too hard. I might move it to
133 >> the first parameter rather than the second. Ikiwiki is my first real perl hacking and I'm still discovering
134 >> good ways to write things in perl.
136 >>>> `%params` contains the parameters passed to `pagespec_match`, not
137 >>>> user-supplied parameters. The user-supplied parameter to a function
138 >>>> like `match_glob()` or `match_link()` is passed in the second positional parameter. --[[Joey]]
140 >> What do you think is best to do about `is_globlist()`? At the moment it requires that the 'second word', as
141 >> 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).
142 >> My thought was just to search for 'and' or 'or' as words anywhere in the pagespec. Thoughts?
144 >>> Dunno, we could just finish deprecating it. Or change the regexp to
145 >>> skip over spaces in parens. (`/[^\s]+\s+([^)]+)/`) --[[Joey]]
147 >> Oh, one more thing. In pagespec_translate (now pagespec_makeperl), there is a part of the regular expression for `# any other text`.
148 >> This contained `()`, which has no effect. I replaced that with `\(\)`, but that is a change in the definition of pagespecs unrelated to the
149 >> rest of this patch. In a related change, commands were not able to contain `)` in their parameters. I've extended that so the cannot
150 >> contain `(` or `)`. -- [[Will]]
152 >>> `[^\s()]+` is a character class matching all characters not spaces or
153 >>> parens. Since the pervious terminals in the regexp consume most
154 >>> occurances of an open paren or close paren, it's unlikely for one to
155 >>> get through to that part of the regexp. For example, "foo()" will be
156 >>> matched by the command matcher; "(foo)" will be matched by the open
157 >>> paren literal terminal. "foo(" and "foo)" can get through to the
158 >>> end, and would be matched as a page name, if it didn't exclude parens.
160 >>> So why exclude them? Well, consider "foo and(bar and baz)". We don't
161 >>> want it to match "and(" as a page name!
163 >>> Escaping the parens in the character class actually changes nothing; the
164 >>> changed character class still matches all characters not spaces or
165 >>> parens. (Try it!).
167 >>> Re commands containing '(', I don't really see any reason not to
168 >>> allow that, unless it breaks something. --[[Joey]]
170 >>> Updated patch. Moved the specFuncsRef to the front of the arg list. Still haven't thought through the security implications of
171 >>> having it in `%params`. I've also removed all the debugging `print` statements. And I've updated the `is_globlist()` function.
172 >>> I think this is ready for people other than me to have a play. It is not well enough tested to commit just yet.
177 diff --git a/IkiWiki.pm b/IkiWiki.pm
178 index e476521..532aaf5 100644
181 @@ -1524,7 +1524,16 @@ sub globlist_to_pagespec ($) { #{{{
183 sub is_globlist ($) { #{{{
185 - return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
188 + [^\s\(]+ # single item
189 + (\( # possibly with parens after it
190 + ([^\)]* # with stuff inside those parens
191 + (\([^\)]*\))*)* # maybe even nested parens
194 + (\s and \s) | (\s or \s) # or we find 'and' or 'or' somewhere
198 sub safequote ($) { #{{{
199 @@ -1605,7 +1614,7 @@ sub pagespec_merge ($$) { #{{{
200 return "($a) or ($b)";
203 -sub pagespec_translate ($) { #{{{
204 +sub pagespec_makeperl ($) { #{{{
207 # Support for old-style GlobLists.
208 @@ -1624,9 +1633,11 @@ sub pagespec_translate ($) { #{{{
212 - \w+\([^\)]*\) # command(params)
213 + define\(\s*~\w+\s*,((\([^\(\)]*\)) | ([^\(\)]+))+\) # define(~specName, spec) - spec can contain parens 1 deep
215 + \w+\([^\(\)]*\) # command(params) - params cannot contain parens
217 - [^\s()]+ # any other text
218 + [^\s\(\)]+ # any other text
220 \s* # ignore whitespace
222 @@ -1640,16 +1651,23 @@ sub pagespec_translate ($) { #{{{
223 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
226 + elsif ($word =~ /^define\(\s*~(\w+)\s*,(.*)\)$/) {
227 + $code .= " (\$specFuncsRef->{$1}=";
228 + $code .= "memoize(";
229 + $code .= &pagespec_makeperl($2);
233 elsif ($word =~ /^(\w+)\((.*)\)$/) {
234 if (exists $IkiWiki::PageSpec::{"match_$1"}) {
235 - $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@_)";
236 + $code.="IkiWiki::PageSpec::match_$1(\$specFuncsRef, \$page, ".safequote($2).", \@_)";
243 - $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
244 + $code.=" IkiWiki::PageSpec::match_glob(\$specFuncsRef, \$page, ".safequote($word).", \@_)";
248 @@ -1657,8 +1675,16 @@ sub pagespec_translate ($) { #{{{
252 + return 'sub { my $specFuncsRef=shift; my $page=shift; '.$code.' }';
255 +sub pagespec_translate ($) { #{{{
258 + my $code = pagespec_makeperl($spec);
261 - return eval 'sub { my $page=shift; '.$code.' }';
265 sub pagespec_match ($$;@) { #{{{
266 @@ -1673,7 +1699,7 @@ sub pagespec_match ($$;@) { #{{{
268 my $sub=pagespec_translate($spec);
269 return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
270 - return $sub->($page, @params);
271 + return $sub->({}, $page, @params);
274 sub pagespec_valid ($) { #{{{
275 @@ -1722,11 +1748,71 @@ sub new { #{{{
277 package IkiWiki::PageSpec;
279 -sub match_glob ($$;@) { #{{{
280 +sub check_named_spec($$$;@) {
281 + my $specFuncsRef=shift;
283 + my $specName=shift;
286 + return IkiWiki::FailReason->new("Named page spec '$specName' is not valid")
287 + unless (substr($specName, 0, 1) eq '~');
289 + $specName = substr($specName, 1);
291 + if (exists $specFuncsRef->{$specName}) {
292 + # remove the named spec from the spec refs
293 + # when we recurse to avoid infinite recursion
294 + my $sub = $specFuncsRef->{$specName};
295 + $specFuncsRef->{$specName} = undef;
296 + my $result = $sub->($specFuncsRef, $page, %params);
297 + $specFuncsRef->{$specName} = $sub;
300 + return IkiWiki::FailReason->new("Page spec '$specName' does not exist");
304 +sub check_named_spec_existential($$$$;@) {
305 + my $specFuncsRef=shift;
307 + my $specName=shift;
311 + return IkiWiki::FailReason->new("Named page spec '$specName' is not valid")
312 + unless (substr($specName, 0, 1) eq '~');
313 + $specName = substr($specName, 1);
315 + if (exists $specFuncsRef->{$specName}) {
316 + # remove the named spec from the spec refs
317 + # when we recurse to avoid infinite recursion
318 + my $sub = $specFuncsRef->{$specName};
319 + $specFuncsRef->{$specName} = undef;
321 + foreach my $nextpage (keys %IkiWiki::pagesources) {
322 + if ($sub->($specFuncsRef, $nextpage, %params)) {
323 + my $tempResult = $funcref->($specFuncsRef, $page, $nextpage, %params);
324 + return $tempResult if ($tempResult);
328 + $specFuncsRef->{$specName} = $sub;
329 + return IkiWiki::FailReason->new("No page in spec '$specName' was successfully matched");
331 + return IkiWiki::FailReason->new("Named page spec '$specName' does not exist");
335 +sub match_glob ($$$;@) { #{{{
336 + my $specFuncsRef=shift;
341 + if (substr($glob, 0, 1) eq '~') {
342 + return check_named_spec($specFuncsRef, $page, $glob);
345 my $from=exists $params{location} ? $params{location} : '';
348 @@ -1750,17 +1836,23 @@ sub match_glob ($$;@) { #{{{
352 -sub match_internal ($$;@) { #{{{
353 - return match_glob($_[0], $_[1], @_, internal => 1)
354 +sub match_internal ($$$;@) { #{{{
355 + return match_glob(shift, shift, shift, @_, internal => 1)
358 -sub match_link ($$;@) { #{{{
359 +sub match_link ($$$;@) { #{{{
360 + my $specFuncsRef=shift;
362 - my $link=lc(shift);
363 + my $fulllink=shift;
364 + my $link=lc($fulllink);
367 - my $from=exists $params{location} ? $params{location} : '';
368 + if (substr($fulllink, 0, 1) eq '~') {
369 + return check_named_spec_existential($specFuncsRef, $page, $fulllink, \&match_link);
372 + my $from=exists $params{location} ? $params{location} : '';
375 if ($link =~ m!^\.! && defined $from) {
377 @@ -1778,17 +1870,21 @@ sub match_link ($$;@) { #{{{
380 return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
381 - if match_glob($p, $link, %params);
382 + if match_glob($specFuncsRef, $p, $link, %params);
385 return IkiWiki::FailReason->new("$page does not link to $link");
388 -sub match_backlink ($$;@) { #{{{
389 - return match_link($_[1], $_[0], @_);
390 +sub match_backlink ($$$;@) { #{{{
391 + my $specFuncsRef=shift;
393 + my $backlink=shift;
394 + return match_link($specFuncsRef, $backlink, $page, @_);
397 -sub match_created_before ($$;@) { #{{{
398 +sub match_created_before ($$$;@) { #{{{
399 + my $specFuncsRef=shift;
403 @@ -1805,7 +1901,8 @@ sub match_created_before ($$;@) { #{{{
407 -sub match_created_after ($$;@) { #{{{
408 +sub match_created_after ($$$;@) { #{{{
409 + my $specFuncsRef=shift;
413 @@ -1822,8 +1919,12 @@ sub match_created_after ($$;@) { #{{{
417 -sub match_creation_day ($$;@) { #{{{
418 - if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
419 +sub match_creation_day ($$$;@) { #{{{
424 + if ((gmtime($IkiWiki::pagectime{$page}))[3] == $time) {
425 return IkiWiki::SuccessReason->new('creation_day matched');
428 @@ -1831,8 +1932,12 @@ sub match_creation_day ($$;@) { #{{{
432 -sub match_creation_month ($$;@) { #{{{
433 - if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
434 +sub match_creation_month ($$$;@) { #{{{
439 + if ((gmtime($IkiWiki::pagectime{$page}))[4] + 1 == $time) {
440 return IkiWiki::SuccessReason->new('creation_month matched');
443 @@ -1840,8 +1945,12 @@ sub match_creation_month ($$;@) { #{{{
447 -sub match_creation_year ($$;@) { #{{{
448 - if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
449 +sub match_creation_year ($$$;@) { #{{{
454 + if ((gmtime($IkiWiki::pagectime{$page}))[5] + 1900 == $time) {
455 return IkiWiki::SuccessReason->new('creation_year matched');
458 diff --git a/IkiWiki/Plugin/attachment.pm b/IkiWiki/Plugin/attachment.pm
459 index f1f792a..a410e48 100644
460 --- a/IkiWiki/Plugin/attachment.pm
461 +++ b/IkiWiki/Plugin/attachment.pm
462 @@ -291,7 +291,8 @@ sub attachment_list ($) { #{{{
464 package IkiWiki::PageSpec;
466 -sub match_user ($$;@) { #{{{
467 +sub match_user ($$$;@) { #{{{
472 @@ -311,7 +312,8 @@ sub match_user ($$;@) { #{{{
476 -sub match_ip ($$;@) { #{{{
477 +sub match_ip ($$$;@) { #{{{
482 diff --git a/IkiWiki/Plugin/conditional.pm b/IkiWiki/Plugin/conditional.pm
483 index 7716fce..c0dbb50 100644
484 --- a/IkiWiki/Plugin/conditional.pm
485 +++ b/IkiWiki/Plugin/conditional.pm
486 @@ -70,7 +70,8 @@ sub preprocess_if (@) { #{{{
488 package IkiWiki::PageSpec;
490 -sub match_enabled ($$;@) { #{{{
491 +sub match_enabled ($$$;@) { #{{{
496 @@ -83,13 +84,14 @@ sub match_enabled ($$;@) { #{{{
500 -sub match_sourcepage ($$;@) { #{{{
501 +sub match_sourcepage ($$$;@) { #{{{
502 + my $specFuncsRef=shift;
507 return IkiWiki::FailReason->new("cannot match sourcepage") unless exists $params{sourcepage};
508 - if (match_glob($params{sourcepage}, $glob, @_)) {
509 + if (match_glob($specFuncsRef, $params{sourcepage}, $glob, @_)) {
510 return IkiWiki::SuccessReason->new("sourcepage matches $glob");
513 @@ -97,13 +99,14 @@ sub match_sourcepage ($$;@) { #{{{
517 -sub match_destpage ($$;@) { #{{{
518 +sub match_destpage ($$$;@) { #{{{
519 + my $specFuncsRef=shift;
524 return IkiWiki::FailReason->new("cannot match destpage") unless exists $params{destpage};
525 - if (match_glob($params{destpage}, $glob, @_)) {
526 + if (match_glob($specFuncsRef, $params{destpage}, $glob, @_)) {
527 return IkiWiki::SuccessReason->new("destpage matches $glob");
530 @@ -111,7 +114,8 @@ sub match_destpage ($$;@) { #{{{
534 -sub match_included ($$;@) { #{{{
535 +sub match_included ($$$;@) { #{{{
540 diff --git a/IkiWiki/Plugin/filecheck.pm b/IkiWiki/Plugin/filecheck.pm
541 index 6f71be3..3592342 100644
542 --- a/IkiWiki/Plugin/filecheck.pm
543 +++ b/IkiWiki/Plugin/filecheck.pm
544 @@ -66,7 +66,8 @@ sub humansize ($) { #{{{
546 package IkiWiki::PageSpec;
548 -sub match_maxsize ($$;@) { #{{{
549 +sub match_maxsize ($$$;@) { #{{{
552 my $maxsize=eval{IkiWiki::Plugin::attachment::parsesize(shift)};
554 @@ -87,7 +88,8 @@ sub match_maxsize ($$;@) { #{{{
558 -sub match_minsize ($$;@) { #{{{
559 +sub match_minsize ($$$;@) { #{{{
562 my $minsize=eval{IkiWiki::Plugin::attachment::parsesize(shift)};
564 @@ -108,7 +110,8 @@ sub match_minsize ($$;@) { #{{{
568 -sub match_mimetype ($$;@) { #{{{
569 +sub match_mimetype ($$$;@) { #{{{
574 @@ -138,7 +141,8 @@ sub match_mimetype ($$;@) { #{{{
578 -sub match_virusfree ($$;@) { #{{{
579 +sub match_virusfree ($$$;@) { #{{{
584 @@ -180,7 +184,7 @@ sub match_virusfree ($$;@) { #{{{
588 -sub match_ispage ($$;@) { #{{{
589 +sub match_ispage ($$$;@) { #{{{
592 if (defined IkiWiki::pagetype($filename)) {
593 diff --git a/IkiWiki/Plugin/meta.pm b/IkiWiki/Plugin/meta.pm
594 index b2c85c8..788f248 100644
595 --- a/IkiWiki/Plugin/meta.pm
596 +++ b/IkiWiki/Plugin/meta.pm
597 @@ -263,6 +263,7 @@ sub pagetemplate (@) { #{{{
604 # turn glob into a safe regexp
605 @@ -291,23 +292,23 @@ sub match { #{{{
607 package IkiWiki::PageSpec;
609 -sub match_title ($$;@) { #{{{
610 +sub match_title ($$$;@) { #{{{
611 IkiWiki::Plugin::meta::match("title", @_);
614 -sub match_author ($$;@) { #{{{
615 +sub match_author ($$$;@) { #{{{
616 IkiWiki::Plugin::meta::match("author", @_);
619 -sub match_authorurl ($$;@) { #{{{
620 +sub match_authorurl ($$$;@) { #{{{
621 IkiWiki::Plugin::meta::match("authorurl", @_);
624 -sub match_license ($$;@) { #{{{
625 +sub match_license ($$$;@) { #{{{
626 IkiWiki::Plugin::meta::match("license", @_);
629 -sub match_copyright ($$;@) { #{{{
630 +sub match_copyright ($$$;@) { #{{{
631 IkiWiki::Plugin::meta::match("copyright", @_);