Changes between Version 43 and Version 44 of TracDownloaderPlugin


Ignore:
Timestamp:
Dec 1, 2015, 9:11:19 AM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • TracDownloaderPlugin

    v43 v44  
    1 = Trac Downloader plug-in
     1[[PageOutline(2-5,Contents,pullout)]]
     2
     3= Trac Downloader plugin
    24
    35== Description
    46
    5 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 plug-in.
     7Project 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.
    68
    79See also DownloadsPlugin.
    810
    911'''Screenshots:'''
    10  * [attachment:04_downloads.png view on main list of downloads]
    11  * [attachment:08_questionnaire.png questionnaire with captha to get information about user who downloads]
    12  * [attachment:01_files_admin.png administration of files for download]
    13  * [attachment:03_stats_admin.png administration of statistics and questionnaire fill up's]
    14  * [attachment:06_year_stats.png statistics of downloads by years]
    15  * [attachment:05_month_stats.png statistics of downloads by months]
    16  * [attachment:07_file_stats.png statistics of files (releases and categories has this too)]
     12 * [attachment:04_downloads.png View on Main list of downloads]
     13 * [attachment:08_questionnaire.png Questionnaire with captha to get information about user who downloads]
     14 * [attachment:01_files_admin.png Administration of files for download]
     15 * [attachment:03_stats_admin.png Administration of statistics and questionnaire fill up's]
     16 * [attachment:06_year_stats.png Statistics of downloads by years]
     17 * [attachment:05_month_stats.png Statistics of downloads by months]
     18 * [attachment:07_file_stats.png Statistics of files (releases and categories has this too)]
     19
     20Plugin 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.
    1721
    1822== Planned features and improvements
    1923
    20  * rewrite all templates from !ClearSilver to Genshi
    21  * display and request captcha only first time in session
    22  * nicer rendering of forms and fix some rendering problems
    23  * support for searching in files and notes
    24  * support for Tags
    25  * some aggregations of data filled in user defined questionnaire
     24 * Rewrite all templates from !ClearSilver to Genshi
     25 * Display and request captcha only first time in session
     26 * Nicer rendering of forms and fix some rendering problems
     27 * Support for searching in files and notes
     28 * Support for Tags
     29 * Some aggregations of data filled in user defined questionnaire
    2630
    2731== Bugs/Feature Requests
    2832
    29 Plug-in was tested on Python 2.3 - Trac 0.9.6 and Trac 0.10.4, '''first successful tests were made on Trac 0.11b1! ''' But be patient if there are still some bugs and report every problem you find.
    30 
    3133Existing bugs and feature requests for TracDownloaderPlugin are
    32 [query:status!=closed&component=TracDownloaderPlugin&order=priority here].
     34[report:9?COMPONENT=TracDownloaderPlugin here].
    3335
    3436If you have any issues, create a
    35 [http://trac-hacks.org/newticket?component=TracDownloaderPlugin&owner=peca new ticket].
     37[/newticket?component=TracDownloaderPlugin new ticket].
    3638
    3739[[TicketQuery(component=TracDownloaderPlugin,group=type,format=progress)]]
    … …  
    3941== Download
    4042
    41 If you don't like Subversion you can download egg or full source here:
    42 [[BR]][http://data.pevnosti.cz/tracdownloader/TracDownloader-0.1-trac-0.11.egg TracDownloader-0.1-trac-0.11.egg]
    43 [[BR]][http://data.pevnosti.cz/tracdownloader/TracDownloader-0.1-trac-0.11.zip TracDownloader-0.1-trac-0.11.zip]
    44 [[BR]][http://data.pevnosti.cz/tracdownloader/TracDownloader-0.1-trac-0.10.egg TracDownloader-0.1-trac-0.10.egg]
    45 [[BR]][http://data.pevnosti.cz/tracdownloader/TracDownloader-0.1-trac-0.10.zip TracDownloader-0.1-trac-0.10.zip]
    46 [[BR]][http://data.pevnosti.cz/tracdownloader/TracDownloader-0.1-trac-0.9.egg TracDownloader-0.1-trac-0.9.egg]
    47 [[BR]][http://data.pevnosti.cz/tracdownloader/TracDownloader-0.1-trac-0.9.zip TracDownloader-0.1-trac-0.9.zip]
     43If you don't like Subversion you can download the egg or the full source here:
     44 * [http://data.pevnosti.cz/tracdownloader/TracDownloader-0.1-trac-0.11.egg TracDownloader-0.1-trac-0.11.egg]
     45 * [http://data.pevnosti.cz/tracdownloader/TracDownloader-0.1-trac-0.11.zip TracDownloader-0.1-trac-0.11.zip]
     46 * [http://data.pevnosti.cz/tracdownloader/TracDownloader-0.1-trac-0.10.egg TracDownloader-0.1-trac-0.10.egg]
     47 * [http://data.pevnosti.cz/tracdownloader/TracDownloader-0.1-trac-0.10.zip TracDownloader-0.1-trac-0.10.zip]
     48 * [http://data.pevnosti.cz/tracdownloader/TracDownloader-0.1-trac-0.9.egg TracDownloader-0.1-trac-0.9.egg]
     49 * [http://data.pevnosti.cz/tracdownloader/TracDownloader-0.1-trac-0.9.zip TracDownloader-0.1-trac-0.9.zip]
    4850
    4951Here are [http://data.pevnosti.cz/tracdownloader/ some screenshots] too.
    5052
    51 Download the zipped source for [download:tracdownloaderplugin/0.9 Trac 0.9], [download:tracdownloaderplugin/0.10 Trac 0.10], [download:tracdownloaderplugin/0.11 Trac 0.11] or [download:tracdownloaderplugin just everything].
     53Download the zipped source for [export:tracdownloaderplugin/0.9 Trac 0.9], [export:tracdownloaderplugin/0.10 Trac 0.10], [export:tracdownloaderplugin/0.11 Trac 0.11] or [export:tracdownloaderplugin just everything].
    5254
    5355== Source
    5456
    55 You can check out TracDownloaderPlugin from [http://trac-hacks.org/svn/tracdownloaderplugin here] using Subversion, or [source:tracdownloaderplugin browse the source] with Trac.
     57You can check out TracDownloaderPlugin from [/svn/tracdownloaderplugin here] using Subversion, or [source:tracdownloaderplugin browse the source] with Trac.
    5658
    5759== Installation
    … …  
    5961'''Using Python egg'''
    6062
    61 The easiest way to start using Downloader plug-in is to get downloaded python egg into plugin directory of 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 (Downloader is dependent on WebAdmin plug-in). And finally there is need to get some permissions of Downloader to some users. In this case if you like to use !PyCaptcha, you must take care of installing it by yourself, !PyCaptcha is dependent on PIL so you must download it too.
     63The 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.
    6264
    63 '''Using source''' - installation with !PyCaptcha and Python Imaging Library (PIL) which are needed for Captcha to work:
     65'''Using source''' - installation with !PyCaptcha and PIL which are needed for Captcha to work:
    6466
    65 {{{
    66 #!sh
     67{{{#!sh
    6768easy_install --find-links http://www.pythonware.com/products/pil/ Imaging
    6869easy_install PyCaptcha
    69 easy_install http://trac-hacks.org/svn/tracdownloaderplugin/0.10/
     70easy_install https://trac-hacks.org/svn/tracdownloaderplugin/0.10/
    7071}}}
    7172
    72 '''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).
     73'''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).
    7374
    74 Then you must enable both Downloader modules in !TracAdmin/Plugins (or enable Downoader components in your envronment's ini file - source bottom) and assign some permissions of downloader to someone and you can start trying Downloader plug-in:
     75Then 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:
    7576
    76 {{{
    77 #!ini
     77{{{#!ini
    7878[components]
    7979tracdownloader.admin.downloaderadminpage = enabled
    … …  
    8181}}}
    8282
    83 After 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's best to restart your http server.
     83After 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.
    8484
    8585Downloader 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.'''
    … …  
    8989== Permissions
    9090
    91 Downloader plug-in defines the following permissions:
     91Downloader plugin defines the following permissions:
    9292
    93 `DOWNLOADER_DOWNLOAD`: lets user to download things from main part of plug-in, if you like to let all users download from donwloader, just get this permission to user anonymous.
     93`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.
    9494`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).
    95 `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 plug-in. Note that this permission should never be given to user anonymous!
     95`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!
    9696
    9797== Wiki syntax
    9898
    99 Downloader plug-in provides three types of wiki syntax for referencing of standalone files, whole releases or categories. Each syntax have 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).
     99Downloader 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).
    100100
    101101'''Syntaxes:'''
    … …  
    112112}}}
    113113
    114 If item of that id doesn't exist, there's diplayed only link to nowhere with title "id not found". If file was deleted, it still displays its correct name, but does not link to anywhere.
     114If 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.
    115115
    116116== Special features
    117117
    118 This features are available only if you have Downloader installed in unzipped form (doesn't work in egg or zip file).
     118This features are available only if you have Downloader installed in unzipped form. This doesn't work in egg or zip file.
    119119
    120120'''MIME list'''
    121 In tracdownloader directroy 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.
     121In 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.
    122122
    123123'''EDIT QUESTIONNAIRE'''
    124 The file form_data.py contains structure used to generate questionnaire before download of file. You can easily edit this to get from users the data you exactly want. There is big description inside of this file.
     124The 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.
    125125
    126126== Reset all statistics
    127127
    128128To 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.
    129 {{{
     129{{{#!sql
    130130DELETE FROM downloader_downloaded_attributes;
    131131DELETE FROM downloader_downloaded;