/*
 * hunt-time: A time library for D programming language.
 *
 * Copyright (C) 2015-2018 HuntLabs
 *
 * Website: https://www.huntlabs.net/
 *
 * Licensed under the Apache-2.0 License.
 *
 */

module hunt.time.zone.ZoneRulesProvider;

// import hunt.security.AccessController;
// import hunt.security.PrivilegedAction;
// import hunt.time.ZoneId;
// import hunt.time.ZonedDateTime;
import hunt.collection.ArrayList;
import hunt.collection.HashSet;
import hunt.collection.Iterator;
import hunt.collection.List;
import hunt.collection.NavigableMap;
import hunt.collection.Set;
import hunt.collection.HashMap;
import hunt.collection.Collections;

import hunt.time.zone.ZoneRules;
import hunt.time.zone.ZoneRulesException;
import hunt.time.util.Common;
import hunt.time.util.ServiceLoader;
import hunt.time.zone.TzdbZoneRulesProvider;

version (HUNT_DEBUG) import hunt.logging.ConsoleLogger;

import std.concurrency : initOnce;

/**
 * Provider of time-zone rules to the system.
 * !(p)
 * This class manages the configuration of time-zone rules.
 * The static methods provide the API that can be used to manage the providers.
 * The abstract methods provide the SPI that allows rules to be provided.
 * !(p)
 * ZoneRulesProvider may be installed _in an instance of the Java Platform as
 * extension classes, that is, jar files placed into any of the usual extension
 * directories. Installed providers are loaded using the service-provider loading
 * facility defined by the {@link ServiceLoader} class. A ZoneRulesProvider
 * identifies itself with a provider configuration file named
 * {@code hunt.time.zone.ZoneRulesProvider} _in the resource directory
 * {@code META-INF/services}. The file should contain a line that specifies the
 * fully qualified concrete zonerules-provider class name.
 * Providers may also be made available by adding them to the class path or by
 * registering themselves via {@link #registerProvider} method.
 * !(p)
 * The Java virtual machine has a default provider that provides zone rules
 * for the time-zones defined by IANA Time Zone Database (TZDB). If the system
 * property {@code hunt.time.zone.DefaultZoneRulesProvider} is defined then
 * it is taken to be the fully-qualified name of a concrete ZoneRulesProvider
 * class to be loaded as the default provider, using the system class loader.
 * If this system property is not defined, a system-default provider will be
 * loaded to serve as the default provider.
 * !(p)
 * Rules are looked up primarily by zone ID, as used by {@link ZoneId}.
 * Only zone region IDs may be used, zone offset IDs are not used here.
 * !(p)
 * Time-zone rules are political, thus the data can change at any time.
 * Each provider will provide the latest rules for each zone ID, but they
 * may also provide the history of how the rules changed.
 *
 * @implSpec
 * This interface is a service provider that can be called by multiple threads.
 * Implementations must be immutable and thread-safe.
 * !(p)
 * Providers must ensure that once a rule has been seen by the application, the
 * rule must continue to be available.
 * !(p)
 * Providers are encouraged to implement a meaningful {@code toString} method.
 * !(p)
 * Many systems would like to update time-zone rules dynamically without stopping the JVM.
 * When examined _in detail, this is a complex problem.
 * Providers may choose to handle dynamic updates, however the default provider does not.
 *
 * @since 1.8
 */
abstract class ZoneRulesProvider {

    /**
     * The set of loaded providers.
     */
    static ArrayList!(ZoneRulesProvider) PROVIDERS() {
        initializeGlobals();
        return _PROVIDERS;
    }

    /**
     * The lookup from zone ID to provider.
     */
    static HashMap!(string, ZoneRulesProvider) ZONES() {
        initializeGlobals();
        return _ZONES;
    }
    
    // __gshared ConcurrentMap!(string, ZoneRulesProvider) ZONES;

    /**
     * The zone ID data
     */
    private __gshared Set!(string) ZONE_IDS;
    private __gshared ArrayList!(ZoneRulesProvider) _PROVIDERS;
    private __gshared HashMap!(string, ZoneRulesProvider) _ZONES;

    private static void initializeGlobals() {
        __gshared bool isInitialized = false;
        initOnce!(isInitialized)({
            _PROVIDERS = new ArrayList!(ZoneRulesProvider)();
            _ZONES = new HashMap!(string, ZoneRulesProvider)(512, 0.75f/* , 2 */);
            registerProvider0(new TzdbZoneRulesProvider());
            return true;
        }());
    }

    // FIXME: Needing refactor or cleanup -@zhangxueping at 4/4/2019, 5:51:46 PM
    // 
    // shared static this() {
    //     // registerProvider(new TzdbZoneRulesProvider());
    // }

    
    //-------------------------------------------------------------------------
    /**
     * Gets the set of available zone IDs.
     * !(p)
     * These IDs are the string form of a {@link ZoneId}.
     *
     * @return the unmodifiable set of zone IDs, not null
     */
    static Set!(string) getAvailableZoneIds() {
        initializeGlobals();
        return ZONE_IDS;
    }


    /**
     * Gets the rules for the zone ID.
     * !(p)
     * This returns the latest available rules for the zone ID.
     * !(p)
     * This method relies on time-zone data provider files that are configured.
     * These are loaded using a {@code ServiceLoader}.
     * !(p)
     * The caching flag is designed to allow provider implementations to
     * prevent the rules being cached _in {@code ZoneId}.
     * Under normal circumstances, the caching of zone rules is highly desirable
     * as it will provide greater performance. However, there is a use case where
     * the caching would not be desirable, see {@link #provideRules}.
     *
     * @param zoneId the zone ID as defined by {@code ZoneId}, not null
     * @param forCaching whether the rules are being queried for caching,
     * true if the returned rules will be cached by {@code ZoneId},
     * false if they will be returned to the user without being cached _in {@code ZoneId}
     * @return the rules, null if {@code forCaching} is true and this
     * is a dynamic provider that wants to prevent caching _in {@code ZoneId},
     * otherwise not null
     * @throws ZoneRulesException if rules cannot be obtained for the zone ID
     */
    static ZoneRules getRules(string zoneId, bool forCaching) {
        assert(zoneId, "zoneId");
        return getProvider(zoneId).provideRules(zoneId, forCaching);
    }

    /**
     * Gets the history of rules for the zone ID.
     * !(p)
     * Time-zones are defined by governments and change frequently.
     * This method allows applications to find the history of changes to the
     * rules for a single zone ID. The map is keyed by a string, which is the
     * version string associated with the rules.
     * !(p)
     * The exact meaning and format of the version is provider specific.
     * The version must follow lexicographical order, thus the returned map will
     * be order from the oldest known rules to the newest available rules.
     * The default 'TZDB' group uses version numbering consisting of the year
     * followed by a letter, such as '2009e' or '2012f'.
     * !(p)
     * Implementations must provide a result for each valid zone ID, however
     * they do not have to provide a history of rules.
     * Thus the map will always contain one element, and will only contain more
     * than one element if historical rule information is available.
     *
     * @param zoneId  the zone ID as defined by {@code ZoneId}, not null
     * @return a modifiable copy of the history of the rules for the ID, sorted
     *  from oldest to newest, not null
     * @throws ZoneRulesException if history cannot be obtained for the zone ID
     */
    static NavigableMap!(string, ZoneRules) getVersions(string zoneId) {
        assert(zoneId, "zoneId");
        return getProvider(zoneId).provideVersions(zoneId);
    }

    /**
     * Gets the provider for the zone ID.
     *
     * @param zoneId  the zone ID as defined by {@code ZoneId}, not null
     * @return the provider, not null
     * @throws ZoneRulesException if the zone ID is unknown
     */
    private static ZoneRulesProvider getProvider(string zoneId) {
        ZoneRulesProvider provider = ZONES.get(zoneId);
        // version (HUNT_DEBUG) tracef("zoneId=%s, ZONES.size=%d", zoneId, ZONES.size());
        if (provider is null) {
            if (ZONES.isEmpty()) {
                throw new ZoneRulesException("No time-zone data files registered");
            }
            throw new ZoneRulesException("Unknown time-zone ID: " ~ zoneId);
        }
        return provider;
    }

    //-------------------------------------------------------------------------
    /**
     * Registers a zone rules provider.
     * !(p)
     * This adds a new provider to those currently available.
     * A provider supplies rules for one or more zone IDs.
     * A provider cannot be registered if it supplies a zone ID that has already been
     * registered. See the notes on time-zone IDs _in {@link ZoneId}, especially
     * the section on using the concept of a "group" to make IDs unique.
     * !(p)
     * To ensure the integrity of time-zones already created, there is no way
     * to deregister providers.
     *
     * @param provider  the provider to register, not null
     * @throws ZoneRulesException if a zone ID is already registered
     */
    static void registerProvider(ZoneRulesProvider provider) {
        assert(provider !is null, "provider");
        synchronized {
            // registerProvider0(provider);
            // PROVIDERS.add(provider);
            initializeGlobals();
            registerProvider0(provider);
        }
    }

    /**
     * Registers the provider.
     *
     * @param provider  the provider to register, not null
     * @throws ZoneRulesException if unable to complete the registration
     */
    private static void registerProvider0(ZoneRulesProvider provider) {
        foreach(string zoneId ; provider.provideZoneIds()) {
            assert(zoneId, "zoneId");
            ZoneRulesProvider old = _ZONES.putIfAbsent(zoneId, provider);
            if (old !is null) {
                throw new ZoneRulesException(
                    "Unable to register zone as one already registered with that ID: " ~ zoneId ~
                    ", currently loading from provider: " ~ provider.toString);
            }
        }
        // Set!(string) combinedSet = new HashSet!(string)();
        // foreach(data; ZONES.keySet()) {
        //     combinedSet.add(data);
        // }
        // import std.stdio;
        // writeln("zone set : ",combinedSet);
        // ZONE_IDS = /* Collections.unmodifiableSet */(combinedSet);
        ZONE_IDS = new HashSet!(string)();
        foreach(data; _ZONES.keySet()) {
            ZONE_IDS.add(data);
        }

        _PROVIDERS.add(provider);
    }

    /**
     * Refreshes the rules from the underlying data provider.
     * !(p)
     * This method allows an application to request that the providers check
     * for any updates to the provided rules.
     * After calling this method, the offset stored _in any {@link ZonedDateTime}
     * may be invalid for the zone ID.
     * !(p)
     * Dynamic update of rules is a complex problem and most applications
     * should not use this method or dynamic rules.
     * To achieve dynamic rules, a provider implementation will have to be written
     * as per the specification of this class.
     * In addition, instances of {@code ZoneRules} must not be cached _in the
     * application as they will become stale. However, the bool flag on
     * {@link #provideRules(string, bool)} allows provider implementations
     * to control the caching of {@code ZoneId}, potentially ensuring that
     * all objects _in the system see the new rules.
     * Note that there is likely to be a cost _in performance of a dynamic rules
     * provider. Note also that no dynamic rules provider is _in this specification.
     *
     * @return true if the rules were updated
     * @throws ZoneRulesException if an error occurs during the refresh
     */
    static bool refresh() {
        bool changed = false;
        foreach(ZoneRulesProvider provider ; PROVIDERS) {
            changed |= provider.provideRefresh();
        }
        return changed;
    }

    /**
     * Constructor.
     */
    protected this() {
    }

    //-----------------------------------------------------------------------
    /**
     * SPI method to get the available zone IDs.
     * !(p)
     * This obtains the IDs that this {@code ZoneRulesProvider} provides.
     * A provider should provide data for at least one zone ID.
     * !(p)
     * The returned zone IDs remain available and valid for the lifetime of the application.
     * A dynamic provider may increase the set of IDs as more data becomes available.
     *
     * @return the set of zone IDs being provided, not null
     * @throws ZoneRulesException if a problem occurs while providing the IDs
     */
    protected abstract Set!(string) provideZoneIds();

    /**
     * SPI method to get the rules for the zone ID.
     * !(p)
     * This loads the rules for the specified zone ID.
     * The provider implementation must validate that the zone ID is valid and
     * available, throwing a {@code ZoneRulesException} if it is not.
     * The result of the method _in the valid case depends on the caching flag.
     * !(p)
     * If the provider implementation is not dynamic, then the result of the
     * method must be the non-null set of rules selected by the ID.
     * !(p)
     * If the provider implementation is dynamic, then the flag gives the option
     * of preventing the returned rules from being cached _in {@link ZoneId}.
     * When the flag is true, the provider is permitted to return null, where
     * null will prevent the rules from being cached _in {@code ZoneId}.
     * When the flag is false, the provider must return non-null rules.
     *
     * @param zoneId the zone ID as defined by {@code ZoneId}, not null
     * @param forCaching whether the rules are being queried for caching,
     * true if the returned rules will be cached by {@code ZoneId},
     * false if they will be returned to the user without being cached _in {@code ZoneId}
     * @return the rules, null if {@code forCaching} is true and this
     * is a dynamic provider that wants to prevent caching _in {@code ZoneId},
     * otherwise not null
     * @throws ZoneRulesException if rules cannot be obtained for the zone ID
     */
    protected abstract ZoneRules provideRules(string zoneId, bool forCaching);

    /**
     * SPI method to get the history of rules for the zone ID.
     * !(p)
     * This returns a map of historical rules keyed by a version string.
     * The exact meaning and format of the version is provider specific.
     * The version must follow lexicographical order, thus the returned map will
     * be order from the oldest known rules to the newest available rules.
     * The default 'TZDB' group uses version numbering consisting of the year
     * followed by a letter, such as '2009e' or '2012f'.
     * !(p)
     * Implementations must provide a result for each valid zone ID, however
     * they do not have to provide a history of rules.
     * Thus the map will contain at least one element, and will only contain
     * more than one element if historical rule information is available.
     * !(p)
     * The returned versions remain available and valid for the lifetime of the application.
     * A dynamic provider may increase the set of versions as more data becomes available.
     *
     * @param zoneId  the zone ID as defined by {@code ZoneId}, not null
     * @return a modifiable copy of the history of the rules for the ID, sorted
     *  from oldest to newest, not null
     * @throws ZoneRulesException if history cannot be obtained for the zone ID
     */
    protected abstract NavigableMap!(string, ZoneRules) provideVersions(string zoneId);

    /**
     * SPI method to refresh the rules from the underlying data provider.
     * !(p)
     * This method provides the opportunity for a provider to dynamically
     * recheck the underlying data provider to find the latest rules.
     * This could be used to load new rules without stopping the JVM.
     * Dynamic behavior is entirely optional and most providers do not support it.
     * !(p)
     * This implementation returns false.
     *
     * @return true if the rules were updated
     * @throws ZoneRulesException if an error occurs during the refresh
     */
    protected bool provideRefresh() {
        return false;
    }

}