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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
/**
* @file llviewerhelp.cpp
* @brief Utility functions for the Help system
* @author Tofu Linden
*
* $LicenseInfo:firstyear=2009&license=viewergpl$
*
* Copyright (c) 2009, Linden Research, Inc.
*
* 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
*
* 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
*
* 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$
*/
#include "llviewerprecompiledheaders.h"
#include "llcommandhandler.h"
#include "llfloaterhelpbrowser.h"
#include "llfloaterreg.h"
#include "llfocusmgr.h"
#include "llviewercontrol.h"
#include "llappviewer.h"
#include "lllogininstance.h"
#include "llviewerhelputil.h"
#include "llviewerhelp.h"
// support for secondlife:///app/help/{TOPIC} SLapps
class LLHelpHandler : public LLCommandHandler
{
public:
// requests will be throttled from a non-trusted browser
LLHelpHandler() : LLCommandHandler("help", UNTRUSTED_THROTTLE) {}
bool handle(const LLSD& params, const LLSD& query_map, LLMediaCtrl* web)
{
LLViewerHelp* vhelp = LLViewerHelp::getInstance();
if (! vhelp)
{
return false;
}
// get the requested help topic name, or use the fallback if none
std::string help_topic = vhelp->defaultTopic();
if (params.size() >= 1)
{
help_topic = params[0].asString();
}
vhelp->showTopic(help_topic);
return true;
}
};
LLHelpHandler gHelpHandler;
//////////////////////////////
// implement LLHelp interface
void LLViewerHelp::showTopic(const std::string &topic)
{
// allow overriding the help server with a local help file
if( gSavedSettings.getBOOL("HelpUseLocal") )
{
showHelp();
LLFloaterHelpBrowser* helpbrowser = dynamic_cast<LLFloaterHelpBrowser*>(LLFloaterReg::getInstance("help_browser"));
helpbrowser->navigateToLocalPage( "help-offline" , "index.html" );
return;
}
// if the help topic is empty, use the default topic
std::string help_topic = topic;
if (help_topic.empty())
{
help_topic = defaultTopic();
}
// f1 help topic means: if the user is not logged in yet, show
// the pre-login topic instead of the default fallback topic,
// otherwise show help for the focused item
if (help_topic == f1HelpTopic())
{
help_topic = getTopicFromFocus();
if (help_topic == defaultTopic() && ! LLLoginInstance::getInstance()->authSuccess())
{
help_topic = preLoginTopic();
}
}
// work out the URL for this topic and display it
showHelp();
std::string helpURL = LLViewerHelpUtil::buildHelpURL( help_topic );
setRawURL( helpURL );
}
std::string LLViewerHelp::defaultTopic()
{
// *hack: to be done properly
return "this_is_fallbacktopic";
}
std::string LLViewerHelp::preLoginTopic()
{
// *hack: to be done properly
return "pre_login_help";
}
std::string LLViewerHelp::f1HelpTopic()
{
// *hack: to be done properly
return "f1_help";
}
//////////////////////////////
// our own interfaces
std::string LLViewerHelp::getTopicFromFocus()
{
// use UI element with viewer's keyboard focus as basis for searching
LLUICtrl* focused = dynamic_cast<LLUICtrl*>(gFocusMgr.getKeyboardFocus());
if (focused)
{
std::string topic;
if (focused->findHelpTopic(topic))
{
return topic;
}
}
// didn't find a help topic in the UI hierarchy for focused
// element, return the fallback topic name instead.
return defaultTopic();
}
// static
void LLViewerHelp::showHelp()
{
LLFloaterHelpBrowser* helpbrowser = dynamic_cast<LLFloaterHelpBrowser*>(LLFloaterReg::getInstance("help_browser"));
if (helpbrowser)
{
BOOL visible = TRUE;
BOOL take_focus = TRUE;
helpbrowser->setVisible(visible);
helpbrowser->setFrontmost(take_focus);
}
else
{
llwarns << "Eep, help_browser floater not found" << llendl;
}
}
// static
void LLViewerHelp::setRawURL(std::string url)
{
LLFloaterHelpBrowser* helpbrowser = dynamic_cast<LLFloaterHelpBrowser*>(LLFloaterReg::getInstance("help_browser"));
if (helpbrowser)
{
helpbrowser->openMedia(url);
}
else
{
llwarns << "Eep, help_browser floater not found" << llendl;
}
}
|
