Skip to content

[3.0] Enhance data handling and improve code readability #9191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
live627 wants to merge 17 commits into
base: release-3.0
Choose a base branch
from
+260 −245
Open

[3.0] Enhance data handling and improve code readability #9191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
7992156
add html entities on display, not in source
live627 Apr 20, 2026
b40ffdf
template layers
live627 Apr 20, 2026
5663645
do not display id
live627 Apr 20, 2026
7210c02
each list shall have its own sorting variable
live627 Apr 20, 2026
5ec9146
sort each list separately
live627 Apr 20, 2026
115f840
unpack supports offsets now
live627 Apr 20, 2026
5fabc5a
only extract data when we know for sure that we want that file
live627 Apr 20, 2026
1ee1c5a
reformat installed mods into a hash map that we can use directly
live627 Apr 20, 2026
83314ac
ord cache
live627 Apr 20, 2026
a7498d9
more readable code for directory traversal
live627 Apr 20, 2026
0047777
rewrite tar reader to make fewer temp strings
live627 Apr 20, 2026
2d6e4ce
build dirname in temp string once and reuse it
live627 Apr 20, 2026
356b805
wrong function name used
live627 Apr 20, 2026
8c84c10
avoid sprintf() when building tar backups
live627 Apr 20, 2026
685370f
user/group cache
live627 Apr 20, 2026
d876e88
Apply suggestion from @live627
live627 May 1, 2026
b513efc
Apply suggestion from @live627
live627 May 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion Languages/en_US/Packages.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
$txt['package_proceed'] = 'Proceed';
$txt['php_script'] = 'Modification file was extracted, but this modification also comes with a PHP script which should be executed before it will work';
$txt['package_run'] = 'Run';
$txt['package_id'] = 'ID';
$txt['package_read'] = 'Read';
$txt['script_output'] = 'Script output:';
$txt['additional_notes'] = 'Additional notes';
Expand Down
165 changes: 73 additions & 92 deletions Sources/PackageManager/PackageManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1579,7 +1579,8 @@ public function browse(): void
Utils::$context['page_title'] .= ' - ' . Lang::getTxt('browse_packages', file: 'Admin');

Utils::$context['forum_version'] = SMF_FULL_VERSION;
Utils::$context['available_packages'] = 0;
$packages = self::getPackages();
Utils::$context['available_packages'] = \count($packages);
Utils::$context['modification_types'] = ['modification', 'avatar', 'language', 'unknown', 'smiley'];

IntegrationHook::call('integrate_modification_types');
Expand All @@ -1591,50 +1592,55 @@ public function browse(): void
'title' => Lang::getTxt($type . '_package', file: 'Packages'),
'no_items_label' => Lang::getTxt('no_packages', file: 'Packages'),
'get_items' => [
'function' => [$this, 'list_getPackages'],
'params' => [$type],
'function' => function($start, $items_per_page, $sort) use ($packages, $type)
{
if (!isset($packages[$type]))
return [];

$col = strtok($sort, ' ');
$dir = strtok(' ');
array_multisort(
array_column($packages[$type], $col),
$dir === 'desc' ? SORT_DESC : SORT_ASC,
$packages[$type]
);

return $packages[$type];
},
],
'base_href' => Config::$scripturl . '?action=admin;area=packages;sa=browse',
'default_sort_col' => 'time_installed',
'default_sort_dir' => 'desc',
'request_vars' => [
'sort' => $type . '_sort',
],
'base_href' => Config::$scripturl . '?action=admin;area=packages;sa=browse;type=' . $type,
'default_sort_col' => 'id' . $type,
'columns' => [
'id' . $type => [
'header' => [
'value' => Lang::getTxt('package_id', file: 'Packages'),
],
'data' => [
'db' => 'sort_id',
],
'sort' => [
'default' => 'sort_id',
'reverse' => 'sort_id',
],
],
'package_name' . $type => [
'package_name' => [
'header' => [
'value' => Lang::getTxt('package_name_header', file: 'Packages'),
'style' => 'width: 25%;',
],
'data' => [
'db' => 'name',
'db_htmlsafe' => 'name',
],
'sort' => [
'default' => 'name',
'reverse' => 'name',
'reverse' => 'name desc',
],
],
'version' . $type => [
'version' => [
'header' => [
'value' => Lang::getTxt('package_version_header', file: 'Packages'),
],
'data' => [
'db' => 'version',
'db_htmlsafe' => 'version',
],
'sort' => [
'default' => 'version',
'reverse' => 'version',
'reverse' => 'version desc',
],
],
'time_installed' . $type => [
'time_installed' => [
'header' => [
'value' => Lang::getTxt('package_installed_time', file: 'Packages'),
],
Expand All @@ -1648,13 +1654,10 @@ public function browse(): void
],
'sort' => [
'default' => 'time_installed',
'reverse' => 'time_installed',
'reverse' => 'time_installed desc',
],
],
'operations' . $type => [
'header' => [
'value' => '',
],
'operations' => [
'data' => [
'function' => function ($package) use ($type) {
$return = '';
Expand Down Expand Up @@ -1689,8 +1692,17 @@ public function browse(): void
new ItemList($listOptions);
}

Utils::$context['sub_template'] = 'browse';
Utils::$context['default_list'] = 'packages_lists';
if (Utils::$context['available_packages'] === 0) {
Utils::$context['sub_templates'][] = 'no_packages';
} else {
foreach (Utils::$context['modification_types'] as $type) {
if (!empty(Utils::$context['packages_lists_' . $type]['rows'])) {
Utils::$context['sub_templates'][] = ['show_list', ['packages_lists_' . $type]];
}
}
}

Utils::$context['template_layers'][] = 'browse';

$get_versions = Db::$db->query(
'SELECT data FROM {db_prefix}admin_info_files WHERE filename={string:versionsfile} AND path={string:smf}',
Expand Down Expand Up @@ -3185,18 +3197,11 @@ public function serverRemove(): void
* Determines whether the package has been installed or not by
* checking it against {@link loadInstalledPackages()}.
*
* @param int $start The item to start with (not used here)
* @param int $items_per_page The number of items to show per page (not used here)
* @param string $sort A string indicating how to sort the results
* @param string $params Type of packages
* @return array An array of information about the packages
*/
public function list_getPackages(int $start, int $items_per_page, string $sort, string $params): array
public function getPackages(): array
{
static $installed_mods;

$packages = [];
$column = [];

// We need the packages directory to be writable for this.
if (!@is_writable(Config::$packagesdir)) {
Expand Down Expand Up @@ -3225,22 +3230,10 @@ public function list_getPackages(int $start, int $items_per_page, string $sort,
unset($_SESSION['single_version_emulate']);
}

if (empty($installed_mods)) {
$instmods = PackageUtils::loadInstalledPackages();
$installed_mods = [];
$installed_mods = PackageUtils::loadInstalledPackages();

// Look through the list of installed mods...
foreach ($instmods as $installed_mod) {
$installed_mods[$installed_mod['package_id']] = [
'id' => $installed_mod['id'],
'version' => $installed_mod['version'],
'time_installed' => $installed_mod['time_installed'],
];
}

// Get a list of all the ids installed, so the latest packages won't include already installed ones.
Utils::$context['installed_mods'] = array_keys($installed_mods);
}
// Get a list of all the ids installed, so the latest packages widget won't include already installed ones.
Utils::$context['installed_mods'] = array_keys($installed_mods);

if ($dir = @opendir(Config::$packagesdir)) {
$dirs = [];
Expand All @@ -3254,26 +3247,29 @@ public function list_getPackages(int $start, int $items_per_page, string $sort,
IntegrationHook::call('integrate_packages_sort_id', [&$sort_id, &$packages]);

while ($package = readdir($dir)) {
if ($package == '.' || $package == '..' || $package == 'temp' || (!(is_dir(Config::$packagesdir . '/' . $package) && file_exists(Config::$packagesdir . '/' . $package . '/package-info.xml')) && !str_ends_with(strtolower($package), '.tar.gz') && !str_ends_with(strtolower($package), '.tgz') && !str_ends_with(strtolower($package), '.zip'))) {
// Skip hidden files and directories.
if ($package[0] === '.' || $package === 'temp') {
continue;
}

// Skip directories or files that are named the same.
if (is_dir(Config::$packagesdir . '/' . $package)) {
$is_dir = is_dir(Config::$packagesdir . '/' . $package);
if ($is_dir)
{
// Skip packages that are named the same.
if (\in_array($package, $dirs)) {
continue;
}
$dirs[] = $package;
} elseif (str_ends_with(strtolower($package), '.tar.gz')) {
if (\in_array(substr($package, 0, -7), $dirs)) {
continue;
}
$dirs[] = substr($package, 0, -7);
} elseif (str_ends_with(strtolower($package), '.zip') || str_ends_with(strtolower($package), '.tgz')) {
if (\in_array(substr($package, 0, -4), $dirs)) {
continue;
} else {
// pathinfo() does not parse complex file extensions correctly, so do it manually.
if (preg_match('/^.*(?=\.(?:zip|t(?:ar\.)?gz)$)/i', $package, $m)) {
$basename = $m[0];

if (\in_array($basename, $dirs)) {
continue;
}
$dirs[] = $basename;
}
$dirs[] = substr($package, 0, -4);
}

$packageInfo = PackageUtils::getPackageInfo($package);
Expand All @@ -3282,23 +3278,23 @@ public function list_getPackages(int $start, int $items_per_page, string $sort,
continue;
}

if (!empty($packageInfo)) {
if ($packageInfo !== []) {
if (!isset($sort_id[$packageInfo['type']])) {
$packageInfo['sort_id'] = $sort_id['unknown'];
} else {
$packageInfo['sort_id'] = $sort_id[$packageInfo['type']];
$packageInfo['type'] = 'unknown';
}

$packageInfo['time_installed'] = 0;
$packageInfo['is_installed'] = isset($installed_mods[$packageInfo['id']]);
$id = $packageInfo['id'];
$packageInfo['is_installed'] = isset($installed_mods[$id]);

if ($packageInfo['is_installed']) {
$packageInfo['is_current'] = $installed_mods[$packageInfo['id']]['version'] == $packageInfo['version'];
$packageInfo['is_newer'] = $installed_mods[$packageInfo['id']]['version'] > $packageInfo['version'];
$packageInfo['installed_id'] = $installed_mods[$packageInfo['id']]['id'];
$installed_mod = $installed_mods[$id];
$packageInfo['is_current'] = $installed_mod['version'] == $packageInfo['version'];
$packageInfo['is_newer'] = $installed_mod['version'] > $packageInfo['version'];
$packageInfo['installed_id'] = $installed_mod['id'];

if ($packageInfo['is_current']) {
$packageInfo['time_installed'] = $installed_mods[$packageInfo['id']]['time_installed'];
$packageInfo['time_installed'] = $installed_mod['time_installed'];
}
}

Expand Down Expand Up @@ -3340,7 +3336,7 @@ public function list_getPackages(int $start, int $items_per_page, string $sort,
foreach ($upgrades as $upgrade) {
// Even if it is for this SMF, is it for the installed version of the mod?
if (!$upgrade->exists('@for') || PackageUtils::matchPackageVersion($the_version, $upgrade->fetch('@for'))) {
if (!$upgrade->exists('@from') || PackageUtils::matchPackageVersion((string) $installed_mods[$packageInfo['id']]['version'], $upgrade->fetch('@from'))) {
if (!$upgrade->exists('@from') || PackageUtils::matchPackageVersion((string) $installed_mod['version'], $upgrade->fetch('@from'))) {
$packageInfo['can_upgrade'] = true;
break;
}
Expand Down Expand Up @@ -3374,26 +3370,11 @@ public function list_getPackages(int $start, int $items_per_page, string $sort,
// Save some memory by not passing the XmlArray object into context.
unset($packageInfo['xml']);

if (isset($sort_id[$packageInfo['type']]) && $params == $packageInfo['type']) {
$column[] = $packageInfo[$sort];
$sort_id[$packageInfo['type']]++;
$packages[] = $packageInfo;
} elseif (!isset($sort_id[$packageInfo['type']]) && $params == 'unknown') {
$column[] = $packageInfo[$sort];
$packageInfo['sort_id'] = $sort_id['unknown'];
$sort_id['unknown']++;
$packages[] = $packageInfo;
}
$packages[$packageInfo['type']][] = $packageInfo;
}
}
closedir($dir);
}
Utils::$context['available_packages'] += \count($packages);
array_multisort(
$column,
isset($_GET['desc']) ? SORT_DESC : SORT_ASC,
$packages,
);

return $packages;
}
Expand Down
Loading
Loading