001/*
002 *  Copyright 2017 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.contentio.synchronize.clientsideelement;
017
018import java.util.ArrayList;
019import java.util.HashMap;
020import java.util.List;
021import java.util.Map;
022
023import org.apache.avalon.framework.service.ServiceException;
024import org.apache.avalon.framework.service.ServiceManager;
025
026import org.ametys.core.ui.StaticClientSideElement;
027import org.ametys.plugins.contentio.synchronize.SynchronizableContentsCollection;
028import org.ametys.plugins.contentio.synchronize.SynchronizableContentsCollectionHelper;
029
030/**
031 * This implementation test if at least one SCC is associated to the model defined by the sccModelId.
032 * If yes, the first collection is used to create the button, it there are no collections, the button is not displayed.
033 * Also, it set some elements to be used by the import tool (SCCSearchTool for most cases).
034 */
035public class SCCClientSideElement extends StaticClientSideElement
036{
037    /** SCC helper */
038    protected SynchronizableContentsCollectionHelper _sccHelper;
039    
040    @Override
041    public void service(ServiceManager smanager) throws ServiceException
042    {
043        super.service(smanager);
044        _sccHelper = (SynchronizableContentsCollectionHelper) smanager.lookup(SynchronizableContentsCollectionHelper.ROLE);
045    }
046    
047    @Override
048    public List<Script> getScripts(boolean ignoreRights, Map<String, Object> contextParameters)
049    {
050        List<Script> clonedScripts = new ArrayList<>();
051        
052        List<Script> scripts = super.getScripts(ignoreRights, contextParameters);
053        
054        for (Script script : scripts)
055        {
056            if (script.getParameters().containsKey("sccModelId"))
057            {
058                String sccModelId = (String) script.getParameters().get("sccModelId");
059                SynchronizableContentsCollection collection = _sccHelper.getSCCFromModelId(sccModelId);
060                if (collection != null)
061                {
062                    clonedScripts.add(_getScriptFromCollection(script, collection));
063                }
064            }
065        }
066        
067        return clonedScripts;
068    }
069
070    /**
071     * Get a cloned script by updating configuration with collection values.
072     * @param script The script to clone
073     * @param collection The collection
074     * @return A cloned script
075     */
076    @SuppressWarnings("unchecked")
077    protected Script _getScriptFromCollection(Script script, SynchronizableContentsCollection collection)
078    {
079        Script clonedScript = new Script(script);
080        
081        Map<String, Object> openToolParams = new HashMap<>();
082        
083        Object existingParams = clonedScript.getParameters().get("opentool-params");
084        if (existingParams instanceof Map)
085        {
086            openToolParams.putAll((Map) existingParams);
087        }
088        openToolParams.put("id", collection.getId());
089        openToolParams.put("collectionId", collection.getId());
090        openToolParams.put("collectionLabel", collection.getLabel());
091        clonedScript.getParameters().put("opentool-params", openToolParams);
092        
093        return clonedScript;
094    }
095}