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.page;
017
018import java.util.ArrayList;
019import java.util.List;
020import java.util.Map;
021import java.util.SortedSet;
022
023import org.apache.avalon.framework.service.ServiceException;
024import org.apache.avalon.framework.service.ServiceManager;
025import org.apache.avalon.framework.service.Serviceable;
026
027import org.ametys.cms.repository.Content;
028import org.ametys.plugins.contentio.synchronize.SynchronizableContentsCollectionDAO;
029import org.ametys.plugins.contentio.synchronize.SynchronizableContentsCollectionHelper;
030import org.ametys.plugins.repository.AmetysObjectFactory;
031import org.ametys.plugins.repository.AmetysObjectIterable;
032import org.ametys.plugins.repository.AmetysObjectResolver;
033import org.ametys.plugins.repository.AmetysRepositoryException;
034import org.ametys.plugins.repository.CollectionIterable;
035import org.ametys.plugins.repository.UnknownAmetysObjectException;
036import org.ametys.plugins.repository.jcr.JCRAmetysObject;
037import org.ametys.plugins.repository.virtual.VirtualAmetysObjectFactory;
038import org.ametys.plugins.userdirectory.UserDirectoryPageHandler;
039import org.ametys.runtime.plugin.component.AbstractLogEnabled;
040import org.ametys.web.data.type.ModelItemTypeExtensionPoint;
041import org.ametys.web.repository.page.Page;
042import org.ametys.web.service.ServiceExtensionPoint;
043import org.ametys.web.skin.SkinsManager;
044
045/**
046 * {@link AmetysObjectFactory} for handling "virtual" user directory page
047 */
048public class VirtualUserDirectoryPageFactory extends AbstractLogEnabled implements VirtualAmetysObjectFactory<Page>, Serviceable
049{
050    /** The user directory root page handler. */
051    protected UserDirectoryPageHandler _userDirectoryPageHandler;
052    
053    /** The ametys object resolver */
054    protected AmetysObjectResolver _resolver;
055    
056    private SynchronizableContentsCollectionDAO _synchronizableContentsCollectionDAO;
057    private SkinsManager _skinManager;
058    private SynchronizableContentsCollectionHelper _sccHelper;
059    private ModelItemTypeExtensionPoint _pageDataTypeExtensionPoint;
060    private ServiceExtensionPoint _serviceExtensionPoint;
061    
062
063    @Override
064    public void service(ServiceManager manager) throws ServiceException
065    {
066        _userDirectoryPageHandler = (UserDirectoryPageHandler) manager.lookup(UserDirectoryPageHandler.ROLE);
067        _resolver = (AmetysObjectResolver) manager.lookup(AmetysObjectResolver.ROLE);
068        _synchronizableContentsCollectionDAO = (SynchronizableContentsCollectionDAO) manager.lookup(SynchronizableContentsCollectionDAO.ROLE);
069        _skinManager = (SkinsManager) manager.lookup(SkinsManager.ROLE);
070        _sccHelper = (SynchronizableContentsCollectionHelper) manager.lookup(SynchronizableContentsCollectionHelper.ROLE);
071        _pageDataTypeExtensionPoint = (ModelItemTypeExtensionPoint) manager.lookup(ModelItemTypeExtensionPoint.ROLE_PAGE_DATA);
072        _serviceExtensionPoint = (ServiceExtensionPoint) manager.lookup(ServiceExtensionPoint.ROLE);
073    }
074
075    @Override
076    public Page getAmetysObjectById(String id) throws AmetysRepositoryException
077    {
078        // No page object linked to this factory
079        throw new UnsupportedOperationException();
080    }
081
082    @Override
083    public boolean hasAmetysObjectForId(String id) throws AmetysRepositoryException
084    {
085        // No page object linked to this factory
086        throw new UnsupportedOperationException();
087    }
088
089    @Override
090    public String getScheme()
091    {
092        return "udroot";
093    }
094
095    @Override
096    public AmetysObjectIterable<Page> getChildren(JCRAmetysObject parent)
097    {
098        if (!(parent instanceof Page))
099        {
100            throw new IllegalArgumentException("The holder of the user directory virtual pages should be a page.");
101        }
102        
103        List<Page> children = new ArrayList<>();
104        Page rootPage = (Page) parent;
105        
106        int depth = _userDirectoryPageHandler.getDepth(rootPage);
107        if (depth > 0)
108        {
109            SortedSet<String> transitionalPagesName = _userDirectoryPageHandler.getTransitionalPagesName(rootPage, "_root");
110            for (String pageName : transitionalPagesName)
111            {
112                String pathName = _userDirectoryPageHandler.getPathName(pageName);
113                children.add(new TransitionalPage(rootPage, pageName, pathName, _resolver, _userDirectoryPageHandler, _synchronizableContentsCollectionDAO, _skinManager, _sccHelper, _pageDataTypeExtensionPoint, _pageDataTypeExtensionPoint, _serviceExtensionPoint, _pageDataTypeExtensionPoint));
114            }
115        }
116        else
117        {
118            Map<String, String> userPagesContent = _userDirectoryPageHandler.getUserPagesContent(rootPage, "_root");
119            for (String contentId : userPagesContent.values())
120            {
121                if (_resolver.hasAmetysObjectForId(contentId))
122                {
123                    Content content = _resolver.resolveById(contentId);
124                    children.add(new UserPage(rootPage, content, "_root", _resolver, _userDirectoryPageHandler, _synchronizableContentsCollectionDAO, _skinManager, _sccHelper, _pageDataTypeExtensionPoint, _pageDataTypeExtensionPoint, _serviceExtensionPoint, _pageDataTypeExtensionPoint));
125                }
126                else
127                {
128                    getLogger().info("Content '{}' is stil referenced, but it does not exists anymore");
129                }
130            }
131        }
132        
133        return new CollectionIterable<>(children);
134    }
135
136    @Override
137    public Page getChild(JCRAmetysObject parent, String childName)
138    {
139        if (!(parent instanceof Page))
140        {
141            throw new IllegalArgumentException("The holder of the user directory virtual pages should be a page.");
142        }
143        
144        Page rootPage = (Page) parent;
145        int intialDepth = _userDirectoryPageHandler.getDepth(rootPage);
146        
147        if (intialDepth > 0)
148        {
149            SortedSet<String> transitionalPagesName = _userDirectoryPageHandler.getTransitionalPagesName(rootPage, "_root");
150            String name = _userDirectoryPageHandler.getName(childName);
151            if (transitionalPagesName.contains(name))
152            {
153                return new TransitionalPage(rootPage, name, childName, _resolver, _userDirectoryPageHandler, _synchronizableContentsCollectionDAO, _skinManager, _sccHelper, _pageDataTypeExtensionPoint, _pageDataTypeExtensionPoint, _serviceExtensionPoint, _pageDataTypeExtensionPoint);
154            }
155            else
156            {
157                throw new UnknownAmetysObjectException("No transitional page named " + childName);
158            }
159        }
160        else
161        {
162            Map<String, String> userPagesContent = _userDirectoryPageHandler.getUserPagesContent(rootPage, "_root");
163            if (userPagesContent.containsKey(childName))
164            {
165                Content content = _resolver.resolveById(userPagesContent.get(childName));
166                return new UserPage(rootPage, content, "_root", _resolver, _userDirectoryPageHandler, _synchronizableContentsCollectionDAO, _skinManager, _sccHelper, _pageDataTypeExtensionPoint, _pageDataTypeExtensionPoint, _serviceExtensionPoint, _pageDataTypeExtensionPoint);
167            }
168            else
169            {
170                throw new UnknownAmetysObjectException("No user content named " + childName);
171            }
172        }
173    }
174
175    @Override
176    public boolean hasChild(JCRAmetysObject parent, String childName)
177    {
178        if (!(parent instanceof Page))
179        {
180            throw new IllegalArgumentException("The holder of the user directory virtual pages should be a page.");
181        }
182        
183        Page rootPage = (Page) parent;
184        int intialDepth = _userDirectoryPageHandler.getDepth(rootPage);
185        
186        if (intialDepth > 0)
187        {
188            SortedSet<String> transitionalPagesName = _userDirectoryPageHandler.getTransitionalPagesName(rootPage, "_root");
189            String name = _userDirectoryPageHandler.getName(childName);
190            return transitionalPagesName.contains(name);
191        }
192        else
193        {
194            Map<String, String> userPagesContent = _userDirectoryPageHandler.getUserPagesContent(rootPage, childName);
195            return userPagesContent.containsKey(childName);
196        }
197    }
198}