libre-service.eu/pad.libre-service.eu-etherpad
libre-service.eu/pad.libre-service.eu-etherpad
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2025-01-19 14:13:34 +01:00
Code Issues Projects Releases Wiki Activity

pad: Pass color and display name in CLIENT_READY

Browse source
This commit is contained in:
Richard Hansen 2021-11-03 00:50:51 -04:00
parent 7a0d8cb52e
commit 56cb08f4c5
3 changed files with 22 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/node/handler/PadMessageHandler.js
View file

@ -814,6 +814,7 @@ const handleClientReady = async (socket, message) => {
const sessionInfo = sessioninfos[socket.id]; const sessionInfo = sessioninfos[socket.id];
// Check if the user has already disconnected. // Check if the user has already disconnected.
if (sessionInfo == null) return; if (sessionInfo == null) return;
assert(sessionInfo.author);
const padIds = await readOnlyManager.getIds(sessionInfo.auth.padID); const padIds = await readOnlyManager.getIds(sessionInfo.auth.padID);
sessionInfo.padId = padIds.padId; sessionInfo.padId = padIds.padId;
@ -823,10 +824,16 @@ const handleClientReady = async (socket, message) => {
await hooks.aCallAll('clientReady', message); // Deprecated due to awkward context. await hooks.aCallAll('clientReady', message); // Deprecated due to awkward context.
// get all authordata of this new user let {colorId: authorColorId, name: authorName} = message.userInfo || {};
assert(sessionInfo.author); if (authorColorId && !/^#(?:[0-9A-F]{3}){1,2}$/i.test(authorColorId)) {
const {colorId: authorColorId, name: authorName} = messageLogger.warn(`Ignoring invalid colorId in CLIENT_READY message: ${authorColorId}`);
await authorManager.getAuthor(sessionInfo.author); authorColorId = null;
}
await Promise.all([
authorName && authorManager.setAuthorName(sessionInfo.author, authorName),
authorColorId && authorManager.setAuthorColorId(sessionInfo.author, authorColorId),
]);
({colorId: authorColorId, name: authorName} = await authorManager.getAuthor(sessionInfo.author));
// load the pad-object from the database // load the pad-object from the database
const pad = await padManager.getPad(sessionInfo.padId); const pad = await padManager.getPad(sessionInfo.padId);

8
src/static/js/collab_client.js
View file

@ -245,14 +245,6 @@ const getCollabClient = (ace2editor, serverVars, initialUserInfo, options, _pad)
} else if (msg.type === 'USER_NEWINFO') { } else if (msg.type === 'USER_NEWINFO') {
const userInfo = msg.userInfo; const userInfo = msg.userInfo;
const id = userInfo.userId; const id = userInfo.userId;
// Avoid a race condition when setting colors. If our color was set by a
// query param, ignore our own "new user" message's color value.
if (id === initialUserInfo.userId && initialUserInfo.globalUserColor) {
msg.userInfo.colorId = initialUserInfo.globalUserColor;
}
if (userSet[id]) { if (userSet[id]) {
userSet[id] = userInfo; userSet[id] = userInfo;
callbacks.onUpdateUserInfo(userInfo); callbacks.onUpdateUserInfo(userInfo);

11
src/static/js/pad.js
View file

@ -184,12 +184,23 @@ const sendClientReady = (isReconnect) => {
Cookies.set('token', token, {expires: 60}); Cookies.set('token', token, {expires: 60});
} }
// If known, propagate the display name and color to the server in the CLIENT_READY message. This
// allows the server to include the values in its reply CLIENT_VARS message (which avoids
// initialization race conditions) and in the USER_NEWINFO messages sent to the other users on the
// pad (which enables them to display a user join notification with the correct name).
const params = getUrlVars();
const userInfo = {
colorId: params.get('userColor'),
name: params.get('userName'),
};
const msg = { const msg = {
component: 'pad', component: 'pad',
type: 'CLIENT_READY', type: 'CLIENT_READY',
padId, padId,
sessionID: Cookies.get('sessionID'), sessionID: Cookies.get('sessionID'),
token, token,
userInfo,
}; };
// this is a reconnect, lets tell the server our revisionnumber // this is a reconnect, lets tell the server our revisionnumber