1use anyhow::{Context as _, Result, bail};
2use collections::{BTreeMap, HashMap};
3use fs::Fs;
4use language::LanguageName;
5use lsp::LanguageServerName;
6use semantic_version::SemanticVersion;
7use serde::{Deserialize, Serialize};
8use std::{
9 ffi::OsStr,
10 fmt,
11 path::{Path, PathBuf},
12 sync::Arc,
13};
14
15/// This is the old version of the extension manifest, from when it was `extension.json`.
16#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
17pub struct OldExtensionManifest {
18 pub name: String,
19 pub version: Arc<str>,
20
21 #[serde(default)]
22 pub description: Option<String>,
23 #[serde(default)]
24 pub repository: Option<String>,
25 #[serde(default)]
26 pub authors: Vec<String>,
27
28 #[serde(default)]
29 pub themes: BTreeMap<Arc<str>, PathBuf>,
30 #[serde(default)]
31 pub languages: BTreeMap<Arc<str>, PathBuf>,
32 #[serde(default)]
33 pub grammars: BTreeMap<Arc<str>, PathBuf>,
34}
35
36/// The schema version of the [`ExtensionManifest`].
37#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy, Serialize, Deserialize)]
38pub struct SchemaVersion(pub i32);
39
40impl fmt::Display for SchemaVersion {
41 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
42 write!(f, "{}", self.0)
43 }
44}
45
46impl SchemaVersion {
47 pub const ZERO: Self = Self(0);
48
49 pub fn is_v0(&self) -> bool {
50 self == &Self::ZERO
51 }
52}
53
54#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
55pub struct ExtensionManifest {
56 pub id: Arc<str>,
57 pub name: String,
58 pub version: Arc<str>,
59 pub schema_version: SchemaVersion,
60
61 #[serde(default)]
62 pub description: Option<String>,
63 #[serde(default)]
64 pub repository: Option<String>,
65 #[serde(default)]
66 pub authors: Vec<String>,
67 #[serde(default)]
68 pub lib: LibManifestEntry,
69
70 #[serde(default)]
71 pub themes: Vec<PathBuf>,
72 #[serde(default)]
73 pub icon_themes: Vec<PathBuf>,
74 #[serde(default)]
75 pub languages: Vec<PathBuf>,
76 #[serde(default)]
77 pub grammars: BTreeMap<Arc<str>, GrammarManifestEntry>,
78 #[serde(default)]
79 pub language_servers: BTreeMap<LanguageServerName, LanguageServerManifestEntry>,
80 #[serde(default)]
81 pub context_servers: BTreeMap<Arc<str>, ContextServerManifestEntry>,
82 #[serde(default)]
83 pub slash_commands: BTreeMap<Arc<str>, SlashCommandManifestEntry>,
84 #[serde(default)]
85 pub indexed_docs_providers: BTreeMap<Arc<str>, IndexedDocsProviderEntry>,
86 #[serde(default)]
87 pub snippets: Option<PathBuf>,
88 #[serde(default)]
89 pub capabilities: Vec<ExtensionCapability>,
90 #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
91 pub debug_adapters: BTreeMap<Arc<str>, DebugAdapterManifestEntry>,
92 #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
93 pub debug_locators: BTreeMap<Arc<str>, DebugLocatorManifestEntry>,
94}
95
96impl ExtensionManifest {
97 pub fn allow_exec(
98 &self,
99 desired_command: &str,
100 desired_args: &[impl AsRef<str> + std::fmt::Debug],
101 ) -> Result<()> {
102 let is_allowed = self.capabilities.iter().any(|capability| match capability {
103 ExtensionCapability::ProcessExec { command, args } if command == desired_command => {
104 for (ix, arg) in args.iter().enumerate() {
105 if arg == "**" {
106 return true;
107 }
108
109 if ix >= desired_args.len() {
110 return false;
111 }
112
113 if arg != "*" && arg != desired_args[ix].as_ref() {
114 return false;
115 }
116 }
117 if args.len() < desired_args.len() {
118 return false;
119 }
120 true
121 }
122 _ => false,
123 });
124
125 if !is_allowed {
126 bail!(
127 "capability for process:exec {desired_command} {desired_args:?} was not listed in the extension manifest",
128 );
129 }
130
131 Ok(())
132 }
133}
134
135pub fn build_debug_adapter_schema_path(
136 adapter_name: &Arc<str>,
137 meta: &DebugAdapterManifestEntry,
138) -> PathBuf {
139 meta.schema_path.clone().unwrap_or_else(|| {
140 Path::new("debug_adapter_schemas")
141 .join(Path::new(adapter_name.as_ref()).with_extension("json"))
142 })
143}
144
145/// A capability for an extension.
146#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
147#[serde(tag = "kind")]
148pub enum ExtensionCapability {
149 #[serde(rename = "process:exec")]
150 ProcessExec {
151 /// The command to execute.
152 command: String,
153 /// The arguments to pass to the command. Use `*` for a single wildcard argument.
154 /// If the last element is `**`, then any trailing arguments are allowed.
155 args: Vec<String>,
156 },
157}
158
159#[derive(Clone, Default, PartialEq, Eq, Debug, Deserialize, Serialize)]
160pub struct LibManifestEntry {
161 pub kind: Option<ExtensionLibraryKind>,
162 pub version: Option<SemanticVersion>,
163}
164
165#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
166pub enum ExtensionLibraryKind {
167 Rust,
168}
169
170#[derive(Clone, Default, PartialEq, Eq, Debug, Deserialize, Serialize)]
171pub struct GrammarManifestEntry {
172 pub repository: String,
173 #[serde(alias = "commit")]
174 pub rev: String,
175 #[serde(default)]
176 pub path: Option<String>,
177}
178
179#[derive(Clone, Default, PartialEq, Eq, Debug, Deserialize, Serialize)]
180pub struct LanguageServerManifestEntry {
181 /// Deprecated in favor of `languages`.
182 #[serde(default)]
183 language: Option<LanguageName>,
184 /// The list of languages this language server should work with.
185 #[serde(default)]
186 languages: Vec<LanguageName>,
187 #[serde(default)]
188 pub language_ids: HashMap<String, String>,
189 #[serde(default)]
190 pub code_action_kinds: Option<Vec<lsp::CodeActionKind>>,
191}
192
193impl LanguageServerManifestEntry {
194 /// Returns the list of languages for the language server.
195 ///
196 /// Prefer this over accessing the `language` or `languages` fields directly,
197 /// as we currently support both.
198 ///
199 /// We can replace this with just field access for the `languages` field once
200 /// we have removed `language`.
201 pub fn languages(&self) -> impl IntoIterator<Item = LanguageName> + '_ {
202 let language = if self.languages.is_empty() {
203 self.language.clone()
204 } else {
205 None
206 };
207 self.languages.iter().cloned().chain(language)
208 }
209}
210
211#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
212pub struct ContextServerManifestEntry {}
213
214#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
215pub struct SlashCommandManifestEntry {
216 pub description: String,
217 pub requires_argument: bool,
218}
219
220#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
221pub struct IndexedDocsProviderEntry {}
222
223#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
224pub struct DebugAdapterManifestEntry {
225 pub schema_path: Option<PathBuf>,
226}
227
228#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
229pub struct DebugLocatorManifestEntry {}
230
231impl ExtensionManifest {
232 pub async fn load(fs: Arc<dyn Fs>, extension_dir: &Path) -> Result<Self> {
233 let extension_name = extension_dir
234 .file_name()
235 .and_then(OsStr::to_str)
236 .context("invalid extension name")?;
237
238 let mut extension_manifest_path = extension_dir.join("extension.json");
239 if fs.is_file(&extension_manifest_path).await {
240 let manifest_content = fs
241 .load(&extension_manifest_path)
242 .await
243 .with_context(|| format!("failed to load {extension_name} extension.json"))?;
244 let manifest_json = serde_json::from_str::<OldExtensionManifest>(&manifest_content)
245 .with_context(|| {
246 format!("invalid extension.json for extension {extension_name}")
247 })?;
248
249 Ok(manifest_from_old_manifest(manifest_json, extension_name))
250 } else {
251 extension_manifest_path.set_extension("toml");
252 let manifest_content = fs
253 .load(&extension_manifest_path)
254 .await
255 .with_context(|| format!("failed to load {extension_name} extension.toml"))?;
256 toml::from_str(&manifest_content)
257 .with_context(|| format!("invalid extension.toml for extension {extension_name}"))
258 }
259 }
260}
261
262fn manifest_from_old_manifest(
263 manifest_json: OldExtensionManifest,
264 extension_id: &str,
265) -> ExtensionManifest {
266 ExtensionManifest {
267 id: extension_id.into(),
268 name: manifest_json.name,
269 version: manifest_json.version,
270 description: manifest_json.description,
271 repository: manifest_json.repository,
272 authors: manifest_json.authors,
273 schema_version: SchemaVersion::ZERO,
274 lib: Default::default(),
275 themes: {
276 let mut themes = manifest_json.themes.into_values().collect::<Vec<_>>();
277 themes.sort();
278 themes.dedup();
279 themes
280 },
281 icon_themes: Vec::new(),
282 languages: {
283 let mut languages = manifest_json.languages.into_values().collect::<Vec<_>>();
284 languages.sort();
285 languages.dedup();
286 languages
287 },
288 grammars: manifest_json
289 .grammars
290 .into_keys()
291 .map(|grammar_name| (grammar_name, Default::default()))
292 .collect(),
293 language_servers: Default::default(),
294 context_servers: BTreeMap::default(),
295 slash_commands: BTreeMap::default(),
296 indexed_docs_providers: BTreeMap::default(),
297 snippets: None,
298 capabilities: Vec::new(),
299 debug_adapters: Default::default(),
300 debug_locators: Default::default(),
301 }
302}
303
304#[cfg(test)]
305mod tests {
306 use super::*;
307
308 fn extension_manifest() -> ExtensionManifest {
309 ExtensionManifest {
310 id: "test".into(),
311 name: "Test".to_string(),
312 version: "1.0.0".into(),
313 schema_version: SchemaVersion::ZERO,
314 description: None,
315 repository: None,
316 authors: vec![],
317 lib: Default::default(),
318 themes: vec![],
319 icon_themes: vec![],
320 languages: vec![],
321 grammars: BTreeMap::default(),
322 language_servers: BTreeMap::default(),
323 context_servers: BTreeMap::default(),
324 slash_commands: BTreeMap::default(),
325 indexed_docs_providers: BTreeMap::default(),
326 snippets: None,
327 capabilities: vec![],
328 debug_adapters: Default::default(),
329 debug_locators: Default::default(),
330 }
331 }
332
333 #[test]
334 fn test_build_adapter_schema_path_with_schema_path() {
335 let adapter_name = Arc::from("my_adapter");
336 let entry = DebugAdapterManifestEntry {
337 schema_path: Some(PathBuf::from("foo/bar")),
338 };
339
340 let path = build_debug_adapter_schema_path(&adapter_name, &entry);
341 assert_eq!(path, PathBuf::from("foo/bar"));
342 }
343
344 #[test]
345 fn test_build_adapter_schema_path_without_schema_path() {
346 let adapter_name = Arc::from("my_adapter");
347 let entry = DebugAdapterManifestEntry { schema_path: None };
348
349 let path = build_debug_adapter_schema_path(&adapter_name, &entry);
350 assert_eq!(
351 path,
352 PathBuf::from("debug_adapter_schemas").join("my_adapter.json")
353 );
354 }
355
356 #[test]
357 fn test_allow_exact_match() {
358 let manifest = ExtensionManifest {
359 capabilities: vec![ExtensionCapability::ProcessExec {
360 command: "ls".to_string(),
361 args: vec!["-la".to_string()],
362 }],
363 ..extension_manifest()
364 };
365
366 assert!(manifest.allow_exec("ls", &["-la"]).is_ok());
367 assert!(manifest.allow_exec("ls", &["-l"]).is_err());
368 assert!(manifest.allow_exec("pwd", &[] as &[&str]).is_err());
369 }
370
371 #[test]
372 fn test_allow_wildcard_arg() {
373 let manifest = ExtensionManifest {
374 capabilities: vec![ExtensionCapability::ProcessExec {
375 command: "git".to_string(),
376 args: vec!["*".to_string()],
377 }],
378 ..extension_manifest()
379 };
380
381 assert!(manifest.allow_exec("git", &["status"]).is_ok());
382 assert!(manifest.allow_exec("git", &["commit"]).is_ok());
383 assert!(manifest.allow_exec("git", &["status", "-s"]).is_err()); // too many args
384 assert!(manifest.allow_exec("npm", &["install"]).is_err()); // wrong command
385 }
386
387 #[test]
388 fn test_allow_double_wildcard() {
389 let manifest = ExtensionManifest {
390 capabilities: vec![ExtensionCapability::ProcessExec {
391 command: "cargo".to_string(),
392 args: vec!["test".to_string(), "**".to_string()],
393 }],
394 ..extension_manifest()
395 };
396
397 assert!(manifest.allow_exec("cargo", &["test"]).is_ok());
398 assert!(manifest.allow_exec("cargo", &["test", "--all"]).is_ok());
399 assert!(
400 manifest
401 .allow_exec("cargo", &["test", "--all", "--no-fail-fast"])
402 .is_ok()
403 );
404 assert!(manifest.allow_exec("cargo", &["build"]).is_err()); // wrong first arg
405 }
406
407 #[test]
408 fn test_allow_mixed_wildcards() {
409 let manifest = ExtensionManifest {
410 capabilities: vec![ExtensionCapability::ProcessExec {
411 command: "docker".to_string(),
412 args: vec!["run".to_string(), "*".to_string(), "**".to_string()],
413 }],
414 ..extension_manifest()
415 };
416
417 assert!(manifest.allow_exec("docker", &["run", "nginx"]).is_ok());
418 assert!(manifest.allow_exec("docker", &["run"]).is_err());
419 assert!(
420 manifest
421 .allow_exec("docker", &["run", "ubuntu", "bash"])
422 .is_ok()
423 );
424 assert!(
425 manifest
426 .allow_exec("docker", &["run", "alpine", "sh", "-c", "echo hello"])
427 .is_ok()
428 );
429 assert!(manifest.allow_exec("docker", &["ps"]).is_err()); // wrong first arg
430 }
431}