/* * Copyright (C) 2005-2009 Alfresco Software Limited. * * This program 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. * 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 General Public License for more details. * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * As a special exception to the terms and conditions of version 2.0 of * the GPL, you may redistribute this Program in connection with Free/Libre * and Open Source Software ("FLOSS") applications as described in Alfresco's * FLOSS exception. You should have recieved a copy of the text describing * the FLOSS exception, and it is also available here: * http://www.alfresco.com/legal/licensing" */ package org.alfresco.repo.site; import java.io.Serializable; import java.util.ArrayList; import java.util.Comparator; import java.util.HashMap; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Set; import java.util.SortedSet; import java.util.StringTokenizer; import java.util.TreeSet; import java.util.concurrent.ConcurrentHashMap; import org.alfresco.model.ContentModel; import org.alfresco.repo.activities.ActivityType; import org.alfresco.repo.search.QueryParameterDefImpl; import org.alfresco.repo.search.impl.lucene.LuceneQueryParser; import org.alfresco.repo.security.authentication.AuthenticationContext; import org.alfresco.repo.security.authentication.AuthenticationUtil; import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork; import org.alfresco.repo.tenant.TenantAdminService; import org.alfresco.repo.tenant.TenantService; import org.alfresco.repo.transaction.RetryingTransactionHelper; import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; import org.alfresco.service.cmr.activities.ActivityService; import org.alfresco.service.cmr.dictionary.DataTypeDefinition; import org.alfresco.service.cmr.dictionary.DictionaryService; import org.alfresco.service.cmr.model.FileFolderService; import org.alfresco.service.cmr.model.FileInfo; import org.alfresco.service.cmr.model.FileNotFoundException; import org.alfresco.service.cmr.repository.ChildAssociationRef; import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeService; import org.alfresco.service.cmr.repository.StoreRef; import org.alfresco.service.cmr.search.QueryParameterDefinition; import org.alfresco.service.cmr.search.ResultSet; import org.alfresco.service.cmr.search.SearchService; import org.alfresco.service.cmr.security.AccessPermission; import org.alfresco.service.cmr.security.AccessStatus; import org.alfresco.service.cmr.security.AuthorityService; import org.alfresco.service.cmr.security.AuthorityType; import org.alfresco.service.cmr.security.PermissionService; import org.alfresco.service.cmr.security.PersonService; import org.alfresco.service.cmr.site.SiteInfo; import org.alfresco.service.cmr.site.SiteService; import org.alfresco.service.cmr.site.SiteVisibility; import org.alfresco.service.cmr.tagging.TaggingService; import org.alfresco.service.namespace.NamespaceService; import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.RegexQNamePattern; import org.alfresco.util.ParameterCheck; import org.alfresco.util.PropertyCheck; import org.alfresco.util.PropertyMap; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.json.JSONException; import org.json.JSONObject; /** * Site Service Implementation. Also bootstraps the site AVM and DM stores. * * @author Roy Wetherall */ public class SiteServiceImpl implements SiteService, SiteModel { /** Logger */ private static Log logger = LogFactory.getLog(SiteServiceImpl.class); /** The DM store where site's are kept */ public static final StoreRef SITE_STORE = new StoreRef("workspace://SpacesStore"); /** Activity tool */ private static final String ACTIVITY_TOOL = "siteService"; private static final String SITE_PREFIX = "site_"; private static final String GROUP_SITE_PREFIX = PermissionService.GROUP_PREFIX + SITE_PREFIX; private static final int GROUP_SITE_PREFIX_LENGTH = GROUP_SITE_PREFIX.length(); /** Site home ref cache (Tennant aware) */ private Map siteHomeRefs = new ConcurrentHashMap(4); /** Site node ref cache (Tennant aware) */ private Map siteNodeRefs = new ConcurrentHashMap(256); private String sitesXPath; /** Messages */ private static final String MSG_UNABLE_TO_CREATE = "site_service.unable_to_create"; private static final String MSG_CAN_NOT_UPDATE = "site_service.can_not_update"; private static final String MSG_CAN_NOT_DELETE = "site_service.can_not_delete"; private static final String MSG_SITE_NO_EXIST = "site_service.site_no_exist"; private static final String MSG_DO_NOT_REMOVE_MGR = "site_service.do_not_remove_manager"; private static final String MSG_CAN_NOT_REMOVE_MSHIP = "site_service.can_not_reomve_memebership"; private static final String MSG_DO_NOT_CHANGE_MGR = "site_service.do_not_change_manager"; private static final String MSG_CAN_NOT_CHANGE_MSHIP="site_service.can_not_change_memebership"; private static final String MSG_SITE_CONTAINER_NOT_FOLDER = "site_service.site_container_not_folder"; /* Services */ private NodeService nodeService; private FileFolderService fileFolderService; private SearchService searchService; private NamespaceService namespaceService; private PermissionService permissionService; private ActivityService activityService; private PersonService personService; private AuthenticationContext authenticationContext; private TaggingService taggingService; private AuthorityService authorityService; private DictionaryService dictionaryService; private TenantService tenantService; private TenantAdminService tenantAdminService; private RetryingTransactionHelper retryingTransactionHelper; private Comparator roleComparator ; /** * Set the path to the location of the sites root folder. For example: * 
     * ./app:company_home/st:sites
     *
* @param sitesXPath a valid XPath */ public void setSitesXPath(String sitesXPath) { this.sitesXPath = sitesXPath; } /** * Set node service */ public void setNodeService(NodeService nodeService) { this.nodeService = nodeService; } /** * Set file folder service */ public void setFileFolderService(FileFolderService fileFolderService) { this.fileFolderService = fileFolderService; } /** * Set search service */ public void setSearchService(SearchService searchService) { this.searchService = searchService; } /** * Set Namespace service */ public void setNamespaceService(NamespaceService namespaceService) { this.namespaceService = namespaceService; } /** * Set permission service */ public void setPermissionService(PermissionService permissionService) { this.permissionService = permissionService; } /** * Set activity service */ public void setActivityService(ActivityService activityService) { this.activityService = activityService; } /** * Set person service */ public void setPersonService(PersonService personService) { this.personService = personService; } /** * Set authentication component */ public void setAuthenticationContext( AuthenticationContext authenticationContext) { this.authenticationContext = authenticationContext; } /** * Set the tagging service */ public void setTaggingService(TaggingService taggingService) { this.taggingService = taggingService; } /** * Set the authority service */ public void setAuthorityService(AuthorityService authorityService) { this.authorityService = authorityService; } /** * Set the dictionary service * * @param dictionaryService dictionary service */ public void setDictionaryService(DictionaryService dictionaryService) { this.dictionaryService = dictionaryService; } /** * Set the tenant service * * @param tenantService tenant service */ public void setTenantService(TenantService tenantService) { this.tenantService = tenantService; } /** * Sets the tenant admin service */ public void setTenantAdminService(TenantAdminService tenantAdminService) { this.tenantAdminService = tenantAdminService; } /** * Sets helper that provides transaction callbacks */ public void setTransactionHelper(RetryingTransactionHelper retryingTransactionHelper) { this.retryingTransactionHelper = retryingTransactionHelper; } /** * Checks that all necessary properties and services have been provided. */ public void init() { PropertyCheck.mandatory(this, "nodeService", nodeService); PropertyCheck.mandatory(this, "fileFolderService", fileFolderService); PropertyCheck.mandatory(this, "searchService", searchService); PropertyCheck.mandatory(this, "namespaceService", namespaceService); PropertyCheck.mandatory(this, "permissionService", permissionService); PropertyCheck.mandatory(this, "authenticationContext", authenticationContext); PropertyCheck.mandatory(this, "personService", personService); PropertyCheck.mandatory(this, "activityService", activityService); PropertyCheck.mandatory(this, "taggingService", taggingService); PropertyCheck.mandatory(this, "authorityService", authorityService); PropertyCheck.mandatory(this, "sitesXPath", sitesXPath); } /** * @see org.alfresco.service.cmr.site.SiteService#createSite(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean) */ public SiteInfo createSite( final String sitePreset, String passedShortName, final String title, final String description, final boolean isPublic) { // Determine the site visibility SiteVisibility visibility = SiteVisibility.PRIVATE; if (isPublic == true) { visibility = SiteVisibility.PUBLIC; } // Create the site return createSite(sitePreset, passedShortName, title, description, visibility); } /** * @see org.alfresco.service.cmr.site.SiteService#createSite(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean) */ public SiteInfo createSite(final String sitePreset, String passedShortName, final String title, final String description, final SiteVisibility visibility) { // Remove spaces from shortName final String shortName = passedShortName.replaceAll(" ", ""); // Check to see if we already have a site of this name NodeRef existingSite = getSiteNodeRef(shortName); if (existingSite != null) { // Throw an exception since we have a duplicate site name throw new SiteServiceException(MSG_UNABLE_TO_CREATE, new Object[]{shortName}); } // Get the site parent node reference NodeRef siteParent = getSiteParent(shortName); // Create the site node PropertyMap properties = new PropertyMap(4); properties.put(ContentModel.PROP_NAME, shortName); properties.put(SiteModel.PROP_SITE_PRESET, sitePreset); properties.put(SiteModel.PROP_SITE_VISIBILITY, visibility.toString()); properties.put(ContentModel.PROP_TITLE, title); properties.put(ContentModel.PROP_DESCRIPTION, description); final NodeRef siteNodeRef = this.nodeService.createNode( siteParent, ContentModel.ASSOC_CONTAINS, QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, shortName), SiteModel.TYPE_SITE, properties) .getChildRef(); // Make the new site a tag scope this.taggingService.addTagScope(siteNodeRef); // Clear the sites inherited permissions this.permissionService.setInheritParentPermissions(siteNodeRef, false); // Get the current user final String currentUser = authenticationContext.getCurrentUserName(); // Create the relevant groups and assign permissions AuthenticationUtil.runAs(new AuthenticationUtil.RunAsWork() { public String doWork() throws Exception { // Create the site's groups String siteGroup = authorityService.createAuthority( AuthorityType.GROUP, null, getSiteGroup(shortName, false)); Set permissions = permissionService.getSettablePermissions(SiteModel.TYPE_SITE); for (String permission : permissions) { // Create a group for the permission String permissionGroup = authorityService.createAuthority( AuthorityType.GROUP, siteGroup, getSiteRoleGroup( shortName, permission, false)); // Assign the group the relevant permission on the site permissionService.setPermission(siteNodeRef, permissionGroup, permission, true); } // Set the memberships details // - give all authorities site consumer if site is public // - give all authorities read properties if site is moderated // - give all authorities read permission on permissions so // memberships can be calculated // - add the current user to the site manager group if (SiteVisibility.PUBLIC.equals(visibility) == true) { permissionService.setPermission(siteNodeRef, PermissionService.ALL_AUTHORITIES, SITE_CONSUMER, true); } else if (SiteVisibility.MODERATED.equals(visibility) == true) { permissionService.setPermission(siteNodeRef, PermissionService.ALL_AUTHORITIES, PermissionService.READ_PROPERTIES, true); } permissionService.setPermission(siteNodeRef, PermissionService.ALL_AUTHORITIES, PermissionService.READ_PERMISSIONS, true); authorityService.addAuthority(getSiteRoleGroup(shortName, SiteModel.SITE_MANAGER, true), currentUser); // Return nothing return null; } }, AuthenticationUtil.getSystemUserName()); // Return created site information Map customProperties = getSiteCustomProperties(siteNodeRef); SiteInfo siteInfo = new SiteInfoImpl(sitePreset, shortName, title, description, visibility, customProperties, siteNodeRef); return siteInfo; } /** * Gets a map containing the site's custom properties * * @return Map map containing the custom properties of the site */ private Map getSiteCustomProperties(Map properties) { Map customProperties = new HashMap(4); for (Map.Entry entry : properties.entrySet()) { if (entry.getKey().getNamespaceURI().equals(SITE_CUSTOM_PROPERTY_URL) == true) { customProperties.put(entry.getKey(), entry.getValue()); } } return customProperties; } /** * Gets a map containing the site's custom properties * * @return Map map containing the custom properties of the site */ private Map getSiteCustomProperties(NodeRef siteNodeRef) { Map customProperties = new HashMap(4); Map properties = nodeService.getProperties(siteNodeRef); for (Map.Entry entry : properties.entrySet()) { if (entry.getKey().getNamespaceURI().equals(SITE_CUSTOM_PROPERTY_URL) == true) { customProperties.put(entry.getKey(), entry.getValue()); } } return customProperties; } /** * @see org.alfresco.service.cmr.site.SiteService#getSiteGroup(java.lang.String) */ public String getSiteGroup(String shortName) { return getSiteGroup(shortName, true); } /** * @see org.alfresco.service.cmr.site.SiteService#getSiteRoleGroup(java.lang.String, * java.lang.String) */ public String getSiteRoleGroup(String shortName, String role) { return getSiteRoleGroup(shortName, role, true); } /** * Helper method to get the name of the site group * * @param shortName site short name * @return String site group name */ public String getSiteGroup(String shortName, boolean withGroupPrefix) { StringBuffer sb = new StringBuffer(64); if (withGroupPrefix == true) { sb.append(PermissionService.GROUP_PREFIX); } sb.append(SITE_PREFIX); sb.append(shortName); return sb.toString(); } /** * Helper method to get the name of the site permission group * * @param shortName site short name * @param permission permission name * @return String site permission group name */ public String getSiteRoleGroup(String shortName, String permission, boolean withGroupPrefix) { return getSiteGroup(shortName, withGroupPrefix) + '_' + permission; } /** * Gets a sites parent folder based on it's short name ] * * @param shortName site short name * @return NodeRef the site's parent */ private NodeRef getSiteParent(String shortName) { // TODO: For now just return the site root, later we may build folder // structure based on the shortname to spread the sites about return getSiteRoot(); } /** * Get the node reference that is the site root * * @return NodeRef node reference */ private NodeRef getSiteRoot() { String tenantDomain = tenantAdminService.getCurrentUserDomain(); NodeRef siteHomeRef = siteHomeRefs.get(tenantDomain); if (siteHomeRef == null) { siteHomeRef = AuthenticationUtil.runAs(new RunAsWork() { public NodeRef doWork() throws Exception { return retryingTransactionHelper.doInTransaction(new RetryingTransactionCallback() { public NodeRef execute() throws Exception { // Get the root 'sites' folder NodeRef rootNodeRef = nodeService.getRootNode(SITE_STORE); List results = searchService.selectNodes( rootNodeRef, sitesXPath, null, namespaceService, false, SearchService.LANGUAGE_XPATH); if (results.size() == 0) { // No root site folder exists throw new SiteServiceException("No root sites folder exists"); } else if (results.size() != 1) { // More than one root site folder exits logger.warn("More than one root sites folder exists: \n" + results); } return results.get(0); } }); } }, AuthenticationUtil.getSystemUserName()); siteHomeRefs.put(tenantDomain, siteHomeRef); } return siteHomeRef; } /** * @see org.alfresco.service.cmr.site.SiteService#listSites(java.lang.String, java.lang.String) */ public List listSites(String nameFilter, String sitePresetFilter) { return listSites(nameFilter, sitePresetFilter, 0); } /** * @see org.alfresco.service.cmr.site.SiteService#listSites(java.lang.String, java.lang.String, int) */ public List listSites(String nameFilter, String sitePresetFilter, int size) { List result; // TODO: take into consideration the sitePresetFilter NodeRef siteRoot = getSiteRoot(); if (nameFilter != null && nameFilter.length() != 0) { String escNameFilter = LuceneQueryParser.escape(nameFilter.replace('"', ' ')); // Perform a Lucene search under the Site parent node using *name*, title and description search query QueryParameterDefinition[] params = new QueryParameterDefinition[3]; params[0] = new QueryParameterDefImpl( ContentModel.PROP_NAME, dictionaryService.getDataType( DataTypeDefinition.TEXT), true, escNameFilter); params[1] = new QueryParameterDefImpl( ContentModel.PROP_TITLE, dictionaryService.getDataType( DataTypeDefinition.TEXT), true, escNameFilter); params[2] = new QueryParameterDefImpl( ContentModel.PROP_DESCRIPTION, dictionaryService.getDataType( DataTypeDefinition.TEXT), true, escNameFilter); // get the sites that match the specified names StringBuilder query = new StringBuilder(128); query.append("+PARENT:\"").append(siteRoot.toString()) .append("\" +(@cm\\:name:\"*${cm:name}*\"") .append(" @cm\\:title:\"${cm:title}\"") .append(" @cm\\:description:\"${cm:description}\")"); ResultSet results = this.searchService.query( siteRoot.getStoreRef(), SearchService.LANGUAGE_LUCENE, query.toString(), params); result = new ArrayList(results.length()); try { for (NodeRef site : results.getNodeRefs()) { // Ignore any node type that is not a "site" QName siteClassName = this.nodeService.getType(site); if (this.dictionaryService.isSubClass(siteClassName, SiteModel.TYPE_SITE) == true) { result.add(createSiteInfo(site)); // break on max size limit reached if (result.size() == size) break; } } } finally { results.close(); } } else { // Get ALL sites - this may be a very slow operation if there are many sites... List assocs = this.nodeService.getChildAssocs( siteRoot, ContentModel.ASSOC_CONTAINS, RegexQNamePattern.MATCH_ALL); result = new ArrayList(assocs.size()); for (ChildAssociationRef assoc : assocs) { // Ignore any node type that is not a "site" NodeRef site = assoc.getChildRef(); QName siteClassName = this.nodeService.getType(site); if (this.dictionaryService.isSubClass(siteClassName, SiteModel.TYPE_SITE) == true) { result.add(createSiteInfo(site)); // break on max size limit reached if (result.size() == size) break; } } } return result; } /** * @see org.alfresco.service.cmr.site.SiteService#listSites(java.lang.String) */ public List listSites(String userName) { // get the Groups this user is contained within (at any level) Set groups = this.authorityService.getContainingAuthorities(null, userName, false); Set siteNames = new HashSet(groups.size()); // purge non Site related Groups and strip the group name down to the site "shortName" it relates too for (String group : groups) { if (group.startsWith(GROUP_SITE_PREFIX)) { int roleIndex = group.lastIndexOf('_'); String siteName; if (roleIndex + 1 <= GROUP_SITE_PREFIX_LENGTH) { // There is no role associated siteName = group.substring(GROUP_SITE_PREFIX_LENGTH); } else { siteName = group.substring(GROUP_SITE_PREFIX_LENGTH, roleIndex); } siteNames.add(siteName); } } // retrieve the site nodes based on the list from the containing site groups NodeRef siteRoot = getSiteRoot(); List siteList = new ArrayList(siteNames); // ensure we do not trip over the getChildrenByName() 1000 item API limit! if (siteList.size() > 1000) { siteList = siteList.subList(0, 1000); } List assocs = this.nodeService.getChildrenByName( siteRoot, ContentModel.ASSOC_CONTAINS, siteList); List result = new ArrayList(assocs.size()); for (ChildAssociationRef assoc : assocs) { // Ignore any node that is not a "site" type NodeRef site = assoc.getChildRef(); QName siteClassName = this.nodeService.getType(site); if (this.dictionaryService.isSubClass(siteClassName, SiteModel.TYPE_SITE)) { result.add(createSiteInfo(site)); } } return result; } /** * Creates a site information object given a site node reference * * @param siteNodeRef * site node reference * @return SiteInfo site information object */ private SiteInfo createSiteInfo(NodeRef siteNodeRef) { // Get the properties Map properties = this.nodeService.getProperties(siteNodeRef); String shortName = (String) properties.get(ContentModel.PROP_NAME); String sitePreset = (String) properties.get(PROP_SITE_PRESET); String title = (String) properties.get(ContentModel.PROP_TITLE); String description = (String) properties.get(ContentModel.PROP_DESCRIPTION); // Get the visibility of the site SiteVisibility visibility = getSiteVisibility(siteNodeRef); // Create and return the site information Map customProperties = getSiteCustomProperties(properties); SiteInfo siteInfo = new SiteInfoImpl(sitePreset, shortName, title, description, visibility, customProperties, siteNodeRef); return siteInfo; } /** * Helper method to get the visibility of the site. If no value is present in the repository then it is calculated from the * set permissions. This will maintain backwards compatibility with earlier versions of the service implementation. * * @param siteNodeRef site node reference * @return SiteVisibility site visibility */ private SiteVisibility getSiteVisibility(NodeRef siteNodeRef) { SiteVisibility visibility = SiteVisibility.PRIVATE; // Get the visibility value stored in the repo String visibilityValue = (String)this.nodeService.getProperty(siteNodeRef, SiteModel.PROP_SITE_VISIBILITY); // To maintain backwards compatibility calculate the visibility from the permissions // if there is no value specified on the site node if (visibilityValue == null) { // Examine each permission to see if this is a public site or not Set permissions = this.permissionService.getAllSetPermissions(siteNodeRef); for (AccessPermission permission : permissions) { if (permission.getAuthority().equals(PermissionService.ALL_AUTHORITIES) == true && permission.getPermission().equals(SITE_CONSUMER) == true) { visibility = SiteVisibility.PUBLIC; break; } } } else { // Create the enum value from the string visibility = SiteVisibility.valueOf(visibilityValue); } return visibility; } /** * @see org.alfresco.service.cmr.site.SiteService#getSite(java.lang.String) */ public SiteInfo getSite(final String shortName) { // MT share - for activity service system callback if (tenantService.isEnabled() && (AuthenticationUtil.SYSTEM_USER_NAME.equals(AuthenticationUtil.getRunAsUser())) && tenantService.isTenantName(shortName)) { final String tenantDomain = tenantService.getDomain(shortName); final String sName = tenantService.getBaseName(shortName, true); return AuthenticationUtil.runAs(new AuthenticationUtil.RunAsWork() { public SiteInfo doWork() throws Exception { SiteInfo site = getSiteImpl(sName); return new SiteInfoImpl(site.getSitePreset(), shortName, site.getTitle(), site.getDescription(), site.getVisibility(), site.getCustomProperties(), site.getNodeRef()); } }, tenantService.getDomainUser(AuthenticationUtil.getSystemUserName(), tenantDomain)); } else { return getSiteImpl(shortName); } } private SiteInfo getSiteImpl(String shortName) { SiteInfo result = null; // Get the site node NodeRef siteNodeRef = getSiteNodeRef(shortName); if (siteNodeRef != null) { // Create the site info result = createSiteInfo(siteNodeRef); } // Return the site information return result; } /** * Gets the site's node reference based on its short name * * @param shortName short name * * @return NodeRef node reference */ private NodeRef getSiteNodeRef(String shortName) { final String cacheKey = this.tenantAdminService.getCurrentUserDomain() + '_' + shortName; NodeRef siteNodeRef = this.siteNodeRefs.get(cacheKey); if (siteNodeRef != null) { // test for existance - and remove from cache if no longer exists if (!this.nodeService.exists(siteNodeRef)) { this.siteNodeRefs.remove(cacheKey); siteNodeRef = null; } } else { // not in cache - find and store NodeRef siteRoot = getSiteParent(shortName); // the site "short name" directly maps to the cm:name property siteNodeRef = this.nodeService.getChildByName(siteRoot, ContentModel.ASSOC_CONTAINS, shortName); // cache the result if found - null results will be requeried to ensure new sites are found later if (siteNodeRef != null) { this.siteNodeRefs.put(cacheKey, siteNodeRef); } } return siteNodeRef; } /** * @see org.alfresco.service.cmr.site.SiteService#updateSite(org.alfresco.service.cmr.site.SiteInfo) */ public void updateSite(SiteInfo siteInfo) { NodeRef siteNodeRef = getSiteNodeRef(siteInfo.getShortName()); if (siteNodeRef == null) { throw new SiteServiceException(MSG_CAN_NOT_UPDATE, new Object[]{siteInfo.getShortName()}); } // Get the sites properties Map properties = this.nodeService.getProperties(siteNodeRef); // Update the properties of the site // Note: the site preset and short name should never be updated! properties.put(ContentModel.PROP_TITLE, siteInfo.getTitle()); properties.put(ContentModel.PROP_DESCRIPTION, siteInfo.getDescription()); // Update the isPublic flag SiteVisibility currentVisibility = getSiteVisibility(siteNodeRef); SiteVisibility updatedVisibility = siteInfo.getVisibility(); if (currentVisibility.equals(updatedVisibility) == false) { // Remove current visibility permissions if (SiteVisibility.PUBLIC.equals(currentVisibility) == true) { this.permissionService.deletePermission(siteNodeRef, PermissionService.ALL_AUTHORITIES, SITE_CONSUMER); } else if (SiteVisibility.MODERATED.equals(currentVisibility) == true) { this.permissionService.deletePermission(siteNodeRef, PermissionService.ALL_AUTHORITIES, PermissionService.READ_PROPERTIES); // TODO update all child folders ?? ... } // Add new visibility permissions if (SiteVisibility.PUBLIC.equals(updatedVisibility) == true) { this.permissionService.setPermission(siteNodeRef, PermissionService.ALL_AUTHORITIES, SITE_CONSUMER, true); } else if (SiteVisibility.MODERATED.equals(updatedVisibility) == true) { this.permissionService.setPermission(siteNodeRef, PermissionService.ALL_AUTHORITIES, PermissionService.READ_PROPERTIES, true); // TODO update all child folders ?? ... } // Update the site node reference with the updated visibility value properties.put(SiteModel.PROP_SITE_VISIBILITY, siteInfo.getVisibility()); } // Set the updated properties back onto the site node reference this.nodeService.setProperties(siteNodeRef, properties); } /** * @see org.alfresco.service.cmr.site.SiteService#deleteSite(java.lang.String) */ public void deleteSite(final String shortName) { NodeRef siteNodeRef = getSiteNodeRef(shortName); if (siteNodeRef == null) { throw new SiteServiceException(MSG_CAN_NOT_DELETE, new Object[]{shortName}); } // Delete the cached reference String cacheKey = this.tenantAdminService.getCurrentUserDomain() + '_' + shortName; this.siteNodeRefs.remove(cacheKey); // Delete the node this.nodeService.deleteNode(siteNodeRef); // Delete the associated group's AuthenticationUtil.runAs(new AuthenticationUtil.RunAsWork() { public Object doWork() throws Exception { authorityService.deleteAuthority(getSiteGroup(shortName, true)); return null; } }, AuthenticationUtil.getSystemUserName()); } /** * @see org.alfresco.service.cmr.site.SiteService#listMembers(java.lang.String, java.lang.String, java.lang.String, int) */ public Map listMembers(String shortName, String nameFilter, String roleFilter, int size) { return listMembers(shortName, nameFilter, roleFilter, size, false); } /** * @see org.alfresco.service.cmr.site.SiteService#listMembers(String, String, String, int, boolean) */ public Map listMembers(String shortName, final String nameFilter, final String roleFilter, final int size, final boolean collapseGroups) { // MT share - for activity service system callback if (tenantService.isEnabled() && (AuthenticationUtil.SYSTEM_USER_NAME.equals(AuthenticationUtil.getRunAsUser())) && tenantService.isTenantName(shortName)) { final String tenantDomain = tenantService.getDomain(shortName); final String sName = tenantService.getBaseName(shortName, true); return AuthenticationUtil.runAs(new AuthenticationUtil.RunAsWork>() { public Map doWork() throws Exception { return listMembersImpl(sName, nameFilter, roleFilter, size, collapseGroups); } }, tenantService.getDomainUser(AuthenticationUtil.getSystemUserName(), tenantDomain)); } else { return listMembersImpl(shortName, nameFilter, roleFilter, size, collapseGroups); } } private Map listMembersImpl(String shortName, String nameFilter, String roleFilter, int size, boolean collapseGroups) { NodeRef siteNodeRef = getSiteNodeRef(shortName); if (siteNodeRef == null) { throw new SiteServiceException(MSG_SITE_NO_EXIST, new Object[]{shortName}); } // build an array of name filter tokens pre lowercased to test against person properties String[] nameFilters = new String[0]; if (nameFilter != null && nameFilter.length() != 0) { StringTokenizer t = new StringTokenizer(nameFilter, " "); nameFilters = new String[t.countTokens()]; for (int i=0; t.hasMoreTokens(); i++) { nameFilters[i] = t.nextToken().toLowerCase(); } } Map members = new HashMap(32); Set permissions = this.permissionService.getSettablePermissions(SiteModel.TYPE_SITE); for (String permission : permissions) { if (roleFilter == null || roleFilter.length() == 0 || roleFilter.equals(permission)) { String groupName = getSiteRoleGroup(shortName, permission, true); Set users = this.authorityService.getContainedAuthorities(AuthorityType.USER, groupName, true); for (String user : users) { boolean addUser = true; if (nameFilter != null && nameFilter.length() != 0 && !nameFilter.equals(user)) { // found a filter - does it match person first/last name? addUser = matchPerson(nameFilters, user); } if (addUser) { // Add the user and their permission to the returned map members.put(user, permission); // break on max size limit reached if (members.size() == size) break; } } Set groups = this.authorityService.getContainedAuthorities(AuthorityType.GROUP, groupName, true); for (String group : groups) { if (collapseGroups == false) { if (nameFilter != null && nameFilter.length() != 0) { // found a filter - does it match Group name part? if (group.substring(GROUP_SITE_PREFIX_LENGTH).toLowerCase().contains(nameFilter.toLowerCase())) { members.put(group, permission); } } else { // No name filter add this group members.put(group, permission); } } else { Set subUsers = this.authorityService.getContainedAuthorities(AuthorityType.USER, group, false); for (String subUser : subUsers) { boolean addUser = true; if (nameFilter != null && nameFilter.length() != 0 && !nameFilter.equals(subUser)) { // found a filter - does it match person first/last name? addUser = matchPerson(nameFilters, subUser); } if (addUser) { // Add the collapsed user into the members list if they do not already appear in the list if (members.containsKey(subUser) == false) { members.put(subUser, permission); } // break on max size limit reached if (members.size() == size) break; } } } } } } return members; } /** * Helper to match name filters to Person properties * * @param filter * @param username * @return */ private boolean matchPerson(final String[] nameFilters, final String username) { boolean addUser = false; NodeRef personRef = this.personService.getPerson(username); Map props = this.nodeService.getProperties(personRef); String firstName = (String)props.get(ContentModel.PROP_FIRSTNAME); String lastName = (String)props.get(ContentModel.PROP_LASTNAME); final String lowFirstName = (firstName != null ? firstName.toLowerCase() : ""); final String lowLastName = (lastName != null ? lastName.toLowerCase() : ""); for (int i=0; i roles = getMembersRoles(shortName, authorityName); if (roles.isEmpty() == false) { if(roleComparator != null) { // Need to sort the roles into the most important first. SortedSet sortedRoles = new TreeSet(roleComparator); for (String role : roles) { sortedRoles.add(role); } result = sortedRoles.first(); } else { // don't search on precedence result = roles.get(0); } } return result; } public List getMembersRoles(String shortName, String authorityName) { List result = new ArrayList(5); List groups = getPermissionGroups(shortName, authorityName); for (String group : groups) { int index = group.lastIndexOf('_'); if (index != -1) { result.add(group.substring(index + 1)); } } return result; } /** * Helper method to get the permission groups for a given authority on a site. * Returns empty List if the user does not have a explicit membership to the site. * * A user permission will take precedence over a permission obtained via a group. * * @param siteShortName site short name * @param authorityName authority name * @return List Permission groups, empty list if no explicit membership set */ private List getPermissionGroups(String siteShortName, String authorityName) { List result = new ArrayList(5); Set roles = this.permissionService.getSettablePermissions(SiteModel.TYPE_SITE); for (String role : roles) { String roleGroup = getSiteRoleGroup(siteShortName, role, true); Set authorities = this.authorityService.getContainedAuthorities(AuthorityType.USER, roleGroup, true); if (authorities.contains(authorityName) == true) { result.add(roleGroup); } } // If there are user permissions then they take priority if(result.size() > 0) { return result; } // Now do a deep search through all users and groups for (String role : roles) { String roleGroup = getSiteRoleGroup(siteShortName, role, true); Set authorities = this.authorityService.getContainedAuthorities(null, roleGroup, false); if (authorities.contains(authorityName) == true) { result.add(roleGroup); } } return result; } /** * @see org.alfresco.service.cmr.site.SiteService#getSiteRoles() */ public List getSiteRoles() { Set permissions = permissionService .getSettablePermissions(SiteModel.TYPE_SITE); return new ArrayList(permissions); } /** * @see org.alfresco.service.cmr.site.SiteService#isMember(java.lang.String, java.lang.String) */ public boolean isMember(String shortName, String authorityName) { return (!getPermissionGroups(shortName, authorityName).isEmpty()); } /** * @see org.alfresco.service.cmr.site.SiteService#removeMembership(java.lang.String, java.lang.String) */ public void removeMembership(final String shortName, final String authorityName) { final NodeRef siteNodeRef = getSiteNodeRef(shortName); if (siteNodeRef == null) { throw new SiteServiceException(MSG_SITE_NO_EXIST, new Object[]{shortName}); } // TODO what do we do about the user if they are in a group that has // rights to the site? // Get the current user String currentUserName = AuthenticationUtil.getFullyAuthenticatedUser(); // Get the user current role final String role = getMembersRole(shortName, authorityName); if (role != null) { // Check that we are not about to remove the last site manager if (SiteModel.SITE_MANAGER.equals(role) == true) { Set siteMangers = this.authorityService .getContainedAuthorities( AuthorityType.USER, getSiteRoleGroup(shortName, SITE_MANAGER, true), true); if (siteMangers.size() == 1) { throw new SiteServiceException(MSG_DO_NOT_REMOVE_MGR, new Object[]{authorityName}); } } // If ... // -- the current user has change permissions rights on the site // or // -- the user is ourselves if ((currentUserName.equals(authorityName) == true) || (permissionService.hasPermission(siteNodeRef, PermissionService.CHANGE_PERMISSIONS) == AccessStatus.ALLOWED)) { // Run as system user AuthenticationUtil.runAs( new AuthenticationUtil.RunAsWork() { public Object doWork() throws Exception { // Remove the user from the current permission // group String currentGroup = getSiteRoleGroup(shortName, role, true); authorityService.removeAuthority(currentGroup, authorityName); return null; } }, AuthenticationUtil.SYSTEM_USER_NAME); // Raise events if (AuthorityType.getAuthorityType(authorityName) == AuthorityType.USER) { activityService.postActivity( ActivityType.SITE_USER_REMOVED, shortName, ACTIVITY_TOOL, getActivityData(authorityName, "")); } else { // TODO - update this, if sites support groups logger.error("setMembership - failed to post activity: unexpected authority type: " + AuthorityType.getAuthorityType(authorityName)); } } else { // Throw an exception throw new SiteServiceException(MSG_CAN_NOT_REMOVE_MSHIP, new Object[]{shortName}); } } else { // Throw an exception throw new SiteServiceException(MSG_CAN_NOT_REMOVE_MSHIP, new Object[]{shortName}); } } /** * @see org.alfresco.service.cmr.site.SiteService#setMembership(java.lang.String, * java.lang.String, java.lang.String) */ public void setMembership(final String shortName, final String authorityName, final String role) { final NodeRef siteNodeRef = getSiteNodeRef(shortName); if (siteNodeRef == null) { throw new SiteServiceException(MSG_SITE_NO_EXIST, new Object[]{shortName}); } // Get the user's current role final String currentRole = getMembersRole(shortName, authorityName); // Do nothing if the role of the user is not being changed if (currentRole == null || role.equals(currentRole) == false) { // TODO if this is the only site manager do not down grade their // permissions // Get the visibility of the site SiteVisibility visibility = getSiteVisibility(siteNodeRef); // If we are ... // -- the current user has change permissions rights on the site // or we are ... // -- referring to a public site and // -- the role being set is consumer and // -- the user being added is ourselves and // -- the member does not already have permissions // ... then we can set the permissions as system user final String currentUserName = AuthenticationUtil.getFullyAuthenticatedUser(); if ((permissionService.hasPermission(siteNodeRef, PermissionService.CHANGE_PERMISSIONS) == AccessStatus.ALLOWED) || (SiteVisibility.PUBLIC.equals(visibility) == true && role.equals(SiteModel.SITE_CONSUMER) == true && authorityName.equals(currentUserName) == true && currentRole == null)) { // Check that we are not about to remove the last site manager if (SiteModel.SITE_MANAGER.equals(currentRole) == true) { Set siteMangers = this.authorityService.getContainedAuthorities(AuthorityType.USER, getSiteRoleGroup(shortName, SITE_MANAGER, true), true); if (siteMangers.size() == 1) { throw new SiteServiceException(MSG_DO_NOT_CHANGE_MGR, new Object[]{authorityName}); } } // Run as system user AuthenticationUtil.runAs(new AuthenticationUtil.RunAsWork() { public Object doWork() throws Exception { if (currentRole != null) { // Remove the user from the current // permission group String currentGroup = getSiteRoleGroup(shortName, currentRole, true); authorityService.removeAuthority(currentGroup, authorityName); } // Add the user to the new permission group String newGroup = getSiteRoleGroup(shortName, role, true); authorityService.addAuthority(newGroup, authorityName); return null; } }, AuthenticationUtil.SYSTEM_USER_NAME); if (currentRole == null) { if (AuthorityType.getAuthorityType(authorityName) == AuthorityType.USER) { activityService.postActivity( ActivityType.SITE_USER_JOINED, shortName, ACTIVITY_TOOL, getActivityData(authorityName, role)); } else { // TODO - update this, if sites support groups logger .error("setMembership - failed to post activity: unexpected authority type: " + AuthorityType.getAuthorityType(authorityName)); } } else { if (AuthorityType.getAuthorityType(authorityName) == AuthorityType.USER) { activityService.postActivity( ActivityType.SITE_USER_ROLE_UPDATE, shortName, ACTIVITY_TOOL, getActivityData(authorityName, role)); } else { // TODO - update this, if sites support groups logger.error("setMembership - failed to post activity: unexpected authority type: " + AuthorityType.getAuthorityType(authorityName)); } } } else { // Raise a permission exception throw new SiteServiceException(MSG_CAN_NOT_CHANGE_MSHIP, new Object[]{shortName}); } } } /** * @see org.alfresco.service.cmr.site.SiteService#createContainer(java.lang.String, * java.lang.String, org.alfresco.service.namespace.QName, * java.util.Map) */ public NodeRef createContainer(String shortName, String componentId, QName containerType, Map containerProperties) { // Check for the component id ParameterCheck.mandatoryString("componentId", componentId); // retrieve site NodeRef siteNodeRef = getSiteNodeRef(shortName); if (siteNodeRef == null) { throw new SiteServiceException(MSG_SITE_NO_EXIST, new Object[]{shortName}); } // retrieve component folder within site NodeRef containerNodeRef = null; try { containerNodeRef = findContainer(siteNodeRef, componentId); } catch (FileNotFoundException e) { } // create the container node reference if (containerNodeRef == null) { if (containerType == null) { containerType = ContentModel.TYPE_FOLDER; } // create component folder FileInfo fileInfo = fileFolderService.create(siteNodeRef, componentId, containerType); // Get the created container containerNodeRef = fileInfo.getNodeRef(); // Set the properties if they have been provided if (containerProperties != null) { Map props = this.nodeService .getProperties(containerNodeRef); props.putAll(containerProperties); this.nodeService.setProperties(containerNodeRef, props); } // Add the container aspect Map aspectProps = new HashMap( 1); aspectProps.put(SiteModel.PROP_COMPONENT_ID, componentId); this.nodeService.addAspect(containerNodeRef, ASPECT_SITE_CONTAINER, aspectProps); // Make the container a tag scope this.taggingService.addTagScope(containerNodeRef); } return containerNodeRef; } /** * @see org.alfresco.service.cmr.site.SiteService#getContainer(java.lang.String) */ public NodeRef getContainer(String shortName, String componentId) { ParameterCheck.mandatoryString("componentId", componentId); // retrieve site NodeRef siteNodeRef = getSiteNodeRef(shortName); if (siteNodeRef == null) { throw new SiteServiceException(MSG_SITE_NO_EXIST, new Object[]{shortName}); } // retrieve component folder within site // NOTE: component id is used for folder name NodeRef containerNodeRef = null; try { containerNodeRef = findContainer(siteNodeRef, componentId); } catch (FileNotFoundException e) { } return containerNodeRef; } /** * @see org.alfresco.service.cmr.site.SiteService#hasContainer(java.lang.String) */ public boolean hasContainer(String shortName, String componentId) { ParameterCheck.mandatoryString("componentId", componentId); // retrieve site NodeRef siteNodeRef = getSiteNodeRef(shortName); if (siteNodeRef == null) { throw new SiteServiceException(MSG_SITE_NO_EXIST, new Object[]{shortName}); } // retrieve component folder within site // NOTE: component id is used for folder name boolean hasContainer = false; try { findContainer(siteNodeRef, componentId); hasContainer = true; } catch (FileNotFoundException e) { } return hasContainer; } /** * Locate site "container" folder for component * * @param siteNodeRef * site * @param componentId * component id * @return "container" node ref, if it exists * @throws FileNotFoundException */ private NodeRef findContainer(NodeRef siteNodeRef, String componentId) throws FileNotFoundException { List paths = new ArrayList(1); paths.add(componentId); FileInfo fileInfo = fileFolderService.resolveNamePath(siteNodeRef, paths); if (!fileInfo.isFolder()) { throw new SiteServiceException(MSG_SITE_CONTAINER_NOT_FOLDER, new Object[]{fileInfo.getName()}); } return fileInfo.getNodeRef(); } /** * Helper method to get the activity data for a user * * @param userName user name * @param role role * @return */ private String getActivityData(String userName, String role) { String memberFN = ""; String memberLN = ""; NodeRef person = personService.getPerson(userName); if (person != null) { memberFN = (String) nodeService.getProperty(person, ContentModel.PROP_FIRSTNAME); memberLN = (String) nodeService.getProperty(person, ContentModel.PROP_LASTNAME); } try { JSONObject activityData = new JSONObject(); activityData.put("role", role); activityData.put("memberUserName", userName); activityData.put("memberFirstName", memberFN); activityData.put("memberLastName", memberLN); activityData.put("title", (memberFN + " " + memberLN + " (" + userName + ")").trim()); return activityData.toString(); } catch (JSONException je) { // log error, subsume exception logger.error("Failed to get activity data: " + je); return ""; } } public void setRoleComparator(Comparator roleComparator) { this.roleComparator = roleComparator; } public Comparator getRoleComparator() { return roleComparator; } }