fisher 1.0.0

Webhooks catcher written in Rust
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

// Copyright (C) 2016-2017 Pietro Albini
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

use std::net::IpAddr;
use std::sync::{Arc, Mutex};
use std::sync::atomic::{AtomicBool, Ordering};

use common::prelude::*;
use common::config::RateLimitConfig;

use requests::{Request, RequestType};
use scripts::{Repository, Job};
use web::rate_limits::RateLimiter;
use web::responses::Response;


#[derive(Clone)]
pub struct WebApi<A: ProcessorApiTrait<Repository>> {
    processor: Arc<Mutex<A>>,
    hooks: Arc<Repository>,
    locked: Arc<AtomicBool>,
    limiter: Arc<Mutex<RateLimiter<IpAddr>>>,

    health_enabled: bool,
}

impl<A: ProcessorApiTrait<Repository>> WebApi<A> {
    pub fn new(
        processor: A,
        hooks: Arc<Repository>,
        locked: Arc<AtomicBool>,
        rate_limit_config: &RateLimitConfig,
        health_enabled: bool,
    ) -> Self {
        let limiter = Arc::new(Mutex::new(RateLimiter::new(
            rate_limit_config.allowed,
            rate_limit_config.interval.as_u64(),
        )));

        WebApi {
            processor: Arc::new(Mutex::new(processor)),
            hooks, locked, limiter, health_enabled,
        }
    }

    pub fn process_hook(&self, req: &Request, args: Vec<String>) -> Response {
        let hook_name = &args[0];

        // Don't process hooks if the web api is locked
        if self.locked.load(Ordering::Relaxed) {
            return Response::Unavailable;
        }

        // Check if the user is not rate limited
        if let Ok(r) = req.web() {
            let limited = self.limiter.lock().unwrap().is_limited(&r.source);
            if let Some(until) = limited {
                return Response::TooManyRequests(until);
            }
        }

        // Check if the hook exists
        let hook;
        if let Some(found) = self.hooks.get_by_name(hook_name) {
            hook = found;
        } else {
            return Response::NotFound;
        }

        // Validate the hook
        let (request_type, provider) = hook.validate(req);

        // Change behavior based on the request type
        match request_type {
            // Don't do anything if it's only a ping
            RequestType::Ping => Response::Ok,

            // Queue a job if the hook should be executed
            RequestType::ExecuteHook => {
                let job = Job::new(hook.clone(), provider, req.clone());
                self.processor
                    .lock()
                    .unwrap()
                    .queue(job, hook.priority())
                    .unwrap();

                Response::Ok
            },

            RequestType::Invalid => {
                // Increment the limits for the user
                if let Ok(r) = req.web() {
                    self.limiter.lock().unwrap().increment(r.source);
                }

                Response::Forbidden
            },
        }
    }

    pub fn get_health(&self, _req: &Request, _args: Vec<String>) -> Response {
        if self.health_enabled {
            Response::HealthStatus(
                self.processor.lock().unwrap().health_details().unwrap(),
            )
        } else {
            Response::Forbidden
        }
    }
}