Disable default cover images

config/vufind/config.ini

@@ -1066,8 +1066,8 @@ verify_server_certificate = false
 ;coversize = false
 
 ; You can select Syndetics, LibraryThing, Summon, Booksite, OpenLibrary,
-; Contentcafe, Buchhandel.de, Google, BrowZine, ObalkyKnih, Orb, Koha and/or
-; LocalFile. Service-specific notes:
+; Contentcafe, Buchhandel.de, Google, BrowZine, ObalkyKnih, Orb, Koha, Demo,
+; and/or LocalFile. Service-specific notes:
 ;   - BrowZine requires you to have BrowZine.ini configured appropriately.
 ;   - Google Books caching behavior can be customized in the [Cache_GoogleCover]
 ;       section.
@@ -1076,6 +1076,10 @@ verify_server_certificate = false
 ;       OPACLocalCoverImages system preferences must be turned on and local cover
 ;       images uploaded to the Koha system. Koha emits only two sizes of cover
 ;       images, so small and medium are treated the same in VuFind.
+;   - Demo should only be used for testing. It will return an image with filename
+;       "demo-cover-*" from the themes or no image. This is evenly distributed based on
+;       the checksum of the record's parameters like id, isbn etc. Use Demo:true to activate
+;       backlink functionality when ajaxcovers are active.
 ;   - LocalFile:PathToFile supports a combination of directory path information
 ;       and tokens for filename and image type. If you have multiple directories
 ;       in which you have stored coverimages, you can specify multiple paths to search
@@ -1155,6 +1159,7 @@ coverproxyAllowedTypes[] = "image/png"
 
 ; Otherwise, you can use noCoverAvailableImage to specify a
 ; path relative to the base of your theme directory for a static image to display.
+; If set to "false", no image will be displayed for unavailable covers.
 noCoverAvailableImage = images/noCover2.gif
 
 ; You can select from Syndetics, SyndeticsPlus, Booksite and/or the Guardian
@@ -1317,7 +1322,8 @@ url = "https://api.vlb.de/api/v1/cover/"
 
 [QRCode]
 ; This setting controls the image to display when no qrcode is available.
-; The path is relative to the base of your theme directory.
+; The path is relative to the base of your theme directory. Default is
+; "images/noQRCode.gif".
 ;noQRCodeAvailableImage = images/noQRCode.gif
 
 ; Should we show QR codes in search results?

module/VuFind/src/VuFind/Content/Covers/Demo.php

@@ -0,0 +1,139 @@
+<?php
+
+/**
+ * Demo cover content loader.
+ *
+ * PHP version 8
+ *
+ * Copyright (C) Hebis Verbundzentrale 2024.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program 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 this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * @category VuFind
+ * @package  Content
+ * @author   Thomas Wagener <[email protected]>
+ * @author   Demian Katz <[email protected]>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org/wiki/development Wiki
+ */
+
+namespace VuFind\Content\Covers;
+
+use VuFindTheme\ThemeInfo;
+
+use function count;
+
+/**
+ * Demo cover content loader.
+ *
+ * @category VuFind
+ * @package  Content
+ * @author   Thomas Wagener <[email protected]>
+ * @author   Demian Katz <[email protected]>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org/wiki/development Wiki
+ */
+class Demo extends \VuFind\Content\AbstractCover
+{
+    /**
+     * Constructor
+     *
+     * @param ThemeInfo $themeInfo Theme info
+     * @param string    $baseUrl   VuFind's base URL
+     */
+    public function __construct(protected ThemeInfo $themeInfo, protected string $baseUrl)
+    {
+        $this->directUrls = true;
+        $this->mandatoryBacklinkLocations = ['core'];
+    }
+
+    /**
+     * Does this plugin support the provided ID array?
+     *
+     * @param array $ids IDs that will later be sent to load() -- see below.
+     *
+     * @return bool
+     */
+    public function supports($ids)
+    {
+        // We won't know what we need until we parse the path string; accept
+        // everything at this stage:
+        return true;
+    }
+
+    /**
+     * Get image location from local file storage.
+     *
+     * @param string $key  If backlink functionality should be used
+     * @param string $size Size of image to load (small/medium/large)
+     * @param array  $ids  Associative array of identifiers (keys may include 'isbn'
+     * pointing to an ISBN object and 'issn' pointing to a string)
+     *
+     * @return string|bool
+     */
+    public function getUrl($key, $size, $ids)
+    {
+        $cover = $this->getCover($ids);
+        if ($path = $cover['file'] ?? null) {
+            return 'file://' . $path;
+        }
+        return false;
+    }
+
+    /**
+     * Get cover metadata for a particular API key and set of IDs (or empty array).
+     *
+     * @param ?string $key  If backlink functionality should be used
+     * @param string  $size Size of image to load (small/medium/large)
+     * @param array   $ids  Associative array of identifiers (keys may include 'isbn'
+     * pointing to an ISBN object, 'issn' pointing to a string and 'oclc' pointing
+     * to an OCLC number string)
+     *
+     * @return array Array with keys: url, backlink_url, backlink_text
+     */
+    public function getMetadata(?string $key, string $size, array $ids)
+    {
+        $cover = $this->getCover($ids);
+        $path = $cover['relativeFile'] ?? null;
+        if (empty($path)) {
+            return [];
+        }
+        $res = [
+            'url' => $this->baseUrl . 'themes/' . $cover['theme'] . '/' . $path,
+        ];
+        if ($key === 'true') {
+            $res['backlink_url'] = 'https://vufind.org';
+            $res['backlink_text'] = 'vufind.org';
+        }
+        return $res;
+    }
+
+    /**
+     * Selects demo covers or no cover based on the $ids array and returns location information.
+     *
+     * @param array $ids Associative array of identifiers (keys may include 'isbn'
+     *                   pointing to an ISBN object and 'issn' pointing to a
+     *                   string)
+     *
+     * @return string|bool
+     */
+    protected function getCover($ids)
+    {
+        $covers = $this->themeInfo->findInThemes('images/demo-cover-*');
+        // selects either one of the available demo covers or no image
+        // evenly distributed based on the checksum of the ids.
+        $coverNum = crc32(serialize($ids)) % (count($covers) + 1);
+        return $covers[$coverNum];
+    }
+}

module/VuFind/src/VuFind/Content/Covers/DemoFactory.php

@@ -0,0 +1,77 @@
+<?php
+
+/**
+ * Demo cover loader factory
+ *
+ * PHP version 8
+ *
+ * Copyright (C) Hebis Verbundzentrale 2024.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program 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 this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * @category VuFind
+ * @package  Content
+ * @author   Thomas Wagener <[email protected]>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org/wiki/development:plugins:record_drivers Wiki
+ */
+
+namespace VuFind\Content\Covers;
+
+use Laminas\ServiceManager\Exception\ServiceNotCreatedException;
+use Laminas\ServiceManager\Exception\ServiceNotFoundException;
+use Psr\Container\ContainerExceptionInterface as ContainerException;
+use Psr\Container\ContainerInterface;
+
+/**
+ * Demo cover loader factory
+ *
+ * @category VuFind
+ * @package  Content
+ * @author   Thomas Wagener <[email protected]>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org/wiki/development:plugins:record_drivers Wiki
+ */
+class DemoFactory implements \Laminas\ServiceManager\Factory\FactoryInterface
+{
+    /**
+     * Create an object
+     *
+     * @param ContainerInterface $container     Service manager
+     * @param string             $requestedName Service being created
+     * @param null|array         $options       Extra options (optional)
+     *
+     * @return object
+     *
+     * @throws ServiceNotFoundException if unable to resolve the service.
+     * @throws ServiceNotCreatedException if an exception is raised when
+     * creating a service.
+     * @throws ContainerException&\Throwable if any other error occurs
+     *
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function __invoke(
+        ContainerInterface $container,
+        $requestedName,
+        array $options = null
+    ) {
+        if (!empty($options)) {
+            throw new \Exception('Unexpected options passed to factory.');
+        }
+        $helpers = $container->get('ViewHelperManager');
+        $basePath = ($helpers->get('url'))('home');
+        $baseUrl = ($helpers->get('serverurl'))($basePath);
+        return new $requestedName($container->get(\VuFindTheme\ThemeInfo::class), $baseUrl);
+    }
+}

module/VuFind/src/VuFind/Content/Covers/PluginManager.php

@@ -56,6 +56,7 @@ class PluginManager extends \VuFind\ServiceManager\AbstractPluginManager
         'buchhandel' => Buchhandel::class,
         'browzine' => BrowZine::class,
         'contentcafe' => ContentCafe::class,
+        'demo' => Demo::class,
         'google' => Google::class,
         'koha' => Koha::class,
         'librarything' => LibraryThing::class,
@@ -79,6 +80,7 @@ class PluginManager extends \VuFind\ServiceManager\AbstractPluginManager
         BrowZine::class => BrowZineFactory::class,
         Buchhandel::class => BuchhandelFactory::class,
         ContentCafe::class => ContentCafeFactory::class,
+        Demo::class => DemoFactory::class,
         Deprecated::class => InvokableFactory::class,
         Google::class => GoogleFactory::class,
         Koha::class => KohaFactory::class,

module/VuFind/src/VuFind/Exception/NotFound.php

@@ -0,0 +1,52 @@
+<?php
+
+/**
+ * "Not Found" Exception
+ *
+ * PHP version 8
+ *
+ * Copyright (C) Hebis Verbundzentrale 2024.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program 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 this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * @category VuFind
+ * @package  Exceptions
+ * @author   Thomas Wagener <[email protected]>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org/wiki/development Wiki
+ */
+
+namespace VuFind\Exception;
+
+/**
+ * "Not Found" Exception
+ *
+ * @category VuFind
+ * @package  Exceptions
+ * @author   Thomas Wagener <[email protected]>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org/wiki/development Wiki
+ */
+class NotFound extends \Exception implements HttpStatusInterface
+{
+    /**
+     * Get HTTP status associated with this exception.
+     *
+     * @return int
+     */
+    public function getHttpStatus()
+    {
+        return 404;
+    }
+}

module/VuFind/src/VuFind/Exception/RecordMissing.php

@@ -38,20 +38,8 @@
  * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
  * @link     https://vufind.org/wiki/development Wiki
  */
-class RecordMissing extends \Exception implements
-    HttpStatusInterface,
-    SeverityLevelInterface
+class RecordMissing extends NotFound implements SeverityLevelInterface
 {
-    /**
-     * Get HTTP status associated with this exception.
-     *
-     * @return int
-     */
-    public function getHttpStatus()
-    {
-        return 404;
-    }
-
     /**
      * Get the logging severity level for this exception.
      *

module/VuFind/src/VuFind/ImageLoader.php

@@ -70,7 +70,7 @@ class ImageLoader implements \Laminas\Log\LoggerAwareInterface
     /**
      * User-configured image to load from theme on error.
      *
-     * @var string
+     * @var ?string
      */
     protected $configuredFailImage = null;
 
@@ -79,7 +79,7 @@ class ImageLoader implements \Laminas\Log\LoggerAwareInterface
      *
      * @var string
      */
-    protected $defaultFailImage = 'images/noCover2.gif';
+    protected $defaultFailImage = 'images/hidden-image.gif';
 
     /**
      * Array containing map of allowed file extensions to mimetypes