summary refs log tree commit diff stats
path: root/pkgs/by-name/ba/back/src/git_bug/format/mod.rs
blob: b3b6bcc334a25ff9c17fee580c112cdd6a0cdfc5 (plain) (blame)
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
// Back - An extremely simple git issue tracking system. Inspired by tvix's
// panettone
//
// Copyright (C) 2024 Benedikt Peetz <benedikt.peetz@b-peetz.de>
// SPDX-License-Identifier: AGPL-3.0-or-later
//
// This file is part of Back.
//
// You should have received a copy of the License along with this program.
// If not, see <https://www.gnu.org/licenses/agpl.txt>.

use std::fmt::Display;

use chrono::DateTime;
use markdown::to_html;
use serde::Deserialize;
use serde_json::Value;

#[derive(Debug, Default, Clone)]
/// Markdown content.
pub struct MarkDown {
    value: String,
}

impl Display for MarkDown {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(to_html(&self.value).as_str())
    }
}
impl From<&Value> for MarkDown {
    fn from(value: &Value) -> Self {
        Self {
            value: value.as_str().expect("This will exist").to_owned(),
        }
    }
}

/// An UNIX time stamp.
///
/// These should only ever be used for human-display, because timestamps are unreliably in a
/// distributed system.
/// Because of this reason, there is no `value()` function.
#[derive(Debug, Default, Clone, Copy)]
pub struct TimeStamp {
    value: u64,
}
impl From<&Value> for TimeStamp {
    fn from(value: &Value) -> Self {
        Self {
            value: value.as_u64().expect("This must exist"),
        }
    }
}
impl Display for TimeStamp {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let date =
            DateTime::from_timestamp(self.value as i64, 0).expect("This timestamp should be vaild");

        let newdate = date.format("%Y-%m-%d %H:%M:%S");
        f.write_str(newdate.to_string().as_str())
    }
}

/// An UNIX time stamp.
///
/// These should only ever be used for human-display, because timestamps are unreliably in a
/// distributed system.
///
/// This one allows underlying access to it's value and is only obtainable via `unsafe` code.
/// The reason behind this is, that you might need to access this to improve the display for humans
/// (i.e., sorting by date).
#[derive(Debug, Default, Clone, Copy, Ord, PartialOrd, Eq, PartialEq)]
pub struct UnsafeTimeStamp {
    value: u64,
}
impl TimeStamp {
    /// # Safety
    /// This is not really unsafe, but there is just no way your can trust a time stamp in a
    /// distributed system. As such access to the raw value could lead to bugs.
    pub unsafe fn to_unsafe(self) -> UnsafeTimeStamp {
        UnsafeTimeStamp { value: self.value }
    }
}

#[derive(Debug, Default, Deserialize, Clone, PartialEq, Eq)]
/// A string that should be escaped when injected into html content.
pub struct HtmlString {
    value: String,
}

impl From<MarkDown> for HtmlString {
    fn from(value: MarkDown) -> Self {
        Self { value: value.value }
    }
}

impl From<&Value> for HtmlString {
    fn from(value: &Value) -> Self {
        Self {
            value: value.as_str().expect("This will exist").to_owned(),
        }
    }
}
impl Display for HtmlString {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(escape_html(&self.value).as_str())
    }
}

// From `tera::escape_html`
/// Escape HTML following [OWASP](https://www.owasp.org/index.php/XSS_(Cross_Site_Scripting)_Prevention_Cheat_Sheet)
///
/// Escape the following characters with HTML entity encoding to prevent switching
/// into any execution context, such as script, style, or event handlers. Using
/// hex entities is recommended in the spec. In addition to the 5 characters
/// significant in XML (&, <, >, ", '), the forward slash is included as it helps
/// to end an HTML entity.
///
/// ```text
/// & --> &amp;
/// < --> &lt;
/// > --> &gt;
/// " --> &quot;
/// ' --> &#x27;     &apos; is not recommended
/// / --> &#x2F;     forward slash is included as it helps end an HTML entity
/// ```
#[inline]
pub fn escape_html(input: &str) -> String {
    let mut output = String::with_capacity(input.len() * 2);
    for c in input.chars() {
        match c {
            '&' => output.push_str("&amp;"),
            '<' => output.push_str("&lt;"),
            '>' => output.push_str("&gt;"),
            '"' => output.push_str("&quot;"),
            '\'' => output.push_str("&#x27;"),
            '/' => output.push_str("&#x2F;"),
            _ => output.push(c),
        }
    }

    // Not using shrink_to_fit() on purpose
    output
}