magika 1.0.1

Determines file content types using AI
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
123

// Copyright 2024 Google LLC
//
// 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.

use std::path::Path;

use ndarray::Array2;

use crate::future::{exec, AsyncEnv, Env, SyncEnv};
use crate::input::AsyncInputApi;
use crate::{AsyncInput, Builder, Features, FeaturesOrRuled, FileType, Result, SyncInput};

/// A Magika session to identify files.
#[derive(Debug)]
pub struct Session {
    pub(crate) session: ort::session::Session,
}

impl Session {
    /// Creates a default session.
    pub fn new() -> Result<Self> {
        Session::builder().build()
    }

    /// Initializes a new Magika session builder with default values.
    pub fn builder() -> Builder {
        Builder::default()
    }

    /// Identifies a single file (synchronously).
    pub fn identify_file_sync(&mut self, file: impl AsRef<Path>) -> Result<FileType> {
        exec(self.identify_file::<SyncEnv>(file.as_ref()))
    }

    /// Identifies a single file (asynchronously).
    pub async fn identify_file_async(&mut self, file: impl AsRef<Path>) -> Result<FileType> {
        self.identify_file::<AsyncEnv>(file.as_ref()).await
    }

    async fn identify_file<E: Env>(&mut self, file: &Path) -> Result<FileType> {
        let metadata = E::symlink_metadata(file).await?;
        if metadata.is_dir() {
            Ok(FileType::Directory)
        } else if metadata.is_symlink() {
            Ok(FileType::Symlink)
        } else {
            debug_assert!(metadata.is_file());
            self.identify_content::<E>(E::open(file).await?).await
        }
    }

    /// Identifies a single file from its content (synchronously).
    pub fn identify_content_sync(&mut self, file: impl SyncInput) -> Result<FileType> {
        exec(self.identify_content::<SyncEnv>(file))
    }

    /// Identifies a single file from its content (asynchronously).
    pub async fn identify_content_async(&mut self, file: impl AsyncInput) -> Result<FileType> {
        self.identify_content::<AsyncEnv>(file).await
    }

    async fn identify_content<E: Env>(&mut self, file: impl AsyncInputApi) -> Result<FileType> {
        match FeaturesOrRuled::extract(file).await? {
            FeaturesOrRuled::Ruled(content_type) => Ok(FileType::Ruled(content_type)),
            FeaturesOrRuled::Features(features) => self.identify_features::<E>(&features).await,
        }
    }

    /// Identifies a single file from its features (synchronously).
    pub fn identify_features_sync(&mut self, features: &Features) -> Result<FileType> {
        exec(self.identify_features::<SyncEnv>(features))
    }

    /// Identifies a single file from its features (asynchronously).
    pub async fn identify_features_async(&mut self, features: &Features) -> Result<FileType> {
        self.identify_features::<AsyncEnv>(features).await
    }

    async fn identify_features<E: Env>(&mut self, features: &Features) -> Result<FileType> {
        let results = self.identify_features_batch::<E>(std::slice::from_ref(features)).await?;
        let [result] = results.try_into().ok().unwrap();
        Ok(result)
    }

    /// Identifies multiple files in parallel from their features (synchronously).
    pub fn identify_features_batch_sync(&mut self, features: &[Features]) -> Result<Vec<FileType>> {
        exec(self.identify_features_batch::<SyncEnv>(features))
    }

    /// Identifies multiple files in parallel from their features (asynchronously).
    pub async fn identify_features_batch_async(
        &mut self, features: &[Features],
    ) -> Result<Vec<FileType>> {
        self.identify_features_batch::<AsyncEnv>(features).await
    }

    async fn identify_features_batch<E: Env>(
        &mut self, features: &[Features],
    ) -> Result<Vec<FileType>> {
        if features.is_empty() {
            return Ok(Vec::new());
        }
        let features_size = crate::model::CONFIG.features_size();
        let input = Array2::from_shape_vec(
            [features.len(), features_size],
            features.iter().flat_map(|x| &x.0).cloned().collect(),
        )?;
        let mut output = E::ort_session_run(&mut self.session, input).await?;
        let output = output.remove("target_label").unwrap();
        let output = output.try_extract_array()?;
        Ok(FileType::convert(output))
    }
}