Browse Source
Refactor processing of track and admin commands
Separate the processing of track commands and admin commands into separate files, and normalize handling of messages. Adjust test cases so that they match the new normalized messages. Change-Id: I26e3683bbf3b7daab68407cd9928ee3d7f5c50dcchanges/73/764373/3
Thierry Carrez
5 months ago
4 changed files with 248 additions and 216 deletions
Split View
Diff Options
-
+86 -0ptgbot/admincommands.py
-
+36 -210ptgbot/bot.py
-
+9 -6ptgbot/tests/test_message_process.py
-
+117 -0ptgbot/trackcommands.py
+ 86
- 0
ptgbot/admincommands.py
View File
| @ -0,0 +1,86 @@ | |||
| # Copyright 2011, 2013, 2020 OpenStack Foundation | |||
| # | |||
| # Licensed 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. | |||
| def process_admin_command(db, command, params): | |||
| if command == 'emptydb': | |||
| db.empty() | |||
| elif command == 'fetchdb': | |||
| if len(params) < 1: | |||
| return "Missing URL to fetch (~fetch URL)" | |||
| url = params[0] | |||
| try: | |||
| db.import_json(url) | |||
| return "Loaded DB from %s" % url | |||
| except Exception as e: | |||
| return "Error loading DB: %s" % e | |||
| elif command == 'newday': | |||
| db.new_day_cleanup() | |||
| elif command == 'motd': | |||
| if len(params) < 1: | |||
| return "Missing subcommand (~motd add|del|clean|reorder ...)" | |||
| if params[0] == "add": | |||
| if len(params) < 3: | |||
| return "Missing parameters (~motd add LEVEL MSG)" | |||
| if params[1] not in ['info', 'success', 'warning', 'danger']: | |||
| return ("Incorrect message level '%s' (should be info, " | |||
| "success, warning or danger)" % params[1]) | |||
| db.motd_add(params[1], str.join(' ', params[2:])) | |||
| elif params[0] == "del": | |||
| if len(params) < 2: | |||
| return "Missing message number (~motd del NUM)" | |||
| if not db.motd_has(params[1]): | |||
| return "Incorrect message number %s" % params[1] | |||
| db.motd_del(params[1]) | |||
| elif params[0] == "clean": | |||
| if len(params) > 1: | |||
| return "'~motd clean' does not take parameters" | |||
| db.motd_clean() | |||
| elif params[0] == "reorder": | |||
| if len(params) < 2: | |||
| return "Missing params (~motd reorder X Y...)" | |||
| order = [] | |||
| for num in params[1:]: | |||
| if not db.motd_has(num): | |||
| return "Incorrect message number %s" % num | |||
| order.append(num) | |||
| db.motd_reorder(order) | |||
| else: | |||
| return "Unknown motd subcommand %s" % params[0] | |||
| elif command == 'requirevoice': | |||
| db.require_voice() | |||
| elif command == 'alloweveryone': | |||
| db.allow_everyone() | |||
| elif command == 'list': | |||
| return 'Available tracks: ' + str.join(' ', db.list_tracks()) | |||
| elif command in ('clean', 'add', 'del'): | |||
| if len(params) < 1: | |||
| return "This command takes one or more arguments" | |||
| getattr(db, command + '_tracks')(params[1:]) | |||
| else: | |||
| return "Unknown command '%s'" % command | |||
+ 36
- 210
ptgbot/bot.py
View File
+ 9
- 6
ptgbot/tests/test_message_process.py
View File
+ 117
- 0
ptgbot/trackcommands.py
View File
| @ -0,0 +1,117 @@ | |||
| # Copyright 2011, 2013, 2020 OpenStack Foundation | |||
| # | |||
| # Licensed 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 re | |||
| def notify(db, botsend, track, adverb, sentence): | |||
| location = db.get_location(track) | |||
| track = '#' + track | |||
| trackloc = track | |||
| if location is not None: | |||
| trackloc = "%s (%s)" % (track, location) | |||
| for nick, regexp in db.get_subscriptions().items(): | |||
| if regexp is None: | |||
| # Person did #unsubscribe, so skip | |||
| continue | |||
| event_text = " ".join([track, adverb, sentence]) | |||
| if re.search(regexp, event_text, re.IGNORECASE): | |||
| message = "%s in %s: %s" % (adverb, trackloc, sentence) | |||
| # Note: there is no guarantee that nick will be online | |||
| # at this point. However if not, the bot will receive | |||
| # a 401 :No such nick/channel message which it will | |||
| # ignore due to the lack of a nosuchnick handler. | |||
| # Fortunately this is the behaviour we want. | |||
| botsend(nick, message) | |||
| def not_scheduled_today(db, track): | |||
| if not db.get_track_room(track): | |||
| return ("Message added, but please note that track '%s' does not " | |||
| "appear to have a room scheduled today." % track) | |||
| def process_track_command(db, botsend, track, params): | |||
| if not db.is_track_valid(track): | |||
| return "Unknown track '%s'" % track | |||
| if len(params) < 1: | |||
| return "Missing track command (#TRACK [now|next|clean...] ...)" | |||
| adverb = params[0].lower() | |||
| sentence = str.join(' ', params[1:]) | |||
| if adverb == 'now': | |||
| if len(params) < 2: | |||
| return "Missing sentence (#TRACK now ...)" | |||
| db.add_now(track, sentence) | |||
| notify(db, botsend, track, adverb, sentence) | |||
| return not_scheduled_today(db, track) | |||
| elif adverb == 'next': | |||
| if len(params) < 2: | |||
| return "Missing sentence (#TRACK next ...)" | |||
| db.add_next(track, sentence) | |||
| notify(db, botsend, track, adverb, sentence) | |||
| return not_scheduled_today(db, track) | |||
| elif adverb == 'clean': | |||
| if len(params) > 1: | |||
| return "'#TRACK clean' does not take any parameter" | |||
| db.clean_tracks([track]) | |||
| elif adverb == 'etherpad': | |||
| if len(params) != 2: | |||
| return "'#TRACK etherpad' takes a single URL parameter" | |||
| db.add_etherpad(track, params[1]) | |||
| elif adverb == 'url': | |||
| if len(params) != 2: | |||
| return "'#TRACK url' takes a single URL parameter" | |||
| db.add_url(track, params[1]) | |||
| elif adverb == 'color': | |||
| if len(params) != 2: | |||
| return "'#TRACK color' takes a single colorcode parameter" | |||
| db.add_color(track, params[1]) | |||
| elif adverb == 'location': | |||
| db.add_location(track, sentence) | |||
| elif adverb == 'book': | |||
| if len(params) != 2: | |||
| return "'#TRACK book' takes a single slotname parameter" | |||
| room, sep, tslot = params[1].partition('-') | |||
| if db.is_slot_valid_and_empty(room, tslot): | |||
| db.book(track, room, tslot) | |||
| return "Room %s is now booked on %s for %s" % (room, tslot, track) | |||
| else: | |||
| return "Slot '%s' is invalid (or booked)" % params[1] | |||
| elif adverb == 'unbook': | |||
| if len(params) != 2: | |||
| return "'#TRACK unbook' takes a single slotname parameter" | |||
| room, sep, tslot = params[1].partition('-') | |||
| if db.is_slot_booked_for_track(track, room, tslot): | |||
| db.unbook(room, tslot) | |||
| return ("Room %s (previously booked for %s) is now free on %s" % | |||
| (room, track, tslot)) | |||
| else: | |||
| return ("Slot '%s' is invalid (or not booked for %s)" % | |||
| (params[1], track)) | |||
| else: | |||
| return ("Unknown command '%s'. Did you mean: %s now %s... ?" % | |||
| (adverb, track, adverb)) | |||