From c1dec9d808c904708a70da490daf2d6e1f4b6271 Mon Sep 17 00:00:00 2001 From: Schimon Jehudah Date: Fri, 16 Feb 2024 13:16:52 +0000 Subject: [PATCH] Adjust modules client and component --- slixfeed/xmpp/client.py | 8 +- slixfeed/xmpp/component.py | 1030 +++++++++++++++++++++++++++++++----- 2 files changed, 903 insertions(+), 135 deletions(-) diff --git a/slixfeed/xmpp/client.py b/slixfeed/xmpp/client.py index 41bcf0e..2411a76 100644 --- a/slixfeed/xmpp/client.py +++ b/slixfeed/xmpp/client.py @@ -223,14 +223,8 @@ class Slixfeed(slixmpp.ClientXMPP): def on_session_resumed(self, event): # self.send_presence() profile.set_identity(self, 'client') - # self.service_commands() - # self.service_reactions() self['xep_0115'].update_caps() XmppGroupchat.autojoin(self) - - # Service.commands(self) - # Service.reactions(self) - async def on_disco_info(self, DiscoInfo): @@ -1321,7 +1315,7 @@ class Slixfeed(slixmpp.ClientXMPP): value = False form.add_field(var='old', ftype='boolean', - desc='Send old items of newly added subscriptions.', + desc='Treat all items of newly added subscriptions as new.', # label='Send only new items', label='Include old news', value=value) diff --git a/slixfeed/xmpp/component.py b/slixfeed/xmpp/component.py index 923f2dd..c6e14c6 100644 --- a/slixfeed/xmpp/component.py +++ b/slixfeed/xmpp/component.py @@ -30,8 +30,11 @@ from slixmpp.plugins.xep_0048.stanza import Bookmarks # import xml.etree.ElementTree as ET # from lxml import etree +import slixfeed.action as action import slixfeed.config as config +from slixfeed.dt import timestamp import slixfeed.sqlite as sqlite +from slixfeed.version import __version__ from slixfeed.xmpp.bookmark import XmppBookmark from slixfeed.xmpp.connect import XmppConnect # NOTE MUC is possible for component @@ -42,6 +45,7 @@ import slixfeed.xmpp.profile as profile # from slixfeed.xmpp.roster import XmppRoster # import slixfeed.xmpp.service as service from slixfeed.xmpp.presence import XmppPresence +from slixfeed.xmpp.upload import XmppUpload from slixfeed.xmpp.utility import get_chat_type from slixmpp.xmlstream import ET # from slixmpp.xmlstream.handler import Callback @@ -92,6 +96,8 @@ class SlixfeedComponent(slixmpp.ComponentXMPP): # self.add_event_handler("got_online", self.check_readiness) self.add_event_handler("changed_status", self.on_changed_status) + self.add_event_handler("disco_info", + self.on_disco_info) self.add_event_handler("presence_available", self.on_presence_available) self.add_event_handler("presence_unavailable", @@ -175,25 +181,27 @@ class SlixfeedComponent(slixmpp.ComponentXMPP): profile.set_identity(self, 'service') await profile.update(self) task.task_ping(self) - - # Service.commands(self) - # Service.reactions(self) - - self.service_commands() - self.service_reactions() + # bookmarks = await self.plugin['xep_0048'].get_bookmarks() + # XmppGroupchat.autojoin(self, bookmarks) + if config.get_value('accounts', 'XMPP', 'operator'): + jid_op = config.get_value('accounts', 'XMPP', 'operator') + message_body = 'Slixfeed version {}'.format(__version__) + XmppMessage.send(self, jid_op, message_body, 'chat') def on_session_resumed(self, event): - self.send_presence() + # self.send_presence() + profile.set_identity(self, 'service') self['xep_0115'].update_caps() # await XmppGroupchat.autojoin(self) - profile.set_identity(self, 'service') - - # Service.commands(self) - # Service.reactions(self) - - self.service_commands() - self.service_reactions() + + + async def on_disco_info(self, DiscoInfo): + jid = DiscoInfo['from'] + # self.service_commands() + # self.service_reactions() + # self.send_presence(pto=jid) + await self['xep_0115'].update_caps(jid=jid) # TODO Request for subscription @@ -210,7 +218,6 @@ class SlixfeedComponent(slixmpp.ComponentXMPP): # presence_probe.send() await process.message(self, message) - # chat_type = message["type"] # message_body = message["body"] # message_reply = message.reply @@ -219,19 +226,30 @@ class SlixfeedComponent(slixmpp.ComponentXMPP): async def on_changed_status(self, presence): # await task.check_readiness(self, presence) jid = presence['from'].bare + if jid in self.boundjid.bare: + return if presence['show'] in ('away', 'dnd', 'xa'): task.clean_tasks_xmpp(self, jid, ['interval']) await task.start_tasks_xmpp(self, jid, ['status', 'check']) - def on_presence_subscribe(self, presence): + async def on_presence_subscribe(self, presence): jid = presence['from'].bare - # XmppPresence.request(self, jid) - XmppPresence.subscription(self, jid, 'subscribe') + if not self.client_roster[jid]['to']: + # XmppPresence.subscription(self, jid, 'subscribe') + XmppPresence.subscription(self, jid, 'subscribed') + await XmppRoster.add(self, jid) + status_message = 'āœ’ļø Share online status to receive updates' + XmppPresence.send(self, jid, status_message) + message_subject = 'RSS News Bot' + message_body = 'Share online status to receive updates.' + XmppMessage.send_headline(self, jid, message_subject, message_body, + 'chat') def on_presence_subscribed(self, presence): jid = presence['from'].bare + # XmppPresence.subscription(self, jid, 'subscribed') message_subject = 'RSS News Bot' message_body = ('Greetings! I am {}, the news anchor.\n' 'My job is to bring you the latest ' @@ -247,10 +265,15 @@ class SlixfeedComponent(slixmpp.ComponentXMPP): # await task.start_tasks(self, presence) # NOTE Already done inside the start-task function jid = presence['from'].bare + if jid in self.boundjid.bare: + return + logging.info('JID {} is available'.format(jid)) # FIXME TODO Find out what is the source responsible for a couple presences with empty message # NOTE This is a temporary solution await asyncio.sleep(10) await task.start_tasks_xmpp(self, jid) + self.add_event_handler("presence_unavailable", + self.on_presence_unavailable) def on_presence_unsubscribed(self, presence): @@ -262,13 +285,23 @@ class SlixfeedComponent(slixmpp.ComponentXMPP): XmppPresence.subscription(self, jid, 'unsubscribed') # XmppPresence.send(self, jid, status_message, # presence_type='unsubscribed') + # XmppRoster.remove(self, jid) def on_presence_unavailable(self, presence): jid = presence['from'].bare + logging.info('JID {} is unavailable'.format(jid)) # await task.stop_tasks(self, jid) task.clean_tasks_xmpp(self, jid) + # NOTE Albeit nice to ~have~ see, this would constantly + # send presence messages to server to no end. + status_message = 'Farewell' + XmppPresence.send(self, jid, status_message, + presence_type='unavailable') + self.del_event_handler("presence_unavailable", + self.on_presence_unavailable) + # TODO # Send message that database will be deleted within 30 days @@ -276,9 +309,8 @@ class SlixfeedComponent(slixmpp.ComponentXMPP): # If roster, remove contact JID into file # If bookmarks, remove groupchat JID into file def on_presence_error(self, presence): - print("on_presence_error") - print(presence) jid = presence["from"].bare + logging.info('JID {} (error)'.format(jid)) task.clean_tasks_xmpp(self, jid) @@ -288,38 +320,54 @@ class SlixfeedComponent(slixmpp.ComponentXMPP): async def on_chatstate_active(self, message): + jid = message['from'].bare + if jid in self.boundjid.bare: + return if message['type'] in ('chat', 'normal'): - jid = message['from'].bare + # NOTE: Required for Cheogram + # await self['xep_0115'].update_caps(jid=jid) + # self.send_presence(pto=jid) # task.clean_tasks_xmpp(self, jid, ['status']) + await asyncio.sleep(5) await task.start_tasks_xmpp(self, jid, ['status']) - def on_chatstate_composing(self, message): + async def on_chatstate_composing(self, message): if message['type'] in ('chat', 'normal'): jid = message['from'].bare + # NOTE: Required for Cheogram + # await self['xep_0115'].update_caps(jid=jid) + # self.send_presence(pto=jid) # task.clean_tasks_xmpp(self, jid, ['status']) + await asyncio.sleep(5) status_message = ('šŸ’” Send "help" for manual, or "info" for ' 'information.') XmppPresence.send(self, jid, status_message) async def on_chatstate_gone(self, message): + jid = message['from'].bare + if jid in self.boundjid.bare: + return if message['type'] in ('chat', 'normal'): - jid = message['from'].bare # task.clean_tasks_xmpp(self, jid, ['status']) await task.start_tasks_xmpp(self, jid, ['status']) async def on_chatstate_inactive(self, message): + jid = message['from'].bare + if jid in self.boundjid.bare: + return if message['type'] in ('chat', 'normal'): - jid = message['from'].bare # task.clean_tasks_xmpp(self, jid, ['status']) await task.start_tasks_xmpp(self, jid, ['status']) async def on_chatstate_paused(self, message): + jid = message['from'].bare + if jid in self.boundjid.bare: + return if message['type'] in ('chat', 'normal'): - jid = message['from'].bare # task.clean_tasks_xmpp(self, jid, ['status']) await task.start_tasks_xmpp(self, jid, ['status']) @@ -385,44 +433,277 @@ class SlixfeedComponent(slixmpp.ComponentXMPP): # ) # if jid == config.get_value('accounts', 'XMPP', 'operator'): - # self['xep_0050'].add_command(node='bookmarks', - # name='Bookmarks', - # handler=self._handle_bookmarks) - # self['xep_0050'].add_command(node='roster', - # name='Roster', - # handler=self._handle_roster) - self['xep_0050'].add_command(node='settings', - name='Settings', - handler=self._handle_settings) + self['xep_0050'].add_command(node='subscription', + name='āž•ļø Add', + handler=self._handle_subscription_add) self['xep_0050'].add_command(node='subscriptions', - name='Subscriptions', + name='šŸ“°ļø Subscriptions', handler=self._handle_subscriptions) + # self['xep_0050'].add_command(node='subscriptions_cat', + # name='šŸ”–ļø Categories', + # handler=self._handle_subscription) + # self['xep_0050'].add_command(node='subscriptions_tag', + # name='šŸ·ļø Tags', + # handler=self._handle_subscription) + # self['xep_0050'].add_command(node='subscriptions_index', + # name='šŸ“‘ļø Index (A - Z)', + # handler=self._handle_subscription) + # TODO Join Filters and Settings into Preferences + self['xep_0050'].add_command(node='filters', + name='šŸ›”ļø Filters', + handler=self._handle_filters) + self['xep_0050'].add_command(node='settings', + name='šŸ“®ļø Settings', + handler=self._handle_settings) + if not self.is_component: # This will be changed with XEP-0222 XEP-0223 + self['xep_0050'].add_command(node='bookmarks', + name='šŸ“• Bookmarks', + handler=self._handle_bookmarks) + self['xep_0050'].add_command(node='roster', + name='šŸ““ Roster', # šŸ“‹ + handler=self._handle_roster) + self['xep_0050'].add_command(node='help', + name='šŸ“”ļø Manual', + handler=self._handle_help) + self['xep_0050'].add_command(node='totd', + name='šŸ’”ļø TOTD', + handler=self._handle_totd) + self['xep_0050'].add_command(node='fotd', + name='šŸ—“ļø FOTD', + handler=self._handle_fotd) + self['xep_0050'].add_command(node='activity', + name='šŸ“ ļø Activity', + handler=self._handle_activity) + self['xep_0050'].add_command(node='statistics', + name='šŸ“Šļø Statistics', + handler=self._handle_statistics) + self['xep_0050'].add_command(node='import', + name='šŸ“„ļø Import', + handler=self._handle_import) + self['xep_0050'].add_command(node='export', + name='šŸ“¤ļø Export', + handler=self._handle_export) + self['xep_0050'].add_command(node='credit', + name='šŸ…ļø Credits', + handler=self._handle_credit) + self['xep_0050'].add_command(node='privacy', + name='Privacy', + handler=self._handle_privacy) + self['xep_0050'].add_command(node='about', + name='About', # šŸ“œļø + handler=self._handle_about) + self['xep_0050'].add_command(node='exploit', + name='Exploit', # šŸ“œļø + handler=self._handle_reveal_jid) # self['xep_0050'].add_command(node='search', # name='Search', # handler=self._handle_search) - # self['xep_0050'].add_command(node='filters', - # name='Filters', - # handler=self._handle_filters) + + # Special interface + # http://jabber.org/protocol/commands#actions + + async def _handle_reveal_jid(self, iq, session): + jid = session['from'].bare + session['notes'] = [['info', jid]] + return session + + async def _handle_filters(self, iq, session): + jid = session['from'].bare + jid_file = jid + db_file = config.get_pathname_to_database(jid_file) + form = self['xep_0004'].make_form('form', 'Filters') + form['instructions'] = 'šŸ›”ļø Manage filters' # šŸŖ„ļø + value = sqlite.get_filter_value(db_file, 'allow') + if value: value = str(value[0]) + form.add_field(var='allow', + ftype='text-single', + label='Allow list', + value=value, + desc=('Keywords to allow (comma-separated keywords).')) + value = sqlite.get_filter_value(db_file, 'deny') + if value: value = str(value[0]) + form.add_field(var='deny', + ftype='text-single', + label='Deny list', + value=value, + desc=('Keywords to deny (comma-separated keywords).')) + session['payload'] = form + session['next'] = self._handle_filters_complete + session['has_next'] = True + return session + + + async def _handle_filters_complete(self, payload, session): + """ + Process a command result from the user. + + Arguments: + payload -- Either a single item, such as a form, or a list + of items or forms if more than one form was + provided to the user. The payload may be any + stanza, such as jabber:x:oob for out of band + data, or jabber:x:data for typical data forms. + session -- A dictionary of data relevant to the command + session. Additional, custom data may be saved + here to persist across handler callbacks. + """ + # Text is not displayed; only labels + form = payload + + jid = session['from'].bare + form = self['xep_0004'].make_form('result', 'Filters') + form['instructions'] = ('āœ…ļø Filters have been updated') + jid_file = jid + db_file = config.get_pathname_to_database(jid_file) + # In this case (as is typical), the payload is a form + values = payload['values'] + for value in values: + key = value + val = values[value] + # NOTE We might want to add new keywords from + # an empty form instead of editing a form. + # keywords = sqlite.get_filter_value(db_file, key) + keywords = '' + val = await config.add_to_list(val, keywords) if val else '' + if sqlite.is_filter_key(db_file, key): + await sqlite.update_filter_value(db_file, [key, val]) + elif val: + await sqlite.set_filter_value(db_file, [key, val]) + form.add_field(var=key.capitalize() + ' list', + ftype='text-single', + value=val) + session['payload'] = form + session["has_next"] = False + session['next'] = None + return session + + + async def _handle_subscription_add(self, iq, session): + jid = session['from'].bare + form = self['xep_0004'].make_form('form', 'Add Subscriptions') + form['instructions'] = 'šŸ“°ļø Add a new subscription' + options = form.add_field(var='subscription', + # TODO Make it possible to add several subscriptions at once; + # Similarly to BitTorrent trackers list + # ftype='text-multi', + # label='Subscription URLs', + # desc=('Add subscriptions one time per ' + # 'subscription.'), + ftype='text-single', + label='Subscription URL', + desc='Enter subscription URL.', + required=True) + form.add_field(var='scan', + ftype='boolean', + label='Scan', + desc='Scan URL for validity.', + value=True) + session['payload'] = form + session['next'] = self._handle_subscription_new + session['has_next'] = True + return session + + + async def _handle_subscription_new(self, payload, session): + jid = session['from'].bare + jid_file = jid + db_file = config.get_pathname_to_database(jid_file) + url = payload['values']['subscription'] + result = await action.add_feed(db_file, url) + if isinstance(result, list): + results = result + form = self['xep_0004'].make_form('form', 'Subscriptions') + form['instructions'] = ('šŸ”ļø Discovered {} subscriptions for {}' + .format(len(results), url)) + options = form.add_field(var='subscriptions', + ftype='list-single', + label='Subscriptions', + desc=('Select a subscription to add.'), + required=True) + for result in results: + options.addOption(result['name'], result['url']) + session['payload'] = form + session['next'] = self._handle_subscription_editor + session['has_next'] = True + elif result['exist']: + # response = ('News source "{}" is already listed ' + # 'in the subscription list at index ' + # '{}.\n{}'.format(result['name'], result['index'], + # result['url'])) + # session['notes'] = [['warn', response]] # Not supported by Gajim + # session['notes'] = [['info', response]] + form = self['xep_0004'].make_form('result', 'Subscriptions') + form['instructions'] = ('āš ļø Feed "{}" already exist as index {}' + .format(result['name'], result['index'])) + options = form.add_field(var='subscriptions', + ftype='text-single', + label=result['url'], + desc='Choose next to edit subscription.', + value=result['url']) + # FIXME payload value does not pass, only []. + session['payload'] = form + session['next'] = self._handle_subscription_editor + session['has_next'] = True + elif result['error']: + response = ('Failed to load URL.' + '\n\n' + 'Reason: {}' + '\n\n' + 'URL: {}' + .format(result['code'], url)) + session['notes'] = [['error', response]] + session['next'] = None + else: + # response = ('News source "{}" has been ' + # 'added to subscription list.\n{}' + # .format(result['name'], result['url'])) + # session['notes'] = [['info', response]] + form = self['xep_0004'].make_form('result', 'Subscriptions') + form['instructions'] = ('āœ…ļø News source "{}" has been added to ' + 'subscription list as index {}' + .format(result['name'], result['index'])) + options = form.add_field(var='subscriptions', + ftype='text-single', + label=result['url'], + desc='Choose next to edit subscription.', + value=result['url']) + # FIXME payload value does not pass, only []. + session['payload'] = form + session['next'] = self._handle_subscription_editor + session['has_next'] = True + return session async def _handle_subscriptions(self, iq, session): + jid = session['from'].bare form = self['xep_0004'].make_form('form', 'Subscriptions') - form['instructions'] = 'šŸ“°ļø Manage subscriptions.' + form['instructions'] = 'šŸ“°ļø Manage subscriptions' # form.addField(var='interval', # ftype='text-single', # label='Interval period') options = form.add_field(var='subscriptions', ftype='list-multi', - label='Select subscriptions', - desc='Select subscription(s) to edit.') - jid = session['from'].bare + label='Subscriptions', + desc=('Select subscriptions to perform ' + 'actions upon.'), + required=True) jid_file = jid db_file = config.get_pathname_to_database(jid_file) subscriptions = await sqlite.get_feeds(db_file) + subscriptions = sorted(subscriptions, key=lambda x: x[0]) for subscription in subscriptions: title = subscription[0] url = subscription[1] options.addOption(title, url) + # options = form.add_field(var='action', + # ftype='list-single', + # label='Action', + # value='none') + # options.addOption('None', 'none') + # options.addOption('Reset', 'reset') + # options.addOption('Enable', 'enable') + # options.addOption('Disable', 'disable') + # options.addOption('Delete', 'delete') session['payload'] = form session['next'] = self._handle_subscription_editor session['has_next'] = True @@ -443,79 +724,515 @@ class SlixfeedComponent(slixmpp.ComponentXMPP): return session - # TODO Make form for a single subscription and several subscriptions - # single: Delete, Disable, Reset and Rename - # several: Delete, Disable, Reset - async def _handle_subscription_editor(self, iq, session): + # FIXME There are feeds that are missing (possibly because of sortings) + async def _handle_subscription(self, iq, session): + jid = session['from'].bare form = self['xep_0004'].make_form('form', 'Subscriptions') - form['instructions'] = 'šŸ—žļø Edit subscriptions.' - options = form.add_field(var='enable', - ftype='boolean', - label='Enable', - value=True) - options = form.add_field(var='action', - ftype='list-single', - label='Action', - value='reset') - options.addOption('Delete', 'delete') - options.addOption('Reset', 'reset') + form['instructions'] = 'šŸ“°ļø Edit subscription' + # form.addField(var='interval', + # ftype='text-single', + # label='Interval period') + jid_file = jid + db_file = config.get_pathname_to_database(jid_file) + subscriptions = await sqlite.get_feeds(db_file) + # subscriptions = set(subscriptions) + categorized_subscriptions = {} + for subscription in subscriptions: + title = subscription[0] + url = subscription[1] + try: + letter = title[0].capitalize() + if letter not in categorized_subscriptions: + categorized_subscriptions[letter] = [subscription] + # title[0].capitalize()] = [subscription] + else: + categorized_subscriptions[letter].append(subscription) + # title[0].capitalize()].append(subscription) + except Exception as e: + logging.warning('Title might be empty:', str(e)) + for category in sorted(categorized_subscriptions): + options = form.add_field(var=category, + ftype='list-single', + label=category.capitalize(), + desc='Select a subscription to view.') + subscriptions_ = categorized_subscriptions[category] + subscriptions_ = sorted(subscriptions_, key=lambda x: x[0]) + for subscription_ in subscriptions_: + # for subscription in categorized_subscriptions[category]: + # breakpoint() + title = subscription_[0] + url = subscription_[1] + options.addOption(title, url) session['payload'] = form + session['next'] = self._handle_subscription_editor + session['has_next'] = True + return session + + + async def _handle_subscription_editor(self, payload, session): + jid = session['from'].bare + jid_file = jid + db_file = config.get_pathname_to_database(jid_file) + if 'subscriptions' in payload['values']: + urls = payload['values']['subscriptions'] + url_count = len(urls) + if isinstance(urls, list) and url_count > 1: + form = self['xep_0004'].make_form('form', 'Subscription editor') + form['instructions'] = 'šŸ“‚ļø Editing {} subscriptions'.format(url_count) + form.add_field(var='options', + ftype='fixed', + value='Options') + options = form.add_field(var='action', + ftype='list-single', + label='Action', + value='none') + options.addOption('None', 'none') + counter = 0 + for url in urls: + feed_id = await sqlite.get_feed_id(db_file, url) + feed_id = feed_id[0] + count = sqlite.get_number_of_unread_entries_by_feed(db_file, feed_id) + counter += count[0] + if int(counter): + options.addOption('Mark {} entries as read'.format(counter), 'reset') + options.addOption('Delete {} subscriptions'.format(url_count), 'delete') + options.addOption('Export {} subscriptions'.format(url_count), 'export') + else: + url = urls[0] + feed_id = await sqlite.get_feed_id(db_file, url) + feed_id = feed_id[0] + title = sqlite.get_feed_title(db_file, feed_id) + title = title[0] + form = self['xep_0004'].make_form('form', 'Subscription editor') + form['instructions'] = 'šŸ“‚ļø Editing subscription #{}'.format(feed_id) + form.add_field(ftype='fixed', + value='Properties') + form.add_field(var='name', + ftype='text-single', + label='Name', + value=title) + # NOTE This does not look good in Gajim + # url = form.add_field(ftype='fixed', + # value=url) + #url['validate']['datatype'] = 'xs:anyURI' + form.add_field(var='url', + ftype='text-single', + label='URL', + value=url) + form.add_field(ftype='fixed', + value='Options') + options = form.add_field(var='action', + ftype='list-single', + label='Action', + value='none') + options.addOption('None', 'none') + count = sqlite.get_number_of_unread_entries_by_feed(db_file, feed_id) + count = count[0] + if int(count): + options.addOption('Mark {} entries as read'.format(count), 'reset') + options.addOption('Delete subscription', 'delete') + form.add_field(var='enable', + ftype='boolean', + label='Enable', + value=True) + options = form.add_field(var='priority', + ftype='list-single', + label='Priority', + value='0') + options['validate']['datatype'] = 'xs:integer' + options['validate']['range'] = { 'minimum': 1, 'maximum': 5 } + i = 0 + while i <= 5: + num = str(i) + options.addOption(num, num) + i += 1 + form.add_field(ftype='fixed', + value='Labels') + options = form.add_field(var='category', + ftype='list-single', + label='Category', + value='none') + options.addOption('None', 'none') + options.addOption('Activity', 'activity') + options.addOption('Catalogues', 'catalogues') + options.addOption('Clubs', 'clubs') + options.addOption('Events', 'events') + options.addOption('Forums', 'forums') + options.addOption('Music', 'music') + options.addOption('News', 'news') + options.addOption('Organizations', 'organizations') + options.addOption('Podcasts', 'podcasts') + options.addOption('Projects', 'projects') + options.addOption('Schools', 'schools') + options.addOption('Stores', 'stores') + options.addOption('Tutorials', 'tutorials') + options.addOption('Videos', 'videos') + options = form.add_field(var='tags', + ftype='text-single', + # ftype='text-multi', + label='Tags', + value='') + session['payload'] = form + session['next'] = self._handle_subscription_complete + session['has_next'] = True + return session + + + async def _handle_subscription_selector(self, payload, session): + jid = session['from'].bare + form = self['xep_0004'].make_form('form', 'Subscribe') + form['instructions'] = ('šŸ“°ļø Select a subscriptions to add\n' + 'Subsciptions discovered for {}' + .format(url)) + # form.addField(var='interval', + # ftype='text-single', + # label='Interval period') + options = form.add_field(var='subscriptions', + ftype='list-multi', + label='Subscriptions', + desc=('Select subscriptions to perform ' + 'actions upon.'), + required=True) + jid_file = jid + db_file = config.get_pathname_to_database(jid_file) + subscriptions = await sqlite.get_feeds(db_file) + subscriptions = sorted(subscriptions, key=lambda x: x[0]) + for subscription in subscriptions: + title = subscription[0] + url = subscription[1] + options.addOption(title, url) + # options = form.add_field(var='action', + # ftype='list-single', + # label='Action', + # value='none') + # options.addOption('None', 'none') + # options.addOption('Reset', 'reset') + # options.addOption('Enable', 'enable') + # options.addOption('Disable', 'disable') + # options.addOption('Delete', 'delete') + session['payload'] = form + session['next'] = self._handle_subscription_editor + session['has_next'] = True + return session + + + async def _handle_subscription_complete(self, payload, session): + form = self['xep_0004'].make_form('form', 'Subscription editor') + form['instructions'] = ('šŸ“ļø Subscription #{} has been {}' + .format(feed_id, action)) + pass + + + async def _handle_about(self, iq, session): + # form = self['xep_0004'].make_form('result', 'Thanks') + # form['instructions'] = action.manual('information.toml', 'thanks') + # session['payload'] = form + # text = 'šŸ’”ļø About Slixfeed, slixmpp and XMPP\n\n' + # text += '\n\n' + # form = self['xep_0004'].make_form('result', 'About') + text = 'Slixfeed {}\n\n'.format(__version__) + text += ''.join(action.manual('information.toml', 'about')) + text += '\n\n' + text += 'Slixmpp\n\n' + text += ''.join(action.manual('information.toml', 'slixmpp')) + text += '\n\n' + text += 'SleekXMPP\n\n' + text += ''.join(action.manual('information.toml', 'sleekxmpp')) + text += '\n\n' + text += 'XMPP\n\n' + text += ''.join(action.manual('information.toml', 'xmpp')) + session['notes'] = [['info', text]] + # form.add_field(var='about', + # ftype='text-multi', + # label='About', + # value=text) + # session['payload'] = form + return session + + + async def _handle_activity(self, iq, session): + # TODO dialog for JID and special dialog for operator + text = ('Here you can monitor activity') + session['notes'] = [['info', text]] + return session + + + async def _handle_statistics(self, iq, session): + text = ('Here you can monitor statistics') + session['notes'] = [['info', text]] + return session + + + async def _handle_import(self, iq, session): + form = self['xep_0004'].make_form('form', 'Import') + form['instructions'] = 'šŸ—žļø Import feeds from OPML' + url = form.add_field(var='url', + ftype='text-single', + label='URL', + desc='Enter URL to OPML file.', + required=True) + url['validate']['datatype'] = 'xs:anyURI' + session['payload'] = form + session['next'] = self._handle_import_complete + session['has_next'] = True + return session + + + async def _handle_import_complete(self, payload, session): session['next'] = None - session['has_next'] = False + url = payload['values']['url'] + if url.startswith('http') and url.endswith('.opml'): + jid = session['from'].bare + jid_file = jid.replace('/', '_') + db_file = config.get_pathname_to_database(jid_file) + count = await action.import_opml(db_file, url) + try: + int(count) + form = self['xep_0004'].make_form('result', 'Import') + form['instructions'] = ('āœ…ļø Feeds have been imported') + message = '{} feeds have been imported to {}.'.format(count, jid) + form.add_field(var='message', + ftype='text-single', + value=message) + session['payload'] = form + session["has_next"] = False + except: + session['notes'] = [['error', 'Import failed. Filetype does not appear to be an OPML file.']] + session['has_next'] = False + else: + session['notes'] = [['error', 'Import aborted. Send URL of OPML file.']] + session['has_next'] = False + return session + + + async def _handle_export(self, iq, session): + form = self['xep_0004'].make_form('form', 'Export') + form['instructions'] = 'šŸ—žļø Export feeds' + options = form.add_field(var='filetype', + ftype='list-multi', + label='Format', + desc='Choose export format.', + value='opml', + required=True) + options.addOption('Markdown', 'md') + options.addOption('OPML', 'opml') + # options.addOption('HTML', 'html') + # options.addOption('XBEL', 'xbel') + session['payload'] = form + session['next'] = self._handle_export_complete + session['has_next'] = True + return session + + + async def _handle_export_complete(self, payload, session): + jid = session['from'].bare + jid_file = jid.replace('/', '_') + form = self['xep_0004'].make_form('result', 'Export') + form['instructions'] = ('āœ…ļø Feeds have been exported') + exts = payload['values']['filetype'] + for ext in exts: + filename = await action.export_feeds(self, jid, jid_file, ext) + url = await XmppUpload.start(self, jid, filename) + form.add_field(var=ext.upper(), + ftype='text-single', + label=ext, + value=url) + session['payload'] = form + session["has_next"] = False + session['next'] = None + return session + + + async def _handle_privacy(self, iq, session): + text = ('Privacy Policy') + text += '\n\n' + text += ''.join(action.manual('information.toml', 'privacy')) + session['notes'] = [['info', text]] + return session + + + async def _handle_fotd(self, iq, session): + text = ('Here we publish featured news feeds!') + session['notes'] = [['info', text]] + return session + + + async def _handle_motd(self, iq, session): + # TODO add functionality to attach image. + text = ('Here you can add groupchat rules,post schedule, tasks or ' + 'anything elaborated you might deem fit. Good luck!') + session['notes'] = [['info', text]] + return session + + + async def _handle_totd(self, iq, session): + text = ('Tips and tricks you might have not known about Slixfeed and XMPP!') + session['notes'] = [['info', text]] + return session + + + async def _handle_credit(self, iq, session): + form = self['xep_0004'].make_form('result', 'Credits') + form['instructions'] = "We are XMPP" + form.add_field(ftype="text-multi", value=action.manual('information.toml', 'thanks')) + + # Gajim displays all form['instructions'] on top + # Psi ignore the latter form['instructions'] + # form['instructions'] = 'YOU!\nšŸ«µļø\n- Join us -' + + session['payload'] = form + return session + + + async def _handle_help(self, iq, session): + filename = 'commands.toml' + import tomllib + config_dir = config.get_default_config_directory() + with open(config_dir + '/' + filename, mode="rb") as commands: + cmds = tomllib.load(commands) + + form = self['xep_0004'].make_form('result', 'Manual') + form['instructions'] = 'šŸ›Ÿļø Help manual for interactive chat' + + # text = 'šŸ›Ÿļø Help and Information about Slixfeed\n\n' + # for cmd in cmds: + # name = cmd.capitalize() + # elements = cmds[cmd] + # text += name + '\n' + # for key, value in elements.items(): + # text += " " + key.capitalize() + '\n' + # for line in value.split("\n"): + # text += " " + line + '\n' + # form['instructions'] = text + + for cmd in cmds: + name = cmd.capitalize() + form.add_field(var='title', + ftype='fixed', + value=name) + elements = cmds[cmd] + for key, value in elements.items(): + key = key.replace('_', ' ') + key = key.capitalize() + form.add_field(var='title', + ftype='text-multi', + label=key, + value=value) + session['payload'] = form return session async def _handle_bookmarks(self, iq, session): - form = self['xep_0004'].make_form('form', 'Bookmarks') - form['instructions'] = 'šŸ“‘ļø Organize bookmarks.' - options = form.add_field(var='bookmarks', - # ftype='list-multi' - ftype='list-single', - label='Select a bookmark', - desc='Select a bookmark to edit.') - conferences = await XmppBookmark.get(self) - for conference in conferences: - options.addOption(conference['jid'], conference['jid']) - session['payload'] = form - session['next'] = self._handle_command_complete - session['has_next'] = False + jid = session['from'].bare + if jid == config.get_value('accounts', 'XMPP', 'operator'): + form = self['xep_0004'].make_form('form', 'Bookmarks') + form['instructions'] = 'šŸ“–ļø Organize bookmarks' + options = form.add_field(var='bookmarks', + ftype='list-single', + label='Select a bookmark', + desc='Select a bookmark to edit.') + conferences = await XmppBookmark.get(self) + for conference in conferences: + options.addOption(conference['name'], conference['jid']) + session['payload'] = form + session['next'] = self._handle_bookmarks_editor + session['has_next'] = True + else: + logging.warning('An unauthorized attempt to access bookmarks has ' + 'been detected!\n' + 'Details:\n' + ' Jabber ID: {}\n' + ' Timestamp: {}\n' + .format(jid, timestamp())) + session['notes'] = [['warn', 'You are not allowed to access this resource.']] return session - async def _handle_bookmarks_editor(self, iq, session): - form = self['xep_0004'].make_form('form', 'Bookmarks') - form['instructions'] = 'šŸ“ļø Edit bookmarks.' + async def _handle_bookmarks_editor(self, payload, session): + jid = payload['values']['bookmarks'] + properties = await XmppBookmark.properties(self, jid) + jid = session['from'].bare + form = self['xep_0004'].make_form('form', 'Edit bookmark') + form['instructions'] = 'šŸ“ļø Edit bookmark {}'.format(properties['name']) + jid = properties['jid'].split('@') + room = jid[0] + host = jid[1] form.addField(var='name', ftype='text-single', - label='Name') - form.addField(var='host', - ftype='text-single', - label='Host', + label='Name', + value=properties['name'], required=True) form.addField(var='room', ftype='text-single', label='Room', + value=room, + required=True) + form.addField(var='host', + ftype='text-single', + label='Host', + value=host, required=True) form.addField(var='alias', ftype='text-single', - label='Alias') + label='Alias', + value=properties['nick'], + required=True) form.addField(var='password', ftype='text-private', - label='Password') + label='Password', + value=properties['password']) + form.addField(var='language', + ftype='text-single', + label='Language', + value=properties['lang']) form.add_field(var='autojoin', ftype='boolean', label='Auto-join', - value=True) - options = form.add_field(var='action', - ftype='list-single', - label='Action', - value='join') - options.addOption('Add', 'add') - options.addOption('Join', 'join') - options.addOption('Remove', 'remove') + value=properties['autojoin']) + # options = form.add_field(var='action', + # ftype='list-single', + # label='Action', + # value='join') + # options.addOption('Add', 'add') + # options.addOption('Join', 'join') + # options.addOption('Remove', 'remove') session['payload'] = form + session['next'] = self._handle_bookmarks_complete + session['has_next'] = True + return session + + + async def _handle_bookmarks_complete(self, payload, session): + """ + Process a command result from the user. + + Arguments: + payload -- Either a single item, such as a form, or a list + of items or forms if more than one form was + provided to the user. The payload may be any + stanza, such as jabber:x:oob for out of band + data, or jabber:x:data for typical data forms. + session -- A dictionary of data relevant to the command + session. Additional, custom data may be saved + here to persist across handler callbacks. + """ + + form = self['xep_0004'].make_form('result', 'Bookmarks') + form['instructions'] = ('āœ…ļø Bookmark has been saved') + # In this case (as is typical), the payload is a form + values = payload['values'] + await XmppBookmark.add(self, properties=values) + for value in values: + key = str(value) + val = str(values[value]) + if not val: val = 'None' # '(empty)' + form.add_field(var=key, + ftype='text-single', + label=key.capitalize(), + value=val) + session['payload'] = form # Comment when this is fixed in Gajim + session["has_next"] = False session['next'] = None - session['has_next'] = False return session @@ -529,11 +1246,12 @@ class SlixfeedComponent(slixmpp.ComponentXMPP): session. Additional, custom data may be saved here to persist across handler callbacks. """ - form = self['xep_0004'].make_form('form', 'Settings') - form['instructions'] = ('šŸ“®ļø Customize news updates.') jid = session['from'].bare jid_file = jid db_file = config.get_pathname_to_database(jid_file) + form = self['xep_0004'].make_form('form', 'Settings') + form['instructions'] = ('šŸ“®ļø Customize news updates') + value = config.get_setting_value(db_file, 'enabled') value = int(value) if value: @@ -545,32 +1263,68 @@ class SlixfeedComponent(slixmpp.ComponentXMPP): label='Enable', desc='Enable news updates.', value=value) + + value = config.get_setting_value(db_file, 'media') + value = int(value) + if value: + value = True + else: + value = False + form.add_field(var='media', + ftype='boolean', + desc='Send audio, images or videos if found.', + label='Display media', + value=value) + value = config.get_setting_value(db_file, 'old') value = int(value) if value: - value = False - else: value = True + else: + value = False form.add_field(var='old', ftype='boolean', - desc='Do not mark items of newly added subscriptions ' - 'as read.', + desc='Treat all items of newly added subscriptions as new.', # label='Send only new items', label='Include old news', value=value) + value = config.get_setting_value(db_file, 'interval') - value = str(int(value/60)) + value = int(value) + value = value/60 + value = int(value) + value = str(value) options = form.add_field(var='interval', ftype='list-single', label='Interval', - desc='Set interval update (in hours).', + desc='Interval update (in hours).', value=value) - i = 60 - while i <= 2880: - var = str(i) - lab = str(int(i/60)) - options.addOption(lab, var) - i += 60 + options['validate']['datatype'] = 'xs:integer' + options['validate']['range'] = { 'minimum': 1, 'maximum': 48 } + i = 1 + while i <= 48: + x = str(i) + options.addOption(x, x) + if i >= 12: + i += 6 + else: + i += 1 + + value = config.get_setting_value(db_file, 'quantum') + value = str(value) + options = form.add_field(var='quantum', + ftype='list-single', + label='Amount', + desc='Amount of items per update.', + value=value) + options['validate']['datatype'] = 'xs:integer' + options['validate']['range'] = { 'minimum': 1, 'maximum': 5 } + i = 1 + while i <= 5: + x = str(i) + options.addOption(x, x) + i += 1 + value = config.get_setting_value(db_file, 'archive') value = str(value) options = form.add_field(var='archive', @@ -578,23 +1332,14 @@ class SlixfeedComponent(slixmpp.ComponentXMPP): label='Archive', desc='Number of news items to archive.', value=value) + options['validate']['datatype'] = 'xs:integer' + options['validate']['range'] = { 'minimum': 0, 'maximum': 500 } i = 0 while i <= 500: x = str(i) options.addOption(x, x) - i += 1 - value = config.get_setting_value(db_file, 'quantum') - value = str(value) - options = form.add_field(var='quantum', - ftype='list-single', - label='Amount', - desc='Set amount of updates per update.', - value='3') - i = 1 - while i <= 10: - x = str(i) - options.addOption(x, x) - i += 1 + i += 50 + session['payload'] = form session['next'] = self._handle_settings_complete session['has_next'] = False @@ -615,28 +1360,57 @@ class SlixfeedComponent(slixmpp.ComponentXMPP): session. Additional, custom data may be saved here to persist across handler callbacks. """ + # This looks nice in Gajim, though there are dropdown menues + # form = payload jid = session['from'].bare + form = self['xep_0004'].make_form('form', 'Settings') + form['instructions'] = ('āœ…ļø Settings have been saved') + jid_file = jid db_file = config.get_pathname_to_database(jid_file) # In this case (as is typical), the payload is a form - form = payload - values = form['values'] + values = payload['values'] for value in values: key = value val = values[value] + + if key == 'interval': + val = int(val) + if val < 1: val = 1 + val = val * 60 + if sqlite.is_setting_key(db_file, key): await sqlite.update_setting_value(db_file, [key, val]) else: await sqlite.set_setting_value(db_file, [key, val]) - match value: - case 'enabled': - pass - case 'interval': - pass - # Having no return statement is the same as unsetting the 'payload' - # and 'next' session values and returning the session. - # Unless it is the final step, always return the session dictionary. - session['payload'] = None + + val = sqlite.get_setting_value(db_file, key) + val = val[0] + if key in ('enabled', 'media', 'old'): + if val == '1': + val = 'Yes' + elif val == '0': + val = 'No' + + if key == 'interval': + val = int(val) + val = val/60 + val = int(val) + val = str(val) + + # match value: + # case 'enabled': + # pass + # case 'interval': + # pass + + result = '{}: {}'.format(key.capitalize(), val) + + form.add_field(var=key, + ftype='fixed', + value=result) + session['payload'] = form # Comment when this is fixed in Gajim + session["has_next"] = False session['next'] = None - return session + # return session