summaryrefslogtreecommitdiff
path: root/indra/newview/llinventorymodelbackgroundfetch.h
blob: 831ab80dba577ad6b645c0603493f85f781f2a0e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/** 
 * @file llinventorymodelbackgroundfetch.h
 * @brief LLInventoryModelBackgroundFetch class header file
 *
 * $LicenseInfo:firstyear=2002&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * 
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_LLINVENTORYMODELBACKGROUNDFETCH_H
#define LL_LLINVENTORYMODELBACKGROUNDFETCH_H

#include "llsingleton.h"
#include "lluuid.h"
#include "httpcommon.h"
#include "httprequest.h"
#include "httpoptions.h"
#include "httpheaders.h"
#include "httphandler.h"

//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Class LLInventoryModelBackgroundFetch
//
// This class handles background fetches, which are fetches of
// inventory folder.  Fetches can be recursive or not.
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
class LLInventoryModelBackgroundFetch : public LLSingleton<LLInventoryModelBackgroundFetch>
{
	LLSINGLETON(LLInventoryModelBackgroundFetch);
	~LLInventoryModelBackgroundFetch();
public:

    // Start background breadth-first fetching of inventory contents.
	// This gets triggered when performing a filter-search.
	void start(const LLUUID& cat_id = LLUUID::null, bool recursive = true);
    void scheduleFolderFetch(const LLUUID& cat_id, bool forced = false);
    void scheduleItemFetch(const LLUUID& item_id, bool forced = false);

    typedef boost::function<void()> nullary_func_t;
    // AIS3 only, Fetches folder and everithing links inside the folder point to
    // Intended for outfits
    void fetchFolderAndLinks(const LLUUID& cat_id, nullary_func_t callback);
    // AIS3 only
    void fetchCOF(nullary_func_t callback);

	bool folderFetchActive() const;
	bool isEverythingFetched() const; // completing the fetch once per session should be sufficient

	bool libraryFetchStarted() const;
	bool libraryFetchCompleted() const;
	bool libraryFetchInProgress() const;
	
	bool inventoryFetchStarted() const;
	bool inventoryFetchCompleted() const;
	bool inventoryFetchInProgress() const;

    void findLostItems();
    void incrFetchCount(S32 fetching);
    void incrFetchFolderCount(S32 fetching);

	bool isBulkFetchProcessingComplete() const;
	void setAllFoldersFetched();

    typedef boost::function<void()> folders_fetched_callback_t;
    boost::signals2::connection setFetchCompletionCallback(folders_fetched_callback_t cb);

	void addRequestAtFront(const LLUUID & id, bool recursive, bool is_category);
	void addRequestAtBack(const LLUUID & id, bool recursive, bool is_category);

protected:
    bool isFolderFetchProcessingComplete() const;

    typedef enum {
        FT_DEFAULT = 0,
        FT_FORCED, // request non-recursively even if already loaded
        FT_CONTENT_RECURSIVE, // request content recursively
        FT_FOLDER_AND_CONTENT, // request folder, then content recursively
        FT_RECURSIVE, // request everything recursively
    } EFetchType;
    struct FetchQueueInfo
    {
        FetchQueueInfo(const LLUUID& id, EFetchType recursive, bool is_category = true)
            : mUUID(id),
            mIsCategory(is_category),
            mFetchType(recursive)
        {}

        LLUUID mUUID;
        bool mIsCategory;
        EFetchType mFetchType;
    };
    typedef std::deque<FetchQueueInfo> fetch_queue_t;

    void onAISContentCalback(const LLUUID& request_id, const uuid_vec_t &content_ids, const LLUUID& response_id, EFetchType fetch_type);
    void onAISFolderCalback(const LLUUID &request_id, const LLUUID &response_id, EFetchType fetch_type);
    void bulkFetchViaAis();
    void bulkFetchViaAis(const FetchQueueInfo& fetch_info);
	void bulkFetch();

	void backgroundFetch();
	static void backgroundFetchCB(void*); // background fetch idle function

	bool fetchQueueContainsNoDescendentsOf(const LLUUID& cat_id) const;

private:
 	bool mRecursiveInventoryFetchStarted;
	bool mRecursiveLibraryFetchStarted;
    bool mRecursiveMarketplaceFetchStarted; // AIS3 specific
	bool mAllRecursiveFoldersFetched;
    typedef boost::signals2::signal<void()> folders_fetched_signal_t;
    folders_fetched_signal_t mFoldersFetchedSignal;

    bool mBackgroundFetchActive;
	bool mFolderFetchActive;
	S32 mFetchCount;
    S32 mLastFetchCount; // for debug
    S32 mFetchFolderCount;

	LLFrameTimer mFetchTimer;
	F32 mMinTimeBetweenFetches;
	fetch_queue_t mFetchFolderQueue;
    fetch_queue_t mFetchItemQueue;
    uuid_set_t mForceFetchSet;
    std::list<LLUUID> mExpectedFolderIds; // for debug, should this track time?
};

#endif // LL_LLINVENTORYMODELBACKGROUNDFETCH_H