Update list formatting

[matrix-goal-bot.git] / matrix_goal_bot / bot.py

diff --git a/matrix_goal_bot/bot.py b/matrix_goal_bot/bot.py
index 957051c785f516e50764754af3c7251a7fe7b455..3da43ce9cef81f0fac125708f20c44d9d2700ca8 100644 (file)
--- a/matrix_goal_bot/bot.py
+++ b/matrix_goal_bot/bot.py
@@ -1,3 +1,39 @@
+'''
+Prefix: .goal
+
+Synax:
+    .goal COMMAND ARGS
+
+Commands:
+  help - show this help
+  extra.help - show extended help
+  add - add a goal
+  clear - clear completed tasks under current goal
+  task ID - add a task under the goal specified by ID
+  close ID - mark goal done by ID
+  done ID - mark task done by ID
+  list - list incomplete goals
+  print GOAL_ID - print a goal and all tasks
+'''
+
+ex_help = '''
+More commands:
+    add.vision - add a new vision (collection of goals)
+    close.vision ID - mark vision as complete by ID
+    dump - dump the full data set - BEWARE - so many messages
+    later VISION_ID - put off all goals in VISION for 14 days
+    list.later - list all 'later' goals
+    print.vision ID - print a vision and all goals
+    set.vision GOAL_ID VISION_ID- associate GOAL_ID with VISION_ID
+    visions - list incomplete visions
+    list.done - list completed goals
+    remove ID - remove a task by ID
+    start GOAL_ID - un-put-off a goal (reverse of later)
+    visionless - list goals with no set vision
+    wins - list recently completed goals
+'''
+
+

 from datetime import datetime as dt
 import logging
 import os
 from datetime import datetime as dt
 import logging
 import os


@@ -6,168 +42,269 @@ import simplematrixbotlib as botlib
 
 from .db import Data, pretty_print
 
 
 from .db import Data, pretty_print
 

-SERVER = os.environ.get('MATRIX_SERVER')
-BOT_NAME = os.environ.get('GOAL_BOT')
-BOT_PWD = os.environ.get('GOAL_BOT_PWD')
-
-def get_bot():
-    creds = botlib.Creds(SERVER, BOT_NAME, BOT_PWD)
-    return botlib.Bot(creds)
-

 DATE_FORMAT = '%Y-%m-%d'
 
 def today():
     return dt.now().strftime(DATE_FORMAT)
 
 DATE_FORMAT = '%Y-%m-%d'
 
 def today():
     return dt.now().strftime(DATE_FORMAT)
 

-PREFIX = '!goal'
-

 logger = logging.getLogger(__name__)
 logger = logging.getLogger(__name__)

-logging.basicConfig(filename='goals.log', encoding='utf-8', level=logging.DEBUG)
-logging.getLogger('nio').setLevel(logging.WARNING)
-
-async def do_goal(match):
-    '''
-    Prefix: !goal
-
-    Synax:
-        !goal COMMAND ARGS
-
-    Commands:
-      help - show this help
-      add - add a goal
-      add-task ID - add a task under the goal specified by ID
-      add-vision - add a new vision (collection of goals)
-      close-goal ID - mark goal done by ID
-      close-vision ID - mark vision as complete by ID
-      done ID - mark task done by ID
-      list - list incomplete goals
-      list-all - list everything
-      list-done - list completed goals
-      print GOAL_ID - print a goal and all tasks
-      print-vision ID - print a vision and all goals
-      set-vision GOAL_ID VISION_ID- associate GOAL_ID with VISION_ID
-      visions - list incomplete visions
-    '''
-
-    if match.command('setup'):
-        result = Data().setup()
-        return [result]
-
-    if match.command('add'):
-        new = ' '.join(match.args()[1:])
-        result = Data().add_goal(new)
-        return [f'Goal added with id {result}']
-
-    if match.command('list'):
-        goals = Data().get_all_goals()
-        results = ['# Goals list...']
-        for goal in goals:
-            results.append(str(goal))
-        return results
-
-
-    if match.command('list-done'):
-        goals = Data().get_done_goals()
-        results = ['# Completed Goals...']
-        for goal in goals:
-            results.append(str(goal))
-        return results
-
-
-    if match.command('add-task'):
-        goal_id = int(match.args()[1])
-        new = ' '.join(match.args()[2:])
-        result = Data().add_task(goal_id=goal_id, name=new)
-        goal,tasks = Data().get_goal(goal_id)
-        results = pretty_print(goal, tasks)
-        return results
-    # return [f'Added task with id {result}']
-
-    if match.command('add-vision'):
-        new = ' '.join(match.args()[1:])
-        result = Data().add_vision(new)
-        return [f'Vision added with id {result}']
-
-    if match.command('print'):
-        goal_id = int(match.args()[1])
-        logger.debug(f'Searching for goal {goal_id}...')
-        goal,tasks = Data().get_goal(goal_id)
-        results = pretty_print(goal, tasks)
-        return results
-
-
-    if match.command('print-vision'):
-        get_id = int(match.args()[1])
-        vision,goals = Data().get_vision(get_id)
-        results = pretty_print(vision, goals)
-        return results
-
-    if match.command('close-goal'):
-        goal_id = int(match.args()[1])
-        vision_id = Data().complete_goal(goal_id)
-        vision,goals = Data().get_vision(vision_id)
-        results = pretty_print(vision, goals)
-        return results
-
-    if match.command('close-vision'):
-        vision_id = int(match.args()[1])
-        Data().complete_vision(vision_id)
-        vision,goals = Data().get_vision(vision_id)
-        results = pretty_print(vision, goals)
-        return results
-
-    if match.command('done'):
-        task_id = int(match.args()[1])
-        goal_id = Data().complete_task(task_id)
-        goal,tasks = Data().get_goal(goal_id)
-        results = pretty_print(goal, tasks)
-        return results
-
-    if match.command('list-all'):
-        goals = Data().get_all_goals()
-        results = ['# Everything is...']
-        for goal in goals:
-            _,tasks = Data().get_goal(goal.id)
-            details = pretty_print(goal, tasks)
-            results += details
-        return results
-
-    if match.command('visions'):
-        items = Data().get_all_visions()
-        results = ['# Visions']
-        if not items:
-            results.append('-- No current visions --')
-
-        for item in items:
-            results.append(item)
-        return results
-
-
-    if match.command('set-vision'):
-        goal_id = int(match.args()[1])
-        vision_id = int(match.args()[2])
-        Data().assign_vision(goal_id=goal_id, vision_id=vision_id)
-        vision,goals = Data().get_vision(vision_id)
-        results = pretty_print(vision, goals)
-        return results
-
-    return [do_goal.__doc__]
-
-async def goal_bot(room, message, bot):
-    match = botlib.MessageMatch(room, message, bot, PREFIX)
-
-    if not match.is_not_from_this_bot() and match.prefix():
-        return
-
-    try:
+
+snark = [
+    'Ye cannot get ye flask.',
+    'Ye flask must be load bearing, or something...',
+    '''You have:
+        no tea
+    ''',
+    'How are you gentlemen?',
+    'All your base are belong to us.',
+    'You have been eaten by a groo.'
+]
+
+class GoalBot():
+    def __init__(self, matrix_server,
+                 bot_name,
+                 bot_pwd,
+                 db_file=None,
+                 bot_prefix='.goal'):
+
+        creds = botlib.Creds(matrix_server, bot_name, bot_pwd)
+        self.bot = botlib.Bot(creds)
+        self.prefix = bot_prefix
+        self.data = Data(db_file)
+
+    def run(self):
+        logger.debug('Running goal bot...')
+        self.bot.run()
+
+    async def handle_message(self, room, message):
+        match = botlib.MessageMatch(room, message, self.bot, self.prefix)
+
+        if not match.is_not_from_this_bot():
+            # Let's not talk to our-self
+            return
+
+        logger.debug(f'Message: {message}')
+        if not match.prefix():
+            logger.debug(f'{message} - did not match {self.prefix}')
+

         if match.prefix():
         if match.prefix():

-            result_lines = await do_goal(match)
-            for line in result_lines:
-                await bot.api.send_text_message(
-                    room.room_id, str(line))
-    except Exception as ex:
-        line ='Ye cannot get ye flask.'
-        await bot.api.send_text_message(
-                    room.room_id, str(line))
+            try:
+                result_lines = await self._handle_match(match)
+
+                message_lines = []
+                for line in result_lines:
+                    message_lines.append(str(line))
+
+                message = '\n'.join(message_lines)
+
+                await self.bot.api.send_text_message(
+                    room.room_id, message)
+
+            except Exception as ex:
+                logger.warn(f'Caught exception: {str(ex)}')
+                dumb_msg_idx = len(str(ex)) % len(snark)
+                dumb_msg = snark[dumb_msg_idx]
+                await self.bot.api.send_text_message(
+                    room.room_id, dumb_msg)
+
+                await self.bot.api.send_text_message(
+                    room.room_id, str(ex))
+
+
+    async def _handle_match(self, match):
+        logger.debug(f'Try to match {str(match)}')
+
+        if match.command('setup'):
+            result = self.data.setup()
+            return [result]
+
+        if match.command('add'):
+            new = ' '.join(match.args()[1:])
+            goal_id = self.data.add_goal(new)
+            results = [f'Goal added with id {goal_id}']
+
+            goals = self.data.get_all_goals()
+            results.append('# Goals list...')
+            for goal in goals:
+                results.append(str(goal))
+
+            return results
+
+        if match.command('list'):
+            logger.debug('Asked to list current goals...')
+            goals = self.data.get_current_goals()
+            results = ['# Goals list']
+            results.append('------------']
+            for goal in goals:
+                results.append(str(goal))
+            return results
+
+
+        if match.command('list.done'):
+            goals = self.data.get_done_goals()
+            results = ['# Completed Goals...']
+            for goal in goals:
+                results.append(str(goal))
+            return results
+
+        if match.command('task'):
+            new = ' '.join(match.args()[1:])
+            goal_id  = self.data.quick_add_task(new)
+            goal,tasks = self.data.get_goal(goal_id)
+            results = pretty_print(goal, tasks)
+            return results
+
+        if match.command('add.vision'):
+            new = ' '.join(match.args()[1:])
+            result = self.data.add_vision(new)
+            return [f'Vision added with id {result}']
+
+        if match.command('print'):
+            if len(match.args()) > 1:
+                goal_id = int(match.args()[1])
+            else:
+                goal_id = self.data._get_pref_goal_id()
+
+            logger.debug(f'Searching for goal {goal_id}...')
+            goal,tasks = self.data.get_goal(goal_id)
+            results = pretty_print(goal, tasks)
+
+            return results
+
+
+        if match.command('print.vision'):
+            get_id = int(match.args()[1])
+            vision,goals = self.data.get_vision(get_id)
+            results = pretty_print(vision, goals)
+            return results
+
+        if match.command('close'):
+            goal_id = int(match.args()[1])
+            vision_id = self.data.complete_goal(goal_id)
+            vision,goals = self.data.get_vision(vision_id)
+            results = pretty_print(vision, goals)
+            return results
+
+
+        if match.command('clear'):
+            if len(match.args()) > 1:
+                goal_id = int(match.args()[1])
+            else:
+                goal_id = self.data._get_pref_goal_id()
+            _ = self.data.clear(goal_id)
+
+            goal,tasks = self.data.get_goal(goal_id)
+            results = pretty_print(goal, tasks)
+            return results
+
+
+        if match.command('start'):
+            goal_id = int(match.args()[1])
+            vision,goals  = self.data.start_goal(goal_id)
+            results = pretty_print(vision, goals)
+            return results
+
+        if match.command('later'):
+            vision_id = int(match.args()[1])
+            self.data.put_off_vision(vision_id)
+            # Want to see what we just cleaned up
+            goals = self.data.get_current_goals()
+            results = ['# Goals list...']
+            for goal in goals:
+                results.append(str(goal))
+            return results
+
+
+        if match.command('close.vision'):
+            vision_id = int(match.args()[1])
+            self.data.complete_vision(vision_id)
+            vision,goals = self.data.get_vision(vision_id)
+            results = pretty_print(vision, goals)
+            return results
+
+        if match.command('done'):
+            ids = match.args()[1:]
+            for task_id in ids:
+                goal_id = self.data.complete_task(int(task_id))
+            # Print the goal of the last closed task
+            goal,tasks = self.data.get_goal(goal_id)
+            results = pretty_print(goal, tasks)
+            return results
+
+        if match.command('dump'):
+            goals = self.data.get_all_goals()
+            results = ['# Everything ... ']
+            for goal in goals:
+                _,tasks = self.data.get_goal(goal.id)
+                details = pretty_print(goal, tasks)
+                results += details
+            return results
+
+
+        if match.command('list.later'):
+            goals = self.data.get_all_goals()
+            results = ['# All Goals ... ']
+            return results
+
+        if match.command('visions'):
+            items = self.data.get_all_visions()
+            results = ['# Visions']
+            if not items:
+                results.append('-- No current visions --')
+
+            for item in items:
+                results.append(item)
+            return results
+
+        if match.command('visionless'):
+            items = self.data.visionless()
+            results = ['# Goals with no vision']
+            if not items:
+                results.append('-- No visionless goals --')
+
+            for item in items:
+                results.append(item)
+            return results
+
+        if match.command('wins'):
+            items = self.data.wins()
+            results = ['# Wins']
+            if not items:
+                results.append('-- No wins yet --')
+
+            for item in items:
+                results.append(item)
+            return results
+
+
+
+        if match.command('set.vision'):
+            goal_id = int(match.args()[1])
+            vision_id = int(match.args()[2])
+            self.data.assign_vision(goal_id=goal_id, vision_id=vision_id)
+            vision,goals = self.data.get_vision(vision_id)
+            results = pretty_print(vision, goals)
+            return results
+
+
+        if match.command('rename'):
+            goal_id = int(match.args()[1])
+            name = ' '.join(match.args()[2:])
+            self.data.rename_goal(goal_id=goal_id, name=name)
+            goal,tasks = self.data.get_goal(goal_id)
+            results = pretty_print(goal, tasks)
+            return results
+
+        if match.command('remove'):
+            task_id  = int(match.args()[1])
+            result = self.data.remove_task(task_id)
+            return [result]
+
+        if match.command('extra.help'):
+            return [ex_help]
+
+        # Help text
+        return [__doc__]
+