diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c9ec333 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +__pycache__ +.cache +.mypy_cache +.pytest_cache +build +dist +*.egg-info + +*~ +.#* +*# diff --git a/.isort.cfg b/.isort.cfg new file mode 100644 index 0000000..9caba16 --- /dev/null +++ b/.isort.cfg @@ -0,0 +1,2 @@ +[isort] +profile=black diff --git a/.mypy.ini b/.mypy.ini new file mode 100644 index 0000000..976ba02 --- /dev/null +++ b/.mypy.ini @@ -0,0 +1,2 @@ +[mypy] +ignore_missing_imports = True diff --git a/CHANGELOG.rst b/CHANGELOG.rst new file mode 100644 index 0000000..5a18fcc --- /dev/null +++ b/CHANGELOG.rst @@ -0,0 +1,7 @@ +Changelog +********* + +1.0.0 +----- + +- initial release diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..14e2f77 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..7d61281 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,2 @@ +include LICENSE +include *.rst diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..039d6f9 --- /dev/null +++ b/README.rst @@ -0,0 +1,4 @@ +Feeds +===== + +A SimpleBot plugin that allows to subscribe to RSS/Atoms feeds. diff --git a/pylama.ini b/pylama.ini new file mode 100644 index 0000000..98358cd --- /dev/null +++ b/pylama.ini @@ -0,0 +1,4 @@ +[pylama] +linters=mccabe,pyflakes,pylint,isort,mypy +ignore=C0116,C0103,C0301 +skip=tests/*,build/*,simplebot_*/orm.py diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..cf461f0 --- /dev/null +++ b/setup.py @@ -0,0 +1,51 @@ +"""Setup module installation.""" + +import os +import re + +from setuptools import find_packages, setup + +if __name__ == "__main__": + MODULE_NAME = 'simplebot_feeds' + DESC = 'A plugin for SimpleBot, a Delta Chat(http://delta.chat/) bot' + + init_file = os.path.join(MODULE_NAME, '__init__.py') + with open(init_file) as fh: + version = re.search( + r'__version__ = \'(.*?)\'', fh.read(), re.M).group(1) + + with open('README.rst') as fh: + long_description = fh.read() + with open('CHANGELOG.rst') as fh: + long_description += fh.read() + with open('LICENSE') as fh: + long_description += fh.read() + + setup( + name=MODULE_NAME, + version=version, + description=DESC, + long_description=long_description, + long_description_content_type='text/x-rst', + keywords='simplebot plugin deltachat', + license='MPL', + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Environment :: Plugins', + 'Programming Language :: Python :: 3', + 'License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)', + 'Operating System :: OS Independent', + 'Topic :: Utilities', + ], + zip_safe=False, + include_package_data=True, + packages=find_packages(), + install_requires=[ + 'simplebot', + 'feedparser', + 'html2text' + ], + entry_points={ + 'simplebot.plugins': '{0} = {0}'.format(MODULE_NAME), + }, + ) diff --git a/simplebot_feeds/__init__.py b/simplebot_feeds/__init__.py new file mode 100644 index 0000000..5c083e8 --- /dev/null +++ b/simplebot_feeds/__init__.py @@ -0,0 +1,249 @@ + +import os +import sqlite3 +from threading import Thread +from time import sleep +from typing import Optional + +import feedparser +import html2text +import simplebot +from deltachat import Chat, Contact, Message +from feedparser.exceptions import CharacterEncodingOverride +from simplebot.bot import DeltaBot, Replies + +from .db import DBManager +from .util import ResultProcess + +__version__ = '1.0.0' +feedparser.USER_AGENT = 'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:60.0)' +feedparser.USER_AGENT += ' Gecko/20100101 Firefox/60.0' +html2text.config.WRAP_LINKS = False +db: DBManager +TIMEOUT = 60 + + +@simplebot.hookimpl +def deltabot_init(bot: DeltaBot) -> None: + global db + db = _get_db(bot) + + _getdefault(bot, 'delay', 60*5) + _getdefault(bot, 'max_feed_count', -1) + + +@simplebot.hookimpl +def deltabot_start(bot: DeltaBot) -> None: + Thread(target=_check_feeds, args=(bot,), daemon=True).start() + + +@simplebot.hookimpl +def deltabot_member_removed(bot: DeltaBot, chat: Chat, contact: Contact) -> None: + me = bot.self_contact + if me == contact or len(chat.get_contacts()) <= 1: + feeds = db.get_feeds(chat.id) + if feeds: + db.remove_fchat(chat.id) + for feed in feeds: + if not db.get_fchats(feed['url']): + db.remove_feed(feed['url']) + + +@simplebot.command +def feed_sub(bot: DeltaBot, payload: str, message: Message, replies: Replies) -> None: + """Subscribe current chat to the given feed. + """ + url = db.normalize_url(payload) + feed = db.get_feed(url) + + if feed: + process = ResultProcess(target=feedparser.parse, args=(feed['url'],)) + process.start() + d = process.get_result(TIMEOUT) + else: + max_fc = int(_getdefault(bot, 'max_feed_count')) + if 0 <= max_fc <= len(db.get_feeds()): + replies.add(text='Sorry, maximum number of feeds reached') + return + process = ResultProcess(target=feedparser.parse, args=(url,)) + process.start() + d = process.get_result(TIMEOUT) + bozo_exception = d.get('bozo_exception', '') + if (d.get('bozo') == 1 and not isinstance( + bozo_exception, CharacterEncodingOverride)) or not d.entries: + replies.add(text='Invalid feed url: {}'.format(url)) + bot.logger.warning('Invalid feed %s: %s', url, bozo_exception) + return + feed = dict( + url=url, + etag=d.get('etag'), + modified=d.get('modified') or d.get('updated'), + latest=get_latest_date(d.entries), + ) + db.add_feed(url, feed['etag'], feed['modified'], feed['latest']) + assert feed + + if message.chat.is_group(): + chat = message.chat + else: + chat = bot.create_group( + d.feed.get('title') or url, [message.get_sender_contact()]) + + if chat.id in db.get_fchats(feed['url']): + replies.add(text='Chat alredy subscribed to that feed.', chat=chat) + return + + db.add_fchat(chat.id, feed['url']) + title = d.feed.get('title') or '-' + desc = d.feed.get('description') or '-' + text = 'Title: {}\n\nURL: {}\n\nDescription: {}'.format( + title, feed['url'], desc) + + if d.entries and feed['latest']: + latest = tuple(map(int, feed['latest'].split())) + html = format_entries(get_old_entries(d.entries, latest)[:5]) + replies.add(text=text, html=html, chat=chat) + else: + replies.add(text=text, chat=chat) + + +@simplebot.command +def feed_unsub(payload: str, message: Message, replies: Replies) -> None: + """Unsubscribe current chat from the given feed. + """ + url = payload + feed = db.get_feed(url) + if not feed: + replies.add(text='Unknow feed: {}'.format(url)) + return + + if message.chat.id not in db.get_fchats(feed['url']): + replies.add( + text='This chat is not subscribed to: {}'.format(feed['url'])) + return + + db.remove_fchat(message.chat.id, feed['url']) + if not db.get_fchats(feed['url']): + db.remove_feed(feed['url']) + replies.add(text='Chat unsubscribed from: {}'.format(feed['url'])) + + +@simplebot.command +def feed_list(message: Message, replies: Replies) -> None: + """List feed subscriptions for the current chat. + """ + feeds = db.get_feeds(message.chat.id) + text = '\n\n'.join(f['url'] for f in feeds) + replies.add(text=text or 'No feed subscriptions in this chat') + + +def _check_feeds(bot: DeltaBot) -> None: + while True: + bot.logger.debug('Checking feeds') + for f in db.get_feeds(): + try: + _check_feed(bot, f) + except Exception as err: + bot.logger.exception(err) + sleep(int(_getdefault(bot, 'delay'))) + + +def _check_feed(bot: DeltaBot, f: sqlite3.Row) -> None: + fchats = db.get_fchats(f['url']) + + if not fchats: + db.remove_feed(f['url']) + return + + bot.logger.debug('Checking feed: %s', f['url']) + process = ResultProcess( + target=feedparser.parse, + args=(f['url'],), kwargs=dict(etag=f['etag'], modified=f['modified'])) + process.start() + d = process.get_result(TIMEOUT) + + bozo_exception = d.get('bozo_exception', '') + if d.get('bozo') == 1 and not isinstance( + bozo_exception, CharacterEncodingOverride): + bot.logger.exception(bozo_exception) + return + + if d.entries and f['latest']: + d.entries = get_new_entries( + d.entries, tuple(map(int, f['latest'].split()))) + if not d.entries: + return + + html = format_entries(d.entries[:50]) + replies = Replies(bot, logger=bot.logger) + for gid in fchats: + try: + replies.add(html=html, chat=bot.get_chat(gid)) + except (ValueError, AttributeError): + db.remove_fchat(gid) + replies.send_reply_messages() + + latest = get_latest_date(d.entries) or f['latest'] + modified = d.get('modified') or d.get('updated') + db.update_feed(f['url'], d.get('etag'), modified, latest) + + +def format_entries(entries: list) -> str: + entries_text = [] + for e in entries: + t = '<a href="{}"><h3>{}</h3></a>'.format( + e.get('link') or '', e.get('title') or 'NO TITLE') + pub_date = e.get('published') + if pub_date: + t += '<p>📆 <small><em>{}</em></small></p>'.format(pub_date) + desc = e.get('description') or '' + if not desc and e.get('content'): + for c in e.get('content'): + if c.get('type') == 'text/html': + desc += c['value'] + if desc and desc != e.get('title'): + t += desc + entries_text.append(t) + return '<br><hr>'.join(entries_text) + + +def get_new_entries(entries: list, date: tuple) -> list: + new_entries = [] + for e in entries: + d = e.get('published_parsed') or e.get('updated_parsed') + if d is not None and d > date: + new_entries.append(e) + return new_entries + + +def get_old_entries(entries: list, date: tuple) -> list: + old_entries = [] + for e in entries: + d = e.get('published_parsed') or e.get('updated_parsed') + if d is not None and d <= date: + old_entries.append(e) + return old_entries + + +def get_latest_date(entries: list) -> Optional[str]: + dates = [] + for e in entries: + d = e.get('published_parsed') or e.get('updated_parsed') + if d: + dates.append(d) + return ' '.join(map(str, max(dates))) if dates else None + + +def _getdefault(bot: DeltaBot, key: str, value=None) -> str: + val = bot.get(key, scope=__name__) + if val is None and value is not None: + bot.set(key, value, scope=__name__) + val = value + return val + + +def _get_db(bot: DeltaBot) -> DBManager: + path = os.path.join(os.path.dirname(bot.account.db_path), __name__) + if not os.path.exists(path): + os.makedirs(path) + return DBManager(os.path.join(path, 'sqlite.db')) diff --git a/simplebot_feeds/db.py b/simplebot_feeds/db.py new file mode 100644 index 0000000..baf215f --- /dev/null +++ b/simplebot_feeds/db.py @@ -0,0 +1,91 @@ +import sqlite3 +from typing import List, Optional + + +class DBManager: + def __init__(self, db_path: str) -> None: + self.db = sqlite3.connect(db_path, check_same_thread=False) + self.db.row_factory = sqlite3.Row + with self.db: + self.db.execute( + '''CREATE TABLE IF NOT EXISTS feeds + (url TEXT PRIMARY KEY, + etag TEXT, + modified TEXT, + latest TEXT)''') + self.db.execute( + '''CREATE TABLE IF NOT EXISTS fchats + (gid INTEGER, + feed TEXT REFERENCES feeds(url), + PRIMARY KEY(gid, feed))''') + + def execute(self, statement: str, args=()) -> sqlite3.Cursor: + return self.db.execute(statement, args) + + def commit(self, statement: str, args=()) -> sqlite3.Cursor: + with self.db: + return self.db.execute(statement, args) + + def close(self) -> None: + self.db.close() + + # ==== feeds ===== + + def add_feed(self, url: str, etag: str, modified: str, latest: str) -> None: + url = self.normalize_url(url) + with self.db: + self.db.execute('INSERT INTO feeds VALUES (?,?,?,?)', + (url, etag, modified, latest)) + + def remove_feed(self, url: str) -> None: + url = self.normalize_url(url) + with self.db: + self.db.execute('DELETE FROM fchats WHERE feed=?', (url,)) + self.db.execute('DELETE FROM feeds WHERE url=?', (url,)) + + def update_feed(self, url: str, etag: Optional[str], + modified: Optional[str], latest: Optional[str]) -> None: + url = self.normalize_url(url) + q = 'UPDATE feeds SET etag=?, modified=?, latest=? WHERE url=?' + self.commit(q, (etag, modified, latest, url)) + + def get_feed(self, url: str) -> Optional[sqlite3.Row]: + url = self.normalize_url(url) + return self.db.execute( + 'SELECT * FROM feeds WHERE url=?', (url,)).fetchone() + + def get_feeds(self, gid: int = None) -> List[sqlite3.Row]: + if gid is None: + return self.db.execute('SELECT * FROM feeds').fetchall() + rows = self.db.execute( + 'SELECT feed FROM fchats WHERE gid=?', (gid,)).fetchall() + if not rows: + return [] + rows = [r[0] for r in rows] + q = 'SELECT * FROM feeds WHERE ' + q += ' or '.join('url=?' for r in rows) + return self.db.execute(q, rows).fetchall() + + def add_fchat(self, gid: int, url: str) -> None: + url = self.normalize_url(url) + self.commit('INSERT INTO fchats VALUES (?,?)', (gid, url)) + + def remove_fchat(self, gid: int, url: str = None) -> None: + if url: + url = self.normalize_url(url) + self.commit( + 'DELETE FROM fchats WHERE gid=? AND feed=?', (gid, url)) + else: + self.commit('DELETE FROM fchats WHERE gid=?', (gid,)) + + def get_fchats(self, url: str) -> List[int]: + url = self.normalize_url(url) + rows = self.db.execute('SELECT gid FROM fchats WHERE feed=?', (url,)) + return [r[0] for r in rows] + + def normalize_url(self, url: str) -> str: + if not url.startswith('http'): + url = 'http://'+url + if url.endswith('/'): + url = url[:-1] + return url diff --git a/simplebot_feeds/util.py b/simplebot_feeds/util.py new file mode 100644 index 0000000..9308f99 --- /dev/null +++ b/simplebot_feeds/util.py @@ -0,0 +1,42 @@ +import queue +from multiprocessing import Event, Process, Queue + + +class AbortError(Exception): + """User canceled the operation.""" + + +class ResultProcess(Process): + """A process + internal queue to get target result in other process.""" + + def __init__(self, target, **kwargs) -> None: + self._real_target = target + self._result_queue: Queue = Queue() + self._failed = Event() + kwargs.setdefault("daemon", True) + super().__init__(target=self._wrapper, **kwargs) + + def _wrapper(self, *args, **kwargs) -> None: + try: + self._result_queue.put(self._real_target(*args, **kwargs)) + except BaseException as ex: + self._failed.set() + self._result_queue.put(ex) + + def abort(self) -> None: + """Cancel process execution.""" + self.kill() + self._failed.set() + self._result_queue.put(AbortError()) + + def get_result(self, timeout: float = None, kill: bool = True): + """Return target result.""" + try: + result = self._result_queue.get(timeout=timeout) + except queue.Empty as ex: + if kill: + self.kill() + raise TimeoutError("Operation timed out.") from ex + if self._failed.is_set(): + raise result + return result