itdominator/SolarFM
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Restructured plugin system and examples

Browse Source
This commit is contained in:
itdominator
2022-07-06 23:19:41 -05:00
parent 111c535876
commit 8f64066049
11 changed files with 213 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
plugins/README.md Normal file
View File

@@ -0,0 +1,58 @@
### Note
Copy the example and rename it to your desired name. Plugins define a ui target slot with the 'ui_target' permissions data but don't have to if not directly interacted with.
Plugins must have a run method defined; though, you do not need to necessarily do anything within it. The run method implies that the passed in event system or other data is ready for the plugin to use.
### Manifest
```
class Manifest:
path: str = os.path.dirname(os.path.realpath(__file__))
name: str = "Example Plugin"
author: str = "John Doe"
version: str = "0.0.1"
support: str = ""
permissions: {} = {
'ui_target': "plugin_control_list",
'pass_fm_events': "true"
}
```
### Permissions
```
permissions: {} = {
'ui_target': "plugin_control_list",
'ui_target_id': "<some other Gtk Glade ID>" # Only needed if using "other" in "ui_target". See below for predefined "ui_target" options...
'pass_fm_events': "true" # If empty or undefined will be ignored.
}
```
UI Targets:
<ul>
<li>main_Window</li>
<li>main_menu_bar</li>
<li>path_menu_bar</li>
<li>plugin_control_list</li>
<li>window_(1-4)</li>
<li>context_menu</li>
<li>other</li>
</ul>
### Methods
```
# Must define and return a widget if "ui_target" is defined.
def get_ui_element(self):
button = Gtk.Button(label=self.name)
button.connect("button-release-event", self._do_download)
return button
# Must define in plugin if "pass_fm_events" is set to "true" string.
def set_fm_event_system(self, fm_event_system):
self._fm_event_system = fm_event_system
# Must define regardless if needed. Can just pass if plugin does stuff in its __init__
def run(self):
self._module_event_observer()
```

2
plugins/README.txt
View File

@@ -1,2 +0,0 @@
### 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.

49
plugins/template/__main__.py → plugins/template/plugin.py
View File

@@ -24,42 +24,41 @@ def daemon_threaded(fn):
class Plugin:
def __init__(self, builder, event_system):
self.SCRIPT_PTH = os.path.dirname(os.path.realpath(__file__))
self._plugin_name = "Example Plugin"
self._plugin_author = "John Doe"
self._plugin_version = "0.0.1"
class Manifest:
path: str = os.path.dirname(os.path.realpath(__file__))
name: str = "Example Plugin"
author: str = "John Doe"
version: str = "0.0.1"
support: str = ""
permissions: {} = {
'ui_target': "plugin_control_list",
'pass_fm_events': "true"
self._builder = builder
}
class Plugin(Manifest):
def __init__(self):
self._event_system = event_system
self._event_sleep_time = .5
self._event_message = None
button = Gtk.Button(label=self._plugin_name)
def get_ui_element(self):
button = Gtk.Button(label=self.name)
button.connect("button-release-event", self.send_message)
return button
plugin_list = self._builder.get_object("plugin_socket")
plugin_list.add(button)
plugin_list.show_all()
def set_fm_event_system(self, fm_event_system):
self.event_system = fm_event_system
def get_plugin_name(self):
return self._plugin_name
def get_plugin_author(self):
return self._plugin_author
def get_plugin_version(self):
return self._plugin_version
def get_socket_id(self):
return self._socket_id
def run(self):
self._module_event_observer()
def send_message(self, widget=None, eve=None):
message = "Hello, World!"
self._event_system.push_gui_event([self._plugin_name, "display_message", ("warning", message, None)])
self._event_system.push_gui_event([self.name, "display_message", ("warning", message, None)])
@daemon_threaded
@@ -69,7 +68,7 @@ class Plugin:
event = self._event_system.read_module_event()
if event:
try:
if event[0] is self._plugin_name:
if event[0] is self.name:
target_id, method_target, data = self._event_system.consume_module_event()
if not method_target:

50
plugins/youtube_download/__main__.py → plugins/youtube_download/plugin.py
View File

@@ -24,36 +24,36 @@ def daemon_threaded(fn):
class Plugin:
def __init__(self, fm_builder, fm_event_system):
self.SCRIPT_PTH = os.path.dirname(os.path.realpath(__file__))
self._plugin_name = "Youtube Download"
self._plugin_author = "ITDominator"
self._plugin_version = "0.0.1"
class Manifest:
path: str = os.path.dirname(os.path.realpath(__file__))
name: str = "Youtube Download"
author: str = "ITDominator"
version: str = "0.0.1"
support: str = ""
permissions: {} = {
'ui_target': "plugin_control_list",
'pass_fm_events': "true"
self._fm_builder = fm_builder
self._fm_event_system = fm_event_system
}
class Plugin(Manifest):
def __init__(self):
self._fm_event_system = None
self._event_sleep_time = .5
self._fm_event_message = None
self._module_event_observer()
button = Gtk.Button(label=self._plugin_name)
def get_ui_element(self):
button = Gtk.Button(label=self.name)
button.connect("button-release-event", self._do_download)
return button
plugin_list = self._fm_builder.get_object("plugin_socket")
plugin_list.add(button)
plugin_list.show_all()
def set_fm_event_system(self, fm_event_system):
self._fm_event_system = fm_event_system
def get_plugin_name(self):
return self._plugin_name
def get_plugin_author(self):
return self._plugin_author
def get_plugin_version(self):
return self._plugin_version
def run(self):
self._module_event_observer()
@daemon_threaded
@@ -63,7 +63,7 @@ class Plugin:
event = self._fm_event_system.read_module_event()
if event:
try:
if event[0] is self._plugin_name:
if event[0] is self.name:
target_id, method_target, data = self._fm_event_system.consume_module_event()
if not method_target:
@@ -77,10 +77,10 @@ class Plugin:
@threaded
def _do_download(self, widget=None, eve=None):
self._fm_event_system.push_gui_event([self._plugin_name, "get_current_state", ()])
self._fm_event_system.push_gui_event([self.name, "get_current_state", ()])
while not self._fm_event_message:
pass
state = self._fm_event_message
subprocess.Popen([f'{self.SCRIPT_PTH}/download.sh' , state.tab.get_current_directory()])
subprocess.Popen([f'{self.path}/download.sh' , state.tab.get_current_directory()])
self._fm_event_message = None