Sanitize device names in paths sezanzeb#507 (sezanzeb#508)

Author: jonasBoss

inputremapper/configs/paths.py

@@ -86,13 +86,26 @@ def remove(path):
         os.remove(path)
 
 
+def sanitize_path_component(group_name: str) -> str:
+    """replace characters listed in
+    https://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words
+    with an underscore
+    """
+    for c in '/\\?%*:|"<>':
+        if c in group_name:
+            group_name = group_name.replace(c, "_")
+    return group_name
+
+
 def get_preset_path(group_name=None, preset=None):
     """Get a path to the stored preset, or to store a preset to."""
     presets_base = os.path.join(CONFIG_PATH, "presets")
 
     if group_name is None:
         return presets_base
 
+    group_name = sanitize_path_component(group_name)
+
     if preset is not None:
         # the extension of the preset should not be shown in the ui.
         # if a .json extension arrives this place, it has not been

tests/test.py

@@ -247,6 +247,12 @@ def read_write_history_pipe():
         "info": evdev.device.DeviceInfo(6, 1, 6, 1),
         "name": "YuBiCofooYuBiKeYbar",
     },
+    "/dev/input/event52": {
+        "capabilities": {evdev.ecodes.EV_KEY: keyboard_keys},
+        "phys": "usb-0000:03:00.0-3/input1",
+        "info": evdev.device.DeviceInfo(2, 1, 2, 1),
+        "name": "Qux/Device?",
+    },
 }
 
 

tests/unit/test_groups.py

@@ -125,6 +125,14 @@ def test_find_groups(self):
                             "key": "input-remapper Bar Device",
                         }
                     ),
+                    json.dumps(
+                        {
+                            "paths": ["/dev/input/event52"],
+                            "names": ["Qux/Device?"],
+                            "types": [KEYBOARD],
+                            "key": "Qux/Device?",
+                        }
+                    ),
                 ]
             ),
         )
@@ -142,6 +150,7 @@ def test_list_group_names(self):
                 "Foo Device",
                 "Bar Device",
                 "gamepad",
+                "Qux/Device?",
             ],
         )
 

tests/unit/test_presets.py

@@ -108,6 +108,10 @@ def test_create_preset_3(self):
         self.assertTrue(os.path.exists(f"{PRESETS}/Foo Device/pre set 2.json"))
         self.assertTrue(os.path.exists(f"{PRESETS}/Foo Device/pre set 3.json"))
 
+    def test_create_preset_4(self):
+        create_preset("Qux/Device?", "bla")
+        self.assertTrue(os.path.exists(f"{PRESETS}/Qux_Device_/bla.json"))
+
 
 class TestDeletePreset(unittest.TestCase):
     def tearDown(self):
@@ -127,6 +131,11 @@ def test_delete_preset(self):
         # if no preset in the directory, remove the directory
         self.assertFalse(os.path.exists(f"{PRESETS}/Foo Device"))
 
+        create_preset("Qux/Device?", "bla")
+        self.assertTrue(os.path.exists(f"{PRESETS}/Qux_Device_/bla.json"))
+        delete_preset("Qux/Device?", "bla")
+        self.assertFalse(os.path.exists(f"{PRESETS}/Qux_Device_/bla.json"))
+
 
 class TestRenamePreset(unittest.TestCase):
     def tearDown(self):
@@ -137,12 +146,18 @@ def test_rename_preset(self):
         create_preset("Foo Device", "preset 1")
         create_preset("Foo Device", "preset 2")
         create_preset("Foo Device", "foobar")
+        create_preset("Qux/Device?", "bla")
+
         rename_preset("Foo Device", "preset 1", "foobar")
         rename_preset("Foo Device", "preset 2", "foobar")
+        rename_preset("Qux/Device?", "bla", "blubb")
+
         self.assertFalse(os.path.exists(f"{PRESETS}/Foo Device/preset 1.json"))
         self.assertTrue(os.path.exists(f"{PRESETS}/Foo Device/foobar.json"))
         self.assertTrue(os.path.exists(f"{PRESETS}/Foo Device/foobar 2.json"))
         self.assertTrue(os.path.exists(f"{PRESETS}/Foo Device/foobar 3.json"))
+        self.assertFalse(os.path.exists(f"{PRESETS}/Qux_Device_/bla.json"))
+        self.assertTrue(os.path.exists(f"{PRESETS}/Qux_Device_/blubb.json"))
 
 
 class TestFindPresets(unittest.TestCase):
@@ -152,6 +167,9 @@ def tearDown(self):
 
     def test_get_presets(self):
         os.makedirs(os.path.join(PRESETS, "1234"))
+        os.makedirs(f"{PRESETS}/Qux_Device_")
+        os.mknod(f"{PRESETS}/Qux_Device_/blubb.json")
+        self.assertEqual(len(get_presets("Qux/Device?")), 1)
 
         os.mknod(os.path.join(PRESETS, "1234", "picture.png"))
         self.assertEqual(len(get_presets("1234")), 0)