X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fplugins%2Fguide.md;h=4a0d318a7428eda08541adefc502559c72418582;hb=06aad80165d09a8863ab8103149a8ff518b10641;hp=20cbec5c739bff8a88e97a106831386567631c7a;hpb=a786d8a08bf99f339bf16808f46e160404497ae2;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md index 20cbec5c7..4a0d318a7 100644 --- a/support/doc/plugins/guide.md +++ b/support/doc/plugins/guide.md @@ -3,27 +3,33 @@ - - [Concepts](#concepts) - [Hooks](#hooks) - [Static files](#static-files) - [CSS](#css) - - [Server helpers (only for plugins)](#server-helpers-only-for-plugins) + - [Server API (only for plugins)](#server-api-only-for-plugins) - [Settings](#settings) - [Storage](#storage) - [Update video constants](#update-video-constants) - [Add custom routes](#add-custom-routes) - [Add external auth methods](#add-external-auth-methods) - [Add new transcoding profiles](#add-new-transcoding-profiles) - - [Client helpers (themes & plugins)](#client-helpers-themes--plugins) + - [Server helpers](#server-helpers) + - [Client API (themes & plugins)](#client-api-themes--plugins) - [Plugin static route](#plugin-static-route) - [Notifier](#notifier) - [Markdown Renderer](#markdown-renderer) + - [Auth header](#auth-header) + - [Plugin router route](#plugin-router-route) - [Custom Modal](#custom-modal) - [Translate](#translate) - [Get public settings](#get-public-settings) - [Get server config](#get-server-config) - [Add custom fields to video form](#add-custom-fields-to-video-form) + - [Register settings script](#register-settings-script) + - [Plugin selector on HTML elements](#plugin-selector-on-html-elements) + - [HTML placeholder elements](#html-placeholder-elements) + - [Add/remove left menu links](#addremove-left-menu-links) - [Publishing](#publishing) - [Write a plugin/theme](#write-a-plugintheme) - [Clone the quickstart repository](#clone-the-quickstart-repository) @@ -35,6 +41,7 @@ - [Build your plugin](#build-your-plugin) - [Test your plugin/theme](#test-your-plugintheme) - [Publish](#publish) + - [Unpublish](#unpublish) - [Plugin & Theme hooks/helpers API](#plugin--theme-hookshelpers-api) - [Tips](#tips) - [Compatibility with PeerTube](#compatibility-with-peertube) @@ -101,6 +108,20 @@ async function register ({ } ``` +Hooks prefixed by `action:api` also give access the original **express** [Request](http://expressjs.com/en/api.html#req) and [Response](http://expressjs.com/en/api.html#res): + +```js +async function register ({ + registerHook, + peertubeHelpers: { logger } +}) { + registerHook({ + target: 'action:api.video.updated', + handler: ({ req, res }) => logger.debug('original request parameters', { params: req.params }) + }) +} +``` + On client side, these hooks are registered by the `clientScripts` files defined in `package.json`. All client scripts have scopes so PeerTube client only loads scripts it needs: @@ -154,31 +175,53 @@ body#custom-css { } ``` -### Server helpers (only for plugins) +### Server API (only for plugins) #### Settings Plugins can register settings, that PeerTube will inject in the administration interface. +The following fields will be automatically translated using the plugin translation files: `label`, `html`, `descriptionHTML`, `options.label`. +**These fields are injected in the plugin settings page as HTML, so pay attention to your translation files.** Example: ```js -registerSetting({ - name: 'admin-name', - label: 'Admin name', - type: 'input', - // type: input | input-checkbox | input-password | input-textarea | markdown-text | markdown-enhanced - default: 'my super name' -}) +function register (...) { + registerSetting({ + name: 'admin-name', + label: 'Admin name', -const adminName = await settingsManager.getSetting('admin-name') + type: 'input', + // type: 'input' | 'input-checkbox' | 'input-password' | 'input-textarea' | 'markdown-text' | 'markdown-enhanced' | 'select' | 'html' -const result = await settingsManager.getSettings([ 'admin-name', 'admin-password' ]) -result['admin-name] + // If type: 'select', give the select available options + options: [ + { label: 'Label 1', value: 'value1' }, + { label: 'Label 2', value: 'value2' } + ], -settingsManager.onSettingsChange(settings => { - settings['admin-name]) -}) + // If type: 'html', set the HTML that will be injected in the page + html: 'Hello

' + + // Optional + descriptionHTML: 'The purpose of this field is...', + + default: 'my super name', + + // If the setting is not private, anyone can view its value (client code included) + // If the setting is private, only server-side hooks can access it + private: false + }) + + const adminName = await settingsManager.getSetting('admin-name') + + const result = await settingsManager.getSettings([ 'admin-name', 'admin-password' ]) + result['admin-name] + + settingsManager.onSettingsChange(settings => { + settings['admin-name'] + }) +} ``` #### Storage @@ -188,26 +231,56 @@ Plugins can store/load JSON data, that PeerTube will store in its database (so d Example: ```js -const value = await storageManager.getData('mykey') -await storageManager.storeData('mykey', { subkey: 'value' }) +function register ({ + storageManager +}) { + const value = await storageManager.getData('mykey') + await storageManager.storeData('mykey', { subkey: 'value' }) +} +``` + +You can also store files in the plugin data directory (`/{plugins-directory}/data/{npm-plugin-name}`) **in PeerTube >= 3.2**. +This directory and its content won't be deleted when your plugin is uninstalled/upgraded. + +```js +function register ({ + storageManager, + peertubeHelpers +}) { + const basePath = peertubeHelpers.plugin.getDataDirectoryPath() + + fs.writeFile(path.join(basePath, 'filename.txt'), 'content of my file', function (err) { + ... + }) +} ``` #### Update video constants -You can add/delete video categories, licences or languages using the appropriate managers: +You can add/delete video categories, licences or languages using the appropriate constant managers: ```js -videoLanguageManager.addLanguage('al_bhed', 'Al Bhed') -videoLanguageManager.deleteLanguage('fr') +function register ({ + videoLanguageManager, + videoCategoryManager, + videoLicenceManager, + videoPrivacyManager, + playlistPrivacyManager +}) { + videoLanguageManager.addConstant('al_bhed', 'Al Bhed') + videoLanguageManager.deleteConstant('fr') -videoCategoryManager.addCategory(42, 'Best category') -videoCategoryManager.deleteCategory(1) // Music + videoCategoryManager.addConstant(42, 'Best category') + videoCategoryManager.deleteConstant(1) // Music + videoCategoryManager.resetConstants() // Reset to initial categories + videoCategoryManager.getConstants() // Retrieve all category constants -videoLicenceManager.addLicence(42, 'Best licence') -videoLicenceManager.deleteLicence(7) // Public domain + videoLicenceManager.addConstant(42, 'Best licence') + videoLicenceManager.deleteConstant(7) // Public domain -videoPrivacyManager.deletePrivacy(2) // Remove Unlisted video privacy -playlistPrivacyManager.deletePlaylistPrivacy(3) // Remove Private video playlist privacy + videoPrivacyManager.deleteConstant(2) // Remove Unlisted video privacy + playlistPrivacyManager.deleteConstant(3) // Remove Private video playlist privacy +} ``` #### Add custom routes @@ -215,8 +288,28 @@ playlistPrivacyManager.deletePlaylistPrivacy(3) // Remove Private video playlist You can create custom routes using an [express Router](https://expressjs.com/en/4x/api.html#router) for your plugin: ```js -const router = getRouter() -router.get('/ping', (req, res) => res.json({ message: 'pong' })) +function register ({ + router +}) { + const router = getRouter() + router.get('/ping', (req, res) => res.json({ message: 'pong' })) + + // Users are automatically authenticated + router.get('/auth', async (res, res) => { + const user = await peertubeHelpers.user.getAuthUser(res) + + const isAdmin = user.role === 0 + const isModerator = user.role === 1 + const isUser = user.role === 2 + + res.json({ + username: user.username, + isAdmin, + isModerator, + isUser + }) + }) +} ``` The `ping` route can be accessed using: @@ -229,80 +322,86 @@ The `ping` route can be accessed using: If you want to add a classic username/email and password auth method (like [LDAP](https://framagit.org/framasoft/peertube/official-plugins/-/tree/master/peertube-plugin-auth-ldap) for example): ```js -registerIdAndPassAuth({ - authName: 'my-auth-method', +function register (...) { - // PeerTube will try all id and pass plugins in the weight DESC order - // Exposing this value in the plugin settings could be interesting - getWeight: () => 60, + registerIdAndPassAuth({ + authName: 'my-auth-method', - // Optional function called by PeerTube when the user clicked on the logout button - onLogout: user => { - console.log('User %s logged out.', user.username') - }, + // PeerTube will try all id and pass plugins in the weight DESC order + // Exposing this value in the plugin settings could be interesting + getWeight: () => 60, - // Optional function called by PeerTube when the access token or refresh token are generated/refreshed - hookTokenValidity: ({ token, type }) => { - if (type === 'access') return { valid: true } - if (type === 'refresh') return { valid: false } - }, + // Optional function called by PeerTube when the user clicked on the logout button + onLogout: user => { + console.log('User %s logged out.', user.username') + }, - // Used by PeerTube when the user tries to authenticate - login: ({ id, password }) => { - if (id === 'user' && password === 'super password') { - return { - username: 'user' - email: 'user@example.com' - role: 2 - displayName: 'User display name' + // Optional function called by PeerTube when the access token or refresh token are generated/refreshed + hookTokenValidity: ({ token, type }) => { + if (type === 'access') return { valid: true } + if (type === 'refresh') return { valid: false } + }, + + // Used by PeerTube when the user tries to authenticate + login: ({ id, password }) => { + if (id === 'user' && password === 'super password') { + return { + username: 'user' + email: 'user@example.com' + role: 2 + displayName: 'User display name' + } } - } - // Auth failed - return null - } -}) + // Auth failed + return null + } + }) -// Unregister this auth method -unregisterIdAndPassAuth('my-auth-method') + // Unregister this auth method + unregisterIdAndPassAuth('my-auth-method') +} ``` You can also add an external auth method (like [OpenID](https://framagit.org/framasoft/peertube/official-plugins/-/tree/master/peertube-plugin-auth-openid-connect), [SAML2](https://framagit.org/framasoft/peertube/official-plugins/-/tree/master/peertube-plugin-auth-saml2) etc): ```js -// result contains the userAuthenticated auth method you can call to authenticate a user -const result = registerExternalAuth({ - authName: 'my-auth-method', +function register (...) { - // Will be displayed in a button next to the login form - authDisplayName: () => 'Auth method' + // result contains the userAuthenticated auth method you can call to authenticate a user + const result = registerExternalAuth({ + authName: 'my-auth-method', - // If the user click on the auth button, PeerTube will forward the request in this function - onAuthRequest: (req, res) => { - res.redirect('https://external-auth.example.com/auth') - }, + // Will be displayed in a button next to the login form + authDisplayName: () => 'Auth method' - // Same than registerIdAndPassAuth option - // onLogout: ... + // If the user click on the auth button, PeerTube will forward the request in this function + onAuthRequest: (req, res) => { + res.redirect('https://external-auth.example.com/auth') + }, - // Same than registerIdAndPassAuth option - // hookTokenValidity: ... -}) + // Same than registerIdAndPassAuth option + // onLogout: ... -router.use('/external-auth-callback', (req, res) => { - // Forward the request to PeerTube - result.userAuthenticated({ - req, - res, - username: 'user' - email: 'user@example.com' - role: 2 - displayName: 'User display name' + // Same than registerIdAndPassAuth option + // hookTokenValidity: ... }) -}) -// Unregister this external auth method -unregisterExternalAuth('my-auth-method) + router.use('/external-auth-callback', (req, res) => { + // Forward the request to PeerTube + result.userAuthenticated({ + req, + res, + username: 'user' + email: 'user@example.com' + role: 2 + displayName: 'User display name' + }) + }) + + // Unregister this external auth method + unregisterExternalAuth('my-auth-method) +} ``` #### Add new transcoding profiles @@ -323,7 +422,16 @@ async function register ({ const streamString = streamNum ? ':' + streamNum : '' // You can also return a promise + // All these options are optional return { + scaleFilter: { + // Used to define an alternative scale filter, needed by some encoders + // Default to 'scale' + name: 'scale_vaapi' + }, + // Default to [] + inputOptions: [], + // Default to [] outputOptions: [ // Use a custom bitrate '-b' + streamString + ' 10K' @@ -374,6 +482,7 @@ async function register ({ { const builder = () => { return { + inputOptions: [], outputOptions: [] } } @@ -393,15 +502,44 @@ async function register ({ } ``` -### Client helpers (themes & plugins) +During live transcode input options are applied once for each target resolution. +Plugins are responsible for detecting such situation and applying input options only once if necessary. + +#### Server helpers + +PeerTube provides your plugin some helpers. For example: + +```js +async function register ({ + peertubeHelpers +}) { + // Block a server + { + const serverActor = await peertubeHelpers.server.getServerActor() + + await peertubeHelpers.moderation.blockServer({ byAccountId: serverActor.Account.id, hostToBlock: '...' }) + } + + // Load a video + { + const video = await peertubeHelpers.videos.loadByUrl('...') + } +} +``` + +See the [plugin API reference](https://docs.joinpeertube.org/api-plugins) to see the complete helpers list. + +### Client API (themes & plugins) #### Plugin static route To get your plugin static route: ```js -const baseStaticUrl = peertubeHelpers.getBaseStaticRoute() -const imageUrl = baseStaticUrl + '/images/chocobo.png' +function register (...) { + const baseStaticUrl = peertubeHelpers.getBaseStaticRoute() + const imageUrl = baseStaticUrl + '/images/chocobo.png' +} ``` #### Notifier @@ -409,9 +547,11 @@ const imageUrl = baseStaticUrl + '/images/chocobo.png' To notify the user with the PeerTube ToastModule: ```js -const { notifier } = peertubeHelpers -notifier.success('Success message content.') -notifier.error('Error message content.') +function register (...) { + const { notifier } = peertubeHelpers + notifier.success('Success message content.') + notifier.error('Error message content.') +} ``` #### Markdown Renderer @@ -419,13 +559,60 @@ notifier.error('Error message content.') To render a formatted markdown text to HTML: ```js -const { markdownRenderer } = peertubeHelpers +function register (...) { + const { markdownRenderer } = peertubeHelpers + + await markdownRenderer.textMarkdownToHTML('**My Bold Text**') + // return My Bold Text + + await markdownRenderer.enhancedMarkdownToHTML('![alt-img](http://.../my-image.jpg)') + // return alt-img +} +``` + +#### Auth header + +**PeerTube >= 3.2** + +To make your own HTTP requests using the current authenticated user, use an helper to automatically set appropriate headers: + +```js +function register (...) { + registerHook({ + target: 'action:auth-user.information-loaded', + handler: ({ user }) => { + + // Useless because we have the same info in the ({ user }) parameter + // It's just an example + fetch('/api/v1/users/me', { + method: 'GET', + headers: peertubeHelpers.getAuthHeader() + }).then(res => res.json()) + .then(data => console.log('Hi %s.', data.username)) + } + }) +} +``` + +#### Plugin router route -await markdownRenderer.textMarkdownToHTML('**My Bold Text**') -// return My Bold Text +**PeerTube >= 3.3** -await markdownRenderer.enhancedMarkdownToHTML('![alt-img](http://.../my-image.jpg)') -// return alt-img +To get your plugin router route, you can use `peertubeHelpers.getBaseRouterRoute()`: + +```js +function register (...) { + registerHook({ + target: 'action:video-watch.video.loaded', + handler: ({ video }) => { + fetch(peertubeHelpers.getBaseRouterRoute() + '/my/plugin/api', { + method: 'GET', + headers: peertubeHelpers.getAuthHeader() + }).then(res => res.json()) + .then(data => console.log('Hi %s.', data)) + } + }) +} ``` #### Custom Modal @@ -433,17 +620,19 @@ await markdownRenderer.enhancedMarkdownToHTML('![alt-img](http://.../my-image.jp To show a custom modal: ```js - peertubeHelpers.showModal({ - title: 'My custom modal title', - content: '

My custom modal content

', - // Optionals parameters : - // show close icon - close: true, - // show cancel button and call action() after hiding modal - cancel: { value: 'cancel', action: () => {} }, - // show confirm button and call action() after hiding modal - confirm: { value: 'confirm', action: () => {} }, - }) +function register (...) { + peertubeHelpers.showModal({ + title: 'My custom modal title', + content: '

My custom modal content

', + // Optionals parameters : + // show close icon + close: true, + // show cancel button and call action() after hiding modal + cancel: { value: 'cancel', action: () => {} }, + // show confirm button and call action() after hiding modal + confirm: { value: 'confirm', action: () => {} }, + }) +} ``` #### Translate @@ -451,8 +640,10 @@ To show a custom modal: You can translate some strings of your plugin (PeerTube will use your `translations` object of your `package.json` file): ```js -peertubeHelpers.translate('User name') - .then(translation => console.log('Translated User name by ' + translation)) +function register (...) { + peertubeHelpers.translate('User name') + .then(translation => console.log('Translated User name by ' + translation)) +} ``` #### Get public settings @@ -460,24 +651,28 @@ peertubeHelpers.translate('User name') To get your public plugin settings: ```js -peertubeHelpers.getSettings() - .then(s => { - if (!s || !s['site-id'] || !s['url']) { - console.error('Matomo settings are not set.') - return - } +function register (...) { + peertubeHelpers.getSettings() + .then(s => { + if (!s || !s['site-id'] || !s['url']) { + console.error('Matomo settings are not set.') + return + } - // ... - }) + // ... + }) +} ``` #### Get server config ```js -peertubeHelpers.getServerConfig() - .then(config => { - console.log('Fetched server config.', config) - }) +function register (...) { + peertubeHelpers.getServerConfig() + .then(config => { + console.log('Fetched server config.', config) + }) +} ``` #### Add custom fields to video form @@ -491,11 +686,21 @@ async function register ({ registerVideoField, peertubeHelpers }) { name: 'my-field-name, label: 'My added field', descriptionHTML: 'Optional description', + + // type: 'input' | 'input-checkbox' | 'input-password' | 'input-textarea' | 'markdown-text' | 'markdown-enhanced' | 'select' | 'html' + // /!\ 'input-checkbox' could send "false" and "true" strings instead of boolean type: 'input-textarea', - default: '' + + default: '', + // Optional, to hide a field depending on the current form state + // liveVideo is in the options object when the user is creating/updating a live + // videoToUpdate is in the options object when the user is updating a video + hidden: ({ formValues, videoToUpdate, liveVideo }) => { + return formValues.pluginData['other-field'] === 'toto' + } } - for (const type of [ 'upload', 'import-url', 'import-torrent', 'update' ]) { + for (const type of [ 'upload', 'import-url', 'import-torrent', 'update', 'go-live' ]) { registerVideoField(commonOptions, { type }) } } @@ -540,10 +745,58 @@ async function register ({ }) } ``` + +#### Register settings script + +To hide some fields in your settings plugin page depending on the form state: + +```js +async function register ({ registerSettingsScript }) { + registerSettingsScript({ + isSettingHidden: options => { + if (options.setting.name === 'my-setting' && options.formValues['field45'] === '2') { + return true + } + + return false + } + }) +} +``` +#### Plugin selector on HTML elements + +PeerTube provides some selectors (using `id` HTML attribute) on important blocks so plugins can easily change their style. + +For example `#plugin-selector-login-form` could be used to hide the login form. + +See the complete list on https://docs.joinpeertube.org/api-plugins + +#### HTML placeholder elements + +PeerTube provides some HTML id so plugins can easily insert their own element: + +```js +async function register (...) { + const elem = document.createElement('div') + elem.className = 'hello-world-h4' + elem.innerHTML = '

Hello everybody! This is an element next to the player

' + + document.getElementById('plugin-placeholder-player-next').appendChild(elem) +} +``` + +See the complete list on https://docs.joinpeertube.org/api-plugins + +#### Add/remove left menu links + +Left menu links can be filtered (add/remove a section or add/remove links) using the `filter:left-menu.links.create.result` client hook. + + ### Publishing -PeerTube plugins and themes should be published on [NPM](https://www.npmjs.com/) so that PeerTube indexes -take into account your plugin (after ~ 1 day). An official PeerTube index is available on https://packages.joinpeertube.org/ (it's just a REST API, so don't expect a beautiful website). +PeerTube plugins and themes should be published on [NPM](https://www.npmjs.com/) so that PeerTube indexes take into account your plugin (after ~ 1 day). An official plugin index is available on [packages.joinpeertube.org](https://packages.joinpeertube.org/api/v1/plugins), with no interface to present packages. + +> The official plugin index source code is available at https://framagit.org/framasoft/peertube/plugin-index ## Write a plugin/theme @@ -639,7 +892,7 @@ If you want to translate strings of your plugin (like labels of your registered { ..., "translations": { - "fr-FR": "./languages/fr.json", + "fr": "./languages/fr.json", "pt-BR": "./languages/pt-BR.json" }, ... @@ -647,7 +900,6 @@ If you want to translate strings of your plugin (like labels of your registered ``` The key should be one of the locales defined in [i18n.ts](https://github.com/Chocobozzz/PeerTube/blob/develop/shared/models/i18n/i18n.ts). -You **must** use the complete locales (`fr-FR` instead of `fr`). Translation files are just objects, with the english sentence as the key and the translation as the value. `fr.json` could contain for example: @@ -729,6 +981,20 @@ $ npm publish Every time you want to publish another version of your plugin/theme, just update the `version` key from the `package.json` and republish it on NPM. Remember that the PeerTube index will take into account your new plugin/theme version after ~24 hours. +> If you need to force your plugin update on a specific __PeerTube__ instance, you may update the latest available version manually: +> ```sql +> UPDATE "plugin" SET "latestVersion" = 'X.X.X' WHERE "plugin"."name" = 'plugin-shortname'; +> ``` +> You'll then be able to click the __Update plugin__ button on the plugin list. + +### Unpublish + +If for a particular reason you don't want to maintain your plugin/theme anymore +you can deprecate it. The plugin index will automatically remove it preventing users to find/install it from the PeerTube admin interface: + +```bash +$ npm deprecate peertube-plugin-xxx@"> 0.0.0" "explain here why you deprecate your plugin/theme" +``` ## Plugin & Theme hooks/helpers API