From d580949de0ea9d0f9e102da7b22862c8e2d426b3 Mon Sep 17 00:00:00 2001 From: Tim Van Baak Date: Sat, 25 Apr 2020 20:06:26 -0700 Subject: [PATCH] Refactor editor functions into another file --- amanuensis/server/session/__init__.py | 93 +++----------------- amanuensis/server/session/editor.py | 118 ++++++++++++++++++++++++++ 2 files changed, 129 insertions(+), 82 deletions(-) create mode 100644 amanuensis/server/session/editor.py diff --git a/amanuensis/server/session/__init__.py b/amanuensis/server/session/__init__.py index 60df1bd..97ce4ae 100644 --- a/amanuensis/server/session/__init__.py +++ b/amanuensis/server/session/__init__.py @@ -1,4 +1,3 @@ -import json import uuid from flask import ( @@ -12,10 +11,7 @@ from flask import ( Markup) from flask_login import current_user -from amanuensis.lexicon import ( - get_player_characters, - get_player_drafts, - attempt_publish) +from amanuensis.lexicon import attempt_publish from amanuensis.models import LexiconModel from amanuensis.parser import ( parse_raw_markdown, @@ -30,9 +26,7 @@ from amanuensis.server.helpers import ( player_required, editor_required) - -def jsonfmt(obj): - return Markup(json.dumps(obj)) +from .editor import load_editor, new_draft, update_draft bp_session = Blueprint('session', __name__, @@ -187,89 +181,24 @@ def review(name): @player_required def editor(name): lexicon: LexiconModel = g.lexicon - aid = request.args.get('aid') - if aid: - # Article specfied, load editor in edit mode - article_fn = None - for filename in lexicon.ctx.draft.ls(): - if filename.endswith(f'{aid}.json'): - article_fn = filename - break - if not article_fn: - flash("Draft not found") - return redirect(url_for('session.session', name=name)) - with lexicon.ctx.draft.read(article_fn) as a: - article = a - # Check that the player owns this article - character = lexicon.cfg.character.get(article.character) - if character.player != current_user.uid: - flash("Access forbidden") - return redirect(url_for('session.session', name=name)) - return render_template( - 'session.editor.jinja', - character=character, - article=article, - jsonfmt=jsonfmt) - - # Article not specified, load editor in load mode - characters = list(get_player_characters(lexicon, current_user.uid)) - articles = list(get_player_drafts(lexicon, current_user.uid)) - print(characters) - print(articles) - return render_template( - 'session.editor.jinja', - characters=characters, - articles=articles) + aid: str = request.args.get('aid') + return load_editor(lexicon, aid) @bp_session.route('/editor/new', methods=['GET']) @lexicon_param @player_required def editor_new(name): - new_aid = uuid.uuid4().hex - # TODO harden this - cid = request.args.get("cid") - character = g.lexicon.cfg.character.get(cid) - article = { - "version": "0", - "aid": new_aid, - "lexicon": g.lexicon.lid, - "character": cid, - "title": "", - "turn": 1, - "status": { - "ready": False, - "approved": False - }, - "contents": f"\n\n{character.signature}", - } - filename = f"{cid}.{new_aid}" - with g.lexicon.ctx.draft.new(filename) as j: - j.update(article) - return redirect(url_for('session.editor', name=name, cid=cid, aid=new_aid)) + lexicon: LexiconModel = g.lexicon + cid: str = request.args.get('cid') + return new_draft(lexicon, cid) @bp_session.route('/editor/update', methods=['POST']) @lexicon_param @player_required def editor_update(name): - article = request.json['article'] - # TODO verification - # check if article was previously approved - # check extrinsic constraints for blocking errors - parsed_draft = parse_raw_markdown(article['contents']) - rendered_html = parsed_draft.render(PreviewHtmlRenderer(g.lexicon)) - features = parsed_draft.render(FeatureCounter()) - - filename = f'{article["character"]}.{article["aid"]}' - with g.lexicon.ctx.draft.edit(filename) as a: - a.update(article) - - # TODO return more info - return { - 'article': article, - 'info': { - 'rendered': rendered_html, - 'word_count': features.word_count, - } - } + lexicon: LexiconModel = g.lexicon + article_json = request.json['article'] + return update_draft(lexicon, article_json) + # only need to be sending around title, status, contents, aid diff --git a/amanuensis/server/session/editor.py b/amanuensis/server/session/editor.py new file mode 100644 index 0000000..fba0cf5 --- /dev/null +++ b/amanuensis/server/session/editor.py @@ -0,0 +1,118 @@ +""" +Handler helper functions pertaining to the article editor +""" +import json +import uuid + +from flask import ( + flash, redirect, url_for, render_template, Markup) +from flask_login import current_user + +from amanuensis.lexicon import get_player_characters, get_player_drafts +from amanuensis.models import LexiconModel +from amanuensis.parser import ( + parse_raw_markdown, + PreviewHtmlRenderer, + FeatureCounter) + + +def load_editor(lexicon: LexiconModel, aid: str): + """ + Load the editor page + """ + if aid: + # Article specfied, load editor in edit mode + article_fn = None + for filename in lexicon.ctx.draft.ls(): + if filename.endswith(f'{aid}.json'): + article_fn = filename + break + if not article_fn: + flash("Draft not found") + return redirect(url_for('session.session', name=lexicon.cfg.name)) + with lexicon.ctx.draft.read(article_fn) as a: + article = a + # Check that the player owns this article + character = lexicon.cfg.character.get(article.character) + if character.player != current_user.uid: + flash("Access forbidden") + return redirect(url_for('session.session', name=lexicon.cfg.name)) + return render_template( + 'session.editor.jinja', + character=character, + article=article, + jsonfmt=lambda obj: Markup(json.dumps(obj))) + + # Article not specified, load editor in load mode + characters = list(get_player_characters(lexicon, current_user.uid)) + articles = list(get_player_drafts(lexicon, current_user.uid)) + return render_template( + 'session.editor.jinja', + characters=characters, + articles=articles) + + +def new_draft(lexicon: LexiconModel, cid: str): + """ + Create a new draft and open it in the editor + """ + if cid: + new_aid = uuid.uuid4().hex + # TODO harden this + character = lexicon.cfg.character.get(cid) + article = { + "version": "0", + "aid": new_aid, + "lexicon": lexicon.lid, + "character": cid, + "title": "", + "turn": 1, + "status": { + "ready": False, + "approved": False + }, + "contents": f"\n\n{character.signature}", + } + filename = f"{cid}.{new_aid}" + with lexicon.ctx.draft.new(filename) as j: + j.update(article) + return redirect(url_for( + 'session.editor', + name=lexicon.cfg.name, + cid=cid, + aid=new_aid)) + + # Character not specified + flash('Character not found') + return redirect(url_for('session.session', name=lexicon.cfg.name)) + + +def update_draft(lexicon: LexiconModel, article_json): + """ + Update a draft and perform analysis on it + """ + aid = article_json.get('aid') + # TODO check if article can be updated + # article exists + # player owns article + # article is not already approved + + contents = article_json.get('contents') + if contents is not None: + parsed = parse_raw_markdown(contents) + # HTML parsing + rendered_html = parsed.render(PreviewHtmlRenderer(lexicon)) + # Constraint analysis + # features = parsed_draft.render(FeatureCounter()) TODO + filename = f'{article_json["character"]}.{article_json["aid"]}' + with lexicon.ctx.draft.edit(filename) as article: + # TODO + article.contents = contents + return { + 'article': article, + 'info': { + 'rendered': rendered_html, + #'word_count': features.word_count, + } + } + return {}