#
# ----------------------
# DBMan for ARVILL
# ----------------------
# Database Administrator
#
# File: html.pl
# Description: This file contains all the HTML that the program generates.
# Author: Alex Krohn
# Web: http://www.gossamer-threads.com/
# Version: 2.05
# CVS Revision: $Id: html.pl,v 1.3 2000/07/08 18:14:40 alex Exp $
#
# COPYRIGHT NOTICE:
#
# Copyright 1997 Gossamer Threads Inc. All Rights Reserved.
#
# This program is being distributed as shareware. It may be used and
# modified free of charge for personal, academic, government or non-profit
# use, so long as this copyright notice and the header above remain intact.
# Any commercial use should be registered. Please also send me an email,
# and let me know where you are using this script. By using this program
# you agree to indemnify Gossamer Threads Inc. from any liability.
#
# Selling the code for this program without prior written consent is
# expressly forbidden. Obtain permission before redistributing this
# program over the Internet or in any other medium. In all cases
# copyright and header must remain intact.
#
# Please check the README file for full details on registration.
# =====================================================================
##########################################################
## HTML Globals ##
##########################################################
# Put any globals you like in here for your html pages.
$html_title = 'Arvill Products For Hire Database';
##########################################################
## Record Layout ##
##########################################################
sub html_record_form {
# --------------------------------------------------------
# The form fields that will be displayed each time a record is
# edited (including searching). You don't want to put the
#
tags for each field.
# The values to be displayed are in %rec and should be incorporated
# into your form. You can use &build_select_field, &build_checkbox_field
# and &build_radio_field to generate the respective input boxes. Text and
# Textarea inputs can be inserted as is. If you turn on form auto
# generation, the program will build the forms for you (all though they may
# not be as nice). See the README for more info.
my (%rec) = @_;
($db_auto_generate and print &build_html_record_form(%rec) and return);
my $font = 'Font face="Verdana, Arial, Helvetica" Size=2 Color=#003399';
print qq|
|;
}
sub html_record {
# --------------------------------------------------------
# How a record will be displayed. This is used primarily in
# returning search results and how it is formatted. The record to
# be displayed will be in the %rec hash.
my (%rec) = @_; # Load any defaults to put in the VALUE field.
($db_auto_generate and print &build_html_record(%rec) and return);
my $font_color = 'Font face="Verdana, Arial, Helvetica" Size=2 Color=#003399';
my $font = 'Font face="Verdana, Arial, Helvetica" Size=2';
print qq|
|;
}
##########################################################
## Home Page ##
##########################################################
sub html_home {
# --------------------------------------------------------
# The database manager home page.
&html_print_headers;
print qq|
$html_title: Main Menu.
$html_title: Main Menu
<$font_title>
Main Menu
Permissions: |;
print " View " if ($per_view);
print " Add " if ($per_add);
print " Delete " if ($per_del);
print " Modify " if ($per_mod);
print " Admin " if ($per_admin);
print " None " if (!($per_view || $per_add || $per_del || per_mod));
print qq|
<$font>
Welcome to the Arvill product Hire database. Use our search facility to find the tools and equipment you need.
|; &html_footer; print qq|
|;
}
sub html_footer {
# --------------------------------------------------------
# Print the menu and the footer and logo. It would be nice if you left
# the logo in. ;)
#
# We only print options that the user have permissions for.
#
my $font = 'Font face="Verdana, Arial, Helvetica" Size=2';
print qq!
<$font>!;
print qq!| Menu !;
print qq!| Add ! if ($per_add);
print qq!| View ! if ($per_view);
print qq!| Delete ! if ($per_del);
print qq!| Modify ! if ($per_mod);
print qq!| List All ! if ($per_view);
print qq!| Admin ! if ($per_admin);
print qq!| Log Off |!;
print qq!
!;
# Print the Footer -- note: a link (doesn't have to be the graphic) is required unless you purchase
# a license. See: http://gossamer-threads.com/scripts/register/ for more info.
print qq!
!;
}
sub html_search_options {
# --------------------------------------------------------
# Search options to be displayed at the bottom of search forms.
#
print qq~
Search Options:
Match Any
Match Case
Whole Words
Reg. Expression
Keyword Search (will match against all fields)
Max. Returned Hits
Sort By:
Sort Order:
Search Tips:
- use '*' to match everything in a field)
- put a '>' or '<' at the beginning to to do range searches.
~;
}
##########################################################
## Adding ##
##########################################################
sub html_add_form {
# --------------------------------------------------------
# The add form page where the user fills out all the details
# on the new record he would like to add. You should use
# &html_record_form to print out the form as it makes
# updating much easier. Feel free to edit &get_defaults
# to change the default values.
&html_print_headers;
print qq|
$html_title: Add a New Record.
|;
}
sub html_add_success {
# --------------------------------------------------------
# The page that is returned upon a successful addition to
# the database. You should use &get_record and &html_record
# to verify that the record was inserted properly and to make
# updating easier.
&html_print_headers;
print qq|
$html_title: Record Added.
$html_title: Record Added
<$font_title>
Record Added
<$font>
The following record was successfully added to the database:
|; &html_record(&get_record($in{$db_key})); print qq|
|; &html_footer; print qq|
|;
}
sub html_add_failure {
# --------------------------------------------------------
# The page that is returned if the addition failed. An error message
# is passed in explaining what happened in $message and the form is
# reprinted out saving the input (by passing in %in to html_record_form).
my ($message) = $_[0];
&html_print_headers;
print qq|
$html_title: Error! Unable to Add Record.
|;
}
##########################################################
## Viewing ##
##########################################################
sub html_view_search {
# --------------------------------------------------------
# This page is displayed when a user requests to search the
# database for viewing.
# Note: all searches must use GET method.
#
&html_print_headers;
print qq|
$html_title: Search the Arvill Database.
|;
}
sub html_view_success {
# --------------------------------------------------------
# This page displays the results of a successful search.
# You can use the following variables when displaying your
# results:
#
# $numhits - the number of hits in this batch of results.
# $maxhits - the max number of hits displayed.
# $db_total_hits - the total number of hits.
# $db_next_hits - html for displaying the next set of results.
#
my (@hits) = @_;
my ($numhits) = ($#hits+1) / ($#db_cols+1);
my ($maxhits); $in{'mh'} ? ($maxhits = $in{'mh'}) : ($maxhits = $db_max_hits);
&html_print_headers;
print qq|
$html_title: Search Results.
$html_title: Search Results
<$font>
Your search returned $db_total_hits matches.
|;
if ($db_next_hits) {
print " <$font>Pages: $db_next_hits";
}
# Go through each hit and convert the array to hash and send to
# html_record for printing.
for (0 .. $numhits - 1) {
print "
|;
}
sub html_view_failure {
# --------------------------------------------------------
# The search for viewing failed. The reason is stored in $message
# and a new search form is printed out.
my ($message) = $_[0];
&html_print_headers;
print qq|
$html_title: Search Failed.
|;
}
##########################################################
## Deleting ##
##########################################################
sub html_delete_search {
# --------------------------------------------------------
# The page is displayed when a user wants to delete records. First
# the user has to Search the Arvill Database to pick which records to delete.
# That's handled by this form.
&html_print_headers;
print qq|
$html_title: Search the Arvill Database for Deletion.
|;
}
sub html_delete_form {
# --------------------------------------------------------
# The user has searched the database for deletion and must now
# pick which records to delete from the records returned. This page
# should produce a checkbox with name=ID value=delete for each record.
# We have to do a little work to convert the array @hits that contains
# the search results to a hash for printing.
my ($status, @hits) = &query("mod");
my ($numhits) = ($#hits+1) / ($#db_cols+1);
my ($maxhits); $in{'mh'} ? ($maxhits = $in{'mh'}) : ($maxhits = $db_max_hits);
my (%tmp);
&html_print_headers;
print qq|
$html_title: Delete Record(s).
|;
}
sub html_modify_form {
# --------------------------------------------------------
# The user has searched the database for modification and must now
# pick which record to modify from the records returned. This page
# should produce a radio button with name=modify value=ID for each record.
# We have to do a little work to convert the array @hits that contains
# the search results to a hash for printing.
my (%tmp);
my ($status, @hits) = &query("mod");
my ($numhits) = ($#hits+1) / ($#db_cols+1);
if (($numhits == 1) and !$in{'nh'}) { $in{'modify'} = $hits[$db_key_pos]; &html_modify_form_record(); return; }
my ($maxhits); $in{'mh'} ? ($maxhits = $in{'mh'}) : ($maxhits = $db_max_hits);
&html_print_headers;
print qq|
$html_title: Modify Record.
|;
}
sub html_modify_form_record {
# --------------------------------------------------------
# The user has picked a record to modify and it should appear
# filled in here stored in %rec. If we can't find the record,
# the user is sent to modify_failure.
my (%rec) = &get_record($in{'modify'});
if (!%rec) { &html_modify_failure("unable to find record/no record specified: $in{'modify'}"); return; }
&html_print_headers;
print qq|
$html_title: Modify a Record.
|;
}
sub html_modify_success {
# --------------------------------------------------------
# The user has successfully modified a record, and this page will
# display the modified record as a confirmation.
&html_print_headers;
print qq|
$html_title: Record Modified.
$html_title: Record Modified.
<$font_title>
Record Modified
<$font>
The following record was successfully modified:
|; &html_record(&get_record($in{$db_key})); print qq|
|; &html_footer; print qq|
|;
}
sub html_modify_failure {
# --------------------------------------------------------
# There was an error modifying the record. $message contains
# the reason why.
my ($message) = $_[0];
&html_print_headers;
print qq|
$html_title: Error! Unable to Modify Record.
|;
}
##########################################################
## Authentication ##
##########################################################
sub html_login_form {
# --------------------------------------------------------
# The login screen.
&html_print_headers;
print qq|
$html_title: Login.
|;
}
sub html_login_failure {
# --------------------------------------------------------
# There was an error loggin in. The error message is stored in $message.
my ($message) = $_[0];
&html_print_headers;
print qq|
$html_title: Login Error.
|;
}
sub html_admin_display {
# --------------------------------------------------------
# The displays the list of current users.
my ($message, $user_list, $password, $permissions) = @_;
&html_print_headers;
print qq|
$html_title: User Management.
|;
}
sub html_unauth {
# --------------------------------------------------------
# A user tried to do something he was not authorized for.
&html_print_headers;
print qq|
$html_title: Error! Unauthorized Action.
$html_title: Error! Unauthorized Action.
<$font_title>
Error: Unauthorized Action
<$font>
The database program received a command that you are not authorized for.
|; &html_footer; print qq|
|;
}
sub html_signup_form {
# --------------------------------------------------------
# This form is displayed for new users who want to create an account.
#
my $error = shift;
&html_print_headers;
print qq|
$html_title: Create Account.
|;
}
sub html_signup_success {
# --------------------------------------------------------
# The user has successfully created a new account.
&html_print_headers;
print qq|
$html_title: Account Created.
|;
}
##########################################################
## Misc ##
##########################################################
sub html_unkown_action {
# --------------------------------------------------------
# The program received a command it did not recognize.
&html_print_headers;
print qq|
$html_title: Error! Unknown Action.
$html_title: Error! Unkown Action.
<$font_title>
Error: Unknown Action
<$font>
The database program received a command that it did not understand.
|; &html_footer; print qq|
|;
}
sub html_print_headers {
# --------------------------------------------------------
# Print out the headers if they haven't already been printed.
if (!$html_headers_printed) {
print "Content-type: text/html\n\n";
$html_headers_printed = 1;
}
}
1;