ruma_events/room/power_levels.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
//! Types for the [`m.room.power_levels`] event.
//!
//! [`m.room.power_levels`]: https://spec.matrix.org/latest/client-server-api/#mroompower_levels
use std::{cmp::max, collections::BTreeMap};
use js_int::{int, Int};
use ruma_common::{
power_levels::{default_power_level, NotificationPowerLevels},
push::PushConditionPowerLevelsCtx,
OwnedUserId, RoomVersionId, UserId,
};
use ruma_macros::EventContent;
use serde::{Deserialize, Serialize};
use crate::{
EmptyStateKey, EventContent, MessageLikeEventType, RedactContent, RedactedStateEventContent,
StateEventType, StaticEventContent, TimelineEventType,
};
/// The content of an `m.room.power_levels` event.
///
/// Defines the power levels (privileges) of users in the room.
#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
#[ruma_event(type = "m.room.power_levels", kind = State, state_key_type = EmptyStateKey, custom_redacted)]
pub struct RoomPowerLevelsEventContent {
/// The level required to ban a user.
#[serde(
default = "default_power_level",
skip_serializing_if = "is_default_power_level",
deserialize_with = "ruma_common::serde::deserialize_v1_powerlevel"
)]
pub ban: Int,
/// The level required to send specific event types.
///
/// This is a mapping from event type to power level required.
#[serde(
default,
skip_serializing_if = "BTreeMap::is_empty",
deserialize_with = "ruma_common::serde::btreemap_deserialize_v1_powerlevel_values"
)]
pub events: BTreeMap<TimelineEventType, Int>,
/// The default level required to send message events.
#[serde(
default,
skip_serializing_if = "ruma_common::serde::is_default",
deserialize_with = "ruma_common::serde::deserialize_v1_powerlevel"
)]
pub events_default: Int,
/// The level required to invite a user.
#[serde(
default,
skip_serializing_if = "ruma_common::serde::is_default",
deserialize_with = "ruma_common::serde::deserialize_v1_powerlevel"
)]
pub invite: Int,
/// The level required to kick a user.
#[serde(
default = "default_power_level",
skip_serializing_if = "is_default_power_level",
deserialize_with = "ruma_common::serde::deserialize_v1_powerlevel"
)]
pub kick: Int,
/// The level required to redact an event.
#[serde(
default = "default_power_level",
skip_serializing_if = "is_default_power_level",
deserialize_with = "ruma_common::serde::deserialize_v1_powerlevel"
)]
pub redact: Int,
/// The default level required to send state events.
#[serde(
default = "default_power_level",
skip_serializing_if = "is_default_power_level",
deserialize_with = "ruma_common::serde::deserialize_v1_powerlevel"
)]
pub state_default: Int,
/// The power levels for specific users.
///
/// This is a mapping from `user_id` to power level for that user.
#[serde(
default,
skip_serializing_if = "BTreeMap::is_empty",
deserialize_with = "ruma_common::serde::btreemap_deserialize_v1_powerlevel_values"
)]
pub users: BTreeMap<OwnedUserId, Int>,
/// The default power level for every user in the room.
#[serde(
default,
skip_serializing_if = "ruma_common::serde::is_default",
deserialize_with = "ruma_common::serde::deserialize_v1_powerlevel"
)]
pub users_default: Int,
/// The power level requirements for specific notification types.
///
/// This is a mapping from `key` to power level for that notifications key.
#[serde(default, skip_serializing_if = "NotificationPowerLevels::is_default")]
pub notifications: NotificationPowerLevels,
}
impl RoomPowerLevelsEventContent {
/// Creates a new `RoomPowerLevelsEventContent` with all-default values.
pub fn new() -> Self {
// events_default, users_default and invite having a default of 0 while the others have a
// default of 50 is not an oversight, these defaults are from the Matrix specification.
Self {
ban: default_power_level(),
events: BTreeMap::new(),
events_default: int!(0),
invite: int!(0),
kick: default_power_level(),
redact: default_power_level(),
state_default: default_power_level(),
users: BTreeMap::new(),
users_default: int!(0),
notifications: NotificationPowerLevels::default(),
}
}
}
impl Default for RoomPowerLevelsEventContent {
fn default() -> Self {
Self::new()
}
}
impl RedactContent for RoomPowerLevelsEventContent {
type Redacted = RedactedRoomPowerLevelsEventContent;
fn redact(self, version: &RoomVersionId) -> Self::Redacted {
let Self {
ban,
events,
events_default,
invite,
kick,
redact,
state_default,
users,
users_default,
..
} = self;
let invite = match version {
RoomVersionId::V1
| RoomVersionId::V2
| RoomVersionId::V3
| RoomVersionId::V4
| RoomVersionId::V5
| RoomVersionId::V6
| RoomVersionId::V7
| RoomVersionId::V8
| RoomVersionId::V9
| RoomVersionId::V10 => int!(0),
_ => invite,
};
RedactedRoomPowerLevelsEventContent {
ban,
events,
events_default,
invite,
kick,
redact,
state_default,
users,
users_default,
}
}
}
/// Used with `#[serde(skip_serializing_if)]` to omit default power levels.
#[allow(clippy::trivially_copy_pass_by_ref)]
fn is_default_power_level(l: &Int) -> bool {
*l == int!(50)
}
impl RoomPowerLevelsEvent {
/// Obtain the effective power levels, regardless of whether this event is redacted.
pub fn power_levels(&self) -> RoomPowerLevels {
match self {
Self::Original(ev) => ev.content.clone().into(),
Self::Redacted(ev) => ev.content.clone().into(),
}
}
}
impl SyncRoomPowerLevelsEvent {
/// Obtain the effective power levels, regardless of whether this event is redacted.
pub fn power_levels(&self) -> RoomPowerLevels {
match self {
Self::Original(ev) => ev.content.clone().into(),
Self::Redacted(ev) => ev.content.clone().into(),
}
}
}
impl StrippedRoomPowerLevelsEvent {
/// Obtain the effective power levels from this event.
pub fn power_levels(&self) -> RoomPowerLevels {
self.content.clone().into()
}
}
/// Redacted form of [`RoomPowerLevelsEventContent`].
#[derive(Clone, Debug, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct RedactedRoomPowerLevelsEventContent {
/// The level required to ban a user.
#[serde(
default = "default_power_level",
skip_serializing_if = "is_default_power_level",
deserialize_with = "ruma_common::serde::deserialize_v1_powerlevel"
)]
pub ban: Int,
/// The level required to send specific event types.
///
/// This is a mapping from event type to power level required.
#[serde(
default,
skip_serializing_if = "BTreeMap::is_empty",
deserialize_with = "ruma_common::serde::btreemap_deserialize_v1_powerlevel_values"
)]
pub events: BTreeMap<TimelineEventType, Int>,
/// The default level required to send message events.
#[serde(
default,
skip_serializing_if = "ruma_common::serde::is_default",
deserialize_with = "ruma_common::serde::deserialize_v1_powerlevel"
)]
pub events_default: Int,
/// The level required to invite a user.
///
/// This field was redacted in room versions 1 through 10. Starting from room version 11 it is
/// preserved.
#[serde(
default,
skip_serializing_if = "ruma_common::serde::is_default",
deserialize_with = "ruma_common::serde::deserialize_v1_powerlevel"
)]
pub invite: Int,
/// The level required to kick a user.
#[serde(
default = "default_power_level",
skip_serializing_if = "is_default_power_level",
deserialize_with = "ruma_common::serde::deserialize_v1_powerlevel"
)]
pub kick: Int,
/// The level required to redact an event.
#[serde(
default = "default_power_level",
skip_serializing_if = "is_default_power_level",
deserialize_with = "ruma_common::serde::deserialize_v1_powerlevel"
)]
pub redact: Int,
/// The default level required to send state events.
#[serde(
default = "default_power_level",
skip_serializing_if = "is_default_power_level",
deserialize_with = "ruma_common::serde::deserialize_v1_powerlevel"
)]
pub state_default: Int,
/// The power levels for specific users.
///
/// This is a mapping from `user_id` to power level for that user.
#[serde(
default,
skip_serializing_if = "BTreeMap::is_empty",
deserialize_with = "ruma_common::serde::btreemap_deserialize_v1_powerlevel_values"
)]
pub users: BTreeMap<OwnedUserId, Int>,
/// The default power level for every user in the room.
#[serde(
default,
skip_serializing_if = "ruma_common::serde::is_default",
deserialize_with = "ruma_common::serde::deserialize_v1_powerlevel"
)]
pub users_default: Int,
}
impl EventContent for RedactedRoomPowerLevelsEventContent {
type EventType = StateEventType;
fn event_type(&self) -> Self::EventType {
StateEventType::RoomPowerLevels
}
}
impl StaticEventContent for RedactedRoomPowerLevelsEventContent {
const TYPE: &'static str = "m.room.power_levels";
}
impl RedactedStateEventContent for RedactedRoomPowerLevelsEventContent {
type StateKey = EmptyStateKey;
}
/// The effective power levels of a room.
///
/// This struct contains the same fields as [`RoomPowerLevelsEventContent`] and be created from that
/// using a `From` trait implementation, but it is also implements
/// `From<`[`RedactedRoomPowerLevelsEventContent`]`>`, so can be used when wanting to inspect the
/// power levels of a room, regardless of whether the most recent power-levels event is redacted or
/// not.
#[derive(Clone, Debug)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct RoomPowerLevels {
/// The level required to ban a user.
pub ban: Int,
/// The level required to send specific event types.
///
/// This is a mapping from event type to power level required.
pub events: BTreeMap<TimelineEventType, Int>,
/// The default level required to send message events.
pub events_default: Int,
/// The level required to invite a user.
pub invite: Int,
/// The level required to kick a user.
pub kick: Int,
/// The level required to redact an event.
pub redact: Int,
/// The default level required to send state events.
pub state_default: Int,
/// The power levels for specific users.
///
/// This is a mapping from `user_id` to power level for that user.
pub users: BTreeMap<OwnedUserId, Int>,
/// The default power level for every user in the room.
pub users_default: Int,
/// The power level requirements for specific notification types.
///
/// This is a mapping from `key` to power level for that notifications key.
pub notifications: NotificationPowerLevels,
}
impl RoomPowerLevels {
/// Get the power level of a specific user.
pub fn for_user(&self, user_id: &UserId) -> Int {
self.users.get(user_id).map_or(self.users_default, |pl| *pl)
}
/// Get the power level required to perform a given action.
pub fn for_action(&self, action: PowerLevelAction) -> Int {
match action {
PowerLevelAction::Ban => self.ban,
PowerLevelAction::Unban => self.ban.max(self.kick),
PowerLevelAction::Invite => self.invite,
PowerLevelAction::Kick => self.kick,
PowerLevelAction::RedactOwn => self.for_message(MessageLikeEventType::RoomRedaction),
PowerLevelAction::RedactOther => {
self.redact.max(self.for_message(MessageLikeEventType::RoomRedaction))
}
PowerLevelAction::SendMessage(msg_type) => self.for_message(msg_type),
PowerLevelAction::SendState(state_type) => self.for_state(state_type),
PowerLevelAction::TriggerNotification(NotificationPowerLevelType::Room) => {
self.notifications.room
}
}
}
/// Get the power level required to send the given message type.
pub fn for_message(&self, msg_type: MessageLikeEventType) -> Int {
self.events.get(&msg_type.into()).copied().unwrap_or(self.events_default)
}
/// Get the power level required to send the given state event type.
pub fn for_state(&self, state_type: StateEventType) -> Int {
self.events.get(&state_type.into()).copied().unwrap_or(self.state_default)
}
/// Whether the given user can ban other users based on the power levels.
///
/// Shorthand for `power_levels.user_can_do(user_id, PowerLevelAction::Ban)`.
pub fn user_can_ban(&self, user_id: &UserId) -> bool {
self.for_user(user_id) >= self.ban
}
/// Whether the acting user can ban the target user based on the power levels.
///
/// On top of `power_levels.user_can_ban(acting_user_id)`, this performs an extra check
/// to make sure the acting user has at greater power level than the target user.
///
/// Shorthand for `power_levels.user_can_do_to_user(acting_user_id, target_user_id,
/// PowerLevelUserAction::Ban)`.
pub fn user_can_ban_user(&self, acting_user_id: &UserId, target_user_id: &UserId) -> bool {
let acting_pl = self.for_user(acting_user_id);
let target_pl = self.for_user(target_user_id);
acting_pl >= self.ban && target_pl < acting_pl
}
/// Whether the given user can unban other users based on the power levels.
///
/// This action requires to be allowed to ban and to kick.
///
/// Shorthand for `power_levels.user_can_do(user_id, PowerLevelAction::Unban)`.
pub fn user_can_unban(&self, user_id: &UserId) -> bool {
let pl = self.for_user(user_id);
pl >= self.ban && pl >= self.kick
}
/// Whether the acting user can unban the target user based on the power levels.
///
/// This action requires to be allowed to ban and to kick.
///
/// On top of `power_levels.user_can_unban(acting_user_id)`, this performs an extra check
/// to make sure the acting user has at greater power level than the target user.
///
/// Shorthand for `power_levels.user_can_do_to_user(acting_user_id, target_user_id,
/// PowerLevelUserAction::Unban)`.
pub fn user_can_unban_user(&self, acting_user_id: &UserId, target_user_id: &UserId) -> bool {
let acting_pl = self.for_user(acting_user_id);
let target_pl = self.for_user(target_user_id);
acting_pl >= self.ban && acting_pl >= self.kick && target_pl < acting_pl
}
/// Whether the given user can invite other users based on the power levels.
///
/// Shorthand for `power_levels.user_can_do(user_id, PowerLevelAction::Invite)`.
pub fn user_can_invite(&self, user_id: &UserId) -> bool {
self.for_user(user_id) >= self.invite
}
/// Whether the given user can kick other users based on the power levels.
///
/// Shorthand for `power_levels.user_can_do(user_id, PowerLevelAction::Kick)`.
pub fn user_can_kick(&self, user_id: &UserId) -> bool {
self.for_user(user_id) >= self.kick
}
/// Whether the acting user can kick the target user based on the power levels.
///
/// On top of `power_levels.user_can_kick(acting_user_id)`, this performs an extra check
/// to make sure the acting user has at least the same power level as the target user.
///
/// Shorthand for `power_levels.user_can_do_to_user(acting_user_id, target_user_id,
/// PowerLevelUserAction::Kick)`.
pub fn user_can_kick_user(&self, acting_user_id: &UserId, target_user_id: &UserId) -> bool {
let acting_pl = self.for_user(acting_user_id);
let target_pl = self.for_user(target_user_id);
acting_pl >= self.kick && target_pl < acting_pl
}
/// Whether the given user can redact their own events based on the power levels.
///
/// Shorthand for `power_levels.user_can_do(user_id, PowerLevelAction::RedactOwn)`.
pub fn user_can_redact_own_event(&self, user_id: &UserId) -> bool {
self.user_can_send_message(user_id, MessageLikeEventType::RoomRedaction)
}
/// Whether the given user can redact events of other users based on the power levels.
///
/// Shorthand for `power_levels.user_can_do(user_id, PowerLevelAction::RedactOthers)`.
pub fn user_can_redact_event_of_other(&self, user_id: &UserId) -> bool {
self.user_can_redact_own_event(user_id) && self.for_user(user_id) >= self.redact
}
/// Whether the given user can send message events based on the power levels.
///
/// Shorthand for `power_levels.user_can_do(user_id, PowerLevelAction::SendMessage(msg_type))`.
pub fn user_can_send_message(&self, user_id: &UserId, msg_type: MessageLikeEventType) -> bool {
self.for_user(user_id) >= self.for_message(msg_type)
}
/// Whether the given user can send state events based on the power levels.
///
/// Shorthand for `power_levels.user_can_do(user_id, PowerLevelAction::SendState(state_type))`.
pub fn user_can_send_state(&self, user_id: &UserId, state_type: StateEventType) -> bool {
self.for_user(user_id) >= self.for_state(state_type)
}
/// Whether the given user can notify everybody in the room by writing `@room` in a message.
///
/// Shorthand for `power_levels.user_can_do(user_id,
/// PowerLevelAction::TriggerNotification(NotificationPowerLevelType::Room))`.
pub fn user_can_trigger_room_notification(&self, user_id: &UserId) -> bool {
self.for_user(user_id) >= self.notifications.room
}
/// Whether the acting user can change the power level of the target user.
///
/// Shorthand for `power_levels.user_can_do_to_user(acting_user_id, target_user_id,
/// PowerLevelUserAction::ChangePowerLevel`.
pub fn user_can_change_user_power_level(
&self,
acting_user_id: &UserId,
target_user_id: &UserId,
) -> bool {
// Check that the user can change the power levels first.
if !self.user_can_send_state(acting_user_id, StateEventType::RoomPowerLevels) {
return false;
}
// A user can change their own power level.
if acting_user_id == target_user_id {
return true;
}
// The permission is different whether the target user is added or changed/removed, so
// we need to check that.
if let Some(target_pl) = self.users.get(target_user_id).copied() {
self.for_user(acting_user_id) > target_pl
} else {
true
}
}
/// Whether the given user can do the given action based on the power levels.
pub fn user_can_do(&self, user_id: &UserId, action: PowerLevelAction) -> bool {
match action {
PowerLevelAction::Ban => self.user_can_ban(user_id),
PowerLevelAction::Unban => self.user_can_unban(user_id),
PowerLevelAction::Invite => self.user_can_invite(user_id),
PowerLevelAction::Kick => self.user_can_kick(user_id),
PowerLevelAction::RedactOwn => self.user_can_redact_own_event(user_id),
PowerLevelAction::RedactOther => self.user_can_redact_event_of_other(user_id),
PowerLevelAction::SendMessage(message_type) => {
self.user_can_send_message(user_id, message_type)
}
PowerLevelAction::SendState(state_type) => {
self.user_can_send_state(user_id, state_type)
}
PowerLevelAction::TriggerNotification(NotificationPowerLevelType::Room) => {
self.user_can_trigger_room_notification(user_id)
}
}
}
/// Whether the acting user can do the given action to the target user based on the power
/// levels.
pub fn user_can_do_to_user(
&self,
acting_user_id: &UserId,
target_user_id: &UserId,
action: PowerLevelUserAction,
) -> bool {
match action {
PowerLevelUserAction::Ban => self.user_can_ban_user(acting_user_id, target_user_id),
PowerLevelUserAction::Unban => self.user_can_unban_user(acting_user_id, target_user_id),
PowerLevelUserAction::Invite => self.user_can_invite(acting_user_id),
PowerLevelUserAction::Kick => self.user_can_kick_user(acting_user_id, target_user_id),
PowerLevelUserAction::ChangePowerLevel => {
self.user_can_change_user_power_level(acting_user_id, target_user_id)
}
}
}
/// Get the maximum power level of any user.
pub fn max(&self) -> Int {
self.users.values().fold(self.users_default, |max_pl, user_pl| max(max_pl, *user_pl))
}
}
impl From<RoomPowerLevelsEventContent> for RoomPowerLevels {
fn from(c: RoomPowerLevelsEventContent) -> Self {
Self {
ban: c.ban,
events: c.events,
events_default: c.events_default,
invite: c.invite,
kick: c.kick,
redact: c.redact,
state_default: c.state_default,
users: c.users,
users_default: c.users_default,
notifications: c.notifications,
}
}
}
impl From<RedactedRoomPowerLevelsEventContent> for RoomPowerLevels {
fn from(c: RedactedRoomPowerLevelsEventContent) -> Self {
Self {
ban: c.ban,
events: c.events,
events_default: c.events_default,
invite: c.invite,
kick: c.kick,
redact: c.redact,
state_default: c.state_default,
users: c.users,
users_default: c.users_default,
notifications: NotificationPowerLevels::default(),
}
}
}
impl From<RoomPowerLevels> for RoomPowerLevelsEventContent {
fn from(c: RoomPowerLevels) -> Self {
Self {
ban: c.ban,
events: c.events,
events_default: c.events_default,
invite: c.invite,
kick: c.kick,
redact: c.redact,
state_default: c.state_default,
users: c.users,
users_default: c.users_default,
notifications: c.notifications,
}
}
}
impl From<RoomPowerLevels> for PushConditionPowerLevelsCtx {
fn from(c: RoomPowerLevels) -> Self {
Self { users: c.users, users_default: c.users_default, notifications: c.notifications }
}
}
/// The actions that can be limited by power levels.
#[derive(Clone, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum PowerLevelAction {
/// Ban a user.
Ban,
/// Unban a user.
Unban,
/// Invite a user.
Invite,
/// Kick a user.
Kick,
/// Redact one's own event.
RedactOwn,
/// Redact the event of another user.
RedactOther,
/// Send a message-like event.
SendMessage(MessageLikeEventType),
/// Send a state event.
SendState(StateEventType),
/// Trigger a notification.
TriggerNotification(NotificationPowerLevelType),
}
/// The notification types that can be limited by power levels.
#[derive(Clone, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum NotificationPowerLevelType {
/// `@room` notifications.
Room,
}
/// The actions to other users that can be limited by power levels.
#[derive(Clone, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum PowerLevelUserAction {
/// Ban a user.
Ban,
/// Unban a user.
Unban,
/// Invite a user.
Invite,
/// Kick a user.
Kick,
/// Change a user's power level.
ChangePowerLevel,
}
#[cfg(test)]
mod tests {
use std::collections::BTreeMap;
use assign::assign;
use js_int::int;
use maplit::btreemap;
use ruma_common::user_id;
use serde_json::{json, to_value as to_json_value};
use super::{default_power_level, NotificationPowerLevels, RoomPowerLevelsEventContent};
#[test]
fn serialization_with_optional_fields_as_none() {
let default = default_power_level();
let power_levels = RoomPowerLevelsEventContent {
ban: default,
events: BTreeMap::new(),
events_default: int!(0),
invite: int!(0),
kick: default,
redact: default,
state_default: default,
users: BTreeMap::new(),
users_default: int!(0),
notifications: NotificationPowerLevels::default(),
};
let actual = to_json_value(&power_levels).unwrap();
let expected = json!({});
assert_eq!(actual, expected);
}
#[test]
fn serialization_with_all_fields() {
let user = user_id!("@carl:example.com");
let power_levels_event = RoomPowerLevelsEventContent {
ban: int!(23),
events: btreemap! {
"m.dummy".into() => int!(23)
},
events_default: int!(23),
invite: int!(23),
kick: int!(23),
redact: int!(23),
state_default: int!(23),
users: btreemap! {
user.to_owned() => int!(23)
},
users_default: int!(23),
notifications: assign!(NotificationPowerLevels::new(), { room: int!(23) }),
};
let actual = to_json_value(&power_levels_event).unwrap();
let expected = json!({
"ban": 23,
"events": {
"m.dummy": 23
},
"events_default": 23,
"invite": 23,
"kick": 23,
"redact": 23,
"state_default": 23,
"users": {
"@carl:example.com": 23
},
"users_default": 23,
"notifications": {
"room": 23
},
});
assert_eq!(actual, expected);
}
}