Diffusion invenio-infoscience (maint-2.0) Browse

bibeditmulti.js
d30e56fa001amaint-2.0

bibeditmulti.js
View Options

			/*
			* This file is part of Invenio.
			* Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008 2009 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.
			*/

			/*
			* Global variables
			*/

			/global performAJAXRequest, setOutputFormat, rebindActionsRelatedControls /

			// Defines the different actions performed by AJAX calls
			var gActionTypes = {
			testSearch : "testSearch",
			displayDetailedRecord : "displayDetailedRecord",
			previewResults : "previewResults",
			displayDetailedResult : "displayDetailedResult",
			submitChanges : "submitChanges"
			};

			// Defines the different output formats of the results
			var gOutputFormatTypes = {
			bibTeX : "hx",
			marcXML : "xm",
			nlm : "xn",
			htmlBrief : "hb",
			htmlDetailed : "hd",
			marc : "hm"
			};

			// Defines different types of commands for manipulation of records
			var gCommandTypes = {
			replaceTextInField : "replaceTextInField",
			replaceFieldContent : "replaceFieldContent",
			deleteField : "deleteField",
			addField : "addField"
			};

			// current action
			var gActionToPerform = "";
			// ID of the record that will be displayed
			var gCurrentRecordID = -1;
			// Keeps the commands entered by the user
			var gCommands = {};
			var gCurrentCommandID = 0;
			var gPageToDiplay = 1;
			var gDeleteCommandIDPrefix = "deleteCommandID_";
			var gCommandDisplayTemplateIDPrefix = "commandDisplayTemplateID_";
			var gOutputFormat = gOutputFormatTypes.marc;
			var gOutputFormatDetails = gOutputFormatTypes.htmlDetailed;
			var gOutputFormatPreview = gOutputFormatTypes.marc;

			/*
			* Global variables
			*/

			var gFields = {};
			var gCurrentFieldID = 0;
			var gCurrentSubfieldID = 0;
			var gFieldDisplayIDPrefix = "fieldDisplayID";
			var gSubfieldDisplayIDPrefix = "subfieldDisplayID";

			var gSubfieldActionTypes = {
			addSubfield : 0,
			deleteSubfield : 1,
			replaceContent : 2,
			replaceText : 3
			};

			var gFieldActionTypes = {
			addField : 0,
			deleteField : 1,
			updateField : 2
			};

			function updateView() {
			$("#displayTemplates").hide();
			}

			function createCommandsList(){
			/*
			* Creates structure with information about the commands
			*/
			var commands = Array();

			var fieldID = "";
			for (fieldID in gFields) {
			var currentField = gFields[fieldID];

			subfieldsList = Array();
			subfields = currentField.subfields;
			var subfieldID = "";
			for (subfieldID in subfields) {
			currentSubfield = subfields[subfieldID];
			subfieldsList.push(currentSubfield);
			}

			var field = {
			tag : currentField.tag,
			ind1 : currentField.ind1,
			ind2 : currentField.ind2,
			action : currentField.action,
			subfields : subfieldsList
			};

			commands.push(field);
			}

			return commands;
			}

			// Page in results preview
			function onButtonGoToFirstPageClick(){
			gPageToDiplay = 1;
			performAJAXRequest();
			}
			function onButtonGoToPreviousPageClick(){
			gPageToDiplay--;
			performAJAXRequest();
			}
			function onButtonGoToNextPageClick(){
			gPageToDiplay++;
			performAJAXRequest();
			}

			function onButtonOutputFormatMarcXMLClick(){
			setOutputFormat(gOutputFormatTypes.marcXML);
			}
			function onButtonOutputFormatHTMLBriefClick(){
			setOutputFormat(gOutputFormatTypes.htmlBrief);
			}
			function onButtonOutputFormatHTMLDetailedClick(){
			setOutputFormat(gOutputFormatTypes.htmlDetailed);
			}
			function onButtonOutputFormatMARCClick(){
			setOutputFormat(gOutputFormatTypes.marc);
			}

			function onButtonTestSearchClick() {
			/*
			* Displays preview of the results of the search
			*/
			gActionToPerform = gActionTypes.testSearch;
			gOutputFormat = gOutputFormatPreview;
			gPageToDiplay = 1;
			performAJAXRequest();
			}

			function onButtonPreviewResultsClick() {
			/*
			* Displays preview of the results of the search All the changes defined
			* with the commands are reflected in the results
			*/
			gActionToPerform = gActionTypes.previewResults;
			gOutputFormat = gOutputFormatPreview;
			gPageToDiplay = 1;
			performAJAXRequest();
			}

			function onButtonBackToResultsClick() {
			/*
			* Brings back the user to the results list
			*/
			if (gActionToPerform == gActionTypes.displayDetailedRecord) {
			onButtonTestSearchClick();
			} else {
			onButtonPreviewResultsClick();
			}
			}

			function onButtonGoToNextPageClick(){
			gPageToDiplay++;
			performAJAXRequest();
			}

			function onButtonSubmitChangesClick(){
			/*
			* Submits changes defined by user
			*/
			var confirmation = confirm('Are you sure you want to submit the changes?');
			if (confirmation == true) {
			gActionToPerform = gActionTypes.submitChanges;
			performAJAXRequest();
			}
			}

			function rebindControls() {
			/*
			* Binds controls with the appropriate events
			*/

			rebindActionsRelatedControls();
			initTextBoxes();


			$("#buttonTestSearch").bind("click", onButtonTestSearchClick);
			$("#buttonPreviewResults").bind("click", onButtonPreviewResultsClick);
			$("#buttonSubmitChanges").bind("click", onButtonSubmitChangesClick);
			$(".buttonBackToResults").bind("click", onButtonBackToResultsClick);
			$(".buttonOutputFormatMarcXML").bind("click", onButtonOutputFormatMarcXMLClick);
			$(".buttonOutputFormatHTMLBrief").bind("click", onButtonOutputFormatHTMLBriefClick);
			$(".buttonOutputFormatHTMLDetailed").bind("click", onButtonOutputFormatHTMLDetailedClick);
			$(".buttonOutputFormatMARC").bind("click", onButtonOutputFormatMARCClick);
			/$(".resultItem").bind("click", onResultItemClick);/
			$(".buttonGoToFirstPage").bind("click", onButtonGoToFirstPageClick);
			$(".buttonGoToPreviousPage").bind("click", onButtonGoToPreviousPageClick);
			$(".buttonGoToNextPage").bind("click", onButtonGoToNextPageClick);
			}

			function displayResultsPreview(data) {
			$("#preview_area").html(data);
			rebindControls();
			}

			function createJSONData() {
			/*
			* Gathers the necessary data and creates a JSON structure that can be used
			* with the AJAX requests
			*/

			var searchCriteria = $("#textBoxSearchCriteria").val();
			var outputTags = $("#textBoxOutputTags").val();
			var language = $("#language").val();
			var actionType = gActionToPerform;
			var currentRecordID = gCurrentRecordID;
			var outputFormat = gOutputFormat;
			var pageToDisplay = gPageToDiplay;
			var collection = $("#collection").val();
			var commands = createCommandsList();

			var data = {
			language : language,
			searchCriteria : searchCriteria,
			outputTags : outputTags,
			actionType : actionType,
			currentRecordID : currentRecordID,
			commands : commands,
			outputFormat : outputFormat,
			pageToDisplay : pageToDisplay,
			collection: collection
			};

			return JSON.stringify(data);
			}


			function onRequestError(XMLHttpRequest, textStatus, errorThrown) {
			/*
			* Handle AJAX request errors.
			*/
			// FIXME: Change this method. At least strings should be localazed.
			// It is better if the message is more friendly and displayed in a
			// better way
			// alert('Request completed with status ' + textStatus + '\nResult: '
			// + XMLHttpRequest.responseText + '\nError: ' + errorThrown);
			error_message = 'Request completed with status ' + textStatus +
			'\nResult: ' + XMLHttpRequest.responseText + '\nError: ' + errorThrown;

			displayResultsPreview(error_message);
			}

			function performAJAXRequest() {
			/*
			* Perform an AJAX request
			*/

			$.ajax( {
			cache : false,
			type : "POST",
			dataType : "text",
			data : {
			jsondata : createJSONData()
			},
			success : displayResultsPreview,
			error : onRequestError
			});
			}

			function setOutputFormat(outputFormat){
			// We have separate format for the preview and detailed view
			// so we have to set the proper variable depending
			// what are we currently displaying
			if (gActionToPerform == gActionTypes.testSearch \|\| gActionToPerform == gActionTypes.previewResults ){
			gOutputFormatPreview = outputFormat;
			}
			else{
			gOutputFormatDetails = outputFormat;
			}

			gOutputFormat = outputFormat;

			if (gActionToPerform!=""){
			performAJAXRequest();
			}
			}

			function initTextBoxes(){
			$('#textBoxValue, #textBoxNewValue, #textBoxOutputTags, #textBoxCondition').focus(function() {
			if (this.value == this.defaultValue){
			this.value = '';
			}
			if(this.value != this.defaultValue){
			this.select();
			}
			});

			$('#textBoxValue, #textBoxNewValue, #textBoxOutputTags, #textBoxCondition').blur(function() {
			if ($.trim(this.value) == ''){
			this.value = (this.defaultValue ? this.defaultValue : '');
			}
			});

			}

			$(document).ready( function() {
			rebindControls();
			updateView();
			});


			/*
			* ********************************************************
			* Methods related to action edition
			* ********************************************************
			* */


			function getFieldID(displayID){
			var fieldID = displayID.split("_")[1];
			return fieldID;
			}

			function getSubfieldID(displayID){
			var subfieldID = displayID.split("_")[2];
			return subfieldID;
			}


			function getIndicatorText(indicator) {
			var text = (indicator === "" \|\| indicator === " ") ? "_" : indicator;
			return text;
			}

			function cleanIndicator(indicator) {
			var cleanedValue = (indicator != "_" && indicator != "") ? indicator : " ";
			return cleanedValue;
			}

			function displayProperSubfieldInformation(actionParentElement, actionType, displayCondition) {
			actionParentElement.find(".valueParameters").hide();
			actionParentElement.find(".newValueParameters").hide();
			actionParentElement.find(".conditionParameters").hide();
			actionParentElement.find(".conditionSubfieldParameters").hide();

			if (actionType == null){
			actionType = actionParentElement.find(".subfieldActionType").eq(0).val();
			}

			if(actionType != gSubfieldActionTypes.deleteSubfield) {
			actionParentElement.find(".valueParameters").show();
			}

			if(actionType == gSubfieldActionTypes.replaceText) {
			actionParentElement.find(".newValueParameters").show();
			}

			// Fix subfield action type to "add" when adding fields
			// We assume that by default this is the selected value
			var subfieldDisplayID = actionParentElement.attr("id");
			var fieldID = getFieldID(subfieldDisplayID);
			var field = gFields[fieldID];

			if(field.action == gFieldActionTypes.addField){
			actionParentElement.find(".subfieldActionType").attr("disabled", "true");
			}

			if (displayCondition == 'true') {
			actionParentElement.find(".conditionParameters").show();
			actionParentElement.find(".conditionSubfieldParameters").show();
			}

			}

			function unbindControls(filter_field){
			if (filter_field == 'true'){
			$("#actOnFields").unbind("click");
			$("#actOnFieldsRemove").unbind("click");
			$("#actOnFieldsRemove").bind("click", onActOnFieldsRemoveClick);
			}
			else{
			$("#actOnFields").unbind("click");
			$("#actOnFields").bind("click", onActOnFieldsClick);
			$("#actOnFieldsRemove").unbind("click");
			}

			}

			function onActOnFieldsClick() {
			var parentElement = $(this).parents(".templateNewSubfield").eq(0);
			parentElement.find(".conditionParameters").show();
			parentElement.find(".conditionSubfieldParameters").show();
			parentElement.find("#actOnFields").html('<u>Act on all fields</u>');
			parentElement.find("#actOnFields").attr('id', 'actOnFieldsRemove');

			unbindControls('true');
			}

			function onActOnFieldsRemoveClick() {
			var parentElement = $(this).parents(".templateNewSubfield").eq(0);
			parentElement.find(".conditionParameters").hide();
			parentElement.find(".conditionSubfieldParameters").hide();
			parentElement.find("#actOnFieldsRemove").html('<u>Apply only to specific field instances</u>');
			parentElement.find("#actOnFieldsRemove").attr('id', 'actOnFields');

			unbindControls('false');
			}

			function generateFieldDisplayID() {
			/*
			* Returns identifier for field that could be used
			* in the html elements
			*/
			var fieldDisplayID = gFieldDisplayIDPrefix + "_" +gCurrentFieldID;
			gCurrentFieldID++;

			return fieldDisplayID;
			}

			function generateSubfieldDisplayID(fieldID, subfieldID) {
			/*
			* Returns identifier for subfield that could be used
			* in the html elements
			*/
			if (subfieldID == null){
			subfieldID = gCurrentSubfieldID;
			gCurrentSubfieldID++;
			}
			var subfieldDisplayID = gFieldDisplayIDPrefix + "_" + fieldID + "_" + subfieldID;

			return subfieldDisplayID;
			}


			function addMessage(fieldID, actionText) {
			if (actionText != "Delete field") {
			var templateMsg = $("#displayTemplates .templateMsg").clone();

			templateMsg.attr("id", 'Msg_' + fieldID);
			templateMsg.find(".msg").eq(0).text("Warning: add one subfield action before applying changes");

			$("#actionsDisplayArea .lastRow").before(templateMsg);

			rebindControls();
			}
			}

			function deleteMsg(fieldID) {
			var msgID = "#" + 'Msg_' + fieldID;
			$(msgID).remove();
			}

			function createSubfield(templateNewSubield){
			/*
			* Creates a subfield from the informaiton contained in
			* templateNewSubield. It is expected to contain specific
			* fields with all the necessary information
			*/

			var subfieldCode = templateNewSubield.find(".textBoxSubfieldCode").eq(0).val();
			var value = templateNewSubield.find(".textBoxValue").eq(0).val();
			var newValue = templateNewSubield.find(".textBoxNewValue").eq(0).val();
			var action = templateNewSubield.find(".subfieldActionType").eq(0).val();
			var condition = templateNewSubield.find(".textBoxCondition").eq(0).val();
			var conditionSubfield = templateNewSubield.find(".textBoxConditionSubfield").eq(0).val();

			var subfield = {
			subfieldCode : subfieldCode,
			value : value,
			newValue : newValue,
			action : action,
			condition : condition,
			conditionSubfield : conditionSubfield
			};

			return subfield;
			}

			function createField(jqueryElement) {
			/*
			* Creates a field from the informaiton contained in an
			* element. This element is expected to contain specific
			* fields with all the necessary information
			*/

			var tag = jqueryElement.find(".textBoxFieldTag").eq(0).val();
			var ind1 = jqueryElement.find(".textBoxFieldInd1").eq(0).val();
			var ind2 = jqueryElement.find(".textBoxFieldInd2").eq(0).val();
			var action = jqueryElement.find(".fieldActionType").eq(0).val();

			ind1 = cleanIndicator(ind1);
			ind2 = cleanIndicator(ind2);

			var subfields = {};


			var field = {
			tag : tag,
			ind1 : ind1,
			ind2 : ind2,
			action : action,
			subfields : subfields
			};

			return field;
			}

			function onFieldActionTypeChange(instance) {
			onButtonSaveNewFieldClick(instance);
			}

			function onSubfieldActionTypeChange() {
			var parentElement = $(this).parents(".templateNewSubfield").eq(0);

			displayProperSubfieldInformation(parentElement);
			}

			function onButtonNewSubfieldClick(instance) {
			// find the id of the field that is parent of the subfield

			var templateField = $(this).parents(".templateDisplayField");
			var fieldDisplayID = templateField.attr("id");
			var fieldID = getFieldID(fieldDisplayID);

			// generate ID for the the element of the new subfield
			var subfieldDisplayID = generateSubfieldDisplayID(fieldID);

			// add the new subfield to the UI
			var templateNewSubfield = $("#displayTemplates .templateNewSubfield").clone();
			templateNewSubfield.attr("id", subfieldDisplayID);
			displayProperSubfieldInformation(templateNewSubfield);
			templateField.after(templateNewSubfield);

			rebindControls();
			}

			function onButtonCancelNewSubfieldClick() {
			$(this).parents(".templateNewSubfield").remove();
			}

			function onButtonNewFieldClick() {
			var templateNewField = $("#displayTemplates .templateNewField").clone();
			templateNewField.attr("id", generateFieldDisplayID());
			$("#actionsDisplayArea .lastRow").before(templateNewField);

			rebindControls();
			}

			function onButtonCancelNewFieldClick(instance) {
			$(instance).parents(".templateNewField").remove();
			}

			function onButtonDeleteFieldClick() {
			var fieldElement = $(this).parents(".templateDisplayField");

			var fieldDisplayID = fieldElement.attr("id");

			var fieldID = getFieldID(fieldDisplayID);

			// delete subfields from the UI
			var subfieldID = "";
			for (subfieldID in gFields[fieldID].subfields){
			var subfieldSelector = "#" + generateSubfieldDisplayID(fieldID, subfieldID);
			$(subfieldSelector).remove();
			}

			// delete field itself
			delete gFields[fieldID];
			fieldElement.remove();
			deleteMsg(fieldID);
			}

			function onButtonSaveNewSubfieldClick() {
			// template for displaying the information
			var templateDisplaySubfield = $("#displayTemplates .templateDisplaySubfield").clone();
			// here is where the user entered the information
			var templateNewSubfield = $(this).parents(".templateNewSubfield");

			var subfieldDisplayID = templateNewSubfield.attr("id");
			var fieldID = getFieldID(subfieldDisplayID);
			var subfieldID = getSubfieldID(subfieldDisplayID);

			var currentSubfield = createSubfield(templateNewSubfield);
			var field = gFields[fieldID];
			field.subfields[subfieldID] = currentSubfield;

			// update subfield appearence at the user interface
			var actionText = templateNewSubfield.find(".subfieldActionType").eq(0).find('option').filter(':selected').text();

			templateDisplaySubfield.attr("id", subfieldDisplayID);
			templateDisplaySubfield.find(".action").eq(0).text(actionText);
			templateDisplaySubfield.find(".subfieldCode").eq(0).text(currentSubfield.subfieldCode);
			templateDisplaySubfield.find(".value").eq(0).text(currentSubfield.value);
			templateDisplaySubfield.find(".newValue").eq(0).text(currentSubfield.newValue);
			templateDisplaySubfield.find(".condition").eq(0).text(currentSubfield.condition);
			templateDisplaySubfield.find(".conditionSubfield").eq(0).text(currentSubfield.conditionSubfield);

			if (templateDisplaySubfield.find(".condition").eq(0).text() != 'condition') {
			displayProperSubfieldInformation(templateDisplaySubfield, currentSubfield.action, 'true');
			}
			else {
			displayProperSubfieldInformation(templateDisplaySubfield, currentSubfield.action);
			}
			templateNewSubfield.replaceWith(templateDisplaySubfield );

			deleteMsg(fieldID);
			rebindControls();
			}

			function onButtonDeleteSubfieldClick() {
			var subfieldElement = $(this).parents(".templateDisplaySubfield");

			var subfieldDisplayID = subfieldElement.attr("id");

			var fieldID = getFieldID(subfieldDisplayID);
			var subfieldID = getSubfieldID(subfieldDisplayID);

			delete gFields[fieldID].subfields[subfieldID];
			subfieldElement.remove();
			}

			function onButtonSaveNewFieldClick(instance) {
			// template for displaying the information

			var templateDisplayField = $("#displayTemplates .templateDisplayField").clone();

			// here is where the user entered the information
			var templateNewField = $(instance).parents(".templateNewField");

			var field = createField(templateNewField);

			var fieldDisplayID = templateNewField.attr("id");
			var fieldID = getFieldID(fieldDisplayID);

			gFields[fieldID] = field;

			// update field appearence at the user interface
			var actionText = templateNewField.find(".fieldActionType").eq(0).find('option').filter(':selected').text();

			templateDisplayField.attr("id", fieldDisplayID);
			templateDisplayField.find(".tag").eq(0).text(field.tag);
			templateDisplayField.find(".ind1").eq(0).text(getIndicatorText(field.ind1));
			templateDisplayField.find(".ind2").eq(0).text(getIndicatorText(field.ind2));
			templateDisplayField.find(".action").eq(0).text(actionText);

			// When deleting fields, we don't have to define subfields
			if(field.action == gFieldActionTypes.deleteField){
			templateDisplayField.find(".buttonNewSubfield").remove();
			}

			templateNewField.replaceWith(templateDisplayField);

			rebindControls();
			addMessage(fieldID, actionText);
			}

			function rebindActionsRelatedControls() {
			/*
			* Binds controls with the appropriate events
			*/
			// Field related
			$(".buttonNewField").bind("click", onButtonNewFieldClick);
			$("#buttonSaveNewField").bind("click", onButtonSaveNewFieldClick);
			$("#buttonCancelNewField").bind("click", onButtonCancelNewFieldClick);
			$(".buttonDeleteField").bind("click", onButtonDeleteFieldClick);
			// Subfield related
			$(".buttonNewSubfield").bind("click", onButtonNewSubfieldClick);
			$("#buttonSaveNewSubfield").bind("click", onButtonSaveNewSubfieldClick);
			$("#buttonCancelNewSubfield").bind("click", onButtonCancelNewSubfieldClick);
			$(".buttonDeleteSubfield").bind("click", onButtonDeleteSubfieldClick);
			$(".subfieldActionType").bind("change", onSubfieldActionTypeChange);
			$("#actOnFields").bind("click", onActOnFieldsClick);
			$("#actOnFieldsRemove").bind("click", onActOnFieldsRemoveClick);
			}

			function onSelectOutputFormatChange(value){
			if (value == "Marc"){
			setOutputFormat(gOutputFormatTypes.marc);
			}
			else{
			setOutputFormat(gOutputFormatTypes.htmlBrief);
			}
			}

			function onEnter(evt){
			var keyCode = null;
			if( evt.which ) {
			keyCode = evt.which;
			} else if( evt.keyCode ) {
			keyCode = evt.keyCode;
			}if( 13 == keyCode ) {
			onButtonTestSearchClick();
			}
			}

			function onPressEsc(evt){
			var keyCode = null;

			if( evt.which ) {
			keyCode = evt.which;
			}
			else if( evt.keyCode ) {
			keyCode = evt.keyCode;
			}
			if( 27 == keyCode ) {
			onButtonCancelNewFieldClick(evt.target);
			}
			}

			function onSelectCollectionChange(evt){
			onButtonTestSearchClick();
			}

R3600/modules/bibedit/lib/bibeditmulti.jsd30e56fa001amaint-2.0

bibeditmulti.jsView Options

R3600/modules/bibedit/lib/bibeditmulti.js
d30e56fa001amaint-2.0

bibeditmulti.js
View Options