mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-10-08 14:51:49 +00:00
02ef5d3156
129148 kroast: Merged 5.0.N (5.0.4) to 5.1.N (5.1.2) (PARTIAL MERGE)
129068 kroast: ESC-476, MNT-16162
Folder access in 'private' sites using site path url fails versus repository url path
SHA-1682
Granular Permissions File and Folder Access for non-site members
- Navigating to a Document Library folder link in the search results page to a folder you have been given access to in a private site. You can now navigate to the folder and all sub-folders you have been given access to within that private site.
- Navigating to a Document Details page link in the search results page to a document you have been given access to in a private site.
- The Tags 'Could not retrieve tags' and the Tree component "Site not found: ..." messages have been made less aggressive looking within the Document Library views - the red background has been removed.
- The private site missing title (was blank previously) in the title area has been replaced with the site url name which is all the user is able to resolve given the private permissions for the site object.
See tickets for more detail on fixes and what functionality is available.
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@129222 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
445 lines
17 KiB
Java
445 lines
17 KiB
Java
/*
|
|
* #%L
|
|
* Alfresco Repository
|
|
* %%
|
|
* Copyright (C) 2005 - 2016 Alfresco Software Limited
|
|
* %%
|
|
* This file is part of the Alfresco software.
|
|
* If the software was purchased under a paid Alfresco license, the terms of
|
|
* the paid license agreement will prevail. Otherwise, the software is
|
|
* provided under the following open source license terms:
|
|
*
|
|
* Alfresco 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.
|
|
*
|
|
* Alfresco 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 Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
* #L%
|
|
*/
|
|
package org.alfresco.repo.site.script;
|
|
|
|
import java.util.ArrayList;
|
|
import java.util.List;
|
|
|
|
import org.alfresco.repo.jscript.BaseScopableProcessorExtension;
|
|
import org.alfresco.repo.jscript.ScriptNode;
|
|
import org.alfresco.repo.security.authentication.AuthenticationUtil;
|
|
import org.alfresco.repo.site.SiteServiceImpl;
|
|
import org.alfresco.service.ServiceRegistry;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
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.namespace.QName;
|
|
import org.springframework.extensions.surf.util.ParameterCheck;
|
|
|
|
|
|
/**
|
|
* Script object representing the site service.
|
|
*
|
|
* @author Roy Wetherall
|
|
*/
|
|
public class ScriptSiteService extends BaseScopableProcessorExtension
|
|
{
|
|
/** Visibility helper constants */
|
|
public static final String PUBLIC_SITE = "PUBLIC";
|
|
public static final String MODERATED_SITE = "MODERATED";
|
|
public static final String PRIVATE_SITE = "PRIVATE";
|
|
|
|
/** Service Registry */
|
|
private ServiceRegistry serviceRegistry;
|
|
|
|
/** The site service */
|
|
private SiteService siteService;
|
|
|
|
/**
|
|
* Sets the Service Registry
|
|
*
|
|
* @param serviceRegistry ServiceRegistry
|
|
*/
|
|
public void setServiceRegistry(ServiceRegistry serviceRegistry)
|
|
{
|
|
this.serviceRegistry = serviceRegistry;
|
|
}
|
|
|
|
/**
|
|
* Set the site service
|
|
*
|
|
* @param siteService the site service
|
|
*/
|
|
public void setSiteService(SiteService siteService)
|
|
{
|
|
this.siteService = siteService;
|
|
}
|
|
|
|
/**
|
|
* @see #createSite(String, String, String, String, String)
|
|
*
|
|
* @param sitePreset site preset
|
|
* @param shortName site short name
|
|
* @param title site title
|
|
* @param description site description
|
|
* @param isPublic whether the site is public or not
|
|
* @return Site the created site
|
|
* @deprecated as of version 3.2, replaced by {@link #createSite(String, String, String, String, String)}
|
|
*/
|
|
public Site createSite(String sitePreset, String shortName, String title, String description, boolean isPublic)
|
|
{
|
|
SiteInfo siteInfo = this.siteService.createSite(sitePreset, shortName, title, description, isPublic);
|
|
return new Site(siteInfo, this.serviceRegistry, this.siteService, getScope());
|
|
}
|
|
|
|
/**
|
|
* Create a new site.
|
|
* <p>
|
|
* The site short name will be used to uniquely identify the site so it must be unique.
|
|
*
|
|
* @param sitePreset site preset
|
|
* @param shortName site short name
|
|
* @param title site title
|
|
* @param description site description
|
|
* @param visibility visibility of the site (public|moderated|private)
|
|
* @return Site the created site
|
|
*/
|
|
public Site createSite(String sitePreset, String shortName, String title, String description, String visibility)
|
|
{
|
|
ParameterCheck.mandatoryString("visibility", visibility);
|
|
SiteVisibility siteVisibility = SiteVisibility.valueOf(visibility);
|
|
SiteInfo siteInfo = this.siteService.createSite(sitePreset, shortName, title, description, siteVisibility);
|
|
return new Site(siteInfo, this.serviceRegistry, this.siteService, getScope());
|
|
}
|
|
|
|
/**
|
|
* Create a new site.
|
|
* <p>
|
|
* The site short name will be used to uniquely identify the site so it must be unique.
|
|
*
|
|
* @param sitePreset site preset
|
|
* @param shortName site short name
|
|
* @param title site title
|
|
* @param description site description
|
|
* @param visibility visibility of the site (public|moderated|private)
|
|
* @param siteType qname of site type to create
|
|
* @return Site the created site
|
|
*/
|
|
public Site createSite(String sitePreset, String shortName, String title, String description, String visibility, String siteType)
|
|
{
|
|
ParameterCheck.mandatoryString("visibility", visibility);
|
|
SiteVisibility siteVisibility = SiteVisibility.valueOf(visibility);
|
|
QName siteTypeQName = QName.createQName(siteType);
|
|
SiteInfo siteInfo = this.siteService.createSite(sitePreset, shortName, title, description, siteVisibility, siteTypeQName);
|
|
return new Site(siteInfo, this.serviceRegistry, this.siteService, getScope());
|
|
}
|
|
|
|
/**
|
|
* Site existence check. Allows private site existence to be tested.
|
|
*
|
|
* @param shortName site short name
|
|
* @return true if the site exists, false otherwise.
|
|
*/
|
|
public boolean hasSite(String shortName)
|
|
{
|
|
return this.siteService.hasSite(shortName);
|
|
}
|
|
|
|
/**
|
|
* This method checks if the currently authenticated user has permission to create sites.
|
|
*
|
|
* @return <code>true</code> if the current user is a Contributor to "Sites" node, else <code>false</code>.
|
|
* @since 3.4
|
|
*/
|
|
public boolean hasCreateSitePermissions()
|
|
{
|
|
return siteService.hasCreateSitePermissions();
|
|
}
|
|
|
|
/**
|
|
* Determines if the current user is a manager of the given site.
|
|
*
|
|
* @param siteId The short name of the site to check
|
|
* @return true if the current user is a manager of the given site
|
|
*/
|
|
public boolean isSiteManager(String siteId)
|
|
{
|
|
String role = siteService.getMembersRole(siteId, AuthenticationUtil.getFullyAuthenticatedUser());
|
|
return (SiteServiceImpl.SITE_MANAGER.equals(role));
|
|
}
|
|
|
|
/**
|
|
* Retrieves the sites available in the repository. The returned list can optionally be filtered by name and site
|
|
* preset. If no filters are specified then all the available sites are returned.
|
|
*
|
|
* NOTE: If the filter starts with a * a Lucene based search will be performed, this may discover a wider range
|
|
* of results i.e. those sites that contain the search term as opposed to those that start with the search term,
|
|
* but newly created sites may not be found until the underlying search indexes are updated.
|
|
*
|
|
* @param filter inclusion filter for returned sites. Only sites whose cm:name OR cm:title
|
|
* OR cm:description start with the filter string will be returned.
|
|
* @param sitePresetFilter site preset filter
|
|
* @param size max results size crop if >0
|
|
* @return Site[] a list of the site filtered as appropriate
|
|
*/
|
|
public Site[] getSites(String filter, String sitePresetFilter, int size)
|
|
{
|
|
// reset filter if necessary
|
|
if (filter != null && (filter.length() == 0 || filter.equals("*")))
|
|
{
|
|
filter = null;
|
|
}
|
|
|
|
if (filter != null && (filter.startsWith("*")))
|
|
{
|
|
// findSites will add the wildcard so remove here
|
|
filter = filter.substring(1, filter.length());
|
|
|
|
// use findSites to do a "contains" search
|
|
return findSites(filter, sitePresetFilter, size);
|
|
}
|
|
else
|
|
{
|
|
// use listSites to do a canned query (will provide consistent results)
|
|
return listSites(filter, sitePresetFilter, size);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* List the sites available in the repository. The returned list can optionally be filtered by name and site
|
|
* preset.
|
|
* <p>
|
|
* If no filters are specified then all the available sites are returned.
|
|
*
|
|
* @param filter inclusion filter for returned sites. Only sites whose cm:name OR cm:title
|
|
* OR cm:description start with the filter string will be returned.
|
|
* @param sitePresetFilter site preset filter
|
|
* @return Site[] a list of the site filtered as appropriate
|
|
*
|
|
* @see SiteService#listSites(String, String, int) for a description of the limitations of this method.
|
|
*/
|
|
public Site[] listSites(String filter, String sitePresetFilter)
|
|
{
|
|
return listSites(filter, sitePresetFilter, -1);
|
|
}
|
|
|
|
/**
|
|
* List the sites available in the repository. The returned list can optionally be filtered by name and site
|
|
* preset.
|
|
* <p/>
|
|
* If no filters are specified then all the available sites are returned.
|
|
*
|
|
* @param filter inclusion filter for returned sites. Only sites whose cm:name OR cm:title
|
|
* OR cm:description start with the filter string will be returned.
|
|
* @param sitePresetFilter site preset filter
|
|
* @param size max results size crop if >0
|
|
* @return Site[] a list of the site filtered as appropriate
|
|
*
|
|
* @see SiteService#listSites(String, String, int) for a description of the limitations of this method.
|
|
*/
|
|
public Site[] listSites(String filter, String sitePresetFilter, int size)
|
|
{
|
|
List<SiteInfo> siteInfos = this.siteService.listSites(filter, sitePresetFilter, size);
|
|
return makeSitesArray(siteInfos);
|
|
}
|
|
|
|
/**
|
|
* Find (search) the sites available in the repository. The returned list can optionally be filtered by name and site
|
|
* preset.
|
|
* <p/>
|
|
* If no filters are specified then all the available sites are returned.
|
|
*
|
|
* @param filter inclusion filter for returned sites. Only sites whose cm:name OR cm:title
|
|
* OR cm:description CONTAIN the filter string will be returned.
|
|
* @param sitePresetFilter site preset filter
|
|
* @param size max results size crop if >0
|
|
*
|
|
* @return Site[] a list of the site filtered as appropriate
|
|
*
|
|
* @see SiteService#findSites(String, String, int) for a description of the limitations of this method.
|
|
* @since 4.0
|
|
*/
|
|
public Site[] findSites(String filter, String sitePresetFilter, int size)
|
|
{
|
|
List<SiteInfo> siteInfos = this.siteService.findSites(filter, sitePresetFilter, size);
|
|
return makeSitesArray(siteInfos);
|
|
}
|
|
|
|
/**
|
|
* Find (search) the sites available in the repository. The returned list can optionally be filtered by name
|
|
* <p/>
|
|
*
|
|
* @param filter inclusion filter for returned sites. Only sites whose cm:name OR cm:title
|
|
* OR cm:description CONTAIN the filter string will be returned.
|
|
* @param size max results size crop if >0
|
|
*
|
|
* @return Site[] a list of the site filtered as appropriate
|
|
*
|
|
* @see SiteService#findSites(String, int) for a description of the limitations of this method.
|
|
* @since 5.0
|
|
*/
|
|
public Site[] findSites(String filter, int size)
|
|
{
|
|
List<SiteInfo> siteInfos = this.siteService.findSites(filter, size);
|
|
return makeSitesArray(siteInfos);
|
|
}
|
|
/**
|
|
* Converts the given List of SiteInfo objects to a JavaScript friendly array
|
|
* of Site objects.
|
|
*
|
|
* @return Array of Site objects
|
|
*/
|
|
protected Site[] makeSitesArray(List<SiteInfo> siteInfos)
|
|
{
|
|
List<Site> sites = new ArrayList<Site>(siteInfos.size());
|
|
for (SiteInfo siteInfo : siteInfos)
|
|
{
|
|
sites.add(new Site(siteInfo, this.serviceRegistry, this.siteService, getScope()));
|
|
}
|
|
|
|
return sites.toArray(new Site[sites.size()]);
|
|
}
|
|
|
|
/**
|
|
* List all the sites that the specified user has an explicit membership to.
|
|
*
|
|
* @param userName user name
|
|
* @param size maximum list size
|
|
* @return Site[] a list of sites the user has an explicit membership to
|
|
*/
|
|
public Site[] listUserSites(String userName, int size)
|
|
{
|
|
List<SiteInfo> siteInfos = this.siteService.listSites(userName, size);
|
|
List<Site> sites = new ArrayList<Site>(siteInfos.size());
|
|
for (SiteInfo siteInfo : siteInfos)
|
|
{
|
|
sites.add(new Site(siteInfo, this.serviceRegistry, this.siteService, getScope()));
|
|
}
|
|
return sites.toArray(new Site[sites.size()]);
|
|
}
|
|
|
|
/**
|
|
* List all the sites that the specified user has an explicit membership to.
|
|
*
|
|
* @param userName user name
|
|
* @return Site[] a list of sites the user has an explicit membership to
|
|
*/
|
|
public Site[] listUserSites(String userName)
|
|
{
|
|
return listUserSites(userName, 0);
|
|
}
|
|
|
|
/**
|
|
* Get a site for a provided site short name.
|
|
* <p>
|
|
* Returns null if the site does not exist.
|
|
*
|
|
* @param shortName short name of the site
|
|
* @return Site the site, null if does not exist
|
|
*/
|
|
public Site getSite(final String shortName)
|
|
{
|
|
SiteInfo siteInfo = null;
|
|
Site site = null;
|
|
if (siteService.isSiteAdmin(AuthenticationUtil.getFullyAuthenticatedUser()))
|
|
{
|
|
siteInfo = AuthenticationUtil.runAs(new AuthenticationUtil.RunAsWork<SiteInfo>()
|
|
{
|
|
public SiteInfo doWork() throws Exception
|
|
{
|
|
return siteService.getSite(shortName);
|
|
}
|
|
}, AuthenticationUtil.getAdminUserName());
|
|
}
|
|
else
|
|
{
|
|
siteInfo = this.siteService.getSite(shortName);
|
|
}
|
|
|
|
if (siteInfo != null)
|
|
{
|
|
site = new Site(siteInfo, this.serviceRegistry, this.siteService, getScope());
|
|
}
|
|
return site;
|
|
}
|
|
|
|
/**
|
|
* Get a site for a provided site short name. If the current user does not have permission to view the site content, the info
|
|
* will still be returned, but none of the operations that would modify site information on save() will work. As usual ACLs
|
|
* will apply on any attempt to modify the Site object.
|
|
* <p>
|
|
* Returns null if the site does not exist.
|
|
*
|
|
* @param shortName short name of the site
|
|
* @return Site the site, null if does not exist
|
|
*/
|
|
public Site getSiteInfo(final String shortName)
|
|
{
|
|
Site site = null;
|
|
|
|
SiteInfo siteInfo = AuthenticationUtil.runAs(new AuthenticationUtil.RunAsWork<SiteInfo>()
|
|
{
|
|
public SiteInfo doWork() throws Exception
|
|
{
|
|
return siteService.getSite(shortName);
|
|
}
|
|
}, AuthenticationUtil.getAdminUserName());
|
|
|
|
if (siteInfo != null)
|
|
{
|
|
site = new Site(siteInfo, this.serviceRegistry, this.siteService, getScope());
|
|
}
|
|
return site;
|
|
}
|
|
|
|
/**
|
|
* Returns an array of all the roles that can be assigned to a member of a site.
|
|
*
|
|
* @return String[] roles available to assign to a member of a site
|
|
*/
|
|
public String[] listSiteRoles()
|
|
{
|
|
List<String> roles = this.siteService.getSiteRoles();
|
|
return roles.toArray(new String[roles.size()]);
|
|
}
|
|
|
|
/**
|
|
* It removes permissions which pertain to sites other than the node's current site.
|
|
*
|
|
* @param targetNode the root node which is to have its permissions cleaned.
|
|
* @see SiteService#cleanSitePermissions(NodeRef, SiteInfo)
|
|
*/
|
|
public void cleanSitePermissions(NodeRef targetNode)
|
|
{
|
|
this.siteService.cleanSitePermissions(targetNode, null);
|
|
}
|
|
|
|
/**
|
|
* This method cleans up the permissions on the specified node and all its primary children.
|
|
* It removes permissions which pertain to sites other than the node's current site.
|
|
*
|
|
* @since 3.4.2
|
|
* @see SiteService#cleanSitePermissions(NodeRef, SiteInfo)
|
|
*/
|
|
public void cleanSitePermissions(ScriptNode targetNode)
|
|
{
|
|
this.cleanSitePermissions(targetNode.getNodeRef());
|
|
}
|
|
|
|
/**
|
|
* Returns an array of all the roles that can be assigned to a member of a
|
|
* specific site.
|
|
*
|
|
* @return String[] roles available to assign to a member of a site
|
|
*/
|
|
public String[] listSiteRoles(String shortName)
|
|
{
|
|
List<String> roles = this.siteService.getSiteRoles(shortName);
|
|
return (String[])roles.toArray(new String[roles.size()]);
|
|
}
|
|
}
|