xref: /plugin/siteexport/action/aggregate.php (revision 3e21110ad54276195c129364af455184127d6cfe)
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
2539abe1ceSGerry Weißbach    private function prefixStart($namespace) {
2639abe1ceSGerry Weißbach        global $conf;
2739abe1ceSGerry Weißbach        return getNS($namespace) . ':' . $conf['start'];
286292ca7aSGerry Weißbach    }
296292ca7aSGerry Weißbach
30a8c17ab5Si-net /// software    public function siteexport_aggregate(Doku_Event &$event)
315472512bSGerry Weißbach    {
32f6138195SGerry Weißbach        global $ID, $INFO, $conf, $INPUT;
335472512bSGerry Weißbach
3470ed105dSGerry Weißbach        // Aggregate only if
355f9e6101SGerry Weißbach        // (1) this page really has an aggregator and we did submit a request to do so
3670ed105dSGerry Weißbach        // (2) this page really has an aggregator and we export as PDF
37f6138195SGerry Weißbach        if ( !( (!empty($INFO['meta']['siteexport']) && $INFO['meta']['siteexport']['hasaggregator'] == true) && ( $INPUT->has( 'siteexport_aggregate' ) || $conf['renderer_xhtml'] == 'siteexport_pdf' ) ) ) { return true; }
385472512bSGerry Weißbach
396292ca7aSGerry Weißbach        $exportBase = $INPUT->str('baseID');
406292ca7aSGerry Weißbach        $namespaces = empty($exportBase) ? $INFO['meta']['siteexport']['baseID'] : getNs($exportBase);
416292ca7aSGerry Weißbach        $namespaces = explode('|', $namespaces);
426292ca7aSGerry Weißbach        $namespaces = array_map('cleanID', $namespaces);
436292ca7aSGerry Weißbach        $namespace = $exportBase = $namespaces[0];
4470ed105dSGerry Weißbach
455472512bSGerry Weißbach        $functions = plugin_load('helper', 'siteexport');
466292ca7aSGerry Weißbach        $values = $functions->__getOrderedListOfPagesForID($namespaces, $exportBase);
47cb07d9f3SGerry Weißbach/*
48cb07d9f3SGerry Weißbach        print '<pre>' . print_r($namespaces, 1) . '</pre>';
49cb07d9f3SGerry Weißbach        print '<pre>' . print_r($values, 1) . '</pre>';
50cb07d9f3SGerry Weißbach        exit(0);
51cb07d9f3SGerry Weißbach//*/
5202184f7eSGerry Weißbach        // If no base given, take the first one from the ordered list.
5370ed105dSGerry Weißbach        if ( empty($exportBase) ) {
5413c50aa6SGerry Weißbach            // Reset to latest element
5513c50aa6SGerry Weißbach            list($exportBase) = reset( $values );
5602184f7eSGerry Weißbach        }
5702184f7eSGerry Weißbach
5802184f7eSGerry Weißbach        // If only the one file should be exported, strip it down.
59f6138195SGerry Weißbach        if ( $INPUT->bool('exportSelectedVersionOnly' ) ) {
6002184f7eSGerry Weißbach            // Strip down values
616292ca7aSGerry Weißbach            $lookupNS = array_map(array($this, 'prefixStart'), $namespaces);
62f6138195SGerry Weißbach            if ( $INPUT->has( 'mergecompare_start' ) && $INPUT->has( 'mergecompare_end' ) ) {
63c8d56c5cSGerry Weißbach                    $values = $functions->__getOrderedListOfPagesForStartEnd($lookupNS, $INPUT->int( 'mergecompare_start' ), $INPUT->int( 'mergecompare_end', PHP_INT_MAX ) );
64c66aa19aSGerry Weißbach            } else {
658ef92d7aSGerry Weißbach                $values = $functions->__getOrderedListOfPagesForID($lookupNS, $exportBase);
6670ed105dSGerry Weißbach            }
67c66aa19aSGerry Weißbach        }
685472512bSGerry Weißbach
69894bc325SGerry Weißbach        $includeSelected = $INPUT->str('includeSelectedVersion', 'true', true ) === 'true';
7000d64dfbSGerry Weißbach        if( !$includeSelected ) {
7100d64dfbSGerry Weißbach
7200d64dfbSGerry Weißbach            // Remove entries that are  from the selectes version, but only if more than these entries exists
7300d64dfbSGerry Weißbach            $baseVersion = intval(p_get_metadata($exportBase, 'mergecompare')) +1;
7400d64dfbSGerry Weißbach            $checkValues = array_filter($values, array(new helper_plugin_siteexport_page_remove($baseVersion), '_page_remove'));
7500d64dfbSGerry Weißbach            if ( count($checkValues) > 0 ) {
7600d64dfbSGerry Weißbach                $values = $checkValues;
7700d64dfbSGerry Weißbach            }
78f6138195SGerry Weißbach        }
79f6138195SGerry Weißbach
8087c0291bSGerry Weißbach        $originalID = (string) $ID;
815472512bSGerry Weißbach
825472512bSGerry Weißbach        // Generate a TOC that can be exported
83a310139eSGerry Weißbach        $TOC = "<toc merge mergeheader";
84a310139eSGerry Weißbach
85a310139eSGerry Weißbach        // add a mergehint, or better remove it if not required
86a310139eSGerry Weißbach        if( $INPUT->bool('mergehint', true, true ) ) {
87a310139eSGerry Weißbach            $TOC .= " mergehint";
88a310139eSGerry Weißbach        }
89a310139eSGerry Weißbach
90a310139eSGerry Weißbach        $TOC .= ">\n";
915472512bSGerry Weißbach        $thema = array();
925472512bSGerry Weißbach        foreach( $values as $value ) {
93a8c17ab5Si-net /// software            list($id, $title) = $value;
945472512bSGerry Weißbach
955472512bSGerry Weißbach            $thema[] = p_get_metadata($id, 'thema', METADATA_RENDER_USING_SIMPLE_CACHE);
965472512bSGerry Weißbach            $TOC .= "  * [[{$id}|{$title}]]\n";
975472512bSGerry Weißbach        }
985472512bSGerry Weißbach
995472512bSGerry Weißbach        $TOC .= "</toc>";
1005472512bSGerry Weißbach
1015472512bSGerry Weißbach        // Only get first and last element
10280cfd8feSGerry Weißbach        $thema = array_reverse(array_unique(array(reset($thema), end($thema))));
1035472512bSGerry Weißbach
10480cfd8feSGerry Weißbach        $meta = p_read_metadata($originalID);
10580cfd8feSGerry Weißbach        // Temporary ID for rendering a document.
10680cfd8feSGerry Weißbach        $ID = (string) cleanID($originalID . '-toc-' . implode('-', array_filter($thema)));
1075472512bSGerry Weißbach
1085472512bSGerry Weißbach        $meta['current']['thema'] = implode(' - ', array_filter($thema));
10980cfd8feSGerry Weißbach        p_save_metadata($originalID, $meta);
1105472512bSGerry Weißbach        p_save_metadata($ID, $meta);
1115472512bSGerry Weißbach
11223be581eSGerry Weißbach        if (empty($TOC)) { return true; }
1136792d0cfSGerry Weißbach        $event->preventDefault();
114fd385364SGerry Weißbach
115*3e21110aSGerry Weißbach        $renderer = $INPUT->str('renderer', $conf['renderer_xhtml'], true);
116*3e21110aSGerry Weißbach        $INPUT->set('do', 'export_' . $renderer);
117*3e21110aSGerry Weißbach
118*3e21110aSGerry Weißbach        $html = p_render($renderer, p_get_instructions($TOC), $INFO);
1196792d0cfSGerry Weißbach        if ($INFO['prependTOC']) $html = tpl_toc(true) . $html;
1206792d0cfSGerry Weißbach
121a8c17ab5Si-net /// software        if (@unlink(metaFN($ID, '.meta')) === false) {
1222b035b08Si-net /// software            dbglog("Could not delete old meta file", metaFN($ID, '.meta'), 1 );
123a8c17ab5Si-net /// software        }
1245472512bSGerry Weißbach
12587c0291bSGerry Weißbach        $ID = (string) $originalID;
1265472512bSGerry Weißbach        echo $html;
127*3e21110aSGerry Weißbach
12823be581eSGerry Weißbach        return true;
129fd385364SGerry Weißbach    }
130fd385364SGerry Weißbach
131fd385364SGerry Weißbach    /**
132fd385364SGerry Weißbach     * Inserts a toolbar button
133fd385364SGerry Weißbach     */
134a8c17ab5Si-net /// software    public function siteexport_aggregate_button(& $event, $param) {
135fd385364SGerry Weißbach        $event->data[] = array (
136fd385364SGerry Weißbach            'type' => 'mediapopup',
137fd385364SGerry Weißbach            'title' => $this->getLang('toolbarButton'),
138fd385364SGerry Weißbach            'icon' => '../../plugins/siteexport/images/toolbar.png',
139b325f6faSGerry Weißbach            'url' => 'lib/plugins/siteexport/exe/siteexportmanager.php?ns=',
140fd385364SGerry Weißbach            'options' => 'width=750,height=500,left=20,top=20,scrollbars=yes,resizable=yes',
141fd385364SGerry Weißbach            'block' => false,
142fd385364SGerry Weißbach        );
143fd385364SGerry Weißbach    }
144fd385364SGerry Weißbach}
145