Skip to content

DeepTutor: Lifelong Personalized Tutoring. https://deeptutor.info/.

26.6 KB
Raw Blame
"use client";

import {
  BookmarkCheck,
  ChevronDown,
  ChevronRight,
  Highlighter,
  ListTree,
  Loader2,
  Search,
  Trash2,
  X,
} from "lucide-react";
import { useMemo, useState } from "react";
import { useTranslation } from "react-i18next";
import { useReading } from "@/context/ReadingContext";
import {
  type AnnotationItem,
  type OutlineRow,
  type ReadingBookmark,
  type UnitReference,
} from "@/lib/reading-api";
import {
  type OutlineNode,
  type ReaderHeading,
  buildOutlineTree,
  filterOutlineNodes,
  filterReaderHeadings,
} from "@/lib/reading-outline";
import {
  type ReadingLibraryMaterial,
  type ReadingWorkspaceTab,
} from "@/lib/reading-workspace-api";
import { formatMediaTime, timeFromSourceHref } from "@/lib/reading-media-time";
import Tooltip from "@/shared/ui/Tooltip";
import { AnnotationList } from "../AnnotationList";
import { iconForMaterial } from "./WorkspaceChrome";
import { type TranscriptRow } from "./types";

export function SourceNavigator({
  material,
  materials,
  activeMaterialId,
  onSelectMaterial,
  onRemoveMaterial,
  outline,
  pageHeadings,
  activeHeadingId,
  onNavigateHeading,
  refs,
  transcript,
  transcriptUnavailable,
  chaptersOnly,
  search,
  onSearch,
  activeLocator,
  annotationCount,
  unitCount,
  open,
  onClose,
  onNavigate,
  bookmarks,
  onRemoveBookmark,
  onOpenAnnotation,
}: {
  material: ReadingLibraryMaterial | null;
  materials: ReadingWorkspaceTab[];
  activeMaterialId: string | null;
  onSelectMaterial: (material: ReadingLibraryMaterial) => void;
  onRemoveMaterial: (material: ReadingLibraryMaterial) => void;
  outline: OutlineRow[];
  pageHeadings: ReaderHeading[];
  activeHeadingId: string | null;
  onNavigateHeading: (heading: ReaderHeading) => void;
  refs: UnitReference[];
  transcript: TranscriptRow[];
  transcriptUnavailable: boolean;
  chaptersOnly: boolean;
  search: string;
  onSearch: (value: string) => void;
  activeLocator: number;
  annotationCount: number;
  unitCount: number;
  open: boolean;
  onClose: () => void;
  onNavigate: (locator: number, quote?: string) => void;
  /** Places the reader kept, listed above the outline. */
  bookmarks: ReadingBookmark[];
  onRemoveBookmark: (bookmarkId: string) => void;
  /**
   * Scroll the document to a mark. Separate from `onNavigate` because a
   * transcript row's quote becomes the companion's quoted context, and
   * opening a highlight should not quietly change what the next question is
   * about.
   */
  onOpenAnnotation?: (locator: number, quote?: string) => void;
}) {
  const { t } = useTranslation();
  // The document's marks, listed here rather than in a column of the reader:
  // beside the navigator and the companion, a fourth column left the page
  // itself the narrowest thing on screen.
  const reading = useReading();
  const [view, setView] = useState<"contents" | "notes">("contents");
  const [activeAnnotationId, setActiveAnnotationId] = useState<string | null>(
    null,
  );
  const notesAvailable = Boolean(onOpenAnnotation) && !mediaSourceOf(material);
  const showNotes = notesAvailable && view === "notes";
  const openAnnotation = (annotation: AnnotationItem) => {
    setActiveAnnotationId(annotation.annotation_id);
    onOpenAnnotation?.(annotation.locator, annotation.quote || undefined);
  };
  const [collapsedNodes, setCollapsedNodes] = useState<Set<string>>(new Set());
  const [collapsedMaterials, setCollapsedMaterials] = useState<Set<string>>(
    new Set(),
  );
  const mediaSource = mediaSourceOf(material);
  const isPdf = material?.render_mode === "pdf";
  const reliableOutline = isPdf
    ? outline.filter((row) => !row.synthesised)
    : outline;
  const pageFallback = isPdf && reliableOutline.length === 0 && unitCount > 0;
  const documentOutline: OutlineRow[] = pageFallback
    ? Array.from({ length: unitCount }, (_, index) => ({
        locator: index + 1,
        title: t("Page {{page}}", { page: index + 1 }),
        level: 1,
        synthesised: false,
      }))
    : reliableOutline;
  const documentTree = useMemo(
    () => filterOutlineNodes(buildOutlineTree(documentOutline), search),
    [documentOutline, search],
  );
  const activeDocumentRow = documentOutline.reduce<OutlineRow | null>(
    (active, row) => (row.locator <= activeLocator ? row : active),
    null,
  );
  const outlineRows = outline.length
    ? outline.map((row) => ({
        locator: row.locator,
        title: chaptersOnly
          ? formatMediaTime(
              timeFromSourceHref(
                refs.find((ref) => ref.locator === row.locator)?.source_href ||
                  "",
              ) || 0,
            )
          : refs.find((ref) => ref.locator === row.locator)?.title ||
            String(row.locator).padStart(2, "0"),
        text: row.title,
        sourceHref:
          refs.find((ref) => ref.locator === row.locator)?.source_href || "",
      }))
    : refs.map((row) => ({
        locator: row.locator,
        title: String(row.locator).padStart(2, "0"),
        text: row.title || "",
        sourceHref: row.source_href,
      }));
  const rows = transcriptUnavailable
    ? chaptersOnly
      ? outlineRows.filter((row) =>
          `${row.title} ${row.text}`
            .toLowerCase()
            .includes(search.toLowerCase()),
        )
      : []
    : transcript.length
      ? transcript.filter((row) =>
          `${row.title} ${row.text}`
            .toLowerCase()
            .includes(search.toLowerCase()),
        )
      : outlineRows;

  // A server document outline owns the tree. Local page headings are only a
  // fallback for sources that cannot provide one, so Markdown sources do not
  // show the same structure twice.
  const visibleHeadings = useMemo(
    () =>
      mediaSource || documentOutline.length > 0
        ? []
        : filterReaderHeadings(pageHeadings, search),
    [documentOutline.length, mediaSource, pageHeadings, search],
  );
  const query = search.trim().toLowerCase();
  const activeContentMatches = mediaSource
    ? rows.length > 0
    : documentTree.length > 0 || visibleHeadings.length > 0;
  const visibleMaterials = query
    ? materials.filter(
        ({ material: candidate }) =>
          candidate.title.toLowerCase().includes(query) ||
          candidate.filename.toLowerCase().includes(query) ||
          (candidate.material_id === activeMaterialId && activeContentMatches),
      )
    : materials;

  const selectMaterial = (candidate: ReadingLibraryMaterial) => {
    onSelectMaterial(candidate);
    setCollapsedMaterials((current) => {
      if (!current.has(candidate.material_id)) return current;
      const next = new Set(current);
      next.delete(candidate.material_id);
      return next;
    });
  };

  return (
    <aside
      className={`dt-reading-navigator min-h-0 min-w-0 flex-col bg-[var(--background)] ${
        open
          ? "absolute inset-y-0 left-0 z-30 flex w-[min(300px,88vw)] shadow-[18px_0_42px_rgba(0,0,0,.12)] lg:static lg:row-start-2 lg:w-auto lg:shadow-none"
          : "hidden"
      }`}
    >
      <div className="flex h-11 shrink-0 items-center gap-1 px-2">
        {notesAvailable ? (
          <div role="tablist" className="flex min-w-0 flex-1 items-center gap-0.5">
            <NavigatorTab
              active={!showNotes}
              icon={ListTree}
              label={t("Contents")}
              onClick={() => setView("contents")}
            />
            <NavigatorTab
              active={showNotes}
              icon={Highlighter}
              label={t("Annotations")}
              count={annotationCount}
              onClick={() => setView("notes")}
            />
          </div>
        ) : (
          <p className="flex min-w-0 flex-1 items-center gap-2 truncate px-1 text-[12px] font-semibold">
            <ListTree size={13} className="shrink-0 text-[var(--primary)]" />
            {t("Contents")}
          </p>
        )}
        <button
          type="button"
          onClick={onClose}
          className="flex size-7 shrink-0 items-center justify-center rounded-md text-[var(--muted-foreground)] hover:bg-[var(--muted)]"
          aria-label={t("Close contents")}
        >
          <X size={13} />
        </button>
      </div>

      {showNotes && material ? (
        <div className="min-h-0 flex-1">
          <AnnotationList
            annotations={reading.annotations}
            unit={reading.material?.unit ?? "page"}
            activeId={activeAnnotationId}
            onSelect={openAnnotation}
            onDelete={(annotation) => void reading.removeMark(annotation)}
          />
        </div>
      ) : (
        <>
          <label className="mx-2 mt-1 flex h-8 shrink-0 items-center gap-2 rounded-lg bg-[rgb(var(--dt-ink,55_53_47)/0.045)] px-2.5 focus-within:bg-[rgb(var(--dt-ink,55_53_47)/0.06)]">
            <Search size={12} className="text-[var(--muted-foreground)]" />
            <input
              value={search}
              onChange={(event) => onSearch(event.target.value)}
              placeholder={t("Search materials and contents")}
              className="min-w-0 flex-1 bg-transparent text-[12px] outline-none"
            />
          </label>

          <div className="mt-2 min-h-0 flex-1 overflow-y-auto px-2 pb-3">
            {bookmarks.length > 0 && (
              /* The reader's own short index, in front of the document's long
                 one. Above rather than below because it is the shorter list and
                 the one they came here for — scrolling past 74 outline rows to
                 reach three saved places would defeat the point. */
              <div className="mb-2 pb-1">
                <p className="flex items-center gap-1.5 px-2 py-1 text-[10.5px] font-semibold uppercase tracking-wide text-[var(--muted-foreground)]">
                  <BookmarkCheck size={11} className="text-[var(--primary)]" />
                  {t("Bookmarks")}
                  <span className="tabular-nums opacity-70">
                    {bookmarks.length}
                  </span>
                </p>
                {bookmarks.map((row) => (
                  <div
                    key={row.bookmark_id}
                    className={`group flex items-center gap-1 rounded-lg transition ${
                      activeLocator === row.locator
                        ? "bg-[color-mix(in_srgb,var(--primary)_10%,transparent)] text-[var(--primary)]"
                        : "text-[var(--foreground)] hover:bg-[var(--muted)]"
                    }`}
                  >
                    <button
                      type="button"
                      onClick={() => onNavigate(row.locator)}
                      className="flex min-w-0 flex-1 items-baseline gap-2 px-2 py-1.5 text-left"
                    >
                      <span className="w-7 shrink-0 text-right text-[11px] tabular-nums text-[var(--muted-foreground)]">
                        {row.locator}
                      </span>
                      {/* A bookmark saved without a label is "this page", so it
                          borrows the outline's own heading for that locator
                          rather than making the reader name a place before they
                          are allowed to keep it. */}
                      <span className="line-clamp-2 min-w-0 text-[12px] leading-[1.5]">
                        {row.label ||
                          outline.find((entry) => entry.locator === row.locator)
                            ?.title ||
                          t("p. {{page}}", { page: row.locator })}
                      </span>
                    </button>
                    <button
                      type="button"
                      onClick={() => onRemoveBookmark(row.bookmark_id)}
                      aria-label={t("Remove this bookmark")}
                      className="mr-1 shrink-0 rounded-md p-1 text-[var(--muted-foreground)] opacity-0 transition hover:bg-[var(--accent)] hover:text-[var(--foreground)] focus-visible:opacity-100 group-hover:opacity-100"
                    >
                      <Trash2 size={11} />
                    </button>
                  </div>
                ))}
              </div>
            )}
            {visibleMaterials.length === 0 ? (
              <div className="px-2 py-4 text-[11.5px] leading-relaxed text-[var(--muted-foreground)]">
                {query ? (
                  <p>{t("No matching materials or contents.")}</p>
                ) : mediaSource && transcriptUnavailable ? (
                  <>
                    <p className="font-medium text-[var(--muted-foreground)]">
                      {t("No transcript available")}
                    </p>
                    <p className="mt-1">
                      {t(
                        "Playback still works. Transcript-grounded explanation and timestamp search are unavailable for this video.",
                      )}
                    </p>
                  </>
                ) : (
                  <p>
                    {material?.status === "ready"
                      ? t("This material has no outline to navigate yet.")
                      : t("The outline appears once processing finishes.")}
                  </p>
                )}
              </div>
            ) : (
              <ul>
                {visibleMaterials.map(({ material: candidate }) => {
                  const active = candidate.material_id === activeMaterialId;
                  const MaterialIcon = iconForMaterial(candidate);
                  const busy =
                    candidate.status === "processing" ||
                    candidate.status === "queued";
                  const expanded =
                    active && !collapsedMaterials.has(candidate.material_id);

                  return (
                    <li key={candidate.material_id} className="mb-1">
                      <div
                        className={`flex items-center gap-1 rounded-lg transition ${
                          active
                            ? "bg-[color-mix(in_srgb,var(--primary)_10%,transparent)] text-[var(--primary)]"
                            : "text-[var(--foreground)] hover:bg-[var(--muted)]"
                        }`}
                      >
                        <button
                          type="button"
                          onClick={() => selectMaterial(candidate)}
                          aria-current={active ? "true" : undefined}
                          className="flex min-w-0 flex-1 items-center gap-2 px-2 py-2 text-left"
                        >
                          {busy ? (
                            <Loader2 size={12} className="shrink-0 animate-spin" />
                          ) : (
                            <MaterialIcon size={12} className="shrink-0" />
                          )}
                          <span className="line-clamp-2 min-w-0 text-[12.5px] font-medium leading-[1.35]">
                            {candidate.title || candidate.filename}
                          </span>
                        </button>
                        {active && (
                          <button
                            type="button"
                            onClick={() =>
                              setCollapsedMaterials((current) => {
                                const next = new Set(current);
                                if (next.has(candidate.material_id))
                                  next.delete(candidate.material_id);
                                else next.add(candidate.material_id);
                                return next;
                              })
                            }
                            className="mr-1 shrink-0 rounded-md p-1 text-[var(--muted-foreground)] hover:bg-[var(--accent)] hover:text-[var(--foreground)]"
                            aria-expanded={expanded}
                            aria-label={
                              expanded
                                ? t("Collapse section")
                                : t("Expand section")
                            }
                          >
                            {expanded ? (
                              <ChevronDown size={11} />
                            ) : (
                              <ChevronRight size={11} />
                            )}
                          </button>
                        )}
                        <Tooltip label={t("Remove from collection")}>
                          <button
                            type="button"
                            onClick={() => onRemoveMaterial(candidate)}
                            className="mr-1 shrink-0 rounded-md p-1 text-[var(--muted-foreground)] transition hover:bg-[var(--muted)] hover:text-[var(--destructive)]"
                            aria-label={t("Remove from collection")}
                          >
                            <X size={10} />
                          </button>
                        </Tooltip>
                      </div>

                      {expanded && (
                        <div className="ml-2 mt-0.5 border-l border-[rgb(var(--dt-ink,55_53_47)/0.08)] pl-1">
                          {mediaSource ? (
                            rows.map((row) => (
                              <button
                                key={row.locator}
                                type="button"
                                onClick={() =>
                                  onNavigate(
                                    row.locator,
                                    !chaptersOnly && transcript.length
                                      ? row.text
                                      : undefined,
                                  )
                                }
                                className={`mb-0.5 flex w-full gap-2 rounded-lg px-2 py-2 text-left transition ${
                                  activeLocator === row.locator
                                    ? "bg-[var(--muted)] text-[var(--primary)]"
                                    : "text-[var(--muted-foreground)] hover:bg-[var(--muted)]"
                                }`}
                              >
                                <span className="mt-0.5 w-10 shrink-0 text-[11px] font-medium tabular-nums text-[var(--primary)]">
                                  {row.title || row.locator}
                                </span>
                                <span className="line-clamp-3 text-[12px] leading-[1.45]">
                                  {row.text}
                                </span>
                              </button>
                            ))
                          ) : documentOutline.length > 0 ? (
                            <WorkspaceOutlineBranch
                              nodes={documentTree}
                              activeRow={activeDocumentRow}
                              pageFallback={pageFallback}
                              collapsedNodes={search ? new Set() : collapsedNodes}
                              onNavigateHeading={onNavigateHeading}
                              showLocator={isPdf}
                              onToggle={(key) =>
                                setCollapsedNodes((current) => {
                                  const next = new Set(current);
                                  if (next.has(key)) next.delete(key);
                                  else next.add(key);
                                  return next;
                                })
                              }
                              onNavigate={onNavigate}
                            />
                          ) : (
                            visibleHeadings.map((heading) => (
                              <span
                                key={heading.id}
                                className="block w-full [&>span]:w-full [&>span>button]:w-full"
                              >
                                <Tooltip label={heading.title}>
                                  <button
                                    type="button"
                                    onClick={() => onNavigateHeading(heading)}
                                    style={{
                                      paddingLeft: `${
                                        10 + (Math.min(heading.level, 4) - 1) * 10
                                      }px`,
                                    }}
                                    className={`mb-0.5 block w-full truncate rounded-lg py-1.5 pr-2 text-left text-[12px] leading-[1.4] transition ${
                                      activeHeadingId === heading.id
                                        ? "bg-[var(--muted)] font-medium text-[var(--primary)]"
                                        : "text-[var(--muted-foreground)] hover:bg-[var(--muted)] hover:text-[var(--foreground)]"
                                    }`}
                                  >
                                    {heading.title}
                                  </button>
                                </Tooltip>
                              </span>
                            ))
                          )}
                        </div>
                      )}
                    </li>
                  );
                })}
              </ul>
            )}
          </div>

          <div className="shrink-0 px-3 py-2 text-[11px] text-[var(--muted-foreground)]">
            {material && material.status === "ready"
              ? mediaSource
                ? t("{{count}} passages available to the companion", {
                    count: rows.length,
                  })
                : pageFallback
                  ? t("{{count}} pages", { count: documentOutline.length })
                  : t("{{count}} outline entries", {
                      count: documentOutline.length,
                    })
              : t(material?.status || "queued")}
          </div>
        </>
      )}
    </aside>
  );
}

function mediaSourceOf(material: ReadingLibraryMaterial | null) {
  return (
    material?.render_mode === "video" ||
    material?.render_mode === "audio" ||
    material?.source_kind === "youtube" ||
    material?.source_kind === "bilibili"
  );
}

function NavigatorTab({
  active,
  icon: Icon,
  label,
  count,
  onClick,
}: {
  active: boolean;
  icon: typeof ListTree;
  label: string;
  count?: number;
  onClick: () => void;
}) {
  return (
    <button
      type="button"
      role="tab"
      aria-selected={active}
      onClick={onClick}
      className={`inline-flex h-7 min-w-0 items-center gap-1.5 rounded-md px-2 text-[12px] font-medium transition ${
        active
          ? "bg-[var(--muted)] text-[var(--foreground)]"
          : "text-[var(--muted-foreground)] hover:bg-[var(--muted)] hover:text-[var(--foreground)]"
      }`}
    >
      <Icon
        size={12}
        className={active ? "shrink-0 text-[var(--primary)]" : "shrink-0"}
      />
      <span className="truncate">{label}</span>
      {count ? (
        <span className="rounded-full bg-[var(--background)] px-1.5 text-[10.5px] tabular-nums text-[var(--muted-foreground)]">
          {count}
        </span>
      ) : null}
    </button>
  );
}

export function WorkspaceOutlineBranch({
  nodes,
  activeRow,
  pageFallback,
  collapsedNodes,
  onNavigateHeading,
  onToggle,
  onNavigate,
  showLocator,
  depth = 0,
}: {
  nodes: OutlineNode[];
  activeRow: OutlineRow | null;
  pageFallback: boolean;
  collapsedNodes: Set<string>;
  onNavigateHeading: (heading: ReaderHeading) => void;
  onToggle: (key: string) => void;
  onNavigate: (locator: number) => void;
  showLocator: boolean;
  depth?: number;
}) {
  const { t } = useTranslation();
  return (
    <ul className={depth ? "ml-2 border-l border-[rgb(var(--dt-ink,55_53_47)/0.08)] pl-1" : ""}>
      {nodes.map((node) => {
        const key = `${node.row.locator}-${node.row.title}`;
        const active = node.row === activeRow;
        const collapsed = collapsedNodes.has(key);
        const hasAnchor = Boolean(node.row.source_href && node.row.source_anchor);
        const outlineButton = (
          <button
            type="button"
            onClick={() => {
              if (hasAnchor) {
                onNavigateHeading({
                  id: node.row.source_anchor ?? "",
                  title: node.row.title,
                  level: node.row.level,
                  locator: node.row.locator,
                  sourceHref: node.row.source_href,
                });
                return;
              }
              onNavigate(node.row.locator);
            }}
            className="flex min-w-0 flex-1 items-baseline gap-2 px-2 py-1.5 text-left"
          >
            {showLocator && (
              <span className="w-7 shrink-0 text-right text-[11px] tabular-nums text-[var(--muted-foreground)]">
                {node.row.locator}
              </span>
            )}
            <span className="line-clamp-3 min-w-0 text-[12px] leading-[1.5]">
              {node.row.title}
            </span>
          </button>
        );
        return (
          <li key={key} className="mb-0.5 min-w-0">
            <div
              className={`group flex items-center gap-1 rounded-lg transition ${
                active
                  ? "bg-[color-mix(in_srgb,var(--primary)_10%,transparent)] text-[var(--primary)]"
                  : "text-[var(--foreground)] hover:bg-[var(--muted)]"
              }`}
            >
              <span className="inline-flex min-w-0 flex-1 [&>span]:w-full [&>span>button]:w-full">
                {showLocator ? (
                  <Tooltip label={t("p. {{page}}", { page: node.row.locator })}>
                    {outlineButton}
                  </Tooltip>
                ) : (
                  outlineButton
                )}
              </span>
              {node.children.length > 0 && (
                <button
                  type="button"
                  onClick={() => onToggle(key)}
                  aria-expanded={!collapsed}
                  aria-label={
                    collapsed ? t("Expand section") : t("Collapse section")
                  }
                  className="mr-1 shrink-0 rounded-md p-1 text-[var(--muted-foreground)] hover:bg-[var(--accent)] hover:text-[var(--foreground)]"
                >
                  {collapsed ? <ChevronRight size={11} /> : <ChevronDown size={11} />}
                </button>
              )}
            </div>
            {node.children.length > 0 && !collapsed && (
              <WorkspaceOutlineBranch
                nodes={node.children}
                activeRow={activeRow}
                pageFallback={pageFallback}
                collapsedNodes={collapsedNodes}
                onToggle={onToggle}
                onNavigate={onNavigate}
                onNavigateHeading={onNavigateHeading}
                showLocator={showLocator}
                depth={depth + 1}
              />
            )}
          </li>
        );
      })}
    </ul>
  );
}