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
use crate::abi::{self, XqdStatus};
use crate::body::{Body, BodyHandle, StreamingBody, StreamingBodyHandle};
use crate::error::{anyhow, Error};
use bytes::{BufMut, BytesMut};
use http::header::{HeaderName, HeaderValue};
use http::{Response, StatusCode, Version};
use lazy_static::lazy_static;
use std::convert::TryFrom;
use std::io::Write;
use std::sync::Mutex;

#[derive(Debug, Eq, Hash, PartialEq)]
#[repr(transparent)]
pub struct ResponseHandle {
    pub(crate) handle: u32,
}

impl ResponseHandle {
    pub const INVALID: Self = ResponseHandle {
        handle: fastly_shared::INVALID_RESPONSE_HANDLE,
    };

    pub fn is_invalid(&self) -> bool {
        self == &Self::INVALID
    }

    /// Get an owned `ResponseHandle` from a borrowed one.
    ///
    /// This should only be used when calling the raw ABI directly.
    pub(crate) unsafe fn handle(&self) -> Self {
        Self {
            handle: self.handle,
        }
    }

    pub fn new() -> Result<Self, Error> {
        let mut handle = ResponseHandle::INVALID;
        let status = unsafe { abi::xqd_resp_new(&mut handle) };
        if status.is_err() || handle.is_invalid() {
            Err(Error::msg("xqd_resp_new failed"))
        } else {
            Ok(handle)
        }
    }

    pub fn get_header_names<'a>(
        &'a self,
        max_len: usize,
    ) -> impl Iterator<Item = Result<HeaderName, Error>> + 'a {
        abi::MultiValueHostcall::new(
            b'\0',
            max_len,
            move |buf, buf_size, cursor, ending_cursor, nwritten| unsafe {
                abi::xqd_resp_header_names_get(
                    self.handle(),
                    buf,
                    buf_size,
                    cursor,
                    ending_cursor,
                    nwritten,
                )
            },
        )
        .map(|res| {
            res.and_then(|name_bytes| {
                HeaderName::from_bytes(&name_bytes)
                    .map_err(|e| anyhow!("invalid header name: {}", e))
            })
        })
    }

    pub fn get_header_values<'a>(
        &'a self,
        name: &'a HeaderName,
        max_len: usize,
    ) -> impl Iterator<Item = Result<HeaderValue, Error>> + 'a {
        abi::MultiValueHostcall::new(
            b'\0',
            max_len,
            move |buf, buf_size, cursor, ending_cursor, nwritten| unsafe {
                let name: &[u8] = name.as_ref();
                abi::xqd_resp_header_values_get(
                    self.handle(),
                    name.as_ptr(),
                    name.len(),
                    buf,
                    buf_size,
                    cursor,
                    ending_cursor,
                    nwritten,
                )
            },
        )
        .map(|res| {
            res.map(|value_bytes| unsafe {
                // we trust that the hostcall is giving us valid header bytes
                HeaderValue::from_maybe_shared_unchecked(value_bytes)
            })
        })
    }

    pub fn set_header_values<'a, I>(&mut self, name: &HeaderName, values: I) -> Result<(), Error>
    where
        I: IntoIterator<Item = &'a HeaderValue>,
    {
        // build a buffer of all the values, each terminated by a nul byte
        let mut buf = vec![];
        for value in values {
            buf.put(value.as_bytes());
            buf.put_u8(b'\0');
        }

        let name: &[u8] = name.as_ref();
        let status = unsafe {
            abi::xqd_resp_header_values_set(
                self.handle(),
                name.as_ptr(),
                name.len(),
                buf.as_ptr(),
                buf.len(),
            )
        };

        if status.is_err() {
            Err(Error::msg("xqd_req_header_values_set failed"))
        } else {
            Ok(())
        }
    }

    pub fn get_header_value(
        &self,
        name: &HeaderName,
        max_len: usize,
    ) -> Result<HeaderValue, Error> {
        let name: &[u8] = name.as_ref();
        let mut buf = BytesMut::with_capacity(max_len);
        let mut nwritten = 0;
        let status = unsafe {
            abi::xqd_resp_header_value_get(
                self.handle(),
                name.as_ptr(),
                name.len(),
                buf.as_mut_ptr(),
                buf.capacity(),
                &mut nwritten,
            )
        };
        if status.is_err() {
            return Err(Error::msg("xqd_resp_header_value_get returned error"));
        }
        assert!(nwritten <= buf.capacity(), "hostcall wrote too many bytes");
        unsafe {
            buf.set_len(nwritten);
        }
        Ok(HeaderValue::from_bytes(&buf).map_err(|_| Error::msg("invalid header"))?)
    }

    pub fn insert_header(&mut self, name: &HeaderName, value: &HeaderValue) -> Result<(), Error> {
        let name_bytes: &[u8] = name.as_ref();
        let value_bytes: &[u8] = value.as_ref();
        let status = unsafe {
            abi::xqd_resp_header_insert(
                self.handle(),
                name_bytes.as_ptr(),
                name_bytes.len(),
                value_bytes.as_ptr(),
                value_bytes.len(),
            )
        };
        if status.is_err() {
            Err(Error::msg("xqd_resp_header_insert returned error"))
        } else {
            Ok(())
        }
    }

    pub fn append_header(&mut self, name: &HeaderName, value: &HeaderValue) -> Result<(), Error> {
        let name_bytes: &[u8] = name.as_ref();
        let value_bytes: &[u8] = value.as_ref();
        let status = unsafe {
            abi::xqd_resp_header_append(
                self.handle(),
                name_bytes.as_ptr(),
                name_bytes.len(),
                value_bytes.as_ptr(),
                value_bytes.len(),
            )
        };
        if status.is_err() {
            Err(Error::msg("xqd_resp_header_append returned error"))
        } else {
            Ok(())
        }
    }

    pub fn set_status(&mut self, status: StatusCode) {
        let status = unsafe { abi::xqd_resp_status_set(self.handle(), status.as_u16()) };
        assert_eq!(
            status,
            XqdStatus::OK,
            "setting a StatusCode should always succeed"
        );
    }

    pub fn get_status(&self) -> Result<StatusCode, Error> {
        let mut status = 0;
        let xqd_status = unsafe { abi::xqd_resp_status_get(self.handle(), &mut status) };
        if xqd_status.is_err() {
            Err(Error::msg("xqd_resp_status_get failed"))
        } else {
            StatusCode::from_u16(status).map_err(|e| anyhow!("invalid status code: {}", e))
        }
    }

    pub fn get_version(&self) -> Result<Version, Error> {
        let mut version = 0;
        let status = unsafe { abi::xqd_resp_version_get(self.handle(), &mut version) };
        if status.is_err() {
            Err(Error::msg("xqd_resp_version_get failed"))
        } else {
            abi::HttpVersion::try_from(version)
                .map(Into::into)
                .map_err(Error::msg)
        }
    }

    pub fn set_version(&mut self, v: Version) -> Result<(), Error> {
        let status =
            unsafe { abi::xqd_resp_version_set(self.handle(), abi::HttpVersion::from(v) as u32) };
        if status.is_err() {
            Err(Error::msg("xqd_req_version_get failed"))
        } else {
            Ok(())
        }
    }

    /// Send this response downstream to the client with the given body.
    ///
    /// This will only begin sending bytes once the program has completed execution. If you want to
    /// begin sending before the program is complete, use
    /// `ResponseHandle::send_downstream_streaming()`.
    pub fn send_downstream(self, body: BodyHandle) -> Result<(), Error> {
        let status = unsafe { abi::xqd_resp_send_downstream(self, body, false as u32) };
        if status.is_err() {
            Err(Error::msg("xqd_resp_send_downstream failed"))
        } else {
            Ok(())
        }
    }

    /// Immediately begin sending this response downstream to the client, and return a
    /// `StreamingBodyHandle` that can accept further data to send.
    pub fn send_downstream_streaming(self, body: BodyHandle) -> Result<StreamingBodyHandle, Error> {
        let streaming_body_handle = unsafe { StreamingBodyHandle::from_body_handle(&body) };
        let status = unsafe { abi::xqd_resp_send_downstream(self, body, true as u32) };
        if status.is_err() {
            Err(Error::msg("xqd_resp_send_downstream failed"))
        } else {
            Ok(streaming_body_handle)
        }
    }
}

pub(crate) fn handles_to_response(
    resp_handle: ResponseHandle,
    resp_body_handle: BodyHandle,
) -> Result<Response<Body>, Error> {
    let mut resp = Response::builder()
        .status(resp_handle.get_status()?)
        .version(resp_handle.get_version()?);

    for name in resp_handle.get_header_names(crate::HEADER_NAME_MAX_LEN) {
        let name = name?;
        for value in resp_handle.get_header_values(&name, crate::HEADER_VALUE_MAX_LEN) {
            resp = resp.header(&name, value?);
        }
    }

    Ok(resp.body(resp_body_handle.into())?)
}

pub trait ResponseExt: Sized {
    fn send_downstream(self) -> Result<(), Error> {
        self.inner_to_body()?.send_downstream()
    }

    fn send_downstream_streaming(self) -> Result<StreamingBody, Error> {
        self.inner_to_body()?.send_downstream_streaming()
    }

    /// Replace the body of a response with a `Body` with the same contents.
    fn inner_to_body(self) -> Result<Response<Body>, Error>;

    /// Replace the body of a response with the remaining contents of its body.
    ///
    /// Note that this will involve copying and buffering the body, and so should only be used for
    /// convenience on small response bodies.
    fn inner_to_bytes(self) -> Result<Response<Vec<u8>>, Error>;
}

fn send_downstream_impl(
    resp: Response<Body>,
    streaming: bool,
) -> Result<Option<StreamingBody>, Error> {
    lazy_static! {
        static ref SENT: Mutex<bool> = Mutex::new(false);
    }

    let mut sent = SENT.lock().unwrap();
    if *sent {
        return Err(Error::msg(
            "cannot send more than one downstream response per execution",
        ));
    }

    let (parts, body) = resp.into_parts();

    let mut resp_handle = ResponseHandle::new()?;

    for name in parts.headers.keys() {
        resp_handle.set_header_values(name, parts.headers.get_all(name))?;
    }

    resp_handle.set_status(parts.status);
    resp_handle.set_version(parts.version)?;

    let res = if streaming {
        Some(
            resp_handle
                .send_downstream_streaming(body.into_handle()?)?
                .into(),
        )
    } else {
        resp_handle.send_downstream(body.into_handle()?)?;
        None
    };

    *sent = true;
    Ok(res)
}

impl ResponseExt for Response<Body> {
    /// Send this response downstream to the client.
    ///
    /// This will only begin sending bytes once the program has completed execution. If you want to
    /// begin sending before the program is complete, use
    /// `ResponseExt::send_downstream_streaming()`.
    fn send_downstream(self) -> Result<(), Error> {
        let res = send_downstream_impl(self, false)?;
        debug_assert!(res.is_none());
        Ok(())
    }

    /// Immediately begin sending this response downstream to the client, and return a
    /// `StreamingBody` that can accept further data to send.
    fn send_downstream_streaming(self) -> Result<StreamingBody, Error> {
        let res = send_downstream_impl(self, true)?;
        // streaming = true means we always get back a `Some`
        Ok(res.expect("streaming body is present"))
    }

    fn inner_to_body(self) -> Result<Response<Body>, Error> {
        Ok(self)
    }

    fn inner_to_bytes(self) -> Result<Response<Vec<u8>>, Error> {
        let (parts, body) = self.into_parts();
        Ok(Response::from_parts(parts, body.into_bytes()?))
    }
}

impl ResponseExt for Response<&[u8]> {
    fn inner_to_body(self) -> Result<Response<Body>, Error> {
        let mut body = Body::new()?;
        body.write_all(self.body())?;
        Ok(self.map(|_| body))
    }

    fn inner_to_bytes(self) -> Result<Response<Vec<u8>>, Error> {
        Ok(self.map(|b| b.to_vec()))
    }
}

impl ResponseExt for Response<Vec<u8>> {
    fn inner_to_body(self) -> Result<Response<Body>, Error> {
        let mut body = Body::new()?;
        body.write_all(self.body())?;
        Ok(self.map(|_| body))
    }

    fn inner_to_bytes(self) -> Result<Response<Vec<u8>>, Error> {
        Ok(self)
    }
}

impl ResponseExt for Response<&str> {
    fn inner_to_body(self) -> Result<Response<Body>, Error> {
        let mut body = Body::new()?;
        body.write_all(self.body().as_bytes())?;
        Ok(self.map(|_| body))
    }

    fn inner_to_bytes(self) -> Result<Response<Vec<u8>>, Error> {
        Ok(self.map(|b| b.as_bytes().to_vec()))
    }
}

impl ResponseExt for Response<String> {
    fn inner_to_body(self) -> Result<Response<Body>, Error> {
        let mut body = Body::new()?;
        body.write_all(self.body().as_bytes())?;
        Ok(self.map(|_| body))
    }

    fn inner_to_bytes(self) -> Result<Response<Vec<u8>>, Error> {
        Ok(self.map(|b| b.into_bytes()))
    }
}

impl ResponseExt for Response<()> {
    fn inner_to_body(self) -> Result<Response<Body>, Error> {
        let body = Body::new()?;
        Ok(self.map(|_| body))
    }

    fn inner_to_bytes(self) -> Result<Response<Vec<u8>>, Error> {
        Ok(self.map(|_| vec![]))
    }
}