Koha/C4/UsageStats.pm
Nick Clemens 78a7d5aada Bug 14576: Allow arbitrary automatic update of location on checkin
This patch adds a new syspref "UpdateItemLocationOnCheckin" which
accepts pairs of shelving locations.  On check-in the items location is
compared ot the location on the left and, if it matches, is updated to
the location on the left.

This preference replaces ReturnToShelvingCart and
InProcessingToShelvingCart preferences.  The update statement should
insert values that replciate these functions.  Note existing
functionality of all items in PROC location being returned to
permanent_location is preserved by default.  Also, any items issued from
CART location will be returned to their permanent location on issue (if
it differs)

Special values for this pref are:
_ALL_ - used on left side only to affect all items
_BLANK_ - used on either side to match on/set to blank (actual blanks
        will work, but this is an easier to read option)
_PERM_ - used on right side only to return items to permanent location

Test Plan:
1) Apply this patch
2) Run updatedatabase.pl
3) Set the new system preference UpdateitemLocationOnCheckin
   to the following (assuming sample data):
   NEW: FIC
   FIC: GEN
4) Create an item, set its location to NEW
5) Check in the item, note its location is now FIC
6) Check in the item again, note its location is now GEN
7) Check in the item again, note its location remains GEN
8) Test using _ALL_, _BLANK_ and _PERM_ for updates
9) Try entering various incorrect syntax in the pref and note you are warned

Sponsored by:
    Arcadia Public Library (http://library.ci.arcadia.ca.us/)
    Middletown Township Public Library (http://www.mtpl.org/)
    Round Rock Public Library (https://www.roundrocktexas.gov/departments/library/)

Signed-off-by: Michal Denar <black23@gmail.com>

Signed-off-by: Liz Rea <wizzyrea@gmail.com>

Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
2019-04-25 11:36:23 +00:00

386 lines
10 KiB
Perl

package C4::UsageStats;
# This file is part of Koha.
#
# Copyright 2014 BibLibre
#
# 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 3 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, see <http://www.gnu.org/licenses>.
use Modern::Perl;
use C4::Context;
use POSIX qw(strftime);
use LWP::UserAgent;
use JSON;
use Koha::Libraries;
=head1 NAME
C4::UsageStats
=head1 DESCRIPTION
This package contains what is needed to report Koha statistics to hea
hea.koha-community.org is the server that centralize Koha setups informations
Koha libraries are encouraged to provide informations about their collections,
their structure,...
=head2 NeedUpdate
$needUpdateYN = C4::UsageStats::NeedUpdate;
Returns Y (1) if the last update is more than 1 month old
This way, even if the cronjob is run every minute, the webservice will be called
only once a month !
=cut
sub NeedUpdate {
my $lastupdated = C4::Context->preference('UsageStatsLastUpdateTime') || 0;
my $now = strftime( "%s", localtime );
# Need to launch cron.
return 1 if $now - $lastupdated >= 2592000;
# Data don't need to be updated
return 0;
}
sub BuildReport {
my $report;
my @libraries;
if( C4::Context->preference('UsageStatsLibrariesInfo') ) {
my $libraries = Koha::Libraries->search;
while ( my $library = $libraries->next ) {
push @libraries, { name => $library->branchname, url => $library->branchurl, country => $library->branchcountry, geolocation => $library->geolocation, };
}
}
$report = {
installation => {
koha_id => C4::Context->preference('UsageStatsID') || 0,
name => C4::Context->preference('UsageStatsLibraryName') || q||,
url => C4::Context->preference('UsageStatsLibraryUrl') || q||,
type => C4::Context->preference('UsageStatsLibraryType') || q||,
country => C4::Context->preference('UsageStatsCountry') || q||,
geolocation => C4::Context->preference('UsageStatsGeolocation') || q||,
},
libraries => \@libraries,
};
# Get database volumetry.
foreach (
qw/biblio items auth_header old_issues old_reserves borrowers aqorders subscription/
)
{
$report->{volumetry}{$_} = _count($_);
}
# Get systempreferences.
foreach (
qw/
AcqCreateItem
AcqWarnOnDuplicateInvoice
AcqViewBaskets
BasketConfirmations
OrderPdfFormat
casAuthentication
casLogout
AllowPKIAuth
DebugLevel
delimiter
noItemTypeImages
virtualshelves
AutoLocation
IndependentBranches
SessionStorage
Persona
AuthDisplayHierarchy
AutoCreateAuthorities
BiblioAddsAuthorities
AuthorityMergeLimit
AuthorityMergeMode
UseAuthoritiesForTracings
CatalogModuleRelink
hide_marc
IntranetBiblioDefaultView
LabelMARCView
OpacSuppression
SeparateHoldings
UseControlNumber
advancedMARCeditor
DefaultClassificationSource
EasyAnalyticalRecords
autoBarcode
item-level_itypes
marcflavour
PrefillItem
z3950NormalizeAuthor
SpineLabelAutoPrint
SpineLabelShowPrintOnBibDetails
BlockReturnOfLostItems
BlockReturnOfWithdrawnItems
CalculateFinesOnReturn
AgeRestrictionOverride
AllFinesNeedOverride
AllowFineOverride
AllowItemsOnHoldCheckout
AllowItemsOnHoldCheckoutSCO
AllowNotForLoanOverride
AllowRenewalLimitOverride
AllowReturnToBranch
AllowTooManyOverride
AutomaticItemReturn
AutoRemoveOverduesRestrictions
CircControl
HomeOrHoldingBranch
IssueLostItem
IssuingInProcess
ManInvInNoissuesCharge
OverduesBlockCirc
RenewalPeriodBase
RenewalSendNotice
RentalsInNoissuesCharge
ReturnBeforeExpiry
TransfersMaxDaysWarning
UseBranchTransferLimits
useDaysMode
UseTransportCostMatrix
UseCourseReserves
finesCalendar
FinesIncludeGracePeriod
finesMode
RefundLostOnReturnControl
WhenLostChargeReplacementFee
WhenLostForgiveFine
AllowHoldDateInFuture
AllowHoldPolicyOverride
AllowHoldsOnDamagedItems
AllowHoldsOnPatronsPossessions
AutoResumeSuspendedHolds
canreservefromotherbranches
decreaseLoanHighHolds
DisplayMultiPlaceHold
emailLibrarianWhenHoldIsPlaced
ExpireReservesMaxPickUpDelay
OPACAllowHoldDateInFuture
OPACAllowUserToChooseBranch
ReservesControlBranch
ReservesNeedReturns
SuspendHoldsIntranet
SuspendHoldsOpac
TransferWhenCancelAllWaitingHolds
AllowAllMessageDeletion
AllowOfflineCirculation
CircAutocompl
CircAutoPrintQuickSlip
DisplayClearScreenButton
FilterBeforeOverdueReport
FineNotifyAtCheckin
itemBarcodeFallbackSearch
itemBarcodeInputFilter
previousIssuesDefaultSortOrder
RecordLocalUseOnReturn
AudioAlerts
SpecifyDueDate
todaysIssuesDefaultSortOrder
UpdateTotalIssuesOnCirc
UseTablesortForCirc
WaitingNotifyAtCheckin
AllowSelfCheckReturns
AutoSelfCheckAllowed
FRBRizeEditions
OPACFRBRizeEditions
AmazonCoverImages
OPACAmazonCoverImages
Babeltheque
BakerTaylorEnabled
GoogleJackets
HTML5MediaEnabled
IDreamBooksReadometer
IDreamBooksResults
IDreamBooksReviews
LibraryThingForLibrariesEnabled
LocalCoverImages
OPACLocalCoverImages
NovelistSelectEnabled
OpenLibraryCovers
OpenLibrarySearch
UseKohaPlugins
SyndeticsEnabled
TagsEnabled
CalendarFirstDayOfWeek
opaclanguagesdisplay
AuthoritiesLog
BorrowersLog
CataloguingLog
FinesLog
IssueLog
LetterLog
ReturnLog
SubscriptionLog
BiblioDefaultView
COinSinOPACResults
DisplayOPACiconsXSLT
hidelostitems
HighlightOwnItemsOnOPAC
OpacAddMastheadLibraryPulldown
OPACDisplay856uAsImage
OpacHighlightedWords
OpacKohaUrl
OpacMaintenance
OpacPublic
OpacSeparateHoldings
OPACShowCheckoutName
OpacShowFiltersPulldownMobile
OPACShowHoldQueueDetails
OpacShowRecentComments
OPACShowUnusedAuthorities
OpacStarRatings
opacthemes
OPACURLOpenInNewWindow
OpacAuthorities
opacbookbag
OpacBrowser
OpacBrowseResults
OpacCloud
OPACFinesTab
OpacHoldNotes
OpacItemLocation
OpacPasswordChange
OPACPatronDetails
OPACpatronimages
OPACPopupAuthorsSearch
OpacTopissue
opacuserlogin
QuoteOfTheDay
RequestOnOpac
reviewson
ShowReviewer
ShowReviewerPhoto
SocialNetworks
suggestion
AllowPurchaseSuggestionBranchChoice
OpacAllowPublicListCreation
OpacAllowSharingPrivateLists
OpacRenewalAllowed
OpacRenewalBranch
OPACViewOthersSuggestions
SearchMyLibraryFirst
AnonSuggestions
EnableOpacSearchHistory
OPACPrivacy
opacreadinghistory
TrackClicks
PatronSelfRegistration
OPACShelfBrowser
AutoEmailOpacUser
AutoEmailPrimaryAddress
autoMemberNum
BorrowerRenewalPeriodBase
EnableBorrowerFiles
EnhancedMessagingPreferences
ExtendedPatronAttributes
intranetreadinghistory
patronimages
TalkingTechItivaPhoneNotification
uppercasesurnames
IncludeSeeFromInSearches
OpacGroupResults
QueryAutoTruncate
QueryFuzzy
QueryStemming
QueryWeightFields
TraceCompleteSubfields
TraceSubjectSubdivisions
UseICU
UseQueryParser
defaultSortField
displayFacetCount
OPACdefaultSortField
OPACItemsResultsDisplay
expandedSearchOption
IntranetNumbersPreferPhrase
OPACNumbersPreferPhrase
opacSerialDefaultTab
RenewSerialAddsSuggestion
RoutingListAddReserves
RoutingSerials
SubscriptionHistory
Display856uAsImage
DisplayIconsXSLT
template
yuipath
HidePatronName
intranetbookbag
StaffDetailItemSelection
viewISBD
viewLabeledMARC
viewMARC
ILS-DI
OAI-PMH
version
/
)
{
$report->{systempreferences}{$_} = C4::Context->preference($_);
}
return $report;
}
=head2 ReportToCommunity
ReportToCommunity;
Send to hea.koha-community.org database informations
=cut
sub ReportToCommunity {
my $data = shift;
my $json = encode_json($data);
my $url = "https://hea.koha-community.org/upload.pl";
my $ua = LWP::UserAgent->new;
my $res = $ua->post(
$url,
'Content-type' => 'application/json;charset=utf-8',
Content => $json,
);
my $content = decode_json( $res->decoded_content );
if ( $content->{koha_id} ) {
C4::Context->set_preference( 'UsageStatsID', $content->{koha_id} );
}
if ( $content->{id} ) {
C4::Context->set_preference( 'UsageStatsPublicID', $content->{id} );
}
}
=head2 _count
$data = _count($table);
Count the number of records in $table tables
=cut
sub _count {
my $table = shift;
my $dbh = C4::Context->dbh;
my $sth = $dbh->prepare("SELECT count(*) from $table");
$sth->execute;
return $sth->fetchrow_array;
}
1;