woocommerce/includes/export/abstract-wc-csv-exporter.php

<?php
/**
 * Handles CSV export.
 *
 * @author   Automattic
 * @category Admin
 * @package  WooCommerce/Export
 * @version  3.1.0
 */
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * WC_CSV_Exporter Class.
 */
abstract class WC_CSV_Exporter {

	/**
	 * Type of export used in filter names.
	 */
	protected $export_type = '';

	/**
	 * Batch limit.
	 * @var integer
	 */
	protected $limit = 10;

	/**
	 * Number exported.
	 * @var integer
	 */
	protected $exported_row_count = 0;

	/**
	 * Raw data to export.
	 * @var integer
	 */
	protected $row_data = array();

	/**
	 * The CSV data - each row is an array item.
	 * @var string[]
	 */
	protected $csv_rows = array();

	/**
	 * Total rows to export.
	 * @var integer
	 */
	protected $total_rows = 0;

	/**
	 * Columns ids and names.
	 * @var array
	 */
	protected $column_names = array();

	/**
	 * Prepare data that will be exported.
	 */
	abstract function prepare_data_to_export();

	/**
	 * Return an array of columns to export.
	 *
	 * @return array
	 */
	public function get_column_names() {
		return $this->column_names;
	}

	/**
	 * Set column names.
	 * @param array $column_names
	 */
	public function set_column_names( $column_names ) {
		$this->column_names = array();

		foreach ( $column_names as $column_id => $column_name ) {
			$this->column_names[ wc_clean( $column_id ) ] = wc_clean( $column_name );
		}
	}

	/**
	 * Return default columns.
	 *
	 * @return array
	 */
	public function get_default_column_names() {
		return array();
	}

	/**
	 * Do the export.
	 */
	public function export() {
		$this->prepare_data_to_export();
		$this->send_headers();
		$this->send_content( $this->export_column_headers() . $this->get_csv_data() );
		die();
	}

	/**
	 * Set the export headers.
	 */
	public function send_headers() {
		if ( function_exists( 'gc_enable' ) ) {
			gc_enable();
		}
		if ( function_exists( 'apache_setenv' ) ) {
			@apache_setenv( 'no-gzip', 1 );
		}
		@ini_set( 'zlib.output_compression', 'Off' );
		@ini_set( 'output_buffering', 'Off' );
		@ini_set( 'output_handler', '' );
		ignore_user_abort( true );
		wc_set_time_limit( 0 );
		nocache_headers();
		header( 'Content-Type: text/csv; charset=utf-8' );
		header( 'Content-Disposition: attachment; filename=wc-' . $this->export_type . '-export.csv' );
		header( 'Pragma: no-cache' );
		header( 'Expires: 0' );
	}

	/**
	 * Set the export content.
	 */
	public function send_content( $csv_data ) {
		echo $csv_data;
	}

	/**
	 * Get CSV data for this export.
	 * @return string
	 */
	protected function get_csv_data() {
		return "\r\n" . implode( "\r\n", $this->export_rows() );
	}

	/**
	 * Export column headers in CSV format.
	 */
	protected function export_column_headers() {
		$columns     = $this->get_column_names();
		$column_ids  = array_keys( $columns );
		$last_column = end( $column_ids );
		$row         = '';

		foreach ( $columns as $column_id => $column_name ) {
			$row .= '"' . addslashes( $column_name ) . '"';
			$row .= $column_id === $last_column ? '' : ',';
		}

		return $row;
	}

	/**
	 * Get data that will be exported.
	 *
	 * @return array
	 */
	protected function get_data_to_export() {
		return $this->row_data;
	}

	/**
	 * Export rows in CSV format.
	 */
	protected function export_rows() {
		$this->csv_rows = array();
		$data = $this->get_data_to_export();
		array_walk( $data, array( $this, 'export_row' ) );
		return $this->csv_rows;
	}

	/**
	 * Export a row in CSV format.
	 */
	protected function export_row( $row_data ) {
		$columns     = $this->get_column_names();
		$column_ids  = array_keys( $columns );
		$last_column = end( $column_ids );
		$row         = '';

		foreach ( $columns as $column_id => $column_name ) {
			if ( isset( $row_data[ $column_id ] ) ) {
				$row .= '"' . $this->format_data( $row_data[ $column_id ] ) . '"';
			} else {
				$row .= '""';
			}
			$row .= $column_id === $last_column ? '' : ',';
		}

		$this->csv_rows[] = $row;
		++ $this->exported_row_count;
	}

	/**
	 * Get batch limit.
	 * @return int
	 */
	public function get_limit() {
		return $this->limit;
	}

	/**
	 * Set batch limit.
	 * @param int $limit
	 */
	public function set_limit( $limit ) {
		$this->limit = absint( $limit );
	}

	/**
	 * Get count of records exported.
	 * @return int
	 */
	public function get_total_exported() {
		return $this->exported_row_count;
	}

	/**
	 * Escape a string to be used in a CSV context
	 *
	 * Malicious input can inject formulas into CSV files, opening up the possibility
	 * for phishing attacks and disclosure of sensitive information.
	 *
	 * Additionally, Excel exposes the ability to launch arbitrary commands through
	 * the DDE protocol.
	 *
	 * @see http://www.contextis.com/resources/blog/comma-separated-vulnerabilities/
	 * @see https://hackerone.com/reports/72785
	 *
	 * @param string $field CSV field to escape
	 *
	 * @return string
	 */
	public function escape_data( $data ) {
		$active_content_triggers = array( '=', '+', '-', '@' );

		if ( in_array( mb_substr( $data, 0, 1 ), $active_content_triggers, true ) ) {
			$data = "'" . $data;
		}

		return $data;
	}

	/**
	 * Format and escape data ready for the CSV file.
	 * @param  string $data
	 * @return string
	 */
	public function format_data( $data ) {
		if ( ! is_scalar( $data ) ) {
			if ( is_a( $data, 'WC_Datetime' ) ) {
				$data = $data->date( DATE_ATOM );
			} elseif ( is_bool( $data ) ) {
				$data = $data ? 1 : 0;
			} else {
				$data = ''; // Not supported.
			}
		}
		$data     = (string) urldecode( $data );
		$encoding = mb_detect_encoding( $data, 'UTF-8, ISO-8859-1', true );
		$data     = 'UTF-8' === $encoding ? $data : utf8_encode( $data );
		return $this->escape_data( addslashes( $data ) );
	}

	/**
	 * Format term ids to names.
	 * @param  array $term_ids
	 * @param  string $taxonomy
	 * @return array
	 */
	public function format_term_ids( $term_ids, $taxonomy ) {
		$term_ids = wp_parse_id_list( $term_ids );

		if ( ! count( $term_ids ) ) {
			return '';
		}

		$formatted_terms = array();

		if ( is_taxonomy_hierarchical( $taxonomy ) ) {
			foreach ( $term_ids as $term_id ) {
				$formatted_term = array();
				$ancestor_ids   = array_reverse( get_ancestors( $term_id, $taxonomy ) );

				foreach ( $ancestor_ids as $ancestor_id ) {
					$term = get_term( $ancestor_id, $taxonomy );
					if ( $term && ! is_wp_error( $term ) ) {
						$formatted_term[] = $term->name;
					}
				}

				$term = get_term( $term_id, $taxonomy );

				if ( $term && ! is_wp_error( $term ) ) {
					$formatted_term[] = $term->name;
				}

				$formatted_terms[] = implode( ' > ', $formatted_term );
			}
		} else {
			foreach ( $term_ids as $term_id ) {
				$term = get_term( $term_id, $taxonomy );

				if ( $term && ! is_wp_error( $term ) ) {
					$formatted_terms[] = $term->name;
				}
			}
		}

		return implode( ', ', $formatted_terms );
	}
}