channel_view.rs

  1use anyhow::Result;
  2use call::ActiveCall;
  3use channel::{Channel, ChannelBuffer, ChannelBufferEvent, ChannelStore};
  4use client::{
  5    ChannelId, Collaborator, ParticipantIndex,
  6    proto::{self, PeerId},
  7};
  8use collections::HashMap;
  9use editor::{
 10    CollaborationHub, DisplayPoint, Editor, EditorEvent, display_map::ToDisplayPoint,
 11    scroll::Autoscroll,
 12};
 13use gpui::{
 14    AnyView, App, ClipboardItem, Context, Entity, EventEmitter, Focusable, Pixels, Point, Render,
 15    Subscription, Task, VisualContext as _, WeakEntity, Window, actions,
 16};
 17use project::Project;
 18use rpc::proto::ChannelVisibility;
 19use std::{
 20    any::{Any, TypeId},
 21    sync::Arc,
 22};
 23use ui::prelude::*;
 24use util::ResultExt;
 25use workspace::{CollaboratorId, item::TabContentParams};
 26use workspace::{
 27    ItemNavHistory, Pane, SaveIntent, Toast, ViewId, Workspace, WorkspaceId,
 28    item::{FollowableItem, Item, ItemEvent, ItemHandle},
 29    searchable::SearchableItemHandle,
 30};
 31use workspace::{item::Dedup, notifications::NotificationId};
 32
 33actions!(collab, [CopyLink]);
 34
 35pub fn init(cx: &mut App) {
 36    workspace::FollowableViewRegistry::register::<ChannelView>(cx)
 37}
 38
 39pub struct ChannelView {
 40    pub editor: Entity<Editor>,
 41    workspace: WeakEntity<Workspace>,
 42    project: Entity<Project>,
 43    channel_store: Entity<ChannelStore>,
 44    channel_buffer: Entity<ChannelBuffer>,
 45    remote_id: Option<ViewId>,
 46    _editor_event_subscription: Subscription,
 47    _reparse_subscription: Option<Subscription>,
 48}
 49
 50impl ChannelView {
 51    pub fn open(
 52        channel_id: ChannelId,
 53        link_position: Option<String>,
 54        workspace: Entity<Workspace>,
 55        window: &mut Window,
 56        cx: &mut App,
 57    ) -> Task<Result<Entity<Self>>> {
 58        let pane = workspace.read(cx).active_pane().clone();
 59        let channel_view = Self::open_in_pane(
 60            channel_id,
 61            link_position,
 62            pane.clone(),
 63            workspace.clone(),
 64            window,
 65            cx,
 66        );
 67        window.spawn(cx, async move |cx| {
 68            let channel_view = channel_view.await?;
 69            pane.update_in(cx, |pane, window, cx| {
 70                telemetry::event!(
 71                    "Channel Notes Opened",
 72                    channel_id,
 73                    room_id = ActiveCall::global(cx)
 74                        .read(cx)
 75                        .room()
 76                        .map(|r| r.read(cx).id())
 77                );
 78                pane.add_item(Box::new(channel_view.clone()), true, true, None, window, cx);
 79            })?;
 80            anyhow::Ok(channel_view)
 81        })
 82    }
 83
 84    pub fn open_in_pane(
 85        channel_id: ChannelId,
 86        link_position: Option<String>,
 87        pane: Entity<Pane>,
 88        workspace: Entity<Workspace>,
 89        window: &mut Window,
 90        cx: &mut App,
 91    ) -> Task<Result<Entity<Self>>> {
 92        let channel_view = Self::load(channel_id, workspace, window, cx);
 93        window.spawn(cx, async move |cx| {
 94            let channel_view = channel_view.await?;
 95
 96            pane.update_in(cx, |pane, window, cx| {
 97                let buffer_id = channel_view.read(cx).channel_buffer.read(cx).remote_id(cx);
 98
 99                let existing_view = pane
100                    .items_of_type::<Self>()
101                    .find(|view| view.read(cx).channel_buffer.read(cx).remote_id(cx) == buffer_id);
102
103                // If this channel buffer is already open in this pane, just return it.
104                if let Some(existing_view) = existing_view.clone() {
105                    if existing_view.read(cx).channel_buffer == channel_view.read(cx).channel_buffer
106                    {
107                        if let Some(link_position) = link_position {
108                            existing_view.update(cx, |channel_view, cx| {
109                                channel_view.focus_position_from_link(
110                                    link_position,
111                                    true,
112                                    window,
113                                    cx,
114                                )
115                            });
116                        }
117                        return existing_view;
118                    }
119                }
120
121                // If the pane contained a disconnected view for this channel buffer,
122                // replace that.
123                if let Some(existing_item) = existing_view {
124                    if let Some(ix) = pane.index_for_item(&existing_item) {
125                        pane.close_item_by_id(
126                            existing_item.entity_id(),
127                            SaveIntent::Skip,
128                            window,
129                            cx,
130                        )
131                        .detach();
132                        pane.add_item(
133                            Box::new(channel_view.clone()),
134                            true,
135                            true,
136                            Some(ix),
137                            window,
138                            cx,
139                        );
140                    }
141                }
142
143                if let Some(link_position) = link_position {
144                    channel_view.update(cx, |channel_view, cx| {
145                        channel_view.focus_position_from_link(link_position, true, window, cx)
146                    });
147                }
148
149                channel_view
150            })
151        })
152    }
153
154    pub fn load(
155        channel_id: ChannelId,
156        workspace: Entity<Workspace>,
157        window: &mut Window,
158        cx: &mut App,
159    ) -> Task<Result<Entity<Self>>> {
160        let weak_workspace = workspace.downgrade();
161        let workspace = workspace.read(cx);
162        let project = workspace.project().to_owned();
163        let channel_store = ChannelStore::global(cx);
164        let language_registry = workspace.app_state().languages.clone();
165        let markdown = language_registry.language_for_name("Markdown");
166        let channel_buffer =
167            channel_store.update(cx, |store, cx| store.open_channel_buffer(channel_id, cx));
168
169        window.spawn(cx, async move |cx| {
170            let channel_buffer = channel_buffer.await?;
171            let markdown = markdown.await.log_err();
172
173            channel_buffer.update(cx, |channel_buffer, cx| {
174                channel_buffer.buffer().update(cx, |buffer, cx| {
175                    buffer.set_language_registry(language_registry);
176                    let Some(markdown) = markdown else {
177                        return;
178                    };
179                    buffer.set_language(Some(markdown), cx);
180                })
181            })?;
182
183            cx.new_window_entity(|window, cx| {
184                let mut this = Self::new(
185                    project,
186                    weak_workspace,
187                    channel_store,
188                    channel_buffer,
189                    window,
190                    cx,
191                );
192                this.acknowledge_buffer_version(cx);
193                this
194            })
195        })
196    }
197
198    pub fn new(
199        project: Entity<Project>,
200        workspace: WeakEntity<Workspace>,
201        channel_store: Entity<ChannelStore>,
202        channel_buffer: Entity<ChannelBuffer>,
203        window: &mut Window,
204        cx: &mut Context<Self>,
205    ) -> Self {
206        let buffer = channel_buffer.read(cx).buffer();
207        let this = cx.entity().downgrade();
208        let editor = cx.new(|cx| {
209            let mut editor = Editor::for_buffer(buffer, None, window, cx);
210            editor.set_collaboration_hub(Box::new(ChannelBufferCollaborationHub(
211                channel_buffer.clone(),
212            )));
213            editor.set_custom_context_menu(move |_, position, window, cx| {
214                let this = this.clone();
215                Some(ui::ContextMenu::build(window, cx, move |menu, _, _| {
216                    menu.entry("Copy link to section", None, move |window, cx| {
217                        this.update(cx, |this, cx| {
218                            this.copy_link_for_position(position, window, cx)
219                        })
220                        .ok();
221                    })
222                }))
223            });
224            editor
225        });
226        let _editor_event_subscription =
227            cx.subscribe(&editor, |_, _, e: &EditorEvent, cx| cx.emit(e.clone()));
228
229        cx.subscribe_in(&channel_buffer, window, Self::handle_channel_buffer_event)
230            .detach();
231
232        Self {
233            editor,
234            workspace,
235            project,
236            channel_store,
237            channel_buffer,
238            remote_id: None,
239            _editor_event_subscription,
240            _reparse_subscription: None,
241        }
242    }
243
244    fn focus_position_from_link(
245        &mut self,
246        position: String,
247        first_attempt: bool,
248        window: &mut Window,
249        cx: &mut Context<Self>,
250    ) {
251        let position = Channel::slug(&position).to_lowercase();
252        let snapshot = self
253            .editor
254            .update(cx, |editor, cx| editor.snapshot(window, cx));
255
256        if let Some(outline) = snapshot.buffer_snapshot.outline(None) {
257            if let Some(item) = outline
258                .items
259                .iter()
260                .find(|item| &Channel::slug(&item.text).to_lowercase() == &position)
261            {
262                self.editor.update(cx, |editor, cx| {
263                    editor.change_selections(Some(Autoscroll::focused()), window, cx, |s| {
264                        s.replace_cursors_with(|map| vec![item.range.start.to_display_point(map)])
265                    })
266                });
267                return;
268            }
269        }
270
271        if !first_attempt {
272            return;
273        }
274        self._reparse_subscription = Some(cx.subscribe_in(
275            &self.editor,
276            window,
277            move |this, _, e: &EditorEvent, window, cx| {
278                match e {
279                    EditorEvent::Reparsed(_) => {
280                        this.focus_position_from_link(position.clone(), false, window, cx);
281                        this._reparse_subscription.take();
282                    }
283                    EditorEvent::Edited { .. } | EditorEvent::SelectionsChanged { local: true } => {
284                        this._reparse_subscription.take();
285                    }
286                    _ => {}
287                };
288            },
289        ));
290    }
291
292    fn copy_link(&mut self, _: &CopyLink, window: &mut Window, cx: &mut Context<Self>) {
293        let position = self
294            .editor
295            .update(cx, |editor, cx| editor.selections.newest_display(cx).start);
296        self.copy_link_for_position(position, window, cx)
297    }
298
299    fn copy_link_for_position(
300        &self,
301        position: DisplayPoint,
302        window: &mut Window,
303        cx: &mut Context<Self>,
304    ) {
305        let snapshot = self
306            .editor
307            .update(cx, |editor, cx| editor.snapshot(window, cx));
308
309        let mut closest_heading = None;
310
311        if let Some(outline) = snapshot.buffer_snapshot.outline(None) {
312            for item in outline.items {
313                if item.range.start.to_display_point(&snapshot) > position {
314                    break;
315                }
316                closest_heading = Some(item);
317            }
318        }
319
320        let Some(channel) = self.channel(cx) else {
321            return;
322        };
323
324        let link = channel.notes_link(closest_heading.map(|heading| heading.text), cx);
325        cx.write_to_clipboard(ClipboardItem::new_string(link));
326        self.workspace
327            .update(cx, |workspace, cx| {
328                struct CopyLinkForPositionToast;
329
330                workspace.show_toast(
331                    Toast::new(
332                        NotificationId::unique::<CopyLinkForPositionToast>(),
333                        "Link copied to clipboard",
334                    ),
335                    cx,
336                );
337            })
338            .ok();
339    }
340
341    pub fn channel(&self, cx: &App) -> Option<Arc<Channel>> {
342        self.channel_buffer.read(cx).channel(cx)
343    }
344
345    fn handle_channel_buffer_event(
346        &mut self,
347        _: &Entity<ChannelBuffer>,
348        event: &ChannelBufferEvent,
349        window: &mut Window,
350        cx: &mut Context<Self>,
351    ) {
352        match event {
353            ChannelBufferEvent::Disconnected => self.editor.update(cx, |editor, cx| {
354                editor.set_read_only(true);
355                cx.notify();
356            }),
357            ChannelBufferEvent::ChannelChanged => {
358                self.editor.update(cx, |_, cx| {
359                    cx.emit(editor::EditorEvent::TitleChanged);
360                    cx.notify()
361                });
362            }
363            ChannelBufferEvent::BufferEdited => {
364                if self.editor.read(cx).is_focused(window) {
365                    self.acknowledge_buffer_version(cx);
366                } else {
367                    self.channel_store.update(cx, |store, cx| {
368                        let channel_buffer = self.channel_buffer.read(cx);
369                        store.update_latest_notes_version(
370                            channel_buffer.channel_id,
371                            channel_buffer.epoch(),
372                            &channel_buffer.buffer().read(cx).version(),
373                            cx,
374                        )
375                    });
376                }
377            }
378            ChannelBufferEvent::CollaboratorsChanged => {}
379        }
380    }
381
382    fn acknowledge_buffer_version(&mut self, cx: &mut Context<ChannelView>) {
383        self.channel_store.update(cx, |store, cx| {
384            let channel_buffer = self.channel_buffer.read(cx);
385            store.acknowledge_notes_version(
386                channel_buffer.channel_id,
387                channel_buffer.epoch(),
388                &channel_buffer.buffer().read(cx).version(),
389                cx,
390            )
391        });
392        self.channel_buffer.update(cx, |buffer, cx| {
393            buffer.acknowledge_buffer_version(cx);
394        });
395    }
396
397    fn get_channel(&self, cx: &App) -> (SharedString, Option<SharedString>) {
398        if let Some(channel) = self.channel(cx) {
399            let status = match (
400                self.channel_buffer.read(cx).buffer().read(cx).read_only(),
401                self.channel_buffer.read(cx).is_connected(),
402            ) {
403                (false, true) => None,
404                (true, true) => Some("read-only"),
405                (_, false) => Some("disconnected"),
406            };
407
408            (channel.name.clone(), status.map(Into::into))
409        } else {
410            ("<unknown>".into(), Some("disconnected".into()))
411        }
412    }
413}
414
415impl EventEmitter<EditorEvent> for ChannelView {}
416
417impl Render for ChannelView {
418    fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
419        div()
420            .size_full()
421            .on_action(cx.listener(Self::copy_link))
422            .child(self.editor.clone())
423    }
424}
425
426impl Focusable for ChannelView {
427    fn focus_handle(&self, cx: &App) -> gpui::FocusHandle {
428        self.editor.read(cx).focus_handle(cx)
429    }
430}
431
432impl Item for ChannelView {
433    type Event = EditorEvent;
434
435    fn act_as_type<'a>(
436        &'a self,
437        type_id: TypeId,
438        self_handle: &'a Entity<Self>,
439        _: &'a App,
440    ) -> Option<AnyView> {
441        if type_id == TypeId::of::<Self>() {
442            Some(self_handle.to_any())
443        } else if type_id == TypeId::of::<Editor>() {
444            Some(self.editor.to_any())
445        } else {
446            None
447        }
448    }
449
450    fn tab_icon(&self, _: &Window, cx: &App) -> Option<Icon> {
451        let channel = self.channel(cx)?;
452        let icon = match channel.visibility {
453            ChannelVisibility::Public => IconName::Public,
454            ChannelVisibility::Members => IconName::Hash,
455        };
456
457        Some(Icon::new(icon))
458    }
459
460    fn tab_content_text(&self, _detail: usize, cx: &App) -> SharedString {
461        let (name, status) = self.get_channel(cx);
462        if let Some(status) = status {
463            format!("{name} - {status}").into()
464        } else {
465            name
466        }
467    }
468
469    fn tab_content(&self, params: TabContentParams, _: &Window, cx: &App) -> gpui::AnyElement {
470        let (name, status) = self.get_channel(cx);
471        h_flex()
472            .gap_2()
473            .child(
474                Label::new(name)
475                    .color(params.text_color())
476                    .when(params.preview, |this| this.italic()),
477            )
478            .when_some(status, |element, status| {
479                element.child(
480                    Label::new(status)
481                        .size(LabelSize::XSmall)
482                        .color(Color::Muted),
483                )
484            })
485            .into_any_element()
486    }
487
488    fn telemetry_event_text(&self) -> Option<&'static str> {
489        None
490    }
491
492    fn clone_on_split(
493        &self,
494        _: Option<WorkspaceId>,
495        window: &mut Window,
496        cx: &mut Context<Self>,
497    ) -> Option<Entity<Self>> {
498        Some(cx.new(|cx| {
499            Self::new(
500                self.project.clone(),
501                self.workspace.clone(),
502                self.channel_store.clone(),
503                self.channel_buffer.clone(),
504                window,
505                cx,
506            )
507        }))
508    }
509
510    fn is_singleton(&self, _cx: &App) -> bool {
511        false
512    }
513
514    fn navigate(
515        &mut self,
516        data: Box<dyn Any>,
517        window: &mut Window,
518        cx: &mut Context<Self>,
519    ) -> bool {
520        self.editor
521            .update(cx, |editor, cx| editor.navigate(data, window, cx))
522    }
523
524    fn deactivated(&mut self, window: &mut Window, cx: &mut Context<Self>) {
525        self.editor
526            .update(cx, |item, cx| item.deactivated(window, cx))
527    }
528
529    fn set_nav_history(
530        &mut self,
531        history: ItemNavHistory,
532        window: &mut Window,
533        cx: &mut Context<Self>,
534    ) {
535        self.editor.update(cx, |editor, cx| {
536            Item::set_nav_history(editor, history, window, cx)
537        })
538    }
539
540    fn as_searchable(&self, _: &Entity<Self>) -> Option<Box<dyn SearchableItemHandle>> {
541        Some(Box::new(self.editor.clone()))
542    }
543
544    fn show_toolbar(&self) -> bool {
545        true
546    }
547
548    fn pixel_position_of_cursor(&self, cx: &App) -> Option<Point<Pixels>> {
549        self.editor.read(cx).pixel_position_of_cursor(cx)
550    }
551
552    fn to_item_events(event: &EditorEvent, f: impl FnMut(ItemEvent)) {
553        Editor::to_item_events(event, f)
554    }
555}
556
557impl FollowableItem for ChannelView {
558    fn remote_id(&self) -> Option<workspace::ViewId> {
559        self.remote_id
560    }
561
562    fn to_state_proto(&self, window: &Window, cx: &App) -> Option<proto::view::Variant> {
563        let channel_buffer = self.channel_buffer.read(cx);
564        if !channel_buffer.is_connected() {
565            return None;
566        }
567
568        Some(proto::view::Variant::ChannelView(
569            proto::view::ChannelView {
570                channel_id: channel_buffer.channel_id.0,
571                editor: if let Some(proto::view::Variant::Editor(proto)) =
572                    self.editor.read(cx).to_state_proto(window, cx)
573                {
574                    Some(proto)
575                } else {
576                    None
577                },
578            },
579        ))
580    }
581
582    fn from_state_proto(
583        workspace: Entity<workspace::Workspace>,
584        remote_id: workspace::ViewId,
585        state: &mut Option<proto::view::Variant>,
586        window: &mut Window,
587        cx: &mut App,
588    ) -> Option<gpui::Task<anyhow::Result<Entity<Self>>>> {
589        let Some(proto::view::Variant::ChannelView(_)) = state else {
590            return None;
591        };
592        let Some(proto::view::Variant::ChannelView(state)) = state.take() else {
593            unreachable!()
594        };
595
596        let open = ChannelView::load(ChannelId(state.channel_id), workspace, window, cx);
597
598        Some(window.spawn(cx, async move |cx| {
599            let this = open.await?;
600
601            let task = this.update_in(cx, |this, window, cx| {
602                this.remote_id = Some(remote_id);
603
604                if let Some(state) = state.editor {
605                    Some(this.editor.update(cx, |editor, cx| {
606                        editor.apply_update_proto(
607                            &this.project,
608                            proto::update_view::Variant::Editor(proto::update_view::Editor {
609                                selections: state.selections,
610                                pending_selection: state.pending_selection,
611                                scroll_top_anchor: state.scroll_top_anchor,
612                                scroll_x: state.scroll_x,
613                                scroll_y: state.scroll_y,
614                                ..Default::default()
615                            }),
616                            window,
617                            cx,
618                        )
619                    }))
620                } else {
621                    None
622                }
623            })?;
624
625            if let Some(task) = task {
626                task.await?;
627            }
628
629            Ok(this)
630        }))
631    }
632
633    fn add_event_to_update_proto(
634        &self,
635        event: &EditorEvent,
636        update: &mut Option<proto::update_view::Variant>,
637        window: &Window,
638        cx: &App,
639    ) -> bool {
640        self.editor
641            .read(cx)
642            .add_event_to_update_proto(event, update, window, cx)
643    }
644
645    fn apply_update_proto(
646        &mut self,
647        project: &Entity<Project>,
648        message: proto::update_view::Variant,
649        window: &mut Window,
650        cx: &mut Context<Self>,
651    ) -> gpui::Task<anyhow::Result<()>> {
652        self.editor.update(cx, |editor, cx| {
653            editor.apply_update_proto(project, message, window, cx)
654        })
655    }
656
657    fn set_leader_id(
658        &mut self,
659        leader_id: Option<CollaboratorId>,
660        window: &mut Window,
661        cx: &mut Context<Self>,
662    ) {
663        self.editor
664            .update(cx, |editor, cx| editor.set_leader_id(leader_id, window, cx))
665    }
666
667    fn is_project_item(&self, _window: &Window, _cx: &App) -> bool {
668        false
669    }
670
671    fn to_follow_event(event: &Self::Event) -> Option<workspace::item::FollowEvent> {
672        Editor::to_follow_event(event)
673    }
674
675    fn dedup(&self, existing: &Self, _: &Window, cx: &App) -> Option<Dedup> {
676        let existing = existing.channel_buffer.read(cx);
677        if self.channel_buffer.read(cx).channel_id == existing.channel_id {
678            if existing.is_connected() {
679                Some(Dedup::KeepExisting)
680            } else {
681                Some(Dedup::ReplaceExisting)
682            }
683        } else {
684            None
685        }
686    }
687}
688
689struct ChannelBufferCollaborationHub(Entity<ChannelBuffer>);
690
691impl CollaborationHub for ChannelBufferCollaborationHub {
692    fn collaborators<'a>(&self, cx: &'a App) -> &'a HashMap<PeerId, Collaborator> {
693        self.0.read(cx).collaborators()
694    }
695
696    fn user_participant_indices<'a>(&self, cx: &'a App) -> &'a HashMap<u64, ParticipantIndex> {
697        self.0.read(cx).user_store().read(cx).participant_indices()
698    }
699
700    fn user_names(&self, cx: &App) -> HashMap<u64, SharedString> {
701        let user_ids = self.collaborators(cx).values().map(|c| c.user_id);
702        self.0
703            .read(cx)
704            .user_store()
705            .read(cx)
706            .participant_names(user_ids, cx)
707    }
708}