xref: /plugin/struct/renderer/csv.php (revision 470e44be3c0bad066dfbb6af3875f5e11344471d)

<?php

/**
 * CSV export of tabular data
 *
 * @link https://tools.ietf.org/html/rfc4180
 * @link http://csvlint.io/
 */
class renderer_plugin_struct_csv extends Doku_Renderer {

    protected $first = false;

    /**
     * Determine if out put is wanted right now
     *
     * @return bool
     */
    function _doOutput() {
        global $INPUT;

        if(
            !isset($this->info['struct_table_hash']) or
            $this->info['struct_table_hash'] != $INPUT->str('hash')
        ) {
            return false;
        }

        if(!empty($this->info['struct_table_meta'])) {
            return false;
        }

        return true;
    }

    /**
     * Our own format
     *
     * @return string
     */
    function getFormat() {
        return 'struct_csv';
    }

    /**
     * Set proper headers
     */
    function document_start() {
        global $ID;
        $filename = noNS($ID) . '.csv';
        $headers = array(
            'Content-Type' => 'text/csv',
            'Content-Disposition' => 'attachment; filename="' . $filename . '";'
        );
        p_set_metadata($ID, array('format' => array('struct_csv' => $headers)));
        // don't cache
        $this->nocache();
    }

    /**
     * Opening a table row prevents the separator for the first following cell
     */
    function tablerow_open() {
        if(!$this->_doOutput()) return;
        $this->first = true;
    }

    /**
     * Output the delimiter (unless it's the first cell of this row) and the text wrapper
     *
     * @param int $colspan ignored
     * @param null $align ignored
     * @param int $rowspan ignored
     */
    function tablecell_open($colspan = 1, $align = null, $rowspan = 1) {
        if(!$this->_doOutput()) return;
        if(!$this->first) {
            $this->doc .= ",";
        }
        $this->first = false;

        $this->doc .= '"';
    }

    /**
     * Close the text wrapper
     */
    function tablecell_close() {
        if(!$this->_doOutput()) return;
        $this->doc .= '"';
    }

    /**
     * Alias for tablecell_open
     *
     * @param int $colspan ignored
     * @param null $align ignored
     * @param int $rowspan ignored
     */
    function tableheader_open($colspan = 1, $align = null, $rowspan = 1) {
        $this->tablecell_open($colspan, $align, $rowspan);
    }

    /**
     * Alias for tablecell_close
     */
    function tableheader_close() {
        $this->tablecell_close();
    }

    /**
     * Add CRLF newline at the end of one line
     */
    function tablerow_close() {
        if(!$this->_doOutput()) return;
        $this->doc .= "\r\n";
    }

    /**
     * Outputs cell content
     *
     * @param string $text
     */
    function cdata($text) {
        if(!$this->_doOutput()) return;
        if($text === '') return;

        $this->doc .= str_replace('"', '""', $text);
    }


    #region overrides using cdata for output

    function internallink($link, $title = null) {
        if(is_null($title) or is_array($title) or $title == '') {
            $title = $this->_simpleTitle($link);
        }
        $this->cdata($title);
    }

    function externallink($link, $title = null) {
        if(is_null($title) or is_array($title) or $title == '') {
            $title = $link;
        }
        $this->cdata($title);
    }

    function emaillink($address, $name = null) {
        $this->cdata($address);
    }

    function plugin($name, $args, $state = '', $match = '') {
        if(substr($name,0, 7) == 'struct_') {
            parent::plugin($name, $args, $state, $match);
        } else {
            $this->cdata($match);
        }
    }

    function acronym($acronym) {
        $this->cdata($acronym);
    }

    function code($text, $lang = null, $file = null) {
        $this->cdata($text);
    }

    function header($text, $level, $pos) {
        $this->cdata($text);
    }

    function linebreak() {
        $this->cdata("\r\n");
    }

    function unformatted($text) {
        $this->cdata($text);
    }

    function php($text) {
        $this->cdata($text);
    }

    function phpblock($text) {
        $this->cdata($text);
    }

    function html($text) {
        $this->cdata($text);
    }

    function htmlblock($text) {
        $this->cdata($text);
    }

    function preformatted($text) {
        $this->cdata($text);
    }

    function file($text, $lang = null, $file = null) {
        $this->cdata($text);
    }

    function smiley($smiley) {
        $this->cdata($smiley);
    }

    function entity($entity) {
        $this->cdata($entity);
    }

    function multiplyentity($x, $y) {
        $this->cdata($x . 'x' . $y);
    }

    function locallink($hash, $name = null) {
        if(is_null($name) or is_array($name) or $name == '') {
            $name = $hash;
        }
        $this->cdata($name);
    }

    function interwikilink($link, $title = null, $wikiName, $wikiUri) {
        if(is_null($title) or is_array($title) or $title == '') {
            $title = $wikiName . '>' . $link;
        }
        $this->cdata($title);
    }

    function filelink($link, $title = null) {
        if(is_null($title) or is_array($title) or $title == '') {
            $title = $link;
        }
        $this->cdata($title);
    }

    function windowssharelink($link, $title = null) {
        if(is_null($title) or is_array($title) or $title == '') {
            $title = $link;
        }
        $this->cdata($title);
    }

    function internalmedia($src, $title = null, $align = null, $width = null,
                           $height = null, $cache = null, $linking = null) {
        $this->cdata($src);
    }

    function externalmedia($src, $title = null, $align = null, $width = null,
                           $height = null, $cache = null, $linking = null) {
        $this->cdata($src);
    }

    function internalmedialink($src, $title = null, $align = null,
                               $width = null, $height = null, $cache = null) {
        $this->cdata($src);
    }

    function externalmedialink($src, $title = null, $align = null,
                               $width = null, $height = null, $cache = null) {
        $this->cdata($src);
    }

    #endregion
}