[GUI Plugin] Reading List

[theducks]

Originally Posted by JimmXinu

Attached is a version I think is ready for release, if some kind mod would oblige.

Version 1.6.13 - 27 Aug 2020
- Don't restrict search for auto-populated from search lists to current Virtual Library.
- Fix for moving books from list to same list, from davidfor

(I'm shelving for the time being the idea of date custom columns.)

Moderator Notice
done it for you

[Gandulf]

Reading form another tread, is it possible to generate a text file or something to send at the same time you sync to device?

[thegameksk]

I have a new phone. I erased the old folder from my sd card and put SD into phone. Calibre sees my phone but when I hit sync now nothing happens or it gets stuck on waiting for calibre on my phone.

[Gandulf]

Originally Posted by thegameksk

I have a new phone. I erased the old folder from my sd card and put SD into phone. Calibre sees my phone but when I hit sync now nothing happens or it gets stuck on waiting for calibre on my phone.

Use CC.

[thegameksk]

Originally Posted by Gandulf

Use CC.

Its working now. Not sure what the issue was before with CC.

[JimmXinu]

Originally Posted by Gandulf

Reading form another tread, is it possible to generate a text file or something to send at the same time you sync to device?

Reading List plugin doesn't have any feature to do that.

[Gandulf]

Originally Posted by JimmXinu

Reading List plugin doesn't have any feature to do that.

Thanks noticed that, but in next version is it possible to add something like that?

[davidfor]

Originally Posted by Gandulf

Thanks noticed that, but in next version is it possible to add something like that?

It might be a good idea to state what you actually want. At the moment, it sounds like you want a text file with random text in it sent to the the device at the same time the books are sent.

[JSWolf]

Originally Posted by Gandulf

Reading form another tread, is it possible to generate a text file or something to send at the same time you sync to device?

What is the purpose of this text file?

[Gandulf]

In the other thread he wanted to find a way for kindle to show the books in series order, was suggested that he send a text file with the read order, so...

Was thinking that the reading list plugin let's you arange books in order and then sends them to your device, is it not possible that the plugin create a text file of the books it sends in the order the books are placed in the list and then send that same file with the books. That way if you reading a 8 book series you can just refer to the text file and read the books in the correct order.

[JimmXinu]

Personally, I use Calibre's metadata plugboards feature to prepend the series to the title when sent to device. Look at the first example in the Techniques to use plugboards... thread.

Adding a list file via Reading List sounds less useful and more complex, both in design and for the user.

I'd need a much stronger use case to consider adding this. Especially since I'm just maintaining this plugin, I didn't create it.

[Gandulf]

Thanks was just curious.

[compurandom]

I have Reading List 1.19.11 installed.

I have a reading list that is
* autopopulated from books on device
* update column for add to list only
* column to update: tags

When this syncs with the device and the book isn't on the device, it deletes the tag even though it is set to "add to list only".

Is this how it is suppose to work?

[JimmXinu]

I dunno--you're using features I've never used and I didn't write it, so...

The relevant block of code appears to be:

Spoiler:

    def _rebuild_auto_device_list(self, db, list_name, on_device_ids):
        if DEBUG:
            prints('READING LIST: Auto-populating device list: ', list_name)
        existing_book_ids = set(cfg.get_book_list(db, list_name))
        ids_to_remove = list(existing_book_ids - on_device_ids)
        ids_to_add = list(on_device_ids - existing_book_ids)
        if DEBUG:
            prints('READING LIST: Removing %d ids from automatic list: %s' % (len(ids_to_remove), list_name))
        self.apply_tags_to_list(list_name, ids_to_remove, add=False, modify_action='TAGADDREMOVE')
        if DEBUG:
            prints('READING LIST: Adding %d ids to automatic list: %s' % (len(ids_to_add), list_name))
        # We will force the apply of tags to ALL items on the list, just in case the user
        # has only just specified a tag.
        self.apply_tags_to_list(list_name, list(on_device_ids), add=True, modify_action='TAGADDREMOVE')
        cfg.set_book_list(db, list_name, list(on_device_ids))
        ids_to_remove.extend(ids_to_add)
        return ids_to_remove

The code is explicitly ignoring the list's setting for modify_action when it's an auto-populated list.

That's the only place in the RL code that the apply_tags_to_list(...,modify_action=...) parameter is used, which suggests it was deliberate? (Interestingly, search populated lists explicitly disable updating column/tags from list.)

I think it would do what you want if the modify_action='TAGADDREMOVE' parameters are removed.

Attached is a version with that change. I haven't tested it -- use at your own risk and test it first.

[davidfor]

Originally Posted by JimmXinu

I dunno--you're using features I've never used and I didn't write it, so...

The relevant block of code appears to be:

Spoiler:

    def _rebuild_auto_device_list(self, db, list_name, on_device_ids):
        if DEBUG:
            prints('READING LIST: Auto-populating device list: ', list_name)
        existing_book_ids = set(cfg.get_book_list(db, list_name))
        ids_to_remove = list(existing_book_ids - on_device_ids)
        ids_to_add = list(on_device_ids - existing_book_ids)
        if DEBUG:
            prints('READING LIST: Removing %d ids from automatic list: %s' % (len(ids_to_remove), list_name))
        self.apply_tags_to_list(list_name, ids_to_remove, add=False, modify_action='TAGADDREMOVE')
        if DEBUG:
            prints('READING LIST: Adding %d ids to automatic list: %s' % (len(ids_to_add), list_name))
        # We will force the apply of tags to ALL items on the list, just in case the user
        # has only just specified a tag.
        self.apply_tags_to_list(list_name, list(on_device_ids), add=True, modify_action='TAGADDREMOVE')
        cfg.set_book_list(db, list_name, list(on_device_ids))
        ids_to_remove.extend(ids_to_add)
        return ids_to_remove

The code is explicitly ignoring the list's setting for modify_action when it's an auto-populated list.

That's the only place in the RL code that the apply_tags_to_list(...,modify_action=...) parameter is used, which suggests it was deliberate? (Interestingly, search populated lists explicitly disable updating column/tags from list.)

I think it would do what you want if the modify_action='TAGADDREMOVE' parameters are removed.

Attached is a version with that change. I haven't tested it -- use at your own risk and test it first.

To me that is very deliberate. The purpose of that type of list is to be able to see what books are on the device when it is not actually connected. Removing the book from the list, but, not removing the column value would be confusing. The point of setting the column is to have a way to search for the books that are on the device when the device is not connected. If you don't remove the value, you break that rule and it will almost definitely break searches people are using.