Jonathan Druart
9d6d641d1f
On bug 17591 we discovered that there was something weird going on with the way we export and use subroutines/modules. This patch tries to standardize our EXPORT to use EXPORT_OK only. That way we will need to explicitely define the subroutine we want to use from a module. This patch is a squashed version of: Bug 17600: After export.pl Bug 17600: After perlimport Bug 17600: Manual changes Bug 17600: Other manual changes after second perlimports run Bug 17600: Fix tests And a lot of other manual changes. export.pl is a dirty script that can be found on bug 17600. "perlimport" is: git clone https://github.com/oalders/App-perlimports.git cd App-perlimports/ cpanm --installdeps . export PERL5LIB="$PERL5LIB:/kohadevbox/koha/App-perlimports/lib" find . \( -name "*.pl" -o -name "*.pm" \) -exec perl App-perlimports/script/perlimports --inplace-edit --no-preserve-unused --filename {} \; The ideas of this patch are to: * use EXPORT_OK instead of EXPORT * perltidy the EXPORT_OK list * remove '&' before the subroutine names * remove some uneeded use statements * explicitely import the subroutines we need within the controllers or modules Note that the private subroutines (starting with _) should not be exported (and not used from outside of the module except from tests). EXPORT vs EXPORT_OK (from https://www.thegeekstuff.com/2010/06/perl-exporter-examples/) """ Export allows to export the functions and variables of modules to user’s namespace using the standard import method. This way, we don’t need to create the objects for the modules to access it’s members. @EXPORT and @EXPORT_OK are the two main variables used during export operation. @EXPORT contains list of symbols (subroutines and variables) of the module to be exported into the caller namespace. @EXPORT_OK does export of symbols on demand basis. """ If this patch caused a conflict with a patch you wrote prior to its push: * Make sure you are not reintroducing a "use" statement that has been removed * "$subroutine" is not exported by the C4::$MODULE module means that you need to add the subroutine to the @EXPORT_OK list * Bareword "$subroutine" not allowed while "strict subs" means that you didn't imported the subroutine from the module: - use $MODULE qw( $subroutine list ); You can also use the fully qualified namespace: C4::$MODULE::$subroutine Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
128 lines
3 KiB
Perl
Executable file
128 lines
3 KiB
Perl
Executable file
#!/usr/bin/perl
|
|
|
|
# Copyright 2015 Tamil s.a.r.l.
|
|
#
|
|
# 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 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>.
|
|
|
|
package Main;
|
|
|
|
use Modern::Perl;
|
|
use utf8;
|
|
use Pod::Usage qw( pod2usage );
|
|
use Getopt::Long qw( GetOptions );
|
|
|
|
use Koha::Script -cron;
|
|
use Koha::Sitemapper;
|
|
|
|
|
|
my ($verbose, $help, $url, $dir, $short) = (0, 0, '', '.', 1);
|
|
GetOptions(
|
|
'verbose' => \$verbose,
|
|
'help' => \$help,
|
|
'url=s' => \$url,
|
|
'dir=s' => \$dir,
|
|
'short!' => \$short,
|
|
);
|
|
|
|
sub usage {
|
|
pod2usage( -verbose => 2 );
|
|
exit;
|
|
}
|
|
|
|
usage() if $help;
|
|
|
|
unless ($url) {
|
|
$url = C4::Context->preference("OPACBaseURL");
|
|
unless ($url) {
|
|
say "OPACBaseURL syspref isn't defined. You can use --url parameter.";
|
|
exit;
|
|
}
|
|
}
|
|
$url =~ s/\/*$//g;
|
|
|
|
my $sitemapper = Koha::Sitemapper->new(
|
|
verbose => $verbose,
|
|
url => $url,
|
|
dir => $dir,
|
|
short => $short,
|
|
);
|
|
$sitemapper->run();
|
|
|
|
|
|
=head1 USAGE
|
|
|
|
=over
|
|
|
|
=item sitemap.pl [--verbose|--help|--short|--noshort|--url|--dir]
|
|
|
|
=back
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
sitemap.pl --verbose
|
|
sitemap.pl --noshort --dir /home/koha/mylibrary/www
|
|
sitemap.pl --url opac.myDNSname.org
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Process all biblio records from a Koha instance and generate Sitemap files
|
|
complying with this protocol as described on L<http://sitemaps.org>. The goal of
|
|
this script is to be able to provide to search engines direct access to biblio
|
|
records. It avoid leaving search engine browsing Koha OPAC and so generating
|
|
a lot of traffic, and workload, for a bad result.
|
|
|
|
A file name F<sitemapindex.xml> is generated. It contains references to Sitemap
|
|
multiples files. Each file contains at most 50,000 urls, and is named
|
|
F<sitemapXXXX.xml>.
|
|
|
|
The files must be stored on Koha OPAC root directory, ie
|
|
F<<koha-root>/koha-tmpl/>. Place also in this directory a F<robots.txt> file
|
|
like this one:
|
|
|
|
Sitemap: sitemapindex.xml
|
|
User-agent: *
|
|
Disallow: /cgi-bin/
|
|
|
|
=head1 PARAMETERS
|
|
|
|
=over
|
|
|
|
=item B<--url=Koha OPAC base URL>
|
|
|
|
If omitted, OPACBaseURL syspref is used.
|
|
|
|
=item B<--short|noshort>
|
|
|
|
By default, --short. With --short, URL to bib record ends with
|
|
/bib/biblionumber. With --noshort, URL ends with
|
|
/cgi-bin/koha/opac-detail.pl?biblionumber=bibnum
|
|
|
|
=item B<--dir>
|
|
|
|
Directory where to write sitemap files. By default, the current directory.
|
|
|
|
=item B<--verbose|-v>
|
|
|
|
Enable script verbose mode: a message is displayed for each 10,000 biblio
|
|
records processed.
|
|
|
|
=item B<--help|-h>
|
|
|
|
Print this help page.
|
|
|
|
=back
|
|
|
|
=cut
|