This module is a technical module with the purpose of easing the export of image thumbnails to a search engine index.
It extends the functionality of the connector_search_engine module
by adding specialized methods that can be used to get and generate
thumbnails from an image you want to index.
Important
This is an alpha version, the data model and design can change at any time without warning. Only for development or testing purpose, do not use in production. More details on development status
Table of contents
When you export images to an index, you may want to ensure that the images are exported in a format and size that is suitable for the application that will consume the index.
This module depends on the
fs_image_thumdbnail
module. This last one provides a method and a mixin used to generate
thumbnails from a FSImageValue object.
If you want to force the format of the generated thumbnail, you define a
a configuration parameter into Odoo with the key
fs_image_thumbnail.resize_format and the value PNG or JPEG or GIF or
ICO. Otherwise, the format of the generated thumbnail will be the same
as the format of the original image.
As specified, this module will not add any new features by itself once installed. As a developer, you can depend on this module to benefit from a set of specialized methods that can be used to get and generate thumbnails from an image you want to index.
Behind the scenes, this module extend the se.indexable.recor model
by adding 2 new methods:
_get_or_create_thumbnails_for_multi_images: This method is used to get or create thumbnails for a set of images._get_or_create_thumbnails_for_image: This method is used to get or create thumbnails for a single image.
Thanks to these methods, you can easily generate thumbnails for images stored into odoo through three different ways:
- A relational field referencing record inheriting from
fs.image.relation.mixin. - An odoo's Image field.
- An FSImage field.
The sizes of the thumbnails generated by these methods are configured
through the creation of a new record into the se.thumbnail.size
model. This model allows you to define the size of thumbnails by search
engine backend, model and field. For example, you can define that you
want to generate thumbnails of size 100x100 for all the images
stored into the product.template model and the image field when
you export them to the opensearch_xyz backend. In this way, you can
easily define different thumbnail sizes for different search engine
backends, models and fields according to your needs.
Thumbnails are always retrieved and generated for one image and a
specific base_name. The base name is used as a key to identify the
thumbnails from an image related to a usage and also as base name for
the file name of the thumbnails generated. By default, the base_name
is computed from the display name of the record that contains the image
to ensure a good SEO. To avoid problems with special characters, the
base_name is normalized before being used.
Here is an example of how to use these methods:
from odoo import models, fields
from odoo.addons.fs_imeage.fields import FSImage
class ProductImageRelation(models.Model):
_name = "product.image.relation"
_inherit = ["fs.image.relation.mixin"]
name = fields.Char(required=True)
product_id = fields.Many2one(
"product.product",
required=True,
ondelete="cascade",
)
class ProductProduct(models.Model):
_name = "product.product"
_inherit = ["se.indexable.record", "product.product"]
name = fields.Char(required=True)
image = fields.Image(required=True)
image_ids = fields.One2many(
"product.image.relation",
"product_id",
string="Images",
)
fs_image = FSImage(required=True)
# A creation is always done for a given se.index record.
index = self.env["se.index"].browse(1)
product = self.env["product.product"].browse(1)
# Get or create thumbnails for a single image
for (thumbnail_size, thumbnail) in product._get_or_create_thumbnails_for_image(
index,
field_name="image",
):
# Do something with the thumbnail
print(f"Thumbnail for image with size {thumbnail_size.display_name} "
"is available at url {thumbnail.image.url}")
# Get or create thumbnails for a single image
for (thumbnail_size, thumbnail) in product._get_or_create_thumbnails_for_image(
index,
field_name="fs_image",
):
# Do something with the thumbnail
print(f"Thumbnail for fs_image with size {thumbnail_size.display_name} "
"is available at url {thumbnail.image.url}")
# Get or create thumbnails for a set of images
thumbnails_by_image = product._get_or_create_thumbnails_for_multi_images(
index,
field_name="image_ids",
)
for (image, thumbnails) in thumbnails_by_image.items():
for (thumbnail_size, thumbnail) in thumbnails:
# Do something with the thumbnail
print(f"Thumbnail for image {image.name} with size "
"{thumbnail_size.display_name} is available at url "
"{thumbnail.image.url}")- Add new config parameter on the search engine backend to allow the user to specify if the serialization of a record should fail if thumbnails are requested but no thumbnail sizes are defined for the model and field for which it' requested. Defaults to False (i.e. don't fail). (#176)
Fixes image sizes lookups.
When serializing a record and generating thumbnails, the thumbnail sizes are looked up on the index. Prior to this change, only sizes defined for the model associated with the current index were looked up. This means that if you tried to serialize a nested record that had an image field that was defined on a different model, the thumbnail size was not found and an error was thrown. The lookup method takes now the record for which the thumbnail is being generated as an argument, so that the correct model can be used to look up the thumbnail size. You still need to define the thumbnail sizes for each model serialized in the index.
Fixes UI error when creating a new thumbnail size.
When creating a new record, the UI was throwing an error. This was due to the computations of the domain to apply to restrict the choices of the possible image fields. When the record is new, no model is set, so the domain for the field must be empty. This is now handled correctly. (#174)
Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.
Do not contact contributors directly about support or help with technical issues.
- ACSONE SA/NV
- Laurent Mignon [email protected] (https://www.acsone.eu/)
- Mohamed Alkobrosli [email protected] (https://www.kobros-tech.com/)
The development of this module has been financially supported by:
This module is maintained by the OCA.
OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.
Current maintainer:
This module is part of the OCA/search-engine project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.