use anyhow::Result;
use serde_json::Value;
use std::collections::BTreeMap;
use std::path::Path;
use vivacity_core::layout::{plugin_allowed, Layout, PluginVerdict};
use vivacity_core::lock::{Lock, LockPackage};
use vivacity_core::pathutil::{find_shortest_path, normalize_path};
use vivacity_core::runtime_stub::php_var_export;
use vivacity_resolver::constraint::{parse_constraints, Bound, Constraint};
pub const PHPSTAN: &str = "phpstan/extension-installer";
pub const RECTOR: &str = "rector/extension-installer";
pub const INFECTION: &str = "infection/extension-installer";
const PHPSTAN_TEMPLATE: &str = "<?php declare(strict_types = 1);\n\nnamespace PHPStan\\ExtensionInstaller;\n\n/**\n * This class is generated by phpstan/extension-installer.\n * @internal\n */\nfinal class GeneratedConfig\n{\n\n\tpublic const EXTENSIONS = %s;\n\n\tpublic const NOT_INSTALLED = %s;\n\n\t/** @var string|null */\n\tpublic const PHPSTAN_VERSION_CONSTRAINT = %s;\n\n\tprivate function __construct()\n\t{\n\t}\n\n}\n";
const RECTOR_TEMPLATE: &str = "<?php\n\ndeclare(strict_types = 1);\n\nnamespace Rector\\RectorInstaller;\n\n/**\n * This class is generated by rector/extension-installer.\n * @internal\n */\nfinal class GeneratedConfig\n{\n public const EXTENSIONS = %s;\n\n private function __construct()\n {\n }\n}\n";
const INFECTION_TEMPLATE: &str = "<?php\ndeclare(strict_types=1);\n\nnamespace Infection\\ExtensionInstaller;\n\n/**\n * This class is generated by infection/extension-installer\n */\nfinal class GeneratedExtensionsConfig\n{\n public const EXTENSIONS = %s;\n\n private function __construct()\n {\n }\n}";
fn full_pretty_version(p: &LockPackage) -> String {
let pretty = p.version().to_owned();
let normalized = vivacity_core::version::normalize_pretty(&pretty).unwrap_or_default();
let is_dev = normalized.starts_with("dev-") || normalized.ends_with("-dev");
let source_type = p
.raw
.get("source")
.and_then(|s| s.get("type"))
.and_then(Value::as_str)
.unwrap_or("");
let source_ref = p
.raw
.get("source")
.and_then(|s| s.get("reference"))
.and_then(Value::as_str)
.unwrap_or("");
let dist_ref = p.dist_reference().unwrap_or("");
if !is_dev
|| (!matches!(source_type, "git" | "hg")
&& (!source_type.is_empty() || dist_ref.is_empty()))
{
return pretty;
}
let reference = if !source_ref.is_empty() {
source_ref
} else {
dist_ref
};
if reference.is_empty() {
return pretty;
}
if reference.len() == 40 && source_type != "svn" {
return format!("{pretty} {}", &reference[..7]);
}
format!("{pretty} {reference}")
}
fn absolute_install_path(layout: &Layout, name: &str) -> Option<String> {
let abs = layout.abs(name)?;
let vendor = layout.vendor_dir();
let rel = abs.strip_prefix(&vendor).ok()?;
let real = std::fs::canonicalize(&vendor).unwrap_or(vendor);
let real = real.to_string_lossy();
let real = real.strip_prefix("\\\\?\\").unwrap_or(&real);
let rel = rel.to_string_lossy().replace('\\', "/");
Some(format!("{}/{}", real.trim_end_matches(['/', '\\']), rel))
}
fn constraint_into_string(c: &Constraint) -> String {
let (lo, hi) = (c.lower_bound(), c.upper_bound());
format!(
"{}{}, {}{}",
if lo.inclusive { ">=" } else { ">" },
lo.version,
if hi.inclusive { "<=" } else { "<" },
hi.version
)
}
fn write_if_changed(path: &Path, contents: &str) -> Result<bool> {
if std::fs::read(path).ok().as_deref() == Some(contents.as_bytes()) {
return Ok(false);
}
let tmp = path.with_extension("php.vivacity-tmp");
std::fs::write(&tmp, contents)?;
std::fs::rename(&tmp, path)?;
Ok(true)
}
fn local_repository_entries(p: &LockPackage, lock_aliases: &[Value]) -> usize {
let branch = usize::from(vivacity_resolver::loader::branch_alias(&p.raw).is_some());
let inline = lock_aliases
.iter()
.filter(|a| a.get("package").and_then(Value::as_str) == Some(p.name()))
.count();
1 + branch + inline
}
fn fill(template: &str, args: &[String]) -> String {
let mut out = String::new();
let mut parts = template.split("%s");
if let Some(first) = parts.next() {
out.push_str(first);
}
for (part, arg) in parts.zip(args) {
out.push_str(arg);
out.push_str(part);
}
out
}
pub fn phpstan(
layout: &Layout,
local: &Lock,
lock_aliases: &[Value],
manifest: &Value,
with_dev: bool,
plugins_enabled: bool,
) -> Result<()> {
let packages: Vec<&LockPackage> = local.wanted_packages(with_dev).collect();
if !plugins_enabled
|| !packages.iter().any(|p| p.name() == PHPSTAN)
|| !matches!(plugin_allowed(manifest, PHPSTAN), PluginVerdict::Allowed)
{
return Ok(());
}
let Some(own) = layout.abs(PHPSTAN) else {
return Ok(());
};
let src_dir = own.join("src");
if !src_dir.is_dir() {
return Ok(());
}
let generated_dir = normalize_path(
&absolute_install_path(layout, PHPSTAN)
.map(|p| format!("{p}/src"))
.unwrap_or_default(),
);
let ignore: Vec<&str> = manifest
.get("extra")
.and_then(|e| e.get(PHPSTAN))
.and_then(|e| e.get("ignore"))
.and_then(Value::as_array)
.map(|a| a.iter().filter_map(Value::as_str).collect())
.unwrap_or_default();
let mut data: BTreeMap<String, Value> = BTreeMap::new();
let mut not_installed: BTreeMap<String, Value> = BTreeMap::new();
let mut ignored: Vec<&str> = Vec::new();
let mut constraints: Vec<Constraint> = Vec::new();
for p in &packages {
let extra_phpstan = p.raw.get("extra").and_then(|e| e.get("phpstan"));
if p.package_type() != "phpstan-extension" && extra_phpstan.is_none() {
if p.name().contains("phpstan")
&& ![
"phpstan/phpstan",
"phpstan/phpstan-shim",
"phpstan/phpdoc-parser",
PHPSTAN,
]
.contains(&p.name())
{
not_installed.insert(p.name().to_owned(), Value::String(full_pretty_version(p)));
}
continue;
}
if ignore.contains(&p.name()) {
for _ in 0..local_repository_entries(p, lock_aliases) {
ignored.push(p.name());
}
continue;
}
let Some(install_path) = absolute_install_path(layout, p.name()) else {
continue;
};
let mut phpstan_constraint: Option<Constraint> = None;
if let Some(text) = p
.raw
.get("require")
.and_then(|r| r.get("phpstan/phpstan"))
.and_then(Value::as_str)
{
if let Ok(parsed) = parse_constraints(text) {
let c = parsed.constraint;
if c.lower_bound() == Bound::zero() || c.upper_bound() == Bound::positive_infinity()
{
continue;
}
constraints.push(c.clone());
phpstan_constraint = Some(c);
}
}
let mut entry = serde_json::Map::new();
entry.insert("install_path".into(), Value::String(install_path.clone()));
entry.insert(
"relative_install_path".into(),
Value::String(find_shortest_path(&generated_dir, &install_path, true)),
);
entry.insert(
"extra".into(),
extra_phpstan.cloned().unwrap_or(Value::Null),
);
entry.insert("version".into(), Value::String(full_pretty_version(p)));
entry.insert(
"phpstanVersionConstraint".into(),
phpstan_constraint
.as_ref()
.map(|c| Value::String(constraint_into_string(c)))
.unwrap_or(Value::Null),
);
data.insert(p.name().to_owned(), Value::Object(entry));
}
let overall = if constraints.is_empty() {
Value::Null
} else {
let multi = if constraints.len() == 1 {
constraints.remove(0)
} else {
Constraint::Multi {
constraints,
conjunctive: true,
}
};
Value::String(constraint_into_string(
&vivacity_resolver::intervals::compact_constraint(&multi),
))
};
let installed_names: Vec<String> = data.keys().cloned().collect();
let unsupported_names: Vec<String> = not_installed.keys().cloned().collect();
let as_object = |m: BTreeMap<String, Value>| {
let mut o = serde_json::Map::new();
for (k, v) in m {
o.insert(k, v);
}
Value::Object(o)
};
let contents = fill(
PHPSTAN_TEMPLATE,
&[
php_var_export(&as_object(data), 0),
php_var_export(&as_object(not_installed), 0),
php_var_export(&overall, 0),
],
);
let changed = write_if_changed(&src_dir.join("GeneratedConfig.php"), &contents)?;
vivacity_core::out!("phpstan/extension-installer: Extensions installed");
if changed {
for name in installed_names {
vivacity_core::out!("> {name}: installed");
}
for name in unsupported_names {
vivacity_core::out!("> {name}: not supported");
}
ignored.sort_unstable();
for name in ignored {
vivacity_core::out!("> {name}: ignored");
}
}
Ok(())
}
pub fn rector(
layout: &Layout,
local: &Lock,
manifest: &Value,
with_dev: bool,
plugins_enabled: bool,
) -> Result<()> {
let packages: Vec<&LockPackage> = local.wanted_packages(with_dev).collect();
if !plugins_enabled
|| !packages.iter().any(|p| p.name() == RECTOR)
|| !matches!(plugin_allowed(manifest, RECTOR), PluginVerdict::Allowed)
{
return Ok(());
}
let Some(own) = layout.abs(RECTOR) else {
return Ok(());
};
let src_dir = own.join("src");
if !src_dir.is_dir() {
return Ok(());
}
let generated_dir = normalize_path(
&absolute_install_path(layout, RECTOR)
.map(|p| format!("{p}/src"))
.unwrap_or_default(),
);
let mut data: BTreeMap<String, Value> = BTreeMap::new();
for p in &packages {
let extra_rector = p.raw.get("extra").and_then(|e| e.get("rector"));
if p.package_type() != "rector-extension" && extra_rector.is_none() {
continue;
}
let Some(install_path) = absolute_install_path(layout, p.name()) else {
continue;
};
let mut entry = serde_json::Map::new();
entry.insert("install_path".into(), Value::String(install_path.clone()));
entry.insert(
"relative_install_path".into(),
Value::String(find_shortest_path(&generated_dir, &install_path, true)),
);
entry.insert("extra".into(), extra_rector.cloned().unwrap_or(Value::Null));
entry.insert("version".into(), Value::String(full_pretty_version(p)));
data.insert(p.name().to_owned(), Value::Object(entry));
}
let installed_names: Vec<String> = data.keys().cloned().collect();
let mut o = serde_json::Map::new();
for (k, v) in data {
o.insert(k, v);
}
let contents = fill(RECTOR_TEMPLATE, &[php_var_export(&Value::Object(o), 0)]);
if write_if_changed(&src_dir.join("GeneratedConfig.php"), &contents)? {
vivacity_core::out!("rector/rector-installer: Extensions installed");
for name in installed_names {
vivacity_core::out!("> {name}: installed");
}
}
Ok(())
}
pub fn in_order<'a>(mut packages: Vec<&'a LockPackage>, order: &[&str]) -> Vec<&'a LockPackage> {
packages.sort_by_key(|p| {
order
.iter()
.position(|n| *n == p.name())
.unwrap_or(usize::MAX)
});
packages
}
pub fn infection(
layout: &Layout,
local: &Lock,
order: &[&str],
manifest: &Value,
with_dev: bool,
plugins_enabled: bool,
) -> Result<()> {
let packages = in_order(local.wanted_packages(with_dev).collect(), order);
if !plugins_enabled
|| !packages.iter().any(|p| p.name() == INFECTION)
|| !matches!(plugin_allowed(manifest, INFECTION), PluginVerdict::Allowed)
{
return Ok(());
}
let Some(own) = layout.abs(INFECTION) else {
return Ok(());
};
let src_dir = own.join("src");
if !src_dir.is_dir() {
return Ok(());
}
let mut data: BTreeMap<String, Value> = BTreeMap::new();
let mut invalid: Vec<&str> = Vec::new();
for p in &packages {
if p.package_type() != "infection-extension" {
continue;
}
let extra = p.raw.get("extra").and_then(|e| e.get("infection"));
let class = extra
.filter(|e| e.is_object())
.and_then(|e| e.get("class"))
.filter(|c| !c.is_null());
if class.is_none() {
if !invalid.contains(&p.name()) {
invalid.push(p.name());
}
continue;
}
let Some(install_path) = absolute_install_path(layout, p.name()) else {
continue;
};
let mut entry = serde_json::Map::new();
entry.insert("install_path".into(), Value::String(install_path));
entry.insert("extra".into(), extra.cloned().unwrap_or(Value::Null));
entry.insert("version".into(), Value::String(full_pretty_version(p)));
data.insert(p.name().to_owned(), Value::Object(entry));
}
let installed_names: Vec<String> = data.keys().cloned().collect();
let mut o = serde_json::Map::new();
for (k, v) in data {
o.insert(k, v);
}
let contents = fill(INFECTION_TEMPLATE, &[php_var_export(&Value::Object(o), 0)]);
write_if_changed(&src_dir.join("GeneratedExtensionsConfig.php"), &contents)?;
if installed_names.is_empty() && invalid.is_empty() {
vivacity_core::out!("infection/extension-installer: No extensions found");
}
if !installed_names.is_empty() {
vivacity_core::out!("infection/extension-installer: Extensions installed");
for name in &installed_names {
vivacity_core::out!("> {name}: installed");
}
}
if !invalid.is_empty() {
vivacity_core::out!("infection/extension-installer: Invalid extensions:");
for name in invalid {
vivacity_core::out!("> {name}. (`class` is not specified under `extra.infection` key)");
}
}
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn constraint_string_like_the_plugin() {
let c = parse_constraints("^1.10").unwrap().constraint;
assert_eq!(constraint_into_string(&c), ">=1.10.0.0-dev, <2.0.0.0-dev");
let multi = Constraint::Multi {
constraints: vec![
parse_constraints("^1.10").unwrap().constraint,
parse_constraints("^1.11.5").unwrap().constraint,
],
conjunctive: true,
};
assert_eq!(
constraint_into_string(&vivacity_resolver::intervals::compact_constraint(&multi)),
">=1.11.5.0-dev, <2.0.0.0-dev"
);
}
#[test]
fn an_ignored_package_is_listed_once_per_repository_entry() {
let lock = Lock::parse(
&serde_json::json!({"packages": [
{"name": "a/plain", "version": "1.0.0", "type": "phpstan-extension"},
{"name": "a/branch", "version": "dev-main", "type": "phpstan-extension",
"extra": {"branch-alias": {"dev-main": "1.0.x-dev"}}},
{"name": "a/inline", "version": "1.0.0", "type": "phpstan-extension"},
], "packages-dev": [], "aliases": [
{"package": "a/inline", "version": "1.0.0.0", "alias": "1.0.99", "alias_normalized": "1.0.99.0"},
]})
.to_string(),
)
.unwrap();
let count = |name: &str| {
let p = lock.packages.iter().find(|p| p.name() == name).unwrap();
local_repository_entries(p, &lock.aliases)
};
assert_eq!(count("a/plain"), 1);
assert_eq!(count("a/branch"), 2);
assert_eq!(count("a/inline"), 2);
}
#[test]
fn sprintf_fill() {
assert_eq!(fill("a %s b %s c", &["1".into(), "2".into()]), "a 1 b 2 c");
}
}