xref: /plugin/siteexport/helper.php (revision 0f42821782a9fcc483e0e80008f5e0982ff86184) 
1<?php
2/**
3 * Translation Plugin: Simple multilanguage plugin
4 *
5 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author     i-net software <tools@inetsoftware.de>
7 * @author     Gerry Weissbach <gweissbach@inetsoftware.de>
8 */
9
10// must be run within Dokuwiki
11if(!defined('DOKU_INC')) die();
12
13
14class helper_plugin_siteexport_page_remove {
15    private $newerThanPage;
16
17    function __construct($newerThanPage) {
18            $this->newerThanPage = $newerThanPage;
19    }
20
21    function _page_remove($elem) {
22    	return $elem[2] >= $this->newerThanPage;
23    }
24}
25
26class helper_plugin_siteexport extends DokuWiki_Plugin {
27
28	/**
29	 * for backward compatability
30	 * @see inc/DokuWiki_Plugin#getInfo()
31	 */
32    function getInfo(){
33        if ( method_exists(parent, 'getInfo')) {
34            $info = parent::getInfo();
35        }
36        return is_array($info) ? $info : confToHash(dirname(__FILE__).'/plugin.info.txt');
37    }
38
39    /*
40     * return all the templates that this wiki has
41     */
42	function __getTemplates() {
43
44		// populate $this->_choices with a list of directories
45		$list = array();
46
47		$_dir = DOKU_INC . 'lib/tpl/';
48		$_pattern = '/^[\w-]+$/';
49		if ($dh = @opendir($_dir)) {
50			while (false !== ($entry = readdir($dh))) {
51				if ($entry == '.' || $entry == '..') continue;
52				if ($entry == '.' || $entry == '..') continue;
53				if ($_pattern && !preg_match($_pattern,$entry)) continue;
54
55				$file = (is_link($_dir.$entry)) ? readlink($_dir.$entry) : $entry;
56				if (is_dir($_dir.$file)) $list[] = $entry;
57			}
58			closedir($dh);
59		}
60
61
62		sort($list);
63		return $list;
64	}
65
66	/*
67	 * Return array list of plugins that exist
68	 */
69	function __getPluginList() {
70	    global $plugin_controller;
71
72	    $allPlugins = array();
73	    foreach($plugin_controller->getList(null,true) as $plugin ) { // All plugins
74	    	// check for CSS or JS
75	    	if ( !file_exists(DOKU_PLUGIN."$plugin/script.js") && !file_exists(DOKU_PLUGIN."$plugin/style.css") && !file_exists(DOKU_PLUGIN."$plugin/print.css") ) { continue; }
76	    	$allPlugins[] = $plugin;
77	    }
78
79    	return array($allPlugins, $plugin_controller->getList());
80	}
81
82    private function _page_sort($a, $b)
83    {
84	    if ( $a[2] == $b[2] ) {
85		    return 0;
86	    }
87
88	    return $a[2] > $b[2] ? -1 : 1;
89    }
90
91    function __getOrderedListOfPagesForID($ID, $newerThanPage=null)
92	{
93		global $conf;
94		require_once(dirname(__FILE__)."/inc/functions.php");
95		$functions = new siteexport_functions(false);
96
97        $sites = $values = array();
98        $page = null;
99		search($sites, $conf['datadir'], 'search_allpages', array(), $functions->getNamespaceFromID($ID, $page));
100        foreach( $sites as $site ) {
101
102        	if ( $ID == $site['id'] ) continue;
103        	$sortIdentifier = intval(p_get_metadata($site['id'], 'mergecompare'));
104            array_push($values, array(':' . $site['id'], $functions->getSiteTitle($site['id']), $sortIdentifier));
105        }
106
107        if ( $newerThanPage != null ) {
108
109        	// filter using the newerThanPage indicator
110            $sortIdentifier = intval(p_get_metadata($newerThanPage, 'mergecompare'));
111	        $values = array_filter($values, array(new helper_plugin_siteexport_page_remove($sortIdentifier), '_page_remove'));
112        }
113
114        usort($values, array($this, '_page_sort'));
115
116        return $values;
117	}
118
119	function __siteexport_addpage() {
120
121        global $ID, $conf;
122
123	    $templateSwitching = false;
124	    $pdfExport = false;
125	    $usenumberedheading = false;
126	    $cronEnabled = false;
127	    $translation = null;
128	    $translationAvailable = false;
129	    $usenumberedheading = true;
130
131        if ( $functions=& plugin_load('preload', 'siteexport') && $functions->__create_preload_function() ) {
132            $templateSwitching = true;
133        }
134
135        if ( $functions =& plugin_load('action', 'dw2pdf' ) ) {
136            $pdfExport = true;
137        }
138
139        // if ( $functions =& plugin_load('renderer', 'nodetailsxhtml' ) ) {
140        // }
141
142        if ( $functions =& plugin_load('cron', 'siteexport' ) ) {
143            $cronEnabled = $functions->canWriteSettings();
144        }
145
146        if ( $translation =& plugin_load('helper', 'translation' ) ) {
147            $translationAvailable = true;
148        }
149
150        $regenerateScript = '';
151        print $this->locale_xhtml(( defined('DOKU_SITEEXPORT_MANAGER') ? 'manager' : '') . 'intro');
152
153        $form = new Doku_Form('siteexport', null, 'post');
154        $form->startFieldset( $this->getLang('startingNamespace') );
155
156        $form->addElement(form_makeTextField('ns', $ID, $this->getLang('ns') . ':', 'ns'));
157        $form->addElement(form_makeTag('br'));
158        $form->addElement(form_makeTextField('ens', $ID, $this->getLang('ens') . ':', 'ens'));
159
160        $form->addElement(form_makeTag('br'));
161        $form->addElement(form_makeListboxField('depthType', array( "0.0" => $this->getLang('depth.pageOnly'), "1.0" => $this->getLang('depth.allSubNameSpaces'), "2.0" => $this->getLang('depth.specifiedDepth') ), (empty($_REQUEST['depthType']) ? $this->getLang('depth.allSubNameSpaces') : $_REQUEST['depthType']), $this->getLang('depthType') . ':', 'depthType', null, array_merge(array('class' => 'edit'))));
162
163        $form->addElement(form_makeTag('br'));
164        $form->addElement(form_makeOpenTag("div", array('style' => 'display:' . ($_REQUEST['depthType'] == "2" ? "block" : "none") . ';', 'id' => 'depthContainer')));
165        $form->addElement(form_makeTextField('depth', $this->getConf('depth'), $this->getLang('depth') . ':', 'depth'));
166        $form->addElement(form_makeCloseTag("div"));
167
168        $form->addElement(form_makeTag('br'));
169        $form->addElement(form_makeOpenTag("div", array('style' => 'display:none;', 'id' => 'depthContainer')));
170        $form->addElement(form_makeCheckboxField('exportLinkedPages', 1, $this->getLang('exportLinkedPages') . ':', 'exportLinkedPages'));
171        $form->addElement(form_makeCloseTag("div"));
172
173        $form->endFieldset();
174        $form->addElement(form_makeTag('br'));
175
176        $form->startFieldset( $this->getLang('selectYourOptions') );
177        $form->addElement(form_makeCheckboxField('absolutePath', 1, $this->getLang('absolutePath') . ':', 'absolutePath'));
178        $form->addElement(form_makeTag('br'));
179        // The parameter needs lowercase
180        $form->addElement(form_makeCheckboxField('exportbody', 1, $this->getLang('exportBody') . ':', 'exportbody'));
181        $form->addElement(form_makeTag('br'));
182        $form->addElement(form_makeCheckboxField('disableCache', 1, $this->getLang('disableCache') . ':', 'disableCache'));
183        $form->addElement(form_makeTag('br'));
184        $form->addElement(form_makeCheckboxField('addParams', 1, $this->getLang('addParams') . ':', 'addParams', null, array_merge(array('checked' => ($conf['userewrite'] != 1 ? 'checked' : '' ) ))));
185        $form->addElement(form_makeTag('br'));
186        $form->addElement(form_makeTag('br'));
187        $form->addElement(form_makeListboxField('renderer', array_merge(array('','xhtml'), plugin_list('renderer')), '', $this->getLang('renderer') . ':', 'renderer', null, array_merge(array('class' => 'edit'))));
188
189        $form->addElement(form_makeTag('br'));
190        if ( $templateSwitching ) {
191            $form->addElement(form_makeListboxField('template', $this->__getTemplates(), $conf['template'], $this->getLang('template') . ':', 'template', null, array_merge(array('class' => 'edit'))));
192            $form->addElement(form_makeTag('br'));
193        } else
194        {
195            $form->addElement(form_makeTag('br'));
196            $form->addElement(form_makeOpenTag('p', array('style' => 'color: #a00;' )));
197            $form->addElement('Can\'t create preload file in \'inc\' directory. Template switching is not available. Plugin disabling is not available.');
198            $form->addElement(form_makeCloseTag('p'));
199        }
200
201        $form->addElement(form_makeTag('br'));
202        $form->addElement(form_makeCheckboxField('pdfExport', 1, $this->getLang('pdfExport') . ':', 'pdfExport', null, $pdfExport ? array() : array_merge(array('disabled' => 'disabled')) ));
203        if ( !$pdfExport ) {
204            $form->addElement(form_makeOpenTag('p', array('style' => 'color: #a00;' )));
205            $form->addElement('In order to use the PDF export, please ');
206            $form->addElement(form_makeOpenTag('a', array('href' => 'http://www.dokuwiki.org/plugin:dw2pdf', 'alt' => 'install plugin', 'target' => '_blank')));
207            $form->addElement('install the dw2pdf plugin.');
208            $form->addElement(form_makeCloseTag('a'));
209            $form->addElement(form_makeCloseTag('p'));
210        }
211
212        $form->addElement(form_makeTag('br'));
213        $form->addElement(form_makeCheckboxField('usenumberedheading', 1, $this->getLang('usenumberedheading') . ':', 'usenumberedheading', null, $usenumberedheading && $pdfExport ? array() : array_merge(array('disabled' => 'disabled')) ));
214        $form->addElement(form_makeTag('br'));
215
216        if ( !$usenumberedheading ) {
217            $form->addElement(form_makeOpenTag('p', array('style' => 'color: #a00;' )));
218            $form->addElement('In order to use numbered headings, please ');
219            $form->addElement(form_makeOpenTag('a', array('href' => 'http://www.dokuwiki.org/plugin:nodetailsxhtml', 'alt' => 'install plugin', 'target' => '_blank')));
220            $form->addElement('install the nodetailsxhtml plugin.');
221            $form->addElement(form_makeCloseTag('a'));
222            $form->addElement(form_makeCloseTag('p'));
223        }
224
225        $form->endFieldset();
226        $form->addElement(form_makeTag('br'));
227
228        $form->startFieldset( $this->getLang('helpCreationOptions') );
229        $form->addElement(form_makeCheckboxField('eclipseDocZip', 1, $this->getLang('eclipseDocZip') . ':', 'eclipseDocZip'));
230        $form->addElement(form_makeTag('br'));
231        $form->addElement(form_makeCheckboxField('JavaHelpDocZip', 1, $this->getLang('JavaHelpDocZip') . ':', 'JavaHelpDocZip'));
232        $form->addElement(form_makeTag('br'));
233        $form->addElement(form_makeCheckboxField('useTocFile', 1, $this->getLang('useTocFile') . ':', 'useTocFile'));
234        $form->addElement(form_makeTag('br'));
235        $form->addElement(form_makeCheckboxField('emptyTocElem', 1, $this->getLang('emptyTocElem') . ':', 'emptyTocElem'));
236        $form->addElement(form_makeTag('br'));
237        if ( !$translationAvailable ) {
238            $form->addElement(form_makeCheckboxField('TOCMapWithoutTranslation', 1, $this->getLang('TOCMapWithoutTranslation') . ':', 'TOCMapWithoutTranslation'));
239            $form->addElement(form_makeTag('br'));
240        } else {
241
242            if ( !is_array($trans) ) {
243                $trans = array( $trans );
244            }
245
246            $trans = array_unique(array_merge($trans, array( $conf['lang'] )));
247            $form->addElement(form_makeListboxField('defaultLang', $trans, $conf['lang'], $this->getLang('defaultLang') . ':', 'defaultLang'));
248            $form->addElement(form_makeTag('br'));
249        }
250        $form->endFieldset();
251        $form->addElement(form_makeTag('br'));
252
253        if ( $templateSwitching )
254        {
255            $form->startFieldset( $this->getLang('disablePluginsOption') );
256
257            $form->addElement(form_makeCheckboxField("disableall", 1, 'Disable All:', "disableall", 'forceVisible'));
258            $form->addElement(form_makeTag('br'));
259            $form->addElement(form_makeTag('br'));
260
261            list($allPlugins, $enabledPlugins) = $this->__getPluginList();
262            foreach ( $allPlugins as $plugin ) {
263                $form->addElement(form_makeCheckboxField("disableplugin[]", $plugin, $plugin . ':', "disableplugin_$plugin", null, (!in_array($plugin, $enabledPlugins) ? array('checked' => 'checked', 'disabled' => 'disabled') : array() )));
264                $form->addElement(form_makeTag('br'));
265            }
266
267            $form->endFieldset();
268            $form->addElement(form_makeTag('br'));
269        }
270
271        $form->startFieldset( $this->getLang('customOptions') );
272        $form->addElement(form_makeOpenTag('p'));
273        $form->addElement( $this->getLang('customOptionsDescription') );
274        $form->addElement(form_makeCloseTag('p'));
275
276        $form->addElement(form_makeOpenTag('ul', array('id' => 'siteexport__customActions')));
277        $form->addElement(form_makeCloseTag('ul'));
278        $form->addElement(form_makeTag('br', array('class'=>'clear')));
279        $form->addElement(form_makeButton('submit', 'addoption', $this->getLang('addCustomOption') , array('style' => 'float:right;') ));
280
281        $form->endFieldset();
282        $form->addElement(form_makeTag('br'));
283
284		if ( !defined('DOKU_SITEEXPORT_MANAGER') ) {
285
286
287	        $form->startFieldset( $this->getLang('startProcess') );
288	        $form->addElement(form_makeTextField('copyurl', "", $this->getLang('directDownloadLink') . ':', 'copyurl', null, array('readonly' => 'readonly') ));
289	        $form->addElement(form_makeTag('br'));
290	        $form->addElement(form_makeTextField('wgeturl', "", $this->getLang('wgetURLLink') . ':', 'wgeturl', null, array('readonly' => 'readonly') ));
291	        $form->addElement(form_makeTag('br'));
292	        $form->addElement(form_makeTextField('curlurl', "", $this->getLang('curlURLLink') . ':', 'curlurl', null, array('readonly' => 'readonly') ));
293	        $form->addElement(form_makeTag('br', array('class'=>'clear')));
294	        $form->addElement(form_makeButton('submit', 'siteexport', $this->getLang('start') , array('style' => 'float:right;')));
295	        $form->endFieldset();
296	        $form->addElement(form_makeTag('br'));
297
298	        $form->endFieldset();
299			$form->addElement(form_makeTag('br'));
300
301	        $form->startFieldset( $this->getLang('status') );
302	        $form->addElement(form_makeOpenTag('span', array('id' => 'siteexport__out')));
303
304	        $form->addElement(form_makeCloseTag('span'));
305	        $form->addElement(form_makeOpenTag('span', array('class' => 'siteexport__throbber')));
306	        $form->addElement(form_makeTag('img', array('src' => DOKU_BASE.'lib/images/loading.gif', 'id' => 'siteexport__throbber')));
307	        $form->addElement(form_makeCloseTag('span'));
308	        $form->endFieldset();
309	        $form->addElement(form_makeTag('br'));
310
311	        if ( $cronEnabled )
312	        {
313	            $form->startFieldset( $this->getLang('cronSaveProcess') );
314	            $form->addElement(form_makeOpenTag('p'));
315	            $form->addElement( $this->getLang('cronDescription') );
316	            $form->addElement(form_makeCloseTag('p'));
317
318	            $form->addElement(form_makeCheckboxField("cronOverwriteExisting", 1, $this->getLang('canOverwriteExisting'), "cronOverwriteExisting"));
319	            $form->addElement(form_makeTag('br', array('class'=>'clear')));
320	            $form->addElement(form_makeButton('submit', 'cronDeleteAction', $this->getLang('cronDeleteAction') , array('id' => 'cronDeleteAction', 'style' => 'float:left;display:none') ));
321	            $form->addElement(form_makeButton('submit', 'cronSaveAction', $this->getLang('cronSaveAction') , array('id' => 'cronSaveAction', 'style' => 'float:right;') ));
322	            $form->addElement(form_makeTag('br', array('class'=>'clear')));
323
324	            $form->addElement(form_makeOpenTag('a', array('href' => '#cronactions', 'alt' => 'show cron jobs', 'id' => 'showcronjobs', 'target' => '_blank', 'style' => 'float:right;')));
325	            $form->addElement('show all cron jobs');
326	            $form->addElement(form_makeCloseTag('a'));
327	        }
328
329		} else {
330	        $form->startFieldset( $this->getLang('startProcess') );
331	        $form->addElement(form_makeButton('submit', 'siteexport', $this->getLang('useOptionsInEditor') , array('style' => 'width:100%;')));
332		}
333
334        $form->endFieldset();
335        $form->addElement(form_makeTag('br'));
336
337        $form->printForm();
338	}
339}
340