Merge pull request #3695 from Nriver/master

add natural sort for notes, introduce new label #sortNatural

src/public/app/widgets/dialogs/sort_child_notes.js

@@ -65,6 +65,26 @@ const TPL = `<div class="sort-child-notes-dialog modal mx-auto" tabindex="-1" ro
                             sort folders at the top
                         </label>
                     </div>
+                    
+                    <br />
+                    
+                    <h5>Natural Sort</h5>
+
+                    <div class="form-check">
+                        <label class="form-check-label">
+                            <input class="form-check-input" type="checkbox" name="sort-natural" value="1">
+                            sort with respect to different character sorting and collation rules in different languages or regions.
+                        </label>
+                    </div>
+                    <br />
+                    
+                    <div class="form-check">
+                        <label>
+                            Natural sort language
+                            <input class="form-control" name="sort-locale">
+                            The language code for natural sort, e.g. "zh-CN" for Chinese.
+                        </label>
+                    </div>
                 </div>
                 <div class="modal-footer">
                     <button type="submit" class="btn btn-primary">Sort <kbd>enter</kbd></button>
@@ -83,8 +103,10 @@ export default class SortChildNotesDialog extends BasicWidget {
             const sortBy = this.$form.find("input[name='sort-by']:checked").val();
             const sortDirection = this.$form.find("input[name='sort-direction']:checked").val();
             const foldersFirst = this.$form.find("input[name='sort-folders-first']").is(":checked");
+            const sortNatural = this.$form.find("input[name='sort-natural']").is(":checked");
+            const sortLocale = this.$form.find("input[name='sort-locale']").val();
 
-            await server.put(`notes/${this.parentNoteId}/sort-children`, {sortBy, sortDirection, foldersFirst});
+            await server.put(`notes/${this.parentNoteId}/sort-children`, {sortBy, sortDirection, foldersFirst, sortNatural, sortLocale});
 
             utils.closeActiveDialog();
         });

src/routes/api/notes.js

@@ -94,13 +94,13 @@ function undeleteNote(req) {
 
 function sortChildNotes(req) {
     const noteId = req.params.noteId;
-    const {sortBy, sortDirection, foldersFirst} = req.body;
+    const {sortBy, sortDirection, foldersFirst, sortNatural, sortLocale} = req.body;
 
-    log.info(`Sorting '${noteId}' children with ${sortBy} ${sortDirection}, foldersFirst=${foldersFirst}`);
+    log.info(`Sorting '${noteId}' children with ${sortBy} ${sortDirection}, foldersFirst=${foldersFirst}, sortNatural=${sortNatural}, sortLocale=${sortLocale}`);
 
     const reverse = sortDirection === 'desc';
 
-    treeService.sortNotes(noteId, sortBy, reverse, foldersFirst);
+    treeService.sortNotes(noteId, sortBy, reverse, foldersFirst, sortNatural, sortLocale);
 }
 
 function protectNote(req) {

src/services/builtin_attributes.js

@@ -42,6 +42,8 @@ module.exports = [
     { type: 'label', name: 'sorted' },
     { type: 'label', name: 'sortDirection' },
     { type: 'label', name: 'sortFoldersFirst' },
+    { type: 'label', name: 'sortNatural' },
+    { type: 'label', name: 'sortLocale' },
     { type: 'label', name: 'top' },
     { type: 'label', name: 'fullContentWidth' },
     { type: 'label', name: 'shareHiddenFromTree' },

src/services/handlers.js

@@ -46,7 +46,7 @@ eventService.subscribe([ eventService.ENTITY_CHANGED, eventService.ENTITY_DELETE
     if (entityName === 'attributes') {
         runAttachedRelations(entity.getNote(), 'runOnAttributeChange', entity);
 
-        if (entity.type === 'label' && ['sorted', 'sortDirection', 'sortFoldersFirst'].includes(entity.name)) {
+        if (entity.type === 'label' && ['sorted', 'sortDirection', 'sortFoldersFirst', 'sortNatural', 'sortLocale'].includes(entity.name)) {
             handleSortedAttribute(entity);
         } else if (entity.type === 'label') {
             handleMaybeSortingLabel(entity);
@@ -101,7 +101,7 @@ eventService.subscribe(eventService.ENTITY_CREATED, ({ entityName, entity }) =>
                 noteService.duplicateSubtreeWithoutRoot(templateNote.noteId, note.noteId);
             }
         }
-        else if (entity.type === 'label' && ['sorted', 'sortDirection', 'sortFoldersFirst'].includes(entity.name)) {
+        else if (entity.type === 'label' && ['sorted', 'sortDirection', 'sortFoldersFirst', 'sortNatural', 'sortLocale'].includes(entity.name)) {
             handleSortedAttribute(entity);
         }
         else if (entity.type === 'label') {

src/services/tree.js

@@ -123,11 +123,16 @@ function loadSubtreeNoteIds(parentNoteId, subtreeNoteIds) {
     }
 }
 
-function sortNotes(parentNoteId, customSortBy = 'title', reverse = false, foldersFirst = false) {
+function sortNotes(parentNoteId, customSortBy = 'title', reverse = false, foldersFirst = false, sortNatural = false, sortLocale) {
     if (!customSortBy) {
         customSortBy = 'title';
     }
 
+    if (!sortLocale) {
+        // sortLocale can not be empty string or null value, default value must be set to undefined.
+        sortLocale = undefined;
+    }
+
     sql.transactional(() => {
         const notes = becca.getNote(parentNoteId).getChildNotes();
 
@@ -153,7 +158,14 @@ function sortNotes(parentNoteId, customSortBy = 'title', reverse = false, folder
             }
 
             function compare(a, b) {
-                return b === null || b === undefined || a < b ? -1 : 1;
+                if (!sortNatural){
+                    // alphabetical sort
+                    return b === null || b === undefined || a < b ? -1 : 1;
+                } else {
+                    // natural sort
+                    return a.localeCompare(b, sortLocale, {numeric: true, sensitivity: 'base'});
+                }
+
             }
 
             const topAEl = fetchValue(a, 'top');
@@ -224,8 +236,11 @@ function sortNotesIfNeeded(parentNoteId) {
     const sortReversed = parentNote.getLabelValue('sortDirection')?.toLowerCase() === "desc";
     const sortFoldersFirstLabel = parentNote.getLabel('sortFoldersFirst');
     const sortFoldersFirst = sortFoldersFirstLabel && sortFoldersFirstLabel.value.toLowerCase() !== "false";
+    const sortNaturalLabel = parentNote.getLabel('sortNatural');
+    const sortNatural = sortNaturalLabel && sortNaturalLabel.value.toLowerCase() !== "false";
+    const sortLocale = parentNote.getLabelValue('sortLocale');
 
-    sortNotes(parentNoteId, sortedLabel.value, sortReversed, sortFoldersFirst);
+    sortNotes(parentNoteId, sortedLabel.value, sortReversed, sortFoldersFirst, sortNatural, sortLocale);
 }
 
 /**