add option to add watermark on pdf export

cyrilus · cyrilus · commit f8ccb3d27b3c · 2025-10-25T13:54:48.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -23,6 +23,7 @@ exports/
 /lotemplate/unittest/files/content/debug.json
 /lotemplate/unittest/files/content/*.unittest.odt
 /lotemplate/unittest/files/content/*.unittest.pdf
+/lotemplate/unittest/files/content/*.unittest_html_*.png
 /venv
 /lotemplate/unittest/files/content/e89fbedb61af3994184da3e5340bd9e9-calc_variables.ods.json
 /output*.*
diff --git a/API/utils.py b/API/utils.py
@@ -32,7 +32,7 @@ def start_soffice(workers,jsondir,maxt=60):
 
 
 def connexion():
-   global my_lo 
+   global my_lo
    cnx= ot.randomConnexion(my_lo)
 
    return cnx
@@ -178,7 +178,6 @@ def fill_file(directory: str, file: str, json, error_caught=False) -> Union[tupl
     :param error_caught: specify if an error was already caught
     :return: a json and optionally an int which represent the status code to return
     """
-
     if  isinstance(json, list):
         json=json[0]
         print("####\nUsing a list of dict is DEPRECATED, you must directly send the dict.")
@@ -192,33 +191,32 @@ def fill_file(directory: str, file: str, json, error_caught=False) -> Union[tupl
             is_name_present = type(json.get("name")) is str
             is_variables_present = type(json.get("variables")) is dict
             is_page_break_present = type(json.get("page_break")) is bool
-
+            is_watermark_present = type(json.get("watermark")) is dict
             if (
                     not is_name_present
                     or not is_variables_present
-                    or ((length > 2 and not is_page_break_present) or (length > 3 and is_page_break_present))
             ):
                 return 415, error_sim(
                     "JsonSyntaxError",
                     'api_invalid_instance_syntax',
                     "Each instance of the array in the json should be an object containing only 'name' - "
-                    "a non-empty string, 'variables' - a non-empty object, and, optionally, 'page_break' - "
-                    "a boolean.")
+                    "a non-empty string, 'variables' - a non-empty object, optionally, 'page_break' - "
+                    "a boolean and 'watermark' a json array.")
 
             try:
                 json_variables = ot.convert_to_datas_template(json["variables"])
                 temp.search_error(json_variables)
                 temp.fill(json["variables"])
                 if json.get('page_break', False):
                     temp.page_break()
-                export_file=temp.export(json["name"],"exports")
+                watermark=json.get("watermark",{})
+                export_file=temp.export(json["name"],"exports",False,watermark)
                 export_name=json["name"]
             except Exception as e:
                 if 'export_name' in locals():
                     return ( export_file,error_format(e))
                 else:
                     return ( "nofile",error_format(e))
-
             return (export_file,send_file(export_file, export_name))
 
     except Exception as e:
diff --git a/README.md b/README.md
@@ -56,11 +56,12 @@ The tool is written in Python and use a real LibreOffice headless to fill the te
 Table of content
 ----------------
 
-* [Principles](#installation)
+* [Principles](#principles)
 * [Quick Start](#quick_start)
 * [API and CLI Usage](#api-and-cli-usage)
 * [DOCX and ODT Template syntax and examples](#docx-and-odt-template-syntax)
 * [XLSX and ODS Template syntax and examples](#xlsx-and-ods-template-syntax)
+* [Add watermark when output in pdf](#watermark)
 * [Supported formats](#supported-formats)
 * [Doc for developpers of lotemplate](#doc-for-devs)
 * [Unsolvable problems](#unsolvable-problems)
@@ -242,8 +243,12 @@ optional arguments:
   -h, --help            show this help message and exit
   --json_file JSON_FILE , -jf JSON_FILE
                         Json files that must fill the template, if any
-  --json JSON , -j JSON 
+  --json JSON , -j JSON
                         Json strings that must fill the template, if any
+  --json_watermark_file JSON_FILE, -jwf JSON_FILE
+                        Json files to configure pdf watermark, if any
+  --json_watermark JSON , -jw JSON
+                        Json strings to configure pdf watermark, if any
   --output OUTPUT, -o OUTPUT
                         Names of the filled files, if the template should
                         be filled. supported formats: pdf, html, docx, png, odt
@@ -943,6 +948,51 @@ The principle is exactly the same as for LibreOffice Calc exept for the creation
 
 (sorry, my excel is in french...)
 
+<a name="watermark">Add watermark when output in pdf
+
+You can insert a watermark text in the page background when you are exporting in pdf.
+
+### Possible parameters
+
+| Name               | Description                                                                            | DefaultValue |
+|--------------------|----------------------------------------------------------------------------------------|--------------|
+| Watermark          | Specifies the text for a watermark to be drawn on every page of the exported PDF file. | empty        |
+| WatermarkColorRGB  | Specifies the color of the watermark text in RGB                                       |  236,236,236 |
+| WatermarkFontHeight| Specifies the font height of the watermark text.                                       |              |
+| WatermarkRotateAngle | Specifies angle of the watermark text in 1/10 degree.                                | 450          |
+| WatermarkFontName  | Specifies font name of the watermark text.                                             | Helvetica    |
+| TiledWatermark     | Specifies the tiled watermark text.                                                    |              |
+
+
+### Cli example
+
+create a file named watermark.json
+
+```json
+{
+"Watermark": "ttottoto",
+"WatermarkColorRGB" : "236,0,0"
+}
+
+```
+then you can used the cli like this
+
+```bash
+./lotemplate_cli.py --template_file lotemplate/unittest/files/templates/text_vars.odt --json_file lotemplate/unittest/files/jsons/text_vars_valid.json --output toto.pdf -jwf 'watermark.json'
+
+```
+
+
+### API example
+
+
+```bash
+
+# generate a file titi.pdf from a template and a json content
+ curl -X POST -H 'secretkey: DEFAULT_KEY' -H 'Content-Type: application/json' -d '{"name":"my_file.pdf","variables":{"my_tag":{"type":"text","value":"foo"},"other_tag":{"type":"text","value":"bar"}},"watermark": {"Watermark": "It s a draft","WatermarkColorRGB" : "236,200,0"}}' --output titi.pdf http://localhost:8000/test_dir1/test.odt
+
+```
+
 <a name="supported-formats"></a>Supported formats
 -------------------------------------------------
 
@@ -1043,5 +1093,5 @@ For Pyuno
 - [JODConverter wiki for list formats compatibles with LibreOffice](https://github.com/sbraconnier/jodconverter/wiki/Getting-Started)
 - [The unoconv source code, written in python with PyUNO](https://github.com/unoconv/unoconv/blob/master/unoconv)
 - [Unoconv source code for list formats - and properties - compatible with LibreOffice for export](https://github.com/unoconv/unoconv/blob/94161ec11ef583418a829fca188c3a878567ed84/unoconv#L391)
-
+- [convert color RGB to long color use for LibreOffice](https://help.libreoffice.org/latest/fr/text/sbasic/shared/03010305.html)
 
diff --git a/lotemplate/Template.py b/lotemplate/Template.py
@@ -13,20 +13,29 @@
 from typing import Union
 from sorcery import dict_of
 import unohelper
+import uno
 from com.sun.star.beans import PropertyValue
 from com.sun.star.io import IOException
 from com.sun.star.lang import IllegalArgumentException, DisposedException
 from com.sun.star.uno import RuntimeException
-
 from . import errors
 #from . import Connexion
-from .utils import get_file_url,get_cached_json 
+from .utils import get_file_url,get_cached_json
 
 
 import uuid
 import shutil
 import json
 
+def dict_to_property(values, uno_any=False):
+    ps = tuple([PropertyValue(Name=n, Value=v) for n, v in values.items()])
+    if uno_any:
+        ps = uno.Any('[]com.sun.star.beans.PropertyValue', ps)
+    return ps
+
+def rgb_to_long(rgb:tuple):
+    return int(rgb[0])*65536+int(rgb[1])*256+int(rgb[2])
+
 class Template:
 
     TMPDIR='/tmp'
@@ -205,7 +214,9 @@ def close(self) -> None:
         except FileNotFoundError:
             pass
 
-    def export(self, filename: str, dirname=None, no_uid=None )  -> Union[str, None]:
+
+
+    def export(self, filename: str, dirname=None, no_uid=None, my_filter_data=None )  -> Union[str, None]:
         """
         Exports the newly generated document, if any.
 
@@ -220,10 +231,27 @@ def export(self, filename: str, dirname=None, no_uid=None )  -> Union[str, None]
             path = os.getcwd() + "/" + dirname +  '/' + str(uuid.uuid4()) +filename
         url = unohelper.systemPathToFileUrl(path)
 
+
+        filter_data = {
+                #'EncryptFile': True,
+                #'DocumentOpenPassword': 'letmein',
+                'Watermark' : '',
+                'WatermarkColorRGB' : '236,236,236',
+                #'WatermarkColor' : 11316396,
+                'WatermarkRotateAngle' : 450,
+                'WatermarkFontName' : 'Helvetica',
+        }
+        if  isinstance(my_filter_data,dict) and bool(my_filter_data) and self.formats[file_type].endswith("pdf_Export"):
+            filter_data.update(my_filter_data)
+            filter_data['WatermarkColor']=rgb_to_long(tuple(filter_data['WatermarkColorRGB'].split(",")))
+
+        prop_filter_data = dict_to_property(filter_data, True)
         # list of available convert filters
         # cf https://help.libreoffice.org/latest/he/text/shared/guide/convertfilters.html
         try:
-            self.doc.storeToURL(url, (PropertyValue("FilterName", 0, self.formats[file_type], 0),))
+            self.doc.storeToURL(url, (PropertyValue("FilterName", 0,self.formats[file_type], 0),
+                                      PropertyValue("FilterData", 0,prop_filter_data, 0)),
+                                      )
         except KeyError:
             self.close()
             raise errors.ExportError('invalid_format',
diff --git a/lotemplate/unittest/files/content/text_watermark.expected.txt b/lotemplate/unittest/files/content/text_watermark.expected.txt
@@ -0,0 +1,2 @@
+jeanjhtr rah oeeeeee erg1 aejean 2zhefh qsg$ $ test
+my_good_watermark
diff --git a/lotemplate/unittest/files/content/text_watermark.json b/lotemplate/unittest/files/content/text_watermark.json
@@ -0,0 +1,8 @@
+{
+  "aerhh": {"type": "text", "value": "1"},
+  "h": {"type": "text", "value": "zhefh"},
+  "rh": {"type": "text", "value": "jean"},
+  "gjerg": {"type": "text", "value": "jhtr"},
+  "aet": {"type": "text", "value": "2"},
+  "jean": {"type": "text", "value": "rah oeeeeee"}
+}
diff --git a/lotemplate/unittest/files/content/text_watermark.odt b/lotemplate/unittest/files/content/text_watermark.odt
diff --git a/lotemplate/unittest/files/content/text_watermark.wk.json b/lotemplate/unittest/files/content/text_watermark.wk.json
@@ -0,0 +1 @@
+{"Watermark": "my_good_watermark","WatermarkColorRGB" : "236,200,0"}
diff --git a/lotemplate/unittest/test_content.py b/lotemplate/unittest/test_content.py
@@ -61,6 +61,9 @@ def test_counter(self):
     def test_text_var_in_header(self):
         self.assertTrue(compare_files('text_var_in_header', 'pdf',cnx=cnx))
 
+    def test_text_watermark(self):
+        self.assertTrue(compare_files('text_watermark','pdf',cnx=cnx,watermark=True))
+
     def test_too_many_endif_strange(self):
         self.assertTrue(compare_files('too_many_endif_strange',cnx=cnx))
 
diff --git a/lotemplate/unittest/test_function.py b/lotemplate/unittest/test_function.py
@@ -106,7 +106,7 @@ def get_filename(ext: str):
 
 
 
-def compare_files(name: str, format: str = 'txt',cnx = None):
+def compare_files(name: str, format: str = 'txt',cnx = None, watermark = False):
     if format not in ['txt', 'pdf']:
         return False
 
@@ -126,18 +126,21 @@ def get_filename(ext: str):
             return True
         else:
             raise FileNotFoundError('No file found for ' + name)
-
     temp.scan()
     temp.search_error(to_data(get_filename('json')))
     temp.fill(file_to_dict(get_filename('json')))
+    if watermark:
+        watermark_data=file_to_dict(get_filename('wk.json'))
+    else:
+        watermark_data={}
 
     if os.path.isfile(get_filename('unittest.'+format)):
         os.remove(get_filename('unittest.'+format))
-    temp.export(name+'.unittest.'+format,base_path, True)
+    temp.export(name+'.unittest.'+format,base_path, True,watermark_data)
     # temp.close()
     if os.path.isfile(get_filename('unittest.odt')):
         os.remove(get_filename('unittest.odt'))
-    temp.export(name+'.unittest.odt',base_path, True)
+    temp.export(name+'.unittest.odt',base_path, True, watermark_data)
     temp.close()
 
     # The PDF format is used to test some documents with headers or footers that are not supported by the text saveAs from
diff --git a/lotemplate_cli.py b/lotemplate_cli.py
@@ -28,6 +28,10 @@ def set_arguments() -> cparse.Namespace:
                    help="Json files that must fill the template, if any")
     p.add_argument('--json', '-j', 
                    help="Json strings that must fill the template, if any")
+    p.add_argument('--json_watermark_file', '-jwf', 
+                   help="Json files to configure pdf watermark, if any")
+    p.add_argument('--json_watermark', '-jw', 
+                   help="Json strings to configure pdf watermark, if any")
     p.add_argument('--output', '-o', default="output.pdf",
                    help="Names of the filled files, if the template should be filled. supported formats: "
                         "pdf, html, docx, png, odt")
@@ -47,11 +51,19 @@ def set_arguments() -> cparse.Namespace:
     p.add_argument('--json_cache_dir',nargs='?',  help="Specify a cache for the scanned json")
     args=p.parse_args()
     if not args.scan and not args.clean and not args.template_file and not args.stats:
-         p.error(" #######You need at minimun --scan or --clean or --template_file")
+         p.error(" ####### You need at minimun --scan or --clean or --template_file")
     elif (args.scan and not  args.template_file):
          p.error(" ####### with --scan you need --template_file")
     return args
 
+def load_json_file(file):
+    if ot.is_network_based(file):
+        json_variables = json.loads(urllib.request.urlopen(file).read())
+    else:
+        with open(file) as f:
+            json_variables = json.loads(f.read())
+    return json_variables
+
 if __name__ == '__main__':
     # get the necessaries arguments
     args = set_arguments()
@@ -68,7 +80,6 @@ def set_arguments() -> cparse.Namespace:
 
     if args.stats:
         print(json.dumps(ot.statistic_open_document(my_lo, args.maxtime)))
-   
         exit()
 
 
@@ -83,17 +94,17 @@ def set_arguments() -> cparse.Namespace:
 
     # fill and export the template if it should
     else:
-
+        json_watermark_variables={}
         # get the specified jsons
         json_dict = {}
         if args.json_file:
-            if ot.is_network_based(args.json_file):
-                json_variables = json.loads(urllib.request.urlopen(args.json_file).read())
-            else:
-                with open(args.json_file) as f:
-                    json_variables = json.loads(f.read())
+            json_variables = load_json_file(args.json_file) 
         if args.json:
             json_variables = json.loads(args.json)
+        if args.json_watermark_file:
+            json_watermark_variables = load_json_file(args.json_watermark_file) 
+        if args.json:
+            json_watermark_variables = json.loads(args.json_watermark)
 
         try:
             # scan for errors
@@ -105,10 +116,10 @@ def set_arguments() -> cparse.Namespace:
             path=os.path.dirname(args.output)
             if not path:
                path='exports'
-
             print(
                 "Document saved as " +
-                repr(document.export( filename, path, True))
+                repr(document.export( filename, path,
+                                     True,json_watermark_variables))
             )
         except Exception as exception:
             print('Ignoring exception on json :', file=sys.stderr)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+jeanjhtr rah oeeeeee erg1 aejean 2zhefh qsg$ $ test`
	`2`	`+my_good_watermark`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"Watermark": "my_good_watermark","WatermarkColorRGB" : "236,200,0"}`