]> sipb.mit.edu Git - ikiwiki.git/blob - doc/todo/want_to_avoid_ikiwiki_using_http_or_https_in_urls_to_allow_serving_both.mdwn
use cgitemplate, remove misctemplate
[ikiwiki.git] / doc / todo / want_to_avoid_ikiwiki_using_http_or_https_in_urls_to_allow_serving_both.mdwn
1 ## current status
2
3 [[done]] again! :)
4
5 * CGI pages, with the exception of edit pages, set `<base>` to
6   `$config{url}`
7
8   I had to revert using `baseurl(undef)` for that, because it needs
9   to be a full url.
10
11   Ideally, baseurl would return an absolute url derived from the url
12   being used to access the cgi, but that needs access to the CGI object,
13   which it does not currently have. Similarly, `misctemplate`
14   does not have access to the CGI object, so it cannot use it to
15   generate a better baseurl. Not sure yet what to do; may have to thread
16   a cgi parameter through all the calls to misctemplate. --[[Joey]]
17
18   > Fixed, cgitemplate is used now. --[[Joey]] 
19
20 * Using `do=goto` to go to a comment or recentchanges item
21   will redirect to the `$config{url}`-based url, since the
22   permalinks are made to be absolute urls now.
23
24   Fixing this would seem to involve making meta force permalinks
25   to absolute urls when fulling out templates, while allowing them
26   to be left as partial urls internally, for use by goto. --[[Joey]]
27
28   > This reversion has now been fixed. --[[Joey]]
29
30 ## old attempt
31
32 It looks like all links in websites are absolute paths, this has some limitations:
33
34 * If connecting to website via https://... all links will take you back to http://
35 * Makes it harder to mirror website via HTML version, as all links have to be updated.
36
37 It would be good if relative paths could be used instead, so the transport method isn't changed unless specifically requested.
38
39 -- Brian May
40
41 > Er, which absolute links are you talking about? If you view the source
42 > to this page, you'll find links such as "../favicon.ico", "../style.css",
43 > "../../", and "../". The only absolute links are to CGIs and the w3c DTD.
44 > --[[Joey]]
45
46 >> The problem is within the CGI script. The links within the HTML page are all
47 >> absolute, including links to the css file. Having a http links within a HTML
48 >> page retrieved using https upset most browsers (I think). Also if I push cancel
49 >> on the edit page in https, I end up at at http page. -- Brian May
50
51 >>> Ikiwiki does not hardcode http links anywhere. If you don't want
52 >>> it to use such links, change your configuration to use https
53 >>> consistently. --[[Joey]]
54
55 Errr... That is not a solution, that is a work around. ikiwiki does not hard
56 code the absolute paths, but absolute paths are hard coded in the configuration
57 file. If you want to serve your website so that the majority of users can see
58 it as http, including in rss feeds (this allows proxy caches to cache the
59 contents and has reduced load requirements), but editing is done via https for
60 increased security, it is not possible. I have some ideas how this can be
61 implemented (as ikiwiki has the absolute path to the CGI script and the
62 absolute path to the destination, it should be possible to generate a relative
63 path from one to the other), although some minor issues still need to be
64 resolved. -- Brian May
65
66 I noticed the links to the images on <http://ikiwiki.info/recentchanges/> are
67 also absolute, that is <http://ikiwiki.info/wikiicons/diff.png>; this seems
68 surprising, as the change.tmpl file uses &lt;TMPL_VAR BASEURL&gt; which seems
69 to do the right thing in page.tmpl, but not for change.tmpl. Where is BASEURL
70 set? -- Brian May
71
72 > The use of an absolute baseurl in change.tmpl is a special case. --[[Joey]]
73
74 So I'm facing this same issue. I have a wiki which needs to be accessed on
75 three different URLs(!) and the hard coding of the URL from the setup file is
76 becoming a problem for me. Is there anything I can do here? --[[Perry]]
77
78 > I remain puzzled by the problem that Brian is discussing. I don't see
79 > why you can't just set the cgiurl and url to a https url, and serve
80 > the site using both http and https.
81
82 > Just for example, <https://kitenet.net/> is an ikiwiki, and it is accessible
83 > via https or http, and if you use https, links will remain on https (except
84 > for links using the cgi, which I could fix by changing the cgiurl to https).
85
86 > I think it's possible ikiwiki used to have some
87 > absolute urls that have been fixed since Brian filed the bug. --[[Joey]]  
88
89 [[wishlist]]
90
91 ----
92
93 [[!toggle id="smcv-https" text="Some discussion of a rejected implementation, smcv/https."]]
94 [[!toggleable id="smcv-https" text="""
95
96 [[!template id=gitbranch branch=smcv/https author="[[smcv]]"]]
97
98 For a while I've been using a configuration where each wiki has a HTTP and
99 a HTTPS mirror, and updating one automatically updates the other, but
100 that seems unnecessarily complicated. My `https` branch adds `https_url`
101 and `https_cgiurl` config options which can be used to provide a HTTPS
102 variant of an existing site; the CGI script automatically detects whether
103 it was accessed over HTTPS and switches to the other one.
104
105 This required some refactoring, which might be worth merging even if
106 you don't like my approach:
107
108 * change `IkiWiki::cgiurl` to return the equivalent of `$config{cgiurl}` if
109   called with no parameters, and change all plugins to indirect through it
110   (then I only need to change that one function for the HTTPS hack)
111
112 * `IkiWiki::baseurl` already has similar behaviour, so change nearly all
113   references to the `$config{url}` to call `baseurl` (a couple of references
114   specifically wanted the top-level public URL for Google or Blogspam rather
115   than a URL for the user's browser, so I left those alone)
116
117 --[[smcv]]
118
119 > The justification for your patch seems to be wanting to use a different
120 > domain, like secure.foo.com, for https? Can you really not just configure
121 > both url and cgiurl to use `https://secure.foo.com/...` and rely on
122 > relative links to keep users of `http://insecure.foo.com/` on http until
123 > they need to use the cgi? 
124
125 >> My problem with that is that uses of the CGI aren't all equal (and that
126 >> the CA model is broken). You could put CGI uses in two classes:
127 >>
128 >> - websetup and other "serious" things (for the sites I'm running, which
129 >>   aren't very wiki-like, editing pages is also in this class).
130 >>   I'd like to be able to let privileged users log in over
131 >>   https with httpauth (or possibly even a client certificate), and I don't
132 >>   mind teaching these few people how to do the necessary contortions to
133 >>   enable something like CACert.
134 >>
135 >> - Random users making limited use of the CGI: do=goto, do=404, and
136 >>   commenting with an OpenID. I don't think it's realistic to expect
137 >>   users to jump through all the CA hoops to get CACert installed for that,
138 >>   which leaves their browsers being actively obstructive, unless I either
139 >>   pay the CA tax (per subdomain) to get "real" certificates, or use plain
140 >>   http.
141 >>
142 >> On a more wiki-like wiki, the second group would include normal page edits.
143 >>
144 >>> I see your use case. It still seems to me that for the more common
145 >>> case where CA tax has been paid (getting a cert that is valid for
146 >>> multiple subdomains should be doable?), having anything going through the
147 >>> cgiurl upgrade to https would be ok. In that case, http is just an
148 >>> optimisation for low-value, high-aggregate-bandwidth type uses, so a
149 >>> little extra https on the side is not a big deal. --[[Joey]]
150 >>
151 >> Perhaps I'm doing this backwards, and instead of having the master
152 >> `url`/`cgiurl` be the HTTP version and providing tweakables to override
153 >> these with HTTPS, I should be overriding particular uses to plain HTTP...
154 >>
155 >> --[[smcv]]
156 >>> 
157 >>> Maybe, or I wonder if you could just use RewriteEngine for such selective
158 >>> up/downgrading. Match on `do=(edit|create|prefs)`. --[[Joey]]
159
160 > I'm unconvinced.
161
162 > `Ikiwiki::baseurl()."foo"` just seems to be asking for trouble,
163 > ie being accidentially written as `IkiWiki::baseurl("foo")`,
164 > which will fail when foo is not a page, but some file.
165
166 >> That's a good point. --s
167
168 > I see multiple places (inline.pm, meta.pm, poll.pm, recentchanges.pm)
169 > where it will now put the https url into a static page if the build
170 > happens to be done by the cgi accessed via https, but not otherwise.
171 > I would rather not have to audit for such problems going forward.
172
173 >> Yes, that's a problem with this approach (either way round). Perhaps
174 >> making it easier to run two mostly-synched copies like I was previously
175 >> doing is the only solution... --s
176
177 """]]
178
179 ----
180
181 [[!template id=gitbranch branch=smcv/ready/localurl author="[[smcv]]"]]
182 [[!tag patch]]
183
184 OK, here's an alternative approach, closer in spirit to what was initially
185 requested. I included a regression test for `urlto`, `baseurl` and `cgiurl`,
186 now that they have slightly more complex behaviour.
187
188 The idea is that in the common case, the CGI and the pages will reside on the
189 same server, so they can use "semi-absolute" URLs (`/ikiwiki.cgi`, `/style.css`,
190 `/bugs/done`) to refer to each other. Most redirects, form actions, links etc.
191 can safely use this form rather than the fully-absolute URL.
192
193 The initial version of the branch had config options `local_url` and
194 `local_cgiurl`, but they're now automatically computed by checking
195 whether `url` and `cgiurl` are on the same server with the the same URL
196 scheme. In theory you could use things like `//static.example.com/wiki/`
197 and `//dynamic.example.com/ikiwiki.cgi` to preserve choice of http/https
198 while switching server, but I don't know how consistently browsers
199 support that.
200
201 "local" here is short for "locally valid", because these URLs are neither
202 fully relative nor fully absolute, and there doesn't seem to be a good name
203 for them...
204
205 I've tested this on a demo website with the CGI enabled, and it seemed to
206 work nicely (there might be bugs in some plugins, I didn't try all of them).
207 The branch at [[todo/use secure cookies for SSL logins]] goes well with
208 this one.
209
210 The `$config{url}` and `$config{cgiurl}` are both HTTP, but if I enable
211 `httpauth`, set `cgiauthurl` to a HTTPS version of the same site and log
212 in via that, links all end up in the HTTPS version.
213
214 New API added by this branch:
215
216 * `urlto(x, y, 'local')` uses `$local_url` instead of `$config{url}`
217
218   > Yikes. I see why you wanted to keep it to 3 parameters (4 is too many,
219   > and po overrides it), but I dislike overloading the third parameter
220   > like that.
221   > 
222   > There are fairly few calls to `urlto($foo, $bar)`, so why not
223   > make that always return the semi-local url form, and leave the third
224   > parameter for the cases that need a true fully-qualified url.
225   > The new form for local urls will typically be only a little bit longer,
226   > except in the unusual case where the cgiurl is elsewhere. --[[Joey]]
227
228   >> So, have urlto(x, y) use `$local_url`? There are few calls, but IMO
229   >> they're for the most important things - wikilinks, img, map and
230   >> other ordinary hyperlinks. Using `$local_url` would be fine for
231   >> webserver-based use, but it does stop you browsing your wiki's
232   >> HTML over `file:///` (unless you set that as the base URL, but
233   >> then you can't move it around), and stops you moving simple
234   >> outputs (like the docwiki!) around.
235   >>
236   >> I personally think breaking the docwiki is enough to block that.
237   >>
238   >>> Well, the docwiki doesn't have an url configured at all, so I assumed
239   >>> it would need to fall back to current behavior in that case. I had
240   >>> not thought about browsing wiki's html files though, good point.
241   >>
242   >> How about this?
243   >>
244   >> * `urlto($link, $page)` with `$page` defined: relative
245   >> * `urlto($link, undef)`: local, starts with `/`
246   >> * `urlto($link)`: also local, as a side-effect
247   >> * `urlto($link, $anything, 1)` (but idiomatically, `$anything` is
248   >>   normally undef): absolute, starts with `http[s]://`
249   >>
250   >> --[[smcv]]
251   >> 
252   >>> That makes a great deal of sense, bravo for actually removing
253   >>> parameters in the common case while maintaining backwards
254   >>> compatability! --[[Joey]]
255   >>>
256   >>>> Done in my `localurl` branch; not tested in a whole-wiki way
257   >>>> yet, but I did add a regression test. I've used
258   >>>> `urlto(x, undef)` rather than `urlto(x)` so far, but I could
259   >>>> go back through the codebase using the short form if you'd
260   >>>> prefer. --[[smcv]]
261   >>> 
262   >>> It does highlight that it would be better to have a
263   >>> `absolute_urlto($link)` (or maybe `absolute(urlto($link))` )
264   >>> rather than the 3 parameter form. --[[Joey]]
265   >>>
266   >>> Possibly. I haven't added this.
267
268 * `IkiWiki::baseurl` has a new second argument which works like the
269   third argument of `urlto`
270
271   > I assume you have no objection to this --[[smcv]]
272
273   >> It's so little used that I don't really care if it's a bit ugly.
274   >> (But I assume changes to `urlto` will follow through here anyway.)
275   >> --[[Joey]] 
276
277   >>> I had to use it a bit more, as a replacement for `$config{url}`
278   >>> when doing things like referencing stylesheets or redirecting to
279   >>> the top of the wiki.
280   >>>
281   >>> I ended up redoing this without the extra parameter. Previously,
282   >>> `baseurl(undef)` was the absolute URL; now, `baseurl(undef)` is
283   >>> the local path. I know you objected to me using `baseurl()` in
284   >>> an earlier branch, because `baseurl().$x` looks confusingly
285   >>> similar to `baseurl($x)` but has totally different semantics;
286   >>> I've generally written it `baseurl(undef)` now, to be more
287   >>> explicit. --[[smcv]]
288
289 * `IkiWiki::cgiurl` uses `$local_cgiurl` if passed `local_cgiurl => 1`
290
291   > Now changed to always use the `$local_cgiurl`. --[[smcv]]
292
293 * `IkiWiki::cgiurl` omits the trailing `?` if given no named parameters
294   except `cgiurl` and/or `local_cgiurl`
295
296   > I assume you have no objection to this --[[smcv]]
297   > 
298   >> Nod, although I don't know of a use case. --[[Joey]]
299
300   >>> The use-case is that I can replace `$config{cgiurl}` with
301   >>> `IkiWiki::cgiurl()` for things like the action attribute of
302   >>> forms. --[[smcv]]
303
304 Fixed bugs:
305
306 * I don't think anything except `openid` calls `cgiurl` without also
307   passing in `local_cgiurl => 1`, so perhaps that should be the default;
308   `openid` uses the `cgiurl` named parameter anyway, so there doesn't even
309   necessarily need to be a way to force absolute URLs? Any other module
310   that really needs an absolute URL could use
311   `cgiurl(cgiurl => $config{cgiurl}, ...)`,
312   although that does look a bit strange
313
314   > I agree that makes sense. --[[Joey]]
315
316   >> I'm not completely sure whether you're agreeing with "perhaps do this"
317   >> or "that looks too strange", so please disambiguate:
318   >> would you accept a patch that makes `cgiurl` default to a local
319   >> (starts-with-`/`) result? If you would, that'd reduce the diff. --[[smcv]]
320
321   >>> Yes, I absolutely think it should default to local. (Note that
322   >>> if `absolute()` were implemented as suggested above, it could also
323   >>> be used with cgiurl if necessary.) --[[Joey]]
324
325   >>>> Done (minus `absolute()`). --[[smcv]]
326
327 Potential future things:
328
329 * It occurs to me that `IkiWiki::cgiurl` could probably benefit from being
330   exported? Perhaps also `IkiWiki::baseurl`?
331
332   > Possibly, see [[firm_up_plugin_interface]]. --[[Joey]]
333
334   >> Not really part of this branch, though, so wontfix (unless you ask me
335   >> to do so). --[[smcv]]
336
337 * Or, to reduce use of the unexported `baseurl` function, it might make
338   sense to give `urlto` a special case that references the root of the wiki,
339   with a trailing slash ready to append stuff: perhaps `urlto('/')`,
340   with usage like this?
341
342         do_something(baseurl => urlto('/', undef, local)`);
343         do_something_else(urlto('/').'style.css');
344         IkiWiki::redirect(urlto('/', undef, 1));
345
346   > AFACIS, `baseurl` is only called in 3 places so I don't think that's
347   > needed. --[[Joey]] 
348
349   >> OK, wontfix. For what it's worth, my branch has 6 uses in IkiWiki
350   >> core code (IkiWiki, CGI, Render and the pseudo-core part of editpage)
351   >> and 5 in plugins, since I used it for things like redirection back
352   >> to the top of the wiki --[[smcv]]
353
354 merged|done --[[Joey]] (But reopened, see above.)
355
356 ----
357
358 Update: I had to revert part of 296e5cb2fd3690e998b3824d54d317933c595873,
359 since it broke openid logins. The openid object requires a complete,
360 not a relative cgiurl. I'm not sure if my changing that back to using
361 `$config{cgiurl}` will force users back to eg, the non-https version of a
362 site when logging in via openid.
363
364 > Ok, changed it to use `CGI->url` to get the current absolute cgi url. --[[Joey]]