PeerTube/server/core/initializers/database.ts

249 lines
9.4 KiB
TypeScript
Raw Normal View History

import { isTestOrDevInstance } from '@peertube/peertube-node-utils'
import { ActorCustomPageModel } from '@server/models/account/actor-custom-page.js'
import { AutomaticTagModel } from '@server/models/automatic-tag/automatic-tag.js'
import { VideoAutomaticTagModel } from '@server/models/automatic-tag/video-automatic-tag.js'
import { CommentAutomaticTagModel } from '@server/models/automatic-tag/comment-automatic-tag.js'
import { RunnerJobModel } from '@server/models/runner/runner-job.js'
import { RunnerRegistrationTokenModel } from '@server/models/runner/runner-registration-token.js'
import { RunnerModel } from '@server/models/runner/runner.js'
import { TrackerModel } from '@server/models/server/tracker.js'
import { VideoTrackerModel } from '@server/models/server/video-tracker.js'
import { UserExportModel } from '@server/models/user/user-export.js'
import { UserImportModel } from '@server/models/user/user-import.js'
import { UserNotificationModel } from '@server/models/user/user-notification.js'
import { UserRegistrationModel } from '@server/models/user/user-registration.js'
import { UserVideoHistoryModel } from '@server/models/user/user-video-history.js'
import { UserModel } from '@server/models/user/user.js'
import { StoryboardModel } from '@server/models/video/storyboard.js'
import { VideoChannelSyncModel } from '@server/models/video/video-channel-sync.js'
import { VideoChapterModel } from '@server/models/video/video-chapter.js'
import { VideoJobInfoModel } from '@server/models/video/video-job-info.js'
import { VideoLiveReplaySettingModel } from '@server/models/video/video-live-replay-setting.js'
import { VideoLiveSessionModel } from '@server/models/video/video-live-session.js'
import { VideoPasswordModel } from '@server/models/video/video-password.js'
import { VideoSourceModel } from '@server/models/video/video-source.js'
import { LocalVideoViewerWatchSectionModel } from '@server/models/view/local-video-viewer-watch-section.js'
import { LocalVideoViewerModel } from '@server/models/view/local-video-viewer.js'
import { WatchedWordsListModel } from '@server/models/watched-words/watched-words-list.js'
import pg from 'pg'
import { QueryTypes, Transaction } from 'sequelize'
import { Sequelize as SequelizeTypescript } from 'sequelize-typescript'
import { logger } from '../helpers/logger.js'
import { AbuseMessageModel } from '../models/abuse/abuse-message.js'
import { AbuseModel } from '../models/abuse/abuse.js'
import { VideoAbuseModel } from '../models/abuse/video-abuse.js'
import { VideoCommentAbuseModel } from '../models/abuse/video-comment-abuse.js'
import { AccountBlocklistModel } from '../models/account/account-blocklist.js'
import { AccountVideoRateModel } from '../models/account/account-video-rate.js'
import { AccountModel } from '../models/account/account.js'
import { ActorFollowModel } from '../models/actor/actor-follow.js'
import { ActorImageModel } from '../models/actor/actor-image.js'
import { ActorModel } from '../models/actor/actor.js'
import { ApplicationModel } from '../models/application/application.js'
import { OAuthClientModel } from '../models/oauth/oauth-client.js'
import { OAuthTokenModel } from '../models/oauth/oauth-token.js'
import { VideoRedundancyModel } from '../models/redundancy/video-redundancy.js'
import { PluginModel } from '../models/server/plugin.js'
import { ServerBlocklistModel } from '../models/server/server-blocklist.js'
import { ServerModel } from '../models/server/server.js'
import { UserNotificationSettingModel } from '../models/user/user-notification-setting.js'
import { ScheduleVideoUpdateModel } from '../models/video/schedule-video-update.js'
import { TagModel } from '../models/video/tag.js'
import { ThumbnailModel } from '../models/video/thumbnail.js'
import { VideoBlacklistModel } from '../models/video/video-blacklist.js'
import { VideoCaptionModel } from '../models/video/video-caption.js'
import { VideoChangeOwnershipModel } from '../models/video/video-change-ownership.js'
import { VideoChannelModel } from '../models/video/video-channel.js'
import { VideoCommentModel } from '../models/video/video-comment.js'
import { VideoFileModel } from '../models/video/video-file.js'
import { VideoImportModel } from '../models/video/video-import.js'
import { VideoLiveModel } from '../models/video/video-live.js'
import { VideoPlaylistElementModel } from '../models/video/video-playlist-element.js'
import { VideoPlaylistModel } from '../models/video/video-playlist.js'
import { VideoShareModel } from '../models/video/video-share.js'
import { VideoStreamingPlaylistModel } from '../models/video/video-streaming-playlist.js'
import { VideoTagModel } from '../models/video/video-tag.js'
import { VideoModel } from '../models/video/video.js'
import { VideoViewModel } from '../models/view/video-view.js'
import { CONFIG } from './config.js'
import { AccountAutomaticTagPolicyModel } from '@server/models/automatic-tag/account-automatic-tag-policy.js'
2017-09-07 15:27:35 +02:00
pg.defaults.parseInt8 = true // Avoid BIGINT to be converted to string
2015-06-09 17:41:40 +02:00
2017-05-15 22:22:03 +02:00
const dbname = CONFIG.DATABASE.DBNAME
const username = CONFIG.DATABASE.USERNAME
const password = CONFIG.DATABASE.PASSWORD
2017-12-15 08:21:00 +01:00
const host = CONFIG.DATABASE.HOSTNAME
const port = CONFIG.DATABASE.PORT
2018-07-28 21:02:26 +02:00
const poolMax = CONFIG.DATABASE.POOL.MAX
2015-06-09 17:41:40 +02:00
2021-04-19 09:25:11 +02:00
let dialectOptions: any = {}
if (CONFIG.DATABASE.SSL) {
dialectOptions = {
ssl: {
rejectUnauthorized: false
}
}
}
2017-12-12 17:53:50 +01:00
const sequelizeTypescript = new SequelizeTypescript({
database: dbname,
2016-12-11 21:50:51 +01:00
dialect: 'postgres',
2021-04-19 09:25:11 +02:00
dialectOptions,
2017-12-15 08:21:00 +01:00
host,
port,
2017-12-12 17:53:50 +01:00
username,
password,
2018-07-28 21:02:26 +02:00
pool: {
max: poolMax
},
benchmark: isTestOrDevInstance(),
2019-04-18 11:28:17 +02:00
isolationLevel: Transaction.ISOLATION_LEVELS.SERIALIZABLE,
2017-07-11 17:04:57 +02:00
logging: (message: string, benchmark: number) => {
if (process.env.NODE_DB_LOG === 'false') return
let newMessage = 'Executed SQL request'
if (isTestOrDevInstance() === true && benchmark !== undefined) {
newMessage += ' in ' + benchmark + 'ms'
2016-12-24 16:59:17 +01:00
}
logger.debug(newMessage, { sql: message, tags: [ 'sql' ] })
2016-12-24 16:59:17 +01:00
}
2016-12-11 21:50:51 +01:00
})
2020-08-24 14:11:15 +02:00
function checkDatabaseConnectionOrDie () {
sequelizeTypescript.authenticate()
.then(() => logger.debug('Connection to PostgreSQL has been established successfully.'))
.catch(err => {
logger.error('Unable to connect to PostgreSQL database.', { err })
process.exit(-1)
})
}
2017-12-13 17:46:23 +01:00
async function initDatabaseModels (silent: boolean) {
2017-12-12 17:53:50 +01:00
sequelizeTypescript.addModels([
ApplicationModel,
2017-12-14 17:38:41 +01:00
ActorModel,
ActorFollowModel,
2021-04-06 11:35:56 +02:00
ActorImageModel,
2017-12-12 17:53:50 +01:00
AccountModel,
OAuthClientModel,
OAuthTokenModel,
ServerModel,
TagModel,
AccountVideoRateModel,
UserModel,
2020-07-24 15:05:51 +02:00
AbuseMessageModel,
2020-07-01 16:05:30 +02:00
AbuseModel,
VideoCommentAbuseModel,
2017-12-12 17:53:50 +01:00
VideoAbuseModel,
2019-04-24 09:44:36 +02:00
VideoModel,
Users can change ownership of their video [#510] (#888) * [#510] Create a new route to get the list of user names To be able to transfer ownership to a user, we need to be able to select him from the list of users. Because the list could be too big, we add a autocomplete feature. This commit does the following: * Add a API endpoint to get a list of user names by searching its name * [#510] The user can choose the next owner of the video To be able to transfer ownership to a user, we need the owner to be able to select the user. The server can autocomplete the name of the user to give the ownership. We add a dialog for the user to actually select it. This commit does the following: * Create a modal for the owner to select the next one * Opens this modal with a button into the menu *more* * Make the dependency injection * [#510] When the user choose the next owner, create a request in database For the change of ownership to happen, we need to store the temporary requests. When the user make the request, save it to database. This commit does the following: * Create the model to persist change ownership requests * Add an API to manage ownership operations * Add a route to persist an ownership request * [#510] A user can fetch its ownership requests sent to him To be able to accept or refuse a change of ownership, the user must be able to fetch them. This commit does the following: * Add an API to list ownership for a user * Add the query to database model * [#510] A user can validate an ownership requests sent to him - server The user can accept or refuse any ownership request that was sent to him. This commit focus only on the server part. This commit does the following: * Add an API for the user to accept or refuse a video ownership * Add validators to ensure security access * Add a query to load a specific video change ownership request * [#510] A user can validate an ownership requests sent to him - web The user can accept or refuse any ownership request that was sent to him. This commit focus only on the web part. This commit does the following: * Add a page to list user ownership changes * Add actions to accept or refuse them * When accepting, show a modal requiring the channel to send the video * Correct lint - to squash * [#510] PR reviews - to squash This commit does the following: * Search parameter for user autocompletion is required from middleware directly * [#510] PR reviews - to squash with creation in database commit This commit does the following: * Add the status attribute in model * Set this attribute on instance creation * Use AccountModel method `loadLocalByName` * [#510] PR reviews - to squash with fetch ownership This commit does the following: * Add the scope `FULL` for database queries with includes * Add classic pagination middlewares * [#510] PR reviews - to squash with ownership validation - server This commit does the following: * Add a middleware to validate whether a user can validate an ownership * Change the ownership status instead of deleting the row * [#510] PR reviews - to squash with ownership validation - client This commit does the following: * Correct indentation of html files with two-spaces indentation * Use event emitter instead of function for accept event * Update the sort of ownership change table for a decreasing order by creation date * Add the status in ownership change table * Use classic method syntax * code style - to squash * Add new user right - to squash * Move the change to my-account instead of video-watch - to squash As requested in pull-request, move the action to change ownership into my videos page. The rest of the logic was not really changed. This commit does the following: - Move the modal into my video page - Create the generic component `button` to keep some styles and logic * [#510] Add tests for the new feature To avoid regression, we add tests for all api of ownership change. This commit does the following: - Create an end-to-end test for ownership change - Divide it to one test per request * [#510] Do not send twice the same request to avoid spam We can send several time the same request to change ownership. However, it will spam the user. To avoid this, we do not save a request already existing in database. This commit does the following: - Check whether the request exist in database - Add tests to verify this new condition * [#510] Change icons Change icons so they remains logic with the rest of the application. This commit does the following: - Add svg for missing icons - Add icons in `my-button` component - Use these new icons * [#510] Add control about the user quota The user should be able to accept a new video only if his quota allows it. This commit does the following: - Update the middleware to control the quota - Add tests verifying the control * Correct merge - Use new modal system - Move button to new directory `buttons` * PR reviews - to squash
2018-09-04 08:57:13 +02:00
VideoChangeOwnershipModel,
2017-12-12 17:53:50 +01:00
VideoChannelModel,
VideoShareModel,
VideoFileModel,
VideoSourceModel,
2023-08-28 10:55:04 +02:00
VideoChapterModel,
2018-07-12 19:02:00 +02:00
VideoCaptionModel,
2017-12-12 17:53:50 +01:00
VideoBlacklistModel,
VideoTagModel,
VideoCommentModel,
ScheduleVideoUpdateModel,
2018-08-29 16:26:25 +02:00
VideoImportModel,
2018-09-11 16:27:07 +02:00
VideoViewModel,
2018-10-05 11:15:06 +02:00
VideoRedundancyModel,
UserVideoHistoryModel,
VideoLiveModel,
2022-05-03 11:38:07 +02:00
VideoLiveSessionModel,
VideoLiveReplaySettingModel,
AccountBlocklistModel,
2018-12-26 10:36:24 +01:00
ServerBlocklistModel,
UserNotificationModel,
2019-01-29 08:37:25 +01:00
UserNotificationSettingModel,
2019-02-26 10:55:40 +01:00
VideoStreamingPlaylistModel,
VideoPlaylistModel,
VideoPlaylistElementModel,
LocalVideoViewerModel,
LocalVideoViewerWatchSectionModel,
2019-07-05 15:28:49 +02:00
ThumbnailModel,
2021-02-18 10:15:11 +01:00
TrackerModel,
VideoTrackerModel,
PluginModel,
Add support for saving video files to object storage (#4290) * Add support for saving video files to object storage * Add support for custom url generation on s3 stored files Uses two config keys to support url generation that doesn't directly go to (compatible s3). Can be used to generate urls to any cache server or CDN. * Upload files to s3 concurrently and delete originals afterwards * Only publish after move to object storage is complete * Use base url instead of url template * Fix mistyped config field * Add rudenmentary way to download before transcode * Implement Chocobozzz suggestions https://github.com/Chocobozzz/PeerTube/pull/4290#issuecomment-891670478 The remarks in question: Try to use objectStorage prefix instead of s3 prefix for your function/variables/config names Prefer to use a tree for the config: s3.streaming_playlists_bucket -> object_storage.streaming_playlists.bucket Use uppercase for config: S3.STREAMING_PLAYLISTS_BUCKETINFO.bucket -> OBJECT_STORAGE.STREAMING_PLAYLISTS.BUCKET (maybe BUCKET_NAME instead of BUCKET) I suggest to rename moveJobsRunning to pendingMovingJobs (or better, create a dedicated videoJobInfo table with a pendingMove & videoId columns so we could also use this table to track pending transcoding jobs) https://github.com/Chocobozzz/PeerTube/pull/4290/files#diff-3e26d41ca4bda1de8e1747af70ca2af642abcc1e9e0bfb94239ff2165acfbde5R19 uses a string instead of an integer I think we should store the origin object storage URL in fileUrl, without base_url injection. Instead, inject the base_url at "runtime" so admins can easily change this configuration without running a script to update DB URLs * Import correct function * Support multipart upload * Remove import of node 15.0 module stream/promises * Extend maximum upload job length Using the same value as for redundancy downloading seems logical * Use dynamic part size for really large uploads Also adds very small part size for local testing * Fix decreasePendingMove query * Resolve various PR comments * Move to object storage after optimize * Make upload size configurable and increase default * Prune webtorrent files that are stored in object storage * Move files after transcoding jobs * Fix federation * Add video path manager * Support move to external storage job in client * Fix live object storage tests Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-08-17 08:26:20 +02:00
ActorCustomPageModel,
2024-02-12 10:47:52 +01:00
UserImportModel,
Channel sync (#5135) * Add external channel URL for channel update / creation (#754) * Disallow synchronisation if user has no video quota (#754) * More constraints serverside (#754) * Disable sync if server configuration does not allow HTTP import (#754) * Working version synchronizing videos with a job (#754) TODO: refactoring, too much code duplication * More logs and try/catch (#754) * Fix eslint error (#754) * WIP: support synchronization time change (#754) * New frontend #754 * WIP: Create sync front (#754) * Enhance UI, sync creation form (#754) * Warning message when HTTP upload is disallowed * More consistent names (#754) * Binding Front with API (#754) * Add a /me API (#754) * Improve list UI (#754) * Implement creation and deletion routes (#754) * Lint (#754) * Lint again (#754) * WIP: UI for triggering import existing videos (#754) * Implement jobs for syncing and importing channels * Don't sync videos before sync creation + avoid concurrency issue (#754) * Cleanup (#754) * Cleanup: OpenAPI + API rework (#754) * Remove dead code (#754) * Eslint (#754) * Revert the mess with whitespaces in constants.ts (#754) * Some fixes after rebase (#754) * Several fixes after PR remarks (#754) * Front + API: Rename video-channels-sync to video-channel-syncs (#754) * Allow enabling channel sync through UI (#754) * getChannelInfo (#754) * Minor fixes: openapi + model + sql (#754) * Simplified API validators (#754) * Rename MChannelSync to MChannelSyncChannel (#754) * Add command for VideoChannelSync (#754) * Use synchronization.enabled config (#754) * Check parameters test + some fixes (#754) * Fix conflict mistake (#754) * Restrict access to video channel sync list API (#754) * Start adding unit test for synchronization (#754) * Continue testing (#754) * Tests finished + convertion of job to scheduler (#754) * Add lastSyncAt field (#754) * Fix externalRemoteUrl sort + creation date not well formatted (#754) * Small fix (#754) * Factorize addYoutubeDLImport and buildVideo (#754) * Check duplicates on channel not on users (#754) * factorize thumbnail generation (#754) * Fetch error should return status 400 (#754) * Separate video-channel-import and video-channel-sync-latest (#754) * Bump DB migration version after rebase (#754) * Prettier states in UI table (#754) * Add DefaultScope in VideoChannelSyncModel (#754) * Fix audit logs (#754) * Ensure user can upload when importing channel + minor fixes (#754) * Mark synchronization as failed on exception + typos (#754) * Change REST API for importing videos into channel (#754) * Add option for fully synchronize a chnanel (#754) * Return a whole sync object on creation to avoid tricks in Front (#754) * Various remarks (#754) * Single quotes by default (#754) * Rename synchronization to video_channel_synchronization * Add check.latest_videos_count and max_per_user options (#754) * Better channel rendering in list #754 * Allow sorting with channel name and state (#754) * Add missing tests for channel imports (#754) * Prefer using a parent job for channel sync * Styling * Client styling Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-08-10 09:53:39 +02:00
VideoJobInfoModel,
2023-01-19 09:27:16 +01:00
VideoChannelSyncModel,
UserRegistrationModel,
VideoPasswordModel,
RunnerRegistrationTokenModel,
RunnerModel,
2023-06-01 14:51:16 +02:00
RunnerJobModel,
2024-02-12 10:47:52 +01:00
StoryboardModel,
UserExportModel,
VideoAutomaticTagModel,
CommentAutomaticTagModel,
AutomaticTagModel,
WatchedWordsListModel,
AccountAutomaticTagPolicyModel
2017-12-12 17:53:50 +01:00
])
2016-12-25 09:44:57 +01:00
2018-07-19 16:17:54 +02:00
// Check extensions exist in the database
await checkPostgresExtensions()
// Create custom PostgreSQL functions
await createFunctions()
if (!silent) logger.info('Database %s is ready.', dbname)
2016-12-25 09:44:57 +01:00
}
2017-05-15 22:22:03 +02:00
// ---------------------------------------------------------------------------
2017-05-22 20:58:25 +02:00
export {
checkDatabaseConnectionOrDie, initDatabaseModels, sequelizeTypescript
2017-06-16 09:45:46 +02:00
}
2018-07-19 16:17:54 +02:00
// ---------------------------------------------------------------------------
async function checkPostgresExtensions () {
2018-11-19 15:21:09 +01:00
const promises = [
checkPostgresExtension('pg_trgm'),
checkPostgresExtension('unaccent')
2018-07-19 16:17:54 +02:00
]
2018-11-19 15:21:09 +01:00
return Promise.all(promises)
}
async function checkPostgresExtension (extension: string) {
2019-04-23 09:50:57 +02:00
const query = `SELECT 1 FROM pg_available_extensions WHERE name = '${extension}' AND installed_version IS NOT NULL;`
2019-04-18 11:28:17 +02:00
const options = {
type: QueryTypes.SELECT as QueryTypes.SELECT,
raw: true
}
2019-04-23 09:50:57 +02:00
const res = await sequelizeTypescript.query<object>(query, options)
2018-07-19 16:17:54 +02:00
2019-04-23 09:50:57 +02:00
if (!res || res.length === 0) {
2019-04-18 11:28:17 +02:00
// Try to create the extension ourselves
2018-11-19 15:21:09 +01:00
try {
await sequelizeTypescript.query(`CREATE EXTENSION ${extension};`, { raw: true })
2018-07-19 16:17:54 +02:00
2018-11-19 15:21:09 +01:00
} catch {
const errorMessage = `You need to enable ${extension} extension in PostgreSQL. ` +
`You can do so by running 'CREATE EXTENSION ${extension};' as a PostgreSQL super user in ${CONFIG.DATABASE.DBNAME} database.`
throw new Error(errorMessage)
2018-07-19 16:17:54 +02:00
}
}
}
function createFunctions () {
2018-07-26 10:45:10 +02:00
const query = `CREATE OR REPLACE FUNCTION immutable_unaccent(text)
RETURNS text AS
$func$
SELECT public.unaccent('public.unaccent', $1::text)
$func$ LANGUAGE sql IMMUTABLE;`
2018-07-19 16:17:54 +02:00
return sequelizeTypescript.query(query, { raw: true })
}