Merge pull request 'Expand caption limit to 1500 characters' (#9686) from supakaity/calckey:supakaity/caption-size into develop

Reviewed-on: https://codeberg.org/calckey/calckey/pulls/9686

.config/example.yml

@@ -96,6 +96,9 @@ id: 'aid'
 # Max note length, should be < 8000.
 #maxNoteLength: 3000
 
+# Maximum lenght of an image caption or file comment (default 1500, max 8192)
+#maxCaptionLength: 1500
+
 # Whether disable HSTS
 #disableHsts: true
 

packages/backend/migration/1677935903517-DriveComment.js

@@ -0,0 +1,11 @@
+export class DriveComment1677935903517 {
+    name = 'DriveComment1677935903517'
+
+    async up(queryRunner) {
+        await queryRunner.query(`ALTER TABLE "drive_file" ALTER "comment" TYPE character varying(8192)`);
+    }
+
+    async down(queryRunner) {
+        await queryRunner.query(`ALTER TABLE "drive_file" ALTER "comment" TYPE character varying(512)`);
+    }
+}

packages/backend/src/config/types.ts

@@ -74,6 +74,7 @@ export type Source = {
 	maxUserSignups?: number;
 	isManagedHosting?: boolean;
 	maxNoteLength?: number;
+	maxCaptionLength?: number;
 	deepl: {
 		managed?: boolean;
 		authKey?: string;

packages/backend/src/const.ts

@@ -1,7 +1,12 @@
 import config from "@/config/index.js";
+import { DB_MAX_IMAGE_COMMENT_LENGTH } from "@/misc/hard-limits.js";
 
 export const MAX_NOTE_TEXT_LENGTH =
 	config.maxNoteLength != null ? config.maxNoteLength : 3000; // <- should we increase this?
+export const MAX_CAPTION_TEXT_LENGTH = Math.min(
+	config.maxCaptionLength ?? 1500,
+	DB_MAX_IMAGE_COMMENT_LENGTH,
+);
 
 export const SECOND = 1000;
 export const SEC = 1000; // why do we need this duplicate here?

packages/backend/src/misc/hard-limits.ts

@@ -10,4 +10,4 @@ export const DB_MAX_NOTE_TEXT_LENGTH = 8192;
  * Maximum image description length that can be stored in DB.
  * Surrogate pairs count as one
  */
-export const DB_MAX_IMAGE_COMMENT_LENGTH = 512;
+export const DB_MAX_IMAGE_COMMENT_LENGTH = 8192;

packages/backend/src/models/entities/drive-file.ts

@@ -9,6 +9,7 @@ import {
 import { id } from "../id.js";
 import { User } from "./user.js";
 import { DriveFolder } from "./drive-folder.js";
+import { DB_MAX_IMAGE_COMMENT_LENGTH } from "@/misc/hard-limits.js";
 
 @Entity()
 @Index(['userId', 'folderId', 'id'])
@@ -69,7 +70,8 @@ export class DriveFile {
 	public size: number;
 
 	@Column('varchar', {
-		length: 512, nullable: true,
+		length: DB_MAX_IMAGE_COMMENT_LENGTH,
+		nullable: true,
 		comment: 'The comment of the DriveFile.',
 	})
 	public comment: string | null;

packages/backend/src/server/api/endpoints/admin/meta.ts

@@ -1,6 +1,6 @@
 import config from "@/config/index.js";
 import { fetchMeta } from "@/misc/fetch-meta.js";
-import { MAX_NOTE_TEXT_LENGTH } from "@/const.js";
+import { MAX_NOTE_TEXT_LENGTH, MAX_CAPTION_TEXT_LENGTH } from "@/const.js";
 import define from "../../define.js";
 
 export const meta = {
@@ -86,6 +86,11 @@ export const meta = {
 				optional: false,
 				nullable: false,
 			},
+			maxCaptionTextLength: {
+				type: "number",
+				optional: false,
+				nullable: false,
+			},
 			emojis: {
 				type: "array",
 				optional: false,
@@ -499,6 +504,7 @@ export default define(meta, paramDef, async (ps, me) => {
 		backgroundImageUrl: instance.backgroundImageUrl,
 		logoImageUrl: instance.logoImageUrl,
 		maxNoteTextLength: MAX_NOTE_TEXT_LENGTH, // 後方互換性のため
+		maxCaptionTextLength: MAX_CAPTION_TEXT_LENGTH,
 		defaultLightTheme: instance.defaultLightTheme,
 		defaultDarkTheme: instance.defaultDarkTheme,
 		enableEmail: instance.enableEmail,

packages/backend/src/server/api/endpoints/meta.ts

@@ -2,8 +2,7 @@ import { IsNull, MoreThan } from "typeorm";
 import config from "@/config/index.js";
 import { fetchMeta } from "@/misc/fetch-meta.js";
 import { Ads, Emojis, Users } from "@/models/index.js";
-import { DB_MAX_NOTE_TEXT_LENGTH } from "@/misc/hard-limits.js";
-import { MAX_NOTE_TEXT_LENGTH } from "@/const.js";
+import { MAX_NOTE_TEXT_LENGTH, MAX_CAPTION_TEXT_LENGTH } from "@/const.js";
 import define from "../define.js";
 
 export const meta = {
@@ -178,6 +177,11 @@ export const meta = {
 				optional: false,
 				nullable: false,
 			},
+			maxCaptionTextLength: {
+				type: "number",
+				optional: false,
+				nullable: false,
+			},
 			emojis: {
 				type: "array",
 				optional: false,
@@ -456,6 +460,7 @@ export default define(meta, paramDef, async (ps, me) => {
 		backgroundImageUrl: instance.backgroundImageUrl,
 		logoImageUrl: instance.logoImageUrl,
 		maxNoteTextLength: MAX_NOTE_TEXT_LENGTH, // 後方互換性のため
+		maxCaptionTextLength: MAX_CAPTION_TEXT_LENGTH,
 		emojis: instance.privateMode && !me ? [] : await Emojis.packMany(emojis),
 		defaultLightTheme: instance.defaultLightTheme,
 		defaultDarkTheme: instance.defaultDarkTheme,

packages/backend/src/server/nodeinfo.ts

@@ -3,7 +3,7 @@ import config from "@/config/index.js";
 import { fetchMeta } from "@/misc/fetch-meta.js";
 import { Users, Notes } from "@/models/index.js";
 import { IsNull, MoreThan } from "typeorm";
-import { MAX_NOTE_TEXT_LENGTH } from "@/const.js";
+import { MAX_NOTE_TEXT_LENGTH, MAX_CAPTION_TEXT_LENGTH } from "@/const.js";
 import { Cache } from "@/misc/cache.js";
 
 const router = new Router();
@@ -85,6 +85,7 @@ const nodeinfo2 = async () => {
 			enableHcaptcha: meta.enableHcaptcha,
 			enableRecaptcha: meta.enableRecaptcha,
 			maxNoteTextLength: MAX_NOTE_TEXT_LENGTH,
+			maxCaptionTextLength: MAX_CAPTION_TEXT_LENGTH,
 			enableTwitterIntegration: meta.enableTwitterIntegration,
 			enableGithubIntegration: meta.enableGithubIntegration,
 			enableDiscordIntegration: meta.enableDiscordIntegration,

packages/client/src/components/MkMediaCaption.vue

@@ -39,6 +39,7 @@ import MkButton from '@/components/MkButton.vue';
 import bytes from '@/filters/bytes';
 import number from '@/filters/number';
 import { i18n } from '@/i18n';
+import { instance } from '@/instance';
 
 export default defineComponent({
 	components: {
@@ -87,8 +88,9 @@ export default defineComponent({
 
 	computed: {
 		remainingLength(): number {
-			if (typeof this.inputValue !== "string") return 512;
-			return 512 - length(this.inputValue);
+			const maxCaptionLength = instance.maxCaptionTextLength ?? 512;
+			if (typeof this.inputValue !== "string") return maxCaptionLength;
+			return maxCaptionLength - length(this.inputValue);
 		}
 	},