web_panels.py 22 KB

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