3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20 use Scalar
::Util
qw(looks_like_number);
21 use List
::Util
qw( first );
26 use Koha
::SearchEngine
::Elasticsearch
;
27 use Koha
::SearchEngine
::Elasticsearch
::Indexer
;
28 use Koha
::SearchMarcMaps
;
29 use Koha
::SearchFields
;
35 my ( $template, $borrowernumber, $cookie ) = get_template_and_user
(
36 { template_name
=> 'admin/searchengine/elasticsearch/mappings.tt',
40 flagsrequired
=> { parameters
=> 'manage_search_engine_config' },
44 my $index = $input->param('index') || 'biblios';
45 my $op = $input->param('op') || 'list';
48 my $database = Koha
::Database
->new();
49 my $schema = $database->schema;
51 my $marc_type = lc C4
::Context
->preference('marcflavour');
53 my @index_names = ($Koha::SearchEngine
::Elasticsearch
::BIBLIOS_INDEX
, $Koha::SearchEngine
::Elasticsearch
::AUTHORITIES_INDEX
);
55 my $update_mappings = sub {
56 for my $index_name (@index_names) {
57 my $indexer = Koha
::SearchEngine
::Elasticsearch
::Indexer
->new({ index => $index_name });
59 $indexer->update_mappings();
61 my $conf = $indexer->get_elasticsearch_params();
64 code
=> 'error_on_update_es_mappings',
66 index => $conf->{index_name
},
72 my $cache = Koha
::Caches
->get_instance();
73 my $clear_cache = sub {
74 $cache->clear_from_cache('elasticsearch_search_fields_staff_client');
75 $cache->clear_from_cache('elasticsearch_search_fields_opac');
78 if ( $op eq 'edit' ) {
80 $schema->storage->txn_begin;
82 my @field_name = $input->multi_param('search_field_name');
83 my @field_label = $input->multi_param('search_field_label');
84 my @field_type = $input->multi_param('search_field_type');
85 my @field_weight = $input->multi_param('search_field_weight');
86 my @field_staff_client = $input->multi_param('search_field_staff_client');
87 my @field_opac = $input->multi_param('search_field_opac');
89 my @index_name = $input->multi_param('mapping_index_name');
90 my @search_field_name = $input->multi_param('mapping_search_field_name');
91 my @mapping_sort = $input->multi_param('mapping_sort');
92 my @mapping_facet = $input->multi_param('mapping_facet');
93 my @mapping_suggestible = $input->multi_param('mapping_suggestible');
94 my @mapping_search = $input->multi_param('mapping_search');
95 my @mapping_marc_field = $input->multi_param('mapping_marc_field');
96 my @faceted_field_names = $input->multi_param('display_facet');
100 for my $i ( 0 .. scalar(@field_name) - 1 ) {
101 my $field_name = $field_name[$i];
102 my $field_label = $field_label[$i];
103 my $field_type = $field_type[$i];
104 my $field_weight = $field_weight[$i];
105 my $field_staff_client = $field_staff_client[$i];
106 my $field_opac = $field_opac[$i];
108 my $search_field = Koha
::SearchFields
->find( { name
=> $field_name }, { key
=> 'name' } );
109 $search_field->label($field_label);
110 $search_field->type($field_type);
112 if (!length($field_weight)) {
113 $search_field->weight(undef);
115 elsif ($field_weight <= 0 || !looks_like_number
($field_weight)) {
116 push @messages, { type
=> 'error', code
=> 'invalid_field_weight', 'weight' => $field_weight };
119 $search_field->weight($field_weight);
121 $search_field->staff_client($field_staff_client ?
1 : 0);
122 $search_field->opac($field_opac ?
1 : 0);
124 my $facet_order = first
{ $faceted_field_names[$_] eq $field_name } 0 .. $#faceted_field_names;
125 $search_field->facet_order(defined $facet_order ?
$facet_order + 1 : undef);
126 $search_field->store;
129 Koha
::SearchMarcMaps
->search( { marc_type
=> $marc_type, } )->delete;
130 my @facetable_fields = Koha
::SearchEngine
::Elasticsearch
->get_facetable_fields();
131 my @facetable_field_names = map { $_->name } @facetable_fields;
133 for my $i ( 0 .. scalar(@index_name) - 1 ) {
134 my $index_name = $index_name[$i];
135 my $search_field_name = $search_field_name[$i];
136 my $mapping_marc_field = $mapping_marc_field[$i];
137 my $mapping_facet = $mapping_facet[$i];
138 $mapping_facet = ( grep {/^$search_field_name$/} @facetable_field_names ) ?
$mapping_facet : 0;
139 my $mapping_suggestible = $mapping_suggestible[$i];
140 my $mapping_sort = $mapping_sort[$i] eq 'undef' ?
undef : $mapping_sort[$i];
141 my $mapping_search = $mapping_search[$i];
143 my $search_field = Koha
::SearchFields
->find({ name
=> $search_field_name }, { key
=> 'name' });
144 # TODO Check mapping format
145 my $marc_field = Koha
::SearchMarcMaps
->find_or_create({
146 index_name
=> $index_name,
147 marc_type
=> $marc_type,
148 marc_field
=> $mapping_marc_field
150 $search_field->add_to_search_marc_maps($marc_field, {
151 facet
=> $mapping_facet,
152 suggestible
=> $mapping_suggestible,
153 sort => $mapping_sort,
154 search
=> $mapping_search
159 push @messages, { type
=> 'error', code
=> 'error_on_update', message
=> $@
, };
160 $schema->storage->txn_rollback;
162 push @messages, { type
=> 'message', code
=> 'success_on_update' };
163 $schema->storage->txn_commit;
165 $update_mappings->();
168 elsif( $op eq 'reset_confirmed' ) {
169 Koha
::SearchMarcMaps
->delete;
170 Koha
::SearchFields
->delete;
171 Koha
::SearchEngine
::Elasticsearch
->reset_elasticsearch_mappings;
173 push @messages, { type
=> 'message', code
=> 'success_on_reset' };
175 elsif( $op eq 'reset_confirm' ) {
176 $template->param( reset_confirm
=> 1 );
181 for my $index_name (@index_names) {
182 my $indexer = Koha
::SearchEngine
::Elasticsearch
::Indexer
->new({ index => $index_name });
183 if (!$indexer->is_index_status_ok) {
184 my $conf = $indexer->get_elasticsearch_params();
185 if ($indexer->is_index_status_reindex_required) {
188 code
=> 'reindex_required',
189 index => $conf->{index_name
},
192 elsif($indexer->is_index_status_recreate_required) {
195 code
=> 'recreate_required',
196 index => $conf->{index_name
},
202 my @facetable_fields = Koha
::SearchEngine
::Elasticsearch
->get_facetable_fields();
203 for my $index_name (@index_names) {
204 my $search_fields = Koha
::SearchFields
->search(
206 'search_marc_map.index_name' => $index_name,
207 'search_marc_map.marc_type' => $marc_type,
210 join => { search_marc_to_fields
=> 'search_marc_map' },
212 'search_marc_to_fields.facet',
213 'search_marc_to_fields.suggestible',
214 'search_marc_to_fields.sort',
215 'search_marc_to_fields.search',
216 'search_marc_map.marc_field'
225 order_by
=> { -asc
=> [qw
/name marc_field/] }
230 my @facetable_field_names = map { $_->name } @facetable_fields;
232 while ( my $s = $search_fields->next ) {
235 search_field_name
=> $name,
236 search_field_label
=> $s->label,
237 search_field_type
=> $s->type,
238 marc_field
=> $s->get_column('marc_field'),
239 sort => $s->get_column('sort') // 'undef', # To avoid warnings "Use of uninitialized value in lc"
240 suggestible
=> $s->get_column('suggestible'),
241 search
=> $s->get_column('search'),
242 facet
=> $s->get_column('facet'),
243 is_facetable
=> ( grep {/^$name$/} @facetable_field_names ) ?
1 : 0,
247 push @indexes, { index_name
=> $index_name, mappings
=> \
@mappings };
250 my $search_fields = Koha
::SearchFields
->search( {}, { order_by
=> ['name'] } );
251 my @all_search_fields;
252 while ( my $search_field = $search_fields->next ) {
253 my $search_field_unblessed = $search_field->unblessed;
254 $search_field_unblessed->{mapped_biblios
} = 1 if $search_field->is_mapped_biblios;
255 push @all_search_fields, $search_field_unblessed;
259 indexes
=> \
@indexes,
260 all_search_fields
=> \
@all_search_fields,
261 facetable_fields
=> \
@facetable_fields,
262 messages
=> \
@messages,
265 output_html_with_http_headers
$input, $cookie, $template->output;