Added missing "static" declarations
[people/sha0/gpxe.git] / src / net / tcp / http.c
index 56e15af..88958af 100644 (file)
-#include <stddef.h>
-#include <string.h>
-#include <vsprintf.h>
-#include <assert.h>
-#include <gpxe/async.h>
-#include <gpxe/http.h>
-
-/** @file
+/*
+ * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
  *
- * The Hyper Text Transfer Protocol (HTTP)
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or any later version.
  *
- * This file implements the TCP-based HTTP protocol. It connects to the
- * server specified in http_request::tcp and transmit an HTTP GET request
- * for the file specified in http_request::filename. It then decoded the
- * HTTP header, determining file status and file size. Then sends the file
- * to the callback function at http_request::callback().
- * **NOTE**: still working on correcting the closing of the tcp connection
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
  *
- * To use this code, do something like:
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
+
+/**
+ * @file
  *
- * @code
+ * Hyper Text Transfer Protocol (HTTP)
  *
- *   static void my_callback ( struct http_request *http, char *data, size_t len ) {
- *     ... process data ...
- *   }
+ */
+
+#include <stdint.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include <strings.h>
+#include <byteswap.h>
+#include <errno.h>
+#include <assert.h>
+#include <gpxe/uri.h>
+#include <gpxe/refcnt.h>
+#include <gpxe/iobuf.h>
+#include <gpxe/xfer.h>
+#include <gpxe/open.h>
+#include <gpxe/socket.h>
+#include <gpxe/tcpip.h>
+#include <gpxe/process.h>
+#include <gpxe/linebuf.h>
+#include <gpxe/tls.h>
+#include <gpxe/http.h>
+
+/** HTTP receive state */
+enum http_rx_state {
+       HTTP_RX_RESPONSE = 0,
+       HTTP_RX_HEADER,
+       HTTP_RX_DATA,
+       HTTP_RX_DEAD,
+};
+
+/**
+ * An HTTP request
  *
- *   struct http_request http = {
- *     .filename = "path/to/file",
- *     .callback = my_callback,
- *   };
+ */
+struct http_request {
+       /** Reference count */
+       struct refcnt refcnt;
+       /** Data transfer interface */
+       struct xfer_interface xfer;
+
+       /** URI being fetched */
+       struct uri *uri;
+       /** Transport layer interface */
+       struct xfer_interface socket;
+
+       /** TX process */
+       struct process process;
+
+       /** HTTP response code */
+       unsigned int response;
+       /** HTTP Content-Length */
+       size_t content_length;
+       /** Received length */
+       size_t rx_len;
+       /** RX state */
+       enum http_rx_state rx_state;
+       /** Line buffer for received header lines */
+       struct line_buffer linebuf;
+};
+
+/**
+ * Free HTTP request
  *
- *   ... assign http.tcp.server ...
+ * @v refcnt           Reference counter
+ */
+static void http_free ( struct refcnt *refcnt ) {
+       struct http_request *http =
+               container_of ( refcnt, struct http_request, refcnt );
+
+       uri_put ( http->uri );
+       empty_line_buffer ( &http->linebuf );
+       free ( http );
+};
+
+/**
+ * Mark HTTP request as complete
  *
- *   rc = async_wait ( get_http ( &http ) );
+ * @v http             HTTP request
+ * @v rc               Return status code
+ */
+static void http_done ( struct http_request *http, int rc ) {
+
+       /* Prevent further processing of any current packet */
+       http->rx_state = HTTP_RX_DEAD;
+
+       /* If we had a Content-Length, and the received content length
+        * isn't correct, flag an error
+        */
+       if ( http->content_length &&
+            ( http->content_length != http->rx_len ) ) {
+               DBGC ( http, "HTTP %p incorrect length %zd, should be %zd\n",
+                      http, http->rx_len, http->content_length );
+               rc = -EIO;
+       }
+
+       /* Remove process */
+       process_del ( &http->process );
+
+       /* Close all data transfer interfaces */
+       xfer_nullify ( &http->socket );
+       xfer_close ( &http->socket, rc );
+       xfer_nullify ( &http->xfer );
+       xfer_close ( &http->xfer, rc );
+}
+
+/**
+ * Convert HTTP response code to return status code
  *
- * @endcode
+ * @v response         HTTP response code
+ * @ret rc             Return status code
+ */
+static int http_response_to_rc ( unsigned int response ) {
+       switch ( response ) {
+       case 200:
+               return 0;
+       case 404:
+               return -ENOENT;
+       case 403:
+               return -EPERM;
+       default:
+               return -EIO;
+       }
+}
+
+/**
+ * Handle HTTP response
  *
+ * @v http             HTTP request
+ * @v response         HTTP response
+ * @ret rc             Return status code
  */
+static int http_rx_response ( struct http_request *http, char *response ) {
+       char *spc;
+       int rc;
+
+       DBGC ( http, "HTTP %p response \"%s\"\n", http, response );
 
-static inline struct http_request *
-tcp_to_http ( struct tcp_connection *conn ) {
-       return container_of ( conn, struct http_request, tcp );
+       /* Check response starts with "HTTP/" */
+       if ( strncmp ( response, "HTTP/", 5 ) != 0 )
+               return -EIO;
+
+       /* Locate and check response code */
+       spc = strchr ( response, ' ' );
+       if ( ! spc )
+               return -EIO;
+       http->response = strtoul ( spc, NULL, 10 );
+       if ( ( rc = http_response_to_rc ( http->response ) ) != 0 )
+               return rc;
+
+       /* Move to received headers */
+       http->rx_state = HTTP_RX_HEADER;
+       return 0;
 }
 
 /**
- * Close an HTTP connection
+ * Handle HTTP Content-Length header
  *
- * @v conn     a TCP Connection
- * @v status   connection status at close
+ * @v http             HTTP request
+ * @v value            HTTP header value
+ * @ret rc             Return status code
  */
-static void http_closed ( struct tcp_connection *conn, int status ) {
-       struct http_request *http = tcp_to_http ( conn );
-       async_done ( &http->aop, status );
+static int http_rx_content_length ( struct http_request *http,
+                                   const char *value ) {
+       char *endp;
+
+       http->content_length = strtoul ( value, &endp, 10 );
+       if ( *endp != '\0' ) {
+               DBGC ( http, "HTTP %p invalid Content-Length \"%s\"\n",
+                      http, value );
+               return -EIO;
+       }
+
+       /* Use seek() to notify recipient of filesize */
+       xfer_seek ( &http->xfer, http->content_length, SEEK_SET );
+       xfer_seek ( &http->xfer, 0, SEEK_SET );
+
+       return 0;
 }
 
+/** An HTTP header handler */
+struct http_header_handler {
+       /** Name (e.g. "Content-Length") */
+       const char *header;
+       /** Handle received header
+        *
+        * @v http      HTTP request
+        * @v value     HTTP header value
+        * @ret rc      Return status code
+        *
+        * If an error is returned, the download will be aborted.
+        */
+       int ( * rx ) ( struct http_request *http, const char *value );
+};
+
+/** List of HTTP header handlers */
+static struct http_header_handler http_header_handlers[] = {
+       {
+               .header = "Content-Length",
+               .rx = http_rx_content_length,
+       },
+       { NULL, NULL }
+};
+
 /**
- * Callback after a TCP connection is established
+ * Handle HTTP header
  *
- * @v conn     a TCP Connection
+ * @v http             HTTP request
+ * @v header           HTTP header
+ * @ret rc             Return status code
  */
-static void http_connected ( struct tcp_connection *conn ) {
-       struct http_request *http = tcp_to_http ( conn );
+static int http_rx_header ( struct http_request *http, char *header ) {
+       struct http_header_handler *handler;
+       char *separator;
+       char *value;
+       int rc;
+
+       /* An empty header line marks the transition to the data phase */
+       if ( ! header[0] ) {
+               DBGC ( http, "HTTP %p start of data\n", http );
+               empty_line_buffer ( &http->linebuf );
+               http->rx_state = HTTP_RX_DATA;
+               return 0;
+       }
+
+       DBGC ( http, "HTTP %p header \"%s\"\n", http, header );
 
-       http->state = HTTP_REQUEST_FILE;
+       /* Split header at the ": " */
+       separator = strstr ( header, ": " );
+       if ( ! separator ) {
+               DBGC ( http, "HTTP %p malformed header\n", http );
+               return -EIO;
+       }
+       *separator = '\0';
+       value = ( separator + 2 );
+
+       /* Hand off to header handler, if one exists */
+       for ( handler = http_header_handlers ; handler->header ; handler++ ) {
+               if ( strcasecmp ( header, handler->header ) == 0 ) {
+                       if ( ( rc = handler->rx ( http, value ) ) != 0 )
+                               return rc;
+                       break;
+               }
+       }
+       return 0;
 }
 
+/** An HTTP line-based data handler */
+struct http_line_handler {
+       /** Handle line
+        *
+        * @v http      HTTP request
+        * @v line      Line to handle
+        * @ret rc      Return status code
+        */
+       int ( * rx ) ( struct http_request *http, char *line );
+};
+
+/** List of HTTP line-based data handlers */
+static struct http_line_handler http_line_handlers[] = {
+       [HTTP_RX_RESPONSE]      = { .rx = http_rx_response },
+       [HTTP_RX_HEADER]        = { .rx = http_rx_header },
+};
+
 /**
- * Callback for when TCP data is acknowledged
+ * Handle new data arriving via HTTP connection in the data phase
  *
- * @v conn     a TCP Connection
- * @v len      the length of data acked
+ * @v http             HTTP request
+ * @v iobuf            I/O buffer
+ * @ret rc             Return status code
  */
-static void http_acked ( struct tcp_connection *conn, size_t len ) {
-       struct http_request *http = tcp_to_http ( conn );
-
-       // assume that the whole GET request was sent in on epacket
-
-       switch ( http->state ) {
-       case HTTP_REQUEST_FILE:
-               http->state = HTTP_PARSE_HEADER;
-               break;
-       case HTTP_PARSE_HEADER:
-       case HTTP_RECV_FILE:
-               break;
-       case HTTP_DONE:
-               //tcp_close(conn);
-               break;
-       default:
-               break;
+static int http_rx_data ( struct http_request *http,
+                         struct io_buffer *iobuf ) {
+       int rc;
+
+       /* Update received length */
+       http->rx_len += iob_len ( iobuf );
+
+       /* Hand off data buffer */
+       if ( ( rc = xfer_deliver_iob ( &http->xfer, iobuf ) ) != 0 )
+               return rc;
+
+       /* If we have reached the content-length, stop now */
+       if ( http->content_length &&
+            ( http->rx_len >= http->content_length ) ) {
+               http_done ( http, 0 );
        }
-       //printf("acked\n");
+
+       return 0;
 }
 
 /**
- * Callback when new TCP data is recieved
+ * Handle new data arriving via HTTP connection
  *
- * @v conn     a TCP Connection
- * @v data     a pointer to the data recieved
- * @v len      length of data buffer
+ * @v socket           Transport layer interface
+ * @v iobuf            I/O buffer
+ * @v meta             Data transfer metadata, or NULL
+ * @ret rc             Return status code
  */
-static void http_newdata ( struct tcp_connection *conn, void *data,
-                           size_t len ) {
-       struct http_request *http = tcp_to_http ( conn );
-       char *content_length;
-       char *start = data;
-       char *rcp; int rc;
-
-       switch ( http->state ) {
-       case HTTP_PARSE_HEADER:
-               if(strncmp("HTTP/",data,5) != 0){
-                       // no http header
-                       printf("Error: no HTTP Header\n");
-               }
-               // if rc is not 200, then handle problem
-               // either redirect or not there
-               rcp = strstr(data,"HTTP");
-               if(rcp == NULL){ printf("Could not find header status line.\n"); }
-               rcp += 9;
-               rc = strtoul(rcp,NULL,10);
-               printf("RC=%d\n",rc);
-               content_length = strstr(data,"Content-Length: ");
-               if(content_length != NULL){
-                       content_length += 16;
-                       http->file_size = strtoul(content_length,NULL,10);
-                       http->file_recv = 0;
-                       printf("http->file_size = %d\n", http->file_size);
-               }
-               start = strstr(data,"\r\n\r\n");
-               if(start == NULL){ printf("No end of header\n"); }
-               else{
-                       start += 4;
-                       len -= ((void *)start - data);
-                       http->state = HTTP_RECV_FILE;
-               }
+static int http_socket_deliver_iob ( struct xfer_interface *socket,
+                                    struct io_buffer *iobuf,
+                                    struct xfer_metadata *meta __unused ) {
+       struct http_request *http =
+               container_of ( socket, struct http_request, socket );
+       struct http_line_handler *lh;
+       char *line;
+       ssize_t len;
+       int rc = 0;
 
-               if ( http->state != HTTP_RECV_FILE )
+       while ( iob_len ( iobuf ) ) {
+               switch ( http->rx_state ) {
+               case HTTP_RX_DEAD:
+                       /* Do no further processing */
+                       goto done;
+               case HTTP_RX_DATA:
+                       /* Once we're into the data phase, just fill
+                        * the data buffer
+                        */
+                       rc = http_rx_data ( http, iobuf );
+                       iobuf = NULL;
+                       goto done;
+               case HTTP_RX_RESPONSE:
+               case HTTP_RX_HEADER:
+                       /* In the other phases, buffer and process a
+                        * line at a time
+                        */
+                       len = line_buffer ( &http->linebuf, iobuf->data,
+                                           iob_len ( iobuf ) );
+                       if ( len < 0 ) {
+                               rc = len;
+                               DBGC ( http, "HTTP %p could not buffer line: "
+                                      "%s\n", http, strerror ( rc ) );
+                               goto done;
+                       }
+                       iob_pull ( iobuf, len );
+                       line = buffered_line ( &http->linebuf );
+                       if ( line ) {
+                               lh = &http_line_handlers[http->rx_state];
+                               if ( ( rc = lh->rx ( http, line ) ) != 0 )
+                                       goto done;
+                       }
+                       break;
+               default:
+                       assert ( 0 );
                        break;
-       case HTTP_RECV_FILE:
-               http->callback(http,start,len);
-               //http->file_size -= len;
-               //printf("File recv is %d\n", http->file_recv);
-               if ( http->file_recv == http->file_size ){
-                       http->state = HTTP_DONE;
-                       tcp_close(conn);
                }
-               break;
-       case HTTP_REQUEST_FILE:
-       case HTTP_DONE:
-       default:
-               break;
        }
+
+ done:
+       if ( rc )
+               http_done ( http, rc );
+       free_iob ( iobuf );
+       return rc;
 }
 
 /**
- * Callback for sending TCP data
+ * HTTP process
  *
- * @v conn     a TCP Connection
+ * @v process          Process
  */
-static void http_senddata ( struct tcp_connection *conn, void *buf, size_t len ) {
-       struct http_request *http = tcp_to_http ( conn );
-       char buf[66]; // 16 request + 50 for filename
-       size_t len;
-
-       switch ( http->state ){
-       case HTTP_REQUEST_FILE:
-               len = snprintf(buf,66,"GET %s HTTP/1.0\r\n\r\n",http->filename);
-               printf("%s\n",buf);
-               // string is: GET <file> HTTP/1.0\r\n\r\n
-
-               tcp_send ( conn, buf, len);
-               break;
-       case HTTP_PARSE_HEADER:
-       case HTTP_RECV_FILE:
-               break;
-       case HTTP_DONE:
-               //tcp_close(conn)
-               break;
-       default:
-               break;
+static void http_step ( struct process *process ) {
+       struct http_request *http =
+               container_of ( process, struct http_request, process );
+       const char *path = http->uri->path;
+       const char *host = http->uri->host;
+       const char *query = http->uri->query;
+       int rc;
+
+       if ( xfer_window ( &http->socket ) ) {
+               process_del ( &http->process );
+               if ( ( rc = xfer_printf ( &http->socket,
+                                         "GET %s%s%s HTTP/1.1\r\n"
+                                         "User-Agent: gPXE/" VERSION "\r\n"
+                                         "Host: %s\r\n"
+                                         "\r\n",
+                                         ( path ? path : "/" ),
+                                         ( query ? "?" : "" ),
+                                         ( query ? query : "" ),
+                                         host ) ) != 0 ) {
+                       http_done ( http, rc );
+               }
        }
 }
 
-static struct tcp_operations http_tcp_operations = {
-       .closed         = http_closed,
-       .connected      = http_connected,
-       .acked          = http_acked,
-       .newdata        = http_newdata,
-       .senddata       = http_senddata,
+/**
+ * HTTP connection closed by network stack
+ *
+ * @v socket           Transport layer interface
+ * @v rc               Reason for close
+ */
+static void http_socket_close ( struct xfer_interface *socket, int rc ) {
+       struct http_request *http =
+               container_of ( socket, struct http_request, socket );
+
+       DBGC ( http, "HTTP %p socket closed: %s\n",
+              http, strerror ( rc ) );
+       
+       http_done ( http, rc );
+}
+
+/** HTTP socket operations */
+static struct xfer_interface_operations http_socket_operations = {
+       .close          = http_socket_close,
+       .vredirect      = xfer_vopen,
+       .seek           = ignore_xfer_seek,
+       .window         = unlimited_xfer_window,
+       .alloc_iob      = default_xfer_alloc_iob,
+       .deliver_iob    = http_socket_deliver_iob,
+       .deliver_raw    = xfer_deliver_as_iob,
+};
+
+/**
+ * Close HTTP data transfer interface
+ *
+ * @v xfer             Data transfer interface
+ * @v rc               Reason for close
+ */
+static void http_xfer_close ( struct xfer_interface *xfer, int rc ) {
+       struct http_request *http =
+               container_of ( xfer, struct http_request, xfer );
+
+       DBGC ( http, "HTTP %p interface closed: %s\n",
+              http, strerror ( rc ) );
+
+       http_done ( http, rc );
+}
+
+/** HTTP data transfer interface operations */
+static struct xfer_interface_operations http_xfer_operations = {
+       .close          = http_xfer_close,
+       .vredirect      = ignore_xfer_vredirect,
+       .seek           = ignore_xfer_seek,
+       .window         = unlimited_xfer_window,
+       .alloc_iob      = default_xfer_alloc_iob,
+       .deliver_iob    = xfer_deliver_as_raw,
+       .deliver_raw    = ignore_xfer_deliver_raw,
 };
 
 /**
- * Initiate a HTTP connection
+ * Initiate an HTTP connection
  *
- * @v http     a HTTP request
+ * @v xfer             Data transfer interface
+ * @v uri              Uniform Resource Identifier
+ * @ret rc             Return status code
  */
-struct async_operation * get_http ( struct http_request *http ) {
-       http->tcp.tcp_op = &http_tcp_operations;
-       http->state = HTTP_REQUEST_FILE;
-       tcp_connect ( &http->tcp );
-       return &http->aop;
+int http_open ( struct xfer_interface *xfer, struct uri *uri ) {
+       struct http_request *http;
+       struct sockaddr_tcpip server;
+       int rc;
+
+       /* Sanity checks */
+       if ( ! uri->host )
+               return -EINVAL;
+
+       /* Allocate and populate HTTP structure */
+       http = zalloc ( sizeof ( *http ) );
+       if ( ! http )
+               return -ENOMEM;
+       http->refcnt.free = http_free;
+       xfer_init ( &http->xfer, &http_xfer_operations, &http->refcnt );
+               http->uri = uri_get ( uri );
+       xfer_init ( &http->socket, &http_socket_operations, &http->refcnt );
+       process_init ( &http->process, http_step, &http->refcnt );
+
+       /* Open socket */
+       memset ( &server, 0, sizeof ( server ) );
+       server.st_port = htons ( uri_port ( http->uri, HTTP_PORT ) );
+       if ( ( rc = xfer_open_named_socket ( &http->socket, SOCK_STREAM,
+                                            ( struct sockaddr * ) &server,
+                                            uri->host, NULL ) ) != 0 )
+               goto err;
+
+#if 0
+       if ( strcmp ( http->uri->scheme, "https" ) == 0 ) {
+               st->st_port = htons ( uri_port ( http->uri, HTTPS_PORT ) );
+               if ( ( rc = add_tls ( &http->stream ) ) != 0 )
+                       goto err;
+       }
+#endif
+
+       /* Attach to parent interface, mortalise self, and return */
+       xfer_plug_plug ( &http->xfer, xfer );
+       ref_put ( &http->refcnt );
+       return 0;
+
+ err:
+       DBGC ( http, "HTTP %p could not create request: %s\n", 
+              http, strerror ( rc ) );
+       http_done ( http, rc );
+       ref_put ( &http->refcnt );
+       return rc;
 }
+
+/** HTTP URI opener */
+struct uri_opener http_uri_opener __uri_opener = {
+       .scheme = "http",
+       .open   = http_open,
+};
+
+/** HTTPS URI opener */
+struct uri_opener https_uri_opener __uri_opener = {
+       .scheme = "https",
+       .open   = http_open,
+};