YiRemoteAssetCatalog.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_REMOTE_ASSET_CATALOG_H_
#define _YI_REMOTE_ASSET_CATALOG_H_

#include "asset/YiAsset.h"
#include "asset/YiAssetManifest.h"
#include "network/YiHTTPRequest.h"
#include "network/YiRemoteAssetDownloadHelper.h"

class CYIRemoteAssetCatalog : public CYIAsset, public CYISignalHandler
{
    friend class CYIAssetLoader;

public:
    static std::shared_ptr<CYIRemoteAssetCatalog> Create(const CYIString &name);

    enum FAILURE_TYPE
    {
        INVALID_URL,     
        NETWORK_ERROR,   
        INVALID_ASSET,   
        INVALID_MANIFEST 
    };

    virtual ~CYIRemoteAssetCatalog();

    const CYIUrl &GetUrl() const;

    uint64_t GetCatalogID() const;

    CYIString GetAbsoluteCatalogUrlForAsset(const CYIString &assetName) const;

    CYIString GetRelativeCatalogUrlForAsset(const CYIString &assetName) const;

    void DownloadManifest(const CYIUrl &url);

    void DownloadAssets();

    void DownloadManifestAndAssets(const CYIUrl &url);

    void CancelDownload();

    virtual std::pair<uint32_t, uint32_t> GetApproximateSize() const override;

    bool AddAssetToDownloadList(const CYIString &assetName, const CYIRuntimeTypeInfo &assetTypeInfo);

    void RemoveAssetFromDownloadList(const CYIString &assetName);

    std::shared_ptr<CYIAsset> GetAsset(const CYIString &assetName) const;

    void ClearData();

    std::vector<CYIString> GetAssetList() const;

    const CYIAssetManifest &GetAssetManifest() const;

    bool IsManifestDownloaded() const;

    bool IsAssetInDownloadList(const CYIString &assetName) const;

    CYISignal<const CYIUrl &> AssetDownloadCompleted;

    CYISignal<const CYIUrl & /*catalog*/, const FAILURE_TYPE, const CYIUrl & /*asset*/> AssetDownloadFailed;

    CYISignal<const CYIUrl &, const FAILURE_TYPE> ManifestDownloadFailed;

    CYISignal<const CYIUrl &> DownloadCancelled;

    CYISignal<const CYIUrl &> ManifestDownloadCompleted;

protected:
    CYIRemoteAssetCatalog(const CYIString &name);

    const std::vector<uint8_t> &GetData(const CYIString &assetName) const;

    void OnManifestDownloadCompleted(const std::shared_ptr<CYIHTTPRequest> &pRequest, const std::shared_ptr<CYIHTTPResponse> &pResponse, bool bCachedResponse);

    void OnManifestDownloadFailed(const std::shared_ptr<CYIHTTPRequest> &pRequest, const HTTP_STATUS_CODE statusCode, const CYIString &errorMessage);

    void OnAssetDownloadCompleted(const CYIUrl &url);

    void OnAssetDownloadFailed(CYIRemoteAssetDownloadHelper::FAILURE_TYPE eFailureType, const CYIUrl &url);

    std::shared_ptr<CYIAsset> DecodeAsset(const CYIString &path, CYIAssetLoadParams *pLoadParams = nullptr) const;

    CYIUrl GetAssetDownloadURL(const CYIString &assetName, const CYIRuntimeTypeInfo &typeInfo) const;

    bool QueueTemplateDependenciesForDownload(const CYIString &assetName);

private:
    struct AssetDownloadInfo
    {
        AssetDownloadInfo(const std::shared_ptr<CYIRemoteAssetDownloadHelper> &pDownloadHelper, const CYIRuntimeTypeInfo &assetType);

        std::shared_ptr<CYIRemoteAssetDownloadHelper> m_pDownloadHelper;
        const CYIRuntimeTypeInfo &m_AssetType;
    };

    void FetchAssetsFromManifest();

    bool IsAssetInCatalog(const CYIString &assetName, const CYIRuntimeTypeInfo &assetTypeInfo) const;

    uint64_t m_uCatalogID;
    CYIUrl m_Url;
    CYIAssetManifest m_manifest;
    std::shared_ptr<CYIHTTPRequest> m_pManifestDownloadRequest;
    std::map<CYIString, AssetDownloadInfo> m_assetsData;
    bool m_bManifestDowloaded;

    YI_DISALLOW_COPY_AND_ASSIGN(CYIRemoteAssetCatalog)
    YI_TYPE_BASES(CYIRemoteAssetCatalog, CYIAsset)
};

#endif // _YI_REMOTE_ASSET_CATALOG_H_