Release v1.0.0

Author: simsekhalit

.gitignore

@@ -0,0 +1,6 @@
+*.egg-info/
+.idea
+__pycache__
+build/
+dist/
+venv

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Halit Şimşek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,37 @@
+# Mtime Fixer
+Mtime Fixer is a tool for fixing inconsistent timestamp metadata (atime, ctime, and mtime).
+Sometimes timestamp metadata of folders are inconsistent with files inside them.
+Mtime Fixer is a program for setting mtime (modification time) timestamp of folders according to files inside them.
+Additionally, it can set ctime (change time) metadata as the same as mtime as well (with root privileges).
+
+## Requirements
+Python >= 3.8 is required. (CPython and PyPy are both supported)
+
+## Installation
+Mtime Fixer can be either installed directly via pip:
+```shell
+pip install mtime-fixer
+```
+Or it can be installed from the source:
+```shell
+git clone https://github.com/simsekhalit/mtime-fixer.git
+python3 -m pip install ./mtime-fixer
+```
+
+## Manual
+```
+$ python3 -m mtime_fixer --help
+usage: mtime-fixer [-h] [-c] [-f] PATH [PATH ...]
+
+A tool for fixing inconsistent timestamp metadata (atime, ctime, and mtime).
+
+positional arguments:
+  PATH
+
+optional arguments:
+  -h, --help        show this help message and exit
+  -c, --fix-ctimes  change ctimes as well (requires root priviledges)
+  -f, --fix-files   change timestamps of files as well
+
+For more information: https://github.com/simsekhalit/mtime-fixer
+```

mtime_fixer/__init__.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python3
+from .core import *
+
+__version__ = "1.0.0"
+__version_info__ = (1, 0, 0)

mtime_fixer/__main__.py

@@ -0,0 +1,6 @@
+#!/usr/bin/env python3
+import sys
+
+from .cli import main
+
+main(sys.argv[1:])

mtime_fixer/cli.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python3
+import argparse
+import sys
+from typing import Sequence
+
+from .core import MtimeFixer
+
+__all__ = [
+    "main",
+    "parse_args",
+]
+
+
+def parse_args(args: Sequence[str]) -> argparse.Namespace:
+    description = "A tool for fixing inconsistent timestamp metadata (atime, ctime, and mtime)."
+    epilog = "For more information: https://github.com/simsekhalit/mtime-fixer"
+    parser = argparse.ArgumentParser("mtime-fixer", description=description, epilog=epilog)
+    parser.add_argument("-c", "--fix-ctimes", action="store_true",
+                        help="change ctimes as well (requires root priviledges)")
+    parser.add_argument("-f", "--fix-files", action="store_true", help="change timestamps of files as well")
+    parser.add_argument("paths", metavar="PATH", nargs="+")
+
+    return parser.parse_args(args)
+
+
+def main(args: Sequence[str]) -> None:
+    args = parse_args(args)
+    mtime_fixer = MtimeFixer(args.fix_ctimes, args.fix_files)
+    mtime_fixer.fix(args.paths)
+
+
+if __name__ == "__main__":
+    main(sys.argv[1:])

mtime_fixer/core.py

@@ -0,0 +1,107 @@
+#!/usr/bin/env python3
+import os
+import stat
+from typing import List
+
+
+class MtimeFixer:
+    def __init__(self, fix_ctimes: bool = False, fix_files: bool = False):
+        self.fix_ctimes: bool = False
+        self.fix_files: bool = fix_files
+        self.librt = None
+
+        if fix_ctimes:
+            if self._setup_librt():
+                self.fix_ctimes = True
+
+    def _setup_librt(self) -> bool:
+        global ctypes, timespec
+        import ctypes.util
+
+        librt = ctypes.util.find_library("rt")
+        if not librt:
+            return False
+        try:
+            self.librt = ctypes.CDLL(librt)
+        except Exception:
+            return False
+
+        class timespec(ctypes.Structure):
+            _fields_ = [("tv_sec", ctypes.c_long),
+                        ("tv_nsec", ctypes.c_long)]
+
+        return True
+
+    @staticmethod
+    def _enable_ntp() -> None:
+        import subprocess
+        popen = subprocess.Popen(["timedatectl", "set-ntp", "true"], stdin=subprocess.DEVNULL,
+                                 stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, start_new_session=True)
+        try:
+            popen.wait(10)
+        except subprocess.TimeoutExpired:
+            pass
+
+    def _set_time(self, time_ns: int) -> None:
+        ts = timespec(time_ns // 1_000_000_000, time_ns % 1_000_000_000)
+        self.librt.clock_settime(0, ctypes.byref(ts))
+
+    def _fix_times(self, path: str, time_ns: int) -> None:
+        if self.fix_ctimes:
+            self._set_time(time_ns)
+        os.utime(path, ns=(time_ns, time_ns), follow_symlinks=False)
+
+    def _is_fix_needed(self, stat_: os.stat_result, time_ns: int) -> bool:
+        if not self.fix_files and not stat.S_ISDIR(stat_.st_mode):
+            return False
+        elif self.fix_ctimes and abs(stat_.st_ctime_ns - time_ns) > 1_000_000_000:
+            return True
+        elif abs(stat_.st_mtime_ns - time_ns) > 1_000_000_000:
+            return True
+        else:
+            return False
+
+    def _fix_path(self, path: str) -> int:
+        current_stat = os.stat(path, follow_symlinks=False)
+        max_mtime = 0
+
+        if stat.S_ISDIR(current_stat.st_mode):
+            for child in os.listdir(path):
+                child_mtime = self._fix_path(os.path.join(path, child))
+                if child_mtime > max_mtime:
+                    max_mtime = child_mtime
+
+        if max_mtime == 0:
+            max_mtime = current_stat.st_mtime_ns
+
+        if self._is_fix_needed(current_stat, max_mtime):
+            self._fix_times(path, max_mtime)
+        return max_mtime
+
+    @staticmethod
+    def _disable_ntp() -> bool:
+        import subprocess
+        try:
+            subprocess.run(["timedatectl", "set-ntp", "false"], stdin=subprocess.DEVNULL, stdout=subprocess.PIPE,
+                           stderr=subprocess.STDOUT, universal_newlines=True, timeout=10)
+        except subprocess.TimeoutExpired as e:
+            print(f"Failed to disable ntp:\n{e.output}")
+            return False
+        else:
+            return True
+
+    def fix(self, paths: List[str]) -> bool:
+        if self.fix_ctimes:
+            success = self._disable_ntp()
+            if not success:
+                return False
+            try:
+                for path in paths:
+                    self._fix_path(path)
+            finally:
+                self._enable_ntp()
+        else:
+            for path in paths:
+                self._fix_path(path)
+
+        return True

setup.py

@@ -0,0 +1,86 @@
+#!/usr/bin/env python3
+import os
+import re
+import shutil
+import subprocess
+import sys
+
+from setuptools import Command, setup
+
+
+class UploadCommand(Command):
+    """Support setup.py upload."""
+
+    description = "Build and publish the package."
+    user_options = []
+
+    @staticmethod
+    def status(s):
+        """Prints things in bold."""
+        print('\033[1m{0}\033[0m'.format(s))
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        try:
+            self.status("Cleaning previous builds...")
+            for p in ("build", "dist", *(p for p in os.listdir(setup_dir) if p.endswith(".egg-info"))):
+                shutil.rmtree(os.path.join(setup_dir, p), True)
+        except OSError:
+            pass
+
+        self.status("Building Source and Wheel (universal) distribution...")
+        subprocess.run([sys.executable, "-m", "build"], check=True)
+
+        self.status("Uploading the package to PyPI via Twine...")
+        dist_dir = os.path.join(setup_dir, "dist")
+        subprocess.run(["twine", "upload", *(os.path.join(dist_dir, p) for p in os.listdir(dist_dir))], check=True)
+
+        self.status("Pushing git tags...")
+        subprocess.run(["git", "tag", f"v{version}"], check=True)
+        subprocess.run(["git", "push", "--tags"], check=True)
+
+
+setup_dir = os.path.abspath(os.path.dirname(__file__))
+
+with open(os.path.join(setup_dir, "README.md"), "r") as f:
+    long_description = f.read()
+
+with open(os.path.join(setup_dir, "mtime_fixer", "__init__.py"), "r") as f:
+    version = re.search(r"__version__\s*=\s*['\"](.+)['\"]", f.read()).group(1)
+
+
+setup(
+    author="Halit Şimşek",
+    author_email="mail.simsekhalit@gmail.com",
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: Implementation :: CPython",
+        "Programming Language :: Python :: Implementation :: PyPy",
+        "Topic :: System :: Archiving",
+    ],
+    cmdclass={
+        "upload": UploadCommand,
+    },
+    description="A tool for fixing inconsistent timestamp metadata (atime, ctime, and mtime).",
+    keywords=["atime", "ctime", "metadata", "mtime"],
+    license="MIT",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    name="mtime-fixer",
+    packages=["mtime_fixer"],
+    python_requires=">=3.8",
+    url="https://www.github.com/simsekhalit/mtime-fixer",
+    version=version,
+)