</div>
<div class="plugins" myInfiniteScroller (nearOfBottom)="onNearOfBottom()" [autoInit]="true">
- <div class="section plugin" *ngFor="let plugin of plugins">
- {{ plugin.name }}
+ <div class="card plugin" *ngFor="let plugin of plugins">
+ <div class="card-body">
+ <div class="first-row">
+ <a class="plugin-name" [routerLink]="getShowRouterLink(plugin)" title="Show plugin settings">{{ plugin.name }}</a>
+
+ <span class="plugin-version">{{ plugin.version }}</span>
+ </div>
+
+ <div class="second-row">
+ <div class="description">{{ plugin.description }}</div>
+
+ <div class="buttons">
+ <a class="action-button action-button-edit grey-button" target="_blank" rel="noopener noreferrer"
+ [href]="plugin.homepage" i18n-title title="Go to the plugin homepage"
+ >
+ <my-global-icon iconName="go"></my-global-icon>
+ <span i18n class="button-label">Homepage</span>
+ </a>
+
+
+ <my-edit-button [routerLink]="getShowRouterLink(plugin)" label="Settings" i18n-label></my-edit-button>
+
+ <my-delete-button (click)="uninstall(plugin)" label="Uninstall" i18n-label></my-delete-button>
+ </div>
+ </div>
+ </div>
</div>
</div>
@import '_variables';
@import '_mixins';
-.toggle-plugin-type {
+.first-row {
+ margin-bottom: 10px;
+
+ .plugin-name {
+ font-size: 16px;
+ margin-right: 10px;
+ font-weight: $font-semibold;
+ }
+
+ .plugin-version {
+ opacity: 0.6;
+ }
+}
+
+.second-row {
display: flex;
- justify-content: center;
- margin-bottom: 30px;
+ align-items: center;
+ justify-content: space-between;
+
+ .description {
+ opacity: 0.8
+ }
+
+ .buttons {
+ > *:not(:last-child) {
+ margin-right: 10px;
+ }
+ }
+}
+
+.action-button {
+ @include peertube-button-link;
+ @include button-with-icon(21px, 0, -2px);
}
import { I18n } from '@ngx-translate/i18n-polyfill'
import { PluginApiService } from '@app/+admin/plugins/shared/plugin-api.service'
import { ComponentPagination, hasMoreItems } from '@app/shared/rest/component-pagination.model'
-import { Notifier } from '@app/core'
+import { ConfirmService, Notifier } from '@app/core'
import { PeerTubePlugin } from '@shared/models/plugins/peertube-plugin.model'
+import { ActivatedRoute, Router } from '@angular/router'
@Component({
selector: 'my-plugin-list-installed',
templateUrl: './plugin-list-installed.component.html',
- styleUrls: [ './plugin-list-installed.component.scss' ]
+ styleUrls: [
+ '../shared/toggle-plugin-type.scss',
+ './plugin-list-installed.component.scss'
+ ]
})
export class PluginListInstalledComponent implements OnInit {
pluginTypeOptions: { label: string, value: PluginType }[] = []
constructor (
private i18n: I18n,
private pluginService: PluginApiService,
- private notifier: Notifier
+ private notifier: Notifier,
+ private confirmService: ConfirmService,
+ private router: Router,
+ private route: ActivatedRoute
) {
this.pluginTypeOptions = this.pluginService.getPluginTypeOptions()
}
ngOnInit () {
+ const query = this.route.snapshot.queryParams
+ if (query['pluginType']) this.pluginType = parseInt(query['pluginType'], 10)
+
this.reloadPlugins()
}
this.pagination.currentPage = 1
this.plugins = []
+ this.router.navigate([], { queryParams: { pluginType: this.pluginType }})
+
this.loadMorePlugins()
}
return this.i18n('You don\'t have themes installed yet.')
}
+
+ async uninstall (plugin: PeerTubePlugin) {
+ const res = await this.confirmService.confirm(
+ this.i18n('Do you really want to uninstall {{pluginName}}?', { pluginName: plugin.name }),
+ this.i18n('Uninstall')
+ )
+ if (res === false) return
+
+ this.pluginService.uninstall(plugin.name, plugin.type)
+ .subscribe(
+ () => {
+ this.notifier.success(this.i18n('{{pluginName}} uninstalled.', { pluginName: plugin.name }))
+
+ this.plugins = this.plugins.filter(p => p.name !== plugin.name)
+ this.pagination.totalItems--
+ },
+
+ err => this.notifier.error(err.message)
+ )
+ }
+
+ getShowRouterLink (plugin: PeerTubePlugin) {
+ return [ '/admin', 'plugins', 'show', this.pluginService.nameToNpmName(plugin.name, plugin.type) ]
+ }
}
@Component({
selector: 'my-plugin-search',
templateUrl: './plugin-search.component.html',
- styleUrls: [ './plugin-search.component.scss' ]
+ styleUrls: [
+ '../shared/toggle-plugin-type.scss',
+ './plugin-search.component.scss'
+ ]
})
export class PluginSearchComponent implements OnInit {
pluginTypeOptions: { label: string, value: PluginType }[] = []
+<ng-container *ngIf="plugin">
+
+ <h2>
+ <ng-container>{{ pluginTypeLabel }}</ng-container>
+ {{ plugin.name }}
+ </h2>
+
+ <form *ngIf="hasRegisteredSettings()" role="form" (ngSubmit)="formValidated()" [formGroup]="form">
+ <div class="form-group" *ngFor="let setting of registeredSettings">
+ <label [attr.for]="setting.name">{{ setting.label }}</label>
+
+ <input *ngIf="setting.type === 'input'" type="text" [id]="setting.name" [formControlName]="setting.name" />
+
+ <div *ngIf="formErrors[setting.name]" class="form-error">
+ {{ formErrors[setting.name] }}
+ </div>
+ </div>
+
+ <input type="submit" i18n value="Update plugin settings" [disabled]="!form.valid">
+ </form>
+
+ <div *ngIf="!hasRegisteredSettings()" i18n class="no-settings">
+ This {{ pluginTypeLabel }} does not have settings.
+ </div>
+
+</ng-container>
@import '_variables';
@import '_mixins';
+
+h2 {
+ margin-bottom: 20px;
+}
+
+input:not([type=submit]) {
+ @include peertube-input-text(340px);
+ display: block;
+}
+
+.peertube-select-container {
+ @include peertube-select-container(340px);
+}
+
+input[type=submit], button {
+ @include peertube-button;
+ @include orange-button;
+
+ margin-top: 10px;
+}
-import { Component, OnInit } from '@angular/core'
+import { Component, OnDestroy, OnInit } from '@angular/core'
+import { PeerTubePlugin } from '@shared/models/plugins/peertube-plugin.model'
+import { I18n } from '@ngx-translate/i18n-polyfill'
+import { PluginApiService } from '@app/+admin/plugins/shared/plugin-api.service'
+import { Notifier } from '@app/core'
+import { ActivatedRoute } from '@angular/router'
+import { Subscription } from 'rxjs'
+import { map, switchMap } from 'rxjs/operators'
+import { RegisterSettingOptions } from '@shared/models/plugins/register-setting.model'
+import { BuildFormArgument, BuildFormDefaultValues, FormReactive, FormValidatorService } from '@app/shared'
@Component({
selector: 'my-plugin-show-installed',
templateUrl: './plugin-show-installed.component.html',
styleUrls: [ './plugin-show-installed.component.scss' ]
})
-export class PluginShowInstalledComponent implements OnInit {
+export class PluginShowInstalledComponent extends FormReactive implements OnInit, OnDestroy{
+ plugin: PeerTubePlugin
+ registeredSettings: RegisterSettingOptions[] = []
+ pluginTypeLabel: string
+
+ private sub: Subscription
+
+ constructor (
+ protected formValidatorService: FormValidatorService,
+ private i18n: I18n,
+ private pluginService: PluginApiService,
+ private notifier: Notifier,
+ private route: ActivatedRoute
+ ) {
+ super()
+ }
ngOnInit () {
+ this.sub = this.route.params.subscribe(
+ routeParams => {
+ const npmName = routeParams['npmName']
+
+ this.loadPlugin(npmName)
+ }
+ )
+ }
+
+ ngOnDestroy () {
+ if (this.sub) this.sub.unsubscribe()
+ }
+
+ formValidated () {
+ const settings = this.form.value
+
+ this.pluginService.updatePluginSettings(this.plugin.name, this.plugin.type, settings)
+ .subscribe(
+ () => {
+ this.notifier.success(this.i18n('Settings updated.'))
+ },
+
+ err => this.notifier.error(err.message)
+ )
+ }
+
+ hasRegisteredSettings () {
+ return Array.isArray(this.registeredSettings) && this.registeredSettings.length !== 0
+ }
+
+ private loadPlugin (npmName: string) {
+ this.pluginService.getPlugin(npmName)
+ .pipe(switchMap(plugin => {
+ return this.pluginService.getPluginRegisteredSettings(plugin.name, plugin.type)
+ .pipe(map(data => ({ plugin, registeredSettings: data.settings })))
+ }))
+ .subscribe(
+ ({ plugin, registeredSettings }) => {
+ this.plugin = plugin
+ this.registeredSettings = registeredSettings
+
+ this.pluginTypeLabel = this.pluginService.getPluginTypeLabel(this.plugin.type)
+
+ this.buildSettingsForm()
+ },
+
+ err => this.notifier.error(err.message)
+ )
+ }
+
+ private buildSettingsForm () {
+ const defaultValues: BuildFormDefaultValues = {}
+ const buildOptions: BuildFormArgument = {}
+ const settingsValues: any = {}
+
+ for (const setting of this.registeredSettings) {
+ buildOptions[ setting.name ] = null
+ settingsValues[ setting.name ] = this.getSetting(setting.name)
+ }
+
+ this.buildForm(buildOptions)
+
+ this.form.patchValue(settingsValues)
+ }
+
+ private getSetting (name: string) {
+ const settings = this.plugin.settings
+
+ if (settings && settings[name]) return settings[name]
+
+ const registered = this.registeredSettings.find(r => r.name === name)
+ return registered.default
}
}
}
},
{
- path: 'show/:name',
+ path: 'show/:npmName',
component: PluginShowInstalledComponent,
data: {
meta: {
import { ComponentPagination } from '@app/shared/rest/component-pagination.model'
import { ResultList } from '@shared/models'
import { PeerTubePlugin } from '@shared/models/plugins/peertube-plugin.model'
+import { ManagePlugin } from '@shared/models/plugins/manage-plugin.model'
+import { InstallPlugin } from '@shared/models/plugins/install-plugin.model'
+import { RegisterSettingOptions } from '@shared/models/plugins/register-setting.model'
@Injectable()
export class PluginApiService {
getPluginTypeOptions () {
return [
{
- label: this.i18n('Plugin'),
+ label: this.i18n('Plugins'),
value: PluginType.PLUGIN
},
{
- label: this.i18n('Theme'),
+ label: this.i18n('Themes'),
value: PluginType.THEME
}
]
}
+ getPluginTypeLabel (type: PluginType) {
+ if (type === PluginType.PLUGIN) {
+ return this.i18n('plugin')
+ }
+
+ return this.i18n('theme')
+ }
+
getPlugins (
type: PluginType,
componentPagination: ComponentPagination,
return this.authHttp.get<ResultList<PeerTubePlugin>>(PluginApiService.BASE_APPLICATION_URL, { params })
.pipe(catchError(res => this.restExtractor.handleError(res)))
}
+
+ getPlugin (npmName: string) {
+ const path = PluginApiService.BASE_APPLICATION_URL + '/' + npmName
+
+ return this.authHttp.get<PeerTubePlugin>(path)
+ .pipe(catchError(res => this.restExtractor.handleError(res)))
+ }
+
+ getPluginRegisteredSettings (pluginName: string, pluginType: PluginType) {
+ const path = PluginApiService.BASE_APPLICATION_URL + '/' + this.nameToNpmName(pluginName, pluginType) + '/registered-settings'
+
+ return this.authHttp.get<{ settings: RegisterSettingOptions[] }>(path)
+ .pipe(catchError(res => this.restExtractor.handleError(res)))
+ }
+
+ updatePluginSettings (pluginName: string, pluginType: PluginType, settings: any) {
+ const path = PluginApiService.BASE_APPLICATION_URL + '/' + this.nameToNpmName(pluginName, pluginType) + '/settings'
+
+ return this.authHttp.put(path, { settings })
+ .pipe(catchError(res => this.restExtractor.handleError(res)))
+ }
+
+ uninstall (pluginName: string, pluginType: PluginType) {
+ const body: ManagePlugin = {
+ npmName: this.nameToNpmName(pluginName, pluginType)
+ }
+
+ return this.authHttp.post(PluginApiService.BASE_APPLICATION_URL + '/uninstall', body)
+ .pipe(catchError(res => this.restExtractor.handleError(res)))
+ }
+
+ install (npmName: string) {
+ const body: InstallPlugin = {
+ npmName
+ }
+
+ return this.authHttp.post(PluginApiService.BASE_APPLICATION_URL + '/install', body)
+ .pipe(catchError(res => this.restExtractor.handleError(res)))
+ }
+
+ nameToNpmName (name: string, type: PluginType) {
+ const prefix = type === PluginType.PLUGIN
+ ? 'peertube-plugin-'
+ : 'peertube-theme-'
+
+ return prefix + name
+ }
+
+ pluginTypeFromNpmName (npmName: string) {
+ return npmName.startsWith('peertube-plugin-')
+ ? PluginType.PLUGIN
+ : PluginType.THEME
+ }
}
--- /dev/null
+@import '_variables';
+@import '_mixins';
+
+.toggle-plugin-type {
+ display: flex;
+ justify-content: center;
+ margin-bottom: 30px;
+
+ p-selectButton {
+ /deep/ {
+ .ui-button-text {
+ font-size: 15px;
+ }
+
+ .ui-button.ui-state-active {
+ background-color: var(--mainColor);
+ border-color: var(--mainColor);
+ }
+ }
+ }
+}
//@import '~bootstrap/scss/custom-forms';
@import '~bootstrap/scss/nav';
//@import '~bootstrap/scss/navbar';
-//@import '~bootstrap/scss/card';
+@import '~bootstrap/scss/card';
//@import '~bootstrap/scss/breadcrumb';
//@import '~bootstrap/scss/pagination';
@import '~bootstrap/scss/badge';
import { PluginModel } from '../../models/server/plugin'
import { UserRight } from '../../../shared/models/users'
import {
- enabledPluginValidator,
+ existingPluginValidator,
installPluginValidator,
listPluginsValidator,
uninstallPluginValidator,
asyncMiddleware(listPlugins)
)
-pluginRouter.get('/:pluginName/settings',
+pluginRouter.get('/:npmName',
authenticate,
ensureUserHasRight(UserRight.MANAGE_PLUGINS),
- asyncMiddleware(enabledPluginValidator),
- asyncMiddleware(listPluginSettings)
+ asyncMiddleware(existingPluginValidator),
+ getPlugin
)
-pluginRouter.put('/:pluginName/settings',
+pluginRouter.get('/:npmName/registered-settings',
+ authenticate,
+ ensureUserHasRight(UserRight.MANAGE_PLUGINS),
+ asyncMiddleware(existingPluginValidator),
+ asyncMiddleware(getPluginRegisteredSettings)
+)
+
+pluginRouter.put('/:npmName/settings',
authenticate,
ensureUserHasRight(UserRight.MANAGE_PLUGINS),
updatePluginSettingsValidator,
- asyncMiddleware(enabledPluginValidator),
+ asyncMiddleware(existingPluginValidator),
asyncMiddleware(updatePluginSettings)
)
return res.json(getFormattedObjects(resultList.data, resultList.total))
}
+function getPlugin (req: express.Request, res: express.Response) {
+ const plugin = res.locals.plugin
+
+ return res.json(plugin.toFormattedJSON())
+}
+
async function installPlugin (req: express.Request, res: express.Response) {
const body: InstallPlugin = req.body
return res.sendStatus(204)
}
-async function listPluginSettings (req: express.Request, res: express.Response) {
+async function getPluginRegisteredSettings (req: express.Request, res: express.Response) {
const plugin = res.locals.plugin
const settings = await PluginManager.Instance.getSettings(plugin.name)
return exists(engine) && exists(engine.peertube)
}
+function isPluginHomepage (value: string) {
+ return isUrlValid(value)
+}
+
function isStaticDirectoriesValid (staticDirs: any) {
if (!exists(staticDirs) || typeof staticDirs !== 'object') return false
return isNpmPluginNameValid(packageJSON.name) &&
isPluginDescriptionValid(packageJSON.description) &&
isPluginEngineValid(packageJSON.engine) &&
- isUrlValid(packageJSON.homepage) &&
+ isPluginHomepage(packageJSON.homepage) &&
exists(packageJSON.author) &&
isUrlValid(packageJSON.bugs) &&
(pluginType === PluginType.THEME || isSafePath(packageJSON.library)) &&
isPluginTypeValid,
isPackageJSONValid,
isThemeValid,
+ isPluginHomepage,
isPluginVersionValid,
isPluginNameValid,
isPluginDescriptionValid,
async runHook (hookName: string, param?: any) {
let result = param
+ if (!this.hooks[hookName]) return result
+
const wait = hookName.startsWith('static:')
for (const hook of this.hooks[hookName]) {
: await installNpmPlugin(toInstall, version)
name = fromDisk ? basename(toInstall) : toInstall
- const pluginType = name.startsWith('peertube-theme-') ? PluginType.THEME : PluginType.PLUGIN
- const pluginName = this.normalizePluginName(name)
+ const pluginType = PluginModel.getTypeFromNpmName(name)
+ const pluginName = PluginModel.normalizePluginName(name)
const packageJSON = this.getPackageJSON(pluginName, pluginType)
if (!isPackageJSONValid(packageJSON, pluginType)) {
[ plugin ] = await PluginModel.upsert({
name: pluginName,
description: packageJSON.description,
+ homepage: packageJSON.homepage,
type: pluginType,
version: packageJSON.version,
enabled: true,
await this.registerPluginOrTheme(plugin)
}
- async uninstall (packageName: string) {
- logger.info('Uninstalling plugin %s.', packageName)
+ async uninstall (npmName: string) {
+ logger.info('Uninstalling plugin %s.', npmName)
- const pluginName = this.normalizePluginName(packageName)
+ const pluginName = PluginModel.normalizePluginName(npmName)
try {
await this.unregister(pluginName)
logger.warn('Cannot unregister plugin %s.', pluginName, { err })
}
- const plugin = await PluginModel.load(pluginName)
+ const plugin = await PluginModel.loadByNpmName(npmName)
if (!plugin || plugin.uninstalled === true) {
- logger.error('Cannot uninstall plugin %s: it does not exist or is already uninstalled.', packageName)
+ logger.error('Cannot uninstall plugin %s: it does not exist or is already uninstalled.', npmName)
return
}
await plugin.save()
- await removeNpmPlugin(packageName)
+ await removeNpmPlugin(npmName)
- logger.info('Plugin %s uninstalled.', packageName)
+ logger.info('Plugin %s uninstalled.', npmName)
}
// ###################### Private register ######################
return join(CONFIG.STORAGE.PLUGINS_DIR, 'node_modules', prefix + pluginName)
}
- private normalizePluginName (name: string) {
- return name.replace(/^peertube-((theme)|(plugin))-/, '')
- }
-
// ###################### Private getters ######################
private getRegisteredPluginsOrThemes (type: PluginType) {
body('npmName').custom(isNpmPluginNameValid).withMessage('Should have a valid npm name'),
(req: express.Request, res: express.Response, next: express.NextFunction) => {
- logger.debug('Checking managePluginValidator parameters', { parameters: req.body })
+ logger.debug('Checking uninstallPluginValidator parameters', { parameters: req.body })
if (areValidationErrors(req, res)) return
}
]
-const enabledPluginValidator = [
- body('name').custom(isPluginNameValid).withMessage('Should have a valid plugin name'),
+const existingPluginValidator = [
+ param('npmName').custom(isPluginNameValid).withMessage('Should have a valid plugin name'),
async (req: express.Request, res: express.Response, next: express.NextFunction) => {
- logger.debug('Checking enabledPluginValidator parameters', { parameters: req.body })
+ logger.debug('Checking enabledPluginValidator parameters', { parameters: req.params })
if (areValidationErrors(req, res)) return
- const plugin = await PluginModel.load(req.body.name)
+ const plugin = await PluginModel.loadByNpmName(req.params.npmName)
if (!plugin) {
return res.status(404)
.json({ error: 'Plugin not found' })
servePluginStaticDirectoryValidator,
updatePluginSettingsValidator,
uninstallPluginValidator,
- enabledPluginValidator,
+ existingPluginValidator,
installPluginValidator,
listPluginsValidator
}
import { AllowNull, Column, CreatedAt, DataType, DefaultScope, Is, Model, Table, UpdatedAt } from 'sequelize-typescript'
import { getSort, throwIfNotValid } from '../utils'
import {
- isPluginDescriptionValid,
+ isPluginDescriptionValid, isPluginHomepage,
isPluginNameValid,
isPluginTypeValid,
isPluginVersionValid
tableName: 'plugin',
indexes: [
{
- fields: [ 'name' ],
+ fields: [ 'name', 'type' ],
unique: true
}
]
@Column
description: string
+ @AllowNull(false)
+ @Is('PluginHomepage', value => throwIfNotValid(value, isPluginHomepage, 'homepage'))
+ @Column
+ homepage: string
+
@AllowNull(true)
@Column(DataType.JSONB)
settings: any
return PluginModel.findAll(query)
}
- static load (pluginName: string) {
+ static loadByNpmName (npmName: string) {
+ const name = this.normalizePluginName(npmName)
+ const type = this.getTypeFromNpmName(npmName)
+
const query = {
where: {
- name: pluginName
+ name,
+ type
}
}
})
}
+ static normalizePluginName (name: string) {
+ return name.replace(/^peertube-((theme)|(plugin))-/, '')
+ }
+
+ static getTypeFromNpmName (npmName: string) {
+ return npmName.startsWith('peertube-plugin-')
+ ? PluginType.PLUGIN
+ : PluginType.THEME
+ }
+
toFormattedJSON (): PeerTubePlugin {
return {
name: this.name,
uninstalled: this.uninstalled,
peertubeEngine: this.peertubeEngine,
description: this.description,
+ homepage: this.homepage,
settings: this.settings,
createdAt: this.createdAt,
updatedAt: this.updatedAt
uninstalled: boolean
peertubeEngine: string
description: string
- settings: any
+ homepage: string
+ settings: { [ name: string ]: string }
createdAt: Date
updatedAt: Date
}
projects / github / Chocobozzz / PeerTube.git / commitdiff
