#! /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: 5.3 $"
__date__ = "$Date: 2010/01/29 $"
__revision__ = "$Date: 2014/08/27 $"
__copyright__ = "Copyright (c) Cedric Bonhomme"
__license__ = "AGPLv3"
import os
import string
import random
import hashlib
import logging
import datetime
from collections import OrderedDict
from bootstrap import application as app, db
from flask import render_template, request, flash, session, \
url_for, redirect, g, current_app, make_response
from flask.ext.login import LoginManager, login_user, logout_user, \
login_required, current_user, AnonymousUserMixin, \
login_url
from flask.ext.principal import Principal, Identity, AnonymousIdentity, \
identity_changed, identity_loaded, Permission,\
RoleNeed, UserNeed
from flask.ext.babel import gettext
from sqlalchemy import or_, and_
from sqlalchemy.exc import IntegrityError
from werkzeug import generate_password_hash
import conf
from pyaggr3g470r import utils, notifications, export
from pyaggr3g470r.lib.view_utils import etag_match
from pyaggr3g470r.models import User, Feed, Article, Role
from pyaggr3g470r.decorators import feed_access_required
from pyaggr3g470r.forms import SignupForm, SigninForm, InformationMessageForm,\
ProfileForm, UserForm, RecoverPasswordForm \
from pyaggr3g470r.controllers import UserController, FeedController, \
ArticleController
Principal(app)
# Create a permission with a single Need, in this case a RoleNeed.
admin_permission = Permission(RoleNeed('admin'))
login_manager = LoginManager()
login_manager.init_app(app)
login_manager.login_message = gettext('Authentication required.')
login_manager.login_message_category = "info"
login_manager.login_view = 'login'
logger = logging.getLogger(__name__)
#
# Management of the user's session.
#
@identity_loaded.connect_via(app)
def on_identity_loaded(sender, identity):
# Set the identity user object
identity.user = current_user
# Add the UserNeed to the identity
if hasattr(current_user, 'id'):
identity.provides.add(UserNeed(current_user.id))
# Assuming the User model has a list of roles, update the
# identity with the roles that the user provides
if hasattr(current_user, 'roles'):
for role in current_user.roles:
identity.provides.add(RoleNeed(role.name))
@app.before_request
def before_request():
g.user = current_user
if g.user.is_authenticated:
g.user.last_seen = datetime.datetime.utcnow()
db.session.add(g.user)
db.session.commit()
@login_manager.user_loader
def load_user(id):
# Return an instance of the User model
return UserController().get(id=id)
#
# Custom error pages.
#
@app.errorhandler(401)
def authentication_required(e):
flash(gettext('Authentication required.'), 'info')
return redirect(url_for('login'))
@app.errorhandler(403)
def authentication_failed(e):
flash(gettext('Forbidden.'), 'danger')
return redirect(url_for('login'))
@app.errorhandler(404)
def page_not_found(e):
return render_template('errors/404.html'), 404
@app.errorhandler(500)
def internal_server_error(e):
return render_template('errors/500.html'), 500
def redirect_url(default='home'):
return request.args.get('next') or \
request.referrer or \
url_for(default)
@g.babel.localeselector
def get_locale():
"""
Called before each request to give us a chance to choose
the language to use when producing its response.
"""
return request.accept_languages.best_match(conf.LANGUAGES.keys())
@g.babel.timezoneselector
def get_timezone():
try:
return conf.TIME_ZONE[get_locale()]
except:
return conf.TIME_ZONE["en"]
#
# Views.
#
@app.route('/login', methods=['GET', 'POST'])
def login():
"""
Log in view.
"""
if g.user is not None and g.user.is_authenticated:
return redirect(url_for('home'))
g.user = AnonymousUserMixin()
form = SigninForm()
if form.validate_on_submit():
user = UserController().get(email=form.email.data)
login_user(user)
g.user = user
session['email'] = form.email.data
identity_changed.send(current_app._get_current_object(),
identity=Identity(user.id))
return form.redirect('home')
return render_template('login.html', form=form)
@app.route('/logout')
@login_required
def logout():
"""
Log out view. Removes the user information from the session.
"""
session.pop('email', None)
# Remove the user information from the session
logout_user()
# Remove session keys set by Flask-Principal
for key in ('identity.name', 'identity.auth_type'):
session.pop(key, None)
# Tell Flask-Principal the user is anonymous
identity_changed.send(current_app._get_current_object(),
identity=AnonymousIdentity())
flash(gettext("Logged out successfully."), 'success')
return redirect(url_for('login'))
@app.route('/signup', methods=['GET', 'POST'])
def signup():
"""
Signup page.
"""
if int(os.environ.get("SELF_REGISTRATION", 0)) != 1:
flash(gettext("Self-registration is disabled."), 'warning')
return redirect(url_for('home'))
if g.user is not None and g.user.is_authenticated:
return redirect(url_for('home'))
form = SignupForm()
if form.validate_on_submit():
role_user = Role.query.filter(Role.name == "user").first()
user = User(nickname=form.nickname.data,
email=form.email.data,
pwdhash=generate_password_hash(form.password.data))
user.roles = [role_user]
db.session.add(user)
try:
db.session.commit()
except IntegrityError:
flash(gettext('Email already used.'), 'warning')
return render_template('signup.html', form=form)
# Send the confirmation email
try:
notifications.new_account_notification(user)
except Exception as error:
flash(gettext('Problem while sending activation email: %(error)s',
error=error), 'danger')
return redirect(url_for('home'))
flash(gettext('Your account has been created. '
'Check your mail to confirm it.'), 'success')
return redirect(url_for('home'))
return render_template('signup.html', form=form)
@etag_match
def render_home(filters=None, head_titles=None,
page_to_render='home', **kwargs):
if filters is None:
filters = {}
if head_titles is None:
head_titles = []
feed_contr = FeedController(g.user.id)
arti_contr = ArticleController(g.user.id)
feeds = {feed.id: feed.title for feed in feed_contr.read()}
in_error = {feed.id: feed.error_count for feed in
feed_contr.read(error_count__gt=2)}
filter_ = request.args.get('filter_',
'unread' if page_to_render == 'home' else 'all')
sort_ = request.args.get('sort_', 'date')
feed_id = int(request.args.get('feed_id', 0))
limit = request.args.get('limit', 1000)
if filter_ != 'all':
filters['readed'] = filter_ == 'read'
if feed_id:
filters['feed_id'] = feed_id
head_titles.append(feed_contr.get(id=feed_id).title)
sort_param = {"feed": Feed.title.desc(),
"date": Article.date.desc(),
"article": Article.title.desc(),
"-feed": Feed.title.asc(),
"-date": Article.date.asc(),
"-article": Article.title.asc()
}.get(sort_, Article.date.desc())
articles = arti_contr.read(**filters).join(Article.source). \
order_by(sort_param)
if limit != 'all':
limit = int(limit)
articles = articles.limit(limit)
def gen_url(filter_=filter_, sort_=sort_, limit=limit, feed_id=feed_id,
**kwargs):
o_kwargs = OrderedDict()
for key in sorted(kwargs):
o_kwargs[key] = kwargs[key]
if page_to_render == 'search':
o_kwargs['query'] = request.args.get('query', '')
o_kwargs['search_title'] = request.args.get('search_title', 'off')
o_kwargs['search_content'] = request.args.get(
'search_content', 'off')
# if nor title and content are selected, selecting title
if o_kwargs['search_title'] == o_kwargs['search_content'] == 'off':
o_kwargs['search_title'] = 'on'
o_kwargs['filter_'] = filter_
o_kwargs['sort_'] = sort_
o_kwargs['limit'] = limit
o_kwargs['feed_id'] = feed_id
return url_for(page_to_render, **o_kwargs)
articles = list(articles)
if (page_to_render == 'home' and feed_id or page_to_render == 'search') \
and filter_ != 'all' and not articles:
return redirect(gen_url(filter_='all'))
return render_template('home.html', gen_url=gen_url,
feed_id=feed_id, page_to_render=page_to_render,
filter_=filter_, limit=limit, feeds=feeds,
unread=arti_contr.count_by_feed(readed=False),
articles=articles, in_error=in_error,
head_titles=head_titles, sort_=sort_, **kwargs)
@app.route('/')
@login_required
def home():
"Home page for connected users. Displays by default unread articles."
return render_home()
@app.route('/favorites')
@login_required
def favorites():
return render_home({'like': True}, [gettext('Favorites')], 'favorites')
@app.route('/search', methods=['GET'])
@login_required
def search():
"Search articles corresponding to the query."
if 'query' not in request.args:
flash(gettext("No text to search were provided."), "warning")
return render_home()
query = request.args['query']
filters = {}
search_title = request.args.get('search_title', 'off')
search_content = request.args.get('search_content', 'off')
if search_title == 'on':
filters['title__ilike'] = "%%%s%%" % query
if search_content == 'on':
filters['content__ilike'] = "%%%s%%" % query
if len(filters) == 0:
search_title = 'on'
filters['title__ilike'] = "%%%s%%" % query
if len(filters) > 1:
filters = {"__or__": filters}
return render_home(filters, ["%s %s" % (gettext('Search:'), query)],
'search', search_query=query, search_title=search_title,
search_content=search_content)
@app.route('/fetch', methods=['GET'])
@app.route('/fetch/', methods=['GET'])
@login_required
def fetch(feed_id=None):
"""
Triggers the download of news.
News are downloaded in a separated process, mandatory for Heroku.
"""
if conf.CRAWLING_METHOD == "classic" \
and (not conf.ON_HEROKU or g.user.is_admin()):
utils.fetch(g.user.id, feed_id)
flash(gettext("Downloading articles..."), "info")
else:
flash(gettext("The manual retrieving of news is only available " +
"for administrator, on the Heroku platform."), "info")
return redirect(redirect_url())
@app.route('/about', methods=['GET'])
@etag_match
def about():
"""
'About' page.
"""
return render_template('about.html')
@app.route('/mark_as/', methods=['GET'])
@app.route('/mark_as//article/', methods=['GET'])
@login_required
@feed_access_required
def mark_as(new_value='read', feed_id=None, article_id=None):
"""
Mark all unreaded articles as read.
"""
readed = new_value == 'read'
articles = Article.query.filter(Article.user_id == g.user.id)
if feed_id is not None:
articles = articles.filter(Article.feed_id == feed_id)
message = 'Feed marked as %s.'
elif article_id is not None:
articles = articles.filter(Article.id == article_id)
message = 'Article marked as %s.'
else:
message = 'All article marked as %s.'
articles.filter(Article.readed == (not readed)).update({"readed": readed})
flash(gettext(message % new_value), 'info')
db.session.commit()
if readed:
return redirect(redirect_url())
return redirect(url_for('home'))
@app.route('/like/', methods=['GET'])
@login_required
def like(article_id=None):
"""
Mark or unmark an article as favorites.
"""
Article.query.filter(Article.user_id == g.user.id, Article.id == article_id). \
update({
"like": not Article.query.filter(Article.id == article_id).first().like
})
db.session.commit()
return redirect(redirect_url())
@app.route('/delete/', methods=['GET'])
@login_required
def delete(article_id=None):
"""
Delete an article from the database.
"""
article = Article.query.filter(Article.id == article_id).first()
if article is not None and article.source.subscriber.id == g.user.id:
db.session.delete(article)
db.session.commit()
flash(gettext('Article') + ' ' + article.title + ' ' + gettext('deleted.'), 'success')
return redirect(redirect_url())
else:
flash(gettext('This article do not exist.'), 'danger')
return redirect(url_for('home'))
@app.route('/inactives', methods=['GET'])
@login_required
def inactives():
"""
List of inactive feeds.
"""
nb_days = int(request.args.get('nb_days', 365))
user = UserController(g.user.id).get(email=g.user.email)
today = datetime.datetime.now()
inactives = []
for feed in user.feeds:
try:
last_post = feed.articles[0].date
except IndexError:
continue
elapsed = today - last_post
if elapsed > datetime.timedelta(days=nb_days):
inactives.append((feed, elapsed))
inactives.sort(key=lambda tup: tup[1], reverse=True)
return render_template('inactives.html', inactives=inactives, nb_days=nb_days)
@app.route('/duplicates/', methods=['GET'])
@login_required
def duplicates(feed_id=None):
"""
Return duplicates article for a feed.
"""
feed = Feed.query.filter(Feed.user_id == g.user.id, Feed.id == feed_id).first()
duplicates = []
duplicates = utils.compare_documents(feed)
if len(duplicates) == 0:
flash(gettext('No duplicates in the feed "{}".').format(feed.title),
'info')
return redirect(redirect_url())
return render_template('duplicates.html', duplicates=duplicates, feed=feed)
@app.route('/export', methods=['GET'])
@login_required
def export_articles():
"""
Export all articles to HTML or JSON.
"""
user = UserController(g.user.id).get(id=g.user.id)
if request.args.get('format') == "HTML":
# Export to HTML
try:
archive_file, archive_file_name = export.export_html(user)
except:
flash(gettext("Error when exporting articles."), 'danger')
return redirect(redirect_url())
response = make_response(archive_file)
response.headers['Content-Type'] = 'application/x-compressed'
response.headers['Content-Disposition'] = 'attachment; filename=%s' \
% archive_file_name
elif request.args.get('format') == "JSON":
# Export to JSON
try:
json_result = export.export_json(user)
except:
flash(gettext("Error when exporting articles."), 'danger')
return redirect(redirect_url())
response = make_response(json_result)
response.mimetype = 'application/json'
response.headers["Content-Disposition"] = 'attachment; filename=account.json'
else:
flash(gettext('Export format not supported.'), 'warning')
return redirect(redirect_url())
return response
@app.route('/export_opml', methods=['GET'])
@login_required
def export_opml():
"""
Export all feeds to OPML.
"""
user = UserController(g.user.id).get(id=g.user.id)
response = make_response(render_template('opml.xml', user=user,
now=datetime.datetime.now()))
response.headers['Content-Type'] = 'application/xml'
response.headers['Content-Disposition'] = 'attachment; filename=feeds.opml'
return response
@app.route('/management', methods=['GET', 'POST'])
@login_required
def management():
"""
Display the management page.
"""
if request.method == 'POST':
if None != request.files.get('opmlfile', None):
# Import an OPML file
data = request.files.get('opmlfile', None)
if not utils.allowed_file(data.filename):
flash(gettext('File not allowed.'), 'danger')
else:
try:
nb = utils.import_opml(g.user.email, data.read())
if conf.CRAWLING_METHOD == "classic":
utils.fetch(g.user.email, None)
flash(str(nb) + ' ' + gettext('feeds imported.'),
"success")
flash(gettext("Downloading articles..."), 'info')
except:
flash(gettext("Impossible to import the new feeds."),
"danger")
elif None != request.files.get('jsonfile', None):
# Import an account
data = request.files.get('jsonfile', None)
if not utils.allowed_file(data.filename):
flash(gettext('File not allowed.'), 'danger')
else:
try:
nb = utils.import_json(g.user.email, data.read())
flash(gettext('Account imported.'), "success")
except:
flash(gettext("Impossible to import the account."),
"danger")
else:
flash(gettext('File not allowed.'), 'danger')
nb_feeds = len(g.user.feeds.all())
articles = Article.query.filter(Article.user_id == g.user.id)
nb_articles = articles.count()
nb_unread_articles = articles.filter(Article.readed == False).count()
return render_template('management.html', user=g.user,
nb_feeds=nb_feeds, nb_articles=nb_articles,
nb_unread_articles=nb_unread_articles)
@app.route('/history', methods=['GET'])
@app.route('/history/', methods=['GET'])
@app.route('/history//', methods=['GET'])
@login_required
def history(year=None, month=None):
articles_counter, articles = utils.history(g.user.id, year, month)
return render_template('history.html',
articles_counter=articles_counter,
articles=articles,
year=year, month=month)
@app.route('/profile', methods=['GET', 'POST'])
@login_required
def profile():
"""
Edit the profile of the currently logged user.
"""
user = UserController(g.user.id).get(id=g.user.id)
form = ProfileForm()
if request.method == 'POST':
if form.validate():
form.populate_obj(user)
if form.password.data != "":
user.set_password(form.password.data)
db.session.commit()
flash("%s %s %s" % (gettext('User'), user.nickname,
gettext('successfully updated.')),
'success')
return redirect(url_for('profile'))
else:
return render_template('profile.html', user=user, form=form)
if request.method == 'GET':
form = ProfileForm(obj=user)
return render_template('profile.html', user=user, form=form)
@app.route('/delete_account', methods=['GET'])
@login_required
def delete_account():
"""
Delete the account of the user (with all its data).
"""
user = UserController(g.user.id).get(id=g.user.id)
if user is not None:
db.session.delete(user)
db.session.commit()
flash(gettext('Your account has been deleted.'), 'success')
else:
flash(gettext('This user does not exist.'), 'danger')
return redirect(url_for('login'))
@app.route('/expire_articles', methods=['GET'])
@login_required
def expire_articles():
"""
Delete articles older than the given number of weeks.
"""
weeks_ago = datetime.datetime.utcnow() - \
datetime.timedelta(weeks=int(request.args.get('weeks', 10)))
Article.query.filter(
and_(Article.user_id == g.user.id,
or_(Article.date < weeks_ago,
Article.retrieved_date < weeks_ago))).delete()
flash(gettext('Articles deleted.'), 'info')
db.session.commit()
return redirect(redirect_url())
@app.route('/confirm_account/', methods=['GET'])
def confirm_account(activation_key=None):
"""
Confirm the account of a user.
"""
if activation_key != "":
user = User.query.filter(User.activation_key == activation_key).first()
if user is not None:
user.activation_key = ""
db.session.commit()
flash(gettext('Your account has been confirmed.'), 'success')
else:
flash(gettext('Impossible to confirm this account.'), 'danger')
return redirect(url_for('login'))
@app.route('/recover', methods=['GET', 'POST'])
def recover():
"""
Enables the user to recover its account when he has forgotten
its password.
"""
form = RecoverPasswordForm()
if request.method == 'POST':
if form.validate():
user = User.query.filter(User.email == form.email.data).first()
characters = string.ascii_letters + string.digits
password = "".join(random.choice(characters) for x in range(random.randint(8, 16)))
user.set_password(password)
db.session.commit()
# Send the confirmation email
try:
notifications.new_password_notification(user, password)
flash(gettext('New password sent to your address.'), 'success')
except Exception as e:
flash(gettext('Problem while sending your new password.') + ': ' + str(e), 'danger')
return redirect(url_for('login'))
return render_template('recover.html', form=form)
if request.method == 'GET':
return render_template('recover.html', form=form)
#
# Views dedicated to administration tasks.
#
@app.route('/admin/dashboard', methods=['GET', 'POST'])
@login_required
@admin_permission.require(http_exception=403)
def dashboard():
"""
Adminstrator's dashboard.
"""
form = InformationMessageForm()
if request.method == 'POST':
if form.validate():
try:
notifications.information_message(form.subject.data, form.message.data)
except Exception as e:
flash(gettext('Problem while sending email') + ': ' + str(e), 'danger')
users = User.query.all()
return render_template('admin/dashboard.html', users=users, current_user=g.user, form=form)
@app.route('/admin/create_user', methods=['GET', 'POST'])
@app.route('/admin/edit_user/', methods=['GET', 'POST'])
@login_required
@admin_permission.require(http_exception=403)
def create_user(user_id=None):
"""
Create or edit a user.
"""
form = UserForm()
if request.method == 'POST':
if form.validate():
role_user = Role.query.filter(Role.name == "user").first()
if user_id is not None:
# Edit a user
user = User.query.filter(User.id == user_id).first()
form.populate_obj(user)
if form.password.data != "":
user.set_password(form.password.data)
db.session.commit()
flash(gettext('User') + ' ' + user.nickname + ' ' + gettext('successfully updated.'), 'success')
else:
# Create a new user
user = User(nickname=form.nickname.data,
email=form.email.data,
pwdhash=generate_password_hash(form.password.data))
user.roles.extend([role_user])
user.activation_key = ""
db.session.add(user)
db.session.commit()
flash("%s %s %s" % (gettext('User'), user.nickname,
gettext('successfully created.')),
'success')
return redirect(url_for('create_user', user_id=user.id))
else:
return redirect(url_for('create_user'))
if request.method == 'GET':
if user_id is not None:
user = User.query.filter(User.id == user_id).first()
form = UserForm(obj=user)
message = "%s %s" % (gettext('Edit the user'),
user.nickname)
else:
form = UserForm()
message = gettext('Add a new user')
return render_template('/admin/create_user.html',
form=form, message=message)
@app.route('/admin/user/', methods=['GET'])
@login_required
@admin_permission.require(http_exception=403)
def user(user_id=None):
"""
See information about a user (stations, etc.).
"""
user = UserController().get(id=user_id)
if user is not None:
article_contr = ArticleController(user_id)
return render_template('/admin/user.html', user=user, feeds=user.feeds,
article_count=article_contr.count_by_feed(),
unread_article_count=article_contr.count_by_feed(readed=False))
else:
flash(gettext('This user does not exist.'), 'danger')
return redirect(redirect_url())
@app.route('/admin/delete_user/', methods=['GET'])
@login_required
@admin_permission.require(http_exception=403)
def delete_user(user_id=None):
"""
Delete a user (with all its data).
"""
user = User.query.filter(User.id == user_id).first()
if user is not None:
db.session.delete(user)
db.session.commit()
flash(gettext('User') + ' ' + user.nickname + ' ' + gettext('successfully deleted.'), 'success')
else:
flash(gettext('This user does not exist.'), 'danger')
return redirect(redirect_url())
@app.route('/admin/enable_user/', methods=['GET'])
@app.route('/admin/disable_user/', methods=['GET'])
@login_required
@admin_permission.require()
def disable_user(user_id=None):
"""
Enable or disable the account of a user.
"""
user = User.query.filter(User.id == user_id).first()
if user is not None:
if user.activation_key != "":
# Send the confirmation email
try:
notifications.new_account_activation(user)
user.activation_key = ""
flash(gettext('Account of the user') + ' ' + user.nickname + ' ' + gettext('successfully activated.'), 'success')
except Exception as e:
flash(gettext('Problem while sending activation email') + ': ' + str(e), 'danger')
else:
user.activation_key = hashlib.sha512(str(random.getrandbits(256)).encode("utf-8")).hexdigest()[:86]
flash(gettext('Account of the user') + ' ' + user.nickname + ' ' + gettext('successfully disabled.'), 'success')
db.session.commit()
else:
flash(gettext('This user does not exist.'), 'danger')
return redirect(redirect_url())