add ability to bookmark posts and threads, courtesy of bitty

app/__init__.py

@@ -1,4 +1,4 @@
-from flask import Flask, session
+from flask import Flask, session, request
 from dotenv import load_dotenv
 from .models import Avatars, Users, PostHistory, Posts
 from .auth import digest
@@ -131,6 +131,7 @@ def create_app():
     from app.routes.mod import bp as mod_bp
     from app.routes.api import bp as api_bp
     from app.routes.posts import bp as posts_bp
+    from app.routes.hyperapi import bp as hyperapi_bp
     app.register_blueprint(app_bp)
     app.register_blueprint(topics_bp)
     app.register_blueprint(threads_bp)
@@ -138,6 +139,7 @@ def create_app():
     app.register_blueprint(mod_bp)
     app.register_blueprint(api_bp)
     app.register_blueprint(posts_bp)
+    app.register_blueprint(hyperapi_bp)
 
     app.config['SESSION_COOKIE_SECURE'] = True
 
@@ -200,6 +202,15 @@ def create_app():
             for id_, text in matches
         ]
 
+    @app.errorhandler(404)
+    def _handle_404(e):
+        if request.path.startswith('/hyperapi/'):
+            return '<h1>not found</h1>', e.code
+        elif request.path.startswith('/api/'):
+            return {'error': 'not found'}, e.code
+        else:
+            return e
+
     # this only happens at build time but
     # build time is when updates are done anyway
     # sooo... /shrug

app/models.py

@@ -371,6 +371,16 @@ class BookmarkCollections(Model):
         res = db.fetch_one(q, self.id)
         return int(res['pc'])
 
+    def has_thread(self, thread_id):
+        q = 'SELECT EXISTS(SELECT 1 FROM bookmarked_threads WHERE collection_id = ? AND thread_id = ?) as e'
+        res = db.fetch_one(q, self.id, int(thread_id))['e']
+        return int(res) == 1
+
+    def has_post(self, post_id):
+        q = 'SELECT EXISTS(SELECT 1 FROM bookmarked_posts WHERE collection_id = ? AND post_id = ?) as e'
+        res = db.fetch_one(q, self.id, int(post_id))['e']
+        return int(res) == 1
+
 
 class BookmarkedPosts(Model):
     table = 'bookmarked_posts'

app/routes/api.py

@@ -2,7 +2,7 @@ from flask import Blueprint, request, url_for
 from ..lib.babycode import babycode_to_html
 from ..constants import REACTION_EMOJI
 from .users import is_logged_in, get_active_user
-from ..models import APIRateLimits, Threads, Reactions, Users, BookmarkCollections
+from ..models import APIRateLimits, Threads, Reactions, Users, BookmarkCollections, BookmarkedThreads, BookmarkedPosts
 from ..db import db
 
 bp = Blueprint("api", __name__, url_prefix="/api/")
@@ -139,3 +139,76 @@ def manage_bookmark_collections(user_id):
 
 
     return {'status': 'ok'}, 200
+
+
+@bp.post('/bookmark-post/<post_id>')
+def bookmark_post(post_id):
+    if not is_logged_in():
+        return {'error': 'not authorized', 'error_code': 401}, 401
+
+    operation = request.json.get('operation')
+    if operation == 'remove' and request.json.get('collection_id', '') == '':
+        return {'status': 'not modified'}, 304
+    collection_id = int(request.json.get('collection_id'))
+    post_id = int(post_id)
+    memo = request.json.get('memo', '')
+
+    if operation == 'move':
+        bm = BookmarkedPosts.find({'post_id': post_id})
+        if not bm:
+            BookmarkedPosts.create({
+                'post_id': post_id,
+                'collection_id': collection_id,
+                'note': memo,
+            })
+        else:
+            bm.update({
+                'collection_id': collection_id,
+                'note': memo,
+            })
+    elif operation == 'remove':
+        bm = BookmarkedPosts.find({'post_id': post_id})
+        if bm:
+            bm.delete()
+    else:
+        return {'error': 'bad request'}, 400
+
+    return {'status': 'ok'}, 200
+
+
+@bp.post('/bookmark-thread/<thread_id>')
+def bookmark_thread(thread_id):
+    if not is_logged_in():
+        return {'error': 'not authorized', 'error_code': 401}, 401
+
+    operation = request.json.get('operation')
+    if operation == 'remove' and request.json.get('collection_id', '') == '':
+        return {'status': 'not modified'}, 304
+    collection_id = int(request.json.get('collection_id'))
+    thread_id = int(thread_id)
+    memo = request.json.get('memo', '')
+
+    if operation == 'move':
+        bm = BookmarkedThreads.find({'thread_id': thread_id})
+        if not bm:
+            BookmarkedThreads.create({
+                'thread_id': thread_id,
+                'collection_id': collection_id,
+                'note': memo,
+            })
+        else:
+            bm.update({
+                'collection_id': collection_id,
+                'note': memo,
+            })
+    elif operation == 'remove':
+        bm = BookmarkedThreads.find({
+            'thread_id': thread_id,
+            'note': memo,
+        })
+        if bm:
+            bm.delete()
+    else:
+        return {'error': 'bad request'}, 400
+
+    return {'status': 'ok'}, 200

app/routes/hyperapi.py

@@ -0,0 +1,53 @@
+from flask import Blueprint, render_template, abort, request
+from .users import get_active_user, is_logged_in
+from ..models import BookmarkCollections, BookmarkedPosts, BookmarkedThreads
+from functools import wraps
+
+bp = Blueprint('hyperapi', __name__, url_prefix='/hyperapi/')
+
+def login_required(view_func):
+    @wraps(view_func)
+    def dec(*args, **kwargs):
+        if not is_logged_in():
+            abort(403)
+        return view_func(*args, **kwargs)
+    return dec
+
+def account_required(view_func):
+    @wraps(view_func)
+    def dec(*args, **kwargs):
+        if get_active_user().is_guest():
+            abort(403)
+        return view_func(*args, **kwargs)
+    return dec
+
+@bp.errorhandler(403)
+def handle_403(e):
+    return "<h1>forbidden</h1>", 403
+
+
+@bp.get('bookmarks-dropdown/<bookmark_type>')
+@login_required
+@account_required
+def bookmarks_dropdown(bookmark_type):
+    collections = BookmarkCollections.findall({'user_id': get_active_user().id})
+    concept_id = request.args.get('id')
+    require_reload = bool(int(request.args.get('require_reload', default=0)))
+    if bookmark_type.lower() == 'thread':
+        selected = next(filter(lambda bc: bc.has_thread(concept_id), collections), None)
+    elif bookmark_type.lower() == 'post':
+        selected = next(filter(lambda bc: bc.has_post(concept_id), collections), None)
+    else:
+        abort(400)
+        return
+
+    if selected:
+        if bookmark_type.lower() == 'thread':
+            memo = BookmarkedThreads.find({'collection_id': selected.id, 'thread_id': int(concept_id)}).note
+        else:
+            memo = BookmarkedPosts.find({'collection_id': selected.id, 'post_id': int(concept_id)}).note
+    else:
+        memo = ''
+
+
+    return render_template('components/bookmarks_dropdown.html', collections=collections, id=concept_id, selected=selected, type=bookmark_type, memo=memo, require_reload=require_reload)

app/templates/base.html

@@ -10,20 +10,23 @@
   {% endif %}
   <link rel="stylesheet" href="{{ ("/static/css/%s.css" % get_prefers_theme()) | cachebust }}">
   <link rel="icon" type="image/png" href="/static/favicon.png">
+  <script src="/static/js/vnd/bitty-5.1.0-rc6.min.js" type="module"></script>
 </head>
 <body>
-  {% include 'common/topnav.html' %}
-  {% with messages = get_flashed_messages(with_categories=true) %}
-    {% if messages %}
-      {% for category, message in messages %}
-        {{ infobox(message, category) }}
-      {% endfor %}
-    {% endif %}
-  {% endwith %}
-  {% block content %}{% endblock %}
-  <footer class="darkbg">
-    <span>Pyrom commit <a href="{{ "https://git.poto.cafe/yagich/pyrom/commit/" + __commit }}">{{ __commit[:8] }}</a></span>
-  </footer>
+  <bitty-5-1 data-connect="/static/js/bitties/pyrom-bitty.js">
+    {% include 'common/topnav.html' %}
+    {% with messages = get_flashed_messages(with_categories=true) %}
+      {% if messages %}
+        {% for category, message in messages %}
+          {{ infobox(message, category) }}
+        {% endfor %}
+      {% endif %}
+    {% endwith %}
+    {% block content %}{% endblock %}
+    <footer class="darkbg">
+      <span>Pyrom commit <a href="{{ "https://git.poto.cafe/yagich/pyrom/commit/" + __commit }}">{{ __commit[:8] }}</a></span>
+    </footer>
+  </bitty-5-1>
   <script src="{{ "/static/js/ui.js" | cachebust }}"></script>
   <script src="{{ "/static/js/date-fmt.js" | cachebust }}"></script>
 </body>

app/templates/common/macros.html

@@ -28,6 +28,14 @@
 </div>
 {% endmacro %}
 
+{% macro bookmark_button(type, id, message = "Bookmark&hellip;", require_reload=false) %}
+{% set bid = type[0] + id | string %}
+<div class="bookmark-dropdown">
+<button type="button" class="contain-svg inline icon" data-bookmark-type="{{type}}" data-send="showBookmarkMenu" data-concept-id="{{id}}" data-bookmark-id="{{bid}}">{{ icn_bookmark(20) }}{{ message | safe }}</button>
+<div class="bookmark-dropdown-inner" data-receive="showBookmarkMenu" data-bookmark-id="{{bid}}" data-require-reload={{require_reload | int}}></div>
+</div>
+{% endmacro %}
+
 {% macro infobox(message, kind=InfoboxKind.INFO) %}
 <div class="{{ "infobox " + InfoboxHTMLClass[kind] }}">
   <span>
@@ -104,7 +112,8 @@
   post, render_sig = True, is_latest = False,
   editing = False, active_user = None, no_reply = false,
   Reactions = none, show_thread_title = false,
-  show_bookmark = false, memo = None, bookmark_message = "Bookmark&hellip;"
+  show_bookmark = false, memo = None, bookmark_message = "Bookmark&hellip;",
+  reload_after_bookmark = false
 ) %}
 {% set postclass = "post" %}
 {% if editing %}
@@ -182,7 +191,7 @@
         {% endif %}
 
         {% if show_bookmark %}
-          <button type="button" class="contain-svg inline icon">{{ icn_bookmark(20) }}{{ bookmark_message | safe }}</button>
+          {{ bookmark_button(type="post", id=post.id, message=bookmark_message, require_reload=reload_after_bookmark)}}
         {% endif %}
       </span>
     </div>

app/templates/components/bookmarks_dropdown.html

@@ -0,0 +1,23 @@
+{% set bookmark_url = None %}
+{% if type == 'post' %}
+  {% set bookmark_url = url_for('api.bookmark_post', post_id=id) %}
+{% else %}
+  {% set bookmark_url = url_for('api.bookmark_thread', thread_id=id) %}
+{% endif %}
+<div class="bookmarks-dropdown" data-bookmark-type="{{type}}" data-receive="saveBookmarks" data-bookmark-endpoint="{{bookmark_url}}" data-originally-contained-in="{{ selected.id if selected else ""}}" data-require-reload={{require_reload | int}}>
+  <div class="bookmarks-dropdown-header">
+    <span>Bookmark collections</span>
+    {% if not require_reload %}
+      <a href="{{ url_for('users.bookmarks', username=get_active_user().username) }}">View bookmarks</a>
+    {% endif %}
+  </div>
+  <div class="bookmark-dropdown-items-container">
+  {% for collection in collections %}
+    <div class="bookmark-dropdown-item {{ "selected" if selected and (selected.id | int) == (collection.id | int) else ""}}" data-send="selectBookmarkCollection" data-receive="selectBookmarkCollection" data-collection-id="{{collection.id}}">{{collection.name}} ({{ collection.get_posts_count() }}p, {{ collection.get_threads_count() }}t)</div>
+  {% endfor %}
+  </div>
+  <span>
+    <input type="text" placeholder="Memo" class="bookmark-memo-input" value="{{memo}}"></input>
+    <button type="button" data-send="saveBookmarks">Save</button>
+  </span>
+</div>

app/templates/threads/thread.html

@@ -1,4 +1,4 @@
-{% from 'common/macros.html' import pager, babycode_editor_form, full_post %}
+{% from 'common/macros.html' import pager, babycode_editor_form, full_post, bookmark_button %}
 {% from 'common/icons.html' import icn_bookmark %}
 {% extends "base.html" %}
 {% block title %}{{ thread.title }}{% endblock %}
@@ -30,7 +30,7 @@
         </form>
       {% endif %}
       {% if can_bookmark %}
-        <button type="button" class="contain-svg inline icon">{{ icn_bookmark(20) }}Bookmark&hellip;</button>
+        {{ bookmark_button(type="thread", id=thread.id) }}
       {% endif %}
       {% if can_lock %}
         <form class="modform" action="{{ url_for("threads.lock", slug=thread.slug) }}" method="post">

app/templates/topics/topic.html

@@ -1,4 +1,4 @@
-{% from 'common/macros.html' import pager, timestamp %}
+{% from 'common/macros.html' import pager, timestamp, bookmark_button %}
 {% from 'common/icons.html' import icn_bookmark, icn_lock, icn_sticky %}
 {% extends "base.html" %}
 {% block title %}browsing topic {{ topic['name'] }}{% endblock %}
@@ -53,7 +53,7 @@
           </span>
           <span>
             {% if active_user and not active_user.is_guest() -%}
-            <button class="thread-info-bookmark-button contain-svg icon" type="button">{{ icn_bookmark(20) }}Bookmark&hellip;</button>
+            {{ bookmark_button(type="thread", id=thread.id) }}
             {%- endif %}
           </span>
         </span>

app/templates/users/bookmarks.html

@@ -1,9 +1,10 @@
-{% from "common/macros.html" import accordion, full_post %}
+{% from "common/macros.html" import accordion, full_post, bookmark_button %}
 {% from "common/icons.html" import icn_bookmark %}
 {% extends "base.html" %}
 {% block title %}bookmarks{% endblock %}
 {% block content %}
 <div class="darkbg inbox-container">
+  <a class="linkbutton" href="{{ url_for('users.bookmark_collections', username=get_active_user().username) }}">Manage collections</a>
   {% for collection in collections | sort(attribute='sort_order') %}
     {% call(section) accordion(disabled=collection.is_empty()) %}
       {% if section == 'header' %}
@@ -28,7 +29,7 @@
                     <i>{{ thread.note }}</i>
                   </td>
                   <td>
-                    <button type="button" class="contain-svg inline icon">{{ icn_bookmark(20) }}Manage&hellip;</button>
+                    {{ bookmark_button(type='thread', id=thread.thread_id, message='Manage&hellip;', require_reload=true) }}
                   </td>
                 </tr>
               {% endfor %}
@@ -40,7 +41,7 @@
           Posts{{" (no bookmarks)" if not collection.has_posts() else ""}}
           {% else %}
             {% for post in collection.get_posts() %}
-              {{ full_post(post.get_post().get_full_post_view(), no_reply=false, render_sig=false, show_thread_title=true, show_bookmark=true, memo=post.note, bookmark_message="Manage&hellip;") }}
+              {{ full_post(post.get_post().get_full_post_view(), no_reply=false, render_sig=false, show_thread_title=true, show_bookmark=true, memo=post.note, bookmark_message="Manage&hellip;", reload_after_bookmark=true) }}
             {% endfor %}
           {% endif %}
         {% endcall %}