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
|
/**
* @file llviewerhelp.cpp
* @brief Utility functions for the Help system
* @author Tofu 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 "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
std::string LLViewerHelp::getURL(const std::string &topic)
{
// allow overriding the help server with a local help file
if( gSavedSettings.getBOOL("HelpUseLocal") )
{
return "__local";
}
// 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();
}
}
return LLViewerHelpUtil::buildHelpURL( help_topic );
}
void LLViewerHelp::showTopic(const std::string& topic)
{
LLFloaterReg::showInstance("help_browser", topic);
}
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();
}
|
