summaryrefslogtreecommitdiff
path: root/indra/newview/llfloaterhelpbrowser.cpp
blob: e77fa836065ab571f0630682c1cfe785ff1f4e0e (plain)
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
/**
 * @file llfloaterhelpbrowser.cpp
 * @brief HTML Help floater - uses embedded web browser control
 *
 * $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$
 */

#include "llviewerprecompiledheaders.h"

#include "llfloaterhelpbrowser.h"

#include "llfloaterreg.h"
#include "llhttpconstants.h"
#include "llpluginclassmedia.h"
#include "llmediactrl.h"
#include "llviewerwindow.h"
#include "llviewercontrol.h"
#include "llweb.h"
#include "llui.h"

#include "llurlhistory.h"
#include "llviewermedia.h"
#include "llviewerhelp.h"


LLFloaterHelpBrowser::LLFloaterHelpBrowser(const LLSD& key)
    : LLFloater(key)
{
}

bool LLFloaterHelpBrowser::postBuild()
{
    mBrowser = getChild<LLMediaCtrl>("browser");
    mBrowser->addObserver(this);
    mBrowser->setErrorPageURL(gSavedSettings.getString("GenericErrorPageURL"));

    childSetAction("open_browser", onClickOpenWebBrowser, this);

    buildURLHistory();
    return true;
}

void LLFloaterHelpBrowser::buildURLHistory()
{
    // Get all of the entries in the "browser" collection
    LLSD browser_history = LLURLHistory::getURLHistory("browser");

    // initialize URL history in the plugin
    LLPluginClassMedia *plugin = mBrowser->getMediaPlugin();
    if (plugin)
    {
        plugin->initializeUrlHistory(browser_history);
    }
}

void LLFloaterHelpBrowser::onOpen(const LLSD& key)
{
    gSavedSettings.setBOOL("HelpFloaterOpen", true);

    std::string topic = key.asString();
    mBrowser->navigateTo(LLViewerHelp::instance().getURL(topic));
}

//virtual
void LLFloaterHelpBrowser::onClose(bool app_quitting)
{
    if (!app_quitting)
    {
        gSavedSettings.setBOOL("HelpFloaterOpen", false);
    }
    // really really destroy the help browser when it's closed, it'll be recreated.
    destroy(); // really destroy this dialog on closure, it's relatively heavyweight.
}

void LLFloaterHelpBrowser::handleMediaEvent(LLPluginClassMedia* self, EMediaEvent event)
{
    switch (event)
    {
    case MEDIA_EVENT_LOCATION_CHANGED:
        setCurrentURL(self->getLocation());
        break;

    case MEDIA_EVENT_NAVIGATE_BEGIN:
        getChild<LLUICtrl>("status_text")->setValue(getString("loading_text"));
        break;

    case MEDIA_EVENT_NAVIGATE_COMPLETE:
        getChild<LLUICtrl>("status_text")->setValue(getString("done_text"));
        break;

    default:
        break;
    }
}

void LLFloaterHelpBrowser::setCurrentURL(const std::string& url)
{
    mCurrentURL = url;

    // redirects will navigate momentarily to about:blank, don't add to history
    if (mCurrentURL != "about:blank")
    {
        // Serialize url history
        LLURLHistory::removeURL("browser", mCurrentURL);
        LLURLHistory::addURL("browser", mCurrentURL);
    }
}

//static
void LLFloaterHelpBrowser::onClickClose(void* user_data)
{
    LLFloaterHelpBrowser* self = (LLFloaterHelpBrowser*)user_data;

    self->closeFloater();
}

//static
void LLFloaterHelpBrowser::onClickOpenWebBrowser(void* user_data)
{
    LLFloaterHelpBrowser* self = (LLFloaterHelpBrowser*)user_data;

    std::string url = self->mCurrentURL.empty() ?
        self->mBrowser->getHomePageUrl() :
        self->mCurrentURL;
    LLWeb::loadURLExternal(url);
}

void LLFloaterHelpBrowser::openMedia(const std::string& media_url)
{
    // explicitly make the media mime type for this floater since it will
    // only ever display one type of content (Web).
    mBrowser->setHomePageUrl(media_url, HTTP_CONTENT_TEXT_HTML);
    mBrowser->navigateTo(media_url, HTTP_CONTENT_TEXT_HTML);
    setCurrentURL(media_url);
}