hemna/aprsd
1
0
Fork 0
mirror of https://github.com/craigerl/aprsd.git synced 2024-10-31 15:07:13 -04:00
Code Issues Projects Releases Wiki Activity
026a64c003
aprsd/aprsd/plugins/fortune.py

59 lines
1.4 KiB
Python
Raw Normal View History

refactor Plugin objects to plugins directory This patch moves all of the plugins out of plugin.py into their own separate plugins/<plugin>.py file. This makes it easier to maintain each plugin. NOTE: You will have to update your ~/.config/aprsd/aprsd.yml to change the python location path for each plugin enabled. For example: OLD: enabled_plugins: - aprsd.plugin.EmailPlugin TO NEW enabled_plugins: - aprsd.plugins.email.EmailPlugin
2021-01-09 09:58:56 -05:00
import logging
import shutil
import subprocess
Updated plugins and plugin interfaces for Packet This patch updates unit tests as well as the Plugin filter() interface to accept a packets.Packet object instead of a packet dictionary.
2022-12-14 22:03:21 -05:00
from aprsd import packets, plugin
Moved trace.py to utils This patch moves trace.py to the utils directory
2022-07-07 10:47:34 -04:00
from aprsd.utils import trace
refactor Plugin objects to plugins directory This patch moves all of the plugins out of plugin.py into their own separate plugins/<plugin>.py file. This makes it easier to maintain each plugin. NOTE: You will have to update your ~/.config/aprsd/aprsd.yml to change the python location path for each plugin enabled. For example: OLD: enabled_plugins: - aprsd.plugin.EmailPlugin TO NEW enabled_plugins: - aprsd.plugins.email.EmailPlugin
2021-01-09 09:58:56 -05:00
Use Gray instead of Black for code formatting. The Black code formatter sucks with respect to function declarations with a lot of params. Completely unreadable.
2021-08-23 12:14:19 -04:00
refactor Plugin objects to plugins directory This patch moves all of the plugins out of plugin.py into their own separate plugins/<plugin>.py file. This makes it easier to maintain each plugin. NOTE: You will have to update your ~/.config/aprsd/aprsd.yml to change the python location path for each plugin enabled. For example: OLD: enabled_plugins: - aprsd.plugin.EmailPlugin TO NEW enabled_plugins: - aprsd.plugins.email.EmailPlugin
2021-01-09 09:58:56 -05:00
LOG = logging.getLogger("APRSD")
Refactor Message processing and MORE This patch refactors how the recieved message processing happens. We now handle all incoming packets the same. Removed the notification thread to handle the watchlist packets. This is now done with a unified plugins architecture that allows different capabilities via the new plugin structure. All packets sent to us will be sent through all of the plugins. It's the plugins job to decide what to do with that packet or ignore it. Email is no longer a special case for the most part. All email functions have been migrated to the EmailPlugin, including starting the EmailThread, which works in the background to check for new emails and send those to the registered callsign. The EmailPlugin now starts the EmailThread itself. All plugins are now build on the new APRSDPluginBase which has a common set of features. The APRSDPluginBase calls self.setup() upon creation, which allows all plugins to do whatever they want for initiali startup. The EmailPlugin uses setup() to start the EmailThread if email is enabled.
2021-08-19 11:39:29 -04:00
class FortunePlugin(plugin.APRSDRegexCommandPluginBase):
refactor Plugin objects to plugins directory This patch moves all of the plugins out of plugin.py into their own separate plugins/<plugin>.py file. This makes it easier to maintain each plugin. NOTE: You will have to update your ~/.config/aprsd/aprsd.yml to change the python location path for each plugin enabled. For example: OLD: enabled_plugins: - aprsd.plugin.EmailPlugin TO NEW enabled_plugins: - aprsd.plugins.email.EmailPlugin
2021-01-09 09:58:56 -05:00
"""Fortune."""
Update regex processing and regex for plugins The regex search is now by default case insensitive. Also update each core plugin to better match the command. ping plugin can now match on p p foo ping pIng Weather plugins can now match on w wx wX Wx KM6LYW weather WeaTher
2022-12-29 14:18:38 -05:00
command_regex = r"^([f]|[f]\s|fortune)"
refactor Plugin objects to plugins directory This patch moves all of the plugins out of plugin.py into their own separate plugins/<plugin>.py file. This makes it easier to maintain each plugin. NOTE: You will have to update your ~/.config/aprsd/aprsd.yml to change the python location path for each plugin enabled. For example: OLD: enabled_plugins: - aprsd.plugin.EmailPlugin TO NEW enabled_plugins: - aprsd.plugins.email.EmailPlugin
2021-01-09 09:58:56 -05:00
command_name = "fortune"
Added new list-plugins command This patch adds the new list-plugins command that shows the list of built in plugins for APRSD.
2021-11-12 11:36:22 -05:00
short_description = "Give me a fortune"
refactor Plugin objects to plugins directory This patch moves all of the plugins out of plugin.py into their own separate plugins/<plugin>.py file. This makes it easier to maintain each plugin. NOTE: You will have to update your ~/.config/aprsd/aprsd.yml to change the python location path for each plugin enabled. For example: OLD: enabled_plugins: - aprsd.plugin.EmailPlugin TO NEW enabled_plugins: - aprsd.plugins.email.EmailPlugin
2021-01-09 09:58:56 -05:00
Removed requirement for aprs.fi key This removed the requirement of running APRSD for specifying the aprs.fi key in the config file. The plugins that need the key have been updated to set enabled = False when the key is missing.
2021-11-10 11:01:10 -05:00
fortune_path = None
def setup(self):
self.fortune_path = shutil.which("fortune")
if not self.fortune_path:
self.enabled = False
Fix test failures
2021-11-10 11:51:21 -05:00
else:
self.enabled = True
Removed requirement for aprs.fi key This removed the requirement of running APRSD for specifying the aprs.fi key in the config file. The plugins that need the key have been updated to set enabled = False when the key is missing.
2021-11-10 11:01:10 -05:00
Added tracing facility You can enable debug tracing iff loglevel == DEBUG AND config file has aprsd:trace:True
2021-01-29 10:07:49 -05:00
@trace.trace
Updated plugins and plugin interfaces for Packet This patch updates unit tests as well as the Plugin filter() interface to accept a packets.Packet object instead of a packet dictionary.
2022-12-14 22:03:21 -05:00
def process(self, packet: packets.MessagePacket):
refactor Plugin objects to plugins directory This patch moves all of the plugins out of plugin.py into their own separate plugins/<plugin>.py file. This makes it easier to maintain each plugin. NOTE: You will have to update your ~/.config/aprsd/aprsd.yml to change the python location path for each plugin enabled. For example: OLD: enabled_plugins: - aprsd.plugin.EmailPlugin TO NEW enabled_plugins: - aprsd.plugins.email.EmailPlugin
2021-01-09 09:58:56 -05:00
LOG.info("FortunePlugin")
Add new watchlist feature This patch adds a new optional feature called Watch list. Aprsd will filter IN all aprs packets from a list of callsigns. APRSD will keep track of the last time a callsign has been seen. When the configured timeout value has been reached, the next time a callsign is seen, APRSD will send the next packet from that callsign through the new notification plugins list. The new BaseNotifyPlugin is the default core APRSD notify based plugin. When it gets a packet it will construct a reply message to be sent to the configured alert callsign to alert them that the seen callsign is now on the APRS network. This basically acts as a notification that your watched callsign list is available on APRS. The new configuration options: aprsd: watch_list: # The callsign to send a message to once a watch list callsign # is now seen on APRS-IS alert_callsign: NOCALL # The time in seconds to wait for notification. # The default is 12 hours. alert_time_seconds: 43200 # The list of callsigns to watch for callsigns: - WB4BOR - KFART # Enable/disable this feature enabled: false # The list of notify based plugins to load for # processing a new seen packet from a callsign. enabled_plugins: - aprsd.plugins.notify.BaseNotifyPlugin This patch also adds a new section in the Admin UI for showing the watch list and the age of the last seen packet for each callsing since APRSD startup.
2021-07-14 20:50:41 -04:00
# fromcall = packet.get("from")
# message = packet.get("message_text", None)
# ack = packet.get("msgNo", "0")
refactor Plugin objects to plugins directory This patch moves all of the plugins out of plugin.py into their own separate plugins/<plugin>.py file. This makes it easier to maintain each plugin. NOTE: You will have to update your ~/.config/aprsd/aprsd.yml to change the python location path for each plugin enabled. For example: OLD: enabled_plugins: - aprsd.plugin.EmailPlugin TO NEW enabled_plugins: - aprsd.plugins.email.EmailPlugin
2021-01-09 09:58:56 -05:00
reply = None
try:
Removed requirement for aprs.fi key This removed the requirement of running APRSD for specifying the aprs.fi key in the config file. The plugins that need the key have been updated to set enabled = False when the key is missing.
2021-11-10 11:01:10 -05:00
cmnd = [self.fortune_path, "-s", "-n 60"]
Fixed fortune plugin failures On alpine containers the fortune options aren't all available and we were silently failing. Updated the fortune plugin to capture shell failures.
2021-01-11 14:13:20 -05:00
command = " ".join(cmnd)
output = subprocess.check_output(
command,
shell=True,
timeout=3,
universal_newlines=True,
refactor Plugin objects to plugins directory This patch moves all of the plugins out of plugin.py into their own separate plugins/<plugin>.py file. This makes it easier to maintain each plugin. NOTE: You will have to update your ~/.config/aprsd/aprsd.yml to change the python location path for each plugin enabled. For example: OLD: enabled_plugins: - aprsd.plugin.EmailPlugin TO NEW enabled_plugins: - aprsd.plugins.email.EmailPlugin
2021-01-09 09:58:56 -05:00
)
remove fortune white space
2021-01-17 11:02:45 -05:00
output = (
output.replace("\r", "")
.replace("\n", "")
.replace(" ", "")
.replace("\t", " ")
)
Fixed fortune plugin failures On alpine containers the fortune options aren't all available and we were silently failing. Updated the fortune plugin to capture shell failures.
2021-01-11 14:13:20 -05:00
except subprocess.CalledProcessError as ex:
Use Gray instead of Black for code formatting. The Black code formatter sucks with respect to function declarations with a lot of params. Completely unreadable.
2021-08-23 12:14:19 -04:00
reply = f"Fortune command failed '{ex.output}'"
Fixed fortune plugin failures On alpine containers the fortune options aren't all available and we were silently failing. Updated the fortune plugin to capture shell failures.
2021-01-11 14:13:20 -05:00
else:
reply = output
refactor Plugin objects to plugins directory This patch moves all of the plugins out of plugin.py into their own separate plugins/<plugin>.py file. This makes it easier to maintain each plugin. NOTE: You will have to update your ~/.config/aprsd/aprsd.yml to change the python location path for each plugin enabled. For example: OLD: enabled_plugins: - aprsd.plugin.EmailPlugin TO NEW enabled_plugins: - aprsd.plugins.email.EmailPlugin
2021-01-09 09:58:56 -05:00
return reply
Reference in New Issue Copy Permalink