Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

support more images on single thumb-markdown block #136

Merged
merged 4 commits into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 47 additions & 37 deletions cads_catalogue/layout_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,44 +54,54 @@ def manage_image_section(
new_section = copy.deepcopy(section)
blocks = new_section.get("blocks", [])
for i, block in enumerate(copy.deepcopy(blocks)):
image_dict = block.get("image", {})
image_rel_path = image_dict.get("url")
if block.get("type") == "thumb-markdown" and image_rel_path:
if utils.is_url(image_rel_path):
# nothing to do, the url is already uploaded somewhere
continue
image_abs_path = os.path.join(folder_path, block["image"]["url"])
if os.path.isfile(image_abs_path):
if image_abs_path not in images_stored and not disable_upload:
# process upload to object storage
subpath = os.path.dirname(
os.path.join(
"resources", resource["resource_uid"], image_rel_path
if "image" not in block:
continue
image_dict_list = block["image"]
if isinstance(image_dict_list, dict):
image_dict_list = [image_dict_list]
for j, image_dict in enumerate(image_dict_list):
image_rel_path = image_dict.get("url")
if block.get("type") == "thumb-markdown" and image_rel_path:
if utils.is_url(image_rel_path):
# nothing to do, the url is already uploaded somewhere
continue
image_abs_path = os.path.abspath(
os.path.join(folder_path, image_dict["url"])
)
if os.path.isfile(image_abs_path):
if image_abs_path not in images_stored and not disable_upload:
# process upload to object storage
subpath = f"resources/{resource['resource_uid']}"
image_rel_url = object_storage.store_file(
image_abs_path,
storage_settings.object_storage_url,
bucket_name=storage_settings.catalogue_bucket,
subpath=subpath,
**storage_settings.storage_kws,
)
)
image_rel_url = object_storage.store_file(
image_abs_path,
storage_settings.object_storage_url,
bucket_name=storage_settings.catalogue_bucket,
subpath=subpath,
**storage_settings.storage_kws,
)
# update cache of the upload urls
images_stored[image_abs_path] = urllib.parse.urljoin(
storage_settings.document_storage_url, image_rel_url
)
blocks[i]["image"]["url"] = images_stored.get(image_abs_path, "")
else:
raise ValueError(f"image {image_rel_path} not found")
elif block.get("type") in ("section", "accordion"):
blocks[i] = manage_image_section(
folder_path,
block,
images_stored,
resource,
storage_settings,
disable_upload=disable_upload,
)
# update cache of the upload urls
images_stored[image_abs_path] = urllib.parse.urljoin(
storage_settings.document_storage_url, image_rel_url
)
if isinstance(block["image"], dict):
blocks[i]["image"]["url"] = images_stored.get(
image_abs_path, ""
)
else:
blocks[i]["image"][j]["url"] = images_stored.get(
image_abs_path, ""
)
else:
raise ValueError(f"image {image_rel_path} not found")
elif block.get("type") in ("section", "accordion"):
blocks[i] = manage_image_section(
folder_path,
block,
images_stored,
resource,
storage_settings,
disable_upload=disable_upload,
)
return new_section


Expand Down
47 changes: 44 additions & 3 deletions tests/test_30_layout_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,21 @@ def test_manage_image_section(tmpdir, mocker: pytest_mock.MockerFixture) -> None
"alt": "alternative text",
},
}
multi_images_block = {
"id": "abstract",
"type": "thumb-markdown",
"content": "a content",
"image": [
{
"url": "overview/overview.png",
"alt": "alternative text1",
},
{
"url": "overview/overview2.png",
"alt": "alternative text2",
},
],
}
modified_image_block = {
"id": "abstract",
"type": "thumb-markdown",
Expand All @@ -211,6 +226,21 @@ def test_manage_image_section(tmpdir, mocker: pytest_mock.MockerFixture) -> None
"alt": "alternative text",
},
}
multi_images_block_uploaded = {
"id": "abstract",
"type": "thumb-markdown",
"content": "a content",
"image": [
{
"url": "http://public-storage/an url",
"alt": "alternative text1",
},
{
"url": "http://public-storage/an url",
"alt": "alternative text2",
},
],
}
section = {"id": "overview", "blocks": [no_image_block, image_block]}
images_stored: dict[str, str] = dict()

Expand All @@ -219,7 +249,7 @@ def test_manage_image_section(tmpdir, mocker: pytest_mock.MockerFixture) -> None
layout_manager.manage_image_section(
str(tmpdir), section, images_stored, resource, oss
)
# url is already a link: no change
# url is already uploaded: no change
image_block_already_url = {
"id": "abstract",
"type": "thumb-markdown",
Expand All @@ -241,7 +271,9 @@ def test_manage_image_section(tmpdir, mocker: pytest_mock.MockerFixture) -> None
overview_file_path = os.path.join(overview_path, "overview.png")
with open(overview_file_path, "w") as fp:
fp.write("hello! I am an image")

overview2_file_path = os.path.join(overview_path, "overview2.png")
with open(overview2_file_path, "w") as fp:
fp.write("hello! I am an image2")
# 1 image block
section = {"id": "overview", "blocks": [no_image_block, image_block]}
new_section = layout_manager.manage_image_section(
Expand All @@ -263,7 +295,7 @@ def test_manage_image_section(tmpdir, mocker: pytest_mock.MockerFixture) -> None
)
assert new_section == section

# case section with more image_blocks
# case section with more separeted image blocks
section = {"id": "overview", "blocks": [image_block, no_image_block, image_block]}
new_section = layout_manager.manage_image_section(
str(tmpdir), section, images_stored, resource, oss
Expand Down Expand Up @@ -322,6 +354,15 @@ def test_manage_image_section(tmpdir, mocker: pytest_mock.MockerFixture) -> None
no_image_block,
],
}
# case section with a block with multiple images
section = {"id": "overview", "blocks": [no_image_block, multi_images_block]}
new_section = layout_manager.manage_image_section(
str(tmpdir), section, images_stored, resource, oss
)
assert new_section == {
"id": "overview",
"blocks": [no_image_block, multi_images_block_uploaded],
}


def test_transform_image_blocks(tmpdir, mocker: pytest_mock.MockerFixture) -> None:
Expand Down