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