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