ripht-php-sapi 0.1.0-rc.9

Ripht PHP SAPI - A PHP SAPI written in Rust to expose safe and convenient APIs to encourage additional Rust tooling development for PHP
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

use super::header::ResponseHeader;
use super::message::{ExecutionMessage, SyslogLevel};

/// Result of PHP script execution.
///
/// Contains the HTTP status code, response headers, body output,
/// and any PHP errors/warnings/notices logged during execution.
#[must_use]
#[derive(Debug, Clone)]
pub struct ExecutionResult {
    status: u16,
    exit_status: i32,
    body: Vec<u8>,
    headers: Vec<ResponseHeader>,
    messages: Vec<ExecutionMessage>,
}

impl ExecutionResult {
    pub fn new(
        status: u16,
        exit_status: i32,
        body: Vec<u8>,
        headers: Vec<ResponseHeader>,
        messages: Vec<ExecutionMessage>,
    ) -> Self {
        Self {
            status,
            exit_status,
            body,
            headers,
            messages,
        }
    }

    pub fn body(&self) -> Vec<u8> {
        self.body.to_owned()
    }

    pub fn take_body(&mut self) -> Vec<u8> {
        std::mem::take(&mut self.body)
    }

    pub fn body_string(&self) -> String {
        if self.body.is_empty() {
            return String::default();
        }

        String::from_utf8_lossy(&self.body).into_owned()
    }

    pub fn body_str(&self) -> Result<&str, std::str::Utf8Error> {
        std::str::from_utf8(&self.body)
    }

    pub fn status_code(&self) -> u16 {
        self.status
    }

    pub fn exit_status(&self) -> i32 {
        self.exit_status
    }

    pub fn has_errors(&self) -> bool {
        self.messages
            .iter()
            .any(|m| m.is_error())
    }

    pub fn has_message_level(&self, level: SyslogLevel) -> bool {
        self.messages
            .iter()
            .any(|m| m.level == level)
    }

    pub fn errors(&self) -> impl Iterator<Item = &ExecutionMessage> {
        self.messages
            .iter()
            .filter(|m| m.is_error())
    }

    pub fn all_messages(&self) -> impl Iterator<Item = &ExecutionMessage> {
        self.messages.iter()
    }

    pub fn all_headers(&self) -> impl Iterator<Item = &ResponseHeader> {
        self.headers.iter()
    }

    /// Returns the first header value for a given header name, if any.
    pub fn header_val(&self, name: &str) -> Option<&str> {
        self.headers
            .iter()
            .find(|h| {
                h.name()
                    .eq_ignore_ascii_case(name)
            })
            .map(|h| h.value())
    }

    /// Returns all headers for a given header name
    /// e.g. "cookie" -> vec!["SESSID=abc123", "lang=en", "..."]
    pub fn header_vals(&self, name: &str) -> Vec<&str> {
        self.headers
            .iter()
            .filter(|h| {
                h.name()
                    .eq_ignore_ascii_case(name)
            })
            .map(|h| h.value())
            .collect()
    }

    pub fn is_success(&self) -> bool {
        (200..300).contains(&self.status)
    }

    pub fn is_redirect(&self) -> bool {
        (300..400).contains(&self.status)
    }

    pub fn is_client_error(&self) -> bool {
        (400..500).contains(&self.status)
    }

    pub fn is_server_error(&self) -> bool {
        (500..600).contains(&self.status)
    }
}

impl Default for ExecutionResult {
    fn default() -> Self {
        Self {
            status: 200,
            exit_status: 0,
            body: Vec::new(),
            headers: Vec::new(),
            messages: Vec::new(),
        }
    }
}

#[cfg(feature = "http")]
impl ExecutionResult {
    pub fn into_http_response(self) -> http::Response<Vec<u8>> {
        let mut builder = http::Response::builder().status(self.status);

        for h in &self.headers {
            builder = builder.header(h.name(), h.value());
        }

        builder
            .body(self.body)
            .unwrap_or_else(|_| http::Response::new(Vec::new()))
    }
}

#[cfg(feature = "http")]
impl From<ExecutionResult> for http::Response<Vec<u8>> {
    fn from(res: ExecutionResult) -> Self {
        res.into_http_response()
    }
}