apps/web/lighttpd-1.4.13/src/mod_staticfile.c

Go to the documentation of this file.

#include <ctype.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>

#include "base.h"
#include "log.h"
#include "buffer.h"

#include "plugin.h"

#include "stat_cache.h"
#include "etag.h"
#include "http_chunk.h"
#include "response.h"

/*
*! *!  $Log: mod_staticfile.c,v $
*! *!  Revision 1.1.1.1  2008/11/27 20:04:01  elphel
*! *!
*! *!
*! *!  Revision 1.1.1.1  2007/09/21 06:15:02  elphel
*! *!  This is a fresh tree based on elphel353-2.10
*! *!
*! *!  Revision 1.1  2007/09/21 06:15:02  elphel
*! *!  modified lighttpd to be able to serve /dev/curcbuf
*! *!

*/


/* plugin config for all request/connections */

typedef struct {
        array *exclude_ext;
} plugin_config;

typedef struct {
        PLUGIN_DATA;

        buffer *range_buf;

        plugin_config **config_storage;

        plugin_config conf;
} plugin_data;

/* init the plugin data */
INIT_FUNC(mod_staticfile_init) {
        plugin_data *p;

        p = calloc(1, sizeof(*p));

        p->range_buf = buffer_init();

        return p;
}

/* detroy the plugin data */
FREE_FUNC(mod_staticfile_free) {
        plugin_data *p = p_d;

        UNUSED(srv);

        if (!p) return HANDLER_GO_ON;

        if (p->config_storage) {
                size_t i;
                for (i = 0; i < srv->config_context->used; i++) {
                        plugin_config *s = p->config_storage[i];

                        array_free(s->exclude_ext);

                        free(s);
                }
                free(p->config_storage);
        }
        buffer_free(p->range_buf);

        free(p);

        return HANDLER_GO_ON;
}

/* handle plugin config and check values */

SETDEFAULTS_FUNC(mod_staticfile_set_defaults) {
        plugin_data *p = p_d;
        size_t i = 0;

        config_values_t cv[] = {
                { "static-file.exclude-extensions", NULL, T_CONFIG_ARRAY, T_CONFIG_SCOPE_CONNECTION },       /* 0 */
                { NULL,                         NULL, T_CONFIG_UNSET, T_CONFIG_SCOPE_UNSET }
        };

        if (!p) return HANDLER_ERROR;

        p->config_storage = calloc(1, srv->config_context->used * sizeof(specific_config *));

        for (i = 0; i < srv->config_context->used; i++) {
                plugin_config *s;

                s = calloc(1, sizeof(plugin_config));
                s->exclude_ext    = array_init();

                cv[0].destination = s->exclude_ext;

                p->config_storage[i] = s;

                if (0 != config_insert_values_global(srv, ((data_config *)srv->config_context->data[i])->value, cv)) {
                        return HANDLER_ERROR;
                }
        }

        return HANDLER_GO_ON;
}

#define PATCH(x) \
        p->conf.x = s->x;
static int mod_staticfile_patch_connection(server *srv, connection *con, plugin_data *p) {
        size_t i, j;
        plugin_config *s = p->config_storage[0];

        PATCH(exclude_ext);

        /* skip the first, the global context */
        for (i = 1; i < srv->config_context->used; i++) {
                data_config *dc = (data_config *)srv->config_context->data[i];
                s = p->config_storage[i];

                /* condition didn't match */
                if (!config_check_cond(srv, con, dc)) continue;

                /* merge config */
                for (j = 0; j < dc->value->used; j++) {
                        data_unset *du = dc->value->data[j];

                        if (buffer_is_equal_string(du->key, CONST_STR_LEN("static-file.exclude-extensions"))) {
                                PATCH(exclude_ext);
                        }
                }
        }

        return 0;
}
#undef PATCH

static int http_response_parse_range(server *srv, connection *con, plugin_data *p) {
        int multipart = 0;
        int error;
        off_t start, end;
        const char *s, *minus;
        char *boundary = "fkj49sn38dcn3";
        data_string *ds;
        stat_cache_entry *sce = NULL;
        buffer *content_type = NULL;

        if (HANDLER_ERROR == stat_cache_get_entry(srv, con, con->physical.path, &sce)) {
                SEGFAULT();
        }

        start = 0;
        end = sce->st.st_size - 1;

        con->response.content_length = 0;

        if (NULL != (ds = (data_string *)array_get_element(con->response.headers, "Content-Type"))) {
                content_type = ds->value;
        }

        for (s = con->request.http_range, error = 0;
             !error && *s && NULL != (minus = strchr(s, '-')); ) {
                char *err;
                off_t la, le;

                if (s == minus) {
                        /* -<stop> */

                        le = strtoll(s, &err, 10);

                        if (le == 0) {
                                /* RFC 2616 - 14.35.1 */

                                con->http_status = 416;
                                error = 1;
                        } else if (*err == '\0') {
                                /* end */
                                s = err;

                                end = sce->st.st_size - 1;
                                start = sce->st.st_size + le;
                        } else if (*err == ',') {
                                multipart = 1;
                                s = err + 1;

                                end = sce->st.st_size - 1;
                                start = sce->st.st_size + le;
                        } else {
                                error = 1;
                        }

                } else if (*(minus+1) == '\0' || *(minus+1) == ',') {
                        /* <start>- */

                        la = strtoll(s, &err, 10);

                        if (err == minus) {
                                /* ok */

                                if (*(err + 1) == '\0') {
                                        s = err + 1;

                                        end = sce->st.st_size - 1;
                                        start = la;

                                } else if (*(err + 1) == ',') {
                                        multipart = 1;
                                        s = err + 2;

                                        end = sce->st.st_size - 1;
                                        start = la;
                                } else {
                                        error = 1;
                                }
                        } else {
                                /* error */
                                error = 1;
                        }
                } else {
                        /* <start>-<stop> */

                        la = strtoll(s, &err, 10);

                        if (err == minus) {
                                le = strtoll(minus+1, &err, 10);

                                /* RFC 2616 - 14.35.1 */
                                if (la > le) {
                                        error = 1;
                                }

                                if (*err == '\0') {
                                        /* ok, end*/
                                        s = err;

                                        end = le;
                                        start = la;
                                } else if (*err == ',') {
                                        multipart = 1;
                                        s = err + 1;

                                        end = le;
                                        start = la;
                                } else {
                                        /* error */

                                        error = 1;
                                }
                        } else {
                                /* error */

                                error = 1;
                        }
                }

                if (!error) {
                        if (start < 0) start = 0;

                        /* RFC 2616 - 14.35.1 */
                        if (end > sce->st.st_size - 1) end = sce->st.st_size - 1;

                        if (start > sce->st.st_size - 1) {
                                error = 1;

                                con->http_status = 416;
                        }
                }

                if (!error) {
                        if (multipart) {
                                /* write boundary-header */
                                buffer *b;

                                b = chunkqueue_get_append_buffer(con->write_queue);

                                buffer_copy_string(b, "\r\n--");
                                buffer_append_string(b, boundary);

                                /* write Content-Range */
                                buffer_append_string(b, "\r\nContent-Range: bytes ");
                                buffer_append_off_t(b, start);
                                buffer_append_string(b, "-");
                                buffer_append_off_t(b, end);
                                buffer_append_string(b, "/");
                                buffer_append_off_t(b, sce->st.st_size);

                                buffer_append_string(b, "\r\nContent-Type: ");
                                buffer_append_string_buffer(b, content_type);

                                /* write END-OF-HEADER */
                                buffer_append_string(b, "\r\n\r\n");

                                con->response.content_length += b->used - 1;

                        }

                        chunkqueue_append_file(con->write_queue, con->physical.path, start, end - start + 1);
                        con->response.content_length += end - start + 1;
                }
        }

        /* something went wrong */
        if (error) return -1;

        if (multipart) {
                /* add boundary end */
                buffer *b;

                b = chunkqueue_get_append_buffer(con->write_queue);

                buffer_copy_string_len(b, "\r\n--", 4);
                buffer_append_string(b, boundary);
                buffer_append_string_len(b, "--\r\n", 4);

                con->response.content_length += b->used - 1;

                /* set header-fields */

                buffer_copy_string(p->range_buf, "multipart/byteranges; boundary=");
                buffer_append_string(p->range_buf, boundary);

                /* overwrite content-type */
                response_header_overwrite(srv, con, CONST_STR_LEN("Content-Type"), CONST_BUF_LEN(p->range_buf));
        } else {
                /* add Content-Range-header */

                buffer_copy_string(p->range_buf, "bytes ");
                buffer_append_off_t(p->range_buf, start);
                buffer_append_string(p->range_buf, "-");
                buffer_append_off_t(p->range_buf, end);
                buffer_append_string(p->range_buf, "/");
                buffer_append_off_t(p->range_buf, sce->st.st_size);

                response_header_insert(srv, con, CONST_STR_LEN("Content-Range"), CONST_BUF_LEN(p->range_buf));
        }

        /* ok, the file is set-up */
        return 0;
}

URIHANDLER_FUNC(mod_staticfile_subrequest) {
        plugin_data *p = p_d;
        size_t k;
        int s_len;
        stat_cache_entry *sce = NULL;
        buffer *mtime;
        data_string *ds;

        /* someone else has done a decision for us */
        if (con->http_status != 0) return HANDLER_GO_ON;
        if (con->uri.path->used == 0) return HANDLER_GO_ON;
        if (con->physical.path->used == 0) return HANDLER_GO_ON;

        /* someone else has handled this request */
        if (con->mode != DIRECT) return HANDLER_GO_ON;

        /* we only handle GET, POST and HEAD */
        switch(con->request.http_method) {
        case HTTP_METHOD_GET:
        case HTTP_METHOD_POST:
        case HTTP_METHOD_HEAD:
                break;
        default:
                return HANDLER_GO_ON;
        }

        mod_staticfile_patch_connection(srv, con, p);

        s_len = con->uri.path->used - 1;

        /* ignore certain extensions */
        for (k = 0; k < p->conf.exclude_ext->used; k++) {
                ds = (data_string *)p->conf.exclude_ext->data[k];

                if (ds->value->used == 0) continue;

                if (buffer_is_equal_right_len(con->physical.path, ds->value, ds->value->used - 1)) {
                        return HANDLER_GO_ON;
                }
        }


        if (con->conf.log_request_handling) {
                log_error_write(srv, __FILE__, __LINE__,  "s",  "-- handling file as static file");
        }

        if (HANDLER_ERROR == stat_cache_get_entry(srv, con, con->physical.path, &sce)) {
                con->http_status = 403;

                log_error_write(srv, __FILE__, __LINE__, "sbsb",
                                "not a regular file:", con->uri.path,
                                "->", con->physical.path);

                return HANDLER_FINISHED;
        }

        /* we only handline regular files */
#ifdef HAVE_LSTAT
        if ((sce->is_symlink == 1) && !con->conf.follow_symlink) {
                con->http_status = 403;

                if (con->conf.log_request_handling) {
                        log_error_write(srv, __FILE__, __LINE__,  "s",  "-- access denied due symlink restriction");
                        log_error_write(srv, __FILE__, __LINE__,  "sb", "Path         :", con->physical.path);
                }

                buffer_reset(con->physical.path);
                return HANDLER_FINISHED;
        }
#endif
// disabling check it is a regular file - see if it will work with circbuf
#if 0
        if (!S_ISREG(sce->st.st_mode)) {
                con->http_status = 404;

                if (con->conf.log_file_not_found) {
                        log_error_write(srv, __FILE__, __LINE__, "sbsb",
                                        "not a regular file:", con->uri.path,
                                        "->", sce->name);
                }

                return HANDLER_FINISHED;
        }
#endif
#if 1
        if (con->conf.log_request_handling) {
                log_error_write(srv, __FILE__, __LINE__,  "sd", "sce->st.st_mode=", (int) (sce->st.st_mode));
                log_error_write(srv, __FILE__, __LINE__,  "sd", "sce->st.st_size=", (int) (sce->st.st_size));
//              log_error_write(srv, __FILE__, __LINE__,  "sb", "con->physical.path=", con->physical.path);
                log_error_write(srv, __FILE__, __LINE__,  "ss", "con->physical.path=", con->physical.path->ptr);

        }

        off_t pseudo_size=0;
        FILE * nonregfile;
        if (!S_ISREG(sce->st.st_mode)) {
// open file and see it size;
           if ((nonregfile= fopen(con->physical.path->ptr, "r"))) {
             fseek (nonregfile,0,SEEK_END);
             pseudo_size=ftello(nonregfile);
             fclose (nonregfile);
           }
        }
        if (con->conf.log_request_handling) {
                log_error_write(srv, __FILE__, __LINE__,  "sd", "pseudo_size=", (int) pseudo_size);
        }
#endif
        /* mod_compress might set several data directly, don't overwrite them */

        /* set response content-type, if not set already */

        if (NULL == array_get_element(con->response.headers, "Content-Type")) {
                if (buffer_is_empty(sce->content_type)) {
                        response_header_overwrite(srv, con, CONST_STR_LEN("Content-Type"), CONST_STR_LEN("application/octet-stream"));
                } else {
                        response_header_overwrite(srv, con, CONST_STR_LEN("Content-Type"), CONST_BUF_LEN(sce->content_type));
                }
        }

        if (NULL == array_get_element(con->response.headers, "ETag")) {
                /* generate e-tag */
                etag_mutate(con->physical.etag, sce->etag);

                response_header_overwrite(srv, con, CONST_STR_LEN("ETag"), CONST_BUF_LEN(con->physical.etag));
        }
        response_header_overwrite(srv, con, CONST_STR_LEN("Accept-Ranges"), CONST_STR_LEN("bytes"));

        /* prepare header */
        if (NULL == (ds = (data_string *)array_get_element(con->response.headers, "Last-Modified"))) {
                mtime = strftime_cache_get(srv, sce->st.st_mtime);
                response_header_overwrite(srv, con, CONST_STR_LEN("Last-Modified"), CONST_BUF_LEN(mtime));
        } else {
                mtime = ds->value;
        }

        if (HANDLER_FINISHED == http_response_handle_cachable(srv, con, mtime)) {
                return HANDLER_FINISHED;
        } else if (con->request.http_range && con->conf.range_requests) {
                int do_range_request = 1;
                /* check if we have a conditional GET */

                if (NULL != (ds = (data_string *)array_get_element(con->request.headers, "If-Range"))) {
                        /* if the value is the same as our ETag, we do a Range-request,
                         * otherwise a full 200 */

                        if (!buffer_is_equal(ds->value, con->physical.etag)) {
                                do_range_request = 0;
                        }
                }

                if (do_range_request) {
                        /* content prepared, I'm done */
                        con->file_finished = 1;

                        if (0 == http_response_parse_range(srv, con, p)) {
                                con->http_status = 206;
                        }
                        return HANDLER_FINISHED;
                }
        }

        /* if we are still here, prepare body */

        /* we add it here for all requests
         * the HEAD request will drop it afterwards again
         */
#if 0
        http_chunk_append_file(srv, con, con->physical.path, 0, sce->st.st_size);
#else
        if (pseudo_size) http_chunk_append_file(srv, con, con->physical.path, 0, pseudo_size);
        else http_chunk_append_file(srv, con, con->physical.path, 0, sce->st.st_size);
#endif
        con->file_finished = 1;

        return HANDLER_FINISHED;
}

/* this function is called at dlopen() time and inits the callbacks */

int mod_staticfile_plugin_init(plugin *p) {
        p->version     = LIGHTTPD_VERSION_ID;
        p->name        = buffer_init_string("staticfile");

        p->init        = mod_staticfile_init;
        p->handle_subrequest_start = mod_staticfile_subrequest;
        p->set_defaults  = mod_staticfile_set_defaults;
        p->cleanup     = mod_staticfile_free;

        p->data        = NULL;

        return 0;
}

---