web_panels.py 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540
  1. from flask import flash, render_template, Blueprint, current_app, redirect, request, url_for, session, g
  2. from datetime import timezone
  3. from ownchatbot.db import get_db, reread_goals, reread_votes, rem_vote, reset_vote, reset_goal, clear_fulfilled_rewards, clear_reward_queue, rem_cool, rem_from_queue
  4. from ownchatbot.reward_handlers import all_active_votes, all_active_goals, all_active_rewards, get_queue, fulfill_reward, save_rewards, activate_category, deactivate_category, refund_reward, reread_categories, save_config
  5. from ownchatbot.user_handlers import get_all_users, get_all_users_by_name, refund_points, adjust_points, change_email, get_email_code, del_email_code
  6. from ownchatbot.bot_messages import save_announce
  7. from ownchatbot.owncast_com import send_private_chat
  8. import json
  9. import emoji
  10. from ownchatbot.kofi_handlers import save_kofi_settings, kofi_pngs
  11. import random
  12. import pkce
  13. import requests
  14. from functools import wraps
  15. ocb = Blueprint('web_panels', __name__)
  16. state_value = ''
  17. def requires_login(f):
  18. @wraps(f)
  19. def decorated_function(*args, **kwargs):
  20. if 'user' not in session:
  21. return redirect(url_for('web_panels.login'))
  22. return f(*args, **kwargs)
  23. return decorated_function
  24. @ocb.route('/login')
  25. def login(): # Verify the streamer using indieauth, to their owncast instance
  26. code_verifier, code_challenge = pkce.generate_pkce_pair() # Generate a code verifier and code challenge
  27. global state_value
  28. state_value = code_verifier
  29. owncast_url = current_app.config['OWNCAST_URL']
  30. client_id = current_app.config['INDIEAUTH_CLIENT_ID']
  31. redirect_url = f'{owncast_url}/api/auth/provider/indieauth?client_id={client_id}&redirect_uri={url_for("web_panels.auth_response", _external=True)}&response_type=code&code_challenge_method=S256&code_challenge={code_challenge}&state={code_verifier}'
  32. return redirect(redirect_url)
  33. @ocb.route('/auth_response')
  34. def auth_response():
  35. code = request.args.get('code')
  36. state = request.args.get('state')
  37. if state == state_value: # Check that the state value returned matches the state value sent
  38. current_app.logger.info(f'CSRF code is valid.')
  39. owncast_url = current_app.config['OWNCAST_URL']
  40. owncast_auth_url = f'{owncast_url}/api/auth/provider/indieauth'
  41. client_id = current_app.config['INDIEAUTH_CLIENT_ID']
  42. client_secret = current_app.config['INDIEAUTH_CLIENT_SECRET']
  43. # https://owncast.online/api/latest/#tag/Auth
  44. # https://aaronparecki.com/2021/04/13/26/indieauth
  45. token_response = requests.post(owncast_auth_url, data={
  46. 'client_id': client_id,
  47. 'client_secret': client_secret,
  48. 'code': code,
  49. 'redirect_uri': url_for("web_panels.auth_response", _external=True),
  50. 'grant_type': 'authorization_code',
  51. 'code_verifier': state
  52. })
  53. return_data = token_response.json()
  54. f_return_data = json.dumps(return_data, indent=4)
  55. auth_photo = return_data['profile']['photo']
  56. session['user'] = f_return_data
  57. current_app.logger.info(f'Authenticated.')
  58. return redirect(url_for('web_panels.mgmt'))
  59. else:
  60. current_app.logger.info(f'Invalid CSRF Code.')
  61. return 'Not Authorized'
  62. @ocb.route('/logout')
  63. def logout():
  64. session.pop('user', None)
  65. return redirect(url_for('web_panels.user_panel'))
  66. @ocb.route('/mgmt', methods=['GET']) # The streamer's management panel
  67. @requires_login
  68. def mgmt():
  69. owncast_url = current_app.config['OWNCAST_URL']
  70. db = get_db()
  71. users = get_all_users(db)
  72. utc_timezone = timezone.utc
  73. rewards = current_app.config['REWARDS']
  74. active_rewards = []
  75. for each_reward in all_active_rewards(): # Get the name of all active rewards
  76. active_rewards.append(each_reward)
  77. active_categories = current_app.config['ACTIVE_CAT']
  78. inactive_categories = current_app.config['INACTIVE_CAT']
  79. all_cats = current_app.config['ALL_CAT']
  80. points_interval = current_app.config['POINTS_INTERVAL']
  81. points_award = current_app.config['POINTS_AWARD']
  82. gunicorn_logging = current_app.config['GUNICORN']
  83. prefix = current_app.config['PREFIX']
  84. access_token = current_app.config['ACCESS_TOKEN']
  85. kofi_token = current_app.config['KOFI_TOKEN']
  86. kofi_integration = current_app.config['KOFI_INTEGRATION']
  87. kofi_logos = kofi_pngs()
  88. announce_enable = current_app.config['ANNOUNCE_ENABLE']
  89. announce_interval = current_app.config['ANNOUNCE_INTERVAL']
  90. announcements = current_app.config['ANNOUNCEMENTS']
  91. settings_info = [
  92. points_interval,
  93. points_award,
  94. gunicorn_logging,
  95. prefix,
  96. access_token,
  97. owncast_url,
  98. kofi_token,
  99. kofi_integration,
  100. announce_enable,
  101. announce_interval
  102. ]
  103. return render_template('mgmt.html',
  104. queue=get_queue(db),
  105. votes=all_active_votes(db),
  106. goals=all_active_goals(db),
  107. rewards=rewards,
  108. active_rewards=active_rewards,
  109. prefix=current_app.config['PREFIX'],
  110. kofi_settings=current_app.config['KOFI_SETTINGS'],
  111. kofi_integration=kofi_integration,
  112. kofi_logos=kofi_logos,
  113. announcements=announcements,
  114. users=users,
  115. utc_timezone=utc_timezone,
  116. active_categories=active_categories,
  117. inactive_categories=inactive_categories,
  118. settings_info=settings_info)
  119. @ocb.route('/mgmt_queue', methods=['GET']) # The streamer's management panel
  120. @requires_login
  121. def mgmtqueue():
  122. owncast_url = current_app.config['OWNCAST_URL']
  123. db = get_db()
  124. users = get_all_users(db)
  125. utc_timezone = timezone.utc
  126. rewards = current_app.config['REWARDS']
  127. active_rewards = []
  128. for each_reward in all_active_rewards(): # Get the name of all active rewards
  129. active_rewards.append(each_reward)
  130. return render_template('queue.html',
  131. queue=get_queue(db),
  132. votes=all_active_votes(db),
  133. goals=all_active_goals(db),
  134. rewards=rewards,
  135. utc_timezone=utc_timezone)
  136. @ocb.route('/userpanel', methods=['GET']) # The viewers panel
  137. def user_panel():
  138. db = get_db()
  139. instance = request.args.get('instance')
  140. all_rewards = rewards = current_app.config['REWARDS']
  141. username = request.args.get('username')
  142. points_interval = current_app.config['POINTS_INTERVAL']
  143. points_award = current_app.config['POINTS_AWARD']
  144. if username is not None:
  145. users = get_all_users_by_name(db, username)
  146. else:
  147. users = []
  148. utc_timezone = timezone.utc
  149. return render_template('userpanel.html',
  150. queue=get_queue(db),
  151. votes=all_active_votes(db),
  152. goals=all_active_goals(db),
  153. rewards=all_active_rewards(),
  154. all_rewards=all_rewards,
  155. prefix=current_app.config['PREFIX'],
  156. kofi_settings=current_app.config['KOFI_SETTINGS'],
  157. kofi_integration=current_app.config['KOFI_INTEGRATION'],
  158. points_interval=points_interval,
  159. points_award=points_award,
  160. username=username,
  161. users=users,
  162. instance=instance,
  163. utc_timezone=utc_timezone)
  164. @ocb.route('/mgmt/fulfill', methods=['GET'])
  165. @requires_login
  166. def fulfilled():
  167. db = get_db()
  168. reward_id = request.args.get('reward_id')
  169. username = request.args.get('username')
  170. fulfill_reward(db, reward_id)
  171. return redirect(url_for('web_panels.mgmtqueue'))
  172. @ocb.route('/mgmt/refund', methods=['GET'])
  173. @requires_login
  174. def refund():
  175. db = get_db()
  176. reward_id = request.args.get('reward_id')
  177. reward = request.args.get('reward')
  178. rewards = current_app.config['REWARDS']
  179. points = rewards[reward]['price']
  180. username = request.args.get('username')
  181. user_id = request.args.get('rewarder_id')
  182. refund_points(db, user_id, points) # resets points
  183. refund_reward(db, reward_id) # marks the reward as refunded
  184. return redirect(url_for('web_panels.mgmtqueue'))
  185. @ocb.route('/mgmt/edit_account/<user_id>', methods=['GET', 'POST']) # Streamer manually edit user's account
  186. @requires_login
  187. def edit_account(user_id):
  188. db = get_db()
  189. name = request.args.get('name')
  190. points = request.args.get('points')
  191. email = request.args.get('email')
  192. if request.method == 'POST':
  193. user_id = request.form['user_id']
  194. name = request.form['name']
  195. newpoints = request.form['newpoints']
  196. adjust_points(db, user_id, newpoints)
  197. newemail = request.form['newemail']
  198. if newemail == 'None':
  199. current_app.logger.info(f'No email change requested')
  200. else:
  201. if change_email(db, user_id, newemail):
  202. if newemail == '':
  203. current_app.logger.info(f'Removed {name}\'s email')
  204. else:
  205. current_app.logger.info(f'Changed {name}\'s email to {newemail}')
  206. return redirect(url_for('web_panels.mgmt'))
  207. return render_template('edit_account.html',
  208. name=name,
  209. user_id=user_id,
  210. points=points,
  211. email=email)
  212. @ocb.route('/mgmt/delete/<reward_name>', methods=['GET', 'POST'])
  213. @requires_login
  214. def delete(reward_name):
  215. del_reward = current_app.config['REWARDS']
  216. del_reward.pop(reward_name)
  217. if save_rewards(del_reward):
  218. if rem_cool(reward_name):
  219. rem_from_queue(reward_name)
  220. if reread_votes():
  221. if reread_goals():
  222. pass
  223. return redirect(url_for('web_panels.mgmt'))
  224. @ocb.route('/mgmt/edit/<reward_name>', methods=['GET', 'POST'])
  225. @requires_login
  226. def edit(reward_name):
  227. active_categories = current_app.config['ACTIVE_CAT']
  228. all_the_rewards = current_app.config['REWARDS']
  229. reward_data = all_the_rewards[reward_name]
  230. all_cats = current_app.config['ALL_CAT']
  231. if request.method == 'POST':
  232. reward_data['cooldown'] = int(request.form['cooldown'])
  233. reward_data['type'] = request.form['type']
  234. if reward_data['type'] == 'goal':
  235. reward_data['target'] = int(request.form['target'])
  236. if "milestones" not in reward_data: # If using old rewards.py, and no milestones key exists, create one
  237. reward_data["milestones"] = {"milestone1": [], "milestone2": [], "milestone3": []}
  238. if request.form['milestone1_points'] == '':
  239. reward_data['milestones']['milestone1'] = []
  240. else:
  241. milestone1_points = int(request.form['milestone1_points'])
  242. reward_data['milestones']['milestone1'] = [request.form['milestone1_desc'], milestone1_points]
  243. if request.form['milestone2_points'] == '':
  244. reward_data['milestones']['milestone2'] = []
  245. else:
  246. milestone2_points = int(request.form['milestone2_points'])
  247. reward_data['milestones']['milestone2'] = [request.form['milestone2_desc'], milestone2_points]
  248. if request.form['milestone3_points'] == '':
  249. reward_data['milestones']['milestone3'] = []
  250. else:
  251. milestone3_points = int(request.form['milestone3_points'])
  252. reward_data['milestones']['milestone3'] = [request.form['milestone3_desc'], milestone3_points]
  253. else:
  254. reward_data['price'] = int(request.form['price'])
  255. reward_data['info'] = emoji.demojize(request.form['info'])
  256. if reward_data['type'] == 'special':
  257. reward_data['cmd'] = request.form['cmd']
  258. reward_data['categories'] = request.form.getlist('category')
  259. reward_data['cooldown'] = int(request.form['cooldown'])
  260. all_the_rewards[reward_name] = reward_data
  261. save_rewards(all_the_rewards)
  262. if reward_data['type'] == 'goal': # Sync goals and votes in the db with rewards.py
  263. reread_goals()
  264. if reward_data['type'] == 'vote':
  265. reread_votes()
  266. return redirect(url_for('web_panels.mgmt'))
  267. return render_template('edit.html',
  268. all_cats=all_cats,
  269. reward_name=reward_name,
  270. active_categories=active_categories,
  271. reward_data=reward_data)
  272. @ocb.route('/mgmt/settings', methods=['GET', 'POST']) # OwnchatBot settings panel
  273. @requires_login
  274. def settings():
  275. points_interval = int(request.form['points_interval'])
  276. points_award = int(request.form['points_award'])
  277. gunicorn_logging = 'gunicorn_logging' in request.form
  278. prefix = request.form['prefix']
  279. access_token = request.form['access_token']
  280. owncast_url = request.form['owncast_url']
  281. kofi_integration = 'kofi_integration' in request.form
  282. kofi_token = request.form['kofi_token']
  283. config_dict = {
  284. 'POINTS_INTERVAL': points_interval,
  285. 'POINTS_AWARD': points_award,
  286. 'GUNICORN': gunicorn_logging,
  287. 'PREFIX': prefix,
  288. 'ACCESS_TOKEN': access_token,
  289. 'OWNCAST_URL': owncast_url,
  290. 'KOFI_TOKEN': kofi_token,
  291. 'KOFI_INTEGRATION': kofi_integration
  292. }
  293. if save_config(config_dict): # Save new config.py
  294. current_app.logger.info('Saved new config.')
  295. return redirect(url_for('web_panels.mgmt'))
  296. @ocb.route('/mgmt/announcements', methods=['GET', 'POST']) # OwnchatBot settings panel
  297. @requires_login
  298. def announcements():
  299. announce_enable = 'announce_enable' in request.form
  300. announce_interval = int(request.form['announce_interval'])
  301. new_announcements = []
  302. new_announcements = request.form['announcements'].strip().split('\n')
  303. announce_dict = {
  304. 'ANNOUNCEMENTS': new_announcements,
  305. 'ANNOUNCE_ENABLE': announce_enable,
  306. 'ANNOUNCE_INTERVAL': announce_interval
  307. }
  308. if save_announce(announce_dict): # Save new announce.py
  309. current_app.logger.info('Saved new announcements.')
  310. return redirect(url_for('web_panels.mgmt'))
  311. @ocb.route('/mgmt/ksettings', methods=['GET', 'POST']) # OwnchatBot settings panel
  312. @requires_login
  313. def ksettings():
  314. kofi_settings_dict = current_app.config['KOFI_SETTINGS']
  315. if request.method == 'POST':
  316. enable_donations = 'enable_donations' in request.form
  317. set_donation_points = request.form['set_donation_points']
  318. enable_subs = 'enable_subs' in request.form
  319. sub_points = int(request.form['sub_points'])
  320. kofi_url = request.form['kofi_url']
  321. kofi_logo = request.form.get('kofi_logo')
  322. kofi_settings_dict['donations'] = enable_donations
  323. kofi_settings_dict['subs'] = enable_subs
  324. kofi_settings_dict['sub_points'] = sub_points
  325. kofi_settings_dict['kofi_url'] = kofi_url
  326. kofi_settings_dict['kofi_logo'] = kofi_logo
  327. if save_kofi_settings(kofi_settings_dict):
  328. current_app.logger.info(f'Saved Kofi settings')
  329. return redirect(url_for('web_panels.mgmt'))
  330. @ocb.route('/mgmt/add/<reward_type>', methods=['GET', 'POST'])
  331. @requires_login
  332. def add(reward_type):
  333. all_cats = current_app.config['ALL_CAT']
  334. active_categories = current_app.config['ACTIVE_CAT']
  335. all_the_rewards = current_app.config['REWARDS']
  336. if request.method == 'POST':
  337. name = request.form['name']
  338. name = name.lower() # Force the name to all lower case
  339. name = emoji.demojize(name) # Remove any emojis
  340. name = name.replace(" ", "") # Remove any spaces from the name
  341. type = request.form['type']
  342. if name in all_the_rewards: # Check for duplicate reward names
  343. flash("A reward with this name already exists.", "error") # Flash an error message
  344. return redirect(url_for('web_panels.add', reward_type=reward_type)) # Redirect back to the add page
  345. if type != 'category': # If we're only adding a category, skip all of this
  346. cooldown = int(request.form['cooldown'])
  347. if type == 'redeem' or type == 'special' or type == 'vote':
  348. price = int(request.form['price'])
  349. if type == 'goal':
  350. target = int(request.form['target'])
  351. milestone1_desc = request.form['milestone1_desc']
  352. if request.form['milestone1_points'] == '':
  353. milestone1_points = ''
  354. else:
  355. milestone1_points = int(request.form['milestone1_points'])
  356. milestone2_desc = request.form['milestone2_desc']
  357. if request.form['milestone2_points'] == '':
  358. milestone2_points = ''
  359. else:
  360. milestone2_points = int(request.form['milestone2_points'])
  361. milestone3_desc = request.form['milestone3_desc']
  362. if request.form['milestone3_points'] == '':
  363. milestone3_points = ''
  364. else:
  365. milestone3_points = int(request.form['milestone3_points'])
  366. info = request.form['info']
  367. info = emoji.demojize(info) # Remove any emojis
  368. if type == 'special':
  369. cmd = request.form['cmd']
  370. categories = request.form.getlist('category')
  371. if type == 'redeem':
  372. if categories == ['']:
  373. all_the_rewards[name] = {'price': price, 'type': type, 'info': info, 'cooldown': cooldown}
  374. else:
  375. all_the_rewards[name] = {'price': price, 'type': type, 'info': info, 'categories': categories, 'cooldown': cooldown}
  376. if type == 'goal':
  377. if categories == ['']:
  378. all_the_rewards[name] = {'target': target, 'type': type, 'info': info, 'cooldown': cooldown}
  379. else:
  380. all_the_rewards[name] = {'target': target, 'type': type, 'info': info, 'categories': categories, 'cooldown': cooldown}
  381. all_the_rewards[name]["milestones"] = {"milestone1": [], "milestone2": [], "milestone3": []} # Create empty milestones key
  382. if milestone1_points:
  383. all_the_rewards[name]["milestones"]["milestone1"] = [milestone1_desc, milestone1_points]
  384. if milestone2_points:
  385. all_the_rewards[name]["milestones"]["milestone2"] = [milestone2_desc, milestone2_points]
  386. if milestone3_points:
  387. all_the_rewards[name]["milestones"]["milestone3"] = [milestone3_desc, milestone3_points]
  388. if type == 'vote':
  389. if categories == ['']:
  390. all_the_rewards[name] = {'price': price, 'type': type, 'info': info}
  391. else:
  392. all_the_rewards[name] = {'price': price, 'type': type, 'info': info, 'categories': categories, 'cooldown': cooldown}
  393. if type == 'special':
  394. if categories == ['']:
  395. all_the_rewards[name] = {'price': price, 'type': type, 'info': info, 'cmd': cmd, 'cooldown': cooldown}
  396. else:
  397. all_the_rewards[name] = {'price': price, 'type': type, 'info': info, 'cmd': cmd, 'categories': categories, 'cooldown': cooldown}
  398. save_rewards(all_the_rewards)
  399. if type == 'goal': # Remove old goals and votes from the database
  400. reread_goals()
  401. if type == 'vote':
  402. reread_votes()
  403. else: # If we're only adding a category
  404. inactive_categories = current_app.config['INACTIVE_CAT']
  405. inactive_categories.append(name) # Add it to the INACTIVE_CAT variable
  406. reread_categories() # Write it to categories.py
  407. return redirect(url_for('web_panels.mgmt'))
  408. return render_template('add.html',
  409. all_cats=all_cats,
  410. reward_type=reward_type,
  411. active_categories=active_categories)
  412. @ocb.route('/set_viewer_email', methods=['GET', 'POST'])
  413. def set_viewer_email():
  414. db = get_db()
  415. mail_reg_code = int(request.form['code'])
  416. user_id = request.form['user_id']
  417. db_mail_reg_code = get_email_code(db, user_id)
  418. new_email = request.form['new_email']
  419. instance = request.form['instance']
  420. user_name = request.form['user_name']
  421. if mail_reg_code == db_mail_reg_code:
  422. if change_email(db, user_id, new_email):
  423. del_email_code(db, user_id)
  424. flash(f"Email Address \"{new_email}\" successfully registered.", "success")
  425. send_private_chat(user_id, f'{user_name}, thanks for registering for Kofi perks! I appreciate your support!')
  426. current_app.logger.info(f'Changed {user_id}\'s email to {new_email}')
  427. else:
  428. flash(f"Incorrect code. Email Address \"{new_email}\" was not registered.", "failure")
  429. current_app.logger.info(f'The code entered, \"{mail_reg_code}\", does not match \"{db_mail_reg_code}\" found in database.')
  430. return redirect(url_for('web_panels.user_panel', instance=instance, username=user_name))
  431. @ocb.route('/mgmt/activate/<category>', methods=['GET', 'POST'])
  432. def activate(category):
  433. activate_category(category)
  434. return redirect(url_for('web_panels.mgmt'))
  435. @ocb.route('/mgmt/deactivate/<category>', methods=['GET', 'POST'])
  436. def deactivate(category):
  437. deactivate_category(category)
  438. return redirect(url_for('web_panels.mgmt'))
  439. @ocb.route('/mgmt/delcat/<cat_name>/<cat_act>', methods=['GET', 'POST'])
  440. def delcat(cat_name, cat_act):
  441. active_categories = current_app.config['ACTIVE_CAT']
  442. inactive_categories = current_app.config['INACTIVE_CAT']
  443. if cat_act == 'inactive':
  444. inactive_categories.remove(cat_name)
  445. else:
  446. active_categories.remove(cat_name)
  447. reread_categories()
  448. current_rewards = current_app.config['REWARDS']
  449. for reward, details in current_rewards.items(): # Remove from rewards.py as well
  450. if cat_name in details['categories']:
  451. details['categories'].remove(cat_name)
  452. save_rewards(current_rewards)
  453. return redirect(url_for('web_panels.mgmt'))
  454. @ocb.route('/mgmt/reset/<reward_name>/<reward_type>', methods=['GET', 'POST']) # Reset votes and goals to zero
  455. def reset(reward_name, reward_type):
  456. if reward_type == "goal":
  457. reset_goal(reward_name)
  458. if reward_type == "vote":
  459. reset_vote(reward_name)
  460. return redirect(url_for('web_panels.mgmt'))
  461. @ocb.route('/mgmt/rereadvotes', methods=['GET', 'POST'])
  462. def rereadv():
  463. reread_votes()
  464. return redirect(url_for('web_panels.mgmt'))
  465. @ocb.route('/mgmt/clearfulfilled', methods=['GET', 'POST'])
  466. def clearfulfilled():
  467. clear_fulfilled_rewards()
  468. return redirect(url_for('web_panels.mgmt'))
  469. @ocb.route('/mgmt/clearqueue', methods=['GET', 'POST'])
  470. def clear_queue():
  471. clear_reward_queue()
  472. return redirect(url_for('web_panels.mgmt'))