      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

    //! Request logging middleware
    use std::collections::HashSet;
    use std::env;
    use std::fmt::{self, Display, Formatter};

    use regex::Regex;
    use time;

    use error::Result;
    use httpmessage::HttpMessage;
    use httprequest::HttpRequest;
    use httpresponse::HttpResponse;
    use middleware::{Finished, Middleware, Started};

    /// `Middleware` for logging request and response info to the terminal.
    ///
    /// `Logger` middleware uses standard log crate to log information. You should
    /// enable logger for `actix_web` package to see access log.
    /// ([`env_logger`](https://docs.rs/env_logger/*/env_logger/) or similar)
    ///
    /// ## Usage
    ///
    /// Create `Logger` middleware with the specified `format`.
    /// Default `Logger` could be created with `default` method, it uses the
    /// default format:
    ///
    /// ```ignore
    ///  %a "%r" %s %b "%{Referer}i" "%{User-Agent}i" %T
    /// ```
    /// ```rust
    /// # extern crate actix_web;
    /// extern crate env_logger;
    /// use actix_web::middleware::Logger;
    /// use actix_web::App;
    ///
    /// fn main() {
    ///     std::env::set_var("RUST_LOG", "actix_web=info");
    ///     env_logger::init();
    ///
    ///     let app = App::new()
    ///         .middleware(Logger::default())
    ///         .middleware(Logger::new("%a %{User-Agent}i"))
    ///         .finish();
    /// }
    /// ```
    ///
    /// ## Format
    ///
    /// `%%`  The percent sign
    ///
    /// `%a`  Remote IP-address (IP-address of proxy if using reverse proxy)
    ///
    /// `%t`  Time when the request was started to process
    ///
    /// `%r`  First line of request
    ///
    /// `%s`  Response status code
    ///
    /// `%b`  Size of response in bytes, including HTTP headers
    ///
    /// `%T` Time taken to serve the request, in seconds with floating fraction in
    /// .06f format
    ///
    /// `%D`  Time taken to serve the request, in milliseconds
    ///
    /// `%{FOO}i`  request.headers['FOO']
    ///
    /// `%{FOO}o`  response.headers['FOO']
    ///
    /// `%{FOO}e`  os.environ['FOO']
    ///
    pub struct Logger {
        format: Format,
        exclude: HashSet<String>,
    }

    impl Logger {
        /// Create `Logger` middleware with the specified `format`.
        pub fn new(format: &str) -> Logger {
            Logger {
                format: Format::new(format),
                exclude: HashSet::new(),
            }
        }

        /// Ignore and do not log access info for specified path.
        pub fn exclude<T: Into<String>>(mut self, path: T) -> Self {
            self.exclude.insert(path.into());
            self
        }
    }

    impl Default for Logger {
        /// Create `Logger` middleware with format:
        ///
        /// ```ignore
        /// %a "%r" %s %b "%{Referer}i" "%{User-Agent}i" %T
        /// ```
        fn default() -> Logger {
            Logger {
                format: Format::default(),
                exclude: HashSet::new(),
            }
        }
    }

    struct StartTime(time::Tm);

    impl Logger {
        fn log<S>(&self, req: &HttpRequest<S>, resp: &HttpResponse) {
            if let Some(entry_time) = req.extensions().get::<StartTime>() {
                let render = |fmt: &mut Formatter| {
                    for unit in &self.format.0 {
                        unit.render(fmt, req, resp, entry_time.0)?;
                    }
                    Ok(())
                };
                info!("{}", FormatDisplay(&render));
            }
        }
    }

    impl<S> Middleware<S> for Logger {
        fn start(&self, req: &HttpRequest<S>) -> Result<Started> {
            if !self.exclude.contains(req.path()) {
                req.extensions_mut().insert(StartTime(time::now()));
            }
            Ok(Started::Done)
        }

        fn finish(&self, req: &HttpRequest<S>, resp: &HttpResponse) -> Finished {
            self.log(req, resp);
            Finished::Done
        }
    }

    /// A formatting style for the `Logger`, consisting of multiple
    /// `FormatText`s concatenated into one line.
    #[derive(Clone)]
    #[doc(hidden)]
    struct Format(Vec<FormatText>);

    impl Default for Format {
        /// Return the default formatting style for the `Logger`:
        fn default() -> Format {
            Format::new(r#"%a "%r" %s %b "%{Referer}i" "%{User-Agent}i" %T"#)
        }
    }

    impl Format {
        /// Create a `Format` from a format string.
        ///
        /// Returns `None` if the format string syntax is incorrect.
        pub fn new(s: &str) -> Format {
            trace!("Access log format: {}", s);
            let fmt = Regex::new(r"%(\{([A-Za-z0-9\-_]+)\}([ioe])|[atPrsbTD]?)").unwrap();

            let mut idx = 0;
            let mut results = Vec::new();
            for cap in fmt.captures_iter(s) {
                let m = cap.get(0).unwrap();
                let pos = m.start();
                if idx != pos {
                    results.push(FormatText::Str(s[idx..pos].to_owned()));
                }
                idx = m.end();

                if let Some(key) = cap.get(2) {
                    results.push(match cap.get(3).unwrap().as_str() {
                        "i" => FormatText::RequestHeader(key.as_str().to_owned()),
                        "o" => FormatText::ResponseHeader(key.as_str().to_owned()),
                        "e" => FormatText::EnvironHeader(key.as_str().to_owned()),
                        _ => unreachable!(),
                    })
                } else {
                    let m = cap.get(1).unwrap();
                    results.push(match m.as_str() {
                        "%" => FormatText::Percent,
                        "a" => FormatText::RemoteAddr,
                        "t" => FormatText::RequestTime,
                        "r" => FormatText::RequestLine,
                        "s" => FormatText::ResponseStatus,
                        "b" => FormatText::ResponseSize,
                        "T" => FormatText::Time,
                        "D" => FormatText::TimeMillis,
                        _ => FormatText::Str(m.as_str().to_owned()),
                    });
                }
            }
            if idx != s.len() {
                results.push(FormatText::Str(s[idx..].to_owned()));
            }

            Format(results)
        }
    }

    /// A string of text to be logged. This is either one of the data
    /// fields supported by the `Logger`, or a custom `String`.
    #[doc(hidden)]
    #[derive(Debug, Clone)]
    pub enum FormatText {
        Str(String),
        Percent,
        RequestLine,
        RequestTime,
        ResponseStatus,
        ResponseSize,
        Time,
        TimeMillis,
        RemoteAddr,
        RequestHeader(String),
        ResponseHeader(String),
        EnvironHeader(String),
    }

    impl FormatText {
        fn render<S>(
            &self, fmt: &mut Formatter, req: &HttpRequest<S>, resp: &HttpResponse,
            entry_time: time::Tm,
        ) -> Result<(), fmt::Error> {
            match *self {
                FormatText::Str(ref string) => fmt.write_str(string),
                FormatText::Percent => "%".fmt(fmt),
                FormatText::RequestLine => {
                    if req.query_string().is_empty() {
                        fmt.write_fmt(format_args!(
                            "{} {} {:?}",
                            req.method(),
                            req.path(),
                            req.version()
                        ))
                    } else {
                        fmt.write_fmt(format_args!(
                            "{} {}?{} {:?}",
                            req.method(),
                            req.path(),
                            req.query_string(),
                            req.version()
                        ))
                    }
                }
                FormatText::ResponseStatus => resp.status().as_u16().fmt(fmt),
                FormatText::ResponseSize => resp.response_size().fmt(fmt),
                FormatText::Time => {
                    let rt = time::now() - entry_time;
                    let rt = (rt.num_nanoseconds().unwrap_or(0) as f64) / 1_000_000_000.0;
                    fmt.write_fmt(format_args!("{:.6}", rt))
                }
                FormatText::TimeMillis => {
                    let rt = time::now() - entry_time;
                    let rt = (rt.num_nanoseconds().unwrap_or(0) as f64) / 1_000_000.0;
                    fmt.write_fmt(format_args!("{:.6}", rt))
                }
                FormatText::RemoteAddr => {
                    if let Some(remote) = req.connection_info().remote() {
                        return remote.fmt(fmt);
                    } else {
                        "-".fmt(fmt)
                    }
                }
                FormatText::RequestTime => entry_time
                    .strftime("[%d/%b/%Y:%H:%M:%S %z]")
                    .unwrap()
                    .fmt(fmt),
                FormatText::RequestHeader(ref name) => {
                    let s = if let Some(val) = req.headers().get(name) {
                        if let Ok(s) = val.to_str() {
                            s
                        } else {
                            "-"
                        }
                    } else {
                        "-"
                    };
                    fmt.write_fmt(format_args!("{}", s))
                }
                FormatText::ResponseHeader(ref name) => {
                    let s = if let Some(val) = resp.headers().get(name) {
                        if let Ok(s) = val.to_str() {
                            s
                        } else {
                            "-"
                        }
                    } else {
                        "-"
                    };
                    fmt.write_fmt(format_args!("{}", s))
                }
                FormatText::EnvironHeader(ref name) => {
                    if let Ok(val) = env::var(name) {
                        fmt.write_fmt(format_args!("{}", val))
                    } else {
                        "-".fmt(fmt)
                    }
                }
            }
        }
    }

    pub(crate) struct FormatDisplay<'a>(&'a Fn(&mut Formatter) -> Result<(), fmt::Error>);

    impl<'a> fmt::Display for FormatDisplay<'a> {
        fn fmt(&self, fmt: &mut Formatter) -> Result<(), fmt::Error> {
            (self.0)(fmt)
        }
    }

    #[cfg(test)]
    mod tests {
        use time;

        use super::*;
        use http::{header, StatusCode};
        use test::TestRequest;

        #[test]
        fn test_logger() {
            let logger = Logger::new("%% %{User-Agent}i %{X-Test}o %{HOME}e %D test");

            let req = TestRequest::with_header(
                header::USER_AGENT,
                header::HeaderValue::from_static("ACTIX-WEB"),
            ).finish();
            let resp = HttpResponse::build(StatusCode::OK)
                .header("X-Test", "ttt")
                .force_close()
                .finish();

            match logger.start(&req) {
                Ok(Started::Done) => (),
                _ => panic!(),
            };
            match logger.finish(&req, &resp) {
                Finished::Done => (),
                _ => panic!(),
            }
            let entry_time = time::now();
            let render = |fmt: &mut Formatter| {
                for unit in &logger.format.0 {
                    unit.render(fmt, &req, &resp, entry_time)?;
                }
                Ok(())
            };
            let s = format!("{}", FormatDisplay(&render));
            assert!(s.contains("ACTIX-WEB ttt"));
        }

        #[test]
        fn test_default_format() {
            let format = Format::default();

            let req = TestRequest::with_header(
                header::USER_AGENT,
                header::HeaderValue::from_static("ACTIX-WEB"),
            ).finish();
            let resp = HttpResponse::build(StatusCode::OK).force_close().finish();
            let entry_time = time::now();

            let render = |fmt: &mut Formatter| {
                for unit in &format.0 {
                    unit.render(fmt, &req, &resp, entry_time)?;
                }
                Ok(())
            };
            let s = format!("{}", FormatDisplay(&render));
            assert!(s.contains("GET / HTTP/1.1"));
            assert!(s.contains("200 0"));
            assert!(s.contains("ACTIX-WEB"));

            let req = TestRequest::with_uri("/?test").finish();
            let resp = HttpResponse::build(StatusCode::OK).force_close().finish();
            let entry_time = time::now();

            let render = |fmt: &mut Formatter| {
                for unit in &format.0 {
                    unit.render(fmt, &req, &resp, entry_time)?;
                }
                Ok(())
            };
            let s = format!("{}", FormatDisplay(&render));
            assert!(s.contains("GET /?test HTTP/1.1"));
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)