PrivateFiles plugin
( Installation code : kurtjensen.privatefiles ) Requires ( RainLab.User and KurtJensen.Passage )
Languages: DE, EN
This Plugin requires these additional plugins to function:
PrivateFiles plugin allows back-end users to upload files and share them with front-end users based on permission settings for their user group. Great for clubs, unions or other community type organizations to store and share policies, meeting minutes, or other documents just for their registered users.
All files are stored in a protected directory and routed to users only if there permissions permit. Each file can have it's own permission setting.
- You can mark a file "Not Protected" so that anyone can access it.
- You may assign a file to a group of users.
- You may assign a file to a single logged in user. ( NEW )
- Files are named after upload.
- They are displayed with your own description.
- Automatically calculated file size is displayed.
- Files show author name and the number of times the file has been downloaded.
- Download activity is logged with the user and time-stamp information.
- Easily send email invitations and reminders to users who have not accessed file yet.
- Uploader component allows uploading by logged in front-end users (again based on permissions ).
Files In Folder Component Displays files in virtual folders making it easy to locate files by grouping them on the front pages.
Other features considered on request.
The following plugins are required
User
Front-end user management.
User
Front-end user management.
Passage Permission and Roles System
Fast, Efficient permissions and roles system for your site pages and resources.
Passage Permission and Roles System
Fast, Efficient permissions and roles system for your site pages and resources.
PrivateFiles plugin
( Installation code : kurtjensen.privatefiles ) Requires ( RainLab.User and KurtJensen.Passage )
This Plugin requires these additional plugins to function:
PrivateFiles plugin allows back-end users to upload files and share them with front-end users based on permission settings for their user group. Great for clubs, unions or other community type organizations to store and share policies, meeting minutes, or other documents just for their registered users.
All files are stored in a protected directory and routed to users only if there permissions permit. Each file can have it's own permission setting.
- You can mark a file "Not Protected" so that anyone can access it.
- Files are named after upload.
- They are displayed with your own description.
- Automatically calculated file size is displayed.
- Files show author name and the number of times the file has been downloaded.
Basic Steps
Install
- Download plugin to plugin directory.
- Logout and back into october backend.
- Goto Settings and choose Private Files in the side menu.
- Set the default permision that you want for each file you create. You can change this when you add or edit the file.
Group Permissions
- You will want to setup user groups and permission for user groups who will download the files. This is done in the Users section of the Backend.
- !Important - Groups need to have the permission "download" in order to actually download a protected file despite the permission chosen for the individual file. If this permission is not set user will receive message "Downloads permission not set for current user." when attempting to download any protected file.
Add Files
- Choose Private Files in backend menu.
- Click New Download button to start uploading files.
Create Page for File Output
-
Next you will want to create a special page and add PrivateFiles Download Component to the page.
- DO NOT add a layout.
- Set the URL for this page and end the URL with "/:slug" to tell component what file to grab. Example: "/download/output/:slug"
This page will serve as the output page for downloadable files.
Create Page for Display
- Next you will want to create a page and add _PrivateFiles Download Component to the page. Configure your layout but do not add a :slug to the URL.
- Set the component "Download Page" property to match the output page you just created
Create Page for Front End Uploading ( Optional )
- You may want to create a page and add _PrivateFiles Uploader Component to the page. Configure your layout but and add a :slug to the URL.
- Set the component properties listed as you see fit.
Troubleshooting
File uploads can be tricky with PHP.
Here are a few setting to check in php.ini :
- post_max_size
- upload_max_filesize
- upload_tmp_dir
See: https://mediatemple.net/community/products/dv/204404784/how-do-i-increase-the-php-upload-limits for more info.
Like this plugin?
If you like this plugin or if you use some of my plugins, you can help me by submiting a review in the market. Small donations also help keep me motivated.
Please do not hesitate to find me in the IRC channel or contact me for assistance. Sincerely Kurt Jensen
-
Pavel Andrei
Found the plugin useful on 19 May, 2023
This product is great. We use it for some years now but at this moment we need a new functionalty. It's a basic one and we need some hints if possible on how to get it done and implemented.
We need to have the posibility to export the Logs/file listind under: kurtjensen/privatefiles/logs/filereport in any format like..XLS, CSV, PDF..any type format would be great, just to have this Download Report / file function.
Thank you in advance everyone.
-
Dan Hinman
Found the plugin useful on 1 May, 2017
Ran into some issues with the plugin. Kurt took the time to set up a chat session and diagnose the problem. The end result was a user issue and nothing to do with the plugin. But he took the time, without pause, to help when he could. That makes this plugin worth so much more. Thank you.
-
Fabio Cidral
Found the plugin not useful on 14 Feb, 2017
There is a lot bugs not solved.
-
Kurt Jensen author
Replied on 14 Feb, 2017
Thank you for the review. Please report any bugs / issues that you have with this plugin and I will be greatful and happy to resolve them.
At the time of your review I see only 1 outstanding bug / issue not resolved. It is now fixed in 1.1.8.
-
Mathias Kessler
Found the plugin useful on 4 Feb, 2017
Plugin works like I imagined it, but I would be much better if you would use a container-fluid on the Download Component for better stylability.
-
Kurt Jensen author
Replied on 1 Dec, 2017
Thank you for your review. Please feel free to contact me directly through my author page so we we can work out any changes you would like to see to improve this product.
[https://octobercms.com/author/KurtJensen] -
Tim
Found the plugin useful on 11 Nov, 2016
Plugin works perfect, easy to configure and great support! Recommended
-
| 1.2.4 |
Updated for new OctoberCMS Jun 19, 2022 |
|---|---|
| 1.2.3 |
Prevents sending email to potential users of group 0. Sep 08, 2020 |
| 1.2.2 |
Updates email notifications to work for single assigned user. Sep 08, 2020 |
| 1.2.1 |
Adds ability to assign file permission to a single user from backend controller form. Sep 04, 2020 |
| 1.2.0 |
Adds ability to assign file pemission to a single user. Sep 04, 2020 |
| 1.1.24 |
Adds link target for Folder Tree component. Jun 08, 2020 |
| 1.1.23 |
Fixes count error from thumbnail check. Adds link target for downloads components. May 30, 2020 |
| 1.1.22 |
Make Folders Nestable. Aug 07, 2019 |
| 1.1.21 |
Fixes line 14 Undefined variable error in change_permission_nulable.php Jun 16, 2019 |
| 1.1.20 |
Add search by description option and made search sticky to session. Jun 05, 2019 |
| 1.1.19 |
!!! This is an important update that contains breaking changes. You must set the "Download Page" property for the Download component for listing page. See Upgrade guide. Feb 01, 2019 |
| 1.1.18 |
Added default sorting field and direction. Mar 05, 2018 |
| 1.1.17 |
Improved sorting,language strings, cleaned up filetype setting and added thumbnails. Mar 04, 2018 |
| 1.1.16 |
!!! This is an important update that contains breaking changes. You must create a new page in CMS with URL "/pdown/:slug?". See Upgrade guide. Feb 02, 2018 |
| 1.1.15 |
Styling and sorting improvements in Backend. Dec 01, 2017 |
| 1.1.14 |
Updated to changes made in Passage Permission Plugin up to version 1.0.12 Nov 22, 2017 |
| 1.1.13 |
Update Download route to L5.5 std. Jul 30, 2017 |
| 1.1.12 |
Fixes where is_protected=null not showing up in downloads. May 03, 2017 |
| 1.1.11 |
Add translation to errors. Delete now removes attached file from storage. Apr 20, 2017 |
| 1.1.10 |
Add no-user warning to uploader. Apr 20, 2017 |
| 1.1.9 |
Change permission column to nulable. Feb 15, 2017 |
| 1.1.8 |
Fixes 1366 Incorrect integer value for column 'user_id' Connection.php line 662 Feb 14, 2017 |
| 1.1.7 |
Fixes Folder class already in use exception. Jan 07, 2017 |
| 1.1.6 |
Fixes Download.php line 127 non object exception and adds new upload component. Jan 06, 2017 |
| 1.1.5 |
Fixes Download.php line 132 property of non-object Nov 21, 2016 |
| 1.1.4 |
Fixes a few errors ( Thanks Tim Förster ) Nov 14, 2016 |
| 1.1.3 |
Adds de language file ( by Tim Förster ) Nov 13, 2016 |
| 1.1.2 |
Added Activity log. Updated all timestamp columns to be nullable. Nov 13, 2016 |
| 1.1.1 |
Created EN translation file and updated plugin to support language files Oct 23, 2016 |
| 1.0.15 |
Updated to changes made in Passage Permission Plugin Oct 04, 2016 |
| 1.0.14 |
Added Backend Settings Permissions Feb 23, 2016 |
| 1.0.13 |
Added messageURL() to enable Author Notices Feb 14, 2016 |
| 1.0.12 |
!!! This is an important update that contains breaking changes. Private Files will now be using PassagePermission Keys for permissions and you will need to install the plugin using code "kurtjensen.passage". If you do not install Passage Permission Keys plugin then Private Files plugin will be disabled until you do. Feb 05, 2016 |
| 1.0.11 |
Minor fix to change filename on download Oct 29, 2015 |
| 1.0.10 |
Fixed breaking changes from Rainlab Attach/File.php Oct 29, 2015 |
| 1.0.9 |
Add folder column. Apr 30, 2015 |
| 1.0.8 |
Built Folders Tables and seed it Apr 30, 2015 |
| 1.0.7 |
Fixed broken download caused by other changes in RC Mar 15, 2015 |
| 1.0.6 |
Updated to be RC compatible Mar 10, 2015 |
| 1.0.5 |
Removed test route and function from plugin. Feb 10, 2015 |
| 1.0.4 |
Fixed Error when user has no available permissions. Jan 25, 2015 |
| 1.0.3 |
Add category column for future categorization of files. Dec 30, 2014 |
| 1.0.2 |
Built Tables Dec 26, 2014 |
| 1.0.1 |
First version of PrivateFiles Dec 26, 2014 |
Upgrade guide
<a name="upgrade-1.1.19"></a>
Upgrading To 1.1.19
This is an important update that contains breaking changes.
The Download component now has the flexibility for you to name the output page however you want. Since this is now an option, you must set the property in any current listing pages so that the URL will point to the output page.
<a name="upgrade-1.1.16"></a>
Upgrading To 1.1.16
This is an important update that contains breaking changes.
This change was required because user permissions are not available using the old output method since the recent October updates.
You must now create a new page in CMS with URL "/pdown/:slug".
The new page should:
- have no layout
- contain Download component.
- Slug for Download ID should be used in URL as shown above.
This new page will serve as the file output page for all downloadable files.
<a name="upgrade-1.0.12"></a>
Upgrading To 1.0.12
This is an important update that contains breaking changes.
Private Files will now be using Passage Permission Keys plugin for permissions.
You will need to install that plugin using code "kurtjensen.passage".
You should follow directions in Passage Permission Keys plugin to transfer your permissions over from the Roles plugin. No other changes should be needed for existing Private Files data to work as long as the "id" of the permissions in Passage Permission Keys matches the "id" old of the permissions in Roles.
If you do not install Passage Permission Keys plugin then Private Files plugin will be disabled until you do.
This change was due to some unresolved issues in the Roles plugin that made it unreliable and out of our control to fix.
DO NOT UPGRADE TO 1.0.12 UNLESS YOU ARE GOING TO INSTALL Passage Permission Keys PLUGIN.