package Torello.Java.Build;

import Torello.Java.ReadOnly.ReadOnlyList;

import Torello.Java.Shell;
import Torello.Java.GSUTIL;
import Torello.Java.OSResponse;
import Torello.Java.OSExtras;
import Torello.Java.StringParse;

import Torello.Java.Additional.BiAppendable;
import Torello.Java.Additional.AppendableSafe;

import static Torello.Java.C.BYELLOW;
import static Torello.Java.C.BGREEN;
import static Torello.Java.C.RESET;

import java.io.File;
import java.io.IOException;
import java.util.Vector;
import java.util.stream.Stream;

/**
 * This is the fifth Build-Stage, and it is part of the synchronization of a project with Google
 * Cloud Platform Stroage Buckets.  This class relies heavily on the GCP Shell-Command
 * {@code 'gsutil'} and it's Java implementation - {@link GSUTIL Torello.Java.GSUTIL}.
 * 
 * <BR /><BR />This class' synchronization-efforts entail copying the File-System's Java-Doc
 * Directory-Contents onto the (User-Specified) Google Cloud Server Storage-Bucket.
 * 
 * <EMBED CLASS='external-html' DATA-FILE-ID=S05_SYNC_JAVADOC>
 */
@Torello.JavaDoc.StaticFunctional
public class S05_SyncJavaDoc
{
    // Completely irrelevant, and the 'private' modifier keeps it off of JavaDoc
    private S05_SyncJavaDoc() { }

    private static final String FS = java.io.File.separator;


    // ********************************************************************************************
    // ********************************************************************************************
    // Copies entire 'javadoc/' directory-tree to GCS
    // ********************************************************************************************
    // ********************************************************************************************


    public static void sync(Builder builder) throws IOException
    {
        builder.timers.startStage05();
        Printing.startStep(5);

        OSResponse      osr     = null;
        StringBuilder   logOnly = new StringBuilder();

        final AppendableSafe logAndScreen = new AppendableSafe(
            new BiAppendable(System.out, logOnly),
            AppendableSafe.USE_APPENDABLE_ERROR
        );

        // Uses Shell-Contructor:
        // (outputAppendable, commandStrAppendable, standardOutput, errorOutput)

        // GSUTIL gsutil = new GSUTIL(logOnly, logAndScreen, null, null);
        builder.cloudSync.initStage05(logOnly, logAndScreen);
        Shell shell = new Shell(logOnly, logAndScreen, null, null);

        if (! builder.cli.SKIP_REMOVE_GCS_FILES)
        {
            // osr = gsutil.RM(builder.cli.GCS_DIR + "javadoc/" + "**");
            osr = builder.cloudSync.removeCloudJavaDocDir();
            Util.HALT_ON_ERROR(osr);
            Printing.PLS(logOnly, false);
        }

        // TRICKY !!! Do not use 'GCS_JAVADOC_DIR' here - because then it will be
        // 'javadoc/javadoc/!!!

        // osr = gsutil.CP(builder.LOCAL_JAVADOC_DIR, builder.cli.GCS_DIR, "-r");
        osr = builder.cloudSync.copyJavaDocDirToCloudDir();
        Util.HALT_ON_ERROR(osr);
        Printing.PLS(logOnly, false);

        osr = shell.RM(builder.LOCAL_JAVADOC_DIR, "-r");
        Util.HALT_ON_ERROR(osr);
        Printing.PLS(logOnly, false);

        if (builder.RUN_MAKE_PUBLIC)
        {
            Printing.PLS(logOnly, false);
            // osr = gsutil.MP(builder.cli.GCS_DIR + "javadoc/**");
            osr = builder.cloudSync.makePublicJavaDocDir();
            Util.HALT_ON_ERROR(osr);
        }

        builder.logs.write_S05_LOG(logOnly.toString());
        builder.cloudSync.endStage05();
        builder.timers.endStage05();
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Copies only selected packages of the Java-Doc Directory to GCS
    // ********************************************************************************************
    // ********************************************************************************************


    static void syncPart(Builder builder) throws IOException
    {
        builder.timers.startStage05();
        Printing.startStep(5);

        ReadOnlyList<BuildPackage> packageSyncList;

        if (builder.cli.userSpecifiedPackages != null)
        {
            packageSyncList = builder.cli.userSpecifiedPackages;

            for (BuildPackage bp : packageSyncList) if (! bp.mustDocument)
                throw new IllegalArgumentException("Not allowd to document: " + bp.fullName);
        }

        else packageSyncList = builder.packageList;

        OSResponse      osr     = null;
        StringBuilder   logOnly = new StringBuilder();

        final AppendableSafe logAndScreen = new AppendableSafe(
            new BiAppendable(System.out, logOnly),
            AppendableSafe.USE_APPENDABLE_ERROR
        );

        // Uses Shell-Contructor:
        // (outputAppendable, commandStrAppendable, standardOutput, errorOutput)

        Shell       shell   = new Shell(logOnly, logAndScreen, null, null);
        OSExtras    ose     = new OSExtras();

        // GSUTIL gsutil = new GSUTIL(logOnly, logAndScreen, null, null);
        builder.cloudSync.initStage05(logOnly, logAndScreen);

        Stream.Builder<String> aclCommandB = Stream.builder();
        Vector<String> copyDirs = new Vector<>(4);

        for (BuildPackage bp : packageSyncList)
        {
            final String PN_FS =
                builder.LOCAL_JAVADOC_DIR + bp.fullName.replace(".", FS) + FS;

            final String PN_GCS =
                builder.cli.GCS_DIR + "javadoc/" + bp.fullName.replace('.', '/') + '/';

            logAndScreen.append("\nCopying Package HTML: " + BYELLOW + bp.fullName + RESET + '\n');
            // osr = gsutil.CP(PN_FS + '*', PN_GCS);
            osr = builder.cloudSync.copySingleJDPackageToCloud(PN_FS, PN_GCS);

            Util.HALT_ON_ERROR(osr);

            // The GSUTIL.MP (Make-Public) Command is called once at the very end.
            aclCommandB.accept(PN_GCS + '*');

            // Empty out the previous calls stuff
            copyDirs.clear();

            if (new java.io.File(PN_FS + "doc-files" + FS).exists())
            {
                copyDirs.add("doc-files" + FS);
                aclCommandB.accept(PN_GCS + "doc-files" + FS + "**");
            }

            if (new java.io.File(PN_FS + "hilite-files" + FS).exists())
            {
                copyDirs.add("hilite-files" + FS);
                aclCommandB.accept(PN_GCS + "hilite-files" + FS + "**");
            }

            if (new java.io.File(PN_FS + "stylesheets" + FS).exists())
            {
                copyDirs.add("stylesheets" + FS);
                aclCommandB.accept(PN_GCS + "stylesheets" + FS + "**");
            }

            ose.currentWorkingDirectory = new File(PN_FS);
            // gsutil.osExtras = ose;

            logAndScreen.append(
                "\nOSExtras.currentWorkingDirectory was assigned:  " +
                BYELLOW + PN_FS + RESET + '\n'
            );

            // osr = gsutil.CP(copyDirs, PN_GCS, "-r");
            builder.cloudSync.copyOtherPackageDirsToCloudDir(ose, copyDirs, PN_GCS);
            Util.HALT_ON_ERROR(osr);
        }

        String[] makePublicArr = aclCommandB.build().toArray(String[]::new);

        // My Cute little hack for the day.  This will make Stage 8 a lot faster.
        // Well, this isn't considered a hack anymore, because it works pretty well.
        //
        // NOTE: Even if "Make-Public" isn't executed on a directory because that GCP Bucket
        //       directory has been assigned "Bucket-Level Permissions", it will stll be necessary
        //       to run the "Set Max Age" (Stage 8 Stuff), if the user has requested it!  Therefore
        //       we cannot just 'discard' the 'makePublicArr' when RUN_MAKE_PUBLIC is false.

        builder.stage8GCSDirs = makePublicArr;

        // REMEMBER: if this is ever invoked on a bucket that has bucket-level
        // permissions, instead of object level permissions, THIS WOULD CRASH.
        //
        // NOTE: the content of the 'aclCommandB' Stream.Builder are just wholly ignored and
        //       discarded (eventually), by the garbage-collector if the Storage-Bucket has been
        //       assigned Bucket-Level permissions instead of Object-Level Permissions.

        if (builder.RUN_MAKE_PUBLIC)
        {
            // Print these so they are legible
            logAndScreen.append(BGREEN + "\nMake Copied Files Public:\n\n" + RESET);
            for (String gcsDir : makePublicArr) logAndScreen.append('\t' + gcsDir + "\n");
            logAndScreen.append('\n');

            // Now do the actual "Make Public" Command
            // osr = gsutil.MP(makePublicArr);
            osr = builder.cloudSync.makePublicDirArr(makePublicArr);
            Util.HALT_ON_ERROR(osr);
        }

        logAndScreen.append(BGREEN + "\nClean Up:\n" + RESET);
        osr = shell.RM(builder.LOCAL_JAVADOC_DIR, "-r");
        Util.HALT_ON_ERROR(osr);

        builder.logs.write_S05_LOG(logOnly.toString());
        builder.cloudSync.endStage05();
        builder.timers.endStage05();
    }
}