merge: Implement Donation URL (#343)

Reviewed-on: https://git.joinsharkey.org/Sharkey/Sharkey/pulls/343
Reviewed-by: dakkar <dakkar@noreply.git.joinshakrey.org>
Reviewed-by: Amelia Yukii <admin@transfem.org>
Reviewed-by: Marie <marie@kaifa.ch>

locales/de-DE.yml

@@ -973,6 +973,7 @@ neverShow: "Nicht wieder anzeigen"
 remindMeLater: "Vielleicht später"
 didYouLikeMisskey: "Gefällt dir Sharkey?"
 pleaseDonate: "Sharkey ist die kostenlose Software, die von {host} verwendet wird. Wir würden uns über Spenden freuen, damit dessen Entwicklung weitergeführt werden kann!"
+pleaseDonateInstance: "Du kannst {host} auch direkt unterstützen, indem du an deine Instanz Administration spendest."
 roles: "Rollen"
 role: "Rolle"
 noRole: "Rolle nicht gefunden"
@@ -1150,6 +1151,8 @@ impressumDescription: "In manchen Ländern, wie Deutschland und dessen Umgebung,
 privacyPolicy: "Datenschutzerklärung"
 privacyPolicyUrl: "Datenschutzerklärungs-URL"
 tosAndPrivacyPolicy: "Nutzungsbedingungen und Datenschutzerklärung"
+donation: "Spenden"
+donationUrl: "Spenden-URL"
 avatarDecorations: "Profilbilddekoration"
 attach: "Anbringen"
 detach: "Entfernen"

locales/en-US.yml

@@ -1014,6 +1014,7 @@ neverShow: "Don't show again"
 remindMeLater: "Maybe later"
 didYouLikeMisskey: "Have you taken a liking to Sharkey?"
 pleaseDonate: "{host} uses the free software, Sharkey. We would highly appreciate your donations so development of Sharkey can continue!"
+pleaseDonateInstance: "You can also support {host} directly by donating to your instance administration."
 roles: "Roles"
 role: "Role"
 noRole: "Role not found"
@@ -1200,6 +1201,8 @@ impressumDescription: "In some countries, like germany, the inclusion of operato
 privacyPolicy: "Privacy Policy"
 privacyPolicyUrl: "Privacy Policy URL"
 tosAndPrivacyPolicy: "Terms of Service and Privacy Policy"
+donation: "Donate"
+donationUrl: "Donation URL"
 avatarDecorations: "Avatar decorations"
 attach: "Attach"
 detach: "Remove"

locales/index.d.ts

@@ -1023,6 +1023,7 @@ export interface Locale {
     "remindMeLater": string;
     "didYouLikeMisskey": string;
     "pleaseDonate": string;
+    "pleaseDonateInstance": string;
     "roles": string;
     "role": string;
     "noRole": string;
@@ -1209,6 +1210,8 @@ export interface Locale {
     "privacyPolicy": string;
     "privacyPolicyUrl": string;
     "tosAndPrivacyPolicy": string;
+    "donation": string;
+    "donationUrl": string;
     "avatarDecorations": string;
     "attach": string;
     "detach": string;

locales/ja-JP.yml

@@ -1020,6 +1020,7 @@ neverShow: "今後表示しない"
 remindMeLater: "また後で"
 didYouLikeMisskey: "Sharkeyを気に入っていただけましたか？"
 pleaseDonate: "Sharkeyは{host}が使用している無料のソフトウェアです。これからも開発を続けられるように、ぜひ寄付をお願いします！"
+pleaseDonateInstance: "インスタンス管理への寄付によって{host}を直接サポートすることもできます。"
 roles: "ロール"
 role: "ロール"
 noRole: "ロールはありません"
@@ -1206,6 +1207,8 @@ impressumDescription: "ドイツなどの一部の国と地域では表示が義
 privacyPolicy: "プライバシーポリシー"
 privacyPolicyUrl: "プライバシーポリシーURL"
 tosAndPrivacyPolicy: "利用規約・プライバシーポリシー"
+donation: "寄付する"
+donationUrl: "寄付URL"
 avatarDecorations: "アイコンデコレーション"
 attach: "付ける"
 detach: "外す"

packages/backend/migration/1704744370000-add-donation-url.js

@@ -0,0 +1,10 @@
+export class AddDonationUrl1704744370000 {
+    name = 'AddDonationUrl1704744370000'
+
+    async up(queryRunner) {
+        await queryRunner.query(`ALTER TABLE "meta" ADD "donationUrl" character varying(1024)`);
+    }
+    async down(queryRunner) {
+        await queryRunner.query(`ALTER TABLE "meta" DROP COLUMN "donationUrl"`);
+    }
+}

packages/backend/src/models/Meta.ts

@@ -385,6 +385,12 @@ export class MiMeta {
 	})
 	public privacyPolicyUrl: string | null;
 
+	@Column('varchar', {
+		length: 1024,
+		nullable: true,
+	})
+	public donationUrl: string | null;
+
 	@Column('varchar', {
 		length: 8192,
 		nullable: true,

packages/backend/src/server/NodeinfoServerService.ts

@@ -108,6 +108,7 @@ export class NodeinfoServerService {
 					tosUrl: meta.termsOfServiceUrl,
 					privacyPolicyUrl: meta.privacyPolicyUrl,
 					impressumUrl: meta.impressumUrl,
+					donationUrl: meta.donationUrl,
 					repositoryUrl: meta.repositoryUrl,
 					feedbackUrl: meta.feedbackUrl,
 					disableRegistration: meta.disableRegistration,

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

@@ -415,6 +415,10 @@ export const meta = {
 				type: 'string',
 				optional: false, nullable: true,
 			},
+			donationUrl: {
+				type: 'string',
+				optional: false, nullable: true,
+			},
 			maintainerEmail: {
 				type: 'string',
 				optional: false, nullable: true,
@@ -498,6 +502,7 @@ export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-
 				repositoryUrl: instance.repositoryUrl,
 				feedbackUrl: instance.feedbackUrl,
 				impressumUrl: instance.impressumUrl,
+				donationUrl: instance.donationUrl,
 				privacyPolicyUrl: instance.privacyPolicyUrl,
 				disableRegistration: instance.disableRegistration,
 				emailRequiredForSignup: instance.emailRequiredForSignup,

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

@@ -105,6 +105,7 @@ export const paramDef = {
 		repositoryUrl: { type: 'string' },
 		feedbackUrl: { type: 'string' },
 		impressumUrl: { type: 'string', nullable: true },
+		donationUrl: { type: 'string', nullable: true },
 		privacyPolicyUrl: { type: 'string', nullable: true },
 		useObjectStorage: { type: 'boolean' },
 		objectStorageBaseUrl: { type: 'string', nullable: true },
@@ -406,6 +407,10 @@ export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-
 				set.impressumUrl = ps.impressumUrl;
 			}
 
+			if (ps.donationUrl !== undefined) {
+				set.donationUrl = ps.donationUrl;
+			}
+
 			if (ps.privacyPolicyUrl !== undefined) {
 				set.privacyPolicyUrl = ps.privacyPolicyUrl;
 			}

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

@@ -291,6 +291,10 @@ export const meta = {
 				type: 'string',
 				optional: false, nullable: true,
 			},
+			donationUrl: {
+				type: 'string',
+				optional: false, nullable: true,
+			},
 			logoImageUrl: {
 				type: 'string',
 				optional: false, nullable: true,
@@ -365,6 +369,7 @@ export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-
 				repositoryUrl: instance.repositoryUrl,
 				feedbackUrl: instance.feedbackUrl,
 				impressumUrl: instance.impressumUrl,
+				donationUrl: instance.donationUrl,
 				privacyPolicyUrl: instance.privacyPolicyUrl,
 				disableRegistration: instance.disableRegistration,
 				emailRequiredForSignup: instance.emailRequiredForSignup,

packages/frontend/src/components/MkDonation.vue

@@ -26,6 +26,16 @@ SPDX-License-Identifier: AGPL-3.0-only
 				<MkLink target="_blank" url="https://ko-fi.com/transfem">{{ i18n.ts.learnMore }}</MkLink>
 			</div>
 		</div>
+		<div v-if="instance.donationUrl" :class="$style.text">
+			<I18n :src="i18n.ts.pleaseDonateInstance" tag="span">
+				<template #host>
+					{{ instance.name ?? host }}
+				</template>
+			</I18n>
+			<div style="margin-top: 0.2em;">
+				<MkLink target="_blank" :url="instance.donationUrl">{{ i18n.ts.learnMore }}</MkLink>
+			</div>
+		</div>
 		<div class="_buttons">
 			<MkButton @click="close">{{ i18n.ts.remindMeLater }}</MkButton>
 			<MkButton @click="neverShow">{{ i18n.ts.neverShow }}</MkButton>

packages/frontend/src/components/MkVisitorDashboard.vue

@@ -123,7 +123,13 @@ function showMenu(ev) {
 		action: () => {
 			window.open(instance.privacyPolicyUrl, '_blank', 'noopener');
 		},
-	} : undefined, (!instance.impressumUrl && !instance.tosUrl && !instance.privacyPolicyUrl) ? undefined : { type: 'divider' }, {
+	} : undefined, (instance.donationUrl) ? {
+		text: i18n.ts.donation,
+		icon: 'ph-hand-coins ph-bold ph-lg',
+		action: () => {
+			window.open(instance.donationUrl, '_blank', 'noopener');
+		},
+	} : undefined, (!instance.impressumUrl && !instance.tosUrl && !instance.privacyPolicyUrl && !instance.donationUrl) ? undefined : { type: 'divider' }, {
 		text: i18n.ts.help,
 		icon: 'ph-question ph-bold ph-lg',
 		action: () => {

packages/frontend/src/pages/about.vue

@@ -57,6 +57,7 @@ SPDX-License-Identifier: AGPL-3.0-only
 						</MkFolder>
 						<FormLink v-if="instance.tosUrl" :to="instance.tosUrl" external>{{ i18n.ts.termsOfService }}</FormLink>
 						<FormLink v-if="instance.privacyPolicyUrl" :to="instance.privacyPolicyUrl" external>{{ i18n.ts.privacyPolicy }}</FormLink>
+						<FormLink v-if="instance.donationUrl" :to="instance.donationUrl" external>{{ i18n.ts.donation }}</FormLink>
 					</div>
 				</div>
 			</FormSection>

packages/frontend/src/pages/admin/settings.vue

@@ -40,6 +40,11 @@ SPDX-License-Identifier: AGPL-3.0-only
 						<template #caption>{{ i18n.ts.impressumDescription }}</template>
 					</MkInput>
 
+					<MkInput v-model="donationUrl" type="url">
+						<template #label>{{ i18n.ts.donationUrl }}</template>
+						<template #prefix><i class="ph-link ph-bold ph-lg"></i></template>
+					</MkInput>
+
 					<MkTextarea v-model="pinnedUsers">
 						<template #label>{{ i18n.ts.pinnedUsers }}</template>
 						<template #caption>{{ i18n.ts.pinnedUsersDescription }}</template>
@@ -170,6 +175,7 @@ const description = ref<string | null>(null);
 const maintainerName = ref<string | null>(null);
 const maintainerEmail = ref<string | null>(null);
 const impressumUrl = ref<string | null>(null);
+const donationUrl = ref<string | null>(null);
 const pinnedUsers = ref<string>('');
 const cacheRemoteFiles = ref<boolean>(false);
 const cacheRemoteSensitiveFiles = ref<boolean>(false);
@@ -192,6 +198,7 @@ async function init(): Promise<void> {
 	maintainerName.value = meta.maintainerName;
 	maintainerEmail.value = meta.maintainerEmail;
 	impressumUrl.value = meta.impressumUrl;
+	donationUrl.value = meta.donationUrl;
 	pinnedUsers.value = meta.pinnedUsers.join('\n');
 	cacheRemoteFiles.value = meta.cacheRemoteFiles;
 	cacheRemoteSensitiveFiles.value = meta.cacheRemoteSensitiveFiles;
@@ -215,6 +222,7 @@ async function save(): void {
 		maintainerName: maintainerName.value,
 		maintainerEmail: maintainerEmail.value,
 		impressumUrl: impressumUrl.value,
+		donationUrl: donationUrl.value,
 		pinnedUsers: pinnedUsers.value.split('\n'),
 		cacheRemoteFiles: cacheRemoteFiles.value,
 		cacheRemoteSensitiveFiles: cacheRemoteSensitiveFiles.value,

packages/frontend/src/ui/_common_/common.ts

@@ -102,7 +102,13 @@ export function openInstanceMenu(ev: MouseEvent) {
 		action: () => {
 			window.open(instance.privacyPolicyUrl, '_blank', 'noopener');
 		},
-	} : undefined, (!instance.impressumUrl && !instance.tosUrl && !instance.privacyPolicyUrl) ? undefined : { type: 'divider' }, {
+	} : undefined, (instance.donationUrl) ? {
+		text: i18n.ts.donation,
+		icon: 'ph-hand-coins ph-bold ph-lg',
+		action: () => {
+			window.open(instance.donationUrl, '_blank', 'noopener');
+		},
+	} : undefined, (!instance.impressumUrl && !instance.tosUrl && !instance.privacyPolicyUrl && !instance.donationUrl) ? undefined : { type: 'divider' }, {
 		text: i18n.ts.help,
 		icon: 'ph-question ph-bold ph-lg',
 		action: () => {

packages/misskey-js/src/autogen/types.ts

@@ -4631,6 +4631,7 @@ export type operations = {
             description: string | null;
             disableRegistration: boolean;
             impressumUrl: string | null;
+            donationUrl: string | null;
             maintainerEmail: string | null;
             maintainerName: string | null;
             name: string | null;
@@ -8650,6 +8651,7 @@ export type operations = {
           repositoryUrl?: string;
           feedbackUrl?: string;
           impressumUrl?: string | null;
+          donationUrl?: string | null;
           privacyPolicyUrl?: string | null;
           useObjectStorage?: boolean;
           objectStorageBaseUrl?: string | null;
@@ -19400,6 +19402,7 @@ export type operations = {
             };
             backgroundImageUrl: string | null;
             impressumUrl: string | null;
+            donationUrl: string | null;
             logoImageUrl: string | null;
             privacyPolicyUrl: string | null;
             serverRules: string[];