Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Routine: ONCX10A

ONCX10A.m

Go to the documentation of this file. 
  1. ONCX10A ;HCIOFO/SG - HTTP 1.0 CLIENT (TOOLS) ; 8/11/04 8:26am
  1.  ;;2.2;ONCOLOGY;**1**;Jul 31, 2013;Build 8
  1.  ;
  1.  Q
  1.  ;
  1.  ;***** APPENDS RECEIVED PIECE OF DATA TO THE DESTINATION BUFFER
  1.  ;
  1.  ; BUF           Received data
  1.  ;
  1.  ; [NEWLINE]     Start a new line after appending the data
  1.  ;
  1.  ; The ONC8BUF, ONC8DST, ONC8IS, ONC8MBL, ONC8PTR, and ONC8SL
  1.  ; variables must be properly initialized before calling this
  1.  ; procedure (see the $$RECEIVE^ONCX10A for details).
  1.  ;
  1. APPEND(BUF,NEWLINE) ;
  1.  N BASE,L
  1.  S L=$L(BUF)  S:$A(BUF,L)=13 L=L-1
  1.  ;--- Append the data
  1.  I L'<ONC8SL  D
  1.  . S ONC8BUF=ONC8BUF_$E(BUF,1,ONC8SL),L=L-ONC8SL
  1.  . S BASE=1
  1.  . F  D  Q:L'>0
  1.  . . I 'ONC8IS  S @ONC8DST@(ONC8PTR)=ONC8BUF
  1.  . . E  S @ONC8DST@(ONC8PTR,ONC8IS)=ONC8BUF
  1.  . . S BASE=BASE+ONC8SL,ONC8IS=ONC8IS+1,ONC8SL=ONC8MBL
  1.  . . S ONC8BUF=$E(BUF,BASE,BASE+ONC8SL-1),L=L-ONC8SL
  1.  . S ONC8SL=-L
  1.  E  S ONC8BUF=ONC8BUF_$E(BUF,1,L),ONC8SL=ONC8SL-L
  1.  ;--- Flush the buffer and start a new line
  1.  I $G(NEWLINE)  D  S ONC8BUF="",ONC8IS=0,ONC8PTR=ONC8PTR+1,ONC8SL=ONC8MBL
  1.  . I 'ONC8IS  S @ONC8DST@(ONC8PTR)=ONC8BUF  Q
  1.  . S @ONC8DST@(ONC8PTR,ONC8IS)=ONC8BUF
  1.  Q
  1.  ;
  1.  ;***** CALCULATES NUMBER OF BYTES IN THE MESSAGE BODY
  1.  ;
  1.  ; ONC8DATA      Closed root of a variable containing body
  1.  ;               of the message
  1.  ;
  1.  ; NLS           Length of the line terminator(s)
  1.  ;
  1. DATASIZE(ONC8DATA,NLS) ;
  1.  N SIZE
  1.  S SIZE=0
  1.  F  S I=$O(@ONC8DATA@(I))  Q:I=""  D  S SIZE=SIZE+NLS
  1.  . S SIZE=SIZE+$L($G(@ONC8DATA@(I)))
  1.  . S J=""
  1.  . F  S J=$O(@ONC8DATA@(I,J))  Q:J=""  D
  1.  . . S SIZE=SIZE+$L($G(@ONC8DATA@(I,J)))
  1.  Q $S(SIZE>0:SIZE-NLS,1:0)
  1.  ;
  1.  ;***** PROCESSES THE HTTP HEADER
  1.  ;
  1.  ; .ONC8H        Reference to a local array containing
  1.  ;               the raw header data
  1.  ;
  1.  ; .ONC8HDR      Reference to a local variable where the parsed
  1.  ;               header will be returned
  1.  ;
  1.  ; Return values:
  1.  ;       <0  Error Descriptor
  1.  ;       >0  HTTP Status Code^Description
  1.  ;
  1.  N BUF,I,NAME,TAB,TMP
  1.  S ONC8HDR=$$NORMSTAT($G(ONC8H(1))),TAB=$C(9)
  1.  F I=2:1  S BUF=$TR($G(ONC8H(I)),TAB," ")  Q:BUF=""  D
  1.  . ;--- Continuation of the previous header line
  1.  . I $E(BUF,1)=" "  D:$G(NAME)'=""  Q
  1.  . . S TMP=$$TRIM^XLFSTR(BUF)
  1.  . . S:TMP'="" ONC8HDR(NAME)=ONC8HDR(NAME)_" "_TMP
  1.  . ;--- New header line
  1.  . S NAME=$$UP^XLFSTR($$TRIM^XLFSTR($P(BUF,":")))
  1.  . S:NAME'="" ONC8HDR(NAME)=$$TRIM^XLFSTR($P(BUF,":",2,999))
  1.  Q $P(ONC8HDR," ",2)_U_$P(ONC8HDR," ",3,999)
  1.  ;
  1.  ;***** NORMALIZES THE HTTP STATUS LINE
  1. NORMSTAT(STATUS) ;
  1.  N I,J1,J2,TMP
  1.  ;--- Remove leading and trailing spaces
  1.  S STATUS=$$TRIM^XLFSTR(STATUS)
  1.  ;--- Replace groups of consecutive spaces with single spaces
  1.  S J2=1
  1.  F I=1,2  D  Q:'J1
  1.  . S J1=$F(STATUS," ",J2)  Q:'J1
  1.  . F J2=J1:1  Q:$E(STATUS,J2)'=" "
  1.  . S $E(STATUS,J1,J2-1)=""
  1.  ;--- Return normalized status line
  1.  Q STATUS
  1.  ;
  1.  ;***** RECEIVES AN HTTP RESPONSE
  1.  ;
  1.  ; TIMEOUT       Timeout value (in seconds) for TCPIP input.
  1.  ;
  1.  ; [ONC8DATA]    Closed root of the variable where the message
  1.  ;               body is returned. See the $$GETURL^ONCX10
  1.  ;               for details.
  1.  ;
  1.  ; [.ONC8HDR]    Reference to a local variable where the parsed
  1.  ;               headers will be returned. See the $$GETURL^ONCX10
  1.  ;               for details.
  1.  ;
  1. RECEIVE(TIMEOUT,ONC8DATA,ONC8HDR) ;
  1.  ; ONC8BUF       Work buffer where the current line is being built
  1.  ; ONC8DST       Closed root of the current destination buffer used
  1.  ;               by the APPEND^ONCX10A
  1.  ; ONC8H         Temporary buffer for the raw HTTP header
  1.  ; ONC8IS        Subscript of the current continuation sub-node in
  1.  ;               the destination buffer (if 0 then the current main
  1.  ;               node is used)
  1.  ; ONC8MBL       Maximum buffer length
  1.  ; ONC8PTR       Subscript of the current node in the dest. buffer
  1.  ; ONC8SL        Number of available bytes in the current (sub)node
  1.  ;
  1.  N $ESTACK,$ETRAP,BLCHS,BUF,EXIT,I1,I2,MBL,ONC8BUF,ONC8DST,ONC8H,ONC8IS,ONC8MBL,ONC8PTR,ONC8SL,RTO,STATUS,TMP,X
  1.  S BLCHS=$C(9,10,12,13)_" ",ONC8MBL=245
  1.  K:$G(ONC8DATA)'="" @ONC8DATA  K ONC8HDR
  1.  S ONC8BUF="",ONC8IS=0,ONC8PTR=1,ONC8SL=ONC8MBL
  1.  ;--- Setup the error processing
  1.  S X="RCVERR^ONCX10A",@^%ZOSF("TRAP"),$ETRAP=""
  1.  ;--- Receive the header (until the first empty line)
  1.  U IO
  1.  S ONC8DST="ONC8H",(EXIT,RTO)=0
  1.  F  R BUF#ONC8MBL:TIMEOUT  S RTO='$T  D  Q:EXIT!RTO
  1.  . S I1=1
  1.  . F  S I2=$F(BUF,$C(10),I1)  Q:'I2  D  Q:EXIT
  1.  . . S TMP=$E(BUF,I1,I2-2)  D APPEND(TMP,1)  S I1=I2
  1.  . . S:$TR(TMP,BLCHS)="" EXIT=1
  1.  . D:'EXIT APPEND($E(BUF,I1,ONC8MBL))
  1.  ;--- A header must end with an empty line.
  1.  ;--- Otherwise, there was a timeout.
  1.  Q:'EXIT $$ERROR^ONCXERR(-7)
  1.  ;--- Remove ending of the header from the buffer. The buffer
  1.  ;--- can contain beginning of the message body.
  1.  S:I1>1 $E(BUF,1,I1-1)=""
  1.  ;--- Process the header
  1.  S STATUS=$$HEADER(.ONC8H,.ONC8HDR)
  1.  ;--- Receive the message body
  1.  D:$G(ONC8DATA)'=""
  1.  . N CNTLEN,RDLEN
  1.  . S RDLEN=ONC8MBL
  1.  . ;--- Check for Content-Length header
  1.  . I $D(ONC8HDR("CONTENT-LENGTH"))  D  Q:CNTLEN'>0
  1.  . . S CNTLEN=+ONC8HDR("CONTENT-LENGTH")
  1.  . . S:CNTLEN<ONC8MBL RDLEN=CNTLEN
  1.  . E  S CNTLEN=-1
  1.  . ;--- Read the content
  1.  . S ONC8DST=ONC8DATA,RTO=0
  1.  . F  D  Q:'CNTLEN!RTO  R BUF#RDLEN:TIMEOUT  S RTO='$T
  1.  . . D:CNTLEN>0
  1.  . . . S CNTLEN=CNTLEN-$L(BUF)  S:CNTLEN<0 CNTLEN=0
  1.  . . . S:CNTLEN<RDLEN RDLEN=CNTLEN
  1.  . . S I1=1
  1.  . . F  S I2=$F(BUF,$C(10),I1)  Q:'I2  D
  1.  . . . D APPEND($E(BUF,I1,I2-2),1)  S I1=I2
  1.  . . D APPEND($E(BUF,I1,ONC8MBL))
  1.  ;--- Flush the buffers and process the header (only if necessary)
  1. RCVERR U $P
  1.  D APPEND("",1)
  1.  S:$G(STATUS)="" STATUS=$$HEADER(.ONC8H,.ONC8HDR)
  1.  Q STATUS
  1.  ;
  1.  ;***** SENDS THE HTTP REQUEST
  1.  ;
  1.  ; URI           Request URI
  1.  ;
  1.  ; [ONC8DATA]    Closed root of a variable containing body of the
  1.  ;               request message. If this parameter is defined, not
  1.  ;               empty, and the referenced variable is defined then
  1.  ;               the POST request is generated. Otherwise, the GET
  1.  ;               request is sent.
  1.  ;
  1.  ; [.ONC8HDR]    Reference to a local variable containing header
  1.  ;               values
  1.  ;
  1.  ; Return values:
  1.  ;       <0  Error Code^Description
  1.  ;    "GET"  Ok
  1.  ;   "POST"  Ok
  1.  ;
  1. REQUEST(URI,ONC8DATA,ONC8HDR) ;
  1.  N CRLF,DFLTHDR,I,J,STATUS
  1.  S CRLF=$C(13,10)
  1.  ;--- Check for default header(s)
  1.  S DFLTHDR("CONTENT-LENGTH")=""
  1.  S DFLTHDR("CONTENT-TYPE")=""
  1.  S DFLTHDR("USER-AGENT")=""
  1.  S I=""
  1.  F  S I=$O(ONC8HDR(I))  Q:I=""  K DFLTHDR($$UP^XLFSTR(I))
  1.  S:$D(DFLTHDR("USER-AGENT")) ONC8HDR("User-Agent")="VistA/1.0"
  1.  ;--- Send the request
  1.  U IO
  1.  I $G(ONC8DATA)'="",$D(@ONC8DATA)>1  S STATUS="POST"  D
  1.  . S:$D(DFLTHDR("CONTENT-TYPE")) ONC8HDR("Content-Type")="text/html"
  1.  . D:$D(DFLTHDR("CONTENT-LENGTH"))
  1.  . . S ONC8HDR("Content-Length")=$$DATASIZE(ONC8DATA,$L(CRLF))
  1.  . W "POST "_URI_" HTTP/1.0",CRLF,!
  1.  . ;--- Header
  1.  . S I=""
  1.  . F  S I=$O(ONC8HDR(I))  Q:I=""  W I_": "_ONC8HDR(I),CRLF,!
  1.  . ;--- Body
  1.  . S I=""
  1.  . F  S I=$O(@ONC8DATA@(I))  Q:I=""  D
  1.  . . W CRLF,$G(@ONC8DATA@(I)),!
  1.  . . S J=""
  1.  . . F  S J=$O(@ONC8DATA@(I,J))  Q:J=""  W $G(@ONC8DATA@(I,J)),!
  1.  E  S STATUS="GET"  D
  1.  . W "GET "_URI_" HTTP/1.0",CRLF,!
  1.  . S I=""
  1.  . F  S I=$O(ONC8HDR(I))  Q:I=""  W I_": "_ONC8HDR(I),CRLF,!
  1.  . W CRLF,!
  1.  U $P
  1.  Q STATUS