Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info
[ikiwiki.git] / doc / todo / tracking_bugs_with_dependencies.mdwn
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]]
2
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".
8 >
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.
11 >
12 >> I thought about this briefly, and got about that far.. glad you got
13 >> further. :-) --[[Joey]]
14
15 >> Or, one could also refer to the language of [[!wikipedia description logics]]: their formulas actually define classes of objects through quantified relations to other classes. --Ivan Z.
16
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:
22 >
23 >> `bugs/* and !*/Discussion and !link(bugs/* and !*/Discussion and !link(done))`
24 >
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
28 > easy parsing).
29 >
30 >> Also, it may cause ambiguities with page names that contain parens
31 >> (though some such ambigutities already exist with the pagespec syntax).
32 >
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.
43 >
44 > Does that seem like a reasonable first approach?
45 >
46 > -- [[Will]]
47
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?
51 >> 
52 >> Example: `define(~bugs, bugs/* and !*/Discussion) and define(~openbugs, ~bugs and !link(done)) and ~openbugs and !link(~openbugs)`
53
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.
55
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.
58
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.
60
61 >> So, equivilant example: `define(bugs, bugs/* and !*/Discussion) and define(openbugs, bugs and !link(done)) and openbugs and !link(openbugs)`
62 >> 
63 >> Re recursion, it is avoided.. but building a pagespec that is O(N^X) where N is the
64 >> number of pages in the wiki is not avoided. Probably need to add DOS prevention.
65 >>  --[[Joey]]
66
67 >>> If you memoize the outcomes of the named pagespecs you can make in O(N.X), no?
68 >>> -- [[Will]]
69
70 >>>> Yeah, guess that'd work. :-)
71
72 > <a id="another_kind_of_links" />One quick further thought.  All the above discussion assumes that 'dependency' is the
73 > same as 'links to', which is not really true.  For example, you'd like to be able to say
74 > "This bug does not depend upon [ [ link to other bug ] ]" and not have a dependency.
75 > Without having different types of links, I don't see how this would be possible.
76 >
77 > -- [[Will]]
78
79 >> I saw that this issue is targeted at by the work on [[structured page data#another_kind_of_links]]. --Ivan Z.
80
81 Okie - I've had a quick attempt at this.  Initial patch attached.  This one doesn't quite work.
82 And there is still a lot of debugging stuff in there.
83
84 At the moment I've added a new preprocessor plugin, `definepagespec`, which is like
85 shortcut for pagespecs.  To reference a named pagespec, use `~` like this:
86
87     [ [!definepagespec name="bugs" spec="bugs/* and !*/Discussion"]]
88     [ [!definepagespec name="openbugs" spec="~bugs and !link(done)"]]
89     [ [!definepagespec name="readybugs" spec="~openbugs and !link(~openbugs)"]]
90
91 At the moment the problem is in `match_link()` when we're trying to find a sub-page that
92 matches the appropriate page spec.  There is no good list of pages available to iterate over.
93
94     foreach my $nextpage (keys %IkiWiki::pagesources)
95
96 does not give me a good list of pages.  I found the same thing when I was working on
97 this todo [[todo/Add_a_plugin_to_list_available_pre-processor_commands]].
98
99 > I'm not sure why iterating over `%pagesources` wouldn't work here, it's the same method
100 > used by anything that needs to match a pagespec against all pages..? --[[Joey]]
101
102 >> My uchecked hypothesis is that %pagesources is created after the refresh hook.
103 >> I've also been concerned about how globally defined pagespec shortcuts would interact with
104 >> the page dependancy system.  Your idea of internally defined shortcuts should fix that. -- [[Will]]
105
106 >>> You're correct, the refresh hook is run very early, before pagesources
107 >>> is populated. (It will be partially populated on a refresh, but will
108 >>> not be updated to reflect new pages.) Agree that internally defined
109 >>> seems the way to go. --[[Joey]]
110
111 Immediately below is a patch which seems to basically work.  Lots of debugging code is still there
112 and it needs a cleanup, but I thought it worth posting at this point.  (I was having problems
113 with old style glob lists, so i just switched them off for the moment.)
114
115 The following three inlines work for me with this patch:
116
117     Bugs:
118     
119     [ [!inline pages="define(~bugs, bugs/* and ! */Discussion) and ~bugs" archive="yes"]]
120     
121     OpenBugs:
122     
123     [ [!inline pages="define(~bugs, bugs/* and ! */Discussion) and define(~openbugs,~bugs and !link(done)) and ~openbugs" archive="yes"]]
124     
125     ReadyBugs:
126     
127     [ [!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"]]
128
129 > Nice! Could the specfuncsref be passed in %params? I'd like to avoid
130 > needing to change the prototype of every pagespec function, since several
131 > plugins define them too. --[[Joey]]
132
133 >> Maybe - it needs more thought.  I also considered it when I was going though changing all those plugins :).
134 >> My concern was that `%params` can contain other user-defined parameters,
135 >> e.g. `link(target, otherparameter)`, and that means that the specFuncs could be clobbered by a user (or other
136 >> weird security hole).  I thought it better to separate it, but I didn't think about it too hard.  I might move it to
137 >> the first parameter rather than the second.  Ikiwiki is my first real perl hacking and I'm still discovering
138 >> good ways to write things in perl.
139 >>
140 >>>> `%params` contains the parameters passed to `pagespec_match`, not
141 >>>> user-supplied parameters. The user-supplied parameter to a function
142 >>>> like `match_glob()` or `match_link()` is passed in the second positional parameter. --[[Joey]]
143
144 >>>>> OK.  That seems reasonable then.  The only problem is that my PERLfu is not strong enough to make it
145 >>>>> work.  I really have to wonder what substance was influencing the designers of PERL...
146 >>>>> I can't figure out how to use the %params.  And I'm pissed off enough with PERL that I'm not going
147 >>>>> to try and figure it out any more.  There are two patches below now.  The first one uses an extra
148 >>>>> argument and works.  The second one tries to use %params and doesn't - take your pick :-). -- [[Will]]
149
150 >> What do you think is best to do about `is_globlist()`?  At the moment it requires that the 'second word', as
151 >> 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).
152 >> My thought was just to search for 'and' or 'or' as words anywhere in the pagespec.  Thoughts?
153
154 >>> Dunno, we could just finish deprecating it. Or change the regexp to
155 >>> skip over spaces in parens. (`/[^\s]+\s+([^)]+)/`) --[[Joey]]
156
157 >>>> I think I have a working regexp now.
158
159 >> Oh, one more thing.  In pagespec_translate (now pagespec_makeperl), there is a part of the regular expression for `# any other text`.
160 >> This contained `()`, which has no effect.  I replaced that with `\(\)`, but that is a change in the definition of pagespecs unrelated to the
161 >> rest of this patch. In a related change, commands were not able to contain `)` in their parameters.  I've extended that so the cannot
162 >> contain `(` or `)`.  -- [[Will]]
163
164 >>> `[^\s()]+` is a character class matching all characters not spaces or
165 >>> parens. Since the pervious terminals in the regexp consume most
166 >>> occurances of an open paren or close paren, it's unlikely for one to
167 >>> get through to that part of the regexp. For example, "foo()" will be
168 >>> matched by the command matcher; "(foo)" will be matched by the open
169 >>> paren literal terminal. "foo(" and "foo)" can get through to the
170 >>> end, and would be matched as a page name, if it didn't exclude parens.
171 >>>
172 >>> So why exclude them? Well, consider "foo and(bar and baz)". We don't
173 >>> want it to match "and(" as a page name!
174 >>> 
175 >>> Escaping the parens in the character class actually changes nothing; the
176 >>> changed character class still matches all characters not spaces or
177 >>> parens. (Try it!).
178 >>> 
179 >>> Re commands containing '(', I don't really see any reason not to
180 >>> allow that, unless it breaks something. --[[Joey]]
181
182 >>>> Oh, I didn't realise you didn't need to escape parens inside [].  All else I
183 >>>> I understood.  I have stopped commands from containing parens because
184 >>>> once you allow that then you might have a extra level of depth in the parsing
185 >>>> of define() statements. -- [[Will]]
186
187 >>> Updated patch.  Moved the specFuncsRef to the front of the arg list.  Still haven't thought through the security implications of
188 >>> having it in `%params`.  I've also removed all the debugging `print` statements.  And I've updated the `is_globlist()` function.
189 >>> I think this is ready for people other than me to have a play.  It is not well enough tested to commit just yet.
190 >>> -- [[Will]]
191
192 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
193 account all comments above (which doesn't mean it is above reproach :) ).  --[[Will]]
194
195 > Very belated code review of last version of the patch:
196
197 > * `is_globlist` is no longer needed
198 > * `pagespec_translate` is already memoized, so the explicit call
199 >   to memoize when handling a define seems unnecessary?
200 > * I don't understand why the pagespec match regexp is changed
201 >   from having flags `igx` to `ixgs`. Don't see why you
202 >   want `.` to match '\n` in it, and don't see any `.` in the regexp 
203 >   anyway?
204 > * Some changes of `@_` to `%params` in `pagespec_makeperl` do not
205 >   make sense to me. I don't see where \%params is defined and populated,
206 >   except with `\$params{specFunc}`.
207 > * Seems that the only reason `match_glob` has to check for `~` is
208 >   because when a named spec appears in a pagespec, it is translated
209 >   to `match_glob("~foo")`. If, instead, `pagespec_makeperl` checked
210 >   for named specs, it could convert them into `check_named_spec("foo")`
211 >   and avoid that ugliness.
212 > * The changes to `match_link` seem either unecessary, or incomplete.
213 >   Shouldn't it check for named specs and call
214 >   `check_named_spec_existential`?
215 > * Generally, the need to modify `match_*` functions so that they
216 >   check for and handle named pagespecs seems suboptimal, if
217 >   only because there might be others people may want to use named
218 >   pagespecs with. It would be possible to move this check
219 >   to `pagespec_makeperl`, by having it check if the parameter
220 >   passed to a pagespec function looked like a named pagespec.
221 >   The only issue is that some pagespec functions take a parameter
222 >   that is not a page name at all, and it could be weird
223 >   if such a parameter were accidentially interpreted as a named
224 >   pagespec. (But, that seems unlikely to happen.)
225 > * I need to check if your trick to avoid infinite recursion
226 >   works if there are two named specs that recursively
227 >   call one-another. I suspect it does, but will test this
228 >   myself..
229 >  
230 > --[[Joey]] 
231
232 ----
233
234     diff --git a/IkiWiki.pm b/IkiWiki.pm
235     index 4e4da11..8b3cdfe 100644
236     --- a/IkiWiki.pm
237     +++ b/IkiWiki.pm
238     @@ -1550,7 +1550,16 @@ sub globlist_to_pagespec ($) {
239      
240      sub is_globlist ($) {
241         my $s=shift;
242     -   return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
243     +   return ! ($s =~ /
244     +                   (^\s*
245     +                           [^\s(]+         # single item
246     +                                   (\(                     # possibly with parens after it
247     +                                           ([^)]*  # with stuff inside those parens
248     +                                           (\([^)]*\))*)*  # maybe even nested parens
249     +                                   \))?\s*$
250     +                   ) |
251     +                           (\s and \s) | (\s or \s)        # or we find 'and' or 'or' somewhere
252     +                   /xs);
253      }
254      
255      sub safequote ($) {
256     @@ -1631,7 +1640,7 @@ sub pagespec_merge ($$) {
257         return "($a) or ($b)";
258      }
259      
260     -sub pagespec_translate ($) {
261     +sub pagespec_makeperl ($) {
262         my $spec=shift;
263      
264         # Support for old-style GlobLists.
265     @@ -1650,12 +1659,14 @@ sub pagespec_translate ($) {
266                 |
267                         \)              # )
268                 |
269     -                   \w+\([^\)]*\)   # command(params)
270     +                   define\(\s*~\w+\s*,((\([^()]*\)) | ([^()]+))+\) # define(~specName, spec) - spec can contain parens 1 deep
271     +           |
272     +                   \w+\([^()]*\)   # command(params) - params cannot contain parens
273                 |
274                         [^\s()]+        # any other text
275                 )
276                 \s*             # ignore whitespace
277     -   }igx) {
278     +   }igxs) {
279                 my $word=$1;
280                 if (lc $word eq 'and') {
281                         $code.=' &&';
282     @@ -1666,16 +1677,23 @@ sub pagespec_translate ($) {
283                 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
284                         $code.=' '.$word;
285                 }
286     -           elsif ($word =~ /^(\w+)\((.*)\)$/) {
287     +           elsif ($word =~ /^define\(\s*~(\w+)\s*,(.*)\)$/s) {
288     +                   $code .= " (\$params{specFuncs}->{$1}=";        # (exists \$params{specFuncs}) && 
289     +                   $code .= "memoize(";
290     +                   $code .= &pagespec_makeperl($2);
291     +                   $code .= ")";
292     +                   $code .= ") ";
293     +           }
294     +           elsif ($word =~ /^(\w+)\((.*)\)$/s) {
295                         if (exists $IkiWiki::PageSpec::{"match_$1"}) {
296     -                           $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@_)";
297     +                           $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \%params)";
298                         }
299                         else {
300                                 $code.=' 0';
301                         }
302                 }
303                 else {
304     -                   $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
305     +                   $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \%params)";
306                 }
307         }
308      
309     @@ -1683,8 +1701,18 @@ sub pagespec_translate ($) {
310                 $code=0;
311         }
312      
313     +   return 'sub { my $page=shift; my %params = @_; '.$code.' }';
314     +}
315     +
316     +sub pagespec_translate ($) {
317     +   my $spec=shift;
318     +
319     +   my $code = pagespec_makeperl($spec);
320     +
321     +   # print STDERR "Spec '$spec' generated code '$code'\n";
322     +
323         no warnings;
324     -   return eval 'sub { my $page=shift; '.$code.' }';
325     +   return eval $code;
326      }
327      
328      sub pagespec_match ($$;@) {
329     @@ -1699,7 +1727,7 @@ sub pagespec_match ($$;@) {
330      
331         my $sub=pagespec_translate($spec);
332         return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
333     -   return $sub->($page, @params);
334     +   return $sub->($page, @params, specFuncs => {});
335      }
336      
337      sub pagespec_valid ($) {
338     @@ -1748,11 +1776,78 @@ sub new {
339      
340      package IkiWiki::PageSpec;
341      
342     +sub check_named_spec($$;@) {
343     +   my $page=shift;
344     +   my $specName=shift;
345     +   my %params=@_;
346     +   
347     +   error("Unable to find specFuncs in params to check_named_spec()!") unless exists $params{specFuncs};
348     +
349     +   my $specFuncsRef=$params{specFuncs};
350     +   
351     +   return IkiWiki::FailReason->new("Named page spec '$specName' is not valid")
352     +           unless (substr($specName, 0, 1) eq '~');
353     +   
354     +   $specName = substr($specName, 1);
355     +
356     +   if (exists $specFuncsRef->{$specName}) {
357     +           # remove the named spec from the spec refs
358     +           # when we recurse to avoid infinite recursion
359     +           my $sub = $specFuncsRef->{$specName};
360     +           delete $specFuncsRef->{$specName};
361     +           my $result = $sub->($page, %params);
362     +           $specFuncsRef->{$specName} = $sub;
363     +           return $result;
364     +   } else {
365     +           return IkiWiki::FailReason->new("Page spec '$specName' does not exist");
366     +   }
367     +}
368     +
369     +sub check_named_spec_existential($$$;@) {
370     +   my $page=shift;
371     +   my $specName=shift;
372     +   my $funcref=shift;
373     +   my %params=@_;
374     +   
375     +   error("Unable to find specFuncs in params to check_named_spec_existential()!") unless exists $params{specFuncs};
376     +   my $specFuncsRef=$params{specFuncs};
377     +   
378     +   return IkiWiki::FailReason->new("Named page spec '$specName' is not valid")
379     +           unless (substr($specName, 0, 1) eq '~');
380     +   $specName = substr($specName, 1);
381     +   
382     +   if (exists $specFuncsRef->{$specName}) {
383     +           # remove the named spec from the spec refs
384     +           # when we recurse to avoid infinite recursion
385     +           my $sub = $specFuncsRef->{$specName};
386     +           delete $specFuncsRef->{$specName};
387     +           
388     +           foreach my $nextpage (keys %IkiWiki::pagesources) {
389     +                   if ($sub->($nextpage, %params)) {
390     +                           my $tempResult = $funcref->($page, $nextpage, %params);
391     +                           if ($tempResult) {
392     +                                   $specFuncsRef->{$specName} = $sub;
393     +                                   return $tempResult;
394     +                           }
395     +                   }
396     +           }
397     +           
398     +           $specFuncsRef->{$specName} = $sub;
399     +           return IkiWiki::FailReason->new("No page in spec '$specName' was successfully matched");
400     +   } else {
401     +           return IkiWiki::FailReason->new("Named page spec '$specName' does not exist");
402     +   }
403     +}
404     +
405      sub match_glob ($$;@) {
406         my $page=shift;
407         my $glob=shift;
408         my %params=@_;
409         
410     +   if (substr($glob, 0, 1) eq '~') {
411     +           return check_named_spec($page, $glob, %params);
412     +   }
413     +
414         my $from=exists $params{location} ? $params{location} : '';
415         
416         # relative matching
417     @@ -1782,11 +1877,12 @@ sub match_internal ($$;@) {
418      
419      sub match_link ($$;@) {
420         my $page=shift;
421     -   my $link=lc(shift);
422     +   my $fulllink=shift;
423         my %params=@_;
424     +   my $link=lc($fulllink);
425      
426         my $from=exists $params{location} ? $params{location} : '';
427     -
428     +   
429         # relative matching
430         if ($link =~ m!^\.! && defined $from) {
431                 $from=~s#/?[^/]+$##;
432     @@ -1804,19 +1900,32 @@ sub match_link ($$;@) {
433                 }
434                 else {
435                         return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
436     -                           if match_glob($p, $link, %params);
437     +                           if match_glob($p, $fulllink, %params);
438                 }
439         }
440         return IkiWiki::FailReason->new("$page does not link to $link");
441      }
442      
443      sub match_backlink ($$;@) {
444     -   return match_link($_[1], $_[0], @_);
445     +   my $page=shift;
446     +   my $backlink=shift;
447     +   my @params=@_;
448     +
449     +   if (substr($backlink, 0, 1) eq '~') {
450     +           return check_named_spec_existential($page, $backlink, \&match_backlink, @params);
451     +   }
452     +
453     +   return match_link($backlink, $page, @params);
454      }
455      
456      sub match_created_before ($$;@) {
457         my $page=shift;
458         my $testpage=shift;
459     +   my @params=@_;
460     +
461     +   if (substr($testpage, 0, 1) eq '~') {
462     +           return check_named_spec_existential($page, $testpage, \&match_created_before, @params);
463     +   }
464      
465         if (exists $IkiWiki::pagectime{$testpage}) {
466                 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
467     @@ -1834,6 +1943,11 @@ sub match_created_before ($$;@) {
468      sub match_created_after ($$;@) {
469         my $page=shift;
470         my $testpage=shift;
471     +   my @params=@_;
472     +
473     +   if (substr($testpage, 0, 1) eq '~') {
474     +           return check_named_spec_existential($page, $testpage, \&match_created_after, @params);
475     +   }
476      
477         if (exists $IkiWiki::pagectime{$testpage}) {
478                 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {