mirror of https://github.com/axmolengine/axmol.git
342 lines
11 KiB
C++
342 lines
11 KiB
C++
/****************************************************************************
|
|
Copyright (c) 2013 cocos2d-x.org
|
|
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
|
|
|
|
https://axys1.github.io/
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
****************************************************************************/
|
|
|
|
#ifndef __AssetsManagerEx__
|
|
#define __AssetsManagerEx__
|
|
|
|
#include <string>
|
|
#include <unordered_map>
|
|
#include <vector>
|
|
|
|
#include "base/CCEventDispatcher.h"
|
|
#include "platform/CCFileUtils.h"
|
|
#include "network/CCDownloader.h"
|
|
|
|
#include "CCEventAssetsManagerEx.h"
|
|
|
|
#include "Manifest.h"
|
|
#include "extensions/ExtensionMacros.h"
|
|
#include "extensions/ExtensionExport.h"
|
|
#include "rapidjson/document-wrapper.h"
|
|
|
|
struct zlib_filefunc_def_s;
|
|
|
|
NS_AX_EXT_BEGIN
|
|
|
|
/**
|
|
* @brief This class is used to auto update resources, such as pictures or scripts.
|
|
*/
|
|
class AX_EX_DLL AssetsManagerEx : public Ref
|
|
{
|
|
public:
|
|
//! Update states
|
|
enum class State
|
|
{
|
|
UNCHECKED,
|
|
PREDOWNLOAD_VERSION,
|
|
DOWNLOADING_VERSION,
|
|
VERSION_LOADED,
|
|
PREDOWNLOAD_MANIFEST,
|
|
DOWNLOADING_MANIFEST,
|
|
MANIFEST_LOADED,
|
|
NEED_UPDATE,
|
|
UPDATING,
|
|
UNZIPPING,
|
|
UP_TO_DATE,
|
|
FAIL_TO_UPDATE
|
|
};
|
|
|
|
const static std::string VERSION_ID;
|
|
const static std::string MANIFEST_ID;
|
|
|
|
/** @brief Create function for creating a new AssetsManagerEx
|
|
@param manifestUrl The url for the local manifest file
|
|
@param storagePath The storage path for downloaded assets
|
|
@warning The cached manifest in your storage path have higher priority and will be searched first,
|
|
only if it doesn't exist, AssetsManagerEx will use the given manifestUrl.
|
|
*/
|
|
static AssetsManagerEx* create(std::string_view manifestUrl, std::string_view storagePath);
|
|
|
|
/** @brief Check out if there is a new version of manifest.
|
|
* You may use this method before updating, then let user determine whether
|
|
* he wants to update resources.
|
|
*/
|
|
void checkUpdate();
|
|
|
|
/** @brief Update with the current local manifest.
|
|
*/
|
|
void update();
|
|
|
|
/** @brief Reupdate all failed assets under the current AssetsManagerEx context
|
|
*/
|
|
void downloadFailedAssets();
|
|
|
|
/** @brief Gets the current update state.
|
|
*/
|
|
State getState() const;
|
|
|
|
/** @brief Gets storage path.
|
|
*/
|
|
std::string_view getStoragePath() const;
|
|
|
|
/** @brief Function for retrieving the local manifest object
|
|
*/
|
|
const Manifest* getLocalManifest() const;
|
|
|
|
/** @brief Function for retrieving the remote manifest object
|
|
*/
|
|
const Manifest* getRemoteManifest() const;
|
|
|
|
/** @brief Function for retrieving the max concurrent task count
|
|
*/
|
|
const int getMaxConcurrentTask() const { return _maxConcurrentTask; };
|
|
|
|
/** @brief Function for setting the max concurrent task count
|
|
*/
|
|
void setMaxConcurrentTask(const int max) { _maxConcurrentTask = max; };
|
|
|
|
/** @brief Set the handle function for comparing manifests versions
|
|
* @param handle The compare function
|
|
*/
|
|
void setVersionCompareHandle(const std::function<int(std::string_view versionA, std::string_view versionB)>& handle)
|
|
{
|
|
_versionCompareHandle = handle;
|
|
};
|
|
|
|
/** @brief Set the verification function for checking whether downloaded asset is correct, e.g. using md5
|
|
* verification
|
|
* @param callback The verify callback function
|
|
*/
|
|
void setVerifyCallback(const std::function<bool(std::string_view path, Manifest::Asset asset)>& callback)
|
|
{
|
|
_verifyCallback = callback;
|
|
};
|
|
|
|
AssetsManagerEx(std::string_view manifestUrl, std::string_view storagePath);
|
|
|
|
virtual ~AssetsManagerEx();
|
|
|
|
protected:
|
|
std::string_view basename(std::string_view path) const;
|
|
|
|
std::string get(std::string_view key) const;
|
|
|
|
void initManifests(std::string_view manifestUrl);
|
|
|
|
void loadLocalManifest(std::string_view manifestUrl);
|
|
|
|
void prepareLocalManifest();
|
|
|
|
void setStoragePath(std::string_view storagePath);
|
|
|
|
void adjustPath(std::string& path);
|
|
|
|
void dispatchUpdateEvent(EventAssetsManagerEx::EventCode code,
|
|
std::string_view message = "",
|
|
std::string_view assetId = "",
|
|
int curle_code = 0,
|
|
int curlm_code = 0);
|
|
|
|
void downloadVersion();
|
|
void parseVersion();
|
|
void downloadManifest();
|
|
void parseManifest();
|
|
void startUpdate();
|
|
void updateSucceed();
|
|
bool decompress(std::string_view filename);
|
|
void decompressDownloadedZip(std::string_view customId, std::string_view storagePath);
|
|
|
|
/** @brief Update a list of assets under the current AssetsManagerEx context
|
|
*/
|
|
void updateAssets(const DownloadUnits& assets);
|
|
|
|
/** @brief Retrieve all failed assets during the last update
|
|
*/
|
|
const DownloadUnits& getFailedAssets() const;
|
|
|
|
/** @brief Function for destroying the downloaded version file and manifest file
|
|
*/
|
|
void destroyDownloadedVersion();
|
|
|
|
/** @brief Download items in queue with max concurrency setting
|
|
*/
|
|
void queueDowload();
|
|
|
|
void fileError(std::string_view identifier,
|
|
std::string_view errorStr,
|
|
int errorCode = 0,
|
|
int errorCodeInternal = 0);
|
|
|
|
void fileSuccess(std::string_view customId, std::string_view storagePath);
|
|
|
|
/** @brief Call back function for error handling,
|
|
the error will then be reported to user's listener registed in addUpdateEventListener
|
|
@param error The error object contains ErrorCode, message, asset url, asset key
|
|
@warning AssetsManagerEx internal use only
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual void onError(const network::DownloadTask& task,
|
|
int errorCode,
|
|
int errorCodeInternal,
|
|
std::string_view errorStr);
|
|
|
|
/** @brief Call back function for recording downloading percent of the current asset,
|
|
the progression will then be reported to user's listener registed in addUpdateProgressEventListener
|
|
@param total Total size to download for this asset
|
|
@param downloaded Total size already downloaded for this asset
|
|
@param url The url of this asset
|
|
@param customId The key of this asset
|
|
@warning AssetsManagerEx internal use only
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual void onProgress(double total, double downloaded, std::string_view url, std::string_view customId);
|
|
|
|
/** @brief Call back function for success of the current asset
|
|
the success event will then be send to user's listener registed in addUpdateEventListener
|
|
@param srcUrl The url of this asset
|
|
@param customId The key of this asset
|
|
@warning AssetsManagerEx internal use only
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual void onSuccess(std::string_view srcUrl, std::string_view storagePath, std::string_view customId);
|
|
|
|
private:
|
|
void batchDownload();
|
|
|
|
// Called when one DownloadUnits finished
|
|
void onDownloadUnitsFinished();
|
|
void fillZipFunctionOverrides(zlib_filefunc_def_s& zipFunctionOverrides);
|
|
|
|
//! The event of the current AssetsManagerEx in event dispatcher
|
|
std::string _eventName;
|
|
|
|
//! Reference to the global event dispatcher
|
|
EventDispatcher* _eventDispatcher;
|
|
//! Reference to the global file utils
|
|
FileUtils* _fileUtils;
|
|
|
|
//! State of update
|
|
State _updateState = State::UNCHECKED;
|
|
|
|
//! Downloader
|
|
std::shared_ptr<network::Downloader> _downloader;
|
|
|
|
//! The reference to the local assets
|
|
const hlookup::string_map<Manifest::Asset>* _assets = nullptr;
|
|
|
|
//! The path to store successfully downloaded version.
|
|
std::string _storagePath;
|
|
|
|
//! The path to store downloading version.
|
|
std::string _tempStoragePath;
|
|
|
|
//! The local path of cached temporary version file
|
|
std::string _tempVersionPath;
|
|
|
|
//! The local path of cached manifest file
|
|
std::string _cacheManifestPath;
|
|
|
|
//! The local path of cached temporary manifest file
|
|
std::string _tempManifestPath;
|
|
|
|
//! The path of local manifest file
|
|
std::string _manifestUrl;
|
|
|
|
//! Local manifest
|
|
Manifest* _localManifest = nullptr;
|
|
|
|
//! Local temporary manifest for download resuming
|
|
Manifest* _tempManifest = nullptr;
|
|
|
|
//! Remote manifest
|
|
Manifest* _remoteManifest = nullptr;
|
|
|
|
//! Whether user have requested to update
|
|
enum class UpdateEntry : char
|
|
{
|
|
NONE,
|
|
CHECK_UPDATE,
|
|
DO_UPDATE
|
|
};
|
|
|
|
UpdateEntry _updateEntry = UpdateEntry::NONE;
|
|
|
|
//! All assets unit to download
|
|
DownloadUnits _downloadUnits;
|
|
|
|
//! All failed units
|
|
DownloadUnits _failedUnits;
|
|
|
|
//! Download queue
|
|
std::vector<std::string> _queue;
|
|
|
|
//! Max concurrent task count for downloading
|
|
int _maxConcurrentTask = 32;
|
|
|
|
//! Current concurrent task count
|
|
int _currConcurrentTask = 0;
|
|
|
|
//! Download percent
|
|
float _percent = 0.f;
|
|
|
|
//! Download percent by file
|
|
float _percentByFile = 0.f;
|
|
|
|
//! Indicate whether the total size should be enabled
|
|
int _totalEnabled;
|
|
|
|
//! Indicate the number of file whose total size have been collected
|
|
int _sizeCollected;
|
|
|
|
//! Total file size need to be downloaded (sum of all file)
|
|
double _totalSize;
|
|
|
|
//! Downloaded size for each file
|
|
hlookup::string_map<double> _downloadedSize;
|
|
|
|
//! Total number of assets to download
|
|
int _totalToDownload = 0;
|
|
//! Total number of assets still waiting to be downloaded
|
|
int _totalWaitToDownload = 0;
|
|
//! Next target percent for saving the manifest file
|
|
float _nextSavePoint = 0.f;
|
|
|
|
//! Handle function to compare versions between different manifests
|
|
std::function<int(std::string_view versionA, std::string_view versionB)> _versionCompareHandle = nullptr;
|
|
|
|
//! Callback function to verify the downloaded assets
|
|
std::function<bool(std::string_view path, Manifest::Asset asset)> _verifyCallback = nullptr;
|
|
|
|
//! Marker for whether the assets manager is inited
|
|
bool _inited = false;
|
|
};
|
|
|
|
NS_AX_EXT_END
|
|
|
|
#endif /* defined(__AssetsManagerEx__) */
|