Bug 15967: Use the email template if the print template does not exist
[koha.git] / misc / translator / LangInstaller.pm
1 package LangInstaller;
2
3 # Copyright (C) 2010 Tamil s.a.r.l.
4 #
5 # This file is part of Koha.
6 #
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
11 #
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
16 #
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
19
20 use Modern::Perl;
21
22 use C4::Context;
23 # WARNING: Any other tested YAML library fails to work properly in this
24 # script content
25 use YAML::Syck qw( Dump LoadFile );
26 use Locale::PO;
27 use FindBin qw( $Bin );
28
29 $YAML::Syck::ImplicitTyping = 1;
30
31
32 # Default file header for .po syspref files
33 my $default_pref_po_header = Locale::PO->new(-msgid => '', -msgstr =>
34     "Project-Id-Version: PACKAGE VERSION\\n" .
35     "PO-Revision-Date: YEAR-MO-DA HO:MI +ZONE\\n" .
36     "Last-Translator: FULL NAME <EMAIL\@ADDRESS>\\n" .
37     "Language-Team: Koha Translate List <koha-translate\@lists.koha-community.org>\\n" .
38     "MIME-Version: 1.0\\n" .
39     "Content-Type: text/plain; charset=UTF-8\\n" .
40     "Content-Transfer-Encoding: 8bit\\n" .
41     "Plural-Forms: nplurals=2; plural=(n > 1);\\n"
42 );
43
44
45 sub set_lang {
46     my ($self, $lang) = @_;
47
48     $self->{lang} = $lang;
49     $self->{po_path_lang} = $self->{context}->config('intrahtdocs') .
50                             "/prog/$lang/modules/admin/preferences";
51 }
52
53
54 sub new {
55     my ($class, $lang, $pref_only, $verbose) = @_;
56
57     my $self                 = { };
58
59     my $context              = C4::Context->new();
60     $self->{context}         = $context;
61     $self->{path_pref_en}    = $context->config('intrahtdocs') .
62                                '/prog/en/modules/admin/preferences';
63     set_lang( $self, $lang ) if $lang;
64     $self->{pref_only}       = $pref_only;
65     $self->{verbose}         = $verbose;
66     $self->{process}         = "$Bin/tmpl_process3.pl " . ($verbose ? '' : '-q');
67     $self->{path_po}         = "$Bin/po";
68     $self->{po}              = { '' => $default_pref_po_header };
69     $self->{domain}          = 'messages';
70     $self->{cp}              = `which cp`;
71     $self->{msgmerge}        = `which msgmerge`;
72     $self->{xgettext}        = `which xgettext`;
73     $self->{sed}             = `which sed`;
74     chomp $self->{cp};
75     chomp $self->{msgmerge};
76     chomp $self->{xgettext};
77     chomp $self->{sed};
78
79     unless ($self->{xgettext}) {
80         die "Missing 'xgettext' executable. Have you installed the gettext package?\n";
81     }
82
83     # Get all .pref file names
84     opendir my $fh, $self->{path_pref_en};
85     my @pref_files = grep { /.pref/ } readdir($fh);
86     close $fh;
87     $self->{pref_files} = \@pref_files;
88
89     # Get all available language codes
90     opendir $fh, $self->{path_po};
91     my @langs =  map { ($_) =~ /(.*)-pref/ }
92         grep { $_ =~ /.*-pref/ } readdir($fh);
93     closedir $fh;
94     $self->{langs} = \@langs;
95
96     # Map for both interfaces opac/intranet
97     my $opachtdocs = $context->config('opachtdocs');
98     $self->{interface} = [
99         {
100             name   => 'Intranet prog UI',
101             dir    => $context->config('intrahtdocs') . '/prog',
102             suffix => '-staff-prog.po',
103         },
104         {
105             name   => 'Intranet prog help',
106             dir    => $context->config('intrahtdocs') . '/prog/en/modules/help',
107             suffix => '-staff-help.po',
108         },
109     ];
110
111     # OPAC themes
112     opendir my $dh, $context->config('opachtdocs');
113     for my $theme ( grep { not /^\.|lib/ } readdir($dh) ) {
114         push @{$self->{interface}}, {
115             name   => "OPAC $theme",
116             dir    => "$opachtdocs/$theme",
117             suffix => "-opac-$theme.po",
118         };
119     }
120
121     # MARC flavours (hardcoded list)
122     for ( "MARC21", "UNIMARC", "NORMARC" ) {
123         # search for strings on staff & opac marc files
124         my $dirs = $context->config('intrahtdocs') . '/prog';
125         opendir $fh, $context->config('opachtdocs');
126         for ( grep { not /^\.|\.\.|lib$/ } readdir($fh) ) {
127             $dirs .= ' ' . "$opachtdocs/$_";
128         }
129         push @{$self->{interface}}, {
130             name   => "$_",
131             dir    => $dirs,
132             suffix => "-marc-$_.po",
133         };
134     }
135
136     bless $self, $class;
137 }
138
139
140 sub po_filename {
141     my $self = shift;
142
143     my $context    = C4::Context->new;
144     my $trans_path = $Bin . '/po';
145     my $trans_file = "$trans_path/" . $self->{lang} . "-pref.po";
146     return $trans_file;
147 }
148
149
150 sub po_append {
151     my ($self, $id, $comment) = @_;
152     my $po = $self->{po};
153     my $p = $po->{$id};
154     if ( $p ) {
155         $p->comment( $p->comment . "\n" . $comment );
156     }
157     else {
158         $po->{$id} = Locale::PO->new(
159             -comment => $comment,
160             -msgid   => $id,
161             -msgstr  => ''
162         );
163     }
164 }
165
166
167 sub add_prefs {
168     my ($self, $comment, $prefs) = @_;
169
170     for my $pref ( @$prefs ) {
171         my $pref_name = '';
172         for my $element ( @$pref ) {
173             if ( ref( $element) eq 'HASH' ) {
174                 $pref_name = $element->{pref};
175                 last;
176             }
177         }
178         for my $element ( @$pref ) {
179             if ( ref( $element) eq 'HASH' ) {
180                 while ( my ($key, $value) = each(%$element) ) {
181                     next unless $key eq 'choices';
182                     next unless ref($value) eq 'HASH';
183                     for my $ckey ( keys %$value ) {
184                         my $id = $self->{file} . "#$pref_name# " . $value->{$ckey};
185                         $self->po_append( $id, $comment );
186                     }
187                 }
188             }
189             elsif ( $element ) {
190                 $self->po_append( $self->{file} . "#$pref_name# $element", $comment );
191             }
192         }
193     }
194 }
195
196
197 sub get_trans_text {
198     my ($self, $id) = @_;
199
200     my $po = $self->{po}->{$id};
201     return unless $po;
202     return Locale::PO->dequote($po->msgstr);
203 }
204
205
206 sub update_tab_prefs {
207     my ($self, $pref, $prefs) = @_;
208
209     for my $p ( @$prefs ) {
210         my $pref_name = '';
211         next unless $p;
212         for my $element ( @$p ) {
213             if ( ref( $element) eq 'HASH' ) {
214                 $pref_name = $element->{pref};
215                 last;
216             }
217         }
218         for my $i ( 0..@$p-1 ) {
219             my $element = $p->[$i];
220             if ( ref( $element) eq 'HASH' ) {
221                 while ( my ($key, $value) = each(%$element) ) {
222                     next unless $key eq 'choices';
223                     next unless ref($value) eq 'HASH';
224                     for my $ckey ( keys %$value ) {
225                         my $id = $self->{file} . "#$pref_name# " . $value->{$ckey};
226                         my $text = $self->get_trans_text( $id );
227                         $value->{$ckey} = $text if $text;
228                     }
229                 }
230             }
231             elsif ( $element ) {
232                 my $id = $self->{file} . "#$pref_name# $element";
233                 my $text = $self->get_trans_text( $id );
234                 $p->[$i] = $text if $text;
235             }
236         }
237     }
238 }
239
240
241 sub get_po_from_prefs {
242     my $self = shift;
243
244     for my $file ( @{$self->{pref_files}} ) {
245         my $pref = LoadFile( $self->{path_pref_en} . "/$file" );
246         $self->{file} = $file;
247         # Entries for tab titles
248         $self->po_append( $self->{file}, $_ ) for keys %$pref;
249         while ( my ($tab, $tab_content) = each %$pref ) {
250             if ( ref($tab_content) eq 'ARRAY' ) {
251                 $self->add_prefs( $tab, $tab_content );
252                 next;
253             }
254             while ( my ($section, $sysprefs) = each %$tab_content ) {
255                 my $comment = "$tab > $section";
256                 $self->po_append( $self->{file} . " " . $section, $comment );
257                 $self->add_prefs( $comment, $sysprefs );
258             }
259         }
260     }
261 }
262
263
264 sub save_po {
265     my $self = shift;
266
267     # Create file header if it doesn't already exist
268     my $po = $self->{po};
269     $po->{''} ||= $default_pref_po_header;
270
271     # Write .po entries into a file put in Koha standard po directory
272     Locale::PO->save_file_fromhash( $self->po_filename, $po );
273     say "Saved in file: ", $self->po_filename if $self->{verbose};
274 }
275
276
277 sub get_po_merged_with_en {
278     my $self = shift;
279
280     # Get po from current 'en' .pref files
281     $self->get_po_from_prefs();
282     my $po_current = $self->{po};
283
284     # Get po from previous generation
285     my $po_previous = Locale::PO->load_file_ashash( $self->po_filename );
286
287     for my $id ( keys %$po_current ) {
288         my $po =  $po_previous->{Locale::PO->quote($id)};
289         next unless $po;
290         my $text = Locale::PO->dequote( $po->msgstr );
291         $po_current->{$id}->msgstr( $text );
292     }
293 }
294
295
296 sub update_prefs {
297     my $self = shift;
298     print "Update '", $self->{lang},
299           "' preferences .po file from 'en' .pref files\n" if $self->{verbose};
300     $self->get_po_merged_with_en();
301     $self->save_po();
302 }
303
304
305 sub install_prefs {
306     my $self = shift;
307
308     unless ( -r $self->{po_path_lang} ) {
309         print "Koha directories hierarchy for ", $self->{lang}, " must be created first\n";
310         exit;
311     }
312
313     # Get the language .po file merged with last modified 'en' preferences
314     $self->get_po_merged_with_en();
315
316     for my $file ( @{$self->{pref_files}} ) {
317         my $pref = LoadFile( $self->{path_pref_en} . "/$file" );
318         $self->{file} = $file;
319         # First, keys are replaced (tab titles)
320         $pref = do {
321             my %pref = map { 
322                 $self->get_trans_text( $self->{file} ) || $_ => $pref->{$_}
323             } keys %$pref;
324             \%pref;
325         };
326         while ( my ($tab, $tab_content) = each %$pref ) {
327             if ( ref($tab_content) eq 'ARRAY' ) {
328                 $self->update_tab_prefs( $pref, $tab_content );
329                 next;
330             }
331             while ( my ($section, $sysprefs) = each %$tab_content ) {
332                 $self->update_tab_prefs( $pref, $sysprefs );
333             }
334             my $ntab = {};
335             for my $section ( keys %$tab_content ) {
336                 my $id = $self->{file} . " $section";
337                 my $text = $self->get_trans_text($id);
338                 my $nsection = $text ? $text : $section;
339                 $ntab->{$nsection} = $tab_content->{$section};
340             }
341             $pref->{$tab} = $ntab;
342         }
343         my $file_trans = $self->{po_path_lang} . "/$file";
344         print "Write $file\n" if $self->{verbose};
345         open my $fh, ">", $file_trans;
346         print $fh Dump($pref);
347     }
348 }
349
350
351 sub install_tmpl {
352     my ($self, $files) = @_;
353     say "Install templates" if $self->{verbose};
354     for my $trans ( @{$self->{interface}} ) {
355         my @t_dirs = split(" ", $trans->{dir});
356         for my $t_dir ( @t_dirs ) {
357             my @files   = @$files;
358             my @nomarc = ();
359             print
360                 "  Install templates '$trans->{name}'\n",
361                 "    From: $t_dir/en/\n",
362                 "    To  : $t_dir/$self->{lang}\n",
363                 "    With: $self->{path_po}/$self->{lang}$trans->{suffix}\n"
364                 if $self->{verbose};
365
366             my $trans_dir = ( $trans->{name} =~ /help/ )?"$t_dir":"$t_dir/en/";
367             my $lang_dir  = ( $trans->{name} =~ /help/ )?"$t_dir":"$t_dir/$self->{lang}";
368             $lang_dir =~ s|/en/|/$self->{lang}/|;
369             mkdir $lang_dir unless -d $lang_dir;
370             my $excludes = ( $trans->{name} !~ /help/   )?"":"-x 'help'";
371             # if installing MARC po file, only touch corresponding files
372             my $marc     = ( $trans->{name} =~ /MARC/ )?"-m \"$trans->{name}\"":"";            # for MARC translations
373             # if not installing MARC po file, ignore all MARC files
374             @nomarc      = ( 'marc21', 'unimarc', 'normarc' ) if ( $trans->{name} !~ /MARC/ ); # hardcoded MARC variants
375
376             system
377                 "$self->{process} install " .
378                 "-i $trans_dir " .
379                 "-o $lang_dir  ".
380                 "-s $self->{path_po}/$self->{lang}$trans->{suffix} -r " .
381                 "$excludes " .
382                 "$marc " .
383                 ( @files   ? ' -f ' . join ' -f ', @files : '') .
384                 ( @nomarc  ? ' -n ' . join ' -n ', @nomarc : '');
385         }
386     }
387 }
388
389
390 sub update_tmpl {
391     my ($self, $files) = @_;
392
393     say "Update templates" if $self->{verbose};
394     for my $trans ( @{$self->{interface}} ) {
395         my @files   = @$files;
396         my @nomarc = ();
397         print
398             "  Update templates '$trans->{name}'\n",
399             "    From: $trans->{dir}/en/\n",
400             "    To  : $self->{path_po}/$self->{lang}$trans->{suffix}\n"
401                 if $self->{verbose};
402
403         my $trans_dir = ( $trans->{name} =~ /help/ )?"$trans->{dir}":join("/en/ -i ",split(" ",$trans->{dir}))."/en/"; # multiple source dirs
404         # do no process 'help' dirs unless needed
405         my $excludes  = ( $trans->{name} !~ /help/ )?"-x help":"";
406         # if processing MARC po file, only use corresponding files
407         my $marc      = ( $trans->{name} =~ /MARC/ )?"-m \"$trans->{name}\"":"";            # for MARC translations
408         # if not processing MARC po file, ignore all MARC files
409         @nomarc       = ( 'marc21', 'unimarc', 'normarc' ) if ( $trans->{name} !~ /MARC/ );      # hardcoded MARC variants
410
411         system
412             "$self->{process} update " .
413             "-i $trans_dir " .
414             "-s $self->{path_po}/$self->{lang}$trans->{suffix} -r " .
415             "$excludes " .
416             "$marc "     .
417             ( @files   ? ' -f ' . join ' -f ', @files : '') .
418             ( @nomarc  ? ' -n ' . join ' -n ', @nomarc : '');
419     }
420 }
421
422
423 sub create_prefs {
424     my $self = shift;
425
426     if ( -e $self->po_filename ) {
427         say "Preferences .po file already exists. Delete it if you want to recreate it.";
428         return;
429     }
430     $self->get_po_from_prefs();
431     $self->save_po();
432 }
433
434
435 sub create_tmpl {
436     my ($self, $files) = @_;
437
438     say "Create templates\n" if $self->{verbose};
439     for my $trans ( @{$self->{interface}} ) {
440         my @files   = @$files;
441         my @nomarc = ();
442         print
443             "  Create templates .po files for '$trans->{name}'\n",
444             "    From: $trans->{dir}/en/\n",
445             "    To  : $self->{path_po}/$self->{lang}$trans->{suffix}\n"
446                 if $self->{verbose};
447
448         my $trans_dir = ( $trans->{name} =~ /help/ )?"$trans->{dir}":join("/en/ -i ",split(" ",$trans->{dir}))."/en/"; # multiple source dirs
449         my $excludes  = ( $trans->{name} !~ /help/ )?"-x help":"";
450         # if processing MARC po file, only use corresponding files
451         my $marc      = ( $trans->{name} =~ /MARC/ )?"-m \"$trans->{name}\"":"";            # for MARC translations
452         # if not processing MARC po file, ignore all MARC files
453         @nomarc       = ( 'marc21', 'unimarc', 'normarc' ) if ( $trans->{name} !~ /MARC/ ); # hardcoded MARC variants
454
455         system
456             "$self->{process} create " .
457             "-i $trans_dir " .
458             "-s $self->{path_po}/$self->{lang}$trans->{suffix} -r " .
459             "$excludes " .
460             "$marc " .
461             ( @files  ? ' -f ' . join ' -f ', @files   : '') .
462             ( @nomarc ? ' -n ' . join ' -n ', @nomarc : '');
463     }
464 }
465
466 sub create_messages {
467     my $self = shift;
468
469     print "Create messages ($self->{lang})\n" if $self->{verbose};
470     system
471         "$self->{cp} $self->{domain}.pot " .
472         "$self->{path_po}/$self->{lang}-$self->{domain}.po";
473 }
474
475 sub update_messages {
476     my $self = shift;
477
478     my $pofile = "$self->{path_po}/$self->{lang}-$self->{domain}.po";
479     print "Update messages ($self->{lang})\n" if $self->{verbose};
480     if ( not -f $pofile ) {
481         print "File $pofile does not exist\n" if $self->{verbose};
482         $self->create_messages();
483     }
484     system "$self->{msgmerge} -U $pofile $self->{domain}.pot";
485 }
486
487 sub extract_messages {
488     my $self = shift;
489
490     my $intranetdir = $self->{context}->config('intranetdir');
491     my @files_to_scan;
492     my @directories_to_scan = ('.');
493     my @blacklist = qw(blib koha-tmpl skel tmp t);
494     while (@directories_to_scan) {
495         my $dir = shift @directories_to_scan;
496         opendir DIR, "$intranetdir/$dir" or die "Unable to open $dir: $!";
497         foreach my $entry (readdir DIR) {
498             next if $entry =~ /^\./;
499             my $relentry = "$dir/$entry";
500             $relentry =~ s|^\./||;
501             if (-d "$intranetdir/$relentry" and not grep /^$relentry$/, @blacklist) {
502                 push @directories_to_scan, "$relentry";
503             } elsif (-f "$intranetdir/$relentry" and $relentry =~ /(pl|pm)$/) {
504                 push @files_to_scan, "$relentry";
505             }
506         }
507     }
508
509     my $xgettext_cmd = "$self->{xgettext} -L Perl --from-code=UTF-8 " .
510         "-o $Bin/$self->{domain}.pot -D $intranetdir";
511     $xgettext_cmd .= " $_" foreach (@files_to_scan);
512
513     if (system($xgettext_cmd) != 0) {
514         die "system call failed: $xgettext_cmd";
515     }
516
517     if ( -f "$Bin/$self->{domain}.pot" ) {
518         my $replace_charset_cmd = "$self->{sed} --in-place " .
519             "$Bin/$self->{domain}.pot " .
520             "--expression='s/charset=CHARSET/charset=UTF-8/'";
521         if (system($replace_charset_cmd) != 0) {
522             die "system call failed: $replace_charset_cmd";
523         }
524     } else {
525         print "No messages found\n" if $self->{verbose};
526         return;
527     }
528     return 1;
529 }
530
531 sub remove_pot {
532     my $self = shift;
533
534     unlink "$Bin/$self->{domain}.pot";
535 }
536
537 sub install {
538     my ($self, $files) = @_;
539     return unless $self->{lang};
540     $self->install_tmpl($files) unless $self->{pref_only};
541     $self->install_prefs();
542 }
543
544
545 sub get_all_langs {
546     my $self = shift;
547     opendir( my $dh, $self->{path_po} );
548     my @files = grep { $_ =~ /-pref.po$/ }
549         readdir $dh;
550     @files = map { $_ =~ s/-pref.po$//; $_ } @files;
551 }
552
553
554 sub update {
555     my ($self, $files) = @_;
556     my @langs = $self->{lang} ? ($self->{lang}) : $self->get_all_langs();
557     my $extract_ok = $self->extract_messages();
558     for my $lang ( @langs ) {
559         $self->set_lang( $lang );
560         $self->update_tmpl($files) unless $self->{pref_only};
561         $self->update_prefs();
562         $self->update_messages() if $extract_ok;
563     }
564     $self->remove_pot() if $extract_ok;
565 }
566
567
568 sub create {
569     my ($self, $files) = @_;
570     return unless $self->{lang};
571     $self->create_tmpl($files) unless $self->{pref_only};
572     $self->create_prefs();
573     if ($self->extract_messages()) {
574         $self->create_messages();
575         $self->remove_pot();
576     }
577 }
578
579
580
581 1;
582
583
584 =head1 NAME
585
586 LangInstaller.pm - Handle templates and preferences translation
587
588 =head1 SYNOPSYS
589
590   my $installer = LangInstaller->new( 'fr-FR' );
591   $installer->create();
592   $installer->update();
593   $installer->install();
594   for my $lang ( @{$installer->{langs} ) {
595     $installer->set_lang( $lan );
596     $installer->install();
597   }
598
599 =head1 METHODS
600
601 =head2 new
602
603 Create a new instance of the installer object. 
604
605 =head2 create
606
607 For the current language, create .po files for templates and preferences based
608 of the english ('en') version.
609
610 =head2 update
611
612 For the current language, update .po files.
613
614 =head2 install
615
616 For the current langage C<$self->{lang}, use .po files to translate the english
617 version of templates and preferences files and copy those files in the
618 appropriate directory.
619
620 =over
621
622 =item translate create F<lang>
623
624 Create 4 kinds of .po files in F<po> subdirectory:
625 (1) one from each theme on opac pages templates,
626 (2) intranet templates and help,
627 (3) preferences, and
628 (4) one for each MARC dialect.
629
630
631 =over
632
633 =item F<lang>-opac-{theme}.po
634
635 Contains extracted text from english (en) OPAC templates found in
636 <KOHA_ROOT>/koha-tmpl/opac-tmpl/{theme}/en/ directory.
637
638 =item F<lang>-staff-prog.po and F<lang>-staff-help.po
639
640 Contains extracted text from english (en) intranet templates found in
641 <KOHA_ROOT>/koha-tmpl/intranet-tmpl/prog/en/ directory.
642
643 =item F<lang>-pref.po
644
645 Contains extracted text from english (en) preferences. They are found in files
646 located in <KOHA_ROOT>/koha-tmpl/intranet-tmpl/prog/en/admin/preferences
647 directory.
648
649 =item F<lang>-marc-{MARC}.po
650
651 Contains extracted text from english (en) files from opac and intranet,
652 related with MARC dialects.
653
654 =back
655
656 =item pref-trans update F<lang>
657
658 Update .po files in F<po> directory, named F<lang>-*.po.
659
660 =item pref-trans install F<lang>
661
662 =back
663
664 =cut
665