Cornvalley


Bug reporting

Home
FAQ

This program is a simple CGI program used to collect bug report information and send it to an appropriate email address. As part of the information, it sends the referring page which allows the recipient to get some context for the problem.

Note that this is not a task management system, it simply sends email. Thus don't expect more than is here, but you may also be able to use this to send email in situations other than reporting bug.

The expectation is that there is a link from every page to this program, either in the sidebar or in the tail of the page. This allows a single place to modify to allow user feedback.

The environment is passed along into the programs, so it would be possible to create a form with the REMOTE_USER sent as the email address if this program was protected by a .htaccess file. However, what isn't currently here is a lookup from the Accepted directory of the registration program to map that name into an email address and a full name. If there is any call for such capability, it would be easy to hack in.


In use, this program is called with a URL which looks like:

	_HOME-BIN_/bugreport.cgi?file=/Template/bugreport1.wc
This URL is referenced from a ScriptAlias or by being in an appropriate directory and having the program named *.cgi. The appropriate version depends upon the UserCGI as defined in Config/defs.wh as well as the configuration of your web server.

The basename of the file specified must must start with /bug. This is to slow down misapplication of this program being used to extract information from inappropriate files.

This file has a few special things in it to help gather information for the bug report, but mostly this is just HTML, so you can add whatever you want in the file. This program calls the bugreport.cgi program again in order to process the finished data. The results are displayed by a template file specifed within the first template file.


In normal use, you will not need to get the bugreport package by itself as it will be included by whichever application you are using. However, if you want the packages, you can get one of the following:

  • bugreport-1.07.tar.gz This is the full tar file. This is useful for doing the first installation.
  • bugreport.tar.gz. This is the file that the update program uses as data for other applications.
  • bugreporta.tar.gz. This is the bugreport application. This is used to maintain this page. Normally there is little need for people to use this version.

Cornvalley

If you have any question about the Bug reporting, send mail to regan@ao.com.

If you see something which looks like a bug, please report that as well.

You can find other programs in Regan's Cornvalley Archive.