includes/CLI/CommandLineHelper.php
<?php
/*
Copyright 2009-2020 Guillaume Boudreau
This file is part of Greyhole.
Greyhole 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.
Greyhole 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 Greyhole. If not, see <http://www.gnu.org/licenses/>.
*/
require_once('includes/CLI/CliCommandDefinition.php');
require_once('includes/CLI/CliOptionDefinition.php');
// Runners
require_once('includes/CLI/BalanceCliRunner.php');
require_once('includes/CLI/BalanceStatusCliRunner.php');
require_once('includes/CLI/BootInitCliRunner.php');
require_once('includes/CLI/CancelBalanceCliRunner.php');
require_once('includes/CLI/CancelFsckCliRunner.php');
require_once('includes/CLI/ConfigCliRunner.php');
require_once('includes/CLI/CopyCliRunner.php');
require_once('includes/CLI/CreateMemSpoolRunner.php');
require_once('includes/CLI/DebugCliRunner.php');
require_once('includes/CLI/DeleteMetadataCliRunner.php');
require_once('includes/CLI/EmptyTrashCliRunner.php');
require_once('includes/CLI/FixSymlinksCliRunner.php');
require_once('includes/CLI/FsckCliRunner.php');
require_once('includes/CLI/GetGUIDCliRunner.php');
require_once('includes/CLI/GoingCliRunner.php');
require_once('includes/CLI/GoneCliRunner.php');
require_once('includes/CLI/IoStatsCliRunner.php');
require_once('includes/CLI/LogsCliRunner.php');
require_once('includes/CLI/MoveCliRunner.php');
require_once('includes/CLI/MD5WorkerCliRunner.php');
require_once('includes/CLI/PauseCliRunner.php');
require_once('includes/CLI/PrintFsckCliRunner.php');
require_once('includes/CLI/ProcessSpoolCliRunner.php');
require_once('includes/CLI/RemoveShareCliRunner.php');
require_once('includes/CLI/RemoveCliRunner.php');
require_once('includes/CLI/ResumeCliRunner.php');
require_once('includes/CLI/ReplaceCliRunner.php');
require_once('includes/CLI/StatsCliRunner.php');
require_once('includes/CLI/StatusCliRunner.php');
require_once('includes/CLI/TestCliRunner.php');
require_once('includes/CLI/ThawCliRunner.php');
require_once('includes/CLI/ViewQueueCliRunner.php');
require_once('includes/CLI/WaitForCliRunner.php');
class CommandLineHelper {
/** @var CliCommandDefinition */
protected $actionCmd = null;
protected $options = array();
/** @var CliCommandDefinition[] */
protected $cliCommandsDefinitions;
protected $cliOptionsDefinitions;
function __construct() {
$this->cliCommandsDefinitions = array(
new CliCommandDefinition('help', '?', null, null, "Display this help and exit."),
new CliCommandDefinition('daemon', 'D', null, DaemonRunner::class, "Start the daemon."),
new CliCommandDefinition('pause', 'P', null, PauseCliRunner::class, "Pause the daemon."),
new CliCommandDefinition('resume', 'M', null, ResumeCliRunner::class, "Resume a paused daemon."),
new CliCommandDefinition('fsck', 'f', null, FsckCliRunner::class, "Schedule a fsck."),
new CliCommandDefinition('cancel-fsck', 'C', null, CancelFsckCliRunner::class, "Cancel any ongoing or scheduled fsck operations."),
new CliCommandDefinition('print-fsck', 'F', null, PrintFsckCliRunner::class, "Print the fsck report for the last completed fsck task. This will print the same content that is sent by email when the --email-report option is used."),
new CliCommandDefinition('balance', 'l', null, BalanceCliRunner::class, "Balance available space on storage pool drives."),
new CliCommandDefinition('balance-status', '', null, BalanceStatusCliRunner::class, "Verify how balanced are the storage pool drives."),
new CliCommandDefinition('cancel-balance', 'B', null, CancelBalanceCliRunner::class, "Cancel any ongoing or scheduled balance operations."),
new CliCommandDefinition('stats', 's', null, StatsCliRunner::class, "Display storage pool statistics."),
new CliCommandDefinition('iostat', 'i', null, IoStatsCliRunner::class, "I/O statistics for your storage pool drives."),
new CliCommandDefinition('logs', 'L', null, LogsCliRunner::class, "Display new greyhole.log entries as they are logged."),
new CliCommandDefinition('status', 'S', null, StatusCliRunner::class, "Display what the Greyhole daemon is currently doing."),
new CliCommandDefinition('view-queue', 'q', null, ViewQueueCliRunner::class, "Display the current work queue."),
new CliCommandDefinition('empty-trash', 'a', null, EmptyTrashCliRunner::class, "Empty the trash."),
new CliCommandDefinition('mv', '', ' source target', MoveCliRunner::class, "Move a folder or file from one Greyhole share to another. Run without parameters for details."),
new CliCommandDefinition('cp', '', ' source share/target/dir/', CopyCliRunner::class,"Copy a file or folder onto your storage pool without going through Samba. Run without parameters for details."),
new CliCommandDefinition('debug:', 'b:', '=filename', DebugCliRunner::class, "Debug past file operations."),
new CliCommandDefinition('thaw::', 't::', '[=path]', ThawCliRunner::class, "Thaw a frozen directory. Greyhole will start working on files inside <path>. If you don't supply an option, the list of frozen directories will be displayed."),
new CliCommandDefinition('wait-for::', 'w::', '[=path]', WaitForCliRunner::class, "Tell Greyhole that the missing drive at <path> will return soon, and that it shouldn't re-create additional file copies to replace it. If you don't supply an option, the available options (paths) will be displayed."),
new CliCommandDefinition('gone::', '', null, GoneCliRunner::class, null),
new CliCommandDefinition('going::', '', null, GoingCliRunner::class, null),
new CliCommandDefinition('remove::', 'R::', '[=path]', RemoveCliRunner::class, "Tell Greyhole that you want to remove a drive. Greyhole will then make sure you don't lose any files, and that the correct number of file copies are created to replace the missing drive. If you don't supply an option, the available options (paths) will be displayed."),
new CliCommandDefinition('replaced::', 'r::', '[=path]', ReplaceCliRunner::class, "Tell Greyhole that you replaced the drive at <path>."),
new CliCommandDefinition('fix-symlinks', 'X', null, FixSymlinksCliRunner::class, "Try to find a good file copy to point to for all broken symlinks found on your shares."),
new CliCommandDefinition('delete-metadata:', 'p:', '=path', DeleteMetadataCliRunner::class, "Delete all metadata files for <path>, which should be a share name, followed by the path to a file that is gone from your storage pool. Eg. 'Movies/HD/The Big Lebowski.mkv'" ),
new CliCommandDefinition('remove-share:', 'U:', '=share_name', RemoveShareCliRunner::class, "Move the files currently inside the specified share from the storage pool into the shared folder (landing zone), effectively removing the share from Greyhole's storage pool."),
new CliCommandDefinition('config', '', ' name', ConfigCliRunner::class, "Get a config from greyhole.conf; outputs JSON"),
new CliCommandDefinition('config', '', ' name value', ConfigCliRunner::class, "Change a config in greyhole.conf"),
new CliCommandDefinition('md5-worker', '', null, null, null),
new CliCommandDefinition('getuid', 'G', null, GetGUIDCliRunner::class, null),
new CliCommandDefinition('create-mem-spool', '', null, CreateMemSpoolRunner::class, null),
new CliCommandDefinition('test-config', '', null, TestCliRunner::class, null),
new CliCommandDefinition('boot-init', '', null, BootInitCliRunner::class, null),
new CliCommandDefinition('process-spool', '', null, ProcessSpoolCliRunner::class, null),
);
$this->cliOptionsDefinitions = array(
// For view-queue & stats
'json' => new CliOptionDefinition('json', 'j', null, "Output the result as JSON, instead of human-readable text."),
// For fsck
'email-report' => new CliOptionDefinition('email-report', 'e', null, "Send an email when fsck completes, to report on what was checked, and any error that was found."),
'dont-walk-metadata-store' => new CliOptionDefinition('dont-walk-metadata-store', 'y', null, "Speed up fsck by skipping the scan of the metadata store directories. Scanning the metadata stores is only required to re-create symbolic links that might be missing from your shared directories."),
'if-conf-changed' => new CliOptionDefinition('if-conf-changed', 'c', null, "Only fsck if greyhole.conf or smb.conf paths changed since the last fsck.\nUsed in the daily cron to prevent unneccesary fsck runs."),
'dir' => new CliOptionDefinition('dir:', 'd:', '=path', "Only scan a specific directory, and all sub-directories. The specified directory should be a Samba share, a sub-directory of a Samba share, or any directory on a storage pool drive."),
'find-orphaned-files' => new CliOptionDefinition('find-orphaned-files', 'o', null, "Scan for files with no metadata in the storage pool drives. This will allow you to include existing files on a drive in your storage pool without having to copy them manually."),
'checksums' => new CliOptionDefinition('checksums', 'k', null, "Read ALL files in your storage pool, and check that file copies are identical. This will identify any problem you might have with your file-systems.\nNOTE: this can take a LONG time to complete, since it will read everything from all your drives!"),
'delete-orphaned-metadata' => new CliOptionDefinition('delete-orphaned-metadata', 'm', null, "When fsck find metadata files with no file copies, delete those metadata files. If the file copies re-appear later, you'll need to run fsck with --find-orphaned-files to have them reappear in your shares."),
'disk-usage-report' => new CliOptionDefinition('disk-usage-report', 'u', null, "Calculate the disk usage of scanned folders."),
'drive' => new CliOptionDefinition('drive:', 'R:', '=path', null),
);
}
public function processCommandLine() {
$command_line_options = $this->getopt($this->getOpts(), $this->getLongOpts());
$this->actionCmd = $this->getActionCommand($command_line_options);
$this->options = $this->getOptions($command_line_options);
return $this->getRunner();
}
private function getActionCommand($command_line_options) {
foreach ($this->cliCommandsDefinitions as $def) {
$param = $def->paramSpecified($command_line_options);
if ($param !== FALSE) {
if ($param !== TRUE) {
$this->options['cmd_param'] = $param;
}
return $def;
}
}
return null;
}
private function getOptions($command_line_options) {
$options = $this->options;
foreach ($this->cliOptionsDefinitions as $opt_name => $def) {
$param = $def->paramSpecified($command_line_options);
if ($param !== FALSE) {
$options[$opt_name] = $param;
}
}
return $options;
}
private function getRunner() {
if (empty($this->actionCmd) && basename(first($GLOBALS['argv'], '')) == 'cpgh') {
return new CopyCliRunner($this->options, $this->actionCmd);
}
// No action specified on the command line; print usage help and exit.
if (empty($this->actionCmd) || $this->actionCmd->getOpt() == 'help') {
$this->printUsage();
exit(0);
}
if ($this->actionCmd->getLongOpt() == 'md5-worker') {
// Any forking needs to happen before DB::connect(), or the parent exiting will close the child's DB connection!
$cliRunner = new MD5WorkerCliRunner($this->options, $this->actionCmd);
}
if ($this->actionCmd->getLongOpt() == 'create-mem-spool') {
// This can be executed during Greyhole install, so it needs to run before the config parsing runs (and fails)
$cliRunner = new CreateMemSpoolRunner($this->options, $this->actionCmd);
} else {
if ($this->actionCmd->getLongOpt() != 'test-config') {
// Those will be tested in TestCliRunner
ConfigHelper::test();
$retry_until_successful = ( $this->actionCmd->getLongOpt() == 'boot-init' );
if ($this->actionCmd->getLongOpt() != 'config') {
DB::connect($retry_until_successful);
}
}
if (!isset($cliRunner)) {
$cliRunner = $this->actionCmd->getNewRunner($this->options);
if ($cliRunner === FALSE) {
$this->printUsage();
exit(0);
}
}
}
if (!$cliRunner->canRun()) {
echo "You need to execute this as root.\n";
exit(1);
}
Log::setAction($this->actionCmd->getLongOpt());
return $cliRunner;
}
private function printUsage() {
echo "greyhole, version %VERSION%, for linux-gnu (noarch)\n";
echo "This software comes with ABSOLUTELY NO WARRANTY. This is free software,\n";
echo "and you are welcome to modify and redistribute it under the GPL v3 license.\n";
echo "\n";
echo "Usage: greyhole [ACTION] [OPTIONS]\n";
echo "\n";
echo "Where ACTION is one of:\n";
foreach ($this->cliCommandsDefinitions as $def) {
echo $def->getUsage();
}
echo "\n";
echo "For --stats and --view-queue, the available OPTIONS are:\n";
echo $this->cliOptionsDefinitions['json']->getUsage();
echo "\n";
echo "For --fsck, the available OPTIONS are:\n";
foreach ($this->cliOptionsDefinitions as $opt_name => $def) {
if ($opt_name != 'json') {
echo $def->getUsage();
}
}
}
private function getOpts() {
$opts = array();
foreach ($this->cliCommandsDefinitions as $def) {
$opts[] = $def->getOpt();
}
foreach ($this->cliOptionsDefinitions as $def) {
$opts[] = $def->getOpt();
}
return $opts;
}
private function getLongOpts() {
$long_opts = array();
foreach ($this->cliCommandsDefinitions as $def) {
$long_opts[] = $def->getLongOpt();
}
foreach ($this->cliOptionsDefinitions as $def) {
$long_opts[] = $def->getLongOpt();
}
return $long_opts;
}
/*
* _getopt(): Ver. 1.3 2009/05/30
* My page: http://www.ntu.beautifulworldco.com/weblog/?p=526
*
* Note that another function split_para() is required, which can be found in the same page.
*
* _getopt() fully simulates getopt() which is described at
* http://us.php.net/manual/en/function.getopt.php , including long options for PHP
* version under 5.3.0. (Prior to 5.3.0, long options was only available on few systems)
*/
protected function getopt($short_options, $long_options) {
$opts_no_value = array();
$opts_required_value = array();
$opts_optional_value = array();
foreach (array_merge($short_options, $long_options) as $a) {
if (substr($a, -2) == "::" ) {
$opts_optional_value[] = substr($a, 0, -2);
} else if (substr($a, -1) == ":") {
$opts_required_value[] = substr($a, 0, -1);
} else {
$opts_no_value[] = $a;
}
}
$argv = $GLOBALS['argv'];
$options = array();
for ($i = 0; $i < count($argv); ) {
$arg = $argv[$i];
if ($arg == "-") {
$i++;
continue;
}
if ($arg[0] != "-") {
$i++;
continue;
}
if (!empty($argv[$i+1]) && $argv[$i+1][0] != "-") {
$nextArg = $argv[$i+1];
} else {
$nextArg = FALSE;
}
if (substr($arg, 0, 2) == "--") {
// Long opt
$key = substr($arg, 2);
if (string_contains($key, '=')) {
// --longopt=value
list($key, $value) = explode('=', $key, 2);
if (array_contains($opts_required_value, $key) || array_contains($opts_optional_value, $key)) {
$options[$key][] = $value;
}
$i++;
continue;
}
if (array_contains($opts_required_value, $key)) {
// --longopt value
$options[$key][] = $argv[$i+1];
$i += 2;
continue;
} else if (array_contains($opts_optional_value, $key)) {
// --longopt [value]
if ($nextArg) {
$options[$key][] = $nextArg;
$i += 2;
} else {
$options[$key][] = FALSE;
$i++;
}
continue;
} else if (array_contains($opts_no_value, $key)) {
// --longopt
$options[$key][] = FALSE;
$i++;
continue;
} else {
$i++;
continue;
}
} else {
// Short opt(s)
// eg. -abcvalue => -a -b -c value
for ($j=1; $j < strlen($arg); $j++) {
if (array_contains($opts_no_value, $arg[$j])) {
// -a
$options[$arg[$j]][] = FALSE;
if ($j == strlen($arg) - 1) {
break;
}
} if (array_contains($opts_required_value, $arg[$j])) {
if ($j == strlen($arg) - 1) {
// -a value
$options[$arg[$j]][] = $argv[$i+1];
$i++;
} else {
// -avalue
$options[$arg[$j]][] = substr($arg, $j+1);
}
break;
} else {
// -a [value]
if ($j == strlen($arg) - 1 && $nextArg) {
$options[$arg[$j]][] = $nextArg;
$i++;
} else {
$options[$arg[$j]][] = FALSE;
}
}
}
}
$i++;
}
foreach ($options as $key => $value) {
if (count($value) == 1) {
$options[$key] = $value[0];
}
}
return $options;
}
}
?>