xref: /plugin/siteexport/action/aggregate.php (revision cb07d9f3ef39ecd308f5495ed31d7d3946cebe0e)
1fd385364SGerry Weißbach<?php
2fd385364SGerry Weißbach/**
3fd385364SGerry Weißbach * Site Export Plugin
4fd385364SGerry Weißbach *
5fd385364SGerry Weißbach * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6fd385364SGerry Weißbach * @author     i-net software <tools@inetsoftware.de>
7fd385364SGerry Weißbach * @author     Gerry Weissbach <gweissbach@inetsoftware.de>
8fd385364SGerry Weißbach */
9fd385364SGerry Weißbach
10fd385364SGerry Weißbach// must be run within Dokuwiki
11a8c17ab5Si-net /// softwareif (!defined('DOKU_INC')) define('DOKU_INC', /** @scrutinizer ignore-type */ realpath(dirname(__FILE__) . '/../../') . '/');
12fd385364SGerry Weißbachif (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');
13fd385364SGerry Weißbachrequire_once(DOKU_PLUGIN . 'action.php');
14fd385364SGerry Weißbach
15fd385364SGerry Weißbachclass action_plugin_siteexport_aggregate extends DokuWiki_Action_Plugin {
16fd385364SGerry Weißbach
17fd385364SGerry Weißbach    /**
18fd385364SGerry Weißbach     * Register Plugin in DW
19fd385364SGerry Weißbach     **/
203f2e6413SGerry Weißbach    public function register(Doku_Event_Handler $controller) {
21fd385364SGerry Weißbach        $controller->register_hook('TPL_ACT_RENDER', 'BEFORE',  $this, 'siteexport_aggregate');
22fd385364SGerry Weißbach        $controller->register_hook('TOOLBAR_DEFINE', 'AFTER', $this, 'siteexport_aggregate_button', array ());
23fd385364SGerry Weißbach    }
24fd385364SGerry Weißbach
256292ca7aSGerry Weißbach    private function prefixStart($entry) {
266292ca7aSGerry Weißbach        return noNS($namespace) == $conf['start'] ? $namespace : $namespace . ':' . $conf['start'];
276292ca7aSGerry Weißbach    }
286292ca7aSGerry Weißbach
29a8c17ab5Si-net /// software    public function siteexport_aggregate(Doku_Event &$event)
305472512bSGerry Weißbach    {
31f6138195SGerry Weißbach        global $ID, $INFO, $conf, $INPUT;
325472512bSGerry Weißbach
3370ed105dSGerry Weißbach        // Aggregate only if
345f9e6101SGerry Weißbach        // (1) this page really has an aggregator and we did submit a request to do so
3570ed105dSGerry Weißbach        // (2) this page really has an aggregator and we export as PDF
36f6138195SGerry Weißbach        if ( !( (!empty($INFO['meta']['siteexport']) && $INFO['meta']['siteexport']['hasaggregator'] == true) && ( $INPUT->has( 'siteexport_aggregate' ) || $conf['renderer_xhtml'] == 'siteexport_pdf' ) ) ) { return true; }
375472512bSGerry Weißbach
386292ca7aSGerry Weißbach        $exportBase = $INPUT->str('baseID');
396292ca7aSGerry Weißbach        $namespaces = empty($exportBase) ? $INFO['meta']['siteexport']['baseID'] : getNs($exportBase);
406292ca7aSGerry Weißbach        $namespaces = explode('|', $namespaces);
416292ca7aSGerry Weißbach        $namespaces = array_map('cleanID', $namespaces);
426292ca7aSGerry Weißbach        $namespace = $exportBase = $namespaces[0];
4370ed105dSGerry Weißbach
445472512bSGerry Weißbach        $functions = plugin_load('helper', 'siteexport');
456292ca7aSGerry Weißbach        $values = $functions->__getOrderedListOfPagesForID($namespaces, $exportBase);
46*cb07d9f3SGerry Weißbach/*
47*cb07d9f3SGerry Weißbach        print '<pre>' . print_r($namespaces, 1) . '</pre>';
48*cb07d9f3SGerry Weißbach        print '<pre>' . print_r($values, 1) . '</pre>';
49*cb07d9f3SGerry Weißbach        exit(0);
50*cb07d9f3SGerry Weißbach//*/
5102184f7eSGerry Weißbach        // If no base given, take the first one from the ordered list.
5270ed105dSGerry Weißbach        if ( empty($exportBase) ) {
5313c50aa6SGerry Weißbach            // Reset to latest element
5413c50aa6SGerry Weißbach            list($exportBase) = reset( $values );
5502184f7eSGerry Weißbach        }
5602184f7eSGerry Weißbach
5702184f7eSGerry Weißbach        // If only the one file should be exported, strip it down.
58f6138195SGerry Weißbach        if ( $INPUT->bool('exportSelectedVersionOnly' ) ) {
5902184f7eSGerry Weißbach            // Strip down values
606292ca7aSGerry Weißbach            $lookupNS = array_map(array($this, 'prefixStart'), $namespaces);
61f6138195SGerry Weißbach            if ( $INPUT->has( 'mergecompare_start' ) && $INPUT->has( 'mergecompare_end' ) ) {
62c8d56c5cSGerry Weißbach                    $values = $functions->__getOrderedListOfPagesForStartEnd($lookupNS, $INPUT->int( 'mergecompare_start' ), $INPUT->int( 'mergecompare_end', PHP_INT_MAX ) );
63c66aa19aSGerry Weißbach            } else {
648ef92d7aSGerry Weißbach                $values = $functions->__getOrderedListOfPagesForID($lookupNS, $exportBase);
6502184f7eSGerry Weißbach                $values = array(end( $values )); // the list above has the $exportBase element at the very end
6670ed105dSGerry Weißbach            }
67c66aa19aSGerry Weißbach        }
685472512bSGerry Weißbach
69894bc325SGerry Weißbach        $includeSelected = $INPUT->str('includeSelectedVersion', 'true', true ) === 'true';
70894bc325SGerry Weißbach        if( !$includeSelected && count( $values ) > 1 ) {
71f6138195SGerry Weißbach            array_pop( $values ); // Remove last entry which is the selected version, but only if more than one entry exists
72f6138195SGerry Weißbach        }
73f6138195SGerry Weißbach
7487c0291bSGerry Weißbach        $originalID = (string) $ID;
755472512bSGerry Weißbach
765472512bSGerry Weißbach        // Generate a TOC that can be exported
77a310139eSGerry Weißbach        $TOC = "<toc merge mergeheader";
78a310139eSGerry Weißbach
79a310139eSGerry Weißbach        // add a mergehint, or better remove it if not required
80a310139eSGerry Weißbach        if( $INPUT->bool('mergehint', true, true ) ) {
81a310139eSGerry Weißbach            $TOC .= " mergehint";
82a310139eSGerry Weißbach        }
83a310139eSGerry Weißbach
84a310139eSGerry Weißbach        $TOC .= ">\n";
855472512bSGerry Weißbach        $thema = array();
865472512bSGerry Weißbach        foreach( $values as $value ) {
87a8c17ab5Si-net /// software            list($id, $title) = $value;
885472512bSGerry Weißbach
895472512bSGerry Weißbach            $thema[] = p_get_metadata($id, 'thema', METADATA_RENDER_USING_SIMPLE_CACHE);
905472512bSGerry Weißbach            $TOC .= "  * [[{$id}|{$title}]]\n";
915472512bSGerry Weißbach        }
925472512bSGerry Weißbach
935472512bSGerry Weißbach        $TOC .= "</toc>";
945472512bSGerry Weißbach
955472512bSGerry Weißbach        // Only get first and last element
9680cfd8feSGerry Weißbach        $thema = array_reverse(array_unique(array(reset($thema), end($thema))));
975472512bSGerry Weißbach
9880cfd8feSGerry Weißbach        $meta = p_read_metadata($originalID);
9980cfd8feSGerry Weißbach        // Temporary ID for rendering a document.
10080cfd8feSGerry Weißbach        $ID = (string) cleanID($originalID . '-toc-' . implode('-', array_filter($thema)));
1015472512bSGerry Weißbach
1025472512bSGerry Weißbach        $meta['current']['thema'] = implode(' - ', array_filter($thema));
10380cfd8feSGerry Weißbach        p_save_metadata($originalID, $meta);
1045472512bSGerry Weißbach        p_save_metadata($ID, $meta);
1055472512bSGerry Weißbach
10623be581eSGerry Weißbach        if (empty($TOC)) { return true; }
1076792d0cfSGerry Weißbach        $event->preventDefault();
108fd385364SGerry Weißbach
10923be581eSGerry Weißbach        $html = p_render('xhtml', p_get_instructions($TOC), $INFO);
1106792d0cfSGerry Weißbach        if ($INFO['prependTOC']) $html = tpl_toc(true) . $html;
1116792d0cfSGerry Weißbach
112a8c17ab5Si-net /// software        if (@unlink(metaFN($ID, '.meta')) === false) {
1132b035b08Si-net /// software            dbglog("Could not delete old meta file", metaFN($ID, '.meta'), 1 );
114a8c17ab5Si-net /// software        }
1155472512bSGerry Weißbach
11687c0291bSGerry Weißbach        $ID = (string) $originalID;
1175472512bSGerry Weißbach        echo $html;
11823be581eSGerry Weißbach        return true;
119fd385364SGerry Weißbach    }
120fd385364SGerry Weißbach
121fd385364SGerry Weißbach    /**
122fd385364SGerry Weißbach     * Inserts a toolbar button
123fd385364SGerry Weißbach     */
124a8c17ab5Si-net /// software    public function siteexport_aggregate_button(& $event, $param) {
125fd385364SGerry Weißbach        $event->data[] = array (
126fd385364SGerry Weißbach            'type' => 'mediapopup',
127fd385364SGerry Weißbach            'title' => $this->getLang('toolbarButton'),
128fd385364SGerry Weißbach            'icon' => '../../plugins/siteexport/images/toolbar.png',
129b325f6faSGerry Weißbach            'url' => 'lib/plugins/siteexport/exe/siteexportmanager.php?ns=',
130fd385364SGerry Weißbach            'options' => 'width=750,height=500,left=20,top=20,scrollbars=yes,resizable=yes',
131fd385364SGerry Weißbach            'block' => false,
132fd385364SGerry Weißbach        );
133fd385364SGerry Weißbach    }
134fd385364SGerry Weißbach}
135