""" Copyright (c) 2014 Congressus, The Netherlands Copyright (c) 2017-2023 Raphael Michel and contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. """ import xml.etree.ElementTree as ET from collections import OrderedDict from .utils import decimal_str_to_int, int_to_decimal_str, make_msg_id from .validation import try_valid_xml class SepaPaymentInitn: def __init__(self, config, schema, clean=True): """ Constructor. Checks the config, prepares the document and builds the header. @param param: The config dict. @raise exception: When the config file is invalid. """ self._config = None # Will contain the config file. self._xml = None # Will contain the final XML file. self._batches = OrderedDict() # Will contain the SEPA batches. self._batch_totals = OrderedDict() # Will contain the total amount to debit per batch for checksum total. self.schema = schema self.msg_id = make_msg_id() self.clean = clean config_result = self.check_config(config) if config_result: self._config = config if self.clean: from text_unidecode import unidecode self._config['name'] = unidecode(self._config['name'])[:70] self._prepare_document() self._create_header() def _prepare_document(self): """ Build the main document node and set xml namespaces. """ self._xml = ET.Element("Document") self._xml.set("xmlns", "urn:iso:std:iso:20022:tech:xsd:" + self.schema) self._xml.set("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance") ET.register_namespace("", "urn:iso:std:iso:20022:tech:xsd:" + self.schema) ET.register_namespace("xsi", "http://www.w3.org/2001/XMLSchema-instance") n = ET.Element(self.root_el) self._xml.append(n) def _create_header(self): raise NotImplementedError() def _finalize_batch(self): raise NotImplementedError() def export(self, validate=True, pretty_print=False): """ Method to output the xml as string. It will finalize the batches and then calculate the checksums (amount sum and transaction count), fill these into the group header and output the XML. @param pretty_print: uses Python's xml.dom.minidom.Node.toprettyxml to make it easier to read for humans """ self._finalize_batch() ctrl_sum_total = 0 nb_of_txs_total = 0 for ctrl_sum in self._xml.iter('CtrlSum'): if ctrl_sum.text is None: continue ctrl_sum_total += decimal_str_to_int(ctrl_sum.text) for nb_of_txs in self._xml.iter('NbOfTxs'): if nb_of_txs.text is None: continue nb_of_txs_total += int(nb_of_txs.text) n = self._xml.find(self.root_el) GrpHdr_node = n.find('GrpHdr') CtrlSum_node = GrpHdr_node.find('CtrlSum') NbOfTxs_node = GrpHdr_node.find('NbOfTxs') CtrlSum_node.text = int_to_decimal_str(ctrl_sum_total) NbOfTxs_node.text = str(nb_of_txs_total) # Prepending the XML version is hacky, but cElementTree only offers this # automatically if you write to a file, which we don't necessarily want. out = b"" + ET.tostring( self._xml, "utf-8") if pretty_print: from xml.dom import minidom out_minidom = minidom.parseString(out) out = out_minidom.toprettyxml(encoding="utf-8") if validate: try_valid_xml(out, self.schema) return out