Use XML comments for debug/verbose info.
[yaz-moved-to-github.git] / src / marcdisp.c
1 /*
2  * Copyright (C) 1995-2005, Index Data ApS
3  * See the file LICENSE for details.
4  *
5  * $Id: marcdisp.c,v 1.21 2005-04-20 13:17:51 adam Exp $
6  */
7
8 /**
9  * \file marcdisp.c
10  * \brief Implements MARC display - and conversion utilities
11  */
12
13 #if HAVE_CONFIG_H
14 #include <config.h>
15 #endif
16
17 #include <stdio.h>
18 #include <string.h>
19 #include <ctype.h>
20 #include <yaz/marcdisp.h>
21 #include <yaz/wrbuf.h>
22 #include <yaz/yaz-util.h>
23
24 struct yaz_marc_t_ {
25     WRBUF m_wr;
26     int xml;
27     int debug;
28     yaz_iconv_t iconv_cd;
29     char subfield_str[8];
30     char endline_str[8];
31 };
32
33 yaz_marc_t yaz_marc_create(void)
34 {
35     yaz_marc_t mt = (yaz_marc_t) xmalloc(sizeof(*mt));
36     mt->xml = YAZ_MARC_LINE;
37     mt->debug = 0;
38     mt->m_wr = wrbuf_alloc();
39     mt->iconv_cd = 0;
40     strcpy(mt->subfield_str, " $");
41     strcpy(mt->endline_str, "\n");
42     return mt;
43 }
44
45 void yaz_marc_subfield_str(yaz_marc_t mt, const char *s)
46 {
47     strncpy(mt->subfield_str, s, sizeof(mt->subfield_str)-1);
48     mt->subfield_str[sizeof(mt->subfield_str)-1] = '\0';
49 }
50
51 void yaz_marc_endline_str(yaz_marc_t mt, const char *s)
52 {
53     strncpy(mt->endline_str, s, sizeof(mt->endline_str)-1);
54     mt->endline_str[sizeof(mt->endline_str)-1] = '\0';
55 }
56
57 void yaz_marc_destroy(yaz_marc_t mt)
58 {
59     if (!mt)
60         return ;
61     wrbuf_free (mt->m_wr, 1);
62     xfree (mt);
63 }
64
65 static void marc_cdata (yaz_marc_t mt, const char *buf, size_t len, WRBUF wr)
66 {
67     if (mt->xml == YAZ_MARC_ISO2709)
68         wrbuf_iconv_write(wr, mt->iconv_cd, buf, len);
69     else if (mt->xml == YAZ_MARC_LINE)
70         wrbuf_iconv_write(wr, mt->iconv_cd, buf, len);
71     else
72         wrbuf_iconv_write_cdata(wr, mt->iconv_cd, buf, len);
73 }
74
75 static int atoi_n_check(const char *buf, int size, int *val)
76 {
77     if (!isdigit(*(const unsigned char *) buf))
78         return 0;
79     *val = atoi_n(buf, size);
80     return 1;
81 }
82
83 int yaz_marc_decode_wrbuf (yaz_marc_t mt, const char *buf, int bsize, WRBUF wr)
84 {
85     int entry_p;
86     int record_length;
87     int indicator_length;
88     int identifier_length;
89     int end_of_directory;
90     int base_address;
91     int length_data_entry;
92     int length_starting;
93     int length_implementation;
94     char lead[24];
95     int produce_warnings = 0;
96
97     if (mt->debug)
98         produce_warnings = 1;
99     if (mt->xml == YAZ_MARC_SIMPLEXML || mt->xml == YAZ_MARC_OAIMARC
100         || mt->xml == YAZ_MARC_MARCXML || mt->xml == YAZ_MARC_XCHANGE)
101         produce_warnings = 1;
102
103     record_length = atoi_n (buf, 5);
104     if (record_length < 25)
105     {
106         if (mt->debug)
107             wrbuf_printf(wr, "<!-- Record length %d - aborting -->\n",
108                             record_length);
109         return -1;
110     }
111     memcpy(lead, buf, 24);  /* se can modify the header for output */
112
113     /* ballout if bsize is known and record_length is less than that */
114     if (bsize != -1 && record_length > bsize)
115         return -1;
116     if (!atoi_n_check(buf+10, 1, &indicator_length))
117     {
118         if (produce_warnings)
119             wrbuf_printf(wr, "<!-- Indicator length at offset 10 should hold a digit. Assuming 2 -->\n");
120         lead[10] = '2';
121         indicator_length = 2;
122     }
123     if (!atoi_n_check(buf+11, 1, &identifier_length))
124     {
125         if (produce_warnings)
126             wrbuf_printf(wr, "<!-- Identifier length at offset 11 should hold a digit. Assuming 2 -->\n");
127         lead[11] = '2';
128         identifier_length = 2;
129     }
130     if (!atoi_n_check(buf+12, 5, &base_address))
131     {
132         if (produce_warnings)
133             wrbuf_printf(wr, "<!-- Base address at offsets 12..16 should hold a number. Assuming 0 -->\n");
134         base_address = 0;
135     }
136     if (!atoi_n_check(buf+20, 1, &length_data_entry))
137     {
138         if (produce_warnings)
139             wrbuf_printf(wr, "<!-- Length data entry at offset 20 should hold a digit. Assuming 4 -->\n");
140         length_data_entry = 4;
141         lead[20] = '4';
142     }
143     if (!atoi_n_check(buf+21, 1, &length_starting))
144     {
145         if (produce_warnings)
146             wrbuf_printf(wr, "<!-- Length starting at offset 21 should hold a digit. Assuming 5 -->\n");
147         length_starting = 5;
148         lead[21] = '5';
149     }
150     if (!atoi_n_check(buf+22, 1, &length_implementation))
151     {
152         if (produce_warnings)
153             wrbuf_printf(wr, "<!-- Length implementation at offset 22 should hold a digit. Assuming 0 -->\n");
154         length_implementation = 0;
155         lead[22] = '0';
156     }
157
158     if (mt->xml != YAZ_MARC_LINE)
159     {
160         char str[80];
161         int i;
162         switch(mt->xml)
163         {
164         case YAZ_MARC_ISO2709:
165             break;
166         case YAZ_MARC_SIMPLEXML:
167             wrbuf_puts (wr, "<iso2709\n");
168             sprintf (str, " RecordStatus=\"%c\"\n", buf[5]);
169             wrbuf_puts (wr, str);
170             sprintf (str, " TypeOfRecord=\"%c\"\n", buf[6]);
171             wrbuf_puts (wr, str);
172             for (i = 1; i<=19; i++)
173             {
174                 sprintf (str, " ImplDefined%d=\"%c\"\n", i, buf[6+i]);
175                 wrbuf_puts (wr, str);
176             }
177             wrbuf_puts (wr, ">\n");
178             break;
179         case YAZ_MARC_OAIMARC:
180             wrbuf_puts(
181                 wr,
182                 "<oai_marc xmlns=\"http://www.openarchives.org/OIA/oai_marc\""
183                 "\n"
184                 " xmlns:xsi=\"http://www.w3.org/2000/10/XMLSchema-instance\""
185                 "\n"
186                 " xsi:schemaLocation=\"http://www.openarchives.org/OAI/oai_marc.xsd\""
187                 "\n"
188                 );
189             
190             sprintf (str, " status=\"%c\" type=\"%c\" catForm=\"%c\">\n",
191                      buf[5], buf[6], buf[7]);
192             wrbuf_puts (wr, str);
193             break;
194         case YAZ_MARC_MARCXML:
195             wrbuf_printf(
196                 wr,
197                 "<record xmlns=\"http://www.loc.gov/MARC21/slim\">\n"
198                 "  <leader>");
199             lead[9] = 'a';                 /* set leader to signal unicode */
200             marc_cdata(mt, lead, 24, wr); 
201             wrbuf_printf(wr, "</leader>\n");
202             break;
203         case YAZ_MARC_XCHANGE:
204             wrbuf_printf(
205                 wr,
206                 "<record xmlns=\"http://www.bs.dk/standards/MarcXchange\">\n"
207                 "  <leader>");
208             marc_cdata(mt, lead, 24, wr);
209             wrbuf_printf(wr, "</leader>\n");
210             break;
211         }
212     }
213     if (mt->debug)
214     {
215         char str[40];
216
217         wrbuf_puts (wr, "<!--\n");
218         sprintf (str, "Record length         %5d\n", record_length);
219         wrbuf_puts (wr, str);
220         sprintf (str, "Indicator length      %5d\n", indicator_length);
221         wrbuf_puts (wr, str);
222         sprintf (str, "Identifier length     %5d\n", identifier_length);
223         wrbuf_puts (wr, str);
224         sprintf (str, "Base address          %5d\n", base_address);
225         wrbuf_puts (wr, str);
226         sprintf (str, "Length data entry     %5d\n", length_data_entry);
227         wrbuf_puts (wr, str);
228         sprintf (str, "Length starting       %5d\n", length_starting);
229         wrbuf_puts (wr, str);
230         sprintf (str, "Length implementation %5d\n", length_implementation);
231         wrbuf_puts (wr, str);
232         wrbuf_puts (wr, "-->\n");
233     }
234
235     /* first pass. determine length of directory & base of data */
236     for (entry_p = 24; buf[entry_p] != ISO2709_FS; )
237     {
238         /* length of directory entry */
239         int l = 3 + length_data_entry + length_starting;
240         if (entry_p + l >= record_length)
241         {
242             wrbuf_printf (wr, "<!-- Directory offset %d: end of record. "
243                             "Missing FS char -->\n", entry_p);
244             return -1;
245         }
246         if (mt->debug)
247             wrbuf_printf (wr, "<!-- Directory offset %d: Tag %.3s -->\n",
248                             entry_p, buf+entry_p);
249         /* check for digits in length info */
250         while (--l >= 3)
251             if (!isdigit(*(const unsigned char *) (buf + entry_p+l)))
252                 break;
253         if (l >= 3)
254         {
255             /* not all digits, so stop directory scan */
256             wrbuf_printf (wr, "<!-- Directory offset %d: Bad data for data "
257                             "length and/or length starting -->\n", entry_p);
258             break;
259         }
260         entry_p += 3 + length_data_entry + length_starting;
261     }
262     end_of_directory = entry_p;
263     if (base_address != entry_p+1)
264     {
265         if (produce_warnings)
266             wrbuf_printf (wr,"<!-- Base address not at end of directory, "
267                           "base %d, end %d -->\n", base_address, entry_p+1);
268     }
269     if (mt->xml == YAZ_MARC_ISO2709)
270     {
271         WRBUF wr_head = wrbuf_alloc();
272         WRBUF wr_dir = wrbuf_alloc();
273         WRBUF wr_tmp = wrbuf_alloc();
274
275         int data_p = 0;
276         /* second pass. create directory for ISO2709 output */
277         for (entry_p = 24; entry_p != end_of_directory; )
278         {
279             int data_length, data_offset, end_offset;
280             int i, sz1, sz2;
281             
282             wrbuf_write(wr_dir, buf+entry_p, 3);
283             entry_p += 3;
284             
285             data_length = atoi_n (buf+entry_p, length_data_entry);
286             entry_p += length_data_entry;
287             data_offset = atoi_n (buf+entry_p, length_starting);
288             entry_p += length_starting;
289             i = data_offset + base_address;
290             end_offset = i+data_length-1;
291             
292             if (data_length <= 0 || data_offset < 0 || end_offset >= record_length)
293                 return -1;
294         
295             while (i < end_offset &&
296                     buf[i] != ISO2709_RS && buf[i] != ISO2709_FS)
297                 i++;
298             sz1 = 1+i - (data_offset + base_address);
299             if (mt->iconv_cd)
300             {
301                 sz2 = wrbuf_iconv_write(wr_tmp, mt->iconv_cd,
302                                         buf + data_offset+base_address, sz1);
303                 wrbuf_rewind(wr_tmp);
304             }
305             else
306                 sz2 = sz1;
307             wrbuf_printf(wr_dir, "%0*d", length_data_entry, sz2);
308             wrbuf_printf(wr_dir, "%0*d", length_starting, data_p);
309             data_p += sz2;
310         }
311         wrbuf_putc(wr_dir, ISO2709_FS);
312         wrbuf_printf(wr_head, "%05d", data_p+1 + base_address);
313         wrbuf_write(wr_head, lead+5, 7);
314         wrbuf_printf(wr_head, "%05d", base_address);
315         wrbuf_write(wr_head, lead+17, 7);
316
317         wrbuf_write(wr, wrbuf_buf(wr_head), 24);
318         wrbuf_write(wr, wrbuf_buf(wr_dir), wrbuf_len(wr_dir));
319         wrbuf_free(wr_head, 1);
320         wrbuf_free(wr_dir, 1);
321         wrbuf_free(wr_tmp, 1);
322     }
323     /* third pass. create data output */
324     for (entry_p = 24; entry_p != end_of_directory; )
325     {
326         int data_length;
327         int data_offset;
328         int end_offset;
329         int i, j;
330         char tag[4];
331         int identifier_flag = 0;
332         int entry_p0 = entry_p;
333
334         memcpy (tag, buf+entry_p, 3);
335         entry_p += 3;
336         tag[3] = '\0';
337         data_length = atoi_n (buf+entry_p, length_data_entry);
338         entry_p += length_data_entry;
339         data_offset = atoi_n (buf+entry_p, length_starting);
340         entry_p += length_starting;
341         i = data_offset + base_address;
342         end_offset = i+data_length-1;
343
344         if (data_length <= 0 || data_offset < 0)
345             break;
346         
347         if (mt->debug)
348         {
349             wrbuf_printf(wr, "<!-- Directory offset %d: data-length %d, "
350                             "data-offset %d -->\n",
351                     entry_p0, data_length, data_offset);
352         }
353         if (end_offset >= record_length)
354         {
355             wrbuf_printf (wr,"<!-- Directory offset %d: Data out of bounds "
356                             "%d >= %d -->\n",
357                                    entry_p0, end_offset, record_length);
358             break;
359         }
360         
361         if (memcmp (tag, "00", 2))
362             identifier_flag = 1;  /* if not 00X assume subfields */
363         else if (indicator_length < 4 && indicator_length > 0)
364         {
365             /* Danmarc 00X have subfields */
366             if (buf[i + indicator_length] == ISO2709_IDFS)
367                 identifier_flag = 1;
368             else if (buf[i + indicator_length + 1] == ISO2709_IDFS)
369                 identifier_flag = 2;
370         }
371
372         if (mt->debug)
373         {
374             wrbuf_printf(wr, "<!-- identifier_flag = %d -->\n",
375                          identifier_flag);
376         } 
377        
378         switch(mt->xml)
379         {
380         case YAZ_MARC_LINE:
381             wrbuf_puts (wr, tag);
382             wrbuf_puts (wr, " ");
383             break;
384         case YAZ_MARC_SIMPLEXML:
385             wrbuf_printf (wr, "<field tag=\"");
386             marc_cdata(mt, tag, strlen(tag), wr);
387             wrbuf_printf(wr, "\"");
388             break;
389         case YAZ_MARC_OAIMARC:
390             if (identifier_flag)
391                 wrbuf_printf (wr, "  <varfield id=\"");
392             else
393                 wrbuf_printf (wr, "  <fixfield id=\"");
394             marc_cdata(mt, tag, strlen(tag), wr);
395             wrbuf_printf(wr, "\"");
396             break;
397         case YAZ_MARC_MARCXML:
398         case YAZ_MARC_XCHANGE:
399             if (identifier_flag)
400                 wrbuf_printf (wr, "  <datafield tag=\"");
401             else
402                 wrbuf_printf (wr, "  <controlfield tag=\"");
403             marc_cdata(mt, tag, strlen(tag), wr);
404             wrbuf_printf(wr, "\"");
405         }
406         
407         if (identifier_flag)
408         {
409             i += identifier_flag-1;
410             for (j = 0; j<indicator_length; j++, i++)
411             {
412                 switch(mt->xml)
413                 {
414                 case YAZ_MARC_ISO2709:
415                     wrbuf_putc(wr, buf[i]);
416                     break;
417                 case YAZ_MARC_LINE:
418                     wrbuf_putc(wr, buf[i]);
419                     break;
420                 case YAZ_MARC_SIMPLEXML:
421                     wrbuf_printf(wr, " Indicator%d=\"", j+1);
422                     marc_cdata(mt, buf+i, 1, wr);
423                     wrbuf_printf(wr, "\"");
424                     break;
425                 case YAZ_MARC_OAIMARC:
426                     wrbuf_printf(wr, " i%d=\"", j+1);
427                     marc_cdata(mt, buf+i, 1, wr);
428                     wrbuf_printf(wr, "\"");
429                     break;
430                 case YAZ_MARC_MARCXML:
431                 case YAZ_MARC_XCHANGE:
432                     wrbuf_printf(wr, " ind%d=\"", j+1);
433                     marc_cdata(mt, buf+i, 1, wr);
434                     wrbuf_printf(wr, "\"");
435                 }
436             }
437         }
438         if (mt->xml == YAZ_MARC_SIMPLEXML || mt->xml == YAZ_MARC_MARCXML
439             || mt->xml == YAZ_MARC_OAIMARC || mt->xml == YAZ_MARC_XCHANGE)
440         {
441             wrbuf_puts (wr, ">");
442             if (identifier_flag)
443                 wrbuf_puts (wr, "\n");
444         }
445         if (identifier_flag)
446         {
447             while (i < end_offset &&
448                     buf[i] != ISO2709_RS && buf[i] != ISO2709_FS)
449             {
450                 int i0;
451                 i++;
452                 switch(mt->xml)
453                 {
454                 case YAZ_MARC_ISO2709:
455                     --i;
456                     wrbuf_iconv_write(wr, mt->iconv_cd, 
457                                       buf+i, identifier_length);
458                     i += identifier_length;
459                     break;
460                 case YAZ_MARC_LINE: 
461                     wrbuf_puts (wr, mt->subfield_str); 
462                     marc_cdata(mt, buf+i, identifier_length-1, wr);
463                     i = i+identifier_length-1;
464                     wrbuf_putc (wr, ' ');
465                     break;
466                 case YAZ_MARC_SIMPLEXML:
467                     wrbuf_puts (wr, "  <subfield code=\"");
468                     marc_cdata(mt, buf+i, identifier_length-1, wr);
469                     i = i+identifier_length-1;
470                     wrbuf_puts (wr, "\">");
471                     break;
472                 case YAZ_MARC_OAIMARC:
473                     wrbuf_puts (wr, "    <subfield label=\"");
474                     marc_cdata(mt, buf+i, identifier_length-1, wr);
475                     i = i+identifier_length-1;
476                     wrbuf_puts (wr, "\">");
477                     break;
478                 case YAZ_MARC_MARCXML:
479                 case YAZ_MARC_XCHANGE:
480                     wrbuf_puts (wr, "    <subfield code=\"");
481                     marc_cdata(mt, buf+i, identifier_length-1, wr);
482                     i = i+identifier_length-1;
483                     wrbuf_puts (wr, "\">");
484                     break;
485                 }
486                 i0 = i;
487                 while (i < end_offset &&
488                         buf[i] != ISO2709_RS && buf[i] != ISO2709_IDFS &&
489                         buf[i] != ISO2709_FS)
490                     i++;
491                 marc_cdata(mt, buf + i0, i - i0, wr);
492
493                 if (mt->xml == YAZ_MARC_ISO2709 && buf[i] != ISO2709_IDFS)
494                     marc_cdata(mt, buf + i, 1, wr);
495
496                 if (mt->xml == YAZ_MARC_SIMPLEXML || 
497                     mt->xml == YAZ_MARC_MARCXML ||
498                     mt->xml == YAZ_MARC_XCHANGE ||
499                     mt->xml == YAZ_MARC_OAIMARC)
500                     wrbuf_puts (wr, "</subfield>\n");
501             }
502         }
503         else
504         {
505             int i0 = i;
506             while (i < end_offset && 
507                 buf[i] != ISO2709_RS && buf[i] != ISO2709_FS)
508                 i++;
509             marc_cdata(mt, buf + i0, i - i0, wr);
510             if (mt->xml == YAZ_MARC_ISO2709)
511                 marc_cdata(mt, buf + i, 1, wr);
512         }
513         if (mt->xml == YAZ_MARC_LINE)
514             wrbuf_puts (wr, mt->endline_str);
515         if (i < end_offset)
516             wrbuf_printf(wr, "<!-- separator but not at end of field length=%d-->\n", data_length);
517         if (buf[i] != ISO2709_RS && buf[i] != ISO2709_FS)
518             wrbuf_printf(wr, "<!-- no separator at end of field length=%d-->\n", data_length);
519         switch(mt->xml)
520         {
521         case YAZ_MARC_SIMPLEXML:
522             wrbuf_puts (wr, "</field>\n");
523             break;
524         case YAZ_MARC_OAIMARC:
525             if (identifier_flag)
526                 wrbuf_puts (wr, "</varfield>\n");
527             else
528                 wrbuf_puts (wr, "</fixfield>\n");
529             break;
530         case YAZ_MARC_MARCXML:
531         case YAZ_MARC_XCHANGE:
532             if (identifier_flag)
533                 wrbuf_puts (wr, "  </datafield>\n");
534             else
535                 wrbuf_puts (wr, "</controlfield>\n");
536             break;
537         }
538     }
539     switch (mt->xml)
540     {
541     case YAZ_MARC_LINE:
542         wrbuf_puts (wr, "");
543         break;
544     case YAZ_MARC_SIMPLEXML:
545         wrbuf_puts (wr, "</iso2709>\n");
546         break;
547     case YAZ_MARC_OAIMARC:
548         wrbuf_puts (wr, "</oai_marc>\n");
549         break;
550     case YAZ_MARC_MARCXML:
551     case YAZ_MARC_XCHANGE:
552         wrbuf_puts (wr, "</record>\n");
553         break;
554     case YAZ_MARC_ISO2709:
555         wrbuf_putc (wr, ISO2709_RS);
556         break;
557     }
558     return record_length;
559 }
560
561 int yaz_marc_decode_buf (yaz_marc_t mt, const char *buf, int bsize,
562                          char **result, int *rsize)
563 {
564     int r = yaz_marc_decode_wrbuf(mt, buf, bsize, mt->m_wr);
565     if (result)
566         *result = wrbuf_buf(mt->m_wr);
567     if (rsize)
568         *rsize = wrbuf_len(mt->m_wr);
569     return r;
570 }
571
572 void yaz_marc_xml(yaz_marc_t mt, int xmlmode)
573 {
574     if (mt)
575         mt->xml = xmlmode;
576 }
577
578 void yaz_marc_debug(yaz_marc_t mt, int level)
579 {
580     if (mt)
581         mt->debug = level;
582 }
583
584 void yaz_marc_iconv(yaz_marc_t mt, yaz_iconv_t cd)
585 {
586     mt->iconv_cd = cd;
587 }
588
589 /* depricated */
590 int yaz_marc_decode(const char *buf, WRBUF wr, int debug, int bsize, int xml)
591 {
592     yaz_marc_t mt = yaz_marc_create();
593     int r;
594
595     mt->debug = debug;
596     mt->xml = xml;
597     r = yaz_marc_decode_wrbuf(mt, buf, bsize, wr);
598     yaz_marc_destroy(mt);
599     return r;
600 }
601
602 /* depricated */
603 int marc_display_wrbuf (const char *buf, WRBUF wr, int debug, int bsize)
604 {
605     return yaz_marc_decode(buf, wr, debug, bsize, 0);
606 }
607
608 /* depricated */
609 int marc_display_exl (const char *buf, FILE *outf, int debug, int bsize)
610 {
611     yaz_marc_t mt = yaz_marc_create();
612     int r;
613
614     mt->debug = debug;
615     r = yaz_marc_decode_wrbuf (mt, buf, bsize, mt->m_wr);
616     if (!outf)
617         outf = stdout;
618     if (r > 0)
619         fwrite (wrbuf_buf(mt->m_wr), 1, wrbuf_len(mt->m_wr), outf);
620     yaz_marc_destroy(mt);
621     return r;
622 }
623
624 /* depricated */
625 int marc_display_ex (const char *buf, FILE *outf, int debug)
626 {
627     return marc_display_exl (buf, outf, debug, -1);
628 }
629
630 /* depricated */
631 int marc_display (const char *buf, FILE *outf)
632 {
633     return marc_display_ex (buf, outf, 0);
634 }
635