Zip Reader: Take members from the index if they exist.
[pspp] / src / libpspp / u8-istream.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2010, 2011, 2012 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #include <config.h>
18
19 #include "u8-istream.h"
20
21 #include <assert.h>
22 #include <errno.h>
23 #include <fcntl.h>
24 #include <iconv.h>
25 #include <limits.h>
26 #include <stdint.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <unistd.h>
31 #include <unistr.h>
32
33 #include "libpspp/assertion.h"
34 #include "libpspp/cast.h"
35 #include "libpspp/compiler.h"
36 #include "libpspp/encoding-guesser.h"
37 #include "libpspp/i18n.h"
38
39 #include "gl/c-strcase.h"
40 #include "gl/localcharset.h"
41 #include "gl/minmax.h"
42
43 enum u8_istream_state
44   {
45     S_AUTO,                     /* Stream encoding not yet known. */
46     S_UTF8,                     /* Stream encoding is known to be UTF-8. */
47     S_CONVERT                   /* Stream encoding is known but not UTF-8. */
48   };
49
50 struct u8_istream
51   {
52     int fd;
53     iconv_t converter;
54     enum u8_istream_state state;
55
56     char *buffer;
57     char *head;
58     size_t length;
59
60     char outbuf[4];
61     size_t outlen;
62   };
63
64 static ssize_t fill_buffer (struct u8_istream *);
65
66 /* Opens FILENAME, which is encoded in FROMCODE, for reading as an UTF-8
67    stream, passing FLAGS to the open() function.  Returns a new u8_istream if
68    successful, otherwise returns NULL and sets errno to an appropriate value.
69
70    The accepted forms for FROMCODE are listed at the top of
71    encoding-guesser.h. */
72 struct u8_istream *
73 u8_istream_for_file (const char *fromcode, const char *filename, int flags)
74 {
75   struct u8_istream *is;
76   int fd;
77
78   assert (!(flags & O_CREAT));
79
80   fd = open (filename, flags);
81   if (fd < 0)
82     return NULL;
83
84   is = u8_istream_for_fd (fromcode, fd);
85   if (is == NULL)
86     {
87       int save_errno = errno;
88       close (fd);
89       errno = save_errno;
90     }
91
92   return is;
93 }
94
95 /* Creates and returns a new u8_istream that reads its input from FD.  Returns
96    a new u8_istream if successful, otherwise returns NULL and sets errno to an
97    appropriate value.
98
99    The accepted forms for FROMCODE are listed at the top of
100    encoding-guesser.h. */
101 struct u8_istream *
102 u8_istream_for_fd (const char *fromcode, int fd)
103 {
104   struct u8_istream *is;
105   const char *encoding;
106
107   is = malloc (sizeof *is);
108   if (is == NULL)
109     return NULL;
110
111   is->fd = fd;
112   is->converter = (iconv_t) -1;
113   is->buffer = malloc (U8_ISTREAM_BUFFER_SIZE);
114   if (is->buffer == NULL)
115     goto error;
116   is->head = is->buffer;
117   is->length = 0;
118   is->outlen = 0;
119
120   if (fill_buffer (is) < 0)
121     goto error;
122
123   encoding = encoding_guess_head_encoding (fromcode, is->buffer, is->length);
124   if (is_encoding_utf8 (encoding))
125     is->state = S_UTF8;
126   else
127     {
128       if (encoding_guess_encoding_is_auto (fromcode)
129           && !strcmp (encoding, "ASCII"))
130         is->state = S_AUTO;
131       else
132         is->state = S_CONVERT;
133
134       is->converter = iconv_open ("UTF-8",
135                                   encoding_guess_parse_encoding (fromcode));
136       if (is->converter == (iconv_t) -1)
137         goto error;
138     }
139
140   return is;
141
142 error:
143   u8_istream_free (is);
144   return NULL;
145 }
146
147 /* Closes IS and its underlying file descriptor and frees all associated
148    resources.  Returns the return value from close(). */
149 int
150 u8_istream_close (struct u8_istream *is)
151 {
152   if (is != NULL)
153     {
154       int fd = is->fd;
155       u8_istream_free (is);
156       return close (fd);
157     }
158   return 0;
159 }
160
161 /* Frees IS and associated resources, but does not close the underlying file
162    descriptor.  (Thus, the client must close the file descriptor when it is no
163    longer needed.) */
164 void
165 u8_istream_free (struct u8_istream *is)
166 {
167   if (is != NULL)
168     {
169       if (is->converter != (iconv_t) -1)
170         iconv_close (is->converter);
171       free (is->buffer);
172       free (is);
173     }
174 }
175
176 static void
177 substitute_invalid_input_byte (struct u8_istream *is)
178 {
179   assert (is->outlen == 0);
180   is->head++;
181   is->length--;
182   is->outlen = u8_uctomb (CHAR_CAST (uint8_t *, is->outbuf),
183                           0xfffd, sizeof is->outbuf);
184 }
185
186 static ssize_t
187 fill_buffer (struct u8_istream *is)
188 {
189   ssize_t n;
190
191   /* Move any unused bytes to the beginning of the input buffer. */
192   if (is->length > 0 && is->buffer != is->head)
193     memmove (is->buffer, is->head, is->length);
194   is->head = is->buffer;
195
196   /* Read more input. */
197   do
198     {
199       n = read (is->fd, is->buffer + is->length,
200                 U8_ISTREAM_BUFFER_SIZE - is->length);
201     }
202   while (n < 0 && errno == EINTR);
203   if (n > 0)
204     is->length += n;
205   return n;
206 }
207
208 static ssize_t
209 read_auto (struct u8_istream *is, char *buffer, size_t size)
210 {
211   size_t original_size = size;
212   int retval = 0;
213
214   while (size > 0)
215     {
216       if (is->length > 0)
217         {
218           size_t n_ascii;
219
220           n_ascii = encoding_guess_count_ascii (is->head,
221                                                 MIN (is->length, size));
222
223           memcpy (buffer, is->head, n_ascii);
224           buffer += n_ascii;
225           size -= n_ascii;
226
227           is->head += n_ascii;
228           is->length -= n_ascii;
229
230           if (size == 0)
231             break;
232         }
233
234       if (is->length == 0)
235         {
236           retval = fill_buffer (is);
237           if (retval > 0)
238             continue;
239           else
240             break;
241         }
242
243       /* is->head points to a byte that isn't a printable ASCII character.
244          Fill up the buffer and check for UTF-8. */
245       fill_buffer (is);
246       is->state = (encoding_guess_tail_is_utf8 (is->head, is->length)
247                    ? S_UTF8 : S_CONVERT);
248       if (size == original_size)
249         return u8_istream_read (is, buffer, size);
250       break;
251     }
252
253   return original_size - size;
254 }
255
256 static int
257 convert_iconv (iconv_t converter,
258                char **inbufp, size_t *inbytesleft,
259                char **outbufp, size_t *outbytesleft)
260 {
261   size_t n = iconv (converter, (ICONV_CONST char **) inbufp, inbytesleft,
262                     outbufp, outbytesleft);
263   return n == SIZE_MAX ? errno : 0;
264 }
265
266 static int
267 convert_utf8 (iconv_t converter UNUSED,
268               char **inbufp, size_t *inbytesleft,
269               char **outbufp, size_t *outbytesleft)
270 {
271   const uint8_t *in = CHAR_CAST (const uint8_t *, *inbufp);
272   size_t n = MIN (*inbytesleft, *outbytesleft);
273   size_t ofs = 0;
274   int error;
275
276   for (;;)
277     {
278       ucs4_t uc;
279       int mblen;
280
281       if (ofs >= n)
282         {
283           error = ofs < *inbytesleft ? E2BIG : 0;
284           break;
285         }
286
287       mblen = u8_mbtouc (&uc, in + ofs, n - ofs);
288       if (uc == 0xfffd)
289         {
290           int retval = u8_mbtoucr (&uc, in + ofs, *inbytesleft - ofs);
291           if (retval == mblen)
292             {
293               /* There's an actual U+FFFD in the input stream.  Carry on. */
294             }
295           else
296             {
297               error = (retval == -1 ? EILSEQ
298                        : retval == -2 ? EINVAL
299                        : E2BIG);
300               break;
301             }
302         }
303
304       ofs += mblen;
305     }
306
307   if (ofs > 0)
308     {
309       memcpy (*outbufp, *inbufp, ofs);
310       *inbufp += ofs;
311       *inbytesleft -= ofs;
312       *outbufp += ofs;
313       *outbytesleft -= ofs;
314     }
315
316   return error;
317 }
318
319 static ssize_t
320 read_convert (struct u8_istream *is,
321               int (*convert) (iconv_t converter,
322                               char **inbufp, size_t *inbytesleft,
323                               char **outbufp, size_t *outbytesleft),
324               char *buffer, size_t size)
325 {
326   size_t original_size = size;
327
328   while (size > 0)
329     {
330       ssize_t n_read;
331
332       if (is->outlen > 0)
333         {
334           size_t n = MIN (size, is->outlen);
335
336           memcpy (buffer, is->outbuf, n);
337           is->outlen -= n;
338           if (is->outlen > 0)
339             memmove (is->outbuf, is->outbuf + n, is->outlen);
340
341           buffer += n;
342           size -= n;
343
344           if (size == 0)
345             break;
346         }
347
348       if (is->length)
349         {
350           int error = convert (is->converter,
351                                &is->head, &is->length,
352                                &buffer, &size);
353           if (size == 0)
354             break;
355
356           switch (error)
357             {
358             case 0:
359               /* Converted all of the input into output, possibly with space
360                  for output left over.
361
362                  Read more input. */
363               break;
364
365             case EILSEQ:
366               substitute_invalid_input_byte (is);
367               continue;
368
369             case EINVAL:
370               /* Incomplete byte sequence at end of input.  Read more
371                  input. */
372               break;
373
374             default:
375               /* A real error of some kind (ENOMEM?). */
376               return -1;
377
378             case E2BIG:
379               /* Ran out of room for output.
380                  Convert into outbuf and copy from there instead. */
381               {
382                 char *outptr = is->outbuf;
383                 size_t outleft = sizeof is->outbuf;
384
385                 error = convert (is->converter,
386                                  &is->head, &is->length,
387                                  &outptr, &outleft);
388                 is->outlen = outptr - is->outbuf;
389                 if (is->outlen > 0)
390                   continue;
391
392                 switch (error)
393                   {
394                   case EILSEQ:
395                     substitute_invalid_input_byte (is);
396                     continue;
397
398                   case E2BIG:
399                   case EINVAL:
400                     continue;
401
402                   default:
403                     /* A real error of some kind (ENOMEM?). */
404                     return -1;
405                   }
406               }
407             }
408         }
409
410       assert (is->length <= MB_LEN_MAX);
411       n_read = fill_buffer (is);
412       if (n_read <= 0)
413         {
414           if (original_size != size)
415             {
416               /* We produced some output so don't report EOF or error yet. */
417               break;
418             }
419           else if (n_read == 0 && is->length != 0)
420             {
421               /* Incomplete byte sequence at end of file. */
422               substitute_invalid_input_byte (is);
423             }
424           else
425             {
426               /* Propagate end-of-file or error to caller. */
427               return n_read;
428             }
429         }
430     }
431
432   return original_size - size;
433 }
434
435 /* Reads up to SIZE bytes of UTF-8 text from IS into BUFFER.  Returns the
436    number of bytes read if successful, 0 at end of file, or -1 if an error
437    occurred before any data could be read.  Upon error, sets errno to an
438    appropriate value. */
439 ssize_t
440 u8_istream_read (struct u8_istream *is, char *buffer, size_t size)
441 {
442   switch (is->state)
443     {
444     case S_CONVERT:
445       return read_convert (is, convert_iconv, buffer, size);
446
447     case S_AUTO:
448       return read_auto (is, buffer, size);
449
450     case S_UTF8:
451       return read_convert (is, convert_utf8, buffer, size);
452     }
453
454   NOT_REACHED ();
455 }
456
457 /* Returns the file descriptor underlying IS. */
458 int
459 u8_istream_fileno (const struct u8_istream *is)
460 {
461   return is->fd;
462 }
463 \f
464 /* Test functions.
465
466    These functions are probably useful only for white-box testing. */
467
468 /* Returns true if the encoding of the file being read by IS is not yet
469    known. */
470 bool
471 u8_istream_is_auto (const struct u8_istream *is)
472 {
473   return is->state == S_AUTO;
474 }
475
476 /* Returns true if the encoding of the file being read by IS has been
477    determined to be UTF-8. */
478 bool
479 u8_istream_is_utf8 (const struct u8_istream *is)
480 {
481   return is->state == S_UTF8;
482 }