3 // security - hide paths
4 if (!defined('ADODB_DIR')) die();
6 global $ADODB_INCLUDED_CSV;
7 $ADODB_INCLUDED_CSV = 1;
11 @version v5.20.9 21-Dec-2016
12 @copyright (c) 2000-2013 John Lim (jlim#natsoft.com). All rights reserved.
13 @copyright (c) 2014 Damien Regad, Mark Newnham and the ADOdb community
14 Released under both BSD license and Lesser GPL library license.
15 Whenever there is any discrepancy between the two licenses,
16 the BSD license will take precedence. See License.txt.
17 Set tabs to 4 for best viewing.
19 Latest version is available at http://adodb.sourceforge.net
21 Library for CSV serialization. This is used by the csv/proxy driver and is the
22 CacheExecute() serialization format.
25 Format documented at http://php.weblogs.com/ADODB_CSV
30 * convert a recordset into special format
32 * @param rs the recordset
34 * @return the CSV formated data
36 function _rs2serialize(&$rs,$conn=false,$sql='')
38 $max = ($rs) ?
$rs->FieldCount() : 0;
40 if ($sql) $sql = urlencode($sql);
43 if ($max <= 0 ||
$rs->dataProvider
== 'empty') { // is insert/update/delete
44 if (is_object($conn)) {
45 $sql .= ','.$conn->Affected_Rows();
46 $sql .= ','.$conn->Insert_ID();
50 $text = "====-1,0,$sql\n";
53 $tt = ($rs->timeCreated
) ?
$rs->timeCreated
: time();
55 ## changed format from ====0 to ====1
56 $line = "====1,$tt,$sql\n";
58 if ($rs->databaseType
== 'array') {
63 $rows[] = $rs->fields
;
68 for($i=0; $i < $max; $i++
) {
69 $o = $rs->FetchField($i);
73 $savefetch = isset($rs->adodbFetchMode
) ?
$rs->adodbFetchMode
: $rs->fetchMode
;
74 $class = $rs->connection
->arrayClass
;
76 $rs2->timeCreated
= $rs->timeCreated
; # memcache fix
78 $rs2->oldProvider
= $rs->dataProvider
;
79 $rs2->InitArrayFields($rows,$flds);
80 $rs2->fetchMode
= $savefetch;
81 return $line.serialize($rs2);
86 * Open CSV file and convert it into Data.
88 * @param url file/ftp/http url
89 * @param err returns the error message
90 * @param timeout dispose if recordset has been alive for $timeout secs
92 * @return recordset, or false if error occured. If no
93 * error occurred in sql INSERT/UPDATE/DELETE,
94 * empty recordset is returned
96 function csv2rs($url,&$err,$timeout=0, $rsclass='ADORecordSet_array')
100 $fp = @fopen
($url,'rb');
102 $err = $url.' file/URL not found';
105 @flock
($fp, LOCK_SH
);
109 if ($meta = fgetcsv($fp, 32000, ",")) {
110 // check if error message
111 if (strncmp($meta[0],'****',4) === 0) {
112 $err = trim(substr($meta[0],4,1024));
116 // check for meta data
117 // $meta[0] is -1 means return an empty recordset
118 // $meta[1] contains a time
120 if (strncmp($meta[0], '====',4) === 0) {
122 if ($meta[0] == "====-1") {
123 if (sizeof($meta) < 5) {
124 $err = "Corrupt first line for format -1";
131 $err = " Illegal Timeout $timeout ";
135 $rs = new $rsclass($val=true);
136 $rs->fields
= array();
137 $rs->timeCreated
= $meta[1];
139 $rs->_numOfFields
= 0;
140 $rs->sql
= urldecode($meta[2]);
141 $rs->affectedrows
= (integer)$meta[3];
142 $rs->insertid
= $meta[4];
145 # Under high volume loads, we want only 1 thread/process to _write_file
146 # so that we don't have 50 processes queueing to write the same data.
147 # We use probabilistic timeout, ahead of time.
149 # -4 sec before timeout, give processes 1/32 chance of timing out
150 # -2 sec before timeout, give processes 1/16 chance of timing out
151 # -1 sec after timeout give processes 1/4 chance of timing out
152 # +0 sec after timeout, give processes 100% chance of timing out
153 if (sizeof($meta) > 1) {
155 $tdiff = (integer)( $meta[1]+
$timeout - time());
160 if ((rand() & 31) == 0) {
167 if ((rand() & 15) == 0) {
174 if ((rand() & 3) == 0) {
186 } // if check flush cache
190 //================================================
191 // new cache format - use serialize extensively...
192 if ($meta[0] === '====1') {
196 $text = fread($fp,$MAXSIZE);
198 while ($txt = fread($fp,$MAXSIZE)) {
203 $rs = unserialize($text);
204 if (is_object($rs)) $rs->timeCreated
= $ttl;
206 $err = "Unable to unserialize recordset";
207 //echo htmlspecialchars($text),' !--END--!<p>';
213 $meta = fgetcsv($fp, 32000, ",");
216 $err = "Unexpected EOF 1";
221 // Get Column definitions
223 foreach($meta as $o) {
224 $o2 = explode(':',$o);
225 if (sizeof($o2)!=3) {
230 $fld = new ADOFieldObject();
231 $fld->name
= urldecode($o2[0]);
233 $fld->max_length
= $o2[2];
238 $err = "Recordset had unexpected EOF 2";
246 while ($txt = fread($fp,$MAXSIZE)) {
251 @$arr = unserialize($text);
253 if (!is_array($arr)) {
254 $err = "Recordset had unexpected EOF (in serialized recordset)";
255 if (get_magic_quotes_runtime()) $err .= ". Magic Quotes Runtime should be disabled!";
258 $rs = new $rsclass();
259 $rs->timeCreated
= $ttl;
260 $rs->InitArrayFields($arr,$flds);
266 * Save a file $filename and its $contents (normally for caching) with file locking
267 * Returns true if ok, false if fopen/fwrite error, 0 if rename error (eg. file is locked)
269 function adodb_write_file($filename, $contents,$debug=false)
271 # http://www.php.net/bugs.php?id=9203 Bug that flock fails on Windows
272 # So to simulate locking, we assume that rename is an atomic operation.
273 # First we delete $filename, then we create a $tempfile write to it and
274 # rename to the desired $filename. If the rename works, then we successfully
275 # modified the file exclusively.
276 # What a stupid need - having to simulate locking.
278 # 1. $tempfile name is not unique -- very very low
279 # 2. unlink($filename) fails -- ok, rename will fail
280 # 3. adodb reads stale file because unlink fails -- ok, $rs timeout occurs
281 # 4. another process creates $filename between unlink() and rename() -- ok, rename() fails and cache updated
282 if (strncmp(PHP_OS
,'WIN',3) === 0) {
283 // skip the decimal place
284 $mtime = substr(str_replace(' ','_',microtime()),2);
285 // getmypid() actually returns 0 on Win98 - never mind!
286 $tmpname = $filename.uniqid($mtime).getmypid();
287 if (!($fd = @fopen
($tmpname,'w'))) return false;
288 if (fwrite($fd,$contents)) $ok = true;
293 @chmod
($tmpname,0644);
296 if (!@rename
($tmpname,$filename)) {
301 if ($debug) ADOConnection
::outp( " Rename $tmpname ".($ok?
'ok' : 'failed'));
306 if (!($fd = @fopen
($filename, 'a'))) return false;
307 if (flock($fd, LOCK_EX
) && ftruncate($fd, 0)) {
308 if (fwrite( $fd, $contents )) $ok = true;
311 @chmod
($filename,0644);
314 if ($debug)ADOConnection
::outp( " Failed acquiring lock for $filename<br>\n");