path: root/indra/newview/llfloaterwebcontent.cpp

/**
 * @file llfloaterwebcontent.cpp
 * @brief floater for displaying web content - e.g. profiles and search (eventually)
 *
 * $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 "llcombobox.h"
#include "lliconctrl.h"
#include "llfloaterreg.h"
#include "llhttpconstants.h"
#include "lllayoutstack.h"
#include "llpluginclassmedia.h"
#include "llprogressbar.h"
#include "lltextbox.h"
#include "llurlhistory.h"
#include "llviewercontrol.h"
#include "llweb.h"
#include "llwindow.h"

#include "llfloaterwebcontent.h"

LLFloaterWebContent::_Params::_Params()
:   url("url"),
    target("target"),
    id("id"),
    window_class("window_class", "web_content"),
    show_chrome("show_chrome", true),
    allow_address_entry("allow_address_entry", true),
    allow_back_forward_navigation("allow_back_forward_navigation", true),
    preferred_media_size("preferred_media_size"),
    trusted_content("trusted_content", false),
    show_page_title("show_page_title", true),
    clean_browser("clean_browser", false),
    dev_mode("dev_mode", false)
{}

LLFloaterWebContent::LLFloaterWebContent( const Params& params )
:   LLFloater( params ),
    LLInstanceTracker<LLFloaterWebContent, std::string, LLInstanceTrackerReplaceOnCollision>(params.id()),
    mWebBrowser(NULL),
    mAddressCombo(NULL),
    mSecureLockIcon(NULL),
    mStatusBarText(NULL),
    mStatusBarProgress(NULL),
    mBtnBack(NULL),
    mBtnForward(NULL),
    mBtnReload(NULL),
    mBtnStop(NULL),
    mUUID(params.id()),
    mShowPageTitle(params.show_page_title),
    mAllowNavigation(true),
    mCurrentURL(""),
    mDisplayURL(""),
    mDevelopMode(params.dev_mode) // if called from "Develop" Menu, set a flag and change things to be more useful for devs
{
    mCommitCallbackRegistrar.add( "WebContent.Back", boost::bind( &LLFloaterWebContent::onClickBack, this ));
    mCommitCallbackRegistrar.add( "WebContent.Forward", boost::bind( &LLFloaterWebContent::onClickForward, this ));
    mCommitCallbackRegistrar.add( "WebContent.Reload", boost::bind( &LLFloaterWebContent::onClickReload, this ));
    mCommitCallbackRegistrar.add( "WebContent.Stop", boost::bind( &LLFloaterWebContent::onClickStop, this ));
    mCommitCallbackRegistrar.add( "WebContent.EnterAddress", boost::bind( &LLFloaterWebContent::onEnterAddress, this ));
    mCommitCallbackRegistrar.add( "WebContent.PopExternal", boost::bind(&LLFloaterWebContent::onPopExternal, this));
    mCommitCallbackRegistrar.add( "WebContent.TestURL", boost::bind(&LLFloaterWebContent::onTestURL, this, _2));
}

bool LLFloaterWebContent::postBuild()
{
    // these are used in a bunch of places so cache them
    mWebBrowser        = getChild< LLMediaCtrl >( "webbrowser" );
    mAddressCombo      = getChild< LLComboBox >( "address" );
    mStatusBarText     = getChild< LLTextBox >( "statusbartext" );
    mStatusBarProgress = getChild<LLProgressBar>("statusbarprogress" );

    mBtnBack           = getChildView( "back" );
    mBtnForward        = getChildView( "forward" );
    mBtnReload         = getChildView( "reload" );
    mBtnStop           = getChildView( "stop" );

    // observe browser events
    mWebBrowser->addObserver( this );

    // these buttons are always enabled
    mBtnReload->setEnabled( true );
    mBtnReload->setVisible( false );
    getChildView("popexternal")->setEnabled( true );

    // cache image for secure browsing
    mSecureLockIcon = getChild< LLIconCtrl >("media_secure_lock_flag");

    // initialize the URL history using the system URL History manager
    initializeURLHistory();

    return true;
}

void LLFloaterWebContent::initializeURLHistory()
{
    // start with an empty list
    LLCtrlListInterface* url_list = childGetListInterface("address");
    if (url_list)
    {
        url_list->operateOnAll(LLCtrlListInterface::OP_DELETE);
    }

    // Get all of the entries in the "browser" collection
    LLSD browser_history = LLURLHistory::getURLHistory("browser");
    LLSD::array_iterator iter_history = browser_history.beginArray();
    LLSD::array_iterator end_history = browser_history.endArray();
    for(; iter_history != end_history; ++iter_history)
    {
        std::string url = (*iter_history).asString();
        if(! url.empty())
            url_list->addSimpleElement(url);
    }
}

bool LLFloaterWebContent::matchesKey(const LLSD& key)
{
    Params p(mKey);
    Params other_p(key);
    if (!other_p.target().empty() && other_p.target() != "_blank")
    {
        return other_p.target() == p.target();
    }
    else
    {
        return other_p.id() == p.id();
    }
}

//static
LLFloater* LLFloaterWebContent::create( Params p)
{
    preCreate(p);
    return new LLFloaterWebContent(p);
}

//static
void LLFloaterWebContent::closeRequest(const std::string &uuid)
{
    auto floaterp = instance_tracker_t::getInstance(uuid);
    if (floaterp)
    {
        floaterp->closeFloater(false);
    }
}

//static
void LLFloaterWebContent::geometryChanged(const std::string &uuid, S32 x, S32 y, S32 width, S32 height)
{
    auto floaterp = instance_tracker_t::getInstance(uuid);
    if (floaterp)
    {
        floaterp->geometryChanged(x, y, width, height);
    }
}

void LLFloaterWebContent::geometryChanged(S32 x, S32 y, S32 width, S32 height)
{
    // Make sure the layout of the browser control is updated, so this calculation is correct.
    getChild<LLLayoutStack>("stack1")->updateLayout();

    // TODO: need to adjust size and constrain position to make sure floaters aren't moved outside the window view, etc.
    LLCoordWindow window_size;
    getWindow()->getSize(&window_size);

    // Adjust width and height for the size of the chrome on the web Browser window.
    LLRect browser_rect;
    mWebBrowser->localRectToOtherView(mWebBrowser->getLocalRect(), &browser_rect, this);

    S32 requested_browser_bottom = window_size.mY - (y + height);
    LLRect geom;
    geom.setOriginAndSize(x - browser_rect.mLeft,
                        requested_browser_bottom - browser_rect.mBottom,
                        width + getRect().getWidth() - browser_rect.getWidth(),
                        height + getRect().getHeight() - browser_rect.getHeight());

    LLRect new_rect;
    getParent()->screenRectToLocal(geom, &new_rect);
    setShape(new_rect);
}

// static
void LLFloaterWebContent::preCreate(LLFloaterWebContent::Params& p)
{
    if (!p.id.isProvided())
    {
        p.id = LLUUID::generateNewID().asString();
    }

    if(p.target().empty() || p.target() == "_blank")
    {
        p.target = p.id();
    }

    S32 browser_window_limit = gSavedSettings.getS32("WebContentWindowLimit");
    if(browser_window_limit != 0)
    {
        // showInstance will open a new window.  Figure out how many web browsers are already open,
        // and close the least recently opened one if this will put us over the limit.

        LLFloaterReg::const_instance_list_t &instances = LLFloaterReg::getFloaterList(p.window_class());

        if(instances.size() >= (size_t)browser_window_limit)
        {
            // Destroy the least recently opened instance
            (*instances.begin())->closeFloater();
        }
    }
}

void LLFloaterWebContent::open_media(const Params& p)
{
    LLViewerMedia::getInstance()->proxyWindowOpened(p.target(), p.id());
    mWebBrowser->setHomePageUrl(p.url);
    mWebBrowser->setTarget(p.target);
    mWebBrowser->navigateTo(p.url);

    set_current_url(p.url);

    getChild<LLLayoutPanel>("status_bar")->setVisible(p.show_chrome);
    getChild<LLLayoutPanel>("nav_controls")->setVisible(p.show_chrome);

    // turn additional debug controls on but only for Develop mode (Develop menu open)
    getChild<LLLayoutPanel>("debug_controls")->setVisible(mDevelopMode);

    bool address_entry_enabled = p.allow_address_entry && !p.trusted_content;
    mAllowNavigation = p.allow_back_forward_navigation;
    getChildView("address")->setEnabled(address_entry_enabled);
    getChildView("popexternal")->setEnabled(address_entry_enabled);

    if (!p.show_chrome)
    {
        setResizeLimits(100, 100);
    }

    if (!p.preferred_media_size().isEmpty())
    {
        getChild<LLLayoutStack>("stack1")->updateLayout();
        LLRect browser_rect = mWebBrowser->calcScreenRect();
        LLCoordWindow window_size;
        getWindow()->getSize(&window_size);

        geometryChanged(browser_rect.mLeft, window_size.mY - browser_rect.mTop, p.preferred_media_size().getWidth(), p.preferred_media_size().getHeight());
    }

}

void LLFloaterWebContent::onOpen(const LLSD& key)
{
    Params params(key);

    if (!params.validateBlock())
    {
        closeFloater();
        return;
    }

    mWebBrowser->setTrustedContent(params.trusted_content);

    // tell the browser instance to load the specified URL
    open_media(params);
}

//virtual
void LLFloaterWebContent::onClose(bool app_quitting)
{
    LLViewerMedia::getInstance()->proxyWindowClosed(mUUID);
    destroy();
}

// virtual
void LLFloaterWebContent::draw()
{
    // this is asynchronous so we need to keep checking
    mBtnBack->setEnabled( mWebBrowser->canNavigateBack() && mAllowNavigation);
    mBtnForward->setEnabled( mWebBrowser->canNavigateForward() && mAllowNavigation);

    LLFloater::draw();
}

// virtual
void LLFloaterWebContent::handleMediaEvent(LLPluginClassMedia* self, EMediaEvent event)
{
    if(event == MEDIA_EVENT_LOCATION_CHANGED)
    {
        const std::string url = self->getLocation();

        if ( url.length() )
            mStatusBarText->setText( url );

        set_current_url( url );
    }
    else if(event == MEDIA_EVENT_NAVIGATE_BEGIN)
    {
        // flags are sent with this event
        mBtnBack->setEnabled( self->getHistoryBackAvailable() );
        mBtnForward->setEnabled( self->getHistoryForwardAvailable() );

        // toggle visibility of these buttons based on browser state
        mBtnReload->setVisible( false );
        mBtnStop->setVisible( true );

        // turn "on" progress bar now we're about to start loading
        mStatusBarProgress->setVisible( true );
    }
    else if(event == MEDIA_EVENT_NAVIGATE_COMPLETE)
    {
        // flags are sent with this event
        mBtnBack->setEnabled( self->getHistoryBackAvailable() );
        mBtnForward->setEnabled( self->getHistoryForwardAvailable() );

        // toggle visibility of these buttons based on browser state
        mBtnReload->setVisible( true );
        mBtnStop->setVisible( false );

        // turn "off" progress bar now we're loaded
        mStatusBarProgress->setVisible( false );

        // we populate the status bar with URLs as they change so clear it now we're done
        const std::string end_str = "";
        mStatusBarText->setText( end_str );
    }
    else if(event == MEDIA_EVENT_CLOSE_REQUEST)
    {
        // The browser instance wants its window closed.
        closeFloater();
    }
    else if(event == MEDIA_EVENT_STATUS_TEXT_CHANGED )
    {
        const std::string text = self->getStatusText();
        if ( text.length() )
            mStatusBarText->setText( text );
    }
    else if(event == MEDIA_EVENT_PROGRESS_UPDATED )
    {
        int percent = (int)self->getProgressPercent();
        mStatusBarProgress->setValue( percent );
    }
    else if(event == MEDIA_EVENT_NAME_CHANGED )
    {
        // flags are sent with this event
        mBtnBack->setEnabled(self->getHistoryBackAvailable());
        mBtnForward->setEnabled(self->getHistoryForwardAvailable());
        std::string page_title = self->getMediaName();
        // simulate browser behavior - title is empty, use the current URL
        if (mShowPageTitle)
        {
            if ( page_title.length() > 0 )
                setTitle( page_title );
            else
                setTitle( mCurrentURL );
        }
    }
    else if(event == MEDIA_EVENT_LINK_HOVERED )
    {
        const std::string link = self->getHoverLink();
        mStatusBarText->setText( link );
    }
}

void LLFloaterWebContent::set_current_url(const std::string& url)
{
    if (!url.empty())
    {
        if (!mCurrentURL.empty())
        {
            // Clean up the current browsing list to show true URL
            mAddressCombo->remove(mDisplayURL);
            mAddressCombo->add(mCurrentURL);
        }

        // Update current URL
        mCurrentURL = url;
        LLStringUtil::trim(mCurrentURL);

        // Serialize url history into the system URL History manager
        LLURLHistory::removeURL("browser", mCurrentURL);
        LLURLHistory::addURL("browser", mCurrentURL);

        // Check if this is a secure URL
        static const std::string secure_prefix = std::string("https://");
        std::string prefix = mCurrentURL.substr(0, secure_prefix.length());
        LLStringUtil::toLower(prefix);
        bool secure_url = (prefix == secure_prefix);
        mSecureLockIcon->setVisible(secure_url);
        mAddressCombo->setLeftTextPadding(secure_url ? 22 : 2);
        mDisplayURL = mCurrentURL;

        // Clean up browsing list (prevent dupes) and add/select the new URL to it
        mAddressCombo->remove(mCurrentURL);
        mAddressCombo->add(mDisplayURL);
        mAddressCombo->selectByValue(mDisplayURL);
    }
}

void LLFloaterWebContent::onClickForward()
{
    mWebBrowser->navigateForward();
}

void LLFloaterWebContent::onClickBack()
{
    mWebBrowser->navigateBack();
}

void LLFloaterWebContent::onClickReload()
{

    if( mWebBrowser->getMediaPlugin() )
    {
        bool ignore_cache = true;
        mWebBrowser->getMediaPlugin()->browse_reload( ignore_cache );
    }
    else
    {
        mWebBrowser->navigateTo(mCurrentURL);
    }
}

void LLFloaterWebContent::onClickStop()
{
    if( mWebBrowser->getMediaPlugin() )
        mWebBrowser->getMediaPlugin()->browse_stop();

    // still should happen when we catch the navigate complete event
    // but sometimes (don't know why) that event isn't sent from Qt
    // and we ghetto a point where the stop button stays active.
    mBtnReload->setVisible( true );
    mBtnStop->setVisible( false );
}

void LLFloaterWebContent::onEnterAddress()
{
    // make sure there is at least something there.
    // (perhaps this test should be for minimum length of a URL)
    std::string url = mAddressCombo->getValue().asString();
    LLStringUtil::trim(url);
    if ( url.length() > 0 )
    {
        mWebBrowser->navigateTo(url);
    };
}

void LLFloaterWebContent::onPopExternal()
{
    // make sure there is at least something there.
    // (perhaps this test should be for minimum length of a URL)
    std::string url = mAddressCombo->getValue().asString();
    LLStringUtil::trim(url);
    if (url.length() > 0)
    {
        LLWeb::loadURLExternal(url);
    };
}

void LLFloaterWebContent::onTestURL(std::string url)
{
    LLStringUtil::trim(url);
    if (url.length() > 0)
    {
        mWebBrowser->navigateTo(url);
    };
}