2020-04-18 00:51:33 +02:00
|
|
|
<?php
|
|
|
|
|
|
|
|
$cli_commands=array();
|
|
|
|
function add_cli_command($command, $handler, $short_desc, $usage_args=false, $long_desc=false, $override=false) {
|
|
|
|
global $cli_commands;
|
|
|
|
if (array_key_exists($command, $cli_commands) && !$override) {
|
|
|
|
logging('ERROR', "The CLI command '$command' already exists.");
|
|
|
|
return False;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!is_callable($handler)) {
|
|
|
|
logging('ERROR', "The CLI command '$command' handler is not callable !");
|
|
|
|
return False;
|
|
|
|
}
|
|
|
|
|
|
|
|
$cli_commands[$command] = array (
|
|
|
|
'handler' => $handler,
|
|
|
|
'short_desc' => $short_desc,
|
|
|
|
'usage_args' => $usage_args,
|
|
|
|
'long_desc' => $long_desc,
|
|
|
|
);
|
|
|
|
return True;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
**************************************************************************************************************
|
|
|
|
* /!\ Code after this message will only be execute on CLI context /!\
|
|
|
|
**************************************************************************************************************
|
|
|
|
*/
|
|
|
|
if (php_sapi_name() != "cli")
|
2020-11-18 18:33:39 +01:00
|
|
|
return true;
|
|
|
|
|
|
|
|
// Store current CLI command
|
|
|
|
$cli_command = null;
|
2020-04-18 00:51:33 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* CLI Helpers
|
|
|
|
**/
|
|
|
|
|
|
|
|
function usage($error=false) {
|
2020-11-18 18:33:39 +01:00
|
|
|
global $cli_commands, $cli_command, $argv;
|
2020-04-18 00:51:33 +02:00
|
|
|
|
|
|
|
if ($error)
|
|
|
|
echo "$error\n\n";
|
|
|
|
echo "Usage : ".$argv[0]." [-h] [-qd] command\n";
|
|
|
|
echo " -h Show this message\n";
|
|
|
|
echo " -q / -d Quiet/Debug mode\n";
|
|
|
|
echo " command Command to run\n";
|
|
|
|
echo "\n";
|
|
|
|
echo "Available commands :\n";
|
|
|
|
|
|
|
|
foreach ($cli_commands as $command => $info) {
|
2020-11-18 18:33:39 +01:00
|
|
|
if ($cli_command && $command != $cli_command)
|
|
|
|
continue;
|
2020-04-18 00:51:33 +02:00
|
|
|
echo " $command : ".$info['short_desc']."\n";
|
|
|
|
echo " ".$argv[0]." $command ".($info['usage_args']?$info['usage_args']:'')."\n";
|
|
|
|
if ($info['long_desc']) {
|
|
|
|
if (is_array($info['long_desc']))
|
|
|
|
$info['long_desc'] = implode("\n", $info['long_desc']);
|
|
|
|
echo "\n ".str_replace("\n", "\n ", wordwrap($info['long_desc']))."\n";
|
|
|
|
}
|
|
|
|
echo "\n";
|
|
|
|
}
|
|
|
|
|
|
|
|
exit(($error?1:0));
|
|
|
|
}
|
|
|
|
|
|
|
|
function handle_cli_args() {
|
2020-11-18 18:33:39 +01:00
|
|
|
global $log_level, $cli_commands, $cli_command, $argv;
|
2020-04-18 00:51:33 +02:00
|
|
|
$log_level = 'INFO';
|
2020-11-18 18:33:39 +01:00
|
|
|
$cli_command = false;
|
2020-04-18 00:51:33 +02:00
|
|
|
$command_args = array();
|
|
|
|
for ($i=1; $i < count($argv); $i++) {
|
|
|
|
if (array_key_exists($argv[$i], $cli_commands)) {
|
2020-11-18 18:33:39 +01:00
|
|
|
if (!$cli_command)
|
|
|
|
$cli_command = $argv[$i];
|
2020-04-18 00:51:33 +02:00
|
|
|
else
|
|
|
|
usage("Only one command could be executed !");
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
switch($argv[$i]) {
|
|
|
|
case '-h':
|
|
|
|
case '--help':
|
|
|
|
usage();
|
|
|
|
break;
|
|
|
|
case '-d':
|
|
|
|
case '--debug':
|
|
|
|
$log_level = 'DEBUG';
|
|
|
|
break;
|
|
|
|
case '-q':
|
|
|
|
case '--quiet':
|
|
|
|
$log_level = 'WARNING';
|
|
|
|
break;
|
|
|
|
default:
|
2020-11-18 18:33:39 +01:00
|
|
|
if ($cli_command)
|
2020-04-18 00:51:33 +02:00
|
|
|
$command_args[] = $argv[$i];
|
|
|
|
else
|
|
|
|
usage("Invalid parameter \"".$argv[$i]."\".\nNote: Command's parameter/argument must be place after the command.");
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-11-18 18:33:39 +01:00
|
|
|
if (!$cli_command)
|
2020-04-18 00:51:33 +02:00
|
|
|
usage();
|
|
|
|
|
2020-11-18 18:33:39 +01:00
|
|
|
logging('DEBUG', 'Run '.basename($argv[0])." command $cli_command with argument(s) '".implode("', '", $command_args)."'");
|
2020-04-18 00:51:33 +02:00
|
|
|
|
|
|
|
try {
|
2020-11-18 18:33:39 +01:00
|
|
|
$result = call_user_func($cli_commands[$cli_command]['handler'], $command_args);
|
2020-04-18 00:51:33 +02:00
|
|
|
|
|
|
|
exit($result?0:1);
|
|
|
|
}
|
|
|
|
catch(Exception $e) {
|
2020-11-18 18:33:39 +01:00
|
|
|
log_exception("An exception occured running command $cli_command");
|
2020-04-18 00:51:33 +02:00
|
|
|
exit(1);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
function print_item_info($item) {
|
|
|
|
echo "Item #".$item['id']." :\n";
|
|
|
|
echo "\tID : ".$item['id']."\n";
|
|
|
|
echo "\tName : '".$item['name']."'\n";
|
|
|
|
echo "\tDate : ".format_time($item['date'])."\n";
|
|
|
|
echo "\tDescription : ".($item['description']?"'".$item['description']."'":"Not set")."\n";
|
|
|
|
echo "\tStatus : '".$item['status']."'\n";
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Common CLI commands
|
|
|
|
**/
|
|
|
|
|
|
|
|
$orderbys = array('id', 'name', 'date', 'status', 'description');
|
|
|
|
function cli_list($command_args) {
|
|
|
|
global $orderbys;
|
|
|
|
$params = array(
|
|
|
|
'order' => $orderbys[0],
|
|
|
|
'order_direction' => 'ASC',
|
|
|
|
'all' => true,
|
|
|
|
);
|
|
|
|
$patterns = array();
|
|
|
|
for($i=0; $i < count($command_args); $i++) {
|
|
|
|
switch($command_args[$i]) {
|
|
|
|
case '-o':
|
|
|
|
case '--orderby':
|
|
|
|
$i++;
|
|
|
|
if(!in_array($command_args[$i], $orderbys))
|
|
|
|
usage('Invalid --orderby clause');
|
|
|
|
$params['order'] = $command_args[$i];
|
|
|
|
break;
|
|
|
|
case '-r':
|
|
|
|
case '--reverse':
|
|
|
|
$params['order_direction'] = 'DESC';
|
|
|
|
break;
|
|
|
|
case '-s':
|
|
|
|
case '--status':
|
|
|
|
$i++;
|
|
|
|
if(!check_status($command_args[$i]))
|
|
|
|
usage('Invalid -s/--status clause');
|
|
|
|
$params['status'] = $command_args[$i];
|
|
|
|
break;
|
|
|
|
default:
|
|
|
|
$patterns[] = $command_args[$i];
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!empty($patterns))
|
|
|
|
$params['pattern'] = implode(' ', $patterns);
|
|
|
|
|
|
|
|
$items = search_items($params);
|
|
|
|
if (!is_array($items)) {
|
|
|
|
logging("ERROR", "Invalid DB info return.\n");
|
|
|
|
return False;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($items['count'] == 0){
|
|
|
|
echo "No item.\n";
|
|
|
|
return True;
|
|
|
|
}
|
|
|
|
|
|
|
|
$tbl = new Console_Table();
|
|
|
|
$tbl->setHeaders(
|
|
|
|
array(
|
|
|
|
'ID',
|
|
|
|
'Name',
|
|
|
|
'Date',
|
|
|
|
'Status',
|
|
|
|
'Description',
|
|
|
|
)
|
|
|
|
);
|
|
|
|
foreach($items['items'] as $info) {
|
|
|
|
$tbl->addRow(
|
|
|
|
array(
|
|
|
|
$info['id'],
|
|
|
|
$info['name'],
|
|
|
|
format_time($info['date']),
|
|
|
|
$info['status'],
|
|
|
|
($info['description']?$info['description']:''),
|
|
|
|
)
|
|
|
|
);
|
|
|
|
}
|
|
|
|
echo $tbl->getTable();
|
|
|
|
echo "\n".$items['count']." item(s)\n";
|
|
|
|
return True;
|
|
|
|
}
|
|
|
|
add_cli_command(
|
|
|
|
'list',
|
|
|
|
'cli_list',
|
|
|
|
"List/search items",
|
|
|
|
"[patterns]",
|
|
|
|
array(
|
|
|
|
"-o|--orderby Ordering list criterion. Possible values :",
|
|
|
|
" - ".implode("\n - ", $orderbys),
|
|
|
|
"-r|--reverse Reverse order",
|
|
|
|
"-s|--status Filter on status. Possible values :",
|
|
|
|
" - ".implode("\n - ", array_keys($status_list)),
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
|
|
|
function cli_show($command_args) {
|
|
|
|
if (count($command_args) != 1 || !check_id($command_args[0]))
|
|
|
|
usage('You must provide a valid ID.');
|
|
|
|
|
|
|
|
$item_id = $command_args[0];
|
|
|
|
$item = get_item($item_id);
|
|
|
|
|
|
|
|
if (!$item)
|
|
|
|
logging('FATAL', "Item #$item_id not found.");
|
|
|
|
|
|
|
|
print_item_info($item);
|
|
|
|
return True;
|
|
|
|
}
|
|
|
|
add_cli_command(
|
|
|
|
'show',
|
|
|
|
'cli_show',
|
|
|
|
"Show item",
|
|
|
|
"[ID]"
|
|
|
|
);
|
|
|
|
|
|
|
|
function cli_delete($command_args) {
|
|
|
|
if (count($command_args) != 1)
|
|
|
|
usage('You must provide item ID.');
|
|
|
|
|
|
|
|
// Check URI
|
|
|
|
if (!check_id($command_args[0]))
|
|
|
|
logging('FATAL', "Invalid item ID");
|
|
|
|
|
|
|
|
// Check exist
|
|
|
|
$item_id = $command_args[0];
|
|
|
|
$item = get_item($item_id);
|
|
|
|
if (!$item)
|
|
|
|
logging('FATAL', "Item #$item_id not found.");
|
|
|
|
|
|
|
|
print_item_info($item);
|
|
|
|
|
|
|
|
// Sure ?
|
|
|
|
echo "Are you sure you want to delete this item ? Type 'yes' to continue: ";
|
|
|
|
$handle = fopen ("php://stdin","r");
|
|
|
|
$line = fgets($handle);
|
|
|
|
if(trim($line) != 'yes'){
|
|
|
|
logging('WARNING', "User cancel");
|
|
|
|
exit;
|
|
|
|
}
|
|
|
|
echo "\n";
|
|
|
|
|
|
|
|
if (!delete_item($item['id']))
|
|
|
|
logging('FATAL', "An error occured deleting item #$item_id.");
|
|
|
|
|
|
|
|
return True;
|
|
|
|
}
|
|
|
|
add_cli_command(
|
|
|
|
'delete',
|
|
|
|
'cli_delete',
|
|
|
|
"Delete item",
|
|
|
|
"[item ID]"
|
|
|
|
);
|
|
|
|
|
|
|
|
function cli_export($command_args) {
|
|
|
|
$fd = fopen((count($command_args) >= 1?$command_args[0]:'php://output'), 'w');
|
|
|
|
export_items($fd);
|
|
|
|
fclose($fd);
|
|
|
|
logging('INFO', "Items export to '".(count($command_args) >= 1?$command_args[0]:'STDOUT')."'.");
|
|
|
|
}
|
|
|
|
add_cli_command(
|
|
|
|
'export',
|
|
|
|
'cli_export',
|
|
|
|
"Export items (as CSV)",
|
|
|
|
"[output file path]"
|
|
|
|
);
|
|
|
|
|
|
|
|
function cli_restore($command_args) {
|
|
|
|
$fd = fopen((count($command_args) >= 1?$command_args[0]:'php://stdin'), 'r');
|
|
|
|
restore_items($fd);
|
|
|
|
fclose($fd);
|
|
|
|
logging('INFO', "Items restored from '".(count($command_args) >= 1?$command_args[0]:'STDIN')."'.");
|
|
|
|
}
|
|
|
|
add_cli_command(
|
|
|
|
'restore',
|
|
|
|
'cli_restore',
|
|
|
|
"Restore items (from CSV)",
|
|
|
|
"[input file path]"
|
|
|
|
);
|
|
|
|
|
|
|
|
function cli_cron($command_args) {
|
|
|
|
global $item_max_age;
|
|
|
|
if (!isset($item_max_age))
|
|
|
|
$item_max_age = 30;
|
|
|
|
|
|
|
|
$just_try = false;
|
|
|
|
for($i=0; $i < count($command_args); $i++) {
|
|
|
|
switch($command_args[$i]) {
|
|
|
|
case '-m':
|
|
|
|
case '--max-age':
|
|
|
|
$i++;
|
|
|
|
if(!check_id($command_args[$i]))
|
|
|
|
usage('Invalid -m|--max-age clause');
|
|
|
|
$item_max_age = $command_args[$i];
|
|
|
|
break;
|
|
|
|
case '-j':
|
|
|
|
case '--just-try':
|
|
|
|
$just_try = true;
|
|
|
|
break;
|
|
|
|
default:
|
|
|
|
usage('Invalid parameter '.$command_args[$i]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!is_int($item_max_age) || $item_max_age <= 0)
|
|
|
|
logging('FATAL', 'Invalid $item_max_age value set in configuration : it\'s must be a positive integer.');
|
|
|
|
logging('DEBUG', "cli_cron() : item max age = $item_max_age day(s)");
|
|
|
|
|
|
|
|
$limit = time() - ($item_max_age * 86400);
|
|
|
|
logging('DEBUG', "Handle items expiration with creation date limit ".format_time($limit).".");
|
|
|
|
|
|
|
|
$items = search_items(array('all' => true));
|
|
|
|
$error = false;
|
|
|
|
foreach($items['items'] as $item) {
|
|
|
|
if ($item['date'] < $limit) {
|
|
|
|
if ($just_try) {
|
|
|
|
logging('DEBUG', 'Just-try mode : do not really delete item #'.$item['id'].' ('.$item['name'].', creation date : '.format_time($item['date']).')');
|
|
|
|
}
|
|
|
|
else if (delete_item($item['id'])) {
|
|
|
|
logging('INFO', 'item #'.$item['id'].' ('.$item['name'].') deleted (creation date : '.format_time($item['date']).')');
|
|
|
|
remove_item_attachments($item['id']);
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
logging('ERROR', 'Fail to delete item "'.$item['id'].'" ('.$item['name'].', creation date : '.format_time($item['date']).')');
|
|
|
|
$error = true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
logging('DEBUG', 'item "'.$item['id'].'" ('.$item['name'].') still valid (creation date : '.format_time($item['date']).')');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
exit($error?1:0);
|
|
|
|
}
|
|
|
|
add_cli_command(
|
|
|
|
'cron',
|
|
|
|
'cli_cron',
|
|
|
|
"Cron to handle items expiration",
|
|
|
|
false,
|
|
|
|
array (
|
|
|
|
"-j/--just-try Just-try mode : do not really removed expired item(s)",
|
|
|
|
"-m/--max-day item expiration limit (in day, default = ".(isset($item_max_age)?$item_max_age:183).")"
|
|
|
|
)
|
|
|
|
);
|