FileScroller 3.20 ================= GiftWare By Eric Sauvageau July 23th, 1993 0-Summary ~~~~~~~~~ 1-About. 2-Needed. 3-Installation. 4-Configuration. 5-The Main prompt. 6-The Options prompt. 7-Movement keys. 8-The AFR. 9-The logfile. 10-The Sysop Module. 11-Special Notes. 12-Legal Stuff. 13-Support. 14-History. 1-About: ~~~~~~~~ FileScroller is an ARexx script written for TransAmiga 1.1 BBS and up. Its main purpose is to replace the actual "List Files" command of the file area by a better, nicer, and more complete one. Just to mention a few of its features... o Can let the user scroll up and down the listing. o View the list in normal order, alphabetical order, or just new files. o View a text file alone or contained within an archive. o Select a file for viewing or marking via a cursor method, using AFR, my "Ansi File Requester" ;). o Multi-node friendly. o Fully support comments presents in your Files.BBS. o A custom Browse Mode, allowing backward and forward browsing. o An optional logfile. o Complete set of utilities for the Sysop (Sysop Module). o Fully bilingual, supporting English and French. o Optional support for 'Gios' Magschok's "NumFiDL". (Also support "GTAFiDl" from John Marchant.) o A complete and versatile Config section. o And much more! 2-Needed: ~~~~~~~~~ - Some AmigaDOS command are essential to the good working of FileScroller. You must have in your C: directory those commands: o Copy o FileNote o Join - You must be using TransAmiga 1.1 or higher. I recommend using 1.11 when possible. - ARexx and RexxSupport.library. 3-Installation: ~~~~~~~~~~~~~~~ First, you must copy the "FileScroller.trans" in your REXX: drawer with all thoses .trans files. You will also have to copy all the files from the Text/ directory to your BBS:Text/ drawer. Move the "FileSort" and the "CreateList" programs to your BBS:Bin/ directory. FileSort's job is to sort Files.BBS listings, while CreateList is aimed at file list processing. Next, you'll have to edit your "File.rx" file (in the BBS:Configs/ drawer) to look like this: ; ********************** *** ******** ************************************** L File Listing 10 -------- FileScroller.trans You will also have to edit your "File.cmds" (in the same drawer) and change the line of the original List Files command to use a different key, and to adjust its access to 256, disabling it. You could also leave the original file listing as is, and simply assign another key for the FileScroller: it's entirely up to you! If you need help about how to edit those two files, just look in your TransAmiga's docs for a complete explanation. Now, you can create an header txt file, for the (D)ownload filelist command. This text file will be added to the begining of the file created by this function. The path and the filename should be specified in FileScroller's Config section, as the TextHeader parameter. Note that this file is purely optional: if you don't create one, FileScroller will simply put your BBS name as the default header for the FileLists generated. Finally, you'll have to edit the config part in "FileScroller.trans" to suit your system. Those lines can be easily found in the first lines of the script. 4-Configuration: ~~~~~~~~~~~~~~~~ The first parameter let you select between English ('1'), or French ('0'), as FileScroller's language. You could also insert here your own routin that will define which language FileScroller will use for each user entering the Scroller. On PowerLand BBS, as an example, we're checking the access level for determining wich language the Scroller should use. You could also use flags if you prefer. Finally, if you feel adventurous, you could try to translate French into another language (like German). If you try this, I wish you best of luck! ;) /* Selected language. '1' = English, '0' = French. */ /* You could also insert your own language-selection routin here... */ Language = 1 The second parameter is the number of different transfer protocols actually configured in your TransAmiga's configuration. /* How many transfer protocols are supported by your system. */ Protocols = 1 The third parameter is the minimum access required to enter the Sysop Module. /* Minimum access required for accessing the Sysop Module */ SysopLevel = 200 The next one is a flag that will enable ('1') or disable ('0') the logging option. /* Set the following to '1' to enable FileScroller logging. */ LogActive = 0 There, you should give the complete path and filename of the logfile. If you aren't using the logging option, just leave it as is. Also, don't worry about the BBS node: the node number will be automaticaly linked to the end of the log's filename. /* Here you put the path and the filename of the log. */ LogFile ='BBS:System/FScroller.log' This one will tell to FileScroller if it must use its own custom "View Archive" function, or use the "ViewArchive" ARexx command provided by TransAmiga 1.11. This flag is here only for compatibility with both TransAmiga's versions (1.1 and 1.11). /* Set this to '1' if you are using TransAmiga 1.11 or higher. */ ViewArchiveFlag = 0 Next parameter will enable ('1') or disable ('0') support for Gio's "NumFiDL" program. "NumFiDL" is a program that put a download counter before each description. GTAFiDl will also work with this option. /* Set this to '1' if you are using Gio's "NumFiDL" script. */ NumFiDL = 0 Next variable will tell FileScroller where to stop when doing a '>' (Next Area) area change. You should put there what is the LAST file area available (including restricted ones). This flag will allow FileScroller to skip unavailable areas until it finds one that suits requirements (like access levels and flags), or will go back to the initial area when reaching HighArea + 1. This variable is also used in the Download FileList command, when doing a "ALL" FileList. /* Set this to the highest available file area number */ HighArea = 50 Next line will tell to FileScroller where to put files extracted from an archive for online reading. Be sure to have at least 100K-200K free there, or set this to somewhere on your hard disk. /* Where extracted text goes. */ DestDir = 'T:' This variable will tell FileScroller what file to append at the begining of the file listings created by its (D)ownload FileList command. Note that this file is optional: if you don't want to use one, just leave this variable as it is; FileScroller will see by itself if he can find the file, and will generate his own small header if he can't find it. /* Path and name of the file to be used as an header for the file listings */ /* downloaded from FileScroller */ TextHeader = 'BBS:Text/ListHeader.txt' Now, you will have to tell FileScroller how it should deal with each diferent archives types, and disable those that you do not want to support. This part is divided into three columns: In the first column, you will put the archiver program, and its path if it isn't located in C:. Also, if you want to disable one kind of archive (let's say .ZIP processing), you will have to put "OFF" as the archiver program (change "UnZip" for "OFF" in my example here). If you're not sure about what I mean, just look at the configuration example below. Second column is the switches used by the archiver to display the listing of that type of archive. Third column is the switches used by the archiver to extract a file from it. At the end of each line there is a small comment about the archive type configured there. DO NOT change their order!!! Just disable the one you don't want by giving it an archiver filename of "OFF". Here is an example of configuration: /* Next part is about archive handling. */ /* To disable one archive type, just tell "Com.? = 'OFF'" , and leave the remainder of its line untouched. Archiver Filename ; List Switches ; Extract Switches */ Com.1 = 'LhA' ; Switch.1 = 'vv' ; Extract.1 = 'e' /* .lha & .run files */ Com.2 = 'LhA' ; Switch.2 = 'vv' ; Extract.2 = 'e' /* .lzh files */ Com.3 = 'Zoo' ; Switch.3 = 'l' ; Extract.3 = 'x' /* .zoo files */ Com.4 = 'Arc' ; Switch.4 = '-v' ; Extract.4 = '-e' /* .arc files */ Com.5 = 'OFF' ; Switch.5 = '-v' ; Extract.5 = '-x' /* .zip files */ Com.6 = 'UnArj' ; Switch.6 = 'v' ; Extract.6 = 'x' /* .arj files */ In this example, .zip files are disabled. That mean that they will be treated as a binary file that can't be viewed. At last, the FileScroller should be ready for use! Note: If you have an AREXX compiler, I strongly suggest you to compile the script after you have finished adjusting the config section. The speed gain will be really appreciable! 5-The Main prompt: ~~~~~~~~~~~~~~~~~~ When you will do a listing of a file area, FileScroller will invoke CreateList, who will create a custom listing in the T: directory. When finished, FileScroller will show you the first page of this listing. The listing is divided in columns that are self-explanatory. In the bottom of the screen, a two-line prompt will appear. On the last line, you will see the movement keys (more about them later), and the Help key ('?'). The main prompt in itself is just above. Let's see what are the available commands. (A)rea change: This one will let you go into another file area. (M)ode: Will let you select between different listing modes: I) Normal listing: Will display a normal listing, in the same order as in the Files.BBS file. Usually, it will be starting with the oldest upload, and finishing by the most recent one. II) New Files listing: Will list only the files uploaded since a cutoff date that FileScroller will ask you. By default, it will be your last call date. III) Sorted listing: Will sort the file listing in one of these ways: by name, by date, or by file size. Also, you'll be asked if you want a reversed sort, where the listing would be sorted in the reverse order: starting with latest uploads if sorted by date, with the 'z???' filenames if sorted by name, or with the biggest files if sorted by size. IV) Browse mode listing: Let you scan through the listing, one file at a time. With each file you will get the habitual infos, plus the name of its uploader, and a long description (if any). You will have the options of going back one file, go to the next file, change the current file area, search files matching a pattern, mark the file or view the file displayed on the screen at this moment. So, it's quite the same thing as the original "Browse" of TransAmiga. All movements are controlled via the same movement keys, as in the Main Prompt. Note that there is one additional movement key available when in browse mode. This is the Jump key (#), that let you go directly to a specified file using its number. This way, you could jump immediately to the 57th file of the listing, without having to browse all the other files. All you will have to do is to press the '#' key, and then enter '57' at the prompt. (R)edraw: Will simply redraw the entire screen, in the case it would be corrupted by line-noise or by an online message sent by the BBS. (Q)uit: Well... Do just what it says: leave the FileScroller :) (O)ptions: Will give you some more commands. See below for this one. Also, not showed in the prompt is the ($)ysop Module. If you press this key ('$'), have sufficient access (see "SysopLevel" parameter), and are in Normal Listing mode, you'll enter the Sysop Module. We'll see about it later. If you're asking why the '$' key is never displayed in the prompt, this is essentially for security purposes: nobody will know how to access it even if they are behind you when you're entering the Sysop Module. 6-The Options Prompt: ~~~~~~~~~~~~~~~~~~~~~ When you enter this one, a new prompt will appear: D)ownload FileList: Will gather the file listing from some areas selected by the user, sort the files by their name or by the date they where uploaded, and download the resulting listing (archived in an .LHA archive). NO download will be credited to the user. (so it's FREE! Yeah! :) If present, a text file (defined in the config area) will be added to the begining of the listing as an header, so you could put complete informations about your BBS there. (I)nfos: Will do (almost) the same as TA's "Info" command of the File prompt: it will let the user select a file via the AFR (more about the AFR later), and then view its length, the name of the uploader, and so on. (M)ark file: Allow the user to mark one or more files for downloading, using the AFR. Do not forget that TA is only allowing a maximum of 10 marked files. (R)ead file/archive: This one will allow te user to select a file using the AFR, and then read this file if it's a text file, or display the archive listing and select a file in it for reading, if it's a recognized archive format. FileScroller will first look at the first bytes of the file to see if it's a known archive format, and then at the extension. Any file not recognized as an archive or a knwon binary file (i.e. .BIN, .IFF and so on) will be treated as a text file! So be cautious with crunched files or binary files without recognizable extension. (S)earch File: Will search the listing for a giving pattern matching a filename or a file's description, just like in Browse Mode. 7-Movement Keys: ~~~~~~~~~~~~~~~~ The movement keys lets you scroll the listing, by using the numeric keypad, or the arrow keys. Arrow Up / 8 - Scroll one page up (one line up if in the AFR.) Arrow Dwn / 2 - Scroll one page down (one line down if in the AFR.) Arrow Lft / 7 - Go to the first page (first line if in the AFR.) Arrow Rgt / 1 - Go to the last page (last line if in the AFR.) 0 - Go down five pages (five lines if in the AFR.) The Return key will also scroll the listing one page (or one line) down. 8-The AFR: ~~~~~~~~~~ This one stands for "Ansi File Requester" :). That's a function that I wrote for FileScroller that let the user select the file that he want to process (it could be for marking, reading, viewing, or something else). When the user select an (O)ptions described above, the AFR will be called. The AFR will highlight the first file in the listing, and then will let the user select the file he wants via the (8) and (2) keys, just like if he was using cursors in a standard file requester, and then press RETURN when the correct file is highlighted. As for the (0) key, it will simply go 5 entries down. If the user know the filename and don't see it in the displayed page, then he can use the (E)nter filename command (there is a prompt in the bottom of the screen with the available commands), and then type in the name normally. He can also abort the AFR by pressing (Q)uit. Also, the cursor keys can do just the same thing when scrolling: Up/Down arrow keys go up or down one line, while left and right arrow go to the first and the last file on the screen. The help key ('?') will bring up a short text explaining the available functions of the AFR. Last word about the AFR: it should be intelligent enough to skip comments or blank lines. 9-The LogFile: ~~~~~~~~~~~~~~ FileScroller feature a complete logging function, that will allow you (or your Co-Sysops) to see what your users are doing in your file areas. Are they viewing lots of text files? Browsing through your files areas? To toggle ON or OFF this feature, just adjust the appropriate flag in the config section ("LogActive"). You must also select where to put the logfile on your hard disk, and wich filename to use. I recommend you to put it in your BBS:System/ directory, where the TransAmiga log is usually located. This is done with the "LogFile" parameter. 10-The Sysop Module: ~~~~~~~~~~~~~~~~~~~~ This FileScroller's "module" is new from version 3.00. It is a set of goodies that can be real handy to a Sysop or a remote CoSysop. The access will be granted only to those whose access is greater or equal to the one assigned in the Config section to the "SysopLevel" parameter. The Sysop Module allow a Sysop to do various maintenance in his files areas, without leaving the FileScroller. Also, since he can use the AFR, that results in a much easier way to do maintenance in the files areas. IMPORTANT: You must be in a NORMAL listing mode to enter the Sysop Module! If you aren't, you'll be refused access to it. Here is a summary of the available functions: (A)rea Change: Go to another File Area. (D)elete: Allow you to erase a file from the listing and/or the hard disk. (Just like TA's "Kill File"). (E)dit: Allow you to freely edit a file description. You'll be prompted with the actual description, allowing you to change it (up to a maximum of 40 caracters). NOTE: If you are using the NumFiDL option, don't forget to leave the [?] download value in your description! (V)iew logfile: Allow you to read FileScroller's log, and then delete it if you wish so. (M)ove: Allow you to move one file from the current file area to another file area. (Just like TA's "Move File"). (R)edraw: Will redraw the entire screen. (Q)uit: Return to FileScroller's main prompt. 11-Special Notes: ~~~~~~~~~~~~~~~~~ -FileScroller rely HEAVILY on ANSI codes. So, nothing fancy for ASCII users: FileScroller will simply fallback to the original TA listing. I was originaly planning to do an ASCII version, but I don't feel like re-writing another Scroller just for the ASCII version. -If a user have a screen length of '0' (continual listing), then FileScroller will assume a screen length of 23 lines. -FileScroller can crash when it encounters a filename with a space within it or a filename longer than 20 characters. Those kind of files are allowed by AmigaDOS, but since it's most unusual in a file area, I didn't add any special code to handle those. So you're warned ;) 12-Legal Stuff: ~~~~~~~~~~~~~~~ Some boring stuff following now... :( I'm not responsible for bugs, data losses (?), damages (??), lost wife (?!?!) or any problem you can have when using FileScroller. FileScroller was tested toroughly, and is used regularly on our BBS without any problems. This whole archive (with the exception of FileSort and its specificaly related files) is GiftWare. If you like it, I ask you to send me a ittle something: could be a few bucks (CAN$ or US$ only), a registered version of one of your program, demos, old original games you don't want anymore, or simply a postcard from your country. See "Support" below for the address. I'm not asking too much, in fact it's just enough to encourage me to continue my work on it. I keep ALL the rights on FileScroller and CreateList: you CAN'T spread modified versions, or ask money for them. If you have any suggestions, questions, or simple comments (feedback is always appreciated!), you can send me a netmail at 1:242/907.0. FileSort is from Rod Schnell, who gladly offered it for inclusion in FileScroller. Thanks Rod! Finally, I apologize for any mistakes in those docs... I'm doing my best (with the help of my good 'old English/French dictionary next to me!) to give you some decent docs... I just hope that there is more mistakes in my English than in my ARexx code ;) 13-Support: ~~~~~~~~~~~ You can reach me on this BBS where I'm the Co-Sysop: Powerland BBS Sysop: Marc Chabot (Registered TA #7007) Phone: (514) 965-7295 Rosemere, Quebec (Canada) SupraFax 14.4K - V32bis/V42bis Fully bilingual (English/Français) FidoNet: 1:242/907.0 You can send your contribution (do you remember? It's GiftWare :) to: Eric Sauvageau 5336, 10th avenue Montreal, Que. Canada H1Y-2G6 I can be reached on FidoNet at 1:242/907.0. You can also contact me via the TransAmiga echo. The latest version of FileScroller is available for FReq'ing under the magic name FSCROLL. Thanks goes to my Sysop Marc, Tim Aston (for TransAmiga) and Roger Clark (for the help in the installation of FidoNet on our BBS and various suggestions for FileScroller). Also, thanks to Michel Brunette for his help, and Rod Schnell for FileSort. Finally, big thanks to all TransAmiga Sysops who are using FileScroller, and had sent comments about improvements or suggestions. So let's keep Scrollin' ;) 14-History: ~~~~~~~~~~~ 1.00 to 1.20: -Never released, personal versions. 1.21: -First public release. 1.22: -Added Multi-Node support 1.30: -Added Redraw option -Now display the number of pages. -Added support for file listing headers: any line of text starting by a '\' in the Files.BBS will be displayed without being counted as a file. -Some cleaning in the display. 2.00: Major upgrade with lots of new stuff in it! Among those changes: -A modified version supporting NumFiDL is included in the archive. -Added the AFR for selecting files. -Better support for file list comments. -Added Read text/archive function, with automatic detection of the file type. -Added Info command. -Code cleanup for speed (worked a lot on that: still a bit slow on a simple 68000, but quite usable) and better error handling. -Found and corrected some minor bugs. -Added Top/Bottom keys. -Added function to change file area without leaving the Scroller. -Rewrote those docs. 2.02: -Some code optimisations. -List was redrawed with a (M)ode command even if the user stood with the same current mode. -Now you can just press Return to go down one page, in addition with the '2' key. -FileScroller would crash if a user entered via the keyboard a wrong filename to be viewed. 2.10: -Added "<" & ">" in the Change Area command to go to the previous or the next FileArea, and a "?" to see the available areas. -Various changes to the prompts. - * MUCH FASTER * scrolling! At last I found a way to use a pointer for the file instead of having to re-read it from the begining at each page scroll. Alas, the listing will be as slow as it was when doing a "New File" listing, because I have then to check each line of the listing: I must skip old files when searching the requested page to read and display. But that's still a great improvement, especially for 68000 based Amigas working on a 200+ files listing! -Will warn the user if a non-existing filename is entered in the AFR via the keyboard. -Added support for cursor keys (Finally it's there!). -Added an help key in the main prompt and in the AFR. -When listing file areas, FileScroller will now check for an existing "FileLibs.XXX.ANSI" and send it instead of doing a simple ListFileAreas when possible. 2.20: -NEW:Added a bi-directional custom Browse mode, with a search file option. -Totally changed the look of the (I)nfos On File command: now have the same look as the new custom Browse mode. -BUG FIXED:It is no longer possible to change (M)ode when in an area without a single file. -Now you can mark more than one file without leaving the AFR. -Should be a LOT less CPU-hungry than the last version, since I found a way to use GetChar instead of a looped MayGetChar when reading the user command. (For the curious: did you know that the first character sent by an arrow-key could be $1b, $5b or $9b, depending if you were locally or remotely, and if I was using GetChar or MayGetchar??? Well, finally found WHICH ones are recognized with GetChar!) -Removed the "(V)iew archive option". The same function could be performed with "(R)ead file/archive", so it was quite useless. -BUG FIXED: If a user was doing a "(I)nfo on file", and had given the filename via "(E)nter on keyboard" in the AFR, some infos would be missing. 3.00: Another major release! Lots of new goodies: -NEW: Sysop Module. Now you can edit file descriptions, kill a file or move it using the AFR, and without leaving FileScroller. -NEW: Fully bilingual, actually supporting English and French. -NEW: Optional logfile. -NEW: Cutoff date for the (N)ew Files mode. -Now can FULLY support middle-list comments in the Files.BBS. The AmigaDOS "Sort" command is no longer required, being replaced by "ScrollSort". Do not forget to copy it your C: drawer. -New parameters in the Config section: o "HighArea" (Allow for a more flexible Change Area function). o "SysopLevel" (Limiting access to Sysop Module). o "NumFiDL" (Enable/disable NumFiDl support). o "Language" (Select wich language FileScroller should use). o "LogActive" (Enable/disable the LogFile). o "LogFile" (Path and filename of the LogFile). The "ArchTypes" parameter of the config section is gone. The archive processing configuration part is sligthly different. -BUG FIXED:The filename would be incorrectly returned by the AFR if it was exactly 20 characters long. -BUG FIXED:Pointer would be incorrect if a user was doing an Area Change in the Browse Mode for another area containing comments. -BUG FIXED:The user's name wasn't put in its Node Location. -Rewrote the archive processing function for a safer and faster one. From now, you are no longer able to add new kinds of archives, but I think that those already included should be enough. Just tell me if you find another one that could be usefull, and it should be added in the next release of FileScroller. -Now you can view more than one file from the same archive without having to reselect again the same archive for each files. -Added "(V)iew File" command in the Browse Mode. Do the same thing as the one in the "(O)ptions" command. -Added "(S)earch File" command in the (O)ptions prompt. -Now, (S)earch File will also look into the file's description. This is the way TA is doing it too... -From now, the NumFiDL and the regular version are the same. You can select if you wish regular version or NumFiDL version via the new "NumFiDL" parameter. -Faster display when scrolling pages in all modes (including New Files). -Now FileScroller will count by increments of 5 when creating the custom listing. This changes results in a faster creation, and should be a benediction for users who are in 2400 bauds on a fast (i.e.: 68030) BBS. -Many others small code enhancements. 3.10: From now, FileScroller is GIFTWARE! See "Disclaimer" for infos. -SPEED ATTACK! When under Kickstart 2.04 or better, now use my new "CreateList", included in this archive for the file list creation. If Kickstart 1.2/1.3 is detected, then FileScroller will fallback to the same ARexx function as in 3.00. Just take a look at these results on a list containing 483 files, on my A1200 (68020): ARexx CreateList function : 50 seconds. Binary CreateList command : 7 seconds! See "CreateList.doc" for more infos on this. -NEW: Added a "(0)Jump 5" key. Allow you to go 5 pages down (or 5 files down if in the AFR). -BUG FIXED: Small bug in the Config part that would prevent .zip & .arj archives to be correctly processed. -BUG FIXED: The ".Desc" file wasn't properly deleted when moved from one area to another in the Sysop Module, due to a pending Open() on it. -Now able to process -lh0- through -lh5- archives. -lh0-, and -lh2- to -lh5- will be handled as .lha archives. -Added .JPG and .OWS to known binary file types. -Smarter screen refresh handling. -Logging of logfile deletion now specify which node was deleted. -Now when (E)diting file description, will give you the actual description as default, for inline editing. 3.11: -BUG FIXED:CreateList 1.05 included. See "CreateList.doc" for more infos on it. -Added a note in the docs: GTaFiDL is fully compatible with FileScroller and the NumFidl switch. -Slight change in the display. 3.12: -Interim beta-version. Never released. 3.20: -NEW: CreateList 1.10 included; now handle paths up to 250 characters long, and FULLY 1.3 compatible (hooray!). -NEW: ScrollSort was replaced by Rod Schnell's FileSort. That gave me the possibility to add a few more List Modes (see below). -NEW: New (O)ptions gadget: (D)ownload FileList. Lets you select some file areas, and download their listings. -NEW: "TextHeader" parameter added. -NEW: Replaced the Alphabetical mode by a more versatile Sorted mode. Now, you'll be able to sort a listing by the filenames, the dates, or the files sizes. Also, you'll be able to sort the listing in normal, or reverse order. -BUG FIXED: Since version 3.00, .RUN internal file viewing function was broken. Now fixed. -BUG FIXED: Now, when entering a blank line as a new file description in the Sysop Module, the file will keep his original description, instead of having a stupid "RESULT" as description. -If changing area while in a list mode different than Normal, now you'll stay in the same list mode. -Comment lines are now supported in Sorted list mode too. -From now, the two executables (CreateList & FileSort) should be copied to your BBS:Bin/ directory, rather than in your C: directory. -Slight changes in the display. -IMPORTANT! Powerland BBS address had changed since last release. The current address is 1:242/907.0. --- Eric Sauvageau (Merlin). "When I'm walking a dark road," "I am a man who walks alone." -Iron Maiden. ---