bouncer_r/php/lib csv.php,1.2,1.3

[David Farning (dfarning)]

Author: dfarning

Update of /cvs/fedora/bouncer_r/php/lib
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv21147/php/lib

Added Files:
	csv.php 
Log Message:
cvs cleanup for fedora initial commit


Index: csv.php
===================================================================
RCS file: csv.php
diff -N csv.php
--- /dev/null	1 Jan 1970 00:00:00 -0000
+++ csv.php	2 Aug 2005 00:06:09 -0000	1.3
@@ -0,0 +1,177 @@
+<?php
+/**
+ *	Functions that take a db result and export it to CSV.
+ *	Usage example:
+ *	<code>
+ *	if ($_GET['csv'])
+ *	{
+ *		$res=db_query("SELECT * FROM fic_courses");
+ *		send_csv($res);
+ *		exit;
+ *	}
+ *	</code>
+ *	@package mirror 
+ *	@subpackage lib 
+ *  @author Central Web Services, Oregon State University
+ *  @copyright Oregon State University
+ */
+
+/**
+ *	@param resource $res MySQL resource / result
+ *	@return array $ret_val array of CSV rows, parsed properly (false if $res is not resource)
+ */
+function export_to_csv($res)
+{
+	// parse all results, format for CSV
+	while ( $buf=db_fetch($res,MYSQL_ASSOC) )
+	{
+		// get the keys (headers), if not already done
+		if ( empty($heads) )
+		{
+			$heads=array_keys($buf);
+			foreach ($heads as $key=>$val)
+			{
+				$heads[$key]=add_quotes(fix_quotes($val));
+			}
+			$heads=implode(',',$heads);
+			$csv[]=$heads."\n";
+		}
+		// fix inner quotes, add outer quotes for all values
+		$row=array_to_csv($buf);
+		$csv[]=$row."\n";
+	}
+	return $csv;
+}
+
+/**
+ *	Use a resource or two dimensional array, then send the CSV results to user.
+ *	@param mixed $res MySQL resource / result, or a two dimensional array
+ *	@param string $name name of the export file
+ *	@return bool true if file sent, false otherwise
+ */
+function send_csv($res,$name=null)
+{
+	// set name of the export file
+	$filename=(is_null($name))?'export-'.date('Y-m-d').'.csv':$name.'.csv';
+	// check for valid resource
+	if ( is_resource($res) )
+	{
+		$csv=export_to_csv($res);
+	}
+	elseif( is_array($res) && !empty($res) )
+	{
+		foreach ($res as $row)
+		{
+			if ( !is_array($row) )
+				;
+			else
+				$csv[] = array_to_csv($row)."\n";
+		}
+	}
+	
+	if ( is_array($csv) )
+	{
+		// stream csv to user
+		header("Content-type: application/x-csv");
+		header('Content-disposition: inline; filename="'.$filename.'"');
+		header('Cache-Control: private');
+		header('Pragma: public'); 	
+		foreach ($csv as $row)
+		{
+			echo $row;
+		}
+		return true;
+	}
+
+	return false;
+}
+
+/**
+ *	Replace quotes inside of a field with double quotes, which is something CSV requires.
+ *	@param string $string unquoted quotes
+ *	@return string $string quoted quotes
+ */
+function fix_quotes($string)
+{
+	return preg_replace('/"/','""',$string);
+}
+
+/**
+ * 	Replaces instances of double quotes in a string with a single quote.
+ * 	@param string $string the string to perform the replacement on
+ * 	@return string the string with "" replaced by "
+ */
+function unfix_quotes($string)
+{
+	return preg_replace('/""/', '"', $string);
+}
+
+/**
+ *	Place quotes outside of every field, which inherently solves space, line break issues.
+ *	@param string $string 
+ *	@return string $string with quotes around it
+ */
+function add_quotes($string)
+{
+	return '"'.$string.'"';
+}
+
+/**
+ *  Removes quotes from the beginning and the end of a string.
+ *  @param string $string the string to remove the quotes from
+ *  @return string the string, sans quotes at the beginning and end
+ */
+function remove_quotes($string)
+{
+	$pattern = "/^\"(.*)\"$/";
+	$replacement = "$1";
+	return preg_replace($pattern, $replacement, $string);
+}
+
+/**
+ *	Convert an array into a CSV string with quotes around each value.
+ *	@param array $array
+ *	@return string the values in $array surrounded by quotes and separated by commas
+ */
+function array_to_csv($array)
+{
+	$csv_arr = array();
+	foreach ($array as $value)
+	{
+		$csv_arr[]=add_quotes(fix_quotes($value));
+	}
+	$csv_string=implode(',',$csv_arr);
+
+	return $csv_string;
+}
+
+/**
+ *	Convert a CSV string into an array.
+ *	Please use sparingly - this creates temp files
+ *	@param string $string the CSV string
+ *	@return array the elements from the CSV string in an array
+ */
+function csv_to_array($string)
+{
+	$return = array();
+	$length = strlen($string);
+	
+	// create a temp file and write the string to it
+	$tmpfname = tempnam('/tmp', 'csvlib');
+	$fh = fopen($tmpfname, 'w');
+	fwrite($fh, $string);
+	fclose($fh);
+
+	// open the file for csv parsing
+	$csvh = fopen($tmpfname, 'r');
+	while (($arraydata = fgetcsv($csvh, $length, ',')) !== false)
+	{
+		$return = array_merge($return, $arraydata);
+	}
+
+	fclose($csvh);
+	unlink($tmpfname);
+
+	return $return;
+}
+?>