465 lines
18 KiB
Python
Executable file
465 lines
18 KiB
Python
Executable file
#!/usr/bin/env python3
|
|
#encoding: utf-8
|
|
|
|
import os
|
|
import sys
|
|
import time
|
|
import glob
|
|
import shutil
|
|
import logging
|
|
import datetime
|
|
import subprocess
|
|
|
|
try:
|
|
from sdbus_block.notifications import FreedesktopNotifications
|
|
except Exception as e:
|
|
print("WARNING:", e, file=sys.stderr)
|
|
print("WARNING: Suitable `sdbus` module cannot be loaded, the --dbus action is disabled.", file=sys.stderr)
|
|
HAS_DBUS = False
|
|
else:
|
|
HAS_DBUS = True
|
|
|
|
from watchdog.observers import Observer
|
|
from watchdog.events import LoggingEventHandler
|
|
from watchdog.events import FileSystemEventHandler
|
|
|
|
|
|
def last_of(us):
|
|
return us[-1]
|
|
|
|
|
|
class Flick:
|
|
def __init__(self, target, date, ext = None):
|
|
self.target = target
|
|
self.date = date
|
|
self.ext = ext
|
|
|
|
def __repr__(self):
|
|
return f"Flick({self.date},{self.target},{self.ext})"
|
|
|
|
|
|
class Flicker:
|
|
"""Build a new timestamped file name."""
|
|
def __init__(self, targets, delay=10):
|
|
self.targets = targets
|
|
self.delay = delay
|
|
self.last_date = {}
|
|
|
|
def __call__(self):
|
|
for target in self.targets:
|
|
name,ext = os.path.splitext(target)
|
|
date_now = datetime.datetime.now()
|
|
|
|
if target in self.last_date:
|
|
logging.debug(f"Target already actionned at {self.last_date[target]}")
|
|
logging.debug("Current date: %s", date_now.isoformat())
|
|
assert(self.last_date[target] <= date_now)
|
|
|
|
if date_now - self.last_date[target] < datetime.timedelta(seconds=self.delay):
|
|
logging.debug("Delay passed, current delta: %s < %s", date_now - self.last_date[target],datetime.timedelta(seconds=self.delay))
|
|
yield Flick(target, self.last_date[target], ext)
|
|
self.last_date[target] = date_now
|
|
else:
|
|
logging.debug("Delay not passed")
|
|
else:
|
|
self.last_date[target] = date_now
|
|
yield Flick(target, date_now, ext)
|
|
|
|
|
|
class Handler(FileSystemEventHandler):
|
|
"""Event handler, will call a sequence of operators at each event matching the target."""
|
|
def __init__(self, operators, flicker, watched_events = ["modified"] ):
|
|
self.flicker = flicker
|
|
self.ops = operators
|
|
self.watched_events = watched_events
|
|
|
|
def on_any_event(self, event):
|
|
logging.debug(f"##############################\n\t\t\tRECEIVED EVENT:")
|
|
logging.debug(f"{event}")
|
|
super(Handler,self).on_any_event(event)
|
|
for flick in self.flicker():
|
|
logging.debug(f"Created flick: {flick}")
|
|
# Watchdog cannot watch single files (FIXME bugreport?),
|
|
# so we filter it in this event handler.
|
|
if (not event.is_directory) and os.path.abspath(event.src_path) == os.path.abspath(flick.target) and event.event_type in self.watched_events:
|
|
logging.debug("Handle event")
|
|
logging.debug("New flick for %s: %s", event.src_path, flick)
|
|
|
|
for op in self.ops:
|
|
logging.debug("Calling %s", op)
|
|
op(os.path.abspath(event.src_path), flick, event)
|
|
else:
|
|
is_dir = ""
|
|
if event.is_directory:
|
|
is_dir = " is a directory"
|
|
is_not_target = ""
|
|
if os.path.abspath(event.src_path) != os.path.abspath(flick.target):
|
|
is_not_target = " is not a target"
|
|
is_not_watched = ""
|
|
if event.event_type not in self.watched_events:
|
|
is_not_watched = " is not a watched event"
|
|
|
|
logging.debug("Not handling event:" + ", ".join([i for i in [is_dir, is_not_target, is_not_watched] if i != ""]))
|
|
|
|
|
|
class Operator:
|
|
"""Interface example for an Operator (but can actually be any callable with the same signature)."""
|
|
|
|
def __call__(self, target, flick, event, alt_ext = None):
|
|
raise NotImplemented
|
|
|
|
|
|
class Save(Operator):
|
|
"""Make a copy of the target file.
|
|
Takes care to create a missing directory if necessary."""
|
|
def __repr__(self):
|
|
return f"Save({self.last_date})"
|
|
|
|
def __init__(self, save_dir, date_sep, date_template, no_overwrite = False):
|
|
self.date_template = date_template
|
|
self.save_dir = save_dir
|
|
self.date_sep = date_sep
|
|
self.no_overwrite = no_overwrite
|
|
|
|
# Alternate last_date, xtracted from the file's timestamp.
|
|
self.last_date = None
|
|
|
|
# Make a glob search expression with the date template.
|
|
self.fields = {'Y':4,'m':2,'d':2,'H':2,'M':2,'S':2}
|
|
self.glob_template = self.date_template
|
|
for k in self.fields:
|
|
self.glob_template = self.glob_template.replace("%"+k,'?'*self.fields[k])
|
|
|
|
def as_file(self, flick):
|
|
# Assemble the flick properties as if it was a file.
|
|
# Current date with second precision (i.e. without micro-seconds).
|
|
tag = flick.date.isoformat().split(".")[0]
|
|
name,ext = os.path.splitext(flick.target)
|
|
if flick.ext:
|
|
ext = flick.ext
|
|
flickname = name + self.date_sep + tag + ext
|
|
return os.path.join(self.save_dir, flickname)
|
|
|
|
def find_last_save(self, target):
|
|
full = os.path.expanduser(target)
|
|
head = os.path.basename(full)
|
|
name,ext = os.path.splitext(head)
|
|
|
|
pattern = name+self.date_sep+self.glob_template+ext
|
|
logging.debug("Search pattern: %s", pattern)
|
|
|
|
existing = glob.glob(os.path.join(self.save_dir,pattern))
|
|
logging.debug("Matching files: %s", existing)
|
|
|
|
if existing:
|
|
last = last_of(sorted(existing))
|
|
root,ext = os.path.splitext(last)
|
|
last_name = os.path.basename(root)
|
|
# As we globbed the pattern, no need for complex regexp.
|
|
last_tag = last_of(last_name.split(self.date_sep))
|
|
last_date = datetime.datetime.strptime(last_tag, self.date_template)
|
|
logging.debug("Last flick at: %s", last_date.isoformat())
|
|
return last_date
|
|
|
|
logging.debug("No previous save found.")
|
|
return None
|
|
|
|
def save(self, flick):
|
|
flickfile = self.as_file(flick)
|
|
if self.no_overwrite and os.path.is_file(flickfile):
|
|
index = 1
|
|
while os.path.is_file(flickfile):
|
|
name,ext = os.path.splitext(flickfile)
|
|
flickfile = name+self.date_sep+index+ext
|
|
index += 1
|
|
logging.info("Copy %s as %s", target, flickfile)
|
|
try:
|
|
shutil.copy(target, flickfile)
|
|
except FileNotFoundError:
|
|
logging.warning('WARNING create missing directory: %s',os.path.dirname(flickfile))
|
|
os.mkdir(os.path.dirname(flickfile))
|
|
shutil.copy(target, flickfile)
|
|
#FIXME more error handling?
|
|
except:
|
|
logging.error("ERROR while copying file: %s", sys.exc_info()[0])
|
|
|
|
self.last_date = self.find_last_save(self.flick.target)
|
|
|
|
def __call__(self, target, flick, event, alt_ext = None):
|
|
self.last_date = self.find_last_save(self.flick.target)
|
|
if self.last_date:
|
|
logging.debug("Current date: %s", date_now.isoformat())
|
|
assert(self.last_date <= date_now)
|
|
|
|
if date_now - self.last_date < datetime.timedelta(seconds=self.delay):
|
|
logging.debug("Current delta: %s < %s", date_now - self.last_date,datetime.timedelta(seconds=self.delay))
|
|
save(flick)
|
|
else:
|
|
logging.info("Delay not reached, I will not save.")
|
|
else:
|
|
save(flick)
|
|
|
|
|
|
class Command(Save):
|
|
"""Run a user-defined command.
|
|
Takes the target and the flick as argument.
|
|
The command should be a python 3 format string.
|
|
For example: 'cp {target} {flick}'
|
|
You can omit one of the named arguments.
|
|
For example: 'touch {flick}'"""
|
|
|
|
def __init__(self, command, save_dir = ".", date_sep = "_", date_template = '%Y-%m-%dT%H:%M:%S', alt_ext = None, no_overwrite = False):
|
|
super(type(self),self).__init__(save_dir, date_sep, date_template)
|
|
|
|
self.cmd = command
|
|
self.alt_ext = alt_ext
|
|
self.no_overwrite = no_overwrite
|
|
|
|
def __repr__(self):
|
|
return f"Command(\"{self.cmd}\",{self.save_dir}, {self.date_sep},{self.date_template},{self.alt_ext},{self.no_overwrite})"
|
|
|
|
def __call__(self, target, flick, event):
|
|
# Change the extension, if asked.
|
|
flickname,flickext = os.path.splitext(flick.target)
|
|
if self.alt_ext:
|
|
flick.ext = self.alt_ext
|
|
|
|
cmd = self.cmd.format(
|
|
target = flick.target,
|
|
flick = self.as_file(flick),
|
|
directory = self.save_dir,
|
|
separator = self.date_sep,
|
|
timestamp = flick.date,
|
|
alt_ext = self.alt_ext,
|
|
no_overwrite = int(self.no_overwrite),
|
|
event = event.event_type,
|
|
)
|
|
logging.info("Run command: %s", cmd)
|
|
try:
|
|
# We want the shell because we may call shell command or need environment variables.
|
|
proc = subprocess.run(cmd, shell=True, check=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
|
except subprocess.CalledProcessError as err:
|
|
logging.error("ERROR while calling command")
|
|
logging.error("\tReturn code: %s",err.returncode)
|
|
logging.error("\tOut: %s",err.stdout)
|
|
logging.error("\tErr: %s",err.stderr)
|
|
except:
|
|
logging.error("ERROR while calling subprocess: %s", sys.exc_info()[0])
|
|
|
|
logging.debug("Command ended.")
|
|
|
|
|
|
class Log(Operator):
|
|
def __repr__(self):
|
|
return "Log()"
|
|
|
|
def __call__(self, target, flick, event, alt_ext = None):
|
|
logging.info(f"File {target} was {event.event_type}")
|
|
|
|
|
|
if HAS_DBUS:
|
|
class DBus(Operator):
|
|
def __repr__(self):
|
|
return "Log()"
|
|
|
|
def __call__(self, target, flick, event, alt_ext = None):
|
|
logging.info(f"File {target} was {event.event_type}")
|
|
notif = FreedesktopNotifications()
|
|
hints = notif.create_hint(
|
|
urgency = 0,
|
|
category = "transfer", # See https://specifications.freedesktop.org/notification-spec/latest/categories.html
|
|
)
|
|
# app_name='', replaces_id=0, app_icon='', summary='', body='', actions=[], hints={}, expire_timeout=-1
|
|
notif.notify(
|
|
app_name = "FlickSave",
|
|
summary = f"File {target} was {event.event_type}",
|
|
body = str(flick),
|
|
hints = hints,
|
|
)
|
|
|
|
|
|
def flicksave(globbed_targets, operators=None, delay=10, watched=["modified"]):
|
|
"""Start the watch thread."""
|
|
|
|
targets = [os.path.abspath(p) for p in globbed_targets]
|
|
logging.debug(f"Watching {len(targets)} files.")
|
|
|
|
root = os.path.commonpath(targets)
|
|
if os.path.isfile(root):
|
|
root = os.path.dirname(root)
|
|
logging.debug(f"Watching at root directory: `{root}`.")
|
|
|
|
flicker = Flicker(targets, delay)
|
|
|
|
handler = Handler(operators, flicker, watched)
|
|
|
|
# Start the watch thread.
|
|
observer = Observer()
|
|
observer.schedule(handler, root)
|
|
logging.debug("Start watching...")
|
|
observer.start()
|
|
try:
|
|
while True:
|
|
time.sleep(1)
|
|
except KeyboardInterrupt:
|
|
observer.stop()
|
|
observer.join()
|
|
|
|
|
|
if __name__=="__main__":
|
|
import sys
|
|
import argparse
|
|
|
|
class SaneHelpFormatter(
|
|
argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter
|
|
):
|
|
pass
|
|
|
|
# With default values in help message.
|
|
parser = argparse.ArgumentParser(formatter_class=SaneHelpFormatter,
|
|
description="Perofm an action each time a file is touched. For example: make a copy of a file each time it is modified.",
|
|
epilog="""Examples:
|
|
Copy the file each time it is modified:
|
|
flicksave --save my_file
|
|
Copy the file in a subdirectory each time it is modified:
|
|
flicksave --directory snapshots --save my_file
|
|
Export a PNG from a watched SVG, each time you hit 'save' in inkscape:
|
|
flicksave --inkscape my_file
|
|
Git commit the file if it has been modified, but not before 30 seconds after the previous commit:
|
|
flicksave --git --delay 30 my_file
|
|
Copy the file each time is is opened or closed:
|
|
flicksave --events opened closed --save my_file
|
|
You may want to save both the file before and after it was modified by any
|
|
program:
|
|
flicksave --save --events opened closed --no-overwrite my_file
|
|
""")
|
|
|
|
# Required argument.
|
|
parser.add_argument("targets", nargs="+",
|
|
help="The files to save each time it's modified.")
|
|
|
|
# Optional arguments.
|
|
parser.add_argument("-d","--directory", default='.',
|
|
help="The directory in which to copy the saved versions.")
|
|
|
|
parser.add_argument("-y","--delay", default=10, type=int,
|
|
help="The minimum time (in seconds) between the creation of different saved files.")
|
|
|
|
parser.add_argument("-e","--events", default="modified", nargs="*",
|
|
choices = ["opened", "moved", "deleted", "created", "modified", "closed"],
|
|
help="The event(s) on which you want to perform the action.")
|
|
|
|
parser.add_argument("-s","--separator", default='_',
|
|
help="Separator character between the file name and the date stamp.")
|
|
|
|
parser.add_argument("-t","--template", default='%Y-%m-%dT%H:%M:%S',
|
|
help="Template of the date stamp.")
|
|
|
|
parser.add_argument("-w", "--no-overwrite", action="store_true",
|
|
help="Do not overwrite snapshots created at the same time, but append a number to their name.")
|
|
|
|
parser.add_argument("-x", "--alt-ext", metavar="EXTENSION", default='',
|
|
help="Alternate extension for the timestamped snapshot (do not forget the dot).")
|
|
|
|
parser.add_argument("-v","--verbose", choices=['DEBUG','INFO','WARNING','ERROR'], default='INFO',
|
|
help="Verbosity level.")
|
|
log_as = { 'DEBUG' :logging.DEBUG,
|
|
'INFO' :logging.INFO,
|
|
'WARNING':logging.WARNING,
|
|
'ERROR' :logging.ERROR }
|
|
|
|
parser.add_argument("--cmd", metavar="COMMAND", type=str,
|
|
help="Execute the provided command as a action. You can use the following tags: {target} (watched file), {flick} (timestamped filename), {directory} (--directory where to put timestamped files), {separator} (--separator), {timestamp} (the timestamp formatted by --template), {alt_ext} (--alt-ext alternate extension), {no_overwrite} (--no-overwrite boolean, 1 if True, 0 if False), {event} (the event type).")
|
|
|
|
existing = {
|
|
"save":
|
|
["Save a snapshot of the target files.",
|
|
None],
|
|
"inkscape":
|
|
["Save a PNG snapshot of the files, using inkscape.",
|
|
None],
|
|
"git":
|
|
["Commit the target files if it has been modified [the repository should be set-up].",
|
|
None],
|
|
"log":
|
|
["Log when the target files are touched.",
|
|
None],
|
|
}
|
|
if HAS_DBUS:
|
|
existing["dbus"] = \
|
|
["Send a notification (on the system's D-Bus).",
|
|
None]
|
|
|
|
if shutil.which("zenity") and os.environ.get('DISPLAY'):
|
|
HAS_ZENITY = True
|
|
existing["zenity"] = ["Pop-up a dialog boz each time a file is touched.", None]
|
|
else:
|
|
HAS_ZENITY = False
|
|
has_zen = ""
|
|
if not shutil.which("zenity"):
|
|
has_zen = "`zenity` command not found, "
|
|
has_X = ""
|
|
if not os.environ.get('DISPLAY'):
|
|
has_X = "No graphical display found, "
|
|
logging.warning(has_X + has_zen + "the --zenity action is disabled.")
|
|
|
|
def help(name):
|
|
return existing[name][0]
|
|
|
|
for name in existing:
|
|
parser.add_argument("--"+name, help=help(name), action="store_true")
|
|
|
|
asked = parser.parse_args()
|
|
|
|
logging.basicConfig(level=log_as[asked.verbose], format='%(asctime)s -- %(message)s', datefmt=asked.template)
|
|
|
|
logging.debug("Load actions...")
|
|
|
|
# Add instances, now that we have all parameters.
|
|
available = existing;
|
|
available["save"][1] = Save(asked.directory, asked.separator, asked.template, asked.no_overwrite)
|
|
available["inkscape"][1] = Command("inkscape {target} --without-gui --export-png={flick} --export-area-page", asked.directory, asked.separator, asked.template, "png", asked.no_overwrite)
|
|
available["git"][1] = Command("git add {target} ; git commit -m 'Automatic flicksave commit: {flick}'")
|
|
available["log"][1] = Log()
|
|
available["cmd"] = ["", Command(asked.cmd, asked.directory, asked.separator, asked.template, asked.alt_ext, asked.no_overwrite)]
|
|
|
|
if HAS_ZENITY:
|
|
available["zenity"][1] = Command("zenity --info --text 'File {target} was {event}'")
|
|
|
|
if HAS_DBUS:
|
|
available["dbus"][1] = DBus()
|
|
|
|
# Check that both available and existing are aligned.
|
|
for op in existing:
|
|
assert op in available
|
|
for op in available:
|
|
assert op in existing
|
|
|
|
logging.debug("Available operators:")
|
|
for name in available:
|
|
logging.debug("\t%s",name)
|
|
|
|
operators = []
|
|
requested = vars(asked)
|
|
def instance(name):
|
|
return available[name][1]
|
|
for it in [iz for iz in requested if iz in available and requested[iz]]:
|
|
operators.append(instance(it))
|
|
|
|
if len(operators) == 0:
|
|
logging.warning(
|
|
"WARNING: you did not asked for any snapshot command, "
|
|
"I will only log when you save the file, but not perform any action. "
|
|
"Use one of the following option if you want me to do something: "
|
|
+", ".join(["--"+str(k) for k in available.keys()])
|
|
)
|
|
operators.append(Log())
|
|
|
|
logging.debug("Used operators:")
|
|
for op in operators:
|
|
logging.debug("\t%s", op)
|
|
|
|
# Start it.
|
|
logging.debug(asked.targets)
|
|
flicksave(asked.targets, operators, asked.delay, asked.events)
|
|
|