summaryrefslogtreecommitdiff
path: root/indra/newview/llslurl.h
diff options
context:
space:
mode:
Diffstat (limited to 'indra/newview/llslurl.h')
-rw-r--r--indra/newview/llslurl.h187
1 files changed, 96 insertions, 91 deletions
diff --git a/indra/newview/llslurl.h b/indra/newview/llslurl.h
index 1a3f0543dd..a79a8fc97c 100644
--- a/indra/newview/llslurl.h
+++ b/indra/newview/llslurl.h
@@ -1,108 +1,113 @@
-/**
+/**
* @file llslurl.h
- * @brief Handles "SLURL fragments" like Ahern/123/45 for
- * startup processing, login screen, prefs, etc.
+ * @brief SLURL manipulation
*
- * $LicenseInfo:firstyear=2010&license=viewerlgpl$
- * Second Life Viewer Source Code
- * Copyright (C) 2010, Linden Research, Inc.
+ * $LicenseInfo:firstyear=2009&license=viewergpl$
*
- * 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.
+ * Copyright (c) 2009, Linden Research, Inc.
*
- * 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.
+ * 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
*
- * 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
+ * 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
*
- * Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA
+ * 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 LLSLURL_H
-#define LLSLURL_H
-#include "llstring.h"
+#ifndef LL_SLURL_H
+#define LL_SLURL_H
+#include <string>
-// represents a location in a grid
+// IAN BUG: where should this live?
+// IAN BUG: are static utility functions right? See LLUUID.
+// question of whether to have a LLSLURL object or a
+// some of this was moved from LLURLDispatcher
+/**
+ * SLURL manipulation
+ */
class LLSLURL
{
public:
- static const char* SLURL_HTTPS_SCHEME;
- static const char* SLURL_HTTP_SCHEME;
- static const char* SLURL_SL_SCHEME;
- static const char* SLURL_SECONDLIFE_SCHEME;
- static const char* SLURL_SECONDLIFE_PATH;
- static const char* SLURL_COM;
- static const char* WWW_SLURL_COM;
- static const char* SECONDLIFE_COM;
- static const char* MAPS_SECONDLIFE_COM;
- static const char* SLURL_X_GRID_LOCATION_INFO_SCHEME;
- static LLSLURL START_LOCATION;
- static const char* SIM_LOCATION_HOME;
- static const char* SIM_LOCATION_LAST;
- static const char* SLURL_APP_PATH;
- static const char* SLURL_REGION_PATH;
-
- enum SLURL_TYPE {
- INVALID,
- LOCATION,
- HOME_LOCATION,
- LAST_LOCATION,
- APP,
- HELP
- };
-
-
- LLSLURL(): mType(INVALID) { }
- LLSLURL(const std::string& slurl);
- LLSLURL(const std::string& grid, const std::string& region);
- LLSLURL(const std::string& region, const LLVector3& position);
- LLSLURL(const std::string& grid, const std::string& region, const LLVector3& position);
- LLSLURL(const std::string& grid, const std::string& region, const LLVector3d& global_position);
- LLSLURL(const std::string& region, const LLVector3d& global_position);
- LLSLURL(const std::string& command, const LLUUID&id, const std::string& verb);
-
- SLURL_TYPE getType() const { return mType; }
-
- std::string getSLURLString() const;
- std::string getLoginString() const;
- std::string getLocationString() const;
- std::string getGrid() const { return mGrid; }
- std::string getRegion() const { return mRegion; }
- LLVector3 getPosition() const { return mPosition; }
- std::string getAppCmd() const { return mAppCmd; }
- std::string getAppQuery() const { return mAppQuery; }
- LLSD getAppQueryMap() const { return mAppQueryMap; }
- LLSD getAppPath() const { return mAppPath; }
-
- bool isValid() const { return mType != INVALID; }
- bool isSpatial() const { return (mType == LAST_LOCATION) || (mType == HOME_LOCATION) || (mType == LOCATION); }
-
- bool operator==(const LLSLURL& rhs);
- bool operator!=(const LLSLURL&rhs);
-
- std::string asString() const ;
-
-protected:
- SLURL_TYPE mType;
-
- // used for Apps and Help
- std::string mAppCmd;
- LLSD mAppPath;
- LLSD mAppQueryMap;
- std::string mAppQuery;
-
- std::string mGrid; // reference to grid manager grid
- std::string mRegion;
- LLVector3 mPosition;
+ static const std::string PREFIX_SL_HELP;
+ static const std::string PREFIX_SL;
+ static const std::string PREFIX_SECONDLIFE;
+ static const std::string PREFIX_SLURL;
+ static const std::string PREFIX_SLURL_OLD;
+ static const std::string PREFIX_SLURL_WWW;
+
+ static const std::string APP_TOKEN;
+
+ /**
+ * Is this any sort of secondlife:// or sl:// URL?
+ */
+ static bool isSLURL(const std::string& url);
+
+ /**
+ * Returns true if url is proven valid by regexp check from LLUrlRegistry
+ */
+ static bool isValidSLURL(const std::string& url);
+
+ /**
+ * Is this a special secondlife://app/ URL?
+ */
+ static bool isSLURLCommand(const std::string& url);
+
+ /**
+ * Not sure what it is.
+ */
+ static bool isSLURLHelp(const std::string& url);
+
+ /**
+ * builds: http://slurl.com/secondlife/Region%20Name/x/y/z/ escaping result url.
+ */
+ static std::string buildSLURL(const std::string& regionname, S32 x, S32 y, S32 z);
+
+ /// Build a SLURL like secondlife:///app/agent/<uuid>/inspect
+ static std::string buildCommand(const char* noun, const LLUUID& id, const char* verb);
+
+ /**
+ * builds: http://slurl.com/secondlife/Region Name/x/y/z/ without escaping result url.
+ */
+ static std::string buildUnescapedSLURL(const std::string& regionname, S32 x, S32 y, S32 z);
+
+ /**
+ * builds SLURL from global position. Returns escaped or unescaped url.
+ * Returns escaped url by default.
+ */
+ static std::string buildSLURLfromPosGlobal(const std::string& regionname,
+ const LLVector3d& global_pos,
+ bool escaped = true);
+ /**
+ * Strip protocol part from the URL.
+ */
+ static std::string stripProtocol(const std::string& url);
+
+ /**
+ * Convert global position to X, Y Z
+ */
+ static void globalPosToXYZ(const LLVector3d& pos, S32& x, S32& y, S32& z);
+
+private:
+ static bool matchPrefix(const std::string& url, const std::string& prefix);
+
};
-#endif // LLSLURL_H
+#endif