Bug 16016: Sitemap handling scripts for packages
authorTomas Cohen Arazi <tomascohen@theke.io>
Tue, 8 Mar 2016 17:48:17 +0000 (14:48 -0300)
committerKyle M Hall <kyle@bywatersolutions.com>
Wed, 4 May 2016 13:34:21 +0000 (13:34 +0000)
commit4e7734ce330ce73eaa5cfbd7525ea073bb2a1acb
tree3d6b5f8ea7a910ebbfa0fc0868d7c2c534a69527
parent30dc04c74a2ef00c22667f722746c2c6be1da6b1
Bug 16016: Sitemap handling scripts for packages

This patch introduces the koha-sitemap script. This script wraps calls to
the misc/cronjobs/sitemap.pl script so it can be done easily instance-wise.

It sets /var/lib/koha/${instance}/sitemap as the destination directory for
the sitemap files. A followup will make them available through an Apache
configuration entry.

koha-functions.sh is provided with a handy is_sitemap_enabled function so
we can later add filters to other commands (koha-list, koha-foreach, etc).

Exposes sitemap files to apache. This is suitable for including the sitemap in
the robots.txt file as proposed in

  http://www.sitemaps.org/protocol.html#submit_robots

Note: it depends on Apache 2.4+ so we can patch the file as needed. Older
Apache users will be warned that they need to tweak the apache files on their
own.

To test:
- You can build a package out of this patchset, or do the following on a kohadevbox
  cp debian/scripts/koha-functions.sh /usr/share/koha/bin
- Run
  $ debian/scripts/koha-sitemap --help
- Go through all the options (--enable, --disable, generate).
(a) --enable:
  - debian/scripts/koha-sitemap --enable kohadev
=> SUCCESS: /var/lib/koha/kohadev/sitemap.enabled is created
  - call it again, a suitable warning is raised and the file is still there
(b) debian/scripts/koha-sitemap --disable kohadev
=> SUCCESS: /var/lib/koha/kohadev/sitemap.enabled is deleted
  - call it again, a suitable warning is raised and the file does not exist
(c) --generate:
  - debian/scripts/koha-sitemap --generate kohadev
=> SUCCESS: sitemapindex.xml and sitemap000X.xml files are generated in
            /var/lib/koha/kohadev/sitemap/
- Sign off :-D

Sponsored-by: Orex Digital
Signed-off-by: Frédéric Demians <f.demians@tamil.fr>
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
debian/docs/koha-sitemap.xml [new file with mode: 0644]
debian/koha-common.install
debian/scripts/koha-functions.sh
debian/scripts/koha-sitemap [new file with mode: 0755]
debian/templates/apache-shared-opac.conf