Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
53.85% |
7 / 13 |
CRAP | |
83.05% |
49 / 59 |
| VuFindHarvest\OaiPmh\HarvesterFactory | |
0.00% |
0 / 1 |
|
53.85% |
7 / 13 |
40.96 | |
83.05% |
49 / 59 |
| addAutoSslOptions | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 5 |
|||
| getClientOptions | |
0.00% |
0 / 1 |
7.07 | |
88.89% |
8 / 9 |
|||
| configureClient | |
0.00% |
0 / 1 |
4.13 | |
80.00% |
4 / 5 |
|||
| getBasePath | |
0.00% |
0 / 1 |
3.07 | |
80.00% |
4 / 5 |
|||
| getCommunicator | |
0.00% |
0 / 1 |
5.07 | |
85.71% |
6 / 7 |
|||
| getFormatter | |
0.00% |
0 / 1 |
3.03 | |
85.71% |
6 / 7 |
|||
| getConsoleWriter | |
100.00% |
1 / 1 |
3 | |
100.00% |
2 / 2 |
|||
| getResponseProcessor | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| getSetLoader | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| getStateManager | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| getWriter | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| getWriterStrategyFactory | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| getHarvester | |
100.00% |
1 / 1 |
2 | |
100.00% |
14 / 14 |
|||
| <?php | |
| /** | |
| * Factory for OAI-PMH Harvest Tool | |
| * | |
| * PHP version 7 | |
| * | |
| * Copyright (c) Demian Katz 2010. | |
| * | |
| * 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 Harvest_Tools | |
| * @author Demian Katz <demian.katz@villanova.edu> | |
| * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License | |
| * @link https://vufind.org/wiki/indexing:oai-pmh Wiki | |
| */ | |
| namespace VuFindHarvest\OaiPmh; | |
| use Laminas\Http\Client; | |
| use VuFindHarvest\ConsoleOutput\ConsoleWriter; | |
| use VuFindHarvest\RecordWriterStrategy\RecordWriterStrategyFactory; | |
| use VuFindHarvest\RecordWriterStrategy\RecordWriterStrategyInterface; | |
| use VuFindHarvest\ResponseProcessor\ResponseProcessorInterface; | |
| use VuFindHarvest\ResponseProcessor\SimpleXmlResponseProcessor; | |
| /** | |
| * Factory for OAI-PMH Harvest Tool | |
| * | |
| * @category VuFind | |
| * @package Harvest_Tools | |
| * @author Demian Katz <demian.katz@villanova.edu> | |
| * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License | |
| * @link https://vufind.org/wiki/indexing:oai-pmh Wiki | |
| */ | |
| class HarvesterFactory | |
| { | |
| /** | |
| * Add SSL options to $options if standard files can be autodetected. | |
| * | |
| * @param array $options Options to modify. | |
| * | |
| * @return void | |
| */ | |
| protected function addAutoSslOptions(& $options) | |
| { | |
| // RedHat/CentOS: | |
| if (file_exists('/etc/pki/tls/cert.pem')) { | |
| $options['sslcafile'] = '/etc/pki/tls/cert.pem'; | |
| } | |
| // Debian/Ubuntu: | |
| if (file_exists('/etc/ssl/certs')) { | |
| $options['sslcapath'] = '/etc/ssl/certs'; | |
| } | |
| } | |
| /** | |
| * Get HTTP client options from $settings array | |
| * | |
| * @param array $settings Settings | |
| * | |
| * @return array | |
| */ | |
| protected function getClientOptions(array $settings) | |
| { | |
| $options = [ | |
| 'timeout' => $settings['timeout'] ?? 60, | |
| ]; | |
| if (isset($settings['autosslca']) && $settings['autosslca']) { | |
| $this->addAutoSslOptions($options); | |
| } | |
| foreach (['sslcafile', 'sslcapath'] as $sslSetting) { | |
| if (isset($settings[$sslSetting])) { | |
| $options[$sslSetting] = $settings[$sslSetting]; | |
| } | |
| } | |
| if (isset($settings['sslverifypeer']) && !$settings['sslverifypeer']) { | |
| $options['sslverifypeer'] = false; | |
| } | |
| return $options; | |
| } | |
| /** | |
| * Configure the HTTP client | |
| * | |
| * @param Client $client HTTP client | |
| * @param array $settings Settings | |
| * | |
| * @return Client | |
| * | |
| * @throws Exception | |
| */ | |
| protected function configureClient(Client $client, array $settings) | |
| { | |
| $configuredClient = $client ?: new Client(); | |
| // Set authentication, if necessary: | |
| if (!empty($settings['httpUser']) && !empty($settings['httpPass'])) { | |
| $configuredClient->setAuth($settings['httpUser'], $settings['httpPass']); | |
| } | |
| // Set up assorted client options from $settings array: | |
| $configuredClient->setOptions($this->getClientOptions($settings)); | |
| return $configuredClient; | |
| } | |
| /** | |
| * Set up directory structure for harvesting. | |
| * | |
| * @param string $harvestRoot Root directory containing harvested data. | |
| * @param string $target The OAI-PMH target directory to create inside | |
| * $harvestRoot. | |
| * | |
| * @return string | |
| */ | |
| protected function getBasePath($harvestRoot, $target) | |
| { | |
| // Build the full harvest path: | |
| $basePath = rtrim($harvestRoot, '/') . '/' . rtrim($target, '/') . '/'; | |
| // Create the directory if it does not already exist: | |
| if (!is_dir($basePath)) { | |
| if (!mkdir($basePath)) { | |
| throw new \Exception("Problem creating directory {$basePath}."); | |
| } | |
| } | |
| return $basePath; | |
| } | |
| /** | |
| * Get the communicator. | |
| * | |
| * @param Client $client HTTP client | |
| * @param array $settings Additional settings | |
| * @param ResponseProcessorInterface $processor Response processor | |
| * @param string $target Target being configured (used for | |
| * error messages) | |
| * | |
| * @return Communicator | |
| */ | |
| protected function getCommunicator(Client $client, array $settings, | |
| ResponseProcessorInterface $processor, $target | |
| ) { | |
| if (empty($settings['url'])) { | |
| throw new \Exception("Missing base URL for {$target}."); | |
| } | |
| $comm = new Communicator($settings['url'], $client, $processor); | |
| // We only want the communicator to output messages if we are in verbose | |
| // mode; communicator messages are considered verbose output. | |
| if (isset($settings['verbose']) && $settings['verbose'] | |
| && $writer = $this->getConsoleWriter($settings) | |
| ) { | |
| $comm->setOutputWriter($writer); | |
| } | |
| return $comm; | |
| } | |
| /** | |
| * Get the record XML formatter. | |
| * | |
| * @param Communicator $communicator Communicator | |
| * @param array $settings Additional settings | |
| * | |
| * @return RecordXmlFormatter | |
| */ | |
| protected function getFormatter(Communicator $communicator, array $settings) | |
| { | |
| // Build the formatter: | |
| $formatter = new RecordXmlFormatter($settings); | |
| // Load set names if we're going to need them: | |
| if ($formatter->needsSetNames()) { | |
| $loader = $this->getSetLoader($communicator, $settings); | |
| if ($writer = $this->getConsoleWriter($settings)) { | |
| $loader->setOutputWriter($writer); | |
| } | |
| $formatter->setSetNames($loader->getNames()); | |
| } | |
| return $formatter; | |
| } | |
| /** | |
| * Get console output writer (if applicable). | |
| * | |
| * @param array $settings OAI-PMH settings | |
| * | |
| * @return ConsoleWriter | |
| */ | |
| protected function getConsoleWriter($settings) | |
| { | |
| // Don't create a writer if we're in silent mode. | |
| return isset($settings['silent']) && $settings['silent'] | |
| ? null : new ConsoleWriter(); | |
| } | |
| /** | |
| * Get XML response processor. | |
| * | |
| * @param string $basePath Base path for harvest | |
| * @param array $settings OAI-PMH settings | |
| * | |
| * @return SimpleXmlResponseProcessor | |
| */ | |
| protected function getResponseProcessor($basePath, array $settings) | |
| { | |
| return new SimpleXmlResponseProcessor($basePath, $settings); | |
| } | |
| /** | |
| * Get the set loader (used to load set names). | |
| * | |
| * @param Communicator $communicator API communicator | |
| * @param array $settings OAI-PMH settings | |
| * | |
| * @return SetLoader | |
| */ | |
| protected function getSetLoader(Communicator $communicator, array $settings) | |
| { | |
| return new SetLoader($communicator, $settings); | |
| } | |
| /** | |
| * Get state manager | |
| * | |
| * @param string $basePath Base path for harvest | |
| * | |
| * @return StateManager | |
| */ | |
| protected function getStateManager($basePath) | |
| { | |
| return new StateManager($basePath); | |
| } | |
| /** | |
| * Build the writer support object. | |
| * | |
| * @param RecordWriterStrategyInterface $strategy Writing strategy | |
| * @param RecordXmlFormatter $formatter XML record formatter | |
| * @param array $settings Configuration settings | |
| * | |
| * @return RecordWriter | |
| */ | |
| protected function getWriter(RecordWriterStrategyInterface $strategy, | |
| RecordXmlFormatter $formatter, array $settings | |
| ) { | |
| return new RecordWriter($strategy, $formatter, $settings); | |
| } | |
| /** | |
| * Get the factory for record writer strategies. | |
| * | |
| * @return RecordWriterStrategyFactory | |
| */ | |
| protected function getWriterStrategyFactory() | |
| { | |
| return new RecordWriterStrategyFactory(); | |
| } | |
| /** | |
| * Get the harvester | |
| * | |
| * @param string $target Name of source being harvested (used as directory | |
| * name for storing harvested data inside $harvestRoot) | |
| * @param string $harvestRoot Root directory containing harvested data. | |
| * @param Client $client HTTP client | |
| * @param array $settings Additional settings | |
| * | |
| * @return Harvester | |
| * | |
| * @throws \Exception | |
| */ | |
| public function getHarvester($target, $harvestRoot, Client $client = null, | |
| array $settings = [] | |
| ) { | |
| $basePath = $this->getBasePath($harvestRoot, $target); | |
| $responseProcessor = $this->getResponseProcessor($basePath, $settings); | |
| $communicator = $this->getCommunicator( | |
| $this->configureClient($client, $settings), | |
| $settings, $responseProcessor, $target | |
| ); | |
| $formatter = $this->getFormatter($communicator, $settings); | |
| $strategy = $this->getWriterStrategyFactory() | |
| ->getStrategy($basePath, $settings); | |
| $writer = $this->getWriter($strategy, $formatter, $settings); | |
| $stateManager = $this->getStateManager($basePath); | |
| $harvester = new Harvester($communicator, $writer, $stateManager, $settings); | |
| if ($writer = $this->getConsoleWriter($settings)) { | |
| $harvester->setOutputWriter($writer); | |
| } | |
| return $harvester; | |
| } | |
| } |