Koha-community/Koha
13
7
Fork 0
Code Issues Releases Wiki Activity
Koha/admin/systempreferences.pl
Ian Walls 850b4eeab9 Bug 6151: Add AllowReturnToBranch system preference 
In order to solve the issue of IndependantBranches being incompatible with HomeOrHoldingBranchReturn,
this patch changes the mechanism by which the question "can I return this material here?" is answered.  Before,
the conditions were "if IndependantBranches is on, and this branch isn't HomeOrHoldingBranchReturn for the item,
then no, otherwise yes".  Now, the question is answered by consulting CanBookBeReturned (new subroutine)

New system preference:  AllowReturnToBranch
Possible values:
  - anywhere (default for new installs, and for existing systems with IndependantBranches turned off)
  - homebranch
  - holdingbranch (which is also the issuing branch in all normal circumstances)
  - homeorholdingbranch (default for existing systems with IndependantBranches turned on)

New subroutine:  CanBookBeReturned
Input:  $item hash (from GetItems), and $branchcode
Output: 0 or 1 to indicate "allowed" or not, and an optional message if not allowed.  Message is the 'correct' branchcode
to return the material to

To Test:
1.  Install patch and new syspref
2.  Check that default value of the preference:
    - if IndependantBranches was OFF at install time, should be 'anywhere'
    - if IndependantBranches was ON at install time, should be 'homeorholdingbranch'

Case:  'anywhere'
1.  Checkout a Library A book at Library A.  Return at Library A should be successful
2.  Repeat step 1, returning to Library B.  Return should be successful
3.  Checkout a Library A book at Library B.  Return to A should be successful
4.  Repeat step 3 with Library B and Library C

Case: 'homebranch'
1.  Checkout a Library A book at Library A.  Return at Library A should be successful
2.  Repeat step 1, returning to Library B.  Return should FAIL (returning message to return at A)
3.  Checkout a Library A book at Library B.  Return to Library A should be successful
4.  Repeat step 3 with Library B and Library C.  Both should FAIL (returning message to return at A)

Case: 'holdingbranch'
1.  Checkout a Library A book at Library A.  Return at Library A should be successful
2.  Repeat step 1, returning to Library B.  Return should FAIL (returning message to return at A)
3.  Checkout a Library A book at Library B.  Return to A should FAIL (returning message to return at B)
4.  Repeat step 3 with Library B. Return should be successful
5.  Repeat step 3 with Library C. Return should FAIL (returning message to return at B)

Case: 'homeorholdingbranch'
1.  Checkout a Library A book at Library A.  Return at Library A should be successful
2.  Repeat step 1, returning to Library B.  Return should FAIL (returning message to return at A)
3.  Checkout a Library A book at Library B.  Return to A should be successful
4.  Repeat step 3 with Library B. Return should be successful
5.  Repeat step 3 with Library C. Return should FAIL (returning message to return at A)

Signed-off-by: Chris Cormack <chrisc@catalyst.net.nz>
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
2012-09-17 19:17:41 +02:00

870 lines
35 KiB
Perl
Executable file
Raw Blame History

#!/usr/bin/perl
# script to administer the systempref table
# written 20/02/2002 by paul.poulain@free.fr
# This software is placed under the gnu General Public License, v2 (http://www.gnu.org/licenses/gpl.html)
# Copyright 2000-2002 Katipo Communications
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation; either version 2 of the License, or (at your option) any later
# version.
#
# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with Koha; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
=head1 systempreferences.pl
ALSO :
this script use an $op to know what to do.
if $op is empty or none of the above values,
- the default screen is build (with all records, or filtered datas).
- the user can clic on add, modify or delete record.
if $op=add_form
- if primkey exists, this is a modification,so we read the $primkey record
- builds the add/modify form
if $op=add_validate
- the user has just send datas, so we create/modify the record
if $op=delete_form
- we show the record having primkey=$primkey and ask for deletion validation form
if $op=delete_confirm
- we delete the record having primkey=$primkey
=cut
use strict;
use warnings;
use CGI;
use MIME::Base64;
use C4::Auth;
use C4::Context;
use C4::Koha;
use C4::Languages qw(getTranslatedLanguages);
use C4::ClassSource;
use C4::Log;
use C4::Output;
use YAML::Syck qw( Dump LoadFile );
# use Smart::Comments;
# FIXME, shouldnt we store this stuff in the systempreferences table?
# FIXME: This uses hash in a backwards way. What we really want is:
# $tabsysprefs{key} = $array_ref;
# like
# $tabsysprefs{Cataloguing} = [qw(autoBarcode ISBD marc ...)];
#
# Because some things *should* be on more than one tab.
# And the tabname is the unique part (the key).
my %tabsysprefs;
# Acquisitions
$tabsysprefs{gist}="Acquisitions";
$tabsysprefs{emailPurchaseSuggestions}="Acquisitions";
$tabsysprefs{RenewSerialAddsSuggestion}="Acquisitions";
$tabsysprefs{AcqCreateItem}="Acquisitions";
$tabsysprefs{OrderPdfFormat}="Acquisitions";
$tabsysprefs{CurrencyFormat}="Acquisitions";
$tabsysprefs{AcqViewBaskets}="Acquisitions";
# Admin
$tabsysprefs{singleBranchMode} = "Admin";
$tabsysprefs{staffClientBaseURL} = "Admin";
$tabsysprefs{Version} = "Admin";
$tabsysprefs{OpacMaintenance} = "Admin";
$tabsysprefs{FrameworksLoaded} = "Admin";
$tabsysprefs{delimiter} = "Admin";
$tabsysprefs{IndependantBranches} = "Admin";
$tabsysprefs{insecure} = "Admin";
$tabsysprefs{KohaAdmin} = "Admin";
$tabsysprefs{KohaAdminEmailAddress} = "Admin";
$tabsysprefs{timeout} = "Admin";
$tabsysprefs{Intranet_includes} = "Admin";
$tabsysprefs{AutoLocation} = "Admin";
$tabsysprefs{DebugLevel} = "Admin";
$tabsysprefs{SessionStorage} = "Admin";
# This script is deprecated so all of these prefs are lumped here to avoid their being displayed in the local use prefs tab
$tabsysprefs{noItemTypeImages} = "Admin";
$tabsysprefs{OPACBaseURL} = "Admin";
$tabsysprefs{AnonymousPatron} = "Admin";
$tabsysprefs{casAuthentication} = "Admin";
$tabsysprefs{casLogout} = "Admin";
$tabsysprefs{casServerUrl} = "Admin";
$tabsysprefs{Disable_Dictionary} = "Admin";
$tabsysprefs{EnableOpacSearchHistory} = "Admin";
$tabsysprefs{Intranetbookbag} = "Admin";
$tabsysprefs{maxitemsinSearchResults} = "Admin";
$tabsysprefs{noOPACUserLogin} = "Admin";
$tabsysprefs{'OAI-PMH:ConfFile'} = "Admin";
$tabsysprefs{OpacAddMastheadLibraryPulldown} = "Admin";
$tabsysprefs{opaclargeimage} = "Admin";
$tabsysprefs{OPACXSLTDetailsDisplay} = "Admin";
$tabsysprefs{OPACXSLTResultsDisplay} = "Admin";
$tabsysprefs{PDFFontType} = "Admin";
$tabsysprefs{PrintNoticesMaxLines} = "Admin";
$tabsysprefs{ReservesControlBranch} = "Admin";
$tabsysprefs{ResultsDisplay} = "Admin";
$tabsysprefs{NoReturnSetLost} = "Admin";
$tabsysprefs{SearchURL} = "Admin";
$tabsysprefs{ShowPictures} = "Admin";
$tabsysprefs{soundon} = "Admin";
$tabsysprefs{SpineLabelShowPrintOnBibDetails} = "Admin";
$tabsysprefs{WebBasedSelfCheckHeader} = "Admin";
$tabsysprefs{WebBasedSelfCheckTimeout} = "Admin";
# Authorities
$tabsysprefs{authoritysep} = "Authorities";
$tabsysprefs{AuthDisplayHierarchy} = "Authorities";
$tabsysprefs{dontmerge} = "Authorities";
$tabsysprefs{BiblioAddsAuthorities} = "Authorities";
# Cataloguing
$tabsysprefs{advancedMARCeditor} = "Cataloging";
$tabsysprefs{autoBarcode} = "Cataloging";
$tabsysprefs{hide_marc} = "Cataloging";
$tabsysprefs{IntranetBiblioDefaultView} = "Cataloging";
$tabsysprefs{ISBD} = "Cataloging";
$tabsysprefs{itemcallnumber} = "Cataloging";
$tabsysprefs{LabelMARCView} = "Cataloging";
$tabsysprefs{marcflavour} = "Cataloging";
$tabsysprefs{MARCOrgCode} = "Cataloging";
$tabsysprefs{z3950AuthorAuthFields} = "Cataloging";
$tabsysprefs{z3950NormalizeAuthor} = "Cataloging";
$tabsysprefs{Stemming} = "Cataloging";
$tabsysprefs{WeightFields} = "Cataloging";
$tabsysprefs{NoZebra} = "Cataloging";
$tabsysprefs{NoZebraIndexes} = "Cataloging";
$tabsysprefs{ReceiveBackIssues} = "Cataloging";
$tabsysprefs{DefaultClassificationSource} = "Cataloging";
$tabsysprefs{RoutingSerials} = "Cataloging";
$tabsysprefs{'item-level_itypes'} = "Cataloging";
$tabsysprefs{OpacSuppression} = "Cataloging";
$tabsysprefs{SpineLabelFormat} = "Cataloging";
$tabsysprefs{SpineLabelAutoPrint} = "Cataloging";
# Circulation
$tabsysprefs{maxoutstanding} = "Circulation";
$tabsysprefs{maxreserves} = "Circulation";
$tabsysprefs{noissuescharge} = "Circulation";
$tabsysprefs{IssuingInProcess} = "Circulation";
$tabsysprefs{patronimages} = "Circulation";
$tabsysprefs{printcirculationslips} = "Circulation";
$tabsysprefs{ReturnBeforeExpiry} = "Circulation";
$tabsysprefs{SpecifyDueDate} = "Circulation";
$tabsysprefs{AutomaticItemReturn} = "Circulation";
$tabsysprefs{ReservesMaxPickUpDelay} = "Circulation";
$tabsysprefs{TransfersMaxDaysWarning} = "Circulation";
$tabsysprefs{useDaysMode} = "Circulation";
$tabsysprefs{ReservesNeedReturns} = "Circulation";
$tabsysprefs{CircAutocompl} = "Circulation";
$tabsysprefs{AllowRenewalLimitOverride} = "Circulation";
$tabsysprefs{canreservefromotherbranches} = "Circulation";
$tabsysprefs{finesMode} = "Circulation";
$tabsysprefs{numReturnedItemsToShow} = "Circulation";
$tabsysprefs{emailLibrarianWhenHoldIsPlaced} = "Circulation";
$tabsysprefs{itemBarcodeInputFilter} = "Circulation";
$tabsysprefs{WebBasedSelfCheck} = "Circulation";
$tabsysprefs{ShowPatronImageInWebBasedSelfCheck} = "Circulation";
$tabsysprefs{CircControl} = "Circulation";
$tabsysprefs{finesCalendar} = "Circulation";
$tabsysprefs{previousIssuesDefaultSortOrder} = "Circulation";
$tabsysprefs{todaysIssuesDefaultSortOrder} = "Circulation";
$tabsysprefs{HomeOrHoldingBranch} = "Circulation";
$tabsysprefs{HomeOrHoldingBranchReturn} = "Circulation";
$tabsysprefs{RandomizeHoldsQueueWeight} = "Circulation";
$tabsysprefs{StaticHoldsQueueWeight} = "Circulation";
$tabsysprefs{AllowOnShelfHolds} = "Circulation";
$tabsysprefs{AllowHoldsOnDamagedItems} = "Circulation";
$tabsysprefs{UseBranchTransferLimits} = "Circulation";
$tabsysprefs{AllowHoldPolicyOverride} = "Circulation";
$tabsysprefs{BranchTransferLimitsType} = "Circulation";
$tabsysprefs{AllowNotForLoanOverride} = "Circulation";
$tabsysprefs{RenewalPeriodBase} = "Circulation";
$tabsysprefs{FilterBeforeOverdueReport} = "Circulation";
$tabsysprefs{AllowHoldDateInFuture} = "Circulation";
$tabsysprefs{OPACFineNoRenewals} = "Circulation";
$tabsysprefs{InProcessingToShelvingCart} = "Circulation";
$tabsysprefs{NewItemsDefaultLocation} = "Circulation";
$tabsysprefs{ReturnToShelvingCart} = "Circulation";
$tabsysprefs{DisplayClearScreenButton} = "Circulation";
$tabsysprefs{AllowAllMessageDeletion} = "Circulation";
$tabsysprefs{OverdueNoticeBcc} = "Circulation";
$tabsysprefs{OverduesBlockCirc} = "Circulation";
$tabsysprefs{UseTransportCostMatrix} = "Circulation";
$tabsysprefs{AllowReturnToBranch} = "Circulation";
# Staff Client
$tabsysprefs{template} = "StaffClient";
$tabsysprefs{intranetstylesheet} = "StaffClient";
$tabsysprefs{IntranetNav} = "StaffClient";
$tabsysprefs{intranetcolorstylesheet} = "StaffClient";
$tabsysprefs{intranetuserjs} = "StaffClient";
$tabsysprefs{yuipath} = "StaffClient";
$tabsysprefs{IntranetmainUserblock} = "StaffClient";
$tabsysprefs{viewMARC} = "StaffClient";
$tabsysprefs{viewLabeledMARC} = "StaffClient";
$tabsysprefs{viewISBD} = "StaffClient";
# Patrons
$tabsysprefs{autoMemberNum} = "Patrons";
$tabsysprefs{checkdigit} = "Patrons";
$tabsysprefs{intranetreadinghistory} = "Patrons";
$tabsysprefs{NotifyBorrowerDeparture} = "Patrons";
$tabsysprefs{memberofinstitution} = "Patrons";
$tabsysprefs{BorrowerMandatoryField} = "Patrons";
$tabsysprefs{BorrowerUnwantedField} = "Patrons";
$tabsysprefs{borrowerRelationship} = "Patrons";
$tabsysprefs{BorrowersTitles} = "Patrons";
$tabsysprefs{patronimages} = "Patrons";
$tabsysprefs{minPasswordLength} = "Patrons";
$tabsysprefs{uppercasesurnames} = "Patrons";
$tabsysprefs{MaxFine} = "Patrons";
$tabsysprefs{NotifyBorrowerDeparture} = "Patrons";
$tabsysprefs{AddPatronLists} = "Patrons";
$tabsysprefs{PatronsPerPage} = "Patrons";
$tabsysprefs{ExtendedPatronAttributes} = "Patrons";
$tabsysprefs{AutoEmailOpacUser} = "Patrons";
$tabsysprefs{AutoEmailPrimaryAddress} = "Patrons";
$tabsysprefs{EnhancedMessagingPreferences} = "Patrons";
$tabsysprefs{'SMSSendDriver'} = 'Patrons';
$tabsysprefs{HidePatronName} = "Patrons";
# I18N/L10N
$tabsysprefs{dateformat} = "I18N/L10N";
$tabsysprefs{opaclanguages} = "I18N/L10N";
$tabsysprefs{opaclanguagesdisplay} = "I18N/L10N";
$tabsysprefs{language} = "I18N/L10N";
# Searching
$tabsysprefs{defaultSortField} = "Searching";
$tabsysprefs{defaultSortOrder} = "Searching";
$tabsysprefs{numSearchResults} = "Searching";
$tabsysprefs{OPACdefaultSortField} = "Searching";
$tabsysprefs{OPACdefaultSortOrder} = "Searching";
$tabsysprefs{OPACItemsResultsDisplay} = "Searching";
$tabsysprefs{OPACnumSearchResults} = "Searching";
$tabsysprefs{QueryFuzzy} = "Searching";
$tabsysprefs{QueryStemming} = "Searching";
$tabsysprefs{QueryWeightFields} = "Searching";
$tabsysprefs{expandedSearchOption} = "Searching";
$tabsysprefs{QueryAutoTruncate} = "Searching";
$tabsysprefs{QueryRemoveStopwords} = "Searching";
$tabsysprefs{AdvancedSearchTypes} = "Searching";
$tabsysprefs{DisplayMultiPlaceHold} = "Searching";
# EnhancedContent
$tabsysprefs{AmazonCoverImages} = "EnhancedContent";
$tabsysprefs{OPACAmazonCoverImages} = "EnhancedContent";
$tabsysprefs{AmazonLocale} = "EnhancedContent";
$tabsysprefs{AmazonAssocTag} = "EnhancedContent";
# Babelthèque
$tabsysprefs{Babeltheque} = "EnhancedContent";
# Baker & Taylor
$tabsysprefs{BakerTaylorBookstoreURL} = 'EnhancedContent';
$tabsysprefs{BakerTaylorEnabled} = 'EnhancedContent';
$tabsysprefs{BakerTaylorPassword} = 'EnhancedContent';
$tabsysprefs{BakerTaylorUsername} = 'EnhancedContent';
# Library Thing for Libraries
$tabsysprefs{LibraryThingForLibrariesID} = "EnhancedContent";
$tabsysprefs{LibraryThingForLibrariesEnabled} = "EnhancedContent";
$tabsysprefs{LibraryThingForLibrariesTabbedView} = "EnhancedContent";
# Syndetics
$tabsysprefs{SyndeticsClientCode} = 'EnhancedContent';
$tabsysprefs{SyndeticsEnabled} = 'EnhancedContent';
$tabsysprefs{SyndeticsCoverImages} = 'EnhancedContent';
$tabsysprefs{SyndeticsTOC} = 'EnhancedContent';
$tabsysprefs{SyndeticsSummary} = 'EnhancedContent';
$tabsysprefs{SyndeticsEditions} = 'EnhancedContent';
$tabsysprefs{SyndeticsExcerpt} = 'EnhancedContent';
$tabsysprefs{SyndeticsReviews} = 'EnhancedContent';
$tabsysprefs{SyndeticsAuthorNotes} = 'EnhancedContent';
$tabsysprefs{SyndeticsAwards} = 'EnhancedContent';
$tabsysprefs{SyndeticsSeries} = 'EnhancedContent';
$tabsysprefs{SyndeticsCoverImageSize} = 'EnhancedContent';
# FRBR
$tabsysprefs{FRBRizeEditions} = "EnhancedContent";
$tabsysprefs{XISBN} = "EnhancedContent";
$tabsysprefs{OCLCAffiliateID} = "EnhancedContent";
$tabsysprefs{XISBNDailyLimit} = "EnhancedContent";
$tabsysprefs{ThingISBN} = "EnhancedContent";
$tabsysprefs{OPACFRBRizeEditions} = "EnhancedContent";
# Tags
$tabsysprefs{TagsEnabled} = 'EnhancedContent';
$tabsysprefs{TagsExternalDictionary} = 'EnhancedContent';
$tabsysprefs{TagsInputOnDetail} = 'EnhancedContent';
$tabsysprefs{TagsInputOnList} = 'EnhancedContent';
$tabsysprefs{TagsShowOnDetail} = 'EnhancedContent';
$tabsysprefs{TagsShowOnList} = 'EnhancedContent';
$tabsysprefs{TagsModeration} = 'EnhancedContent';
$tabsysprefs{GoogleJackets} = 'EnhancedContent';
$tabsysprefs{AuthorisedValueImages} = "EnhancedContent";
# OPAC
$tabsysprefs{BiblioDefaultView} = "OPAC";
$tabsysprefs{LibraryName} = "OPAC";
$tabsysprefs{opaccolorstylesheet} = "OPAC";
$tabsysprefs{opaccredits} = "OPAC";
$tabsysprefs{opaclayoutstylesheet} = "OPAC";
$tabsysprefs{OpacNav} = "OPAC";
$tabsysprefs{opacsmallimage} = "OPAC";
$tabsysprefs{opacthemes} = "OPAC";
$tabsysprefs{opacuserjs} = "OPAC";
$tabsysprefs{opacheader} = "OPAC";
$tabsysprefs{hideBiblioNumber} = "OPAC";
$tabsysprefs{OpacMainUserBlock} = "OPAC";
$tabsysprefs{OPACURLOpenInNewWindow} = "OPAC";
$tabsysprefs{OPACUserCSS} = "OPAC";
$tabsysprefs{OPACHighlightedWords} = "OPAC";
$tabsysprefs{OPACViewOthersSuggestions} = "OPAC";
$tabsysprefs{URLLinkText} = "OPAC";
$tabsysprefs{OPACSearchForTitleIn} = "OPAC";
$tabsysprefs{OPACShelfBrowser} = "OPAC";
$tabsysprefs{OPACShowHoldQueueDetails} = "OPAC";
$tabsysprefs{OPACAllowHoldDateInFuture} = "OPAC";
$tabsysprefs{OPACPatronDetails} = "OPAC";
$tabsysprefs{OPACFinesTab} = "OPAC";
$tabsysprefs{DisplayOPACiconsXSLT} = "OPAC";
$tabsysprefs{AutoSelfCheckAllowed} = "OPAC";
$tabsysprefs{AutoSelfCheckID} = "OPAC";
$tabsysprefs{AutoSelfCheckPass} = "OPAC";
# OPAC
$tabsysprefs{SearchMyLibraryFirst} = "OPAC";
$tabsysprefs{hidelostitems} = "OPAC";
$tabsysprefs{opacbookbag} = "OPAC";
$tabsysprefs{OpacPasswordChange} = "OPAC";
$tabsysprefs{opacreadinghistory} = "OPAC";
$tabsysprefs{virtualshelves} = "OPAC";
$tabsysprefs{RequestOnOpac} = "OPAC";
$tabsysprefs{reviewson} = "OPAC";
$tabsysprefs{OpacTopissues} = "OPAC";
$tabsysprefs{OpacAuthorities} = "OPAC";
$tabsysprefs{OpacCloud} = "OPAC";
$tabsysprefs{opacuserlogin} = "OPAC";
$tabsysprefs{AnonSuggestions} = "OPAC";
$tabsysprefs{suggestion} = "OPAC";
$tabsysprefs{OpacTopissue} = "OPAC";
$tabsysprefs{OpacBrowser} = "OPAC";
$tabsysprefs{OpacRenewalAllowed} = "OPAC";
$tabsysprefs{OPACItemHolds} = "OPAC";
$tabsysprefs{OPACGroupResults} = "OPAC";
$tabsysprefs{XSLTDetailsDisplay} = "OPAC";
$tabsysprefs{XSLTResultsDisplay} = "OPAC";
$tabsysprefs{OPACShowCheckoutName} = "OPAC";
$tabsysprefs{AllowPurchaseSuggestionBranchChoice} = "OPAC";
# Serials
$tabsysprefs{RoutingListAddReserves} = "Serials";
$tabsysprefs{OPACSerialIssueDisplayCount} = "Serials";
$tabsysprefs{StaffSerialIssueDisplayCount} = "Serials";
$tabsysprefs{RenewSerialAddsSuggestion} = "Serials";
$tabsysprefs{SubscriptionHistory} = "Serials";
# LOGFeatures
$tabsysprefs{CataloguingLog} = "Logs";
$tabsysprefs{BorrowersLog} = "Logs";
$tabsysprefs{SubscriptionLog} = "Logs";
$tabsysprefs{IssueLog} = "Logs";
$tabsysprefs{ReturnLog} = "Logs";
$tabsysprefs{LetterLog} = "Logs";
$tabsysprefs{FinesLog} = "Logs";
# OAI-PMH variables
$tabsysprefs{'OAI-PMH'} = "OAI-PMH";
$tabsysprefs{'OAI-PMH:archiveID'} = "OAI-PMH";
$tabsysprefs{'OAI-PMH:MaxCount'} = "OAI-PMH";
# ILS-DI variables
$tabsysprefs{'ILS-DI'} = "ILS-DI";
$tabsysprefs{'ILS-DI:AuthorizedIPs'} = "Admin";
# Creator variables
$tabsysprefs{'ImageLimit'} = "Creators";
sub StringSearch {
my ( $searchstring, $type ) = @_;
my $dbh = C4::Context->dbh;
$searchstring =~ s/\'/\\\'/g;
my @data = split( ' ', $searchstring );
my $count = @data;
my @results;
my $cnt = 0;
my $sth;
# used for doing a plain-old sys-pref search
if ( $type && $type ne 'all' ) {
foreach my $syspref ( sort { lc $a cmp lc $b } keys %tabsysprefs ) {
if ( $tabsysprefs{$syspref} eq $type ) {
my $sth = $dbh->prepare("Select variable,value,explanation,type,options from systempreferences where (variable like ?) order by variable");
$sth->execute($syspref);
while ( my $data = $sth->fetchrow_hashref ) {
$data->{shortvalue} = $data->{value};
$data->{shortvalue} = substr( $data->{value}, 0, 60 ) . "..." if defined( $data->{value} ) and length( $data->{value} ) > 60;
push( @results, $data );
$cnt++;
}
$sth->finish;
}
}
} else {
my $sth;
if ( $type and $type eq 'all' ) {
$sth = $dbh->prepare( "
SELECT *
FROM systempreferences
WHERE variable LIKE ? OR explanation LIKE ?
ORDER BY VARIABLE" );
$sth->execute( "%$searchstring%", "%$searchstring%" );
} else {
my $strsth = "Select variable,value,explanation,type,options from systempreferences where variable in (";
my $first = 1;
for my $name ( get_local_prefs() ) {
$strsth .= ',' unless $first;
$strsth .= "'$name'";
$first = 0;
}
$strsth .= ") order by variable";
$sth = $dbh->prepare($strsth);
$sth->execute();
}
while ( my $data = $sth->fetchrow_hashref ) {
$data->{shortvalue} = $data->{value};
$data->{shortvalue} = substr( $data->{value}, 0, 60 ) . "..." if length( $data->{value} ) > 60;
push( @results, $data );
$cnt++;
}
$sth->finish;
}
return ( $cnt, \@results );
}
sub GetPrefParams {
my $data = shift;
my $params = $data;
my @options;
if ( defined $data->{'options'} ) {
foreach my $option ( split( /\|/, $data->{'options'} ) ) {
my $selected = '0';
defined( $data->{'value'} ) and $option eq $data->{'value'} and $selected = 1;
push @options, { option => $option, selected => $selected };
}
}
$params->{'prefoptions'} = $data->{'options'};
if ( not defined( $data->{'type'} ) ) {
$params->{'type_free'} = 1;
$params->{'fieldlength'} = ( defined( $data->{'options'} ) and $data->{'options'} and $data->{'options'} > 0 );
} elsif ( $data->{'type'} eq 'Upload' ) {
$params->{'type_upload'} = 1;
} elsif ( $data->{'type'} eq 'Choice' ) {
$params->{'type_choice'} = 1;
} elsif ( $data->{'type'} eq 'YesNo' ) {
$params->{'type_yesno'} = 1;
$data->{'value'} = C4::Context->boolean_preference( $data->{'variable'} );
if ( defined( $data->{'value'} ) and $data->{'value'} eq '1' ) {
$params->{'value_yes'} = 1;
} else {
$params->{'value_no'} = 1;
}
} elsif ( $data->{'type'} eq 'Integer' || $data->{'type'} eq 'Float' ) {
$params->{'type_free'} = 1;
$params->{'fieldlength'} = ( defined( $data->{'options'} ) and $data->{'options'} and $data->{'options'} > 0 ) ? $data->{'options'} : 10;
} elsif ( $data->{'type'} eq 'Textarea' ) {
$params->{'type_textarea'} = 1;
$data->{options} =~ /(.*)\|(.*)/;
$params->{'cols'} = $1;
$params->{'rows'} = $2;
} elsif ( $data->{'type'} eq 'Themes' ) {
$params->{'type_choice'} = 1;
my $type = '';
( $data->{'variable'} =~ m#opac#i ) ? ( $type = 'opac' ) : ( $type = 'intranet' );
@options = ();
my $currently_selected_themes;
my $counter = 0;
foreach my $theme ( split /\s+/, $data->{'value'} ) {
push @options, { option => $theme, counter => $counter };
$currently_selected_themes->{$theme} = 1;
$counter++;
}
foreach my $theme ( getallthemes($type) ) {
my $selected = '0';
next if $currently_selected_themes->{$theme};
push @options, { option => $theme, counter => $counter };
$counter++;
}
} elsif ( $data->{'type'} eq 'ClassSources' ) {
$params->{'type_choice'} = 1;
my $type = '';
@options = ();
my $sources = GetClassSources();
my $counter = 0;
foreach my $cn_source ( sort keys %$sources ) {
if ( $cn_source eq $data->{'value'} ) {
push @options, { option => $cn_source, counter => $counter, selected => 1 };
} else {
push @options, { option => $cn_source, counter => $counter };
}
$counter++;
}
} elsif ( $data->{'type'} eq 'Languages' ) {
my $currently_selected_languages;
foreach my $language ( split /\s+/, $data->{'value'} ) {
$currently_selected_languages->{$language} = 1;
}
# current language
my $lang = $params->{'lang'};
my $theme;
my $interface;
if ( $data->{'variable'} =~ /opac/ ) {
# this is the OPAC
$interface = 'opac';
$theme = C4::Context->preference('opacthemes');
} else {
# this is the staff client
$interface = 'intranet';
$theme = C4::Context->preference('template');
}
my $languages_loop = getTranslatedLanguages( $interface, $theme, $lang, $currently_selected_languages );
$params->{'languages_loop'} = $languages_loop;
$params->{'type_langselector'} = 1;
} else {
$params->{'type_free'} = 1;
$params->{'fieldlength'} = ( defined( $data->{'options'} ) and $data->{'options'} and $data->{'options'} > 0 ) ? $data->{'options'} : 30;
}
if ( $params->{'type_choice'} || $params->{'type_free'} || $params->{'type_yesno'} ) {
$params->{'oneline'} = 1;
}
$params->{'preftype'} = $data->{'type'};
$params->{'options'} = \@options;
return $params;
}
my $input = new CGI;
my $searchfield = $input->param('searchfield') || '';
my $Tvalue = $input->param('Tvalue');
my $offset = $input->param('offset') || 0;
my $script_name = "/cgi-bin/koha/admin/systempreferences.pl";
my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
{ template_name => "admin/systempreferences.tmpl",
query => $input,
type => "intranet",
authnotrequired => 0,
flagsrequired => { parameters => 'parameters_remaining_permissions' },
debug => 1,
}
);
my $pagesize = 100;
my $op = $input->param('op') || '';
$searchfield =~ s/\,//g;
if ($op) {
$template->param(
script_name => $script_name,
$op => 1
); # we show only the TMPL_VAR names $op
} else {
$template->param(
script_name => $script_name,
else => 1
); # we show only the TMPL_VAR names $op
}
if ( $op eq 'update_and_reedit' ) {
foreach ( $input->param ) {
}
my $value = '';
if ( my $currentorder = $input->param('currentorder') ) {
my @currentorder = split /\|/, $currentorder;
my $orderchanged = 0;
foreach my $param ( $input->param ) {
if ( $param =~ m#up-(\d+).x# ) {
my $temp = $currentorder[$1];
$currentorder[$1] = $currentorder[ $1 - 1 ];
$currentorder[ $1 - 1 ] = $temp;
$orderchanged = 1;
last;
} elsif ( $param =~ m#down-(\d+).x# ) {
my $temp = $currentorder[$1];
$currentorder[$1] = $currentorder[ $1 + 1 ];
$currentorder[ $1 + 1 ] = $temp;
$orderchanged = 1;
last;
}
}
$value = join ' ', @currentorder;
if ($orderchanged) {
$op = 'add_form';
$template->param(
script_name => $script_name,
$op => 1
); # we show only the TMPL_VAR names $op
} else {
$op = '';
$searchfield = '';
$template->param(
script_name => $script_name,
else => 1
); # we show only the TMPL_VAR names $op
}
}
my $dbh = C4::Context->dbh;
my $query = "select * from systempreferences where variable=?";
my $sth = $dbh->prepare($query);
$sth->execute( $input->param('variable') );
if ( $sth->rows ) {
unless ( C4::Context->config('demo') ) {
my $sth = $dbh->prepare("update systempreferences set value=?,explanation=?,type=?,options=? where variable=?");
$sth->execute( $value, $input->param('explanation'), $input->param('variable'), $input->param('preftype'), $input->param('prefoptions') );
$sth->finish;
logaction( 'SYSTEMPREFERENCE', 'MODIFY', undef, $input->param('variable') . " | " . $value );
}
} else {
unless ( C4::Context->config('demo') ) {
my $sth = $dbh->prepare("insert into systempreferences (variable,value,explanation) values (?,?,?,?,?)");
$sth->execute( $input->param('variable'), $input->param('value'), $input->param('explanation'), $input->param('preftype'), $input->param('prefoptions') );
$sth->finish;
logaction( 'SYSTEMPREFERENCE', 'ADD', undef, $input->param('variable') . " | " . $input->param('value') );
}
}
$sth->finish;
}
################## ADD_FORM ##################################
# called by default. Used to create form to add or modify a record
if ( $op eq 'add_form' ) {
#---- if primkey exists, it's a modify action, so read values to modify...
my $data;
if ($searchfield) {
my $dbh = C4::Context->dbh;
my $sth = $dbh->prepare("select variable,value,explanation,type,options from systempreferences where variable=?");
$sth->execute($searchfield);
$data = $sth->fetchrow_hashref;
$sth->finish;
$template->param( modify => 1 );
# save tab to return to if user cancels edit
$template->param( return_tab => $tabsysprefs{$searchfield} );
}
$data->{'lang'} = $template->param('lang');
my $prefparams = GetPrefParams($data);
$template->param( %$prefparams );
$template->param( searchfield => $searchfield );
################## ADD_VALIDATE ##################################
# called by add_form, used to insert/modify data in DB
} elsif ( $op eq 'add_validate' ) {
my $dbh = C4::Context->dbh;
my $sth = $dbh->prepare("select * from systempreferences where variable=?");
$sth->execute( $input->param('variable') );
# to handle multiple values
my $value;
# handle multiple value strings (separated by ',')
my $params = $input->Vars;
if ( defined $params->{'value'} ) {
my @values = ();
@values = split( "\0", $params->{'value'} ) if defined( $params->{'value'} );
if (@values) {
$value = "";
for my $vl (@values) {
$value .= "$vl,";
}
$value =~ s/,$//;
} else {
$value = $params->{'value'};
}
}
if ( $input->param('preftype') eq 'Upload' ) {
my $lgtfh = $input->upload('value');
$value = join '', <$lgtfh>;
$value = encode_base64($value);
}
if ( $sth->rows ) {
unless ( C4::Context->config('demo') ) {
my $sth = $dbh->prepare("update systempreferences set value=?,explanation=?,type=?,options=? where variable=?");
$sth->execute( $value, $input->param('explanation'), $input->param('preftype'), $input->param('prefoptions'), $input->param('variable') );
$sth->finish;
logaction( 'SYSTEMPREFERENCE', 'MODIFY', undef, $input->param('variable') . " | " . $value );
}
} else {
unless ( C4::Context->config('demo') ) {
my $sth = $dbh->prepare("insert into systempreferences (variable,value,explanation,type,options) values (?,?,?,?,?)");
$sth->execute( $input->param('variable'), $value, $input->param('explanation'), $input->param('preftype'), $input->param('prefoptions') );
$sth->finish;
logaction( 'SYSTEMPREFERENCE', 'ADD', undef, $input->param('variable') . " | " . $value );
}
}
$sth->finish;
print "Content-Type: text/html\n\n<META HTTP-EQUIV=Refresh CONTENT=\"0; URL=systempreferences.pl?tab=\"></html>";
exit;
################## DELETE_CONFIRM ##################################
# called by default form, used to confirm deletion of data in DB
} elsif ( $op eq 'delete_confirm' ) {
my $dbh = C4::Context->dbh;
my $sth = $dbh->prepare("select variable,value,explanation,type,options from systempreferences where variable=?");
$sth->execute($searchfield);
my $data = $sth->fetchrow_hashref;
$sth->finish;
$template->param(
searchfield => $searchfield,
Tvalue => $data->{'value'},
);
# END $OP eq DELETE_CONFIRM
################## DELETE_CONFIRMED ##################################
# called by delete_confirm, used to effectively confirm deletion of data in DB
} elsif ( $op eq 'delete_confirmed' ) {
my $dbh = C4::Context->dbh;
my $sth = $dbh->prepare("delete from systempreferences where variable=?");
$sth->execute($searchfield);
my $logstring = $searchfield . " | " . $Tvalue;
logaction( 'SYSTEMPREFERENCE', 'DELETE', undef, $logstring );
$sth->finish;
# END $OP eq DELETE_CONFIRMED
################## DEFAULT ##################################
} else { # DEFAULT
#Adding tab management for system preferences
my $tab = $input->param('tab');
$template->param( $tab => 1 );
my ( $count, $results ) = StringSearch( $searchfield, $tab );
my @loop_data = ();
for ( my $i = $offset ; $i < ( $offset + $pagesize < $count ? $offset + $pagesize : $count ) ; $i++ ) {
my $row_data = $results->[$i];
$row_data->{'lang'} = $template->param('lang');
$row_data = GetPrefParams($row_data); # get a fresh hash for the row data
$row_data->{edit} = "$script_name?op=add_form&amp;searchfield=" . $results->[$i]{'variable'};
$row_data->{delete} = "$script_name?op=delete_confirm&amp;searchfield=" . $results->[$i]{'variable'};
push( @loop_data, $row_data );
}
$tab = ( $tab ? $tab : "local_use" );
$template->param( loop => \@loop_data, $tab => 1 );
if ( $offset > 0 ) {
my $prevpage = $offset - $pagesize;
$template->param( "<a href=$script_name?offset=" . $prevpage . '&lt;&lt; Prev</a>' );
}
if ( $offset + $pagesize < $count ) {
my $nextpage = $offset + $pagesize;
$template->param( "a href=$script_name?offset=" . $nextpage . 'Next &gt;&gt;</a>' );
}
$template->param( tab => $tab, );
} #---- END $OP eq DEFAULT
output_html_with_http_headers $input, $cookie, $template->output;
# Return an array containing all preferences defined in current Koha instance
# .pref files.
sub get_prefs_from_files {
my $context = C4::Context->new();
my $path_pref_en = $context->config('intrahtdocs') .
'/prog/en/modules/admin/preferences';
# Get all .pref file names
opendir ( my $fh, $path_pref_en );
my @pref_files = grep { /.pref/ } readdir($fh);
close $fh;
my @names = ();
my $append = sub {
my $prefs = shift;
for my $pref ( @$prefs ) {
for my $element ( @$pref ) {
if ( ref( $element) eq 'HASH' ) {
my $name = $element->{pref};
next unless $name;
push @names, $name;
next;
}
}
}
};
for my $file (@pref_files) {
my $pref = LoadFile( "$path_pref_en/$file" );
for my $tab ( keys %$pref ) {
my $content = $pref->{$tab};
if ( ref($content) eq 'ARRAY' ) {
$append->($content);
next;
}
for my $section ( keys %$content ) {
my $syspref = $content->{$section};
$append->($syspref);
}
}
}
return @names;
}
# Return an array containg all preferences defined in DB
sub get_prefs_from_db {
my $dbh = C4::Context->dbh;
my $sth = $dbh->prepare("SELECT variable FROM systempreferences");
$sth->execute;
my @names = ();
while ( (my $name) = $sth->fetchrow_array ) {
push @names, $name if $name;
}
return @names;
}
# Return an array containing all local preferences: those which are defined in
# DB and not defined in Koha .pref files.
sub get_local_prefs {
my @prefs_file = get_prefs_from_files();
my @prefs_db = get_prefs_from_db();
my %prefs_file = map { $_ => 1 } @prefs_file;
my @names = ();
foreach my $name (@prefs_db) {
push @names, $name unless $prefs_file{$name};
}
return @names;
}
View git blame Copy permalink