/*
  ==============================================================================

   This file is part of the JUCE framework.
   Copyright (c) Raw Material Software Limited

   JUCE is an open source framework subject to commercial or open source
   licensing.

   By downloading, installing, or using the JUCE framework, or combining the
   JUCE framework with any other source code, object code, content or any other
   copyrightable work, you agree to the terms of the JUCE End User Licence
   Agreement, and all incorporated terms including the JUCE Privacy Policy and
   the JUCE Website Terms of Service, as applicable, which will bind you. If you
   do not agree to the terms of these agreements, we will not license the JUCE
   framework to you, and you must discontinue the installation or download
   process and cease use of the JUCE framework.

   JUCE End User Licence Agreement: https://juce.com/legal/juce-9-licence/
   JUCE Privacy Policy: https://juce.com/juce-privacy-policy
   JUCE Website Terms of Service: https://juce.com/juce-website-terms-of-service/

   Or:

   You may also use this code under the terms of the AGPLv3:
   https://www.gnu.org/licenses/agpl-3.0.en.html

   THE JUCE FRAMEWORK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL
   WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING WARRANTY OF
   MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, ARE DISCLAIMED.

  ==============================================================================
*/

namespace juce
{

class WebInputStream;

//==============================================================================
/**
    Represents a URL and has a bunch of useful functions to manipulate it.

    This class can be used to launch URLs in browsers, and also to create
    InputStreams that can read from remote HTTP or FTP sources.

    @tags{Core}
*/
class JUCE_API  URL
{
public:
    //==============================================================================
    /** Creates an empty URL. */
    URL();

    /** Creates a URL from a string.

        This will parse any embedded parameters after a '?' character and store them
        in the list (see getParameterNames etc). If you don't want this to happen, you
        can use createWithoutParsing().
    */
    URL (const String& url);

    /** Creates URL referring to a local file on your disk using the file:// scheme. */
    explicit URL (File localFile);

    /** Compares two URLs.

        All aspects of the URLs must be identical for them to match, including any parameters,
        upload files, etc.
    */
    bool operator== (const URL&) const;
    bool operator!= (const URL&) const;

    //==============================================================================
    /** Returns a string version of the URL.

        @param includeGetParameters  if this is true and any parameters have been set
                                     with the withParameter() method, then the string
                                     will have these appended on the end and URL-encoded.

        @see getQueryString
    */
    String toString (bool includeGetParameters) const;

    /** Returns true if the URL is an empty string. */
    bool isEmpty() const noexcept;

    /** True if it seems to be valid. */
    bool isWellFormed() const;

    /** Returns just the domain part of the URL.

        e.g. for "http://www.xyz.com/foobar", this will return "www.xyz.com".
    */
    String getDomain() const;

    /** Returns the path part of the URL.

        e.g. for "http://www.xyz.com/foo/bar?x=1", this will return "foo/bar".

        @param includeGetParameters  if this is true and any parameters have been set
                                     with the withParameter() method, then the string
                                     will have these appended on the end and URL-encoded.

        @see getQueryString
    */
    String getSubPath (bool includeGetParameters = false) const;

    /** If any parameters are set, returns these URL-encoded, including the "?"
        prefix.
    */
    String getQueryString() const;

    /** If any anchor is set, returns URL-encoded anchor, including the "#"
        prefix.
    */
    String getAnchorString() const;

    /** Returns the scheme of the URL.

        e.g. for "http://www.xyz.com/foobar", this will return "http" (it won't
        include the colon).
    */
    String getScheme() const;

    /** Returns true if this URL refers to a local file. */
    bool isLocalFile() const;

    /** Returns the file path of the local file to which this URL refers to.

        If the URL does not represent a local file URL (i.e. the URL's scheme is not 'file')
        then this method will assert.

        This method also supports converting Android's content:// URLs to local file paths.

        @see isLocalFile
    */
    File getLocalFile() const;

    /** Returns the file name.

        For all but Android's content:// scheme, it will simply return the last segment of
        the URL, e.g. for "http://www.xyz.com/foo/bar.txt", this will return "bar.txt".

        For Android's content:// scheme, it will attempt to resolve the filename
        located under the URL.
    */
    String getFileName() const;

    /** Attempts to read a port number from the URL.

        @returns the port number, or 0 if none is explicitly specified.
    */
    int getPort() const;

    /** Returns the origin of a resource reachable on this URL.

        In the context of cross-origin resource sharing (CORS) a script downloaded from this URL
        would only be allowed to reach resources from the returned origin.
    */
    String getOrigin() const;

    /** Returns a new version of this URL with a different domain and path.

        e.g. if the URL is "http://www.xyz.com/foo?x=1" and you call this with
        "abc.com/zzz", it'll return "http://abc.com/zzz?x=1".

        @see withNewSubPath
    */
    [[nodiscard]] URL withNewDomainAndPath (const String& newFullPath) const;

    /** Returns a new version of this URL with a different sub-path.

        e.g. if the URL is "http://www.xyz.com/foo?x=1" and you call this with
        "bar", it'll return "http://www.xyz.com/bar?x=1".

        @see withNewDomainAndPath
    */
    [[nodiscard]] URL withNewSubPath (const String& newPath) const;

    /** Attempts to return a URL which is the parent folder containing this URL.

        If there isn't a parent, this method will just return a copy of this URL.
    */
    URL getParentURL() const;

    /** Returns a new URL that refers to a sub-path relative to this one.

        e.g. if the URL is "http://www.xyz.com/foo" and you call this with "bar",
        it'll return "http://www.xyz.com/foo/bar".

        Note that there's no way for this method to know whether the original URL is
        a file or directory, so it's up to you to make sure it's a directory. It also
        won't attempt to be smart about the content of the childPath string, so if this
        string is an absolute URL, it'll still just get bolted onto the end of the path.

        @see File::getChildFile
    */
    URL getChildURL (const String& subPath) const;

    //==============================================================================
    /** Returns a copy of this URL, with a GET or POST parameter added to the end.

        Any control characters in the value will be URL-encoded.

        e.g. calling "withParameter ("amount", "some fish") for the url "www.fish.com"
        would produce a new url whose `toString (true)` method would return
        "www.fish.com?amount=some+fish".

        @see getParameterNames, getParameterValues
    */
    [[nodiscard]] URL withParameter (const String& parameterName,
                                     const String& parameterValue) const;

    /** Returns a copy of this URL, with a set of GET or POST parameters added.

        This is a convenience method, equivalent to calling withParameter for each value.

        @see withParameter
    */
    [[nodiscard]] URL withParameters (const StringPairArray& parametersToAdd) const;

    /** Returns a copy of this URL, with an anchor added to the end of the URL.
    */
    [[nodiscard]] URL withAnchor (const String& anchor) const;

    /** Returns a copy of this URL, with a file-upload type parameter added to it.

        When performing a POST where one of your parameters is a binary file, this
        lets you specify the file.

        Note that the filename is stored, but the file itself won't actually be read
        until this URL is later used to create a network input stream. If you want to
        upload data from memory, use withDataToUpload().

        @see withDataToUpload
    */
    [[nodiscard]] URL withFileToUpload (const String& parameterName,
                                         const File& fileToUpload,
                                         const String& mimeType) const;

    /** Returns a copy of this URL, with a file-upload type parameter added to it.

        When performing a POST where one of your parameters is a binary file, this
        lets you specify the file content.

        Note that the filename parameter should not be a full path, it's just the
        last part of the filename.

        @see withFileToUpload
    */
    [[nodiscard]] URL withDataToUpload (const String& parameterName,
                                         const String& filename,
                                         const MemoryBlock& fileContentToUpload,
                                         const String& mimeType) const;

    /** Returns an array of the names of all the URL's parameters.

        e.g. for the url "www.fish.com?type=haddock&amount=some+fish", this array would
        contain two items: "type" and "amount".

        You can call getParameterValues() to get the corresponding value of each
        parameter. Note that the list can contain multiple parameters with the same name.

        @see getParameterValues, withParameter
    */
    const StringArray& getParameterNames() const noexcept       { return parameterNames; }

    /** Returns an array of the values of all the URL's parameters.

        e.g. for the url "www.fish.com?type=haddock&amount=some+fish", this array would
        contain two items: "haddock" and "some fish".

        The values returned will have been cleaned up to remove any escape characters.

        You can call getParameterNames() to get the corresponding name of each
        parameter. Note that the list can contain multiple parameters with the same name.

        @see getParameterNames, withParameter
    */
    const StringArray& getParameterValues() const noexcept      { return parameterValues; }

    /** Returns a copy of this URL, with a block of data to send as the POST data.

        If the URL already contains some POST data, this will replace it, rather
        than being appended to it.

        If no HTTP command is set when calling createInputStream() to read from
        this URL and some data has been set, it will do a POST request.
    */
    [[nodiscard]] URL withPOSTData (const String& postData) const;

    /** Returns a copy of this URL, with a block of data to send as the POST data.

        If the URL already contains some POST data, this will replace it, rather
        than being appended to it.

        If no HTTP command is set when calling createInputStream() to read from
        this URL and some data has been set, it will do a POST request.
    */
    [[nodiscard]] URL withPOSTData (const MemoryBlock& postData) const;

    /** Returns the data that was set using withPOSTData(). */
    String getPostData() const                                      { return postData.toString(); }

    /** Returns the data that was set using withPOSTData() as a MemoryBlock. */
    const MemoryBlock& getPostDataAsMemoryBlock() const noexcept    { return postData; }

    //==============================================================================
    /** Tries to launch the system's default browser to open the URL.

        @returns  true if this seems to have worked.
    */
    bool launchInDefaultBrowser() const;

    //==============================================================================
    /** Takes a guess as to whether a string might be a valid website address.
        This isn't foolproof!
    */
    static bool isProbablyAWebsiteURL (const String& possibleURL);

    /** Takes a guess as to whether a string might be a valid email address.
        This isn't foolproof!
    */
    static bool isProbablyAnEmailAddress (const String& possibleEmailAddress);

    //==============================================================================
    enum class ParameterHandling
    {
        inAddress,
        inPostData
    };

    /** Class used to create a set of options to pass to the createInputStream() method.

        You can chain together a series of calls to this class's methods to create
        a set of whatever options you want to specify, e.g.
        @code
        if (auto inputStream = URL ("http://www.xyz.com/foobar")
                                 .createInputStream (URL::InputStreamOptions (URL::ParameterHandling::inAddress)
                                                           .withConnectionTimeoutMs (1000)
                                                           .withNumRedirectsToFollow (0)))
        {
            ...
        }
        @endcode
    */
    class JUCE_API  InputStreamOptions
    {
    public:
        /** Constructor.

            If parameterHandling is ParameterHandling::inPostData, any URL parameters
            that have been set will be transferred via the request body data. Otherwise
            the parameters will be added to the URL address.
        */
        explicit InputStreamOptions (ParameterHandling parameterHandling);

        //==============================================================================
        /** A callback function to keep track of the operation's progress.

            This can be useful for lengthy POST operations, so that you can provide user feedback.
        */
        [[nodiscard]] InputStreamOptions withProgressCallback (std::function<bool (int bytesSent, int totalBytes)> progressCallback) const;

        /** A string that will be appended onto the headers that are used for the request.

            It must be a valid set of HTML header directives, separated by newlines.
        */
        [[nodiscard]] InputStreamOptions withExtraHeaders (const String& extraHeaders) const;

        /** Specifies a timeout for the request in milliseconds.

            If 0, this will use whatever default setting the OS chooses. If a negative
            number, it will be infinite.
        */
        [[nodiscard]] InputStreamOptions withConnectionTimeoutMs (int connectionTimeoutMs) const;

        /** If this is non-null, all the (key, value) pairs received as headers
            in the response will be stored in this array.
        */
        [[nodiscard]] InputStreamOptions withResponseHeaders (StringPairArray* responseHeaders) const;

        /** If this is non-null, it will get set to the http status code, if one
            is known, or 0 if a code isn't available.
        */
        [[nodiscard]] InputStreamOptions withStatusCode (int* statusCode) const;

        /** Specifies the number of redirects that will be followed before returning a response.

            N.B. This will be ignored on Android which follows up to 5 redirects.
        */
        [[nodiscard]] InputStreamOptions withNumRedirectsToFollow (int numRedirectsToFollow) const;

        /** Specifies which HTTP request command to use.

            If this is not set, then the command will be POST if parameterHandling is
            set to ParameterHandling::inPostData or if any POST data has been specified
            via withPOSTData(), withFileToUpload(), or withDataToUpload(). Otherwise it
            will be GET.
        */
        [[nodiscard]] InputStreamOptions withHttpRequestCmd (const String& httpRequestCmd) const;

        //==============================================================================
        ParameterHandling getParameterHandling() const noexcept             { return parameterHandling; }
        std::function<bool (int, int)> getProgressCallback() const noexcept { return progressCallback; }
        String getExtraHeaders() const noexcept                             { return extraHeaders; }
        int getConnectionTimeoutMs() const noexcept                         { return connectionTimeOutMs; }
        StringPairArray* getResponseHeaders() const noexcept                { return responseHeaders; }
        int* getStatusCode() const noexcept                                 { return statusCode; }
        int getNumRedirectsToFollow() const noexcept                        { return numRedirectsToFollow; }
        String getHttpRequestCmd() const noexcept                           { return httpRequestCmd; }

    private:
        //==============================================================================
        const ParameterHandling parameterHandling;

        std::function<bool (int, int)> progressCallback = nullptr;
        String extraHeaders;
        int connectionTimeOutMs = 0;
        StringPairArray* responseHeaders = nullptr;
        int* statusCode = nullptr;
        int numRedirectsToFollow = 5;
        String httpRequestCmd;
    };

    /** Attempts to open a stream that can read from this URL.

        Note that this method will block until the first byte of data has been received or an
        error has occurred.

        Note that on some platforms (Android, for example) it's not permitted to do any network
        action from the message thread, so you must only call it from a background thread.

        Unless the URL represents a local file, this method returns an instance of a
        WebInputStream. You can use dynamic_cast to cast the return value to a WebInputStream
        which allows you more fine-grained control of the transfer process.

        If the URL represents a local file, then this method simply returns a FileInputStream.

        @param options           a set of options that will be used when opening the stream.

        @returns                 a valid input stream, or nullptr if there was an error trying to open it.
    */
    std::unique_ptr<InputStream> createInputStream (const InputStreamOptions& options) const;

    /** Attempts to open an output stream to a URL for writing

        This method can only be used for certain scheme types such as local files
        and content:// URIs on Android.
    */
    std::unique_ptr<OutputStream> createOutputStream() const;

    //==============================================================================
    class DownloadTask;

    /** Used to receive callbacks for download progress. */
    struct JUCE_API  DownloadTaskListener
    {
        virtual ~DownloadTaskListener() = default;

        /** Called when the download has finished. Be aware that this callback may
            come on an arbitrary thread.
        */
        virtual void finished (DownloadTask* task, bool success) = 0;

        /** Called periodically by the OS to indicate download progress.

            Beware that this callback may come on an arbitrary thread.
        */
        virtual void progress (DownloadTask* task, int64 bytesDownloaded, int64 totalLength);
    };

    /** Holds options that can be specified when starting a new download
        with downloadToFile().
    */
    class DownloadTaskOptions
    {
    public:
        String extraHeaders;
        String sharedContainer;
        DownloadTaskListener* listener = nullptr;
        bool usePost = false;

        /** Specifies headers to add to the request. */
        [[nodiscard]] auto withExtraHeaders (String value) const            { return with (&DownloadTaskOptions::extraHeaders, std::move (value)); }

        /** On iOS, specifies the container where the downloaded file will be stored.

            If you initiate a download task from inside an app extension on iOS,
            you must supply this option.

            This is currently unused on other platforms.
        */
        [[nodiscard]] auto withSharedContainer (String value) const         { return with (&DownloadTaskOptions::sharedContainer, std::move (value)); }

        /** Specifies an observer for the download task. */
        [[nodiscard]] auto withListener (DownloadTaskListener* value) const { return with (&DownloadTaskOptions::listener, std::move (value)); }

        /** Specifies whether a post command should be used. */
        [[nodiscard]] auto withUsePost (bool value) const                   { return with (&DownloadTaskOptions::usePost, value); }

    private:
        template <typename Member, typename Value>
        [[nodiscard]] DownloadTaskOptions with (Member&& member, Value&& value) const
        {
            auto copy = *this;
            copy.*member = std::forward<Value> (value);
            return copy;
        }
    };

    /** Represents a download task.

        Returned by downloadToFile() to allow querying and controlling the download task.
    */
    class JUCE_API  DownloadTask
    {
    public:
        using Listener = DownloadTaskListener;

        /** Releases the resources of the download task, unregisters the listener
            and cancels the download if necessary.
        */
        virtual ~DownloadTask();

        /** Returns the total length of the download task.

            This may return -1 if the length was not returned by the server.
        */
        int64 getTotalLength() const                      { return contentLength; }

        /** Returns the number of bytes that have been downloaded so far. */
        int64 getLengthDownloaded() const                 { return downloaded; }

        /** Returns true if the download finished or there was an error. */
        bool isFinished() const                           { return finished; }

        /** Returns the status code of the server's response.

            This will only be valid after the download has finished.

            @see isFinished
        */
        int statusCode() const                            { return httpCode; }

        /** Returns true if there was an error. */
        inline bool hadError() const                      { return error; }

        /** Returns the target file location that was provided in URL::downloadToFile. */
        File getTargetLocation() const                    { return targetLocation; }

    protected:
        int64 contentLength = -1, downloaded = 0;
        bool finished = false, error = false;
        int httpCode = -1;
        File targetLocation;

        DownloadTask();

    private:
        friend class URL;
        static std::unique_ptr<DownloadTask> createFallbackDownloader (const URL&, const File&, const DownloadTaskOptions&);

    public:
       #if JUCE_IOS
        /** internal **/
        static void juce_iosURLSessionNotify (const String&);
       #endif

    private:
        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (DownloadTask)
    };

    /** This function is replaced by a new overload accepting a DownloadTaskOptions argument. */
    [[deprecated ("Use the overload with a DownloadTaskOptions argument instead")]]
    std::unique_ptr<DownloadTask> downloadToFile (const File& targetLocation,
                                                  String extraHeaders = String(),
                                                  DownloadTaskListener* listener = nullptr,
                                                  bool usePostCommand = false);

    /** Download the URL to a file.

        This method attempts to download the URL to a given file location.

        Using this method to download files on mobile is less flexible but more reliable
        than using createInputStream or WebInputStreams as it will attempt to download the file
        using a native OS background network task. Such tasks automatically deal with
        network re-connections and continuing your download while your app is suspended.
    */
    std::unique_ptr<DownloadTask> downloadToFile (const File& targetLocation,
                                                  const DownloadTaskOptions& options);

    //==============================================================================
    /** Tries to download the entire contents of this URL into a binary data block.

        If it succeeds, this will return true and append the data it read onto the end
        of the memory block.

        Note that on some platforms (Android, for example) it's not permitted to do any network
        action from the message thread, so you must only call it from a background thread.

        @param destData        the memory block to append the new data to.
        @param usePostCommand  whether to use a POST command to get the data (uses
                               a GET command if this is false).

        @see readEntireTextStream, readEntireXmlStream
    */
    bool readEntireBinaryStream (MemoryBlock& destData,
                                 bool usePostCommand = false) const;

    /** Tries to download the entire contents of this URL as a string.

        If it fails, this will return an empty string, otherwise it will return the
        contents of the downloaded file. If you need to distinguish between a read
        operation that fails and one that returns an empty string, you'll need to use
        a different method, such as readEntireBinaryStream().

        Note that on some platforms (Android, for example) it's not permitted to do any network
        action from the message thread, so you must only call it from a background thread.

        @param usePostCommand  whether to use a POST command to get the data (uses
                               a GET command if this is false).

        @see readEntireBinaryStream, readEntireXmlStream
    */
    String readEntireTextStream (bool usePostCommand = false) const;

    /** Tries to download the entire contents of this URL and parse it as XML.

        If it fails, or if the text that it reads can't be parsed as XML, this will
        return nullptr.

        Note that on some platforms (Android, for example) it's not permitted to do any network
        action from the message thread, so you must only call it from a background thread.

        @param usePostCommand  whether to use a POST command to get the data (uses
                               a GET command if this is false).

        @see readEntireBinaryStream, readEntireTextStream
    */
    std::unique_ptr<XmlElement> readEntireXmlStream (bool usePostCommand = false) const;

    //==============================================================================
    /** Adds escape sequences to a string to encode any characters that aren't
        legal in a URL.

        E.g. any spaces will be replaced with "%20".

        This is the opposite of removeEscapeChars().

        @param stringToAddEscapeCharsTo  the string to escape.
        @param isParameter               if true then the string is going to be
                                         used as a parameter, so it also encodes
                                         '$' and ',' (which would otherwise be
                                         legal in a URL.
        @param roundBracketsAreLegal     technically round brackets are ok in URLs,
                                         however, some servers (like AWS) also want
                                         round brackets to be escaped.

        @see removeEscapeChars
    */
    static String addEscapeChars (const String& stringToAddEscapeCharsTo,
                                  bool isParameter,
                                  bool roundBracketsAreLegal = true);

    /** Replaces any escape character sequences in a string with their original
        character codes.

        E.g. any instances of "%20" will be replaced by a space.

        This is the opposite of addEscapeChars().

        @see addEscapeChars
    */
    static String removeEscapeChars (const String& stringToRemoveEscapeCharsFrom);

    /** Returns a URL without attempting to remove any embedded parameters from the string.

        This may be necessary if you need to create a request that involves both POST
        parameters and parameters which are embedded in the URL address itself.
    */
    static URL createWithoutParsing (const String& url);

    //==============================================================================
    /** @cond */
    using OpenStreamProgressCallback = bool (void* context, int bytesSent, int totalBytes);

    /** This method has been deprecated.

        @see InputStreamOptions
    */
    [[deprecated ("New code should use the method which takes an InputStreamOptions argument instead.")]]
    std::unique_ptr<InputStream> createInputStream (bool doPostLikeRequest,
                                                    OpenStreamProgressCallback* progressCallback = nullptr,
                                                    void* progressCallbackContext = nullptr,
                                                    String extraHeaders = {},
                                                    int connectionTimeOutMs = 0,
                                                    StringPairArray* responseHeaders = nullptr,
                                                    int* statusCode = nullptr,
                                                    int numRedirectsToFollow = 5,
                                                    String httpRequestCmd = {}) const;
    /** @endcond */

private:
    //==============================================================================
   #if JUCE_IOS
    struct Bookmark : public ReferenceCountedObject
    {
        using Ptr = ReferenceCountedObjectPtr<Bookmark>;

        Bookmark (void*);
        ~Bookmark();

        void* data;
    };

    Bookmark::Ptr bookmark;

    friend void setURLBookmark (URL&, void*);
    friend void* getURLBookmark (URL&);
   #endif

    //==============================================================================
    struct Upload  : public ReferenceCountedObject
    {
        Upload (const String&, const String&, const String&, const File&, MemoryBlock*);
        String parameterName, filename, mimeType;
        File file;
        std::unique_ptr<MemoryBlock> data;

        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Upload)
    };

    //==============================================================================
    friend class WebInputStream;

    URL (const String&, int);
    void init();
    void addParameter (const String&, const String&);
    bool hasBodyDataToSend() const;
    void createHeadersAndPostData (String&, MemoryBlock&, bool) const;
    URL withUpload (Upload*) const;

    static ParameterHandling toHandling (bool);
    static File fileFromFileSchemeURL (const URL&);
    String getDomainInternal (bool) const;

    //==============================================================================
    String url;
    MemoryBlock postData;
    StringArray parameterNames, parameterValues;
    String anchor;

    ReferenceCountedArray<Upload> filesToUpload;

    //==============================================================================
    JUCE_LEAK_DETECTOR (URL)
};

} // namespace juce
