-
Notifications
You must be signed in to change notification settings - Fork 0
/
GedcomDecoder.cs
444 lines (362 loc) · 13.6 KB
/
GedcomDecoder.cs
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
using Ekmansoft.FamilyTree.Library.FamilyTreeStore;
using System;
using System.ComponentModel;
using System.Diagnostics;
namespace Ekmansoft.FamilyTree.Codec.Gedcom
{
public class GedcomDecoder : FamilyFileTypeBaseClass
{
private static TraceSource trace = new TraceSource("GedcomDecoder", SourceLevels.Warning);
private IFamilyTreeStoreBaseClass familyTree;
private BackgroundWorker backgroundWorker;
private int parsedLines;
private bool printMemory;
private FileBufferClass fileBuffer;
private GedcomLineStatus line;
private GedcomFileCharacterSet characterSet;
private FileImportResult importResult;
private MemoryClass memory;
private GedcomParserUtility parser;
public GedcomDecoder()
{
parser = new GedcomParserUtility();
trace.TraceData(TraceEventType.Information, 0, "Create");
}
public override void Dispose()
{
trace.TraceData(TraceEventType.Information, 0, "Dispose");
}
public override FileImportResult GetImportResult()
{
return importResult;
}
void DebugStringAdd(ref FileImportResult importResult, string str)
{
/*if (importResult == null)
{
importResult = "";
}*/
//importResult += str + "\n";
importResult.AddString(str);
trace.TraceInformation(str);
}
private bool ReadFile(String fileName, ref IFamilyTreeStoreBaseClass inFamilyTree)
{
printMemory = false;// true;
importResult = new FileImportResult();
DebugStringAdd(ref importResult, "GedcomDecoder::Readfile(" + fileName + ") Start " + DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"));
familyTree = inFamilyTree;
trace.TraceData(TraceEventType.Verbose, 0, familyTree.GetShortTreeInfo());
if (printMemory)
{
memory = new MemoryClass();
memory.PrintMemory();
}
fileBuffer = new FileBufferClass();
fileBuffer.ReadFile(fileName);
DebugStringAdd(ref importResult, "GedcomDecoder::Readfile() size " + fileBuffer.GetSize());
if (printMemory)
{
memory.PrintMemory();
}
String HeadString = "";
parsedLines = 0;
if (fileBuffer.GetSize() < 12)
{
importResult = line.GetDebugString();
DebugStringAdd(ref importResult, "gedcom file too small!: " + fileName + ", size:" + fileBuffer.GetSize());
importResult.WriteToFile(fileName);
return false;
}
Byte[] fileDataBuffer = fileBuffer.GetBuffer();
//DebugStringAdd(ref importResult, "");
string hdrStrText = "";
string linefeed = "";
bool linefeedFound = false;
for (int i = 0; i < 20; i++)
{
char ch = (char)fileDataBuffer[i];
//DebugStringAdd(ref importResult, fileDataBuffer[i].ToString());
HeadString += ch;
hdrStrText += ch.ToString() + " ";
if (!linefeedFound)
{
if ((ch == '\n') || (ch == '\r'))
{
linefeed += ch;
}
else if (linefeed.Length > 0)
{
linefeedFound = true;
}
}
}
//DebugStringAdd(ref importResult, "");
DebugStringAdd(ref importResult, "Header bytes: " + hdrStrText);
if (!linefeedFound)
{
DebugStringAdd(ref importResult, " Did not find proper linefeed!: " + fileName + ", size:" + fileBuffer.GetSize() + ":" + HeadString);
importResult.WriteToFile(fileName);
return false;
}
line = new GedcomLineStatus(ref importResult, linefeed);
if (HeadString.IndexOf("HEAD") < 0)
{
importResult = line.GetDebugString();
DebugStringAdd(ref importResult, "gedcom file header missing!: " + fileName + ", size:" + fileBuffer.GetSize() + ":" + HeadString);
importResult.WriteToFile(fileName);
return false;
}
familyTree.SetSourceFileType("GEDCOM");
if (printMemory)
{
memory.PrintMemory();
}
Parse(ref importResult);
if (printMemory)
{
memory.PrintMemory();
}
trace.TraceData(TraceEventType.Verbose, 0, familyTree.GetShortTreeInfo());
DebugStringAdd(ref importResult, "GedcomDecoder::Readfile() Done " + DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"));
importResult.WriteToFile(fileName);
return true;
}
private bool CheckBomMark(ref GedcomParserProgress progress, ref FileImportResult importResult)
{
Byte[] fileDataBuffer = fileBuffer.GetBuffer();
Byte[] UTF_8_BOM = { 0xEF, 0xBB, 0xBF };
Byte[] UTF_16BE_BOM = { 0xFE, 0xFF };
Byte[] UTF_16LE_BOM = { 0xFF, 0xFE };
bool match;
match = true;
for (int i = 0; match && (i < UTF_8_BOM.Length); i++)
{
if (UTF_8_BOM[i] != fileDataBuffer[i])
{
match = false;
}
}
if (match)
{
importResult.AddString("BOM says UTF-8!");
//trace.TraceInformation();
SetCharacterSet(GedcomFileCharacterSet.Utf8);
progress.position = UTF_8_BOM.Length;
return true;
}
match = true;
for (int i = 0; match && (i < UTF_16BE_BOM.Length); i++)
{
if (UTF_16BE_BOM[i] != fileDataBuffer[i])
{
match = false;
}
}
if (match)
{
importResult.AddString("BOM says UTF-8!");
//trace.TraceInformation("BOM says UTF-16-BE!");
SetCharacterSet(GedcomFileCharacterSet.Utf16BE);
progress.position = UTF_16BE_BOM.Length;
return true;
}
match = true;
for (int i = 0; match && (i < UTF_16LE_BOM.Length); i++)
{
if (UTF_16LE_BOM[i] != fileDataBuffer[i])
{
match = false;
}
}
if (match)
{
importResult.AddString("BOM says UTF-16-LE!");
//trace.TraceInformation("BOM says UTF-16-LE!");
SetCharacterSet(GedcomFileCharacterSet.Utf16LE);
progress.position = UTF_16LE_BOM.Length;
return true;
}
importResult.AddString("BOM not found!");
return false;
}
public void SetCharacterSet(GedcomFileCharacterSet inCharacterSet)
{
characterSet = inCharacterSet;
line.SetCharacterSet(inCharacterSet);
}
private void Parse(ref FileImportResult importResult)
{
bool bomFound = false;
GedcomLineObject rootLineObject = new GedcomLineObject(0);
GedcomParserProgress progress = new GedcomParserProgress(fileBuffer.GetBuffer(), fileBuffer.GetSize());
double lastPrintPercent = 0.0;
double printPercent;
GedcomLineObject currentLineObject = rootLineObject;
GedcomLineData prevLineData = null;
int lineDiff = 0;
uint lineLength;
//string importResult = "";
bomFound = CheckBomMark(ref progress, ref importResult);
GedcomTreeDecoderClass treeDecoder = new GedcomTreeDecoderClass(ref familyTree, ref importResult);
treeDecoder.SetCharacterSet(characterSet);
while (!progress.IsEndOfFile())
{
GedcomLineData lineData;
line.SetDebugString(importResult);
lineLength = line.ReadLine(ref progress);
lineData = line.DecodeLine();
importResult = line.GetDebugString();
parsedLines++;
if ((lineData != null) && lineData.valid)
{
if (lineData.level == (currentLineObject.GetLevel() + 1))
{
GedcomLineObject subLineObject = new GedcomLineObject(lineData.level);
subLineObject.parent = currentLineObject;
if (prevLineData != null)
{
prevLineData.child = subLineObject;
}
currentLineObject = subLineObject;
}
/*else if (currentLineObject.GetLevel() == lineData.level)
{
}*/
else if (lineData.level < currentLineObject.GetLevel())
{
bool decodeDone = false;
printPercent = 100.0 * (double)progress.position / (double)progress.size;
if ((printPercent - lastPrintPercent) > 0.10)
{
if (backgroundWorker != null)
{
backgroundWorker.ReportProgress((int)printPercent, "Working...");
}
lastPrintPercent = printPercent;
if (trace.Switch.Level.HasFlag(SourceLevels.Information))
{
trace.TraceInformation("Decode position 1 " + progress.position + " (" + progress.size + ") " + DateTime.Now.ToString());
trace.TraceInformation("Lines " + parsedLines + " (" + treeDecoder.GetDecodedLines() + ") " + printPercent.ToString("F") + "%");
trace.TraceData(TraceEventType.Verbose, 0, familyTree.GetShortTreeInfo());
//familyTree.PrintShort();
}
}
do
{
if (currentLineObject.parent != null)
{
currentLineObject = currentLineObject.parent;
if ((currentLineObject.GetLevel() == 0) && (parsedLines > 0))
{
treeDecoder.DecodeObject(currentLineObject);
currentLineObject.Clear();
if (treeDecoder.GetCharacterSet() != characterSet)
{
if (bomFound)
{
treeDecoder.DebugStringAdd("Warning! BOM and character set in Gedcom part mismatches! " + treeDecoder.GetCharacterSet() + "," + characterSet);
}
SetCharacterSet(treeDecoder.GetCharacterSet());
}
}
}
else
{
if ((parsedLines - 1) - treeDecoder.GetDecodedLines() - 1 > lineDiff)
{
treeDecoder.DebugStringAdd("Decode position " + progress.position + " (" + progress.size + ")");
treeDecoder.DebugStringAdd("Lines " + parsedLines + " (" + treeDecoder.GetDecodedLines() + "," + lineDiff + ")");
treeDecoder.DebugStringAdd("New undecoded lines: " + (parsedLines - treeDecoder.GetDecodedLines() - lineDiff) + "!");
lineDiff = parsedLines - treeDecoder.GetDecodedLines();
}
if (trace.Switch.Level.HasFlag(SourceLevels.Information))
{
trace.TraceInformation("Decode position 2 " + progress.position + " (" + progress.size + ")");
trace.TraceInformation("Lines " + parsedLines + " (" + treeDecoder.GetDecodedLines() + ")");
trace.TraceData(TraceEventType.Information, 0, familyTree.GetShortTreeInfo());
//familyTree.PrintShort();
}
currentLineObject.gedcomLines.Clear();
decodeDone = true;
}
} while ((currentLineObject.GetLevel() > lineData.level) && !decodeDone);
}
prevLineData = lineData;
currentLineObject.gedcomLines.Add(lineData);
}
else
{
if (lineData != null)
{
treeDecoder.DebugStringAdd("Line:" + lineData.lineNo + " Error bad gedcom line [" + lineData + "]");
}
else
{
treeDecoder.DebugStringAdd("Line: " + parsedLines + ": Error bad gedcom line:no data found ");
}
}
if (progress.IsEndOfFile())
{
treeDecoder.DecodeObject(currentLineObject);
if (treeDecoder.GetCharacterSet() != characterSet)
{
if (bomFound)
{
treeDecoder.DebugStringAdd("Warning! BOM and character set in Gedcom part mismatches! " + treeDecoder.GetCharacterSet() + "," + characterSet);
}
SetCharacterSet(treeDecoder.GetCharacterSet());
}
treeDecoder.DebugStringAdd("Line:" + lineData.lineNo + " end of file " + parsedLines);
if (lineData.level != 0)
{
treeDecoder.DebugStringAdd("Line:" + lineData.lineNo + "Error: The Gedcom file did not end correctly! Was it inomplete? = " + currentLineObject.gedcomLines.Count);
}
if (!treeDecoder.DecodingCompleted())
{
treeDecoder.DebugStringAdd("Line:" + lineData.lineNo + "Error: The Gedcom file did not end correctly! No trailer detected = " + currentLineObject.gedcomLines.Count);
}
treeDecoder.ShowUnknownTags();
}
}
backgroundWorker = null;
treeDecoder.DebugStringAdd("Gedcom file parsing finished at " + currentLineObject.gedcomLines.Count);
importResult = treeDecoder.GetImportResult();
}
public override bool IsKnownFileType(String fileName)
{
if (fileName.ToLower().Contains(".ged"))
{
return true;
}
return false;
}
public override IFamilyTreeStoreBaseClass CreateFamilyTreeStore(String fileName, CompletedCallback callback)
{
trace.TraceInformation("GedcomDecoder::CreateFamilyTreeStore( " + fileName + ")");
callback(true);
return null;
}
public override bool OpenFile(String fileName, ref IFamilyTreeStoreBaseClass inFamilyTree, CompletedCallback callback)
{
trace.TraceInformation("GedcomDecoder::OpenFile( " + fileName + ")");
bool result = ReadFile(fileName, ref inFamilyTree);
callback(result);
return result;
}
public override bool SetProgressTarget(BackgroundWorker inBackgroundWorker)
{
trace.TraceInformation("GedcomCodec::SetProgressTarget 2");
backgroundWorker = inBackgroundWorker;
return true;
}
public override string GetFileTypeFilter(FamilyFileTypeOperation operation = FamilyFileTypeOperation.Open)
{
if (operation == FamilyFileTypeOperation.Import)
{
return "Gedcom|*.ged";
}
return null;
}
}
}