Page MenuHomec4science
Files F91462407

webcomment_blueprint.py
No OneTemporary
Actions

File Metadata

Created
Mon, Nov 11, 08:56

webcomment_blueprint.py
View Options

# -*- coding: utf-8 -*-
##
## This file is part of Invenio.
## Copyright (C) 2012 CERN.
##
## Invenio is free software; you can redistribute it and/or
## modify it under the terms of the GNU General Public License as
## published by the Free Software Foundation; either version 2 of the
## License, or (at your option) any later version.
##
## Invenio 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
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Invenio; if not, write to the Free Software Foundation, Inc.,
## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
"""WebSearch Flask Blueprint"""
import datetime
import pprint
from functools import wraps
from string import rfind, strip
from datetime import datetime
from hashlib import md5
from flask import Blueprint, session, make_response, g, render_template, \
request, flash, jsonify, redirect, url_for, current_app
from invenio.cache import cache
from invenio.intbitset import intbitset as HitSet
from invenio.sqlalchemyutils import db
from invenio.websearch_model import Collection, CollectionCollection
from invenio.webmessage_mailutils import email_quote_txt
from invenio.websession_model import User
from invenio.webcomment_model import CmtRECORDCOMMENT, CmtSUBSCRIPTION, \
CmtACTIONHISTORY
from invenio.webcomment_forms import AddCmtRECORDCOMMENTForm, \
AddCmtRECORDCOMMENTFormReview
from invenio.webinterface_handler_flask_utils import _, InvenioBlueprint, \
register_template_context_processor
from invenio.webuser_flask import current_user
from invenio.config import CFG_PREFIX, \
CFG_SITE_LANG, \
CFG_WEBALERT_ALERT_ENGINE_EMAIL,\
CFG_SITE_SUPPORT_EMAIL,\
CFG_WEBCOMMENT_ALERT_ENGINE_EMAIL,\
CFG_SITE_URL,\
CFG_SITE_NAME,\
CFG_SITE_RECORD, \
CFG_WEBCOMMENT_ALLOW_REVIEWS,\
CFG_WEBCOMMENT_ALLOW_SHORT_REVIEWS,\
CFG_WEBCOMMENT_ALLOW_COMMENTS,\
CFG_WEBCOMMENT_ADMIN_NOTIFICATION_LEVEL,\
CFG_WEBCOMMENT_NB_REPORTS_BEFORE_SEND_EMAIL_TO_ADMIN,\
CFG_WEBCOMMENT_TIMELIMIT_PROCESSING_COMMENTS_IN_SECONDS,\
CFG_WEBCOMMENT_DEFAULT_MODERATOR, \
CFG_SITE_RECORD, \
CFG_WEBCOMMENT_EMAIL_REPLIES_TO, \
CFG_WEBCOMMENT_ROUND_DATAFIELD, \
CFG_WEBCOMMENT_RESTRICTION_DATAFIELD, \
CFG_WEBCOMMENT_MAX_COMMENT_THREAD_DEPTH
from invenio.webcomment_config import CFG_WEBCOMMENT_ACTION_CODE
from invenio.access_control_engine import acc_authorize_action
blueprint = InvenioBlueprint('webcomment', __name__,
url_prefix="/"+CFG_SITE_RECORD,
config='invenio.webcomment_config',
#breadcrumbs=[(_('Comments'),
# 'webcomment.subscribtions')],
menubuilder=[('main.personalize.comment_subscriptions',
_('Your comment subscriptions'),
'webcomment.subscriptions', 20)])
from invenio.record_blueprint import request_record
def log_comment_action(action_code, id, recid, uid=None):
action = CmtACTIONHISTORY(
id_cmtRECORDCOMMENT = id,
id_bibrec = recid,
id_user = uid or current_user.get_id(),
client_host = socket.inet_aton(request.remote_addr),
action_time = datetime.now(),
action_code = action_code)
db.session.add(action)
db.session.commit()
class CommentRights(object):
def __init__(self, comment, uid = None):
self.id = comment
self.uid = uid or current_user.get_id()
self.id_collection = 0#FIXME
def can_perform_action(self, action=None):
cond = CmtACTIONHISTORY.id_user == self.uid \
if self.uid>0 else \
CmtACTIONHISTORY.client_host == socket.inet_aton(request.remote_addr)
if action in CFG_WEBCOMMENT_ACTION_CODE:
cond = db.and_(cond, CmtACTIONHISTORY.action_code == \
CFG_WEBCOMMENT_ACTION_CODE[action])
return CmtACTIONHISTORY.query.filter(
CmtACTIONHISTORY.id_cmtRECORDCOMMENT==self.id, cond).\
count() == 0
def can_view_restricted_comment(self, restriction):
#restriction = self.comment.restriction
if restriction == "":
return (0, '')
return acc_authorize_action(
self.uid,
'viewrestrcomment',
status=restriction)
def can_send_comment(self):
return acc_authorize_action(
self.uid,
'sendcomment',
authorized_if_no_roles=True,
collection=self.id_collection)
def can_attach_comment_file(self):
return acc_authorize_action(
self.uid,
'attachcommentfile',
authorized_if_no_roles=False,
collection=self.id__collection)
@blueprint.route('/<int:recid>/comments/add', methods=['GET', 'POST'])
@request_record
#@blueprint.invenio_authentificated
@blueprint.invenio_authorized('sendcomment',
authorized_if_no_roles=True,
collection=lambda: g.collection.id)
def add_comment(recid):
uid = current_user.get_id()
in_reply = request.args.get('in_reply', type=int)
if in_reply is not None:
comment = CmtRECORDCOMMENT.query.get(in_reply)
if comment is not None:
c = CmtRECORDCOMMENT()
c.title = _('Re: ') + comment.title
c.body = email_quote_txt(comment.body or '')
c.in_reply_to_id_cmtRECORDCOMMENT = in_reply
form = AddCmtRECORDCOMMENTForm(request.form, obj=c)
return render_template('webcomment_add.html', form=form)
form = AddCmtRECORDCOMMENTForm(request.values)
if form.validate_on_submit():
c = CmtRECORDCOMMENT()
form.populate_obj(c)
c.id_bibrec = recid
c.id_user = uid
c.date_creation = datetime.now()
c.star_score = 0
try:
db.session.add(c)
db.session.commit()
flash(_('Comment was sent'), "info")
return redirect(url_for('webcomment.comments', recid=recid))
except:
db.session.rollback()
return render_template('webcomment_add.html', form=form)
@blueprint.route('/<int:recid>/reviews/add', methods=['GET', 'POST'])
@request_record
#@blueprint.invenio_authentificated
@blueprint.invenio_authorized('sendcomment',
authorized_if_no_roles=True,
collection=lambda: g.collection.id)
def add_review(recid):
uid = current_user.get_id()
form = AddCmtRECORDCOMMENTFormReview(request.values)
if form.validate_on_submit():
c = CmtRECORDCOMMENT()
form.populate_obj(c)
c.id_bibrec = recid
c.id_user = uid
c.date_creation = datetime.now()
try:
db.session.add(c)
db.session.commit()
flash(_('Review was sent'), "info")
return redirect(url_for('webcomment.reviews', recid=recid))
except:
db.session.rollback()
return render_template('webcomment_add_review.html', form=form)
@blueprint.route('/<int:recid>/comments', methods=['GET', 'POST'])
@request_record
def comments(recid):
uid = current_user.get_id()
comments = CmtRECORDCOMMENT.query.filter(db.and_(
CmtRECORDCOMMENT.id_bibrec == recid,
CmtRECORDCOMMENT.in_reply_to_id_cmtRECORDCOMMENT == 0,
CmtRECORDCOMMENT.star_score == 0
)).all()
return render_template('webcomment_comments.html', comments=comments)
@blueprint.route('/<recid>/reviews', methods=['GET', 'POST'])
#@blueprint.invenio_templated('webcomment_display.html')
@request_record
def reviews(recid):
uid = current_user.get_id()
comments = CmtRECORDCOMMENT.query.filter(db.and_(
CmtRECORDCOMMENT.id_bibrec == recid,
CmtRECORDCOMMENT.in_reply_to_id_cmtRECORDCOMMENT == 0,
CmtRECORDCOMMENT.star_score > 0
)).all()
return render_template('webcomment_reviews.html', comments=comments)
import socket
@blueprint.route('/<int:recid>/report/<int:id>', methods=['GET', 'POST'])
@request_record
def report(recid, id):
if CommentRights(id).can_perform_action():
CmtRECORDCOMMENT.query.filter(CmtRECORDCOMMENT.id==id).update(dict(
nb_abuse_reports = CmtRECORDCOMMENT.nb_abuse_reports+1),
synchronize_session='fetch')
log_comment_action(CFG_WEBCOMMENT_ACTION_CODE['REPORT_ABUSE'], id, recid)
flash(_('Comment has been reported.'), 'success')
else:
flash(_('Comment has been already reported.'), 'error')
return redirect(url_for('webcomment.comments', recid=recid))
@blueprint.route('/<int:recid>/vote/<int:id>/<value>',
methods=['GET', 'POST'])
@request_record
def vote(recid, id, value):
if CommentRights(id).can_perform_action():
value = 1 if int(value) > 0 else 0
CmtRECORDCOMMENT.query.filter(
CmtRECORDCOMMENT.id==id).update(dict(
nb_votes_total = CmtRECORDCOMMENT.nb_votes_total+1,
nb_votes_yes = CmtRECORDCOMMENT.nb_votes_yes + value),
synchronize_session='fetch')
log_comment_action(CFG_WEBCOMMENT_ACTION_CODE['VOTE'], id, recid)
flash(_('Thank you for your vote.'), 'success')
else:
flash(_('You can not vote for this comment.'), 'error')
return redirect(url_for('webcomment.comments', recid=recid))
@blueprint.route('/<recid>/comments/subscribe', methods=['GET', 'POST'])
@blueprint.invenio_authenticated
@request_record
def subscribe(recid):
uid = current_user.get_id()
subscription = CmtSUBSCRIPTION(id_bibrec=recid, id_user=uid,
creation_time=datetime.now())
try:
db.session.add(subscription)
db.session.commit()
flash(_('You have been successfully subscribed'), 'success')
except:
flash(_('You are already subscribed'), 'error')
return redirect(url_for('.comments', recid=recid))
@blueprint.route('/<int:recid>/comments/unsubscribe', methods=['GET', 'POST'])
@blueprint.route('/comments/unsubscribe', methods=['GET', 'POST'])
@blueprint.invenio_authenticated
def unsubscribe(recid=None):
uid = current_user.get_id()
if recid is None:
recid = request.values.getlist('recid', type=int)
else:
recid = [recid]
current_app.logger.info(recid)
try:
db.session.query(CmtSUBSCRIPTION).filter(db.and_(
CmtSUBSCRIPTION.id_bibrec.in_(recid),
CmtSUBSCRIPTION.id_user==uid)).delete(synchronize_session=False)
db.session.commit()
flash(_('You have been successfully unsubscribed'), 'success')
except:
flash(_('You are already unsubscribed'), 'error')
if len(recid) == 1:
return redirect(url_for('.comments', recid=recid[0]))
else:
return redirect(url_for('.subscriptions'))
#FIXME replace by Record `get title` when available
from invenio.search_engine_utils import get_fieldvalues
@blueprint.invenio_set_breadcrumb(_("Your comment subscriptions"))
@blueprint.route('/comments/subscriptions', methods=['GET', 'POST'])
@blueprint.invenio_authenticated
def subscriptions():
uid = current_user.get_id()
all = CmtSUBSCRIPTION.query.filter(CmtSUBSCRIPTION.id_user==uid).all()
@register_template_context_processor
def get_title():
return dict(get_title = lambda r: get_fieldvalues(r, '245__a')[0])
return render_template('webcomment_subscriptions.html', subscriptions=all)

Event Timeline

c4science · Help