Merge pull request #241 from karlch/fix-xdg-trash

Fix compliance with the xdg trash standard

Author: karlch

docs/changelog.rst

@@ -34,6 +34,8 @@ Fixed:
 * Various issues when handling backslash and percent characters in paths and
   completions. Thanks
   `@woefe <https://github.com/woefe>`_ for pointing these out!
+* Quoting of paths and the date format of the trashinfo file created by the ``:delete``
+  command. Thanks `@woefe <https://github.com/woefe>`_ for the bug report.
 
 
 v0.7.0 (2020-05-17)

tests/end2end/features/completion/completion.feature

@@ -132,6 +132,7 @@ Feature: Using completion.
         When I run delete %
         When I run command --text="undelete "
         Then a possible completion should contain undelete image_01.jpg
+        And the trash completion for 'image_01.jpg' should show the trashinfo
 
     Scenario: Do not show trash completion in manipulate mode
         Given I open 2 images

tests/end2end/features/completion/test_completion_bdd.py

@@ -4,10 +4,13 @@
 # Copyright 2017-2020 Christian Karl (karlch) <karlch at protonmail dot com>
 # License: GNU GPL v3, see the "LICENSE" and "AUTHORS" files for details.
 
+import os
+
 import pytest
 import pytest_bdd as bdd
 
 import vimiv.gui.completionwidget
+from vimiv.utils import trash_manager
 
 
 bdd.scenarios("completion.feature")
@@ -18,21 +21,24 @@ def completionwidget():
     return vimiv.gui.completionwidget.CompletionView.instance
 
 
+@pytest.fixture()
+def completiondata(completionwidget):
+    model = completionwidget.model()
+    return [
+        [model.index(row, column).data() for column in range(model.columnCount())]
+        for row in range(model.rowCount())
+    ]
+
+
 @bdd.then("no completion should be selected")
 def check_no_completion_selected(completionwidget):
     assert not completionwidget.selectedIndexes()
 
 
 @bdd.then(bdd.parsers.parse("a possible completion should contain {text}"))
 @bdd.then("a possible completion should contain <text>")
-def check_available_completion_text(completionwidget, text):
-    model = completionwidget.model()
-    completion_data = [
-        model.index(row, column).data()
-        for row in range(model.rowCount())
-        for column in range(model.columnCount())
-    ]
-    completion_text = "\n".join(completion_data)
+def check_available_completion_text(completiondata, text):
+    completion_text = "\n".join(" ".join(row) for row in completiondata)
     assert text in completion_text
 
 
@@ -48,3 +54,21 @@ def check_selected_completion_row(completionwidget, row):
     if row == -1:
         row = completionwidget.model().rowCount() - 1
     assert completionwidget.row() == row
+
+
+@bdd.then(
+    bdd.parsers.parse("the trash completion for '{basename}' should show the trashinfo")
+)
+def check_show_deletion_date(completiondata, basename):
+    original_path, deletion_date = trash_manager.trash_info(basename)
+    # Space for formatting and remove seconds
+    expected_date = deletion_date.replace("T", " ")[:-3]
+    expected_dir = os.path.dirname(original_path)
+    for completion_text, completion_dir, completion_date in completiondata:
+        completion_basename = completion_text.replace(":undelete ", "")
+        if completion_basename == basename:
+            assert expected_date == completion_date
+            assert expected_dir == completion_dir
+            break
+    else:
+        assert False, f"Completion for '{basename}' not found"

vimiv/completion/completionmodels.py

@@ -190,6 +190,8 @@ def __init__(self):
             column_widths=(0.4, 0.45, 0.15),
             valid_modes=api.modes.GLOBALS,
         )
+        self._old_date_re = re.compile(r"(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})(\d{2})")
+        self._date_re = re.compile(r"(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})")
 
     def on_enter(self, text: str) -> None:
         """Update trash model on enter to include any newly un-/deleted paths."""
@@ -200,13 +202,16 @@ def on_enter(self, text: str) -> None:
             original, date = trash_manager.trash_info(path)
             original = original.replace(os.path.expanduser("~"), "~")
             original = os.path.dirname(original)
-            date = "%s-%s-%s %s:%s" % (
-                date[2:4],
-                date[4:6],
-                date[6:8],
-                date[9:11],
-                date[11:13],
-            )
+            date_match = self._date_re.match(date)
+            if date_match is None:
+                # Wrong date formatting that was used up to v0.7.0
+                # TODO remove after releasing v1.0.0
+                date_match = self._old_date_re.match(date)
+            if date_match is not None:
+                year, month, day, hour, minute, _ = date_match.groups()
+                date = f"{year}-{month}-{day} {hour}:{minute}"
+            else:
+                date = "date unknown"
             # Append data in column form
             data.append((cmd, original, date))
         self.set_data(data)

vimiv/utils/trash_manager.py

@@ -86,11 +86,13 @@ def trash_info(filename: str) -> Tuple[str, str]:
         original_filename: The absolute path to the original file.
         deletion_date: The deletion date.
     """
+    from urllib.parse import unquote
+
     info_filename = _get_info_filename(filename)
     info = TrashInfoParser()
     info.read(info_filename)
     content = info["Trash Info"]
-    original_filename = content["Path"]
+    original_filename = unquote(content["Path"])
     deletion_date = content["DeletionDate"]
     return original_filename, deletion_date
 
@@ -132,13 +134,15 @@ def _create_info_file(trash_filename: str, original_filename: str) -> None:
         trash_filename: The name of the file in self.files_directory.
         original_filename: The original name of the file.
     """
+    from urllib.parse import quote
+
     # Write to temporary file and use shutil.move to make sure the
     # operation is an atomic operation as specified by the standard
     temp_file = tempfile.NamedTemporaryFile(dir=_info_directory, delete=False, mode="w")
     info = TrashInfoParser()
     info["Trash Info"] = {
-        "Path": original_filename,
-        "DeletionDate": time.strftime("%Y%m%dT%H%M%S"),
+        "Path": quote(original_filename),
+        "DeletionDate": time.strftime("%Y-%m-%dT%H:%M:%S"),
     }
     info.write(temp_file, space_around_delimiters=False)
     # Move to proper filename