summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-08-29 13:21:25 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-08-29 13:21:25 -0400
commit494b36acd6b23502be9c907b2d3f7121c8f1576b (patch)
treec720f7f2fc04af306ab32fb2f7ec3ed96ff9a9a0
parent70d8df54a51ff6b6e455627783cb00ff64f93963 (diff)
parent18e531f4a8d71a47e0a919e7dcadde29083f6772 (diff)
Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info
-rw-r--r--doc/bugs/Filenames_with_colons_cause_problems_for_Windows_users.mdwn22
-rw-r--r--doc/todo/tracking_bugs_with_dependencies.mdwn268
2 files changed, 287 insertions, 3 deletions
diff --git a/doc/bugs/Filenames_with_colons_cause_problems_for_Windows_users.mdwn b/doc/bugs/Filenames_with_colons_cause_problems_for_Windows_users.mdwn
index b02239171..289e3534f 100644
--- a/doc/bugs/Filenames_with_colons_cause_problems_for_Windows_users.mdwn
+++ b/doc/bugs/Filenames_with_colons_cause_problems_for_Windows_users.mdwn
@@ -17,7 +17,16 @@ Windows does not support filenames containing any of these characters: `/ \ * :
>>> the source repo it's working on has a file with a problem character
>>> added to it, since the breakage will happen at the revision control
>>> system level.
->>>
+
+>>>> Just a quick note that the version control community generally doesn't
+>>>> agree with that view. They'll store what you ask them to store. If you
+>>>> want to work cross platform, then you need to make sure that all
+>>>> your file names work on all the platforms you're interested in. (Note: many systems will
+>>>> warn on commit, but not all. Many systems also have a way to fix
+>>>> the problem without checking out, but not all.) Another common place for this to
+>>>> arise is case insensitive file systems. If you have two files committed
+>>>> that differ only in case, then you cannot check out on a Mac in most systems.
+
>>> OTOH, there are some simple mods to ikiwiki that can make it escape
>>> colons etc the same way it already escapes other problem characters
>>> like "*", "?", etc. Without actually testing it, it should suffice to
@@ -32,7 +41,16 @@ Windows does not support filenames containing any of these characters: `/ \ * :
>>> annoying transition. I could do a OS test and do it in Windows, but then
>>> there would be interop problems if a Windows and non-windows system both
>>> acted on the same wiki source.
->>>
+
+>>>> I haven't checked the source, but need this break existing wikis?
+>>>> I can imagine a system where a colon gets converted to something safe,
+>>>> and the safe encoding gets converted back to a colon. But if you
+>>>> already have a colon, that doesn't get converted and stays a colon, and
+>>>> so it should still work shouldn't it? The only
+>>>> problem would be with pages that already have the 'safe encoding for a colon'.
+>>>> They'll suddenly change names. Well, I should finish frying my current fish
+>>>> before taking on something new, so I'll shut up now :). -- [[Will]]
+
>>> So, I guess it has to be a config option, possibly defaulting on
>>> when the OS is Windows. And if being able to checkout/etc the wiki
>>> source on windows systems is desired, you'd have to remember to turn
diff --git a/doc/todo/tracking_bugs_with_dependencies.mdwn b/doc/todo/tracking_bugs_with_dependencies.mdwn
index a2287cdf4..53b5fc070 100644
--- a/doc/todo/tracking_bugs_with_dependencies.mdwn
+++ b/doc/todo/tracking_bugs_with_dependencies.mdwn
@@ -136,7 +136,13 @@ The following three inlines work for me with this patch:
>>>> `%params` contains the parameters passed to `pagespec_match`, not
>>>> user-supplied parameters. The user-supplied parameter to a function
>>>> like `match_glob()` or `match_link()` is passed in the second positional parameter. --[[Joey]]
->>
+
+>>>>> OK. That seems reasonable then. The only problem is that my PERLfu is not strong enough to make it
+>>>>> work. I really have to wonder what substance was influencing the designers of PERL...
+>>>>> I can't figure out how to use the %params. And I'm pissed off enough with PERL that I'm not going
+>>>>> to try and figure it out any more. There are two patches below now. The first one uses an extra
+>>>>> argument and works. The second one tries to use %params and doesn't - take your pick :-). -- [[Will]]
+
>> What do you think is best to do about `is_globlist()`? At the moment it requires that the 'second word', as
>> 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).
>> My thought was just to search for 'and' or 'or' as words anywhere in the pagespec. Thoughts?
@@ -144,6 +150,8 @@ The following three inlines work for me with this patch:
>>> Dunno, we could just finish deprecating it. Or change the regexp to
>>> skip over spaces in parens. (`/[^\s]+\s+([^)]+)/`) --[[Joey]]
+>>>> I think I have a working regexp now.
+
>> Oh, one more thing. In pagespec_translate (now pagespec_makeperl), there is a part of the regular expression for `# any other text`.
>> This contained `()`, which has no effect. I replaced that with `\(\)`, but that is a change in the definition of pagespecs unrelated to the
>> rest of this patch. In a related change, commands were not able to contain `)` in their parameters. I've extended that so the cannot
@@ -167,6 +175,11 @@ The following three inlines work for me with this patch:
>>> Re commands containing '(', I don't really see any reason not to
>>> allow that, unless it breaks something. --[[Joey]]
+>>>> Oh, I didn't realise you didn't need to escape parens inside []. All else I
+>>>> I understood. I have stopped commands from containing parens because
+>>>> once you allow that then you might have a extra level of depth in the parsing
+>>>> of define() statements. -- [[Will]]
+
>>> Updated patch. Moved the specFuncsRef to the front of the arg list. Still haven't thought through the security implications of
>>> having it in `%params`. I've also removed all the debugging `print` statements. And I've updated the `is_globlist()` function.
>>> I think this is ready for people other than me to have a play. It is not well enough tested to commit just yet.
@@ -631,3 +644,256 @@ index b2c85c8..788f248 100644
IkiWiki::Plugin::meta::match("copyright", @_);
} #}}}
+----
+
+diff --git a/IkiWiki.pm b/IkiWiki.pm
+index e476521..0751d56 100644
+--- a/IkiWiki.pm
++++ b/IkiWiki.pm
+@@ -1524,7 +1524,16 @@ sub globlist_to_pagespec ($) { #{{{
+
+ sub is_globlist ($) { #{{{
+ my $s=shift;
+- return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
++ return ! ($s =~ /
++ (^\s*
++ [^\s(]+ # single item
++ (\( # possibly with parens after it
++ ([^)]* # with stuff inside those parens
++ (\([^)]*\))*)* # maybe even nested parens
++ \))?\s*$
++ ) |
++ (\s and \s) | (\s or \s) # or we find 'and' or 'or' somewhere
++ /x);
+ } #}}}
+
+ sub safequote ($) { #{{{
+@@ -1605,7 +1614,7 @@ sub pagespec_merge ($$) { #{{{
+ return "($a) or ($b)";
+ } #}}}
+
+-sub pagespec_translate ($) { #{{{
++sub pagespec_makeperl ($) { #{{{
+ my $spec=shift;
+
+ # Support for old-style GlobLists.
+@@ -1624,7 +1633,9 @@ sub pagespec_translate ($) { #{{{
+ |
+ \) # )
+ |
+- \w+\([^\)]*\) # command(params)
++ define\(\s*~\w+\s*,((\([^()]*\)) | ([^()]+))+\) # define(~specName, spec) - spec can contain parens 1 deep
++ |
++ \w+\([^()]*\) # command(params) - params cannot contain parens
+ |
+ [^\s()]+ # any other text
+ )
+@@ -1640,16 +1651,23 @@ sub pagespec_translate ($) { #{{{
+ elsif ($word eq "(" || $word eq ")" || $word eq "!") {
+ $code.=' '.$word;
+ }
++ elsif ($word =~ /^define\(\s*~(\w+)\s*,(.*)\)$/) {
++ $code .= " (\$params{specFuncs}->{$1}="; # (exists \$params{specFuncs}) &&
++ $code .= "memoize(";
++ $code .= &pagespec_makeperl($2);
++ $code .= ")";
++ $code .= ") ";
++ }
+ elsif ($word =~ /^(\w+)\((.*)\)$/) {
+ if (exists $IkiWiki::PageSpec::{"match_$1"}) {
+- $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@_)";
++ $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \%params)";
+ }
+ else {
+ $code.=' 0';
+ }
+ }
+ else {
+- $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
++ $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \%params)";
+ }
+ }
+
+@@ -1657,23 +1675,36 @@ sub pagespec_translate ($) { #{{{
+ $code=0;
+ }
+
++ return 'sub { my $page=shift; my %params = @_; '.$code.' }';
++} #}}}
++
++sub pagespec_translate ($) { #{{{
++ my $spec=shift;
++
++ my $code = pagespec_makeperl($spec);
++
++ print "Spec '$spec' generated code '$code'\n";
++
+ no warnings;
+- return eval 'sub { my $page=shift; '.$code.' }';
++ return eval $code;
+ } #}}}
+
+ sub pagespec_match ($$;@) { #{{{
+ my $page=shift;
+ my $spec=shift;
+ my @params=@_;
++ my %params=@_;
+
+ # Backwards compatability with old calling convention.
+ if (@params == 1) {
+- unshift @params, 'location';
++ %params = { location => $params[1] };
+ }
+
++ $params{specFuncs} = {} unless exists $params{specFuncs};
++
+ my $sub=pagespec_translate($spec);
+ return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
+- return $sub->($page, @params);
++ return $sub->($page, %params);
+ } #}}}
+
+ sub pagespec_valid ($) { #{{{
+@@ -1722,11 +1753,84 @@ sub new { #{{{
+
+ package IkiWiki::PageSpec;
+
++sub check_named_spec($$;@) {
++ my $page=shift;
++ my $specName=shift;
++ my %params=@_;
++
++ print "Checking named spec $specName\n";
++
++ error("Unable to find specFuncs in params to check_named_spec()!") unless exists $params{specFuncs};
++ my $specFuncsRef=$params{specFuncs};
++
++ print "A\n";
++
++ return IkiWiki::FailReason->new("Named page spec '$specName' is not valid")
++ unless (substr($specName, 0, 1) eq '~');
++
++ $specName = substr($specName, 1);
++
++ if (exists $specFuncsRef->{$specName}) {
++ # remove the named spec from the spec refs
++ # when we recurse to avoid infinite recursion
++ my $sub = $specFuncsRef->{$specName};
++ $specFuncsRef->{$specName} = undef;
++ my $result = $sub->($specFuncsRef, $page, %params);
++ $specFuncsRef->{$specName} = $sub;
++ return $result;
++ } else {
++ print "Invalid specname\n";
++ return IkiWiki::FailReason->new("Page spec '$specName' does not exist");
++ }
++}
++
++sub check_named_spec_existential($$$;@) {
++ my $page=shift;
++ my $specName=shift;
++ my $funcref=shift;
++ my %params=@_;
++
++ print "(Existential) Checking named spec $specName\n";
++
++ error("Unable to find specFuncs in params to check_named_spec()!") unless exists $params{specFuncs};
++ my $specFuncsRef=$params{specFuncs};
++
++ print "B\n";
++
++ return IkiWiki::FailReason->new("Named page spec '$specName' is not valid")
++ unless (substr($specName, 0, 1) eq '~');
++ $specName = substr($specName, 1);
++
++ if (exists $specFuncsRef->{$specName}) {
++ # remove the named spec from the spec refs
++ # when we recurse to avoid infinite recursion
++ my $sub = $specFuncsRef->{$specName};
++ $specFuncsRef->{$specName} = undef;
++
++ foreach my $nextpage (keys %IkiWiki::pagesources) {
++ if ($sub->($specFuncsRef, $nextpage, %params)) {
++ my $tempResult = $funcref->($page, $nextpage, %params);
++ return $tempResult if ($tempResult);
++ }
++ }
++
++ $specFuncsRef->{$specName} = $sub;
++ return IkiWiki::FailReason->new("No page in spec '$specName' was successfully matched");
++ } else {
++ print "Invalid specname\n";
++ return IkiWiki::FailReason->new("Named page spec '$specName' does not exist");
++ }
++}
++
+ sub match_glob ($$;@) { #{{{
+ my $page=shift;
+ my $glob=shift;
+ my %params=@_;
+
++ if (substr($glob, 0, 1) eq '~') {
++ return check_named_spec($page, $glob, %params);
++ }
++
+ my $from=exists $params{location} ? $params{location} : '';
+
+ # relative matching
+@@ -1756,11 +1860,16 @@ sub match_internal ($$;@) { #{{{
+
+ sub match_link ($$;@) { #{{{
+ my $page=shift;
+- my $link=lc(shift);
++ my $fulllink=shift;
++ my $link=lc($fulllink);
+ my %params=@_;
+
+- my $from=exists $params{location} ? $params{location} : '';
++ if (substr($fulllink, 0, 1) eq '~') {
++ return check_named_spec_existential($page, $fulllink, \&match_link, %params);
++ }
+
++ my $from=exists $params{location} ? $params{location} : '';
++
+ # relative matching
+ if ($link =~ m!^\.! && defined $from) {
+ $from=~s#/?[^/]+$##;
+@@ -1785,12 +1894,25 @@ sub match_link ($$;@) { #{{{
+ } #}}}
+
+ sub match_backlink ($$;@) { #{{{
+- return match_link($_[1], $_[0], @_);
++ my $page=shift;
++ my $backlink=shift;
++ my %params=@_;
++
++ if (substr($backlink, 0, 1) eq '~') {
++ return check_named_spec_existential($page, $backlink, \&match_backlink, %params);
++ }
++
++ return match_link($backlink, $page, %params);
+ } #}}}
+
+ sub match_created_before ($$;@) { #{{{
+ my $page=shift;
+ my $testpage=shift;
++ my %params=@_;
++
++ if (substr($testpage, 0, 1) eq '~') {
++ return check_named_spec_existential($page, $testpage, \&match_created_before, %params);
++ }
+
+ if (exists $IkiWiki::pagectime{$testpage}) {
+ if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
+@@ -1808,6 +1930,11 @@ sub match_created_before ($$;@) { #{{{
+ sub match_created_after ($$;@) { #{{{
+ my $page=shift;
+ my $testpage=shift;
++ my %params=@_;
++
++ if (substr($testpage, 0, 1) eq '~') {
++ return check_named_spec_existential($page, $testpage, \&match_created_after, %params);
++ }
+
+ if (exists $IkiWiki::pagectime{$testpage}) {
+ if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {