aboutsummaryrefslogtreecommitdiff
path: root/src/web/models
diff options
context:
space:
mode:
authorFrançois Schmidts <francois.schmidts@gmail.com>2015-12-12 21:14:28 +0100
committerFrançois Schmidts <francois.schmidts@gmail.com>2015-12-17 09:42:56 +0100
commitb35e9773198ef2d8b37c4ca223f08147db47de0b (patch)
treeba4b1b171b3c1ab9414a96ad264c47b0f9d1246b /src/web/models
parentUpdated link to Heroku deploy button on the About page. (diff)
downloadnewspipe-b35e9773198ef2d8b37c4ca223f08147db47de0b.tar.gz
newspipe-b35e9773198ef2d8b37c4ca223f08147db47de0b.tar.bz2
newspipe-b35e9773198ef2d8b37c4ca223f08147db47de0b.zip
moving the root of source code from / to /src/
Diffstat (limited to 'src/web/models')
-rw-r--r--src/web/models/__init__.py103
-rw-r--r--src/web/models/article.py84
-rw-r--r--src/web/models/feed.py77
-rw-r--r--src/web/models/icon.py7
-rw-r--r--src/web/models/role.py39
-rw-r--r--src/web/models/user.py88
6 files changed, 398 insertions, 0 deletions
diff --git a/src/web/models/__init__.py b/src/web/models/__init__.py
new file mode 100644
index 00000000..54168279
--- /dev/null
+++ b/src/web/models/__init__.py
@@ -0,0 +1,103 @@
+#! /usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# jarr - A Web based news aggregator.
+# Copyright (C) 2010-2015 Cédric Bonhomme - https://www.JARR-aggregator.org
+#
+# For more information : https://github.com/JARR-aggregator/JARR/
+#
+# 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 <http://www.gnu.org/licenses/>.
+
+__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 .feed import Feed
+from .role import Role
+from .user import User
+from .article import Article
+from .icon import Icon
+
+__all__ = ['Feed', 'Role', 'User', 'Article', 'Icon']
+
+import os
+
+from werkzeug import generate_password_hash
+
+from sqlalchemy.engine import reflection
+from sqlalchemy.schema import (
+ MetaData,
+ Table,
+ DropTable,
+ ForeignKeyConstraint,
+ DropConstraint)
+
+def db_empty(db):
+ "Will drop every datas stocked in db."
+ # From http://www.sqlalchemy.org/trac/wiki/UsageRecipes/DropEverything
+ conn = db.engine.connect()
+
+ # the transaction only applies if the DB supports
+ # transactional DDL, i.e. Postgresql, MS SQL Server
+ trans = conn.begin()
+
+ inspector = reflection.Inspector.from_engine(db.engine)
+
+ # gather all data first before dropping anything.
+ # some DBs lock after things have been dropped in
+ # a transaction.
+ metadata = MetaData()
+
+ tbs = []
+ all_fks = []
+
+ for table_name in inspector.get_table_names():
+ fks = []
+ for fk in inspector.get_foreign_keys(table_name):
+ if not fk['name']:
+ continue
+ fks.append(ForeignKeyConstraint((), (), name=fk['name']))
+ t = Table(table_name, metadata, *fks)
+ tbs.append(t)
+ all_fks.extend(fks)
+
+ for fkc in all_fks:
+ conn.execute(DropConstraint(fkc))
+
+ for table in tbs:
+ conn.execute(DropTable(table))
+
+ trans.commit()
+
+def db_create(db):
+ "Will create the database from conf parameters."
+ db.create_all()
+
+ role_admin = Role(name="admin")
+ role_user = Role(name="user")
+
+ user1 = User(nickname="admin",
+ email=os.environ.get("ADMIN_EMAIL",
+ "root@jarr.localhost"),
+ pwdhash=generate_password_hash(
+ os.environ.get("ADMIN_PASSWORD", "password")),
+ activation_key="")
+ user1.roles.extend([role_admin, role_user])
+
+ db.session.add(user1)
+ db.session.commit()
+ return role_admin, role_user
diff --git a/src/web/models/article.py b/src/web/models/article.py
new file mode 100644
index 00000000..c25d09d9
--- /dev/null
+++ b/src/web/models/article.py
@@ -0,0 +1,84 @@
+#! /usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# jarr - A Web based news aggregator.
+# Copyright (C) 2010-2015 Cédric Bonhomme - https://www.JARR-aggregator.org
+#
+# For more information : https://github.com/JARR-aggregator/JARR
+#
+# 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 <http://www.gnu.org/licenses/>.
+
+__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 bootstrap import db
+from datetime import datetime
+from sqlalchemy import asc, desc
+
+
+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 "<Article(id=%d, entry_id=%s, title=%r, " \
+ "date=%r, retrieved_date=%r)>" % (self.id, self.entry_id,
+ self.title, self.date, self.retrieved_date)
+
+ def dump(self):
+ return {"id": self.id,
+ "user_id": self.user_id,
+ "entry_id": self.entry_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": getattr(self.source, 'id', None),
+ "feed_name": getattr(self.source, 'title', None)}
diff --git a/src/web/models/feed.py b/src/web/models/feed.py
new file mode 100644
index 00000000..59456a7f
--- /dev/null
+++ b/src/web/models/feed.py
@@ -0,0 +1,77 @@
+#! /usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# jarr - A Web based news aggregator.
+# Copyright (C) 2010-2015 Cédric Bonhomme - https://www.JARR-aggregator.org
+#
+# For more information : https://github.com/JARR-aggregator/JARR/
+#
+# 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 <http://www.gnu.org/licenses/>.
+
+__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 bootstrap import db
+from datetime import datetime
+from sqlalchemy import desc
+
+
+class Feed(db.Model):
+ """
+ Represent a feed.
+ """
+ id = db.Column(db.Integer(), primary_key=True)
+ title = db.Column(db.String(), default="")
+ description = db.Column(db.String(), default="FR")
+ link = db.Column(db.String())
+ site_link = db.Column(db.String(), default="")
+ enabled = db.Column(db.Boolean(), default=True)
+ created_date = db.Column(db.DateTime(), default=datetime.now)
+ filters = db.Column(db.PickleType, default=[])
+
+ # cache handling
+ etag = db.Column(db.String(), default="")
+ last_modified = db.Column(db.String(), default="")
+ last_retrieved = 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
+ icon_url = db.Column(db.String(), db.ForeignKey('icon.url'), default=None)
+ 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 '<Feed %r>' % (self.title)
+
+ def dump(self):
+ return {"id": self.id,
+ "user_id": self.user_id,
+ "title": self.title,
+ "description": self.description,
+ "link": self.link,
+ "site_link": self.site_link,
+ "etag": self.etag,
+ "icon_url": self.icon_url,
+ "error_count": self.error_count,
+ "last_modified": self.last_modified,
+ "last_retrieved": self.last_retrieved}
diff --git a/src/web/models/icon.py b/src/web/models/icon.py
new file mode 100644
index 00000000..22ef1164
--- /dev/null
+++ b/src/web/models/icon.py
@@ -0,0 +1,7 @@
+from bootstrap import db
+
+
+class Icon(db.Model):
+ url = db.Column(db.String(), primary_key=True)
+ content = db.Column(db.String(), default=None)
+ mimetype = db.Column(db.String(), default="application/image")
diff --git a/src/web/models/role.py b/src/web/models/role.py
new file mode 100644
index 00000000..a9184d64
--- /dev/null
+++ b/src/web/models/role.py
@@ -0,0 +1,39 @@
+#! /usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# jarr - A Web based news aggregator.
+# Copyright (C) 2010-2015 Cédric Bonhomme - https://www.JARR-aggregator.org
+#
+# For more information : https://github.com/JARR-aggregator/JARR/
+#
+# 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 <http://www.gnu.org/licenses/>.
+
+__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 bootstrap import 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/src/web/models/user.py b/src/web/models/user.py
new file mode 100644
index 00000000..c5e70036
--- /dev/null
+++ b/src/web/models/user.py
@@ -0,0 +1,88 @@
+#! /usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# jarr - A Web based news aggregator.
+# Copyright (C) 2010-2015 Cédric Bonhomme - https://www.JARR-aggregator.org
+#
+# For more information : https://github.com/JARR-aggregator/JARR/
+#
+# 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 <http://www.gnu.org/licenses/>.
+
+__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 werkzeug import generate_password_hash, check_password_hash
+from flask.ext.login import UserMixin
+
+from bootstrap import 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 of the user.
+ """
+ return self.id
+
+ 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 '<User %r>' % (self.nickname)
bgstack15