Koha Solutions knowledge base: run log of a live check
Article https://kohasolutions.com/knowledge-base/koha-opac-customization-guide
Check scripts/kb/live/koha-opac-customization-guide.mjs (SHA-256 41d14a2ec8626f91a27a5c91bcb34fdfae30bb6416d1c227253ea163ea56ed16)
Ran 2026-11-08T05:22:56Z (UTC), 180 s
Koha 26.05.02 (Koha::version 26.05.02.002, database version 26.0600002)
Source https://git.koha-community.org/Koha-community/Koha/src/commit/d3fc229bc5eaea25dfe88f86149386408fe5d32d
System Debian GNU/Linux 13 (trixie)
Result PASS: all 80 claims held
Each claim is something the article says. "seen" is what the check read back when it is not just a yes/no.
Changes the check made to the test server were undone afterwards, as its header describes.
== Claims ==
ok the OPAC preferences named exist: LibraryName, OpacPublic, OpacMaintenance, opacthemes, OPACFallback, OPACUserCSS, OPACUserJS, OpacAdditionalStylesheet, opaclayoutstylesheet, OpacFavicon, OPACXSLTDetailsDisplay, OPACXSLTResultsDisplay, OPACXSLTListsDisplay, OPACShowLibraries, OpacAddMastheadLibraryPulldown, BiblioDefaultView, OPACAmazonCoverImages, GoogleJackets, OpenLibraryCovers, OPACLocalCoverImages, AdditionalContentsEditor
ok the OPAC tab of System preferences has 10 sections (Appearance, Features, … Authentication)
seen: 10
ok LibraryName "Kbverify Library" is the text of the header link (#logo a)
seen: Kbverify Library
ok …and the logo you see is a CSS background on #logo (koha-green-logo.svg), so it is changed with CSS
seen: url("http://localhost:8080/opac-tmpl/bootstrap/images/koha-green-logo.svg")
ok Tools lists "News", "HTML customizations", "Pages" and "Record display customizations"
ok an HTML customization in OpacMainUserBlock shows on the OPAC home page
ok a Pages entry (OPAC only) is its own page at /cgi-bin/koha/opac-page.pl?page_id=217
ok …set to staff only, the OPAC link redirects to the 404 page
seen: http://localhost:8080/cgi-bin/koha/errors/404.pl
ok a Record display customization at OPACDetailPage is added to the record's page, with [% record.title %] filled in
seen: E Street shuffle : the glory days of Bruce Springsteen & the E Street Band / Clinton Heylin. | title: E Street shuffle :
ok …and not to search results (that is OPACResultsPage)
ok OPACXSLTDetailsDisplay is "default" (the shipped stylesheet)
seen: default
ok a plain copy in another folder fails: plack-opac-error.log "xsl:import : unable to load /var/lib/koha/kohadev/MARC21slimUtils.xsl"
seen: [2026/11/08 05:23:12] [WARN] XSLT::Base: I/O warning : failed to load external entity "/var/lib/koha/kohadev/MARC21slimUtils.xsl"
compilation error: file /var/lib/koha/kohadev/kbv-detail-1794115375601.xsl element import
xsl:import : unable to load /var/lib/koha/kohadev/MARC21slimUtils.xsl
at /kohad
ok …and the record page shows none of the copy (no record description at all)
ok with the xsl:import changed to the full path of MARC21slimUtils.xsl, the record page uses the copy
ok a folder kbvtheme/en in the OPAC template directory appears as a choice for opacthemes
seen:
bootstrap
,
kbvtheme
ok opacthemes = the new theme: its own opac-main.tt is used
ok …every page it does not contain comes from the fallback (bootstrap): search still works
ok …but its home page links no opac.css: CSS is looked up in the theme folder only, so a theme without css/ is unstyled
ok …plack-opac-error.log: "File not found : css/opac.css at …/Koha/Template/Plugin/Asset.pm" (and js/basket.js, js/Gettext.js…)
seen: [2026/11/08 05:23:18] [WARN] File not found : css/opac.css at /kohadevbox/koha/Koha/Template/Plugin/Asset.pm line 107.
[2026/11/08 05:23:18] [WARN] File not found : css/print.css at /kohadevbox/koha/Koha/Template/Plugin/Asset.pm line 107.
[2026/11/08 05:23:18] [WARN] File not found : js/Gettext.js at /kohadevbox/koha/Koha/Template/Plugin/Asset.pm line 84.
[2026/11/08 05:23:18] [WARN] File not foun
ok with css, js and images linked to bootstrap's (ln -s ../bootstrap/css css …), the theme's page loads opac-tmpl/kbvtheme/css/opac_….css
seen: opac-tmpl/kbvtheme/css/opac_26.0502002.css
ok OpacPublic Disable: the OPAC home page asks to log in ("Log in to your account")
ok OpacMaintenance Show: every OPAC page shows "System maintenance" instead
ok logo: an OPACUserCSS rule on #logo replaces the Koha logo with your image
seen: url("https://cdn.example.org/our-logo.png") 200px
ok header: an opacheader HTML customization shows on every page (search results too), just under the top bar
seen: after-nav
ok links: an OpacMoreSearches entry adds a link to the row under the search box (#moresearches), on every page
ok home page: no left column (#navigation) while OpacNav and OpacNavBottom are empty
ok links: an OpacNavBottom entry shows in the left column of the home page
ok staff page: the Pages entry shows its title and the staff table at opac-page.pl?page_id=
ok left block: an OpacNav entry shows in the left column (#navigation), with its link to the staff page
seen:
ok left block: OpacNav does not print the entry's Title (write your own heading in Content)
ok right block: an OpacNavRight entry shows in the right column (#OpacNavRight), under the login box
seen: in right column
ok right block: OpacNavRight does not print the entry's Title either
ok the layout: three columns when left and right blocks are set (centre col-lg-7)
ok News and Pages Display location options read "Staff interface and OPAC", "Staff interface", "OPAC"
seen:
ok news: an item with location OPAC shows on the home page with "Published on"
ok news: it still shows on its Expiration date (hidden from the day after)
ok news: an item whose Publication date is in the future is not shown yet
ok news: newest Publication date first, whatever "Appear in position" says
seen: newer 18220, event 18941
ok news: an expired item still opens from its own link (opac-main.pl?news_id=), as the editor hint says
ok news: the editor hint reads "News will still be accessible by direct URL if expired."
ok news: the home page links an RSS feed (opac-news-rss.pl) that carries the items
ok QuoteOfTheDay is empty on a new Koha (no quote shown anywhere)
ok QuoteOfTheDay = OPAC: the home page shows "Quote of the day" with a quote
seen: What you do makes a difference, and you have to decide what kind of difference you want to make.
ok …the same quote all day: a second visit shows the same one
seen: What you do makes a difference, and you have to decide what kind of difference you want to make. / What you do makes a difference, and you have to decide what kind of difference you want to make.
ok …because showing it stamps that quote's Last display with today
ok …and the next day (no quote stamped today) Koha picks a new one at random by itself, no cron job
seen: My fellow Americans, ask not what your country can do for you; ask what you can do for your country.
ok the public report at /cgi-bin/koha/svc/report?id=…&annotated=1 returns the newest items as JSON (biblionumber, title, author, added)
seen: {"biblionumber":5327,"title":"Kbverify new arrival one","author":null,"added":"2026-11-08"}
ok …20 rows: the report's own LIMIT 20 decides how many
seen: 20
ok …without a LIMIT the service returns only 10 (SvcMaxReportRows, default 10)
seen: 10
ok STUCK: a book added after the first request does not appear (the JSON is cached for the report's 300 seconds)
seen: Kbverify new arrival one | Some boring read
ok OLD BOOKS: a deleted book is still in the slider until the cache expires
seen: Kbverify new arrival one | Some boring read
ok fix: with the cache cleared (or expired), the deleted book is gone and the new one is first
seen: Kbverify new arrival two | Some boring read
ok fix: with the report's cache expiry set low, a newly added book appears on its own within that time
seen: Kbverify new arrival three | Kbverify new arrival two
ok a withdrawn copy is left out by the report (withdrawn = 0)
ok the slider: the OPACUserJS code fills #new-arrivals with one link per book, newest first, in a scrolling row
seen: 20 cards, first "Kbverify new arrival three", flex auto
ok …each card links to the book's page
seen: /cgi-bin/koha/opac-detail.pl?biblionumber=5329
ok LibraryName is also the browser tab title: "Kbverify Library catalog"
seen: Kbverify Library catalog
ok with OpacFavicon empty, the tab icon is Koha's own favicon.ico
seen: /opac-tmpl/bootstrap/images/favicon.ico
ok OpacFavicon set to a full https:// address becomes the tab icon ()
seen: https://cdn.example.org/our-favicon.png
ok OPACShowLibraries (Show) puts a "Libraries" link in the menu (one library: "Contact")
seen: Libraries
ok the phone set in Administration → Libraries shows on the OPAC library page: "Phone: +1 555 0100"
seen: Phone: +1 555 0100
ok …and an HTML customization in OpacLibraryInfo for that library shows on the same page
ok …but not on another library's page
ok OpacAddMastheadLibraryPulldown (Add) adds a library drop-down to the search bar, first choice "All libraries"
seen: off 0, on 1, "All libraries"
ok Enhanced content → OpenLibraryCovers (Add) puts an Open Library cover box on a record with an ISBN
seen: off false, on true
ok a record with a 520 field shows "Summary:" on its OPAC page, with no cover or content service switched on
seen: biblio 8
ok …and the record page keeps its "MARC view" link (#MARCview), so a reader can still switch
ok BiblioDefaultView decides which page a search result opens: normal → opac-detail.pl, marc → opac-MARCdetail.pl, isbd → opac-ISBDdetail.pl
seen: /cgi-bin/koha/opac-detail.pl?biblionumber=58&query_desc=kw%2Cwrdl%3A%20history | /cgi-bin/koha/opac-MARCdetail.pl?biblionumber=58&query_desc=kw%2Cwrdl%3A%20history | /cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=58&query_desc=kw%2Cwrdl%3A%20history
ok an HTML customization in OpacCustomSearch replaces Koha's whole search bar (#searchform is gone, yours is there)
seen: yours 1, Koha's 0
ok an HTML customization in opaccredits shows at the bottom of every OPAC page (here a search results page)
seen: after main
ok Tools → HTML customizations, News and Pages appear only for staff with the tools permission edit_additional_contents
seen: without: none | with: HTML customizations,News,Pages
ok AdditionalContentsEditor is "tinymce" (the WYSIWYG editor) on a new install
ok …and the arrow next to "New entry" offers the other one: "New entry using text editor"
seen: New entry using text editor
ok the text editor is a code editor (CodeMirror) for the HTML itself
seen: 1
ok the OPAC includes call KohaPlugins.get_plugins_opac_head and get_plugins_opac_js
seen: 2
ok package install: bootstrap templates and the default XSLT belong to koha-common (an upgrade overwrites them)
seen: koha-common: /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/modules/opac-main.tt
koha-common: /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/xslt/MARC21slim2OPACDetail.xsl
dpkg-query: no path found matching pattern /usr/share/koha/opac/htdocs/opac-tmpl/mytheme
Version: 26.05.05-1
ok …and a theme folder of your own belongs to no package: "dpkg-query: no path found matching pattern …/mytheme"
seen: koha-common: /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/modules/opac-main.tt
koha-common: /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/xslt/MARC21slim2OPACDetail.xsl
dpkg-query: no path found matching pattern /usr/share/koha/opac/htdocs/opac-tmpl/mytheme
Version: 26.05.05-1
ok …on koha-common 26.05.05
seen: koha-common: /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/modules/opac-main.tt
koha-common: /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/xslt/MARC21slim2OPACDetail.xsl
dpkg-query: no path found matching pattern /usr/share/koha/opac/htdocs/opac-tmpl/mytheme
Version: 26.05.05-1
ok the article's theme commands, on a package install: the folder holds one template and three links to bootstrap
seen: total 4
lrwxrwxrwx 1 root root 16 Nov 8 05:25 css -> ../bootstrap/css
drwxr-xr-x 3 root root 4096 Nov 8 05:25 en
lrwxrwxrwx 1 root root 19 Nov 8 05:25 images -> ../bootstrap/images
lrwxrwxrwx 1 root root 15 Nov 8 05:25 js -> ../bootstrap/js
/usr/share/koha/opac/htdocs/opac-tmpl/mytheme/en/modules/opac-main.tt
---
10:
ok the article's XSLT commands: the copy now imports MARC21slimUtils.xsl by its full path
seen: total 4
lrwxrwxrwx 1 root root 16 Nov 8 05:25 css -> ../bootstrap/css
drwxr-xr-x 3 root root 4096 Nov 8 05:25 en
lrwxrwxrwx 1 root root 19 Nov 8 05:25 images -> ../bootstrap/images
lrwxrwxrwx 1 root root 15 Nov 8 05:25 js -> ../bootstrap/js
/usr/share/koha/opac/htdocs/opac-tmpl/mytheme/en/modules/opac-main.tt
---
10:
== The check that produced this log (scripts/kb/live/koha-opac-customization-guide.mjs) ==
/**
* Live check for prisma/ks-kb/99-koha-opac-customization-guide.ts (the OPAC customization pillar). On live Koha:
* the OPAC preferences the article names exist; LibraryName is the header's text over the Koha logo; the four Tools
* entries (News, HTML customizations, Pages, Record display customizations); a Pages entry served by
* opac-page.pl?page_id= (and a 404 when it is staff-only); a Record display customization appended to the record's
* page with Template Toolkit ([% record.title %]); a custom XSLT file named in OPACXSLTDetailsDisplay; a custom theme
* folder holding one template, falling back to bootstrap for the rest, and its missing CSS; OpacPublic and
* OpacMaintenance. The upgrade claims (which paths the koha-common package owns) run in a throwaway
* kbv-koha-ubuntu:24.04 box (koha-common 26.05.05). Undone: prefs, rows, files and the theme folder.
* Round 2 (2026-11-08, plan48): tab title, OpacFavicon, the Libraries page (phone + OpacLibraryInfo), the library
* pull-down, OpenLibraryCovers, 520 Summary, BiblioDefaultView links, OpacCustomSearch, opaccredits, the
* edit_additional_contents permission (a throwaway KBVOCSTAFF user) and the two editors.
*/
import { spawnSync } from 'node:child_process'
// The article shows these four exactly; the check runs them as they are.
export const NEW_ARRIVALS_SQL = `SELECT b.biblionumber, b.title, b.author, MAX(i.dateaccessioned) AS added
FROM items i
JOIN biblio b ON b.biblionumber = i.biblionumber
WHERE i.withdrawn = 0 AND i.itemlost = 0 AND i.dateaccessioned IS NOT NULL
GROUP BY b.biblionumber, b.title, b.author
ORDER BY added DESC, b.biblionumber DESC
LIMIT 20`
export const SLIDER_HTML = '
Thursday 3 December, 14:00, Main reading room. A one-hour session on finding journal articles. Free, no booking.
`
export const meta = { koha: '26.05.02', passed: '2026-11-08' }
const IMG = 'kbv-koha-ubuntu:24.04'
const HT = '/kohadevbox/koha/koha-tmpl/opac-tmpl'
const THEME = 'kbvtheme'
// a new name each run: Koha::XSLT::Base caches a stylesheet by file name in each Plack worker
const XSL = `/var/lib/koha/kohadev/kbv-detail-${Date.now()}.xsl`
export default async function run(ctx) {
const opac = (path) => ctx.sh(`curl -s -L '${ctx.OPAC}${path}'`).out
const bib = ctx.sqlValue('SELECT MIN(biblionumber) FROM biblio')
const ids = []
ctx.restore("delete this run's additional_contents rows", () => {
if (!ids.length) return
ctx.sql(`DELETE FROM additional_contents_localizations WHERE additional_content_id IN (${ids.join(',')})`)
ctx.sql(`DELETE FROM additional_contents WHERE id IN (${ids.join(',')})`)
ctx.flushCaches()
})
const add = (category, location, code, content) => {
ctx.sql(`INSERT INTO additional_contents (category, code, location, branchcode, published_on) VALUES ('${category}', '${code}', '${location}', NULL, CURDATE() - INTERVAL 1 DAY)`)
const id = ctx.sqlValue(`SELECT MAX(id) FROM additional_contents WHERE code = '${code}'`)
ids.push(id)
ctx.sql(`INSERT INTO additional_contents_localizations (additional_content_id, title, content, lang) VALUES (${id}, 'Kbverify ${code}', ${ctx.q(content)}, 'default')`)
ctx.flushCaches()
return id
}
// 1. The preferences the article names.
const names = ['LibraryName', 'OpacPublic', 'OpacMaintenance', 'opacthemes', 'OPACFallback', 'OPACUserCSS', 'OPACUserJS', 'OpacAdditionalStylesheet', 'opaclayoutstylesheet', 'OpacFavicon', 'OPACXSLTDetailsDisplay', 'OPACXSLTResultsDisplay', 'OPACXSLTListsDisplay', 'OPACShowLibraries', 'OpacAddMastheadLibraryPulldown', 'BiblioDefaultView', 'OPACAmazonCoverImages', 'GoogleJackets', 'OpenLibraryCovers', 'OPACLocalCoverImages', 'AdditionalContentsEditor']
const have = ctx.sql(`SELECT variable FROM systempreferences WHERE variable IN (${names.map((n) => `'${n}'`).join(',')})`).map((r) => r[0])
ctx.check(`the OPAC preferences named exist: ${names.join(', ')}`, names.every((n) => have.includes(n)), names.filter((n) => !have.includes(n)).join(', '))
const pref = ctx.sh('grep -c "^ [A-Z][A-Za-z ]*:$" /kohadevbox/koha/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/opac.pref').out
ctx.check('the OPAC tab of System preferences has 10 sections (Appearance, Features, … Authentication)', pref === '10', pref)
// 2. LibraryName is the header's text; the Koha logo is a CSS background.
ctx.setPref('LibraryName', 'Kbverify Library')
const b = await ctx.newPage()
await b.goto(`${ctx.OPAC}/cgi-bin/koha/opac-main.pl`)
const brand = (await b.locator('#logo a').innerText().catch(() => '')).trim()
const bg = await b.evaluate(() => getComputedStyle(document.querySelector('#logo')).backgroundImage)
ctx.check('LibraryName "Kbverify Library" is the text of the header link (#logo a)', brand === 'Kbverify Library', brand)
ctx.check('…and the logo you see is a CSS background on #logo (koha-green-logo.svg), so it is changed with CSS', /koha-green-logo/.test(bg), bg)
// 3. Tools → the four content tools.
const staff = await ctx.newPage()
await ctx.staffLogin(staff)
await staff.goto(`${ctx.STAFF}/cgi-bin/koha/tools/tools-home.pl`)
const tools = await ctx.pageText(staff)
const four = ['News', 'HTML customizations', 'Pages', 'Record display customizations']
ctx.check('Tools lists "News", "HTML customizations", "Pages" and "Record display customizations"', four.every((x) => tools.includes(x)), four.filter((x) => !tools.includes(x)).join(', '))
// 4. HTML customization: one block on the home page.
add('html_customizations', 'OpacMainUserBlock', 'KBV_MAIN', '
Kbverify main block
')
ctx.check('an HTML customization in OpacMainUserBlock shows on the OPAC home page', opac('/cgi-bin/koha/opac-main.pl').includes('Kbverify main block'))
// 5. Pages.
const page = add('pages', 'opac_only', 'KBV_PAGE', '
Kbverify opening hours page
')
ctx.check(`a Pages entry (OPAC only) is its own page at /cgi-bin/koha/opac-page.pl?page_id=${page}`, opac(`/cgi-bin/koha/opac-page.pl?page_id=${page}`).includes('Kbverify opening hours page'))
ctx.sql(`UPDATE additional_contents SET location = 'staff_only' WHERE id = ${page}`)
ctx.flushCaches()
const code = ctx.sh(`curl -s -o /dev/null -w '%{redirect_url}' '${ctx.OPAC}/cgi-bin/koha/opac-page.pl?page_id=${page}'`).out
ctx.check('…set to staff only, the OPAC link redirects to the 404 page', /errors\/404\.pl/.test(code), code)
// 6. Record display customization.
add('record_display', 'OPACDetailPage', 'KBV_REC', '
Kbverify note for [% record.title %]
')
const title = ctx.sqlValue(`SELECT title FROM biblio WHERE biblionumber = ${bib}`)
const det = opac(`/cgi-bin/koha/opac-detail.pl?biblionumber=${bib}`)
const shown = (det.match(/Kbverify note for ([^<]*)) ?? [])[1] ?? ''
ctx.check("a Record display customization at OPACDetailPage is added to the record's page, with [% record.title %] filled in", shown !== '' && title.startsWith(shown.trim().slice(0, 10)), `${shown} | title: ${title}`)
ctx.check('…and not to search results (that is OPACResultsPage)', !opac('/cgi-bin/koha/opac-search.pl?q=a').includes('Kbverify note for'))
// 7. XSLT: a copy of the default stylesheet, named in the preference.
const xslOld = ctx.sqlValue("SELECT value FROM systempreferences WHERE variable = 'OPACXSLTDetailsDisplay'")
ctx.check('OPACXSLTDetailsDisplay is "default" (the shipped stylesheet)', xslOld === 'default', xslOld)
ctx.sh(`cp ${HT}/bootstrap/en/xslt/MARC21slim2OPACDetail.xsl ${XSL} && sed -i '0,//s//Kbverify custom XSLT<\\/span>/' ${XSL} && chmod 644 ${XSL}`)
ctx.restore('remove the custom XSLT file', () => ctx.sh(`rm -f ${XSL}`))
ctx.setPref('OPACXSLTDetailsDisplay', XSL)
const logMark = Number(ctx.sh('wc -l < /var/log/koha/kohadev/plack-opac-error.log').out)
let d = opac(`/cgi-bin/koha/opac-detail.pl?biblionumber=${bib}`)
const err = ctx.sh(`tail -n +${logMark + 1} /var/log/koha/kohadev/plack-opac-error.log`).out
ctx.check(`a plain copy in another folder fails: plack-opac-error.log "xsl:import : unable to load ${XSL.replace(/kbv-detail-[0-9]+\.xsl$/, 'MARC21slimUtils.xsl')}"`, err.includes(`xsl:import : unable to load ${XSL.replace(/kbv-detail-[0-9]+\.xsl$/, 'MARC21slimUtils.xsl')}`), err.slice(0, 300))
ctx.check('…and the record page shows none of the copy (no record description at all)', !d.includes('Kbverify custom XSLT'))
ctx.sh(`sed -i 's###' ${XSL}`)
ctx.sh(`grep -n 'xsl:import' ${XSL}`)
d = opac(`/cgi-bin/koha/opac-detail.pl?biblionumber=${bib}`)
ctx.check('with the xsl:import changed to the full path of MARC21slimUtils.xsl, the record page uses the copy', d.includes('Kbverify custom XSLT'))
ctx.setPref('OPACXSLTDetailsDisplay', 'default')
// 8. A theme folder with one template.
ctx.sh(`mkdir -p ${HT}/${THEME}/en/modules && cp ${HT}/bootstrap/en/modules/opac-main.tt ${HT}/${THEME}/en/modules/ && sed -i '0,//s//
Kbverify theme<\\/p>/' ${HT}/${THEME}/en/modules/opac-main.tt && chown -R kohadev-koha: ${HT}/${THEME}`)
ctx.restore('remove the test theme folder', () => ctx.sh(`rm -rf ${HT}/${THEME}`))
await staff.goto(`${ctx.STAFF}/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=opacthemes`)
const opts = await staff.locator('select[name="pref_opacthemes"] option').allInnerTexts()
ctx.check(`a folder ${THEME}/en in the OPAC template directory appears as a choice for opacthemes`, opts.map((o) => o.trim()).includes(THEME), opts.join(', '))
ctx.setPref('OPACFallback', 'bootstrap')
ctx.setPref('opacthemes', THEME)
const themeMark = Number(ctx.sh('wc -l < /var/log/koha/kohadev/plack-opac-error.log').out)
const home = opac('/cgi-bin/koha/opac-main.pl')
ctx.check('opacthemes = the new theme: its own opac-main.tt is used', home.includes('id="kbv-theme"'))
ctx.check('…every page it does not contain comes from the fallback (bootstrap): search still works', opac('/cgi-bin/koha/opac-search.pl?q=a').includes('id="numresults"') || opac('/cgi-bin/koha/opac-search.pl?q=a').includes('results'))
ctx.check('…but its home page links no opac.css: CSS is looked up in the theme folder only, so a theme without css/ is unstyled', !/opac-tmpl\/[a-z]+\/css\/opac[_0-9]*\.css/.test(home), (home.match(/opac-tmpl\/[^"]*\.css/g) ?? []).join(' '))
const tlog = ctx.sh(`tail -n +${themeMark + 1} /var/log/koha/kohadev/plack-opac-error.log`).out
ctx.check('…plack-opac-error.log: "File not found : css/opac.css at …/Koha/Template/Plugin/Asset.pm" (and js/basket.js, js/Gettext.js…)', tlog.includes('File not found : css/opac.css') && tlog.includes('File not found : js/Gettext.js'), tlog.slice(0, 400))
ctx.sh(`cd ${HT}/${THEME} && ln -s ../bootstrap/css css && ln -s ../bootstrap/js js && ln -s ../bootstrap/images images`)
const fixed = opac('/cgi-bin/koha/opac-main.pl')
ctx.check(`with css, js and images linked to bootstrap's (ln -s ../bootstrap/css css …), the theme's page loads opac-tmpl/${THEME}/css/opac_….css`, new RegExp(`opac-tmpl/${THEME}/css/opac_[0-9.]+\\.css`).test(fixed) && fixed.includes('id="kbv-theme"'), (fixed.match(/opac-tmpl\/[^"]*opac[^"]*\.css/g) ?? []).join(' '))
ctx.setPref('opacthemes', 'bootstrap')
// 9. Private and maintenance.
ctx.setPref('OpacPublic', '0')
ctx.check('OpacPublic Disable: the OPAC home page asks to log in ("Log in to your account")', opac('/cgi-bin/koha/opac-main.pl').includes('Log in to your account'))
ctx.setPref('OpacPublic', '1')
ctx.setPref('OpacMaintenance', '1')
ctx.check('OpacMaintenance Show: every OPAC page shows "System maintenance" instead', opac('/cgi-bin/koha/opac-main.pl').includes('System maintenance') && opac(`/cgi-bin/koha/opac-detail.pl?biblionumber=${bib}`).includes('System maintenance'))
ctx.setPref('OpacMaintenance', '0')
// 9b. Logo, header and navigation links.
ctx.setPref('OPACUserCSS', '#logo { background-image: url("https://cdn.example.org/our-logo.png"); background-size: contain; width: 200px; } #logo a { width: 200px; padding-top: 50px; }')
await b.goto(`${ctx.OPAC}/cgi-bin/koha/opac-main.pl`)
const logo = await b.evaluate(() => { const s = getComputedStyle(document.querySelector('#logo')); return `${s.backgroundImage} ${s.width}` })
ctx.check('logo: an OPACUserCSS rule on #logo replaces the Koha logo with your image', logo.includes('https://cdn.example.org/our-logo.png') && logo.includes('200px'), logo)
ctx.setPref('OPACUserCSS', '')
add('html_customizations', 'opacheader', 'KBV_HEAD', '
Kbverify header strip
')
await b.goto(`${ctx.OPAC}/cgi-bin/koha/opac-search.pl?q=a`)
const headPos = await b.evaluate(() => { const h = document.querySelector('.kbv-head'); const n = document.querySelector('#header-region nav'); return h && n ? (n.compareDocumentPosition(h) & Node.DOCUMENT_POSITION_FOLLOWING ? 'after-nav' : 'before-nav') : 'missing' })
ctx.check('header: an opacheader HTML customization shows on every page (search results too), just under the top bar', headPos === 'after-nav', headPos)
add('html_customizations', 'OpacMoreSearches', 'KBV_MORE', '
')
await b.goto(`${ctx.OPAC}/cgi-bin/koha/opac-search.pl?q=a`)
ctx.check('links: an OpacMoreSearches entry adds a link to the row under the search box (#moresearches), on every page', (await b.locator('#moresearches a', { hasText: 'Kbverify opening hours' }).count()) === 1)
ctx.check('home page: no left column (#navigation) while OpacNav and OpacNavBottom are empty', !opac('/cgi-bin/koha/opac-main.pl').includes('id="navigation"'))
add('html_customizations', 'OpacNavBottom', 'KBV_NAVB', '
([\s\S]*?)<\/div>\s*<\/div>/) ?? [])[1] ?? ''
ctx.check('left block: an OpacNav entry shows in the left column (#navigation), with its link to the staff page', navDiv.includes('Quick links') && navDiv.includes(`opac-page.pl?page_id=${staffPage}`), navDiv.slice(0, 120))
ctx.check("left block: OpacNav does not print the entry's Title (write your own heading in Content)", !hp.includes('Kbverify left title'))
const right = hp.slice(hp.indexOf('col-12 col-lg-3 order-md-2'))
ctx.check('right block: an OpacNavRight entry shows in the right column (#OpacNavRight), under the login box', right.includes('id="OpacNavRight"') && right.includes('Mon-Fri') && right.indexOf('Mon-Fri') > right.indexOf('Log in to your account:'), right.includes('Mon-Fri') ? 'in right column' : 'missing')
ctx.check("right block: OpacNavRight does not print the entry's Title either", !hp.includes('Kbverify Opening hours'))
ctx.check('the layout: three columns when left and right blocks are set (centre col-lg-7)', hp.includes('col-12 col-lg-7 order-md-1 maincontent'))
const tt = ctx.sh('grep -o \'\' /kohadevbox/koha/koha-tmpl/intranet-tmpl/prog/en/modules/tools/additional-contents.tt | sort -u').out
ctx.check('News and Pages Display location options read "Staff interface and OPAC", "Staff interface", "OPAC"', ['>Staff interface and OPAC<', '>Staff interface<', '>OPAC<'].every((x) => tt.includes(x)), tt)
const evNow = full({ category: 'news', location: 'opac_only', code: 'KBV_EV_NOW', title: 'Kbverify Event today', content: EVENT_NEWS_HTML, pub: 3, exp: 0, number: 1 })
full({ category: 'news', location: 'opac_only', code: 'KBV_EV_NEW', title: 'Kbverify Newer news', content: '
', pub: -2 })
const np = opac('/cgi-bin/koha/opac-main.pl')
ctx.check('news: an item with location OPAC shows on the home page with "Published on"', np.includes('Kbverify Event today') && np.includes('Published on'))
ctx.check('news: it still shows on its Expiration date (hidden from the day after)', np.includes('Kbverify Event today') && !np.includes('Kbverify Event past'))
ctx.check('news: an item whose Publication date is in the future is not shown yet', !np.includes('Kbverify Event announced later'))
ctx.check('news: newest Publication date first, whatever "Appear in position" says', np.indexOf('Kbverify Newer news') > -1 && np.indexOf('Kbverify Newer news') < np.indexOf('Kbverify Event today'), `newer ${np.indexOf('Kbverify Newer news')}, event ${np.indexOf('Kbverify Event today')}`)
ctx.check('news: an expired item still opens from its own link (opac-main.pl?news_id=), as the editor hint says', opac(`/cgi-bin/koha/opac-main.pl?news_id=${evOld}`).includes('Kbverify past'))
ctx.check('news: the editor hint reads "News will still be accessible by direct URL if expired."', ctx.sh('grep -c "News will still be accessible by direct URL if expired." /kohadevbox/koha/koha-tmpl/intranet-tmpl/prog/en/modules/tools/additional-contents.tt').out.trim() === '1')
const rss = opac('/cgi-bin/koha/opac-news-rss.pl')
ctx.check('news: the home page links an RSS feed (opac-news-rss.pl) that carries the items', np.includes('opac-news-rss.pl') && rss.includes('Kbverify Event today'))
void evNow
// 9c. Quote of the day.
const qBefore = ctx.sql('SELECT id, COALESCE(timestamp, "NULL") FROM quotes')
ctx.restore('quotes: remove the test quotes and put back every Last display date', () => {
ctx.sql("DELETE FROM quotes WHERE source = 'Kbverify'")
for (const [id, ts] of qBefore) ctx.sql(`UPDATE quotes SET timestamp = ${ts === 'NULL' ? 'NULL' : `'${ts}'`} WHERE id = ${id}`)
})
ctx.sql("INSERT INTO quotes (source, text, timestamp) VALUES ('Kbverify', 'Kbverify quote one', NULL), ('Kbverify', 'Kbverify quote two', NULL)")
ctx.check('QuoteOfTheDay is empty on a new Koha (no quote shown anywhere)', ctx.sh("grep -E \"^\\('QuoteOfTheDay',\" /kohadevbox/koha/installer/data/mysql/mandatory/sysprefs.sql").out.includes("('QuoteOfTheDay','')"))
ctx.setPref('QuoteOfTheDay', 'opac')
const q1 = opac('/cgi-bin/koha/opac-main.pl')
const text1 = (q1.match(/id="daily-quote-text">([^<]*)) ?? [])[1] ?? ''
ctx.check('QuoteOfTheDay = OPAC: the home page shows "Quote of the day" with a quote', q1.includes('Quote of the day') && text1 !== '', text1)
const text2 = (opac('/cgi-bin/koha/opac-main.pl').match(/id="daily-quote-text">([^<]*)) ?? [])[1] ?? ''
ctx.check('…the same quote all day: a second visit shows the same one', text1 === text2, `${text1} / ${text2}`)
ctx.check("…because showing it stamps that quote's Last display with today", ctx.sqlValue(`SELECT DATE(timestamp) = CURDATE() FROM quotes WHERE text = ${ctx.q(text1)} ORDER BY timestamp DESC LIMIT 1`) === '1')
ctx.sql('UPDATE quotes SET timestamp = timestamp - INTERVAL 1 DAY WHERE DATE(timestamp) = CURDATE()')
const text3 = (opac('/cgi-bin/koha/opac-main.pl').match(/id="daily-quote-text">([^<]*)) ?? [])[1] ?? ''
ctx.check('…and the next day (no quote stamped today) Koha picks a new one at random by itself, no cron job', text3 !== '' && ctx.sqlValue('SELECT COUNT(*) FROM quotes WHERE DATE(timestamp) = CURDATE()') === '1', text3)
ctx.setPref('QuoteOfTheDay', '')
// 9d. New arrivals: a public report, read by OPACUserJS, and its cache.
const REPORT_SQL = NEW_ARRIVALS_SQL
ctx.sql(`INSERT INTO saved_sql (borrowernumber, date_created, last_modified, savedsql, report_name, cache_expiry, public) VALUES (51, NOW(), NOW(), ${ctx.q(REPORT_SQL)}, 'Kbverify new arrivals', 300, 1)`)
const rid = ctx.sqlValue("SELECT MAX(id) FROM saved_sql WHERE report_name = 'Kbverify new arrivals'")
ctx.restore('remove the test report', () => ctx.sql(`DELETE FROM saved_sql WHERE id = ${rid}`))
const perl = (code) => { ctx.sh(`cat > /tmp/kbv-oc.pl <<'PL'\n${code}\nPL\nchmod 644 /tmp/kbv-oc.pl`); return ctx.sh(`koha-shell ${ctx.INSTANCE} -c "perl /tmp/kbv-oc.pl" 2>&1; rm -f /tmp/kbv-oc.pl`).out.trim().split('\n').pop() }
const today = ctx.sqlValue('SELECT CURDATE()')
const newBib = (t) => Number(perl(`use C4::Biblio qw(AddBiblio); use MARC::Record; use Koha::Item; my $r = MARC::Record->new; $r->leader(' nam a22 7a 4500'); $r->append_fields(MARC::Field->new('245','1','0','a'=>'${t}')); my ($bn) = AddBiblio($r, ''); Koha::Item->new({ biblionumber => $bn, homebranch => 'CPL', holdingbranch => 'CPL', itype => 'BK', dateaccessioned => '${today}' })->store; print "$bn\\n";`))
const delBib = (bn) => perl(`use C4::Biblio qw(DelBiblio); use Koha::Biblios; my $b = Koha::Biblios->find(${bn}); $_->safe_delete for $b ? $b->items->as_list : (); DelBiblio(${bn}); print "ok\\n";`)
const made = []
ctx.restore('remove the new-arrival test records', () => { for (const bn of made) { delBib(bn); ctx.sql(`DELETE FROM deleteditems WHERE biblionumber = ${bn}`); ctx.sql(`DELETE FROM deletedbiblio_metadata WHERE biblionumber = ${bn}`); ctx.sql(`DELETE FROM deletedbiblioitems WHERE biblionumber = ${bn}`); ctx.sql(`DELETE FROM deletedbiblio WHERE biblionumber = ${bn}`) } })
const svc = () => JSON.parse(ctx.sh(`curl -s '${ctx.OPAC}/cgi-bin/koha/svc/report?id=${rid}&annotated=1'`).out || '[]')
const one = newBib('Kbverify new arrival one'); made.push(one)
ctx.flushCaches()
let rows = svc()
ctx.check('the public report at /cgi-bin/koha/svc/report?id=…&annotated=1 returns the newest items as JSON (biblionumber, title, author, added)', rows[0]?.title === 'Kbverify new arrival one' && 'biblionumber' in rows[0] && 'added' in rows[0], JSON.stringify(rows[0]))
ctx.check("…20 rows: the report's own LIMIT 20 decides how many", rows.length === 20, rows.length)
ctx.sql(`UPDATE saved_sql SET savedsql = ${ctx.q(REPORT_SQL.replace(/\nLIMIT 20$/, ''))} WHERE id = ${rid}`)
ctx.flushCaches()
const noLimit = svc().length
ctx.sql(`UPDATE saved_sql SET savedsql = ${ctx.q(REPORT_SQL)} WHERE id = ${rid}`)
ctx.flushCaches()
rows = svc()
ctx.check('…without a LIMIT the service returns only 10 (SvcMaxReportRows, default 10)', noLimit === 10, noLimit)
const two = newBib('Kbverify new arrival two'); made.push(two)
rows = svc()
ctx.check('STUCK: a book added after the first request does not appear (the JSON is cached for the report\'s 300 seconds)', !rows.some((r) => r.title === 'Kbverify new arrival two'), rows.slice(0, 2).map((r) => r.title).join(' | '))
delBib(one)
rows = svc()
ctx.check('OLD BOOKS: a deleted book is still in the slider until the cache expires', rows.some((r) => r.title === 'Kbverify new arrival one'), rows.slice(0, 2).map((r) => r.title).join(' | '))
ctx.sql(`UPDATE saved_sql SET cache_expiry = 1 WHERE id = ${rid}`)
ctx.flushCaches()
rows = svc()
ctx.check('fix: with the cache cleared (or expired), the deleted book is gone and the new one is first', rows[0]?.title === 'Kbverify new arrival two' && !rows.some((r) => r.title === 'Kbverify new arrival one'), rows.slice(0, 2).map((r) => r.title).join(' | '))
const three = newBib('Kbverify new arrival three'); made.push(three)
await new Promise((r) => setTimeout(r, 2500))
rows = svc()
ctx.check('fix: with the report\'s cache expiry set low, a newly added book appears on its own within that time', rows[0]?.title === 'Kbverify new arrival three', rows.slice(0, 2).map((r) => r.title).join(' | '))
ctx.check('a withdrawn copy is left out by the report (withdrawn = 0)', (() => { ctx.sql(`UPDATE items SET withdrawn = 1 WHERE biblionumber = ${three}`); ctx.flushCaches(); const r = svc(); ctx.sql(`UPDATE items SET withdrawn = 0 WHERE biblionumber = ${three}`); return !r.some((x) => x.title === 'Kbverify new arrival three') })())
ctx.flushCaches()
add('html_customizations', 'OpacMainUserBlock', 'KBV_SLIDER', SLIDER_HTML)
ctx.setPref('OPACUserCSS', SLIDER_CSS)
ctx.setPref('OPACUserJS', SLIDER_JS.replace('REPORT_ID', rid))
await b.goto(`${ctx.OPAC}/cgi-bin/koha/opac-main.pl`)
await b.waitForSelector('#new-arrivals a', { timeout: 15000 }).catch(() => {})
const cards = await b.locator('#new-arrivals a').allInnerTexts()
const flex = await b.evaluate(() => { const e = document.querySelector('#new-arrivals'); return e ? `${getComputedStyle(e).display} ${getComputedStyle(e).overflowX}` : '' })
ctx.check('the slider: the OPACUserJS code fills #new-arrivals with one link per book, newest first, in a scrolling row', cards.length === 20 && cards[0].includes('Kbverify new arrival three') && flex === 'flex auto', `${cards.length} cards, first "${cards[0]}", ${flex}`)
const href = await b.locator('#new-arrivals a').first().getAttribute('href')
ctx.check("…each card links to the book's page", href === `/cgi-bin/koha/opac-detail.pl?biblionumber=${three}`, href)
ctx.setPref('OPACUserJS', '')
ctx.setPref('OPACUserCSS', '')
// 9e. Round 2 (owner 2026-11-08): the library's identity.
ctx.setPref('LibraryName', 'Kbverify Library')
await b.goto(`${ctx.OPAC}/cgi-bin/koha/opac-main.pl`)
const tabTitle = await b.title()
ctx.check('LibraryName is also the browser tab title: "Kbverify Library catalog"', tabTitle.includes('Kbverify Library catalog'), tabTitle)
const favDefault = await b.locator('link[rel="shortcut icon"]').getAttribute('href')
ctx.check('with OpacFavicon empty, the tab icon is Koha\'s own favicon.ico', /\/bootstrap\/images\/favicon\.ico$/.test(favDefault ?? ''), favDefault)
ctx.setPref('OpacFavicon', 'https://cdn.example.org/our-favicon.png')
await b.goto(`${ctx.OPAC}/cgi-bin/koha/opac-main.pl`)
const fav = await b.locator('link[rel="shortcut icon"]').getAttribute('href')
ctx.check('OpacFavicon set to a full https:// address becomes the tab icon ()', fav === 'https://cdn.example.org/our-favicon.png', fav)
const libLink = (await b.locator('#library_page').innerText().catch(() => '')).trim()
ctx.check('OPACShowLibraries (Show) puts a "Libraries" link in the menu (one library: "Contact")', libLink === 'Libraries', libLink)
const cplOld = ctx.sql("SELECT COALESCE(branchphone,'NULL'), COALESCE(branchemail,'NULL') FROM branches WHERE branchcode = 'CPL'")[0]
ctx.restore('put back Centerville\'s phone and email', () => ctx.sql(`UPDATE branches SET branchphone = ${cplOld[0] === 'NULL' ? 'NULL' : ctx.q(cplOld[0])}, branchemail = ${cplOld[1] === 'NULL' ? 'NULL' : ctx.q(cplOld[1])} WHERE branchcode = 'CPL'`))
ctx.sql("UPDATE branches SET branchphone = '+1 555 0100' WHERE branchcode = 'CPL'")
const infoId = add('html_customizations', 'OpacLibraryInfo', 'KBV_LIBINFO', '