aboutsummaryrefslogtreecommitdiff
path: root/lib/elearning/Ilias3SaxParser.php
blob: 92d247dd2746696c22d96ce19b6671e6f218dd55 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
<?php
# Lifter002: TODO
# Lifter007: TODO
# Lifter003: TODO
# Lifter010: TODO
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2001 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program is free software; you can redistribute it and/or               |
    | modify it under the terms of the GNU General Public License                 |
    | as published by the Free Software Foundation; either version 2              |
    | of the License, or (at your option) any later version.                      |
    |                                                                             |
    | This program is distributed in the hope that it will be useful,             |
    | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
    | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
    | GNU General Public License for more details.                                |
    |                                                                             |
    | You should have received a copy of the GNU General Public License           |
    | along with this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/


/**
* Base class for sax-based expat parsing
* extended classes need to overwrite the method setHandlers and implement their own handler methods
* 
*
* @author Stefan Meyer <smeyer@databay>
*
* @package ilias-core
*/
class Ilias3SaxParser
{
    /**
     * XML-Content type 'file' or 'string'
     * If you choose file set the filename in constructor
     * If you choose 'String' call the constructor with no argument and use setXMLContent()
     * @var string
     * @access private
     */
    var $input_type = null;

    /**
     * XML-Content in case of content type 'string'

     * @var string 
     * @access private
     */
    var $xml_content = '';

    /**
     * ilias object
     * @var object ilias
     * @access private
     */
    var $ilias;

    /**
     * language object
     * @var object language
     * @access private
     */
    var $lng;

    /**
     * xml filename
     * @var filename
     * @access private
     */
    var $xml_file;

    /**
    * Constructor
    * setup ILIAS global object
    * @access   public
    */
    function __construct($a_xml_file = '')
    {
        global $ilias, $lng;

        if($a_xml_file)
        {
            $this->xml_file = $a_xml_file;
            $this->input_type = 'file';
        }
        
        $this->ilias = &$ilias;
        $this->lng = &$lng;
    }

    function setXMLContent($a_xml_content)
    {
        $this->xml_content = $a_xml_content;
        $this->input_type = 'string';
    }
    
    function getXMLContent()
    {
        return $this->xml_content;
    }

    function getInputType()
    {
        return $this->input_type;
    }

    /**
    * stores xml data in array
    * 
    * @access   private
    */
    function startParsing()
    {
        $xml_parser = $this->createParser();
        $this->setOptions($xml_parser);
        $this->setHandlers($xml_parser);

        switch($this->getInputType())
        {
            case 'file':
                $fp = $this->openXMLFile();
                $this->parse($xml_parser,$fp);
                break;

            case 'string':
                $this->parse($xml_parser);
                break;

            default:
                echo "No input type given. Set filename in constructor or choose setXMLContent()";
                break;
        }
        $this->freeParser($xml_parser);
    }
    /**
    * create parser
    * 
    * @access   private
    */
    function createParser()
    {
        $xml_parser = xml_parser_create("UTF-8");

        if($xml_parser == false)
        {
            echo "Cannot create an XML parser handle";
        }
        return $xml_parser;
    }
    /**
    * set parser options
    * 
    * @access   private
    */
    function setOptions($a_xml_parser)
    {
        xml_parser_set_option($a_xml_parser,XML_OPTION_CASE_FOLDING,false);
    }
    /**
    * set event handler
    * should be overwritten by inherited class
    * @access   private
    */
    function setHandlers($a_xml_parser)
    {
        echo 'ilSaxParser::setHandlers() must be overwritten';
    }
    /**
    * open xml file
    * 
    * @access   private
    */
    function openXMLFile()
    {
        if(!($fp = fopen($this->xml_file,'r')))
        {
            echo "Cannot open xml file";
        }
        return $fp;
    }
    /**
    * parse xml file
    * 
    * @access   private
    */
    function parse($a_xml_parser,$a_fp = null)
    {
        switch($this->getInputType())
        {
            case 'file':

                while($data = fread($a_fp,4096))
                {
                    $parseOk = xml_parse($a_xml_parser,$data,feof($a_fp));
                }
                break;
                
            case 'string':
                $parseOk = xml_parse($a_xml_parser,$this->getXMLContent());
                break;
        }
        if(!$parseOk
           && (xml_get_error_code($a_xml_parser) != XML_ERROR_NONE))
        {
            echo $this->getXMLContent();
            echo "XML Parse Error: ".xml_get_error_code($a_xml_parser);
        }
        return true;
                
    }
    /**
    * free xml parser handle
    * 
    * @access   private
    */
    function freeParser($a_xml_parser)
    {
        if(!xml_parser_free($a_xml_parser))
        {
            echo "Error freeing xml parser handle ";
        }
    }
}
?>