-
Notifications
You must be signed in to change notification settings - Fork 21
/
export.php
1413 lines (1131 loc) · 51.1 KB
/
export.php
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
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
if ( ! class_exists( 'GFForms' ) ) {
die();
}
class GFExport {
private static $min_import_version = '1.3.12.3';
/**
* Process the forms export request.
*/
public static function maybe_export() {
if ( isset( $_POST['export_forms'] ) ) {
check_admin_referer( 'gf_export_forms', 'gf_export_forms_nonce' );
$selected_forms = rgpost( 'gf_form_id' );
if ( empty( $selected_forms ) ) {
GFCommon::add_error_message( __( 'Please select the forms to be exported', 'gravityforms' ) );
return;
}
self::export_forms( $selected_forms );
}
}
public static function export_forms( $form_ids ) {
$forms = GFFormsModel::get_form_meta_by_id( $form_ids );
$forms = self::prepare_forms_for_export( $forms );
$forms['version'] = GFForms::$version;
$forms_json = json_encode( $forms );
/**
* Allows the form export filename to be changed.
*
* @since 2.3.4
*
* @param string $filename The new filename to use for the export file.
* @param array $form_ids Array containing the IDs of forms selected for export.
*/
$filename = apply_filters( 'gform_form_export_filename', 'gravityforms-export-' . date( 'Y-m-d' ), $form_ids ) . '.json';
$filename = sanitize_file_name( $filename );
header( 'Content-Description: File Transfer' );
header( "Content-Disposition: attachment; filename=$filename" );
header( 'Content-Type: application/json; charset=' . get_option( 'blog_charset' ), true );
$buffer_length = ob_get_length(); // length or false if no buffer.
if ( $buffer_length > 1 ) {
ob_clean();
}
echo $forms_json;
die();
}
public static function export_page() {
if ( ! GFCommon::ensure_wp_version() ) {
return;
}
$view = rgget( 'subview' ) ? rgget( 'subview' ) : 'export_entry';
switch ( $view ) {
case 'export_entry':
self::export_lead_page();
break;
case 'import_form' :
self::import_form_page();
break;
case 'export_form' :
self::export_form_page();
break;
default:
/**
* Fires when export pages are gathered
*
* Used to add additional export settings pages
*
* @param string $view Set when defining the action string. Creates the name for the new page
*/
do_action( "gform_export_page_{$view}" );
break;
}
}
public static function import_file( $filepath, &$forms = null ) {
$file_contents = file_get_contents( $filepath );
if ( GFCommon::safe_substr( $file_contents, 0, 38 ) == '<?xml version="1.0" encoding="UTF-8"?>' ) {
return self::import_xml( $file_contents, $forms );
}
return self::import_json( $file_contents, $forms );
}
public static function import_json( $forms_json, &$forms = null ) {
$forms_json = self::sanitize_forms_json( $forms_json );
$forms = json_decode( $forms_json, true );
if ( ! $forms ) {
GFCommon::log_debug( __METHOD__ . '(): Import Failed. Invalid form objects.' );
return 0;
} else if ( ! rgar( $forms, 'version' ) || version_compare( $forms['version'], self::$min_import_version, '<' ) ) {
GFCommon::log_debug( __METHOD__ . '(): Import Failed. The JSON version is not compatible with the current Gravity Forms version.' );
return - 1;
} //Error. JSON version is not compatible with current Gravity Forms version
$simplified_version = implode( '.', array_slice( preg_split( '/[.-]/', $forms['version'] ), 0, 2 ) );
if ( version_compare( 2.5, $simplified_version ) ) {
$markup_version = 1;
} else {
$markup_version = 2;
}
GFCache::delete( 'legacy_is_in_use' );
unset( $forms['version'] );
$clean_forms = array();
foreach ( $forms as $form ) {
$form['markupVersion'] = rgar( $form, 'markupVersion' ) ? $form['markupVersion'] : $markup_version;
$form = GFFormsModel::convert_field_objects( $form );
$clean_forms[] = GFFormsModel::sanitize_settings( $form );
}
$form_ids = GFAPI::add_forms( $clean_forms );
if ( is_wp_error( $form_ids ) ) {
GFCommon::log_debug( __METHOD__ . '(): Import Failed => ' . print_r( $form_ids, 1 ) );
$form_ids = array();
} else {
foreach ( $form_ids as $key => $form_id ) {
$forms[ $key ] = GFAPI::get_form( $form_id );
}
/**
* Fires after forms have been imported.
*
* Used to perform additional actions after import
*
* @param array $forms An array imported form objects.
*
*/
do_action( 'gform_forms_post_import', $forms );
}
return sizeof( $form_ids );
}
/**
* Removes any extraneous strings from the begining of the JSON file to be imported.
*
* @since 2.5.16
*
* @param string $forms_json Exported form JSON to be sanitized.
*
* @return string Sanitized JSON string.
*/
public static function sanitize_forms_json( $forms_json ) {
// Remove any whitespace from before and after the JSON.
$forms_json = trim( $forms_json );
// Remove any characters before the beginning of the JSON string.
if ( preg_match( '/{\s*"\d"\s*:\s*{/', $forms_json, $matches, PREG_OFFSET_CAPTURE ) ) {
$forms_json = substr( $forms_json, $matches[0][1] );
}
return $forms_json;
}
// This function is not deprecated as of 1.9 because it will still be needed for a while to import legacy XML files without generating deprecation notices.
// However, XML is not used to export Forms so this function will soon be deprecated.
public static function import_xml( $xmlstr, &$forms = null ) {
require_once( 'xml.php' );
$options = array(
'page' => array( 'unserialize_as_array' => true ),
'form' => array( 'unserialize_as_array' => true ),
'field' => array( 'unserialize_as_array' => true ),
'rule' => array( 'unserialize_as_array' => true ),
'choice' => array( 'unserialize_as_array' => true ),
'input' => array( 'unserialize_as_array' => true ),
'routing_item' => array( 'unserialize_as_array' => true ),
'creditCard' => array( 'unserialize_as_array' => true ),
'routin' => array( 'unserialize_as_array' => true ), //routin is for backwards compatibility
'confirmation' => array( 'unserialize_as_array' => true ),
'notification' => array( 'unserialize_as_array' => true ),
);
$options = apply_filters( 'gform_import_form_xml_options', $options );
$xml = new RGXML( $options );
$forms = $xml->unserialize( $xmlstr );
if ( ! $forms ) {
return 0;
} //Error. could not unserialize XML file
else if ( version_compare( $forms['version'], self::$min_import_version, '<' ) ) {
return - 1;
} //Error. XML version is not compatible with current Gravity Forms version
//cleaning up generated object
self::cleanup( $forms );
foreach ( $forms as $key => &$form ) {
$title = $form['title'];
$count = 2;
while ( ! RGFormsModel::is_unique_title( $title ) ) {
$title = $form['title'] . "($count)";
$count ++;
}
//inserting form
$form_id = RGFormsModel::insert_form( $title );
//updating form meta
$form['title'] = $title;
$form['id'] = $form_id;
$form = GFFormsModel::trim_form_meta_values( $form );
if ( isset( $form['confirmations'] ) ) {
$form['confirmations'] = self::set_property_as_key( $form['confirmations'], 'id' );
$form['confirmations'] = GFFormsModel::trim_conditional_logic_values( $form['confirmations'], $form );
GFFormsModel::update_form_meta( $form_id, $form['confirmations'], 'confirmations' );
unset( $form['confirmations'] );
}
if ( isset( $form['notifications'] ) ) {
$form['notifications'] = self::set_property_as_key( $form['notifications'], 'id' );
$form['notifications'] = GFFormsModel::trim_conditional_logic_values( $form['notifications'], $form );
GFFormsModel::update_form_meta( $form_id, $form['notifications'], 'notifications' );
unset( $form['notifications'] );
}
RGFormsModel::update_form_meta( $form_id, $form );
}
return sizeof( $forms );
}
private static function cleanup( &$forms ) {
unset( $forms['version'] );
//adding checkboxes 'inputs' property based on 'choices'. (they were removed from the export
//to provide a cleaner xml format
foreach ( $forms as &$form ) {
if ( ! is_array( $form['fields'] ) ) {
continue;
}
$form = GFFormsModel::convert_field_objects( $form );
foreach ( $form['fields'] as &$field ) {
$input_type = RGFormsModel::get_input_type( $field );
if ( in_array( $input_type, array( 'checkbox', 'radio', 'select', 'multiselect' ) ) ) {
//creating inputs array for checkboxes
if ( $input_type == 'checkbox' && ! isset( $field->inputs ) ) {
$field->inputs = array();
}
$adjust_by = 0;
for ( $i = 1, $count = sizeof( $field->choices ); $i <= $count; $i ++ ) {
if ( ! $field->enableChoiceValue ) {
$field->choices[ $i - 1 ]['value'] = $field->choices[ $i - 1 ]['text'];
}
if ( $input_type == 'checkbox' ) {
if ( ( ( $i + $adjust_by ) % 10 ) == 0 ) {
$adjust_by ++;
}
$id = $i + $adjust_by;
$field->inputs[] = array( 'id' => $field->id . '.' . $id, 'label' => $field->choices[ $i - 1 ]['text'] );
}
}
}
}
}
}
public static function set_property_as_key( $array, $property ) {
$new_array = array();
foreach ( $array as $item ) {
$new_array[ $item[ $property ] ] = $item;
}
return $new_array;
}
public static function import_form_page() {
if ( ! GFCommon::current_user_can_any( 'gravityforms_edit_forms' ) ) {
wp_die( 'You do not have permission to access this page' );
}
if ( isset( $_POST['import_forms'] ) ) {
check_admin_referer( 'gf_import_forms', 'gf_import_forms_nonce' );
if ( ! empty( $_FILES['gf_import_file']['tmp_name'][0] ) ) {
// Set initial count to 0.
$count = 0;
// Loop through each uploaded file.
foreach ( $_FILES['gf_import_file']['tmp_name'] as $import_file ) {
$count += self::import_file( $import_file, $forms );
}
if ( $count == 0 ) {
$error_message = sprintf(
esc_html__( 'Forms could not be imported. Please make sure your files have the .json extension, and that they were generated by the %sGravity Forms Export form%s tool.', 'gravityforms' ),
'<a href="admin.php?page=gf_export&view=export_form">',
'</a>'
);
GFCommon::add_error_message( $error_message );
} else if ( $count == '-1' ) {
GFCommon::add_error_message( esc_html__( 'Forms could not be imported. Your export file is not compatible with your current version of Gravity Forms.', 'gravityforms' ) );
} else {
$form_text = $count > 1 ? esc_html__( 'forms', 'gravityforms' ) : esc_html__( 'form', 'gravityforms' );
$edit_link = $count == 1 ? "<a href='admin.php?page=gf_edit_forms&id={$forms[0]['id']}'>" . esc_html__( 'Edit Form', 'gravityforms' ) . '</a>' : '';
GFCommon::add_message( sprintf( esc_html__( 'Gravity Forms imported %d %s successfully', 'gravityforms' ), $count, $form_text ) . ". $edit_link" );
}
}
}
self::page_header();
?>
<div class="gform-settings__content">
<form method="post" enctype="multipart/form-data" class="gform_settings_form">
<?php wp_nonce_field( 'gf_import_forms', 'gf_import_forms_nonce' ); ?>
<div class="gform-settings-panel gform-settings-panel--full">
<header class="gform-settings-panel__header"><legend class="gform-settings-panel__title"><?php esc_html_e('Import Forms', 'gravityforms'); ?></legend></header>
<div class="gform-settings-panel__content">
<div class="gform-settings-description">
<?php
echo sprintf(
esc_html__( 'Select the Gravity Forms export files you would like to import. Please make sure your files have the .json extension, and that they were generated by the %sGravity Forms Export form%s tool. When you click the import button below, Gravity Forms will import the forms.', 'gravityforms' ),
'<a href="admin.php?page=gf_export&view=export_form">',
'</a>'
);
?>
</div>
<table class="form-table">
<tr valign="top">
<th scope="row">
<label for="gf_import_file"><?php esc_html_e( 'Select Files', 'gravityforms' ); ?></label> <?php gform_tooltip( 'import_select_file' ) ?>
</th>
<td><input type="file" name="gf_import_file[]" id="gf_import_file" multiple /></td>
</tr>
</table>
<br /><br />
<input type="submit" value="<?php esc_html_e( 'Import', 'gravityforms' ) ?>" name="import_forms" class="button large primary" />
</div>
</div>
</form>
</div>
<?php
self::page_footer();
}
public static function export_form_page() {
if ( ! GFCommon::current_user_can_any( 'gravityforms_edit_forms' ) ) {
wp_die( 'You do not have permission to access this page' );
}
self::page_header();
self::maybe_process_automated_export();
?>
<script type="text/javascript">
( function( $, window, undefined ) {
$( document ).on( 'click keypress', '#gf_export_forms_all', function( e ) {
var checked = e.target.checked,
label = $( 'label[for="gf_export_forms_all"]' ),
formList = $( '#export_form_list' );
// Set label.
label.find( 'strong' ).html( checked ? label.data( 'deselect' ) : label.data( 'select' ) );
// Change checkbox status.
$( 'input[name]', formList ).prop( 'checked', checked );
} );
}( jQuery, window ));
</script>
<div class="gform-settings__content">
<form method="post" id="gform_export" class="gform_settings_form">
<?php wp_nonce_field( 'gf_export_forms', 'gf_export_forms_nonce' ); ?>
<div class="gform-settings-panel gform-settings-panel--full">
<header class="gform-settings-panel__header"><legend class="gform-settings-panel__title"><?php esc_html_e( 'Export Forms', 'gravityforms' )?></legend></header>
<div class="gform-settings-panel__content">
<div class="gform-settings-description">
<?php esc_html_e( 'Select the forms you would like to export. When you click the download button below, Gravity Forms will create a JSON file for you to save to your computer. Once you\'ve saved the download file, you can use the Import tool to import the forms.', 'gravityforms' ); ?>
</div>
<table class="form-table">
<tr valign="top">
<th scope="row">
<label for="export_fields"><?php esc_html_e( 'Select Forms', 'gravityforms' ); ?></label> <?php gform_tooltip( 'export_select_forms' ) ?>
</th>
<td>
<ul id="export_form_list">
<li>
<input type="checkbox" id="gf_export_forms_all" />
<label for="gf_export_forms_all" data-deselect="<?php esc_attr_e( 'Deselect All', 'gravityforms' ); ?>" data-select="<?php esc_attr_e( 'Select All', 'gravityforms' ); ?>"><?php esc_html_e( 'Select All', 'gravityforms' ); ?></label>
</li>
<?php
$forms = RGFormsModel::get_forms( null, 'title' );
/**
* Modify list of forms available for export.
*
* @since 2.4.7
*
* @param array $forms Forms to display on Export Forms page.
*/
$forms = apply_filters( 'gform_export_forms_forms', $forms );
foreach ( $forms as $form ) {
?>
<li>
<input type="checkbox" name="gf_form_id[]" id="gf_form_id_<?php echo absint( $form->id ) ?>" value="<?php echo absint( $form->id ) ?>" />
<label for="gf_form_id_<?php echo absint( $form->id ) ?>"><?php echo esc_html( $form->title ) ?></label>
</li>
<?php
}
?>
</ul>
</td>
</tr>
</table>
<br /><br />
<input type="hidden" name="gform_automatic_submit" id="gform_automatic_submit" value="false" />
<input type="submit" value="<?php esc_attr_e( 'Download Export File', 'gravityforms' ) ?>" name="export_forms" class="button large primary" />
</div>
</div>
</form>
</div>
<?php
self::page_footer();
}
/**
* Checks if form ids are provided in query to be automatically exported.
*
* This method checks the checkboxes of the desired forms and simulates a click on the submit button.
*
* @since 2.6.2
*
* @return void
*/
public static function maybe_process_automated_export() {
$export_ids = rgget( 'export_form_ids' );
$automatic_submit = rgpost( 'gform_automatic_submit' );
if ( $export_ids && ! $automatic_submit ) {
?>
<script>
jQuery( document ).ready( function () {
var export_ids = <?php echo json_encode( $export_ids ); ?>;
var clickSubmit = false;
export_ids.split(',').forEach( ( id ) => {
var formCheckbox = jQuery( '#gf_form_id_' + id );
if( formCheckbox.length ) {
formCheckbox.prop( 'checked', true );
clickSubmit = true;
}
});
if ( clickSubmit ) {
jQuery( '#gform_automatic_submit' ).val( true );
jQuery( '#gform_export input[type="submit"]' ).click();
}
})
</script>
<?php
}
}
public static function export_lead_page() {
if ( ! GFCommon::current_user_can_any( 'gravityforms_export_entries' ) ) {
wp_die( 'You do not have permission to access this page' );
}
self::page_header();
?>
<script type="text/javascript">
var gfSpinner;
<?php GFCommon::gf_global(); ?>
<?php GFCommon::gf_vars(); ?>
function SelectExportForm(formId) {
if (!formId)
return;
gform.utils.trigger( { event: 'gform/page_loader/show' } );
var mysack = new sack("<?php echo admin_url( 'admin-ajax.php' )?>");
mysack.execute = 1;
mysack.method = 'POST';
mysack.setVar("action", "rg_select_export_form");
mysack.setVar("rg_select_export_form", "<?php echo wp_create_nonce( 'rg_select_export_form' ); ?>");
mysack.setVar("form_id", formId);
mysack.onError = function () {
alert(<?php echo json_encode( __( 'Ajax error while selecting a form', 'gravityforms' ) ); ?>)
};
mysack.runAJAX();
return true;
}
function EndSelectExportForm(aryFields, filterSettings) {
gform.utils.trigger( { event: 'gform/page_loader/hide' } );
if (aryFields.length == 0) {
jQuery("#export_field_container, #export_date_container, #export_submit_container").hide()
return;
}
var fieldList = "<li><input id='select_all' type='checkbox' onclick=\"jQuery('.gform_export_field').prop('checked', this.checked); jQuery('#gform_export_check_all').html(this.checked ? '<strong><?php echo esc_js( __( 'Deselect All', 'gravityforms' ) ); ?></strong>' : '<strong><?php echo esc_js( __( 'Select All', 'gravityforms' ) ); ?></strong>'); \" onkeypress=\"jQuery('.gform_export_field').prop('checked', this.checked); jQuery('#gform_export_check_all').html(this.checked ? '<strong><?php echo esc_js( __( 'Deselect All', 'gravityforms' ) ); ?></strong>' : '<strong><?php echo esc_js( __( 'Select All', 'gravityforms' ) ); ?></strong>'); \"> <label id='gform_export_check_all' for='select_all'><strong><?php esc_html_e( 'Select All', 'gravityforms' ) ?></strong></label></li>";
for (var i = 0; i < aryFields.length; i++) {
fieldList += "<li><input type='checkbox' id='export_field_" + i + "' name='export_field[]' value='" + aryFields[i][0] + "' class='gform_export_field'> <label for='export_field_" + i + "'>" + aryFields[i][1] + "</label></li>";
}
jQuery("#export_field_list").html(fieldList);
jQuery("#export_date_start, #export_date_end").datepicker({dateFormat: 'yy-mm-dd', changeMonth: true, changeYear: true});
jQuery("#export_field_container, #export_filter_container, #export_date_container, #export_submit_container").hide().show();
gf_vars.filterAndAny = <?php echo json_encode( esc_html__( 'Export entries if {0} of the following match:', 'gravityforms' ) ); ?>;
jQuery("#export_filters").gfFilterUI(filterSettings);
}
( function( $, window, undefined ) {
$(document).ready(function() {
$("#submit_button").click(function () {
if ($(".gform_export_field:checked").length == 0) {
alert(<?php echo json_encode( __( 'Please select the fields to be exported', 'gravityforms' ) ); ?>);
return false;
}
$(this).hide();
$('#please_wait_container').show();
process();
return false;
});
$('#export_form').on('change', function() {
SelectExportForm($(this).val());
}).trigger('change');
});
function process( offset, exportId ) {
if ( typeof offset == 'undefined' ) {
offset = 0;
}
if ( typeof exportId == 'undefined' ) {
exportId = 0;
}
var data = $('#gform_export').serialize();
data += '&action=gf_process_export';
data += '&offset=' + offset;
data += '&exportId='+ exportId;
$.ajax({
type: 'POST',
url: ajaxurl,
data: data,
dataType: 'json'
}).done(function( response ){
if ( response.status == 'in_progress' ) {
$('#progress_container').text( response.progress );
process( response.offset, response.exportId );
} else if ( response.status == 'complete' ) {
$('#progress_container').text('0%');
$('#please_wait_container').hide();
var formId = parseInt( $('#export_form').val() );
var url = ajaxurl + '?action=gf_download_export&_wpnonce=<?php echo wp_create_nonce( 'gform_download_export' ); ?>&export-id=' + response.exportId + '&form-id=' + formId;
$('#submit_button').fadeIn();
document.location.href = url;
}
}
);
}
}( jQuery, window ));
</script>
<div class="gform-settings__content">
<form method="post" id="gform_export" class="gform_settings_form" data-js="page-loader">
<?php echo wp_nonce_field( 'rg_start_export', 'rg_start_export_nonce' ); ?>
<div class="gform-settings-panel gform-settings-panel--full">
<header class="gform-settings-panel__header"><legend class="gform-settings-panel__title"><?php esc_html_e( 'Export Entries', 'gravityforms' ) ;?></legend></header>
<div class="gform-settings-panel__content">
<div class="gform-settings-description">
<?php esc_html_e( 'Select a form below to export entries. Once you have selected a form you may select the fields you would like to export and then define optional filters for field values and the date range. When you click the download button below, Gravity Forms will create a CSV file for you to save to your computer.', 'gravityforms' ); ?>
</div>
<table class="form-table">
<tr valign="top">
<th scope="row">
<label for="export_form"><?php esc_html_e( 'Select a Form', 'gravityforms' ); ?></label> <?php gform_tooltip( 'export_select_form' ) ?>
</th>
<td>
<select id="export_form" name="export_form">
<option value=""><?php esc_html_e( 'Select a form', 'gravityforms' ); ?></option>
<?php
$forms = RGFormsModel::get_forms( null, 'title' );
/**
* Modify list of forms available to export entries from.
*
* @since 2.4.7
*
* @param array $forms Forms to display on Export Entries page.
*/
$forms = apply_filters( 'gform_export_entries_forms', $forms );
foreach ( $forms as $form ) {
?>
<option value="<?php echo absint( $form->id ) ?>" <?php selected( rgget( 'id' ), $form->id ); ?>><?php echo esc_html( $form->title ) ?></option>
<?php
}
?>
</select>
</td>
</tr>
<tr id="export_field_container" valign="top" style="display: none;">
<th scope="row">
<label for="export_fields"><?php esc_html_e( 'Select Fields', 'gravityforms' ); ?></label> <?php gform_tooltip( 'export_select_fields' ) ?>
</th>
<td>
<ul id="export_field_list">
</ul>
</td>
</tr>
<tr id="export_filter_container" valign="top" style="display: none;">
<th scope="row">
<label><?php esc_html_e( 'Conditional Logic', 'gravityforms' ); ?></label> <?php gform_tooltip( 'export_conditional_logic' ) ?>
</th>
<td>
<div id="export_filters" class="gform-settings-field__conditional-logic">
<!--placeholder-->
</div>
</td>
</tr>
<tr id="export_date_container" valign="top" style="display: none;">
<th scope="row">
<label for="export_date"><?php esc_html_e( 'Select Date Range', 'gravityforms' ); ?></label> <?php gform_tooltip( 'export_date_range' ) ?>
</th>
<td>
<div>
<span style="width:150px; float:left; ">
<input type="text" id="export_date_start" name="export_date_start" style="width:90%" />
<strong><label for="export_date_start" style="display:block;"><?php esc_html_e( 'Start', 'gravityforms' ); ?></label></strong>
</span>
<span style="width:150px; float:left;">
<input type="text" id="export_date_end" name="export_date_end" style="width:90%" />
<strong><label for="export_date_end" style="display:block;"><?php esc_html_e( 'End', 'gravityforms' ); ?></label></strong>
</span>
<div style="clear: both;"></div>
<?php esc_html_e( 'Date Range is optional, if no date range is selected all entries will be exported.', 'gravityforms' ); ?>
</div>
</td>
</tr>
</table>
<ul>
<li id="export_submit_container" style="display:none; clear:both;">
<br /><br />
<button id="submit_button" class="button large primary"><?php esc_attr_e( 'Download Export File', 'gravityforms' ); ?></button>
<span id="please_wait_container" style="display:none; margin-left:15px;">
<i class='gficon-gravityforms-spinner-icon gficon-spin'></i> <?php esc_html_e( 'Exporting entries. Progress:', 'gravityforms' ); ?>
<span id="progress_container">0%</span>
</span>
</li>
</ul>
</div>
</div>
</form>
</div>
<?php
self::page_footer();
}
public static function get_field_row_count( $form, $exported_field_ids, $entry_count ) {
$list_fields = GFAPI::get_fields_by_type( $form, array( 'list' ), true );
//only getting fields that have been exported
$field_ids = array();
foreach ( $list_fields as $field ) {
if ( in_array( $field->id, $exported_field_ids ) && $field->enableColumns ) {
$field_ids[] = $field->id;
}
}
if ( empty( $field_ids ) ) {
return array();
}
$field_ids = implode( ',', array_map( 'absint', $field_ids ) );
$page_size = 200;
$offset = 0;
$row_counts = array();
global $wpdb;
$go_to_next_page = true;
while ( $go_to_next_page ) {
if ( version_compare( GFFormsModel::get_database_version(), '2.3-dev-1', '<' ) ) {
$sql = $wpdb->prepare( "SELECT d.field_number as field_id, d.value as value
FROM {$wpdb->prefix}rg_lead_detail d
WHERE d.form_id=%d AND cast(d.field_number as decimal) IN ({$field_ids})
LIMIT %d, %d",
$form['id'],
$offset,
$page_size
);
} else {
$sql = $wpdb->prepare( "SELECT d.meta_key as field_id, d.meta_value as value
FROM {$wpdb->prefix}gf_entry_meta d
WHERE d.form_id=%d AND d.meta_key IN ({$field_ids})
LIMIT %d, %d",
$form['id'],
$offset,
$page_size
);
}
$results = $wpdb->get_results( $sql, ARRAY_A );
foreach ( $results as $result ) {
$list = unserialize( $result['value'] );
$current_row_count = isset( $row_counts[ $result['field_id'] ] ) ? intval( $row_counts[ $result['field_id'] ] ) : 0;
if ( is_array( $list ) && count( $list ) > $current_row_count ) {
$row_counts[ $result['field_id'] ] = count( $list );
}
}
$offset += $page_size;
$go_to_next_page = count( $results ) == $page_size;
}
return $row_counts;
}
/**
* @deprecated No longer used.
*/
public static function get_gmt_timestamp( $local_timestamp ) {
_deprecated_function( 'GFExport::get_gmt_timestamp', '2.0.7', 'GFCommon::get_gmt_timestamp' );
return $local_timestamp - ( get_option( 'gmt_offset' ) * 3600 );
}
/**
* @deprecated No longer used.
*/
public static function get_gmt_date( $local_date ) {
_deprecated_function( 'GFExport::get_gmt_date', '2.0.7' );
$local_timestamp = strtotime( $local_date );
$gmt_timestamp = self::get_gmt_timestamp( $local_timestamp );
$date = gmdate( 'Y-m-d H:i:s', $gmt_timestamp );
return $date;
}
public static function start_export( $form, $offset = 0, $export_id = '' ) {
$time_start = microtime( true );
/***
* Allows the export max execution time to be changed.
*
* When the max execution time is reached, the export routine stop briefly and submit another AJAX request to continue exporting entries from the point it stopped.
*
* @since 2.0.3.10
*
* @param int 20 The amount of time, in seconds, that each request should run for. Defaults to 20 seconds.
* @param array $form The Form Object
*/
$max_execution_time = apply_filters( 'gform_export_max_execution_time', 20, $form ); // seconds
$page_size = 20;
$form_id = $form['id'];
$fields = $_POST['export_field'];
$start_date = rgpost( 'export_date_start' );
$end_date = rgpost( 'export_date_end' );
$search_criteria['status'] = 'active';
$search_criteria['field_filters'] = GFCommon::get_field_filters_from_post( $form );
if ( ! empty( $start_date ) ) {
$search_criteria['start_date'] = $start_date;
}
if ( ! empty( $end_date ) ) {
$search_criteria['end_date'] = $end_date;
}
//$sorting = array( 'key' => 'date_created', 'direction' => 'DESC', 'type' => 'info' );
$sorting = array( 'key' => 'id', 'direction' => 'DESC', 'type' => 'info' );
$form = self::add_default_export_fields( $form );
/**
* Allows the search criteria to be filtered before exporting entries.
*
* @since 2.7
*
* @param array $search_criteria The search criteria array being filtered.
* @param int $form_id The current form ID.
*/
$search_criteria = apply_filters( 'gform_search_criteria_export_entries', $search_criteria, $form_id );
$total_entry_count = GFAPI::count_entries( $form_id, $search_criteria );
$remaining_entry_count = $offset == 0 ? $total_entry_count : $total_entry_count - $offset;
$lines = '';
// Set the separator
$separator = gf_apply_filters( array( 'gform_export_separator', $form_id ), ',', $form_id );
$field_rows = self::get_field_row_count( $form, $fields, $remaining_entry_count );
if ( $offset == 0 ) {
GFCommon::log_debug( __METHOD__ . '(): Processing request for form #' . $form_id );
/**
* Allows the BOM character to be excluded from the beginning of entry export files.
*
* @since 2.1.1.21
*
* @param bool $include_bom Whether or not to include the BOM characters. Defaults to true.
* @param array $form The Form Object.
*/
$include_bom = apply_filters( 'gform_include_bom_export_entries', true, $form );
//Adding BOM marker for UTF-8
$lines = $include_bom ? chr( 239 ) . chr( 187 ) . chr( 191 ) : '';
//writing header
$headers = array();
foreach ( $fields as $field_id ) {
$field = RGFormsModel::get_field( $form, $field_id );
$label = gf_apply_filters( array( 'gform_entries_field_header_pre_export', $form_id, $field_id ), GFCommon::get_label( $field, $field_id ), $form, $field );
$value = str_replace( '"', '""', $label );
GFCommon::log_debug( "GFExport::start_export(): Header for field ID {$field_id}: {$value}" );
if ( strpos( $value, '=' ) === 0 ) {
// Prevent Excel formulas
$value = "'" . $value;
}
$headers[ $field_id ] = $value;
$subrow_count = isset( $field_rows[ $field_id ] ) ? intval( $field_rows[ $field_id ] ) : 0;
if ( $subrow_count == 0 ) {
$lines .= '"' . $value . '"' . $separator;
} else {
for ( $i = 1; $i <= $subrow_count; $i ++ ) {
$lines .= '"' . $value . ' ' . $i . '"' . $separator;
}
}
//GFCommon::log_debug( "GFExport::start_export(): Lines: {$lines}" );
}
$lines = substr( $lines, 0, strlen( $lines ) - 1 ) . "\n";
if ( $remaining_entry_count == 0 ) {
self::write_file( $lines, $export_id );
}
GFCommon::log_debug( __METHOD__ . '(): search criteria: ' . print_r( $search_criteria, true ) );
GFCommon::log_debug( __METHOD__ . '(): sorting: ' . print_r( $sorting, true ) );
}
// Paging through results for memory issues
while ( $remaining_entry_count > 0 ) {
$paging = array(
'offset' => $offset,
'page_size' => $page_size,
);
GFCommon::log_debug( __METHOD__ . '(): paging: ' . print_r( $paging, true ) );
$leads = GFAPI::get_entries( $form_id, $search_criteria, $sorting, $paging );
$leads = gf_apply_filters( array( 'gform_leads_before_export', $form_id ), $leads, $form, $paging );
foreach ( $leads as $lead ) {
$line = self::get_entry_export_line( $lead, $form, $fields, $field_rows, $separator );
/**
* Filter the current line being exported.
*
* @since 2.4.11.5
*
* @param string $line The current line being exported.
* @param array $form The current form object.
* @param array $fields An array of field IDs to be exported.
* @param array $field_rows An array of List fields
* @param array $entry The current entry.
* @param string $separator The separator
*/
$line = apply_filters( 'gform_export_line', $line, $form, $fields, $field_rows, $lead, $separator );
$lines .= "$line\n";
}
$offset += $page_size;
$remaining_entry_count -= $page_size;
if ( ! seems_utf8( $lines ) ) {
$lines = utf8_encode( $lines );
}
$lines = apply_filters( 'gform_export_lines', $lines );
self::write_file( $lines, $export_id );
$time_end = microtime( true );
$execution_time = ( $time_end - $time_start );
if ( $execution_time >= $max_execution_time ) {
break;
}
$lines = '';
}
$complete = $remaining_entry_count <= 0;
if ( $complete ) {
/**
* Fires after exporting all the entries in form
*
* @since 2.4.5.11 Added the $export_id param.
* @since 1.9.3
*
* @param array $form The Form object to get the entries from
* @param string $start_date The start date for when the export of entries should take place
* @param string $end_date The end date for when the export of entries should stop
* @param array $fields The specified fields where the entries should be exported from
* @param string $export_id A unique ID for the export.