' + link_open = '' + out += _("You can now go back to %(x_url_open)sBibEdit Admin Interface%(x_url_close)s.") % {'x_url_open': link_open, 'x_url_close': ''} + return out def tmpl_deleted(self, ln, message='', recid='', temp='', format_tag=''): """ Return a deleted message of Bibedit. """ _ = gettext_set_language(ln) if message == 1: return """ %(message)s
' + link_open = '' + out += _("You can now go back to %(x_url_open)sBibEdit Admin Interface%(x_url_close)s.") % {'x_url_open': link_open, 'x_url_close': ''} return out def tmpl_link(self, ln, text, url, dest, dict_args='', ancre=''): """ Return a link. """ if dict_args == '': link_args = '' else: link_args = '?' list_args = dict_args.items() for arg in list_args: link_args += "%(name)s=%(value)s&" % {'name' : str(arg[0]), - 'value' : str(arg[1])} + 'value' : str(arg[1])} link_args += "ln=%s" % ln if ancre != '': ancre = '#' + ancre return ' %(text)s ' % {'text' : text, 'url' : url, 'dest' : dest, 'args' : link_args, 'ancre' : ancre} def tmpl_input(self, type_input, value='', name='', maxlength='', size='', class_css='', style=''): """ Return a input form. """ if value != '': value = 'value="%s"' % str(value) if name != '': name = 'name="%s"' % str(name) if maxlength != '': maxlength = 'maxlength="%s"' % str(maxlength) if size != '': size = 'size="%s"' % str(size) if class_css != '': class_css = 'class="%s"' % str(class_css) if style != '': style = 'style="%s"' % str(style) out = '' out %= {'type' : type_input, 'value' : value, 'name' : name, 'maxlength' : maxlength, 'size' : size, 'class_css' : class_css, 'style' : style} return out diff --git a/modules/webalert/lib/webalert.py b/modules/webalert/lib/webalert.py index a010d6c15..142e7b750 100644 --- a/modules/webalert/lib/webalert.py +++ b/modules/webalert/lib/webalert.py @@ -1,370 +1,370 @@ ## $Id$ ## This file is part of CDS Invenio. ## Copyright (C) 2002, 2003, 2004, 2005, 2006 CERN. ## ## CDS 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. ## ## CDS 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 CDS Invenio; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. """PERSONAL FEATURES - YOUR ALERTS""" import cgi import time from invenio.config import weburl, cdslang from invenio.dbquery import run_sql from invenio.webuser import isGuestUser from invenio.webaccount import warning_guest_user from invenio.webbasket import create_personal_baskets_selection_box from invenio.messages import gettext_set_language from invenio.dateutils import convert_datestruct_to_datetext, convert_datetext_to_dategui import invenio.template webalert_templates = invenio.template.load('webalert') ### IMPLEMENTATION class AlertError(Exception): pass def check_alert_name(alert_name, uid, ln=cdslang): """check this user does not have another alert with this name.""" sql = """select id_query from user_query_basket where id_user=%s and alert_name='%s'"""%(uid, alert_name.strip()) res = run_sql( sql ) # load the right message language _ = gettext_set_language(ln) if len( run_sql( sql ) ) > 0: raise AlertError( _("You already have an alert named %s.") % ('' + alert_name + '',) ) def get_textual_query_info_from_urlargs(urlargs, ln=cdslang): """Return nicely formatted search pattern and catalogue from urlargs of the search query. Suitable for 'your searches' display.""" out = "" args = cgi.parse_qs(urlargs) return webalert_templates.tmpl_textual_query_info_from_urlargs( ln = ln, args = args, ) return out def perform_display(permanent, uid, ln=cdslang): """display the searches performed by the current user input: default permanent="n"; permanent="y" display permanent queries(most popular) output: list of searches in formatted html """ # load the right message language _ = gettext_set_language(ln) # first detect number of queries: nb_queries_total = 0 nb_queries_distinct = 0 id_queries_distinct = [] query = "SELECT COUNT(*),COUNT(DISTINCT(id_query)) FROM user_query WHERE id_user=%s" res = run_sql(query, (uid,), 1) try: nb_queries_total = res[0][0] nb_queries_distinct = res[0][1] except: pass # query for queries: if permanent == "n": SQL_query = "SELECT DISTINCT(q.id),q.urlargs "\ "FROM query q, user_query uq "\ "WHERE uq.id_user='%s' "\ "AND uq.id_query=q.id "\ "ORDER BY q.id DESC" % uid else: # permanent="y" SQL_query = "SELECT q.id,q.urlargs "\ "FROM query q "\ "WHERE q.type='p'" query_result = run_sql(SQL_query) queries = [] if len(query_result) > 0: for row in query_result : if permanent == "n": res = run_sql("SELECT DATE_FORMAT(MAX(date),'%%Y-%%m-%%d %%H:%%i:%%s') FROM user_query WHERE id_user=%s and id_query=%s", (uid, row[0])) try: lastrun = res[0][0] except: lastrun = _("unknown") else: lastrun = "" queries.append({ 'id' : row[0], 'args' : row[1], 'textargs' : get_textual_query_info_from_urlargs(row[1], ln=ln), 'lastrun' : lastrun, }) return webalert_templates.tmpl_display_alerts( ln = ln, permanent = permanent, nb_queries_total = nb_queries_total, nb_queries_distinct = nb_queries_distinct, queries = queries, guest = isGuestUser(uid), guesttxt = warning_guest_user(type="alerts", ln=ln), weburl = weburl ) def perform_input_alert(action, id_query, alert_name, frequency, notification, id_basket,uid, old_id_basket=None, ln = cdslang): """get the alert settings input: action="add" for a new alert (blank form), action="modify" for an update (get old values) id_query id the identifier of the search to be alerted for the "modify" action specify old alert_name, frequency of checking, e-mail notification and basket id. output: alert settings input form""" # display query information res = run_sql("SELECT urlargs FROM query WHERE id=%s", (id_query,)) try: urlargs = res[0][0] except: urlargs = "UNKNOWN" baskets = create_personal_baskets_selection_box(uid=uid, html_select_box_name='idb', selected_bskid=old_id_basket, ln=cdslang) return webalert_templates.tmpl_input_alert( ln = ln, query = get_textual_query_info_from_urlargs(urlargs, ln = ln), action = action, frequency = frequency, notification = notification, alert_name = alert_name, baskets = baskets, old_id_basket = old_id_basket, id_basket = id_basket, id_query = id_query, ) def check_alert_is_unique(id_basket, id_query, uid, ln=cdslang ): """check the user does not have another alert for the specified query and basket""" _ = gettext_set_language(ln) sql = """select id_query from user_query_basket where id_user = %s and id_query = %s and id_basket= %s"""%(uid, id_query, id_basket) res = run_sql(sql) if len(res): raise AlertError(_("You already have an alert defined for the specified query and basket.")) def perform_add_alert(alert_name, frequency, notification, id_basket, id_query, uid, ln = cdslang): """add an alert to the database input: the name of the new alert; alert frequency: 'month', 'week' or 'day'; setting for e-mail notification: 'y' for yes, 'n' for no; basket identifier: 'no' for no basket; new basket name for this alert; identifier of the query to be alerted output: confirmation message + the list of alerts Web page""" alert_name = alert_name.strip() # load the right message language _ = gettext_set_language(ln) #check the alert name is not empty if alert_name.strip() == "": raise AlertError(_("The alert name cannot be empty.")) #check if the alert can be created check_alert_name(alert_name, uid, ln) check_alert_is_unique(id_basket, id_query, uid, ln) # add a row to the alerts table: user_query_basket query = """INSERT INTO user_query_basket (id_user, id_query, id_basket, frequency, date_creation, date_lastrun, alert_name, notification) VALUES ('%s','%s','%s','%s','%s','','%s','%s')""" query %= (uid, id_query, id_basket, frequency, convert_datestruct_to_datetext(time.localtime()), alert_name, notification) run_sql(query) out = _("The alert %s has been added to your profile.") out %= '' + alert_name + '' out += perform_list_alerts(uid, ln=ln) return out def perform_list_alerts (uid, ln=cdslang): """perform_list_alerts display the list of alerts for the connected user""" # set variables out = "" # query the database query = """ SELECT q.id, q.urlargs, a.id_basket, b.name, a.alert_name, a.frequency,a.notification, DATE_FORMAT(a.date_creation,'%%Y-%%m-%%d %%H:%%i:%%s'), DATE_FORMAT(a.date_lastrun,'%%Y-%%m-%%d %%H:%%i:%%s') FROM user_query_basket a LEFT JOIN query q ON a.id_query=q.id LEFT JOIN bskBASKET b ON a.id_basket=b.id WHERE a.id_user='%s' ORDER BY a.alert_name ASC """ % uid res = run_sql(query) alerts = [] for (qry_id, qry_args, bsk_id, bsk_name, alrt_name, alrt_frequency, alrt_notification, alrt_creation, alrt_last_run) in res: alerts.append({ 'queryid' : qry_id, 'queryargs' : qry_args, 'textargs' : get_textual_query_info_from_urlargs(qry_args, ln=ln), 'userid' : uid, 'basketid' : bsk_id, 'basketname' : bsk_name, 'alertname' : alrt_name, 'frequency' : alrt_frequency, 'notification' : alrt_notification, 'created' : convert_datetext_to_dategui(alrt_creation), 'lastrun' : convert_datetext_to_dategui(alrt_last_run) }) # link to the "add new alert" form out = webalert_templates.tmpl_list_alerts(ln=ln, weburl=weburl, alerts=alerts, guest=isGuestUser(uid), guesttxt=warning_guest_user(type="alerts", ln=ln)) return out def perform_remove_alert(alert_name, id_user, id_query, id_basket, uid, ln=cdslang): """perform_remove_alert: remove an alert from the database input: identifier of the user; identifier of the query; identifier of the basket output: confirmation message + the list of alerts Web page""" # set variables out = "" # remove a row from the alerts table: user_query_basket query = """DELETE FROM user_query_basket WHERE id_user='%s' AND id_query='%s' AND id_basket='%s'""" query %= (id_user, id_query, id_basket) run_sql(query) out += "The alert %s has been removed from your profile.
\n" % alert_name out += perform_list_alerts(uid, ln=ln) return out def perform_update_alert(alert_name, frequency, notification, id_basket, id_query, old_id_basket,uid, ln = cdslang): """update alert settings into the database input: the name of the new alert; alert frequency: 'month', 'week' or 'day'; setting for e-mail notification: 'y' for yes, 'n' for no; new basket identifier: 'no' for no basket; new basket name for this alert; identifier of the query to be alerted old identifier of the basket associated to the alert output: confirmation message + the list of alerts Web page""" #set variables out = "" # load the right message language _ = gettext_set_language(ln) #check the alert name is not empty if alert_name.strip() == "": raise AlertError(_("The alert name cannot be empty.")) #check if the alert can be created sql = """select alert_name from user_query_basket where id_user=%s and id_basket=%s and id_query=%s"""%( uid, old_id_basket, id_query ) old_alert_name = run_sql( sql )[0][0] if old_alert_name.strip()!="" and old_alert_name != alert_name: check_alert_name( alert_name, uid, ln) if id_basket != old_id_basket: check_alert_is_unique( id_basket, id_query, uid, ln) # update a row into the alerts table: user_query_basket query = """UPDATE user_query_basket SET alert_name='%s',frequency='%s',notification='%s', date_creation='%s',date_lastrun='',id_basket='%s' WHERE id_user='%s' AND id_query='%s' AND id_basket='%s'""" query %= (alert_name, frequency, notification, convert_datestruct_to_datetext(time.localtime()), id_basket, uid, id_query, old_id_basket) run_sql(query) out += _("The alert %s has been successfully updated.") % ("" + alert_name + "",) out += "
\n" + perform_list_alerts(uid, ln=ln) return out def is_selected(var, fld): "Checks if the two are equal, and if yes, returns ' selected'. Useful for select boxes." if var == fld: return " selected" else: return "" def account_list_alerts(uid, ln=cdslang): """account_list_alerts: list alert for the account page input: the user id language output: the list of alerts Web page""" query = """ SELECT q.id, q.urlargs, a.id_user, a.id_query, a.id_basket, a.alert_name, a.frequency, a.notification, DATE_FORMAT(a.date_creation,'%%d %%b %%Y'), DATE_FORMAT(a.date_lastrun,'%%d %%b %%Y'), a.id_basket FROM query q, user_query_basket a WHERE a.id_user='%s' AND a.id_query=q.id ORDER BY a.alert_name ASC """ % uid res = run_sql(query) alerts = [] if len(res): for row in res: alerts.append({ 'id' : row[0], 'name' : row[5] }) return webalert_templates.tmpl_account_list_alerts(ln=ln, alerts=alerts) def account_list_searches(uid, ln=cdslang): """ account_list_searches: list the searches of the user input: the user id output: resume of the searches""" out ="" # first detect number of queries: nb_queries_total = 0 nb_queries_distinct = 0 id_queries_distinct = [] res = run_sql("SELECT COUNT(*),COUNT(DISTINCT(id_query)) FROM user_query WHERE id_user=%s", (uid,), 1) try: nb_queries_total = res[0][0] nb_queries_distinct = res[0][1] except: pass # load the right message language _ = gettext_set_language(ln) - out += _("You have made %s queries. A %sdetailed list%s is available with a posibility to (a) view search results and (b) subscribe to an automatic email alerting service for these queries.") % (nb_queries_total, '' % ln, '') + out += _("You have made %(x_nb)s queries. A %(x_url_open)sdetailed list%(x_url_close)s is available with a posibility to (a) view search results and (b) subscribe to an automatic email alerting service for these queries.") % {'x_nb': nb_queries_total, 'x_url_open': '' % ln, 'x_url_close': ''} return out diff --git a/modules/webalert/lib/webalert_templates.py b/modules/webalert/lib/webalert_templates.py index 92deb28fc..3e3eafaab 100644 --- a/modules/webalert/lib/webalert_templates.py +++ b/modules/webalert/lib/webalert_templates.py @@ -1,549 +1,553 @@ ## $Id$ ## This file is part of CDS Invenio. ## Copyright (C) 2002, 2003, 2004, 2005, 2006 CERN. ## ## CDS 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. ## ## CDS 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 CDS Invenio; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. import urllib import time import cgi import gettext import string import locale import re import operator from invenio.config import * from invenio.messages import gettext_set_language from invenio.htmlparser import get_as_text, wrap from invenio.alert_engine_config import cfg_webalert_max_num_of_records_in_alert_email class Template: def tmpl_errorMsg(self, ln, error_msg, rest = ""): """ Adds an error message to the output Parameters: - 'ln' *string* - The language to display the interface in - 'error_msg' *string* - The error message - 'rest' *string* - The rest of the page """ # load the right message language _ = gettext_set_language(ln) out = """
%(error)s
%(rest)s""" % { 'error' : error_msg, 'rest' : rest } return out def tmpl_textual_query_info_from_urlargs(self, ln, args): """ Displays a human inteligible textual representation of a query Parameters: - 'ln' *string* - The language to display the interface in - 'args' *array* - The URL arguments array (parsed) """ # load the right message language _ = gettext_set_language(ln) out = "" if args.has_key('p'): out += "" + _("Pattern") + ": " + string.join(args['p'], "; ") + "
" if args.has_key('f'): out += "" + _("Field") + ": " + string.join(args['f'], "; ") + "
" if args.has_key('p1'): out += "" + _("Pattern 1") + ": " + string.join(args['p1'], "; ") + "
" if args.has_key('f1'): out += "" + _("Field 1") + ": " + string.join(args['f1'], "; ") + "
" if args.has_key('p2'): out += "" + _("Pattern 2") + ": " + string.join(args['p2'], "; ") + "
" if args.has_key('f2'): out += "" + _("Field 2") + ": " + string.join(args['f2'], "; ") + "
" if args.has_key('p3'): out += "" + _("Pattern 3") + ": " + string.join(args['p3'], "; ") + "
" if args.has_key('f3'): out += "" + _("Field 3") + ": " + string.join(args['f3'], "; ") + "
" if args.has_key('c'): out += "" + _("Collections") + ": " + string.join(args['c'], "; ") + "
" elif args.has_key('cc'): out += "" + _("Collection") + ": " + string.join(args['cc'], "; ") + "
" return out def tmpl_account_list_alerts(self, ln, alerts): """ Displays all the alerts in the main "Your account" page Parameters: - 'ln' *string* - The language to display the interface in - 'alerts' *array* - The existing alerts IDs ('id' + 'name' pairs) """ # load the right message language _ = gettext_set_language(ln) out = """""" % { 'show' : _("SHOW"), } return out def tmpl_input_alert(self, ln, query, alert_name, action, frequency, notification, baskets, old_id_basket, id_basket, id_query): """ Displays an alert adding form. Parameters: - 'ln' *string* - The language to display the interface in - 'query' *string* - The HTML code of the textual representation of the query (as returned ultimately by tmpl_textual_query_info_from_urlargs...) - 'alert_name' *string* - The alert name - 'action' *string* - The action to complete ('update' or 'add') - 'frequency' *string* - The frequency of alert running ('day', 'week', 'month') - 'notification' *string* - If notification should be sent by email ('y', 'n') - 'baskets' *array* - The existing baskets ('id' + 'name' pairs) - 'old_id_basket' *string* - The id of the previous basket of this alert - 'id_basket' *string* - The id of the basket of this alert - 'id_query' *string* - The id of the query associated to this alert """ # load the right message language _ = gettext_set_language(ln) out = "" out += """
| %(notify_cond)s | ||
| %(query_text)s: | %(query)s | |
' + _("Set a new alert from %syour searches%s, the %spopular_searches%s, or the input form.") + '
' - out %= ('' % ln, '', - """""" % ln, '') + out = '' + _("Set a new alert from %(x_url1_open)syour searches%(x_url_close)s, the %(x_url2_open)spopular_searches%(x_url_close)s, or the input form.") + '
' + out %= {'x_url1_open': '', + 'x_url2_open': '', + 'x_url_close': ''} if len(alerts): out += """| %(no)s | %(name)s | %(search_freq)s | %(notification)s | %(result_basket)s | %(date_run)s | %(date_created)s | %(query)s | %(action)s |
| #%(index)d | %(alertname)s | %(frequency)s | %(notification)s | %(basketname)s | %(lastrun)s | %(created)s | %(textargs)s |
%(remove)s %(modify)s %(search)s |
' + (_("You have defined %s alerts.") % ('' + str(len(alerts)) + '' )) + '
' if guest: out += guesttxt return out def tmpl_display_alerts(self, ln, weburl, permanent, nb_queries_total, nb_queries_distinct, queries, guest, guesttxt): """ Displays the list of alerts Parameters: - 'ln' *string* - The language to display the interface in - 'weburl' *string* - The url of CDS Invenio - 'permanent' *string* - If displaying most popular searches ('y') or only personal searches ('n') - 'nb_queries_total' *string* - The number of personal queries in the last period - 'nb_queries_distinct' *string* - The number of distinct queries in the last period - 'queries' *array* - The existing queries: - 'id' *string* - The id of the associated query - 'args' *string* - The query string - 'textargs' *string* - The textual description of the query string - 'lastrun' *string* - The last running date (only for personal queries) - 'guest' *bool* - If the user is a guest user - 'guesttxt' *string* - The HTML content of the warning box for guest users (produced by webaccount.tmpl_warning_guest_user) """ # load the right message language _ = gettext_set_language(ln) if len(queries) == 0: - out = _("You have not executed any search yet. Please go to the %ssearch interface%s first.") % ('' % (weburl, ln), - '') + out = _("You have not executed any search yet. Please go to the %(x_url_open)ssearch interface%(x_url_close)s first.") % \ + {'x_url_open': '', + 'x_url_close': ''} return out out = '' # display message: number of items in the list if permanent=="n": - msg = _("You have performed %s searches (%s different questions) during the last 30 days or so.") % (nb_queries_total, nb_queries_distinct) + msg = _("You have performed %(x_nb1)s searches (%(x_nb2)s different questions) during the last 30 days or so.") % {'x_nb1': nb_queries_total, + 'x_nb_2': nb_queries_distinct} out += '' + msg + '
' else: # permanent="y" msg = _("Here are the %s most popular searches.") - msg %= ('' + str(len(query_result)) + '') + msg %= ('' + str(len(queries)) + '') out += '' + msg + '
' # display the list of searches out += """| %(no)s | %(question)s | %(action)s | """ % { 'no' : "#", 'question' : _("Question"), 'action' : _("Action") } if permanent=="n": out += '%s | ' % _("Last Run") out += "
| #%(index)d | %(textargs)s | %(execute_query)s %(set_alert)s | """ % {
'index' : i,
'textargs' : query['textargs'],
'weburl' : weburl,
'args' : query['args'],
'id' : query['id'],
'ln': ln,
'execute_query' : _("Execute search"),
'set_alert' : _("Set new alert")
}
if permanent=="n":
out += '%s | ' % query['lastrun'] out += """
\n" if guest : out += guesttxt return out def tmpl_alert_email_headers(self, name, headers): headers['Subject'] = 'Alert %s run on %s' % ( name, time.strftime("%Y-%m-%d")) headers['From'] = 'CDS Alert Engine <%s>' % alertengineemail def tmpl_alert_email_body(self, name, url, records, pattern, catalogues, frequency): l = len(catalogues) if l == 0: collections = '' elif l == 1: collections = "collection: %s\n" % catalogues[0] else: collections = "collections: %s\n" % wrap(', '.join(catalogues)) if pattern: pattern = 'pattern: %s\n' % pattern frequency = {'day': 'daily', 'month': 'monthly', 'year': 'yearly'}[frequency] l = len(records) if l == 1: total = '1 record' else: total = '%d records' % l body = """\ Hello: Below are the results of the email notification alert that you set up with the %(cdsname)s. This is an automatic message, please don't reply to it. For any question, please use <%(supportemail)s> instead. alert name: %(name)s %(pattern)s%(collections)sfrequency: %(frequency)s run time: %(runtime)s found: %(total)s url: <%(url)s> """ % {'supportemail': supportemail, 'name': name, 'cdsname': cdsname, 'pattern': pattern, 'collections': collections, 'frequency': frequency, 'runtime': time.strftime("%a %Y-%m-%d %H:%M:%S"), 'total': total, 'url': url} for index, recid in enumerate(records[:cfg_webalert_max_num_of_records_in_alert_email]): body += "\n%i) " % (index + 1) body += self.tmpl_alert_email_record(recid) body += "\n" if len(records) > cfg_webalert_max_num_of_records_in_alert_email: body += ''' Only the first %s records were displayed. Please consult the search URL given at the top of this email to see all the results. ''' % cfg_webalert_max_num_of_records_in_alert_email body += ''' -- %s Alert Service <%s> Unsubscribe? See <%s> Need human intervention? Contact <%s> ''' % (cdsname, weburl, weburl + '/youralerts/list', supportemail) return body def tmpl_alert_email_record(self, recid): """ Format a single record.""" out = wrap(get_as_text(recid)) out += "Detailed record: <%s/record/%s>" % (weburl, recid) return out diff --git a/modules/webbasket/lib/webbasket.py b/modules/webbasket/lib/webbasket.py index b15d5fc02..4f0f8f2af 100644 --- a/modules/webbasket/lib/webbasket.py +++ b/modules/webbasket/lib/webbasket.py @@ -1,795 +1,797 @@ ## $Id$ ## This file is part of CDS Invenio. ## Copyright (C) 2002, 2003, 2004, 2005, 2006 CERN. ## ## CDS 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. ## ## CDS 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 CDS Invenio; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. """Web Baskets features.""" from zlib import decompress from invenio.config import cdslang, weburl from invenio.messages import gettext_set_language from invenio.dateutils import convert_datetext_to_dategui, \ convert_datetext_to_datestruct,\ convert_datestruct_to_dategui from invenio.search_engine import print_record from invenio.webbasket_config import cfg_webbasket_share_levels, \ cfg_webbasket_share_levels_ordered, \ cfg_webbasket_categories, \ cfg_webbasket_actions, \ cfg_webbasket_warning_messages, \ cfg_webbasket_error_messages, \ cfg_webbasket_max_number_of_displayed_baskets from invenio.webuser import isGuestUser import invenio.webbasket_dblayer as db try: import invenio.template webbasket_templates = invenio.template.load('webbasket') except ImportError: pass def perform_request_display(uid, category=cfg_webbasket_categories['PRIVATE'], selected_topic=0, selected_group_id=0, ln=cdslang): """Display all the baskets of given category, topic or group. @param uid: user id @param category: selected category (see webbasket_config.py) @param selected_topic: # of selected topic to display baskets @param selected_group_id: id of group to display baskets @param ln: language""" warnings = [] errors = [] baskets_html = [] _ = gettext_set_language(ln) nb_groups = db.count_groups_user_member_of(uid) nb_external_baskets = db.count_external_baskets(uid) selectionbox = '' infobox = '' if category == cfg_webbasket_categories['EXTERNAL']: baskets = db.get_external_baskets_infos(uid) if len(baskets): map(list, baskets) else: category = cfg_webbasket_categories['PRIVATE'] if category == cfg_webbasket_categories['GROUP']: groups = db.get_group_infos(uid) if len(groups): if selected_group_id == 0 and len(groups): selected_group_id = groups[0][0] selectionbox = webbasket_templates.tmpl_group_selection(groups, selected_group_id, ln) baskets = db.get_group_baskets_infos(selected_group_id) def adapt_group_rights(item): """Suppress unused element in tuple.""" out = list(item) if out[-1] == uid: out[-2] = cfg_webbasket_share_levels['MANAGE'] return out[:-1] baskets = map(adapt_group_rights, baskets) else: category = cfg_webbasket_categories['PRIVATE'] if category == cfg_webbasket_categories['PRIVATE']: topics_list = db.get_personal_topics_infos(uid) if not selected_topic and len(topics_list): selected_topic = 0 selectionbox = webbasket_templates.tmpl_topic_selection(topics_list, selected_topic, ln) if len(topics_list) > 0: baskets = db.get_personal_baskets_infos(uid, topics_list[selected_topic][0]) else: baskets = [] def add_manage_rights(item): """ Convert a tuple to a list and add rights""" out = list(item) out.append(cfg_webbasket_share_levels['MANAGE']) return out baskets = map(add_manage_rights, baskets) bskids = [] for basket in baskets: bskids.append(basket[0]) levels = dict(db.is_shared_to(bskids)) create_link = '' if category == cfg_webbasket_categories['PRIVATE']: create_link = webbasket_templates.tmpl_create_basket_link(selected_topic, ln) infobox = webbasket_templates.tmpl_baskets_infobox(map(lambda x: (x[0], x[1], x[2]), baskets), create_link, ln) for (bskid, name, date_modification, nb_views, nb_items, last_added, share_level) in baskets: (bsk_html, bsk_e, bsk_w) = __display_basket(bskid, name, date_modification, nb_views, nb_items, last_added, share_level, levels[bskid], category, selected_topic, selected_group_id, ln) baskets_html.append(bsk_html) errors.extend(bsk_e) warnings.extend(bsk_w) body = webbasket_templates.tmpl_display(selectionbox, infobox, baskets_html, category, nb_groups, nb_external_baskets, ln) return (body, errors, warnings) def __display_basket(bskid, name, date_modification, nb_views, nb_items, last_added, share_level, group_sharing_level, category=cfg_webbasket_categories['PRIVATE'], selected_topic=0, selected_group_id=0, ln=cdslang): """Private function. Display a basket giving its category and topic or group. @param share_level: rights user has on basket @param group_sharing_level: None if basket is not shared, 0 if public basket, > 0 if shared to usergroups but not public. @param category: selected category (see webbasket_config.py) @param selected_topic: # of selected topic to display baskets @param selected_group_id: id of group to display baskets @param ln: language""" _ = gettext_set_language(ln) errors = [] warnings = [] nb_bsk_cmts = 0 last_cmt = _("N/A") records = [] cmt_dates = [] date_modification = convert_datetext_to_dategui(date_modification, ln) items = db.get_basket_content(bskid, 'hb') for (recid, nb_cmt, last_cmt, ext_val, int_val, score) in items: cmt_dates.append(convert_datetext_to_datestruct(last_cmt)) last_cmt = convert_datetext_to_dategui(last_cmt, ln) val = '' nb_bsk_cmts += nb_cmt if recid < 0: if ext_val: val = decompress(ext_val) else: if int_val: val = decompress(int_val) records.append((recid, nb_cmt, last_cmt, val, score)) if len(cmt_dates) > 0: last_cmt = convert_datestruct_to_dategui(max(cmt_dates), ln) body = webbasket_templates.tmpl_basket(bskid, name, date_modification, nb_views, nb_items, last_added, (__check_sufficient_rights(share_level, cfg_webbasket_share_levels['READITM']), __check_sufficient_rights(share_level, cfg_webbasket_share_levels['MANAGE']), __check_sufficient_rights(share_level, cfg_webbasket_share_levels['READCMT']), __check_sufficient_rights(share_level, cfg_webbasket_share_levels['ADDITM']), __check_sufficient_rights(share_level, cfg_webbasket_share_levels['DELITM'])), nb_bsk_cmts, last_cmt, group_sharing_level, category, selected_topic, selected_group_id, records, ln) return (body, errors, warnings) def perform_request_display_item(uid, bskid, recid, format='hb', category=cfg_webbasket_categories['PRIVATE'], topic=0, group_id=0, ln=cdslang): """Display an item of a basket of given category, topic or group. @param uid: user id @param bskid: basket_id @param recid: record id @param format: format of the record (hb, hd, etc.) @param category: selected category (see webbasket_config.py) @param topic: # of selected topic to display baskets @param group_id: id of group to display baskets @param ln: language""" body = '' errors = [] warnings = [] rights = db.get_max_user_rights_on_basket(uid, bskid) if not(__check_sufficient_rights(rights, cfg_webbasket_share_levels['READITM'])): errors.append('ERR_WEBBASKET_NO_RIGHTS') return (body, errors, warnings) if category == cfg_webbasket_categories['PRIVATE']: topics_list = db.get_personal_topics_infos(uid) if not topic and len(topics_list): topic = 0 topicsbox = webbasket_templates.tmpl_topic_selection(topics_list, topic, ln) elif category == cfg_webbasket_categories['GROUP']: groups = db.get_group_infos(uid) if group_id == 0 and len(groups): group_id = groups[0][0] topicsbox = webbasket_templates.tmpl_group_selection(groups, group_id, ln) else: topicsbox = '' record = db.get_basket_record(bskid, recid, format) comments = db.get_comments(bskid, recid) group_sharing_level = None levels = db.is_shared_to(bskid) if len(levels): group_sharing_level = levels[0][1] basket = db.get_basket_general_infos(bskid) if not(len(basket)): errors.append('ERR_WEBBASKET_DB_ERROR') return (body, errors, warnings) basket = basket[0] item_html = webbasket_templates.tmpl_item(basket, recid, record, comments, group_sharing_level, (__check_sufficient_rights(rights, cfg_webbasket_share_levels['READCMT']), __check_sufficient_rights(rights, cfg_webbasket_share_levels['ADDCMT']), __check_sufficient_rights(rights, cfg_webbasket_share_levels['DELCMT'])), selected_category=category, selected_topic=topic, selected_group_id=group_id, ln=ln) body = webbasket_templates.tmpl_display(topicsbox=topicsbox, baskets=[item_html], selected_category=category, nb_groups=db.count_groups_user_member_of(uid), nb_external_baskets=db.count_external_baskets(uid), ln=ln) return (body, errors, warnings) def perform_request_write_comment(uid, bskid, recid, cmtid=0, category=cfg_webbasket_categories['PRIVATE'], topic=0, group_id=0, ln=cdslang): """Display a comment writing form @param uid: user id @param bskid: basket id @param recid: record id (comments are on a specific record in a specific basket) @param cmtid: if provided this comment is a reply to comment cmtid. @param category: selected category @param topic: selected topic @param group id: selected group id @param ln: language """ body = '' warnings = [] errors = [] cmt_body = '' if not __check_user_can_comment(uid, bskid): errors.append(('ERR_WEBBASKET_CANNOT_COMMENT')) return (body, errors, warnings) if cmtid: # this is a reply to another comment comment = db.get_comment(cmtid) if comment: cmt_body = webbasket_templates.tmpl_quote_comment(comment[2], # title uid, comment[0], # nickname comment[4], # date comment[3], ln) else: warning = (cfg_webbasket_warning_messages['ERR_WEBBASKET_cmtid_INVALID'], cmtid) warnings.append(warning) record = db.get_basket_record(bskid, recid, 'hb') body = webbasket_templates.tmpl_write_comment(bskid=bskid, recid=recid, cmt_body=cmt_body, record = record, selected_category=category, selected_topic=topic, selected_group_id=group_id, warnings=warnings) if category == cfg_webbasket_categories['PRIVATE']: topics_list = db.get_personal_topics_infos(uid) if not topic and len(topics_list): topic = 0 topicsbox = webbasket_templates.tmpl_topic_selection(topics_list, topic, ln) elif category == cfg_webbasket_categories['GROUP']: groups = db.get_group_infos(uid) if group_id == 0 and len(groups): group_id = groups[0][0] topicsbox = webbasket_templates.tmpl_group_selection(groups, group_id, ln) else: topicsbox = '' body = webbasket_templates.tmpl_display(topicsbox, '', [ body ], category, ln) return (body, errors, warnings) def perform_request_save_comment(uid, bskid, recid, title='', text='', ln=cdslang): """ Save a given comment if able to. @param uid: user id (int) @param bskid: basket id (int) @param recid: record id (int) @param title: title of comment (string) @param text: comment's body (string) @param ln: language (string) @return (errors, infos) where errors: list of errors while saving infos: list of informations to display""" _ = gettext_set_language(ln) errors = [] infos = [] if not __check_user_can_comment(uid, bskid): errors.append(('ERR_WEBBASKET_CANNOT_COMMENT')) return (errors, infos) if not(db.save_comment(uid, bskid, recid, title, text)): errors.append(('ERR_WEBBASKET_DB_ERROR')) else: infos.append(_('Your comment has been successfully posted')) return (errors, infos) def perform_request_delete_comment(uid, bskid, recid, cmtid): """Delete comment cmtid on record recid for basket bskid.""" errors = [] if __check_user_can_perform_action(uid, bskid, cfg_webbasket_share_levels['DELCMT']): db.delete_comment(bskid, recid, cmtid) else: errors.append('ERR_WEBBASKET_NO_RIGHTS') return errors def perform_request_add(uid, recids=[], bskids=[], referer='', new_basket_name='', new_topic_name='', create_in_topic='', ln=cdslang): """Add records to baskets @param uid: user id @param recids: list of records to add @param bskids: list of baskets to add records to. if not provided, will return a page where user can select baskets @param referer: URL of the referring page @param new_basket_name: add record to new basket @param new_topic_name: new basket goes into new topic @param create_in_topic: # of topic to put basket into @param ln: language @return (body, errors, warnings) tuple """ body = '' errors = [] warnings = [] if not(type(recids) == list): recids = [recids] if not(len(recids)): warnings.append('WRN_WEBBASKET_NO_RECORD') body += webbasket_templates.tmpl_warnings(warnings, ln) if referer and not(referer.find(weburl) == -1): body += webbasket_templates.tmpl_back_link(referer, ln) return (body, errors, warnings) if new_basket_name != '': new_topic_name = new_topic_name.strip() if new_topic_name: topic = new_topic_name elif create_in_topic != -1: topics = map(lambda x: x[0], db.get_personal_topics_infos(uid)) try: topic = topics[create_in_topic] except IndexError: topic = '' if topic: id_bsk = db.create_basket(uid, new_basket_name, topic) bskids.append(id_bsk) if len(bskids): # save nb_modified_baskets = db.add_to_basket(uid, recids, bskids) body = webbasket_templates.tmpl_added_to_basket(nb_modified_baskets, ln) body += webbasket_templates.tmpl_back_link(referer, ln) else: # Display basket_selection personal_baskets = db.get_all_personal_baskets_names(uid) group_baskets = db.get_all_group_baskets_names(uid) external_baskets = db.get_all_external_baskets_names(uid) topics = map(lambda x: x[0], db.get_personal_topics_infos(uid)) body = webbasket_templates.tmpl_add(recids=recids, personal_baskets=personal_baskets, group_baskets=group_baskets, external_baskets=external_baskets, topics=topics, referer=referer, ln=ln) body += webbasket_templates.tmpl_back_link(referer, ln) return (body, errors, warnings) def perform_request_delete(uid, bskid, confirmed=0, category=cfg_webbasket_categories['PRIVATE'], selected_topic=0, selected_group_id=0, ln=cdslang): """Delete a given basket. @param uid: user id (user has to be owner of this basket) @param bskid: basket id @param confirmed: if 0 will return a confirmation page; if 1 will delete basket. @param category: category currently displayed @param selected_topic: topic currently displayed @param selected_group id: if category is group, id of the group currently displayed @param ln: language""" body = '' errors = [] warnings = [] if not(db.check_user_owns_baskets(uid, [bskid])): errors.append(('ERR_WEBBASKET_NO_RIGHTS',)) return (body, errors, warnings) if confirmed: success = db.delete_basket(bskid) if not success: errors.append(('ERR_WEBBASKET_DB_ERROR',)) else: body = webbasket_templates.tmpl_confirm_delete(bskid, db.count_subscribers(uid, bskid), category, selected_topic, selected_group_id, ln) return (body, errors, warnings) def delete_record(uid, bskid, recid): """Delete a given record in a given basket. @param uid: user id (user has to have sufficient rights on basket @param bskid: basket id @param recid: record id """ if __check_user_can_perform_action(uid, bskid, cfg_webbasket_share_levels['DELITM']): db.delete_item(bskid, recid) def move_record(uid, bskid, recid, direction): """Move a record up or down in a basket (change score). @param uid: user id (user has to have manage rights over this basket) @param bskid: basket id @param recid: record we want to move @param direction: cfg_webbasket_actions['UP'] or cfg_webbasket_actions['DOWN'] """ if __check_user_can_perform_action(uid, bskid, cfg_webbasket_share_levels['MANAGE']): db.move_item(bskid, recid, direction) def perform_request_edit(uid, bskid, topic=0, new_name='', new_topic = '', new_topic_name='', groups=[], external='', ln=cdslang): """Interface for management of basket. If names, groups or external is provided, will save new rights into database, else will provide interface. @param uid: user id (user has to have sufficient rights on this basket @param bskid: basket id to change rights on @param topic: topic currently used (int) @param new_name: new name of basket @param new_topic: topic in which to move basket (int), new_topic_name must be left blank @param new_topic_name: new topic in which to move basket (will overwrite param new_topic) @param groups: list of strings formed in this way: group_id + '_' + rights @param external: rights for everybody (can be 'NO') @param ln: language """ body = '' errors = [] warnings = [] rights = db.get_max_user_rights_on_basket(uid, bskid) if rights != cfg_webbasket_share_levels['MANAGE']: errors.append(('ERR_WEBBASKET_NO_RIGHTS',)) return (body, errors, warnings) bsk_name = db.get_basket_name(bskid) if not(groups) and not(external) and not(new_name) and not(new_topic) and not(new_topic_name): # display interface topics = map(lambda x: x[0], db.get_personal_topics_infos(uid)) groups_rights = db.get_groups_subscribing_to_basket(bskid) external_rights = '' if groups_rights and groups_rights[0][0] == 0: external_rights = groups_rights[0][2] groups_rights = groups_rights[1:] display_delete = db.check_user_owns_baskets(uid, bskid) display_general = display_delete if isGuestUser(uid): display_sharing = 0 else: display_sharing = 1 body = webbasket_templates.tmpl_edit(bskid=bskid, bsk_name=bsk_name, display_general=display_general, topics=topics, topic=topic, display_delete=display_delete, display_sharing=display_sharing, groups_rights=groups_rights, external_rights=external_rights, ln=ln) else: out_groups = {} if len(groups): for group in groups: (group_id, group_rights) = group.split('_') out_groups[group_id] = group_rights out_groups['0'] = external if not(isGuestUser(uid)): db.update_rights(bskid, out_groups) if new_name != bsk_name: db.rename_basket(bskid, new_name) if new_topic_name: db.move_baskets_to_topic(uid, bskid, new_topic_name) elif new_topic != -1: if db.check_user_owns_baskets(uid, bskid): topics = map(lambda x: x[0], db.get_personal_topics_infos(uid)) try: new_topic_name = topics[new_topic] db.move_baskets_to_topic(uid, bskid, new_topic_name) except: errors.append(('ERR_WEBBASKET_DB_ERROR')) else: topic = 0 errors.append(('ERR_WEBBASKET_NOT_OWNER')) return (body, errors, warnings) def perform_request_add_group(uid, bskid, topic=0, group_id=0, ln=cdslang): """If group id is specified, share basket bskid to this group with READITM rights; else return a page for selection of a group. @param uid: user id (selection only of groups user is member of) @param bskid: basket id @param topic: topic currently displayed @param group_id: id of group to share basket to @param ln: language """ if group_id: db.share_basket_with_group(bskid, group_id, cfg_webbasket_share_levels['READITM']) else: groups = db.get_groups_user_member_of(uid) body = webbasket_templates.tmpl_add_group(bskid, topic, groups, ln) return body def perform_request_create_basket(uid, new_basket_name='', new_topic_name='', create_in_topic=-1, topic_number=-1, ln=cdslang): """if new_basket_name and topic infos are given create a basket and return topic number, else return (body, errors, warnings) tuple of basket creation form. @param uid: user id (int) @param new_basket_name: name of the basket to create (str) @param new_topic_name: name of new topic to create new basket in (str) @param create_in_topic: identification number of topic to create new basket in (int) @param topic_number: number of topic to preselect on the creation form. @pram ln: language """ if new_basket_name and (new_topic_name or create_in_topic != -1): - topics = map(lambda x: x[0], db.get_personal_topics_infos(uid)) + topics_infos = db.get_personal_topics_infos(uid) new_topic_name = new_topic_name.strip() if new_topic_name: topic = new_topic_name else: try: topic = topics_infos[create_in_topic] except IndexError: return 0 db.create_basket(uid, new_basket_name, topic) - topics = map(lambda x: x[0], db.get_personal_topics_infos(uid)) + topics = map(lambda x: x[0], topics_infos) try: return topics.index(topic) except ValueError: return 0 else: topics = map(lambda x: x[0], db.get_personal_topics_infos(uid)) if topic_number in range (0, len(topics)): create_in_topic = topics[topic_number] body = webbasket_templates.tmpl_create_basket(new_basket_name, new_topic_name, create_in_topic, topics, ln) return (body, [], []) def perform_request_display_public(bskid=0, of='hb', ln=cdslang): """return html representation of a public basket @param bskid: basket id @param of: format @param ln: language""" _ = gettext_set_language(ln) body = '' errors = [] warnings = [] basket = db.get_public_basket_infos(bskid) if of[0]=='x': items = [] if len(basket) == 7: content = db.get_basket_content(bskid) for item in content: items.append(print_record(item[0], of)) return webbasket_templates.tmpl_xml_basket(items) if len(basket) == 7: items = db.get_basket_content(bskid) last_cmt = _("N/A") records = [] cmt_dates = [] for (recid, nb_cmt, last_cmt, ext_val, int_val, score) in items: cmt_dates.append(convert_datetext_to_datestruct(last_cmt)) last_cmt = convert_datetext_to_dategui(last_cmt, ln) val = '' if recid < 0: if ext_val: val = decompress(ext_val) else: if int_val: val = print_record(recid) records.append((recid, nb_cmt, last_cmt, val, score)) body = webbasket_templates.tmpl_display_public(basket, records, ln) else: errors.append('ERR_WEBBASKET_RESTRICTED_ACCESS') return (body, errors, warnings) def perform_request_list_public_baskets(inf_limit=0, order=1, asc=1, ln=cdslang): """Display list of public baskets. @param inf_limit: display baskets from inf_limit @param order: 1: order by name of basket, 2: number of views, 3: owner @param asc: ascending order if 1, descending if 0 @param ln: language """ errors = [] warnings = [] total_baskets = db.count_public_baskets() baskets = db.get_public_baskets_list(inf_limit, cfg_webbasket_max_number_of_displayed_baskets, order, asc) body = webbasket_templates.tmpl_display_list_public_baskets(baskets, inf_limit, total_baskets, order, asc, ln) return (body, errors, warnings) def perform_request_subscribe(uid, bskid): """subscribe to external basket bskid""" errors = [] if db.is_public(bskid): db.subscribe(uid, bskid) else: errors.append('ERR_WEBBASKET_RESTRICTED_ACCESS') return errors def perform_request_unsubscribe(uid, bskid): """unsubscribe from external basket bskid""" db.unsubscribe(uid, bskid) def __check_user_can_comment(uid, bskid): """ Private function. check if a user can comment """ min_right = cfg_webbasket_share_levels['ADDCMT'] rights = db.get_max_user_rights_on_basket(uid, bskid) if rights: if cfg_webbasket_share_levels_ordered.index(rights) >= cfg_webbasket_share_levels_ordered.index(min_right): return 1 return 0 def __check_user_can_perform_action(uid, bskid, rights): """ Private function, check if a user has sufficient rights""" min_right = rights rights = db.get_max_user_rights_on_basket(uid, bskid) if rights: if cfg_webbasket_share_levels_ordered.index(rights) >= cfg_webbasket_share_levels_ordered.index(min_right): return 1 return 0 def __check_sufficient_rights(rights_user_has, rights_needed): """Private function, check if the rights are sufficient.""" try: out = cfg_webbasket_share_levels_ordered.index(rights_user_has) >= cfg_webbasket_share_levels_ordered.index(rights_needed) except ValueError: out = 0 return out def create_guest_warning_box(ln=cdslang): """return a warning message about logging into system""" return webbasket_templates.tmpl_create_guest_warning_box(ln) def create_personal_baskets_selection_box(uid, html_select_box_name='baskets', selected_bskid=None, ln=cdslang): """Return HTML box for basket selection. Only for personal baskets. @param uid: user id @param html_select_box_name: name used in html form @param selected_bskid: basket currently selected @param ln: language """ baskets = db.get_all_personal_baskets_names(uid) return webbasket_templates.tmpl_personal_baskets_selection_box(baskets, html_select_box_name, selected_bskid, ln) def create_basket_navtrail(uid, category=cfg_webbasket_categories['PRIVATE'], topic=0, group=0, bskid=0, ln=cdslang): """display navtrail for basket navigation. @param uid: user id (int) @param category: selected category (see cfg_webbasket_categories) @param topic: selected topic # if personal baskets @param group: selected group id for displaying (int) @param bskid: basket id (int) @param ln: language""" _ = gettext_set_language(ln) out = '' if category == cfg_webbasket_categories['PRIVATE']: out += ' > %s' out %= (weburl, 'category=' + category + '&ln=' + ln, _("Personal baskets")) topics = map(lambda x: x[0], db.get_personal_topics_infos(uid)) if topic in range(0, len(topics)): out += ' > ' out += '%s' out %= (weburl, 'category=' + category + '&topic=' + str(topic) + '&ln=' + ln, topics[topic]) if bskid: basket = db.get_public_basket_infos(bskid) if basket: out += ' > ' out += '%s' out %= (weburl, 'category=' + category + '&topic=' + str(topic) + \ '&ln=' + ln + '#bsk' + str(bskid), basket[1]) elif category == cfg_webbasket_categories['GROUP']: out += ' > %s' out %= (weburl, 'category=' + category + '&ln=' + ln, _("Group baskets")) groups = db.get_group_infos(uid) if group: groups = filter(lambda x: x[0]==group, groups) if len(groups): out += ' > ' out += '%s' out %= (weburl, 'category=' + category + '&group=' + str(group) + '&ln=' + ln, groups[0][1]) if bskid: basket = db.get_public_basket_infos(bskid) if basket: out += ' > ' out += '%s' out %= (weburl, 'category=' + category + '&group=' + str(group) + \ '&ln=' + ln + '#bsk' + str(bskid), basket[1]) elif category == cfg_webbasket_categories['EXTERNAL']: out += ' > %s' out %= (weburl, 'category=' + category + '&ln=' + ln, _("Others' baskets")) if bskid: basket = db.get_public_basket_infos(bskid) if basket: out += ' > ' out += '%s' out %= (weburl, 'category=' + category + '&ln=' + ln + '#bsk' + str(bskid), basket[1]) return out def create_infobox(infos=[]): """Create an infos box. infos param should be a list of strings. Return formatted infos""" return webbasket_templates.tmpl_create_infobox(infos) def account_list_baskets(uid, ln=cdslang): """Display baskets informations on account page""" _ = gettext_set_language(ln) (personal, group, external) = db.count_baskets(uid) link = '%s' base_url = weburl + '/yourbaskets/display?category=%s&ln=' + ln personal_text = personal if personal: url = base_url % cfg_webbasket_categories['PRIVATE'] personal_text = link % (url, personal_text) group_text = group if group: url = base_url % cfg_webbasket_categories['GROUP'] group_text = link % (url, group_text) external_text = external if external: url = base_url % cfg_webbasket_categories['EXTERNAL'] else: url = weburl + '/yourbaskets/list_public_baskets?ln=' + ln external_text = link % (url, external_text) - out = _("You have %s personal baskets and are subscribed to %s group baskets and %s other users public baskets.") - out %= (personal_text, group_text, external_text) + out = _("You have %(x_nb_perso)s personal baskets and are subscribed to %(x_nb_group)s group baskets and %(x_nb_public)s other users public baskets.") %\ + {'x_nb_perso': personal_text, + 'x_nb_group': group_text, + 'x_nb_public': external_text} return out diff --git a/modules/webbasket/lib/webbasket_templates.py b/modules/webbasket/lib/webbasket_templates.py index 6613c5ab9..214f03f4b 100644 --- a/modules/webbasket/lib/webbasket_templates.py +++ b/modules/webbasket/lib/webbasket_templates.py @@ -1,1509 +1,1488 @@ ## $Id$ ## This file is part of CDS Invenio. ## Copyright (C) 2002, 2003, 2004, 2005, 2006 CERN. ## ## CDS 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. ## ## CDS 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 CDS Invenio; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. from invenio.messages import gettext_set_language from invenio.webbasket_config import cfg_webbasket_categories, \ cfg_webbasket_share_levels, \ cfg_webbasket_max_number_of_displayed_baskets from invenio.webmessage_mailutils import email_quoted_txt2html, email_quote_txt from invenio.config import weburl, sweburl, cdslang from invenio.textutils import indent_text from invenio.webuser import get_user_info from invenio.dateutils import convert_datetext_to_dategui class Template: ######################## General interface ############################### def tmpl_display(self, topicsbox='', baskets_infobox='', baskets=[], selected_category=cfg_webbasket_categories['PRIVATE'], nb_groups=0, nb_external_baskets=0, ln=cdslang): """Generic display. takes already formatted baskets (list of formatted baskets), infobox and topicsbox, add tabs and returns complete interface""" _ = gettext_set_language(ln) if type(baskets) not in (list, tuple): baskets = [baskets] tabs = self.__create_tabs(selected_category, nb_groups, nb_external_baskets, ln) out = """
%s
""" % indent_text(tabs, 2)
if topicsbox:
out += indent_text(topicsbox, 6)
out += """
"""
if baskets_infobox:
out += """
%s
""" % indent_text(baskets_infobox, 5)
for basket in baskets:
out += basket
out += """
s/img/%(img)s)
| %s |
| %s |
- \n'
for (bskid, name, last_update) in basket_infos:
last_update = convert_datetext_to_dategui(last_update)
basket_list += '
- %s - ' % (bskid, name) basket_list += _("updated on") + ' ' + last_update + ' \n' basket_list += '
| %s | %s | %s |
s/img/webbasket_world.png)
|
%(name)s %(nb_items)i %(records_label)s - %(last_update_label)s: %(last_update)s | %(link_subscribe)s%(subscribe_label)s |
 + ')
'
if order == 1:
name_label = '' + name_label + ' ' + asc_image + ''
nb_views_label = '' + nb_views_label + ''
owner_label = '' + owner_label + ''
elif order == 2:
name_label = '' + name_label + ''
nb_views_label = '' + nb_views_label + ' ' + asc_image + ''
owner_label = '' + owner_label + ''
else:
name_label = '' + name_label + ''
nb_views_label = '' + nb_views_label + ''
owner_label = '' + owner_label + ' ' + asc_image + ''
baskets_html = ''
for (bskid, name, nb_views, owner_id, owner_nickname) in baskets:
if owner_nickname:
display = owner_nickname
else:
(owner_id, owner_nickname, display) = get_user_info(owner_id)
messaging_link = self.__create_messaging_link(owner_nickname, display, ln)
form_view = """
""" % {'weburl': weburl,
'ln': ln,
'bskid': bskid,
'display_public_label': _("View")}
form_subscribe = """
""" % {'weburl': weburl,
'ln': ln,
'bskid': bskid,
'subscribe_label': _("Subscribe")}
baskets_html += """
| %(name)s | %(nb_views)s | %(user)s | %(actions)s | |
| %(footer)s | ||||
| " + logo + " | " actions += "
![\"%s\"](\"%s/img/%s\")
" % (weburl, group_img_name, group_alt)
if user_can_edit_basket:
url = weburl + '/yourbaskets/edit?bskid=%i&topic=%i&ln=%s'
url %= (bskid, selected_topic, ln)
logo = '%s %s""" % (nb_comments, _("comments"), _("last comment:"), last_comment) out = """
| %(actions)s |
%(name)s %(nb_items)i %(records_label)s - %(last_update_label)s: %(last_update)s |
%(comments_field)s |
![\"%s\"](\"%s/img/webbasket_extern.png\")
"
+ actions += '
'
actions = actions % (weburl, _("External record"))
else:
pass
#actions += "![\"%s\"](\"%s/img/webbasket_intern.png\")
"
#actions = actions % (weburl, _("Internal record"))
out = """
""" if view_comments: if nb_cmt > 0: out += """ %(nb_cmts)i %(cmts_label)s; %(last_cmt_label)s: %(last_cmt)s
""" out += """ %(detailed_label)s """ out += """
' if not(content) and not(public_infos): content += '
' out = """
elt2""" return elt1 + "
\n" + elt2 if comments and user_can_view_comments: comments = [self.__tmpl_display_comment(bskid, recid, comment, (user_can_add_comment, user_can_delete_comment), selected_category, selected_topic, selected_group_id, ln) for comment in comments] comments = reduce(list_to_str, comments) else: comments = '' record_text = '' if record: record_text = record[-1] body = """ %(record)s
""" if user_can_view_comments: body += """
%(comments_label)s
%(total_label)s""" if user_can_add_comment: body += """ """ if user_can_view_comments: body += """
%(comments)s""" body %= {'record': record_text, 'comments_label': _("Comments"), 'total_label': _("There is a total of %i comments") % total_comments, 'action': action, 'button_label': _("Write a comment"), 'comments': comments} if group_sharing_level == None: img = '
' % (weburl, _("Non-shared basket"))
elif group_sharing_level == 0:
img = '
' % (weburl, _("Shared basket"))
else:
img = '
' % (weburl, _("Group-shared basket"))
content = ''
if selected_category == cfg_webbasket_categories['EXTERNAL']:
url = "%s/yourbaskets/unsubscribe?bskid=%i&ln=%s" % (weburl, bskid, ln)
action = "%s"
action %= (url, _("Unsubscribe from this basket"))
content += action
footer = self.tmpl_basket_footer(bskid,
selected_category,
selected_topic,
selected_group_id,
group_sharing_level,
content,
ln)
out = """
| %(img)s |
%(name)s %(nb_items)i %(records_label)s - %(last_update_label)s: %(last_update)s |
|
| %(body)s | ||
%(warnings)s
%(record)s
""" % {'warnings': warnings_box,
'record': record and record[-1] or '',
'write_label': _("Add Comment"),
'title_label': _("Title"),
'comment_label': _("Comment"),
'action': action,
'cmt_body': cmt_body,
'button_label': _("Add Comment")
}
return out
############################ Basket creation ###################################
def tmpl_create_basket_link(self, selected_topic=0, ln=cdslang):
""" Create link to basket creation """
_ = gettext_set_language(ln)
url = weburl + '/yourbaskets/create_basket?topic_number=%i&ln=%s'
url %= (selected_topic, ln)
image = '%(write_label)s
' % weburl
out = """
""" % (url, image, _("Create new basket"))
return out
def __tmpl_basket_box(self, img='', title=' ', subtitle=' ', body=''):
""" private function, display a basket/topic selection box """
out = """
|
|
%(label)s %(count)s |
|
|
|
' + out + '
' def tmpl_confirm_delete(self, bskid, (nb_users, nb_groups, nb_alerts), category=cfg_webbasket_categories['PRIVATE'], selected_topic=0, selected_group_id=0, ln=cdslang): """ display a confirm message @param bskid: basket id @param nb*: nb of users/groups/alerts linked to this basket @param category: private, group or external baskets are selected @param selected_topic: if private baskets, topic nb @param selected_group_id: if group: group to display baskets of @param ln: language @return html output """ _ = gettext_set_language(ln) message = _("Are you sure you want to delete this basket?") if nb_users: message += '' + _("%i users are subscribed to this basket.")% nb_users + '
' if nb_groups: message += '' + _("%i user groups are subscribed to this basket.")% nb_groups + '
' if nb_alerts: message += '' + _("You have set %i alerts on this basket.")% nb_alerts + '
' out = """| %s |
|---|
| %s |
|---|
%s
' % warning_text
return out
def tmpl_create_infobox(self, infos = []):
""" returns html for general informations
@param infos: list of strings to display"""
out = ''
if len(infos):
out += ''
for info in infos:
out += info + '
' out += '
'
return out
def tmpl_back_link(self, link, ln=cdslang):
""" returns HTML for a link whose label should be
'Back to search results'
"""
_ = gettext_set_language(ln)
label = _("Back to search results")
out = '%s' % (link, label)
return out
def __create_messaging_link(self, to, display_name, ln=cdslang):
"""prints a link to the messaging system"""
link = "%s/yourmessages/write?msg_to=%s&ln=%s" % (weburl, to, ln)
if to:
return '%s' % (link, display_name)
else:
return display_name
def tmpl_xml_basket(self, items=[]):
"""Template for XML output of basket
@param items: XML version of each item (list)"""
items_xml = ''
for item in items:
items_xml += ' ' + item + '\n'
return """
' out += '
','\n'), 'weburl' : weburl } from_addr = 'CDS Invenio WebComment <%s>' % alertengineemail to_addr = adminemail subject = "A new comment/review has just been posted" from invenio.alert_engine import send_email, forge_email out = forge_email(from_addr, to_addr, subject, out) send_email(from_addr, to_addr, out) def check_recID_is_in_range(recID, warnings=[], ln=cdslang): """ Check that recID is >= 0 Append error messages to errors listi @param recID: record id @param warnings: the warnings list of the calling function @return tuple (boolean, html) where boolean (1=true, 0=false) and html is the body of the page to display if there was a problem """ # Make errors into a list if needed if type(warnings) is not list: errors = [warnings] try: recID = int(recID) except: pass if type(recID) is int: if recID > 0: from invenio.search_engine import record_exists success = record_exists(recID) if success == 1: return (1,"") else: warnings.append(('ERR_WEBCOMMENT_RECID_INEXISTANT', recID)) return (0, webcomment_templates.tmpl_record_not_found(status='inexistant', recID=recID, ln=ln)) elif recID == 0: warnings.append(('ERR_WEBCOMMENT_RECID_MISSING',)) return (0, webcomment_templates.tmpl_record_not_found(status='missing', recID=recID, ln=ln)) else: warnings.append(('ERR_WEBCOMMENT_RECID_INVALID', recID)) return (0, webcomment_templates.tmpl_record_not_found(status='invalid', recID=recID, ln=ln)) else: warnings.append(('ERR_WEBCOMMENT_RECID_NAN', recID)) return (0, webcomment_templates.tmpl_record_not_found(status='nan', recID=recID, ln=ln)) def check_int_arg_is_in_range(value, name, errors, gte_value, lte_value=None): """ Check that variable with name 'name' >= gte_value and optionally <= lte_value Append error messages to errors list @param value: variable value @param name: variable name @param errors: list of error tuples (error_id, value) @param gte_value: greater than or equal to value @param lte_value: less than or equal to value @return boolean (1=true, 0=false) """ # Make errors into a list if needed if type(errors) is not list: errors = [errors] if type(value) is not int or type(gte_value) is not int: errors.append(('ERR_WEBCOMMENT_PROGRAMNING_ERROR',)) return 0 if type(value) is not int: errors.append(('ERR_WEBCOMMENT_ARGUMENT_NAN', value)) return 0 if value < gte_value: errors.append(('ERR_WEBCOMMENT_ARGUMENT_INVALID', value)) return 0 if lte_value: if type(lte_value) is not int: errors.append(('ERR_WEBCOMMENT_PROGRAMNING_ERROR',)) return 0 if value > lte_value: errors.append(('ERR_WEBCOMMENT_ARGUMENT_INVALID', value)) return 0 return 1 diff --git a/modules/webcomment/lib/webcomment_templates.py b/modules/webcomment/lib/webcomment_templates.py index 7de443c06..00417775e 100644 --- a/modules/webcomment/lib/webcomment_templates.py +++ b/modules/webcomment/lib/webcomment_templates.py @@ -1,1335 +1,1335 @@ # -*- coding: utf-8 -*- ## $Id$ ## Comments and reviews for records. ## This file is part of CDS Invenio. ## Copyright (C) 2002, 2003, 2004, 2005, 2006 CERN. ## ## CDS 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. ## ## CDS 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 CDS Invenio; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. """HTML Templates for commenting features """ __lastupdated__ = """$Date$""" # non CDS Invenio imports import string # CDS Invenio imports from invenio.webuser import get_user_info from invenio.dateutils import convert_datetext_to_dategui from invenio.webmessage_mailutils import email_quoted_txt2html from invenio.config import weburl, \ sweburl, \ cdslang, \ cdsnameintl,\ cfg_webcomment_nb_reviews_in_detailed_view, \ cfg_webcomment_allow_reviews, \ cfg_webcomment_allow_comments, \ cfg_webcomment_nb_comments_in_detailed_view from invenio.messages import gettext_set_language from invenio.textutils import indent_text class Template: """templating class, refer to webcomment.py for examples of call""" def tmpl_get_first_comments_without_ranking(self, recID, ln, comments, nb_comments_total, warnings): """ @param recID: record id @param ln: language @param comments: tuple as returned from webcomment.py/query_retrieve_comments_or_remarks @param nb_comments_total: total number of comments for this record @param warnings: list of warning tuples (warning_msg, arg1, arg2, ...) @return html of comments """ # load the right message language _ = gettext_set_language(ln) # naming data fields of comments c_nickname = 0 c_user_id = 1 c_date_creation = 2 c_body = 3 c_id = 4 warnings = self.tmpl_warnings(warnings, ln) # comments comment_rows = '' for comment in comments: if comment[c_nickname]: nickname = comment[c_nickname] display = nickname else: (uid, nickname, display) = get_user_info(comment[c_user_id]) messaging_link = self.create_messaging_link(nickname, display, ln) comment_rows += """
| %(comment_title)s |
%(write_button_form)s
""" % \ {'comment_title': _("Discuss this document"), 'comments_label': comments_label, 'nb_comments_total' : nb_comments_total, 'recID': recID, 'comment_rows': comment_rows, 'tab': ' '*4, 'weburl': weburl, 's': cfg_webcomment_nb_comments_in_detailed_view>1 and 's' or "", 'view_all_comments_link': nb_comments_total>0 and '''View all %s comments''' \ % (weburl, recID, nb_comments_total) or "", 'write_button_form': write_button_form, 'nb_comments': cfg_webcomment_nb_comments_in_detailed_view>1 and cfg_webcomment_nb_comments_in_detailed_view or "" } else: out = """
| %(discuss_label)s: |
%(form)s
""" % {'form': write_button_form, 'discuss_label': _("Discuss this document"), 'detailed_info': _("Start a discussion about any aspect of this document.") } return out def tmpl_record_not_found(self, status='missing', recID="", ln=cdslang): """ Displays a page when bad or missing record ID was given. @param status: 'missing' : no recID was given 'inexistant': recID doesn't have an entry in the database 'nan' : recID is not a number 'invalid' : recID is an error code, i.e. in the interval [-99,-1] @param return: body of the page """ _ = gettext_set_language(ln) if status == 'inexistant': body = _("Sorry, the record %s does not seem to exist.") % (recID,) elif status in ('nan', 'invalid'): body = _("Sorry, %s is not a valid ID value.") % (recID,) else: body = _("Sorry, no record ID was provided.") body += "
" link = "%s." % (weburl, ln, cdsnameintl[ln]) body += _("You may want to start browsing from %s") % link return body def tmpl_get_first_comments_with_ranking(self, recID, ln, comments=None, nb_comments_total=None, avg_score=None, warnings=[]): """ @param recID: record id @param ln: language @param comments: tuple as returned from webcomment.py/query_retrieve_comments_or_remarks @param nb_comments_total: total number of comments for this record @param avg_score: average score of all reviews @param warnings: list of warning tuples (warning_msg, arg1, arg2, ...) @return html of comments """ # load the right message language _ = gettext_set_language(ln) # naming data fields of comments c_nickname = 0 c_user_id = 1 c_date_creation = 2 c_body = 3 c_nb_votes_yes = 4 c_nb_votes_total = 5 c_star_score = 6 c_title = 7 c_id = 8 warnings = self.tmpl_warnings(warnings, ln) #stars if avg_score > 0: avg_score_img = 'stars-' + str(avg_score).split('.')[0] + '-' + str(avg_score).split('.')[1] + '.png' else: avg_score_img = "stars-0-0.png" # voting links useful_dict = { 'weburl' : weburl, 'recID' : recID, 'ln' : ln, 'yes_img' : 'smchk_gr.gif', #'yes.gif', 'no_img' : 'iconcross.gif' #'no.gif' } link = '' + _("Yes") + '' useful_no = link + '&com_value=-1">' + _("No") + '' #comment row comment_rows = ' ' for comment in comments: if comment[c_nickname]: nickname = comment[c_nickname] display = nickname else: (uid, nickname, display) = get_user_info(comment[c_user_id]) messaging_link = self.create_messaging_link(nickname, display, ln) comment_rows += '''
''' % (_("Was this review helpful?"), useful_yes % {'comid':comment[c_id]}, useful_no % {'comid':comment[c_id]}) comment_rows += '''
s/img/%(avg_score_img)s)
',
- '%(nb_comments_total)s')
- score %= {'weburl': weburl,
- 'avg_score_img': avg_score_img,
- 'avg_score': avg_score,
- 'nb_comments_total': nb_comments_total}
+ score = ''
+ score = _("Average review score: %(x_nb_score)s based on %(x_nb_reviews)s reviews") %\
+ {'x_nb_score': '
',
+ 'x_nb_reviews': nb_comments_total}
useful_label = _("Readers found the following %s reviews to be most helpful.")
useful_label %= cfg_webcomment_nb_reviews_in_detailed_view > 1 and cfg_webcomment_nb_reviews_in_detailed_view or ""
view_all_comments_link ='' % (weburl, recID, ln)
view_all_comments_link += _("View all %s reviews") % nb_comments_total
view_all_comments_link += '' out = warnings + """
| %(comment_title)s: |
+ %(score_label)s
%(useful_label)s
""" % \ { 'comment_title' : _("Rate this document"), 'score_label' : score, 'useful_label' : useful_label, 'recID' : recID, 'view_all_comments' : _("View all %s reviews") % (nb_comments_total,), 'write_comment' : _("Write a review"), 'comment_rows' : comment_rows, 'tab' : ' '*4, 'weburl' : weburl, 'view_all_comments_link': nb_comments_total>0 and view_all_comments_link or "", 'write_button_form' : write_button_form } else: out = '''
| %s: |
%s
''' % (_("Rate this document"), _("Be the first to review this document."), write_button_form) return out def tmpl_get_comment_without_ranking(self, ln, nickname, date_creation, body, reply_link=None, report_link=None): """ private function @param ln: language @param nickname: nickname @param date_creation: date comment was written @param body: comment body @param reply_link: if want reply and report, give the http links @param repot_link: if want reply and report, give the http links @return html table of comment """ # load the right message language _ = gettext_set_language(ln) date_creation = convert_datetext_to_dategui(date_creation) out = '' final_body = email_quoted_txt2html(body) - title = nickname + ' ' + _("wrote on") + ' ' + date_creation + '' + title = _("%(x_name)s wrote on %(x_date)s:") % {'x_name': nickname, + 'x_date': '' + date_creation + ''} links = '' if reply_link: links += '' + _("Reply") +'' if report_link: links += ' | ' if report_link: links += '' + _("Report abuse") + '' out += """
%(title)s
%(body)s
%(links)s
""" % \
{'title' : title,
'body' : final_body,
'links' : links}
return out
def tmpl_get_comment_with_ranking(self, ln, nickname, date_creation, body, nb_votes_total, nb_votes_yes, star_score, title, report_link=None):
"""
private function
@param ln: language
@param nickname: nickname
@param date_creation: date comment was written
@param body: comment body
@param nb_votes_total: total number of votes for this review
@param nb_votes_yes: number of positive votes for this record
@param star_score: star score for this record
@param title: title of review
@return html table of review
"""
# load the right message language
_ = gettext_set_language(ln)
if star_score > 0:
star_score_img = 'stars-' + str(star_score) + '-0.png'
else:
star_score_img = 'stars-0-0.png'
out = ""
date_creation = convert_datetext_to_dategui(date_creation)
reviewed_label = _("Reviewed by %(x_nickname)s on %(x_date)s") % {'x_nickname': nickname, 'x_date':date_creation}
- useful_label = _("%i out of %i people found this review useful")
- useful_label %= (nb_votes_yes, nb_votes_total)
+ useful_label = _("%(x_nb_people)i out of %(x_nb_total)i people found this review useful") % {'x_nb_people': nb_votes_yes,
+ 'x_nb_total': nb_votes_total}
links = ''
if report_link:
links += '' + _("Report abuse") + ''
out += """
%(body)s
%(links)s
s/img/%(star_score_img)s) %(title)s%(reviewed_label)s %(useful_label)s |
%(body)s |
| %(abuse)s |
| %(helpful_label)s %(tab)s | %(yes)s | / | %(no)s | %(tab)s%(tab)s%(report_abuse_label)s |
' + _("Average review score: %s based on %s reviews") % ('
' % { 'weburl' : weburl, 'avg_score' : avg_score, 'avg_score_img' : avg_score_img },
- total_nb_comments) + '' + ranking_average = '
' + ranking_average += _("Average review score: %(x_nb_score)s based on %(x_nb_reviews)s reviews") %\ + {'x_nb_score': '
',
+ 'x_nb_reviews': total_nb_comments}
+ ranking_average += '' else: ranking_average = "" write_button_link = '''%s/comments/add''' % (weburl, ) write_button_form = ''' ''' % (recID, ln, reviews) write_button_form = self.createhiddenform(action=write_button_link, method="Get", text=write_button_form, button = reviews and _('Write a review') or _('Write a comment')) if reviews: total_label = _("There is a total of %s reviews") else: total_label = _("There is a total of %s comments") total_label %= total_nb_comments # do NOT remove the HTML comments below. Used for parsing body = """
%(record_label)s %(recid)s |
%(back_label)s |
%(record_details)s
%(comments_or_reviews_title)s
%(total_label)s %(ranking_avg)s%(write_button_form)s
| %(write_button_form_again)s | %(back_label)s |
""" % \ { 'record_label': _("Record"), 'back_label': _("Back to search results"), 'total_label': total_label, 'record_details': record_details, 'write_button_form' : write_button_form, 'write_button_form_again' : total_nb_comments>3 and write_button_form or "", 'comments_rows' : indent_text(comments_rows, 1), 'total_nb_comments' : total_nb_comments, 'comments_or_reviews' : reviews and _('review') or _('comment'), 'comments_or_reviews_title' : reviews and _('Review') or _('Comment'), 'weburl' : weburl, 'module' : "comments", 'recid' : recID, 'ln' : ln, 'border' : border, 'ranking_avg' : ranking_average } # form is not currently used. reserved for an eventual purpose #form = """ # Display # comments per page that are # and sorted by # """ % \ # (reviews==1 and ''' # # # # # ''' or ''' # ''') # #form_link = "%(weburl)s/%(module)s/%(function)s" % link_dic #form = self.createhiddenform(action=form_link, method="Get", text=form, button='Go', recid=recID, p=1) pages = """
%(v_label)s %(comments_or_reviews)s %(results_nb_lower)s-%(results_nb_higher)s
%(page_links)s
""" % \ {'v_label': _("Viewing"), 'page_links': _("Page:") + page_links , 'comments_or_reviews': reviews and _('review') or _('comment'), 'results_nb_lower': len(comments)>0 and ((page-1) * nb_per_page)+1 or 0, 'results_nb_higher': page == nb_pages and (((page-1) * nb_per_page) + len(comments)) or (page * nb_per_page) } if nb_pages > 1: #body = warnings + body + form + pages body = warnings + body + pages else: body = warnings + body return body def create_messaging_link(self, to, display_name, ln=cdslang): """prints a link to the messaging system""" link = "%s/yourmessages/write?msg_to=%s&ln=%s" % (weburl, to, ln) if to: return '%s' % (link, display_name) else: return display_name def createhiddenform(self, action="", method="Get", text="", button="confirm", cnfrm='', **hidden): """ create select with hidden values and submit button @param action: name of the action to perform on submit @param method: 'get' or 'post' @param text: additional text, can also be used to add non hidden input @param button: value/caption on the submit button @param cnfrm: if given, must check checkbox to confirm @param **hidden: dictionary with name=value pairs for hidden input @return html form """ output = """ """ return output def tmpl_warnings(self, warnings, ln=cdslang): """ Prepare the warnings list @param warnings: list of warning tuples (warning_msg, arg1, arg2, etc) @return html string of warnings """ red_text_warnings = ['WRN_WEBCOMMENT_FEEDBACK_NOT_RECORDED', 'WRN_WEBCOMMENT_ALREADY_VOTED'] green_text_warnings = ['WRN_WEBCOMMENT_FEEDBACK_RECORDED'] from invenio.errorlib import get_msgs_for_code_list span_class = 'important' out = "" if type(warnings) is not list: warnings = [warnings] if len(warnings) > 0: warnings_parsed = get_msgs_for_code_list(warnings, 'warning', ln) for (warning_code, warning_text) in warnings_parsed: if not warning_code.startswith('WRN'): #display only warnings that begin with WRN to user continue if warning_code in red_text_warnings: span_class = 'important' elif warning_code in green_text_warnings: span_class = 'exampleleader' else: span_class = 'important' out += ''' %(warning)s
''' % \ { 'span_class' : span_class, 'warning' : warning_text } return out else: return "" def tmpl_add_comment_form(self, recID, uid, nickname, ln, msg, warnings): """ Add form for comments @param recID: record id @param uid: user id @param ln: language @param msg: comment body contents for when refreshing due to warning @param warnings: list of warning tuples (warning_msg, color) @return html add comment form """ _ = gettext_set_language(ln) link_dic = { 'weburl' : weburl, 'module' : 'comments', 'function' : 'add', 'arguments' : 'recid=%s&ln=%s&action=%s&reviews=0' % (recID, ln, 'SUBMIT') } if nickname: note = _("Note: Your nickname, %s, will be displayed as author of this comment") % ('' + nickname + '') else: (uid, nickname, display) = get_user_info(uid) link = '' % sweburl - note = _("Note: you have not %sdefined your nickname%s. %s will be displayed as the author of this comment.") - note %= (link, '', '
' + display + '') + note = _("Note: you have not %(x_url_open)sdefined your nickname%(x_url_close)s. %(x_nickname)s will be displayed as the author of this comment.") %\ + {'x_url_open': link, + 'x_url_close': '', + 'x_nickname': '
' + display + ''} from invenio.search_engine import print_record record_details = print_record(recID=recID, format='hb', ln=ln) warnings = self.tmpl_warnings(warnings, ln) form = """
| %(record_label)s |
%(record)s |
| %(comment_label)s |
| %(note)s |
""" % {'msg': msg, 'note': note, 'record': record_details, 'record_label': _("Article") + ":", 'comment_label': _("Comment") + ":"} form_link = "%(weburl)s/%(module)s/%(function)s?%(arguments)s" % link_dic form = self.createhiddenform(action=form_link, method="POST", text=form, button='Add comment') return warnings + form def tmpl_add_comment_form_with_ranking(self, recID, uid, nickname, ln, msg, score, note, warnings): """ Add form for reviews @param recID: record id @param uid: user id @param ln: language @param msg: comment body contents for when refreshing due to warning @param score: review score @param note: review title @param warnings: list of warning tuples (warning_msg, color) @return html add review form """ _ = gettext_set_language(ln) link_dic = { 'weburl' : weburl, 'module' : 'comments', 'function' : 'add', 'arguments' : 'recid=%s&ln=%s&action=%s&reviews=1' % (recID, ln, 'SUBMIT') } warnings = self.tmpl_warnings(warnings, ln) from search_engine import print_record record_details = print_record(recID=recID, format='hb', ln=ln) note_label = _("Note: Your nickname, %s, will be displayed as the author of this review.") note_label %= ('' + nickname + '') form = """
| %(article_label)s: |
%(record)s |
| %(rate_label)s: |
| %(title_label)s: |
| %(write_label)s: |
| %(note_label)s |
""" % {'article_label': _('Article'), 'rate_label': _("Rate this article"), 'select_label': _("Select a score"), 'title_label': _("Give a title to your review"), 'write_label': _("Write your review"), 'note_label': note_label, 'note' : note!='' and note or "", 'msg' : msg!='' and msg or "", 'record' : record_details } form_link = "%(weburl)s/%(module)s/%(function)s?%(arguments)s" % link_dic form = self.createhiddenform(action=form_link, method="Post", text=form, button=_('Add Review')) return warnings + form def tmpl_add_comment_successful(self, recID, ln, reviews, warnings): """ @param recID: record id @param ln: language @return html page of successfully added comment/review """ _ = gettext_set_language(ln) link_dic = { 'weburl' : weburl, 'module' : 'comments', 'function' : 'display', 'arguments' : 'recid=%s&ln=%s&do=od&reviews=%s' % (recID, ln, reviews) } link = "%(weburl)s/%(module)s/%(function)s?%(arguments)s" % link_dic if warnings: out = self.tmpl_warnings(warnings, ln) + '
' else: if reviews: out = _("Your review was successfully added.") + '
' else: out = _("Your comment was successfully added.") + '
' out += '' % link out += _('Back to record') + '' return out def tmpl_create_multiple_actions_form(self, form_name="", form_action="", method="GET", action_display={}, action_field_name="", button_label="", button_name="", content="", **hidden): """ Creates an HTML form with a multiple choice of actions and a button to select it. @param form_action: link to the receiver of the formular @param form_name: name of the HTML formular @param method: either 'GET' or 'POST' @param action_display: dictionary of actions. action is HTML name (name of action) display is the string provided in the popup @param action_field_name: html name of action field @param button_label: what's written on the button @param button_name: html name of the button @param content: what's inside te formular @param **hidden: dictionary of name/value pairs of hidden fields. """ output = """ """ return output def tmpl_admin_index(self, ln): """ """ # load the right message language _ = gettext_set_language(ln) out = '
- '
if cfg_webcomment_allow_comments or cfg_webcomment_allow_reviews:
if cfg_webcomment_allow_comments:
- out += '''
-
- %(reported_cmt_label)s ''' + out += '
- %(reported_cmt_label)s ' %\ + {'weburl': weburl, 'ln': ln, 'reported_cmt_label': _("View all reported comments")} if cfg_webcomment_allow_reviews: - out += ''' -
- %(reported_rev_label)s ''' - out += ''' + out += '
- %(reported_rev_label)s ' %\ + {'weburl': weburl, 'ln': ln, 'reported_rev_label': _("View all reported reviews")} + out += """
- %(delete_label)s
- %(view_users)s - ''' - out = out % { 'weburl' : weburl, - 'reported_cmt_label': _("View all reported comments"), - 'reported_rev_label': _("View all reported reviews"), - 'delete_label': _("Delete a specific comment/review (by ID)"), - 'view_users': _("View all users who have been reported"), - 'ln' : ln } + """ % {'weburl' : weburl, + 'delete_label': _("Delete a specific comment/review (by ID)"), + 'view_users': _("View all users who have been reported"), + 'ln' : ln} else: out += _("Comments and reviews are disabled") + '
' out += '
%s
'''%_("Please enter the ID of the comment/review so that you can view it before deciding whether to delete it or not") form = '''
| %s: | +%s | |
- ''' %_("Comment ID") + ''' %_("Comment ID:") form_link = "%s/admin/webcomment/webcommentadmin.py/delete?ln=%s" % (weburl, ln) form = self.createhiddenform(action=form_link, method="Get", text=form, button=_('View Comment')) return warnings + out + form def tmpl_admin_users(self, ln, users_data): """ @param users_data: tuple of ct, i.e. (ct, ct, ...) where ct is a tuple (total_number_reported, total_comments_reported, total_reviews_reported, total_nb_votes_yes_of_reported, total_nb_votes_total_of_reported, user_id, user_email, user_nickname) sorted by order of ct having highest total_number_reported """ _ = gettext_set_language(ln) u_reports = 0 u_comment_reports = 1 u_reviews_reports = 2 u_nb_votes_yes = 3 u_nb_votes_total = 4 u_uid = 5 u_email = 6 u_nickname = 7 if not users_data: return self.tmpl_warnings([(_("There have been no reports so far."), 'green')]) user_rows = "" for utuple in users_data: com_label = _("View all %s reported comments") % utuple[u_comment_reports] com_link = '''%s
''' % \ (weburl, ln, utuple[u_uid], com_label) rev_label = _("View all %s reported reviews") % utuple[u_reviews_reports] rev_link = '''%s''' % \ (weburl, ln, utuple[u_uid], rev_label) if not utuple[u_nickname]: user_info = get_user_info(utuple[u_uid]) nickname = user_info[2] else: nickname = utuple[u_nickname] if cfg_webcomment_allow_reviews: review_row = """
" out += _("Here is a list, sorted by total number of reports, of all users who have had a comment reported at least once.") out += """
| """ out += _("Nickname") + ' | \n' out += indent_text('' + _("Email") + ' | \n', 3) out += indent_text('' + _("User ID") + ' | \n', 3) if cfg_webcomment_allow_reviews > 0: out += indent_text('' + _("Number positive votes") + ' | \n', 3) out += indent_text('' + _("Number negative votes") + ' | \n', 3) out += indent_text('' + _("Total number votes") + ' | \n', 3) out += indent_text('' + _("Total number of reports") + ' | \n', 3) out += indent_text('' + _("View all user's reported comments/reviews") + ' | \n', 3) out += """
|---|
%(uid_label)s: %(uid)i
%(email_label)s: %(email)s""" out %= {'nickname_label': _("Nickname"), 'messaging': self.create_messaging_link(uid, nickname, ln), 'uid_label': _("User ID"), 'uid': int(uid), 'email_label': _("Email"), 'email': email} return out def tmpl_admin_review_info(self, ln, reviews, nb_reports, cmt_id, rec_id): """ outputs information about a review """ _ = gettext_set_language(ln) if reviews: reported_label = _("This review has been reported %i times") else: reported_label = _("This comment has been reported %i times") reported_label %= int(nb_reports) out = """ %(reported_label)s
%(rec_id_label)s
%(cmt_id_label)s""" out %= {'reported_label': reported_label, 'rec_id_label': _("Record") + ' #' + str(rec_id), 'weburl': weburl, 'rec_id': int(rec_id), 'cmt_id_label': _("Comment") + ' #' + str(cmt_id), 'ln': ln} return out def tmpl_admin_comments(self, ln, uid, comID, comment_data, reviews): """ @param comment_data: same type of tuple as that which is returned by webcomment.py/query_retrieve_comments_or_remarks i.e. tuple of comment where comment is tuple (nickname, date_creation, body, id) if ranking disabled or tuple (nickname, date_creation, body, nb_votes_yes, nb_votes_total, star_score, title, id) """ _ = gettext_set_language(ln) comments = [] comments_info = [] checkboxes = [] users = [] for (cmt_tuple, meta_data) in comment_data: if reviews: comments.append(self.tmpl_get_comment_with_ranking(ln, cmt_tuple[0],#nickname cmt_tuple[2],#date_creation cmt_tuple[3],#body cmt_tuple[5],#nb_votes_total cmt_tuple[4],#nb_votes_yes cmt_tuple[6],#star_score cmt_tuple[7]))#title else: comments.append(self.tmpl_get_comment_without_ranking(ln, cmt_tuple[0],#nickname cmt_tuple[2],#date_creation cmt_tuple[3],#body None, #reply_link None)) #report_link users.append(self.tmpl_admin_user_info(ln, meta_data[0], #nickname meta_data[1], #uid meta_data[2]))#email comments_info.append(self.tmpl_admin_review_info(ln, reviews, meta_data[5], # nb abuse reports meta_data[3], # cmt_id meta_data[4]))# rec_id checkboxes.append(self.tmpl_admin_select_comment_checkbox(meta_data[3])) form_link = "%s/admin/webcomment/webcommentadmin.py/del_com?ln=%s" % (weburl, ln) out = """
| %(review_label)s | %(written_by_label)s | %(review_info_label)s | %(select_label)s |
|---|---|---|---|
| %s | %s | %s | %s |
' if reviews: header += _("Here are the reported reviews of user %s") % uid else: header += _("Here are the reported comments of user %s") % uid header += '
' if comID > 0: header = '
' +_("Here is comment/review %s")% comID + '
' if uid > 0 and comID > 0: header = '
' + _("Here is comment/review %(x_cmtID)s written by user %(x_user)s") % {'x_cmtID': comID, 'x_user': uid} header += '
' if uid == 0 and comID == 0: header = '
' if reviews: header += _("Here are all reported reviews sorted by the most reported") else: header += _("Here are all reported comments sorted by the most reported") header += "
" return header + form def tmpl_admin_del_com(self, del_res, ln=cdslang): """ @param del_res: list of the following tuple (comment_id, was_successfully_deleted), was_successfully_deleted is boolean (0=false, >0=true """ _ = gettext_set_language(ln) table_rows = '' for deltuple in del_res: table_rows += """
| %s | %s | |||||||||||||||
| %s | %s | |||||||||||||||
| %s | %s | |||||||||||||||
| %s | %s | %s | %s |
| %s | |||
| %s | %s | %s | |
%(format)s: """ % {
- 'format' : _("Format")
+ out = """ '
if row.has_key ('citinglist'):
cs = row ['citinglist']
similar = self.tmpl_print_record_list_for_similarity_boxen(
_("Cited by: %s records") % len (cs), cs, ln)
out += '''
'
if row.has_key ('viewsimilarity'):
out += '
"
return out
def tmpl_search_no_boolean_hits(self, ln, nearestterms):
"""No hits found, proposes alternative boolean queries
Parameters:
- 'ln' *string* - The language to display
- 'weburl' *string* - The base URL for the site
- 'nearestterms' *array* - Parts of the interface to display, in the format:
- 'nearestterms[nbhits]' *int* - The resulting number of hits
- 'nearestterms[url_args]' *string* - The search parameters
- 'nearestterms[p]' *string* - The search terms
"""
# load the right message language
_ = gettext_set_language(ln)
out = _("Boolean query returned no hits. Please combine your search terms differently.")
out += '''
"""
return out
def tmpl_print_record_detailed(self, recID, ln, weburl):
"""Displays a detailed on-the-fly record
Parameters:
- 'ln' *string* - The language to display
- 'weburl' *string* - The base URL for the site
- 'recID' *int* - The record id
"""
# okay, need to construct a simple "Detailed record" format of our own:
out = "%s " % title
# thirdly, authors:
authors = get_fieldvalues(recID, "100__a") + get_fieldvalues(recID, "700__a")
if authors:
out += ""
for author in authors:
out += '%s; ' % a_href(cgi.escape(author),
href=self.build_search_url(ln=ln, p=author, f='author'))
out += " "
# fourthly, date of creation:
dates = get_fieldvalues(recID, "260__c")
for date in dates:
out += "%s " % date
# fifthly, abstract:
abstracts = get_fieldvalues(recID, "520__a")
for abstract in abstracts:
out += """
"""
return out
def tmpl_print_record_brief(self, ln, recID, weburl):
"""Displays a brief record on-the-fly
Parameters:
- 'ln' *string* - The language to display
- 'weburl' *string* - The base URL for the site
- 'recID' *int* - The record id
"""
out = ""
# record 'recID' does not exist in format 'format', so print some default format:
# firstly, title:
titles = get_fieldvalues(recID, "245__a")
# secondly, authors:
authors = get_fieldvalues(recID, "100__a") + get_fieldvalues(recID, "700__a")
# thirdly, date of creation:
dates = get_fieldvalues(recID, "260__c")
# thirdly bis, report numbers:
rns = get_fieldvalues(recID, "037__a")
rns = get_fieldvalues(recID, "088__a")
# fourthly, beginning of abstract:
abstracts = get_fieldvalues(recID, "520__a")
# fifthly, fulltext link:
urls_z = get_fieldvalues(recID, "8564_z")
urls_u = get_fieldvalues(recID, "8564_u")
return self.tmpl_record_body(
weburl = weburl,
titles = titles,
authors = authors,
dates = dates,
rns = rns,
abstracts = abstracts,
urls_u = urls_u,
urls_z = urls_z,
ln=ln)
def tmpl_print_record_brief_links(self, ln, recID, weburl):
"""Displays links for brief record on-the-fly
Parameters:
- 'ln' *string* - The language to display
- 'weburl' *string* - The base URL for the site
- 'recID' *int* - The record id
"""
# load the right message language
_ = gettext_set_language(ln)
out = ""
if cfg_use_aleph_sysnos:
alephsysnos = get_fieldvalues(recID, "970__a")
if len(alephsysnos)>0:
alephsysno = alephsysnos[0]
out += '
%s' % \ a_href(_("Detailed record"), _class="moreinfo", href=self.build_search_url(sysno=alephsysno, ln=ln)) else: out += '
%s' % \ a_href(_("Detailed record"), _class="moreinfo", href=self.build_search_url(recid=recID, ln=ln)) else: out += '
%s' % \ a_href(_("Detailed record"), _class="moreinfo", href=self.build_search_url(recid=recID, ln=ln)) out += ' - %s' % \ a_href(_("Similar records"), _class="moreinfo", href=self.build_search_url(p="recid:%d" % recID, rm="wrd", ln=ln)) if cfg_experimental_features: out += ' - %s' % \ a_href(_("Cited by"), _class="moreinfo", href=self.build_search_url(p="recid:%d" % recID, rm="cit", ln=ln)) return out diff --git a/modules/websession/lib/webaccount.py b/modules/websession/lib/webaccount.py index ad26b1738..8fb90fa8f 100644 --- a/modules/websession/lib/webaccount.py +++ b/modules/websession/lib/webaccount.py @@ -1,252 +1,255 @@ ## $Id$ ## This file is part of CDS Invenio. ## Copyright (C) 2002, 2003, 2004, 2005, 2006 CERN. ## ## CDS 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. ## ## CDS 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 CDS Invenio; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. import sys import string import cgi from invenio.config import * from invenio.webpage import page from invenio.dbquery import run_sql from invenio.webuser import getUid,isGuestUser, get_user_preferences, set_user_preferences from invenio.access_control_admin import acc_findUserRoleActions from invenio.access_control_config import CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS, CFG_EXTERNAL_AUTHENTICATION from invenio.messages import gettext_set_language import invenio.template websession_templates = invenio.template.load('websession') # perform_info(): display the main features of CDS personalize def perform_info(req, ln): out = "" uid = getUid(req) return websession_templates.tmpl_account_info( ln = ln, uid = uid, guest = isGuestUser(uid), cfg_cern_site = cfg_cern_site, ); def perform_youradminactivities(uid, ln): """Return text for the `Your Admin Activities' box. Analyze whether user UID has some admin roles, and if yes, then print suitable links for the actions he can do. If he's not admin, print a simple non-authorized message.""" your_role_actions = acc_findUserRoleActions(uid) your_roles = [] your_admin_activities = [] guest = isGuestUser(uid) for (role, action) in your_role_actions: if role not in your_roles: your_roles.append(role) if action not in your_admin_activities: your_admin_activities.append(action) if "superadmin" in your_roles: for action in ["runbibedit", "cfgbibformat", "cfgbibharvest", "cfgbibrank", "cfgbibindex", "cfgwebaccess", "cfgwebcomment", "cfgwebsearch", "cfgwebsubmit"]: if action not in your_admin_activities: your_admin_activities.append(action) return websession_templates.tmpl_account_adminactivities( ln = ln, uid = uid, guest = guest, roles = your_roles, activities = your_admin_activities, weburl = weburl, ) # perform_display_account(): display a dynamic page that shows the user's account def perform_display_account(req,username,bask,aler,sear,msgs,grps,ln): # load the right message language _ = gettext_set_language(ln) uid = getUid(req) #your account if isGuestUser(uid): user = "guest" login = "%s/youraccount/login?ln=%s" % (sweburl, ln) - accBody = _("You are logged in as guest. You may want to %slogin%s as a regular user.") % ('', '') + accBody = _("You are logged in as guest. You may want to %(x_url_open)slogin%(x_url_close)s as a regular user.") %\ + {'x_url_open': '', + 'x_url_close': ''} accBody += "
" - bask=aler=msgs= _("The %sguest%s users need to %sregister%s first") % ('', - '', - '', - '') + bask=aler=msgs= _("The %(x_fmt_open)sguest%(x_fmt_close)s users need to %(x_url_open)sregister%(x_url_close)s first") %\ + {'x_fmt_open': '', + 'x_fmt_close': '', + 'x_url_open': '', + 'x_url_close': ''} sear= _("No queries found") else: user = username accBody = websession_templates.tmpl_account_body( ln = ln, user = user, ) return websession_templates.tmpl_account_page( ln = ln, weburl = weburl, accBody = accBody, baskets = bask, alerts = aler, searches = sear, messages = msgs, groups = grps, administrative = perform_youradminactivities(uid, ln) ) # template_account() : it is a template for print each of the options from the user's account def template_account(title, body, ln): return websession_templates.tmpl_account_template( ln = ln, title = title, body = body ) # warning_guest_user(): It returns an alert message,showing that the user is a guest user and should log into the system def warning_guest_user(type, ln=cdslang): # load the right message language _ = gettext_set_language(ln) return websession_templates.tmpl_warning_guest_user( ln = ln, type = type, ) ## perform_delete():delete the account of the user, not implement yet def perform_delete(ln): return websession_templates.tmpl_account_delete(ln = ln) ## perform_set(email,password): edit your account parameters, email and password. def perform_set(email,password, ln): try: res = run_sql("SELECT id, nickname FROM user WHERE email=%s", (email,)) uid = res[0][0] nickname = res[0][1] except: uid = 0 nickname = "" CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS_LOCAL = CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS prefs = get_user_preferences(uid) if CFG_EXTERNAL_AUTHENTICATION.has_key(prefs['login_method']) and CFG_EXTERNAL_AUTHENTICATION[prefs['login_method']][1] != True: CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS_LOCAL = 3 out = websession_templates.tmpl_user_preferences( ln = ln, email = email, email_disabled = (CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS_LOCAL >= 2), password = password, password_disabled = (CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS_LOCAL >= 3), nickname = nickname, ) if len(CFG_EXTERNAL_AUTHENTICATION) >= 1: try: uid = run_sql("SELECT id FROM user where email=%s", (email,)) uid = uid[0][0] except: uid = 0 prefs = get_user_preferences(uid) current_login_method = prefs['login_method'] methods = CFG_EXTERNAL_AUTHENTICATION.keys() methods.sort() out += websession_templates.tmpl_user_external_auth( ln = ln, methods = methods, current = current_login_method, method_disabled = (CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS >= 4) ) return out ## create_register_page_box(): register a new account def create_register_page_box(referer='', ln=cdslang): return websession_templates.tmpl_register_page( referer = referer, ln = ln, level = CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS, supportemail = supportemail, cdsname = cdsname ) ## create_login_page_box(): ask for the user's email and password, for login into the system def create_login_page_box(referer='', ln=cdslang): internal = None for system in CFG_EXTERNAL_AUTHENTICATION.keys(): if not CFG_EXTERNAL_AUTHENTICATION[system][0]: internal = system break register_available = CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS <= 1 and internal methods = CFG_EXTERNAL_AUTHENTICATION.keys() methods.sort() selected = '' for method in methods: if CFG_EXTERNAL_AUTHENTICATION[method][1] == True: selected = method break return websession_templates.tmpl_login_form( ln = ln, referer = referer, internal = internal, register_available = register_available, methods = methods, selected_method = selected, supportemail = supportemail, ) # perform_logout: display the message of not longer authorized, def perform_logout(req, ln): return websession_templates.tmpl_account_logout(ln = ln) #def perform_lost: ask the user for his email, in order to send him the lost password def perform_lost(ln): return websession_templates.tmpl_lost_password_form( ln = ln, msg = websession_templates.tmpl_lost_password_message(ln = ln, supportemail = supportemail), ) # perform_emailSent(email): confirm that the password has been emailed to 'email' address def perform_emailSent(email, ln): return websession_templates.tmpl_account_emailSent(ln = ln, email = email) # peform_emailMessage : display a error message when the email introduced is not correct, and sugest to try again def perform_emailMessage(eMsg, ln): return websession_templates.tmpl_account_emailMessage( ln = ln, msg = eMsg ) # perform_back(): template for return to a previous page, used for login,register and setting def perform_back(mess,act,linkname='', ln='en'): if not linkname: linkname = act return websession_templates.tmpl_back_form( ln = ln, message = mess, act = act, link = linkname, ) diff --git a/modules/websession/lib/webgroup.py b/modules/websession/lib/webgroup.py index cf615400b..e4cb5a89b 100644 --- a/modules/websession/lib/webgroup.py +++ b/modules/websession/lib/webgroup.py @@ -1,718 +1,718 @@ ## $Id$ ## This file is part of CDS Invenio. ## Copyright (C) 2002, 2003, 2004, 2005, 2006 CERN. ## ## CDS 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. ## ## CDS 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 CDS Invenio; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. """Group features.""" from invenio.config import cdslang from invenio.messages import gettext_set_language from invenio.websession_config import cfg_websession_info_messages, cfg_websession_usergroup_status, cfg_websession_group_join_policy, cfg_websession_warning_messages from invenio.webuser import nickname_valid_p, get_user_info from invenio.webmessage import perform_request_send import invenio.webgroup_dblayer as db try: import invenio.template websession_templates = invenio.template.load('websession') except ImportError: pass def perform_request_group_display(uid, infos=[], errors = [], warnings = [], ln=cdslang): """Display all the groups the user belong to @param uid: user id @param info: info about last user action @param ln: language @return a (body, errors[], warnings[]) formed tuple """ _ = gettext_set_language(ln) body = "" (body_admin, errors_admin) = display_admin_group(uid) (body_member, errors_member) = display_member_group(uid) if errors_admin: errors.extend(errors_admin) if errors_member: errors.extend(errors_member) body = websession_templates.tmpl_display_all_groups(infos=infos, admin_group_html=body_admin, member_group_html=body_member, warnings=warnings, ln=ln) return (body, errors, warnings) def display_admin_group(uid, ln=cdslang): """Display groups the user is admin of @param uid: user id @param ln: language @return a (body, errors[]) formed tuple return html groups representation the user is admin of""" body = "" errors = [] record = db.get_groups_by_user_status(uid=uid, user_status=cfg_websession_usergroup_status["ADMIN"]) body = websession_templates.tmpl_display_admin_group(groups=record, ln=ln) return (body, errors) def display_member_group(uid, ln=cdslang): """Display groups the user is member of @param uid: user id @param ln: language @return a (body, errors[]) formed tuple body : html groups representation the user is member of""" body = "" errors = [] records = db.get_groups_by_user_status(uid, user_status=cfg_websession_usergroup_status["MEMBER"] ) body = websession_templates.tmpl_display_member_group(groups=records, ln=ln) return (body, errors) def perform_request_input_create_group(group_name, group_description, join_policy, warnings=[], ln=cdslang): """Display form for creating new group. @param group_name: name of the group entered if the page has been reloaded @param group_description: description entered if the page has been reloaded @param join_policy: join policy chosen if the page has been reloaded @param warnings: warnings @param ln: language @return a (body, errors[], warnings[]) formed tuple body: html for group creation page""" body = "" errors = [] body = websession_templates.tmpl_display_input_group_info(group_name, group_description, join_policy, act_type="create", warnings=warnings, ln=ln) return (body, errors, warnings) def perform_request_create_group(uid, group_name, group_description, join_policy, ln=cdslang): """Create new group @param group_name: name of the group entered @param group_description: description of the group entered @param join_policy: join policy of the group entered @param ln: language @return a (body, errors, warnings) formed tuple warning != [] if group_name or join_policy are not valid or if the name already exists in the database body="1" if succeed in order to display info on the main page """ _ = gettext_set_language(ln) body = "" warnings = [] errors = [] infos = [] if group_name == "": warnings.append(('WRN_WEBSESSION_NO_GROUP_NAME',)) (body, errors, warnings) = perform_request_input_create_group(group_name, group_description, join_policy, warnings=warnings) elif not group_name_valid_p(group_name): warnings.append('WRN_WEBSESSION_NOT_VALID_GROUP_NAME') (body, errors, warnings) = perform_request_input_create_group(group_name, group_description, join_policy, warnings=warnings) elif join_policy=="-1": warnings.append('WRN_WEBSESSION_NO_JOIN_POLICY') (body, errors, warnings) = perform_request_input_create_group(group_name, group_description, join_policy, warnings=warnings) elif db.group_name_exist(group_name): warnings.append('WRN_WEBSESSION_GROUP_NAME_EXISTS') (body, errors, warnings) = perform_request_input_create_group(group_name, group_description, join_policy, warnings=warnings) else: db.insert_new_group(uid, group_name, group_description, join_policy) infos.append(_(cfg_websession_info_messages["GROUP_CREATED"])) (body, errors, warnings) = perform_request_group_display(uid, infos=infos, errors=errors, warnings=warnings, ln=cdslang) return (body, errors, warnings) def perform_request_input_join_group(uid, group_name, search, warnings=[], ln=cdslang): """Return html for joining new group @param group_name: name of the group entered if user is looking for a group @param search=1 if search performed else 0 @param warnings: warnings coming from perform_request_join_group @param ln: language @return a (body, errors[], warnings[]) formed tuple """ errors = [] group_from_search = {} records = db.get_visible_group_list(uid=uid) if search: group_from_search = db.get_visible_group_list(uid, group_name) body = websession_templates.tmpl_display_input_join_group(records.items(), group_name, group_from_search.items(), search, warnings=warnings, ln=ln) return (body, errors, warnings) def perform_request_join_group(uid, grpID, group_name, search, ln=cdslang): """Join group @param grpID: list of the groups the user wants to join, only one value must be selected among the two group lists (default group list, group list resulting from the search) @param group_name: name of the group entered if search on name performed @param search=1 if search performed else 0 @param ln: language @return a (body, errors[], warnings[]) formed tuple warnings != [] if 0 or more than one group is selected """ _ = gettext_set_language(ln) body = "" warnings = [] errors = [] infos = [] if "-1" in grpID: grpID.remove("-1") if len(grpID)==1 : grpID = grpID[0] """test if user is already member or pending""" status = db.get_user_status(uid, grpID) if status: warnings.append('WRN_WEBSESSION_ALREADY_MEMBER') (body, errors, warnings) = perform_request_group_display(uid, infos=infos, errors=errors, warnings=warnings, ln=cdslang) """insert new user of group""" else: group_infos = db.get_group_infos(grpID) group_type = group_infos[0][3] if group_type == cfg_websession_group_join_policy["VISIBLEMAIL"]: db.insert_new_member(uid, grpID, cfg_websession_usergroup_status["PENDING"]) admin = db.get_users_by_status(grpID, cfg_websession_usergroup_status["ADMIN"])[0][1] group_name = group_infos[0][1] msg_subjet, msg_body = websession_templates.tmpl_admin_msg(group_name=group_name, grpID=grpID, ln=ln) (body, errors, warnings, title, navtrail) = perform_request_send(uid, msg_to_user=admin, msg_to_group="", msg_subject=msg_subjet, msg_body=msg_body, ln=ln) infos.append(_(cfg_websession_info_messages["JOIN_REQUEST"])) elif group_type == cfg_websession_group_join_policy["VISIBLEOPEN"]: db.insert_new_member(uid, grpID, cfg_websession_usergroup_status["MEMBER"]) infos.append(_(cfg_websession_info_messages["JOIN_GROUP"])) (body, errors, warnings) = perform_request_group_display(uid, infos=infos, errors=errors, warnings=warnings, ln=cdslang) else: warnings.append('WRN_WEBSESSION_MULTIPLE_GROUPS') (body, errors, warnings) = perform_request_input_join_group(uid, group_name, search, warnings, ln) return (body, errors, warnings) def perform_request_input_leave_group(uid, warnings=[], ln=cdslang): """Return html for leaving group @param uid: user ID @param warnings: warnings != [] if 0 group is selected or if not admin of the @param ln: language @return a (body, errors[], warnings[]) formed tuple """ body = "" errors = [] groups = [] records = db.get_groups_by_user_status(uid=uid, user_status=cfg_websession_usergroup_status["MEMBER"]) map(lambda x: groups.append((x[0], x[1])), records) body = websession_templates.tmpl_display_input_leave_group(groups, warnings=warnings, ln=ln) return (body, errors, warnings) def perform_request_leave_group(uid, grpID, confirmed=0, ln=cdslang): """Leave group @param uid: user ID @param grpID: ID of the group the user wants to leave @param warnings: warnings != [] if 0 group is selected @param confirmed: a confirmed page is first displayed @param ln: language @return a (body, errors[], warnings[]) formed tuple """ _ = gettext_set_language(ln) body = "" warnings = [] errors = [] infos = [] if not grpID == "-1": if confirmed: db.leave_group(grpID, uid) infos.append(_(cfg_websession_info_messages["LEAVE_GROUP"])) (body, errors, warnings) = perform_request_group_display(uid, infos=infos, errors=errors, warnings=warnings, ln=cdslang) else: body = websession_templates.tmpl_confirm_leave(uid, grpID, ln) else: warnings.append('WRN_WEBSESSION_NO_GROUP_SELECTED') (body, errors, warnings) = perform_request_input_leave_group(uid, warnings= warnings, ln=ln) return (body, errors, warnings) def perform_request_edit_group(uid, grpID, warnings=[], ln=cdslang): """Return html for group editing @param uid: user ID @param grpID: ID of the group @param warnings: warnings @param ln: language @return a (body, errors[], warnings[]) formed tuple """ body = '' errors = [] user_status = db.get_user_status(uid, grpID) if not len(user_status): errors.append('ERR_WEBSESSION_DB_ERROR') return (body, errors, warnings) elif user_status[0][0] != cfg_websession_usergroup_status['ADMIN']: errors.append(('ERR_WEBSESSION_GROUP_NO_RIGHTS',)) return (body, errors, warnings) group_infos = db.get_group_infos(grpID)[0] if not len(group_infos): errors.append('ERR_WEBSESSION_DB_ERROR') return (body, errors, warnings) body = websession_templates.tmpl_display_input_group_info(group_name=group_infos[1], group_description=group_infos[2], join_policy=group_infos[3], act_type="update", grpID=grpID, warnings=warnings, ln=ln) return (body, errors, warnings) def perform_request_update_group(uid, grpID, group_name, group_description, join_policy, ln=cdslang): """Update group datas in database @param uid: user ID @param grpID: ID of the group @param group_name: name of the group @param group_description: description of the group @param join_policy: join policy of the group @param ln: language @return a (body, errors[], warnings[]) formed tuple """ body = '' errors = [] warnings = [] infos = [] _ = gettext_set_language(ln) group_name_available = db.group_name_exist(group_name) if group_name == "": warnings.append('WRN_WEBSESSION_NO_GROUP_NAME') (body, errors, warnings) = perform_request_edit_group(uid, grpID, warnings=warnings, ln=ln) elif not group_name_valid_p(group_name): warnings.append('WRN_WEBSESSION_NOT_VALID_GROUP_NAME') (body, errors, warnings) = perform_request_edit_group(uid, grpID, warnings=warnings, ln=ln) elif join_policy == "-1": warnings.append('WRN_WEBSESSION_NO_JOIN_POLICY') (body, errors, warnings) = perform_request_edit_group(uid, grpID, warnings=warnings, ln=ln) elif (group_name_available and group_name_available[0][0]!= int(grpID)): warnings.append('WRN_WEBSESSION_GROUP_NAME_EXISTS') (body, errors, warnings) = perform_request_edit_group(uid, grpID, warnings=warnings, ln=ln) else: grpID = db.update_group_infos(grpID, group_name, group_description, join_policy) infos.append(_(cfg_websession_info_messages["GROUP_UPDATED"])) (body, errors, warnings) = perform_request_group_display(uid, infos=infos, errors=errors, warnings=warnings, ln=cdslang) return (body, errors, warnings) def perform_request_delete_group(uid, grpID, confirmed=0, ln=cdslang): """First display confirm message(confirmed=0) then(confirmed=1) delete group and all its members @param uid: user ID @param grpID: ID of the group @param confirmed =1 if confirmed message has been previously displayed @param ln: language @return a (body, errors[], warnings[]) formed tuple """ body = "" warnings = [] errors = [] infos = [] _ = gettext_set_language(ln) group_infos = db.get_group_infos(grpID) user_status = db.get_user_status(uid, grpID) if not group_infos: warnings.append('WRN_WEBSESSION_GROUP_ALREADY_DELETED') (body, errors, warnings) = perform_request_group_display(uid, infos=infos, errors=errors, warnings=warnings, ln=cdslang) else: if not len(user_status): errors.append('ERR_WEBSESSION_DB_ERROR') elif confirmed: group_infos = db.get_group_infos(grpID) group_name = group_infos[0][1] msg_subjet, msg_body = websession_templates.tmpl_delete_msg(group_name=group_name, ln=ln) (body, errors, warnings, title, navtrail) = perform_request_send(uid, msg_to_user="", msg_to_group=group_name, msg_subject=msg_subjet, msg_body=msg_body, ln=ln) db.delete_group_and_members(grpID) infos.append(_(cfg_websession_info_messages["GROUP_DELETED"])) (body, errors, warnings) = perform_request_group_display(uid, infos=infos, errors=errors, warnings=warnings, ln=cdslang) else: body = websession_templates.tmpl_confirm_delete(grpID, ln) return (body, errors, warnings) def perform_request_manage_member(uid, grpID, infos=[], warnings=[], ln=cdslang): """Return html for managing group's members @param uid: user ID @param grpID: ID of the group @param info: info about last user action @param warnings: warnings @param ln: language @return a (body, errors[], warnings[]) formed tuple """ body = '' errors = [] _ = gettext_set_language(ln) user_status = db.get_user_status(uid, grpID) if not len(user_status): errors.append('ERR_WEBSESSION_DB_ERROR') return (body, errors, warnings) elif user_status[0][0] != cfg_websession_usergroup_status['ADMIN']: errors.append(('ERR_WEBSESSION_GROUP_NO_RIGHTS',)) return (body, errors, warnings) group_infos = db.get_group_infos(grpID) if not len(group_infos): errors.append('ERR_WEBSESSION_DB_ERROR') return (body, errors, warnings) members = db.get_users_by_status(grpID, cfg_websession_usergroup_status["MEMBER"]) pending_members = db.get_users_by_status(grpID, cfg_websession_usergroup_status["PENDING"]) body = websession_templates.tmpl_display_manage_member(grpID=grpID, group_name=group_infos[0][1], members=members, pending_members=pending_members, warnings=warnings, infos=infos, ln=ln) return (body, errors, warnings) def perform_request_remove_member(uid, grpID, member_id, ln=cdslang): """Remove member from a group @param uid: user ID @param grpID: ID of the group @param member_id: selected member ID @param ln: language @return a (body, errors[], warnings[]) formed tuple """ body = '' errors = [] warnings = [] infos = [] _ = gettext_set_language(ln) user_status = db.get_user_status(uid, grpID) if not len(user_status): errors.append('ERR_WEBSESSION_DB_ERROR') return (body, errors, warnings) if member_id == -1: warnings.append('WRN_WEBSESSION_NO_MEMBER_SELECTED') (body, errors, warnings) = perform_request_manage_member(uid, grpID, warnings=warnings, ln=ln) else: db.delete_member(grpID, member_id) infos.append(_(cfg_websession_info_messages["MEMBER_DELETED"])) (body, errors, warnings) = perform_request_manage_member(uid, grpID, infos=infos, warnings=warnings, ln=ln) return (body, errors, warnings) def perform_request_add_member(uid, grpID, user_id, ln=cdslang): """Add waiting member to a group @param uid: user ID @param grpID: ID of the group @param user_id: selected member ID @param ln: language @return a (body, errors[], warnings[]) formed tuple """ body = '' errors = [] warnings = [] infos = [] _ = gettext_set_language(ln) user_status = db.get_user_status(uid, grpID) if not len(user_status): errors.append('ERR_WEBSESSION_DB_ERROR') return (body, errors, warnings) if user_id == -1: warnings.append('WRN_WEBSESSION_NO_USER_SELECTED_ADD') (body, errors, warnings) = perform_request_manage_member(uid, grpID, warnings=warnings, ln=ln) else : """test if user is already member or pending""" status = db.get_user_status(user_id, grpID) if status and status[0][0] == 'M': warnings.append('WRN_WEBSESSION_ALREADY_MEMBER_ADD') (body, errors, warnings) = perform_request_manage_member(uid, grpID, infos=infos, warnings=warnings, ln=ln) else: db.add_pending_member(grpID, user_id, cfg_websession_usergroup_status["MEMBER"]) infos.append(_(cfg_websession_info_messages["MEMBER_ADDED"])) group_infos = db.get_group_infos(grpID) group_name = group_infos[0][1] user = get_user_info(user_id, ln)[2] msg_subjet, msg_body = websession_templates.tmpl_member_msg(group_name=group_name, - status=_("accepted"), + accepted=1, ln=ln) (body, errors, warnings, title, navtrail) = perform_request_send(uid, msg_to_user=user, msg_to_group="", msg_subject=msg_subjet, msg_body=msg_body, ln=ln) (body, errors, warnings) = perform_request_manage_member(uid, grpID, infos=infos, warnings=warnings, ln=ln) return (body, errors, warnings) def perform_request_reject_member(uid, grpID, user_id, ln=cdslang): """Reject waiting member and delete it from the list @param uid: user ID @param grpID: ID of the group @param member_id: selected member ID @param ln: language @return a (body, errors[], warnings[]) formed tuple """ body = '' errors = [] warnings = [] infos = [] _ = gettext_set_language(ln) user_status = db.get_user_status(uid, grpID) if not len(user_status): errors.append('ERR_WEBSESSION_DB_ERROR') return (body, errors, warnings) if user_id == -1: warnings.append('WRN_WEBSESSION_NO_USER_SELECTED_DEL') (body, errors, warnings) = perform_request_manage_member(uid, grpID, warnings=warnings, ln=ln) else : """test if user is already member or pending""" status = db.get_user_status(user_id, grpID) if not status: warnings.append('WRN_WEBSESSION_ALREADY_MEMBER_REJECT') (body, errors, warnings) = perform_request_manage_member(uid, grpID, infos=infos, warnings=warnings, ln=ln) else: db.delete_member(grpID, user_id) group_infos = db.get_group_infos(grpID) group_name = group_infos[0][1] user = get_user_info(user_id, ln)[2] msg_subjet, msg_body = websession_templates.tmpl_member_msg(group_name=group_name, - status=_("rejected"), + accepted=0, ln=ln) (body, errors, warnings, title, navtrail) = perform_request_send(uid, msg_to_user=user, msg_to_group="", msg_subject=msg_subjet, msg_body=msg_body, ln=ln) infos.append(_(cfg_websession_info_messages["MEMBER_REJECTED"])) (body, errors, warnings) = perform_request_manage_member(uid, grpID, infos=infos, warnings=warnings, ln=ln) return (body, errors, warnings) def account_group(uid, ln=cdslang): """ display group info for myaccount.py page. @param uid: user id (int) @param ln: language @return html body """ nb_admin_groups = db.count_nb_group_user(uid, cfg_websession_usergroup_status["ADMIN"]) nb_member_groups = db.count_nb_group_user(uid, cfg_websession_usergroup_status["MEMBER"]) nb_total_groups = nb_admin_groups + nb_member_groups return websession_templates.tmpl_group_info(nb_admin_groups, nb_member_groups, nb_total_groups, ln=ln) def get_navtrail(ln=cdslang, title=""): """ gets the navtrail for title... @param title: title of the page @param ln: language @return HTML output """ navtrail = websession_templates.tmpl_navtrail(ln, title) return navtrail def group_name_valid_p(group_name): """Test if the group's name is valid""" return nickname_valid_p(group_name) diff --git a/modules/websession/lib/websession_templates.py b/modules/websession/lib/websession_templates.py index 8ebf130ba..ada5014db 100644 --- a/modules/websession/lib/websession_templates.py +++ b/modules/websession/lib/websession_templates.py @@ -1,1797 +1,1815 @@ ## $Id$ ## This file is part of CDS Invenio. ## Copyright (C) 2002, 2003, 2004, 2005, 2006 CERN. ## ## CDS 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. ## ## CDS 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 CDS Invenio; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. import urllib import time import cgi import gettext import string import locale from invenio.config import * from invenio.messages import gettext_set_language from invenio.textutils import indent_text from invenio.websession_config import cfg_websession_group_join_policy class Template: def tmpl_lost_password_message(self, ln, supportemail): """ Defines the text that will be displayed on the 'lost password' page Parameters: - 'ln' *string* - The language to display the interface in - 'supportemail' *string* - The email of the support team """ # load the right message language _ = gettext_set_language(ln) return _("If you have lost password for your CDS Invenio internal account, then please enter your email address below and the lost password will be emailed to you.") +\ "
" +\ _("Note that if you have been using an external login system (such as CERN NICE), then we cannot do anything and you have to ask there.") +\ _("Alternatively, you can ask %s to change your login system from external to internal.") % ("""%(email)s""" % { 'email' : supportemail }) +\ "
" def tmpl_back_form(self, ln, message, act, link): """ A standard one-message-go-back-link page. Parameters: - 'ln' *string* - The language to display the interface in - 'message' *string* - The message to display - 'act' *string* - The action to accomplish when going back - 'link' *string* - The link text """ out = """
"""% {
'message' : message,
'act' : act,
'link' : link
}
return out
def tmpl_user_preferences(self, ln, email, email_disabled, password, password_disabled, nickname):
"""
Displays a form for the user to change his email/password.
Parameters:
- 'ln' *string* - The language to display the interface in
- 'email' *string* - The email of the user
- 'email_disabled' *boolean* - If the user has the right to edit his email
- 'password' *string* - The password of the user
- 'password_disabled' *boolean* - If the user has the right to edit his password
- 'nickname' *string* - The nickname of the user (empty string if user does not have it)
"""
# load the right message language
_ = gettext_set_language(ln)
out = """
'+_("Example")+':johnd' or '', 'new_email' : _("New email address"), 'mandatory' : _("mandatory"), 'example' : _("Example"), 'new_password' : _("New password"), 'optional' : _("optional"), 'note' : _("Note"), 'password_note' : _("The password phrase may contain punctuation, spaces, etc."), 'retype_password' : _("Retype password"), 'set_values' : _("Set new values"), 'email' : email, 'email_disabled' : email_disabled and "disabled" or "", 'password' : password, 'password_disabled' : password_disabled and "disabled" or "", 'sweburl': sweburl, } return out def tmpl_user_external_auth(self, ln, methods, current, method_disabled): """ Displays a form for the user to change his authentication method. Parameters: - 'ln' *string* - The language to display the interface in - 'methods' *array* - The methods of authentication - 'method_disabled' *boolean* - If the user has the right to change this - 'current' *string* - The currently selected method """ # load the right message language _ = gettext_set_language(ln) out = """ """ % { 'select_method' : _("Select method"), } return out def tmpl_lost_password_form(self, ln, msg): """ Displays a form for the user to ask for his password sent by email. Parameters: - 'ln' *string* - The language to display the interface in - 'msg' *string* - Explicative message on top of the form. """ # load the right message language _ = gettext_set_language(ln) out = """ """ % { 'msg' : msg, 'email' : _("Email address"), 'send' : _("Send lost password"), } return out def tmpl_account_info(self, ln, uid, guest, cfg_cern_site): """ Displays the account information Parameters: - 'ln' *string* - The language to display the interface in - 'uid' *string* - The user id - 'guest' *boolean* - If the user is guest - 'cfg_cern_site' *boolean* - If the site is a CERN site """ # load the right message language _ = gettext_set_language(ln) out = """
""" % msg
def tmpl_account_body(self, ln, user):
"""
Displays the body of the actions of the user
Parameters:
- 'ln' *string* - The language to display the interface in
- 'user' *string* - The username (nickname or email)
"""
# load the right message language
_ = gettext_set_language(ln)
- return _("You are logged in as %(x_user)s. You may want to a) %(x_link1_begin)slogout%(x_link_end)s; b) edit your %(x_link2_begin)saccount settings%(x_link_end)s.") % {
- 'x_user': user,
- 'x_link1_begin': '',
- 'x_link_end': '',
- 'x_link2_begin': ''} + "
" + out = _("You are logged in as %(x_user)s. You may want to a) %(x_url1_open)slogout%(x_url_close)s; b) edit your %(x_url2_open)saccount settings%(x_url_close)s.") %\ + {'x_user': user, + 'x_url1_open': '', + 'x_url_close': '', + 'x_url2_open': ''} + return out + "
" def tmpl_account_template(self, title, body, ln): """ Displays a block of the your account page Parameters: - 'ln' *string* - The language to display the interface in - 'title' *string* - The title of the block - 'body' *string* - The body of the block """ out ="" out +="""
""" % (title, body)
return out
def tmpl_account_page(self, ln, weburl, accBody, baskets, alerts, searches, messages, groups, administrative):
"""
Displays the your account page
Parameters:
- 'ln' *string* - The language to display the interface in
- 'weburl' *string* - The URL of CDS Invenio
- 'accBody' *string* - The body of the heading block
- 'baskets' *string* - The body of the baskets block
- 'alerts' *string* - The body of the alerts block
- 'searches' *string* - The body of the searches block
- 'messages' *string* - The body of the messages block
- 'groups' *string* - The body of the groups block
- 'administrative' *string* - The body of the administrative block
"""
# load the right message language
_ = gettext_set_language(ln)
out = ""
out += self.tmpl_account_template(_("Your Account"), accBody, ln)
out += self.tmpl_account_template(_("Your Messages"), messages, ln)
out += self.tmpl_account_template(_("Your Baskets"), baskets, ln)
out += self.tmpl_account_template(_("Your Alert Searches"), alerts, ln)
out += self.tmpl_account_template(_("Your Searches"), searches, ln)
- out += self.tmpl_account_template(_("Your Groups"), groups, ln)
- submission_description = _("You can consult the list of %syour submissions%s and inquire about their status.")
- submission_description %= ('', '')
+ groups_description = _("You can consult the list of %(x_url_open)syour groups%(x_url_close)s you are administering or are a member of.")
+ groups_description %= {'x_url_open': '',
+ 'x_url_close': ''}
+ out += self.tmpl_account_template(_("Your Groups"), groups_description, ln)
+ submission_description = _("You can consult the list of %(x_url_open)syour submissions%(x_url_close)s and inquire about their status.")
+ submission_description %= {'x_url_open': '',
+ 'x_l_c': ''}
out += self.tmpl_account_template(_("Your Submissions"), submission_description, ln)
- approval_description = _("You can consult the list of %syour approvals%s with the documents you approved or refereed.")
- approval_description %= ('', '')
+ approval_description = _("You can consult the list of %(x_url_open)syour approvals%(x_url_close)s with the documents you approved or refereed.")
+ approval_description %= {'x_url_open': '',
+ 'x_url_close': ''}
out += self.tmpl_account_template(_("Your Approvals"), approval_description, ln)
out += self.tmpl_account_template(_("Your Administrative Activities"), administrative, ln)
return out
def tmpl_account_emailMessage(self, ln, msg):
"""
Displays a link to retrieve the lost password
Parameters:
- 'ln' *string* - The language to display the interface in
- 'msg' *string* - Explicative message on top of the form.
"""
# load the right message language
_ = gettext_set_language(ln)
out =""
out +="""
%(msg)s %(try_again)s
""" % {
'ln' : ln,
'msg' : msg,
'try_again' : _("Try again")
}
return out
def tmpl_account_emailSent(self, ln, email):
"""
Displays a confirmation message for an email sent
Parameters:
- 'ln' *string* - The language to display the interface in
- 'email' *string* - The email to which the message has been sent
"""
# load the right message language
_ = gettext_set_language(ln)
out =""
out += _("Okay, password has been emailed to %s.") % email
return out
def tmpl_account_delete(self, ln):
"""
Displays a confirmation message about deleting the account
Parameters:
- 'ln' *string* - The language to display the interface in
"""
# load the right message language
_ = gettext_set_language(ln)
out = "
%(format)s """ % {
+ 'format' : _("Format:")
}
result = []
for abbrev, name in (('hd', 'HTML'),
('hx', 'BibTeX'),
('xd', 'DC'),
('hm', 'MARC'),
('xm', 'MARCXML')):
if format == abbrev:
result.append(name)
else:
result.append(a_href(name, href=self.build_search_url(url_argd, of=abbrev)))
out += " | ".join(result)
out += "
"
for row in rows:
out += row ['record']
if format.startswith("hd"):
# do not print further information but for HTML detailed formats
if row ['creationdate']:
out += '''%(dates)s
%(similar)s
''' % { - 'dates': _("Record created %s, last modified %s") % (row['creationdate'], - row['modifydate']), + 'dates': _("Record created %(x_date_creation)s, last modified %(x_date_modification)s") % {'x_date_creation': row['creationdate'], + 'x_date_modification': row['modifydate']}, 'weburl': weburl, 'recid': row['recid'], 'ln': ln, 'similar': a_href(_("Similar records"), _class="moreinfo", href=self.build_search_url(p='recid:%d' % row['recid'], rm='wrd', ln=ln)), 'basket' : _("ADD TO BASKET") } out += '|
%(similar)s %(more)s
|
|
%(similar)s %(more)s
|
| %s |
| %(graph)s |
| %(similar)s |
' out += self.tmpl_print_record_list_for_similarity_boxen ( _("People who viewed this page also viewed:"), row ['viewsimilarity'], ln) if row.has_key ('reviews'): out += '
' out += row['reviews'] if row.has_key ('comments'): out += row['comments'] out += "
" return out def tmpl_print_results_overview(self, ln, weburl, results_final_nb_total, cpu_time, results_final_nb, colls): """Prints results overview box with links to particular collections below. Parameters: - 'ln' *string* - The language to display - 'weburl' *string* - The base URL for the site - 'results_final_nb_total' *int* - The total number of hits for the query - 'colls' *array* - The collections with hits, in the format: - 'coll[code]' *string* - The code of the collection (canonical name) - 'coll[name]' *string* - The display name of the collection - 'results_final_nb' *array* - The number of hits, indexed by the collection codes: - 'cpu_time' *string* - The time the query took - 'url_args' *string* - The rest of the search query """ if len(colls) == 1: # if one collection only, print nothing: return "" # load the right message language _ = gettext_set_language(ln) # first find total number of hits: out = """
| %(founds)s |
|---|
| """ % {
- 'founds' : _("%sResults overview:%s Found %s records in %s seconds.") % ('',
- '',
- '' + self.tmpl_nice_number(results_final_nb_total, ln) + '',
- '%.2f' % cpu_time)
+ 'founds' : _("%(x_fmt_open)sResults overview:%(x_fmt_close)s Found %(x_nb_records)s records in %(x_nb_seconds)s seconds.") %\
+ {'x_fmt_open': '',
+ 'x_fmt_close': '',
+ 'x_nb_records': '' + self.tmpl_nice_number(results_final_nb_total, ln) + '',
+ 'x_nb_seconds': '%.2f' % cpu_time}
}
# then print hits per collection:
for coll in colls:
if results_final_nb.has_key(coll['code']) and results_final_nb[coll['code']] > 0:
out += '''%(coll_name)s,
%(number)s ''' % { 'coll' : urllib.quote(coll['code']), 'coll_name' : coll['name'], 'number' : _("%s records found") % ('' + self.tmpl_nice_number(results_final_nb[coll['code']], ln) + '') } out += " |
""" return out def tmpl_similar_author_names(self, authors, ln): """No hits found, proposes alternative boolean queries Parameters: - 'authors': a list of (name, hits) tuples - 'ln' *string* - The language to display """ # load the right message language _ = gettext_set_language(ln) out = '''''' for term, hits, argd in nearestterms: out += '''\
''' % {'hits' : hits, 'link': a_href(cgi.escape(term), _class="nearestterms", href=self.build_search_url(argd))} out += """ %(hits)s %(link)s
| %(similar)s | |
|---|---|
| %(nb)d | %(link)s |
" # secondly, title: titles = get_fieldvalues(recID, "245__a") for title in titles: out += "
Abstract: %s
""" % abstract # fifthly bis, keywords: keywords = get_fieldvalues(recID, "6531_a") if len(keywords): out += """Keyword(s):""" for keyword in keywords: out += '%s; ' % a_href(cgi.escape(keyword), href=self.build_search_url(ln=ln, p=keyword, f='keyword')) out += '' # fifthly bis bis, published in: prs_p = get_fieldvalues(recID, "909C4p") prs_v = get_fieldvalues(recID, "909C4v") prs_y = get_fieldvalues(recID, "909C4y") prs_n = get_fieldvalues(recID, "909C4n") prs_c = get_fieldvalues(recID, "909C4c") for idx in range(0,len(prs_p)): out += """
Publ. in: %s""" % prs_p[idx] if prs_v and prs_v[idx]: out += """%s""" % prs_v[idx] if prs_y and prs_y[idx]: out += """(%s)""" % prs_y[idx] if prs_n and prs_n[idx]: out += """, no.%s""" % prs_n[idx] if prs_c and prs_c[idx]: out += """, p.%s""" % prs_c[idx] out += """.""" # sixthly, fulltext link: urls_z = get_fieldvalues(recID, "8564_z") urls_u = get_fieldvalues(recID, "8564_u") for idx in range(0,len(urls_u)): link_text = "URL" try: if urls_z[idx]: link_text = urls_z[idx] except IndexError: pass out += """
%s: %s""" % (link_text, urls_u[idx], urls_u[idx]) # print some white space at the end: out += "
" return out def tmpl_print_record_list_for_similarity_boxen(self, title, score_list, ln=cdslang): """Print list of records in the "hs" (HTML Similarity) format for similarity boxes. FIXME: bad symbol names again, e.g. SCORE_LIST is *not* a list of scores. Humph. """ from invenio.search_engine import print_record out = '''
|
|
|
%s' % \ a_href(_("Detailed record"), _class="moreinfo", href=self.build_search_url(sysno=alephsysno, ln=ln)) else: out += '
%s' % \ a_href(_("Detailed record"), _class="moreinfo", href=self.build_search_url(recid=recID, ln=ln)) else: out += '
%s' % \ a_href(_("Detailed record"), _class="moreinfo", href=self.build_search_url(recid=recID, ln=ln)) out += ' - %s' % \ a_href(_("Similar records"), _class="moreinfo", href=self.build_search_url(p="recid:%d" % recID, rm="wrd", ln=ln)) if cfg_experimental_features: out += ' - %s' % \ a_href(_("Cited by"), _class="moreinfo", href=self.build_search_url(p="recid:%d" % recID, rm="cit", ln=ln)) return out diff --git a/modules/websession/lib/webaccount.py b/modules/websession/lib/webaccount.py index ad26b1738..8fb90fa8f 100644 --- a/modules/websession/lib/webaccount.py +++ b/modules/websession/lib/webaccount.py @@ -1,252 +1,255 @@ ## $Id$ ## This file is part of CDS Invenio. ## Copyright (C) 2002, 2003, 2004, 2005, 2006 CERN. ## ## CDS 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. ## ## CDS 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 CDS Invenio; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. import sys import string import cgi from invenio.config import * from invenio.webpage import page from invenio.dbquery import run_sql from invenio.webuser import getUid,isGuestUser, get_user_preferences, set_user_preferences from invenio.access_control_admin import acc_findUserRoleActions from invenio.access_control_config import CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS, CFG_EXTERNAL_AUTHENTICATION from invenio.messages import gettext_set_language import invenio.template websession_templates = invenio.template.load('websession') # perform_info(): display the main features of CDS personalize def perform_info(req, ln): out = "" uid = getUid(req) return websession_templates.tmpl_account_info( ln = ln, uid = uid, guest = isGuestUser(uid), cfg_cern_site = cfg_cern_site, ); def perform_youradminactivities(uid, ln): """Return text for the `Your Admin Activities' box. Analyze whether user UID has some admin roles, and if yes, then print suitable links for the actions he can do. If he's not admin, print a simple non-authorized message.""" your_role_actions = acc_findUserRoleActions(uid) your_roles = [] your_admin_activities = [] guest = isGuestUser(uid) for (role, action) in your_role_actions: if role not in your_roles: your_roles.append(role) if action not in your_admin_activities: your_admin_activities.append(action) if "superadmin" in your_roles: for action in ["runbibedit", "cfgbibformat", "cfgbibharvest", "cfgbibrank", "cfgbibindex", "cfgwebaccess", "cfgwebcomment", "cfgwebsearch", "cfgwebsubmit"]: if action not in your_admin_activities: your_admin_activities.append(action) return websession_templates.tmpl_account_adminactivities( ln = ln, uid = uid, guest = guest, roles = your_roles, activities = your_admin_activities, weburl = weburl, ) # perform_display_account(): display a dynamic page that shows the user's account def perform_display_account(req,username,bask,aler,sear,msgs,grps,ln): # load the right message language _ = gettext_set_language(ln) uid = getUid(req) #your account if isGuestUser(uid): user = "guest" login = "%s/youraccount/login?ln=%s" % (sweburl, ln) - accBody = _("You are logged in as guest. You may want to %slogin%s as a regular user.") % ('', '') + accBody = _("You are logged in as guest. You may want to %(x_url_open)slogin%(x_url_close)s as a regular user.") %\ + {'x_url_open': '', + 'x_url_close': ''} accBody += "
" - bask=aler=msgs= _("The %sguest%s users need to %sregister%s first") % ('', - '', - '', - '') + bask=aler=msgs= _("The %(x_fmt_open)sguest%(x_fmt_close)s users need to %(x_url_open)sregister%(x_url_close)s first") %\ + {'x_fmt_open': '', + 'x_fmt_close': '', + 'x_url_open': '', + 'x_url_close': ''} sear= _("No queries found") else: user = username accBody = websession_templates.tmpl_account_body( ln = ln, user = user, ) return websession_templates.tmpl_account_page( ln = ln, weburl = weburl, accBody = accBody, baskets = bask, alerts = aler, searches = sear, messages = msgs, groups = grps, administrative = perform_youradminactivities(uid, ln) ) # template_account() : it is a template for print each of the options from the user's account def template_account(title, body, ln): return websession_templates.tmpl_account_template( ln = ln, title = title, body = body ) # warning_guest_user(): It returns an alert message,showing that the user is a guest user and should log into the system def warning_guest_user(type, ln=cdslang): # load the right message language _ = gettext_set_language(ln) return websession_templates.tmpl_warning_guest_user( ln = ln, type = type, ) ## perform_delete():delete the account of the user, not implement yet def perform_delete(ln): return websession_templates.tmpl_account_delete(ln = ln) ## perform_set(email,password): edit your account parameters, email and password. def perform_set(email,password, ln): try: res = run_sql("SELECT id, nickname FROM user WHERE email=%s", (email,)) uid = res[0][0] nickname = res[0][1] except: uid = 0 nickname = "" CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS_LOCAL = CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS prefs = get_user_preferences(uid) if CFG_EXTERNAL_AUTHENTICATION.has_key(prefs['login_method']) and CFG_EXTERNAL_AUTHENTICATION[prefs['login_method']][1] != True: CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS_LOCAL = 3 out = websession_templates.tmpl_user_preferences( ln = ln, email = email, email_disabled = (CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS_LOCAL >= 2), password = password, password_disabled = (CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS_LOCAL >= 3), nickname = nickname, ) if len(CFG_EXTERNAL_AUTHENTICATION) >= 1: try: uid = run_sql("SELECT id FROM user where email=%s", (email,)) uid = uid[0][0] except: uid = 0 prefs = get_user_preferences(uid) current_login_method = prefs['login_method'] methods = CFG_EXTERNAL_AUTHENTICATION.keys() methods.sort() out += websession_templates.tmpl_user_external_auth( ln = ln, methods = methods, current = current_login_method, method_disabled = (CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS >= 4) ) return out ## create_register_page_box(): register a new account def create_register_page_box(referer='', ln=cdslang): return websession_templates.tmpl_register_page( referer = referer, ln = ln, level = CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS, supportemail = supportemail, cdsname = cdsname ) ## create_login_page_box(): ask for the user's email and password, for login into the system def create_login_page_box(referer='', ln=cdslang): internal = None for system in CFG_EXTERNAL_AUTHENTICATION.keys(): if not CFG_EXTERNAL_AUTHENTICATION[system][0]: internal = system break register_available = CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS <= 1 and internal methods = CFG_EXTERNAL_AUTHENTICATION.keys() methods.sort() selected = '' for method in methods: if CFG_EXTERNAL_AUTHENTICATION[method][1] == True: selected = method break return websession_templates.tmpl_login_form( ln = ln, referer = referer, internal = internal, register_available = register_available, methods = methods, selected_method = selected, supportemail = supportemail, ) # perform_logout: display the message of not longer authorized, def perform_logout(req, ln): return websession_templates.tmpl_account_logout(ln = ln) #def perform_lost: ask the user for his email, in order to send him the lost password def perform_lost(ln): return websession_templates.tmpl_lost_password_form( ln = ln, msg = websession_templates.tmpl_lost_password_message(ln = ln, supportemail = supportemail), ) # perform_emailSent(email): confirm that the password has been emailed to 'email' address def perform_emailSent(email, ln): return websession_templates.tmpl_account_emailSent(ln = ln, email = email) # peform_emailMessage : display a error message when the email introduced is not correct, and sugest to try again def perform_emailMessage(eMsg, ln): return websession_templates.tmpl_account_emailMessage( ln = ln, msg = eMsg ) # perform_back(): template for return to a previous page, used for login,register and setting def perform_back(mess,act,linkname='', ln='en'): if not linkname: linkname = act return websession_templates.tmpl_back_form( ln = ln, message = mess, act = act, link = linkname, ) diff --git a/modules/websession/lib/webgroup.py b/modules/websession/lib/webgroup.py index cf615400b..e4cb5a89b 100644 --- a/modules/websession/lib/webgroup.py +++ b/modules/websession/lib/webgroup.py @@ -1,718 +1,718 @@ ## $Id$ ## This file is part of CDS Invenio. ## Copyright (C) 2002, 2003, 2004, 2005, 2006 CERN. ## ## CDS 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. ## ## CDS 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 CDS Invenio; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. """Group features.""" from invenio.config import cdslang from invenio.messages import gettext_set_language from invenio.websession_config import cfg_websession_info_messages, cfg_websession_usergroup_status, cfg_websession_group_join_policy, cfg_websession_warning_messages from invenio.webuser import nickname_valid_p, get_user_info from invenio.webmessage import perform_request_send import invenio.webgroup_dblayer as db try: import invenio.template websession_templates = invenio.template.load('websession') except ImportError: pass def perform_request_group_display(uid, infos=[], errors = [], warnings = [], ln=cdslang): """Display all the groups the user belong to @param uid: user id @param info: info about last user action @param ln: language @return a (body, errors[], warnings[]) formed tuple """ _ = gettext_set_language(ln) body = "" (body_admin, errors_admin) = display_admin_group(uid) (body_member, errors_member) = display_member_group(uid) if errors_admin: errors.extend(errors_admin) if errors_member: errors.extend(errors_member) body = websession_templates.tmpl_display_all_groups(infos=infos, admin_group_html=body_admin, member_group_html=body_member, warnings=warnings, ln=ln) return (body, errors, warnings) def display_admin_group(uid, ln=cdslang): """Display groups the user is admin of @param uid: user id @param ln: language @return a (body, errors[]) formed tuple return html groups representation the user is admin of""" body = "" errors = [] record = db.get_groups_by_user_status(uid=uid, user_status=cfg_websession_usergroup_status["ADMIN"]) body = websession_templates.tmpl_display_admin_group(groups=record, ln=ln) return (body, errors) def display_member_group(uid, ln=cdslang): """Display groups the user is member of @param uid: user id @param ln: language @return a (body, errors[]) formed tuple body : html groups representation the user is member of""" body = "" errors = [] records = db.get_groups_by_user_status(uid, user_status=cfg_websession_usergroup_status["MEMBER"] ) body = websession_templates.tmpl_display_member_group(groups=records, ln=ln) return (body, errors) def perform_request_input_create_group(group_name, group_description, join_policy, warnings=[], ln=cdslang): """Display form for creating new group. @param group_name: name of the group entered if the page has been reloaded @param group_description: description entered if the page has been reloaded @param join_policy: join policy chosen if the page has been reloaded @param warnings: warnings @param ln: language @return a (body, errors[], warnings[]) formed tuple body: html for group creation page""" body = "" errors = [] body = websession_templates.tmpl_display_input_group_info(group_name, group_description, join_policy, act_type="create", warnings=warnings, ln=ln) return (body, errors, warnings) def perform_request_create_group(uid, group_name, group_description, join_policy, ln=cdslang): """Create new group @param group_name: name of the group entered @param group_description: description of the group entered @param join_policy: join policy of the group entered @param ln: language @return a (body, errors, warnings) formed tuple warning != [] if group_name or join_policy are not valid or if the name already exists in the database body="1" if succeed in order to display info on the main page """ _ = gettext_set_language(ln) body = "" warnings = [] errors = [] infos = [] if group_name == "": warnings.append(('WRN_WEBSESSION_NO_GROUP_NAME',)) (body, errors, warnings) = perform_request_input_create_group(group_name, group_description, join_policy, warnings=warnings) elif not group_name_valid_p(group_name): warnings.append('WRN_WEBSESSION_NOT_VALID_GROUP_NAME') (body, errors, warnings) = perform_request_input_create_group(group_name, group_description, join_policy, warnings=warnings) elif join_policy=="-1": warnings.append('WRN_WEBSESSION_NO_JOIN_POLICY') (body, errors, warnings) = perform_request_input_create_group(group_name, group_description, join_policy, warnings=warnings) elif db.group_name_exist(group_name): warnings.append('WRN_WEBSESSION_GROUP_NAME_EXISTS') (body, errors, warnings) = perform_request_input_create_group(group_name, group_description, join_policy, warnings=warnings) else: db.insert_new_group(uid, group_name, group_description, join_policy) infos.append(_(cfg_websession_info_messages["GROUP_CREATED"])) (body, errors, warnings) = perform_request_group_display(uid, infos=infos, errors=errors, warnings=warnings, ln=cdslang) return (body, errors, warnings) def perform_request_input_join_group(uid, group_name, search, warnings=[], ln=cdslang): """Return html for joining new group @param group_name: name of the group entered if user is looking for a group @param search=1 if search performed else 0 @param warnings: warnings coming from perform_request_join_group @param ln: language @return a (body, errors[], warnings[]) formed tuple """ errors = [] group_from_search = {} records = db.get_visible_group_list(uid=uid) if search: group_from_search = db.get_visible_group_list(uid, group_name) body = websession_templates.tmpl_display_input_join_group(records.items(), group_name, group_from_search.items(), search, warnings=warnings, ln=ln) return (body, errors, warnings) def perform_request_join_group(uid, grpID, group_name, search, ln=cdslang): """Join group @param grpID: list of the groups the user wants to join, only one value must be selected among the two group lists (default group list, group list resulting from the search) @param group_name: name of the group entered if search on name performed @param search=1 if search performed else 0 @param ln: language @return a (body, errors[], warnings[]) formed tuple warnings != [] if 0 or more than one group is selected """ _ = gettext_set_language(ln) body = "" warnings = [] errors = [] infos = [] if "-1" in grpID: grpID.remove("-1") if len(grpID)==1 : grpID = grpID[0] """test if user is already member or pending""" status = db.get_user_status(uid, grpID) if status: warnings.append('WRN_WEBSESSION_ALREADY_MEMBER') (body, errors, warnings) = perform_request_group_display(uid, infos=infos, errors=errors, warnings=warnings, ln=cdslang) """insert new user of group""" else: group_infos = db.get_group_infos(grpID) group_type = group_infos[0][3] if group_type == cfg_websession_group_join_policy["VISIBLEMAIL"]: db.insert_new_member(uid, grpID, cfg_websession_usergroup_status["PENDING"]) admin = db.get_users_by_status(grpID, cfg_websession_usergroup_status["ADMIN"])[0][1] group_name = group_infos[0][1] msg_subjet, msg_body = websession_templates.tmpl_admin_msg(group_name=group_name, grpID=grpID, ln=ln) (body, errors, warnings, title, navtrail) = perform_request_send(uid, msg_to_user=admin, msg_to_group="", msg_subject=msg_subjet, msg_body=msg_body, ln=ln) infos.append(_(cfg_websession_info_messages["JOIN_REQUEST"])) elif group_type == cfg_websession_group_join_policy["VISIBLEOPEN"]: db.insert_new_member(uid, grpID, cfg_websession_usergroup_status["MEMBER"]) infos.append(_(cfg_websession_info_messages["JOIN_GROUP"])) (body, errors, warnings) = perform_request_group_display(uid, infos=infos, errors=errors, warnings=warnings, ln=cdslang) else: warnings.append('WRN_WEBSESSION_MULTIPLE_GROUPS') (body, errors, warnings) = perform_request_input_join_group(uid, group_name, search, warnings, ln) return (body, errors, warnings) def perform_request_input_leave_group(uid, warnings=[], ln=cdslang): """Return html for leaving group @param uid: user ID @param warnings: warnings != [] if 0 group is selected or if not admin of the @param ln: language @return a (body, errors[], warnings[]) formed tuple """ body = "" errors = [] groups = [] records = db.get_groups_by_user_status(uid=uid, user_status=cfg_websession_usergroup_status["MEMBER"]) map(lambda x: groups.append((x[0], x[1])), records) body = websession_templates.tmpl_display_input_leave_group(groups, warnings=warnings, ln=ln) return (body, errors, warnings) def perform_request_leave_group(uid, grpID, confirmed=0, ln=cdslang): """Leave group @param uid: user ID @param grpID: ID of the group the user wants to leave @param warnings: warnings != [] if 0 group is selected @param confirmed: a confirmed page is first displayed @param ln: language @return a (body, errors[], warnings[]) formed tuple """ _ = gettext_set_language(ln) body = "" warnings = [] errors = [] infos = [] if not grpID == "-1": if confirmed: db.leave_group(grpID, uid) infos.append(_(cfg_websession_info_messages["LEAVE_GROUP"])) (body, errors, warnings) = perform_request_group_display(uid, infos=infos, errors=errors, warnings=warnings, ln=cdslang) else: body = websession_templates.tmpl_confirm_leave(uid, grpID, ln) else: warnings.append('WRN_WEBSESSION_NO_GROUP_SELECTED') (body, errors, warnings) = perform_request_input_leave_group(uid, warnings= warnings, ln=ln) return (body, errors, warnings) def perform_request_edit_group(uid, grpID, warnings=[], ln=cdslang): """Return html for group editing @param uid: user ID @param grpID: ID of the group @param warnings: warnings @param ln: language @return a (body, errors[], warnings[]) formed tuple """ body = '' errors = [] user_status = db.get_user_status(uid, grpID) if not len(user_status): errors.append('ERR_WEBSESSION_DB_ERROR') return (body, errors, warnings) elif user_status[0][0] != cfg_websession_usergroup_status['ADMIN']: errors.append(('ERR_WEBSESSION_GROUP_NO_RIGHTS',)) return (body, errors, warnings) group_infos = db.get_group_infos(grpID)[0] if not len(group_infos): errors.append('ERR_WEBSESSION_DB_ERROR') return (body, errors, warnings) body = websession_templates.tmpl_display_input_group_info(group_name=group_infos[1], group_description=group_infos[2], join_policy=group_infos[3], act_type="update", grpID=grpID, warnings=warnings, ln=ln) return (body, errors, warnings) def perform_request_update_group(uid, grpID, group_name, group_description, join_policy, ln=cdslang): """Update group datas in database @param uid: user ID @param grpID: ID of the group @param group_name: name of the group @param group_description: description of the group @param join_policy: join policy of the group @param ln: language @return a (body, errors[], warnings[]) formed tuple """ body = '' errors = [] warnings = [] infos = [] _ = gettext_set_language(ln) group_name_available = db.group_name_exist(group_name) if group_name == "": warnings.append('WRN_WEBSESSION_NO_GROUP_NAME') (body, errors, warnings) = perform_request_edit_group(uid, grpID, warnings=warnings, ln=ln) elif not group_name_valid_p(group_name): warnings.append('WRN_WEBSESSION_NOT_VALID_GROUP_NAME') (body, errors, warnings) = perform_request_edit_group(uid, grpID, warnings=warnings, ln=ln) elif join_policy == "-1": warnings.append('WRN_WEBSESSION_NO_JOIN_POLICY') (body, errors, warnings) = perform_request_edit_group(uid, grpID, warnings=warnings, ln=ln) elif (group_name_available and group_name_available[0][0]!= int(grpID)): warnings.append('WRN_WEBSESSION_GROUP_NAME_EXISTS') (body, errors, warnings) = perform_request_edit_group(uid, grpID, warnings=warnings, ln=ln) else: grpID = db.update_group_infos(grpID, group_name, group_description, join_policy) infos.append(_(cfg_websession_info_messages["GROUP_UPDATED"])) (body, errors, warnings) = perform_request_group_display(uid, infos=infos, errors=errors, warnings=warnings, ln=cdslang) return (body, errors, warnings) def perform_request_delete_group(uid, grpID, confirmed=0, ln=cdslang): """First display confirm message(confirmed=0) then(confirmed=1) delete group and all its members @param uid: user ID @param grpID: ID of the group @param confirmed =1 if confirmed message has been previously displayed @param ln: language @return a (body, errors[], warnings[]) formed tuple """ body = "" warnings = [] errors = [] infos = [] _ = gettext_set_language(ln) group_infos = db.get_group_infos(grpID) user_status = db.get_user_status(uid, grpID) if not group_infos: warnings.append('WRN_WEBSESSION_GROUP_ALREADY_DELETED') (body, errors, warnings) = perform_request_group_display(uid, infos=infos, errors=errors, warnings=warnings, ln=cdslang) else: if not len(user_status): errors.append('ERR_WEBSESSION_DB_ERROR') elif confirmed: group_infos = db.get_group_infos(grpID) group_name = group_infos[0][1] msg_subjet, msg_body = websession_templates.tmpl_delete_msg(group_name=group_name, ln=ln) (body, errors, warnings, title, navtrail) = perform_request_send(uid, msg_to_user="", msg_to_group=group_name, msg_subject=msg_subjet, msg_body=msg_body, ln=ln) db.delete_group_and_members(grpID) infos.append(_(cfg_websession_info_messages["GROUP_DELETED"])) (body, errors, warnings) = perform_request_group_display(uid, infos=infos, errors=errors, warnings=warnings, ln=cdslang) else: body = websession_templates.tmpl_confirm_delete(grpID, ln) return (body, errors, warnings) def perform_request_manage_member(uid, grpID, infos=[], warnings=[], ln=cdslang): """Return html for managing group's members @param uid: user ID @param grpID: ID of the group @param info: info about last user action @param warnings: warnings @param ln: language @return a (body, errors[], warnings[]) formed tuple """ body = '' errors = [] _ = gettext_set_language(ln) user_status = db.get_user_status(uid, grpID) if not len(user_status): errors.append('ERR_WEBSESSION_DB_ERROR') return (body, errors, warnings) elif user_status[0][0] != cfg_websession_usergroup_status['ADMIN']: errors.append(('ERR_WEBSESSION_GROUP_NO_RIGHTS',)) return (body, errors, warnings) group_infos = db.get_group_infos(grpID) if not len(group_infos): errors.append('ERR_WEBSESSION_DB_ERROR') return (body, errors, warnings) members = db.get_users_by_status(grpID, cfg_websession_usergroup_status["MEMBER"]) pending_members = db.get_users_by_status(grpID, cfg_websession_usergroup_status["PENDING"]) body = websession_templates.tmpl_display_manage_member(grpID=grpID, group_name=group_infos[0][1], members=members, pending_members=pending_members, warnings=warnings, infos=infos, ln=ln) return (body, errors, warnings) def perform_request_remove_member(uid, grpID, member_id, ln=cdslang): """Remove member from a group @param uid: user ID @param grpID: ID of the group @param member_id: selected member ID @param ln: language @return a (body, errors[], warnings[]) formed tuple """ body = '' errors = [] warnings = [] infos = [] _ = gettext_set_language(ln) user_status = db.get_user_status(uid, grpID) if not len(user_status): errors.append('ERR_WEBSESSION_DB_ERROR') return (body, errors, warnings) if member_id == -1: warnings.append('WRN_WEBSESSION_NO_MEMBER_SELECTED') (body, errors, warnings) = perform_request_manage_member(uid, grpID, warnings=warnings, ln=ln) else: db.delete_member(grpID, member_id) infos.append(_(cfg_websession_info_messages["MEMBER_DELETED"])) (body, errors, warnings) = perform_request_manage_member(uid, grpID, infos=infos, warnings=warnings, ln=ln) return (body, errors, warnings) def perform_request_add_member(uid, grpID, user_id, ln=cdslang): """Add waiting member to a group @param uid: user ID @param grpID: ID of the group @param user_id: selected member ID @param ln: language @return a (body, errors[], warnings[]) formed tuple """ body = '' errors = [] warnings = [] infos = [] _ = gettext_set_language(ln) user_status = db.get_user_status(uid, grpID) if not len(user_status): errors.append('ERR_WEBSESSION_DB_ERROR') return (body, errors, warnings) if user_id == -1: warnings.append('WRN_WEBSESSION_NO_USER_SELECTED_ADD') (body, errors, warnings) = perform_request_manage_member(uid, grpID, warnings=warnings, ln=ln) else : """test if user is already member or pending""" status = db.get_user_status(user_id, grpID) if status and status[0][0] == 'M': warnings.append('WRN_WEBSESSION_ALREADY_MEMBER_ADD') (body, errors, warnings) = perform_request_manage_member(uid, grpID, infos=infos, warnings=warnings, ln=ln) else: db.add_pending_member(grpID, user_id, cfg_websession_usergroup_status["MEMBER"]) infos.append(_(cfg_websession_info_messages["MEMBER_ADDED"])) group_infos = db.get_group_infos(grpID) group_name = group_infos[0][1] user = get_user_info(user_id, ln)[2] msg_subjet, msg_body = websession_templates.tmpl_member_msg(group_name=group_name, - status=_("accepted"), + accepted=1, ln=ln) (body, errors, warnings, title, navtrail) = perform_request_send(uid, msg_to_user=user, msg_to_group="", msg_subject=msg_subjet, msg_body=msg_body, ln=ln) (body, errors, warnings) = perform_request_manage_member(uid, grpID, infos=infos, warnings=warnings, ln=ln) return (body, errors, warnings) def perform_request_reject_member(uid, grpID, user_id, ln=cdslang): """Reject waiting member and delete it from the list @param uid: user ID @param grpID: ID of the group @param member_id: selected member ID @param ln: language @return a (body, errors[], warnings[]) formed tuple """ body = '' errors = [] warnings = [] infos = [] _ = gettext_set_language(ln) user_status = db.get_user_status(uid, grpID) if not len(user_status): errors.append('ERR_WEBSESSION_DB_ERROR') return (body, errors, warnings) if user_id == -1: warnings.append('WRN_WEBSESSION_NO_USER_SELECTED_DEL') (body, errors, warnings) = perform_request_manage_member(uid, grpID, warnings=warnings, ln=ln) else : """test if user is already member or pending""" status = db.get_user_status(user_id, grpID) if not status: warnings.append('WRN_WEBSESSION_ALREADY_MEMBER_REJECT') (body, errors, warnings) = perform_request_manage_member(uid, grpID, infos=infos, warnings=warnings, ln=ln) else: db.delete_member(grpID, user_id) group_infos = db.get_group_infos(grpID) group_name = group_infos[0][1] user = get_user_info(user_id, ln)[2] msg_subjet, msg_body = websession_templates.tmpl_member_msg(group_name=group_name, - status=_("rejected"), + accepted=0, ln=ln) (body, errors, warnings, title, navtrail) = perform_request_send(uid, msg_to_user=user, msg_to_group="", msg_subject=msg_subjet, msg_body=msg_body, ln=ln) infos.append(_(cfg_websession_info_messages["MEMBER_REJECTED"])) (body, errors, warnings) = perform_request_manage_member(uid, grpID, infos=infos, warnings=warnings, ln=ln) return (body, errors, warnings) def account_group(uid, ln=cdslang): """ display group info for myaccount.py page. @param uid: user id (int) @param ln: language @return html body """ nb_admin_groups = db.count_nb_group_user(uid, cfg_websession_usergroup_status["ADMIN"]) nb_member_groups = db.count_nb_group_user(uid, cfg_websession_usergroup_status["MEMBER"]) nb_total_groups = nb_admin_groups + nb_member_groups return websession_templates.tmpl_group_info(nb_admin_groups, nb_member_groups, nb_total_groups, ln=ln) def get_navtrail(ln=cdslang, title=""): """ gets the navtrail for title... @param title: title of the page @param ln: language @return HTML output """ navtrail = websession_templates.tmpl_navtrail(ln, title) return navtrail def group_name_valid_p(group_name): """Test if the group's name is valid""" return nickname_valid_p(group_name) diff --git a/modules/websession/lib/websession_templates.py b/modules/websession/lib/websession_templates.py index 8ebf130ba..ada5014db 100644 --- a/modules/websession/lib/websession_templates.py +++ b/modules/websession/lib/websession_templates.py @@ -1,1797 +1,1815 @@ ## $Id$ ## This file is part of CDS Invenio. ## Copyright (C) 2002, 2003, 2004, 2005, 2006 CERN. ## ## CDS 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. ## ## CDS 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 CDS Invenio; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. import urllib import time import cgi import gettext import string import locale from invenio.config import * from invenio.messages import gettext_set_language from invenio.textutils import indent_text from invenio.websession_config import cfg_websession_group_join_policy class Template: def tmpl_lost_password_message(self, ln, supportemail): """ Defines the text that will be displayed on the 'lost password' page Parameters: - 'ln' *string* - The language to display the interface in - 'supportemail' *string* - The email of the support team """ # load the right message language _ = gettext_set_language(ln) return _("If you have lost password for your CDS Invenio internal account, then please enter your email address below and the lost password will be emailed to you.") +\ "
" +\ _("Note that if you have been using an external login system (such as CERN NICE), then we cannot do anything and you have to ask there.") +\ _("Alternatively, you can ask %s to change your login system from external to internal.") % ("""%(email)s""" % { 'email' : supportemail }) +\ "
" def tmpl_back_form(self, ln, message, act, link): """ A standard one-message-go-back-link page. Parameters: - 'ln' *string* - The language to display the interface in - 'message' *string* - The message to display - 'act' *string* - The action to accomplish when going back - 'link' *string* - The link text """ out = """
| %(message)s - %(link)s | + %(link)s
%(edit_params)s
""" % { 'change_user_pass' : _("If you want to change your email address or password, please set new values in the form below."), 'edit_params' : _("Edit parameters"), 'nickname_label' : _("Nickname"), 'nickname' : nickname, 'nickname_prefix' : nickname=='' and ''+_("Example")+':johnd' or '', 'new_email' : _("New email address"), 'mandatory' : _("mandatory"), 'example' : _("Example"), 'new_password' : _("New password"), 'optional' : _("optional"), 'note' : _("Note"), 'password_note' : _("The password phrase may contain punctuation, spaces, etc."), 'retype_password' : _("Retype password"), 'set_values' : _("Set new values"), 'email' : email, 'email_disabled' : email_disabled and "disabled" or "", 'password' : password, 'password_disabled' : password_disabled and "disabled" or "", 'sweburl': sweburl, } return out def tmpl_user_external_auth(self, ln, methods, current, method_disabled): """ Displays a form for the user to change his authentication method. Parameters: - 'ln' *string* - The language to display the interface in - 'methods' *array* - The methods of authentication - 'method_disabled' *boolean* - If the user has the right to change this - 'current' *string* - The currently selected method """ # load the right message language _ = gettext_set_language(ln) out = """ """ % { 'select_method' : _("Select method"), } return out def tmpl_lost_password_form(self, ln, msg): """ Displays a form for the user to ask for his password sent by email. Parameters: - 'ln' *string* - The language to display the interface in - 'msg' *string* - Explicative message on top of the form. """ # load the right message language _ = gettext_set_language(ln) out = """ """ % { 'msg' : msg, 'email' : _("Email address"), 'send' : _("Send lost password"), } return out def tmpl_account_info(self, ln, uid, guest, cfg_cern_site): """ Displays the account information Parameters: - 'ln' *string* - The language to display the interface in - 'uid' *string* - The user id - 'guest' *boolean* - If the user is guest - 'cfg_cern_site' *boolean* - If the site is a CERN site """ # load the right message language _ = gettext_set_language(ln) out = """
%(account_offer)s
""" return out def tmpl_warning_guest_user(self, ln, type): """ Displays a warning message about the specified type Parameters: - 'ln' *string* - The language to display the interface in - - 'type' *string* - The type of data that will get lost in case of guest account + - 'type' *string* - The type of data that will get lost in case of guest account (for the moment: 'alerts' or 'baskets') """ # load the right message language _ = gettext_set_language(ln) - - msg = _("You are logged in as a guest user, so your %s will disappear at the end of the current session. If you wish you can %slogin or register here%s.") - msg %= (type, '', '') + if (type=='baskets'): + msg = _("You are logged in as a guest user, so your baskets will disappear at the end of the current session.") + ' ' + elif (type=='alerts'): + msg = _("You are logged in as a guest user, so your alerts will disappear at the end of the current session.") + ' ' + msg += _("If you wish you can %(x_url_open)slogin or register here%(x_url_close)s.") % {'x_url_open': '', + 'x_url_close': ''} return """""" % { 'account_offer' : _("%s offers you the possibility to personalize the interface, to set up your own personal library of documents, or to set up an automatic alert query that would run periodically and would notify you of search results by email.") % cdsnameintl[ln], } if not guest: out += """
- %(your_settings)s
- %(change_account)s""" % { 'ln' : ln, 'your_settings' : _("Your Settings"), 'change_account' : _("Set or change your account email address or password. Specify your preferences about the look and feel of the interface.") } out += """
- %(your_searches)s
- %(search_explain)s
- %(your_baskets)s
- %(basket_explain)s""" % { 'ln' : ln, 'your_searches' : _("Your Searches"), 'search_explain' : _("View all the searches you performed during the last 30 days."), 'your_baskets' : _("Your Baskets"), 'basket_explain' : _("With baskets you can define specific collections of items, store interesting records you want to access later or share with others."), } if guest: out += self.tmpl_warning_guest_user(ln = ln, type = "baskets") out += """
- %(your_alerts)s
- %(explain_alerts)s""" % { 'ln' : ln, 'your_alerts' : _("Your Alerts"), 'explain_alerts' : _("Subscribe to a search which will be run periodically by our service. The result can be sent to you via Email or stored in one of your baskets."), } if guest: out += self.tmpl_warning_guest_user(type="alerts", ln = ln) if cfg_cern_site: out += """
- %(your_loans)s
- %(explain_loans)s""" % { 'your_loans' : _("Your Loans"), 'explain_loans' : _("Check out book you have on loan, submit borrowing requests, etc. Requires CERN ID."), } out += """
| %s |
|---|
" + out = _("You are logged in as %(x_user)s. You may want to a) %(x_url1_open)slogout%(x_url_close)s; b) edit your %(x_url2_open)saccount settings%(x_url_close)s.") %\ + {'x_user': user, + 'x_url1_open': '', + 'x_url_close': '', + 'x_url2_open': ''} + return out + "
" def tmpl_account_template(self, title, body, ln): """ Displays a block of the your account page Parameters: - 'ln' *string* - The language to display the interface in - 'title' *string* - The title of the block - 'body' *string* - The body of the block """ out ="" out +="""
| %s |
|---|
| %s |
" + _("""Deleting your account""") return out def tmpl_account_logout(self, ln): """ Displays a confirmation message about logging out Parameters: - 'ln' *string* - The language to display the interface in """ # load the right message language _ = gettext_set_language(ln) - - out = "" - out += _("You are no longer recognized. If you wish you can %slogin here%s.") % ('', '') + out = _("You are no longer recognized.") + ' ' + out += _("If you wish you can %(x_url_open)slogin here%(x_url_close)s.") % {'x_url_open': '', + 'x_url_close': ''} return out def tmpl_login_form(self, ln, referer, internal, register_available, methods, selected_method, supportemail): """ Displays a login form Parameters: - 'ln' *string* - The language to display the interface in - 'referer' *string* - The referer URL - will be redirected upon after login - 'internal' *boolean* - If we are producing an internal authentication - 'register_available' *boolean* - If users can register freely in the system - 'methods' *array* - The available authentication methods - 'selected_method' *string* - The default authentication method - 'supportemail' *string* - The email of the support team """ # load the right message language _ = gettext_set_language(ln) out = "
%(please_login)s
" % {
'please_login' : _("If you already have an account, please login using the form below.")
}
if register_available:
- out += _("If you don't own an account yet, please %sregister%s an internal account.") % ('', '')
+ out += _("If you don't own an account yet, please %(x_url_open)sregister%(x_url_close)s an internal account.") %\
+ {'x_url_open': '',
+ 'x_url_close': ''}
else:
out += _("It is not possible to create an account yourself. Contact %s if you want an account.") % ('%s' % (supportemail, supportemail))
out += """
""" # Add the "back to main menu" button if finished == 0: out += """ """ % { 'surequit' : _("Are you sure you want to quit this submission?"), 'mainmenu' : mainmenu, } else: out += """
s/mainmenu.gif)
""" % { 'back' : _("Back to main menu"), 'images' : images, 'mainmenu' : mainmenu, } return out def tmpl_function_output(self, ln, display_on, action, doctype, step, functions): """ Produces the output of the functions. Parameters: - 'ln' *string* - The language to display the interface in - 'display_on' *bool* - If debug information should be displayed - 'doctype' *string* - The document type - 'action' *string* - The action - 'step' *int* - The current step in submission - 'functions' *aray* - HTML code produced by functions executed and informations about the functions - 'name' *string* - the name of the function - 'score' *string* - the score of the function - 'error' *bool* - if the function execution produced errors - 'text' *string* - the HTML code produced by the function """ # load the right message language _ = gettext_set_language(ln) out = "" if display_on: out += """
%(function_list)s
| %(function)s | %(score)s | %(running)s |
|---|---|---|
| %(name)s | %(score)s | %(result)s |
%(haveto)s
- " % {
'haveto' : _("You must now"),
}
i = 0
for action in actions:
if i > 0:
out += " " + _("or") + " "
i += 1
out += """
- %(name)s """ % action out += "
| Access to Fulltext [%s] |
|---|
| %s |
- "
for content in mytype['content']:
out += content
out += "
|
|
|
| %(version)s %(ver)s%(text)s |
|
| %(name)s | %(value)s |
" return out def tmpl_yourapprovals(self, ln, referees): """ Displays the doctypes and categories for which the user is referee Parameters: - 'ln' *string* - The language to display the interface in - 'referees' *array* - All the doctypes for which the user is referee: - 'doctype' *string* - The doctype - 'docname' *string* - The display name of the doctype - 'categories' *array* - The specific categories for which the user is referee: - 'id' *string* - The category id - 'name' *string* - The display name of the category """ # load the right message language _ = gettext_set_language(ln) out = """
| %(refdocs)s |
|---|
""" % {
'refdocs' : _("Refereed Documents"),
}
for doctype in referees:
out += """
|
| %(list)s |
|---|
%(select)s:
""" % { 'list' : _("List of refereed types of documents"), 'select' : _("Select one of the following types of documents to check the documents status."), } for doc in docs: out += " |
| %(title)s: %(list_categ)s | ||||
|---|---|---|---|---|
%(choose_categ)s
|
s/waiting_or.gif)
""" % {
'waiting' : categ['waiting'],
'pending' : _("Pending"),
'images' : images,
}
if categ['approved'] != 0:
out += """| %(approved)ss/smchk_gr.gif)
""" % {
'approved' : categ['approved'],
'approved_text' : _("Approved"),
'images' : images,
}
if categ['rejected'] != 0:
out += """| %(rejected)ss/cross_red.gif)
""" % {
'rejected' : categ['rejected'],
'rejected_text' : _("Rejected"),
'images' : images,
}
out += ")| %(title)s - %(categ)s: %(list)s | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
%(choose_report)s
|
""" % images
elif status == "approved":
image = """
""" % images
elif status == "rejected":
image = """
""" % images
else:
image = ""
out = """
| %(image)s %(rn)s |
|---|
| """ % {
'image' : image,
'rn' : rn,
}
if confirm_send:
out += """%(requestsent)s """ % { 'requestsent' : _("Your request has been sent to the referee."), } out += """ |
%(body)s
""" if user_can_add_comment: out += """ %(reply_label)s""" if user_can_delete_comment: out += """ | %(delete_label)s""" out += """