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.LinkedHashSet;
026import java.util.List;
027import java.util.Map;
028import java.util.Objects;
029import java.util.Optional;
030import java.util.Set;
031import java.util.function.Predicate;
032import java.util.regex.Pattern;
033import java.util.stream.Collectors;
034import java.util.stream.Stream;
035import java.util.stream.StreamSupport;
036
037import javax.jcr.Node;
038import javax.jcr.PathNotFoundException;
039import javax.jcr.RepositoryException;
040import javax.jcr.Session;
041import javax.jcr.Value;
042
043import org.apache.avalon.framework.activity.Initializable;
044import org.apache.avalon.framework.component.Component;
045import org.apache.avalon.framework.context.Context;
046import org.apache.avalon.framework.context.ContextException;
047import org.apache.avalon.framework.context.Contextualizable;
048import org.apache.avalon.framework.logger.AbstractLogEnabled;
049import org.apache.avalon.framework.service.ServiceException;
050import org.apache.avalon.framework.service.ServiceManager;
051import org.apache.avalon.framework.service.Serviceable;
052import org.apache.cocoon.components.ContextHelper;
053import org.apache.cocoon.environment.Request;
054import org.apache.commons.collections.CollectionUtils;
055import org.apache.commons.lang3.ArrayUtils;
056import org.apache.commons.lang3.StringUtils;
057import org.apache.commons.lang3.tuple.Pair;
058
059import org.ametys.cms.fo.ForceDefaultRepositoryWorkspaceCallableDecorator;
060import org.ametys.cms.tag.Tag;
061import org.ametys.core.cache.AbstractCacheManager;
062import org.ametys.core.cache.AbstractCacheManager.CacheType;
063import org.ametys.core.cache.Cache;
064import org.ametys.core.cache.CacheException;
065import org.ametys.core.group.GroupDirectoryContextHelper;
066import org.ametys.core.group.GroupIdentity;
067import org.ametys.core.observation.Event;
068import org.ametys.core.observation.ObservationManager;
069import org.ametys.core.observation.Observer;
070import org.ametys.core.right.RightManager;
071import org.ametys.core.right.RightManager.RightResult;
072import org.ametys.core.ui.Callable;
073import org.ametys.core.user.CurrentUserProvider;
074import org.ametys.core.user.UserIdentity;
075import org.ametys.core.user.population.PopulationContextHelper;
076import org.ametys.core.util.I18nUtils;
077import org.ametys.core.util.LambdaUtils;
078import org.ametys.plugins.core.impl.cache.AbstractCacheKey;
079import org.ametys.plugins.core.search.UserAndGroupSearchManager;
080import org.ametys.plugins.core.user.UserHelper;
081import org.ametys.plugins.explorer.ExplorerNode;
082import org.ametys.plugins.explorer.resources.ModifiableResourceCollection;
083import org.ametys.plugins.repository.AmetysObject;
084import org.ametys.plugins.repository.AmetysObjectIterable;
085import org.ametys.plugins.repository.AmetysObjectResolver;
086import org.ametys.plugins.repository.AmetysRepositoryException;
087import org.ametys.plugins.repository.CollectionIterable;
088import org.ametys.plugins.repository.ModifiableAmetysObject;
089import org.ametys.plugins.repository.ModifiableTraversableAmetysObject;
090import org.ametys.plugins.repository.RepositoryConstants;
091import org.ametys.plugins.repository.UnknownAmetysObjectException;
092import org.ametys.plugins.repository.jcr.JCRAmetysObject;
093import org.ametys.plugins.repository.provider.AbstractRepository;
094import org.ametys.plugins.repository.provider.JackrabbitRepository;
095import org.ametys.plugins.repository.provider.WorkspaceSelector;
096import org.ametys.plugins.repository.query.QueryHelper;
097import org.ametys.plugins.repository.query.expression.Expression;
098import org.ametys.plugins.repository.query.expression.Expression.Operator;
099import org.ametys.plugins.repository.query.expression.StringExpression;
100import org.ametys.plugins.workspaces.ObservationConstants;
101import org.ametys.plugins.workspaces.catalog.CatalogSiteType;
102import org.ametys.plugins.workspaces.categories.Category;
103import org.ametys.plugins.workspaces.categories.CategoryProviderExtensionPoint;
104import org.ametys.plugins.workspaces.keywords.KeywordProviderExtensionPoint;
105import org.ametys.plugins.workspaces.members.JCRProjectMember;
106import org.ametys.plugins.workspaces.members.JCRProjectMember.MemberType;
107import org.ametys.plugins.workspaces.members.ProjectMemberManager;
108import org.ametys.plugins.workspaces.members.ProjectMemberManager.ProjectMember;
109import org.ametys.plugins.workspaces.project.modules.WorkspaceModule;
110import org.ametys.plugins.workspaces.project.modules.WorkspaceModuleExtensionPoint;
111import org.ametys.plugins.workspaces.project.objects.Project;
112import org.ametys.plugins.workspaces.project.objects.Project.InscriptionStatus;
113import org.ametys.plugins.workspaces.project.rights.ProjectRightHelper;
114import org.ametys.plugins.workspaces.util.StatisticColumn;
115import org.ametys.plugins.workspaces.util.StatisticsColumnType;
116import org.ametys.runtime.authentication.AccessDeniedException;
117import org.ametys.runtime.config.Config;
118import org.ametys.runtime.i18n.I18nizableText;
119import org.ametys.runtime.plugin.component.PluginAware;
120import org.ametys.web.repository.SiteAwareAmetysObject;
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.getValueOrDefault(ProjectWorkspaceSiteType.PROJECT_OVERRIDE_MEMBERS_MODULES_POLICY_SITE_PARAM, 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, decorators = ForceDefaultRepositoryWorkspaceCallableDecorator.DECORATOR_ID)
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, decorators = ForceDefaultRepositoryWorkspaceCallableDecorator.DECORATOR_ID)
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, decorators = ForceDefaultRepositoryWorkspaceCallableDecorator.DECORATOR_ID)
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_EXTERNAL_POPULATIONS_SITE_PARAM);
918            
919            // Check if project site overrides catalog configuration
920            String externalPopulationPolicy = site.getValueOrDefault(ProjectWorkspaceSiteType.PROJECT_OVERRIDE_EXTERNAL_POPULATION_POLICY_SITE_PARAM, ProjectWorkspaceSiteType.ExternalPopulationPolicy.GLOBAL.name());
921            if (externalPopulationPolicy.equals(ProjectWorkspaceSiteType.ExternalPopulationPolicy.EXTERNAL_POPULATION_BY_PROJECT.name()))
922            {
923                excludedPopulationsString = site.getValue(ProjectWorkspaceSiteType.PROJECT_EXTERNAL_POPULATIONS_PROJECT_SITE_PARAM);
924            }
925            
926            List<String> excludedPopulationsList = Arrays.asList(StringUtils.split(StringUtils.defaultString(excludedPopulationsString), ","));
927            
928            if (!excludedPopulationsList.isEmpty())
929            {
930                userPopulations.removeAll(excludedPopulationsList);
931            }
932        }
933
934        return userPopulations;
935    }
936
937    /**
938     * Retrieves the mapping of all the projects name with their title (regarless user rights)
939     * @return the map (projectName, projectTitle) for all projects
940     */
941    @Callable(rights = "Runtime_Rights_Admin_Access", context = "/admin")
942    public List<Map<String, Object>> getProjectsData()
943    {
944        return getProjects()
945                .stream()
946                .map(p -> _project2json(p))
947                .collect(Collectors.toList());
948    }
949    
950    /**
951     * Get the project's main properties as json object
952     * @param project the project
953     * @return the json representation of project
954     */
955    protected Map<String, Object> _project2json(Project project)
956    {
957        Map<String, Object> json = new HashMap<>();
958        
959        json.put("id", project.getId());
960        json.put("name", project.getName());
961        json.put("title", project.getTitle());
962        json.put("url", getProjectUrl(project, StringUtils.EMPTY));
963        
964        return json;
965    }
966    /**
967     * Retrieves the project names
968     * @return the project names
969     */
970    @Callable(rights = "Runtime_Rights_Admin_Access", context = "/admin")
971    public Collection<String> getProjectNames()
972    {
973        // As cache is computed from default JCR workspace, we need to filter on sites that exist into the current JCR workspace
974        return _getUUIDCache().entrySet().stream()
975                .filter(e -> _resolver.hasAmetysObjectForId(e.getValue()))
976                .map(Map.Entry::getKey)
977                .collect(Collectors.toList());
978    }
979    
980    /**
981     * Return the root for projects
982     * The root node will be created if necessary
983     * @return The root for projects
984     */
985    public ModifiableTraversableAmetysObject getProjectsRoot()
986    {
987        try
988        {
989            ModifiableTraversableAmetysObject pluginsNode = _resolver.resolveByPath("/ametys:plugins");
990            ModifiableTraversableAmetysObject workspacesPluginNode = _getOrCreateObject(pluginsNode, __WORKSPACES_PLUGIN_NODE_NAME, __WORKSPACES_PLUGIN_NODE_TYPE);
991            return _getOrCreateObject(workspacesPluginNode, __PROJECTS_ROOT_NODE_NAME, __PROJECTS_ROOT_NODE_TYPE);
992        }
993        catch (AmetysRepositoryException e)
994        {
995            throw new AmetysRepositoryException("Error getting the projects root node.", e);
996        }
997    }
998    
999    /**
1000     * Retrieves the standard information of a project
1001     * @param projectId Identifier of the project
1002     * @return The map of information
1003     */
1004    @Callable(rights = "Runtime_Rights_Admin_Access", context = "/admin")
1005    public Map<String, Object> getProjectProperties(String projectId)
1006    {
1007        return getProjectProperties((Project) _resolver.resolveById(projectId));
1008    }
1009    
1010    /**
1011     * Retrieves the standard information of a project
1012     * @param project The project
1013     * @return The map of information
1014     */
1015    public Map<String, Object> getProjectProperties(Project project)
1016    {
1017        Map<String, Object> info = new HashMap<>();
1018
1019        info.put("id", project.getId());
1020        info.put("name", project.getName());
1021        info.put("type", "project");
1022
1023        info.put("title", project.getTitle());
1024        info.put("description", project.getDescription());
1025        info.put("inscriptionStatus", project.getInscriptionStatus().toString());
1026        info.put("defaultProfile", project.getDefaultProfile());
1027
1028        info.put("creationDate", project.getCreationDate());
1029
1030        // check if the project workspace configuration is valid
1031        Site site = project.getSite();
1032        boolean valid = site != null && _siteConfigurationManager.isSiteConfigurationValid(site);
1033        
1034        Set<String> categories = project.getCategories();
1035        info.put("categories", categories.stream()
1036                .map(c -> _categoryProviderEP.getTag(c, new HashMap<>()))
1037                .filter(Objects::nonNull)
1038                .map(t -> _tag2json(t))
1039                .collect(Collectors.toList()));
1040        
1041        info.put("keywords", Arrays.stream(project.getKeywords())
1042                .map(c -> _keywordProviderEP.getTag(c, new HashMap<>()))
1043                .filter(Objects::nonNull)
1044                .map(t -> _tag2json(t))
1045                .collect(Collectors.toList()));
1046        
1047        info.put("valid", valid);
1048        
1049        UserIdentity[] managers = project.getManagers();
1050        info.put("managers", Arrays.stream(managers)
1051                .map(u -> _userHelper.user2json(u))
1052                .collect(Collectors.toList()));
1053        
1054        Map<String, String> siteProps = new HashMap<>();
1055        // site map with id ,name, title and url property
1056        // { id: site id, name: site name, title: site title, url: site url }
1057        if (site != null)
1058        {
1059            siteProps.put("id", site.getId());
1060            siteProps.put("name", site.getName());
1061            siteProps.put("title", site.getTitle());
1062            siteProps.put("url", site.getUrl());
1063        }
1064        info.put("site", siteProps);
1065
1066        return info;
1067    }
1068    
1069    private Map<String, Object> _tag2json(Tag tag)
1070    {
1071        Map<String, Object> json = new HashMap<>();
1072        json.put("id", tag.getId());
1073        json.put("name", tag.getName());
1074        json.put("title", tag.getTitle());
1075        return json;
1076    }
1077
1078    /**
1079     * Get the project URL.
1080     * @param project The project
1081     * @param defaultValue The default value to use if there is no site
1082     * @return The project URL if a site is configured, otherwise return the default value.
1083     */
1084    public String getProjectUrl(Project project, String defaultValue)
1085    {
1086        Site site = project.getSite();
1087        if (site == null)
1088        {
1089            return defaultValue;
1090        }
1091        else
1092        {
1093            return site.getUrl();
1094        }
1095    }
1096    
1097    /**
1098     * Create a project
1099     * @param name The project name
1100     * @param title The project title
1101     * @param description The project description
1102     * @param emailList Project mailing list
1103     * @param inscriptionStatus The inscription status of the project
1104     * @param defaultProfile The default profile for new members
1105     * @return A map containing the id of the new project or an error key.
1106     */
1107    @Callable (rights = Callable.CHECKED_BY_IMPLEMENTATION, decorators = ForceDefaultRepositoryWorkspaceCallableDecorator.DECORATOR_ID)
1108    public Map<String, Object> createProject(String name, String title, String description, String emailList, String inscriptionStatus, String defaultProfile)
1109    {
1110        checkRightsForProjectCreation(InscriptionStatus.valueOf(inscriptionStatus.toUpperCase()), null);
1111
1112        Map<String, Object> result = new HashMap<>();
1113        List<String> errors = new ArrayList<>();
1114        
1115        Map<String, Object> additionalValues = new HashMap<>();
1116        additionalValues.put("description", description);
1117        additionalValues.put("emailList", emailList);
1118        additionalValues.put("inscriptionStatus", inscriptionStatus);
1119        additionalValues.put("defaultProfile", defaultProfile);
1120        
1121        Project project = createProject(name, title, additionalValues, null, errors);
1122        
1123        if (CollectionUtils.isEmpty(errors))
1124        {
1125            result.put("id", project.getId());
1126        }
1127        else
1128        {
1129            result.put("error", errors.get(0));
1130        }
1131        
1132        return result;
1133    }
1134    
1135    /**
1136     * Create a project
1137     * @param name The project name
1138     * @param title The project title
1139     * @param additionalValues A list of optional additional values. Accepted values are : description, mailingList, inscriptionStatus, defaultProfile, tags, categoryTags, keywords and language
1140     * @param modulesIds The list of modules to activate. Can be null to activate all modules
1141     * @param errors A list that will be populated with the encountered errors. If null, errors will not be tracked.
1142     * @return The id of the new project
1143     */
1144    public Project createProject(String name, String title, Map<String, Object> additionalValues, Set<String> modulesIds, List<String> errors)
1145    {
1146        if (StringUtils.isEmpty(title))
1147        {
1148            throw new IllegalArgumentException(String.format("Cannot create project. Title is mandatory"));
1149        }
1150        
1151        ModifiableTraversableAmetysObject projectsRoot = getProjectsRoot();
1152        
1153        // Project name should be unique
1154        if (hasProject(name))
1155        {
1156            if (getLogger().isWarnEnabled())
1157            {
1158                getLogger().warn(String.format("A project with the name '%s' already exists", name));
1159            }
1160            
1161            if (errors != null)
1162            {
1163                errors.add("project-exists");
1164            }
1165            
1166            return null;
1167        }
1168        
1169        Project project = projectsRoot.createChild(name, Project.NODE_TYPE);
1170        project.setTitle(title);
1171        String description = (String) additionalValues.getOrDefault("description", null);
1172        if (StringUtils.isNotEmpty(description))
1173        {
1174            project.setDescription(description);
1175        }
1176        String mailingList = (String) additionalValues.getOrDefault("emailList", null);
1177        if (StringUtils.isNotEmpty(mailingList))
1178        {
1179            project.setMailingList(mailingList);
1180        }
1181        
1182        String inscriptionStatus = (String) additionalValues.getOrDefault("inscriptionStatus", null);
1183        if (StringUtils.isNotEmpty(inscriptionStatus))
1184        {
1185            project.setInscriptionStatus(inscriptionStatus);
1186        }
1187        
1188        String defaultProfile = (String) additionalValues.getOrDefault("defaultProfile", null);
1189        if (StringUtils.isNotEmpty(defaultProfile))
1190        {
1191            project.setDefaultProfile(defaultProfile);
1192        }
1193        
1194        @SuppressWarnings("unchecked")
1195        List<String> tags = (List<String>) additionalValues.getOrDefault("tags", null);
1196        if (tags != null)
1197        {
1198            project.setTags(tags);
1199        }
1200        @SuppressWarnings("unchecked")
1201        List<String> categoryTags = (List<String>) additionalValues.getOrDefault("categoryTags", null);
1202        if (categoryTags != null)
1203        {
1204            project.setCategoryTags(categoryTags);
1205        }
1206        
1207        @SuppressWarnings("unchecked")
1208        List<String> keywords = (List<String>) additionalValues.getOrDefault("keywords", null);
1209        if (keywords != null)
1210        {
1211            project.setKeywords(keywords.toArray(new String[keywords.size()]));
1212        }
1213
1214        project.setCreationDate(ZonedDateTime.now());
1215        
1216        // Create the project workspace = a site + a set of pages
1217        _createProjectWorkspace(project, errors);
1218        
1219        activateModules(project, modulesIds, additionalValues);
1220        
1221        if (CollectionUtils.isEmpty(errors))
1222        {
1223            project.saveChanges();
1224         
1225            // Notify observers
1226            Map<String, Object> eventParams = new HashMap<>();
1227            eventParams.put(ObservationConstants.ARGS_PROJECT, project);
1228            _observationManager.notify(new Event(ObservationConstants.EVENT_PROJECT_ADDED, _currentUserProvider.getUser(), eventParams));
1229            
1230        }
1231        else
1232        {
1233            deleteProject(project);
1234        }
1235        
1236        clearCaches();
1237        
1238        return project;
1239    }
1240    
1241    /**
1242     * Edit a project
1243     * @param id The project identifier
1244     * @param title The title to set
1245     * @param description The description to set
1246     * @param mailingList Project mailing list
1247     * @param inscriptionStatus The inscription status of the project
1248     * @param defaultProfile The default profile for new members
1249     */
1250    @Callable(rights = ProjectConstants.RIGHT_PROJECT_EDIT, context = "/admin")
1251    public void editProject(String id, String title, String description, String mailingList, String inscriptionStatus, String defaultProfile)
1252    {
1253        Project project = _resolver.resolveById(id);
1254        editProject(project, title, description, mailingList, inscriptionStatus, defaultProfile);
1255    }
1256    
1257    /**
1258     * Edit a project
1259     * @param project The project
1260     * @param title The title to set
1261     * @param description The description to set
1262     * @param mailingList Project mailing list
1263     * @param inscriptionStatus The inscription status of the project
1264     * @param defaultProfile The default profile for new members
1265     */
1266    public void editProject(Project project, String title, String description, String mailingList, String inscriptionStatus, String defaultProfile)
1267    {
1268        checkRightsForProjectEdition(project, InscriptionStatus.valueOf(inscriptionStatus.toUpperCase()), null);
1269        
1270        project.setTitle(title);
1271        
1272        if (StringUtils.isNotEmpty(description))
1273        {
1274            project.setDescription(description);
1275        }
1276        else
1277        {
1278            project.removeDescription();
1279        }
1280        
1281        if (StringUtils.isNotEmpty(mailingList))
1282        {
1283            project.setMailingList(mailingList);
1284        }
1285        else
1286        {
1287            project.removeMailingList();
1288        }
1289
1290        project.setInscriptionStatus(inscriptionStatus);
1291        project.setDefaultProfile(defaultProfile);
1292        
1293        project.saveChanges();
1294        
1295        // Notify observers
1296        Map<String, Object> eventParams = new HashMap<>();
1297        eventParams.put(ObservationConstants.ARGS_PROJECT, project);
1298        eventParams.put(org.ametys.plugins.workspaces.ObservationConstants.ARGS_PROJECT_ID, project.getId());
1299        _observationManager.notify(new Event(ObservationConstants.EVENT_PROJECT_UPDATED, _currentUserProvider.getUser(), eventParams));
1300    }
1301    
1302    /**
1303     * Delete a list of project.
1304     * @param ids The ids of projects to delete
1305     * @return The ids of the deleted projects, unknowns projects and the deleted sites
1306     */
1307    @Callable(rights = ProjectConstants.RIGHT_PROJECT_DELETE, context = "/admin")
1308    public Map<String, Object> deleteProjectsByIds(List<String> ids)
1309    {
1310        Map<String, Object> result = new HashMap<>();
1311        List<Map<String, Object>> deleted = new ArrayList<>();
1312        List<String> unknowns = new ArrayList<>();
1313        
1314        for (String id : ids)
1315        {
1316            try
1317            {
1318                Project project = _resolver.resolveById(id);
1319                
1320                Map<String, Object> projectInfo = new HashMap<>();
1321                projectInfo.put("id", id);
1322                projectInfo.put("title", project.getTitle());
1323                projectInfo.put("sites", deleteProject(project));
1324                
1325                deleted.add(projectInfo);
1326            }
1327            catch (UnknownAmetysObjectException e)
1328            {
1329                getLogger().warn(String.format("Unable to delete the definition of id '%s', because it does not exist.", id), e);
1330                unknowns.add(id);
1331            }
1332        }
1333        
1334        result.put("deleted", deleted);
1335        result.put("unknowns", unknowns);
1336        
1337        return result;
1338    }
1339    
1340    /**
1341     * Delete a project.
1342     * @param projects The list of projects to delete
1343     * @return list of deleted sites (each list entry contains a data map with
1344     *         the id and the name of the delete site).
1345     */
1346    public List<Map<String, String>> deleteProject(List<Project> projects)
1347    {
1348        List<Map<String, String>> deletedSitesInfo = new ArrayList<>();
1349        
1350        for (Project project : projects)
1351        {
1352            deletedSitesInfo.addAll(deleteProject(project));
1353        }
1354        
1355        return deletedSitesInfo;
1356    }
1357    
1358    /**
1359     * Delete a project and its sites
1360     * @param project The project to delete
1361     * @return list of deleted sites (each list entry contains a data map with
1362     *         the id and the name of the delete site).
1363     */
1364    public List<Map<String, String>> deleteProject(Project project)
1365    {
1366        ModifiableAmetysObject parent = project.getParent();
1367        
1368        
1369        // list of map entry with id, name and title property
1370        // { id: site id, name: site name }
1371        List<Map<String, String>> deletedSitesInfo = new ArrayList<>();
1372        
1373        Site site = project.getSite();
1374        if (site != null)
1375        {
1376            try
1377            {
1378                Map<String, String> siteProps = new HashMap<>();
1379                siteProps.put("id", site.getId());
1380                siteProps.put("name", site.getName());
1381                
1382                _siteDao.deleteSite(site.getId());
1383                deletedSitesInfo.add(siteProps);
1384            }
1385            catch (RepositoryException e)
1386            {
1387                String errorMsg = String.format("Error while trying to delete the site '%s' for the project '%s'.", site.getName(), project.getName());
1388                getLogger().error(errorMsg, e);
1389            }
1390        }
1391        
1392        String projectId = project.getId();
1393        Collection<ProjectMember> projectMembers = _projectMembers.getProjectMembers(project, true);
1394        project.remove();
1395        parent.saveChanges();
1396        
1397        // Notify observers
1398        Map<String, Object> eventParams = new HashMap<>();
1399        eventParams.put(ObservationConstants.ARGS_PROJECT_ID, projectId);
1400        eventParams.put(ObservationConstants.ARGS_PROJECT_NAME, project.getName());
1401        eventParams.put(ObservationConstants.ARGS_PROJECT_MEMBERS, projectMembers);
1402        _observationManager.notify(new Event(ObservationConstants.EVENT_PROJECT_DELETED, _currentUserProvider.getUser(), eventParams));
1403        
1404        clearCaches();
1405        
1406        return deletedSitesInfo;
1407    }
1408    
1409    /**
1410     * Utility method to get or create an ametys object
1411     * @param <A> A sub class of AmetysObject
1412     * @param parent The parent object
1413     * @param name The ametys object name
1414     * @param type The ametys object type
1415     * @return ametys object
1416     * @throws AmetysRepositoryException if an repository error occurs
1417     */
1418    private <A extends AmetysObject> A _getOrCreateObject(ModifiableTraversableAmetysObject parent, String name, String type) throws AmetysRepositoryException
1419    {
1420        A object;
1421        
1422        if (parent.hasChild(name))
1423        {
1424            object = parent.getChild(name);
1425        }
1426        else
1427        {
1428            object = parent.createChild(name, type);
1429            parent.saveChanges();
1430        }
1431        
1432        return object;
1433    }
1434    
1435    /**
1436     * Get the project of an ametys object inside a project.
1437     * It can be an explorer node, or any type of resource in a module.
1438     * @param id The identifier of the ametys object
1439     * @return the project or null if not found
1440     */
1441    public Project getParentProject(String id)
1442    {
1443        return getParentProject(_resolver.<AmetysObject>resolveById(id));
1444    }
1445    
1446    /**
1447     * Get the project of an ametys object inside a project.
1448     * It can be an explorer node, or any type of resource in a module.
1449     * @param object The ametys object
1450     * @return the project or null if not found
1451     */
1452    public Project getParentProject(AmetysObject object)
1453    {
1454        AmetysObject ametysObject = object;
1455        // Go back to the local explorer root.
1456        do
1457        {
1458            ametysObject = ametysObject.getParent();
1459        }
1460        while (ametysObject instanceof ExplorerNode);
1461        
1462        if (!(ametysObject instanceof Project))
1463        {
1464            getLogger().warn(String.format("No project found for ametys object with id '%s'", ametysObject.getId()));
1465            return null;
1466        }
1467        
1468        return (Project) ametysObject;
1469    }
1470    
1471    /**
1472     * Get the list of project names for a given site
1473     * @param siteName The site name
1474     * @return the list of project names
1475     */
1476    @Callable(rights = "Runtime_Rights_Admin_Access", context = "/admin")
1477    public List<String> getProjectsForSite(String siteName)
1478    {
1479        Cache<String, List<Pair<String, String>>> cache = _getMemorySiteAssociationCache();
1480        if (cache.hasKey(siteName))
1481        {
1482            return cache.get(siteName).stream()
1483                    .map(p -> p.getRight())
1484                    .collect(Collectors.toList());
1485        }
1486        else
1487        {
1488            List<String> projectNames = new ArrayList<>();
1489            
1490            if (_siteManager.hasSite(siteName))
1491            {
1492                Site site = _siteManager.getSite(siteName);
1493                getProjectsForSite(site)
1494                    .stream()
1495                    .map(Project::getName)
1496                    .forEach(projectNames::add);
1497            }
1498            
1499            return projectNames;
1500        }
1501    }
1502    
1503    /**
1504     * Get the list of project for a given site
1505     * @param site The site
1506     * @return the list of project
1507     */
1508    public List<Project> getProjectsForSite(Site site)
1509    {
1510        Cache<String, List<Pair<String, String>>> cache = _getMemorySiteAssociationCache();
1511        if (cache.hasKey(site.getName()))
1512        {
1513            return cache.get(site.getName()).stream()
1514                        .map(p -> _resolver.<Project>resolveById(p.getLeft()))
1515                        .collect(Collectors.toList());
1516        }
1517        
1518        StringExpression siteExpression = new StringExpression(SiteAwareAmetysObject.METADATA_SITE, Operator.EQ, site.getName());
1519        String query = QueryHelper.getXPathQuery(null, Project.NODE_TYPE, siteExpression);
1520        try (AmetysObjectIterable<Project> projects = _resolver.query(query))
1521        {
1522            List<Pair<String, String>> projectsPairs = new ArrayList<>();
1523            List<Project> result = new ArrayList<>();
1524            for (Project project : projects)
1525            {
1526                projectsPairs.add(Pair.of(project.getId(), project.getName()));
1527                result.add(project);
1528            }
1529            
1530            cache.put(site.getName(), projectsPairs);
1531            return result;
1532        }
1533        catch (AmetysRepositoryException e)
1534        {
1535            getLogger().error(String.format("Unable to find projects for site '%s'", site.getName()), e);
1536        }
1537        
1538        return new ArrayList<>();
1539    }
1540    
1541    /**
1542     * Create the project workspace for a given project.
1543     * @param project The project for which the workspace must be created
1544     * @param errors A list of possible errors to populate. Can be null if the caller is not interested in error tracking.
1545     * @return The site created for this workspace
1546     */
1547    protected Site _createProjectWorkspace(Project project, List<String> errors)
1548    {
1549        String initialSiteName = project.getName();
1550        Site site = null;
1551        
1552        Site catalogSite = _siteManager.getSite(getCatalogSiteName());
1553        String rootId = catalogSite != null ? catalogSite.getId() : null;
1554        
1555        Map<String, Object> result = _siteDao.createSite(rootId, initialSiteName, ProjectWorkspaceSiteType.TYPE_ID, true);
1556        
1557        String siteId = (String) result.get("id");
1558        String siteName = (String) result.get("name");
1559        if (StringUtils.isNotEmpty(siteId))
1560        {
1561            // Creation success
1562            site = _siteManager.getSite(siteName);
1563            
1564            setProjectSiteTitle(site, project.getTitle());
1565          
1566            // Add site to project
1567            project.setSite(site);
1568            
1569            site.saveChanges();
1570        }
1571        
1572        return site;
1573    }
1574
1575    /**
1576     * Get the project's tags
1577     * @return The project's tags
1578     */
1579    public List<String> getTags()
1580    {
1581        AmetysObject projectsRootNode = getProjectsRoot();
1582        if (projectsRootNode instanceof JCRAmetysObject)
1583        {
1584            Node node = ((JCRAmetysObject) projectsRootNode).getNode();
1585            
1586            try
1587            {
1588                return Arrays.stream(node.getProperty(__PROJECTS_TAGS_PROPERTY).getValues())
1589                    .map(LambdaUtils.wrap(Value::getString))
1590                    .collect(Collectors.toList());
1591            }
1592            catch (PathNotFoundException e)
1593            {
1594                // property is not set, empty list will be returned.
1595            }
1596            catch (RepositoryException e)
1597            {
1598                throw new AmetysRepositoryException(e);
1599            }
1600        }
1601        
1602        return new ArrayList<>();
1603    }
1604
1605    /**
1606     * Add project's tags
1607     * @param newTags The new tags to add
1608     */
1609    public synchronized void addTags(Collection<String> newTags)
1610    {
1611        if (CollectionUtils.isNotEmpty(newTags))
1612        {
1613            AmetysObject projectsRootNode = getProjectsRoot();
1614            if (projectsRootNode instanceof JCRAmetysObject)
1615            {
1616                // Concat existing tags with new lowercased tags
1617                String[] tags = Stream.concat(getTags().stream(), newTags.stream().map(String::trim).map(String::toLowerCase).filter(StringUtils::isNotEmpty))
1618                        .distinct()
1619                        .toArray(String[]::new);
1620                
1621                try
1622                {
1623                    ((JCRAmetysObject) projectsRootNode).getNode().setProperty(__PROJECTS_TAGS_PROPERTY, tags);
1624                }
1625                catch (RepositoryException e)
1626                {
1627                    throw new AmetysRepositoryException(e);
1628                }
1629            }
1630        }
1631    }
1632    
1633    /**
1634     * Get the list of activated modules for a project
1635     * @param project The project
1636     * @return The list of activated modules
1637     */
1638    public List<WorkspaceModule> getModules(Project project)
1639    {
1640        return _moduleManagerEP.getModules().stream()
1641                .filter(module -> isModuleActivated(project, module.getId()))
1642                .collect(Collectors.toList());
1643    }
1644    
1645    /**
1646     * Retrieves the page of the module for all available languages
1647     * @param project The project
1648     * @param moduleId The project module id
1649     * @return the page or null if not found
1650     */
1651    public Set<Page> getModulePages(Project project, String moduleId)
1652    {
1653        if (_moduleManagerEP.hasExtension(moduleId))
1654        {
1655            WorkspaceModule module = _moduleManagerEP.getExtension(moduleId);
1656            return getModulePages(project, module);
1657        }
1658        return null;
1659    }
1660    
1661    /**
1662     * Return the possible module roots associated to a page
1663     * @param page The given page
1664     * @return A non null set of the data of the linked modules
1665     */
1666    public Set<ModifiableResourceCollection> pageToModuleRoot(Page page)
1667    {
1668        Set<ModifiableResourceCollection> data = new LinkedHashSet<>();
1669        
1670        Page rootPage = page;
1671        SitemapElement parent = page.getParent();
1672        while (!(parent instanceof Sitemap) && !page.hasValue(__PAGE_MODULES_VALUE))
1673        {
1674            rootPage = (Page) parent;
1675            parent = parent.getParent();
1676        }
1677        
1678        String[] modulesRootsIds = rootPage.getValueOrDefault(__PAGE_MODULES_VALUE, new String[0]);
1679        if (modulesRootsIds.length > 0)
1680        {
1681            for (String moduleRootId : modulesRootsIds)
1682            {
1683                try
1684                {
1685                    ModifiableResourceCollection moduleRoot = _resolver.resolveById(moduleRootId);
1686                    data.add(moduleRoot);
1687                }
1688                catch (UnknownAmetysObjectException e)
1689                {
1690                    // Ignore obsolete data
1691                }
1692            }
1693        }
1694        
1695        return data;
1696    }
1697    
1698    /**
1699     * Mark the given page as this module page. The modified page will not be saved.
1700     * @param page The page to change
1701     * @param moduleRoot The workspace module that use this page
1702     */
1703    public void tagProjectPage(ModifiablePage page, ModifiableResourceCollection moduleRoot)
1704    {
1705        String[] currentModules = page.getValueOrDefault(__PAGE_MODULES_VALUE, new String[0]);
1706        
1707        Set<String> modules = new LinkedHashSet<>(Arrays.asList(currentModules));
1708        modules.add(moduleRoot.getId());
1709        
1710        String[] newModules = new String[modules.size()];
1711        modules.toArray(newModules);
1712        
1713        page.setValue(__PAGE_MODULES_VALUE, newModules);
1714    }
1715
1716    /**
1717     * Remove the mark on the given page of this module. The modified page will not be saved.
1718     * @param page The page to change
1719     * @param moduleRoot The workspace module that use this page
1720     */
1721    public void untagProjectPage(ModifiablePage page, ModifiableResourceCollection moduleRoot)
1722    {
1723        if (moduleRoot != null)
1724        {
1725            String[] currentModules = page.getValueOrDefault(__PAGE_MODULES_VALUE, new String[0]);
1726            
1727            Set<String> modules = new LinkedHashSet<>(Arrays.asList(currentModules));
1728            modules.remove(moduleRoot.getId());
1729            
1730            String[] newModules = new String[modules.size()];
1731            modules.toArray(newModules);
1732            
1733            page.setValue(__PAGE_MODULES_VALUE, newModules);
1734        }
1735    }
1736
1737    /**
1738     * Get a page in the site of a given project with a specific tag
1739     * @param project The project
1740     * @param workspaceModule the module
1741     * @return The module's pages
1742     */
1743    public Set<Page> getModulePages(Project project, WorkspaceModule workspaceModule)
1744    {
1745        Request request = _getRequest();
1746        if (request == null)
1747        {
1748            // There is no request to store cache
1749            return _computePages(project, workspaceModule);
1750        }
1751        
1752        Cache<RequestModuleCacheKey, Set<Page>> pagesCache = _getRequestPageCache();
1753        
1754        // The site key in the cache is of the form {site + workspace}.
1755        String currentWorkspace = _workspaceSelector.getWorkspace();
1756        RequestModuleCacheKey pagesKey = RequestModuleCacheKey.of(project.getName(), workspaceModule.getId(), currentWorkspace);
1757        
1758        try
1759        {
1760            return pagesCache.get(pagesKey, __ -> _computePages(project, workspaceModule));
1761        }
1762        catch (CacheException e)
1763        {
1764            if (e.getCause() instanceof UnknownAmetysObjectException)
1765            {
1766                throw (UnknownAmetysObjectException) e.getCause();
1767            }
1768            else
1769            {
1770                throw new RuntimeException("An error occurred while computing page of module " + workspaceModule.getModuleName() + " in project " + project.getName(), e);
1771            }
1772        }
1773    }
1774    
1775    private Set<Page> _computePages(Project project, WorkspaceModule workspaceModule)
1776    {
1777        Set<String> pagesUUids = _getMemoryPageCache().get(ModuleCacheKey.of(project.getName(), workspaceModule.getId()), __ -> _computePagesIds(project, workspaceModule));
1778        if (pagesUUids != null)
1779        {
1780            return pagesUUids.stream().map(uuid -> _resolver.<Page>resolveById(uuid)).collect(Collectors.toSet());
1781        }
1782        else
1783        {
1784            // Project may be present in cache for 'default' workspace but does not exist in current JCR workspace
1785            throw new UnknownAmetysObjectException("There is no pages for '" + project.getName() + "', module '" + workspaceModule.getModuleName() + "'");
1786        }
1787    }
1788    
1789    private Set<String> _computePagesIds(Project project, WorkspaceModule workspaceModule)
1790    {
1791        Site site = project.getSite();
1792        String siteName = site != null ? site.getName() : null;
1793        if (StringUtils.isEmpty(siteName))
1794        {
1795            return null;
1796        }
1797        
1798        ModifiableResourceCollection moduleRoot = workspaceModule.getModuleRoot(project, false);
1799        if (moduleRoot != null)
1800        {
1801            Expression expression = new StringExpression(__PAGE_MODULES_VALUE, Operator.EQ, moduleRoot.getId());
1802            String query = PageQueryHelper.getPageXPathQuery(siteName, null, null, expression, null);
1803    
1804            return StreamSupport.stream(_resolver.query(query).spliterator(), false)
1805                        .map(page -> page.getId())
1806                        .collect(Collectors.toSet());
1807        }
1808        else
1809        {
1810            return Set.of();
1811        }
1812    }
1813
1814    /**
1815     * Activate the list of module of the project
1816     * @param project The project
1817     * @param moduleIds The list of modules. Can be null to activate all modules
1818     * @param additionalValues A list of optional additional values. Accepted values are : description, mailingList, inscriptionStatus, defaultProfile, tags, categoryTags, keywords and language
1819     */
1820    public void activateModules(Project project, Set<String> moduleIds, Map<String, Object> additionalValues)
1821    {
1822        Set<String> modules = moduleIds == null ? _moduleManagerEP.getExtensionsIds() : moduleIds;
1823        
1824        for (String moduleId : modules)
1825        {
1826            WorkspaceModule module = _moduleManagerEP.getModule(moduleId);
1827            if (module != null && !isModuleActivated(project, moduleId))
1828            {
1829                module.activateModule(project, additionalValues);
1830                project.addModule(moduleId);
1831            }
1832        }
1833        
1834        _setDefaultProfileForMembers(project, modules);
1835        
1836        project.saveChanges();
1837    }
1838
1839    private void _setDefaultProfileForMembers(Project project, Set<String> modules)
1840    {
1841        String profileForNewModule = StringUtils.defaultString(Config.getInstance().getValue("workspaces.profile.new.module"));
1842        
1843        if (profileForNewModule.equals(ProfileForNewModule.DEFAULT_MEMBER_PROFILE.name()))
1844        {
1845            Set<String> defaultProfiles = Set.of(StringUtils.defaultString(Config.getInstance().getValue("workspaces.profile.default")));
1846            Map<JCRProjectMember, Object> projectMembers = _projectMembers.getJCRProjectMembers(project);
1847            
1848            Set<WorkspaceModule> modulesForMembers = getProjectModulesForNewMembers(project);
1849            for (String moduleId : modules)
1850            {
1851                WorkspaceModule module = _moduleManagerEP.getModule(moduleId);
1852                Set<String> profiles = modulesForMembers.contains(module) ? defaultProfiles : Set.of();
1853                for (JCRProjectMember member : projectMembers.keySet())
1854                {
1855                    _projectMembers.setProfileOnModule(member, project, module, profiles);
1856                }
1857            }
1858        }
1859    }
1860    
1861    /**
1862     * Initialize the sitemap with the active module of the project
1863     * @param project The project
1864     * @param sitemap The sitemap
1865     */
1866    public void initializeModulesSitemap(Project project, Sitemap sitemap)
1867    {
1868        Set<String> modules = _moduleManagerEP.getExtensionsIds();
1869        
1870        for (String moduleId : modules)
1871        {
1872            if (_moduleManagerEP.hasExtension(moduleId))
1873            {
1874                WorkspaceModule module = _moduleManagerEP.getExtension(moduleId);
1875                
1876                if (isModuleActivated(project, moduleId))
1877                {
1878                    module.initializeSitemap(project, sitemap);
1879                }
1880            }
1881        }
1882    }
1883    
1884    /**
1885     * Determines if a module is activated
1886     * @param project The project
1887     * @param moduleId The id of module
1888     * @return true if the module the currently activated
1889     */
1890    public boolean isModuleActivated(Project project, String moduleId)
1891    {
1892        return ArrayUtils.contains(project.getModules(), moduleId);
1893    }
1894    
1895    /**
1896     * Remove the explorer root node of the project module, remove all events
1897     * related to that module and set it to deactivated
1898     * @param project The project
1899     * @param moduleIds The id of module to activate
1900     */
1901    public void deactivateModules(Project project, Set<String> moduleIds)
1902    {
1903        for (String moduleId : moduleIds)
1904        {
1905            WorkspaceModule module = _moduleManagerEP.getModule(moduleId);
1906            if (module != null && isModuleActivated(project, moduleId))
1907            {
1908                module.deactivateModule(project);
1909                project.removeModule(moduleId);
1910            }
1911        }
1912        
1913        project.saveChanges();
1914    }
1915    
1916    
1917    /**
1918     * Get the list of profiles configured for the workspaces' projects
1919     * @return The list of profiles as JSON
1920     */
1921    @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")
1922    public Map<String, Object> getProjectProfiles()
1923    {
1924        Map<String, Object> result = new HashMap<>();
1925        List<Map<String, Object>> profiles = _projectRightHelper.getProfiles().stream().map(p -> p.toJSON()).collect(Collectors.toList());
1926        result.put("profiles", profiles);
1927        return result;
1928    }
1929    
1930    /**
1931     * Get the site name holding the catalog of projects
1932     * @return the catalog's site name
1933     * @throws UnknownCatalogSiteException when the config is invalid
1934     */
1935    public String getCatalogSiteName() throws UnknownCatalogSiteException
1936    {
1937        String catalogSiteName = Config.getInstance().getValue("workspaces.catalog.site.name");
1938        if (!_siteManager.hasSite(catalogSiteName))
1939        {
1940            throw new UnknownCatalogSiteException("Unknown site '" + catalogSiteName + "'. The global Ametys configuration is invalid for the parameter 'workspaces.catalog.site.name'");
1941        }
1942        return catalogSiteName;
1943    }
1944    
1945    /**
1946     * Get the site name holding the users directory
1947     * @return the users directory's site name
1948     * @throws UnknownUserDirectorySiteException when the config is invalid
1949     */
1950    public String getUsersDirectorySiteName() throws UnknownUserDirectorySiteException
1951    {
1952        String udSiteName = Config.getInstance().getValue("workspaces.member.userdirectory.site.name");
1953        if (!_siteManager.hasSite(udSiteName))
1954        {
1955            throw new UnknownUserDirectorySiteException("Unknown site '" + udSiteName + "'. The global Ametys configuration is invalid for the parameter 'workspaces.member.userdirectory.site.name'");
1956        }
1957        return udSiteName;
1958    }
1959    
1960    @Override
1961    public boolean supports(Event event)
1962    {
1963        return event.getId().equals(ObservationConstants.EVENT_PROJECT_DELETED)
1964                || event.getId().equals(ObservationConstants.EVENT_PROJECT_UPDATED)
1965                || event.getId().equals(ObservationConstants.EVENT_PROJECT_ADDED)
1966                || event.getId().equals(org.ametys.web.ObservationConstants.EVENT_PAGE_ADDED)
1967                || event.getId().equals(org.ametys.web.ObservationConstants.EVENT_PAGE_DELETED);
1968    }
1969
1970    public int getPriority()
1971    {
1972        return 0;
1973    }
1974
1975    public void observe(Event event, Map<String, Object> transientVars) throws Exception
1976    {
1977        clearCaches();
1978    }
1979
1980    /**
1981     * Prefix project title
1982     * @param site the site
1983     * @param title the title
1984     */
1985    public void setProjectSiteTitle(Site site, String title)
1986    {
1987        I18nizableText i18nSiteTitle = new I18nizableText("plugin." + _pluginName, "PLUGINS_WORKSPACES_PROJECT_DEFAULT_PROJECT_WORKSPACE_TITLE", Arrays.asList(title));
1988        site.setTitle(_i18nUtils.translate(i18nSiteTitle));
1989    }
1990    
1991    private Project _computeProject(String projectName)
1992    {
1993        if (hasProject(projectName))
1994        {
1995            String uuid = _getUUIDCache().get(projectName);
1996            return _resolver.<Project>resolveById(uuid);
1997        }
1998        else
1999        {
2000            // Project may be present in cache for 'default' workspace but does not exist in current JCR workspace
2001            throw new UnknownAmetysObjectException("There is no site named '" + projectName + "'");
2002        }
2003    }
2004    
2005    /**
2006     * Check rights to create project
2007     * @param inscriptionStatus the inscription status
2008     * @param zoneItem the zoneItem containing catalog service. Must be a catalog service if not null
2009     */
2010    public void checkRightsForProjectCreation(InscriptionStatus inscriptionStatus, ZoneItem zoneItem)
2011    {
2012        SitemapElement catalogPage = zoneItem != null ? zoneItem.getZone().getSitemapElement() : null;
2013        
2014        if (catalogPage != null && !_projectRightHelper.hasCatalogReadAccess(zoneItem))
2015        {
2016            throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to create project from page '" + catalogPage.getId() + "' without sufficient rights");
2017        }
2018        
2019        switch (inscriptionStatus)
2020        {
2021            case PRIVATE:
2022                boolean hasRightToCreatePrivateProjetOnPages = catalogPage != null ? _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PRIVATE, catalogPage) == RightResult.RIGHT_ALLOW : false;
2023                if (!hasRightToCreatePrivateProjetOnPages && _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PRIVATE, "/${WorkspaceName}") != RightResult.RIGHT_ALLOW)
2024                {
2025                    throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to create private project without sufficient rights");
2026                }
2027                break;
2028            case MODERATED:
2029                boolean hasRightToCreateModeratedProjetOnPages = catalogPage != null ? _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_MODERATED, catalogPage) == RightResult.RIGHT_ALLOW : false;
2030                if (!hasRightToCreateModeratedProjetOnPages && _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_MODERATED, "/${WorkspaceName}") != RightResult.RIGHT_ALLOW)
2031                {
2032                    throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to create public project with moderation without sufficient rights");
2033                }
2034                break;
2035            case OPEN:
2036                boolean hasRightToCreateOpenProjetOnPages = catalogPage != null ? _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_OPENED, catalogPage) == RightResult.RIGHT_ALLOW : false;
2037                if (!hasRightToCreateOpenProjetOnPages && _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_OPENED, "/${WorkspaceName}") != RightResult.RIGHT_ALLOW)
2038                {
2039                    throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to create public project without sufficient rights");
2040                }
2041                break;
2042            default:
2043                throw new IllegalArgumentException("Inscription status '" + inscriptionStatus.toString() + "' is unknown");
2044        }
2045    }
2046    
2047    /**
2048     * Check rights to edit project
2049     * @param project the project
2050     * @param inscriptionStatus the inscription status
2051     * @param zoneItem the zoneItem containing catalog service. Must be a catalog service if not null
2052     */
2053    public void checkRightsForProjectEdition(Project project, InscriptionStatus inscriptionStatus, ZoneItem zoneItem)
2054    {
2055        InscriptionStatus oldInscriptionStatus = project.getInscriptionStatus();
2056        SitemapElement catalogPage = zoneItem != null ? zoneItem.getZone().getSitemapElement() : null;
2057        
2058        if (catalogPage != null && !_projectRightHelper.hasCatalogReadAccess(zoneItem))
2059        {
2060            throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to edit project from page '" + catalogPage.getId() + "' without sufficient rights");
2061        }
2062        
2063        if (oldInscriptionStatus != inscriptionStatus)
2064        {
2065            boolean canCreatePrivateProjet = _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PRIVATE, "/${WorkspaceName}") == RightResult.RIGHT_ALLOW
2066                    || (catalogPage != null ? _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PRIVATE, catalogPage) == RightResult.RIGHT_ALLOW : false);
2067            boolean canCreatePublicProjetWithModeration = _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_MODERATED, "/${WorkspaceName}") == RightResult.RIGHT_ALLOW
2068                    || (catalogPage != null ? _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_MODERATED, catalogPage) == RightResult.RIGHT_ALLOW : false);
2069            boolean canCreatePublicProjet = _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_OPENED, "/${WorkspaceName}") == RightResult.RIGHT_ALLOW
2070                    || (catalogPage != null ? _rightManager.currentUserHasRight(ProjectConstants.RIGHT_PROJECT_CREATE_PUBLIC_OPENED, catalogPage) == RightResult.RIGHT_ALLOW : false);
2071            
2072            switch (oldInscriptionStatus)
2073            {
2074                case PRIVATE:
2075                    if (!canCreatePrivateProjet)
2076                    {
2077                        throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to edit private project without sufficient rights");
2078                    }
2079                    break;
2080                case MODERATED:
2081                    if (!canCreatePublicProjetWithModeration)
2082                    {
2083                        throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to edit public project with moderation without sufficient rights");
2084                    }
2085                    break;
2086                case OPEN:
2087                    if (!canCreatePublicProjet)
2088                    {
2089                        throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to edit public project without sufficient rights");
2090                    }
2091                    break;
2092                default:
2093                    throw new IllegalArgumentException("Inscription status '" + oldInscriptionStatus.toString() + "' is unknown");
2094            }
2095            
2096            switch (inscriptionStatus)
2097            {
2098                case PRIVATE:
2099                    if (!canCreatePrivateProjet)
2100                    {
2101                        throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to edit project to private project without sufficient rights");
2102                    }
2103                    break;
2104                case MODERATED:
2105                    if (!canCreatePublicProjetWithModeration)
2106                    {
2107                        throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to edit project to public project with moderation without sufficient rights");
2108                    }
2109                    break;
2110                case OPEN:
2111                    if (!canCreatePublicProjet)
2112                    {
2113                        throw new AccessDeniedException("User " + _currentUserProvider.getUser() + " tried to edit project to public project without sufficient rights");
2114                    }
2115                    break;
2116                default:
2117                    throw new IllegalArgumentException("Inscription status '" + inscriptionStatus.toString() + "' is unknown");
2118            }
2119        }
2120    }
2121    
2122    /**
2123     * Clear the site cache
2124     */
2125    public void clearCaches ()
2126    {
2127        _getMemorySiteAssociationCache().invalidateAll();
2128        _getMemoryProjectCache().invalidateAll();
2129        _getMemoryPageCache().invalidateAll();
2130        _getRequestProjectCache().invalidateAll();
2131        _getRequestPageCache().invalidateAll();
2132    }
2133    
2134    private Cache<String, List<Pair<String, String>>> _getMemorySiteAssociationCache()
2135    {
2136        return _cacheManager.get(MEMORY_SITEASSOCIATION_CACHE);
2137    }
2138    
2139    private Cache<String, String> _getMemoryProjectCache()
2140    {
2141        return _cacheManager.get(MEMORY_PROJECTIDBYNAMECACHE);
2142    }
2143    
2144    private Cache<ModuleCacheKey, Set<String>> _getMemoryPageCache()
2145    {
2146        return _cacheManager.get(MEMORY_PAGESBYIDCACHE);
2147    }
2148    
2149    private Cache<RequestProjectCacheKey, Project> _getRequestProjectCache()
2150    {
2151        return _cacheManager.get(REQUEST_PROJECTBYID_CACHE);
2152    }
2153    
2154    private Cache<RequestModuleCacheKey, Set<Page>> _getRequestPageCache()
2155    {
2156        return _cacheManager.get(REQUEST_PAGESBYPROJECTANDMODULE_CACHE);
2157    }
2158
2159    
2160    /**
2161     * Creates the caches
2162     */
2163    protected void _createCaches()
2164    {
2165        _cacheManager.createMemoryCache(MEMORY_SITEASSOCIATION_CACHE,
2166                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_CACHE_PROJECT_MANAGER_LABEL"),
2167                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_CACHE_PROJECT_MANAGER_DESCRIPTION"),
2168                true,
2169                null);
2170        _cacheManager.createMemoryCache(MEMORY_PROJECTIDBYNAMECACHE,
2171                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_MANAGER_UUID_CACHE_LABEL"),
2172                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_MANAGER_UUID_CACHE_DESCRIPTION"),
2173                true,
2174                null);
2175        _cacheManager.createMemoryCache(MEMORY_PAGESBYIDCACHE,
2176                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_MANAGER_PAGEUUID_CACHE_LABEL"),
2177                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_MANAGER_PAGEUUID_CACHE_DESCRIPTION"),
2178                true,
2179                null);
2180        _cacheManager.createRequestCache(REQUEST_PROJECTBYID_CACHE,
2181                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_MANAGER_REQUEST_CACHE_LABEL"),
2182                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_MANAGER_REQUEST_CACHE_DESCRIPTION"),
2183                false);
2184        _cacheManager.createRequestCache(REQUEST_PAGESBYPROJECTANDMODULE_CACHE,
2185                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_MANAGER_PAGEREQUEST_CACHE_LABEL"),
2186                new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_MANAGER_PAGEREQUEST_CACHE_DESCRIPTION"),
2187                false);
2188    }
2189    
2190    private synchronized Map<String, String> _getUUIDCache()
2191    {
2192        if (!_getMemoryProjectCache().hasKey(__IS_CACHE_FILLED))
2193        {
2194            Session defaultSession = null;
2195            try
2196            {
2197                // Force default workspace to execute query
2198                defaultSession = _repository.login(RepositoryConstants.DEFAULT_WORKSPACE);
2199                
2200                String jcrQuery = "//element(*, ametys:project)";
2201                
2202                AmetysObjectIterable<Project> projects = _resolver.query(jcrQuery, defaultSession);
2203                
2204                for (Project project : projects)
2205                {
2206                    _getMemoryProjectCache().put(project.getName(), project.getId());
2207                }
2208                
2209                _getMemoryProjectCache().put(__IS_CACHE_FILLED, null);
2210            }
2211            catch (RepositoryException e)
2212            {
2213                throw new AmetysRepositoryException(e);
2214            }
2215            finally
2216            {
2217                if (defaultSession != null)
2218                {
2219                    defaultSession.logout();
2220                }
2221            }
2222        }
2223        
2224        Map<String, String> cacheAsMap = _getMemoryProjectCache().asMap();
2225        cacheAsMap.remove(__IS_CACHE_FILLED);
2226        return cacheAsMap;
2227    }
2228    
2229    private static final class RequestProjectCacheKey extends AbstractCacheKey
2230    {
2231        private RequestProjectCacheKey(String projectName, String workspaceName)
2232        {
2233            super(projectName, workspaceName);
2234        }
2235        
2236        static RequestProjectCacheKey of(String projectName, String workspaceName)
2237        {
2238            return new RequestProjectCacheKey(projectName, workspaceName);
2239        }
2240    }
2241    
2242    private static final class ModuleCacheKey extends AbstractCacheKey
2243    {
2244        private ModuleCacheKey(String projectName, String moduleId)
2245        {
2246            super(projectName, moduleId);
2247        }
2248        
2249        static ModuleCacheKey of(String projectName, String moduleId)
2250        {
2251            return new ModuleCacheKey(projectName, moduleId);
2252        }
2253    }
2254    
2255    private static final class RequestModuleCacheKey extends AbstractCacheKey
2256    {
2257        private RequestModuleCacheKey(String projectName, String moduleId, String workspaceName)
2258        {
2259            super(projectName, moduleId, workspaceName);
2260        }
2261        
2262        static RequestModuleCacheKey of(String projectName, String moduleId, String workspaceName)
2263        {
2264            return new RequestModuleCacheKey(projectName, moduleId, workspaceName);
2265        }
2266    }
2267    
2268    private Request _getRequest ()
2269    {
2270        try
2271        {
2272            return (Request) _context.get(ContextHelper.CONTEXT_REQUEST_OBJECT);
2273        }
2274        catch (ContextException ce)
2275        {
2276            getLogger().info("Unable to get the request", ce);
2277            return null;
2278        }
2279    }
2280
2281    /**
2282     * Retrieves all projects for client side
2283     * @return the projects
2284     */
2285    @Callable(rights = "Runtime_Rights_Admin_Access", context = "/admin")
2286    public List<Map<String, Object>> getProjectsStatisticsForClientSide()
2287    {
2288        return getProjects()
2289                .stream()
2290                .map(p -> getProjectStatistics(p))
2291                .collect(Collectors.toList());
2292    }
2293    
2294    /**
2295     * Retrieves the standard information of a project
2296     * @param project The project
2297     * @return The map of information
2298     */
2299    public Map<String, Object> getProjectStatistics(Project project)
2300    {
2301        Map<String, Object> statistics = new HashMap<>();
2302
2303        statistics.put("title", project.getTitle());
2304
2305        long totalSize = 0;
2306        for (WorkspaceModule moduleManager : _moduleManagerEP.getModules())
2307        {
2308            Map<String, Object> moduleStatistics = moduleManager.getStatistics(project);
2309            statistics.putAll(moduleStatistics);
2310            Long size = (Long) moduleStatistics.get(moduleManager.getModuleSizeKey());
2311            totalSize += (size != null && size >= 0) ? (Long) moduleStatistics.get(moduleManager.getModuleSizeKey()) : 0;
2312        }
2313
2314        statistics.put("totalSize", totalSize);
2315
2316        ZonedDateTime creationDate = project.getCreationDate();
2317        
2318        statistics.put("creationDate", creationDate);
2319        statistics.put("managers", Arrays.stream(project.getManagers())
2320                .map(u -> _userHelper.user2json(u))
2321                .collect(Collectors.toList()));
2322
2323        return statistics;
2324    }
2325
2326    /**
2327     * Retrieves all projects for client side
2328     * @return the projects
2329     */
2330    @Callable(rights = "Runtime_Rights_Admin_Access", context = "/admin")
2331    public List<Map<String, Object>> getProjectsStatisticsColumnsModel()
2332    {
2333        return getStatisticHeaders()
2334                .stream()
2335                .map(p -> p.convertToJSON())
2336                .collect(Collectors.toList());
2337    }
2338
2339    private List<StatisticColumn> getStatisticHeaders()
2340    {
2341
2342        List<StatisticColumn> flatStatisticHeaders = getFlatStatisticHeaders();
2343        List<StatisticColumn> headers = new ArrayList<>();
2344        for (StatisticColumn statisticColumn : flatStatisticHeaders)
2345        {
2346            // this column have a parent, we have to find it and attach it
2347            if (statisticColumn.getGroup() != null)
2348            {
2349                Optional<StatisticColumn> parent = flatStatisticHeaders.stream()
2350                                                    .filter(column -> column.getId().equals(statisticColumn.getGroup()))
2351                                                    .findAny();
2352                if (parent.isPresent())
2353                {
2354                    parent.get().addSubColumn(statisticColumn);
2355                }
2356            }
2357            else
2358            {
2359                headers.add(statisticColumn);
2360            }
2361        }
2362        
2363        return headers;
2364    }
2365    
2366    private List<StatisticColumn> getFlatStatisticHeaders()
2367    {
2368        List<StatisticColumn> headers = new ArrayList<>();
2369        headers.add(new StatisticColumn("title", new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_STATISTICS_TOOL_COLUMN_TITLE"))
2370                .withType(StatisticsColumnType.STRING)
2371                .withWidth(200)
2372                .withRenderer("Ametys.plugins.workspaces.project.tool.ProjectsGridHelper.renderTitle"));
2373        headers.add(new StatisticColumn("creationDate", new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_STATISTICS_TOOL_COLUMN_CREATION"))
2374                .withType(StatisticsColumnType.DATE)
2375                .withWidth(150));
2376        headers.add(new StatisticColumn("managers", new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_STATISTICS_TOOL_COLUMN_MANAGERS"))
2377                .withRenderer("Ametys.grid.GridColumnHelper.renderUser")
2378                .withFilter(false));
2379        for (WorkspaceModule moduleManager : _moduleManagerEP.getModules())
2380        {
2381            headers.addAll(moduleManager.getStatisticModel());
2382        }
2383        
2384        StatisticColumn elements = new StatisticColumn(WorkspaceModule.GROUP_HEADER_ELEMENTS_ID, new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_STATISTICS_TOOL_COLUMN_ELEMENTS"))
2385                .withFilter(false);
2386        headers.add(elements);
2387
2388        StatisticColumn activatedModules = new StatisticColumn(WorkspaceModule.GROUP_HEADER_ACTIVATED_ID, new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_STATISTICS_TOOL_COLUMN_ACTIVE_MODULES"))
2389                .isHidden(true)
2390                .withFilter(false);
2391        headers.add(activatedModules);
2392        
2393        StatisticColumn lastActivity = new StatisticColumn(WorkspaceModule.GROUP_HEADER_LAST_ACTIVITY_ID, new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_STATISTICS_TOOL_COLUMN_LAST_ACTIVITY")).isHidden(true);
2394        headers.add(lastActivity);
2395
2396        StatisticColumn modulesSize = new StatisticColumn(WorkspaceModule.GROUP_HEADER_SIZE_ID, new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_STATISTICS_TOOL_COLUMN_MODULES_SIZE"))
2397                .withFilter(false);
2398        modulesSize.addSubColumn(new StatisticColumn("totalSize", new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_PROJECT_STATISTICS_TOOL_COLUMN_MODULES_SIZE_TOTAL"))
2399                .withRenderer("Ametys.plugins.workspaces.project.tool.ProjectsGridHelper.renderSize")
2400                .withType(StatisticsColumnType.LONG));
2401        
2402        headers.add(modulesSize);
2403        
2404        return headers;
2405    }
2406    
2407    /**
2408     * Check if the user is in one of the populations of project
2409     * @param project the project
2410     * @param user the user
2411     * @return true if the user is in one of the populations of project
2412     */
2413    public boolean isUserInProjectPopulations(Project project, UserIdentity user)
2414    {
2415        Site site = project.getSite();
2416
2417        if (site == null)
2418        {
2419            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");
2420        }
2421        String siteName = site.getName();
2422
2423        Set<String> populations = _populationContextHelper.getUserPopulationsOnContext("/sites/" + siteName, false);
2424        Set<String> frontPopulations = _populationContextHelper.getUserPopulationsOnContext("/sites-fo/" + siteName, false);
2425        
2426        return populations.contains(user.getPopulationId()) || frontPopulations.contains(user.getPopulationId());
2427    }
2428    
2429    /**
2430     * Thrown to indicate that the catalog site is unknown
2431     */
2432    public class UnknownCatalogSiteException extends IllegalArgumentException
2433    {
2434        /**
2435         * Construct a {@code UnknownCatalogSiteException} with the specified message
2436         * @param message the message
2437         */
2438        public UnknownCatalogSiteException(String message)
2439        {
2440            super(message);
2441        }
2442    }
2443    
2444    /**
2445     * Thrown to indicate that the user directory site is unknown
2446     */
2447    public class UnknownUserDirectorySiteException extends IllegalArgumentException
2448    {
2449        /**
2450         * Construct a {@code UnknownUserDirectorySiteException} with the specified message
2451         * @param message the message
2452         */
2453        public UnknownUserDirectorySiteException(String message)
2454        {
2455            super(message);
2456        }
2457    }
2458}