wiki:TracDownloaderPlugin

Trac Downloader plugin

Description

Project release downloader plugin for Trac system with optional questionnaire before download of file, Captcha antirobot check, stats module and easy to use administration in Trac WebAdmin plugin.

See also DownloadsPlugin.

Screenshots:

Plugin was tested on Python 2.3, Trac 0.9.6 and Trac 0.10.4. The first successful tests were made on Trac 0.11b1. But note that there may still be some bugs and please report every problem you find.

Planned features and improvements

  • Rewrite all templates from ClearSilver to Genshi
  • Display and request captcha only first time in session
  • Nicer rendering of forms and fix some rendering problems
  • Support for searching in files and notes
  • Support for Tags
  • Some aggregations of data filled in user defined questionnaire

Bugs/Feature Requests

Existing bugs and feature requests for TracDownloaderPlugin are here.

If you have any issues, create a new ticket.

defect

36 / 48

enhancement

3 / 10

task

1 / 1

Download

If you don't like Subversion you can download the egg or the full source here:

Here are some screenshots too.

Download the zipped source for Trac 0.9, Trac 0.10, Trac 0.11 or just everything.

Source

You can check out TracDownloaderPlugin from here using Subversion, or browse the source with Trac.

Installation

Using Python egg

The easiest way to start using the Downloader plugin is to get download the Python egg into the plugin directory of your project environment (egg is most probably Python version independent, just rename it, there is still the source package). After that you must turn both modules of Downloader on in WebAdmin/plugins: the Downloader is dependent on WebAdmin plugin. And finally you need to get apply the permissions of Downloader to the users. In this case if you like to use PyCaptcha, you must install it yourself, PyCaptcha is dependent on Python Imaging Library (PIL) so you must download it too.

Using source - installation with PyCaptcha and PIL which are needed for Captcha to work:

easy_install --find-links http://www.pythonware.com/products/pil/ Imaging
easy_install PyCaptcha
easy_install https://trac-hacks.org/svn/tracdownloaderplugin/0.10/

Second and maybe better way is to download and unpack somewhere source zip package and then just run "setup.py install" (or on Windows maybe better "python setup.py install") or you can just use easy_install commands written above. Setup should take care of all dependences (PyCaptcha and PIL but it could get some errors while dowloading them so if automatic dependency resolution doesn't work use code above) and prepare plugin to be turned on in WebAdmin/plugins. Setup just installs TracDownloaderPlugin. If you like to use Captcha tests you have to install PIL and PyCaptcha manually either (note that PIL is in most Linux distributions package named python-imaging so you don't need to install it by easy install but you can use your package manager).

Then you must enable both Downloader modules in TracAdmin/Plugins (or enable Downoader components in your envronment's trac.ini file - source bottom) and assign some permissions of downloader to someone and you can start trying Downloader plugin:

[components]
tracdownloader.admin.downloaderadminpage = enabled
tracdownloader.web_ui.downloadermodule = enabled

After the steps above and clicking to any part of Downloader you should be asked about location of directory to store uploaded files. When it is set up, you must Submit that form two times and there can occur exception "DatabaseError: database schema has changed". If this exception is thrown, it is best to restart your http server.

Downloader keeps using ClearSilver as templating system so you have to have it installed (version for new templating system Genshi will be written soon). Version for Trac 0.11 wasn't too much tested so if you find errors, please write me a ticket.

If you had problems installing Downloader, please write me a ticket or write solution of your installation problems here.

Permissions

Downloader plugin defines the following permissions:

DOWNLOADER_DOWNLOAD: lets user to download things from main part of plugin, if you like to let all users download from donwloader, just get this permission to user anonymous. DOWNLOADER_STATS: lets user to browse part of statistics in the main module of Downloader (user will be able to see links to statistics in the right top corner of the page). DOWNLOADER_ADMIN: lets user to upload files, manage files, releases and categories, browse fill up's of questionnaire, delete fill up's of questionnaire and manage settings of Downloader plugin. Note that this permission should never be given to user anonymous!

Wiki syntax

Downloader plugin provides three types of wiki syntax for referencing of standalone files, whole releases or categories. Each syntax has two possible forms. If syntax is enclosed by [] you can easily write your own title for item (file, release, category). If the syntax is separated just by spaces, there will be automatically created link with name of referenced item (file, release, category).

Syntaxes:

downloader:5 - Creates link to file with id 5 with it's name
[downloader:5 click here] - Creates 'click here' link to file with id 5

downloaderrel:23 - Creates link to release with id 23 with it's name
[downloaderrel:23 click here] - Creates 'click here' link to release with id 23

downloadercat:43 - Creates link to category with id 43 with it's name
[downloadercat:43 click here] - Creates 'click here' link to category with id 43

If item of that id doesn't exist, there is diplayed a dead link with title "id not found". If the file was deleted, it still displays its correct name, but does not link to anywhere.

Special features

This features are available only if you have Downloader installed in unzipped form. This doesn't work in egg or zip file.

MIME list In tracdownloader directory there is a file mime_list.txt which contains list of known MIME types for downloader, you can easily add new ones or delete unneeded, if there is no record found for particular file extension in this list, Downloader uses MIME of application/octet-stream.

EDIT QUESTIONNAIRE The file form_data.py contains the structure used to generate questionnaire before the download of the file. You can easily edit this to get from users the data you want. There is big description inside of this file.

Reset all statistics

To clear all recorded data about downloads and users who downloaded anything by DownloaderPlugin you can use on your Trac environment database these two SQL commands.

DELETE FROM downloader_downloaded_attributes;
DELETE FROM downloader_downloaded;

After this all statistics are gone.

Recent Changes

12139 by rjollos on 2012-10-10 03:54:13
Fixed incorrect source code encoding (http://www.python.org/dev/peps/pep-0263/).
11235 by rjollos on 2012-02-02 23:12:33
Refs #4299: Fixed setup.py syntax error for the 0.10 branch. The 0.10 branch won't be supported. This fix is untested.
11234 by rjollos on 2012-02-02 22:14:57
Fixes #5540: Fixed encoding error in defining the navigation item for the INavigationContributor interface.
(more)

Author/Contributors

Author: Petr Škoda
Maintainer: Petr Škoda
Contributors:

Last modified 7 months ago Last modified on Dec 1, 2015, 10:11:19 AM

Attachments (8)

Download all attachments as: .zip