def build_html_chapter_file(published_object, versioned_object, working_dir,
root_dir):
"""
Parses the full html file, extracts the ``<hX>`` tags and splits their content into new files.
Yields all the produced files.
:param root_dir: the root directory into which dump the ebook
:type root_dir: pathlib.Path
:param working_dir:
:type working_dir: pathlib.Path
:param versioned_object: the object representing the public version in git file system
:type versioned_object: zds.tutorialv2.models.models_versioned.VersionedContent
:param published_object: the published content as saved in database
:type published_object: zds.tutorialv2.models.models_database.PublishedContent
:return: a generator of tuples composed as ``[splitted_html_file_relative_path, chapter-identifier, chapter-title]``
"""
DirTuple = namedtuple('DirTuple', ['absolute', 'relative'])
img_dir = working_dir.parent / 'images'
path_to_title_dict = publish_container(
published_object,
str(working_dir),
versioned_object,
template='tutorialv2/export/ebook/chapter.html',
file_ext='xhtml',
image_callback=handle_images,
image_directory=DirTuple(str(img_dir.absolute()),
str(img_dir.relative_to(root_dir))),
relative='.')
for container_path, title in path_to_title_dict.items():
# TODO: check if a function exists in the std lib to get rid of `root_dir + '/'`
yield container_path.replace(str(root_dir.absolute()) + '/',
''), 'chapter-' + slugify(title), title
def build_html_chapter_file(published_object, versioned_object, working_dir, root_dir):
"""
Parses the full html file, extracts the ``<hX>`` tags and splits their content into new files.
Yields all the produced files.
:param root_dir: the root directory into which dump the ebook
:type root_dir: pathlib.Path
:param working_dir:
:type working_dir: pathlib.Path
:param versioned_object: the object representing the public version in git file system
:type versioned_object: zds.tutorialv2.models.models_versioned.VersionedContent
:param published_object: the published content as saved in database
:type published_object: zds.tutorialv2.models.models_database.PublishedContent
:return: a generator of tuples composed as ``[splitted_html_file_relative_path, chapter-identifier, chapter-title]``
"""
DirTuple = namedtuple('DirTuple', ['absolute', 'relative'])
img_dir = working_dir.parent / 'images'
path_to_title_dict = publish_container(published_object, str(working_dir), versioned_object,
template='tutorialv2/export/ebook/chapter.html',
file_ext='xhtml', image_callback=handle_images,
image_directory=DirTuple(str(img_dir.absolute()),
str(img_dir.relative_to(root_dir))),
relative='.')
for container_path, title in path_to_title_dict.items():
# TODO: check if a function exists in the std lib to get rid of `root_dir + '/'`
yield container_path.replace(str(root_dir.absolute()) + '/', ''), 'chapter-' + slugify(title), title
def publish_content(db_object, versioned, is_major_update=True):
"""
Publish a given content.
.. note::
create a manifest.json without the introduction and conclusion if not needed. Also remove the 'text' field
of extracts.
:param db_object: Database representation of the content
:type db_object: zds.tutorialv2.models.database.PublishableContent
:param versioned: version of the content to publish
:type versioned: zds.tutorialv2.models.versioned.VersionedContent
:param is_major_update: if set to `True`, will update the publication date
:type is_major_update: bool
:raise FailureDuringPublication: if something goes wrong
:return: the published representation
:rtype: zds.tutorialv2.models.database.PublishedContent
"""
from zds.tutorialv2.models.database import PublishedContent
if is_major_update:
versioned.pubdate = datetime.now()
# First write the files to a temporary directory: if anything goes wrong,
# the last published version is not impacted !
tmp_path = path.join(settings.ZDS_APP["content"]["repo_public_path"], versioned.slug + "__building")
if path.exists(tmp_path):
shutil.rmtree(tmp_path) # remove previous attempt, if any
# render HTML:
altered_version = copy.deepcopy(versioned)
publish_container(db_object, tmp_path, altered_version)
altered_version.dump_json(path.join(tmp_path, "manifest.json"))
# make room for 'extra contents'
build_extra_contents_path = path.join(tmp_path, settings.ZDS_APP["content"]["extra_contents_dirname"])
makedirs(build_extra_contents_path)
base_name = path.join(build_extra_contents_path, versioned.slug)
# 1. markdown file (base for the others) :
# If we come from a command line, we need to activate i18n, to have the date in the french language.
cur_language = translation.get_language()
altered_version.pubdate = datetime.now()
md_file_path = base_name + ".md"
with contextlib.suppress(OSError):
Path(Path(md_file_path).parent, "images").mkdir()
is_update = False
if db_object.public_version:
is_update, public_version = update_existing_publication(db_object, versioned)
else:
public_version = PublishedContent()
# make the new public version
public_version.content_public_slug = versioned.slug
public_version.content_type = versioned.type
public_version.content_pk = db_object.pk
public_version.content = db_object
public_version.must_reindex = True
public_version.save()
with contextlib.suppress(FileExistsError):
makedirs(public_version.get_extra_contents_directory())
PublicatorRegistry.get("md").publish(md_file_path, base_name, versioned=versioned, cur_language=cur_language)
public_version.char_count = public_version.get_char_count(md_file_path)
if is_major_update or not is_update:
public_version.publication_date = datetime.now()
elif is_update:
public_version.update_date = datetime.now()
public_version.sha_public = versioned.current_version
public_version.save()
with contextlib.suppress(OSError):
make_zip_file(public_version)
public_version.save(update_fields=["char_count", "publication_date", "update_date", "sha_public"])
public_version.authors.clear()
for author in db_object.authors.all():
public_version.authors.add(author)
# this puts the manifest.json and base json file on the prod path.
shutil.rmtree(public_version.get_prod_path(), ignore_errors=True)
shutil.copytree(tmp_path, public_version.get_prod_path())
if settings.ZDS_APP["content"]["extra_content_generation_policy"] == "SYNC":
# ok, now we can really publish the thing!
generate_external_content(base_name, build_extra_contents_path, md_file_path)
elif settings.ZDS_APP["content"]["extra_content_generation_policy"] == "WATCHDOG":
PublicatorRegistry.get("watchdog").publish(md_file_path, base_name, silently_pass=False)
db_object.sha_public = versioned.current_version
return public_version
def publish_content(db_object, versioned, is_major_update=True):
"""
Publish a given content.
.. note::
create a manifest.json without the introduction and conclusion if not needed. Also remove the 'text' field
of extracts.
:param db_object: Database representation of the content
:type db_object: zds.tutorialv2.models.database.PublishableContent
:param versioned: version of the content to publish
:type versioned: zds.tutorialv2.models.versioned.VersionedContent
:param is_major_update: if set to `True`, will update the publication date
:type is_major_update: bool
:raise FailureDuringPublication: if something goes wrong
:return: the published representation
:rtype: zds.tutorialv2.models.database.PublishedContent
"""
from zds.tutorialv2.models.database import PublishedContent
if is_major_update:
versioned.pubdate = datetime.now()
# First write the files to a temporary directory: if anything goes wrong,
# the last published version is not impacted !
tmp_path = path.join(settings.ZDS_APP['content']['repo_public_path'], versioned.slug + '__building')
if path.exists(tmp_path):
shutil.rmtree(tmp_path) # remove previous attempt, if any
# render HTML:
altered_version = copy.deepcopy(versioned)
publish_container(db_object, tmp_path, altered_version)
altered_version.dump_json(path.join(tmp_path, 'manifest.json'))
# make room for 'extra contents'
build_extra_contents_path = path.join(tmp_path, settings.ZDS_APP['content']['extra_contents_dirname'])
makedirs(build_extra_contents_path)
base_name = path.join(build_extra_contents_path, versioned.slug)
# 1. markdown file (base for the others) :
# If we come from a command line, we need to activate i18n, to have the date in the french language.
cur_language = translation.get_language()
altered_version.pubdate = datetime.now()
md_file_path = base_name + '.md'
with contextlib.suppress(OSError):
Path(Path(md_file_path).parent, 'images').mkdir()
is_update = False
if db_object.public_version:
is_update, public_version = update_existing_publication(db_object, versioned)
else:
public_version = PublishedContent()
# make the new public version
public_version.content_public_slug = versioned.slug
public_version.content_type = versioned.type
public_version.content_pk = db_object.pk
public_version.content = db_object
public_version.must_reindex = True
public_version.save()
with contextlib.suppress(FileExistsError):
makedirs(public_version.get_extra_contents_directory())
PublicatorRegistry.get('md').publish(md_file_path, base_name, versioned=versioned, cur_language=cur_language)
public_version.char_count = public_version.get_char_count(md_file_path)
if is_major_update or not is_update:
public_version.publication_date = datetime.now()
elif is_update:
public_version.update_date = datetime.now()
public_version.sha_public = versioned.current_version
public_version.save()
with contextlib.suppress(OSError):
make_zip_file(public_version)
public_version.save(
update_fields=['char_count', 'publication_date', 'update_date', 'sha_public'])
public_version.authors.clear()
for author in db_object.authors.all():
public_version.authors.add(author)
# this puts the manifest.json and base json file on the prod path.
shutil.rmtree(public_version.get_prod_path(), ignore_errors=True)
shutil.copytree(tmp_path, public_version.get_prod_path())
if settings.ZDS_APP['content']['extra_content_generation_policy'] == 'SYNC':
# ok, now we can really publish the thing!
generate_external_content(base_name, build_extra_contents_path, md_file_path)
elif settings.ZDS_APP['content']['extra_content_generation_policy'] == 'WATCHDOG':
PublicatorRegistry.get('watchdog').publish(md_file_path, base_name, silently_pass=False)
db_object.sha_public = versioned.current_version
return public_version