Merge pull request #980 from npocccties/lti-deep-link

feat: LTI Deep Linking 2.0
npocccties · Sep 14, 2023 · 78460f9 · 78460f9
2 parents ddfc45d + 1d144f8
commit 78460f9
Show file tree

Hide file tree

Showing 73 changed files with 3,128 additions and 679 deletions.
diff --git a/components/atoms/AuthorFilter.tsx b/components/atoms/AuthorFilter.tsx
@@ -21,13 +21,15 @@ type Props = {
   sx?: SxProps;
   disabled?: boolean;
   onFilterChange?: (value: AuthorFilterType) => void;
+  row?: boolean | undefined;
 };
 
 function AuthorFilter({
   value = options[0].value,
   sx,
   disabled = false,
   onFilterChange,
+  row,
 }: Props) {
   const handleChange = useCallback(
     (event: React.ChangeEvent<HTMLInputElement>) => {
@@ -38,7 +40,7 @@ function AuthorFilter({
   return (
     <FormControl component="fieldset" sx={sx}>
       <FormLabel component="legend">作成者</FormLabel>
-      <RadioGroup value={value} onChange={handleChange}>
+      <RadioGroup value={value} onChange={handleChange} row={row}>
         {options.map(({ value, label }) => (
           <FormControlLabel
             key={value}

diff --git a/components/atoms/SharedFilter.tsx b/components/atoms/SharedFilter.tsx
@@ -21,13 +21,15 @@ type Props = {
   sx?: SxProps;
   disabled?: boolean;
   onFilterChange?: (value: SharedFilterType) => void;
+  row?: boolean | undefined;
 };
 
 function SharedFilter({
   value = options[2].value,
   sx,
   disabled = false,
   onFilterChange,
+  row,
 }: Props) {
   const handleChange = useCallback(
     (event: React.ChangeEvent<HTMLInputElement>) => {
@@ -38,7 +40,7 @@ function SharedFilter({
   return (
     <FormControl component="fieldset" sx={sx}>
       <FormLabel component="legend">共有</FormLabel>
-      <RadioGroup value={value} onChange={handleChange}>
+      <RadioGroup value={value} onChange={handleChange} row={row}>
         {options.map(({ value, label }) => (
           <FormControlLabel
             key={value}

diff --git a/components/organisms/AppBar.tsx b/components/organisms/AppBar.tsx
@@ -28,6 +28,7 @@ const useStyles = makeStyles((theme) => ({
   inner: {
     display: "flex",
     alignItems: "center",
+    justifyContent: "space-between",
     maxWidth: theme.breakpoints.values.lg,
     width: "100%",
     margin: "0 auto",
@@ -88,6 +89,7 @@ function AppBar(props: Props, ref: Ref<HTMLDivElement>) {
     onDashboardClick,
     ...others
   } = props;
+  const isDeepLink = !!session.ltiDlSettings?.deep_link_return_url;
   const appBarClasses = useAppBarStyles();
   const classes = useStyles();
   const [open, setOpen] = useState(false);
@@ -137,71 +139,75 @@ function AppBar(props: Props, ref: Ref<HTMLDivElement>) {
             alt="CHiBi-CHiLO"
             className={clsx(classes.margin, classes.logo)}
           />
-          <div className={classes.nav}>
-            <AppBarNavButton
-              color="inherit"
-              icon={<MenuBookOutlinedIcon />}
-              label="ブック"
-              onClick={onBooksClick}
-              disabled={!onBooksClick}
-            />
-            <AppBarNavButton
-              color="inherit"
-              icon={<LibraryBooksOutlinedIcon />}
-              label="トピック"
-              onClick={onTopicsClick}
-              disabled={!onTopicsClick}
-            />
-            <AppBarNavButton
-              color="inherit"
-              icon={<LinkIcon />}
-              label="リンク"
-              onClick={onCoursesClick}
-              disabled={!onCoursesClick}
-            />
-            <AppBarNavButton
-              color="inherit"
-              icon={<CellTowerIcon />}
-              label="配信中のブック"
-              onClick={onBookClick}
-              disabled={
-                !onBookClick ||
-                !Number.isFinite(session?.ltiResourceLink?.bookId)
-              }
-            />
-            {session?.systemSettings?.zoomImportEnabled && ( // TODO: zoomインポート以外の設定値が実装されたら常時表示する
+          {!isDeepLink && (
+            <div className={classes.nav}>
               <AppBarNavButton
                 color="inherit"
-                icon={<SettingsIcon />}
-                label="設定"
-                onClick={handleOpenUserSettings}
+                icon={<MenuBookOutlinedIcon />}
+                label="ブック"
+                onClick={onBooksClick}
+                disabled={!onBooksClick}
               />
-            )}
-            {onDashboardClick && (
               <AppBarNavButton
                 color="inherit"
-                icon={<AssessmentOutlinedIcon />}
-                label="学習分析"
-                onClick={onDashboardClick}
+                icon={<LibraryBooksOutlinedIcon />}
+                label="トピック"
+                onClick={onTopicsClick}
+                disabled={!onTopicsClick}
               />
-            )}
-          </div>
-          <div className={clsx(classes.user, classes.margin)}>
-            <p>{session.user.name}</p>
-            <p className={classes.roles}>{role(session)}</p>
-          </div>
-          {session && (
-            <>
-              <Button variant="text" color="primary" onClick={handleClick}>
-                LTI情報
-              </Button>
-              <LtiItemDialog
-                open={open}
-                onClose={handleClose}
-                session={session}
+              <AppBarNavButton
+                color="inherit"
+                icon={<LinkIcon />}
+                label="リンク"
+                onClick={onCoursesClick}
+                disabled={!onCoursesClick}
               />
-            </>
+              <AppBarNavButton
+                color="inherit"
+                icon={<CellTowerIcon />}
+                label="配信中のブック"
+                onClick={onBookClick}
+                disabled={
+                  !onBookClick ||
+                  !Number.isFinite(session?.ltiResourceLink?.bookId)
+                }
+              />
+              {session?.systemSettings?.zoomImportEnabled && ( // TODO: zoomインポート以外の設定値が実装されたら常時表示する
+                <AppBarNavButton
+                  color="inherit"
+                  icon={<SettingsIcon />}
+                  label="設定"
+                  onClick={handleOpenUserSettings}
+                />
+              )}
+              {onDashboardClick && (
+                <AppBarNavButton
+                  color="inherit"
+                  icon={<AssessmentOutlinedIcon />}
+                  label="学習分析"
+                  onClick={onDashboardClick}
+                />
+              )}
+            </div>
           )}
+          <div>
+            <div className={clsx(classes.user, classes.margin)}>
+              <p>{session.user.name}</p>
+              <p className={classes.roles}>{role(session)}</p>
+            </div>
+            {session && (
+              <>
+                <Button variant="text" color="primary" onClick={handleClick}>
+                  LTI情報
+                </Button>
+                <LtiItemDialog
+                  open={open}
+                  onClose={handleClose}
+                  session={session}
+                />
+              </>
+            )}
+          </div>
         </div>
       </Toolbar>
       <Snackbar

diff --git a/components/organisms/ContentPreview.tsx b/components/organisms/ContentPreview.tsx
@@ -124,6 +124,7 @@ type Props = Parameters<typeof Checkbox>[0] & {
   onKeywordClick(keyword: Pick<KeywordSchema, "name">): void;
   onRelatedBookClick?(id: RelatedBook): void;
   linked?: boolean;
+  isDeepLink?: boolean;
 };
 
 export default function ContentPreview({
@@ -135,6 +136,7 @@ export default function ContentPreview({
   onKeywordClick,
   onRelatedBookClick,
   linked = content.type === "book" ? false : undefined,
+  isDeepLink,
   checked,
   ...checkboxProps
 }: Props) {
@@ -177,7 +179,7 @@ export default function ContentPreview({
             />
           ))}
         {content.shared && <SharedIndicator className="shared" />}
-        {onContentEditClick && (
+        {!isDeepLink && onContentEditClick && (
           <EditButton
             className="edit-button"
             variant={content.type}
@@ -198,17 +200,27 @@ export default function ContentPreview({
         />
       </CardActionArea>
       <Box position="relative">
-        {linked !== undefined && onContentLinkClick && (
-          <LinkSwitch
-            sx={{
-              position: "absolute",
-              bottom: 0,
-              right: 0,
-              transform: "translateY(50%)",
-            }}
-            checked={linked}
-            onChange={handleContentLinkClick}
-          />
+        {content.type === "book" && linked !== undefined && (
+          <label
+            title={
+              onContentLinkClick
+                ? "リンクを切り替える"
+                : "ツールURLが指定されているため、リンクの切り替えはできません"
+            }
+          >
+            <LinkSwitch
+              sx={{
+                position: "absolute",
+                bottom: 0,
+                right: 0,
+                transform: "translateY(50%)",
+                filter: onContentLinkClick ? "none" : "grayscale(1)",
+              }}
+              disabled={!onContentLinkClick}
+              checked={linked}
+              onChange={handleContentLinkClick}
+            />
+          </label>
         )}
         {content.license && (
           <License

diff --git a/components/templates/BookEdit.tsx b/components/templates/BookEdit.tsx
@@ -15,6 +15,7 @@ import type { TopicSchema } from "$server/models/topic";
 import type { AuthorSchema } from "$server/models/author";
 import type { IsContentEditable } from "$server/models/content";
 import { useConfirm } from "material-ui-confirm";
+import { useSessionAtom } from "$store/session";
 import useDialogProps from "$utils/useDialogProps";
 
 const useStyles = makeStyles((theme) => ({
@@ -73,6 +74,7 @@ export default function BookEdit({
   isContentEditable,
   linked = false,
 }: Props) {
+  const { session } = useSessionAtom();
   const classes = useStyles();
   const confirm = useConfirm();
   const {
@@ -121,7 +123,7 @@ export default function BookEdit({
       <BookForm
         className={classes.content}
         book={book}
-        linked={linked}
+        linked={Boolean(session?.ltiTargetLinkUri || linked)}
         variant="update"
         onSubmit={onSubmit}
         onAuthorsUpdate={onAuthorsUpdate}

diff --git a/components/templates/BookNew.tsx b/components/templates/BookNew.tsx
@@ -49,7 +49,7 @@ export default function BookNew({
   onAuthorsUpdate,
   onAuthorSubmit,
 }: Props) {
-  const { isContentEditable } = useSessionAtom();
+  const { session, isContentEditable } = useSessionAtom();
   const forkFrom =
     book && !isContentEditable(book) && book.authors.length > 0 && book.authors;
   const defaultBook = book && {
@@ -87,6 +87,7 @@ export default function BookNew({
       <BookForm
         book={defaultBook}
         topics={topics}
+        linked={Boolean(session?.ltiTargetLinkUri)}
         variant="create"
         onSubmit={onSubmit}
         onAuthorsUpdate={onAuthorsUpdate}

diff --git a/components/templates/Books.tsx b/components/templates/Books.tsx
@@ -24,7 +24,7 @@ export type Props = {
   loading?: boolean;
   onContentPreviewClick(content: ContentSchema): void;
   onContentEditClick(content: ContentSchema): void;
-  onContentLinkClick(content: ContentSchema, checked: boolean): void;
+  onContentLinkClick?(content: ContentSchema, checked: boolean): void;
   onLinkedBookClick?(book: BookSchema): void;
   onBookNewClick(): void;
   onBooksImportClick(): void;

diff --git a/components/templates/DeepLInkBooks.stories.tsx b/components/templates/DeepLInkBooks.stories.tsx
@@ -0,0 +1,28 @@
+import type { Story } from "@storybook/react";
+import DeepLinkBooks from "./DeepLinkBooks";
+import { book, books } from "samples";
+
+export default {
+  title: "templates/DeepLinkBooks",
+  parameters: { layout: "fullscreen" },
+  component: DeepLinkBooks,
+};
+
+const linkedBook = { ...book, editable: true };
+
+const Template: Story<Parameters<typeof DeepLinkBooks>[0]> = (args) => (
+  <DeepLinkBooks {...args} />
+);
+
+export const Default = Template.bind({});
+Default.args = {
+  linkedBook,
+  totalCount: 123,
+  contents: books.map((book) => ({ type: "book", ...book })),
+};
+
+export const Empty = Template.bind({});
+Empty.args = {
+  totalCount: 0,
+  contents: [],
+};