Dave Ward 890d3795ce Merged V3.3 to HEAD
20440: RM: CapabilitiesTest.testDestroyRecordsCapability (MS SQL Server build) - use non-public nodeService
   20441: Include virtual tomcat in installers
   20442: Change bitrock builder version to use.
   20443: Merged BRANCHES/DEV/V3.3-BUG-FIX to BRANCHES/V3.3: (Fixed tabs and removed 'svn:executable' and 'svn:eol-style')
      20384: Merged BRANCHES/DEV/BELARUS/HEAD-2010_04_28 to BRANCHES/DEV/V3.3-BUG-FIX:
         20271: ALF-803: Asset Service Improvements
      20386: Merged V2.2 to V3.3-BUG-FIX
         20385: Merged DEV/BELARUS/V2.2-2010_04_06 to V2.2
            20379: V2.2-ALF-1888 AssociationQuery was corrected to filter ...
      20387: Version Migrator (ALF-1000) - approx x3 boost (policies ignore version2 store)
      20388: Merged BRANCHES/DEV/BELARUS/HEAD-2010_04_28 to BRANCHES/DEV/V3.3-BUG-FIX:
         20372: ALF-897: It is impossible to create content when default value selected in ContentHeadlineBackground field for intranet_rssi_landing_template web-form (also fixes ALF-2798 & ALF-791)
      20389: Merged BRANCHES/DEV/BELARUS/HEAD-2010_04_28 to BRANCHES/DEV/V3.3-BUG-FIX:
         20374: ALF-2723: WCM - Http 500 creating content via webform
      20394: Fix for ALF-2257 - It's impossible to find and add group at Records Manage Permissions page
      20396: Fixed ALF-2956 "XSS attack is made when a rule is being deleted"
      20397: Fix for ALF-922: Mysql does not support unique keys that contain nulls as one would expect
      20402: ALF-2186 : Rules not being fired on datalist items - because it's a zero byte file?
      20404: Fixed ALF-2109 "Rule doesn't apply to the files in sub-folders when 'Run rule for this folder and its subfolders' action was performed"
      20406: Fix for ALF-2985 - Share document library throws error if document modifier or creator is deleted from Alfresco
      20409: Improved FormServiceImplTest, added more content related tests and some edge case tests using the FDK model (this test needs to be manually enabled though as the FDK model is not available by default)
      20414: Merged DEV/BELARUS/HEAD-2010_04_28 to DEV/V3.3-BUG-FIX
         20401: ALF-2616: Serious Web Form layout performance issues on IE8. This fix contains:
      20427: Merged DEV/BELARUS/HEAD-2010_04_28 to DEV/V3.3-BUG-FIX
         20042: ALF-1523: Failed Kerberos SSO auth doesn't fail through, simply returns a blank page
         20323: ALF-1523: Failed Kerberos SSO auth doesn't fail through, simply returns a blank page
      20428: Merged DEV/BELARUS/HEAD-2010_04_28 to DEV/V3.3-BUG-FIX
         20417: ALF-736: WebDAV Folder Renaming fails on Mac but works on Windows.
      20430: Fix for ALF-2313 - Accessing a Doclib folder in Share which has a link to a deleted node fails
      20431: Version Migrator (ALF-1000) - migrate 1st batch independently
      20432: Fix for ALF-2327 - Can not have more than one Transfer Step in a disposal schedule
      20438: ALF-479: Merged DEV/BELARUS/V3.2-2010_01_11 to DEV/V3.3-BUG-FIX
         18448: ETHREEOH-4044: External Authentication Subsystem does not perform user mapping for WebDAV requests
   20444: Fix for ConcurrentModificationException in file server quota manager. ALF-2970.
   20445: Merged HEAD to BRANCHES/V3.3: (RECORD ONLY)
      20413: Added clean of quickr project
   20446: Changed version to 3.3.1dev
   20447: Merged V3.3-BUG-FIX to V3.3
      20294: Fixes: ALF-1020 & ALF-1013 for all views except agenda.
   20451: Merged V2.2 to V3.3
      20450: Merged DEV/BELARUS/V2.2-2010_04_06 to V2.2
         20412: ALF-1887: too easy to break alfresco - one can remove the guest user and recreate it but then access to RSS is broken
            - PersonServiceImpl.beforeDeleteNode prohibits attempts to delete a guest user.
   20452: Fix for transaction error from NFS server file expiry thread. ALF-3016.
   20458: ALF-2729 - rationalise (and deprecate) VersionLabelComparator
   20460: Fix for ALF-2430
      - AVM nodes are not checked for exclusion - the default ACLEntryVoter will always vote for AVM
      - avoids embedded AVM permission checks for getType/getAspect and anything else that may be added
      - seems AVM read is not checked upon "lookup" for the last node in the PATH (getType should have failed too)
   20466: Merged V2.2 to V3.3
      20243: (RECORD ONLY) ALF-2814: Merged V3.2 to V2.2
         17891: Merged DEV_TEMPORARY to V3.2
            17873: ETHREEOH-3810: WCM - Recursion detector erroring
   20467: Merged V3.1 to V3.3 (RECORD ONLY)
      20276: Incremented version label
      20275: ALF-2845: Merged V3.2 to V3.1
         17768: Merged DEV/BELARUS/V3.2-2009_11_24 to V3.2
            17758: ETHREEOH-3757: Oracle upgrade issue: failed "inviteEmailTemplate" patch - also causes subsequent patches to not be applied
      19573: Merged V3.2 to V3.1
         19539: Merged HEAD to V3.2
            19538: Build fix - fix build speed
   20468: Merged PATCHES/V3.2.r to V3.3 (RECORD ONLY)
      20357: Merged PATCHES/V3.2.0 to PATCHES/V3.2.r
         20349: Merged V3.3 to PATCHES/V3.2.0
            20346: ALF-2839: Node pre-loading generates needless resultset rows
               - Added missing Criteria.list() call
      20339: Incremented version label
      20338: Merged PATCHES/V3.2.0 to PATCHES/V3.2.r
         20280: Fixed ALF-2839: Node pre-loading generates needless resultset rows
            - Split Criteria query to retrieve properties and aspects separately
         20272: Backports to help fix ALF-2839: Node pre-loading generates needless resultset rows
            Merged BRANCHES/V3.2 to PATCHES/V3.2.0:
               18490: Added cache for alf_content_data
            Merged BRANCHES/DEV/V3.3-BUG-FIX to PATCHES/V3.2.0:
               20231: Fixed ALF-2784: Degradation of performance between 3.1.1 and 3.2x (observed in JSF)
         20266: Test reproduction of ALF-2839 failure: Node pre-loading generates needless resultset rows
   20469: Merged PATCHES/V3.1.2 to V3.3 (RECORD ONLY)
      20393: Eclipse classpath fix to avoid problems in JBoss
      20309: ALF-2777: PrimaryChildAssocCopyBehaviour from MOB-388 corrupts cm:name attributes of copied child nodes
         - Folded example behaviours from previous AMP into repository
         - Fixed PrimaryChildAssocCopyBehaviour to back-up and set the cm:name property on copied children
   20470: Merged PATCHES/V3.2.0 to V3.3 (RECORD ONLY)
      20465: Incremented version label
      20464: ALF-3060: Merged V3.2 to PATCHES/V3.2.0
         19920: Merged HEAD to BRANCHES/V3.2:
            19918: Fix ALF-2499 (Deleting a web project also deletes similarly named web projects - Potential Data Loss)
      20448: Merged DEV/V3.3-BUG-FIX to PATCHES/V3.2.0
         20414: Merged DEV/BELARUS/HEAD-2010_04_28 to DEV/V3.3-BUG-FIX
            20401: ALF-2616: Serious Web Form layout performance issues on IE8. This fix contains:
               a) X-UA-Compatible head tag with IE=EmulateIE7 value
               b) alfresco.ieVersion and alfresco.ieEngine in common.js
               c) recurseOnChildren in _updateDisplay
               d) Some performance modifications in xforms.js
      20350: Increment version label
      20349: Merged V3.3 to PATCHES/V3.2.0
         20346: ALF-2839: Node pre-loading generates needless resultset rows
            - Added missing Criteria.list() call
   20471: Fix for offline sync losing metadata properties, due to rename/delete of original file. ALF-575.
   20478: Merged HEAD to BRANCHES/V3.3: (RECORD ONLY)
      20477: Fix ALF-3086: CMIS checkin of a non-versionable document should make it versionable
   20479: ALF-2110: Make it possible to determine which person properties are synced via LDAP and hence immutable
      - Added Set<QName> UserRegistrySynchronizer.getPersonMappedProperties(String username)
      - UI/Services Fix to follow
   20481: Latest SpringSurf libs:
      - Fix for ALF-1518 - Added support for HTTP and HTTPS proxies for Surf application remote api calls - via the standard JVM cmd line properties such as -Dhttp.proxyHost=...
   20484: ALF-2886: LDAP sync defaults display names incorrectly and can't cope with DNs containing escaped trailing whitespace.
      - Had to work around a JDK bug in LDAP RDN parsing
   20486: Added case sensitive flag to the file state cache. Part of ALF-570.
   20487: Fix for copy/rename of folders causing file exists errors in some cases. ALF-570.
   20488: Fix ALF-680: Previously valid content models now fail with CMISAbstractDictionaryService$DictionaryRegistry exception
   20489: Uploaded correct version of spring source jars and reunited them with 3rd-party/.classpath
   20490: Fix for cannot delete folders via CIFS from Mac OSX, due to desktop actions. ALF-2553.
   20491: Merged DEV/TEMPORARY to V3.3 (With corrections)
      20485: ALF-2290: a HTTP GET request of a document redirects to the Home Location when using NTLM SSO
         The logic related to ADB-61 in NTLMAuthenticationFilter clears previous location and redirects request to default home location. NTLMAuthenticationFilter was changed to process GET requests to documents correctly. Now, fix to ADB-61 processes only “/faces” requests and GET requests to documents are processed correctly.
         The same fix was made to KerberosAuthenticationFilter
   20492: Fix ALF-680: Previously valid content models now fail with CMISAbstractDictionaryService$DictionaryRegistry exception
      - missing remove directory
   20493: Fix ALF-2837: ClassCastException in getProperties()
   20498: Fix for ALF-2818: Failure to close index writer under certain conditions.
      - fix for index writer to close indexes when stopped by exceptions during FTS
      - fix FTS job to handle exceptions better
      - debug for FTS background operations
   20499: ALF-3094: In ticket authenticate method in AuthenticationHelper, invalidate the current session if its cached ticket doesn't match
   20500: Fix for ALF-2858 "Zero KB sized bin files will be created in the contentstore when new sites are created" (RECORD ONLY)
   20503: AVMTestSuite: minor fixes to cleanup ctx usage (avoid re-loading)
   20505: Merged BRANCHES/V2.2 to BRANCHES/V3.3 (record-only)
      13859: (record-only) Removed dev from version label
      14003: (record-only) Updated version to 2.2.5dev
      14566: (record-only) ETWOTWO-1239 - remove workflow interpreter/console bootstrap
      14572: (record-only) ETWOTWO-1239 - fix PersonTest to fix JBPMEngineTest (part-sourced from r13247)
      14776: (record-only) Merged V3.1 to V2.2
         14748: ETHREEOH-2225 - WCM upgrade (performance improvements for MySQL)
   20506: NFS ReadDir/ReadDirPlus skips some folder entries. JLAN-98. 
   20507: Fixed issue with folder search resume id being reset to the wrong value during NFS folder search. Part of JLAN-98.
   20508: Merged BRANCHES/V3.2 to BRANCHES/V3.3:
      18319: Merged BRANCHES/DEV/BELARUS/V3.2-2010_01_11 to V3.2
         18273: ETHREEOH-3834: WCM: An extral .xml.html file is created when editing newly created content
      19182: Merged V3.1 to V3.2
         18423: ETHREEOH-3850 - Content Manager unable to edit content items if there is a lock on a generated rendition
         18432: (RECORD ONLY) Added FTP data port range configuration via <dataPorts>n:n</dataPorts> config value. ETHREEOH-4103.
         18451: (RECORD ONLY) Fixed incorrect FTP debug level name.
         18577: (RECORD ONLY) Fix for ETHREEOH-4117, based on CHK-11154
         18792: Fix ETHREEOH-2729:  Import of property with @ symbol in name fails with "start tag unexpected character @ "
      19570: ALF-192 / ALF-1750:  System Error if user trying submit web content based on web form which was deleted
      19583: Merged DEV/BELARUS/V3.2-2010_03_17 to V3.2
         19545: ALF-1954: Regression: same item can be submitted multiple times to workflow
      19725: AVMStoreDescriptor - fix minor typo (for debugging)
      19917: (RECORD ONLY) Merged HEAD to BRANCHES/V3.2:
         19880: Fix ALF-898 - WCM: Deleting a file leads to error (only if RM/DOD installed)
      19920: (RECORD ONLY) Merged HEAD to BRANCHES/V3.2:
         19918: Fix ALF-2499 (Deleting a web project also deletes similarly named web projects - Potential Data Loss)
   20509: Merged BRANCHES/V3.2 to BRANCHES/V3.3 (RECORD ONLY):
      19825: (RECORD ONLY) Merged PATCHES/V3.2.r to BRANCHES/V3.2: 
         19804: Merged PATCHES/V3.2.0 to PATCHES/V3.2.r 
            Merged HEAD to V3.2.0 
            ...
   20510: Merged BRANCHES/V3.1 to BRANCHES/V3.3 (RECORD ONLY)
      17482: (RECORD ONLY) Merged V3.2 to V3.1
         17478: Fix ETHREEOH-3340 - WCM - Revert to snapshot failure (fix AVM getListing -> AVMSync compare -> WCM revertSnapshot)
      18783: (RECORD ONLY) MT: ensure group (EMAIL_CONTRIBUTORS) bootstraps tenant admin user (when creating tenant)
   20513: Added port change example for remote Alfresco server to share-config-custom.xml.sample
   20518: ALF-657 Created tests to check that the 'runas' functionality works in the AlfrescoJavaScript action handler. Also modified the handler to run as the System user if no Authentication is currently set, as may occur if the action handler is being executed asynchronously.
   20519: ALF-657 Created tests to check that the 'runas' functionality works in the AlfrescoJavaScript action handler. Also modified the handler to run as the System user if no Authentication is currently set, as may occur if the action handler is being executed asynchronously.
   20520: Removed dev version.label
   20522: ALF-3129: Map cm:organization property in LDAP as well as cm:organizationId, since cm:organization is what shows up in JSF and Share. Needed by ALF-2110.
   20523: First part of fix for ALF-2110:
      - Appropriate Person and webframework metadata APIs now return information on immutability of Person properties (as some properties are immutable when synced to LDAP etc.)
      - Share client  now correctly disables profile fields in User Profile and Admin User Console as appropriate based on individual user property mutability
      - Change Password button now correctly enabled/disabled based on account mutability
   20524: VersionMigrator - option to run as scheduled job (ALF-1000)
   20525: Fix for various IE6 CSS issues:
      ALF-3047 - It's impossible to destinate any action with data list item (IE6 specific)
      ALF-3049 - Incorrect layout of Manage aspects page
      ALF-3050 - Incorrect layout of Assign Workflow form
   20526: Fix for ALF-2915 - Select > None feature for Data Lists not working across multiple pages in IE
      Closed ALF-2846 - DataList UI not fully I18Ned [Old prototype code]
   20527: Fix for ALF-3082 - There is no Edit Offline action at Details page in Share site
   20528: Fix various script errors due to typo:
      ALF-3088 - Script error occurs on creating duplicated record seria
      ALF-3012 - Incorrect behaviour on creating duplicating folders
      ALF-3004 - Script error when submitting an item with long data in Prioprity field
   20529: Fix for ALF-3006 - Selected Items > Copy to... and Move to actions not working in Document Library
   20530: Dynamic Models - fix test(s)
      - fix concurrency test for Oracle build (retry if txn lock cannot be acquired)
      - when getting deployed models, skip if invalid (eg. cannot be parsed)
   20536: Remove @Override (ALF-657)
   20537: Activities - (minor) fix NPE for Oracle build/test
   20543: Final part of ALF-2110 - Appropriate person properties disabled for editing in Explorer Client if external mapped sync such as LDAP is used.
      Fixed issue with Change Password option being disabled incorrectly.
   20544: Follow-up fix to r20528
   20546: Fix for ALF-3151 - Freemarker causes NPE while deploying 3.3 enterprise onto WebSphere 7.0.0.7
      - NOTE: will need to submit patch to freemarker.org
   20552: Merged BRANCHES/V3.2 to BRANCHES/V3.3 (RECORD ONLY)
      20551: (RECORD ONLY) Merged BRANCHES/V3.3 to BRANCHES/V3.2:
         20090: Dynamic models: minor improvements to DictionaryModelType
   20553: Fix for escalated issue ALF-2856: Space returns to browse view after completing Add Content dialog; need a way to return to custom view (applied patch provided by customer).
   20554: Improvement to model delete validation (investigating intermittent failure of RepoAdminServiceImplTest.testSimpleDynamicModelViaNodeService)
   20558: Merged DEV/BELARUS/V3.3-2010_06_08 to V3.3
      20550: ALF-922: Mysql does not support unique keys that contain nulls as one would expect ...... duplicates in the alf_access_control_entry table
   20562: ALF-3177 - security fix.
   20563: Merged BRANCHES/V3.2 to BRANCHES/V3.3:
      19412: Fix for ALF-865 "WCM / Cluster: unexpected error when concurrently submitting content"
         ALF-862 "WCM submit execution will require locking in a clustered WCM authoring env"
   20564: Merged BRANCHES/V3.1 to BRANCHES/V3.3:
      20542: Fixed ALF-3152: ImporterComponent transaction retry settings can cause IllegalArgumentException
   20568: Follow-up on fix ALF-3152.  Fix jobLockService's retryWaitIncrementMs


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@20572 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2010-06-09 14:53:24 +00:00

861 lines
31 KiB
Java

/*
* Copyright (C) 2005-2010 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* 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/>.
*/
package org.alfresco.repo.jscript;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.StringTokenizer;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.search.impl.lucene.LuceneQueryParser;
import org.alfresco.repo.security.authentication.AuthenticationException;
import org.alfresco.repo.security.authentication.AuthenticationUtil;
import org.alfresco.repo.security.authentication.UserNameGenerator;
import org.alfresco.repo.security.authority.AuthorityDAO;
import org.alfresco.repo.security.sync.UserRegistrySynchronizer;
import org.alfresco.repo.tenant.TenantService;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.cmr.search.LimitBy;
import org.alfresco.service.cmr.search.ResultSet;
import org.alfresco.service.cmr.search.SearchParameters;
import org.alfresco.service.cmr.search.SearchService;
import org.alfresco.service.cmr.security.AuthorityService;
import org.alfresco.service.cmr.security.AuthorityType;
import org.alfresco.service.cmr.security.MutableAuthenticationService;
import org.alfresco.service.cmr.security.PersonService;
import org.alfresco.service.cmr.usage.ContentUsageService;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.springframework.extensions.surf.util.ParameterCheck;
import org.alfresco.util.PropertyMap;
import org.alfresco.util.ValueDerivingMapFactory;
import org.alfresco.util.ValueDerivingMapFactory.ValueDeriver;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.mozilla.javascript.Context;
import org.mozilla.javascript.Scriptable;
import org.springframework.beans.factory.InitializingBean;
/**
* Scripted People service for describing and executing actions against People & Groups.
*
* @author davidc
* @author kevinr
*/
public final class People extends BaseScopableProcessorExtension implements InitializingBean
{
private static Log logger = LogFactory.getLog(People.class);
/** Repository Service Registry */
private ServiceRegistry services;
private AuthorityDAO authorityDAO;
private AuthorityService authorityService;
private PersonService personService;
private MutableAuthenticationService authenticationService;
private ContentUsageService contentUsageService;
private TenantService tenantService;
private UserNameGenerator usernameGenerator;
private UserRegistrySynchronizer userRegistrySynchronizer;
private StoreRef storeRef;
private ValueDerivingMapFactory<ScriptNode, String, Boolean> valueDerivingMapFactory;
private int numRetries = 10;
public void afterPropertiesSet() throws Exception
{
Map <String, ValueDeriver<ScriptNode, Boolean>> capabilityTesters = new HashMap<String, ValueDeriver<ScriptNode, Boolean>>(5);
capabilityTesters.put("isAdmin", new ValueDeriver<ScriptNode, Boolean>()
{
public Boolean deriveValue(ScriptNode source)
{
return isAdmin(source);
}
});
capabilityTesters.put("isGuest", new ValueDeriver<ScriptNode, Boolean>()
{
public Boolean deriveValue(ScriptNode source)
{
return isGuest(source);
}
});
capabilityTesters.put("isMutable", new ValueDeriver<ScriptNode, Boolean>()
{
public Boolean deriveValue(ScriptNode source)
{
// Check whether the account is mutable according to the authentication service
String sourceUser = (String) source.getProperties().get(ContentModel.PROP_USERNAME);
if (!authenticationService.isAuthenticationMutable(sourceUser))
{
return false;
}
// Only allow non-admin users to mutate their own accounts
String currentUser = authenticationService.getCurrentUserName();
if (currentUser.equals(sourceUser) || authorityService.isAdminAuthority(currentUser))
{
return true;
}
return false;
}
});
this.valueDerivingMapFactory = new ValueDerivingMapFactory<ScriptNode, String, Boolean>(capabilityTesters);
}
/**
* Set the default store reference
*
* @param storeRef the default store reference
*/
public void setStoreUrl(String storeRef)
{
// ensure this is not set again by a script instance
if (this.storeRef != null)
{
throw new IllegalStateException("Default store URL can only be set once.");
}
this.storeRef = new StoreRef(storeRef);
}
/**
* Sets the authentication service.
*
* @param authenticationService
* the authentication service
*/
public void setAuthenticationService(MutableAuthenticationService authenticationService)
{
this.authenticationService = authenticationService;
}
/**
* Set the service registry
*
* @param serviceRegistry the service registry
*/
public void setServiceRegistry(ServiceRegistry serviceRegistry)
{
this.services = serviceRegistry;
}
/**
* Set the authority DAO
*
* @param authorityDAO authority dao
*/
public void setAuthorityDAO(AuthorityDAO authorityDAO)
{
this.authorityDAO = authorityDAO;
}
/**
* Set the authority service
*
* @param authorityService The authorityService to set.
*/
public void setAuthorityService(AuthorityService authorityService)
{
this.authorityService = authorityService;
}
/**
* Set the person service
*
* @param personService The personService to set.
*/
public void setPersonService(PersonService personService)
{
this.personService = personService;
}
/**
* @param contentUsageService the ContentUsageService to set
*/
public void setContentUsageService(ContentUsageService contentUsageService)
{
this.contentUsageService = contentUsageService;
}
/**
* @param tenantService the tenantService to set
*/
public void setTenantService(TenantService tenantService)
{
this.tenantService = tenantService;
}
/**
* Set the user name generator service
*
* @param userNameGenerator the user name generator
*/
public void setUserNameGenerator(UserNameGenerator userNameGenerator)
{
this.usernameGenerator = userNameGenerator;
}
/**
* Set the UserRegistrySynchronizer
*
* @param userRegistrySynchronizer
*/
public void setUserRegistrySynchronizer(UserRegistrySynchronizer userRegistrySynchronizer)
{
this.userRegistrySynchronizer = userRegistrySynchronizer;
}
/**
* Delete a Person with the given username
*
* @param username the username of the person to delete
*/
public void deletePerson(String username)
{
personService.deletePerson(username);
}
/**
* Create a Person with an optionally generated user name
*
* @param userName userName or null for a generated user name
* @param firstName firstName
* @param lastName lastName
* @param emailAddress emailAddress
* @param password if not null creates a new authenticator with the given password.
* @param setAccountEnabled
* set to 'true' to create enabled user account, or 'false' to
* create disabled user account for created person.
* @return the person node (type cm:person) created or null if the person
* could not be created
*/
public ScriptNode createPerson(String userName, String firstName, String lastName, String emailAddress, String password, boolean setAccountEnabled)
{
ParameterCheck.mandatory("firstName", firstName);
ParameterCheck.mandatory("lastName", lastName);
ParameterCheck.mandatory("emailAddress", emailAddress);
ScriptNode person = null;
// generate user name if not supplied
if (userName == null)
{
for (int i=0; i < numRetries; i++)
{
userName = usernameGenerator.generateUserName(firstName, lastName, emailAddress, i);
// create person if user name does not already exist
if (!personService.personExists(userName))
{
break;
}
}
}
if (userName != null)
{
if (tenantService.isEnabled())
{
String currentDomain = tenantService.getCurrentUserDomain();
if (! currentDomain.equals(TenantService.DEFAULT_DOMAIN))
{
if (! tenantService.isTenantUser(userName))
{
// force domain onto the end of the username
userName = tenantService.getDomainUser(userName, currentDomain);
logger.warn("Added domain to username: " + userName);
}
else
{
try
{
tenantService.checkDomainUser(userName);
}
catch (RuntimeException re)
{
throw new AuthenticationException("User must belong to same domain as admin: " + currentDomain);
}
}
}
}
person = createPerson(userName, firstName, lastName, emailAddress);
if (person != null && password != null)
{
// create account for person with the userName and password
authenticationService.createAuthentication(userName, password.toCharArray());
authenticationService.setAuthenticationEnabled(userName, setAccountEnabled);
person.save();
}
}
return person;
}
/**
* Enable user account. Can only be called by an Admin authority.
*
* @param userName user name for which to enable user account
*/
public void enableAccount(String userName)
{
if (this.authorityService.isAdminAuthority(AuthenticationUtil.getFullyAuthenticatedUser()))
{
this.authenticationService.setAuthenticationEnabled(userName, true);
}
}
/**
* Disable user account. Can only be called by an Admin authority.
*
* @param userName user name for which to disable user account
*/
public void disableAccount(String userName)
{
if (this.authorityService.isAdminAuthority(AuthenticationUtil.getFullyAuthenticatedUser()))
{
this.authenticationService.setAuthenticationEnabled(userName, false);
}
}
/**
* Return true if the specified user account is enabled.
*
* @param userName user name to test account
*
* @return true if account enabled, false if disabled
*/
public boolean isAccountEnabled(String userName)
{
return this.authenticationService.getAuthenticationEnabled(userName);
}
/**
* Change the password for the currently logged in user.
* Old password must be supplied.
*
* @param oldPassword Old user password
* @param newPassword New user password
*/
public void changePassword(String oldPassword, String newPassword)
{
ParameterCheck.mandatoryString("oldPassword", oldPassword);
ParameterCheck.mandatoryString("newPassword", newPassword);
this.services.getAuthenticationService().updateAuthentication(
AuthenticationUtil.getFullyAuthenticatedUser(), oldPassword.toCharArray(), newPassword.toCharArray());
}
/**
* Set a password for the given user. Note that only an administrator
* can perform this action, otherwise it will be ignored.
*
* @param userName Username to change password for
* @param password Password to set
*/
public void setPassword(String userName, String password)
{
ParameterCheck.mandatoryString("userName", userName);
ParameterCheck.mandatoryString("password", password);
MutableAuthenticationService authService = this.services.getAuthenticationService();
if (this.authorityService.hasAdminAuthority() && (userName.equalsIgnoreCase(authService.getCurrentUserName()) == false))
{
authService.setAuthentication(userName, password.toCharArray());
}
}
/**
* Create a Person with the given user name
*
* @param userName the user name of the person to create
* @return the person node (type cm:person) created or null if the user name already exists
*/
public ScriptNode createPerson(String userName)
{
ParameterCheck.mandatoryString("userName", userName);
ScriptNode person = null;
PropertyMap properties = new PropertyMap();
properties.put(ContentModel.PROP_USERNAME, userName);
if (!personService.personExists(userName))
{
NodeRef personRef = personService.createPerson(properties);
person = new ScriptNode(personRef, services, getScope());
}
return person;
}
/**
* Create a Person with the given user name, firstName, lastName and emailAddress
*
* @param userName the user name of the person to create
* @return the person node (type cm:person) created or null if the user name already exists
*/
public ScriptNode createPerson(String userName, String firstName, String lastName, String emailAddress)
{
ParameterCheck.mandatoryString("userName", userName);
ParameterCheck.mandatoryString("firstName", firstName);
ParameterCheck.mandatoryString("lastName", lastName);
ParameterCheck.mandatoryString("emailAddress", emailAddress);
ScriptNode person = null;
PropertyMap properties = new PropertyMap();
properties.put(ContentModel.PROP_USERNAME, userName);
properties.put(ContentModel.PROP_FIRSTNAME, firstName);
properties.put(ContentModel.PROP_LASTNAME, lastName);
properties.put(ContentModel.PROP_EMAIL, emailAddress);
if (!personService.personExists(userName))
{
NodeRef personRef = personService.createPerson(properties);
person = new ScriptNode(personRef, services, getScope());
}
return person;
}
/**
* Set the content quota in bytes for a person.
* Only the admin authority can set this value.
*
* @param person Person to set quota against.
* @param quota As a string, in bytes, a value of "-1" means no quota is set
*/
public void setQuota(ScriptNode person, String quota)
{
if (this.authorityService.isAdminAuthority(AuthenticationUtil.getFullyAuthenticatedUser()))
{
this.contentUsageService.setUserQuota((String)person.getProperties().get(ContentModel.PROP_USERNAME), Long.parseLong(quota));
}
}
/**
* Get the collection of people stored in the repository.
* An optional filter query may be provided by which to filter the people collection.
* Space separate the query terms i.e. "john bob" will find all users who's first or
* second names contain the strings "john" or "bob".
*
* @param filter filter query string by which to filter the collection of people.
* If <pre>null</pre> then all people stored in the repository are returned
*
* @return people collection as a JavaScript array
*/
public Scriptable getPeople(String filter)
{
return getPeople(filter, 0);
}
/**
* Get the collection of people stored in the repository.
* An optional filter query may be provided by which to filter the people collection.
* Space separate the query terms i.e. "john bob" will find all users who's first or
* second names contain the strings "john" or "bob".
*
* @param filter filter query string by which to filter the collection of people.
* If <pre>null</pre> then all people stored in the repository are returned
* @param maxResults maximum results to return or all if <= 0
*
* @return people collection as a JavaScript array
*/
public Scriptable getPeople(String filter, int maxResults)
{
Object[] people = null;
if (filter == null || filter.length() == 0)
{
people = personService.getAllPeople().toArray();
if (maxResults > 0 && people.length > maxResults)
{
Object[] dest = new Object[maxResults];
System.arraycopy(people, 0, dest, 0, maxResults);
people = dest;
}
}
else
{
filter = filter.trim();
if (filter.length() != 0)
{
// define the query to find people by their first or last name
StringBuilder query = new StringBuilder(128);
for (StringTokenizer t = new StringTokenizer(filter, " "); t.hasMoreTokens(); /**/)
{
String term = LuceneQueryParser.escape(t.nextToken().replace('"', ' '));
query.append("@").append(NamespaceService.CONTENT_MODEL_PREFIX).append("\\:firstName:\"*");
query.append(term);
query.append("*\" @").append(NamespaceService.CONTENT_MODEL_PREFIX).append("\\:lastName:\"*");
query.append(term);
query.append("*\" @").append(NamespaceService.CONTENT_MODEL_PREFIX).append("\\:userName:\"*");
query.append(term);
query.append("*\" ");
}
// define the search parameters
SearchParameters params = new SearchParameters();
params.setLanguage(SearchService.LANGUAGE_LUCENE);
params.addStore(this.storeRef);
params.setQuery(query.toString());
if (maxResults > 0)
{
params.setLimitBy(LimitBy.FINAL_SIZE);
params.setLimit(maxResults);
}
ResultSet results = null;
try
{
results = services.getSearchService().query(params);
people = results.getNodeRefs().toArray();
}
finally
{
if (results != null)
{
results.close();
}
}
}
}
if (people == null)
{
people = new Object[0];
}
return Context.getCurrentContext().newArray(getScope(), people);
}
/**
* Gets the Person given the username
*
* @param username the username of the person to get
* @return the person node (type cm:person) or null if no such person exists
*/
public ScriptNode getPerson(String username)
{
ParameterCheck.mandatoryString("Username", username);
ScriptNode person = null;
if (personService.personExists(username))
{
NodeRef personRef = personService.getPerson(username);
person = new ScriptNode(personRef, services, getScope());
}
return person;
}
/**
* Gets the Group given the group name
*
* @param groupName name of group to get
* @return the group node (type usr:authorityContainer) or null if no such group exists
*/
public ScriptNode getGroup(String groupName)
{
ParameterCheck.mandatoryString("GroupName", groupName);
ScriptNode group = null;
NodeRef groupRef = authorityDAO.getAuthorityNodeRefOrNull(groupName);
if (groupRef != null)
{
group = new ScriptNode(groupRef, services, getScope());
}
return group;
}
/**
* Deletes a group from the system.
*
* @param group The group to delete
*/
public void deleteGroup(ScriptNode group)
{
ParameterCheck.mandatory("Group", group);
if (group.getQNameType().equals(ContentModel.TYPE_AUTHORITY_CONTAINER))
{
String groupName = (String)group.getProperties().get(ContentModel.PROP_AUTHORITY_NAME);
authorityService.deleteAuthority(groupName);
}
}
/**
* Create a new root level group with the specified unique name
*
* @param groupName The unique group name to create - NOTE: do not prefix with "GROUP_"
*
* @return the group reference if successful or null if failed
*/
public ScriptNode createGroup(String groupName)
{
return createGroup(null, groupName);
}
/**
* Create a new group with the specified unique name
*
* @param parentGroup The parent group node - can be null for a root level group
* @param groupName The unique group name to create - NOTE: do not prefix with "GROUP_"
*
* @return the group reference if successful or null if failed
*/
public ScriptNode createGroup(ScriptNode parentGroup, String groupName)
{
ParameterCheck.mandatoryString("GroupName", groupName);
ScriptNode group = null;
String actualName = services.getAuthorityService().getName(AuthorityType.GROUP, groupName);
if (authorityService.authorityExists(actualName) == false)
{
String result = authorityService.createAuthority(AuthorityType.GROUP, groupName);
if (parentGroup != null)
{
String parentGroupName = (String)parentGroup.getProperties().get(ContentModel.PROP_AUTHORITY_NAME);
if (parentGroupName != null)
{
authorityService.addAuthority(parentGroupName, actualName);
}
}
group = getGroup(result);
}
return group;
}
/**
* Add an authority (a user or group) to a group container as a new child
*
* @param parentGroup The parent container group
* @param authority The authority (user or group) to add
*/
public void addAuthority(ScriptNode parentGroup, ScriptNode authority)
{
ParameterCheck.mandatory("Authority", authority);
ParameterCheck.mandatory("ParentGroup", parentGroup);
if (parentGroup.getQNameType().equals(ContentModel.TYPE_AUTHORITY_CONTAINER))
{
String parentGroupName = (String)parentGroup.getProperties().get(ContentModel.PROP_AUTHORITY_NAME);
String authorityName;
if (authority.getQNameType().equals(ContentModel.TYPE_AUTHORITY_CONTAINER))
{
authorityName = (String)authority.getProperties().get(ContentModel.PROP_AUTHORITY_NAME);
}
else
{
authorityName = (String)authority.getProperties().get(ContentModel.PROP_USERNAME);
}
authorityService.addAuthority(parentGroupName, authorityName);
}
}
/**
* Remove an authority (a user or group) from a group
*
* @param parentGroup The parent container group
* @param authority The authority (user or group) to remove
*/
public void removeAuthority(ScriptNode parentGroup, ScriptNode authority)
{
ParameterCheck.mandatory("Authority", authority);
ParameterCheck.mandatory("ParentGroup", parentGroup);
if (parentGroup.getQNameType().equals(ContentModel.TYPE_AUTHORITY_CONTAINER))
{
String parentGroupName = (String)parentGroup.getProperties().get(ContentModel.PROP_AUTHORITY_NAME);
String authorityName;
if (authority.getQNameType().equals(ContentModel.TYPE_AUTHORITY_CONTAINER))
{
authorityName = (String)authority.getProperties().get(ContentModel.PROP_AUTHORITY_NAME);
}
else
{
authorityName = (String)authority.getProperties().get(ContentModel.PROP_USERNAME);
}
authorityService.removeAuthority(parentGroupName, authorityName);
}
}
/**
* Gets the members (people) of a group (including all sub-groups)
*
* @param group the group to retrieve members for
* @param recurse recurse into sub-groups
*
* @return members of the group as a JavaScript array
*/
public Scriptable getMembers(ScriptNode group)
{
ParameterCheck.mandatory("Group", group);
Object[] members = getContainedAuthorities(group, AuthorityType.USER, true);
return Context.getCurrentContext().newArray(getScope(), members);
}
/**
* Gets the members (people) of a group
*
* @param group the group to retrieve members for
* @param recurse recurse into sub-groups
*
* @return the members of the group as a JavaScript array
*/
public Scriptable getMembers(ScriptNode group, boolean recurse)
{
ParameterCheck.mandatory("Group", group);
Object[] members = getContainedAuthorities(group, AuthorityType.USER, recurse);
return Context.getCurrentContext().newArray(getScope(), members);
}
/**
* Gets the groups that contain the specified authority
*
* @param person the user (cm:person) to get the containing groups for
*
* @return the containing groups as a JavaScript array
*/
public Scriptable getContainerGroups(ScriptNode person)
{
ParameterCheck.mandatory("Person", person);
Object[] parents = null;
Set<String> authorities = this.authorityService.getContainingAuthorities(
AuthorityType.GROUP,
(String)person.getProperties().get(ContentModel.PROP_USERNAME),
false);
parents = new Object[authorities.size()];
int i = 0;
for (String authority : authorities)
{
ScriptNode group = getGroup(authority);
if (group != null)
{
parents[i++] = group;
}
}
return Context.getCurrentContext().newArray(getScope(), parents);
}
/**
* Return true if the specified user is an Administrator authority.
*
* @param person to test
*
* @return true if an admin, false otherwise
*/
public boolean isAdmin(ScriptNode person)
{
ParameterCheck.mandatory("Person", person);
return this.authorityService.isAdminAuthority((String)person.getProperties().get(ContentModel.PROP_USERNAME));
}
/**
* Return true if the specified user is an guest authority.
*
* @param person to test
*
* @return true if an admin, false otherwise
*/
public boolean isGuest(ScriptNode person)
{
ParameterCheck.mandatory("Person", person);
return this.authorityService.isGuestAuthority((String) person.getProperties().get(ContentModel.PROP_USERNAME));
}
/**
* Gets a map of capabilities (boolean assertions) for the given person.
*
* @param person
* the person
* @return the capability map
*/
public Map<String, Boolean> getCapabilities(final ScriptNode person)
{
ParameterCheck.mandatory("Person", person);
Map<String,Boolean> retVal = new ScriptableHashMap<String, Boolean>();
retVal.putAll(this.valueDerivingMapFactory.getMap(person));
return retVal;
}
/**
* Return a map of the Person properties that are marked as immutable for the given user.
* This enables a script to interogate which properties are dealt with by an external
* system such as LDAP and should not be mutable in any client UI.
*
* @param username
*
* @return ScriptableHashMap
*/
public ScriptableHashMap getImmutableProperties(String username)
{
Set<QName> props = userRegistrySynchronizer.getPersonMappedProperties(username);
ScriptableHashMap propMap = new ScriptableHashMap();
for (QName prop : props)
{
propMap.put(prop.toString(), Boolean.TRUE);
}
return propMap;
}
/**
* Get Contained Authorities
*
* @param container authority containers
* @param type authority type to filter by
* @param recurse recurse into sub-containers
*
* @return contained authorities
*/
private Object[] getContainedAuthorities(ScriptNode container, AuthorityType type, boolean recurse)
{
Object[] members = null;
if (container.getQNameType().equals(ContentModel.TYPE_AUTHORITY_CONTAINER))
{
String groupName = (String)container.getProperties().get(ContentModel.PROP_AUTHORITY_NAME);
Set<String> authorities = authorityService.getContainedAuthorities(type, groupName, !recurse);
members = new Object[authorities.size()];
int i = 0;
for (String authority : authorities)
{
AuthorityType authorityType = AuthorityType.getAuthorityType(authority);
if (authorityType.equals(AuthorityType.GROUP))
{
ScriptNode group = getGroup(authority);
if (group != null)
{
members[i++] = group;
}
}
else if (authorityType.equals(AuthorityType.USER))
{
ScriptNode person = getPerson(authority);
if (person != null)
{
members[i++] = person;
}
}
}
}
return members != null ? members : new Object[0];
}
}