indexer/util/StreamUtils.java

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * See LICENSE.txt included in this distribution for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at LICENSE.txt.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright (c) 2017, 2021, Oracle and/or its affiliates. All rights reserved.
 * Portions Copyright (c) 2018, 2021, Chris Fraire <cfraire@me.com>.
 */
package org.opengrok.indexer.util;

import org.opengrok.indexer.analysis.CtagsReader;
import org.opengrok.indexer.analysis.Definitions;
import org.opengrok.indexer.analysis.StreamSource;
import java.io.BufferedInputStream;
import java.io.BufferedReader;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.List;

import static org.junit.jupiter.api.Assertions.assertNotNull;

/**
 * Represents a container for stream utility methods.
 */
public class StreamUtils {
    /**
     * Read a stream fully to an in-memory byte array.
     * @param iss a defined stream at the chosen starting position
     * @return a defined instance
     * @throws IOException if I/O fails
     */
    public static byte[] copyStream(InputStream iss) throws IOException {

        ByteArrayOutputStream baosExp = new ByteArrayOutputStream();
        byte[] buffer = new byte[8192];
        int read;
        do {
            read = iss.read(buffer, 0, buffer.length);
            if (read > 0) {
                baosExp.write(buffer, 0, read);
            }
        } while (read >= 0);

        baosExp.close();
        return baosExp.toByteArray();
    }

    /**
     * Read all bytes from the specified reader.
     * @param in a required instance
     * @return a defined instance
     * @throws IOException thrown if I/O error occurs while reading
     */
    public static String readToEnd(Reader in) throws IOException {

        StringBuilder result = new StringBuilder();
        char[] buf = new char[8 * 1024];
        int charsRead;
        while ((charsRead = in.read(buf, 0, buf.length)) != -1) {
            result.append(buf, 0, charsRead);
        }

        return result.toString();
    }

    public static Definitions readTagsFromResource(String resourceName)
            throws IOException {
        return readTagsFromResource(resourceName, null);
    }

    public static Definitions readTagsFromResource(String tagsResourceName,
            String rawResourceName) throws IOException {
        return readTagsFromResource(tagsResourceName, rawResourceName, 0);
    }

    public static Definitions readTagsFromResource(String tagsResourceName,
        String rawResourceName, int tabSize) throws IOException {

        InputStream res = StreamUtils.class.getClassLoader().
            getResourceAsStream(tagsResourceName);
        assertNotNull(res, tagsResourceName + " as resource");

        BufferedReader in = new BufferedReader(new InputStreamReader(
            res, StandardCharsets.UTF_8));

        CtagsReader rdr = new CtagsReader();
        rdr.setTabSize(tabSize);
        if (rawResourceName != null) {
            rdr.setSplitterSupplier(() -> {
                /*
                 * This should return truly raw content, as the CtagsReader will
                 * expand tabs according to its setting.
                 */
                SourceSplitter splitter = new SourceSplitter();
                StreamSource src = sourceFromEmbedded(rawResourceName);
                try {
                    splitter.reset(src);
                } catch (IOException ex) {
                    System.err.println(ex.toString());
                    return null;
                }
                return splitter;
            });
        }

        String line;
        while ((line = in.readLine()) != null) {
            rdr.readLine(line);
        }
        return rdr.getDefinitions();
    }

    /**
     * Gets a {@link Reader} from a specified resource name or raises an
     * assertion error if no defined stream is available.
     * @param resourceName a required name
     * @return a defined instance
     * @throws IOException thrown on I/O error
     */
    public static Reader readerFromResource(String resourceName)
            throws IOException {

        InputStream res = StreamUtils.class.getClassLoader().
                getResourceAsStream(resourceName);
        assertNotNull(res, resourceName + " should be gettable");
        return IOUtils.createBOMStrippedReader(res, StandardCharsets.UTF_8.name());
    }

    /**
     * Creates a {@code StreamSource} instance that reads data from an
     * embedded resource.
     * @param resourceName a required resource name
     * @return a stream source that reads from {@code name}
     */
    public static StreamSource sourceFromEmbedded(String resourceName) {
        return new StreamSource() {
            @Override
            public InputStream getStream() {
                InputStream res = StreamUtils.class.getClassLoader().
                    getResourceAsStream(resourceName);
                assertNotNull(res, "resource " + resourceName);
                return new BufferedInputStream(res);
            }
        };
    }

    /**
     * Parses symbols, one per line (trimmed), from a resource stream, but
     * recognizing a hash character {@code '#'} as starting a line comment that
     * is not included in a symbol.
     * @return a defined instance
     */
    public static List<String> readSampleSymbols(InputStream symbolsResource) throws IOException {
        List<String> result = new ArrayList<>();
        try (BufferedReader rdr = new BufferedReader(new InputStreamReader(symbolsResource,
                StandardCharsets.UTF_8))) {
            String line;
            while ((line = rdr.readLine()) != null) {
                int hashOffset = line.indexOf('#');
                if (hashOffset != -1) {
                    line = line.substring(0, hashOffset);
                }
                result.add(line.trim());
            }
        }
        return result;
    }

    // private to enforce static
    private StreamUtils() {
    }
}