From 6617c932816c843e0eb0045f618213331787d972 Mon Sep 17 00:00:00 2001 From: François Schmidts Date: Sun, 1 Mar 2015 23:34:50 +0100 Subject: splitting models --- pyaggr3g470r/models/__init__.py | 172 ++-------------------------------------- pyaggr3g470r/models/article.py | 87 ++++++++++++++++++++ pyaggr3g470r/models/feed.py | 76 ++++++++++++++++++ pyaggr3g470r/models/role.py | 41 ++++++++++ pyaggr3g470r/models/user.py | 89 +++++++++++++++++++++ 5 files changed, 298 insertions(+), 167 deletions(-) create mode 100644 pyaggr3g470r/models/article.py create mode 100644 pyaggr3g470r/models/feed.py create mode 100644 pyaggr3g470r/models/role.py create mode 100644 pyaggr3g470r/models/user.py diff --git a/pyaggr3g470r/models/__init__.py b/pyaggr3g470r/models/__init__.py index 25273036..9584d1f2 100644 --- a/pyaggr3g470r/models/__init__.py +++ b/pyaggr3g470r/models/__init__.py @@ -26,172 +26,10 @@ __revision__ = "$Date: 2014/04/12 $" __copyright__ = "Copyright (c) Cedric Bonhomme" __license__ = "GPLv3" -import re -import json -import random -import hashlib -from datetime import datetime -from flask import g -from sqlalchemy import asc, desc -from werkzeug import generate_password_hash, check_password_hash -from flask.ext.login import UserMixin +from .feed import Feed +from .role import Role +from .user import User +from .article import Article -db = g.db - -class User(db.Model, UserMixin): - """ - Represent a user. - """ - id = db.Column(db.Integer, primary_key=True) - nickname = db.Column(db.String(), unique=True) - email = db.Column(db.String(254), index=True, unique=True) - pwdhash = db.Column(db.String()) - roles = db.relationship('Role', backref='user', lazy='dynamic') - activation_key = db.Column(db.String(128), default=hashlib.sha512( - str(random.getrandbits(256)).encode("utf-8")).hexdigest()[:86]) - date_created = db.Column(db.DateTime(), default=datetime.now) - last_seen = db.Column(db.DateTime(), default=datetime.now) - feeds = db.relationship('Feed', backref='subscriber', lazy='dynamic', - cascade='all,delete-orphan') - refresh_rate = db.Column(db.Integer, default=60) # in minutes - - @staticmethod - def make_valid_nickname(nickname): - return re.sub('[^a-zA-Z0-9_\.]', '', nickname) - - def get_id(self): - """ - Return the id (email) of the user. - """ - return self.email - - def set_password(self, password): - """ - Hash the password of the user. - """ - self.pwdhash = generate_password_hash(password) - - def check_password(self, password): - """ - Check the password of the user. - """ - return check_password_hash(self.pwdhash, password) - - def is_admin(self): - """ - Return True if the user has administrator rights. - """ - return len([role for role in self.roles if role.name == "admin"]) != 0 - - def __eq__(self, other): - return self.id == other.id - - def __repr__(self): - return '' % (self.nickname) - - -class Role(db.Model): - """ - Represent a role. - """ - id = db.Column(db.Integer, primary_key=True) - name = db.Column(db.String(), unique=True) - - user_id = db.Column(db.Integer, db.ForeignKey('user.id')) - - -class Feed(db.Model): - """ - Represent a station. - """ - id = db.Column(db.Integer, primary_key=True) - title = db.Column(db.String(), default="No title") - description = db.Column(db.String(), default="FR") - link = db.Column(db.String()) - site_link = db.Column(db.String(), default="") - email_notification = db.Column(db.Boolean(), default=False) - enabled = db.Column(db.Boolean(), default=True) - created_date = db.Column(db.DateTime(), default=datetime.now) - - # cache handling - etag = db.Column(db.String(), default="") - last_modified = db.Column(db.String(), default="") - last_retreived = db.Column(db.DateTime(), default=datetime(1970, 1, 1)) - - # error logging - last_error = db.Column(db.String(), default="") - error_count = db.Column(db.Integer(), default=0) - - # relationship - user_id = db.Column(db.Integer, db.ForeignKey('user.id')) - articles = db.relationship('Article', backref='source', lazy='dynamic', - cascade='all,delete-orphan', - order_by=desc("Article.date")) - - def __repr__(self): - return '' % (self.title) - - def dump(self): - return {"id": self.id, - "title": self.title, - "description": self.description, - "link": self.link, - "site_link": self.site_link, - "etag": self.etag, - "error_count": self.error_count, - "last_modified": self.last_modified, - "last_retreived": self.last_retreived} - - -class Article(db.Model): - """ - Represent an article from a feed. - """ - id = db.Column(db.Integer, primary_key=True) - entry_id = db.Column(db.String()) - link = db.Column(db.String()) - title = db.Column(db.String()) - content = db.Column(db.String()) - readed = db.Column(db.Boolean(), default=False) - like = db.Column(db.Boolean(), default=False) - date = db.Column(db.DateTime(), default=datetime.now) - retrieved_date = db.Column(db.DateTime(), default=datetime.now) - - user_id = db.Column(db.Integer, db.ForeignKey('user.id')) - feed_id = db.Column(db.Integer, db.ForeignKey('feed.id')) - - def previous_article(self): - """ - Returns the previous article (older). - """ - return Article.query.filter(Article.date < self.date, - Article.feed_id == self.feed_id)\ - .order_by(desc("Article.date")).first() - - def next_article(self): - """ - Returns the next article (newer). - """ - return Article.query.filter(Article.date > self.date, - Article.feed_id == self.feed_id)\ - .order_by(asc("Article.date")).first() - - def __repr__(self): - return json.dumps({ - "title": self.title, - "link": self.link, - "content": self.content - }) - - def dump(self): - return {"id": self.id, - "title": self.title, - "link": self.link, - "content": self.content, - "readed": self.readed, - "like": self.like, - "date": self.date, - "retrieved_date": self.retrieved_date, - "feed_id": self.source.id, - "feed_name": self.source.title} +__all__ = ['Feed', 'Role', 'User', 'Article'] diff --git a/pyaggr3g470r/models/article.py b/pyaggr3g470r/models/article.py new file mode 100644 index 00000000..2b79c6aa --- /dev/null +++ b/pyaggr3g470r/models/article.py @@ -0,0 +1,87 @@ +#! /usr/bin/env python +# -*- coding: utf-8 -*- + +# pyAggr3g470r - A Web based news aggregator. +# Copyright (C) 2010-2015 Cédric Bonhomme - https://www.cedricbonhomme.org +# +# For more information : https://bitbucket.org/cedricbonhomme/pyaggr3g470r/ +# +# 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.4 $" +__date__ = "$Date: 2013/11/05 $" +__revision__ = "$Date: 2014/04/12 $" +__copyright__ = "Copyright (c) Cedric Bonhomme" +__license__ = "GPLv3" + +import json +from datetime import datetime +from flask import g +from sqlalchemy import asc, desc + +db = g.db + + +class Article(db.Model): + """ + Represent an article from a feed. + """ + id = db.Column(db.Integer, primary_key=True) + entry_id = db.Column(db.String()) + link = db.Column(db.String()) + title = db.Column(db.String()) + content = db.Column(db.String()) + readed = db.Column(db.Boolean(), default=False) + like = db.Column(db.Boolean(), default=False) + date = db.Column(db.DateTime(), default=datetime.now) + retrieved_date = db.Column(db.DateTime(), default=datetime.now) + + user_id = db.Column(db.Integer, db.ForeignKey('user.id')) + feed_id = db.Column(db.Integer, db.ForeignKey('feed.id')) + + def previous_article(self): + """ + Returns the previous article (older). + """ + return Article.query.filter(Article.date < self.date, + Article.feed_id == self.feed_id)\ + .order_by(desc("Article.date")).first() + + def next_article(self): + """ + Returns the next article (newer). + """ + return Article.query.filter(Article.date > self.date, + Article.feed_id == self.feed_id)\ + .order_by(asc("Article.date")).first() + + def __repr__(self): + return json.dumps({ + "title": self.title, + "link": self.link, + "content": self.content + }) + + def dump(self): + return {"id": self.id, + "title": self.title, + "link": self.link, + "content": self.content, + "readed": self.readed, + "like": self.like, + "date": self.date, + "retrieved_date": self.retrieved_date, + "feed_id": self.source.id, + "feed_name": self.source.title} diff --git a/pyaggr3g470r/models/feed.py b/pyaggr3g470r/models/feed.py new file mode 100644 index 00000000..176f0f01 --- /dev/null +++ b/pyaggr3g470r/models/feed.py @@ -0,0 +1,76 @@ +#! /usr/bin/env python +# -*- coding: utf-8 -*- + +# pyAggr3g470r - A Web based news aggregator. +# Copyright (C) 2010-2015 Cédric Bonhomme - https://www.cedricbonhomme.org +# +# For more information : https://bitbucket.org/cedricbonhomme/pyaggr3g470r/ +# +# 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.4 $" +__date__ = "$Date: 2013/11/05 $" +__revision__ = "$Date: 2014/04/12 $" +__copyright__ = "Copyright (c) Cedric Bonhomme" +__license__ = "GPLv3" + +from datetime import datetime +from flask import g +from sqlalchemy import desc + +db = g.db + + +class Feed(db.Model): + """ + Represent a station. + """ + id = db.Column(db.Integer, primary_key=True) + title = db.Column(db.String(), default="No title") + description = db.Column(db.String(), default="FR") + link = db.Column(db.String()) + site_link = db.Column(db.String(), default="") + email_notification = db.Column(db.Boolean(), default=False) + enabled = db.Column(db.Boolean(), default=True) + created_date = db.Column(db.DateTime(), default=datetime.now) + + # cache handling + etag = db.Column(db.String(), default="") + last_modified = db.Column(db.String(), default="") + last_retreived = db.Column(db.DateTime(), default=datetime(1970, 1, 1)) + + # error logging + last_error = db.Column(db.String(), default="") + error_count = db.Column(db.Integer(), default=0) + + # relationship + user_id = db.Column(db.Integer, db.ForeignKey('user.id')) + articles = db.relationship('Article', backref='source', lazy='dynamic', + cascade='all,delete-orphan', + order_by=desc("Article.date")) + + def __repr__(self): + return '' % (self.title) + + def dump(self): + return {"id": self.id, + "title": self.title, + "description": self.description, + "link": self.link, + "site_link": self.site_link, + "etag": self.etag, + "error_count": self.error_count, + "last_modified": self.last_modified, + "last_retreived": self.last_retreived} diff --git a/pyaggr3g470r/models/role.py b/pyaggr3g470r/models/role.py new file mode 100644 index 00000000..71497caf --- /dev/null +++ b/pyaggr3g470r/models/role.py @@ -0,0 +1,41 @@ +#! /usr/bin/env python +# -*- coding: utf-8 -*- + +# pyAggr3g470r - A Web based news aggregator. +# Copyright (C) 2010-2015 Cédric Bonhomme - https://www.cedricbonhomme.org +# +# For more information : https://bitbucket.org/cedricbonhomme/pyaggr3g470r/ +# +# 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.4 $" +__date__ = "$Date: 2013/11/05 $" +__revision__ = "$Date: 2014/04/12 $" +__copyright__ = "Copyright (c) Cedric Bonhomme" +__license__ = "GPLv3" + +from flask import g + +db = g.db + + +class Role(db.Model): + """ + Represent a role. + """ + id = db.Column(db.Integer, primary_key=True) + name = db.Column(db.String(), unique=True) + + user_id = db.Column(db.Integer, db.ForeignKey('user.id')) diff --git a/pyaggr3g470r/models/user.py b/pyaggr3g470r/models/user.py new file mode 100644 index 00000000..f2a268db --- /dev/null +++ b/pyaggr3g470r/models/user.py @@ -0,0 +1,89 @@ +#! /usr/bin/env python +# -*- coding: utf-8 -*- + +# pyAggr3g470r - A Web based news aggregator. +# Copyright (C) 2010-2015 Cédric Bonhomme - https://www.cedricbonhomme.org +# +# For more information : https://bitbucket.org/cedricbonhomme/pyaggr3g470r/ +# +# 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.4 $" +__date__ = "$Date: 2013/11/05 $" +__revision__ = "$Date: 2014/04/12 $" +__copyright__ = "Copyright (c) Cedric Bonhomme" +__license__ = "GPLv3" + +import re +import random +import hashlib +from datetime import datetime +from flask import g +from werkzeug import generate_password_hash, check_password_hash +from flask.ext.login import UserMixin + +db = g.db + + +class User(db.Model, UserMixin): + """ + Represent a user. + """ + id = db.Column(db.Integer, primary_key=True) + nickname = db.Column(db.String(), unique=True) + email = db.Column(db.String(254), index=True, unique=True) + pwdhash = db.Column(db.String()) + roles = db.relationship('Role', backref='user', lazy='dynamic') + activation_key = db.Column(db.String(128), default=hashlib.sha512( + str(random.getrandbits(256)).encode("utf-8")).hexdigest()[:86]) + date_created = db.Column(db.DateTime(), default=datetime.now) + last_seen = db.Column(db.DateTime(), default=datetime.now) + feeds = db.relationship('Feed', backref='subscriber', lazy='dynamic', + cascade='all,delete-orphan') + refresh_rate = db.Column(db.Integer, default=60) # in minutes + + @staticmethod + def make_valid_nickname(nickname): + return re.sub('[^a-zA-Z0-9_\.]', '', nickname) + + def get_id(self): + """ + Return the id (email) of the user. + """ + return self.email + + def set_password(self, password): + """ + Hash the password of the user. + """ + self.pwdhash = generate_password_hash(password) + + def check_password(self, password): + """ + Check the password of the user. + """ + return check_password_hash(self.pwdhash, password) + + def is_admin(self): + """ + Return True if the user has administrator rights. + """ + return len([role for role in self.roles if role.name == "admin"]) != 0 + + def __eq__(self, other): + return self.id == other.id + + def __repr__(self): + return '' % (self.nickname) -- cgit