def run(self, event):
# Get server object
server_obj = event.server
# If no arguments given, toggle caps lock in current destination
line_clean = event.command_args.strip()
if line_clean == "":
event.channel.use_caps_lock = not event.channel.use_caps_lock
return event.create_response("Caps lock toggled.")
# If line has 1 argument,
line_split = line_clean.split()
if len(line_split) == 1:
# Check if a boolean was specified
input_bool = Commons.string_to_bool(line_split[0])
if input_bool is not None:
event.channel.use_caps_lock = input_bool
return event.create_response("Caps lock set {}.".format({
False:
"off",
True:
"on"
}[input_bool]))
# Check if a channel was specified
target_channel = server_obj.get_channel_by_name(line_split[0])
if target_channel.in_channel:
target_channel.use_caps_lock = not target_channel.use_caps_lock
return event.create_response("Caps lock toggled in {}.".format(
target_channel.name))
# Otherwise input unknown
return event.create_response(
"Error, I don't understand your input, " +
"please specify a channel and whether to turn caps lock on or off."
)
# Otherwise line has 2 or more arguments.
# Check if first argument is boolean
input_bool = Commons.string_to_bool(line_split[0])
target_channel_name = line_split[1]
if input_bool is None:
input_bool = Commons.string_to_bool(line_split[1])
target_channel_name = line_split[0]
if input_bool is None:
return event.create_response(
"Error, I don't understand your input, please specify a channel and "
+ "whether to turn caps lock on or off.")
target_channel = server_obj.get_channel_by_name(target_channel_name)
if target_channel is None or not target_channel.in_channel:
return event.create_response("Error, I'm not in that channel.")
target_channel.use_caps_lock = input_bool
return event.create_response("Caps lock set {} in {}.".format({
False:
"off",
True:
"on"
}[input_bool], target_channel.name))
def run(self, event):
line_split = event.command_args.split()
if len(line_split) < 3:
return event.create_response(
"Error, you need to specify a location, a right and the value"
)
bool_input = line_split[-1]
right_input = line_split[-2]
location_input = line_split[:-2]
# Search for the permission_mask they want.
try:
permission_mask = self.find_permission_mask(
location_input, event.user, event.channel
)
# If it comes back with an error message, return that error
except PermissionControlException as e:
return event.create_response(str(e))
# If it comes back unspecified, generic error message
if permission_mask is None:
return event.create_response(
"Error, I can't find that permission mask. "
+ "Specify which you wish to modify as user={username}, "
+ "or similarly for usergroup, channel, server or hallo."
)
# Turn bool_input into a boolean
bool_bool = Commons.string_to_bool(bool_input)
# Check if boolean input is valid
if bool_bool is None:
return event.create_response(
"Error, I don't understand your boolean value. Please use true or false."
)
# Set the right
permission_mask.set_right(right_input, bool_bool)
return event.create_response(
"Set {} to {}.".format(right_input, "true" if bool_bool else "false")
)
def test_string_to_bool__none(string):
assert Commons.string_to_bool(string) is None
def test_string_to_bool__false(string):
assert not Commons.string_to_bool(string)
def test_string_to_bool__true(string):
assert Commons.string_to_bool(string)
def edit_server_irc(self, line, server_obj):
"""Processes arguments in order to edit an IRC server"""
# Set all variables to none as default
server_address, server_port = None, None
# Find the URL, if specified
url_regex = re.compile(
r"(^|\s)(irc://)?(([a-z.]+\.[a-z]+)(:([0-9]+))?)(\s|$)",
re.IGNORECASE)
url_search = url_regex.search(line)
if url_search is not None:
line = line.replace(url_search.group(0), " ")
server_address = url_search.group(4).lower()
server_port = int(url_search.group(6))
# Find the server_address, if specified with equals notation
server_address = (Commons.find_parameter("server_address", line)
or server_address)
# Find the server_port, if specified with equals notation
server_port_param = Commons.find_parameter("server_port", line)
if server_port_param is not None:
try:
server_port = int(server_port_param)
except ValueError:
return "Invalid port number."
# If server_address or server_port are set, edit those and reconnect.
if server_address is not None:
server_obj.server_address = server_address
if server_port is not None:
server_obj.server_port = server_port
# Get other parameters, if set. defaulting to whatever server defaults.
auto_connect = (Commons.string_to_bool(
Commons.find_parameter("auto_connect", line))
or server_obj.get_auto_connect())
server_nick = (Commons.find_parameter("server_nick", line)
or Commons.find_parameter("nick", line)
or server_obj.get_nick())
server_prefix = (Commons.find_parameter("server_prefix", line)
or Commons.find_parameter("prefix", line)
or server_obj.get_prefix())
full_name = (Commons.find_parameter("full_name", line)
or server_obj.get_full_name())
nickserv_nick = (Commons.find_parameter("nickserv_nick", line)
or server_obj.get_nickserv_nick())
nickserv_identity_command = (
Commons.find_parameter("nickserv_identity_command", line)
or server_obj.get_nickserv_ident_command())
nickserv_identity_response = (
Commons.find_parameter("nickserv_identity_response", line)
or server_obj.get_nickserv_ident_response())
nickserv_password = (Commons.find_parameter("nickserv_password", line)
or server_obj.get_nickserv_pass())
# Set all the new variables
server_obj.set_auto_connect(auto_connect)
server_obj.nick = server_nick
server_obj.prefix = server_prefix
server_obj.set_full_name(full_name)
server_obj.set_nickserv_nick(nickserv_nick)
server_obj.set_nickserv_ident_command(nickserv_identity_command)
server_obj.set_nickserv_ident_response(nickserv_identity_response)
server_obj.get_nickserv_pass(nickserv_password)
# If server address or server port was changed, reconnect.
if server_port is not None or server_address is not None:
server_obj.reconnect()
return "Modified the IRC server: {}.".format(server_obj.name)
def connect_to_new_server_irc(self, line, event):
"""
Processes arguments in order to connect to a new IRC server
:type line: str
:type event: EventMessage
"""
# Get some handy objects
current_server = event.server
hallo_obj = current_server.hallo
# Set all variables to none as default
server_address, server_port = None, None
server_name = None
# Find the URL, if specified
url_regex = re.compile(
r"(^|\s)(irc://)?(([a-z.]+\.[a-z]+)(:([0-9]+))?)(\s|$)",
re.IGNORECASE)
url_search = url_regex.search(line)
if url_search is not None:
line = line.replace(url_search.group(0), " ")
server_address = url_search.group(4).lower()
try:
server_port = int(url_search.group(6))
except (ValueError, TypeError):
server_port = None
# Find the server_address, if specified with equals notation
server_address = (Commons.find_parameter("server_address", line)
or server_address)
# Find the server_port, if specified with equals notation
server_port_param = Commons.find_parameter("server_port", line)
if server_port_param is not None:
try:
server_port = int(server_port_param)
except (ValueError, TypeError):
return "Error, invalid port number."
# Check server_address and server_port are set
if server_address is None:
return "Error, No server address specified."
if server_port is None and isinstance(current_server, ServerIRC):
server_port = current_server.get_server_port()
if server_port is None:
return "Error, No server port specified."
# Get server name
server_name = (Commons.find_any_parameter(["server_name", "name"],
line) or server_name)
# if server name is null, get it from server_address
if server_name is None:
server_name = Commons.get_domain_name(server_address)
# Get other parameters, if set.
auto_connect_str = Commons.find_parameter("auto_connect", line)
auto_connect = (True if auto_connect_str is None else
Commons.string_to_bool(auto_connect_str))
server_nick = (Commons.find_any_parameter(
["server_nick", "nick"], line) or current_server.get_nick())
server_prefix_arg = Commons.find_any_parameter(
["server_prefix", "prefix"], line)
if not server_prefix_arg:
server_prefix = current_server.prefix
else:
server_prefix = (None if Commons.is_string_null(server_prefix_arg)
else server_prefix_arg)
full_name = (Commons.find_parameter("full_name", line)
or current_server.get_full_name())
nickserv_nick = "nickserv"
nickserv_identity_command = "status"
nickserv_identity_resp = "^status [^ ]+ 3$"
nickserv_password = None
if isinstance(current_server, ServerIRC):
nickserv_nick = current_server.get_nickserv_nick()
nickserv_identity_command = current_server.get_nickserv_ident_command(
)
nickserv_identity_resp = current_server.get_nickserv_ident_response(
)
nickserv_password = current_server.get_nickserv_pass()
nickserv_nick = Commons.find_parameter("nickserv_nick",
line) or nickserv_nick
nickserv_identity_command = (Commons.find_parameter(
"nickserv_identity_command", line) or nickserv_identity_command)
nickserv_identity_resp = (Commons.find_parameter(
"nickserv_identity_resp", line) or nickserv_identity_resp)
nickserv_password = (Commons.find_parameter("nickserv_password", line)
or nickserv_password)
# Create this serverIRC object
new_server_obj = ServerIRC(hallo_obj, server_name, server_address,
server_port)
new_server_obj.auto_connect = auto_connect
new_server_obj.set_nick(server_nick)
new_server_obj.set_prefix(server_prefix)
new_server_obj.set_full_name(full_name)
new_server_obj.set_nickserv_nick(nickserv_nick)
new_server_obj.set_nickserv_ident_command(nickserv_identity_command)
new_server_obj.set_nickserv_ident_response(nickserv_identity_resp)
new_server_obj.set_nickserv_pass(nickserv_password)
# Add user with same name on new server to all the same groups as current user
new_user_nick = Commons.find_any_parameter(["user", "god"], line)
if new_user_nick is False: # TODO: check user exists on server, ask server?
new_user = new_server_obj.get_user_by_address(
event.user.address, event.user.name)
else:
new_user = new_server_obj.get_user_by_address(
new_user_nick.lower(), new_user_nick)
if new_user is None:
return 'Could not find a user by the name specified ("{}") on the new server.'.format(
new_user_nick)
for group in event.user.user_group_list:
new_user.add_user_group(group)
# Add the new object to Hallo's list
hallo_obj.add_server(new_server_obj)
# Connect to the new server object.
new_server_obj.start()
return "Connected to new IRC server: {}.".format(new_server_obj.name)
