litvinovg/vitro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updates for handling single and double quotes as well as enabling self contained template option for page management

Browse source
This commit is contained in:
hjkhjk54 2012-08-03 15:24:58 +00:00
parent 6a63de6144
commit 8225bcf91f
7 changed files with 97 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

20
webapp/src/edu/cornell/mannlib/vitro/webapp/edit/n3editing/configuration/generators/ManagePageGenerator.java
View file

@ -98,7 +98,7 @@ public class ManagePageGenerator extends BaseEditConfigurationGenerator implemen
private void setUrisAndLiteralsOnForm(EditConfigurationVTwo conf,
VitroRequest vreq) {
conf.setUrisOnForm(new String[]{"page", "menuItem"}); //new resources: should this be on form for new - should be for existing
conf.setLiteralsOnForm(new String[]{"pageName", "prettyUrl", "menuPosition", "menuLinkText", "customTemplate", "pageContentUnit"}); //page content unit = data getter JSON object
conf.setLiteralsOnForm(new String[]{"pageName", "prettyUrl", "menuPosition", "menuLinkText", "customTemplate", "isSelfContainedTemplate", "pageContentUnit"}); //page content unit = data getter JSON object
}
@ -116,7 +116,8 @@ public class ManagePageGenerator extends BaseEditConfigurationGenerator implemen
private void setN3Optional(EditConfigurationVTwo conf) {
//body template is not required, and a given page may or may not be a menu item, but should linked to menu if menu item
conf.setN3Optional(new ArrayList<String>(Arrays.asList(prefixes + pageBodyTemplateN3,
prefixes + menuItemN3 + menuN3)));
prefixes + menuItemN3 + menuN3,
prefixes + isSelfContainedTemplateN3)));
}
private void setN3Required(EditConfigurationVTwo conf) {
@ -149,6 +150,10 @@ public class ManagePageGenerator extends BaseEditConfigurationGenerator implemen
FieldVTwo menuItemPositionField = new FieldVTwo().setName("menuPosition").setRangeDatatypeUri(XSD.integer.getURI());
conf.addField(menuItemPositionField);
//If this is a self contained template, the appropriate flag will be set
FieldVTwo isSelfContainedTemplateField = new FieldVTwo().setName("isSelfContainedTemplate");
conf.addField(isSelfContainedTemplateField);
//The actual page content information is stored in this field, and then
//interpreted using the preprocessor
FieldVTwo pageContentUnitField = new FieldVTwo().setName("pageContentUnit");
@ -423,6 +428,7 @@ public class ManagePageGenerator extends BaseEditConfigurationGenerator implemen
map.put("menuPosition", getExistingMenuPositionQuery());
map.put("menuLinkText", getExistingMenuLinkTextQuery());
map.put("customTemplate", getExistingCustomTemplateQuery());
map.put("isSelfContainedTemplate", getExistingIsSelfContainedTemplateQuery());
return map;
}
@ -462,6 +468,12 @@ private String getExistingCustomTemplateQuery() {
return query;
}
private String getExistingIsSelfContainedTemplateQuery() {
String query = getSparqlPrefix() + "SELECT ?isSelfContainedTemplate WHERE {?page display:isSelfContainedTemplate ?isSelfContainedTemplate .}";
return query;
}
//Form specific data
//In this case, need to get all the different data getter TYPES and labels
//Also need to pass back the map for the options presented to the user
@ -533,6 +545,10 @@ private String getExistingCustomTemplateQuery() {
final static String pageBodyTemplateN3 = "?page display:requiresBodyTemplate ?customTemplate .";
//If self contained template, n3 will denote this using a flag
final static String isSelfContainedTemplateN3 = "?page display:isSelfContainedTemplate ?isSelfContainedTemplate .";
//Menu position is added dynamically at end by default and can be changed on reordering page
final static String menuItemN3 = "?menuItem a display:NavigationElement ; \n" +
"display:menuPosition ?menuPosition; \n" +

11
webapp/src/edu/cornell/mannlib/vitro/webapp/edit/n3editing/configuration/preprocessors/ManagePagePreprocessor.java
View file

@ -172,11 +172,14 @@ public class ManagePagePreprocessor extends
private void convertToJson() {
//Iterate through list of inputs
pageContentUnitsJSON = new ArrayList<JSONObject>();
for(String pageContentUnit: pageContentUnits) {
JSONObject jsonObject = (JSONObject) JSONSerializer.toJSON( pageContentUnit );
pageContentUnitsJSON.add(jsonObject);
//page content units might return null in case self-contained template is selected
//otherwise there should be page content units returned from the form
if(pageContentUnits != null) {
for(String pageContentUnit: pageContentUnits) {
JSONObject jsonObject = (JSONObject) JSONSerializer.toJSON( pageContentUnit );
pageContentUnitsJSON.add(jsonObject);
}
}
}
//This is where the actual values will be submitted as if they were separate input fields

11
webapp/src/edu/cornell/mannlib/vitro/webapp/edit/n3editing/configuration/preprocessors/utils/ProcessFixedHTMLN3.java
View file

@ -142,8 +142,11 @@ public class ProcessFixedHTMLN3 extends ProcessDataGetterAbstract {
QuerySolution qs = results.nextSolution();
Literal saveToVarLiteral = qs.getLiteral("saveToVar");
Literal htmlValueLiteral = qs.getLiteral("htmlValue");
String htmlValueString = htmlValueLiteral.getString();
htmlValueString = this.replaceQuotes(htmlValueString);
jObject.element("saveToVar", saveToVarLiteral.getString());
jObject.element("htmlValue", htmlValueLiteral.getString());
//TODO: Handle single and double quotes within string and escape properlyu
jObject.element("htmlValue", htmlValueString);
}
} catch(Exception ex) {
log.error("Exception occurred in retrieving existing values with query " + querystr, ex);
@ -151,6 +154,12 @@ public class ProcessFixedHTMLN3 extends ProcessDataGetterAbstract {
return jObject;
}
//Escape single and double quotes for html string to be returned to form
public String replaceQuotes(String inputStr) {
return inputStr.replaceAll("\'", "&#39;").replaceAll("\"", "&quot;");
}
}

3
webapp/web/WEB-INF/ontologies/app/menuload/displayTBOX.n3
View file

@ -91,6 +91,9 @@ owl:versionInfo
<http://vitro.mannlib.cornell.edu/ontologies/display/1.1#requiresBodyTemplate>
a owl:DatatypeProperty .
<http://vitro.mannlib.cornell.edu/ontologies/display/1.1#isSelfContainedTemplate>
a owl:DatatypeProperty .
<http://vitro.mannlib.cornell.edu/ontologies/display/1.1#menuPosition>
a owl:DatatypeProperty ;
<http://vitro.mannlib.cornell.edu/ns/vitro/0.7#displayLimitAnnot>

38
webapp/web/js/menupage/pageManagementUtils.js
View file

@ -256,7 +256,7 @@ var pageManagementUtils = {
var validationError = pageManagementUtils.validateMenuItemForm();
//Add any errors from page content sections if necessary
// Only validate the content sections if the self contained template section is NOT selected tlw72
if ( !pageManagementUtils.selfContainedTemplate.is(':checked') ) {
if ( !pageManagementUtils.isSelfContainedTemplateChecked() ) {
validationError += pageManagementUtils.validatePageContentSections();
}
if (validationError == "") {
@ -264,7 +264,8 @@ var pageManagementUtils = {
pageManagementUtils.checkMenuTitleSubmission();
//Create the appropriate json objects if necessary
pageManagementUtils.createPageContentForSubmission();
pageManagementUtils.mapCustomTemplateName();
//pageManagementUtils.mapCustomTemplateName();
pageManagementUtils.setUsesSelfContainedTemplateInput();
return true;
} else{
$('#error-alert').removeClass('hidden');
@ -698,10 +699,22 @@ var pageManagementUtils = {
//Create a new hidden input with a specific name and assign value per page content
pageManagementUtils.createPageContentInputForSubmission(jsonObjectString);
});
//For the case where the template only selection is picked, there will be
//no page contents, but the hidden input still needs to be created as it is expected
//to exist by the edit configuration, this creates the hidden input with an empty value
if (pageManagementUtils.isSelfContainedTemplateChecked() ) {
//An empty string as no content selected
pageManagementUtils.createPageContentInputForSubmission("");
}
},
createPageContentInputForSubmission: function(inputValue) {
$("<input type='hidden' name='pageContentUnit' value='" + inputValue + "'>").appendTo(pageManagementUtils.pageContentSubmissionInputs);
//Previously, this code created the hidden input and included the value inline
//but this was converting html encoding for quotes/single quotes into actual quotes
//which prevented correct processing as the html thought the string had ended
//Creating the input and then using the val() method preserved the encoding
var pageContentUnit = $("<input type='hidden' name='pageContentUnit'>");
pageContentUnit.val(inputValue);
pageContentUnit.appendTo(pageManagementUtils.pageContentSubmissionInputs);
},
//returns a json object with the data getter information required
processPageContentSection:function(pageContentSection) {
@ -776,8 +789,9 @@ var pageManagementUtils = {
validationError += "The pretty URL must begin with a leading forward slash<br />";
}
// Check custom template
if ($('input:radio[name=selectedTemplate]:checked').val() == "custom") {
// Check custom template and self contained template
var selectedTemplateValue = $('input:radio[name=selectedTemplate]:checked').val();
if (selectedTemplateValue == "custom" || selectedTemplateValue == "selfContained") {
if ($('input[name=customTemplate]').val() == "") {
validationError += "You must supply a template<br />";
}
@ -817,17 +831,27 @@ var pageManagementUtils = {
//If the selfContained-template radio is checked, copy the custom template name to the hidden
//selfContainedTemplate input element. We need that for edit mode to select the correct radio button.
mapCustomTemplateName:function() {
if ( this.selfContainedTemplateRadio.is(':checked') ) {
if ( pageManagementUtils.selfContainedTemplateRadio.is(':checked') ) {
$("input[name='selfContainedTemplate']").val($("input[name='customTemplate']").val());
}
},
setUsesSelfContainedTemplateInput:function() {
//On form submission attach hidden input to form if the custom template selection is picked
if ( pageManagementUtils.isSelfContainedTemplateChecked() ) {
$("<input name='isSelfContainedTemplate' value='true'>").appendTo($("form"));
}
},
//If any content is defined, keep the selContained radio button hidden
checkSelfContainedRadio:function() {
if ( pageManagementUtils.savedContentDivs.html().length == 0 ) {
$('div#selfContainedDiv').show();
}
},
isSelfContainedTemplateChecked:function() {
return pageManagementUtils.selfContainedTemplateRadio.is(':checked');
}
}

24
webapp/web/js/menupage/processFixedHTMLDataGetterContent.js
View file

@ -11,7 +11,10 @@ var processFixedHTMLDataGetterContent = {
processPageContentSection:function(pageContentSection) {
var saveToVarValue = pageContentSection.find("input[name='saveToVar']").val();
var htmlValue = pageContentSection.find("textarea[name='htmlValue']").val();
//query model should also be an input
//JSON parsing on the server side does not handle single quotes, as it appears it thinks the string has
//ended. Different data getter types may handle apostrophes/single quotes differently
//In this case, this is HTML so it simply html Encodes any apostrophes
htmlValue = processFixedHTMLDataGetterContent.replaceSingleQuote(htmlValue);
var returnObject = {saveToVar:saveToVarValue, htmlValue:htmlValue, dataGetterClass:this.dataGetterClass};
return returnObject;
},
@ -38,13 +41,30 @@ var processFixedHTMLDataGetterContent = {
//Check that query and saveToVar have been input
var variableValue = pageContentSection.find("input[name='saveToVar']").val();
if(variableValue == "") {
validationError += pageContentSectionLabel + ": You must supply a variable to save HTML content. <br />"
validationError += pageContentSectionLabel + ": You must supply a variable to save HTML content. <br />";
}
if(processFixedHTMLDataGetterContent.stringHasSingleQuote(variableValue)) {
validationError += pageContentSectionLabel + ": The variable name should not have an apostrophe . <br />";
}
if(processFixedHTMLDataGetterContent.stringHasDoubleQuote(variableValue)) {
validationError += pageContentSectionLabel + ": The variable name should not have a double quote . <br />";
}
var htmlValue = pageContentSection.find("textarea[name='htmlValue']").val();
if(htmlValue == "") {
validationError += pageContentSectionLabel + ": You must supply some HTML or text. <br />";
}
return validationError;
},
replaceSingleQuote:function(inputStr) {
return inputStr.replace(/'/g, '&#39;').replace(/"/g, '&quot;');
},
//For the variable name, no single quote should be allowed
//This can be extended for other special characters
stringHasSingleQuote:function(inputStr) {
return(inputStr.indexOf("'") != -1);
},
stringHasDoubleQuote:function(inputStr) {
return(inputStr.indexOf("\"") != -1);
}

10
webapp/web/templates/freemarker/edit/forms/pageManagement.ftl
View file

@ -25,7 +25,7 @@
<#assign menuItem = lvf.getFormFieldValue(editSubmission, editConfiguration, "menuItem")/>
<#assign menuLinkText = lvf.getFormFieldValue(editSubmission, editConfiguration, "menuLinkText")/>
<#assign customTemplate = lvf.getFormFieldValue(editSubmission, editConfiguration, "customTemplate")/>
<#assign selfContainedTemplate = lvf.getFormFieldValue(editSubmission, editConfiguration, "selfContainedTemplate")/>
<#assign selfContainedTemplate = lvf.getFormFieldValue(editSubmission, editConfiguration, "isSelfContainedTemplate")/>
<#assign pageHeading = "Edit Page" />
<#if customTemplate?has_content>
<#if selfContainedTemplate?has_content>
@ -67,7 +67,7 @@
<h2>${pageHeading}</h2>
<!--Drop down for the types of content possible-->
<section id="floatRight">
<div id="rightSide">
<div id="rightSide" <#if selectedTemplateType="selfContained">style="display:none;"</#if>>
<section id="addPageOne" role="region" >
<label for="contentType">Content Type<span class="requiredHint"> *</span></label>
<select id="typeSelect" name="typeSelect" >
@ -104,7 +104,7 @@
<br /><div id="selfContainedDiv">
<input type="radio" name="selectedTemplate" class="selfContained-template" value="selfContained" <#if selectedTemplateType = "selfContained">checked="checked"</#if> role="input" />
<label class="inline" for="selfContained"> Custom template containing all content</label></div>
<section id="custom-template" <#if selectedTemplateType != 'custom'>class="hidden" </#if>role="region">
<section id="custom-template" <#if selectedTemplateType ="default">class="hidden" </#if>role="region">
<input type="text" name="customTemplate" value="${customTemplate!''}" size="33" role="input" /><span class="requiredHint"> *</span>
<input type="hidden" name="selfContainedTemplate" value="${selfContainedTemplate!''}"/>
</section>
@ -140,7 +140,9 @@
<!--For existing content, will have div to save existing content-->
<div id="existingPageContent" style="display:none">
<#if pageData.existingPageContentUnits?has_content>
<input type='hidden' id='existingPageContentUnits' value='${pageData.existingPageContentUnits}'/>
<!--Using the ?html ensures that single and double quotes are html encoded - double quotes
if left unencoded will break the html and lead to errors-->
<input type='hidden' id='existingPageContentUnits' value='${pageData.existingPageContentUnits?html}'/>
</#if>
</div>
</form>