From 8bd82176356540b88eece24b96d7eb6a2260d718 Mon Sep 17 00:00:00 2001 From: Cédric Bonhomme Date: Sun, 12 Feb 2017 16:41:09 +0100 Subject: prototypefor bookmarks --- src/web/controllers/__init__.py | 3 +- src/web/controllers/abstract.py | 12 +++--- src/web/controllers/bookmark.py | 20 +++++++++ src/web/forms.py | 10 +++++ src/web/models/__init__.py | 6 ++- src/web/models/article.py | 8 ++-- src/web/models/bookmark.py | 67 ++++++++++++++++++++++++++++++ src/web/models/tag.py | 40 +++++++++++++++--- src/web/models/user.py | 4 ++ src/web/templates/bookmarks.html | 15 +++++++ src/web/templates/edit_bookmark.html | 58 ++++++++++++++++++++++++++ src/web/views/__init__.py | 3 +- src/web/views/bookmark.py | 80 ++++++++++++++++++++++++++++++++++++ src/web/views/category.py | 2 +- 14 files changed, 308 insertions(+), 20 deletions(-) create mode 100644 src/web/controllers/bookmark.py create mode 100644 src/web/models/bookmark.py create mode 100644 src/web/templates/bookmarks.html create mode 100644 src/web/templates/edit_bookmark.html create mode 100644 src/web/views/bookmark.py (limited to 'src/web') diff --git a/src/web/controllers/__init__.py b/src/web/controllers/__init__.py index a1b89ea8..dd497e9a 100644 --- a/src/web/controllers/__init__.py +++ b/src/web/controllers/__init__.py @@ -3,7 +3,8 @@ from .category import CategoryController from .article import ArticleController from .user import UserController from .icon import IconController +from .bookmark import BookmarkController __all__ = ['FeedController', 'CategoryController', 'ArticleController', - 'UserController', 'IconController'] + 'UserController', 'IconController', 'BookmarkController'] diff --git a/src/web/controllers/abstract.py b/src/web/controllers/abstract.py index 3c91e08a..8563d5f2 100644 --- a/src/web/controllers/abstract.py +++ b/src/web/controllers/abstract.py @@ -98,14 +98,14 @@ class AbstractController: def read(self, **filters): return self._get(**filters) - def update(self, filters, attrs): + def update(self, filters, attrs, return_objs=False, commit=True): assert attrs, "attributes to update must not be empty" - result = None - try: - result = self._get(**filters).update(attrs, synchronize_session=False) + result = self._get(**filters).update(attrs, synchronize_session=False) + if commit: + db.session.flush() db.session.commit() - except Exception as e: - db.session.rollback() + if return_objs: + return self._get(**filters) return result def delete(self, obj_id): diff --git a/src/web/controllers/bookmark.py b/src/web/controllers/bookmark.py new file mode 100644 index 00000000..cf7815a8 --- /dev/null +++ b/src/web/controllers/bookmark.py @@ -0,0 +1,20 @@ +import logging +import itertools +from datetime import datetime, timedelta + +from bootstrap import db +from .abstract import AbstractController +from web.models import Bookmark + +logger = logging.getLogger(__name__) + + +class BookmarkController(AbstractController): + _db_cls = Bookmark + + def count_by_href(self, **filters): + return self._count_by(Bookmark.href, filters) + + def update(self, filters, attrs, *args, **kwargs): + self.tags = attrs['tags'] + return super().update(filters, attrs, *args, **kwargs) diff --git a/src/web/forms.py b/src/web/forms.py index 8088f27b..5957ceef 100644 --- a/src/web/forms.py +++ b/src/web/forms.py @@ -204,6 +204,16 @@ class CategoryForm(Form): submit = SubmitField(lazy_gettext("Save")) +class BookmarkForm(Form): + href = TextField(lazy_gettext("URL")) + description = TextField(lazy_gettext("Description")) + extended = TextField(lazy_gettext("Description long")) + tags = TextField(lazy_gettext("Tags")) + to_read = BooleanField(lazy_gettext("To read"), default=False) + shared = BooleanField(lazy_gettext("Shared"), default=False) + submit = SubmitField(lazy_gettext("Save")) + + class InformationMessageForm(Form): subject = TextField(lazy_gettext("Subject"), [validators.Required(lazy_gettext("Please enter a subject."))]) diff --git a/src/web/models/__init__.py b/src/web/models/__init__.py index 1fc0c3e0..c8fc1aef 100644 --- a/src/web/models/__init__.py +++ b/src/web/models/__init__.py @@ -33,8 +33,12 @@ from .article import Article from .icon import Icon from .category import Category from .tag import Tag +from .tag import BookmarkTag +from .tag import ArticleTag +from .bookmark import Bookmark -__all__ = ['Feed', 'Role', 'User', 'Article', 'Icon', 'Category', 'Tag'] +__all__ = ['Feed', 'Role', 'User', 'Article', 'Icon', 'Category', 'Tag', + 'Bookmark', 'ArticleTag', 'BookmarkTag'] import os diff --git a/src/web/models/article.py b/src/web/models/article.py index 87ad1a9a..923d6869 100644 --- a/src/web/models/article.py +++ b/src/web/models/article.py @@ -52,10 +52,10 @@ class Article(db.Model, RightMixin): category_id = db.Column(db.Integer(), db.ForeignKey('category.id')) # relationships - tag_objs = db.relationship('Tag', back_populates='article', - cascade='all,delete-orphan', - lazy=False, - foreign_keys='[Tag.article_id]') + tag_objs = db.relationship('ArticleTag', back_populates='article', + cascade='all,delete-orphan', + lazy=False, + foreign_keys='[ArticleTag.article_id]') tags = association_proxy('tag_objs', 'text') # index diff --git a/src/web/models/bookmark.py b/src/web/models/bookmark.py new file mode 100644 index 00000000..a796cffa --- /dev/null +++ b/src/web/models/bookmark.py @@ -0,0 +1,67 @@ +#! /usr/bin/env python +# -*- coding: utf-8 -*- + +# Newspipe - A Web based news aggregator. +# Copyright (C) 2010-2016 Cédric Bonhomme - https://www.cedricbonhomme.org +# +# For more information : https://github.com/newspipe/newspipe +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + +__author__ = "Cedric Bonhomme" +__version__ = "$Revision: 0.1 $" +__date__ = "$Date: 2016/12/07 $" +__revision__ = "$Date: 2016/12/07 $" +__copyright__ = "Copyright (c) Cedric Bonhomme" +__license__ = "GPLv3" + +from bootstrap import db +from datetime import datetime +from sqlalchemy.orm import validates +from sqlalchemy.ext.associationproxy import association_proxy + +from web.models.right_mixin import RightMixin + + +class Bookmark(db.Model, RightMixin): + """ + Represent a bookmark. + """ + id = db.Column(db.Integer(), primary_key=True) + href = db.Column(db.String(), default="") + description = db.Column(db.String(), default="FR") + extended = db.Column(db.String()) + shared = db.Column(db.Boolean(), default=False) + to_read = db.Column(db.Boolean(), default=False) + time = db.Column(db.DateTime(), default=datetime.utcnow) + user_id = db.Column(db.Integer(), db.ForeignKey('user.id')) + + # relationships + tag_objs = db.relationship('BookmarkTag', back_populates='bookmark', + cascade='all,delete-orphan', + lazy=False, + foreign_keys='[BookmarkTag.bookmark_id]') + tags = association_proxy('tag_objs', 'text') + + + @validates('description') + def validates_title(self, key, value): + return str(value).strip() + + @validates('extended') + def validates_description(self, key, value): + return str(value).strip() + + def __repr__(self): + return '' % (self.href) diff --git a/src/web/models/tag.py b/src/web/models/tag.py index 8d7fe4d4..d43ce300 100644 --- a/src/web/models/tag.py +++ b/src/web/models/tag.py @@ -8,15 +8,43 @@ from bootstrap import db class Tag(db.Model): - text = Column(String, primary_key=True, unique=False) + id = db.Column(db.Integer(), primary_key=True) + text = Column(String, unique=False) + obj = db.Column(db.String, default='article') + user_id = db.Column(db.Integer(), db.ForeignKey('user.id'), nullable=False) - # foreign keys - article_id = Column(Integer, ForeignKey('article.id', ondelete='CASCADE'), - primary_key=True) + __mapper_args__ = { + 'polymorphic_on': obj + } + + + def __init__(self, text): + self.text = text + + +class ArticleTag(Tag): + __mapper_args__ = { + 'polymorphic_identity': 'article' + } + id = db.Column(db.Integer, db.ForeignKey('tag.id', ondelete='CASCADE'), + primary_key=True) # relationships + article_id = Column(Integer, ForeignKey('article.id', ondelete='CASCADE'), + nullable=False) article = relationship('Article', back_populates='tag_objs', foreign_keys=[article_id]) - def __init__(self, text): - self.text = text + +class BookmarkTag(Tag): + __mapper_args__ = { + 'polymorphic_identity': 'bookmark' + } + id = db.Column(db.Integer, db.ForeignKey('tag.id', ondelete='CASCADE'), + primary_key=True) + + # relationships + bookmark_id = Column(Integer, ForeignKey('bookmark.id', ondelete='CASCADE'), + nullable=False) + bookmark = relationship('Bookmark', back_populates='tag_objs', + foreign_keys=[bookmark_id]) diff --git a/src/web/models/user.py b/src/web/models/user.py index 460958e0..d2b3c52a 100644 --- a/src/web/models/user.py +++ b/src/web/models/user.py @@ -38,6 +38,7 @@ from bootstrap import db from web.models.right_mixin import RightMixin from web.models.category import Category from web.models.feed import Feed +from web.models.bookmark import Bookmark class User(db.Model, UserMixin, RightMixin): @@ -71,6 +72,9 @@ class User(db.Model, UserMixin, RightMixin): feeds = db.relationship('Feed', backref='user', cascade='all, delete-orphan', foreign_keys=[Feed.user_id]) + bookmarks = db.relationship('Bookmark', backref='user', + cascade='all, delete-orphan', + foreign_keys=[Bookmark.user_id]) @staticmethod def _fields_base_write(): diff --git a/src/web/templates/bookmarks.html b/src/web/templates/bookmarks.html new file mode 100644 index 00000000..9e6f0ab1 --- /dev/null +++ b/src/web/templates/bookmarks.html @@ -0,0 +1,15 @@ +{% extends "layout.html" %} +{% block content %} +
+

{{ _('Bookmarks') }}

+ +
+{% endblock %} diff --git a/src/web/templates/edit_bookmark.html b/src/web/templates/edit_bookmark.html new file mode 100644 index 00000000..8dc0cba3 --- /dev/null +++ b/src/web/templates/edit_bookmark.html @@ -0,0 +1,58 @@ +{% extends "layout.html" %} +{% block content %} +
+
+

{{ action }}

+
+ {{ form.hidden_tag() }} +
+ +
+ {{ form.href(class_="form-control", size="100%") }} +
+ {% for error in form.href.errors %} {{ error }}
{% endfor %} +
+ +
+ +
+ {{ form.description(class_="form-control", size="100%") }} +
+ {% for error in form.description.errors %} {{ error }}
{% endfor %} +
+ +
+ +
+ {{ form.tags(class_="form-control", size="100%") }} +
+ {% for error in form.tags.errors %} {{ error }}
{% endfor %} +
+ +
+ +
+
+ {{ form.shared(class_="checkbox", style="margin-left: 0px;") }} +
+
+
+ +
+ +
+
+ {{ form.to_read(class_="checkbox", style="margin-left: 0px;") }} +
+
+
+ +
+
+ {{ form.submit(class_="btn btn-default") }} +
+
+
+
+
+{% endblock %} diff --git a/src/web/views/__init__.py b/src/web/views/__init__.py index e0e49927..41bb52f3 100644 --- a/src/web/views/__init__.py +++ b/src/web/views/__init__.py @@ -6,11 +6,12 @@ from web.views.category import category_bp, categories_bp from web.views.icon import icon_bp from web.views.admin import admin_bp from web.views.user import user_bp, users_bp +from web.views.bookmark import bookmark_bp, bookmarks_bp __all__ = ['views', 'home', 'session_mgmt', 'v2', 'v3', 'article_bp', 'articles_bp', 'feed_bp', 'feeds_bp', 'category_bp', 'categories_bp', 'icon_bp', - 'admin_bp', 'user_bp', 'users_bp'] + 'admin_bp', 'user_bp', 'users_bp', 'bookmark_bp', 'bookmarks_bp'] import conf from flask import request diff --git a/src/web/views/bookmark.py b/src/web/views/bookmark.py new file mode 100644 index 00000000..d780a3ae --- /dev/null +++ b/src/web/views/bookmark.py @@ -0,0 +1,80 @@ +import logging +from werkzeug.exceptions import BadRequest + +from flask import Blueprint, render_template, flash, \ + redirect, request, url_for +from flask_babel import gettext +from flask_login import login_required, current_user + +import conf +from bootstrap import db +from web.forms import BookmarkForm +from web.controllers import BookmarkController + +logger = logging.getLogger(__name__) +bookmarks_bp = Blueprint('bookmarks', __name__, url_prefix='/bookmarks') +bookmark_bp = Blueprint('bookmark', __name__, url_prefix='/bookmark') + + +@bookmarks_bp.route('/', methods=['GET']) +@login_required +def list(): + "Lists the bookmarks." + bookmark_contr = BookmarkController(current_user.id) + return render_template('bookmarks.html', + bookmarks=BookmarkController(current_user.id).read().order_by('time')) + + +@bookmark_bp.route('/create', methods=['GET']) +@bookmark_bp.route('/edit/', methods=['GET']) +@login_required +def form(bookmark_id=None): + action = gettext("Add a bookmark") + head_titles = [action] + if bookmark_id is None: + return render_template('edit_bookmark.html', action=action, + head_titles=head_titles, form=BookmarkForm()) + bookmark = BookmarkController(current_user.id).get(id=bookmark_id) + action = gettext('Edit bookmark') + head_titles = [action] + form = BookmarkForm(obj=bookmark) + form.tags.data = ", ".join(bookmark.tags) + return render_template('edit_bookmark.html', action=action, + head_titles=head_titles, bookmark=bookmark, + form=form) + + +@bookmark_bp.route('/create', methods=['POST']) +@bookmark_bp.route('/edit/', methods=['POST']) +@login_required +def process_form(bookmark_id=None): + form = BookmarkForm() + bookmark_contr = BookmarkController(current_user.id) + + if not form.validate(): + return render_template('edit_bookmark.html', form=form) + + # Edit an existing bookmark + bookmark_attr = {'href': form.href.data, + 'description': form.description.data, + 'extended': form.extended.data, + 'tags': [tag.strip() for tag in form.tags.data.split(',')], + 'shared': form.shared.data, + 'to_read': form.to_read.data} + + if bookmark_id is not None: + bookmark = BookmarkController(current_user.id).get(id=bookmark_id) + form.populate_obj(bookmark) + bookmark.tags = [tag.strip() for tag in form.tags.data.split(',')] + db.session.commit() + + #bookmark_contr.update({'id': bookmark_id}, bookmark_attr) + flash(gettext('Bookmark successfully updated.'), 'success') + return redirect(url_for('bookmark.form', bookmark_id=bookmark_id)) + + # Create a new bookmark + new_bookmark = bookmark_contr.create(**bookmark_attr) + + flash(gettext('Bookmark successfully created.'), 'success') + + return redirect(url_for('bookmark.form', bookmark_id=new_bookmark.id)) diff --git a/src/web/views/category.py b/src/web/views/category.py index 2bdcf9cc..138561dd 100644 --- a/src/web/views/category.py +++ b/src/web/views/category.py @@ -16,7 +16,7 @@ category_bp = Blueprint('category', __name__, url_prefix='/category') @login_required @etag_match def list_(): - "Lists the subscribed feeds in a table." + "Lists the subscribed feeds in a table." art_contr = ArticleController(current_user.id) return render_template('categories.html', categories=list(CategoryController(current_user.id).read().order_by('name')), -- cgit