Source code

001/*
002 *  Copyright 2016 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.userdirectory.clientsideelement;
017
018import java.util.ArrayList;
019import java.util.Arrays;
020import java.util.HashMap;
021import java.util.List;
022import java.util.Map;
023import java.util.Set;
024import java.util.stream.Collectors;
025
026import javax.jcr.Node;
027import javax.jcr.RepositoryException;
028import javax.jcr.Value;
029
030import org.apache.avalon.framework.service.ServiceException;
031import org.apache.avalon.framework.service.ServiceManager;
032import org.apache.commons.lang3.StringUtils;
033import org.apache.jackrabbit.value.StringValue;
034
035import org.ametys.cms.contenttype.ContentType;
036import org.ametys.cms.contenttype.ContentTypeExtensionPoint;
037import org.ametys.core.observation.Event;
038import org.ametys.core.observation.ObservationManager;
039import org.ametys.core.ui.Callable;
040import org.ametys.core.util.LambdaUtils;
041import org.ametys.plugins.repository.AmetysObjectResolver;
042import org.ametys.plugins.repository.jcr.JCRAmetysObject;
043import org.ametys.plugins.userdirectory.UserDirectoryPageHandler;
044import org.ametys.plugins.userdirectory.observation.ObservationConstants;
045import org.ametys.plugins.userdirectory.page.VirtualUserDirectoryPageFactory;
046import org.ametys.runtime.i18n.I18nizableTextParameter;
047import org.ametys.runtime.i18n.I18nizableText;
048import org.ametys.web.clientsideelement.AbstractPageClientSideElement;
049import org.ametys.web.repository.page.ModifiablePage;
050import org.ametys.web.repository.page.Page;
051
052/**
053 * Client side element for a controller wich set/remove the root page of a user directory.
054 */
055public class SetUserDirectoryRootClientSideElement extends AbstractPageClientSideElement
056{
057    /** Observer manager. */
058    protected ObservationManager _observationManager;
059    /** The extension point for content types */
060    protected ContentTypeExtensionPoint _contentTypeEP;
061    /** The User Directory page handler */
062    protected UserDirectoryPageHandler _userDirectoryPageHandler;
063
064    @Override
065    public void service(ServiceManager smanager) throws ServiceException
066    {
067        super.service(smanager);
068        _observationManager = (ObservationManager) smanager.lookup(ObservationManager.ROLE);
069        _contentTypeEP = (ContentTypeExtensionPoint) smanager.lookup(ContentTypeExtensionPoint.ROLE);
070        _userDirectoryPageHandler = (UserDirectoryPageHandler) smanager.lookup(UserDirectoryPageHandler.ROLE);
071    }
072    
073    /**
074     * Gets the status of the given page
075     * @param pageId The page id
076     * @return the status of the given page
077     */
078    @Callable
079    public Map<String, Object> getStatus(String pageId)
080    {
081        Map<String, Object> result = new HashMap<>();
082        
083        Map<String, Object> parameters = this._script.getParameters();
084        
085        Page page = _resolver.resolveById(pageId);
086
087        if (page instanceof JCRAmetysObject)
088        {
089            if (_isUserDirectoryRootPage((JCRAmetysObject) page))
090            {
091                List<String> i18nParameters = new ArrayList<>();
092                i18nParameters.add(page.getTitle());
093    
094                I18nizableText ed = (I18nizableText) parameters.get("user-directory-page-description");
095                I18nizableText msg = new I18nizableText(ed.getCatalogue(), ed.getKey(), i18nParameters);
096                result.put("user-directory-page-title", msg);
097                
098                ed = (I18nizableText) parameters.get("remove-user-directory-page-description");
099                msg = new I18nizableText(ed.getCatalogue(), ed.getKey(), i18nParameters);
100                result.put("remove-user-directory-page-title", msg);
101                
102                String contentTypeId = page.getValue(UserDirectoryPageHandler.CONTENT_TYPE_METADATA_NAME, StringUtils.EMPTY);
103                
104                if (StringUtils.isNotEmpty(contentTypeId))
105                {
106                    I18nizableText contentTypeText = _contentTypeEP.hasExtension(contentTypeId) ? _contentTypeEP.getExtension(contentTypeId).getLabel() : new I18nizableText(contentTypeId);
107                    
108                    Map<String, I18nizableTextParameter> contentTypeI18nParameters = new HashMap<>();
109                    contentTypeI18nParameters.put("0", contentTypeText);
110                    
111                    ed = (I18nizableText) parameters.get("contenttype-user-directory-page-description");
112                    msg = new I18nizableText(ed.getCatalogue(), ed.getKey(), contentTypeI18nParameters);
113                    result.put("contenttype-user-directory-page-description", msg);
114                }
115                
116                result.put("user-directory-page-id", new I18nizableText(page.getId()));
117                
118                I18nizableText defaultDirectoryDeep = (I18nizableText) parameters.get("default-depth");
119                long depthMetadata = page.getValue(UserDirectoryPageHandler.DEPTH_METADATA_NAME, -1L);
120                I18nizableText depth = depthMetadata == -1 ? defaultDirectoryDeep : new I18nizableText(String.valueOf(depthMetadata));
121                result.put("depth", depth);
122            }
123            else
124            {
125                List<String> i18nParameters = new ArrayList<>();
126                i18nParameters.add(page.getTitle());
127    
128                I18nizableText ed = (I18nizableText) parameters.get("add-user-directory-page-description");
129                I18nizableText msg = new I18nizableText(ed.getCatalogue(), ed.getKey(), i18nParameters);
130                
131                result.put("add-user-directory-page-id", new I18nizableText(page.getId()));
132                result.put("add-user-directory-page-title", msg);
133            }
134        }
135        else
136        {
137            List<String> noJcrI18nParameters = new ArrayList<>();
138            noJcrI18nParameters.add(page.getTitle());
139
140            I18nizableText ed = (I18nizableText) parameters.get("no-jcr-page-description");
141            I18nizableText msg = new I18nizableText(ed.getCatalogue(), ed.getKey(), noJcrI18nParameters);
142            
143            result.put("no-jcr-page-id", new I18nizableText(page.getId()));
144            result.put("no-jcr-page-title", msg);
145        }
146        
147        return result;
148    }
149    
150    private boolean _isUserDirectoryRootPage (JCRAmetysObject jcrPage)
151    {
152        try
153        {
154            Node node = jcrPage.getNode();
155            
156            if (node.hasProperty(AmetysObjectResolver.VIRTUAL_PROPERTY))
157            {
158                List<Value> values = Arrays.asList(node.getProperty(AmetysObjectResolver.VIRTUAL_PROPERTY).getValues());
159                
160                return values.stream()
161                        .map(LambdaUtils.wrap(Value::getString))
162                        .anyMatch(v -> VirtualUserDirectoryPageFactory.class.getName().equals(v));
163            }
164            else
165            {
166                return false;
167            }
168        }
169        catch (RepositoryException e)
170        {
171            return false;
172        }
173    }
174    
175    /**
176     * Gets the content types which can build a user directory
177     * @param pageId The id of the page being edited
178     * @return the content types which can build a user directory
179     */
180    @Callable
181    public List<Map<String, Object>> getSupportedContentTypes(String pageId)
182    {
183        List<Map<String, Object>> result = new ArrayList<>();
184        Page page = _resolver.resolveById(pageId);
185        
186        for (String contentTypeId : _contentTypeEP.getSubTypes(UserDirectoryPageHandler.ABSTRACT_USER_CONTENT_TYPE))
187        {
188            ContentType contentType = _contentTypeEP.getExtension(contentTypeId);
189            Page userDirectoryRootPage = _userDirectoryPageHandler.getUserDirectoryRootPage(page.getSiteName(), page.getSitemapName(), contentTypeId);
190            if (!contentType.isAbstract() && (userDirectoryRootPage == null || userDirectoryRootPage.equals(page)))
191            {
192                // The content type is not already a root of a user directory or is the root of the currently edited page
193                Map<String, Object> entry = new HashMap<>();
194                entry.put("value", contentType.getId());
195                entry.put("text", contentType.getLabel());
196                result.add(entry);
197            }
198        }
199        
200        return result;
201    }
202    
203    /**
204     * Sets the given page as the root of a user directory
205     * @param pageId The id of the page
206     * @param contentType The id of the content type
207     * @param metadata The 
208     * @param depth The depth of the tree structure
209     * @return A result map
210     * @throws RepositoryException if a repository error occured
211     */
212    @Callable
213    public Map<String, Object> setUserDirectoryRoot(String pageId, String contentType, String metadata, int depth) throws RepositoryException
214    {
215        Map<String, Object> result = new HashMap<>();
216        if (!_contentTypeEP.isDescendant(contentType, UserDirectoryPageHandler.ABSTRACT_USER_CONTENT_TYPE))
217        {
218            result.put("error", "invalid-content-type");
219            return result;
220        }
221        
222        Page page = _resolver.resolveById(pageId);
223        String oldContentType = page.getValue(UserDirectoryPageHandler.CONTENT_TYPE_METADATA_NAME, StringUtils.EMPTY);
224        String oldMetadata = page.getValue(UserDirectoryPageHandler.CLASSIFICATION_METADATA_METADATA_NAME, StringUtils.EMPTY);
225        long oldDepth = page.getValue(UserDirectoryPageHandler.DEPTH_METADATA_NAME, -1L);
226        
227        // Do nothing if page attribute are the same
228        if (!oldContentType.equals(contentType) || !oldMetadata.equals(metadata) || oldDepth != depth)
229        {
230            Set<Page> currentUserDirectoryPages = _userDirectoryPageHandler.getUserDirectoryRootPages(page.getSiteName(), page.getSitemapName());
231            
232            Map<String, Object> eventParams = new HashMap<>();
233            eventParams.put(org.ametys.web.ObservationConstants.ARGS_PAGE, page);
234            
235            if (currentUserDirectoryPages.contains(page))
236            {
237                // Unindex pages for all workspaces before the properties changed 
238                _observationManager.notify(new Event(ObservationConstants.EVENT_USER_DIRECTORY_ROOT_UPDATING, _currentUserProvider.getUser(), eventParams));
239                
240                _updateUserDirectoryRootProperty(page, contentType, metadata, depth);
241            }
242            else
243            {
244                _addUserDirectoryRootProperty(page, contentType, metadata, depth);
245            }
246            
247            _userDirectoryPageHandler.clearCache(page);
248            
249            // Live synchronization
250            _notifyPageUpdated(page);
251            
252            // Indexation
253            _observationManager.notify(new Event(ObservationConstants.EVENT_USER_DIRECTORY_ROOT_UPDATED, _currentUserProvider.getUser(), eventParams));
254        }
255        
256        return result;
257    }
258    
259    /**
260     * Remove the user directory root status to the given page
261     * @param pageId The id of the page
262     * @return A result map
263     * @throws RepositoryException if a repository error occured
264     */
265    @Callable
266    public Map<String, Object> removeUserDirectoryRoot(String pageId) throws RepositoryException
267    {
268        Map<String, Object> result = new HashMap<>();
269        
270        Page page = _resolver.resolveById(pageId);
271        
272        if (page instanceof JCRAmetysObject)
273        {
274            if (!_isUserDirectoryRootPage((JCRAmetysObject) page))
275            {
276                result.put("error", "no-root");
277                return result;
278            }
279            
280            Map<String, Object> eventParams = new HashMap<>();
281            eventParams.put(org.ametys.web.ObservationConstants.ARGS_PAGE, page);
282            
283            // Unindex pages for all workspaces before the properties were removed 
284            _observationManager.notify(new Event(ObservationConstants.EVENT_USER_DIRECTORY_ROOT_DELETING, _currentUserProvider.getUser(), eventParams));
285            
286            _userDirectoryPageHandler.clearCache(page);
287            _removeUserDirectoryRootProperty(page);
288            
289            _notifyPageUpdated(page);
290            
291            // After live synchronization
292            _observationManager.notify(new Event(ObservationConstants.EVENT_USER_DIRECTORY_ROOT_DELETED, _currentUserProvider.getUser(), eventParams));
293        }
294        else
295        {
296            result.put("error", "no-root");
297        }
298        return result;
299    }
300    
301    /**
302     * Gets information about user directory root status on the given.
303     * @param pageId The id of the page
304     * @return information about user directory root status on the given.
305     */
306    @Callable
307    public Map<String, Object> getRootPageInfo(String pageId)
308    {
309        Map<String, Object> result = new HashMap<>();
310        
311        Page page = _resolver.resolveById(pageId);
312        Set<Page> currentUserDirectoryPages = _userDirectoryPageHandler.getUserDirectoryRootPages(page.getSiteName(), page.getSitemapName());
313        
314        if (currentUserDirectoryPages.contains(page))
315        {
316            result.put("isRoot", true);
317            result.put("contentType", page.getValue(UserDirectoryPageHandler.CONTENT_TYPE_METADATA_NAME));
318            result.put("metadata", page.getValue(UserDirectoryPageHandler.CLASSIFICATION_METADATA_METADATA_NAME));
319            result.put("depth", page.getValue(UserDirectoryPageHandler.DEPTH_METADATA_NAME));
320        }
321        else
322        {
323            result.put("isRoot", false);
324        }
325        
326        return result;
327    }
328    
329    private void _addUserDirectoryRootProperty(Page page, String contentType, String metadata, int depth) throws RepositoryException
330    {
331        if (page instanceof JCRAmetysObject)
332        {
333            JCRAmetysObject jcrPage = (JCRAmetysObject) page;
334            Node node = jcrPage.getNode();
335            
336            List<Value> values = new ArrayList<>();
337            if (node.hasProperty(AmetysObjectResolver.VIRTUAL_PROPERTY))
338            {
339                values.addAll(Arrays.asList(node.getProperty(AmetysObjectResolver.VIRTUAL_PROPERTY).getValues()));
340            }
341            
342            StringValue virtualUserDirectoryPageFactoryClassName = new StringValue(VirtualUserDirectoryPageFactory.class.getName());
343            if (!values.contains(virtualUserDirectoryPageFactoryClassName))
344            {
345                values.add(virtualUserDirectoryPageFactoryClassName);
346            }
347            
348            node.setProperty(AmetysObjectResolver.VIRTUAL_PROPERTY, values.toArray(new Value[values.size()]));
349
350            // Set the user directory root property
351            if (page instanceof ModifiablePage)
352            {
353                ModifiablePage modifiablePage = (ModifiablePage) page;
354                modifiablePage.setValue(UserDirectoryPageHandler.CONTENT_TYPE_METADATA_NAME, contentType);
355                modifiablePage.setValue(UserDirectoryPageHandler.CLASSIFICATION_METADATA_METADATA_NAME, metadata);
356                modifiablePage.setValue(UserDirectoryPageHandler.DEPTH_METADATA_NAME, depth);
357            }
358            
359            jcrPage.saveChanges();
360        }
361    }
362    
363    private void _updateUserDirectoryRootProperty(Page page, String contentType, String metadata, int depth)
364    {
365        if (page instanceof ModifiablePage)
366        {
367            ModifiablePage modifiablePage = (ModifiablePage) page;
368            
369            // Set the user directory root property
370            modifiablePage.setValue(UserDirectoryPageHandler.CONTENT_TYPE_METADATA_NAME, contentType);
371            modifiablePage.setValue(UserDirectoryPageHandler.CLASSIFICATION_METADATA_METADATA_NAME, metadata);
372            modifiablePage.setValue(UserDirectoryPageHandler.DEPTH_METADATA_NAME, depth);
373            
374            modifiablePage.saveChanges();
375        }
376    }
377    
378    private void _removeUserDirectoryRootProperty(Page page) throws RepositoryException
379    {
380        if (page instanceof JCRAmetysObject)
381        {
382            JCRAmetysObject jcrPage = (JCRAmetysObject) page;
383            Node node = jcrPage.getNode();
384            
385            if (node.hasProperty(AmetysObjectResolver.VIRTUAL_PROPERTY))
386            {
387                List<Value> values = new ArrayList<>(Arrays.asList(node.getProperty(AmetysObjectResolver.VIRTUAL_PROPERTY).getValues()));
388                int index = values.stream()
389                        .map(LambdaUtils.wrap(Value::getString))
390                        .collect(Collectors.toList())
391                        .indexOf(VirtualUserDirectoryPageFactory.class.getName());
392                if (index != -1)
393                {
394                    values.remove(index);
395                    node.setProperty(AmetysObjectResolver.VIRTUAL_PROPERTY, values.toArray(new Value[values.size()]));
396                }
397
398                // Remove the user directory root property
399                if (page instanceof ModifiablePage)
400                {
401                    ModifiablePage modifiablePage = (ModifiablePage) page;
402                    if (modifiablePage.hasValue(UserDirectoryPageHandler.CONTENT_TYPE_METADATA_NAME))
403                    {
404                        modifiablePage.removeValue(UserDirectoryPageHandler.CONTENT_TYPE_METADATA_NAME);
405                    }
406                    if (modifiablePage.hasValue(UserDirectoryPageHandler.CLASSIFICATION_METADATA_METADATA_NAME))
407                    {
408                        modifiablePage.removeValue(UserDirectoryPageHandler.CLASSIFICATION_METADATA_METADATA_NAME);
409                    }
410                    if (modifiablePage.hasValue(UserDirectoryPageHandler.DEPTH_METADATA_NAME))
411                    {
412                        modifiablePage.removeValue(UserDirectoryPageHandler.DEPTH_METADATA_NAME);
413                    }
414                }
415                
416                jcrPage.saveChanges();
417            }
418        }
419    }
420    
421    private void _notifyPageUpdated(Page page)
422    {
423        Map<String, Object> eventParams = new HashMap<>();
424        eventParams.put(org.ametys.web.ObservationConstants.ARGS_PAGE, page);
425        _observationManager.notify(new Event(org.ametys.web.ObservationConstants.EVENT_PAGE_CHANGED, _currentUserProvider.getUser(), eventParams));
426    }
427}