Imported existing code
This commit is contained in:
Hazim Gazov
489
indra/llmessage/llassetstorage.h
Normal file
489
indra/llmessage/llassetstorage.h
Normal file
@@ -0,0 +1,489 @@
|
||||
/**
|
||||
* @file llassetstorage.h
|
||||
* @brief definition of LLAssetStorage class which allows simple
|
||||
* up/downloads of uuid,type asets
|
||||
*
|
||||
* $LicenseInfo:firstyear=2001&license=viewergpl$
|
||||
*
|
||||
* Copyright (c) 2001-2009, Linden Research, Inc.
|
||||
*
|
||||
* Second Life Viewer Source Code
|
||||
* The source code in this file ("Source Code") is provided by Linden Lab
|
||||
* to you under the terms of the GNU General Public License, version 2.0
|
||||
* ("GPL"), unless you have obtained a separate licensing agreement
|
||||
* ("Other License"), formally executed by you and Linden Lab. Terms of
|
||||
* the GPL can be found in doc/GPL-license.txt in this distribution, or
|
||||
* online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
|
||||
*
|
||||
* There are special exceptions to the terms and conditions of the GPL as
|
||||
* it is applied to this Source Code. View the full text of the exception
|
||||
* in the file doc/FLOSS-exception.txt in this software distribution, or
|
||||
* online at
|
||||
* http://secondlifegrid.net/programs/open_source/licensing/flossexception
|
||||
*
|
||||
* By copying, modifying or distributing this software, you acknowledge
|
||||
* that you have read and understood your obligations described above,
|
||||
* and agree to abide by those obligations.
|
||||
*
|
||||
* ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
|
||||
* WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
|
||||
* COMPLETENESS OR PERFORMANCE.
|
||||
* $/LicenseInfo$
|
||||
*/
|
||||
|
||||
#ifndef LL_LLASSETSTORAGE_H
|
||||
#define LL_LLASSETSTORAGE_H
|
||||
|
||||
#include <string>
|
||||
|
||||
#include "lluuid.h"
|
||||
#include "lltimer.h"
|
||||
#include "llnamevalue.h"
|
||||
#include "llhost.h"
|
||||
#include "stdenums.h" // for EDragAndDropType
|
||||
#include "lltransfermanager.h" // For LLTSCode enum
|
||||
#include "llassettype.h"
|
||||
#include "llstring.h"
|
||||
#include "llextendedstatus.h"
|
||||
|
||||
// Forward declarations
|
||||
class LLMessageSystem;
|
||||
class LLXferManager;
|
||||
class LLAssetStorage;
|
||||
class LLVFS;
|
||||
class LLSD;
|
||||
|
||||
// anything that takes longer than this to download will abort.
|
||||
// HTTP Uploads also timeout if they take longer than this.
|
||||
const F32 LL_ASSET_STORAGE_TIMEOUT = 5 * 60.0f;
|
||||
|
||||
class LLAssetInfo
|
||||
{
|
||||
protected:
|
||||
std::string mDescription;
|
||||
std::string mName;
|
||||
|
||||
public:
|
||||
LLUUID mUuid;
|
||||
LLTransactionID mTransactionID;
|
||||
LLUUID mCreatorID;
|
||||
LLAssetType::EType mType;
|
||||
|
||||
LLAssetInfo( void );
|
||||
LLAssetInfo( const LLUUID& object_id, const LLUUID& creator_id,
|
||||
LLAssetType::EType type, const char* name, const char* desc );
|
||||
LLAssetInfo( const LLNameValue& nv );
|
||||
|
||||
const std::string& getName( void ) const { return mName; }
|
||||
const std::string& getDescription( void ) const { return mDescription; }
|
||||
void setName( const std::string& name );
|
||||
void setDescription( const std::string& desc );
|
||||
|
||||
// Assets (aka potential inventory items) can be applied to an
|
||||
// object in the world. We'll store that as a string name value
|
||||
// pair where the name encodes part of asset info, and the value
|
||||
// the rest. LLAssetInfo objects will be responsible for parsing
|
||||
// the meaning out froman LLNameValue object. See the inventory
|
||||
// design docs for details.
|
||||
void setFromNameValue( const LLNameValue& nv );
|
||||
};
|
||||
|
||||
|
||||
class LLAssetRequest
|
||||
{
|
||||
public:
|
||||
LLAssetRequest(const LLUUID &uuid, const LLAssetType::EType at);
|
||||
virtual ~LLAssetRequest();
|
||||
|
||||
LLUUID getUUID() const { return mUUID; }
|
||||
LLAssetType::EType getType() const { return mType; }
|
||||
|
||||
void setUUID(const LLUUID& id) { mUUID = id; }
|
||||
void setType(LLAssetType::EType type) { mType = type; }
|
||||
void setTimeout (F64 timeout) { mTimeout = timeout; }
|
||||
|
||||
protected:
|
||||
LLUUID mUUID;
|
||||
LLAssetType::EType mType;
|
||||
|
||||
public:
|
||||
void (*mDownCallback)(LLVFS*, const LLUUID&, LLAssetType::EType, void *, S32, LLExtStat);
|
||||
void (*mUpCallback)(const LLUUID&, void *, S32, LLExtStat);
|
||||
void (*mInfoCallback)(LLAssetInfo *, void *, S32);
|
||||
|
||||
void *mUserData;
|
||||
LLHost mHost;
|
||||
BOOL mIsTemp;
|
||||
BOOL mIsLocal;
|
||||
BOOL mIsUserWaiting; // We don't want to try forever if a user is waiting for a result.
|
||||
F64 mTime; // Message system time
|
||||
F64 mTimeout; // Amount of time before timing out.
|
||||
BOOL mIsPriority;
|
||||
BOOL mDataSentInFirstPacket;
|
||||
BOOL mDataIsInVFS;
|
||||
LLUUID mRequestingAgentID; // Only valid for uploads from an agent
|
||||
|
||||
virtual LLSD getTerseDetails() const;
|
||||
virtual LLSD getFullDetails() const;
|
||||
};
|
||||
|
||||
template <class T>
|
||||
struct ll_asset_request_equal : public std::equal_to<T>
|
||||
{
|
||||
bool operator()(const T& x, const T& y) const
|
||||
{
|
||||
return ( x->getType() == y->getType()
|
||||
&& x->getUUID() == y->getUUID() );
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
class LLInvItemRequest
|
||||
{
|
||||
public:
|
||||
LLInvItemRequest(const LLUUID &uuid, const LLAssetType::EType at);
|
||||
virtual ~LLInvItemRequest();
|
||||
|
||||
LLUUID getUUID() const { return mUUID; }
|
||||
LLAssetType::EType getType() const { return mType; }
|
||||
|
||||
void setUUID(const LLUUID& id) { mUUID = id; }
|
||||
void setType(LLAssetType::EType type) { mType = type; }
|
||||
|
||||
protected:
|
||||
LLUUID mUUID;
|
||||
LLAssetType::EType mType;
|
||||
|
||||
public:
|
||||
void (*mDownCallback)(LLVFS*, const LLUUID&, LLAssetType::EType, void *, S32, LLExtStat);
|
||||
|
||||
void *mUserData;
|
||||
LLHost mHost;
|
||||
BOOL mIsTemp;
|
||||
F64 mTime; // Message system time
|
||||
BOOL mIsPriority;
|
||||
BOOL mDataSentInFirstPacket;
|
||||
BOOL mDataIsInVFS;
|
||||
|
||||
};
|
||||
|
||||
class LLEstateAssetRequest
|
||||
{
|
||||
public:
|
||||
LLEstateAssetRequest(const LLUUID &uuid, const LLAssetType::EType at, EstateAssetType et);
|
||||
virtual ~LLEstateAssetRequest();
|
||||
|
||||
LLUUID getUUID() const { return mUUID; }
|
||||
LLAssetType::EType getAType() const { return mAType; }
|
||||
|
||||
void setUUID(const LLUUID& id) { mUUID = id; }
|
||||
void setType(LLAssetType::EType type) { mAType = type; }
|
||||
|
||||
protected:
|
||||
LLUUID mUUID;
|
||||
LLAssetType::EType mAType;
|
||||
EstateAssetType mEstateAssetType;
|
||||
|
||||
public:
|
||||
void (*mDownCallback)(LLVFS*, const LLUUID&, LLAssetType::EType, void *, S32, LLExtStat);
|
||||
|
||||
void *mUserData;
|
||||
LLHost mHost;
|
||||
BOOL mIsTemp;
|
||||
F64 mTime; // Message system time
|
||||
BOOL mIsPriority;
|
||||
BOOL mDataSentInFirstPacket;
|
||||
BOOL mDataIsInVFS;
|
||||
|
||||
};
|
||||
|
||||
|
||||
// Map of known bad assets
|
||||
typedef std::map<LLUUID,U64,lluuid_less> toxic_asset_map_t;
|
||||
|
||||
typedef void (*LLGetAssetCallback)(LLVFS *vfs, const LLUUID &asset_id,
|
||||
LLAssetType::EType asset_type, void *user_data, S32 status, LLExtStat ext_status);
|
||||
|
||||
class LLTempAssetStorage
|
||||
{
|
||||
public:
|
||||
virtual ~LLTempAssetStorage() =0;
|
||||
virtual void addTempAssetData(const LLUUID& asset_id,
|
||||
const LLUUID& agent_id,
|
||||
const std::string& host_name) = 0;
|
||||
};
|
||||
|
||||
class LLAssetStorage : public LLTempAssetStorage
|
||||
{
|
||||
public:
|
||||
// VFS member is public because static child methods need it :(
|
||||
LLVFS *mVFS;
|
||||
typedef void (*LLStoreAssetCallback)(const LLUUID &asset_id, void *user_data, S32 status, LLExtStat ext_status);
|
||||
|
||||
enum ERequestType
|
||||
{
|
||||
RT_INVALID = -1,
|
||||
RT_DOWNLOAD = 0,
|
||||
RT_UPLOAD = 1,
|
||||
RT_LOCALUPLOAD = 2,
|
||||
RT_COUNT = 3
|
||||
};
|
||||
|
||||
protected:
|
||||
BOOL mShutDown;
|
||||
LLHost mUpstreamHost;
|
||||
|
||||
LLMessageSystem *mMessageSys;
|
||||
LLXferManager *mXferManager;
|
||||
|
||||
|
||||
typedef std::list<LLAssetRequest*> request_list_t;
|
||||
request_list_t mPendingDownloads;
|
||||
request_list_t mPendingUploads;
|
||||
request_list_t mPendingLocalUploads;
|
||||
|
||||
// Map of toxic assets - these caused problems when recently rezzed, so avoid them
|
||||
toxic_asset_map_t mToxicAssetMap; // Objects in this list are known to cause problems and are not loaded
|
||||
|
||||
public:
|
||||
LLAssetStorage(LLMessageSystem *msg, LLXferManager *xfer,
|
||||
LLVFS *vfs, const LLHost &upstream_host);
|
||||
|
||||
LLAssetStorage(LLMessageSystem *msg, LLXferManager *xfer,
|
||||
LLVFS *vfs);
|
||||
virtual ~LLAssetStorage();
|
||||
|
||||
void setUpstream(const LLHost &upstream_host);
|
||||
|
||||
virtual BOOL hasLocalAsset(const LLUUID &uuid, LLAssetType::EType type);
|
||||
|
||||
// public interface methods
|
||||
// note that your callback may get called BEFORE the function returns
|
||||
|
||||
virtual void getAssetData(const LLUUID uuid, LLAssetType::EType atype, LLGetAssetCallback cb, void *user_data, BOOL is_priority = FALSE);
|
||||
|
||||
/*
|
||||
* TransactionID version
|
||||
* Viewer needs the store_local
|
||||
*/
|
||||
virtual void storeAssetData(
|
||||
const LLTransactionID& tid,
|
||||
LLAssetType::EType atype,
|
||||
LLStoreAssetCallback callback,
|
||||
void* user_data,
|
||||
bool temp_file = false,
|
||||
bool is_priority = false,
|
||||
bool store_local = false,
|
||||
bool user_waiting= false,
|
||||
F64 timeout=LL_ASSET_STORAGE_TIMEOUT);
|
||||
|
||||
/*
|
||||
* AssetID version
|
||||
* Sim needs both store_local and requesting_agent_id.
|
||||
*/
|
||||
virtual void storeAssetData(
|
||||
const LLUUID& asset_id,
|
||||
LLAssetType::EType asset_type,
|
||||
LLStoreAssetCallback callback,
|
||||
void* user_data,
|
||||
bool temp_file = false,
|
||||
bool is_priority = false,
|
||||
bool store_local = false,
|
||||
const LLUUID& requesting_agent_id = LLUUID::null,
|
||||
bool user_waiting= false,
|
||||
F64 timeout=LL_ASSET_STORAGE_TIMEOUT);
|
||||
|
||||
virtual void checkForTimeouts();
|
||||
|
||||
void getEstateAsset(const LLHost &object_sim, const LLUUID &agent_id, const LLUUID &session_id,
|
||||
const LLUUID &asset_id, LLAssetType::EType atype, EstateAssetType etype,
|
||||
LLGetAssetCallback callback, void *user_data, BOOL is_priority);
|
||||
|
||||
void getInvItemAsset(const LLHost &object_sim,
|
||||
const LLUUID &agent_id, const LLUUID &session_id,
|
||||
const LLUUID &owner_id, const LLUUID &task_id, const LLUUID &item_id,
|
||||
const LLUUID &asset_id, LLAssetType::EType atype,
|
||||
LLGetAssetCallback cb, void *user_data, BOOL is_priority = FALSE); // Get a particular inventory item.
|
||||
|
||||
// Check if an asset is in the toxic map. If it is, the entry is updated
|
||||
BOOL isAssetToxic( const LLUUID& uuid );
|
||||
|
||||
// Clean the toxic asset list, remove old entries
|
||||
void flushOldToxicAssets( BOOL force_it );
|
||||
|
||||
// Add an item to the toxic asset map
|
||||
void markAssetToxic( const LLUUID& uuid );
|
||||
|
||||
protected:
|
||||
virtual LLSD getPendingDetails(const request_list_t* requests,
|
||||
LLAssetType::EType asset_type,
|
||||
const std::string& detail_prefix) const;
|
||||
|
||||
virtual LLSD getPendingRequest(const request_list_t* requests,
|
||||
LLAssetType::EType asset_type,
|
||||
const LLUUID& asset_id) const;
|
||||
|
||||
virtual bool deletePendingRequest(request_list_t* requests,
|
||||
LLAssetType::EType asset_type,
|
||||
const LLUUID& asset_id);
|
||||
|
||||
public:
|
||||
static const LLAssetRequest* findRequest(const request_list_t* requests,
|
||||
LLAssetType::EType asset_type,
|
||||
const LLUUID& asset_id);
|
||||
static LLAssetRequest* findRequest(request_list_t* requests,
|
||||
LLAssetType::EType asset_type,
|
||||
const LLUUID& asset_id);
|
||||
|
||||
request_list_t* getRequestList(ERequestType rt);
|
||||
const request_list_t* getRequestList(ERequestType rt) const;
|
||||
static std::string getRequestName(ERequestType rt);
|
||||
|
||||
S32 getNumPendingDownloads() const;
|
||||
S32 getNumPendingUploads() const;
|
||||
S32 getNumPendingLocalUploads();
|
||||
S32 getNumPending(ERequestType rt) const;
|
||||
|
||||
virtual LLSD getPendingDetails(ERequestType rt,
|
||||
LLAssetType::EType asset_type,
|
||||
const std::string& detail_prefix) const;
|
||||
|
||||
virtual LLSD getPendingRequest(ERequestType rt,
|
||||
LLAssetType::EType asset_type,
|
||||
const LLUUID& asset_id) const;
|
||||
|
||||
virtual bool deletePendingRequest(ERequestType rt,
|
||||
LLAssetType::EType asset_type,
|
||||
const LLUUID& asset_id);
|
||||
|
||||
|
||||
// download process callbacks
|
||||
static void downloadCompleteCallback(
|
||||
S32 result,
|
||||
const LLUUID& file_id,
|
||||
LLAssetType::EType file_type,
|
||||
void* user_data, LLExtStat ext_status);
|
||||
static void downloadEstateAssetCompleteCallback(
|
||||
S32 result,
|
||||
const LLUUID& file_id,
|
||||
LLAssetType::EType file_type,
|
||||
void* user_data, LLExtStat ext_status);
|
||||
static void downloadInvItemCompleteCallback(
|
||||
S32 result,
|
||||
const LLUUID& file_id,
|
||||
LLAssetType::EType file_type,
|
||||
void* user_data, LLExtStat ext_status);
|
||||
|
||||
// upload process callbacks
|
||||
static void uploadCompleteCallback(const LLUUID&, void *user_data, S32 result, LLExtStat ext_status);
|
||||
static void processUploadComplete(LLMessageSystem *msg, void **this_handle);
|
||||
|
||||
// debugging
|
||||
static const char* getErrorString( S32 status );
|
||||
|
||||
// deprecated file-based methods
|
||||
void getAssetData(const LLUUID uuid, LLAssetType::EType type, void (*callback)(const char*, const LLUUID&, void *, S32, LLExtStat), void *user_data, BOOL is_priority = FALSE);
|
||||
|
||||
/*
|
||||
* AssetID version.
|
||||
*/
|
||||
virtual void storeAssetData(
|
||||
const std::string& filename,
|
||||
const LLUUID& asset_id,
|
||||
LLAssetType::EType type,
|
||||
LLStoreAssetCallback callback,
|
||||
void* user_data,
|
||||
bool temp_file = false,
|
||||
bool is_priority = false,
|
||||
bool user_waiting = false,
|
||||
F64 timeout = LL_ASSET_STORAGE_TIMEOUT);
|
||||
|
||||
/*
|
||||
* TransactionID version
|
||||
*/
|
||||
virtual void storeAssetData(
|
||||
const std::string& filename,
|
||||
const LLTransactionID &transaction_id,
|
||||
LLAssetType::EType type,
|
||||
LLStoreAssetCallback callback,
|
||||
void *user_data,
|
||||
bool temp_file = false,
|
||||
bool is_priority = false,
|
||||
bool user_waiting = false,
|
||||
F64 timeout = LL_ASSET_STORAGE_TIMEOUT);
|
||||
|
||||
static void legacyGetDataCallback(LLVFS *vfs, const LLUUID &uuid, LLAssetType::EType, void *user_data, S32 status, LLExtStat ext_status);
|
||||
static void legacyStoreDataCallback(const LLUUID &uuid, void *user_data, S32 status, LLExtStat ext_status);
|
||||
|
||||
// Temp assets are stored on sim nodes, they have agent ID and location data associated with them.
|
||||
// This is a no-op for non-http asset systems
|
||||
virtual void addTempAssetData(const LLUUID& asset_id, const LLUUID& agent_id, const std::string& host_name);
|
||||
virtual BOOL hasTempAssetData(const LLUUID& texture_id) const;
|
||||
virtual std::string getTempAssetHostName(const LLUUID& texture_id) const;
|
||||
virtual LLUUID getTempAssetAgentID(const LLUUID& texture_id) const;
|
||||
virtual void removeTempAssetData(const LLUUID& asset_id);
|
||||
virtual void removeTempAssetDataByAgentID(const LLUUID& agent_id);
|
||||
// Pass LLUUID::null for all
|
||||
virtual void dumpTempAssetData(const LLUUID& avatar_id) const;
|
||||
virtual void clearTempAssetData();
|
||||
|
||||
// add extra methods to handle metadata
|
||||
|
||||
protected:
|
||||
void _cleanupRequests(BOOL all, S32 error);
|
||||
void _callUploadCallbacks(const LLUUID &uuid, const LLAssetType::EType asset_type, BOOL success, LLExtStat ext_status);
|
||||
|
||||
virtual void _queueDataRequest(const LLUUID& uuid, LLAssetType::EType type,
|
||||
void (*callback)(LLVFS *vfs, const LLUUID&, LLAssetType::EType, void *, S32, LLExtStat),
|
||||
void *user_data, BOOL duplicate,
|
||||
BOOL is_priority);
|
||||
|
||||
private:
|
||||
void _init(LLMessageSystem *msg,
|
||||
LLXferManager *xfer,
|
||||
LLVFS *vfs,
|
||||
const LLHost &upstream_host);
|
||||
|
||||
protected:
|
||||
enum EMetricResult
|
||||
{
|
||||
// Static valued enums for #dw readability - please copy this
|
||||
// declaration to them on updates -- source in llassetstorage.h
|
||||
MR_INVALID = -1, // Makes no sense
|
||||
MR_OKAY = 0, // Success - no metric normally
|
||||
MR_ZERO_SIZE = 1, // Zero size asset
|
||||
MR_BAD_FUNCTION = 2, // Tried to use a virtual base (PROGRAMMER ERROR)
|
||||
MR_FILE_NONEXIST = 3, // Old format store call - source file does not exist
|
||||
MR_NO_FILENAME = 4, // Old format store call - source filename is NULL/0-length
|
||||
MR_NO_UPSTREAM = 5, // Upstream provider is missing
|
||||
MR_VFS_CORRUPTION = 6 // VFS is corrupt - too-large or mismatched stated/returned sizes
|
||||
};
|
||||
|
||||
static class LLMetrics *metric_recipient;
|
||||
|
||||
static void reportMetric( const LLUUID& asset_id, const LLAssetType::EType asset_type, const std::string& filename,
|
||||
const LLUUID& agent_id, S32 asset_size, EMetricResult result,
|
||||
const char* file, const S32 line, const std::string& message );
|
||||
public:
|
||||
static void setMetricRecipient( LLMetrics *recip )
|
||||
{
|
||||
metric_recipient = recip;
|
||||
}
|
||||
};
|
||||
|
||||
////////////////////////////////////////////////////////////////////////
|
||||
// Wrappers to replicate deprecated API
|
||||
////////////////////////////////////////////////////////////////////////
|
||||
|
||||
class LLLegacyAssetRequest
|
||||
{
|
||||
public:
|
||||
void (*mDownCallback)(const char *, const LLUUID&, void *, S32, LLExtStat);
|
||||
LLAssetStorage::LLStoreAssetCallback mUpCallback;
|
||||
|
||||
void *mUserData;
|
||||
};
|
||||
|
||||
extern LLAssetStorage *gAssetStorage;
|
||||
extern const LLUUID CATEGORIZE_LOST_AND_FOUND_ID;
|
||||
#endif
|
||||
Reference in New Issue
Block a user