ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / todo / fileupload / soc-proposal.mdwn
1 # SoC Proposal for Implementation of a File Upload Interface
2
3 I intend to extend Ikiwiki such that it accepts file uploads, subject to access
4 control, and integrates said uploads with the interface. What
5 follows is a **very rough draft** of my thoughts on the matter. Comments are
6 welcomed, either on the discussion page or via e-mail (_me_ at _inelegant.org_).
7
8 I suggest we adopt the Trac/Wikipedia concept of "attaching" files to a given
9 page. In this scenario, each page for which file upload has been enabled, will
10 sport an `<input type="file">` construct along with an _Attach_ button. Upon
11 successfully attaching a file, its name will be appended to an _"Attachments"_
12 list at the bottom of the page. The names in the list will link to the
13 appropriate files. Architecturally, this means that after a file has been attached to a page, the
14 page will have to be rebuilt. 
15
16 Files will be uploaded in a background thread via XMLHTTPRequest. This allows us to provide visual indicators of upload status, support multiple uploads at a time, and reduces the amount of template code we must write.
17
18 After an upload has been started, another text entry field will be rendered, enabling the user to commence a new upload.
19
20 ## Metadata
21
22 It is necessary to associate metadata with the uploaded file. The IkiWiki index file already associates rudimentary metadata with the files it renders, but there has been interest from multiple sources in creating a general purpose metadata layer for IkiWiki which supports the association of arbitrary metadata with a file. This work is outside the scope of the file upload feature, but I will attempt a basic implementation nevertheless.
23
24 A key decision involves the storage of the metadata. IkiWiki must be as usable from the CLI as from the web, so the data being stored must be easily manipulatable using standard command line tools. It is infeasible to expect users to embed arbitrary metadata in arbitrary files, so we will use a plaintext file consisting of name-value pairs for recording metadata. Each file in the IkiWiki source directory may have its own metadata file, but they are always optional. The metadata for a file, _F_, will be stored in a file named _F.meta_. For example, the metadata for this page would be in _todo/fileupload/soc-proposal.mdwn.meta_.
25
26 For instance: `cat "license: gpl\n" >> software.tar.gz.meta`. It would be trivial to distribute a tool with IkiWiki that made this even easier, too, e.g. `ikiwiki-meta license gpl software.tar.gz`. An open issue is how this metadata will be added from the web interface. 
27
28 For source files, this approach conflicts with the [_meta_ plugin](http://ikiwiki.info/plugins/meta/), so there needs to be some integration between the two.
29
30 In keeping with the current architecture of IkiWiki, we can make this metadata available to plugins by using a hash keyed on the filename, e.g. `$metadata{'software/software.tar.gz'}{'license'} eq 'gpl'`. 
31
32 In general, we will only use the _.meta_ files to store data that cannot be automatically determined from the file itself. For uploaded files this will be probably include the uploader's IP address, for example.
33
34 ## Configuration
35
36 In [[todo/fileupload]] it is specified that the upload feature must be highly
37 configurable. Joey suggests the use of the preferences page to specify some of these options, but it is not yet clear which ones are important enough to expose in this way. All options will be configurable via the config file.
38
39 We will (or do) support configuring:
40
41 * The allowable MIME types of uploaded files.
42 * The maximum size of the uploaded file.
43 * The maximum size of the upload temporary directory.
44 * The maximum size of the source directory.
45 * The IP addresses allowed to upload.
46 * The pages which can have files attached to them.
47 * The users who are allowed to upload.
48 * The users who are prohibited from uploading.
49
50 etc.
51
52 ## Operation
53
54 1. File upload forms will be rendered on all wiki pages which have been allowed
55 in the global configuration file. By default, this will probably be none of
56 them.
57 2. The forms will interface with _ikiwiki.cgi_, passing it the filename, the
58 file contents, and the name of the page to which it is being attached.
59 3. The CGI will consult the config file and any embedded pagespecs in turn, to
60 determine whether the access controls permit the upload. If they don't, an error
61 message will be displayed to the user, and the process will abort.
62 4. The uploaded file will be saved to a temporary upload directory.
63 5. Access controls which work on the entire file will be ran. The process will abort if they fail, or if the upload appears to have been aborted. Before the process is aborted, the file will be deleted from the temp directory.
64 6. The file is moved to the appropriate directory.
65 7. The _$file.meta_ file will be created and populated.
66 8. The uploaded file will be committed to the RCS.
67 9. _.ikiwiki/index_ will be modified to reflect the new upload (as above).
68 10. The page to which the file is attached (and any other
69 affected pages) will be regenerated.
70
71 --Ben