Client File Manager 6.03
|
|
Please read the Perl Services Licensing Agreement
By downloading, purchasing, acquiring and/or implementing any PerlServices software, you agree to be bound by the terms and conditions of the distribution policy.
To Top
List of Screen Shots
To Top
Introduction
Thank you for choosing Client File Manager. This program is also popularly called Upload File Manager.
This program was first written in 1998 and has been evolving over the years as part of custom CGI applications. This program was first released as a publicly available CGI application in December 2001.
Client File Manager allows you to setup multiple user accounts for the delivery and storeage of files. Each individual user has complete control over all of thier files, including the ability to delete them, rename them and store specific notes/instructions attached to the file. Client File Manager has a series of add-on modules that extend the functionality and abilities of this program to meet almost any users needs. As usual, this program can be customized to meet your web sites exact needs and requirements.
To Top
Requirements
Client File Manager must be used on a UNIX server with Perl 5 or higher. You must also confirm that your server supports dynamic uploads (uploads through an HTML form).
Some servers do not permit dynamic uploads. Some servers place size limitations on the size of files that can be uploaded. While this program has been successfully used with files over 21Mb in size, the program will be limited by any restrictions the server has in place. It is your responsibility to confirm that dynamic uploads are permitted by your server prior to purchasing this program.
To Top
Configuration
Before you can install this program, there are a few configuration items you must first address.
Path To Perl
All CGI programs written in Perl must start with a line that tells the web server where to look for the Perl interpreter. This means the very first line of each of the .cgi or .pl files MUST be the path to Perl. Here are some examples of common paths to Perl:
#!/usr/bin/perl
#!/usr/bin/perl5
#!/usr/lib/perl
#!/usr/local/bin/perl
This program was shipped with a default path of: #!/usr/local/bin/perl
The first configuration item to address is to make sure that this is the correct Path to Perl for your web server. Your Virtual Hosts support/FAQ pages will tell you what the correct Path to Perl is for your web server. If this information can not be found on the support/FAQ pages then you should contact your System Administrator or Support Dept. to find out the correct value. In lieu of them being available, the samples above are fairly standard. Try them all out in the order above and see if any work for you.
Data Key
Next, use your text editor to open the file "cfm_cfg.lib". Just below the header, there is one variable called $DataKey. You must set this variable to a completely random sequence of numbers and letters, upper case or lower case is fine but do NOT use any punctuation characters. Setting this $DataKey is a required step and it plugs a security hole that is present in all standardized, distributed CGI programs. There is an explanation of this accompanying the variable, please read the explanation and set the key now. Remember that it must be exactly ten characters long. If there is a problem with the Data Key that you set, the program will not set-up properly and you will be prompted to correct it.
On most servers, this should be the end of any configuration changes you have to set in the script. Please note that you do not have to set any more variables in the cfm_cfg.lib, cfm_admin.cgi, cfm_admin.lib, cfm_setup.cgi, client_upload.cgi or the Perl modules that shipped with
the program, unless the program specifically tells you to.
This program uses our advanced set-up routine, which will create all it's own directories and set it's own permissions on data directories. If the program encounters a problem during the set-up process, you will be given specific directions on what to do. If the instructions given don't allow you to successfully install the program or you are not comfortable following the instructions, contact us through the Perl Services support page at:
/support.html
Please note that unless the program tells you otherwise, you do not have to create or set permissions on any directories.
To Top
Installation
To install this program, you must have an FTP client and be familiar with how to use its basic functions. If your not sure how to achieve any of the stated functions or commands with your FTP client, please refer to our tutorial on installation and on using FTP clients at:
http://www.perlservices.net/perlfaqs/index.html
Having set the path to Perl and the $Data Key, it's time to install the program.
Here are the installation steps:
1. Open your FTP client and connect to your web space.
2. In your cgi-bin (some call it just "cgi") create a sub-directory with any legal name that you want (i.e. "clients").
3. CHMOD this sub-directory to 755 (rwx-rx-rx).
4. Change into this sub-directory with your FTP client.
5. Making sure your FTP client is set to transfer in ASCII mode and not binary mode, transfer the files
cfm_cfg.lib, cfm_setup.cgi, cfm_admin.cgi, cfm_admin.lib, client_upload.cgi, MongerFile.pm and MongerTemplate.pm into the newly created sub-directory.
6. CHMOD each of the .cgi files to 755 (rwx-rx-rx). You should not have to CHMOD the .lib or .pm files
7. Close your FTP client.
8. Launch your web browser and in the address line of the browser, type the full URL to the cfm_setup.cgi script:
i.e. http://www.foo.com/cgi-bin/clients/cfm_setup.cgi
9. You should now see a set-up screen asking you to enter a User Name and Password (you have to enter the password twice). If you see this screen, it means the program has been configured correctly. Enter your new User Name and Password. Enter the Password a second time in the space provided. Submit the form.
10. If you made any mistakes along the way, you will get a warning message with instructions on what to do to correct the error. If you get an error that says the program could not set-up the password file, this means that the program is unable to access the data directory. If this was the first pass through the set-up screen, then there is a server specific configuration issue. Contact us at our support centre for assistance. If this is not the first pass through the set-up screen and you were asked to create some sub-directories, then the program and sever are not able to resolve the Root directory. In this case, you must do the following:
|
a. You must now create a directory on your server for the data files to be written to. Follow the instructions in the installation area above. This time however, the data directory must be outside of the cgi-bin and it must be CHMOD 777. b. Once you have done that, use your text editor (Notepad , Editpad or similar) to open the cfm_cfg.lib file. Just below the script header block you will see a variable like this: $DefaultData = ""; Set the absolute path to that directory in the above variable. It will look like: $DefaultData = "/usr/name/htdocs/some_data_directory"; c. Note that this variable does NOT end with a slash. d. Save the changes to the file then re-upload it to the same directory it was originally installed in on the server. e. Run the set-up routine again. If the problem persists, contact us at the Script Centre support forum for assistance.
Once you have received the screen that says "Set-up Successful" your program is installed, configured and ready to run. The first thing you should do is log into the admin program.
|
To Top
Un-Install
To un-install this program, use the built in un-install program to ensure that all data files and directories are removed along with all program files.
First, log into the admin program then click on "Un-Install" on the function bar. This will present you with the un-install confirmation screen. You must enter your username and password again on this page. Once done, click the button and the program and all data directories and files will be removed without further confirmation.
Please note that the sub-administrator can NOT un-install this program.
To Top
Administration Function Bar
After logging into the administration program, the top portion of the screen will contain the above administration function bar. You will use this to navigate the various options and functions that this administration program contains. Whenver this users guide refers to the "function bar", this is what we are refering to.
To Top
Login
Whenever you wish to use the Client File Manager administration program, you must first sign into the program. Enter the full URL to the cfm_admin.cgi script in the address line of your browser.
You will be presented with the login screen.
Enter your user name and password and click the button. At any time, you can change your password. After logging in, click the "Change Password" link at the top of the page. You will be taken to the form that allows you to change your password. Enter your current user name and password then enter your new user name and password. You will have to enter the new password twice.
To Top
Exit
Whenever you are done working with the program or are going to be stepping away from your desk, we strongly urge you to logout by clicking the "Exit" link at the top of the page. Even if your working from home and stepping away from the desk, EXIT THE PROGRAM. It has been my experience that a curious six year old or a cat walking across the keyboard can wreck untold havoc on even the most careful users.
To Top
Admin Summary
When you sign into the administration program, you will be presented with the admin summary screen. This screen can also be reached at any time you are signed into the program by clicking on "List Users" on the function bar.
To Top
Change Password
Primary Administrator
You can change your administrative password at any time by clicking on "Change Password" on the top row of the function bar. To change your password, you need to enter five pieces of information on the Change Password screen. First, you must enter your current user name and password. This information is validated against current values just to make sure someone doesn't change the information if you walk away from your terminal.
The primary administrators password is labeld "Primary Administrator" and is on the left side of this screen.
To Top
Sub-Administrator Password
This program provides two levels of administrator. Both administrators have full access and privledges to functions with the exception of the following:
- The sub-administrator can not access of modify the configuration valuables on the "Options" page.
- The sub-administrator can not un-install the program.
When you first install the program, when you go to the "Change Password" page, you will see a form for the sub-administrator that only asks for a user name and password. Since the sub-administrator has not been set up, all you need to do is enter a user name and password (twice). Submitting this information will create the sub-administrator password.
The sub-administrator can log in at any time and change their password as often as they wish. Note that the sub-administrator will NOT see the Primary Administrator password change form.
The primary administrator can delete the sub-administrators access at any time by placing a check in the checkbox and submitting the form.
To Top
Managing Profiles
Adding a new user
To add a new user, click on the "List Users" link on the administration function bar.
Below the list of current users, you will see the "New User Addition Screen". Fill in the new users Name, E-mail, Company/Alias, Upload disk space limit, a User Name and as Password. The Company/Alias is what will show up for public users if you use the Public Drop Box or Public Download add-on modules. Click the "Add New User" button. The new users account is now active and ready to use.
To Top
Viewing a users profile
To view a users profile, click on the "List Users" link on the administration function bar.
The top of this page will list all registered users. Simply click on the registered users name to view their profile and all associated files.
If you are on the "List Files" page, you can also click on the users name to view their profile.
To Top
Editing a users profile
To edit a users profile, click on the "List Users" link on the administration function bar.
From the list of users at the top of the page, click on the "Edit" link on the same line as their name. This will take you to the edit screen where you can update their profile. There is a separate box on this page for updating the users password. Please note that you can NOT edit a users User Name once their profile has been added.
Additionally, there will be other options on the edit screen appear if you have one of the add-on modules installed with this program.
To Top
Purging a users files
To purge a users files, click on the "List Users" link on the administration function bar.
From the list of users at the top of the page, click on the "Purge" link. You will be asked to confirm your selection. Purging the users files removes ALL of their stored files along with all notes and permissions for those files. It is recommended you purge a users files before deleting the users profile to prevent any stranded documents from interfering with the profile deletion.
Please note that purging a users profile is a permanent and irreversible course of action. Once you click the OK button on the confirmation you can NOT undo this delete. All user files and associated notes will be permanently removed from the system.
To Top
Changing a users directory size
To purge a users files, click on the "List Users" link on the administration function bar.
From the list of users at the top of the page, click on the "Edit" link. To change the users disk space allotment, simply enter a new value in the Upload Limit filed of the profile edit box.
Note that if you set the upload limit to a size smaller than is currently in use by the user, no files will be erased. They simply will not be able to upload new files until they delete some of the files in their profile.
To Top
Deleting a users profile
It is recommended that you purge a users profile before you delete the profile.
To delete a users profile, click on the "List Users" link on the administration function bar.
From the list of users at the top of the page, click on the "Delete" link on the same line as the users name. You will be asked to confirm your selection.
Please note that deleting a users profile is a permanent and irreversible course of action. Once you click the OK button on the confirmation you can NOT undo this delete. All user information and all files and associated notes will be permanently removed from the system.
To Top
Managing Files
Listing all files in the system
To list all users files in the system, click on the "List Files" link on the administration function bar.
This "List Files" page provides the ability to view a users profile, download a file and view the notes associated to a file. All files are broken down by client user.
To Top
Listing the files in an individual profile
To view an individual profiles files, go to that users profile and all of their current files will be listed on the bottom of the page.
To Top
Deleting an individual file
From the users profile listing, click on the "Delete" link on the same line as the file name. You will be asked to confirm your choice. Click on the OK to proceed with the delete. Deleting a file is a permanent and irreversible course of action. Once committed, it can not be un-done.
To Top
Renaming an individual file
From the users profile listing, click on the "Rename" link on the same line as the file name. A pop up box will appear asking for the new file name. Here is a breakdown of what will occur based on your input:
- If you click cancel of submit an empty value, nothing happens.
- If you type a new name with an extension, the file will be renamed to that value you entered.
- If you type a new name without an extension, the current extension will be maintained.
- If you attempt to rename a file to an extension that is not permitted, you will be notified the name change did not take place.
- If you rename the file to a name that already exists in that users folder, the existing file will be replaced with the new file and the file that previously had that name will be permanently removed from the system.
Once committed, the rename function can not be un-done.
To Top
How to add/view notes associated to a file
From the users profile listing, click on the "Notes" link on the same line as the file name. A pop up window will appear containing the current content of the "Notes" associated to that file. If the content field is blank, there are no notes. You simply edit the current notes or add new content in the editable field of the pop up window. When completed, click the "Update Notes" button. When you are finished with the notes window, click on the "x" in the upper right hand corner.
To Top
Users Guides
View our on-line client users guide
From within the admin program, on the function bar, you can click the "Users Guide" link at any time. You will be brought to this page that you are reading right now.
To Top
Creating your own sites client users guide
A generic Users Guide that you can modify as you require, has been included with the basic distribution zip file of this program. This can be displayed on your website for your program users to utilize.
This client users guide template will be updated as the program is enhanced and new options are added. It is your responsibility to make sure you have the most recent copy of this client users guide template whenever you upgrade your program.
To Top
File Fetch Add-On Module
What the File Fetch Add On Module does
The File Fetch module will allow your client users to retrieve files from across the web. Instead of uploading a file from their hard drive, they will have the option of entering a URL to a document in the File Fetch box. Then, when they click the button, the program will go to that site, retrieve the file and store it in their account. This does not replace file upload ability, it is in addition to the file upload ability.
To Top
How to obtain this add-on module
To obtain the File Fetch Add-On Module, on-line order page and select "CFM-File Fetch Module". Note that if you purchased the "CFM-The Full Monty" package, File Fetch was part of that distribution.
To Top
How to install it
To install this add-on module, simply place the cfm_filefetch.lib file in the same directory as the other scripts with this program. That is ALL that you have to do. The File Fetch retrieval form will then be located in the client users "Upload Files" page.
To Top
Administrative Considerations
There are considerations you should keep in mind when installing this module. This module permits a user to simply enter the URL of a document/image and have it retrieved and stored in their webspace. There may be copyright restrictions that are being violated. While a user can simply download it to their hard drive and upload it to their file space, by providing the File Fetch abiltity, you may be viewed as having facilitated such a copyright infringement.
While we are not aware of any instance where such a claim has been made or action taken, we urge you to make sure that your users are aware of their responsiblity to ensure that no copyright infringement is taking place with files they retrieve using the File Fetch utility.
To Top
What are it's limitations
Currently, the V1.0 of the File Fetch Add-On Module, will only handle files up to approximately 50-60Kb in size. Test in on your system to determine it's exact limitations.
To Top
Public Drop Box Add-On Module
What the Public Drop Box Add On Module does
The Public Drop Box allows website visitors to upload files to the directories of your registered clients. The public user does not have to log in. You can have any type of form you want with the dropbox by utilizing the HTML template and the form contents will be stored with the file in the "Notes".
If you site has "departments" that you want to be able to freely receive documents, then setup client accounts with department "names" and the program will take care of the rest.
To Top
How to obtain this add-on module
To obtain the Public Drop Box Add-On Module, on-line order page and select "CFM-Public Drop Box". Note that if you purchased the "CFM-The Full Monty" package, the Public Drop Box was part of that distribution.
To Top
How to install it
To install the Public Download module, FTP in ASCII mode the files "cfm_dropbox.cgi" into the same directory as the other CGI scripts with this program. You must CHMOD the "cfm_download.cgi" file to 755.
Next, if you are logged into the admin program, click on "List Users" or if not, then log into the admin program. Locate the Quick Switches at the bottom of the page (List Users) and click on the "Turn On" link next to Permit Public Drop Box.
The Public Drop Box module is now active and operational. If you do not wish to use the default form, proceed to the section below on using and customizing the HTML template.
To Top
Administrative Options
The Public Drop Box has the option to turn On/Off the Public Drop Box feature. The Public Drop Box can be turned on or off from the Quick Switch links at the bottom of the "List Users" page or it can be toggeled on or off from the "Options" page.
To Top
How to make a users profile accessible
Once the Public Drop Box is installed, individual users must make themselves accessible to the Public Drop Box. They can only do this if the "Permit Profile Edit" switch is turned on. If it is on or off, the administrator can make them accessible or inaccessible by going to the users profile edit screen. Once the drop box is installed, the edit screen will contain an additional field that will allow you to set their display in the Public Drop Box to Active or Disabled.
Additionally, there is now a second option on the edit page as well for activiating or de-activating drop box notification for that user. If it is set to active, they will get an e-mail message whenever someone uploads to their account via the Public Drop Box.
To Top
How to use the Drop Box template
The Public Drop Box is called "dropbox.html". Do NOT rename this file. This file gets placed in the same directory as the rest of the cgi scripts. Also note up front that you do not link to or call this HTML document in your browser. If you do, the Public Drop Box will not work. Instead, you link to or call the "cfm_dropbox.cgi" script which in turn uses the template HTML file.
Feel free to edit/modify/change this HTML document as necessary. There are only a few rules you must follow:
- The opening form tag must remain un-changed.
- The hidden form filed tag named "action" must remain un-changed.
- The marker "%%%destination_list%%%" must be in place, un-altered, between the opening
and closing form tags.
- You can have as many file fields as you want, up to the max number specified in the
admin "Options" page. The file field must be named FILE1, FILE2, FILE3, etc, etc. The name of this
field is case sensitive.
<input type="file" name="FILE2" size=20>
To Top
Renaming the drop box script
If you prefer to have the cfm_dropbox.cgi script renamed to something else, you can do this. The only requirement is that in addition to the newly named script, the cfm_dropbox.cgi must still be present in the same directory as the rest of the scripts. Therefore, as an example we will assume you would like to rename the script "dropbox.cgi". Open the cfm_dropbox.cgi in your text editor and then click on File->Save As and enter the new name of the file. The only requirement with the name is that it must end with a ".cgi" extension. (If your server requires ".pl" extensions, we can provide a copy of the program for you with that extension. You simply can not change the extensions)
So, having saved the file as "dropbox.cgi", you will now FTP both to them to the sever in ASCII mode. Therefore the directory with this programs files would now contain in addition to the other files, these two files:
- cfm_dropbox.cgi (mine)
- dropbox.cgi (yours)
To Top
Private Drop Box Add-On Module
What the Private Drop Box Add On Module does
The Private Drop Box allows website visitors to upload files to the directories of your registered clients. The public user is required to use a User Name and Password to complete the upload. You can have any type of form you want with the dropbox by utilizing the HTML template and the form contents will be stored with the file in the "Notes".
Both the administrator and client user can add temporary access for an individual to upload files/use the Private Drop Box. The administrator can add a temporary user for any client user account. The client user can only create a temporary user for their own account.
The temporary user should be given the URL to the "cfm_private_dropbox.cgi" script to complete their uploads.
To Top
How to obtain this add-on module
To obtain the Private Dropbox Add-On Module, on-line order page and select "CFM-Private Dropbox". Note that if you purchased the "CFM-The Full Monty" package, the Private Dropbox was part of that distribution.
To Top
How to install it
To install the Private Dropbox module, FTP in ASCII mode the files "cfm_private_dropbox.cgi" and "cfm_private_dropbox.lib" into the same directory as the other CGI scripts with this program. You must CHMOD the "cfm_private_dropbox.cgi" file to 755. You should not have to CHMOD the "cfm_private_dropbox.lib" file.
Next, if you are logged into the admin program, click on "List Users" or if not, then log into the admin program. Locate the Quick Switches at the bottom of the page (List Users) and click on the "Turn On" link next to Permit Private Dropbox.
The Private Dropbox module is now active and operational. If you do not wish to use the default form, proceed to the section below on using and customizing the HTML template.
To Top
Administrative Options
The Private Drop Box has the option to turn On/Off the Private Drop Box feature. The Private Drop Box can be turned on or off from the Quick Switch links at the bottom of the "List Users" page or it can be toggeled on or off from the "Options" page.
To Top
How to add a temporary drop box user
From the "List Users" page, beneath the "Add New User" form, you will see a section called "Private Drop Box Users - Add New". In this form, enter the temporary users Name, E-Mail, a user name and a password. Next, from the drop down list of registered clients, select the name of the client that this person is to upload files for. Click the Add button.
Your client users have a similar form on their main summary page, however, they do not have the list to select destinations from.
The temporary user can use that user name and password to upload files to that one destination users folder only. If they need to upload to a different person, you must create a second temporary user account for them.
The temporary user should be given the full URL to the "cfm_private_dropbox.cgi" script to complete their upload.
To Top
Viewing a list of temporary drop box users
In the admin program, on the "List Users" page, beneath the form to add a new temporary user you will see a section called "Private Drop Box Users - Existing". This lists all temporary accounts currently in the system including those entered by your client users. This list shows the temporary users name, e-mail address and the name of the client user they are authorized to upload files to.
Your client user will have a similar listing on their own summary page except that it will not display the destination folders, it will only show the temporary users permitted to upload to their account.
To Top
How to delete a temporary drop box user
From the list of temporary users, simply click on the delete link. There is no validation of this selection, the temporary user will be removed without further confirmation.
Your client user has the ability to delete temporary users as well but they can only delete the temporary users that are specified for access to their account.
To Top
How to use the Private Drop Box template
The Private Drop Box template is called "private_dropbox.html". Do NOT rename this file. This file gets placed in the same directory as the rest of the cgi scripts. Also note up front that you do not link to or call this HTML document in your browser. If you do, the Private Drop Box will not work. Instead, you link to or call the "cfm_private_dropbox.cgi" script which in turn uses the template HTML file.
Feel free to edit/modify/change this HTML document as necessary. There are only a few rules you must follow:
- The opening form tag must remain un-changed.
- The hidden form filed tag named "action" must remain un-changed.
- You can have as many file fields as you want, up to the max number specified in the
admin "Options" page. The file field must be named FILE1, FILE2, FILE3, etc, etc. The name of this
field is case sensitive.
<input type="file" name="FILE2" size=20>
To Top
Renaming the drop box script
If you prefer to have the "cfm_private_dropbox.cgi" script renamed to something else, you can do this. The only requirement is that in addition to the newly named script, the "cfm_private_dropbox.cgi" must still be present in the same directory as the rest of the scripts. Therefore, as an example we will assume you would like to rename the script "dropbox.cgi". Open the cfm_private_dropbox.cgi in your text editor and then click on File->Save As and enter the new name of the file. The only requirement with the name is that it must end with a ".cgi" extension. (If your server requires ".pl" extensions, we can provide a copy of the program for you with that extension. You simply can not change the extensions)
So, having saved the file as "dropbox.cgi", you will now FTP both to them to the sever in ASCII mode. Therefore the directory with this programs files would now contain in addition to the other files, these two files:
- cfm_private_dropbox.cgi (mine)
- dropbox.cgi (yours)
To Top
Self Registration Add-On Module
What the Self Registration Add On Module does
The Self Registration Add-On Module permits the public to Self Register for an account with your copy of the Client File Manager. The system forces the user to enter a valid e-mail address as they must confirm their registration through a link that is sent to the e-mail address they register with. Other than that, there is no further validation or intervention for a person Self Registering.
If you would like to have this Self Registration system tied in to a payment processor, we can do this. The cost will vary depending on the payment processor and the level of complexity involved.
To Top
How to obtain this add-on module
To obtain the Self Registration Add-On Module, on-line order page and select "CFM-Self Register". Note that if you purchased the "CFM-The Full Monty" package, the Self Register was part of that distribution.
To Top
How to install it
To install the Self Registration Add-On Module, place the file "cfm_register.cgi" in the same directory as the other CGI scripts with this program. CHMOD the file to 755.
Next, if you are logged into the admin program, click on "List Users" or if not, then log into the admin program. Locate the Quick Switches at the bottom of the page (List Users) and click on the "Turn On" link next to Permit Self Register.
The Self Register module is now active and operational. If you do not wish to use the default form, proceed to the section below on using and customizing the HTML template.
To Top
Administrative Options
The Self Registration module has the option to turn On/Off the Self Registration feature. The Self Registration feature can be turned on or off from the Quick Switch links at the bottom of the "List Users" page or it can be toggeled on or off from the "Options" page.
To Top
How to use the Self Registration template
The Self Registration template is called "register.html". Do NOT rename this file. This file gets placed in the same directory as the rest of the cgi scripts. Also note up front that you do not link to or call this HTML document in your browser. If you do, the Self Registration will not work. Instead, you link to or call the "cfm_register.cgi" script which in turn uses the template HTML file.
Feel free to edit/modify/change this HTML document as necessary. There are only a few rules you must follow:
- The opening form tag must remain un-changed.
- The hidden form filed tag named "action" must remain un-changed.
- There are six mandatory fields for the Self Registration form:
name, email, alias, username, password, passwordcompare
It is highly recommended that you edit the template around the form only and that you do not alter the registration form itself.
To Top
Renaming the Self Registration script
If you prefer to have the cfm_register.cgi script renamed to something else, you can do this. The only requirement is that in addition to the newly named script, the cfm_register.cgi must still be present in the same directory as the rest of the scripts. Therefore, as an example we will assume you would like to rename the script "register.cgi". Open the cfm_register.cgi in your text editor and then click on File->Save As and enter the new name of the file. The only requirement with the name is that it must end with a ".cgi" extension. (If your server requires ".pl" extensions, we can provide a copy of the program for you with that extension. You simply can not change the extensions)
So, having saved the file as "register.cgi", you will now FTP both to them to the sever in ASCII mode. Therefore the directory with this programs files would now contain in addition to the other files, these two files:
- cfm_register.cgi (mine)
- register.cgi (yours)
To Top
Public Download Add-On Module
What the Public Download Add On Module Does
The Public Download module allows public users to view a list of files that are specified as "Open" for all the client users accounts in the system. The public can download these files without any validation.
The public does not have the ability to upload, modify, rename or delete these files. The public does not have the ability to see the "Notes" associated to a file.
To Top
How to obtain this add-on module
To obtain the Public Download Add-On Module, on-line order page and select "CFM-Public Download". Note that if you purchased the "CFM-The Full Monty" package, the Public Download was part of that distribution.
To Top
How to install it
To install the Public Download module, FTP in ASCII mode the files "cfm_download.cgi" and "cfm_download.lib" into the same directory as the other CGI scripts with this program. You must CHMOD the "cfm_download.cgi" file to 755. You should not have to CHMOD the "cfm_download.lib" file.
Next, if you are logged into the admin program, click on "List Users" or if not, then log into the admin program. Locate the Quick Switches at the bottom of the page (List Users) and click on the "Turn On" link next to Permit Public Download.
The Public Download module is now active and operational. If you do not wish to use the default form, proceed to the section below on using and customizing the HTML template.
By default, all files are considered private. You must actively select and mark as file as open for it to be accessible for Public Download. To do this, switch into each of the user accounts and click on "Private" next to the file name. This will then change to "Open". You must do this for each file you want to be made available.
To Top
Administrative Options
The Public Download module has the option to turn On/Off the Public Download feature. The Public Download feature can be turned on or off from the Quick Switch links at the bottom of the "List Users" page or it can be toggeled on or off from the "Options" page.
Additionally, you have the option to use counters with the Public Download feature. To turn on the counters, go to the "Options" page in the admin program. You will see the download options section. Setting the option to "Yes" will enable the counters. The counter will be displayed where the files are listed within the program. Setting this option to "No" will disable the counter but will not erase any counter values. Turning the setting back on will re-enable the counters and they will pick up from where they left off.
Note that when you switch a file from "Open" status to "Private" status, the file counter will be erased. It will be reset to zero the next time you make that file "Open".
The counters option switch is shared by the public and Private Download Add-On Modules. If you have both of these Add-On Modules installed, you can not specify on for one and off for the other.
To Top
How to prevent files from being downloadable
When the public or Private Download modules are installed, a new option will appear next to a file name in the listing of files under each account. This new option shows a status of "Open" or "Private". By default, all files are "Private" when this module is installed. This means that it can not be viewed in the Public Download page.
To make a file available, click on the "Private" link and the page will refresh showing this file as "Open".
To suspend or remove a file from download availability, click on the "Open" link and the page will refresh showing the file as private.
To Top
How to use the Public Download template
The Public Download template is called "download.html". Do NOT rename this file. This file gets placed in the same directory as the rest of the cgi scripts. Also note up front that you do not link to or call this HTML document in your browser. If you do, the Public Download will not work. Instead, you link to or call the "cfm_download.cgi" script which in turn uses the template HTML file.
Feel free to edit/modify/change this HTML document as necessary. There are only a few rules you must follow:
- There is one mandatory marker that must be in the page:
%%%contents%%%
If this marker is not present, the available files will not display.
The available files display in a predefined format. If you want this format changed, it is a custom modification for which we charge a fee. It is not possible for the end user to modify the output of the downloadable files. If you are extremley comfortable with Perl, you may feel free to modify the output to your specifications for the site for which you purchased your copy of the program. You may not re-distribute this modification to any other site or person under any circumstance.
To Top
Renaming the Public Download script
If you prefer to have the cfm_download.cgi script renamed to something else, you can do this. The only requirement is that in addition to the newly named script, the cfm_download.cgi must still be present in the same directory as the rest of the scripts. Therefore, as an example we will assume you would like to rename the script "download.cgi". Open the cfm_download.cgi in your text editor and then click on File->Save As and enter the new name of the file. The only requirement with the name is that it must end with a ".cgi" extension. (If your server requires ".pl" extensions, we can provide a copy of the program for you with that extension. You simply can not change the extensions)
So, having saved the file as "download.cgi", you will now FTP both to them to the sever in ASCII mode. Therefore the directory with this programs files would now contain in addition to the other files, these two files:
- cfm_download.cgi (mine)
- download.cgi (yours)
To Top
Private Download Add-On Module
What the Private Download Add On Module does
The Private Download module allows public users to view a list of files that are specified as "Open". The public user must first have a temporary user account created for them. They will be assigned a user name and password. When they sign into the Private Download module, they will only see a list of the files available for the client user they are registered for. If you want them to see the files in multiple client user accounts, you must create a temporary user account for them for each client user profile.
The temporary user does not have the ability to upload, modify, rename or delete these files. The temporary user does not have the ability to see the "Notes" associated to a file.
To Top
How to obtain this add-on module
To obtain the Private Download Add-On Module, on-line order page and select "CFM-Private Download". Note that if you purchased the "CFM-The Full Monty" package, the Private Download was part of that distribution.
To Top
How to install it
To install the Private Download module, FTP in ASCII mode the files "cfm_private_download.cgi" and "cfm_private_download.lib" into the same directory as the other CGI scripts with this program. You must CHMOD the "cfm_private_download.cgi" file to 755. You should not have to CHMOD the "cfm_private_download.lib" file.
Next, if you are logged into the admin program, click on "List Users" or if not, then log into the admin program. Locate the Quick Switches at the bottom of the page (List Users) and click on the "Turn On" link next to Permit Private Download.
The Private Download module is now active and operational. If you do not wish to use the default form, proceed to the section below on using and customizing the HTML template.
To Top
Administrative Options
The Private Download module has the option to turn On/Off the Private Download feature. The Private Download feature can be turned on or off from the Quick Switch links at the bottom of the "List Users" page or it can be toggeled on or off from the "Options" page.
Additionally, you have the option to use counters with the Private Download feature. To turn on the counters, go to the "Options" page in the admin program. You will see the download options section. Setting the option to "Yes" will enable the counters. The counter will be displayed where the files are listed within the program. Setting this option to "No" will disable the counter but will not erase any counter values. Turning the setting back on will re-enable the counters and they will pick up from where they left off.
Note that when you switch a file from "Open" status to "Private" status, the file counter will be erased. It will be reset to zero the next time you make that file "Open".
The counters option switch is shared by the public and Private Download Add-On Modules. If you have both of these add-on modules installed, you can not specify on for one and off for the other.
To Top
How to add a temporary Private Download user
From the "List Users" page, beneath the "Add New User" form, you will see a section called "Private Download Users - Add New". In this form, enter the temporary users Name, E-Mail, a user name and a password. Next, from the drop down list of registered clients, select the name of the client that this person is to download files from. Click the Add button.
Your client users have a similar form on their main summary page, however, they do not have the list to select the source account. This will automatically be assigned as the client user who is adding the temporary user.
The temporary user can use that user name and password to view and download files from that one source folder only. If they need to view and download files from a different user account, you must create a second temporary user account for them.
The temporary user should be given the full URL to the "cfm_private_download.cgi" script to complete their download.
To Top
Viewing a list of temporary download users
In the admin program, on the "List Users" page, beneath the form to add a new temporary user you will see a section called "Private Download Users - Existing". This lists all temporary accounts currently in the system including those entered by your client users. This list shows the temporary users name, e-mail address and the name of the client user they are authorized to view and download files from.
Your client user will have a similar listing on their own summary page except that it will not display the source folders, it will only show the temporary users permitted to upload to their account.
To Top
How to delete a temporary download user
From the list of temporary users, simply click on the delete link. There is no validation of this selection, the temporary user will be removed without further confirmation.
Your client user has the ability to delete temporary users as well but they can only delete the temporary users that are specified for access to their account.
To Top
How to use the Drop Box template
The Private Download template is called "private_download.html". Do NOT rename this file. This file gets placed in the same directory as the rest of the cgi scripts. Also note up front that you do not link to or call this HTML document in your browser. If you do, the Private Download will not work. Instead, you link to or call the "cfm_private_download.cgi" script which in turn uses the template HTML file.
Feel free to edit/modify/change this HTML document as necessary. There are only a few rules you must follow:
- There is one mandatory marker that must be in the page:
%%%contents%%%
If this marker is not present, the available files will not display.
The available files display in a predefined format. If you want this format changed, it is a custom modification for which we charge a fee. It is not possible for the end user to modify the output of the downloadable files. If you are extremley comfortable with Perl, you may feel free to modify the output to your specifications for the site for which you purchased your copy of the program. You may not re-distribute this modification to any other site or person under any circumstance.
To Top
Renaming the drop box script
If you prefer to have the cfm_private_download.cgi script renamed to something else, you can do this. The only requirement is that in addition to the newly named script, the cfm_private_download.cgi must still be present in the same directory as the rest of the scripts. Therefore, as an example we will assume you would like to rename the script "download.cgi". Open the cfm_private_download.cgi in your text editor and then click on File->Save As and enter the new name of the file. The only requirement with the name is that it must end with a ".cgi" extension. (If your server requires ".pl" extensions, we can provide a copy of the program for you with that extension. You simply can not change the extensions)
So, having saved the file as "download.cgi", you will now FTP both to them to the sever in ASCII mode. Therefore the directory with this programs files would now contain in addition to the other files, these two files:
- cfm_private_download.cgi (mine)
- download.cgi (yours)
To Top
About the Perl Modules with this program
There are two Perl Modules that ship with this program. They are MongerFile.pm and MongerTemplate.pm. These modules were both developed by and are freely distributed from Perl Services. These two modules are distributed under the same terms as Perl itself. We only ask that you leave the header notice intact and that you comment any modifications to the modules along with your name, the date and your e-mail address (we have to know who to blame after all). You can read more about these and other Perl Modules at www.perlservices.net/en/modules/
To Top
Support
This program and all it's add on modules have been tested on the Apache web server and on a variety of different flavours of UNIX. This program will NOT run on a Windows server and we don't even know anyone with Mac server ;)
If you have difficulties setting up this program, we will install it for you. The installation fee is US$40. Installation can be ordered on our order form.
If you have a question about the scripts operation, please go over this users guide. If you still can't find the answer to your question or you believe you have found a bug/error/problem in this program, then please contact our support department for assistance via our on-line, support request form. Most support requests are answered within one business day.
To Top
Security
There are a few important security aspects to keep in mind. Some are good practice in general, some are specific to this program only.
1. Make sure your $DataKey variable is a completely random sequence of characters. Do not make it a real word and do not make your Postal Code/ZIP Code or phone number part of it.
2. This program supports two administrative users. Do not give out your administrative User Name and Password unless absolutely necessary. If you do have to give it out to someone, change these as soon as that person is finished working with it. Make sure your sub-administrator follows the same rules.
3. Change your User Name and Password every four to six months. Encourage your registered users and sub-administrator to do the same thing. If they don't, do it for them.
4. Select a User Name and Password that is easy for you to remember but hard for someone else to guess. User Names and Passwords that are longer, are harder to guess. We recommend ten characters for User Names and Password.
5. Whenever this program creates a sub-directory, it creates and index.html document that displays an un-authorized access message. This is utilized in case someone stumbles across the directory name. This way your server will not be able to list the contents of that directory. If your main directory document is named something other than index.html, you will have to FTP into the data directories and manually rename these documents.
6. Your programs administrative password is encrypted. Therefore you can not retrieve it. If you forget the administrative password then contact us. We will send you a utility script that will allow you to generate a new password without re-running the setup script. Re-running the setup script also restores default setting for all options you previously may have set through the program interface. There is no charge for this utility script.
7. Unlike most CGI programs available on the web, this program utilizes a back-up and restoration set of utility on all data files. This reduces the likely hood of files being erased by a large number of hits at the same time. In the very unlikely event that this does occur, please contact us
To Top
