001/*
002 * (C) Copyright 2012 Nuxeo SA (http://nuxeo.com/) and others.
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 * Contributors:
016 * Nuxeo - initial API and implementation
017 */
018
019package org.nuxeo.ecm.platform.rendition.action;
020
021import java.io.Serializable;
022import java.util.ArrayList;
023import java.util.Arrays;
024import java.util.List;
025
026import javax.faces.context.FacesContext;
027import javax.servlet.http.HttpServletRequest;
028
029import org.apache.commons.lang.StringUtils;
030import org.jboss.seam.ScopeType;
031import org.jboss.seam.annotations.Factory;
032import org.jboss.seam.annotations.In;
033import org.jboss.seam.annotations.Name;
034import org.jboss.seam.annotations.Scope;
035import org.nuxeo.ecm.core.api.CoreSession;
036import org.nuxeo.ecm.core.api.DocumentModel;
037import org.nuxeo.ecm.core.api.IdRef;
038import org.nuxeo.ecm.platform.rendition.Constants;
039import org.nuxeo.ecm.platform.rendition.Rendition;
040import org.nuxeo.ecm.platform.rendition.service.RenditionDefinition;
041import org.nuxeo.ecm.platform.rendition.service.RenditionService;
042import org.nuxeo.ecm.platform.ui.web.api.NavigationContext;
043import org.nuxeo.ecm.platform.ui.web.util.BaseURL;
044import org.nuxeo.runtime.api.Framework;
045
046/**
047 * Seam bean used to hold Factory used by summary widget
048 *
049 * @author <a href="mailto:tdelprat@nuxeo.com">Tiry</a>
050 */
051@Name("renditionAction")
052@Scope(ScopeType.PAGE)
053public class RenditionActionBean implements Serializable {
054
055    private static final long serialVersionUID = 1L;
056
057    public static final String RENDITION_REST_URL_FORMAT = "%sapi/v1/id/%s/@rendition/%s";
058
059    @In(create = true)
060    protected transient NavigationContext navigationContext;
061
062    @In(create = true, required = false)
063    protected transient CoreSession documentManager;
064
065    @Factory(value = "currentDocumentRenditions", scope = ScopeType.EVENT)
066    public List<Rendition> getCurrentDocumentRenditions() throws Exception {
067        DocumentModel doc = navigationContext.getCurrentDocument();
068        RenditionService rs = Framework.getLocalService(RenditionService.class);
069        return rs.getAvailableRenditions(doc);
070    }
071
072    @Factory(value = "currentDocumentVisibleRenditionDefinitions", scope = ScopeType.EVENT)
073    public List<RenditionDefinition> getVisibleRenditionDefinitions() throws Exception {
074
075        List<RenditionDefinition> result = new ArrayList<>();
076        DocumentModel doc = navigationContext.getCurrentDocument();
077        RenditionService rs = Framework.getLocalService(RenditionService.class);
078        for (RenditionDefinition rd : rs.getAvailableRenditionDefinitions(doc)) {
079            if (rd.isVisible()) {
080                result.add(rd);
081            }
082        }
083        return result;
084    }
085
086    /**
087     * @since 7.3
088     */
089    public List<Rendition> getVisibleRenditions(String excludedKinds) {
090        DocumentModel doc = navigationContext.getCurrentDocument();
091        RenditionService rs = Framework.getLocalService(RenditionService.class);
092        List<Rendition> availableRenditions = rs.getAvailableRenditions(doc, true);
093
094        List<Rendition> filteredRenditions = availableRenditions;
095        if (StringUtils.isNotBlank(excludedKinds)) {
096            filteredRenditions = new ArrayList<>();
097            List<String> excludedKindList = Arrays.asList(excludedKinds.split(","));
098            for (Rendition rendition : availableRenditions) {
099                if (!excludedKindList.contains(rendition.getKind())) {
100                    filteredRenditions.add(rendition);
101                }
102            }
103        }
104        return filteredRenditions;
105    }
106
107    public boolean hasVisibleRenditions(String excludedKinds) {
108        return !getVisibleRenditions(excludedKinds).isEmpty();
109    }
110
111    /**
112     * @since 7.3
113     */
114    public String getRenditionURL(String renditionName) {
115        return getRenditionURL(navigationContext.getCurrentDocument(), renditionName);
116    }
117
118    /**
119     * @since 7.3
120     */
121    public String getRenditionURL(DocumentModel doc, String renditionName) {
122        FacesContext context = FacesContext.getCurrentInstance();
123        HttpServletRequest request = (HttpServletRequest) context.getExternalContext().getRequest();
124        return String.format(RENDITION_REST_URL_FORMAT, BaseURL.getBaseURL(request), doc.getId(), renditionName);
125    }
126
127    /**
128     * @since 8.3
129     */
130    public DocumentModel getRenditionSourceDocumentModel(DocumentModel doc) {
131        String id = (String) doc.getPropertyValue(Constants.RENDITION_SOURCE_VERSIONABLE_ID_PROPERTY);
132        if (id == null) {
133            id = (String) doc.getPropertyValue(Constants.RENDITION_SOURCE_ID_PROPERTY);
134        }
135        return documentManager.getDocument(new IdRef(id));
136    }
137
138}