();
for (String role : roles)
{
this.siteRoleGroups.put(
role,
this.siteService.getSiteRoleGroup(this.siteInfo.getShortName(), role));
}
}
return this.siteRoleGroups;
}
/**
* Saves any outstanding updates to the site details.
*
* If properties of the site are changed and save is not called, those changes will be lost.
*/
public void save()
{
if (this.isDirty == true)
{
// Update the site details
this.siteService.updateSite(this.siteInfo);
// Reset the dirty flag
this.isDirty = false;
}
}
/**
* Deletes the site
*/
public void deleteSite()
{
// Delete the site
this.siteService.deleteSite(this.siteInfo.getShortName());
}
/**
* Gets a map of members of the site with their role within the site. This list can
* be filtered by name and/or role.
*
* If no name or role filter is specified all members of the site are listed.
*
* This list includes both users and groups.
*
* @param nameFilter user name filter
* @param roleFilter user role filter
*
* @return ScriptableHashMap list of members of site with their roles
* @deprecated Use {@link #listMembers(String, String, int, boolean)} instead
*/
public ScriptableHashMap listMembers(String nameFilter, String roleFilter)
{
return listMembers(nameFilter, roleFilter, 0);
}
/**
* Gets a map of members of the site with their role within the site. This list can
* be filtered by name and/or role.
*
* If no name or role filter is specified all members of the site are listed.
*
* This list includes both users and groups.
*
* @param nameFilter user name filter
* @param roleFilter user role filter
* @param size max results size crop if >0
*
* @return ScriptableHashMap list of members of site with their roles
* @deprecated Use {@link #listMembers(String, String, int, boolean)} instead
*/
public ScriptableHashMap listMembers(String nameFilter, String roleFilter, int size)
{
return listMembers(nameFilter, roleFilter, size, false);
}
/**
* Gets a map of members of the site with their role within the site. This list can
* be filtered by name and/or role.
*
* If no name or role filter is specified all members of the site are listed.
*
* This list includes both users and groups if collapseGroups is set to false, otherwise all
* groups that are members are collapsed into their component users and listed.
*
* @param nameFilter user name filter
* @param roleFilter user role filter
* @param size max results size crop if >0
* @param collapseGroups true if collapse member groups into user list, false otherwise
*
* @return ScriptableHashMap list of members of site with their roles
*/
public ScriptableHashMap listMembers(String nameFilter, String roleFilter, int size, boolean collapseGroups)
{
Map members = this.siteService.listMembers(getShortName(), nameFilter, roleFilter, size, collapseGroups);
ScriptableHashMap result = new ScriptableHashMap();
result.putAll(members);
return result;
}
/**
* Gets a user's role in this site.
*
* If the user is not a member of the site then null is returned.
*
* @param authorityName authority name
* @return String user's role or null if not a member
*/
public String getMembersRole(String authorityName)
{
return this.siteService.getMembersRole(getShortName(), authorityName);
}
/**
* Gets extended information on the user's role in this site.
*
* If the user is not a member of the site then null is returned.
*
* @param authorityName authority name
* @return SiteMemberInfo user's role information or null if not a member
*/
public SiteMemberInfo getMembersRoleInfo(String authorityName)
{
return this.siteService.getMembersRoleInfo(getShortName(), authorityName);
}
/**
* Indicates whether a user belongs to a group with access rights to the site or not
*
* @param authorityName user name
* @return boolean true if the user belongs to a group with access rights, false otherwise
*/
public boolean isMemberOfGroup(String authorityName)
{
boolean isMemberOfGroup = false;
SiteMemberInfo membersRoleInfo = getMembersRoleInfo(authorityName);
if (membersRoleInfo != null)
{
isMemberOfGroup = membersRoleInfo.isMemberOfGroup();
}
return isMemberOfGroup;
}
/**
* Indicates whether a user is a member of the site.
*
* @param authorityName user name
* @return boolean true if the user is a member of the site, false otherwise
*/
public boolean isMember(String authorityName)
{
return this.siteService.isMember(getShortName(), authorityName);
}
/**
* Sets the membership details for a user.
*
* If the user is not already a member of the site then they are added with the role
* given. If the user is already a member of the site then their role is updated to the new role.
*
* Only a site manager can modify memberships and there must be at least one site manager at
* all times.
*
* @param authorityName authority name
* @param role site role
*/
public void setMembership(String authorityName, String role)
{
this.siteService.setMembership(getShortName(), authorityName, role);
}
/**
* Removes a user or group membership from a site.
*
* Only a site manager can remove a user's membership and the last site manager can not be removed.
*
* @param authorityName authority name
*/
public void removeMembership(String authorityName)
{
this.siteService.removeMembership(getShortName(), authorityName);
}
/**
* Gets (or creates) the "container" folder for the specified component id
*
* @param componentId
* @return node representing the "container" folder (or null, if for some reason
* the container can not be created - probably due to permissions)
*/
public ScriptNode getContainer(String componentId)
{
ScriptNode container = null;
try
{
NodeRef containerNodeRef = this.siteService.getContainer(getShortName(), componentId);
if (containerNodeRef != null)
{
container = new ScriptNode(containerNodeRef, this.serviceRegistry, this.scope);
}
}
catch (AccessDeniedException ade)
{
return null;
}
return container;
}
/**
* Creates a new site container
*
* @param componentId component id
* @return ScriptNode the created container
*/
public ScriptNode createContainer(String componentId)
{
return createContainer(componentId, null, null);
}
/**
* Creates a new site container
*
* @param componentId component id
* @param folderType folder type to create
* @return ScriptNode the created container
*/
public ScriptNode createContainer(String componentId, String folderType)
{
return createContainer(componentId, folderType, null);
}
/**
* Creates a new site container
*
* @param componentId component id
* @param folderType folder type to create
* @return ScriptNode the created container
*/
public ScriptNode createContainer(final String componentId, final String folderType, final Object permissions)
{
final NodeRef containerNodeRef = this.createContainerImpl(componentId, folderType, permissions);
if (Site.this.serviceRegistry.getPermissionService().hasPermission(containerNodeRef, PermissionService.READ_PROPERTIES) == AccessStatus.ALLOWED)
{
return getContainer(componentId);
}
else
{
// current user has no access.
return null;
}
}
private NodeRef createContainerImpl(final String componentId, final String folderType, final Object permissions)
{
return AuthenticationUtil.runAs(new RunAsWork()
{
public NodeRef doWork() throws Exception
{
// Get the container type
QName folderQName = (folderType == null) ? null : QName.createQName(folderType, serviceRegistry.getNamespaceService());
// Create the container node
NodeRef containerNode = Site.this.siteService.createContainer(getShortName(), componentId, folderQName, null);
// Set any permissions that might have been provided for the container
if (permissions != null && permissions instanceof ScriptableObject)
{
ScriptableObject scriptable = (ScriptableObject)permissions;
Object[] propIds = scriptable.getIds();
for (int i = 0; i < propIds.length; i++)
{
// work on each key in turn
Object propId = propIds[i];
// we are only interested in keys that are formed of Strings
if (propId instanceof String)
{
// get the value out for the specified key - it must be String
final String key = (String)propId;
final Object value = scriptable.get(key, scriptable);
if (value instanceof String)
{
// Set the permission on the container
Site.this.serviceRegistry.getPermissionService().setPermission(containerNode, key, (String)value, true);
}
}
}
}
// Make the "admin" the owner of the node
serviceRegistry.getOwnableService().setOwner(containerNode, AuthenticationUtil.getAdminUserName());
return containerNode;
}
}, AuthenticationUtil.SYSTEM_USER_NAME);
}
/**
* Gets and if missing, creates a new site container. The Site container is created in a new readwrite txn.
*
* @param componentId component id
* @return ScriptNode the created container
*/
public ScriptNode aquireContainer(final String componentId)
{
return this.aquireContainer(componentId, null, null);
}
/**
* Gets and if missing, creates a new site container. The Site container is created in a new readwrite txn.
*
* @param componentId component id
* @param folderType folder type to create
* @return ScriptNode the created container
*/
public ScriptNode aquireContainer(final String componentId, final String folderType)
{
return this.aquireContainer(componentId, folderType, null);
}
/**
* Gets and if missing, creates a new site container. The Site container is created in a new readwrite txn.
*
* @param componentId component id
* @param folderType folder type to create
* @return ScriptNode the created container
*/
public ScriptNode aquireContainer(final String componentId, final String folderType, final Object properties)
{
ScriptNode container = this.getContainer(componentId);
if (container == null)
{
RetryingTransactionCallback txnCallback = new RetryingTransactionCallback()
{
public NodeRef execute() throws Throwable
{
final NodeRef containerRef = createContainerImpl(componentId, folderType, null);
if (properties instanceof ScriptableObject)
{
ScriptableObject scriptable = (ScriptableObject)properties;
Object[] propIds = scriptable.getIds();
for (int i = 0; i < propIds.length; i++)
{
// work on each key in turn
Object propId = propIds[i];
// we are only interested in keys that are Strings
if (propId instanceof String)
{
final String key = (String)propId;
final Object value = scriptable.get(key, scriptable);
if (value instanceof String)
{
// Set the property on the container
QName qname = QName.resolveToQName(serviceRegistry.getNamespaceService(), key);
serviceRegistry.getNodeService().setProperty(containerRef, qname, (Serializable)value);
}
}
}
}
return containerRef;
}
};
final NodeRef containerNodeRef = serviceRegistry.getRetryingTransactionHelper().doInTransaction(txnCallback, false, true);
if (this.serviceRegistry.getPermissionService().hasPermission(containerNodeRef, PermissionService.READ_PROPERTIES) == AccessStatus.ALLOWED)
{
container = new ScriptNode(containerNodeRef, this.serviceRegistry, this.scope);
}
}
return container;
}
/**
* This method creates a container of the specified id and type, sets the cm:description
* on that container node to the specified value and saves the container node updates to the repository.
* All of this is run as system.
*
* @param containerId an id for the container node.
* @param containerType the type for the container node.
* @param description a value for the cm:description property on the container node.
*
* @return the newly created and saved container {@link ScriptNode}.
* @since 3.4
*/
public ScriptNode createAndSaveContainer(String containerId, String containerType, final String description)
{
// Implementation node. See ALF-4282 for details.
//
// The container for the "data lists" page within a Share site is lazily created the first time
// that a user navigates to that page. However if the first Share user to look at the data lists
// page for a site is not a site manager then they will not have the necessary permissions to
// create the container node.
// For this reason we need to create the node, set its cm:description and save those changes
// as system.
// The container creation is already run as system, so we don't need to double-wrap this first call
// in a RunAs class.
final ScriptNode result = this.createContainer(containerId, containerType);
if (result == null)
{
return null;
}
AuthenticationUtil.runAs(new RunAsWork()
{
public Void doWork() throws Exception
{
serviceRegistry.getNodeService().setProperty(result.getNodeRef(),
ContentModel.PROP_DESCRIPTION, description);
result.save();
return null;
}
}, AuthenticationUtil.SYSTEM_USER_NAME);
return result;
}
/**
* Determine if the "container" folder for the specified component exists
*
* @param componentId
* @return true => "container" folder exists
*/
public boolean hasContainer(String componentId)
{
return this.siteService.hasContainer(getShortName(), componentId);
}
/**
* Apply a set of permissions to the node.
*
* @param nodeRef node reference
*/
public void setPermissions(final ScriptNode node, final Object permissions)
{
final NodeRef nodeRef = node.getNodeRef();
if (permissions != null && permissions instanceof ScriptableObject)
{
final PermissionService permissionService = this.serviceRegistry.getPermissionService();
// ensure the user has permission to Change Permissions
if (permissionService.hasPermission(nodeRef, PermissionService.CHANGE_PERMISSIONS).equals(AccessStatus.ALLOWED))
{
AuthenticationUtil.runAs(new RunAsWork()
{
public Void doWork() throws Exception
{
if (!permissionService.getInheritParentPermissions(nodeRef))
{
// remove existing permissions
permissionService.deletePermissions(nodeRef);
}
// Assign the correct permissions
ScriptableObject scriptable = (ScriptableObject)permissions;
Object[] propIds = scriptable.getIds();
for (int i = 0; i < propIds.length; i++)
{
// Work on each key in turn
Object propId = propIds[i];
// Only interested in keys that are formed of Strings
if (propId instanceof String)
{
// Get the value out for the specified key - it must be String
final String key = (String)propId;
final Object value = scriptable.get(key, scriptable);
if (value instanceof String)
{
// Set the permission on the node
permissionService.setPermission(nodeRef, key, (String)value, true);
}
}
}
// always add the site managers group with SiteManager permission
String managers = siteService.getSiteRoleGroup(getShortName(), SiteModel.SITE_MANAGER);
permissionService.setPermission(nodeRef, managers, SiteModel.SITE_MANAGER, true);
// now turn off inherit to finalize our permission changes
permissionService.setInheritParentPermissions(nodeRef, false);
return null;
}
}, AuthenticationUtil.SYSTEM_USER_NAME);
}
}
else
{
// No permissions passed-in
this.resetAllPermissions(node);
}
}
/**
* Reset any permissions that have been set on the node.
*
* All permissions will be deleted and the node set to inherit permissions.
*
* @param nodeRef node reference
*/
public void resetAllPermissions(ScriptNode node)
{
final NodeRef nodeRef = node.getNodeRef();
// ensure the user has permission to Change Permissions
final PermissionService permissionService = serviceRegistry.getPermissionService();
if (permissionService.hasPermission(nodeRef, PermissionService.CHANGE_PERMISSIONS).equals(AccessStatus.ALLOWED))
{
AuthenticationUtil.runAs(new RunAsWork()
{
public Void doWork() throws Exception
{
// Ensure node isn't inheriting permissions from an ancestor before deleting
if (!permissionService.getInheritParentPermissions(nodeRef))
{
permissionService.deletePermissions(nodeRef);
permissionService.setInheritParentPermissions(nodeRef, true);
}
return null;
}
}, AuthenticationUtil.SYSTEM_USER_NAME);
}
else
{
throw new AlfrescoRuntimeException("You do not have the authority to update permissions on this node.");
}
}
/**
* Get the value of a custom property, null if the custom property has not been set or doesn't exist.
*
* @param name qname of the property
* @return Serializable value of the property, null if not set
*/
public CustomProperty getCustomProperty(String name)
{
return (CustomProperty)getCustomProperties().get(name);
}
/**
* Get a map of the sites custom properties
*
* @return ScriptableQNameMap map of names and values
*/
public ScriptableQNameMap getCustomProperties()
{
if (this.customProperties == null)
{
// create the custom properties map
ScriptNode siteNode = new ScriptNode(this.siteInfo.getNodeRef(), this.serviceRegistry);
// set the scope, for use when converting props to javascript objects
siteNode.setScope(scope);
this.customProperties = new ContentAwareScriptableQNameMap(siteNode, this.serviceRegistry);
Map props = siteInfo.getCustomProperties();
for (QName qname : props.keySet())
{
// get the property value
Serializable propValue = props.get(qname);
// convert the value
NodeValueConverter valueConverter = siteNode.new NodeValueConverter();
Serializable value = valueConverter.convertValueForScript(qname, propValue);
// get the type and label information from the dictionary
String title = null;
String type = null;
PropertyDefinition propDef = this.serviceRegistry.getDictionaryService().getProperty(qname);
if (propDef != null)
{
type = propDef.getDataType().getName().toString();
title = propDef.getTitle(this.serviceRegistry.getDictionaryService());
}
// create the custom property and add to the map
CustomProperty customProp = new CustomProperty(qname.toString(), value, type, title);
this.customProperties.put(qname.toString(), customProp);
}
}
return this.customProperties;
}
/**
* Create new moderated invitation to this web site
* @return the new invitation
*/
public ScriptInvitation inviteModerated(String inviteeComments, String inviteeUserName, String inviteeRole)
{
Invitation invitation = invitationService.inviteModerated(inviteeComments, inviteeUserName, Invitation.ResourceType.WEB_SITE, getShortName(), inviteeRole);
return scriptInvitationFactory.toScriptInvitation(invitation);
}
/**
* Create new nominated invitation to this web site
* @return the new invitation
*/
public ScriptInvitation inviteNominated(String inviteeFirstName, String inviteeLastName, String inviteeEmail, String inviteeRole, String acceptUrl, String rejectUrl)
{
Invitation invitation = invitationService.inviteNominated(inviteeFirstName, inviteeLastName, inviteeEmail, Invitation.ResourceType.WEB_SITE, getShortName(), inviteeRole, acceptUrl, rejectUrl);
return scriptInvitationFactory.toScriptInvitation(invitation);
}
/**
* Create new nominated invitation to this web site
* @return the new invitation
*/
public ScriptInvitation inviteNominated(String inviteeUserName, String inviteeRole, String acceptUrl, String rejectUrl)
{
Invitation invitation = invitationService.inviteNominated(inviteeUserName, Invitation.ResourceType.WEB_SITE, getShortName(), inviteeRole, acceptUrl, rejectUrl);
return scriptInvitationFactory.toScriptInvitation(invitation);
}
/**
* Get an invitation to this web site
* @return the invitation or null if it does not exist
*/
public ScriptInvitation getInvitation(String invitationId)
{
try
{
Invitation invitation = invitationService.getInvitation(invitationId);
return scriptInvitationFactory.toScriptInvitation(invitation);
}
catch (InvitationException e)
{
return null;
}
}
/**
* list the outstanding invitations for this site
*
* Map of name / invitation
*/
public ScriptInvitation[] listInvitations()
{
List invitations = invitationService.listPendingInvitationsForResource(Invitation.ResourceType.WEB_SITE, getShortName());
ScriptInvitation[] ret = new ScriptInvitation[invitations.size()];
int i = 0;
for(Invitation item : invitations)
{
ret[i++] = scriptInvitationFactory.toScriptInvitation(item);
}
return ret;
}
/**
* List the open invitations for this web site.
* props specifies optional properties to be searched.
*
* @param props inviteeUserName
*
* @return the invitations
*/
public ScriptInvitation[] listInvitations(Scriptable props)
{
InvitationSearchCriteriaImpl crit = new InvitationSearchCriteriaImpl();
crit.setResourceName(getShortName());
crit.setResourceType(Invitation.ResourceType.WEB_SITE);
if (props.has("inviteeUserName", props))
{
crit.setInvitee((String)props.get("inviteeUserName", props));
}
if (props.has("invitationType", props))
{
String invitationType = (String)props.get("invitationType", props);
crit.setInvitationType(InvitationType.valueOf(invitationType));
}
List invitations = invitationService.searchInvitation(crit);
ScriptInvitation[] ret = new ScriptInvitation[invitations.size()];
int i = 0;
for(Invitation item : invitations)
{
ret[i++] = scriptInvitationFactory.toScriptInvitation(item);
}
return ret;
}
/**
* Custom property helper class
*
* @author Roy Wetherall
*/
public class CustomProperty
{
/** Details of the custom property */
private String name;
private Serializable value;
private String type;
private String title;
/**
* Constructor
*
* @param name property name
* @param value property value
* @param type property type
* @param title property title
*/
public CustomProperty(String name, Serializable value, String type, String title)
{
this.name = name;
this.value = value;
this.type = type;
this.title = title;
}
public String getName()
{
return name;
}
public Serializable getValue()
{
return value;
}
public String getType()
{
return type;
}
public String getTitle()
{
return title;
}
}
}