sch/Slixfeed
sch/Slixfeed
3
1
Fork 1
Code Issues 15 Pull requests Projects Releases Packages Wiki Activity Actions

Fix keys by setting lower case.

Browse source 
Consolidate commands into options.
Various of fixes and improvements.
This commit is contained in:
Schimon Jehudah 2024-02-22 14:09:13 +00:00
parent 74192965d1
commit 6e2a7305c2
8 changed files with 876 additions and 575 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
slixfeed/action.py
View file

@ -269,7 +269,12 @@ def manual(filename, section=None, command=None):
config_dir = config.get_default_config_directory()
with open(config_dir + '/' + filename, mode="rb") as commands:
cmds = tomllib.load(commands)
if command and section:
if section == 'all':
cmd_list = ''
for cmd in cmds:
for i in cmds[cmd]:
cmd_list += cmds[cmd][i] + '\n'
elif command and section:
try:
cmd_list = cmds[section][command]
except KeyError as e:
@ -290,60 +295,6 @@ def manual(filename, section=None, command=None):
return cmd_list
async def xmpp_change_interval(self, key, val, jid, jid_file, message=None):
if val:
# response = (
# 'Updates will be sent every {} minutes.'
# ).format(response)
db_file = config.get_pathname_to_database(jid_file)
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])
# NOTE Perhaps this should be replaced
# by functions clean and start
await task.refresh_task(self, jid, task.task_send, key, val)
response = ('Updates will be sent every {} minutes.'
.format(val))
else:
response = 'Missing value.'
if message:
XmppMessage.send_reply(self, message, response)
async def xmpp_start_updates(self, message, jid, jid_file):
key = 'enabled'
val = 1
db_file = config.get_pathname_to_database(jid_file)
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])
status_type = 'available'
status_message = '📫️ Welcome back!'
XmppPresence.send(self, jid, status_message, status_type=status_type)
message_body = 'Updates are enabled.'
XmppMessage.send_reply(self, message, message_body)
await asyncio.sleep(5)
await task.start_tasks_xmpp(self, jid, ['check', 'status', 'interval'])
async def xmpp_stop_updates(self, message, jid, jid_file):
key = 'enabled'
val = 0
db_file = config.get_pathname_to_database(jid_file)
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])
task.clean_tasks_xmpp(self, jid, ['interval', 'status'])
message_body = 'Updates are disabled.'
XmppMessage.send_reply(self, message, message_body)
status_type = 'xa'
status_message = '📪️ Send "Start" to receive Jabber updates'
XmppPresence.send(self, jid, status_message, status_type=status_type)
def log_to_markdown(timestamp, filename, jid, message):
"""
Log message to file.

4
slixfeed/assets/commands.toml
View file

@ -100,6 +100,10 @@ Leave groupchat and delete it from bookmarks.
"""
[manual]
all = """
help all
Print a complete list of commands.
"""
help = """
help
Print list of command types.

268
slixfeed/assets/information.toml
View file

@ -1,6 +1,7 @@
about = """
about = [
"""
Slixfeed is a news broker bot for syndicated news which aims to be \
an easy to use and fully-featured news aggregator bot.
an easy to use and fully-featured news aggregating bot.
Slixfeed provides a convenient access to Blogs, News websites and \
even Fediverse instances, along with filtering and other privacy \
@ -11,19 +12,23 @@ Slixfeed is designed primarily for the XMPP communication network \
https://gitgud.io/sjehuda/slixfeed
"""
]
authors = """
Laura Lapina
Co-Author, Instructor and Mentor.
Schimon Zackary
Author.
authors = [
"Laura Lapina ",
"(Co-Author, Instructor and Mentor), ",
"Schimon Zackary ",
"(Author)."
]
filetypes = [
"""
filetypes = """
Supported filetypes: Atom, JSON, RDF, RSS and XML.
"""
]
license = """
license = [
"""
Copyright 2022 - 2024 Schimon Zackary Jehudah
Permission is hereby granted, free of charge, to any person obtaining \
@ -45,37 +50,63 @@ OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, \
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER \
DEALINGS IN THE SOFTWARE.
"""
]
note = """
note = [
"""
You can run Slixfeed as a client, from your own computer, server, \
and even from a Linux phone (i.e. Droidian, Kupfer, Mobian, NixOS, \
postmarketOS), and even from Termux.
All you need is one of the above and an XMPP account to connect \
Slixfeed to. Good luck!
"""
]
operators = """
operators = [
"""
No operator was specified for this instance.
"""
]
platforms = """
platforms = [
"""
Supported platforms: XMPP
Platforms to be added in future: ActivityPub, Briar, Email, IRC, LXMF, \
Matrix, MQTT, Nostr, Session, Tox.
For ideal experience, we recommend using XMPP.
"""
]
privacy = """
privacy = [
"""
All your data belongs to us.
"""
]
protocols = """
protocols = [
"""
Supported protocols: HTTP
Protocols to be added in future: Dat, FTP, Gemini, Gopher, IPFS.
"""
]
# Supported protocols: Dat, FTP, Gemini, Gopher, HTTP and IPFS.
resources = """
rtf = [
"""
The RSS Task Force is an international organization headquartered in Switzerland.
It was originally formed to maintain, serve and improve data flow to and from \
small and medium enterprises, namely rural farms and long distance taxi drivers.
Thanks to a joint effort of several taxi and travel companies, in 2021 we have \
expanded our cause towards all entities of all types and sorts.
The RSS Task Force was founded in 2018.
"""
]
resources = [
"""
Slixfeed
https://gitgud.io/sjehuda/slixfeed
@ -88,16 +119,65 @@ https://pythonhosted.org/feedparser
XMPP
https://xmpp.org/about/
"""
]
sleekxmpp = """
services = [
"""
Feed Creator
Feed Creator is a service that creates feeds from HTML pages. \
It generates RSS and JSON feeds from a set of links or other HTML elements.
https://www.fivefilters.org/feed-creator/
Kill the Newsletter
Kill the Newsletter converts email newsletters into Web feeds.
https://kill-the-newsletter.com/
Open RSS
Open RSS is a nonprofit organization that provides free RSS feeds for \
websites and applications that don't already provide them, so RSS feeds \
can continue to be a reliable way for people to stay up-to-date with \
content anywhere on the internet.
https://openrss.org/
RSS-Bridge
RSS-Bridge is free and open source software for generating Atom or RSS \
feeds from websites which don’t have one. It is written in PHP and intended \
to run on a Web server.
https://rss-bridge.org/bridge01/
RSSHub
RSSHub is an open source, easy to use, and extensible RSS feed generator. \
It's capable of generating RSS feeds from pretty much everything.
https://docs.rsshub.app/
"""
]
sleekxmpp = [
"""
SleekXMPP is an MIT licensed XMPP library for Python 2.6/3.1+, and is featured \
in examples in the book XMPP: The Definitive Guide by Kevin Smith, Remko Tronçon, \
and Peter Saint-Andre.
https://codeberg.org/fritzy/SleekXMPP
"""
]
slixmpp = """
slixmpp = [
"""
Slixmpp is an MIT licensed XMPP library for Python 3.7+. It is a fork of SleekXMPP.
Slixmpp's goals is to only rewrite the core of the SleekXMPP library \
@ -106,12 +186,82 @@ in order to remove all threads.
https://codeberg.org/poezio/slixmpp
"""
]
support = """
software = [
"""
CommaFeed
A self-hosted RSS reader, based on Dropwizard and React/TypeScript.
https://commafeed.com/
FreshRSS
FreshRSS is a self-hosted RSS and Atom feed aggregator.
It is lightweight, easy to work with, powerful, and customizable.
https://freshrss.org/
Liferea
Liferea is a feed reader/news aggregator that brings together \
all of the content from your favorite subscriptions into a simple \
interface that makes it easy to organize and browse feeds. Its \
GUI is similar to a desktop mail/news client, with an embedded \
web browser.
https://lzone.de/liferea/
NetNewsWire
NetNewsWire shows you articles from your favorite blogs and news \
sites and keeps track of what you’ve read.
This means you can stop going from page to page in your browser \
looking for new articles to read. Do it the easy way instead: let \
NetNewsWire bring you the news.
And, if you’ve been getting your news via the commercial Social \
Networks — with their ads, algorithms, user tracking, outrage, and \
misinformation — you can switch to NetNewsWire to get news directly \
and more reliably from the sites you trust.
https://netnewswire.com/
Spot-On
Spot-On is a software carnival which brings chat, email, news, \
newsgroups, search and other forms of communications into a single \
communications orchestra.
https://textbrowser.github.io/spot-on/
Vienna RSS
Vienna is an RSS/Atom reader for macOS, packed with powerful \
features that help you make sense of the flood of information \
that is distributed via these formats today.
https://vienna-rss.com/
"""
]
support = [
"""
xmpp:slixfeed@chat.woodpeckersnest.space?join
"""
]
terms = """
terms = [
"""
Slixfeed is free software; you can redistribute it and/or \
modify it under the terms of the MIT License.
@ -122,48 +272,51 @@ MIT License for more details.
https://gitgud.io/sjehuda/slixfeed
"""
]
thanks = [
"Alixander Court <alixandercourt.com> (Utah)",
"Chriss Farrell (SalixOS, Oregon)",
"Christian Dersch (SalixOS)",
"Cyrille Pontvieux <enialis.net> (SalixOS, France)",
"Denis Fomin (Gajim, Russia)",
"Dimitris Tzemos (SalixOS, Greece)",
"Emmanuel Gil Peyrot (Poezio, France)",
"Florent Le Coz (Poezio, France)",
"George Vlahavas <vlahavas.com> (SalixOS, Greece)",
"Guus der Kinderen <igniterealtime.org> (Openfire, Netherlands)",
"habnabit_ from #python on irc.libera.chat",
"Imar van Erven Dorens <simplicit.nl> (SalixOS, Netherlands)",
"imattau (atomtopubsub)",
"Jaussoin Timothée <mov.im> (Movim, France)",
"Justin Karneges <jblog.andbit.net> (Psi, California)",
"Kevin Smith <isode.com> (Swift IM, Wales)",
"Lars Windolf (Liferea, Germany)",
"Luis Henrique Mello (SalixOS, Brazil)",
"magicfelix",
"Markus Muttilainen (SalixOS)",
"Martin <debacle@debian.org> (Debian, Germany)",
"Mathieu Pasquet (slixmpp, France)",
"Maxime Buquet (slixmpp, France)",
"mirux (Germany)",
"Phillip Watkins (SalixOS, United Kingdom)",
"Pierrick Le Brun (SalixOS, France)",
"Raphael Groner (Fedora, Germany)",
"Remko Tronçon <mko.re> (Psi , Belgium)",
"Simone \"roughnecks\" Canaletti <woodpeckersnest.space> (Italy)",
"Richard Lapointe (SalixOS, Connecticut)",
"Stephen Paul Weber <singpolyma.net>",
"Strix from Loqi",
"Thibaud Guerin (SalixOS)",
"Thorsten Fröhlich (France)",
"Thorsten Mühlfelder (SalixOS, Germany)",
"Tim Beech (SalixOS, Brazil)",
"Alixander Court &lt;alixandercourt.com&gt; (Utah), ",
"Arne-Brün Vogelsang &lt;monocles.de&gt; (monocles, Germany), ",
"Chriss Farrell (SalixOS, Oregon), ",
"Christian Dersch (SalixOS), ",
"Cyrille Pontvieux &lt;enialis.net&gt; (SalixOS, France), ",
"Denis Fomin (Gajim, Russia), ",
"Dimitris Tzemos (SalixOS, Greece), ",
"Emmanuel Gil Peyrot (Poezio, France), ",
"Florent Le Coz (Poezio, France), ",
"George Vlahavas &lt;vlahavas.com&gt; (SalixOS, Greece), ",
"Guus der Kinderen &lt;igniterealtime.org&gt; (Openfire, Netherlands), ",
"habnabit_ from #python on irc.libera.chat, ",
"Imar van Erven Dorens &lt;simplicit.nl&gt; (SalixOS, Netherlands), ",
"imattau (atomtopubsub), ",
"Jaussoin Timothée &lt;mov.im&gt; (Movim, France), ",
"Justin Karneges &lt;jblog.andbit.net&gt; (Psi, California), ",
"Kevin Smith &lt;isode.com&gt; (Swift IM, Wales), ",
"Lars Windolf (Liferea, Germany), ",
"Luis Henrique Mello (SalixOS, Brazil), ",
"magicfelix, ",
"Markus Muttilainen (SalixOS), ",
"Martin &lt;debacle@debian.org&gt; (Debian, Germany), ",
"Mathieu Pasquet (slixmpp, France), ",
"Maxime Buquet (slixmpp, France), ",
"mirux (Germany), ",
"Phillip Watkins (SalixOS, United Kingdom), ",
"Pierrick Le Brun (SalixOS, France), ",
"Raphael Groner (Fedora, Germany), ",
"Remko Tronçon &lt;mko.re&gt; (Psi , Belgium), ",
"Simone &quot;roughnecks&quot; Canaletti &lt;woodpeckersnest.space&gt; (Italy), ",
"Richard Lapointe (SalixOS, Connecticut), ",
"Stephen Paul Weber &lt;singpolyma.net&gt;, ",
"Strix from Loqi, ",
"Thibaud Guerin (SalixOS), ",
"Thorsten Fröhlich (France), ",
"Thorsten Mühlfelder (SalixOS, Germany), ",
"Tim Beech (SalixOS, Brazil), ",
"Yann Leboulanger (Gajim, France)"
]
xmpp = """
xmpp = [
"""
XMPP is the Extensible Messaging and Presence Protocol, a set \
of open technologies for instant messaging, presence, multi-party \
chat, voice and video calls, collaboration, lightweight \
@ -172,3 +325,4 @@ data.
https://xmpp.org/about/
"""
]

9
slixfeed/config.py
View file

@ -34,6 +34,15 @@ import sys
import tomli_w
import tomllib
async def set_setting_value(db_file, key, val):
key = key.lower()
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])
def get_setting_value(db_file, key):
value = sqlite.get_setting_value(db_file, key)
if value:

30
slixfeed/sqlite.py
View file

@ -743,6 +743,36 @@ async def get_unread_entries(db_file, num):
return results
def get_feed_id_by_entry_index(db_file, ix):
"""
Get feed id by entry index.
Parameters
----------
db_file : str
Path to database file.
ix : str
Index.
Returns
-------
feed_id : str
Feed index.
"""
with create_connection(db_file) as conn:
cur = conn.cursor()
sql = (
"""
SELECT feed_id
FROM entries
WHERE id = :ix
"""
)
par = (ix,)
feed_id = cur.execute(sql, par).fetchone()
return feed_id
async def get_feed_id(db_file, url):
"""
Get index of given feed.

4
slixfeed/version.py
View file

@ -1,2 +1,2 @@
__version__ = '0.1.13'
__version_info__ = (0, 1, 13)
__version__ = '0.1.14'
__version_info__ = (0, 1, 14)

970
slixfeed/xmpp/client.py
View file

File diff suppressed because it is too large Load diff

105
slixfeed/xmpp/process.py
View file

@ -23,6 +23,7 @@ TODO
"""
import asyncio
import logging
import os
import slixfeed.action as action
@ -205,6 +206,13 @@ async def message(self, message):
.format(command_list))
print(response)
XmppMessage.send_reply(self, message, response)
case 'help all':
command_list = action.manual('commands.toml', section='all')
response = ('Complete list of commands:\n'
'```\n{}\n```'
.format(command_list))
print(response)
XmppMessage.send_reply(self, message, response)
case _ if message_lowercase.startswith('help'):
command = message_text[5:].lower()
command = command.split(' ')
@ -236,7 +244,7 @@ async def message(self, message):
'or command key & name')
XmppMessage.send_reply(self, message, response)
case 'info':
command_list = ' '.join(action.manual('information.toml'))
command_list = action.manual('information.toml')
response = ('Available command options:\n'
'```\n{}\n```\n'
'Usage: `info <option>`'
@ -375,14 +383,7 @@ async def message(self, message):
response = 'Value may not be greater than 500.'
else:
db_file = config.get_pathname_to_database(jid_file)
if sqlite.is_setting_key(db_file, key):
print('update archive')
await sqlite.update_setting_value(db_file,
[key, val])
else:
print('set archive')
await sqlite.set_setting_value(db_file,
[key, val])
await config.set_setting_value(db_file, key, val)
response = ('Maximum archived items has '
'been set to {}.'
.format(val))
@ -608,16 +609,24 @@ async def message(self, message):
case _ if message_lowercase.startswith('interval'):
key = message_text[:8]
val = message_text[9:]
try:
val = int(val)
await action.xmpp_change_interval(self, key, val, jid,
jid_file,
message=message)
except:
response = ('No action has been taken.'
'\n'
'Enter a numeric value only.')
XmppMessage.send_reply(self, message, response)
if val:
try:
val = int(val)
db_file = config.get_pathname_to_database(jid_file)
await config.set_setting_value(db_file, key, val)
# NOTE Perhaps this should be replaced by functions
# clean and start
await task.refresh_task(self, jid, task.task_send, key,
val)
response = ('Updates will be sent every {} minutes.'
.format(val))
except:
response = ('No action has been taken.'
'\n'
'Enter a numeric value only.')
else:
response = 'Missing value.'
XmppMessage.send_reply(self, message, response)
case _ if message_lowercase.startswith('join'):
muc_jid = uri.check_xmpp_uri(message_text[5:])
if muc_jid:
@ -638,12 +647,7 @@ async def message(self, message):
try:
val = int(val)
db_file = config.get_pathname_to_database(jid_file)
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])
await config.set_setting_value(db_file, key, val)
if val == 0: # if not val:
response = 'Summary length limit is disabled.'
else:
@ -687,30 +691,21 @@ async def message(self, message):
db_file = config.get_pathname_to_database(jid_file)
key = 'media'
val = 0
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])
await config.set_setting_value(db_file, key, val)
response = 'Media is disabled.'
XmppMessage.send_reply(self, message, response)
case 'media on':
db_file = config.get_pathname_to_database(jid_file)
key = 'media'
val = 1
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])
await config.set_setting_value(db_file, key, val)
response = 'Media is enabled.'
XmppMessage.send_reply(self, message, response)
case 'new':
db_file = config.get_pathname_to_database(jid_file)
key = 'old'
val = 0
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])
await config.set_setting_value(db_file, key, val)
response = 'Only new items of newly added feeds be delivered.'
XmppMessage.send_reply(self, message, response)
# TODO Will you add support for number of messages?
@ -730,10 +725,7 @@ async def message(self, message):
db_file = config.get_pathname_to_database(jid_file)
key = 'old'
val = 1
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])
await config.set_setting_value(db_file, key, val)
response = 'All items of newly added feeds be delivered.'
XmppMessage.send_reply(self, message, response)
case _ if message_lowercase.startswith('quantum'):
@ -746,12 +738,7 @@ async def message(self, message):
# 'Every update will contain {} news items.'
# ).format(response)
db_file = config.get_pathname_to_database(jid_file)
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])
await config.set_setting_value(db_file, key, val)
response = ('Next update will contain {} news items.'
.format(val))
except:
@ -940,7 +927,17 @@ async def message(self, message):
'Missing search query.')
XmppMessage.send_reply(self, message, response)
case 'start':
await action.xmpp_start_updates(self, message, jid, jid_file)
key = 'enabled'
val = 1
db_file = config.get_pathname_to_database(jid_file)
await config.set_setting_value(db_file, key, val)
status_type = 'available'
status_message = '📫️ Welcome back!'
XmppPresence.send(self, jid, status_message, status_type=status_type)
await asyncio.sleep(5)
await task.start_tasks_xmpp(self, jid, ['check', 'status', 'interval'])
response = 'Updates are enabled.'
XmppMessage.send_reply(self, message, response)
case 'stats':
db_file = config.get_pathname_to_database(jid_file)
response = await action.list_statistics(db_file)
@ -1014,7 +1011,17 @@ async def message(self, message):
'No news source with index {}.'.format(ix))
XmppMessage.send_reply(self, message, response)
case 'stop':
await action.xmpp_stop_updates(self, message, jid, jid_file)
key = 'enabled'
val = 0
db_file = config.get_pathname_to_database(jid_file)
await config.set_setting_value(db_file, key, val)
task.clean_tasks_xmpp(self, jid, ['interval', 'status'])
status_type = 'xa'
status_message = '📪️ Send "Start" to receive Jabber updates'
XmppPresence.send(self, jid, status_message,
status_type=status_type)
response = 'Updates are disabled.'
XmppMessage.send_reply(self, message, response)
case 'support':
# TODO Send an invitation.
response = 'Join xmpp:slixfeed@chat.woodpeckersnest.space?join'