- WIP on Cronard tasks

- Added some minors features to the API web interface
This commit is contained in:
Dave Mc Nicoll committed 2026-10-30 18:15:37 +00:00
1 parent 2d560a0857
commit a54930b6c6
10 files changed
+102 -28

No files matched your search

+14 -8
View File
@@ -4,7 +4,7 @@ use Ulmus\ConnectionAdapter;
use function DI\{ get, env }; use function DI\{ get, env };
define('LEAN_API_PROJECT_PATH', $path = dirname(__DIR__, 2)); define('LEAN_API_PROJECT_PATH', dirname(__DIR__, 2));
return [ return [
'lean.api' => [ 'lean.api' => [
@@ -13,25 +13,29 @@ return [
'view' => [ 'view' => [
[ [
'path' => implode(DIRECTORY_SEPARATOR, [ $path , "view", '' ]), 'path' => implode(DIRECTORY_SEPARATOR, [ LEAN_API_PROJECT_PATH , "view", '' ]),
'order' => 99, 'order' => 99,
], ],
], ],
'asset' => [ 'asset' => [
[ [
'path' => implode(DIRECTORY_SEPARATOR, [ $path, "asset", '' ]), 'path' => implode(DIRECTORY_SEPARATOR, [ LEAN_API_PROJECT_PATH, "asset", '' ]),
'order' => 10 'order' => 10
], ],
], ],
], ],
'cli' => [ 'cli' => [
'Lean\\Api\\Cli' => implode(DIRECTORY_SEPARATOR, [ $path, "src", "Cli", "" ]), 'Lean\\Api\\Cli' => implode(DIRECTORY_SEPARATOR, [ LEAN_API_PROJECT_PATH, "src", "Cli", "" ]),
],
'cronard' => [
'Lean\\Api\\Cronard' => implode(DIRECTORY_SEPARATOR, [ LEAN_API_PROJECT_PATH, 'src', 'Cronard', '' ]),
], ],
'ulmus' => [ 'ulmus' => [
'entities' => [ 'Lean\\Api\\Entity' => implode(DIRECTORY_SEPARATOR, [ $path, 'src', 'Entity', '' ]) ], 'entities' => [ 'Lean\\Api\\Entity' => implode(DIRECTORY_SEPARATOR, [ LEAN_API_PROJECT_PATH, 'src', 'Entity', '' ]) ],
'adapters' => [ 'adapters' => [
DI\get('lean.api:storage'), DI\get('lean.api:storage'),
] ]
@@ -40,15 +44,17 @@ return [
'tell' => [ 'tell' => [
'json' => [ 'json' => [
[ [
'path' => implode(DIRECTORY_SEPARATOR, [ $path, "meta", "i18n", "" ]), 'path' => implode(DIRECTORY_SEPARATOR, [ LEAN_API_PROJECT_PATH, "meta", "i18n", "" ]),
'order' => 99, 'order' => 99,
], ],
] ]
], ],
'routes' => [ 'routes' => [
'Lean\\Api\\Controller' => implode(DIRECTORY_SEPARATOR, [ $path, "src", "Controller", "" ]), 'Lean\\Api\\Controller' => implode(DIRECTORY_SEPARATOR, [ LEAN_API_PROJECT_PATH, "src", "Controller", "" ]),
], ] + (getenv('DEBUG') ? [
'Lean\\Api\\Cronard' => implode(DIRECTORY_SEPARATOR, [ LEAN_API_PROJECT_PATH, 'src', 'Cronard', '' ]),
]: []),
], ],
'app.middlewares' => \DI\add([ 'app.middlewares' => \DI\add([
+19
View File
@@ -0,0 +1,19 @@
# LEAN API
## Automated tasks
--------------------------------------------------------------------------------
### Routes
{route:descriptor}
{request:debugger}
### Forms / actions
{form:descriptor}
### Entities
{entity:descriptor}
+43 -11
View File
@@ -2,32 +2,64 @@
namespace Lean\Api\Cronard; namespace Lean\Api\Cronard;
use CSSLSJ\TransportScolaire\Api\{Controller\Api, Entity, Form, Lib}; use Lean\Api\{Controller, Entity, Form, Lib};
use Notes\Breadcrumb\Attribute\Method\Breadcrumb; use DI\Attribute\Inject;
use Notes\Cronard\Attribute\Method\Cronard; use Notes\Cronard\Attribute\Method\Cronard;
use Notes\Route\Attribute\Method\Route; use Notes\Route\Attribute\Method\Route;
use Notes\Route\Attribute\Object\Route as RouteObj; use Notes\Route\Attribute\Object\Route as RouteObj;
use Notes\Security\Attribute\Taxus; use Psr\Container\ContainerInterface;
use Psr\Http\Message\{ResponseInterface, ServerRequestInterface}; use Psr\Http\Message\{ResponseInterface, ServerRequestInterface};
use Storage\{Cookie, Session}; use ZipArchive;
use TheBugs\Email\MailerInterface;
use function CSSLSJ\TransportScolaire\Api\View\{form, route};
##[Taxus(Entity\UserTypeEnum::Developer)] ##[Taxus(Entity\UserTypeEnum::Developer)]
#[RouteObj(base: "/lean/cronard")] #[RouteObj(base: "/lean/cronard")]
class System { class System {
use Lib\ControllerTrait; use Lib\ControllerTrait;
#[Route("/", name: "lean-api.cronard:documentation", method: "GET", description: "Route de documentation pour cette section")] protected int $weekRetention = 4;
#[Inject]
protected ContainerInterface $container;
#[Route("/", name: "lean-api.cronard:documentation", method: "GET", description: "Documentation route for ")]
public function documentation(ServerRequestInterface $request, array $arguments) : ResponseInterface public function documentation(ServerRequestInterface $request, array $arguments) : ResponseInterface
{ {
return $this->renderMarkdown(getenv("PROJECT_PATH") . "/meta/docs/cronard.md", [ ], []); return $this->renderMarkdown(LEAN_API_PROJECT_PATH . "/meta/docs/cronard.md", [ ], []);
} }
#[Cronard('0 0 1 * *')] #[Cronard(cron: '30 3 1 * *', method: 'DELETE')]
#[Route("/clean/request-logs", name: "lean-api.cronard:clean-request-logs", method: ["DELETE"], description: "Fait le ménage automatiquement des logs de requêtes datant de plus d'un an")] #[Route("/clean/request-logs", name: "lean-api.cronard:clean-request-logs", method: ["DELETE"], description: "Fait le ménage automatiquement des logs de requêtes")]
public function clean_request_logs(ServerRequestInterface $request, array $arguments): ResponseInterface public function clean_request_logs(ServerRequestInterface $request, array $arguments): ResponseInterface
{ {
# return $this->outputSearchResult($results); $date = new Entity\Field\Datetime()->sub(new \DateInterval("P{$this->weekRetention}W"));
$count = Entity\Security\ApiRequestLog::repository()
->where(Entity\Security\ApiRequestLog::field('createdAt'), $date, '<=')
->count();
if ($count) {
$table = Entity\Security\ApiRequestLog::resolveEntity()->tableName();
$zipPath = getenv('LOGS_PATH') . DIRECTORY_SEPARATOR . sprintf("lean-api.%s-%s.zip", $table, date('Ymm_Hi'));
$dbPath = $this->container->get('config')['ulmus']['connections'][Entity\Security\ApiRequestLog::repository()->adapter->name]['path'];
$zip = new ZipArchive();
$zip->open($zipPath, ZipArchive::CREATE | ZipArchive::OVERWRITE);
$sqlDump = shell_exec(sprintf("sqlite3 %s \".dump %s\"", $dbPath, $table));
$zip->addFromString('lean-api.sqlite3', $sqlDump);
$zip->close();
$count = Entity\Security\ApiRequestLog::repository()
->where(Entity\Security\ApiRequestLog::field('createdAt', false), $date, '<=')
->deleteAll();
return $this->renderJson([
'data' => [
'count' => $count
]
]);
}
return $this->renderNothing();
} }
} }
+1 -1
View File
@@ -21,7 +21,7 @@ class ApiActionLog implements EntityInterface, \JsonSerializable
public int $id; public int $id;
#[Field\ForeignKey(name: "object_id"), EntityField(field: "object_id")] #[Field\ForeignKey(name: "object_id"), EntityField(field: "object_id")]
public int $objectId; public int|array $objectId;
#[Field(name: "object_type"), EntityField(field: "object_type")] #[Field(name: "object_type"), EntityField(field: "object_type")]
public string $objectType; public string $objectType;
+15 -4
View File
@@ -5,6 +5,7 @@ namespace Lean\Api\Form\Security;
use CSSLSJ\TransportScolaire\Api\{Entity}; use CSSLSJ\TransportScolaire\Api\{Entity};
use Lean\Api\Attribute\ContextField; use Lean\Api\Attribute\ContextField;
use Lean\Api\Lib\FormContext; use Lean\Api\Lib\FormContext;
use Ulmus\Attribute\IndexTypeEnum;
use Ulmus\Entity\EntityInterface; use Ulmus\Entity\EntityInterface;
use Ulmus\Event\Entity\DatasetFill; use Ulmus\Event\Entity\DatasetFill;
use Ulmus\Ulmus; use Ulmus\Ulmus;
@@ -21,7 +22,7 @@ class ActionLogContext extends FormContext
public string $method; public string $method;
#[ContextField(mandatory: true)] #[ContextField(mandatory: true)]
public int $object_id; public int|array $object_id;
#[ContextField(mandatory: true)] #[ContextField(mandatory: true)]
public string $object_type; public string $object_type;
@@ -60,14 +61,24 @@ class ActionLogContext extends FormContext
public function initializeEntity(\Lean\Api\Entity\Security\ApiActionLog $actionLog) : void public function initializeEntity(\Lean\Api\Entity\Security\ApiActionLog $actionLog) : void
{ {
if (isset($this->entity) && $this->entity->isLoaded()) { if (isset($this->entity) && $this->entity->isLoaded()) {
if ($pk = array_key_first($this->entity::resolveEntity()->getPrimaryKeyField())) {
if (isset($this->entity->$pk)) {
$this->object_id = $this->entity->$pk;
$this->object_type = $this->entity::class; $this->object_type = $this->entity::class;
if (isset($this->datasetFillEvent->data)) { if (isset($this->datasetFillEvent->data)) {
$this->data = $this->datasetFillEvent->data; $this->data = $this->datasetFillEvent->data;
} }
$pk = $this->entity::resolveEntity()->getPrimaryKeyField();
if ($pk) {
$pk = array_key_first($this->entity::resolveEntity()->getPrimaryKeyField());
if (isset($this->entity->$pk)) {
$this->object_id = $this->entity->$pk;
}
}
elseif ($index = $this->entity::resolveEntity()->getCompoundKeyFields()) {
if ($index->type === IndexTypeEnum::Primary) {
$this->object_id = array_combine($index->column, array_map(fn($e) => $this->entity->$e ?? null, $index->column));
} }
} }
} }
+1 -1
View File
@@ -120,6 +120,6 @@
</div> </div>
{% endif %} {% endif %}
{% or %} {% or %}
<i style="color:#585858; padding:0 12px">{% _ "none" %}</i> <i class="nothing-found">{% _ "none" %}</i>
{% endforeach %} {% endforeach %}
</div> </div>
+1 -1
View File
@@ -59,6 +59,6 @@
{% endif %} {% endif %}
</div> </div>
{% or %} {% or %}
<i style="color:#585858; padding:0 12px">{% _ "none" %}</i> <i class="nothing-found">{% _ "none" %}</i>
{% endforeach %} {% endforeach %}
</div> </div>
+5 -1
View File
@@ -56,7 +56,10 @@
.request-head .url button:active {filter:contrast(85%);} .request-head .url button:active {filter:contrast(85%);}
.response-head {display: flex;border:1px solid #ececec;margin-bottom: 5px;border-top:0} .response-head {display: flex;border:1px solid #ececec;margin-bottom: 5px;border-top:0}
.response-head .response-code {background:#dfdfdf;padding:0 8px;font-weight: bold;line-height: 29px;font-size: 80%;} .response-head[data-code="200"] .response-code{background: #cdfbbd;}
.response-head[data-code="204"] .response-code{background: #eaeab5;}
.response-head[data-code^="5"] .response-code{background: #ffa8a8;}
.response-head .response-code {background:#dfdfdf;padding:0 8px;font-weight: bold;line-height: 30px;font-size: 80%;}
.response-head .response-message {padding:0 10px;background:#fbfbfb;line-height: 30px;font-size: 80%;} .response-head .response-message {padding:0 10px;background:#fbfbfb;line-height: 30px;font-size: 80%;}
.request-compose {position:relative;} .request-compose {position:relative;}
@@ -157,6 +160,7 @@
launchRequest(requestMethod, input.value, editor.getValue()) launchRequest(requestMethod, input.value, editor.getValue())
.then((response) => { .then((response) => {
responseHead.setAttribute("data-code", response.status);
responseHead.querySelector('.response-code').innerText = response.status; responseHead.querySelector('.response-code').innerText = response.status;
responseHead.querySelector('.response-message').innerText = response.statusText; responseHead.querySelector('.response-message').innerText = response.statusText;
+1 -1
View File
@@ -28,7 +28,7 @@
</small> </small>
</li> </li>
{% or %} {% or %}
<i style="color:#585858; padding:0 12px">{% _ "none" %}</i> <i class="nothing-found">{% _ "none" %}</i>
{% endforeach %} {% endforeach %}
{% endforeach %} {% endforeach %}
</ul> </ul>
+2
View File
@@ -38,6 +38,8 @@
.header-fields {color: #fff;line-height: 1.8rem;font-variant: small-caps;padding: 4px 0.8rem 0 0.8rem} .header-fields {color: #fff;line-height: 1.8rem;font-variant: small-caps;padding: 4px 0.8rem 0 0.8rem}
/*.fields-wrapper {border-left: 3px solid #c14141; margin-left: -10px; padding-left: 10px;}*/ /*.fields-wrapper {border-left: 3px solid #c14141; margin-left: -10px; padding-left: 10px;}*/
.nothing-found {color:#585858; padding:0 12px;font-size: 75%;}
.forms ol {background: #ccdef2;} .forms ol {background: #ccdef2;}
.forms li {border-color: #859aae;} .forms li {border-color: #859aae;}
.forms .btn {display: flex;justify-content: center;align-items: center;padding: 0 15px;gap: 15px;background-color:#4b6080;outline: 1px #4b6080 solid;border: 4px solid #9cc5e6;outline-offset: -3px;border-radius: 5px;cursor: pointer;transition: 400ms;color: white;font-weight: 100;font-size: 0.85em;transition-duration: 400ms;} .forms .btn {display: flex;justify-content: center;align-items: center;padding: 0 15px;gap: 15px;background-color:#4b6080;outline: 1px #4b6080 solid;border: 4px solid #9cc5e6;outline-offset: -3px;border-radius: 5px;cursor: pointer;transition: 400ms;color: white;font-weight: 100;font-size: 0.85em;transition-duration: 400ms;}