humbird 0.1.4

humbird network communication core library,universal server function wrapper library
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
use std::{
    collections::HashMap,
    fs,
    io::{self, Read, Write},
    path::Path,
};

use mio::{event::Event, net::TcpStream, Token};
use regex::Regex;
use tokio::{io::AsyncWriteExt, net::tcp::OwnedReadHalf};
use tracing::{error, instrument};

use crate::core::{
    plugins::ROUTER_TABLE,
    server::{NetModel, ROOT_PATH},
};

/// http request process
pub type HttpRequestProcess = fn(Request, Response) -> Response;

// delimiter
#[derive(Debug)]
pub enum Delimiter {
    HEAD,
    BODY,
}

// overall encapsulation of http protocol packets
#[derive(Debug)]
pub struct Http {
    pub request: Request,
    pub response: Response,
    pub net_model: NetModel,
}

impl Http {
    pub async fn multi_thread(stream: tokio::net::TcpStream) -> Result<Http, String> {
        let (r, mut w) = stream.into_split();
        match Request::multi_thread_decode(r).await {
            Ok(request) => {
                let response = Response::new(&request);
                let mut http = Http {
                    request: request,
                    response: response,
                    net_model: NetModel::Multithread,
                };
                // exec plugin
                match http.router() {
                    Ok(res) => http.response = res,
                    Err(_) => {}
                }
                // response
                http.response.make_raw();
                let _ = w.write_all(&http.response.body[..]).await;
                return Ok(http);
            }
            Err(_e) => {
                error!("http request processing failed");
                return Err("http request processing failed".to_string());
            }
        }
    }
    #[instrument]
    pub fn event_poll(
        event: &Event,
        m: &HashMap<Token, TcpStream>,
        token: &Token,
    ) -> Result<Http, String> {
        match m.get(token) {
            Some(mut stream) => {
                if event.is_readable() {
                    match Request::event_poll_decode(stream) {
                        Ok(request) => {
                            let res = Response::new(&request);
                            let mut http = Http {
                                request: request,
                                response: res,
                                net_model: NetModel::EventPoll,
                            };
                            // exec plugin
                            match http.router() {
                                Ok(res) => http.response = res,
                                Err(_) => {}
                            }
                            // reponse
                            http.response.make_raw();
                            let _ = stream.write_all(&http.response.raw[..]);
                            return Ok(http);
                        }
                        Err(_e) => {
                            error!("http request processing failed");
                            return Err("http request processing failed".to_string());
                        }
                    }
                } else {
                    return Err("the event is not readable".to_string());
                }
            }
            None => {
                return Err("event poll token is null".to_string());
            }
        }
    }

    // is http protocol
    pub fn is(c: String) -> bool {
        let re = Regex::new(r"^(GET|HEAD|POST|PUT|DELETE|CONNECT|OPTIONS|TRACE)\s(([/0-9a-zA-Z.]+)?(\?[0-9a-zA-Z&=]+)?)\s(HTTP/1.0|HTTP/1.1|HTTP/2.0)\r\n$").unwrap();
        re.is_match(&c)
    }
    /// execute plugin
    fn router(&mut self) -> Result<Response, ()> {
        match ROUTER_TABLE.lock() {
            Ok(t) => {
                if t.len() > 0 && t.contains_key(&self.request.path) {
                    Ok(t.get(&self.request.path).unwrap()(
                        self.request.clone(),
                        self.response.clone(),
                    ))
                } else {
                    Err(())
                }
            }
            Err(_) => Err(()),
        }
    }
}

// http protocol method encapsulation
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Method {
    DEFAULT,
    GET,
    POST,
    HEAD,
    PUT,
    DELETE,
    CONNECT,
    OPTIONS,
    TRACE,
}

impl Method {
    pub fn new(m: &str) -> Self {
        match m {
            "GET" => Method::GET,
            "POST" => Method::POST,
            _ => Method::DEFAULT,
        }
    }
}

// generic request wrapper
#[derive(Debug, Clone)]
pub struct Request {
    method: Method,
    path: String,
    protocol: String,
    params: HashMap<String, String>,
    cookie: HashMap<String, String>,
    head: HashMap<String, String>,
    body: Vec<u8>,
    raw: Vec<u8>,
}

impl Request {
    #[instrument]
    pub async fn multi_thread_decode(r: OwnedReadHalf) -> Result<Self, String> {
        use tokio::io::AsyncBufReadExt;
        use tokio::io::AsyncReadExt;
        use tokio::io::BufReader;
        use tokio::net::tcp::OwnedReadHalf;
        let mut protocol_line = String::default();
        let mut r_buf: BufReader<OwnedReadHalf> = BufReader::new(r);
        let _ = r_buf.read_line(&mut protocol_line).await;
        if !Request::is(protocol_line.to_string()) {
            return Err("http request processing failed".to_string());
        }
        let items: Vec<&str> = protocol_line.split(" ").collect();
        let mut req_str_buf = String::default();
        let mut delimiter = Delimiter::HEAD;
        let mut req = Request {
            method: Method::new(items[0]),
            path: items[1].to_string(),
            protocol: items[2].to_string().replace("\r\n", ""),
            params: HashMap::default(),
            cookie: HashMap::default(),
            head: HashMap::default(),
            body: vec![],
            raw: vec![],
        };
        // handle request params
        req.handle_params();
        loop {
            match delimiter {
                Delimiter::HEAD => {
                    // handle head
                    match r_buf.read_line(&mut req_str_buf).await {
                        Ok(0) => break,
                        Ok(_n) => {
                            let c = req_str_buf.drain(..).as_str().to_string();
                            req.raw.extend(c.as_bytes());
                            if c.eq("\r\n") {
                                delimiter = Delimiter::BODY;
                                continue;
                            };
                            // push request head
                            req.append_head_info(c);
                        }
                        Err(_) => break,
                    }
                }
                Delimiter::BODY => {
                    match req.head.get("Content-Length") {
                        Some(length_str) => {
                            match length_str.parse::<u64>() {
                                Ok(length) => {
                                    let mut buf = vec![
                                        0u8;
                                        match length.try_into() {
                                            Ok(l) => l,
                                            Err(_) => 0,
                                        }
                                    ];
                                    match r_buf.read(&mut buf).await {
                                        Ok(0) => break,
                                        Ok(_s) => {
                                            // save request body
                                            req.body = buf;
                                            break;
                                        }
                                        Err(_) => break,
                                    }
                                }
                                Err(_) => break,
                            };
                        }
                        None => break,
                    }
                }
            }
        }
        Ok(req)
    }
    #[instrument]
    pub fn event_poll_decode(stream: &mio::net::TcpStream) -> Result<Self, String> {
        use std::io::BufRead;
        use std::io::BufReader;
        let mut r_buf = BufReader::new(stream);
        let mut protocol_line = String::default();
        let _ = r_buf.read_line(&mut protocol_line);
        if !Request::is(protocol_line.to_string()) {
            return Err("http request processing failed".to_string());
        }
        let items: Vec<&str> = protocol_line.split(" ").collect();
        let mut req_str_buf = String::default();
        let mut delimiter = Delimiter::HEAD;
        let mut req = Request {
            method: Method::new(items[0]),
            path: items[1].to_string(),
            protocol: items[2].to_string().replace("\r\n", ""),
            params: HashMap::default(),
            cookie: HashMap::default(),
            head: HashMap::default(),
            body: vec![],
            raw: vec![],
        };
        loop {
            match delimiter {
                Delimiter::HEAD => {
                    // handle head
                    match r_buf.read_line(&mut req_str_buf) {
                        Ok(0) => {
                            // end
                            break;
                        }
                        Ok(_n) => {
                            let c = req_str_buf.drain(..).as_str().to_string();
                            req.raw.extend(c.as_bytes());
                            if c.eq("\r\n") {
                                delimiter = Delimiter::BODY;
                                continue;
                            };
                            // push request head
                            req.append_head_info(c);
                        }
                        Err(ref err) if err.kind() == io::ErrorKind::WouldBlock => break,
                        Err(ref err) if err.kind() == io::ErrorKind::Interrupted => break,
                        Err(_) => break,
                    }
                }
                Delimiter::BODY => {
                    match req.head.get("Content-Length") {
                        Some(length_str) => {
                            match length_str.parse::<u64>() {
                                Ok(length) => {
                                    let mut buf = vec![
                                        0u8;
                                        match length.try_into() {
                                            Ok(l) => l,
                                            Err(_) => 0,
                                        }
                                    ];
                                    match r_buf.read(&mut buf) {
                                        Ok(0) => break,
                                        Ok(_s) => {
                                            // save request body
                                            req.body = buf;
                                            break;
                                        }
                                        Err(ref err) if err.kind() == io::ErrorKind::WouldBlock => {
                                            break
                                        }
                                        Err(ref err)
                                            if err.kind() == io::ErrorKind::Interrupted =>
                                        {
                                            break
                                        }
                                        Err(_) => break,
                                    }
                                }
                                Err(_) => break,
                            };
                        }
                        None => break,
                    }
                }
            }
        }
        Ok(req)
    }
    pub fn append_head_info(&mut self, item: String) {
        let item_split: Vec<&str> = item.split(":").collect();
        if item_split.len() == 0 {
            return;
        }
        let k = item_split[0].trim().to_string();
        let v = item_split[1];
        self.head.insert(
            k.to_owned(),
            v.trim()
                .to_string()
                .chars()
                .into_iter()
                .filter(|c| !c.eq(&'\r') && !c.eq(&'\n'))
                .collect(),
        );
        // cookies
        if k.clone().eq("Cookie") {
            let cookies: Vec<&str> = v.split(";").collect();
            let _ = cookies.iter().map(|&e| {
                let cookie_split: Vec<&str> = e.split("=").collect();
                if cookie_split.len() > 0 {
                    self.cookie
                        .insert(cookie_split[0].to_owned(), cookie_split[1].to_owned());
                }
            });
        }
    }
    /// request method
    pub fn method(&self) -> Method {
        self.method
    }
    /// convert request body structure to http protocol request structure string
    ///
    /// Example
    /// ```
    /// GET / HTTP/1.1\r\n
    /// request head1\r\n
    /// request head1\r\n
    /// \r\n
    /// request body
    /// ```
    pub fn raw(&self) -> Vec<u8> {
        self.raw.clone()
    }
    /// determine whether it is an http request
    pub fn is(r: String) -> bool {
        let re = Regex::new(r"^(GET|HEAD|POST|PUT|DELETE|CONNECT|OPTIONS|TRACE)\s(([/0-9a-zA-Z.]+)?(\?[0-9a-zA-Z&=]+)?)\s(HTTP/1.0|HTTP/1.1|HTTP/2.0)\r\n$").unwrap();
        re.is_match(&r)
    }
    /// request parameter handle
    fn handle_params(&self) {}
}

// generic response wrapper
#[derive(Debug, Clone)]
pub struct Response {
    protocol: String,
    status_code: String,
    status_msg: String,
    head: HashMap<String, String>,
    body: Vec<u8>,
    content_length: u64,
    raw: Vec<u8>,
    req_method: Method,
    req_path: String,
}

impl Response {
    #[instrument]
    pub fn new(request: &Request) -> Self {
        let mut response = Response {
            protocol: String::default(),
            status_code: String::default(),
            status_msg: String::default(),
            head: HashMap::default(),
            body: vec![],
            raw: vec![],
            req_method: request.method,
            req_path: String::default(),
            content_length: 0,
        };
        // GET request default processing
        if Method::GET.eq(&request.method) {
            match ROOT_PATH.lock() {
                Ok(p) => {
                    let r_path = &request.path;
                    let s_file = p.to_string() + &r_path[1..r_path.len()];
                    // static file
                    match fs::File::open(Path::new(&s_file)) {
                        Ok(mut f) => match f.metadata() {
                            Ok(meta) => {
                                let mut sf_buf = vec![0u8; meta.len().try_into().unwrap()];
                                let _ = f.read_to_end(&mut sf_buf);
                                response.body = sf_buf;
                            }
                            Err(_) => {
                                response.body = "<h1>404 Not Found</h1>".as_bytes().to_vec();
                            }
                        },
                        Err(_) => {
                            response.body = "<h1>404 Not Found</h1>".as_bytes().to_vec();
                        }
                    }
                }
                Err(e) => {}
            }
        }
        response
    }
    ///
    #[instrument]
    pub async fn multi_thread_decode(r: OwnedReadHalf) -> Result<Self, String> {
        use tokio::io::AsyncBufReadExt;
        use tokio::io::AsyncReadExt;
        use tokio::io::BufReader;
        use tokio::net::tcp::OwnedReadHalf;
        let mut protocol_line = String::default();
        let mut r_buf: BufReader<OwnedReadHalf> = BufReader::new(r);
        let _ = r_buf.read_line(&mut protocol_line).await;
        if !Response::is(protocol_line.to_string()) {
            return Err("this is not an http response body".to_string());
        }
        let items: Vec<&str> = protocol_line.split(" ").collect();
        let mut response_str_buf = String::default();
        let mut delimiter = Delimiter::HEAD;
        let mut response = Response {
            protocol: items[0].to_string(),
            status_code: items[1].to_string(),
            status_msg: match Some(items[2]) {
                Some(s) => s.to_string().replace("\r\n", ""),
                None => "".to_string(),
            },
            head: HashMap::default(),
            body: vec![],
            raw: vec![],
            req_method: Method::DEFAULT,
            req_path: String::default(),
            content_length: 0,
        };
        loop {
            match delimiter {
                Delimiter::HEAD => {
                    match r_buf.read_line(&mut response_str_buf).await {
                        Ok(0) => {
                            break;
                        }
                        Ok(_n) => {
                            let c = response_str_buf.drain(..).as_str().to_string();
                            response.raw.extend(c.as_bytes().iter());
                            if c.eq("\r\n") {
                                delimiter = Delimiter::BODY;
                                continue;
                            };
                            // push request head info
                            response.append_head_info(c);
                        }
                        Err(_) => {
                            break;
                        }
                    }
                }
                Delimiter::BODY => {
                    /// response body
                    match response.head.get("Content-Length") {
                        Some(length_str) => {
                            match length_str.parse::<u64>() {
                                Ok(length) => {
                                    let mut buf = vec![
                                        0u8;
                                        match length.try_into() {
                                            Ok(l) => l,
                                            Err(_) => 0,
                                        }
                                    ];
                                    match r_buf.read(&mut buf).await {
                                        Ok(0) => break,
                                        Ok(_s) => {
                                            response.body = buf;
                                            break;
                                        }
                                        Err(_) => break,
                                    }
                                }
                                Err(_) => break,
                            };
                        }
                        None => break,
                    }
                }
            }
        }
        Ok(response)
    }
    fn make_raw(&mut self) {
        // init content length
        self.head
            .insert("Content-Length".to_string(), self.body.len().to_string());
        // raw data
        let mut raw_data: Vec<u8> = vec![];
        // head
        let mut h = String::default();
        h.push_str("HTTP/1.1 ");
        h.push_str(&format!("{} {} \r\n", self.status_code, self.status_msg));
        // head info
        for (k, v) in self.head.iter_mut() {
            h.push_str(&format!("{}:{} \r\n", k, v));
        }
        // delimiter
        h.push_str("\r\n");
        raw_data.extend(h.as_bytes().to_vec().iter());
        // body
        raw_data.extend(self.body.iter());
        self.raw = raw_data;
    }
    /// record response header information
    pub fn append_head_info(&mut self, item: String) {
        let item_split: Vec<&str> = item.split(":").collect();
        if item_split.len() == 0 {
            return;
        }
        let k = item_split[0].trim().to_string();
        let v = item_split[1].trim().to_string();
        if k.eq("Content-Length") {
            self.content_length = match v.parse::<u64>() {
                Ok(length) => length,
                Err(_) => 0,
            };
        }
        self.head.insert(
            k,
            v.trim()
                .to_string()
                .chars()
                .into_iter()
                .filter(|c| !c.eq(&'\r') && !c.eq(&'\n'))
                .collect(),
        );
    }
    /// set response body
    pub fn set_body(&mut self, body: &str) {
        self.body = body.as_bytes().to_vec();
    }
    /// append head information
    pub fn append_body(&mut self, body: &str) {
        self.body.extend(body.as_bytes().to_vec());
    }
    /// raw data
    pub fn raw(&mut self) -> Vec<u8> {
        self.raw.clone()
    }
    /// determine whether it is an http response
    fn is(r: String) -> bool {
        let re = Regex::new(
            r"^(HTTP/1.0|HTTP/1.1|HTTP/2.0)\s(200|400|401|403|404|500|503)\s(([/0-9a-zA-Z.]+)?(\?[0-9a-zA-Z&=]+)?)\r\n$",
        )
        .unwrap();
        re.is_match(&r)
    }
}