source: main/trunk/greenstone3/bin/script/convert_coll_from_gs2.pl@ 28780

Last change on this file since 28780 was 28780, checked in by ak19, 10 years ago

Now the default version of the convert_coll_from_gs2.pl does not try to convert the GS2 format statements into GS3 format statements. Instead, the script embeds GS2 format statements in the new tag <gsf:format-gs2/>, so that GS3 does not try to process them and they are preserved so that they can be fed into the c++ binary formatconverter one at a time, so that this can process one format statement at a time. GLI will allow the user to inspect the converted format statements and correct them.

  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
File size: 29.9 KB
Line 
1#!/usr/bin/perl -w
2
3BEGIN {
4 die "GSDLHOME not set\n" unless defined $ENV{'GSDLHOME'};
5 die "GSDL3HOME not set\n" unless defined $ENV{'GSDL3HOME'};
6 die "GSDL3SRCHOME not set\n" unless defined $ENV{'GSDL3SRCHOME'};
7 die "GSDLOS not set\n" unless defined $ENV{'GSDLOS'};
8 unshift (@INC, "$ENV{'GSDLHOME'}/perllib");
9 unshift (@INC, "$ENV{'GSDL3SRCHOME'}/lib/perl/cpan");
10}
11
12use colcfg;
13use util;
14use parsargv;
15use FileHandle;
16use XML::Writer;
17#can't get this to work on windows
18#use GDBM_File;
19
20use strict;
21
22my $convert_format_stmts = 0;
23
24&main();
25sub print_usage() {
26 print STDOUT "Usage: convert_coll_from_gs2.pl [options] coll-name\n";
27 print STDOUT "options:\n";
28
29 print STDOUT " -collectdir Directory where collection lives.\n";
30 print STDOUT " -verbosity Controls the amount of output.\n";
31 print STDOUT " -defaultlang The language that is considered the default (for display text etc). defaults to 'en'\n";
32 print STDOUT " -convert_format_stmts (Deprecated.) Switch this on if you want the old behaviour of this script, which is \n";
33 print STDOUT " to process format statements using perl regular expressions.\n";
34 print STDOUT " This option is deprecated in favour of using 'formatconverter' which interprets \n";
35 print STDOUT " format statements directly using the same C++ parsing code as in GS2 runtime.\n\n";
36}
37
38
39sub main {
40
41 my ($defaultlang, $verbosity, $collectdir);
42 # note that no defaults are passed for most options as they're set
43 # later (after we check the collect.cfg file)
44 if (!&parsargv::parse(\@ARGV,
45 'verbosity/\d+/', \$verbosity,
46 'collectdir/.*/', \$collectdir,
47 'defaultlang/.*/', \$defaultlang,
48 'convert_format_stmts', \$convert_format_stmts)) {
49 &print_usage();
50 die "\n";
51 }
52
53 # get and check the collection name
54 my ($collection) = @ARGV;
55 if (!defined($collection) || $collection eq "") {
56 die "No collection specified\n";
57 }
58 if ($collection eq "gs2model") {
59 die "You cant convert the model collection\n";
60 }
61
62 if (!defined $collectdir || $collectdir eq "") {
63 $collectdir = &util::filename_cat ($ENV{'GSDLHOME'}, "collect");
64 }
65
66 if (!defined $defaultlang || $defaultlang eq "") {
67 $defaultlang = 'en';
68 }
69 # add on the coll name
70 $collectdir = &util::filename_cat ($collectdir, $collection);
71
72 my $collconfigfilename = &util::filename_cat ($collectdir, "etc", "collect.cfg");
73 print STDOUT "coll config=$collconfigfilename\n";
74 my $collectcfg;
75 if (-e $collconfigfilename) {
76 $collectcfg = &colcfg::read_collect_cfg ($collconfigfilename);
77
78 } else {
79 print STDERR "collect.cfg not found!!";
80 die "\n";
81 }
82
83
84 my $buildconfigfilename = &util::filename_cat ($collectdir, "index", "build.cfg");
85 my $buildcfg;
86 if (-e $buildconfigfilename) {
87 $buildcfg = &colcfg::read_build_cfg ($buildconfigfilename);
88
89 } else {
90 print STDERR "build.cfg not found!!";
91 die "\n";
92 }
93
94
95
96 my $colloutfile = &util::filename_cat ($collectdir, "etc", "collectionConfig.xml");
97 if (-e $colloutfile) {
98 print STDOUT "collectionConfig file already exists! overwriting it!\n";
99
100 }
101
102 my $buildoutfile = &util::filename_cat ($collectdir, "index", "buildConfig.xml");
103 if (-e $buildoutfile) {
104 print STDOUT "buildConfig file already exists! overwriting it!\n";
105
106 }
107
108# my $db_file = &util::filename_cat ($collectdir, "index", "text", "$collection.ldb");
109 my $database;
110# if (-e $db_file) {
111# $database = &open_database($db_file);
112# } else {
113# print STDERR "gdbm database file $db_file not found!!";
114# die "\n";
115# }
116
117 my $buildtype;
118 if (defined $buildcfg->{'buildtype'}) {
119 $buildtype = $buildcfg->{'buildtype'};
120 } else {
121 $buildtype = 'mg';
122 }
123
124 my $indexstem = undef;
125 if (defined $buildcfg->{'indexstem'}) {
126 $indexstem = $buildcfg->{'indexstem'};
127 }
128
129 my $buildoutput = new IO::File(">$buildoutfile");
130 binmode($buildoutput,":utf8");
131 my $buildwriter = new XML::Writer(OUTPUT => $buildoutput, NEWLINES => 1);
132
133 $buildwriter->xmlDecl("UTF-8");
134 $buildwriter->startTag('buildConfig', 'xmlns:gsf'=>"http://www.greenstone.org/greenstone3/schema/ConfigFormat");
135
136 my $colloutput = new IO::File(">$colloutfile");
137 binmode($colloutput,":utf8");
138 my $collwriter = new XML::Writer(OUTPUT => $colloutput, NEWLINES => 1);
139
140 $collwriter->xmlDecl("UTF-8");
141 $collwriter->startTag('CollectionConfig', 'xmlns:gsf'=>"http://www.greenstone.org/greenstone3/schema/ConfigFormat", 'xmlns:xsl'=>'http://www.w3.org/1999/XSL/Transform');
142
143 #output the collection metadata to the collectionConfig file
144 $collwriter->startTag('metadataList');
145
146 my $creator = $collectcfg->{'creator'};
147 &output_metadata($collwriter,'default', 'creator', $creator);
148 my $public =$collectcfg->{'public'};
149 &output_metadata($collwriter,'default', 'public', $public);
150
151 $collwriter->endTag('metadataList');
152
153 #output the display collectionmeta to collectionConfig.xml
154
155 my $collectionmeta = $collectcfg->{'collectionmeta'};
156 if (defined $collectionmeta) {
157 my %name_map = ('collectionname', 'name',
158 'collectionextra', 'description',
159 'iconcollection', 'icon',
160 'iconcollectionsmall', 'smallicon');
161
162 $collwriter->startTag('displayItemList');
163 foreach my $entry ( keys %$collectionmeta) {
164 # some metadata names need to be specially mapped to other names
165 # most of them however, can retain their original names
166 my $name = (defined $name_map{$entry}) ? $name_map{$entry} : $entry;
167 foreach my $lang (keys %{$collectionmeta->{$entry}}) {
168 my $value = $collectionmeta->{$entry}->{$lang};
169 if ($entry =~ /^icon/) {
170 $value = format_icon_value($value);
171 } else {
172 $value = tidy_up_display_item($value);
173 }
174 &output_display($collwriter, $name, $lang, $value);
175 }
176 }
177 $collwriter->endTag('displayItemList');
178 }
179
180 # output building metadata to build config file
181 my $numdocs = $buildcfg->{'numdocs'};
182 $buildwriter->startTag('metadataList');
183 &output_metadata($buildwriter,'', 'numDocs', $numdocs);
184 &output_metadata($buildwriter,'', 'buildType', $buildtype);
185 $buildwriter->endTag('metadataList');
186
187
188 #indexes
189 # maps index name to shortname
190 my $indexmap = {};
191 # keeps the order for indexes
192 my @indexlist = ();
193 my $defaultindex = "";
194 my $first = 1;
195 my $maptype = "indexfieldmap";
196 if ($buildtype eq "mg") {
197 $maptype = "indexmap";
198 }
199 if (defined $buildcfg->{$maptype}) {
200 my $indexmap_t = $buildcfg->{$maptype};
201 foreach my $i (@$indexmap_t) {
202 my ($k, $v) = $i =~ /^(.*)\-\>(.*)$/;
203 $indexmap->{$k} = $v;
204 push @indexlist, $k;
205 if ($first == 1) {
206 $defaultindex = $k;
207 $first = 0;
208 }
209 }
210 } else {
211 print STDERR "$maptype not defined\n";
212 }
213 # we use the shortname for default index
214 if (defined $collectcfg->{'defaultindex'}) {
215 $defaultindex = $collectcfg->{'defaultindex'};
216 #$defaultindex = $indexmap->{$defaultindex};
217 }
218
219 # levels
220 my $levelmap = {};
221 my @levellist = ();
222 my $default_search_level = "";
223 my $default_search_level_shortname = "";
224 my $default_retrieve_level = "Sec";
225 $first = 1;
226 if ($buildtype eq "mgpp" || $buildtype eq "lucene") {
227 if (defined $buildcfg->{'levelmap'}) {
228 my $levelmap_t = $buildcfg->{'levelmap'};
229 foreach my $l (@$levelmap_t) {
230 my ($k, $v) = $l =~ /^(.*)\-\>(.*)$/;
231 $levelmap->{$k} = $v;
232 push @levellist, $k;
233 if ($first) {
234 $default_search_level = $k;
235 $default_search_level_shortname = $v;
236 $first = 0;
237 }
238 }
239 }
240
241 if (defined $collectcfg->{'defaultlevel'}) {
242 $default_search_level = $collectcfg->{'defaultlevel'};
243 #$default_search_level = $levelmap->{$default_search_level};
244 $default_search_level_shortname = $levelmap->{$default_search_level};
245 }
246 if (defined $buildcfg->{'textlevel'}) {
247 $default_retrieve_level = $buildcfg->{'textlevel'};
248 }
249 }
250 # format stuff
251 my $format = $collectcfg->{'format'};
252
253 #output the search stuff to coll cfg
254 $collwriter->startTag('search','type'=>$buildtype);
255 foreach my $i (keys %$indexmap) {
256 $collwriter->startTag('index', 'name'=>$i);
257 #find the coll meta stuff
258 my $indexdisplay = ".$i";
259 foreach my $lang (keys %{$collectionmeta->{$indexdisplay}}) {
260 my $value = $collectionmeta->{$indexdisplay}->{$lang};
261 output_display($collwriter, 'name', $lang, $i);
262 }
263 $collwriter->endTag('index');
264 }
265
266 #output the defaultIndex to coll cfg
267 $collwriter->emptyTag('defaultIndex','name'=>$defaultindex);
268
269 # indexOptions
270 if (defined $collectcfg->{'indexoptions'}) {
271 foreach my $i (@{$collectcfg->{'indexoptions'}}) {
272 $collwriter->emptyTag('indexOption', 'name'=>$i);
273 }
274 }
275
276 #indexSubcollection
277 my $indexsubcollections = $collectcfg->{'indexsubcollections'};
278
279 if (defined $indexsubcollections) {
280 my $indexsubcollections_t= $collectcfg->{'indexsubcollections'};
281 foreach my $i ( @$indexsubcollections_t) {
282 $collwriter->startTag('indexSubcollection', 'name'=>$i);
283 &output_display($collwriter, 'name', $defaultlang, $i);
284 $collwriter->endTag('indexSubcollection');
285 }
286 }
287
288 #subcollection
289 my $subcollection = $collectcfg->{'subcollection'};
290 if (defined $subcollection){
291 foreach my $entry (keys %$subcollection){
292 my $value = $subcollection->{$entry};
293 $collwriter->emptyTag('subcollection','filter'=>$value,'name'=>$entry);
294 }
295 }
296
297 #indexlanguage
298 my $languages = $collectcfg->{'languages'};
299 if (defined $languages){
300 my $languages_t = $collectcfg->{'languages'};
301 foreach my $i (@$languages_t){
302 $collwriter->startTag('indexLanguage','name'=>$i);
303 &output_display($collwriter, 'name', $defaultlang, $i);
304 $collwriter->endTag('indexLanguage');
305 }
306 }
307
308 # level stuff for mgpp/lucene
309 if ($buildtype eq 'mgpp' || $buildtype eq 'lucene'){
310 foreach my $l (keys %$levelmap) {
311 $collwriter->startTag('level', 'name'=>$l);
312 #find the coll meta stuff
313 my $leveldisplay = ".$l";
314 foreach my $lang (keys %{$collectionmeta->{$leveldisplay}}) {
315 my $value = $collectionmeta->{$leveldisplay}->{$lang};
316 output_display($collwriter, 'name', $lang, $value);
317 }
318 $collwriter->endTag('level');
319 }
320 $collwriter->emptyTag('defaultLevel', 'name'=>$default_search_level);
321 }
322
323 # add in the search type
324 if (defined $format->{'SearchTypes'}){
325 $collwriter->startTag('format', 'name'=>"searchType");
326 $collwriter->charactersXML($format->{'SearchTypes'});
327 $collwriter->endTag('format');
328 }
329
330 # add in the format stuff
331 if (defined $format->{'SearchVList'}) {
332
333 $collwriter->startTag('format');
334 write_format($collwriter, $format->{'SearchVList'}, "document");
335 $collwriter->endTag('format');
336 }
337 elsif (defined $format->{'VList'}) {
338 $collwriter->startTag('format');
339 write_format($collwriter, $format->{'VList'}, "document");
340 $collwriter->endTag('format');
341 }
342
343 $collwriter->endTag('search');
344
345 # import plugins
346 # if ImagePlugin is added, then need to add in a replaceListRef element for gs2-image
347 my $contains_image_plugin = 0;
348
349 my $plugins = $collectcfg->{'plugin'};
350
351 if (defined $plugins){
352 $collwriter->startTag('import');
353 $collwriter->startTag('pluginList');
354 foreach my $pl (@$plugins) {
355 my ($pluginname) = @$pl[0];
356 if ($pluginname =~ m/^(ImagePlugin|ImagePlug|PagedImagePlugin)$/) {
357 $contains_image_plugin = 1;
358 }
359 $collwriter->startTag('plugin','name'=>$pluginname);
360
361 for (my $i=1; $i<scalar(@$pl); $i++) {
362 my $arg =@$pl[$i];
363 if ($arg =~ /^-/){
364 my $option_name=@$pl[$i];
365 my $option_value=@$pl[$i+1];
366 if (defined $option_value){
367 if ($option_value =~ /^-/){
368 $collwriter->startTag('option','name'=>$option_name);
369 $collwriter->endTag('option');
370 }else{
371 $collwriter->startTag('option','name'=>$option_name,'value'=>$option_value);
372 $collwriter->endTag('option');
373 }
374 }
375 }
376 }
377 $collwriter->endTag('plugin');
378 }
379 $collwriter->endTag('pluginList');
380 $collwriter->endTag('import');
381 }
382
383 $buildwriter->startTag('serviceRackList');
384
385 my @levels = ();
386 my $defaultlevel;
387 my $service_type = "MG";
388 if ($buildtype eq 'mgpp') {
389 $service_type = "MGPP";
390 } elsif ($buildtype eq "lucene") {
391 $service_type = "Lucene";
392 }
393
394 #indexSubcollectionList
395
396 my $subcollectionmap = $buildcfg->{'subcollectionmap'};
397 my $firstsubcollection = 1;
398 my $defaultsubcollection = "";
399 my @subcollist;
400 my $subcolmap = {};
401
402 if (defined $buildcfg->{'subcollectionmap'}) {
403 my $subcolmap_t = $buildcfg->{'subcollectionmap'};
404
405 foreach my $l (@$subcolmap_t) {
406 my @pair = split(/->/, $l);
407 $subcolmap->{$pair[0]} = $pair[1];
408 push @subcollist, $pair[0];
409 if ($firstsubcollection==1) {
410 $defaultsubcollection = $pair[1];
411 $firstsubcollection = 0;
412 }
413 }
414
415 }
416
417
418 #do the retrieve service
419 $buildwriter->startTag('serviceRack', 'name'=>"GS2".$service_type."Retrieve");
420 if ($buildtype eq 'mgpp' || $buildtype eq 'lucene') {
421 $buildwriter->emptyTag('defaultLevel', 'shortname'=>$default_retrieve_level);
422 } elsif ($buildtype eq "mg") {
423 $buildwriter->emptyTag('defaultIndex', 'shortname'=>$defaultindex);
424 }
425
426 if ((defined $defaultsubcollection) && ($defaultsubcollection ne "")) {
427 $buildwriter->emptyTag('defaultIndexSubcollection', 'shortname'=>$defaultsubcollection);
428 }
429
430 if (defined $indexstem) {
431 $buildwriter->emptyTag('indexStem', 'name'=>$indexstem);
432 }
433 # close off the Retrieve service
434 $buildwriter->endTag('serviceRack');
435
436 # add in the classifiers if needed
437
438 my $count = 1;
439 my $phind = 0;
440 my $started_classifiers = 0;
441 if (defined $collectcfg->{'classify'}) {
442 $collwriter->startTag('browse');
443 # add in default format if necessary
444 if (defined $format->{"VList"} || defined $format->{"HList"}) {
445 # global formats
446 $collwriter->startTag('format');
447 if (defined $format->{"VList"}) {
448 # VLIst applies to both classifier and doc nodes
449 write_format($collwriter, $format->{"VList"}, "document");
450 write_format($collwriter, $format->{"VList"}, "classifier");
451 }
452 if (defined $format->{"HList"}) {
453 # hlist is only for classifier nodes
454 write_format($collwriter, $format->{"HList"}, "horizontal");
455 }
456 $collwriter->endTag('format');
457 }
458 my $classifiers = $collectcfg->{'classify'};
459 foreach my $cl (@$classifiers) {
460 my $name = "CL$count";
461 $count++;
462 my ($classname) = @$cl[0];
463 if ($classname =~ /^phind$/i) {
464 $phind=1;
465 #should add it into coll config classifiers
466 next;
467 }
468
469 my $horizontalAtTop = &isHorizontalClassifier($database, $name);
470 if (not $started_classifiers) {
471 $buildwriter->startTag('serviceRack', 'name'=>'GS2Browse');
472 if (defined $indexstem) {
473 $buildwriter->emptyTag('indexStem', 'name'=>$indexstem);
474 }
475
476 $buildwriter->startTag('classifierList');
477 $started_classifiers = 1;
478 }
479 my $content = ''; #use buttonname first, then metadata
480 if ($classname eq "DateList") {
481 $content = "Date";
482 } else {
483 for (my $i=0; $i<scalar(@$cl); $i++) {
484 my $arg = @$cl[$i];
485 if ($arg eq "-buttonname"){
486 $content = @$cl[$i+1];
487 last;
488 } elsif ($arg eq "-metadata") {
489 $content = @$cl[$i+1];
490 }
491
492 }
493 }
494 if ($horizontalAtTop) {
495 $buildwriter->emptyTag('classifier', 'name'=>$name, 'content'=>$content, 'horizontalAtTop'=>'true');
496
497 } else {
498 $buildwriter->emptyTag('classifier', 'name'=>$name, 'content'=>$content);
499 }
500
501
502 # $collwriter->startTag('classifier', 'name'=>$name);
503 $collwriter->startTag('classifier', 'name'=>$classname);
504 for (my $i=1; $i<scalar(@$cl); $i++) {
505 my $arg =@$cl[$i];
506 if ($arg =~ /^-/){
507 my $option_name=@$cl[$i];
508 my $option_value=@$cl[$i+1];
509 if (defined $option_value){
510 if ($option_value=~ /^-/){
511 $collwriter->startTag('option','name'=>$option_name);
512 $collwriter->endTag('option');
513 }else{
514 $collwriter->startTag('option','name'=>$option_name,'value'=>$option_value);
515 $collwriter->endTag('option');
516 }
517 }
518 }
519 }
520
521 my $vlist = $name."VList";
522 my $hlist = $name."HList";
523 my $dlist = "";
524 if ($classname eq "DateList") {
525 $dlist = "DateList";
526 }
527 # need to work out how to split into classifier and document
528 if (defined $format->{$vlist} || defined $format->{$hlist} || defined $format->{$dlist}) {
529 $collwriter->startTag('format');
530 if (defined $format->{$vlist}) {
531 write_format($collwriter, $format->{$vlist}, "document");
532 write_format($collwriter, $format->{$vlist}, "classifier");
533 }
534 if (defined $format->{$hlist}) {
535 write_format($collwriter, $format->{$hlist}, "horizontal");
536 }
537
538 if (defined $format->{$dlist}) {
539 write_format($collwriter, $format->{$dlist}, "document");
540 }
541 $collwriter->endTag('format');
542 }
543 $collwriter->endTag('classifier');
544 } #foreach classifier
545 if ($started_classifiers) {
546 # end the classifiers
547 $buildwriter->endTag('classifierList');
548 # close off the Browse service
549 $buildwriter->endTag('serviceRack');
550 }
551
552 $collwriter->endTag('browse');
553 }
554
555
556 # the phind classifier is a separate service
557 if ($phind) {
558 # if phind classifier
559 $buildwriter->emptyTag('serviceRack', 'name'=>'PhindPhraseBrowse');
560 }
561
562 # do the search service
563 $buildwriter->startTag('serviceRack', 'name'=>'GS2'.$service_type.'Search');
564 #$buildwriter->emptyTag('defaultIndex', 'shortname'=>$defaultindex);
565 $buildwriter->startTag('indexList');
566 #for each index
567 foreach my $i (@indexlist) {
568 my $index = $indexmap->{$i};
569 $buildwriter->emptyTag('index', 'name'=>$i, 'shortname'=>$index);
570 }
571 $buildwriter->endTag('indexList');
572 if (defined $indexstem) {
573 $buildwriter->emptyTag('indexStem', 'name'=>$indexstem);
574 }
575
576 # index options
577 if ($buildtype eq 'mg' || $buildtype eq 'mgpp') {
578 $buildwriter->startTag('indexOptionList');
579 my $stemindexes = 3; # default is stem and casefold
580 if (defined $buildcfg->{'stemindexes'} && $buildcfg->{'stemindexes'} =~ /^\d+$/ ) {
581 $stemindexes = $buildcfg->{'stemindexes'};
582 }
583 $buildwriter->emptyTag('indexOption', 'name'=>'stemIndexes', 'value'=>$stemindexes);
584
585 my $maxnumeric = 4; # default
586 if (defined $buildcfg->{'maxnumeric'} && $buildcfg->{'maxnumeric'} =~ /^\d+$/) {
587 $maxnumeric = $buildcfg->{'maxnumeric'};
588 }
589 $buildwriter->emptyTag('indexOption', 'name'=>'maxnumeric', 'value'=>$maxnumeric);
590
591 $buildwriter->endTag('indexOptionList');
592 }
593
594 if ($buildtype eq 'mgpp' || $buildtype eq 'lucene') {
595
596 # level info
597 $buildwriter->emptyTag('defaultLevel', 'shortname'=>$default_search_level_shortname);
598 $buildwriter->emptyTag('defaultGDBMLevel', 'shortname'=>$default_retrieve_level);
599 $buildwriter->startTag('levelList');
600 foreach my $l (@levellist) {
601 my $level = $levelmap->{$l};
602 $buildwriter->emptyTag('level', 'name'=>$l, 'shortname'=>$level);
603 }
604 $buildwriter->endTag('levelList');
605
606 # do the search types if there
607 if (defined $collectcfg->{'searchtype'}) {
608 $buildwriter->startTag('searchTypeList');
609 foreach my $st (@{$collectcfg->{'searchtype'}}) {
610 $buildwriter->emptyTag('searchType', 'name'=>$st);
611 }
612 $buildwriter->endTag('searchTypeList');
613 } elsif (defined $format->{'SearchTypes'}) {
614 #check format statement
615 my $searchtype = $format->{'SearchTypes'};
616 $buildwriter->startTag('searchTypeList');
617 if ($searchtype =~ /form/) {
618 $buildwriter->emptyTag('searchType', 'name'=>'form');
619 }
620 if ($searchtype =~ /plain/) {
621 $buildwriter->emptyTag('searchType', 'name'=>'plain');
622 }
623 $buildwriter->endTag('searchTypeList');
624 }
625 }
626
627 #indexLanguageList
628 my $indexlanguages = $collectcfg->{'languages'};
629 my $firstindexlanguage = 1;
630 my $defaultindexlanguage_shortname;
631 if (defined $indexlanguages){
632 $buildwriter->startTag('indexLanguageList');
633 my $languages_t = $collectcfg->{'languages'};
634 foreach my $i (@$languages_t){
635 $buildwriter->startTag('indexLanguage','name'=>$i);
636 &output_display($buildwriter, 'name', $i, $i);
637 $buildwriter->endTag('indexLanguage');
638 if ($firstindexlanguage==1){
639 $defaultindexlanguage_shortname = $i;
640 $firstindexlanguage=0;
641 }
642 }
643 $buildwriter->endTag('indexLanguageList');
644 $buildwriter->startTag('defaultIndexLanguage', 'name'=>$defaultindexlanguage_shortname,'shortname'=>$defaultindexlanguage_shortname);
645 $buildwriter->endTag('defaultIndexLanguage');
646 }
647
648 # my $defaultsubcollection = "";
649 # my @subcollist;
650
651 if (scalar(@subcollist)>0){
652
653 $buildwriter->startTag('indexSubcollectionList');
654 foreach my $i (keys %$subcolmap){
655 my $short_name = $subcolmap->{$i};
656 $buildwriter->emptyTag('indexSubcollection', 'name'=>$i, 'shortname'=>$short_name);
657 }
658
659 $buildwriter->endTag('indexSubcollectionList');
660 $buildwriter->emptyTag('defaultIndexSubcollection', 'shortname'=>$defaultsubcollection);
661 }
662
663
664 $buildwriter->endTag('serviceRack');
665
666 $buildwriter->endTag('serviceRackList');
667 $buildwriter->endTag('buildConfig');
668
669 # we add in the default replace list just in case we have macros in the
670 # collection
671 $collwriter->emptyTag('replaceListRef', 'id'=>'gs2-standard');
672 $collwriter->emptyTag('replaceListRef', 'id'=>'gs2-image') if $contains_image_plugin;
673 $collwriter->endTag('CollectionConfig');
674 $collwriter->end();
675 $buildwriter->end();
676 $buildoutput->close();
677 $colloutput->close();
678 &close_database($database);
679}
680
681
682sub output_metadata {
683 my ($writer, $lang, $metaname, $metavalue) = @_;
684 $lang = 'en' if $lang eq 'default';
685 if ($lang ne ""){
686 $writer->startTag('metadata', 'lang'=>$lang, 'name'=>$metaname);
687 }else{
688 $writer->startTag('metadata', 'name'=>$metaname);
689 }
690 $writer->characters($metavalue);
691 $writer->endTag('metadata');
692}
693
694sub output_display {
695 my ($writer, $name, $lang, $value) = @_;
696 $lang = 'en' if $lang eq 'default';
697 if ($lang =~ /^\[/) {
698 ($lang) = $lang =~ /\[l=(.*)\]/;
699 }
700
701 $writer->startTag('displayItem', 'name'=>$name, 'lang'=>$lang);
702 $writer->characters($value);
703 $writer->endTag('displayItem');
704}
705sub format_icon_value {
706 my ($value) = @_;
707 if ($value =~ /^_/) {
708 my ($newvalue) = $value =~ /images\/(.*)$/;
709 if ($newvalue) {
710 return $newvalue;
711 }
712 }
713 return $value;
714}
715
716sub tidy_up_display_item {
717 my ($value) = @_;
718 # remove \n
719 $value =~ s/\\n//g;
720 # replace \' with '
721 $value =~ s/\\\'/\'/g;
722 # replace \" with "
723 $value =~ s/\\\"/\"/g;
724 # replace _httpprefix_ with _httpsite_
725 $value =~ s/_httpprefix_/_httpsite_/g;
726 $value =~ s/_gwcgi_//g;
727 $value =~ s/[a-z][a-z]?=_cgiarg[a-z][a-z]?_&?//g;
728 $value =~ s/&p=/&sa=/g;
729 return $value;
730}
731
732sub format_if_or {
733 my ($format, $node_type) = @_;
734
735 # while we find nested if/or statements, recurse to find more nested if/or statements,
736 # and try to expand (process) these nested statements starting from innermost going to outermost
737
738 while($format =~ m/^.*\{(?:If|Or)\}\{[^\}\{]*\{/) { # contains nested if/or statement, expand it
739
740 my ($prefix, $nested_to_process, $suffix) = $format =~ m/^(.*\{(?:If|Or)\}\{[^\}\{]*)(\{[^\}]*\}\s*\{[^\}]*\})(.*)$/g; # recursion step
741
742 #print STDERR "prefix: |$prefix|\n\nnested: |$nested_to_process|\n\nsuffix: |$suffix|\n\n";
743 $format = $prefix . &format_if_or($nested_to_process, $node_type) . $suffix;
744 }
745
746 if($format =~ m/\{(If|Or)\}\{[^\}\{]*\}/g) { # base step: contains if/or statement(s), but none nested
747 # expand them
748 $format =~ s/\{If\}\{([^\}]*)\}/&format_if($1, $node_type)/eg;
749 $format =~ s/\{Or\}\{([^\}]*)\}/&format_or($1)/eg;
750 }
751 return $format;
752}
753
754sub write_format {
755 my ($writer, $old_format, $node_type) = @_;
756
757 if($convert_format_stmts) {
758
759 # replace \' with '
760 $old_format =~ s/\\\'/\'/g;
761 # replace \" with "
762 $old_format =~ s/\\\"/\"/g;
763 #convert [] to <gsf:...>
764 # now handles nested {If} and {Or}
765 $old_format = &format_if_or($old_format, $node_type);
766 $old_format =~ s/\[Text\]/\<gsf:text\/\>/g;
767 $old_format =~ s/\[num\]/\<gsf:num\/\>/g;
768 $old_format =~ s/\[link\]/\<gsf:link type=\'$node_type\'\>/g;
769 $old_format =~ s/\[\/link\]/\<\/gsf:link\>/g;
770 $old_format =~ s/\[srclink\]/\<gsf:link type=\'source\'\>/g;
771 $old_format =~ s/\[\/srclink\]/\<\/gsf:link\>/g;
772 $old_format =~ s/\[icon\]/\<gsf:icon type=\'$node_type\'\/\>/g;
773 $old_format =~ s/\[srcicon\]/\<gsf:icon type=\'source\'\/\>/g;
774
775 # what to do with hightlight??
776 $old_format =~ s/\[\/?highlight\]//g;
777
778 #now do the rest of the [] which are assumed to be metadata
779 $old_format =~ s/\[([^\]]*)\]/&format_metadata($1)/eg;
780
781 # some html tidy
782 #turn <br> into <br />
783 $old_format =~ s/\<br\>/\<br \/\>/g;
784 #turn <p> into <p />
785 $old_format =~ s/\<p\>/\<p \/\>/g;
786
787 #put quotes around any atts
788 $old_format =~ s/=([a-z]+)([> ])/=\'$1\'$2/g;
789 }
790 else { # not converting format statements, leave them as GS2 format stmts,
791 # so that formatconverter can convert them and users can oversee the conversion in GLI,
792 # but nest the GS2 statements here in an xml tag that won't be processed by GS3
793 $old_format = "<gsf:format-gs2>" . $old_format . "</gsf:format-gs2>";
794 }
795
796 if ($node_type eq "document") {
797 $writer->startTag('gsf:template', 'match'=>'documentNode');
798 $writer->charactersXML($old_format);
799 $writer->endTag('gsf:template');
800 } elsif ($node_type eq "classifier") {
801 $writer->startTag('gsf:template', 'match'=>'classifierNode');
802 $writer->charactersXML($old_format);
803 $writer->endTag('gsf:template');
804 } elsif ($node_type eq "horizontal") {
805 $writer->startTag('gsf:template', 'match'=>'classifierNode', 'mode'=>'horizontal');
806 $writer->charactersXML($old_format);
807 $writer->endTag('gsf:template');
808
809 }
810}
811
812sub format_metadata {
813 my ($metadata_string) = @_;
814
815 #print STDERR "original meta = $metadata_string\n";
816
817 # what shall we do with cgisafe??
818 my $cgisafe = $metadata_string =~ s/^cgisafe://;
819
820 my ($select) = $metadata_string =~ /^(parent|sibling)/;
821 $metadata_string =~ s/^(parent|sibling)//;
822 my ($scope, $delim);
823
824 if ($select) {
825 ($scope) = $metadata_string =~ /^\((Top|All)/;
826 $metadata_string =~ s/^\((Top|All)\)?//;
827 if ($scope) {
828 ($delim) = $metadata_string =~ /^\'([^\']*)\'\)/;
829 $metadata_string =~ s/^\'([^\']*)\'\)//;
830 }
831 }
832 $metadata_string =~ s/^://;
833 # remove ex.
834 $metadata_string =~ s/^ex\.//;
835
836 #print STDERR "select=$select, scope=$scope, delim=|$delim|, meta = $metadata_string\n";
837
838 my $new_format = "<gsf:metadata name='$metadata_string' ";
839 if (defined $select) {
840 if ($select eq "sibling") {
841 $new_format .= "multiple='true' ";
842 if (defined $delim) {
843 $new_format .= "separator='$delim' ";
844 }
845 } elsif ($select eq "parent"){
846 if (defined $scope) {
847 if ($scope eq "Top") {
848 $new_format .= "select='root' ";
849 } elsif ($scope eq "All") {
850 $new_format .= "select='ancestors' ";
851 if (defined $delim) {
852 $new_format .= "separator='$delim' ";
853 }
854 }
855 } else {
856 $new_format .= "select='parent' ";
857 }
858 }
859 }
860 $new_format .= "/>";
861 #print STDERR "$new_format\n";
862 return $new_format;
863
864}
865
866sub format_if {
867
868 my ($if_string, $node_type) = @_;
869 #print STDERR "if string = $if_string\n";
870
871 my @parts = split /,/, $if_string;
872 my $test = $parts[0];
873 my $true_option = $parts[1];
874 my $false_option;
875 if (scalar (@parts) == 3) {
876 $false_option = $parts[2];
877 }
878 $test =~ s/^\s*//;
879 $test =~ s/\s*$//;
880 my ($test_meta, $test_type, $test_value);
881 if ($test =~ /^(\[.+\])$/) {
882 $test_meta = $1;
883 $test_type = 'exists';
884 } else {
885 my ($lhs, $exp, $rhs) = $test =~ /^(.+)\s+(eq|ne|lt|gt|le|ge|sw|ew)\s+(.+)$/;
886 #print STDERR "lhs, exp, rhs = $lhs, $exp, $rhs\n";
887 if ($exp eq "eq") {
888 $test_type = "equals";
889 } elsif ($exp eq "sw") {
890 $test_type = "startsWith";
891 } elsif ($exp eq "ew") {
892 $test_type = "endsWith";
893 } elsif ($exp eq "ne") {
894 $test_type = "notEquals";
895 } elsif ($exp eq "lt") {
896 $test_type = "lessThan";
897 }elsif ($exp eq "gt") {
898 $test_type = "greaterThan";
899 }elsif ($exp eq "le") {
900 $test_type = "lessThanOrEquals";
901 }elsif ($exp eq "ge") {
902 $test_type = "greaterThanOrEquals";
903 }
904 if ($lhs =~ /^\[.+\]$/) {
905 $test_meta = $lhs;
906 $test_value = $rhs;
907 } else {
908 # assume rhs has meta
909 $test_meta = $rhs;
910 $test_value = $lhs;
911 }
912
913 #remove beginning and end quotes
914 $test_value =~ s/^[\'\"]//;
915 $test_value =~ s/[\'\"]$//;
916 }
917 my $test_atts = "test='$test_type' ";
918 if (defined $test_value) {
919 $test_atts .= "test-value='$test_value' ";
920 }
921 #print STDERR "test, true, false = $test, $true_option, $false_option\n";
922 my $new_format = "<gsf:switch>$test_meta";
923 $new_format .= "<gsf:when $test_atts>$true_option</gsf:when>";
924 if (defined $false_option) {
925 $new_format .="<gsf:otherwise>$false_option</gsf:otherwise>";
926 }
927 $new_format .= "</gsf:switch>";
928
929 #print STDERR "new format = $new_format\n";
930 return $new_format;
931}
932
933sub format_or {
934 my ($or_string) = @_;
935 my @meta_list = split (',', $or_string);
936 return "" unless scalar (@meta_list);
937 my $new_format = "<gsf:choose-metadata>";
938 foreach my $m (@meta_list) {
939 if ($m =~ /^\[(.*)\]$/) {
940 $new_format .= &format_metadata($1);
941 } else {
942 # a default value
943 $new_format .= "<gsf:default>$m</gsf:default>";
944 last;
945 }
946 }
947 $new_format .= "</gsf:choose-metadata>";
948 return $new_format;
949}
950
951sub open_database {
952 my ($db_file) = @_;
953
954 my $database = ();
955# tie (%$database, 'GDBM_File', $db_file, GDBM_READER, 0400) ||
956# die "Couldn't open database $db_file\n";
957
958 return $database;
959}
960
961sub close_database {
962 my ($database) = @_;
963 untie %$database;
964}
965sub isHorizontalClassifier {
966 my ($database, $name) = @_;
967
968 return 0; # can't get this to work for windows
969 my $record = $database->{$name};
970 my ($childtype) = $record =~ /<childtype>(\w*)/;
971 if ($childtype eq "HList") {
972 return 1;
973 }
974 return 0;
975}
976#$writer->startTag('');
977#$writer->endTag('');
978#$writer->characters();
979#$writer->emptyTag('');
980
9811;
Note: See TracBrowser for help on using the repository browser.