[GUI Plugin] Reading List

[JimmXinu]

Originally Posted by ownedbycats

Created a fresh test library for replication and was able to repeat results even in a portable Calibre with only Reading List and View Manager. So here it is.

This is your idea of a "fresh" library? There's 40+ columns, dozens of saved searches and your view sorts on 7 columns. And you haven't mentioned what column(s) aren't sorting correctly--just that a book is 'stuck at the bottom'.

Okay, I've followed your steps. Yes, the list-deleted book goes to the bottom of the list and stays there.

I changed the book's metadata, including setting and clearing the Reading List column to make sure that Calibre and not RL had touched it last. I manually clicked each of the sorts in order (except On Device but including hidden columns Currently reading and On Reading List).

The list-deleted book stayed at the bottom.

As far as I know, that's where it's supposed to be--I'm not taking the time to manually verify 7 sort columns for 14 books--but I will continue anyway.

When I quit and restart Calibre and run 'On Device' view, the list-deleted book is not at the bottom immediately after restart, nor after running 'Default' view and then 'On Device' view again.

However, when I use Calibre's Edit metadata to add a value to the On Reading List column, save it, then remove it and invoke 'On Device' view, the list-deleted book is back at the bottom.

IMO, this absolves the RL plugin. But not necessarily VM.

Next test: I outright removed the VM and RL plugins, restarted Calibre, manually set and then cleared the Reading List column on the same book as before; then manually apply the sort order. The changed book is now at the bottom.

FYI, the default Calibre value for maximum_resort_levels is 5 (which is what I'm testing with).

I don't know whether it's changed or not, but in past, Calibre used to limit sort level to 4 on restart. From an old VM post. And that Calibre would force Date into the sort at least priority anytime it wasn't already included.

VM, as I understand it from the follow on posts, does apply sort depth >5 when configured with more.

TL;DR: I submit that if there's a problem here, it's either in Calibre itself or ownedbycats' expectations.

[ownedbycats]

Yes, the book only is stuck on the bottom for the duration of the current session. Admittedly restarting isn't that much of a problem most of the time, but when I'm running from source that means frequently heading back to the git folder to re-launch the bat file.

I already accounted for maximum_resort_levels; I set it to 12 and that didn't work.

[ownedbycats]

Think this should be sent to the Calibre bugtracker? I'll wait and see if chaley sees this first though before doing that.

For now, I'll just remove #readinglist from my VM sorts, at least until I move to the next stable version (usually I just hit restart to fix things, but running from source just makes it close and not restart).

[chaley]

Originally Posted by ownedbycats

Think this should be sent to the Calibre bugtracker? I'll wait and see if chaley sees this first though before doing that.

Well, this has been fun.

I now understand what is happening. To explain:

• For performance reasons calibre keeps an in-memory copy of the data read from the database.
• When the database is originally loaded into memory, if a custom series is empty then the custom series index is set to empty (None), otherwise it is set to the series index.
• When you sort on a custom series it automatically sorts by the name then the index.
• When you edit a custom series by setting it to empty, the custom series index remains in the in-memory copy of the database.

Putting all this together, when you start calibre all the books without the custom series have an empty index so they sort identically. However, if you change (remove) the custom series that book still has the index so it sorts differently from the other empty books.

I have a fix but I don't trust my comprehension of the affected code. I will commit it, explaining to Kovid why I changed what I did so he can show me any errors of my ways.

[chaley]

Kovid committed an improved version of my changes. They are now in source.

[ownedbycats]

Updated my source. It's fixed. Thank you for looking into that.

[JimmXinu]

Originally Posted by chaley

Well, this has been fun.

Indeed. Many thanks for figuring it out!

[ownedbycats]

And now the fix is in the stable version.

[uli]

I have a bug where the Sync Options 'when syncing' reset to default when switching away from 'Auto populated from books on device'. The setting gets saved even when the window is cancelled.

1. List Type: 'Auto populated from books on device'
2. List Type: Manually or Search
3. Change the default 'when syncing this list' to another option 'e.g. Replaced device with list' (SYNCREPNEW)
4. Switch between lists and the setting will reset.
5. Return to 'Auto populated from books on device' and Cancel

Peaking at settings will be back to "listType": "SYNCNEW" so not a display bug.

Example:
https://imgur.com/a/JQRp74p

[JimmXinu]

I do see this happen too. My instinct is that it's probably an edit check for the auto-pop that is misplaced.

Hopefully I'll have time to look at it today.

[JimmXinu]

New Test Version

- Only force set sync_type as needed. Only expresses when switching lists in config.

I believe this version will solve uli's issue. Hopefully without breaking anything else.

[uli]

Originally Posted by JimmXinu

New Test Version

- Only force set sync_type as needed. Only expresses when switching lists in config.

I believe this version will solve uli's issue. Hopefully without breaking anything else.

Thanks for the fix!

If it doesn't break anything... is it possible for the 'auto populate from device' to run after the other lists have be processed?

I'm using column update, and if a reading list removes a book it'll only get refreshed on a second sync.

[FadedSun]

Many thanks for creating this plugin.
I'm just curious, where do the lists actually "live"? I mean are they stored in metadata.db or are there part of a different file?

[ownedbycats]

Originally Posted by FadedSun

Many thanks for creating this plugin.
I'm just curious, where do the lists actually "live"? I mean are they stored in metadata.db or are there part of a different file?

metadata.db. In the preferences table is a row called namespaced:ReadingListPlugin:settings. The lists are stored as a JSON there:

{
  "SchemaVersion": 1.64,
  "default": "To Be Read",
  "lists": {
    "Remove from Device": {
      "content": [],
      "displayTopMenu": false,
      "listType": "SYNCREM",
      "modifyAction": "TAGADDREMOVE",
      "populateSearch": "",
      "populateType": "POPMANUAL",
      "seriesColumn": "",
      "seriesName": "",
      "sortList": true,
      "syncAuto": true,
      "syncClear": true,
      "syncDevice": "[redacted just in case]",
      "tagsColumn": "#kobocoll",
      "tagsText": "[Remove from Device]"
    },
    "Send to Device": {
      "content": [],
      "displayTopMenu": true,
      "listType": "SYNCALL",
      "modifyAction": "TAGADDREMOVE",
      "populateSearch": "",
      "populateType": "POPMANUAL",
      "seriesColumn": "",
      "seriesName": "",
      "sortList": true,
      "syncAuto": true,
      "syncClear": true,
      "syncDevice": "[redacted just in case]",
      "tagsColumn": "#kobocoll",
      "tagsText": "[Send to Device]"
    },
    "To Be Read": {
      "content": [
        6812,
        6318,
        5785,
        3298,
        6810,
        4713,
        6663,
        5695,
        5231,
        5088,
        4525,
        4980,
        4771,
        4655,
        6069,
        1983,
        3856,
        6712,
        5977,
        703,
        6787,
        3022,
        5075,
        6734,
        2927,
        6807,
        6823,
        3257,
        5679
      ],
      "displayTopMenu": true,
      "listType": "SYNCNEW",
      "modifyAction": "TAGADDREMOVE",
      "populateSearch": "",
      "populateType": "POPMANUAL",
      "seriesColumn": "#readinglist",
      "seriesName": "To Be Read",
      "sortList": true,
      "syncAuto": false,
      "syncClear": false,
      "syncDevice": null,
      "tagsColumn": "#kobocoll",
      "tagsText": "To Be Read"
    }
  }
}

The list of numbers in content are book IDs.

[FadedSun]

Thank you so much ownedbycats !