Sharkey/src/server/api/endpoints/meta.ts

591 lines
17 KiB
TypeScript
Raw Normal View History

import $ from 'cafy';
2021-03-23 10:43:07 +02:00
import config from '@/config';
2018-11-02 06:47:44 +02:00
import define from '../define';
2021-03-23 10:43:07 +02:00
import { fetchMeta } from '@/misc/fetch-meta';
import { Ads, Emojis, Users } from '../../../models';
2021-03-23 10:43:07 +02:00
import { DB_MAX_NOTE_TEXT_LENGTH } from '@/misc/hard-limits';
import { MoreThan } from 'typeorm';
2016-12-29 00:49:51 +02:00
2018-10-08 19:01:48 +03:00
export const meta = {
tags: ['meta'],
2020-02-15 14:33:32 +02:00
requireCredential: false as const,
2018-10-08 19:01:48 +03:00
params: {
detail: {
2019-02-13 09:33:07 +02:00
validator: $.optional.bool,
default: true
}
},
2019-02-24 20:21:54 +02:00
res: {
2019-06-27 12:04:09 +03:00
type: 'object' as const,
optional: false as const, nullable: false as const,
2019-02-24 20:21:54 +02:00
properties: {
maintainerName: {
type: 'string' as const,
optional: false as const, nullable: true as const
},
maintainerEmail: {
type: 'string' as const,
optional: false as const, nullable: true as const
},
2019-02-24 20:21:54 +02:00
version: {
2019-06-27 12:04:09 +03:00
type: 'string' as const,
optional: false as const, nullable: false as const,
example: config.version
2019-02-24 20:21:54 +02:00
},
name: {
2019-06-27 12:04:09 +03:00
type: 'string' as const,
optional: false as const, nullable: false as const,
2019-02-24 20:21:54 +02:00
},
uri: {
2019-06-27 12:04:09 +03:00
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'url',
example: 'https://misskey.example.com'
},
description: {
type: 'string' as const,
optional: false as const, nullable: true as const,
2019-02-24 20:21:54 +02:00
},
langs: {
type: 'array' as const,
optional: false as const, nullable: false as const,
items: {
type: 'string' as const,
optional: false as const, nullable: false as const
}
},
tosUrl: {
type: 'string' as const,
optional: false as const, nullable: true as const
},
repositoryUrl: {
type: 'string' as const,
optional: false as const, nullable: false as const,
2021-03-24 05:23:05 +02:00
default: 'https://github.com/misskey-dev/misskey'
},
feedbackUrl: {
type: 'string' as const,
optional: false as const, nullable: false as const,
2021-03-24 05:23:05 +02:00
default: 'https://github.com/misskey-dev/misskey/issues/new'
},
secure: {
type: 'boolean' as const,
optional: false as const, nullable: false as const,
default: false
},
disableRegistration: {
type: 'boolean' as const,
optional: false as const, nullable: false as const,
},
disableLocalTimeline: {
type: 'boolean' as const,
optional: false as const, nullable: false as const,
},
disableGlobalTimeline: {
type: 'boolean' as const,
optional: false as const, nullable: false as const,
},
driveCapacityPerLocalUserMb: {
type: 'number' as const,
optional: false as const, nullable: false as const
},
driveCapacityPerRemoteUserMb: {
type: 'number' as const,
optional: false as const, nullable: false as const
},
cacheRemoteFiles: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
proxyRemoteFiles: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
enableHcaptcha: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
hcaptchaSiteKey: {
type: 'string' as const,
optional: false as const, nullable: true as const
},
enableRecaptcha: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
recaptchaSiteKey: {
type: 'string' as const,
optional: false as const, nullable: true as const
},
swPublickey: {
type: 'string' as const,
optional: false as const, nullable: true as const
},
mascotImageUrl: {
type: 'string' as const,
optional: false as const, nullable: false as const,
default: '/assets/ai.png'
},
bannerUrl: {
type: 'string' as const,
optional: false as const, nullable: false as const
},
errorImageUrl: {
type: 'string' as const,
optional: false as const, nullable: false as const,
default: 'https://xn--931a.moe/aiart/yubitun.png'
},
iconUrl: {
type: 'string' as const,
optional: false as const, nullable: true as const
},
maxNoteTextLength: {
type: 'number' as const,
optional: false as const, nullable: false as const,
default: 500
},
emojis: {
2019-06-27 12:04:09 +03:00
type: 'array' as const,
optional: false as const, nullable: false as const,
2019-02-24 20:21:54 +02:00
items: {
2019-06-27 12:04:09 +03:00
type: 'object' as const,
optional: false as const, nullable: false as const,
2019-02-24 20:21:54 +02:00
properties: {
id: {
2019-06-27 12:04:09 +03:00
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'id'
2019-02-24 20:21:54 +02:00
},
aliases: {
type: 'array' as const,
2019-06-27 12:04:09 +03:00
optional: false as const, nullable: false as const,
items: {
type: 'string' as const,
optional: false as const, nullable: false as const
}
2019-02-24 20:21:54 +02:00
},
category: {
type: 'string' as const,
optional: false as const, nullable: true as const
},
host: {
type: 'string' as const,
optional: false as const, nullable: true as const
},
url: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'url'
}
2019-02-24 20:21:54 +02:00
}
}
2019-02-24 20:21:54 +02:00
},
ads: {
type: 'array' as const,
optional: false as const, nullable: false as const,
items: {
type: 'object' as const,
optional: false as const, nullable: false as const,
properties: {
place: {
type: 'string' as const,
optional: false as const, nullable: false as const
},
url: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'url'
},
imageUrl: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'url'
},
}
}
},
requireSetup: {
2019-06-27 12:04:09 +03:00
type: 'boolean' as const,
optional: false as const, nullable: false as const,
example: false
2019-02-24 20:21:54 +02:00
},
enableEmail: {
2019-06-27 12:04:09 +03:00
type: 'boolean' as const,
optional: false as const, nullable: false as const
2019-02-24 20:21:54 +02:00
},
enableTwitterIntegration: {
2019-06-27 12:04:09 +03:00
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
enableGithubIntegration: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
enableDiscordIntegration: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
enableServiceWorker: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
translatorAvailable: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
proxyAccountName: {
type: 'string' as const,
optional: false as const, nullable: true as const
},
features: {
type: 'object' as const,
optional: true as const, nullable: false as const,
properties: {
registration: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
localTimeLine: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
globalTimeLine: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
elasticsearch: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
hcaptcha: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
recaptcha: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
objectStorage: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
twitter: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
github: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
discord: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
serviceWorker: {
type: 'boolean' as const,
optional: false as const, nullable: false as const
},
miauth: {
type: 'boolean' as const,
optional: true as const, nullable: false as const,
default: true
},
}
},
userStarForReactionFallback: {
type: 'boolean' as const,
optional: true as const, nullable: false as const,
},
pinnedUsers: {
type: 'array' as const,
optional: true as const, nullable: false as const,
items: {
type: 'string' as const,
optional: false as const, nullable: false as const
}
},
hiddenTags: {
type: 'array' as const,
optional: true as const, nullable: false as const,
items: {
type: 'string' as const,
optional: false as const, nullable: false as const
}
},
blockedHosts: {
type: 'array' as const,
optional: true as const, nullable: false as const,
items: {
type: 'string' as const,
optional: false as const, nullable: false as const
}
},
hcaptchaSecretKey: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
recaptchaSecretKey: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
proxyAccountId: {
type: 'string' as const,
optional: true as const, nullable: true as const,
format: 'id'
},
twitterConsumerKey: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
twitterConsumerSecret: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
githubClientId: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
githubClientSecret: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
discordClientId: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
discordClientSecret: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
summaryProxy: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
email: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
smtpSecure: {
type: 'boolean' as const,
optional: true as const, nullable: false as const
},
smtpHost: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
smtpPort: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
smtpUser: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
smtpPass: {
type: 'string' as const,
optional: true as const, nullable: true as const
2019-02-24 20:21:54 +02:00
},
swPrivateKey: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
useObjectStorage: {
type: 'boolean' as const,
optional: true as const, nullable: false as const
},
objectStorageBaseUrl: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
objectStorageBucket: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
objectStoragePrefix: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
objectStorageEndpoint: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
objectStorageRegion: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
objectStoragePort: {
type: 'number' as const,
optional: true as const, nullable: true as const
},
objectStorageAccessKey: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
objectStorageSecretKey: {
type: 'string' as const,
optional: true as const, nullable: true as const
},
objectStorageUseSSL: {
type: 'boolean' as const,
optional: true as const, nullable: false as const
},
objectStorageUseProxy: {
type: 'boolean' as const,
optional: true as const, nullable: false as const
},
objectStorageSetPublicRead: {
type: 'boolean' as const,
optional: true as const, nullable: false as const
}
2019-02-24 20:21:54 +02:00
}
}
2018-10-08 19:01:48 +03:00
};
export default define(meta, async (ps, me) => {
2019-04-24 02:11:19 +03:00
const instance = await fetchMeta(true);
2017-11-15 02:47:47 +02:00
const emojis = await Emojis.find({
where: {
host: null
},
order: {
category: 'ASC',
name: 'ASC'
},
cache: {
id: 'meta_emojis',
milliseconds: 3600000 // 1 hour
}
});
2018-11-02 16:23:01 +02:00
const ads = await Ads.find({
where: {
expiresAt: MoreThan(new Date())
},
});
const response: any = {
Use PostgreSQL instead of MongoDB (#4572) * wip * Update note.ts * Update timeline.ts * Update core.ts * wip * Update generate-visibility-query.ts * wip * wip * wip * wip * wip * Update global-timeline.ts * wip * wip * wip * Update vote.ts * wip * wip * Update create.ts * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * Update files.ts * wip * wip * Update CONTRIBUTING.md * wip * wip * wip * wip * wip * wip * wip * wip * Update read-notification.ts * wip * wip * wip * wip * wip * wip * wip * Update cancel.ts * wip * wip * wip * Update show.ts * wip * wip * Update gen-id.ts * Update create.ts * Update id.ts * wip * wip * wip * wip * wip * wip * wip * Docker: Update files about Docker (#4599) * Docker: Use cache if files used by `yarn install` was not updated This patch reduces the number of times to installing node_modules. For example, `yarn install` step will be skipped when only ".config/default.yml" is updated. * Docker: Migrate MongoDB to Postgresql Misskey uses Postgresql as a database instead of Mongodb since version 11. * Docker: Uncomment about data persistence This patch will save a lot of databases. * wip * wip * wip * Update activitypub.ts * wip * wip * wip * Update logs.ts * wip * Update drive-file.ts * Update register.ts * wip * wip * Update mentions.ts * wip * wip * wip * Update recommendation.ts * wip * Update index.ts * wip * Update recommendation.ts * Doc: Update docker.ja.md and docker.en.md (#1) (#4608) Update how to set up misskey. * wip * :v: * wip * Update note.ts * Update postgre.ts * wip * wip * wip * wip * Update add-file.ts * wip * wip * wip * Clean up * Update logs.ts * wip * :pizza: * wip * Ad notes * wip * Update api-visibility.ts * Update note.ts * Update add-file.ts * tests * tests * Update postgre.ts * Update utils.ts * wip * wip * Refactor * wip * Refactor * wip * wip * Update show-users.ts * Update update-instance.ts * wip * Update feed.ts * Update outbox.ts * Update outbox.ts * Update user.ts * wip * Update list.ts * Update update-hashtag.ts * wip * Update update-hashtag.ts * Refactor * Update update.ts * wip * wip * :v: * clean up * docs * Update push.ts * wip * Update api.ts * wip * :v: * Update make-pagination-query.ts * :v: * Delete hashtags.ts * Update instances.ts * Update instances.ts * Update create.ts * Update search.ts * Update reversi-game.ts * Update signup.ts * Update user.ts * id * Update example.yml * :art: * objectid * fix * reversi * reversi * Fix bug of chart engine * Add test of chart engine * Improve test * Better testing * Improve chart engine * Refactor * Add test of chart engine * Refactor * Add chart test * Fix bug * コミットし忘れ * Refactoring * :v: * Add tests * Add test * Extarct note tests * Refactor * 存在しないユーザーにメンションできなくなっていた問題を修正 * Fix bug * Update update-meta.ts * Fix bug * Update mention.vue * Fix bug * Update meta.ts * Update CONTRIBUTING.md * Fix bug * Fix bug * Fix bug * Clean up * Clean up * Update notification.ts * Clean up * Add mute tests * Add test * Refactor * Add test * Fix test * Refactor * Refactor * Add tests * Update utils.ts * Update utils.ts * Fix test * Update package.json * Update update.ts * Update manifest.ts * Fix bug * Fix bug * Add test * :art: * Update endpoint permissions * Updaye permisison * Update person.ts #4299 * データベースと同期しないように * Fix bug * Fix bug * Update reversi-game.ts * Use a feature of Node v11.7.0 to extract a public key (#4644) * wip * wip * :v: * Refactoring #1540 * test * test * test * test * test * test * test * Fix bug * Fix test * :sushi: * wip * #4471 * Add test for #4335 * Refactor * Fix test * Add tests * :clock4: * Fix bug * Add test * Add test * rename * Fix bug
2019-04-07 15:50:36 +03:00
maintainerName: instance.maintainerName,
maintainerEmail: instance.maintainerEmail,
version: config.version,
name: instance.name,
uri: config.url,
description: instance.description,
langs: instance.langs,
tosUrl: instance.ToSUrl,
repositoryUrl: instance.repositoryUrl,
feedbackUrl: instance.feedbackUrl,
2018-08-19 13:15:29 +03:00
secure: config.https != null,
2018-10-08 19:01:48 +03:00
disableRegistration: instance.disableRegistration,
disableLocalTimeline: instance.disableLocalTimeline,
2019-01-16 07:54:14 +02:00
disableGlobalTimeline: instance.disableGlobalTimeline,
driveCapacityPerLocalUserMb: instance.localDriveCapacityMb,
driveCapacityPerRemoteUserMb: instance.remoteDriveCapacityMb,
2020-04-28 08:29:33 +03:00
enableHcaptcha: instance.enableHcaptcha,
hcaptchaSiteKey: instance.hcaptchaSiteKey,
2018-11-07 05:09:24 +02:00
enableRecaptcha: instance.enableRecaptcha,
recaptchaSiteKey: instance.recaptchaSiteKey,
2018-12-19 21:08:13 +02:00
swPublickey: instance.swPublicKey,
2019-01-03 20:52:50 +02:00
mascotImageUrl: instance.mascotImageUrl,
bannerUrl: instance.bannerUrl,
2018-12-11 14:17:57 +02:00
errorImageUrl: instance.errorImageUrl,
iconUrl: instance.iconUrl,
backgroundImageUrl: instance.backgroundImageUrl,
logoImageUrl: instance.logoImageUrl,
maxNoteTextLength: Math.min(instance.maxNoteTextLength, DB_MAX_NOTE_TEXT_LENGTH),
2020-03-31 03:15:04 +03:00
emojis: await Emojis.packMany(emojis),
ads: ads.map(ad => ({
2021-05-08 06:50:11 +03:00
id: ad.id,
url: ad.url,
place: ad.place,
2021-05-07 08:22:13 +03:00
ratio: ad.ratio,
imageUrl: ad.imageUrl,
})),
enableEmail: instance.enableEmail,
2018-11-16 19:13:01 +02:00
enableTwitterIntegration: instance.enableTwitterIntegration,
enableGithubIntegration: instance.enableGithubIntegration,
enableDiscordIntegration: instance.enableDiscordIntegration,
enableServiceWorker: instance.enableServiceWorker,
2020-08-29 02:56:32 +03:00
translatorAvailable: instance.deeplAuthKey != null,
...(ps.detail ? {
2020-12-06 15:47:51 +02:00
pinnedPages: instance.pinnedPages,
pinnedClipId: instance.pinnedClipId,
cacheRemoteFiles: instance.cacheRemoteFiles,
proxyRemoteFiles: instance.proxyRemoteFiles,
requireSetup: (await Users.count({
host: null,
})) === 0,
} : {})
};
2018-11-02 16:23:01 +02:00
if (ps.detail) {
const proxyAccount = instance.proxyAccountId ? await Users.pack(instance.proxyAccountId).catch(() => null) : null;
response.proxyAccountName = proxyAccount ? proxyAccount.username : null;
response.features = {
registration: !instance.disableRegistration,
localTimeLine: !instance.disableLocalTimeline,
2019-01-16 07:54:14 +02:00
globalTimeLine: !instance.disableGlobalTimeline,
elasticsearch: config.elasticsearch ? true : false,
2020-04-28 08:29:33 +03:00
hcaptcha: instance.enableHcaptcha,
recaptcha: instance.enableRecaptcha,
2019-05-15 19:07:32 +03:00
objectStorage: instance.useObjectStorage,
twitter: instance.enableTwitterIntegration,
github: instance.enableGithubIntegration,
discord: instance.enableDiscordIntegration,
2018-12-19 21:08:13 +02:00
serviceWorker: instance.enableServiceWorker,
2020-03-29 11:44:14 +03:00
miauth: true,
};
if (me && me.isAdmin) {
response.useStarForReactionFallback = instance.useStarForReactionFallback;
response.pinnedUsers = instance.pinnedUsers;
response.hiddenTags = instance.hiddenTags;
response.blockedHosts = instance.blockedHosts;
response.hcaptchaSecretKey = instance.hcaptchaSecretKey;
response.recaptchaSecretKey = instance.recaptchaSecretKey;
response.proxyAccountId = instance.proxyAccountId;
response.twitterConsumerKey = instance.twitterConsumerKey;
response.twitterConsumerSecret = instance.twitterConsumerSecret;
response.githubClientId = instance.githubClientId;
response.githubClientSecret = instance.githubClientSecret;
response.discordClientId = instance.discordClientId;
response.discordClientSecret = instance.discordClientSecret;
response.summalyProxy = instance.summalyProxy;
response.email = instance.email;
response.smtpSecure = instance.smtpSecure;
response.smtpHost = instance.smtpHost;
response.smtpPort = instance.smtpPort;
response.smtpUser = instance.smtpUser;
response.smtpPass = instance.smtpPass;
response.swPrivateKey = instance.swPrivateKey;
response.useObjectStorage = instance.useObjectStorage;
response.objectStorageBaseUrl = instance.objectStorageBaseUrl;
response.objectStorageBucket = instance.objectStorageBucket;
response.objectStoragePrefix = instance.objectStoragePrefix;
response.objectStorageEndpoint = instance.objectStorageEndpoint;
response.objectStorageRegion = instance.objectStorageRegion;
response.objectStoragePort = instance.objectStoragePort;
response.objectStorageAccessKey = instance.objectStorageAccessKey;
response.objectStorageSecretKey = instance.objectStorageSecretKey;
response.objectStorageUseSSL = instance.objectStorageUseSSL;
response.objectStorageUseProxy = instance.objectStorageUseProxy;
response.objectStorageSetPublicRead = instance.objectStorageSetPublicRead;
response.objectStorageS3ForcePathStyle = instance.objectStorageS3ForcePathStyle;
}
}
return response;
});