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
/*
*   Copyright (c) 2023 Duart Snel
*   All rights reserved.

*   Licensed under the Apache License, Version 2.0 (the "License");
*   you may not use this file except in compliance with the License.
*   You may obtain a copy of the License at

*   http://www.apache.org/licenses/LICENSE-2.0

*   Unless required by applicable law or agreed to in writing, software
*   distributed under the License is distributed on an "AS IS" BASIS,
*   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*   See the License for the specific language governing permissions and
*   limitations under the License.
*/

pub mod classification {
    use std::collections::HashMap;

    use serde::{Deserialize, Serialize};

    #[derive(Clone, Debug, Serialize, Deserialize)]
    pub enum LicenseClassification {
        /// previously "Open Source"
        Open,
        Viral,
        Affero,
        Commercial,

        /// This entry shall contain the special case defined within
        Special(String),

        Unknown,
    }

    #[derive(Debug)]
    pub enum CompliancyStatus {
        Compliant,
        NonCompliant(Vec<LicenseClassification>),
    }

    #[allow(dead_code)]
    #[derive(Debug)]
    pub struct SPDXDetails {
        pub key: Option<String>,
        pub short_name: Option<String>,
        pub name: Option<String>,
        pub category: Option<String>,
    }

    #[derive(Debug, Deserialize, Serialize, Clone)]
    pub struct ClassificationEntry {
        pub classification: LicenseClassification,
    }

    #[derive(Debug, Deserialize, Serialize, Clone)]
    pub struct Classifier {
        pub data: HashMap<String, ClassificationEntry>,
    }

    impl Classifier {
        pub fn new() -> Classifier {
            Classifier {
                data: HashMap::new(),
            }
        }

        pub fn add(&mut self, key: &str, classification: ClassificationEntry) {
            self.data.insert(key.to_owned(), classification);
        }

        pub fn classify(&self, key: &str) -> Option<LicenseClassification> {
            match self.data.get(key) {
                Some(entry) => Some(entry.classification.clone()),
                None => None,
            }
        }

        pub fn get(&self, key: &str) -> Option<LicenseClassification> {
            self.classify(key)
        }

        pub fn classify_all(&self, keys: &Vec<String>) -> Vec<Option<LicenseClassification>> {
            keys.iter().map(|key| self.classify(key)).collect()
        }

        pub fn load_from_memory(&mut self, raw: Vec<u8>) {
            self.data = bincode::deserialize(&raw[..]).unwrap();
        }

        pub fn from_memory(raw: Vec<u8>) -> Classifier {
            let mut classifier = Classifier::new();
            classifier.load_from_memory(raw);
            classifier
        }

        pub fn load_from_file(&mut self, path: &str) {
            let raw = std::fs::read(path).unwrap();
            self.load_from_memory(raw);
        }

        pub fn from_file(path: &str) -> Classifier {
            let mut classifier = Classifier::new();
            classifier.load_from_file(path);
            classifier
        }

        pub fn save_to_file(&self, path: &str) {
            let raw = bincode::serialize(&self.data).unwrap();
            std::fs::write(path, raw).unwrap();
        }
    }

    pub fn compliancy_check(
        host_classification: &LicenseClassification,
        found_classifications: &Vec<LicenseClassification>,
        // TODO: opts struct with unknown_is_compliant and special_is_compliant
        unknown_is_compliant: bool,
    ) -> CompliancyStatus {
        let incompliant_pillars: Vec<LicenseClassification> = found_classifications
            .iter()
            .filter(|c| !match (host_classification, c) {
                // (what you have in your project, another dependency's license classification)
                (_, LicenseClassification::Unknown) | (LicenseClassification::Unknown, _) => {
                    unknown_is_compliant
                }

                (LicenseClassification::Open, LicenseClassification::Open) => true,
                (LicenseClassification::Open, LicenseClassification::Affero) => false,
                (LicenseClassification::Open, LicenseClassification::Viral) => false,
                (LicenseClassification::Open, LicenseClassification::Commercial) => false,
                (LicenseClassification::Viral, LicenseClassification::Viral) => true,
                (LicenseClassification::Viral, LicenseClassification::Open) => true,
                (LicenseClassification::Viral, LicenseClassification::Affero) => false,
                (LicenseClassification::Viral, LicenseClassification::Commercial) => false,
                (LicenseClassification::Affero, LicenseClassification::Open) => true,
                (LicenseClassification::Affero, LicenseClassification::Viral) => true,
                (LicenseClassification::Affero, LicenseClassification::Affero) => true,
                (LicenseClassification::Affero, LicenseClassification::Commercial) => false,
                // TODO: correct? we don't know if one commercial is compatible with another commercial
                (LicenseClassification::Commercial, LicenseClassification::Commercial) => false,
                (LicenseClassification::Commercial, LicenseClassification::Open) => true,
                (LicenseClassification::Commercial, LicenseClassification::Affero) => true,
                (LicenseClassification::Commercial, LicenseClassification::Viral) => true,
                (_, LicenseClassification::Special(_)) => false,
                (LicenseClassification::Special(_), _) => false,
                // _ => false,
            })
            .map(|c| c.to_owned())
            .collect();

        match incompliant_pillars.len() {
            0 => CompliancyStatus::Compliant,
            _ => CompliancyStatus::NonCompliant(incompliant_pillars),
        }
    }

    pub fn spdx_category_to_license_classification(spdx_category: &str) -> LicenseClassification {
        match spdx_category {
            "Public Domain" => LicenseClassification::Open,
            "Permissive" => LicenseClassification::Open,
            // open for interpretation whether this is viral or not. need manual human intervention.
            "Copyleft" => LicenseClassification::Unknown,
            // open for interpretation whether this is viral or not. need manual human intervention.
            "Copyleft Limited" => LicenseClassification::Unknown,

            // TODO: i think?
            "Commercial" => LicenseClassification::Commercial,

            // TODO: Lump this in with "Commercial"?
            "Source-available" => LicenseClassification::Commercial,

            // TODO: lump again with commercial?
            "Proprietary Free" => LicenseClassification::Commercial,
            "CLA" => LicenseClassification::Unknown,

            // TODO: not really licenses? require manual human intervention?
            "Patent License" => LicenseClassification::Unknown,
            "Unstated License" => LicenseClassification::Unknown,
            _ => LicenseClassification::Unknown,
        }
    }
}