library/adodb/adodb-csvlib.inc.php

   1 <?php
   2 global $ADODB_INCLUDED_CSV;
   3 $ADODB_INCLUDED_CSV = 1;
   4
   5 /*
   6   V4.20 22 Feb 2004  (c) 2000-2004 John Lim (jlim@natsoft.com.my). All rights reserved.
   7   Released under both BSD license and Lesser GPL library license.
   8   Whenever there is any discrepancy between the two licenses,
   9   the BSD license will take precedence. See License.txt.
  10   Set tabs to 4 for best viewing.
  11
  12   Latest version is available at http://php.weblogs.com/
  13
  14   Library for CSV serialization. This is used by the csv/proxy driver and is the
  15   CacheExecute() serialization format.
  16
  17   ==== NOTE ====
  18   Format documented at http://php.weblogs.com/ADODB_CSV
  19   ==============
  20 */
  21
  22         /**
  23          * convert a recordset into special format
  24          *
  25          * @param rs    the recordset
  26          *
  27          * @return      the CSV formated data
  28          */
  29         function _rs2serialize(&$rs,$conn=false,$sql='')
  30         {
  31                 $max = ($rs) ? $rs->FieldCount() : 0;
  32
  33                 if ($sql) $sql = urlencode($sql);
  34                 // metadata setup
  35
  36                 if ($max <= 0 || $rs->dataProvider == 'empty') { // is insert/update/delete
  37                         if (is_object($conn)) {
  38                                 $sql .= ','.$conn->Affected_Rows();
  39                                 $sql .= ','.$conn->Insert_ID();
  40                         } else
  41                                 $sql .= ',,';
  42
  43                         $text = "====-1,0,$sql\n";
  44                         return $text;
  45                 } else {
  46                         $tt = ($rs->timeCreated) ? $rs->timeCreated : time();
  47                         $line = "====0,$tt,$sql\n";
  48                 }
  49                 // column definitions
  50                 for($i=0; $i < $max; $i++) {
  51                         $o = $rs->FetchField($i);
  52                         $line .= urlencode($o->name).':'.$rs->MetaType($o->type,$o->max_length,$o).":$o->max_length,";
  53                 }
  54                 $text = substr($line,0,strlen($line)-1)."\n";
  55
  56
  57                 // get data
  58                 if ($rs->databaseType == 'array') {
  59                         $text .= serialize($rs->_array);
  60                 } else {
  61                         $rows = array();
  62                         while (!$rs->EOF) {
  63                                 $rows[] = $rs->fields;
  64                                 $rs->MoveNext();
  65                         }
  66                         $text .= serialize($rows);
  67                 }
  68                 $rs->MoveFirst();
  69                 return $text;
  70         }
  71
  72
  73 /**
  74 * Open CSV file and convert it into Data.
  75 *
  76 * @param url            file/ftp/http url
  77 * @param err            returns the error message
  78 * @param timeout        dispose if recordset has been alive for $timeout secs
  79 *
  80 * @return               recordset, or false if error occured. If no
  81 *                       error occurred in sql INSERT/UPDATE/DELETE,
  82 *                       empty recordset is returned
  83 */
  84         function &csv2rs($url,&$err,$timeout=0)
  85         {
  86                 $err = false;
  87                 $fp = @fopen($url,'r');
  88                 if (!$fp) {
  89                         $err = $url.' file/URL not found';
  90                         return false;
  91                 }
  92                 flock($fp, LOCK_SH);
  93                 $arr = array();
  94                 $ttl = 0;
  95
  96                 if ($meta = fgetcsv ($fp, 32000, ",")) {
  97                         // check if error message
  98                         if (substr($meta[0],0,4) === '****') {
  99                                 $err = trim(substr($meta[0],4,1024));
 100                                 fclose($fp);
 101                                 return false;
 102                         }
 103                         // check for meta data
 104                         // $meta[0] is -1 means return an empty recordset
 105                         // $meta[1] contains a time
 106
 107                         if (substr($meta[0],0,4) ===  '====') {
 108
 109                                 if ($meta[0] == "====-1") {
 110                                         if (sizeof($meta) < 5) {
 111                                                 $err = "Corrupt first line for format -1";
 112                                                 fclose($fp);
 113                                                 return false;
 114                                         }
 115                                         fclose($fp);
 116
 117                                         if ($timeout > 0) {
 118                                                 $err = " Illegal Timeout $timeout ";
 119                                                 return false;
 120                                         }
 121                                         $rs->fields = array();
 122                                         $rs->timeCreated = $meta[1];
 123                                         $rs = new ADORecordSet($val=true);
 124                                         $rs->EOF = true;
 125                                         $rs->_numOfFields=0;
 126                                         $rs->sql = urldecode($meta[2]);
 127                                         $rs->affectedrows = (integer)$meta[3];
 128                                         $rs->insertid = $meta[4];
 129                                         return $rs;
 130                                 }
 131                         # Under high volume loads, we want only 1 thread/process to _write_file
 132                         # so that we don't have 50 processes queueing to write the same data.
 133                         # Would require probabilistic blocking write
 134                         #
 135                         # -2 sec before timeout, give processes 1/16 chance of writing to file with blocking io
 136                         # -1 sec after timeout give processes 1/4 chance of writing with blocking
 137                         # +0 sec after timeout, give processes 100% chance writing with blocking
 138                                 if (sizeof($meta) > 1) {
 139                                         if($timeout >0){
 140                                                 $tdiff = $meta[1]+$timeout - time();
 141                                                 if ($tdiff <= 2) {
 142                                                         switch($tdiff) {
 143                                                         case 2:
 144                                                                 if ((rand() & 15) == 0) {
 145                                                                         fclose($fp);
 146                                                                         $err = "Timeout 2";
 147                                                                         return false;
 148                                                                 }
 149                                                                 break;
 150                                                         case 1:
 151                                                                 if ((rand() & 3) == 0) {
 152                                                                         fclose($fp);
 153                                                                         $err = "Timeout 1";
 154                                                                         return false;
 155                                                                 }
 156                                                                 break;
 157                                                         default:
 158                                                                 fclose($fp);
 159                                                                 $err = "Timeout 0";
 160                                                                 return false;
 161                                                         } // switch
 162
 163                                                 } // if check flush cache
 164                                         }// (timeout>0)
 165                                         $ttl = $meta[1];
 166                                 }
 167                                 $meta = false;
 168                                 $meta = fgetcsv($fp, 16000, ",");
 169                                 if (!$meta) {
 170                                         fclose($fp);
 171                                         $err = "Unexpected EOF 1";
 172                                         return false;
 173                                 }
 174                         }
 175
 176                         // Get Column definitions
 177                         $flds = array();
 178                         foreach($meta as $o) {
 179                                 $o2 = explode(':',$o);
 180                                 if (sizeof($o2)!=3) {
 181                                         $arr[] = $meta;
 182                                         $flds = false;
 183                                         break;
 184                                 }
 185                                 $fld = new ADOFieldObject();
 186                                 $fld->name = urldecode($o2[0]);
 187                                 $fld->type = $o2[1];
 188                                 $fld->max_length = $o2[2];
 189                                 $flds[] = $fld;
 190                         }
 191                 } else {
 192                         fclose($fp);
 193                         $err = "Recordset had unexpected EOF 2";
 194                         return false;
 195                 }
 196
 197                 // slurp in the data
 198                 $MAXSIZE = 128000;
 199
 200                 $text = '';
 201                 while ($txt = fread($fp,$MAXSIZE)) {
 202                         $text .= $txt;
 203                 }
 204
 205                 fclose($fp);
 206                 $arr = @unserialize($text);
 207                 //var_dump($arr);
 208                 if (!is_array($arr)) {
 209                         $err = "Recordset had unexpected EOF (in serialized recordset)";
 210                         if (get_magic_quotes_runtime()) $err .= ". Magic Quotes Runtime should be disabled!";
 211                         return false;
 212                 }
 213                 $rs = new ADORecordSet_array();
 214                 $rs->timeCreated = $ttl;
 215                 $rs->InitArrayFields($arr,$flds);
 216                 return $rs;
 217         }
 218 ?>