libKonogonka/src/main/java/libKonogonka/Tools/XCI/HFS0Provider.java

/*
    Copyright 2019-2020 Dmitry Isaenko

    This file is part of Konogonka.

    Konogonka is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Konogonka is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Konogonka.  If not, see <https://www.gnu.org/licenses/>.
*/
package libKonogonka.Tools.XCI;

import libKonogonka.Tools.ISuperProvider;

import java.io.*;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;

import static libKonogonka.LoperConverter.*;

/**
 * HFS0
 * */
public class HFS0Provider implements ISuperProvider {

    private boolean magicHFS0;
    private int filesCnt;
    private boolean paddingHfs0;
    private int stringTableSize;
    private long rawFileDataStart;

    private HFS0File[] hfs0Files;

    private File file;

    HFS0Provider(long hfsOffsetPosition, RandomAccessFile raf, File file) throws Exception{
        this.file = file;    // Will be used @ getHfs0FilePipedInpStream. It's a bad implementation.
        byte[] hfs0bytes = new byte[16];
        try{
            raf.seek(hfsOffsetPosition);
            if (raf.read(hfs0bytes) != 16){
                throw new Exception("Read HFS0 structure failure. Can't read first 16 bytes on requested offset.");
            }
        }
        catch (IOException ioe){
            throw new Exception("Read HFS0 structure failure. Can't read first 16 bytes on requested offset: "+ioe.getMessage());
        }
        magicHFS0 = Arrays.equals(Arrays.copyOfRange(hfs0bytes, 0, 4),new byte[]{0x48, 0x46, 0x53, 0x30});
        filesCnt = getLEint(hfs0bytes, 0x4);
        stringTableSize = getLEint(hfs0bytes, 8);
        paddingHfs0 = Arrays.equals(Arrays.copyOfRange(hfs0bytes, 12, 16),new byte[4]);

        hfs0Files = new HFS0File[filesCnt];

        // TODO: IF NOT EMPTY TABLE:

        long[] offsetHfs0files = new long[filesCnt];
        long[] sizeHfs0files = new long[filesCnt];
        int[] hashedRegionSizeHfs0Files = new int[filesCnt];
        boolean[] paddingHfs0Files = new boolean[filesCnt];
        byte[][] SHA256HashHfs0Files = new byte[filesCnt][];
        int[] strTableOffsets = new int[filesCnt];

        try {
            // Populate meta information regarding each file inside (?) HFS0
            byte[] metaInfoBytes = new byte[64];
            for (int i=0; i < filesCnt; i++){
                if (raf.read(metaInfoBytes) != 64) {
                    throw new Exception("Read HFS0 File Entry Table failure for file # "+i);
                }
                offsetHfs0files[i] = getLElong(metaInfoBytes, 0);
                sizeHfs0files[i] = getLElong(metaInfoBytes, 8);
                hashedRegionSizeHfs0Files[i] = getLEint(metaInfoBytes, 20);
                paddingHfs0Files[i] = Arrays.equals(Arrays.copyOfRange(metaInfoBytes, 24, 32), new byte[8]);
                SHA256HashHfs0Files[i] = Arrays.copyOfRange(metaInfoBytes, 32, 64);

                strTableOffsets[i] = getLEint(metaInfoBytes, 16);
            }
            // Define location of actual data for this HFS0
            rawFileDataStart = raf.getFilePointer()+stringTableSize;
            if (stringTableSize <= 0)
                throw new Exception("String table size of HFS0 less or equal to zero");
            byte[] stringTbl = new byte[stringTableSize];
            if (raf.read(stringTbl) != stringTableSize){
                throw new Exception("Read HFS0 String table failure. Can't read requested string table size ("+stringTableSize+")");
            }
            String[] namesHfs0files = new String[filesCnt];
            // Parse string table
            for (int i=0; i < filesCnt; i++){
                int j = 0;
                while (stringTbl[strTableOffsets[i]+j] != (byte)0x00)
                    j++;
                namesHfs0files[i] = new String(stringTbl, strTableOffsets[i], j, StandardCharsets.UTF_8);
            }
            //----------------------------------------------------------------------------------------------------------
            // Set files
            for (int i=0; i < filesCnt; i++){
                hfs0Files[i] = new HFS0File(
                        namesHfs0files[i],
                        offsetHfs0files[i],
                        sizeHfs0files[i],
                        hashedRegionSizeHfs0Files[i],
                        paddingHfs0Files[i],
                        SHA256HashHfs0Files[i]
                );
            }
        }
        catch (IOException ioe){
            throw new Exception("Read HFS0 structure failure: "+ioe.getMessage());
        }
    }

    public boolean isMagicHFS0() { return magicHFS0; }
    public int getFilesCnt() { return filesCnt; }
    public boolean isPaddingHfs0() { return paddingHfs0; }
    public int getStringTableSize() { return stringTableSize; }
    @Override
    public long getRawFileDataStart() { return rawFileDataStart; }
    public HFS0File[] getHfs0Files() { return hfs0Files; }
    @Override
    public File getFile(){ return file; }
    @Override
    public PipedInputStream getProviderSubFilePipedInpStream(int subFileNumber) throws Exception{
        PipedOutputStream streamOut = new PipedOutputStream();
        Thread workerThread;
        if (subFileNumber >= hfs0Files.length) {
            throw new Exception("HFS0Provider -> getHfs0FilePipedInpStream(): Requested sub file doesn't exists");
        }
        PipedInputStream streamIn = new PipedInputStream(streamOut);

        workerThread = new Thread(() -> {
            System.out.println("HFS0Provider -> getHfs0FilePipedInpStream(): Executing thread");
            try{
                long subFileRealPosition = rawFileDataStart + hfs0Files[subFileNumber].getOffset();
                BufferedInputStream bis = new BufferedInputStream(new FileInputStream(file));
                if (bis.skip(subFileRealPosition) != subFileRealPosition) {
                    System.out.println("HFS0Provider -> getHfs0FilePipedInpStream(): Unable to skip requested offset");
                    return;
                }

                int readPice = 8388608; // 8mb NOTE: consider switching to 1mb 1048576

                long readFrom = 0;
                long realFileSize = hfs0Files[subFileNumber].getSize();

                byte[] readBuf;

                while (readFrom < realFileSize){
                    if (realFileSize - readFrom < readPice)
                        readPice = Math.toIntExact(realFileSize - readFrom);    // it's safe, I guarantee
                    readBuf = new byte[readPice];
                    if (bis.read(readBuf) != readPice) {
                        System.out.println("HFS0Provider -> getHfs0FilePipedInpStream(): Unable to read requested size from file.");
                        return;
                    }
                    streamOut.write(readBuf, 0, readPice);
                    readFrom += readPice;
                }
                bis.close();
                streamOut.close();
            }
            catch (IOException ioe){
                System.out.println("HFS0Provider -> getHfs0FilePipedInpStream(): Unable to provide stream");
                ioe.printStackTrace();
            }
            System.out.println("HFS0Provider -> getHfs0FilePipedInpStream(): Thread died");
        });
        workerThread.start();
        return streamIn;
    }
    /**
     * Sugar
     * */
    @Override
    public PipedInputStream getProviderSubFilePipedInpStream(String subFileName) throws Exception {
        for (int i = 0; i < hfs0Files.length; i++){
            if (hfs0Files[i].getName().equals(subFileName))
                return getProviderSubFilePipedInpStream(i);
        }
        return null;
    }
}