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

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

Webmaster