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=STAGE_PRIVATE_NOTE>
 * <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(final BuilderRecord brec) throws IOException
    {
        brec.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);
        brec.cloudSync.initStage(logOnly, logAndScreen);
        Shell shell = new Shell(logOnly, logAndScreen, null, null);

        // Data-Record Explanation:
        // 
        // brec: BuilderRecord - Top-of-Tree Data-Record for executing a build, Contains everything
        // cli:  (Command-Line-Interface) - All info gathered from user-input to "String[] argv"
        // aor:  Auxiliary-Options Record - A Record containing only final / constant booleans,
        //       whose values are all exactly equal to whether or not each of the 6 or 7 Auxiliary
        //       options were passed, by the user, to "String[] argv" at the command line.

        if (! brec.cli.aor.SKIP_REMOVE_GCS_FILES_SWITCH)
        {
            // osr = gsutil.RM(brec.cli.GCS_DIR + "javadoc/" + "**");
            osr = brec.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(brec.LOCAL_JAVADOC_DIR, brec.cli.GCS_DIR, "-r");
        osr = brec.cloudSync.copyJavaDocDirToCloudDir();
        Util.HALT_ON_ERROR(osr);
        Printing.PLS(logOnly, false);

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

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

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


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


    static void syncPart(final BuilderRecord brec) throws IOException
    {
        brec.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)

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

        // GSUTIL gsutil = new GSUTIL(logOnly, logAndScreen, null, null);
        brec.cloudSync.initStage(logOnly, logAndScreen);

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


        // brec: class BuilderRecord
        // cli:  class CLI
        // aor:  class AuxiliaryOptRecord

        for (BuildPackage bp : brec.cli.sor.userSpecifiedPackages)
        {
            final String pkgRootLocalDir =
                brec.LOCAL_JAVADOC_DIR + bp.fullName.replace(".", FS) + FS;

            final String pkgRootCloudDir =

                // brec.cli.GCS_DIR + "javadoc/" + bp.fullName.replace('.', '/') + '/';
                //
                // TO-DO: When I am capable of holding this inside my brain, I need to revisit
                //        this line.  For now, I simply cannot think - and I'm trying to get this
                //        B.S. to compile.  The current plan is to only run "syncAll" and not
                //        "syncPart".  I will worry about this very soon, just not right now.
                //        NOTE THE ORIGINAL LINE OF CODE IS DIRECTLY ABOVE, COMMENTED OUT.
                // 
                // Not sure brec.cloudSync

                brec.cloudSync.cloudRootStorageDir +
                "javadoc/" + bp.fullName.replace('.', '/') + '/';

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

            Util.HALT_ON_ERROR(osr);

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

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

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

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

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


            // This part (this 'if' statement) is a litte weird.
            // If there are no 'doc-files/', 'stylesheets/' or 'hilite-files/' the next few lines
            // will CRASH the BUILD.  However, there should always be 'hilite-files/', so the
            // following check should always get a PASS!
            // 
            // I'm going to leave this check here, for now.  This error was discovered when trying
            // to figure out the source of a different bug.  Because it is possible for a user to
            // actually "turn off" the "HiLite Source" feature for an entire package - this check
            // isn't actually a complete joke.  I never turned of Hi-Lite Files, since that's the
            // main thing this Upgrader does!  Anyway, if such a decision by the user were made,
            // then this 'if-statement' is very important...  OK?  :)  Have a nice day.
            // 
            // By the way, it's also possible for this list to empty because there were no
            // no 'hilite-files/' due to a bug in the CLI-Processing for the "Partial-Build's"
            // Menu-Options Package-Lists...  Specifically if a package were included in the list,
            // but the Ugprader hadn't been run on that package, then this specific list right here
            // (directly below) would, indeed, be empty.  That's the bug that was just fixed a
            // moment ago.  (TL;DR: If you try to "Synchronize a Package" that wasn't upgraded by
            // the Upgrader, It's very likely it won't have any of these "Copy-Dirs" either).  The
            // Upgrader will **ALWAYS** at least add a 'hilite-files/' directory, unless that
            // features was explicitly requested to be turned off by the user.

            if (copyDirs.size() == 0) continue;


            // This is the culmination of quite a bit of playing with the OSCommands class
            // to allow a user to execute / run an external OS-Call (an external program)
            // as if it had been invoked inside of some other directory that the in which
            // the original Java-VM / JRE had been invoked.

            ose.currentWorkingDirectory = new File(pkgRootLocalDir);

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


            // ORIGINAL:
            // osr = gsutil.CP(copyDirs, pkgRootCloudDir, "-r");
            //
            // TO-DO PART 2: I am incapable of analyzing this right now.  I just want it to compile
            //               and build at the moment.  I hate breaking my build, and that is what I
            //               I have just done.  When the Build itself won't work, that is when 
            //               I get really aggrivated
            // 
            //               THERE ARE ONLY TWO LINES THAT NEED REAL FIXING.
            //               BOTH OF THEM ARE IN THIS FILE.
            //
            // OK, I SOLVED THE PROBLEM - HOWEVER, THE REIGNING SOLUTION DOES NOT EXTEND TO THE
            // SCENARIO WHERE I STOP USING "GSUTIL" AND START ALLOWING "RCLONE" OR SOME KIND OF
            // "S3".
            // 
            // Currently, "SyncPart" is a GSUTIL only method.  And since Torello.Java.Build is 
            // just impossible for me to think about for very long.  I am going to stop this for a
            // few weeks, and it is now going to be time to finish JavaDoc.Upgrade...
            //
            // "syncPart" works, but only with the GSUTILCloudSync version.  However since I have
            // not written S3CloudSync, or RCloneCloudSync - I'm just not going to worry about it
            // right now.  Build is true madness is what it usually feels like.  It is nothing but
            // a long, long, LONG list of configurations, settings, and choices that are supposed
            // to all be controllable from a simple CLI-argv String...-Array thing.

            osr = brec.cloudSync.copyOtherPackageDirsToCloudDir
                (ose, copyDirs, pkgRootCloudDir);

            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.

        brec.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 (brec.RUN_MAKE_PUBLIC)
        if (brec.cloudSync.shouldRunMakePublic)
        {
            // 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 = brec.cloudSync.makePublicDirArr(makePublicArr);
            Util.HALT_ON_ERROR(osr);
        }

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

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