Begin tracking ufpsutil

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,36 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../..')) # libufps dir
+
+project = 'libufps'
+copyright = '2024, Innovation Science'
+author = 'Innovation Science'
+release = '0.1.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+	'sphinx.ext.autodoc',
+	'sphinx.ext.autosummary',
+]
+autosummary_generate = True
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']

docs/source/index.rst

@@ -0,0 +1,30 @@
+libufps
+=======
+
+**ufpsutil**
+
+Unix File Permission Supplicant Utility - A simple utility that indexes directories and records their Unix permission and ownership data.
+
+**Purpose**
+
+The purpose of this project is to recursively delve into subdirectories and record their Unix file permissions and ownership information.
+
+Most offsite backup solutions (such as Backblaze) don't store file permissions or ownership information. This means that in the event that data needs to be restored from them, time will need to be taken in order to update permissions and owners, which adds additional downtime.
+
+Naturally, enterprises have solutions to this, but self hosters may not. This project aims to remedy that.
+
+The idea is to record all of this information to a text file, which is backed up off-site as a normal file. This file can then be read by the utility to restore permissions, thereby making the restored backup as close as possible to how it was before it crashed. If mounted to the same locations, this solves any permissions issues a self hoster could face getting back up and running after a catastrophe.
+
+**libufps**
+
+libufps is a modulized version of ufpsutil. Most of ufpsutil's code resides in libufps.
+
+**Status**
+	- ❎ Recurse a directory (index)
+	- ❎ Store Unix file permissions and ownership data
+	- ❎ Restore Unix file permissions and ownership data using index file as an input
+	- ❎ Diff index file and restored backup and inform the user of file inconsistencies
+
+.. toctree::
+	libufps
+	ufpsutil

docs/source/libufps.rst

@@ -0,0 +1,8 @@
+libufps
+=======
+
+.. autosummary::
+	:toctree: _autosummary
+	:recursive:
+
+	libufps.ufps.ufps

docs/source/ufpsutil.rst

@@ -0,0 +1,11 @@
+ufpsutil
+========
+
+Driver for libufps
+
+..
+	.. autosummary::
+		:toctree: _autosummary
+		:recursive:
+
+		libufps.ufps.ufps

libufps/__init__.py

@@ -0,0 +1,3 @@
+#import ufps
+
+#ufps = ufps.UFPS

libufps/ufps.py

@@ -0,0 +1,147 @@
+import os
+import stat
+import pwd
+import grp
+
+class ufps:
+	"""
+	Primary class for libufps
+	"""
+
+	def __init__(self, basedir):
+		"""
+		Constructor method.
+		:param basedir: The input base directory from the user/program. Gets normalized later.
+		:type basedir: str
+		"""
+
+		# Normalize the directory prior to setting it.
+		self.basedir = self.normalizeInputDir(basedir)
+
+		# Now we check if the path exists and is a directory.
+		self.checkPathValidity(self.basedir)
+
+		print ("Init ufps with base dir: " + self.basedir)
+
+	def normalizeInputDir(self, dir):
+		"""
+		This function normalizes the input directory.
+		In short, it makes sure the input ends with /, as we expect that to be the case in the rest of the code.
+		:param dir: The input directory from the user/program.
+		:type dir: str
+		:return: A string representing a directory that has been normalized as described above.
+		:rtype: str
+		"""	
+
+		if(dir[-1] != '/'):
+			dir=dir+'/'
+		return dir
+
+	def checkPathValidity(self, dir):
+		"""
+		This function checks the validity of an input path.
+		Path validity means that it (1) exists and (2) is a directory.
+		:raises FileNotFoundError: The path doesn't exist at all.
+		:raises NotADirectoryError: The path is a file.
+		:param dir: Input directory.
+		:type dir: str
+		:return: `True` if path is valid, `False` if not.
+		:rtype: bool
+		"""
+
+		exist = os.path.exists(dir)
+		isdir = os.path.isdir(dir)
+
+		# For the purposes of verbosity, we check if a file with the same name
+		# exists by removing the / at the end of the directory.
+		vDir = dir[len(dir)-1]
+		vExist = os.path.exists(vDir)
+
+		# If vExist is False and exist is False, the user input a nothing burger.
+		# This results in FileNotFoundError being thrown.
+
+		# If that doesn't occur, and isdir is false, they input a file.
+		# This results in NotADirectoryError being thrown.
+
+		# If none of the above occurs, the path is valid.
+
+		if(not exist and not vExist):
+			raise FileNotFoundError("The path " + dir + " does not exist.")
+
+		if(not isdir):
+			raise NotADirectoryError("The path must be a directory.")
+
+		return isdir
+
+	def parsePerms(self, path):
+		"""
+		Parses octal permissions stats into a string. Also determines other characteristics of the path: if it's a directory, and if it's a link (and where it goes). Returns this information as well.
+		:param oct_perm: Permissions of path in octal form (i.e. 0o0100644)
+		:return pPerms: Path permissions
+		:rtype pPerms: str
+
+		:return pIsDir: Whether or not the path is a directory
+		:rtype pIsDir: bool
+
+		:return pIsLink: Whether or not the path is a link
+		:rtype pIsLink: bool
+
+		:return pLinkTarget: Where the link points to (if applicable)
+		:rtype pLinkTarget: str
+		"""
+
+		# Get stats of the file/directory
+		stats = os.stat(self.basedir+path)
+
+		# Invoke a magic spell
+		# Magic number -3 is used as for this we only need the last 3 digits.
+		# Directory and link detection is handled later.
+		pPerms = oct(stats.st_mode)[-3:]
+
+		# Get whether or not the path is a dir
+		pIsDir = os.path.isdir(path)
+
+		# Get whether or not the path is a link.
+		pIsLink = os.path.islink(path)
+
+		pLinkTarget = None
+		if pIsLink:
+			pLinkTarget = os.readlink(path)
+
+		return pPerms, pIsDir, pIsLink, pLinkTarget
+
+	def getFilePermissions(self, path):
+		"""
+		Gets Unix file permissions of a directory or file.
+		:param path: Path to directory or file
+		:type path: str
+		"""
+		# Parse oct_perm
+		permStr, isDir, isLink, linkTarget = self.parsePerms(path)
+
+		# If it's a directory, we also want to figure out if it's a link.
+		#isDirectoryLink
+
+		D_userFriendlyString = permStr + " | " + str(isDir) + " | " + str(isLink) + " | " + str(linkTarget)
+		return D_userFriendlyString
+
+	def getFileOwner(self, path):
+		"""
+		Gets file owner and group of a directory or file.
+		:param path: Path to directory or file
+		:type path: str
+
+		:return ownername: Owner name
+		:rtype ownername: str
+
+		:return groupname: Group name
+		:rtype groupname: str
+		"""
+		stats = os.stat(path)
+		uid = stats.st_uid
+		gid = stats.st_gid
+
+		ownername = pwd.getpwuid(stats.st_uid).pw_name
+		groupname = grp.getgrgid(stats.st_gid).gr_name
+
+		return ownername, groupname

requirements-lib.txt

@@ -0,0 +1,5 @@
+wheel
+setuptools
+twine
+pytest==4.4.1
+pytest-runner==4.4

setup.py

@@ -0,0 +1,9 @@
+from setuptools import find_packages, setup
+
+setup(
+	name='libufps',
+	packages=find_packages(),
+	version='0.0.0',
+	description='Unix File Permission Supplicant Utility',
+	author='Innovation Science',
+)

tests/test_libufps.py

@@ -0,0 +1 @@
+import libufps

tests/testfiles/0644

@@ -0,0 +1 @@
+File permissions should equal 0644

tests/testfiles/linktests/link

@@ -0,0 +1 @@
+linkdir/

ufpsutil.py

@@ -0,0 +1,12 @@
+from libufps import ufps
+from inspect import getmembers, isfunction
+print(getmembers(ufps, isfunction))
+
+basedir = "."
+
+ufps = ufps.ufps(basedir)
+
+print("Regular dir:  " + str(ufps.getFilePermissions("tests/testfiles/")) + " | " + str(ufps.getFileOwner("tests/testfiles/")))
+print("Regular file: " + str(ufps.getFilePermissions("tests/testfiles/0644")) + " | " + str(ufps.getFileOwner("tests/testfiles/0644")))
+print("Linked dir:   " + str(ufps.getFilePermissions("tests/testfiles/linktests/link")) + " | " + str(ufps.getFileOwner("tests/testfiles/linktests/link")))
+print("Linked file:  " + str(ufps.getFilePermissions("tests/testfiles/linktests/linkfile")) + " | " + str(ufps.getFileOwner("tests/testfiles/linktests/linkfile")))