217 lines
6.8 KiB
C++
217 lines
6.8 KiB
C++
/**
|
|
* @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
|
|
|
|
#include "llxmlnode.h"
|
|
|
|
extern const char* DEFAULT_LOGIN_PAGE;
|
|
//Kokua: for llviewernetwork_test
|
|
#define KNOWN_GRIDS_SIZE 3
|
|
#define AGNI "Second Life"
|
|
#define ADITI "Second Life Beta"
|
|
|
|
#define GRID_VALUE "name"
|
|
#define GRID_ID_VALUE "grid_login_id"
|
|
// <AW opensim>
|
|
#define GRID_LABEL_VALUE "gridname"
|
|
#define GRID_NICK_VALUE "gridnick"
|
|
#define GRID_LOGIN_URI_VALUE "loginuri"
|
|
#define GRID_HELPER_URI_VALUE "helperuri"
|
|
#define GRID_LOGIN_PAGE_VALUE "loginpage"
|
|
#define GRID_IS_FAVORITE_VALUE "favorite"
|
|
#define GRID_REGISTER_NEW_ACCOUNT "register"
|
|
#define GRID_FORGOT_PASSWORD "password"
|
|
// </AW opensim>
|
|
#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"
|
|
|
|
// <AW opensim>
|
|
struct GridEntry
|
|
{
|
|
LLSD grid;
|
|
LLXMLNodePtr info_root;
|
|
bool set_current;
|
|
std::string last_http_error;
|
|
};
|
|
|
|
class LLInvalidGridName
|
|
{
|
|
public:
|
|
LLInvalidGridName(std::string grid) : mGrid(grid)
|
|
{
|
|
}
|
|
protected:
|
|
std::string mGrid;
|
|
};
|
|
// </AW opensim>
|
|
|
|
/**
|
|
* @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:
|
|
// <AW opensim>
|
|
typedef enum
|
|
{
|
|
FETCH,
|
|
FETCHTEMP,
|
|
SYSTEM,
|
|
RETRY,
|
|
LOCAL,
|
|
FINISH,
|
|
TRYLEGACY,
|
|
FAIL
|
|
} AddState;
|
|
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();
|
|
~LLGridManager();
|
|
|
|
// <AW opensim>
|
|
void initGrids();
|
|
void initSystemGrids();
|
|
void initGridList(std::string grid_file, AddState state);
|
|
void initCmdLineGrids();
|
|
|
|
// grid list management
|
|
bool isReadyToLogin(){return mReadyToLogin;}
|
|
void incResponderCount(){++mResponderCount;}
|
|
void decResponderCount(){--mResponderCount;}
|
|
void gridInfoResponderCB(GridEntry* grid_data);
|
|
// add a grid to the list of grids
|
|
void addGrid(GridEntry* grid_info, AddState state);
|
|
|
|
// 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);
|
|
|
|
// this was getGridInfo - renamed to avoid ambiguity with the OpenSim grid_info
|
|
void getGridData(const std::string& grid, LLSD &grid_info);
|
|
void getGridData(LLSD &grid_info) { getGridData(mGrid, grid_info); }
|
|
// </AW opensim>
|
|
|
|
// 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]; }
|
|
|
|
// get location slurl base for the given region within the selected grid
|
|
std::string getSLURLBase(const std::string& grid);
|
|
std::string getSLURLBase() { return getSLURLBase(mGrid); }
|
|
|
|
// get app slurl base for the given region within the selected grid
|
|
std::string getAppSLURLBase(const std::string& grid);
|
|
std::string getAppSLURLBase() { return getAppSLURLBase(mGrid); }
|
|
std::string getGridByLabel( const std::string &grid_label, bool case_sensitive = false);
|
|
|
|
// <AW opensim>
|
|
std::string getGridByProbing( const std::string &probe_for, bool case_sensitive = false);
|
|
std::string getGridByGridNick( const std::string &grid_nick, bool case_sensitive = false);
|
|
std::string getGridByHostName( const std::string &host_name, bool case_sensitive = false);
|
|
std::string getGridByAttribute(const std::string &attribute, const std::string &attribute_value, bool case_sensitive );
|
|
// </AW opensim>
|
|
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
|
|
// <AW: opensim>
|
|
// Not used anymore, keeping commented as reminder for merge conflicts
|
|
//void setFavorite() { mGridList[mGrid][GRID_IS_FAVORITE_VALUE] = TRUE; }
|
|
// </AW opensim>
|
|
|
|
// <AW opensim>
|
|
bool isInSLMain();
|
|
bool isInSLBeta();
|
|
bool isInOpenSim();
|
|
void saveGridList();
|
|
int mGridEntries;
|
|
// </AW opensim>
|
|
void clearFavorites();
|
|
|
|
protected:
|
|
|
|
void updateIsInProductionGrid();
|
|
|
|
// helper function for adding the predefined grids
|
|
void addSystemGrid(const std::string& label,
|
|
const std::string& name,
|
|
const std::string& nick,
|
|
const std::string& login,
|
|
const std::string& helper,
|
|
const std::string& login_page);
|
|
|
|
|
|
std::string mGrid;
|
|
std::string mGridFile;
|
|
LLSD mGridList;
|
|
// <AW opensim>
|
|
bool mIsInSLMain;
|
|
bool mIsInSLBeta;
|
|
bool mIsInOpenSim;
|
|
int mResponderCount;
|
|
bool mReadyToLogin;
|
|
bool mCommandLineDone;
|
|
// </AW opensim>
|
|
};
|
|
|
|
const S32 MAC_ADDRESS_BYTES = 6;
|
|
|
|
#endif
|