001/*
002 * (C) Copyright 2006-2013 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 *
016 * Contributors:
017 *     Benjamin JALON <bjalon@nuxeo.com>
018 */
019package org.nuxeo.ecm.automation.core.operations.document;
020
021import org.nuxeo.ecm.automation.core.Constants;
022import org.nuxeo.ecm.automation.core.annotations.Context;
023import org.nuxeo.ecm.automation.core.annotations.Operation;
024import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
025import org.nuxeo.ecm.automation.core.collectors.DocumentModelCollector;
026import org.nuxeo.ecm.core.api.CoreSession;
027import org.nuxeo.ecm.core.api.DocumentModel;
028
029/**
030 * @author <a href="mailto:bjalon@nuxeo.com">Benjamin JALON</a>
031 * @since 5.7
032 */
033@Operation(id = GetLiveDocument.ID, category = Constants.CAT_DOCUMENT, label = "Get Live Document", description = "Get the live document even if this is a Proxy or Version Document.", aliases = { "GetLiveDocument" })
034public class GetLiveDocument {
035
036    public static final String ID = "Proxy.GetSourceDocument";
037
038    private static int MAX_ITERATION = 5;
039
040    @Context
041    protected CoreSession session;
042
043    @OperationMethod(collector = DocumentModelCollector.class)
044    public DocumentModel run(DocumentModel input) {
045        DocumentModel doc = session.getSourceDocument(input.getRef());
046        for (int i = 0; i < MAX_ITERATION && !isLive(doc); i++) {
047            doc = session.getSourceDocument(doc.getRef());
048        }
049
050        return doc;
051    }
052
053    private boolean isLive(DocumentModel doc) {
054        return !doc.isVersion() && !doc.isProxy();
055    }
056
057}