home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / FLG2G1.ZIP / FILEGATE.DOC < prev    next >
Encoding:
Text File  |  1996-03-10  |  16.7 KB  |  438 lines

  1. FileGate document for filegate v2.00 and higher
  2.  
  3. FileGate v2.00 (c)Copyright 1996 by Tdd /Dementia '96
  4. Released under the label of DMA (Dementia)
  5. First official public release at 14/03/1996
  6.  
  7.  
  8. What's filegate?
  9. ----------------
  10.      FileGate v2.00 is a fileslister, downloader and uploader
  11.      for RemoteAccess compatible bulletinboardsoftware running
  12.      files.bbs or RA internal filedatabase. FileGate will take care
  13.      of download-counters and will start the needed protocols.
  14.      BiDirectional protocols are supported as well!
  15.      The wareztag alike lister is HIGH-speed and easy to use for
  16.      both sysop and user. Lightbars, internal (and external)
  17.      fileviewing, tagging, backscroll, all features are available to
  18.      make life and bbs'ing very relaxed.
  19.      FileGate has multinode support aswell so more than one
  20.      line should be no problem at all.
  21.  
  22.  
  23. Minimal requirements for installation:
  24. --------------------------------------
  25.      . MS-DOS 3.30 or higher
  26.      . About 530kb of FREE conventional memory
  27.      . Vga or compatible video-card (for setup)
  28.      . 80286 or better
  29.      . About 1mb of FREE harddisk space for FULL
  30.        installation of ALL features
  31.      . Remote access 2.50 or higher compatible
  32.        bulletinboard-software using files.bbs or
  33.        ra-internal filedatabase
  34.      . You must set the environment variables:
  35.        set dszlog=<path+filename>
  36.        set temp=<path>
  37.        set ra=<path>
  38.  
  39.  
  40. Included files:
  41. ---------------
  42.      The following files are needed by filegate
  43.      and are therefore included in the package (if not,
  44.      then contact the nearest support-bbs and get a
  45.      complete package!)
  46.  
  47.      FLG_LST.EXE    .    The lister
  48.      FLG_DU.EXE     .    Downloader and uploader
  49.      FLG_STP.EXE    .    Setup utility
  50.      FLG.CFG        .    Sample configuration file
  51.      FLGPROT.CFG    .    Sample protocol-configuration
  52.                          File. Includes samples for
  53.                          Gsz,BiModem and CeXYZ
  54.      FLG_LST.ANS    .    The lister ansi
  55.      PROTOCOL.ANS   .    Ansi used for protocol-selection
  56.      TAGLIST.ANS    .    Background ansi for TAGLIST-edit
  57.      FLG_UP.ANS     .    Uploadprocessor ansi
  58.      FLGTHANX.ANS   .    Ansi shown after a user uploaded
  59.                          Some files (optional)
  60.      INTRO.ANS      .    Background ansi for down- and
  61.                          Uploadmenu.
  62.      FLG_AREA.ANS   .    Background ansi for areaselector
  63.      FLG_GRP.ANS    .    Background ansi for group-selector
  64.      SEARCH.ANS     .    Ansi for keyword and newfiles-search
  65.      FLGMAIN.ANS    .    Ansi for filegate internal lightbar-
  66.                          Menu (not tested though...)
  67.  
  68.      Included protocols in the package are Zmodem(gsz),
  69.      BiModem(pampa). They are included in their original package
  70.      so you have to unpack them yourselfes.
  71.  
  72.  
  73. Installation and configuration:
  74. -------------------------------
  75.      UnZip the package in any directory you want, run
  76.      the FLG_STP.EXE and change colors, directories (non-existing
  77.      directories are generated) and switch between remote-access
  78.      or files.bbs.
  79.  
  80.      When you select COLOR-CONFIG:
  81.           - LIGHTBAR FOREGROUND
  82.                Foreground color of the lightbar
  83.           - LIGHTBAR BACKGROUND
  84.                Background color of the lightbar
  85.           - GLOBAL TEXTS
  86.                Color of the texts like (areaname or
  87.                 Search on keyword'
  88.           - FILENAME COLOR
  89.                Color of the filename in lister
  90.           - FILESIZE
  91.                Color of the size(length) of the file
  92.                In lister
  93.           - DOWNLOAD-COUNTER
  94.                Color used for the downloadcounter
  95.  
  96.           - FILENAME/SIZE
  97.                Color used for the uploaded-filename and
  98.                Size of that file
  99.           - PROTOCOL
  100.                Color of the protocol-name showed in the
  101.                Download/upload-menu
  102.           - BYTES FREE
  103.                Color used for  bytes free on uploaddisk'
  104.                And  transfertime'
  105.  
  106.      Explanation of directory-entries etc:
  107.           - PROTOCOL DIRECTORY
  108.                All protocols must be located in this
  109.                directory!
  110.           - UPLOAD DIRECTORY
  111.                The public upload-directory, uploads
  112.                that are public will be put here
  113.           - PRIVATE DIRECTORY
  114.                The private files (to sysop) will be
  115.                put here
  116.           - COMMANDLINE FOR VIRUSCHECK *
  117.                This commandline will be used while
  118.                checking the uploads for virusses.
  119.                (Tested with tbav)
  120.                Example: C:\TBAV\TBSCAN @ KI BA
  121.           - BANNERFILE *
  122.                The TEXTfile mentioned here will be
  123.                Stamped on all uploads
  124.           - COMMERCIAL FILE *
  125.                This file will be added to all uploads
  126.           - UPLOAD PROCESSOR COMMANDLINE
  127.                This commandline will be used to activate
  128.                An external uploadprocessor, use the  @' char
  129.                For passing filenames (@ will be replaced
  130.                By the file to be processed)
  131.              * FILLING THIS LINE WILL DEACTIVATE THE
  132.                INTERNAL FILEPROCESSOR !
  133.                (Tested with skullcheck)
  134.                Example: C:\SKULL\SKULLCHK.EXE @ /N*N /P*P
  135.           - EXTERNAL FILEVIEWER
  136.                FileGate will start this program as the
  137.                Fileviewer, instead of the internal one
  138.                (Tested with x-view)
  139.                Example: C:\XVIEW\XVIEW.EXE @
  140.  
  141.      When you select TOGGLES (use space to toggle)
  142.           - DATESWAPPING
  143.                While developing filegate, we encountered
  144.                Some bug with ra2.50, it returned the
  145.                Last-logon-date incorrectly, it returned
  146.                It like this: MM/DD/YY, it must be DD/MM/YY
  147.                So this option will swap DD and MM
  148.           - USE UPLOADED BY STRING
  149.                If switched, filegate will add an uploaded
  150.                By string to the files.bbs when processing
  151.                The upload (does not work with ra internal
  152.                filedatabase)
  153.           - ADD TAGDUDE.HUH TO DOWNLOADLIST
  154.                FileGate will add a textfile containing
  155.                Descriptions of all tagged files to
  156.                Downloadlist if switched  ON'
  157.           - USE FILEGATE.LOG INSTEAD OF RA.LOG
  158.                Turn this  ON' if you do not want filegate
  159.                To add the log-entries to the RA.LOG
  160.                But add it to a special FILEGATE.LOG
  161.                (This file is located in the ra-dir)
  162.           - CONVERT TO NEW ARCHIVES (IN UPLOAD-SCAN)
  163.                Select the archive-format to convert uploaded
  164.                Files to here (does not work if you use an
  165.                External uploadprocessor)
  166.           - WHICH TYPE OF FILEDATABASE DO U USE
  167.                This option lets you select FILES.BBS or
  168.                Ra internal filedatabase (faster!). Now you
  169.                don't need to use the slow FILES.BBS and will have
  170.                Cool descriptions as well
  171.  
  172.  
  173. Multinode:
  174. ----------
  175.      Multinode should work, however, it is not fully
  176.      tested so it might give some problems.
  177.      All files that are needed are located in the following
  178.      directories.
  179.  
  180.      %RA%\NODE<nodenumber>\DORINFO1.DEF
  181.      %RA%\NODE<nodenumber>\EXITINFO.BBS
  182.      %RA%\FILES.RA (and all other related files)
  183.  
  184.      These directories are only activated when you start filegate
  185.      with the '#' char for multinode support (must be first parameter!)
  186.  
  187.      (In this example RA is located in C:\RA)
  188.      Example: FLG_LST.EXE #3 L
  189.      this will choose node3, reads the following files
  190.           C:\RA\NODE3\DORINFO1.DEF
  191.           C:\RA\NODE3\EXITINFO.BBS
  192.      and lists the current area
  193.  
  194.  
  195. The Lister:
  196. -----------
  197.      Start without parameters for explanation of the commandline
  198.  
  199.      Available functions:
  200.      . File- and message- Group/Area selection
  201.      . Taglist editing
  202.      . Keyword search (searches on filenames as well!)
  203.      . Area listing
  204.      . Newfiles search from last date user logged on
  205.  
  206.      Executable: FLG_LST.EXE
  207.      Parameters: [!|#<nodenr>] [SG|SF|SC|SM|N|NA|K|L|E]
  208.  
  209.      Commandline options:
  210.  
  211.      !    .    Force into local-test-mode (do not
  212.                read dorinfo and exitinfo)
  213.              * MUST BE FIRST OPTION *
  214.      #    .    Go for multi-node support, (eg.
  215.                FLG_LST #2 for node2)
  216.                See for multinode for more info
  217.              * MUST BE FIRST OPTION *
  218.      SG   .    Select filegroup and filearea
  219.      SF   .    Select filearea
  220.      SC   .    Select mailgroup and mailarea
  221.      SM   .    Select mailarea
  222.      L    .    List current filearea
  223.      K    .    Search on keyword
  224.      N    .    Scan for newfiles since last call
  225.      NA   .    Ask if user wants to scan for newfiles
  226.      E    .    Edit current taglist
  227.  
  228.  
  229. Sub. NEWFILES
  230.      --------
  231.      The newfiles checker will scan for all newfiles
  232.      since the last logon of the user. It will take
  233.      the lastdate variable out of the userrecord.
  234.  
  235.  
  236. Sub. KEYWORD
  237.      -------
  238.      This feature lets the user search on keyword
  239.      through the entire bbs. (Also on filenames!)
  240.  
  241.  
  242. Sub. INTERNAL FILEVIEWING
  243.      --------------------
  244.      FileGate has an internal fileviewer aswell, this one
  245.      should work on all systems, however, it is not yet
  246.      fully developed (still busy on viewing music-files and
  247.      other formatted files). So if this one gives you any
  248.      bugs, just use an external one (tested with X-VIEW 1.81)
  249.  
  250.  
  251. The downloader and uploader:
  252. ----------------------------
  253.      Available functions:
  254.      . Downloading all tagged files
  255.      . Making a textfile containing descriptions of all
  256.        tagged files that are to be downloaded (tagdude)
  257.      . Uploading and processing uploaded files
  258.      . Importing file_id.diz files into files.bbs or
  259.        ra filedatabase
  260.  
  261.      Executable: FLG_DU.EXE
  262.      Parameters: [!|#<nodenr>] [D|U]
  263.  
  264.      Commandline options:
  265.      D    .    Download all tagged files
  266.      U    .    Start receiving files, private or public
  267.                and process them afterwards
  268.      D[path+filename]
  269.           .    Will force (one) file to be downloaded from
  270.                commandline (handy for allfiles etc..)
  271.      U[path]
  272.           .    Will force the upload-directory to the specified
  273.                one
  274.  
  275.  
  276. Sub. UPLOADPROCESSOR
  277.      ---------------
  278.      FileGate has an internal file-uploadprocessor, it
  279.      worked just fine at my board, however, I cannot
  280.      say it will work on ALL boards. You can therefore
  281.      use an external processor, this processor should
  282.      add the file-description to the filebase because
  283.      filegate does not do that (when using external one).
  284.      Installing an external processor is recommended
  285.      (If you want full and good upload-processing).
  286.      It was tested with SKULLCHECK 3.80a and it went well!
  287.  
  288.      The internal processor checks the uploaded files
  289.      for virusses, stamps a banner, adds a commercial file
  290.      and imports the file_id.diz into the filebase.
  291.  
  292.  
  293. Sub. TAGDUDE.HUH
  294.      -----------
  295.      This file is generated while scanning for tagged files
  296.      it contains all descriptions of the tagged files and has
  297.      both header and footer. These header and footer can be
  298.      configured to your own needs, the filenames of these
  299.      files are: TAGHDR.HUH    (for the header) and
  300.                 TAGFTR.HUH    (for the footer)
  301.      Both files are added to the TAGDUDE.HUH file.
  302. !!!  These files must be located in the RA directory!
  303.  
  304.  
  305. Sub. PROTOCOLS
  306.      ---------
  307.      All protocols MUST be DSZ-log compatible for filegate
  308.      to recognize the down- and uploads. For filegate to find
  309.      the DSZ.LOG file, the DSZLOG variable has to be set!
  310.      Set this variable in you autoexec.bat or the batchfile
  311.      you use to start your bbs-software!
  312.      SET DSZLOG=C:\LOGS\DSZ.LOG (for example that is...)
  313.      See for the protocol-installation part in this document
  314.      for more information about installing protocols!
  315.  
  316. !!!  Further, filegate changes the current directory to
  317.      the TEMP directory (set in autoexec.bat) this directory
  318.      MUST exist, filegate will report a runtime error if
  319.      I could not change the directory!
  320.      (This temp-variable is also used for other features
  321.       so it's wise to set it!)
  322.  
  323.  
  324. Sub. TODAYS DOWNLOADS
  325.      ----------------
  326.      FileGate also generates two files named FLGTODAY.UP and
  327.      FLGTODAY.DWN, these files contain all files that have
  328.      been downloaded (or uploaded) today, files that are
  329.      more then once downloaded get a higher number (they are
  330.      not added twice!). There is no util that converts these
  331.      files to an ansi-file so you have to wait for an util
  332.      that does so (sorry for that...).
  333.      These files have to erased by you every night (filegate
  334.      wont erase them if a day goes by..) Or else you'll get
  335.      very long lists containing files that have been downloaded
  336.      weeks ago (or files that have been downloaded about 100x).
  337.      The record-format is listed at the end of this document
  338.      (This is for util-coders).
  339.  
  340.  
  341. Protocol-installation and supported protocols:
  342. ----------------------------------------------
  343.      FileGate supports one-way as well as bi-directional
  344.      protcols. You can install these protocols with the
  345.      setup-utility (flg_stp.exe). Up to 10 protocols are allowed.
  346.      All available macros are listed in the protocol-editor, however,
  347.      here's a list:
  348.      *B   .    Current bpsrate, not comport but modemspeed!
  349.      *L   .    Logfile position (dsz compatible) this is
  350.                The same as the DSZLOG variable.
  351.      *F   .    Fileslist, this file contains a list of all
  352.                Files that are tagged and to be downloaded!
  353.                (Including path)
  354.      *U   .    Upload directory (where files are received into)
  355.      *P   .    Current comport (1=com1 etc..)
  356.              * IMPORTANT * This will be set to 1 in local
  357.                Testmode! (So don't go crazy while testing it)
  358.      *K   .    Kilobyte limit (this variable holds the users
  359.                Kb-limit that is yet available for download
  360.  
  361.      Some protocols like GSZ and BIMODEM are already configured in
  362.      the example protocol-configuration. So you don't need to enter
  363.      your own commandline.
  364.  
  365.  
  366. Known bugs:
  367. -----------
  368.      There are still bugs to be fixed, and features
  369.      of remote access that are not yet supported. Here's a
  370.      list containing all we know about them:
  371.      . Area flags not supported (still working on it though)
  372.        Use levels instead!
  373.      . Remoteaccess internal filebase
  374.        Files flagged FREE within an area that is NOT free at all
  375.        (not supported yet!)
  376.      . Pressing escape while testing locally might lead to
  377.        a strange hang of your computer (we think it's already
  378.        fixed but, just in case it goes wrong, wont happen
  379.        with a user online)
  380.      . Remote access 2.50 saves its LASTDATE differently then
  381.        You config it, we therefore implemented a date-swapping
  382.        Routine that will swap the date to the one wanted!
  383.      . The timer does NOT work under DESQVIEW, the usertime will
  384.        not be updated (not decreased), RA will update it correctly!
  385.  
  386.  
  387. Final message:
  388. --------------
  389.      That's it for now, more weird options for filegate are
  390.      coming very very soon. If you are a coder of weird utils
  391.      (like todays downloads, a record-structure in PASCAL can
  392.      be found at the end of this document).
  393.      Support can be found at the following bbs's
  394.  
  395.      Digital Underworld: Final Chase
  396.      +31-(0)23-5240160
  397.      2k4 - 14k4
  398.      Syzo Tdd
  399.  
  400.      Lounge Act
  401.      +31-(0)71-5790411
  402.      2k4 - 14k4
  403.      Syzo Vertigo
  404.  
  405.      You can also e-mail me (the coder:Tdd) at
  406.      v952481@si.hhs.nl
  407.      or check the filegate-homepage (not really
  408.      up to date.. But who carez)
  409.      http://www.hhs.nl/~v952481/home.html
  410.  
  411.  
  412. Thanx fly to:
  413.      . The Free Debugger (for his intensive beta-testing)
  414.      . Vertigo, for his high phonebills :)
  415.  
  416.  
  417. Greetz to:
  418.      . Members of DMA, Brainrave, Mad Max, Scsi2, Highlite,
  419.                        Thunderbass
  420.      . Member of BLACKTRON, Armadon
  421.  
  422.  
  423. !!!  AND KNOW, THE STRUCTURE (IN PASCAL)
  424.  
  425.      This structure is used in the following files:
  426.           FLGTODAY.UP and FLGTODAY.DWN
  427.  
  428.      These files contain the information about files that
  429.      are downloaded/uploaded today (well, you have to erase these
  430.      files yourselves in an daily event)
  431.      The uploaded files do not use the TIMES variable!
  432.  
  433.      TODAYUPDWN   = RECORD
  434.                       FN       : STRING[12];
  435.                       TIMES    : BYTE;          { not used in FLGTODAY.UP }
  436.                     END;
  437.  
  438. <end of doc>