initial push
22
README.md
|
@ -1,3 +1,23 @@
|
||||||
# Python-With-Kivy-Template
|
# Python-With-Kivy-Template
|
||||||
|
|
||||||
A template project for Python with Kivy applications.
|
A template project for Python with Kivy applications.
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
* setuptools
|
||||||
|
* buildozer
|
||||||
|
* kivy[full]
|
||||||
|
* plyer
|
||||||
|
* setproctitle
|
||||||
|
|
||||||
|
|
||||||
|
### Note
|
||||||
|
There are a "\<change_me\>" strings and files that need to be set according to your app's name located at:
|
||||||
|
* \_\_builtins\_\_.py
|
||||||
|
* user_config/bin/app_name
|
||||||
|
* user_config/usr/share/app_name
|
||||||
|
* user_config/usr/share/app_name/icons/app_name.png
|
||||||
|
* user_config/usr/share/app_name/icons/app_name-64x64.png
|
||||||
|
* user_config/usr/share/applications/app_name.desktop
|
||||||
|
|
||||||
|
|
||||||
|
For the user_config, after changing names and files, copy all content to their respective destinations.
|
||||||
|
The logic follows Debian Dpkg packaging and its placement logic.
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
### Note
|
||||||
|
Copy the example and rename it to your desired name. The Main class and passed in arguments are required. You don't necessarily need to use the passed in socket_id or event_system.
|
|
@ -0,0 +1,3 @@
|
||||||
|
"""
|
||||||
|
Pligin Module
|
||||||
|
"""
|
|
@ -0,0 +1,3 @@
|
||||||
|
"""
|
||||||
|
Pligin Package
|
||||||
|
"""
|
|
@ -0,0 +1,13 @@
|
||||||
|
{
|
||||||
|
"manifest": {
|
||||||
|
"name": "Example Plugin",
|
||||||
|
"author": "John Doe",
|
||||||
|
"version": "0.0.1",
|
||||||
|
"support": "",
|
||||||
|
"requests": {
|
||||||
|
"ui_target": "plugin_control_list",
|
||||||
|
"pass_fm_events": "true",
|
||||||
|
"bind_keys": ["Example Plugin||send_message:<Control>f"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,49 @@
|
||||||
|
# Python imports
|
||||||
|
import os
|
||||||
|
import threading
|
||||||
|
import subprocess
|
||||||
|
import time
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
from kivy.uix.button import Button
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
from plugins.plugin_base import PluginBase
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# NOTE: Threads WILL NOT die with parent's destruction.
|
||||||
|
def threaded(fn):
|
||||||
|
def wrapper(*args, **kwargs):
|
||||||
|
threading.Thread(target=fn, args=args, kwargs=kwargs, daemon=False).start()
|
||||||
|
return wrapper
|
||||||
|
|
||||||
|
# NOTE: Threads WILL die with parent's destruction.
|
||||||
|
def daemon_threaded(fn):
|
||||||
|
def wrapper(*args, **kwargs):
|
||||||
|
threading.Thread(target=fn, args=args, kwargs=kwargs, daemon=True).start()
|
||||||
|
return wrapper
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class Plugin(PluginBase):
|
||||||
|
def __init__(self):
|
||||||
|
super().__init__()
|
||||||
|
|
||||||
|
self.name = "Example Plugin" # NOTE: Need to remove after establishing private bidirectional 1-1 message bus
|
||||||
|
# where self.name should not be needed for message comms
|
||||||
|
|
||||||
|
|
||||||
|
def generate_reference_ui_element(self):
|
||||||
|
button = Button(text=self.name)
|
||||||
|
button.bind(on_release=self.send_message)
|
||||||
|
return button
|
||||||
|
|
||||||
|
def run(self):
|
||||||
|
...
|
||||||
|
|
||||||
|
def send_message(self, widget=None, eve=None):
|
||||||
|
message = "Hello, World!"
|
||||||
|
event_system.emit("display_message", ("warning", message, None))
|
|
@ -0,0 +1,43 @@
|
||||||
|
# Python imports
|
||||||
|
import builtins
|
||||||
|
import threading
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
from utils.event_system import EventSystem
|
||||||
|
from utils.endpoint_registry import EndpointRegistry
|
||||||
|
# from utils.keybindings import Keybindings
|
||||||
|
from utils.logger import Logger
|
||||||
|
from utils.settings import Settings
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# NOTE: Threads WILL NOT die with parent's destruction.
|
||||||
|
def threaded_wrapper(fn):
|
||||||
|
def wrapper(*args, **kwargs):
|
||||||
|
threading.Thread(target=fn, args=args, kwargs=kwargs, daemon=False).start()
|
||||||
|
return wrapper
|
||||||
|
|
||||||
|
# NOTE: Threads WILL die with parent's destruction.
|
||||||
|
def daemon_threaded_wrapper(fn):
|
||||||
|
def wrapper(*args, **kwargs):
|
||||||
|
threading.Thread(target=fn, args=args, kwargs=kwargs, daemon=True).start()
|
||||||
|
return wrapper
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# NOTE: Just reminding myself we can add to builtins two different ways...
|
||||||
|
# __builtins__.update({"event_system": Builtins()})
|
||||||
|
builtins.app_name = "<change_me>"
|
||||||
|
# builtins.keybindings = Keybindings()
|
||||||
|
builtins.event_system = EventSystem()
|
||||||
|
builtins.endpoint_registry = EndpointRegistry()
|
||||||
|
builtins.settings = Settings()
|
||||||
|
builtins.logger = Logger(settings.get_home_config_path(), \
|
||||||
|
_ch_log_lvl=settings.get_ch_log_lvl(), \
|
||||||
|
_fh_log_lvl=settings.get_fh_log_lvl()).get_logger()
|
||||||
|
|
||||||
|
builtins.threaded = threaded_wrapper
|
||||||
|
builtins.daemon_threaded = daemon_threaded_wrapper
|
||||||
|
builtins.event_sleep_time = 0.05
|
|
@ -0,0 +1,3 @@
|
||||||
|
"""
|
||||||
|
Start of package.
|
||||||
|
"""
|
|
@ -0,0 +1,47 @@
|
||||||
|
#!/usr/bin/python3
|
||||||
|
|
||||||
|
# Python imports
|
||||||
|
import argparse
|
||||||
|
import faulthandler
|
||||||
|
import traceback
|
||||||
|
from setproctitle import setproctitle
|
||||||
|
|
||||||
|
import tracemalloc
|
||||||
|
tracemalloc.start()
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
from __builtins__ import *
|
||||||
|
from app import Application
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
''' Set process title, get arguments, and create GTK main thread. '''
|
||||||
|
|
||||||
|
try:
|
||||||
|
setproctitle(f'{app_name}')
|
||||||
|
# faulthandler.enable() # For better debug info
|
||||||
|
|
||||||
|
parser = argparse.ArgumentParser()
|
||||||
|
# Add long and short arguments
|
||||||
|
parser.add_argument("--debug", "-d", default="false", help="Do extra console messaging.")
|
||||||
|
parser.add_argument("--trace-debug", "-td", default="false", help="Disable saves, ignore IPC lock, do extra console messaging.")
|
||||||
|
parser.add_argument("--file", "-f", default="default", help="JUST SOME FILE ARG.")
|
||||||
|
|
||||||
|
# Read arguments (If any...)
|
||||||
|
args, unknownargs = parser.parse_known_args()
|
||||||
|
|
||||||
|
if args.debug == "true":
|
||||||
|
settings.set_debug(True)
|
||||||
|
|
||||||
|
if args.trace_debug == "true":
|
||||||
|
settings.set_trace_debug(True)
|
||||||
|
|
||||||
|
settings.do_dirty_start_check()
|
||||||
|
Application(args, unknownargs)
|
||||||
|
except Exception as e:
|
||||||
|
traceback.print_exc()
|
||||||
|
quit()
|
|
@ -0,0 +1,35 @@
|
||||||
|
# Python imports
|
||||||
|
import os
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
from utils.ipc_server import IPCServer
|
||||||
|
from core.window import Window
|
||||||
|
|
||||||
|
|
||||||
|
class AppLaunchException(Exception):
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class Application(IPCServer):
|
||||||
|
''' Create Settings and Controller classes. Bind signal to Builder. Inherit from Builtins to bind global methods and classes.'''
|
||||||
|
|
||||||
|
def __init__(self, args, unknownargs):
|
||||||
|
super(Application, self).__init__()
|
||||||
|
if not settings.is_trace_debug():
|
||||||
|
try:
|
||||||
|
self.create_ipc_listener()
|
||||||
|
except Exception:
|
||||||
|
...
|
||||||
|
|
||||||
|
if not self.is_ipc_alive:
|
||||||
|
for arg in unknownargs + [args.new_tab,]:
|
||||||
|
if os.path.isdir(arg):
|
||||||
|
message = f"FILE|{arg}"
|
||||||
|
self.send_ipc_message(message)
|
||||||
|
|
||||||
|
raise AppLaunchException(f"{app_name} IPC Server Exists: Will send path(s) to it and close...")
|
||||||
|
|
||||||
|
Window(args, unknownargs).run()
|
|
@ -0,0 +1,3 @@
|
||||||
|
"""
|
||||||
|
Gtk Bound Signal Module
|
||||||
|
"""
|
|
@ -0,0 +1,66 @@
|
||||||
|
# Python imports
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
from .mixins.dummy_mixin import DummyMixin
|
||||||
|
from .controller_data import ControllerData
|
||||||
|
from .core_widget import CoreWidget
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class Controller(DummyMixin, ControllerData):
|
||||||
|
def __init__(self, args, unknownargs):
|
||||||
|
|
||||||
|
self._setup_styling()
|
||||||
|
self._setup_signals()
|
||||||
|
self._subscribe_to_events()
|
||||||
|
|
||||||
|
self.setup_controller_data()
|
||||||
|
self.load_core_widget()
|
||||||
|
self.print_hello_world() # A mixin method from the DummyMixin file
|
||||||
|
|
||||||
|
logger.info(f"Made it past {self.__class__} loading...")
|
||||||
|
|
||||||
|
|
||||||
|
def _setup_styling(self):
|
||||||
|
...
|
||||||
|
|
||||||
|
def _setup_signals(self):
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
|
def _subscribe_to_events(self):
|
||||||
|
event_system.subscribe("handle_file_from_ipc", self.handle_file_from_ipc)
|
||||||
|
|
||||||
|
def handle_file_from_ipc(self, path: str) -> None:
|
||||||
|
print(f"Path From IPC: {path}")
|
||||||
|
|
||||||
|
def load_core_widget(self):
|
||||||
|
self.core_widget = CoreWidget()
|
||||||
|
|
||||||
|
def get_core_widget(self):
|
||||||
|
return self.core_widget
|
||||||
|
|
||||||
|
|
||||||
|
def on_global_key_release_controller(self, widget: type, event: type) -> None:
|
||||||
|
...
|
||||||
|
# """Handler for keyboard events"""
|
||||||
|
# keyname = Gdk.keyval_name(event.keyval).lower()
|
||||||
|
# if keyname.replace("_l", "").replace("_r", "") in ["control", "alt", "shift"]:
|
||||||
|
# if "control" in keyname:
|
||||||
|
# self.ctrl_down = False
|
||||||
|
# if "shift" in keyname:
|
||||||
|
# self.shift_down = False
|
||||||
|
# if "alt" in keyname:
|
||||||
|
# self.alt_down = False
|
||||||
|
#
|
||||||
|
#
|
||||||
|
# mapping = keybindings.lookup(event)
|
||||||
|
# if mapping:
|
||||||
|
# getattr(self, mapping)()
|
||||||
|
# return True
|
||||||
|
# else:
|
||||||
|
# print(f"on_global_key_release_controller > key > {keyname}")
|
||||||
|
# print(f"Add logic or remove this from: {self.__class__}")
|
|
@ -0,0 +1,63 @@
|
||||||
|
# Python imports
|
||||||
|
import os
|
||||||
|
import subprocess
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
from plugins.plugins_controller import PluginsController
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class ControllerData:
|
||||||
|
''' ControllerData contains most of the state of the app at ay given time. It also has some support methods. '''
|
||||||
|
|
||||||
|
def setup_controller_data(self) -> None:
|
||||||
|
self.window = settings.get_main_window()
|
||||||
|
self.builder = None
|
||||||
|
self.core_widget = None
|
||||||
|
self.plugins = PluginsController()
|
||||||
|
|
||||||
|
|
||||||
|
def clear_console(self) -> None:
|
||||||
|
''' Clears the terminal screen. '''
|
||||||
|
os.system('cls' if os.name == 'nt' else 'clear')
|
||||||
|
|
||||||
|
def call_method(self, _method_name: str, data: type) -> type:
|
||||||
|
'''
|
||||||
|
Calls a method from scope of class.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
a (obj): self
|
||||||
|
b (str): method name to be called
|
||||||
|
c (*): Data (if any) to be passed to the method.
|
||||||
|
Note: It must be structured according to the given methods requirements.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Return data is that which the calling method gives.
|
||||||
|
'''
|
||||||
|
method_name = str(_method_name)
|
||||||
|
method = getattr(self, method_name, lambda data: f"No valid key passed...\nkey={method_name}\nargs={data}")
|
||||||
|
return method(*data) if data else method()
|
||||||
|
|
||||||
|
def has_method(self, obj: type, method: type) -> type:
|
||||||
|
''' Checks if a given method exists. '''
|
||||||
|
return callable(getattr(obj, method, None))
|
||||||
|
|
||||||
|
def clear_children(self, widget: type) -> None:
|
||||||
|
''' Clear children of a gtk widget. '''
|
||||||
|
for child in widget.get_children():
|
||||||
|
widget.remove(child)
|
||||||
|
|
||||||
|
def get_clipboard_data(self, encoding="utf-8") -> str:
|
||||||
|
proc = subprocess.Popen(['xclip','-selection', 'clipboard', '-o'], stdout=subprocess.PIPE)
|
||||||
|
retcode = proc.wait()
|
||||||
|
data = proc.stdout.read()
|
||||||
|
return data.decode(encoding).strip()
|
||||||
|
|
||||||
|
def set_clipboard_data(self, data: type, encoding="utf-8") -> None:
|
||||||
|
proc = subprocess.Popen(['xclip','-selection','clipboard'], stdin=subprocess.PIPE)
|
||||||
|
proc.stdin.write(data.encode(encoding))
|
||||||
|
proc.stdin.close()
|
||||||
|
retcode = proc.wait()
|
|
@ -0,0 +1,43 @@
|
||||||
|
# Python imports
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
from kivy.uix.gridlayout import GridLayout
|
||||||
|
from kivy.uix.button import Button
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
|
||||||
|
|
||||||
|
class CoreWidget(GridLayout):
|
||||||
|
"""docstring for CoreWidget."""
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
super(CoreWidget, self).__init__()
|
||||||
|
|
||||||
|
self._setup_styling()
|
||||||
|
self._setup_signals()
|
||||||
|
self._load_widgets()
|
||||||
|
|
||||||
|
|
||||||
|
def _setup_styling(self):
|
||||||
|
self.cols = 2
|
||||||
|
self.row_force_default = True
|
||||||
|
self.row_default_height = 40
|
||||||
|
|
||||||
|
def _setup_signals(self):
|
||||||
|
...
|
||||||
|
|
||||||
|
def _load_widgets(self):
|
||||||
|
hello_button = Button(text='Click Me!')
|
||||||
|
hello_button.bind(on_release=self._hello_world)
|
||||||
|
|
||||||
|
close_button = Button(text='Close')
|
||||||
|
close_button.bind(on_release=self._close_button_eve)
|
||||||
|
|
||||||
|
self.add_widget(hello_button)
|
||||||
|
self.add_widget(close_button)
|
||||||
|
|
||||||
|
def _hello_world(self, widget=None, eve=None):
|
||||||
|
print("Hello, World!")
|
||||||
|
|
||||||
|
def _close_button_eve(self, widget=None, eve=None):
|
||||||
|
event_system.emit("tear_down")
|
|
@ -0,0 +1,3 @@
|
||||||
|
"""
|
||||||
|
Generic Mixins Module
|
||||||
|
"""
|
|
@ -0,0 +1,14 @@
|
||||||
|
# Python imports
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class DummyMixin:
|
||||||
|
""" DummyMixin is an example of how mixins are used and structured in a project. """
|
||||||
|
|
||||||
|
def print_hello_world(self) -> None:
|
||||||
|
print("Hello, World!")
|
|
@ -0,0 +1,80 @@
|
||||||
|
# Python imports
|
||||||
|
import time
|
||||||
|
import signal
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
from kivy.app import App
|
||||||
|
from kivy.graphics import Color, Rectangle
|
||||||
|
from kivy.config import Config
|
||||||
|
from kivy.properties import (
|
||||||
|
BooleanProperty,
|
||||||
|
StringProperty,
|
||||||
|
ListProperty,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
from core.controller import Controller
|
||||||
|
|
||||||
|
|
||||||
|
class ControllerStartExceptiom(Exception):
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class Window(App):
|
||||||
|
"""docstring for Window."""
|
||||||
|
|
||||||
|
shape_image = StringProperty('', force_dispatch=True)
|
||||||
|
|
||||||
|
def __init__(self, args, unknownargs):
|
||||||
|
super(Window, self).__init__()
|
||||||
|
|
||||||
|
self._controller = None
|
||||||
|
|
||||||
|
self._setup_styling()
|
||||||
|
self._setup_signals()
|
||||||
|
self._subscribe_to_events()
|
||||||
|
|
||||||
|
settings.set_main_window(self)
|
||||||
|
self._load_widgets(args, unknownargs)
|
||||||
|
|
||||||
|
|
||||||
|
def _setup_styling(self):
|
||||||
|
self.title = app_name
|
||||||
|
self.icon = settings.get_window_icon()
|
||||||
|
self.size = (settings.get_main_window_width(),
|
||||||
|
settings.get_main_window_height())
|
||||||
|
|
||||||
|
def _setup_signals(self):
|
||||||
|
...
|
||||||
|
|
||||||
|
def _subscribe_to_events(self):
|
||||||
|
event_system.subscribe("tear_down", self._tear_down)
|
||||||
|
|
||||||
|
def _load_widgets(self, args, unknownargs):
|
||||||
|
self._controller = Controller(args, unknownargs)
|
||||||
|
if not self._controller:
|
||||||
|
raise ControllerStartException("Controller exited and doesn't exist...")
|
||||||
|
|
||||||
|
def build(self):
|
||||||
|
self.root = root = self._controller.get_core_widget()
|
||||||
|
root.bind(size=self._update_rect, pos=self._update_rect)
|
||||||
|
|
||||||
|
with root.canvas.before:
|
||||||
|
Color(25, 25, 25, 0.64)
|
||||||
|
self.rect = Rectangle(size=root.size, pos=root.pos)
|
||||||
|
|
||||||
|
return root
|
||||||
|
|
||||||
|
def _update_rect(self, instance, value):
|
||||||
|
self.rect.pos = instance.pos
|
||||||
|
self.rect.size = instance.size
|
||||||
|
|
||||||
|
def _tear_down(self, widget=None, eve=None):
|
||||||
|
settings.clear_pid()
|
||||||
|
time.sleep(event_sleep_time)
|
||||||
|
quit()
|
||||||
|
|
||||||
|
def on_stop(self):
|
||||||
|
self._tear_down()
|
|
@ -0,0 +1,3 @@
|
||||||
|
"""
|
||||||
|
Gtk Bound Plugins Module
|
||||||
|
"""
|
|
@ -0,0 +1,64 @@
|
||||||
|
# Python imports
|
||||||
|
import os
|
||||||
|
import json
|
||||||
|
from os.path import join
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class ManifestProcessor(Exception):
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
|
class Plugin:
|
||||||
|
path: str = None
|
||||||
|
name: str = None
|
||||||
|
author: str = None
|
||||||
|
version: str = None
|
||||||
|
support: str = None
|
||||||
|
requests:{} = None
|
||||||
|
reference: type = None
|
||||||
|
|
||||||
|
|
||||||
|
class ManifestProcessor:
|
||||||
|
def __init__(self, path, builder):
|
||||||
|
manifest = join(path, "manifest.json")
|
||||||
|
if not os.path.exists(manifest):
|
||||||
|
raise Exception("Invalid Plugin Structure: Plugin doesn't have 'manifest.json'. Aboarting load...")
|
||||||
|
|
||||||
|
self._path = path
|
||||||
|
self._builder = builder
|
||||||
|
with open(manifest) as f:
|
||||||
|
data = json.load(f)
|
||||||
|
self._manifest = data["manifest"]
|
||||||
|
self._plugin = self.collect_info()
|
||||||
|
|
||||||
|
def collect_info(self) -> Plugin:
|
||||||
|
plugin = Plugin()
|
||||||
|
plugin.path = self._path
|
||||||
|
plugin.name = self._manifest["name"]
|
||||||
|
plugin.author = self._manifest["author"]
|
||||||
|
plugin.version = self._manifest["version"]
|
||||||
|
plugin.support = self._manifest["support"]
|
||||||
|
plugin.requests = self._manifest["requests"]
|
||||||
|
|
||||||
|
return plugin
|
||||||
|
|
||||||
|
def get_loading_data(self):
|
||||||
|
loading_data = {}
|
||||||
|
requests = self._plugin.requests
|
||||||
|
keys = requests.keys()
|
||||||
|
|
||||||
|
if "pass_events" in keys:
|
||||||
|
if requests["pass_events"] in ["true"]:
|
||||||
|
loading_data["pass_events"] = True
|
||||||
|
|
||||||
|
if "bind_keys" in keys:
|
||||||
|
if isinstance(requests["bind_keys"], list):
|
||||||
|
loading_data["bind_keys"] = requests["bind_keys"]
|
||||||
|
|
||||||
|
return self._plugin, loading_data
|
|
@ -0,0 +1,61 @@
|
||||||
|
# Python imports
|
||||||
|
import os
|
||||||
|
import time
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
|
||||||
|
|
||||||
|
class PluginBaseException(Exception):
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
|
class PluginBase:
|
||||||
|
def __init__(self):
|
||||||
|
self.name = "Example Plugin" # NOTE: Need to remove after establishing private bidirectional 1-1 message bus
|
||||||
|
# where self.name should not be needed for message comms
|
||||||
|
|
||||||
|
self._builder = None
|
||||||
|
self._ui_objects = None
|
||||||
|
self._event_system = None
|
||||||
|
|
||||||
|
|
||||||
|
def run(self):
|
||||||
|
"""
|
||||||
|
Must define regardless if needed and can 'pass' if plugin doesn't need it.
|
||||||
|
Is intended to be used to setup internal signals or custom Gtk Builders/UI logic.
|
||||||
|
"""
|
||||||
|
raise PluginBaseException("Method hasn't been overriden...")
|
||||||
|
|
||||||
|
def generate_reference_ui_element(self):
|
||||||
|
"""
|
||||||
|
Requests Key: 'ui_target': "plugin_control_list",
|
||||||
|
Must define regardless if needed and can 'pass' if plugin doesn't use it.
|
||||||
|
Must return a widget if "ui_target" is set.
|
||||||
|
"""
|
||||||
|
raise PluginBaseException("Method hasn't been overriden...")
|
||||||
|
|
||||||
|
def set_event_system(self, event_system):
|
||||||
|
"""
|
||||||
|
Requests Key: 'pass_events': "true"
|
||||||
|
Must define in plugin if "pass_events" is set to "true" string.
|
||||||
|
"""
|
||||||
|
self._event_system = event_system
|
||||||
|
|
||||||
|
def set_ui_object_collection(self, ui_objects):
|
||||||
|
"""
|
||||||
|
Requests Key: "pass_ui_objects": [""]
|
||||||
|
Request reference to a UI component. Will be passed back as array to plugin.
|
||||||
|
Must define in plugin if set and an array of valid glade UI IDs is given.
|
||||||
|
"""
|
||||||
|
self._ui_objects = ui_objects
|
||||||
|
|
||||||
|
def subscribe_to_events(self):
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
|
def clear_children(self, widget: type) -> None:
|
||||||
|
""" Clear children of a gtk widget. """
|
||||||
|
for child in widget.get_children():
|
||||||
|
widget.remove(child)
|
|
@ -0,0 +1,115 @@
|
||||||
|
# Python imports
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
import importlib
|
||||||
|
import traceback
|
||||||
|
from os.path import join
|
||||||
|
from os.path import isdir
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
from .manifest import Plugin
|
||||||
|
from .manifest import ManifestProcessor
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class InvalidPluginException(Exception):
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
|
class PluginsController:
|
||||||
|
"""PluginsController controller"""
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
path = os.path.dirname(os.path.realpath(__file__))
|
||||||
|
sys.path.insert(0, path) # NOTE: I think I'm not using this correctly...
|
||||||
|
|
||||||
|
self._plugins_path = settings.get_plugins_path()
|
||||||
|
|
||||||
|
self._plugins_dir_watcher = None
|
||||||
|
self._plugin_collection = []
|
||||||
|
|
||||||
|
|
||||||
|
def launch_plugins(self) -> None:
|
||||||
|
self._set_plugins_watcher()
|
||||||
|
self.load_plugins()
|
||||||
|
|
||||||
|
def _set_plugins_watcher(self) -> None:
|
||||||
|
...
|
||||||
|
# self._plugins_dir_watcher = Gio.File.new_for_path(self._plugins_path) \
|
||||||
|
# .monitor_directory(Gio.FileMonitorFlags.WATCH_MOVES, Gio.Cancellable())
|
||||||
|
# self._plugins_dir_watcher.connect("changed", self._on_plugins_changed, ())
|
||||||
|
|
||||||
|
def _on_plugins_changed(self, file_monitor, file, other_file=None, eve_type=None, data=None):
|
||||||
|
...
|
||||||
|
# if eve_type in [Gio.FileMonitorEvent.CREATED, Gio.FileMonitorEvent.DELETED,
|
||||||
|
# Gio.FileMonitorEvent.RENAMED, Gio.FileMonitorEvent.MOVED_IN,
|
||||||
|
# Gio.FileMonitorEvent.MOVED_OUT]:
|
||||||
|
# self.reload_plugins(file)
|
||||||
|
|
||||||
|
def load_plugins(self, file: str = None) -> None:
|
||||||
|
print(f"Loading plugins...")
|
||||||
|
parent_path = os.getcwd()
|
||||||
|
|
||||||
|
for path, folder in [[join(self._plugins_path, item), item] if os.path.isdir(join(self._plugins_path, item)) else None for item in os.listdir(self._plugins_path)]:
|
||||||
|
try:
|
||||||
|
target = join(path, "plugin.py")
|
||||||
|
manifest = ManifestProcessor(path, self._builder)
|
||||||
|
|
||||||
|
if not os.path.exists(target):
|
||||||
|
raise InvalidPluginException("Invalid Plugin Structure: Plugin doesn't have 'plugin.py'. Aboarting load...")
|
||||||
|
|
||||||
|
plugin, loading_data = manifest.get_loading_data()
|
||||||
|
module = self.load_plugin_module(path, folder, target)
|
||||||
|
self.execute_plugin(module, plugin, loading_data)
|
||||||
|
except Exception as e:
|
||||||
|
print(f"Malformed Plugin: Not loading -->: '{folder}' !")
|
||||||
|
traceback.print_exc()
|
||||||
|
|
||||||
|
os.chdir(parent_path)
|
||||||
|
|
||||||
|
|
||||||
|
def load_plugin_module(self, path, folder, target):
|
||||||
|
os.chdir(path)
|
||||||
|
|
||||||
|
locations = []
|
||||||
|
self.collect_search_locations(path, locations)
|
||||||
|
|
||||||
|
spec = importlib.util.spec_from_file_location(folder, target, submodule_search_locations = locations)
|
||||||
|
module = importlib.util.module_from_spec(spec)
|
||||||
|
sys.modules[folder] = module
|
||||||
|
spec.loader.exec_module(module)
|
||||||
|
|
||||||
|
return module
|
||||||
|
|
||||||
|
def collect_search_locations(self, path, locations):
|
||||||
|
locations.append(path)
|
||||||
|
for file in os.listdir(path):
|
||||||
|
_path = os.path.join(path, file)
|
||||||
|
if os.path.isdir(_path):
|
||||||
|
self.collect_search_locations(_path, locations)
|
||||||
|
|
||||||
|
def execute_plugin(self, module: type, plugin: Plugin, loading_data: []):
|
||||||
|
plugin.reference = module.Plugin()
|
||||||
|
keys = loading_data.keys()
|
||||||
|
|
||||||
|
if "ui_target" in keys:
|
||||||
|
loading_data["ui_target"].add( plugin.reference.generate_reference_ui_element() )
|
||||||
|
|
||||||
|
if "pass_ui_objects" in keys:
|
||||||
|
plugin.reference.set_ui_object_collection( loading_data["pass_ui_objects"] )
|
||||||
|
|
||||||
|
if "pass_events" in keys:
|
||||||
|
plugin.reference.set_fm_event_system(event_system)
|
||||||
|
plugin.reference.subscribe_to_events()
|
||||||
|
|
||||||
|
# if "bind_keys" in keys:
|
||||||
|
# keybindings.append_bindings( loading_data["bind_keys"] )
|
||||||
|
|
||||||
|
plugin.reference.run()
|
||||||
|
self._plugin_collection.append(plugin)
|
||||||
|
|
||||||
|
def reload_plugins(self, file: str = None) -> None:
|
||||||
|
print(f"Reloading plugins... stub.")
|
|
@ -0,0 +1,3 @@
|
||||||
|
"""
|
||||||
|
Utils module
|
||||||
|
"""
|
|
@ -0,0 +1,22 @@
|
||||||
|
# Python imports
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class EndpointRegistry():
|
||||||
|
def __init__(self):
|
||||||
|
self._endpoints = {}
|
||||||
|
|
||||||
|
def register(self, rule, **options):
|
||||||
|
def decorator(f):
|
||||||
|
self._endpoints[rule] = f
|
||||||
|
return f
|
||||||
|
|
||||||
|
return decorator
|
||||||
|
|
||||||
|
def get_endpoints(self):
|
||||||
|
return self._endpoints
|
|
@ -0,0 +1,54 @@
|
||||||
|
# Python imports
|
||||||
|
from collections import defaultdict
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class EventSystem:
|
||||||
|
""" Create event system. """
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self.subscribers = defaultdict(list)
|
||||||
|
|
||||||
|
|
||||||
|
def subscribe(self, event_type, fn):
|
||||||
|
self.subscribers[event_type].append(fn)
|
||||||
|
|
||||||
|
def unsubscribe(self, event_type, fn):
|
||||||
|
self.subscribers[event_type].remove(fn)
|
||||||
|
|
||||||
|
def unsubscribe_all(self, event_type):
|
||||||
|
self.subscribers.pop(event_type, None)
|
||||||
|
|
||||||
|
def emit(self, event_type, data = None):
|
||||||
|
if event_type in self.subscribers:
|
||||||
|
for fn in self.subscribers[event_type]:
|
||||||
|
if data:
|
||||||
|
if hasattr(data, '__iter__') and not type(data) is str:
|
||||||
|
fn(*data)
|
||||||
|
else:
|
||||||
|
fn(data)
|
||||||
|
else:
|
||||||
|
fn()
|
||||||
|
|
||||||
|
def emit_and_await(self, event_type, data = None):
|
||||||
|
""" NOTE: Should be used when signal has only one listener and vis-a-vis """
|
||||||
|
if event_type in self.subscribers:
|
||||||
|
response = None
|
||||||
|
for fn in self.subscribers[event_type]:
|
||||||
|
if data:
|
||||||
|
if hasattr(data, '__iter__') and not type(data) is str:
|
||||||
|
response = fn(*data)
|
||||||
|
else:
|
||||||
|
response = fn(data)
|
||||||
|
else:
|
||||||
|
response = fn()
|
||||||
|
|
||||||
|
if not response in (None, ''):
|
||||||
|
break
|
||||||
|
|
||||||
|
return response
|
|
@ -0,0 +1,105 @@
|
||||||
|
# Python imports
|
||||||
|
import os
|
||||||
|
import threading
|
||||||
|
import time
|
||||||
|
from multiprocessing.connection import Client
|
||||||
|
from multiprocessing.connection import Listener
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class IPCServer:
|
||||||
|
""" Create a listener so that other {app_name} instances send requests back to existing instance. """
|
||||||
|
def __init__(self, ipc_address: str = '127.0.0.1', conn_type: str = "socket"):
|
||||||
|
self.is_ipc_alive = False
|
||||||
|
self._ipc_port = 4848
|
||||||
|
self._ipc_address = ipc_address
|
||||||
|
self._conn_type = conn_type
|
||||||
|
self._ipc_authkey = b'' + bytes(f'{app_name}-ipc', 'utf-8')
|
||||||
|
self._ipc_timeout = 15.0
|
||||||
|
|
||||||
|
if conn_type == "socket":
|
||||||
|
self._ipc_address = f'/tmp/{app_name}-ipc.sock'
|
||||||
|
elif conn_type == "full_network":
|
||||||
|
self._ipc_address = '0.0.0.0'
|
||||||
|
elif conn_type == "full_network_unsecured":
|
||||||
|
self._ipc_authkey = None
|
||||||
|
self._ipc_address = '0.0.0.0'
|
||||||
|
elif conn_type == "local_network_unsecured":
|
||||||
|
self._ipc_authkey = None
|
||||||
|
|
||||||
|
self._subscribe_to_events()
|
||||||
|
|
||||||
|
def _subscribe_to_events(self):
|
||||||
|
event_system.subscribe("post_file_to_ipc", self.send_ipc_message)
|
||||||
|
|
||||||
|
|
||||||
|
def create_ipc_listener(self) -> None:
|
||||||
|
if self._conn_type == "socket":
|
||||||
|
if os.path.exists(self._ipc_address) and settings.is_dirty_start():
|
||||||
|
os.unlink(self._ipc_address)
|
||||||
|
|
||||||
|
listener = Listener(address=self._ipc_address, family="AF_UNIX", authkey=self._ipc_authkey)
|
||||||
|
elif "unsecured" not in self._conn_type:
|
||||||
|
listener = Listener((self._ipc_address, self._ipc_port), authkey=self._ipc_authkey)
|
||||||
|
else:
|
||||||
|
listener = Listener((self._ipc_address, self._ipc_port))
|
||||||
|
|
||||||
|
|
||||||
|
self.is_ipc_alive = True
|
||||||
|
self._run_ipc_loop(listener)
|
||||||
|
|
||||||
|
@daemon_threaded
|
||||||
|
def _run_ipc_loop(self, listener) -> None:
|
||||||
|
while True:
|
||||||
|
conn = listener.accept()
|
||||||
|
start_time = time.perf_counter()
|
||||||
|
self._handle_ipc_message(conn, start_time)
|
||||||
|
|
||||||
|
listener.close()
|
||||||
|
|
||||||
|
def _handle_ipc_message(self, conn, start_time) -> None:
|
||||||
|
while True:
|
||||||
|
msg = conn.recv()
|
||||||
|
if settings.is_debug():
|
||||||
|
print(msg)
|
||||||
|
|
||||||
|
if "FILE|" in msg:
|
||||||
|
file = msg.split("FILE|")[1].strip()
|
||||||
|
if file:
|
||||||
|
event_system.emit("handle_file_from_ipc", file)
|
||||||
|
|
||||||
|
conn.close()
|
||||||
|
break
|
||||||
|
|
||||||
|
|
||||||
|
if msg in ['close connection', 'close server']:
|
||||||
|
conn.close()
|
||||||
|
break
|
||||||
|
|
||||||
|
# NOTE: Not perfect but insures we don't lock up the connection for too long.
|
||||||
|
end_time = time.perf_counter()
|
||||||
|
if (end_time - start_time) > self._ipc_timeout:
|
||||||
|
conn.close()
|
||||||
|
break
|
||||||
|
|
||||||
|
|
||||||
|
def send_ipc_message(self, message: str = "Empty Data...") -> None:
|
||||||
|
try:
|
||||||
|
if self._conn_type == "socket":
|
||||||
|
conn = Client(address=self._ipc_address, family="AF_UNIX", authkey=self._ipc_authkey)
|
||||||
|
elif "unsecured" not in self._conn_type:
|
||||||
|
conn = Client((self._ipc_address, self._ipc_port), authkey=self._ipc_authkey)
|
||||||
|
else:
|
||||||
|
conn = Client((self._ipc_address, self._ipc_port))
|
||||||
|
|
||||||
|
conn.send(message)
|
||||||
|
conn.close()
|
||||||
|
except ConnectionRefusedError as e:
|
||||||
|
print("Connection refused...")
|
||||||
|
except Exception as e:
|
||||||
|
print(repr(e))
|
|
@ -0,0 +1,128 @@
|
||||||
|
# Python imports
|
||||||
|
import re
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
import gi
|
||||||
|
gi.require_version('Gdk', '3.0')
|
||||||
|
from gi.repository import Gdk
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
def err(log = ""):
|
||||||
|
"""Print an error message"""
|
||||||
|
print(log)
|
||||||
|
|
||||||
|
|
||||||
|
class KeymapError(Exception):
|
||||||
|
"""Custom exception for errors in keybinding configurations"""
|
||||||
|
|
||||||
|
MODIFIER = re.compile('<([^<]+)>')
|
||||||
|
class Keybindings:
|
||||||
|
"""Class to handle loading and lookup of Terminator keybindings"""
|
||||||
|
|
||||||
|
modifiers = {
|
||||||
|
'ctrl': Gdk.ModifierType.CONTROL_MASK,
|
||||||
|
'control': Gdk.ModifierType.CONTROL_MASK,
|
||||||
|
'primary': Gdk.ModifierType.CONTROL_MASK,
|
||||||
|
'shift': Gdk.ModifierType.SHIFT_MASK,
|
||||||
|
'alt': Gdk.ModifierType.MOD1_MASK,
|
||||||
|
'super': Gdk.ModifierType.SUPER_MASK,
|
||||||
|
'hyper': Gdk.ModifierType.HYPER_MASK,
|
||||||
|
'mod2': Gdk.ModifierType.MOD2_MASK
|
||||||
|
}
|
||||||
|
|
||||||
|
empty = {}
|
||||||
|
keys = None
|
||||||
|
_masks = None
|
||||||
|
_lookup = None
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self.keymap = Gdk.Keymap.get_default()
|
||||||
|
self.configure({})
|
||||||
|
|
||||||
|
def configure(self, bindings):
|
||||||
|
"""Accept new bindings and reconfigure with them"""
|
||||||
|
self.keys = bindings
|
||||||
|
self.reload()
|
||||||
|
|
||||||
|
def reload(self):
|
||||||
|
"""Parse bindings and mangle into an appropriate form"""
|
||||||
|
self._lookup = {}
|
||||||
|
self._masks = 0
|
||||||
|
|
||||||
|
for action, bindings in list(self.keys.items()):
|
||||||
|
if isinstance(bindings, list):
|
||||||
|
bindings = (*bindings,)
|
||||||
|
elif not isinstance(bindings, tuple):
|
||||||
|
bindings = (bindings,)
|
||||||
|
|
||||||
|
|
||||||
|
for binding in bindings:
|
||||||
|
if not binding or binding == "None":
|
||||||
|
continue
|
||||||
|
|
||||||
|
try:
|
||||||
|
keyval, mask = self._parsebinding(binding)
|
||||||
|
# Does much the same, but with poorer error handling.
|
||||||
|
#keyval, mask = Gtk.accelerator_parse(binding)
|
||||||
|
except KeymapError as e:
|
||||||
|
err ("keybinding reload failed to parse binding '%s': %s" % (binding, e))
|
||||||
|
else:
|
||||||
|
if mask & Gdk.ModifierType.SHIFT_MASK:
|
||||||
|
if keyval == Gdk.KEY_Tab:
|
||||||
|
keyval = Gdk.KEY_ISO_Left_Tab
|
||||||
|
mask &= ~Gdk.ModifierType.SHIFT_MASK
|
||||||
|
else:
|
||||||
|
keyvals = Gdk.keyval_convert_case(keyval)
|
||||||
|
if keyvals[0] != keyvals[1]:
|
||||||
|
keyval = keyvals[1]
|
||||||
|
mask &= ~Gdk.ModifierType.SHIFT_MASK
|
||||||
|
else:
|
||||||
|
keyval = Gdk.keyval_to_lower(keyval)
|
||||||
|
|
||||||
|
self._lookup.setdefault(mask, {})
|
||||||
|
self._lookup[mask][keyval] = action
|
||||||
|
self._masks |= mask
|
||||||
|
|
||||||
|
def _parsebinding(self, binding):
|
||||||
|
"""Parse an individual binding using Gtk's binding function"""
|
||||||
|
mask = 0
|
||||||
|
modifiers = re.findall(MODIFIER, binding)
|
||||||
|
|
||||||
|
if modifiers:
|
||||||
|
for modifier in modifiers:
|
||||||
|
mask |= self._lookup_modifier(modifier)
|
||||||
|
|
||||||
|
key = re.sub(MODIFIER, '', binding)
|
||||||
|
if key == '':
|
||||||
|
raise KeymapError('No key found!')
|
||||||
|
|
||||||
|
keyval = Gdk.keyval_from_name(key)
|
||||||
|
|
||||||
|
if keyval == 0:
|
||||||
|
raise KeymapError("Key '%s' is unrecognised..." % key)
|
||||||
|
return (keyval, mask)
|
||||||
|
|
||||||
|
def _lookup_modifier(self, modifier):
|
||||||
|
"""Map modifier names to gtk values"""
|
||||||
|
try:
|
||||||
|
return self.modifiers[modifier.lower()]
|
||||||
|
except KeyError:
|
||||||
|
raise KeymapError("Unhandled modifier '<%s>'" % modifier)
|
||||||
|
|
||||||
|
def lookup(self, event):
|
||||||
|
"""Translate a keyboard event into a mapped key"""
|
||||||
|
try:
|
||||||
|
_found, keyval, _egp, _lvl, consumed = self.keymap.translate_keyboard_state(
|
||||||
|
event.hardware_keycode,
|
||||||
|
Gdk.ModifierType(event.get_state() & ~Gdk.ModifierType.LOCK_MASK),
|
||||||
|
event.group)
|
||||||
|
except TypeError:
|
||||||
|
err ("Keybinding lookup failed to translate keyboard event: %s" % dir(event))
|
||||||
|
return None
|
||||||
|
|
||||||
|
mask = (event.get_state() & ~consumed) & self._masks
|
||||||
|
return self._lookup.get(mask, self.empty).get(keyval, None)
|
|
@ -0,0 +1,61 @@
|
||||||
|
# Python imports
|
||||||
|
import os
|
||||||
|
import logging
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class Logger:
|
||||||
|
"""
|
||||||
|
Create a new logging object and return it.
|
||||||
|
:note:
|
||||||
|
NOSET # Don't know the actual log level of this... (defaulting or literally none?)
|
||||||
|
Log Levels (From least to most)
|
||||||
|
Type Value
|
||||||
|
CRITICAL 50
|
||||||
|
ERROR 40
|
||||||
|
WARNING 30
|
||||||
|
INFO 20
|
||||||
|
DEBUG 10
|
||||||
|
:param loggerName: Sets the name of the logger object. (Used in log lines)
|
||||||
|
:param createFile: Whether we create a log file or just pump to terminal
|
||||||
|
|
||||||
|
:return: the logging object we created
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, config_path: str, _ch_log_lvl = logging.CRITICAL, _fh_log_lvl = logging.INFO):
|
||||||
|
self._CONFIG_PATH = config_path
|
||||||
|
self.global_lvl = logging.DEBUG # Keep this at highest so that handlers can filter to their desired levels
|
||||||
|
self.ch_log_lvl = _ch_log_lvl # Prety much the only one we ever change
|
||||||
|
self.fh_log_lvl = _fh_log_lvl
|
||||||
|
|
||||||
|
def get_logger(self, loggerName: str = "NO_LOGGER_NAME_PASSED", createFile: bool = True) -> logging.Logger:
|
||||||
|
log = logging.getLogger(loggerName)
|
||||||
|
log.setLevel(self.global_lvl)
|
||||||
|
|
||||||
|
# Set our log output styles
|
||||||
|
fFormatter = logging.Formatter('[%(asctime)s] %(pathname)s:%(lineno)d %(levelname)s - %(message)s', '%m-%d %H:%M:%S')
|
||||||
|
cFormatter = logging.Formatter('%(pathname)s:%(lineno)d] %(levelname)s - %(message)s')
|
||||||
|
|
||||||
|
ch = logging.StreamHandler()
|
||||||
|
ch.setLevel(level=self.ch_log_lvl)
|
||||||
|
ch.setFormatter(cFormatter)
|
||||||
|
log.addHandler(ch)
|
||||||
|
|
||||||
|
if createFile:
|
||||||
|
folder = self._CONFIG_PATH
|
||||||
|
file = f"{folder}/application.log"
|
||||||
|
|
||||||
|
if not os.path.exists(folder):
|
||||||
|
os.mkdir(folder)
|
||||||
|
|
||||||
|
fh = logging.FileHandler(file)
|
||||||
|
fh.setLevel(level=self.fh_log_lvl)
|
||||||
|
fh.setFormatter(fFormatter)
|
||||||
|
log.addHandler(fh)
|
||||||
|
|
||||||
|
return log
|
|
@ -0,0 +1,4 @@
|
||||||
|
"""
|
||||||
|
Settings module
|
||||||
|
"""
|
||||||
|
from .settings import Settings
|
|
@ -0,0 +1,156 @@
|
||||||
|
# Python imports
|
||||||
|
import os
|
||||||
|
import json
|
||||||
|
import inspect
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
from .start_check_mixin import StartCheckMixin
|
||||||
|
|
||||||
|
|
||||||
|
class MissingConfigError(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class Settings(StartCheckMixin):
|
||||||
|
def __init__(self):
|
||||||
|
self._SCRIPT_PTH = os.path.dirname(os.path.realpath(__file__))
|
||||||
|
self._USER_HOME = os.path.expanduser('~')
|
||||||
|
self._USR_PATH = f"/usr/share/{app_name.lower()}"
|
||||||
|
|
||||||
|
self._USR_CONFIG_FILE = f"{self._USR_PATH}/settings.json"
|
||||||
|
self._HOME_CONFIG_PATH = f"{self._USER_HOME}/.config/{app_name.lower()}"
|
||||||
|
self._PLUGINS_PATH = f"{self._HOME_CONFIG_PATH}/plugins"
|
||||||
|
self._DEFAULT_ICONS = f"{self._HOME_CONFIG_PATH}/icons"
|
||||||
|
self._CONFIG_FILE = f"{self._HOME_CONFIG_PATH}/settings.json"
|
||||||
|
self._GLADE_FILE = f"{self._HOME_CONFIG_PATH}/Main_Window.glade"
|
||||||
|
self._CSS_FILE = f"{self._HOME_CONFIG_PATH}/stylesheet.css"
|
||||||
|
self._KEY_BINDINGS_FILE = f"{self._HOME_CONFIG_PATH}/key-bindings.json"
|
||||||
|
self._PID_FILE = f"{self._HOME_CONFIG_PATH}/{app_name.lower()}.pid"
|
||||||
|
self._WINDOW_ICON = f"{self._DEFAULT_ICONS}/icons/{app_name.lower()}.png"
|
||||||
|
|
||||||
|
if not os.path.exists(self._HOME_CONFIG_PATH):
|
||||||
|
os.mkdir(self._HOME_CONFIG_PATH)
|
||||||
|
if not os.path.exists(self._PLUGINS_PATH):
|
||||||
|
os.mkdir(self._PLUGINS_PATH)
|
||||||
|
|
||||||
|
if not os.path.exists(self._CONFIG_FILE):
|
||||||
|
import shutil
|
||||||
|
try:
|
||||||
|
shutil.copyfile(self._USR_CONFIG_FILE, self._CONFIG_FILE)
|
||||||
|
except Exception as e:
|
||||||
|
raise
|
||||||
|
|
||||||
|
if not os.path.exists(self._DEFAULT_ICONS):
|
||||||
|
self._DEFAULT_ICONS = f"{self._USR_PATH}/icons"
|
||||||
|
if not os.path.exists(self._DEFAULT_ICONS):
|
||||||
|
raise MissingConfigError("Unable to find the application icons directory.")
|
||||||
|
if not os.path.exists(self._GLADE_FILE):
|
||||||
|
self._GLADE_FILE = f"{self._USR_PATH}/Main_Window.glade"
|
||||||
|
if not os.path.exists(self._GLADE_FILE):
|
||||||
|
raise MissingConfigError("Unable to find the application Glade file.")
|
||||||
|
if not os.path.exists(self._KEY_BINDINGS_FILE):
|
||||||
|
self._KEY_BINDINGS_FILE = f"{self._USR_PATH}/key-bindings.json"
|
||||||
|
if not os.path.exists(self._KEY_BINDINGS_FILE):
|
||||||
|
raise MissingConfigError("Unable to find the application Keybindings file.")
|
||||||
|
if not os.path.exists(self._CSS_FILE):
|
||||||
|
self._CSS_FILE = f"{self._USR_PATH}/stylesheet.css"
|
||||||
|
if not os.path.exists(self._CSS_FILE):
|
||||||
|
raise MissingConfigError("Unable to find the application Stylesheet file.")
|
||||||
|
if not os.path.exists(self._WINDOW_ICON):
|
||||||
|
self._WINDOW_ICON = f"{self._USR_PATH}/icons/{app_name.lower()}.png"
|
||||||
|
if not os.path.exists(self._WINDOW_ICON):
|
||||||
|
raise MissingConfigError("Unable to find the application icon.")
|
||||||
|
|
||||||
|
|
||||||
|
# with open(self._KEY_BINDINGS_FILE) as file:
|
||||||
|
# bindings = json.load(file)["keybindings"]
|
||||||
|
# keybindings.configure(bindings)
|
||||||
|
|
||||||
|
self._main_window = None
|
||||||
|
self._main_window_w = 800
|
||||||
|
self._main_window_h = 600
|
||||||
|
self._builder = None
|
||||||
|
|
||||||
|
self._trace_debug = False
|
||||||
|
self._debug = False
|
||||||
|
self._dirty_start = False
|
||||||
|
|
||||||
|
self.load_settings()
|
||||||
|
|
||||||
|
|
||||||
|
def register_signals_to_builder(self, classes=None):
|
||||||
|
handlers = {}
|
||||||
|
|
||||||
|
for c in classes:
|
||||||
|
methods = None
|
||||||
|
try:
|
||||||
|
methods = inspect.getmembers(c, predicate=inspect.ismethod)
|
||||||
|
handlers.update(methods)
|
||||||
|
except Exception as e:
|
||||||
|
...
|
||||||
|
|
||||||
|
self._builder.connect_signals(handlers)
|
||||||
|
|
||||||
|
def set_main_window(self, window): self._main_window = window
|
||||||
|
def set_builder(self, builder) -> any: self._builder = builder
|
||||||
|
|
||||||
|
|
||||||
|
def get_monitor_data(self) -> list:
|
||||||
|
screen = self._main_window.get_screen()
|
||||||
|
monitors = []
|
||||||
|
for m in range(screen.get_n_monitors()):
|
||||||
|
monitors.append(screen.get_monitor_geometry(m))
|
||||||
|
print("{}x{}+{}+{}".format(monitor.width, monitor.height, monitor.x, monitor.y))
|
||||||
|
|
||||||
|
return monitors
|
||||||
|
|
||||||
|
def get_main_window(self) -> any: return self._main_window
|
||||||
|
def get_main_window_width(self) -> any: return self._main_window_w
|
||||||
|
def get_main_window_height(self) -> any: return self._main_window_h
|
||||||
|
def get_builder(self) -> any: return self._builder
|
||||||
|
def get_glade_file(self) -> str: return self._GLADE_FILE
|
||||||
|
|
||||||
|
def get_plugins_path(self) -> str: return self._PLUGINS_PATH
|
||||||
|
def get_icon_theme(self) -> str: return self._ICON_THEME
|
||||||
|
def get_css_file(self) -> str: return self._CSS_FILE
|
||||||
|
def get_home_config_path(self) -> str: return self._HOME_CONFIG_PATH
|
||||||
|
def get_window_icon(self) -> str: return self._WINDOW_ICON
|
||||||
|
def get_home_path(self) -> str: return self._USER_HOME
|
||||||
|
|
||||||
|
# Filter returns
|
||||||
|
def get_office_filter(self) -> tuple: return tuple(self._settings["filters"]["office"])
|
||||||
|
def get_vids_filter(self) -> tuple: return tuple(self._settings["filters"]["videos"])
|
||||||
|
def get_text_filter(self) -> tuple: return tuple(self._settings["filters"]["text"])
|
||||||
|
def get_music_filter(self) -> tuple: return tuple(self._settings["filters"]["music"])
|
||||||
|
def get_images_filter(self) -> tuple: return tuple(self._settings["filters"]["images"])
|
||||||
|
def get_pdf_filter(self) -> tuple: return tuple(self._settings["filters"]["pdf"])
|
||||||
|
|
||||||
|
def get_success_color(self) -> str: return self._theming["success_color"]
|
||||||
|
def get_warning_color(self) -> str: return self._theming["warning_color"]
|
||||||
|
def get_error_color(self) -> str: return self._theming["error_color"]
|
||||||
|
|
||||||
|
def is_trace_debug(self) -> str: return self._trace_debug
|
||||||
|
def is_debug(self) -> str: return self._debug
|
||||||
|
|
||||||
|
def get_ch_log_lvl(self) -> str: return self._settings["debugging"]["ch_log_lvl"]
|
||||||
|
def get_fh_log_lvl(self) -> str: return self._settings["debugging"]["fh_log_lvl"]
|
||||||
|
|
||||||
|
def set_trace_debug(self, trace_debug):
|
||||||
|
self._trace_debug = trace_debug
|
||||||
|
|
||||||
|
def set_debug(self, debug):
|
||||||
|
self._debug = debug
|
||||||
|
|
||||||
|
|
||||||
|
def load_settings(self):
|
||||||
|
with open(self._CONFIG_FILE) as f:
|
||||||
|
self._settings = json.load(f)
|
||||||
|
self._config = self._settings["config"]
|
||||||
|
self._theming = self._settings["theming"]
|
||||||
|
|
||||||
|
def save_settings(self):
|
||||||
|
with open(self._CONFIG_FILE, 'w') as outfile:
|
||||||
|
json.dump(self._settings, outfile, separators=(',', ':'), indent=4)
|
|
@ -0,0 +1,50 @@
|
||||||
|
# Python imports
|
||||||
|
import os
|
||||||
|
import json
|
||||||
|
import inspect
|
||||||
|
|
||||||
|
# Lib imports
|
||||||
|
|
||||||
|
# Application imports
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class StartCheckMixin:
|
||||||
|
def is_dirty_start(self) -> bool: return self._dirty_start
|
||||||
|
def clear_pid(self): self._clean_pid()
|
||||||
|
|
||||||
|
def do_dirty_start_check(self):
|
||||||
|
if not os.path.exists(self._PID_FILE):
|
||||||
|
self._write_new_pid()
|
||||||
|
else:
|
||||||
|
with open(self._PID_FILE, "r") as _pid:
|
||||||
|
pid = _pid.readline().strip()
|
||||||
|
if pid not in ("", None):
|
||||||
|
self._check_alive_status(int(pid))
|
||||||
|
else:
|
||||||
|
self._write_new_pid()
|
||||||
|
|
||||||
|
""" Check For the existence of a unix pid. """
|
||||||
|
def _check_alive_status(self, pid):
|
||||||
|
print(f"PID Found: {pid}")
|
||||||
|
try:
|
||||||
|
os.kill(pid, 0)
|
||||||
|
except OSError:
|
||||||
|
print(f"{app_name} is starting dirty...")
|
||||||
|
self._dirty_start = True
|
||||||
|
self._write_new_pid()
|
||||||
|
return
|
||||||
|
|
||||||
|
print("PID is alive... Let downstream errors (sans debug args) handle app closure propigation.")
|
||||||
|
|
||||||
|
def _write_new_pid(self):
|
||||||
|
pid = os.getpid()
|
||||||
|
self._write_pid(pid)
|
||||||
|
|
||||||
|
def _clean_pid(self):
|
||||||
|
os.unlink(self._PID_FILE)
|
||||||
|
|
||||||
|
def _write_pid(self, pid):
|
||||||
|
with open(self._PID_FILE, "w") as _pid:
|
||||||
|
_pid.write(f"{pid}")
|
|
@ -0,0 +1,29 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# . CONFIG.sh
|
||||||
|
|
||||||
|
# set -o xtrace ## To debug scripts
|
||||||
|
# set -o errexit ## To exit on error
|
||||||
|
# set -o errunset ## To exit if a variable is referenced but not set
|
||||||
|
|
||||||
|
|
||||||
|
function main() {
|
||||||
|
call_path=`pwd`
|
||||||
|
path=""
|
||||||
|
|
||||||
|
if [[ ! "${1::1}" == /* ]]; then
|
||||||
|
path="${call_path}/${1}"
|
||||||
|
else
|
||||||
|
path="${1}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# NOTE: Remove if you want to pass file(s) besides directories...
|
||||||
|
if [ ! -d "${path}" ]; then
|
||||||
|
echo "<change_me>: Path given not a directory..."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
cd "/opt/"
|
||||||
|
python /opt/<change_me>.zip "$@"
|
||||||
|
}
|
||||||
|
main "$@";
|
|
@ -0,0 +1,11 @@
|
||||||
|
[Desktop Entry]
|
||||||
|
Name=<change_me>
|
||||||
|
GenericName=<change_me>
|
||||||
|
Comment=<change_me>
|
||||||
|
Exec=/bin/<change_me> %F
|
||||||
|
Icon=/usr/share/<change_me>/icons/<change_me>.png
|
||||||
|
Type=Application
|
||||||
|
StartupNotify=true
|
||||||
|
Categories=System;FileTools;Utility;Core;GTK;FileManager;
|
||||||
|
MimeType=
|
||||||
|
Terminal=false
|
|
@ -0,0 +1,28 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!-- Generated with glade 3.40.0 -->
|
||||||
|
<interface>
|
||||||
|
<requires lib="gtk+" version="3.20"/>
|
||||||
|
<object class="GtkBox" id="glade_box">
|
||||||
|
<property name="visible">True</property>
|
||||||
|
<property name="can-focus">False</property>
|
||||||
|
<property name="orientation">vertical</property>
|
||||||
|
<child>
|
||||||
|
<object class="GtkLabel" id="glade_label">
|
||||||
|
<property name="visible">True</property>
|
||||||
|
<property name="can-focus">False</property>
|
||||||
|
<property name="label" translatable="yes">Loaded Me From Glade!</property>
|
||||||
|
</object>
|
||||||
|
<packing>
|
||||||
|
<property name="expand">False</property>
|
||||||
|
<property name="fill">True</property>
|
||||||
|
<property name="position">0</property>
|
||||||
|
</packing>
|
||||||
|
</child>
|
||||||
|
<child>
|
||||||
|
<placeholder/>
|
||||||
|
</child>
|
||||||
|
<child>
|
||||||
|
<placeholder/>
|
||||||
|
</child>
|
||||||
|
</object>
|
||||||
|
</interface>
|
After Width: | Height: | Size: 12 KiB |
After Width: | Height: | Size: 21 KiB |
After Width: | Height: | Size: 1.6 KiB |
After Width: | Height: | Size: 1.5 KiB |
After Width: | Height: | Size: 858 B |
After Width: | Height: | Size: 850 B |
After Width: | Height: | Size: 702 B |
After Width: | Height: | Size: 6.4 KiB |
After Width: | Height: | Size: 925 B |
After Width: | Height: | Size: 882 B |
After Width: | Height: | Size: 707 B |
After Width: | Height: | Size: 798 B |
After Width: | Height: | Size: 989 B |
After Width: | Height: | Size: 1.3 KiB |
After Width: | Height: | Size: 1.8 KiB |
|
@ -0,0 +1,23 @@
|
||||||
|
{
|
||||||
|
"keybindings": {
|
||||||
|
"help" : "F1",
|
||||||
|
"rename_files" : ["F2", "<Control>e"],
|
||||||
|
"open_terminal" : "F4",
|
||||||
|
"refresh_tab" : ["F5", "<Control>r"],
|
||||||
|
"delete_files" : "Delete",
|
||||||
|
"tggl_top_main_menubar" : "<Alt>",
|
||||||
|
"trash_files" : "<Shift><Control>t",
|
||||||
|
"tear_down" : "<Control>q",
|
||||||
|
"go_up" : "<Control>Up",
|
||||||
|
"go_home" : "<Control>slash",
|
||||||
|
"grab_focus_path_entry" : "<Control>l",
|
||||||
|
"open_files" : "<Control>o",
|
||||||
|
"show_hide_hidden_files" : "<Control>h",
|
||||||
|
"keyboard_create_tab" : "<Control>t",
|
||||||
|
"keyboard_close_tab" : "<Control>w",
|
||||||
|
"keyboard_copy_files" : "<Control>c",
|
||||||
|
"keyboard_cut_files" : "<Control>x",
|
||||||
|
"paste_files" : "<Control>v",
|
||||||
|
"show_new_file_menu" : "<Control>n"
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,40 @@
|
||||||
|
{
|
||||||
|
"config": {
|
||||||
|
"base_of_home": "",
|
||||||
|
"hide_hidden_files": "true",
|
||||||
|
"thumbnailer_path": "ffmpegthumbnailer",
|
||||||
|
"go_past_home": "true",
|
||||||
|
"lock_folder": "false",
|
||||||
|
"locked_folders": "venv::::flasks",
|
||||||
|
"mplayer_options": "-quiet -really-quiet -xy 1600 -geometry 50%:50%",
|
||||||
|
"music_app": "/opt/deadbeef/bin/deadbeef",
|
||||||
|
"media_app": "mpv",
|
||||||
|
"image_app": "mirage",
|
||||||
|
"office_app": "libreoffice",
|
||||||
|
"pdf_app": "evince",
|
||||||
|
"text_app": "leafpad",
|
||||||
|
"file_manager_app": "solarfm",
|
||||||
|
"terminal_app": "terminator",
|
||||||
|
"remux_folder_max_disk_usage": "8589934592"
|
||||||
|
},
|
||||||
|
"filters": {
|
||||||
|
"meshs": [".blend", ".dae", ".fbx", ".gltf", ".obj", ".stl"],
|
||||||
|
"code": [".cpp", ".css", ".c", ".go", ".html", ".htm", ".java", ".js", ".json", ".lua", ".md", ".py", ".rs", ".toml", ".xml", ".pom"],
|
||||||
|
"videos": [".mkv", ".mp4", ".webm", ".avi", ".mov", ".m4v", ".mpg", ".mpeg", ".wmv", ".flv"],
|
||||||
|
"office": [".doc", ".docx", ".xls", ".xlsx", ".xlt", ".xltx", ".xlm", ".ppt", ".pptx", ".pps", ".ppsx", ".odt", ".rtf"],
|
||||||
|
"images": [".png", ".jpg", ".jpeg", ".gif", ".ico", ".tga", ".webp"],
|
||||||
|
"text": [".txt", ".text", ".sh", ".cfg", ".conf", ".log"],
|
||||||
|
"music": [".psf", ".mp3", ".ogg", ".flac", ".m4a"],
|
||||||
|
"pdf": [".pdf"]
|
||||||
|
|
||||||
|
},
|
||||||
|
"theming":{
|
||||||
|
"success_color":"#88cc27",
|
||||||
|
"warning_color":"#ffa800",
|
||||||
|
"error_color":"#ff0000"
|
||||||
|
},
|
||||||
|
"debugging": {
|
||||||
|
"ch_log_lvl": 10,
|
||||||
|
"fh_log_lvl": 20
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,86 @@
|
||||||
|
/* Set fm to have transparent window */
|
||||||
|
box,
|
||||||
|
iconview,
|
||||||
|
notebook,
|
||||||
|
paned,
|
||||||
|
stack,
|
||||||
|
scrolledwindow,
|
||||||
|
treeview.view,
|
||||||
|
.content-view,
|
||||||
|
.view {
|
||||||
|
background: rgba(19, 21, 25, 0.14);
|
||||||
|
color: rgba(255, 255, 255, 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
notebook > header > tabs > tab:checked {
|
||||||
|
/* Neon Blue 00e8ff */
|
||||||
|
background-color: rgba(0, 232, 255, 0.2);
|
||||||
|
/* Dark Bergundy */
|
||||||
|
/* background-color: rgba(116, 0, 0, 0.25); */
|
||||||
|
|
||||||
|
color: rgba(255, 255, 255, 0.8);
|
||||||
|
}
|
||||||
|
|
||||||
|
#message_view {
|
||||||
|
font: 16px "Monospace";
|
||||||
|
}
|
||||||
|
|
||||||
|
.view:selected,
|
||||||
|
.view:selected:hover {
|
||||||
|
box-shadow: inset 0 0 0 9999px rgba(21, 158, 167, 0.34);
|
||||||
|
color: rgba(255, 255, 255, 0.5);
|
||||||
|
}
|
||||||
|
|
||||||
|
.alert-border {
|
||||||
|
border: 2px solid rgba(116, 0, 0, 0.64);
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-border {
|
||||||
|
border: 2px solid rgba(136, 204, 39, 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
.notebook-selected-focus {
|
||||||
|
/* Neon Blue 00e8ff border */
|
||||||
|
border: 2px solid rgba(0, 232, 255, 0.34);
|
||||||
|
/* Dark Bergundy */
|
||||||
|
/* border: 2px solid rgba(116, 0, 0, 0.64); */
|
||||||
|
}
|
||||||
|
|
||||||
|
.notebook-unselected-focus {
|
||||||
|
/* Neon Blue 00e8ff border */
|
||||||
|
/* border: 2px solid rgba(0, 232, 255, 0.25); */
|
||||||
|
/* Dark Bergundy */
|
||||||
|
/* border: 2px solid rgba(116, 0, 0, 0.64); */
|
||||||
|
/* Snow White */
|
||||||
|
border: 2px solid rgba(255, 255, 255, 0.24);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/* * {
|
||||||
|
background: rgba(0, 0, 0, 0.14);
|
||||||
|
color: rgba(255, 255, 255, 1);
|
||||||
|
} */
|
||||||
|
|
||||||
|
/* * selection {
|
||||||
|
background-color: rgba(116, 0, 0, 0.65);
|
||||||
|
color: rgba(255, 255, 255, 0.5);
|
||||||
|
} */
|
||||||
|
|
||||||
|
/* Rubberband coloring */
|
||||||
|
/* .rubberband,
|
||||||
|
rubberband,
|
||||||
|
flowbox rubberband,
|
||||||
|
treeview.view rubberband,
|
||||||
|
.content-view rubberband,
|
||||||
|
.content-view .rubberband,
|
||||||
|
XfdesktopIconView.view .rubberband {
|
||||||
|
border: 1px solid #6c6c6c;
|
||||||
|
background-color: rgba(21, 158, 167, 0.57);
|
||||||
|
}
|
||||||
|
|
||||||
|
XfdesktopIconView.view:active {
|
||||||
|
background-color: rgba(172, 102, 21, 1);
|
||||||
|
} */
|