Bug 23846: Add a check to the data inconsistencies script
[koha.git] / patroncards / edit-layout.pl
1 #!/usr/bin/perl
2 #
3 # Copyright 2006 Katipo Communications.
4 # Parts Copyright 2009 Foundations Bible College.
5 #
6 # This file is part of Koha.
7 #
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
12 #
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20
21 use Modern::Perl;
22
23 use CGI qw ( -utf8 );
24 use Text::CSV_XS;
25 use XML::Simple;
26 use autouse 'Data::Dumper' => qw(Dumper);
27
28 use C4::Auth qw(get_template_and_user);
29 use C4::Output qw(output_html_with_http_headers);
30 use C4::Creators;
31 use C4::Patroncards;
32
33 my $cgi = new CGI;
34 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
35     {
36         template_name   => "patroncards/edit-layout.tt",
37         query           => $cgi,
38         type            => "intranet",
39         authnotrequired => 0,
40         flagsrequired   => { catalogue => 1 },
41         debug           => 1,
42     }
43 );
44
45 my $op = $cgi->param('op') || 'new'; # make 'new' the default operation if none is submitted
46 my $layout_id = $cgi->param('layout_id') || $cgi->param('element_id') || '';
47 my $layout_choice = $cgi->param('layout_choice') || '';
48 my $layout = '';
49 my $layout_xml = undef;
50
51 my $units = get_unit_values();
52 my $font_types = get_font_types();
53 my $alignment_types = get_text_justification_types();
54 my $barcode_types = get_barcode_types();
55 my $image_sources = [
56     {type => 'none', name => 'None', selected => 1},
57     {type => 'patronimages', name => 'Patron Image', selected => 0},
58     {type => 'creator_images', name => 'Other Image', selected => 0},
59 ];
60 my $image_names = get_all_image_names();
61 unshift @$image_names, {type => 'none', name => 'Select Image', selected => 1};
62
63 sub _set_selected {
64     my ($selection, $source_list) = @_;
65     my @select_list = ();       # we must make a copy of the referent otherwise we modify the original which causes bad things to happen
66     my $selected = 0;
67     SET_SELECTED:
68     foreach my $type (@$source_list) {
69         if (($selection) && ($type->{'type'} eq $selection)) {  # even if there is no current selection we must still build the select box
70             $selected = 1;
71         }
72         else {
73             $selected = 0;
74         }
75         push @select_list, {type => $type->{'type'}, name => $type->{'name'}, selected => $selected};
76     };
77     return \@select_list;
78 }
79
80 if ($op eq 'edit') {
81     warn sprintf("Error performing '%s': No 'layout_id' passed in.", $op) unless ($layout_id);
82     $layout = C4::Patroncards::Layout->retrieve(layout_id => $layout_id);
83     $layout_xml = XMLin($layout->get_attr('layout_xml'), ForceArray => 1);
84 #       Handle text fields...
85     my $field_number = 0;
86     my @text_fields = ();
87     if ($layout_xml->{'text'}) {
88         while (scalar @{$layout_xml->{'text'}}) {
89             $field_number++;
90             push @text_fields, (
91                                 "field_" . $field_number => 1,      # indicate field as currently "selected" for display in form
92                                 "field_" . $field_number . "_text" => shift @{$layout_xml->{'text'}},
93                                 );
94             my $field_params = shift @{$layout_xml->{'text'}};
95             push @text_fields, (
96                                 "field_" . $field_number . "_llx" => $field_params->{'llx'},
97                                 "field_" . $field_number . "_lly" => $field_params->{'lly'},
98                                 "field_" . $field_number . "_height_scale" => $field_params->{'height_scale'},
99                                 "field_" . $field_number . "_width_scale" => $field_params->{'width_scale'},
100                                 "field_" . $field_number . "_font" => _set_selected($field_params->{'font'}, $font_types),
101                                 "field_" . $field_number . "_font_size" => $field_params->{'font_size'},
102                                 "field_" . $field_number . "_text_alignment" => _set_selected($field_params->{'text_alignment'}, $alignment_types),
103                                 );
104         }
105     }
106
107 #   Handle fields not currently used
108     UNUSED_TEXT_FIELDS:
109     for (my $field = $field_number + 1; $field < 4; $field++) {     # limit 3 text fields
110         push @text_fields, (
111                         "field_$field" . "_font" => get_font_types(),
112                         "field_$field" . "_text_alignment" => get_text_justification_types(),
113                         );
114     }
115
116 #   Handle images...
117     my $image_count = 0;
118     my @images = ();
119     foreach my $image (keys %{$layout_xml->{'images'}}) {
120         $image_count++;
121         push @images, ( $image . "_image" => "$image",
122                         $image . "_Dx" => $layout_xml->{'images'}->{$image}->{'Dx'},
123                         $image . "_Tx" => $layout_xml->{'images'}->{$image}->{'Tx'},
124                         $image . "_Ty" => $layout_xml->{'images'}->{$image}->{'Ty'},
125                         $image . "_image_source" => _set_selected($layout_xml->{'images'}->{$image}->{'data_source'}->[0]->{'image_source'}, $image_sources),
126                         $image . "_image_name" => _set_selected($layout_xml->{'images'}->{$image}->{'data_source'}->[0]->{'image_name'}, $image_names),
127                         );
128     }
129
130 #   Handle image fields not currently used
131     UNUSED_IMAGE_FIELDS:
132     for (my $image = $image_count + 1; $image < 3; $image++) {     #limit 2 images
133         push @images, (
134                         "image_$image" . "_image_source" => $image_sources,
135                         "image_$image" . "_image_name" => $image_names,
136                         );
137     }
138
139 #   Handle barcodes...
140     my @barcode = ();
141     foreach my $barcode_param (keys %{$layout_xml->{'barcode'}->[0]}) {
142         push @barcode, (($barcode_param eq 'type' ? ("barcode_" . $barcode_param => _set_selected($layout_xml->{'barcode'}->[0]->{'type'}, $barcode_types)) : ("barcode_" . $barcode_param => $layout_xml->{'barcode'}->[0]->{$barcode_param})));
143     }
144
145     foreach my $unit (@$units){
146         if ($unit->{'type'} eq $layout->get_attr('units')) {
147             $unit->{'selected'} = 1;
148         } else {
149             $unit->{'selected'} = 0;
150         }
151     }
152
153     $template->param(
154             layout_id       => $layout->get_attr('layout_id') > -1 ? $layout->get_attr('layout_id') : '',
155             layout_name     => $layout->get_attr('layout_name'),
156             page_side       => ($layout_xml->{'page_side'} eq 'F' ? 0 : 1),
157             guide_box       => $layout_xml->{'guide_box'},
158             guide_grid      => $layout_xml->{'guide_grid'},
159             units           => $units,
160             @barcode,
161             barcode_type    => _set_selected($layout_xml->{'barcode'}->[0]->{'type'}, $barcode_types),
162             @text_fields,
163             @images,
164             guidebox        => 0,
165     );
166     output_html_with_http_headers $cgi, $cookie, $template->output;
167     exit;
168 }
169 elsif  ($op eq 'save') {
170     my $format_string = undef;
171     my $layout = {};
172     my $layout_name = undef;
173     my $layout_id = undef;
174     my $text_lines = [];
175     my $array_index = 0;
176     my $image_select = 0;
177     my $field_enabled = 0;
178     CGI_PARAMS:
179     foreach my $parameter ($cgi->param()) {     # parse the field values and build a hash of the layout for conversion to xml and storage in the db
180         if ($parameter =~ m/^field_([0-9])_(.*)$/) {
181             my $field_number = $1;
182             my $field_data = $2;
183             $field_enabled = $field_number if $field_data eq 'enable';
184             next CGI_PARAMS unless $field_number == $field_enabled;
185             if ($field_data eq 'text') {
186                 push @$text_lines, $cgi->param($parameter);
187                 if ($array_index <= 0) {
188                     $array_index++;
189                 }
190                 else {
191                     $array_index += 2; # after hitting 1, increment by 2 so counting odds
192                 }
193             }
194             elsif ($array_index > 0) {
195                 $text_lines->[$array_index]->{$field_data} = $cgi->param($parameter);
196             }
197         }
198         elsif ($parameter =~ m/^barcode_(.*)$/) {
199             $field_enabled = $1 if $1 eq 'print';
200             next CGI_PARAMS unless $field_enabled eq 'print';
201             $layout->{'barcode'}->{$1} = $cgi->param($parameter);
202         }
203         elsif ($parameter =~m/^image_([0-9])_(.*)$/) {
204             my $image_number = $1;
205             my $image_data = $2;
206             $field_enabled = $image_number if $cgi->param("image_$image_number" . "_image_source") ne 'none';
207             next CGI_PARAMS unless $image_number == $field_enabled;
208             if ($image_data =~ m/^image_(.*)$/) {
209                 $layout->{'images'}->{"image_$image_number"}->{'data_source'}->{"image_$1"} = $cgi->param($parameter);
210             }
211             else {
212                 $layout->{'images'}->{"image_$image_number"}->{$image_data} = $cgi->param($parameter);
213             }
214         }
215         else {
216             $layout_name = $cgi->param($parameter) if $parameter eq 'layout_name';
217             $layout_id = $cgi->param($parameter) if $parameter eq 'layout_id';
218             $layout->{'units'} = $cgi->param($parameter) if $parameter eq 'units';
219             $layout->{'page_side'} = $cgi->param($parameter) if $parameter eq 'page_side';
220             $layout->{'guide_box'} = $cgi->param($parameter) if $parameter eq 'guide_box';
221             $layout->{'guide_grid'} = $cgi->param($parameter) if $parameter eq 'guide_grid';
222         }
223     }
224     $layout->{'text'} = $text_lines;
225     my @params = (layout_name => $layout_name, layout_id => $layout_id, layout_xml => XMLout($layout));
226     push(@params,units => $layout->{'units'}) if $layout->{'units'};
227     if ($layout_id) {   # if a label_id was passed in, this is an update to an existing layout
228         $layout = C4::Patroncards::Layout->retrieve(layout_id => $layout_id);
229         $layout->set_attr(@params);
230         $layout_id = $layout->save();
231     }
232     else {      # if no label_id, this is a new layout so insert it
233         $layout = C4::Patroncards::Layout->new(@params);
234         $layout_id = $layout->save();
235     }
236     print $cgi->redirect("manage.pl?card_element=layout" . ($layout_id == -1 ? "&element_id=$layout_id&op=$op&error=101" : ''));
237     exit;
238 }
239 elsif  ($op eq 'new') { # this is a new layout
240     $layout = C4::Patroncards::Layout->new();
241     my @fields = ();
242     for (my $field = 0; $field < 4; $field++) {     # limit 3 text fields
243         push @fields, (
244                         "field_$field" . "_font" => get_font_types(),
245                         "field_$field" . "_text_alignment" => get_text_justification_types(),
246                         );
247     }
248
249     my @images = ();
250     for (my $image = 0; $image < 3; $image++) {     #limit 2 images
251         push @images, (
252                         "image_$image" . "_image_source" => $image_sources,
253                         "image_$image" . "_image_name" => $image_names,
254                         );
255     }
256
257     $template->param(
258                     units               => get_unit_values(),
259                     @fields,
260                     barcode_type        => get_barcode_types(),
261                     @images,
262                     );
263
264 output_html_with_http_headers $cgi, $cookie, $template->output;
265 exit;
266 }
267 else { # trap unsupported operation here
268     warn sprintf("Unsupported operation type submitted: %s", $op);
269     print $cgi->redirect("manage.pl?card_element=layout&element_id=$layout_id&error=201");
270     exit;
271 }
272
273 __END__