001/*
002 *  Copyright 2015 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.web.skin.actions;
017
018import java.nio.file.Path;
019import java.util.Collection;
020import java.util.Collections;
021import java.util.HashMap;
022import java.util.Map;
023
024import org.apache.avalon.framework.context.Context;
025import org.apache.avalon.framework.context.ContextException;
026import org.apache.avalon.framework.context.Contextualizable;
027import org.apache.avalon.framework.parameters.Parameters;
028import org.apache.avalon.framework.service.ServiceException;
029import org.apache.avalon.framework.service.ServiceManager;
030import org.apache.cocoon.acting.ServiceableAction;
031import org.apache.cocoon.environment.ObjectModelHelper;
032import org.apache.cocoon.environment.Redirector;
033import org.apache.cocoon.environment.Request;
034import org.apache.cocoon.environment.SourceResolver;
035import org.apache.commons.lang3.StringUtils;
036
037import org.ametys.core.cocoon.JSonReader;
038import org.ametys.runtime.model.DefinitionAndValue;
039import org.ametys.runtime.model.ElementDefinition;
040import org.ametys.runtime.model.ModelItem;
041import org.ametys.runtime.model.View;
042import org.ametys.runtime.util.AmetysHomeHelper;
043import org.ametys.web.skin.Skin;
044import org.ametys.web.skin.SkinDAO;
045import org.ametys.web.skin.SkinParameterTypeExtensionPoint;
046import org.ametys.web.skin.SkinParametersModel;
047import org.ametys.web.skin.SkinsManager;
048
049/**
050 * Get the skin configuration parameters and their values
051 */
052public class SkinConfigurationAction extends ServiceableAction implements Contextualizable
053{
054    /** The service manager instance */
055    private SkinsManager _skinsManager;
056    private Context _context;
057    private SkinParameterTypeExtensionPoint _skinParameterTypeEP;
058    private SkinDAO _skinDAO;
059    
060    @Override
061    public void service(ServiceManager serviceManager) throws ServiceException
062    {
063        super.service(serviceManager);
064        _skinsManager = (SkinsManager) serviceManager.lookup(SkinsManager.ROLE);
065        _skinParameterTypeEP = (SkinParameterTypeExtensionPoint) serviceManager.lookup(SkinParameterTypeExtensionPoint.ROLE);
066        _skinDAO = (SkinDAO) serviceManager.lookup(SkinDAO.ROLE);
067    }
068    
069    public Map act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters) throws Exception
070    {
071        Request request = ObjectModelHelper.getRequest(objectModel);
072        
073        String skinName = request.getParameter("skinName");
074        String tempDir = request.getParameter("tempDir");
075        String skinDirName = request.getParameter("skinDir");
076        
077        Path skinDir = null;
078        if (StringUtils.isEmpty(tempDir))
079        {
080            Skin skin = _skinsManager.getSkin(skinName);
081            if (!skin.isConfigurable())
082            {
083                throw new IllegalStateException("The skin '" + skinName + "' is not configurable.");
084            }
085            
086            skinDir = skin.getRawPath(); // isConfigurable does not support inheritance. fine to edit local file thus
087        }
088        else
089        {
090            Path ametysTmpDir = AmetysHomeHelper.getAmetysHomeTmp().toPath();
091            skinDir = ametysTmpDir.resolve(tempDir).resolve(skinDirName);
092        }
093        
094        SkinParametersModel model = new SkinParametersModel(skinName, skinDir, _skinParameterTypeEP, _context, manager);
095        Map<String, Object> result = new HashMap<>();
096        
097        View view = model.getView();
098        result.put("parameters", view.toJSON());
099        
100        result.put("values", _values2json(skinDir, model.getModelItems()));
101        
102        request.setAttribute(JSonReader.OBJECT_TO_READ, result);
103        return Collections.EMPTY_MAP;
104    }
105
106    /**
107     * Read configuration file and return a flat map of values
108     * @param skinDir The skin directory
109     * @param skinParameterDefinitions The parameters definitions
110     * @return the configuration definition and values
111     * @throws Exception if a problem occurs reading values
112     */
113    private Map<String, Object> _values2json(Path skinDir, Collection<ElementDefinition> skinParameterDefinitions) throws Exception
114    {
115        Collection<DefinitionAndValue> definitionAndValues = _skinDAO.readValues(skinDir, skinParameterDefinitions);
116        
117        Map<String, Object> values = new HashMap<>();
118        
119        if (definitionAndValues != null)
120        {
121            for (DefinitionAndValue definitionAndValue : definitionAndValues)
122            {
123                ModelItem definition = definitionAndValue.getDefinition();
124                
125                // Skin parameter can only be element definitions
126                if (definition instanceof ElementDefinition)
127                {
128                    ElementDefinition elementDefinition = (ElementDefinition) definition;
129                    Object jsonValue = elementDefinition.getType().valueToJSONForClient(definitionAndValue.getValue());
130                    values.put(elementDefinition.getName(), jsonValue);
131                }
132            }
133        }
134
135        Map<String, Object> form = new HashMap<>();
136        form.put("values", values);
137        return form;
138    }
139    
140    public void contextualize(Context context) throws ContextException
141    {
142        _context = context;
143    }
144    
145}