开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 游戏 > 游戏引擎 > 查看源码
llassetstorage.h
资源名称：snowglobe-src-viewer-2.0.0-r0.tar.gz　[点击查看]
上传用户：king477883
上传日期：2021-03-01
资源大小：9553k
文件大小：15k
源码类别：

游戏引擎

开发平台：

C++ Builder

llassetstorage.h：源码内容
  1. /** 
  2.  * @file llassetstorage.h
  3.  * @brief definition of LLAssetStorage class which allows simple
  4.  * up/downloads of uuid,type asets
  5.  *
  6.  * $LicenseInfo:firstyear=2001&license=viewergpl$
  7.  * 
  8.  * Copyright (c) 2001-2010, Linden Research, Inc.
  9.  * 
  10.  * Second Life Viewer Source Code
  11.  * The source code in this file ("Source Code") is provided by Linden Lab
  12.  * to you under the terms of the GNU General Public License, version 2.0
  13.  * ("GPL"), unless you have obtained a separate licensing agreement
  14.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  15.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  16.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  17.  * 
  18.  * There are special exceptions to the terms and conditions of the GPL as
  19.  * it is applied to this Source Code. View the full text of the exception
  20.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  21.  * online at
  22.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  23.  * 
  24.  * By copying, modifying or distributing this software, you acknowledge
  25.  * that you have read and understood your obligations described above,
  26.  * and agree to abide by those obligations.
  27.  * 
  28.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  29.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  30.  * COMPLETENESS OR PERFORMANCE.
  31.  * $/LicenseInfo$
  32.  */
  34. #ifndef LL_LLASSETSTORAGE_H
  35. #define LL_LLASSETSTORAGE_H
  37. #include <string>
  39. #include "lluuid.h"
  40. #include "lltimer.h"
  41. #include "llnamevalue.h"
  42. #include "llhost.h"
  43. #include "stdenums.h"  // for EDragAndDropType
  44. #include "lltransfermanager.h" // For LLTSCode enum
  45. #include "llassettype.h"
  46. #include "llstring.h"
  47. #include "llextendedstatus.h"
  49. // Forward declarations
  50. class LLMessageSystem;
  51. class LLXferManager;
  52. class LLAssetStorage;
  53. class LLVFS;
  54. class LLSD;
  56. // anything that takes longer than this to download will abort.
  57. // HTTP Uploads also timeout if they take longer than this.
  58. const F32 LL_ASSET_STORAGE_TIMEOUT = 5 * 60.0f;  
  60. class LLAssetInfo
  61. {
  62. protected:
  63. std::string mDescription;
  64. std::string mName;
  66. public:
  67. LLUUID mUuid;
  68. LLTransactionID mTransactionID;
  69. LLUUID mCreatorID;
  70. LLAssetType::EType mType;
  72. LLAssetInfo( void );
  73. LLAssetInfo( const LLUUID& object_id, const LLUUID& creator_id,
  74.  LLAssetType::EType type, const char* name, const char* desc );
  75. LLAssetInfo( const LLNameValue& nv );
  77. const std::string& getName( void ) const { return mName; }
  78. const std::string& getDescription( void ) const { return mDescription; } 
  79. void setName( const std::string& name );
  80. void setDescription( const std::string& desc );
  82. // Assets (aka potential inventory items) can be applied to an
  83. // object in the world. We'll store that as a string name value
  84. // pair where the name encodes part of asset info, and the value
  85. // the rest.  LLAssetInfo objects will be responsible for parsing
  86. // the meaning out froman LLNameValue object. See the inventory
  87. // design docs for details.
  88. void setFromNameValue( const LLNameValue& nv );
  89. };
  92. class LLAssetRequest
  93. {
  94. public:
  95. LLAssetRequest(const LLUUID &uuid, const LLAssetType::EType at);
  96. virtual ~LLAssetRequest();
  98. LLUUID getUUID() const { return mUUID; }
  99. LLAssetType::EType getType() const { return mType; }
  101. void setUUID(const LLUUID& id) { mUUID = id; }
  102. void setType(LLAssetType::EType type) { mType = type; }
  103. void setTimeout (F64 timeout) { mTimeout = timeout; }
  105. protected:
  106. LLUUID mUUID;
  107. LLAssetType::EType mType;
  109. public:
  110. void (*mDownCallback)(LLVFS*, const LLUUID&, LLAssetType::EType, void *, S32, LLExtStat);
  111. void (*mUpCallback)(const LLUUID&, void *, S32, LLExtStat);
  112. void (*mInfoCallback)(LLAssetInfo *, void *, S32);
  114. void *mUserData;
  115. LLHost  mHost;
  116. BOOL mIsTemp;
  117. BOOL mIsLocal;
  118. BOOL mIsUserWaiting; // We don't want to try forever if a user is waiting for a result.
  119. F64 mTime; // Message system time
  120. F64 mTimeout; // Amount of time before timing out.
  121. BOOL    mIsPriority;
  122. BOOL mDataSentInFirstPacket;
  123. BOOL mDataIsInVFS;
  124. LLUUID mRequestingAgentID; // Only valid for uploads from an agent
  126. virtual LLSD getTerseDetails() const;
  127. virtual LLSD getFullDetails() const;
  128. };
  130. template <class T>
  131. struct ll_asset_request_equal : public std::equal_to<T>
  132. {
  133. bool operator()(const T& x, const T& y) const 
  134. { 
  135. return ( x->getType() == y->getType()
  136. && x->getUUID() == y->getUUID() );
  137. }
  138. };
  141. class LLInvItemRequest
  142. {
  143. public:
  144. LLInvItemRequest(const LLUUID &uuid, const LLAssetType::EType at);
  145. virtual ~LLInvItemRequest();
  147. LLUUID getUUID() const { return mUUID; }
  148. LLAssetType::EType getType() const { return mType; }
  150. void setUUID(const LLUUID& id) { mUUID = id; }
  151. void setType(LLAssetType::EType type) { mType = type; }
  153. protected:
  154. LLUUID mUUID;
  155. LLAssetType::EType mType;
  157. public:
  158. void (*mDownCallback)(LLVFS*, const LLUUID&, LLAssetType::EType, void *, S32, LLExtStat);
  160. void *mUserData;
  161. LLHost  mHost;
  162. BOOL mIsTemp;
  163. F64 mTime; // Message system time
  164. BOOL    mIsPriority;
  165. BOOL mDataSentInFirstPacket;
  166. BOOL mDataIsInVFS;
  168. };
  170. class LLEstateAssetRequest
  171. {
  172. public:
  173. LLEstateAssetRequest(const LLUUID &uuid, const LLAssetType::EType at, EstateAssetType et);
  174. virtual ~LLEstateAssetRequest();
  176. LLUUID getUUID() const { return mUUID; }
  177. LLAssetType::EType getAType() const { return mAType; }
  179. void setUUID(const LLUUID& id) { mUUID = id; }
  180. void setType(LLAssetType::EType type) { mAType = type; }
  182. protected:
  183. LLUUID mUUID;
  184. LLAssetType::EType mAType;
  185. EstateAssetType mEstateAssetType;
  187. public:
  188. void (*mDownCallback)(LLVFS*, const LLUUID&, LLAssetType::EType, void *, S32, LLExtStat);
  190. void *mUserData;
  191. LLHost  mHost;
  192. BOOL mIsTemp;
  193. F64 mTime; // Message system time
  194. BOOL    mIsPriority;
  195. BOOL mDataSentInFirstPacket;
  196. BOOL mDataIsInVFS;
  198. };
  201. // Map of known bad assets
  202. typedef std::map<LLUUID,U64,lluuid_less> toxic_asset_map_t;
  204. typedef void (*LLGetAssetCallback)(LLVFS *vfs, const LLUUID &asset_id,
  205.  LLAssetType::EType asset_type, void *user_data, S32 status, LLExtStat ext_status);
  207. class LLTempAssetStorage
  208. {
  209. public:
  210. virtual ~LLTempAssetStorage() =0;
  211. virtual void addTempAssetData(const LLUUID& asset_id,
  212.   const LLUUID& agent_id,
  213.   const std::string& host_name) = 0;
  214. };
  216. class LLAssetStorage : public LLTempAssetStorage
  217. {
  218. public:
  219. // VFS member is public because static child methods need it :(
  220. LLVFS *mVFS;
  221. typedef void (*LLStoreAssetCallback)(const LLUUID &asset_id, void *user_data, S32 status, LLExtStat ext_status);
  223. enum ERequestType
  224. {
  225. RT_INVALID = -1,
  226. RT_DOWNLOAD = 0,
  227. RT_UPLOAD = 1,
  228. RT_LOCALUPLOAD = 2,
  229. RT_COUNT = 3
  230. };
  232. protected:
  233. BOOL mShutDown;
  234. LLHost mUpstreamHost;
  236. LLMessageSystem *mMessageSys;
  237. LLXferManager *mXferManager;
  240. typedef std::list<LLAssetRequest*> request_list_t;
  241. request_list_t mPendingDownloads;
  242. request_list_t mPendingUploads;
  243. request_list_t mPendingLocalUploads;
  245. // Map of toxic assets - these caused problems when recently rezzed, so avoid them
  246. toxic_asset_map_t mToxicAssetMap; // Objects in this list are known to cause problems and are not loaded
  248. public:
  249. LLAssetStorage(LLMessageSystem *msg, LLXferManager *xfer,
  250.    LLVFS *vfs, const LLHost &upstream_host);
  252. LLAssetStorage(LLMessageSystem *msg, LLXferManager *xfer,
  253.    LLVFS *vfs);
  254. virtual ~LLAssetStorage();
  256. void setUpstream(const LLHost &upstream_host);
  258. virtual BOOL hasLocalAsset(const LLUUID &uuid, LLAssetType::EType type);
  260. // public interface methods
  261. // note that your callback may get called BEFORE the function returns
  263. virtual void getAssetData(const LLUUID uuid, LLAssetType::EType atype, LLGetAssetCallback cb, void *user_data, BOOL is_priority = FALSE);
  265. /*
  266.  * TransactionID version
  267.  * Viewer needs the store_local
  268.  */
  269. virtual void storeAssetData(
  270. const LLTransactionID& tid,
  271. LLAssetType::EType atype,
  272. LLStoreAssetCallback callback,
  273. void* user_data,
  274. bool temp_file = false,
  275. bool is_priority = false,
  276. bool store_local = false,
  277. bool user_waiting= false,
  278. F64 timeout=LL_ASSET_STORAGE_TIMEOUT);
  280. /*
  281.  * AssetID version
  282.  * Sim needs both store_local and requesting_agent_id.
  283.  */
  284. virtual void storeAssetData(
  285. const LLUUID& asset_id,
  286. LLAssetType::EType asset_type,
  287. LLStoreAssetCallback callback,
  288. void* user_data,
  289. bool temp_file = false,
  290. bool is_priority = false,
  291. bool store_local = false,
  292. const LLUUID& requesting_agent_id = LLUUID::null,
  293. bool user_waiting= false,
  294. F64 timeout=LL_ASSET_STORAGE_TIMEOUT);
  296. virtual void checkForTimeouts();
  298. void getEstateAsset(const LLHost &object_sim, const LLUUID &agent_id, const LLUUID &session_id,
  299. const LLUUID &asset_id, LLAssetType::EType atype, EstateAssetType etype,
  300.  LLGetAssetCallback callback, void *user_data, BOOL is_priority);
  302. void getInvItemAsset(const LLHost &object_sim,
  303.  const LLUUID &agent_id, const LLUUID &session_id,
  304.  const LLUUID &owner_id, const LLUUID &task_id, const LLUUID &item_id,
  305.  const LLUUID &asset_id, LLAssetType::EType atype,
  306.  LLGetAssetCallback cb, void *user_data, BOOL is_priority = FALSE); // Get a particular inventory item.
  308. // Check if an asset is in the toxic map.  If it is, the entry is updated
  309. BOOL isAssetToxic( const LLUUID& uuid );
  311. // Clean the toxic asset list, remove old entries
  312. void flushOldToxicAssets( BOOL force_it );
  314. // Add an item to the toxic asset map
  315. void markAssetToxic( const LLUUID& uuid );
  317. protected:
  318. virtual LLSD getPendingDetailsImpl(const request_list_t* requests,
  319.   LLAssetType::EType asset_type,
  320.   const std::string& detail_prefix) const;
  322. virtual LLSD getPendingRequestImpl(const request_list_t* requests,
  323. LLAssetType::EType asset_type,
  324. const LLUUID& asset_id) const;
  326. virtual bool deletePendingRequestImpl(request_list_t* requests,
  327. LLAssetType::EType asset_type,
  328. const LLUUID& asset_id);
  330. public:
  331. static const LLAssetRequest* findRequest(const request_list_t* requests,
  332. LLAssetType::EType asset_type,
  333. const LLUUID& asset_id);
  334. static LLAssetRequest* findRequest(request_list_t* requests,
  335. LLAssetType::EType asset_type,
  336. const LLUUID& asset_id);
  338. request_list_t* getRequestList(ERequestType rt);
  339. const request_list_t* getRequestList(ERequestType rt) const;
  340. static std::string getRequestName(ERequestType rt);
  342. S32 getNumPendingDownloads() const;
  343. S32 getNumPendingUploads() const;
  344. S32 getNumPendingLocalUploads();
  345. S32 getNumPending(ERequestType rt) const;
  347. virtual LLSD getPendingDetails(ERequestType rt,
  348.   LLAssetType::EType asset_type,
  349.   const std::string& detail_prefix) const;
  351. virtual LLSD getPendingRequest(ERequestType rt,
  352. LLAssetType::EType asset_type,
  353. const LLUUID& asset_id) const;
  355. virtual bool deletePendingRequest(ERequestType rt,
  356. LLAssetType::EType asset_type,
  357. const LLUUID& asset_id);
  360. // download process callbacks
  361. static void downloadCompleteCallback(
  362. S32 result,
  363. const LLUUID& file_id,
  364. LLAssetType::EType file_type,
  365. void* user_data, LLExtStat ext_status);
  366. static void downloadEstateAssetCompleteCallback(
  367. S32 result,
  368. const LLUUID& file_id,
  369. LLAssetType::EType file_type,
  370. void* user_data, LLExtStat ext_status);
  371. static void downloadInvItemCompleteCallback(
  372. S32 result,
  373. const LLUUID& file_id,
  374. LLAssetType::EType file_type,
  375. void* user_data, LLExtStat ext_status);
  377. // upload process callbacks
  378. static void uploadCompleteCallback(const LLUUID&, void *user_data, S32 result, LLExtStat ext_status);
  379. static void processUploadComplete(LLMessageSystem *msg, void **this_handle);
  381. // debugging
  382. static const char* getErrorString( S32 status );
  384. // deprecated file-based methods
  385. void getAssetData(const LLUUID uuid, LLAssetType::EType type, void (*callback)(const char*, const LLUUID&, void *, S32, LLExtStat), void *user_data, BOOL is_priority = FALSE);
  387. /*
  388.  * AssetID version.
  389.  */
  390. virtual void storeAssetData(
  391. const std::string& filename,
  392. const LLUUID& asset_id,
  393. LLAssetType::EType type,
  394. LLStoreAssetCallback callback,
  395. void* user_data,
  396. bool temp_file = false,
  397. bool is_priority = false,
  398. bool user_waiting = false,
  399. F64 timeout  = LL_ASSET_STORAGE_TIMEOUT);
  401. /*
  402.  * TransactionID version
  403.  */
  404. virtual void storeAssetData(
  405. const std::string& filename,
  406. const LLTransactionID &transaction_id,
  407. LLAssetType::EType type,
  408. LLStoreAssetCallback callback,
  409. void *user_data,
  410. bool temp_file = false,
  411. bool is_priority = false,
  412. bool user_waiting = false,
  413. F64 timeout  = LL_ASSET_STORAGE_TIMEOUT);
  415. static void legacyGetDataCallback(LLVFS *vfs, const LLUUID &uuid, LLAssetType::EType, void *user_data, S32 status, LLExtStat ext_status);
  416. static void legacyStoreDataCallback(const LLUUID &uuid, void *user_data, S32 status, LLExtStat ext_status);
  418. // Temp assets are stored on sim nodes, they have agent ID and location data associated with them.
  419. // This is a no-op for non-http asset systems
  420. virtual void addTempAssetData(const LLUUID& asset_id, const LLUUID& agent_id, const std::string& host_name);
  421. virtual BOOL hasTempAssetData(const LLUUID& texture_id) const;
  422. virtual std::string getTempAssetHostName(const LLUUID& texture_id) const;
  423. virtual LLUUID getTempAssetAgentID(const LLUUID& texture_id) const;
  424. virtual void removeTempAssetData(const LLUUID& asset_id);
  425. virtual void removeTempAssetDataByAgentID(const LLUUID& agent_id);
  426. // Pass LLUUID::null for all
  427. virtual void dumpTempAssetData(const LLUUID& avatar_id) const;
  428. virtual void clearTempAssetData();
  430. // add extra methods to handle metadata
  432. protected:
  433. void _cleanupRequests(BOOL all, S32 error);
  434. void _callUploadCallbacks(const LLUUID &uuid, const LLAssetType::EType asset_type, BOOL success, LLExtStat ext_status);
  436. virtual void _queueDataRequest(const LLUUID& uuid, LLAssetType::EType type,
  437.    void (*callback)(LLVFS *vfs, const LLUUID&, LLAssetType::EType, void *, S32, LLExtStat),
  438.    void *user_data, BOOL duplicate,
  439.    BOOL is_priority);
  441. private:
  442. void _init(LLMessageSystem *msg,
  443.    LLXferManager *xfer,
  444.    LLVFS *vfs,
  445.    const LLHost &upstream_host);
  447. protected:
  448. enum EMetricResult
  449. {
  450. // Static valued enums for #dw readability - please copy this
  451. // declaration to them on updates -- source in llassetstorage.h
  452. MR_INVALID = -1, // Makes no sense
  453. MR_OKAY = 0, // Success - no metric normally
  454. MR_ZERO_SIZE = 1, // Zero size asset
  455. MR_BAD_FUNCTION = 2, // Tried to use a virtual base (PROGRAMMER ERROR)
  456. MR_FILE_NONEXIST = 3, // Old format store call - source file does not exist
  457. MR_NO_FILENAME = 4, // Old format store call - source filename is NULL/0-length
  458. MR_NO_UPSTREAM = 5, // Upstream provider is missing
  459. MR_VFS_CORRUPTION = 6 // VFS is corrupt - too-large or mismatched stated/returned sizes
  460. };
  462. static class LLMetrics *metric_recipient;
  464. static void reportMetric( const LLUUID& asset_id, const LLAssetType::EType asset_type, const std::string& filename,
  465.   const LLUUID& agent_id, S32 asset_size, EMetricResult result,
  466.   const char* file, const S32 line, const std::string& message ); 
  467. public:
  468. static void setMetricRecipient( LLMetrics *recip )
  469. {
  470. metric_recipient = recip;
  471. }
  472. };
  474. ////////////////////////////////////////////////////////////////////////
  475. // Wrappers to replicate deprecated API
  476. ////////////////////////////////////////////////////////////////////////
  478. class LLLegacyAssetRequest
  479. {
  480. public:
  481. void (*mDownCallback)(const char *, const LLUUID&, void *, S32, LLExtStat);
  482. LLAssetStorage::LLStoreAssetCallback mUpCallback;
  484. void *mUserData;
  485. };
  487. extern LLAssetStorage *gAssetStorage;
  488. extern const LLUUID CATEGORIZE_LOST_AND_FOUND_ID;
  489. #endif