formatter: invenio.config deprecation

* Replaces usage of invenio.config with invenio.base.globals:cfg. (addresses inveniosoftware#3106) Signed-off-by: Leonardo Rossi <[email protected]>
hachreak · May 12, 2015 · 1821e89 · 1821e89
1 parent 2b4f7a9
commit 1821e89
Show file tree

Hide file tree

Showing 42 changed files with 321 additions and 317 deletions.
diff --git a/invenio/modules/formatter/config.py b/invenio/modules/formatter/config.py
@@ -27,6 +27,7 @@
 
 import pkg_resources
 
+# FIXME deprecate invenio.config
 from invenio.config import CFG_ETCDIR
 
 __revision__ = "$Id$"

diff --git a/invenio/modules/formatter/engine.py b/invenio/modules/formatter/engine.py
@@ -44,22 +44,20 @@
 import traceback
 import types
 import warnings
+
 from HTMLParser import HTMLParseError
 from operator import itemgetter
 
 from flask import current_app, has_app_context
 from six import iteritems
 from werkzeug.utils import cached_property
 
-import invenio.legacy.bibformat.dblayer as bibformat_dblayer
 from invenio.base.globals import cfg
 from invenio.base.i18n import gettext_set_language, language_list_long, \
     wash_language
-from invenio.config import CFG_BIBFORMAT_CACHED_FORMATS, \
-    CFG_BIBFORMAT_DISABLE_I18N_FOR_CACHED_FORMATS, CFG_BIBFORMAT_HIDDEN_TAGS, \
-    CFG_SITE_LANG
 from invenio.ext.logging import register_exception
 from invenio.ext.template import render_template_to_string
+from invenio.legacy.bibformat import dblayer as bibformat_dblayer
 from invenio.legacy.bibrecord import create_record, record_empty, \
     record_get_field_instances, record_get_field_value, \
     record_get_field_values, record_xml_output
@@ -73,10 +71,7 @@
 from invenio.utils.memoise import memoize
 
 from . import registry
-from .config import CFG_BIBFORMAT_FORMAT_JINJA_TEMPLATE_EXTENSION, \
-    CFG_BIBFORMAT_FORMAT_OUTPUT_EXTENSION, \
-    CFG_BIBFORMAT_FORMAT_TEMPLATE_EXTENSION, CFG_BIBFORMAT_OUTPUTS_PATH, \
-    CFG_BIBFORMAT_TEMPLATES_DIR, InvenioBibFormatError
+from .config import InvenioBibFormatError
 from .engines import xslt
 
 # Cache for data we have already read and parsed
@@ -285,7 +280,7 @@ def get_format_element_path(filename):
     return TEMPLATE_CONTEXT_FUNCTIONS_CACHE.bibformat_elements()[filename].__file__
 
 
-def format_record(recID, of, ln=CFG_SITE_LANG, verbose=0,
+def format_record(recID, of, ln=cfg['CFG_SITE_LANG'], verbose=0,
                   search_pattern=None, xml_record=None, user_info=None, qid="",
                   **kwargs):
     """
@@ -347,7 +342,7 @@ def format_record(recID, of, ln=CFG_SITE_LANG, verbose=0,
     path = registry.format_templates_lookup.get(template)
 
     if template is None or not (
-       template.endswith("." + CFG_BIBFORMAT_FORMAT_JINJA_TEMPLATE_EXTENSION)
+       template.endswith("." + cfg['CFG_BIBFORMAT_FORMAT_JINJA_TEMPLATE_EXTENSION'])
        or path is None or os.access(path, os.R_OK)
        ):
         # template not found in new BibFormat. Call old one
@@ -382,7 +377,7 @@ def format_record(recID, of, ln=CFG_SITE_LANG, verbose=0,
     return out, needs_2nd_pass
 
 
-def format_record_1st_pass(recID, of, ln=CFG_SITE_LANG, verbose=0,
+def format_record_1st_pass(recID, of, ln=cfg['CFG_SITE_LANG'], verbose=0,
                            search_pattern=None, xml_record=None,
                            user_info=None, on_the_fly=False,
                            save_missing=True, **kwargs):
@@ -437,9 +432,9 @@ def format_record_1st_pass(recID, of, ln=CFG_SITE_LANG, verbose=0,
         Formatting record %i with output format %s.
         </span>""" % (recID, of)
     if not on_the_fly and \
-       (ln == CFG_SITE_LANG or
+       (ln == cfg['CFG_SITE_LANG'] or
         of.lower() == 'xm' or
-        (of.lower() in CFG_BIBFORMAT_DISABLE_I18N_FOR_CACHED_FORMATS)) and \
+        (of.lower() in cfg['CFG_BIBFORMAT_DISABLE_I18N_FOR_CACHED_FORMATS'])) and \
        record_exists(recID) != -1:
         # Try to fetch preformatted record. Only possible for records
         # formatted in CFG_SITE_LANG language (other are never
@@ -460,15 +455,17 @@ def format_record_1st_pass(recID, of, ln=CFG_SITE_LANG, verbose=0,
             if of.lower() == 'xm':
                 res = filter_hidden_fields(res, user_info)
             # try to replace language links in pre-cached res, if applicable:
-            if ln != CFG_SITE_LANG and of.lower() in CFG_BIBFORMAT_DISABLE_I18N_FOR_CACHED_FORMATS:
+            if ln != cfg['CFG_SITE_LANG'] and \
+                    of.lower() in \
+                    cfg['CFG_BIBFORMAT_DISABLE_I18N_FOR_CACHED_FORMATS']:
                 # The following statements try to quickly replace any
                 # language arguments in URL links.  Not an exact
                 # science, but should work most of the time for most
                 # of the formats, with not too many false positives.
                 # We don't have time to parse output much here.
-                res = res.replace('?ln=' + CFG_SITE_LANG, '?ln=' + ln)
-                res = res.replace('&ln=' + CFG_SITE_LANG, '&ln=' + ln)
-                res = res.replace('&amp;ln=' + CFG_SITE_LANG, '&amp;ln=' + ln)
+                res = res.replace('?ln=' + cfg['CFG_SITE_LANG'], '?ln=' + ln)
+                res = res.replace('&ln=' + cfg['CFG_SITE_LANG'], '&ln=' + ln)
+                res = res.replace('&amp;ln=' + cfg['CFG_SITE_LANG'], '&amp;ln=' + ln)
             out += res
             return out, needs_2nd_pass
         else:
@@ -517,7 +514,7 @@ def format_record_1st_pass(recID, of, ln=CFG_SITE_LANG, verbose=0,
         raise
 
 
-def format_record_2nd_pass(recID, template, ln=CFG_SITE_LANG,
+def format_record_2nd_pass(recID, template, ln=cfg['CFG_SITE_LANG'],
                            search_pattern=None, xml_record=None,
                            user_info=None, of=None, verbose=0, **kwargs):
     # Create light bfo object
@@ -574,7 +571,7 @@ def decide_format_template(bfo, of):
         return None
 
 
-def translate_template(template, ln=CFG_SITE_LANG):
+def translate_template(template, ln=cfg['CFG_SITE_LANG']):
     _ = gettext_set_language(ln)
 
     def translate(match):
@@ -615,11 +612,11 @@ def format_with_format_template(format_template_filename, bfo,
     """
     if format_template_code is not None:
         format_content = str(format_template_code)
-    elif not format_template_filename.endswith("." + CFG_BIBFORMAT_FORMAT_JINJA_TEMPLATE_EXTENSION):
+    elif not format_template_filename.endswith("." + cfg['CFG_BIBFORMAT_FORMAT_JINJA_TEMPLATE_EXTENSION']):
         format_content = get_format_template(format_template_filename)['code']
 
     if format_template_filename is None or \
-            format_template_filename.endswith("." + CFG_BIBFORMAT_FORMAT_TEMPLATE_EXTENSION):
+            format_template_filename.endswith("." + cfg['CFG_BIBFORMAT_FORMAT_TEMPLATE_EXTENSION']):
         # .bft
         warnings.warn(
             "BFT template format ({0}) is deprecated. "
@@ -634,7 +631,7 @@ def format_with_format_template(format_template_filename, bfo,
             evaluated_format = translate_template(evaluated_format, bfo.lang)
 
 
-    elif format_template_filename.endswith("." + CFG_BIBFORMAT_FORMAT_JINJA_TEMPLATE_EXTENSION):
+    elif format_template_filename.endswith("." + cfg['CFG_BIBFORMAT_FORMAT_JINJA_TEMPLATE_EXTENSION']):
         evaluated_format = '<!-- empty -->'
         #try:
         from functools import wraps
@@ -1022,7 +1019,7 @@ def eval_format_element(format_element, bfo, parameters=None, verbose=0):
                     str(exc.message)+'</span></b>', errors)
 
 
-def filter_languages(format_template, ln=CFG_SITE_LANG):
+def filter_languages(format_template, ln=cfg['CFG_SITE_LANG']):
     """
     Filters the language tags that do not correspond to the specified language.
 
@@ -1065,7 +1062,7 @@ def clean_language_tag(match):
         pattern_current_lang = re.compile(r"<(" + current_lang +
                                           r")\s*>(.*)(</" + current_lang + r"\s*>)", re.IGNORECASE | re.DOTALL)
         if re.search(pattern_current_lang, lang_tag_content) is None:
-            current_lang = CFG_SITE_LANG
+            current_lang = cfg['CFG_SITE_LANG']
 
         cleaned_lang_tag = ln_pattern.sub(clean_language_tag, lang_tag_content)
         return cleaned_lang_tag.strip()
@@ -1089,9 +1086,9 @@ def get_format_template(filename, with_attributes=False):
     :param with_attributes: if True, fetch the attributes (names and description) for format'
     @return: strucured content of format template
     """
-    _ = gettext_set_language(CFG_SITE_LANG)
+    _ = gettext_set_language(cfg['CFG_SITE_LANG'])
 
-    if not filename.endswith("."+CFG_BIBFORMAT_FORMAT_TEMPLATE_EXTENSION) and \
+    if not filename.endswith("."+cfg['CFG_BIBFORMAT_FORMAT_TEMPLATE_EXTENSION']) and \
            not filename.endswith(".xsl"):
         return None
 
@@ -1114,7 +1111,7 @@ def get_format_template(filename, with_attributes=False):
 
         # Load format template code
         # Remove name and description
-        if filename.endswith("."+CFG_BIBFORMAT_FORMAT_TEMPLATE_EXTENSION):
+        if filename.endswith("."+cfg['CFG_BIBFORMAT_FORMAT_TEMPLATE_EXTENSION']):
             code_and_description = pattern_format_template_name.sub("",
                                                                     format_content, 1)
             code = pattern_format_template_desc.sub("", code_and_description, 1)
@@ -1154,7 +1151,7 @@ def get_format_templates(with_attributes=False):
     format_templates = {}
 
     for filename in registry.format_templates:
-        if filename.endswith("."+CFG_BIBFORMAT_FORMAT_TEMPLATE_EXTENSION) or \
+        if filename.endswith("."+cfg['CFG_BIBFORMAT_FORMAT_TEMPLATE_EXTENSION']) or \
                filename.endswith(".xsl"):
             filename = os.path.basename(filename)
             format_templates[filename] = get_format_template(filename,
@@ -1172,7 +1169,7 @@ def get_format_template_attrs(filename):
     :param filename: the name of a format template
     @return: a structure with detailed information about given format template
     """
-    _ = gettext_set_language(CFG_SITE_LANG)
+    _ = gettext_set_language(cfg['CFG_SITE_LANG'])
     attrs = {}
     attrs['name'] = ""
     attrs['description'] = ""
@@ -1230,7 +1227,7 @@ def get_format_element(element_name, verbose=0, with_built_in_params=False,
     :param with_built_in_params: if True, load the parameters built in all elements
     @return: a dictionary with format element attributes
     """
-    _ = gettext_set_language(CFG_SITE_LANG)
+    _ = gettext_set_language(cfg['CFG_SITE_LANG'])
 
     # Resolve filename and prepare 'name' as key for the cache
     filename = resolve_format_element_filename(element_name)
@@ -1646,7 +1643,7 @@ class BibFormatObject(object):
     record = None
 
     # The language in which the formatting has to be done
-    lang = CFG_SITE_LANG
+    lang = cfg['CFG_SITE_LANG']
 
     # A list of string describing the context in which the record has
     # to be formatted.
@@ -1665,7 +1662,7 @@ class BibFormatObject(object):
 
     req = None # DEPRECATED: use bfo.user_info instead. Used by WebJournal.
 
-    def __init__(self, recID, ln=CFG_SITE_LANG, search_pattern=None,
+    def __init__(self, recID, ln=cfg['CFG_SITE_LANG'], search_pattern=None,
                  xml_record=None, user_info=None, output_format=''):
         """
         Creates a new bibformat object, with given record.
@@ -2094,3 +2091,4 @@ def filter_hidden_fields(recxml, user_info=None, filter_tags=None,
         if omit and ('</datafield>' in line or '</marc:datafield>' in line):
             omit = False
     return out
+
diff --git a/invenio/modules/formatter/format_elements/bfe_addresses.py b/invenio/modules/formatter/format_elements/bfe_addresses.py
@@ -22,8 +22,11 @@
 __revision__ = "$Id$"
 
 import cgi
+
+from invenio.base.globals import cfg
+
 from urllib import quote
-from invenio.config import CFG_BASE_URL
+
 
 def format_element(bfo, separator="; ", print_link="yes"):
     """
@@ -37,11 +40,12 @@ def format_element(bfo, separator="; ", print_link="yes"):
     list_addresses = []
     if print_link.lower() == 'yes':
         for address in addresses:
-            list_addresses.append('<a href="'+CFG_BASE_URL+'/search?f=author&p='+ \
-                                  quote(address.get('p', "")) + \
-                                  '&amp;ln=' + bfo.lang + \
-                                  '">'+cgi.escape(address.get('p', "")) + \
-                                  '</a>')
+            list_addresses.append(
+                '<a href="'+cfg['CFG_BASE_URL']+'/search?f=author&p='+ \
+                quote(address.get('p', "")) + \
+                '&amp;ln=' + bfo.lang + \
+                '">'+cgi.escape(address.get('p', "")) + \
+                '</a>')
             list_addresses.append(cgi.escape(address.get('g', "")))
     else:
         for address in addresses:

diff --git a/invenio/modules/formatter/format_elements/bfe_addthis.py b/invenio/modules/formatter/format_elements/bfe_addthis.py
@@ -19,16 +19,12 @@
 
 """BibFormat element - wrap the Add This service: <http://www.addthis.com/>."""
 
-try:
-    from invenio.config import CFG_BIBFORMAT_ADDTHIS_ID
-except ImportError:
-    CFG_BIBFORMAT_ADDTHIS_ID = None
-
+from invenio.base.globals import cfg
 from invenio.legacy.search_engine import get_all_restricted_recids
 
 
 def format_element(bfo, only_public_records=1,
-                   addthis_id=CFG_BIBFORMAT_ADDTHIS_ID):
+                   addthis_id=cfg['CFG_BIBFORMAT_ADDTHIS_ID']):
     """Print the AddThis box from the <http://www.addthis.com/> service.
 
     :param only_public_records: if set to 1 (the default), prints the box only

diff --git a/invenio/modules/formatter/format_elements/bfe_affiliation.py b/invenio/modules/formatter/format_elements/bfe_affiliation.py
@@ -21,14 +21,12 @@
 __revision__ = "$Id$"
 
 import cgi
-from invenio.config import \
-    CFG_SITE_URL, CFG_SITE_NAME
-from invenio.legacy.bibauthority.config import \
-    CFG_BIBAUTHORITY_AUTHORITY_COLLECTION_NAME
-
+
+from invenio.base.globals import cfg
 from invenio.legacy.bibauthority.engine import \
     get_low_level_recIDs_from_control_no
 
+
 def format_element(bfo):
     """
     HTML Affiliation display
@@ -44,16 +42,16 @@ def format_element(bfo):
                 recIDs.extend(get_low_level_recIDs_from_control_no(control_no))
             affiliation = cgi.escape(affiliation)
             if len(recIDs) == 1:
-                affiliation = '<a href="' + CFG_SITE_URL + \
+                affiliation = '<a href="' + cfg['CFG_SITE_URL'] + \
                               '/record/' + str(recIDs[0]) + \
                               '?ln=' + bfo.lang + \
                               '">' + affiliation + '</a>'
             elif len(recIDs) > 1:
-                affiliation = '<a href="' + CFG_SITE_URL + \
+                affiliation = '<a href="' + cfg['CFG_SITE_URL'] + \
                               '/search?' + \
                               'p=recid:' +  " or recid:".join([str(_id) for _id in recIDs]) + \
-                              '&amp;c=' + CFG_SITE_NAME + \
-                              '&amp;c=' + CFG_BIBAUTHORITY_AUTHORITY_COLLECTION_NAME + \
+                              '&amp;c=' + cfg['CFG_SITE_NAME'] + \
+                              '&amp;c=' + cfg['CFG_BIBAUTHORITY_AUTHORITY_COLLECTION_NAME'] + \
                               '&amp;ln=' + bfo.lang + \
                               '">' + affiliation + '</a>'
 

diff --git a/invenio/modules/formatter/format_elements/bfe_aid_authors.py b/invenio/modules/formatter/format_elements/bfe_aid_authors.py
@@ -59,10 +59,10 @@ def format_element(bfo, limit, separator='; ',
     record page
 
     """
-    from urllib import quote
-    from cgi import escape
     import re
-    from invenio.config import CFG_BASE_URL, CFG_SITE_RECORD, CFG_SITE_URL
+    from cgi import escape
+    from invenio.base.globals import cfg
+    from urllib import quote
 
     #regex for parsing last and first names and initials
     re_last_first = re.compile('^(?P<last>[^,]+)\s*,\s*(?P<first_names>[^\,]*)(?P<extension>\,?.*)$')
@@ -131,7 +131,7 @@ def format_element(bfo, limit, separator='; ',
                 if id_links == "yes" and 'i' in author:
                     author['i'] = author['i'][0]  #possible to have more IDs?
                     id_link = '<a class="authoridlink" href="' + \
-                              CFG_BASE_URL + \
+                              cfg['CFG_BASE_URL'] + \
                               '/search?' + \
                               'ln=' + bfo.lang + \
                               '&amp;p=100__i' + escape(':' + author['i']) + \
@@ -141,7 +141,7 @@ def format_element(bfo, limit, separator='; ',
 
                 author['display'] = '<a class="authorlink" target="_blank" ' + \
                                     'href="' + \
-                                    CFG_SITE_URL + \
+                                    cfg['CFG_SITE_URL'] + \
                                     '/author/search?q=' + bibrec_id + ':' + \
                                     quote(author['a']) + \
                                     '&ln=' + bfo.lang + \
@@ -201,7 +201,7 @@ def format_element(bfo, limit, separator='; ',
     # link the extension to detailed record
     if link_extension == 'yes' and interactive != 'yes':
         extension = '<a class="authorlink" href="' + \
-                    CFG_BASE_URL + '/' + CFG_SITE_RECORD + '∕' + str(bfo.recID) + '">' + \
+                    cfg['CFG_BASE_URL'] + '/' + cfg['CFG_SITE_RECORD'] + '∕' + str(bfo.recID) + '">' + \
                     extension + '</a>'
 
     # Detect Collaborations:
@@ -214,7 +214,7 @@ def format_element(bfo, limit, separator='; ',
         colls = [re_coll.sub('', coll) for coll in colls]
         if print_links.lower() == "yes":
             colls = ['<a class="authorlink" href="' + \
-                     CFG_BASE_URL + '/search' + \
+                     cfg['CFG_BASE_URL'] + '/search' + \
                      '?p=' + quote(coll) + \
                      '&amp;ln=' + bfo.lang + \
                      '&amp;f=collaboration' + \

diff --git a/invenio/modules/formatter/format_elements/bfe_authority_author.py b/invenio/modules/formatter/format_elements/bfe_authority_author.py
@@ -16,14 +16,14 @@
 # You should have received a copy of the GNU General Public License
 # along with Invenio; if not, write to the Free Software Foundation, Inc.,
 # 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
-"""BibFormat element - Prints author data from an Authority Record.
-"""
-from invenio.config import CFG_SITE_URL, CFG_SITE_NAME
-from urllib import quote
+
+"""BibFormat element - Prints author data from an Authority Record."""
+
 import re
 
 __revision__ = "$Id$"
 
+
 def format_element(bfo, main_name='yes', detail='no'):
     """ Prints the data of an author authority record in HTML. By default prints
     brief version.