Potato

.gitignore

@@ -88,4 +88,6 @@ ENV/
 # Rope project settings
 .ropeproject
 .idea/
-config.py
+config.py
+
+.vscode

README.md

@@ -1,2 +1,60 @@
 # MasterBot
 CW Master Castle Bot
+
+# Trello taskboard:
+[ТЫЦ](https://trello.com/b/mIKI2omk/%D1%81%D1%83%D0%BC%D1%80%D0%B0%D0%BA%D0%BE%D0%B1%D0%BE%D1%82)
+
+### installation into venv (recommended):
+```
+virtualenv -p python3 .env #make sure you creating python3 venv
+source .env/bin/activate
+python3 -m pip install -r requirements.txt
+```
+
+### mysql database setup (only mysql is supported):
+
+1)Install recent mysql-server distribution
+e.g. for GNU/Linux:
+```
+sudo apt-get install mysql-server
+```
+2)create a root user (if it was not created during installation process)
+```
+sudo mysqladmin -u root password 'mynewpassword'
+```
+3)login to mysql as root:
+```
+sudo mysql -u root -h localhost -p
+```
+4)create a new user:
+```
+CREATE USER 'myuser'@'localhost' IDENTIFIED BY 'mypass';
+```
+5)grant privileges to the new user:
+```
+GRANT ALL PRIVILEGES ON * . * TO 'myuser'@'localhost';
+exit
+```
+6)log in to your new user similarly to step (3).
+
+7)create a new database
+```
+CREATE DATABASE 'test';
+ALTER DATABASE 'test' CHARACTER SET = utf8mb4 COLLATE = utf8mb4_unicode_ci;
+```
+8)exit to CLI
+```
+exit
+```
+9)open the file 'config.py.sample', enter your new database user's credentials, database name and your telegram bot API token
+
+10)You have to install python3-tk (if not yet installed) to properly run matplotlib requirement.
+```
+sudo apt-get install python3-tk
+```
+
+11)launch the bot:
+```
+python3 main.py
+```
+the mysql database schema will be created automatically by a built-in script.

config.py.sample

@@ -0,0 +1,12 @@
+# Содержимое этого файла необходимо скопировать в config.py и изменить под себя
+
+TOKEN = '<SOME_TOKEN>' # Токен телеграмбота (получается у @BotFather)
+DB = 'mysql+pymysql://<username>:<password>@<host>/<dbname>?charset=utf8mb4' # Строчка подключения к базе данных (поддерживается только MySql, о формате можно прочитать тут http://docs.sqlalchemy.org/en/latest/dialects/mysql.html)
+API_PORT = 88 # Порт, по которому будет доступен внешний апи бота (REST)
+GOVERNMENT_CHAT = -1001149271906 # Чат, в который бот будет слать отчёты
+SUPER_ADMIN_ID = 0 # id супер админа
+# вербовочный функционал:
+CASTLE_CHAT_ID = None # id замкового чата (для поиска новых игроков в замке - если None - функционал отключен)
+ACADEM_CHAT_ID = None # id чата академии (для уведомления о новых игроках в замке - если None - функционал отключен)
+CASTLE = None # Флаг замка, который вы хотите обслуживать (например '🇮🇲'), оставьте None, чтобы не было ограничений
+WEB_LINK = 'Please change it. {}'

core/__init__.py

@@ -1 +1 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8 -*-

core/chat_commands.py

@@ -0,0 +1,29 @@
+CC_SET_WELCOME = 'welcome:'
+CC_HELP = 'help'
+CC_SQUAD = 'squad'
+CC_SHOW_WELCOME = 'show welcome message'
+CC_TURN_ON_WELCOME = 'turn on welcome message'
+CC_TURN_OFF_WELCOME = 'turn off welcome message'
+CC_SET_TRIGGER = 'trigger:'
+CC_UNSET_TRIGGER = 'untrigger:'
+CC_TRIGGER_LIST = 'trigger list'
+CC_ADMIN_LIST = 'admin list'
+CC_PING = 'ping'
+CC_DAY_STATISTICS = 'daily stats'
+CC_WEEK_STATISTICS = 'weekly stats'
+CC_BATTLE_STATISTICS = 'battle stats'
+CC_ALLOW_TRIGGER_ALL = 'allow everyone to trigger'
+CC_DISALLOW_TRIGGER_ALL = 'prevent everyone from triggering'
+CC_ADMINS = ['admins', 'commander']
+CC_ALLOW_PIN_ALL = 'allow everyone to pin'
+CC_DISALLOW_PIN_ALL = 'prevent everyone from pinning'
+CC_BOSS_1 = ['бандит', 'краб']
+CC_BOSS_2 = ['жало', 'королева роя']
+CC_BOSS_3 = ['циклоп', 'борода']
+CC_BOSS_4 = ['гидра', 'лич']
+CC_OPEN_HIRING = 'open admissions'
+CC_CLOSE_HIRING = 'close admissions'
+CC_PIN = 'pin and notify'
+CC_SILENT_PIN = 'pin'
+CC_DELETE = 'delete'
+CC_KICK = 'kick'

core/commands.py

@@ -0,0 +1,28 @@
+ADMIN_COMMAND_ORDER = '⚔Orders'
+ADMIN_COMMAND_STATUS = '🔎Status'
+ADMIN_COMMAND_GROUPS = '👥Groups'
+ADMIN_COMMAND_RECRUIT = '📬Squad Requests'
+ADMIN_COMMAND_FIRE_UP = '⛏Harvest'
+ADMIN_COMMAND_SQUAD_LIST = '🗂Squad List'
+ADMIN_COMMAND_ADMINPANEL = '🥔Admin Panel🥔'
+ADMIN_COMMAND_REPORTS = '📜Reports'
+
+USER_COMMAND_ME = '🏅Hero'
+USER_COMMAND_TOP = '🌟Top'
+USER_COMMAND_SQUAD = '⚜Squad'
+USER_COMMAND_STATISTICS = '📊Statistics'
+USER_COMMAND_BUILD = '🚧Coming Soon'
+USER_COMMAND_CONTACTS = '💬Chat'
+USER_COMMAND_SQUAD_REQUEST = '⚜Join Squad'
+USER_COMMAND_SQUAD_LEAVE = '☄Leave Squad'
+
+USER_COMMAND_BACK = '🔙Go Back'
+
+TOP_COMMAND_ATTACK = '⚔'
+TOP_COMMAND_DEFENCE = '🛡'
+TOP_COMMAND_EXP = '🔥'
+TOP_COMMAND_BUILD = '👷🏻'
+
+TOP_COMMAND_BATTLES = '⛳️'
+
+STATISTICS_COMMAND_EXP = '🔥XP'

core/constants.py

@@ -0,0 +1,3 @@
+MINIMUM_SQUAD_MEMBER_LEVEL = 5
+DAYS_PROFILE_REMIND = 5
+DAYS_OLD_PROFILE_KICK = 14

core/enums.py

@@ -4,26 +4,26 @@
 
 class Castle(Enum):
     UNDEFINED = 0
-    BLACK = '\U0001f1ec\U0001f1f5'
-    RED = '\U0001f1ee\U0001f1f2'
-    BLUE = '\U0001f1ea\U0001f1fa'
-    YELLOW = '\U0001f1fb\U0001f1e6'
-    WHITE = '\U0001f1e8\U0001f1fe'
-    MINT = '\U0001F1F2\U0001F1F4'
-    DUSK = '\U0001F1F0\U0001F1EE'
+    BLACK = '🌑'
+    RED = '🐺'
+    BLUE = '🥔'
+    YELLOW = '🦅'
+    WHITE = '🦌'
+    MINT = '🐉'
+    DUSK = '🦈'
     LES = '\U0001f332Лесной форт'
     GORY = '\u26f0Горный форт'
     SEA = '\u2693\uFE0FМорской форт'
 
 
 class Icons(Enum):
-    BLACK = '\U0001f1ec\U0001f1f5'
-    RED = '\U0001f1ee\U0001f1f2'
-    BLUE = '\U0001f1ea\U0001f1fa'
-    YELLOW = '\U0001f1fb\U0001f1e6'
-    WHITE = '\U0001f1e8\U0001f1fe'
-    MINT = '\U0001F1F2\U0001F1F4'
-    DUSK = '\U0001F1F0\U0001F1EE'
+    BLACK = '🌑'
+    RED = '🐺'
+    BLUE = '🥔'
+    YELLOW = '🦅'
+    WHITE = '🦌'
+    MINT = '🐉'
+    DUSK = '🦈'
     LES = '\U0001f332'
     GORY = '\u26f0'
     SEA = '\u2693\uFE0F'

core/functions/activity.py

@@ -1,8 +1,10 @@
+from datetime import datetime, timedelta
+
 from telegram import Update, Bot
-from core.types import AdminType, admin, Session, Squad
+
+from core.texts import MSG_ORDER_STATISTIC, MSG_ORDER_STATISTIC_OUT_FORMAT
+from core.types import AdminType, admin_allowed, Squad
 from core.utils import send_async
-from datetime import datetime, timedelta
-from core.texts import *
 
 
 def activity(squad, days=0, hours=0):
@@ -25,37 +27,25 @@ def activity(squad, days=0, hours=0):
     return msg
 
 
-@admin(adm_type=AdminType.GROUP)
-def day_activity(bot: Bot, update: Update):
-    session = Session()
-    try:
-        squad = session.query(Squad).filter_by(chat_id=update.message.chat.id).first()
-        if squad is not None:
-            msg = activity(squad, days=1)
-            send_async(bot, chat_id=update.message.chat.id, text=msg)
-    except:
-        session.rollback()
-
-
-@admin(adm_type=AdminType.GROUP)
-def week_activity(bot: Bot, update: Update):
-    session = Session()
-    try:
-        squad = session.query(Squad).filter_by(chat_id=update.message.chat.id).first()
-        if squad is not None:
-            msg = activity(squad, days=7)
-            send_async(bot, chat_id=update.message.chat.id, text=msg)
-    except:
-        session.rollback()
-
-
-@admin(adm_type=AdminType.GROUP)
-def battle_activity(bot: Bot, update: Update):
-    session = Session()
-    try:
-        squad = session.query(Squad).filter_by(chat_id=update.message.chat.id).first()
-        if squad is not None:
-            msg = activity(squad, hours=4)
-            send_async(bot, chat_id=update.message.chat.id, text=msg)
-    except:
-        session.rollback()
+@admin_allowed(adm_type=AdminType.GROUP)
+def day_activity(bot: Bot, update: Update, session):
+    squad = session.query(Squad).filter_by(chat_id=update.message.chat.id).first()
+    if squad is not None:
+        msg = activity(squad, days=1)
+        send_async(bot, chat_id=update.message.chat.id, text=msg)
+
+
+@admin_allowed(adm_type=AdminType.GROUP)
+def week_activity(bot: Bot, update: Update, session):
+    squad = session.query(Squad).filter_by(chat_id=update.message.chat.id).first()
+    if squad is not None:
+        msg = activity(squad, days=7)
+        send_async(bot, chat_id=update.message.chat.id, text=msg)
+
+
+@admin_allowed(adm_type=AdminType.GROUP)
+def battle_activity(bot: Bot, update: Update, session):
+    squad = session.query(Squad).filter_by(chat_id=update.message.chat.id).first()
+    if squad is not None:
+        msg = activity(squad, hours=4)
+        send_async(bot, chat_id=update.message.chat.id, text=msg)