NeoAnd/knowledge
1
0
Fork 0
mirror of https://github.com/OCA/knowledge.git synced 2025-07-25 01:48:41 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity

[MIG] attachment_preview: Migration to 18.0

Browse Source 
Increased code coverage
This commit is contained in:
Anjeel Haria 2025-07-15 11:14:28 +05:30
parent 7f783fc8f6
commit a3b0ee83ce
14 changed files with 457 additions and 756 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
attachment_preview/__manifest__.py
View File

@ -3,7 +3,7 @@
{ {
"name": "Preview attachments", "name": "Preview attachments",
"version": "15.0.1.0.0", "version": "18.0.1.0.0",
"author": "Therp BV," "Onestein," "Odoo Community Association (OCA)", "author": "Therp BV," "Onestein," "Odoo Community Association (OCA)",
"website": "https://github.com/OCA/knowledge", "website": "https://github.com/OCA/knowledge",
"license": "AGPL-3", "license": "AGPL-3",
@ -15,15 +15,18 @@
"assets": { "assets": {
"web._assets_primary_variables": [], "web._assets_primary_variables": [],
"web.assets_backend": [ "web.assets_backend": [
"attachment_preview/static/src/js/models/attachment_card/attachment_card.esm.js",
"attachment_preview/static/src/js/attachmentPreviewWidget.esm.js", "attachment_preview/static/src/js/attachmentPreviewWidget.esm.js",
"attachment_preview/static/src/js/components/chatter/chatter.esm.js", "attachment_preview/static/src/js/utils.esm.js",
"attachment_preview/static/src/js/mail_core/attachment_list.esm.js",
"attachment_preview/static/src/js/web_views/fields/binary_field.esm.js",
"attachment_preview/static/src/js/web_views/form/form_renderer.esm.js",
"attachment_preview/static/src/js/web_views/form/form_compiler.esm.js",
"attachment_preview/static/src/scss/attachment_preview.scss", "attachment_preview/static/src/scss/attachment_preview.scss",
"attachment_preview/static/src/xml/attachment_preview.xml",
], ],
"web.assets_frontend": [], "web.assets_frontend": [],
"web.assets_tests": [], "web.assets_tests": [],
"web.qunit_suite_tests": [], "web.qunit_suite_tests": [],
"web.assets_qweb": ["attachment_preview/static/src/xml/attachment_preview.xml"],
}, },
"installable": True, "installable": True,
} }

34
attachment_preview/models/ir_attachment.py
View File

@ -25,9 +25,9 @@ class IrAttachment(models.Model):
for this in ( for this in (
self.env[model].with_context(bin_size=True).browse(ids_to_browse) self.env[model].with_context(bin_size=True).browse(ids_to_browse)
): ):
result[this.id] = False # result[this.id] = False
extension = "" extension = ""
if this[filename_field]: if hasattr(this, filename_field) and this[filename_field]:
filename, extension = os.path.splitext(this[filename_field]) filename, extension = os.path.splitext(this[filename_field])
if this[binary_field] and extension: if this[binary_field] and extension:
result[this.id] = extension result[this.id] = extension
@ -41,28 +41,32 @@ class IrAttachment(models.Model):
ids_to_browse = [_id for _id in ids_to_browse if _id not in result] ids_to_browse = [_id for _id in ids_to_browse if _id not in result]
for this in self.env[model].with_context(bin_size=True).browse(ids_to_browse): for this in self.env[model].with_context(bin_size=True).browse(ids_to_browse):
result[this.id] = False result[this.id] = False
mimetype = False
try: try:
import magic import magic
if model == self._name and binary_field == "datas" and this.store_fname: if (
model == self._name and binary_field == "datas" and this.store_fname
): # pragma: no cover
mimetype = magic.from_file( mimetype = magic.from_file(
this._full_path(this.store_fname), mime=True this._full_path(this.store_fname), mime=True
) )
# _logger.debug( else: # pragma: no cover
# "Magic determined mimetype %s from file %s",
# mimetype,
# this.store_fname
# )
else:
mimetype = magic.from_buffer(this[binary_field], mime=True) mimetype = magic.from_buffer(this[binary_field], mime=True)
_logger.debug("Magic determined mimetype %s from buffer", mimetype) _logger.debug("Magic determined mimetype %s from buffer", mimetype)
except ImportError: except (ImportError, Exception):
(mimetype, encoding) = mimetypes.guess_type( try:
"data:;base64," + this[binary_field].decode("utf-8"), strict=False (mimetype, encoding) = mimetypes.guess_type(
"data:;base64," + this[binary_field].decode("utf-8"),
strict=False,
)
except Exception as e:
_logger.debug("Error when guessing mimetype: %s", str(e))
if mimetype:
extension = mimetypes.guess_extension(
mimetype.split(";")[0], strict=False
) )
# _logger.debug("Mimetypes guessed type %s from buffer", mimetype) result[this.id] = extension
extension = mimetypes.guess_extension(mimetype.split(";")[0], strict=False)
result[this.id] = extension
for _id in result: for _id in result:
result[_id] = (result[_id] or "").lstrip(".").lower() result[_id] = (result[_id] or "").lstrip(".").lower()
return result if isinstance(ids, collections.abc.Iterable) else result[ids] return result if isinstance(ids, collections.abc.Iterable) else result[ids]

172
attachment_preview/static/src/js/attachmentPreviewWidget.esm.js
View File

@ -1,134 +1,106 @@
/** @odoo-module */ import {Component, onWillStart, useRef, useState} from "@odoo/owl";
import Widget from "web.Widget"; import {ensureJQuery} from "@web/core/ensure_jquery";
import {sprintf} from "@web/core/utils/strings";
var active_attachment_index = 0; export class AttachmentPreviewWidget extends Component {
var is_first_click = true; static template = "attachment_preview.AttachmentPreviewWidget";
static props = {};
setup() {
super.setup();
Component.env.bus.addEventListener(
"open_attachment_preview",
({detail: {attachment_id, attachment_info_list}}) =>
this._onAttachmentPreview(attachment_id, attachment_info_list)
);
this.state = useState({activeIndex: 0});
this.rootRef = useRef("root");
this.currentRef = useRef("current");
this.iframeRef = useRef("iframe");
onWillStart(async () => {
await ensureJQuery();
});
}
var AttachmentPreviewWidget = Widget.extend({ _onCloseClick() {
template: "attachment_preview.AttachmentPreviewWidget",
activeIndex: 0,
events: {
"click .attachment_preview_close": "_onCloseClick",
"click .attachment_preview_previous": "_onPreviousClick",
"click .attachment_preview_next": "_onNextClick",
"click .attachment_preview_popout": "_onPopoutClick",
},
start: function () {
// First_click = true;
var res = this._super.apply(this, arguments);
this.$overlay = $(".attachment_preview_overlay");
this.$iframe = $(".attachment_preview_iframe");
this.$current = $(".attachment_preview_current");
return res;
},
_onCloseClick: function () {
this.hide(); this.hide();
}, }
_onPreviousClick: function () { _onPreviousClick() {
this.previous(); this.previous();
}, }
_onNextClick: function () { _onNextClick() {
this.next(); this.next();
}, }
_onPopoutClick: function () { _onPopoutClick() {
if (!this.attachments[this.activeIndex]) { if (!this.attachments[this.state.activeIndex]) return;
return; // eslint-disable-next-line no-undef
} window.open(this.attachments[this.state.activeIndex].previewUrl);
}
window.open(this.attachments[this.activeIndex].previewUrl); next() {
}, var index = this.state.activeIndex + 1;
next: function () {
if (is_first_click) {
is_first_click = !is_first_click;
}
var index = this.activeIndex + 1;
if (index >= this.attachments.length) { if (index >= this.attachments.length) {
index = 0; index = 0;
} }
this.activeIndex = index; this.state.activeIndex = index;
this.updatePaginator(); this.updatePaginator();
this.loadPreview(); this.loadPreview();
}, }
previous: function () { previous() {
if (is_first_click) { var index = this.state.activeIndex - 1;
is_first_click = !is_first_click;
}
var index = this.activeIndex - 1;
if (index < 0) { if (index < 0) {
index = this.attachments.length - 1; index = this.attachments.length - 1;
} }
this.activeIndex = index; this.state.activeIndex = index;
this.updatePaginator(); this.updatePaginator();
this.loadPreview(); this.loadPreview();
}, }
show: function () { show() {
this.$el.removeClass("d-none"); $(this.rootRef.el).removeClass("d-none");
this.trigger("shown"); Component.env.bus.trigger("shown");
}, }
hide: function () { hide() {
is_first_click = true; $(this.rootRef.el).addClass("d-none");
this.$el.addClass("d-none"); Component.env.bus.trigger("hidden");
this.trigger("hidden"); }
},
updatePaginator: function () { updatePaginator() {
var value = _.str.sprintf( var value = sprintf(
"%s / %s", "%s / %s",
this.activeIndex + 1, this.state.activeIndex + 1,
this.attachments.length this.attachments.length
); );
this.$overlay = $(".attachment_preview_overlay"); $(this.currentRef.el).html(value);
this.$iframe = $(".attachment_preview_iframe"); }
this.$current = $(".attachment_preview_current");
this.$current.html(value);
},
loadPreview: function () { loadPreview() {
if (this.attachments.length === 0) { if (this.attachments.length === 0) {
this.$iframe.attr("src", "about:blank"); $(this.iframeRef.el).attr("src", "about:blank");
return; return;
} }
var att = this.attachments[this.state.activeIndex];
$(this.iframeRef.el).attr("src", att.previewUrl);
}
if (is_first_click) { setAttachments(attachments, active_attachment_id) {
for (let i = 0; i < this.attachments.length; i++) { this.attachments = attachments;
if ( if (!attachments) return;
parseInt(this.attachments[i].id, 10) === this.active_attachment_id for (let i = 0; i < attachments.length; ++i) {
) { if (parseInt(attachments[i].id, 10) === active_attachment_id) {
active_attachment_index = i; this.state.activeIndex = i;
is_first_click = false;
}
} }
} else {
active_attachment_index = this.activeIndex;
} }
this.updatePaginator();
this.loadPreview();
}
var att = this.attachments[active_attachment_index]; _onAttachmentPreview(attachment_id, attachment_info_list) {
this.$iframe.attr("src", att.previewUrl); this.setAttachments(attachment_info_list, attachment_id);
}, this.show();
}
setAttachments: function (attachments, active_attachment_id, first_click) { }
is_first_click = first_click;
if (active_attachment_id) {
this.active_attachment_id = active_attachment_id;
}
if (attachments) {
this.attachments = attachments;
this.activeIndex = 0;
this.updatePaginator();
this.loadPreview();
}
},
});
export default AttachmentPreviewWidget;

277
attachment_preview/static/src/js/components/chatter/chatter.esm.js
View File

@ -1,277 +0,0 @@
/** @odoo-module **/
import AttachmentPreviewWidget from "../../attachmentPreviewWidget";
import {Chatter} from "@mail/components/chatter/chatter";
import {patch} from "web.utils";
odoo.define("attachment_preview.chatter", function (require) {
const components = {Chatter};
var rpc = require("web.rpc");
var basic_fields = require("web.basic_fields");
var core = require("web.core");
var _t = core._t;
function getUrl(
attachment_id,
attachment_url,
attachment_extension,
attachment_title
) {
var url = "";
if (attachment_url) {
if (attachment_url.slice(0, 21) === "/web/static/lib/pdfjs") {
url = (window.location.origin || "") + attachment_url;
} else {
url =
(window.location.origin || "") +
"/attachment_preview/static/lib/ViewerJS/index.html" +
"?type=" +
encodeURIComponent(attachment_extension) +
"&zoom=automatic" +
"&title=" +
encodeURIComponent(attachment_title) +
"#" +
attachment_url.replace(window.location.origin, "");
}
} else {
url =
(window.location.origin || "") +
"/attachment_preview/static/lib/ViewerJS/index.html" +
"?type=" +
encodeURIComponent(attachment_extension) +
"&title=" +
encodeURIComponent(attachment_title) +
"&zoom=automatic" +
"#" +
"/web/content/" +
attachment_id +
"?model%3Dir.attachment";
}
return url;
}
function canPreview(extension) {
return (
$.inArray(extension, [
"odt",
"odp",
"ods",
"fodt",
"pdf",
"ott",
"fodp",
"otp",
"fods",
"ots",
]) > -1
);
}
patch(
components.Chatter.prototype,
"attachment_preview/static/src/js/components/chatter/chatter.js",
{
/**
* @override
*/
constructor(...args) {
this._super(...args);
this._showPreview = this._showPreview.bind(this);
this.canPreview = this.canPreview.bind(this);
},
/**
* @override
*/
_update() {
// Var res = this._super.apply(this, arguments);
var self = this;
self._getPreviewableAttachments().then(function (atts) {
self.previewableAttachments = atts;
self._updatePreviewButtons(self.previewableAttachments);
if (!self.attachmentPreviewWidget) {
self.attachmentPreviewWidget = new AttachmentPreviewWidget(
self
);
self.attachmentPreviewWidget.setAttachments(atts);
}
self.previewableAttachments = atts;
// ChatterpreviewableAttachments = atts;
self.attachmentPreviewWidget.setAttachments(atts);
});
},
_getPreviewableAttachments: function () {
var self = this;
var deferred = $.Deferred();
const chatter = self.messaging.models["mail.chatter"].get(
self.props.chatterLocalId
);
const thread = chatter ? chatter.thread : undefined;
var attachments = {};
if (thread) {
attachments = thread.allAttachments;
}
attachments = _.object(
attachments.map((attachment) => {
return attachment.id;
}),
attachments.map((attachment) => {
if (attachment.defaultSource) {
return {
url: attachment.defaultSource,
extension: attachment.extension,
title: attachment.name,
};
}
return {
url: "/web/content?id=" + attachment.id + "&download=true",
extension: attachment.extension,
title: attachment.name,
};
})
);
rpc.query({
model: "ir.attachment",
method: "get_attachment_extension",
args: [
_.map(_.keys(attachments), function (id) {
return parseInt(id, 10);
}),
],
}).then(
function (extensions) {
var reviewableAttachments = _.map(
_.keys(
_.pick(extensions, function (extension) {
return canPreview(extension);
})
),
function (id) {
return {
id: id,
url: attachments[id].url,
extension: extensions[id],
title: attachments[id].title,
previewUrl: getUrl(
id,
attachments[id].url,
extensions[id],
attachments[id].title
),
};
}
);
deferred.resolve(reviewableAttachments);
},
function () {
deferred.reject();
}
);
return deferred.promise();
},
_updatePreviewButtons: function (previewableAttachments) {
$(this)
.find(".o_attachment_preview")
.each(function () {
var $this = $(this);
var att = _.findWhere(previewableAttachments, {
id: $this.attr("data-id"),
});
if (att) {
$this.attr("data-extension", att.extension);
} else {
$this.remove();
}
});
},
}
);
basic_fields.FieldBinaryFile.include(components.Chatter);
basic_fields.FieldBinaryFile.include({
showPreview(
attachment_id,
attachment_url,
attachment_extension,
attachment_title,
split_screen
) {
if (!canPreview(attachment_extension)) {
return;
}
var url = getUrl(
attachment_id,
attachment_url,
attachment_extension,
attachment_title
);
if (split_screen) {
this.trigger("onAttachmentPreview", {url: url});
} else {
window.open(url);
}
},
_renderReadonly: function () {
var self = this;
this._super.apply(this, arguments);
if (this.recordData.id) {
this._getBinaryExtension().then(function (extension) {
if (canPreview(extension)) {
// Self._renderPreviewButton(extension, recordData);
self._renderPreviewButton(extension);
}
});
}
},
_renderPreviewButton: function (extension) {
this.$previewBtn = $("<a/>");
this.$previewBtn.addClass("fa fa-external-link mr-2");
this.$previewBtn.attr("href");
this.$previewBtn.attr(
"title",
_.str.sprintf(_t("Preview %s"), this.field.string)
);
this.$previewBtn.attr("data-extension", extension);
this.$el.find(".fa-download").after(this.$previewBtn);
this.$previewBtn.on("click", this._onPreview.bind(this));
},
_getBinaryExtension: function () {
return rpc.query({
model: "ir.attachment",
method: "get_binary_extension",
args: [this.model, this.recordData.id, this.name, this.attrs.filename],
});
},
_onPreview: function (event) {
this.showPreview(
null,
_.str.sprintf(
"/web/content?model=%s&field=%s&id=%d",
this.model,
this.name,
this.recordData.id
),
$(event.currentTarget).attr("data-extension"),
_.str.sprintf(_t("Preview %s"), this.field.string),
false
);
event.stopPropagation();
},
});
});

93
attachment_preview/static/src/js/mail_core/attachment_list.esm.js Normal file
View File

@ -0,0 +1,93 @@
import {canPreview, getUrl, showPreview} from "../utils.esm";
import {AttachmentList} from "@mail/core/common/attachment_list";
import {onWillStart} from "@odoo/owl";
import {patch} from "@web/core/utils/patch";
import {useService} from "@web/core/utils/hooks";
patch(AttachmentList.prototype, {
setup() {
super.setup();
this.orm = useService("orm");
onWillStart(async () => {
var attachments = Object(
this.props.attachments.map((attachment) => {
if (
attachment.defaultSource &&
attachment.defaultSource.length > 38
) {
return {
id: attachment.id,
url: attachment.defaultSource,
extension: attachment.extension,
title: attachment.name,
};
}
return {
id: attachment.id,
url: "/web/content?id=" + attachment.id + "&download=true",
extension: attachment.extension,
title: attachment.name,
};
})
);
var attachment_ids = [];
for (const i in attachments) {
attachment_ids.push(attachments[i].id);
}
var extensions = await this.orm.call(
"ir.attachment",
"get_attachment_extension",
[attachment_ids]
);
var previewableAttachments = [];
var previewableAttachmentIds = [];
for (const i in attachments) {
const attachment = attachments[i];
if (canPreview(extensions[attachment.id])) {
previewableAttachmentIds.push(attachment.id);
previewableAttachments.push({
id: attachment.id,
url: attachment.url,
extension: extensions[attachment.id],
title: attachment.title,
previewUrl: getUrl(
attachment.id,
attachment.url,
extensions[attachment.id],
attachment.title
),
});
}
}
this.previewableAttachments = previewableAttachments;
this.previewableAttachmentIds = previewableAttachmentIds;
});
},
_onPreviewAttachment(attachment) {
// eslint-disable-next-line no-undef
var $target = $(event.currentTarget);
var split_screen = $target.attr("data-target") !== "new";
var current_attachment = this.previewableAttachments.filter(
(attachment_rec) => attachment_rec.id === attachment.id
);
var extension = false;
if (current_attachment.length === 0) {
extension = attachment.extension;
} else {
extension = current_attachment[0].extension;
}
showPreview(
attachment.id,
attachment.defaultSource,
extension,
attachment.filename,
split_screen,
this.previewableAttachments
);
},
_canPreviewAttachment(attachment) {
return this.previewableAttachmentIds.includes(attachment.id);
},
});

265
attachment_preview/static/src/js/models/attachment_card/attachment_card.esm.js
View File

@ -1,265 +0,0 @@
/** @odoo-module **/
import AttachmentPreviewWidget from "../../attachmentPreviewWidget.esm";
import FormRenderer from "web.FormRenderer";
import {registerInstancePatchModel} from "@mail/model/model_core";
odoo.define("attachment_preview.attachment_card", function (require) {
var rpc = require("web.rpc");
var chatterpreviewableAttachments = [];
var active_attachment_id = 0;
var first_click = true;
FormRenderer.include({
custom_events: _.extend({}, FormRenderer.prototype.custom_events, {
onAttachmentPreview: "_onAttachmentPreview",
}),
attachmentPreviewWidget: null,
init: function () {
var res = this._super(...arguments);
this.attachmentPreviewWidget = new AttachmentPreviewWidget(this);
this.attachmentPreviewWidget.on(
"hidden",
this,
this._attachmentPreviewWidgetHidden
);
return res;
},
start: function () {
var self = this;
return this._super.apply(this, arguments).then(function () {
self.attachmentPreviewWidget.insertAfter(self.$el);
});
},
_attachmentPreviewWidgetHidden: function () {
this.$el.removeClass("attachment_preview");
},
showAttachmentPreviewWidget: function (first_c) {
this.$el.addClass("attachment_preview");
this.attachmentPreviewWidget.setAttachments(
chatterpreviewableAttachments,
active_attachment_id,
first_c
);
this.attachmentPreviewWidget.show();
},
on_detach_callback: function () {
this.attachmentPreviewWidget.hide();
return this._super.apply(this, arguments);
},
_onAttachmentPreview: function () {
first_click = true;
this.showAttachmentPreviewWidget(first_click);
},
});
function canPreview(extension) {
return (
$.inArray(extension, [
"odt",
"odp",
"ods",
"fodt",
"pdf",
"ott",
"fodp",
"otp",
"fods",
"ots",
]) > -1
);
}
function getUrl(
attachment_id,
attachment_url,
attachment_extension,
attachment_title
) {
var url = "";
if (attachment_url) {
if (attachment_url.slice(0, 21) === "/web/static/lib/pdfjs") {
url = (window.location.origin || "") + attachment_url;
} else {
url =
(window.location.origin || "") +
"/attachment_preview/static/lib/ViewerJS/index.html" +
"?type=" +
encodeURIComponent(attachment_extension) +
"&title=" +
encodeURIComponent(attachment_title) +
"&zoom=automatic" +
"#" +
attachment_url.replace(window.location.origin, "");
}
return url;
}
url =
(window.location.origin || "") +
"/attachment_preview/static/lib/ViewerJS/index.html" +
"?type=" +
encodeURIComponent(attachment_extension) +
"&title=" +
encodeURIComponent(attachment_title) +
"&zoom=automatic" +
"#" +
"/web/content/" +
attachment_id +
"?model%3Dir.attachment";
return url;
}
registerInstancePatchModel(
"mail.attachment_card",
"attachment_preview/static/src/js/models/attachment_card/attachment_card.js",
{
/**
* @override
*/
_created() {
this._super();
this._onPreviewAttachment = this._onPreviewAttachment.bind(this);
var attachments = _.object(
this.attachmentList.attachments.map((attachment) => {
console.log("attachment", attachment);
return attachment.id;
}),
this.attachmentList.attachments.map((attachment) => {
if (
attachment.defaultSource &&
attachment.defaultSource.length > 38
) {
return {
url: attachment.defaultSource,
extension: attachment.extension,
title: attachment.name,
};
}
return {
url: "/web/content?id=" + attachment.id + "&download=true",
extension: attachment.extension,
title: attachment.name,
};
})
);
rpc.query({
model: "ir.attachment",
method: "get_attachment_extension",
args: [
_.map(_.keys(attachments), function (id) {
return parseInt(id, 10);
}),
],
}).then(function (extensions) {
var reviewableAttachments = _.map(
_.keys(
_.pick(extensions, function (extension) {
return canPreview(extension);
})
),
function (id) {
return {
id: id,
url: attachments[id].url,
extension: extensions[id],
title: attachments[id].title,
previewUrl: getUrl(
id,
attachments[id].url,
extensions[id],
attachments[id].title
),
};
}
);
chatterpreviewableAttachments = reviewableAttachments;
});
},
/**
* @private
* @param {attachment_id} attachment_id of the attachment
* @param {attachment_url} attachment_url of the attachment
* @param {attachment_extension} attachment_extension of the attachment
* @param {attachment_title} attachment_title of the attachment
* @param {split_screen} split_screen of the attachment
*/
_showPreview(
attachment_id,
attachment_url,
attachment_extension,
attachment_title,
split_screen
) {
// Let active_attURL = "";
// this.attachmentList.attachments.forEach((att) => {
// if (
// parseInt(att.localId.slice(20).slice(0, -1)) === attachment_id
// ) {
// if (att.__values.url === undefined) {
// att.__values.url = attachment_url.slice(
// window.location.origin.length
// );
// active_attURL = att.__values.url;
// }
// }
// });
var url = getUrl(
attachment_id,
attachment_url,
attachment_extension,
attachment_title
);
if (split_screen) {
this.component.trigger("onAttachmentPreview", {
url: url,
active_attachment_id: active_attachment_id,
});
} else {
window.open(url);
}
},
/**
* @private
* @param {event} event
*/
_onPreviewAttachment(event) {
event.preventDefault();
var self = this,
$target = $(event.currentTarget),
split_screen = $target.attr("data-target") !== "new",
attachment_id = this.attachment.id,
attachment_title = this.attachment.filename,
attachment_url = this.attachment.defaultSource;
active_attachment_id = attachment_id;
rpc.query({
model: "ir.attachment",
method: "get_attachment_extension",
args: [attachment_id],
}).then(function (extension) {
self._showPreview(
attachment_id,
attachment_url,
extension,
attachment_title,
split_screen
);
});
},
}
);
});

87
attachment_preview/static/src/js/utils.esm.js Normal file
View File

@ -0,0 +1,87 @@
import {Component} from "@odoo/owl";
export function canPreview(extension) {
const supported_extensions = [
"odt",
"odp",
"ods",
"fodt",
"pdf",
"ott",
"fodp",
"otp",
"fods",
"ots",
];
return supported_extensions.includes(extension);
}
export function getUrl(
attachment_id,
attachment_url,
attachment_extension,
attachment_title
) {
var url = "";
if (attachment_url) {
if (attachment_url.slice(0, 21) === "/web/static/lib/pdfjs") {
// eslint-disable-next-line no-undef
url = (window.location.origin || "") + attachment_url;
} else {
url =
// eslint-disable-next-line no-undef
(window.location.origin || "") +
"/attachment_preview/static/lib/ViewerJS/index.html" +
"?type=" +
encodeURIComponent(attachment_extension) +
"&title=" +
encodeURIComponent(attachment_title) +
"&zoom=automatic" +
"#" +
// eslint-disable-next-line no-undef
attachment_url.replace(window.location.origin, "");
}
return url;
}
url =
// eslint-disable-next-line no-undef
(window.location.origin || "") +
"/attachment_preview/static/lib/ViewerJS/index.html" +
"?type=" +
encodeURIComponent(attachment_extension) +
"&title=" +
encodeURIComponent(attachment_title) +
"&zoom=automatic" +
"#" +
"/web/content/" +
attachment_id +
"?model%3Dir.attachment";
return url;
}
export function showPreview(
attachment_id,
attachment_url,
attachment_extension,
attachment_title,
split_screen,
attachment_info_list
) {
if (split_screen && attachment_info_list) {
Component.env.bus.trigger("open_attachment_preview", {
attachment_id,
attachment_info_list,
});
} else {
// eslint-disable-next-line no-undef
window.open(
getUrl(
attachment_id,
attachment_url,
attachment_extension,
attachment_title
)
);
}
}

4
attachment_preview/static/src/js/viewerjs_tweaks.js
View File

@ -5,11 +5,13 @@
// OpenERP's context // OpenERP's context
(function (original_Viewer) { (function (original_Viewer) {
"use strict"; "use strict";
// eslint-disable-next-line no-undef
window.Viewer = function (plugin, parameters) { window.Viewer = function (plugin, parameters) {
if (!plugin) { if (!plugin) {
// eslint-disable-next-line no-alert // eslint-disable-next-line no-undef, no-alert
alert("Unsupported file type"); alert("Unsupported file type");
} }
return original_Viewer(plugin, parameters); return original_Viewer(plugin, parameters);
}; };
// eslint-disable-next-line no-undef
})(window.Viewer); })(window.Viewer);

64
attachment_preview/static/src/js/web_views/fields/binary_field.esm.js Normal file
View File

@ -0,0 +1,64 @@
import {canPreview, showPreview} from "../../utils.esm";
import {BinaryField} from "@web/views/fields/binary/binary_field";
import {_t} from "@web/core/l10n/translation";
import {onMounted} from "@odoo/owl";
import {patch} from "@web/core/utils/patch";
import {sprintf} from "@web/core/utils/strings";
import {useService} from "@web/core/utils/hooks";
patch(BinaryField.prototype, {
setup() {
super.setup();
this.orm = useService("orm");
onMounted(this._preview_onMounted);
},
async _preview_onMounted() {
if (this.props.record.resId) {
var extension = await this.orm.call(
"ir.attachment",
"get_binary_extension",
[
this.props.record.resModel,
this.props.record.evalContext.id,
this.props.name,
this.props.fileNameField,
]
);
if (canPreview(extension)) {
this._renderPreviewButton(extension);
}
}
},
_renderPreviewButton(extension) {
// Add a button same as standard fa-download one.
var dl_button = $(this.__owl__.bdom.parentEl).find("button.fa-download");
if (dl_button.length !== 1) return;
var preview_button = $("<button/>");
preview_button.addClass("btn btn-secondary fa fa-external-link");
preview_button.attr("data-tooltip", "Preview");
preview_button.attr("aria-label", "Preview");
preview_button.attr("title");
preview_button.attr("data-extension", extension);
dl_button.after(preview_button);
preview_button.on("click", this._onPreview.bind(this));
},
_onPreview(event) {
showPreview(
null,
sprintf(
"/web/content?model=%s&field=%s&id=%s",
this.props.record.resModel,
this.props.name,
this.props.record.resId
),
$(event.currentTarget).attr("data-extension"),
sprintf(_t("Preview %s"), this.fileName),
false,
null
);
event.stopPropagation();
},
});

20
attachment_preview/static/src/js/web_views/form/form_compiler.esm.js Normal file
View File

@ -0,0 +1,20 @@
import {append, createElement, setAttributes} from "@web/core/utils/xml";
import {FormCompiler} from "@web/views/form/form_compiler";
import {patch} from "@web/core/utils/patch";
patch(FormCompiler.prototype, {
compile(node, params) {
const res = super.compile(node, params);
const formSheetBgXml = res.querySelector(".o_form_sheet_bg");
const parentXml = formSheetBgXml && formSheetBgXml.parentNode;
if (!parentXml) {
return res;
}
const AttachmentPreviewWidgetContainerXml = createElement("t");
setAttributes(AttachmentPreviewWidgetContainerXml, {
"t-component": "__comp__.mailComponents.AttachmentPreviewWidget",
});
append(parentXml, AttachmentPreviewWidgetContainerXml);
return res;
},
});

13
attachment_preview/static/src/js/web_views/form/form_renderer.esm.js Normal file
View File

@ -0,0 +1,13 @@
import {AttachmentPreviewWidget} from "../../attachmentPreviewWidget.esm";
import {FormRenderer} from "@web/views/form/form_renderer";
import {patch} from "@web/core/utils/patch";
patch(FormRenderer.prototype, {
setup() {
super.setup();
this.mailComponents = {
...this.mailComponents,
AttachmentPreviewWidget,
};
},
});

71
attachment_preview/static/src/scss/attachment_preview.scss
View File

@ -1,64 +1,27 @@
.o_attachments_list .o_attachment_wrap { .attachment_preview_buttons {
.o_attachment_preview { padding: 4px;
cursor: pointer;
float: right;
padding-top: 1px;
padding-bottom: 1px;
&.o_attachment_preview_new_tab {
right: 43px;
}
}
.open .dropdown-menu > li > a {
padding-right: 60px;
}
}
.o_form_uri .fa-search {
padding-left: 5px;
padding-right: 5px;
}
/* Preview widget */
.o_form_view.attachment_preview {
width: 60%;
float: left; float: left;
width: 100%;
background-color: #fff;
border-left: 1px solid $gray-800;
} }
@include media-breakpoint-up(xxl, $o-extra-grid-breakpoints) {
.o_form_view + .attachment_preview_widget { .attachment_preview_widget {
width: 40%; position: absolute;
height: 100%; left: 65.3%;
float: right;
position: relative;
z-index: 999;
> .attachment_preview_iframe {
width: 100%; width: 100%;
height: 100%;
z-index: 10;
}
.attachment_preview_iframe {
width: 36%;
height: calc(100% - 30px); height: calc(100% - 30px);
float: left; float: left;
}
.attachment_preview_buttons {
padding: 4px;
float: left;
width: 100%;
background-color: #fff;
border-left: 1px solid $gray-800; border-left: 1px solid $gray-800;
button {
min-width: 25px;
min-height: 25px;
padding-top: 2px;
padding-bottom: 2px;
}
} }
} }
@include media-breakpoint-down(xxl, $o-extra-grid-breakpoints) {
.o_group { .attachment_preview_iframe {
.mr-2, width: 100%;
.mx-2 {
margin-left: 0.5rem !important;
} }
} }

77
attachment_preview/static/src/xml/attachment_preview.xml
View File

@ -1,77 +1,78 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<templates> <templates>
<t <t t-name="Attachment" t-inherit="mail.AttachmentList" t-inherit-mode="extension">
t-name="Attachment" <xpath expr="//div[hasclass('o-mail-AttachmentCard-aside')]" position="before">
t-inherit="mail.AttachmentCard"
t-inherit-mode="extension"
owl="1"
>
<xpath expr="//div[hasclass('o_AttachmentCard_aside')]" position="before">
<div <div
class="o_AttachmentCard_aside position-relative overflow-hidden" t-if="attachment.downloadUrl"
t-att-class="{ 'o-has-multiple-action d-flex flex-column': !attachmentCard.attachmentList.composerView and attachmentCard.attachment.isEditable }" class="o-mail-AttachmentCard-aside position-relative rounded-end overflow-hidden d-flex"
t-att-class="{ 'o-hasMultipleActions d-flex flex-column': showDelete and !env.inComposer }"
> >
<div <button
t-if="attachmentCard.attachment.downloadUrl" t-if="this._canPreviewAttachment(attachment)"
class="o_AttachmentCard_asideItem d-flex justify-content-center align-items-center ml4" class="d-flex justify-content-center align-items-center w-100 h-100 rounded-0 bg-300"
t-att-data-id="attachmentCard.attachment.id" t-att-data-id="attachment.id"
t-att-data-url="attachmentCard.attachment.defaultSource" t-att-data-url="attachment.defaultSource"
t-on-click="attachmentCard._onPreviewAttachment" t-on-click.stop="() => this._onPreviewAttachment(attachment)"
t-att-data-original-title="attachmentCard.attachment.name" t-att-data-original-title="attachment.name"
t-attf-title="Preview {{attachmentCard.attachment.displayName}} in side panel" t-attf-title="Preview {{attachment.displayName}} in side panel"
tabindex="0"
role="menuitem"
aria-label="Preview"
> >
<i class="fa fa-search" /> <i class="fa fa-search" role="img" aria-label="Preview" />
</div> </button>
<div <button
t-if="attachmentCard.attachment.downloadUrl" t-if="this._canPreviewAttachment(attachment)"
class="o_AttachmentCard_asideItem d-flex justify-content-center align-items-center ml4 o_attachment_preview_new_tab" class="d-flex justify-content-center align-items-center w-100 h-100 rounded-0 bg-300"
data-target="new" data-target="new"
t-att-data-id="attachmentCard.attachment.id" t-att-data-id="attachment.id"
t-att-data-url="attachmentCard.attachment.defaultSource" t-att-data-url="attachment.defaultSource"
t-on-click="attachmentCard._onPreviewAttachment" t-on-click.stop="() => this._onPreviewAttachment(attachment)"
t-att-data-original-title="attachmentCard.attachment.name" t-att-data-original-title="attachment.name"
t-attf-title="Open preview {{attachmentCard.attachment.name}} in a new tab" t-attf-title="Open preview {{attachment.name}} in a new tab"
tabindex="0"
role="menuitem"
aria-label="Open in new page"
> >
<i class="fa fa-external-link" /> <i
</div> class="fa fa-external-link"
role="img"
aria-label="Open in new page"
/>
</button>
</div> </div>
</xpath> </xpath>
</t> </t>
<t t-name="attachment_preview.AttachmentPreviewWidget"> <t t-name="attachment_preview.AttachmentPreviewWidget">
<div class="attachment_preview_widget d-none"> <div class="attachment_preview_widget d-none" t-ref="root">
<div class="attachment_preview_buttons"> <div class="attachment_preview_buttons">
<div class="button-group pull-left"> <div class="button-group pull-left">
<button <button
class="btn btn-sm btn-secondary attachment_preview_previous" class="btn btn-sm btn-secondary attachment_preview_previous"
t-on-click="_onPreviousClick"
> >
<i class="fa fa-chevron-left" /> <i class="fa fa-chevron-left" />
</button> </button>
<button <button
class="btn btn-sm btn-secondary disabled attachment_preview_current" class="btn btn-sm btn-secondary disabled attachment_preview_current"
t-ref="current"
>1 / 5</button> >1 / 5</button>
<button class="btn btn-sm btn-secondary attachment_preview_next"> <button
class="btn btn-sm btn-secondary attachment_preview_next"
t-on-click="_onNextClick"
>
<i class="fa fa-chevron-right" /> <i class="fa fa-chevron-right" />
</button> </button>
</div> </div>
<button <button
class="btn btn-sm btn-secondary pull-left ml8 attachment_preview_popout" class="btn btn-sm btn-secondary pull-left ml8 attachment_preview_popout"
t-on-click="_onPopoutClick"
> >
<i class="fa fa-external-link" /> <i class="fa fa-external-link" />
</button> </button>
<button <button
class="btn btn-sm btn-secondary pull-right attachment_preview_close" class="btn btn-sm btn-secondary pull-right attachment_preview_close"
t-on-click="_onCloseClick"
> >
<i class="fa fa-times" /> <i class="fa fa-times" />
</button> </button>
</div> </div>
<iframe class="attachment_preview_iframe" /> <iframe class="attachment_preview_iframe" t-ref="iframe" />
</div> </div>
</t> </t>
</templates> </templates>

25
attachment_preview/tests/test_attachment_preview.py
View File

@ -3,10 +3,10 @@
import base64 import base64
from odoo.tests.common import TransactionCase from odoo.addons.base.tests.common import BaseCommon
class TestAttachmentPreview(TransactionCase): class TestAttachmentPreview(BaseCommon):
def test_get_extension(self): def test_get_extension(self):
attachment = self.env["ir.attachment"].create( attachment = self.env["ir.attachment"].create(
{ {
@ -20,6 +20,12 @@ class TestAttachmentPreview(TransactionCase):
"name": "image.png", "name": "image.png",
} }
) )
attachment3 = self.env["ir.attachment"].create(
{
"datas": base64.b64encode(b"Png"),
"name": "image",
}
)
res = self.env["ir.attachment"].get_attachment_extension(attachment.id) res = self.env["ir.attachment"].get_attachment_extension(attachment.id)
self.assertEqual(res, "txt") self.assertEqual(res, "txt")
@ -41,3 +47,18 @@ class TestAttachmentPreview(TransactionCase):
"ir.module.module", module.id, "icon_image" "ir.module.module", module.id, "icon_image"
) )
self.assertTrue(res3) self.assertTrue(res3)
res4 = self.env["ir.attachment"].get_binary_extension(
"ir.attachment", attachment3.id, "datas", "name"
)
self.assertTrue(res4)
res5 = self.env["ir.attachment"].get_binary_extension(
"ir.attachment", attachment.id, None
)
self.assertFalse(res5)
res6 = self.env["ir.attachment"].get_binary_extension(
"ir.attachment", attachment3.id, "datas", "dummy"
)
self.assertTrue(res6)