Home > Articles

This chapter is from the book

Example: Downloading and Installing a Guestbook Script

Let's take a look at the steps required to download and install a typical CGI script on a server. For this example, I'm going to use the Guestbook script from the NMS collection of scripts. The guestbook program allows users who visit your site to enter some personal information that will be published as part of your site's guestbook. Other users who visit your site can view the guestbook and add entries of their own. One nice thing about the NMS scripts is that they're designed to allow users to get them up and running quickly. The documentation is clear and concise, and the scripts themselves are written so that they're easy to configure for the local computer. The guestbook script is available at:

http://nms-cgi.sourceforge.net/scripts.shtml

The script and its attending files can be downloaded in any number of formats; you should download it in the format that's appropriate for your platform. After you've downloaded it, you should unpack the archive into a directory outside your Web directories. The package comes with a CGI program (guestbook.pl), several HTML documents, and a README file which explains how to install the application.

NOTE

By unpack, I mean that you should use the appropriate application to extract the files from the archive. On Windows, you might use WinZip to extract the files. Under UNIX, you would most likely use gzip and tar.

Configuring the Script

After you've downloaded and unpacked the script, the next step is to get the guestbook up and running on your Web server. The first step is to read the README file—it explains exactly what you need to change to get the script to work. Because it's a Perl script, you'll have to edit it so that it works in your environment. Generally, that means editing the shebang line (the first line of the script), so that the pointer to the Perl interpreter is correct. For example, the script is set by default to look for the Perl interpreter at /usr/bin/perl. On my Web server, Perl is installed at /usr/local/bin/perl, so I changed the first line to point to the correct location. After that's done, the script should run, but there's still more work to do.

NOTE

The first line of a UNIX script, the one with the pointer to the script interpreter is called the "shebang line." It's called that because the first two characters are #!. The # is sometimes called the hash character, and UNIX people call exclamation points bangs, thus shebang.

To get the script working, you have to go into the script and set some variables so they reflect your environment. These variable assignments are found in the guestbook.pl script immediately after the comments at the top. Some of the information you must enter or verify is the location of the date program on your system, the URL where the guestbook form is located, and the name of the file to be used as the guestbook log. There are also a number of options that can be set to alter the behavior of the script. These options are described in the README file.

Installing the Files and Setting Permissions

You must put all the files in the proper locations. The guestbook.pl file should reside in your cgi-bin directory, and the HTML files distributed as part of the guestbook application should reside under the document root on your Web server with the rest of your static HTML documents. Some of the variables in guestbook.pl will have to be set after you've determined the final locations for the files in the package. You also have to edit the addguest.html form and change the action attribute of the form tag so that it points to the location where you installed guestbook.pl.

You also have to make sure that the actual guestbook file, guestbook.html, and the guest log, guestlog.html, have the proper permissions set. They must be writable by the user that the Web server runs as. You can either change the owner of the files to the Web server user (often nobody), or just make the files world writable. It's up to you.

NOTE

If you're a Windows user (especially one who's running the Web server as yourself), you don't need to worry about this. All of the scripts will be able to write to the data files already.

These concepts are universal to all CGI scripts that write to local files, so I'll elaborate some. Under UNIX and Windows, all processes run as a particular user. For example, if I log into a computer running UNIX and start a Web browser, the Web browser process will run under my user ID. When the Web server is started, the process runs under the user ID that started it, or under the user ID that's assigned to the process. For security purposes, the Web server processes are often assigned to the user ID nobody, which has few, if any, privileges. To change the owner of the guestbook and log file to the user ID nobody, the following commands are used:

chown nobody guestbook.html guestlog.html

If you opt not to deal with changing the owner of these files, you can just give all the users on the server write access to them. The big problem here is that if the computer on which the guestbook runs is used by multiple users, they'll all have the ability to modify that file. If you're worried about that, you should change the owner to the Web server user. If that's not a concern, you can just use the chmod command to provide write access to the files to all users on the system. The following command is used:

chmod o+w guestbook.html guestlog.html

Testing the Script

After you're done with the installation, you should be able to run the script. If it isn't working, read over the documentation again to make sure that you've set everything up properly. Then, if it still won't work, check out the next section of the hour to find out how to debug your CGI scripts. When the script is working, the guestbook will appear in your browser as it does in Figure 3.1.

Figure 3.1 The guestbook from the NMS project.

Customizing the Look and Feel

After you have the script working, you can edit all of the files associated with the guestbook to align them with the look-and-feel of your Web site. There are some instructions on customizing the files associated with the guestbook in the documentation. To view the guestbook on my Web site, use the following URL:

http://rc3.org/cgibook/guestbook/guestbook.html

In Figure 3.2, you can see the addguest.html script after its appearance has been changed to fit the design of my Web site.

Figure 3.2 A customized version of the addguest.html file.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020