xref: /plugin/siteexport/inc/javahelp.php (revision 13326eab2a5080d71f21feceebde1b6c7efe3df5) 
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, 3);
50        $this->functions->debug->message("Translation-Root: {$translationRoot}", null, 3);
51        $this->functions->debug->message("HSFiles:", $translationHSFiles, 1);
52
53
54        $check = array();
55        $last_key = end(array_keys($translationHSFiles));
56
57        foreach( $translationHSFiles as $lang => $data )
58        {
59            // Prepare Translations
60            if ( !empty($lang) && !$this->functions->settings->TOCMapWithoutTranslation )
61            {
62                $toc->translation = &$this->translation;
63                $rootNode = cleanID($this->translation->tns . $lang) . ':';
64            } else {
65                $toc->translation = null;
66                $rootNode = '';
67            }
68
69            $tsRootPath = $hsPrename . '/' . $this->translationRootPath($translationRoot);
70            $this->functions->debug->message("Generating JavaHelpDocZip for language '$lang'", $tsRootPath, 3);
71
72            // Create toc and map for each lang
73            list($tocData, $mapData, $startPageID) = $toc->__getJavaHelpTOCXML($data, $tsRootPath);
74            $this->filewriter->__moveDataToZip($tocData, $tsRootPath . $lang . '/' . $this->tocName);
75            $this->filewriter->__moveDataToZip($mapData, $tsRootPath . $lang . '/' . $this->mapName);
76
77            // Create HS File
78            // array_shift($toc->getMapID($rootNode, &$check))
79            $HS = $this->getHSXML( $startPageID, $this->functions->getSiteTitle($rootNode), $lang, $tsRootPath );
80            $this->filewriter->__moveDataToZip($HS, $translationRoot . ( empty($lang) ? '' : '_' . $lang ) . '.hs');
81
82            // Default Lang
83            if ( $lang == $this->functions->settings->defaultLang || $lang == $last_key )
84            {
85                $this->functions->debug->message("Writing Default HS File for Language:", $lang, 3);
86                $this->filewriter->__moveDataToZip($HS, $translationRoot . '.hs');
87                $last_key = null;
88            }
89        }
90    }
91
92    private function translationRootPath($translationRoot = '')
93    {
94        if ( !empty($translationRoot) )
95        {
96            return $translationRoot . '/';
97        }
98
99        return $translationRoot;
100    }
101
102    private function getHSXML($rootID, $title, $lang='', $translationRoot='')
103    {
104        if ( empty($lang) && substr($translationRoot, -1) == '/') {
105            $translationRoot = substr($translationRoot, 0, -1);
106        }
107
108        return <<<OUTPUT
109<?xml version='1.0' encoding='ISO-8859-1' ?>
110<helpset version="1.0">
111
112	<title>{$title}</title>
113    <maps>
114        <homeID>{$rootID}</homeID>
115        <mapref location="{$translationRoot}{$lang}/{$this->mapName}"/>
116     </maps>
117
118    <view>
119        <name>TOC</name>
120        <label>{$this->functions->getLang('toc')}</label>
121        <type>javax.help.TOCView</type>
122        <data>{$translationRoot}{$lang}/{$this->tocName}</data>
123    </view>
124
125    <view>
126        <name>Search</name>
127        <label>{$this->functions->getLang('search')}</label>
128        <type>javax.help.SearchView</type>
129        <data engine="com.sun.java.help.search.DefaultSearchEngine">
130            {$translationRoot}{$lang}/JavaHelpSearch
131        </data>
132    </view>
133
134    <impl>
135        <helpsetregistry helpbrokerclass="javax.help.DefaultHelpBroker" />
136        <viewerregistry viewertype="text/html" viewerclass="com.inet.html.InetHtmlEditorKit" />
137    </impl>
138</helpset>
139OUTPUT;
140    }
141}