X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmodels%2Fserver%2Fplugin.ts;h=9948c9f7ac27d3366acd5f6dbac41767d1c5144f;hb=64aa66c4a61e1c6aa83a775e7af498e288ea82e4;hp=d094da1f560084b9d51d39e93364941d92a0e823;hpb=d5c8932a601c1854db0a2e399ccaf26e17385f1a;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/models/server/plugin.ts b/server/models/server/plugin.ts index d094da1f5..9948c9f7a 100644 --- a/server/models/server/plugin.ts +++ b/server/models/server/plugin.ts @@ -1,18 +1,17 @@ +import { FindAndCountOptions, json, QueryTypes } from 'sequelize' import { AllowNull, Column, CreatedAt, DataType, DefaultScope, Is, Model, Table, UpdatedAt } from 'sequelize-typescript' -import { getSort, throwIfNotValid } from '../utils' +import { MPlugin, MPluginFormattable } from '@server/types/models' +import { AttributesOnly } from '@shared/typescript-utils' +import { PeerTubePlugin, PluginType, RegisterServerSettingOptions, SettingEntries, SettingValue } from '../../../shared/models' import { isPluginDescriptionValid, isPluginHomepage, isPluginNameValid, - isPluginTypeValid, - isPluginVersionValid + isPluginStableOrUnstableVersionValid, + isPluginStableVersionValid, + isPluginTypeValid } from '../../helpers/custom-validators/plugins' -import { PluginType } from '../../../shared/models/plugins/plugin.type' -import { PeerTubePlugin } from '../../../shared/models/plugins/peertube-plugin.model' -import { FindAndCountOptions, json } from 'sequelize' -import { RegisterServerSettingOptions } from '../../../shared/models/plugins/register-server-setting.model' -import * as Bluebird from 'bluebird' -import { MPlugin, MPluginFormattable } from '@server/typings/models' +import { getSort, throwIfNotValid } from '../shared' @DefaultScope(() => ({ attributes: { @@ -29,7 +28,7 @@ import { MPlugin, MPluginFormattable } from '@server/typings/models' } ] }) -export class PluginModel extends Model { +export class PluginModel extends Model>> { @AllowNull(false) @Is('PluginName', value => throwIfNotValid(value, isPluginNameValid, 'name')) @@ -42,12 +41,12 @@ export class PluginModel extends Model { type: number @AllowNull(false) - @Is('PluginVersion', value => throwIfNotValid(value, isPluginVersionValid, 'version')) + @Is('PluginVersion', value => throwIfNotValid(value, isPluginStableOrUnstableVersionValid, 'version')) @Column version: string @AllowNull(true) - @Is('PluginLatestVersion', value => throwIfNotValid(value, isPluginVersionValid, 'version')) + @Is('PluginLatestVersion', value => throwIfNotValid(value, isPluginStableVersionValid, 'version')) @Column latestVersion: string @@ -87,7 +86,7 @@ export class PluginModel extends Model { @UpdatedAt updatedAt: Date - static listEnabledPluginsAndThemes (): Bluebird { + static listEnabledPluginsAndThemes (): Promise { const query = { where: { enabled: true, @@ -98,7 +97,7 @@ export class PluginModel extends Model { return PluginModel.findAll(query) } - static loadByNpmName (npmName: string): Bluebird { + static loadByNpmName (npmName: string): Promise { const name = this.normalizePluginName(npmName) const type = this.getTypeFromNpmName(npmName) @@ -112,7 +111,7 @@ export class PluginModel extends Model { return PluginModel.findOne(query) } - static getSetting (pluginName: string, pluginType: PluginType, settingName: string) { + static getSetting (pluginName: string, pluginType: PluginType, settingName: string, registeredSettings: RegisterServerSettingOptions[]) { const query = { attributes: [ 'settings' ], where: { @@ -123,13 +122,52 @@ export class PluginModel extends Model { return PluginModel.findOne(query) .then(p => { - if (!p || !p.settings) return undefined + if (!p?.settings || p.settings === undefined) { + const registered = registeredSettings.find(s => s.name === settingName) + if (!registered || registered.default === undefined) return undefined + + return registered.default + } return p.settings[settingName] }) } - static setSetting (pluginName: string, pluginType: PluginType, settingName: string, settingValue: string) { + static getSettings ( + pluginName: string, + pluginType: PluginType, + settingNames: string[], + registeredSettings: RegisterServerSettingOptions[] + ) { + const query = { + attributes: [ 'settings' ], + where: { + name: pluginName, + type: pluginType + } + } + + return PluginModel.findOne(query) + .then(p => { + const result: SettingEntries = {} + + for (const name of settingNames) { + if (!p?.settings || p.settings[name] === undefined) { + const registered = registeredSettings.find(s => s.name === name) + + if (registered?.default !== undefined) { + result[name] = registered.default + } + } else { + result[name] = p.settings[name] + } + } + + return result + }) + } + + static setSetting (pluginName: string, pluginType: PluginType, settingName: string, settingValue: SettingValue) { const query = { where: { name: pluginName, @@ -160,39 +198,34 @@ export class PluginModel extends Model { if (!c) return undefined const value = c.value - if (typeof value === 'string' && value.startsWith('{')) { - try { - return JSON.parse(value) - } catch { - return value - } + try { + return JSON.parse(value) + } catch { + return value } - - return c.value }) } static storeData (pluginName: string, pluginType: PluginType, key: string, data: any) { - const query = { - where: { - name: pluginName, - type: pluginType - } - } + const query = 'UPDATE "plugin" SET "storage" = jsonb_set(coalesce("storage", \'{}\'), :key, :data::jsonb) ' + + 'WHERE "name" = :pluginName AND "type" = :pluginType' - const toSave = { - [`storage.${key}`]: data + const jsonPath = '{' + key + '}' + + const options = { + replacements: { pluginName, pluginType, key: jsonPath, data: JSON.stringify(data) }, + type: QueryTypes.UPDATE } - return PluginModel.update(toSave, query) + return PluginModel.sequelize.query(query, options) .then(() => undefined) } static listForApi (options: { - pluginType?: PluginType, - uninstalled?: boolean, - start: number, - count: number, + pluginType?: PluginType + uninstalled?: boolean + start: number + count: number sort: string }) { const { uninstalled = false } = options @@ -207,14 +240,13 @@ export class PluginModel extends Model { if (options.pluginType) query.where['type'] = options.pluginType - return PluginModel - .findAndCountAll(query) - .then(({ rows, count }) => { - return { total: count, data: rows } - }) + return Promise.all([ + PluginModel.count(query), + PluginModel.findAll(query) + ]).then(([ total, data ]) => ({ total, data })) } - static listInstalled (): Bluebird { + static listInstalled (): Promise { const query = { where: { uninstalled: false @@ -241,13 +273,13 @@ export class PluginModel extends Model { } getPublicSettings (registeredSettings: RegisterServerSettingOptions[]) { - const result: { [ name: string ]: string } = {} + const result: SettingEntries = {} const settings = this.settings || {} for (const r of registeredSettings) { if (r.private !== false) continue - result[r.name] = settings[r.name] || r.default || null + result[r.name] = settings[r.name] ?? r.default ?? null } return result