libraries/export/csv.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * @version $Id$
   5  */
   6
   7 /**
   8  * Set of functions used to build CSV dumps of tables
   9  */
  10
  11 if (isset($plugin_list)) {
  12     $plugin_list['csv'] = array(
  13         'text' => 'strStrucCSV',
  14         'extension' => 'csv',
  15         'mime_type' => 'text/comma-separated-values',
  16         'options' => array(
  17             array('type' => 'text', 'name' => 'separator', 'text' => 'strFieldsTerminatedBy'),
  18             array('type' => 'text', 'name' => 'enclosed', 'text' => 'strFieldsEnclosedBy'),
  19             array('type' => 'text', 'name' => 'escaped', 'text' => 'strFieldsEscapedBy'),
  20             array('type' => 'text', 'name' => 'terminated', 'text' => 'strLinesTerminatedBy'),
  21             array('type' => 'text', 'name' => 'null', 'text' => 'strReplaceNULLBy'),
  22             array('type' => 'bool', 'name' => 'columns', 'text' => 'strPutColNames'),
  23             array('type' => 'hidden', 'name' => 'data'),
  24             ),
  25         'options_text' => 'strOptions',
  26         );
  27 } else {
  28
  29 /**
  30  * Outputs comment
  31  *
  32  * @param   string      Text of comment
  33  *
  34  * @return  bool        Whether it suceeded
  35  */
  36 function PMA_exportComment($text) {
  37     return TRUE;
  38 }
  39
  40 /**
  41  * Outputs export footer
  42  *
  43  * @return  bool        Whether it suceeded
  44  *
  45  * @access  public
  46  */
  47 function PMA_exportFooter() {
  48     return TRUE;
  49 }
  50
  51 /**
  52  * Outputs export header
  53  *
  54  * @return  bool        Whether it suceeded
  55  *
  56  * @access  public
  57  */
  58 function PMA_exportHeader() {
  59     global $what;
  60     global $csv_terminated;
  61     global $csv_separator;
  62     global $csv_enclosed;
  63     global $csv_escaped;
  64
  65     // Here we just prepare some values for export
  66     if ($what == 'excel') {
  67         $csv_terminated      = "\015\012";
  68         $csv_separator          = isset($GLOBALS['excel_edition']) && $GLOBALS['excel_edition'] == 'mac' ? ';' : ',';
  69         $csv_enclosed           = '"';
  70         $csv_escaped            = '"';
  71         if (isset($GLOBALS['excel_columns'])) {
  72             $GLOBALS['csv_columns'] = 'yes';
  73         }
  74     } else {
  75         if (empty($csv_terminated) || strtolower($csv_terminated) == 'auto') {
  76             $csv_terminated  = $GLOBALS['crlf'];
  77         } else {
  78             $csv_terminated  = str_replace('\\r', "\015", $csv_terminated);
  79             $csv_terminated  = str_replace('\\n', "\012", $csv_terminated);
  80             $csv_terminated  = str_replace('\\t', "\011", $csv_terminated);
  81         } // end if
  82         $csv_separator          = str_replace('\\t', "\011", $csv_separator);
  83     }
  84     return TRUE;
  85 }
  86
  87 /**
  88  * Outputs database header
  89  *
  90  * @param   string      Database name
  91  *
  92  * @return  bool        Whether it suceeded
  93  *
  94  * @access  public
  95  */
  96 function PMA_exportDBHeader($db) {
  97     return TRUE;
  98 }
  99
 100 /**
 101  * Outputs database footer
 102  *
 103  * @param   string      Database name
 104  *
 105  * @return  bool        Whether it suceeded
 106  *
 107  * @access  public
 108  */
 109 function PMA_exportDBFooter($db) {
 110     return TRUE;
 111 }
 112
 113 /**
 114  * Outputs create database database
 115  *
 116  * @param   string      Database name
 117  *
 118  * @return  bool        Whether it suceeded
 119  *
 120  * @access  public
 121  */
 122 function PMA_exportDBCreate($db) {
 123     return TRUE;
 124 }
 125
 126 /**
 127  * Outputs the content of a table in CSV format
 128  *
 129  * @param   string      the database name
 130  * @param   string      the table name
 131  * @param   string      the end of line sequence
 132  * @param   string      the url to go back in case of error
 133  * @param   string      SQL query for obtaining data
 134  *
 135  * @return  bool        Whether it suceeded
 136  *
 137  * @access  public
 138  */
 139 function PMA_exportData($db, $table, $crlf, $error_url, $sql_query) {
 140     global $what;
 141     global $csv_terminated;
 142     global $csv_separator;
 143     global $csv_enclosed;
 144     global $csv_escaped;
 145
 146     // Gets the data from the database
 147     $result      = PMA_DBI_query($sql_query, null, PMA_DBI_QUERY_UNBUFFERED);
 148     $fields_cnt  = PMA_DBI_num_fields($result);
 149
 150     // If required, get fields name at the first line
 151     if (isset($GLOBALS['csv_columns'])) {
 152         $schema_insert = '';
 153         for ($i = 0; $i < $fields_cnt; $i++) {
 154             if ($csv_enclosed == '') {
 155                 $schema_insert .= stripslashes(PMA_DBI_field_name($result, $i));
 156             } else {
 157                 $schema_insert .= $csv_enclosed
 158                                . str_replace($csv_enclosed, $csv_escaped . $csv_enclosed, stripslashes(PMA_DBI_field_name($result, $i)))
 159                                . $csv_enclosed;
 160             }
 161             $schema_insert     .= $csv_separator;
 162         } // end for
 163         $schema_insert  =trim(substr($schema_insert, 0, -1));
 164         if (!PMA_exportOutputHandler($schema_insert . $csv_terminated)) {
 165             return FALSE;
 166         }
 167     } // end if
 168
 169     // Format the data
 170     while ($row = PMA_DBI_fetch_row($result)) {
 171         $schema_insert = '';
 172         for ($j = 0; $j < $fields_cnt; $j++) {
 173             if (!isset($row[$j]) || is_null($row[$j])) {
 174                 $schema_insert .= $GLOBALS[$what . '_null'];
 175             } elseif ($row[$j] == '0' || $row[$j] != '') {
 176                 // loic1 : always enclose fields
 177                 if ($what == 'excel') {
 178                     $row[$j]       = ereg_replace("\015(\012)?", "\012", $row[$j]);
 179                 }
 180                 if ($csv_enclosed == '') {
 181                     $schema_insert .= $row[$j];
 182                 } else {
 183                     $schema_insert .= $csv_enclosed
 184                                    . str_replace($csv_enclosed, $csv_escaped . $csv_enclosed, $row[$j])
 185                                    . $csv_enclosed;
 186                 }
 187             } else {
 188                 $schema_insert .= '';
 189             }
 190             if ($j < $fields_cnt-1) {
 191                 $schema_insert .= $csv_separator;
 192             }
 193         } // end for
 194
 195         if (!PMA_exportOutputHandler($schema_insert . $csv_terminated)) {
 196             return FALSE;
 197         }
 198     } // end while
 199     PMA_DBI_free_result($result);
 200
 201     return TRUE;
 202 } // end of the 'PMA_getTableCsv()' function
 203
 204 }
 205 ?>