Zebra uses own XML reader (was part of YAZ before)
[idzebra-moved-to-github.git] / recctrl / xmlread.c
1 /* $Id: xmlread.c,v 1.3 2002-08-28 12:47:10 adam Exp $
2    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
3    Index Data Aps
4
5 This file is part of the Zebra server.
6
7 Zebra is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
11
12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA.
21 */
22
23 #if HAVE_EXPAT_H
24
25 #include <assert.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #if HAVE_ICONV_H
29 #include <errno.h>
30 #include <iconv.h>
31 #endif
32
33 #include <yaz/log.h>
34
35 #include "grsread.h"
36
37 #include <yaz/xmalloc.h>
38 #include <yaz/log.h>
39 #include <yaz/data1.h>
40
41 #include <expat.h>
42
43 #define XML_CHUNK 1024
44
45 struct user_info {
46     data1_node *d1_stack[256];
47     int level;
48     data1_handle dh;
49     NMEM nmem;
50     int loglevel;
51 };
52
53 static void cb_start (void *user, const char *el, const char **attr)
54 {
55     struct user_info *ui = (struct user_info*) user;
56     if (ui->level == 1)
57         data1_set_root (ui->dh, ui->d1_stack[0], ui->nmem, el);
58     ui->d1_stack[ui->level] = data1_mk_tag (ui->dh, ui->nmem, el, attr,
59                                                 ui->d1_stack[ui->level-1]);
60     ui->level++;
61     yaz_log (ui->loglevel, "cb_start %s", el);
62 }
63
64 static void cb_end (void *user, const char *el)
65 {
66     struct user_info *ui = (struct user_info*) user;
67
68     ui->level--;
69     yaz_log (ui->loglevel, "cb_end %s", el);
70 }
71
72 static void cb_chardata (void *user, const char *s, int len)
73 {
74     struct user_info *ui = (struct user_info*) user;
75 #if 0
76     yaz_log (ui->loglevel, "cb_chardata %.*s", len, s);
77 #endif
78     ui->d1_stack[ui->level] = data1_mk_text_n (ui->dh, ui->nmem, s, len,
79                                                    ui->d1_stack[ui->level -1]);
80 }
81
82 static void cb_decl (void *user, const char *version, const char*encoding,
83                      int standalone)
84 {
85     struct user_info *ui = (struct user_info*) user;
86     const char *attr_list[7];
87
88     attr_list[0] = "version";
89     attr_list[1] = version;
90
91     attr_list[2] = "encoding";
92     attr_list[3] = "UTF-8"; /* encoding */
93
94     attr_list[4] = "standalone";
95     attr_list[5] = standalone  ? "yes" : "no";
96
97     attr_list[6] = 0;
98     
99     data1_mk_preprocess (ui->dh, ui->nmem, "xml", attr_list,
100                              ui->d1_stack[ui->level-1]);
101     yaz_log (ui->loglevel, "decl version=%s encoding=%s",
102              version ? version : "null",
103              encoding ? encoding : "null");
104 }
105     
106 static void cb_processing (void *user, const char *target,
107                            const char *data)
108 {
109     struct user_info *ui = (struct user_info*) user;
110     data1_node *res =
111         data1_mk_preprocess (ui->dh, ui->nmem, target, 0,
112                              ui->d1_stack[ui->level-1]);
113     data1_mk_text_nf (ui->dh, ui->nmem, data, strlen(data), res);
114     
115     yaz_log (ui->loglevel, "decl processing target=%s data=%s",
116              target ? target : "null",
117              data ? data : "null");
118     
119     
120 }
121
122 static void cb_comment (void *user, const char *data)
123 {
124     struct user_info *ui = (struct user_info*) user;
125     yaz_log (ui->loglevel, "decl comment data=%s", data ? data : "null");
126     data1_mk_comment (ui->dh, ui->nmem, data, ui->d1_stack[ui->level-1]);
127 }
128
129 static void cb_doctype_start (void *userData, const char *doctypeName,
130                               const char *sysid, const char *pubid,
131                               int has_internal_subset)
132 {
133     struct user_info *ui = (struct user_info*) userData;
134     yaz_log (ui->loglevel, "doctype start doctype=%s sysid=%s pubid=%s",
135              doctypeName, sysid, pubid);
136 }
137
138 static void cb_doctype_end (void *userData)
139 {
140     struct user_info *ui = (struct user_info*) userData;
141     yaz_log (ui->loglevel, "doctype end");
142 }
143
144
145 static void cb_entity_decl (void *userData, const char *entityName,
146                             int is_parameter_entity,
147                             const char *value, int value_length,
148                             const char *base, const char *systemId,
149                             const char *publicId, const char *notationName)
150 {
151     struct user_info *ui = (struct user_info*) userData;
152     yaz_log (ui->loglevel,
153              "entity decl %s is_para_entry=%d value=%.*s base=%s systemId=%s"
154              " publicId=%s notationName=%s",
155              entityName, is_parameter_entity, value_length, value,
156              base, systemId, publicId, notationName);
157     
158 }
159
160 static int cb_external_entity (XML_Parser pparser,
161                                const char *context,
162                                const char *base,
163                                const char *systemId,
164                                const char *publicId)
165 {
166     struct user_info *ui = (struct user_info*) XML_GetUserData(pparser);
167     FILE *inf;
168     int done = 0;
169     XML_Parser parser;
170
171     yaz_log (ui->loglevel,
172              "external entity context=%s base=%s systemid=%s publicid=%s",
173              context, base, systemId, publicId);
174     if (!systemId)
175         return 1;
176
177     if (!(inf = fopen (systemId, "rb")))
178     {
179         yaz_log (LOG_WARN|LOG_ERRNO, "fopen %s", systemId);
180         return 0;
181     }
182
183     parser = XML_ExternalEntityParserCreate (pparser, "", 0);
184     while (!done)
185     {
186         int r;
187         void *buf = XML_GetBuffer (parser, XML_CHUNK);
188         if (!buf)
189         {
190             yaz_log (LOG_WARN, "XML_GetBuffer fail");
191             break;
192         }
193         r = fread (buf, 1, XML_CHUNK, inf);
194         if (r == 0)
195         {
196             if (ferror(inf))
197             {
198                 yaz_log (LOG_WARN|LOG_ERRNO, "fread %s", systemId);
199                 break;
200             }
201             done = 1;
202         }
203         if (!XML_ParseBuffer (parser, r, done))
204         {
205             yaz_log (LOG_WARN, "XML_ParseBuffer failed %s",
206                      XML_ErrorString(XML_GetErrorCode(parser)));
207         }
208     }
209     fclose (inf);
210     XML_ParserFree (parser);
211     return done;
212 }
213
214
215 #if HAVE_ICONV_H
216 static int cb_encoding_convert (void *data, const char *s)
217 {
218     iconv_t t = (iconv_t) data;
219     size_t ret;
220     size_t outleft = 2;
221     char outbuf_[2], *outbuf = outbuf_;
222     size_t inleft = 4;
223     char *inbuf = (char *) s;
224     unsigned short code;
225
226     ret = iconv (t, &inbuf, &inleft, &outbuf, &outleft);
227     if (ret == (size_t) (-1) && errno != E2BIG)
228     {
229         iconv (t, 0, 0, 0, 0);
230         return -1;
231     }
232     if (outleft != 0)
233         return -1;
234     memcpy (&code, outbuf_, sizeof(short));
235     return code;
236 }
237
238 static void cb_encoding_release (void *data)
239 {
240     iconv_t t = (iconv_t) data;
241     iconv_close (t);
242 }
243
244 static int cb_encoding_handler (void *userData, const char *name,
245                                 XML_Encoding *info)
246 {
247     int i = 0;
248     int no_ok = 0;
249     struct user_info *ui = (struct user_info*) userData;
250
251     iconv_t t = iconv_open ("UNICODE", name);
252     if (t == (iconv_t) (-1))
253         return 0;
254    
255     info->data = 0;  /* signal that multibyte is not in use */
256     yaz_log (ui->loglevel, "Encoding handler of %s", name);
257     for (i = 0; i<256; i++)
258     {
259         size_t ret;
260         char outbuf_[5];
261         char inbuf_[5];
262         char *inbuf = inbuf_;
263         char *outbuf = outbuf_;
264         size_t inleft = 1;
265         size_t outleft = 2;
266         inbuf_[0] = i;
267
268         iconv (t, 0, 0, 0, 0);  /* reset iconv */
269
270         ret = iconv(t, &inbuf, &inleft, &outbuf, &outleft);
271         if (ret == (size_t) (-1))
272         {
273             if (errno == EILSEQ)
274             {
275                 yaz_log (ui->loglevel, "Encoding %d: invalid sequence", i);
276                 info->map[i] = -1;  /* invalid sequence */
277             }
278             if (errno == EINVAL)
279             {                       /* multi byte input */
280                 int len = 2;
281                 int j = 0;
282                 info->map[i] = -1;
283                 
284                 while (len <= 4)
285                 {
286                     char sbuf[80];
287                     int k;
288                     inbuf = inbuf_;
289                     inleft = len;
290                     outbuf = outbuf_;
291                     outleft = 2;
292
293                     inbuf_[len-1] = j;
294                     iconv (t, 0,0,0,0);
295
296                     assert (i >= 0 && i<255);
297
298                     *sbuf = 0;
299                     for (k = 0; k<len; k++)
300                     {
301                         sprintf (sbuf+strlen(sbuf), "%d ", inbuf_[k]&255);
302                     }
303                     ret = iconv (t, &inbuf, &inleft, &outbuf, &outleft);
304                     if (ret == (size_t) (-1))
305                     {
306                         if (errno == EILSEQ || errno == E2BIG)
307                         {
308                             j++;
309                             if (j > 255)
310                                 break;
311                         }
312                         else if (errno == EINVAL)
313                         {
314                             len++;
315                             j = 7;
316                         }
317                     }
318                     else if (outleft == 0)
319                     {
320                         info->map[i] = -len;
321                         info->data = t;  /* signal that multibyte is in use */
322                         break;
323                     }
324                     else
325                     {
326                         break;
327                     }
328                 }
329                 if (info->map[i] < -1)
330                     yaz_log (ui->loglevel, "Encoding %d: multibyte input %d",
331                              i, -info->map[i]);
332                 else
333                     yaz_log (ui->loglevel, "Encoding %d: multibyte input failed",
334                              i);
335             }
336             if (errno == E2BIG)
337             {
338                 info->map[i] = -1;  /* no room for output */
339                 yaz_log (LOG_WARN, "Encoding %d: no room for output",
340                          i);
341             }
342         }
343         else if (outleft == 0)
344         {
345             unsigned short code;
346             memcpy (&code, outbuf_, sizeof(short));
347             info->map[i] = code;
348             no_ok++;
349         }
350         else
351         {   /* should never happen */
352             info->map[i] = -1;
353             yaz_log (LOG_DEBUG, "Encoding %d: bad state", i);
354         }
355     }
356     if (info->data)
357     {   /* at least one multi byte */
358         info->convert = cb_encoding_convert;
359         info->release = cb_encoding_release;
360     }
361     else
362     {
363         /* no multi byte - we no longer need iconv handler */
364         iconv_close(t);
365         info->convert = 0;
366         info->release = 0;
367     }
368     if (!no_ok)
369         return 0;
370     return 1;
371 }
372 /* HAVE_ICONV_H */
373 #endif
374
375
376 data1_node *zebra_read_xml (data1_handle dh,
377                             int (*rf)(void *, char *, size_t), void *fh,
378                             NMEM m)
379 {
380     XML_Parser parser;
381     struct user_info uinfo;
382     int done = 0;
383
384     uinfo.loglevel = LOG_LOG;
385     uinfo.level = 1;
386     uinfo.dh = dh;
387     uinfo.nmem = m;
388     uinfo.d1_stack[0] = data1_mk_node2 (dh, m, DATA1N_root, 0);
389     uinfo.d1_stack[1] = 0; /* indicate no children (see end of routine) */
390     
391     parser = XML_ParserCreate (0 /* encoding */);
392     
393     XML_SetElementHandler (parser, cb_start, cb_end);
394     XML_SetCharacterDataHandler (parser, cb_chardata);
395     XML_SetXmlDeclHandler (parser, cb_decl);
396     XML_SetProcessingInstructionHandler (parser, cb_processing);
397     XML_SetUserData (parser, &uinfo);
398     XML_SetCommentHandler (parser, cb_comment);
399     XML_SetDoctypeDeclHandler (parser, cb_doctype_start, cb_doctype_end);
400     XML_SetEntityDeclHandler (parser, cb_entity_decl);
401     XML_SetExternalEntityRefHandler (parser, cb_external_entity);
402 #if HAVE_ICONV_H
403     XML_SetUnknownEncodingHandler (parser, cb_encoding_handler, &uinfo);
404 #endif
405     while (!done)
406     {
407         int r;
408         void *buf = XML_GetBuffer (parser, XML_CHUNK);
409         if (!buf)
410         {
411             /* error */
412             yaz_log (LOG_WARN, "XML_GetBuffer fail");
413             break;
414         }
415         r = (*rf)(fh, buf, XML_CHUNK);
416         if (r < 0)
417         {
418             /* error */
419             yaz_log (LOG_WARN, "XML read fail");
420             break;
421         }
422         else if (r == 0)
423             done = 1;
424         if (!XML_ParseBuffer (parser, r, done))
425         {
426             yaz_log (LOG_WARN, "XML_ParseBuffer (1) failed %s",
427                      XML_ErrorString(XML_GetErrorCode(parser)));
428         }
429     }
430     XML_ParserFree (parser);
431     if (!uinfo.d1_stack[1] || !done)
432         return 0;
433     return uinfo.d1_stack[0];
434 }
435
436 struct xml_info {
437     int dummy;
438 };
439
440 static void *grs_init_xml(void)
441 {
442     struct xml_info *p = (struct xml_info *) xmalloc (sizeof(*p));
443     return p;
444 }
445
446 static data1_node *grs_read_xml (struct grs_read_info *p)
447 {
448     return zebra_read_xml (p->dh, p->readf, p->fh, p->mem);
449 }
450
451 static void grs_destroy_xml(void *clientData)
452 {
453     struct sgml_getc_info *p = (struct sgml_getc_info *) clientData;
454
455     xfree (p);
456 }
457
458 static struct recTypeGrs xml_type = {
459     "xml",
460     grs_init_xml,
461     grs_destroy_xml,
462     grs_read_xml
463 };
464
465 RecTypeGrs recTypeGrs_xml = &xml_type;
466
467 /* HAVE_EXPAT_H */
468 #endif
469