espanso/espanso-package/src/lib.rs
2021-10-06 18:40:16 +02:00

113 lines
3.6 KiB
Rust

/*
* This file is part of espanso.
*
* Copyright (C) 2019-2021 Federico Terzi
*
* espanso is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* espanso is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with espanso. If not, see <https://www.gnu.org/licenses/>.
*/
use std::path::Path;
use anyhow::{bail, Result};
mod archive;
#[macro_use]
mod logging;
mod manifest;
mod package;
mod provider;
mod resolver;
mod util;
pub use archive::{ArchivedPackage, Archiver, SaveOptions, StoredPackage};
pub use package::Package;
pub use provider::{PackageProvider, PackageSpecifier, ProviderOptions};
pub fn get_provider(
package: &PackageSpecifier,
runtime_dir: &Path,
options: &ProviderOptions,
) -> Result<Box<dyn PackageProvider>> {
if let Some(git_repo_url) = package.git_repo_url.as_deref() {
if !package.use_native_git {
let matches_known_hosts =
if let Some(github_parts) = util::github::extract_github_url_parts(git_repo_url) {
if let Some(repo_scheme) =
util::github::resolve_repo_scheme(github_parts, package.git_branch.as_deref())?
{
return Ok(Box::new(provider::github::GitHubPackageProvider::new(
repo_scheme.author,
repo_scheme.name,
repo_scheme.branch,
)));
}
true
} else if let Some(gitlab_parts) = util::gitlab::extract_gitlab_url_parts(git_repo_url) {
if let Some(repo_scheme) =
util::gitlab::resolve_repo_scheme(gitlab_parts, package.git_branch.as_deref())?
{
return Ok(Box::new(provider::gitlab::GitLabPackageProvider::new(
repo_scheme.author,
repo_scheme.name,
repo_scheme.branch,
)));
}
true
} else {
false
};
// Git repository seems to be in one of the known hosts, but the direct methods
// couldn't retrieve its content. This might happen with private repos (as they are not
// available to non-authenticated requests), so we check if a "git ls-remote" command
// is able to access it.
if matches_known_hosts && !util::git::is_private_repo(git_repo_url) {
bail!("could not access repository: {}, make sure it exists and that you have the necessary access rights.", git_repo_url);
}
}
// Git repository is neither on Github or Gitlab
// OR it's a private repository, which means we can't use the direct method
// (because it's not authenticated)
Ok(Box::new(provider::git::GitPackageProvider::new()))
} else {
// Download from the official espanso hub
Ok(Box::new(provider::hub::EspansoHubPackageProvider::new(
runtime_dir,
options.force_index_update,
)))
}
}
pub fn get_archiver(package_dir: &Path) -> Result<Box<dyn Archiver>> {
Ok(Box::new(archive::default::DefaultArchiver::new(
package_dir,
)))
}
#[cfg(test)]
pub(crate) mod tests {
use super::*;
use tempdir::TempDir;
pub(crate) fn run_with_temp_dir(action: impl FnOnce(&Path)) {
let tmp_dir = TempDir::new("espanso-package").unwrap();
let tmp_path = tmp_dir.path();
action(tmp_path);
}
}