commit 6e66f8929872ecdc9a764e3fa13f77b1d2990d27 Author: itdominator Date: Sat Mar 18 04:17:38 2023 +0000 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b6e4761 --- /dev/null +++ b/.gitignore @@ -0,0 +1,129 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4896ce9 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Python-With-Gtk-Template +A template project for Python with Gtk applications. + +### Requirements +* PyGObject +* setproctitle +* pyxdg + +### Note +There are a "\" 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. diff --git a/plugins/README.txt b/plugins/README.txt new file mode 100644 index 0000000..4173ddd --- /dev/null +++ b/plugins/README.txt @@ -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. diff --git a/plugins/template/__init__.py b/plugins/template/__init__.py new file mode 100644 index 0000000..d36fa8c --- /dev/null +++ b/plugins/template/__init__.py @@ -0,0 +1,3 @@ +""" + Pligin Module +""" diff --git a/plugins/template/__main__.py b/plugins/template/__main__.py new file mode 100644 index 0000000..a576329 --- /dev/null +++ b/plugins/template/__main__.py @@ -0,0 +1,3 @@ +""" + Pligin Package +""" diff --git a/plugins/template/manifest.json b/plugins/template/manifest.json new file mode 100644 index 0000000..4dcbf47 --- /dev/null +++ b/plugins/template/manifest.json @@ -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:f"] + } + } +} diff --git a/plugins/template/plugin.py b/plugins/template/plugin.py new file mode 100644 index 0000000..c52c0ff --- /dev/null +++ b/plugins/template/plugin.py @@ -0,0 +1,51 @@ +# Python imports +import os +import threading +import subprocess +import time + +# Lib imports +import gi +gi.require_version('Gtk', '3.0') +from gi.repository import Gtk + +# 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 = Gtk.Button(label=self.name) + button.connect("button-release-event", 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)) diff --git a/src/__builtins__.py b/src/__builtins__.py new file mode 100644 index 0000000..c7b3d32 --- /dev/null +++ b/src/__builtins__.py @@ -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 = "" +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 diff --git a/src/__init__.py b/src/__init__.py new file mode 100644 index 0000000..90dc8da --- /dev/null +++ b/src/__init__.py @@ -0,0 +1,3 @@ +""" + Start of package. +""" diff --git a/src/__main__.py b/src/__main__.py new file mode 100644 index 0000000..abdc793 --- /dev/null +++ b/src/__main__.py @@ -0,0 +1,51 @@ +#!/usr/bin/python3 + +# Python imports +import argparse +import faulthandler +import traceback +from setproctitle import setproctitle + +import tracemalloc +tracemalloc.start() + +# Lib imports +import gi +gi.require_version('Gtk', '3.0') +from gi.repository import Gtk + +# 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) + Gtk.main() + except Exception as e: + traceback.print_exc() + quit() diff --git a/src/app.py b/src/app.py new file mode 100644 index 0000000..1ea9b36 --- /dev/null +++ b/src/app.py @@ -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) diff --git a/src/core/__init__.py b/src/core/__init__.py new file mode 100644 index 0000000..90cfadc --- /dev/null +++ b/src/core/__init__.py @@ -0,0 +1,3 @@ +""" + Gtk Bound Signal Module +""" diff --git a/src/core/controller.py b/src/core/controller.py new file mode 100644 index 0000000..a632026 --- /dev/null +++ b/src/core/controller.py @@ -0,0 +1,76 @@ +# Python imports + +# Lib imports +import gi +gi.require_version('Gtk', '3.0') +gi.require_version('Gdk', '3.0') +from gi.repository import Gtk +from gi.repository import Gdk +from gi.repository import GLib + +# 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.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_glade_file(self): + self.builder = Gtk.Builder() + self.builder.add_from_file(settings.get_glade_file()) + self.builder.expose_object("main_window", self.window) + + settings.set_builder(self.builder) + self.core_widget = CoreWidget() + + settings.register_signals_to_builder([self, self.core_widget]) + + 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__}") diff --git a/src/core/controller_data.py b/src/core/controller_data.py new file mode 100644 index 0000000..2e59e1a --- /dev/null +++ b/src/core/controller_data.py @@ -0,0 +1,65 @@ +# 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.load_glade_file() + 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() diff --git a/src/core/core_widget.py b/src/core/core_widget.py new file mode 100644 index 0000000..2775c0e --- /dev/null +++ b/src/core/core_widget.py @@ -0,0 +1,44 @@ +# Python imports + +# Lib imports +import gi +gi.require_version('Gtk', '3.0') +from gi.repository import Gtk + +# Application imports + + + + +class CoreWidget(Gtk.Box): + def __init__(self): + super(CoreWidget, self).__init__() + + self._builder = settings.get_builder() + + self._setup_styling() + self._setup_signals() + self._load_widgets() + + self.show_all() + + + def _setup_styling(self): + self.set_orientation(1) + + def _setup_signals(self): + ... + + def _load_widgets(self): + glade_box = self._builder.get_object("glade_box") + button = Gtk.Button(label="Click Me!") + + button.connect("clicked", self._hello_world) + + self.add(button) + self.add(glade_box) + + + + def _hello_world(self, widget=None, eve=None): + print("Hello, World!") diff --git a/src/core/mixins/__init__.py b/src/core/mixins/__init__.py new file mode 100644 index 0000000..4589fc7 --- /dev/null +++ b/src/core/mixins/__init__.py @@ -0,0 +1,3 @@ +""" + Generic Mixins Module +""" diff --git a/src/core/mixins/dummy_mixin.py b/src/core/mixins/dummy_mixin.py new file mode 100644 index 0000000..675bb81 --- /dev/null +++ b/src/core/mixins/dummy_mixin.py @@ -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!") diff --git a/src/core/window.py b/src/core/window.py new file mode 100644 index 0000000..1b702a8 --- /dev/null +++ b/src/core/window.py @@ -0,0 +1,95 @@ +# Python imports +import time +import signal + +# Lib imports +import gi +import cairo +gi.require_version('Gtk', '3.0') +gi.require_version('Gdk', '3.0') +from gi.repository import Gtk +from gi.repository import Gdk +from gi.repository import GLib + +# Application imports +from core.controller import Controller + + +class ControllerStartExceptiom(Exception): + ... + + + + +class Window(Gtk.ApplicationWindow): + """docstring for Window.""" + + def __init__(self, args, unknownargs): + super(Window, self).__init__() + + self._controller = None + + self._set_window_data() + self._setup_styling() + self._setup_signals() + self._subscribe_to_events() + + settings.set_main_window(self) + self._load_widgets(args, unknownargs) + + self.show() + + + def _setup_styling(self): + self.set_default_size(settings.get_main_window_width(), + settings.get_main_window_height()) + self.set_title(f"{app_name}") + self.set_icon_from_file( settings.get_window_icon() ) + self.set_gravity(5) # 5 = CENTER + self.set_position(1) # 1 = CENTER, 4 = CENTER_ALWAYS + + def _setup_signals(self): + self.connect("delete-event", self._tear_down) + GLib.unix_signal_add(GLib.PRIORITY_DEFAULT, signal.SIGINT, self._tear_down) + + def _subscribe_to_events(self): + event_system.subscribe("tear_down", self._tear_down) + + def _load_widgets(self, args, unknownargs): + if settings.is_debug(): + self.set_interactive_debugging(True) + + + self._controller = Controller(args, unknownargs) + if not self._controller: + raise ControllerStartException("Controller exited and doesn't exist...") + + self.add( self._controller.get_core_widget() ) + + def _set_window_data(self) -> None: + screen = self.get_screen() + visual = screen.get_rgba_visual() + + if visual != None and screen.is_composited(): + self.set_visual(visual) + self.set_app_paintable(True) + self.connect("draw", self._area_draw) + + # bind css file + cssProvider = Gtk.CssProvider() + cssProvider.load_from_path( settings.get_css_file() ) + screen = Gdk.Screen.get_default() + styleContext = Gtk.StyleContext() + styleContext.add_provider_for_screen(screen, cssProvider, Gtk.STYLE_PROVIDER_PRIORITY_USER) + + def _area_draw(self, widget: Gtk.ApplicationWindow, cr: cairo.Context) -> None: + cr.set_source_rgba(0, 0, 0, 0.54) + cr.set_operator(cairo.OPERATOR_SOURCE) + cr.paint() + cr.set_operator(cairo.OPERATOR_OVER) + + + def _tear_down(self, widget=None, eve=None): + settings.clear_pid() + time.sleep(event_sleep_time) + Gtk.main_quit() diff --git a/src/plugins/__init__.py b/src/plugins/__init__.py new file mode 100644 index 0000000..5624b32 --- /dev/null +++ b/src/plugins/__init__.py @@ -0,0 +1,3 @@ +""" + Gtk Bound Plugins Module +""" diff --git a/src/plugins/manifest.py b/src/plugins/manifest.py new file mode 100644 index 0000000..4088eed --- /dev/null +++ b/src/plugins/manifest.py @@ -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 diff --git a/src/plugins/plugin_base.py b/src/plugins/plugin_base.py new file mode 100644 index 0000000..3130bb4 --- /dev/null +++ b/src/plugins/plugin_base.py @@ -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) diff --git a/src/plugins/plugins_controller.py b/src/plugins/plugins_controller.py new file mode 100644 index 0000000..f0561f7 --- /dev/null +++ b/src/plugins/plugins_controller.py @@ -0,0 +1,119 @@ +# Python imports +import os +import sys +import importlib +import traceback +from os.path import join +from os.path import isdir + +# Lib imports +import gi +gi.require_version('Gtk', '3.0') +from gi.repository import Gtk +from gi.repository import Gio + +# 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._builder = settings.get_builder() + 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() ) + loading_data["ui_target"].show_all() + + 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.") diff --git a/src/utils/__init__.py b/src/utils/__init__.py new file mode 100644 index 0000000..a8e5edd --- /dev/null +++ b/src/utils/__init__.py @@ -0,0 +1,3 @@ +""" + Utils module +""" diff --git a/src/utils/endpoint_registry.py b/src/utils/endpoint_registry.py new file mode 100644 index 0000000..15ffa9e --- /dev/null +++ b/src/utils/endpoint_registry.py @@ -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 diff --git a/src/utils/event_system.py b/src/utils/event_system.py new file mode 100644 index 0000000..88f7299 --- /dev/null +++ b/src/utils/event_system.py @@ -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 diff --git a/src/utils/ipc_server.py b/src/utils/ipc_server.py new file mode 100644 index 0000000..8226247 --- /dev/null +++ b/src/utils/ipc_server.py @@ -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)) diff --git a/src/utils/keybindings.py b/src/utils/keybindings.py new file mode 100644 index 0000000..790c963 --- /dev/null +++ b/src/utils/keybindings.py @@ -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) diff --git a/src/utils/logger.py b/src/utils/logger.py new file mode 100644 index 0000000..6ca2add --- /dev/null +++ b/src/utils/logger.py @@ -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 diff --git a/src/utils/settings/__init__.py b/src/utils/settings/__init__.py new file mode 100644 index 0000000..e07c5a0 --- /dev/null +++ b/src/utils/settings/__init__.py @@ -0,0 +1,4 @@ +""" + Settings module +""" +from .settings import Settings diff --git a/src/utils/settings/settings.py b/src/utils/settings/settings.py new file mode 100644 index 0000000..f6ce27d --- /dev/null +++ b/src/utils/settings/settings.py @@ -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) -> Gtk.ApplicationWindow: return self._main_window_w + def get_main_window_height(self) -> Gtk.ApplicationWindow: 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) diff --git a/src/utils/settings/start_check_mixin.py b/src/utils/settings/start_check_mixin.py new file mode 100644 index 0000000..7fba503 --- /dev/null +++ b/src/utils/settings/start_check_mixin.py @@ -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}") diff --git a/user_config/bin/ b/user_config/bin/ new file mode 100755 index 0000000..7a3e523 --- /dev/null +++ b/user_config/bin/ @@ -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 ": Path given not a directory..." + exit 1 + fi + + cd "/opt/" + python /opt/.zip "$@" +} +main "$@"; diff --git a/user_config/usr/applications/.desktop b/user_config/usr/applications/.desktop new file mode 100755 index 0000000..d459bfb --- /dev/null +++ b/user_config/usr/applications/.desktop @@ -0,0 +1,11 @@ +[Desktop Entry] +Name= +GenericName= +Comment= +Exec=/bin/ %F +Icon=/usr/share//icons/.png +Type=Application +StartupNotify=true +Categories=System;FileTools;Utility;Core;GTK;FileManager; +MimeType= +Terminal=false diff --git a/user_config/usr/share/app_name/Main_Window.glade b/user_config/usr/share/app_name/Main_Window.glade new file mode 100644 index 0000000..c1a1964 --- /dev/null +++ b/user_config/usr/share/app_name/Main_Window.glade @@ -0,0 +1,28 @@ + + + + + + True + False + vertical + + + True + False + Loaded Me From Glade! + + + False + True + 0 + + + + + + + + + + diff --git a/user_config/usr/share/app_name/icons/app_name-64x64.png b/user_config/usr/share/app_name/icons/app_name-64x64.png new file mode 100644 index 0000000..6105709 Binary files /dev/null and b/user_config/usr/share/app_name/icons/app_name-64x64.png differ diff --git a/user_config/usr/share/app_name/icons/app_name.png b/user_config/usr/share/app_name/icons/app_name.png new file mode 100644 index 0000000..c40fb0f Binary files /dev/null and b/user_config/usr/share/app_name/icons/app_name.png differ diff --git a/user_config/usr/share/app_name/icons/archive.png b/user_config/usr/share/app_name/icons/archive.png new file mode 100644 index 0000000..7943e4e Binary files /dev/null and b/user_config/usr/share/app_name/icons/archive.png differ diff --git a/user_config/usr/share/app_name/icons/audio.png b/user_config/usr/share/app_name/icons/audio.png new file mode 100644 index 0000000..c010134 Binary files /dev/null and b/user_config/usr/share/app_name/icons/audio.png differ diff --git a/user_config/usr/share/app_name/icons/bin.png b/user_config/usr/share/app_name/icons/bin.png new file mode 100644 index 0000000..d6954e3 Binary files /dev/null and b/user_config/usr/share/app_name/icons/bin.png differ diff --git a/user_config/usr/share/app_name/icons/dir.png b/user_config/usr/share/app_name/icons/dir.png new file mode 100644 index 0000000..a9b5e9f Binary files /dev/null and b/user_config/usr/share/app_name/icons/dir.png differ diff --git a/user_config/usr/share/app_name/icons/doc.png b/user_config/usr/share/app_name/icons/doc.png new file mode 100644 index 0000000..f838826 Binary files /dev/null and b/user_config/usr/share/app_name/icons/doc.png differ diff --git a/user_config/usr/share/app_name/icons/image.png b/user_config/usr/share/app_name/icons/image.png new file mode 100644 index 0000000..46f1ae6 Binary files /dev/null and b/user_config/usr/share/app_name/icons/image.png differ diff --git a/user_config/usr/share/app_name/icons/pdf.png b/user_config/usr/share/app_name/icons/pdf.png new file mode 100644 index 0000000..9f40122 Binary files /dev/null and b/user_config/usr/share/app_name/icons/pdf.png differ diff --git a/user_config/usr/share/app_name/icons/presentation.png b/user_config/usr/share/app_name/icons/presentation.png new file mode 100644 index 0000000..3a339af Binary files /dev/null and b/user_config/usr/share/app_name/icons/presentation.png differ diff --git a/user_config/usr/share/app_name/icons/spreadsheet.png b/user_config/usr/share/app_name/icons/spreadsheet.png new file mode 100644 index 0000000..710efa6 Binary files /dev/null and b/user_config/usr/share/app_name/icons/spreadsheet.png differ diff --git a/user_config/usr/share/app_name/icons/text.png b/user_config/usr/share/app_name/icons/text.png new file mode 100644 index 0000000..2546fcd Binary files /dev/null and b/user_config/usr/share/app_name/icons/text.png differ diff --git a/user_config/usr/share/app_name/icons/trash.png b/user_config/usr/share/app_name/icons/trash.png new file mode 100644 index 0000000..c6514b9 Binary files /dev/null and b/user_config/usr/share/app_name/icons/trash.png differ diff --git a/user_config/usr/share/app_name/icons/video.png b/user_config/usr/share/app_name/icons/video.png new file mode 100644 index 0000000..55afa98 Binary files /dev/null and b/user_config/usr/share/app_name/icons/video.png differ diff --git a/user_config/usr/share/app_name/icons/web.png b/user_config/usr/share/app_name/icons/web.png new file mode 100644 index 0000000..17017ce Binary files /dev/null and b/user_config/usr/share/app_name/icons/web.png differ diff --git a/user_config/usr/share/app_name/key-bindings.json b/user_config/usr/share/app_name/key-bindings.json new file mode 100644 index 0000000..487bc02 --- /dev/null +++ b/user_config/usr/share/app_name/key-bindings.json @@ -0,0 +1,23 @@ +{ + "keybindings": { + "help" : "F1", + "rename_files" : ["F2", "e"], + "open_terminal" : "F4", + "refresh_tab" : ["F5", "r"], + "delete_files" : "Delete", + "tggl_top_main_menubar" : "", + "trash_files" : "t", + "tear_down" : "q", + "go_up" : "Up", + "go_home" : "slash", + "grab_focus_path_entry" : "l", + "open_files" : "o", + "show_hide_hidden_files" : "h", + "keyboard_create_tab" : "t", + "keyboard_close_tab" : "w", + "keyboard_copy_files" : "c", + "keyboard_cut_files" : "x", + "paste_files" : "v", + "show_new_file_menu" : "n" + } +} diff --git a/user_config/usr/share/app_name/settings.json b/user_config/usr/share/app_name/settings.json new file mode 100644 index 0000000..f75af4f --- /dev/null +++ b/user_config/usr/share/app_name/settings.json @@ -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 + } +} diff --git a/user_config/usr/share/app_name/stylesheet.css b/user_config/usr/share/app_name/stylesheet.css new file mode 100644 index 0000000..c0383f6 --- /dev/null +++ b/user_config/usr/share/app_name/stylesheet.css @@ -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); +} */