eesyphp/example/includes/cli.php

291 lines
7.2 KiB
PHP
Raw Normal View History

2020-04-18 00:51:33 +02:00
<?php
use EesyPHP\Check;
2023-01-30 00:11:26 +01:00
use EesyPHP\Cli;
use EesyPHP\Date;
use EesyPHP\Log;
2024-02-02 18:19:38 +01:00
use EesyPHPExample\Db;
use EesyPHPExample\Db\Item;
2024-02-02 18:19:38 +01:00
use function EesyPHP\___;
2020-04-18 00:51:33 +02:00
/*
2022-04-24 17:43:44 +02:00
*************************************************************************************************
2020-04-18 00:51:33 +02:00
* /!\ Code after this message will only be execute on CLI context /!\
2022-04-24 17:43:44 +02:00
*************************************************************************************************
2020-04-18 00:51:33 +02:00
*/
if (php_sapi_name() != "cli")
2022-04-24 17:43:44 +02:00
return true;
2020-11-18 18:33:39 +01:00
2020-04-18 00:51:33 +02:00
/**
* CLI Helpers
**/
function print_item_info($item) {
printf(_("Item #%s:\n"), $item->id);
printf("\t"._("ID: %s")."\n", $item->id);
printf("\t"._("Name: '%s'")."\n", $item->name);
printf("\t"._("Date: %s")."\n", Date :: format($item->date));
2022-04-24 17:43:44 +02:00
printf(
"\t"._("Description: %s")."\n",
($item->description?"'".$item->description."'":_("Not set"))
2022-04-24 17:43:44 +02:00
);
printf("\t"._("Status: %s")."\n", $item->status);
2022-04-24 17:43:44 +02:00
return true;
2020-04-18 00:51:33 +02:00
}
/**
* Common CLI commands
**/
function cli_list($command_args) {
2022-04-24 17:43:44 +02:00
global $orderbys;
$params = array(
'filters' => [],
'order' => Item :: default_order(),
2022-04-24 17:43:44 +02:00
'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], Item :: possible_orders()))
2023-01-30 00:11:26 +01:00
Cli :: usage('Invalid --orderby clause');
2022-04-24 17:43:44 +02:00
$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]))
2023-01-30 00:11:26 +01:00
Cli :: usage('Invalid -s/--status clause');
$params['filters']['status'] = $command_args[$i];
2022-04-24 17:43:44 +02:00
break;
default:
$patterns[] = $command_args[$i];
}
}
if (!empty($patterns))
$params['pattern'] = implode(' ', $patterns);
$items = Item :: search($params);
2022-04-24 17:43:44 +02:00
if (!is_array($items)) {
Log :: error("Invalid DB info return.\n");
2022-04-24 17:43:44 +02:00
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,
Date :: format($info->date),
$info->status,
($info->description?$info->description:''),
2022-04-24 17:43:44 +02:00
)
);
}
echo $tbl->getTable();
echo "\n".sprintf(_("%d item(s)"), $items['count'])."\n";
return True;
2020-04-18 00:51:33 +02:00
}
2023-01-30 00:11:26 +01:00
Cli :: add_command(
2022-04-24 17:43:44 +02:00
'list',
'cli_list',
___("List/search items"),
___("[patterns]"),
2022-04-24 17:43:44 +02:00
array(
___("-o|--orderby Ordering list criterion. Possible values:"),
" - ".implode("\n - ", Item :: possible_orders()),
___("-r|--reverse Reverse order"),
___("-s|--status Filter on status. Possible values:"),
2022-04-24 17:43:44 +02:00
" - ".implode("\n - ", array_keys($status_list)),
)
2020-04-18 00:51:33 +02:00
);
function cli_show($command_args) {
if (count($command_args) != 1 || !Check :: id($command_args[0]))
2023-01-30 00:11:26 +01:00
Cli :: usage(_('You must provide a valid ID.'));
2020-04-18 00:51:33 +02:00
$item_id = $command_args[0];
$item = Item :: get($item_id);
2020-04-18 00:51:33 +02:00
2022-04-24 17:43:44 +02:00
if (!$item)
Log :: fatal(_("Item #%s not found."), $item_id);
2020-04-18 00:51:33 +02:00
2022-04-24 17:43:44 +02:00
print_item_info($item);
return True;
2020-04-18 00:51:33 +02:00
}
2023-01-30 00:11:26 +01:00
Cli :: add_command(
2022-04-24 17:43:44 +02:00
'show',
'cli_show',
___("Show item"),
___("[ID]")
2020-04-18 00:51:33 +02:00
);
function cli_delete($command_args) {
2022-04-24 17:43:44 +02:00
if (count($command_args) != 1)
2023-01-30 00:11:26 +01:00
Cli :: usage(_('You must provide item ID.'));
2022-04-24 17:43:44 +02:00
// Check URI
if (!Check :: id($command_args[0]))
Log :: fatal(_("Invalid item ID"));
2022-04-24 17:43:44 +02:00
// Check exist
$item_id = $command_args[0];
$item = Item :: get($item_id);
2022-04-24 17:43:44 +02:00
if (!$item)
Log :: fatal(_("Item #%s not found."), $item_id);
2022-04-24 17:43:44 +02:00
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'){
Log :: warning(_("User cancel"));
2022-04-24 17:43:44 +02:00
exit;
}
echo "\n";
if (!$item -> delete())
Log :: fatal(_("An error occurred deleting item #%d."), $item_id);
2022-04-24 17:43:44 +02:00
return True;
2020-04-18 00:51:33 +02:00
}
2023-01-30 00:11:26 +01:00
Cli :: add_command(
2022-04-24 17:43:44 +02:00
'delete',
'cli_delete',
___("Delete item"),
___("[item ID]")
2020-04-18 00:51:33 +02:00
);
function cli_export($command_args) {
2022-04-24 17:43:44 +02:00
$fd = fopen((count($command_args) >= 1?$command_args[0]:'php://output'), 'w');
Item :: export($fd);
2022-04-24 17:43:44 +02:00
fclose($fd);
Log :: info("Items export to '".(count($command_args) >= 1?$command_args[0]:'STDOUT')."'.");
2020-04-18 00:51:33 +02:00
}
2023-01-30 00:11:26 +01:00
Cli :: add_command(
2022-04-24 17:43:44 +02:00
'export',
'cli_export',
___("Export items (as CSV)"),
___("[output file path]")
2020-04-18 00:51:33 +02:00
);
function cli_restore($command_args) {
2022-04-24 17:43:44 +02:00
$fd = fopen((count($command_args) >= 1?$command_args[0]:'php://stdin'), 'r');
Item :: restore($fd);
2022-04-24 17:43:44 +02:00
fclose($fd);
Log :: info(
"Items restored from '%s'",
2022-04-24 17:43:44 +02:00
(count($command_args) >= 1?$command_args[0]:'STDIN')
);
2020-04-18 00:51:33 +02:00
}
2023-01-30 00:11:26 +01:00
Cli :: add_command(
2022-04-24 17:43:44 +02:00
'restore',
'cli_restore',
___("Restore items (from CSV)"),
___("[input file path]")
2020-04-18 00:51:33 +02:00
);
function cli_cron($command_args) {
2022-04-24 17:43:44 +02:00
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]))
2023-01-30 00:11:26 +01:00
Cli :: usage('Invalid -m|--max-age clause');
2022-04-24 17:43:44 +02:00
$item_max_age = $command_args[$i];
break;
case '-j':
case '--just-try':
$just_try = true;
break;
default:
2023-01-30 00:11:26 +01:00
Cli :: usage('Invalid parameter '.$command_args[$i]);
2022-04-24 17:43:44 +02:00
}
}
if (!is_int($item_max_age) || $item_max_age <= 0)
Log :: fatal(
2022-04-24 17:43:44 +02:00
'Invalid $item_max_age value set in configuration: it\'s must be a positive integer.');
Log :: debug("cli_cron(): item max age = $item_max_age day(s)");
2022-04-24 17:43:44 +02:00
$limit = Date :: from_timestamp(time() - ($item_max_age * 86400));
Log :: debug("Handle items expiration with creation date limit ".Date :: format($limit).".");
2022-04-24 17:43:44 +02:00
$items = Item :: search(array('all' => true));
2022-04-24 17:43:44 +02:00
$error = false;
foreach($items['items'] as $item) {
if ($item -> date < $limit) {
2022-04-24 17:43:44 +02:00
if ($just_try) {
Log :: debug('Just-try mode: do not really delete item #%s (%s, creation date: %s)',
$item->id, $item->name, Date :: format($item->date)
);
2022-04-24 17:43:44 +02:00
}
else if ($item->delete()) {
Log :: info('Item #%s (%s) deleted (creation date: %s)',
$item->id, $item->name, Date :: format($item->date)
);
2022-04-24 17:43:44 +02:00
}
else {
Log :: error('Fail to delete item "%s" (%s, creation date: %s)',
$item->id, $item->name, Date :: format($item->date)
);
2022-04-24 17:43:44 +02:00
$error = true;
}
}
else {
Log :: debug('Item "%s" (%s) still valid (creation date: %s)',
$item->id, $item->name, Date :: format($item->date)
);
2022-04-24 17:43:44 +02:00
}
}
return !$error;
2020-04-18 00:51:33 +02:00
}
2023-01-30 00:11:26 +01:00
Cli :: add_command(
2022-04-24 17:43:44 +02:00
'cron',
'cli_cron',
___("Cron to handle item expiration"),
2023-01-30 00:11:26 +01:00
null,
2022-04-24 17:43:44 +02:00
array (
___("-j/--just-try Just-try mode : do not really removed expired item(s)"),
___("-m/--max-age Item expiration limit (in days, optional)"),
2022-04-24 17:43:44 +02:00
)
2020-04-18 00:51:33 +02:00
);
# vim: tabstop=2 shiftwidth=2 softtabstop=2 expandtab