/
SPExportInitializer.m
589 lines (467 loc) · 21.8 KB
/
SPExportInitializer.m
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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
//
// SPExportInitializer.m
// sequel-pro
//
// Created by Stuart Connolly (stuconnolly.com) on March 31, 2010.
// Copyright (c) 2010 Stuart Connolly. All rights reserved.
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
//
// More info at <https://github.com/sequelpro/sequelpro>
#import "SPExportInitializer.h"
#import "SPTableData.h"
#import "SPDatabaseDocument.h"
#import "SPTablesList.h"
#import "SPGrowlController.h"
#import "SPDatabaseDocument.h"
#import "SPCustomQuery.h"
#import "SPAlertSheets.h"
#import "SPTableContent.h"
#import "SPCSVExporter.h"
#import "SPSQLExporter.h"
#import "SPXMLExporter.h"
#import "SPDotExporter.h"
#import "SPExportFile.h"
#import "SPExportFileUtilities.h"
#import "SPExportFilenameUtilities.h"
#import "SPExportFileNameTokenObject.h"
#import "SPConnectionControllerDelegateProtocol.h"
#import <SPMySQL/SPMySQL.h>
@implementation SPExportController (SPExportInitializer)
/**
* Starts the export process by placing the first exporter on the operation queue. Also opens the progress
* sheet if it's not already visible.
*/
- (void)startExport
{
// Start progress indicator
[exportProgressTitle setStringValue:[NSString stringWithFormat:NSLocalizedString(@"Exporting %@", @"text showing that the application is importing a supplied format"), exportTypeLabel]];
[exportProgressText setStringValue:NSLocalizedString(@"Writing...", @"text showing that app is writing text file")];
[exportProgressIndicator setUsesThreadedAnimation:NO];
[exportProgressIndicator setIndeterminate:NO];
[exportProgressIndicator setDoubleValue:0];
// If it's not already displayed, open the progress sheet open the progress sheet.
if (![exportProgressWindow isVisible]) {
[NSApp beginSheet:exportProgressWindow
modalForWindow:[tableDocumentInstance parentWindow]
modalDelegate:self
didEndSelector:nil
contextInfo:nil];
}
// If using an export type that requires the connection to start in UTF8, cache the current connection
// encoding and then set it here.
if (exportType == SPSQLExport || exportType == SPDotExport) {
previousConnectionEncoding = [[NSString alloc] initWithString:[connection encoding]];
previousConnectionEncodingViaLatin1 = [connection encodingUsesLatin1Transport];
[tableDocumentInstance setConnectionEncoding:@"utf8" reloadingViews:NO];
}
// Add the first exporter to the operation queue
[operationQueue addOperation:[exporters objectAtIndex:0]];
// Remove the exporter we just added to the operation queue from our list of exporters
// so we know it's already been done.
[exporters removeObjectAtIndex:0];
}
/**
* Initializes the export process by analysing the selected criteria.
*/
- (void)initializeExportUsingSelectedOptions
{
NSArray *dataArray = nil;
// Get rid of the cached connection encoding
if (previousConnectionEncoding) [previousConnectionEncoding release], previousConnectionEncoding = nil;
createCustomFilename = ([[exportCustomFilenameTokenField stringValue] length] > 0);
NSMutableArray *exportTables = [NSMutableArray array];
// Set whether or not we are to export to multiple files
[self setExportToMultipleFiles:[exportFilePerTableCheck state]];
// Get the data depending on the source
switch (exportSource)
{
case SPFilteredExport:
dataArray = [tableContentInstance currentDataResultWithNULLs:YES hideBLOBs:NO];
break;
case SPQueryExport:
dataArray = [customQueryInstance currentDataResultWithNULLs:YES truncateDataFields:NO];
break;
case SPTableExport:
// Create an array of tables to export
for (NSMutableArray *table in tables)
{
if (exportType == SPSQLExport) {
if ([[table objectAtIndex:1] boolValue] || [[table objectAtIndex:2] boolValue] || [[table objectAtIndex:3] boolValue]) {
// Check the overall export settings
if ([[table objectAtIndex:1] boolValue] && (![exportSQLIncludeStructureCheck state])) {
[table replaceObjectAtIndex:1 withObject:[NSNumber numberWithBool:NO]];
}
if ([[table objectAtIndex:2] boolValue] && (![exportSQLIncludeContentCheck state])) {
[table replaceObjectAtIndex:2 withObject:[NSNumber numberWithBool:NO]];
}
if ([[table objectAtIndex:3] boolValue] && (![exportSQLIncludeDropSyntaxCheck state])) {
[table replaceObjectAtIndex:3 withObject:[NSNumber numberWithBool:NO]];
}
[exportTables addObject:table];
}
}
else if (exportType == SPDotExport) {
[exportTables addObject:[table objectAtIndex:0]];
}
else {
if ([[table objectAtIndex:2] boolValue]) {
[exportTables addObject:[table objectAtIndex:0]];
}
}
}
break;
}
// Set the export type label
switch (exportType)
{
case SPSQLExport:
exportTypeLabel = @"SQL";
break;
case SPCSVExport:
exportTypeLabel = @"CSV";
break;
case SPXMLExport:
exportTypeLabel = @"XML";
break;
case SPDotExport:
exportTypeLabel = @"Dot";
break;
}
// Begin the export based on the source
switch (exportSource)
{
case SPFilteredExport:
case SPQueryExport:
[self exportTables:nil orDataArray:dataArray];
break;
case SPTableExport:
[self exportTables:exportTables orDataArray:nil];
break;
}
}
/**
* Exports the contents of the supplied array of tables or data array.
*
* Note that at least one of these parameters must not be nil.
*
* @param exportTables An array of table/view names to be exported (can be nil).
* @param dataArray A MySQL result set array to be exported (can be nil).
*/
- (void)exportTables:(NSArray *)exportTables orDataArray:(NSArray *)dataArray
{
BOOL singleFileHandleSet = NO;
SPExportFile *singleExportFile = nil, *file = nil;
// Change query logging mode
[tableDocumentInstance setQueryMode:SPImportExportQueryMode];
// Start the notification timer to allow notifications to be shown even if frontmost for long queries
[[SPGrowlController sharedGrowlController] setVisibilityForNotificationName:@"Export Finished"];
// Setup the progress sheet
[exportProgressTitle setStringValue:[NSString stringWithFormat:NSLocalizedString(@"Exporting %@", @"text showing that the application is importing a supplied format"), exportTypeLabel]];
[exportProgressText setStringValue:NSLocalizedString(@"Initializing...", @"initializing export label")];
[exportProgressIndicator setIndeterminate:YES];
[exportProgressIndicator setUsesThreadedAnimation:YES];
// Open the progress sheet
[NSApp beginSheet:exportProgressWindow
modalForWindow:[tableDocumentInstance parentWindow]
modalDelegate:self
didEndSelector:nil
contextInfo:nil];
// CSV export
if (exportType == SPCSVExport) {
SPCSVExporter *csvExporter = nil;
// If the user has selected to only export to a single file or this is a filtered or custom query
// export, create the single file now and assign it to all subsequently created exporters.
if ((![self exportToMultipleFiles]) || (exportSource == SPFilteredExport) || (exportSource == SPQueryExport)) {
NSString *selectedTableName = nil;
if (exportSource == SPTableExport && [exportTables count] == 1) selectedTableName = [exportTables objectAtIndex:0];
[exportFilename setString:createCustomFilename ? [self expandCustomFilenameFormatUsingTableName:selectedTableName] : [self generateDefaultExportFilename]];
// Only append the extension if necessary
if (![[exportFilename pathExtension] length]) {
[exportFilename setString:[exportFilename stringByAppendingPathExtension:[self currentDefaultExportFileExtension]]];
}
singleExportFile = [SPExportFile exportFileAtPath:[[exportPathField stringValue] stringByAppendingPathComponent:exportFilename]];
}
// Start the export process depending on the data source
if (exportSource == SPTableExport) {
// Cache the number of tables being exported
exportTableCount = [exportTables count];
// Loop through the tables, creating an exporter for each
for (NSString *table in exportTables)
{
csvExporter = [self initializeCSVExporterForTable:table orDataArray:nil];
// If required create a single file handle for all CSV exports
if (![self exportToMultipleFiles]) {
if (!singleFileHandleSet) {
[singleExportFile setExportFileNeedsCSVHeader:YES];
[exportFiles addObject:singleExportFile];
singleFileHandleSet = YES;
}
[csvExporter setExportOutputFile:singleExportFile];
}
[exporters addObject:csvExporter];
}
}
else {
csvExporter = [self initializeCSVExporterForTable:nil orDataArray:dataArray];
[exportFiles addObject:singleExportFile];
[csvExporter setExportOutputFile:singleExportFile];
[exporters addObject:csvExporter];
}
}
// SQL export
else if (exportType == SPSQLExport) {
// Cache the number of tables being exported
exportTableCount = [exportTables count];
SPSQLExporter *sqlExporter = [[SPSQLExporter alloc] initWithDelegate:self];
[sqlExporter setSqlDatabaseHost:[tableDocumentInstance host]];
[sqlExporter setSqlDatabaseName:[tableDocumentInstance database]];
[sqlExporter setSqlDatabaseVersion:[tableDocumentInstance mySQLVersion]];
[sqlExporter setSqlOutputIncludeUTF8BOM:[exportUseUTF8BOMButton state]];
[sqlExporter setSqlOutputEncodeBLOBasHex:[exportSQLBLOBFieldsAsHexCheck state]];
[sqlExporter setSqlOutputIncludeErrors:[exportSQLIncludeErrorsCheck state]];
[sqlExporter setSqlOutputIncludeAutoIncrement:([exportSQLIncludeStructureCheck state] && [exportSQLIncludeAutoIncrementValueButton state])];
[sqlExporter setSqlInsertAfterNValue:[exportSQLInsertNValueTextField integerValue]];
[sqlExporter setSqlInsertDivider:[exportSQLInsertDividerPopUpButton indexOfSelectedItem]];
[sqlExporter setSqlExportTables:exportTables];
// Create custom filename if required
[exportFilename setString:(createCustomFilename) ? [self expandCustomFilenameFormatUsingTableName:nil] : [self generateDefaultExportFilename]];
// Only append the extension if necessary
if (![[exportFilename pathExtension] length]) {
[exportFilename setString:[exportFilename stringByAppendingPathExtension:[self currentDefaultExportFileExtension]]];
}
file = [SPExportFile exportFileAtPath:[[exportPathField stringValue] stringByAppendingPathComponent:exportFilename]];
[exportFiles addObject:file];
[sqlExporter setExportOutputFile:file];
[exporters addObject:sqlExporter];
[sqlExporter release];
}
// XML export
else if (exportType == SPXMLExport) {
SPXMLExporter *xmlExporter = nil;
// If the user has selected to only export to a single file or this is a filtered or custom query
// export, create the single file now and assign it to all subsequently created exporters.
if ((![self exportToMultipleFiles]) || (exportSource == SPFilteredExport) || (exportSource == SPQueryExport)) {
NSString *selectedTableName = nil;
if (exportSource == SPTableExport && [exportTables count] == 1) selectedTableName = [exportTables objectAtIndex:0];
[exportFilename setString:(createCustomFilename) ? [self expandCustomFilenameFormatUsingTableName:selectedTableName] : [self generateDefaultExportFilename]];
// Only append the extension if necessary
if (![[exportFilename pathExtension] length]) {
[exportFilename setString:[exportFilename stringByAppendingPathExtension:[self currentDefaultExportFileExtension]]];
}
singleExportFile = [SPExportFile exportFileAtPath:[[exportPathField stringValue] stringByAppendingPathComponent:exportFilename]];
}
// Start the export process depending on the data source
if (exportSource == SPTableExport) {
// Cache the number of tables being exported
exportTableCount = [exportTables count];
// Loop through the tables, creating an exporter for each
for (NSString *table in exportTables)
{
xmlExporter = [self initializeXMLExporterForTable:table orDataArray:nil];
// If required create a single file handle for all XML exports
if (![self exportToMultipleFiles]) {
if (!singleFileHandleSet) {
[singleExportFile setExportFileNeedsXMLHeader:YES];
[exportFiles addObject:singleExportFile];
singleFileHandleSet = YES;
}
[xmlExporter setExportOutputFile:singleExportFile];
}
[exporters addObject:xmlExporter];
}
}
else {
xmlExporter = [self initializeXMLExporterForTable:nil orDataArray:dataArray];
[singleExportFile setExportFileNeedsXMLHeader:YES];
[exportFiles addObject:singleExportFile];
[xmlExporter setExportOutputFile:singleExportFile];
[exporters addObject:xmlExporter];
}
}
// Dot export
else if (exportType == SPDotExport) {
// Cache the number of tables being exported
exportTableCount = [exportTables count];
SPDotExporter *dotExporter = [[SPDotExporter alloc] initWithDelegate:self];
[dotExporter setDotTableData:tableDataInstance];
[dotExporter setDotForceLowerTableNames:[exportDotForceLowerTableNamesCheck state]];
[dotExporter setDotDatabaseHost:[tableDocumentInstance host]];
[dotExporter setDotDatabaseName:[tableDocumentInstance database]];
[dotExporter setDotDatabaseVersion:[tableDocumentInstance mySQLVersion]];
[dotExporter setDotExportTables:exportTables];
// Create custom filename if required
if (createCustomFilename) {
[exportFilename setString:[self expandCustomFilenameFormatUsingTableName:nil]];
}
else {
[exportFilename setString:[tableDocumentInstance database]];
}
// Only append the extension if necessary
if (![[exportFilename pathExtension] length]) {
[exportFilename setString:[exportFilename stringByAppendingPathExtension:[self currentDefaultExportFileExtension]]];
}
file = [SPExportFile exportFileAtPath:[[exportPathField stringValue] stringByAppendingPathComponent:exportFilename]];
[exportFiles addObject:file];
[dotExporter setExportOutputFile:file];
[exporters addObject:dotExporter];
[dotExporter release];
}
// For each of the created exporters, set their generic properties
for (SPExporter *exporter in exporters)
{
[exporter setConnection:connection];
[exporter setExportOutputEncoding:[connection stringEncoding]];
[exporter setExportMaxProgress:(NSInteger)[exportProgressIndicator bounds].size.width];
[exporter setExportUsingLowMemoryBlockingStreaming:[exportProcessLowMemoryButton state]];
[exporter setExportOutputCompressionFormat:(SPFileCompressionFormat)[exportOutputCompressionFormatPopupButton indexOfSelectedItem]];
[exporter setExportOutputCompressFile:([exportOutputCompressionFormatPopupButton indexOfSelectedItem] != SPNoCompression)];
}
NSMutableArray *problemFiles = [[NSMutableArray alloc] init];
// Create the actual file handles while dealing with errors (e.g. file already exists, etc) during creation
for (SPExportFile *exportFile in exportFiles)
{
if ([exportFile createExportFileHandle:NO] == SPExportFileHandleCreated) {
[exportFile setCompressionFormat:(SPFileCompressionFormat)[exportOutputCompressionFormatPopupButton indexOfSelectedItem]];
if ([exportFile exportFileNeedsCSVHeader]) {
[self writeCSVHeaderToExportFile:exportFile];
}
else if ([exportFile exportFileNeedsXMLHeader]) {
[self writeXMLHeaderToExportFile:exportFile];
}
}
else {
[problemFiles addObject:exportFile];
}
}
// Deal with any file handles that we failed to create for whatever reason
if ([problemFiles count] > 0) {
[self errorCreatingExportFileHandles:problemFiles];
}
else {
[self startExport];
}
[problemFiles release];
}
/**
* Initialises a CSV exporter for the supplied table name or data array.
*
* @param table The table name for which the exporter should be cerated for (can be nil).
* @param dataArray The MySQL result data array for which the exporter should be created for (can be nil).
*/
- (SPCSVExporter *)initializeCSVExporterForTable:(NSString *)table orDataArray:(NSArray *)dataArray
{
SPCSVExporter *csvExporter = [[SPCSVExporter alloc] initWithDelegate:self];
// Depeding on the export source, set the table name or data array
if (exportSource == SPTableExport) {
[csvExporter setCsvTableName:table];
}
else {
[csvExporter setCsvDataArray:dataArray];
}
[csvExporter setCsvTableData:tableDataInstance];
[csvExporter setCsvOutputFieldNames:[exportCSVIncludeFieldNamesCheck state]];
[csvExporter setCsvFieldSeparatorString:[exportCSVFieldsTerminatedField stringValue]];
[csvExporter setCsvEnclosingCharacterString:[exportCSVFieldsWrappedField stringValue]];
[csvExporter setCsvLineEndingString:[exportCSVLinesTerminatedField stringValue]];
[csvExporter setCsvEscapeString:[exportCSVFieldsEscapedField stringValue]];
[csvExporter setCsvNULLString:[exportCSVNULLValuesAsTextField stringValue]];
// If required create separate files
if (exportSource == SPTableExport && [self exportToMultipleFiles]) {
if (createCustomFilename) {
// Create custom filename based on the selected format
[exportFilename setString:[self expandCustomFilenameFormatUsingTableName:table]];
// If the user chose to use a custom filename format and we exporting to multiple files, make
// sure the table name is included to ensure the output files are unique.
if (exportTableCount > 1) {
BOOL tableNameInTokens = NO;
NSArray *representedObjects = [exportCustomFilenameTokenField objectValue];
for (id representedObject in representedObjects) {
if ([representedObject isKindOfClass:[SPExportFileNameTokenObject class]] && [[representedObject tokenContent] isEqualToString:NSLocalizedString(@"table", @"table")]) tableNameInTokens = YES;
}
[exportFilename setString:(tableNameInTokens ? exportFilename : [exportFilename stringByAppendingFormat:@"_%@", table])];
}
}
else {
[exportFilename setString:(dataArray) ? [tableDocumentInstance database] : table];
}
// Only append the extension if necessary
if (![[exportFilename pathExtension] length]) {
[exportFilename setString:[exportFilename stringByAppendingPathExtension:[self currentDefaultExportFileExtension]]];
}
SPExportFile *file = [SPExportFile exportFileAtPath:[[exportPathField stringValue] stringByAppendingPathComponent:exportFilename]];
[exportFiles addObject:file];
[csvExporter setExportOutputFile:file];
}
return [csvExporter autorelease];
}
/**
* Initialises a XML exporter for the supplied table name or data array.
*
* @param table The table name for which the exporter should be cerated for (can be nil).
* @param dataArray The MySQL result data array for which the exporter should be created for (can be nil).
*/
- (SPXMLExporter *)initializeXMLExporterForTable:(NSString *)table orDataArray:(NSArray *)dataArray
{
SPXMLExporter *xmlExporter = [[SPXMLExporter alloc] initWithDelegate:self];
// if required set the data array
if (exportSource != SPTableExport) {
[xmlExporter setXmlDataArray:dataArray];
}
// Regardless of the export source, set exporter's table name as it's used in the output
// of table and table content exports.
[xmlExporter setXmlTableName:table];
[xmlExporter setXmlFormat:[exportXMLFormatPopUpButton indexOfSelectedItem]];
[xmlExporter setXmlOutputIncludeStructure:[exportXMLIncludeStructure state]];
[xmlExporter setXmlOutputIncludeContent:[exportXMLIncludeContent state]];
[xmlExporter setXmlNULLString:[exportXMLNULLValuesAsTextField stringValue]];
// If required create separate files
if ((exportSource == SPTableExport) && exportToMultipleFiles && (exportTableCount > 0)) {
if (createCustomFilename) {
// Create custom filename based on the selected format
[exportFilename setString:[self expandCustomFilenameFormatUsingTableName:table]];
// If the user chose to use a custom filename format and we exporting to multiple files, make
// sure the table name is included to ensure the output files are unique.
if (exportTableCount > 1) {
BOOL tableNameInTokens = NO;
NSArray *representedObjects = [exportCustomFilenameTokenField objectValue];
for (id representedObject in representedObjects) {
if ([representedObject isKindOfClass:[SPExportFileNameTokenObject class]] && [[representedObject tokenContent] isEqualToString:NSLocalizedString(@"table", @"table")]) tableNameInTokens = YES;
}
[exportFilename setString:(tableNameInTokens ? exportFilename : [exportFilename stringByAppendingFormat:@"_%@", table])];
}
}
else {
[exportFilename setString:(dataArray) ? [tableDocumentInstance database] : table];
}
// Only append the extension if necessary
if (![[exportFilename pathExtension] length]) {
[exportFilename setString:[exportFilename stringByAppendingPathExtension:[self currentDefaultExportFileExtension]]];
}
SPExportFile *file = [SPExportFile exportFileAtPath:[[exportPathField stringValue] stringByAppendingPathComponent:exportFilename]];
[file setExportFileNeedsXMLHeader:YES];
[exportFiles addObject:file];
[xmlExporter setExportOutputFile:file];
}
return [xmlExporter autorelease];
}
@end