nextcloud_appinfo 0.6.0

Library to read app info of an Nextcloud app
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

pub mod error;

use std::fs::read_to_string;
use std::path::{Path, PathBuf};

use error::Error;
pub use semver::Version;
use xpath_reader::{Context, Reader};

#[derive(Debug)]
pub struct AppInfo {
    id: String,
    name: String,
    version: Version,
}

impl AppInfo {
    pub fn id(&self) -> &String {
        &self.id
    }
    pub fn name(&self) -> &String {
        &self.name
    }
    pub fn version(&self) -> &Version {
        &self.version
    }
}

fn parse_appinfo(xml: &str) -> Result<AppInfo, Error> {
    let context = Context::new();
    let reader = Reader::from_str(xml, Some(&context))?;

    let id = reader.read("//info/id/text()")?;
    let name = reader.read("//info/name/text()")?;
    let version: String = reader.read("//info/version/text()")?;

    Ok(AppInfo {
        id,
        name,
        version: Version::parse(&version)?,
    })
}

pub fn get_appinfo(app_path: &Path) -> Result<AppInfo, Error> {
    let mut appinfo_path = PathBuf::from(app_path);
    appinfo_path.push("appinfo");
    appinfo_path.push("info.xml");
    if !appinfo_path.exists() {
        return Err(error::Error::InfoXmlMissing);
    }
    let xml = read_to_string(appinfo_path.as_path())?;
    parse_appinfo(&xml)
}

#[cfg(test)]
mod tests {
    use super::*;

    const APPINFO1: &'static str = "<?xml version=\"1.0\"?>
    <info xmlns:xsi= \"http://www.w3.org/2001/XMLSchema-instance\"
      xsi:noNamespaceSchemaLocation=\"https://apps.nextcloud.com/schema/apps/info.xsd\">
	<id>mail</id>
	<name>Mail</name>
	<summary>IMAP web client</summary>
	<description>Easy to use email client which connects to your mail server via IMAP and SMTP.</description>
	<version>0.7.3</version>
	<licence>agpl</licence>
	<author>Christoph Wurst</author>
	<author>Jan-Christoph Borchardt</author>
	<author>Steffen Lindner</author>
	<namespace>Mail</namespace>
	<documentation>
		<admin>https://github.com/nextcloud/mail#readme</admin>
	</documentation>
	<category>social</category>
	<category>office</category>
	<website>https://github.com/nextcloud/mail#readme</website>
	<bugs>https://github.com/nextcloud/mail/issues</bugs>
	<repository type=\"git\">https://github.com/nextcloud/mail.git</repository>
	<screenshot>https://raw.githubusercontent.com/nextcloud/mail/74e94da16618b32ee0834e57bbfc83ff7334f709/screenshots/mail.png</screenshot>
	<dependencies>
		<php min-version=\"5.6\" max-version=\"7.1\" />
		<nextcloud min-version=\"12\" max-version=\"13\" />
	</dependencies>
	<repair-steps>
		<post-migration>
			<step>OCA\\Mail\\Migration\\FixCollectedAddresses</step>
		</post-migration>
	</repair-steps>
</info>";

    #[test]
    fn it_parses_basic_info() {
        let actual = parse_appinfo(APPINFO1).unwrap();

        assert_eq!("mail", actual.id);
        assert_eq!("Mail", actual.name);
        assert_eq!(Version::parse("0.7.3").unwrap(), actual.version);
    }

    #[test]
    fn it_handles_notfound_errors() {
        // There's no appinfo/info.xml in here
        let path = Path::new(".");

        let result = get_appinfo(&path);

        assert!(matches!(result, Err(Error::InfoXmlMissing)));
    }
}