Merge pull request #5 from Garulf/feat-Check-list

Feature: Toggle Checklists via Context Menu

Author: Garulf

plugin.json

@@ -4,7 +4,7 @@
   "Name": "Obsidian Notes",
   "Description": "Search Obsidian notes",
   "Author": "Garulf",
-  "Version": "1.0.2",
+  "Version": "1.1.0",
   "Language": "python",
   "Website": "https://github.com/Garulf/obsidian-notes",
   "IcoPath": "./icon.png",

plugin/main.py

@@ -4,6 +4,10 @@
 
 import obsidian
 
+CHECK_BOX_GLYPH = '\ue003'
+MARKED_CHECK_BOX_GLYPH = '\ue005'
+
+
 def match(query, match):
     return int(SM(lambda x: x == " ", query.lower().replace('\\', ' '), match.lower().replace('\\', ' '), autojunk=False).ratio() * 100)
 
@@ -31,10 +35,26 @@ def query(self, query):
                         method=self.open_note,
                         parameters=[vault.name, str(note.relative_path)],
                         score=score,
+                        context=[vault.id, str(note.path), note.checklists()]
                     )
 
     def context_menu(self, data):
-        pass
+        vault_id = data[0]
+        note_path = data[1]
+        for checks in data[2]:
+            self.add_item(
+                title=checks['description'],
+                subtitle=checks['title'],
+                glyph=MARKED_CHECK_BOX_GLYPH if checks['checked'] else CHECK_BOX_GLYPH,
+                method=self.toggle_checkbox,
+                parameters=[vault_id, note_path, checks['raw']],
+                dont_hide=True
+            )
+
+    def toggle_checkbox(self, vault_id, note_path, raw):
+        note = obsidian.get_note(vault_id, note_path)
+        note.toggle_checkbox(raw)
+
 
     def open_note(self, vault_name, note_path):
         obsidian.open_note(vault_name, note_path)

plugin/obsidian.py

@@ -8,6 +8,8 @@
 
 VAULTS_FILE = 'obsidian.json'
 VAULTS_PATH = Path(os.getenv('APPDATA'), 'obsidian', VAULTS_FILE)
+CHECK_BOX = '- [ ]'
+MARKED_CHECK_BOX = '- [x]'
 
 def get_vaults():
     vaults = []
@@ -22,6 +24,25 @@ def get_vaults():
             vaults.append(Vault(vault, data['vaults'][vault]))
         return vaults
 
+def get_vault(id):
+    try:
+        with open(VAULTS_PATH, 'r') as f:
+            data = json.load(f)
+    except FileNotFoundError:
+        logger.error(f'{VAULTS_PATH} not found!\nIs obsidian installed?')
+        raise
+    else:
+        try:
+            return Vault(id, data['vaults'][id])
+        except KeyError:
+            logger.error(f'{id} not found!')
+            raise
+
+def get_note(vault_id, note_path):
+    vault = get_vault(vault_id)
+    return Note(vault, note_path)
+
+
 def open_note(vault_name, note_path):
     URI = f'open?vault={vault_name}&file={note_path}'.replace(' ', '%20').replace('/', '%2F').replace('\\', '%2F')
     URI = f'obsidian://{URI}'
@@ -42,6 +63,11 @@ def notes(self):
             notes.append(Note(self, note))
         return notes
 
+    def note(self, note_path):
+        for note in self.notes():
+            if str(note.relative_path) == note_path:
+                return note
+
 
 class Note(object):
 
@@ -55,6 +81,52 @@ def __init__(self, vault: Vault, full_path: str):
     def open_note(self):
         open_note(self.vault.name, self.relative_path)
 
+    def content(self):
+        with open(self.path, 'r') as f:
+            return f.read()
+
+
+    def toggle_checkbox(self, raw):
+        content = self.content()
+        for line in content.splitlines():
+            if raw == line:
+                if MARKED_CHECK_BOX in line:
+                    toggled_line = line.replace(MARKED_CHECK_BOX, CHECK_BOX)
+                else:
+                    toggled_line = line.replace(CHECK_BOX, MARKED_CHECK_BOX)
+                break
+        content = content.replace(line, toggled_line)
+        with open(self.path, 'w') as f:
+            f.write(content)
+
+    def checklists(self):
+        checklists = []
+        title = ''
+        for line in self.content().splitlines():
+            if CHECK_BOX in line or MARKED_CHECK_BOX in line:
+                description = line.replace(CHECK_BOX, '').replace(MARKED_CHECK_BOX, '').strip()
+                if MARKED_CHECK_BOX in line:
+                    checked = True
+                else:
+                    checked = False
+                if (CHECK_BOX not in prev_line and MARKED_CHECK_BOX not in prev_line) and prev_line.endswith(':'):
+                    title = prev_line.replace(':', '').strip()
+                checklists.append(
+                    {
+                        'title': title,
+                        'description': description,
+                        'checked': checked,
+                        'raw': line
+                    }
+                )
+            else:
+                title = ''
+            prev_line = line
+        return checklists
+
+
+
+
 if __name__ == "__main__":
     vaults = get_vaults()
     for vault in vaults: