diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..5708a63 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "pip" # See documentation for possible values + directory: "/requirements" # Location of package manifests + schedule: + interval: "monthly" diff --git a/.github/workflows/python-ci.yml b/.github/workflows/python-ci.yml new file mode 100644 index 0000000..dbd7e21 --- /dev/null +++ b/.github/workflows/python-ci.yml @@ -0,0 +1,63 @@ +name: CI + +on: + push: + branches: [ master ] + tags: + - 'v*.*.*' + pull_request: + branches: [ master ] + +jobs: + test: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ['3.7', '3.10'] + steps: + - uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + python -m pip install '.[dev]' + - name: Check code with black + run: | + black --check . + - name: Lint code + run: | + pylama + - name: Test with pytest + run: | + pytest + + deploy: + needs: test + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + with: + python-version: '3.x' + - id: check-tag + run: | + if [[ "${{ github.event.ref }}" =~ ^refs/tags/v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then + echo ::set-output name=match::true + fi + - name: Create PyPI release + uses: casperdcl/deploy-pypi@v2 + with: + password: ${{ secrets.PYPI_TOKEN }} + build: true + # only upload if a tag is pushed (otherwise just build & check) + upload: ${{ github.event_name == 'push' && steps.check-tag.outputs.match == 'true' }} + - name: Create GitHub release + if: ${{ github.event_name == 'push' && steps.check-tag.outputs.match == 'true' }} + uses: Roang-zero1/github-create-release-action@master + with: + version_regex: ^v[[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+ + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0cabcb4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +__pycache__ +.cache +.mypy_cache +.pytest_cache +build +dist +.eggs +*.egg-info +*/_version.py + +*~ +.#* +*# diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..186f2c8 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,6 @@ +# Changelog + +## v0.1.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..dda9b86 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,3 @@ +include LICENSE +include README.rst +include CHANGELOG.md \ No newline at end of file diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..afda2c9 --- /dev/null +++ b/README.rst @@ -0,0 +1,59 @@ +Telegram Channels Bridge +======================== + +.. image:: https://img.shields.io/pypi/v/simplebot_tgchan.svg + :target: https://pypi.org/project/simplebot_tgchan + +.. image:: https://img.shields.io/pypi/pyversions/simplebot_tgchan.svg + :target: https://pypi.org/project/simplebot_tgchan + +.. image:: https://pepy.tech/badge/simplebot_tgchan + :target: https://pepy.tech/project/simplebot_tgchan + +.. image:: https://img.shields.io/pypi/l/simplebot_tgchan.svg + :target: https://pypi.org/project/simplebot_tgchan + +.. image:: https://github.com/simplebot-org/simplebot_tgchan/actions/workflows/python-ci.yml/badge.svg + :target: https://github.com/simplebot-org/simplebot_tgchan/actions/workflows/python-ci.yml + +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black + +A `SimpleBot`_ plugin that allows to subscribe to Telegram channels from Delta Chat. + +Install +------- + +To install run:: + + pip install simplebot-tgchan + +Configure +--------- + +See https://github.com/simplebot-org/simplebot to know how to configure the bot with an e-mail account. + +Before you start using the bot, you need to get your own API ID and hash, go to https://my.telegram.org/ +and get them then configure the bot:: + + simplebot -a bot@example.com db -s simplebot_tgchan/api_id "12345" + simplebot -a bot@example.com db -s simplebot_tgchan/api_hash "0123456789abcdef0123456789abcdef" + +Add your e-mail address as the bot administrator so you have access to the administration commands:: + + simplebot -a bot@example.com admin -a me@example.com + +Then you must provide a Telegram account for the bot to use, to start session in Telegram:: + + simplebot -a bot@example.com login + +After entering phone number and the verification code you received in Telegram or via SMS, start the +bot:: + + simplebot -a bot@example.com serve + +Then you can start subscribing to Telegram channels with ``/sub`` command writting to the bot address +in Delta Chat. + + +.. _SimpleBot: https://github.com/simplebot-org/simplebot diff --git a/pylama.ini b/pylama.ini new file mode 100644 index 0000000..5207e9a --- /dev/null +++ b/pylama.ini @@ -0,0 +1,4 @@ +[pylama] +linters=pyflakes,pylint,isort,mypy +ignore=C0116,C0103,C0301,C0115,R0912,R0914,W0703 +skip=.*,tests/*,build/*,simplebot_*/orm.py,simplebot_*/_version.py diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..201885d --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,16 @@ +[build-system] +requires = [ + "setuptools>=45", + "setuptools-scm>=6.2", + "wheel", +] +build-backend = "setuptools.build_meta" + +[tool.setuptools_scm] +write_to = "simplebot_tgchan/_version.py" + +[tool.isort] +profile = "black" + +[tool.mypy] +ignore_missing_imports = "True" diff --git a/requirements/requirements-dev.txt b/requirements/requirements-dev.txt new file mode 100644 index 0000000..def20df --- /dev/null +++ b/requirements/requirements-dev.txt @@ -0,0 +1,7 @@ +-r requirements.txt +-r requirements-test.txt +black==22.6.0 +mypy==0.971 +isort==5.10.1 +pylint==2.14.5 +pylama==8.3.8 diff --git a/requirements/requirements-test.txt b/requirements/requirements-test.txt new file mode 100644 index 0000000..9b2511d --- /dev/null +++ b/requirements/requirements-test.txt @@ -0,0 +1,2 @@ +pytest==7.1.2 + diff --git a/requirements/requirements.txt b/requirements/requirements.txt new file mode 100644 index 0000000..5cee7ee --- /dev/null +++ b/requirements/requirements.txt @@ -0,0 +1,11 @@ +simplebot>=4.0.0 +SQLAlchemy>=1.4.39 +Telethon>=1.25.4 +# to speed up encryption +cryptg>=0.3.1 +# resize large images when sending photos +Pillow>=9.2.0 +# to download WebDocument media files +aiohttp>=3.8.3 +# to extract metadata from files when sending documents +hachoir>=3.1.3 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..b53b240 --- /dev/null +++ b/setup.py @@ -0,0 +1,67 @@ +"""Setup module installation.""" + +import os + +from setuptools import find_packages, setup + + +def load_requirements(path: str) -> list: + """Load requirements from the given relative path.""" + with open(path, encoding="utf-8") as file: + requirements = [] + for line in file.read().split("\n"): + if line.startswith("-r"): + dirname = os.path.dirname(path) + filename = line.split(maxsplit=1)[1] + requirements.extend(load_requirements(os.path.join(dirname, filename))) + elif line and not line.startswith("#"): + requirements.append(line) + return requirements + + +if __name__ == "__main__": + MODULE_NAME = "simplebot_tgchan" + DESC = "Subscribe to Telegram channels in DeltaChat." + KEYWORDS = "simplebot plugin deltachat telegram bridge" + URL = f"https://github.com/simplebot-org/{MODULE_NAME}" + + with open("README.rst", encoding="utf-8") as fh: + long_description = fh.read() + + setup( + name=MODULE_NAME, + setup_requires=["setuptools_scm"], + use_scm_version={ + "root": ".", + "relative_to": __file__, + "tag_regex": r"^(?Pv)?(?P[^\+]+)(?P.*)?$", + "git_describe_command": "git describe --dirty --tags --long --match v*.*.*", + }, + description=DESC, + long_description=long_description, + long_description_content_type="text/x-rst", + author="adbenitez", + author_email="adbenitez@nauta.cu", + url=URL, + keywords=KEYWORDS, + license="MPL", + classifiers=[ + "Development Status :: 4 - Beta", + "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=load_requirements("requirements/requirements.txt"), + extras_require={ + "test": load_requirements("requirements/requirements-test.txt"), + "dev": load_requirements("requirements/requirements-dev.txt"), + }, + entry_points={ + "simplebot.plugins": f"{MODULE_NAME} = {MODULE_NAME}", + }, + ) diff --git a/simplebot_tgchan/__init__.py b/simplebot_tgchan/__init__.py new file mode 100644 index 0000000..efedfa0 --- /dev/null +++ b/simplebot_tgchan/__init__.py @@ -0,0 +1,190 @@ +"""hooks, filters and commands definitions.""" + +import asyncio +import os +from tempfile import TemporaryDirectory +from threading import Thread + +import simplebot +from deltachat import Chat, Contact, Message +from simplebot import DeltaBot +from simplebot.bot import Replies +from telethon import events +from telethon.tl.functions.channels import JoinChannelRequest +from telethon.tl.functions.messages import ImportChatInviteRequest + +from .orm import Subscription, init, session_scope +from .subcommands import login +from .util import get_client, getdefault, set_config, sync + + +@simplebot.hookimpl +def deltabot_init_parser(parser) -> None: + parser.add_subcommand(login) + + +@simplebot.hookimpl +def deltabot_init(bot: DeltaBot) -> None: + getdefault(bot, "api_id", "") + getdefault(bot, "api_hash", "") + getdefault(bot, "delay", str(60 * 5)) + + +@simplebot.hookimpl +def deltabot_start(bot: DeltaBot) -> None: + path = os.path.join(os.path.dirname(bot.account.db_path), __name__) + if not os.path.exists(path): + os.makedirs(path) + path = os.path.join(path, "sqlite.db") + init(f"sqlite:///{path}") + Thread(target=listen_to_telegram, args=(bot,), daemon=True).start() + + +@simplebot.hookimpl +def deltabot_member_removed( + bot: DeltaBot, chat: Chat, contact: Contact, replies: Replies +) -> None: + if bot.self_contact != contact and len(chat.get_contacts()) > 1: + return + + with session_scope() as session: + session.query(Subscription).filter_by(chat_id=chat.id).delete() + + +@simplebot.command(admin=True) +def sub(bot: DeltaBot, payload: str, message: Message, replies: Replies) -> None: + """Subscribe chat to the given Telegram channel.""" + _sub(bot, payload, message, replies) + + +@sync +async def _sub(bot: DeltaBot, payload: str, message: Message, replies: Replies) -> None: + if not getdefault(bot, "session"): + replies.add(text="❌ You must log in first", quote=message) + return + + if not message.chat.is_multiuser(): + replies.add( + text="❌ Subscribing is supported in group chats only", quote=message + ) + return + + args = payload.split(maxsplit=1) + chan = args[0].rsplit("/", maxsplit=1)[-1] + if "/joinchat/" in args[0]: + request = ImportChatInviteRequest + else: + request = JoinChannelRequest + chan = chan.strip("@").replace(" ", "_") + filter_ = args[1] if len(args) == 2 else "" + + try: + client = get_client(bot) + await client.connect() + await client(request(chan)) + with session_scope() as session: + session.add( + Subscription(chat_id=message.chat.id, chan=chan, filter=filter_) + ) + replies.add(text=f"✔️ Subscribed to {chan}") + except Exception as ex: + bot.logger.exception(ex) + replies.add(text=f"❌ Error: {ex}", quote=message) + finally: + await client.disconnect() + + +@simplebot.command(admin=True) +def unsub(bot: DeltaBot, payload: str, message: Message, replies: Replies) -> None: + """Unsubscribe chat from the given Telegram channel.""" + _unsub(bot, payload, message, replies) + + +@sync +async def _unsub( + bot: DeltaBot, payload: str, message: Message, replies: Replies +) -> None: + with session_scope() as session: + if payload: + subs = ( + session.query(Subscription) + .filter_by(chat_id=message.chat.id, chan=payload) + .first() + ) + if subs: + session.delete(subs) + replies.add(text=f"✔️ Unsubscribed from {payload}") + else: + replies.add(text=f"❌ Error: chat is not subscribed to {payload}") + else: + text = "" + for subs in session.query(Subscription).filter_by(chat_id=message.chat.id): + text += f"/unsub_{subs.chan}\n\n" + if not text: + text = "❌ No subscriptions in this chat" + replies.add(text=text) + + +@sync +async def listen_to_telegram(bot: DeltaBot) -> None: + if not getdefault(bot, "session"): + bot.logger.warning("Telegram session not configured") + return + + while True: + bot.logger.debug("Checking Telegram") + try: + client = get_client(bot) + await client.connect() + dialogs = await client.get_dialogs() + for dialog in reversed(dialogs): + if ( + dialog.unread_count <= 0 + or not dialog.is_channel + or dialog.is_group + or not dialog.entity.username + ): + continue + messages = list( + reversed( + await client.get_messages(dialog, limit=dialog.unread_count) + ) + ) + if not messages: + continue + bot.logger.debug( + f"Channel {dialog.name!r} has {len(messages)} new messages" + ) + with session_scope() as session: + replies = Replies(bot, bot.logger) + for msg in messages: + if msg.text is None: + continue + args = dict( + text=msg.text, + sender=dialog.title or dialog.name or "Unknown", + ) + with TemporaryDirectory() as tempdir: + if msg.file and msg.file.size < 1024**2 * 5: + args["filename"] = await msg.download_media(tempdir) + if not msg.text and not args.get("filename"): + continue + for subs in session.query(Subscription).filter_by( + chan=dialog.entity.username + ): + if subs.filter in msg.text: + try: + replies.add( + **args, chat=bot.get_chat(int(subs.chat_id)) + ) + replies.send_reply_messages() + except Exception as ex: + bot.logger.exception(ex) + await client.send_read_acknowledge(dialog, messages) + except Exception as ex: + bot.logger.exception(ex) + finally: + await client.disconnect() + delay = int(getdefault(bot, "delay")) + bot.logger.debug(f"Done checking Telegram, sleeping for {delay} seconds...") + await asyncio.sleep(delay) diff --git a/simplebot_tgchan/orm.py b/simplebot_tgchan/orm.py new file mode 100644 index 0000000..ee0422e --- /dev/null +++ b/simplebot_tgchan/orm.py @@ -0,0 +1,45 @@ +from contextlib import contextmanager +from threading import Lock + +from sqlalchemy import Column, ForeignKey, Integer, String, create_engine +from sqlalchemy.ext.declarative import declarative_base, declared_attr +from sqlalchemy.orm import relationship, sessionmaker + + +class Base: + @declared_attr + def __tablename__(cls): + return cls.__name__.lower() + + +Base = declarative_base(cls=Base) +_Session = sessionmaker() +_lock = Lock() + + +class Subscription(Base): + chat_id = Column(Integer, primary_key=True) + chan = Column(String(1000), primary_key=True) + filter = Column(String(1000)) + + +@contextmanager +def session_scope(): + """Provide a transactional scope around a series of operations.""" + with _lock: + session = _Session() + try: + yield session + session.commit() + except: + session.rollback() + raise + finally: + session.close() + + +def init(path: str, debug: bool = False) -> None: + """Initialize engine.""" + engine = create_engine(path, echo=debug) + Base.metadata.create_all(engine) + _Session.configure(bind=engine) diff --git a/simplebot_tgchan/subcommands.py b/simplebot_tgchan/subcommands.py new file mode 100644 index 0000000..110598f --- /dev/null +++ b/simplebot_tgchan/subcommands.py @@ -0,0 +1,40 @@ +from simplebot import DeltaBot + +from .util import get_client, set_config, sync + + +class login: + """Login on Telegram.""" + + def add_arguments(self, parser) -> None: + parser.add_argument("--session", help="set a saved session") + + def run(self, bot: DeltaBot, args, out) -> None: + if args.session: + set_config(bot, "session", args.session) + out.line("Session set") + else: + self._login(bot, out) + + @staticmethod + @sync + async def _login(bot: DeltaBot, out) -> None: + phone = input("Please enter your phone: ").replace(" ", "") + if "+" not in phone: + out.fail("Phone number must include country code, example: +5312345678") + try: + client = get_client(bot) + await client.connect() + phone_code_hash = (await client.send_code_request(phone)).phone_code_hash + out.line("You should receive a code from Telegram") + code = input("Please enter the code you received: ") + await client.sign_in(phone, code, phone_code_hash=phone_code_hash) + session = client.session.save() + set_config(bot, "session", session) + out.line("You have logged in successfully. Your session is:") + out.line(session) + except Exception as ex: + bot.logger.exception(ex) + out.fail(str(ex)) + finally: + await client.disconnect() diff --git a/simplebot_tgchan/util.py b/simplebot_tgchan/util.py new file mode 100644 index 0000000..8c472b2 --- /dev/null +++ b/simplebot_tgchan/util.py @@ -0,0 +1,38 @@ +import asyncio +from functools import wraps + +from simplebot import DeltaBot +from telethon import TelegramClient +from telethon.sessions import StringSession + + +def sync(func): + @wraps(func) + def wrapper(*args, **kwargs): + asyncio.new_event_loop().run_until_complete(func(*args, **kwargs)) + + return wrapper + + +def getdefault(bot: DeltaBot, key: str, value: str = None) -> str: + scope = __name__.split(".")[0] + val = bot.get(key, scope=scope) + if val is None and value is not None: + bot.set(key, value, scope=scope) + val = value + return val + + +def set_config(bot: DeltaBot, key: str, value: str = None) -> None: + bot.set(key, value, scope=__name__.split(".")[0]) + + +def get_client(bot: DeltaBot) -> TelegramClient: + api_id = getdefault(bot, "api_id") + api_hash = getdefault(bot, "api_hash") + session = getdefault(bot, "session") + return TelegramClient( + StringSession(session) if session else StringSession(), + api_id=api_id, + api_hash=api_hash, + ) diff --git a/tests/test_plugin.py b/tests/test_plugin.py new file mode 100644 index 0000000..471de48 --- /dev/null +++ b/tests/test_plugin.py @@ -0,0 +1,10 @@ +class TestPlugin: + """Offline tests""" + + def test_login(self, mocker) -> None: + msg = mocker.get_one_reply("/login") + assert "❌" in msg.text + + def test_sub(self, mocker) -> None: + msg = mocker.get_one_reply("/sub test") + assert "❌" in msg.text