[GUI Plugin] Kobo Utilities

[ownedbycats]

currentchap/totalchap will only work for FanFicFare-downloaded stories. For regular books the file-structure varies too much to be reliably detectable with a regex.

program:

	input = $#kobobookmark;
# Don't change this to 'count' as that's a function
	ccount = $$#chaptercount;

	if 
## Checks that a Fanfiction has a Kobo bookmark and is not anthology|oneshot
## If you don't use a booktype-column, change this to check something else like a fandom column.
		$#booktype=='Fanfiction'
		&& 
		substr(input, 0, 10) == 'OEBPS/file'
		&& !$#fanficstatus in 'Anthology,Oneshot'
	then
## Extracts the 'current chapter' from the bookmarks, subtracts 1, and then formats them as 'currentchap/totalchap'
		strcat(format_number(re(input, '.*\/file(\d+).*', '\1') - 1, '{0:,d}'), '/',ccount)

## This will display the regular chapter-count for everything else.
	else
		ccount
	fi

[BookJunkieLI]

Originally Posted by ownedbycats

currentchap/totalchap will only work for FanFicFare-downloaded stories. For regular books the file-structure varies too much to be reliably detectable with a regex.

program:

	input = $#kobobookmark;
# Don't change this to 'count' as that's a function
	ccount = $$#chaptercount;

	if 
## Checks that a Fanfiction has a Kobo bookmark and is not anthology|oneshot
## If you don't use a booktype-column, change this to check something else like a fandom column.
		$#booktype=='Fanfiction'
		&& 
		substr(input, 0, 10) == 'OEBPS/file'
		&& !$#fanficstatus in 'Anthology,Oneshot'
	then
## Extracts the 'current chapter' from the bookmarks, subtracts 1, and then formats them as 'currentchap/totalchap'
		strcat(format_number(re(input, '.*\/file(\d+).*', '\1') - 1, '{0:,d}'), '/',ccount)

## This will display the regular chapter-count for everything else.
	else
		ccount
	fi

Cool. For input = $#kobobookmark; would I use #kobostatus since that's where I'm currently putting the location information?
Although I may change the column name since Status, to me, indicates Unread, Reading, Finished.

And for $#booktype=='Fanfiction' I have a column called #library that is 'Text, but with a set of permitted values' wherein the values are Fanfic, Fiction, Non-Fiction. Would that work?

[ownedbycats]

Originally Posted by BookJunkieLI

Cool. For input = $#kobobookmark; would I use #kobostatus since that's where I'm currently putting the location information?
Although I may change the column name since Status, to me, indicates Unread, Reading, Finished.

And for $#booktype=='Fanfiction' I have a column called #library that is 'Text, but with a set of permitted values' wherein the values are Fanfic, Fiction, Non-Fiction. Would that work?

#kobobookmark is whatever column contains the filename stuff.

#library=='Fanfic' should work, yes. My #booktype is the same column type (enumerated).

You can safely remove the fanficstatus line, but this will result in the template showing the wrong result for FFF anthologies.

[BookJunkieLI]

I think I have one anthology so it shouldn't be an issue.

Works great. Although I apparently have some fics I know I downloaded with FFF that don't have chapter counts. Oh well, fixing metadata is never done. LOL

Thanks for all the help.

[ksignorini]

I'm having trouble getting annotations to download from the Kobo to Calibre. When downloading the annotations file, it shows blank, and when only downloading a single book's annotations, nothing shows up.

However, when using the Annotations plugin (not Kobo Utilities) it works just fine and annotations are downloaded from the reader to Calibre.

Is there some kind of configuration that needs to be done? Is this a known bug with a path to resolution?

Thanks!

(Oh, and I'm using KoboExtended KePubs converted from mobi.)

[Quoth]

Using Kobo Utilities you select an ebook when Kobo connected and select Copy Annotation and it opens a window. You then copy/paste to a text editor (Notepad++ in Windows or WINE, KATE or similar in Linux), and then you can save a file.
The Annotations plugin copies the annotation into Calibre's book record.
I've used the Kobo Utilities method maybe over 1000 times with no issue except once when Kobo database was corrupt. The Kobo Utilities method by default doesn't directly create a file or add the data to Calibre.

[ksignorini]

Originally Posted by Quoth

Using Kobo Utilities you select an ebook when Kobo connected and select Copy Annotation and it opens a window. You then copy/paste to a text editor (Notepad++ in Windows or WINE, KATE or similar in Linux), and then you can save a file.
The Annotations plugin copies the annotation into Calibre's book record.
I've used the Kobo Utilities method maybe over 1000 times with no issue except once when Kobo database was corrupt. The Kobo Utilities method by default doesn't directly create a file or add the data to Calibre.

But when I do that, I get an empty dialog box. There is nothing to copy.

If I use the Annotations plug-in on the same book, I can see it has annotations and get them imported into Calibre.

[HydroGuy]

getting a similiar 403 error referenced a few pages back with a Kobo touch. Calibre 6.23.0 and kobo plugin 2.16.10. Correctly sees the available update but fails on update.
calibre, version 6.23.0 (win32, embedded-python: True)
Failed to update Kobo firmware: Failed: Downloading Kobo firmware update

HTTP Error 403: Forbidden

Traceback (most recent call last):
File "calibre\gui2\device.py", line 104, in run
File "calibre_plugins.koboutilities.jobs", line 123, in do_check_firmware_update
File "urllib\request.py", line 216, in urlopen
File "urllib\request.py", line 525, in open
File "urllib\request.py", line 634, in http_response
File "urllib\request.py", line 563, in error
File "urllib\request.py", line 496, in _call_chain
File "urllib\request.py", line 643, in http_error_default
urllib.error.HTTPError: HTTP Error 403: Forbidden

[bookloverCA]

I recently purchased a Libra 2. I am very glad to find this plug-in. It works quite well. Thanks a lot. I encounter several issues about annotation export. I hope you can help me.

1. Unable to copy/backup annotation for books not sideloaded from Calibre or purchased books:
"Copy Annotations for selected books" and "Back up annotation file" don't show up on "Device" view for any books including books sideloaded from Calibre. The only option I have is "Remove annotation file". Those two options show up on "Calibre Library" view.

Since books sideloaded by other means and purchased books are not on "Calibre Library" view, I cannot export annotations.

2. "Copy annotation file" doesn't work
After I selected a folder and clicked OK, I didn't see any file being saved. Here is the dialog after I clicked OK.

3. The annotation seems to get the "chapter" numbers wrong. It seems that it counts entries in the TOC after "cover" as chapter numbers. For example, in the screenshot below, "Introduction" is as "Chapter 6", and "The Limits of Consciousness" as "Chapter 13". They are actually under chapters 1 and 2 in the TOC. There are 7 (13-6) entries (sub-chapters) in the TOC between those two highlights.

Thanks again for your help.

[Majutsushi]

I'm getting this exception when syncing reading positions:

calibre, version 6.24.0 (linux, embedded-python: False)
Failed to get reading positions: Failed: Storing reading positions for 1330 books

[Errno 11] write could not complete without blocking

Traceback (most recent call last):
  File "/usr/lib/calibre/calibre/gui2/device.py", line 104, in run
    self.result = self.func(*self.args, **self.kwargs)
                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "calibre_plugins.koboutilities.jobs", line 355, in do_store_locations
    debug_print(job.details)
  File "calibre_plugins.koboutilities.jobs", line 44, in debug_print
    prints('DEBUG: %6.1f'%(time.time()-BASE_TIME), *args)
  File "/usr/lib/calibre/calibre/prints.py", line 39, in prints
    stream.write(x)
BlockingIOError: [Errno 11] write could not complete without blocking

This is caused by excessive debug output overwhelming the output buffer. Setting "JOBS_DEBUG = False" in "jobs.py" works around it. It's probably not a good idea to enable debug logging by default anyway, especially since it's cluttering my log files.

[DNSB]

Originally Posted by Majutsushi

This is caused by excessive debug output overwhelming the output buffer. Setting "JOBS_DEBUG = False" in "jobs.py" works around it. It's probably not a good idea to enable debug logging by default anyway, especially since it's cluttering my log files.

I'd tend to suspect that @chaley enabled debug logging while working on the plugin and forget to turn it off for the release version. It's happened before, often when the person working on the plugin was not the original author and will likely happen again.

[chaley]

Originally Posted by DNSB

I'd tend to suspect that @chaley enabled debug logging while working on the plugin and forget to turn it off for the release version. It's happened before, often when the person working on the plugin was not the original author and will likely happen again.

Wasn't me. @davidfor tended to leave debugging on, depending on calibre usually running without debugging to avoid the output problems. I understand the position, because without it debugging user reported problems is very hard.

[DNSB]

Originally Posted by chaley

Wasn't me. @davidfor tended to leave debugging on, depending on calibre usually running without debugging to avoid the output problems. I understand the position, because without it debugging user reported problems is very hard.

I remember that. On one occasion during one of the Kobo betas, it caused some rather massive logs.

[Majutsushi]

Originally Posted by DNSB

I remember that. On one occasion during one of the Kobo betas, it caused some rather massive logs.

Yeah, it's certainly pretty verbose, hence this issue. I noticed that the plugin also imports a "DEBUG" variable from "calibre.constants", although I'm not sure where you would set that. Maybe the plugin should have an "enable debug logging" option rather than always enabling it. There should also be a way to log in a way to doesn't cause this issue. I just hope that I won't have to manually edit the plugin after every update.

[kovidgoyal]

That error indicates STDOUT in whatever environment you are running calibre in is non-blocking. This is not normal. Find out why that is and fix it and you will be fine. Or redirect STDOUT and STDERR to /dev/null when launching calibre.