/**
* @file llfloaterhtmlhelp.cpp
* @brief HTML Help floater - uses embedded web browser control
*
* $LicenseInfo:firstyear=2006&license=viewergpl$
*
* Copyright (c) 2006-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 "llfloaterhtmlhelp.h"
#include "llfloaterhtml.h"
#include "llparcel.h"
#include "lluictrlfactory.h"
#include "llwebbrowserctrl.h"
#include "llviewerwindow.h"
#include "llviewercontrol.h"
#include "llviewerparcelmgr.h"
#include "llweb.h"
#include "llui.h"
#include "roles_constants.h"
#include "llurlhistory.h"
#include "llwebbrowserctrl.h"
#include "llviewermedia.h"
#include "llviewerparcelmedia.h"
#include "llcombobox.h"
LLFloaterMediaBrowser::LLFloaterMediaBrowser(const LLSD& media_data)
{
LLUICtrlFactory::getInstance()->buildFloater(this, "floater_media_browser.xml");
}
void LLFloaterMediaBrowser::draw()
{
childSetEnabled("go", !mAddressCombo->getValue().asString().empty());
LLParcel* parcel = LLViewerParcelMgr::getInstance()->getAgentParcel();
if(parcel)
{
childSetVisible("parcel_owner_controls", LLViewerParcelMgr::isParcelModifiableByAgent(parcel, GP_LAND_CHANGE_MEDIA));
childSetEnabled("assign", !mAddressCombo->getValue().asString().empty());
}
LLFloater::draw();
}
BOOL LLFloaterMediaBrowser::postBuild()
{
mBrowser = getChild("browser");
mBrowser->addObserver(this);
mAddressCombo = getChild("address");
mAddressCombo->setCommitCallback(onEnterAddress);
mAddressCombo->setCallbackUserData(this);
childSetAction("back", onClickBack, this);
childSetAction("forward", onClickForward, this);
childSetAction("reload", onClickRefresh, this);
childSetAction("go", onClickGo, this);
childSetAction("close", onClickClose, this);
childSetAction("open_browser", onClickOpenWebBrowser, this);
childSetAction("assign", onClickAssign, this);
buildURLHistory();
return TRUE;
}
void LLFloaterMediaBrowser::buildURLHistory()
{
LLCtrlListInterface* url_list = childGetListInterface("address");
if (url_list)
{
url_list->operateOnAll(LLCtrlListInterface::OP_DELETE);
}
// Get all of the entries in the "parcel" collection
LLSD parcel_history = LLURLHistory::getURLHistory("browser");
LLSD::array_iterator iter_history =
parcel_history.beginArray();
LLSD::array_iterator end_history =
parcel_history.endArray();
for(; iter_history != end_history; ++iter_history)
{
std::string url = (*iter_history).asString();
if(! url.empty())
url_list->addSimpleElement(url);
}
}
void LLFloaterMediaBrowser::onClose(bool app_quitting)
{
//setVisible(FALSE);
destroy();
}
void LLFloaterMediaBrowser::onLocationChange( const EventType& eventIn )
{
// hitting the refresh button will navigate to same URL, so don't add to address history
mCurrentURL = eventIn.getStringValue();
std::string::size_type string_start = mCurrentURL.find("://");
std::string truncated_url;
if ((string_start == std::string::npos) || (1)) // NOTE: this conditional is forced true to disable truncation DEV-9834
{
truncated_url = mCurrentURL;
}
else
{
truncated_url = mCurrentURL.substr(string_start + 3);
}
// redirects will navigate momentarily to about:blank, don't add to history
if (truncated_url != "about:blank")
{
mAddressCombo->remove(truncated_url);
mAddressCombo->add(truncated_url, ADD_SORTED);
mAddressCombo->selectByValue(truncated_url);
// Serialize url history
LLURLHistory::removeURL("browser", truncated_url);
LLURLHistory::addURL("browser", truncated_url);
}
childSetEnabled("back", mBrowser->canNavigateBack());
childSetEnabled("forward", mBrowser->canNavigateForward());
childSetEnabled("reload", TRUE);
}
LLFloaterMediaBrowser* LLFloaterMediaBrowser::showInstance(const LLSD& media_url)
{
LLFloaterMediaBrowser* floaterp = LLUISingleton >::showInstance(media_url);
floaterp->openMedia(media_url.asString());
return floaterp;
}
//static
void LLFloaterMediaBrowser::onEnterAddress(LLUICtrl* ctrl, void* user_data)
{
LLFloaterMediaBrowser* self = (LLFloaterMediaBrowser*)user_data;
self->mBrowser->navigateTo(self->mAddressCombo->getValue().asString());
}
//static
void LLFloaterMediaBrowser::onClickRefresh(void* user_data)
{
LLFloaterMediaBrowser* self = (LLFloaterMediaBrowser*)user_data;
self->mAddressCombo->remove(0);
self->mBrowser->navigateTo(self->mCurrentURL);
}
//static
void LLFloaterMediaBrowser::onClickForward(void* user_data)
{
LLFloaterMediaBrowser* self = (LLFloaterMediaBrowser*)user_data;
self->mBrowser->navigateForward();
}
//static
void LLFloaterMediaBrowser::onClickBack(void* user_data)
{
LLFloaterMediaBrowser* self = (LLFloaterMediaBrowser*)user_data;
self->mBrowser->navigateBack();
}
//static
void LLFloaterMediaBrowser::onClickGo(void* user_data)
{
LLFloaterMediaBrowser* self = (LLFloaterMediaBrowser*)user_data;
self->mBrowser->navigateTo(self->mAddressCombo->getValue().asString());
}
//static
void LLFloaterMediaBrowser::onClickClose(void* user_data)
{
LLFloaterMediaBrowser* self = (LLFloaterMediaBrowser*)user_data;
self->close();
}
//static
void LLFloaterMediaBrowser::onClickOpenWebBrowser(void* user_data)
{
LLFloaterMediaBrowser* self = (LLFloaterMediaBrowser*)user_data;
std::string url = self->mCurrentURL.empty() ?
self->mBrowser->getHomePageUrl() :
self->mCurrentURL;
LLWeb::loadURLExternal(url);
}
void LLFloaterMediaBrowser::onClickAssign(void* user_data)
{
LLFloaterMediaBrowser* self = (LLFloaterMediaBrowser*)user_data;
LLParcel* parcel = LLViewerParcelMgr::getInstance()->getAgentParcel();
if (!parcel)
{
return;
}
std::string media_url = self->mAddressCombo->getValue().asString();
LLStringUtil::trim(media_url);
parcel->setMediaURL(media_url);
parcel->setMediaType(std::string("text/html"));
// Send current parcel data upstream to server
LLViewerParcelMgr::getInstance()->sendParcelPropertiesUpdate( parcel, true );
// now check for video
LLViewerParcelMedia::update( parcel );
}
void LLFloaterMediaBrowser::openMedia(const std::string& media_url)
{
mBrowser->setHomePageUrl(media_url);
mBrowser->navigateTo(media_url);
}
LLViewerHtmlHelp gViewerHtmlHelp;
class LLFloaterHtmlHelp :
public LLFloater,
public LLWebBrowserCtrlObserver
{
public:
LLFloaterHtmlHelp(std::string start_url, std::string title);
virtual ~LLFloaterHtmlHelp();
virtual void onClose( bool app_quitting );
virtual void draw();
static void show(std::string url, std::string title);
static void onClickBack( void* data );
static void onClickHome( void* data );
static void onClickForward( void* data );
static void onClickClose( void* data );
// browser observer impls
virtual void onStatusTextChange( const EventType& eventIn );
virtual void onLocationChange( const EventType& eventIn );
// used for some stats logging - will be removed at some point
static BOOL sFloaterOpened;
static void onClickF1HelpLoadURL(S32 option, void* userdata);
protected:
LLWebBrowserCtrl* mWebBrowser;
static LLFloaterHtmlHelp* sInstance;
LLButton* mBackButton;
LLButton* mForwardButton;
LLButton* mCloseButton;
LLTextBox* mStatusText;
std::string mStatusTextContents;
std::string mCurrentUrl;
std::string mSupportUrl;
};
LLFloaterHtmlHelp* LLFloaterHtmlHelp::sInstance = 0;
BOOL LLFloaterHtmlHelp::sFloaterOpened = FALSE;
////////////////////////////////////////////////////////////////////////////////
//
LLFloaterHtmlHelp::LLFloaterHtmlHelp(std::string start_url, std::string title)
: LLFloater( std::string("HTML Help") ),
mWebBrowser( 0 ),
mStatusTextContents( LLStringUtil::null ),
mCurrentUrl( LLStringUtil::null )
{
sInstance = this;
// create floater from its XML definition
LLUICtrlFactory::getInstance()->buildFloater( this, "floater_html_help.xml" );
childSetAction("back_btn", onClickBack, this);
childSetAction("home_btn", onClickHome, this);
childSetAction("forward_btn", onClickForward, this);
if (!title.empty())
{
setTitle(title);
}
mWebBrowser = getChild("html_help_browser" );
if ( mWebBrowser )
{
// observe browser control events
mWebBrowser->addObserver( this );
if (start_url != "")
{
mWebBrowser->navigateTo( start_url );
}
else
{
// if the last page we were at before the client was closed is valid, go there and
// override what is in the XML file
// (not when the window was closed - it's only ever hidden - not closed)
std::string lastPageUrl = gSavedSettings.getString( "HtmlHelpLastPage" );
if ( lastPageUrl != "" )
{
mWebBrowser->navigateTo( lastPageUrl );
};
}
};
}
////////////////////////////////////////////////////////////////////////////////
//
LLFloaterHtmlHelp::~LLFloaterHtmlHelp()
{
// stop observing browser events
if ( mWebBrowser )
{
mWebBrowser->remObserver( this );
};
// save position of floater
gSavedSettings.setRect( "HtmlHelpRect", getRect() );
// save the location we were at when SL closed
gSavedSettings.setString( "HtmlHelpLastPage", mCurrentUrl );
sInstance = 0;
}
////////////////////////////////////////////////////////////////////////////////
// virtual
void LLFloaterHtmlHelp::draw()
{
// enable/disable buttons depending on state
if ( mWebBrowser )
{
bool enable_back = mWebBrowser->canNavigateBack();
childSetEnabled( "back_btn", enable_back );
bool enable_forward = mWebBrowser->canNavigateForward();
childSetEnabled( "forward_btn", enable_forward );
};
LLFloater::draw();
}
////////////////////////////////////////////////////////////////////////////////
//
void LLFloaterHtmlHelp::show(std::string url, std::string title)
{
LLFloaterHtml* floater_html = LLFloaterHtml::getInstance();
floater_html->setVisible(FALSE);
if(url.empty())
{
url = floater_html->getSupportUrl();
}
std::string* url_copy = new std::string(url);
gViewerWindow->alertXml("ClickOpenF1Help", onClickF1HelpLoadURL, url_copy);
}
// static
void LLFloaterHtmlHelp::onClickF1HelpLoadURL(S32 option, void* userdata)
{
std::string* urlp = (std::string*)userdata;
if (0 == option)
{
LLWeb::loadURL(urlp->c_str());
}
delete urlp;
}
////////////////////////////////////////////////////////////////////////////////
//
void LLFloaterHtmlHelp::onClose( bool app_quitting )
{
setVisible( false );
}
////////////////////////////////////////////////////////////////////////////////
//
void LLFloaterHtmlHelp::onClickClose( void* data )
{
LLFloaterHtmlHelp* self = ( LLFloaterHtmlHelp* )data;
self->setVisible( false );
}
////////////////////////////////////////////////////////////////////////////////
//
void LLFloaterHtmlHelp::onClickBack( void* data )
{
LLFloaterHtmlHelp* self = ( LLFloaterHtmlHelp* )data;
if ( self )
{
if ( self->mWebBrowser )
{
self->mWebBrowser->navigateBack();
};
};
}
////////////////////////////////////////////////////////////////////////////////
//
void LLFloaterHtmlHelp::onClickHome( void* data )
{
LLFloaterHtmlHelp* self = ( LLFloaterHtmlHelp* )data;
if ( self )
{
// get the home page URL (which can differ from the start URL) from XML and go there
LLWebBrowserCtrl* web_browser = self->getChild("html_help_browser" );
if ( web_browser )
{
web_browser->navigateHome();
};
};
}
////////////////////////////////////////////////////////////////////////////////
//
void LLFloaterHtmlHelp::onClickForward( void* data )
{
LLFloaterHtmlHelp* self = ( LLFloaterHtmlHelp* )data;
if ( self )
{
if ( self->mWebBrowser )
{
self->mWebBrowser->navigateForward();
};
};
}
////////////////////////////////////////////////////////////////////////////////
//
void LLFloaterHtmlHelp::onStatusTextChange( const EventType& eventIn )
{
mStatusTextContents = std::string( eventIn.getStringValue() );
childSetText("status_text", mStatusTextContents);
}
////////////////////////////////////////////////////////////////////////////////
//
void LLFloaterHtmlHelp::onLocationChange( const EventType& eventIn )
{
llinfos << "MOZ> Location changed to " << eventIn.getStringValue() << llendl;
mCurrentUrl = std::string( eventIn.getStringValue() );
}
////////////////////////////////////////////////////////////////////////////////
//
LLViewerHtmlHelp::LLViewerHtmlHelp()
{
LLUI::setHtmlHelp(this);
}
LLViewerHtmlHelp::~LLViewerHtmlHelp()
{
LLUI::setHtmlHelp(NULL);
}
void LLViewerHtmlHelp::show()
{
LLFloaterHtmlHelp::show("", "");
}
void LLViewerHtmlHelp::show(std::string url)
{
std::string title; // empty
LLFloaterHtmlHelp::show(url, title);
}