[18.0][attachment_preview] Add Office format preview via LibreOffice conversion#603
Open
dnplkndll wants to merge 3 commits into
Open
[18.0][attachment_preview] Add Office format preview via LibreOffice conversion#603dnplkndll wants to merge 3 commits into
dnplkndll wants to merge 3 commits into
Conversation
dnplkndll
added a commit
to ledoent/knowledge
that referenced
this pull request
Mar 30, 2026
…ffice Extends attachment_preview to support DOCX, XLSX, PPTX, DOC, XLS, PPT, and ODG in addition to the existing PDF + ODF format support. New endpoint: GET /attachment_preview/office_to_pdf Accepts ?model=<model>&field=<field>&id=<id>&filename=<name> Converts the binary field content to PDF using LibreOffice headless, then streams the PDF to ViewerJS for in-browser rendering. Returns HTTP 503 gracefully if LibreOffice is not installed. Changes: - controllers/main.py: new HTTP controller with LibreOffice conversion - utils.esm.js: OFFICE_EXTENSIONS added to canPreview(); getUrl() routes Office files to the conversion endpoint - binary_field.esm.js: passes filename for correct extension detection - tests: controller unit tests covering success, FileNotFoundError, TimeoutExpired, and non-zero exit code paths Closes OCA#603
dnplkndll
force-pushed
the
18.0-add-office-preview
branch
from
8702c2f to
d9a4a06
Compare
dnplkndll
added a commit
to ledoent/knowledge
that referenced
this pull request
Jun 19, 2026
…ffice Extends attachment_preview to support DOCX, XLSX, PPTX, DOC, XLS, PPT, and ODG in addition to the existing PDF + ODF format support. New endpoint: GET /attachment_preview/office_to_pdf Accepts ?model=<model>&field=<field>&id=<id>&filename=<name> Converts the binary field content to PDF using LibreOffice headless, then streams the PDF to ViewerJS for in-browser rendering. Returns HTTP 503 gracefully if LibreOffice is not installed. Changes: - controllers/main.py: new HTTP controller with LibreOffice conversion - utils.esm.js: OFFICE_EXTENSIONS added to canPreview(); getUrl() routes Office files to the conversion endpoint - binary_field.esm.js: passes filename for correct extension detection - tests: controller unit tests covering success, FileNotFoundError, TimeoutExpired, and non-zero exit code paths Closes OCA#603
dnplkndll
force-pushed
the
18.0-add-office-preview
branch
from
d9a4a06 to
375b593
Compare
dnplkndll
added a commit
to ledoent/knowledge
that referenced
this pull request
Jun 19, 2026
…ffice Extends attachment_preview to support DOCX, XLSX, PPTX, DOC, XLS, PPT, and ODG in addition to the existing PDF + ODF format support. New endpoint: GET /attachment_preview/office_to_pdf Accepts ?model=<model>&field=<field>&id=<id>&filename=<name> Converts the binary field content to PDF using LibreOffice headless, then streams the PDF to ViewerJS for in-browser rendering. Returns HTTP 503 gracefully if LibreOffice is not installed. Changes: - controllers/main.py: new HTTP controller with LibreOffice conversion - utils.esm.js: OFFICE_EXTENSIONS added to canPreview(); getUrl() routes Office files to the conversion endpoint - binary_field.esm.js: passes filename for correct extension detection - tests: controller unit tests covering success, FileNotFoundError, TimeoutExpired, and non-zero exit code paths Closes OCA#603
dnplkndll
force-pushed
the
18.0-add-office-preview
branch
from
375b593 to
ba32cd7
Compare
…ffice Extends attachment_preview to support DOCX, XLSX, PPTX, DOC, XLS, PPT, and ODG in addition to the existing PDF + ODF format support. New endpoint: GET /attachment_preview/office_to_pdf Accepts ?model=<model>&field=<field>&id=<id>&filename=<name> Converts the binary field content to PDF using LibreOffice headless, then streams the PDF to ViewerJS for in-browser rendering. Returns HTTP 503 gracefully if LibreOffice is not installed. Changes: - controllers/main.py: new HTTP controller with LibreOffice conversion - utils.esm.js: OFFICE_EXTENSIONS added to canPreview(); getUrl() routes Office files to the conversion endpoint - binary_field.esm.js: passes filename for correct extension detection - tests: controller unit tests covering success, FileNotFoundError, TimeoutExpired, and non-zero exit code paths Closes OCA#603
dnplkndll
force-pushed
the
18.0-add-office-preview
branch
from
ba32cd7 to
136409c
Compare
Member
|
Why not integrating viewerjs directly into usual Odoo preview instead of having another preview mechanism like |
…onversion
Render office previews through Odoo's native PDF.js viewer instead of a bundled
ViewerJS widget (addresses the "don't ship a parallel preview mechanism" review
point). All office formats — ODF *and* OOXML — are converted to PDF server-side
via LibreOffice and rendered with /web/static/lib/pdfjs, the same viewer core's
FileViewer uses. The bundled ViewerJS library (21 files) is removed.
Why conversion is required: ViewerJS renders only ODF + PDF and Odoo's native
viewer renders no office formats, so previewing XLSX/PPTX/DOCX needs a
server-side conversion regardless of the display widget.
Harden the /attachment_preview/office_to_pdf controller:
- validate the requested field exists and is Binary (no arbitrary attribute read)
- exists() + record-level check_access("read")
- reject documents over a size cap (HTTP 413)
- isolate each LibreOffice run with -env:UserInstallation to avoid the shared
profile-lock collision under concurrency
- cache converted PDFs by content checksum under the data_dir (best-effort)
Tests: add coverage for ODF acceptance, non-binary/unknown field rejection,
oversize rejection, and the isolated-profile flag. Verified real xlsx/ods -> PDF
conversion + 3 concurrent conversions on Odoo 18 with LibreOffice.
…escription DESCRIPTION.md still described the old ViewerJS approach; rewrite it for the native PDF.js + LibreOffice-conversion design. INSTALL.md now states the hard LibreOffice system dependency that office preview needs — it is not in the standard Odoo image, so without it the office endpoint returns HTTP 503 and only PDF preview works.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Extends
attachment_previewto support DOCX, XLSX, PPTX, DOC, XLS, PPT, and ODG preview in addition to the existing PDF + ODF support.How it works
GET /attachment_preview/office_to_pdf?model=&field=&id=&filename=libreoffice --headless --convert-to pdf)Changes
controllers/main.pystatic/src/js/utils.esm.jsOFFICE_EXTENSIONSadded tocanPreview();getUrl()routes Office extensions through conversion endpoint with?type=pdffor ViewerJSstatic/src/js/web_views/fields/binary_field.esm.jsfilenametoshowPreview()so conversion endpoint receives correct extensionRequirements
subprocess,tempfile)Test plan
.docxfile to a record with a binary field → preview button (↗) appears.xlsx/.pptx→ same behavior🤖 Generated with Claude Code