<?php
    require_once(__INCLUDE_CLASS_PATH."/class.SingeltonStorage.php");

    // ==================================================================
    //  Author: Justin Vincent (justin@visunet.ie)
    //	Web: 	http://php.justinvincent.com
    //	Name: 	ezSQL
    // 	Desc: 	Class to make it very easy to deal with mySQL database connections.
    //
    // !! IMPORTANT !!
    //
    //  Please send me a mail telling me what you think of ezSQL
    //  and what your using it for!! Cheers. [ justin@visunet.ie ]
    //
    // ==================================================================
    // User Settings -- CHANGE HERE

    define( 'EZSQL_DB_USER', '' );			// <-- mysql db user
    define( 'EZSQL_DB_PASSWORD', '' );		// <-- mysql db password
    define( 'EZSQL_DB_NAME', 'mysql' );		// <-- mysql db pname
    define( 'EZSQL_DB_HOST', 'localhost' );	// <-- mysql server host

    // ==================================================================
    //	ezSQL Constants
    define( 'EZSQL_VERSION' , '1.26' );
    define( 'OBJECT','OBJECT' , true );
    define( 'ARRAY_A','ARRAY_A' , true );
    define( 'ARRAY_N','ARRAY_N' , true );

    // ==================================================================
    //	The Main Class

    class db {

        public $trace = false;      // same as $debug_all
        public $debug_all = false;  // same as $trace
        public $show_errors = false;
        public $num_queries = 0;
        public $last_query;
        public $col_info;
        public $debug_called;
        public $vardump_called;

        /**
         * Return static link for this class
         *
         * @return static link
         * @access public
         */

        static function  & getInstance(){
            $db = & SingeltonStorage::get("instance", "DB", null);
            if ($db === null){
                $db = new db;
            }
            return $db;
        }
        /**
         * Connect to db
         *
         * @param string $dbuser
         * @param string $dbpassword
         * @param string $dbname
         * @param string $dbhost
         * @return nothing
         * @access public
         */

        function Connect($dbuser, $dbpassword, $dbname, $dbhost){
                $this->dbh = @mysql_connect($dbhost,$dbuser,$dbpassword);
                if ( ! $this->dbh )
                {
                    $this->print_error("<ol><b>Error establishing a database connection!</b><li>Are you sure you have the correct user/password?<li>Are you sure that you have typed the correct hostname?<li>Are you sure that the database server is running?</ol>");
                }
                $this->select($dbname);
        }

        // ==================================================================
        //	Select a DB (if another one needs to be selected)


        function select($db)
        {
            if ( !@mysql_select_db($db,$this->dbh))
            {
                $this->print_error("<ol><b>Error selecting database <u>$db</u>!</b><li>Are you sure it exists?<li>Are you sure there is a valid database connection?</ol>");
            }
        }

        // ====================================================================
        //	Format a string correctly for safe insert under all PHP conditions

        function escape($str)
        {
            return mysql_escape_string(stripslashes($str));
        }

        // ==================================================================
        //	Print SQL/DB error.

        function print_error($str = "")
        {

            // All erros go to the global error array $EZSQL_ERROR..
            global $EZSQL_ERROR;

            // If no special error string then use mysql default..
            if ( !$str )
            {
                $str = mysql_error($this->dbh);
                $error_no = mysql_errno($this->dbh);
            }

            // Log this error to the global array..
            $EZSQL_ERROR[] = array
                            (
                                "query"      => $this->last_query,
                                "error_str"  => $str,
                                "error_no"   => $error_no
                            );

            // Is error output turned on or not..
            if ( $this->show_errors )
            {
                // If there is an error then take note of it
                print "<blockquote><font face=arial size=2 color=ff0000>";
                print "<b>SQL/DB Error --</b> ";
                print "[<font color=000077>$str</font>]";
                print "</font></blockquote>";
            }
            else
            {
                $error = "<font face=arial size=2 color=ff0000><b>SQL/DB Error --</b><br>[<font color=000077>$str</font>]<br>$this->last_query</font>";
                trigger_error($error, E_USER_ERROR);
                return false;
            }
        }

        // ==================================================================
        //	Turn error handling on or off..

        function show_errors()
        {
            $this->show_errors = true;
        }

        function hide_errors()
        {
            $this->show_errors = false;
        }

        // ==================================================================
        //	Kill cached query results

        function flush()
        {

            // Get rid of these
            $this->last_result = null;
            $this->col_info = null;
            $this->last_query = null;

        }

        // ==================================================================
        //	Basic Query	- see docs for more detail

        function query($query)
        {

            // For reg expressions
            $query = trim($query);

            // initialise return
            $return_val = 0;

            // Flush cached values..
            $this->flush();

            // Log how the function was called
            $this->func_call = "\$db->query(\"$query\")";

            // Keep track of the last query for debug..
            $this->last_query = $query;

            // Perform the query via std mysql_query function..
            $this->result = mysql_query($query,$this->dbh) ;
            $this->num_queries++;
            // If there is an error then take note of it..
            if ( mysql_error($this->dbh) )
            {
                $this->print_error(mysql_error($this->dbh));
                return false;
            }

            // Query was an insert, delete, update, replace
            if ( preg_match("/^(insert|delete|update|replace)\s+/i",$query) )
            {
                $this->rows_affected = mysql_affected_rows($this->dbh);

                // Take note of the insert_id
                if ( preg_match("/^(insert|replace)\s+/i",$query) )
                {
                    $this->insert_id = mysql_insert_id($this->dbh);
                }

                // Return number fo rows affected
                $return_val = $this->rows_affected;
            }
            // Query was an select
            else
            {
                $this->last_result = array();
                // Take note of column info
                $i=0;
                while ($i < @mysql_num_fields($this->result))
                {
                    $this->col_info[$i] = @mysql_fetch_field($this->result);
                    $i++;
                }

                // Store Query Results
                $num_rows=0;
                while ( $row = @mysql_fetch_object($this->result) )
                {
                    // Store relults as an objects within main array
                    $this->last_result[$num_rows] = $row;
                    $num_rows++;
                }

                @mysql_free_result($this->result);

                // Log number of rows the query returned
                $this->num_rows = $num_rows;

                // Return number of rows selected
                $return_val = $this->num_rows;
            }

            // If debug ALL queries
            $this->trace || $this->debug_all ? $this->debug() : null ;

            return $return_val;

        }

        // ==================================================================
        //	Get one variable from the DB - see docs for more detail

        function get_var($query=null,$x=0,$y=0)
        {

            // Log how the function was called
            $this->func_call = "\$db->get_var(\"$query\",$x,$y)";

            // If there is a query then perform it if not then use cached results..
            if ($query)
            {
                $this->query($query);
            }

            // Extract var out of cached results based x,y vals
            if ( $this->last_result[$y] )
            {
                $values = array_values(get_object_vars($this->last_result[$y]));
            }

            // If there is a value return it else return null
            return (isset($values[$x]) && $values[$x]!=='')?$values[$x]:null;
        }

        // ==================================================================
        //	Get one row from the DB - see docs for more detail

        function get_row($query=null,$output=OBJECT,$y=0)
        {

            // Log how the function was called
            $this->func_call = "\$db->get_row(\"$query\",$output,$y)";

            // If there is a query then perform it if not then use cached results..
            if ( $query )
            {
                $this->query($query);
            }

            // If the output is an object then return object using the row offset..
            if ( $output == OBJECT )
            {
                return $this->last_result[$y]?$this->last_result[$y]:null;
            }
            // If the output is an associative array then return row as such..
            elseif ( $output == ARRAY_A )
            {
                return $this->last_result[$y]?get_object_vars($this->last_result[$y]):null;
            }
            // If the output is an numerical array then return row as such..
            elseif ( $output == ARRAY_N )
            {
                return $this->last_result[$y]?array_values(get_object_vars($this->last_result[$y])):null;
            }
            // If invalid output type was specified..
            else
            {
                $this->print_error(" \$db->get_row(string query, output type, int offset) -- Output type must be one of: OBJECT, ARRAY_A, ARRAY_N");
            }

        }

        // ==================================================================
        //	Function to get 1 column from the cached result set based in X index
        // se docs for usage and info

        function get_col($query=null,$x=0)
        {

            // If there is a query then perform it if not then use cached results..
            if ( $query )
            {
                $this->query($query);
            }

            // Extract the column values
            for ( $i=0; $i < count($this->last_result); $i++ )
            {
                $new_array[$i] = $this->get_var(null,$x,$i);
            }

            return $new_array;
        }

        // ==================================================================
        // Return the the query as a result set - see docs for more details

        function get_results($query=null, $output = OBJECT)
        {

            // Log how the function was called
            $this->func_call = "\$db->get_results(\"$query\", $output)";

            // If there is a query then perform it if not then use cached results..
            if ( $query )
            {
                $this->query($query);
            }

            // Send back array of objects. Each row is an object
            if ( $output == OBJECT )
            {
                return $this->last_result;
            }
            elseif ( $output == ARRAY_A || $output == ARRAY_N )
            {
                if ( $this->last_result )
                {
                    $i=0;
                    foreach( $this->last_result as $row )
                    {

                        $new_array[$i] = get_object_vars($row);

                        if ( $output == ARRAY_N )
                        {
                            $new_array[$i] = array_values($new_array[$i]);
                        }

                        $i++;
                    }

                    return $new_array;
                }
                else
                {
                    return array();
                }
            }
        }


        // ==================================================================
        // Function to get column meta data info pertaining to the last query
        // see docs for more info and usage

        function get_col_info($info_type="name",$col_offset=-1)
        {

            if ( $this->col_info )
            {
                if ( $col_offset == -1 )
                {
                    $i=0;
                    foreach($this->col_info as $col )
                    {
                        $new_array[$i] = $col->{$info_type};
                        $i++;
                    }
                    return $new_array;
                }
                else
                {
                    return $this->col_info[$col_offset]->{$info_type};
                }

            }

        }


        // ==================================================================
        // Dumps the contents of any input variable to screen in a nicely
        // formatted and easy to understand way - any type: Object, Var or Array

        function vardump($mixed='')
        {

            echo "<p><table><tr><td bgcolor=ffffff><blockquote><font color=000090>";
            echo "<pre><font face=arial>";

            if ( ! $this->vardump_called )
            {
                echo "<font color=800080><b>ezSQL</b> (v".EZSQL_VERSION.") <b>Variable Dump..</b></font>\n\n";
            }

            $var_type = gettype ($mixed);
            print_r(($mixed?$mixed:"<font color=red>No Value / False</font>"));
            echo "\n\n<b>Type:</b> " . ucfirst($var_type) . "\n";
            echo "<b>Last Query</b> [$this->num_queries]<b>:</b> ".($this->last_query?$this->last_query:"NULL")."\n";
            echo "<b>Last Function Call:</b> " . ($this->func_call?$this->func_call:"None")."\n";
            echo "<b>Last Rows Returned:</b> ".count($this->last_result)."\n";
            echo "</font></pre></font></blockquote></td></tr></table>".$this->donation();
            echo "\n<hr size=1 noshade color=dddddd>";

            $this->vardump_called = true;

        }

        // Alias for the above function
        function dumpvar($mixed)
        {
            $this->vardump($mixed);
        }

        // ==================================================================
        // Displays the last query string that was sent to the database & a
        // table listing results (if there were any).
        // (abstracted into a seperate file to save server overhead).

        function debug()
        {

            echo "<blockquote>";

            // Only show ezSQL credits once..
            if ( ! $this->debug_called )
            {
                echo "<font color=800080 face=arial size=2><b>ezSQL</b> (v".EZSQL_VERSION.") <b>Debug..</b></font><p>\n";
            }
            echo "<font face=arial size=2 color=000099><b>Query</b> [$this->num_queries] <b>--</b> ";
            echo "[<font color=000000><b>$this->last_query</b></font>]</font><p>";

                echo "<font face=arial size=2 color=000099><b>Query Result..</b></font>";
                echo "<blockquote>";

            if ( $this->col_info )
            {

                // =====================================================
                // Results top rows

                echo "<table cellpadding=5 cellspacing=1 bgcolor=555555>";
                echo "<tr bgcolor=eeeeee><td nowrap valign=bottom><font color=555599 face=arial size=2><b>(row)</b></font></td>";


                for ( $i=0; $i < count($this->col_info); $i++ )
                {
                    echo "<td nowrap align=left valign=top><font size=1 color=555599 face=arial>{$this->col_info[$i]->type} {$this->col_info[$i]->max_length}</font><br><span style='font-family: arial; font-size: 10pt; font-weight: bold;'>{$this->col_info[$i]->name}</span></td>";
                }

                echo "</tr>";

                // ======================================================
                // print main results

            if ( $this->last_result )
            {

                $i=0;
                foreach ( $this->get_results(null,ARRAY_N) as $one_row )
                {
                    $i++;
                    echo "<tr bgcolor=ffffff><td bgcolor=eeeeee nowrap align=middle><font size=2 color=555599 face=arial>$i</font></td>";

                    foreach ( $one_row as $item )
                    {
                        echo "<td nowrap><font face=arial size=2>$item</font></td>";
                    }

                    echo "</tr>";
                }

            } // if last result
            else
            {
                echo "<tr bgcolor=ffffff><td colspan=".(count($this->col_info)+1)."><font face=arial size=2>No Results</font></td></tr>";
            }

            echo "</table>";

            } // if col_info
            else
            {
                echo "<font face=arial size=2>No Results</font>";
            }

            echo "</blockquote></blockquote>".$this->donation()."<hr noshade color=dddddd size=1>";


            $this->debug_called = true;
        }

        // =======================================================
        // Naughty little function to ask for some remuniration!

        function donation()
        {
            return "<font size=1 face=arial color=000000>If ezSQL has helped <a href=\"https://www.paypal.com/xclick/business=justin%40justinvincent.com&item_name=ezSQL&no_note=1&tax=0\" style=\"color: 0000CC;\">make a donation!?</a> &nbsp;&nbsp;[ go on! you know you want to! ]</font>";
        }

    }
?>
