path: root/indra/newview/llprogressview.cpp

/**
 * @file llprogressview.cpp
 * @brief LLProgressView class implementation
 *
 * $LicenseInfo:firstyear=2002&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 "llprogressview.h"

#include "indra_constants.h"
#include "llmath.h"
#include "llgl.h"
#include "llrender.h"
#include "llui.h"
#include "llfontgl.h"
#include "lltimer.h"
#include "lltextbox.h"
#include "llglheaders.h"

#include "llagent.h"
#include "llbutton.h"
#include "llcallbacklist.h"
#include "llfocusmgr.h"
#include "llnotifications.h"
#include "llprogressbar.h"
#include "llstartup.h"
#include "llviewercontrol.h"
#include "llviewertexturelist.h"
#include "llviewerwindow.h"
#include "llappviewer.h"
#include "llweb.h"
#include "lluictrlfactory.h"
#include "llpanellogin.h"

LLProgressView* LLProgressView::sInstance = NULL;

S32 gStartImageWidth = 1;
S32 gStartImageHeight = 1;
const F32 FADE_TO_WORLD_TIME = 1.0f;

static LLPanelInjector<LLProgressView> r("progress_view");

// XUI: Translate
LLProgressView::LLProgressView()
:   LLPanel(),
    mPercentDone( 0.f ),
    mMediaCtrl( NULL ),
    mMouseDownInActiveArea( false ),
    mUpdateEvents("LLProgressView"),
    mFadeToWorldTimer(),
    mFadeFromLoginTimer(),
    mStartupComplete(false)
{
    mUpdateEvents.listen("self", boost::bind(&LLProgressView::handleUpdate, this, _1));
    mFadeToWorldTimer.stop();
    mFadeFromLoginTimer.stop();
}

BOOL LLProgressView::postBuild()
{
    mProgressBar = getChild<LLProgressBar>("login_progress_bar");

    // media control that is used to play intro video
    mMediaCtrl = getChild<LLMediaCtrl>("login_media_panel");
    mMediaCtrl->setVisible( false );        // hidden initially
    mMediaCtrl->addObserver( this );        // watch events

    LLViewerMedia::getInstance()->setOnlyAudibleMediaTextureID(mMediaCtrl->getTextureID());

    mCancelBtn = getChild<LLButton>("cancel_btn");
    mCancelBtn->setClickedCallback(  LLProgressView::onCancelButtonClicked, NULL );

    getChild<LLTextBox>("title_text")->setText(LLStringExplicit(LLAppViewer::instance()->getSecondLifeTitle()));

    getChild<LLTextBox>("message_text")->setClickedCallback(onClickMessage, this);

    // hidden initially, until we need it
    setVisible(FALSE);

    LLNotifications::instance().getChannel("AlertModal")->connectChanged(boost::bind(&LLProgressView::onAlertModal, this, _1));

    sInstance = this;
    return TRUE;
}


LLProgressView::~LLProgressView()
{
    // Just in case something went wrong, make sure we deregister our idle callback.
    gIdleCallbacks.deleteFunction(onIdle, this);

    gFocusMgr.releaseFocusIfNeeded( this );

    sInstance = NULL;
}

BOOL LLProgressView::handleHover(S32 x, S32 y, MASK mask)
{
    if( childrenHandleHover( x, y, mask ) == NULL )
    {
        gViewerWindow->setCursor(UI_CURSOR_WAIT);
    }
    return TRUE;
}


BOOL LLProgressView::handleKeyHere(KEY key, MASK mask)
{
    // Suck up all keystokes except CTRL-Q.
    if( ('Q' == key) && (MASK_CONTROL == mask) )
    {
        LLAppViewer::instance()->userQuit();
    }
    return TRUE;
}

void LLProgressView::revealIntroPanel()
{
    // if user hasn't yet seen intro video
    std::string intro_url = gSavedSettings.getString("PostFirstLoginIntroURL");
    if ( intro_url.length() > 0 &&
            gSavedSettings.getBOOL("BrowserJavascriptEnabled") &&
            gSavedSettings.getBOOL("PostFirstLoginIntroViewed" ) == FALSE )
    {
        // hide the progress bar
        getChild<LLView>("stack1")->setVisible(false);

        // navigate to intro URL and reveal widget
        mMediaCtrl->navigateTo( intro_url );
        mMediaCtrl->setVisible( TRUE );


        // flag as having seen the new user post login intro
        gSavedSettings.setBOOL("PostFirstLoginIntroViewed", TRUE );

        mMediaCtrl->setFocus(TRUE);
    }

    mFadeFromLoginTimer.start();
    gIdleCallbacks.addFunction(onIdle, this);
}

void LLProgressView::setStartupComplete()
{
    mStartupComplete = true;

    // if we are not showing a video, fade into world
    if (!mMediaCtrl->getVisible())
    {
        mFadeFromLoginTimer.stop();
        mFadeToWorldTimer.start();
    }
}

void LLProgressView::setVisible(BOOL visible)
{
    if (!visible && mFadeFromLoginTimer.getStarted())
    {
        mFadeFromLoginTimer.stop();
    }
    // hiding progress view
    if (getVisible() && !visible)
    {
        LLPanel::setVisible(FALSE);
    }
    // showing progress view
    else if (visible && (!getVisible() || mFadeToWorldTimer.getStarted()))
    {
        setFocus(TRUE);
        mFadeToWorldTimer.stop();
        LLPanel::setVisible(TRUE);
    }
}


void LLProgressView::drawStartTexture(F32 alpha)
{
    gGL.pushMatrix();
    if (gStartTexture)
    {
        LLGLSUIDefault gls_ui;
        gGL.getTexUnit(0)->bind(gStartTexture.get());
        gGL.color4f(1.f, 1.f, 1.f, alpha);
        F32 image_aspect = (F32)gStartImageWidth / (F32)gStartImageHeight;
        S32 width = getRect().getWidth();
        S32 height = getRect().getHeight();
        F32 view_aspect = (F32)width / (F32)height;
        // stretch image to maintain aspect ratio
        if (image_aspect > view_aspect)
        {
            gGL.translatef(-0.5f * (image_aspect / view_aspect - 1.f) * width, 0.f, 0.f);
            gGL.scalef(image_aspect / view_aspect, 1.f, 1.f);
        }
        else
        {
            gGL.translatef(0.f, -0.5f * (view_aspect / image_aspect - 1.f) * height, 0.f);
            gGL.scalef(1.f, view_aspect / image_aspect, 1.f);
        }
        gl_rect_2d_simple_tex( getRect().getWidth(), getRect().getHeight() );
        gGL.getTexUnit(0)->unbind(LLTexUnit::TT_TEXTURE);
    }
    else
    {
        gGL.getTexUnit(0)->unbind(LLTexUnit::TT_TEXTURE);
        gGL.color4f(0.f, 0.f, 0.f, 1.f);
        gl_rect_2d(getRect());
    }
    gGL.popMatrix();
}

void LLProgressView::drawLogos(F32 alpha)
{
    if (mLogosList.empty())
    {
        return;
    }

    // logos are tied to label,
    // due to potential resizes we have to figure offsets out on draw or resize
    LLTextBox *logos_label = getChild<LLTextBox>("logos_lbl");
    S32 offset_x, offset_y;
    logos_label->localPointToScreen(0, 0, &offset_x, &offset_y);
    std::vector<TextureData>::const_iterator iter = mLogosList.begin();
    std::vector<TextureData>::const_iterator end = mLogosList.end();
    for (; iter != end; iter++)
    {
        gl_draw_scaled_image_with_border(iter->mDrawRect.mLeft + offset_x,
                             iter->mDrawRect.mBottom + offset_y,
                             iter->mDrawRect.getWidth(),
                             iter->mDrawRect.getHeight(),
                             iter->mTexturep.get(),
                             UI_VERTEX_COLOR % alpha,
                             FALSE,
                             iter->mClipRect,
                             iter->mOffsetRect);
    }
}

void LLProgressView::draw()
{
    static LLTimer timer;

    if (mFadeFromLoginTimer.getStarted())
    {
        F32 alpha = clamp_rescale(mFadeFromLoginTimer.getElapsedTimeF32(), 0.f, FADE_TO_WORLD_TIME, 0.f, 1.f);
        LLViewDrawContext context(alpha);

        if (!mMediaCtrl->getVisible())
        {
            drawStartTexture(alpha);
        }

        LLPanel::draw();
        drawLogos(alpha);
        return;
    }

    // handle fade out to world view when we're asked to
    if (mFadeToWorldTimer.getStarted())
    {
        // draw fading panel
        F32 alpha = clamp_rescale(mFadeToWorldTimer.getElapsedTimeF32(), 0.f, FADE_TO_WORLD_TIME, 1.f, 0.f);
        LLViewDrawContext context(alpha);

        drawStartTexture(alpha);
        LLPanel::draw();
        drawLogos(alpha);

        // faded out completely - remove panel and reveal world
        if (mFadeToWorldTimer.getElapsedTimeF32() > FADE_TO_WORLD_TIME )
        {
            mFadeToWorldTimer.stop();

            LLViewerMedia::getInstance()->setOnlyAudibleMediaTextureID(LLUUID::null);

            // Fade is complete, release focus
            gFocusMgr.releaseFocusIfNeeded( this );

            // turn off panel that hosts intro so we see the world
            setVisible(FALSE);

            // stop observing events since we no longer care
            mMediaCtrl->remObserver( this );

            // hide the intro
            mMediaCtrl->setVisible( false );

            // navigate away from intro page to something innocuous since 'unload' is broken right now
            //mMediaCtrl->navigateTo( "about:blank" );

            // FIXME: this causes a crash that i haven't been able to fix
            mMediaCtrl->unloadMediaSource();

            releaseTextures();
        }
        return;
    }

    drawStartTexture(1.0f);
    // draw children
    LLPanel::draw();
    drawLogos(1.0f);
}

void LLProgressView::setText(const std::string& text)
{
    getChild<LLUICtrl>("progress_text")->setValue(text);
}

void LLProgressView::setPercent(const F32 percent)
{
    mProgressBar->setValue(percent);
}

void LLProgressView::setMessage(const std::string& msg)
{
    mMessage = msg;
    getChild<LLUICtrl>("message_text")->setValue(mMessage);
}

void LLProgressView::loadLogo(const std::string &path,
                              const U8 image_codec,
                              const LLRect &pos_rect,
                              const LLRectf &clip_rect,
                              const LLRectf &offset_rect)
{
    // We need these images very early, so we have to force-load them, otherwise they might not load in time.
    if (!gDirUtilp->fileExists(path))
    {
        return;
    }

    LLPointer<LLImageFormatted> start_image_frmted = LLImageFormatted::createFromType(image_codec);
    if (!start_image_frmted->load(path))
    {
        LL_WARNS("AppInit") << "Image load failed: " << path << LL_ENDL;
        return;
    }

    LLPointer<LLImageRaw> raw = new LLImageRaw;
    if (!start_image_frmted->decode(raw, 0.0f))
    {
        LL_WARNS("AppInit") << "Image decode failed " << path << LL_ENDL;
        return;
    }
    // HACK: getLocalTexture allows only power of two dimentions
    raw->expandToPowerOfTwo();

    TextureData data;
    data.mTexturep = LLViewerTextureManager::getLocalTexture(raw.get(), FALSE);
    data.mDrawRect = pos_rect;
    data.mClipRect = clip_rect;
    data.mOffsetRect = offset_rect;
    mLogosList.push_back(data);
}

void LLProgressView::initLogos()
{
    mLogosList.clear();

#if LL_FMODSTUDIO || LL_HAVOK
    const U8 image_codec = IMG_CODEC_PNG;
    const LLRectf default_clip(0.f, 1.f, 1.f, 0.f);
    //const S32 default_height = 28;
    const S32 default_pad = 15;

    S32 icon_width, icon_height;

    // We don't know final screen rect yet, so we can't precalculate position fully
    LLTextBox *logos_label = getChild<LLTextBox>("logos_lbl");
    S32 texture_start_x = logos_label->getFont()->getWidthF32(logos_label->getText()) + default_pad;
    S32 texture_start_y = -7;
#endif //LL_FMODSTUDIO || LL_HAVOK

    // Normally we would just preload these textures from textures.xml,
    // and display them via icon control, but they are only needed on
    // startup and preloaded/UI ones stay forever
    // (and this code was done already so simply reused it)
    std::string temp_str = gDirUtilp->getExpandedFilename(LL_PATH_DEFAULT_SKIN, "textures", "3p_icons");

    temp_str += gDirUtilp->getDirDelimiter();

#ifdef LL_FMODSTUDIO
    // original image size is 264x96, it is on longer side but
    // with no internal paddings so it gets additional padding
    icon_width = 77;
    icon_height = 21;
    S32 pad_fmod_y = 4;
    texture_start_x++;
    loadLogo(temp_str + "fmod_logo.png",
        image_codec,
        LLRect(texture_start_x, texture_start_y + pad_fmod_y + icon_height, texture_start_x + icon_width, texture_start_y + pad_fmod_y),
        default_clip,
        default_clip);

    texture_start_x += icon_width + default_pad + 1;
#endif //LL_FMODSTUDIO
#ifdef LL_HAVOK
    // original image size is 342x113, central element is on a larger side
    // plus internal padding, so it gets slightly more height than desired 32
    icon_width = 88;
    icon_height = 29;
    S32 pad_havok_y = -1;
    loadLogo(temp_str + "havok_logo.png",
        image_codec,
        LLRect(texture_start_x, texture_start_y + pad_havok_y + icon_height, texture_start_x + icon_width, texture_start_y + pad_havok_y),
        default_clip,
        default_clip);

    texture_start_x += icon_width + default_pad;
#endif //LL_HAVOK

/*
    // 108x41
    icon_width = 74;
    icon_height = default_height;
    loadLogo(temp_str + "vivox_logo.png",
        image_codec,
        LLRect(texture_start_x, texture_start_y + icon_height, texture_start_x + icon_width, texture_start_y),
        default_clip,
        default_clip);
*/
}

void LLProgressView::initStartTexture(S32 location_id, bool is_in_production)
{
    if (gStartTexture.notNull())
    {
        gStartTexture = NULL;
        LL_INFOS("AppInit") << "re-initializing start screen" << LL_ENDL;
    }

    LL_DEBUGS("AppInit") << "Loading startup bitmap..." << LL_ENDL;

    U8 image_codec = IMG_CODEC_PNG;
    std::string temp_str = gDirUtilp->getLindenUserDir() + gDirUtilp->getDirDelimiter();

    if ((S32)START_LOCATION_ID_LAST == location_id)
    {
        temp_str += LLStartUp::getScreenLastFilename();
    }
    else
    {
        std::string path = temp_str + LLStartUp::getScreenHomeFilename();

        if (!gDirUtilp->fileExists(path) && is_in_production)
        {
            // Fallback to old file, can be removed later
            // Home image only sets when user changes home, so it will take time for users to switch to pngs
            temp_str += "screen_home.bmp";
            image_codec = IMG_CODEC_BMP;
        }
        else
        {
            temp_str = path;
        }
    }

    LLPointer<LLImageFormatted> start_image_frmted = LLImageFormatted::createFromType(image_codec);

    // Turn off start screen to get around the occasional readback
    // driver bug
    if (!gSavedSettings.getBOOL("UseStartScreen"))
    {
        LL_INFOS("AppInit") << "Bitmap load disabled" << LL_ENDL;
        return;
    }
    else if (!start_image_frmted->load(temp_str))
    {
        LL_WARNS("AppInit") << "Bitmap load failed" << LL_ENDL;
        gStartTexture = NULL;
    }
    else
    {
        gStartImageWidth = start_image_frmted->getWidth();
        gStartImageHeight = start_image_frmted->getHeight();

        LLPointer<LLImageRaw> raw = new LLImageRaw;
        if (!start_image_frmted->decode(raw, 0.0f))
        {
            LL_WARNS("AppInit") << "Bitmap decode failed" << LL_ENDL;
            gStartTexture = NULL;
        }
        else
        {
            // HACK: getLocalTexture allows only power of two dimentions
            raw->expandToPowerOfTwo();
            gStartTexture = LLViewerTextureManager::getLocalTexture(raw.get(), FALSE);
        }
    }

    if (gStartTexture.isNull())
    {
        gStartTexture = LLViewerTexture::sBlackImagep;
        gStartImageWidth = gStartTexture->getWidth();
        gStartImageHeight = gStartTexture->getHeight();
    }
}

void LLProgressView::initTextures(S32 location_id, bool is_in_production)
{
    initStartTexture(location_id, is_in_production);
    initLogos();

    childSetVisible("panel_icons", mLogosList.empty() ? FALSE : TRUE);
    childSetVisible("panel_top_spacer", mLogosList.empty() ? TRUE : FALSE);
}

void LLProgressView::releaseTextures()
{
    gStartTexture = NULL;
    mLogosList.clear();

    childSetVisible("panel_top_spacer", TRUE);
    childSetVisible("panel_icons", FALSE);
}

void LLProgressView::setCancelButtonVisible(BOOL b, const std::string& label)
{
    mCancelBtn->setVisible( b );
    mCancelBtn->setEnabled( b );
    mCancelBtn->setLabelSelected(label);
    mCancelBtn->setLabelUnselected(label);
}

// static
void LLProgressView::onCancelButtonClicked(void*)
{
    // Quitting viewer here should happen only when "Quit" button is pressed while starting up.
    // Check for startup state is used here instead of teleport state to avoid quitting when
    // cancel is pressed while teleporting inside region (EXT-4911)
    if (LLStartUp::getStartupState() < STATE_STARTED)
    {
        LL_INFOS() << "User requesting quit during login" << LL_ENDL;
        LLAppViewer::instance()->requestQuit();
    }
    else
    {
        gAgent.teleportCancel();
        sInstance->mCancelBtn->setEnabled(FALSE);
        sInstance->setVisible(FALSE);
    }
}

// static
void LLProgressView::onClickMessage(void* data)
{
    LLProgressView* viewp = (LLProgressView*)data;
    if ( viewp != NULL && ! viewp->mMessage.empty() )
    {
        std::string url_to_open( "" );

        size_t start_pos;
        start_pos = viewp->mMessage.find( "https://" );
        if (start_pos == std::string::npos)
            start_pos = viewp->mMessage.find( "http://" );
        if (start_pos == std::string::npos)
            start_pos = viewp->mMessage.find( "ftp://" );

        if ( start_pos != std::string::npos )
        {
            size_t end_pos = viewp->mMessage.find_first_of( " \n\r\t", start_pos );
            if ( end_pos != std::string::npos )
                url_to_open = viewp->mMessage.substr( start_pos, end_pos - start_pos );
            else
                url_to_open = viewp->mMessage.substr( start_pos );

            LLWeb::loadURLExternal( url_to_open );
        }
    }
}

bool LLProgressView::handleUpdate(const LLSD& event_data)
{
    LLSD message = event_data.get("message");
    LLSD desc = event_data.get("desc");
    LLSD percent = event_data.get("percent");

    if(message.isDefined())
    {
        setMessage(message.asString());
    }

    if(desc.isDefined())
    {
        setText(desc.asString());
    }

    if(percent.isDefined())
    {
        setPercent(percent.asReal());
    }
    return false;
}

bool LLProgressView::onAlertModal(const LLSD& notify)
{
    // if the progress view is visible, it will obscure the notification window
    // in this case, we want to auto-accept WebLaunchExternalTarget notifications
    if (isInVisibleChain() && notify["sigtype"].asString() == "add")
    {
        LLNotificationPtr notifyp = LLNotifications::instance().find(notify["id"].asUUID());
        if (notifyp && notifyp->getName() == "WebLaunchExternalTarget")
        {
            notifyp->respondWithDefault();
        }
    }
    return false;
}

void LLProgressView::handleMediaEvent(LLPluginClassMedia* self, EMediaEvent event)
{
    // the intro web content calls javascript::window.close() when it's done
    if( event == MEDIA_EVENT_CLOSE_REQUEST )
    {
        if (mStartupComplete)
        {
            //make sure other timer has stopped
            mFadeFromLoginTimer.stop();
            mFadeToWorldTimer.start();
        }
        else
        {
            // hide the media ctrl and wait for startup to be completed before fading to world
            mMediaCtrl->setVisible(false);
            if (mMediaCtrl->getMediaPlugin())
            {
                mMediaCtrl->getMediaPlugin()->stop();
            }

            // show the progress bar
            getChild<LLView>("stack1")->setVisible(true);
        }
    }
}


// static
void LLProgressView::onIdle(void* user_data)
{
    LLProgressView* self = (LLProgressView*) user_data;

    // Close login panel on mFadeToWorldTimer expiration.
    if (self->mFadeFromLoginTimer.getStarted() &&
        self->mFadeFromLoginTimer.getElapsedTimeF32() > FADE_TO_WORLD_TIME)
    {
        self->mFadeFromLoginTimer.stop();
        LLPanelLogin::closePanel();

        // Nothing to do anymore.
        gIdleCallbacks.deleteFunction(onIdle, user_data);
    }
}