Guest Book. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

Transcription

1 License Guest Book Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Features Easy integration into your present web site with the use of customizable templates, cascading style sheet (CSS) and optional user defined input and exit links. Configurable logging option allows the guest book to log descriptive error and user access message to the web server log.* Configurable bad words filter which allows you to block bad words which are passed to the guest book. ** Configurable IP Address blocking filter which will block unwanted visitors from accessing the guest book. Configurable age blocking filter which prevents under age visitors from signing the guest book. Configurable auto-responder which allows you to selectively turn on or off, send an administrative , and send mail in either HTML or ASCII format. Configurable page titles and form titles. Guest Book can be called via HTTP or HTTPS. There are no hard coded links in the guest book which would prevent this. Security feature which prevents an unauthorized user from sending a form post to the guest book s primary processing page. Without this feature an unauthorized user could potentially use the guest book as a source to send unauthorized to unknown users. The guest book generates a new view once it has reached a predefined file size. A user that views the guest book entries will be presented by an abbreviated view with a drop down list of additional guest book views. Client Side form validation to ensure users input the appropriate data. Client side form validation takes the processing burden off of the server. System Requirements Windows 2000 Internet Information Services 5.0 May work on other systems however it is currently untested.

2 Instructions The guest book has been designed to be easily deployed just drop the files into a directory, customize the file paths, and set the appropriate permissions. The guest book does however allow for advanced configuration options which allows for bad word filtering, IP filtering and advanced options. Basic Installation Recommended Permissions (IIS and NTFS) / o Read IIS /conf o No IIS /css o Read IIS /data o No IIS o No NTFS /data/gb o No IIS o Modify NTFS /data/lock o No IIS o Modify NTFS /java o Read IIS /templates o Read IIS Setting File Path Information All path information is derived from the root directory of your web site. Example In order to properly configure your guestbook you will need to modify the values in the conf.inc file to match the configuration of your web site. As stated above you want to use the web sites virtual path for all file path configuration parameters. Note: The Guest Book will be confi gured with base functionality by simply configuring the file paths. The section on advanced configuration and installation will enable additional features of the Guest Book.

3 Configurable File Path Parameters DataFilePath o Path for the Guest Book data file. DataFileDirRoot o Root of the data directory which contains the Guest Book directory. GBFileDirRoot o Root of the Guest book data directory. LockFilePath o Path for the lock File. BadWordsFilePath o Path for bad words file used to filter unwanted content. BlockIPFilePath o Path for blocked IP Address file used to filter unwanted user access. CSSFilePath o Path for the applications style sheet. Used to minimize admin effort when customizing the applications appearance. FrmValScpPath o Path for the java script used for client side form validation. HeaderPath o Path for the HTML header template. FooterPath o Path for the HTML footer template. Advanced Installation and Configuration Guest Book Logging AdvancedLogging = (0 Log) (1 Don t Log) The default configuration for the Guest Book is not to log Guest Book specific events. If enabled the Guest Book will log any defined application events to the Internet Information Services (IIS) log. The following is a list of application events and the corresponding log entry Guest Book denies access to an IP address. ##_Access_Denied_to_Guest_Book_from_IP_Address_<Remote Hosts IP>_@_<Time>_## User input is sent to the confirmation page for verification and validation. ##_Guestbook_is_confirming_user_input_## User input is sent to the processing page. ##_Guestbook_is_processing_user_input_## User input is being saved to the data file. ##_Guestbook_is_saving_user_input_## An auto response is being generated in HTML format. ##_Guestbook_is_sending_HTML_ _## An auto response is being generated in ASCII format. ##_Guestbook_is_sending_ASCII_ _## Someone attempted to access the Guest Book from an unknown source. ##_Access_Denied_to_Guest_Book_from_IP_Address_[External_Form_Post]_##

4 User has been thanked and is being transferred to the home page. ##_Guestbook_is_thanking_user_for_their_submission_## A user is viewing the Guest Book entries. ##_Guestbook_entry s_are_being_viewed_## Guest Book entry was denied because the user is under age. ##_Guestbook_entry_was_denied_[Under Age]_## The Guest Book s entry form has been displayed. ##_The_guestbook's_start_page_has_been_accessed_## Bad Word Blocking BWBlocking = (0=Block) (1=Don t Block) MaxBadWords = (Number of bad words to search) (Default 100) badwords.csv (File that contains a list of bad words that you wish to block) The default configuration for the Guest Book is not to block bad words that are submitted. If enabled the Guest Book will read the badwords.csv file for a list of administrator defined bad words. The Guest Book will then compare the user s entries against the list of bad words. If any bad words are found form processing will stop and the user will be prompted to re input their information. The format of the badwords.csv file is coma separate value this means that you should enter a value, then a coma, next a space, and finally another value. Below is an example. Value1, Value2, Value3 If you add more than 100 bad words to the badwords.csv file you must increment the MaxBadWords value to the number of bad words that are in the badwords.csv file. Note: This version of the bad word filter is case sensitive. This means that Value1 and value1 are different and must be added to the badwords.csv file separately. Additionally the bad word filter currently does not search phrases. You can modify the error message displayed to the user in the event that bad input is detected by modifying the below values. Bad word error messages BadInputMessage = Bad Input Detected Bad Message = field contains restricted words! BadFirstName = First Name field contains restricted words! BadLastName = Last Name field contains restricted words! BadAddress = Address field contains restricted words! BadComments = Comments field contains restricted words!

5 IP Address Blocking IPBlocking = (0=Block) (1=Don t Block) MaxBlockedIPs = (Number of IP Addresses to search) (Default 100) block_ip.csv (File that contains a list of IP Addresses that you wish to block) The default configuration for the Guest Book is not to block IP addresses of remote client machines. If enabled the Guest Book will read the block_ip.csv file for a list of administrator defined blocked IP Addresses. The Guest Book will then compare the remote clients IP Address to the list of blocked IP Addresses. If any blocked IP Addresses are found form processing will stop and an error will be displayed in the remote clients browser telling them they have been denied access. The format of the block_ip.csv file is coma separate value this means that you should enter a value, then a coma, next a space, and finally another value. Below is an example. Value1, Value2, Value3 If you add more than 100 blocked IP Addresses to the block_ip.csv file you must increment the MaxBlockedIPs value to the number of blocked IP Addresses that are in the block_ip.csv file. Age Blocking AgeBlocking = (0=Block) (1=Don t Block) The default configuration for the Guest Book is not to perform age verification. If enabled the Guest Book will check the age field in the form. The Guest Book will then check to ensure the value is greater than 17. If the value is less than or equal to 17 the user will denied the ability to enter information to the guestbook and will be redirected to the start page. SendMail = (0=Send Mail) (1=Don t Send Mail) SendAdminMail = (0=Send Admin Mail) (1=Don t Send Admin Mail) HTMLorASCII = (0=HTML Mail) (1=ASCII Mail) Subject = Thank you for signing our guestbook AdminMail = Admin@yourdomain.com FromMail = Thanks@yourdomain.com The default configuration for the Guest Book is not to send . If is configured the default is to not send an admin , and the user will be in ASCII format. The application assumes that you have the SMTP service for IIS installed. Installing this service also installs Collaborative Data Object (CDO) which is used to enable functionality for the application. Prior to enabling functionality you should change the AdminMail and FromMail configurable options to available addresses within your domain. The AdminMail option is the address where you which an administrative notice sent when the Guest Book is signed. The FromMail option is the address that the user will see in the from field of their client. Finally if you wish to change the default subject line of the modify the Subject option.

6 To enable configure the SendMail option with a value of 0. If you wish to have an admin notification sent, configure the SendAdminMail option with a value of 0. Finally you can decide what format you wish to send your auto-response. Set the HTMLorASCII option to 0 for HTML or 1 for ASCII. Below is an ex ample of each output Example ASCII format Thank you for signing our guestbook. Your submission is as follows Date / Time: 12/23/2001 1:20:12 PM @address.com Name: John Doe Address: 123 Some Where Ave. State: MD Country: US Zip Code: Age: 18 Comments: Example Example HTML format Thank you for signing our guestbook Your submission is as follows Date / Time: Address: Name: Address: State: Country: US Zip Code: Your Age: 18 Comments: 12/23/2001 1:22:20 PM @address.com John Doe 123 Some Where Ave. MD Example

7 Home Page / Thank You Page CustomThankYouPage = (0=Custom Page) (1=Default Page) ThankYouPage = URL of your thank you page CustomHomePage = (0=Custom Page) (1=Default Page) HomePage = URL of you home page The default configuration for the Guest Book is to use a single page to render all HTML. This means that the Home Page is the initial entry form and the thank you page displays for three seconds and redirects to the initial entry form. You can defeat this default behavior and specify your own home page and thank you page by specifying values for the above options. To specify a custom Thanks You page configure the CustomThankYouPage option with a value of 0 Then input the URL of your custom thank you page. To specify a custom Home page configure the CustomHomePage option with a value of 0 Then input the URL of your custom home page. Page and Form Titles DefaultPageTitle = Guest Book ConfirmationPageTitle = Guest Book [Please Confirm Your Information!] ThanksPageTitle = Guest Book [Thanks] SorryPageTitle = Guest Book [Sorry] ViewPageTitle = Guest Book [View Submissions] DefaultFormTitle = Please Enter Your Personal Information. ConfirmationFormTitle = Please Confirm Your Information. ViewFormTitle = Select the Guest Book view you wish to load. Above are all of the default values for the page and form titles used in the Guest Book. You can customize them to fit the design of you site. Templates header.txt Basic Template Set footer.txt Template Set w/ Side Bar header_sidebar.txt footer_sidebar.txt The default configuration for the Guest Book is to use the Basic Template Set configuring the HeaderPath, and FooterPath options you can specify the side bar template or a custom template of you own. These templates are basic HTML files that you can customize. Their purpose is to give you a starting point to customize the Guest Book.

8 Cascading Style Sheet You can use the gb.css file to configure color and font options for the Guest Book. This gives you a central location to configure aesthetic attributes. Client Side Form Validation The file FormValidation.js is used for client side form validation. This removes the need for the server to process a form that has missing input. The Form Validation Java Script is provided by: Art Lubin / artswork99@aol.com * Supported on Internet Information Services (IIS) ** Currently filters single words not phrases. The next release of the guest book will search phrases for bad words.