Beijing Paradise BBS Backup

home *** CD-ROM | disk | FTP | other *** search

/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / 125ADEV.ZIP / 125A.DEV next >

Wrap

Text File | 1993-08-08 | 25.5 KB | 943 lines

POWERBOARD BBS 1.25A DEVELOPER'S KIT First Edition Copyright 1993 NuIQ Software, Inc. All Rights Reserved CORRESPONDENCE: NUIQ SOFTWARE, INC 415-A Richbell Road Larchmont, New York 10538 Tel: (914) 833-3479 Fax: (914) 833-3623 BBS: (914) 834-7830 (hst) (914) 833-1479 (v32bis) FIDO 1:272/37 RIME 'THESWING' INTRODUCTION: This package is meant for professional software developers only. This package is not intended for the amateur bulletin board operator or programmer. There will not be any attempts made for the documentation to be understandable by "non-programmers". For those interested in running a BBS using the Powerboard software, please be aware that the software is completely configurable without the need of using a lower level programming language. Please call NuIQ Software for information on the Powerboard software. Information provided herein is intended for Third Party authors who are developing add-ons for the Powerboard software. All other uses are strictly forbidden. PREFACE ------- Our goal at NUIQ SOFTWARE has always been to offer the highest quality software available. The Powerboard Source Code and Record Formats that are provided with this package are done so in good faith. FREE REGISTRATION Any third party author who will be using the information provided in this package for a long period of time is expected to register with NUIQ SOFTWARE by filling out the Third Party Author Registration Form. NUIQ SOFTWARE keeps on file a list of current Third Party Authors, contact information, and the products they produce. Information provided is subject to change. When releasing a new version of the Powerboard Software, NUIQ SOFTWARE does not make any guarantees as to backward compatibility. Registered Third Party Authors will recieve updates to the Powerboard file layouts and other helpful information. POWERBOARD SOFTWARE PACKAGE Third Party Authors who have not already purchased the Powerboard software may do so at a reduced rate. The software is available (one per author) at a 25% discount. Contact NUIQ SOFTWARE for details. LOW-LEVEL CODE & FILE LAYOUTS Code for low-level operations in Powerboard is available at an additional cost after signing a non-disclosure agreement. Without purchasing the Powerboard software, the extended developer's kit costs $100. Authors who have purchased the Powerboard software are entitled to recieve the extended developer's kit for $50. EXTENDED DEVELOPER'S KIT INCLUDES INFORMATION ON: o Multinode Interaction o Powermail Door o Bottom Status Line Configuration o Menu Developer Codes o Waiting-For-Calls Screen Pull Down Menu Codes o EXTERN.LIB External Command Library examples o File Area .NDX (File Index), .SZ, .DTB and .DTX Files TABLE OF CONTENTS ----------------- Node Settings (NodeX.INF) .......................................... 8 BBS Log Files ...................................................... 13 PROTOCOL Files ..................................................... 15 Modem String Files ................................................. 18 Security Files ..................................................... 19 PBANSI Standard .................................................... 22 Time Bank .......................................................... 24 Message Area ....................................................... 25 Doors .............................................................. 26 User File Access ................................................... 27 File Area/Conference Setup ......................................... 28 File Area Listing File (FILES.BBS) ................................. 31 Multinode Network User Listing File ................................ 32 BBS Vital Data File (BBS.DAT) ...................................... 34 Last Caller Information File ....................................... 35 Event Configuration File ........................................... 39 NODE SETTINGS (NodeX.INF) ------------------------- Line Description ---- ----------- 1 Sysop First Name 2 Sysop Last Name 3 Sysop's Password in user file 4 BBS Name 5 Full path to DOOR.SYS for this node 6 Full path to error log 7 Full path to callers log 8 Number of seconds until keyboard timeout disconnect 9 Path to chat log 10 Main BBS path 11 Locked baudrate (NONE if none) 12 Allow hardware (cts/rts) flow control? 13 Allow software (xon/xoff) flow control? 14 Main waiting for calls screen 15 2nd waiting for calls screen 16 Hercules main waiting for calls screen 17 hercules secondary waiting for calls screen 18 Basic prompts text file (basic.txt) 19 basic prompt ansi file (basic.ans) 20 ANSI Screen to show when sysop presses F8 disconnect 21 ASCII Screen to show when sysop presses F8 disconnect 22 Com port to use 23 Baud rate 24 Inital control file to load at log-on 25 Max characters for waiting for screen modem stats box 26 Blank screen allowed? 27 Time until blank 28 Seconds to wait after send to modem 29 Answer on modem ring? 30 string to send for answering (ATA) 31 Allow printing? 32 Re-init modem time... 0=no re-init 33 Allow abortion of screens? 34 Show box when screen is blanked? 35 Beeps enabled? (ON,OFF) 36 ASCII screen to show if user must be disconnected due to event 37 ANSI screen to show if user must be disconnected due to event 38 Local only? (not use modem) 39 ANSI screen to show if user does not press key for a long time and is disconnected 40 ASCII screen to show if user does not press key for a long time and is disconnected 41 ANSI screen to show if user does not press key for a long time (warning) 42 ASCII screen to show if user does not press key for a long time (warning) 43 ANSI screen to show when initalizing CHAT 44 ASCII screen to show when initalizing CHAT 45 ANSI screen to show when ending CHAT 46 ASCII screen to show when ending CHAT 47 ANSI screen to show when user runs out of time 48 ASCII screen to show when user runs out of time 49 Number of seconds of inactivity before "keyboard timout" warning 50 Slow down display for old CGAs (flickering) 51 Allow screen restore in chat? 52 Conceal password? 53 Beep at connect? 54 Clear scren at connect? 55 Invalid keys at Yes/No ask before defaulting 56 Yes/No default 57 Show ansi when user is in ascii? 58 New user security 59 Show bottom status line? 60 New user time limit 61 Message area database path 62 Aborting character for screens (32=space, -1=any) 63 Tab length in message entry 64 Default file area listing file (usually areas\farea1) 65 Function key screen path 66 Allow 300 baud? 67 If no, 300 baud disallowed screen filename (with path) 68 <<blank line here>> 69 Min disk space 70 ascii switch 71 Multinode chat/work path 72 Sec needed to override private mail flag 73 ANSI screen to show for multinode chat help 74 ASCII screen to show for multinode chat help 75 ANSI screen to show for "time on" in multinode chat 76 ASCII screen 77 ANSI screen to show for "/who is on" in multichat 78 ASCII screen to show for "/who is on" in multichat 79 Minutes before time warning (default 3) 80 ANSI time warning screen 81 ASCII 82 file attached to msgs dir 83 show dots in multinode chat 84 Color for sysop in sschat 85 Color for user in sschat 86 Number of welcome screens (welcome command) 87 Sysop password 88 Sysop Sec 89 Instant windows? 90 Default filename extention (zip) 91 Use true baudrate from door.sys? 92 Ansi filename extention 93 ascii filename extention 94 oldest file accepted day 95 oldest file accepted month 96 oldest file accepted year 97 Allow swap to disk? 98 Comment to sysop if invalid password? 99 100 Kill Lines? (Yes) 101 102 Base address value (eg. &h02e8, 0=use default) 103 IRQ (0=default) 104 Allow handles? (use first & last name when %fname% is called) BBS LOG FILES ------------- CALLERS.NODE - List of general reports while callers are online. Text file (variable record length), each line terminated by cr/lf. Line format: Start Length Description ----- ------ ----------- 1 3 Code for activity type. Example: !!=Startup, --=General, **=Connect Message, >>=Log On, <<=Log out 5 10 Date in format MM-DD-YYYY 16 8 Time in format HH:MM:SS, 24-hour 24 1 Ascii 58 (':') 26 EOL Log Entry ERROR.NODE - Error Log. Logs fatal errors. No standard format. CHAT.NODE - Chat Log. If Sysop turns chat log on, the log will be written to this file. UPLOAD.NODE - Upload Log. All uploads are logged to this text file. Format: FILENAME uploaded at HH:MM on MM-DD-YY by NAME. Example: DRWY220.ZIP uploaded at 23:35 on 02-23-92 by John Smith. DOWNLOAD.NODE - Download Log. All downloads are logged to this file. For batch downloads, the format is: PATH\FILENAME downloaded by NAME at HH:MM on MM-DD-YY. Example: \bbs\files\pbsw\HAKCTLS.LZH downloaded by John Smith at 23:04 on 10-26-92. For single-file downloads, the format is: FILENAME downloaded by NAME at HH:MM on MM-DD-YY. PB120-1.ZIP downloaded by John Smith at 08:43 on 11-09-92. PROTOCOL FILES -------------- Powerboard protocols are executed from batch files. These batch files are created from template files (called .BT files). The .BT files are stored in the PROTOCOL\ directory that branches off of the main Powerboard directory. A list of available protocols for a given operation can be obtained by getting a directory listing of the PROTOCOL\ directory. Valid operations are as follows: Code Function ---- -------- -D Download File -U Upload File -AU Attach Upload (single-file only) -AD Attach Download (single-file only) -VD Zipview Download (single-file only) Example: Template File Function ------------- -------- ZB-D.BT Zmodem Batch Download Z-D.BT Zmodem Single-File Download ZB-U.BT Zmodem Batch Upload Z-U.BT Zmodem Single-File Upload Z-AD.BT Zmodem Attached File Download Z-AU.BT Zmodem Attached File Upload Z-VT.BT Zmodem Zipview Download The characters before the operation represent the calling keys for the protocol. They can be as long as filenames permit, however, should not be longer than 2 characters because of the fact that Powerboard stores only 2 character keys in the DEFAULT PROTOCOL field in the user record. COMMONLY USED IMBEDDED TEXT CODES Code Function ---- -------- %BAUD% Current Baudrate %LBAUD% Locked Baudrate %PORT% Com Port (1,2,3,4,5, etc) %BBSP% BBS Path %NODE% Node Number ^:1^ Batch Upload file #1 ^:2^ Batch Upload file #2 %FILPATH% Download Path %VAR%D Filename MODEM STRING & RESULT FILES --------------------------- MODEM.NODE - Initalization string to send. OFFHOOK.NODE - String to send to take phone off the hook. ONHOOK.NODE - String to send to put phone on the hook. CONNECT.NODE - Connect messages in format: CONNECT MESSAGE,BAUDRATE Example: CONNECT 19200,19200 SECURITY FILES -------------- SECS.BBS - Defines securities. Format: SEC,Desc Example: 100,Sysop Default Powerboard configuration: 10,New User 20,Verified User 30,Visiting Sysop 50,Subscriber 100,Sysop/CoSysop RATIOS.BBS - Upload to download ratios. Format: SEC,DOWNLOADS_BEFORE_UPLOAD Example: 10,15 Gives a 15:1 ratio to security 10 users. TIMELIMS.NODE - Time limits for users. Format: SEC,TIME Example: 10,45 Gives 45 minute per day limit to Security 10 users. PHONES.DAT - List of all phone numbers currently being used. If a user tries to log on using a number in here, their account is sent to review by the Sysop. Their name is then automatically added to BADNAMES.BBS. BADNAMES.BBS - List of names that cannot be contained in user names, Example: Doctor Death Screw PBANSI STANDARD --------------- Powerboard control files, messages and displays where the first line says PBANSI use PBANSI display codes. If the current user is in ASCII, PBANSI codes are ignored. If the current user is in ANSI, they are interpeted. Code Function Code Function ---- -------- ---- -------- $0$ Black Background &0& Black Foreground $1$ Blue Background &1& Blue Foreground $2$ Green Background &2& Green Foreground $3$ Cyan Background &3& Cyan Foreground $4$ Red Background &4& Red Foreground $5$ Purple Background &5& Purple Foreground $6$ Brown Background &6& Brown Foreground $7$ White Background &7& Dark White Foreground &8& Gray Foreground &9& Bright Blue Foreground &10& Bright Green Foreground &11& Bright Cyan Foreground &12& Pink Foreground &13& Bright Purple Foreground &14& Yellow Foreground &15& White Foreground TIME BANK --------- The internal time bank for Powerboard has no limit for the ammount of time that can be stored, unless a MAXLIMIT.DAT file exists in the BANK\ directory, in which case the first line of the text file represents the number of minutes that can be stored at maximum. Each user has no time stored in the bank, unless a file exists with the filename of their user record number plus the .DAT extension. Example: 1.DAT Means user #1 has the ammount of time specified on line 1 of 1.DAT stored in the bank. BBS VITAL DATA FILE (BBS.DAT) ----------------------------- If your program absoultely must modify the BBS.DAT file, it should first back it up to an UNUSED filename (i.e. don't assume that there is no .BAK, .OLD, etc). The format for BBS.DAT is as follows: BBS Start Date Number of callers Last Message Written Date Last Message Written Time Last File Uploaded Date Last File Uploaded Time EVENT CONFIGURATION FILE ------------------------ If events are active for a given node, the file NODE.EVT will exist in the main BBS directory. The format is as follows: HH:MM DESCRIPTION ,ERRORLEVEL,DAY,KICKOFF Example: 00:00 Test Event ,000,00,Y LAST CALLER INFORMATION FILE ---------------------------- LASTUSER.DAT - Contains information about the last user on the system. When a user logs off any node on the system, this file is written to the main BBS directory. Format: Offset Length Description ------ ------ ----------- 0 40 User Name 40 25 Phone Number 65 40 Calling From 105 40 Sysop's Memo on User 145 2 Signed Integer - Uploads 147 2 Signed Integer - Downloads DOORS ----- To add a door to the BBS, first create a batch file called DOOR<N>.BAT. Next, modify the doors menu display, usually in the DISPLAY directory, filename DOORS.ANS/.ASC. The BBS will exit with error level 80 and type in "DOOR" at the DOS prompt, which executes a template-created DOOR.BAT. The batch file needs to re-load Powerboard on the same node that it came in on. If developing a door program, suggest that in the inital batch file for loading Powerboard set an environment variable such as NODE. Powerboard creates the DORINFO<NODE>.DEF and DOOR.SYS files on exit. If the BBS is run on a single-node (no network/sharing capability), the file is called DORINFO0.DEF. On multinode, nodes start with 1 (DORINFO1.DEF). The format for the Powerboard DORINFO0.DEF is as follows: BBS Name Sysop First Name Sysop Last Name COM Port (COM1, COM2, etc. COM0=Local) <SPEED> BAUD,N,8,1 <SPEED> = Baudrate <SPEED> User's First Name User's Last Name City, State 0 Security Level Time Left 0 <blank> Powerboard Serial Number Example: The Swing BBS NUIQ SOFTWARE COM3 14400 BAUD,N,8,1 14400 Scott Brown Larchmont, NY 0 51 29 0 - SN#1 When Powerboard returns from a door program, it reads in the file PBDOOR.NODE. The format for PBDOOR.NODE is: BAUD RATE - LOCAL if local mode, otherwise baudrate to open port at USER NAME USER PASSWORD CALLING FROM TIME LEFT USER NUMBER MINUTES PAST MIDNIGHT WHEN ENTERED DOOR DATE WHEN ENTERED DOOR GRAPHICS MODE (ANSI,ASCII,RIP) COMMANDLINE USED TO LOAD POWERBOARD TIME LIMIT PER DAY CHAT REQUESTED TEXT (Blank if user did not req. chat) LAST CONTROL FILE LOADED BPS CONNECTED AT (If different from port speed) MULTINODE NETWORK USER LISTING FILE ----------------------------------- Offset Length Description ------ ------ ----------- 0 1 Available for chat? (Y/N) 1 40 User Name 41 40 Calling From 81 10 Baud Rate 91 40 Current Activity REFER TO: WHO.BAS, WHO.EXE FILE AREA/CONFERENCE SETUP -------------------------- Message area names and data are specified in the MSGAREAS.BBS data file. The format for MSGAREAS.BBS is as follows: Offset Length Description ------ ------ ----------- 0 60 Message Area Name 60 2 Security Level Required for access 62 1 Private Allowed? (Y/N) 63 1 Forced Private? (Y/N) 64 1 Forced Public? (Y/N) 65 1 Netmail Allowed? (Y/N) 66 1 Ignore Scan Flags? (Y/N) 67 1 Forced Netmail? (Y/N) REFER TO: AREASEE.BAS, AREASEE.EXE File areas branch off of message areas. File areas are defined in the file FAREA<CONFERENCE>.BBS, stored in the AREAS\ sub-dir. The format for this text file is: Area Name Security,Path REFER TO: FAREASEE.BAS, FAREASEE.EXE FILE AREA LISTING FILE (FILES.BBS) ---------------------------------- The File Area Listing file is in the following format: FILENAME.EXT FILESIZE FILEDATE DESCRIPTION Example: DM57.ZIP 123092 07-19-93 Doormaster door conversion utility. If the description is more than one line, the next line in FILES.BBS for a given file area will not contain a filename, filesize, and file date. USER FILE ACCESS ---------------- The user file format is as follows: Offset Length Description ------ ------ ----------- 0 5 Last Time Online 5 1 Mail Waiting? (Y/N) 6 1 Locked Out? (Y/N) 7 1 Length of user's name 8 40 User Name 48 1 Street Line 1 Length 49 40 Street Line 1 89 1 City,St Length 90 40 City,St 130 1 Password Length 131 20 Password 151 1 Phone Number Length 152 15 Phone Number 167 1 Work Number Length 168 15 Work Phone Number 183 1 Birthdate Length 184 9 Birthdate 193 1 Last On Length 194 9 Last On Date 203 2 Time Left on last call 205 2 Number of times on 207 2 Number of Uploads 209 2 Number of Downloads 211 1 Length of first call date 212 9 First Call Date Length 221 1 Subscriber (Y/N)? 222 1 Subscription Date Length 223 9 Subscription Expiration Date 232 2 Last Download Area 234 2 Last Upload Area 236 2 Last Message Area 238 2 User Security Level 240 2 Kbytes Downloaded 242 2 Kbytes Uploaded 244 1 Expert Mode? (Y/N) 245 1 Length of graphics mode text 246 15 Graphics mode text 261 2 Screen Length 263 1 Length of Memo text 264 40 Memo text 304 1 Length of Last Baudrate text 305 10 Last Baudrate text 315 1 Computer Using Text Length 316 20 Computer Using Text 336 2 Carrier Dropped Times 338 2 Chat Req Times 340 2 Times disconnected by Sysop 342 2 Default Protocol Text 344 1 Length of last New Files check text 345 8 New Files Check text 353 1 Default Multinode Available for Chat 354 39 Reserved for future use REFER TO: USERINFO.BAS, USERINFO.EXE USERFILE.NDX Index File: The User Index file for Powerboard is a text file, in the format: USER NAME<179>PASSWORD<179>CALLING FROM<179>RECORD<179>LOCKEDOUT The User's Name MUST be in all capital letters. LOCKEDOUT is either 0 for not locked out, or 1 for locked out. RECORD is the user's record in the USERFILE.DAT, starting with record 1. Example: SCOTT BROWN│MYBBS│Larchmont, New York│1│0 MESSAGE AREA ------------ READING USER'S CONFERENCE SETTINGS The Message Area sub-directory is defined in NODE<NODE>.INF (discussed earlier), however, it is most often referred to as the MESSAGES\ dir. Users define their conference settings. The conference settings are stored in the <CONFERENCE>.USR, located in the MESSAGES\ dir. The format for <CONFERENCE>.USR is as follows: Offset Length Description ------ ------ ----------- 0 4 High Read Number 4 4 High Scan Number (Obsolete in v1.25A+) 8 1 Selected? (Y/N) 9 1 Mail Waiting? (Y/N) REFER TO: USERCONF.BAS, USERCONF.EXE MESSAGE HEADER FILES The format for the message header file, <CONFERENCE>.MES is as follows: Offset Length Description ------ ------ ----------- 0 1 User From Length 40 40 User From 41 1 To Name Length 42 40 To Name 82 1 Private? (Y/N) 83 1 Sent-Date Length 84 8 Sent-Date 92 1 Sent-Time Length 93 8 Sent-Time 101 2 Replies? 0=No 103 1 Start Line in .TX file 107 4 End Line in .TX file 111 1 Message Subject Length 112 50 Message Subject 162 1 Flagged for deletion? (Y/N) 163 1 Message has been recieved (Y/N) 164 2 Times message has been read 166 1 Has been sent Netmail? (Y/N) 167 3 Reserved 170 1 File Attached? (Y/N) 171 2 Reserved 173 13 Attach Filename 186 1 Send by Netmail? (Y/N) 187 4 Message Number 191 4 Previous (Rev. Thread) Message # 195 61 Reserved .TX Database file (stores actual message text) is in following format: Offset Length Description ------ ------ ----------- 0 1 String Length 1 127 String Text If an ascii #1 is at the end of a text line, it signifies a line-feed. REFER TO: MESSREAD.BAS, MESSREAD.EXE