Chat-O-Matic/application/Role.h
Jaidyn Ann 6e1ca87890 Support for "Roles" (user, moderator, admin, etc.)
Add scaffodling support for arbitrary roles and permission-based (and
varying!) UI.

A new class, Role, represents a user's role in a given room, with three
values:
	* The role's title
	* The role's permission-set
	* The role's priority

The permission set is a bitmask value for various permissions (e.g.,
PERM_WRITE, PERM_BAN, etc), and priority is position in the hierarchy.
A user with higher priority (and PERM_BAN) can ban a user with lower
priority, but not vice-versa. Two users with the same priority can't
ban/kick/mute each other, etc.

These permissions should be used to determine what UI elements are
displayed― if the user doesn't have permission to ban users, then a
"Ban" button shouldn't exist. If the user is muted, they shouldn't be
able to type. So on and so forth.

For now, permissions are sent with a IM_ROLECHANGE message and stored
by the Conversation, but aren't really in use yet.

This system should be flexible groundwork to account for the varying
administrative hierarchies and norms of different protocols.
2021-06-06 00:59:07 -05:00

55 lines
1.3 KiB
C++

/*
* Copyright 2021, Jaidyn Levesque <jadedctrl@teknik.io>
* All rights reserved. Distributed under the terms of the MIT license.
*/
#ifndef PERMS_H
#define PERMS_H
#include <SupportDefs.h>
// NAME, SUBJECT, ROLECHANGE, BAN, KICK, DEAFEN, MUTE, NICK, READ, WRITE
// Set name of room, set subject, change user's "role" (permission presets
// defined by the protocol), etc…
// NSRBKDMNRW
// 0000000000
#define PERM_WRITE 0x01
#define PERM_READ 0x02
#define PERM_NICK 0x04
#define PERM_MUTE 0x08
#define PERM_DEAFEN 0x016
#define PERM_KICK 0x032
#define PERM_BAN 0x064
#define PERM_ROLECHANGE 0x0128
#define PERM_ROOM_SUBJECT 0x0256
#define PERM_ROOM_NAME 0x0512
#define PERM_ALL 1023
class Role {
public:
Role()
: fTitle("Default"), fPerms(0 | PERM_WRITE | PERM_READ), fPriority(0)
{
}
Role(BString title, uint32 perms, uint32 priority)
: fTitle(title), fPerms(perms), fPriority(priority)
{
}
BString fTitle;
uint32 fPerms; // Permissions afforded to role, as described above.
uint32 fPriority; // 'Rank' of role, with higher being greater priority.
// I.E., a user with a priority of 11 can't kick a user
// with a priority of 12, but can one with 10.
// This sort of hierarchy might not be universal in
// chat protocols, but I think it can be adequately
// simulated in add-ons.
};
#endif // PERMS_H