mirror of
https://github.com/silverstripe/silverstripe-textextraction
synced 2024-09-28 20:29:17 +02:00
Compare commits
No commits in common. "3" and "3.3.0" have entirely different histories.
11
.github/workflows/ci.yml
vendored
11
.github/workflows/ci.yml
vendored
@ -1,11 +0,0 @@
|
||||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
pull_request:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
ci:
|
||||
name: CI
|
||||
uses: silverstripe/gha-ci/.github/workflows/ci.yml@v1
|
16
.github/workflows/dispatch-ci.yml
vendored
16
.github/workflows/dispatch-ci.yml
vendored
@ -1,16 +0,0 @@
|
||||
name: Dispatch CI
|
||||
|
||||
on:
|
||||
# At 12:20 PM UTC, only on Saturday and Sunday
|
||||
schedule:
|
||||
- cron: '20 12 * * 6,0'
|
||||
|
||||
jobs:
|
||||
dispatch-ci:
|
||||
name: Dispatch CI
|
||||
# Only run cron on the silverstripe account
|
||||
if: (github.event_name == 'schedule' && github.repository_owner == 'silverstripe') || (github.event_name != 'schedule')
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Dispatch CI
|
||||
uses: silverstripe/gha-dispatch-ci@v1
|
17
.github/workflows/keepalive.yml
vendored
17
.github/workflows/keepalive.yml
vendored
@ -1,17 +0,0 @@
|
||||
name: Keepalive
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
# The 4th of every month at 10:50am UTC
|
||||
schedule:
|
||||
- cron: '50 10 4 * *'
|
||||
|
||||
jobs:
|
||||
keepalive:
|
||||
name: Keepalive
|
||||
# Only run cron on the silverstripe account
|
||||
if: (github.event_name == 'schedule' && github.repository_owner == 'silverstripe') || (github.event_name != 'schedule')
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Keepalive
|
||||
uses: silverstripe/gha-keepalive@v1
|
13
.scrutinizer.yml
Normal file
13
.scrutinizer.yml
Normal file
@ -0,0 +1,13 @@
|
||||
inherit: true
|
||||
|
||||
checks:
|
||||
php: true
|
||||
|
||||
build:
|
||||
nodes:
|
||||
analysis:
|
||||
tests:
|
||||
override: [php-scrutinizer-run]
|
||||
|
||||
filter:
|
||||
paths: [src/*, tests/*]
|
4
.travis.yml
Normal file
4
.travis.yml
Normal file
@ -0,0 +1,4 @@
|
||||
version: ~> 1.0
|
||||
|
||||
import:
|
||||
- silverstripe/silverstripe-travis-shared:config/provision/standard-jobs-range.yml
|
12
README.md
12
README.md
@ -1,7 +1,9 @@
|
||||
# Text extraction module
|
||||
|
||||
[![CI](https://github.com/silverstripe/silverstripe-textextraction/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-textextraction/actions/workflows/ci.yml)
|
||||
[![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
|
||||
[![Build Status](https://api.travis-ci.com/silverstripe/silverstripe-textextraction.svg?branch=3)](https://travis-ci.com/silverstripe/silverstripe-textextraction)
|
||||
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/silverstripe/silverstripe-textextraction/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/silverstripe/silverstripe-textextraction/?branch=master)
|
||||
[![codecov](https://codecov.io/gh/silverstripe/silverstripe-textextraction/branch/master/graph/badge.svg)](https://codecov.io/gh/silverstripe/silverstripe-textextraction)
|
||||
[![SilverStripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
|
||||
|
||||
Provides a text extraction API for file content, that can hook into different extractor
|
||||
engines based on availability and the parsed file format. The output returned is always a string of the file content.
|
||||
@ -22,7 +24,7 @@ The module supports text extraction on the following file formats:
|
||||
|
||||
## Requirements
|
||||
|
||||
* Silverstripe ^4.0
|
||||
* SilverStripe ^4.0
|
||||
* (optional) [XPDF](http://www.foolabs.com/xpdf/) (`pdftotext` utility)
|
||||
* (optional) [Apache Solr with ExtracingRequestHandler](http://wiki.apache.org/solr/ExtractingRequestHandler)
|
||||
* (optional) [Apache Tika](http://tika.apache.org/)
|
||||
@ -52,8 +54,8 @@ If the issue does look like a new bug:
|
||||
- Create a new issue
|
||||
- Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots
|
||||
and screencasts can help here.
|
||||
- Describe your environment as detailed as possible: Silverstripe version, Browser, PHP version,
|
||||
Operating System, any installed Silverstripe modules.
|
||||
- Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version,
|
||||
Operating System, any installed SilverStripe modules.
|
||||
|
||||
Please report security issues to security@silverstripe.org directly. Please don't file security issues in the bugtracker.
|
||||
|
||||
|
@ -20,11 +20,11 @@
|
||||
}
|
||||
],
|
||||
"require": {
|
||||
"php": "^7.4 || ^8.0",
|
||||
"php": "^7.3 || ^8.0",
|
||||
"silverstripe/framework": "^4.10",
|
||||
"silverstripe/assets": "^1",
|
||||
"silverstripe/versioned": "^1",
|
||||
"guzzlehttp/guzzle": "^6.3 || ^7.0"
|
||||
"guzzlehttp/guzzle": "~6.3.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"squizlabs/php_codesniffer": "^3",
|
||||
|
@ -30,7 +30,7 @@ SilverStripe\Core\Injector\Injector:
|
||||
SilverStripe\TextExtraction\Cache\FileTextCache:
|
||||
class: SilverStripe\TextExtraction\Cache\FileTextCache\Cache
|
||||
|
||||
SilverStripe\TextExtraction\Cache\FileTextCache\Cache:
|
||||
SilverStripe\TextExtraction\Cache\FileTextCache\Database:
|
||||
lifetime: 3600 # Number of seconds to cache content for
|
||||
```
|
||||
|
||||
|
@ -1,4 +1,3 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true">
|
||||
<testsuites>
|
||||
<testsuite name="Default">
|
||||
|
@ -18,7 +18,7 @@ class Cache implements FileTextCache, Flushable
|
||||
|
||||
/**
|
||||
* Lifetime of cache in seconds
|
||||
* Null defaults to 3600 (1 hour)
|
||||
* Null is indefinite
|
||||
*
|
||||
* @var int|null
|
||||
* @config
|
||||
@ -42,7 +42,7 @@ class Cache implements FileTextCache, Flushable
|
||||
*/
|
||||
protected function getKey(File $file)
|
||||
{
|
||||
return md5($file->getFilename() ?? '');
|
||||
return md5($file->getFilename());
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -58,7 +58,7 @@ abstract class FileTextExtractor
|
||||
arsort($classPriorities);
|
||||
|
||||
// Save classes
|
||||
$sortedClasses = array_keys($classPriorities ?? []);
|
||||
$sortedClasses = array_keys($classPriorities);
|
||||
return self::$sorted_extractor_classes = $sortedClasses;
|
||||
}
|
||||
|
||||
@ -81,7 +81,7 @@ abstract class FileTextExtractor
|
||||
*/
|
||||
public static function for_file($file)
|
||||
{
|
||||
if (!$file || (is_string($file) && !file_exists($file ?? ''))) {
|
||||
if (!$file || (is_string($file) && !file_exists($file))) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@ -137,11 +137,11 @@ abstract class FileTextExtractor
|
||||
}
|
||||
|
||||
// Remove any existing temp files with this name
|
||||
if (file_exists($path ?? '')) {
|
||||
unlink($path ?? '');
|
||||
if (file_exists($path)) {
|
||||
unlink($path);
|
||||
}
|
||||
|
||||
$bytesWritten = file_put_contents($path ?? '', $file->getStream());
|
||||
$bytesWritten = file_put_contents($path, $file->getStream());
|
||||
if (false === $bytesWritten) {
|
||||
throw new Exception(static::class . '->getPathFromFile() failed to write temporary file');
|
||||
}
|
||||
|
@ -34,7 +34,7 @@ class HTMLTextExtractor extends FileTextExtractor
|
||||
*/
|
||||
public function supportsExtension($extension)
|
||||
{
|
||||
return in_array(strtolower($extension ?? ''), ["html", "htm", "xhtml"]);
|
||||
return in_array(strtolower($extension), ["html", "htm", "xhtml"]);
|
||||
}
|
||||
|
||||
/**
|
||||
@ -43,7 +43,7 @@ class HTMLTextExtractor extends FileTextExtractor
|
||||
*/
|
||||
public function supportsMime($mime)
|
||||
{
|
||||
return strtolower($mime ?? '') === 'text/html';
|
||||
return strtolower($mime) === 'text/html';
|
||||
}
|
||||
|
||||
/**
|
||||
@ -56,7 +56,7 @@ class HTMLTextExtractor extends FileTextExtractor
|
||||
*/
|
||||
public function getContent($file)
|
||||
{
|
||||
$content = $file instanceof File ? $file->getString() : file_get_contents($file ?? '');
|
||||
$content = $file instanceof File ? $file->getString() : file_get_contents($file);
|
||||
|
||||
// Yes, yes, regex'ing HTML is evil.
|
||||
// Since we don't care about well-formedness or markup here, it does the job.
|
||||
@ -82,9 +82,9 @@ class HTMLTextExtractor extends FileTextExtractor
|
||||
'@</?((frameset)|(frame)|(iframe))@iu',
|
||||
],
|
||||
[' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', "$0", "$0", "$0", "$0", "$0", "$0", "$0", "$0"],
|
||||
$content ?? ''
|
||||
$content
|
||||
);
|
||||
|
||||
return strip_tags($content ?? '');
|
||||
return strip_tags($content);
|
||||
}
|
||||
}
|
||||
|
@ -33,18 +33,18 @@ class PDFTextExtractor extends FileTextExtractor
|
||||
public function isAvailable()
|
||||
{
|
||||
$bin = $this->bin('pdftotext');
|
||||
return $bin && file_exists($bin ?? '') && is_executable($bin ?? '');
|
||||
return $bin && file_exists($bin) && is_executable($bin);
|
||||
}
|
||||
|
||||
public function supportsExtension($extension)
|
||||
{
|
||||
return strtolower($extension ?? '') === 'pdf';
|
||||
return strtolower($extension) === 'pdf';
|
||||
}
|
||||
|
||||
public function supportsMime($mime)
|
||||
{
|
||||
return in_array(
|
||||
strtolower($mime ?? ''),
|
||||
strtolower($mime),
|
||||
[
|
||||
'application/pdf',
|
||||
'application/x-pdf',
|
||||
@ -72,7 +72,7 @@ class PDFTextExtractor extends FileTextExtractor
|
||||
// Find program in each path
|
||||
foreach ($locations as $location) {
|
||||
$path = "{$location}/{$program}";
|
||||
if (file_exists($path ?? '')) {
|
||||
if (file_exists($path)) {
|
||||
return $path;
|
||||
}
|
||||
if (file_exists($path . '.exe')) {
|
||||
@ -86,7 +86,7 @@ class PDFTextExtractor extends FileTextExtractor
|
||||
|
||||
public function getContent($file)
|
||||
{
|
||||
if (!$file || (is_string($file) && !file_exists($file ?? ''))) {
|
||||
if (!$file || (is_string($file) && !file_exists($file))) {
|
||||
// no file
|
||||
return '';
|
||||
}
|
||||
@ -108,7 +108,7 @@ class PDFTextExtractor extends FileTextExtractor
|
||||
}
|
||||
|
||||
$path = $file instanceof File ? $this->getPathFromFile($file) : $file;
|
||||
exec(sprintf('%s %s - 2>&1', $this->bin('pdftotext'), escapeshellarg($path ?? '')), $content, $err);
|
||||
exec(sprintf('%s %s - 2>&1', $this->bin('pdftotext'), escapeshellarg($path)), $content, $err);
|
||||
|
||||
if ($err) {
|
||||
throw new Exception(sprintf(
|
||||
@ -141,6 +141,6 @@ class PDFTextExtractor extends FileTextExtractor
|
||||
'st' => 'st'
|
||||
];
|
||||
|
||||
return str_replace(array_keys($mapping ?? []), array_values($mapping ?? []), $input ?? '');
|
||||
return str_replace(array_keys($mapping), array_values($mapping), $input);
|
||||
}
|
||||
}
|
||||
|
@ -80,7 +80,7 @@ class SolrCellTextExtractor extends FileTextExtractor
|
||||
public function supportsExtension($extension)
|
||||
{
|
||||
return in_array(
|
||||
strtolower($extension ?? ''),
|
||||
strtolower($extension),
|
||||
[
|
||||
'pdf', 'doc', 'docx', 'xls', 'xlsx',
|
||||
'epub', 'rtf', 'odt', 'fodt', 'ods', 'fods',
|
||||
@ -106,12 +106,12 @@ class SolrCellTextExtractor extends FileTextExtractor
|
||||
*/
|
||||
public function getContent($file)
|
||||
{
|
||||
if (!$file || (is_string($file) && !file_exists($file ?? ''))) {
|
||||
if (!$file || (is_string($file) && !file_exists($file))) {
|
||||
// no file
|
||||
return '';
|
||||
}
|
||||
|
||||
$fileName = $file instanceof File ? $file->getFilename() : basename($file ?? '');
|
||||
$fileName = $file instanceof File ? $file->getFilename() : basename($file);
|
||||
$client = $this->getHttpClient();
|
||||
|
||||
// Get and validate base URL
|
||||
@ -121,7 +121,7 @@ class SolrCellTextExtractor extends FileTextExtractor
|
||||
}
|
||||
|
||||
try {
|
||||
$stream = $file instanceof File ? $file->getStream() : fopen($file ?? '', 'r');
|
||||
$stream = $file instanceof File ? $file->getStream() : fopen($file, 'r');
|
||||
/** @var Response $response */
|
||||
$response = $client
|
||||
->post($baseUrl, [
|
||||
@ -154,7 +154,7 @@ class SolrCellTextExtractor extends FileTextExtractor
|
||||
$matches = [];
|
||||
// Use preg match to avoid SimpleXML running out of memory on large text nodes
|
||||
preg_match(
|
||||
sprintf('/\<str name\="%s"\>(.*?)\<\/str\>/s', preg_quote($fileName ?? '')),
|
||||
sprintf('/\<str name\="%s"\>(.*?)\<\/str\>/s', preg_quote($fileName)),
|
||||
(string)$response->getBody(),
|
||||
$matches
|
||||
);
|
||||
|
@ -86,7 +86,7 @@ class TikaServerTextExtractor extends FileTextExtractor
|
||||
{
|
||||
return $this->getServerEndpoint()
|
||||
&& $this->getClient()->isAvailable()
|
||||
&& version_compare($this->getVersion() ?? '', '1.7') >= 0;
|
||||
&& version_compare($this->getVersion(), '1.7') >= 0;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -116,7 +116,7 @@ class TikaServerTextExtractor extends FileTextExtractor
|
||||
|
||||
// Check aliases
|
||||
foreach ($this->supportedMimes as $info) {
|
||||
if (isset($info['alias']) && in_array($mime, $info['alias'] ?? [])) {
|
||||
if (isset($info['alias']) && in_array($mime, $info['alias'])) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@ -130,7 +130,7 @@ class TikaServerTextExtractor extends FileTextExtractor
|
||||
$content = $this->getClient()->tika($tempFile);
|
||||
//Cleanup temp file
|
||||
if ($file instanceof File) {
|
||||
unlink($tempFile ?? '');
|
||||
unlink($tempFile);
|
||||
}
|
||||
return $content;
|
||||
}
|
||||
|
@ -29,7 +29,7 @@ class TikaTextExtractor extends FileTextExtractor
|
||||
$code = $this->runShell('tika --version', $stdout);
|
||||
|
||||
// Parse output
|
||||
if (!$code && preg_match('/Apache Tika (?<version>[\.\d]+)/', $stdout ?? '', $matches)) {
|
||||
if (!$code && preg_match('/Apache Tika (?<version>[\.\d]+)/', $stdout, $matches)) {
|
||||
return $matches['version'];
|
||||
}
|
||||
|
||||
@ -54,14 +54,14 @@ class TikaTextExtractor extends FileTextExtractor
|
||||
];
|
||||
// Invoke command
|
||||
$pipes = [];
|
||||
$proc = proc_open($command ?? '', $descriptorSpecs ?? [], $pipes);
|
||||
$proc = proc_open($command, $descriptorSpecs, $pipes);
|
||||
|
||||
if (!is_resource($proc)) {
|
||||
return 255;
|
||||
}
|
||||
|
||||
// Send content as input
|
||||
fwrite($pipes[0], $input ?? '');
|
||||
fwrite($pipes[0], $input);
|
||||
fclose($pipes[0]);
|
||||
|
||||
// Get output
|
||||
@ -78,11 +78,11 @@ class TikaTextExtractor extends FileTextExtractor
|
||||
{
|
||||
$mode = $this->config()->get('output_mode');
|
||||
$path = $file instanceof File ? $this->getPathFromFile($file) : $file;
|
||||
$command = sprintf('tika %s %s', $mode, escapeshellarg($path ?? ''));
|
||||
$command = sprintf('tika %s %s', $mode, escapeshellarg($path));
|
||||
$code = $this->runShell($command, $output);
|
||||
//Cleanup temp file
|
||||
if ($file instanceof File) {
|
||||
unlink($path ?? '');
|
||||
unlink($path);
|
||||
}
|
||||
|
||||
if ($code == 0) {
|
||||
@ -123,8 +123,8 @@ class TikaTextExtractor extends FileTextExtractor
|
||||
}
|
||||
|
||||
// Check if the mime type is inside the result
|
||||
$pattern = sprintf('/\b(%s)\b/', preg_quote($mime ?? '', '/'));
|
||||
$pattern = sprintf('/\b(%s)\b/', preg_quote($mime, '/'));
|
||||
|
||||
return (bool)preg_match($pattern ?? '', $supportedTypes ?? '');
|
||||
return (bool)preg_match($pattern, $supportedTypes);
|
||||
}
|
||||
}
|
||||
|
@ -80,7 +80,7 @@ class TikaRestClient extends Client
|
||||
|
||||
// Parse output
|
||||
if ($response->getStatusCode() == 200
|
||||
&& preg_match('/Apache Tika (?<version>[\.\d]+)/', $response->getBody() ?? '', $matches)
|
||||
&& preg_match('/Apache Tika (?<version>[\.\d]+)/', $response->getBody(), $matches)
|
||||
) {
|
||||
$version = $matches['version'];
|
||||
}
|
||||
@ -108,7 +108,7 @@ class TikaRestClient extends Client
|
||||
])
|
||||
);
|
||||
|
||||
return $this->mimes = json_decode($response->getBody(), true);
|
||||
return $this->mimes = Convert::json2array($response->getBody());
|
||||
}
|
||||
|
||||
/**
|
||||
@ -129,7 +129,7 @@ class TikaRestClient extends Client
|
||||
'headers' => [
|
||||
'Accept' => 'text/plain',
|
||||
],
|
||||
'body' => file_get_contents($file ?? ''),
|
||||
'body' => file_get_contents($file),
|
||||
])
|
||||
);
|
||||
$text = $response->getBody();
|
||||
|
Loading…
Reference in New Issue
Block a user