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
pub mod version;
pub mod publisher;
pub mod compare;
pub mod fmri_list;
mod helpers;
#[cfg(test)]
mod tests;

use std::{
    cmp::Ordering,
    fmt::{Debug, Display, Formatter}
};
use serde::{Deserialize, Serialize};
use crate::helpers::{check_character_collision, remove_first_and_last_characters};

pub use self::{
    compare::Compare,
    version::Version,
    publisher::Publisher,
    fmri_list::FMRIList
};

/// [`FMRI`] represents pkg fmri versioning system
///
/// # Examples
///
/// ```plain
/// pkg:/audio/audacity
/// pkg:/audio/audacity@2.3.2,5.11-2022.0.0.1
/// pkg://solaris/system/library
/// pkg://solaris/system/library@0.5.11-0.175.1.0.0.2.1:20120919T082311Z
/// ```
#[derive(PartialEq, Serialize, Deserialize, Clone, Ord, Eq, PartialOrd)]
pub struct FMRI {
    /// Publisher is optional
    publisher: Option<Publisher>,
    // TODO: add package_name struct?
    package_name: String,
    /// Version is optional
    version: Option<Version>,
}

impl FMRI {
    /// Returns [`FMRI`] with given package name
    pub fn new_from_package_name(mut package_name: String) -> Self {
        if package_name.is_empty() {
            panic!("package name can't be empty")
        }

        check_character_collision(&package_name);
        package_name = remove_first_and_last_characters(&package_name, '/').to_owned();

        Self {
            publisher: None,
            package_name,
            version: None,
        }
    }

    /// Returns [`FMRI`] from raw fmri
    ///
    /// # Examples
    ///
    /// ```
    /// use fmri::FMRI;
    /// FMRI::parse_raw(&"fmri=test@1-1:20220913T082027Z".to_owned());
    /// FMRI::parse_raw(&"pkg://publisher/test@1-1:20220913T082027Z".to_owned());
    /// ```
    pub fn parse_raw(raw_fmri: &String) -> Self {
        let mut publisher: Option<Publisher> = None;
        let mut version: Option<Version> = None;
        let mut package_name: String = raw_fmri.clone().trim_start_matches("fmri=").to_owned();

        match Publisher::parse_publisher_from_raw_fmri(raw_fmri.clone()) {
            None => {
                package_name = package_name.trim_start_matches("pkg:/").to_owned();
            }
            Some(p) => {
                publisher = Some(p);
                let (_, end_str) = package_name.trim_start_matches("pkg://").split_once("/").expect("Fmri must contain \"/package_name\"");
                package_name = end_str.to_owned()
            }
        }

        match Version::parse_version_from_raw_fmri(raw_fmri.clone()) {
            None => {}
            Some(v) => {
                version = Some(v);
                let (start_str, _) = package_name.split_once("@").expect("error");
                package_name = start_str.to_owned()
            }
        }

        let mut fmri = Self::new_from_package_name(package_name);
        if let Some(p) = publisher {
            fmri.change_publisher(p);
        }
        if let Some(v) = version {
            fmri.change_version(v);
        }
        fmri
    }

    /// Checks if package names are same
    pub fn package_name_eq(&self, comparing_to: &FMRI) -> bool {
        if self.get_package_name_as_ref_string() == comparing_to.get_package_name_as_ref_string() {
            return true;
        }
        false
    }

    /// Checks if package names are not same
    pub fn package_name_ne(&self, comparing_to: &FMRI) -> bool {
        if self.get_package_name_as_ref_string() != comparing_to.get_package_name_as_ref_string() {
            return true;
        }
        false
    }

    /// Returns [`FMRI`] as [String]
    pub fn get_package_name_as_string(self) -> String {
        self.package_name
    }

    /// Returns [`FMRI`] as &[String]
    pub fn get_package_name_as_ref_string(&self) -> &String {
        &self.package_name
    }

    /// Returns [`FMRI`] as &mut [String]
    pub fn get_package_name_as_ref_mut_string(&mut self) -> &mut String {
        &mut self.package_name
    }

    /// Returns [`Publisher`] of [`FMRI`] as [`Publisher`]
    pub fn get_publisher(self) -> Option<Publisher> {
        self.publisher
    }

    /// Returns [`Publisher`] of [`FMRI`] as &[`Publisher`]
    pub fn get_publisher_ref(&self) -> &Option<Publisher> {
        &self.publisher
    }

    /// Returns [`Publisher`] of [`FMRI`] as &mut [`Publisher`]
    pub fn get_publisher_ref_mut(&mut self) -> &mut Option<Publisher> {
        &mut self.publisher
    }

    /// Checks if [`FMRI`] has [`Publisher`]
    pub fn has_publisher(&self) -> bool {
        if self.publisher == None {
            return false;
        }
        true
    }

    /// Changes [`Publisher`] in [`FMRI`]
    pub fn change_publisher(&mut self, publisher: Publisher) {
        self.publisher = Some(publisher);
    }

    /// Returns [`Publisher`] as [`Option`]<&[String]>, returns [`None`] if there isn't [`Publisher`]
    pub fn get_publisher_as_ref_string(&self) -> Option<&String> {
        if let Some(publisher) = &self.publisher {
            return Some(publisher.get_as_ref_string());
        }
        None
    }

    /// Removes [`Publisher`] from [`FMRI`]
    pub fn remove_publisher(&mut self) {
        self.publisher = None
    }

    /// Returns [`Version`] of [`FMRI`] as [`Version`]
    pub fn get_version(self) -> Option<Version> {
        self.version
    }

    /// Returns [`Version`] of [`FMRI`] as &[`Version`]
    pub fn get_version_ref(&self) -> &Option<Version> {
        &self.version
    }

    /// Returns [`Version`] of [`FMRI`] as &mut [`Version`]
    pub fn get_version_ref_mut(&mut self) -> &mut Option<Version> {
        &mut self.version
    }

    /// Checks if [`FMRI`] has [`Version`]
    pub fn has_version(&self) -> bool {
        if self.version == None {
            return false;
        }
        true
    }

    /// Changes [`Version`] in [`FMRI`]
    pub fn change_version(&mut self, version: Version) {
        self.version = Some(version)
    }

    /// Returns [`Version`] as [`Option`]<&[String]>, returns [`None`] if there isn't [`Version`]
    pub fn get_version_as_string(&self) -> Option<String> {
        if let Some(version) = &self.version {
            return Some(format!("{}", version));
        }
        None
    }

    /// Removes [`Version`] from [`FMRI`]
    pub fn remove_version(&mut self) -> &mut FMRI {
        self.version = None;
        self
    }
}

/// Implementation of [`Compare`] for [`FMRI`]
impl Compare for FMRI {
    /// Compares [`Versions`][`Version`] of [`FMRIs`][FMRI]
    fn compare(&self, comparing_to: &Self) -> Ordering {
        if self.package_name_ne(comparing_to) {
            panic!("comparing FMRIs doesn't have same package names")
        }

        if !self.has_version() || !comparing_to.has_version() {
            return Ordering::Equal;
        }

        self
            .version
            .as_ref()
            .unwrap()
            .compare(&comparing_to.version.as_ref().unwrap())
    }
}

/// Implementation of [`Display`] for [`FMRI`]
impl Display for FMRI {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let mut string: String = "".to_owned();

        if self.has_publisher() {
            string.push_str("pkg://");
            string.push_str(self.get_publisher_as_ref_string().unwrap());
            string.push_str("/");
        } else {
            string.push_str("pkg:/");
        }

        string.push_str(self.get_package_name_as_ref_string());

        if self.has_version() {
            string.push_str(&self.get_version_as_string().unwrap());
        }

        write!(f, "{}", string)
    }
}

/// Implementation of [`Debug`] for [`FMRI`]
impl Debug for FMRI {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", format!("{}", self))
    }
}