Merge pull request #1180 from three-comrades/tag_complete

Tag completion: escape RE characters in search pattern.

Author: pazz

alot/addressbook/__init__.py

@@ -34,7 +34,7 @@ def get_contacts(self):  # pragma no cover
     def lookup(self, query=''):
         """looks up all contacts where name or address match query"""
         res = []
-        query = re.compile('.*%s.*' % query, self.reflags)
+        query = re.compile('.*%s.*' % re.escape(query), self.reflags)
         for name, email in self.get_contacts():
             if query.match(name) or query.match(email):
                 res.append((name, email))

alot/completion.py

@@ -75,7 +75,7 @@ def complete(self, original, pos):
         re_prefix = '.*' if self.match_anywhere else ''
 
         def match(s, m):
-            r = re_prefix + m + '.*'
+            r = '{}{}.*'.format(re_prefix, re.escape(m))
             return re.match(r, s, flags=self.flags) is not None
 
         return [(a, len(a)) for a in self.resultlist if match(a, pref)]

alot/settings/manager.py

@@ -320,7 +320,7 @@ def colourpick(triple):
         fallback_focus = resolve_att(onebelow_focus, default_focus)
 
         for sec in cfg['tags'].sections:
-            if re.match('^' + sec + '$', tag):
+            if re.match('^{}$'.format(re.escape(sec)), tag):
                 normal = resolve_att(colourpick(cfg['tags'][sec]['normal']),
                                      fallback_normal)
                 focus = resolve_att(colourpick(cfg['tags'][sec]['focus']),

tests/addressbook/init_test.py

@@ -65,3 +65,12 @@ def test_lookup_will_match_partial_in_the_middle(self):
         actual = abook.lookup('Own')
         expected = [contacts[1]]
         self.assertListEqual(actual, expected)
+
+    def test_lookup_can_handle_special_regex_chars(self):
+        contacts = [('name [work]', 'email@example.com'),
+                    ('My Own Name', 'other@example.com'),
+                    ('someone', 'someone@example.com')]
+        abook = _AddressBook(contacts)
+        actual = abook.lookup('[wor')
+        expected = [contacts[0]]
+        self.assertListEqual(actual, expected)

tests/completion_test.py

@@ -87,3 +87,12 @@ def test_real_name_with_quotes_and_comma(self):
         expected = [(r""""all 'fanzy' \"stuff\" at, once" <all@example.com>""",
                      50)]
         self._assert_only_one_list_entry(actual, expected)
+
+
+class StringlistCompleterTest(unittest.TestCase):
+    def test_dont_choke_on_special_regex_characters(self):
+        tags = ['[match]', 'nomatch']
+        completer = completion.StringlistCompleter(tags)
+        actual = completer.complete('[', 1)
+        expected = [(tags[0], len(tags[0]))]
+        self.assertListEqual(actual, expected)

tests/settings/manager_test.py

@@ -94,6 +94,18 @@ def test_read_notmuch_config_doesnt_exist(self):
         setting = manager.get_notmuch_setting('foo', 'bar')
         self.assertIsNone(setting)
 
+    def test_dont_choke_on_regex_special_chars_in_tagstring(self):
+        tag = 'to**do'
+        with tempfile.NamedTemporaryFile(delete=False) as f:
+            f.write(textwrap.dedent("""\
+                [tags]
+                    [[{tag}]]
+                        normal = '','', 'white','light red', 'white','#d66'
+                """.format(tag=tag)))
+        self.addCleanup(os.unlink, f.name)
+        manager = SettingsManager(alot_rc=f.name)
+        manager.get_tagstring_representation(tag)
+
 
 class TestSettingsManagerGetAccountByAddress(utilities.TestCaseClassCleanup):
     """Test the get_account_by_address helper."""