Skip to content

Commit

Permalink
Optimization: caching group membership
Browse files Browse the repository at this point in the history 
Issue #46701

Change-Id: Iffa85320d6730b8cb491f2f26be6f68f08f514d0
  • Loading branch information
@bforest
bforest committed Mar 27, 2018
1 parent 142b8be commit 541afcf
Show file tree
Hide file tree
Showing 5 changed files with 202 additions and 47 deletions.
191 changes: 191 additions & 0 deletions module_share/src/main/java/com/atolcd/auditshare/repo/jscript/AuditShareScriptExtension.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
/*
* Copyright (C) 2018 Atol Conseils et Développements.
* http://www.atolcd.com/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package com.atolcd.auditshare.repo.jscript;

import java.util.Arrays;
import java.util.Date;
import java.util.List;

import javax.servlet.http.HttpSession;

import org.alfresco.web.extensibility.SlingshotEvaluatorUtil;
import org.alfresco.web.site.SlingshotUserFactory;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.json.simple.JSONArray;
import org.json.simple.JSONObject;
import org.json.simple.parser.JSONParser;
import org.json.simple.parser.ParseException;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.extensions.config.RemoteConfigElement;
import org.springframework.extensions.config.RemoteConfigElement.EndpointDescriptor;
import org.springframework.extensions.surf.RequestContext;
import org.springframework.extensions.surf.ServletUtil;
import org.springframework.extensions.surf.UserFactory;
import org.springframework.extensions.surf.exception.ConnectorServiceException;
import org.springframework.extensions.surf.support.AlfrescoUserFactory;
import org.springframework.extensions.surf.support.ThreadLocalRequestContext;
import org.springframework.extensions.surf.util.ISO8601DateFormat;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.connector.Connector;
import org.springframework.extensions.webscripts.connector.CredentialVault;
import org.springframework.extensions.webscripts.connector.Credentials;
import org.springframework.extensions.webscripts.connector.Response;
import org.springframework.extensions.webscripts.processor.BaseProcessorExtension;
import org.springframework.util.Assert;

public class AuditShareScriptExtension extends BaseProcessorExtension implements InitializingBean {
private static final Log logger = LogFactory.getLog(AuditShareScriptExtension.class);
public static final String AUDITSHARE_CACHE_KEY = "AlfAuditShareKey";
public static final long AUDITSHARE_CACHE_VALIDITY = 2 * 60 * 60 * 1000; // two hours
public static final String AUDITSHARE_CACHE_DATE_KEY = "date";
public static final String AUDITSHARE_CACHE_IS_MANAGER_SITE_LIST_KEY = "sites";
public static final String WEBSCRIPT_SITE_LIST_URL = "/share-stats/site/list-sites?role=SiteManager";

private SlingshotEvaluatorUtil util = null;

public void setSlingshotEvaluatorUtil(SlingshotEvaluatorUtil slingshotExtensibilityUtil) {
this.util = slingshotExtensibilityUtil;
}

@Override
public void afterPropertiesSet() throws Exception {
Assert.notNull(util);
}

public boolean isMemberOfGroups(String groupIds) {
final RequestContext rc = ThreadLocalRequestContext.getRequestContext();
if (rc != null) {
if (logger.isDebugEnabled()) {
logger.debug("Current user: " + rc.getUser().getId());
logger.debug("Groups: " + groupIds);
logger.debug("Site: " + this.util.getSite(rc));
}

List<String> groups = Arrays.asList(groupIds.split("\\s*,\\s*"));
boolean hasMembership = this.util.isMemberOfGroups(rc, groups, true);
if (logger.isDebugEnabled()) {
logger.debug("hasMembership : " + hasMembership);
}

return hasMembership;
}

return false;
}

@SuppressWarnings("unchecked")
public boolean isSiteMangerOfAtLeastOneSite() {
HttpSession session = ServletUtil.getSession();
String userName = (String) session.getAttribute(UserFactory.SESSION_ATTRIBUTE_KEY_USER_ID);

// Note that we're ONLY caching the current user information.
Object _cacheAuditShare = session.getAttribute(AUDITSHARE_CACHE_KEY);
if (_cacheAuditShare instanceof JSONObject) {
JSONObject auditShareCacheObj = (JSONObject) _cacheAuditShare;

if (logger.isDebugEnabled()) {
logger.debug("cache auditShareCacheObj : " + auditShareCacheObj.toString());
}

if (auditShareCacheObj.containsKey(AUDITSHARE_CACHE_DATE_KEY)) {
try {
long cacheDate = ISO8601DateFormat.parse((String) auditShareCacheObj.get(AUDITSHARE_CACHE_DATE_KEY)).getTime();
long currentDate = System.currentTimeMillis();
boolean useCache = (currentDate - cacheDate <= AUDITSHARE_CACHE_VALIDITY);

if (logger.isDebugEnabled()) {
logger.debug("cacheDate: " + cacheDate);
logger.debug("currentDate: " + currentDate);
logger.debug("useCache: " + useCache);
}

if (useCache) {
JSONArray sites = (JSONArray) auditShareCacheObj.get(AUDITSHARE_CACHE_IS_MANAGER_SITE_LIST_KEY);
return (sites != null && sites.size() > 0);
}
} catch (Exception e) {
logger.error("Cannot read date " + AUDITSHARE_CACHE_KEY + " for user: " + userName, e);
}
}
}

try {
final RequestContext context = ThreadLocalRequestContext.getRequestContext();
if (context != null) {
CredentialVault cv = context.getCredentialVault();
if (cv != null) {
boolean externalAuth = false;
RemoteConfigElement config = (RemoteConfigElement) context.getServiceRegistry().getConfigService().getConfig("Remote")
.getConfigElement("remote");
if (config != null) {
EndpointDescriptor descriptor = config.getEndpointDescriptor(AlfrescoUserFactory.ALFRESCO_ENDPOINT_ID);
if (descriptor != null) {
externalAuth = descriptor.getExternalAuth();
}
}

Credentials creds = cv.retrieve(AlfrescoUserFactory.ALFRESCO_ENDPOINT_ID);
// MNT-11857 - Check for external authentication
if (creds == null && !externalAuth) {
// User is not logged in anymore
return false;
}

Connector connector = context.getServiceRegistry().getConnectorService().getConnector(SlingshotUserFactory.ALFRESCO_ENDPOINT_ID,
userName, ServletUtil.getSession());

if (logger.isDebugEnabled()) {
logger.debug("calling webscript: " + WEBSCRIPT_SITE_LIST_URL);
}

Response res = connector.call(WEBSCRIPT_SITE_LIST_URL);
if (res.getStatus().getCode() == Status.STATUS_OK) {
String response = res.getResponse();
if (logger.isDebugEnabled()) {
logger.debug("webscript response: " + response);
}

Object jsonRes = new JSONParser().parse(response);
if (jsonRes instanceof JSONArray) {
JSONArray sites = (JSONArray) jsonRes;

JSONObject auditShareCacheObj = new JSONObject();
auditShareCacheObj.put(AUDITSHARE_CACHE_DATE_KEY, ISO8601DateFormat.format(new Date()));
auditShareCacheObj.put(AUDITSHARE_CACHE_IS_MANAGER_SITE_LIST_KEY, sites);

session.setAttribute(AUDITSHARE_CACHE_KEY, auditShareCacheObj);

if (logger.isDebugEnabled()) {
logger.debug("webscript auditShareCacheObj : " + auditShareCacheObj.toString());
}

return (sites != null && sites.size() > 0);
}
}
}
}
} catch (ConnectorServiceException e) {
logger.error(e.getMessage(), e);
} catch (ParseException e) {
logger.error(e.getMessage(), e);
}

return false;
}
}
17 changes: 2 additions & 15 deletions ...share/src/main/resources/site-webscripts/com/atolcd/share/header/menu/share-header.get.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

var showMenu = false;

if (user.isAdmin) {
showMenu = true;
} else {
// user needs to be SiteManger of at least one site
var json = remote.call("/share-stats/site/list-sites?role=SiteManager");
if (json.status == 200) {
var sites = JSON.parse(json);
if (sites && sites.length > 0) {
showMenu = true;
}
}
}

// User needs to be administrator or SiteManger of at least one site
var showMenu = (user.isAdmin || auditshare.isSiteMangerOfAtLeastOneSite());
if (showMenu) {
var auditShareHeaderMenu = {
id: "HEADER_AUDIT_SHARE",
Expand Down
13 changes: 1 addition & 12 deletions module_share/src/main/resources/site-webscripts/com/atolcd/share/header/share-header.get.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,7 @@
*/

if (page.url.templateArgs.site != null && page.id != "search" && page.id != "advsearch") {
// We are in the context of a site, so call the repository to see if the user is site manager or not
var userIsSiteManager = false;

var json = remote.call("/api/sites/" + page.url.templateArgs.site + "/memberships/" + encodeURIComponent(user.name));
if (json.status == 200) {
var obj = JSON.parse(json);
if (obj) {
userIsSiteManager = (obj.role == "SiteManager");
}
}

if (userIsSiteManager) {
if (auditshare.isMemberOfGroups("SiteManager")) {
// AuditShare site page
var statisticsPage = {
id: "HEADER_SITE_STATISTICS",
Expand Down
23 changes: 3 additions & 20 deletions module_share/src/main/resources/templates/com/atolcd/statistics.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,30 +117,13 @@ function checkPermissions() {
// Check permissions
if (page.url.templateArgs.site) {
// We are in the context of a site, so call the repository to see if the user is site manager or not
var json = remote.call("/api/sites/" + page.url.templateArgs.site + "/memberships/" + encodeURIComponent(user.name));
if (json.status == 200) {
var obj = JSON.parse(json);
if (obj) {
return (obj.role == "SiteManager");
}
}
return auditshare.isMemberOfGroups("SiteManager");
} else if (user.isAdmin) {
// User is an administrator
return true;
} else {
// Check if current user is site manager of a site
// http://localhost:8080/alfresco/s/api/people/admin/sites?roles=user
var json = remote.call("/api/people/" + encodeURIComponent(user.name) + "/sites?roles=user");
if (json.status == 200) {
var sites = JSON.parse(json);
if (sites && sites.length > 0) {
for (var i=0, ii=sites.length ; i<ii ; i++) {
if (sites[i].siteRole == "SiteManager") {
return true;
}
}
}
}
// Check if current user is site manager of at least one site
return auditshare.isSiteMangerOfAtLeastOneSite();
}
return false;
}
Expand Down
5 changes: 5 additions & 0 deletions module_share/src/main/resources/web-extension/auditshare-context.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,9 @@
</property>
</bean>

<!-- JavaScript API -->
<bean id="share-statistics.scriptExtension" class="com.atolcd.auditshare.repo.jscript.AuditShareScriptExtension" parent="baseScriptExtension">
<property name="extensionName" value="auditshare" />
<property name="slingshotEvaluatorUtil" ref="slingshot.evaluator.utility" />
</bean>
</beans>

0 comments on commit 541afcf

Please sign in to comment.