IRCClient can give and revoke channel modes operator and voice.

Author: worblehat

fredirc/client.py

@@ -14,6 +14,8 @@
 
 from fredirc import messages
 from fredirc.errors import ConnectionTimeoutError
+from fredirc.messages import ChannelMode
+from fredirc.parsing import ChannelModeChange
 from fredirc.processor import MessageProcessor
 
 
@@ -206,6 +208,62 @@ def pong(self):
         """ Send a pong message to the server. """
         self._send_message(messages.pong(self._state.server))
 
+    def give_op(self, channel, user):
+        """ Grant operator rights to a user on a channel.
+
+        If the client is no operator, the server will respond with an
+        error message that can be handled via
+        :py:meth:`fredirc.handler.handle_error`.
+
+        Args:
+            channel (str): the channel
+            user (str): the affected user
+        """
+        mode_change = ChannelModeChange(True, ChannelMode.OPERATOR, (user,))
+        self._send_message(messages.channel_mode(channel, mode_change))
+
+    def revoke_op(self, channel, user):
+        """ Revoke operator rights from user on a channel.
+
+        If the client is no operator, the server will respond with an
+            error message that can be handled via
+        :py:meth:`fredirc.handler.handle_error`.
+
+        Args:
+            channel (str): the channel
+            user (str): the affected user
+        """
+        mode_change = ChannelModeChange(False, ChannelMode.OPERATOR, (user,))
+        self._send_message(messages.channel_mode(channel, mode_change))
+
+    def give_voice(self, channel, user):
+        """ Grant voice rights to a user on a channel.
+
+        If the client is no operator, the server will respond with an
+            error message that can be handled via
+        :py:meth:`fredirc.handler.handle_error`.
+
+        Args:
+            channel (str): the channel
+            user (str): the affected user
+        """
+        mode_change = ChannelModeChange(True, ChannelMode.VOICE, (user,))
+        self._send_message(messages.channel_mode(channel, mode_change))
+
+    def revoke_voice(self, channel, user):
+        """ Revoke voice rights from user on a channel.
+
+        If the client is no operator, the server will respond with an
+            error message that can be handled via
+        :py:meth:`fredirc.handler.handle_error`.
+
+        Args:
+            channel (str): the channel
+            user (str): the affected user
+        """
+        mode_change = ChannelModeChange(False, ChannelMode.VOICE, (user,))
+        self._send_message(messages.channel_mode(channel, mode_change))
+
     def is_op_in(self, channel):
         """
         Check if this client has operator rights in the given channel.

fredirc/messages.py

@@ -233,3 +233,13 @@ def part(channels, message):
     return '{part_cmd} {channels} :{message}'.format(
             part_cmd=Cmd.PART, channels=','.join(channels), message=message)
 
+
+def channel_mode(channel, mode_change):
+    """
+    Args:
+        mode_change (ChannelModelChange)
+    """
+    change = '+' if mode_change.added else '-'
+    return '{mode_cmd} {channel} {change}{mode} {params}'.format(
+            mode_cmd=Cmd.MODE, channel=channel, change=change,
+            mode=mode_change.mode, params=' '.join(mode_change.params))

fredirc/parsing.py

@@ -173,6 +173,9 @@ def parse_channel_mode_params(params):
 class ChannelModeChange(object):
     """ Object that contains information about a changed channel mode.
 
+    Note: Does not contain the channel name itself, but only the parameters
+    of the mode-message.
+
     Args:
         added (bool): True, if the mode was added. False, otherwise.
         mode (str): the mode
@@ -188,7 +191,7 @@ def __init__(self, added, mode, params=None):
 class MessageTarget(object):
     """ Represents a target of an IRC message.
 
-    Corresponds to the non-terminal 'msgto' in IRC's grammer.
+    Corresponds to the non-terminal 'msgto' in IRC's grammar.
     """
 
     def __init__(self, channel=None, nick=None, user=None, host=None,