bibformat_dblayer.py
No OneTemporary
Actions

Subscribers

None

File Metadata

Created: Mon, Nov 11, 07:15

bibformat_dblayer.py
View Options

	# -- coding: utf-8 --
	##
	## This file is part of Invenio.
	## Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 CERN.
	##
	## Invenio is free software; you can redistribute it and/or
	## modify it under the terms of the GNU General Public License as
	## published by the Free Software Foundation; either version 2 of the
	## License, or (at your option) any later version.
	##
	## Invenio is distributed in the hope that it will be useful, but
	## WITHOUT ANY WARRANTY; without even the implied warranty of
	## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	## General Public License for more details.
	##
	## You should have received a copy of the GNU General Public License
	## along with Invenio; if not, write to the Free Software Foundation, Inc.,
	## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

	"""
	Database access related functions for BibFormat engine and
	administration pages.
	"""

	__revision__ = "$Id$"

	import zlib
	import time

	from invenio.dbquery import run_sql

	## MARC-21 tag/field access functions
	def get_fieldvalues(recID, tag):
	"""Returns list of values of the MARC-21 'tag' fields for the record
	'recID'."""
	out = []
	bibXXx = "bib" + tag[0] + tag[1] + "x"
	bibrec_bibXXx = "bibrec_" + bibXXx
	query = "SELECT value FROM %s AS b, %s AS bb WHERE bb.id_bibrec=%s AND bb.id_bibxxx=b.id AND tag LIKE '%s'" \
	% (bibXXx, bibrec_bibXXx, recID, tag)
	res = run_sql(query)
	for row in res:
	out.append(row[0])
	return out

	def localtime_to_utc(date, fmt="%Y-%m-%dT%H:%M:%SZ"):
	"Convert localtime to UTC"

	ldate = date.split(" ")[0]
	ltime = date.split(" ")[1]

	lhour = ltime.split(":")[0]
	lminute = ltime.split(":")[1]
	lsec = ltime.split(":")[2]

	lyear = ldate.split("-")[0]
	lmonth = ldate.split("-")[1]
	lday = ldate.split("-")[2]

	timetoconvert = time.strftime(fmt, time.gmtime(time.mktime((int(lyear), int(lmonth), int(lday), int(lhour), int(lminute), int(lsec), 0, 0, -1))))

	return timetoconvert

	def get_creation_date(sysno, fmt="%Y-%m-%dT%H:%M:%SZ"):
	"Returns the creation date of the record 'sysno'."
	out = ""
	res = run_sql("SELECT DATE_FORMAT(creation_date, '%%Y-%%m-%%d %%H:%%i:%%s') FROM bibrec WHERE id=%s", (sysno,), 1)
	if res[0][0]:
	out = localtime_to_utc(res[0][0], fmt)
	return out

	def get_modification_date(sysno, fmt="%Y-%m-%dT%H:%M:%SZ"):
	"Returns the date of last modification for the record 'sysno'."
	out = ""
	res = run_sql("SELECT DATE_FORMAT(modification_date,'%%Y-%%m-%%d %%H:%%i:%%s') FROM bibrec WHERE id=%s", (sysno,), 1)
	if res and res[0][0]:
	out = localtime_to_utc(res[0][0], fmt)
	return out

	## XML Marc related functions
	def get_tag_from_name(name):
	"""
	Returns the marc code corresponding the given name
	"""
	res = run_sql("SELECT value FROM tag WHERE name LIKE %s", (name,))
	if len(res)>0:
	return res[0][0]
	else:
	return None

	def get_tags_from_name(name):
	"""
	Returns the marc codes corresponding the given name,
	ordered by value
	"""
	res = run_sql("SELECT value FROM tag WHERE name LIKE %s ORDER BY value", (name,))
	if len(res)>0:
	return list(res[0])
	else:
	return None

	def tag_exists_for_name(name):
	"""
	Returns True if a tag exists for name in 'tag' table.
	"""
	rows = run_sql("SELECT value FROM tag WHERE name LIKE %s", (name,))
	if len(rows) > 0:
	return True
	return False

	def get_name_from_tag(tag):
	"""
	Returns the name corresponding to a marc code
	"""
	res = run_sql("SELECT name FROM tag WHERE value LIKE %s", (tag,))
	if len(res)>0:
	return res[0][0]
	else:
	return None

	def name_exists_for_tag(tag):
	"""
	Returns True if a name exists for tag in 'tag' table.
	"""
	rows = run_sql("SELECT name FROM tag WHERE value LIKE %s", (tag,))
	if len(rows) > 0:
	return True
	return False

	def get_all_name_tag_mappings():
	"""
	Return the list of mappings name<->tag from 'tag' table.

	The returned object is a dict with name as key (if 2 names are the same
	we will take the value of one of them, as we cannot make the difference in format
	templates)

	@return: a dict containing list of mapping in 'tag' table
	"""
	out = {}
	query = "SELECT value, name FROM tag"
	res = run_sql(query)
	for row in res:
	out[row[1]] = row[0]
	return out


	## Output formats related functions

	def get_output_format_id(code):
	"""
	Returns the id of output format given by code in the database.

	Output formats are located inside 'format' table

	@return: the id in the database of the output format. None if not found
	"""
	f_code = code
	if len(code)>6:
	f_code = code[:6]
	res = run_sql("SELECT id FROM format WHERE code=%s", (f_code.lower(),))
	if len(res)>0:
	return res[0][0]
	else:
	return None

	def add_output_format(code, name="", description="", content_type="text/html", visibility=1):
	"""
	Add output format into format table.

	If format with given code already exists, do nothing

	@param code: the code of the new format
	@param name: a new for the new format
	@param description: a description for the new format
	@param content_type: the content_type (if applicable) of the new output format
	"""
	output_format_id = get_output_format_id(code);
	if output_format_id is None:
	query = "INSERT INTO format SET code=%s, description=%s, content_type=%s, visibility=%s"
	params = (code.lower(), description, content_type, visibility)
	run_sql(query, params)
	set_output_format_name(code, name)

	def remove_output_format(code):
	"""
	Removes the output format with 'code'

	If code does not exist in database, do nothing
	The function also removes all localized names in formatname table

	@param the: code of the output format to remove
	"""
	output_format_id = get_output_format_id(code);
	if output_format_id is None:
	return

	query = "DELETE FROM formatname WHERE id_format='%s'" % output_format_id
	run_sql(query)
	query = "DELETE FROM format WHERE id='%s'" % output_format_id
	run_sql(query)

	def get_output_format_description(code):
	"""
	Returns the description of the output format given by code

	If code or description does not exist, return empty string

	@param code: the code of the output format to get the description from
	@return: output format description
	"""

	res = run_sql("SELECT description FROM format WHERE code=%s", (code,))
	if len(res) > 0:
	res = res[0][0]
	if res is not None:
	return res
	return ""

	def set_output_format_description(code, description):
	"""
	Sets the description of an output format, given by its code

	If 'code' does not exist, create format

	@param code: the code of the output format to update
	@param description: the new description
	"""
	output_format_id = get_output_format_id(code)
	if output_format_id is None:
	add_output_format(code, "", description)

	query = "UPDATE format SET description=%s WHERE code=%s"
	params = (description, code.lower())
	run_sql(query, params)

	def get_output_format_visibility(code):
	"""
	Returns the visibility of the output format, given by its code

	If code does not exist, return 0
	@return: output format visibility (0 if not visible, 1 if visible
	"""
	res = run_sql("SELECT visibility FROM format WHERE code=%s", (code,))
	if len(res) > 0:
	res = res[0][0]
	if res is not None and int(res) in range(0, 2):
	return int(res)
	return 0

	def set_output_format_visibility(code, visibility):
	"""
	Sets the visibility of an output format, given by its code

	If 'code' does not exist, create format

	@param code: the code of the output format to update
	@param visibility: the new visibility (0: not visible, 1:visible)
	"""
	output_format_id = get_output_format_id(code)
	if output_format_id is None:
	add_output_format(code, "", "", "", visibility)

	query = "UPDATE format SET visibility=%s WHERE code=%s"
	params = (visibility, code.lower())
	run_sql(query, params)

	def get_existing_content_types():
	"""
	Returns the list of all MIME content-types used in existing output
	formats.

	Always returns at least a list with 'text/html'

	@return: a list of content-type strings
	"""
	query = "SELECT DISTINCT content_type FROM format GROUP BY content_type"
	res = run_sql(query)

	if res is not None:
	res = [val[0] for val in res if len(val) > 0]
	if not 'text/html' in res:
	res.append('text/html')
	return res
	else:
	return ['text/html']

	def get_output_format_content_type(code):
	"""
	Returns the content_type of the output format given by code

	If code or content_type does not exist, return empty string

	@param code: the code of the output format to get the description from
	@return: output format content_type
	"""
	res = run_sql("SELECT content_type FROM format WHERE code=%s", (code,))
	if len(res) > 0:
	res = res[0][0]
	if res is not None:
	return res
	return ""

	def set_output_format_content_type(code, content_type):
	"""
	Sets the content_type of an output format, given by its code

	If 'code' does not exist, create format

	@param code: the code of the output format to update
	@param content_type: the content type for the format
	"""
	output_format_id = get_output_format_id(code)
	if output_format_id is None:
	# add one if not exist (should not happen)
	add_output_format(code, "", "", content_type)

	query = "UPDATE format SET content_type=%s WHERE code=%s"
	params = (content_type, code.lower())
	run_sql(query, params)


	def get_output_format_names(code):
	"""
	Returns the localized names of the output format designated by 'code'

	The returned object is a dict with keys 'ln' (for long name) and 'sn' (for short name),
	containing each a dictionary with languages as keys.
	The key 'generic' contains the generic name of the output format (for use in admin interface)
	For eg: {'ln':{'en': "a long name", 'fr': "un long nom", 'de': "ein lange Name"},
	'sn':{'en': "a name", 'fr': "un nom", 'de': "ein Name"}
	'generic': "a name"}

	The returned dictionary is never None. The keys 'ln' and 'sn' are always present. However
	only languages present in the database are in dicts 'sn' and 'ln'. language "CFG_SITE_LANG" is always
	in dict.

	The localized names of output formats are located in formatname table.

	@param code: the code of the output format to get the names from
	@return: a dict containing output format names
	"""
	out = {'sn':{}, 'ln':{}, 'generic':''}
	output_format_id = get_output_format_id(code);
	if output_format_id is None:
	return out

	res = run_sql("SELECT name FROM format WHERE code=%s", (code,))
	if len(res) > 0:
	out['generic'] = res[0][0]

	query = "SELECT type, ln, value FROM formatname WHERE id_format='%s'" % output_format_id
	res = run_sql(query)
	for row in res:
	if row[0] == 'sn' or row[0] == 'ln':
	out[row[0]][row[1]] = row[2]
	return out

	def set_output_format_name(code, name, lang="generic", type='ln'):
	"""
	Sets the name of an output format given by code.

	if 'type' different from 'ln' or 'sn', do nothing
	if 'name' exceeds 256 chars, 'name' is truncated to first 256 chars.
	if 'code' does not correspond to exisiting output format, create format if "generic" is given as lang

	The localized names of output formats are located in formatname table.

	@param code: the code of an ouput format
	@param type: either 'ln' (for long name) and 'sn' (for short name)
	@param lang: the language in which the name is given
	@param name: the name to give to the output format
	"""

	if len(name) > 256:
	name = name[:256]
	if type.lower() != "sn" and type.lower() != "ln":
	return
	output_format_id = get_output_format_id(code);
	if output_format_id is None and lang == "generic" and type.lower() == "ln":
	# Create output format inside table if it did not exist
	# Happens when the output format was added not through web interface
	add_output_format(code, name)
	output_format_id = get_output_format_id(code) # Reload id, because it was not found previously

	if lang =="generic" and type.lower()=="ln":
	# Save inside format table for main name
	query = "UPDATE format SET name=%s WHERE code=%s"
	params = (name, code.lower())
	run_sql(query, params)
	else:
	# Save inside formatname table for name variations
	run_sql("REPLACE INTO formatname SET id_format=%s, ln=%s, type=%s, value=%s",
	(output_format_id, lang, type.lower(), name))

	def change_output_format_code(old_code, new_code):
	"""
	Change the code of an output format

	@param old_code: the code of the output format to change
	@param new_code: the new code
	"""
	output_format_id = get_output_format_id(old_code);
	if output_format_id is None:
	return

	query = "UPDATE format SET code=%s WHERE id=%s"
	params = (new_code.lower(), output_format_id)
	res = run_sql(query, params)

	def get_preformatted_record(recID, of, decompress=zlib.decompress):
	"""
	Returns the preformatted record with id 'recID' and format 'of'

	If corresponding record does not exist for given output format,
	returns None

	@param recID: the id of the record to fetch
	@param of: the output format code
	@param decompress: the method used to decompress the preformatted record in database
	@return: formatted record as String, or None if not exist
	"""
	# Try to fetch preformatted record
	query = "SELECT value FROM bibfmt WHERE id_bibrec=%s AND format=%s"
	params = (recID, of)
	res = run_sql(query, params)
	if res:
	# record 'recID' is formatted in 'of', so return it
	return "%s" % decompress(res[0][0])
	else:
	return None

	def get_preformatted_record_date(recID, of):
	"""
	Returns the date of the last update of the cache for the considered
	preformatted record in bibfmt

	If corresponding record does not exist for given output format,
	returns None

	@param recID: the id of the record to fetch
	@param of: the output format code
	@return: the date of the last update of the cache, or None if not exist
	"""
	# Try to fetch preformatted record
	query = "SELECT last_updated FROM bibfmt WHERE id_bibrec='%s' AND format='%s'" % (recID, of)
	res = run_sql(query)
	if res:
	# record 'recID' is formatted in 'of', so return it
	return "%s" % res[0][0]
	else:
	return None

	## def keep_formats_in_db(output_formats):
	## """
	## Remove from db formats that are not in the list
	## TOBE USED ONLY ONCE OLD BIBFORMAT IS REMOVED (or old behaviours will be erased...)
	## """
	## query = "SELECT code FROM format"
	## res = run_sql(query)
	## for row in res:
	## if not row[0] in output_formats:
	## query = "DELETE FROM format WHERE code='%s'"%row[0]

	## def add_formats_in_db(output_formats):
	## """
	## Add given formats in db (if not already there)
	## """
	## for output_format in output_format:

	## if get_format_from_db(output_format) is None:
	## #Add new
	## query = "UPDATE TABLE format "
	## else:
	## #Update
	## query = "UPDATE TABLE format "

	## query = "UPDATE TABLE format "
	## res = run_sql(query)
	## for row in res:
	## if not row[0] in output_formats:
	## query = "DELETE FROM format WHERE code='%s'"%row[0]

bibformat_dblayer.pyNo OneTemporaryActions

File Metadata

bibformat_dblayer.pyView Options

Event Timeline

bibformat_dblayer.py
No OneTemporary
Actions

bibformat_dblayer.py
View Options