* Bug #12140 fixed - csvRead fails when comma is used as decimal mark.
[scilab.git] / scilab / modules / spreadsheet / src / c / csvRead.c
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2010-2011 - DIGITEO - Allan CORNET
4  *
5  * This file must be used under the terms of the CeCILL.
6  * This source file is licensed as described in the file COPYING, which
7  * you should have received as part of this distribution.  The terms
8  * are also available at
9  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
10  *
11  */
12 #include <string.h>
13 #include <stdio.h>
14 #include "csvRead.h"
15 #include "MALLOC.h"
16 #include "freeArrayOfString.h"
17 #include "mopen.h"
18 #include "mgetl.h"
19 #include "localization.h"
20 #include "expandPathVariable.h"
21 #include "FileExist.h"
22 #include "mclose.h"
23 #include "warningmode.h"
24 #include "pcre_private.h"
25 #include "sciprint.h"
26 #include "splitLine.h"
27 #include "csv_strsubst.h"
28 #if _MSC_VER
29 #include "strdup_windows.h"
30 #endif
31 #include "csvDefault.h"
32 // =============================================================================
33 #if _MSC_VER
34 #define READ_ONLY_TEXT_MODE "rt"
35 #else
36 #define READ_ONLY_TEXT_MODE "r"
37 #endif
38 // =============================================================================
39 static int getNumbersOfColumnsInLines(const char **lines, int sizelines,
40                                       const char *separator);
41 static int getNumbersOfColumnsInLine(const char *line, const char *separator);
42 static char **getStringsFromLines(const char **lines, int sizelines,
43                                   const char *separator, const char *decimal,
44                                   int m, int n);
45 static char **removeEmptyLinesAtTheEnd(const char **lines, int *sizelines);
46 static char *stripCharacters(const char *line);
47 static char **replaceStrings(const char **lines, int nbLines, const char **toreplace, int sizetoreplace);
48 static char **extractComments(const char **lines, int nbLines, const char *regexpcomments, int *nbcomments, int *iErr);
49 static char **removeComments(const char **lines, int nbLines, const char *regexpcomments, int *nbNewLine, int *iErr);
50 static char **removeAllBlankLines(const char **lines, int *sizelines);
51 // =============================================================================
52 csvResult* csvRead(const char *filename, const char *separator, const char *decimal, const char **toreplace, int sizetoreplace, const char *regexpcomments)
53 {
54     char *expandedFilename = NULL;
55     csvResult *result = NULL;
56     int fd = 0;
57     int f_swap = 0;
58     double res = 0.0;
59     int errMOPEN = MOPEN_INVALID_STATUS;
60     int errMGETL = MGETL_ERROR;
61     double dErrClose = 0.;
62     char **lines = NULL;
63     int nblines = 0;
64     char **replacedInLines = NULL;
65     char **pComments = NULL;
66     int nbComments = 0;
67
68     if ((filename == NULL) || (separator == NULL) || (decimal == NULL))
69     {
70         return NULL;
71     }
72
73     expandedFilename = expandPathVariable((char*)filename);
74     if (!FileExist(expandedFilename))
75     {
76         result = (csvResult*)(MALLOC(sizeof(csvResult)));
77         if (result)
78         {
79             result->err = CSV_READ_FILE_NOT_EXIST;
80             result->m = 0;
81             result->n = 0;
82             result->pstrValues = NULL;
83             result->pstrComments = NULL;
84             result->nbComments = 0;
85         }
86         if (expandedFilename)
87         {
88             FREE(expandedFilename);
89             expandedFilename = NULL;
90         }
91         return result;
92     }
93
94     C2F(mopen)(&fd, expandedFilename, (char*)READ_ONLY_TEXT_MODE, &f_swap, &res, &errMOPEN);
95     if (expandedFilename)
96     {
97         FREE(expandedFilename);
98         expandedFilename = NULL;
99     }
100     if (errMOPEN != MOPEN_NO_ERROR)
101     {
102         result = (csvResult*)(MALLOC(sizeof(csvResult)));
103         if (result)
104         {
105             result->err = CSV_READ_MOPEN_ERROR;
106             result->m = 0;
107             result->n = 0;
108             result->pstrValues = NULL;
109             result->pstrComments = NULL;
110             result->nbComments = 0;
111
112         }
113         return result;
114     }
115
116     lines = mgetl(fd, -1, &nblines, &errMGETL);
117
118     C2F(mclose)(&fd, &dErrClose);
119
120     if (errMGETL != MGETL_NO_ERROR)
121     {
122         if (lines)
123         {
124             freeArrayOfString(lines, nblines);
125             lines = NULL;
126         }
127
128         result = (csvResult*)(MALLOC(sizeof(csvResult)));
129         if (result)
130         {
131             result->err = CSV_READ_READLINES_ERROR;
132             result->m = 0;
133             result->n = 0;
134             result->pstrValues = NULL;
135             result->pstrComments = NULL;
136             result->nbComments = 0;
137         }
138         return result;
139     }
140
141     if (regexpcomments)
142     {
143         int iErr = 0;
144
145         pComments = extractComments((const char**)lines, nblines, (const char*)regexpcomments, &nbComments, &iErr);
146
147         if ((iErr == CAN_NOT_COMPILE_PATTERN) || (iErr == DELIMITER_NOT_ALPHANUMERIC))
148         {
149             result = (csvResult*)(MALLOC(sizeof(csvResult)));
150             if (result)
151             {
152                 if ((iErr == CAN_NOT_COMPILE_PATTERN) || (iErr == DELIMITER_NOT_ALPHANUMERIC))
153                 {
154                     iErr = CSV_READ_REGEXP_ERROR;
155                 }
156                 result->err = (csvReadError)iErr;
157                 result->m = 0;
158                 result->n = 0;
159                 result->pstrValues = NULL;
160                 result->pstrComments = NULL;
161                 result->nbComments = 0;
162             }
163             return result;
164         }
165
166         if (pComments)
167         {
168             char **pCleanedLines = NULL;
169             int nbCleanedLines = 0;
170             int i = 0;
171
172             pCleanedLines = removeComments((const char**)lines, nblines, (const char*)regexpcomments, &nbCleanedLines, &iErr);
173             if (pCleanedLines)
174             {
175                 FREE(lines);
176                 lines = pCleanedLines;
177                 nblines = nbCleanedLines;
178             }
179
180         }
181     }
182
183     if (toreplace && (sizetoreplace > 0))
184     {
185         replacedInLines = replaceStrings((const char**)lines, nblines, toreplace, sizetoreplace);
186         if (replacedInLines)
187         {
188             freeArrayOfString(lines, nblines);
189             lines = replacedInLines;
190         }
191     }
192
193     result = csvTextScan((const char**)lines, nblines, (const char*)separator, (const char*)decimal);
194     if (lines)
195     {
196         freeArrayOfString(lines, nblines);
197         lines = NULL;
198     }
199
200     if (result)
201     {
202         result->pstrComments = pComments;
203         result->nbComments = nbComments;
204     }
205
206     return result;
207 }
208 // =============================================================================
209 csvResult* csvTextScan(const char **lines, int numberOfLines, const char *separator, const char *decimal)
210 {
211     csvResult *result = NULL;
212     int nbRows = 0;
213     int nbColumns = 0;
214     char **cellsStrings = NULL;
215     char **cleanedLines = NULL;
216     int nbLines = numberOfLines;
217
218     if (strcmp(separator, decimal) == 0)
219     {
220         result = (csvResult*)(MALLOC(sizeof(csvResult)));
221         if (result)
222         {
223             result->err = CSV_READ_SEPARATOR_DECIMAL_EQUAL;
224             result->m = 0;
225             result->n = 0;
226             result->pstrValues = NULL;
227             result->pstrComments = NULL;
228             result->nbComments = 0;
229         }
230         return result;
231     }
232
233     // ticket 472
234     {
235         const char *blankMode = getCsvDefaultCsvIgnoreBlankLine();
236         if (strcmp(blankMode, "on") == 0)
237         {
238             int nbLinesBackup = nbLines;
239             char **tmpLines = removeAllBlankLines(lines, &nbLines);
240             if (tmpLines)
241             {
242                 freeArrayOfString(cleanedLines, nbLines);
243                 cleanedLines = tmpLines;
244             }
245         }
246         else
247         {
248             /* remove last lines empty (bug 7003 in scilab)*/
249             cleanedLines = removeEmptyLinesAtTheEnd(lines, &nbLines);
250         }
251     }
252
253     nbColumns = getNumbersOfColumnsInLines((const char **)cleanedLines, nbLines, separator);
254     if (nbColumns == 0)
255     {
256         result = (csvResult*)(MALLOC(sizeof(csvResult)));
257         if (result)
258         {
259             result->err = CSV_READ_COLUMNS_ERROR;
260             result->m = 0;
261             result->n = 0;
262             result->pstrValues = NULL;
263             result->pstrComments = NULL;
264             result->nbComments = 0;
265         }
266         FREE(cleanedLines);
267         return result;
268     }
269     else
270     {
271         nbRows = nbLines;
272     }
273
274     cellsStrings = getStringsFromLines((const char **)cleanedLines, nbLines, separator, decimal, nbColumns, nbRows);
275     if (cleanedLines)
276     {
277         freeArrayOfString(cleanedLines, nbLines);
278         cleanedLines = NULL;
279     }
280
281     if (cellsStrings)
282     {
283         result = (csvResult*)(MALLOC(sizeof(csvResult)));
284         if (result)
285         {
286             result->err = CSV_READ_NO_ERROR;
287             result->m = nbRows;
288             result->n = nbColumns;
289             result->pstrValues = cellsStrings;
290             result->pstrComments = NULL;
291             result->nbComments = 0;
292         }
293         else
294         {
295             FREE(cellsStrings);
296         }
297     }
298     else
299     {
300         result = (csvResult*)(MALLOC(sizeof(csvResult)));
301         if (result)
302         {
303             result->err = CSV_READ_COLUMNS_ERROR;
304             result->m = 0;
305             result->n = 0;
306             result->pstrValues = NULL;
307             result->pstrComments = NULL;
308             result->nbComments = 0;
309         }
310     }
311     return result;
312 }
313 // =============================================================================
314 void freeCsvResult(csvResult *result)
315 {
316     if (result)
317     {
318         if (result->pstrValues)
319         {
320             freeArrayOfString(result->pstrValues, result->m * result->n);
321             result->pstrValues = NULL;
322         }
323         result->m = 0;
324         result->n = 0;
325
326         if (result->pstrComments)
327         {
328             freeArrayOfString(result->pstrComments, result->nbComments);
329             result->pstrComments = NULL;
330         }
331         result->err = CSV_READ_ERROR;
332         FREE(result);
333         result = NULL;
334     }
335 }
336 // =============================================================================
337 static int getNumbersOfColumnsInLines(const char **lines, int sizelines,
338                                       const char *separator)
339 {
340     int previousNbColumns = 0;
341     int NbColumns = 0;
342     BOOL firstLine = TRUE;
343     if (lines)
344     {
345         int i = 0;
346         for (i = 0; i < sizelines; i++)
347         {
348             NbColumns = getNumbersOfColumnsInLine(lines[i], separator);
349             if (firstLine)
350             {
351                 previousNbColumns = NbColumns;
352                 firstLine = FALSE;
353             }
354             else
355             {
356                 if (previousNbColumns != NbColumns)
357                 {
358                     if (getWarningMode())
359                     {
360                         sciprint(_("%s: Inconsistency found in the columns. At line %d, found %d columns while the previous had %d.\n"), "csvRead", i + 1, NbColumns, previousNbColumns);
361                     }
362
363                     return 0;
364                 }
365             }
366         }
367     }
368     return NbColumns;
369 }
370 // =============================================================================
371 static int getNumbersOfColumnsInLine(const char *line, const char *separator)
372 {
373     if (line && separator)
374     {
375         int i = 0;
376         int nbTokens = 0;
377         char **splittedStr = splitLineCSV(line, separator, &nbTokens, 0);
378         if (splittedStr)
379         {
380             freeArrayOfString(splittedStr, nbTokens);
381             return nbTokens;
382         }
383         else
384         {
385             int len = (int)strlen(line);
386             if (len > 0)
387             {
388                 nbTokens = 1;
389                 return nbTokens;
390             }
391         }
392     }
393     return 0;
394 }
395 // =============================================================================
396 static char **getStringsFromLines(const char **lines, int sizelines,
397                                   const char *separator,
398                                   const char *decimal,
399                                   int m, int n)
400 {
401     char **results = NULL;
402
403     if (lines == NULL)
404     {
405         return NULL;
406     }
407     if (separator == NULL)
408     {
409         return NULL;
410     }
411     if (m == 0 || n == 0)
412     {
413         return NULL;
414     }
415
416     results = (char**) MALLOC(sizeof(char*) * (m * n));
417     if (results)
418     {
419         int i = 0;
420         for (i = 0; i < sizelines; i++)
421         {
422             int nbTokens = 0;
423             char **lineStrings = splitLineCSV(lines[i], separator, &nbTokens, 0);
424             int j = 0;
425
426             if (lineStrings == NULL)
427             {
428                 lineStrings = (char**)MALLOC(sizeof(char*) * 1);
429                 lineStrings[0] = strdup(lines[i]);
430                 nbTokens = 1;
431             }
432
433             if (m != nbTokens)
434             {
435                 freeArrayOfString(results, nbTokens * n);
436                 FREE(lineStrings);
437                 return NULL;
438             }
439
440             for (j = 0; j < m; j++)
441             {
442
443                 if (!decimal)
444                 {
445                     results[i + n * j] = strdup(lineStrings[j]);
446                 }
447                 else
448                 {
449                     /* Proceed to the remplacement of the provided decimal to the default on
450                      * usually, it converts "," => "." */
451                     results[i + n * j] = csv_strsubst(lineStrings[j], decimal, getCsvDefaultDecimal());
452                 }
453
454                 if (lineStrings[j])
455                 {
456                     FREE(lineStrings[j]);
457                     lineStrings[j] = NULL;
458                 }
459             }
460         }
461     }
462     return results;
463 }
464 // =============================================================================
465 static char **removeEmptyLinesAtTheEnd(const char **lines, int *sizelines)
466 {
467     char **returnedLines = NULL;
468     int nbLinesToRemove = 0;
469
470     if (lines)
471     {
472         int i = 0;
473         if (*sizelines >= 1)
474         {
475             for (i = *sizelines - 1; i >= 0; i--)
476             {
477                 char *cleanedLine = stripCharacters(lines[i]);
478                 if (cleanedLine)
479                 {
480                     int len = (int) strlen(cleanedLine);
481                     FREE(cleanedLine);
482                     cleanedLine = NULL;
483                     if (len == 0)
484                     {
485                         nbLinesToRemove++;
486                         FREE((char*)lines[i]);
487                         lines[i] = NULL;
488                     }
489                     else
490                     {
491                         break;
492                     }
493                 }
494             }
495
496             if (nbLinesToRemove > 0)
497             {
498                 *sizelines = *sizelines - nbLinesToRemove;
499             }
500             returnedLines = (char **)MALLOC(sizeof(char *) * (*sizelines));
501             if (returnedLines)
502             {
503                 for (i = 0; i < *sizelines; i++)
504                 {
505                     returnedLines[i] = strdup(lines[i]);
506                 }
507             }
508         }
509     }
510
511     return returnedLines;
512 }
513 // =============================================================================
514 static char **removeAllBlankLines(const char **lines, int *sizelines)
515 {
516     char **returnedLines = NULL;
517     int nbLines = 0;
518     if (lines)
519     {
520         int i = 0;
521         for (i = 0; i < *sizelines; i++)
522         {
523             char *cleanedLine = stripCharacters(lines[i]);
524             if (cleanedLine)
525             {
526                 int len = (int) strlen(cleanedLine);
527                 FREE(cleanedLine);
528                 cleanedLine = NULL;
529                 if (len != 0)
530                 {
531                     if (nbLines == 0)
532                     {
533                         nbLines++;
534                         returnedLines = (char**)MALLOC(sizeof(char*) * nbLines);
535                     }
536                     else
537                     {
538                         nbLines++;
539                         returnedLines = (char**)REALLOC(returnedLines, sizeof(char*) * nbLines);
540                     }
541
542                     if (returnedLines)
543                     {
544                         returnedLines[nbLines - 1] = strdup(lines[i]);
545                     }
546                     else
547                     {
548                         *sizelines = 0;
549                         return NULL;
550                     }
551                 }
552             }
553         }
554         *sizelines = nbLines;
555     }
556     return returnedLines;
557 }
558 // =============================================================================
559 static char *stripCharacters(const char *line)
560 {
561     char *returnedLine = NULL;
562     if (line)
563     {
564         char *tmpLineWithoutTab = csv_strsubst((char*)line, "\t", "");
565         if (tmpLineWithoutTab)
566         {
567             char *tmpLineWithoutLF = csv_strsubst(tmpLineWithoutTab, "\r", "");
568             if (tmpLineWithoutLF)
569             {
570                 char *tmpLineWithoutCR = csv_strsubst(tmpLineWithoutTab, "\n", "");
571                 if (tmpLineWithoutCR)
572                 {
573                     returnedLine = csv_strsubst(tmpLineWithoutCR, " ", "");
574                 }
575                 else
576                 {
577                     returnedLine = strdup(line);
578                 }
579                 FREE(tmpLineWithoutLF);
580                 tmpLineWithoutLF = NULL;
581             }
582             else
583             {
584                 returnedLine = strdup(line);
585             }
586             FREE(tmpLineWithoutTab);
587             tmpLineWithoutTab = NULL;
588         }
589         else
590         {
591             returnedLine = strdup(line);
592         }
593     }
594
595     return returnedLine;
596 }
597 // =============================================================================
598 static char **replaceStrings(const char **lines, int nbLines, const char **toreplace, int sizetoreplace)
599 {
600     char **replacedStrings = NULL;
601     int nr = 0;
602
603     nr = sizetoreplace / 2;
604
605     if (lines)
606     {
607         int i = 0;
608
609         replacedStrings = (char**)MALLOC(sizeof(char*) * nbLines);
610         if (replacedStrings)
611         {
612             // Copy the source lines to the target replacedStrings.
613             int j = 0;
614             for (j = 0; j < nbLines; j++)
615             {
616                 replacedStrings[j] = strdup(lines[j]);
617             }
618             // Make replacements within the target replacedStrings.
619             for (i = 0; i < nr; i = i++)
620             {
621                 for (j = 0; j < nbLines; j++)
622                 {
623                     replacedStrings[j] = csv_strsubst(replacedStrings[j], toreplace[i], toreplace[nr + i]);
624                 }
625             }
626         }
627     }
628     return replacedStrings;
629 }
630 // =============================================================================
631 static char **extractComments(const char **lines, int nbLines,
632                               const char *regexpcomments, int *nbcomments, int *iErr)
633 {
634     char **pComments = NULL;
635     int i = 0;
636
637     for (i = 0; i < nbLines; i++)
638     {
639         int Output_Start = 0;
640         int Output_End = 0;
641         pcre_error_code answer = pcre_private((char*)lines[i], (char*)regexpcomments, &Output_Start, &Output_End, NULL, NULL);
642
643         if ( (answer == CAN_NOT_COMPILE_PATTERN) || (answer == DELIMITER_NOT_ALPHANUMERIC))
644         {
645             *nbcomments = 0;
646             *iErr = answer;
647             return NULL;
648         }
649         if ( answer == PCRE_FINISHED_OK )
650         {
651             (*nbcomments)++;
652             if (pComments == NULL)
653             {
654                 pComments = (char **)MALLOC(sizeof(char*) * (*nbcomments));
655             }
656             else
657             {
658                 pComments = (char **)REALLOC(pComments, sizeof(char*) * (*nbcomments));
659             }
660
661             if (pComments == NULL)
662             {
663                 *nbcomments = 0;
664                 *iErr = 1;
665                 return NULL;
666             }
667             pComments[(*nbcomments) - 1] = strdup(lines[i]);
668         }
669     }
670
671     return pComments;
672 }
673 // =============================================================================
674 static char **removeComments(const char **lines, int nbLines,
675                              const char *regexpcomments, int *newNbLines, int *iErr)
676 {
677     char **pLinesCleaned = NULL;
678
679     int i = 0;
680     *newNbLines = 0;
681
682     for (i = 0; i < nbLines; i++)
683     {
684         int Output_Start = 0;
685         int Output_End = 0;
686         pcre_error_code answer = pcre_private((char*)lines[i], (char*)regexpcomments, &Output_Start, &Output_End, NULL, NULL);
687         if ( answer == PCRE_FINISHED_OK )
688         {
689             FREE((char*)lines[i]);
690             lines[i] = NULL;
691         }
692         else
693         {
694             (*newNbLines)++;
695             if (pLinesCleaned == NULL)
696             {
697                 pLinesCleaned = (char **)MALLOC(sizeof(char*) * (*newNbLines));
698             }
699             else
700             {
701                 pLinesCleaned = (char **)REALLOC(pLinesCleaned, sizeof(char*) * (*newNbLines));
702             }
703
704             if (pLinesCleaned == NULL)
705             {
706                 *newNbLines = 0;
707                 *iErr = 1;
708                 return NULL;
709             }
710
711             pLinesCleaned[(*newNbLines) - 1] = (char*)lines[i];
712         }
713     }
714     return pLinesCleaned;
715 }
716 // =============================================================================