diff --git a/base-config.yaml b/base-config.yaml index 1d9d451..2068f68 100644 --- a/base-config.yaml +++ b/base-config.yaml @@ -2,37 +2,24 @@ # DO NOT CHANGE THIS UNLESS YOU KNOW WHAT YOU ARE DOING command_prefix: report -# Which regions the bot should pay attention to. -# Pass through empty list to allow all senders for a region. -# Add a list of MatrixIDs to whitelist senders for a region. -# Use __global__ to refer to all regions. -# Code looks to see if a sender is allowed for either a specific region or __global__. +# Which regions the bot should pay attention to +# Additionally, optionally whitelist specific accounts for each region allowed_regions: + __global__: + - "@reports:fiftyfiftyonearizona.org" foo: - - "@reports:fiftyfiftyonerarizona.org" + - "@reports:fiftyfiftyonearizona.org" bar: - "@reports:example.org" - "@reports:example.com" buzz: aaa: -# Bot-specific configurations per region -# Use __global__ to specify an endpoint for all regions. -# Code will push to both __global__ and region-specific endpoint. -region_configs: - __global__: - # Bot-specific configurations - api_url: "https://example.org/wp-json/wp/v2/yourposttype" - api_user: "youruser" - api_token: "your token" - arizona: - # Bot-specific configurations - api_url: "https://example.org/wp-json/wp/v2/yourposttype" - api_user: "youruser" - api_token: "your token" +# Bot-specific configurations +api_url: "https://example.org/wp-json/wp/v2/yourposttype" +api_user: "youruser" +api_token: "your token" # If this bot should send a reaction to the message -# Will send 👍 on successful creation of post, and 👎 on failiure. -# Failiure to post to either the region specific, or __global__ endpoint is -# considered complete failiure. +# if the notification was successful send_reaction: true \ No newline at end of file diff --git a/compile.bash b/compile.bash deleted file mode 100644 index 66c85a3..0000000 --- a/compile.bash +++ /dev/null @@ -1,9 +0,0 @@ -#!/bin/bash - -# Get filename -id=$(cat maubot.yaml | grep "id:" | tr ' ' '\n' | tail -n1) -version=$(cat maubot.yaml | grep "version:" | tr ' ' '\n' | tail -n1) -filename="$id-$version.mbp" - -# Compress to zip -zip $filename * \ No newline at end of file diff --git a/consumerwordpress.py b/consumerwordpress.py index 58a5a9b..9e5a5de 100644 --- a/consumerwordpress.py +++ b/consumerwordpress.py @@ -12,7 +12,9 @@ class Config(BaseProxyConfig): def do_update(self, helper: ConfigUpdateHelper) -> None: helper.copy("command_prefix") helper.copy("allowed_regions") - helper.copy("region_configs") + helper.copy("api_url") + helper.copy("api_user") + helper.copy("api_token") helper.copy("send_reaction") class ConsumerWordpress(Plugin): @@ -28,76 +30,59 @@ class ConsumerWordpress(Plugin): # Get !command_name setting from config to register it def get_command_name(self) -> str: return self.config["command_prefix"] - - # Checks if a sender if allowed to send for a particular region - def validate_sender(self, region: str, sender: str): - # Mautrix isn't documented, like at all, so I'm just gonna catch the - # error because IDK how to see if a map is inside a map. - try: allowed_list = self.config["allowed_regions"][region] - except: return False - - if allowed_list is None: return True # Empty list - if sender in allowed_list: return True - - # Sender not allowed in region config - return False - # Does the necessary config checks for the given event - # Returns list of recursive configs to process - def validate_report(self, evt: MessageEvent, message: str): + # Checks if a sender if allowed to send for a particular region + def validateSender(self, region: str, sender: str): + # Check that config value exists + if not self.config["allowed_regions"]: return False + # Check that region is allowed + if not region in self.config["allowed_regions"]: return False + # All senders allowed for this region + if len(self.config["allowed_regions"][region]) == 0: return True + # Check that sender is allowed for region + if not sender in self.config["allowed_regions"][region]: return False + return True + + # Does the necesary config checks for the given event + # Returns list of regions to process (strings) + # Currently just the specified region and "__global__" + def validateReport(self, evt: MessageEvent, message: str): # Split command (minus !command_name) into tokens tokens = message.split() region = tokens[0].lower() # Each command must have a state/territory designation and a message - if len(tokens) < 2: return [] - # And we must have self.config["region_configs"] - try: trashvariable = self.config["region_configs"] - except: return [] + if len(tokens) < 2: return None - configs = [] # To be returned - - allowed_globally = self.validate_sender("__global__", evt.sender) - allowed_region = self.validate_sender(region, evt.sender) - - # If user is allowed globally and/or for a region, - # the plugin should process both the region and __global__ configs - if allowed_globally or allowed_region: - for i in ["__global__", region]: - try: configs.append(self.config["region_configs"][i]) - except: trashvariable = None - - return configs + if (self.validateSender("__global__", evt.sender)) or (self.validateSender(region, evt.sender)): + return [region] # What gets called when !command_name message is sent @command.new(name=get_command_name, help="Report Something") @command.argument("message", pass_raw=True) async def report(self, evt: MessageEvent, message: str) -> None: # If all have passed - wp_posts_passed = None + ntfy_posts_passed = None # Iterate through each endpoint that the message should be pushed to # (if any) - for region_config in self.validate_report(evt, message): - # Detect no regions in reaction - if wp_posts_passed is None: wp_posts_passed = True - - # Create post with only a title - split_message = message.split() - title = "[" + split_message[0] + "] " + ' '.join(message.split()[1:]) - body = {"title": title, "status": "publish"} - - auth = aiohttp.BasicAuth(region_config["api_user"], region_config["api_token"]) - - async with self.http.post(region_config["api_url"], json=body, auth=auth) as response: - if response.status < 200 or response.status > 299: - wp_posts_passed = False + region = self.validateReport(evt, message) + if region is None: return + + # Create post with only a title + split_message = message.split() + title = "[" + split_message[0] + "] " + ' '.join(message.split()[1:]) + body = {"title": title, "status": "publish"} + + auth = aiohttp.BasicAuth(self.config["api_user"], self.config["api_token"]) # Send notification - if self.config["send_reaction"]: - if wp_posts_passed is True: - await evt.react("👍") - elif wp_posts_passed is False: - await evt.react("👎") + async with self.http.post(self.config["api_url"], json=body, auth=auth) as response: + if self.config["send_reaction"]: + if response.status == 201: + await evt.react("👍") + else : + await evt.react("👎") + self.log.debug(response.text) # That's all, folks \ No newline at end of file diff --git a/maubot.yaml b/maubot.yaml index d7119eb..da68109 100644 --- a/maubot.yaml +++ b/maubot.yaml @@ -1,6 +1,6 @@ maubot: 0.1.0 id: org.fiftyfiftyonearizona.reports.consumerwordpress -version: 1.2.0 +version: 1.1.0 license: MIT modules: - consumerwordpress diff --git a/readme.md b/readme.md index 19d873a..c94aefa 100644 --- a/readme.md +++ b/readme.md @@ -2,11 +2,4 @@ Please see https://git.fiftyfiftyonearizona.org/webmaster/matrix-report-documentation -This plugin supports the following: - -* whitelisting regions, or allowing all regions. -* allowed senders per region, or all regions. -* reaction receipt upon successful creation of posts. -* Different users and WPJson endpoints per region. - -Please see [base-config.yaml](base-config.yaml) for explanation of behavior. \ No newline at end of file +This plugin supports whitelisting state/territory designators, allowed senders, reaction receipt, and authenticated NTFY posting. \ No newline at end of file