Annotation of libwww/Library/src/HTReader.c, revision 2.15

2.1       frystyk     1: /*                                                                  HTReader.c
                      2: **     READ STREAM FROM THE NETWORK USING TCP
                      3: **
                      4: **     (c) COPYRIGHT MIT 1995.
                      5: **     Please first read the full copyright statement in the file COPYRIGH.
2.15    ! frystyk     6: **     @(#) $Id: HTReader.c,v 2.14 1996/12/18 17:58:20 frystyk Exp $
2.1       frystyk     7: **
                      8: ** HISTORY:
                      9: **     6 June 95  HFN  Written
                     10: */
                     11: 
                     12: /* Library Include files */
                     13: #include "sysdep.h"
                     14: #include "WWWUtil.h"
2.5       frystyk    15: #include "WWWCore.h"
2.9       frystyk    16: #include "HTHost.h"
2.1       frystyk    17: #include "HTNetMan.h"
                     18: #include "HTReader.h"                                   /* Implemented here */
                     19: 
                     20: struct _HTStream {
                     21:     const HTStreamClass *      isa;
                     22:     /* ... */
                     23: };
                     24: 
                     25: struct _HTInputStream {
                     26:     const HTInputStreamClass * isa;
                     27:     HTChannel *                        ch;
2.9       frystyk    28:     HTHost *                   host;
2.1       frystyk    29:     char *                     write;                  /* Last byte written */
                     30:     char *                     read;                      /* Last byte read */
2.15    ! frystyk    31:     int                                b_read;
2.1       frystyk    32:     char                       data [INPUT_BUFFER_SIZE];          /* buffer */
                     33: };
                     34: 
                     35: /* ------------------------------------------------------------------------- */
                     36: 
                     37: PRIVATE int HTReader_flush (HTInputStream * me)
                     38: {
2.9       frystyk    39:     HTNet * net = HTHost_getReadNet(me->host);
                     40:     return net && net->readStream ? (*net->readStream->isa->flush)(net->readStream) : HT_OK;
2.1       frystyk    41: }
                     42: 
                     43: PRIVATE int HTReader_free (HTInputStream * me)
                     44: {
2.9       frystyk    45:     HTNet * net = HTHost_getReadNet(me->host);
                     46:     if (net && net->readStream) {
                     47:        int status = (*net->readStream->isa->_free)(net->readStream);
                     48:        if (status == HT_OK) net->readStream = NULL;
2.1       frystyk    49:        return status;
                     50:     }
                     51:     return HT_OK;
                     52: }
                     53: 
                     54: PRIVATE int HTReader_abort (HTInputStream * me, HTList * e)
                     55: {
2.9       frystyk    56:     HTNet * net = HTHost_getReadNet(me->host);
                     57:     if (net && net->readStream) {
                     58:        int status = (*net->readStream->isa->abort)(net->readStream, NULL);
                     59:        if (status != HT_IGNORE) net->readStream = NULL;
2.1       frystyk    60:     }
                     61:     return HT_ERROR;
                     62: }
                     63: 
                     64: /*     Push data from a socket down a stream
                     65: **     -------------------------------------
                     66: **
                     67: **   This routine is responsible for creating and PRESENTING any
                     68: **   graphic (or other) objects described by the file. As this function
                     69: **   max reads a chunk of data on size INPUT_BUFFER_SIZE, it can be used
                     70: **   with both blocking or non-blocking sockets. It will always return to
                     71: **   the event loop, however if we are using blocking I/O then we get a full
                     72: **   buffer read, otherwise we get what's available.
                     73: **
                     74: ** Returns      HT_LOADED      if finished reading
                     75: **             HT_OK           if OK, but more to read
                     76: **             HT_ERROR        if error,
                     77: **                     HT_WOULD_BLOCK  if read or write would block
                     78: **             HT_PAUSE        if stream is paused
                     79: */
2.13      eric       80: char * strnstr(char * haystack, int *pLen, char * needle)
                     81: {
                     82:     int found = 0;
                     83:     int need = strlen(needle);
                     84:     int i, start;
                     85:     for (start = i = 0; i < *pLen; i++)
                     86:        if (haystack[i] == needle[found]) {
                     87:            if (++found == need) {
                     88:                i -= need - 1; /* beginning of string */
                     89:                *pLen -= i;
                     90:                return haystack+i;
                     91:            }
                     92:        } else {
                     93:            found = 0;
                     94:        }
                     95:     *pLen = 0;
                     96:     return NULL;
                     97: }
                     98: 
2.9       frystyk    99: int DebugBufferSize = INPUT_BUFFER_SIZE;
                    100: 
2.1       frystyk   101: PRIVATE int HTReader_read (HTInputStream * me)
                    102: {
2.9       frystyk   103:     HTHost * host = me->host;
                    104:     SOCKET soc = HTChannel_socket(me->ch);
                    105:     HTNet * net = HTHost_getReadNet(host);
                    106:     HTRequest * request = HTNet_request(net);
2.1       frystyk   107:     int status;
                    108: 
2.9       frystyk   109:     /*    me->b_read = me->read - me->data; */
2.1       frystyk   110:     /* Read from socket if we got rid of all the data previously read */
                    111:     do {
2.9       frystyk   112:        /* don't read if we have to push unwritten data from last call */
2.1       frystyk   113:        if (me->write >= me->read) {
2.9       frystyk   114:            if ((me->b_read = NETREAD(soc, me->data, DebugBufferSize)) < 0) {
2.1       frystyk   115: #ifdef EAGAIN
                    116:                if (socerrno==EAGAIN || socerrno==EWOULDBLOCK)      /* POSIX */
                    117: #else
                    118:                if (socerrno==EWOULDBLOCK)                            /* BSD */
                    119: #endif 
                    120:                {
                    121:                    if (PROT_TRACE)
                    122:                        HTTrace("Read Socket. WOULD BLOCK fd %d\n",soc);
2.9       frystyk   123:                    HTHost_register(host, net, HTEvent_READ);
2.1       frystyk   124:                    return HT_WOULD_BLOCK;
                    125: #ifdef __svr4__
                    126:     /* 
                    127:     ** In Solaris envirnoment, SIGPOLL is used to signal end of buffer for
                    128:     ** /dev/audio.  If your process is also doing a socket read, it will cause
                    129:     ** an EINTR error.  This error will cause the www library request to 
                    130:     ** terminate prematurly.
                    131:     */
                    132:                 } else if (socerrno == EINTR) {
                    133:                     continue;
                    134: #endif /* __svr4__ */
2.9       frystyk   135: #ifdef EPIPE
                    136:                } else if (socerrno == EPIPE) {
                    137:                    goto socketClosed;
                    138: #endif /* EPIPE */
2.1       frystyk   139:                } else {                             /* We have a real error */
                    140: 
                    141:                    /* HERE WE SHOULD RETURN target abort */
2.9       frystyk   142:                    if (request)
                    143:                        HTRequest_addSystemError(request, ERR_FATAL, socerrno,
                    144:                                                 NO, "NETREAD");
2.1       frystyk   145:                    return HT_ERROR;
                    146:                }
2.8       frystyk   147: #ifdef ECONNRESET
2.9       frystyk   148:            } else if (!me->b_read || socerrno==ECONNRESET) {
2.8       frystyk   149: #else
2.9       frystyk   150:            } else if (!me->b_read) {
2.8       frystyk   151: #endif
2.9       frystyk   152:            socketClosed:
2.11      frystyk   153:                if (PROT_TRACE)
                    154:                    HTTrace("Read Socket. FIN received on socket %d\n", soc);
2.9       frystyk   155:                if (request) {
                    156:                    HTAlertCallback *cbf = HTAlert_find(HT_PROG_DONE);
                    157:                    if (PROT_TRACE)
                    158:                        if (cbf) (*cbf)(request, HT_PROG_DONE,
                    159:                                        HT_MSG_NULL, NULL, NULL, NULL);
                    160:                }
                    161:                HTHost_unregister(host, net, HTEvent_READ);
2.1       frystyk   162:                return HT_CLOSED;
                    163:            }
                    164: 
                    165:            /* Remember how much we have read from the input socket */
2.10      eric      166:            HTTraceData(me->data, me->b_read, "HTReader_read me->data:");
2.1       frystyk   167:            me->write = me->data;
2.9       frystyk   168:            me->read = me->data + me->b_read;
2.13      eric      169: #ifdef FIND_SIGNATURES
                    170:            {
                    171:                char * ptr = me->data;
                    172:                int len = me->b_read;
                    173:                while ((ptr = strnstr(ptr, &len, "HTTP/1.1 200 OK")) != NULL) {
                    174:                    if (PROT_TRACE)
                    175:                        HTTrace("Read Socket. Signature found at 0x%x of 0x%x.\n", ptr - me->data, me->b_read);
                    176:                    ptr++;
                    177:                    len--;
                    178:                }
                    179:            }
                    180: #endif /* FIND_SIGNATURES */
2.1       frystyk   181: #ifdef NOT_ASCII
                    182:            {
                    183:                char *p = me->data;
                    184:                while (p < me->read) {
                    185:                    *p = FROMASCII(*p);
                    186:                    p++;
                    187:                }
                    188:            }
                    189: #endif /* NOT_ASCII */
                    190: 
                    191:            if (PROT_TRACE) 
                    192:                HTTrace("Read Socket. %d bytes read from socket %d\n",
2.9       frystyk   193:                        me->b_read, soc);
                    194:            if (request) {
2.1       frystyk   195:                HTAlertCallback * cbf = HTAlert_find(HT_PROG_READ);
2.9       frystyk   196: #if 0
                    197:                /* byte account is done later */
                    198:                net->bytesRead += me->b_read;
                    199: #endif
                    200:                if (cbf) (*cbf)(request, HT_PROG_READ,
2.1       frystyk   201:                                HT_MSG_NULL, NULL, NULL, NULL);
                    202:            }
                    203:        }
                    204: 
                    205:        /* Now push the data down the stream */
2.9       frystyk   206:        if ((status = (*net->readStream->isa->put_block)
                    207:             (net->readStream, me->write, me->b_read)) != HT_OK) {
2.1       frystyk   208:            if (status == HT_WOULD_BLOCK) {
                    209:                if (PROT_TRACE) HTTrace("Read Socket. Target WOULD BLOCK\n");
2.9       frystyk   210:                HTHost_unregister(host, net, HTEvent_READ);
2.1       frystyk   211:                return HT_WOULD_BLOCK;
                    212:            } else if (status == HT_PAUSE) {
                    213:                if (PROT_TRACE) HTTrace("Read Socket. Target PAUSED\n");
2.9       frystyk   214:                HTHost_unregister(host, net, HTEvent_READ);
2.1       frystyk   215:                return HT_PAUSE;
2.9       frystyk   216:            /* CONTINUE code or stream code means data was consumed */
                    217:            } else if (status == HT_CONTINUE || status > 0) {
                    218:                if (status == HT_CONTINUE) {
                    219:                    if (PROT_TRACE) HTTrace("Read Socket. CONTINUE\n");
                    220:                } else
                    221:                    if (PROT_TRACE)
                    222:                        HTTrace("Read Socket. Target returns %d\n", status);
                    223: /*             me->write = me->read; */
2.1       frystyk   224:                return status;
                    225:            } else {                                 /* We have a real error */
                    226:                if (PROT_TRACE) HTTrace("Read Socket. Target ERROR\n");
                    227:                return status;
                    228:            }
                    229:        }
2.9       frystyk   230:        me->write = me->read;
                    231:        HTHost_setRemainingRead(host, 0);
2.1       frystyk   232:     } while (net->preemptive);
2.9       frystyk   233:     HTHost_register(host, net, HTEvent_READ);
2.1       frystyk   234:     return HT_WOULD_BLOCK;
                    235: }
                    236: 
                    237: /*
                    238: **     The difference between the close and the free method is that we don't
                    239: **     close the connection in the free method - we only call the free method
                    240: **     of the target stream. That way, we can keep the input stream as long 
                    241: **     as the channel itself.
                    242: */
                    243: PRIVATE int HTReader_close (HTInputStream * me)
                    244: {
                    245:     int status = HT_OK;
2.9       frystyk   246:     HTNet * net = HTHost_getReadNet(me->host);
                    247:     if (net && net->readStream) {
                    248:        if ((status = (*net->readStream->isa->_free)(net->readStream))==HT_WOULD_BLOCK)
2.1       frystyk   249:            return HT_WOULD_BLOCK;
2.9       frystyk   250:        net->readStream = NULL;
2.1       frystyk   251:     }
                    252:     if (PROT_TRACE) HTTrace("Socket read. FREEING....\n");
                    253:     HT_FREE(me);
                    254:     return status;
                    255: }
                    256: 
2.9       frystyk   257: PUBLIC int HTReader_consumed (HTInputStream * me, size_t bytes)
                    258: {
                    259:     me->write += bytes;
                    260:     me->b_read -= bytes;
                    261:     HTHost_setRemainingRead(me->host, me->b_read);
                    262:     return HT_OK;
                    263: }
                    264: 
2.1       frystyk   265: PRIVATE const HTInputStreamClass HTReader =
                    266: {
                    267:     "SocketReader",
                    268:     HTReader_flush,
                    269:     HTReader_free,
                    270:     HTReader_abort,
                    271:     HTReader_read,
2.9       frystyk   272:     HTReader_close,
                    273:     HTReader_consumed
2.1       frystyk   274: }; 
                    275: 
                    276: /*
                    277: **     Create a new input read stream. Before we actually create it we check
                    278: **     to see whether we already have an input stream for this channel and if
                    279: **     so we just return that. This means that we can reuse input streams 
                    280: **     in persistent connections, for example.
                    281: */
2.9       frystyk   282: PUBLIC HTInputStream * HTReader_new (HTHost * host, HTChannel * ch,
                    283:                                     void * param, int mode)
2.1       frystyk   284: {
2.9       frystyk   285:     if (host && ch) {
2.1       frystyk   286:        HTInputStream * me = HTChannel_input(ch);
                    287:        if (me == NULL) {
                    288:            if ((me=(HTInputStream *) HT_CALLOC(1, sizeof(HTInputStream))) == NULL)
                    289:            HT_OUTOFMEM("HTReader_new");
                    290:            me->isa = &HTReader;
                    291:            me->ch = ch;
2.9       frystyk   292:            me->host = host;
2.1       frystyk   293:        }
                    294:        return me;
                    295:     }
                    296:     return NULL;
                    297: }
2.9       frystyk   298: 

Webmaster