odfjs/scripts/odf/fillOdtTemplate.js

import { ZipReader, ZipWriter, BlobReader, BlobWriter, TextReader, Uint8ArrayReader, TextWriter, Uint8ArrayWriter } from '@zip.js/zip.js';

import {traverse} from '../DOMUtils.js'
import makeManifestFile from './makeManifestFile.js';

// fillOdtTemplate, getOdtTemplate, getOdtTextContent

/** @import {ODFManifest} from './makeManifestFile.js' */

/** @typedef {ArrayBuffer} ODTFile */

const ODTMimetype = 'application/vnd.oasis.opendocument.text'




// For a given string, split it into fixed parts and parts to replace

/**
 * @typedef TextPlaceToFill
 * @property { {expression: string, replacedString:string}[] } expressions
 * @property {(values: any) => void} fill
 */


/**
 * PPP : for now, expression is expected to be only an object property name or a dot-path
 * in the future, it will certainly be a JavaScript expression
 * securely evaluated within an hardernedJS Compartment https://hardenedjs.org/#compartment
 * @param {string} expression 
 * @param {any} context - data / global object
 * @return {any}
 */
function evaludateTemplateExpression(expression, context){
    const parts = expression.trim().split('.')

    let value = context;

    for(const part of parts){
        if(!value){
            return undefined
        }
        else{
            value = value[part]
        }
    }

    return value
}


/**
 * @param {string} str
 * @returns {TextPlaceToFill | undefined}
 */
function findPlacesToFillInString(str) {
    const matches = str.matchAll(/\{([^{#\/]+?)\}/g)

    /** @type {TextPlaceToFill['expressions']} */
    const expressions = []

    /** @type {(string | ((data:any) => void))[]} */
    const parts = []
    let remaining = str;

    for (const match of matches) {
        //console.log('match', match)
        const [matched, group1] = match

        const replacedString = matched
        const expression = group1.trim()
        expressions.push({ expression, replacedString })

        const [fixedPart, newRemaining] = remaining.split(replacedString, 2)

        if (fixedPart.length >= 1)
            parts.push(fixedPart)

        
        parts.push(data => evaludateTemplateExpression(expression, data))

        remaining = newRemaining
    }

    if (remaining.length >= 1)
        parts.push(remaining)

    //console.log('parts', parts)


    if (remaining === str) {
        // no match found
        return undefined
    }
    else {
        return {
            expressions,
            fill: (data) => {
                return parts.map(p => {
                    if (typeof p === 'string')
                        return p
                    else
                        return p(data)
                })
                    .join('')
            }
        }
    }


}



/**
 * 
 * @param {Node} startNode 
 * @param {string} iterableExpression 
 * @param {string} itemExpression 
 * @param {Node} endNode 
 * @param {any} data 
 * @param {typeof Node} Node
 */
function fillEachBlock(startNode, iterableExpression, itemExpression, endNode, data, Node){
    //console.log('fillEachBlock', iterableExpression, itemExpression)
    //console.log('startNode', startNode.nodeType, startNode.nodeName)
    //console.log('endNode', endNode.nodeType, endNode.nodeName)

    // find common ancestor
    let commonAncestor

    let startAncestor = startNode
    let endAncestor = endNode
    
    const startAncestry = new Set([startAncestor])
    const endAncestry = new Set([endAncestor]) 

    while(!startAncestry.has(endAncestor) && !endAncestry.has(startAncestor)){
        if(startAncestor.parentNode){
            startAncestor = startAncestor.parentNode
            startAncestry.add(startAncestor)
        }
        if(endAncestor.parentNode){
            endAncestor = endAncestor.parentNode
            endAncestry.add(endAncestor)
        }
    }

    if(startAncestry.has(endAncestor)){
        commonAncestor = endAncestor
    }
    else{
        commonAncestor = startAncestor
    }


    //console.log('commonAncestor', commonAncestor.tagName)
    //console.log('startAncestry', startAncestry.size, [...startAncestry].indexOf(commonAncestor))
    //console.log('endAncestry', endAncestry.size, [...endAncestry].indexOf(commonAncestor))

    const startAncestryToCommonAncestor = [...startAncestry].slice(0, [...startAncestry].indexOf(commonAncestor))
    const endAncestryToCommonAncestor = [...endAncestry].slice(0, [...endAncestry].indexOf(commonAncestor))

    const startChild = startAncestryToCommonAncestor.at(-1)
    const endChild = endAncestryToCommonAncestor.at(-1)

    //console.log('startChild', startChild.tagName)
    //console.log('endChild', endChild.tagName)

    // Find repeatable pattern and extract it in a documentFragment
    // @ts-ignore
    const repeatedFragment = startNode.ownerDocument.createDocumentFragment()

    /** @type {Element[]} */
    const repeatedPatternArray = []
    let sibling = startChild.nextSibling

    while(sibling !== endChild){
        repeatedPatternArray.push(sibling)
        sibling = sibling.nextSibling;
    }


    //console.log('repeatedPatternArray', repeatedPatternArray.length)

    for(const sibling of repeatedPatternArray){
        sibling.parentNode?.removeChild(sibling)
        repeatedFragment.appendChild(sibling)
    }

    // Find the iterable in the data
    // PPP eventually, evaluate the expression as a JS expression
    const iterable = evaludateTemplateExpression(iterableExpression, data)
    if(!iterable){
        throw new TypeError(`Missing iterable (${iterableExpression})`)
    }
    if(typeof iterable[Symbol.iterator] !== 'function'){
        throw new TypeError(`'${iterableExpression}' is not iterable`)
    }

    // create each loop result
    // using a for-of loop to accept all iterable values
    for(const item of iterable){
        /** @type {DocumentFragment} */
        // @ts-ignore
        const itemFragment = repeatedFragment.cloneNode(true)

        // recursive call to fillTemplatedOdtElement on itemFragment
        fillTemplatedOdtElement(
            itemFragment, 
            Object.assign({}, data, {[itemExpression]: item}),
            Node
        )
        // @ts-ignore
        commonAncestor.insertBefore(itemFragment, endChild)
    }

    startChild.parentNode.removeChild(startChild)
    endChild.parentNode.removeChild(endChild)
}


/**
 * 
 * @param {Element | DocumentFragment} rootElement 
 * @param {any} data 
 * @param {typeof Node} Node 
 * @returns {void}
 */
function fillTemplatedOdtElement(rootElement, data, Node){
    //console.log('fillTemplatedOdtElement', rootElement.nodeType, rootElement.nodeName)

    /** @type {Node | undefined} */
    let eachBlockStartNode
    /** @type {Node | undefined} */
    let eachBlockEndNode

    let nestedEach = 0

    let iterableExpression, itemExpression;

    // Traverse "in document order"

    // @ts-ignore
    traverse(rootElement, currentNode => {
        const insideAnEachBlock = !!eachBlockStartNode

        if(currentNode.nodeType === Node.TEXT_NODE){
            const text = currentNode.textContent || ''

            // looking for {#each x as y}
            const eachStartRegex = /{#each\s+([^}]+?)\s+as\s+([^}]+?)\s*}/g;
            const startMatches = [...text.matchAll(eachStartRegex)];

            if(startMatches && startMatches.length >= 1){
                if(insideAnEachBlock){
                    nestedEach = nestedEach + 1
                }
                else{
                    // PPP for now, consider only the first set of matches
                    // eventually, consider all of them for in-text-node {#each}...{/each}
                    let [_, _iterableExpression, _itemExpression] = startMatches[0]
                    
                    iterableExpression = _iterableExpression
                    itemExpression = _itemExpression
                    eachBlockStartNode = currentNode
                }
            }

            // trying to find an {/each}
            const eachEndRegex = /{\/each}/g
            const endMatches = [...text.matchAll(eachEndRegex)];

            if(endMatches && endMatches.length >= 1){                    
                if(!eachBlockStartNode)
                    throw new TypeError(`{/each} found without corresponding opening {#each x as y}`)
                
                if(nestedEach >= 1){
                    // ignore because it will be treated as part of the outer {#each}
                    nestedEach = nestedEach - 1
                }
                else{
                    eachBlockEndNode = currentNode
                    
                    // found an #each and its corresponding /each
                    // execute replacement loop
                    fillEachBlock(eachBlockStartNode, iterableExpression, itemExpression, eachBlockEndNode, data, Node)

                    eachBlockStartNode = undefined
                    iterableExpression = undefined
                    itemExpression = undefined 
                    eachBlockEndNode = undefined
                }
            }


            // Looking for variables for substitutions
            if(!insideAnEachBlock){
                if (currentNode.data) {
                    const placesToFill = findPlacesToFillInString(currentNode.data)

                    if(placesToFill){
                        const newText = placesToFill.fill(data)
                        const newTextNode = currentNode.ownerDocument?.createTextNode(newText)
                        currentNode.parentNode?.replaceChild(newTextNode, currentNode)
                    }
                }
            }
            else{
                // ignore because it will be treated as part of the {#each} block
            }
        }

        if(currentNode.nodeType === Node.ATTRIBUTE_NODE){
            // Looking for variables for substitutions
            if(!insideAnEachBlock){
                if (currentNode.value) {
                    const placesToFill = findPlacesToFillInString(currentNode.value)
                    if(placesToFill){
                        currentNode.value = placesToFill.fill(data)
                    }
                }
            }
            else{
                // ignore because it will be treated as part of the {#each} block
            }
        }
    })
}



/**
 * @param {ODTFile} odtTemplate
 * @param {any} data 
 * @param {Function} parseXML 
 * @param {typeof XMLSerializer.prototype.serializeToString} serializeToString 
 * @param {typeof Node} Node
 * @returns {Promise<ODTFile>}
 */
export default async function _fillOdtTemplate(odtTemplate, data, parseXML, serializeToString, Node) {

    const reader = new ZipReader(new Uint8ArrayReader(new Uint8Array(odtTemplate)));

    // Lire toutes les entrées du fichier ODT
    const entries = reader.getEntriesGenerator();

    // Créer un ZipWriter pour le nouveau fichier ODT
    const writer = new ZipWriter(new Uint8ArrayWriter());

    /** @type {ODFManifest} */
    const manifestFileData = {
        mediaType: ODTMimetype,
        version: '1.3', // default, but may be changed
        fileEntries: []
    }

    const keptFiles = new Set(['content.xml', 'styles.xml', 'mimetype'])


    // Parcourir chaque entrée du fichier ODT
    for await (const entry of entries) {
        const filename = entry.filename

        // remove other files
        if(!keptFiles.has(filename)){
            // ignore, do not create a corresponding entry in the new zip
        }
        else{
            let content;
            let options;
            
            switch(filename){
                case 'mimetype':
                    content = new TextReader(ODTMimetype)
                    options = {
                        level: 0,
                        compressionMethod: 0,
                        dataDescriptor: false,
                        extendedTimestamp: false,
                    }
                    break;
                case 'content.xml':
                    const contentXml = await entry.getData(new TextWriter());
                    const contentDocument = parseXML(contentXml);
                    fillTemplatedOdtElement(contentDocument, data, Node) 
                    const updatedContentXml = serializeToString(contentDocument)

                    const docContentElement = contentDocument.getElementsByTagName('office:document-content')[0]
                    const version = docContentElement.getAttribute('office:version')
                    
                    //console.log('version', version)
                    manifestFileData.version = version 
                    manifestFileData.fileEntries.push({
                        fullPath: filename,
                        mediaType: 'text/xml'
                    })

                    content = new TextReader(updatedContentXml)
                    options = {
                        lastModDate: entry.lastModDate,
                        level: 9
                    };
                    
                    break;
                case 'styles.xml':
                    const blobWriter = new BlobWriter();
                    await entry.getData(blobWriter);
                    const blob = await blobWriter.getData();
        
                    manifestFileData.fileEntries.push({
                        fullPath: filename,
                        mediaType: 'text/xml'
                    })

                    content = new BlobReader(blob)
                    break;
                default:
                    throw new Error(`Unexpected file (${filename})`)
            }

            await writer.add(filename, content, options);
        }

    }

    const manifestFileXml = makeManifestFile(manifestFileData)
    await writer.add('META-INF/manifest.xml', new TextReader(manifestFileXml));

    await reader.close();

    return writer.close();
}