<?php
/*
* Tools.php - Module Containing Usefull Functions to be used by other Modules
*
* Made by Temar (most code is Simply Taken from elsewhere)
*
* BeBot - An Anarchy Online & Age of Conan Chat Automaton
* Copyright (C) 2004 Jonas Jax
* Copyright (C) 2005-2007 Thomas Juberg Stens?s, ShadowRealm Creations and the BeBot development team.
*
* Developed by:
* - Alreadythere (RK2)
* - Blondengy (RK1)
* - Blueeagl3 (RK1)
* - Glarawyn (RK1)
* - Khalem (RK1)
* - Naturalistic (RK1)
* - Temar (RK1)
*
* See Credits file for all aknowledgements.
*
*  This program is free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; version 2 of the License only.
*
*  This program 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 General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with this program; if not, write to the Free Software
*  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
*  USA
*
* File last changed at $LastChangedDate: 2008-12-29 23:42:14 +0100 (Mon, 29 Dec 2008) $
* Revision: $Id: 14_Tools.php 1939 2008-12-29 22:42:14Z temar $
*/



$tools = new tools($bot);

class tools extends BasePassiveModule
{

    function __construct(&$bot)
    {
        parent::__construct(&$bot, get_class($this));

        $this -> register_module("tools");

        $this -> bot -> core("settings") -> create("tools", "get_site", "Sockets", "Should get_site use Sockets or Curl", "Sockets;Curl");

        $this -> register_event("settings", array("module" => "tools", "setting" => "get_site"));

        $this->randomsource = "";
        
        $this->useragent = BOT_VERSION_NAME . "/" . BOT_VERSION . BOT_VERSION_INFO . " (Originating bot: " . $this->bot->botname . "; Dimension: " . $this->bot->dimension . ";)";
    }

    function chatcmd($link, $title, $origin = FALSE)
    {
        $origin = strtolower($origin);
        switch($origin)
        {
            case'gc':
            case'o':
            case'gu':
            case '3':
                if($this -> bot -> game == "aoc")
                    $chatcmd = "gu <pre>";
                else
                    $chatcmd = "o <pre>";
                Break;
            case'pgmsg':
            case'pg':
            case '2':
                $chatcmd = "group ".$this -> bot -> botname." <pre>";
                Break;
            case 'start':
                $chatcmd = "start ";
                Break;
            case'tell':
            case '0':
            case '1':
            case FALSE:
                $chatcmd = "tell ".$this -> bot -> botname." <pre>";
                Break;
            Default:
                $chatcmd = $origin." ";
        }
        Return ('<a href=\'chatcmd:///'.$chatcmd.$link . '\'>' . $title . '</a>');
    }

    function get_site($url, $strip_headers = 0, $server_timeout = 25, $read_timeout = 30)
    {
        if(strtolower($this -> bot -> core("settings") -> get("tools", "get_site")) == "curl")
        {
            if(!function_exists('curl_init'))
            {
                $this -> bot -> core("settings") -> save($module, $setting, "Sockets");
                $this -> bot -> send_tell($this -> bot -> core("security") -> owner, "Setting get_site for Module tools Changed to Sockets as cURL is not installed");
                Return $this -> get_site_sock($url, $strip_headers, $server_timeout, $read_timeout);
            }
            else
                Return $this -> get_site_curl($url, $strip_headers);
        }
        else
        {
            Return $this -> get_site_sock($url, $strip_headers, $server_timeout, $read_timeout);
        }
    }

    function get_site_sock($url, $strip_headers = 0, $server_timeout = 5, $read_timeout = 10)
    {
        $return = $this -> get_site_data($url,$strip_headers,$server_timeout,$read_timeout);

/*        if (!isset($return["error"]) && $this -> use_proxy_server && !empty($this -> proxy_server_address))
        {
            echo "We're using a proxy\n";
            foreach ($this -> proxy_server_address as $proxy)
            {
                echo "Trying proxy: ".$proxy."\n";
                $return = $this -> get_site_data($url,$strip_headers,$server_timeout,$read_timeout,$proxy);

                if (!isset($return["error"]))
                    break;
            }
        }
*/

        return $return;
    }

    /*
    Gets the data from a URL
    */
    function get_site_data($url, $strip_headers = 0, $server_timeout = 5, $read_timeout = 10, $proxy = '')
    {
        $get_url = parse_url($url);

        // Check to see if we're using a proxy, and get the IP address for the target host.
        if (!empty($proxy))
        {
            $proxy_address = explode(":", $proxy);
            $address = gethostbyname($proxy_address[0]);
            $service_port = $proxy_address[1];
        }
        else
        {
            $address = gethostbyname($get_url['host']);

            /* Get the port for the WWW service. */
            $service_port = getservbyname('www', 'tcp');

        }

        /* Create a TCP/IP socket. */
        $socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);

        // Check to see if the socket failed to create.
        if ($socket === false) {
            $return["error"] = true;
            $return["errordesc"] = "Socket failed to create.";
            $return["content"] = socket_strerror(socket_last_error());

            return $return;
        }
        
        // Set our socket to non-blocking mode for connection creation
        socket_set_nonblock($socket);

        $connection_result = NULL;
        // This is effectively 5s timeout
        for ($i=0; $i<10; $i++)
        {
            // Try connecting
            $connect_result = socket_connect($socket, $address, $service_port);
            
            // Succesful connect
            if ($connect_result === true)
            {
                break;
            }
            
            // Check the error we got
            $error = socket_last_error();
            socket_clear_error();
            if (($error != SOCKET_EINPROGRESS) &&
                ($error != SOCKET_EALREADY))
            {
                return array(
                    'error'        => true,
                    'errordesc'    => 'Failed to connect to server',
                    'content'    => socket_strerror($error)
                );
            }
            
            // Sleep
            usleep(500000);
        }

        // Make sure we have a connection
        if ($connect_result === false)
        {
            $return["error"] = true;
            $return["errordesc"] = "Failed to connect to server";
            $return["content"] = socket_strerror(socket_last_error());
            
            return $return;
        }

        // Set socket back to blocking mode to get data
        socket_set_block($socket);

        $bot_version = $this -> bot -> botversion;

        // Rebuild the full query after parse_url
        $url = $get_url["path"];
        if (!empty($get_url["query"]))
        {
            $url .= '?' . $get_url["query"];
        }

        $in = "GET $url HTTP/1.0\r\n";
        $in .= "Host: " . $get_url['host'] . "\r\n";
        $in .= "Connection: Close\r\n";
        $in .= "User-Agent:" . $this->useragent . "\r\n\r\n";

        $write_result = socket_write($socket, $in, strlen($in));

        // Make sure we wrote to the server okay.
        if ($write_result === false)
        {
            $return["error"] = true;
            $return["errordesc"] = "Failed to write to server";
            $return["content"] = socket_strerror(socket_last_error());
            
            return $return;
        }

        $return["content"] = "";
        $read_result = socket_read($socket, 2048);
        while ($read_result != "" && $read_result !== false)
        {
            $return["content"] .= $read_result;
            $read_result = socket_read($socket, 2048);
        }

        // Make sure we got a response back from the server.
        if ($read_result === false)
        {
            $return["error"] = true;
            $return["errordesc"] = "Failed to read response";
            $return["content"] = socket_strerror(socket_last_error());
            
            return $return;
        }

        $close_result = socket_close($socket);

        // Make sure we closed our socket properly.  Open sockets are bad!
        if ($close_result === false)
        {
            $return["error"] = true;
            $return["errordesc"] = "Failed to close socket";
            $return["content"] = socket_strerror(socket_last_error());
    
            return $return;
        }

        // Did the calling function want http headers stripped?
        if ($strip_headers)
        {
            $split = split("\r\n\r\n",$return['content']);
            $return["content"] = $split[1];
        }

        return $return;

    }

    function get_site_curl($url, $strip_headers, $timeout = 10)
    {
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_USERAGENT, $this->useragent);
        // Set your login and password for authentication
        //curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
        //curl_setopt($ch, CURLOPT_USERPWD, $user.':'.$pw);

        // You can use CURLAUTH_BASIC, CURLAUTH_DIGEST, CURLAUTH_GSSNEGOTIATE,
        // CURLAUTH_NTLM, CURLAUTH_ANY, and CURLAUTH_ANYSAFE
        //
        // You can use the bitwise | (or) operator to combine more than one method.
        // If you do this, CURL will poll the server to see what methods it supports and pick the best one.
        //
        // CURLAUTH_ANY is an alias for CURLAUTH_BASIC | CURLAUTH_DIGEST |
        // CURLAUTH_GSSNEGOTIATE | CURLAUTH_NTLM
        //
        // CURLAUTH_ANYSAFE is an alias for CURLAUTH_DIGEST | CURLAUTH_GSSNEGOTIATE |
        // CURLAUTH_NTLM
        //
        // Personally I prefer CURLAUTH_ANY as it covers all bases

        // This is occassionally required to stop CURL from verifying the peer's certificate.
        // CURLOPT_SSL_VERIFYHOST may also need to be TRUE or FALSE if
        // CURLOPT_SSL_VERIFYPEER is disabled (it defaults to 2 - check the existence of a
        // common name and also verify that it matches the hostname provided)
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);

        // Optional: Return the result instead of printing it
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
        
        // Specify a timeout
        curl_setopt ( $ch , CURLOPT_TIMEOUT, $timeout);

        // The usual - get the data and close the session
        $return["content"] = curl_exec($ch);
        curl_close($ch);

        // Did the calling function want http headers stripped?
        //if ($strip_headers)// already stripped?
        //{
        //    $split = split("\r\n\r\n",$return["content"]);
        //    $return["content"] = $split[1];
        //}
        
    
        Return $return;
    }

    /*
    Parse XML crap
    */
    function xmlparse($xml, $tag)
    {
        $tmp = explode("<" . $tag . ">", $xml);
        $tmp = explode("</" . $tag . ">", $tmp[1]);
        return $tmp[0];
    }

    function make_blob($title, $content)
    {
        // Using " inside a blob will end the blob.
        // Convert opening and closing tags with " to '
        // Convert any other " to HTML entities.
        $content = str_replace("=\"", "='", $content);
        $content = str_replace("\">", "'>", $content);
        $content = str_replace("\"", "&quot;", $content);        

        return "<a href=\"text://" . $content . "\">" . $title . "</a>";
    }

    /*
    Creates a text blob.
    */
    function make_item($lowid, $highid, $ql, $name, $alt = FALSE)
    {
        $quote = '"';
        if ($alt)
        {
            $quote = '\'';
        }
        $name = str_replace("'", "&#039;", $name);
        return "<a href=".$quote."itemref://$lowid/$highid/$ql".$quote.">$name</a>";
    }

    /*
    Takes an item string and returns an array with lowid, highid, ql and name.
    If $item is unparsable it returns a BotError
    */
    function parse_item($item)
    {
        $pattern='|<a href="itemref://([0-9]+)/([0-9]+)/([0-9]{1,3})">([^<]+)</a>|';
        preg_match($pattern, $item, $parts);
        if(empty($parts))
        {
            $this->error->set("Unable to parse item: '$item'");
            return($this->error);
        }
        $parsed['lowid'] = $parts[1];
        $parsed['highid'] = $parts[2];
        $parsed['ql']=$parts[3];
        $parsed['name']=$parts[4];
        return($parsed);
    }
    
    //Returns true if $item is an itemref, false otherwise.
    function is_item($item)
    {
        $pattern='|<a href="itemref://([0-9]+)/([0-9]+)/([0-9]{1,3})">([^<]+)</a>|';
        preg_match($pattern, $item, $parts);
        if(empty($parts))
        {
            return false;
        }
        return true;
    }

    /*
    Used to convert an overflowed (unsigned) integer to a string with the correct positive unsigned integer value
    If the passed integer is not negative, the integer is merely passed back in string form with no modifications.
    */
    function int_to_string($int)
    {
        if ($int <= -1)
        {
            $int += (float)"4294967296";
        }
        return (string)$int;
    }

    /*
    Used to convert an unsigned interger in string form to an overflowed (negative) integere
    If the passed string is not an integer large enough to overflow, the string is merely passed back in integer form with no modifications.
    */
    function string_to_int($string)
    {
        $int = (float)$string;
        if ($int > (float)2147483647)
        {
            $int -= (float)"4294967296";
        }
        return (int)$int;
    }
    
    /*
    Checks if a player name is valid and if the player exists.
    Returns BotError on failure
    Returns ucfirst(strtolower($name)) if the player exists.
    */
    function validate_player($name, $check_exists=true)
    {
        $name=trim(ucfirst(strtolower($name)));
        if(strlen($name)<3 || strlen($name)>14)
        {
            $this->error->set("Player name has to be between 4 and 13 characters long (inclusive)");
            return($this->error);
        }
        if(preg_match("|([a-z]+[0-9]*[^a-z]*)|", $name)==0)
        {
            $this->error->set("Player name has to be alphabetical followed by 0 or more digits not followed by alphabetical characters.");
            return($this->error);
        }
        if($check_exists)
        {
            if(!$this->bot->core('chat')->get_uid($name))
            {
                $this->error->set("Player '$name' does not exist.");
                return($this->error);
            }
        }
        return($name);
    }

    function settings($user, $module, $setting, $new, $old)
    {
        if($new == "curl" && !function_exists('curl_init'))
        {
            $this -> bot -> core("settings") -> save($module, $setting, "Sockets");
            if ($user != "")
            {
                $this -> bot -> send_tell($user, "Setting get_site for Module tools Changed to Sockets as cURL is not installed");
            }
        }
    }
    
    function my_rand ($min = FALSE, $max = FALSE)
    {
        // For now we only support Mersienne Twister, but this can be changed.
         $this->randomsource = "Mersenne Twister";
        if (isset($min))
        {
            return mt_rand($min, $max);
        }
        else
        {
            return mt_rand();
        }

    }
}
?>