Merge branch 'main' into release

Author: b-simjoo

.travis.yml

@@ -0,0 +1,116 @@
+<p align="center">
+ <img src="Docs/logo.png">
+ <h1 align="center">Telegram RSS Bot</h1>
+ <p align="center">
+ <a href="http://de1.hashbang.sh:7191">
+  <img alt="" src="http://de1.hashbang.sh:7191/build_state">
+ </a>
+ <a href="https://github.com/bsimjoo/Telegram-RSS-Bot/labels/bug">
+  <img alt="Bug issue" src="https://img.shields.io/github/issues-raw/bsimjoo/Telegram-RSS-Bot/bug?color=red">
+ </a>
+ <a href="http://de1.hashbang.sh:7191">
+  <img alt="Reported bugs from pcworms_bot project" src="https://img.shields.io/badge/dynamic/json?url=http://de1.hashbang.sh:7191/json&label=Bugs+found&query=$.Telegram_RSS_Bot.bugs_count&color=red">
+ </a>
+ <a href="https://github.com/bsimjoo/Telegram-RSS-Bot/labels/todo">
+  <img src="https://img.shields.io/github/issues-raw/bsimjoo/Telegram-RSS-Bot/todo?color=orange&label=TODOs">
+ </a>
+ <a href="https://github.com/bsimjoo/Telegram-RSS-Bot/releases">
+  <img src="https://img.shields.io/github/v/release/bsimjoo/Telegram-RSS-Bot">
+ </a>
+ <a href="LICENSE.md">
+  <img src="https://img.shields.io/github/license/bsimjoo/Telegram-RSS-Bot">
+ </a>
+ <img src="https://img.shields.io/badge/Python-v3.8-blue">
+ <a href="https://core.telegram.org/bots/api-changelog">
+  <img src="https://img.shields.io/badge/Bot%20API-5.1-blue?logo=telegram">
+ </a>
+ </p>
+ <p align="center">
+ A simple telegram bot that started for <a href="http://pcworms.blog.ir">pcworms.blog.ir</a> weblog that read RSS Feeds and send newest feed to all chats(in this article chats = [all PVs, all GPs and all channels]).
+Administrators can also send photos, markdown or simple text messages to chats.</p>
+</p>
+
+## Owner
+The person who runs bot-server and has telegram-bot token. He usually has access to source code and Databases.
+
+*Owner can change source of feeds but default source is `http://pcworms.blog.ir/rss` read [Installation](#installation)*
+
+### How the owner is identified
+Owner (bot call him as lord!) can identify himself using the token he got from @botfather like this: `/start {bot-token}`
+
+### Owner can:
+- Generate one-time tokens and add admins. (No remove option at now)
+- Get muted notification of bot join/kick from a GP or channel.
+- Get notification of Errors and Exceptions (usefull for report to me).
+- What Others (Admins and users) can do.
+
+## Admin
+A user can promote as admin just if Owner give him a one-time token who got from bot;
+then user can use one-time token for promotion like this:
+```
+/start {token}
+```
+Then Owner Receive a message with admin information and accept/decline button.
+
+### Admins can:
+- Send photo, markdown or simple text messages to all chats
+- Send last feed to all chats
+- Get bot statistics (chats, members and admins count)
+- Get a list of all chats with username, fullname and ... (except profile photo and phone number)
+- Change the interval between each check for a new post
+
+### Users can:
+- Get last feed
+- *No more option*
+
+---
+`/help` command will give you a list of all available command related to user level.
+
+# Languages
+Available languages:
+ - en-US
+ - fa-IR
+ - [*+Add more+*](https://github.com/bsimjoo/Telegram_RSS_bot/edit/main/default-strings.json)
+You can translate [default-strings.json](default-strings.json) file to add more languages but this bot will use same language for all users, I will make it multilingual for users in future. Owner and admin interface is hardcoded in english (except `/help` command) and [strings.json](strings.json) use to comunicating with users.
+
+**Notice** Rename you custom strings file to `strings.json` to prevent git pull errors. (`strings.json` is ignored for your custom version)
+
+# Installation:
+First of all admin need to create a new bot using telegram @BotFather and keep Bot-Token safe. then Download Comprressed Source or use git clone
+```bash
+git clone https://github.com/bsimjoo/Telegram_RSS_bot.git
+```
+
+Change working directory to source directory and install requirements using this commands:
+```
+cd ./Telegram_RSS_Bot
+python3 -m pip install --user -r requirements.txt
+```
+wait until installation finish without any error. (You can report errors to me)
+
+Then configure and run the server for first use.
+```
+python3 main.py -t {bot-token-here} -s {source-here} -l {language}
+```
+The program will save the configurations for reuse in the database, so you do not need to reconfigure the server for the next run, unless you need to change them.
+
+Identify yourself as owner to bot. you can start a chat with your bot and then use this:
+```
+/start {bot-token}
+```
+
+# Reset databases
+If your about to reset database you can use `-r {database}` to reset `chats`, `config` or `all` databases.
+
+**:warning: This action can not be undone**
+
+# Bug Reporter
+I added a module that reports exceptions or any custom message and counts them, then I can show the number of bugs through a running server and then track and fix them. The bug reporter is not enabled by default, but if you are interested you can save the bugs to a local file `bug.json` by running the server with the `-b` argument, or run the bug report http server with `-b {port number}` to see them through an http server (click on the "Bugs found" badge to see an example).
+
+**Notice** Don't forget to install `cherrypy` for online bug reporter using `python3 -m pip install cherrypy`
+
+---
+Using [python-telegram-bot](https://github.com/python-telegram-bot/python-telegram-bot) api
+
+###### this is my first telegram bot!
+this project began for [pcworms.blog.ir](http://pcworms.blog.ir) weblog, but now it is available for everyone. you can see customised version at [pcworms/PCworms_Bot](https://github.com/pcworms/PCworms_Bot)

Docs/build failing.svg

@@ -1076,39 +1076,49 @@ def idle(self):
 
         if port:
             import cherrypy #user can ignore installing this mudole if now need for http reporting
-            conf = {'global':
-                {
-                    "server.socket_host": '0.0.0.0',
-                    "server.socket_port": port
-                },
-                'log.screen': False
-            }
-            import cherrypy
             class root:
-                def __init__(self, reporter):
+                def __init__(self, reporter, bug_reporter):
                     self.reporter = reporter
+                    self.bug_reporter = bug_reporter
 
                 @cherrypy.expose
                 def index(self):
                     res = '''<html style="weidth:100%"><body><h1>Bugs</h1><hr>
                     <b>what is this page?</b> this project is using a simple 
                     web server to report bugs(exceptions) that found in a running program.
-                    <h2>Bug logs</h2><pre language="json" style="weidth:100%;overflow:auto">'''+html.escape(self.reporter.dumps())+'</pre></body></html>'
+                    <h2>Bug logs</h2><pre language="json" style="weidth:100%;overflow:auto">'''+html.escape(self.bug_reporter.dumps())+'</pre></body></html>'
                     return res
 
+                @cherrypy.expose
+                def build_state(self):
+                    cherrypy.response.headers['Content-Type'] = "image/svg+xml;charset=utf-8"
+                    if self.reporter.data['bugs_count']>0:
+                        return open('Docs/build faling.svg', 'rb')
+                    else:
+                        return open('Docs/build passing.svg', 'rb')
+
                 @cherrypy.expose
                 @cherrypy.tools.json_out()
                 def json(self):
-                    return self.reporter.reports
+                    return self.bug_reporter.reports
 
+            
+            cherrypy.log.access_log.propagate = False
+            cherrypy.tree.mount(root(reporter, bug_reporter),'/')
+            conf = {'global':
+                {
+                    "server.socket_host": '0.0.0.0',
+                    "server.socket_port": port,
+                    'log.screen': False
+                }
+            }
             cherrypy.config.update(conf)
-            cherrypy.tree.mount(root(bug_reporter),'/')
             cherrypy.engine.start()
             web_reporter = True
 
             logger.info(f'reporting bugs at {port} and saving them in bugs.json')
         else:
-            logger.info(f'saving bugs in {path}')
+            logger.info(f'saving bugs in bugs.json')
 
     with env.begin(config_db, write = True) as txn:
         if '-t' in argv and len(argv) > 1: