[Tiki-devel] Unicode-aware sort plugin

Volker Wysk <post-hhF2Jplw28UoZk/[email protected]> Thu, 29 Jun 2023 19:06:06 +0200

Newsgroups	gmane.comp.cms.tiki.devel
Message-ID	<[email protected]>

Hi!

The Sort Plugin is kinda broken, because it isn't Unicode aware. That's not
that easy to fix, because the PHP natcasesort() function isn't Unicode
aware. And there is no mb_natcasesort(). It needs to be done differently.

I've found on the web, how it is to be done, here:

https://stackoverflow.com/questions/58577558/how-to-use-multiple-sort-flags-in-php-array-sorting-using-sort-locale-string

I've applied it to the wikiplugin_sort and it works. However, this plugin
needs to use the correct locale for the user. I don't know how to get this
locale. This bit is still missing.

I've attached the new wikiplugin_sort.php.

Someone with more Tiki knowledge should improve this version, by querying
the locale to be used and pass it to the collator_create function.

I suspect that this state of affairs occurs in a few other places as well,
which use "natural ordering".

Cheers,
Volker

_______________________________________________
TikiWiki-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/tikiwiki-devel

wikiplugin_sort.php (application/x-php, 2.4 KB)

<?php

// (c) Copyright by authors of the Tiki Wiki CMS Groupware Project
//
// All Rights Reserved. See copyright.txt for details and a complete list of authors.
// Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See license.txt for details.
// $Id$

function wikiplugin_sort_info()
{
    return [
        'name' => tra('Sort'),
        'documentation' => 'PluginSort',
        'description' => tra('Sort lines of text'),
        'prefs' => [ 'wikiplugin_sort' ],
        'body' => tra('Data to sort, one entry per line.'),
        'filter' => 'text',
        'iconname' => 'sort-desc',
        'introduced' => 1,
        'tags' => [ 'basic' ],
        'params' => [
            'sort' => [
                'required' => false,
                'name' => tra('Order'),
                'description' => tra('Set the sort order of lines of content (default is ascending)'),
                'since' => '1',
                'filter' => 'alpha',
                'default' => 'asc',
                'options' => [
                    ['text' => '', 'value' => ''],
                    ['text' => tra('Ascending'), 'value' => 'asc'],
                    ['text' => tra('Descending'), 'value' => 'desc'],
                    ['text' => tra('Reverse'), 'value' => 'reverse'],
                    ['text' => tra('Shuffle'), 'value' => 'shuffle']
                ]
            ]
        ]
    ];
}

function wikiplugin_sort($data, $params)
{
    global $tikilib;

    extract($params, EXTR_SKIP);

    $sort = (isset($sort)) ? $sort : "asc";

    $lines = preg_split("/\n+/", $data, -1, PREG_SPLIT_NO_EMPTY); // separate lines into array
    // $lines = array_filter( $lines, "chop" ); // remove \n
    srand((float) microtime() * 1000000); // needed for shuffle;

    # XXX Need to insert correct locale here!
    $coll = collator_create("de_DE");

    collator_set_attribute($coll, Collator::NUMERIC_COLLATION, Collator::ON);
    collator_set_attribute($coll, Collator::CASE_FIRST, Collator::LOWER_FIRST);

    if ($sort == "asc") {
        collator_asort($coll, $lines);
    } elseif ($sort == "desc") {
        collator_asort($coll, $lines);
        $lines = array_reverse($lines);
    } elseif ($sort == "reverse") {
        $lines = array_reverse($lines);
    } elseif ($sort == "shuffle") {
        shuffle($lines);
    }

    reset($lines);

    if (is_array($lines)) {
        $data = implode("\n", $lines);
    }

    $data = trim($data);
    return $data;
}

signature.asc (application/pgp-signature, 833 B)