llpaneldirfind.cpp

Go to the documentation of this file.

#include "llviewerprecompiledheaders.h"

#include "llpaneldirfind.h"

// linden library includes
#include "llclassifiedflags.h"
#include "llfontgl.h"
#include "llparcel.h"
#include "llqueryflags.h"
#include "message.h"

// viewer project includes
#include "llagent.h"
#include "llbutton.h"
#include "llcheckboxctrl.h"
#include "lllineeditor.h"
#include "llcombobox.h"
#include "llviewercontrol.h"
#include "llmenucommands.h"
#include "llmenugl.h"
#include "lltextbox.h"
#include "lluiconstants.h"
#include "llviewerimagelist.h"
#include "llviewermessage.h"
#include "llfloateravatarinfo.h"
#include "lldir.h"
#include "llviewercontrol.h"
#include "llviewerregion.h"             // for region name for search urls
#include "llvieweruictrlfactory.h"
#include "llfloaterdirectory.h"
#include "llpaneldirbrowser.h"

#include <boost/tokenizer.hpp>

//---------------------------------------------------------------------------
// LLPanelDirFindAll - Google search appliance based search
//---------------------------------------------------------------------------

class LLPanelDirFindAll
:       public LLPanelDirBrowser,
        public LLWebBrowserCtrlObserver
{
public:
        LLPanelDirFindAll(const std::string& name, LLFloaterDirectory* floater);
        /*virtual*/ ~LLPanelDirFindAll();

        /*virtual*/ BOOL postBuild();
        /*virtual*/ void draw();

        void search(const std::string& search_text);
        void focus();
        void navigateToDefaultPage();

private:
        static void onClickBack( void* data );
        static void onClickForward( void* data );
        static void onClickHome( void* data );
        static void onClickSearch( void* data );
        static void onCommitSearch(LLUICtrl*, void* data);

        static std::string getSearchURLSuffix(bool mature);

        /*virtual*/ void onNavigateBegin( const EventType& eventIn );
        /*virtual*/ void onNavigateComplete( const EventType& eventIn );
                // Used to update progress indicator
        /*virtual*/ void onLocationChange( const EventType& eventIn );
                // Debugging info to console

private:
#if LL_LIBXUL_ENABLED
        LLWebBrowserCtrl* mWebBrowser;
#endif // LL_LIBXUL_ENABLED
};


LLPanelDirFindAll::LLPanelDirFindAll(const std::string& name, LLFloaterDirectory* floater)
:       LLPanelDirBrowser(name, floater)
#if LL_LIBXUL_ENABLED
        ,mWebBrowser(NULL)
#endif // LL_LIBXUL_ENABLED
{
        mMinSearchChars = 3;
}

BOOL LLPanelDirFindAll::postBuild()
{
        LLPanelDirBrowser::postBuild();

        childSetAction("back_btn", onClickBack, this);
        childSetAction("home_btn", onClickHome, this);
        childSetAction("forward_btn", onClickForward, this);
        childSetCommitCallback("search_editor", onCommitSearch, this);
        childSetAction("search_btn", onClickSearch, this);

        if (gAgent.isTeen())
        {
                childSetVisible("mature_check", false);
                childSetValue("mature_check", false);
        }

#if LL_LIBXUL_ENABLED
        mWebBrowser = LLViewerUICtrlFactory::getWebBrowserByName(this, "find_browser");
        if (mWebBrowser)
        {
                // new pages appear in same window as the results page now
                mWebBrowser->setOpenInInternalBrowser( false );
                mWebBrowser->setOpenInExternalBrowser( false ); 

                // redirect 404 pages from S3 somewhere else
                mWebBrowser->set404RedirectUrl( childGetText("redirect_404_url") );
                
                // Track updates for progress display.
                mWebBrowser->addObserver(this);

                navigateToDefaultPage();
        }
#endif // LL_LIBXUL_ENABLED

        return TRUE;
}

LLPanelDirFindAll::~LLPanelDirFindAll()
{
#if LL_LIBXUL_ENABLED
        if (mWebBrowser) mWebBrowser->remObserver(this);
#endif // LL_LIBXUL_ENABLED
}

// virtual
void LLPanelDirFindAll::draw()
{
        // enable/disable buttons depending on state
#if LL_LIBXUL_ENABLED
        if ( mWebBrowser )
        {
                bool enable_back = mWebBrowser->canNavigateBack();      
                childSetEnabled( "back_btn", enable_back );

                bool enable_forward = mWebBrowser->canNavigateForward();        
                childSetEnabled( "forward_btn", enable_forward );
        }
#endif // LL_LIBXUL_ENABLED

        LLPanelDirBrowser::draw();
}

void LLPanelDirFindAll::search(const std::string& search_text)
{
        if (!search_text.empty())
        {
                // Replace spaces with "+" for use by Google search appliance
                // Yes, this actually works for double-spaces
                // " foo  bar" becomes "+foo++bar" and works fine. JC

                // Since we are already iterating over the query,
                // do our own custom escaping here.

                // Our own special set of allowed chars (RFC1738 http://www.ietf.org/rfc/rfc1738.txt)
                const char* allowed =   
                        "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
                        "0123456789"
                        "-._~$+!*'()";

                std::string query;
                std::string::const_iterator it = search_text.begin();
                for ( ; it != search_text.end(); ++it )
                {
                        if ( std::isspace( *it ) )
                        {
                                query += '+';
                        }
                        else if(strchr(allowed,*it))
                        {
                                // The character is in the allowed set, just copy it
                                query += *it;
                        }
                        else
                        {
                                // Do escaping
                                query += llformat("%%%02X", *it);
                        }
                }

                std::string url = gSavedSettings.getString("SearchURLQuery");
                std::string substring = "[QUERY]";
                url.replace(url.find(substring), substring.length(), query);

                // replace the collection name with the one selected from the combo box
                std::string selected_collection = childGetValue( "Category" ).asString();
                substring = "[COLLECTION]";
                url.replace(url.find(substring), substring.length(), selected_collection);

                // Add common parameters (mature, teen, location)
                bool mature = childGetValue( "mature_check" ).asBoolean();
                url += getSearchURLSuffix(mature);

                llinfos << "url " << url << llendl;

#if LL_LIBXUL_ENABLED
                if (mWebBrowser)
                {
                        mWebBrowser->navigateTo(url);
                }
#endif // LL_LIBXUL_ENABLED
        }
        else
        {
                // empty search text
                navigateToDefaultPage();
        }

        childSetText("search_editor", search_text);
}

void LLPanelDirFindAll::focus()
{
        childSetFocus("search_editor");
}

void LLPanelDirFindAll::navigateToDefaultPage()
{
        std::string start_url = gSavedSettings.getString("SearchURLDefault");
        bool mature = childGetValue( "mature_check" ).asBoolean();
        start_url += getSearchURLSuffix( mature );

        llinfos << "default url: "  << start_url << llendl;

#if LL_LIBXUL_ENABLED
        if (mWebBrowser)
        {
                mWebBrowser->navigateTo( start_url );
        }
#endif //LL_LIBXUL_ENABLED
}

// static
std::string LLPanelDirFindAll::getSearchURLSuffix(bool mature_in)
{
        bool mature = mature_in;
        // Teens never get mature results.  Explicitly override because 
        // Lindens/testers have multiple accounts and shared settings sometimes 
        // result in teen=Y and mature=Y simultaneously.  JC
        if (gAgent.isTeen())
        {
                mature = false;
        }

        std::string url = gSavedSettings.getString("SearchURLSuffix");

        // if the mature checkbox is unchecked, modify query to remove 
        // terms with given phrase from the result set
        std::string substring = "[MATURE]";
        const char* mature_flag = (mature ? "Y" : "N");
        url.replace(url.find(substring), substring.length(), mature_flag);

        substring = "[TEEN]";
        const char* teen_flag = (gAgent.isTeen() ? "Y" : "N");
        url.replace(url.find(substring), substring.length(), teen_flag);

        // Include region and x/y position, not for the GSA, but
        // just to get logs on the web server for search_proxy.php
        // showing where people were standing when they searched.
        std::string region_name;
        LLViewerRegion* region = gAgent.getRegion();
        if (region)
        {
                region_name = region->getName();
        }
        // take care of spaces in names
        region_name = LLURI::escape(region_name);
        substring = "[REGION]";
        url.replace(url.find(substring), substring.length(), region_name);

        LLVector3 pos_region = gAgent.getPositionAgent();

        std::string x = llformat("%.0f", pos_region.mV[VX]);
        substring = "[X]";
        url.replace(url.find(substring), substring.length(), x);
        std::string y = llformat("%.0f", pos_region.mV[VY]);
        substring = "[Y]";
        url.replace(url.find(substring), substring.length(), y);
        std::string z = llformat("%.0f", pos_region.mV[VZ]);
        substring = "[Z]";
        url.replace(url.find(substring), substring.length(), z);

        return url;
}


// static
void LLPanelDirFindAll::onClickBack( void* data )
{
#if LL_LIBXUL_ENABLED
        LLPanelDirFindAll* self = ( LLPanelDirFindAll* )data;
        if ( self->mWebBrowser )
        {
                self->mWebBrowser->navigateBack();
        }
#endif // LL_LIBXUL_ENABLED
}

// static
void LLPanelDirFindAll::onClickForward( void* data )
{
#if LL_LIBXUL_ENABLED
        LLPanelDirFindAll* self = ( LLPanelDirFindAll* )data;
        if ( self->mWebBrowser )
        {
                self->mWebBrowser->navigateForward();
        }
#endif // LL_LIBXUL_ENABLED
}

// static
void LLPanelDirFindAll::onClickHome( void* data )
{
#if LL_LIBXUL_ENABLED
        LLPanelDirFindAll* self = ( LLPanelDirFindAll* )data;
        if ( self->mWebBrowser )
        {
                self->mWebBrowser->navigateHome();
        }
#endif // LL_LIBXUL_ENABLED
}

// static
void LLPanelDirFindAll::onCommitSearch(LLUICtrl*, void* data)
{
        onClickSearch(data);
}

// static
void LLPanelDirFindAll::onClickSearch(void* data)
{
        LLPanelDirFindAll* self = ( LLPanelDirFindAll* )data;
        LLString search_text = self->childGetText("search_editor");
        self->search(search_text);
}

void LLPanelDirFindAll::onNavigateBegin( const EventType& eventIn )
{
        childSetText("status_text", childGetText("loading_text"));
}

void LLPanelDirFindAll::onNavigateComplete( const EventType& eventIn )
{
        childSetText("status_text", childGetText("done_text"));
}

void LLPanelDirFindAll::onLocationChange( const EventType& eventIn )
{
        llinfos << eventIn.getStringValue() << llendl;
}

//---------------------------------------------------------------------------
// LLPanelDirFindAllInterface
//---------------------------------------------------------------------------

// static
LLPanelDirFindAll* LLPanelDirFindAllInterface::create(LLFloaterDirectory* floater)
{
        return new LLPanelDirFindAll("find_all_panel", floater);
}

// static
void LLPanelDirFindAllInterface::search(LLPanelDirFindAll* panel,
                                                                                const std::string& search_text)
{
        panel->search(search_text);
}

// static
void LLPanelDirFindAllInterface::focus(LLPanelDirFindAll* panel)
{
        panel->focus();
}

//---------------------------------------------------------------------------
// LLPanelDirFindAllOld - deprecated if new Google search works out. JC
//---------------------------------------------------------------------------

LLPanelDirFindAllOld::LLPanelDirFindAllOld(const std::string& name, LLFloaterDirectory* floater)
        :       LLPanelDirBrowser(name, floater)
{
        mMinSearchChars = 3;
}

BOOL LLPanelDirFindAllOld::postBuild()
{
        LLPanelDirBrowser::postBuild();

        childSetKeystrokeCallback("name", &LLPanelDirBrowser::onKeystrokeName, this);

        childSetAction("Search", onClickSearch, this);
        childDisable("Search");
        setDefaultBtn( "Search" );

        return TRUE;
}

LLPanelDirFindAllOld::~LLPanelDirFindAllOld()
{
        // Children all cleaned up by default view destructor.
}

// virtual
void LLPanelDirFindAllOld::draw()
{
        // You only have a choice if you are mature
        childSetVisible("incmature", !gAgent.isTeen());
        childSetValue("incmature", gSavedSettings.getBOOL("ShowMatureFindAll"));

        LLPanelDirBrowser::draw();
}

// static
void LLPanelDirFindAllOld::onCommitScope(LLUICtrl* ctrl, void* data)
{
        LLPanelDirFindAllOld* self = (LLPanelDirFindAllOld*)data;
        self->setFocus(TRUE);
}

// static
void LLPanelDirFindAllOld::onClickSearch(void *userdata)
{
        LLPanelDirFindAllOld *self = (LLPanelDirFindAllOld *)userdata;

        if (self->childGetValue("name").asString().length() < self->mMinSearchChars)
        {
                return;
        };

        self->setupNewSearch();

        // Figure out scope
        U32 scope = 0x0;
        scope |= DFQ_PEOPLE;    // people (not just online = 0x01 | 0x02)
        // places handled below
        scope |= DFQ_EVENTS;    // events
        scope |= DFQ_GROUPS;    // groups

        BOOL filter_mature = (!gSavedSettings.getBOOL("ShowMatureFindAll") || 
                 gAgent.isTeen() ||
                 !self->childGetValue("incmature").asBoolean() );

        if ( filter_mature )
        {
                scope |= DFQ_PG_SIMS_ONLY;
                scope |= DFQ_PG_EVENTS_ONLY;
                scope |= DFQ_FILTER_MATURE;
                scope |= DFQ_PG_PARCELS_ONLY;
        }

        // send the message
        LLMessageSystem *msg = gMessageSystem;
        S32 start_row = 0;
        sendDirFindQuery(msg, self->mSearchID, self->childGetValue("name").asString(), scope, start_row);

        // Also look up classified ads. JC 12/2005
        BOOL filter_auto_renew = FALSE;
        U32 classified_flags = pack_classified_flags(filter_mature, filter_auto_renew);
        msg->newMessage("DirClassifiedQuery");
        msg->nextBlock("AgentData");
        msg->addUUID("AgentID", gAgent.getID());
        msg->addUUID("SessionID", gAgent.getSessionID());
        msg->nextBlock("QueryData");
        msg->addUUID("QueryID", self->mSearchID);
        msg->addString("QueryText", self->childGetValue("name").asString());
        msg->addU32("QueryFlags", classified_flags);
        msg->addU32("Category", 0);     // all categories
        msg->addS32("QueryStart", 0);
        gAgent.sendReliableMessage();

        // Need to use separate find places query because places are
        // sent using the more compact DirPlacesReply message.
        U32 query_flags = DFQ_DWELL_SORT;
        if ( filter_mature )
        {
        query_flags |= DFQ_PG_SIMS_ONLY;
                query_flags |= DFQ_PG_PARCELS_ONLY;     // FWIW, currently DFQ_PG_PARCELS_ONLY is only supported
                query_flags |= DFQ_FILTER_MATURE;
        }
        msg->newMessage("DirPlacesQuery");
        msg->nextBlock("AgentData");
        msg->addUUID("AgentID", gAgent.getID() );
        msg->addUUID("SessionID", gAgent.getSessionID());
        msg->nextBlock("QueryData");
        msg->addUUID("QueryID", self->mSearchID );
        msg->addString("QueryText", self->childGetValue("name").asString());
        msg->addU32("QueryFlags", query_flags );
        msg->addS32("QueryStart", 0 ); // Always get the first 100 when using find ALL
        msg->addS8("Category", LLParcel::C_ANY);
        msg->addString("SimName", NULL);
        gAgent.sendReliableMessage();
}

---