inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-08-14 17:58:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merged HEAD-BUG-FIX (5.0/Cloud) to HEAD (5.0/Cloud)

Browse Source 
80709: Merged WAT1 (5.0/Cloud) to HEAD-BUG-FIX (5.0/Cloud)
      78667: ACE-1582: Made the facet config service and the relevant web scripts to accept single/multiple value(s) update (to support inline edits).


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@83007 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Will Abson
2014-09-03 16:41:45 +00:00
parent cde57422fc
commit ffb416a5f8
5 changed files with 255 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
config/alfresco/templates/webscripts/org/alfresco/repository/solr/facet/solr-facet-config-admin.get.json.ftl
View File

@@ -16,7 +16,7 @@
</#list>
],
</#if>
<#if facet.customProperties?size != 0>
<#if facet.customProperties?? && facet.customProperties?size != 0>
"customProperties" :
{
<#list facet.customProperties as propDetails>

88
source/java/org/alfresco/repo/web/scripts/solr/facet/AbstractSolrFacetConfigAdminWebScript.java
View File

@@ -19,9 +19,9 @@
package org.alfresco.repo.web.scripts.solr.facet;
import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
@@ -29,7 +29,6 @@ import java.util.Set;
import javax.servlet.http.HttpServletResponse;
import org.alfresco.repo.search.impl.solr.facet.SolrFacetModel;
import org.alfresco.repo.search.impl.solr.facet.SolrFacetProperties;
import org.alfresco.repo.search.impl.solr.facet.SolrFacetProperties.CustomProperties;
import org.alfresco.repo.search.impl.solr.facet.SolrFacetService;
import org.alfresco.repo.security.authentication.AuthenticationUtil;
@@ -39,7 +38,6 @@ import org.apache.commons.logging.LogFactory;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import org.json.JSONTokener;
import org.springframework.extensions.webscripts.Cache;
import org.springframework.extensions.webscripts.DeclarativeWebScript;
import org.springframework.extensions.webscripts.Status;
@@ -100,69 +98,7 @@ public abstract class AbstractSolrFacetConfigAdminWebScript extends DeclarativeW
}
}
protected SolrFacetProperties parseRequestForFacetProperties(WebScriptRequest req)
{
JSONObject json = null;
try
{
json = new JSONObject(new JSONTokener(req.getContent().getContent()));
final String filterID = json.getString(PARAM_FILTER_ID);
final String facetQNameStr = json.getString(PARAM_FACET_QNAME);
if (filterID == null || facetQNameStr == null)
{
String requiredProp = (filterID == null) ? "filterID" : "facetQName";
throw new WebScriptException(Status.STATUS_BAD_REQUEST, requiredProp + " not provided.");
}
final QName facetQName = QName.createQName(facetQNameStr);
final String displayName = json.getString(PARAM_DISPLAY_NAME);
final String displayControl = json.getString(PARAM_DISPLAY_CONTROL);
final int maxFilters = json.getInt(PARAM_MAX_FILTERS);
final int hitThreshold = json.getInt(PARAM_HIT_THRESHOLD);
final int minFilterValueLength = json.getInt(PARAM_MIN_FILTER_VALUE_LENGTH);
final String sortBy = json.getString(PARAM_SORT_BY);
final String scope = getValue(String.class, json.opt(PARAM_SCOPE), "ALL");
final boolean isEnabled = getValue(Boolean.class, json.opt(PARAM_IS_ENABLED), false);
JSONArray scopedSitesJsonArray = getValue(JSONArray.class, json.opt(PARAM_SCOPED_SITES), null);
Set<String> scopedSites = null;
if (scopedSitesJsonArray != null)
{
scopedSites = new HashSet<String>(scopedSitesJsonArray.length());
for (int i = 0, length = scopedSitesJsonArray.length(); i < length; i++)
{
String site = scopedSitesJsonArray.getString(i);
scopedSites.add(site);
}
}
final JSONObject customPropJsonObj = getValue(JSONObject.class, json.opt(PARAM_CUSTOM_PROPERTIES), null);
Set<CustomProperties> customProps = getCustomProperties(customPropJsonObj);
SolrFacetProperties fp = new SolrFacetProperties.Builder()
.filterID(filterID)
.facetQName(facetQName)
.displayName(displayName)
.displayControl(displayControl)
.maxFilters(maxFilters)
.hitThreshold(hitThreshold)
.minFilterValueLength(minFilterValueLength)
.sortBy(sortBy)
.scope(scope)
.isEnabled(isEnabled)
.scopedSites(scopedSites)
.customProperties(customProps).build();
return fp;
}
catch (IOException e)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "Could not read content from req.", e);
}
catch (JSONException e)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "Could not parse JSON from req.", e);
}
}
private <T> T getValue(Class<T> clazz, Object value, T defaultValue) throws JSONException
protected <T> T getValue(Class<T> clazz, Object value, T defaultValue) throws JSONException
{
if (JSONObject.NULL.equals(value))
{
@@ -179,7 +115,7 @@ public abstract class AbstractSolrFacetConfigAdminWebScript extends DeclarativeW
}
}
private Set<CustomProperties> getCustomProperties(JSONObject customPropsJsonObj) throws JSONException
protected Set<CustomProperties> getCustomProperties(JSONObject customPropsJsonObj) throws JSONException
{
if (customPropsJsonObj == null)
{
@@ -188,7 +124,7 @@ public abstract class AbstractSolrFacetConfigAdminWebScript extends DeclarativeW
JSONArray keys = customPropsJsonObj.names();
if (keys == null)
{
return null;
return Collections.emptySet();
}
Set<CustomProperties> customProps = new HashSet<>(keys.length());
@@ -229,6 +165,22 @@ public abstract class AbstractSolrFacetConfigAdminWebScript extends DeclarativeW
return customProps;
}
protected Set<String> getScopedSites(JSONArray scopedSitesJsonArray) throws JSONException
{
if (scopedSitesJsonArray == null)
{
return null;
}
Set<String> scopedSites = new HashSet<String>(scopedSitesJsonArray.length());
for (int i = 0, length = scopedSitesJsonArray.length(); i < length; i++)
{
String site = scopedSitesJsonArray.getString(i);
scopedSites.add(site);
}
return scopedSites;
}
private void validateMandatoryCustomProps(Object obj, String paramName) throws JSONException
{
if (obj == null)

57
source/java/org/alfresco/repo/web/scripts/solr/facet/SolrFacetConfigAdminPost.java
View File

@@ -19,12 +19,20 @@
package org.alfresco.repo.web.scripts.solr.facet;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import org.alfresco.repo.search.impl.solr.facet.SolrFacetProperties;
import org.alfresco.repo.search.impl.solr.facet.SolrFacetProperties.CustomProperties;
import org.alfresco.service.namespace.QName;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import org.json.JSONTokener;
import org.springframework.extensions.webscripts.Cache;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptException;
@@ -60,4 +68,53 @@ public class SolrFacetConfigAdminPost extends AbstractSolrFacetConfigAdminWebScr
Map<String, Object> model = new HashMap<String, Object>(1);
return model;
}
private SolrFacetProperties parseRequestForFacetProperties(WebScriptRequest req)
{
JSONObject json = null;
try
{
json = new JSONObject(new JSONTokener(req.getContent().getContent()));
final String filterID = json.getString(PARAM_FILTER_ID);
final String facetQNameStr = json.getString(PARAM_FACET_QNAME);
final QName facetQName = QName.createQName(facetQNameStr);
final String displayName = json.getString(PARAM_DISPLAY_NAME);
final String displayControl = json.getString(PARAM_DISPLAY_CONTROL);
final int maxFilters = json.getInt(PARAM_MAX_FILTERS);
final int hitThreshold = json.getInt(PARAM_HIT_THRESHOLD);
final int minFilterValueLength = json.getInt(PARAM_MIN_FILTER_VALUE_LENGTH);
final String sortBy = json.getString(PARAM_SORT_BY);
// Optional params
final String scope = getValue(String.class, json.opt(PARAM_SCOPE), "ALL");
final boolean isEnabled = getValue(Boolean.class, json.opt(PARAM_IS_ENABLED), false);
JSONArray scopedSitesJsonArray = getValue(JSONArray.class, json.opt(PARAM_SCOPED_SITES), null);
final Set<String> scopedSites = getScopedSites(scopedSitesJsonArray);
final JSONObject customPropJsonObj = getValue(JSONObject.class, json.opt(PARAM_CUSTOM_PROPERTIES), null);
final Set<CustomProperties> customProps = getCustomProperties(customPropJsonObj);
SolrFacetProperties fp = new SolrFacetProperties.Builder()
.filterID(filterID)
.facetQName(facetQName)
.displayName(displayName)
.displayControl(displayControl)
.maxFilters(maxFilters)
.hitThreshold(hitThreshold)
.minFilterValueLength(minFilterValueLength)
.sortBy(sortBy)
.scope(scope)
.isEnabled(isEnabled)
.scopedSites(scopedSites)
.customProperties(customProps).build();
return fp;
}
catch (IOException e)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "Could not read content from req.", e);
}
catch (JSONException e)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "Could not parse JSON from req.", e);
}
}
}

56
source/java/org/alfresco/repo/web/scripts/solr/facet/SolrFacetConfigAdminPut.java
View File

@@ -19,16 +19,24 @@
package org.alfresco.repo.web.scripts.solr.facet;
import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.alfresco.repo.search.impl.solr.facet.Exceptions.UnrecognisedFacetId;
import org.alfresco.repo.search.impl.solr.facet.SolrFacetProperties.CustomProperties;
import org.alfresco.repo.search.impl.solr.facet.SolrFacetProperties;
import org.alfresco.service.namespace.QName;
import org.alfresco.util.collections.CollectionUtils;
import org.alfresco.util.collections.Function;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import org.json.JSONTokener;
import org.springframework.extensions.webscripts.Cache;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptException;
@@ -119,4 +127,52 @@ public class SolrFacetConfigAdminPut extends AbstractSolrFacetConfigAdminWebScri
return model;
}
private SolrFacetProperties parseRequestForFacetProperties(WebScriptRequest req)
{
JSONObject json = null;
try
{
json = new JSONObject(new JSONTokener(req.getContent().getContent()));
final String filterID = json.getString(PARAM_FILTER_ID); // Must exist
final String facetQNameStr = getValue(String.class, json.opt(PARAM_FACET_QNAME), null);
final QName facetQName = (facetQNameStr == null) ? null : QName.createQName(facetQNameStr);
final String displayName = getValue(String.class, json.opt(PARAM_DISPLAY_NAME), null);
final String displayControl = getValue(String.class, json.opt(PARAM_DISPLAY_CONTROL), null);
final int maxFilters = getValue(Integer.class, json.opt(PARAM_MAX_FILTERS), -1);
final int hitThreshold = getValue(Integer.class, json.opt(PARAM_HIT_THRESHOLD), -1);
final int minFilterValueLength = getValue(Integer.class, json.opt(PARAM_MIN_FILTER_VALUE_LENGTH), -1);
final String sortBy = getValue(String.class, json.opt(PARAM_SORT_BY), null);
final String scope = getValue(String.class, json.opt(PARAM_SCOPE), null);
final Boolean isEnabled = getValue(Boolean.class, json.opt(PARAM_IS_ENABLED), null);
JSONArray scopedSitesJsonArray = getValue(JSONArray.class, json.opt(PARAM_SCOPED_SITES), null);
final Set<String> scopedSites = getScopedSites(scopedSitesJsonArray);
final JSONObject customPropJsonObj = getValue(JSONObject.class, json.opt(PARAM_CUSTOM_PROPERTIES), null);
final Set<CustomProperties> customProps = getCustomProperties(customPropJsonObj);
SolrFacetProperties fp = new SolrFacetProperties.Builder()
.filterID(filterID)
.facetQName(facetQName)
.displayName(displayName)
.displayControl(displayControl)
.maxFilters(maxFilters)
.hitThreshold(hitThreshold)
.minFilterValueLength(minFilterValueLength)
.sortBy(sortBy)
.scope(scope)
.isEnabled(isEnabled)
.scopedSites(scopedSites)
.customProperties(customProps).build();
return fp;
}
catch (IOException e)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "Could not read content from req.", e);
}
catch (JSONException e)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "Could not parse JSON from req.", e);
}
}
}

118
source/test-java/org/alfresco/repo/web/scripts/solr/facet/FacetRestApiTest.java
View File

@@ -474,6 +474,124 @@ public class FacetRestApiTest extends BaseWebScriptTest
}
public void testUpdateSingleValue() throws Exception
{
// Build the Filter object
final JSONObject filter = new JSONObject();
final String filterName = "filter" + System.currentTimeMillis();
filters.add(filterName);
filter.put("filterID", filterName);
filter.put("facetQName", "{http://www.alfresco.org/model/content/1.0}test");
filter.put("displayName", "facet-menu.facet.test1");
filter.put("displayControl", "alfresco/search/FacetFilters/test");
filter.put("maxFilters", 5);
filter.put("hitThreshold", 1);
filter.put("minFilterValueLength", 4);
filter.put("sortBy", "ALPHABETICALLY");
filter.put("isEnabled", true);
JSONObject customProp = new JSONObject();
// 1st custom prop
JSONObject blockIncludeRequest = new JSONObject();
blockIncludeRequest.put("name", "blockIncludeFacetRequest");
blockIncludeRequest.put("value", "true");
customProp.put("blockIncludeFacetRequest", blockIncludeRequest);
filter.put("customProperties", customProp);
AuthenticationUtil.runAs(new RunAsWork<Void>()
{
@Override
public Void doWork() throws Exception
{
// Post the filter
sendRequest(new PostRequest(POST_FACETS_URL, filter.toString(), "application/json"), 200);
return null;
}
}, SEARCH_ADMIN_USER);
// Admin updates displayName and facetQName in 2 put requests
AuthenticationUtil.runAs(new RunAsWork<Void>()
{
@Override
public Void doWork() throws Exception
{
// Retrieve the created filter
Response response = sendRequest(new GetRequest(GET_FACETS_URL + "/" + filterName), 200);
JSONObject jsonRsp = new JSONObject(new JSONTokener(response.getContentAsString()));
assertEquals(filterName, jsonRsp.getString("filterID"));
assertEquals("facet-menu.facet.test1", jsonRsp.getString("displayName"));
assertEquals("{http://www.alfresco.org/model/content/1.0}test", jsonRsp.getString("facetQName"));
assertTrue(jsonRsp.getBoolean("isEnabled"));
// Just supply the filterID and the required value
JSONObject singleValueJson = new JSONObject();
singleValueJson.put("filterID", filterName);
// Change the displayName value and update
singleValueJson.put("displayName", "facet-menu.facet.modifiedValue");
sendRequest(new PutRequest(PUT_FACETS_URL, singleValueJson.toString(), "application/json"), 200);
// Change the isEnabled value and update
// We simulate two PUT requests without refreshing the page in
// between updates
singleValueJson = new JSONObject();
singleValueJson.put("filterID", filterName);
singleValueJson.put("isEnabled", false);
sendRequest(new PutRequest(PUT_FACETS_URL, singleValueJson.toString(), "application/json"), 200);
response = sendRequest(new GetRequest(GET_FACETS_URL + "/" + filterName), 200);
jsonRsp = new JSONObject(new JSONTokener(response.getContentAsString()));
// Now see if the two changes have been persisted
assertEquals("facet-menu.facet.modifiedValue", jsonRsp.getString("displayName"));
assertFalse(jsonRsp.getBoolean("isEnabled"));
// Make sure the rest of values haven't been changed
assertEquals(filterName, jsonRsp.getString("filterID"));
assertEquals("{http://www.alfresco.org/model/content/1.0}test", jsonRsp.getString("facetQName"));
assertEquals("alfresco/search/FacetFilters/test", jsonRsp.getString("displayControl"));
assertEquals(5, jsonRsp.getInt("maxFilters"));
assertEquals(1, jsonRsp.getInt("hitThreshold"));
assertEquals(4, jsonRsp.getInt("minFilterValueLength"));
assertEquals("ALPHABETICALLY", jsonRsp.getString("sortBy"));
assertEquals("ALL", jsonRsp.getString("scope"));
assertFalse(jsonRsp.getBoolean("isDefault"));
// Make sure custom properties haven't been deleted
JSONObject retrievedCustomProp = jsonRsp.getJSONObject("customProperties");
JSONObject retrievedBlockIncludeRequest = retrievedCustomProp.getJSONObject("blockIncludeFacetRequest");
assertEquals("{http://www.alfresco.org/model/solrfacetcustomproperty/1.0}blockIncludeFacetRequest", retrievedBlockIncludeRequest.get("name"));
assertEquals("true", retrievedBlockIncludeRequest.get("value"));
// Change the facetQName value and update
singleValueJson = new JSONObject();
singleValueJson.put("filterID", filterName);
singleValueJson.put("facetQName", "{http://www.alfresco.org/model/content/1.0}testModifiedValue");
// We simulate that 'testModifiedValue' QName doesn't have custom properties
singleValueJson.put("customProperties", new JSONObject());
sendRequest(new PutRequest(PUT_FACETS_URL, singleValueJson.toString(), "application/json"), 200);
response = sendRequest(new GetRequest(GET_FACETS_URL + "/" + filterName), 200);
jsonRsp = new JSONObject(new JSONTokener(response.getContentAsString()));
// Now see if the facetQName and its side-effect have been persisted
assertEquals("{http://www.alfresco.org/model/content/1.0}testModifiedValue",jsonRsp.getString("facetQName"));
assertNull("Custom properties should have been deleted.", jsonRsp.opt("customProperties"));
// Make sure the rest of values haven't been changed
assertEquals(filterName, jsonRsp.getString("filterID"));
assertEquals("facet-menu.facet.modifiedValue", jsonRsp.getString("displayName"));
assertEquals("alfresco/search/FacetFilters/test", jsonRsp.getString("displayControl"));
assertEquals(5, jsonRsp.getInt("maxFilters"));
assertEquals(1, jsonRsp.getInt("hitThreshold"));
assertEquals(4, jsonRsp.getInt("minFilterValueLength"));
assertEquals("ALPHABETICALLY", jsonRsp.getString("sortBy"));
assertFalse(jsonRsp.getBoolean("isDefault"));
assertEquals("ALL", jsonRsp.getString("scope"));
assertFalse(jsonRsp.getBoolean("isEnabled"));
return null;
}
}, SEARCH_ADMIN_USER);
}
private List<String> getListFromJsonArray(JSONArray facetsArray) throws JSONException
{
List<String> result = new ArrayList<>();