v1.2.1 Release

README.md

@@ -6,8 +6,6 @@
 
 *Inspired by the larger sites that are now charging for core functionality, Scholarsome intends to be a drop-in replacement for any study workflow.*
 
-https://scholarsome.com
-
 <a href="https://discord.gg/hRgVvc5MKf">![](https://img.shields.io/badge/-Join%20our%20Discord-white?logo=Discord&logoColor=blue)</a>
 <a href="https://github.com/hwgilbert16/scholarsome/blob/develop/LICENSE">![](https://img.shields.io/github/license/hwgilbert16/scholarsome?color=blue)</a>
 <a href="https://github.com/hwgilbert16/scholarsome/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22">![](https://img.shields.io/badge/contributions-welcome-orange)</a>
@@ -61,13 +59,11 @@ You can read more about our design philosophy <a href="https://github.com/hwgilb
 
 ## Usage
 
-Scholarsome is accessible at https://scholarsome.com for individuals who are not interested in hosting it themselves. It is free and runs the same as the most recently released version.
-
-However, the service can be hosted yourself on any system. For those wishing to self-host Scholarsome, documentation for installation can be found <a href="https://scholarsome.com/handbook/installation/prerequisites">here.</a>
+Scholarsome  can be hosted yourself on any system. For those wishing to self-host Scholarsome, documentation for installation can be found <a href="https://github.com/hwgilbert16/scholarsome/blob/develop/apps/docs/docs/installation/installing.md">here.</a>
 
 ## Development
 
-For development purposes, Scholarsome is required to be installed outside the standard container-based system that is used for production installs. Documentation for development can be found <a href="https://scholarsome.com/handbook/development/development-guide">here.</a>
+For development purposes, Scholarsome is required to be installed outside the standard container-based system that is used for production installs. Documentation for development can be found <a href="https://github.com/hwgilbert16/scholarsome/blob/develop/apps/docs/docs/development/development-guide.md">here.</a>
 
 While we use many technologies, some of our most prominent are:
 

apps/api/src/app/app.module.ts

@@ -21,6 +21,8 @@ import { TokenRefreshMiddleware } from "./providers/token-refresh.middleware";
 import { ConvertingModule } from "./converting/converting.module";
 import { StorageModule } from "./providers/storage/storage.module";
 import { FoldersModule } from "./folders/folders.module";
+import { ScheduleModule } from "@nestjs/schedule";
+import { TasksService } from "./providers/tasks.service";
 
 @Module({
   imports: [
@@ -30,7 +32,7 @@ import { FoldersModule } from "./folders/folders.module";
         cacheControl: true,
         maxAge: 31536000
       },
-      exclude: ["/api/(.*)", "/handbook/(.*)"]
+      exclude: ["/api/(.*)", "/handbook/(.*)", "/sitemaps/(.*)", "/sitemap.xml"]
     }),
     ServeStaticModule.forRoot({
       rootPath: join(__dirname, "..", "docs"),
@@ -40,13 +42,31 @@ import { FoldersModule } from "./folders/folders.module";
         maxAge: 31536000
       }
     }),
+    ServeStaticModule.forRoot({
+      rootPath: join(__dirname, "..", "..", "sitemaps"),
+      serveRoot: "/sitemaps",
+      serveStaticOptions: {
+        index: false,
+        cacheControl: true,
+        maxAge: 0
+      }
+    }),
+    ServeStaticModule.forRoot({
+      rootPath: join(__dirname, "..", "..", "sitemaps", "sitemap.xml"),
+      serveRoot: "/sitemap.xml",
+      serveStaticOptions: {
+        index: false,
+        cacheControl: true,
+        maxAge: 0
+      }
+    }),
     ConfigModule.forRoot({
       isGlobal: true
     }),
     RedisModule.forRootAsync({
       inject: [ConfigService],
       useFactory: (configService: ConfigService) => ({
-        defaultOptions: {
+        commonOptions: {
           host: configService.get<string>("REDIS_HOST"),
           port: configService.get<number>("REDIS_PORT"),
           username: configService.get<string>("REDIS_USERNAME"),
@@ -64,6 +84,7 @@ import { FoldersModule } from "./folders/folders.module";
         ]
       })
     }),
+    ScheduleModule.forRoot(),
     AuthModule,
     DatabaseModule,
     SetsModule,
@@ -86,7 +107,7 @@ import { FoldersModule } from "./folders/folders.module";
     FoldersModule
   ],
   controllers: [],
-  providers: [],
+  providers: [TasksService],
   exports: [JwtModule]
 })
 export class AppModule implements NestModule {

apps/api/src/app/cards/cards.service.ts

@@ -60,7 +60,7 @@ export class CardsService {
         await this.storageService.getInstance()
             .putFile("media/sets/" + fileName, decoded);
 
-        side = side.replace(source, "/api/sets/" + setId + "/media/" + fileName);
+        side = side.replace(source, "/api/sets/" + setId + "/media/" + name);
       }
     } else return false;
 

apps/api/src/app/cards/dto/createCard.dto.ts

@@ -1,58 +1,59 @@
-import { IsNotEmpty, IsNumber, IsOptional, IsString, IsUUID, Max, MaxLength, Min } from "class-validator";
+import {
+  IsNotEmpty,
+  IsNumber,
+  IsOptional,
+  IsString,
+  IsUUID,
+  Max,
+  Min,
+} from "class-validator";
 import { ApiProperty } from "@nestjs/swagger";
 import { Transform, TransformFnParams } from "class-transformer";
 import * as sanitizeHtml from "sanitize-html";
+import { sanitizationConfig } from "../../shared/sanitization/sanitization-config";
 
 export class CreateCardDto {
   @ApiProperty({
     description: "The ID of the set that the card will belong to",
     example: "27758237-5f57-4f6c-b483-6161056dad76",
     minLength: 36,
-    maxLength: 36
+    maxLength: 36,
   })
   @IsUUID("4")
   @IsNotEmpty()
-    setId: string;
+  setId: string;
 
   @ApiProperty({
     description: "The index of the card in the set",
     example: 0,
     minimum: 0,
-    maximum: 2147483647
+    maximum: 2147483647,
   })
   @IsNumber()
   @Min(0)
   @Max(2147483647)
   @IsOptional()
-    index: number;
+  index: number;
 
   @ApiProperty({
-    description: "The front or \"term\" of the card",
+    description: 'The front or "term" of the card',
     example: "The definition of the card",
-    maxLength: 65535
   })
   @IsString()
   @IsNotEmpty()
-  @MaxLength(65535)
-  @Transform((params: TransformFnParams) => sanitizeHtml(params.value, {
-    allowedTags: sanitizeHtml.defaults.allowedTags.concat(["img"]),
-    allowedAttributes: { "img": ["src", "width", "height"], "span": ["style"] },
-    allowedSchemes: ["data"]
-  }))
-    term: string;
+  @Transform((params: TransformFnParams) =>
+    sanitizeHtml(params.value, sanitizationConfig)
+  )
+  term: string;
 
   @ApiProperty({
-    description: "The back or \"definition\" of the card",
+    description: 'The back or "definition" of the card',
     example: "The definition of the card",
-    maxLength: 65535
   })
   @IsString()
   @IsNotEmpty()
-  @MaxLength(65535)
-  @Transform((params: TransformFnParams) => sanitizeHtml(params.value, {
-    allowedTags: sanitizeHtml.defaults.allowedTags.concat(["img"]),
-    allowedAttributes: { "img": ["src", "width", "height"], "span": ["style"] },
-    allowedSchemes: ["data"]
-  }))
-    definition: string;
+  @Transform((params: TransformFnParams) =>
+    sanitizeHtml(params.value, sanitizationConfig)
+  )
+  definition: string;
 }

apps/api/src/app/cards/dto/updateCard.dto.ts

@@ -1,54 +1,54 @@
-import { IsNotEmpty, IsNumber, IsOptional, IsString, Max, MaxLength, Min } from "class-validator";
+import {
+  IsNotEmpty,
+  IsNumber,
+  IsOptional,
+  IsString,
+  Max,
+  Min,
+} from "class-validator";
 import { ApiProperty } from "@nestjs/swagger";
 import { Transform, TransformFnParams } from "class-transformer";
 import * as sanitizeHtml from "sanitize-html";
+import { sanitizationConfig } from "../../shared/sanitization/sanitization-config";
 
 export class UpdateCardDto {
   @ApiProperty({
     description: "The index of the card in the set",
     example: 0,
     required: false,
     minimum: 0,
-    maximum: 2147483647
+    maximum: 2147483647,
   })
   @IsNumber()
   @IsOptional()
   @Min(0)
   @Max(2147483647)
   @IsNotEmpty()
-    index?: number;
+  index?: number;
 
   @ApiProperty({
-    description: "The front or \"term\" of the card",
+    description: 'The front or "term" of the card',
     example: "The definition of the card",
-    maxLength: 65535,
-    required: false
+    required: false,
   })
   @IsString()
   @IsOptional()
   @IsNotEmpty()
-  @MaxLength(65535)
-  @Transform((params: TransformFnParams) => sanitizeHtml(params.value, {
-    allowedTags: sanitizeHtml.defaults.allowedTags.concat(["img"]),
-    allowedAttributes: { "img": ["src", "width", "height"], "span": ["style"] },
-    allowedSchemes: ["data"]
-  }))
-    term?: string;
+  @Transform((params: TransformFnParams) =>
+    sanitizeHtml(params.value, sanitizationConfig)
+  )
+  term?: string;
 
   @ApiProperty({
-    description: "The back or \"definition\" of the card",
+    description: 'The back or "definition" of the card',
     example: "The definition of the card",
-    maxLength: 65535,
-    required: false
+    required: false,
   })
   @IsString()
   @IsOptional()
   @IsNotEmpty()
-  @MaxLength(65535)
-  @Transform((params: TransformFnParams) => sanitizeHtml(params.value, {
-    allowedTags: sanitizeHtml.defaults.allowedTags.concat(["img"]),
-    allowedAttributes: { "img": ["src", "width", "height"], "span": ["style"] },
-    allowedSchemes: ["data"]
-  }))
-    definition?: string;
+  @Transform((params: TransformFnParams) =>
+    sanitizeHtml(params.value, sanitizationConfig)
+  )
+  definition?: string;
 }

apps/api/src/app/folders/folders.controller.ts

@@ -217,8 +217,6 @@ export class FoldersController {
   @UseGuards(AuthenticatedGuard)
   @Post()
   async createFolder(@Body(HtmlDecodePipe) body: CreateFolderDto, @Request() req: ExpressRequest): Promise<ApiResponse<Folder>> {
-    console.log(body);
-
     const user = await this.authService.getUserInfo(req);
     if (!user) {
       throw new UnauthorizedException({

apps/api/src/app/folders/folders.service.ts

@@ -39,6 +39,24 @@ export class FoldersService {
     return folder.author.id === user.id;
   }
 
+  /**
+   * Queries the database for every public folder's ID and when they were last modified
+   * Used for sitemap generation
+   *
+   * @returns Array of all folder IDs and when they were last updated
+   */
+  async getSitemapFolderInfo(): Promise<{ id: string, updatedAt: Date }[]> {
+    return this.prisma.folder.findMany({
+      where: {
+        private: false
+      },
+      select: {
+        id: true,
+        updatedAt: true
+      }
+    });
+  }
+
   /**
    * Queries the database for a unique folder
    *