From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2.migadu.com ([2001:41d0:403:4876::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms13.migadu.com with LMTPS id gHELHIm3b2cMLAAAe85BDQ:P1 (envelope-from ) for ; Sat, 28 Dec 2024 08:32:09 +0000 Received: from aspmx1.migadu.com ([2001:41d0:403:4876::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2.migadu.com with LMTPS id gHELHIm3b2cMLAAAe85BDQ (envelope-from ) for ; Sat, 28 Dec 2024 09:32:09 +0100 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; none Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 583BB825B8 for ; Sat, 28 Dec 2024 09:32:09 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tRSEA-0005hS-Td; Sat, 28 Dec 2024 03:31:18 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tRSE3-0005hF-Nc for emacs-orgmode@gnu.org; Sat, 28 Dec 2024 03:31:12 -0500 Received: from mout01.posteo.de ([185.67.36.65]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tRSE0-0005mQ-K5 for emacs-orgmode@gnu.org; Sat, 28 Dec 2024 03:31:11 -0500 Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id 7E257240027 for ; Sat, 28 Dec 2024 09:31:06 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1735374666; bh=lXaF2CEW2F3SXpCfIht50WDgcjRMwUe4gkz5RiZ0uJY=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version:Content-Type: From; b=roraKdpgtolPGCtylubbc+zeyn6RfVXNyJdDWe3gu0pTtguS1KUlrcyCGxFY3+ddd djvctYyzimlfmSd2EaRxB1WdgOTNhQhB8JTDGcpYOdbo3R4P060ydMyJaVdDlIOwcW Og7AMiECgH8PYbK47X9gUbEDzOXZtJAXX9/JJRvDIPsH0OUdvgyTe+3T9auvXayrJb g333AAEVL2OBgHOD0exFcbonVE2aKIKjQie9ydE1fcHBsfBZYraJZOyfg5kHty+x0I pYxwnPFzK9+jXA4mYMaNbQPsScnhEIk3ui5LckoMARCQ7jk17/WWznNoKqpoudwUJk 25+ZjWlxvuGLA== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4YKwYh5bV4z9rxF; Sat, 28 Dec 2024 09:31:04 +0100 (CET) From: Ihor Radchenko To: Joseph Turner Cc: Christian Moe , Org Mode Mailing List , Bohong Huang Subject: Re: Form feed characters break odt export In-Reply-To: <87jzbk503b.fsf@breatheoutbreathe.in> References: <87ed21hkmi.fsf@breatheoutbreathe.in> <87ikrajoe4.fsf@localhost> <87o711l4u4.fsf@christianmoe.com> <87jzbpgocm.fsf@localhost> <878qs4oyyh.fsf@breatheoutbreathe.in> <87plld5svl.fsf@localhost> <87jzbk503b.fsf@breatheoutbreathe.in> Date: Sat, 28 Dec 2024 08:32:29 +0000 Message-ID: <871pxs438i.fsf@localhost> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Received-SPF: pass client-ip=185.67.36.65; envelope-from=yantar92@posteo.net; helo=mout01.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: emacs-orgmode-bounces+larch=yhetil.org@gnu.org X-Migadu-Country: US X-Migadu-Flow: FLOW_IN X-Migadu-Spam-Score: -4.00 X-Spam-Score: -4.00 X-Migadu-Queue-Id: 583BB825B8 X-Migadu-Scanner: mx10.migadu.com X-TUID: 1N1wKOGHJCQZ --=-=-= Content-Type: text/plain Joseph Turner writes: > From ce506caa0bffbd243a2aba384f75f7aaac7fdc4b Mon Sep 17 00:00:00 2001 > From: Ihor Radchenko > Date: Fri, 27 Dec 2024 10:21:02 +0000 > Subject: [PATCH] ox-odt: Avoid putting forbidden characters into ODT xml Thanks for helping with the patch! I modified it further, adding ORG-NEWS entry announcing the new export option. --=-=-= Content-Type: text/x-patch; charset=utf-8 Content-Disposition: inline; filename=v3-0001-ox-odt-Avoid-putting-forbidden-characters-into-OD.patch Content-Transfer-Encoding: quoted-printable >From 89901da3a0d00598c5ac40cddb2f6dec7c7047cf Mon Sep 17 00:00:00 2001 Message-ID: <89901da3a0d00598c5ac40cddb2f6dec7c7047cf.1735374641.git.yantar= 92@posteo.net> From: Ihor Radchenko Date: Fri, 27 Dec 2024 10:21:02 +0000 Subject: [PATCH v3] ox-odt: Avoid putting forbidden characters into ODT xml * lisp/ox-odt.el (org-odt-with-forbidden-chars): New export option to control how to handle forbidden XML characters. (org-odt--remove-forbidden): New filter removing/replacing forbidden characters. * etc/ORG-NEWS (ox-odt: New export option ~org-odt-with-forbidden-chars~): Announce the new option. Co-authored-by: Joseph Turner Link: https://orgmode.org/list/87o711l4u4.fsf@christianmoe.com --- etc/ORG-NEWS | 16 ++++++++++++++++ lisp/ox-odt.el | 51 +++++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 66 insertions(+), 1 deletion(-) diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index d26813c983..a56e105481 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -182,6 +182,22 @@ now be pasted as an Org table using ~yank-media~. # adding new customizations, or changing the interpretation of the # existing customizations. =20 +*** ox-odt: New export option ~org-odt-with-forbidden-chars~ + +The new export option controls how to deal with characters that are forbid= den +inside ODT documents during export. + +The ODT documents must follow XML1.0 specification and cannot contain +certain unicode characters. For example, form feed characters like ^L +are disallowed. + +By default, =3Dox-odt=3D will strip such characters and display warning. +You may return to the previous behaviour by setting +~org-odt-with-forbidden-chars~ to t. + +Note that Emacs warnings can always be suppressed by clicking on =E2=9B=94 +symbol or by customizing ~warning-suppress-types~. + *** New option ~org-edit-keep-region~ =20 Since Org 9.7, structure editing commands do not deactivate region diff --git a/lisp/ox-odt.el b/lisp/ox-odt.el index ec81637ef0..960bab286a 100644 --- a/lisp/ox-odt.el +++ b/lisp/ox-odt.el @@ -94,7 +94,8 @@ (org-export-define-backend 'odt . (org-odt--translate-latex-fragments org-odt--translate-description-lists org-odt--translate-list-tables - org-odt--translate-image-links))) + org-odt--translate-image-links)) + (:filter-final-output . org-odt--remove-forbidden)) :menu-entry '(?o "Export to ODT" ((?o "As ODT file" org-odt-export-to-odt) @@ -108,6 +109,7 @@ (org-export-define-backend 'odt (:keywords "KEYWORDS" nil nil space) (:subtitle "SUBTITLE" nil nil parse) ;; Other variables. + (:odt-with-forbidden-chars nil nil org-odt-with-forbidden-chars) (:odt-content-template-file nil nil org-odt-content-template-file) (:odt-display-outline-level nil nil org-odt-display-outline-level) (:odt-fontify-srcblocks nil nil org-odt-fontify-srcblocks) @@ -170,6 +172,14 @@ (defconst org-odt-special-string-regexps ("\\.\\.\\." . "…")) ; hellip "Regular expressions for special string conversion.") =20 +(defconst org-odt-forbidden-char-re + (rx (not (in ?\N{U+9} ?\N{U+A} ?\N{U+D} + (?\N{U+20} . ?\N{U+D7FF}) + (?\N{U+E000} . ?\N{U+FFFD}) + (?\N{U+10000} . ?\N{U+10FFFF})))) + "Regexp matching forbidden XML1.0 characters. +https://www.w3.org/TR/REC-xml/#charsets") + (defconst org-odt-schema-dir-list (list (expand-file-name "./schema/" org-odt-data-dir)) "List of directories to search for OpenDocument schema files. @@ -364,6 +374,19 @@ (defgroup org-export-odt nil :tag "Org Export ODT" :group 'org-export) =20 +(defcustom org-odt-with-forbidden-chars "" + "String to replace forbidden XML characters. +When set to t, forbidden characters are left as-is. +When set to nil, an error is thrown. +See `org-odt-forbidden-char-re' for the list of forbidden characters +that cannot occur inside ODT documents. + +You may also consider export filters to perform more fine-grained +replacements. See info node `(org)Advanced Export Configuration'." + :package-version '(Org . "9.8") + :type '(choice (const :tag "Leave forbidden characters as-is" t) + (const :tag "Err when forbidden characters encountered" n= il) + (string :tag "Replacement string"))) =20 ;;;; Debugging =20 @@ -2892,6 +2915,32 @@ (defun org-odt--encode-tabs-and-spaces (line) (format " " (1- (length s))))) line)) =20 +(defun org-odt--remove-forbidden (text _backend info) + "Remove forbidden and discouraged characters from TEXT. +INFO is the communication plist" + (pcase-exhaustive (plist-get info :odt-with-forbidden-chars) + ((and (pred stringp) rep) + (let ((replacements (make-hash-table :test 'equal))) + (with-temp-buffer + (insert text) + (goto-char (point-min)) + (while (re-search-forward org-odt-forbidden-char-re nil t) + (cl-incf (gethash (match-string 0) replacements 0)) + (replace-match rep)) + (cl-loop for forbidden being the hash-keys of replacements + using (hash-values count) + do (display-warning + '(ox-odt ox-odt-with-forbidden-chars) + (format "Replaced forbidden character '%s' with '%s'= %d times" + forbidden rep count))) + (buffer-string)))) + (`nil + (if (string-match org-odt-forbidden-char-re text) + (error "Forbidden character '%s' found. See `org-odt-with-forbid= den-chars'" + (match-string 0 text)) + text)) + ('t text))) + (defun org-odt--encode-plain-text (text &optional no-whitespace-filling) (dolist (pair '(("&" . "&") ("<" . "<") (">" . ">"))) (setq text (replace-regexp-in-string (car pair) (cdr pair) text t t))) --=20 2.47.1 --=-=-= Content-Type: text/plain -- Ihor Radchenko // yantar92, Org mode maintainer, Learn more about Org mode at . Support Org development at , or support my work at --=-=-=--