home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / ckscripts / alphapage < prev    next >
Text File  |  2020-01-01  |  12KB  |  323 lines
  1. #!/usr/local/bin/kermit +
  2. ;
  3. ; ALPHAPAGE 6.0 for C-Kermit 8.0.201, 206, or 209 (but not 208)
  4. ; F. da Cruz, The Kermit Project, Columbia University
  5. ;
  6. ; TAP/IXO alphanumeric paging script for C-Kermit.
  7. ; For a detailed explanation, consult "Using C-Kermit", 2nd Ed., pp.454-456.
  8. ;
  9. if LLT \v(version) 800201 stop 1 C-Kermit 8.0.201 or later required.
  10. if EQU \v(version) 800208 stop 1 -
  11. "Sorry - This script doesn't work in 8.0.208; please use 201, 206, or 209.
  12.  
  13. ; Set defaults here.
  14.  
  15. define d_LINE /dev/ttyb           ; Device modem is attached to
  16.  
  17. ; The following are critical - the script won't work unless
  18. ; all of them are set appropriately for the specific paging service,
  19. ; Verizon PCS in this example.
  20.  
  21. define d_APAGEPHONE 18668230501   ; Paging service phone number (VERIZON PCS)
  22. define d_MODEM usrobotics         ; Actual specific modem type
  23. define d_SPEED 1200               ; Serial port speed
  24. define d_PARITY EVEN              ; Parity (usually EVEN or NONE)
  25. define d_FLOW NONE                ; Flow control
  26. define d_PACING 0                 ; Output character pacing (milliseconds)
  27.  
  28. ; Other defaults
  29.  
  30. define d_REDIALS 20               ; Allow 20 redials (IF LEGAL!)
  31. define d_TESTING 0                ; Set to 1 or 2 for debugging
  32.  
  33. ; You can override defaults with Kermit variables or environment variables:
  34.  
  35. if not def APAGEPHONE assign APAGEPHONE \$(APAGEPHONE)
  36. if not def APAGEPHONE asg APAGEPHONE \m(d_APAGEPHONE)
  37. if not def LINE assign LINE \$(LINE)
  38. if not def LINE asg LINE \m(d_LINE)
  39. if not def SPEED asg SPEED \$(SPEED)
  40. if not def SPEED asg SPEED \m(d_SPEED)
  41. if not def MODEM assign MODEM \$(MODEM)
  42. if not def MODEM asg MODEM \m(d_MODEM)
  43. if not def PARITY assign PARITY \$(PARITY)
  44. if not def PARITY asg PARITY \m(d_PARITY)
  45. if not def FLOW assign FLOW \$(FLOW)
  46. if not def FLOW asg FLOW \m(d_FLOW)
  47. if not def PACING assign PACING \$(PACING)
  48. if not def PACING asg PACING \m(d_PACING)
  49. ;
  50. ; WARNING: Automatic redialing is restricted or illegal in some
  51. ; countries.  Modify the lines marked "IF LEGAL!" above if this applies
  52. ; in your location.
  53. ;
  54. assign REDIALS \$(REDIALS)
  55. if not def REDIALS asg REDIALS \m(d_REDIALS)
  56. if not def TESTING {
  57.     assign TESTING \$(TESTING)
  58.     if not def TESTING asg TESTING \m(d_TESTING)
  59.     if not def TESTING asg TESTING 0
  60.     if not numeric \m(TESTING) asg TESTING 1
  61. }
  62.  
  63. ; TAPMSG, defined below, is an alphanumeric pager dialing script that
  64. ; implements the Telocator Alphanumeric Protocol (TAP), also known as IXO,
  65. ; for sending one-line alphanumeric pages.  TAPMSG assumes the connection
  66. ; to the paging service is already made.
  67. ;
  68. ; The APAGE macro makes a connection to the paging service using the
  69. ; device, modem, and phone number definitions at the top of this file,
  70. ; and then invokes TAPMSG to send the page.
  71. ;
  72. ; INSTRUCTIONS
  73. ;
  74. ; Edit the defaults at the top of this file as needed.
  75. ;
  76. ; Change the top line to indicate the full pathname of the C-Kermit 8.0
  77. ; executable if necessary, then store this file in your PATH with a name like
  78. ; "verizon", give it execute permission, and then you can run it by name from
  79. ; the shell prompt:
  80. ;
  81. ;   verizon pagerid message
  82. ;
  83. ; Command-line args containing spaces must be quoted.  Example:
  84. ;
  85. ;   verizon 9876543 "This is a message"
  86. ; 
  87. ; You can also pass the pagerid and message as environment variables instead
  88. ; of command-line arguments:
  89. ;
  90. ;   export PIN=19177654321
  91. ;   export MESSAGE="Everything is broken - come and fix!"
  92. ;   verizon
  93. ;
  94. ; To use different paging services, make copies of this file with the
  95. ; appropriate names and configuration changes, e.g. skytel with skytel's
  96. ; phone number, pagenet, whatever.
  97. ;
  98. ; EDIT HISTORY
  99. ;
  100. ; Version 1.0: Sept 1996, for C-Kermit 6.0.
  101. ; Version 2.0: July 1997:
  102. ;  1. To make TAPMSG fit into 1K for small C-Kermit versions.
  103. ;  2. Change END to STOP within SWITCH to work around C-Kermit bug.
  104. ; Version 3.0: September 1997, for C-Kermit 7.0 Beta.
  105. ;  1. Change STOP back to END because bug is fixed.
  106. ;  2. Added robustness.
  107. ; Version 4.0: August 1998:
  108. ;  1. Additional robustness - requires 2K command buffer.
  109. ;  2. Diagnostics.
  110. ; Version 5.0: May 2000, for C-Kermit 7.0:
  111. ;  1. Improved portability, parameterization, and error checking.
  112. ; Version 6.0: Mar 2003, for C-Kermit 8.0:
  113. ;  1. More debugging.
  114. ;  2. Accept environment variables as well as command-line args.
  115. ;  3. Parameterize output pacing -- it can make all the difference.
  116. ;
  117. if \m(TESTING) {         ; Set up debugging messages and logs
  118.     set quiet off
  119.     echo TESTING=\m(TESTING)
  120.     echo COMMAND FILE: \fpathname(\v(cmdfile))
  121.     echo EXEDIR: \v(exedir) ; where Kermit is running from
  122.     set dial display on          ; Watch computer/modem dialog
  123.     set command byte 7           ; Filter out the 8th bit when debugging
  124.     if > \m(TESTING) 1 {         ; serious debugging
  125.         log session              ; Creates session.log in current directory
  126.         log debug                ; Creates debug.log in current directory
  127.         set input echo on        ; Watch input (can mess up your screen)
  128.     }
  129. }
  130.  
  131. ; APSETUP - Set up dialing device and modem.
  132.  
  133. define APSETUP {                 ; Set up the calling parameters.
  134.     set exit warning off         ; No warnings on exit.
  135.     if eq \v(system) WIN32 {     ; In Windows use the default TAPI device.
  136.         set port tapi          
  137.         if fail end 1
  138.     } else {                     ; Elsewhere...
  139.         set modem type \m(MODEM) ; Specify the modem type.
  140.         if fail end 1 Bad modem type: "\m(MODEM)"
  141.         if eq "\v(modem)" "multitech" {
  142.             set modem command init ATQ0E1X4&E8&Q0&S0$BA0$MB\m(speed)\13
  143.             set modem command error-correction off AT&E0\13
  144.         }
  145.         set line \m(LINE)        ; Specify dialout port.
  146.     if fail end 1 Can't SET LINE to "\m(LINE)"
  147.     }
  148.     if \m(TESTING) {
  149.         echo "PHONE:   \m(APAGEPHONE)"
  150.         echo "PORT:    \m(LINE)"
  151.         echo "MODEM:   \m(MODEM)"
  152.         echo "SPEED:   \m(SPEED)"
  153.         echo "PARITY:  \m(PARITY)"
  154.         echo "FLOW:    \m(FLOW)"
  155.         echo "PACING:  \m(PACING)"
  156.     }
  157.     set term byte 7              ; Ignore the 8th bit - TAP is ASCII only
  158.     set input echo off           ; (this can confuse the terminal)
  159.     set speed \m(SPEED)          ; Speed required by paging service
  160.     if fail stop 1 Bad SPEED - "\m(SPEED)"
  161.     set parity \m(PARITY)        ; Parity required by paging service
  162.     if fail stop 1 Bad PARITY - "\m(PARITY)"
  163.     set flow \m(FLOW)            ; Flow control (usually NONE)
  164.     if fail stop 1 Bad FLOW-CONTROL - "\m(FLOW)"
  165.     set dial interval 1          ; 1 sec between redial attempts
  166.     set dial retries \m(REDIALS)
  167.     if fail stop 1 Bad DIAL RETRIES - "\m(REDIALS)"
  168.     if \m(TESTING) show comm     ; Let's see the modem signals
  169. }
  170.  
  171. ; APAGE - Make the call and send the page.
  172. ;   \%1 = Pager ID (PIN)
  173. ;   \%2 = Message (single line)
  174. ;
  175. define APAGE {                   ; Call the paging service and send a page.
  176.     local rc t                   ; rc = Return code for this macro
  177.     if < \v(argc) 2 end 1 Pager ID required
  178.     if \m(TESTING) {
  179.         asg t \v(ntime)
  180.         echo
  181.         echo "PIN:     \%1"
  182.         echo "MESSAGE: \%2"
  183.     }
  184.     do apsetup                   ; Make the call.
  185.     if fail end 1                ; Quit if the call failed.
  186.     set modem error-correction off  ; Turn OFF error correction
  187.     set modem data-compression off  ; and data compression
  188.     set modem speed-matching on     ; and speed-buffering.
  189.     if def PACING {                 ; Intercharacter pacing for OUTPUT.
  190.         if numeric \m(PACING) set output pacing \m(PACING)
  191.     }
  192.     dial \m(APAGEPHONE)          ; Call the pager service
  193.     asg rc \v(status)             ; Save DIAL status
  194.     if = \m(rc) 0 {              ; If the call is answered
  195.         tapmsg \%1 {\%2}         ; Send the page
  196.         asg rc \v(status)        ; Save the result
  197.     }
  198.     set dial display off         ; Don't display garbage burst on hangup
  199.     if k-95 set line             ; Release the port
  200.     ;; if c-kermit set line
  201.  
  202. ; In UNIX or VMS: Uncomment previous command if running this script in a 
  203. ; loop to send multiple pages AND job has a controlling terminal (if there
  204. ; is no controlling terminal, e.g. under Cron or Sendmail, the "set line"
  205. ; command can fail.
  206.  
  207.     if \m(TESTING) echo PORT RELEASED
  208.     if not quiet {
  209.     if = \m(rc) 0 {
  210.         echo PAGE OK
  211.     } else {
  212.         echo PAGE FAILED
  213.     }
  214.     }
  215.     if \m(TESTING) {
  216.         echo TIME \feval(\v(ntime) - \m(t))
  217.         echo
  218.     }
  219.     ;
  220.     ; For shared in-out ports you might need to reset the port's original
  221.     ; speed here and maybe also send it some kind of reset command like ATZ.
  222.     ;
  223.     set modem type \v(modem)     ; Restore default modem settings
  224.     end \m(rc)                   ; Return
  225. }
  226.  
  227. dcl \&m[] = "ACK" "NAK" "ID=" "FORCED DISCONNECT"
  228. def \&m[0] "TIMEOUT"
  229.  
  230. ; TAPMSG Telocator Alphanumeric Protocol execution.  Call with:
  231. ;   \%1 = Pager ID (PIN)
  232. ;   \%2 = Message (single line)
  233. ;  Assumes connection is made.  Uses TAP to send PIN and 1-line message.
  234. ;
  235. def TAPMSG {
  236.     local \%i \%m \%s blk        ; Local variables
  237.     set case on                         ; INPUT is case sensitive
  238.     asg \%m \2\%1\13\%2\13\3        ; <STX>ID<CR>msg<CR><ETX>
  239.     asg \%s \fchecksum(\%m)        ; Get checksum and make block
  240.     asg blk \%m\fchar(\fmod(\%s/256,16)+48)-
  241. \fchar(\fmod(\%s/16,16)+48)-
  242. \fchar(\fmod(\%s,16)+48)\13        ; Checksummed TAP block
  243.     if \m(TESTING) { echo, echo WAITING FOR ID= PROMPT... }
  244.     msleep 500                          ; Wait half a sec...
  245.     for \%i 1 6 1 {            ; Try six times to get prompt
  246.     out \13                ; Send <CR>
  247.         if fail end 1 OUTPUT I/O ERROR
  248.         if \m(TESTING) echo SENT <CR>(\%i)
  249.     input 2 {ID=}                   ; Look for "ID=" prompt
  250.     if success break
  251.         if not open connection end 1 FATAL - Connection Lost
  252.         if > \v(instatus) 2 end 1 FATAL INPUT ERROR
  253.     }
  254.     if > \%i 6 end 1 {FAILED: NO "ID=" PROMPT (TRIES=\feval(\%i-1))}
  255.     if \m(TESTING) echo {RCVD "ID="}
  256.  
  257.     for \%i 1 8 1 {            ; Send <ESC>PG1, get <ACK>
  258.     msleep 500                      ; First wait half a second
  259.     output \27PG1\13
  260.         if \m(TESTING) echo SENT <ESC>PG1(\%i)
  261.     minput 3 {\6\13} {\21\13} {ID=} {\27\4\13}
  262.         if \m(TESTING) echo RCVD \&m[\v(minput)]
  263.     switch \v(minput) {
  264.       :0, continue            ; Timeout
  265.       :1, break            ; <ACK>
  266.       :2, continue            ; <NAK>
  267.       :3, continue                  ; ID= again
  268.       :4, end 1 FORCED DISCONNECT    ; Forced disconnect - fatal
  269.     }
  270.     break
  271.     }
  272.     if > \%i 8 end 1
  273.     def \&m[3] "FORCED DISCONNECT"
  274.     def \&m[4] "ERROR INDICATION"
  275.     in 10 \27[p\13            ; Wait for go-ahead
  276.     if fail end 1 NO GO-AHEAD        ; Didn't get it
  277.     for \%i 1 8 1 {            ; Try eight times
  278.     msleep 500
  279.     output \m(blk)            ; Send block
  280.         if \m(TESTING) echo SENT MESSAGE (\%i)
  281.     minput 8 {\6\13} {\21\13} {\13\27\4\13} {\30\13}
  282.         if \m(TESTING) echo RCVD \&m[\v(minput)]
  283.     switch \v(minput) {             ; Get response
  284.       :0, continue                  ; Timeout
  285.       :1, break                     ; <ACK> - success
  286.       :2, continue                  ; <NAK> - transmission error
  287.       :3, end 1 FORCED DISCONNECT
  288.       :4, echo "ERROR - RETRYING", continue
  289.     }
  290.     out \4\13                       ; Sign off with <EOT>
  291.         if \m(TESTING) echo SENT EOT
  292.     in 8 \27\4\13                   ; Get <ESC><EOT> back
  293.         if \m(TESTING) {
  294.             if fail {
  295.                 echo "TIMEOUT (IGNORED)"
  296.             } else {
  297.                 echo "RCVD ACK"
  298.             }
  299.         }
  300.     break
  301.     }
  302.     if > \%i 8 end 1 Too many retries
  303. }
  304.  
  305. ; If invoked as a "kerbang" script execute it now.
  306. ; Otherwise TAKE'ing this file simply defines the macros so you can
  307. ; use them interactively, e.g. 'apage 7654321 "this is a message"'.
  308. ;
  309. if kerbang {
  310.     if not def \%1 asg \%1 \$(PIN)
  311.     if not def \%2 asg \%1 \$(MESSAGE)
  312.     if ( not def \%1 || not def \%2 ) exit 1 {usage: \%0 <pagerid> <message>}
  313.     apage {\%1} {\%2}
  314.     exit \v(status)
  315. } else if > \v(argc) 1 {
  316.     apage {\%1} {\%2}
  317.     exit \v(status)
  318. } else {
  319.     echo APAGE <pin> "<message>" (defined)
  320. }
  321.  
  322. ; (End)
  323.