Refactor file stat and ensure Linux gets correct ctime (#338)

Look for birthtime if supported on systems. Also, move file attribute
functions to util.

Author: facelessuser

.coveragerc

@@ -2,10 +2,8 @@
 omit=
     rummage/__main__.py
     rummage/lib/gui/*
-    rummage/lib/rumcore/file_stat.py
 
 [report]
 omit=
     rummage/__main__.py
     rummage/lib/gui/*
-    rummage/lib/rumcore/file_stat.py

docs/src/markdown/changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Current
+
+- **FIX**: Better attempt to get appropriate creation on all Linux systems.
+
 ## 4.6.3
 
 - **FIX**: Notification audio failures should be handled gracefully.

rummage/lib/gui/data/docs/.dochash

@@ -1 +1 @@
-faa2ffe1ce652963b312fbd75e6d4f21
+28779be569f92b6d78c94b5e98470719

rummage/lib/gui/data/docs/changelog.html

@@ -25,6 +25,10 @@
 
   <!-- Table of Content (Don't show for static sites) -->
     <h1 id="changelog">Changelog</h1>
+<h2 id="current">Current</h2>
+<ul>
+<li><strong>FIX</strong>: Better attempt to get appropriate creation on all Linux systems.</li>
+</ul>
 <h2 id="463">4.6.3</h2>
 <ul>
 <li><strong>FIX</strong>: Notification audio failures should be handled gracefully.</li>

rummage/lib/gui/dialogs/rummage_dialog.py

@@ -63,7 +63,6 @@
 from .. import gui
 from .. import data
 from .. import notify
-from ...rumcore import epoch_timestamp
 from ... import __meta__
 from ... import rumcore
 from .. import util
@@ -1355,15 +1354,15 @@ def set_arguments(self, chain, replace):
             if cmp_modified:
                 args.modified_compare = (
                     LIMIT_COMPARE[cmp_modified],
-                    epoch_timestamp.local_time_to_epoch_timestamp(
+                    rumcore.util.local_time_to_epoch_timestamp(
                         self.m_modified_date_picker.GetValue().Format("%m/%d/%Y"),
                         self.m_modified_time_picker.GetValue()
                     )
                 )
             if cmp_created:
                 args.created_compare = (
                     LIMIT_COMPARE[cmp_created],
-                    epoch_timestamp.local_time_to_epoch_timestamp(
+                    rumcore.util.local_time_to_epoch_timestamp(
                         self.m_modified_date_picker.GetValue().Format("%m/%d/%Y"),
                         self.m_modified_time_picker.GetValue()
                     )

rummage/lib/rumcore/__init__.py

@@ -32,7 +32,6 @@
 from collections import deque
 from . import text_decode
 from wcmatch import wcmatch
-from .file_stat import get_stat
 from . import util
 try:
     from backrefs import bregex
@@ -1257,7 +1256,7 @@ def on_validate_file(self, base, name):
 
         valid = not self._is_backup(name)
         fullname = os.path.join(base, name)
-        self.created_time, self.modified_time, self.current_size = get_stat(fullname)
+        self.created_time, self.modified_time, self.current_size = util.get_stat(fullname)
         if valid:
             valid = self._is_size_okay(fullname)
         if valid:
@@ -1398,7 +1397,7 @@ def __init__(
             )
         elif not self.buffer_input and os.path.isfile(self.target):
             try:
-                c_time, m_time = get_stat(self.target)
+                c_time, m_time = util.get_stat(self.target)
                 self.files.append(
                     FileAttrRecord(
                         self.target,

rummage/lib/rumcore/epoch_timestamp.py

@@ -1,5 +1,8 @@
 """Compatibility module."""
 import sys
+import os
+from datetime import datetime, timedelta, tzinfo
+
 
 if sys.platform.startswith('win'):
     _PLATFORM = "windows"
@@ -8,8 +11,54 @@
 else:
     _PLATFORM = "linux"
 
+ZERO = timedelta(0)
+
 
 def platform():
     """Get Platform."""
 
     return _PLATFORM
+
+
+def get_stat(pth):
+    """Get file status."""
+
+    st = os.stat(pth)
+    try:
+        st_ctime = st.st_birthtime if platform() != "windows" else st.st_ctime
+    except AttributeError:
+        st_ctime = st.st_ctime
+    return st_ctime, st.st_mtime, st.st_size
+
+
+class UTCTimezone(tzinfo):
+    """Epoch UTC time zone object."""
+
+    def utcoffset(self, dt):
+        """Return UTC offset."""
+
+        return ZERO
+
+    def tzname(self, dt):
+        """Return timezone name."""
+
+        return "UTC"
+
+    def dst(self, dt):
+        """Return `dst`."""
+
+        return ZERO
+
+
+UTC = UTCTimezone()
+EPOCH = datetime(1970, 1, 1, tzinfo=UTC)
+
+
+def local_time_to_epoch_timestamp(date, time):
+    """Take a local date and time and convert it to an epoch timestamp."""
+
+    d = date.split("/")
+    t = time.split(":")
+    dt = datetime(int(d[2]), int(d[0]), int(d[1]), int(t[0]), int(t[1]), int(t[2]), 0, UTC)
+    delta = dt - EPOCH
+    return (delta.microseconds + (delta.seconds + delta.days * 24 * 3600) * 10 ** 6) / 1e6

rummage/lib/rumcore/file_stat.py

@@ -10,7 +10,6 @@
 from backrefs import bre
 from backrefs import bregex
 from rummage.lib import rumcore as rc
-from rummage.lib.rumcore import epoch_timestamp as epoch
 from rummage.lib.rumcore import text_decode as td
 from wcmatch import wcmatch
 from . import util
@@ -748,7 +747,7 @@ def test_time_modified_less(self):
             r'*.*', None,
             self.default_flags | wcmatch.RECURSIVE | wcmatch.HIDDEN,
             False, False,
-            None, ("lt", epoch.local_time_to_epoch_timestamp(date, '00:00:00')), None,
+            None, ("lt", rc.util.local_time_to_epoch_timestamp(date, '00:00:00')), None,
             None, False
         )
 
@@ -766,7 +765,7 @@ def test_time_modified_greater(self):
             r'*.*', None,
             self.default_flags | wcmatch.RECURSIVE | wcmatch.HIDDEN,
             False, False,
-            None, ("gt", epoch.local_time_to_epoch_timestamp('07/07/1980', '00:00:00')), None,
+            None, ("gt", rc.util.local_time_to_epoch_timestamp('07/07/1980', '00:00:00')), None,
             None, False
         )
 
@@ -787,7 +786,7 @@ def test_time_created_less(self):
             r'*.*', None,
             self.default_flags | wcmatch.RECURSIVE | wcmatch.HIDDEN,
             False, False,
-            None, None, ("lt", epoch.local_time_to_epoch_timestamp(date, '00:00:00')),
+            None, None, ("lt", rc.util.local_time_to_epoch_timestamp(date, '00:00:00')),
             None, False
         )
 
@@ -805,7 +804,7 @@ def test_time_created_greater(self):
             r'*.*', None,
             self.default_flags | wcmatch.RECURSIVE | wcmatch.HIDDEN,
             False, False,
-            None, None, ("gt", epoch.local_time_to_epoch_timestamp('07/07/1980', '00:00:00')),
+            None, None, ("gt", rc.util.local_time_to_epoch_timestamp('07/07/1980', '00:00:00')),
             None, False
         )
 
@@ -885,7 +884,7 @@ def get_file_attr(self, *path):
         """Get the file attributes."""
 
         name = self.norm(*path)
-        c_time, m_time = rc.get_stat(name)[:2]
+        c_time, m_time = rc.util.get_stat(name)[:2]
         return rc.FileAttrRecord(
             name,
             os.path.splitext(name)[1].lower().lstrip('.'),