xref: /plugin/siteexport/inc/javahelp.php (revision 5b6dc6f25907626264cadbaddf4e355be0c0e47b) 
1<?php
2
3if(!defined('DOKU_PLUGIN')) die('meh');
4require_once(DOKU_PLUGIN.'siteexport/inc/toc.php');
5
6class siteexport_javahelp
7{
8    private $functions = null;
9    private $translation = null;
10    private $filewriter = null;
11
12    private $tocName = 'toc.xml';
13    private $mapName = 'map.xml';
14
15    public function siteexport_javahelp($functions, $filewriter)
16    {
17        $this->functions = $functions;
18        $this->filewriter = $filewriter;
19        $this->translation = & plugin_load('helper', 'translation' );
20    }
21
22    public function createTOCFiles($data)
23    {
24        global $conf;
25
26        // Split Tree for translation
27        $translationHSFiles = array();
28
29        for ($i=0; $i<count($data); $i++)
30        {
31            $lang = '';
32            if ( $this->translation )
33            {
34                $this->translation->tns = $this->translation->setupTNS($data[$i]['id']);
35                $lang = $this->translation->getLangPart($data[$i]['id']);
36            }
37
38            // get all the relative URLs
39            $translationHSFiles[$lang][] = $data[$i];
40        }
41
42        $toc = new siteexport_toc($this->functions);
43        if ( $this->translation )
44        {
45            $translationRoot = curNS($this->translation->tns);
46        }
47
48        $hsPrename = curNS(getNS($this->translation->tns));
49        $this->functions->debug->message("HelpSetPre-Name: {$hsPrename}", null, 1);
50        $this->functions->debug->message("Translation-Root: {$translationRoot}", null, 1);
51
52        $check = array();
53        $last_key = end(array_keys($translationHSFiles));
54        foreach( $translationHSFiles as $lang => $data )
55        {
56            // Prepare Translations
57            if ( !empty($lang) && !$functions->settings->TOCMapWithoutTranslation )
58            {
59                $toc->translation = &$this->translation;
60                $rootNode = cleanID($this->translation->tns . $lang) . ':';
61            } else {
62                $toc->translation = null;
63                $rootNode = '';
64            }
65
66            $tsRootPath = $hsPrename . '/' . $this->translationRootPath($translationRoot);
67
68            // Create toc and map for each lang
69            list($tocData, $mapData, $startPageID) = $toc->__getJavaHelpTOCXML($data, $tsRootPath);
70            $this->functions->debug->message("Generating JavaHelpDocZip for language '$lang'", null, 2);
71            $this->filewriter->__moveDataToZip($tocData, $tsRootPath . $lang . '/' . $this->tocName);
72            $this->filewriter->__moveDataToZip($mapData, $tsRootPath . $lang . '/' . $this->mapName);
73
74            // Create HS File
75            // array_shift($toc->getMapID($rootNode, &$check))
76            $HS = $this->getHSXML( $startPageID, $this->functions->getSiteTitle($rootNode), $lang, $tsRootPath );
77            $this->filewriter->__moveDataToZip($HS, $translationRoot . ( empty($lang) ? '' : '_' . $lang ) . '.hs');
78
79            // Default Lang
80            if ( $lang == $conf['lang'] || $lang == $last_key )
81            {
82                $this->filewriter->__moveDataToZip($HS, $translationRoot . '.hs');
83                $last_key = null;
84            }
85        }
86    }
87
88    private function translationRootPath($translationRoot = '')
89    {
90        if ( !empty($translationRoot) )
91        {
92            return $translationRoot . '/';
93        }
94
95        return $translationRoot;
96    }
97
98    private function getHSXML($rootID, $title, $lang='', $translationRoot='')
99    {
100        if ( empty($lang) && substr($translationRoot, -1) == '/') {
101            $translationRoot = substr($translationRoot, 0, -1);
102        }
103
104        return <<<OUTPUT
105<?xml version='1.0' encoding='ISO-8859-1' ?>
106<helpset version="1.0">
107
108	<title>{$title}</title>
109    <maps>
110        <homeID>{$rootID}</homeID>
111        <mapref location="{$translationRoot}{$lang}/{$this->mapName}"/>
112     </maps>
113
114    <view>
115        <name>TOC</name>
116        <label>{$this->functions->getLang('toc')}</label>
117        <type>javax.help.TOCView</type>
118        <data>{$translationRoot}{$lang}/{$this->tocName}</data>
119    </view>
120
121    <view>
122        <name>Search</name>
123        <label>{$this->functions->getLang('search')}</label>
124        <type>javax.help.SearchView</type>
125        <data engine="com.sun.java.help.search.DefaultSearchEngine">
126            {$translationRoot}{$lang}/JavaHelpSearch
127        </data>
128    </view>
129
130    <impl>
131        <helpsetregistry helpbrokerclass="javax.help.DefaultHelpBroker" />
132        <viewerregistry viewertype="text/html" viewerclass="com.inet.html.InetHtmlEditorKit" />
133    </impl>
134</helpset>
135OUTPUT;
136    }
137}