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.ugc.generators;
017
018import java.io.IOException;
019
020import org.apache.avalon.framework.service.ServiceException;
021import org.apache.avalon.framework.service.ServiceManager;
022import org.apache.cocoon.ProcessingException;
023import org.apache.cocoon.environment.ObjectModelHelper;
024import org.apache.cocoon.environment.Request;
025import org.apache.cocoon.generation.ServiceableGenerator;
026import org.apache.cocoon.xml.XMLUtils;
027import org.apache.commons.lang.StringUtils;
028import org.xml.sax.SAXException;
029
030import org.ametys.cms.contenttype.ContentType;
031import org.ametys.cms.contenttype.ContentTypeExtensionPoint;
032import org.ametys.core.right.RightManager;
033import org.ametys.core.user.CurrentUserProvider;
034import org.ametys.plugins.repository.data.holder.ModelAwareDataHolder;
035import org.ametys.plugins.ugc.UGCConstants;
036import org.ametys.web.WebConstants;
037import org.ametys.web.cache.PageHelper;
038import org.ametys.web.content.FOContentCreationHelper;
039import org.ametys.web.repository.page.Page;
040import org.ametys.web.repository.page.ZoneItem;
041
042/**
043 * UGC service generator
044 */
045public class UGCGenerator extends ServiceableGenerator
046{
047    /** The {@link ContentType} manager */
048    protected ContentTypeExtensionPoint _cTypeExtPt;
049    /** The right manager */
050    protected RightManager _rightManager;
051    /** The current user provider */
052    protected CurrentUserProvider _currentUserProvider;
053    /** The FO content creation helper */
054    protected FOContentCreationHelper _foContentCreationHelper;
055    /** The page helper */
056    protected PageHelper _pageHelper;
057    
058    @Override
059    public void service(ServiceManager smanager) throws ServiceException
060    {
061        super.service(smanager);
062        _cTypeExtPt = (ContentTypeExtensionPoint) smanager.lookup(ContentTypeExtensionPoint.ROLE);
063        _rightManager = (RightManager) smanager.lookup(RightManager.ROLE);
064        _currentUserProvider = (CurrentUserProvider) smanager.lookup(CurrentUserProvider.ROLE);
065        _foContentCreationHelper = (FOContentCreationHelper) smanager.lookup(FOContentCreationHelper.ROLE);
066        _pageHelper = (PageHelper) smanager.lookup(PageHelper.ROLE);
067    }
068    
069    @Override
070    public void generate() throws IOException, SAXException, ProcessingException
071    {
072        Request request = ObjectModelHelper.getRequest(objectModel);
073
074        Page page = (Page) request.getAttribute(WebConstants.REQUEST_ATTR_PAGE);
075        ZoneItem zoneItem = (ZoneItem) request.getAttribute(WebConstants.REQUEST_ATTR_ZONEITEM);
076        
077        ModelAwareDataHolder serviceParameters = zoneItem.getServiceParameters();
078        String cType = (String) serviceParameters.getValue("content-type");
079        if (StringUtils.isBlank(cType))
080        {
081            throw new IllegalArgumentException("A content type must be defined");
082        }
083        
084        contentHandler.startDocument();
085        
086        XMLUtils.startElement(contentHandler, "ugc");
087        
088        // SAX inputs for UGC mixin
089        ContentType ugcMixin = _cTypeExtPt.getExtension(UGCConstants.UGC_MIXIN_TYPE);
090        _foContentCreationHelper.saxViewIfExists(contentHandler, ugcMixin, "mixin", "main");
091        
092        // SAX view
093        ContentType contentType = _cTypeExtPt.getExtension(cType);
094        _foContentCreationHelper.saxViewIfExists(contentHandler, contentType, "content-type", "main");
095        
096        // SAX contents values for metadata of type CONTENT
097        _foContentCreationHelper.saxContentValues(contentHandler, contentType, "items", page.getSitemapName());
098        
099        XMLUtils.createElement(contentHandler, "has-captcha", String.valueOf(_pageHelper.isCaptchaRequired(page)));
100        
101        XMLUtils.endElement(contentHandler, "ugc");
102        
103        contentHandler.endDocument();
104    }
105    
106    
107
108}