├── .dockerignore ├── .gitattributes ├── requirements.txt ├── docs └── images │ ├── logo.png │ ├── example.png │ ├── rssfeed-jackett.png │ └── rssfeed-prowlarr.png ├── .github ├── FUNDING.yml └── workflows │ └── deploy.yml ├── renovate.json ├── docker-entrypoint.sh ├── .gitignore ├── Dockerfile ├── README.md ├── jackett2telegram.py └── LICENSE /.dockerignore: -------------------------------------------------------------------------------- 1 | .github 2 | .gitattributes 3 | LICENSE 4 | README.md 5 | docs/ -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | requests~=2.31 2 | python-telegram-bot[job-queue,rate-limiter]~=22.3 -------------------------------------------------------------------------------- /docs/images/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/danimart1991/jackett2telegram/HEAD/docs/images/logo.png -------------------------------------------------------------------------------- /docs/images/example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/danimart1991/jackett2telegram/HEAD/docs/images/example.png -------------------------------------------------------------------------------- /docs/images/rssfeed-jackett.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/danimart1991/jackett2telegram/HEAD/docs/images/rssfeed-jackett.png -------------------------------------------------------------------------------- /docs/images/rssfeed-prowlarr.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/danimart1991/jackett2telegram/HEAD/docs/images/rssfeed-prowlarr.png -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: danimart1991 4 | custom: https://www.paypal.me/danimart1991 5 | -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": [ 4 | "config:recommended" 5 | ] 6 | } 7 | -------------------------------------------------------------------------------- /docker-entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | CMD="python jackett2telegram.py --token ${TOKEN} --chat_id ${CHATID} --delay ${DELAY} --log_level ${LOG_LEVEL}" 4 | 5 | if [ -n "${MESSAGE_THREAD_ID}" ]; then 6 | CMD="${CMD} --message_thread_id ${MESSAGE_THREAD_ID}" 7 | fi 8 | 9 | exec ${CMD} -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # Installer logs 6 | pip-log.txt 7 | pip-delete-this-directory.txt 8 | 9 | # Unit test / coverage reports 10 | .tox/ 11 | .coverage 12 | .cache 13 | nosetests.xml 14 | coverage.xml 15 | 16 | # Environments 17 | .venv 18 | 19 | # IDE Configurations 20 | .vscode 21 | 22 | # Application files 23 | rss.db -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # Use an official Python runtime as a parent image 2 | FROM python:3.13-alpine 3 | 4 | # Set the working directory to /app 5 | WORKDIR /app 6 | 7 | # Copy the current directory contents into the container at /app 8 | COPY . /app 9 | 10 | # Install any needed packages specified in requirements.txt 11 | RUN pip install --trusted-host pypi.python.org -r /app/requirements.txt 12 | 13 | # Define environment variable 14 | ENV TOKEN=X 15 | ENV CHATID=X 16 | ENV MESSAGE_THREAD_ID="" 17 | ENV DELAY=600 18 | ENV LOG_LEVEL=INFO 19 | 20 | # Make entrypoint script executable 21 | RUN chmod +x /app/docker-entrypoint.sh 22 | 23 | # Run entrypoint script when container launches 24 | CMD ["/app/docker-entrypoint.sh"] 25 | -------------------------------------------------------------------------------- /.github/workflows/deploy.yml: -------------------------------------------------------------------------------- 1 | name: Publish Docker image 2 | 3 | on: 4 | release: 5 | types: [published] 6 | 7 | jobs: 8 | push_to_registry: 9 | name: Push Docker image to Docker Hub 10 | runs-on: ubuntu-latest 11 | steps: 12 | - name: Checkout Repository 13 | uses: actions/checkout@v5 14 | 15 | - name: Log in to Docker Hub 16 | uses: docker/login-action@v3 17 | with: 18 | username: ${{ github.repository_owner }} 19 | password: ${{ secrets.DOCKERHUB_TOKEN }} 20 | 21 | - name: Login to GHCR 22 | uses: docker/login-action@v3 23 | with: 24 | registry: ghcr.io 25 | username: ${{ github.repository_owner }} 26 | password: ${{ secrets.GITHUB_TOKEN }} 27 | 28 | - name: Extract metadata (tags, labels) for Docker 29 | id: meta 30 | uses: docker/metadata-action@v5 31 | with: 32 | images: | 33 | ${{ github.repository }} 34 | ghcr.io/${{ github.repository }} 35 | 36 | - name: Build and push Docker image 37 | uses: docker/build-push-action@v6 38 | with: 39 | push: true 40 | tags: ${{ steps.meta.outputs.tags }} 41 | labels: ${{ steps.meta.outputs.labels }} 42 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![Jackett RSS to Telegram Bot logo](https://github.com/danimart1991/jackett2telegram/blob/main/docs/images/logo.png?raw=true) 2 | 3 | [![GitHub release (latest by date)](https://img.shields.io/github/v/release/danimart1991/jackett2telegram)](https://github.com/danimart1991/jackett2telegram/releases) 4 | [![Build](https://img.shields.io/github/actions/workflow/status/danimart1991/jackett2telegram/deploy.yml)](https://github.com/danimart1991/jackett2telegram/actions/workflows/deploy.yml) 5 | [![License](https://img.shields.io/github/license/danimart1991/jackett2telegram)](https://github.com/danimart1991/jackett2telegram/blob/main/LICENSE) 6 | [![Docker Pulls](https://img.shields.io/docker/pulls/danimart1991/jackett2telegram)](https://hub.docker.com/r/danimart1991/jackett2telegram) 7 | 8 | [![Tip Me via PayPal](https://img.shields.io/badge/PayPal-tip%20me-blue?logo=paypal&style=flat)](https://www.paypal.me/danimart1991) 9 | [![Sponsor Me via GitHub](https://img.shields.io/badge/GitHub-sponsor%20me-blue?logo=github&style=flat)](https://github.com/sponsors/danimart1991) 10 | 11 | # Jackett (and Prowlarr) RSS to Telegram Bot 12 | 13 | A **self-hosted Telegram Python Bot** that dumps posts from **Jackett or Prowlarr RSS feeds to a Telegram** chat. 14 | 15 | Based on [**RSS to Telegram bot**](https://github.com/BoKKeR/RSS-to-Telegram-Bot) by [_BoKKeR_](https://github.com/BoKKeR) (Thanks for your effort). 16 | 17 | ![Image of the chat](https://github.com/danimart1991/jackett2telegram/blob/main/docs/images/example.png?raw=true) 18 | 19 | ## Requirements 20 | 21 | A Telegram Bot is needed that the script will connect to. 22 | 23 | You could use [this post](https://www.danielmartingonzalez.com/en/home-assistant-notifications-on-telegram/) to create your own with the [BotFather Telegram Bot](https://telegram.me/botfather). 24 | 25 | > WARNING!! Without `chat_id` the bot wont be able to send automated messages and will only be able to respond to messages. 26 | 27 | ## Docker Installation 28 | 29 | ```bash 30 | $ docker create \ 31 | --name=jackett2telegram \ 32 | -e TOKEN= \ 33 | -e CHATID= \ 34 | -v :/app/config \ 35 | -v :/app/blackhole \ 36 | --restart unless-stopped \ 37 | danimart1991/jackett2telegram 38 | ``` 39 | 40 | ## Manual Installation 41 | 42 | Python 3.X 43 | 44 | 1. Clone the script 45 | 2. Install depedencies with: 46 | 47 | ```bash 48 | pip install -r requirements.txt 49 | ``` 50 | 51 | 3. Run the script with: 52 | 53 | ```bash 54 | python jackett2telegram.py --token --chat_id 55 | ``` 56 | 57 | ## Optional Parameters 58 | 59 | The following parameters can be used in both Docker (as environment variables) and Manual installation (as command line arguments): 60 | 61 | | Docker Env | Command Line Arg | Description | Default | 62 | | ------------------- | --------------------- | ------------------------------------------------------------------------------------------------ | ------- | 63 | | `MESSAGE_THREAD_ID` | `--message_thread_id` | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | - | 64 | | `DELAY` | `--delay` | Seconds between each RSS fetching | 600 | 65 | | `LOG_LEVEL` | `--log_level` | Log level (_critical_, _error_, _warning_, _info_, _debug_) | info | 66 | 67 | > Note: `MESSAGE_THREAD_ID` is optional. If you run the Docker image you can leave the environment variable empty (for example `ENV MESSAGE_THREAD_ID=""`) and the container entrypoint will omit the `--message_thread_id` argument. Only set `MESSAGE_THREAD_ID` (or pass `--message_thread_id` when running manually) when you need to target a specific forum topic in a supergroup. 68 | 69 | ## Usage 70 | 71 | Send `/help` command to the bot to get this message: 72 | 73 | > **Jackett2Telegram (Jackett and Prowlarr RSS to Telegram Bot)** 74 | > 75 | > After successfully adding a Jackett or Prowlarr RSS link, the bot starts fetching the feed every 600 seconds. (This can be set) 76 | > 77 | > Titles are used to easily manage RSS feeds and should contain only one word and are case sensitive. 78 | > 79 | > Commands: 80 | > 81 | > - /help Posts this help message. 😑 82 | > - /add TITLE JACKETT_OR_PROWLARR_RSS_FEED_URL - Adds new Jackett or Prowlarr RSS Feed (overwrited if title previously exist). 83 | > - /remove TITLE - Removes the RSS link. 84 | > - /list Lists all the titles and the asociated Jackett or Prowlarr RSS links from the DB. 85 | > - /test JACKETT_OR_PROWLARR_RSS_FEED_URL - Inbuilt command that fetches a post (usually latest) from a Jackett or Prowlarr RSS. 86 | > 87 | > In order to use **Blackhole**, your _Torrent_ client must support it and be configured to point to **Jackett2Telegram** _Blackhole_ folder. 88 | > 89 | > If you like the project, star it on [GitHub](https://github.com/danimart1991/jackett2telegram). 90 | 91 | ### How to add a new Indexer 92 | 93 | You could get the **Jackett or Prowlarr RSS Feed Url** using the action button in Indexers list: 94 | 95 | ![Jackett RSS Feed Button](https://github.com/danimart1991/jackett2telegram/blob/main/docs/images/rssfeed-jackett.png?raw=true) 96 | 97 | You could get the **Prowlarr RSS Feed Url** using the action button in Indexers list: 98 | 99 | ![Prowlarr RSS Feed Button](https://github.com/danimart1991/jackett2telegram/blob/main/docs/images/rssfeed-prowlarr.png?raw=true) 100 | 101 | Then paste the Url in the chat like `/add TITLE JACKETT_OR_PROWLARR_RSS_FEED_URL` and send the message. The bot will reply with the result. 102 | 103 | ### How to use Blackhole 104 | 105 | **Blackhole** folder is a monitored folder that your _Torrent_ client checks to look for `.torrent` files and then download them automatically. 106 | 107 | First, you must read the documentation of the _Torrent_ client to make sure is supported and simply configure it to point to the blackhole folder created by **Jackett2Telegram**. 108 | 109 | When a new release is showed in Telegram, a Blackhole button could be pressed and download the `.torrent` file locally, then _Torrent_ client use it. 110 | 111 | > If you use the _Docker_ installation, make a bind between folders. 112 | -------------------------------------------------------------------------------- /jackett2telegram.py: -------------------------------------------------------------------------------- 1 | import inspect 2 | import logging 3 | import os 4 | import requests 5 | import sqlite3 6 | import string 7 | import unicodedata 8 | 9 | from argparse import ArgumentParser 10 | from datetime import datetime 11 | from telegram import ( 12 | Message, 13 | helpers, 14 | InlineKeyboardButton, 15 | InlineKeyboardMarkup, 16 | LinkPreviewOptions, 17 | Update, 18 | ) 19 | from telegram.ext import ( 20 | AIORateLimiter, 21 | Application, 22 | CallbackQueryHandler, 23 | CommandHandler, 24 | ContextTypes, 25 | Defaults, 26 | ) 27 | from telegram.ext.filters import MessageFilter 28 | from typing import Any 29 | from urllib import parse 30 | from xml.etree import ElementTree 31 | 32 | blackhole_path = os.path.join(os.path.abspath(os.path.dirname(__file__)), "blackhole") 33 | config_path = os.path.join(os.path.abspath(os.path.dirname(__file__)), "config") 34 | db_path = os.path.join(config_path, "rss.db") 35 | os.makedirs(blackhole_path, exist_ok=True) 36 | os.makedirs(config_path, exist_ok=True) 37 | 38 | rss_dict = {} 39 | 40 | escaped_backslash = helpers.escape_markdown("-", 2) 41 | char_limit = 255 42 | 43 | 44 | class TopicFilter(MessageFilter): 45 | def filter(self, message: Message) -> bool | None: 46 | if message_thread_id is None: 47 | return True 48 | return ( 49 | message.is_topic_message and message.message_thread_id == message_thread_id 50 | ) 51 | 52 | 53 | topic_filter = TopicFilter() 54 | 55 | 56 | # SQLITE 57 | 58 | 59 | def init_sqlite() -> None: 60 | logging.debug("Trying to create the Database") 61 | conn = sqlite3.connect(db_path) 62 | c = conn.cursor() 63 | c.execute( 64 | """CREATE TABLE IF NOT EXISTS rss (name text PRIMARY KEY, link text, last_pubdate text, last_items text, is_down integer)""" 65 | ) 66 | 67 | 68 | def sqlite_connect() -> None: 69 | global conn 70 | conn = sqlite3.connect(db_path, check_same_thread=False) 71 | 72 | 73 | def sqlite_load_all() -> list[Any]: 74 | sqlite_connect() 75 | c = conn.cursor() 76 | c.execute("SELECT * FROM rss") 77 | rows = c.fetchall() 78 | conn.close() 79 | return rows 80 | 81 | 82 | def sqlite_write( 83 | name: str, link: str, last_pubdate: str, last_items: str, is_down: int 84 | ) -> None: 85 | sqlite_connect() 86 | c = conn.cursor() 87 | values = [(name), (link), (last_pubdate), (last_items), (is_down)] 88 | c.execute( 89 | """REPLACE INTO rss (name,link,last_pubdate,last_items,is_down) VALUES(?,?,?,?,?)""", 90 | values, 91 | ) 92 | conn.commit() 93 | conn.close() 94 | 95 | 96 | # RSS 97 | 98 | 99 | def rss_load() -> None: 100 | # if the dict is not empty, empty it. 101 | if bool(rss_dict): 102 | rss_dict.clear() 103 | for row in sqlite_load_all(): 104 | rss_dict[row[0]] = (row[1], row[2], row[3], row[4]) 105 | 106 | 107 | async def cmd_rss_list(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None: 108 | if not its_me(update): 109 | return 110 | 111 | indexers = ["*List of Registered Indexers\.*"] 112 | if bool(rss_dict) is False: 113 | indexers.append("The database is empty\.") 114 | else: 115 | for rss_name, rss_props in sorted(rss_dict.items(), key=lambda item: item[0]): 116 | indexers.append( 117 | f"Title: {helpers.escape_markdown(rss_name, 2)}" 118 | + f"\nJacket RSS: `{helpers.escape_markdown(rss_props[0], 2)}`" 119 | + f"\nLast article from: {helpers.escape_markdown(rss_props[1], 2)}" 120 | + f"\nStatus: {('✔️' if rss_props[3] == 0 else '🚫' if rss_props[3] == 2 else '⚠️')}" 121 | ) 122 | 123 | await telegram_send_reply_text(update, "\n\n".join(indexers)) 124 | 125 | 126 | async def cmd_rss_add(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None: 127 | if not its_me(update): 128 | return 129 | 130 | if not context.args or len(context.args) != 2: 131 | await telegram_send_reply_error( 132 | update, 133 | "To add a new _Jackett or Prowlarr RSS_ the command needs to be:\n`/add TITLE JACKETT_OR_PROWLARR_RSS_FEED_URL`", 134 | ) 135 | return 136 | 137 | try: 138 | response = requests.get(context.args[1]) 139 | root = ElementTree.fromstring(response.content) 140 | channel = root.find("channel") 141 | items = channel.findall("item") if channel is not None else [] 142 | except ElementTree.ParseError: 143 | await telegram_send_reply_error( 144 | update, 145 | "The link does not seem to be a _Jackett or Prowlarr RSS Feed_ or is not supported\.", 146 | ) 147 | return 148 | except requests.exceptions.MissingSchema: 149 | await telegram_send_reply_error( 150 | update, "The _Jackett or Prowlarr RSS Feed Url_ is malformed\." 151 | ) 152 | return 153 | 154 | items.sort( 155 | reverse=True, key=lambda item: pubDate_to_datetime(item.findtext("pubDate", "")) 156 | ) 157 | sqlite_write( 158 | context.args[0], context.args[1], items[0].findtext("pubDate", ""), str([]), 0 159 | ) 160 | rss_load() 161 | logging.info(f"List: Indexer {context.args[0]} | {context.args[1]} added.") 162 | message = ( 163 | f"*Indexer added to list:* {helpers.escape_markdown(context.args[0], 2)}" 164 | + f"\n`{helpers.escape_markdown(context.args[1], 2)}`" 165 | ) 166 | await telegram_send_reply_text(update, message) 167 | 168 | 169 | async def cmd_rss_remove(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None: 170 | if not its_me(update): 171 | return 172 | 173 | if not context.args or len(context.args) != 1: 174 | await telegram_send_reply_error( 175 | update, 176 | "To remove a _Jackett or Prowlarr RSS_ the command needs to be:\n`/remove TITLE`", 177 | ) 178 | return 179 | 180 | sqlite_connect() 181 | c = conn.cursor() 182 | q = (context.args[0],) 183 | escaped_indexer = helpers.escape_markdown(context.args[0], 2) 184 | try: 185 | c.execute("SELECT count(*) FROM rss WHERE name = ?", q) 186 | res = c.fetchall()[0][0] 187 | if int(res) != 1: 188 | await telegram_send_reply_error( 189 | update, 190 | f"Can't remove _Jackett or Prowlarr RSS_ with title _{escaped_indexer}_\. Not found\.", 191 | ) 192 | return 193 | c.execute("DELETE FROM rss WHERE name = ?", q) 194 | conn.commit() 195 | conn.close() 196 | except sqlite3.Error: 197 | await telegram_send_reply_error( 198 | update, 199 | "Can't remove the _Jackett or Prowlarr RSS_ because of an unknown issue\.", 200 | ) 201 | return 202 | rss_load() 203 | 204 | await telegram_send_reply_text( 205 | update, f"*Indexer removed from list:* {escaped_indexer}" 206 | ) 207 | 208 | 209 | async def cmd_help(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None: 210 | if not its_me(update): 211 | return 212 | 213 | msg = ( 214 | "*Jackett2Telegram \(Jackett and Prowlarr RSS to Telegram Bot\)*" 215 | + "\n\nAfter successfully adding a Jackett or Prowlarr RSS link, the bot starts fetching the feed every " 216 | f"{str(delay)} seconds\. \(This can be set\)" 217 | + "\n\nTitles are used to easily manage RSS feeds and should contain only one word and are case sensitive\." 218 | + "\n\nCommands:" 219 | + "\n\- /help \- Posts this help message\. 😑" 220 | + "\n\- /add TITLE JACKETT\_OR\_PROWLARR\_RSS\_FEED\_URL \- Adds new Jackett or Prowlarr RSS Feed \(overwrited if title previously exist\)\." 221 | + "\n\- /remove TITLE \- Removes the RSS link\." 222 | + "\n\- /list \- Lists all the titles and the asociated Jackett or Prowlarr RSS links from the DB\." 223 | + "\n\- /test JACKETT\_OR\_PROWLARR\_RSS\_FEED\_URL \- Inbuilt command that fetches a post \(usually latest\) from a Jackett or Prowlarr RSS\." 224 | + "\n\nIn order to use *Blackhole*, your _Torrent_ client must support it and be configured to point to *Jackett2Telegram* _Blackhole_ folder\." 225 | "\n\nIf you like the project, consider [BECOME A SPONSOR](https://github.com/sponsors/danimart1991)\." 226 | ) 227 | 228 | if update.effective_message: 229 | await update.effective_message.reply_text(msg) 230 | elif context.bot: 231 | await context.bot.send_message( 232 | chat_id, msg, message_thread_id=message_thread_id 233 | ) 234 | 235 | 236 | async def rss_monitor(context: ContextTypes.DEFAULT_TYPE) -> None: 237 | for rss_name, rss_props in rss_dict.items(): 238 | try: 239 | response = requests.get(rss_props[0]) 240 | root = ElementTree.fromstring(response.content) 241 | if root.tag == "error": 242 | code = root.attrib["code"] 243 | description = root.attrib["description"] 244 | if code == "410" or code == "429": 245 | logging.info(f"Indexer {rss_name} is disabled.") 246 | sqlite_write(rss_name, rss_props[0], rss_props[1], rss_props[2], 2) 247 | else: 248 | raise Exception(f"{code}: {description}") 249 | else: 250 | channel = root.find("channel") 251 | items = channel.findall("item") if channel is not None else [] 252 | last_pubdate_datetime = pubDate_to_datetime(rss_props[1]) 253 | filteredItems = filter( 254 | lambda item: pubDate_to_datetime(item.findtext("pubDate", "")) 255 | >= last_pubdate_datetime, 256 | items, 257 | ) 258 | sortedFilteredItems = sorted( 259 | filteredItems, 260 | key=lambda item: pubDate_to_datetime(item.findtext("pubDate", "")), 261 | ) 262 | 263 | if sortedFilteredItems: 264 | last_items = eval(rss_props[2]) 265 | for item in sortedFilteredItems: 266 | item_guid = item.findtext("guid", "") 267 | if item_guid not in last_items: 268 | last_items.append(item_guid) 269 | await jackettitem_to_telegram(context, item, rss_name) 270 | 271 | itemsCount = len(items) 272 | while len(last_items) > itemsCount: 273 | last_items.pop(0) 274 | 275 | new_pubdate = sortedFilteredItems[-1].findtext("pubDate", "") 276 | sqlite_write( 277 | rss_name, rss_props[0], new_pubdate, str(last_items), 0 278 | ) 279 | except Exception as exception: 280 | # If not down yet, put down and send message. 281 | if rss_props[3] != 1: 282 | msg = f"Indexer {helpers.escape_markdown(rss_name, 2)} not available due to some issue\." 283 | await context.bot.send_message( 284 | chat_id, 285 | f"*ERROR:* {msg}", 286 | parse_mode="MARKDOWNV2", 287 | message_thread_id=message_thread_id, 288 | ) 289 | logging.exception(f"{msg}: {exception}") 290 | sqlite_write(rss_name, rss_props[0], rss_props[1], rss_props[2], 1) 291 | 292 | rss_load() 293 | 294 | 295 | async def cmd_test(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None: 296 | if not its_me(update): 297 | return 298 | 299 | if not context.args or not context.args[0]: 300 | logging.error(f"User calls command /test with invalid arguments.") 301 | await telegram_send_reply_error( 302 | update, 303 | "The format needs to be:\n`/test JACKETT\_OR\_PROWLARR\_RSS\_FEED\_URL`", 304 | ) 305 | return 306 | 307 | try: 308 | response = requests.get(context.args[0]) 309 | root = ElementTree.fromstring(response.content) 310 | channel = root.find("channel") 311 | if channel is None: 312 | return 313 | title = channel.findtext("title", default="") 314 | items = channel.findall("item") 315 | except ElementTree.ParseError: 316 | await telegram_send_reply_error( 317 | update, 318 | "The link does not seem to be a _Jackett or Prowlarr RSS Feed_ or is not supported\.", 319 | ) 320 | return 321 | except requests.exceptions.MissingSchema: 322 | await telegram_send_reply_error( 323 | update, "The _Jackett or Prowlarr RSS Feed Url_ is malformed\." 324 | ) 325 | return 326 | 327 | items.sort( 328 | reverse=True, key=lambda item: pubDate_to_datetime(item.findtext("pubDate", "")) 329 | ) 330 | await jackettitem_to_telegram(context, items[0], title) 331 | 332 | 333 | async def jackettitem_to_telegram( 334 | context: ContextTypes.DEFAULT_TYPE, item: ElementTree.Element, rssName: str 335 | ) -> None: 336 | coverurl = None 337 | title = helpers.escape_markdown( 338 | item.findtext("title", default=escaped_backslash), 2 339 | ) 340 | category = ( 341 | parse_category(item.findtext("category", "")) 342 | if item.findall("category") 343 | else -1 344 | ) 345 | icons = [parse_categoryIcon(category)] 346 | trackerName = helpers.escape_markdown(rssName, 2) 347 | externalLinks = [] 348 | seeders = escaped_backslash 349 | peers = escaped_backslash 350 | grabs = item.findtext("grabs", default=escaped_backslash) 351 | files = item.findtext("files", default=escaped_backslash) 352 | uploadvolumefactor = "" 353 | downloadvolumefactor = "" 354 | downloadUrl = "" 355 | magnetUrl = "" 356 | 357 | size = helpers.escape_markdown( 358 | str(round(float(item.findtext("size", default=0)) / 1073741824, 2)) + "GiB", 2 359 | ) 360 | 361 | guid = item.findtext("guid", default=None) 362 | link = item.findtext("link", default=None) 363 | if guid and guid.startswith("magnet:"): 364 | magnetUrl = helpers.escape_markdown(guid, 2) 365 | elif not magnetUrl and link and link.startswith("magnet:"): 366 | magnetUrl = helpers.escape_markdown(link, 2) 367 | if link and not link.startswith("magnet:"): 368 | downloadUrl = link 369 | 370 | keyboard = [[]] 371 | if item.findall("comments"): 372 | keyboard[0].append( 373 | InlineKeyboardButton("🔗", url=item.findtext("comments", default=None)) 374 | ) 375 | if downloadUrl: 376 | if magnetUrl: 377 | keyboard[0].append(InlineKeyboardButton("🧲", url=downloadUrl)) 378 | else: 379 | keyboard[0].append(InlineKeyboardButton("💾", url=downloadUrl)) 380 | keyboard[0].append(InlineKeyboardButton("🕳", callback_data="blackhole")) 381 | reply_markup = InlineKeyboardMarkup(keyboard) 382 | ns = {"torznab": "http://torznab.com/schemas/2015/feed"} 383 | 384 | for torznabattr in item.findall("torznab:attr", ns): 385 | torznabattr_name = torznabattr.get("name") 386 | if torznabattr_name == "downloadvolumefactor": 387 | downloadvolumefactor = parse_downloadvolumefactor( 388 | float(torznabattr.get("value", 0)) 389 | ) 390 | if downloadvolumefactor: 391 | icons.append(downloadvolumefactor[:1]) 392 | elif torznabattr_name == "uploadvolumefactor": 393 | uploadvolumefactor = parse_uploadvolumefactor( 394 | float(torznabattr.get("value", 0)) 395 | ) 396 | if uploadvolumefactor: 397 | icons.append(uploadvolumefactor[:1]) 398 | elif torznabattr_name == "seeders": 399 | seeders = torznabattr.get("value") 400 | elif torznabattr_name == "peers": 401 | peers = torznabattr.get("value") 402 | elif torznabattr_name == "coverurl": 403 | coverurl = torznabattr.get("value") 404 | elif torznabattr_name == "imdbid": 405 | externalLinks.append( 406 | f"[*IMDb*](https://www.imdb.com/title/{torznabattr.get('value')})" 407 | ) 408 | elif torznabattr_name == "tmdbid": 409 | type = None 410 | if category == 2: 411 | type = "movie" 412 | elif category == 5: 413 | type = "tv" 414 | if type: 415 | externalLinks.append( 416 | f"[*TMDb*](https://www.themoviedb.org/{type}/{torznabattr.get('value')})" 417 | ) 418 | elif torznabattr_name == "magneturl" and not magnetUrl: 419 | magnetUrl = torznabattr.get("value") 420 | 421 | externalLinks = ("\n📌 " + "\|".join(externalLinks)) if externalLinks else "" 422 | message = ( 423 | f"{helpers.escape_markdown('|'.join(icons),2)} \- {title} by _{trackerName}_" 424 | + f"{externalLinks}" 425 | + f"\n\n📤 {seeders} 📥 {peers} 💾 {grabs} 🗜 {size} 🗃 {files}" 426 | + f"\n\n{downloadvolumefactor}{uploadvolumefactor}\n\n`{magnetUrl}`" 427 | ) 428 | 429 | if coverurl: 430 | try: 431 | coverraw = requests.get(coverurl, stream=True).raw 432 | await context.bot.send_photo( 433 | chat_id, 434 | photo=coverraw, 435 | caption=message, 436 | reply_markup=reply_markup, 437 | message_thread_id=message_thread_id, 438 | ) 439 | return 440 | # Error, most of the times is a Image 400 Bad Request, without reason. 441 | except: 442 | logging.warning( 443 | "Error sending release with cover. Trying to send without cover." 444 | ) 445 | 446 | await context.bot.send_message( 447 | chat_id, message, reply_markup=reply_markup, message_thread_id=message_thread_id 448 | ) 449 | 450 | 451 | async def cbq_to_blackhole(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None: 452 | if not its_me(update): 453 | return 454 | 455 | if ( 456 | not (message := update.effective_message) 457 | or not (reply_markup := message.reply_markup) 458 | or not (query := update.callback_query) 459 | ): 460 | await telegram_send_error(context, "The message cannot be found\.") 461 | return 462 | 463 | await query.answer() 464 | 465 | inline_keyboard_zero = list(reply_markup.inline_keyboard[0]) 466 | inline_keyboard_zero.pop() 467 | inline_keyboard_zero.append(InlineKeyboardButton("⏳", callback_data=query.data)) 468 | 469 | await context.bot.edit_message_reply_markup( 470 | chat_id=message.chat_id, 471 | message_id=message.message_id, 472 | reply_markup=InlineKeyboardMarkup([inline_keyboard_zero]), 473 | ) 474 | 475 | msg = None 476 | torrent_url = reply_markup.inline_keyboard[0][1].url 477 | if torrent_url: 478 | torrent_file = parse.parse_qs(parse.urlparse(torrent_url).query)["file"][0] 479 | if torrent_file: 480 | torrent_file = clean_filename(torrent_file + ".torrent") 481 | try: 482 | torrent_data = requests.get(torrent_url) 483 | if torrent_data and torrent_data.content: 484 | button_msg = "✔️" 485 | with open(os.path.join(blackhole_path, torrent_file), "wb") as file: 486 | file.write(torrent_data.content) 487 | else: 488 | msg = "Can't obtain `.Torrent` file data\." 489 | except Exception as exception: 490 | if exception.args[0] and "magnet:?" in exception.args[0]: 491 | msg = "It seems that the torrent is a magnet file, it can't be added using blackhole, please use another option\." 492 | else: 493 | logging.exception(exception) 494 | msg = "Can't obtain `.Torrent` file data\." 495 | else: 496 | msg = "Can't obtain `.Torrent` file name\." 497 | else: 498 | msg = "Can't obtain `.Torrent` Url to download\." 499 | 500 | if msg: 501 | button_msg = "❌" 502 | await telegram_send_reply_error(update, msg) 503 | 504 | inline_keyboard_zero.pop() 505 | inline_keyboard_zero.append( 506 | InlineKeyboardButton(button_msg, callback_data=query.data) 507 | ) 508 | 509 | await context.bot.edit_message_reply_markup( 510 | chat_id=message.chat_id, 511 | message_id=message.message_id, 512 | reply_markup=InlineKeyboardMarkup([inline_keyboard_zero]), 513 | ) 514 | 515 | 516 | async def post_init(application: Application) -> None: 517 | msg = ( 518 | "*Jackett2Telegram has started\.*" 519 | + f"\nRSS Indexers: {str(len(rss_dict))}" 520 | + f"\nDelay: {str(delay)} seconds" 521 | + f"\nLog Level: {log_level}" 522 | ) 523 | clean_msg = msg.replace("\n", " ") 524 | logging.info(f"{inspect.stack()[1][3]} - {clean_msg}") 525 | await application.bot.send_message( 526 | chat_id, msg, message_thread_id=message_thread_id 527 | ) 528 | 529 | 530 | # Telegram 531 | 532 | 533 | async def telegram_send_message(context: ContextTypes.DEFAULT_TYPE, msg: str) -> None: 534 | clean_msg = msg.replace("\n", " ") 535 | logging.info(f"{inspect.stack()[1][3]} - {clean_msg}") 536 | if bot := context.bot: 537 | await bot.send_message( 538 | chat_id, f"*ERROR:* {msg}", message_thread_id=message_thread_id 539 | ) 540 | 541 | 542 | async def telegram_send_error(context: ContextTypes.DEFAULT_TYPE, msg: str) -> None: 543 | clean_msg = msg.replace("\n", " ") 544 | logging.error(f"{inspect.stack()[1][3]} - {clean_msg}") 545 | if bot := context.bot: 546 | await bot.send_message( 547 | chat_id, f"*ERROR:* {msg}", message_thread_id=message_thread_id 548 | ) 549 | 550 | 551 | async def telegram_send_reply_text(update: Update, msg: str) -> None: 552 | clean_msg = msg.replace("\n", " ") 553 | logging.info(f"{inspect.stack()[1][3]} - {clean_msg}") 554 | if message := update.effective_message: 555 | await message.reply_text(msg) 556 | 557 | 558 | async def telegram_send_reply_error(update: Update, msg: str) -> None: 559 | clean_msg = msg.replace("\n", " ") 560 | logging.error(f"{inspect.stack()[1][3]} - {clean_msg}") 561 | if message := update.effective_message: 562 | await message.reply_text(f"*ERROR:* {msg}") 563 | 564 | 565 | async def topic_only_command(update: Update, context: ContextTypes.DEFAULT_TYPE): 566 | # Check if the message is in the desired topic 567 | desired_topic_id = 123456 # Replace with your topic's ID 568 | if update.message.message_thread_id == desired_topic_id: 569 | await update.message.reply_text("This command works in this topic!") 570 | else: 571 | await update.message.reply_text("This command is not allowed in this topic.") 572 | 573 | 574 | async def error_handler(update: object, context: ContextTypes.DEFAULT_TYPE) -> None: 575 | logging.error("Exception while handling an update:", exc_info=context.error) 576 | 577 | 578 | def its_me(update: Update) -> bool: 579 | return str(update.effective_chat.id) == chat_id if update.effective_chat else False 580 | 581 | 582 | # Utils 583 | 584 | 585 | def clean_filename(filename: str) -> str: 586 | # replace spaces by underscores 587 | cleaned_filename = filename.replace(" ", "_") 588 | 589 | # keep only valid ascii chars 590 | cleaned_filename = ( 591 | unicodedata.normalize("NFKD", cleaned_filename) 592 | .encode("ASCII", "ignore") 593 | .decode() 594 | ) 595 | 596 | # keep only whitelisted chars 597 | whitelist = "-_.() %s%s" % (string.ascii_letters, string.digits) 598 | cleaned_filename = "".join(c for c in cleaned_filename if c in whitelist) 599 | if len(cleaned_filename) > char_limit: 600 | logging.warning( 601 | f"Filename truncated because it was over {char_limit}. Filenames may no longer be unique." 602 | ) 603 | return cleaned_filename[:char_limit] 604 | 605 | 606 | def pubDate_to_datetime(pubDate: str) -> datetime: 607 | return datetime.strptime(pubDate, "%a, %d %b %Y %H:%M:%S %z") 608 | 609 | 610 | def parse_downloadvolumefactor(value: float) -> str: 611 | if value == 0: 612 | return "🔥 FREELEECH 🔥\n" 613 | elif value == 0.5: 614 | return "🌟 50% DOWNLOAD 🌟\n" 615 | return "" 616 | 617 | 618 | def parse_uploadvolumefactor(value: float) -> str: 619 | if value > 1: 620 | return f"💎 {str(int(value*100))}% UPLOAD 💎" 621 | return "" 622 | 623 | 624 | def parse_category(category: str) -> int: 625 | try: 626 | value = int(category) // 1000 627 | except ValueError: 628 | value = -1 629 | logging.exception(f"Category: {category} is not an Integer") 630 | return value 631 | 632 | 633 | def parse_categoryIcon(category: int) -> str: 634 | if category == 1: 635 | return "🎮" 636 | elif category == 2: 637 | return "🎬" 638 | elif category == 3: 639 | return "🎵" 640 | elif category == 4: 641 | return "💾" 642 | elif category == 5: 643 | return "📺" 644 | elif category == 6: 645 | return "🔶" 646 | elif category == 7: 647 | return "📕" 648 | elif category == 8: 649 | return "❓" 650 | return "" 651 | 652 | 653 | # Main 654 | 655 | 656 | def main() -> None: 657 | parser = ArgumentParser() 658 | parser.add_argument( 659 | "--token", 660 | dest="token", 661 | type=str, 662 | help="Telegram Bot's unique authentication token.", 663 | required=True, 664 | ) 665 | parser.add_argument( 666 | "--chat_id", 667 | dest="chat_id", 668 | type=str, 669 | help="Unique identifier for the target chat or username of the target channel (in the format @channelusername); for supergroups, use the unique identifier.", 670 | required=True, 671 | ) 672 | parser.add_argument( 673 | "--message_thread_id", 674 | dest="message_thread_id", 675 | type=int, 676 | help="Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.", 677 | default=None, 678 | ) 679 | parser.add_argument( 680 | "--delay", 681 | dest="delay", 682 | type=int, 683 | help="Seconds between each RSS fetching", 684 | default=600, 685 | ) 686 | parser.add_argument( 687 | "--log_level", 688 | dest="log_level", 689 | help="Set the level of console logs", 690 | choices=["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"], 691 | default=logging.getLevelName(logging.INFO), 692 | ) 693 | args = parser.parse_args() 694 | 695 | global chat_id 696 | global message_thread_id 697 | global delay 698 | global log_level 699 | 700 | chat_id = args.chat_id 701 | message_thread_id = args.message_thread_id 702 | delay = args.delay 703 | log_level = args.log_level 704 | 705 | logging.basicConfig( 706 | format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=log_level 707 | ) 708 | 709 | defaults = Defaults( 710 | link_preview_options=LinkPreviewOptions(is_disabled=True), 711 | do_quote=True, 712 | parse_mode="MARKDOWNV2", 713 | ) 714 | application = ( 715 | Application.builder() 716 | .token(args.token) 717 | .concurrent_updates(True) 718 | .defaults(defaults) 719 | .rate_limiter(rate_limiter=AIORateLimiter()) 720 | .post_init(post_init) 721 | .build() 722 | ) 723 | 724 | application.add_handler(CommandHandler("add", cmd_rss_add, filters=topic_filter)) 725 | application.add_handler(CommandHandler("help", cmd_help, filters=topic_filter)) 726 | application.add_handler(CommandHandler("test", cmd_test, filters=topic_filter)) 727 | application.add_handler(CommandHandler("list", cmd_rss_list, filters=topic_filter)) 728 | application.add_handler( 729 | CommandHandler("remove", cmd_rss_remove, filters=topic_filter) 730 | ) 731 | application.add_handler(CallbackQueryHandler(cbq_to_blackhole)) 732 | 733 | # Try to create a database if missing 734 | try: 735 | init_sqlite() 736 | except sqlite3.OperationalError: 737 | logging.exception("Fail trying to create the Database.") 738 | 739 | rss_load() 740 | 741 | if job_queue := application.job_queue: 742 | job_queue.run_repeating(rss_monitor, delay) 743 | 744 | application.add_error_handler(error_handler) 745 | 746 | application.run_polling() 747 | conn.close() 748 | 749 | 750 | if __name__ == "__main__": 751 | main() 752 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------