web_panels.py 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544
  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') # Remove this comment
  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['ACCESS_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. access_id = current_app.config['ACCESS_ID']
  42. access_token = current_app.config['ACCESS_TOKEN']
  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': access_id,
  47. 'client_secret': access_token,
  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_id = current_app.config['ACCESS_ID']
  85. access_token = current_app.config['ACCESS_TOKEN']
  86. kofi_token = current_app.config['KOFI_TOKEN']
  87. kofi_integration = current_app.config['KOFI_INTEGRATION']
  88. kofi_logos = kofi_pngs()
  89. announce_enable = current_app.config['ANNOUNCE_ENABLE']
  90. announce_interval = current_app.config['ANNOUNCE_INTERVAL']
  91. announcements = current_app.config['ANNOUNCEMENTS']
  92. settings_info = [
  93. access_id,
  94. points_interval,
  95. points_award,
  96. gunicorn_logging,
  97. prefix,
  98. access_token,
  99. owncast_url,
  100. kofi_token,
  101. kofi_integration,
  102. announce_enable,
  103. announce_interval
  104. ]
  105. return render_template('mgmt.html',
  106. queue=get_queue(db),
  107. votes=all_active_votes(db),
  108. goals=all_active_goals(db),
  109. rewards=rewards,
  110. active_rewards=active_rewards,
  111. prefix=current_app.config['PREFIX'],
  112. kofi_settings=current_app.config['KOFI_SETTINGS'],
  113. kofi_integration=kofi_integration,
  114. kofi_logos=kofi_logos,
  115. announcements=announcements,
  116. users=users,
  117. utc_timezone=utc_timezone,
  118. active_categories=active_categories,
  119. inactive_categories=inactive_categories,
  120. settings_info=settings_info)
  121. @ocb.route('/mgmt_queue', methods=['GET']) # The streamer's management panel
  122. @requires_login
  123. def mgmtqueue():
  124. owncast_url = current_app.config['OWNCAST_URL']
  125. db = get_db()
  126. users = get_all_users(db)
  127. utc_timezone = timezone.utc
  128. rewards = current_app.config['REWARDS']
  129. active_rewards = []
  130. for each_reward in all_active_rewards(): # Get the name of all active rewards
  131. active_rewards.append(each_reward)
  132. return render_template('queue.html',
  133. queue=get_queue(db),
  134. votes=all_active_votes(db),
  135. goals=all_active_goals(db),
  136. rewards=rewards,
  137. utc_timezone=utc_timezone)
  138. @ocb.route('/userpanel', methods=['GET']) # The viewers panel
  139. def user_panel():
  140. db = get_db()
  141. instance = request.args.get('instance')
  142. all_rewards = rewards = current_app.config['REWARDS']
  143. username = request.args.get('username')
  144. points_interval = current_app.config['POINTS_INTERVAL']
  145. points_award = current_app.config['POINTS_AWARD']
  146. if username is not None:
  147. users = get_all_users_by_name(db, username)
  148. else:
  149. users = []
  150. utc_timezone = timezone.utc
  151. return render_template('userpanel.html',
  152. queue=get_queue(db),
  153. votes=all_active_votes(db),
  154. goals=all_active_goals(db),
  155. rewards=all_active_rewards(),
  156. all_rewards=all_rewards,
  157. prefix=current_app.config['PREFIX'],
  158. kofi_settings=current_app.config['KOFI_SETTINGS'],
  159. kofi_integration=current_app.config['KOFI_INTEGRATION'],
  160. points_interval=points_interval,
  161. points_award=points_award,
  162. username=username,
  163. users=users,
  164. instance=instance,
  165. utc_timezone=utc_timezone)
  166. @ocb.route('/mgmt/fulfill', methods=['GET'])
  167. @requires_login
  168. def fulfilled():
  169. db = get_db()
  170. reward_id = request.args.get('reward_id')
  171. username = request.args.get('username')
  172. fulfill_reward(db, reward_id)
  173. return redirect(url_for('web_panels.mgmtqueue'))
  174. @ocb.route('/mgmt/refund', methods=['GET'])
  175. @requires_login
  176. def refund():
  177. db = get_db()
  178. reward_id = request.args.get('reward_id')
  179. reward = request.args.get('reward')
  180. rewards = current_app.config['REWARDS']
  181. points = rewards[reward]['price']
  182. username = request.args.get('username')
  183. user_id = request.args.get('rewarder_id')
  184. refund_points(db, user_id, points) # resets points
  185. refund_reward(db, reward_id) # marks the reward as refunded
  186. return redirect(url_for('web_panels.mgmtqueue'))
  187. @ocb.route('/mgmt/edit_account/<user_id>', methods=['GET', 'POST']) # Streamer manually edit user's account
  188. @requires_login
  189. def edit_account(user_id):
  190. db = get_db()
  191. name = request.args.get('name')
  192. points = request.args.get('points')
  193. email = request.args.get('email')
  194. if request.method == 'POST':
  195. user_id = request.form['user_id']
  196. name = request.form['name']
  197. newpoints = request.form['newpoints']
  198. adjust_points(db, user_id, newpoints)
  199. newemail = request.form['newemail']
  200. if newemail == 'None':
  201. current_app.logger.info(f'No email change requested')
  202. else:
  203. if change_email(db, user_id, newemail):
  204. if newemail == '':
  205. current_app.logger.info(f'Removed {name}\'s email')
  206. else:
  207. current_app.logger.info(f'Changed {name}\'s email to {newemail}')
  208. return redirect(url_for('web_panels.mgmt'))
  209. return render_template('edit_account.html',
  210. name=name,
  211. user_id=user_id,
  212. points=points,
  213. email=email)
  214. @ocb.route('/mgmt/delete/<reward_name>', methods=['GET', 'POST'])
  215. @requires_login
  216. def delete(reward_name):
  217. del_reward = current_app.config['REWARDS']
  218. del_reward.pop(reward_name)
  219. if save_rewards(del_reward):
  220. if rem_cool(reward_name):
  221. rem_from_queue(reward_name)
  222. if reread_votes():
  223. if reread_goals():
  224. pass
  225. return redirect(url_for('web_panels.mgmt'))
  226. @ocb.route('/mgmt/edit/<reward_name>', methods=['GET', 'POST'])
  227. @requires_login
  228. def edit(reward_name):
  229. active_categories = current_app.config['ACTIVE_CAT']
  230. all_the_rewards = current_app.config['REWARDS']
  231. reward_data = all_the_rewards[reward_name]
  232. all_cats = current_app.config['ALL_CAT']
  233. if request.method == 'POST':
  234. reward_data['cooldown'] = int(request.form['cooldown'])
  235. reward_data['type'] = request.form['type']
  236. if reward_data['type'] == 'goal':
  237. reward_data['target'] = int(request.form['target'])
  238. if "milestones" not in reward_data: # If using old rewards.py, and no milestones key exists, create one
  239. reward_data["milestones"] = {"milestone1": [], "milestone2": [], "milestone3": []}
  240. if request.form['milestone1_points'] == '':
  241. reward_data['milestones']['milestone1'] = []
  242. else:
  243. milestone1_points = int(request.form['milestone1_points'])
  244. reward_data['milestones']['milestone1'] = [request.form['milestone1_desc'], milestone1_points]
  245. if request.form['milestone2_points'] == '':
  246. reward_data['milestones']['milestone2'] = []
  247. else:
  248. milestone2_points = int(request.form['milestone2_points'])
  249. reward_data['milestones']['milestone2'] = [request.form['milestone2_desc'], milestone2_points]
  250. if request.form['milestone3_points'] == '':
  251. reward_data['milestones']['milestone3'] = []
  252. else:
  253. milestone3_points = int(request.form['milestone3_points'])
  254. reward_data['milestones']['milestone3'] = [request.form['milestone3_desc'], milestone3_points]
  255. else:
  256. reward_data['price'] = int(request.form['price'])
  257. reward_data['info'] = emoji.demojize(request.form['info'])
  258. if reward_data['type'] == 'special':
  259. reward_data['cmd'] = request.form['cmd']
  260. reward_data['categories'] = request.form.getlist('category')
  261. reward_data['cooldown'] = int(request.form['cooldown'])
  262. all_the_rewards[reward_name] = reward_data
  263. save_rewards(all_the_rewards)
  264. if reward_data['type'] == 'goal': # Sync goals and votes in the db with rewards.py
  265. reread_goals()
  266. if reward_data['type'] == 'vote':
  267. reread_votes()
  268. return redirect(url_for('web_panels.mgmt'))
  269. return render_template('edit.html',
  270. all_cats=all_cats,
  271. reward_name=reward_name,
  272. active_categories=active_categories,
  273. reward_data=reward_data)
  274. @ocb.route('/mgmt/settings', methods=['GET', 'POST']) # OwnchatBot settings panel
  275. @requires_login
  276. def settings():
  277. points_interval = int(request.form['points_interval'])
  278. points_award = int(request.form['points_award'])
  279. gunicorn_logging = 'gunicorn_logging' in request.form
  280. prefix = request.form['prefix']
  281. access_id = request.form['access_id']
  282. access_token = request.form['access_token']
  283. owncast_url = request.form['owncast_url']
  284. kofi_integration = 'kofi_integration' in request.form
  285. kofi_token = request.form['kofi_token']
  286. config_dict = {
  287. 'POINTS_INTERVAL': points_interval,
  288. 'POINTS_AWARD': points_award,
  289. 'GUNICORN': gunicorn_logging,
  290. 'PREFIX': prefix,
  291. 'ACCESS_ID': access_id,
  292. 'ACCESS_TOKEN': access_token,
  293. 'OWNCAST_URL': owncast_url,
  294. 'KOFI_TOKEN': kofi_token,
  295. 'KOFI_INTEGRATION': kofi_integration
  296. }
  297. if save_config(config_dict): # Save new config.py
  298. current_app.logger.info('Saved new config.')
  299. return redirect(url_for('web_panels.mgmt'))
  300. @ocb.route('/mgmt/announcements', methods=['GET', 'POST']) # OwnchatBot settings panel
  301. @requires_login
  302. def announcements():
  303. announce_enable = 'announce_enable' in request.form
  304. announce_interval = int(request.form['announce_interval'])
  305. new_announcements = []
  306. new_announcements = request.form['announcements'].strip().split('\n')
  307. announce_dict = {
  308. 'ANNOUNCEMENTS': new_announcements,
  309. 'ANNOUNCE_ENABLE': announce_enable,
  310. 'ANNOUNCE_INTERVAL': announce_interval
  311. }
  312. if save_announce(announce_dict): # Save new announce.py
  313. current_app.logger.info('Saved new announcements.')
  314. return redirect(url_for('web_panels.mgmt'))
  315. @ocb.route('/mgmt/ksettings', methods=['GET', 'POST']) # OwnchatBot settings panel
  316. @requires_login
  317. def ksettings():
  318. kofi_settings_dict = current_app.config['KOFI_SETTINGS']
  319. if request.method == 'POST':
  320. enable_donations = 'enable_donations' in request.form
  321. set_donation_points = request.form['set_donation_points']
  322. enable_subs = 'enable_subs' in request.form
  323. sub_points = int(request.form['sub_points'])
  324. kofi_url = request.form['kofi_url']
  325. kofi_logo = request.form.get('kofi_logo')
  326. kofi_settings_dict['donations'] = enable_donations
  327. kofi_settings_dict['subs'] = enable_subs
  328. kofi_settings_dict['sub_points'] = sub_points
  329. kofi_settings_dict['kofi_url'] = kofi_url
  330. kofi_settings_dict['kofi_logo'] = kofi_logo
  331. if save_kofi_settings(kofi_settings_dict):
  332. current_app.logger.info(f'Saved Kofi settings')
  333. return redirect(url_for('web_panels.mgmt'))
  334. @ocb.route('/mgmt/add/<reward_type>', methods=['GET', 'POST'])
  335. @requires_login
  336. def add(reward_type):
  337. all_cats = current_app.config['ALL_CAT']
  338. active_categories = current_app.config['ACTIVE_CAT']
  339. all_the_rewards = current_app.config['REWARDS']
  340. if request.method == 'POST':
  341. name = request.form['name']
  342. name = name.lower() # Force the name to all lower case
  343. name = emoji.demojize(name) # Remove any emojis
  344. name = name.replace(" ", "") # Remove any spaces from the name
  345. type = request.form['type']
  346. if name in all_the_rewards: # Check for duplicate reward names
  347. flash("A reward with this name already exists.", "error") # Flash an error message
  348. return redirect(url_for('web_panels.add', reward_type=reward_type)) # Redirect back to the add page
  349. if type != 'category': # If we're only adding a category, skip all of this
  350. cooldown = int(request.form['cooldown'])
  351. if type == 'redeem' or type == 'special' or type == 'vote':
  352. price = int(request.form['price'])
  353. if type == 'goal':
  354. target = int(request.form['target'])
  355. milestone1_desc = request.form['milestone1_desc']
  356. if request.form['milestone1_points'] == '':
  357. milestone1_points = ''
  358. else:
  359. milestone1_points = int(request.form['milestone1_points'])
  360. milestone2_desc = request.form['milestone2_desc']
  361. if request.form['milestone2_points'] == '':
  362. milestone2_points = ''
  363. else:
  364. milestone2_points = int(request.form['milestone2_points'])
  365. milestone3_desc = request.form['milestone3_desc']
  366. if request.form['milestone3_points'] == '':
  367. milestone3_points = ''
  368. else:
  369. milestone3_points = int(request.form['milestone3_points'])
  370. info = request.form['info']
  371. info = emoji.demojize(info) # Remove any emojis
  372. if type == 'special':
  373. cmd = request.form['cmd']
  374. categories = request.form.getlist('category')
  375. if type == 'redeem':
  376. if categories == ['']:
  377. all_the_rewards[name] = {'price': price, 'type': type, 'info': info, 'cooldown': cooldown}
  378. else:
  379. all_the_rewards[name] = {'price': price, 'type': type, 'info': info, 'categories': categories, 'cooldown': cooldown}
  380. if type == 'goal':
  381. if categories == ['']:
  382. all_the_rewards[name] = {'target': target, 'type': type, 'info': info, 'cooldown': cooldown}
  383. else:
  384. all_the_rewards[name] = {'target': target, 'type': type, 'info': info, 'categories': categories, 'cooldown': cooldown}
  385. all_the_rewards[name]["milestones"] = {"milestone1": [], "milestone2": [], "milestone3": []} # Create empty milestones key
  386. if milestone1_points:
  387. all_the_rewards[name]["milestones"]["milestone1"] = [milestone1_desc, milestone1_points]
  388. if milestone2_points:
  389. all_the_rewards[name]["milestones"]["milestone2"] = [milestone2_desc, milestone2_points]
  390. if milestone3_points:
  391. all_the_rewards[name]["milestones"]["milestone3"] = [milestone3_desc, milestone3_points]
  392. if type == 'vote':
  393. if categories == ['']:
  394. all_the_rewards[name] = {'price': price, 'type': type, 'info': info}
  395. else:
  396. all_the_rewards[name] = {'price': price, 'type': type, 'info': info, 'categories': categories, 'cooldown': cooldown}
  397. if type == 'special':
  398. if categories == ['']:
  399. all_the_rewards[name] = {'price': price, 'type': type, 'info': info, 'cmd': cmd, 'cooldown': cooldown}
  400. else:
  401. all_the_rewards[name] = {'price': price, 'type': type, 'info': info, 'cmd': cmd, 'categories': categories, 'cooldown': cooldown}
  402. save_rewards(all_the_rewards)
  403. if type == 'goal': # Remove old goals and votes from the database
  404. reread_goals()
  405. if type == 'vote':
  406. reread_votes()
  407. else: # If we're only adding a category
  408. inactive_categories = current_app.config['INACTIVE_CAT']
  409. inactive_categories.append(name) # Add it to the INACTIVE_CAT variable
  410. reread_categories() # Write it to categories.py
  411. return redirect(url_for('web_panels.mgmt'))
  412. return render_template('add.html',
  413. all_cats=all_cats,
  414. reward_type=reward_type,
  415. active_categories=active_categories)
  416. @ocb.route('/set_viewer_email', methods=['GET', 'POST'])
  417. def set_viewer_email():
  418. db = get_db()
  419. mail_reg_code = int(request.form['code'])
  420. user_id = request.form['user_id']
  421. db_mail_reg_code = get_email_code(db, user_id)
  422. new_email = request.form['new_email']
  423. instance = request.form['instance']
  424. user_name = request.form['user_name']
  425. if mail_reg_code == db_mail_reg_code:
  426. if change_email(db, user_id, new_email):
  427. del_email_code(db, user_id)
  428. flash(f"Email Address \"{new_email}\" successfully registered.", "success")
  429. send_private_chat(user_id, f'{user_name}, thanks for registering for Kofi perks! I appreciate your support!')
  430. current_app.logger.info(f'Changed {user_id}\'s email to {new_email}')
  431. else:
  432. flash(f"Incorrect code. Email Address \"{new_email}\" was not registered.", "failure")
  433. current_app.logger.info(f'The code entered, \"{mail_reg_code}\", does not match \"{db_mail_reg_code}\" found in database.')
  434. return redirect(url_for('web_panels.user_panel', instance=instance, username=user_name))
  435. @ocb.route('/mgmt/activate/<category>', methods=['GET', 'POST'])
  436. def activate(category):
  437. activate_category(category)
  438. return redirect(url_for('web_panels.mgmt'))
  439. @ocb.route('/mgmt/deactivate/<category>', methods=['GET', 'POST'])
  440. def deactivate(category):
  441. deactivate_category(category)
  442. return redirect(url_for('web_panels.mgmt'))
  443. @ocb.route('/mgmt/delcat/<cat_name>/<cat_act>', methods=['GET', 'POST'])
  444. def delcat(cat_name, cat_act):
  445. active_categories = current_app.config['ACTIVE_CAT']
  446. inactive_categories = current_app.config['INACTIVE_CAT']
  447. if cat_act == 'inactive':
  448. inactive_categories.remove(cat_name)
  449. else:
  450. active_categories.remove(cat_name)
  451. reread_categories()
  452. current_rewards = current_app.config['REWARDS']
  453. for reward, details in current_rewards.items(): # Remove from rewards.py as well
  454. if cat_name in details['categories']:
  455. details['categories'].remove(cat_name)
  456. save_rewards(current_rewards)
  457. return redirect(url_for('web_panels.mgmt'))
  458. @ocb.route('/mgmt/reset/<reward_name>/<reward_type>', methods=['GET', 'POST']) # Reset votes and goals to zero
  459. def reset(reward_name, reward_type):
  460. if reward_type == "goal":
  461. reset_goal(reward_name)
  462. if reward_type == "vote":
  463. reset_vote(reward_name)
  464. return redirect(url_for('web_panels.mgmt'))
  465. @ocb.route('/mgmt/rereadvotes', methods=['GET', 'POST'])
  466. def rereadv():
  467. reread_votes()
  468. return redirect(url_for('web_panels.mgmt'))
  469. @ocb.route('/mgmt/clearfulfilled', methods=['GET', 'POST'])
  470. def clearfulfilled():
  471. clear_fulfilled_rewards()
  472. return redirect(url_for('web_panels.mgmtqueue'))
  473. @ocb.route('/mgmt/clearqueue', methods=['GET', 'POST'])
  474. def clear_queue():
  475. clear_reward_queue()
  476. return redirect(url_for('web_panels.mgmtqueue'))