nyxx/nyxx/lib/src/core/permissions/Permissions.dart

part of nyxx;

/// Permissions for a role or channel override.
class Permissions implements Convertable<PermissionsBuilder> {
  /// The raw permission code.
  late final int raw;

  /// True if user can create InstantInvite
  late final bool createInstantInvite;

  /// True if user can kick members
  late final bool kickMembers;

  /// True if user can ban members
  late final bool banMembers;

  /// True if user is administrator
  late final bool administrator;

  /// True if user can manager channels
  late final bool manageChannels;

  /// True if user can manager guilds
  late final bool manageGuild;

  /// Allows to add reactions
  late final bool addReactions;

  /// Allows for using priority speaker in a voice channel
  late final bool prioritySpeaker;

  /// Allow to view audit logs
  late final bool viewAuditLog;

  /// Allow viewing channels (OLD READ_MESSAGES)
  late final bool viewChannel;

  /// True if user can send messages
  late final bool sendMessages;

  /// True if user can send TTF messages
  late final bool sendTtsMessages;

  /// True if user can manage messages
  late final bool manageMessages;

  /// True if user can send links in messages
  late final bool embedLinks;

  /// True if user can attach files in messages
  late final bool attachFiles;

  /// True if user can read messages history
  late final bool readMessageHistory;

  /// True if user can mention everyone
  late final bool mentionEveryone;

  /// True if user can use external emojis
  late final bool useExternalEmojis;

  /// True if user can connect to voice channel
  late final bool connect;

  /// True if user can speak
  late final bool speak;

  /// True if user can mute members
  late final bool muteMembers;

  /// True if user can deafen members
  late final bool deafenMembers;

  /// True if user can move members
  late final bool moveMembers;

  /// Allows for using voice-activity-detection in a voice channel
  late final bool useVad;

  /// True if user can change nick
  late final bool changeNickname;

  /// True if user can manager others nicknames
  late final bool manageNicknames;

  /// True if user can manage server's roles
  late final bool manageRoles;

  /// True if user can manage webhooks
  late final bool manageWebhooks;

  /// Allows management and editing of emojis
  late final bool manageEmojis;

  /// Allows the user to go live
  late final bool stream;

  /// Allows for viewing guild insights
  late final bool viewGuildInsights;

  /// Allows members to use slash commands in text channels
  late final bool useSlashCommands;

  /// Allows for requesting to speak in stage channels
  late final bool requestToSpeak;

  /// Makes a [Permissions] object from a raw permission code.
  Permissions.fromInt(int permissions) {
    _construct(permissions);
  }

  /// Permissions with value of 0
  Permissions.empty() {
    _construct(0);
  }

  /// Permissions with max value
  @Deprecated("Needs to be updated")
  Permissions.all() {
    _construct(PermissionsConstants.allPermissions);
  }

  /// Makes a [Permissions] object from overwrite object
  Permissions.fromOverwrite(int permissions, int allow, int deny) {
    _construct(PermissionsUtils.apply(permissions, allow, deny));
  }

  void _construct(int permissions) {
    this.raw = permissions;

    this.createInstantInvite = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.createInstantInvite);
    this.kickMembers = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.kickMembers);
    this.banMembers = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.banMembers);
    this.administrator = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.administrator);
    this.manageChannels = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.manageChannels);
    this.manageGuild = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.manageGuild);
    this.addReactions = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.addReactions);
    this.viewAuditLog = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.viewAuditLog);
    this.viewChannel = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.viewChannel);
    this.sendMessages = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.sendMessages);
    this.prioritySpeaker = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.prioritySpeaker);
    this.sendTtsMessages = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.sendTtsMessages);
    this.manageMessages = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.manageMessages);
    this.embedLinks = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.embedLinks);
    this.attachFiles = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.attachFiles);
    this.readMessageHistory = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.readMessageHistory);
    this.mentionEveryone = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.mentionEveryone);
    this.useExternalEmojis = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.externalEmojis);
    this.connect =
        PermissionsUtils.isApplied(permissions, PermissionsConstants.connect);
    this.speak =
        PermissionsUtils.isApplied(permissions, PermissionsConstants.speak);
    this.muteMembers = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.muteMembers);
    this.deafenMembers = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.deafenMembers);
    this.moveMembers = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.moveMembers);
    this.useVad =
        PermissionsUtils.isApplied(permissions, PermissionsConstants.useVad);
    this.changeNickname = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.changeNickname);
    this.manageNicknames = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.manageNicknames);
    this.manageRoles = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.manageRolesOrPermissions);
    this.manageWebhooks = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.manageWebhooks);

    this.manageEmojis = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.manageEmojis);
    this.stream =
        PermissionsUtils.isApplied(permissions, PermissionsConstants.stream);
    this.viewGuildInsights = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.viewGuildInsights);

    this.useSlashCommands = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.useSlashCommands);
    this.requestToSpeak = PermissionsUtils.isApplied(
        permissions, PermissionsConstants.useSlashCommands);
  }

  /// Returns true if this permissions has [permission]
  bool hasPermission(int permission) =>
      PermissionsUtils.isApplied(this.raw, permission);

  @override
  int get hashCode => raw.hashCode;

  @override
  bool operator ==(dynamic other) {
    if (other is Permissions) return other.raw == this.raw;
    if (other is int) return other == this.raw;

    return false;
  }

  @override
  PermissionsBuilder toBuilder() => PermissionsBuilder.from(this);
}