ProductOpener::Images - adds, processes, manages and displays product photos
ProductOpener::Images is used to: - upload product images - select and crop product images - run OCR on images - display product images
Product images are stored in html/images/products/[product barcode split with slashes]/
For each product, this directory contains:
Original images uploaded by users or imported
Same image saved as JPEG with specific settings, and after some minimal processing (auto orientation, removing EXIF data, flattening PNG images to remove transparency).
Those images are not displayed on the web site (except on the product edit form), but can be selected and cropped.
Same image saved with a maximum width and height of 100 and 400 pixels. Those thumbnails are used in the product edit form to show the available images.
OCR output from Google Cloud Vision.
When a new image is uploaded,
a symbolic link to it is created in /new_images.
This triggers a script to generate and save the OCR: run_cloud_vision_ocr.pl.
Cropped and selected image for the front of the product, the ingredients list, the nutrition facts table, and the packaging information / recycling instructions, in 4 different sizes (full size, 100 / 200 / 400 pixels maximum width or height).
The product revision is a number that is incremented for each change to the product (each image upload and each image selection are also individual changes that create a new revision).
The selected images are shown on the website, in the app etc.
When a new image is selected for a given field (e.g. ingredients) and language (e.g. French), the existing selected images are kept. (e.g. we can have ingredients_fr.21.100.jpg and a new ingredients_fr.28.100.jpg).
Previously selected images are shown only when people access old product revisions.
Cropping coordinates for all revisions are stored in the "images" field of the product, so we could regenerate old selected and cropped images on demand.
gif, jpeg, jpf, png, heic
This function is used to guess if an image is the front of the product, its list of ingredients, or the nutrition facts table, based on the filename.
It is used in particular for bulk upload of photos sent by manufacturers. The file names have many different formats, but they very often include the barcode of the product, and sometimes an indication of what the image is.
Producers are advised to use the [front|ingredients|nutrition|packaging]_[language code] format, but in practice we receive many other names.
The %file_names_to_imagefield_regexps structure below contains some patterns used to guess what the image is about.
Process an image uploaded to a product (from the web site, from the API, or from an import):
- Read the image - Create a JPEG version - Create resized versions - Store the image in the product data
Indicates what the image is and its language, or indicate a path to the image file (for imports and when uploading an image with a barcode)
Format: [front|ingredients|nutrition|packaging|other]_[2 letter language code]
Used to return the number identifying the image to the caller.
Used to return some debug information to the caller.
Perform OCR for a specific image (either a source image, or a selected image) and return the results.
OCR can be performed with a locally installed Tesseract, or through Google Cloud Vision.
In the case of Google Cloud Vision, we also store the results of the OCR as a JSON file (requested through HTTP by Robotoff).
Either a number like 1, 2 etc. to perform the OCR on a source image (1.jpg, 2.jpg) or a field name in the form of [front|ingredients|nutrition|packaging]_[2 letter language code].
If $id is a field name, the last selected image for that field is used.
Either "tesseract" or "google_cloud_vision"
A hash reference to store the results.
Call to Google Cloud vision API
This determine which detection will be performed. Remember each feature is a cost.
@CLOUD_VISION_FEATURES_FULL and @CLOUD_VISION_FEATURES_TEXT are two constant you can use.
A file where we write additional logs, specific to the service.
Return JSON content of the response.