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.frontedition;
017
018import java.util.ArrayList;
019import java.util.Arrays;
020import java.util.Collection;
021import java.util.Collections;
022import java.util.Comparator;
023import java.util.HashMap;
024import java.util.LinkedHashMap;
025import java.util.List;
026import java.util.Map;
027import java.util.Set;
028import java.util.stream.Collectors;
029
030import javax.jcr.RepositoryException;
031
032import org.apache.avalon.framework.context.Context;
033import org.apache.avalon.framework.context.ContextException;
034import org.apache.avalon.framework.context.Contextualizable;
035import org.apache.avalon.framework.logger.LogEnabled;
036import org.apache.avalon.framework.logger.Logger;
037import org.apache.avalon.framework.service.ServiceException;
038import org.apache.avalon.framework.service.ServiceManager;
039import org.apache.avalon.framework.service.Serviceable;
040import org.apache.cocoon.components.ContextHelper;
041import org.apache.cocoon.environment.Request;
042import org.apache.commons.lang3.ArrayUtils;
043import org.apache.commons.lang3.StringUtils;
044import org.apache.commons.lang3.tuple.Pair;
045import org.w3c.dom.NodeList;
046
047import org.ametys.cms.CmsConstants;
048import org.ametys.cms.clientsideelement.styles.HTMLEditorStyle;
049import org.ametys.cms.content.RootContentHelper;
050import org.ametys.cms.contenttype.AttributeDefinition;
051import org.ametys.cms.contenttype.ContentType;
052import org.ametys.cms.contenttype.ContentTypeExtensionPoint;
053import org.ametys.cms.contenttype.ContentTypesHelper;
054import org.ametys.cms.repository.Content;
055import org.ametys.cms.repository.WorkflowAwareContent;
056import org.ametys.cms.workflow.ContentWorkflowHelper;
057import org.ametys.core.right.RightManager;
058import org.ametys.core.right.RightManager.RightResult;
059import org.ametys.core.ui.ClientSideElement;
060import org.ametys.core.ui.ClientSideElement.Script;
061import org.ametys.core.ui.ClientSideElement.ScriptFile;
062import org.ametys.core.ui.widgets.richtext.RichTextConfiguration;
063import org.ametys.core.ui.widgets.richtext.RichTextConfigurationExtensionPoint;
064import org.ametys.core.util.I18nizableSerializer;
065import org.ametys.core.util.JSONUtils;
066import org.ametys.plugins.core.ui.minimize.HashCache;
067import org.ametys.plugins.explorer.resources.actions.ExplorerResourcesDAO;
068import org.ametys.plugins.repository.AmetysObject;
069import org.ametys.plugins.repository.AmetysObjectIterable;
070import org.ametys.plugins.repository.AmetysObjectResolver;
071import org.ametys.plugins.repository.AmetysRepositoryException;
072import org.ametys.plugins.repository.RepositoryConstants;
073import org.ametys.plugins.repository.UnknownAmetysObjectException;
074import org.ametys.plugins.repository.jcr.DefaultTraversableAmetysObject;
075import org.ametys.plugins.repository.provider.RequestAttributeWorkspaceSelector;
076import org.ametys.plugins.repository.version.VersionableAmetysObject;
077import org.ametys.plugins.workflow.support.WorkflowHelper;
078import org.ametys.plugins.workflow.support.WorkflowProvider;
079import org.ametys.plugins.workflow.support.WorkflowProvider.AmetysObjectWorkflow;
080import org.ametys.runtime.i18n.I18nizableText;
081import org.ametys.runtime.model.ModelItem;
082import org.ametys.runtime.model.ModelItemGroup;
083import org.ametys.runtime.plugin.PluginsManager;
084import org.ametys.web.cache.PageHelper;
085import org.ametys.web.renderingcontext.RenderingContext;
086import org.ametys.web.repository.page.ModifiablePage;
087import org.ametys.web.repository.page.Page;
088import org.ametys.web.repository.page.SitemapElement;
089import org.ametys.web.repository.page.Zone;
090import org.ametys.web.repository.page.ZoneItem;
091import org.ametys.web.repository.site.Site;
092import org.ametys.web.repository.site.SiteManager;
093import org.ametys.web.repository.sitemap.Sitemap;
094import org.ametys.web.transformation.xslt.AmetysXSLTHelper;
095
096import com.opensymphony.workflow.loader.ActionDescriptor;
097import com.opensymphony.workflow.loader.StepDescriptor;
098import com.opensymphony.workflow.loader.WorkflowDescriptor;
099import com.opensymphony.workflow.spi.Step;
100
101/**
102 * Helper for preparing the Ametys Edition
103 */
104public class AmetysFrontEditionHelper implements Serviceable, Contextualizable, LogEnabled
105{
106    /** The right's id from front-edition access */
107    public static final String FRONT_EDITION_RIGHT_ID = "Front_Edition_Access_Right";
108    
109    private static AmetysObjectResolver _ametysObjectResolver;
110    private static HashCache _hashCache;
111    private static RichTextConfigurationExtensionPoint _richTextConfigurationExtensionPoint;
112    private static HTMLEditorStyle _htmlEditorStyle;
113    private static RightManager _rightManager;
114    private static ContentWorkflowHelper _contentWorkflowHelper;
115    private static PageHelper _pageHelper;
116    private static WorkflowHelper _workflowHelper;
117    private static JSONUtils _jsonUtils;
118    private static SiteManager _siteManager;
119    private static WorkflowProvider _workflowProvider;
120    private static ContentTypesHelper _contentTypesHelper;
121    private static ContentTypeExtensionPoint _contentTypesEP;
122    private static RootContentHelper _rootContentHelper;
123    
124    private static Context _context;
125
126    private static Logger _logger;
127
128    public void service(ServiceManager manager) throws ServiceException
129    {
130        _ametysObjectResolver = (AmetysObjectResolver) manager.lookup(AmetysObjectResolver.ROLE);
131        _siteManager = (SiteManager) manager.lookup(SiteManager.ROLE);
132        _hashCache = (HashCache) manager.lookup(HashCache.ROLE);
133        _richTextConfigurationExtensionPoint = (RichTextConfigurationExtensionPoint) manager.lookup(RichTextConfigurationExtensionPoint.ROLE);
134        _htmlEditorStyle = (HTMLEditorStyle) manager.lookup(HTMLEditorStyle.ROLE);
135        _rightManager = (RightManager) manager.lookup(RightManager.ROLE);
136        _contentWorkflowHelper = (ContentWorkflowHelper) manager.lookup(ContentWorkflowHelper.ROLE);
137        _contentTypesHelper = (ContentTypesHelper) manager.lookup(ContentTypesHelper.ROLE);
138        _contentTypesEP = (ContentTypeExtensionPoint) manager.lookup(ContentTypeExtensionPoint.ROLE);
139        _pageHelper = (PageHelper) manager.lookup(PageHelper.ROLE);
140        _workflowHelper = (WorkflowHelper) manager.lookup(WorkflowHelper.ROLE);
141        _jsonUtils = (JSONUtils) manager.lookup(JSONUtils.ROLE);
142        _workflowProvider = (WorkflowProvider) manager.lookup(WorkflowProvider.ROLE);
143        _rootContentHelper = (RootContentHelper) manager.lookup(RootContentHelper.ROLE);
144    }
145    
146    @Override
147    public void contextualize(Context context) throws ContextException
148    {
149        _context = context;
150    }
151    
152    @Override
153    public void enableLogging(Logger logger)
154    {
155        _logger = logger;
156    }
157    
158    /**
159     * Prepare a hashcode for js files
160     * @param locale The language code to use
161     * @param theme The url for the theme
162     * @return The new hashcode to read the minimified concatened file
163     */
164    public static String prepareJSFiles(String locale, String theme)
165    {
166        String themeName = StringUtils.substringAfterLast(theme, "/");
167        
168        Map<String, String> filesInfos = new HashMap<>();
169        filesInfos.put("media", "");
170        filesInfos.put("tag", "script");
171        
172        Map<String, Map<String, String>> files = new LinkedHashMap<>();
173        files.put("/plugins/extjs7/resources/ext-all.js", filesInfos);
174        files.put("/plugins/extjs7/resources/classic/locale/locale-" + locale + ".js", filesInfos);
175        files.put(theme + "/" + themeName + ".js", filesInfos);
176
177        files.put("/plugins/core-ui/resources/js/Ext.fixes." + locale + ".js", filesInfos);
178        files.put("/plugins/core-ui/resources/js/Ext.enhancements." + locale + ".js", filesInfos);
179        
180        files.put("/plugins/core-ui/resources/js/Ametys." + locale + ".js", filesInfos);
181        files.put("/plugins/front-edition/resources/js/Ametys/override/Ametys." + locale + ".js", filesInfos);
182        files.put("/plugins/core-ui/resources/js/Ametys/mask/GlobalLoadMask." + locale + ".js", filesInfos);
183        
184        files.put("/plugins/core-ui/resources/js/Ametys/log/Logger." + locale + ".js", filesInfos);
185        files.put("/plugins/core-ui/resources/js/Ametys/log/Logger/Entry." + locale + ".js", filesInfos);
186        files.put("/plugins/core-ui/resources/js/Ametys/log/LoggerFactory." + locale + ".js", filesInfos);
187        files.put("/plugins/core-ui/resources/js/Ametys/log/ErrorDialog." + locale + ".js", filesInfos);
188        
189        files.put("/plugins/core-ui/resources/js/Ametys/window/DialogBox." + locale + ".js", filesInfos);
190        files.put("/plugins/front-edition/resources/js/Ametys/override/Ametys/window/DialogBox." + locale + ".js", filesInfos);
191        files.put("/plugins/core-ui/resources/js/Ametys/window/MessageBox." + locale + ".js", filesInfos);
192        
193        files.put("/plugins/core-ui/resources/js/Ametys/form/AbstractField." + locale + ".js", filesInfos);
194        files.put("/plugins/core-ui/resources/js/Ametys/form/AbstractFieldsWrapper." + locale + ".js", filesInfos);
195        files.put("/plugins/core-ui/resources/js/Ametys/form/AbstractQueryableComboBox." + locale + ".js", filesInfos);
196        files.put("/plugins/core-ui/resources/js/Ametys/form/AbstractQueryableComboBox/SplitterTracker." + locale + ".js", filesInfos);
197        files.put("/plugins/front-edition/resources/js/Ametys/override/Ametys/form/widget/AbstractQueryableComboBox." + locale + ".js", filesInfos);
198        files.put("/plugins/core-ui/resources/js/Ametys/form/field/DateTime." + locale + ".js", filesInfos);
199        files.put("/plugins/core-ui/resources/js/Ametys/form/field/StringTime." + locale + ".js", filesInfos);
200        files.put("/plugins/core-ui/resources/js/Ametys/form/field/Password." + locale + ".js", filesInfos);
201        files.put("/plugins/core-ui/resources/js/Ametys/form/field/ChangePassword." + locale + ".js", filesInfos);
202        files.put("/plugins/core-ui/resources/js/Ametys/form/field/ReferencedNumberField." + locale + ".js", filesInfos);
203        files.put("/plugins/core-ui/resources/js/Ametys/form/field/RichText." + locale + ".js", filesInfos);
204        files.put("/plugins/cms/resources/js/Ametys/cms/form/field/RichText." + locale + ".js", filesInfos);
205        files.put("/plugins/core-ui/resources/js/Ametys/form/field/RichText/SplitterTracker." + locale + ".js", filesInfos);
206        files.put("/plugins/core-ui/resources/js/Ametys/form/field/TextArea." + locale + ".js", filesInfos);
207        files.put("/plugins/core-ui/resources/js/Ametys/form/field/ColorSelector." + locale + ".js", filesInfos);
208        files.put("/plugins/core-ui/resources/js/Ametys/form/field/SelectUserDirectory." + locale + ".js", filesInfos);
209        files.put("/plugins/core-ui/resources/js/Ametys/form/field/SelectGroupDirectories." + locale + ".js", filesInfos);
210        files.put("/plugins/core-ui/resources/js/Ametys/form/field/Code." + locale + ".js", filesInfos);
211        
212        files.put("/plugins/core-ui/resources/js/Ametys/helper/ChooseLocationLeaflet." + locale + ".js", filesInfos);
213        files.put("/plugins/core-ui/resources/js/Ametys/form/widget/GeoCode." + locale + ".js", filesInfos);
214        files.put("/plugins/core-ui/resources/js/Ametys/grid/GridColumnHelper." + locale + ".js", filesInfos);
215        files.put("/plugins/tiny_mce/resources/js/tinymce.js", filesInfos);
216        files.put("/plugins/codemirror/resources/js/codemirror.js", filesInfos);
217        files.put("/plugins/codemirror/resources/js/addon/edit/matchbrackets.js", filesInfos);
218        files.put("/plugins/codemirror/resources/js/addon/selection/active-line.js", filesInfos);
219        files.put("/plugins/codemirror/resources/js/mode/xml/xml.js", filesInfos);
220        files.put("/plugins/codemirror/resources/js/mode/javascript/javascript.js", filesInfos);
221        files.put("/plugins/codemirror/resources/js/mode/css/css.js", filesInfos);
222        files.put("/plugins/codemirror/resources/js/mode/htmlmixed/htmlmixed.js", filesInfos);
223        
224        files.put("/plugins/core-ui/resources/js/Ametys/data/ServerCaller." + locale + ".js", filesInfos);
225        files.put("/plugins/core-ui/resources/js/Ametys/data/ServerComm." + locale + ".js", filesInfos);
226        files.put("/plugins/front-edition/resources/js/Ametys/override/Ametys/data/ServerComm." + locale + ".js", filesInfos);
227        files.put("/plugins/core-ui/resources/js/Ametys/data/ServerCommProxy." + locale + ".js", filesInfos);
228        files.put("/plugins/core-ui/resources/js/Ametys/data/ServerComm/TimeoutDialog." + locale + ".js", filesInfos);
229
230        files.put("/plugins/core-ui/resources/js/Ametys/form/widget/RichText/RichTextConfigurationBase." + locale + ".js", filesInfos);
231        files.put("/plugins/core-ui/resources/js/Ametys/form/widget/RichText/RichTextConfiguration." + locale + ".js", filesInfos);
232        
233        files.put("/plugins/core-ui/resources/js/Ametys/plugins/coreui/system/devmode/StacktraceHelper." + locale + ".js", filesInfos);
234
235        files.put("/plugins/front-edition/resources/js/front-comm." + locale + ".js", filesInfos);
236        files.put("/plugins/front-edition/resources/js/front-widget." + locale + ".js", filesInfos);
237//        files.put("/plugins/front-edition/resources/js/front-page." + locale + ".js", filesInfos);
238        files.put("/plugins/core-ui/resources/js/Ametys/helper/EnterURL." + locale + ".js", filesInfos);
239        files.put("/plugins/core-ui/resources/js/Ametys/helper/FileUpload." + locale + ".js", filesInfos);
240        files.put("/plugins/web/resources/js/Ametys/web/helper/ChoosePage." + locale + ".js", filesInfos);
241        files.put("/plugins/web/resources/js/Ametys/web/helper/ContextToolbar." + locale + ".js", filesInfos);
242        files.put("/plugins/web/resources/js/Ametys/web/sitemap/SitemapTree." + locale + ".js", filesInfos);
243        files.put("/plugins/web/resources/js/Ametys/web/sitemap/SitemapTree/Page." + locale + ".js", filesInfos);
244        files.put("/plugins/web/resources/js/Ametys/web/sitemap/SitemapTree/Sitemap." + locale + ".js", filesInfos);
245        files.put("/plugins/web/resources/js/Ametys/web/site/SitesTree/Site." + locale + ".js", filesInfos);
246        files.put("/plugins/cms/resources/js/Ametys/cms/editor/LinkHandler." + locale + ".js", filesInfos);
247        files.put("/plugins/cms/resources/js/Ametys/plugins/cms/editor/Links." + locale + ".js", filesInfos);
248        files.put("/plugins/cms/resources/js/Ametys/plugins/cms/editor/Links/LinkHandler." + locale + ".js", filesInfos);
249        files.put("/plugins/web/resources/js/Ametys/plugins/web/editor/Links." + locale + ".js", filesInfos);
250        files.put("/plugins/web/resources/js/Ametys/plugins/web/editor/PageLinkHandler." + locale + ".js", filesInfos);
251        files.put("/plugins/cms/resources/js/Ametys/plugins/cms/editor/Images." + locale + ".js", filesInfos);
252        
253        files.put("/plugins/cms/resources/js/tinymce/basicstyles." + locale + ".js", filesInfos);
254        files.put("/plugins/cms/resources/js/tinymce/lists." + locale + ".js", filesInfos);
255        files.put("/plugins/cms/resources/js/tinymce/links." + locale + ".js", filesInfos);
256        files.put("/plugins/web/resources/js/tinymce/links." + locale + ".js", filesInfos);
257        files.put("/plugins/front-edition/resources/js/tinymce/links." + locale + ".js", filesInfos);
258        files.put("/plugins/cms/resources/js/tinymce/styles." + locale + ".js", filesInfos);
259        files.put("/plugins/cms/resources/js/tinymce/images." + locale + ".js", filesInfos);
260        files.put("/plugins/front-edition/resources/js/tinymce/images." + locale + ".js", filesInfos);
261        
262        if (PluginsManager.getInstance().getPluginNames().contains("inlinemedia"))
263        {
264            
265            files.put("/plugins/inlinemedia/resources/js/Ametys/plugins/inlinemedia/Media." + locale + ".js", filesInfos);
266            files.put("/plugins/inlinemedia/resources/js/Ametys/plugins/inlinemedia/InsertMediaHelper." + locale + ".js", filesInfos);
267            files.put("/plugins/inlinemedia/resources/js/tinymce/images." + locale + ".js", filesInfos);
268        }
269        
270        files.put("/plugins/front-edition/resources/js/tinymce/save." + locale + ".js", filesInfos);
271        
272        //TinyMCE Tables
273        files.put("/plugins/cms/resources/js/tinymce/tables." + locale + ".js", filesInfos);
274        files.put("/plugins/front-edition/resources/js/tinymce/tables." + locale + ".js", filesInfos);
275        files.put("/plugins/cms/resources/js/Ametys/plugins/cms/editor/Tables." + locale + ".js", filesInfos);
276        files.put("/plugins/cms/resources/js/Ametys/plugins/cms/editor/BasicActions." + locale + ".js", filesInfos);
277        //TinyMCE Images
278        files.put("/plugins/cms/resources/js/Ametys/cms/uihelper/ChooseResource." + locale + ".js", filesInfos);
279        files.put("/plugins/explorer/resources/js/Ametys/explorer/tree/ExplorerTree." + locale + ".js", filesInfos);
280        files.put("/plugins/explorer/resources/js/Ametys/explorer/tree/ExplorerTree/NodeEntry." + locale + ".js", filesInfos);
281        files.put("/plugins/explorer/resources/js/Ametys/explorer/Resource." + locale + ".js", filesInfos);
282        files.put("/plugins/explorer/resources/js/Ametys/explorer/ExplorerNodeDAO." + locale + ".js", filesInfos);
283        files.put("/plugins/explorer/resources/js/Ametys/explorer/ExplorerNode." + locale + ".js", filesInfos);
284        files.put("/plugins/web/resources/js/Ametys/plugins/web/explorer/ExplorerNode." + locale + ".js", filesInfos);
285        files.put("/plugins/cms/resources/js/Ametys/cms/attach/AttachmentsExplorerTree." + locale + ".js", filesInfos);
286        files.put("/plugins/cms/resources/js/Ametys/cms/uihelper/ChooseAttachmentFile." + locale + ".js", filesInfos);
287        files.put("/plugins/front-edition/resources/js/Ametys/override/Ametys/cms/uihelper/ChooseAttachmentFile." + locale + ".js", filesInfos);
288        files.put("/plugins/explorer/resources/js/Ametys/explorer/resources/actions/FileActions." + locale + ".js", filesInfos);
289        files.put("/plugins/explorer/resources/js/Ametys/explorer/resources/helper/ResourceUpload." + locale + ".js", filesInfos);
290        files.put("/plugins/core-ui/resources/js/Ametys/file/AbstractFileExplorerTree/FileNode." + locale + ".js", filesInfos);
291        files.put("/plugins/core-ui/resources/js/Ametys/file/AbstractFileExplorerTree." + locale + ".js", filesInfos);
292
293        //Empty Message class
294        files.put("/plugins/core-ui/resources/js/Ametys/message/Message." + locale + ".js", filesInfos);
295        files.put("/plugins/core-ui/resources/js/Ametys/message/MessageTarget." + locale + ".js", filesInfos);
296        files.put("/plugins/core-ui/resources/js/Ametys/message/MessageTargetFactory." + locale + ".js", filesInfos);
297        files.put("/plugins/core-ui/resources/js/Ametys/message/factory/DefaultMessageTargetFactory." + locale + ".js", filesInfos);
298        files.put("/plugins/front-edition/resources/js/Ametys/message/MessageTargetHelper." + locale + ".js", filesInfos);
299        //add page
300        files.put("/plugins/web/resources/js/Ametys/plugins/web/page/AddPageWizard." + locale + ".js", filesInfos);
301        files.put("/plugins/front-edition/resources/js/Ametys/override/Ametys/plugins/web/page/AddPageWizard." + locale + ".js", filesInfos);
302        files.put("/plugins/web/resources/js/Ametys/web/sitemap/SitemapDAO." + locale + ".js", filesInfos);
303        files.put("/plugins/web/resources/js/Ametys/web/sitemap/Sitemap." + locale + ".js", filesInfos);
304        files.put("/plugins/web/resources/js/Ametys/web/page/PageDAO." + locale + ".js", filesInfos);
305        files.put("/plugins/front-edition/resources/js/Ametys/override/Ametys/web/page/PageDAO." + locale + ".js", filesInfos);
306        files.put("/plugins/web/resources/js/Ametys/plugins/web/page/AddPageWizard/Card." + locale + ".js", filesInfos);
307        files.put("/plugins/web/resources/js/Ametys/plugins/web/page/AddPageWizard/CreatePageCard." + locale + ".js", filesInfos);
308        files.put("/plugins/web/resources/js/Ametys/plugins/web/page/AddPageWizard/PageContentCard." + locale + ".js", filesInfos);
309        files.put("/plugins/web/resources/js/Ametys/plugins/web/page/AddPageWizard/ContentPropertiesCard." + locale + ".js", filesInfos);
310        files.put("/plugins/core-ui/resources/js/Ametys/form/Widget." + locale + ".js", filesInfos);
311        files.put("/plugins/core-ui/resources/js/Ametys/form/ConfigurableFormPanel." + locale + ".js", filesInfos);
312        files.put("/plugins/front-edition/resources/js/Ametys/userprefs/UserPrefsDAO." + locale + ".js", filesInfos);
313        files.put("/plugins/core-ui/resources/js/Ametys/form/ConfigurableFormPanel/Repeater." + locale + ".js", filesInfos);
314        files.put("/plugins/core-ui/resources/js/Ametys/form/ConfigurableFormPanel/FieldCheckersManager." + locale + ".js", filesInfos);
315        files.put("/plugins/front-edition/resources/js/Ametys/message/MessageBus." + locale + ".js", filesInfos);
316        files.put("/plugins/core-ui/resources/js/Ametys/form/WidgetManager." + locale + ".js", filesInfos);
317        files.put("/plugins/core-ui/resources/js/Ametys/form/widget/DefaultWidgets." + locale + ".js", filesInfos);
318        files.put("/plugins/core-ui/resources/js/Ametys/form/widget/Date." + locale + ".js", filesInfos);
319        files.put("/plugins/core-ui/resources/js/Ametys/form/widget/DateTime." + locale + ".js", filesInfos);
320        files.put("/plugins/front-edition/resources/js/Ametys/override/Ametys/form/WidgetManager." + locale + ".js", filesInfos);
321        
322        files.put("/plugins/cms/resources/js/Ametys/cms/content/ContentDAO." + locale + ".js", filesInfos);
323        files.put("/plugins/web/resources/js/Ametys/web/content/ContentDAO." + locale + ".js", filesInfos);
324        files.put("/plugins/front-edition/resources/js/Ametys/override/Ametys/cms/content/ContentDAO." + locale + ".js", filesInfos);
325        files.put("/plugins/cms/resources/js/Ametys/cms/content/Content." + locale + ".js", filesInfos);
326        files.put("/plugins/core-ui/resources/js/Ametys/navhistory/HistoryDAO." + locale + ".js", filesInfos);
327        files.put("/plugins/core-ui/resources/js/Ametys/window/MessageBox." + locale + ".js", filesInfos);
328        files.put("/plugins/front-edition/resources/js/Ametys/tool/ToolsManager." + locale + ".js", filesInfos);
329
330        files.put("/plugins/cms/resources/js/Ametys/cms/form/widget/RichText." + locale + ".js", filesInfos);
331        files.put("/plugins/front-edition/resources/js/Ametys/override/Ametys/cms/form/widget/SelectContent/ContentEntry." + locale + ".js", filesInfos);
332        files.put("/plugins/cms/resources/js/Ametys/cms/form/widget/SelectContent." + locale + ".js", filesInfos);
333        files.put("/plugins/front-edition/resources/js/Ametys/override/Ametys/cms/form/widget/SelectContent." + locale + ".js", filesInfos);
334        files.put("/plugins/cms/resources/js/Ametys/cms/form/widget/SelectReferenceTableContent." + locale + ".js", filesInfos);
335        files.put("/plugins/front-edition/resources/js/Ametys/override/Ametys/cms/form/widget/SelectReferenceTableContent." + locale + ".js", filesInfos);
336        files.put("/plugins/web/resources/js/Ametys/plugins/web/page/AddPageWizard/PageTypeCard." + locale + ".js", filesInfos);
337        files.put("/plugins/front-edition/resources/js/Ametys/override/Ametys/plugins/web/page/AddPageWizard/PageTypeCard." + locale + ".js", filesInfos);
338        files.put("/plugins/web/resources/js/Ametys/web/form/widget/SelectPage." + locale + ".js", filesInfos);
339        files.put("/plugins/front-edition/resources/js/Ametys/override/Ametys/web/form/widget/SelectPage." + locale + ".js", filesInfos);
340        files.put("/plugins/web/resources/js/Ametys/web/form/widget/SelectSite." + locale + ".js", filesInfos);
341        files.put("/plugins/web/resources/js/Ametys/web/helper/ChooseSite." + locale + ".js", filesInfos);
342        files.put("/plugins/web/resources/js/Ametys/web/site/SitesTree." + locale + ".js", filesInfos);
343        files.put("/plugins/web/resources/js/Ametys/web/site/SitesTree/Site." + locale + ".js", filesInfos);
344        files.put("/plugins/web/resources/js/Ametys/web/helper/ContextToolbar." + locale + ".js", filesInfos);
345        files.put("/plugins/web/resources/js/Ametys/web/site/SitesTree/Site." + locale + ".js", filesInfos);
346        files.put("/plugins/web/resources/js/Ametys/web/form/widget/SelectPage/PageEntry." + locale + ".js", filesInfos);
347        files.put("/plugins/web/resources/js/Ametys/plugins/web/page/AddPageWizard/TagsCard." + locale + ".js", filesInfos);
348        files.put("/plugins/web/resources/js/Ametys/plugins/web/page/AddPageWizard/TagsCardLite." + locale + ".js", filesInfos);
349        files.put("/plugins/web/resources/js/Ametys/web/page/Page." + locale + ".js", filesInfos);
350        files.put("/plugins/cms/resources/js/Ametys/plugins/cms/tag/TagsTreePanel." + locale + ".js", filesInfos);
351        files.put("/plugins/cms/resources/js/Ametys/plugins/cms/tag/TagsTreePanel/TagNode." + locale + ".js", filesInfos);
352
353        //delete page
354        files.put("/plugins/web/resources/js/Ametys/plugins/web/sitemap/SitemapActions." + locale + ".js", filesInfos);
355
356        //page tags
357        files.put("/plugins/web/resources/js/Ametys/plugins/web/tag/AffectTagAction." + locale + ".js", filesInfos);
358        files.put("/plugins/cms/resources/js/Ametys/cms/uihelper/ChooseTagHelper." + locale + ".js", filesInfos);
359        files.put("/plugins/cms/resources/js/Ametys/cms/uihelper/ChooseTag." + locale + ".js", filesInfos);
360        files.put("/plugins/web/resources/js/Ametys/web/helper/ChooseTag." + locale + ".js", filesInfos);
361        files.put("/plugins/cms/resources/js/Ametys/plugins/cms/tag/TagActions." + locale + ".js", filesInfos);
362        files.put("/plugins/web/resources/js/Ametys/plugins/web/tag/TagsTreePanel." + locale + ".js", filesInfos);
363        
364        // scheduled publication
365        files.put("/plugins/web/resources/js/Ametys/plugins/web/page/SchedulePublication." + locale + ".js", filesInfos);
366        files.put("/plugins/front-edition/resources/js/Ametys/override/Ametys/plugins/web/page/SchedulePublication." + locale + ".js", filesInfos);
367
368        // ping
369        files.put("/plugins/core-ui/resources/js/Ametys/plugins/coreui/system/StartTimeChecker." + locale + ".js", filesInfos);
370
371        // actions on content
372        files.put("/plugins/cms/resources/js/Ametys/cms/uihelper/EditContent." + locale + ".js", filesInfos);
373        files.put("/plugins/web/resources/js/Ametys/plugins/web/zone/ZoneActions." + locale + ".js", filesInfos);
374        files.put("/plugins/web/resources/js/Ametys/plugins/web/zone/ZoneDAO." + locale + ".js", filesInfos);
375
376        // file widget (+cropping for image filter)
377        files.put("/plugins/core-ui/resources/js/Ametys/form/widget/File." + locale + ".js", filesInfos);
378        files.put("/plugins/front-edition/resources/js/Ametys/override/Ametys/form/widget/File." + locale + ".js", filesInfos);
379        files.put("/plugins/core-ui/resources/js/Ametys/form/widget/File/FileSource." + locale + ".js", filesInfos);
380        files.put("/plugins/core-ui/resources/js/Ametys/form/widget/File/External." + locale + ".js", filesInfos);
381        files.put("/plugins/cms/resources/js/Ametys/cms/form/widget/File/Resource." + locale + ".js", filesInfos);
382        files.put("/plugins/core-ui/resources/js/Ametys/helper/crop/CropDialog." + locale + ".js", filesInfos);
383        files.put("/plugins/core-ui/resources/js/Jcrop/jquery.Jcrop." + locale + ".js", filesInfos);
384        files.put("/plugins/core-ui/resources/js/Ametys/form/widget/Image." + locale + ".js", filesInfos);
385        files.put("/plugins/front-edition/resources/js/Ametys/override/Ametys/form/widget/Image." + locale + ".js", filesInfos);
386        
387        // save errors
388        files.put("/plugins/core-ui/resources/js/Ametys/form/SaveHelper/SaveErrorDialog." + locale + ".js", filesInfos);
389        files.put("/plugins/cms/resources/js/Ametys/cms/content/ContentErrorHelper." + locale + ".js", filesInfos);
390        
391        // Let's add all richtextconfiguration files
392        _addRichTextConfigurationFiles(files, filesInfos, locale, true);
393
394        return _hashCache.createHash(files, locale);
395    }
396
397    /**
398     * Prepare a hashcode for css files
399     * @param locale The language code to use
400     * @param theme The url for the theme
401     * @return The new hashcode to read the minimified concatened file
402     */
403    public static String prepareCSSFiles(String locale, String theme)
404    {
405        Map<String, String> filesInfos = new HashMap<>();
406        filesInfos.put("media", "");
407        filesInfos.put("tag", "link");
408        
409        Map<String, Map<String, String>> files = new LinkedHashMap<>();
410        String themeName = StringUtils.substringAfterLast(theme, "/");
411        files.put(theme + "/" + themeName + "-all.css", filesInfos);
412        files.put("/plugins/front-edition/resources/css/theme-ametys-base-light.css", filesInfos);
413        files.put("/plugins/core-ui/resources/font/ametys/AmetysIcon.css", filesInfos);
414        files.put("/plugins/core-ui/resources/css/Ametys/form/image.css", filesInfos);
415        files.put("/plugins/core-ui/resources/css/Jcrop/jquery.Jcrop.css", filesInfos);
416        files.put("/plugins/web/resources/css/pages/addpage.css", filesInfos);
417        files.put("/plugins/cms/resources/css/selectcontent.css", filesInfos);
418        files.put("/plugins/codemirror/resources/css/codemirror.css", filesInfos);
419        files.put("/plugins/codemirror/resources/js/addon/hint/show-hint.css", filesInfos);
420        
421        // Let's add all richtextconfiguration files
422        _addRichTextConfigurationFiles(files, filesInfos, locale, false);
423        
424        return _hashCache.createHash(files, locale);
425    }
426
427    private static List<ScriptFile> _getRichTextConfigurationFiles(boolean scripts, Map<String, Object> contextParameters)
428    {
429        List<ScriptFile> files = new ArrayList<>();
430        
431        for (String richTextConfigurationId : _richTextConfigurationExtensionPoint.getExtensionsIds())
432        {
433            RichTextConfiguration richTextConfiguration = _richTextConfigurationExtensionPoint.getExtension(richTextConfigurationId);
434            for (String category : richTextConfiguration.getCategories())
435            {
436                Set<ClientSideElement> convertors = richTextConfiguration.getConvertors(category, contextParameters);
437                _addFilesForClientSideElements(scripts, files, convertors);
438
439                Set<ClientSideElement> validators = richTextConfiguration.getValidators(category, contextParameters);
440                _addFilesForClientSideElements(scripts, files, validators);
441                
442                if (!scripts)
443                {
444                    List<ScriptFile> backOfficeCSSFiles = _htmlEditorStyle.getBackOfficeCSSFiles(category, contextParameters);
445                    if (backOfficeCSSFiles != null)
446                    {
447                        files.addAll(backOfficeCSSFiles);
448                    }
449                }
450            }
451        }
452
453        return files;
454    }
455
456    private static void _addFilesForClientSideElements(boolean scripts, List<ScriptFile> files, Set<ClientSideElement> clientSideElmts)
457    {
458        if (clientSideElmts != null)
459        {
460            for (ClientSideElement convertor : clientSideElmts)
461            {
462                List<Script> scriptsToAdd = convertor.getScripts(Collections.EMPTY_MAP);
463                if (scriptsToAdd != null)
464                {
465                    for (Script script : scriptsToAdd)
466                    {
467                        List<ScriptFile> scriptFiles = scripts ? script.getScriptFiles() : script.getCSSFiles();
468                        if (scriptFiles != null)
469                        {
470                            files.addAll(scriptFiles);
471                        }
472                    }
473                }
474            }
475        }
476    }
477
478    private static void _addRichTextConfigurationFiles(Map<String, Map<String, String>> files, Map<String, String> filesInfos, String locale, boolean scripts)
479    {
480        Map<String, Object> contextParameters = new HashMap<>();
481        contextParameters.put("siteName", AmetysXSLTHelper.site());
482        
483        List<ScriptFile> richTextConfigurationFiles = _getRichTextConfigurationFiles(scripts, contextParameters);
484        for (ScriptFile file : richTextConfigurationFiles)
485        {
486            String uri = null;
487            if (file.isLangSpecific())
488            {
489                if (file.getLangPaths().containsKey(locale))
490                {
491                    uri = file.getLangPaths().get(locale);
492                }
493                else if (file.getLangPaths().containsKey(file.getDefaultLang()))
494                {
495                    uri = file.getLangPaths().get(file.getDefaultLang());
496                }
497            }
498            else
499            {
500                uri = file.getPath();
501            }
502            
503            if (uri != null)
504            {
505                files.put(uri, filesInfos);
506            }
507        }
508    }
509    /**
510     * Check if we can display the front edition button for a specific right
511     * Checks :
512     * * Rendering context == front
513     * * Edition mode
514     * * Front_Edition_Access_Right on current page
515     * * RightId available  on object
516     * @param rightId right to check (can be null)
517     * @param objectId id of page/content to check. Can be null or empty to get the current page
518     * @return true if all is OK, false if at least one is false
519     * @deprecated Use the version with three arguments
520     */
521    @Deprecated
522    public static boolean hasFrontEditionRight(String rightId, String objectId)
523    {
524        return hasFrontEditionRight(rightId, objectId, true);
525    }
526    /**
527     * Check if we can display the front edition button for a specific right
528     * Checks :
529     * * Rendering context == front
530     * * Edition mode
531     * * Front_Edition_Access_Right on current page
532     * * RightId available on object
533     * @param rightId right to check (can be null)
534     * @param objectId id of page/content to check. Can be null or empty to get the current page
535     * @param editionModeOnly Check if the user is in edition mode
536     * @return true if all is OK, false if at least one is false
537     */
538    public static boolean hasFrontEditionRight(String rightId, String objectId, boolean editionModeOnly)
539    {
540        String aoId = objectId;
541        if (StringUtils.isEmpty(aoId))
542        {
543            aoId = AmetysXSLTHelper.pageId();
544        }
545        
546        if (StringUtils.isEmpty(aoId)                                 // No page or content to check
547            || !RenderingContext.FRONT.toString().equals(AmetysXSLTHelper.renderingContext())     // We are no on front
548            || editionModeOnly && !AmetysXSLTHelper.isEditionMode()   // Not in edition mode
549            || !hasFrontEditionRight())                                 // The user has the front edition right on current page
550        {
551            
552            return false;
553        }
554        
555        Request request = ContextHelper.getRequest(_context);
556        
557        // Retrieve the current workspace.
558        String currentWsp = RequestAttributeWorkspaceSelector.getForcedWorkspace(request);
559        
560        try
561        {
562            // Force default workspace (rights have to be checked on default workspace)
563            // The target objectId can be a node page, available of front only when a first subpage will be created
564            RequestAttributeWorkspaceSelector.setForcedWorkspace(request, RepositoryConstants.DEFAULT_WORKSPACE);
565            
566            if (StringUtils.contains(aoId, ";"))
567            {
568                String[] pageIds = StringUtils.split(aoId, ";");
569                for (String pid : pageIds)
570                {
571                    if (_rightManager.currentUserHasRight(rightId, _ametysObjectResolver.resolveById(pid)) == RightResult.RIGHT_ALLOW)   // Check right on page (If this page does not exists an exception will be thrown... this is fine)
572                    {
573                        return true;
574                    }
575                    // else check the next one
576                }
577                return false; // No right inside the list
578            }
579            else
580            {
581                return StringUtils.isEmpty(rightId) // There is no right to check OR the user has the right
582                    || _rightManager.currentUserHasRight(rightId, _ametysObjectResolver.resolveById(aoId)) == RightResult.RIGHT_ALLOW;   // Check right on page (If this page does not exists an exception will be thrown... this is fine)
583            }
584        }
585        finally
586        {
587            // Restore workspace
588            RequestAttributeWorkspaceSelector.setForcedWorkspace(request, currentWsp);
589        }
590    }
591    
592    /**
593     * Check if current user has right on Ametys object for front edition
594     * Checks :
595     * * Rendering context == front
596     * * Edition mode
597     * * Front_Edition_Access_Right on current page
598     * * RightId available on object
599     * @param rightId right to check (can be null)
600     * @param ao The ametys object check. Cannot be null
601     * @param editionModeOnly Check if the user is in edition mode
602     * @return true if all is OK, false if at least one is false
603     */
604    public static boolean hasFrontEditionRight(String rightId, AmetysObject ao, boolean editionModeOnly)
605    {
606        if (!RenderingContext.FRONT.toString().equals(AmetysXSLTHelper.renderingContext())     // We are no on front
607            || editionModeOnly && !AmetysXSLTHelper.isEditionMode()   // Not in edition mode
608            || !hasFrontEditionRight())                                 // The user has the front edition right on current page
609        {
610            return false;
611        }
612        
613        Request request = ContextHelper.getRequest(_context);
614        
615        // Retrieve the current workspace.
616        String currentWsp = RequestAttributeWorkspaceSelector.getForcedWorkspace(request);
617        
618        try
619        {
620            // Force default workspace (rights have to be checked on default workspace)
621            // The target objectId can be a node page, available of front only when a first subpage will be created
622            RequestAttributeWorkspaceSelector.setForcedWorkspace(request, RepositoryConstants.DEFAULT_WORKSPACE);
623            
624            return StringUtils.isEmpty(rightId) // There is no right to check OR the user has the right
625                    || _rightManager.currentUserHasRight(rightId, ao) == RightResult.RIGHT_ALLOW;   // Check right on page (If this page does not exists an exception will be thrown... this is fine)
626        }
627        finally
628        {
629            // Restore workspace
630            RequestAttributeWorkspaceSelector.setForcedWorkspace(request, currentWsp);
631        }
632    }
633    
634    /**
635     * Check if the current user has the Front_Edition_Access_Right right
636     * @return true if right granted
637     */
638    public static boolean hasFrontEditionRight()
639    {
640        Request request = ContextHelper.getRequest(_context);
641        
642        // Retrieve the current workspace.
643        String currentWsp = RequestAttributeWorkspaceSelector.getForcedWorkspace(request);
644        
645        try
646        {
647            // Force default workspace (rights have to be checked on default workspace)
648            RequestAttributeWorkspaceSelector.setForcedWorkspace(request, RepositoryConstants.DEFAULT_WORKSPACE);
649            
650            String pageId = AmetysXSLTHelper.pageId();
651            if (StringUtils.isNotEmpty(pageId))
652            {
653                Page page = _ametysObjectResolver.resolveById(pageId);
654                return _rightManager.currentUserHasRight(FRONT_EDITION_RIGHT_ID, page) == RightResult.RIGHT_ALLOW;
655            }
656            
657            String lang = AmetysXSLTHelper.lang();
658            if (StringUtils.isEmpty(lang))
659            {
660                lang = (String) request.getAttribute("lang");
661            }
662            String siteName = AmetysXSLTHelper.site();
663            
664            if (StringUtils.isNotEmpty(siteName) && StringUtils.isNoneEmpty(lang))
665            {
666                Site site = _siteManager.getSite(siteName);
667                Sitemap sitemap = site.getSitemap(lang);
668                return _rightManager.currentUserHasRight(FRONT_EDITION_RIGHT_ID, sitemap) == RightResult.RIGHT_ALLOW;
669            }
670            
671            return false;
672        }
673        finally
674        {
675            // Restore workspace
676            RequestAttributeWorkspaceSelector.setForcedWorkspace(request, currentWsp);
677        }
678        
679        
680    }
681    /**
682     * Check if the current workflow action is available on this content
683     * @param actionId action to check
684     * @param contentId content to check
685     * @param checkEditionMode check also if we are in edition mode
686     * @return true if right is granted
687     */
688    public static boolean hasWorkflowRight(int actionId, String contentId, boolean checkEditionMode)
689    {
690        List<Integer> actionIds = new ArrayList<>();
691        actionIds.add(actionId);
692        return hasWorkflowRight(actionIds, contentId, checkEditionMode);
693    }
694    /**
695     * Check if a list of workflow actions are available on this content
696     * @param actionIds list of action ids
697     * @param contentId id of the content to check
698     * @param checkEditionMode check also if we are in edition mode
699     * @return true if all actions are available
700     */
701    public static boolean hasWorkflowRight(List<Integer> actionIds, String contentId, boolean checkEditionMode)
702    {
703        Content content = _ametysObjectResolver.resolveById(contentId);
704        return hasWorkflowRight(actionIds, content, checkEditionMode);
705    }
706    /**
707     * Check if a list of workflow actions are available on this content
708     * @param actionIds list of action ids
709     * @param content content to check
710     * @param checkEditionMode check also if we are in edition mode
711     * @return true if all actions are available
712     */
713    public static boolean hasWorkflowRight(List<Integer> actionIds, Content content, boolean checkEditionMode)
714    {
715        if (checkEditionMode)
716        {
717            boolean editionModeOk = AmetysXSLTHelper.isEditionMode();
718            if (!editionModeOk)
719            {
720                return false;
721            }
722        }
723        boolean result = false;
724        if (content instanceof WorkflowAwareContent)
725        {
726            WorkflowAwareContent wcontent = (WorkflowAwareContent) content;
727            int[] availableActions = _contentWorkflowHelper.getAvailableActions(wcontent);
728            for (int actionId : actionIds)
729            {
730                result = result || ArrayUtils.contains(availableActions, actionId);
731                if (result)
732                {
733                    break;
734                }
735            }
736        }
737        return result;
738    }
739    
740    /**
741     * Get the toolbar configuration for page: retrieve the user rights, the parent and page position
742     * @param pageId The page id
743     * @param addContentsConfigAsJson The items configuration for adding contents as JSON string
744     * @param editionModeOnly true to check edition mode
745     * @return the user's rights, parent and page position
746     * @throws UnknownAmetysObjectException if content is unknown
747     * @throws AmetysRepositoryException if an error occurred
748     * @throws RepositoryException if an error occurred
749     */
750    public static String getPageToolbarConfig(String pageId, String addContentsConfigAsJson, boolean editionModeOnly) throws UnknownAmetysObjectException, AmetysRepositoryException, RepositoryException
751    {
752        Map<String, Object> result = new HashMap<>();
753        
754        Page page = _ametysObjectResolver.resolveById(pageId);
755        SitemapElement parent = page.getParent();
756        long position = _getPagePosition(page);
757        
758        List<Object> addContentsConfig = _jsonUtils.convertJsonToList(addContentsConfigAsJson);
759        
760        @SuppressWarnings("unchecked")
761        Set<Object> allowedContentTypes = addContentsConfig.stream()
762            .filter(Map.class::isInstance)
763            .filter(cfg -> _hasContentCreationRight((Map) cfg))
764            .map(cfg -> (String) ((Map) cfg).get("contentType"))
765            .collect(Collectors.toSet());
766        result.put("allowedContentTypes", allowedContentTypes);
767        
768        result.put("title", page.getTitle());
769        result.put("parentId", parent.getId());
770        result.put("position", position);
771
772        // Get the active status for each action depending on user's rights, page position, FO edition mode, ...
773        result.put("actionStatus", _getActionStatusOnPage(page, position, parent.getChildrenPages().getSize(), editionModeOnly));
774        
775        return _jsonUtils.convertObjectToJson(result);
776    }
777    
778    private static boolean _hasContentCreationRight(Map<String, Object> config)
779    {
780        if (config.containsKey("contentType"))
781        {
782            String cTypeId = (String) config.get("contentType");
783            
784            ContentType contentType = _contentTypesEP.getExtension(cTypeId);
785            if (contentType == null)
786            {
787                _logger.warn("Unknown content type '" + cTypeId + "'");
788                return false;
789            }
790            
791            String right = contentType.getRight();
792            if (StringUtils.isEmpty(right))
793            {
794                return true;
795            }
796            
797            return _rightManager.currentUserHasRight(right, "/cms") == RightResult.RIGHT_ALLOW || _rightManager.currentUserHasRight(right, _rootContentHelper.getRootContent()) == RightResult.RIGHT_ALLOW;
798        }
799        else
800        {
801            _logger.warn("Configuration to add content is invalid: missing 'contentType'. It will be ignored");
802            return false;
803        }
804    }
805    
806    private static long _getPagePosition(Page page) throws AmetysRepositoryException
807    {
808        SitemapElement parent = page.getParent();
809        AmetysObjectIterable< ? extends Page> children = parent.getChildrenPages();
810        
811        long count = 1;
812        for (Page child : children)
813        {
814            if (child.getId().equals(page.getId()))
815            {
816                return count;
817            }
818            count++;
819        }
820        
821        // Not found
822        return -1;
823    }
824    
825    private static Map<String, Boolean> _getActionStatusOnPage(Page page, long position, long size, boolean editionModeOnly) throws UnknownAmetysObjectException, AmetysRepositoryException
826    {
827        Map<String, Boolean> rights = new HashMap<>();
828        
829        if (page instanceof ModifiablePage)
830        {
831            rights.put("add-content", hasFrontEditionRight("Web_Rights_Page_AddContent", page, editionModeOnly));
832            rights.put("add-page", hasFrontEditionRight("Web_Rights_Page_Create", page, editionModeOnly));
833            rights.put("tag", hasFrontEditionRight("Web_Rights_Page_Tag", page, editionModeOnly));
834            rights.put("rename", hasFrontEditionRight("Web_Rights_Page_Rename", page, editionModeOnly));
835            rights.put("schedule-publication", hasFrontEditionRight("Web_Rights_Page_Schedule", page, editionModeOnly));
836            rights.put("delete", hasFrontEditionRight("Web_Rights_Page_Delete", page, editionModeOnly));
837            
838            boolean canMove = hasFrontEditionRight("Web_Rights_Page_Create", page.getParent().getId(), editionModeOnly);
839            boolean moveUp = canMove && position > 1;
840            boolean moveDown = canMove && position < size;
841            
842            rights.put("move-up", moveUp);
843            rights.put("move-down", moveDown);
844            rights.put("move", moveDown || moveUp);
845        }
846        
847        return rights;
848    }
849    
850    /**
851     * Get the toolbar configuration for content: retrieve user rights, available workflow actions, content current step and status history
852     * @param contentId The content id
853     * @param zoneItemId The zone item id
854     * @param restrictedActions The actions ids to retrieve. Set to null or empty to get all available workflow actions with no restriction
855     * @param jsonStepConfig The step configuration
856     * @param locale the locale for translation
857     * @param editionModeOnly true to check edition mode
858     * @return the user's rights, available workflow actions and content current step
859     * @throws UnknownAmetysObjectException if content is unknown
860     * @throws AmetysRepositoryException if an error occurred
861     * @throws RepositoryException if an error occurred
862     */
863    public static String getContentToolbarConfig(String contentId, String zoneItemId, String restrictedActions, String jsonStepConfig, String locale, boolean editionModeOnly) throws UnknownAmetysObjectException, AmetysRepositoryException, RepositoryException
864    {
865        Map<String, Object> result = new HashMap<>();
866        
867        Content content = _ametysObjectResolver.resolveById(contentId);
868
869        // Get the active status of each action depending on user rights, FO mode, content's position, ...
870        result.put("actionStatus", _getActionStatusOnContent(content, zoneItemId, editionModeOnly));
871        
872        if (content instanceof WorkflowAwareContent)
873        {
874            WorkflowDescriptor workflowDescriptor = _getWorkflowDescriptor((WorkflowAwareContent) content);
875            
876            WorkflowAwareContent wcontent = (WorkflowAwareContent) content;
877            
878            Map<String, Object> step = new HashMap<>();
879            long currentStepId = wcontent.getCurrentStepId();
880            
881            // Current step
882            StepDescriptor stepDescriptor = _getStepDescriptor(workflowDescriptor, currentStepId);
883            step.put("id", currentStepId);
884            String name = stepDescriptor.getName();
885            step.put("label", new I18nizableText(StringUtils.substringBefore(name, ":"), StringUtils.substringAfter(name, ":")));
886            result.put("step", step);
887            
888            Map<String, Object> stepConfig = StringUtils.isEmpty(jsonStepConfig) ? null : _jsonUtils.convertJsonToMap(jsonStepConfig);
889            result.put("statusHistory", _getStatusHistory(wcontent, currentStepId, stepConfig, workflowDescriptor));
890            
891            List<Integer> availableActions = Arrays.stream(_contentWorkflowHelper.getAvailableActions(wcontent)).boxed().collect(Collectors.toList());
892            result.put("availableWorkflowActions", availableActions);
893            
894            if (!editionModeOnly || AmetysXSLTHelper.isEditionMode())
895            {
896                List<Object> restrictedActionsAsList = StringUtils.isEmpty(restrictedActions) ? null : _jsonUtils.convertJsonToList(restrictedActions);
897                
898                List<Object> restrictedActionIds = restrictedActionsAsList == null ? null : restrictedActionsAsList.stream()
899                    .map(o -> o instanceof Map ? ((Map) o).get("id") : o)
900                    .collect(Collectors.toList());
901                
902                @SuppressWarnings("unchecked")
903                Map<Object, Map<String, Object>> workflowActions = availableActions.stream()
904                    .filter(actionId -> restrictedActionIds == null || restrictedActionIds.contains(actionId))
905                    .map(actionId -> {
906                        Map<String, Object> wa = new HashMap<>();
907                        
908                        _addDefaultWorkflowActionProperties(wa, workflowDescriptor, actionId);
909                        
910                        if (restrictedActionIds != null && restrictedActionsAsList != null && restrictedActionIds.contains(actionId))
911                        {
912                            for (Object object : restrictedActionsAsList)
913                            {
914                                if (object instanceof Map && ((Map) object).get("id") == actionId)
915                                {
916                                    // get or override properties from map sent by client side
917                                    wa.putAll((Map<String, Object>) object);
918                                    break;
919                                }
920                            }
921                            
922                        }
923                        return Pair.of(actionId, wa);
924                    })
925                    .collect(Collectors.toMap(Pair::getLeft, Pair::getRight));
926                
927                result.put("workflowActions", workflowActions);
928            }
929        }
930        
931        Request request = ContextHelper.getRequest(_context);
932        try
933        {
934            request.setAttribute(I18nizableSerializer.REQUEST_ATTR_LOCALE, locale);
935            return _jsonUtils.convertObjectToJson(result);
936        }
937        finally
938        {
939            request.removeAttribute(I18nizableSerializer.REQUEST_ATTR_LOCALE);
940        }
941    }
942    
943    private static Map<String, Boolean> _getActionStatusOnContent(Content content, String zoneItemId, boolean editionModeOnly) throws UnknownAmetysObjectException, AmetysRepositoryException
944    {
945        Map<String, Boolean> rights = new HashMap<>();
946        
947        ZoneItem zoneItem = _ametysObjectResolver.resolveById(zoneItemId);
948        Zone zone = zoneItem.getZone();
949        SitemapElement sitemapElement = zone.getSitemapElement();
950        
951        rights.put("tag", hasFrontEditionRight("CMS_Rights_Content_Tag", content, editionModeOnly));
952        rights.put("remove", sitemapElement instanceof ModifiablePage && hasFrontEditionRight("Web_Rights_Page_DeleteZoneItem", sitemapElement, editionModeOnly));
953        rights.put("delete", hasFrontEditionRight("CMS_Rights_DeleteContent", content, editionModeOnly));
954        
955        boolean moveUp = false;
956        boolean moveDown = false;
957        
958        long position = getZoneItemPosition(zoneItem);
959        long size = getZoneSize(zone);
960        
961        if (position != -1 && sitemapElement instanceof ModifiablePage && hasFrontEditionRight("Web_Rights_Page_OrganizeZoneItem", sitemapElement, editionModeOnly))
962        {
963            if (position > 0)
964            {
965                moveUp = true;
966            }
967            
968            if (position + 1 < size)
969            {
970                moveDown = true;
971            }
972        }
973        rights.put("move-up", moveUp);
974        rights.put("move-down", moveDown);
975        rights.put("move", moveDown || moveUp);
976        
977        return rights;
978    }
979    
980    private static Map<Integer, Map<String, Object>> _getStatusHistory(WorkflowAwareContent content, long currentStepId, Map<String, Object> stepsConfig, WorkflowDescriptor workflowDescriptor)
981    {
982        List<Step> historyStatus = new ArrayList<>();
983            
984        if (stepsConfig.containsKey(String.valueOf(currentStepId)))
985        {
986            AmetysObjectWorkflow workflow = _workflowProvider.getAmetysObjectWorkflow(content);
987            
988            long workflowId = content.getWorkflowId();
989            List<Step> historySteps = workflow.getHistorySteps(workflowId);
990
991            // Sort by start date descendant
992            Collections.sort(historySteps, new Comparator<Step>()
993            {
994                public int compare(Step s1, Step s2)
995                {
996                    return -s1.getStartDate().compareTo(s2.getStartDate());
997                }
998            });
999            
1000            @SuppressWarnings("unchecked")
1001            Map<String, Object> currentStepCfg = (Map<String, Object>) stepsConfig.get(String.valueOf(currentStepId));
1002            String currentStepType = currentStepCfg != null ? (String) currentStepCfg.get("type") : null;
1003            
1004            boolean stop = false;
1005            for (Step step : historySteps)
1006            {
1007                if (stop)
1008                {
1009                    break;
1010                }
1011
1012                long stepId = step.getStepId();
1013                @SuppressWarnings("unchecked")
1014                Map<String, Object> stepCfg = (Map<String, Object>) stepsConfig.get(String.valueOf(stepId));
1015                String stepType = stepCfg != null ? (String) stepCfg.get("type") : null;
1016                
1017                stop = "positive".equals(currentStepType) && !"positive".equals(stepType)
1018                        || ("negative".equals(currentStepType) || "neutral".equals(currentStepType)) && !"negative".equals(stepType)
1019                        || currentStepId == stepId;
1020                
1021                if (!stop)
1022                {
1023                    historyStatus.add(step);
1024                }
1025            }
1026        }
1027        
1028        Map<Integer, Map<String, Object>> jsonHistoryStatus = new LinkedHashMap<>();
1029        for (Step step : historyStatus)
1030        {
1031            if (!jsonHistoryStatus.containsKey(step.getStepId()))
1032            {
1033                StepDescriptor stepDescriptor = _getStepDescriptor(workflowDescriptor, step.getStepId());
1034                String name = stepDescriptor.getName();
1035                I18nizableText label = new I18nizableText(StringUtils.substringBefore(name, ":"), StringUtils.substringAfter(name, ":"));
1036                jsonHistoryStatus.put(step.getStepId(), Map.of("label", label));
1037            }
1038        }
1039        
1040        return jsonHistoryStatus;
1041    }
1042    
1043    private static void _addDefaultWorkflowActionProperties(Map<String, Object> wa, WorkflowDescriptor workflowDescriptor, int actionId)
1044    {
1045        // Add workflow action label
1046        ActionDescriptor wAction = workflowDescriptor.getAction(actionId);
1047        String name = wAction.getName();
1048        wa.put("label", new I18nizableText(StringUtils.substringBefore(name, ":"), StringUtils.substringAfter(name, ":")));
1049        
1050        // Default workflow icon
1051        switch (actionId)
1052        {
1053            case 3:
1054                wa.put("icon", "fas fa-hand-point-up"); // Propose
1055                break;
1056            case 4:
1057                wa.put("icon", "fas fa-check"); // Validate
1058                break;
1059            case 7:
1060                wa.put("icon", "fas fa-times"); // Refuse
1061                break;
1062            case 10:
1063                wa.put("icon", "fas fa-ban"); // Unpublish
1064                break;
1065            default:
1066                break;
1067        }
1068    }
1069    
1070    private static WorkflowDescriptor _getWorkflowDescriptor(WorkflowAwareContent content)
1071    {
1072        long workflowId = content.getWorkflowId();
1073        
1074        AmetysObjectWorkflow workflow = _workflowProvider.getAmetysObjectWorkflow(content);
1075        
1076        String workflowName = workflow.getWorkflowName(workflowId);
1077        return workflow.getWorkflowDescriptor(workflowName);
1078    }
1079    
1080    private static StepDescriptor _getStepDescriptor(WorkflowDescriptor workflowDescriptor, long stepId)
1081    {
1082        if (workflowDescriptor != null)
1083        {
1084            StepDescriptor stepDescriptor = workflowDescriptor.getStep((int) stepId);
1085            if (stepDescriptor != null)
1086            {
1087                return stepDescriptor;
1088            }
1089        }
1090        
1091        return null;
1092    }
1093    
1094    /**
1095     * Get a string representing a json map of the contentIds with true/false if they can/can't be modified
1096     * @param actionId action to check
1097     * @param inputPageId page (can be null)
1098     * @param checkEditionMode check also if we are in edition mode
1099     * @return {contentId : true/false, ....}
1100     */
1101    public static String getModifiableContents(int actionId, String inputPageId, boolean checkEditionMode)
1102    {
1103        Map<String, Object> jsonObject = new HashMap<>();
1104        String pageId = inputPageId;
1105        if (StringUtils.isEmpty(inputPageId))
1106        {
1107            pageId = AmetysXSLTHelper.pageId();
1108        }
1109        
1110        if (!StringUtils.isEmpty(pageId))
1111        {
1112            AmetysObject resolveById = _ametysObjectResolver.resolveById(pageId);
1113            if (resolveById instanceof Page)
1114            {
1115                Page page = (Page) resolveById;
1116                List<Content> contents = _pageHelper.getAllContents(page);
1117                for (Content content : contents)
1118                {
1119                    Map<String, Object> contentInfo = new HashMap<>();
1120                    contentInfo.put("unmodifiableAttributes", AmetysFrontEditionHelper.getUnmodifiableAttributes(content, List.of(actionId), checkEditionMode));
1121                    contentInfo.put("rights", AmetysFrontEditionHelper.getRightsForContent(content));
1122                    
1123                    jsonObject.put(content.getId(), contentInfo);
1124                }
1125            }
1126        }
1127
1128        return _jsonUtils.convertObjectToJson(jsonObject);
1129    }
1130    
1131    /**
1132     * Get path of unmodifiable attributes. Check if content can be modified and the restrictions on attributes
1133     * @param content the content
1134     * @param actionIds the workflow action ids to check
1135     * @param checkEditionMode to check edition mode
1136     * @return the list with the path of unmodifiable attributes (regarding of restrictions) or null if the content cannot be modified
1137     */
1138    public static List<String> getUnmodifiableAttributes(Content content, List<Integer> actionIds, boolean checkEditionMode)
1139    {
1140        try
1141        {
1142            boolean hasWorkflowRight = hasWorkflowRight(actionIds, content, checkEditionMode);
1143            if (!hasWorkflowRight)
1144            {
1145                // content is not editable
1146                return null;
1147            }
1148            
1149            Collection<? extends ModelItem> modelItems = _contentTypesHelper.getModelItems(content.getTypes());
1150            List<AttributeDefinition> attributes = _getAttributeDefinitionsRecursively(modelItems);
1151            return attributes.stream()
1152                .filter(mi -> !mi.canWrite(content))
1153                .map(mi -> mi.getPath())
1154                .collect(Collectors.toList());
1155        }
1156        catch (IllegalArgumentException e)
1157        {
1158            _logger.error("Fail to get restricted model items for content " + content.getId(), e);
1159            return List.of();
1160        }
1161    }
1162    
1163    /**
1164     * Get a map of chosen rights for a content
1165     * @param content the content
1166     * @return the chosen rights for a content
1167     */
1168    public static Map<String, Object> getRightsForContent(Content content)
1169    {
1170        Map<String, Object> rights = new HashMap<>();
1171        rights.put("hasAddFileRight", _rightManager.currentUserHasRight(ExplorerResourcesDAO.RIGHTS_RESOURCE_ADD, content) == RightResult.RIGHT_ALLOW);
1172        return rights;
1173    }
1174    
1175    private static List<AttributeDefinition> _getAttributeDefinitionsRecursively(Collection<? extends ModelItem> modelItems)
1176    {
1177        List<AttributeDefinition> attributeDefs = new ArrayList<>();
1178        
1179        for (ModelItem modelItem : modelItems)
1180        {
1181            if (modelItem instanceof AttributeDefinition)
1182            {
1183                attributeDefs.add((AttributeDefinition) modelItem);
1184            }
1185            else if (modelItem instanceof ModelItemGroup)
1186            {
1187                attributeDefs.addAll(_getAttributeDefinitionsRecursively(((ModelItemGroup) modelItem).getModelItems()));
1188            }
1189        }
1190        
1191        return attributeDefs;
1192    }
1193    
1194    /**
1195     * Get the name of a workflow action
1196     * @param workflowName workflow name
1197     * @param actionId action id in the workflow
1198     * @return name of the workflow action
1199     */
1200    public static String getWorkflowName(String workflowName, int actionId)
1201    {
1202        String workflowNameKey = _workflowHelper.getActionName(workflowName, actionId);
1203        String translatedName = org.ametys.core.util.AmetysXSLTHelper.translate(workflowNameKey);
1204        return translatedName;
1205    }
1206    /**
1207     * Get the status (validated/draft) of all contents in a page
1208     * @param pageId id of the page to check
1209     * @return "" if not a page, "draft" if all contents are drafts, "validated" if all contents are validated, and "mixed" if there are both
1210     */
1211    public static String getPageStatus(String pageId)
1212    {
1213        boolean hasDraft = false;
1214        boolean hasValidated = false;
1215        AmetysObject resolveById = _ametysObjectResolver.resolveById(pageId);
1216        if (resolveById instanceof Page)
1217        {
1218            Page page = (Page) resolveById;
1219            List<Content> contents = _pageHelper.getAllContents(page);
1220            for (Content content : contents)
1221            {
1222                if (isContentLive(content))
1223                {
1224                    hasValidated = true;
1225                }
1226                else
1227                {
1228                    hasDraft = true;
1229                }
1230            }
1231            String result = "none";
1232            if (hasDraft && !hasValidated)
1233            {
1234                result = "draft";
1235            }
1236            else if (!hasDraft && hasValidated)
1237            {
1238                result = "validated";
1239            }
1240            else if (hasDraft && hasValidated)
1241            {
1242                result = "mixed";
1243            }
1244            return result;
1245        }
1246        else
1247        {
1248            return "";
1249        }
1250    }
1251
1252    /**
1253     * Get the workflow step id of a content
1254     * @param contentId id of the content
1255     * @return the step Id
1256     */
1257    public static long getContentWorkflowId(String contentId)
1258    {
1259        AmetysObject resolvedById = _ametysObjectResolver.resolveById(contentId);
1260        if (resolvedById instanceof Content)
1261        {
1262            Content content = (Content) resolvedById;
1263            return getContentWorkflowId(content);
1264        }
1265        else
1266        {
1267            return 0;
1268        }
1269    }
1270    /**
1271     * Get the workflow step id of a content
1272     * @param content content
1273     * @return the step Id
1274     */
1275    public static long getContentWorkflowId(Content content)
1276    {
1277        WorkflowAwareContent wContent = (WorkflowAwareContent) content;
1278        return wContent.getCurrentStepId();
1279    }
1280
1281    /**
1282     * check if a content is published ot not
1283     * @param contentId id of the content
1284     * @return "validated" or "draft", "" if not found
1285     */
1286    public static String getContentStatus(String contentId)
1287    {
1288        AmetysObject resolvedById = _ametysObjectResolver.resolveById(contentId);
1289        if (resolvedById instanceof Content)
1290        {
1291            Content content = (Content) resolvedById;
1292            return getContentStatus(content);
1293        }
1294        else
1295        {
1296            return "";
1297        }
1298    }
1299    /**
1300     * check if a content is published ot not
1301     * @param content content
1302     * @return "validated" or "draft"
1303     */
1304    public static String getContentStatus(Content content)
1305    {
1306        return isContentLive(content) ? "validated" : "draft";
1307    }
1308    /**
1309     * check if a content is published ot not
1310     * @param contentId id of the content
1311     * @return true if validated
1312     */
1313    public static boolean isContentLive(String contentId)
1314    {
1315        AmetysObject resolvedById = _ametysObjectResolver.resolveById(contentId);
1316        if (resolvedById instanceof Content)
1317        {
1318            Content content = (Content) resolvedById;
1319            return isContentLive(content);
1320        }
1321        else
1322        {
1323            return false;
1324        }
1325    }
1326    /**
1327     * check if a content is published ot not
1328     * @param content content
1329     * @return true if validated
1330     */
1331    public static boolean isContentLive(Content content)
1332    {
1333        return Arrays.asList(((VersionableAmetysObject) content).getLabels()).contains(CmsConstants.LIVE_LABEL);
1334    }
1335    /**
1336     * Get the position of this zoneItem in the zone, or -1 if not found
1337     * @param zoneItemId zoneitem to search
1338     * @return zero based position, -1 if not found
1339     * @throws UnknownAmetysObjectException If zone item is not found
1340     * @throws AmetysRepositoryException If an error occurred
1341     */
1342    public static long getZoneItemPosition(String zoneItemId) throws UnknownAmetysObjectException, AmetysRepositoryException
1343    {
1344        ZoneItem zoneItem = _ametysObjectResolver.resolveById(zoneItemId);
1345        return getZoneItemPosition(zoneItem);
1346    }
1347    
1348    /**
1349     * Get the position of this zoneItem in its parent zone, or -1 if not found
1350     * @param zoneItem zoneitem
1351     * @return zero based position, -1 if not found
1352     */
1353    public static long getZoneItemPosition(ZoneItem zoneItem)
1354    {
1355        AmetysObject parent = zoneItem.getParent();
1356        if (parent instanceof DefaultTraversableAmetysObject)
1357        {
1358            return ((DefaultTraversableAmetysObject) parent).getChildPosition(zoneItem);
1359        }
1360        return -1; // virtual page
1361    }
1362    
1363    /**
1364     * Return the size of a zone
1365     * @param zoneName zone name
1366     * @param pageId page Id
1367     * @return size of the zone (-1 if not found)
1368     */
1369    public static long getZoneSize(String zoneName, String pageId)
1370    {
1371        Page page = _ametysObjectResolver.resolveById(pageId);
1372        Zone zone = page.getZone(zoneName);
1373        return getZoneSize(zone);
1374    }
1375    
1376    /**
1377     * Return the size of a zone
1378     * @param zone the zone
1379     * @return size of the zone or -1 is zone is null
1380     */
1381    public static long getZoneSize(Zone zone)
1382    {
1383        if (zone != null)
1384        {
1385            return zone.getZoneItems().getSize();
1386        }
1387        return -1;
1388    }
1389    /**
1390     * Test if a page is modifiable
1391     * @param pageId id of the page to check
1392     * @return true if the page is modifiable, false otherwise
1393     */
1394    public static boolean isPageModifiable(String pageId)
1395    {
1396        try
1397        {
1398            AmetysObject resolveById = _ametysObjectResolver.resolveById(pageId);
1399            return resolveById instanceof ModifiablePage;
1400        }
1401        catch (AmetysRepositoryException e)
1402        {
1403            // Nothing, this is not a page
1404        }
1405        
1406        return false;
1407    }
1408    
1409    /**
1410     * Returns the ids of the pages tagged with the specified tag in default workspace
1411     * @param tag The tag id
1412     * @return Array of pages ids
1413     */
1414    public static NodeList findPagesIdsByTagInDefaultWorkspace(String tag)
1415    {
1416        return findPagesIdsByTagInDefaultWorkspace(tag, false);
1417    }
1418    
1419    /**
1420     * Returns the ids of the pages tagged with the specified tag  in default workspace
1421     * @param tag The tag id
1422     * @param checkReadAccess true to return only pages with read access for current user
1423     * @return Array of pages ids
1424     */
1425    public static NodeList findPagesIdsByTagInDefaultWorkspace(String tag, boolean checkReadAccess)
1426    {
1427        Request request = ContextHelper.getRequest(_context);
1428        
1429        // Retrieve the current workspace.
1430        String currentWsp = RequestAttributeWorkspaceSelector.getForcedWorkspace(request);
1431        
1432        try
1433        {
1434            // Force default workspace
1435            // The tagged page can be a node page, available of front only when a first subpage will be created
1436            RequestAttributeWorkspaceSelector.setForcedWorkspace(request, RepositoryConstants.DEFAULT_WORKSPACE);
1437            return AmetysXSLTHelper.findPagesIdsByTag(tag, checkReadAccess);
1438        }
1439        finally
1440        {
1441         // Restore workspace
1442            RequestAttributeWorkspaceSelector.setForcedWorkspace(request, currentWsp);
1443        }
1444    }
1445    /**
1446     * Returns the ids of the pages tagged with the specified tag in default workspace
1447     * @param sitename The site id
1448     * @param lang The language code
1449     * @param tag The tag id
1450     * @return Array of pages ids
1451     */
1452    public static NodeList findPagesIdsByTagInDefaultWorkspace(String sitename, String lang, String tag)
1453    {
1454        return findPagesIdsByTagInDefaultWorkspace(sitename, lang, tag, false);
1455    }
1456    
1457    /**
1458     * Returns the ids of the pages tagged with the specified tag in default workspace
1459     * @param sitename The site id
1460     * @param lang The language code
1461     * @param tag The tag id
1462     * @param checkReadAccess true to return only pages with read access for current user
1463     * @return Array of pages ids
1464     */
1465    public static NodeList findPagesIdsByTagInDefaultWorkspace(String sitename, String lang, String tag, boolean checkReadAccess)
1466    {
1467        Request request = ContextHelper.getRequest(_context);
1468        
1469        // Retrieve the current workspace.
1470        String currentWsp = RequestAttributeWorkspaceSelector.getForcedWorkspace(request);
1471        
1472        try
1473        {
1474            // Force default workspace
1475            // The tagged page can be a node page, available of front only when a first subpage will be created
1476            RequestAttributeWorkspaceSelector.setForcedWorkspace(request, RepositoryConstants.DEFAULT_WORKSPACE);
1477            return AmetysXSLTHelper.findPagesIdsByTag(sitename, lang, tag, checkReadAccess);
1478        }
1479        finally
1480        {
1481         // Restore workspace
1482            RequestAttributeWorkspaceSelector.setForcedWorkspace(request, currentWsp);
1483        }
1484    }
1485}