/OpenSimSearch/Modules/SearchModule/OpenSearch.cs

/*

 * Copyright (c) Contributors, http://aurora-sim.org/

 * See CONTRIBUTORS.TXT for a full list of copyright holders.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions are met:

 *     * Redistributions of source code must retain the above copyright

 *       notice, this list of conditions and the following disclaimer.

 *     * Redistributions in binary form must reproduce the above copyright

 *       notice, this list of conditions and the following disclaimer in the

 *       documentation and/or other materials provided with the distribution.

 *     * Neither the name of the Aurora-Sim Project nor the

 *       names of its contributors may be used to endorse or promote products

 *       derived from this software without specific prior written permission.

 *

 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY

 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY

 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */



using System;

using System.Collections;

using System.Collections.Generic;

using System.Globalization;

using System.Net;

using System.Net.Sockets;

using System.Reflection;

using System.Xml;

using OpenMetaverse;

using log4net;

using Nini.Config;

using Nwc.XmlRpc;

using Aurora.Framework;

using OpenSim.Region.Framework.Interfaces;

using OpenSim.Region.Framework.Scenes;

using OpenSim.Services.Interfaces;



namespace OpenSimSearch.Modules.OpenSearch

{

    public class OpenSearchModule : ISharedRegionModule

    {

        //

        // Log module

        //

        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);



        //

        // Module vars

        //

        private IConfigSource m_gConfig;

        private List<IScene> m_Scenes = new List<IScene>();

        private string m_SearchServer = "";

        private bool m_Enabled = true;



        public void Initialise(IConfigSource source)

        {

            m_gConfig = source;

            IConfig searchConfig = source.Configs["Search"];



            if (searchConfig == null)

            {

                m_log.Info("[SEARCH] Not configured, disabling");

                m_Enabled = false;

                return;

            }

            m_SearchServer = searchConfig.GetString("SearchURL", "");

            if (m_SearchServer == "")

            {

                //m_log.Debug("[SEARCH] No search server, disabling search");

                m_Enabled = false;

                return;

            }

            else

            {

                m_log.Info("[SEARCH] Search module is activated");

                m_Enabled = true;

            }

        }



        public void PostInitialise()

        {

        }



        public void AddRegion(IScene scene)

        {

            if (!m_Enabled)

                return;



            m_Scenes.Add(scene);



            // Hook up events

            scene.EventManager.OnNewClient += OnNewClient;

        }



        public void RemoveRegion(IScene scene)

        {

            m_Scenes.Remove(scene);



            // Hook up events

            scene.EventManager.OnNewClient -= OnNewClient;

        }



        public void RegionLoaded(IScene scene)

        {

        }



        public void Close()

        {

        }



        public Type ReplaceableInterface

        {

            get { return null; }

        }



        public string Name

        {

            get { return "SearchModule"; }

        }



        /// New Client Event Handler

        private void OnNewClient(IClientAPI client)

        {

            // Subscribe to messages

            client.OnDirPlacesQuery += DirPlacesQuery;

            client.OnDirFindQuery += DirFindQuery;

            client.OnDirPopularQuery += DirPopularQuery;

            client.OnDirLandQuery += DirLandQuery;

            client.OnDirClassifiedQuery += DirClassifiedQuery;

            // Response after Directory Queries

            client.OnEventInfoRequest += EventInfoRequest;

            client.OnClassifiedInfoRequest += ClassifiedInfoRequest;

            client.OnMapItemRequest += HandleMapItemRequest;

        }



        //

        // Make external XMLRPC request

        //

        private Hashtable GenericXMLRPCRequest(Hashtable ReqParams, string method)

        {

            ArrayList SendParams = new ArrayList();

            SendParams.Add(ReqParams);



            // Send Request

            XmlRpcResponse Resp;

            try

            {

                XmlRpcRequest Req = new XmlRpcRequest(method, SendParams);

                Resp = Req.Send(m_SearchServer, 30000);

            }

            catch (WebException ex)

            {

                m_log.ErrorFormat("[SEARCH]: Unable to connect to Search " +

                        "Server {0}.  Exception {1}", m_SearchServer, ex);



                Hashtable ErrorHash = new Hashtable();

                ErrorHash["success"] = false;

                ErrorHash["errorMessage"] = "Unable to search at this time. ";

                ErrorHash["errorURI"] = "";



                return ErrorHash;

            }

            catch (SocketException ex)

            {

                m_log.ErrorFormat(

                        "[SEARCH]: Unable to connect to Search Server {0}. " +

                        "Exception {1}", m_SearchServer, ex);



                Hashtable ErrorHash = new Hashtable();

                ErrorHash["success"] = false;

                ErrorHash["errorMessage"] = "Unable to search at this time. ";

                ErrorHash["errorURI"] = "";



                return ErrorHash;

            }

            catch (XmlException ex)

            {

                m_log.ErrorFormat(

                        "[SEARCH]: Unable to connect to Search Server {0}. " +

                        "Exception {1}", m_SearchServer, ex);



                Hashtable ErrorHash = new Hashtable();

                ErrorHash["success"] = false;

                ErrorHash["errorMessage"] = "Unable to search at this time. ";

                ErrorHash["errorURI"] = "";



                return ErrorHash;

            }

            if (Resp.IsFault)

            {

                Hashtable ErrorHash = new Hashtable();

                ErrorHash["success"] = false;

                ErrorHash["errorMessage"] = "Unable to search at this time. ";

                ErrorHash["errorURI"] = "";

                return ErrorHash;

            }

            Hashtable RespData = (Hashtable)Resp.Value;



            return RespData;

        }



        protected void DirPlacesQuery(IClientAPI remoteClient, UUID queryID,

                string queryText, int queryFlags, int category, string simName,

                int queryStart)

        {

            Hashtable ReqHash = new Hashtable();

            ReqHash["text"] = queryText;

            ReqHash["flags"] = queryFlags.ToString();

            ReqHash["category"] = category.ToString();

            ReqHash["sim_name"] = simName;

            ReqHash["query_start"] = queryStart.ToString();



            Hashtable result = GenericXMLRPCRequest(ReqHash,

                    "dir_places_query");



            if (!Convert.ToBoolean(result["success"]))

            {

                remoteClient.SendAgentAlertMessage(

                        result["errorMessage"].ToString(), false);

                return;

            }



            ArrayList dataArray = (ArrayList)result["data"];



            int count = dataArray.Count;

            if (count > 100)

                count = 101;



            DirPlacesReplyData[] data = new DirPlacesReplyData[count];



            int i = 0;



            foreach (Object o in dataArray)

            {

                Hashtable d = (Hashtable)o;



                data[i] = new DirPlacesReplyData();

                data[i].parcelID = new UUID(d["parcel_id"].ToString());

                data[i].name = d["name"].ToString();

                data[i].forSale = Convert.ToBoolean(d["for_sale"]);

                data[i].auction = Convert.ToBoolean(d["auction"]);

                data[i].dwell = Convert.ToSingle(d["dwell"]);

                i++;

                if (i >= count)

                    break;

            }



            remoteClient.SendDirPlacesReply(queryID, data);

        }



        public void DirPopularQuery(IClientAPI remoteClient, UUID queryID, uint queryFlags)

        {

            Hashtable ReqHash = new Hashtable();

            ReqHash["flags"] = queryFlags.ToString();



            Hashtable result = GenericXMLRPCRequest(ReqHash,

                    "dir_popular_query");



            if (!Convert.ToBoolean(result["success"]))

            {

                remoteClient.SendAgentAlertMessage(

                        result["errorMessage"].ToString(), false);

                return;

            }



            ArrayList dataArray = (ArrayList)result["data"];



            int count = dataArray.Count;

            if (count > 100)

                count = 101;



            DirPopularReplyData[] data = new DirPopularReplyData[count];



            int i = 0;



            foreach (Object o in dataArray)

            {

                Hashtable d = (Hashtable)o;



                data[i] = new DirPopularReplyData();

                data[i].ParcelID = new UUID(d["parcel_id"].ToString());

                data[i].Name = d["name"].ToString();

                data[i].Dwell = Convert.ToSingle(d["dwell"]);

                i++;

                if (i >= count)

                    break;

            }



            remoteClient.SendDirPopularReply(queryID, data);

        }



        public void DirLandQuery(IClientAPI remoteClient, UUID queryID, uint queryFlags, uint searchType, uint price, uint area, int queryStart)

        {

            Hashtable ReqHash = new Hashtable();

            ReqHash["flags"] = queryFlags.ToString();

            ReqHash["type"] = searchType.ToString();

            ReqHash["price"] = price.ToString();

            ReqHash["area"] = area.ToString();

            ReqHash["query_start"] = queryStart.ToString();



            Hashtable result = GenericXMLRPCRequest(ReqHash,

                    "dir_land_query");



            if (!Convert.ToBoolean(result["success"]))

            {

                remoteClient.SendAgentAlertMessage(

                        result["errorMessage"].ToString(), false);

                return;

            }



            ArrayList dataArray = (ArrayList)result["data"];



            int count = dataArray.Count;

            if (count > 100)

                count = 101;



            DirLandReplyData[] data = new DirLandReplyData[count];



            int i = 0;



            foreach (Object o in dataArray)

            {

                Hashtable d = (Hashtable)o;



                if (d["name"] == null)

                    continue;



                data[i] = new DirLandReplyData();

                data[i].parcelID = new UUID(d["parcel_id"].ToString());

                data[i].name = d["name"].ToString();

                data[i].auction = Convert.ToBoolean(d["auction"]);

                data[i].forSale = Convert.ToBoolean(d["for_sale"]);

                data[i].salePrice = Convert.ToInt32(d["sale_price"]);

                data[i].actualArea = Convert.ToInt32(d["area"]);

                i++;

                if (i >= count)

                    break;

            }



            remoteClient.SendDirLandReply(queryID, data);

        }



        public void DirFindQuery(IClientAPI remoteClient, UUID queryID,

                string queryText, uint queryFlags, int queryStart)

        {

            if ((queryFlags & 1) != 0)		//People (1 << 0)

            {

                DirPeopleQuery(remoteClient, queryID, queryText, queryFlags,

                        queryStart);

                return;

            }

            else if ((queryFlags & 32) != 0)	//DateEvents (1 << 5)

            {

                DirEventsQuery(remoteClient, queryID, queryText, queryFlags,

                        queryStart);

                return;

            }

        }



        public void DirPeopleQuery(IClientAPI remoteClient, UUID queryID,

                string queryText, uint queryFlags, int queryStart)

        {

            List<UserAccount> accounts = m_Scenes[0].UserAccountService.GetUserAccounts(null, queryText);



            DirPeopleReplyData[] data =

                    new DirPeopleReplyData[accounts.Count];



            int i = 0;

            foreach (UserAccount item in accounts)

            {

                data[i] = new DirPeopleReplyData();



                data[i].agentID = item.PrincipalID;

                data[i].firstName = item.FirstName;

                data[i].lastName = item.LastName;

                data[i].group = "";

                data[i].online = false;

                data[i].reputation = 0;

                i++;

            }



            remoteClient.SendDirPeopleReply(queryID, data);

        }

        public void DirEventsQuery(IClientAPI remoteClient, UUID queryID,

                string queryText, uint queryFlags, int queryStart)

        {

            Hashtable ReqHash = new Hashtable();

            ReqHash["text"] = queryText;

            ReqHash["flags"] = queryFlags.ToString();

            ReqHash["query_start"] = queryStart.ToString();



            Hashtable result = GenericXMLRPCRequest(ReqHash,

                    "dir_events_query");



            if (!Convert.ToBoolean(result["success"]))

            {

                remoteClient.SendAgentAlertMessage(

                        result["errorMessage"].ToString(), false);

                return;

            }



            ArrayList dataArray = (ArrayList)result["data"];



            int count = dataArray.Count;

            if (count > 100)

                count = 101;



            DirEventsReplyData[] data = new DirEventsReplyData[count];



            int i = 0;



            foreach (Object o in dataArray)

            {

                Hashtable d = (Hashtable)o;



                data[i] = new DirEventsReplyData();

                data[i].ownerID = new UUID(d["owner_id"].ToString());

                data[i].name = d["name"].ToString();

                data[i].eventID = Convert.ToUInt32(d["event_id"]);

                data[i].date = d["date"].ToString();

                data[i].unixTime = Convert.ToUInt32(d["unix_time"]);

                data[i].eventFlags = Convert.ToUInt32(d["event_flags"]);

                i++;

                if (i >= count)

                    break;

            }



            remoteClient.SendDirEventsReply(queryID, data);

        }



        public void DirClassifiedQuery(IClientAPI remoteClient, UUID queryID, 

                string queryText, uint queryFlags, uint category,

                int queryStart)

        {

            Hashtable ReqHash = new Hashtable();

            ReqHash["text"] = queryText;

            ReqHash["flags"] = queryFlags.ToString();

            ReqHash["category"] = category.ToString();

            ReqHash["query_start"] = queryStart.ToString();



            Hashtable result = GenericXMLRPCRequest(ReqHash,

                    "dir_classified_query");



            if (!Convert.ToBoolean(result["success"]))

            {

                remoteClient.SendAgentAlertMessage(

                        result["errorMessage"].ToString(), false);

                return;

            }



            ArrayList dataArray = (ArrayList)result["data"];



            int count = dataArray.Count;

            if (count > 100)

                count = 101;



            DirClassifiedReplyData[] data = new DirClassifiedReplyData[count];



            int i = 0;



            foreach (Object o in dataArray)

            {

                Hashtable d = (Hashtable)o;



                data[i] = new DirClassifiedReplyData();

                data[i].classifiedID = new UUID(d["classifiedid"].ToString());

                data[i].name = d["name"].ToString();

                data[i].classifiedFlags = Convert.ToByte(d["classifiedflags"]);

                data[i].creationDate = Convert.ToUInt32(d["creation_date"]);

                data[i].expirationDate = Convert.ToUInt32(d["expiration_date"]);

                data[i].price = Convert.ToInt32(d["priceforlisting"]);

                i++;

                if (i >= count)

                    break;

            }



            remoteClient.SendDirClassifiedReply(queryID, data);

        }



        public void EventInfoRequest(IClientAPI remoteClient, uint queryEventID)

        {

            Hashtable ReqHash = new Hashtable();

            ReqHash["eventID"] = queryEventID.ToString();



            Hashtable result = GenericXMLRPCRequest(ReqHash,

                    "event_info_query");



            if (!Convert.ToBoolean(result["success"]))

            {

                remoteClient.SendAgentAlertMessage(

                        result["errorMessage"].ToString(), false);

                return;

            }



            ArrayList dataArray = (ArrayList)result["data"];

            if (dataArray.Count == 0)

            {

                // something bad happened here, if we could return an

                // event after the search,

                // we should be able to find it here

                // TODO do some (more) sensible error-handling here

                remoteClient.SendAgentAlertMessage("Couldn't find this event.",

                        false);

                return;

            }



            Hashtable d = (Hashtable)dataArray[0];

            EventData data = new EventData();

            data.eventID = Convert.ToUInt32(d["event_id"]);

            data.creator = d["creator"].ToString();

            data.name = d["name"].ToString();

            data.category = d["category"].ToString();

            data.description = d["description"].ToString();

            data.date = d["date"].ToString();

            data.dateUTC = Convert.ToUInt32(d["dateUTC"]);

            data.duration = Convert.ToUInt32(d["duration"]);

            data.cover = Convert.ToUInt32(d["covercharge"]);

            data.amount = Convert.ToUInt32(d["coveramount"]);

            data.simName = d["simname"].ToString();

            Vector3.TryParse(d["globalposition"].ToString(), out data.globalPos);

            data.eventFlags = Convert.ToUInt32(d["eventflags"]);



            remoteClient.SendEventInfoReply(data);

        }



        public void ClassifiedInfoRequest(UUID queryClassifiedID, IClientAPI remoteClient)

        {

            Hashtable ReqHash = new Hashtable();

            ReqHash["classifiedID"] = queryClassifiedID.ToString();



            Hashtable result = GenericXMLRPCRequest(ReqHash,

                    "classifieds_info_query");



            if (!Convert.ToBoolean(result["success"]))

            {

                remoteClient.SendAgentAlertMessage(

                        result["errorMessage"].ToString(), false);

                return;

            }



            ArrayList dataArray = (ArrayList)result["data"];

            if (dataArray.Count == 0)

            {

                // something bad happened here, if we could return an

                // event after the search,

                // we should be able to find it here

                // TODO do some (more) sensible error-handling here

                remoteClient.SendAgentAlertMessage("Couldn't find this classifieds.",

                        false);

                return;

            }



            Hashtable d = (Hashtable)dataArray[0];



            Vector3 globalPos = new Vector3();

            Vector3.TryParse(d["posglobal"].ToString(), out globalPos);



            remoteClient.SendClassifiedInfoReply(

                    new UUID(d["classifieduuid"].ToString()),

                    new UUID(d["creatoruuid"].ToString()),

                    Convert.ToUInt32(d["creationdate"]),

                    Convert.ToUInt32(d["expirationdate"]),

                    Convert.ToUInt32(d["category"]),

                    d["name"].ToString(),

                    d["description"].ToString(),

                    new UUID(d["parceluuid"].ToString()),

                    Convert.ToUInt32(d["parentestate"]),

                    new UUID(d["snapshotuuid"].ToString()),

                    d["simname"].ToString(),

                    globalPos,

                    d["parcelname"].ToString(),

                    Convert.ToByte(d["classifiedflags"]),

                    Convert.ToInt32(d["priceforlisting"]));

        }

        public void HandleMapItemRequest(IClientAPI remoteClient, uint flags,

                                                 uint EstateID, bool godlike, uint itemtype, ulong regionhandle)

        {

            //The following constant appears to be from GridLayerType enum

            //defined in OpenMetaverse/GridManager.cs of libopenmetaverse.

            if (itemtype == 7) //(land sales)

            {

                int tc = Environment.TickCount;

                Hashtable ReqHash = new Hashtable();



                //The flags are: SortAsc (1 << 15), PerMeterSort (1 << 17)

                ReqHash["flags"] = "163840";

                ReqHash["type"] = "4294967295"; //This is -1 in 32 bits

                ReqHash["price"] = "0";

                ReqHash["area"] = "0";

                ReqHash["query_start"] = "0";



                Hashtable result = GenericXMLRPCRequest(ReqHash,

                                                        "dir_land_query");



                if (!Convert.ToBoolean(result["success"]))

                {

                    remoteClient.SendAgentAlertMessage(

                        result["errorMessage"].ToString(), false);

                    return;

                }



                ArrayList dataArray = (ArrayList)result["data"];



                int count = dataArray.Count;

                if (count > 100)

                    count = 101;



                DirLandReplyData[] Landdata = new DirLandReplyData[count];



                int i = 0;

                string[] ParcelLandingPoint = new string[count];

                string[] ParcelRegionUUID = new string[count];

                foreach (Object o in dataArray)

                {

                    Hashtable d = (Hashtable)o;



                    if (d["name"] == null)

                        continue;

                    Landdata[i] = new DirLandReplyData();

                    Landdata[i].parcelID = new UUID(d["parcel_id"].ToString());

                    Landdata[i].name = d["name"].ToString();

                    Landdata[i].auction = Convert.ToBoolean(d["auction"]);

                    Landdata[i].forSale = Convert.ToBoolean(d["for_sale"]);

                    Landdata[i].salePrice = Convert.ToInt32(d["sale_price"]);

                    Landdata[i].actualArea = Convert.ToInt32(d["area"]);

                    ParcelLandingPoint[i] = d["landing_point"].ToString();

                    ParcelRegionUUID[i] = d["region_UUID"].ToString();

                    i++;

                    if (i >= count)

                        break;

                }

                i = 0;

                int locX = 0;

                int locY = 0;



                List<mapItemReply> mapitems = new List<mapItemReply>();



                foreach (DirLandReplyData landDir in Landdata)

                {

                    foreach(IScene scene in m_Scenes)

                    {

                        if(scene.RegionInfo.RegionID.ToString() == ParcelRegionUUID[i])

                        {

                            locX = scene.RegionInfo.RegionLocX;

                            locY = scene.RegionInfo.RegionLocY;

                        }

                    }

                    string[] landingpoint = ParcelLandingPoint[i].Split('/');

                    mapItemReply mapitem = new mapItemReply();

                    mapitem.x = (uint)((locX * 256 ) + Convert.ToDecimal(landingpoint[0]));

                    mapitem.y = (uint)((locY * 256 ) + Convert.ToDecimal(landingpoint[1]));

                    mapitem.id = landDir.parcelID;

                    mapitem.name = landDir.name;

                    mapitem.Extra = landDir.actualArea;

                    mapitem.Extra2 = landDir.salePrice;

                    mapitems.Add(mapitem);

                    i++;

                }

                remoteClient.SendMapItemReply(mapitems.ToArray(), itemtype, flags);

                mapitems.Clear();

            }

        }

    }

}