001/*
002 *  Copyright 2020 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.plugins.workspaces.project;
017
018import java.time.ZonedDateTime;
019import java.util.ArrayList;
020import java.util.Arrays;
021import java.util.Collection;
022import java.util.Collections;
023import java.util.HashMap;
024import java.util.HashSet;
025import java.util.Iterator;
026import java.util.LinkedHashSet;
027import java.util.List;
028import java.util.Map;
029import java.util.Objects;
030import java.util.Optional;
031import java.util.Set;
032import java.util.function.Predicate;
033import java.util.regex.Pattern;
034import java.util.stream.Collectors;
035import java.util.stream.Stream;
036import java.util.stream.StreamSupport;
037
038import javax.jcr.Node;
039import javax.jcr.PathNotFoundException;
040import javax.jcr.Property;
041import javax.jcr.RepositoryException;
042import javax.jcr.Session;
043import javax.jcr.Value;
044
045import org.apache.avalon.framework.activity.Initializable;
046import org.apache.avalon.framework.component.Component;
047import org.apache.avalon.framework.context.Context;
048import org.apache.avalon.framework.context.ContextException;
049import org.apache.avalon.framework.context.Contextualizable;
050import org.apache.avalon.framework.logger.AbstractLogEnabled;
051import org.apache.avalon.framework.service.ServiceException;
052import org.apache.avalon.framework.service.ServiceManager;
053import org.apache.avalon.framework.service.Serviceable;
054import org.apache.cocoon.components.ContextHelper;
055import org.apache.cocoon.environment.Request;
056import org.apache.commons.collections.CollectionUtils;
057import org.apache.commons.lang3.ArrayUtils;
058import org.apache.commons.lang3.StringUtils;
059import org.apache.commons.lang3.tuple.Pair;
060
061import org.ametys.cms.tag.Tag;
062import org.ametys.core.cache.AbstractCacheManager;
063import org.ametys.core.cache.AbstractCacheManager.CacheType;
064import org.ametys.core.cache.Cache;
065import org.ametys.core.cache.CacheException;
066import org.ametys.core.group.GroupDirectoryContextHelper;
067import org.ametys.core.group.GroupIdentity;
068import org.ametys.core.observation.Event;
069import org.ametys.core.observation.ObservationManager;
070import org.ametys.core.observation.Observer;
071import org.ametys.core.right.RightManager;
072import org.ametys.core.right.RightManager.RightResult;
073import org.ametys.core.ui.Callable;
074import org.ametys.core.user.CurrentUserProvider;
075import org.ametys.core.user.UserIdentity;
076import org.ametys.core.user.population.PopulationContextHelper;
077import org.ametys.core.util.I18nUtils;
078import org.ametys.core.util.LambdaUtils;
079import org.ametys.plugins.core.impl.cache.AbstractCacheKey;
080import org.ametys.plugins.core.search.UserAndGroupSearchManager;
081import org.ametys.plugins.core.user.UserHelper;
082import org.ametys.plugins.explorer.ExplorerNode;
083import org.ametys.plugins.explorer.resources.ModifiableResourceCollection;
084import org.ametys.plugins.repository.AmetysObject;
085import org.ametys.plugins.repository.AmetysObjectIterable;
086import org.ametys.plugins.repository.AmetysObjectResolver;
087import org.ametys.plugins.repository.AmetysRepositoryException;
088import org.ametys.plugins.repository.CollectionIterable;
089import org.ametys.plugins.repository.ModifiableAmetysObject;
090import org.ametys.plugins.repository.ModifiableTraversableAmetysObject;
091import org.ametys.plugins.repository.RepositoryConstants;
092import org.ametys.plugins.repository.UnknownAmetysObjectException;
093import org.ametys.plugins.repository.jcr.JCRAmetysObject;
094import org.ametys.plugins.repository.jcr.NodeTypeHelper;
095import org.ametys.plugins.repository.provider.AbstractRepository;
096import org.ametys.plugins.repository.provider.JackrabbitRepository;
097import org.ametys.plugins.repository.provider.WorkspaceSelector;
098import org.ametys.plugins.repository.query.expression.Expression;
099import org.ametys.plugins.repository.query.expression.Expression.Operator;
100import org.ametys.plugins.repository.query.expression.StringExpression;
101import org.ametys.plugins.workspaces.ObservationConstants;
102import org.ametys.plugins.workspaces.catalog.CatalogSiteType;
103import org.ametys.plugins.workspaces.categories.Category;
104import org.ametys.plugins.workspaces.categories.CategoryProviderExtensionPoint;
105import org.ametys.plugins.workspaces.keywords.KeywordProviderExtensionPoint;
106import org.ametys.plugins.workspaces.members.JCRProjectMember;
107import org.ametys.plugins.workspaces.members.JCRProjectMember.MemberType;
108import org.ametys.plugins.workspaces.members.ProjectMemberManager;
109import org.ametys.plugins.workspaces.members.ProjectMemberManager.ProjectMember;
110import org.ametys.plugins.workspaces.project.modules.WorkspaceModule;
111import org.ametys.plugins.workspaces.project.modules.WorkspaceModuleExtensionPoint;
112import org.ametys.plugins.workspaces.project.objects.Project;
113import org.ametys.plugins.workspaces.project.objects.Project.InscriptionStatus;
114import org.ametys.plugins.workspaces.project.rights.ProjectRightHelper;
115import org.ametys.plugins.workspaces.util.StatisticColumn;
116import org.ametys.plugins.workspaces.util.StatisticsColumnType;
117import org.ametys.runtime.authentication.AccessDeniedException;
118import org.ametys.runtime.config.Config;
119import org.ametys.runtime.i18n.I18nizableText;
120import org.ametys.runtime.plugin.component.PluginAware;
121import org.ametys.web.repository.page.ModifiablePage;
122import org.ametys.web.repository.page.Page;
123import org.ametys.web.repository.page.PageQueryHelper;
124import org.ametys.web.repository.page.SitemapElement;
125import org.ametys.web.repository.page.ZoneItem;
126import org.ametys.web.repository.site.Site;
127import org.ametys.web.repository.site.SiteDAO;
128import org.ametys.web.repository.site.SiteManager;
129import org.ametys.web.repository.sitemap.Sitemap;
130import org.ametys.web.site.SiteConfigurationManager;
131
132/**
133 * Helper component for managing project workspaces
134 */
135public class ProjectManager extends AbstractLogEnabled implements Serviceable, Component, Contextualizable, PluginAware, Initializable, Observer
136{
137    /** Avalon Role */
138    public static final String ROLE = ProjectManager.class.getName();
139    
140    /** Constant for the {@link Cache} id (the {@link Cache} is in {@link CacheType#REQUEST REQUEST} attribute) for the {@link Project}s objects
141     *  in cache by {@link RequestProjectCacheKey} (composition of project name and workspace name). */
142    public static final String REQUEST_PROJECTBYID_CACHE = ProjectManager.class.getName() + "$ProjectById";
143    
144    /** Constant for the {@link Cache} id for the {@link Project} ids (as {@link String}s) in cache by project name (for whole application). */
145    public static final String MEMORY_PROJECTIDBYNAMECACHE = ProjectManager.class.getName() + "$UUID";
146
147    /** Constant for the {@link Cache} id (the {@link Cache} is in {@link CacheType#REQUEST REQUEST} attribute) for the {@link Page}s objects
148     *  in cache by {@link RequestModuleCacheKey} (composition of project name and module name). */
149    public static final String REQUEST_PAGESBYPROJECTANDMODULE_CACHE = ProjectManager.class.getName() + "$PagesByModule";
150    
151    /** Constant for the {@link Cache} id for the {@link Project} ids (as {@link String}s) in cache by project name (for whole application). */
152    public static final String MEMORY_PAGESBYIDCACHE = ProjectManager.class.getName() + "$PageUUID";
153
154    /** Constant for the {@link Cache} id for the {@link Project} ids (as {@link String}s) in cache by site name (for whole application). */
155    public static final String MEMORY_SITEASSOCIATION_CACHE = ProjectManager.class.getName() + "$SiteAssociation";
156
157    /** Workspaces plugin node name */
158    private static final String __WORKSPACES_PLUGIN_NODE_NAME = "workspaces";
159    
160    /** Workspaces plugin node name */
161    private static final String __WORKSPACES_PLUGIN_NODE_TYPE = RepositoryConstants.NAMESPACE_PREFIX + ":unstructured";
162    
163    /** The name of the projects root node */
164    private static final String __PROJECTS_ROOT_NODE_NAME = "projects";
165    
166    /** The type of the projects root node */
167    private static final String __PROJECTS_ROOT_NODE_TYPE = RepositoryConstants.NAMESPACE_PREFIX + ":unstructured";
168    
169    /** Constants for tags metadata */
170    private static final String __PROJECTS_TAGS_PROPERTY = RepositoryConstants.NAMESPACE_PREFIX_INTERNAL + ":tags";
171    
172    private static final String __PAGE_MODULES_VALUE = "workspaces-modules";
173
174    private static final String __IS_CACHE_FILLED = "###iscachefilled###";
175
176    /** Ametys object resolver */
177    protected AmetysObjectResolver _resolver;
178    
179    /** The i18n utils. */
180    protected I18nUtils _i18nUtils;
181    
182    /** Site manager */
183    protected SiteManager _siteManager;
184    
185    /** Site DAO */
186    protected SiteDAO _siteDao;
187    
188    /** Site configuration manager */
189    protected SiteConfigurationManager _siteConfigurationManager;
190    
191    /** Module Managers EP */
192    protected WorkspaceModuleExtensionPoint _moduleManagerEP;
193
194    /** Helper for user population */
195    protected PopulationContextHelper _populationContextHelper;
196    
197    /** Helper for group directory's context */
198    protected GroupDirectoryContextHelper _groupDirectoryContextHelper;
199    
200    /** The project members' manager */
201    protected ProjectMemberManager _projectMemberManager;
202
203    /** Avalon context */
204    protected Context _context;
205    
206    private ObservationManager _observationManager;
207    
208    private CurrentUserProvider _currentUserProvider;
209
210    private ProjectMemberManager _projectMembers;
211
212    private String _pluginName;
213
214    private ProjectRightHelper _projectRightHelper;
215
216    private CategoryProviderExtensionPoint _categoryProviderEP;
217
218    private KeywordProviderExtensionPoint _keywordProviderEP;
219    
220    private UserHelper _userHelper;
221
222    private AbstractCacheManager _cacheManager;
223
224    private UserAndGroupSearchManager _userAndGroupSearchManager;
225
226    private JackrabbitRepository _repository;
227
228    private WorkspaceSelector _workspaceSelector;
229
230    private RightManager _rightManager;
231
232    private GroupDirectoryContextHelper _directoryContextHelper;
233
234    @Override
235    public void contextualize(Context context) throws ContextException
236    {
237        _context = context;
238    }
239    
240    @Override
241    public void service(ServiceManager manager) throws ServiceException
242    {
243        _resolver = (AmetysObjectResolver) manager.lookup(AmetysObjectResolver.ROLE);
244        _repository = (JackrabbitRepository) manager.lookup(AbstractRepository.ROLE);
245        _workspaceSelector = (WorkspaceSelector) manager.lookup(WorkspaceSelector.ROLE);
246        _i18nUtils = (I18nUtils) manager.lookup(I18nUtils.ROLE);
247        _siteManager = (SiteManager) manager.lookup(SiteManager.ROLE);
248        _siteDao = (SiteDAO) manager.lookup(SiteDAO.ROLE);
249        _siteConfigurationManager = (SiteConfigurationManager) manager.lookup(SiteConfigurationManager.ROLE);
250        _projectMembers = (ProjectMemberManager) manager.lookup(ProjectMemberManager.ROLE);
251        _observationManager = (ObservationManager) manager.lookup(ObservationManager.ROLE);
252        _currentUserProvider = (CurrentUserProvider) manager.lookup(CurrentUserProvider.ROLE);
253        _moduleManagerEP = (WorkspaceModuleExtensionPoint) manager.lookup(WorkspaceModuleExtensionPoint.ROLE);
254        _projectRightHelper = (ProjectRightHelper) manager.lookup(ProjectRightHelper.ROLE);
255        _userHelper = (UserHelper) manager.lookup(UserHelper.ROLE);
256        _categoryProviderEP = (CategoryProviderExtensionPoint) manager.lookup(CategoryProviderExtensionPoint.ROLE);
257        _keywordProviderEP = (KeywordProviderExtensionPoint) manager.lookup(KeywordProviderExtensionPoint.ROLE);
258        _cacheManager = (AbstractCacheManager) manager.lookup(AbstractCacheManager.ROLE);
259        _populationContextHelper = (PopulationContextHelper) manager.lookup(PopulationContextHelper.ROLE);
260        _groupDirectoryContextHelper = (GroupDirectoryContextHelper) manager.lookup(GroupDirectoryContextHelper.ROLE);
261        _projectMemberManager = (ProjectMemberManager) manager.lookup(ProjectMemberManager.ROLE);
262        _userAndGroupSearchManager = (UserAndGroupSearchManager) manager.lookup(UserAndGroupSearchManager.ROLE);
263        _rightManager = (RightManager) manager.lookup(RightManager.ROLE);
264        _directoryContextHelper = (GroupDirectoryContextHelper) manager.lookup(GroupDirectoryContextHelper.ROLE);
265    }
266    
267    public void initialize() throws Exception
268    {
269        _createCaches();
270        _observationManager.registerObserver(this);
271    }
272    
273    @Override
274    public void setPluginInfo(String pluginName, String featureName, String id)
275    {
276        _pluginName = pluginName;
277    }
278
279    /**
280     * Enumeration for the profile to assign for new module
281     */
282    public enum ProfileForNewModule
283    {
284        /** No profile assigned for new modules */
285        NONE,
286        
287        /** Default profile assigned for new modules */
288        DEFAULT_MEMBER_PROFILE
289        
290    }
291    
292    /**
293     * Retrieves all projects
294     * @return the projects
295     */
296    public AmetysObjectIterable<Project> getProjects()
297    {
298        return getProjects(true);
299    }
300    
301    /**
302     * Retrieves all projects
303     * @param onlyWorking true to retrieve only working projects with non null sites
304     * @return the projects
305     */
306    public AmetysObjectIterable<Project> getProjects(boolean onlyWorking)
307    {
308        // As cache is computed from default JCR workspace, we need to filter on sites that exist into the current JCR workspace
309        Set<Project> projects = _getUUIDCache().values().stream()
310                .filter(_resolver::hasAmetysObjectForId)
311                .map(_resolver::<Project>resolveById)
312                // If needed, check if the site is not null, as it can happen if site was deleted from admin side
313                .filter(project -> !onlyWorking || Objects.nonNull(project.getSite()))
314                .collect(Collectors.toSet());
315        
316        return new CollectionIterable<>(projects);
317    }
318    
319    /**
320     * Retrieves projects filtered by categories
321     * @param filteredCategories the filtered categories. Can be empty to no filter by categories.
322     * @return the projects
323     */
324    public List<Project> getProjects(Set<String> filteredCategories)
325    {
326        return getProjects(filteredCategories, null, null, true);
327    }
328    
329    /**
330     * Retrieves projects filtered by categories and/or keywords
331     * @param filteredCategories the filtered categories. Can be empty to no filter by categories.
332     * @param filteredKeywords the filtered keywords. Can be empty to no filter by keywords.
333     * @param anyMatch true to get projects matching categories OR keywords OR pattern
334     * @return the projects
335     */
336    public List<Project> getProjects(Set<String> filteredCategories, Set<String> filteredKeywords, boolean anyMatch)
337    {
338        return getProjects(filteredCategories, filteredKeywords, null, anyMatch);
339    }
340    
341    /**
342     * Retrieves projects filtered by categories and/or keywords and/or pattern
343     * @param filteredCategories the filtered categories. Can be empty to no filter by categories.
344     * @param filteredKeywords the filtered keywords. Can be empty to no filter by keywords.
345     * @param pattern to filter on pattern. Can be null or empty to no filter on pattern
346     * @param anyMatch true to get projects matching categories OR keywords OR pattern
347     * @return the projects
348     */
349    public List<Project> getProjects(Set<String> filteredCategories, Set<String> filteredKeywords, String pattern, boolean anyMatch)
350    {
351        return getProjects(filteredCategories, filteredKeywords, null, anyMatch, false);
352    }
353    
354    /**
355     * Retrieves projects filtered by categories and/or keywords and/or pattern
356     * @param filteredCategories the filtered categories. Can be null or empty to no filter by categories.
357     * @param filteredKeywords the filtered keywords. Can be empty to no filter by keywords.
358     * @param pattern to filter on pattern. Can be null or empty to no filter on pattern
359     * @param anyMatch true to get projects matching categories OR keywords OR pattern
360     * @param excludePrivate true to exclude private projects
361     * @return the projects
362     */
363    public List<Project> getProjects(Set<String> filteredCategories, Set<String> filteredKeywords, String pattern, boolean anyMatch, boolean excludePrivate)
364    {
365        List<Predicate<Project>> filters = new ArrayList<>();
366        if (filteredCategories != null && !filteredCategories.isEmpty())
367        {
368            filters.add(p -> !Collections.disjoint(p.getCategories(), filteredCategories));
369        }
370
371        if (filteredKeywords != null && !filteredKeywords.isEmpty())
372        {
373            filters.add(p -> !Collections.disjoint(Arrays.asList(p.getKeywords()), filteredKeywords));
374        }
375
376        Pattern patternFilter = StringUtils.isNotEmpty(pattern) ? Pattern.compile(pattern, Pattern.CASE_INSENSITIVE) : null;
377        if (patternFilter != null)
378        {
379            filters.add(p -> p.getTitle() != null && patternFilter.matcher(p.getTitle()).find() || p.getDescription() != null && patternFilter.matcher(p.getDescription()).find());
380        }
381
382        Predicate<Project> fullMatch = filters.stream().reduce(anyMatch ? Predicate::or : Predicate::and).orElse(p -> Boolean.TRUE);
383        Predicate<Project> matchStatus = p ->  !excludePrivate || p.getInscriptionStatus() != InscriptionStatus.PRIVATE;
384        
385        return getProjects()
386                .stream()
387                .filter(matchStatus)
388                .filter(fullMatch)
389                .collect(Collectors.toList());
390    }
391    
392    /**
393     * Get the projects categories
394     * @return the projects categories
395     */
396    public Set<Category> getProjectsCategories()
397    {
398        return getProjects().stream()
399            .map(Project::getCategories)
400            .flatMap(Collection::stream)
401            .map(id -> _categoryProviderEP.getTag(id, null))
402            .filter(Objects::nonNull)
403            .collect(Collectors.toSet());
404    }
405    
406    /**
407     * Get the user's projects categories
408     * @param user the user
409     * @return the user's projects categories
410     */
411    public Set<Category> getUserProjectsCategories(UserIdentity user)
412    {
413        return getUserProjects(user).keySet()
414                .stream()
415                .map(Project::getCategories)
416                .flatMap(Collection::stream)
417                .map(id -> _categoryProviderEP.getTag(id, null))
418                .filter(Objects::nonNull)
419                .collect(Collectors.toSet());
420    }
421    
422    /**
423     * Get the projects modules
424     * @return the projects modules
425     */
426    public Set<WorkspaceModule> getProjectsModules()
427    {
428        return getProjects().stream()
429            .map(Project::getModules)
430            .flatMap(Arrays::stream)
431            .map(id -> _moduleManagerEP.<WorkspaceModule>getModule(id))
432            .filter(Objects::nonNull)
433            .collect(Collectors.toSet());
434    }
435    
436    /**
437     * Get the projects modules for new members (depending on the project configuration)
438     * @param project the project
439     * @return the project modules
440     */
441    public Set<WorkspaceModule> getProjectModulesForNewMembers(Project project)
442    {
443        Site projectSite = project.getSite();
444        
445        // Check if project site overrides catalog configuration
446        String membersModulesPolicy = projectSite.getValue(ProjectWorkspaceSiteType.PROJECT_OVERRIDE_MEMBERS_MODULES_POLICY_SITE_PARAM, false, ProjectWorkspaceSiteType.MembersModulesPolicy.GLOBAL.name());
447
448        String membersModulesAsString = null;
449        if (membersModulesPolicy.equals(ProjectWorkspaceSiteType.MembersModulesPolicy.MEMBERS_MODULES_BY_PROJECT.name()))
450        {
451            membersModulesAsString = projectSite.getValue(ProjectWorkspaceSiteType.PROJECT_MEMBERS_MODULES_PROJECT_SITE_PARAM);
452        }
453        else
454        {
455            Site catalogSite = _siteManager.getSite(getCatalogSiteName());
456            // Use #hasValueOrEmpty because we can't use #getValue with a default value. Indeed, the #getValue use the default value for null value or empty value.
457            membersModulesAsString = catalogSite.hasValueOrEmpty(CatalogSiteType.PROJECT_MEMBERS_MODULES_SITE_PARAM) 
458                    ? catalogSite.getValue(CatalogSiteType.PROJECT_MEMBERS_MODULES_SITE_PARAM) 
459                    : String.join(",", _moduleManagerEP.getExtensionsIds());
460        }
461        
462        String[] membersModuleIds = StringUtils.split(StringUtils.defaultString(membersModulesAsString), ",");
463        
464        Set<WorkspaceModule> modules = new HashSet<>();
465        for (String moduleId : membersModuleIds)
466        {
467            if (StringUtils.isNotBlank(moduleId))
468            {
469                WorkspaceModule module = _moduleManagerEP.getModule(moduleId.trim());
470                modules.add(module);
471            }
472        }
473        return modules;
474    }
475    
476    /**
477     * Get the projects modules
478     * @param user the user
479     * @return the projects modules
480     */
481    public Set<WorkspaceModule> getUserProjectsModules(UserIdentity user)
482    {
483        return getUserProjects(user).keySet()
484            .stream()
485            .map(Project::getModules)
486            .flatMap(Arrays::stream)
487            .map(id -> _moduleManagerEP.<WorkspaceModule>getModule(id))
488            .filter(Objects::nonNull)
489            .collect(Collectors.toSet());
490    }
491    
492    /**
493     * Retrieves all projects for client side
494     * @return the projects
495     */
496    @Callable(rights = "Runtime_Rights_Admin_Access", context = "/admin")
497    public List<Map<String, Object>> getProjectsForClientSide()
498    {
499        return getProjects(false)
500                .stream()
501                .map(p -> getProjectProperties(p))
502                .collect(Collectors.toList());
503    }
504    
505    
506    /**
507     * Retrieves a project by its name
508     * @param projectName The project name
509     * @return the project or <code>null</code> if not found
510     */
511    public Project getProject(String projectName)
512    {
513        if (StringUtils.isBlank(projectName))
514        {
515            return null;
516        }
517        
518        Request request = _getRequest();
519        if (request == null)
520        {
521            // There is no request to store cache
522            return _computeProject(projectName);
523        }
524        
525        Cache<RequestProjectCacheKey, Project> projectsCache = _getRequestProjectCache();
526        
527        // The site key in the cache is of the form {site + workspace}.
528        String currentWorkspace = _workspaceSelector.getWorkspace();
529        RequestProjectCacheKey projectKey = RequestProjectCacheKey.of(projectName, currentWorkspace);
530        
531        try
532        {
533            Project project = projectsCache.get(projectKey, __ -> _computeProject(projectName));
534            return project;
535        }
536        catch (CacheException e)
537        {
538            if (e.getCause() instanceof UnknownAmetysObjectException)
539            {
540                throw new UnknownAmetysObjectException(e.getMessage());
541            }
542            else
543            {
544                throw e;
545            }
546        }
547    }
548    
549    /**
550     * Get the user's projects
551     * @param user the user
552     * @return the user's projects
553     */
554    public Map<Project, MemberType> getUserProjects(UserIdentity user)
555    {
556        return getUserProjects(user, Set.of());
557    }
558    
559    /**
560     * Get the user's projects filtered by categories
561     * @param user the user
562     * @param filteredCategories the filtered categories. Can be empty to no filter by categories
563     * @return the user's projects
564     */
565    public Map<Project, MemberType> getUserProjects(UserIdentity user, Set<String> filteredCategories)
566    {
567        return getUserProjects(user, filteredCategories, null, null, true);
568    }
569    
570    /**
571     * Get the user's projects filtered by categories OR keywords
572     * @param user the user
573     * @param filteredCategories the filtered categories. Can be empty to no filter by categories
574     * @param filteredKeywords the filtered keywords. Can be empty to no filter by keywords
575     * @return the user's projects
576     */
577    public Map<Project, MemberType> getUserProjects(UserIdentity user, Set<String> filteredCategories, Set<String> filteredKeywords)
578    {
579        return getUserProjects(user, filteredCategories, filteredKeywords, null, true);
580    }
581    
582    /**
583     * Get the user's projects filtered by categories, keywords and/or pattern
584     * @param user the user
585     * @param filteredCategories the filtered categories. Can be empty to no filter by categories.
586     * @param filteredKeywords the filtered keywords. Can be empty to no filter by keywords.
587     * @param pattern to filter on pattern. Can be null or empty to no filter on pattern
588     * @param anyMatch true to get projects matching categories OR keywords OR pattern
589     * @return the user's projects
590     */
591    public Map<Project, MemberType> getUserProjects(UserIdentity user, Set<String> filteredCategories, Set<String> filteredKeywords, String pattern, boolean anyMatch)
592    {
593        return getUserProjects(user, filteredCategories, filteredKeywords, pattern, true, false);
594    }
595    
596    /**
597     * Get the user's projects filtered by categories, keywords and/or pattern
598     * @param user the user
599     * @param filteredCategories the filtered categories. Can be empty to no filter by categories.
600     * @param filteredKeywords the filtered keywords. Can be empty to no filter by keywords.
601     * @param pattern to filter on pattern. Can be null or empty to no filter on pattern
602     * @param anyMatch true to get projects matching categories OR keywords OR pattern
603     * @param excludePrivate true to exclude private projects
604     * @return the user's projects
605     */
606    public Map<Project, MemberType> getUserProjects(UserIdentity user, Set<String> filteredCategories, Set<String> filteredKeywords, String pattern, boolean anyMatch, boolean excludePrivate)
607    {
608        Map<Project, MemberType> userProjects = new HashMap<>();
609        
610        List<Project> projects = getProjects(filteredCategories, filteredKeywords, pattern, anyMatch, excludePrivate);
611        for (Project project : projects)
612        {
613            ProjectMember member = _projectMembers.getProjectMember(project, user);
614            if (member != null)
615            {
616                userProjects.put(project, member.getType());
617            }
618        }
619        
620        return userProjects;
621    }
622
623    /**
624     * Get the projects managed by the user
625     * @param user the user
626     * @return the projects for which the user is a manager
627     */
628    public List<Project> getManagedProjects(UserIdentity user)
629    {
630        return getManagedProjects(user, Set.of());
631    }
632    
633    /**
634     * Get the projects managed by the user
635     * @param user the user
636     * @param filteredCategories the filtered categories. Can be empty to no filter by categories.
637     * @return the projects for which the user is a manager
638     */
639    public List<Project> getManagedProjects(UserIdentity user, Set<String> filteredCategories)
640    {
641        return getProjects(filteredCategories)
642            .stream()
643            .filter(p -> ArrayUtils.contains(p.getManagers(), user))
644            .collect(Collectors.toList());
645    }
646    
647    /**
648     * Returns true if the given project exists.
649     * @param projectName the project name.
650     * @return true if the given project exists.
651     */
652    public boolean hasProject(String projectName)
653    {
654        Map<String, String> uuidCache = _getUUIDCache();
655        if (uuidCache.containsKey(projectName))
656        {
657            // As cache is computed from default JCR workspace, we need to check if the project exists into the current JCR workspace
658            return _resolver.hasAmetysObjectForId(uuidCache.get(projectName));
659        }
660        return false;
661    }
662    
663    /**
664     * Get all managers
665     * @return the managers
666     */
667    public Set<UserIdentity> getManagers()
668    {
669        return getProjects()
670            .stream()
671            .map(Project::getManagers)
672            .flatMap(Arrays::stream)
673            .collect(Collectors.toSet());
674    }
675    
676    /**
677     * Determines if the current user is a manager of at least one project
678     * @return true if the user is a manager
679     */
680    public boolean isManager()
681    {
682        return isManager(_currentUserProvider.getUser());
683    }
684    
685    /**
686     * Determines if the user is a manager of at least one project
687     * @param user the user
688     * @return true if the user is a manager
689     */
690    public boolean isManager(UserIdentity user)
691    {
692        AmetysObjectIterable<Project> projects = getProjects();
693        for (Project project : projects)
694        {
695            if (isManager(project, user))
696            {
697                return true;
698            }
699        }
700        return false;
701    }
702    
703    /**
704     * Determines if the user is a manager of the project
705     * @param projectName the project name
706     * @param user the user
707     * @return true if the user is a manager
708     */
709    public boolean isManager(String projectName, UserIdentity user)
710    {
711        Project project = getProject(projectName);
712        if (project != null)
713        {
714            return isManager(project, user);
715        }
716        return false;
717    }
718    
719    /**
720     * Determines if the user is a manager of the project
721     * @param project the project
722     * @param user the user
723     * @return true if the user is a manager
724     */
725    public boolean isManager(Project project, UserIdentity user)
726    {
727        return ArrayUtils.contains(project.getManagers(), user);
728    }
729
730    /**
731     * Can the current user access backoffice on the site of the current project
732     * @param project The non null project to analyse
733     * @return true if the user can access to the backoffice
734     */
735    public boolean canAccessBO(Project project)
736    {
737        Site site = project.getSite();
738        if (site == null)
739        {
740            return false;
741        }
742
743        Request request = ContextHelper.getRequest(_context);
744        String currentSiteName = (String) request.getAttribute("siteName");
745        try
746        {
747            request.setAttribute("siteName", site.getName()); // Setting temporarily this attribute to check user rights on any object on this site
748            return !_rightManager.getUserRights(_currentUserProvider.getUser(), "/cms").isEmpty();
749        }
750        finally
751        {
752            request.setAttribute("siteName", currentSiteName);
753        }
754    }
755    
756    /**
757     * Can the current user leave the project
758     * @param project The non null project to analyse
759     * @return true if the user can leave the project
760     */
761    public boolean canLeaveProject(Project project)
762    {
763        if (project == null)
764        {
765            return false;
766        }
767        
768        Site site = project.getSite();
769        if (site == null)
770        {
771            return false;
772        }
773        
774        UserIdentity userIdentity = _currentUserProvider.getUser();
775        
776        // As a user in a group can't leave the project, check if he is registered as User member
777        Set<ProjectMember> members = _projectMemberManager.getProjectMembers(project, false);
778        ProjectMember projectMember = members.stream()
779                .filter(member -> MemberType.USER == member.getType())
780                .filter(member -> userIdentity.equals(member.getUser().getIdentity()))
781                .findFirst()
782                .orElse(null);
783        
784        // The user is either on a group, or has not been found
785        if (projectMember == null)
786        {
787            return false;
788        }
789
790        // The user is the only remaining manager, and therefore can not leave the project
791        if (_projectMemberManager.isOnlyManager(project, userIdentity))
792        {
793            return false;
794        }
795        
796        return true;
797    }
798    
799    /**
800     * Retrieves the mapping of all the projects name with their title on which the current user has access
801     * @return the map (projectName, projectTitle) for all projects
802     */
803    @Callable (rights = Callable.CHECKED_BY_IMPLEMENTATION)
804    public List<Map<String, Object>> getUserProjectsData()
805    {
806        return getUserProjects(_currentUserProvider.getUser())
807                .keySet()
808                .stream()
809                .map(p -> _project2json(p))
810                .collect(Collectors.toList());
811    }
812
813    /**
814     * Get the user modules on the given project.
815     * @param projectName the project name
816     * @return The maps of modules with the read access information
817     */
818    @Callable (rights = Callable.CHECKED_BY_IMPLEMENTATION)
819    public Map<String, Object> getUserModules(String projectName)
820    {
821        Project project = this.getProject(projectName);
822        UserIdentity currentUser = _currentUserProvider.getUser();
823        
824        return Arrays.stream(project.getModules())
825            .collect(Collectors.toMap(
826                mId -> mId,
827                mId -> _projectRightHelper.hasReadAccessOnModule(project, mId, currentUser)));
828    }
829
830    /**
831     * Retrieves the users that have not been yet added to a project with a given criteria
832     * @param projectName the project name
833     * @param limit limit of request
834     * @param criteria the criteria of the search
835     * @param previousSearchData the previous search data to compute offset. Null if first search
836     * @return list of users
837     */
838    @SuppressWarnings("unchecked")
839    @Callable (rights = Callable.CHECKED_BY_IMPLEMENTATION)
840    public Map<String, Object> searchUserByProject(String projectName, int limit, String criteria, Map<String, Object> previousSearchData)
841    {
842
843        Project project = this.getProject(projectName);
844
845        if (!_projectRightHelper.canAddMember(project))
846        {
847            throw new AccessDeniedException("User '" + _currentUserProvider.getUser() + "' tried to do read operation without convenient right");
848        }
849        
850        Map<String, Object> results = new HashMap<>();
851        Site site = project.getSite();
852        
853        Set<String> projectMemberList = _projectMemberManager.getProjectMembers(project, false)
854                .stream()
855                .map(member ->
856                {
857                    if (member.getType() == MemberType.USER)
858                    {
859                        return UserIdentity.userIdentityToString(member.getUser().getIdentity());
860                    }
861                    else
862                    {
863                        GroupIdentity groupIdentityAsString = member.getGroup().getIdentity();
864                        return GroupIdentity.groupIdentityToString(groupIdentityAsString);
865                    }
866                })
867                .collect(Collectors.toSet());
868        
869        Set<String> contexts = new HashSet<>(Arrays.asList("/sites/" + site.getName(), "/sites-fo/" + site.getName()));
870        
871        Map<String, Object> params = new HashMap<>();
872        params.put("pattern", criteria);
873        
874        Map<String, Object> result = new HashMap<>();
875        Map<String, Object> searchData = previousSearchData;
876        List<Map<String, Object>> memberList = new ArrayList<>();
877
878        Set<String> groupDirectories = _directoryContextHelper.getGroupDirectoriesOnContexts(contexts);
879        Set<String> userPopulations = getPopulation(site, true);
880
881        do
882        {
883            result = _userAndGroupSearchManager.searchUsersAndGroup(userPopulations, groupDirectories, limit - memberList.size(), searchData, params, true);
884            List<Map<String, Object>> filteredMembers = ((List<Map<String, Object>>) result.get("results"))
885                    .stream()
886                    .filter(member ->
887                    {
888                        return !projectMemberList.contains(member.get("login") + "#" + member.get("populationId")) && !projectMemberList.contains(member.get("id") + "#" + member.get("groupDirectory"));
889                    }).collect(Collectors.toList());
890            searchData = (Map<String, Object>) result.get("searchData");
891            memberList.addAll(filteredMembers);
892        }
893        while (!result.containsKey("finished") && memberList.size() < limit);
894
895        results.put("searchData", searchData);
896        results.put("memberList", memberList);
897        return results;
898    }
899    
900    /**
901     * Get the populations of the project
902     * @param site the project site
903     * @param excludeConfigurationPopulations true to exclude populations configured in the catalog site or in the project site
904     * @return the populations of the project
905     */
906    public Set<String> getPopulation(Site site, boolean excludeConfigurationPopulations)
907    {
908        Set<String> contexts = new HashSet<>(Arrays.asList("/sites/" + site.getName(), "/sites-fo/" + site.getName()));
909
910        Set<String> userPopulations = _populationContextHelper.getUserPopulationsOnContexts(contexts, false, true);
911        
912        if (excludeConfigurationPopulations)
913        {
914            Site catalogSite = _siteManager.getSite(getCatalogSiteName());
915            
916            // Get the excluded population configuration
917            String excludedPopulationsString = catalogSite.getValue(CatalogSiteType.PROJECT_EXCLUDED_POPULATIONS_SITE_PARAM);
918            
919            // Check if project site overrides catalog configuration
920            if (site.getValue(ProjectWorkspaceSiteType.PROJECT_OVERRIDE_EXCLUDED_POPULATIONS_SITE_PARAM, false, false))
921            {
922                excludedPopulationsString = site.getValue(ProjectWorkspaceSiteType.PROJECT_EXCLUDED_POPULATIONS_PROJECT_SITE_PARAM);
923            }
924            
925            List<String> excludedPopulationsList = Arrays.asList(StringUtils.split(StringUtils.defaultString(excludedPopulationsString), ","));
926            
927            if (!excludedPopulationsList.isEmpty())
928            {
929                userPopulations.removeAll(excludedPopulationsList);
930            }
931        }
932
933        return userPopulations;
934    }
935
936    /**
937     * Retrieves the mapping of all the projects name with their title (regarless user rights)
938     * @return the map (projectName, projectTitle) for all projects
939     */
940    @Callable(rights = "Runtime_Rights_Admin_Access", context = "/admin")
941    public List<Map<String, Object>> getProjectsData()
942    {
943        return getProjects()
944                .stream()
945                .map(p -> _project2json(p))
946                .collect(Collectors.toList());
947    }
948    
949    /**
950     * Get the project's main properties as json object
951     * @param project the project
952     * @return the json representation of project
953     */
954    protected Map<String, Object> _project2json(Project project)
955    {
956        Map<String, Object> json = new HashMap<>();
957        
958        json.put("id", project.getId());
959        json.put("name", project.getName());
960        json.put("title", project.getTitle());
961        json.put("url", getProjectUrl(project, StringUtils.EMPTY));
962        
963        return json;
964    }
965    /**
966     * Retrieves the project names
967     * @return the project names
968     */
969    @Callable(rights = "Runtime_Rights_Admin_Access", context = "/admin")
970    public Collection<String> getProjectNames()
971    {
972        // As cache is computed from default JCR workspace, we need to filter on sites that exist into the current JCR workspace
973        return _getUUIDCache().entrySet().stream()
974                .filter(e -> _resolver.hasAmetysObjectForId(e.getValue()))
975                .map(Map.Entry::getKey)
976                .collect(Collectors.toList());
977    }
978    
979    /**
980     * Return the root for projects
981     * The root node will be created if necessary
982     * @return The root for projects
983     */
984    public ModifiableTraversableAmetysObject getProjectsRoot()
985    {
986        try
987        {
988            ModifiableTraversableAmetysObject pluginsNode = _resolver.resolveByPath("/ametys:plugins");
989            ModifiableTraversableAmetysObject workspacesPluginNode = _getOrCreateObject(pluginsNode, __WORKSPACES_PLUGIN_NODE_NAME, __WORKSPACES_PLUGIN_NODE_TYPE);
990            return _getOrCreateObject(workspacesPluginNode, __PROJECTS_ROOT_NODE_NAME, __PROJECTS_ROOT_NODE_TYPE);
991        }
992        catch (AmetysRepositoryException e)
993        {
994            throw new AmetysRepositoryException("Error getting the projects root node.", e);
995        }
996    }
997    
998    /**
999     * Retrieves the standard information of a project
1000     * @param projectId Identifier of the project
1001     * @return The map of information
1002     */
1003    @Callable(rights = "Runtime_Rights_Admin_Access", context = "/admin")
1004    public Map<String, Object> getProjectProperties(String projectId)
1005    {
1006        return getProjectProperties((Project) _resolver.resolveById(projectId));
1007    }
1008    
1009    /**
1010     * Retrieves the standard information of a project
1011     * @param project The project
1012     * @return The map of information
1013     */
1014    public Map<String, Object> getProjectProperties(Project project)
1015    {
1016        Map<String, Object> info = new HashMap<>();
1017
1018        info.put("id", project.getId());
1019        info.put("name", project.getName());
1020        info.put("type", "project");
1021
1022        info.put("title", project.getTitle());
1023        info.put("description", project.getDescription());
1024        info.put("inscriptionStatus", project.getInscriptionStatus().toString());
1025        info.put("defaultProfile", project.getDefaultProfile());
1026
1027        info.put("creationDate", project.getCreationDate());
1028
1029        // check if the project workspace configuration is valid
1030        Site site = project.getSite();
1031        boolean valid = site != null && _siteConfigurationManager.isSiteConfigurationValid(site);
1032        
1033        Set<String> categories = project.getCategories();
1034        info.put("categories", categories.stream()
1035                .map(c -> _categoryProviderEP.getTag(c, new HashMap<>()))
1036                .filter(Objects::nonNull)
1037                .map(t -> _tag2json(t))
1038                .collect(Collectors.toList()));
1039        
1040        info.put("keywords", Arrays.stream(project.getKeywords())
1041                .map(c -> _keywordProviderEP.getTag(c, new HashMap<>()))
1042                .filter(Objects::nonNull)
1043                .map(t -> _tag2json(t))
1044                .collect(Collectors.toList()));
1045        
1046        info.put("valid", valid);
1047        
1048        UserIdentity[] managers = project.getManagers();
1049        info.put("managers", Arrays.stream(managers)
1050                .map(u -> _userHelper.user2json(u))
1051                .collect(Collectors.toList()));
1052        
1053        Map<String, String> siteProps = new HashMap<>();
1054        // site map with id ,name, title and url property
1055        // { id: site id, name: site name, title: site title, url: site url }
1056        if (site != null)
1057        {
1058            siteProps.put("id", site.getId());
1059            siteProps.put("name", site.getName());
1060            siteProps.put("title", site.getTitle());
1061            siteProps.put("url", site.getUrl());
1062        }
1063        info.put("site", siteProps);
1064
1065        return info;
1066    }
1067    
1068    private Map<String, Object> _tag2json(Tag tag)
1069    {
1070        Map<String, Object> json = new HashMap<>();
1071        json.put("id", tag.getId());
1072        json.put("name", tag.getName());
1073        json.put("title", tag.getTitle());
1074        return json;
1075    }
1076
1077    /**
1078     * Get the project URL.
1079     * @param project The project
1080     * @param defaultValue The default value to use if there is no site
1081     * @return The project URL if a site is configured, otherwise return the default value.
1082     */
1083    public String getProjectUrl(Project project, String defaultValue)
1084    {
1085        Site site = project.getSite();
1086        if (site == null)
1087        {
1088            return defaultValue;
1089        }
1090        else
1091        {
1092            return site.getUrl();
1093        }
1094    }
1095    
1096    /**
1097     * Create a project
1098     * @param name The project name
1099     * @param title The project title
1100     * @param description The project description
1101     * @param emailList Project mailing list
1102     * @param inscriptionStatus The inscription status of the project
1103     * @param defaultProfile The default profile for new members
1104     * @return A map containing the id of the new project or an error key.
1105     */
1106    @Callable (rights = Callable.CHECKED_BY_IMPLEMENTATION)
1107    public Map<String, Object> createProject(String name, String title, String description, String emailList, String inscriptionStatus, String defaultProfile)
1108    {
1109        checkRightsForProjectCreation(InscriptionStatus.valueOf(inscriptionStatus.toUpperCase()), null);
1110
1111        Map<String, Object> result = new HashMap<>();
1112        List<String> errors = new ArrayList<>();
1113        
1114        Map<String, Object> additionalValues = new HashMap<>();
1115        additionalValues.put("description", description);
1116        additionalValues.put("emailList", emailList);
1117        additionalValues.put("inscriptionStatus", inscriptionStatus);
1118        additionalValues.put("defaultProfile", defaultProfile);
1119        
1120        Project project = createProject(name, title, additionalValues, null, errors);
1121        
1122        if (CollectionUtils.isEmpty(errors))
1123        {
1124            result.put("id", project.getId());
1125        }
1126        else
1127        {
1128            result.put("error", errors.get(0));
1129        }
1130        
1131        return result;
1132    }
1133    
1134    /**
1135     * Create a project
1136     * @param name The project name
1137     * @param title The project title
1138     * @param additionalValues A list of optional additional values. Accepted values are : description, mailingList, inscriptionStatus, defaultProfile, tags, categoryTags, keywords and language
1139     * @param modulesIds The list of modules to activate. Can be null to activate all modules
1140     * @param errors A list that will be populated with the encountered errors. If null, errors will not be tracked.
1141     * @return The id of the new project
1142     */
1143    public Project createProject(String name, String title, Map<String, Object> additionalValues, Set<String> modulesIds, List<String> errors)
1144    {
1145        if (StringUtils.isEmpty(title))
1146        {
1147            throw new IllegalArgumentException(String.format("Cannot create project. Title is mandatory"));
1148        }
1149        
1150        ModifiableTraversableAmetysObject projectsRoot = getProjectsRoot();
1151        
1152        // Project name should be unique
1153        if (hasProject(name))
1154        {
1155            if (getLogger().isWarnEnabled())
1156            {
1157                getLogger().warn(String.format("A project with the name '%s' already exists", name));
1158            }
1159            
1160            if (errors != null)
1161            {
1162                errors.add("project-exists");
1163            }
1164            
1165            return null;
1166        }
1167        
1168        Project project = projectsRoot.createChild(name, Project.NODE_TYPE);
1169        project.setTitle(title);
1170        String description = (String) additionalValues.getOrDefault("description", null);
1171        if (StringUtils.isNotEmpty(description))
1172        {
1173            project.setDescription(description);
1174        }
1175        String mailingList = (String) additionalValues.getOrDefault("emailList", null);
1176        if (StringUtils.isNotEmpty(mailingList))
1177        {
1178            project.setMailingList(mailingList);
1179        }
1180        
1181        String inscriptionStatus = (String) additionalValues.getOrDefault("inscriptionStatus", null);
1182        if (StringUtils.isNotEmpty(inscriptionStatus))
1183        {
1184            project.setInscriptionStatus(inscriptionStatus);
1185        }
1186        
1187        String defaultProfile = (String) additionalValues.getOrDefault("defaultProfile", null);
1188        if (StringUtils.isNotEmpty(defaultProfile))
1189        {
1190            project.setDefaultProfile(defaultProfile);
1191        }
1192        
1193        @SuppressWarnings("unchecked")
1194        List<String> tags = (List<String>) additionalValues.getOrDefault("tags", null);
1195        if (tags != null)
1196        {
1197            project.setTags(tags);
1198        }
1199        @SuppressWarnings("unchecked")
1200        List<String> categoryTags = (List<String>) additionalValues.getOrDefault("categoryTags", null);
1201        if (categoryTags != null)
1202        {
1203            project.setCategoryTags(categoryTags);
1204        }
1205        
1206        @SuppressWarnings("unchecked")
1207        List<String> keywords = (List<String>) additionalValues.getOrDefault("keywords", null);
1208        if (keywords != null)
1209        {
1210            project.setKeywords(keywords.toArray(new String[keywords.size()]));
1211        }
1212
1213        project.setCreationDate(ZonedDateTime.now());
1214        
1215        // Create the project workspace = a site + a set of pages
1216        _createProjectWorkspace(project, errors);
1217        
1218        activateModules(project, modulesIds, additionalValues);
1219        
1220        if (CollectionUtils.isEmpty(errors))
1221        {
1222            project.saveChanges();
1223         
1224            // Notify observers
1225            Map<String, Object> eventParams = new HashMap<>();
1226            eventParams.put(ObservationConstants.ARGS_PROJECT, project);
1227            _observationManager.notify(new Event(ObservationConstants.EVENT_PROJECT_ADDED, _currentUserProvider.getUser(), eventParams));
1228            
1229        }
1230        else
1231        {
1232            deleteProject(project);
1233        }
1234        
1235        clearCaches();
1236        
1237        return project;
1238    }
1239    
1240    /**
1241     * Edit a project
1242     * @param id The project identifier
1243     * @param title The title to set
1244     * @param description The description to set
1245     * @param mailingList Project mailing list
1246     * @param inscriptionStatus The inscription status of the project
1247     * @param defaultProfile The default profile for new members
1248     */
1249    @Callable(rights = ProjectConstants.RIGHT_PROJECT_EDIT, context = "/admin")
1250    public void editProject(String id, String title, String description, String mailingList, String inscriptionStatus, String defaultProfile)
1251    {
1252        Project project = _resolver.resolveById(id);
1253        editProject(project, title, description, mailingList, inscriptionStatus, defaultProfile);
1254    }
1255    
1256    /**
1257     * Edit a project
1258     * @param project The project
1259     * @param title The title to set
1260     * @param description The description to set
1261     * @param mailingList Project mailing list
1262     * @param inscriptionStatus The inscription status of the project
1263     * @param defaultProfile The default profile for new members
1264     */
1265    public void editProject(Project project, String title, String description, String mailingList, String inscriptionStatus, String defaultProfile)
1266    {
1267        checkRightsForProjectEdition(project, InscriptionStatus.valueOf(inscriptionStatus.toUpperCase()), null);
1268        
1269        project.setTitle(title);
1270        
1271        if (StringUtils.isNotEmpty(description))
1272        {
1273            project.setDescription(description);
1274        }
1275        else
1276        {
1277            project.removeDescription();
1278        }
1279        
1280        if (StringUtils.isNotEmpty(mailingList))
1281        {
1282            project.setMailingList(mailingList);
1283        }
1284        else
1285        {
1286            project.removeMailingList();
1287        }
1288
1289        project.setInscriptionStatus(inscriptionStatus);
1290        project.setDefaultProfile(defaultProfile);
1291        
1292        project.saveChanges();
1293        
1294        // Notify observers
1295        Map<String, Object> eventParams = new HashMap<>();
1296        eventParams.put(ObservationConstants.ARGS_PROJECT, project);
1297        eventParams.put(org.ametys.plugins.workspaces.ObservationConstants.ARGS_PROJECT_ID, project.getId());
1298        _observationManager.notify(new Event(ObservationConstants.EVENT_PROJECT_UPDATED, _currentUserProvider.getUser(), eventParams));
1299    }
1300    
1301    /**
1302     * Delete a list of project.
1303     * @param ids The ids of projects to delete
1304     * @return The ids of the deleted projects, unknowns projects and the deleted sites
1305     */
1306    @Callable(rights = ProjectConstants.RIGHT_PROJECT_DELETE, context = "/admin")
1307    public Map<String, Object> deleteProjectsByIds(List<String> ids)
1308    {
1309        Map<String, Object> result = new HashMap<>();
1310        List<Map<String, Object>> deleted = new ArrayList<>();
1311        List<String> unknowns = new ArrayList<>();
1312        
1313        for (String id : ids)
1314        {
1315            try
1316            {
1317                Project project = _resolver.resolveById(id);
1318                
1319                Map<String, Object> projectInfo = new HashMap<>();
1320                projectInfo.put("id", id);
1321                projectInfo.put("title", project.getTitle());
1322                projectInfo.put("sites", deleteProject(project));
1323                
1324                deleted.add(projectInfo);
1325            }
1326            catch (UnknownAmetysObjectException e)
1327            {
1328                getLogger().warn(String.format("Unable to delete the definition of id '%s', because it does not exist.", id), e);
1329                unknowns.add(id);
1330            }
1331        }
1332        
1333        result.put("deleted", deleted);
1334        result.put("unknowns", unknowns);
1335        
1336        return result;
1337    }
1338    
1339    /**
1340     * Delete a project.
1341     * @param projects The list of projects to delete
1342     * @return list of deleted sites (each list entry contains a data map with
1343     *         the id and the name of the delete site).
1344     */
1345    public List<Map<String, String>> deleteProject(List<Project> projects)
1346    {
1347        List<Map<String, String>> deletedSitesInfo = new ArrayList<>();
1348        
1349        for (Project project : projects)
1350        {
1351            deletedSitesInfo.addAll(deleteProject(project));
1352        }
1353        
1354        return deletedSitesInfo;
1355    }
1356    
1357    /**
1358     * Delete a project and its sites
1359     * @param project The project to delete
1360     * @return list of deleted sites (each list entry contains a data map with
1361     *         the id and the name of the delete site).
1362     */
1363    public List<Map<String, String>> deleteProject(Project project)
1364    {
1365        ModifiableAmetysObject parent = project.getParent();
1366        
1367        
1368        // list of map entry with id, name and title property
1369        // { id: site id, name: site name }
1370        List<Map<String, String>> deletedSitesInfo = new ArrayList<>();
1371        
1372        Site site = project.getSite();
1373        if (site != null)
1374        {
1375            try
1376            {
1377                Map<String, String> siteProps = new HashMap<>();
1378                siteProps.put("id", site.getId());
1379                siteProps.put("name", site.getName());
1380                
1381                _siteDao.deleteSite(site.getId());
1382                deletedSitesInfo.add(siteProps);
1383            }
1384            catch (RepositoryException e)
1385            {
1386                String errorMsg = String.format("Error while trying to delete the site '%s' for the project '%s'.", site.getName(), project.getName());
1387                getLogger().error(errorMsg, e);
1388            }
1389        }
1390        
1391        String projectId = project.getId();
1392        Collection<ProjectMember> projectMembers = _projectMembers.getProjectMembers(project, true);
1393        project.remove();
1394        parent.saveChanges();
1395        
1396        // Notify observers
1397        Map<String, Object> eventParams = new HashMap<>();
1398        eventParams.put(ObservationConstants.ARGS_PROJECT_ID, projectId);
1399        eventParams.put(ObservationConstants.ARGS_PROJECT_NAME, project.getName());
1400        eventParams.put(ObservationConstants.ARGS_PROJECT_MEMBERS, projectMembers);
1401        _observationManager.notify(new Event(ObservationConstants.EVENT_PROJECT_DELETED, _currentUserProvider.getUser(), eventParams));
1402        
1403        clearCaches();
1404        
1405        return deletedSitesInfo;
1406    }
1407    
1408    /**
1409     * Utility method to get or create an ametys object
1410     * @param <A> A sub class of AmetysObject
1411     * @param parent The parent object
1412     * @param name The ametys object name
1413     * @param type The ametys object type
1414     * @return ametys object
1415     * @throws AmetysRepositoryException if an repository error occurs
1416     */
1417    private <A extends AmetysObject> A _getOrCreateObject(ModifiableTraversableAmetysObject parent, String name, String type) throws AmetysRepositoryException
1418    {
1419        A object;
1420        
1421        if (parent.hasChild(name))
1422        {
1423            object = parent.getChild(name);
1424        }
1425        else
1426        {
1427            object = parent.createChild(name, type);
1428            parent.saveChanges();
1429        }
1430        
1431        return object;
1432    }
1433    
1434    /**
1435     * Get the project of an ametys object inside a project.
1436     * It can be an explorer node, or any type of resource in a module.
1437     * @param id The identifier of the ametys object
1438     * @return the project or null if not found
1439     */
1440    public Project getParentProject(String id)
1441    {
1442        return getParentProject(_resolver.<AmetysObject>resolveById(id));
1443    }
1444    
1445    /**
1446     * Get the project of an ametys object inside a project.
1447     * It can be an explorer node, or any type of resource in a module.
1448     * @param object The ametys object
1449     * @return the project or null if not found
1450     */
1451    public Project getParentProject(AmetysObject object)
1452    {
1453        AmetysObject ametysObject = object;
1454        // Go back to the local explorer root.
1455        do
1456        {
1457            ametysObject = ametysObject.getParent();
1458        }
1459        while (ametysObject instanceof ExplorerNode);
1460        
1461        if (!(ametysObject instanceof Project))
1462        {
1463            getLogger().warn(String.format("No project found for ametys object with id '%s'", ametysObject.getId()));
1464            return null;
1465        }
1466        
1467        return (Project) ametysObject;
1468    }
1469    
1470    /**
1471     * Get the list of project names for a given site
1472     * @param siteName The site name
1473     * @return the list of project names
1474     */
1475    @Callable(rights = "Runtime_Rights_Admin_Access", context = "/admin")
1476    public List<String> getProjectsForSite(String siteName)
1477    {
1478        Cache<String, List<Pair<String, String>>> cache = _getMemorySiteAssociationCache();
1479        if (cache.hasKey(siteName))
1480        {
1481            return cache.get(siteName).stream()
1482                    .map(p -> p.getRight())
1483                    .collect(Collectors.toList());
1484        }
1485        else
1486        {
1487            List<String> projectNames = new ArrayList<>();
1488            
1489            if (_siteManager.hasSite(siteName))
1490            {
1491                Site site = _siteManager.getSite(siteName);
1492                getProjectsForSite(site)
1493                    .stream()
1494                    .map(Project::getName)
1495                    .forEach(projectNames::add);
1496            }
1497            
1498            return projectNames;
1499        }
1500    }
1501    
1502    /**
1503     * Get the list of project for a given site
1504     * @param site The site
1505     * @return the list of project
1506     */
1507    public List<Project> getProjectsForSite(Site site)
1508    {
1509        Cache<String, List<Pair<String, String>>> cache = _getMemorySiteAssociationCache();
1510        if (cache.hasKey(site.getName()))
1511        {
1512            return cache.get(site.getName()).stream()
1513                        .map(p -> _resolver.<Project>resolveById(p.getLeft()))
1514                        .collect(Collectors.toList());
1515        }
1516        
1517        try
1518        {
1519            // Stream over the weak reference properties pointing to this
1520            // node to find referencing projects
1521            Iterator<Property> propertyIterator = site.getNode().getWeakReferences();
1522            Iterable<Property> propertyIterable = () -> propertyIterator;
1523            
1524            List<Project> projects = StreamSupport.stream(propertyIterable.spliterator(), false)
1525                    .map(p ->
1526                    {
1527                        try
1528                        {
1529                            Node parent = p.getParent();
1530
1531                            // Check if the parent is a project"
1532                            if (NodeTypeHelper.isNodeType(parent, "ametys:project"))
1533                            {
1534                                Project project = _resolver.resolve(parent, false);
1535                                return project;
1536                            }
1537                        }
1538                        catch (Exception e)
1539                        {
1540                            if (getLogger().isWarnEnabled())
1541                            {
1542                                // this weak reference is not from a project
1543                                String propertyPath = null;
1544                                try
1545                                {
1546                                    propertyPath = p.getPath();
1547                                }
1548                                catch (Exception e2)
1549                                {
1550                                    // ignore
1551                                }
1552                                
1553                                String warnMsg = String.format("Site '%s' is pointed by a weak reference '%s' which is not representing a relation with project. This reference is ignored.", site.getName(), propertyPath);
1554                                getLogger().warn(warnMsg);
1555                            }
1556                        }
1557                        
1558                        return null;
1559                    })
1560                    .filter(Objects::nonNull)
1561                    .collect(Collectors.toList());
1562            
1563            List<Pair<String, String>> projectsPairs = projects.stream().map(p -> Pair.of(p.getId(), p.getName())).collect(Collectors.toList());
1564            cache.put(site.getName(), projectsPairs);
1565            return projects;
1566        }
1567        catch (RepositoryException e)
1568        {
1569            getLogger().error(String.format("Unable to find projects for site '%s'", site.getName()), e);
1570        }
1571        
1572        return new ArrayList<>();
1573    }
1574    
1575    /**
1576     * Create the project workspace for a given project.
1577     * @param project The project for which the workspace must be created
1578     * @param errors A list of possible errors to populate. Can be null if the caller is not interested in error tracking.
1579     * @return The site created for this workspace
1580     */
1581    protected Site _createProjectWorkspace(Project project, List<String> errors)
1582    {
1583        String initialSiteName = project.getName();
1584        Site site = null;
1585        
1586        Site catalogSite = _siteManager.getSite(getCatalogSiteName());
1587        String rootId = catalogSite != null ? catalogSite.getId() : null;
1588        
1589        Map<String, Object> result = _siteDao.createSite(rootId, initialSiteName, ProjectWorkspaceSiteType.TYPE_ID, true);
1590        
1591        String siteId = (String) result.get("id");
1592        String siteName = (String) result.get("name");
1593        if (StringUtils.isNotEmpty(siteId))
1594        {
1595            // Creation success
1596            site = _siteManager.getSite(siteName);
1597            
1598            setProjectSiteTitle(site, project.getTitle());
1599          
1600            // Add site to project
1601            project.setSite(site);
1602            
1603            site.saveChanges();
1604        }
1605        
1606        return site;
1607    }
1608
1609    /**
1610     * Get the project's tags
1611     * @return The project's tags
1612     */
1613    public List<String> getTags()
1614    {
1615        AmetysObject projectsRootNode = getProjectsRoot();
1616        if (projectsRootNode instanceof JCRAmetysObject)
1617        {
1618            Node node = ((JCRAmetysObject) projectsRootNode).getNode();
1619            
1620            try
1621            {
1622                return Arrays.stream(node.getProperty(__PROJECTS_TAGS_PROPERTY).getValues())
1623                    .map(LambdaUtils.wrap(Value::getString))
1624                    .collect(Collectors.toList());
1625            }
1626            catch (PathNotFoundException e)
1627            {
1628                // property is not set, empty list will be returned.
1629            }
1630            catch (RepositoryException e)
1631            {
1632                throw new AmetysRepositoryException(e);
1633            }
1634        }
1635        
1636        return new ArrayList<>();
1637    }
1638
1639    /**
1640     * Add project's tags
1641     * @param newTags The new tags to add
1642     */
1643    public synchronized void addTags(Collection<String> newTags)
1644    {
1645        if (CollectionUtils.isNotEmpty(newTags))
1646        {
1647            AmetysObject projectsRootNode = getProjectsRoot();
1648            if (projectsRootNode instanceof JCRAmetysObject)
1649            {
1650                // Concat existing tags with new lowercased tags
1651                String[] tags = Stream.concat(getTags().stream(), newTags.stream().map(String::trim).map(String::toLowerCase).filter(StringUtils::isNotEmpty))
1652                        .distinct()
1653                        .toArray(String[]::new);
1654                
1655                try
1656                {
1657                    ((JCRAmetysObject) projectsRootNode).getNode().setProperty(__PROJECTS_TAGS_PROPERTY, tags);
1658                }
1659                catch (RepositoryException e)
1660                {
1661                    throw new AmetysRepositoryException(e);
1662                }
1663            }
1664        }
1665    }
1666    
1667    /**
1668     * Get the list of activated modules for a project
1669     * @param project The project
1670     * @return The list of activated modules
1671     */
1672    public List<WorkspaceModule> getModules(Project project)
1673    {
1674        return _moduleManagerEP.getModules().stream()
1675                .filter(module -> isModuleActivated(project, module.getId()))
1676                .collect(Collectors.toList());
1677    }
1678    
1679    /**
1680     * Retrieves the page of the module for all available languages
1681     * @param project The project
1682     * @param moduleId The project module id
1683     * @return the page or null if not found
1684     */
1685    public Set<Page> getModulePages(Project project, String moduleId)
1686    {
1687        if (_moduleManagerEP.hasExtension(moduleId))
1688        {
1689            WorkspaceModule module = _moduleManagerEP.getExtension(moduleId);
1690            return getModulePages(project, module);
1691        }
1692        return null;
1693    }
1694    
1695    /**
1696     * Return the possible module roots associated to a page
1697     * @param page The given page
1698     * @return A non null set of the data of the linked modules
1699     */
1700    public Set<ModifiableResourceCollection> pageToModuleRoot(Page page)
1701    {
1702        Set<ModifiableResourceCollection> data = new LinkedHashSet<>();
1703        
1704        Page rootPage = page;
1705        SitemapElement parent = page.getParent();
1706        while (!(parent instanceof Sitemap) && !page.hasValue(__PAGE_MODULES_VALUE))
1707        {
1708            rootPage = (Page) parent;
1709            parent = parent.getParent();
1710        }
1711        
1712        String[] modulesRootsIds = rootPage.getValue(__PAGE_MODULES_VALUE, new String[0]);
1713        if (modulesRootsIds.length > 0)
1714        {
1715            for (String moduleRootId : modulesRootsIds)
1716            {
1717                try
1718                {
1719                    ModifiableResourceCollection moduleRoot = _resolver.resolveById(moduleRootId);
1720                    data.add(moduleRoot);
1721                }
1722                catch (UnknownAmetysObjectException e)
1723                {
1724                    // Ignore obsolete data
1725                }
1726            }
1727        }
1728        
1729        return data;
1730    }
1731    
1732    /**
1733     * Mark the given page as this module page. The modified page will not be saved.
1734     * @param page The page to change
1735     * @param moduleRoot The workspace module that use this page
1736     */
1737    public void tagProjectPage(ModifiablePage page, ModifiableResourceCollection moduleRoot)
1738    {
1739        String[] currentModules = page.getValue(__PAGE_MODULES_VALUE, new String[0]);
1740        
1741        Set<String> modules = new LinkedHashSet<>(Arrays.asList(currentModules));
1742        modules.add(moduleRoot.getId());
1743        
1744        String[] newModules = new String[modules.size()];
1745        modules.toArray(newModules);
1746        
1747        page.setValue(__PAGE_MODULES_VALUE, newModules);
1748    }
1749
1750    /**
1751     * Remove the mark on the given page of this module. The modified page will not be saved.
1752     * @param page The page to change
1753     * @param moduleRoot The workspace module that use this page
1754     */
1755    public void untagProjectPage(ModifiablePage page, ModifiableResourceCollection moduleRoot)
1756    {
1757        if (moduleRoot != null)
1758        {
1759            String[] currentModules = page.getValue(__PAGE_MODULES_VALUE, new String[0]);
1760            
1761            Set<String> modules = new LinkedHashSet<>(Arrays.asList(currentModules));
1762            modules.remove(moduleRoot.getId());
1763            
1764            String[] newModules = new String[modules.size()];
1765            modules.toArray(newModules);
1766            
1767            page.setValue(__PAGE_MODULES_VALUE, newModules);
1768        }
1769    }
1770
1771    /**
1772     * Get a page in the site of a given project with a specific tag
1773     * @param project The project
1774     * @param workspaceModule the module
1775     * @return The module's pages
1776     */
1777    public Set<Page> getModulePages(Project project, WorkspaceModule workspaceModule)
1778    {
1779        Request request = _getRequest();
1780        if (request == null)
1781        {
1782            // There is no request to store cache
1783            return _computePages(project, workspaceModule);
1784        }
1785        
1786        Cache<RequestModuleCacheKey, Set<Page>> pagesCache = _getRequestPageCache();
1787        
1788        // The site key in the cache is of the form {site + workspace}.
1789        String currentWorkspace = _workspaceSelector.getWorkspace();
1790        RequestModuleCacheKey pagesKey = RequestModuleCacheKey.of(project.getName(), workspaceModule.getId(), currentWorkspace);
1791        
1792        try
1793        {
1794            return pagesCache.get(pagesKey, __ -> _computePages(project, workspaceModule));
1795        }
1796        catch (CacheException e)
1797        {
1798            if (e.getCause() instanceof UnknownAmetysObjectException)
1799            {
1800                throw (UnknownAmetysObjectException) e.getCause();
1801            }
1802            else
1803            {
1804                throw new RuntimeException("An error occurred while computing page of module " + workspaceModule.getModuleName() + " in project " + project.getName(), e);
1805            }
1806        }
1807    }
1808    
1809    private Set<Page> _computePages(Project project, WorkspaceModule workspaceModule)
1810    {
1811        Set<String> pagesUUids = _getMemoryPageCache().get(ModuleCacheKey.of(project.getName(), workspaceModule.getId()), __ -> _computePagesIds(project, workspaceModule));
1812        if (pagesUUids != null)
1813        {
1814            return pagesUUids.stream().map(uuid -> _resolver.<Page>resolveById(uuid)).collect(Collectors.toSet());
1815        }
1816        else
1817        {
1818            // Project may be present in cache for 'default' workspace but does not exist in current JCR workspace
1819            throw new UnknownAmetysObjectException("There is no pages for '" + project.getName() + "', module '" + workspaceModule.getModuleName() + "'");
1820        }
1821    }
1822    
1823    private Set<String> _computePagesIds(Project project, WorkspaceModule workspaceModule)
1824    {
1825        Site site = project.getSite();
1826        String siteName = site != null ? site.getName() : null;
1827        if (StringUtils.isEmpty(siteName))
1828        {
1829            return null;
1830        }
1831        
1832        ModifiableResourceCollection moduleRoot = workspaceModule.getModuleRoot(project, false);
1833        if (moduleRoot != null)
1834        {
1835            Expression expression = new StringExpression(__PAGE_MODULES_VALUE, Operator.EQ, moduleRoot.getId());
1836            String query = PageQueryHelper.getPageXPathQuery(siteName, null, null, expression, null);
1837    
1838            return StreamSupport.stream(_resolver.query(query).spliterator(), false)
1839                        .map(page -> page.getId())
1840                        .collect(Collectors.toSet());
1841        }
1842        else
1843        {
1844            return Set.of();
1845        }
1846    }
1847
1848    /**
1849     * Activate the list of module of the project
1850     * @param project The project
1851     * @param moduleIds The list of modules. Can be null to activate all modules
1852     * @param additionalValues A list of optional additional values. Accepted values are : description, mailingList, inscriptionStatus, defaultProfile, tags, categoryTags, keywords and language
1853     */
1854    public void activateModules(Project project, Set<String> moduleIds, Map<String, Object> additionalValues)
1855    {
1856        Set<String> modules = moduleIds == null ? _moduleManagerEP.getExtensionsIds() : moduleIds;
1857        
1858        for (String moduleId : modules)
1859        {
1860            WorkspaceModule module = _moduleManagerEP.getModule(moduleId);
1861            if (module != null && !isModuleActivated(project, moduleId))
1862            {
1863                module.activateModule(project, additionalValues);
1864                project.addModule(moduleId);
1865            }
1866        }
1867        
1868        _setDefaultProfileForMembers(project, modules);
1869        
1870        project.saveChanges();
1871    }
1872
1873    private void _setDefaultProfileForMembers(Project project, Set<String> modules)
1874    {
1875        String profileForNewModule = StringUtils.defaultString(Config.getInstance().getValue("workspaces.profile.new.module"));
1876        
1877        if (profileForNewModule.equals(ProfileForNewModule.DEFAULT_MEMBER_PROFILE.name()))
1878        {
1879            Set<String> defaultProfiles = Set.of(StringUtils.defaultString(Config.getInstance().getValue("workspaces.profile.default")));
1880            Map<JCRProjectMember, Object> projectMembers = _projectMembers.getJCRProjectMembers(project);
1881            
1882            Set<WorkspaceModule> modulesForMembers = getProjectModulesForNewMembers(project);
1883            for (String moduleId : modules)
1884            {
1885                WorkspaceModule module = _moduleManagerEP.getModule(moduleId);
1886                Set<String> profiles = modulesForMembers.contains(module) ? defaultProfiles : Set.of();
1887                for (JCRProjectMember member : projectMembers.keySet())
1888                {
1889                    _projectMembers.setProfileOnModule(member, project, module, profiles);
1890                }
1891            }
1892        }
1893    }
1894    
1895    /**
1896     * Initialize the sitemap with the active module of the project
1897     * @param project The project
1898     * @param sitemap The sitemap
1899     */
1900    public void initializeModulesSitemap(Project project, Sitemap sitemap)
1901    {
1902        Set<String> modules = _moduleManagerEP.getExtensionsIds();
1903        
1904        for (String moduleId : modules)
1905        {
1906            if (_moduleManagerEP.hasExtension(moduleId))
1907            {
1908                WorkspaceModule module = _moduleManagerEP.getExtension(moduleId);
1909                
1910                if (isModuleActivated(project, moduleId))
1911                {
1912                    module.initializeSitemap(project, sitemap);
1913                }
1914            }
1915        }
1916    }
1917    
1918    /**
1919     * Determines if a module is activated
1920     * @param project The project
1921     * @param moduleId The id of module
1922     * @return true if the module the currently activated
1923     */
1924    public boolean isModuleActivated(Project project, String moduleId)
1925    {
1926        return ArrayUtils.contains(project.getModules(), moduleId);
1927    }
1928    
1929    /**
1930     * Remove the explorer root node of the project module, remove all events
1931     * related to that module and set it to deactivated
1932     * @param project The project
1933     * @param moduleIds The id of module to activate
1934     */
1935    public void deactivateModules(Project project, Set<String> moduleIds)
1936    {
1937        for (String moduleId : moduleIds)
1938        {
1939            WorkspaceModule module = _moduleManagerEP.getModule(moduleId);
1940            if (module != null && isModuleActivated(project, moduleId))
1941            {
1942                module.deactivateModule(project);
1943                project.removeModule(moduleId);
1944            }
1945        }
1946        
1947        project.saveChanges();
1948    }
1949    
1950    
1951    /**
1952     * Get the list of profiles configured for the workspaces' projects
1953     * @return The list of profiles as JSON
1954     */
1955    @Callable(rights = {ProjectConstants.RIGHT_PROJECT_CREATE_PRIVATE, ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_MODERATED, ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_OPENED, ProjectConstants.RIGHT_PROJECT_EDIT}, context = "/admin")
1956    public Map<String, Object> getProjectProfiles()
1957    {
1958        Map<String, Object> result = new HashMap<>();
1959        List<Map<String, Object>> profiles = _projectRightHelper.getProfiles().stream().map(p -> p.toJSON()).collect(Collectors.toList());
1960        result.put("profiles", profiles);
1961        return result;
1962    }
1963    
1964    /**
1965     * Get the site name holding the catalog of projects
1966     * @return the catalog's site name
1967     * @throws UnknownCatalogSiteException when the config is invalid
1968     */
1969    public String getCatalogSiteName() throws UnknownCatalogSiteException
1970    {
1971        String catalogSiteName = Config.getInstance().getValue("workspaces.catalog.site.name");
1972        if (!_siteManager.hasSite(catalogSiteName))
1973        {
1974            throw new UnknownCatalogSiteException("Unknown site '" + catalogSiteName + "'. The global Ametys configuration is invalid for the parameter 'workspaces.catalog.site.name'");
1975        }
1976        return catalogSiteName;
1977    }
1978    
1979    /**
1980     * Get the site name holding the users directory
1981     * @return the users directory's site name
1982     * @throws UnknownUserDirectorySiteException when the config is invalid
1983     */
1984    public String getUsersDirectorySiteName() throws UnknownUserDirectorySiteException
1985    {
1986        String udSiteName = Config.getInstance().getValue("workspaces.member.userdirectory.site.name");
1987        if (!_siteManager.hasSite(udSiteName))
1988        {
1989            throw new UnknownUserDirectorySiteException("Unknown site '" + udSiteName + "'. The global Ametys configuration is invalid for the parameter 'workspaces.member.userdirectory.site.name'");
1990        }
1991        return udSiteName;
1992    }
1993    
1994    @Override
1995    public boolean supports(Event event)
1996    {
1997        return event.getId().equals(ObservationConstants.EVENT_PROJECT_DELETED)
1998                || event.getId().equals(ObservationConstants.EVENT_PROJECT_UPDATED)
1999                || event.getId().equals(ObservationConstants.EVENT_PROJECT_ADDED)
2000                || event.getId().equals(org.ametys.web.ObservationConstants.EVENT_PAGE_ADDED)
2001                || event.getId().equals(org.ametys.web.ObservationConstants.EVENT_PAGE_DELETED);
2002    }
2003
2004    public int getPriority()
2005    {
2006        return 0;
2007    }
2008
2009    public void observe(Event event, Map<String, Object> transientVars) throws Exception
2010    {
2011        clearCaches();
2012    }
2013
2014    /**
2015     * Prefix project title
2016     * @param site the site
2017     * @param title the title
2018     */
2019    public void setProjectSiteTitle(Site site, String title)
2020    {
2021        I18nizableText i18nSiteTitle = new I18nizableText("plugin." + _pluginName, "PLUGINS_WORKSPACES_PROJECT_DEFAULT_PROJECT_WORKSPACE_TITLE", Arrays.asList(title));
2022        site.setTitle(_i18nUtils.translate(i18nSiteTitle));
2023    }
2024    
2025    private Project _computeProject(String projectName)
2026    {
2027        if (hasProject(projectName))
2028        {
2029            String uuid = _getUUIDCache().get(projectName);
2030            return _resolver.<Project>resolveById(uuid);
2031        }
2032        else
2033        {
2034            // Project may be present in cache for 'default' workspace but does not exist in current JCR workspace
2035            throw new UnknownAmetysObjectException("There is no site named '" + projectName + "'");
2036        }
2037    }
2038    
2039    /**
2040     * Check rights to create project
2041     * @param inscriptionStatus the inscription status
2042     * @param zoneItem the zoneItem containing catalog service. Must be a catalog service if not null
2043     */
2044    public void checkRightsForProjectCreation(InscriptionStatus inscriptionStatus, ZoneItem zoneItem)
2045    {
2046        SitemapElement catalogPage = zoneItem != null ? zoneItem.getZone().getSitemapElement() : null;
2047        
2048        if (catalogPage != null && !_projectRightHelper.hasCatalogReadAccess(zoneItem))
2049        {
2050            throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to create project from page '" + catalogPage.getId() + "' without sufficient rights");
2051        }
2052        
2053        switch (inscriptionStatus)
2054        {
2055            case PRIVATE:
2056                boolean hasRightToCreatePrivateProjetOnPages = catalogPage != null ? _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PRIVATE, catalogPage) == RightResult.RIGHT_ALLOW : false;
2057                if (!hasRightToCreatePrivateProjetOnPages && _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PRIVATE, "/${WorkspaceName}") != RightResult.RIGHT_ALLOW)
2058                {
2059                    throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to create private project without sufficient rights");
2060                }
2061                break;
2062            case MODERATED:
2063                boolean hasRightToCreateModeratedProjetOnPages = catalogPage != null ? _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_MODERATED, catalogPage) == RightResult.RIGHT_ALLOW : false;
2064                if (!hasRightToCreateModeratedProjetOnPages && _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_MODERATED, "/${WorkspaceName}") != RightResult.RIGHT_ALLOW)
2065                {
2066                    throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to create public project with moderation without sufficient rights");
2067                }
2068                break;
2069            case OPEN:
2070                boolean hasRightToCreateOpenProjetOnPages = catalogPage != null ? _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_OPENED, catalogPage) == RightResult.RIGHT_ALLOW : false;
2071                if (!hasRightToCreateOpenProjetOnPages && _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_OPENED, "/${WorkspaceName}") != RightResult.RIGHT_ALLOW)
2072                {
2073                    throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to create public project without sufficient rights");
2074                }
2075                break;
2076            default:
2077                throw new IllegalArgumentException("Inscription status '" + inscriptionStatus.toString() + "' is unknown");
2078        }
2079    }
2080    
2081    /**
2082     * Check rights to edit project
2083     * @param project the project
2084     * @param inscriptionStatus the inscription status
2085     * @param zoneItem the zoneItem containing catalog service. Must be a catalog service if not null
2086     */
2087    public void checkRightsForProjectEdition(Project project, InscriptionStatus inscriptionStatus, ZoneItem zoneItem)
2088    {
2089        InscriptionStatus oldInscriptionStatus = project.getInscriptionStatus();
2090        SitemapElement catalogPage = zoneItem != null ? zoneItem.getZone().getSitemapElement() : null;
2091        
2092        if (catalogPage != null && !_projectRightHelper.hasCatalogReadAccess(zoneItem))
2093        {
2094            throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to edit project from page '" + catalogPage.getId() + "' without sufficient rights");
2095        }
2096        
2097        if (oldInscriptionStatus != inscriptionStatus)
2098        {
2099            boolean canCreatePrivateProjet = _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PRIVATE, "/${WorkspaceName}") == RightResult.RIGHT_ALLOW
2100                    || (catalogPage != null ? _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PRIVATE, catalogPage) == RightResult.RIGHT_ALLOW : false);
2101            boolean canCreatePublicProjetWithModeration = _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_MODERATED, "/${WorkspaceName}") == RightResult.RIGHT_ALLOW
2102                    || (catalogPage != null ? _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_MODERATED, catalogPage) == RightResult.RIGHT_ALLOW : false);
2103            boolean canCreatePublicProjet = _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_OPENED, "/${WorkspaceName}") == RightResult.RIGHT_ALLOW
2104                    || (catalogPage != null ? _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_OPENED, catalogPage) == RightResult.RIGHT_ALLOW : false);
2105            
2106            switch (oldInscriptionStatus)
2107            {
2108                case PRIVATE:
2109                    if (!canCreatePrivateProjet)
2110                    {
2111                        throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to edit private project without sufficient rights");
2112                    }
2113                    break;
2114                case MODERATED:
2115                    if (!canCreatePublicProjetWithModeration)
2116                    {
2117                        throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to edit public project with moderation without sufficient rights");
2118                    }
2119                    break;
2120                case OPEN:
2121                    if (!canCreatePublicProjet)
2122                    {
2123                        throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to edit public project without sufficient rights");
2124                    }
2125                    break;
2126                default:
2127                    throw new IllegalArgumentException("Inscription status '" + oldInscriptionStatus.toString() + "' is unknown");
2128            }
2129            
2130            switch (inscriptionStatus)
2131            {
2132                case PRIVATE:
2133                    if (!canCreatePrivateProjet)
2134                    {
2135                        throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to edit project to private project without sufficient rights");
2136                    }
2137                    break;
2138                case MODERATED:
2139                    if (!canCreatePublicProjetWithModeration)
2140                    {
2141                        throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to edit project to public project with moderation without sufficient rights");
2142                    }
2143                    break;
2144                case OPEN:
2145                    if (!canCreatePublicProjet)
2146                    {
2147                        throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to edit project to public project without sufficient rights");
2148                    }
2149                    break;
2150                default:
2151                    throw new IllegalArgumentException("Inscription status '" + inscriptionStatus.toString() + "' is unknown");
2152            }
2153        }
2154    }
2155    
2156    /**
2157     * Clear the site cache
2158     */
2159    public void clearCaches ()
2160    {
2161        _getMemorySiteAssociationCache().invalidateAll();
2162        _getMemoryProjectCache().invalidateAll();
2163        _getMemoryPageCache().invalidateAll();
2164        _getRequestProjectCache().invalidateAll();
2165        _getRequestPageCache().invalidateAll();
2166    }
2167    
2168    private Cache<String, List<Pair<String, String>>> _getMemorySiteAssociationCache()
2169    {
2170        return _cacheManager.get(MEMORY_SITEASSOCIATION_CACHE);
2171    }
2172    
2173    private Cache<String, String> _getMemoryProjectCache()
2174    {
2175        return _cacheManager.get(MEMORY_PROJECTIDBYNAMECACHE);
2176    }
2177    
2178    private Cache<ModuleCacheKey, Set<String>> _getMemoryPageCache()
2179    {
2180        return _cacheManager.get(MEMORY_PAGESBYIDCACHE);
2181    }
2182    
2183    private Cache<RequestProjectCacheKey, Project> _getRequestProjectCache()
2184    {
2185        return _cacheManager.get(REQUEST_PROJECTBYID_CACHE);
2186    }
2187    
2188    private Cache<RequestModuleCacheKey, Set<Page>> _getRequestPageCache()
2189    {
2190        return _cacheManager.get(REQUEST_PAGESBYPROJECTANDMODULE_CACHE);
2191    }
2192
2193    
2194    /**
2195     * Creates the caches
2196     */
2197    protected void _createCaches()
2198    {
2199        _cacheManager.createMemoryCache(MEMORY_SITEASSOCIATION_CACHE,
2200                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_CACHE_PROJECT_MANAGER_LABEL"),
2201                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_CACHE_PROJECT_MANAGER_DESCRIPTION"),
2202                true,
2203                null);
2204        _cacheManager.createMemoryCache(MEMORY_PROJECTIDBYNAMECACHE,
2205                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_MANAGER_UUID_CACHE_LABEL"),
2206                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_MANAGER_UUID_CACHE_DESCRIPTION"),
2207                true,
2208                null);
2209        _cacheManager.createMemoryCache(MEMORY_PAGESBYIDCACHE,
2210                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_MANAGER_PAGEUUID_CACHE_LABEL"),
2211                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_MANAGER_PAGEUUID_CACHE_DESCRIPTION"),
2212                true,
2213                null);
2214        _cacheManager.createRequestCache(REQUEST_PROJECTBYID_CACHE,
2215                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_MANAGER_REQUEST_CACHE_LABEL"),
2216                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_MANAGER_REQUEST_CACHE_DESCRIPTION"),
2217                false);
2218        _cacheManager.createRequestCache(REQUEST_PAGESBYPROJECTANDMODULE_CACHE,
2219                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_MANAGER_PAGEREQUEST_CACHE_LABEL"),
2220                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_MANAGER_PAGEREQUEST_CACHE_DESCRIPTION"),
2221                false);
2222    }
2223    
2224    private synchronized Map<String, String> _getUUIDCache()
2225    {
2226        if (!_getMemoryProjectCache().hasKey(__IS_CACHE_FILLED))
2227        {
2228            Session defaultSession = null;
2229            try
2230            {
2231                // Force default workspace to execute query
2232                defaultSession = _repository.login(RepositoryConstants.DEFAULT_WORKSPACE);
2233                
2234                String jcrQuery = "//element(*, ametys:project)";
2235                
2236                AmetysObjectIterable<Project> projects = _resolver.query(jcrQuery, defaultSession);
2237                
2238                for (Project project : projects)
2239                {
2240                    _getMemoryProjectCache().put(project.getName(), project.getId());
2241                }
2242                
2243                _getMemoryProjectCache().put(__IS_CACHE_FILLED, null);
2244            }
2245            catch (RepositoryException e)
2246            {
2247                throw new AmetysRepositoryException(e);
2248            }
2249            finally
2250            {
2251                if (defaultSession != null)
2252                {
2253                    defaultSession.logout();
2254                }
2255            }
2256        }
2257        
2258        Map<String, String> cacheAsMap = _getMemoryProjectCache().asMap();
2259        cacheAsMap.remove(__IS_CACHE_FILLED);
2260        return cacheAsMap;
2261    }
2262    
2263    private static final class RequestProjectCacheKey extends AbstractCacheKey
2264    {
2265        private RequestProjectCacheKey(String projectName, String workspaceName)
2266        {
2267            super(projectName, workspaceName);
2268        }
2269        
2270        static RequestProjectCacheKey of(String projectName, String workspaceName)
2271        {
2272            return new RequestProjectCacheKey(projectName, workspaceName);
2273        }
2274    }
2275    
2276    private static final class ModuleCacheKey extends AbstractCacheKey
2277    {
2278        private ModuleCacheKey(String projectName, String moduleId)
2279        {
2280            super(projectName, moduleId);
2281        }
2282        
2283        static ModuleCacheKey of(String projectName, String moduleId)
2284        {
2285            return new ModuleCacheKey(projectName, moduleId);
2286        }
2287    }
2288    
2289    private static final class RequestModuleCacheKey extends AbstractCacheKey
2290    {
2291        private RequestModuleCacheKey(String projectName, String moduleId, String workspaceName)
2292        {
2293            super(projectName, moduleId, workspaceName);
2294        }
2295        
2296        static RequestModuleCacheKey of(String projectName, String moduleId, String workspaceName)
2297        {
2298            return new RequestModuleCacheKey(projectName, moduleId, workspaceName);
2299        }
2300    }
2301    
2302    private Request _getRequest ()
2303    {
2304        try
2305        {
2306            return (Request) _context.get(ContextHelper.CONTEXT_REQUEST_OBJECT);
2307        }
2308        catch (ContextException ce)
2309        {
2310            getLogger().info("Unable to get the request", ce);
2311            return null;
2312        }
2313    }
2314
2315    /**
2316     * Retrieves all projects for client side
2317     * @return the projects
2318     */
2319    @Callable(rights = "Runtime_Rights_Admin_Access", context = "/admin")
2320    public List<Map<String, Object>> getProjectsStatisticsForClientSide()
2321    {
2322        return getProjects()
2323                .stream()
2324                .map(p -> getProjectStatistics(p))
2325                .collect(Collectors.toList());
2326    }
2327    
2328    /**
2329     * Retrieves the standard information of a project
2330     * @param project The project
2331     * @return The map of information
2332     */
2333    public Map<String, Object> getProjectStatistics(Project project)
2334    {
2335        Map<String, Object> statistics = new HashMap<>();
2336
2337        statistics.put("title", project.getTitle());
2338
2339        long totalSize = 0;
2340        for (WorkspaceModule moduleManager : _moduleManagerEP.getModules())
2341        {
2342            Map<String, Object> moduleStatistics = moduleManager.getStatistics(project);
2343            statistics.putAll(moduleStatistics);
2344            Long size = (Long) moduleStatistics.get(moduleManager.getModuleSizeKey());
2345            totalSize += (size != null && size >= 0) ? (Long) moduleStatistics.get(moduleManager.getModuleSizeKey()) : 0;
2346        }
2347
2348        statistics.put("totalSize", totalSize);
2349
2350        ZonedDateTime creationDate = project.getCreationDate();
2351        
2352        statistics.put("creationDate", creationDate);
2353        statistics.put("managers", Arrays.stream(project.getManagers())
2354                .map(u -> _userHelper.user2json(u))
2355                .collect(Collectors.toList()));
2356
2357        return statistics;
2358    }
2359
2360    /**
2361     * Retrieves all projects for client side
2362     * @return the projects
2363     */
2364    @Callable(rights = "Runtime_Rights_Admin_Access", context = "/admin")
2365    public List<Map<String, Object>> getProjectsStatisticsColumnsModel()
2366    {
2367        return getStatisticHeaders()
2368                .stream()
2369                .map(p -> p.convertToJSON())
2370                .collect(Collectors.toList());
2371    }
2372
2373    private List<StatisticColumn> getStatisticHeaders()
2374    {
2375
2376        List<StatisticColumn> flatStatisticHeaders = getFlatStatisticHeaders();
2377        List<StatisticColumn> headers = new ArrayList<>();
2378        for (StatisticColumn statisticColumn : flatStatisticHeaders)
2379        {
2380            // this column have a parent, we have to find it and attach it
2381            if (statisticColumn.getGroup() != null)
2382            {
2383                Optional<StatisticColumn> parent = flatStatisticHeaders.stream()
2384                                                    .filter(column -> column.getId().equals(statisticColumn.getGroup()))
2385                                                    .findAny();
2386                if (parent.isPresent())
2387                {
2388                    parent.get().addSubColumn(statisticColumn);
2389                }
2390            }
2391            else
2392            {
2393                headers.add(statisticColumn);
2394            }
2395        }
2396        
2397        return headers;
2398    }
2399    
2400    private List<StatisticColumn> getFlatStatisticHeaders()
2401    {
2402        List<StatisticColumn> headers = new ArrayList<>();
2403        headers.add(new StatisticColumn("title", new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_STATISTICS_TOOL_COLUMN_TITLE"))
2404                .withType(StatisticsColumnType.STRING)
2405                .withWidth(200)
2406                .withRenderer("Ametys.plugins.workspaces.project.tool.ProjectsGridHelper.renderTitle"));
2407        headers.add(new StatisticColumn("creationDate", new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_STATISTICS_TOOL_COLUMN_CREATION"))
2408                .withType(StatisticsColumnType.DATE)
2409                .withWidth(150));
2410        headers.add(new StatisticColumn("managers", new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_STATISTICS_TOOL_COLUMN_MANAGERS"))
2411                .withRenderer("Ametys.grid.GridColumnHelper.renderUser")
2412                .withFilter(false));
2413        for (WorkspaceModule moduleManager : _moduleManagerEP.getModules())
2414        {
2415            headers.addAll(moduleManager.getStatisticModel());
2416        }
2417        
2418        StatisticColumn elements = new StatisticColumn(WorkspaceModule.GROUP_HEADER_ELEMENTS_ID, new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_STATISTICS_TOOL_COLUMN_ELEMENTS"))
2419                .withFilter(false);
2420        headers.add(elements);
2421
2422        StatisticColumn activatedModules = new StatisticColumn(WorkspaceModule.GROUP_HEADER_ACTIVATED_ID, new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_STATISTICS_TOOL_COLUMN_ACTIVE_MODULES"))
2423                .isHidden(true)
2424                .withFilter(false);
2425        headers.add(activatedModules);
2426        
2427        StatisticColumn lastActivity = new StatisticColumn(WorkspaceModule.GROUP_HEADER_LAST_ACTIVITY_ID, new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_STATISTICS_TOOL_COLUMN_LAST_ACTIVITY")).isHidden(true);
2428        headers.add(lastActivity);
2429
2430        StatisticColumn modulesSize = new StatisticColumn(WorkspaceModule.GROUP_HEADER_SIZE_ID, new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_STATISTICS_TOOL_COLUMN_MODULES_SIZE"))
2431                .withFilter(false);
2432        modulesSize.addSubColumn(new StatisticColumn("totalSize", new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_STATISTICS_TOOL_COLUMN_MODULES_SIZE_TOTAL"))
2433                .withRenderer("Ametys.plugins.workspaces.project.tool.ProjectsGridHelper.renderSize")
2434                .withType(StatisticsColumnType.LONG));
2435        
2436        headers.add(modulesSize);
2437        
2438        return headers;
2439    }
2440    
2441    /**
2442     * Check if the user is in one of the populations of project
2443     * @param project the project
2444     * @param user the user
2445     * @return true if the user is in one of the populations of project
2446     */
2447    public boolean isUserInProjectPopulations(Project project, UserIdentity user)
2448    {
2449        Site site = project.getSite();
2450
2451        if (site == null)
2452        {
2453            throw new IllegalArgumentException("Cannot determine if user " + UserIdentity.userIdentityToString(user) + " can connect to the project " + project.getName() + " since the project has no associated site to determine the populations");
2454        }
2455        String siteName = site.getName();
2456
2457        Set<String> populations = _populationContextHelper.getUserPopulationsOnContext("/sites/" + siteName, false);
2458        Set<String> frontPopulations = _populationContextHelper.getUserPopulationsOnContext("/sites-fo/" + siteName, false);
2459        
2460        return populations.contains(user.getPopulationId()) || frontPopulations.contains(user.getPopulationId());
2461    }
2462    
2463    /**
2464     * Thrown to indicate that the catalog site is unknown
2465     */
2466    public class UnknownCatalogSiteException extends IllegalArgumentException
2467    {
2468        /**
2469         * Construct a {@code UnknownCatalogSiteException} with the specified message
2470         * @param message the message
2471         */
2472        public UnknownCatalogSiteException(String message)
2473        {
2474            super(message);
2475        }
2476    }
2477    
2478    /**
2479     * Thrown to indicate that the user directory site is unknown
2480     */
2481    public class UnknownUserDirectorySiteException extends IllegalArgumentException
2482    {
2483        /**
2484         * Construct a {@code UnknownUserDirectorySiteException} with the specified message
2485         * @param message the message
2486         */
2487        public UnknownUserDirectorySiteException(String message)
2488        {
2489            super(message);
2490        }
2491    }
2492}