torrust-index 3.0.0

A BitTorrent Index
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

//! Templates for "about" static pages.

use std::sync::Arc;

use super::authorization::{self, ACTION};
use crate::errors::ServiceError;
use crate::models::user::UserId;

pub struct Service {
    authorization_service: Arc<authorization::Service>,
}

impl Service {
    #[must_use]
    pub fn new(authorization_service: Arc<authorization::Service>) -> Service {
        Service { authorization_service }
    }

    /// Returns the html with the about page
    ///
    /// # Errors
    ///
    /// It returns an error if:
    ///
    /// * The user does not have the required permissions.
    /// * There is an error authorizing the action.
    pub async fn get_about_page(&self, maybe_user_id: Option<UserId>) -> Result<String, ServiceError> {
        self.authorization_service
            .authorize(ACTION::GetAboutPage, maybe_user_id)
            .await?;

        let html = r#"
    <html>
        <head>
            <title>About</title>
        </head>
        <body style="margin-left: auto;margin-right: auto;max-width: 30em;">
            <h1>Torrust Index</h1>

            <h2>About</h2>

            <p>Hi! This is a running <a href="https://github.com/torrust/torrust-index">torrust-index</a>.</p>
        </body>
        <footer style="padding: 1.25em 0;border-top: dotted 1px;">
            <a href="./about/license">license</a>
        </footer>
    </html>
"#;

        Ok(html.to_string())
    }

    /// Returns the html with the license page
    ///
    /// # Errors
    ///
    /// It returns an error if:
    ///
    /// * The user does not have the required permissions.
    /// * There is an error authorizing the action.
    pub async fn get_license_page(&self, maybe_user_id: Option<UserId>) -> Result<String, ServiceError> {
        self.authorization_service
            .authorize(ACTION::GetLicensePage, maybe_user_id)
            .await?;

        let html = r#"
        <html>
            <head>
                <title>Licensing</title>
            </head>
            <body style="margin-left: auto;margin-right: auto;max-width: 30em;">
                <h1>Torrust Index</h1>
    
                <h2>Licensing</h2>
    
                <h3>Multiple Licenses</h3>
    
                <p>This repository has multiple licenses depending on the content type, the date of contributions or stemming from external component licenses that were not developed by any of Torrust team members or Torrust repository contributors.</p>
    
                <p>The two main applicable license to most of its content are:</p>
    
                <p>- For Code -- <a href="https://github.com/torrust/torrust-index/blob/main/licensing/agpl-3.0.md">agpl-3.0</a></p>
    
                <p>- For Media (Images, etc.) -- <a href="https://github.com/torrust/torrust-index/blob/main/licensing/cc-by-sa.md">cc-by-sa</a></p>
    
                <p>If you want to read more about all the licenses and how they apply please refer to the <a href="https://github.com/torrust/torrust-index/blob/develop/licensing/contributor_agreement_v01.md">contributor agreement</a>.</p>
            </body>
            <footer style="padding: 1.25em 0;border-top: dotted 1px;">
                <a href="../about">about</a>
            </footer>
        </html>
    "#;

        Ok(html.to_string())
    }
}