attachment: Add admin() pagespec to test if the uploading user is a wiki admin.
[ikiwiki.git] / doc / ikiwiki / pagespec / attachment.mdwn
1 [[!meta robots="noindex, follow"]]
2 [[!if test="enabled(attachment)"
3      then="This wiki has attachments **enabled**."
4      else="This wiki has attachments **disabled**."]]
5
6 If attachments are enabled, the wiki admin can control what types of
7 attachments will be accepted, via the `allowed_attachments`
8 configuration setting.
9
10 For example, to limit arbitrary files to 50 kilobytes, but allow
11 larger mp3 files to be uploaded by joey into a specific directory, and
12 check all attachments for virii, something like this could be used:
13   
14         virusfree() and ((user(joey) and podcast/*.mp3 and mimetype(audio/mpeg) and maxsize(15mb)) or (!ispage() and maxsize(50kb)))
15
16 The regular [[ikiwiki/PageSpec]] syntax is expanded with the following
17 additional tests:
18
19 * maxsize(size)
20
21   Tests whether the attachment is no larger than the specified size.
22   The size defaults to being in bytes, but "kb", "mb", "gb" etc can be
23   used to specify the units.
24   
25 * minsize(size)
26
27   Tests whether the attachment is no smaller than the specified size.
28
29 * ispage()
30
31   Tests whether the attachment will be treated by ikiwiki as a wiki page.
32   (Ie, if it has an extension of ".mdwn", or of any other enabled page
33   format).
34
35   So, if you don't want to allow wiki pages to be uploaded as attachments,
36   use `!ispage()` ; if you only want to allow wiki pages to be uploaded
37   as attachments, use `ispage()`.
38
39 * user(username)
40
41   Tests whether the attachment is being uploaded by a user with the
42   specified username. If openid is enabled, an openid can also be put here.
43
44 * adminuser()
45
46   Tests whether the attachment is being uploded by one of the wiki admins.
47
48 * ip(address)
49
50   Tests whether the attacment is being uploaded from the specified IP
51   address.
52
53 * mimetype(foo/bar)
54
55   This checks the MIME type of the attachment. You can include a glob
56   in the type, for example `mimetype(image/*)`.
57
58 * virusfree()
59
60   Checks the attachment with an antiviral program.