Merge pull request #226 from janezd/require-chapter-progress

Implement locking chapters before answering all questions in earlier chapters

Author: janezd

api/book.ts

@@ -1,7 +1,7 @@
 "use server";
 
 import db from "@/utils/db";
-import { BookFrontmatter, ChapterDef, LinkDesc } from "@/types";
+import { BookFrontmatter, ChapterDef, LinkDesc, UnlockChaptersOnAnswersOptions } from "@/types";
 import { getPublicLink, GroupList, ItemDesc } from "@/api/content";
 import { getCollection } from "@/api/collection";
 
@@ -104,6 +104,7 @@ export const getBook = async (id: number): Promise<BookProps> => {
     frontmatter: {
       title: book.title, subTitle: book.subtitle,
       requireLogin: book.requireLogin === 1, quizThreshold: book.quizThreshold,
+      unlockChaptersOnAnswers: UnlockChaptersOnAnswersOptions[book.unlockChaptersOnAnswers],
       public: book.public === 1, coverImg: book.coverImg,
       groups,
       tocInHeader: book.tocInHeader === 1, language: book.language,

components/Book/Book.tsx

@@ -10,9 +10,9 @@ import { BookProps, getPublicCollection } from "@/api/book";
 import { isAdminFor } from "@/api/user";
 
 import { logger } from "@/utils/logger";
-import { getT, IntlContextProvider } from "@/i18n";
+import { getT, IntlContextProvider, useIntl } from "@/i18n";
 import { UserContext } from "@/context/UserContextProvider";
-import { AnswerState, QuizContextProvider } from "@/context/QuizContextProvider";
+import { AnswerState, QuizContext, QuizContextProvider } from "@/context/QuizContextProvider";
 import Layout from "../Layout/Layout";
 
 import Login from "../Login";
@@ -22,9 +22,51 @@ import { Chapter } from "./Chapter";
 import { SidenoteContext } from "@/components/Book/Sidenote";
 import { useHasMounted } from "@/hooks/useHasMounted";
 import { usePublicProvider } from "@/hooks/usePublicProvider";
-import { LinkDesc } from "@/types";
+import { ChapterDef, LinkDesc, UnlockChaptersOnAnswersType } from "@/types";
 
 
+const Chapters = ({chapters: allChapters, bookId, chapterNumbers, unlockChaptersOnAnswers, setIsChapterIndexVisible, allAnswers}:
+  {chapters: ChapterDef[],
+    bookId: number,
+    chapterNumbers: Record<number, number>,
+    unlockChaptersOnAnswers: UnlockChaptersOnAnswersType,
+    setIsChapterIndexVisible: React.Dispatch<React.SetStateAction<Record<number, boolean>>>,
+    allAnswers?: AnswersInBook}
+) => {
+  const {chapterStats} = useContext(QuizContext);
+  const {t} = useIntl();
+  const chapters = [];
+  for(let index = 0; index < allChapters.length; index++) {
+      chapters.push(allChapters[index]);
+      const stats = chapterStats(index);
+      if (unlockChaptersOnAnswers !== "none"
+          && stats
+          && stats.nQuestions != (unlockChaptersOnAnswers === "attempt" ? stats.answered : stats.correct)) {
+        break;
+      }
+    }
+  return <>
+    {chapters.map((chapterDef, index) => (
+      <Chapter
+        {...chapterDef}
+        bookId={bookId}
+        chapterId={chapterDef.chapterId}
+        key={chapterDef.chapterPath}
+        index={index}
+        setIsChapterIndexVisible={setIsChapterIndexVisible}
+        chapterNumber={chapterNumbers[index]}
+        allAnswers={allAnswers}
+      />
+    ))}
+    { allChapters.length !== chapters.length &&
+      <div className="chapter locked">
+        <h2>{t("book.locked-chapter")}</h2>
+        <p>{t(`book.locked-chapter-msg-${unlockChaptersOnAnswers}`)}</p>
+      </div>
+    }
+  </>
+}
+
 export const Book = (
   { frontmatter, content, chapters, slug, bookId, previous, next }: BookProps
 ) => {
@@ -274,18 +316,14 @@ export const Book = (
               />
             }
 
-            {chapters.map((chapterDef, index) => (
-              <Chapter
-                {...chapterDef}
-                bookId={bookId}
-                chapterId={chapterDef.chapterId}
-                key={chapterDef.chapterPath}
-                index={index}
-                setIsChapterIndexVisible={setIsChapterIndexVisible}
-                chapterNumber={chapterNumbers[index]}
-                allAnswers={showAnswers && allAnswers || undefined}
+            <Chapters
+              chapters={chapters}
+              bookId={bookId}
+              chapterNumbers={chapterNumbers}
+              unlockChaptersOnAnswers={frontmatter.unlockChaptersOnAnswers}
+              setIsChapterIndexVisible={setIsChapterIndexVisible}
+              allAnswers={showAnswers && allAnswers || undefined}
               />
-            ))}
             { !!next && <a href={next.href} className="next-book-link">
               {t("book.next-in-collection")}{next.title}</a>
               }

i18n/dict.tsx

@@ -24,6 +24,9 @@ const dict: {[lang: string]: {[key: string]: any}} = {
     "collections": "Book Collections",
     "book.chapter": "Chapter",
     "book.chapters": "Chapters",
+    "book.locked-chapter": "(Locked chapters)",
+    "book.locked-chapter-msg-attempt": "The rest of the book will be unlocked when you attempt all shown questions",
+    "book.locked-chapter-msg-correct": "The rest of the book will be unlocked when you correctly answer all shown questions",
     "book.next-in-collection": "Next book in this collection: ",
     "chapter.replay": "Replay",
     "chapter.showanswer": "Show Answer",
@@ -129,6 +132,9 @@ const dict: {[lang: string]: {[key: string]: any}} = {
     "collections": "Zbirke knjig",
     "book.chapter": "Poglavje",
     "book.chapters": "Poglavja",
+    "book.locked-chapter": "(Skrita poglavja)",
+    "book.locked-chapter-msg-attempt": "Ostanek knjige bo prikazan, ko poskusite odgovoriti na vsa prikazana vprašanja",
+    "book.locked-chapter-msg-correct": "Ostanek knjige bo prikazan, ko pravilno odgovorite na vsa prikazana vprašanja",
     "book.next-in-collection": "Naslednja knjiga v tej zbirki: ",
     "chapter.replay": "Pokaži ponovno",
     "chapter.showanswer": "Pokaži odgovor",

ingest/book.ts

@@ -1,7 +1,7 @@
 import fs from "fs";
 import path from "path";
 
-import { RawBookFrontmatter, ChapterDefBase, ChapterFrontmatter } from "@/types";
+import { RawBookFrontmatter, ChapterDefBase, ChapterFrontmatter, UnlockChaptersOnAnswersOptions } from "@/types";
 
 import { pathExists } from "./paths";
 import { checkedMatter, CollectedDefaults, defaultsFor, getMdFile, isListOfStrings, parseMd, readPublicDirMd } from "./md-helpers";
@@ -23,6 +23,7 @@ const bookFrontmatterDefaults: RawBookFrontmatter = {
   coverImg: "",
   requireLogin: false,
   quizThreshold: 0,
+  unlockChaptersOnAnswers: UnlockChaptersOnAnswersOptions[0],
 } satisfies RawBookFrontmatter & Record<string, unknown>;
 
 const extraBookMatter = {
@@ -46,6 +47,8 @@ export const bookMatter = (indexMd: string, slug: string, defaults: Partial<RawB
         : "'groups' must be a list of strings, or string pairs without dashes",
       tokens: isListOfStrings,
       admins: isListOfStrings,
+      unlockChaptersOnAnswers: (value) => !["none", "attempt", "correct"].includes(value)
+        && `'unlockChaptersOnAnswers' must be one of 'none', 'attempt', or 'correct'`,
     }
   );
 

ingest/index.ts

@@ -57,6 +57,8 @@ export async function updateDb(
     driver: sqlite3.Database,
   });
   await db.exec("PRAGMA foreign_keys = ON");
+  const { migrate } = await import("../utils/migrateDb.mjs");
+  await migrate(db);
   let anyErrors = false;
 
   let moved: [string, string][] = [];

ingest/updatePaths.ts

@@ -12,6 +12,7 @@ import { MailPath } from "@/ingest/mail";
 import { InheritableResources } from "@/ingest/inheritables";
 import {joinedPath} from "@/ingest/paths";
 import {load} from "js-yaml";
+import { UnlockChaptersOnAnswersOptions } from "@/types";
 
 const checkMoved = (moved: [string, string][]) => {
   moved.forEach(([from]) => {
@@ -393,7 +394,7 @@ const insertBook = async (
     mdxContent, chapters, slug,
     frontmatter: {
       title, subTitle, public: isPublic, language, tocInHeader,
-      coverImg, requireLogin, quizThreshold, groups, tokens
+      coverImg, requireLogin, quizThreshold, unlockChaptersOnAnswers, groups, tokens
     }
   } = book;
   const content = await serializedContent(mdxContent, language, slug);
@@ -403,9 +404,9 @@ const insertBook = async (
         INSERT INTO books (lastBuildId,
                            path, title, subtitle,
                            public, language, tocInHeader,
-                           coverImg, requireLogin, quizThreshold,
+                           coverImg, requireLogin, quizThreshold, unlockChaptersOnAnswers,
                            content)
-        VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
+        VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
         ON CONFLICT DO UPDATE SET lastBuildId          = excluded.lastBuildId,
                                   title                = excluded.title,
                                   subtitle             = excluded.subtitle,
@@ -415,6 +416,7 @@ const insertBook = async (
                                   coverImg             = excluded.coverImg,
                                   requireLogin         = excluded.requireLogin,
                                   quizThreshold        = excluded.quizThreshold,
+                                  unlockChaptersOnAnswers = excluded.unlockChaptersOnAnswers,
                                   content              = excluded.content
         RETURNING id
     `,
@@ -423,6 +425,7 @@ const insertBook = async (
       slug, title, subTitle,
       isPublic, language, tocInHeader,
       coverImg, requireLogin, quizThreshold,
+      UnlockChaptersOnAnswersOptions.indexOf(unlockChaptersOnAnswers),
       content
     ]
   );

types/index.ts

@@ -34,6 +34,8 @@ export interface ChapterDef extends ChapterDefBase {
 
 
 /* Books */
+export const UnlockChaptersOnAnswersOptions = ["none", "attempt", "correct"] as const
+export type UnlockChaptersOnAnswersType = typeof UnlockChaptersOnAnswersOptions[number];
 
 export interface BookFrontmatterBase {
   title: string;
@@ -44,6 +46,7 @@ export interface BookFrontmatterBase {
   coverImg: string;
   requireLogin: boolean;
   quizThreshold?: number;
+  unlockChaptersOnAnswers: UnlockChaptersOnAnswersType;
   chapters?: string[];
 }
 

utils/db-migrations/001-require-chapter-progress.sql

@@ -0,0 +1,2 @@
+ALTER TABLE books
+  ADD unlockChaptersOnAnswers INTEGER DEFAULT 0;