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, SelectionEffects,
11 display_map::ToDisplayPoint, 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!(
34 collab,
35 [
36 /// Copies a link to the current position in the channel buffer.
37 CopyLink
38 ]
39);
40
41pub fn init(cx: &mut App) {
42 workspace::FollowableViewRegistry::register::<ChannelView>(cx)
43}
44
45pub struct ChannelView {
46 pub editor: Entity<Editor>,
47 workspace: WeakEntity<Workspace>,
48 project: Entity<Project>,
49 channel_store: Entity<ChannelStore>,
50 channel_buffer: Entity<ChannelBuffer>,
51 remote_id: Option<ViewId>,
52 _editor_event_subscription: Subscription,
53 _reparse_subscription: Option<Subscription>,
54}
55
56impl ChannelView {
57 pub fn open(
58 channel_id: ChannelId,
59 link_position: Option<String>,
60 workspace: Entity<Workspace>,
61 window: &mut Window,
62 cx: &mut App,
63 ) -> Task<Result<Entity<Self>>> {
64 let pane = workspace.read(cx).active_pane().clone();
65 let channel_view = Self::open_in_pane(
66 channel_id,
67 link_position,
68 pane.clone(),
69 workspace,
70 window,
71 cx,
72 );
73 window.spawn(cx, async move |cx| {
74 let channel_view = channel_view.await?;
75 pane.update_in(cx, |pane, window, cx| {
76 telemetry::event!(
77 "Channel Notes Opened",
78 channel_id,
79 room_id = ActiveCall::global(cx)
80 .read(cx)
81 .room()
82 .map(|r| r.read(cx).id())
83 );
84 pane.add_item(Box::new(channel_view.clone()), true, true, None, window, cx);
85 })?;
86 anyhow::Ok(channel_view)
87 })
88 }
89
90 pub fn open_in_pane(
91 channel_id: ChannelId,
92 link_position: Option<String>,
93 pane: Entity<Pane>,
94 workspace: Entity<Workspace>,
95 window: &mut Window,
96 cx: &mut App,
97 ) -> Task<Result<Entity<Self>>> {
98 let channel_view = Self::load(channel_id, workspace, window, cx);
99 window.spawn(cx, async move |cx| {
100 let channel_view = channel_view.await?;
101
102 pane.update_in(cx, |pane, window, cx| {
103 let buffer_id = channel_view.read(cx).channel_buffer.read(cx).remote_id(cx);
104
105 let existing_view = pane
106 .items_of_type::<Self>()
107 .find(|view| view.read(cx).channel_buffer.read(cx).remote_id(cx) == buffer_id);
108
109 // If this channel buffer is already open in this pane, just return it.
110 if let Some(existing_view) = existing_view.clone()
111 && existing_view.read(cx).channel_buffer == channel_view.read(cx).channel_buffer
112 {
113 if let Some(link_position) = link_position {
114 existing_view.update(cx, |channel_view, cx| {
115 channel_view.focus_position_from_link(link_position, true, window, cx)
116 });
117 }
118 return existing_view;
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 && let Some(ix) = pane.index_for_item(&existing_item)
125 {
126 pane.close_item_by_id(existing_item.entity_id(), SaveIntent::Skip, window, cx)
127 .detach();
128 pane.add_item(
129 Box::new(channel_view.clone()),
130 true,
131 true,
132 Some(ix),
133 window,
134 cx,
135 );
136 }
137
138 if let Some(link_position) = link_position {
139 channel_view.update(cx, |channel_view, cx| {
140 channel_view.focus_position_from_link(link_position, true, window, cx)
141 });
142 }
143
144 channel_view
145 })
146 })
147 }
148
149 pub fn load(
150 channel_id: ChannelId,
151 workspace: Entity<Workspace>,
152 window: &mut Window,
153 cx: &mut App,
154 ) -> Task<Result<Entity<Self>>> {
155 let weak_workspace = workspace.downgrade();
156 let workspace = workspace.read(cx);
157 let project = workspace.project().to_owned();
158 let channel_store = ChannelStore::global(cx);
159 let language_registry = workspace.app_state().languages.clone();
160 let markdown = language_registry.language_for_name("Markdown");
161 let channel_buffer =
162 channel_store.update(cx, |store, cx| store.open_channel_buffer(channel_id, cx));
163
164 window.spawn(cx, async move |cx| {
165 let channel_buffer = channel_buffer.await?;
166 let markdown = markdown.await.log_err();
167
168 channel_buffer.update(cx, |channel_buffer, cx| {
169 channel_buffer.buffer().update(cx, |buffer, cx| {
170 buffer.set_language_registry(language_registry);
171 let Some(markdown) = markdown else {
172 return;
173 };
174 buffer.set_language(Some(markdown), cx);
175 })
176 })?;
177
178 cx.new_window_entity(|window, cx| {
179 let mut this = Self::new(
180 project,
181 weak_workspace,
182 channel_store,
183 channel_buffer,
184 window,
185 cx,
186 );
187 this.acknowledge_buffer_version(cx);
188 this
189 })
190 })
191 }
192
193 pub fn new(
194 project: Entity<Project>,
195 workspace: WeakEntity<Workspace>,
196 channel_store: Entity<ChannelStore>,
197 channel_buffer: Entity<ChannelBuffer>,
198 window: &mut Window,
199 cx: &mut Context<Self>,
200 ) -> Self {
201 let buffer = channel_buffer.read(cx).buffer();
202 let this = cx.entity().downgrade();
203 let editor = cx.new(|cx| {
204 let mut editor = Editor::for_buffer(buffer, None, window, cx);
205 editor.set_collaboration_hub(Box::new(ChannelBufferCollaborationHub(
206 channel_buffer.clone(),
207 )));
208 editor.set_custom_context_menu(move |_, position, window, cx| {
209 let this = this.clone();
210 Some(ui::ContextMenu::build(window, cx, move |menu, _, _| {
211 menu.entry("Copy link to section", None, move |window, cx| {
212 this.update(cx, |this, cx| {
213 this.copy_link_for_position(position, window, cx)
214 })
215 .ok();
216 })
217 }))
218 });
219 editor
220 });
221 let _editor_event_subscription =
222 cx.subscribe(&editor, |_, _, e: &EditorEvent, cx| cx.emit(e.clone()));
223
224 cx.subscribe_in(&channel_buffer, window, Self::handle_channel_buffer_event)
225 .detach();
226
227 Self {
228 editor,
229 workspace,
230 project,
231 channel_store,
232 channel_buffer,
233 remote_id: None,
234 _editor_event_subscription,
235 _reparse_subscription: None,
236 }
237 }
238
239 fn focus_position_from_link(
240 &mut self,
241 position: String,
242 first_attempt: bool,
243 window: &mut Window,
244 cx: &mut Context<Self>,
245 ) {
246 let position = Channel::slug(&position).to_lowercase();
247 let snapshot = self
248 .editor
249 .update(cx, |editor, cx| editor.snapshot(window, cx));
250
251 if let Some(outline) = snapshot.buffer_snapshot().outline(None)
252 && let Some(item) = outline
253 .items
254 .iter()
255 .find(|item| &Channel::slug(&item.text).to_lowercase() == &position)
256 {
257 self.editor.update(cx, |editor, cx| {
258 editor.change_selections(
259 SelectionEffects::scroll(Autoscroll::focused()),
260 window,
261 cx,
262 |s| s.replace_cursors_with(|map| vec![item.range.start.to_display_point(map)]),
263 )
264 });
265 return;
266 }
267
268 if !first_attempt {
269 return;
270 }
271 self._reparse_subscription = Some(cx.subscribe_in(
272 &self.editor,
273 window,
274 move |this, _, e: &EditorEvent, window, cx| {
275 match e {
276 EditorEvent::Reparsed(_) => {
277 this.focus_position_from_link(position.clone(), false, window, cx);
278 this._reparse_subscription.take();
279 }
280 EditorEvent::Edited { .. } | EditorEvent::SelectionsChanged { local: true } => {
281 this._reparse_subscription.take();
282 }
283 _ => {}
284 };
285 },
286 ));
287 }
288
289 fn copy_link(&mut self, _: &CopyLink, window: &mut Window, cx: &mut Context<Self>) {
290 let position = self.editor.update(cx, |editor, cx| {
291 editor
292 .selections
293 .newest_display(&editor.display_snapshot(cx))
294 .start
295 });
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::Connected => self.editor.update(cx, |editor, cx| {
358 editor.set_read_only(false);
359 cx.notify();
360 }),
361 ChannelBufferEvent::ChannelChanged => {
362 self.editor.update(cx, |_, cx| {
363 cx.emit(editor::EditorEvent::TitleChanged);
364 cx.notify()
365 });
366 }
367 ChannelBufferEvent::BufferEdited => {
368 if self.editor.read(cx).is_focused(window) {
369 self.acknowledge_buffer_version(cx);
370 } else {
371 self.channel_store.update(cx, |store, cx| {
372 let channel_buffer = self.channel_buffer.read(cx);
373 store.update_latest_notes_version(
374 channel_buffer.channel_id,
375 channel_buffer.epoch(),
376 &channel_buffer.buffer().read(cx).version(),
377 cx,
378 )
379 });
380 }
381 }
382 ChannelBufferEvent::CollaboratorsChanged => {}
383 }
384 }
385
386 fn acknowledge_buffer_version(&mut self, cx: &mut Context<ChannelView>) {
387 self.channel_store.update(cx, |store, cx| {
388 let channel_buffer = self.channel_buffer.read(cx);
389 store.acknowledge_notes_version(
390 channel_buffer.channel_id,
391 channel_buffer.epoch(),
392 &channel_buffer.buffer().read(cx).version(),
393 cx,
394 )
395 });
396 self.channel_buffer.update(cx, |buffer, cx| {
397 buffer.acknowledge_buffer_version(cx);
398 });
399 }
400
401 fn get_channel(&self, cx: &App) -> (SharedString, Option<SharedString>) {
402 if let Some(channel) = self.channel(cx) {
403 let status = match (
404 self.channel_buffer.read(cx).buffer().read(cx).read_only(),
405 self.channel_buffer.read(cx).is_connected(),
406 ) {
407 (false, true) => None,
408 (true, true) => Some("read-only"),
409 (_, false) => Some("disconnected"),
410 };
411
412 (channel.name.clone(), status.map(Into::into))
413 } else {
414 ("<unknown>".into(), Some("disconnected".into()))
415 }
416 }
417}
418
419impl EventEmitter<EditorEvent> for ChannelView {}
420
421impl Render for ChannelView {
422 fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
423 div()
424 .size_full()
425 .on_action(cx.listener(Self::copy_link))
426 .child(self.editor.clone())
427 }
428}
429
430impl Focusable for ChannelView {
431 fn focus_handle(&self, cx: &App) -> gpui::FocusHandle {
432 self.editor.read(cx).focus_handle(cx)
433 }
434}
435
436impl Item for ChannelView {
437 type Event = EditorEvent;
438
439 fn act_as_type<'a>(
440 &'a self,
441 type_id: TypeId,
442 self_handle: &'a Entity<Self>,
443 _: &'a App,
444 ) -> Option<AnyView> {
445 if type_id == TypeId::of::<Self>() {
446 Some(self_handle.to_any())
447 } else if type_id == TypeId::of::<Editor>() {
448 Some(self.editor.to_any())
449 } else {
450 None
451 }
452 }
453
454 fn tab_icon(&self, _: &Window, cx: &App) -> Option<Icon> {
455 let channel = self.channel(cx)?;
456 let icon = match channel.visibility {
457 ChannelVisibility::Public => IconName::Public,
458 ChannelVisibility::Members => IconName::Hash,
459 };
460
461 Some(Icon::new(icon))
462 }
463
464 fn tab_content_text(&self, _detail: usize, cx: &App) -> SharedString {
465 let (name, status) = self.get_channel(cx);
466 if let Some(status) = status {
467 format!("{name} - {status}").into()
468 } else {
469 name
470 }
471 }
472
473 fn tab_content(&self, params: TabContentParams, _: &Window, cx: &App) -> gpui::AnyElement {
474 let (name, status) = self.get_channel(cx);
475 h_flex()
476 .gap_2()
477 .child(
478 Label::new(name)
479 .color(params.text_color())
480 .when(params.preview, |this| this.italic()),
481 )
482 .when_some(status, |element, status| {
483 element.child(
484 Label::new(status)
485 .size(LabelSize::XSmall)
486 .color(Color::Muted),
487 )
488 })
489 .into_any_element()
490 }
491
492 fn telemetry_event_text(&self) -> Option<&'static str> {
493 None
494 }
495
496 fn clone_on_split(
497 &self,
498 _: Option<WorkspaceId>,
499 window: &mut Window,
500 cx: &mut Context<Self>,
501 ) -> Task<Option<Entity<Self>>> {
502 Task::ready(Some(cx.new(|cx| {
503 Self::new(
504 self.project.clone(),
505 self.workspace.clone(),
506 self.channel_store.clone(),
507 self.channel_buffer.clone(),
508 window,
509 cx,
510 )
511 })))
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}