47252638979c9b91b707a61e525cb6e81d4fe52a
[ikiwiki.git] / doc / todo / pagespec_aliases.mdwn
1 [[!template id=gitbranch branch=jon/pagespec_alias author="[[Jon]]"]]
2 [[!tag patch wishlist]]I quite often find myself repeating a boiler-plate
3 [[ikiwiki/pagespec]] chunk, e.g.
4
5     and !*.png and !*.jpg...
6
7 it would be quite nice if I could conveniently bundle them together into a
8 pagespec "alias", and instead write
9
10     and !image()...
11
12 I wrote the following plugin to achieve this:
13
14     <snip old patch; see git branch outlined above>
15
16 I need to reflect on this a bit more before I send a pull request.  In
17 particular I imagine the strict/warnings stuff will make you puke.  Also, I'm
18 not sure whether I should name-grab 'alias' since [[todo/alias_directive]] is
19 an existing wishlist item.
20
21 > I think it would make sense to have "pagespec" in the name somehow.
22
23 > > Good idea, how about `pagespecalias`? — [[Jon]]
24
25 >
26 > No, the strict/warnings does not make me puke. Have you read my perl
27 > code? :-P
28
29 > Note that your XXX is right. It would be a security hole to not validate
30 > `$key`, as anyone with websetup access could cause it to run arbitrary
31 > perl code.
32
33 > Well, except that websetup doesn't currently support configuring hashes
34 > like used here. Which is a pity, but has led me to try to avoid using
35 > such hashes in the setup file.
36
37 > > If I removed the `getsetup` subroutine, it would not be exposed via
38 > > website, is that right?  I suppose it doesn't hurt to validate key, even if
39 > > this risk was not there.  Is the use of a hash here a blocker for adoption?
40 > > — [[Jon]]
41
42 > Have you considered not defining the pagespec aliases in the setup file, but
43 > instead as directives on pages in the wiki? Using pagestate could store
44 > up the aliases that have been defined. It could however, be hard to get
45 > the dependencies right; any page that uses a pagespec containing 
46 > an alias `foo` would need to somehow depend on the page where the alias
47 > was defined. --[[Joey]] 
48
49 > > I haven't thought the dependency issue through beyond "that might be hard".
50 > > Personally, I don't like defining stuff like this in pages, but I appreciate
51 > > some do.  There could be some complex scenarios where some pages rely on a
52 > > pagespec alias defined on others; and could have their meanings changed by
53 > > changing the definition.  A user might have permission to edit a page with a
54 > > definition on it but not on the pages that use it, and similar subtle permission
55 > > bugs.  I'm also not sure what the failure mode is if someone redefines an alias,
56 > > and whether there'd be an unpredictable precedence problem.
57 > > How about both methods? — [[Jon]]
58
59 Here's an example setup chunk:
60
61      pagespec_aliases:
62        image: "*.png or *.jpg or *.jpeg or *.gif or *.ico"
63        helper: "*.css or *.js"
64        boring: "image() or helper()"
65
66 The above demonstrates self-referential dynamic pagespec aliases.  It doesn't work,
67 however, to add ' or internal()' to `boring`, for some reason.
68
69 -- [[Jon]]
70
71 > Probably needs to be `or internal(*)` --[[Joey]] 
72
73 > > Ah yes, could be, thanks. — [[Jon]]
74
75 > another useful pagespec alias for large maps:
76
77        basewiki: "sandbox or templates or templates/* or ikiwiki or ikiwiki/* or shortcuts or recentchanges or wikiicons/*"
78
79 > -- [[Jon]]
80
81 >> Useful indeed! --[[Joey]] 
82
83
84 >>> I've tweaked my patch in light of your above feedback:  The plugin has
85 >>> been renamed, and I now validate keys.  I've also added documentation to
86 >>> the branch.  I haven't read rubykat's code properly yet, and don't have
87 >>> access at the time of writing (I'm on a beach in Greece ☺), but I expect
88 >>> it would be possible to extend what I've got here to support defining the
89 >>> aliases in a PageSpec, once the dependency stuff has been reasoned out
90 >>> properly.  — [[Jon]]
91
92 ---------------------------
93
94 Based on the above, I have written an experimental plugin called "subset".
95 It's in my "ikiplugins" repo on github, in the "experimental" branch.
96 <https://github.com/rubykat/ikiplugins/blob/experimental/IkiWiki/Plugin/subset.pm>
97
98 It takes Joey's suggestion of defining the subsets (aliases) as directives;
99 I took the example of the [[plugins/shortcut]] plugin and designated a single special page as the one where the directives are defined,
100 though unlike "shortcut" I haven't hardcoded the name of the page; it defaults to "subsets" but it can be re-defined in the config.
101
102 I've also added a feature which one might call subset-caching; I had to override `pagespec_match_list` to do it, however.
103 An extra parameter added to `pagespec_match_list` called `subset` which
104
105 * limits the result to look *only* within the set of pages defined by the subset (uses the "list" option to pagespec_match_list to do this)
106 * caches the result of the subset search so that the second time subset "foo" is used, it uses the stored result of the first search for "foo".
107
108 This speeds things up if one is using a particular subset more than once, which one probably is if one bothered to define the subset in the first place.
109 The speed increase is most dramatic when the site has a large number of pages and the number of pages in the subset is small.
110 (this is similar to the "trail" concept I used in my [[plugins/contrib/report]] plugin, but not quite the same)
111
112 Note that things like [[plugins/map]] can't make use of "subset" (yet) because they don't pass along all the parameters they're given.
113 But [[plugins/contrib/report]] actually works without alteration because it does pass along all the parameters.
114
115 Unfortunately I haven't figured out how to do the dependencies - I'd really appreciate help on that.
116
117 --[[KathrynAndersen]]
118
119 > > Cool!  I like the caching idea.  I'm not sure about the name.  I don't like defining
120 > > stuff in pages, but I appreciate this is a matter of taste, and would be happy with
121 > > supporting both. — [[Jon]]
122
123 >>> I've now gone and completely re-done "subset" so that it is less like an alias, but it a bit clearer and simpler:
124 >>> instead of having a separate "match_" function for every alias, I simply have one function, "match_subset"
125 >>> which takes the name of the subset.  Thus a \[[!subset name="foo"...]] would be called `subset(foo)` rather than `foo()`.
126
127 >>> There are a few reasons for this:<br/>
128 >>> (a) it's more secure not to be evaluating code on the fly<br/>
129 >>> (b) it's simpler<br/>
130 >>> (c) (and this was my main reason) it makes it possible to do caching without having to have a separate "subset" argument.
131 >>> I've done a bit of a hack for this: basically, the PageSpec is checked to see if the very start of the PageSpec is `subset(foo) and` or if the whole pagespec is just `subset(foo)` and if either of those is true, then it does the subset caching stuff.
132 >>> The reason I check for "and" is that if it is "subset(foo) or something" then it would be an error to use the subset cache in that case.
133 >>> The reason I just check the start of the PageSpec is because I don't want to have to do complex parsing of the PageSpec.
134
135 >>> As for defining subsets in the config rather than on pages, I perfectly understand that desire, and I could probably add that in.
136
137 >>> As for the name "subset"... well, it's even less like an alias now, and "alias" is already a reserved name.  What other names would you suggest?
138
139 >>>--[[KathrynAndersen]]