001/*
002 * (C) Copyright 2006-2017 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 *     Nuxeo - initial API and implementation
018 */
019package org.nuxeo.ecm.core.io.impl;
020
021import java.io.IOException;
022import java.util.ArrayList;
023import java.util.List;
024
025import org.nuxeo.ecm.core.io.DocumentPipe;
026import org.nuxeo.ecm.core.io.DocumentReader;
027import org.nuxeo.ecm.core.io.DocumentTransformer;
028import org.nuxeo.ecm.core.io.DocumentTranslationMap;
029import org.nuxeo.ecm.core.io.DocumentWriter;
030import org.nuxeo.ecm.core.io.ExportedDocument;
031import org.nuxeo.ecm.core.io.impl.transformers.PropertyDeprecationRemover;
032import org.nuxeo.runtime.api.Framework;
033
034/**
035 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
036 */
037public class DocumentPipeImpl implements DocumentPipe {
038
039    private final List<DocumentTransformer> transformers;
040
041    private final int pageSize;
042
043    private DocumentReader reader;
044
045    private DocumentWriter writer;
046
047    public DocumentPipeImpl(int pageSize) {
048        this.pageSize = pageSize;
049        this.transformers = new ArrayList<>();
050        this.transformers.add(new PropertyDeprecationRemover());
051    }
052
053    public DocumentPipeImpl() {
054        this(0);
055    }
056
057    @Override
058    public void addTransformer(DocumentTransformer transformer) {
059        transformers.add(transformer);
060    }
061
062    @Override
063    public DocumentReader getReader() {
064        return reader;
065    }
066
067    @Override
068    public List<DocumentTransformer> getTransformers() {
069        return transformers;
070    }
071
072    @Override
073    public DocumentWriter getWriter() {
074        return writer;
075    }
076
077    @Override
078    public void removeTransformer(DocumentTransformer transformer) {
079        transformers.remove(transformer);
080    }
081
082    @Override
083    public void setReader(DocumentReader reader) {
084        this.reader = reader;
085    }
086
087    @Override
088    public void setWriter(DocumentWriter writer) {
089        this.writer = writer;
090    }
091
092    @Override
093    public DocumentTranslationMap run() throws IOException {
094        if (reader == null) {
095            throw new IllegalArgumentException("Pipe reader cannot be null");
096        }
097        if (writer == null) {
098            throw new IllegalArgumentException("Pipe writer cannot be null");
099        }
100
101        List<DocumentTranslationMap> maps = new ArrayList<>();
102        // do with privilege to be able to set secure properties
103        Framework.doPrivilegedThrowing(() -> readAndWriteDocs(maps));
104        return DocumentTranslationMapImpl.merge(maps);
105    }
106
107    protected void handleBatchEnd() {
108        // NOP
109    }
110
111    protected void readAndWriteDocs(List<DocumentTranslationMap> maps) throws IOException {
112        if (pageSize == 0) {
113            // handle single doc case
114            ExportedDocument doc;
115            while ((doc = reader.read()) != null) {
116                applyTransforms(doc);
117                DocumentTranslationMap map = writer.write(doc);
118                maps.add(map);
119                handleBatchEnd();
120            }
121
122        } else {
123            // handle multiple doc case
124            ExportedDocument[] docs;
125            while ((docs = reader.read(pageSize)) != null) {
126                if (docs.length != 0) {
127                    applyTransforms(docs);
128                    DocumentTranslationMap map = writer.write(docs);
129                    if (map != null) {
130                        maps.add(map);
131                    }
132                    handleBatchEnd();
133                }
134            }
135        }
136    }
137
138    public void applyTransforms(ExportedDocument doc) throws IOException {
139        for (DocumentTransformer tr : transformers) {
140            tr.transform(doc);
141        }
142    }
143
144    public void applyTransforms(ExportedDocument[] docs) throws IOException {
145        for (DocumentTransformer tr : transformers) {
146            for (ExportedDocument doc : docs) {
147                tr.transform(doc);
148            }
149        }
150    }
151
152}