+
'; - } +
+ listAll('rpm');
-$newRepoDebSourcesList = $mysource->listAll('deb');
-$newRepoFormGroupList = $mygroup->listAll();
+// New repo form variables
+$rpmSourcesList = $sourceController->listAll('rpm');
+$debSourcesList = $sourceController->listAll('deb');
+// Retrieve the groups, the tags and the recipients to build the target selectors
+$groups = $groupController->listAll();
+$tags = $repoListingController->listTags();
$usersEmail = $userController->getEmails();
-unset($userController);
+unset($targetController, $groupController, $repoListingController, $userController, $sourceController);
diff --git a/www/controllers/Layout/Panel/vars/repos/rename.vars.inc.php b/www/controllers/Layout/Panel/vars/repos/rename.vars.inc.php
new file mode 100644
index 000000000..646c0499a
--- /dev/null
+++ b/www/controllers/Layout/Panel/vars/repos/rename.vars.inc.php
@@ -0,0 +1,24 @@
+get('rename', json_decode($item['repos'], true));
+} catch (JsonException $e) {
+ throw new Exception('Error while retrieving the form content: ' . $e->getMessage());
+}
diff --git a/www/controllers/Layout/Panel/vars/repos/scheduled-task.vars.inc.php b/www/controllers/Layout/Panel/vars/repos/scheduled-task.vars.inc.php
new file mode 100644
index 000000000..ac624f00a
--- /dev/null
+++ b/www/controllers/Layout/Panel/vars/repos/scheduled-task.vars.inc.php
@@ -0,0 +1,38 @@
+getValidActions() as $action) {
+ if (RepoPermission::allowedAction($action)) {
+ $allowedActions[] = $action;
+ }
+}
+
+if (empty($allowedActions)) {
+ throw new Exception('You are not allowed to access this panel');
+}
+
+// Human readable title for each action
+$actionsTitles = [
+ 'update' => 'Update repositories',
+ 'env' => 'Point an environment',
+ 'rebuild' => 'Rebuild repositories metadata'
+];
+
+// Retrieve the groups, the tags and the recipients to build the target selectors
+$groups = $groupController->listAll(true);
+$tags = $repoListingController->listTags();
+$usersEmail = $userController->getEmails();
+
+unset($targetController, $groupController, $repoListingController, $userController);
diff --git a/www/controllers/Layout/Panel/vars/repos/settings.vars.inc.php b/www/controllers/Layout/Panel/vars/repos/settings.vars.inc.php
new file mode 100644
index 000000000..67dbb542d
--- /dev/null
+++ b/www/controllers/Layout/Panel/vars/repos/settings.vars.inc.php
@@ -0,0 +1,12 @@
+get($_SESSION['id']);
+
+unset($userPreferenceController);
diff --git a/www/controllers/Layout/Panel/vars/settings/user/permissions.vars.inc.php b/www/controllers/Layout/Panel/vars/settings/user/permissions.vars.inc.php
index 7eeacd0d5..49c9e4c2c 100644
--- a/www/controllers/Layout/Panel/vars/settings/user/permissions.vars.inc.php
+++ b/www/controllers/Layout/Panel/vars/settings/user/permissions.vars.inc.php
@@ -1,6 +1,7 @@
get($userId);
-/**
- * Get repositories groups
- */
+// Get repositories groups
$groupsList = $groupController->listAll(true);
+
+// Get repositories, deduplicated by repository Id as the listing returns one row per snapshot and environment
+$reposList = [];
+
+foreach ($repoListingController->list() as $repo) {
+ if (isset($reposList[$repo['repoId']])) {
+ continue;
+ }
+
+ $label = $repo['Name'];
+
+ if ($repo['Package_type'] == 'deb') {
+ $label .= ' ❯ ' . $repo['Dist'] . ' ❯ ' . $repo['Section'];
+ }
+
+ if ($repo['Package_type'] == 'rpm' and !empty($repo['Releasever'])) {
+ $label .= ' ❯ ' . $repo['Releasever'];
+ }
+
+ $reposList[$repo['repoId']] = $label;
+}
diff --git a/www/controllers/Layout/Panel/vars/snapshot/rebuild.vars.inc.php b/www/controllers/Layout/Panel/vars/snapshot/rebuild.vars.inc.php
new file mode 100644
index 000000000..0792cb0ad
--- /dev/null
+++ b/www/controllers/Layout/Panel/vars/snapshot/rebuild.vars.inc.php
@@ -0,0 +1,38 @@
+getAllById(null, $snapId);
+
+// Retrieve snapshot rebuild status
+$rebuild = $repoController->getRebuild();
+
+if (!empty($rebuild) and $rebuild == 'running') {
+ throw new Exception('Snapshot metadata rebuild is currently running. You cannot rebuild metadata at this time.');
+}
+
+// Define if the GPG signature checkbox should be checked by default
+if ($repoController->getPackageType() == 'rpm' && RPM_SIGN_PACKAGES == 'true') {
+ $gpgSignChecked = 'checked';
+}
+if ($repoController->getPackageType() == 'deb' && DEB_SIGN_REPO == 'true') {
+ $gpgSignChecked = 'checked';
+}
diff --git a/www/controllers/Layout/Panel/vars/snapshot/upload.vars.inc.php b/www/controllers/Layout/Panel/vars/snapshot/upload.vars.inc.php
new file mode 100644
index 000000000..e657e6992
--- /dev/null
+++ b/www/controllers/Layout/Panel/vars/snapshot/upload.vars.inc.php
@@ -0,0 +1,47 @@
+getAllById(null, $snapId);
+
+// Retrieve snapshot rebuild status
+$rebuild = $repoController->getRebuild();
+
+// Define snapshot path
+if ($repoController->getPackageType() == 'rpm') {
+ $snapshotPath = REPOS_DIR . '/rpm/' . $repoController->getName() . '/' . $repoController->getReleasever() . '/' . $repoController->getDate();
+}
+
+if ($repoController->getPackageType() == 'deb') {
+ $snapshotPath = REPOS_DIR . '/deb/' . $repoController->getName() . '/' . $repoController->getDist() . '/' . $repoController->getSection() . '/' . $repoController->getDate();
+}
+
+// Check if the snapshot path exists
+if (!is_dir($snapshotPath)) {
+ throw new Exception('Snapshot path does not exist on the server');
+}
+
+// If a task is already running on this repo then print a message
+if (!empty($rebuild) and $rebuild == 'running') {
+ throw new Exception('A task is running on this repository snapshot. You cannot upload packages at this time.');
+}
diff --git a/www/controllers/Layout/Panel/vars/tasks/edit.vars.inc.php b/www/controllers/Layout/Panel/vars/tasks/edit.vars.inc.php
index d1a221997..f5f6cb637 100644
--- a/www/controllers/Layout/Panel/vars/tasks/edit.vars.inc.php
+++ b/www/controllers/Layout/Panel/vars/tasks/edit.vars.inc.php
@@ -1,9 +1,11 @@
1) {
- $output .= '';
+ $output .= '';
}
// First page button (n°1)
@@ -108,7 +108,7 @@ public static function paginationBtn($currentPage, $totalPages): void
// Next button
if ($currentPage < $totalPages) {
- $output .= '';
+ $output .= '';
}
echo $output;
diff --git a/www/controllers/Layout/Table/vars/host/installed-packages.vars.inc.php b/www/controllers/Layout/Table/vars/host/installed-packages.vars.inc.php
new file mode 100644
index 000000000..be881cb92
--- /dev/null
+++ b/www/controllers/Layout/Table/vars/host/installed-packages.vars.inc.php
@@ -0,0 +1,34 @@
+countInventory($search);
+
+// If offset is out of range, reset it to 0
+if ($reloadableTableOffset >= $reloadableTableTotalItems) {
+ $reloadableTableOffset = 0;
+}
+
+// Get list of inventoried packages, with offset and optional search filter
+$reloadableTableContent = $hostPackageController->getInventory($search, true, $reloadableTableOffset);
+
+// Count total pages for the pagination
+$reloadableTableTotalPages = (int) ceil($reloadableTableTotalItems / 10);
+
+// Calculate current page number
+$reloadableTableCurrentPage = (int) ceil($reloadableTableOffset / 10) + 1;
+
+unset($hostPackageController);
diff --git a/www/controllers/Layout/Table/vars/stats/access.vars.inc.php b/www/controllers/Layout/Table/vars/stats/access.vars.inc.php
index 419945087..f6ca42fc7 100644
--- a/www/controllers/Layout/Table/vars/stats/access.vars.inc.php
+++ b/www/controllers/Layout/Table/vars/stats/access.vars.inc.php
@@ -7,20 +7,18 @@
$timeEnd = strtotime(DATE_YMD . ' 23:59:59');
$envs = [];
-if (__ACTUAL_URI__[2] != 'repo') {
- throw new Exception('Error: invalid URI specified.');
+// Check that repository Id is specified
+if (empty(__ACTUAL_URI__[2])) {
+ throw new Exception('no repository ID specified');
}
-if (empty(__ACTUAL_URI__[3])) {
- throw new Exception('Error: missing repository ID.');
-}
-
-if (!is_numeric(__ACTUAL_URI__[3])) {
- throw new Exception('Error: invalid repository ID specified.');
+// Check that repository Id is valid
+if (!is_numeric(__ACTUAL_URI__[2])) {
+ throw new Exception('invalid repository ID');
}
// Get repository info
-$repoController->getAllById(__ACTUAL_URI__[3]);
+$repoController->getAllById(__ACTUAL_URI__[2]);
// Retrieve period from cookie if exists
if (!empty($_COOKIE['tables/stats/access/period'])) {
diff --git a/www/controllers/Layout/Table/vars/stats/ip-access.vars.inc.php b/www/controllers/Layout/Table/vars/stats/ip-access.vars.inc.php
index 6fd256bf4..269ac6f2c 100644
--- a/www/controllers/Layout/Table/vars/stats/ip-access.vars.inc.php
+++ b/www/controllers/Layout/Table/vars/stats/ip-access.vars.inc.php
@@ -7,16 +7,18 @@
$timeEnd = strtotime(DATE_YMD . ' 23:59:59');
$envs = [];
-if (empty(__ACTUAL_URI__[3])) {
- throw new Exception('Error: missing repository ID.');
+// Check that repository Id is specified
+if (empty(__ACTUAL_URI__[2])) {
+ throw new Exception('no repository ID specified');
}
-if (!is_numeric(__ACTUAL_URI__[3])) {
- throw new Exception('Error: invalid repository ID specified.');
+// Check that repository Id is valid
+if (!is_numeric(__ACTUAL_URI__[2])) {
+ throw new Exception('invalid repository ID');
}
// Get repository info
-$repoController->getAllById(__ACTUAL_URI__[3]);
+$repoController->getAllById(__ACTUAL_URI__[2]);
// Retrieve period from cookie if exists
if (!empty($_COOKIE['tables/stats/ip-access/period'])) {
diff --git a/www/controllers/Layout/Table/vars/tasks/list-children.vars.inc.php b/www/controllers/Layout/Table/vars/tasks/list-children.vars.inc.php
new file mode 100644
index 000000000..a330d4b0d
--- /dev/null
+++ b/www/controllers/Layout/Table/vars/tasks/list-children.vars.inc.php
@@ -0,0 +1,24 @@
+getByParentId($parentTaskId, true, $reloadableTableOffset);
+
+// Get list of ALL sub-tasks, without offset, for the total count
+$reloadableTableTotalItems = count($taskListingController->getByParentId($parentTaskId));
+
+// Count total pages for the pagination
+$reloadableTableTotalPages = ceil($reloadableTableTotalItems / 10);
+
+// Calculate current page number
+$reloadableTableCurrentPage = ceil($reloadableTableOffset / 10) + 1;
diff --git a/www/controllers/Layout/Table/vars/tasks/list-done.vars.inc.php b/www/controllers/Layout/Table/vars/tasks/list-done.vars.inc.php
index c6635dc6c..e88d4c393 100644
--- a/www/controllers/Layout/Table/vars/tasks/list-done.vars.inc.php
+++ b/www/controllers/Layout/Table/vars/tasks/list-done.vars.inc.php
@@ -1,31 +1,21 @@
getDone('', true, $reloadableTableOffset);
-/**
- * Get list of ALL done tasks, without offset, for the total count
- */
+// Get list of ALL done tasks, without offset, for the total count
$reloadableTableTotalItems = count($taskListingController->getDone());
-/**
- * Count total pages for the pagination
- */
+// Count total pages for the pagination
$reloadableTableTotalPages = ceil($reloadableTableTotalItems / 10);
-/**
- * Calculate current page number
- */
+// Calculate current page number
$reloadableTableCurrentPage = ceil($reloadableTableOffset / 10) + 1;
diff --git a/www/controllers/Layout/Table/vars/tasks/list-queued.vars.inc.php b/www/controllers/Layout/Table/vars/tasks/list-queued.vars.inc.php
index 99bb55784..8e6bce488 100644
--- a/www/controllers/Layout/Table/vars/tasks/list-queued.vars.inc.php
+++ b/www/controllers/Layout/Table/vars/tasks/list-queued.vars.inc.php
@@ -1,31 +1,21 @@
getQueued('', true, $reloadableTableOffset);
-/**
- * Get list of ALL queued tasks, without offset, for the total count
- */
+// Get list of ALL queued tasks, without offset, for the total count
$reloadableTableTotalItems = count($taskListingController->getQueued());
-/**
- * Count total pages for the pagination
- */
+// Count total pages for the pagination
$reloadableTableTotalPages = ceil($reloadableTableTotalItems / 10);
-/**
- * Calculate current page number
- */
+// Calculate current page number
$reloadableTableCurrentPage = ceil($reloadableTableOffset / 10) + 1;
diff --git a/www/controllers/Layout/Table/vars/tasks/list-running.vars.inc.php b/www/controllers/Layout/Table/vars/tasks/list-running.vars.inc.php
index 65f9a5728..065290e3d 100644
--- a/www/controllers/Layout/Table/vars/tasks/list-running.vars.inc.php
+++ b/www/controllers/Layout/Table/vars/tasks/list-running.vars.inc.php
@@ -1,31 +1,21 @@
getRunning('', true, $reloadableTableOffset);
-/**
- * Get list of ALL running tasks, without offset, for the total count
- */
+// Get list of ALL running tasks, without offset, for the total count
$reloadableTableTotalItems = count($taskListingController->getRunning());
-/**
- * Count total pages for the pagination
- */
+// Count total pages for the pagination
$reloadableTableTotalPages = ceil($reloadableTableTotalItems / 10);
-/**
- * Calculate current page number
- */
+// Calculate current page number
$reloadableTableCurrentPage = ceil($reloadableTableOffset / 10) + 1;
diff --git a/www/controllers/Layout/Table/vars/tasks/list-scheduled.vars.inc.php b/www/controllers/Layout/Table/vars/tasks/list-scheduled.vars.inc.php
index f08221dcb..181b928a8 100644
--- a/www/controllers/Layout/Table/vars/tasks/list-scheduled.vars.inc.php
+++ b/www/controllers/Layout/Table/vars/tasks/list-scheduled.vars.inc.php
@@ -1,31 +1,21 @@
getScheduled(true, $reloadableTableOffset);
-/**
- * Get list of ALL scheduled tasks, without offset, for the total count
- */
+// Get list of ALL scheduled tasks, without offset, for the total count
$reloadableTableTotalItems = count($taskListingController->getScheduled());
-/**
- * Count total pages for the pagination
- */
+// Count total pages for the pagination
$reloadableTableTotalPages = ceil($reloadableTableTotalItems / 10);
-/**
- * Calculate current page number
- */
+// Calculate current page number
$reloadableTableCurrentPage = ceil($reloadableTableOffset / 10) + 1;
diff --git a/www/controllers/Repo/Browse.php b/www/controllers/Repo/Browse.php
index b52f280f9..214c1390b 100644
--- a/www/controllers/Repo/Browse.php
+++ b/www/controllers/Repo/Browse.php
@@ -209,7 +209,7 @@ private static function printSearchResultFiles(array $results): void
-
-
-
getDateFormatted() ?>
+getDateFormatted() ?>
INSTALLATION
@@ -95,11 +93,10 @@ if ($packageType == 'rpm') : ?> - if ($repo !== end($repos)) { - echo ''; - } +
-
+
@@ -265,7 +265,7 @@ private static function printFiles(array $files): void
-
+
@@ -286,10 +286,10 @@ private static function printFiles(array $files): void
*/
private static function printSubDir(string $dir, string $path): void
{
- $fullPath = $path . '/' . $dir;
- ?>
+ $fullPath = $path . '/' . $dir; ?>
+
-
+
diff --git a/www/controllers/Repo/Deb.php b/www/controllers/Repo/Deb.php
index f16885657..78f58c4b4 100644
--- a/www/controllers/Repo/Deb.php
+++ b/www/controllers/Repo/Deb.php
@@ -2,8 +2,6 @@
namespace Controllers\Repo;
-use Exception;
-
class Deb extends \Controllers\Repo\Repo
{
public function __construct()
@@ -20,14 +18,6 @@ public function getIdByNameDistComponent(string $name, string $distribution, str
return $this->model->getIdByNameDistComponent($name, $distribution, $component);
}
- /**
- * Return repository environment description
- */
- public function getDescriptionByName(string $name, string $dist, string $component, string $env) : string|null
- {
- return $this->model->getDescriptionByName($name, $dist, $component, $env);
- }
-
/**
* Return environment Id from repo name
*/
diff --git a/www/controllers/Repo/Edit/Form.php b/www/controllers/Repo/Edit/Form.php
index f43bca092..c59a4d3bb 100644
--- a/www/controllers/Repo/Edit/Form.php
+++ b/www/controllers/Repo/Edit/Form.php
@@ -64,7 +64,7 @@ public function get(array $repos) : string
*/
ob_start();
- echo '
';
+ echo '
'; - $content .= ob_get_clean(); } @@ -152,13 +150,6 @@ public function edit(array $params) : void $repoController->updateSource($param['repo-id'], $param['source']); } - /** - * Update snapshot description - * TODO: no editable description for now - */ - // $repoController->updateDescription($param['snap-id'], $description); - // $snapshotController->updateDescription($param['snap-id'], $description); - /** * Add history */ diff --git a/www/controllers/Repo/Environment.php b/www/controllers/Repo/Environment.php index f99a3f937..8a95806fa 100644 --- a/www/controllers/Repo/Environment.php +++ b/www/controllers/Repo/Environment.php @@ -2,8 +2,7 @@ namespace Controllers\Repo; -use Exception; -use Controllers\Utils\Validate; +use \Controllers\Environment as GlobalEnvironment; class Environment { @@ -15,19 +14,19 @@ public function __construct() } /** - * Return all environments associated to a repository ID + * Return all environments associated to a snapshot Id */ - public function getByRepoId(int $repoId): array + public function getBySnapId(int $snapId): array { - return $this->model->getByRepoId($repoId); + return $this->model->getBySnapId($snapId); } /** * Associate a new environment to a snapshot */ - public function add(int $snapId, string $env, string $description = '') : void + public function add(int $snapId, string $env) : void { - $this->model->add($snapId, $env, $description); + $this->model->add($snapId, $env); } /** @@ -38,19 +37,6 @@ public function remove(int $id) : void $this->model->remove($id); } - /** - * Update environment description - */ - public function updateDescription(int $id, string $description) : void - { - // Description should not contain single quotes or backslashes - if (str_contains($description, "'") || str_contains($description, "\\") || str_contains($description, '')) { - throw new Exception('Description contains invalid characters'); - } - - $this->model->updateDescription($id, Validate::string($description)); - } - /** * Return true if the repository environment Id exists */ diff --git a/www/controllers/Repo/Listing.php b/www/controllers/Repo/Listing.php index e1101766f..84a195cb4 100644 --- a/www/controllers/Repo/Listing.php +++ b/www/controllers/Repo/Listing.php @@ -46,4 +46,20 @@ public function listSnapshots(int $repoId) : array { return $this->model->listSnapshots($repoId); } + + /** + * Return the list of repositories matching the specified filters, with their latest active snapshot Id + */ + public function listByTarget(string $groupId = '', array $tags = [], string $packageType = '') : array + { + return $this->model->listByTarget($groupId, $tags, $packageType); + } + + /** + * Return the list of all distinct tags used by repositories + */ + public function listTags(): array + { + return $this->model->listTags(); + } } diff --git a/www/controllers/Repo/Package/Sync.php b/www/controllers/Repo/Package/Sync.php index bad8438bf..e3b8bb086 100644 --- a/www/controllers/Repo/Package/Sync.php +++ b/www/controllers/Repo/Package/Sync.php @@ -58,12 +58,12 @@ private function syncPackage() if ($this->repoSnapshotController->getDateById($this->repoController->getSnapId()) != $this->repoController->getDate()) { if ($this->repoController->getPackageType() == 'rpm') { if ($this->rpmRepoController->existsSnapDate($this->repoController->getName(), $this->repoController->getReleasever(), $this->repoController->getDate())) { - throw new Exception('A snapshot already exists on the ' . Label::black($this->repoController->getDateFormatted())); + throw new Exception('A snapshot already exists on the ' . Label::white($this->repoController->getDateFormatted())); } } if ($this->repoController->getPackageType() == 'deb') { if ($this->debRepoController->existsSnapDate($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection(), $this->repoController->getDate())) { - throw new Exception('A snapshot already exists on the ' . Label::black($this->repoController->getDateFormatted())); + throw new Exception('A snapshot already exists on the ' . Label::white($this->repoController->getDateFormatted())); } } } diff --git a/www/controllers/Repo/Repo.php b/www/controllers/Repo/Repo.php index eb34138d1..0dbb5c70f 100644 --- a/www/controllers/Repo/Repo.php +++ b/www/controllers/Repo/Repo.php @@ -25,8 +25,9 @@ class Repo private $date; private $dateFormatted; private $time; - private $env; + private $env = []; private $description; + private $tags = []; private $group; private $advancedParams = []; private $signed; @@ -117,6 +118,11 @@ public function setDescription($description = ''): void $this->description = Validate::string($description); } + public function setTags(array $tags = []): void + { + $this->tags = $tags; + } + public function setSource(string $source): void { $this->source = $source; @@ -199,6 +205,7 @@ public function getPackageType(): string public function getEnv(): string|array { + // return $this->env ?? []; return $this->env; } @@ -257,6 +264,11 @@ public function getDescription(): string|null return $this->description; } + public function getTags(): array + { + return $this->tags; + } + public function getGroup(): string|null { return $this->group; @@ -292,74 +304,76 @@ public function getAllById(string|int|null $repoId = null, string|int|null $snap { $data = $this->model->getAllById($repoId, $snapId, $envId); - if (!empty($data['repoId'])) { - $this->setRepoId($data['repoId']); - } - if (!empty($data['snapId'])) { - $this->setSnapId($data['snapId']); - } - if (!empty($data['envId'])) { - $this->setEnvId($data['envId']); - } - if (!empty($data['Source'])) { - $this->setSource($data['Source']); - } - if (!empty($data['Name'])) { - $this->setName($data['Name']); - } - if (!empty($data['Releasever'])) { - $this->setReleasever($data['Releasever']); - } - if (!empty($data['Dist'])) { - $this->setDist($data['Dist']); - } - if (!empty($data['Section'])) { - $this->setSection($data['Section']); - } - if (!empty($data['Package_type'])) { - $this->setPackageType($data['Package_type']); - } - if (!empty($data['Date'])) { - $this->setDate($data['Date']); - } - if (!empty($data['Time'])) { - $this->setTime($data['Time']); - } - if (!empty($data['Status'])) { - $this->setStatus($data['Status']); - } - if (!empty($data['Env'])) { - $this->setEnv($data['Env']); - } - if (!empty($data['Type'])) { - $this->setType($data['Type']); - } - if (!empty($data['Signed'])) { - $this->setSigned($data['Signed']); - } - if (!empty($data['Reconstruct'])) { - $this->setRebuild($data['Reconstruct']); - } - if (!empty($data['Description'])) { - $this->setDescription($data['Description']); - } - if (!empty($data['Arch'])) { - $this->setArch(explode(',', $data['Arch'])); - } + try { + if (!empty($data['repoId'])) { + $this->setRepoId($data['repoId']); + } + if (!empty($data['snapId'])) { + $this->setSnapId($data['snapId']); + } + if (!empty($data['envId'])) { + $this->setEnvId($data['envId']); + } + if (!empty($data['Source'])) { + $this->setSource($data['Source']); + } + if (!empty($data['Name'])) { + $this->setName($data['Name']); + } + if (!empty($data['Releasever'])) { + $this->setReleasever($data['Releasever']); + } + if (!empty($data['Dist'])) { + $this->setDist($data['Dist']); + } + if (!empty($data['Section'])) { + $this->setSection($data['Section']); + } + if (!empty($data['Package_type'])) { + $this->setPackageType($data['Package_type']); + } + if (!empty($data['Date'])) { + $this->setDate($data['Date']); + } + if (!empty($data['Time'])) { + $this->setTime($data['Time']); + } + if (!empty($data['Status'])) { + $this->setStatus($data['Status']); + } + if (!empty($data['Env'])) { + $this->setEnv($data['Env']); + } + if (!empty($data['Type'])) { + $this->setType($data['Type']); + } + if (!empty($data['Signed'])) { + $this->setSigned($data['Signed']); + } + if (!empty($data['Reconstruct'])) { + $this->setRebuild($data['Reconstruct']); + } + if (!empty($data['Arch'])) { + $this->setArch(explode(',', $data['Arch'])); + } + if (!empty($data['Description'])) { + $this->setDescription($data['Description']); + } + if (!empty($data['Tags'])) { + $tags = explode(',', $data['Tags']); + $this->setTags($tags); + } - /** - * Extract Advanced_params JSON - * This includes package include/exclude, metadata custom fields and potentially other parameters in the future - * It is optional and can be empty - */ - if (!empty($data['Advanced_params'])) { - try { + /** + * Advanced_params includes package include/exclude, metadata custom fields and potentially other parameters in the future + * It is optional and can be empty + */ + if (!empty($data['Advanced_params'])) { $advancedParams = json_decode($data['Advanced_params'], true, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $e) { - throw new Exception('Failed to decode advanced parameters JSON: ' . $e->getMessage()); + $this->setAdvancedParams($advancedParams); } - - $this->setAdvancedParams($advancedParams); + } catch (JsonException $e) { + throw new Exception('Failed to decode JSON data from database: ' . $e->getMessage()); } } @@ -533,4 +547,46 @@ public function updateSource(int $repoId, string $source): void { $this->model->updateSource($repoId, $source); } + + /** + * Update description + */ + public function updateDescription(int $id, string $description): void + { + // Description should not contain single quotes or backslashes + if (str_contains($description, "'") || str_contains($description, "\\") || str_contains($description, '')) { + throw new Exception('Description contains invalid characters'); + } + + $this->model->updateDescription($id, Validate::string($description)); + } + + /** + * Update tags + */ + public function updateTags(int $id, array $tags): void + { + $validTags = []; + + foreach ($tags as $tag) { + $tag = trim($tag); + + // Ignore empty tags + if (empty($tag)) { + continue; + } + + // Tags must be alphanumeric (hyphen and underscore allowed) + if (!Validate::alphaNumericHyphen($tag)) { + throw new Exception('Tag ' . $tag . ' contains invalid characters'); + } + + // Avoid duplicates + if (!in_array($tag, $validTags)) { + $validTags[] = $tag; + } + } + + $this->model->updateTags($id, implode(',', $validTags)); + } } diff --git a/www/controllers/Repo/Rpm.php b/www/controllers/Repo/Rpm.php index 264c8ad41..009995ed9 100644 --- a/www/controllers/Repo/Rpm.php +++ b/www/controllers/Repo/Rpm.php @@ -2,8 +2,6 @@ namespace Controllers\Repo; -use Exception; - class Rpm extends \Controllers\Repo\Repo { public function __construct() @@ -20,14 +18,6 @@ public function getIdByNameReleasever(string $name, string $releaseVersion) : in return $this->model->getIdByNameReleasever($name, $releaseVersion); } - /** - * Return repository environment description - */ - public function getDescriptionByName(string $name, string $releaseVersion, string $env) : string|null - { - return $this->model->getDescriptionByName($name, $releaseVersion, $env); - } - /** * Return environment Id from repo name */ diff --git a/www/controllers/Repo/Snapshot/Package.php b/www/controllers/Repo/Snapshot/Package.php index 691a2f33f..8f08e17fb 100644 --- a/www/controllers/Repo/Snapshot/Package.php +++ b/www/controllers/Repo/Snapshot/Package.php @@ -126,6 +126,11 @@ public function upload(array $packages, bool $overwrite = false, bool $ignoreIfE throw new Exception('You are not allowed to upload packages'); } + // Check if snapshot has a protected env + if ($this->repoSnapshotController->hasProtectedEnv($this->snapId)) { + throw new Exception('Snapshot has a protected environment and cannot be modified. Please contact your administrator.'); + } + // Both overwrite and ignoreIfExists cannot be true at the same time if ($overwrite && $ignoreIfExists) { throw new Exception('Options overwrite and ignore-if-exists are mutually exclusive'); @@ -331,6 +336,11 @@ public function delete(array $files): array throw new Exception('You are not allowed to delete packages.'); } + // Check if snapshot has a protected env + if ($this->repoSnapshotController->hasProtectedEnv($this->snapId)) { + throw new Exception('Snapshot has a protected environment and cannot be modified. Please contact your administrator.'); + } + foreach ($files as $file) { $file = REPOS_DIR . '/' . $file; diff --git a/www/controllers/Repo/Snapshot/Snapshot.php b/www/controllers/Repo/Snapshot/Snapshot.php index 3179e2a83..c1133c66d 100644 --- a/www/controllers/Repo/Snapshot/Snapshot.php +++ b/www/controllers/Repo/Snapshot/Snapshot.php @@ -160,6 +160,24 @@ public function updateAdvancedParams(int $snapId, array $advancedParams): void $this->model->updateAdvancedParams($snapId, $advancedParams); } + /** + * Return true if the snapshot has a protected environment + */ + public function hasProtectedEnv(int $snapId): bool + { + $envController = new \Controllers\Environment(); + $repoEnvController = new \Controllers\Repo\Environment(); + + // Get the list of environments associated with the snapshot and check if any of them is protected + foreach ($repoEnvController->getBySnapId($snapId) as $env) { + if ($envController->isProtected($env)) { + return true; + } + } + + return false; + } + /** * Clean unused snapshots and return a message */ diff --git a/www/controllers/Repo/Task/Create.php b/www/controllers/Repo/Task/Create.php index 1984aa53d..0440e183c 100644 --- a/www/controllers/Repo/Task/Create.php +++ b/www/controllers/Repo/Task/Create.php @@ -56,7 +56,7 @@ public function __construct(string $taskId) /** * Create repository */ - public function execute() + public function execute(): void { if ($this->type == 'mirror') { $this->mirror(); @@ -70,52 +70,38 @@ public function execute() /** * Create a mirror repository */ - private function mirror() + private function mirror(): void { - /** - * Define the date and time of the new mirror snapshot - */ + // Define the date and time of the new mirror snapshot $this->repoController->setDate(date('Y-m-d')); $this->repoController->setTime(date('H:i')); - /** - * Sync packages - */ + // Sync packages $this->syncPackage(); - /** - * Sign repository / packages - */ + // Sign repository / packages $this->signPackage(); - /** - * Create repository and symlinks - */ + // Create repository and symlinks $this->createMetadata(); - /** - * Finalize repository (add to database and set permissions) - */ + // Finalize repository (add to database and set permissions) $this->finalize(); } /** * Create a local repository */ - private function local() + private function local(): void { - /** - * Set today date and time as target date and time - */ + // Set today date and time as target date and time $this->repoController->setDate(date('Y-m-d')); $this->repoController->setTime(date('H:i')); $this->taskLogStepController->new('create-repo', 'CREATING REPOSITORY'); $this->taskLogSubStepController->new('create-dirs', 'CREATING DIRECTORIES'); - /** - * Check if a repo/section with the same name is already active with snapshots - */ + // Check if a repo/section with the same name is already active with snapshots if ($this->repoController->getPackageType() == 'rpm') { if ($this->rpmRepoController->isActive($this->repoController->getName(), $this->repoController->getReleasever())) { throw new Exception(Label::white($this->repoController->getName() . ' ❯ ' . $this->repoController->getReleasever()) . ' repository already exists'); @@ -127,9 +113,7 @@ private function local() } } - /** - * Define snapshot directory path - */ + // Define snapshot directory path if ($this->repoController->getPackageType() == 'rpm') { $snapshotPath = REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/' . $this->repoController->getDate(); } @@ -137,9 +121,7 @@ private function local() $snapshotPath = REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $this->repoController->getDate(); } - /** - * Create snapshot directory and subdirectories - */ + // Create snapshot directory and subdirectories if ($this->repoController->getPackageType() == 'rpm') { if (!is_dir($snapshotPath . '/packages')) { if (!mkdir($snapshotPath . '/packages', 0770, true)) { @@ -155,9 +137,7 @@ private function local() } } - /** - * Create environment symlink, if an environment has been specified - */ + // Create environment symlink, if an environment has been specified if (!empty($this->repoController->getEnv())) { foreach ($this->repoController->getEnv() as $env) { if ($this->repoController->getPackageType() == 'rpm') { @@ -167,18 +147,14 @@ private function local() $link = REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $env; } - /** - * If a symlink with the same name already exists, we remove it - */ + // If a symlink with the same name already exists, we remove it if (is_link($link)) { if (!unlink($link)) { throw new Exception('Could not remove existing symlink ' . $link); } } - /** - * Create symlink - */ + // Create symlink if (!symlink($this->repoController->getDate(), $link)) { throw new Exception('Could not point environment to the repository'); } @@ -191,73 +167,50 @@ private function local() $this->taskLogSubStepController->new('updating-database', 'UPDATING DATABASE'); - /** - * Check if repository already exists in database - */ + // If currently no rpm repo of this name exists in the database then we add it if ($this->repoController->getPackageType() == 'rpm') { - $exists = $this->rpmRepoController->exists($this->repoController->getName(), $this->repoController->getReleasever()); - } - if ($this->repoController->getPackageType() == 'deb') { - $exists = $this->debRepoController->exists($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection()); - } - - /** - * If no repo of this name exists in database then we add it - * Note: here we set the source as $this->repoController->getName() - */ - if ($exists === false) { - /** - * Retrieve repo Id from the last insert row - */ - if ($this->repoController->getPackageType() == 'rpm') { + if (!$this->rpmRepoController->exists($this->repoController->getName(), $this->repoController->getReleasever())) { + // Note: for local repositories, source is set to repo name $this->rpmRepoController->add($this->repoController->getName(), $this->repoController->getReleasever(), $this->repoController->getName()); + + // Repository Id becomes the Id of the last inserted row in the database $this->repoController->setRepoId($this->rpmRepoController->getLastInsertRowID()); - } - if ($this->repoController->getPackageType() == 'deb') { - $this->debRepoController->add($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection(), $this->repoController->getName()); - $this->repoController->setRepoId($this->debRepoController->getLastInsertRowID()); - } - /** - * Else if a repo of this name exists, we attach this new snapshot and this new env to this repo - */ - } else { - /** - * Retrieve and set repo Id from database - */ - if ($this->repoController->getPackageType() == 'rpm') { - $repoId = $this->rpmRepoController->getIdByNameReleasever($this->repoController->getName(), $this->repoController->getReleasever()); + // Otherwise, if a repo of the same name exists, we retrieve its Id from the database + } else { + $this->repoController->setRepoId($this->rpmRepoController->getIdByNameReleasever($this->repoController->getName(), $this->repoController->getReleasever())); } + } - if ($this->repoController->getPackageType() == 'deb') { - $repoId = $this->debRepoController->getIdByNameDistComponent($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection()); - } + // If currently no deb repo of this name exists in the database then we add it + if ($this->repoController->getPackageType() == 'deb') { + if (!$this->debRepoController->exists($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection())) { + // Note: for local repositories, source is set to repo name + $this->debRepoController->add($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection(), $this->repoController->getName()); - if (empty($repoId)) { - throw new Exception('Could not retrieve repository Id from database'); - } + // Repository Id becomes the Id of the last inserted row in the database + $this->repoController->setRepoId($this->debRepoController->getLastInsertRowID()); - $this->repoController->setRepoId($repoId); + // Otherwise, if a repo of the same name exists, we retrieve its Id from the database + } else { + $this->repoController->setRepoId($this->debRepoController->getIdByNameDistComponent($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection())); + } } - unset($exists, $repoId); + // Apply description and tags after the repository Id has been determined, + $this->repoController->updateDescription($this->repoController->getRepoId(), (string) $this->repoController->getDescription()); + $this->repoController->updateTags($this->repoController->getRepoId(), $this->repoController->getTags()); - /** - * Add snapshot to database - */ + // Add snapshot to database $this->repoSnapshotController->add($this->repoController->getDate(), $this->repoController->getTime(), 'false', $this->repoController->getArch(), $this->repoController->getAdvancedParams(), $this->repoController->getType(), 'active', $this->repoController->getRepoId()); - /** - * Retrieve snapshot Id from the last insert row - */ + // Retrieve snapshot Id from the last insert row $this->repoController->setSnapId($this->repoSnapshotController->getLastInsertRowID()); - /** - * Add env to database if an env has been specified by the user - */ + // Add env to database if an env has been specified by the user if (!empty($this->repoController->getEnv())) { foreach ($this->repoController->getEnv() as $env) { - $this->repoEnvController->add($this->repoController->getSnapId(), $env, $this->repoController->getDescription()); + $this->repoEnvController->add($this->repoController->getSnapId(), $env); } } @@ -265,18 +218,14 @@ private function local() $this->taskLogSubStepController->new('applying-permissions', 'APPLYING PERMISSIONS'); - /** - * Apply permissions on the new repo - */ + // Apply permissions on the new repo File::recursiveChmod($snapshotPath, 'dir', 770); File::recursiveChmod($snapshotPath, 'file', 660); $this->taskLogSubStepController->completed(); $this->taskLogStepController->completed(); - /** - * Add repo to group if a group has been specified - */ + // Add repo to group if a group has been specified if (!empty($this->repoController->getGroup())) { $this->taskLogStepController->new('add-to-group', 'ADDING REPOSITORY TO GROUP'); $this->repoController->addRepoIdToGroup($this->repoController->getRepoId(), $this->repoController->getGroup()); diff --git a/www/controllers/Repo/Task/Delete.php b/www/controllers/Repo/Task/Delete.php index d01a6d1e3..602ef7cad 100644 --- a/www/controllers/Repo/Task/Delete.php +++ b/www/controllers/Repo/Task/Delete.php @@ -33,7 +33,7 @@ public function __construct(string $taskId) /** * Delete a repository snapshot */ - public function execute() + public function execute(): void { $deleted = true; diff --git a/www/controllers/Repo/Task/Duplicate.php b/www/controllers/Repo/Task/Duplicate.php index 72722a25d..77612c851 100644 --- a/www/controllers/Repo/Task/Duplicate.php +++ b/www/controllers/Repo/Task/Duplicate.php @@ -45,16 +45,12 @@ public function execute() $this->taskLogStepController->new('duplicating', 'DUPLICATING'); $this->taskLogSubStepController->new('initializing', 'INITIALIZING'); - /** - * Check if source repo snapshot exists - */ + // Check if source repo snapshot exists if ($this->sourceRepoController->existsSnapId($this->sourceRepoController->getSnapId()) === false) { throw new Exception('Source repository snapshot does not exist'); } - /** - * Check if a repo with the same name already exists - */ + // Check if a repo with the same name already exists if ($this->repoController->getPackageType() == 'rpm') { if ($this->rpmRepoController->isActive($this->repoController->getName(), $this->repoController->getReleasever())) { throw new Exception('A repo ' . $this->repoController->getName() . ' (release ver. ' . $this->repoController->getReleasever() . ') already exists'); @@ -66,9 +62,7 @@ public function execute() } } - /** - * Define source snapshot path - */ + // Define source snapshot path if ($this->sourceRepoController->getPackageType() == 'rpm') { $sourceSnapshotPath = REPOS_DIR . '/rpm/' . $this->sourceRepoController->getName() . '/' . $this->sourceRepoController->getReleasever() . '/' . $this->sourceRepoController->getDate(); } @@ -76,9 +70,7 @@ public function execute() $sourceSnapshotPath = REPOS_DIR . '/deb/' . $this->sourceRepoController->getName() . '/' . $this->sourceRepoController->getDist() . '/' . $this->sourceRepoController->getSection() . '/' . $this->sourceRepoController->getDate(); } - /** - * Define target snapshot path - */ + // Define target snapshot path if ($this->repoController->getPackageType() == 'rpm') { $parentDir = REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever(); $targetSnapshotPath = REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/'. $this->repoController->getDate(); @@ -88,38 +80,28 @@ public function execute() $targetSnapshotPath = REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $this->repoController->getDate(); } - /** - * Create parent directory if it does not already exists - */ + // Create parent directory if it does not already exists if (!is_dir($parentDir)) { if (!mkdir($parentDir, 0770, true)) { throw new Exception('Cannot create directory ' . $parentDir); } } - /** - * Set temporary dir path - */ + // Set temporary dir path $tempDir = REPOS_DIR . '/temporary-task-' . $this->taskId; - /** - * Create the temporary directory if it does not already exist (might exist if the task has been stopped and restarted) - */ + // Create the temporary directory if it does not already exist (might exist if the task has been stopped and restarted) if (!file_exists($tempDir)) { if (!mkdir($tempDir, 0770, true)) { throw new Exception('Cannot create temporary directory ' . $tempDir); } } - /** - * Get all files and directories in the source repository - */ + // Get all files and directories in the source repository $dirs = File::recursiveScan($sourceSnapshotPath, 'dir', true); $files = File::recursiveScan($sourceSnapshotPath, 'file', true); - /** - * Create all directories in the temporary directory - */ + // Create all directories in the temporary directory foreach ($dirs as $dir) { if (!file_exists($tempDir . '/' . $dir)) { if (!mkdir($tempDir . '/' . $dir, 0770, true)) { @@ -139,19 +121,13 @@ public function execute() foreach ($files as $file) { $fileCounter++; - /** - * Count total number of files to copy - */ + // Count total number of files to copy $totalFiles = count($files); - /** - * Show progress - */ + // Show progress $this->taskLogSubStepController->new('copying-file-' . $fileCounter, 'COPYING FILE (' . $fileCounter . '/' . $totalFiles . ')', 'From ' . $sourceSnapshotPath . '/' . $file . '
To ' . $tempDir . '/' . $file); - /** - * Ignore file if it was already copied (completed file exists) - */ + // Ignore file if it was already copied (completed file exists) if (file_exists($tempDir . '/' . $file) and file_exists($tempDir . '/' . $file . '.completed')) { $this->taskLogSubStepController->completed('Already exists (ignoring)'); continue; @@ -167,16 +143,12 @@ public function execute() } } - /** - * Copy the file - */ + // Copy the file if (!copy($sourceSnapshotPath . '/' . $file, $tempDir . '/' . $file)) { throw new Exception('Cannot copy file ' . $sourceSnapshotPath . '/' . $file . ' to ' . $tempDir . '/' . $file); } - /** - * Create the completed file - */ + // Create the completed file if (!touch($tempDir . '/' . $file . '.completed')) { throw new Exception('Cannot create copy-completed file ' . $tempDir . '/' . $file . '.completed'); } @@ -186,9 +158,7 @@ public function execute() unset($dirs, $files); - /** - * Rename the temporary directory to the target directory - */ + // Rename the temporary directory to the target directory $this->taskLogSubStepController->new('moving-temp-dir', 'MOVING TEMPORARY DIRECTORY'); if (!rename($tempDir, $targetSnapshotPath)) { throw new Exception('Cannot rename temporary directory ' . $tempDir . ' to ' . $targetSnapshotPath); @@ -208,23 +178,17 @@ public function execute() } } - /** - * Set step 'DUPLICATING' as completed - */ + // Set step 'DUPLICATING' as completed $this->taskLogStepController->completed(); - /** - * On a deb repo, the duplicated repo metadata must be rebuilded - */ + // On a deb repo, the duplicated repo metadata must be rebuilded if ($this->repoController->getPackageType() == 'deb') { $this->createMetadata(); } $this->taskLogStepController->new('finalizing', 'FINALIZING'); - /** - * Create a symlink to the new repo, only if the user has specified an environment - */ + // Create a symlink to the new repo, only if the user has specified an environment if (!empty($this->repoController->getEnv())) { foreach ($this->repoController->getEnv() as $env) { $this->taskLogSubStepController->new('pointing-environment', 'POINTING ENVIRONMENT'); @@ -236,18 +200,14 @@ public function execute() $link = REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $env; } - /** - * If a symlink with the same name already exists, we remove it - */ + // If a symlink with the same name already exists, we remove it if (is_link($link)) { if (!unlink($link)) { throw new Exception('Could not remove existing symlink ' . $link); } } - /** - * Create symlink - */ + // Create symlink if (!symlink($this->repoController->getDate(), $link)) { throw new Exception('Could not point environment to the repository'); } @@ -260,9 +220,7 @@ public function execute() $this->taskLogSubStepController->new('inserting-database', 'INSERTING REPOSITORY IN DATABASE'); - /** - * Insert the new repo in database and retrieve its Id - */ + // Insert the new repo in database and retrieve its Id if ($this->repoController->getPackageType() == 'rpm') { $this->rpmRepoController->add($this->repoController->getName(), $this->repoController->getReleasever(), $this->repoController->getSource()); $targetRepoId = $this->rpmRepoController->getLastInsertRowID(); @@ -272,14 +230,13 @@ public function execute() $targetRepoId = $this->debRepoController->getLastInsertRowID(); } - /** - * Add the new repo snapshot in database - */ + // Repository Id becomes the Id of the last inserted row in the database + $this->repoController->setRepoId($targetRepoId); + + // Add the new repo snapshot in database $this->repoSnapshotController->add($this->repoController->getDate(), $this->repoController->getTime(), $this->repoController->getSigned(), $this->repoController->getArch(), $this->repoController->getAdvancedParams(), $this->repoController->getType(), $this->repoController->getStatus(), $targetRepoId); - /** - * Retrieve the Id of the new repo snapshot in database - */ + // Retrieve the Id of the new repo snapshot in database $targetSnapId = $this->repoSnapshotController->getLastInsertRowID(); // Calculate and update snapshot size @@ -287,28 +244,26 @@ public function execute() $this->repoSnapshotController->updateSize($targetSnapId, Directory::getSize($targetSnapshotPath)); $this->taskLogSubStepController->completed(); - /** - * Add the new repo environment in database, only if the user has specified an environment - */ + // Add the new repo environment in database, only if the user has specified an environment if (!empty($this->repoController->getEnv())) { foreach ($this->repoController->getEnv() as $env) { - $this->repoEnvController->add($targetSnapId, $env, $this->repoController->getDescription()); + $this->repoEnvController->add($targetSnapId, $env); } } - /** - * Add the new repo to a group if a group has been specified - */ + // Apply description and tags after the repository Id has been determined, + $this->repoController->updateDescription($this->repoController->getRepoId(), (string) $this->repoController->getDescription()); + $this->repoController->updateTags($this->repoController->getRepoId(), $this->repoController->getTags()); + + // Add the new repo to a group if a group has been specified if (!empty($this->repoController->getGroup())) { - $this->repoController->addRepoIdToGroup($targetRepoId, $this->repoController->getGroup()); + $this->repoController->addRepoIdToGroup($this->repoController->getRepoId(), $this->repoController->getGroup()); } $this->taskLogSubStepController->completed(); $this->taskLogStepController->completed(); - /** - * If an error occurred after the temporary directory was renamed, clean the target directory - */ + // If an error occurred after the temporary directory was renamed, clean the target directory } catch (Exception $e) { if (file_exists($targetSnapshotPath)) { if (!Directory::deleteRecursive($targetSnapshotPath)) { @@ -316,9 +271,7 @@ public function execute() } } - /** - * Throw initial exception to set the task as error - */ + // Throw initial exception to set the task as error throw new Exception($e->getMessage()); } } diff --git a/www/controllers/Repo/Task/Env.php b/www/controllers/Repo/Task/Env.php index 4d9634645..de7968953 100644 --- a/www/controllers/Repo/Task/Env.php +++ b/www/controllers/Repo/Task/Env.php @@ -32,11 +32,7 @@ public function __construct(string $taskId) public function execute() { foreach ($this->repoController->getEnv() as $env) { - $actualDescription = null; - - /** - * Define snapshot directory path - */ + // Define snapshot directory path if ($this->repoController->getPackageType() == 'rpm') { $snapshotPath = REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/' . $this->repoController->getDate(); } @@ -47,44 +43,19 @@ public function execute() $this->taskLogStepController->new('point-env-' . $env, 'POINT ENVIRONMENT ' . Label::envtag($env)); $this->taskLogSubStepController->new('checking-' . $env, 'CHECKING'); - /** - * Check if the source snapshot exists - */ + // Check if the source snapshot exists if (!$this->repoController->existsSnapId($this->repoController->getSnapId())) { throw new Exception('' . $this->repoController->getDateFormatted() . ' repository snapshot does not exist anymore'); } - /** - * Check if an environment of the same name already exists on the target snapshot - */ + // Check if an environment of the same name already points to the target snapshot if ($this->repoController->existsSnapIdEnv($this->repoController->getSnapId(), $env) === true) { if ($this->repoController->getPackageType() == 'rpm') { - throw new Exception(Label::envtag($env) . ' environment already exists on ' . $this->repoController->getName() . '⸺' . $this->repoController->getDateFormatted() . ''); + throw new Exception(Label::envtag($env) . ' environment already points to ' . $this->repoController->getName() . '⸺' . $this->repoController->getDateFormatted() . ''); } if ($this->repoController->getPackageType() == 'deb') { - throw new Exception(Label::envtag($env) . ' environment already exists on ' . $this->repoController->getName() . ' ❯ ' . $this->repoController->getDist() . ' ❯ ' . $this->repoController->getSection() . '⸺' . $this->repoController->getDateFormatted() . ''); - } - } - - /** - * If the user did not specify any description then we get the one currently in place on the environment of the same name (if the environment exists and if it has a description) - */ - if (empty($this->repoController->getDescription())) { - if ($this->repoController->getPackageType() == 'rpm') { - $actualDescription = $this->rpmRepoController->getDescriptionByName($this->repoController->getName(), $this->repoController->getReleasever(), $env); - } - if ($this->repoController->getPackageType() == 'deb') { - $actualDescription = $this->debRepoController->getDescriptionByName($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection(), $env); - } - - /** - * If the description is empty then the description will remain empty - */ - if (!empty($actualDescription)) { - $this->repoController->setDescription(htmlspecialchars_decode($actualDescription)); - } else { - $this->repoController->setDescription(''); + throw new Exception(Label::envtag($env) . ' environment already points to ' . $this->repoController->getName() . ' ❯ ' . $this->repoController->getDist() . ' ❯ ' . $this->repoController->getSection() . '⸺' . $this->repoController->getDateFormatted() . ''); } } @@ -92,18 +63,12 @@ public function execute() $this->taskLogSubStepController->new('create-symlink-' . $env, 'CREATING SYMLINK'); if ($this->repoController->getPackageType() == 'rpm') { - /** - * If there is already an environment of the same name pointing to a snapshot. - */ + // If there is already an environment of the same name pointing to a snapshot if ($this->rpmRepoController->existsEnv($this->repoController->getName(), $this->repoController->getReleasever(), $env)) { - /** - * Retrieve the Id of the already existing environment - */ + // Retrieve the Id of the already existing environment $actualEnvIds = $this->rpmRepoController->getEnvIdFromRepoName($this->repoController->getName(), $this->repoController->getReleasever(), $env); - /** - * Delete the possible environment of the same name already pointing to a snapshot of this repo (if there is one) - */ + // Delete the possible environment of the same name already pointing to a snapshot of this repo (if there is one) if (!empty($actualEnvIds)) { foreach ($actualEnvIds as $actualEnvId) { $this->repoEnvController->remove($actualEnvId); @@ -111,36 +76,26 @@ public function execute() } } - /** - * Delete symbolic link if already exists - */ + // Delete symbolic link if already exists if (is_link(REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/' . $env)) { if (!unlink(REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/' . $env)) { throw new Exception('Could not delete existing symbolic link: ' . REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/' . $env); } } - /** - * Create symbolic link - */ + // Create symbolic link if (!symlink($this->repoController->getDate(), REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/' . $env)) { throw new Exception('Could not create symbolic link: ' . REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/' . $env); } } if ($this->repoController->getPackageType() == 'deb') { - /** - * If there is already an environment of the same name pointing to a snapshot. - */ + // If there is already an environment of the same name pointing to a snapshot if ($this->debRepoController->existsEnv($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection(), $env)) { - /** - * Retrieve the Id of the already existing environment - */ + // Retrieve the Id of the already existing environment $actualEnvIds = $this->debRepoController->getEnvIdFromRepoName($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection(), $env); - /** - * Delete the possible environment of the same name already pointing to a snapshot of this repo (if there is one) - */ + // Delete the possible environment of the same name already pointing to a snapshot of this repo (if there is one) if (!empty($actualEnvIds)) { foreach ($actualEnvIds as $actualEnvId) { $this->repoEnvController->remove($actualEnvId); @@ -148,18 +103,14 @@ public function execute() } } - /** - * Delete symbolic link if already exists - */ + // Delete symbolic link if already exists if (is_link(REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $env)) { if (!unlink(REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $env)) { throw new Exception('Could not delete existing symbolic link: ' . REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $env); } } - /** - * Create symbolic link - */ + // Create symbolic link if (!symlink($this->repoController->getDate(), REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $env)) { throw new Exception('Could not create symbolic link: ' . REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $env); } @@ -167,11 +118,9 @@ public function execute() $this->taskLogSubStepController->completed(); - /** - * Add environment to database - */ + // Add environment to database $this->taskLogSubStepController->new('update-database', 'UPDATING DATABASE'); - $this->repoEnvController->add($this->repoController->getSnapId(), $env, $this->repoController->getDescription()); + $this->repoEnvController->add($this->repoController->getSnapId(), $env); $this->taskLogSubStepController->completed(); $this->taskLogStepController->completed(); } diff --git a/www/controllers/Repo/Task/Finalize.php b/www/controllers/Repo/Task/Finalize.php index e2a9a38da..660b46a45 100644 --- a/www/controllers/Repo/Task/Finalize.php +++ b/www/controllers/Repo/Task/Finalize.php @@ -11,7 +11,7 @@ trait Finalize /** * Finalize the repository: add to the database and apply permissions */ - protected function finalize() + protected function finalize(): void { $this->taskLogStepController->new('finalizing', 'FINALIZING'); @@ -48,7 +48,6 @@ protected function finalize() if ($this->repoController->getPackageType() == 'deb') { if (!$this->debRepoController->exists($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection())) { $this->debRepoController->add($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection(), $this->repoController->getSource()); - // Repository Id becomes the Id of the last inserted row in the database $this->repoController->setRepoId($this->debRepoController->getLastInsertRowID()); @@ -58,6 +57,10 @@ protected function finalize() } } + // Apply description and tags after the repository Id has been determined, + $this->repoController->updateDescription($this->repoController->getRepoId(), (string) $this->repoController->getDescription()); + $this->repoController->updateTags($this->repoController->getRepoId(), $this->repoController->getTags()); + // Add snapshot in database $this->repoSnapshotController->add($this->repoController->getDate(), $this->repoController->getTime(), $this->repoController->getGpgSign(), $this->repoController->getArch(), $this->repoController->getAdvancedParams(), $this->repoController->getType(), 'active', $this->repoController->getRepoId()); @@ -67,7 +70,7 @@ protected function finalize() // Add env in database if an env has been specified by the user if (!empty($this->repoController->getEnv())) { foreach ($this->repoController->getEnv() as $env) { - $this->repoEnvController->add($this->repoController->getSnapId(), $env, $this->repoController->getDescription()); + $this->repoEnvController->add($this->repoController->getSnapId(), $env); } } } @@ -123,23 +126,6 @@ protected function finalize() $this->taskLogSubStepController->new('adding-env', 'ADDING ENVIRONMENT'); foreach ($this->repoController->getEnv() as $env) { - // If the user has not specified any description, then we retrieve the one currently in place on the environment of the same name (if the environment exists and if it has a description) - if (empty($this->repoController->getDescription())) { - if ($this->repoController->getPackageType() == 'rpm') { - $actualDescription = $this->rpmRepoController->getDescriptionByName($this->repoController->getName(), $this->repoController->getReleasever(), $env); - } - if ($this->repoController->getPackageType() == 'deb') { - $actualDescription = $this->debRepoController->getDescriptionByName($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection(), $env); - } - - // If the retrieved description is empty then the description will remain empty - if (!empty($actualDescription)) { - $this->repoController->setDescription(htmlspecialchars_decode($actualDescription)); - } else { - $this->repoController->setDescription(''); - } - } - // Retrieve the Id of the environment currently in place (if there is one) if ($this->repoController->getPackageType() == 'rpm') { $actualEnvIds = $this->rpmRepoController->getEnvIdFromRepoName($this->repoController->getName(), $this->repoController->getReleasever(), $env); @@ -156,7 +142,7 @@ protected function finalize() } // Then we declare the new environment and make it point to the previously created snapshot - $this->repoEnvController->add($this->repoController->getSnapId(), $env, $this->repoController->getDescription()); + $this->repoEnvController->add($this->repoController->getSnapId(), $env); } $this->taskLogSubStepController->completed(); diff --git a/www/controllers/Repo/Task/Rebuild.php b/www/controllers/Repo/Task/Rebuild.php index c74aa37bf..5e8893208 100644 --- a/www/controllers/Repo/Task/Rebuild.php +++ b/www/controllers/Repo/Task/Rebuild.php @@ -34,26 +34,18 @@ public function __construct(string $taskId) /** * Rebuild repository metadata */ - public function execute() + public function execute(): void { - /** - * Set snapshot metadata rebuild state in database - */ + // Set snapshot metadata rebuild state in database $this->repoSnapshotController->updateRebuild($this->repoController->getSnapId(), 'running'); - /** - * Sign repository / packages - */ + // Sign repository / packages $this->signPackage(); - /** - * Create repository and symlinks - */ + // Create repository and symlinks $this->createMetadata(); - /** - * Finalize repository (update database, clean temporary files, etc.) - */ + // Finalize repository (update database, clean temporary files, etc.) $this->finalize(); } } diff --git a/www/controllers/Repo/Task/RemoveEnv.php b/www/controllers/Repo/Task/RemoveEnv.php index 72268c778..090ca796e 100644 --- a/www/controllers/Repo/Task/RemoveEnv.php +++ b/www/controllers/Repo/Task/RemoveEnv.php @@ -28,14 +28,12 @@ public function __construct(string $taskId) /** * Remove snapshot environment */ - public function execute() + public function execute(): void { $this->taskLogStepController->new('removing', 'REMOVING'); $this->taskLogSubStepController->new('delete-symlink', 'DELETE SYMLINK'); - /** - * Define environment symlink - */ + // Define environment symlink if ($this->repoController->getPackageType() == 'rpm') { $symlink = REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/' . $this->repoController->getEnv(); } @@ -44,9 +42,7 @@ public function execute() $symlink = REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $this->repoController->getEnv(); } - /** - * Delete environment symlink - */ + // Delete environment symlink if (file_exists($symlink)) { if (!unlink($symlink)) { throw new Exception('Failed to delete symlink: ' . $symlink); @@ -55,9 +51,7 @@ public function execute() $this->taskLogSubStepController->completed(); - /** - * Delete environment from database - */ + // Delete environment from database $this->taskLogSubStepController->new('update-database', 'UPDATE DATABASE'); $this->repoEnvController->remove($this->repoController->getEnvId()); $this->taskLogSubStepController->completed(); diff --git a/www/controllers/Repo/Task/Rename.php b/www/controllers/Repo/Task/Rename.php index b893edeb3..c4b0907c3 100644 --- a/www/controllers/Repo/Task/Rename.php +++ b/www/controllers/Repo/Task/Rename.php @@ -13,8 +13,8 @@ public function __construct(string $taskId) { parent::__construct($taskId, 'rename'); - // Get source repository details from its snapshot Id - $this->sourceRepoController->getAllById(null, $this->params['snap-id'], null); + // Get source repository details from its repo Id + $this->sourceRepoController->getAllById($this->params['repo-id']); // Execute the task try { @@ -34,14 +34,14 @@ public function __construct(string $taskId) /** * Rename repository */ - public function execute() + public function execute(): void { $this->taskLogStepController->new('renaming', 'RENAMING'); $this->taskLogSubStepController->new('renaming-directory', 'RENAMING REPOSITORY DIRECTORY'); - // Check if source repo snapshot exists - if ($this->sourceRepoController->existsSnapId($this->sourceRepoController->getSnapId()) === false) { - throw new Exception('Source repository snapshot does not exist'); + // Check if source repo exists + if ($this->sourceRepoController->existsId($this->sourceRepoController->getRepoId()) === false) { + throw new Exception('Source repository does not exist'); } // Check if a repo with the same name already exists @@ -56,7 +56,7 @@ public function execute() } } - // Define source snapshot path + // Define source repository path if ($this->sourceRepoController->getPackageType() == 'rpm') { $sourcePath = REPOS_DIR . '/rpm/' . $this->sourceRepoController->getName() . '/' . $this->sourceRepoController->getReleasever(); } @@ -64,7 +64,7 @@ public function execute() $sourcePath = REPOS_DIR . '/deb/' . $this->sourceRepoController->getName() . '/' . $this->sourceRepoController->getDist() . '/' . $this->sourceRepoController->getSection(); } - // Define target snapshot path + // Define target repository path if ($this->repoController->getPackageType() == 'rpm') { $parentDir = REPOS_DIR . '/rpm/' . $this->repoController->getName(); $targetPath = REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever(); @@ -96,24 +96,24 @@ public function execute() $this->taskLogSubStepController->completed(); $this->taskLogStepController->completed(); - if ($this->repoController->getPackageType() == 'deb') { - try { - // On a deb repo, the renamed repository needs to have its metadata rebuilded - $this->createMetadata(); - - // If an error occurred after repository has been moved, try to revert the move - } catch (Exception $e) { - // Try to revert the move - if (file_exists($targetPath)) { - if (!rename($targetPath, $sourcePath)) { - throw new Exception('An error occured while creating the repository metadata: ' . $e->getMessage() . '. Additionally, the system could not revert the renamed repository from ' . $targetPath . ' to ' . $sourcePath . '. Manual intervention is required to restore the repository to its original state.'); - } - } - - // Throw initial exception to set the task as error - throw new Exception('An error occured while creating the repository metadata: ' . $e->getMessage(). ' The renamed repository has been reverted to its original state. Please check that everything is fine before retrying the rename operation.'); - } - } + // if ($this->repoController->getPackageType() == 'deb') { + // try { + // // On a deb repo, the renamed repository needs to have its metadata rebuilded + // $this->createMetadata(); + + // // If an error occurred after repository has been moved, try to revert the move + // } catch (Exception $e) { + // // Try to revert the move + // if (file_exists($targetPath)) { + // if (!rename($targetPath, $sourcePath)) { + // throw new Exception('An error occured while creating the repository metadata: ' . $e->getMessage() . '. Additionally, the system could not revert the renamed repository from ' . $targetPath . ' to ' . $sourcePath . '. Manual intervention is required to restore the repository to its original state.'); + // } + // } + + // // Throw initial exception to set the task as error + // throw new Exception('An error occured while creating the repository metadata: ' . $e->getMessage(). ' The renamed repository has been reverted to its original state. Please check that everything is fine before retrying the rename operation.'); + // } + // } try { $this->taskLogStepController->new('finalizing', 'FINALIZING'); diff --git a/www/controllers/Repo/Task/Update.php b/www/controllers/Repo/Task/Update.php index bbe04cc2a..b2d109b1d 100644 --- a/www/controllers/Repo/Task/Update.php +++ b/www/controllers/Repo/Task/Update.php @@ -40,67 +40,49 @@ public function __construct(string $taskId) /** * Update repository */ - public function execute() + public function execute(): void { - /** - * Define default date and time - */ + // Define default date and time $this->repoController->setDate(date('Y-m-d')); $this->repoController->setTime(date('H:i')); - /** - * Sync packages (if mirror repo) - */ + // Sync packages (if mirror repo) if ($this->repoController->getType() == 'mirror') { $this->syncPackage(); } - /** - * Update repository (if local repo) - */ + // Update repository (if local repo) if ($this->repoController->getType() == 'local') { $this->updateLocal(); } - /** - * Sign repo / packages - */ + // Sign repo / packages $this->signPackage(); - /** - * Create repo and symlinks - */ + // Create repo and symlinks $this->createMetadata(); - /** - * Finalize repo (add to database and apply rights) - */ + // Finalize repo (add to database and apply rights) $this->finalize(); } /** * Update local repository */ - private function updateLocal() + private function updateLocal(): void { $this->taskLogStepController->new('updating', 'UPDATING'); $this->taskLogSubStepController->new('initializing', 'INITIALIZING'); - /** - * Define temporary working directory - */ + // Define temporary working directory $workingDir = REPOS_DIR . '/temporary-task-' . $this->taskId; - /** - * Check if a snapshot exists in the database - */ + // Check if a snapshot exists in the database if ($this->repoController->existsSnapId($this->repoController->getSnapId()) === false) { throw new Exception('Specified repo snapshot does not exist'); } - /** - * We cannot update a snapshot in the same day - */ + // We cannot update a snapshot in the same day if ($this->repoController->getPackageType() == 'rpm') { if ($this->rpmRepoController->existsSnapDate($this->repoController->getName(), $this->repoController->getReleasever(), $this->repoController->getDate())) { throw new Exception('A snapshot already exists on the ' . $this->repoController->getDateFormatted() . ''); @@ -112,16 +94,12 @@ private function updateLocal() } } - /** - * Arch must be specified - */ + // Arch must be specified if (empty($this->repoController->getArch())) { throw new Exception('Packages arch must be specified'); } - /** - * Define previous snapshot directory path - */ + // Define previous snapshot directory path if ($this->sourceRepoController->getPackageType() == 'rpm') { $previousSnapshotDir = REPOS_DIR . '/rpm/' . $this->sourceRepoController->getName() . '/' . $this->sourceRepoController->getReleasever() . '/' . $this->sourceRepoController->getDate(); } @@ -129,16 +107,12 @@ private function updateLocal() $previousSnapshotDir = REPOS_DIR . '/deb/' . $this->sourceRepoController->getName() . '/' . $this->sourceRepoController->getDist() . '/' . $this->sourceRepoController->getSection() . '/' . $this->sourceRepoController->getDate(); } - /** - * Check that previous snapshot directory exists - */ + // Check that previous snapshot directory exists if (!is_dir($previousSnapshotDir)) { throw new Exception('Previous snapshot directory does not exist: ' . $previousSnapshotDir); } - /** - * If working directory already exists, delete it - */ + // If working directory already exists, delete it if (is_dir($workingDir)) { if (!Directory::deleteRecursive($workingDir)) { throw new Exception('Cannot delete existing directory: ' . $workingDir); @@ -148,9 +122,7 @@ private function updateLocal() $this->taskLogSubStepController->completed(); $this->taskLogSubStepController->new('search-packages', 'SEARCHING PACKAGES IN PREVIOUS SNAPSHOT'); - /** - * Search for packages in the previous snapshot directory - */ + // Search for packages in the previous snapshot directory try { if ($this->repoController->getPackageType() == 'deb') { $packages = File::findRecursive($previousSnapshotDir . '/pool/' . $this->sourceRepoController->getSection(), [], ['deb', 'dsc', 'gz', 'xz']); @@ -163,17 +135,13 @@ private function updateLocal() throw new Exception('Error while retrieving previous snapshot packages: ' . $e->getMessage()); } - /** - * Count number of packages found - */ + // Count number of packages found $totalPackages = count($packages); $packageCounter = 0; $this->taskLogSubStepController->completed($totalPackages . ' package(s) found'); - /** - * Create target pool/packages directory - */ + // Create target pool/packages directory if ($this->repoController->getPackageType() == 'deb') { // Create pool directory if (!mkdir($workingDir . '/pool/' . $this->repoController->getSection(), 0770, true)) { @@ -187,9 +155,7 @@ private function updateLocal() } } - /** - * Deduplication/Copy packages from previous snapshot to the new snapshot - */ + // Deduplication/Copy packages from previous snapshot to the new snapshot foreach ($packages as $packagePath) { // Get package name $name = basename($packagePath); diff --git a/www/controllers/Service/Unit/ScheduledTask.php b/www/controllers/Service/Unit/ScheduledTask.php index fb7d61d46..51d4d5509 100644 --- a/www/controllers/Service/Unit/ScheduledTask.php +++ b/www/controllers/Service/Unit/ScheduledTask.php @@ -4,6 +4,7 @@ use Exception; use DateTime; +use Controllers\Task\Target; class ScheduledTask extends \Controllers\Service\Service { @@ -35,6 +36,7 @@ public function execute() : void } $taskToExec = []; + $tasksRawParams = []; $dateNow = date('Y-m-d'); $timeNow = date('H:i'); $minutesNow = date('i'); @@ -65,6 +67,9 @@ public function execute() : void $taskRawParams = json_decode($task['Raw_params'], true); + // Keep the parameters aside, they are needed when the task is actually executed + $tasksRawParams[$task['Id']] = $taskRawParams; + /** * Case where the task is a unique task */ @@ -161,9 +166,17 @@ public function execute() : void parent::log('Launching scheduled task #' . $taskId . '...'); try { - // Add the scheduled task to the queue and execute it - $this->taskController->updateStatus($taskId, 'queued'); - $this->taskController->executeId($taskId); + /** + * If the task targets a dynamic set of repositories, it is not executed as is: + * it generates one task per matching repository, on their latest snapshot + */ + if (Target::isDynamic($tasksRawParams[$taskId] ?? [])) { + $this->executeDynamicTask($taskId, $tasksRawParams[$taskId]); + } else { + // Add the scheduled task to the queue and execute it + $this->taskController->updateStatus($taskId, 'queued'); + $this->taskController->executeId($taskId); + } } catch (Exception $e) { throw new Exception('Error while executing scheduled task #' . $taskId . ': ' . $e->getMessage()); } @@ -174,6 +187,42 @@ public function execute() : void } } + /** + * Execute a scheduled task targeting a dynamic set of repositories + * One task is generated per matching repository, targeting its latest snapshot + */ + private function executeDynamicTask(int $taskId, array $taskRawParams): void + { + $targetController = new Target(); + + // Retrieve the parameters of the tasks to generate, one per matching repository + $tasksParams = $targetController->expand($taskRawParams); + + if (empty($tasksParams)) { + parent::log('No repository matches the target of scheduled task #' . $taskId); + } else { + parent::log('Scheduled task #' . $taskId . ' matches ' . count($tasksParams) . ' repository(ies)'); + + // Generate and execute a task for each matching repository, linked to the scheduled task that generated them + $this->taskController->execute($tasksParams, $taskId); + } + + /** + * Keep track of the last execution date and time of the scheduled task, + * it has no log of its own as it only dispatches sub-tasks + */ + $this->taskController->updateDate($taskId, date('Y-m-d')); + $this->taskController->updateTime($taskId, date('H:i:s')); + + /** + * A recurring task stays scheduled and will run again at the next occurrence + * A unique task must not run again, so it is marked as done + */ + if (($taskRawParams['schedule']['schedule-type'] ?? '') == 'unique') { + $this->taskController->updateStatus($taskId, 'done'); + } + } + /** * Send scheduled tasks reminders */ diff --git a/www/controllers/Task/Execution.php b/www/controllers/Task/Execution.php index 3f114bbf1..88998b5cd 100644 --- a/www/controllers/Task/Execution.php +++ b/www/controllers/Task/Execution.php @@ -112,6 +112,11 @@ public function __construct(int $taskId, string $action) $this->repoController->getAllById($this->params['repo-id'], $this->params['snap-id'], $this->params['env-id']); } + // Retrieve repository details from repo Id, if needed + if (isset($taskConfig['retrieve-repo-from-repo-id']) and $taskConfig['retrieve-repo-from-repo-id']) { + $this->repoController->getAllById($this->params['repo-id']); + } + // Retrieve repository details from snap Id, if needed if (isset($taskConfig['retrieve-repo-from-snap-id']) and $taskConfig['retrieve-repo-from-snap-id']) { $this->repoController->getAllById(null, $this->params['snap-id'], null); @@ -247,6 +252,7 @@ public function paramsSet($requiredParams = [], $optionalParams = []) 'gpg-sign' => 'setGpgSign', 'env' => 'setEnv', 'description' => 'setDescription', + 'tags' => 'setTags', 'group' => 'setGroup', 'advanced-params' => 'setAdvancedParams' ]; @@ -283,10 +289,11 @@ public function start() : void // Update layout containers states $this->layoutContainerReloadController->reload('header/menu'); + $this->layoutContainerReloadController->reload('repos/kpi'); $this->layoutContainerReloadController->reload('repos/list'); - $this->layoutContainerReloadController->reload('tasks/list'); - $this->layoutContainerReloadController->reload('browse/list'); - $this->layoutContainerReloadController->reload('browse/actions'); + $this->layoutContainerReloadController->reload('tasks/tasks'); + $this->layoutContainerReloadController->reload('snapshot/kpi'); + $this->layoutContainerReloadController->reload('snapshot/list'); // Add current PHP execution PID to the PID file to make sure it can be killed with the stop button $this->taskController->addsubpid(getmypid()); @@ -315,10 +322,6 @@ public function end() : void // Calculate total duration $duration = Convert::microtimeToHuman(microtime(true) - $this->timeStart); - // Create one last step for total duration - $this->taskLogStepController->new('duration', 'DURATION'); - $this->taskLogStepController->none('Total duration: ' . $duration); - // Update duration $this->taskController->updateDuration($this->taskId, $duration); @@ -358,10 +361,12 @@ public function end() : void // Update layout containers states $this->layoutContainerReloadController->reload('header/menu'); + $this->layoutContainerReloadController->reload('repos/kpi'); $this->layoutContainerReloadController->reload('repos/list'); - $this->layoutContainerReloadController->reload('tasks/list'); - $this->layoutContainerReloadController->reload('browse/list'); - $this->layoutContainerReloadController->reload('browse/actions'); + $this->layoutContainerReloadController->reload('tasks/tasks'); + $this->layoutContainerReloadController->reload('tasks/log'); + $this->layoutContainerReloadController->reload('snapshot/kpi'); + $this->layoutContainerReloadController->reload('snapshot/list'); } catch (Exception $e) { throw new Exception('Error while ending task: ' . $e->getMessage()); } diff --git a/www/controllers/Task/Form/Create.php b/www/controllers/Task/Form/Create.php index c14ec20ea..36392f3a7 100644 --- a/www/controllers/Task/Form/Create.php +++ b/www/controllers/Task/Form/Create.php @@ -53,6 +53,9 @@ public function validate(array $formParams): void // Check description Param\Description::check($formParams['description']); + // Check tags + Param\Tags::check($formParams['tags']); + // Check group if (!empty($formParams['group'])) { Param\Group::check($formParams['group']); diff --git a/www/controllers/Task/Form/Delete.php b/www/controllers/Task/Form/Delete.php index 646bfa385..f81c2847a 100644 --- a/www/controllers/Task/Form/Delete.php +++ b/www/controllers/Task/Form/Delete.php @@ -4,37 +4,45 @@ use Exception; use Controllers\Repo\Repo; +use Controllers\Repo\Snapshot\Snapshot; use Controllers\History\Save as History; +use Controllers\Utils\Generate\Html\Label; class Delete { public function validate(array $formParams): void { $repoController = new Repo(); + $repoSnaphotController = new Snapshot(); // Check that the snapshot id is valid Param\Snapshot::checkId($formParams['snap-id']); - // Retrieve all repo data from the Id - $repoController->setSnapId($formParams['snap-id']); - $repoController->getAllById('', $formParams['snap-id'], ''); + // Check that the snapshot exists + if (!$repoSnaphotController->exists($formParams['snap-id'])) { + throw new Exception('Snapshot Id #' . $formParams['snap-id'] . ' does not exist'); + } - // Check that the repo exists - if ($repoController->existsSnapId($formParams['snap-id']) === false) { - throw new Exception('Snapshot Id ' . $formParams['snap-id'] . ' does not exist'); + // Check if the snapshot has a protected environment + if ($repoSnaphotController->hasProtectedEnv($formParams['snap-id'])) { + throw new Exception('Snapshot has a protected environment and cannot be deleted'); } + // Retrieve all repo data from the Id + // $repoController->setSnapId($formParams['snap-id']); + $repoController->getAllById('', $formParams['snap-id'], ''); + // Check scheduling parameters Param\Schedule::check($formParams['schedule']); // Add history if ($repoController->getPackageType() == 'rpm') { - History::set('Running task: delete repository snapshot ' . $repoController->getName() . '⸺' . $repoController->getDateFormatted() . ''); + History::set('Running task: delete repository snapshot ' . Label::white($repoController->getName()) . '⸺' . Label::white($repoController->getDateFormatted())); } if ($repoController->getPackageType() == 'deb') { - History::set('Running task: delete repository snapshot ' . $repoController->getName() . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection() . '⸺' . $repoController->getDateFormatted() . ''); + History::set('Running task: delete repository snapshot ' . Label::white($repoController->getName() . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection()) . '⸺' . Label::white($repoController->getDateFormatted())); } - unset($repoController); + unset($repoController, $repoSnaphotController); } } diff --git a/www/controllers/Task/Form/Duplicate.php b/www/controllers/Task/Form/Duplicate.php index 463d5f135..fdcf00674 100644 --- a/www/controllers/Task/Form/Duplicate.php +++ b/www/controllers/Task/Form/Duplicate.php @@ -5,6 +5,7 @@ use Exception; use Controllers\Repo\Repo; use Controllers\History\Save as History; +use Controllers\Utils\Generate\Html\Label; class Duplicate { @@ -17,10 +18,6 @@ public function validate(array $formParams): void // Check that the snapshot id is valid Param\Snapshot::checkId($formParams['snap-id']); - // Retrieve all repo data from the Id - $repoController->setSnapId($formParams['snap-id']); - $repoController->getAllById('', $formParams['snap-id'], ''); - // Check name Param\Name::check($formParams['name']); @@ -34,20 +31,27 @@ public function validate(array $formParams): void Param\Description::check($formParams['description']); } + // Check tags + Param\Tags::check($formParams['tags']); + // Check group if (!empty($formParams['group'])) { Param\Group::check($formParams['group']); } + // Retrieve all repo data from the Id + // $repoController->setSnapId($formParams['snap-id']); + $repoController->getAllById('', $formParams['snap-id'], ''); + // Check that a repo with the same name does not already exist if ($repoController->getPackageType() == 'rpm') { if ($rpmRepoController->isActive($formParams['name'], $repoController->getReleasever())) { - throw new Exception('' . $formParams['name'] . ' ❯ ' . $repoController->getReleasever() . ' repository already exists'); + throw new Exception(Label::white($formParams['name'] . ' ❯ ' . $repoController->getReleasever()) . ' repository already exists'); } } if ($repoController->getPackageType() == 'deb') { if ($debRepoController->isActive($formParams['name'], $repoController->getDist(), $repoController->getSection())) { - throw new Exception('' . $formParams['name'] . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection() . ' repo already exists'); + throw new Exception(Label::white($formParams['name'] . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection()) . ' repo already exists'); } } @@ -56,10 +60,10 @@ public function validate(array $formParams): void // Add history if ($repoController->getPackageType() == 'rpm') { - History::set('Running task: duplicate repository ' . $repoController->getName() . '⸺' . $repoController->getDateFormatted() . ' ➡ ' . $formParams['name'] . ''); + History::set('Running task: duplicate repository ' . Label::white($repoController->getName()) . '⸺' . Label::white($repoController->getDateFormatted()) . ' ➡ ' . Label::white($formParams['name'])); } if ($repoController->getPackageType() == 'deb') { - History::set('Running task: duplicate repository ' . $repoController->getName() . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection() . '⸺' . $repoController->getDateFormatted() . ' ➡ ' . $formParams['name'] . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection() . ''); + History::set('Running task: duplicate repository ' . Label::white($repoController->getName() . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection()) . '⸺' . Label::white($repoController->getDateFormatted()) . ' ➡ ' . Label::white($formParams['name'] . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection())); } unset($repoController, $rpmRepoController, $debRepoController); diff --git a/www/controllers/Task/Form/Env.php b/www/controllers/Task/Form/Env.php index 486fbb4b7..f67b01105 100644 --- a/www/controllers/Task/Form/Env.php +++ b/www/controllers/Task/Form/Env.php @@ -2,7 +2,9 @@ namespace Controllers\Task\Form; +use Exception; use Controllers\Repo\Repo; +use Controllers\Environment; use Controllers\Utils\Generate\Html\Label; use Controllers\History\Save as History; @@ -11,23 +13,28 @@ class Env public function validate(array $formParams): void { $repoController = new Repo(); + $envController = new Environment(); // Check that the snapshot id is valid Param\Snapshot::checkId($formParams['snap-id']); - // Retrieve all repo data from the Id - $repoController->setSnapId($formParams['snap-id']); - $repoController->getAllById('', $formParams['snap-id'], ''); - // Check environment Param\Environment::check($formParams['env']); - // Check description - Param\Description::check($formParams['description']); - // Check scheduling parameters Param\Schedule::check($formParams['schedule']); + // Check if the env is protected + foreach ($formParams['env'] as $env) { + if ($envController->isProtected($env)) { + throw new Exception('Environment ' . $env . ' is protected and cannot be moved'); + } + } + + // Retrieve all repo data from the Id + // $repoController->setSnapId($formParams['snap-id']); + $repoController->getAllById('', $formParams['snap-id'], ''); + // Add history $content = ''; foreach ($formParams['env'] as $env) { @@ -35,10 +42,10 @@ public function validate(array $formParams): void } if ($repoController->getPackageType() == 'rpm') { - History::set('Running task: point environment(s) ' . trim($content) . ' to repository ' . $repoController->getName() . '⸺' . $repoController->getDateFormatted() . ''); + History::set('Running task: point environment(s) ' . trim($content) . ' to repository ' . Label::white($repoController->getName()) . '⸺' . Label::white($repoController->getDateFormatted())); } if ($repoController->getPackageType() == 'deb') { - History::set('Running task: point environment(s) ' . trim($content) . ' to repository ' . $repoController->getName() . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection() . '⸺' . $repoController->getDateFormatted() . ''); + History::set('Running task: point environment(s) ' . trim($content) . ' to repository ' . Label::white($repoController->getName() . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection()) . '⸺' . Label::white($repoController->getDateFormatted())); } unset($repoController); diff --git a/www/controllers/Task/Form/Form.php b/www/controllers/Task/Form/Form.php index fab2243f5..8c6758160 100644 --- a/www/controllers/Task/Form/Form.php +++ b/www/controllers/Task/Form/Form.php @@ -3,9 +3,14 @@ namespace Controllers\Task\Form; use Exception; +use Controllers\User\User; use Controllers\Repo\Repo; +use Controllers\Environment; +use Controllers\Task\Target; use Controllers\Utils\Validate; -use Controllers\Repo\Environment; +use Controllers\Repo\Listing as RepoListing; +use Controllers\Repo\Environment as RepoEnvironment; +use Controllers\History\Save as History; use Controllers\Task\Scheduled as ScheduledTask; use Controllers\User\Permission\Repo as RepoPermission; @@ -16,70 +21,92 @@ class Form /** * Return the task form to the user according to his selection */ - public function get(string $action, array $repos) : string + public function get(string $action, array $repos): string { - $userController = new \Controllers\User\User(); + $userController = new User(); + $repoEnvController = new RepoEnvironment(); + $repoListingController = new RepoListing(); + $scheduledTaskController = new ScheduledTask(); + + // Get the list of email addresses to populate the recipient selector $usersEmail = $userController->getEmails(); + // Get current tags to populate the tag selector + $tags = $repoListingController->listTags(); + + // Initialize the form content $content = '
';
/**
* Include form template
@@ -73,8 +73,6 @@ public function get(array $repos) : string
echo '
';
- echo ''; - $content .= ob_get_clean(); } @@ -152,13 +150,6 @@ public function edit(array $params) : void $repoController->updateSource($param['repo-id'], $param['source']); } - /** - * Update snapshot description - * TODO: no editable description for now - */ - // $repoController->updateDescription($param['snap-id'], $description); - // $snapshotController->updateDescription($param['snap-id'], $description); - /** * Add history */ diff --git a/www/controllers/Repo/Environment.php b/www/controllers/Repo/Environment.php index f99a3f937..8a95806fa 100644 --- a/www/controllers/Repo/Environment.php +++ b/www/controllers/Repo/Environment.php @@ -2,8 +2,7 @@ namespace Controllers\Repo; -use Exception; -use Controllers\Utils\Validate; +use \Controllers\Environment as GlobalEnvironment; class Environment { @@ -15,19 +14,19 @@ public function __construct() } /** - * Return all environments associated to a repository ID + * Return all environments associated to a snapshot Id */ - public function getByRepoId(int $repoId): array + public function getBySnapId(int $snapId): array { - return $this->model->getByRepoId($repoId); + return $this->model->getBySnapId($snapId); } /** * Associate a new environment to a snapshot */ - public function add(int $snapId, string $env, string $description = '') : void + public function add(int $snapId, string $env) : void { - $this->model->add($snapId, $env, $description); + $this->model->add($snapId, $env); } /** @@ -38,19 +37,6 @@ public function remove(int $id) : void $this->model->remove($id); } - /** - * Update environment description - */ - public function updateDescription(int $id, string $description) : void - { - // Description should not contain single quotes or backslashes - if (str_contains($description, "'") || str_contains($description, "\\") || str_contains($description, '')) { - throw new Exception('Description contains invalid characters'); - } - - $this->model->updateDescription($id, Validate::string($description)); - } - /** * Return true if the repository environment Id exists */ diff --git a/www/controllers/Repo/Listing.php b/www/controllers/Repo/Listing.php index e1101766f..84a195cb4 100644 --- a/www/controllers/Repo/Listing.php +++ b/www/controllers/Repo/Listing.php @@ -46,4 +46,20 @@ public function listSnapshots(int $repoId) : array { return $this->model->listSnapshots($repoId); } + + /** + * Return the list of repositories matching the specified filters, with their latest active snapshot Id + */ + public function listByTarget(string $groupId = '', array $tags = [], string $packageType = '') : array + { + return $this->model->listByTarget($groupId, $tags, $packageType); + } + + /** + * Return the list of all distinct tags used by repositories + */ + public function listTags(): array + { + return $this->model->listTags(); + } } diff --git a/www/controllers/Repo/Package/Sync.php b/www/controllers/Repo/Package/Sync.php index bad8438bf..e3b8bb086 100644 --- a/www/controllers/Repo/Package/Sync.php +++ b/www/controllers/Repo/Package/Sync.php @@ -58,12 +58,12 @@ private function syncPackage() if ($this->repoSnapshotController->getDateById($this->repoController->getSnapId()) != $this->repoController->getDate()) { if ($this->repoController->getPackageType() == 'rpm') { if ($this->rpmRepoController->existsSnapDate($this->repoController->getName(), $this->repoController->getReleasever(), $this->repoController->getDate())) { - throw new Exception('A snapshot already exists on the ' . Label::black($this->repoController->getDateFormatted())); + throw new Exception('A snapshot already exists on the ' . Label::white($this->repoController->getDateFormatted())); } } if ($this->repoController->getPackageType() == 'deb') { if ($this->debRepoController->existsSnapDate($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection(), $this->repoController->getDate())) { - throw new Exception('A snapshot already exists on the ' . Label::black($this->repoController->getDateFormatted())); + throw new Exception('A snapshot already exists on the ' . Label::white($this->repoController->getDateFormatted())); } } } diff --git a/www/controllers/Repo/Repo.php b/www/controllers/Repo/Repo.php index eb34138d1..0dbb5c70f 100644 --- a/www/controllers/Repo/Repo.php +++ b/www/controllers/Repo/Repo.php @@ -25,8 +25,9 @@ class Repo private $date; private $dateFormatted; private $time; - private $env; + private $env = []; private $description; + private $tags = []; private $group; private $advancedParams = []; private $signed; @@ -117,6 +118,11 @@ public function setDescription($description = ''): void $this->description = Validate::string($description); } + public function setTags(array $tags = []): void + { + $this->tags = $tags; + } + public function setSource(string $source): void { $this->source = $source; @@ -199,6 +205,7 @@ public function getPackageType(): string public function getEnv(): string|array { + // return $this->env ?? []; return $this->env; } @@ -257,6 +264,11 @@ public function getDescription(): string|null return $this->description; } + public function getTags(): array + { + return $this->tags; + } + public function getGroup(): string|null { return $this->group; @@ -292,74 +304,76 @@ public function getAllById(string|int|null $repoId = null, string|int|null $snap { $data = $this->model->getAllById($repoId, $snapId, $envId); - if (!empty($data['repoId'])) { - $this->setRepoId($data['repoId']); - } - if (!empty($data['snapId'])) { - $this->setSnapId($data['snapId']); - } - if (!empty($data['envId'])) { - $this->setEnvId($data['envId']); - } - if (!empty($data['Source'])) { - $this->setSource($data['Source']); - } - if (!empty($data['Name'])) { - $this->setName($data['Name']); - } - if (!empty($data['Releasever'])) { - $this->setReleasever($data['Releasever']); - } - if (!empty($data['Dist'])) { - $this->setDist($data['Dist']); - } - if (!empty($data['Section'])) { - $this->setSection($data['Section']); - } - if (!empty($data['Package_type'])) { - $this->setPackageType($data['Package_type']); - } - if (!empty($data['Date'])) { - $this->setDate($data['Date']); - } - if (!empty($data['Time'])) { - $this->setTime($data['Time']); - } - if (!empty($data['Status'])) { - $this->setStatus($data['Status']); - } - if (!empty($data['Env'])) { - $this->setEnv($data['Env']); - } - if (!empty($data['Type'])) { - $this->setType($data['Type']); - } - if (!empty($data['Signed'])) { - $this->setSigned($data['Signed']); - } - if (!empty($data['Reconstruct'])) { - $this->setRebuild($data['Reconstruct']); - } - if (!empty($data['Description'])) { - $this->setDescription($data['Description']); - } - if (!empty($data['Arch'])) { - $this->setArch(explode(',', $data['Arch'])); - } + try { + if (!empty($data['repoId'])) { + $this->setRepoId($data['repoId']); + } + if (!empty($data['snapId'])) { + $this->setSnapId($data['snapId']); + } + if (!empty($data['envId'])) { + $this->setEnvId($data['envId']); + } + if (!empty($data['Source'])) { + $this->setSource($data['Source']); + } + if (!empty($data['Name'])) { + $this->setName($data['Name']); + } + if (!empty($data['Releasever'])) { + $this->setReleasever($data['Releasever']); + } + if (!empty($data['Dist'])) { + $this->setDist($data['Dist']); + } + if (!empty($data['Section'])) { + $this->setSection($data['Section']); + } + if (!empty($data['Package_type'])) { + $this->setPackageType($data['Package_type']); + } + if (!empty($data['Date'])) { + $this->setDate($data['Date']); + } + if (!empty($data['Time'])) { + $this->setTime($data['Time']); + } + if (!empty($data['Status'])) { + $this->setStatus($data['Status']); + } + if (!empty($data['Env'])) { + $this->setEnv($data['Env']); + } + if (!empty($data['Type'])) { + $this->setType($data['Type']); + } + if (!empty($data['Signed'])) { + $this->setSigned($data['Signed']); + } + if (!empty($data['Reconstruct'])) { + $this->setRebuild($data['Reconstruct']); + } + if (!empty($data['Arch'])) { + $this->setArch(explode(',', $data['Arch'])); + } + if (!empty($data['Description'])) { + $this->setDescription($data['Description']); + } + if (!empty($data['Tags'])) { + $tags = explode(',', $data['Tags']); + $this->setTags($tags); + } - /** - * Extract Advanced_params JSON - * This includes package include/exclude, metadata custom fields and potentially other parameters in the future - * It is optional and can be empty - */ - if (!empty($data['Advanced_params'])) { - try { + /** + * Advanced_params includes package include/exclude, metadata custom fields and potentially other parameters in the future + * It is optional and can be empty + */ + if (!empty($data['Advanced_params'])) { $advancedParams = json_decode($data['Advanced_params'], true, 512, JSON_THROW_ON_ERROR); - } catch (JsonException $e) { - throw new Exception('Failed to decode advanced parameters JSON: ' . $e->getMessage()); + $this->setAdvancedParams($advancedParams); } - - $this->setAdvancedParams($advancedParams); + } catch (JsonException $e) { + throw new Exception('Failed to decode JSON data from database: ' . $e->getMessage()); } } @@ -533,4 +547,46 @@ public function updateSource(int $repoId, string $source): void { $this->model->updateSource($repoId, $source); } + + /** + * Update description + */ + public function updateDescription(int $id, string $description): void + { + // Description should not contain single quotes or backslashes + if (str_contains($description, "'") || str_contains($description, "\\") || str_contains($description, '')) { + throw new Exception('Description contains invalid characters'); + } + + $this->model->updateDescription($id, Validate::string($description)); + } + + /** + * Update tags + */ + public function updateTags(int $id, array $tags): void + { + $validTags = []; + + foreach ($tags as $tag) { + $tag = trim($tag); + + // Ignore empty tags + if (empty($tag)) { + continue; + } + + // Tags must be alphanumeric (hyphen and underscore allowed) + if (!Validate::alphaNumericHyphen($tag)) { + throw new Exception('Tag ' . $tag . ' contains invalid characters'); + } + + // Avoid duplicates + if (!in_array($tag, $validTags)) { + $validTags[] = $tag; + } + } + + $this->model->updateTags($id, implode(',', $validTags)); + } } diff --git a/www/controllers/Repo/Rpm.php b/www/controllers/Repo/Rpm.php index 264c8ad41..009995ed9 100644 --- a/www/controllers/Repo/Rpm.php +++ b/www/controllers/Repo/Rpm.php @@ -2,8 +2,6 @@ namespace Controllers\Repo; -use Exception; - class Rpm extends \Controllers\Repo\Repo { public function __construct() @@ -20,14 +18,6 @@ public function getIdByNameReleasever(string $name, string $releaseVersion) : in return $this->model->getIdByNameReleasever($name, $releaseVersion); } - /** - * Return repository environment description - */ - public function getDescriptionByName(string $name, string $releaseVersion, string $env) : string|null - { - return $this->model->getDescriptionByName($name, $releaseVersion, $env); - } - /** * Return environment Id from repo name */ diff --git a/www/controllers/Repo/Snapshot/Package.php b/www/controllers/Repo/Snapshot/Package.php index 691a2f33f..8f08e17fb 100644 --- a/www/controllers/Repo/Snapshot/Package.php +++ b/www/controllers/Repo/Snapshot/Package.php @@ -126,6 +126,11 @@ public function upload(array $packages, bool $overwrite = false, bool $ignoreIfE throw new Exception('You are not allowed to upload packages'); } + // Check if snapshot has a protected env + if ($this->repoSnapshotController->hasProtectedEnv($this->snapId)) { + throw new Exception('Snapshot has a protected environment and cannot be modified. Please contact your administrator.'); + } + // Both overwrite and ignoreIfExists cannot be true at the same time if ($overwrite && $ignoreIfExists) { throw new Exception('Options overwrite and ignore-if-exists are mutually exclusive'); @@ -331,6 +336,11 @@ public function delete(array $files): array throw new Exception('You are not allowed to delete packages.'); } + // Check if snapshot has a protected env + if ($this->repoSnapshotController->hasProtectedEnv($this->snapId)) { + throw new Exception('Snapshot has a protected environment and cannot be modified. Please contact your administrator.'); + } + foreach ($files as $file) { $file = REPOS_DIR . '/' . $file; diff --git a/www/controllers/Repo/Snapshot/Snapshot.php b/www/controllers/Repo/Snapshot/Snapshot.php index 3179e2a83..c1133c66d 100644 --- a/www/controllers/Repo/Snapshot/Snapshot.php +++ b/www/controllers/Repo/Snapshot/Snapshot.php @@ -160,6 +160,24 @@ public function updateAdvancedParams(int $snapId, array $advancedParams): void $this->model->updateAdvancedParams($snapId, $advancedParams); } + /** + * Return true if the snapshot has a protected environment + */ + public function hasProtectedEnv(int $snapId): bool + { + $envController = new \Controllers\Environment(); + $repoEnvController = new \Controllers\Repo\Environment(); + + // Get the list of environments associated with the snapshot and check if any of them is protected + foreach ($repoEnvController->getBySnapId($snapId) as $env) { + if ($envController->isProtected($env)) { + return true; + } + } + + return false; + } + /** * Clean unused snapshots and return a message */ diff --git a/www/controllers/Repo/Task/Create.php b/www/controllers/Repo/Task/Create.php index 1984aa53d..0440e183c 100644 --- a/www/controllers/Repo/Task/Create.php +++ b/www/controllers/Repo/Task/Create.php @@ -56,7 +56,7 @@ public function __construct(string $taskId) /** * Create repository */ - public function execute() + public function execute(): void { if ($this->type == 'mirror') { $this->mirror(); @@ -70,52 +70,38 @@ public function execute() /** * Create a mirror repository */ - private function mirror() + private function mirror(): void { - /** - * Define the date and time of the new mirror snapshot - */ + // Define the date and time of the new mirror snapshot $this->repoController->setDate(date('Y-m-d')); $this->repoController->setTime(date('H:i')); - /** - * Sync packages - */ + // Sync packages $this->syncPackage(); - /** - * Sign repository / packages - */ + // Sign repository / packages $this->signPackage(); - /** - * Create repository and symlinks - */ + // Create repository and symlinks $this->createMetadata(); - /** - * Finalize repository (add to database and set permissions) - */ + // Finalize repository (add to database and set permissions) $this->finalize(); } /** * Create a local repository */ - private function local() + private function local(): void { - /** - * Set today date and time as target date and time - */ + // Set today date and time as target date and time $this->repoController->setDate(date('Y-m-d')); $this->repoController->setTime(date('H:i')); $this->taskLogStepController->new('create-repo', 'CREATING REPOSITORY'); $this->taskLogSubStepController->new('create-dirs', 'CREATING DIRECTORIES'); - /** - * Check if a repo/section with the same name is already active with snapshots - */ + // Check if a repo/section with the same name is already active with snapshots if ($this->repoController->getPackageType() == 'rpm') { if ($this->rpmRepoController->isActive($this->repoController->getName(), $this->repoController->getReleasever())) { throw new Exception(Label::white($this->repoController->getName() . ' ❯ ' . $this->repoController->getReleasever()) . ' repository already exists'); @@ -127,9 +113,7 @@ private function local() } } - /** - * Define snapshot directory path - */ + // Define snapshot directory path if ($this->repoController->getPackageType() == 'rpm') { $snapshotPath = REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/' . $this->repoController->getDate(); } @@ -137,9 +121,7 @@ private function local() $snapshotPath = REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $this->repoController->getDate(); } - /** - * Create snapshot directory and subdirectories - */ + // Create snapshot directory and subdirectories if ($this->repoController->getPackageType() == 'rpm') { if (!is_dir($snapshotPath . '/packages')) { if (!mkdir($snapshotPath . '/packages', 0770, true)) { @@ -155,9 +137,7 @@ private function local() } } - /** - * Create environment symlink, if an environment has been specified - */ + // Create environment symlink, if an environment has been specified if (!empty($this->repoController->getEnv())) { foreach ($this->repoController->getEnv() as $env) { if ($this->repoController->getPackageType() == 'rpm') { @@ -167,18 +147,14 @@ private function local() $link = REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $env; } - /** - * If a symlink with the same name already exists, we remove it - */ + // If a symlink with the same name already exists, we remove it if (is_link($link)) { if (!unlink($link)) { throw new Exception('Could not remove existing symlink ' . $link); } } - /** - * Create symlink - */ + // Create symlink if (!symlink($this->repoController->getDate(), $link)) { throw new Exception('Could not point environment to the repository'); } @@ -191,73 +167,50 @@ private function local() $this->taskLogSubStepController->new('updating-database', 'UPDATING DATABASE'); - /** - * Check if repository already exists in database - */ + // If currently no rpm repo of this name exists in the database then we add it if ($this->repoController->getPackageType() == 'rpm') { - $exists = $this->rpmRepoController->exists($this->repoController->getName(), $this->repoController->getReleasever()); - } - if ($this->repoController->getPackageType() == 'deb') { - $exists = $this->debRepoController->exists($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection()); - } - - /** - * If no repo of this name exists in database then we add it - * Note: here we set the source as $this->repoController->getName() - */ - if ($exists === false) { - /** - * Retrieve repo Id from the last insert row - */ - if ($this->repoController->getPackageType() == 'rpm') { + if (!$this->rpmRepoController->exists($this->repoController->getName(), $this->repoController->getReleasever())) { + // Note: for local repositories, source is set to repo name $this->rpmRepoController->add($this->repoController->getName(), $this->repoController->getReleasever(), $this->repoController->getName()); + + // Repository Id becomes the Id of the last inserted row in the database $this->repoController->setRepoId($this->rpmRepoController->getLastInsertRowID()); - } - if ($this->repoController->getPackageType() == 'deb') { - $this->debRepoController->add($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection(), $this->repoController->getName()); - $this->repoController->setRepoId($this->debRepoController->getLastInsertRowID()); - } - /** - * Else if a repo of this name exists, we attach this new snapshot and this new env to this repo - */ - } else { - /** - * Retrieve and set repo Id from database - */ - if ($this->repoController->getPackageType() == 'rpm') { - $repoId = $this->rpmRepoController->getIdByNameReleasever($this->repoController->getName(), $this->repoController->getReleasever()); + // Otherwise, if a repo of the same name exists, we retrieve its Id from the database + } else { + $this->repoController->setRepoId($this->rpmRepoController->getIdByNameReleasever($this->repoController->getName(), $this->repoController->getReleasever())); } + } - if ($this->repoController->getPackageType() == 'deb') { - $repoId = $this->debRepoController->getIdByNameDistComponent($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection()); - } + // If currently no deb repo of this name exists in the database then we add it + if ($this->repoController->getPackageType() == 'deb') { + if (!$this->debRepoController->exists($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection())) { + // Note: for local repositories, source is set to repo name + $this->debRepoController->add($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection(), $this->repoController->getName()); - if (empty($repoId)) { - throw new Exception('Could not retrieve repository Id from database'); - } + // Repository Id becomes the Id of the last inserted row in the database + $this->repoController->setRepoId($this->debRepoController->getLastInsertRowID()); - $this->repoController->setRepoId($repoId); + // Otherwise, if a repo of the same name exists, we retrieve its Id from the database + } else { + $this->repoController->setRepoId($this->debRepoController->getIdByNameDistComponent($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection())); + } } - unset($exists, $repoId); + // Apply description and tags after the repository Id has been determined, + $this->repoController->updateDescription($this->repoController->getRepoId(), (string) $this->repoController->getDescription()); + $this->repoController->updateTags($this->repoController->getRepoId(), $this->repoController->getTags()); - /** - * Add snapshot to database - */ + // Add snapshot to database $this->repoSnapshotController->add($this->repoController->getDate(), $this->repoController->getTime(), 'false', $this->repoController->getArch(), $this->repoController->getAdvancedParams(), $this->repoController->getType(), 'active', $this->repoController->getRepoId()); - /** - * Retrieve snapshot Id from the last insert row - */ + // Retrieve snapshot Id from the last insert row $this->repoController->setSnapId($this->repoSnapshotController->getLastInsertRowID()); - /** - * Add env to database if an env has been specified by the user - */ + // Add env to database if an env has been specified by the user if (!empty($this->repoController->getEnv())) { foreach ($this->repoController->getEnv() as $env) { - $this->repoEnvController->add($this->repoController->getSnapId(), $env, $this->repoController->getDescription()); + $this->repoEnvController->add($this->repoController->getSnapId(), $env); } } @@ -265,18 +218,14 @@ private function local() $this->taskLogSubStepController->new('applying-permissions', 'APPLYING PERMISSIONS'); - /** - * Apply permissions on the new repo - */ + // Apply permissions on the new repo File::recursiveChmod($snapshotPath, 'dir', 770); File::recursiveChmod($snapshotPath, 'file', 660); $this->taskLogSubStepController->completed(); $this->taskLogStepController->completed(); - /** - * Add repo to group if a group has been specified - */ + // Add repo to group if a group has been specified if (!empty($this->repoController->getGroup())) { $this->taskLogStepController->new('add-to-group', 'ADDING REPOSITORY TO GROUP'); $this->repoController->addRepoIdToGroup($this->repoController->getRepoId(), $this->repoController->getGroup()); diff --git a/www/controllers/Repo/Task/Delete.php b/www/controllers/Repo/Task/Delete.php index d01a6d1e3..602ef7cad 100644 --- a/www/controllers/Repo/Task/Delete.php +++ b/www/controllers/Repo/Task/Delete.php @@ -33,7 +33,7 @@ public function __construct(string $taskId) /** * Delete a repository snapshot */ - public function execute() + public function execute(): void { $deleted = true; diff --git a/www/controllers/Repo/Task/Duplicate.php b/www/controllers/Repo/Task/Duplicate.php index 72722a25d..77612c851 100644 --- a/www/controllers/Repo/Task/Duplicate.php +++ b/www/controllers/Repo/Task/Duplicate.php @@ -45,16 +45,12 @@ public function execute() $this->taskLogStepController->new('duplicating', 'DUPLICATING'); $this->taskLogSubStepController->new('initializing', 'INITIALIZING'); - /** - * Check if source repo snapshot exists - */ + // Check if source repo snapshot exists if ($this->sourceRepoController->existsSnapId($this->sourceRepoController->getSnapId()) === false) { throw new Exception('Source repository snapshot does not exist'); } - /** - * Check if a repo with the same name already exists - */ + // Check if a repo with the same name already exists if ($this->repoController->getPackageType() == 'rpm') { if ($this->rpmRepoController->isActive($this->repoController->getName(), $this->repoController->getReleasever())) { throw new Exception('A repo ' . $this->repoController->getName() . ' (release ver. ' . $this->repoController->getReleasever() . ') already exists'); @@ -66,9 +62,7 @@ public function execute() } } - /** - * Define source snapshot path - */ + // Define source snapshot path if ($this->sourceRepoController->getPackageType() == 'rpm') { $sourceSnapshotPath = REPOS_DIR . '/rpm/' . $this->sourceRepoController->getName() . '/' . $this->sourceRepoController->getReleasever() . '/' . $this->sourceRepoController->getDate(); } @@ -76,9 +70,7 @@ public function execute() $sourceSnapshotPath = REPOS_DIR . '/deb/' . $this->sourceRepoController->getName() . '/' . $this->sourceRepoController->getDist() . '/' . $this->sourceRepoController->getSection() . '/' . $this->sourceRepoController->getDate(); } - /** - * Define target snapshot path - */ + // Define target snapshot path if ($this->repoController->getPackageType() == 'rpm') { $parentDir = REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever(); $targetSnapshotPath = REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/'. $this->repoController->getDate(); @@ -88,38 +80,28 @@ public function execute() $targetSnapshotPath = REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $this->repoController->getDate(); } - /** - * Create parent directory if it does not already exists - */ + // Create parent directory if it does not already exists if (!is_dir($parentDir)) { if (!mkdir($parentDir, 0770, true)) { throw new Exception('Cannot create directory ' . $parentDir); } } - /** - * Set temporary dir path - */ + // Set temporary dir path $tempDir = REPOS_DIR . '/temporary-task-' . $this->taskId; - /** - * Create the temporary directory if it does not already exist (might exist if the task has been stopped and restarted) - */ + // Create the temporary directory if it does not already exist (might exist if the task has been stopped and restarted) if (!file_exists($tempDir)) { if (!mkdir($tempDir, 0770, true)) { throw new Exception('Cannot create temporary directory ' . $tempDir); } } - /** - * Get all files and directories in the source repository - */ + // Get all files and directories in the source repository $dirs = File::recursiveScan($sourceSnapshotPath, 'dir', true); $files = File::recursiveScan($sourceSnapshotPath, 'file', true); - /** - * Create all directories in the temporary directory - */ + // Create all directories in the temporary directory foreach ($dirs as $dir) { if (!file_exists($tempDir . '/' . $dir)) { if (!mkdir($tempDir . '/' . $dir, 0770, true)) { @@ -139,19 +121,13 @@ public function execute() foreach ($files as $file) { $fileCounter++; - /** - * Count total number of files to copy - */ + // Count total number of files to copy $totalFiles = count($files); - /** - * Show progress - */ + // Show progress $this->taskLogSubStepController->new('copying-file-' . $fileCounter, 'COPYING FILE (' . $fileCounter . '/' . $totalFiles . ')', 'From ' . $sourceSnapshotPath . '/' . $file . '
To ' . $tempDir . '/' . $file); - /** - * Ignore file if it was already copied (completed file exists) - */ + // Ignore file if it was already copied (completed file exists) if (file_exists($tempDir . '/' . $file) and file_exists($tempDir . '/' . $file . '.completed')) { $this->taskLogSubStepController->completed('Already exists (ignoring)'); continue; @@ -167,16 +143,12 @@ public function execute() } } - /** - * Copy the file - */ + // Copy the file if (!copy($sourceSnapshotPath . '/' . $file, $tempDir . '/' . $file)) { throw new Exception('Cannot copy file ' . $sourceSnapshotPath . '/' . $file . ' to ' . $tempDir . '/' . $file); } - /** - * Create the completed file - */ + // Create the completed file if (!touch($tempDir . '/' . $file . '.completed')) { throw new Exception('Cannot create copy-completed file ' . $tempDir . '/' . $file . '.completed'); } @@ -186,9 +158,7 @@ public function execute() unset($dirs, $files); - /** - * Rename the temporary directory to the target directory - */ + // Rename the temporary directory to the target directory $this->taskLogSubStepController->new('moving-temp-dir', 'MOVING TEMPORARY DIRECTORY'); if (!rename($tempDir, $targetSnapshotPath)) { throw new Exception('Cannot rename temporary directory ' . $tempDir . ' to ' . $targetSnapshotPath); @@ -208,23 +178,17 @@ public function execute() } } - /** - * Set step 'DUPLICATING' as completed - */ + // Set step 'DUPLICATING' as completed $this->taskLogStepController->completed(); - /** - * On a deb repo, the duplicated repo metadata must be rebuilded - */ + // On a deb repo, the duplicated repo metadata must be rebuilded if ($this->repoController->getPackageType() == 'deb') { $this->createMetadata(); } $this->taskLogStepController->new('finalizing', 'FINALIZING'); - /** - * Create a symlink to the new repo, only if the user has specified an environment - */ + // Create a symlink to the new repo, only if the user has specified an environment if (!empty($this->repoController->getEnv())) { foreach ($this->repoController->getEnv() as $env) { $this->taskLogSubStepController->new('pointing-environment', 'POINTING ENVIRONMENT'); @@ -236,18 +200,14 @@ public function execute() $link = REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $env; } - /** - * If a symlink with the same name already exists, we remove it - */ + // If a symlink with the same name already exists, we remove it if (is_link($link)) { if (!unlink($link)) { throw new Exception('Could not remove existing symlink ' . $link); } } - /** - * Create symlink - */ + // Create symlink if (!symlink($this->repoController->getDate(), $link)) { throw new Exception('Could not point environment to the repository'); } @@ -260,9 +220,7 @@ public function execute() $this->taskLogSubStepController->new('inserting-database', 'INSERTING REPOSITORY IN DATABASE'); - /** - * Insert the new repo in database and retrieve its Id - */ + // Insert the new repo in database and retrieve its Id if ($this->repoController->getPackageType() == 'rpm') { $this->rpmRepoController->add($this->repoController->getName(), $this->repoController->getReleasever(), $this->repoController->getSource()); $targetRepoId = $this->rpmRepoController->getLastInsertRowID(); @@ -272,14 +230,13 @@ public function execute() $targetRepoId = $this->debRepoController->getLastInsertRowID(); } - /** - * Add the new repo snapshot in database - */ + // Repository Id becomes the Id of the last inserted row in the database + $this->repoController->setRepoId($targetRepoId); + + // Add the new repo snapshot in database $this->repoSnapshotController->add($this->repoController->getDate(), $this->repoController->getTime(), $this->repoController->getSigned(), $this->repoController->getArch(), $this->repoController->getAdvancedParams(), $this->repoController->getType(), $this->repoController->getStatus(), $targetRepoId); - /** - * Retrieve the Id of the new repo snapshot in database - */ + // Retrieve the Id of the new repo snapshot in database $targetSnapId = $this->repoSnapshotController->getLastInsertRowID(); // Calculate and update snapshot size @@ -287,28 +244,26 @@ public function execute() $this->repoSnapshotController->updateSize($targetSnapId, Directory::getSize($targetSnapshotPath)); $this->taskLogSubStepController->completed(); - /** - * Add the new repo environment in database, only if the user has specified an environment - */ + // Add the new repo environment in database, only if the user has specified an environment if (!empty($this->repoController->getEnv())) { foreach ($this->repoController->getEnv() as $env) { - $this->repoEnvController->add($targetSnapId, $env, $this->repoController->getDescription()); + $this->repoEnvController->add($targetSnapId, $env); } } - /** - * Add the new repo to a group if a group has been specified - */ + // Apply description and tags after the repository Id has been determined, + $this->repoController->updateDescription($this->repoController->getRepoId(), (string) $this->repoController->getDescription()); + $this->repoController->updateTags($this->repoController->getRepoId(), $this->repoController->getTags()); + + // Add the new repo to a group if a group has been specified if (!empty($this->repoController->getGroup())) { - $this->repoController->addRepoIdToGroup($targetRepoId, $this->repoController->getGroup()); + $this->repoController->addRepoIdToGroup($this->repoController->getRepoId(), $this->repoController->getGroup()); } $this->taskLogSubStepController->completed(); $this->taskLogStepController->completed(); - /** - * If an error occurred after the temporary directory was renamed, clean the target directory - */ + // If an error occurred after the temporary directory was renamed, clean the target directory } catch (Exception $e) { if (file_exists($targetSnapshotPath)) { if (!Directory::deleteRecursive($targetSnapshotPath)) { @@ -316,9 +271,7 @@ public function execute() } } - /** - * Throw initial exception to set the task as error - */ + // Throw initial exception to set the task as error throw new Exception($e->getMessage()); } } diff --git a/www/controllers/Repo/Task/Env.php b/www/controllers/Repo/Task/Env.php index 4d9634645..de7968953 100644 --- a/www/controllers/Repo/Task/Env.php +++ b/www/controllers/Repo/Task/Env.php @@ -32,11 +32,7 @@ public function __construct(string $taskId) public function execute() { foreach ($this->repoController->getEnv() as $env) { - $actualDescription = null; - - /** - * Define snapshot directory path - */ + // Define snapshot directory path if ($this->repoController->getPackageType() == 'rpm') { $snapshotPath = REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/' . $this->repoController->getDate(); } @@ -47,44 +43,19 @@ public function execute() $this->taskLogStepController->new('point-env-' . $env, 'POINT ENVIRONMENT ' . Label::envtag($env)); $this->taskLogSubStepController->new('checking-' . $env, 'CHECKING'); - /** - * Check if the source snapshot exists - */ + // Check if the source snapshot exists if (!$this->repoController->existsSnapId($this->repoController->getSnapId())) { throw new Exception('' . $this->repoController->getDateFormatted() . ' repository snapshot does not exist anymore'); } - /** - * Check if an environment of the same name already exists on the target snapshot - */ + // Check if an environment of the same name already points to the target snapshot if ($this->repoController->existsSnapIdEnv($this->repoController->getSnapId(), $env) === true) { if ($this->repoController->getPackageType() == 'rpm') { - throw new Exception(Label::envtag($env) . ' environment already exists on ' . $this->repoController->getName() . '⸺' . $this->repoController->getDateFormatted() . ''); + throw new Exception(Label::envtag($env) . ' environment already points to ' . $this->repoController->getName() . '⸺' . $this->repoController->getDateFormatted() . ''); } if ($this->repoController->getPackageType() == 'deb') { - throw new Exception(Label::envtag($env) . ' environment already exists on ' . $this->repoController->getName() . ' ❯ ' . $this->repoController->getDist() . ' ❯ ' . $this->repoController->getSection() . '⸺' . $this->repoController->getDateFormatted() . ''); - } - } - - /** - * If the user did not specify any description then we get the one currently in place on the environment of the same name (if the environment exists and if it has a description) - */ - if (empty($this->repoController->getDescription())) { - if ($this->repoController->getPackageType() == 'rpm') { - $actualDescription = $this->rpmRepoController->getDescriptionByName($this->repoController->getName(), $this->repoController->getReleasever(), $env); - } - if ($this->repoController->getPackageType() == 'deb') { - $actualDescription = $this->debRepoController->getDescriptionByName($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection(), $env); - } - - /** - * If the description is empty then the description will remain empty - */ - if (!empty($actualDescription)) { - $this->repoController->setDescription(htmlspecialchars_decode($actualDescription)); - } else { - $this->repoController->setDescription(''); + throw new Exception(Label::envtag($env) . ' environment already points to ' . $this->repoController->getName() . ' ❯ ' . $this->repoController->getDist() . ' ❯ ' . $this->repoController->getSection() . '⸺' . $this->repoController->getDateFormatted() . ''); } } @@ -92,18 +63,12 @@ public function execute() $this->taskLogSubStepController->new('create-symlink-' . $env, 'CREATING SYMLINK'); if ($this->repoController->getPackageType() == 'rpm') { - /** - * If there is already an environment of the same name pointing to a snapshot. - */ + // If there is already an environment of the same name pointing to a snapshot if ($this->rpmRepoController->existsEnv($this->repoController->getName(), $this->repoController->getReleasever(), $env)) { - /** - * Retrieve the Id of the already existing environment - */ + // Retrieve the Id of the already existing environment $actualEnvIds = $this->rpmRepoController->getEnvIdFromRepoName($this->repoController->getName(), $this->repoController->getReleasever(), $env); - /** - * Delete the possible environment of the same name already pointing to a snapshot of this repo (if there is one) - */ + // Delete the possible environment of the same name already pointing to a snapshot of this repo (if there is one) if (!empty($actualEnvIds)) { foreach ($actualEnvIds as $actualEnvId) { $this->repoEnvController->remove($actualEnvId); @@ -111,36 +76,26 @@ public function execute() } } - /** - * Delete symbolic link if already exists - */ + // Delete symbolic link if already exists if (is_link(REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/' . $env)) { if (!unlink(REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/' . $env)) { throw new Exception('Could not delete existing symbolic link: ' . REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/' . $env); } } - /** - * Create symbolic link - */ + // Create symbolic link if (!symlink($this->repoController->getDate(), REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/' . $env)) { throw new Exception('Could not create symbolic link: ' . REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/' . $env); } } if ($this->repoController->getPackageType() == 'deb') { - /** - * If there is already an environment of the same name pointing to a snapshot. - */ + // If there is already an environment of the same name pointing to a snapshot if ($this->debRepoController->existsEnv($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection(), $env)) { - /** - * Retrieve the Id of the already existing environment - */ + // Retrieve the Id of the already existing environment $actualEnvIds = $this->debRepoController->getEnvIdFromRepoName($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection(), $env); - /** - * Delete the possible environment of the same name already pointing to a snapshot of this repo (if there is one) - */ + // Delete the possible environment of the same name already pointing to a snapshot of this repo (if there is one) if (!empty($actualEnvIds)) { foreach ($actualEnvIds as $actualEnvId) { $this->repoEnvController->remove($actualEnvId); @@ -148,18 +103,14 @@ public function execute() } } - /** - * Delete symbolic link if already exists - */ + // Delete symbolic link if already exists if (is_link(REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $env)) { if (!unlink(REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $env)) { throw new Exception('Could not delete existing symbolic link: ' . REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $env); } } - /** - * Create symbolic link - */ + // Create symbolic link if (!symlink($this->repoController->getDate(), REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $env)) { throw new Exception('Could not create symbolic link: ' . REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $env); } @@ -167,11 +118,9 @@ public function execute() $this->taskLogSubStepController->completed(); - /** - * Add environment to database - */ + // Add environment to database $this->taskLogSubStepController->new('update-database', 'UPDATING DATABASE'); - $this->repoEnvController->add($this->repoController->getSnapId(), $env, $this->repoController->getDescription()); + $this->repoEnvController->add($this->repoController->getSnapId(), $env); $this->taskLogSubStepController->completed(); $this->taskLogStepController->completed(); } diff --git a/www/controllers/Repo/Task/Finalize.php b/www/controllers/Repo/Task/Finalize.php index e2a9a38da..660b46a45 100644 --- a/www/controllers/Repo/Task/Finalize.php +++ b/www/controllers/Repo/Task/Finalize.php @@ -11,7 +11,7 @@ trait Finalize /** * Finalize the repository: add to the database and apply permissions */ - protected function finalize() + protected function finalize(): void { $this->taskLogStepController->new('finalizing', 'FINALIZING'); @@ -48,7 +48,6 @@ protected function finalize() if ($this->repoController->getPackageType() == 'deb') { if (!$this->debRepoController->exists($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection())) { $this->debRepoController->add($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection(), $this->repoController->getSource()); - // Repository Id becomes the Id of the last inserted row in the database $this->repoController->setRepoId($this->debRepoController->getLastInsertRowID()); @@ -58,6 +57,10 @@ protected function finalize() } } + // Apply description and tags after the repository Id has been determined, + $this->repoController->updateDescription($this->repoController->getRepoId(), (string) $this->repoController->getDescription()); + $this->repoController->updateTags($this->repoController->getRepoId(), $this->repoController->getTags()); + // Add snapshot in database $this->repoSnapshotController->add($this->repoController->getDate(), $this->repoController->getTime(), $this->repoController->getGpgSign(), $this->repoController->getArch(), $this->repoController->getAdvancedParams(), $this->repoController->getType(), 'active', $this->repoController->getRepoId()); @@ -67,7 +70,7 @@ protected function finalize() // Add env in database if an env has been specified by the user if (!empty($this->repoController->getEnv())) { foreach ($this->repoController->getEnv() as $env) { - $this->repoEnvController->add($this->repoController->getSnapId(), $env, $this->repoController->getDescription()); + $this->repoEnvController->add($this->repoController->getSnapId(), $env); } } } @@ -123,23 +126,6 @@ protected function finalize() $this->taskLogSubStepController->new('adding-env', 'ADDING ENVIRONMENT'); foreach ($this->repoController->getEnv() as $env) { - // If the user has not specified any description, then we retrieve the one currently in place on the environment of the same name (if the environment exists and if it has a description) - if (empty($this->repoController->getDescription())) { - if ($this->repoController->getPackageType() == 'rpm') { - $actualDescription = $this->rpmRepoController->getDescriptionByName($this->repoController->getName(), $this->repoController->getReleasever(), $env); - } - if ($this->repoController->getPackageType() == 'deb') { - $actualDescription = $this->debRepoController->getDescriptionByName($this->repoController->getName(), $this->repoController->getDist(), $this->repoController->getSection(), $env); - } - - // If the retrieved description is empty then the description will remain empty - if (!empty($actualDescription)) { - $this->repoController->setDescription(htmlspecialchars_decode($actualDescription)); - } else { - $this->repoController->setDescription(''); - } - } - // Retrieve the Id of the environment currently in place (if there is one) if ($this->repoController->getPackageType() == 'rpm') { $actualEnvIds = $this->rpmRepoController->getEnvIdFromRepoName($this->repoController->getName(), $this->repoController->getReleasever(), $env); @@ -156,7 +142,7 @@ protected function finalize() } // Then we declare the new environment and make it point to the previously created snapshot - $this->repoEnvController->add($this->repoController->getSnapId(), $env, $this->repoController->getDescription()); + $this->repoEnvController->add($this->repoController->getSnapId(), $env); } $this->taskLogSubStepController->completed(); diff --git a/www/controllers/Repo/Task/Rebuild.php b/www/controllers/Repo/Task/Rebuild.php index c74aa37bf..5e8893208 100644 --- a/www/controllers/Repo/Task/Rebuild.php +++ b/www/controllers/Repo/Task/Rebuild.php @@ -34,26 +34,18 @@ public function __construct(string $taskId) /** * Rebuild repository metadata */ - public function execute() + public function execute(): void { - /** - * Set snapshot metadata rebuild state in database - */ + // Set snapshot metadata rebuild state in database $this->repoSnapshotController->updateRebuild($this->repoController->getSnapId(), 'running'); - /** - * Sign repository / packages - */ + // Sign repository / packages $this->signPackage(); - /** - * Create repository and symlinks - */ + // Create repository and symlinks $this->createMetadata(); - /** - * Finalize repository (update database, clean temporary files, etc.) - */ + // Finalize repository (update database, clean temporary files, etc.) $this->finalize(); } } diff --git a/www/controllers/Repo/Task/RemoveEnv.php b/www/controllers/Repo/Task/RemoveEnv.php index 72268c778..090ca796e 100644 --- a/www/controllers/Repo/Task/RemoveEnv.php +++ b/www/controllers/Repo/Task/RemoveEnv.php @@ -28,14 +28,12 @@ public function __construct(string $taskId) /** * Remove snapshot environment */ - public function execute() + public function execute(): void { $this->taskLogStepController->new('removing', 'REMOVING'); $this->taskLogSubStepController->new('delete-symlink', 'DELETE SYMLINK'); - /** - * Define environment symlink - */ + // Define environment symlink if ($this->repoController->getPackageType() == 'rpm') { $symlink = REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever() . '/' . $this->repoController->getEnv(); } @@ -44,9 +42,7 @@ public function execute() $symlink = REPOS_DIR . '/deb/' . $this->repoController->getName() . '/' . $this->repoController->getDist() . '/' . $this->repoController->getSection() . '/' . $this->repoController->getEnv(); } - /** - * Delete environment symlink - */ + // Delete environment symlink if (file_exists($symlink)) { if (!unlink($symlink)) { throw new Exception('Failed to delete symlink: ' . $symlink); @@ -55,9 +51,7 @@ public function execute() $this->taskLogSubStepController->completed(); - /** - * Delete environment from database - */ + // Delete environment from database $this->taskLogSubStepController->new('update-database', 'UPDATE DATABASE'); $this->repoEnvController->remove($this->repoController->getEnvId()); $this->taskLogSubStepController->completed(); diff --git a/www/controllers/Repo/Task/Rename.php b/www/controllers/Repo/Task/Rename.php index b893edeb3..c4b0907c3 100644 --- a/www/controllers/Repo/Task/Rename.php +++ b/www/controllers/Repo/Task/Rename.php @@ -13,8 +13,8 @@ public function __construct(string $taskId) { parent::__construct($taskId, 'rename'); - // Get source repository details from its snapshot Id - $this->sourceRepoController->getAllById(null, $this->params['snap-id'], null); + // Get source repository details from its repo Id + $this->sourceRepoController->getAllById($this->params['repo-id']); // Execute the task try { @@ -34,14 +34,14 @@ public function __construct(string $taskId) /** * Rename repository */ - public function execute() + public function execute(): void { $this->taskLogStepController->new('renaming', 'RENAMING'); $this->taskLogSubStepController->new('renaming-directory', 'RENAMING REPOSITORY DIRECTORY'); - // Check if source repo snapshot exists - if ($this->sourceRepoController->existsSnapId($this->sourceRepoController->getSnapId()) === false) { - throw new Exception('Source repository snapshot does not exist'); + // Check if source repo exists + if ($this->sourceRepoController->existsId($this->sourceRepoController->getRepoId()) === false) { + throw new Exception('Source repository does not exist'); } // Check if a repo with the same name already exists @@ -56,7 +56,7 @@ public function execute() } } - // Define source snapshot path + // Define source repository path if ($this->sourceRepoController->getPackageType() == 'rpm') { $sourcePath = REPOS_DIR . '/rpm/' . $this->sourceRepoController->getName() . '/' . $this->sourceRepoController->getReleasever(); } @@ -64,7 +64,7 @@ public function execute() $sourcePath = REPOS_DIR . '/deb/' . $this->sourceRepoController->getName() . '/' . $this->sourceRepoController->getDist() . '/' . $this->sourceRepoController->getSection(); } - // Define target snapshot path + // Define target repository path if ($this->repoController->getPackageType() == 'rpm') { $parentDir = REPOS_DIR . '/rpm/' . $this->repoController->getName(); $targetPath = REPOS_DIR . '/rpm/' . $this->repoController->getName() . '/' . $this->repoController->getReleasever(); @@ -96,24 +96,24 @@ public function execute() $this->taskLogSubStepController->completed(); $this->taskLogStepController->completed(); - if ($this->repoController->getPackageType() == 'deb') { - try { - // On a deb repo, the renamed repository needs to have its metadata rebuilded - $this->createMetadata(); - - // If an error occurred after repository has been moved, try to revert the move - } catch (Exception $e) { - // Try to revert the move - if (file_exists($targetPath)) { - if (!rename($targetPath, $sourcePath)) { - throw new Exception('An error occured while creating the repository metadata: ' . $e->getMessage() . '. Additionally, the system could not revert the renamed repository from ' . $targetPath . ' to ' . $sourcePath . '. Manual intervention is required to restore the repository to its original state.'); - } - } - - // Throw initial exception to set the task as error - throw new Exception('An error occured while creating the repository metadata: ' . $e->getMessage(). ' The renamed repository has been reverted to its original state. Please check that everything is fine before retrying the rename operation.'); - } - } + // if ($this->repoController->getPackageType() == 'deb') { + // try { + // // On a deb repo, the renamed repository needs to have its metadata rebuilded + // $this->createMetadata(); + + // // If an error occurred after repository has been moved, try to revert the move + // } catch (Exception $e) { + // // Try to revert the move + // if (file_exists($targetPath)) { + // if (!rename($targetPath, $sourcePath)) { + // throw new Exception('An error occured while creating the repository metadata: ' . $e->getMessage() . '. Additionally, the system could not revert the renamed repository from ' . $targetPath . ' to ' . $sourcePath . '. Manual intervention is required to restore the repository to its original state.'); + // } + // } + + // // Throw initial exception to set the task as error + // throw new Exception('An error occured while creating the repository metadata: ' . $e->getMessage(). ' The renamed repository has been reverted to its original state. Please check that everything is fine before retrying the rename operation.'); + // } + // } try { $this->taskLogStepController->new('finalizing', 'FINALIZING'); diff --git a/www/controllers/Repo/Task/Update.php b/www/controllers/Repo/Task/Update.php index bbe04cc2a..b2d109b1d 100644 --- a/www/controllers/Repo/Task/Update.php +++ b/www/controllers/Repo/Task/Update.php @@ -40,67 +40,49 @@ public function __construct(string $taskId) /** * Update repository */ - public function execute() + public function execute(): void { - /** - * Define default date and time - */ + // Define default date and time $this->repoController->setDate(date('Y-m-d')); $this->repoController->setTime(date('H:i')); - /** - * Sync packages (if mirror repo) - */ + // Sync packages (if mirror repo) if ($this->repoController->getType() == 'mirror') { $this->syncPackage(); } - /** - * Update repository (if local repo) - */ + // Update repository (if local repo) if ($this->repoController->getType() == 'local') { $this->updateLocal(); } - /** - * Sign repo / packages - */ + // Sign repo / packages $this->signPackage(); - /** - * Create repo and symlinks - */ + // Create repo and symlinks $this->createMetadata(); - /** - * Finalize repo (add to database and apply rights) - */ + // Finalize repo (add to database and apply rights) $this->finalize(); } /** * Update local repository */ - private function updateLocal() + private function updateLocal(): void { $this->taskLogStepController->new('updating', 'UPDATING'); $this->taskLogSubStepController->new('initializing', 'INITIALIZING'); - /** - * Define temporary working directory - */ + // Define temporary working directory $workingDir = REPOS_DIR . '/temporary-task-' . $this->taskId; - /** - * Check if a snapshot exists in the database - */ + // Check if a snapshot exists in the database if ($this->repoController->existsSnapId($this->repoController->getSnapId()) === false) { throw new Exception('Specified repo snapshot does not exist'); } - /** - * We cannot update a snapshot in the same day - */ + // We cannot update a snapshot in the same day if ($this->repoController->getPackageType() == 'rpm') { if ($this->rpmRepoController->existsSnapDate($this->repoController->getName(), $this->repoController->getReleasever(), $this->repoController->getDate())) { throw new Exception('A snapshot already exists on the ' . $this->repoController->getDateFormatted() . ''); @@ -112,16 +94,12 @@ private function updateLocal() } } - /** - * Arch must be specified - */ + // Arch must be specified if (empty($this->repoController->getArch())) { throw new Exception('Packages arch must be specified'); } - /** - * Define previous snapshot directory path - */ + // Define previous snapshot directory path if ($this->sourceRepoController->getPackageType() == 'rpm') { $previousSnapshotDir = REPOS_DIR . '/rpm/' . $this->sourceRepoController->getName() . '/' . $this->sourceRepoController->getReleasever() . '/' . $this->sourceRepoController->getDate(); } @@ -129,16 +107,12 @@ private function updateLocal() $previousSnapshotDir = REPOS_DIR . '/deb/' . $this->sourceRepoController->getName() . '/' . $this->sourceRepoController->getDist() . '/' . $this->sourceRepoController->getSection() . '/' . $this->sourceRepoController->getDate(); } - /** - * Check that previous snapshot directory exists - */ + // Check that previous snapshot directory exists if (!is_dir($previousSnapshotDir)) { throw new Exception('Previous snapshot directory does not exist: ' . $previousSnapshotDir); } - /** - * If working directory already exists, delete it - */ + // If working directory already exists, delete it if (is_dir($workingDir)) { if (!Directory::deleteRecursive($workingDir)) { throw new Exception('Cannot delete existing directory: ' . $workingDir); @@ -148,9 +122,7 @@ private function updateLocal() $this->taskLogSubStepController->completed(); $this->taskLogSubStepController->new('search-packages', 'SEARCHING PACKAGES IN PREVIOUS SNAPSHOT'); - /** - * Search for packages in the previous snapshot directory - */ + // Search for packages in the previous snapshot directory try { if ($this->repoController->getPackageType() == 'deb') { $packages = File::findRecursive($previousSnapshotDir . '/pool/' . $this->sourceRepoController->getSection(), [], ['deb', 'dsc', 'gz', 'xz']); @@ -163,17 +135,13 @@ private function updateLocal() throw new Exception('Error while retrieving previous snapshot packages: ' . $e->getMessage()); } - /** - * Count number of packages found - */ + // Count number of packages found $totalPackages = count($packages); $packageCounter = 0; $this->taskLogSubStepController->completed($totalPackages . ' package(s) found'); - /** - * Create target pool/packages directory - */ + // Create target pool/packages directory if ($this->repoController->getPackageType() == 'deb') { // Create pool directory if (!mkdir($workingDir . '/pool/' . $this->repoController->getSection(), 0770, true)) { @@ -187,9 +155,7 @@ private function updateLocal() } } - /** - * Deduplication/Copy packages from previous snapshot to the new snapshot - */ + // Deduplication/Copy packages from previous snapshot to the new snapshot foreach ($packages as $packagePath) { // Get package name $name = basename($packagePath); diff --git a/www/controllers/Service/Unit/ScheduledTask.php b/www/controllers/Service/Unit/ScheduledTask.php index fb7d61d46..51d4d5509 100644 --- a/www/controllers/Service/Unit/ScheduledTask.php +++ b/www/controllers/Service/Unit/ScheduledTask.php @@ -4,6 +4,7 @@ use Exception; use DateTime; +use Controllers\Task\Target; class ScheduledTask extends \Controllers\Service\Service { @@ -35,6 +36,7 @@ public function execute() : void } $taskToExec = []; + $tasksRawParams = []; $dateNow = date('Y-m-d'); $timeNow = date('H:i'); $minutesNow = date('i'); @@ -65,6 +67,9 @@ public function execute() : void $taskRawParams = json_decode($task['Raw_params'], true); + // Keep the parameters aside, they are needed when the task is actually executed + $tasksRawParams[$task['Id']] = $taskRawParams; + /** * Case where the task is a unique task */ @@ -161,9 +166,17 @@ public function execute() : void parent::log('Launching scheduled task #' . $taskId . '...'); try { - // Add the scheduled task to the queue and execute it - $this->taskController->updateStatus($taskId, 'queued'); - $this->taskController->executeId($taskId); + /** + * If the task targets a dynamic set of repositories, it is not executed as is: + * it generates one task per matching repository, on their latest snapshot + */ + if (Target::isDynamic($tasksRawParams[$taskId] ?? [])) { + $this->executeDynamicTask($taskId, $tasksRawParams[$taskId]); + } else { + // Add the scheduled task to the queue and execute it + $this->taskController->updateStatus($taskId, 'queued'); + $this->taskController->executeId($taskId); + } } catch (Exception $e) { throw new Exception('Error while executing scheduled task #' . $taskId . ': ' . $e->getMessage()); } @@ -174,6 +187,42 @@ public function execute() : void } } + /** + * Execute a scheduled task targeting a dynamic set of repositories + * One task is generated per matching repository, targeting its latest snapshot + */ + private function executeDynamicTask(int $taskId, array $taskRawParams): void + { + $targetController = new Target(); + + // Retrieve the parameters of the tasks to generate, one per matching repository + $tasksParams = $targetController->expand($taskRawParams); + + if (empty($tasksParams)) { + parent::log('No repository matches the target of scheduled task #' . $taskId); + } else { + parent::log('Scheduled task #' . $taskId . ' matches ' . count($tasksParams) . ' repository(ies)'); + + // Generate and execute a task for each matching repository, linked to the scheduled task that generated them + $this->taskController->execute($tasksParams, $taskId); + } + + /** + * Keep track of the last execution date and time of the scheduled task, + * it has no log of its own as it only dispatches sub-tasks + */ + $this->taskController->updateDate($taskId, date('Y-m-d')); + $this->taskController->updateTime($taskId, date('H:i:s')); + + /** + * A recurring task stays scheduled and will run again at the next occurrence + * A unique task must not run again, so it is marked as done + */ + if (($taskRawParams['schedule']['schedule-type'] ?? '') == 'unique') { + $this->taskController->updateStatus($taskId, 'done'); + } + } + /** * Send scheduled tasks reminders */ diff --git a/www/controllers/Task/Execution.php b/www/controllers/Task/Execution.php index 3f114bbf1..88998b5cd 100644 --- a/www/controllers/Task/Execution.php +++ b/www/controllers/Task/Execution.php @@ -112,6 +112,11 @@ public function __construct(int $taskId, string $action) $this->repoController->getAllById($this->params['repo-id'], $this->params['snap-id'], $this->params['env-id']); } + // Retrieve repository details from repo Id, if needed + if (isset($taskConfig['retrieve-repo-from-repo-id']) and $taskConfig['retrieve-repo-from-repo-id']) { + $this->repoController->getAllById($this->params['repo-id']); + } + // Retrieve repository details from snap Id, if needed if (isset($taskConfig['retrieve-repo-from-snap-id']) and $taskConfig['retrieve-repo-from-snap-id']) { $this->repoController->getAllById(null, $this->params['snap-id'], null); @@ -247,6 +252,7 @@ public function paramsSet($requiredParams = [], $optionalParams = []) 'gpg-sign' => 'setGpgSign', 'env' => 'setEnv', 'description' => 'setDescription', + 'tags' => 'setTags', 'group' => 'setGroup', 'advanced-params' => 'setAdvancedParams' ]; @@ -283,10 +289,11 @@ public function start() : void // Update layout containers states $this->layoutContainerReloadController->reload('header/menu'); + $this->layoutContainerReloadController->reload('repos/kpi'); $this->layoutContainerReloadController->reload('repos/list'); - $this->layoutContainerReloadController->reload('tasks/list'); - $this->layoutContainerReloadController->reload('browse/list'); - $this->layoutContainerReloadController->reload('browse/actions'); + $this->layoutContainerReloadController->reload('tasks/tasks'); + $this->layoutContainerReloadController->reload('snapshot/kpi'); + $this->layoutContainerReloadController->reload('snapshot/list'); // Add current PHP execution PID to the PID file to make sure it can be killed with the stop button $this->taskController->addsubpid(getmypid()); @@ -315,10 +322,6 @@ public function end() : void // Calculate total duration $duration = Convert::microtimeToHuman(microtime(true) - $this->timeStart); - // Create one last step for total duration - $this->taskLogStepController->new('duration', 'DURATION'); - $this->taskLogStepController->none('Total duration: ' . $duration); - // Update duration $this->taskController->updateDuration($this->taskId, $duration); @@ -358,10 +361,12 @@ public function end() : void // Update layout containers states $this->layoutContainerReloadController->reload('header/menu'); + $this->layoutContainerReloadController->reload('repos/kpi'); $this->layoutContainerReloadController->reload('repos/list'); - $this->layoutContainerReloadController->reload('tasks/list'); - $this->layoutContainerReloadController->reload('browse/list'); - $this->layoutContainerReloadController->reload('browse/actions'); + $this->layoutContainerReloadController->reload('tasks/tasks'); + $this->layoutContainerReloadController->reload('tasks/log'); + $this->layoutContainerReloadController->reload('snapshot/kpi'); + $this->layoutContainerReloadController->reload('snapshot/list'); } catch (Exception $e) { throw new Exception('Error while ending task: ' . $e->getMessage()); } diff --git a/www/controllers/Task/Form/Create.php b/www/controllers/Task/Form/Create.php index c14ec20ea..36392f3a7 100644 --- a/www/controllers/Task/Form/Create.php +++ b/www/controllers/Task/Form/Create.php @@ -53,6 +53,9 @@ public function validate(array $formParams): void // Check description Param\Description::check($formParams['description']); + // Check tags + Param\Tags::check($formParams['tags']); + // Check group if (!empty($formParams['group'])) { Param\Group::check($formParams['group']); diff --git a/www/controllers/Task/Form/Delete.php b/www/controllers/Task/Form/Delete.php index 646bfa385..f81c2847a 100644 --- a/www/controllers/Task/Form/Delete.php +++ b/www/controllers/Task/Form/Delete.php @@ -4,37 +4,45 @@ use Exception; use Controllers\Repo\Repo; +use Controllers\Repo\Snapshot\Snapshot; use Controllers\History\Save as History; +use Controllers\Utils\Generate\Html\Label; class Delete { public function validate(array $formParams): void { $repoController = new Repo(); + $repoSnaphotController = new Snapshot(); // Check that the snapshot id is valid Param\Snapshot::checkId($formParams['snap-id']); - // Retrieve all repo data from the Id - $repoController->setSnapId($formParams['snap-id']); - $repoController->getAllById('', $formParams['snap-id'], ''); + // Check that the snapshot exists + if (!$repoSnaphotController->exists($formParams['snap-id'])) { + throw new Exception('Snapshot Id #' . $formParams['snap-id'] . ' does not exist'); + } - // Check that the repo exists - if ($repoController->existsSnapId($formParams['snap-id']) === false) { - throw new Exception('Snapshot Id ' . $formParams['snap-id'] . ' does not exist'); + // Check if the snapshot has a protected environment + if ($repoSnaphotController->hasProtectedEnv($formParams['snap-id'])) { + throw new Exception('Snapshot has a protected environment and cannot be deleted'); } + // Retrieve all repo data from the Id + // $repoController->setSnapId($formParams['snap-id']); + $repoController->getAllById('', $formParams['snap-id'], ''); + // Check scheduling parameters Param\Schedule::check($formParams['schedule']); // Add history if ($repoController->getPackageType() == 'rpm') { - History::set('Running task: delete repository snapshot ' . $repoController->getName() . '⸺' . $repoController->getDateFormatted() . ''); + History::set('Running task: delete repository snapshot ' . Label::white($repoController->getName()) . '⸺' . Label::white($repoController->getDateFormatted())); } if ($repoController->getPackageType() == 'deb') { - History::set('Running task: delete repository snapshot ' . $repoController->getName() . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection() . '⸺' . $repoController->getDateFormatted() . ''); + History::set('Running task: delete repository snapshot ' . Label::white($repoController->getName() . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection()) . '⸺' . Label::white($repoController->getDateFormatted())); } - unset($repoController); + unset($repoController, $repoSnaphotController); } } diff --git a/www/controllers/Task/Form/Duplicate.php b/www/controllers/Task/Form/Duplicate.php index 463d5f135..fdcf00674 100644 --- a/www/controllers/Task/Form/Duplicate.php +++ b/www/controllers/Task/Form/Duplicate.php @@ -5,6 +5,7 @@ use Exception; use Controllers\Repo\Repo; use Controllers\History\Save as History; +use Controllers\Utils\Generate\Html\Label; class Duplicate { @@ -17,10 +18,6 @@ public function validate(array $formParams): void // Check that the snapshot id is valid Param\Snapshot::checkId($formParams['snap-id']); - // Retrieve all repo data from the Id - $repoController->setSnapId($formParams['snap-id']); - $repoController->getAllById('', $formParams['snap-id'], ''); - // Check name Param\Name::check($formParams['name']); @@ -34,20 +31,27 @@ public function validate(array $formParams): void Param\Description::check($formParams['description']); } + // Check tags + Param\Tags::check($formParams['tags']); + // Check group if (!empty($formParams['group'])) { Param\Group::check($formParams['group']); } + // Retrieve all repo data from the Id + // $repoController->setSnapId($formParams['snap-id']); + $repoController->getAllById('', $formParams['snap-id'], ''); + // Check that a repo with the same name does not already exist if ($repoController->getPackageType() == 'rpm') { if ($rpmRepoController->isActive($formParams['name'], $repoController->getReleasever())) { - throw new Exception('' . $formParams['name'] . ' ❯ ' . $repoController->getReleasever() . ' repository already exists'); + throw new Exception(Label::white($formParams['name'] . ' ❯ ' . $repoController->getReleasever()) . ' repository already exists'); } } if ($repoController->getPackageType() == 'deb') { if ($debRepoController->isActive($formParams['name'], $repoController->getDist(), $repoController->getSection())) { - throw new Exception('' . $formParams['name'] . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection() . ' repo already exists'); + throw new Exception(Label::white($formParams['name'] . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection()) . ' repo already exists'); } } @@ -56,10 +60,10 @@ public function validate(array $formParams): void // Add history if ($repoController->getPackageType() == 'rpm') { - History::set('Running task: duplicate repository ' . $repoController->getName() . '⸺' . $repoController->getDateFormatted() . ' ➡ ' . $formParams['name'] . ''); + History::set('Running task: duplicate repository ' . Label::white($repoController->getName()) . '⸺' . Label::white($repoController->getDateFormatted()) . ' ➡ ' . Label::white($formParams['name'])); } if ($repoController->getPackageType() == 'deb') { - History::set('Running task: duplicate repository ' . $repoController->getName() . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection() . '⸺' . $repoController->getDateFormatted() . ' ➡ ' . $formParams['name'] . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection() . ''); + History::set('Running task: duplicate repository ' . Label::white($repoController->getName() . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection()) . '⸺' . Label::white($repoController->getDateFormatted()) . ' ➡ ' . Label::white($formParams['name'] . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection())); } unset($repoController, $rpmRepoController, $debRepoController); diff --git a/www/controllers/Task/Form/Env.php b/www/controllers/Task/Form/Env.php index 486fbb4b7..f67b01105 100644 --- a/www/controllers/Task/Form/Env.php +++ b/www/controllers/Task/Form/Env.php @@ -2,7 +2,9 @@ namespace Controllers\Task\Form; +use Exception; use Controllers\Repo\Repo; +use Controllers\Environment; use Controllers\Utils\Generate\Html\Label; use Controllers\History\Save as History; @@ -11,23 +13,28 @@ class Env public function validate(array $formParams): void { $repoController = new Repo(); + $envController = new Environment(); // Check that the snapshot id is valid Param\Snapshot::checkId($formParams['snap-id']); - // Retrieve all repo data from the Id - $repoController->setSnapId($formParams['snap-id']); - $repoController->getAllById('', $formParams['snap-id'], ''); - // Check environment Param\Environment::check($formParams['env']); - // Check description - Param\Description::check($formParams['description']); - // Check scheduling parameters Param\Schedule::check($formParams['schedule']); + // Check if the env is protected + foreach ($formParams['env'] as $env) { + if ($envController->isProtected($env)) { + throw new Exception('Environment ' . $env . ' is protected and cannot be moved'); + } + } + + // Retrieve all repo data from the Id + // $repoController->setSnapId($formParams['snap-id']); + $repoController->getAllById('', $formParams['snap-id'], ''); + // Add history $content = ''; foreach ($formParams['env'] as $env) { @@ -35,10 +42,10 @@ public function validate(array $formParams): void } if ($repoController->getPackageType() == 'rpm') { - History::set('Running task: point environment(s) ' . trim($content) . ' to repository ' . $repoController->getName() . '⸺' . $repoController->getDateFormatted() . ''); + History::set('Running task: point environment(s) ' . trim($content) . ' to repository ' . Label::white($repoController->getName()) . '⸺' . Label::white($repoController->getDateFormatted())); } if ($repoController->getPackageType() == 'deb') { - History::set('Running task: point environment(s) ' . trim($content) . ' to repository ' . $repoController->getName() . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection() . '⸺' . $repoController->getDateFormatted() . ''); + History::set('Running task: point environment(s) ' . trim($content) . ' to repository ' . Label::white($repoController->getName() . ' ❯ ' . $repoController->getDist() . ' ❯ ' . $repoController->getSection()) . '⸺' . Label::white($repoController->getDateFormatted())); } unset($repoController); diff --git a/www/controllers/Task/Form/Form.php b/www/controllers/Task/Form/Form.php index fab2243f5..8c6758160 100644 --- a/www/controllers/Task/Form/Form.php +++ b/www/controllers/Task/Form/Form.php @@ -3,9 +3,14 @@ namespace Controllers\Task\Form; use Exception; +use Controllers\User\User; use Controllers\Repo\Repo; +use Controllers\Environment; +use Controllers\Task\Target; use Controllers\Utils\Validate; -use Controllers\Repo\Environment; +use Controllers\Repo\Listing as RepoListing; +use Controllers\Repo\Environment as RepoEnvironment; +use Controllers\History\Save as History; use Controllers\Task\Scheduled as ScheduledTask; use Controllers\User\Permission\Repo as RepoPermission; @@ -16,70 +21,92 @@ class Form /** * Return the task form to the user according to his selection */ - public function get(string $action, array $repos) : string + public function get(string $action, array $repos): string { - $userController = new \Controllers\User\User(); + $userController = new User(); + $repoEnvController = new RepoEnvironment(); + $repoListingController = new RepoListing(); + $scheduledTaskController = new ScheduledTask(); + + // Get the list of email addresses to populate the recipient selector $usersEmail = $userController->getEmails(); + // Get current tags to populate the tag selector + $tags = $repoListingController->listTags(); + + // Initialize the form content $content = '