1 package C4::UsageStats;
3 # This file is part of Koha.
5 # Copyright 2014 BibLibre
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>.
22 use POSIX qw( strftime );
24 use JSON qw( decode_json encode_json );
34 This package contains what is needed to report Koha statistics to hea
35 hea.koha-community.org is the server that centralize Koha setups informations
36 Koha libraries are encouraged to provide informations about their collections,
41 $needUpdateYN = C4::UsageStats::NeedUpdate;
43 Returns Y (1) if the last update is more than 1 month old
44 This way, even if the cronjob is run every minute, the webservice will be called
50 my $lastupdated = C4::Context->preference('UsageStatsLastUpdateTime') || 0;
51 my $now = strftime( "%s", localtime );
53 # Need to launch cron.
54 return 1 if $now - $lastupdated >= 2592000;
56 # Data don't need to be updated
63 if( C4::Context->preference('UsageStatsLibrariesInfo') ) {
64 my $libraries = Koha::Libraries->search;
65 while ( my $library = $libraries->next ) {
66 push @libraries, { name => $library->branchname, url => $library->branchurl, country => $library->branchcountry, geolocation => $library->geolocation, };
71 koha_id => C4::Context->preference('UsageStatsID') || 0,
72 name => C4::Context->preference('UsageStatsLibraryName') || q||,
73 url => C4::Context->preference('UsageStatsLibraryUrl') || q||,
74 type => C4::Context->preference('UsageStatsLibraryType') || q||,
75 country => C4::Context->preference('UsageStatsCountry') || q||,
76 geolocation => C4::Context->preference('UsageStatsGeolocation') || q||,
78 libraries => \@libraries,
81 # Get database volumetry.
83 qw/biblio items auth_header old_issues old_reserves borrowers aqorders subscription/
86 $report->{volumetry}{$_} = _count($_);
89 # Get systempreferences.
90 foreach ( @{ _shared_preferences() } )
92 $report->{systempreferences}{$_} = C4::Context->preference($_);
97 =head2 ReportToCommunity
101 Send to hea.koha-community.org database informations
105 sub ReportToCommunity {
107 my $json = encode_json($data);
109 my $url = "https://hea.koha-community.org/upload.pl";
110 my $ua = LWP::UserAgent->new;
113 'Content-type' => 'application/json;charset=utf-8',
116 my $content = decode_json( $res->decoded_content );
117 if ( $content->{koha_id} ) {
118 C4::Context->set_preference( 'UsageStatsID', $content->{koha_id} );
120 if ( $content->{id} ) {
121 C4::Context->set_preference( 'UsageStatsPublicID', $content->{id} );
125 =head2 _shared_preferences
127 my $preferences = C4::UsageStats::_shared_preferences
129 Returns an I<arreyref> with the system preferences to be shared.
133 sub _shared_preferences {
135 my @preferences = qw/
137 AcqWarnOnDuplicateInvoice
154 AutoCreateAuthorities
156 RequireChoosingExistingAuthority
159 UseAuthoritiesForTracings
162 IntranetBiblioDefaultView
168 DefaultClassificationSource
169 EasyAnalyticalRecords
176 SpineLabelShowPrintOnBibDetails
177 BlockReturnOfLostItems
178 BlockReturnOfWithdrawnItems
179 CalculateFinesOnReturn
180 AgeRestrictionOverride
183 AllowItemsOnHoldCheckoutSIP
184 AllowItemsOnHoldCheckoutSCO
185 AllowNotForLoanOverride
186 AllowRenewalLimitOverride
190 AutoRemoveOverduesRestrictions
195 ManInvInNoissuesCharge
199 RentalsInNoissuesCharge
201 TransfersMaxDaysWarning
202 UseBranchTransferLimits
203 UseTransportCostMatrix
206 FinesIncludeGracePeriod
208 RefundLostOnReturnControl
209 WhenLostChargeReplacementFee
211 AllowHoldDateInFuture
212 AllowHoldItemTypeSelection
213 AllowHoldPolicyOverride
214 AllowHoldsOnDamagedItems
215 AllowHoldsOnPatronsPossessions
216 AutoResumeSuspendedHolds
217 canreservefromotherbranches
218 decreaseLoanHighHolds
219 DisplayMultiPlaceHold
220 emailLibrarianWhenHoldIsPlaced
221 ExpireReservesMaxPickUpDelay
222 OPACAllowHoldDateInFuture
223 OPACAllowUserToChooseBranch
224 ReservesControlBranch
228 TransferWhenCancelAllWaitingHolds
229 AllowAllMessageDeletion
230 AllowOfflineCirculation
232 CircAutoPrintQuickSlip
233 DisplayClearScreenButton
234 FilterBeforeOverdueReport
236 itemBarcodeFallbackSearch
237 itemBarcodeInputFilter
238 previousIssuesDefaultSortOrder
239 RecordLocalUseOnReturn
242 todaysIssuesDefaultSortOrder
243 UpdateTotalIssuesOnCirc
245 WaitingNotifyAtCheckin
251 OPACAmazonCoverImages
256 LibraryThingForLibrariesEnabled
259 NovelistSelectEnabled
264 CalendarFirstDayOfWeek
279 OpacAddMastheadLibraryPulldown
280 OPACDisplay856uAsImage
287 OpacShowFiltersPulldownMobile
288 OPACShowHoldQueueDetails
289 OpacShowRecentComments
290 OPACShowUnusedAuthorities
293 OPACURLOpenInNewWindow
305 OPACPopupAuthorsSearch
315 OpacAllowPublicListCreation
316 OpacAllowSharingPrivateLists
319 OPACViewOthersSuggestions
322 EnableOpacSearchHistory
326 PatronSelfRegistration
329 AutoEmailPrimaryAddress
331 BorrowerRenewalPeriodBase
333 EnhancedMessagingPreferences
334 ExtendedPatronAttributes
335 intranetreadinghistory
337 TalkingTechItivaPhoneNotification
339 IncludeSeeFromInSearches
344 TraceCompleteSubfields
345 TraceSubjectSubdivisions
351 IntranetNumbersPreferPhrase
352 OPACNumbersPreferPhrase
354 RenewSerialAddsSuggestion
355 RoutingListAddReserves
364 StaffDetailItemSelection
373 return \@preferences;
378 $data = _count($table);
380 Count the number of records in $table tables
387 my $dbh = C4::Context->dbh;
388 my $sth = $dbh->prepare("SELECT count(*) from $table");
390 return $sth->fetchrow_array;