Formatting

phpgwapi/inc/class.db_mysql.inc.php

@@ -14,21 +14,21 @@
 
   /* $Id$ */
 
-class db {
-  
+	class db
+	{
 		/* public: connection parameters */
-  var $Host     = "";
-  var $Database = "";
-  var $User     = "";
-  var $Password = "";
+		var $Host     = '';
+		var $Database = '';
+		var $User     = '';
+		var $Password = '';
 
 		/* public: configuration parameters */
 		var $use_pconnect      = True;
 		var $auto_stripslashes = False;
 		var $Auto_Free     = 0;     ## Set to 1 for automatic mysql_free_result()
 		var $Debug         = 0;     ## Set to 1 for debugging messages.
-  var $Halt_On_Error = "yes"; ## "yes" (halt with message), "no" (ignore errors quietly), "report" (ignore errror, but spit a warning)
-  var $Seq_Table     = "db_sequence";
+		var $Halt_On_Error = 'yes'; ## "yes" (halt with message), "no" (ignore errors quietly), "report" (ignore errror, but spit a warning)
+		var $Seq_Table     = 'db_sequence';
 
 		/* public: result array and current row number */
 		var $Record   = array();
@@ -36,51 +36,64 @@ class db {
 
 		/* public: current error number and error text */
 		var $Errno    = 0;
-  var $Error    = "";
+		var $Error    = '';
 
 		/* public: this is an api revision, not a CVS revision. */
-  var $type     = "mysql";
-  var $revision = "1.2";
+		var $type     = 'mysql';
+		var $revision = '1.2';
 
 		/* private: link and query handles */
 		var $Link_ID  = 0;
 		var $Query_ID = 0;
 
-
-
 		/* public: constructor */
-  function db($query = "") {
+		function db($query = '')
+		{
 			$this->query($query);
 		}
 
 		/* public: some trivial reporting */
-  function link_id() {
+		function link_id()
+		{
 			return $this->Link_ID;
 		}
 
-  function query_id() {
+		function query_id()
+		{
 			return $this->Query_ID;
 		}
 
 		/* public: connection management */
-  function connect($Database = "", $Host = "", $User = "", $Password = "") {
+		function connect($Database = '', $Host = '', $User = '', $Password = '')
+		{
 			/* Handle defaults */
-    if ("" == $Database)
+			if ('' == $Database)
+			{
 				$Database = $this->Database;
-    if ("" == $Host)
+			}
+			if ('' == $Host)
+			{
 				$Host     = $this->Host;
-    if ("" == $User)
+			}
+			if ('' == $User)
+			{
 				$User     = $this->User;
-    if ("" == $Password)
+			}
+			if ('' == $Password)
+			{
 				$Password = $this->Password;
-
+			}
 			/* establish connection, select database */
 			if ( 0 == $this->Link_ID )
 			{
 				if ($this->use_pconnect)
+				{
 					$this->Link_ID=mysql_pconnect($Host, $User, $Password);
+				}
 				else
+				{
 					$this->Link_ID=mysql_connect($Host, $User, $Password);
+				}
 
 				if (!$this->Link_ID)
 				{
@@ -88,12 +101,12 @@ class db {
 					return 0;
 				}
 
-      if (!@mysql_select_db($Database,$this->Link_ID)) {
+				if (!@mysql_select_db($Database,$this->Link_ID))
+				{
 					$this->halt("cannot use database ".$this->Database);
 					return 0;
 				}
 			}
-    
 			return $this->Link_ID;
 		}
 
@@ -118,48 +131,59 @@ class db {
 
 			echo '<b>Warning: limit() is no longer used, use limit_query()</b>';
 
-     if ($start == 0) {
-        $s = "limit " . $phpgw_info["user"]["preferences"]["common"]["maxmatchs"];
-     } else {
-        $s = "limit $start," . $phpgw_info["user"]["preferences"]["common"]["maxmatchs"];
+			if ($start == 0)
+			{
+				$s = 'limit ' . $phpgw_info['user']['preferences']['common']['maxmatchs'];
+			}
+			else
+			{
+				$s = "limit $start," . $phpgw_info['user']['preferences']['common']['maxmatchs'];
 			}
 			return $s;
 		}
 
 		/* public: discard the query result */
-  function free() {
+		function free()
+		{
 			@mysql_free_result($this->Query_ID);
 			$this->Query_ID = 0;
 		}
 
 		/* public: perform a query */
 		/* I added the line and file section so we can have better error reporting. (jengo) */
-  function query($Query_String, $line = "", $file = "") {
+		function query($Query_String, $line = '', $file = '')
+		{
 			/* No empty queries, please, since PHP4 chokes on them. */
-    if ($Query_String == "")
 			/* The empty query string is passed on from the constructor,
 			* when calling the class without a query, e.g. in situations
 			* like these: '$db = new db_Subclass;'
 			*/
+			if ($Query_String == '')
+			{
 				return 0;
-
-    if (!$this->connect()) {
+			}
+			if (!$this->connect())
+			{
 				return 0; /* we already complained in connect() about that. */
 			};
 
 			# New query, discard previous result.
-    if ($this->Query_ID) {
+			if ($this->Query_ID)
+			{
 				$this->free();
 			}
 
 			if ($this->Debug)
+			{
 				printf("Debug: query = %s<br>\n", $Query_String);
+			}
 
 			$this->Query_ID = @mysql_query($Query_String,$this->Link_ID);
 			$this->Row   = 0;
 			$this->Errno = mysql_errno();
 			$this->Error = mysql_error();
-    if (! $this->Query_ID) {
+			if (! $this->Query_ID)
+			{
 				$this->halt("Invalid SQL: ".$Query_String, $line, $file);
 			}
 
@@ -195,9 +219,11 @@ class db {
 		}
 
 		/* public: walk result set */
-  function next_record() {
-    if (!$this->Query_ID) {
-      $this->halt("next_record called with no query pending.");
+		function next_record()
+		{
+			if (!$this->Query_ID)
+			{
+				$this->halt('next_record called with no query pending.');
 				return 0;
 			}
 
@@ -207,20 +233,24 @@ class db {
 			$this->Error  = mysql_error();
 
 			$stat = is_array($this->Record);
-    if (!$stat && $this->Auto_Free) {
+			if (!$stat && $this->Auto_Free)
+			{
 				$this->free();
 			}
 			return $stat;
 		}
 
 		/* public: position in result set */
-  function seek($pos = 0) {
+		function seek($pos = 0)
+		{
 			$status = @mysql_data_seek($this->Query_ID, $pos);
 			if ($status)
+			{
 				$this->Row = $pos;
-    else {
+			}
+			else
+			{
 				$this->halt("seek($pos) failed: result has ".$this->num_rows()." rows");
-
 				/* half assed attempt to save the day, 
 				* but do not consider this documented or even
 				* desireable behaviour.
@@ -229,7 +259,6 @@ class db {
 				$this->Row = $this->num_rows;
 				return 0;
 			}
-
 			return 1;
 		}
 
@@ -248,37 +277,47 @@ class db {
 			return True;
 		}
 
-
 		/* public: table locking */
-  function lock($table, $mode="write") {
+		function lock($table, $mode='write')
+		{
 			$this->connect();
 
 			$query = "lock tables ";
-    if (is_array($table)) {
-      while (list($key,$value)=each($table)) {
-        if ($key=="read" && $key!=0) {
+			if (is_array($table))
+			{
+				while (list($key,$value)=each($table))
+				{
+					if ($key == "read" && $key!=0)
+					{
 						$query .= "$value read, ";
-        } else {
+					}
+					else
+					{
 						$query .= "$value $mode, ";
 					}
 				}
 				$query = substr($query,0,-2);
-    } else {
+			}
+			else
+			{
 				$query .= "$table $mode";
 			}
 			$res = @mysql_query($query, $this->Link_ID);
-    if (!$res) {
+			if (!$res)
+			{
 				$this->halt("lock($table, $mode) failed.");
 				return 0;
 			}
 			return $res;
 		}
 
-  function unlock() {
+		function unlock()
+		{
 			$this->connect();
 
 			$res = @mysql_query("unlock tables");
-    if (!$res) {
+			if (!$res)
+			{
 				$this->halt("unlock() failed.");
 				return 0;
 			}
@@ -287,45 +326,56 @@ class db {
 
 
 		/* public: evaluate the result (size, width) */
-  function affected_rows() {
+		function affected_rows()
+		{
 			return @mysql_affected_rows($this->Link_ID);
 		}
 
-  function num_rows() {
+		function num_rows()
+		{
 			return @mysql_num_rows($this->Query_ID);
 		}
 
-  function num_fields() {
+		function num_fields()
+		{
 			return @mysql_num_fields($this->Query_ID);
 		}
 
 		/* public: shorthand notation */
-  function nf() {
+		function nf()
+		{
 			return $this->num_rows();
 		}
 
-  function np() {
+		function np()
+		{
 			print $this->num_rows();
 		}
 
 		function f($Name, $strip_slashes = "")
 		{
-     if ($strip_slashes || ($this->auto_stripslashes && ! $strip_slashes)) {
+			if ($strip_slashes || ($this->auto_stripslashes && ! $strip_slashes))
+			{
 				return stripslashes($this->Record[$Name]);
-     } else {
+			}
+			else
+			{
 				return $this->Record[$Name];
 			}
 		}
 
-  function p($Name) {
+		function p($Name)
+		{
 			print $this->Record[$Name];
 		}
 
 		/* public: sequence numbers */
-  function nextid($seq_name) {
+		function nextid($seq_name)
+		{
 			$this->connect();
 
-    if ($this->lock($this->Seq_Table)) {
+			if ($this->lock($this->Seq_Table))
+			{
 				/* get sequence number (locked) and increment */
 				$q  = sprintf("select nextid from %s where seq_name = '%s'",
 					$this->Seq_Table,
@@ -334,14 +384,17 @@ class db {
 				$res = @mysql_fetch_array($id);
 
 				/* No current value, make one */
-      if (!is_array($res)) {
+				if (!is_array($res))
+				{
 					$currentid = 0;
 					$q = sprintf("insert into %s values('%s', %s)",
 						$this->Seq_Table,
 						$seq_name,
 						$currentid);
 					$id = @mysql_query($q, $this->Link_ID);
-      } else {
+				}
+				else
+				{
 					$currentid = $res["nextid"];
 				}
 				$nextid = $currentid + 1;
@@ -351,7 +404,9 @@ class db {
 					$seq_name);
 				$id = @mysql_query($q, $this->Link_ID);
 				$this->unlock();
-    } else {
+			}
+			else
+			{
 				$this->halt("cannot lock ".$this->Seq_Table." - has it been created?");
 				return 0;
 			}
@@ -359,7 +414,8 @@ class db {
 		}
 
 		/* public: return table metadata */
-  function metadata($table='',$full=false) {
+		function metadata($table='',$full=false)
+		{
 			$count = 0;
 			$id    = 0;
 			$res   = array();
@@ -392,48 +448,64 @@ class db {
 
 			/* if no $table specified, assume that we are working with a query */
 			/* result */
-    if ($table) {
+			if ($table)
+			{
 				$this->connect();
 				$id = @mysql_list_fields($this->Database, $table);
 				if (!$id)
+				{
 					$this->halt("Metadata query failed.");
-    } else {
+				}
+			}
+			else
+			{
 				$id = $this->Query_ID; 
 				if (!$id)
+				{
 					$this->halt("No query specified.");
 				}
+			}
  
 			$count = @mysql_num_fields($id);
 
 			/* made this IF due to performance (one if is faster than $count if's) */
-    if (!$full) {
-      for ($i=0; $i<$count; $i++) {
-        $res[$i]["table"] = @mysql_field_table ($id, $i);
-        $res[$i]["name"]  = @mysql_field_name  ($id, $i);
-        $res[$i]["type"]  = @mysql_field_type  ($id, $i);
-        $res[$i]["len"]   = @mysql_field_len   ($id, $i);
-        $res[$i]["flags"] = @mysql_field_flags ($id, $i);
+			if (!$full)
+			{
+				for ($i=0; $i<$count; $i++)
+				{
+					$res[$i]['table'] = @mysql_field_table ($id, $i);
+					$res[$i]['name']  = @mysql_field_name  ($id, $i);
+					$res[$i]['type']  = @mysql_field_type  ($id, $i);
+					$res[$i]['len']   = @mysql_field_len   ($id, $i);
+					$res[$i]['flags'] = @mysql_field_flags ($id, $i);
 				}
-    } else { /* full */
+			}
+			else
+			{
+				/* full */
 				$res["num_fields"]= $count;
 
-      for ($i=0; $i<$count; $i++) {
-        $res[$i]["table"] = @mysql_field_table ($id, $i);
-        $res[$i]["name"]  = @mysql_field_name  ($id, $i);
-        $res[$i]["type"]  = @mysql_field_type  ($id, $i);
-        $res[$i]["len"]   = @mysql_field_len   ($id, $i);
-        $res[$i]["flags"] = @mysql_field_flags ($id, $i);
-        $res["meta"][$res[$i]["name"]] = $i;
+				for ($i=0; $i<$count; $i++)
+				{
+					$res[$i]['table'] = @mysql_field_table ($id, $i);
+					$res[$i]['name']  = @mysql_field_name  ($id, $i);
+					$res[$i]['type']  = @mysql_field_type  ($id, $i);
+					$res[$i]['len']   = @mysql_field_len   ($id, $i);
+					$res[$i]['flags'] = @mysql_field_flags ($id, $i);
+					$res['meta'][$res[$i]['name']] = $i;
 				}
 			}
 
 			/* free the result only if we were called on a table */
-    if ($table) @mysql_free_result($id);
+			if ($table)
+			{
+				@mysql_free_result($id);
+			}
 			return $res;
 		}
 
 		/* private: error handling */
-  function halt($msg, $line = "", $file = "")
+		function halt($msg, $line = '', $file = '')
 		{
 			global $phpgw;
 			$this->unlock();	/* Just in case there is a table currently locked */
@@ -441,18 +513,22 @@ class db {
 			$this->Error = @mysql_error($this->Link_ID);
 			$this->Errno = @mysql_errno($this->Link_ID);
 			if ($this->Halt_On_Error == "no")
+			{
 				return;
- 
+			}
 			$this->haltmsg($msg);
 
-     if ($file) {
+			if ($file)
+			{
 				printf("<br><b>File:</b> %s",$file);
 			}
-     if ($line) {
+			if ($line)
+			{
 				printf("<br><b>Line:</b> %s",$line);
 			}
 
-     if ($this->Halt_On_Error != "report") {
+			if ($this->Halt_On_Error != "report")
+			{
 				echo "<p><b>Session halted.</b>";
 				$phpgw->common->phpgw_exit(True);
 			}
@@ -461,30 +537,33 @@ class db {
 		function haltmsg($msg)
 		{
 			printf("<b>Database error:</b> %s<br>\n", $msg);
-     if ($this->Errno != "0" && $this->Error != "()") {
+			if ($this->Errno != "0" && $this->Error != "()")
+			{
 				printf("<b>MySQL Error</b>: %s (%s)<br>\n",$this->Errno,$this->Error);
 			}
 		}
 
-  function table_names() {
+		function table_names()
+		{
 			$this->query("SHOW TABLES");
 			$i=0;
 			while ($info=mysql_fetch_row($this->Query_ID))
 			{
-      $return[$i]["table_name"]= $info[0];
-      $return[$i]["tablespace_name"]=$this->Database;
-      $return[$i]["database"]=$this->Database;
+				$return[$i]['table_name'] = $info[0];
+				$return[$i]['tablespace_name'] = $this->Database;
+				$return[$i]['database'] = $this->Database;
 				$i++;
 			}
 			return $return;
 		}
 
-  function create_database($adminname = "", $adminpasswd = "") {
+		function create_database($adminname = '', $adminpasswd = '')
+		{
 			$currentUser = $this->User;
 			$currentPassword = $this->Password;
 			$currentDatabase = $this->Database;
 
-		if ($adminname != "")
+			if ($adminname != '')
 			{
 				$this->User = $adminname;
 				$this->Password = $adminpasswd;