1use anyhow::{anyhow, bail, Context as _, Result};
2use async_compression::futures::bufread::GzipDecoder;
3use async_tar::Archive;
4use client::ClientSettings;
5use collections::{BTreeMap, HashSet};
6use fs::{Fs, RemoveOptions};
7use futures::channel::mpsc::unbounded;
8use futures::StreamExt as _;
9use futures::{io::BufReader, AsyncReadExt as _};
10use gpui::{actions, AppContext, Context, Global, Model, ModelContext, Task};
11use language::{
12 LanguageConfig, LanguageMatcher, LanguageQueries, LanguageRegistry, QUERY_FILENAME_PREFIXES,
13};
14use parking_lot::RwLock;
15use serde::{Deserialize, Serialize};
16use settings::Settings as _;
17use std::cmp::Ordering;
18use std::{
19 ffi::OsStr,
20 path::{Path, PathBuf},
21 sync::Arc,
22 time::Duration,
23};
24use theme::{ThemeRegistry, ThemeSettings};
25use util::http::AsyncBody;
26use util::TryFutureExt;
27use util::{http::HttpClient, paths::EXTENSIONS_DIR, ResultExt};
28
29#[cfg(test)]
30mod extension_store_test;
31
32#[derive(Deserialize)]
33pub struct ExtensionsApiResponse {
34 pub data: Vec<Extension>,
35}
36
37#[derive(Deserialize)]
38pub struct Extension {
39 pub id: Arc<str>,
40 pub version: Arc<str>,
41 pub name: String,
42 pub description: Option<String>,
43 pub authors: Vec<String>,
44 pub repository: String,
45 pub download_count: usize,
46}
47
48#[derive(Clone)]
49pub enum ExtensionStatus {
50 NotInstalled,
51 Installing,
52 Upgrading,
53 Installed(Arc<str>),
54 Removing,
55}
56
57pub struct ExtensionStore {
58 manifest: Arc<RwLock<Manifest>>,
59 fs: Arc<dyn Fs>,
60 http_client: Arc<dyn HttpClient>,
61 extensions_dir: PathBuf,
62 extensions_being_installed: HashSet<Arc<str>>,
63 extensions_being_uninstalled: HashSet<Arc<str>>,
64 manifest_path: PathBuf,
65 language_registry: Arc<LanguageRegistry>,
66 theme_registry: Arc<ThemeRegistry>,
67 extension_changes: ExtensionChanges,
68 reload_task: Option<Task<Option<()>>>,
69 needs_reload: bool,
70 _watch_extensions_dir: [Task<()>; 2],
71}
72
73struct GlobalExtensionStore(Model<ExtensionStore>);
74
75impl Global for GlobalExtensionStore {}
76
77#[derive(Debug, Deserialize, Serialize, Default)]
78pub struct Manifest {
79 pub extensions: BTreeMap<Arc<str>, Arc<str>>,
80 pub grammars: BTreeMap<Arc<str>, GrammarManifestEntry>,
81 pub languages: BTreeMap<Arc<str>, LanguageManifestEntry>,
82 pub themes: BTreeMap<Arc<str>, ThemeManifestEntry>,
83}
84
85#[derive(PartialEq, Eq, Debug, PartialOrd, Ord, Deserialize, Serialize)]
86pub struct GrammarManifestEntry {
87 extension: String,
88 path: PathBuf,
89}
90
91#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Deserialize, Serialize)]
92pub struct LanguageManifestEntry {
93 extension: String,
94 path: PathBuf,
95 matcher: LanguageMatcher,
96 grammar: Option<Arc<str>>,
97}
98
99#[derive(Clone, PartialEq, Debug, Deserialize, Serialize)]
100pub struct ThemeManifestEntry {
101 extension: String,
102 path: PathBuf,
103}
104
105#[derive(Default)]
106struct ExtensionChanges {
107 languages: HashSet<Arc<str>>,
108 grammars: HashSet<Arc<str>>,
109 themes: HashSet<Arc<str>>,
110}
111
112actions!(zed, [ReloadExtensions]);
113
114pub fn init(
115 fs: Arc<fs::RealFs>,
116 http_client: Arc<dyn HttpClient>,
117 language_registry: Arc<LanguageRegistry>,
118 theme_registry: Arc<ThemeRegistry>,
119 cx: &mut AppContext,
120) {
121 let store = cx.new_model(|cx| {
122 ExtensionStore::new(
123 EXTENSIONS_DIR.clone(),
124 fs.clone(),
125 http_client.clone(),
126 language_registry.clone(),
127 theme_registry,
128 cx,
129 )
130 });
131
132 cx.on_action(|_: &ReloadExtensions, cx| {
133 let store = cx.global::<GlobalExtensionStore>().0.clone();
134 store.update(cx, |store, cx| store.reload(cx))
135 });
136
137 cx.set_global(GlobalExtensionStore(store));
138}
139
140impl ExtensionStore {
141 pub fn global(cx: &AppContext) -> Model<Self> {
142 cx.global::<GlobalExtensionStore>().0.clone()
143 }
144
145 pub fn new(
146 extensions_dir: PathBuf,
147 fs: Arc<dyn Fs>,
148 http_client: Arc<dyn HttpClient>,
149 language_registry: Arc<LanguageRegistry>,
150 theme_registry: Arc<ThemeRegistry>,
151 cx: &mut ModelContext<Self>,
152 ) -> Self {
153 let mut this = Self {
154 manifest: Default::default(),
155 extensions_dir: extensions_dir.join("installed"),
156 manifest_path: extensions_dir.join("manifest.json"),
157 extensions_being_installed: Default::default(),
158 extensions_being_uninstalled: Default::default(),
159 reload_task: None,
160 needs_reload: false,
161 extension_changes: ExtensionChanges::default(),
162 fs,
163 http_client,
164 language_registry,
165 theme_registry,
166 _watch_extensions_dir: [Task::ready(()), Task::ready(())],
167 };
168 this._watch_extensions_dir = this.watch_extensions_dir(cx);
169 this.load(cx);
170 this
171 }
172
173 pub fn load(&mut self, cx: &mut ModelContext<Self>) {
174 let (manifest_content, manifest_metadata, extensions_metadata) =
175 cx.background_executor().block(async {
176 futures::join!(
177 self.fs.load(&self.manifest_path),
178 self.fs.metadata(&self.manifest_path),
179 self.fs.metadata(&self.extensions_dir),
180 )
181 });
182
183 if let Some(manifest_content) = manifest_content.log_err() {
184 if let Some(manifest) = serde_json::from_str(&manifest_content).log_err() {
185 self.manifest_updated(manifest, cx);
186 }
187 }
188
189 let should_reload = if let (Ok(Some(manifest_metadata)), Ok(Some(extensions_metadata))) =
190 (manifest_metadata, extensions_metadata)
191 {
192 extensions_metadata.mtime > manifest_metadata.mtime
193 } else {
194 true
195 };
196
197 if should_reload {
198 self.reload(cx)
199 }
200 }
201
202 pub fn extensions_dir(&self) -> PathBuf {
203 self.extensions_dir.clone()
204 }
205
206 pub fn extension_status(&self, extension_id: &str) -> ExtensionStatus {
207 let is_uninstalling = self.extensions_being_uninstalled.contains(extension_id);
208 if is_uninstalling {
209 return ExtensionStatus::Removing;
210 }
211
212 let installed_version = self.manifest.read().extensions.get(extension_id).cloned();
213 let is_installing = self.extensions_being_installed.contains(extension_id);
214 match (installed_version, is_installing) {
215 (Some(_), true) => ExtensionStatus::Upgrading,
216 (Some(version), false) => ExtensionStatus::Installed(version.clone()),
217 (None, true) => ExtensionStatus::Installing,
218 (None, false) => ExtensionStatus::NotInstalled,
219 }
220 }
221
222 pub fn fetch_extensions(
223 &self,
224 search: Option<&str>,
225 cx: &mut ModelContext<Self>,
226 ) -> Task<Result<Vec<Extension>>> {
227 let url = format!(
228 "{}/{}{query}",
229 ClientSettings::get_global(cx).server_url,
230 "api/extensions",
231 query = search
232 .map(|search| format!("?filter={search}"))
233 .unwrap_or_default()
234 );
235 let http_client = self.http_client.clone();
236 cx.spawn(move |_, _| async move {
237 let mut response = http_client.get(&url, AsyncBody::empty(), true).await?;
238
239 let mut body = Vec::new();
240 response
241 .body_mut()
242 .read_to_end(&mut body)
243 .await
244 .context("error reading extensions")?;
245
246 if response.status().is_client_error() {
247 let text = String::from_utf8_lossy(body.as_slice());
248 bail!(
249 "status error {}, response: {text:?}",
250 response.status().as_u16()
251 );
252 }
253
254 let response: ExtensionsApiResponse = serde_json::from_slice(&body)?;
255
256 Ok(response.data)
257 })
258 }
259
260 pub fn install_extension(
261 &mut self,
262 extension_id: Arc<str>,
263 version: Arc<str>,
264 cx: &mut ModelContext<Self>,
265 ) {
266 log::info!("installing extension {extension_id} {version}");
267 let url = format!(
268 "{}/api/extensions/{extension_id}/{version}/download",
269 ClientSettings::get_global(cx).server_url
270 );
271
272 let extensions_dir = self.extensions_dir();
273 let http_client = self.http_client.clone();
274
275 self.extensions_being_installed.insert(extension_id.clone());
276
277 cx.spawn(move |this, mut cx| async move {
278 let mut response = http_client
279 .get(&url, Default::default(), true)
280 .await
281 .map_err(|err| anyhow!("error downloading extension: {}", err))?;
282 let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut()));
283 let archive = Archive::new(decompressed_bytes);
284 archive
285 .unpack(extensions_dir.join(extension_id.as_ref()))
286 .await?;
287
288 this.update(&mut cx, |this, cx| {
289 this.extensions_being_installed
290 .remove(extension_id.as_ref());
291 this.reload(cx)
292 })
293 })
294 .detach_and_log_err(cx);
295 }
296
297 pub fn uninstall_extension(&mut self, extension_id: Arc<str>, cx: &mut ModelContext<Self>) {
298 let extensions_dir = self.extensions_dir();
299 let fs = self.fs.clone();
300
301 self.extensions_being_uninstalled
302 .insert(extension_id.clone());
303
304 cx.spawn(move |this, mut cx| async move {
305 fs.remove_dir(
306 &extensions_dir.join(extension_id.as_ref()),
307 RemoveOptions {
308 recursive: true,
309 ignore_if_not_exists: true,
310 },
311 )
312 .await?;
313
314 this.update(&mut cx, |this, cx| {
315 this.extensions_being_uninstalled
316 .remove(extension_id.as_ref());
317 this.reload(cx)
318 })
319 })
320 .detach_and_log_err(cx)
321 }
322
323 /// Updates the set of installed extensions.
324 ///
325 /// First, this unloads any themes, languages, or grammars that are
326 /// no longer in the manifest, or whose files have changed on disk.
327 /// Then it loads any themes, languages, or grammars that are newly
328 /// added to the manifest, or whose files have changed on disk.
329 fn manifest_updated(&mut self, manifest: Manifest, cx: &mut ModelContext<Self>) {
330 fn diff<'a, T, I1, I2>(
331 old_keys: I1,
332 new_keys: I2,
333 modified_keys: &HashSet<Arc<str>>,
334 ) -> (Vec<Arc<str>>, Vec<Arc<str>>)
335 where
336 T: PartialEq,
337 I1: Iterator<Item = (&'a Arc<str>, T)>,
338 I2: Iterator<Item = (&'a Arc<str>, T)>,
339 {
340 let mut removed_keys = Vec::default();
341 let mut added_keys = Vec::default();
342 let mut old_keys = old_keys.peekable();
343 let mut new_keys = new_keys.peekable();
344 loop {
345 match (old_keys.peek(), new_keys.peek()) {
346 (None, None) => return (removed_keys, added_keys),
347 (None, Some(_)) => {
348 added_keys.push(new_keys.next().unwrap().0.clone());
349 }
350 (Some(_), None) => {
351 removed_keys.push(old_keys.next().unwrap().0.clone());
352 }
353 (Some((old_key, _)), Some((new_key, _))) => match old_key.cmp(&new_key) {
354 Ordering::Equal => {
355 let (old_key, old_value) = old_keys.next().unwrap();
356 let (new_key, new_value) = new_keys.next().unwrap();
357 if old_value != new_value || modified_keys.contains(old_key) {
358 removed_keys.push(old_key.clone());
359 added_keys.push(new_key.clone());
360 }
361 }
362 Ordering::Less => {
363 removed_keys.push(old_keys.next().unwrap().0.clone());
364 }
365 Ordering::Greater => {
366 added_keys.push(new_keys.next().unwrap().0.clone());
367 }
368 },
369 }
370 }
371 }
372
373 let old_manifest = self.manifest.read();
374 let (languages_to_remove, languages_to_add) = diff(
375 old_manifest.languages.iter(),
376 manifest.languages.iter(),
377 &self.extension_changes.languages,
378 );
379 let (grammars_to_remove, grammars_to_add) = diff(
380 old_manifest.grammars.iter(),
381 manifest.grammars.iter(),
382 &self.extension_changes.grammars,
383 );
384 let (themes_to_remove, themes_to_add) = diff(
385 old_manifest.themes.iter(),
386 manifest.themes.iter(),
387 &self.extension_changes.themes,
388 );
389 self.extension_changes.clear();
390 drop(old_manifest);
391
392 let themes_to_remove = &themes_to_remove
393 .into_iter()
394 .map(|theme| theme.into())
395 .collect::<Vec<_>>();
396 self.theme_registry.remove_user_themes(&themes_to_remove);
397 self.language_registry
398 .remove_languages(&languages_to_remove, &grammars_to_remove);
399
400 self.language_registry
401 .register_wasm_grammars(grammars_to_add.iter().map(|grammar_name| {
402 let grammar = manifest.grammars.get(grammar_name).unwrap();
403 let mut grammar_path = self.extensions_dir.clone();
404 grammar_path.extend([grammar.extension.as_ref(), grammar.path.as_path()]);
405 (grammar_name.clone(), grammar_path)
406 }));
407
408 for language_name in &languages_to_add {
409 let language = manifest.languages.get(language_name.as_ref()).unwrap();
410 let mut language_path = self.extensions_dir.clone();
411 language_path.extend([language.extension.as_ref(), language.path.as_path()]);
412 self.language_registry.register_language(
413 language_name.clone(),
414 language.grammar.clone(),
415 language.matcher.clone(),
416 vec![],
417 move || {
418 let config = std::fs::read_to_string(language_path.join("config.toml"))?;
419 let config: LanguageConfig = ::toml::from_str(&config)?;
420 let queries = load_plugin_queries(&language_path);
421 Ok((config, queries))
422 },
423 );
424 }
425
426 let (reload_theme_tx, mut reload_theme_rx) = unbounded();
427 let fs = self.fs.clone();
428 let root_dir = self.extensions_dir.clone();
429 let theme_registry = self.theme_registry.clone();
430 let themes = themes_to_add
431 .iter()
432 .filter_map(|name| manifest.themes.get(name).cloned())
433 .collect::<Vec<_>>();
434 cx.background_executor()
435 .spawn(async move {
436 for theme in &themes {
437 let mut theme_path = root_dir.clone();
438 theme_path.extend([theme.extension.as_ref(), theme.path.as_path()]);
439
440 theme_registry
441 .load_user_theme(&theme_path, fs.clone())
442 .await
443 .log_err();
444 }
445
446 reload_theme_tx.unbounded_send(()).ok();
447 })
448 .detach();
449
450 cx.spawn(|_, cx| async move {
451 while let Some(_) = reload_theme_rx.next().await {
452 if cx
453 .update(|cx| ThemeSettings::reload_current_theme(cx))
454 .is_err()
455 {
456 break;
457 }
458 }
459 })
460 .detach();
461
462 *self.manifest.write() = manifest;
463 cx.notify();
464 }
465
466 fn watch_extensions_dir(&self, cx: &mut ModelContext<Self>) -> [Task<()>; 2] {
467 let manifest = self.manifest.clone();
468 let fs = self.fs.clone();
469 let extensions_dir = self.extensions_dir.clone();
470
471 let (changes_tx, mut changes_rx) = unbounded();
472
473 let events_task = cx.background_executor().spawn(async move {
474 let mut events = fs.watch(&extensions_dir, Duration::from_millis(250)).await;
475 while let Some(events) = events.next().await {
476 let mut changed_grammars = HashSet::default();
477 let mut changed_languages = HashSet::default();
478 let mut changed_themes = HashSet::default();
479
480 {
481 let manifest = manifest.read();
482 for event in events {
483 for (grammar_name, grammar) in &manifest.grammars {
484 let mut grammar_path = extensions_dir.clone();
485 grammar_path
486 .extend([grammar.extension.as_ref(), grammar.path.as_path()]);
487 if event.path.starts_with(&grammar_path) || event.path == grammar_path {
488 changed_grammars.insert(grammar_name.clone());
489 }
490 }
491
492 for (language_name, language) in &manifest.languages {
493 let mut language_path = extensions_dir.clone();
494 language_path
495 .extend([language.extension.as_ref(), language.path.as_path()]);
496 if event.path.starts_with(&language_path) || event.path == language_path
497 {
498 changed_languages.insert(language_name.clone());
499 }
500 }
501
502 for (theme_name, theme) in &manifest.themes {
503 let mut theme_path = extensions_dir.clone();
504 theme_path.extend([theme.extension.as_ref(), theme.path.as_path()]);
505 if event.path.starts_with(&theme_path) || event.path == theme_path {
506 changed_themes.insert(theme_name.clone());
507 }
508 }
509 }
510 }
511
512 changes_tx
513 .unbounded_send(ExtensionChanges {
514 languages: changed_languages,
515 grammars: changed_grammars,
516 themes: changed_themes,
517 })
518 .ok();
519 }
520 });
521
522 let reload_task = cx.spawn(|this, mut cx| async move {
523 while let Some(changes) = changes_rx.next().await {
524 if this
525 .update(&mut cx, |this, cx| {
526 this.extension_changes.merge(changes);
527 this.reload(cx);
528 })
529 .is_err()
530 {
531 break;
532 }
533 }
534 });
535
536 [events_task, reload_task]
537 }
538
539 fn reload(&mut self, cx: &mut ModelContext<Self>) {
540 if self.reload_task.is_some() {
541 self.needs_reload = true;
542 return;
543 }
544
545 let fs = self.fs.clone();
546 let extensions_dir = self.extensions_dir.clone();
547 let manifest_path = self.manifest_path.clone();
548 self.needs_reload = false;
549 self.reload_task = Some(cx.spawn(|this, mut cx| {
550 async move {
551 let manifest = cx
552 .background_executor()
553 .spawn(async move {
554 let mut manifest = Manifest::default();
555
556 fs.create_dir(&extensions_dir).await.log_err();
557
558 let extension_paths = fs.read_dir(&extensions_dir).await;
559 if let Ok(mut extension_paths) = extension_paths {
560 while let Some(extension_dir) = extension_paths.next().await {
561 let Ok(extension_dir) = extension_dir else {
562 continue;
563 };
564 Self::add_extension_to_manifest(
565 fs.clone(),
566 extension_dir,
567 &mut manifest,
568 )
569 .await
570 .log_err();
571 }
572 }
573
574 if let Ok(manifest_json) = serde_json::to_string_pretty(&manifest) {
575 fs.save(
576 &manifest_path,
577 &manifest_json.as_str().into(),
578 Default::default(),
579 )
580 .await
581 .context("failed to save extension manifest")
582 .log_err();
583 }
584
585 manifest
586 })
587 .await;
588
589 this.update(&mut cx, |this, cx| {
590 this.manifest_updated(manifest, cx);
591 this.reload_task.take();
592 if this.needs_reload {
593 this.reload(cx);
594 }
595 })
596 }
597 .log_err()
598 }));
599 }
600
601 async fn add_extension_to_manifest(
602 fs: Arc<dyn Fs>,
603 extension_dir: PathBuf,
604 manifest: &mut Manifest,
605 ) -> Result<()> {
606 let extension_name = extension_dir
607 .file_name()
608 .and_then(OsStr::to_str)
609 .ok_or_else(|| anyhow!("invalid extension name"))?;
610
611 #[derive(Deserialize)]
612 struct ExtensionJson {
613 pub version: String,
614 }
615
616 let extension_json_path = extension_dir.join("extension.json");
617 let extension_json = fs
618 .load(&extension_json_path)
619 .await
620 .context("failed to load extension.json")?;
621 let extension_json: ExtensionJson =
622 serde_json::from_str(&extension_json).context("invalid extension.json")?;
623
624 manifest
625 .extensions
626 .insert(extension_name.into(), extension_json.version.into());
627
628 if let Ok(mut grammar_paths) = fs.read_dir(&extension_dir.join("grammars")).await {
629 while let Some(grammar_path) = grammar_paths.next().await {
630 let grammar_path = grammar_path?;
631 let Ok(relative_path) = grammar_path.strip_prefix(&extension_dir) else {
632 continue;
633 };
634 let Some(grammar_name) = grammar_path.file_stem().and_then(OsStr::to_str) else {
635 continue;
636 };
637
638 manifest.grammars.insert(
639 grammar_name.into(),
640 GrammarManifestEntry {
641 extension: extension_name.into(),
642 path: relative_path.into(),
643 },
644 );
645 }
646 }
647
648 if let Ok(mut language_paths) = fs.read_dir(&extension_dir.join("languages")).await {
649 while let Some(language_path) = language_paths.next().await {
650 let language_path = language_path?;
651 let Ok(relative_path) = language_path.strip_prefix(&extension_dir) else {
652 continue;
653 };
654 let Ok(Some(fs_metadata)) = fs.metadata(&language_path).await else {
655 continue;
656 };
657 if !fs_metadata.is_dir {
658 continue;
659 }
660 let config = fs.load(&language_path.join("config.toml")).await?;
661 let config = ::toml::from_str::<LanguageConfig>(&config)?;
662
663 manifest.languages.insert(
664 config.name.clone(),
665 LanguageManifestEntry {
666 extension: extension_name.into(),
667 path: relative_path.into(),
668 matcher: config.matcher,
669 grammar: config.grammar,
670 },
671 );
672 }
673 }
674
675 if let Ok(mut theme_paths) = fs.read_dir(&extension_dir.join("themes")).await {
676 while let Some(theme_path) = theme_paths.next().await {
677 let theme_path = theme_path?;
678 let Ok(relative_path) = theme_path.strip_prefix(&extension_dir) else {
679 continue;
680 };
681
682 let Some(theme_family) = ThemeRegistry::read_user_theme(&theme_path, fs.clone())
683 .await
684 .log_err()
685 else {
686 continue;
687 };
688
689 for theme in theme_family.themes {
690 let location = ThemeManifestEntry {
691 extension: extension_name.into(),
692 path: relative_path.into(),
693 };
694
695 manifest.themes.insert(theme.name.into(), location);
696 }
697 }
698 }
699
700 Ok(())
701 }
702}
703
704impl ExtensionChanges {
705 fn clear(&mut self) {
706 self.grammars.clear();
707 self.languages.clear();
708 self.themes.clear();
709 }
710
711 fn merge(&mut self, other: Self) {
712 self.grammars.extend(other.grammars);
713 self.languages.extend(other.languages);
714 self.themes.extend(other.themes);
715 }
716}
717
718fn load_plugin_queries(root_path: &Path) -> LanguageQueries {
719 let mut result = LanguageQueries::default();
720 if let Some(entries) = std::fs::read_dir(root_path).log_err() {
721 for entry in entries {
722 let Some(entry) = entry.log_err() else {
723 continue;
724 };
725 let path = entry.path();
726 if let Some(remainder) = path.strip_prefix(root_path).ok().and_then(|p| p.to_str()) {
727 if !remainder.ends_with(".scm") {
728 continue;
729 }
730 for (name, query) in QUERY_FILENAME_PREFIXES {
731 if remainder.starts_with(name) {
732 if let Some(contents) = std::fs::read_to_string(&path).log_err() {
733 match query(&mut result) {
734 None => *query(&mut result) = Some(contents.into()),
735 Some(r) => r.to_mut().push_str(contents.as_ref()),
736 }
737 }
738 break;
739 }
740 }
741 }
742 }
743 }
744 result
745}