home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
High Voltage Shareware
/
high1.zip
/
high1
/
DIR2
/
AREQ1_1B.ZIP
/
AUTOREQ.DOC
< prev
next >
Wrap
Text File
|
1994-01-10
|
30KB
|
658 lines
AddTech Consultancy Limited
▐█████████████████▌ PO Box 862
▐██▌ ▐██▌ ▐██▌ Bristol, BS99 2JH
▐██▌ ▐██▌ ▐██▌ ENGLAND
▐████████▌──▐██▌──┐
▐██▌ ▐██▌ ▐██▌ │ You can contact AddTech Consultancy by
▐██▌ ▐██▌ ▐██▌ │ leaving a message for the Sysop at:
│ │ │ │
│ │ │ ┌──┐ │ Transworld BBS:
│ │ │ │ │ │
┌──┘ └──┤ └──┘ │ +44 (0) 272 444025 2400 baud
└────────┴────────┘ +44 (0) 272 444026 14400 baud
+44 (0) 272 444027 14400 baud
Or on The Internet as "astevens@cheshire.demon.co.uk"
Table Of Contents:
Disclaimer...........................................................ii
Introduction.........................................................ii
What is AutoRequest?.................................................ii
Configuration:.......................................................iii
How does AutoRequest scan for mail?..................................v
Why should I register?...............................................v
Creating your own messages:..........................................v
Automated Information Services (What on Earth is it!?)...............vii
QWKREQ...............................................................viii
How do I register AutoRequest?.......................................x
If you are outside the USA:....................................x
If you are within the USA:.....................................x
LICENSING AND DISTRIBUTION AGREEMENT.................................xi
COPYRIGHT AND TRADEMARK RECOGNITION..................................xii
ii
Disclaimer
AddTech Consultancy makes no warranty of any kind, either express or
implied, including but not limited to implied warranties of
merchantability and fitness for a particular purpose, with respect to
this software and accompanying documentation.
IN NO EVENT SHALL ADDTECH CONSULTANCY BE LIABLE FOR ANY DAMAGES
(INCLUDING DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS
INTERRUPTION, LOSS OF BUSINESS INFORMATION, OR OTHER PECUNIARY LOSS)
ARISING OUT OF THE USE OF OR INABILITY TO USE THIS PROGRAM, EVEN IF
ADDTECH CONSULTANCY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
AutoRequest Documentation for WildCat! BBS systems version 3.xx
AutoRequest is copyright 1994 by AddTech Consultancy Limited.
Introduction
The first thing I should mention is that I'm not very good at writing
documentation! - I'm a programmer by trade, and a Sysop by mistake!
Unfortunately utilities such as this do require a little
documentation, and so this is my limited attempt as such! Shakespeare
would not be impressed, but then again, I doubt if he could run a
BBS! :-)
By the way, to avoid any flames I should state that I have used the
male pronoun exclusively when referring to 'The User' and 'The
Sysop'. This is not to imply that only males participate in BBSing.
The only reason I have done this is to avoid ugly compromises like
'(s)he', 'him/her' and so on!
What is AutoRequest?
AutoRequest is a WildCat! 3.xx Sysop utility which enables users to
download requested files automatically within their TomCat QWK
packets. All the user needs to do is send a message to a user called
"FILE REQUEST", with the name of the file he wants to receive in the
subject line. If a password is required to download the file, then
the subject line should contain first the file name, then the
password, separated by a space. For example:
From: ADAM STEVENS
iii
To: FILE REQUEST
Subj: ANYFILE.ZIP THEPASSWD
The user needs to have an understanding of the "attached files"
option within TomCat to be able to utilise this utility. If the user
requests a file, yet has not set his "attach" option in TomCat, then
he will be sent a message explaining how to configure TomCat to
receive attached files (This message is configurable with the
registered version of AutoRequest).
AutoRequest fully supports the WildCat! databases, and will update
the user and file download count accordingly (unless the file is
marked as "Free", in which case a download will not be added to the
users account).
AutoRequest currently will not support files on CD via the excellent
"RomDoor" program (by Jeff Bisson), but future versions may do
depending on what happens with WildCat! 4 and CD support.
AutoRequest needs to be run as an event every now and again. Probably
once or twice a day depending on the number of requests your users
are sending.
If a user requests a file which isn't available, then a message will
be sent to him explaining exactly why it was unable to attach the
file. This includes request which will take the user above his or her
upload:download ratio, above the daily file count or kilobyte limit,
or files which reside in a file area which he does not usually have
access to.
Registered users of AutoRequest will also be able to create their own
messages to send to users, but more about that later! By default,
AutoRequest will pause for 10 seconds after processing any requests.
This countdown can be cancelled by pressing any key or, in the
registered version, by starting AutoRequest with the "/X" parameter.
But the registered version of AutoRequest is more than just a system
for distributing files. It is also offers a full "Automated
Information Services". For more information on this, read on!
Configuration:
Configuring AutoRequest is *very* easy. Personally I hate having my
WildCat! directories full of .CFG files, and because of this, almost
all of the configuration is done internally by AutoReq.
iv
The first thing to do is to create a new security level via MAKEWILD
called "FILEREQ". The *only* things you need to configure with this
security level is the access to "conferences" and "download files
areas". AutoReq will read this information, will only allow file
request messages in the selected conferences, and will only download
from the selected download areas. (Note that even if you select *all*
the download areas, the user will still only be allowed to download
from an area which he usually has access to). Obviously, under normal
circumstances, you don't want to give the FILEREQ security level
access to any networked message areas. Although if you are running a
small TNET echo then it should be possible for users on one BBS to
request files on the other BBS (Just remember that it's you, as the
Sysop, who will be footing the phone bill! <g>).
The only other thing you need to do is to check that you have a DOS
variable called "WCHOME" which contains your home WildCat! path.
i.e., SET WCHOME=J:\WC
Note the lack of a space between "WCHOME" and "="
If you wish, you can also create a file called AUTOREQ.XRF in the
same directory as your AUTOREQ.EXE. In effect, this file is a look up
table which AutoRequest will use to assign names to various files.
This is a plain ASCII file, and contains the "real" filename, and the
"pseudo" filename separated by a comma, for example:
FILELIST.ZIP,ALLFILES
TWORLD-1.ZIP,MS-DOS
TWORLD-2.ZIP.UNIX
This enables the user to request a file by a pseudo name. (i.e.
ALLFILES for FILELIST.ZIP). The user *MUST* prefix the name with
"//".
For example, a message looking like the following:
From: ADAM STEVENS
To: FILE REQUEST
Subj: //MS-DOS
Will send a private message to ADAM STEVENS, with the file "TWORLD-
1.ZIP" as an attachment.
It is up to you, the Sysop, to inform your users as to which files
you have assigned to which "//" names (if any).
With the registered version of AutoRequest, the XRF file is also used
to specify "Automated Information Services" (more about that later!).
v
There is also another pseudo filename available called "/HELP". This
will send the user a message about AutoRequest, and how to use it.
With registered versions of AutoRequest, this message can be created
by the SysOp.
AutoRequest will keep a log file in the same directory as AUTOREQ.EXE
called AUTOREQ.LOG.
How does AutoRequest scan for mail?
There are several ways in which it is possible to scan for new mail
within the WildCat! message databases. As you may notice, AutoRequest
is a little slower scanning than a product such as TomCat. The reason
for this is that AutoRequest is written in a way to make it easier
for you as a Sysop to "reprocess" any requests. If for any reason you
need to reprocess a previously requested file then all you need to do
is run WCPRO (or some other utility which allows you to change the
message "receive" flag), and set the corresponding message as
"Unreceived". The next time you run AutoRequest this message will be
processed again. The result of this is that if you have a large
number of messages, then AutoRequest may take a minute or two to run.
However as it will usually be run as an event, speed is not as
essential as it may otherwise be.
It is recommended that you renumber the message conferences which
allow requests on a semi-regular process to speed up operation. Maybe
you would like to create a special message conference purely for file
requests?
Why should I register?
You are more than welcome to use AutoRequest for a trial period
without registering. All the main features of AutoRequest work
perfectly well in the non-registered version. However you do get a
few extras with the registered version:
1) A nice warm feeling inside that you are helping future
development of AutoRequest and other WildCat! SysOp utilities.
2) Full support via Internet, snail-mail, or my Bristol based BBS.
3) The ability to use your own messages instead of the in built
ones.
4) Automated Information Service!
Creating your own messages:
vi
With this archive file, you should have received a few text files
ending in .MSG, these files are demonstrations of what is possible
with the registered version of AutoRequest. You can create your own
message files which will be sent to users depending on the result of
the request. These files are:
OKAY.MSG Sent to the user if everything was okay with the
request.
TOMCAT.MSG Sent to the user if the attached file is included,
but he has not set-up TomCat to receive attached
files.
RATIO.MSG Sent to the user if the attachment failed because he
is above his upload:download ratio.
RATIOW.MSG Sent to the user if he is above his upload:download
ratio, but his security level allows continued
downloads with a warning sent.
DAILY.MSG Sent to the user if the attachment failed because he
is above his daily limits.
HELP.MSG Sent to the user if he leaves a message to "FILE
REQUEST" with the subject line "/HELP".
PASSWORD.MSG Sent to the user if the attachment failed because a
wrong (or no) password was given.
FREE.MSG Sent to the user if the attached file is a "Free
Download".
FAILINFO.MSG Sent to the users if AutoRequest was unable to find
the specified file associated with "Automated
Information Services" (see below).
These files should be placed in the same directory as the AutoRequest
program file.
Most of the standard WildCat! "@" codes may be used in the message,
plus a couple of extras which display the file name and file
description. A full list follows...
@VER@ @BBS@ @SYSOP@ @TMSG@
@TUSER@ @TFILE@ @TCALLS@ @USER@
@FIRST@ @PHONE@ @FROM@ @CPU@
@CALLS@ @MEMO@ @SEC@ @SINCE@
@LASTON@ @UPK@ @UPS@ @DOWNK@
@DOWNS@ @MAXDL@ @MAXDK@ @EXDATE@
@BDATE@
(See your WildCat! manual for a description of the above)
Specifically for AutoRequest:
@FILE@ The file requested.
@DESC@ The description of the file. Remember that this
description can be up to 60 characters in length.
vii
Automated Information Services (What on Earth is it!?)
Though out this documentation I've mentioned something called the
"Automated Information Service". With the registered version of
AutoRequest 1.1 or above you can specify a number of text files which
the user can ask to be sent to him on request. If you are a
registered owner of AutoRequest 1.0, then don't worry, your KEY file
will work perfectly well with this new version.
You, the Sysop can configure AutoRequest so that the user just has to
send a message to FILE REQUEST with a subject line beginning with a
forward slash to automatically receive, as a message, any text file
you want to make available.
For example, you could configure AutoRequest to send your WildCat
bulletins on request, or you could create a price list or product
list which the user can read whenever he wants to.
All the configuration for this is done in the AUTOREQ.XRF file, an
example of which is included with this archive. The format is similar
to the "pseudo filenames" format, except that the first parameter of
each line must refer to a full path and filename instead of simply a
filename as stored within the WildCat! file database. For example,
part of your AUTOREQ.XRF file may look like the following:
Messages:
J:\WC\BULL\BULLETIN.MSG,BULL-LIST
J:\WC\BULL\BULL1.MSG,BULL1
J:\WC\PRICES\PRICES.TXT,PRICES
You *must* have a line containing nothing except "Messages:" between
your pseudo filename settings, and your Automated Information
Services settings.
Using the above example, a message sent as:
From: ADAM STEVENS
To: FILE REQUEST
Subj: /PRICES
would send the text file "J:\WC\PRICES\PRICES.TXT" as a message to
user Adam Stevens (me!). This file may contain any of the above
listed @ codes. However, because messages do not support colour, it
may not contain any of the WildCat! colour @ codes (such as "@3E@").
To make life easier, I have included a program file in this archive
called STRIPCOL.EXE which you can use to automatically strip WildCat!
colour codes from any text file (to be precise, it creates a new
file, so there's no problem with it overwriting your original colour
version). The format to use it is very easy, simply type:
STRIPCOL <in-file> <out-file>
viii
at the MS-DOS prompt, where <in-file> is the file containing WildCat!
colour codes, and <out-file> is the name of the new file to be
created without colour codes. Obviously if you have bulletins which
you wish to make available to AutoRequest users, then you must be
sure to run STRIPCOL whenever the bulletin is updated (put it in your
batch file if the bulletin is created automatically).
Of course, another possible use for this feature is the ability to
create a number of FAQ lists (Frequently Asked Questions) which you
can then automatically send to any users you want. (I wonder how many
times I've been asked by users how to set up TomCat for example!).
QWKREQ
QwkRequest is the user side of AutoRequest. It was written by Jason
Hyland, and should have been included in this archive file as
QWKREQ.ZIP. It is recommended that you make this file available to
your users as it will make it easier for them to use AutoRequest. I
strongly recommend that you read the documentation file included in
the QWKREQ.ZIP file, but here's a brief summary of a suggested set-up
for Automated Information Services (or "Magic Requests" as Jason
insists in calling them! :-).
Magic Requests:
Magic Requests are a nifty idea. They benefit both the
user and the Sysop. They benefit the user because of the
ease of selecting them, and the use of "standard"
requests. For example, how often have you logged onto a
BBS and wanted the filelist. Is it called FILELIST.ZIP ?
ALLFILES.ZIP ? HANGAR.ZIP ? or any one of a 100 other
different ideas that Sysops have. Wouldn't it be nice for
a user to just say "I want a File List!" and be done with
it ? Well, QwkRequest and AutoRequest make this dream
come true!
If you're a Sysop you know how demanding running a BBS
can be. If your like me, you spend a fair amount time
sending new users FAQ files, or details of subs, or any
number of other bits of information. Problem is you have
to do it over and over again! Now you as a Sysop can set-
up a .MGC file to have QwkRequest and AutoRequest cut
down on all that (some say unproductive) time you spend
on it.
ix
In QwkRequest's main work area you will see a window
called Magic Requests with at least five entries in it
(these are hard coded for the sake of trying to implement
some common standard!). These request generate the
following request;
AutoReq Help Message:
Ask AutoRequest at the BBS end to send you a help message
detailing how to use AutoRequest.
BBS File List:
Ask AutoRequest to send you a full file list
BBS Subscription Details:
Ask AutoRequest to send you a message detailing
subscription schemes and costs.
Bulletins Available :
Ask AutoRequest to send you a message listing all the
bulletins carried on the BBS
Mail Area Conference :
Ask AutoRequest to send you a message Listing, listing
all the message conferences on the BBS
There may well be other Magic requests there - it depends
if the Sysop has created a '.MGC' file and if you have it
in the QWKREQ directory.
Magic File Support For SysOps
If you are a Sysop using AutoRequest I hope you will
support these Magic request - they offer some excellent
benefits to you and your users.
To start with you should support the 5 default magic
requests as detailed above. These generate the following
'Request' on the Subject Line of the request message;
AutoReq Help Message /HELP
BBS File List //FILELIST
BBS Subscription Details /SUBS
Bulletins Available /BULL
Mail Conferences Listing /CONFLIST
The /HELP message is in built to AutoRequest. The others
need to be Configured, which means that your AUTOREQ.XRF
file should look something like this;
HANGAR.ZIP,FILELIST
Messages:
J:\WC30\MSGS\SUBSINFO.TXT,SUBS
x
J:\WC30\BULLS.LST,BULL
J:\WC30\CONFLIST.TXT,CONFLIST
Note that FILE REQUEST just need the filename as it
appears in the WildCat Database. Messages require a
pathname !
Additional AUTOREQ.XRF entries should be made for any
.MGC entry you may make.
'.MGC' File Format for SysOps.
If you want to let your users benefit from the extensive
possibilities that Magic Requests offer you need to
create a '.MGC' file for your users to download. The
format of the '.MGC' file is;
;
; Example .MGC file for Hangar BBS (44) (0) 934 511751
;
/USER,User Account Details
/TIMETAB,Events Timetable & Mailruns
/TOPTEN,Hangar Top Tens
/RULES,The Hangar Rules !!
/SECLEV,Security Access Levels
//FAQ,Frequently Asked Questions File
/NETMAIL,How to Send Netmail
The magic 'code' is entered before the ',' (comma), and
the description is entered after it. No spaces are
allowed between the comma and the code or description.
The code is limited to 14 characters in total, and the
description is limited to 35 characters (it gets chopped
if longer).
How do I register AutoRequest?
If you are outside the USA:
Registration is a matter of #25 (25 Pounds sterling) sent to: AddTech
Consultancy Ltd, (AutoRequest), PO Box 862, Bristol, BS99 2JH,
ENGLAND. (Cheques to be made payable to "AddTech Consultancy Ltd.").
If you are a resident of the UK then please add 17.5% VAT (a full VAT
receipt can be supplied on request). Please state the name and number
of your BBS system, together with a required login ID and password
for Transworld BBS. I will create a KEY file, and place it on
Transworld for you to download.
If you are within the USA:
xi
US registration for AutoRequest costs $40 (Forty US dollars). Cheques
(sorry, "checks" <g>) should be made payable to "AddTech Consultancy
Limited" and sent to:
C.C.S. OnLine BBS
PO Box 2181
Montgomery, AL
36102-2181
Once payment is received you will be able to dial into C.C.S. OnLine
BBS on 205-281-9114 or 205-281-1331 and download a KEY file directly.
Please state the name and number of your BBS system together with a
required login ID and password for C.C.S. OnLine BBS with your cheque
and they'll be a KEY file waiting for you within a couple of days!
-------------------------
I would honestly *love* to hear your views about AutoRequest. Both
positive, and negative feedback would be very gratefully received. I
intend to support AutoRequest as much as I am able to, and I'll
always be looking for ideas for future versions. You can contact me
in several ways: By "snail-mail" at the address at the top of this
documentation, directly at my BBS in Bristol, England (+44 (0) 272
444026/7), by Internet as "astevens@cheshire.demon.co.uk", or
hopefully in the MSI:WildCat! conference, although I don't read that
as much as I should! - By far the best way for me is via the
Internet.
LICENSING AND DISTRIBUTION AGREEMENT
Licensing and Distribution Agreement
Copyright (C) 1993, 1994 by AddTech Consultancy Limited. ALL RIGHTS
RESERVED. COMMERCIAL DISTRIBUTION AND/OR USE PROHIBITED WITHOUT
WRITTEN PERMISSION FROM AddTech Consultancy Limited. Non-Commercial
distribution and/or use is permitted under the following terms:
1) You may copy and distribute copies of AutoRequest executable
code as you receive it, in any medium, provided that you do so
in a lawful, friendly manner and that you conspicuously and
appropriately publish on each copy of each file that is a part
of the distribution package a valid copyright notice:
"Copyright (C) 1993, 1994 by AddTech Consultancy Limited. Any
copies that you distribute must be distributed free of charge to
the recipient of the copy. AutoRequest may not be sold and you
may not rent or lease it to any other person."
xii
2) You must keep this License Agreement intact and give any other
recipients of the AutoRequest program a copy of this License
Agreement along with the program.
3) You must distribute AutoRequest in unmodified form. You may not
add an advertisement for your Bulletin Board System, User Group,
or anything else either as a file in the distribution packet,
only as a header in any archive. You may not add, modify or
delete any of the files in the AutoRequest distribution archive.
4) AutoRequest must be distributed for free. You may not charge a
distribution fee for the physical act of transferring a copy of
this program. You may not place this program in any file area
of a Bulletin Board System where a fee is required for download.
5) You may not modify your copy or copies of AutoRequest or any
portion of it and you can not copy and distribute any
modifications.
6) You may not copy, sub license, distribute or transfer
AutoRequest except as expressly provided under this License
Agreement. Any attempt otherwise to copy, sub license,
distribute or transfer AutoRequest is void and your rights to
use the program under this License agreement shall be
automatically terminated.
7) You may not incorporate parts of AutoRequest into other programs
without the written permission of AddTech Consultancy Limited.
Permission may or may not be granted based upon a determination
of what your intended use is.
8) For the purposes of this document, "COMMERCIAL USE" is defined
as concurrent operation of the software on two or more computers
or data lines owned by the same for-profit organisation. Any
organisation may operate this software under the terms of this
Non-Commercial Agreement if operation is limited to one computer
or data line.
9) You may use the software only after understanding and agreeing
upon the above terms.
COPYRIGHT AND TRADEMARK RECOGNITION
WildCat! is a trademark and copyright of Mustang Software Inc.
TomCat is a trademark and copyright of Mustang Software Inc.
WCPRO is a trademark and copyright of Mustang Software Inc.
QwkRequest is copyright Jason Hyland.
Extracts from QwkRequest documentation reproduced by permission
of Jason Hyland.
Adam Stevens - January 1994