3 # Copyright 2015 Koha Development team
5 # This file is part of Koha.
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.
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.
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>.
27 use Koha::StockRotationStages;
28 use Koha::SMTP::Servers;
30 use base qw(Koha::Object);
32 my $cache = Koha::Caches->get_instance();
36 Koha::Library - Koha Library Object class
44 Library specific store to ensure relevant caches are flushed on change
53 if ( !$self->in_storage ) {
57 my $self_from_storage = $self->get_from_storage;
58 $flush = 1 if ( $self_from_storage->branchname ne $self->branchname );
61 $self = $self->SUPER::store;
64 $cache->clear_from_cache('libraries:name');
72 Library specific C<delete> to clear relevant caches on delete.
78 $cache->clear_from_cache('libraries:name');
79 $self->SUPER::delete(@_);
82 =head3 stockrotationstages
84 my $stages = Koha::Library->stockrotationstages;
86 Returns the stockrotation stages associated with this Library.
90 sub stockrotationstages {
92 my $rs = $self->_result->stockrotationstages;
93 return Koha::StockRotationStages->_new_from_dbic( $rs );
96 =head3 outgoing_transfers
98 my $outgoing_transfers = Koha::Library->outgoing_transfers;
100 Returns the outgoing item transfers associated with this Library.
104 sub outgoing_transfers {
106 my $rs = $self->_result->branchtransfers_frombranches;
107 return Koha::Item::Transfers->_new_from_dbic( $rs );
110 =head3 inbound_transfers
112 my $inbound_transfers = Koha::Library->inbound_transfers;
114 Returns the inbound item transfers associated with this Library.
118 sub inbound_transfers {
120 my $rs = $self->_result->branchtransfers_tobranches;
121 return Koha::Item::Transfers->_new_from_dbic( $rs );
124 =head3 get_effective_marcorgcode
126 my $marcorgcode = Koha::Libraries->find( $library_id )->get_effective_marcorgcode();
128 Returns the effective MARC organization code of the library. It falls back to the value
129 from the I<MARCOrgCode> syspref if undefined for the library.
133 sub get_effective_marcorgcode {
136 return $self->marcorgcode || C4::Context->preference("MARCOrgCode");
141 my $smtp_server = $library->smtp_server;
142 $library->smtp_server({ smtp_server => $smtp_server });
143 $library->smtp_server({ smtp_server => undef });
145 Accessor for getting and setting the library's SMTP server.
147 Returns the effective SMTP server configuration to be used on the library. The returned
148 value is always a I<Koha::SMTP::Server> object.
150 Setting it to undef will remove the link to a specific SMTP server and effectively
151 make the library use the default setting
156 my ( $self, $params ) = @_;
158 my $library_smtp_server_rs = $self->_result->library_smtp_server;
160 if ( exists $params->{smtp_server} ) {
162 $self->_result->result_source->schema->txn_do( sub {
163 $library_smtp_server_rs->delete
164 if $library_smtp_server_rs;
166 if ( defined $params->{smtp_server} ) {
168 # Remove any already set SMTP server
170 my $smtp_server = $params->{smtp_server};
171 $smtp_server->_result->add_to_library_smtp_servers({ library_id => $self->id });
174 } # else => reset to default
177 if ( $library_smtp_server_rs ) {
178 return Koha::SMTP::Servers->find(
179 $library_smtp_server_rs->smtp_server_id );
182 return Koha::SMTP::Servers->get_default;
188 =head3 from_email_address
190 my $from_email = Koha::Library->from_email_address;
192 Returns the official 'from' email address for the branch.
194 It may well be a 'noreply' or other inaccessible local domain
195 address that is being used to satisfy spam protection filters.
199 sub from_email_address {
204 || C4::Context->preference('KohaAdminEmailAddress')
208 =head3 inbound_email_address
210 my $to_email = Koha::Library->inbound_email_address;
212 Returns an effective email address which should be accessible to librarians at the branch.
214 NOTE: This is the address to use for 'reply_to' or 'to' fields; It should not usually be
215 used as the 'from' address for emails as it may lead to mail being caught by spam filters.
219 sub inbound_email_address {
224 || $self->branchemail
225 || C4::Context->preference('ReplytoDefault')
226 || C4::Context->preference('KohaAdminEmailAddress')
230 =head3 inbound_ill_address
232 my $to_email = Koha::Library->inbound_ill_address;
234 Returns an effective email address which should be accessible to librarians at the branch
235 for inter library loans communication.
239 sub inbound_ill_address {
243 $self->branchillemail
244 || C4::Context->preference('ILLDefaultStaffEmail')
245 || $self->inbound_email_address;
248 =head3 library_groups
250 Return the Library groups of this library
256 my $rs = $self->_result->library_groups;
257 return Koha::Library::Groups->_new_from_dbic( $rs );
260 =head3 cash_registers
262 Return Cash::Registers associated with this Library
268 my $rs = $self->_result->cash_registers;
269 return Koha::Cash::Registers->_new_from_dbic( $rs );
272 =head3 get_hold_libraries
274 Return all libraries (including self) that belong to the same hold groups
278 sub get_hold_libraries {
280 my $library_groups = $self->library_groups;
282 while ( my $library_group = $library_groups->next ) {
283 my $root = Koha::Library::Groups->get_root_ancestor({id => $library_group->id});
284 if($root->ft_local_hold_group) {
285 push @hold_libraries, $root->all_libraries;
291 grep { !$seen{ $_->id }++ } @hold_libraries;
293 return Koha::Libraries->search({ branchcode => { '-in' => [ keys %seen ] } });
296 =head3 validate_hold_sibling
298 Return if given library is a valid hold group member
302 sub validate_hold_sibling {
303 my ( $self, $params ) = @_;
305 return 1 if $params->{branchcode} eq $self->id;
307 my $branchcode = $params->{branchcode};
308 return $self->get_hold_libraries->search( { branchcode => $branchcode } )
312 =head3 public_read_list
314 This method returns the list of publicly readable database fields for both API and UI output purposes
318 sub public_read_list {
320 'branchcode', 'branchname', 'branchaddress1',
321 'branchaddress2', 'branchaddress3', 'branchzip',
322 'branchcity', 'branchstate', 'branchcountry',
323 'branchfax', 'branchemail', 'branchurl'
327 =head3 to_api_mapping
329 This method returns the mapping for representing a Koha::Library object
336 branchcode => 'library_id',
337 branchname => 'name',
338 branchaddress1 => 'address1',
339 branchaddress2 => 'address2',
340 branchaddress3 => 'address3',
341 branchzip => 'postal_code',
342 branchcity => 'city',
343 branchstate => 'state',
344 branchcountry => 'country',
345 branchphone => 'phone',
347 branchemail => 'email',
348 branchillemail => 'illemail',
349 branchreplyto => 'reply_to_email',
350 branchreturnpath => 'return_path_email',
354 branchnotes => 'notes',
355 marcorgcode => 'marc_org_code',
361 $library->opac_info({ lang => $lang });
363 Returns additional contents block OpacLibraryInfo for $lang or 'default'.
365 Note: This replaces the former branches.opac_info column.
370 my ( $self, $params ) = @_;
371 return Koha::AdditionalContents->find_best_match({
372 category => 'html_customizations',
373 location => 'OpacLibraryInfo',
374 lang => $params->{lang},
375 library_id => $self->branchcode,
379 =head2 Internal methods