001/*
002 * (C) Copyright 2018 Nuxeo (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 *     Guillaume Renard <grenard@nuxeo.com>
018 */
019package org.nuxeo.ecm.automation.core.operations.document;
020
021import static javax.servlet.http.HttpServletResponse.SC_FORBIDDEN;
022
023import org.nuxeo.ecm.automation.core.Constants;
024import org.nuxeo.ecm.automation.core.annotations.Context;
025import org.nuxeo.ecm.automation.core.annotations.Operation;
026import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
027import org.nuxeo.ecm.automation.core.collectors.DocumentModelCollector;
028import org.nuxeo.ecm.core.api.CoreSession;
029import org.nuxeo.ecm.core.api.DocumentModel;
030import org.nuxeo.ecm.core.api.NuxeoException;
031import org.nuxeo.ecm.core.api.trash.TrashService;
032
033/**
034 * @since 10.1
035 */
036@Operation(id = UntrashDocument.ID, category = Constants.CAT_DOCUMENT, label = "Untrash", description = "Undeletes documents (and ancestors if needed to make them visible)..")
037public class UntrashDocument {
038
039    public static final String ID = "Document.Untrash";
040
041    @Context
042    protected CoreSession session;
043
044    @Context
045    protected TrashService trashService;
046
047    @OperationMethod(collector = DocumentModelCollector.class)
048    public DocumentModel run(DocumentModel doc) {
049        if (trashService.canPurgeOrUntrash(doc, session.getPrincipal())) {
050            trashService.untrashDocument(doc);
051            return session.getDocument(doc.getRef());
052        } else {
053            throw new NuxeoException("Cannot untrash these documents", SC_FORBIDDEN);
054        }
055    }
056
057}