001/*
002 *  Copyright 2018 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.members;
017
018import java.io.IOException;
019import java.util.Collection;
020import java.util.Iterator;
021import java.util.List;
022import java.util.Locale;
023import java.util.Set;
024
025import org.apache.avalon.framework.service.ServiceException;
026import org.apache.avalon.framework.service.ServiceManager;
027import org.apache.cocoon.ProcessingException;
028import org.apache.cocoon.environment.ObjectModelHelper;
029import org.apache.cocoon.environment.Request;
030import org.apache.cocoon.generation.ServiceableGenerator;
031import org.apache.cocoon.xml.AttributesImpl;
032import org.apache.cocoon.xml.XMLUtils;
033import org.apache.commons.lang.StringUtils;
034import org.apache.commons.lang3.ArrayUtils;
035import org.xml.sax.SAXException;
036
037import org.ametys.cms.contenttype.ContentType;
038import org.ametys.cms.contenttype.ContentTypeExtensionPoint;
039import org.ametys.cms.repository.Content;
040import org.ametys.core.group.GroupManager;
041import org.ametys.core.right.RightManager;
042import org.ametys.core.user.User;
043import org.ametys.core.user.UserIdentity;
044import org.ametys.plugins.core.user.UserHelper;
045import org.ametys.plugins.repository.AmetysRepositoryException;
046import org.ametys.plugins.repository.data.holder.ModelAwareDataHolder;
047import org.ametys.plugins.userdirectory.UserDirectoryHelper;
048import org.ametys.plugins.userdirectory.UserDirectoryPageHandler;
049import org.ametys.plugins.workspaces.members.JCRProjectMember.MemberType;
050import org.ametys.plugins.workspaces.members.ProjectMemberManager.ProjectMember;
051import org.ametys.plugins.workspaces.project.ProjectManager;
052import org.ametys.plugins.workspaces.project.objects.Project;
053import org.ametys.runtime.config.Config;
054import org.ametys.runtime.model.View;
055import org.ametys.runtime.model.type.DataContext;
056import org.ametys.web.WebConstants;
057import org.ametys.web.repository.page.Page;
058import org.ametys.web.repository.page.ZoneItem;
059import org.ametys.web.usermanagement.UserSignUpConfiguration;
060
061/**
062 * Generator used sax project member
063 */
064public class ProjectMembersGenerator extends ServiceableGenerator
065{
066    /** The project manager component */
067    protected ProjectManager _projectManager;
068    
069    /** The project member manager */
070    protected ProjectMemberManager _projectMemberManager;
071    
072    /** The user helper */
073    protected UserHelper _userHelper;
074    
075    /** The user directory helper */
076    protected UserDirectoryHelper _userDirectoryHelper;
077    
078    /** The content type extension point */
079    protected ContentTypeExtensionPoint _cTypeEP;
080    
081    /** The group manager */
082    protected GroupManager _groupManager;
083
084    /** The sign up configuration */
085    protected UserSignUpConfiguration _signupConfig;
086
087    /** The right manager */
088    protected RightManager _rightManager;
089
090    @Override
091    public void service(ServiceManager serviceManager) throws ServiceException
092    {
093        _projectManager = (ProjectManager) serviceManager.lookup(ProjectManager.ROLE);
094        _projectMemberManager = (ProjectMemberManager) serviceManager.lookup(ProjectMemberManager.ROLE);
095        _userHelper = (UserHelper) serviceManager.lookup(UserHelper.ROLE);
096        _userDirectoryHelper = (UserDirectoryHelper) serviceManager.lookup(UserDirectoryHelper.ROLE);
097        _cTypeEP = (ContentTypeExtensionPoint) serviceManager.lookup(ContentTypeExtensionPoint.ROLE);
098        _groupManager = (GroupManager) serviceManager.lookup(GroupManager.ROLE);
099        _signupConfig = (UserSignUpConfiguration) serviceManager.lookup(UserSignUpConfiguration.ROLE);
100        _rightManager = (RightManager) serviceManager.lookup(RightManager.ROLE);
101    }
102
103    @Override
104    public void generate() throws IOException, SAXException, ProcessingException
105    {
106        Request request = ObjectModelHelper.getRequest(objectModel);
107        
108        Page page = (Page) request.getAttribute(WebConstants.REQUEST_ATTR_PAGE);
109        String lang = page.getSitemapName();
110        
111        ZoneItem zoneItem = (ZoneItem) request.getAttribute(WebConstants.REQUEST_ATTR_ZONEITEM);
112        ModelAwareDataHolder serviceParameters2018 = zoneItem.getServiceParameters();
113        
114        long maxNbMembers = serviceParameters2018.getValue("nbMembers", false, -1L);
115        boolean expandGroup = serviceParameters2018.getValue("expandGroup", false, false);
116        
117        contentHandler.startDocument();
118        
119        List<Project> projects = _projectManager.getProjectsForSite(page.getSite());
120        Project project = projects.isEmpty() ? null : projects.get(0);
121        
122        if (project == null)
123        {
124            throw new IllegalArgumentException("There is no project for site " + page.getSiteName());
125        }
126        
127        try
128        {
129            Collection<ProjectMember> members = _projectMemberManager.getProjectMembers(project, expandGroup, true);
130            
131            AttributesImpl attrs = new AttributesImpl();
132            attrs.addCDATAAttribute("nbMembers", String.valueOf(members.size()));
133            
134            String memberPageId = _getMembersPageId(project);
135            if (memberPageId != null)
136            {
137                attrs.addCDATAAttribute("memberPageId", memberPageId);
138            }
139            
140            String siteName = Config.getInstance().getValue("workspaces.member.userdirectory.site.name");
141            if (StringUtils.isNotEmpty(siteName))
142            {
143                attrs.addCDATAAttribute("userDirectorySiteName", siteName);
144            }
145            XMLUtils.startElement(contentHandler, "project", attrs);
146            
147            UserIdentity[] managers = project.getManagers();
148            
149            int count = 0;
150            Iterator<ProjectMember> it = members.iterator();
151            while (it.hasNext() && (maxNbMembers < 1 || count < maxNbMembers))
152            {
153                ProjectMember member = it.next();
154                _saxMember(member, managers, lang);
155                count++;
156            }
157            
158            XMLUtils.endElement(contentHandler, "project");
159        }
160        catch (AmetysRepositoryException e)
161        {
162            throw new ProcessingException("Unable to get project members", e);
163        }
164        
165        contentHandler.endDocument();
166    }
167    
168    /**
169     * Get the id of member page if exists and current user has access
170     * @param project The project
171     * @return the id of member page. Can be null.
172     */
173    protected String _getMembersPageId(Project project)
174    {
175        Set<Page> memberPages = _projectManager.getModulePages(project, MembersWorkspaceModule.MEMBERS_MODULE_ID);
176        
177        if (!memberPages.isEmpty())
178        {
179            Page memberPage = memberPages.iterator().next();
180            
181            if (_rightManager.currentUserHasReadAccess(memberPage))
182            {
183                return memberPage.getId();
184            }
185        }
186        
187        return null;
188    }
189    /**
190     * SAX a member
191     * @param member the member
192     * @param managers the user identities of project's manager
193     * @param lang the current language
194     * @throws SAXException if an error occurred while saxing
195     * @throws AmetysRepositoryException if an error occurred
196     * @throws IOException if failed to sax user content
197     */
198    protected void _saxMember (ProjectMember member, UserIdentity[] managers, String lang) throws SAXException, AmetysRepositoryException, IOException
199    {
200        AttributesImpl attrs = new AttributesImpl();
201        attrs.addCDATAAttribute("manager", String.valueOf(member.isManager()));
202        
203        if (member.isManager())
204        {
205            // Get the position of this manager
206            int position = ArrayUtils.indexOf(managers, member.getUser().getIdentity());
207            attrs.addCDATAAttribute("managerPosition", String.valueOf(position + 1));
208        }
209        
210        attrs.addCDATAAttribute("type", member.getType().name().toLowerCase());
211        
212        XMLUtils.startElement(contentHandler, "member", attrs);
213        
214        XMLUtils.createElement(contentHandler, "title", member.getTitle());
215        XMLUtils.createElement(contentHandler, "sortabletitle", member.getSortableTitle());
216        String role = member.getRole();
217        if (StringUtils.isNotBlank(role))
218        {
219            XMLUtils.createElement(contentHandler, "role", role);
220        }
221        
222        if (member.getType().equals(MemberType.USER))
223        {
224            User user = member.getUser();
225            _saxUser(user, lang);
226        }
227        
228        XMLUtils.endElement(contentHandler, "member");
229    }
230    
231    /**
232     * Sax user
233     * @param user the user 
234     * @param lang the lang
235     * @throws SAXException if an error occurs saxing data
236     * @throws AmetysRepositoryException if an repository error occurs
237     * @throws IOException if an IO exception error occurs
238     */
239    protected void _saxUser(User user, String lang) throws SAXException, AmetysRepositoryException, IOException
240    {
241        XMLUtils.startElement(contentHandler, "user");
242        _userHelper.saxUser(user, contentHandler, "info");
243        Content userContent = _userDirectoryHelper.getUserContent(user.getIdentity(), lang);
244        if (userContent != null)
245        {
246            AttributesImpl contentAttrs = new AttributesImpl();
247            contentAttrs.addCDATAAttribute("id", userContent.getId());
248            XMLUtils.startElement(contentHandler, "content", contentAttrs);
249            ContentType contentType = _cTypeEP.getExtension(UserDirectoryPageHandler.ABSTRACT_USER_CONTENT_TYPE);
250            View view = contentType.getView("abstract");
251            userContent.dataToSAX(contentHandler, view, DataContext.newInstance().withLocale(new Locale(lang)).withEmptyValues(false));
252            XMLUtils.endElement(contentHandler, "content");
253        }
254        XMLUtils.endElement(contentHandler, "user");
255        
256    }
257}