# -*- coding: utf-8 -*-
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import time
from shellbot.i18n import _
from .base import Command
[docs]class Default(Command):
"""
Handles unmatched command
This function looks for a named list and adds participants accordingly.
Note that only list with attribute ``as_command`` set to true are
considered.
In other cases, the end user is advised that the command is unknown.
"""
is_hidden = True
[docs] def on_init(self):
"""
Localize strings for this command
"""
self.keyword = _(u'*default')
self.information_message = _(u'Handle unmatched commands')
self.participants_message = _(u"Adding participants from '{}'")
self.default_message = _(u"Sorry, I do not know how to handle '{}'")
[docs] def execute(self, bot, arguments=None, **kwargs):
"""
Handles unmatched command
:param bot: The bot for this execution
:type bot: Shellbot
:param arguments: The arguments for this command
:type arguments: str or ``None``
Arguments provided should include all of the user input, including
the first token that has not been recognised as a valid command.
If arguments match a named list, then items of the
list are added as participants to the channel. This applies only:
- if the named list has the attribute ``as_command``
- and if this is not a direct channel (limited to 1:1 interactions)
"""
list = bot.engine.list_factory.get_list(arguments)
if list and list.as_command and not bot.channel.is_direct:
bot.say(self.participants_message.format(arguments))
persons = [x for x in list]
bot.add_participants(persons)
else:
bot.say(self.default_message.format(arguments))