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
146
147
148
149
150
|
/**
* @file llviewernetwork.h
* @author James Cook
* @brief Networking constants and globals for viewer.
*
* $LicenseInfo:firstyear=2006&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_LLVIEWERNETWORK_H
#define LL_LLVIEWERNETWORK_H
extern const char* DEFAULT_LOGIN_PAGE;
#define GRID_VALUE "name"
#define GRID_LABEL_VALUE "label"
#define GRID_ID_VALUE "grid_login_id"
#define GRID_LOGIN_URI_VALUE "login_uri"
#define GRID_HELPER_URI_VALUE "helper_uri"
#define GRID_LOGIN_PAGE_VALUE "login_page"
#define GRID_IS_SYSTEM_GRID_VALUE "system_grid"
#define GRID_IS_FAVORITE_VALUE "favorite"
#define MAINGRID "util.agni.lindenlab.com"
#define GRID_LOGIN_IDENTIFIER_TYPES "login_identifier_types"
// defines slurl formats associated with various grids.
// we need to continue to support existing forms, as slurls
// are shared between viewers that may not understand newer
// forms.
#define GRID_SLURL_BASE "slurl_base"
#define GRID_APP_SLURL_BASE "app_slurl_base"
class LLInvalidGridName
{
public:
LLInvalidGridName(std::string grid) : mGrid(grid)
{
}
protected:
std::string mGrid;
};
/**
* @brief A class to manage the grids available to the viewer
* including persistance. This class also maintains the currently
* selected grid.
*
**/
class LLGridManager : public LLSingleton<LLGridManager>
{
public:
// when the grid manager is instantiated, the default grids are automatically
// loaded, and the grids favorites list is loaded from the xml file.
LLGridManager(const std::string& grid_file);
LLGridManager();
~LLGridManager();
void initialize(const std::string& grid_file);
// grid list management
// add a grid to the list of grids
void addGrid(LLSD& grid_info);
// retrieve a map of grid-name <-> label
// by default only return the user visible grids
std::map<std::string, std::string> getKnownGrids(bool favorites_only=FALSE);
void getGridInfo(const std::string& grid, LLSD &grid_info);
// current grid management
// select a given grid as the current grid. If the grid
// is not a known grid, then it's assumed to be a dns name for the
// grid, and the various URIs will be automatically generated.
void setGridChoice(const std::string& grid);
std::string getGridLabel() { return mGridList[mGrid][GRID_LABEL_VALUE]; }
std::string getGrid() const { return mGrid; }
void getLoginURIs(std::vector<std::string>& uris);
std::string getHelperURI();
std::string getLoginPage();
std::string getGridLoginID() { return mGridList[mGrid][GRID_ID_VALUE]; }
std::string getLoginPage(const std::string& grid) { return mGridList[grid][GRID_LOGIN_PAGE_VALUE]; }
void getLoginIdentifierTypes(LLSD& idTypes) { idTypes = mGridList[mGrid][GRID_LOGIN_IDENTIFIER_TYPES]; }
// build a slurl for the given region within the selected grid
std::string getSLURLBase(const std::string& grid);
std::string getSLURLBase() { return getSLURLBase(mGrid); }
std::string getAppSLURLBase(const std::string& grid);
std::string getAppSLURLBase() { return getAppSLURLBase(mGrid); }
void getGridInfo(LLSD &grid_info) { getGridInfo(mGrid, grid_info); }
std::string getGridByLabel( const std::string &grid_label, bool case_sensitive = false);
bool isSystemGrid(const std::string& grid)
{
return mGridList.has(grid) &&
mGridList[grid].has(GRID_IS_SYSTEM_GRID_VALUE) &&
mGridList[grid][GRID_IS_SYSTEM_GRID_VALUE].asBoolean();
}
bool isSystemGrid() { return isSystemGrid(mGrid); }
// Mark this grid as a favorite that should be persisited on 'save'
// this is currently used to persist a grid after a successful login
void setFavorite() { mGridList[mGrid][GRID_IS_FAVORITE_VALUE] = TRUE; }
bool isInProductionGrid();
void saveFavorites();
void clearFavorites();
protected:
// helper function for adding the predefined grids
void addSystemGrid(const std::string& label,
const std::string& name,
const std::string& login,
const std::string& helper,
const std::string& login_page,
const std::string& login_id = "");
std::string mGrid;
std::string mGridFile;
LLSD mGridList;
};
const S32 MAC_ADDRESS_BYTES = 6;
#endif
|
