egroupware/phpgwapi/inc/class.db_mssql.inc.php

<?php
  /**************************************************************************\
  * phpGroupWare API - MS SQL Server support                                 *
  * (C) Copyright 1998 Cameron Taggart (cameront@wolfenet.com)               *
  *  Modified by Guarneri carmelo (carmelo@melting-soft.com)                 *
  *	 Modified by Cameron Just     (C.Just@its.uq.edu.au)                     *
  * ------------------------------------------------------------------------ *
  * This is not part of phpGroupWare, but is used by phpGroupWare.           * 
  * http://www.phpgroupware.org/                                             * 
  * ------------------------------------------------------------------------ *
  * This program 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; either version 2.1 of the License, or   *
  * any later version.                                                       *
  \**************************************************************************/

  /* $Id$ */

# echo "<BR>This is using the MSSQL class<BR>";

class db {
	var $Host         = '';
	var $Database     = '';
	var $User         = '';
	var $Password     = '';

	var $Link_ID      = 0;
	var $Query_ID     = 0;
	var $Record       = array();
	var $Row          = 0;
	var $VEOF         = -1;

	var $Errno        = 0;
	var $Error        = '';
	var $use_pconnect = True;
	var $Auto_Free    = 0;     ## set this to 1 to automatically free results


	function connect()
	{
		if ( 0 == $this->Link_ID )
		{
			if ($this->use_pconnect)
				$this->Link_ID=mssql_pconnect($this->Host, $this->User, $this->Password);
			else
				$this->Link_ID=mssql_connect($this->Host, $this->User, $this->Password);
			if (!$this->Link_ID)
				$this->halt("Link-ID == false, mssql_pconnect failed");
			else
				mssql_select_db($this->Database, $this->Link_ID);
		}
	}

	function free_result()
	{
		mssql_free_result($this->Query_ID);
		$this->Query_ID = 0;
		$this->VEOF = -1;		
	}

	function query($Query_String, $line = '', $file = '')
	{
		$this->VEOF = -1;

		if (!$this->Link_ID)
			$this->connect();

		$this->Query_ID = mssql_query($Query_String, $this->Link_ID);
		$this->Row = 0;
		if (!$this->Query_ID) {
			$this->halt("Invalid SQL: " . $Query_String, $line, $file);
		}
		return $this->Query_ID;
	}

	function limit_query($Query_String, $_offset, $line = '', $file = '')
	{
		global $phpgw_info;

		if ($this->Debug)
		{
			printf("Debug: limit_query = %s<br>offset=%d, num_rows=%d<br>\n", $Query_String, $offset, $num_rows);
		}

		if (is_array($_offset))
		{
			list($offset,$num_rows) = $_offset;
		}
		else
		{
			$num_rows = $phpgw_info['user']['preferences']['common']['maxmatchs'];
			$offset = $_offset;
		}

		$this->query($Query_String, $line, $file);
		if ($this->Query_ID)
		{
			$this->Row = $offset;
			// Push cursor to appropriate row in case next_record() is used
			if ($offset > 0)
				@mssql_data_seek($this->Query_ID, $offset);

			$this->VEOF = $offset + $num_rows - 1;
		}

		return $this->Query_ID;
	}

	function next_record()
	{
		if (!$this->Query_ID)
		{
			$this->halt("next_record called with no query pending.");
			return 0;
		}

		if ($this->VEOF == -1 || ($this->Row++ <= $this->VEOF))
		{
			// Work around for buggy mssql_fetch_array
			$rec = @mssql_fetch_row($this->Query_ID);
			if ($rec)
			{
				$this->Record = array();
				for (var $i = 0; $i < count($rec); $i++)
				{
					$this->Record[$i] = $rec[$i];
					$o = mssql_fetch_field($i, $this->Query_ID);
					$this->Record[$o->name] = $rec[$i];
				}
			}
			else
				$this->Record = NULL;
		}
		else
			$this->Record = NULL;

		$stat = is_array($this->Record);
		if (!$stat && $this->Auto_Free)
			$this->free();

		return $stat;
	}

	function transaction_begin()
	{
		return $this->query('BEGIN TRAN');
	}

	function transaction_commit()
	{
		if (!$this->Errno)
			return $this->query('COMMIT TRAN');

		return False;
	}

	function transaction_abort()
	{
		return $this->query('ROLLBACK TRAN');
	}

	function seek($pos) {
		mssql_data_seek($this->Query_ID,$pos);
		$this->Row = $pos;
	}

	function metadata($table) {
		$count = 0;
		$id    = 0;
		$res   = array();

		$this->connect();
		$id = mssql_query("select * from $table", $this->Link_ID);
		if (!$id)
			$this->halt("Metadata query failed.");

		$count = mssql_num_fields($id);

		for ($i=0; $i<$count; $i++) {
			$info = mssql_fetch_field($id, $i);
			$res[$i]["table"] = $table;
			$res[$i]["name"]  = $info["name"];
			$res[$i]["len"]   = $info["max_length"];
			$res[$i]["flags"] = $info["numeric"];
		}
		$this->free_result();
		return $res;
	}

	function affected_rows() {
		return mssql_affected_rows($this->Query_ID);
	}

	function num_rows() {
		return mssql_num_rows($this->Query_ID);
	}

	function num_fields() {
		return mssql_num_fields($this->Query_ID);
	}

	function nf() {
		return $this->num_rows();
	}

	function np() {
		print $this->num_rows();
	}

	function f($Field_Name) {
		return $this->Record[strtolower($Field_Name)];
	}

	function p($Field_Name) {
		print $this->f($Field_Name);
	}

	/* public: table locking */
	function lock($table, $mode="write")
	{
		return 1; // FIXME: fill it in!
	}

	function unlock()
	{
		return 1; // FIXME: fill it in!
	}

	/* private: error handling */
	function halt($msg, $line = '', $file = '')
	{
		global $phpgw;
		$this->unlock();

		$this->Errno = 1;
		$this->Error = mssql_get_last_message();
		if ($this->Error == '')
			$this->Error = "General Error (The MS-SQL interface did not return a detailed error message).";

		if ($this->Halt_On_Error == "no")
			return;

		$this->haltmsg($msg);

		if ($file)
			printf("<br><b>File:</b> %s",$file);

		if ($line)
			printf("<br><b>Line:</b> %s",$line);

		if ($this->Halt_On_Error != "report")
		{
			echo "<p><b>Session halted.</b>";
			$phpgw->common->phpgw_exit(True);
		}
	}

	function haltmsg($msg)
	{
		printf("<b>Database error:</b> %s<br>\n", $msg);
		if ($this->Errno != "0" && $this->Error != "()") {
			printf("<b>MS-SQL Error</b>: %s (%s)<br>\n", $this->Errno, $this->Error);
		}
	}

	function table_names()
	{
		$this->query("select name from sysobjects where type='u' and name != 'dtproperties'");
		$i = 0;
		while ($info = @mssql_fetch_row($this->Query_ID))
		{
			$return[$i]['table_name'] = $info[0];
			$return[$i]['tablespace_name'] = $this->Database;
			$return[$i]['database'] = $this->Database;
			$i++;
		}
		return $return;
	}	
}
?>