-
Notifications
You must be signed in to change notification settings - Fork 0
/
xlsx2EML-04_Tk.pl
4011 lines (3250 loc) · 168 KB
/
xlsx2EML-04_Tk.pl
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
#!/usr/local/perl/bin/perl
use strict;
use FindBin;
use lib "$FindBin::Bin/../lib";
use Config;
use Spreadsheet::ParseExcel;
use Spreadsheet::XLSX;
use Spreadsheet::XLSX::Utility2007 qw(ExcelFmt ExcelLocaltime LocaltimeExcel);
use Cwd;
use XML::LibXML;
use IO::Handle;
use Getopt::Long;
# Tcl for Mac OS X
#use Tcl::pTk (qw/ :perlTk/);
#use Tcl::pTk::ProgressBar;
#use Tcl::pTk::Tile;
use Tk;
use TK::Checkbutton;
use Tk::Labelframe;
use Tk::Menu;
use Tk::Menubutton;
use Tk::Message;
use Tk::ProgressBar;
use Tk::Radiobutton;
use Tk::Scale;
use Tk::Scrollbar;
use Tk::Spinbox;
use Tk::Text;
use Digest::MD5 qw(md5 md5_hex);
use LWP::UserAgent;
use LWP::Protocol::https;
use IO::Socket::SSL;
use HTTP::Request;
################################################################################
#
# Excel Metadata to EML - Version 0.4
#
# This program converts LTER EML Metadata Submission Template files
# (in Excel format) to EML 2.2.0 files.
#
# This material is based upon work supported by National Science Foundation
# through the Florida Coastal Everglades Long-Term Ecological Research program
# under Cooperative Agreements #DEB-1237517, #DBI-0620409, and #DEB-9910514. Any opinions,
# findings, conclusions, or recommendations expressed in the material are those
# of the author(s) and do not necessarily reflect the views of the National
# Science Foundation.
#
# Copyright (C) 2004, 2010, 2013, 2017, 2021 Florida International University
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
################################################################################
##########################
# Frames for GUI (Tk) #
##########################
my $mw;
my @files;
my $loop;
my $OS = "$^O";
my $basefontsize;
my $fontfamily;
my $dark_background;
my $border;
my $background_bottom;
my $button_padx;
my $button_padx;
my $rt_button_padx;
my $top_padx;
my $lbin_width;
my $lbout_width;
my $directory_entry_width;
my $instructions_wrap_length;
if ( $OS =~ /mswin/i ) {
$basefontsize = "10";
$fontfamily = "Arial, Helvetica";
$dark_background = "#102060";
$border = "#006699";
$background_bottom = "#102060";
$button_padx = 2;
$rt_button_padx = 120;
$top_padx = 0;
$lbin_width = 75;
$lbout_width = 75;
$directory_entry_width = 30;
$instructions_wrap_length = 430;
}
elsif ( $OS =~ /darwin/i ) {
my $l = 1;
$basefontsize = "14";
$fontfamily = "helvetica";
$dark_background = "#092866";
$border = "#006699";
$background_bottom = "#FFFFFF";
$button_padx = 0;
$rt_button_padx = 80;
$top_padx = 35;
$lbin_width = 78;
$lbout_width = 60;
$directory_entry_width = 40;
$instructions_wrap_length = 450;
}
else {
$basefontsize = "12";
$fontfamily = "helvetica";
$dark_background = "#102060";
$border = "#137D51";
$background_bottom = "#006699";
$button_padx = 5;
$rt_button_padx = 120;
$top_padx = 0;
$lbin_width = 70;
$lbout_width = 70;
$directory_entry_width = 30;
$instructions_wrap_length = 400;
}
$mw = MainWindow->new( -background => $dark_background );
$mw->configure( -menu => my $menu = $mw->Menu );
$mw->title("Excel Metadata to EML");
$mw->setPalette(background=>'#FFFFFF');
my $main_container = $mw->Frame( -background => $dark_background )->pack(
-side => 'top',
-fill => 'both'
);
my $top = $main_container->Frame( -background => $dark_background )->pack(
-side => 'top',
-fill => 'x',
-padx => 10,
-pady => 10
);
my $top_content = $main_container->Frame( -background => $border )->pack(
-side => 'top',
-fill => 'y',
-pady => 1,
);
my $top_text = $top_content->Frame( -background => '#FFFFFF')->pack(
-side => 'right',
-fill => 'both',
-anchor => 'w',
-padx => 2,
-pady => 2,
-ipadx => 10
);
my $top_entries = $top_content->Frame( -background => '#FFFFFF' )->pack(
-side => 'left',
-fill => 'both',
-anchor => 'e',
-padx => 2,
-pady => 2,
-ipadx => 5
);
my $top_spacer = $top_content->Frame( -background => $dark_background )->pack(
-side => 'left',
-fill => 'both'
);
my $top_entries1 = $top_entries->Frame( -background => '#FFFFFF' )->pack(
-side => 'top',
-fill => 'x',
);
my $top_entries2 = $top_entries->Frame( -background => '#FFFFFF' )->pack(
-side => 'top',
-fill => 'x'
);
my $top_entries3 = $top_entries->Frame( -background => '#FFFFFF' )->pack(
-side => 'top',
-fill => 'x'
);
my $top_entries4 = $top_entries->Frame( -background => '#FFFFFF' )->pack(
-side => 'top',
-fill => 'x'
);
my $top_entries5 = $top_entries->Frame( -background => '#FFFFFF' )->pack(
-side => 'top',
-fill => 'x'
);
my $top_entries6 = $top_entries->Frame( -background => '#FFFFFF' )->pack(
-side => 'top',
-fill => 'x'
);
my $top_entries7 = $top_entries->Frame( -background => '#FFFFFF' )->pack(
-side => 'top',
-fill => 'x'
);
my $bottom = $mw->Frame( -background => $dark_background )->pack(
-side => 'bottom',
-fill => 'x'
);
my $lb = $main_container->Frame( -background => $dark_background )->pack(
-side => 'left',
-fill => 'both',
-padx => 10,
-pady => 10
);
my $lb_left = $lb->Frame( -background => $background_bottom )->pack(
-side => 'top',
-fill => 'x'
);
my $lb_left_top = $lb_left->Frame( -background => $dark_background )->pack(
-side => 'top',
-fill => 'x',
-expand => 1
);
my $lb_left_select = $lb_left->Frame( -background => $background_bottom )->pack(
-side => 'top',
-fill => 'x',
-pady => 3,
-expand => 1
);
my $lb_left_buttons_container = $lb_left->Frame( -background => $background_bottom )->pack(
-side => 'top',
-pady => 2,
-fill => 'x'
);
my $lb_left_buttons = $lb_left_buttons_container->Frame( -background => $background_bottom )->pack(
-side => 'left',
-fill => 'x',
-anchor => 'w'
);
my $lb_right = $main_container->Frame( -background => $background_bottom )->pack(
-side => 'top',
-fill => 'x',
-padx => 10,
-pady => 10
);
my $lb_right_top = $lb_right->Frame( -background => $dark_background )->pack(
-side => 'top',
-fill => 'x',
-expand => 1
);
my $lb_right_buttons_container = $lb_right->Frame( -background => $background_bottom )->pack(
-side => 'top',
-padx => $rt_button_padx,
-pady => 2,
-fill => 'x'
);
my $lb_right_buttons = $lb_right_buttons_container->Frame( -background => $background_bottom )->pack(
-side => 'left',
-fill => 'x'
);
my $file_menu = $menu->cascade( -label => "~File", -tearoff => 0 );
my $help_menu = $menu->cascade( -label => "~Help", -tearoff => 0 );
$file_menu->command( -label => "~Add file", -command => \&getFile );
$file_menu->command( -label => "~Convert to EML", -command => \&convertToEML );
$file_menu->command( -label => "~Remove selected file(s)", -command => \&removeFile );
$file_menu->command( -label => "~Remove all files", -command => \&removeAllFiles );
$file_menu->command( -label => "~Clear log", -command => \&clearLog );
$file_menu->command( -label => "~Stop converting files", -command => sub { $loop = 0 } );
$file_menu->command( -label => "~Exit", -command => sub { exit ; } );
$help_menu->command( -label => "~Instructions", -command => \&getInstructions );
$help_menu->command( -label => "~Notes", -command => \&getNotes );
$help_menu->command( -label => "~About this program", -command => \&getInfo );
###################################################
# Listboxes for the file list and the log (Tk) #
###################################################
my $lb_in = $lb_left->Scrolled(
"Listbox",
-scrollbars => "osoe",
-width => $lbin_width,
-height => "20",
-background => 'white',
-relief => 'sunken',
-selectmode => 'multiple',
-highlightcolor => '#FFFF99',
-highlightbackground => '#FFFF99'
)->pack( -side => "bottom" );
my $lb_out = $lb_right->Scrolled(
"Listbox",
-scrollbars => "osoe",
-width => $lbout_width,
-height => "22",
-background => 'white',
-relief => 'sunken',
-selectmode => 'multiple'
)->pack( -side => "bottom" );
####################################################################
# Label and entry widgets for optional information section (Tk) #
####################################################################
$top->Label(
-font => [ -size => $basefontsize + 8, -family => $fontfamily, -weight => 'normal' ],
-text => 'Excel Metadata to EML - Version 0.4',
-foreground => '#FFFF99',
-background => $dark_background,
-anchor => 'n'
)->pack( -side => "top" );
$top_entries1->Label(
-font => [ -size => $basefontsize, -family => $fontfamily, -weight => 'bold' ],
-text => 'Optional conversion information:',
-foreground => 'black',
-background => '#FFFFFF',
)->pack( -side => "left" );
my $indent_level;
$top_entries2->Label(
-font => [ -size => $basefontsize, -family => $fontfamily, -weight => 'normal' ],
-text => 'Number of spaces per indent (default=2) ',
-foreground => 'black',
-background => '#FFFFFF',
)->pack( -side => "left" );
$top_entries2->Entry(
-width => '10',
-textvariable => \$indent_level,
)->pack( -side => "left" );
$top_entries3->Label(
-font => [ -size => $basefontsize, -family => $fontfamily, -weight => 'normal' ],
-text => 'EML Schema URL (defaults to FCE URL) ',
-foreground => 'black',
-background => '#FFFFFF',
)->pack( -side => "left" );
my $schema;
$top_entries3->Entry(
-width => $directory_entry_width,
-textvariable => \$schema,
)->pack( -side => "left" );
$top_entries4->Label(
-font => [ -size => $basefontsize, -family => $fontfamily, -weight => 'normal' ],
-text => 'STMML Schema URL (defaults to FCE URL) ',
-foreground => 'black',
-background => '#FFFFFF',
)->pack( -side => "left" );
my $stmml;
$top_entries4->Entry(
-width => $directory_entry_width,
-textvariable => \$stmml,
)->pack( -side => "left" );
$top_entries5->Label(
-font => [ -size => $basefontsize, -family => $fontfamily, -weight => 'normal' ],
-text => 'XSL Stylesheet URL (optional) ',
-foreground => 'black',
-background => '#FFFFFF',
)->pack( -side => "left" );
my $stylesheet;
$top_entries5->Entry(
-width => $directory_entry_width,
-textvariable => \$stylesheet,
)->pack( -side => "left" );
my $embed_data_checkbox;
$top_entries6->Checkbutton(
-font => [ -size => $basefontsize, -family => $fontfamily, -weight => 'normal' ],
-text => 'Embed data in EML (EML 2.1.0 and higher only)',
-onvalue => 'yes',
-offvalue => 'no',
-background => '#FFFFFF',
-activebackground => '#FFFFFF',
-variable => \$embed_data_checkbox
)->pack( -side => "left" );
#my $validation_checkbox = "yes";
my $validation_checkbox;
$top_entries7->Checkbutton(
-font => [ -size => $basefontsize, -family => $fontfamily, -weight => 'normal' ],
-text => 'Validate against the specified EML schema',
-onvalue => 'yes',
-offvalue => 'no',
-background => '#FFFFFF',
-activebackground => '#FFFFFF',
-variable => \$validation_checkbox
)->pack( -side => "left" );
################################################################################
# Space between optional information section and instructions section (Tk) #
################################################################################
$top_spacer ->Label(
-font => [ -size => $basefontsize, -family => $fontfamily, -weight => 'normal' ],
-text => ' ',
-background => $dark_background,
-width => '2'
)->pack( -side => "left" );
############################################
# Label for instructions section (Tk) #
############################################
$top_text->Label(
-font => [ -size => $basefontsize, -family => $fontfamily, -weight => 'normal' ],
-text =>
'This program converts LTER Metadata Submission Template files (in Excel format) to Ecological Metadata Language (EML) 2.2.0 files. Add files to the list on the left and press the \'Convert all files to EML\' button to convert files to EML.
The EML files will retain the same name as the Excel files, but their file extension will be xml instead of xls or xlsx. The Metadata Submission Template files must have a xls or xlsx extension in order to be converted to EML.',
-foreground => 'black',
-background => '#FFFFFF',
-justify => 'left',
-wraplength => $instructions_wrap_length,
-padx => '10',
-pady => '5',
)->pack( -side => "left" );
######################################################################
# Label and button widgets for the EML File List and the Log (Tk) #
######################################################################
$lb_left_top->Label(
-font => [ -size => $basefontsize + 4, -family => $fontfamily, -weight => 'normal' ],
-text => 'List of Excel Metadata files to convert to EML',
-foreground => '#FFFF99',
-background => $dark_background,
-anchor => 'n'
)->pack( -side => "top", -pady => 7 );
if ( &perl_ver >= 58 ) {
$lb_left_select->Button(
-text => 'Destination directory for EML files',
-command => \&chooseDir,
-background => '#FFFF99',
-activebackground => '#FFFFAA'
)->pack( -side => "left" );
}
else {
$lb_left_select->Label(
-font => [ -size => $basefontsize, -family => $fontfamily, -weight => 'normal' ],
-text => 'Destination directory for EML files',
-foreground => '#FFFF99',
-background => $dark_background,
-anchor => 'n'
)->pack( -side => "left" );
}
my $save_dir;
my $dir_entry = $lb_left_select->Entry(
-width => '40',
-textvariable => \$save_dir,
)->pack( -side => "left" );
$lb_left_buttons->Button(
-text => 'Add file to the list',
-command => \&getFile,
-background => '#FFFF99',
-activebackground => '#FFFFAA'
)->pack( -side => "left" );
$lb_left_buttons->Button(
-text => 'Remove selected file(s)',
-command => \&removeFile,
-background => '#FFFF99',
-activebackground => '#FFFFAA'
)->pack( -side => "left", -padx => $button_padx );
$lb_left_buttons->Button(
-text => 'Remove all files',
-command => \&removeAllFiles,
-background => '#FFFF99',
-activebackground => '#FFFFAA'
)->pack( -side => "left", -padx => $button_padx );
$lb_left_buttons->Button(
-text => 'Convert all files to EML',
-command => \&convertToEML,
-background => '#6CD998',
-activebackground => '#79F3AA'
)->pack( -side => "left" );
$lb_right_top->Label(
-font => [ -size => $basefontsize + 4, -family => $fontfamily, -weight => 'normal' ],
-text => 'Log',
-foreground => '#FFFF99',
-background => $dark_background,
-anchor => 'n'
)->pack( -side => "top", -pady => 7 );
$lb_right_buttons->Button(
-text => 'Stop converting files',
-command => sub { $loop = 0 },
-background => '#D95757',
-activebackground => '#F36161'
)->pack( -side => "left", -padx => 10 );
$lb_right_buttons->Button(
-text => 'Clear log',
-command => \&clearLog,
-background => '#FFFF99',
-activebackground => '#FFFFAA'
)->pack( -side => "right", -padx => 10 );
####################################################################################
# Label, progress bar, and exit button widgets at the bottom of the window (Tk) #
####################################################################################
my $progress;
my $percent_done;
$bottom->Button(
-text => "Exit",
-command => sub { exit; },
-background => '#F3F379',
-activebackground => '#FFFF99'
)->pack( -side => "right" );
$bottom->Label(
-font => [ -size => $basefontsize + 4, -family => $fontfamily, -weight => 'normal' ],
-text => ' ',
-foreground => '#FFFF99',
-background => $dark_background
)->pack( -side => "right" );
$progress = $bottom->ProgressBar(
-width => 20,
-length => 250,
-from => 0,
-to => 100,
-blocks => 50,
-colors => [ 0, '#6CD998', 50, '#6CD998', 100, '#6CD998' ],
# -variable => \$percent_done
)->pack( -side => "right" );
$bottom->Label(
-font => [ -size => $basefontsize + 4, -family => $fontfamily, -weight => 'normal' ],
-text => 'Progress ',
-foreground => '#FFFF99',
-background => $dark_background
)->pack( -side => "right" );
MainLoop;
####################
# Tk Subroutines #
####################
# Detect Perl version (check to see if it's >5.8)
sub perl_ver {
my %config;
my $perl_version = $Config{version};
my @perl_version = split( /\./, $perl_version );
my $perl = "$perl_version[0]" . "$perl_version[1]";
return $perl;
}
# 'Destination directory for EML files' action
sub chooseDir {
my $save_dir;
$dir_entry->delete( 0, 500 );
$save_dir = $mw->chooseDirectory( -parent => $mw );
$dir_entry->insert( 0, $save_dir );
}
# 'Add file to the list' action
sub getFile {
my $OS = "$^O";
my $mult;
if ( $OS =~ /mswin/i ) {
$mult = "1";
}
else {
$mult = "0";
}
my $f;
my @file = ();
# Types are listed in the dialog widget
my $types = [ [ "Excel Metadata template", '.xls*' ], [ "Excel Metadata template", '.xlsx' ], [ "All Files", "*" ] ];
if ( &perl_ver >= 58 ) {
@file = $mw->getOpenFile( -filetypes => $types, -multiple => $mult );
}
else {
@file = $mw->getOpenFile( -filetypes => $types );
}
foreach $f (@file) {
if ( $f gt '' ) {
$lb_in->insert( "end", $f );
}
}
}
# 'Remove selected file(s)' action
sub removeFile {
my @selected = ( $lb_in->curselection );
my $item;
foreach $item (@selected) {
my $file_deleted = $lb_in->get($item);
$lb_in->delete($item);
}
}
# 'Remove all files' action
sub removeAllFiles {
my $listboxsize = $lb_in->size;
my $size = $listboxsize - 1;
$lb_in->delete( 0, $size );
# my $deleted = "Removed all files";
# $lb_out->insert( "end", $deleted );
}
# 'Clear log' action
sub clearLog {
my $listboxsize = $lb_out->size;
my $size = $listboxsize - 1;
$lb_out->delete( 0, $size );
}
# 'Information' action
sub getInfo {
my $info = $mw->DialogBox(
-title => "About this program",
-buttons => ["OK"]
);
$info->add(
'Label',
-anchor => 'w',
-justify => 'left',
-background => '#FFFFFF',
-text => qq(
Excel Metadata to EML - Version 0.4
The Excel Metadata to EML program converts LTER EML Metadata Submission Template files
(in Excel format) to EML 2.2.0 files.
This program was developed with support from the Florida Coastal Everglades (FCE),
Georgia Coastal Ecosystems (GCE), and Sevilleta (SEV) Long Term Ecological
Research (LTER) programs. Contributors to this program and the Excel metadata template
include:
Linda Powell, Mike Rugge, and Kristin Vanderbilt from Florida Coastal Everglades LTER Program
(http://fcelter.fiu.edu) at Florida International University.
Wade Sheldon from Georgia Coastal Ecosystems LTER Program
(http://gce-lter.marsci.uga.edu/lter/) at the University of Georgia.
Kristin Vanderbilt from the Sevilleta Long-Term Ecological Research LTER Program
(http://sevilleta.unm.edu) at the University of New Mexico.
Youngmi Kim and Travis Brooks, programmers for the Canopy Database Project and graduates
of The Evergreen State College Software Engineering Program (http://canopy.evergreen.edu/).
Judy Bayard Cushing, Ph.D., a member of the Faculty (Computer Science), The Evergreen State College,
Olympia, Washington and a principal investigator of the Canopy Database Project
(http://academic.evergreen.edu/j/judyc/home.htm, http://canopy.evergreen.edu/).
Working in cooperation with the Evergreen State College contributors are Professor Barbara Bond,
Department of Forest Science, Oregon State University and her students, Georgianne Moore,
Texas A&M University and Kate George, USDA.
This material is based upon work supported by National Science Foundation
through the Florida Coastal Everglades Long-Term Ecological Research program
under Cooperative Agreements #DEB-1237517, #DBI-0620409, and #DEB-9910514. Any opinions,
findings, conclusions, or recommendations expressed in the material are those
of the author(s) and do not necessarily reflect the views of the National
Science Foundation.
Copyright (C) 2004, 2010, 2013, 2017, 2021 Florida International University
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
)
)->pack;
$info->Show();
}
# 'Instructions' action
sub getInstructions {
my $info = $mw->DialogBox(
-title => "Instructions",
-buttons => ["OK"]
);
$info->add(
'Label',
-anchor => 'w',
-justify => 'left',
-background => '#FFFFFF',
-text => qq(
Excel Metadata to EML - Version 0.4
This program converts LTER Excel Metadata Templates to Ecological Metadata Language (EML) 2.2.0 files. The metadata template and
this program are based on the EML best practices document released in 2011.
INSTRUCTIONS
1. Fill out the LTER EML Metadata Template (xlsx2EML-03_Metadata_Template_FCE.xlsx).
Instructions for filling out the template are provided in a Microsoft Word help document called xlsx2EML-03_Metadata_Instructions.doc.
2. Add the template files to the list of files to convert to EML with the 'Add file to the list' button.
You can also use the 'Add file' in the file menu to add files to the list. The other buttons and
choices in the file menu let you remove files, clear the log to the left, and exit the program.
3. Fill out the Optional Conversion Information section.
Indentation
The number of spaces per indent is optional. If you leave this field blank, it defaults to two spaces
per indent.
EML Schema and STMML Schema
The EML and STMML Schema URLs or file paths are optional and will default to eml.xsd and stmml.xsd, respectively.
However, in order to validate the final EML document, URLs or file paths that point to
the eml.xsd and stmml.xsd must be included (i.e. http://ltersite.edu/eml.xsd or C:\\eml\\eml.xsd).
EML schema validation is performed using the specified schemas after each EML file is created.
The stmml.xsd is only required if custom units are included in DataTable worksheet of the metadata template.
XSL Stylesheet
The XSL Stylesheet URL is also optional and won't be included in the final EML files unless the URL is entered.
Embedded Data
You can choose to embed data in the EML document by checking the box at the bottom of this section.
Please note that EML 2.2.0 or higher is required to validate EML files with embedded data.
Validation
Validation against the specified EML schema (the EML and STMML Schema URLs or file paths) is optional, but
checked (enabled) by default. Validation warnings and errors will be displayed in the program's log and
recorded in an error log file (error.log).
4. Select a destination directory for EML files.
If this field is blank, all EML files will be saved in the same directory as their source Excel file.
5. Click on the 'Convert all file to EML' button or select 'Convert to EML' from the file menu
to convert all files in the list to EML. The log on the right displays messages if a file is successfully
converted to EML (with the path to the new EML file), if a file isn't converted to EML, and if the file
has EML schema validation warnings or errors. Validation warnings and errors are also recorded in an
error log file (error.log). Files in the list which don't have xls or xlsx extensions or the value 'Dataset Title'
in cell B20 will not be converted to EML. Click on the 'Stop converting files' button or select
'Stop converting files' from the file menu if you wish to stop the conversion process.
)
)->pack;
$info->Show();
}
# 'Notes' action
sub getNotes {
my $info = $mw->DialogBox(
-title => "Notes",
-buttons => ["OK"]
);
$info->add(
'Label',
-anchor => 'w',
-justify => 'left',
-background => '#FFFFFF',
-text => qq(
Excel Metadata to EML - Version 0.4
NOTES
- EML files will retain the same name as the Excel files, but their file extension will be 'xml' instead of 'xls' or 'xlsx'.
- The program will embed data entered in the Values section of the DataTable worksheet into the EML file if the
'Embed data' box is checked. If no values are entered in this section, no data will be embedded in the EML.
If you plan to embed data, please use EML 2.1.0 or higher.
- Some or all buttons may not be visible if your screen resolution is less than 1024 X 768. If buttons aren't
visible, try making the window larger or using the commands in the File menu at the top instead.
- The program uses up a chunk of memory each time it converts an Excel file to EML. This memory isn't returned to
the system until after you exit the program.
Tips for best performance:
- Validate against local schema or deselect the validation option. Validation against a schema URL can take
awhile if you have a slow network connection.
- Keep the size of the Excel Metadata Template files as small as possible. For example, if you don't have
any methods citations, you could clear all of the cells in the methodsCitation sheet to reduce the size of the file.
Please note that every worksheet needs to be present in the specified order for the program to work, though.
)
)->pack;
$info->Show();
}
#######################################################################################################
# 'Convert all files to EML' button action #
# -Checks the left listbox for file paths - make sure the file list contains files #
# -Checks file paths for xls or xlsx extension - make sure they're Excel files #
# #
# -Checks Excel files for 'Dataset Title' value in cell B20 - make sure they're metadata templates #
# If the file passes all of the tests, the file path, schema, indent level, and destination directory #
# are passed to the createEMLFile subroutine. Otherwise, a message appears in the log explaining #
# why the file wasn't processed. #
#######################################################################################################
my $total_files;
my $files_done;
my $EML_file_done;
sub convertToEML {
my @file_list = ();
my $listboxsize = $lb_in->size;
my $size = $listboxsize - 1;
my $end_loop;
$loop = 1;
if ( !$listboxsize ) {
$lb_out->insert( "end", ":-O No files have been added to the list yet." );
$lb_out->insert( "end", " " );
}
else {
@file_list = $lb_in->get( 0, 'end' );
my $item;
$percent_done = 0;
$files_done = 0;
$EML_file_done = 0;
$progress->configure( -value => $percent_done );
$progress->update;
$total_files = $#file_list + 1;
foreach $item (@file_list) {
if ($loop) {
chomp $item;
my $filename = $item;
my @eml_file = split( /\./, $filename );
my $eml_filename;
my $xls_filename;
my $filetest;
if ( $filename =~ /\// ) {
my @xls_file_path = split( /\//, $filename );
$xls_filename = $xls_file_path[$#xls_file_path];
my $eml_file = $xls_filename;
chop($eml_file);
chop($eml_file);
chop($eml_file);
chop($eml_file);
if ( $eml_file[$#eml_file] eq 'xlsx' ) {
chop($eml_file);
}
$eml_filename = $eml_file . "\.xml";
}
else {
my @xls_file_path = split( /\\/, $filename );
$xls_filename = $xls_file_path[$#xls_file_path];
my $eml_file = $xls_filename;
chop($eml_file);
chop($eml_file);
chop($eml_file);
chop($eml_file);
if ( $eml_file[$#eml_file] eq 'xlsx' ) {
chop($eml_file);
}
$eml_filename = $eml_file . "\.xml";
}
# Check for xls or xlsx extension
if ( $eml_file[$#eml_file] eq 'xls' || $eml_file[$#eml_file] eq 'xlsx' ) {
# Check for value in cell B20 (should be Dataset Title)
my $Book;
my $Excel;
if ( $eml_file[$#eml_file] eq 'xls' ) {
$Excel = new Spreadsheet::ParseExcel;
$Book = Spreadsheet::ParseExcel::Workbook->Parse($filename);
}
elsif ( $eml_file[$#eml_file] eq 'xlsx' ) {
$Book = Spreadsheet::XLSX->new($filename);
}
my $WkS0 = $Book->{Worksheet}[0];
my $WkS1 = $Book->{Worksheet}[1];
if ( $WkS0->{Cells}[19][1] ) {
$filetest = $WkS0->{Cells}[19][1]->Value;
if ( $filetest eq 'Dataset Title' ) {
if ( !$save_dir ) {
$save_dir = "";
}
if ( !$schema ) {
$schema = "https://eml.ecoinformatics.org/eml-2.2.0/eml.xsd";
}
if ( !$stmml ) {
$stmml = "https://eml.ecoinformatics.org/eml-2.2.0/stmml.xsd";
}
if ( !$stylesheet ) {
$stylesheet = "";
}
if ( !$indent_level ) {
$indent_level = "2";
}
$lb_out->insert( "end", "Starting to convert $xls_filename to $eml_filename" );
my $files_done2 = &createEMLFile( $filename, $save_dir, $schema, $indent_level, $total_files, $files_done, $stmml, $stylesheet, $embed_data_checkbox );
$files_done = $files_done2;
$percent_done = ( $files_done / $total_files ) * 100;
$progress->configure( -value => $percent_done );
$progress->update;
}
else {
$files_done = $files_done + 1;
$percent_done = ( $files_done / $total_files ) * 100;
$progress->configure( -value => $percent_done );
$progress->update;
$lb_out->insert( "end", ":-O " . "$xls_filename" . " does not seem to be an Excel Metadata file." );
$lb_out->insert( "end", " (cell B20 should be Dataset Title)" );
$lb_out->insert( "end", " $filetest" );
$lb_out->insert( "end", " " );
}
}
else {
$files_done = $files_done + 1;
$percent_done = ( $files_done / $total_files ) * 100;
$progress->configure( -value => $percent_done );
$progress->update;
$lb_out->insert( "end", ":-O " . "$xls_filename" . " does not seem to be an Excel Metadata file." );
$lb_out->insert( "end", " (cell B20 should be Dataset Title)" );
$lb_out->insert( "end", " " );
}