[NEW] Custom User Status

app/api/server/v1/emoji-custom.js

@@ -122,7 +122,7 @@ API.v1.addRoute('emoji-custom.update', { authRequired: true }, {
 						if (!fields._id) {
 							return callback(new Meteor.Error('The required "_id" query param is missing.'));
 						}
-						const emojiToUpdate = EmojiCustom.findOneByID(fields._id);
+						const emojiToUpdate = EmojiCustom.findOneById(fields._id);
 						if (!emojiToUpdate) {
 							return callback(new Meteor.Error('Emoji not found.'));
 						}

app/api/server/v1/users.js

@@ -18,6 +18,7 @@ import {
 } from '../../../lib';
 import { getFullUserData } from '../../../lib/server/functions/getFullUserData';
 import { API } from '../api';
+import { setStatusMessage } from '../../../lib/server';
 
 API.v1.addRoute('users.create', { authRequired: true }, {
 	post() {
@@ -325,6 +326,73 @@ API.v1.addRoute('users.setAvatar', { authRequired: true }, {
 	},
 });
 
+API.v1.addRoute('users.getStatus', { authRequired: true }, {
+	get() {
+		if (this.isUserFromParams()) {
+			const user = Users.findOneById(this.userId);
+			return API.v1.success({
+				message: user.statusText,
+				connectionStatus: user.statusConnection,
+				status: user.status,
+			});
+		}
+
+		const user = this.getUserFromParams();
+
+		return API.v1.success({
+			message: user.statusText,
+			status: user.status,
+		});
+	},
+});
+
+API.v1.addRoute('users.setStatus', { authRequired: true }, {
+	post() {
+		check(this.bodyParams, Match.ObjectIncluding({
+			status: Match.Maybe(String),
+			message: Match.Maybe(String),
+		}));
+
+		if (!settings.get('Accounts_AllowUserStatusMessageChange')) {
+			throw new Meteor.Error('error-not-allowed', 'Change status is not allowed', {
+				method: 'users.setStatus',
+			});
+		}
+
+		let user;
+		if (this.isUserFromParams()) {
+			user = Meteor.users.findOne(this.userId);
+		} else if (hasPermission(this.userId, 'edit-other-user-info')) {
+			user = this.getUserFromParams();
+		} else {
+			return API.v1.unauthorized();
+		}
+
+		Meteor.runAsUser(user._id, () => {
+			if (this.bodyParams.message) {
+				setStatusMessage(user._id, this.bodyParams.message);
+			}
+			if (this.bodyParams.status) {
+				const validStatus = ['online', 'away', 'offline', 'busy'];
+				if (validStatus.includes(this.bodyParams.status)) {
+					Meteor.users.update(this.userId, {
+						$set: {
+							status: this.bodyParams.status,
+							statusDefault: this.bodyParams.status,
+						},
+					});
+				} else {
+					throw new Meteor.Error('error-invalid-status', 'Valid status types include online, away, offline, and busy.', {
+						method: 'users.setStatus',
+					});
+				}
+			}
+		});
+
+		return API.v1.success();
+	},
+});
+
 API.v1.addRoute('users.update', { authRequired: true }, {
 	post() {
 		check(this.bodyParams, {
@@ -334,6 +402,7 @@ API.v1.addRoute('users.update', { authRequired: true }, {
 				name: Match.Maybe(String),
 				password: Match.Maybe(String),
 				username: Match.Maybe(String),
+				statusText: Match.Maybe(String),
 				active: Match.Maybe(Boolean),
 				roles: Match.Maybe(Array),
 				joinDefaultChannels: Match.Maybe(Boolean),
@@ -369,6 +438,7 @@ API.v1.addRoute('users.updateOwnBasicInfo', { authRequired: true }, {
 				email: Match.Maybe(String),
 				name: Match.Maybe(String),
 				username: Match.Maybe(String),
+				statusText: Match.Maybe(String),
 				currentPassword: Match.Maybe(String),
 				newPassword: Match.Maybe(String),
 			}),
@@ -379,6 +449,7 @@ API.v1.addRoute('users.updateOwnBasicInfo', { authRequired: true }, {
 			email: this.bodyParams.data.email,
 			realname: this.bodyParams.data.name,
 			username: this.bodyParams.data.username,
+			statusText: this.bodyParams.data.statusText,
 			newPassword: this.bodyParams.data.newPassword,
 			typedPassword: this.bodyParams.data.currentPassword,
 		};
@@ -581,6 +652,7 @@ API.v1.addRoute('users.presence', { authRequired: true }, {
 				name: 1,
 				status: 1,
 				utcOffset: 1,
+				statusText: 1,
 			},
 		};
 

app/authorization/server/startup.js

@@ -46,6 +46,7 @@ Meteor.startup(function() {
 		{ _id: 'leave-p',                       roles: ['admin', 'user', 'bot', 'anonymous'] },
 		{ _id: 'manage-assets',                 roles: ['admin'] },
 		{ _id: 'manage-emoji',                  roles: ['admin'] },
+		{ _id: 'manage-user-status',            roles: ['admin'] },
 		{ _id: 'manage-integrations',           roles: ['admin'] },
 		{ _id: 'manage-own-integrations',       roles: ['admin'] },
 		{ _id: 'manage-oauth-apps',             roles: ['admin'] },

app/custom-sounds/server/methods/deleteCustomSound.js

@@ -10,7 +10,7 @@ Meteor.methods({
 		let sound = null;
 
 		if (hasPermission(this.userId, 'manage-sounds')) {
-			sound = CustomSounds.findOneByID(_id);
+			sound = CustomSounds.findOneById(_id);
 		} else {
 			throw new Meteor.Error('not_authorized');
 		}
@@ -20,7 +20,7 @@ Meteor.methods({
 		}
 
 		RocketChatFileCustomSoundsInstance.deleteFile(`${ sound._id }.${ sound.extension }`);
-		CustomSounds.removeByID(_id);
+		CustomSounds.removeById(_id);
 		Notifications.notifyAll('deleteCustomSound', { soundData: sound });
 
 		return true;

app/custom-sounds/server/methods/insertOrUpdateSound.js

@@ -32,7 +32,7 @@ Meteor.methods({
 		let matchingResults = [];
 
 		if (soundData._id) {
-			matchingResults = CustomSounds.findByNameExceptID(soundData.name, soundData._id).fetch();
+			matchingResults = CustomSounds.findByNameExceptId(soundData.name, soundData._id).fetch();
 		} else {
 			matchingResults = CustomSounds.findByName(soundData.name).fetch();
 		}

app/emoji-custom/server/methods/deleteEmojiCustom.js

@@ -10,7 +10,7 @@ Meteor.methods({
 		let emoji = null;
 
 		if (hasPermission(this.userId, 'manage-emoji')) {
-			emoji = EmojiCustom.findOneByID(emojiID);
+			emoji = EmojiCustom.findOneById(emojiID);
 		} else {
 			throw new Meteor.Error('not_authorized');
 		}
@@ -20,7 +20,7 @@ Meteor.methods({
 		}
 
 		RocketChatFileEmojiCustomInstance.deleteFile(encodeURIComponent(`${ emoji.name }.${ emoji.extension }`));
-		EmojiCustom.removeByID(emojiID);
+		EmojiCustom.removeById(emojiID);
 		Notifications.notifyLogged('deleteEmojiCustom', { emojiData: emoji });
 
 		return true;

app/lib/lib/roomTypes/direct.js

@@ -1,7 +1,7 @@
 import { Meteor } from 'meteor/meteor';
 import { Session } from 'meteor/session';
 
-import { ChatRoom, Subscriptions } from '../../../models';
+import { ChatRoom, Subscriptions, Users } from '../../../models';
 import { openRoom } from '../../../ui-utils';
 import { getUserPreference, RoomTypeConfig, RoomTypeRouteConfig, RoomSettingsEnum, UiTextContext } from '../../../utils';
 import { hasPermission, hasAtLeastOnePermission } from '../../../authorization';
@@ -92,6 +92,14 @@ export class DirectMessageRoomType extends RoomTypeConfig {
 		return Session.get(`user_${ subscription.name }_status`);
 	}
 
+	getUserStatusText(roomId) {
+		const userId = roomId.replace(Meteor.userId(), '');
+		const userData = Users.findOne({ _id: userId });
+		if (userData && userData.statusText) {
+			return userData.statusText;
+		}
+	}
+
 	getDisplayName(room) {
 		return room.usernames.join(' x ');
 	}

app/lib/server/functions/getFullUserData.js

@@ -15,6 +15,7 @@ const defaultFields = {
 	type: 1,
 	active: 1,
 	reason: 1,
+	statusText: 1,
 };
 
 const fullFields = {

app/lib/server/functions/index.js

@@ -23,6 +23,7 @@ export { saveUser } from './saveUser';
 export { sendMessage } from './sendMessage';
 export { setEmail } from './setEmail';
 export { setRealName, _setRealName } from './setRealName';
+export { setStatusMessage, _setStatusMessage } from './setStatusMessage';
 export { setUserAvatar } from './setUserAvatar';
 export { _setUsername, setUsername } from './setUsername';
 export { unarchiveRoom } from './unarchiveRoom';

app/lib/server/functions/saveUser.js

@@ -10,7 +10,7 @@ import { settings } from '../../../settings';
 import PasswordPolicy from '../lib/PasswordPolicyClass';
 import { validateEmailDomain } from '../lib';
 
-import { checkEmailAvailability, checkUsernameAvailability, setUserAvatar, setEmail, setRealName, setUsername } from '.';
+import { checkEmailAvailability, checkUsernameAvailability, setUserAvatar, setEmail, setRealName, setUsername, setStatusMessage } from '.';
 
 const passwordPolicy = new PasswordPolicy();
 
@@ -133,6 +133,13 @@ function validateUserEditing(userId, userData) {
 		});
 	}
 
+	if (userData.statusText && !settings.get('Accounts_AllowUserStatusMessageChange') && (!canEditOtherUserInfo || editingMyself)) {
+		throw new Meteor.Error('error-action-not-allowed', 'Edit user status is not allowed', {
+			method: 'insertOrUpdateUser',
+			action: 'Update_user',
+		});
+	}
+
 	if (userData.name && !settings.get('Accounts_AllowRealNameChange') && (!canEditOtherUserInfo || editingMyself)) {
 		throw new Meteor.Error('error-action-not-allowed', 'Edit user real name is not allowed', {
 			method: 'insertOrUpdateUser',
@@ -248,6 +255,10 @@ export const saveUser = function(userId, userData) {
 		setRealName(userData._id, userData.name);
 	}
 
+	if (typeof userData.statusText === 'string') {
+		setStatusMessage(userData._id, userData.statusText);
+	}
+
 	if (userData.email) {
 		const shouldSendVerificationEmailToUser = userData.verified !== true;
 		setEmail(userData._id, userData.email, shouldSendVerificationEmailToUser);

app/lib/server/functions/setStatusMessage.js

@@ -0,0 +1,45 @@
+import { Meteor } from 'meteor/meteor';
+import s from 'underscore.string';
+
+import { Users } from '../../../models';
+import { Notifications } from '../../../notifications';
+import { hasPermission } from '../../../authorization';
+import { RateLimiter } from '../lib';
+
+export const _setStatusMessage = function(userId, statusMessage) {
+	statusMessage = s.trim(statusMessage);
+	if (statusMessage.length > 120) {
+		statusMessage = statusMessage.substr(0, 120);
+	}
+
+	if (!userId) {
+		return false;
+	}
+
+	const user = Users.findOneById(userId);
+
+	// User already has desired statusMessage, return
+	if (user.statusText === statusMessage) {
+		return user;
+	}
+
+	// Set new statusMessage
+	Users.updateStatusText(user._id, statusMessage);
+	user.statusText = statusMessage;
+
+	Notifications.notifyLogged('Users:StatusMessageChanged', {
+		_id: user._id,
+		name: user.name,
+		username: user.username,
+		statusText: user.statusText,
+	});
+
+	return true;
+};
+
+export const setStatusMessage = RateLimiter.limitFunction(_setStatusMessage, 1, 60000, {
+	0() {
+		// Administrators have permission to change others status, so don't limit those
+		return !Meteor.userId() || !hasPermission(Meteor.userId(), 'edit-other-user-info');
+	},
+});

app/lib/server/startup/settings.js

@@ -44,6 +44,10 @@ settings.addGroup('Accounts', function() {
 		type: 'boolean',
 		public: true,
 	});
+	this.add('Accounts_AllowUserStatusMessageChange', true, {
+		type: 'boolean',
+		public: true,
+	});
 	this.add('Accounts_AllowUsernameChange', true, {
 		type: 'boolean',
 		public: true,

app/models/client/index.js

@@ -21,6 +21,7 @@ import { UserRoles } from './models/UserRoles';
 import { AuthzCachedCollection, ChatPermissions } from './models/ChatPermissions';
 import { WebdavAccounts } from './models/WebdavAccounts';
 import CustomSounds from './models/CustomSounds';
+import CustomUserStatus from './models/CustomUserStatus';
 import EmojiCustom from './models/EmojiCustom';
 
 const Users = _.extend({}, users, Meteor.users);
@@ -51,6 +52,7 @@ export {
 	ChatSubscription,
 	Rooms,
 	CustomSounds,
+	CustomUserStatus,
 	EmojiCustom,
 	WebdavAccounts,
 };

app/models/client/models/CustomUserStatus.js

@@ -0,0 +1,10 @@
+import { Base } from './_Base';
+
+class CustomUserStatus extends Base {
+	constructor() {
+		super();
+		this._initModel('custom_user_status');
+	}
+}
+
+export default new CustomUserStatus();

app/models/server/index.js

@@ -15,6 +15,7 @@ import Statistics from './models/Statistics';
 import Permissions from './models/Permissions';
 import Roles from './models/Roles';
 import CustomSounds from './models/CustomSounds';
+import CustomUserStatus from './models/CustomUserStatus';
 import Integrations from './models/Integrations';
 import IntegrationHistory from './models/IntegrationHistory';
 import CredentialTokens from './models/CredentialTokens';
@@ -58,6 +59,7 @@ export {
 	Permissions,
 	Roles,
 	CustomSounds,
+	CustomUserStatus,
 	Integrations,
 	IntegrationHistory,
 	CredentialTokens,

app/models/server/models/CustomSounds.js

@@ -8,7 +8,7 @@ class CustomSounds extends Base {
 	}
 
 	// find one
-	findOneByID(_id, options) {
+	findOneById(_id, options) {
 		return this.findOne(_id, options);
 	}
 
@@ -21,7 +21,7 @@ class CustomSounds extends Base {
 		return this.find(query, options);
 	}
 
-	findByNameExceptID(name, except, options) {
+	findByNameExceptId(name, except, options) {
 		const query = {
 			_id: { $nin: [except] },
 			name,
@@ -48,7 +48,7 @@ class CustomSounds extends Base {
 
 
 	// REMOVE
-	removeByID(_id) {
+	removeById(_id) {
 		return this.remove(_id);
 	}
 }