-
Notifications
You must be signed in to change notification settings - Fork 14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Minor fix for tika validation. #96
Open
dvdcastro
wants to merge
1
commit into
mattporritt:MOODLE_310_STABLE
Choose a base branch
from
dvdcastro:tika_testing
base: MOODLE_310_STABLE
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
<?php | ||
// This file is part of Moodle - http://moodle.org/ | ||
// | ||
// Moodle is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// Moodle 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 Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
/** | ||
* CLI config tester | ||
* | ||
* @package search | ||
* @copyright 2023 David Castro <[email protected]> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
define('CLI_SCRIPT', true); | ||
|
||
require(__DIR__.'/../../../../config.php'); | ||
require_once($CFG->libdir.'/clilib.php'); // Cli only functions. | ||
|
||
list($options, $unrecognized) = cli_get_params([ | ||
'help' => false, | ||
'testfileid' => '', | ||
], [ | ||
'h' => 'help', | ||
't' => 'testfileid', | ||
]); | ||
|
||
if ($unrecognized) { | ||
$unrecognized = implode("\n ", $unrecognized); | ||
cli_error(get_string('cliunknowoption', 'admin', $unrecognized)); | ||
} | ||
|
||
if ($options['help']) { | ||
$help = " | ||
Run Tika diagnostics. | ||
|
||
Options: | ||
-h, --help Print out this help | ||
-t, --testfileid (Optional) PDF or accepted file id to send to tika for analysis | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Where do we get testfileid from? Is it id from mdl_files? If so, then this is not user friendly. Maybe we can pass a path to a test file instead? Or we could use files from tests/fixtures? |
||
|
||
Examples: | ||
\$ sudo -u www-data /usr/bin/php search/engine/elastic/cli/tika_config_tester.php -t=<file id> | ||
"; | ||
|
||
echo $help; | ||
die; | ||
} | ||
|
||
/** | ||
* Inspired by \search_elastic\enrich\text\tika::tika_server_ready. | ||
* Outputs cli messages on error. | ||
*/ | ||
function tika_server_ready() { | ||
$tikahostname = get_config('search_elastic', 'tikahostname'); | ||
$tikaport = get_config('search_elastic', 'tikaport'); | ||
|
||
$returnval = false; | ||
$client = new \search_elastic\esrequest(); | ||
$url = ''; | ||
// Check if we have a valid set of config. | ||
if (!empty($tikahostname) && !empty($tikaport)) { | ||
$port = $tikaport; | ||
$hostname = rtrim($tikahostname, "/"); | ||
$url = $hostname . ':' . $port; | ||
} else { | ||
cli_writeln('tikahostname or tikaport are not set in elasticsearch config'); | ||
} | ||
|
||
// Check we can reach Tika server. | ||
if ($url !== '') { | ||
$response = $client->get($url); | ||
$responsecode = $response->getStatusCode(); | ||
|
||
if ($responsecode == 200) { | ||
$returnval = true; | ||
} else { | ||
$error = 'Undetermined'; | ||
if (method_exists($response, 'getBody')) { | ||
// This might be transformed into a guzzleexception. | ||
// We need to check if it is still a response. | ||
$error = $response->getBody(); | ||
} | ||
cli_error("Making a GET request to $url resulted in error:\nHTTP Code: $responsecode\nResponse: $error"); | ||
} | ||
} | ||
|
||
return $returnval; | ||
} | ||
|
||
$canusetika = tika_server_ready(); | ||
if (!$canusetika) { | ||
cli_error("Tika cannot be used. Please verify plugin configuration."); | ||
} | ||
cli_writeln('Connection to tika was successful!'); | ||
|
||
$fileid = $options['testfileid']; | ||
if (empty($fileid)) { | ||
cli_writeln('No file id specified, exiting.'); | ||
exit(0); | ||
} | ||
|
||
$tika = new \search_elastic\enrich\text\tika(get_config('search_elastic')); | ||
$fs = get_file_storage(); | ||
$file = $fs->get_file_by_id($fileid); | ||
$text = $tika->analyze_file($file); | ||
|
||
cli_writeln('Text found in file ' . $file->get_filename() . ': ' . $text); |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Have you considered move this CLI to UI instead? E.g. after submitting setting we could check if it actually works and then display results?