Edit Book: Check Book: Add a check for missing navigation documents in EPUB 3 books

This commit is contained in:
Kovid Goyal 2016-06-23 06:33:39 +05:30
parent 56a8b58046
commit 3a555b4959

View File

@ -10,6 +10,7 @@ from lxml import etree
from calibre import prepare_string_for_xml as xml from calibre import prepare_string_for_xml as xml
from calibre.ebooks.oeb.polish.check.base import BaseError, WARN from calibre.ebooks.oeb.polish.check.base import BaseError, WARN
from calibre.ebooks.oeb.polish.toc import find_existing_nav_toc
from calibre.ebooks.oeb.polish.utils import guess_type from calibre.ebooks.oeb.polish.utils import guess_type
from calibre.ebooks.oeb.base import OPF, OPF2_NS, DC, DC11_NS, XHTML_MIME from calibre.ebooks.oeb.base import OPF, OPF2_NS, DC, DC11_NS, XHTML_MIME
@ -100,6 +101,15 @@ class MissingNCXRef(BaseError):
container.dirty(container.opf_name) container.dirty(container.opf_name)
return changed return changed
class MissingNav(BaseError):
HELP = _('This book has no Navigation document. According to the EPUB 3 specification, a navigation document'
' is required. The Navigation document contains the Table of Contents. Use the Table of Contents'
' tool to add a Table of Contents to this book.')
def __init__(self, name, lnum):
BaseError.__init__(self, _('Missing navigation document'), name, lnum)
class MissingHref(BaseError): class MissingHref(BaseError):
HELP = _('A file listed in the manifest is missing, you should either remove' HELP = _('A file listed in the manifest is missing, you should either remove'
@ -230,6 +240,7 @@ class BadSpineMime(BaseError):
def check_opf(container): def check_opf(container):
errors = [] errors = []
opf_version = container.opf_version_parsed
if container.opf.tag != OPF('package'): if container.opf.tag != OPF('package'):
err = BaseError(_('The OPF does not have the correct root element'), container.opf_name, container.opf.sourceline) err = BaseError(_('The OPF does not have the correct root element'), container.opf_name, container.opf.sourceline)
@ -306,6 +317,10 @@ def check_opf(container):
if ncx_id: if ncx_id:
errors.append(MissingNCXRef(container.opf_name, spine.sourceline, ncx_id)) errors.append(MissingNCXRef(container.opf_name, spine.sourceline, ncx_id))
if opf_version.major > 2:
if find_existing_nav_toc(container) is None:
errors.append(MissingNav(container.opf_name, 0))
covers = container.opf_xpath('/opf:package/opf:metadata/opf:meta[@name="cover"]') covers = container.opf_xpath('/opf:package/opf:metadata/opf:meta[@name="cover"]')
if len(covers) > 0: if len(covers) > 0:
if len(covers) > 1: if len(covers) > 1: