Difference between revisions of "OS4X plugin os4xplugin utf8 bom check"

From OS4X
Jump to navigation Jump to search
(Created page with "Category:Plugins == Purpose == Verify every XML file of the job to have a valid UTF-8 BOM header contained in the file. The BOM header for UTF-8 is the following three byt...")
 
 
Line 9: Line 9:
  
 
== Configuration ==
 
== Configuration ==
- none -
+
*Check any filetype, not only XML: if enabled, not only XML documents will be checked if the BOM header is present.
 +
*Add required BOM instead of aborting job: If enabled, the required BOM header will be added to the file. ''Beware: this is a RAM intensive task, holding the complete file in memory!''
  
 
== Remarks ==
 
== Remarks ==
 
Only files which can be interpreted correctly as XML will be verified, other files will be ignored. The suffix of the file doesn't count, only the content.
 
Only files which can be interpreted correctly as XML will be verified, other files will be ignored. The suffix of the file doesn't count, only the content.

Latest revision as of 13:01, 27 March 2025

Purpose

Verify every XML file of the job to have a valid UTF-8 BOM header contained in the file. The BOM header for UTF-8 is the following three bytes sequence:

0xEF 0xBB 0xBF

If any of the XML files doesn't contain the BOM header, the job aborts instantly.

Requirements

  • OS4X Enterprise license

Configuration

  • Check any filetype, not only XML: if enabled, not only XML documents will be checked if the BOM header is present.
  • Add required BOM instead of aborting job: If enabled, the required BOM header will be added to the file. Beware: this is a RAM intensive task, holding the complete file in memory!

Remarks

Only files which can be interpreted correctly as XML will be verified, other files will be ignored. The suffix of the file doesn't count, only the content.