home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / my2www05.zip / my2www_doc.eng < prev    next >
Text File  |  1998-06-11  |  16KB  |  319 lines
  1. --------------------------------------- --------------------------------------- -
  2. My2WWW v.05 WWW filter, decoder, virtula server support, My/2 Server support
  3. --------------------------------------- --------------------------------------- -
  4.                                                 Copuright (c) 1998 A. Ivanov
  5.  
  6. 0. Agreement
  7. 1. General description
  8. 2. Contents of archive
  9. 3. Requirement
  10. 4. How to build My2WWW in ICS or GoWebServer
  11. 5. Description of a file of a configuration
  12. 6. Gratitude
  13. 7. Restriction of the freely distributed version
  14.  
  15.  
  16.  
  17.                          0. Agreement
  18. This program is distributed FREE-OF-CHARGE and in a CONSTANT kind. Is forbidden
  19. Debugging, decompiling. It is forbidden to change contents of the given archive.
  20.  
  21.  
  22.                          1. Contents of archive
  23. 1. My2www_doc.rus       the Documentation in Russian
  24. 2. My2www_doc.eng       the Documentation in English
  25. 3. My2www.dll           Basic DLL library
  26. 4. My2www.cfg           an Example of a file of a configuration
  27. 5. Mypm.dll             the Auxiliary library (should be placed somewhere in LIBPATH)
  28. 6. Mynv.dll             the Auxiliary library (should be placed somewhere in LIBPATH)
  29. 7. Mynet.dll            the Auxiliary library (should be placed somewhere in LIBPATH)
  30. 8. Koi                  Decoding table 866 - > KOI codepages
  31. 9. Win                  Decoding table 866 - > WIN codepages
  32.  
  33.                          2. General(common) description
  34. My2www.dll is intended for embedding in HTTP servers of the following types:
  35. (the list is given in item 3). My2www was tested on GoWebServer 4.6.1.
  36.  
  37. Given library is intended for:
  38. 1. Realization of the control of access to the information on yours of WWW server.
  39. 2. Realization of code conversion "on summer" (on-the-fly) contents
  40.    HTML of pages on yours server from 866 code pages to KOI, WIN, ISO.
  41. 3. Creation VIRTUAL WEB-servers on the basis of yours of GoWeb ßÑαóÑαá using
  42.    ONLY one IP address!
  43. 4. Represents itself as the client to My/2 Server.
  44.    (in more detail about My/2 look: http://penza.sura.com.ru/~alex/moreos2.shtml)
  45.  
  46. My2www.dll can:
  47. 1. To forbid reception of the documents from yours server on the chosen IP-addresses,
  48.    Redirect inquiry from yours server on anyone another of URL or server.
  49.    (any mask) is allowed. In more details see item 5 the Description of a file of a
  50.    configuration.
  51. 2. To forbid reception of the document (Picture, class, so everything,
  52.    That is possible to define URL. Any mask URL) from yours server is allowed
  53.    On forbidden for reception it of URL of the address (mask of addresses).
  54.    Redirect inquiry with URL on yours server on anyone another of URL on
  55.    Yours or anyone by the friend server.
  56.    In more details see item 5 the Description of a file of a configuration.
  57. 3. To recode contents HTML of the document "on summer" from WWW server to the client.
  58.    The code conversion is always conducted from 866 code pages in one of chosen:
  59.    KOI, WIN, ISO. In a file of a configuration (In more Details see item 5 the
  60.    Description of a file of a configuration.)
  61.    The code conversion is applied only to the following types of the documents:
  62.    text/* so "text/" and is farther anything you like.
  63.    IT IS NECESSARY to set variable XXX_URL_BEGIN and XXX_CODEPAGE,
  64.    Where XXX - name of code page from 3 letters;) (WIN, KOI, ISO). XXX_URL_BEGIN
  65.    This initial meaning of the address yours server, which will be considered as area,
  66.    Which from is necessary to give back the user not @ document, and its copy
  67.    In the appropriate code page. I understand, that is foggy. Now
  68.    I shall explain. For example, if the address yours of WWW server looks so:
  69.                         Www.sura.com.ru
  70.    And you define in a file of a configuration the following:
  71.         KOI_URL_BEGIN   koi, www
  72.         WIN_URL_BEGIN   win, win1251, mustdie
  73.         ISO_URL_BEGIN   iso
  74.         KOI_CODEPAGE    D:\WORK_PRG\OBJ\WWW\OBJ\koi
  75.         WIN_CODEPAGE    D:\WORK_PRG\OBJ\WWW\OBJ\win
  76.         ISO_CODEPAGE    D:\WORK_PRG\OBJ\WWW\OBJ\iso
  77.  
  78.    Those all inquiries, addressed on koi or koi.sura.com.ru or koi-ili-net.sura.com.ru
  79.    Or koi.moi.twoi or www.moi.twoi etc. will be subjected to code conversion from 866 code
  80.    Pages in page determined in variable KOI_CODEPAGE. In a file, determined by this
  81.    Variable not @ code table, and DECODING table from 866 in KOI lays
  82.    (or other page, which will wish). Actually, my2www simply will recode
  83.    From the current coding in the coding determined by a file XXX_CODEPAGE. So from
  84.    ANYONE in ANYONE. Nevertheless NAMES variable in a file of a configuration do not vary.
  85. 4. To create and to support upto 100 VIRTUAL WEB-servers on ONE IP address only!
  86.    What this such? It is yours - @ WEB-server, having synonym in DNS (actually other name)
  87.    And at the reference to yours server on this name the inquiry of the client will be readdressed
  88.    In other directory on yours WEB-server. Is possible to readdress in:
  89.         Other directory
  90.         Other disk
  91.         Network disk
  92.         The directory can correspond home page of your user.
  93.         Yes anywhere!
  94.     For this purpose there is an instruction in a file of a configuration named VIRTUAL_SRV
  95.     (look 5 in more detail. The description of a file of a configuration).
  96.     The code conversion described above is completely applicable to VIRTUAL servers.
  97.     As well the rights of access.
  98.  
  99.     Example virtual server configuration:
  100.     ======================================= ======
  101.     For the beginning in DNS it is necessary to register all synonyms given virtual server:
  102.  
  103.     File NAMED.DOM
  104.     --------------
  105.         ...
  106.         Koi.any-virtual-name.sura.com.ru. IN CNAME penza.sura.com.ru.
  107.         Win.any-virtual-name.sura.com.ru. IN CNAME penza.sura.com.ru.
  108.         Any-virtual-name.sura.com.ru.     IN CNAME penza.sura.com.ru.
  109.         ...
  110.         Thus we configured virtual servers with names:
  111.         Any-virtual-name
  112.         Koi.any-virtual-name; a synonym for KOI of code conversion.
  113.         Win.any-virtual-name; a synonym for WIN of code conversion.
  114.  
  115.     File My2WWW.CFG
  116.     ---------------
  117.         ...
  118.         VIRTUAL_SRV koi.any-virtual-name.sura.com.ru, D:/ANYDIR/ANYSUBDIR
  119.         VIRTUAL_SRV win.any-virtual-name.sura.com.ru, D:/ANYDIR/ANYSUBDIR
  120.         VIRTUAL_SRV any-virtual-name.sura.com.ru, D:/ANYDIR/ANYSUBDIR
  121.         ...
  122.         The directories, on which are displayed inquiries to VIRTUAL server
  123.         There can be any. Without "/" on the end!!!
  124.         Besides, for each of above mentioned servers they can be.
  125.         For example:
  126.         ...
  127.         VIRTUAL_SRV koi.any-virtual-name.sura.com.ru, D:/ANYDIR/ANYSUBDIR/SUB-SUB-DIR1
  128.         VIRTUAL_SRV win.any-virtual-name.sura.com.ru, D:/ANYDIR/ANYSUBDIR/SUB-SUB-DIR123
  129.         VIRTUAL_SRV any-virtual-name.sura.com.ru, D:/ANYDIR/ANYSUBDIR/SUB-SUB-DIR45678
  130.         ...
  131.  
  132. 5. My2WWW can represent itself as the client to My/2 server (more
  133.         In detail about My/2 look: http://penza.sura.com.ru/~alex/moreos2.shtml).
  134.         For this purpose it is necessary to execute the following steps:
  135.                 1. Install My/2 Server on any computer
  136.                    (look http://penza.sura.com.ru/~alex/moreos2.shtml)
  137.                 2. Install My2WWW (see item 5. How to build My2WWW in ICS or GoWebServer)
  138.                 3. Correctly register MY2_SRV the instruction in a configuration file
  139.                    For My2WWW.
  140.                 4. By anyone of WEB by the client to execute connection with WWW server with
  141.                    Built-in My2WWW.dll and to try to load the document "/My2".
  142.                    If all has passed successfully, on the screen WEB browser you receive
  143.                    Copy of a window My/2 Server. Above the users it is possible to carry out
  144.                    The same actions, as in the  program My/2.
  145.                    If something has passed not so, My2WWW will give out on the screen browser
  146.                    The message on a mistake with its characteristic.
  147.                    I recommend to come or NetScape or MSIE.
  148.  
  149.  
  150.  
  151.                          3. Requirement
  152. 1. OS/2 WARP, WARP CONNECT, WARPSERVER or Merlin.
  153. 2. ICS 4.2 or 4.2.1 either GoWebServer 4.6 or GoWebServer 4.6.1.
  154. 3. HPFS (This not my requirement, and ICS and GoWeb)
  155. 4. HTTPDAPI.DLL (it goes together with above named servers).
  156.  
  157.                          4. How to build My2WWW in ICS or GoWebServer
  158. Yes... It really whole song. It is better by handles go in \ETC\httpd.cnf
  159. To find appropriate to section in it and to put the following. Choose item from
  160. Below-mentioned, which approaches you. Find the appropriate section in
  161. \ETC\httpd.cnf. The name of section corresponds to the first word in lines.
  162. For example, Word PreExit. Search for section PreExit and insert a line
  163. PreExit d:\www\dll\my2www.dll:MyPreExit
  164. Also we act and in all other lines.
  165.  
  166. 1. If want to carry out ONLY control of access
  167.    Or ONLY support virtual servers.
  168.         ...
  169.         PreExit d:\www\dll\my2www.dll:MyPreExit
  170.         ...
  171.         NameTrans * d:\www\dll\my2www.dll:MyNameTrans
  172.         ...
  173.         ObjectType * d:\www\dll\my2www.dll:MyObjType
  174.         ...
  175.         PostExit d:\www\dll\my2www.dll:MyPostExit
  176.         ...
  177.         ServerInit D:\WWW\DLL\my2www.dll:MyInit D:\WORK_PRG\OBJ\WWW\OBJ\my2www.cfg, D:\WORK_PRG\OBJ\WWW\OBJ\wwwserv.exe
  178.         ServerTerm D:\WWW\DLL\my2www.dll:MyTerm
  179.         ...
  180.  
  181.  
  182. 2. If want to carry out ONLY code conversion.
  183.         ...
  184.         PreExit d:\www\dll\my2www.dll:MyPreExit
  185.         ...
  186.         DataFilter d:\www\dll\my2www.dll:MyDataFOpen:MyDat aFWrite:MyDataFClose
  187.         ...
  188.         PostExit d:\www\dll\my2www.dll:MyPostExit
  189.         ...
  190.         ServerInit D:\WWW\DLL\my2www.dll:MyInit D:\WORK_PRG\OBJ\WWW\OBJ\my2www.cfg, D:\WORK_PRG\OBJ\WWW\OBJ\wwwserv.exe
  191.         ServerTerm D:\WWW\DLL\my2www.dll:MyTerm
  192.         ...
  193.  
  194.  
  195. 3. If want to carry out the control of access, code conversion and support
  196.    Virtual servers.
  197.         ...
  198.         PreExit d:\www\dll\my2www.dll:MyPreExit
  199.         ...
  200.         NameTrans * d:\www\dll\my2www.dll:MyNameTrans
  201.         ...
  202.         ObjectType * d:\www\dll\my2www.dll:MyObjType
  203.         ...
  204.         DataFilter d:\www\dll\my2www.dll:MyDataFOpen:MyDat aFWrite:MyDataFClose
  205.         ...
  206.         PostExit d:\www\dll\my2www.dll:MyPostExit
  207.         ...
  208.         ServerInit D:\WWW\DLL\my2www.dll:MyInit D:\WORK_PRG\OBJ\WWW\OBJ\my2www.cfg, D:\WORK_PRG\OBJ\WWW\OBJ\wwwserv.exe
  209.         ServerTerm D:\WWW\DLL\my2www.dll:MyTerm
  210.         ...
  211.  
  212. 4. For support My/2 it is necessary to add:
  213.         1. If want, that /My2 the directory was accessible to all, that I - @
  214.            Did not recommend in any way, it is enough to find in httpd.cnf a file
  215.            Example of the instruction Service and number(line) to enter:
  216.            Service /My2* D:\WWW\dll\my2www.dll:MyServiceMy2
  217.            Notice!!! Second parameter JUST /My2*
  218.            If want, that given URI was protected by server,
  219.            That is necessary correctly to make the appropriate instruction Protect
  220.            And at once ambassador it to insert a line:
  221.            Service /My2* D:\WWW\dll\my2www.dll:MyServiceMy2
  222.            In this case at first will be made check name and password
  223.            The user, and then service of inquiry on /My2*
  224.            Example:
  225.            ...
  226.            Protection PROT-USER-MY2 {
  227.                  PasswdFile d:\mptn\etc\my2.pwd
  228.                  ACLOverride On
  229.                  Mask All (**
  230.                  DeleteMask All (**
  231.                  PostMask All (**
  232.                  PutMask All (**
  233.                  GetMask All (**
  234.                  AuthType Basic
  235.           }
  236.            Protect /My2* PROT-USER-MY2
  237.            Service /My2* D:\WWW\dll\my2www.dll:MyServiceMy2
  238.            ...
  239.  
  240.  
  241. It is necessary to tell about the instruction ServerInit d \ETC\httpd.cnf separately. Its(her) format the following:
  242.         ServerInit [a Way to my2www.dll] [a way to my2www.cfg], [a way to a file, which My2www will start in this moment (moment of start WWW server)]
  243.  
  244.  
  245.                          5. Description of a file of a configuration
  246.  
  247. DENY_ACCESS       FORBIDDEN 195.16.107. *, 194.84.32.70, 193.*.3*2.6*
  248. DENY_ACCESS       http: // www.disney.com 193.*.*.*
  249.                 DENY_ACCESS [FORBIDDEN/Full_URL_name] [IPmask1]..., [IPmask100]
  250.                 In this variable the masks IP of addresses, with which are described
  251.                 The input(entrance) and capture of ANY documents from yours will be forbidden
  252.                 by server. Or at attempt of access to yours server, the client will be
  253.                 REDIRECTED in ANY other place. Can be listed
  254.                 Up to 100 masks. It is possible to mention this instruction some times.
  255.  
  256. URL_DENY_ACCESS   http: // www.porno.com/ / ~ alex/* 195.16.107. *, 194.84.32.70, 197.14.*3.*
  257. URL_DENY_ACCESS   ftp: // ftp.sura.com.ru/ / ~ dizelist/* 195.16.107.*
  258. URL_DENY_ACCESS   FORBIDDEN /*.gif 194.84.32.70
  259.                 URL_DENY_ACCESS [FORBIDDEN/Full_URL_name] [URL mask] [IP mask1]..., [IP mask100]
  260.                 In this variable the masks IP of addresses [IP maskN] are described,
  261.                 Which with will be forbidden an input(entrance) and capture of the documents on a mask
  262.                 [URL mask]. All can be no more than 100 URL mask and IP mask.
  263.                 Also inquiry on ANYONE of URL can be REDIRECTED on ANYONE
  264.                 Another (is not necessary on yours server).
  265.  
  266. KOI_CODEPAGE      D:\WORK _ PRG\OBJ\WWW\OBJ\koi
  267. WIN_CODEPAGE      D:\WORK _ PRG\OBJ\WWW\OBJ\win
  268. ISO_CODEPAGE      D:\WORK _ PRG\OBJ\WWW\OBJ\iso
  269.                 XXX_CODEPAGE [path\filename]
  270.                 Way to a file of code conversion for XXX code pages.
  271.  
  272. KOI_URL_BEGIN     koi, www
  273. WIN_URL_BEGIN     win, win1251, mustdie
  274. ISO_URL_BEGIN     iso
  275.                 XXX_URL_BEGIN [anyname1], [anyname2]..., [anyname5]
  276.                 To each coding can be up to 5 synonyms.
  277.                 See item 2. The general description (my2www.dll can: [3.])
  278.  
  279. VIRTUAL_SRV       dns.name.address.com, D:/PATH/SUBDIR/SUB-SUBDIR
  280.                 These instructions in a file of a configuration can be up to 100.
  281.                 By this instruction is described VIRTUAL server and that
  282.                 Way on a local disk on which reflected all
  283.                 Inquiries on given server.
  284.                 In this case all inquiries about yours of WWW on the address
  285.                 Dns.name.address.com, will be readdressed not
  286.                 In a root directory server (it is usual D:/WWW/HTMLS)
  287.                 And in D:/PATH/SUBDIR/SUB-SUBDIR.
  288.                 Inside the documents on VIRTUAL server of the reference
  289.                 Can be both absolute and relative.
  290.                 Both those and others work. Is checked up.
  291. MY2_SRV           194.84.32.1, 7777
  292.                 In first parameter it is possible to specify as IP the address, and
  293.                 DNS name. As second parameter it is necessary to specify
  294.                 Number of port, on which My/2 Server accepts inquiries.
  295.                 (in more detail about My/2 look http://penza.sura.com.ru/~alex/moreos2.shtml)
  296.  
  297.  
  298.                          6. Gratitude
  299. Many thanks Richard Gray for the explanatories in work GWAPI.
  300.  
  301.                          7. Restriction of the freely distributed version
  302. The freely distributed version is absolutely full-function. Unique(sole)
  303. Restriction this quantity of the specific instructions in a file of a configuration.
  304. From version 0.5 DEMO:
  305. In a file of a configuration of the instructions DENY_ACCESS can be up to 1.
  306.  ----------- // ---------------                  URL_DENY_ACCESS can be up to 1.
  307.  ----------- // ---------------                  VIRTUAL_SRV can be up to 1.
  308. So, there is more given quantity My2WWW will not perceive.
  309. Restrictions on code conversion and work with My/2 server is not put.
  310.  
  311.  
  312. If you had questions or offers, write to me.
  313. --------------------------------------- -------------------------------------
  314. Alexandr A. Ivanov
  315. Email: alex sura.com.ru
  316. WWW:   http://penza.sura.com.ru/~alex
  317. --------------------------------------- -------------------------------------
  318.  
  319.