From e57289eeb6408a73bf05c292a606995e694962fd Mon Sep 17 00:00:00 2001 From: Aaron van Geffen Date: Thu, 19 Dec 2024 11:56:00 +0100 Subject: [PATCH 01/11] GenericTable: drop support for get_count_params, get_data_params --- models/GenericTable.php | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/models/GenericTable.php b/models/GenericTable.php index 415ef53..a5535c7 100644 --- a/models/GenericTable.php +++ b/models/GenericTable.php @@ -41,7 +41,7 @@ class GenericTable $this->tableIsSortable = !empty($options['base_url']); // How much data do we have? - $this->recordCount = $options['get_count'](...(!empty($options['get_count_params']) ? $options['get_count_params'] : [])); + $this->recordCount = $options['get_count'](); // How much data do we need to retrieve? $this->items_per_page = !empty($options['items_per_page']) ? $options['items_per_page'] : 30; @@ -58,8 +58,6 @@ class GenericTable // Gather parameters for the data gather function first. $parameters = [$this->start, $this->items_per_page, $options['sort_order'], $options['sort_direction']]; - if (!empty($options['get_data_params']) && is_array($options['get_data_params'])) - $parameters = array_merge($parameters, $options['get_data_params']); // Okay, let's fetch the data! $data = $options['get_data'](...$parameters); -- 2.46.0 From 06c95853f5b9088e42f9f5d62eb9234eafd784e5 Mon Sep 17 00:00:00 2001 From: Aaron van Geffen Date: Thu, 19 Dec 2024 12:01:00 +0100 Subject: [PATCH 02/11] GenericTable: drop $tableIsSortable property --- models/GenericTable.php | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/models/GenericTable.php b/models/GenericTable.php index a5535c7..b63df32 100644 --- a/models/GenericTable.php +++ b/models/GenericTable.php @@ -15,7 +15,6 @@ class GenericTable private $title; private $title_class; - private $tableIsSortable = false; public $form_above; public $form_below; @@ -37,9 +36,6 @@ class GenericTable if (!empty($options['sort_direction']) && !in_array($options['sort_direction'], ['up', 'down'])) $options['sort_direction'] = 'up'; - // Make sure we know whether we can actually sort on something. - $this->tableIsSortable = !empty($options['base_url']); - // How much data do we have? $this->recordCount = $options['get_count'](); @@ -100,7 +96,7 @@ class GenericTable if (empty($column['header'])) continue; - $isSortable = $this->tableIsSortable && !empty($column['is_sortable']); + $isSortable = !empty($column['is_sortable']); $sortDirection = $key == $this->sort_order && $this->sort_direction === 'up' ? 'down' : 'up'; $header = [ -- 2.46.0 From bb8a8bad272b0e5f369c13ae48c25ca035dad639 Mon Sep 17 00:00:00 2001 From: Aaron van Geffen Date: Thu, 19 Dec 2024 15:00:00 +0100 Subject: [PATCH 03/11] GenericTable: refactor order and pagination initalisation --- controllers/ManageAlbums.php | 24 ++++------- controllers/ManageAssets.php | 21 ++++------ controllers/ManageErrors.php | 29 ++++++------- controllers/ManageTags.php | 23 ++++------- controllers/ManageUsers.php | 27 ++++-------- models/GenericTable.php | 79 ++++++++++++++++++------------------ 6 files changed, 85 insertions(+), 118 deletions(-) diff --git a/controllers/ManageAlbums.php b/controllers/ManageAlbums.php index 662714b..aa48f20 100644 --- a/controllers/ManageAlbums.php +++ b/controllers/ManageAlbums.php @@ -54,27 +54,19 @@ class ManageAlbums extends HTMLController 'value' => 'count', ], ], - 'start' => !empty($_GET['start']) ? (int) $_GET['start'] : 0, - 'sort_order' => !empty($_GET['order']) ? $_GET['order'] : null, - 'sort_direction' => !empty($_GET['dir']) ? $_GET['dir'] : null, + 'default_sort_order' => 'tag', + 'default_sort_direction' => 'up', + 'start' => $_GET['start'] ?? 0, + 'sort_order' => $_GET['order'] ?? '', + 'sort_direction' => $_GET['dir'] ?? '', 'title' => 'Manage albums', 'no_items_label' => 'No albums meet the requirements of the current filter.', 'items_per_page' => 9999, 'index_class' => 'col-md-6', 'base_url' => BASEURL . '/managealbums/', - 'get_data' => function($offset = 0, $limit = 9999, $order = '', $direction = 'up') { - if (!in_array($order, ['id_tag', 'tag', 'slug', 'count'])) - $order = 'tag'; - if (!in_array($direction, ['up', 'down'])) - $direction = 'up'; - - $rows = PhotoAlbum::getHierarchy($order, $direction); - - return [ - 'rows' => $rows, - 'order' => $order, - 'direction' => ($direction == 'up' ? 'up' : 'down'), - ]; + 'get_data' => function($offset, $limit, $order, $direction) { + assert(in_array($order, ['id_tag', 'tag', 'slug', 'count'])); + return PhotoAlbum::getHierarchy($order, $direction); }, 'get_count' => function() { return 9999; diff --git a/controllers/ManageAssets.php b/controllers/ManageAssets.php index 5ae3597..88d9c46 100644 --- a/controllers/ManageAssets.php +++ b/controllers/ManageAssets.php @@ -121,19 +121,20 @@ class ManageAssets extends HTMLController ], ], ], - 'start' => !empty($_GET['start']) ? (int) $_GET['start'] : 0, - 'sort_order' => !empty($_GET['order']) ? $_GET['order'] : '', - 'sort_direction' => !empty($_GET['dir']) ? $_GET['dir'] : '', + 'default_sort_order' => 'id_asset', + 'default_sort_direction' => 'down', + 'start' => $_GET['start'] ?? 0, + 'sort_order' => $_GET['order'] ?? '', + 'sort_direction' => $_GET['dir'] ?? '', 'title' => 'Manage assets', 'no_items_label' => 'No assets meet the requirements of the current filter.', 'items_per_page' => 30, 'index_class' => 'col-md-6', 'base_url' => BASEURL . '/manageassets/', - 'get_data' => function($offset = 0, $limit = 30, $order = '', $direction = 'down') { - if (!in_array($order, ['id_asset', 'id_user_uploaded', 'title', 'subdir', 'filename'])) - $order = 'id_asset'; + 'get_data' => function($offset, $limit, $order, $direction) { + assert(in_array($order, ['id_asset', 'id_user_uploaded', 'title', 'subdir', 'filename'])); - $data = Registry::get('db')->queryAssocs(' + return Registry::get('db')->queryAssocs(' SELECT a.id_asset, a.subdir, a.filename, a.image_width, a.image_height, a.mimetype, u.id_user, u.first_name, u.surname @@ -146,12 +147,6 @@ class ManageAssets extends HTMLController 'offset' => $offset, 'limit' => $limit, ]); - - return [ - 'rows' => $data, - 'order' => $order, - 'direction' => $direction, - ]; }, 'get_count' => 'Asset::getCount', ]; diff --git a/controllers/ManageErrors.php b/controllers/ManageErrors.php index f510c7b..a3c7628 100644 --- a/controllers/ManageErrors.php +++ b/controllers/ManageErrors.php @@ -14,8 +14,8 @@ class ManageErrors extends HTMLController if (!Registry::get('user')->isAdmin()) throw new NotAllowedException(); - // Flushing, are we? - if (isset($_POST['flush']) && Session::validateSession('get')) + // Clearing, are we? + if (isset($_POST['clear']) && Session::validateSession('get')) { ErrorLog::flush(); header('Location: ' . BASEURL . '/manageerrors/'); @@ -31,7 +31,7 @@ class ManageErrors extends HTMLController 'method' => 'post', 'class' => 'col-md-6 text-end', 'buttons' => [ - 'flush' => [ + 'clear' => [ 'type' => 'submit', 'caption' => 'Delete all', 'class' => 'btn-danger', @@ -39,7 +39,7 @@ class ManageErrors extends HTMLController ], ], 'columns' => [ - 'id' => [ + 'id_entry' => [ 'value' => 'id_entry', 'header' => '#', 'is_sortable' => true, @@ -95,19 +95,20 @@ class ManageErrors extends HTMLController ], ], ], - 'start' => !empty($_GET['start']) ? (int) $_GET['start'] : 0, - 'sort_order' => !empty($_GET['order']) ? $_GET['order'] : '', - 'sort_direction' => !empty($_GET['dir']) ? $_GET['dir'] : '', + 'default_sort_order' => 'id_entry', + 'default_sort_direction' => 'down', + 'start' => $_GET['start'] ?? 0, + 'sort_order' => $_GET['order'] ?? '', + 'sort_direction' => $_GET['dir'] ?? '', 'no_items_label' => "No errors to display -- we're all good!", 'items_per_page' => 20, 'index_class' => 'col-md-6', 'base_url' => BASEURL . '/manageerrors/', 'get_count' => 'ErrorLog::getCount', - 'get_data' => function($offset = 0, $limit = 20, $order = '', $direction = 'down') { - if (!in_array($order, ['id_entry', 'file', 'line', 'time', 'ipaddress', 'id_user'])) - $order = 'id_entry'; + 'get_data' => function($offset, $limit, $order, $direction) { + assert(in_array($order, ['id_entry', 'file', 'line', 'time', 'ipaddress', 'id_user'])); - $data = Registry::get('db')->queryAssocs(' + return Registry::get('db')->queryAssocs(' SELECT * FROM log_errors ORDER BY {raw:order} @@ -117,12 +118,6 @@ class ManageErrors extends HTMLController 'offset' => $offset, 'limit' => $limit, ]); - - return [ - 'rows' => $data, - 'order' => $order, - 'direction' => $direction, - ]; }, ]; diff --git a/controllers/ManageTags.php b/controllers/ManageTags.php index ec12de0..34431c9 100644 --- a/controllers/ManageTags.php +++ b/controllers/ManageTags.php @@ -70,21 +70,20 @@ class ManageTags extends HTMLController 'value' => 'count', ], ], - 'start' => !empty($_GET['start']) ? (int) $_GET['start'] : 0, - 'sort_order' => !empty($_GET['order']) ? $_GET['order'] : null, - 'sort_direction' => !empty($_GET['dir']) ? $_GET['dir'] : null, + 'default_sort_order' => 'tag', + 'default_sort_direction' => 'up', + 'start' => $_GET['start'] ?? 0, + 'sort_order' => $_GET['order'] ?? '', + 'sort_direction' => $_GET['dir'] ?? '', 'title' => 'Manage tags', 'no_items_label' => 'No tags meet the requirements of the current filter.', 'items_per_page' => 30, 'index_class' => 'col-md-6', 'base_url' => BASEURL . '/managetags/', - 'get_data' => function($offset = 0, $limit = 30, $order = '', $direction = 'up') { - if (!in_array($order, ['id_tag', 'tag', 'slug', 'kind', 'count'])) - $order = 'tag'; - if (!in_array($direction, ['up', 'down'])) - $direction = 'up'; + 'get_data' => function($offset, $limit, $order, $direction) { + assert(in_array($order, ['id_tag', 'tag', 'slug', 'count'])); - $data = Registry::get('db')->queryAssocs(' + return Registry::get('db')->queryAssocs(' SELECT t.*, u.id_user, u.first_name, u.surname FROM tags AS t LEFT JOIN users AS u ON t.id_user_owner = u.id_user @@ -97,12 +96,6 @@ class ManageTags extends HTMLController 'limit' => $limit, 'album' => 'Album', ]); - - return [ - 'rows' => $data, - 'order' => $order, - 'direction' => ($direction == 'up' ? 'up' : 'down'), - ]; }, 'get_count' => function() { return Registry::get('db')->queryValue(' diff --git a/controllers/ManageUsers.php b/controllers/ManageUsers.php index 1be66a5..7f43b88 100644 --- a/controllers/ManageUsers.php +++ b/controllers/ManageUsers.php @@ -90,19 +90,20 @@ class ManageUsers extends HTMLController ], ], ], - 'start' => !empty($_GET['start']) ? (int) $_GET['start'] : 0, - 'sort_order' => !empty($_GET['order']) ? $_GET['order'] : '', - 'sort_direction' => !empty($_GET['dir']) ? $_GET['dir'] : '', + 'default_sort_order' => 'id_user', + 'default_sort_direction' => 'down', + 'start' => $_GET['start'] ?? 0, + 'sort_order' => $_GET['order'] ?? '', + 'sort_direction' => $_GET['dir'] ?? '', 'title' => 'Manage users', 'no_items_label' => 'No users meet the requirements of the current filter.', 'items_per_page' => 30, 'index_class' => 'col-md-6', 'base_url' => BASEURL . '/manageusers/', - 'get_data' => function($offset = 0, $limit = 30, $order = '', $direction = 'down') { - if (!in_array($order, ['id_user', 'surname', 'first_name', 'slug', 'emailaddress', 'last_action_time', 'ip_address', 'is_admin'])) - $order = 'id_user'; + 'get_data' => function($offset, $limit, $order, $direction) { + assert(in_array($order, ['id_user', 'surname', 'first_name', 'slug', 'emailaddress', 'last_action_time', 'ip_address', 'is_admin'])); - $data = Registry::get('db')->queryAssocs(' + return Registry::get('db')->queryAssocs(' SELECT * FROM users ORDER BY {raw:order} @@ -112,18 +113,8 @@ class ManageUsers extends HTMLController 'offset' => $offset, 'limit' => $limit, ]); - - return [ - 'rows' => $data, - 'order' => $order, - 'direction' => $direction, - ]; }, - 'get_count' => function() { - return Registry::get('db')->queryValue(' - SELECT COUNT(*) - FROM users'); - } + 'get_count' => 'Member::getCount', ]; $table = new GenericTable($options); diff --git a/models/GenericTable.php b/models/GenericTable.php index b63df32..df48c83 100644 --- a/models/GenericTable.php +++ b/models/GenericTable.php @@ -28,53 +28,22 @@ class GenericTable public function __construct($options) { - // Make sure we're actually sorting on something sortable. - if (!isset($options['sort_order']) || (!empty($options['sort_order']) && empty($options['columns'][$options['sort_order']]['is_sortable']))) - $options['sort_order'] = ''; + $this->initOrder($options); + $this->initPagination($options); - // Order in which direction? - if (!empty($options['sort_direction']) && !in_array($options['sort_direction'], ['up', 'down'])) - $options['sort_direction'] = 'up'; - - // How much data do we have? - $this->recordCount = $options['get_count'](); - - // How much data do we need to retrieve? - $this->items_per_page = !empty($options['items_per_page']) ? $options['items_per_page'] : 30; - - // Figure out where to start. - $this->start = empty($options['start']) || !is_numeric($options['start']) || $options['start'] < 0 || $options['start'] > $this->recordCount ? 0 : $options['start']; - - // Figure out where we are on the whole, too. - $numPages = max(1, ceil($this->recordCount / $this->items_per_page)); - $this->currentPage = min(ceil($this->start / $this->items_per_page) + 1, $numPages); - - // Let's bear a few things in mind... - $this->base_url = $options['base_url']; - - // Gather parameters for the data gather function first. - $parameters = [$this->start, $this->items_per_page, $options['sort_order'], $options['sort_direction']]; - - // Okay, let's fetch the data! - $data = $options['get_data'](...$parameters); - - // Extract data into local variables. - $rawRowData = $data['rows']; - $this->sort_order = $data['order']; - $this->sort_direction = $data['direction']; - unset($data); + $data = $options['get_data']($this->start, $this->items_per_page, + $this->sort_order, $this->sort_direction); // Okay, now for the column headers... $this->generateColumnHeaders($options); // Should we create a page index? - $needsPageIndex = !empty($this->items_per_page) && $this->recordCount > $this->items_per_page; - if ($needsPageIndex) + if ($this->recordCount > $this->items_per_page) $this->generatePageIndex($options); // Process the data to be shown into rows. - if (!empty($rawRowData)) - $this->processAllRows($rawRowData, $options); + if (!empty($data)) + $this->processAllRows($data, $options); else $this->body = $options['no_items_label'] ?? ''; @@ -89,6 +58,38 @@ class GenericTable $this->form_below = $options['form_below'] ?? $options['form'] ?? null; } + private function initOrder($options) + { + assert(isset($options['default_sort_order'])); + assert(isset($options['default_sort_direction'])); + + // Validate sort order (column) + $this->sort_order = $options['sort_order']; + if (empty($this->sort_order) || empty($options['columns'][$this->sort_order]['is_sortable'])) + $this->sort_order = $options['default_sort_order']; + + // Validate sort direction + $this->sort_direction = $options['sort_direction']; + if (empty($this->sort_direction) || !in_array($this->sort_direction, ['up', 'down'])) + $this->sort_direction = $options['default_sort_direction']; + } + + private function initPagination(array $options) + { + assert(isset($options['base_url'])); + assert(isset($options['items_per_page'])); + + $this->base_url = $options['base_url']; + + $this->recordCount = $options['get_count'](); + $this->items_per_page = !empty($options['items_per_page']) ? $options['items_per_page'] : 30; + + $this->start = empty($options['start']) || !is_numeric($options['start']) || $options['start'] < 0 || $options['start'] > $this->recordCount ? 0 : $options['start']; + + $numPages = max(1, ceil($this->recordCount / $this->items_per_page)); + $this->currentPage = min(ceil($this->start / $this->items_per_page) + 1, $numPages); + } + private function generateColumnHeaders($options) { foreach ($options['columns'] as $key => $column) @@ -218,7 +219,7 @@ class GenericTable { // Basic option: simply take a use a particular data property. case 'value': - $value = htmlspecialchars($rowData[$options['data']]); + $value = htmlspecialchars($rowData[$options['data']] ?? ''); break; // Processing via a lambda function. -- 2.46.0 From 1e26a51d0867dfd59f0378669a8bbbddc05caa42 Mon Sep 17 00:00:00 2001 From: Aaron van Geffen Date: Sun, 22 Dec 2024 15:35:50 +0100 Subject: [PATCH 04/11] ErrorLog: use DELETE FROM instead of TRUNCATE --- models/ErrorLog.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/models/ErrorLog.php b/models/ErrorLog.php index 0f13d5b..979073b 100644 --- a/models/ErrorLog.php +++ b/models/ErrorLog.php @@ -24,7 +24,7 @@ class ErrorLog public static function flush() { - return Registry::get('db')->query('TRUNCATE log_errors'); + return Registry::get('db')->query('DELETE FROM log_errors'); } public static function getCount() -- 2.46.0 From 2d2ef384229ba39af6743cf32bbea011d3bdca71 Mon Sep 17 00:00:00 2001 From: Aaron van Geffen Date: Sun, 22 Dec 2024 15:45:44 +0100 Subject: [PATCH 05/11] MainNavBar: harden Registry access --- templates/MainNavBar.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/MainNavBar.php b/templates/MainNavBar.php index 51ae4c1..7b7b5e4 100644 --- a/templates/MainNavBar.php +++ b/templates/MainNavBar.php @@ -33,7 +33,7 @@ class MainNavBar extends NavBar '; - if (Registry::get('user')->isLoggedIn()) + if (Registry::has('user') && Registry::get('user')->isLoggedIn()) { echo '
-- 2.46.0 From cc0ff71ef7a7a4faf9aa09a252a2e1de79e4221e Mon Sep 17 00:00:00 2001 From: Aaron van Geffen Date: Wed, 8 Jan 2025 17:17:53 +0100 Subject: [PATCH 06/11] Management controllers: move table queries into models --- controllers/ManageAlbums.php | 5 +- controllers/ManageAssets.php | 18 +------ controllers/ManageErrors.php | 15 +----- controllers/ManageTags.php | 22 +------- controllers/ManageUsers.php | 15 +----- models/Asset.php | 17 ++++++ models/ErrorLog.php | 16 ++++++ models/Member.php | 16 ++++++ models/PhotoAlbum.php | 76 -------------------------- models/Tag.php | 100 ++++++++++++++++++++++++++++++----- 10 files changed, 144 insertions(+), 156 deletions(-) delete mode 100644 models/PhotoAlbum.php diff --git a/controllers/ManageAlbums.php b/controllers/ManageAlbums.php index aa48f20..0300409 100644 --- a/controllers/ManageAlbums.php +++ b/controllers/ManageAlbums.php @@ -65,11 +65,10 @@ class ManageAlbums extends HTMLController 'index_class' => 'col-md-6', 'base_url' => BASEURL . '/managealbums/', 'get_data' => function($offset, $limit, $order, $direction) { - assert(in_array($order, ['id_tag', 'tag', 'slug', 'count'])); - return PhotoAlbum::getHierarchy($order, $direction); + return Tag::getOffset($offset, $limit, $order, $direction, true); }, 'get_count' => function() { - return 9999; + return Tag::getCount(false, 'Album', true); } ]; diff --git a/controllers/ManageAssets.php b/controllers/ManageAssets.php index 88d9c46..9054450 100644 --- a/controllers/ManageAssets.php +++ b/controllers/ManageAssets.php @@ -131,23 +131,7 @@ class ManageAssets extends HTMLController 'items_per_page' => 30, 'index_class' => 'col-md-6', 'base_url' => BASEURL . '/manageassets/', - 'get_data' => function($offset, $limit, $order, $direction) { - assert(in_array($order, ['id_asset', 'id_user_uploaded', 'title', 'subdir', 'filename'])); - - return Registry::get('db')->queryAssocs(' - SELECT a.id_asset, a.subdir, a.filename, - a.image_width, a.image_height, a.mimetype, - u.id_user, u.first_name, u.surname - FROM assets AS a - LEFT JOIN users AS u ON a.id_user_uploaded = u.id_user - ORDER BY {raw:order} - LIMIT {int:offset}, {int:limit}', - [ - 'order' => $order . ($direction == 'up' ? ' ASC' : ' DESC'), - 'offset' => $offset, - 'limit' => $limit, - ]); - }, + 'get_data' => 'Asset::getOffset', 'get_count' => 'Asset::getCount', ]; diff --git a/controllers/ManageErrors.php b/controllers/ManageErrors.php index a3c7628..7dcda24 100644 --- a/controllers/ManageErrors.php +++ b/controllers/ManageErrors.php @@ -105,20 +105,7 @@ class ManageErrors extends HTMLController 'index_class' => 'col-md-6', 'base_url' => BASEURL . '/manageerrors/', 'get_count' => 'ErrorLog::getCount', - 'get_data' => function($offset, $limit, $order, $direction) { - assert(in_array($order, ['id_entry', 'file', 'line', 'time', 'ipaddress', 'id_user'])); - - return Registry::get('db')->queryAssocs(' - SELECT * - FROM log_errors - ORDER BY {raw:order} - LIMIT {int:offset}, {int:limit}', - [ - 'order' => $order . ($direction === 'up' ? ' ASC' : ' DESC'), - 'offset' => $offset, - 'limit' => $limit, - ]); - }, + 'get_data' => 'ErrorLog::getOffset', ]; $error_log = new GenericTable($options); diff --git a/controllers/ManageTags.php b/controllers/ManageTags.php index 34431c9..cca4140 100644 --- a/controllers/ManageTags.php +++ b/controllers/ManageTags.php @@ -81,28 +81,10 @@ class ManageTags extends HTMLController 'index_class' => 'col-md-6', 'base_url' => BASEURL . '/managetags/', 'get_data' => function($offset, $limit, $order, $direction) { - assert(in_array($order, ['id_tag', 'tag', 'slug', 'count'])); - - return Registry::get('db')->queryAssocs(' - SELECT t.*, u.id_user, u.first_name, u.surname - FROM tags AS t - LEFT JOIN users AS u ON t.id_user_owner = u.id_user - WHERE kind != {string:album} - ORDER BY {raw:order} - LIMIT {int:offset}, {int:limit}', - [ - 'order' => $order . ($direction == 'up' ? ' ASC' : ' DESC'), - 'offset' => $offset, - 'limit' => $limit, - 'album' => 'Album', - ]); + return Tag::getOffset($offset, $limit, $order, $direction, false); }, 'get_count' => function() { - return Registry::get('db')->queryValue(' - SELECT COUNT(*) - FROM tags - WHERE kind != {string:album}', - ['album' => 'Album']); + return Tag::getCount(false, null, false); } ]; diff --git a/controllers/ManageUsers.php b/controllers/ManageUsers.php index 7f43b88..a3c9a81 100644 --- a/controllers/ManageUsers.php +++ b/controllers/ManageUsers.php @@ -100,20 +100,7 @@ class ManageUsers extends HTMLController 'items_per_page' => 30, 'index_class' => 'col-md-6', 'base_url' => BASEURL . '/manageusers/', - 'get_data' => function($offset, $limit, $order, $direction) { - assert(in_array($order, ['id_user', 'surname', 'first_name', 'slug', 'emailaddress', 'last_action_time', 'ip_address', 'is_admin'])); - - return Registry::get('db')->queryAssocs(' - SELECT * - FROM users - ORDER BY {raw:order} - LIMIT {int:offset}, {int:limit}', - [ - 'order' => $order . ($direction == 'up' ? ' ASC' : ' DESC'), - 'offset' => $offset, - 'limit' => $limit, - ]); - }, + 'get_data' => 'Member::getOffset', 'get_count' => 'Member::getCount', ]; diff --git a/models/Asset.php b/models/Asset.php index edadd5f..b3803bf 100644 --- a/models/Asset.php +++ b/models/Asset.php @@ -680,6 +680,23 @@ class Asset FROM assets'); } + public static function getOffset($offset, $limit, $order, $direction) + { + return Registry::get('db')->queryAssocs(' + SELECT a.id_asset, a.subdir, a.filename, + a.image_width, a.image_height, a.mimetype, + u.id_user, u.first_name, u.surname + FROM assets AS a + LEFT JOIN users AS u ON a.id_user_uploaded = u.id_user + ORDER BY {raw:order} + LIMIT {int:offset}, {int:limit}', + [ + 'order' => $order . ($direction == 'up' ? ' ASC' : ' DESC'), + 'offset' => $offset, + 'limit' => $limit, + ]); + } + public function save() { if (empty($this->id_asset)) diff --git a/models/ErrorLog.php b/models/ErrorLog.php index 979073b..f406ae3 100644 --- a/models/ErrorLog.php +++ b/models/ErrorLog.php @@ -33,4 +33,20 @@ class ErrorLog SELECT COUNT(*) FROM log_errors'); } + + public static function getOffset($offset, $limit, $order, $direction) + { + assert(in_array($order, ['id_entry', 'file', 'line', 'time', 'ipaddress', 'id_user'])); + + return Registry::get('db')->queryAssocs(' + SELECT * + FROM log_errors + ORDER BY {raw:order} + LIMIT {int:offset}, {int:limit}', + [ + 'order' => $order . ($direction === 'up' ? ' ASC' : ' DESC'), + 'offset' => $offset, + 'limit' => $limit, + ]); + } } diff --git a/models/Member.php b/models/Member.php index 84912a4..0bb2ef5 100644 --- a/models/Member.php +++ b/models/Member.php @@ -187,6 +187,22 @@ class Member extends User FROM users'); } + public static function getOffset($offset, $limit, $order, $direction) + { + assert(in_array($order, ['id_user', 'surname', 'first_name', 'slug', 'emailaddress', 'last_action_time', 'ip_address', 'is_admin'])); + + return Registry::get('db')->queryAssocs(' + SELECT * + FROM users + ORDER BY {raw:order} + LIMIT {int:offset}, {int:limit}', + [ + 'order' => $order . ($direction === 'up' ? ' ASC' : ' DESC'), + 'offset' => $offset, + 'limit' => $limit, + ]); + } + public function getProps() { // We should probably phase out the use of this function, or refactor the access levels of member properties... diff --git a/models/PhotoAlbum.php b/models/PhotoAlbum.php deleted file mode 100644 index efdc41f..0000000 --- a/models/PhotoAlbum.php +++ /dev/null @@ -1,76 +0,0 @@ -query(' - SELECT * - FROM tags - WHERE kind = {string:album} - ORDER BY id_parent, {raw:order}', - [ - 'order' => $order . ($direction == 'up' ? ' ASC' : ' DESC'), - 'album' => 'Album', - ]); - - $albums_by_parent = []; - while ($row = $db->fetch_assoc($res)) - { - if (!isset($albums_by_parent[$row['id_parent']])) - $albums_by_parent[$row['id_parent']] = []; - - $albums_by_parent[$row['id_parent']][] = $row + ['children' => []]; - } - - $albums = self::getChildrenRecursively(0, 0, $albums_by_parent); - $rows = self::flattenChildrenRecursively($albums); - - return $rows; - } - - private static function getChildrenRecursively($id_parent, $level, &$albums_by_parent) - { - $children = []; - if (!isset($albums_by_parent[$id_parent])) - return $children; - - foreach ($albums_by_parent[$id_parent] as $child) - { - if (isset($albums_by_parent[$child['id_tag']])) - $child['children'] = self::getChildrenRecursively($child['id_tag'], $level + 1, $albums_by_parent); - - $child['tag'] = ($level ? str_repeat('—', $level * 2) . ' ' : '') . $child['tag']; - $children[] = $child; - } - - return $children; - } - - private static function flattenChildrenRecursively($albums) - { - if (empty($albums)) - return []; - - $rows = []; - foreach ($albums as $album) - { - $rows[] = array_intersect_key($album, array_flip(['id_tag', 'tag', 'slug', 'count'])); - if (!empty($album['children'])) - { - $children = self::flattenChildrenRecursively($album['children']); - foreach ($children as $child) - $rows[] = array_intersect_key($child, array_flip(['id_tag', 'tag', 'slug', 'count'])); - } - } - - return $rows; - } -} diff --git a/models/Tag.php b/models/Tag.php index 145db1e..d5f6db7 100644 --- a/models/Tag.php +++ b/models/Tag.php @@ -24,6 +24,11 @@ class Tag $this->$attribute = $value; } + public function __toString() + { + return $this->tag; + } + public static function fromId($id_tag, $return_format = 'object') { $db = Registry::get('db'); @@ -409,27 +414,98 @@ class Tag ['tags' => $tags]); } - public static function getCount($only_active = 1, $kind = '') + public static function getCount($only_used = true, $kind = '', $isAlbum = false) { $where = []; - if ($only_active) + if ($only_used) $where[] = 'count > 0'; - if (!empty($kind)) - $where[] = 'kind = {string:kind}'; + if (empty($kind)) + $kind = 'Album'; - if (!empty($where)) - $where = 'WHERE ' . implode(' AND ', $where); - else - $where = ''; + $where[] = 'kind {raw:operator} {string:kind}'; + $where = implode(' AND ', $where); return Registry::get('db')->queryValue(' SELECT COUNT(*) - FROM tags ' . $where, - ['kind' => $kind]); + FROM tags + WHERE ' . $where, + [ + 'kind' => $kind, + 'operator' => $isAlbum ? '=' : '!=', + ]); } - public function __toString() + public static function getOffset($offset, $limit, $order, $direction, $isAlbum = false) { - return $this->tag; + assert(in_array($order, ['id_tag', 'tag', 'slug', 'count'])); + + $db = Registry::get('db'); + $res = $db->query(' + SELECT t.*, u.id_user, u.first_name, u.surname + FROM tags AS t + LEFT JOIN users AS u ON t.id_user_owner = u.id_user + WHERE kind {raw:operator} {string:album} + ORDER BY id_parent, {raw:order} + LIMIT {int:offset}, {int:limit}', + [ + 'order' => $order . ($direction === 'up' ? ' ASC' : ' DESC'), + 'offset' => $offset, + 'limit' => $limit, + 'album' => 'Album', + 'operator' => $isAlbum ? '=' : '!=', + ]); + + $albums_by_parent = []; + while ($row = $db->fetch_assoc($res)) + { + if (!isset($albums_by_parent[$row['id_parent']])) + $albums_by_parent[$row['id_parent']] = []; + + $albums_by_parent[$row['id_parent']][] = $row + ['children' => []]; + } + + $albums = self::getChildrenRecursively(0, 0, $albums_by_parent); + $rows = self::flattenChildrenRecursively($albums); + + return $rows; + } + + private static function getChildrenRecursively($id_parent, $level, &$albums_by_parent) + { + $children = []; + if (!isset($albums_by_parent[$id_parent])) + return $children; + + foreach ($albums_by_parent[$id_parent] as $child) + { + if (isset($albums_by_parent[$child['id_tag']])) + $child['children'] = self::getChildrenRecursively($child['id_tag'], $level + 1, $albums_by_parent); + + $child['tag'] = ($level ? str_repeat('—', $level * 2) . ' ' : '') . $child['tag']; + $children[] = $child; + } + + return $children; + } + + private static function flattenChildrenRecursively($albums) + { + if (empty($albums)) + return []; + + $rows = []; + foreach ($albums as $album) + { + static $headers_to_keep = ['id_tag', 'tag', 'slug', 'count', 'id_user', 'first_name', 'surname']; + $rows[] = array_intersect_key($album, array_flip($headers_to_keep)); + if (!empty($album['children'])) + { + $children = self::flattenChildrenRecursively($album['children']); + foreach ($children as $child) + $rows[] = array_intersect_key($child, array_flip($headers_to_keep)); + } + } + + return $rows; } } -- 2.46.0 From 77809faada78036d141e6a966e8ccaf03925e515 Mon Sep 17 00:00:00 2001 From: Aaron van Geffen Date: Wed, 8 Jan 2025 17:19:09 +0100 Subject: [PATCH 07/11] GenericTable: rename 'parse' option to 'format' --- controllers/ManageAlbums.php | 4 ++-- controllers/ManageAssets.php | 10 +++++----- controllers/ManageErrors.php | 6 +++--- controllers/ManageTags.php | 6 +++--- controllers/ManageUsers.php | 10 +++++----- models/GenericTable.php | 8 ++++---- 6 files changed, 22 insertions(+), 22 deletions(-) diff --git a/controllers/ManageAlbums.php b/controllers/ManageAlbums.php index 0300409..e725db1 100644 --- a/controllers/ManageAlbums.php +++ b/controllers/ManageAlbums.php @@ -35,7 +35,7 @@ class ManageAlbums extends HTMLController 'tag' => [ 'header' => 'Album', 'is_sortable' => true, - 'parse' => [ + 'format' => [ 'link' => BASEURL . '/editalbum/?id={ID_TAG}', 'data' => 'tag', ], @@ -43,7 +43,7 @@ class ManageAlbums extends HTMLController 'slug' => [ 'header' => 'Slug', 'is_sortable' => true, - 'parse' => [ + 'format' => [ 'link' => BASEURL . '/editalbum/?id={ID_TAG}', 'data' => 'slug', ], diff --git a/controllers/ManageAssets.php b/controllers/ManageAssets.php index 9054450..3f5923b 100644 --- a/controllers/ManageAssets.php +++ b/controllers/ManageAssets.php @@ -38,7 +38,7 @@ class ManageAssets extends HTMLController 'checkbox' => [ 'header' => '', 'is_sortable' => false, - 'parse' => [ + 'format' => [ 'type' => 'function', 'data' => function($row) { return ''; @@ -49,7 +49,7 @@ class ManageAssets extends HTMLController 'header' => ' ', 'is_sortable' => false, 'cell_class' => 'text-center', - 'parse' => [ + 'format' => [ 'type' => 'function', 'data' => function($row) { $asset = Image::byRow($row); @@ -87,7 +87,7 @@ class ManageAssets extends HTMLController 'value' => 'filename', 'header' => 'Filename', 'is_sortable' => true, - 'parse' => [ + 'format' => [ 'type' => 'value', 'link' => BASEURL . '/editasset/?id={ID_ASSET}', 'data' => 'filename', @@ -96,7 +96,7 @@ class ManageAssets extends HTMLController 'id_user_uploaded' => [ 'header' => 'User uploaded', 'is_sortable' => true, - 'parse' => [ + 'format' => [ 'type' => 'function', 'data' => function($row) { if (!empty($row['id_user'])) @@ -110,7 +110,7 @@ class ManageAssets extends HTMLController 'dimensions' => [ 'header' => 'Dimensions', 'is_sortable' => false, - 'parse' => [ + 'format' => [ 'type' => 'function', 'data' => function($row) { if (!empty($row['image_width'])) diff --git a/controllers/ManageErrors.php b/controllers/ManageErrors.php index 7dcda24..1496617 100644 --- a/controllers/ManageErrors.php +++ b/controllers/ManageErrors.php @@ -45,7 +45,7 @@ class ManageErrors extends HTMLController 'is_sortable' => true, ], 'message' => [ - 'parse' => [ + 'format' => [ 'type' => 'function', 'data' => function($row) { return $row['message'] . '
' . @@ -71,7 +71,7 @@ class ManageErrors extends HTMLController 'is_sortable' => true, ], 'time' => [ - 'parse' => [ + 'format' => [ 'type' => 'timestamp', 'data' => [ 'timestamp' => 'time', @@ -89,7 +89,7 @@ class ManageErrors extends HTMLController 'uid' => [ 'header' => 'UID', 'is_sortable' => true, - 'parse' => [ + 'format' => [ 'link' => BASEURL . '/edituser/?id={ID_USER}', 'data' => 'id_user', ], diff --git a/controllers/ManageTags.php b/controllers/ManageTags.php index cca4140..400d9b1 100644 --- a/controllers/ManageTags.php +++ b/controllers/ManageTags.php @@ -37,7 +37,7 @@ class ManageTags extends HTMLController 'tag' => [ 'header' => 'Tag', 'is_sortable' => true, - 'parse' => [ + 'format' => [ 'link' => BASEURL . '/edittag/?id={ID_TAG}', 'data' => 'tag', ], @@ -45,7 +45,7 @@ class ManageTags extends HTMLController 'slug' => [ 'header' => 'Slug', 'is_sortable' => true, - 'parse' => [ + 'format' => [ 'link' => BASEURL . '/edittag/?id={ID_TAG}', 'data' => 'slug', ], @@ -53,7 +53,7 @@ class ManageTags extends HTMLController 'id_user_owner' => [ 'header' => 'Owning user', 'is_sortable' => true, - 'parse' => [ + 'format' => [ 'type' => 'function', 'data' => function($row) { if (!empty($row['id_user'])) diff --git a/controllers/ManageUsers.php b/controllers/ManageUsers.php index a3c9a81..068a996 100644 --- a/controllers/ManageUsers.php +++ b/controllers/ManageUsers.php @@ -37,7 +37,7 @@ class ManageUsers extends HTMLController 'surname' => [ 'header' => 'Last name', 'is_sortable' => true, - 'parse' => [ + 'format' => [ 'link' => BASEURL . '/edituser/?id={ID_USER}', 'data' => 'surname', ], @@ -45,7 +45,7 @@ class ManageUsers extends HTMLController 'first_name' => [ 'header' => 'First name', 'is_sortable' => true, - 'parse' => [ + 'format' => [ 'link' => BASEURL . '/edituser/?id={ID_USER}', 'data' => 'first_name', ], @@ -53,7 +53,7 @@ class ManageUsers extends HTMLController 'slug' => [ 'header' => 'Slug', 'is_sortable' => true, - 'parse' => [ + 'format' => [ 'link' => BASEURL . '/edituser/?id={ID_USER}', 'data' => 'slug', ], @@ -64,7 +64,7 @@ class ManageUsers extends HTMLController 'is_sortable' => true, ], 'last_action_time' => [ - 'parse' => [ + 'format' => [ 'type' => 'timestamp', 'data' => [ 'timestamp' => 'last_action_time', @@ -82,7 +82,7 @@ class ManageUsers extends HTMLController 'is_admin' => [ 'is_sortable' => true, 'header' => 'Admin?', - 'parse' => [ + 'format' => [ 'type' => 'function', 'data' => function($row) { return $row['is_admin'] ? 'yes' : 'no'; diff --git a/models/GenericTable.php b/models/GenericTable.php index df48c83..08aa226 100644 --- a/models/GenericTable.php +++ b/models/GenericTable.php @@ -191,9 +191,9 @@ class GenericTable foreach ($options['columns'] as $column) { - // Process data for this particular cell. - if (isset($column['parse'])) - $value = self::processCell($column['parse'], $row); + // Process formatting + if (isset($column['format'])) + $value = self::processFormatting($column['format'], $row); else $value = $row[$column['value']]; @@ -209,7 +209,7 @@ class GenericTable } } - private function processCell($options, $rowData) + private function processFormatting($options, $rowData) { if (!isset($options['type'])) $options['type'] = 'value'; -- 2.46.0 From 6ca3ee6d9d97b59426e464c646a91a42fb60267f Mon Sep 17 00:00:00 2001 From: Aaron van Geffen Date: Wed, 8 Jan 2025 18:27:09 +0100 Subject: [PATCH 08/11] GenericTable: move link generation out of from formatting options --- models/GenericTable.php | 36 +++++++++++++++++++++++++----------- 1 file changed, 25 insertions(+), 11 deletions(-) diff --git a/models/GenericTable.php b/models/GenericTable.php index 08aa226..f564d29 100644 --- a/models/GenericTable.php +++ b/models/GenericTable.php @@ -104,7 +104,7 @@ class GenericTable 'class' => isset($column['class']) ? $column['class'] : '', 'cell_class' => isset($column['cell_class']) ? $column['cell_class'] : null, 'colspan' => !empty($column['header_colspan']) ? $column['header_colspan'] : 1, - 'href' => $isSortable ? $this->getLink($this->start, $key, $sortDirection) : null, + 'href' => $isSortable ? $this->getHeaderLink($this->start, $key, $sortDirection) : null, 'label' => $column['header'], 'scope' => 'col', 'sort_mode' => $key == $this->sort_order ? $this->sort_direction : null, @@ -121,7 +121,7 @@ class GenericTable 'base_url' => $this->base_url, 'index_class' => $options['index_class'] ?? '', 'items_per_page' => $this->items_per_page, - 'linkBuilder' => [$this, 'getLink'], + 'linkBuilder' => [$this, 'getHeaderLink'], 'recordCount' => $this->recordCount, 'sort_direction' => $this->sort_direction, 'sort_order' => $this->sort_order, @@ -129,7 +129,7 @@ class GenericTable ]); } - public function getLink($start = null, $order = null, $dir = null) + public function getHeaderLink($start = null, $order = null, $dir = null) { if ($start === null) $start = $this->start; @@ -197,6 +197,10 @@ class GenericTable else $value = $row[$column['value']]; + // Turn value into a link? + if (!empty($column['link'])) + $value = $this->processLink($column['link'], $value, $row); + // Append the cell to the row. $newRow['cells'][] = [ 'class' => $column['cell_class'] ?? '', @@ -259,18 +263,28 @@ class GenericTable break; } - // Generate a link, if requested. + // TODO: deprecated if (!empty($options['link'])) { - // First, generate the replacement variables. - $keys = array_keys($rowData); - $values = array_values($rowData); - foreach ($keys as $keyKey => $keyValue) - $keys[$keyKey] = '{' . strtoupper($keyValue) . '}'; - - $value = '' . $value . ''; + $value = $this->processLink($options['link'], $value, $rowData); } return $value; } + + private function processLink($template, $value, array $rowData) + { + $href = $this->rowReplacements($template, $rowData); + return '' . $value . ''; + } + + private function rowReplacements($template, array $rowData) + { + $keys = array_keys($rowData); + $values = array_values($rowData); + foreach ($keys as $keyKey => $keyValue) + $keys[$keyKey] = '{' . strtoupper($keyValue) . '}'; + + return str_replace($keys, $values, $template); + } } -- 2.46.0 From 9740416cb2ccef9af25433050acaf7a25d0fbb77 Mon Sep 17 00:00:00 2001 From: Aaron van Geffen Date: Wed, 8 Jan 2025 18:31:29 +0100 Subject: [PATCH 09/11] Management controllers: make format functions first-level --- controllers/ManageAlbums.php | 12 ++---- controllers/ManageAssets.php | 84 +++++++++++++++--------------------- controllers/ManageErrors.php | 27 +++++------- controllers/ManageTags.php | 29 +++++-------- controllers/ManageUsers.php | 25 +++-------- models/GenericTable.php | 4 +- 6 files changed, 70 insertions(+), 111 deletions(-) diff --git a/controllers/ManageAlbums.php b/controllers/ManageAlbums.php index e725db1..248e369 100644 --- a/controllers/ManageAlbums.php +++ b/controllers/ManageAlbums.php @@ -35,18 +35,14 @@ class ManageAlbums extends HTMLController 'tag' => [ 'header' => 'Album', 'is_sortable' => true, - 'format' => [ - 'link' => BASEURL . '/editalbum/?id={ID_TAG}', - 'data' => 'tag', - ], + 'link' => BASEURL . '/editalbum/?id={ID_TAG}', + 'value' => 'tag', ], 'slug' => [ 'header' => 'Slug', 'is_sortable' => true, - 'format' => [ - 'link' => BASEURL . '/editalbum/?id={ID_TAG}', - 'data' => 'slug', - ], + 'link' => BASEURL . '/editalbum/?id={ID_TAG}', + 'value' => 'slug', ], 'count' => [ 'header' => '# Photos', diff --git a/controllers/ManageAssets.php b/controllers/ManageAssets.php index 3f5923b..59895ff 100644 --- a/controllers/ManageAssets.php +++ b/controllers/ManageAssets.php @@ -38,40 +38,33 @@ class ManageAssets extends HTMLController 'checkbox' => [ 'header' => '', 'is_sortable' => false, - 'format' => [ - 'type' => 'function', - 'data' => function($row) { - return ''; - }, - ], + 'format' => fn($row) => + '', ], 'thumbnail' => [ 'header' => ' ', 'is_sortable' => false, 'cell_class' => 'text-center', - 'format' => [ - 'type' => 'function', - 'data' => function($row) { - $asset = Image::byRow($row); - $width = $height = 65; - if ($asset->isImage()) - { - if ($asset->isPortrait()) - $width = null; - else - $height = null; - - $thumb = $asset->getThumbnailUrl($width, $height); - } + 'format' => function($row) { + $asset = Image::byRow($row); + $width = $height = 65; + if ($asset->isImage()) + { + if ($asset->isPortrait()) + $width = null; else - $thumb = BASEURL . '/images/nothumb.svg'; + $height = null; - $width = isset($width) ? $width . 'px' : 'auto'; - $height = isset($height) ? $height . 'px' : 'auto'; + $thumb = $asset->getThumbnailUrl($width, $height); + } + else + $thumb = BASEURL . '/images/nothumb.svg'; - return sprintf('', $thumb, $width, $height); - }, - ], + $width = isset($width) ? $width . 'px' : 'auto'; + $height = isset($height) ? $height . 'px' : 'auto'; + + return sprintf('', $thumb, $width, $height); + }, ], 'id_asset' => [ 'value' => 'id_asset', @@ -87,38 +80,29 @@ class ManageAssets extends HTMLController 'value' => 'filename', 'header' => 'Filename', 'is_sortable' => true, - 'format' => [ - 'type' => 'value', - 'link' => BASEURL . '/editasset/?id={ID_ASSET}', - 'data' => 'filename', - ], + 'link' => BASEURL . '/editasset/?id={ID_ASSET}', + 'value' => 'filename', ], 'id_user_uploaded' => [ 'header' => 'User uploaded', 'is_sortable' => true, - 'format' => [ - 'type' => 'function', - 'data' => function($row) { - if (!empty($row['id_user'])) - return sprintf('%s', BASEURL, $row['id_user'], - $row['first_name'] . ' ' . $row['surname']); - else - return 'n/a'; - }, - ], + 'format' => function($row) { + if (!empty($row['id_user'])) + return sprintf('%s', BASEURL, $row['id_user'], + $row['first_name'] . ' ' . $row['surname']); + else + return 'n/a'; + }, ], 'dimensions' => [ 'header' => 'Dimensions', 'is_sortable' => false, - 'format' => [ - 'type' => 'function', - 'data' => function($row) { - if (!empty($row['image_width'])) - return $row['image_width'] . ' x ' . $row['image_height']; - else - return 'n/a'; - }, - ], + 'format' => function($row) { + if (!empty($row['image_width'])) + return $row['image_width'] . ' x ' . $row['image_height']; + else + return 'n/a'; + }, ], ], 'default_sort_order' => 'id_asset', diff --git a/controllers/ManageErrors.php b/controllers/ManageErrors.php index 1496617..cdb75dc 100644 --- a/controllers/ManageErrors.php +++ b/controllers/ManageErrors.php @@ -45,20 +45,17 @@ class ManageErrors extends HTMLController 'is_sortable' => true, ], 'message' => [ - 'format' => [ - 'type' => 'function', - 'data' => function($row) { - return $row['message'] . '
' . - '
Show debug info' . - '
' . htmlspecialchars($row['debug_info']) .
-								'
' . - '' . - htmlspecialchars($row['request_uri']) . ''; - } - ], 'header' => 'Message / URL', 'is_sortable' => false, + 'format' => function($row) { + return $row['message'] . '
' . + '
Show debug info' . + '
' . htmlspecialchars($row['debug_info']) .
+							'
' . + '' . + htmlspecialchars($row['request_uri']) . ''; + }, ], 'file' => [ 'value' => 'file', @@ -89,10 +86,8 @@ class ManageErrors extends HTMLController 'uid' => [ 'header' => 'UID', 'is_sortable' => true, - 'format' => [ - 'link' => BASEURL . '/edituser/?id={ID_USER}', - 'data' => 'id_user', - ], + 'link' => BASEURL . '/edituser/?id={ID_USER}', + 'value' => 'id_user', ], ], 'default_sort_order' => 'id_entry', diff --git a/controllers/ManageTags.php b/controllers/ManageTags.php index 400d9b1..9dc653b 100644 --- a/controllers/ManageTags.php +++ b/controllers/ManageTags.php @@ -37,32 +37,25 @@ class ManageTags extends HTMLController 'tag' => [ 'header' => 'Tag', 'is_sortable' => true, - 'format' => [ - 'link' => BASEURL . '/edittag/?id={ID_TAG}', - 'data' => 'tag', - ], + 'link' => BASEURL . '/edittag/?id={ID_TAG}', + 'value' => 'tag', ], 'slug' => [ 'header' => 'Slug', 'is_sortable' => true, - 'format' => [ - 'link' => BASEURL . '/edittag/?id={ID_TAG}', - 'data' => 'slug', - ], + 'link' => BASEURL . '/edittag/?id={ID_TAG}', + 'value' => 'slug', ], 'id_user_owner' => [ 'header' => 'Owning user', 'is_sortable' => true, - 'format' => [ - 'type' => 'function', - 'data' => function($row) { - if (!empty($row['id_user'])) - return sprintf('%s', BASEURL, $row['id_user'], - $row['first_name'] . ' ' . $row['surname']); - else - return 'n/a'; - }, - ], + 'format' => function($row) { + if (!empty($row['id_user'])) + return sprintf('%s', BASEURL, $row['id_user'], + $row['first_name'] . ' ' . $row['surname']); + else + return 'n/a'; + }, ], 'count' => [ 'header' => 'Cardinality', diff --git a/controllers/ManageUsers.php b/controllers/ManageUsers.php index 068a996..5e66946 100644 --- a/controllers/ManageUsers.php +++ b/controllers/ManageUsers.php @@ -37,26 +37,20 @@ class ManageUsers extends HTMLController 'surname' => [ 'header' => 'Last name', 'is_sortable' => true, - 'format' => [ - 'link' => BASEURL . '/edituser/?id={ID_USER}', - 'data' => 'surname', - ], + 'link' => BASEURL . '/edituser/?id={ID_USER}', + 'value' => 'surname', ], 'first_name' => [ 'header' => 'First name', 'is_sortable' => true, - 'format' => [ - 'link' => BASEURL . '/edituser/?id={ID_USER}', - 'data' => 'first_name', - ], + 'link' => BASEURL . '/edituser/?id={ID_USER}', + 'value' => 'first_name', ], 'slug' => [ 'header' => 'Slug', 'is_sortable' => true, - 'format' => [ - 'link' => BASEURL . '/edituser/?id={ID_USER}', - 'data' => 'slug', - ], + 'link' => BASEURL . '/edituser/?id={ID_USER}', + 'value' => 'slug', ], 'emailaddress' => [ 'value' => 'emailaddress', @@ -82,12 +76,7 @@ class ManageUsers extends HTMLController 'is_admin' => [ 'is_sortable' => true, 'header' => 'Admin?', - 'format' => [ - 'type' => 'function', - 'data' => function($row) { - return $row['is_admin'] ? 'yes' : 'no'; - } - ], + 'format' => fn($row) => $row['is_admin'] ? 'yes' : 'no', ], ], 'default_sort_order' => 'id_user', diff --git a/models/GenericTable.php b/models/GenericTable.php index f564d29..50cf258 100644 --- a/models/GenericTable.php +++ b/models/GenericTable.php @@ -192,7 +192,9 @@ class GenericTable foreach ($options['columns'] as $column) { // Process formatting - if (isset($column['format'])) + if (isset($column['format']) && is_callable($column['format'])) + $value = $column['format']($row); + elseif (isset($column['format'])) $value = self::processFormatting($column['format'], $row); else $value = $row[$column['value']]; -- 2.46.0 From 7c25d628e1187744f46859606febcb75c25ae99c Mon Sep 17 00:00:00 2001 From: Aaron van Geffen Date: Wed, 8 Jan 2025 18:32:24 +0100 Subject: [PATCH 10/11] GenericTable: remove unused formatting types --- models/GenericTable.php | 22 ---------------------- 1 file changed, 22 deletions(-) diff --git a/models/GenericTable.php b/models/GenericTable.php index 50cf258..2fcb900 100644 --- a/models/GenericTable.php +++ b/models/GenericTable.php @@ -217,31 +217,9 @@ class GenericTable private function processFormatting($options, $rowData) { - if (!isset($options['type'])) - $options['type'] = 'value'; - // Parse the basic value first. switch ($options['type']) { - // Basic option: simply take a use a particular data property. - case 'value': - $value = htmlspecialchars($rowData[$options['data']] ?? ''); - break; - - // Processing via a lambda function. - case 'function': - $value = $options['data']($rowData); - break; - - // Using sprintf to fill out a particular pattern. - case 'sprintf': - $parameters = [$options['data']['pattern']]; - foreach ($options['data']['arguments'] as $identifier) - $parameters[] = $rowData[$identifier]; - - $value = sprintf(...$parameters); - break; - // Timestamps get custom treatment. case 'timestamp': if (empty($options['data']['pattern']) || $options['data']['pattern'] === 'long') -- 2.46.0 From 00ca931cf3613c93e052cc7ec1260feea0abbd79 Mon Sep 17 00:00:00 2001 From: Aaron van Geffen Date: Wed, 8 Jan 2025 18:37:17 +0100 Subject: [PATCH 11/11] GenericTable: rework timestamp formatting --- controllers/ManageErrors.php | 6 ++--- controllers/ManageUsers.php | 6 ++--- models/GenericTable.php | 49 +++++++++++++++--------------------- 3 files changed, 24 insertions(+), 37 deletions(-) diff --git a/controllers/ManageErrors.php b/controllers/ManageErrors.php index cdb75dc..75186aa 100644 --- a/controllers/ManageErrors.php +++ b/controllers/ManageErrors.php @@ -70,10 +70,8 @@ class ManageErrors extends HTMLController 'time' => [ 'format' => [ 'type' => 'timestamp', - 'data' => [ - 'timestamp' => 'time', - 'pattern' => 'long', - ], + 'pattern' => 'long', + 'value' => 'time', ], 'header' => 'Time', 'is_sortable' => true, diff --git a/controllers/ManageUsers.php b/controllers/ManageUsers.php index 5e66946..8473596 100644 --- a/controllers/ManageUsers.php +++ b/controllers/ManageUsers.php @@ -60,10 +60,8 @@ class ManageUsers extends HTMLController 'last_action_time' => [ 'format' => [ 'type' => 'timestamp', - 'data' => [ - 'timestamp' => 'last_action_time', - 'pattern' => 'long', - ], + 'pattern' => 'long', + 'value' => 'last_action_time', ], 'header' => 'Last activity', 'is_sortable' => true, diff --git a/models/GenericTable.php b/models/GenericTable.php index 2fcb900..ec76a1a 100644 --- a/models/GenericTable.php +++ b/models/GenericTable.php @@ -217,39 +217,30 @@ class GenericTable private function processFormatting($options, $rowData) { - // Parse the basic value first. - switch ($options['type']) + if ($options['type'] === 'timestamp') { - // Timestamps get custom treatment. - case 'timestamp': - if (empty($options['data']['pattern']) || $options['data']['pattern'] === 'long') - $pattern = 'Y-m-d H:i'; - elseif ($options['data']['pattern'] === 'short') - $pattern = 'Y-m-d'; - else - $pattern = $options['data']['pattern']; + if (empty($options['pattern']) || $options['pattern'] === 'long') + $pattern = 'Y-m-d H:i'; + elseif ($options['pattern'] === 'short') + $pattern = 'Y-m-d'; + else + $pattern = $options['pattern']; - if (!isset($rowData[$options['data']['timestamp']])) - $timestamp = 0; - elseif (!is_numeric($rowData[$options['data']['timestamp']])) - $timestamp = strtotime($rowData[$options['data']['timestamp']]); - else - $timestamp = (int) $rowData[$options['data']['timestamp']]; + assert(isset($rowData[$options['value']])); + if (!is_numeric($rowData[$options['value']])) + $timestamp = strtotime($rowData[$options['value']]); + else + $timestamp = (int) $rowData[$options['value']]; - if (isset($options['data']['if_null']) && $timestamp == 0) - $value = $options['data']['if_null']; - else - $value = date($pattern, $timestamp); - break; + if (isset($options['if_null']) && $timestamp == 0) + $value = $options['if_null']; + else + $value = date($pattern, $timestamp); + + return $value; } - - // TODO: deprecated - if (!empty($options['link'])) - { - $value = $this->processLink($options['link'], $value, $rowData); - } - - return $value; + else + throw ValueError('Unexpected formatter type: ' . $options['type']); } private function processLink($template, $value, array $rowData) -- 2.46.0