HTTP协议
http协议叫做超文本传输协议,是基于tcp/ic协议的应用层协议。
具体内容可以借鉴这一篇博客:https://blog.csdn.net/qq_36894974/article/details/103930478。
本文主要涉及Tinyhttpd开源项目,该项目就是利用C语言简单地实现了http这一协议。
项目文件结构
拿到开源项目的第一件事就是查看README文档。example文件夹下是简单的tcp和udp服务器、客户端程序,并不关键。主要看httpd.c
先从main函数开始看
int main(void)
{
int server_sock = -1;
u_short port = 0;
int client_sock = -1;
struct sockaddr_in client_name;
int client_name_len = sizeof(client_name);
//pthread_t newthread;
server_sock = startup(&port);
printf("httpd running on port %d\n", port);
while (1)
{
client_sock = accept(server_sock,
(struct sockaddr *)&client_name,
&client_name_len);
if (client_sock == -1)
error_die("accept");
accept_request(client_sock);
/*if (pthread_create(&newthread , NULL, accept_request, client_sock) != 0)
perror("pthread_create");*/
}
close(server_sock);
return(0);
- startup(端口),创建socket绑定本地并设置监听,返回本地socket的fd。
int startup(u_short *port)
{
int httpd = 0;
struct sockaddr_in name;
httpd = socket(PF_INET, SOCK_STREAM, 0);
if (httpd == -1)
error_die("socket");
memset(&name, 0, sizeof(name));
name.sin_family = AF_INET;
//将*port 转换成以网络字节序表示的16位整数
name.sin_port = htons(*port);
name.sin_addr.s_addr = htonl(INADDR_ANY);
//如果传进去的sockaddr结构中的 sin_port 指定为0,这时系统会选择一个临时的端口号
if (bind(httpd, (struct sockaddr *)&name, sizeof(name)) < 0)
error_die("bind");
//如果调用 bind 后端口号仍然是0,则手动调用getsockname()获取端口号
if (*port == 0) /* if dynamically allocating a port */
{
int namelen = sizeof(name);
//调用getsockname()获取系统给 httpd 这个 socket 随机分配的端口号
if (getsockname(httpd, (struct sockaddr *)&name, &namelen) == -1)
error_die("getsockname");
*port = ntohs(name.sin_port);
}
if (listen(httpd, 5) < 0)
error_die("listen");
return(httpd);
}
获得serve_sockde句柄,创建客户端套接字地址结构并accept阻塞等待有客户端连接上来。当客户端连接上来时,跳转无限循环whil(1)执行accept_request响应客户端请求。
accept_request函数
协议主要实现部分都是在这个函数里面。为了方便阅读,所有详细的我都写进代码里面。
代码如下
void accept_request(int client)
{
char buf[1024];
int numchars;
char method[255];
char url[255];
char path[512];
size_t i, j;
struct stat st;
int cgi = 0; /* becomes true if server decides this is a CGI
* program */
char *query_string = NULL;
//numchars记录请求行的长度,buf储存请求行的内容(请求方法,method)
numchars = get_line(client, buf, sizeof(buf));
i = 0; j = 0;
//检查
while (!ISspace(buf[j]) && (i < sizeof(method) - 1))//ISspace判断是否为空字符
{
method[i] = buf[j];
i++; j++;
}
method[i] = '\0';
//如果请求的方法不是 GET 或 POST 任意一个的话就直接发送 response 告诉客户端没实现该方法
if (strcasecmp(method, "GET") && strcasecmp(method, "POST"))//strcasecmp比较相同则返回0
{
unimplemented(client);//里面是一行一行的send服务器响应信息,状态行、消息报头、空行、响应正文
return;
}
//如果是 POST 方法就将 cgi 标志变量置一(true)
if (strcasecmp(method, "POST") == 0)
cgi = 1;
i = 0;
//跳过所有的空白字符(空格)
while (ISspace(buf[j]) && (j < sizeof(buf)))
j++;
//然后把 URL 读出来放到 url 数组中
while (!ISspace(buf[j]) && (i < sizeof(url) - 1) && (j < sizeof(buf)))
{
url[i] = buf[j];
i++; j++;
}
url[i] = '\0';
//如果这个请求是一个 GET 方法的话
if (strcasecmp(method, "GET") == 0)
{
//用一个指针指向 url
query_string = url;
//去遍历这个 url,跳过字符 ?前面的所有字符,如果遍历完毕也没找到字符 ?则退出循环
while ((*query_string != '?') && (*query_string != '\0'))
query_string++;
//退出循环后检查当前的字符是 ?还是字符串(url)的结尾
if (*query_string == '?')
{
//如果是 ? 的话,证明这个请求需要调用 cgi,将 cgi 标志变量置一(true)
cgi = 1;
//从字符 ? 处把字符串 url 给分隔会两份
*query_string = '\0';
//使指针指向字符 ?后面的那个字符
query_string++;
}
}
//将前面分隔两份的前面那份字符串,拼接在字符串htdocs的后面之后就输出存储到数组 path 中。相当于现在 path 中存储着一个字符串
sprintf(path, "htdocs%s", url);
//如果 path 数组中的这个字符串的最后一个字符是以字符 / 结尾的话,就拼接上一个"index.html"的字符串。首页的意思
if (path[strlen(path) - 1] == '/')
strcat(path, "index.html");
//在系统上去查询该文件是否存在
if (stat(path, &st) == -1) {
//如果不存在,那把这次 http 的请求后续的内容(head 和 body)全部读完并忽略
while ((numchars > 0) && strcmp("\n", buf)) /* read & discard headers */
numchars = get_line(client, buf, sizeof(buf));
//然后返回一个找不到文件的 response 给客户端
not_found(client);
}
else
{
//文件存在,那去跟常量S_IFMT相与,相与之后的值可以用来判断该文件是什么类型的
if ((st.st_mode & S_IFMT) == S_IFDIR)
//如果这个文件是个目录,那就需要再在 path 后面拼接一个"/index.html"的字符串
strcat(path, "/index.html");
//S_IXUSR, S_IXGRP, S_IXOTH三者可以参读《TLPI》P295
if ((st.st_mode & S_IXUSR) ||
(st.st_mode & S_IXGRP) ||
(st.st_mode & S_IXOTH) )
//如果这个文件是一个可执行文件,不论是属于用户/组/其他这三者类型的,就将 cgi 标志变量置一
cgi = 1;
if (!cgi)
//如果不需要 cgi 机制的话,发送path的文件即可
serve_file(client, path);
else
//如果需要则调用
execute_cgi(client, path, method, query_string);
}
//断开客户端
close(client);
}
serve_file函数
将filename文件通过FILE流发送到client。
代码如下
void serve_file(int client, const char *filename)
{
FILE *resource = NULL;
int numchars = 1;
char buf[1024];
//确保 buf 里面有东西,能进入下面的 while 循环
buf[0] = 'A'; buf[1] = '\0';
//循环作用是读取并忽略掉这个 http 请求后面的所有内容,清空缓冲区
while ((numchars > 0) && strcmp("\n", buf)) /* read & discard headers */
numchars = get_line(client, buf, sizeof(buf));
//只读方式打开将filenameIO流赋给resource
resource = fopen(filename, "r");
if (resource == NULL)
//打开失败则发送NOT FOUND协议包
not_found(client);
else
{
//打开成功后,发送状态行、消息报头和空行
headers(client, filename);
//将装有filenam内容的resource流send到client
cat(client, resource);
}
//发送完毕,关闭打开的资源文件
fclose(resource);
}
execute_cgi函数
用于响应cgi请求,流程先获取正文长度,发送状态行,创建读写两个管道,创建一个进程,子进程中创建、设置并储存环境变量,最后跳转执行path下的文件。
void execute_cgi(int client, const char *path,
const char *method, const char *query_string)
{
char buf[1024];
int cgi_output[2];
int cgi_input[2];
pid_t pid;
int status;
int i;
char c;
int numchars = 1;
int content_length = -1;
//往 buf 中填东西以保证能进入下面的 while
buf[0] = 'A'; buf[1] = '\0';
//如果是 http 请求是 GET 方法的话读取并忽略请求剩下的内容,相当于再次判断是否cgi请求
if (strcasecmp(method, "GET") == 0)
while ((numchars > 0) && strcmp("\n", buf)) /* read & discard headers */
numchars = get_line(client, buf, sizeof(buf));
else /* POST */
{
//只有 POST 方法才继续读内容
numchars = get_line(client, buf, sizeof(buf));
//获取Content-Length:的大小
//strcmp判断是否到尾,按道理应该是\r\n的
while ((numchars > 0) && strcmp("\n", buf))
{
buf[15] = '\0';
//当遇到Content-Length:时候,buf[16]装下后面的值
if (strcasecmp(buf, "Content-Length:") == 0)
content_length = atoi(&(buf[16])); //记录 body 的长度大小
numchars = get_line(client, buf, sizeof(buf));
}
//如果 http 请求的 header 没有指示 body 长度大小的参数,则报错返回
if (content_length == -1) {
bad_request(client);
return;
}
}
sprintf(buf, "HTTP/1.0 200 OK\r\n");
send(client, buf, strlen(buf), 0);
//下面这里创建两个管道,用于两个进程间通信
if (pipe(cgi_output) < 0) {
cannot_execute(client);
return;
}
if (pipe(cgi_input) < 0) {
cannot_execute(client);
return;
}
//创建一个子进程
if ( (pid = fork()) < 0 ) {
cannot_execute(client);
return;
}
//子进程用来执行 cgi 脚本
if (pid == 0) /* child: CGI script */
{
char meth_env[255];
char query_env[255];
char length_env[255];
//dup2()包含<unistd.h>中,参读《TLPI》P97
//将子进程的输出由标准输出重定向到 cgi_ouput 的管道写端上
dup2(cgi_output[1], 1);
//将子进程的输出由标准输入重定向到 cgi_ouput 的管道读端上
dup2(cgi_input[0], 0);
//关闭 cgi_ouput 管道的读端与cgi_input 管道的写端
close(cgi_output[0]);
close(cgi_input[1]);
//构造一个环境变量
sprintf(meth_env, "REQUEST_METHOD=%s", method);
//putenv()包含于<stdlib.h>中,参读《TLPI》P128
//将这个环境变量加进子进程的运行环境中
putenv(meth_env);
//根据http 请求的不同方法,构造并存储不同的环境变量
if (strcasecmp(method, "GET") == 0) {
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()包含于<unistd.h>中,参读《TLPI》P567
//最后将子进程替换成另一个进程并执行 cgi 脚本
execl(path, path, NULL);
exit(0);
} else { /* parent */
//父进程则关闭了 cgi_output管道的写端和 cgi_input 管道的读端
close(cgi_output[1]);
close(cgi_input[0]);
//如果是 POST 方法的话就继续读 body 的内容,并写到 cgi_input 管道里让子进程去读
if (strcasecmp(method, "POST") == 0)
for (i = 0; i < content_length; i++) {
recv(client, &c, 1, 0);
write(cgi_input[1], &c, 1);
}
//然后从 cgi_output 管道中读子进程的输出,并发送到客户端去
while (read(cgi_output[0], &c, 1) > 0)
send(client, &c, 1, 0);
//关闭管道
close(cgi_output[0]);
close(cgi_input[1]);
//等待子进程的退出
waitpid(pid, &status, 0);
}
}
总结
代码量很小,是二十年前的写的,代码风格和现在有一定差距,不过以此作为入门了解http协议还是有一定的,麻雀小小,五脏俱全,关于进程、文件IO、标准IO、网络都涉及。
代码自行git clone https://github.com/qiushii/tinyhttp.git