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 [[!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.
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
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.
66 >>  --[[Joey]]
67
68 >>> If you memoize the outcomes of the named pagespecs you can make in O(N.X), no?
69 >>> -- [[Will]]
70
71 >>>> Yeah, guess that'd work. :-)
72
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.
77 >
78 > -- [[Will]]
79
80 >> I saw that this issue is targeted at by the work on [[structured page data#another_kind_of_links]]. --Ivan Z.
81
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.
84
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:
87
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)"]]
91
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.
94
95     foreach my $nextpage (keys %IkiWiki::pagesources)
96
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]].
99
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]]
102
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]]
106
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]]
111
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.)
115
116 The following three inlines work for me with this patch:
117
118     Bugs:
119     
120     [ [!inline pages="define(~bugs, bugs/* and ! */Discussion) and ~bugs" archive="yes"]]
121     
122     OpenBugs:
123     
124     [ [!inline pages="define(~bugs, bugs/* and ! */Discussion) and define(~openbugs,~bugs and !link(done)) and ~openbugs" archive="yes"]]
125     
126     ReadyBugs:
127     
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"]]
129
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]]
133
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.
140 >>
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]]
144
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]]
150
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?
154
155 >>> Dunno, we could just finish deprecating it. Or change the regexp to
156 >>> skip over spaces in parens. (`/[^\s]+\s+([^)]+)/`) --[[Joey]]
157
158 >>>> I think I have a working regexp now.
159
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]]
164
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.
172 >>>
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!
175 >>> 
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!).
179 >>> 
180 >>> Re commands containing '(', I don't really see any reason not to
181 >>> allow that, unless it breaks something. --[[Joey]]
182
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]]
187
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.
191 >>> -- [[Will]]
192
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]]
195
196 > Very belated code review of last version of the patch:
197
198 > * `is_globlist` is no longer needed
199 > * I don't understand why the pagespec match regexp is changed
200 >   from having flags `igx` to `ixgs`. Don't see why you
201 >   want `.` to match '\n` in it, and don't see any `.` in the regexp 
202 >   anyway?
203 > * Some changes of `@_` to `%params` in `pagespec_makeperl` do not
204 >   make sense to me. I don't see where \%params is defined and populated,
205 >   except with `\$params{specFunc}`.
206 > * Seems that the only reason `match_glob` has to check for `~` is
207 >   because when a named spec appears in a pagespec, it is translated
208 >   to `match_glob("~foo")`. If, instead, `pagespec_makeperl` checked
209 >   for named specs, it could convert them into `check_named_spec("foo")`
210 >   and avoid that ugliness.
211 > * The changes to `match_link` seem either unecessary, or incomplete.
212 >   Shouldn't it check for named specs and call
213 >   `check_named_spec_existential`?
214 > * Generally, the need to modify `match_*` functions so that they
215 >   check for and handle named pagespecs seems suboptimal, if
216 >   only because there might be others people may want to use named
217 >   pagespecs with. It would be possible to move this check
218 >   to `pagespec_makeperl`, by having it check if the parameter
219 >   passed to a pagespec function looked like a named pagespec.
220 >   The only issue is that some pagespec functions take a parameter
221 >   that is not a page name at all, and it could be weird
222 >   if such a parameter were accidentially interpreted as a named
223 >   pagespec. (But, that seems unlikely to happen.)
224 > * I need to check if your trick to avoid infinite recursion
225 >   works if there are two named specs that recursively
226 >   call one-another. I suspect it does, but will test this
227 >   myself..
228 >  
229 > --[[Joey]] 
230
231 ----
232
233     diff --git a/IkiWiki.pm b/IkiWiki.pm
234     index 4e4da11..8b3cdfe 100644
235     --- a/IkiWiki.pm
236     +++ b/IkiWiki.pm
237     @@ -1550,7 +1550,16 @@ sub globlist_to_pagespec ($) {
238      
239      sub is_globlist ($) {
240         my $s=shift;
241     -   return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
242     +   return ! ($s =~ /
243     +                   (^\s*
244     +                           [^\s(]+         # single item
245     +                                   (\(                     # possibly with parens after it
246     +                                           ([^)]*  # with stuff inside those parens
247     +                                           (\([^)]*\))*)*  # maybe even nested parens
248     +                                   \))?\s*$
249     +                   ) |
250     +                           (\s and \s) | (\s or \s)        # or we find 'and' or 'or' somewhere
251     +                   /xs);
252      }
253      
254      sub safequote ($) {
255     @@ -1631,7 +1640,7 @@ sub pagespec_merge ($$) {
256         return "($a) or ($b)";
257      }
258      
259     -sub pagespec_translate ($) {
260     +sub pagespec_makeperl ($) {
261         my $spec=shift;
262      
263         # Support for old-style GlobLists.
264     @@ -1650,12 +1659,14 @@ sub pagespec_translate ($) {
265                 |
266                         \)              # )
267                 |
268     -                   \w+\([^\)]*\)   # command(params)
269     +                   define\(\s*~\w+\s*,((\([^()]*\)) | ([^()]+))+\) # define(~specName, spec) - spec can contain parens 1 deep
270     +           |
271     +                   \w+\([^()]*\)   # command(params) - params cannot contain parens
272                 |
273                         [^\s()]+        # any other text
274                 )
275                 \s*             # ignore whitespace
276     -   }igx) {
277     +   }igxs) {
278                 my $word=$1;
279                 if (lc $word eq 'and') {
280                         $code.=' &&';
281     @@ -1666,16 +1677,23 @@ sub pagespec_translate ($) {
282                 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
283                         $code.=' '.$word;
284                 }
285     -           elsif ($word =~ /^(\w+)\((.*)\)$/) {
286     +           elsif ($word =~ /^define\(\s*~(\w+)\s*,(.*)\)$/s) {
287     +                   $code .= " (\$params{specFuncs}->{$1}=";        # (exists \$params{specFuncs}) && 
288     +                   $code .= "memoize(";
289     +                   $code .= &pagespec_makeperl($2);
290     +                   $code .= ")";
291     +                   $code .= ") ";
292     +           }
293     +           elsif ($word =~ /^(\w+)\((.*)\)$/s) {
294                         if (exists $IkiWiki::PageSpec::{"match_$1"}) {
295     -                           $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@_)";
296     +                           $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \%params)";
297                         }
298                         else {
299                                 $code.=' 0';
300                         }
301                 }
302                 else {
303     -                   $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
304     +                   $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \%params)";
305                 }
306         }
307      
308     @@ -1683,8 +1701,18 @@ sub pagespec_translate ($) {
309                 $code=0;
310         }
311      
312     +   return 'sub { my $page=shift; my %params = @_; '.$code.' }';
313     +}
314     +
315     +sub pagespec_translate ($) {
316     +   my $spec=shift;
317     +
318     +   my $code = pagespec_makeperl($spec);
319     +
320     +   # print STDERR "Spec '$spec' generated code '$code'\n";
321     +
322         no warnings;
323     -   return eval 'sub { my $page=shift; '.$code.' }';
324     +   return eval $code;
325      }
326      
327      sub pagespec_match ($$;@) {
328     @@ -1699,7 +1727,7 @@ sub pagespec_match ($$;@) {
329      
330         my $sub=pagespec_translate($spec);
331         return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
332     -   return $sub->($page, @params);
333     +   return $sub->($page, @params, specFuncs => {});
334      }
335      
336      sub pagespec_valid ($) {
337     @@ -1748,11 +1776,78 @@ sub new {
338      
339      package IkiWiki::PageSpec;
340      
341     +sub check_named_spec($$;@) {
342     +   my $page=shift;
343     +   my $specName=shift;
344     +   my %params=@_;
345     +   
346     +   error("Unable to find specFuncs in params to check_named_spec()!") unless exists $params{specFuncs};
347     +
348     +   my $specFuncsRef=$params{specFuncs};
349     +   
350     +   return IkiWiki::FailReason->new("Named page spec '$specName' is not valid")
351     +           unless (substr($specName, 0, 1) eq '~');
352     +   
353     +   $specName = substr($specName, 1);
354     +
355     +   if (exists $specFuncsRef->{$specName}) {
356     +           # remove the named spec from the spec refs
357     +           # when we recurse to avoid infinite recursion
358     +           my $sub = $specFuncsRef->{$specName};
359     +           delete $specFuncsRef->{$specName};
360     +           my $result = $sub->($page, %params);
361     +           $specFuncsRef->{$specName} = $sub;
362     +           return $result;
363     +   } else {
364     +           return IkiWiki::FailReason->new("Page spec '$specName' does not exist");
365     +   }
366     +}
367     +
368     +sub check_named_spec_existential($$$;@) {
369     +   my $page=shift;
370     +   my $specName=shift;
371     +   my $funcref=shift;
372     +   my %params=@_;
373     +   
374     +   error("Unable to find specFuncs in params to check_named_spec_existential()!") unless exists $params{specFuncs};
375     +   my $specFuncsRef=$params{specFuncs};
376     +   
377     +   return IkiWiki::FailReason->new("Named page spec '$specName' is not valid")
378     +           unless (substr($specName, 0, 1) eq '~');
379     +   $specName = substr($specName, 1);
380     +   
381     +   if (exists $specFuncsRef->{$specName}) {
382     +           # remove the named spec from the spec refs
383     +           # when we recurse to avoid infinite recursion
384     +           my $sub = $specFuncsRef->{$specName};
385     +           delete $specFuncsRef->{$specName};
386     +           
387     +           foreach my $nextpage (keys %IkiWiki::pagesources) {
388     +                   if ($sub->($nextpage, %params)) {
389     +                           my $tempResult = $funcref->($page, $nextpage, %params);
390     +                           if ($tempResult) {
391     +                                   $specFuncsRef->{$specName} = $sub;
392     +                                   return $tempResult;
393     +                           }
394     +                   }
395     +           }
396     +           
397     +           $specFuncsRef->{$specName} = $sub;
398     +           return IkiWiki::FailReason->new("No page in spec '$specName' was successfully matched");
399     +   } else {
400     +           return IkiWiki::FailReason->new("Named page spec '$specName' does not exist");
401     +   }
402     +}
403     +
404      sub match_glob ($$;@) {
405         my $page=shift;
406         my $glob=shift;
407         my %params=@_;
408         
409     +   if (substr($glob, 0, 1) eq '~') {
410     +           return check_named_spec($page, $glob, %params);
411     +   }
412     +
413         my $from=exists $params{location} ? $params{location} : '';
414         
415         # relative matching
416     @@ -1782,11 +1877,12 @@ sub match_internal ($$;@) {
417      
418      sub match_link ($$;@) {
419         my $page=shift;
420     -   my $link=lc(shift);
421     +   my $fulllink=shift;
422         my %params=@_;
423     +   my $link=lc($fulllink);
424      
425         my $from=exists $params{location} ? $params{location} : '';
426     -
427     +   
428         # relative matching
429         if ($link =~ m!^\.! && defined $from) {
430                 $from=~s#/?[^/]+$##;
431     @@ -1804,19 +1900,32 @@ sub match_link ($$;@) {
432                 }
433                 else {
434                         return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
435     -                           if match_glob($p, $link, %params);
436     +                           if match_glob($p, $fulllink, %params);
437                 }
438         }
439         return IkiWiki::FailReason->new("$page does not link to $link");
440      }
441      
442      sub match_backlink ($$;@) {
443     -   return match_link($_[1], $_[0], @_);
444     +   my $page=shift;
445     +   my $backlink=shift;
446     +   my @params=@_;
447     +
448     +   if (substr($backlink, 0, 1) eq '~') {
449     +           return check_named_spec_existential($page, $backlink, \&match_backlink, @params);
450     +   }
451     +
452     +   return match_link($backlink, $page, @params);
453      }
454      
455      sub match_created_before ($$;@) {
456         my $page=shift;
457         my $testpage=shift;
458     +   my @params=@_;
459     +
460     +   if (substr($testpage, 0, 1) eq '~') {
461     +           return check_named_spec_existential($page, $testpage, \&match_created_before, @params);
462     +   }
463      
464         if (exists $IkiWiki::pagectime{$testpage}) {
465                 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
466     @@ -1834,6 +1943,11 @@ sub match_created_before ($$;@) {
467      sub match_created_after ($$;@) {
468         my $page=shift;
469         my $testpage=shift;
470     +   my @params=@_;
471     +
472     +   if (substr($testpage, 0, 1) eq '~') {
473     +           return check_named_spec_existential($page, $testpage, \&match_created_after, @params);
474     +   }
475      
476         if (exists $IkiWiki::pagectime{$testpage}) {
477                 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {