TinyHttp源码分析

jiezi

5 年前

1. 服务器端初始化：

创建 socket => 设置端口复用 => 绑定 socket 与服务器地址 => 如果未指定端口，动态分配 => 监听

int on = 1;
unsigned int port = 4000;
struct sockaddr_in name;
int lfd = socket(PF_INET, SOCK_STREAM, 0);  // 创建 socket
memset(&name, 0, sizeof(name));  // 初始化 name
name.sin_family = AF_INET;
name.sin_port = htons(*port);
name.sin_addr.s_addr = htonl(INADDR_ANY);
setsockopt(lfd, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on)) // 端口复用
bind(lfd, (struct sockaddr *)&name, sizeof(name))
if (*port == 0) {   // 动态分配端口
    socklen_t namelen = sizeof(name);
    getsockname(lfd, (struct sockaddr *)&name, &namelen);
    *port = ntohs(name.sin_port);
}
listen(httpd, 5);

2. 服务器阻塞等待客户端连接，一旦连接，开辟一个线程并执行对应响应函数：

while(1) {client_sock = accept(server_sock, (struct sockaddr*)&client_name, &client_name_len);
    printf("received from %s at PORT %d\n", 
            inet_ntop(AF_INET, &client_name.sin_addr, str, sizeof(str)), 
            ntohs(client_name.sin_port));
    pthread_create(&newthread , NULL, (void *)accept_request, (void *)(intptr_t)client_sock);
}

1. 获取请求方法：

上图所示是一个 http 请求的报文格式， 请求方法 是指上图中请求行中第一个字段。

int i = 0; 
char buf[1024];
char method[255];
/*get_line 返回获取到的字节数 */
int numchars = get_line(client_sock, buf, sizeof(buf)); 

/* 不为空，以及未到达上限，将 buf 中 Get 或 Post 拷贝进 method*/
while (!isspace((int)buf[i]) && (i < sizeof(method) - 1)) {method[i] = buf[i];
    i++;
}
method[i] = '\0';

注意：如果既不是 post 也不是 get 请求，报错退出；另外值得注意的是报文中的空格值为 ”rn”。

2. 获取 url：

上图所示是一个常见的URL，而请求行中的 url 指的是上图resource path，在请求头部中会包含 host 字段。

int j = i;
i = 0;
char url[255];
while (isspace((int)buf[j]) && (j < numchars)) j++;  // 跳过空格

/* 取出报文头的 url，该 url 不包含 host*/
while (!isspace((int)buf[j]) && (i < sizeof(url) - 1) && (j < numchars)) {url[i] = buf[j];
    i++; j++;
}
url[i] = '\0';

3. 设置 cgi 值（可以理解为一个标志位）：

如果是post 请求, cgi=1;
如果是 带参数的 get 请求, cgi=1, 并使用一个指针指向参数;
如果 url 指向的地址是 可执行文件, cgi=1;
其余情况 cgi=0;

4. 组合 url，让其指向服务器上的一个绝对路径（path），如果 path 是一个目录（文件夹），修改 path 指向默认的主页地址，path = host+url。

5. 使用 stat 函数绑定 path：

失败，即路径错误，将剩余请求内容读出并丢弃，返回 404 错误；
成功，若cgi != 1 (get 无参请求), 直接将 path 内容读出并 send 回客户端；若 **cgi == 1, 执行 cgi 脚本，函数参数:client_sock, path, method, query(get 请求的请求参数)。

1. 什么是 cgi：

带有参数的 get 请求，和 post 请求，服务器没有办法简单的返回文件的内容，服务器需要将对应的的页面找出来，再 send 给客户端。这个就需要 cgi 来帮忙，cgi 可以理解为是服务器端可执行的小脚本。服务器收到这个请求之后，执行.cgi 文件，这个文件是提前写好了，专门来处理这样的请求，然后得到相应的网页数据，再 send 给客户端。

2. 判断是什么请求：

get: 读出剩余报文请求头内容并丢弃，直到遇到两个换行符，后面再读就是请求数据；
post: 读报文请求头部中的 content-length 字段，判断是否有有效内容，该字段的值为 post 请求的数据长度。

//post 请求，获取请求主体数据长度
int numchars = get_line(client_sock, buf, sizeof(buf));
while ((numchars > 0) && strcmp("\n", buf)) {
    /*Content-Length：这个字符串一共长为 15 位，所以取出头部一句后，将第 16 位设置结束符，进行比较, 第 16 位置为结束 */
    buf[15] = '\0';
    if (strcasecmp(buf, "Content-Length:") == 0)
        content_length = atoi(&(buf[16]));
    numchars = get_line(client_sock, buf, sizeof(buf));  // 剩余头内容读出丢弃
}
if (content_length == -1) {bad_request(client);
    return;
}

3. 创建两个管道并 fork：

pipe(cgi_output);  // 输出
pipe(cgi_input);  // 输入
pid = fork();  // 创建进程

4. 子进程：

关闭输出读端，输入写端；
复制输出读端到stdout, 复制输入读端到stdin；
配置 cgi 环境变量；
execl 执行请求地址。

char meth_env[255];
char query_env[255];
char length_env[255];

dup2(cgi_output[1], STDOUT);  // 复制输出读端到 stdout
dup2(cgi_input[0], STDIN);   // 复制输入读端到 stdin
close(cgi_output[0]);  // 输出读
close(cgi_input[1]);   // 输入写

//CGI 环境变量
sprintf(meth_env, "REQUEST_METHOD=%s", method);
putenv(meth_env);
if (strcasecmp(method, "GET") == 0) {   //get 请求
    sprintf(query_env, "QUERY_STRING=%s", query_string);
    putenv(query_env);
}
else {   //post 请求
    sprintf(length_env, "CONTENT_LENGTH=%d", content_length);
    putenv(length_env);
}
execl(path, NULL);
exit(0);  // 子进程退出

5. 父进程：

关闭输出写端，输出读端；
如果是 post 请求，接收 post 内容，并写进输入写端；
循环读输入读端的数据，send 给客户端。

close(cgi_output[1]);  // 输出写
close(cgi_input[0]);   // 输入读
if(strcasecmp(method, "POST") == 0) {// 通过 cgi_input[1](写端)写入到 CGI 的标准输入
    for (int i = 0; i < content_length; i++) {recv(client_sock, &c, 1, 0);
        write(cgi_input[1], &c, 1);
    }
}
// 读取 CGI 的标准输出, 发送到客户端
while (read(cgi_output[0], &c, 1) > 0)
    send(client_sock, &c, 1, 0);

close(cgi_output[0]);
close(cgi_input[1]);
waitpid(pid, &status, 0);

1.get_line：读取一行数据

int get_line(int sock, char *buf, int size)
{
    int n;
    int i = 0;
    char c = '\0';  
    while ((i < size - 1) && (c != '\n')) {
        // 从 sock 中读取一个字节
        n = recv(sock, &c, 1, 0);
        if (n > 0) {
            // 将 \r\n 或 \r 转换为 '\n'
            if (c == '\r') {
                // 读到了 '\r' 就再预读一个字节
                n = recv(sock, &c, 1, MSG_PEEK);
                // 如果读取到的是 '\n', 就读取, 否则 c ='\n'
                if ((n > 0) && (c == '\n')) recv(sock, &c, 1, 0);
                else c = '\n';
            }
            // 读取数据放入 buf
            buf[i] = c;
            i++;
        }
        else c = '\n';
    }
    buf[i] = '\0';
    return(i); // 返回写入 buf 的字节数
}

index.html 必须没有执行权限，否则不能显示内容，可通过 chmod 600 index.html 更改。
编译gcc server.c -o server -lpthread
完整代码请请访问 github

TinyHttp源码分析

主函数

响应函数

cgi 脚本函数

其他重要函数

注意事项