web_panels.py 22 KB

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