HTML Image to Attachment

This module provides functionality to convert images from HTML fields to attachments. It can process both base64-encoded images and external image URLs, making them accessible as Odoo attachments and updating the HTML content accordingly.

Key features include:

• Automatic conversion of external images and base64-encoded images to attachments
• Configurable task system to process specific models and fields
• Marking of attachments for tracking and management
• Cleaning of unused image attachments
• Support for both batch processing and individual record processing

Configuration

Setting up the module is straightforward:

1. Go to Settings -> Technical -> HTML Image to Attachment
2. Create a new task by specifying:
   • Name: Task identifier
   • Model: Target model containing HTML fields
   • HTML Field: Target field containing images to process
3. Click "Create Lines" to generate processing lines
4. Use "Execute" button to process individual lines or "Execute All" for batch processing

Integration Guide

1. Inheriting the Mixin

To add image processing to your model:

# models/my_model.py
from odoo import models, fields

class MyModel(models.Model):
    _name = 'my.model'
    _inherit = ['mail.thread', 'kw.html.image2attachment.mixin']
    
    name = fields.Char()
    description = fields.Html()  # HTML field that will be processed
    other_html_field = fields.Html()  # Another HTML field
    
    # Optional: Override html_fields to specify which fields to process
    @property
    def html_fields(self):
        return ['description', 'other_html_field']

2. Migration Script

To process existing records during module upgrade, create a migration script:

# migrations/16.0.1.1.0/post-migrate.py
from odoo import api, SUPERUSER_ID

def migrate(cr, version):
    if not version:
        return
        
    env = api.Environment(cr, SUPERUSER_ID, {})
    
    # Get all models that inherit kw.html.image2attachment.mixin
    IrModel = env['ir.model']
    models = IrModel.search([
        ('inherited_model_ids.model', '=', 'kw.html.image2attachment.mixin')
    ])
    
    # Process each model
    tool = env['kw.html_image2attachment.tool']
    for model in models:
        if not model.model in env:
            continue
            
        Model = env[model.model]
        records = Model.search([])
        
        # Mark attachments for each record
        for record in records:
            tool.mark_attachments(record)
            
        # Commit after each model to avoid long transactions
        env.cr.commit()

3. Directory Structure

Your module should have this structure:

my_module/
├── __init__.py
├── __manifest__.py
├── models/
│   ├── __init__.py
│   └── my_model.py
└── migrations/
    └── 16.0.1.1.0/
        └── post-migrate.py

4. Manifest Dependencies

Add the dependency in your module's manifest:

# __manifest__.py
{
    'name': 'My Module',
    'version': '16.0.1.1.0',
    'depends': [
        'base',
        'kw_html_image2attachment',
    ],
    # ...
}

Bug Tracker

Bugs are tracked on https://kitworks.systems/requests. In case of trouble, please check there if your issue has already been reported.

Maintainer

KitWorks Systems. Our web site: https://kitworks.systems

We can provide you further Odoo Support, Odoo implementation, Odoo customization, Odoo 3rd Party development and integration software, consulting services. Our main goal is to provide the best quality product for you.

For any questions contact us.