Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 36
0.00% covered (danger)
0.00%
0 / 1
CRAP
0.00% covered (danger)
0.00%
0 / 1
ReCaptchaFactory
0.00% covered (danger)
0.00%
0 / 36
0.00% covered (danger)
0.00%
0 / 1
42
0.00% covered (danger)
0.00%
0 / 1
 __invoke
0.00% covered (danger)
0.00%
0 / 36
0.00% covered (danger)
0.00%
0 / 1
42
1<?php
2
3/**
4 * ReCaptcha factory.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2018.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2,
12 * as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 *
23 * @category VuFind
24 * @package  Service
25 * @author   Demian Katz <demian.katz@villanova.edu>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org/wiki/development Wiki
28 */
29
30namespace VuFind\Service;
31
32use Laminas\ServiceManager\Exception\ServiceNotCreatedException;
33use Laminas\ServiceManager\Exception\ServiceNotFoundException;
34use Laminas\ServiceManager\Factory\FactoryInterface;
35use Psr\Container\ContainerExceptionInterface as ContainerException;
36use Psr\Container\ContainerInterface;
37use VuFind\I18n\Locale\LocaleSettings;
38
39/**
40 * ReCaptcha factory.
41 *
42 * @category VuFind
43 * @package  Service
44 * @author   Demian Katz <demian.katz@villanova.edu>
45 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
46 * @link     https://vufind.org/wiki/development Wiki
47 */
48class ReCaptchaFactory implements FactoryInterface
49{
50    /**
51     * Create an object
52     *
53     * @param ContainerInterface $container     Service manager
54     * @param string             $requestedName Service being created
55     * @param null|array         $options       Extra options (optional)
56     *
57     * @return object
58     *
59     * @throws ServiceNotFoundException if unable to resolve the service.
60     * @throws ServiceNotCreatedException if an exception is raised when
61     * creating a service.
62     * @throws ContainerException&\Throwable if any other error occurs
63     */
64    public function __invoke(
65        ContainerInterface $container,
66        $requestedName,
67        array $options = null
68    ) {
69        if (!empty($options)) {
70            throw new \Exception('Unexpected options passed to factory.');
71        }
72
73        $config = $container->get(\VuFind\Config\PluginManager::class)
74            ->get('config');
75
76        $legacySettingsMap = [
77            'publicKey' => 'recaptcha_siteKey',
78            'siteKey' => 'recaptcha_siteKey',
79            'privateKey' => 'recaptcha_secretKey',
80            'secretKey' => 'recaptcha_secretKey',
81            'theme' => 'recaptcha_theme',
82        ];
83
84        $recaptchaConfig = $config->Captcha->toArray();
85        foreach ($legacySettingsMap as $old => $new) {
86            if (isset($recaptchaConfig[$old])) {
87                error_log(
88                    'Deprecated ' . $old . ' setting found in config.ini - '
89                    . 'please use ' . $new . ' instead.'
90                );
91                if (!isset($recaptchaConfig[$new])) {
92                    $recaptchaConfig[$new] = $recaptchaConfig[$old];
93                }
94            }
95        }
96
97        $siteKey = $recaptchaConfig['recaptcha_siteKey'] ?? '';
98        $secretKey = $recaptchaConfig['recaptcha_secretKey'] ?? '';
99        $httpClient = $container->get(\VuFindHttp\HttpService::class)
100            ->createClient();
101        $language = $container->get(LocaleSettings::class)->getUserLocale();
102        $rcOptions = ['lang' => $language];
103        if (isset($recaptchaConfig['recaptcha_theme'])) {
104            $rcOptions['theme'] = $recaptchaConfig['recaptcha_theme'];
105        }
106        return new $requestedName(
107            $siteKey,
108            $secretKey,
109            ['ssl' => true],
110            $rcOptions,
111            null,
112            $httpClient
113        );
114    }
115}