directories 0.0.3

A minimal library that provides the platform-specific location of configuration, cache etc. directories by leveraging the mechanisms defined by the XDG base directory and the XDG user directory specifications on Linux, the Known Folder API on Windows, and the Standard Directory rules on macOS.
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

use std;
use std::path::PathBuf;

extern crate winapi;
use self::winapi::um::knownfolders;
use self::winapi::um::combaseapi;
use self::winapi::um::shlobj;
use self::winapi::um::shtypes;
use self::winapi::um::winnt;

use BaseDirectories;
use ProjectDirectories;
use strip_qualification;

pub fn base_directories() -> BaseDirectories {
    let home_dir         = unsafe { known_folder(&knownfolders::FOLDERID_UserProfiles) };
    let data_dir         = unsafe { known_folder(&knownfolders::FOLDERID_LocalAppData) };
    let data_roaming_dir = unsafe { known_folder(&knownfolders::FOLDERID_RoamingAppData) };
    let desktop_dir      = unsafe { known_folder(&knownfolders::FOLDERID_Desktop) };
    let documents_dir    = unsafe { known_folder(&knownfolders::FOLDERID_Documents) };
    let download_dir     = unsafe { known_folder(&knownfolders::FOLDERID_Downloads) };
    let music_dir        = unsafe { known_folder(&knownfolders::FOLDERID_Music) };
    let pictures_dir     = unsafe { known_folder(&knownfolders::FOLDERID_Pictures) };
    let public_dir       = unsafe { known_folder(&knownfolders::FOLDERID_Public) };
    let templates_dir    = unsafe { known_folder(&knownfolders::FOLDERID_Templates) };
    let videos_dir       = unsafe { known_folder(&knownfolders::FOLDERID_Videos) };

    let cache_dir        = data_dir.join("cache");
    let config_dir       = data_roaming_dir.clone();

    BaseDirectories {
        home_dir:         home_dir,
        cache_dir:        cache_dir,
        config_dir:       config_dir,
        data_dir:         data_dir,
        data_roaming_dir: data_roaming_dir,
        runtime_dir:      None,
        desktop_dir:      desktop_dir,
        documents_dir:    documents_dir,
        download_dir:     download_dir,
        music_dir:        music_dir,
        pictures_dir:     pictures_dir,
        public_dir:       public_dir,
        templates_dir:    Some(templates_dir),
        videos_dir:       videos_dir,
        executables_dir:  None,
        fonts_dir:        None
    }
}

impl ProjectDirectories {
    pub fn from_unprocessed_string(value: &str) -> ProjectDirectories {
        let project_name             = String::from(value);
        let data_dir                 = unsafe { known_folder(&knownfolders::FOLDERID_LocalAppData) };

        let project_cache_dir        = data_dir.join(&value).join("cache");
        let project_data_dir         = data_dir.join(&value);
        let project_roaming_data_dir = unsafe { known_folder(&knownfolders::FOLDERID_RoamingAppData) }.join(&value);

        let project_config_dir       = project_roaming_data_dir.clone();

        ProjectDirectories {
            project_name:             project_name,
            project_cache_dir:        project_cache_dir,
            project_config_dir:       project_config_dir,
            project_data_dir:         project_data_dir,
            project_data_roaming_dir: project_roaming_data_dir,
            project_runtime_dir:      None,
        }
    }

    pub fn from_project_name(project_name: &str) -> ProjectDirectories {
        ProjectDirectories::from_unprocessed_string(project_name)
    }

    pub fn from_qualified_project_name(qualified_project_name: &str) -> ProjectDirectories {
        let name = strip_qualification(qualified_project_name).trim();
        ProjectDirectories::from_unprocessed_string(name)
    }
}

unsafe fn known_folder(folder_id: shtypes::REFKNOWNFOLDERID) -> PathBuf {
    let mut path_ptr: winnt::PWSTR = std::ptr::null_mut();
    let _result = shlobj::SHGetKnownFolderPath(folder_id, 0, std::ptr::null_mut(), &mut path_ptr);
    let len = length_of_u16_string(path_ptr);
    let path = std::slice::from_raw_parts(path_ptr, len);
    let ostr: std::ffi::OsString = std::os::windows::ffi::OsStringExt::from_wide(path);
    combaseapi::CoTaskMemFree(path_ptr as *mut winapi::ctypes::c_void);
    PathBuf::from(ostr)
}

unsafe fn length_of_u16_string(ptr: *mut u16) -> usize {
    let mut index = 0;
    while *ptr.offset(index as isize) != 0 as u16 {
        index += 1;
    }
    index
}