openuds-gui/toUDS.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Copyright (c) 2018 Virtual Cable S.L.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without modification,
# are permitted provided that the following conditions are met:
#
#    * Redistributions of source code must retain the above copyright notice,
#      this list of conditions and the following disclaimer.
#    * Redistributions in binary form must reproduce the above copyright notice,
#      this list of conditions and the following disclaimer in the documentation
#      and/or other materials provided with the distribution.
#    * Neither the name of Virtual Cable S.L. nor the names of its contributors
#      may be used to endorse or promote products derived from this software
#      without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import os
import shutil
import glob
import re
import typing

DIST = 'dist/browser'
THIRD_PARTY_LICENSES = 'dist/3rdpartylicenses.txt'
SRC = 'src'
UDS = os.path.join(DIST, 'uds')
STATIC = 'static/modern'
TEMPLATE = 'templates/uds/modern'


def make_path(path) -> None:
    folder = ''
    for p in path.split(os.path.sep):
        folder = os.path.join(folder, p)
        try:
            os.mkdir(folder)
        except OSError:
            pass  # Already exits, ignore


def locate_files(files: typing.List[str], folder: str, extension: str) -> None:
    for f in glob.glob(folder+"/*"):
        if os.path.isdir(f):
            # Recurse
            locate_files(files, os.path.join(f), extension)
        else:
            if os.path.splitext(f)[1][1:].lower() == extension:
                files.append(f)


def locate_html_files() -> typing.List[str]:
    files: typing.List[str] = []
    locate_files(files, SRC, 'html')
    return files


def locate_typescript_files() -> typing.List[str]:
    files: typing.List[str] = []
    locate_files(files, SRC, 'ts')
    return files


def fix_index_html() -> None:
    print('Fixing index.html...')
    translations = '<script type="text/javascript" src="{% url \'utility.jsCatalog\' LANGUAGE_CODE %}"></script>'
    jsdata = '<script type="text/javascript" src="{% url \'utility.js\' %}"></script>'
    csrfData = "var csrf = {  csrfToken: '{{ csrf_token }}',  csrfField: '{{ csrf_field }}' };"
    csrfRE = re.compile(r'// CSRF.*// ENDCSRF', re.MULTILINE | re.DOTALL)
    # Change index.html, to include django required stuff
    translatePattern = re.compile(
        '<!-- DYNAMIC_DATA -->.*<!-- ENDDYNAMIC_DATA -->', re.MULTILINE | re.DOTALL)
    with open(os.path.join(DIST, 'index.html'), 'r', encoding='utf8') as f:
        html = f.read()
    # include django headers
    html = '{% load i18n %}{% get_current_language as LANGUAGE_CODE %}' + html
    # Change <html lang="en"> with {{ LANGUAGE_CODE }}
    html = re.sub('<html lang="en">',
                  '<html lang="{{ LANGUAGE_CODE }}">', html)
    # Add link rel style.. to our theme stylesheet AFTER all index styles
    html = re.sub('</head>',
                  '<link rel="stylesheet" href="{% url \'custom\' \'styles.css\' %}"></head>', html)
    html = csrfRE.sub(csrfData, html)
    html = translatePattern.sub(translations + jsdata, html)

    with open(os.path.join(os.path.join(UDS, TEMPLATE), 'index.html'), 'w', encoding='utf8') as f:
        f.write(translatePattern.sub(translations + jsdata, html))


def extract_translations():
    print('Extracting translations from HTML')
    # Generate "fake" translations file (just to use django translator)

    def getTranslations(locator, pattern, output, strip=True):
        for fileName in locator():
            with open(fileName, 'r', encoding='utf8') as f:
                data = f.read()
                # Locate pattern
                for v in pattern.finditer(data):
                    s = v.groupdict()['data']
                    if strip:
                        s = s.replace('\n', ' ').replace('\r', ' ').strip()
                    s = s.replace('\n', '\\n').replace('\r', '\\r').replace('"', '\\"')

                    # print('Found string {}'.format(s))
                    print('gettext("{}");'.format(s), file=output)

    with open(os.path.join(os.path.join(UDS, STATIC), 'translations-fakejs.js'), 'w', encoding='utf8') as output:
        print('// "Fake" javascript file for translations', file=output)

        # First, extract translations from typescript
        typeScriptTranslationPattern = re.compile(r'django\.gettext\(\s*([\'"])(?P<data>.*?)\1\)')
        print('// Typescript', file=output)
        getTranslations(locate_typescript_files, typeScriptTranslationPattern, output, strip=False)

        # Now extract translations from html
        htmlTranslationPattern = re.compile(r'<uds-translate[^>]*>(?P<data>.*?)</uds-translate>', re.MULTILINE | re.IGNORECASE | re.DOTALL)
        print('// HTML', file=output)
        getTranslations(locate_html_files, htmlTranslationPattern, output)


def copy_images():
    print('Copying images')
    outputPath = os.path.join(UDS, STATIC, 'img')
    make_path(outputPath)
    for f in glob.glob(DIST + '/static/modern/img/*'):
        shutil.copy(f, outputPath)

def copy_third_party_licenses() -> None:
    print('Copying third party licenses')
    shutil.copy(THIRD_PARTY_LICENSES, os.path.join(UDS, STATIC))

def organize():
    print('Organizing content')
    for f in glob.glob(DIST + '/*'):
        if os.path.isdir(f):
            continue    # Skip folders
        if os.path.splitext(f)[1] == '.html':
            continue    # Also skip html
        shutil.copy(f, os.path.join(UDS, STATIC))


def clean_up():
    print('Cleaning unneeded content')
    folder = os.path.join(UDS, STATIC)
    os.unlink(os.path.join(folder, 'favicon.ico'))


def create_output_folders():
    try:
        print('Creating output uds dir...')
        os.mkdir(UDS)
    except OSError:
        print('Already exists, cleaning content')
        shutil.rmtree(UDS)  # Clean UDS dir
        os.mkdir(UDS)

    # Static folders
    make_path(os.path.join(UDS, STATIC))
    make_path(os.path.join(UDS, TEMPLATE))

#
# def buildSource():
#    os.system('ng build --prod --output-hashing=none --aot --deleteOutputPath --build-optimizer --deploy-url /uds/res/modern/ --base-href /uds/page')


def main():
    print('Use "yarn build" to correctly build for UDS')
    # buildSource()
    create_output_folders()
    extract_translations()
    fix_index_html()
    copy_images()
    organize()
    clean_up()


# Updades index.html
if __name__ == "__main__":
    main()
Added post processing script for deployment 2018-05-11 13:05:29 +03:00			`#!/usr/bin/env python3`
			`# -- coding: utf-8 --`
			`#`
			`# Copyright (c) 2018 Virtual Cable S.L.`
			`# All rights reserved.`
			`#`
			`# Redistribution and use in source and binary forms, with or without modification,`
			`# are permitted provided that the following conditions are met:`
			`#`
			`# * Redistributions of source code must retain the above copyright notice,`
			`# this list of conditions and the following disclaimer.`
			`# * Redistributions in binary form must reproduce the above copyright notice,`
			`# this list of conditions and the following disclaimer in the documentation`
			`# and/or other materials provided with the distribution.`
			`# * Neither the name of Virtual Cable S.L. nor the names of its contributors`
			`# may be used to endorse or promote products derived from this software`
			`# without specific prior written permission.`
			`#`
			`# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"`
			`# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE`
			`# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE`
			`# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR`
			`# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER`
			`# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,`
			`# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE`
			`# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.`

			`import os`
			`import shutil`
			`import glob`
			`import re`
Removed CSRF from js and generated it on html 2022-05-20 10:01:51 +03:00			`import typing`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00
upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`DIST = 'dist/browser'`
			`THIRD_PARTY_LICENSES = 'dist/3rdpartylicenses.txt'`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00			`SRC = 'src'`
			`UDS = os.path.join(DIST, 'uds')`
			`STATIC = 'static/modern'`
			`TEMPLATE = 'templates/uds/modern'`


upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`def make_path(path) -> None:`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00			`folder = ''`
			`for p in path.split(os.path.sep):`
			`folder = os.path.join(folder, p)`
			`try:`
			`os.mkdir(folder)`
advancing 2018-05-14 14:10:29 +03:00			`except OSError:`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00			`pass # Already exits, ignore`

adding types and advancing on services 2018-08-31 06:46:36 +03:00
upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`def locate_files(files: typing.List[str], folder: str, extension: str) -> None:`
Fixed 2018-05-22 02:40:52 +03:00			`for f in glob.glob(folder+"/*"):`
			`if os.path.isdir(f):`
			`# Recurse`
upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`locate_files(files, os.path.join(f), extension)`
Fixed 2018-05-22 02:40:52 +03:00			`else:`
			`if os.path.splitext(f)[1][1:].lower() == extension:`
			`files.append(f)`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00
adding types and advancing on services 2018-08-31 06:46:36 +03:00
upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`def locate_html_files() -> typing.List[str]:`
Removed CSRF from js and generated it on html 2022-05-20 10:01:51 +03:00			`files: typing.List[str] = []`
upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`locate_files(files, SRC, 'html')`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00			`return files`

adding types and advancing on services 2018-08-31 06:46:36 +03:00
upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`def locate_typescript_files() -> typing.List[str]:`
Removed CSRF from js and generated it on html 2022-05-20 10:01:51 +03:00			`files: typing.List[str] = []`
upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`locate_files(files, SRC, 'ts')`
Fixed 2018-05-22 02:40:52 +03:00			`return files`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00
adding types and advancing on services 2018-08-31 06:46:36 +03:00
upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`def fix_index_html() -> None:`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00			`print('Fixing index.html...')`
Moving urils to new locations, etc.. 2018-09-20 10:46:52 +03:00			`translations = '<script type="text/javascript" src="{% url \'utility.jsCatalog\' LANGUAGE_CODE %}"></script>'`
			`jsdata = '<script type="text/javascript" src="{% url \'utility.js\' %}"></script>'`
Removed CSRF from js and generated it on html 2022-05-20 10:01:51 +03:00			`csrfData = "var csrf = { csrfToken: '{{ csrf_token }}', csrfField: '{{ csrf_field }}' };"`
			`csrfRE = re.compile(r'// CSRF.*// ENDCSRF', re.MULTILINE \| re.DOTALL)`
			`# Change index.html, to include django required stuff`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00			`translatePattern = re.compile(`
			`'<!-- DYNAMIC_DATA -->.*<!-- ENDDYNAMIC_DATA -->', re.MULTILINE \| re.DOTALL)`
			`with open(os.path.join(DIST, 'index.html'), 'r', encoding='utf8') as f:`
			`html = f.read()`
			`# include django headers`
removed uds from load modules django part 2018-10-07 09:45:37 +03:00			`html = '{% load i18n %}{% get_current_language as LANGUAGE_CODE %}' + html`
updated 2018-05-16 08:12:22 +03:00			`# Change <html lang="en"> with {{ LANGUAGE_CODE }}`
adding types and advancing on services 2018-08-31 06:46:36 +03:00			`html = re.sub('<html lang="en">',`
			`'<html lang="{{ LANGUAGE_CODE }}">', html)`
fixes 2018-10-06 08:24:55 +03:00			`# Add link rel style.. to our theme stylesheet AFTER all index styles`
			`html = re.sub('</head>',`
			`'<link rel="stylesheet" href="{% url \'custom\' \'styles.css\' %}"></head>', html)`
Removed CSRF from js and generated it on html 2022-05-20 10:01:51 +03:00			`html = csrfRE.sub(csrfData, html)`
			`html = translatePattern.sub(translations + jsdata, html)`

Added post processing script for deployment 2018-05-11 13:05:29 +03:00			`with open(os.path.join(os.path.join(UDS, TEMPLATE), 'index.html'), 'w', encoding='utf8') as f:`
			`f.write(translatePattern.sub(translations + jsdata, html))`


upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`def extract_translations():`
Fixed 2018-05-22 02:40:52 +03:00			`print('Extracting translations from HTML')`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00			`# Generate "fake" translations file (just to use django translator)`
Fixed 2018-05-22 02:40:52 +03:00
fixed trans xtractor 2019-04-04 12:31:57 +03:00			`def getTranslations(locator, pattern, output, strip=True):`
Fixed 2018-05-22 02:40:52 +03:00			`for fileName in locator():`
			`with open(fileName, 'r', encoding='utf8') as f:`
			`data = f.read()`
			`# Locate pattern`
			`for v in pattern.finditer(data):`
fixed trans xtractor 2019-04-04 12:31:57 +03:00			`s = v.groupdict()['data']`
			`if strip:`
Fixed toUDS 2024-08-07 20:52:19 +03:00			`s = s.replace('\n', ' ').replace('\r', ' ').strip()`
			`s = s.replace('\n', '\\n').replace('\r', '\\r').replace('"', '\\"')`
upgraded 2019-04-04 11:30:52 +03:00
Fixed toUDS 2024-08-07 20:52:19 +03:00			`# print('Found string {}'.format(s))`
upgraded 2019-04-04 11:30:52 +03:00			`print('gettext("{}");'.format(s), file=output)`
Fixed 2018-05-22 02:40:52 +03:00
Added post processing script for deployment 2018-05-11 13:05:29 +03:00			`with open(os.path.join(os.path.join(UDS, STATIC), 'translations-fakejs.js'), 'w', encoding='utf8') as output:`
			`print('// "Fake" javascript file for translations', file=output)`

Fixed 2018-05-22 02:40:52 +03:00			`# First, extract translations from typescript`
fixed regex 2019-04-04 12:11:43 +03:00			`typeScriptTranslationPattern = re.compile(r'django\.gettext\(\s([\'"])(?P<data>.?)\1\)')`
Fixed 2018-05-22 02:40:52 +03:00			`print('// Typescript', file=output)`
upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`getTranslations(locate_typescript_files, typeScriptTranslationPattern, output, strip=False)`
Fixed 2018-05-22 02:40:52 +03:00
			`# Now extract translations from html`
fixed toUDS.py 2020-02-28 11:27:22 +03:00			`htmlTranslationPattern = re.compile(r'<uds-translate[^>]>(?P<data>.?)</uds-translate>', re.MULTILINE \| re.IGNORECASE \| re.DOTALL)`
Fixed 2018-05-22 02:40:52 +03:00			`print('// HTML', file=output)`
upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`getTranslations(locate_html_files, htmlTranslationPattern, output)`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00
adding types and advancing on services 2018-08-31 06:46:36 +03:00
upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`def copy_images():`
adding types and advancing on services 2018-08-31 06:46:36 +03:00			`print('Copying images')`
			`outputPath = os.path.join(UDS, STATIC, 'img')`
upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`make_path(outputPath)`
adding types and advancing on services 2018-08-31 06:46:36 +03:00			`for f in glob.glob(DIST + '/static/modern/img/*'):`
			`shutil.copy(f, outputPath)`

upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`def copy_third_party_licenses() -> None:`
			`print('Copying third party licenses')`
			`shutil.copy(THIRD_PARTY_LICENSES, os.path.join(UDS, STATIC))`
adding types and advancing on services 2018-08-31 06:46:36 +03:00
Added post processing script for deployment 2018-05-11 13:05:29 +03:00			`def organize():`
			`print('Organizing content')`
			`for f in glob.glob(DIST + '/*'):`
			`if os.path.isdir(f):`
			`continue # Skip folders`
			`if os.path.splitext(f)[1] == '.html':`
			`continue # Also skip html`
			`shutil.copy(f, os.path.join(UDS, STATIC))`

adding types and advancing on services 2018-08-31 06:46:36 +03:00
upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`def clean_up():`
updated 2018-05-16 08:12:22 +03:00			`print('Cleaning unneeded content')`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00			`folder = os.path.join(UDS, STATIC)`
			`os.unlink(os.path.join(folder, 'favicon.ico'))`


upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`def create_output_folders():`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00			`try:`
updated 2018-05-16 08:12:22 +03:00			`print('Creating output uds dir...')`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00			`os.mkdir(UDS)`
			`except OSError:`
			`print('Already exists, cleaning content')`
			`shutil.rmtree(UDS) # Clean UDS dir`
			`os.mkdir(UDS)`

			`# Static folders`
upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`make_path(os.path.join(UDS, STATIC))`
			`make_path(os.path.join(UDS, TEMPLATE))`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00
advancing 2018-05-14 14:10:29 +03:00			`#`
			`# def buildSource():`
advancing 2018-09-12 10:41:21 +03:00			`# os.system('ng build --prod --output-hashing=none --aot --deleteOutputPath --build-optimizer --deploy-url /uds/res/modern/ --base-href /uds/page')`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00
adding types and advancing on services 2018-08-31 06:46:36 +03:00
Added post processing script for deployment 2018-05-11 13:05:29 +03:00			`def main():`
advancing 2018-05-14 14:10:29 +03:00			`print('Use "yarn build" to correctly build for UDS')`
			`# buildSource()`
upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`create_output_folders()`
			`extract_translations()`
			`fix_index_html()`
			`copy_images()`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00			`organize()`
upgraded user interface (Angular 18) 2024-06-20 05:24:03 +03:00			`clean_up()`
Added post processing script for deployment 2018-05-11 13:05:29 +03:00

			`# Updades index.html`
			`if __name__ == "__main__":`
			`main()`