mirrors/etherpad-lite
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2025-04-24 17:36:14 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 33

PadMessageHandler: Rename client to socket

Browse source 
The `client` variable is actually a socket.io Socket object. Rename it
to reduce confusion.
This commit is contained in:
Richard Hansen 2020-10-20 18:38:56 -04:00 • committed by John McLear
parent cfc7e47db0
commit 91268e14b7
2 changed files with 137 additions and 159 deletions
Download patch file Download diff file Expand all files Collapse all files

22
doc/api/hooks_server-side.md
View file

@ -513,7 +513,8 @@ Called from: src/node/handler/PadMessageHandler.js
Things in context:
1. message - the message being handled
2. client - the socket.io Socket object
2. socket - the socket.io Socket object
3. client - **deprecated** synonym of socket
This hook allows plugins to drop or modify incoming socket.io messages from
clients, before Etherpad processes them.
@ -526,19 +527,19 @@ Examples:
```
// Using an async function:
exports.handleMessage = async (hookName, {message, client}) => {
exports.handleMessage = async (hookName, {message, socket}) => {
if (message.type === 'USERINFO_UPDATE') {
// Force the display name to the name associated with the account.
const user = client.client.request.session.user || {};
const user = socket.client.request.session.user || {};
if (user.name) message.data.userInfo.name = user.name;
}
};
// Using a regular function:
exports.handleMessage = (hookName, {message, client}, callback) => {
exports.handleMessage = (hookName, {message, socket}, callback) => {
if (message.type === 'USERINFO_UPDATE') {
// Force the display name to the name associated with the account.
const user = client.client.request.session.user || {};
const user = socket.client.request.session.user || {};
if (user.name) message.data.userInfo.name = user.name;
}
return cb();
@ -551,7 +552,8 @@ Called from: src/node/handler/PadMessageHandler.js
Things in context:
1. message - the message being handled
2. client - the socket.io Socket object
2. socket - the socket.io Socket object
3. client - **deprecated** synonym of socket
This hook allows plugins to grant temporary write access to a pad. It is called
for each incoming message from a client. If write access is granted, it applies
@ -568,14 +570,14 @@ Examples:
```
// Using an async function:
exports.handleMessageSecurity = async (hookName, {message, client}) => {
if (shouldGrantWriteAccess(message, client)) return true;
exports.handleMessageSecurity = async (hookName, {message, socket}) => {
if (shouldGrantWriteAccess(message, socket)) return true;
return;
};
// Using a regular function:
exports.handleMessageSecurity = (hookName, {message, client}, callback) => {
if (shouldGrantWriteAccess(message, client)) return callback(true);
exports.handleMessageSecurity = (hookName, {message, socket}, callback) => {
if (shouldGrantWriteAccess(message, socket)) return callback(true);
return callback();
};
```