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
|
/**
* @file llviewerhelp.cpp
* @brief Utility functions for the Help system
* @author Soft Linden
*
* $LicenseInfo:firstyear=2009&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$
*/
#include "llviewerprecompiledheaders.h"
#include "llviewerhelputil.h"
#include "llagent.h"
#include "llsd.h"
#include "llstring.h"
#include "lluri.h"
#include "llweb.h"
#include "llviewercontrol.h"
//////////////////////////////////////////////
// Build a help URL from a topic and formatter
//static
std::string LLViewerHelpUtil::helpDataEncode(const std::string &component)
{
const std::string data_marker = "data:";
if (component.compare(0, data_marker.length(), data_marker) == 0)
{
// This is not url, but data, data part needs to be properly escaped
// data part is separated by ',' from header. Minimal data uri is "data:,"
// See "data URI scheme"
size_t separator = component.find(",");
if (separator != std::string::npos)
{
size_t header_size = separator + 1;
std::string header = component.substr(0, header_size);
if (header.find("base64") != std::string::npos)
{
// assume url-safe data
return component;
}
std::string data = component.substr(header_size, component.length() - header_size);
const std::string allowed_sorted =
"%-." //include % since it can be a sign of being pre-escaped and is an allowed symbol
"0123456789"
"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
"_"
"abcdefghijklmnopqrstuvwxyz";
bool needs_escaping = false;
std::string::const_iterator it = data.begin();
std::string::const_iterator end = data.end();
std::string::const_iterator allowed_begin(allowed_sorted.begin());
std::string::const_iterator allowed_end(allowed_sorted.end());
std::string::value_type c;
for (; it != end; ++it)
{
c = *it;
if (!std::binary_search(allowed_begin, allowed_end, c))
{
// found unescaped symbol
needs_escaping = true;
break;
}
}
if (!needs_escaping)
{
// pre-escaped
return component;
}
// Notes: Teoretically file can be partially pre-escaped,
// but we can't reliably distinguish what user intended to do,
// so escape everything and let user control the rest.
// Escapes % as well
std::string url = header + helpURLEncode(data);
return url;
}
else
{
// corrupted or not a data scheme? Nothing we can do.
return component;
}
}
else
{
// Not a data scheme
return component;
}
}
//static
std::string LLViewerHelpUtil::helpURLEncode( const std::string &component )
{
// Every character rfc3986 allows as unreserved in 2.3, minus the tilde
// which we may grant special meaning. Yay.
const char* allowed =
"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
"abcdefghijklmnopqrstuvwxyz"
"0123456789"
"-._";
std::string escaped = LLURI::escape(component, allowed);
return escaped;
}
//static
std::string LLViewerHelpUtil::buildHelpURL( const std::string &topic)
{
LLSD substitution;
substitution["TOPIC"] = helpURLEncode(topic);
substitution["DEBUG_MODE"] = gAgent.isGodlike() ? "/debug" : "";
// get the help URL and expand all of the substitutions
// (also adds things like [LANGUAGE], [VERSION], [OS], etc.)
std::string helpURL = gSavedSettings.getString("HelpURLFormat");
return LLWeb::expandURLSubstitutions(helpURL, substitution);
}
|
