| 1 |
<?php |
| 2 |
|
| 3 |
// +----------------------------------------------------------------------+ |
| 4 |
// | Copyright 2013 Madpixels (email : visualizer@madpixels.net) | |
| 5 |
// +----------------------------------------------------------------------+ |
| 6 |
// | This program is free software; you can redistribute it and/or modify | |
| 7 |
// | it under the terms of the GNU General Public License, version 2, as | |
| 8 |
// | published by the Free Software Foundation. | |
| 9 |
// | | |
| 10 |
// | This program is distributed in the hope that it will be useful, | |
| 11 |
// | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 |
// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 13 |
// | GNU General Public License for more details. | |
| 14 |
// | | |
| 15 |
// | You should have received a copy of the GNU General Public License | |
| 16 |
// | along with this program; if not, write to the Free Software | |
| 17 |
// | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, | |
| 18 |
// | MA 02110-1301 USA | |
| 19 |
// +----------------------------------------------------------------------+ |
| 20 |
// | Author: Eugene Manuilov <eugene@manuilov.org> | |
| 21 |
// +----------------------------------------------------------------------+ |
| 22 |
/** |
| 23 |
* Source manager for local CSV files. |
| 24 |
* |
| 25 |
* @category Visualizer |
| 26 |
* @package Source |
| 27 |
* |
| 28 |
* @since 1.0.0 |
| 29 |
*/ |
| 30 |
class Visualizer_Source_Csv extends Visualizer_Source { |
| 31 |
|
| 32 |
/** |
| 33 |
* The path to the file with data. |
| 34 |
* |
| 35 |
* @since 1.0.0 |
| 36 |
* |
| 37 |
* @access protected |
| 38 |
* @var string |
| 39 |
*/ |
| 40 |
protected $_filename; |
| 41 |
|
| 42 |
/** |
| 43 |
* Constructor. |
| 44 |
* |
| 45 |
* @since 1.0.0 |
| 46 |
* |
| 47 |
* @access public |
| 48 |
* @param string $filename The path to the file. |
| 49 |
*/ |
| 50 |
public function __construct( $filename = null ) { |
| 51 |
$this->_filename = trim( $filename ); |
| 52 |
} |
| 53 |
|
| 54 |
/** |
| 55 |
* Fetches series information. |
| 56 |
* |
| 57 |
* @since 1.0.0 |
| 58 |
* |
| 59 |
* @access private |
| 60 |
* @param resource $handle The file handle resource. |
| 61 |
*/ |
| 62 |
private function _fetchSeries( &$handle ) { |
| 63 |
// read column titles |
| 64 |
$labels = fgetcsv( $handle, 0, VISUALIZER_CSV_DELIMITER, VISUALIZER_CSV_ENCLOSURE ); |
| 65 |
$types = null; |
| 66 |
|
| 67 |
if ( false !== strpos( $this->_filename, 'tqx=out:csv' ) ) { |
| 68 |
$attributes = $this->_fetchSeriesForGoogleQueryLanguage( $labels ); |
| 69 |
if ( ! $attributes['abort'] ) { |
| 70 |
$labels = $attributes['labels']; |
| 71 |
$types = $attributes['types']; |
| 72 |
} |
| 73 |
} |
| 74 |
|
| 75 |
if ( is_null( $types ) ) { |
| 76 |
// read series types |
| 77 |
$types = fgetcsv( $handle, 0, VISUALIZER_CSV_DELIMITER, VISUALIZER_CSV_ENCLOSURE ); |
| 78 |
} |
| 79 |
|
| 80 |
if ( ! $labels || ! $types ) { |
| 81 |
return false; |
| 82 |
} |
| 83 |
|
| 84 |
// if no types were setup, re read labels and empty types array |
| 85 |
$types = array_map( 'trim', $types ); |
| 86 |
if ( ! self::_validateTypes( $types ) ) { |
| 87 |
// re open the file |
| 88 |
fclose( $handle ); |
| 89 |
$handle = $this->_get_file_handle(); |
| 90 |
|
| 91 |
// re read the labels and empty types array |
| 92 |
$labels = fgetcsv( $handle, 0, VISUALIZER_CSV_DELIMITER, VISUALIZER_CSV_ENCLOSURE ); |
| 93 |
$types = array(); |
| 94 |
} |
| 95 |
|
| 96 |
for ( $i = 0, $len = count( $labels ); $i < $len; $i++ ) { |
| 97 |
$default_type = $i === 0 ? 'string' : 'number'; |
| 98 |
|
| 99 |
$labels[ $i ] = $this->toUTF8( $labels[ $i ] ); |
| 100 |
|
| 101 |
$this->_series[] = array( |
| 102 |
'label' => $labels[ $i ], |
| 103 |
'type' => isset( $types[ $i ] ) ? $types[ $i ] : $default_type, |
| 104 |
); |
| 105 |
} |
| 106 |
|
| 107 |
return true; |
| 108 |
} |
| 109 |
|
| 110 |
/** |
| 111 |
* Returns file handle to fetch data from. |
| 112 |
* |
| 113 |
* @since 1.4.2 |
| 114 |
* |
| 115 |
* @access protected |
| 116 |
* @param string $filename Optional file name to get handle. If omitted, $_filename is used. |
| 117 |
* @return resource File handle resource on success, otherwise FALSE. |
| 118 |
*/ |
| 119 |
protected function _get_file_handle( $filename = false ) { |
| 120 |
// set line endings auto detect mode |
| 121 |
ini_set( 'auto_detect_line_endings', true ); |
| 122 |
// open file and return handle |
| 123 |
return fopen( $filename ? $filename : $this->_filename, 'rb' ); |
| 124 |
} |
| 125 |
|
| 126 |
/** |
| 127 |
* Fetches information from source, parses it and builds series and data arrays. |
| 128 |
* |
| 129 |
* @since 1.0.0 |
| 130 |
* |
| 131 |
* @access public |
| 132 |
* @return boolean TRUE on success, otherwise FALSE. |
| 133 |
*/ |
| 134 |
public function fetch() { |
| 135 |
// if filename is empty return false |
| 136 |
if ( empty( $this->_filename ) ) { |
| 137 |
return false; |
| 138 |
} |
| 139 |
|
| 140 |
// read file and fill arrays |
| 141 |
$handle = $this->_get_file_handle(); |
| 142 |
if ( $handle ) { |
| 143 |
// fetch series |
| 144 |
if ( ! $this->_fetchSeries( $handle ) ) { |
| 145 |
return false; |
| 146 |
} |
| 147 |
|
| 148 |
// fetch data |
| 149 |
// phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition |
| 150 |
while ( ( $data = fgetcsv( $handle, 0, VISUALIZER_CSV_DELIMITER, VISUALIZER_CSV_ENCLOSURE ) ) !== false ) { |
| 151 |
$this->_data[] = $this->_normalizeData( $data ); |
| 152 |
} |
| 153 |
|
| 154 |
// close file handle |
| 155 |
fclose( $handle ); |
| 156 |
} |
| 157 |
|
| 158 |
return true; |
| 159 |
} |
| 160 |
|
| 161 |
/** |
| 162 |
* Returns source name. |
| 163 |
* |
| 164 |
* @since 1.0.0 |
| 165 |
* |
| 166 |
* @access public |
| 167 |
* @return string The name of source. |
| 168 |
*/ |
| 169 |
public function getSourceName() { |
| 170 |
return __CLASS__; |
| 171 |
} |
| 172 |
|
| 173 |
/** |
| 174 |
* Adds support for QueryLanguage https://developers.google.com/chart/interactive/docs/querylanguage |
| 175 |
* where the user can provide something like /gviz/tq?tq=select%20A%2C%20B%20&tqx=out:csv after the URL of the raw spreadsheet |
| 176 |
* to get the subset of data specified by the query |
| 177 |
* this will conflate the heading and the type into one value viz. for heading XXX and type string, the value will become "XXX string" |
| 178 |
* so we need to split them apart logically |
| 179 |
* also the $types variable now contains the first row because the header and the type got conflated |
| 180 |
*/ |
| 181 |
private function _fetchSeriesForGoogleQueryLanguage( $labels, $types = array() ) { |
| 182 |
$new_labels = array(); |
| 183 |
$new_types = array(); |
| 184 |
$abort = false; |
| 185 |
foreach ( $labels as $label ) { |
| 186 |
// get the index of the last space |
| 187 |
$index = strrpos( $label, ' ' ); |
| 188 |
if ( $index === false ) { |
| 189 |
// no space here? something has gone wrong; abort the entire process. |
| 190 |
$abort = true; |
| 191 |
break; |
| 192 |
} |
| 193 |
$type = trim( substr( $label, $index + 1 ) ); |
| 194 |
if ( ! self::_validateTypes( array( $type ) ) ) { |
| 195 |
// some other data type? abort the entire process. |
| 196 |
$abort = true; |
| 197 |
break; |
| 198 |
} |
| 199 |
$label = substr( $label, 0, $index ); |
| 200 |
$new_labels[] = $label; |
| 201 |
$new_types[] = $type; |
| 202 |
} |
| 203 |
if ( ! $abort ) { |
| 204 |
$labels = $new_labels; |
| 205 |
$types = $new_types; |
| 206 |
} |
| 207 |
|
| 208 |
return array( |
| 209 |
'abort' => $abort, |
| 210 |
'labels' => $labels, |
| 211 |
'types' => $types, |
| 212 |
); |
| 213 |
} |
| 214 |
} |
| 215 |
|
