#!/usr/bin/env python
#############################################################################
##
## Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
## Contact: http://www.qt-project.org/legal
##
## This file is part of the release tools of the Qt Toolkit.
##
## $QT_BEGIN_LICENSE:LGPL$
## Commercial License Usage
## Licensees holding valid commercial Qt licenses may use this file in
## accordance with the commercial license agreement provided with the
## Software or, alternatively, in accordance with the terms contained in
## a written agreement between you and Digia.  For licensing terms and
## conditions see http://qt.digia.com/licensing.  For further information
## use the contact form at http://qt.digia.com/contact-us.
##
## GNU Lesser General Public License Usage
## Alternatively, this file may be used under the terms of the GNU Lesser
## General Public License version 2.1 as published by the Free Software
## Foundation and appearing in the file LICENSE.LGPL included in the
## packaging of this file.  Please review the following information to
## ensure the GNU Lesser General Public License version 2.1 requirements
## will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
##
## In addition, as a special exception, Digia gives you certain additional
## rights.  These rights are described in the Digia Qt LGPL Exception
## version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
##
## GNU General Public License Usage
## Alternatively, this file may be used under the terms of the GNU
## General Public License version 3.0 as published by the Free Software
## Foundation and appearing in the file LICENSE.GPL included in the
## packaging of this file.  Please review the following information to
## ensure the GNU General Public Lhttps://www.google.fi/icense version 3.0 requirements will be
## met: http://www.gnu.org/copyleft/gpl.html.
##
##
## $QT_END_LICENSE$
##
#############################################################################

from __future__ import print_function
import os
import shutil
import sys
import multiprocessing
import bldinstallercommon
bldinstallercommon.init_common_module(os.path.dirname(os.path.realpath(__file__)))

def handle_extra_module_doc_build():
    if not bldinstallercommon.is_linux_platform():
        print('*** Only Linux platform supported currently to perform doc builds. Aborting')
        sys.exit(-1)
    if not os.environ.get('APPLICATION_NAME'):
        print('*** APPLICATION_NAME environment variable not defined. Unable to generate doc for this package.')
        sys.exit(-1)
    if not os.environ.get('EXTRA_MODULE_SRC_PACKAGE_URI'):
        print('*** EXTRA_MODULE_SRC_PACKAGE_URI environment variable not defined. Unable to generate doc for this package.')
        sys.exit(-1)
    if not os.environ.get('EXTRA_MODULE_DOC_BUILD_QT5_PACKAGE_URI'):
        print('*** EXTRA_MODULE_DOC_BUILD_QT5_PACKAGE_URI environment variable not defined. Unable to generate doc for this package.')
        sys.exit(-1)
    if not os.environ.get('EXTRA_MODULE_DOC_BUILD_QT5_ICU_PACKAGE_URI'):
        print('*** EXTRA_MODULE_DOC_BUILD_QT5_ICU_PACKAGE_URI environment variable not defined. Unable to generate doc for this package.')
        sys.exit(-1)
    extra_module_src_package_uri = os.environ['EXTRA_MODULE_SRC_PACKAGE_URI']
    extra_module_doc_build_qt5_package_uri = os.environ['EXTRA_MODULE_DOC_BUILD_QT5_PACKAGE_URI']
    extra_module_doc_build_qt5_icu_package_uri = os.environ['EXTRA_MODULE_DOC_BUILD_QT5_ICU_PACKAGE_URI']
    # define some paths
    current_path = os.path.dirname(os.path.realpath(__file__))
    qt5_package_path = os.path.join(current_path, 'doc_build_qt5_package')
    if os.path.exists(qt5_package_path):
        print('*** Deleted existing qt5 package directory (for doc build) before setting up the new one: '.format(qt5_package_path))
        shutil.rmtree(qt5_package_path)
    qt5_icu_path = os.path.join(current_path, 'doc_build_qt5_icu_package')
    if os.path.exists(qt5_icu_path):
        print('*** Deleted existing qt5 icu directory (for doc build) before setting up the new one: '.format(qt5_icu_path))
        shutil.rmtree(qt5_icu_path)
    extra_module_src_path = os.path.join(current_path, 'extra_module_src_package')
    if os.path.exists(extra_module_src_path):
        print('*** Deleted existing extra module package directory before setting up the new one: '.format(extra_module_src_path))
        shutil.rmtree(extra_module_src_path)
    bldinstallercommon.create_dirs(qt5_package_path)
    bldinstallercommon.create_dirs(extra_module_src_path)
    bldinstallercommon.create_dirs(qt5_icu_path)
    # fetch extra module src package
    raw_name_extra_module_src_package = extra_module_src_package_uri.rsplit('/',1)[-1] # get last item from array
    downloaded_extra_module_archive = os.path.join(current_path, raw_name_extra_module_src_package)
    if os.path.lexists(downloaded_extra_module_archive):
        print('*** Deleted existing extra module src package: [{0}] before fetching the new one.{0}'.format(downloaded_extra_module_archive))
        os.remove(downloaded_extra_module_archive)
    print('Starting to download: {0}'.format(extra_module_src_package_uri))
    bldinstallercommon.retrieve_url(extra_module_src_package_uri, downloaded_extra_module_archive)
    bldinstallercommon.extract_file(downloaded_extra_module_archive, extra_module_src_path)
    # fetch qt5 binary package
    raw_name_qt5_bin_package = extra_module_doc_build_qt5_package_uri.rsplit('/',1)[-1] # get last item from array
    downloaded_qt5_bin_archive = os.path.join(current_path, raw_name_qt5_bin_package)
    if os.path.lexists(downloaded_qt5_bin_archive):
        print('*** Deleted existing qt5 binary package: [{0}] before fetching the new one.'.format(downloaded_qt5_bin_archive))
        os.remove(downloaded_qt5_bin_archive)
    print('Starting to download: {0}'.format(extra_module_doc_build_qt5_package_uri))
    bldinstallercommon.retrieve_url(extra_module_doc_build_qt5_package_uri, downloaded_qt5_bin_archive)
    bldinstallercommon.extract_file(downloaded_qt5_bin_archive, qt5_package_path)
    # fetch qt5 icu binary package
    raw_name_qt5_icu_package = extra_module_doc_build_qt5_icu_package_uri.rsplit('/',1)[-1] # get last item from array
    downloaded_qt5_icu_archive = os.path.join(current_path, raw_name_qt5_icu_package)
    if os.path.lexists(downloaded_qt5_icu_archive):
        print('*** Deleted existing qt5 icu package: [{0}] before fetching the new one.'.format(downloaded_qt5_icu_archive))
        os.remove(downloaded_qt5_icu_archive)
    print('Starting to download: {0}'.format(extra_module_doc_build_qt5_icu_package_uri))
    bldinstallercommon.retrieve_url(extra_module_doc_build_qt5_icu_package_uri, downloaded_qt5_icu_archive)
    qt5_lib_directory = bldinstallercommon.locate_directory(qt5_package_path, 'lib')
    bldinstallercommon.extract_file(downloaded_qt5_icu_archive, qt5_lib_directory)
    # patch Qt5 package
    qt5_bin_directory = bldinstallercommon.locate_directory(qt5_package_path, 'bin')
    if not os.path.exists(qt5_bin_directory):
        print('*** Unable to locate bin directory from: {0}'.format(qt5_bin_directory))
        sys.exit(-1)
    qtConfFile = open(os.path.join(qt5_bin_directory, 'qt.conf'), "w")
    qtConfFile.write("[Paths]" + os.linesep)
    qtConfFile.write("Prefix=.." + os.linesep)
    qtConfFile.close()
    qt5_directory = os.path.dirname(qt5_bin_directory)
    bldinstallercommon.handle_component_rpath(qt5_directory, 'lib')
    # locate tools
    qmake_binary = bldinstallercommon.locate_executable(qt5_directory, 'qmake')
    print('Using qmake from: {0}'.format(qmake_binary))
    # locate extra module .pro file
    extra_module_pro_file = bldinstallercommon.locate_file(extra_module_src_path, '*.pro')
    # build extra module
    extra_module_build_environment = dict(os.environ)
    extra_module_build_environment["LD_LIBRARY_PATH"] = qt5_lib_directory
    extra_module_build_environment["QMAKESPEC"] = "linux-g++"
    cpu_count = ["-j" + str(multiprocessing.cpu_count() + 1)]
    print('Using .pro file from: {0}'.format(extra_module_pro_file))
    bld_args = [qmake_binary, extra_module_pro_file]
    bldinstallercommon.do_execute_sub_process(bld_args, os.path.dirname(extra_module_pro_file), True, False, extra_module_build_environment)
    bld_args = ['make'] + cpu_count
    bldinstallercommon.do_execute_sub_process(bld_args, os.path.dirname(extra_module_pro_file), True, False, extra_module_build_environment)
    # make docs
    bld_args = ['make', '-j1', 'docs']
    bldinstallercommon.do_execute_sub_process(bld_args, os.path.dirname(extra_module_pro_file), True, False, extra_module_build_environment)
    # make install docs
    extra_module_doc_install_dir = extra_module_src_path = os.path.join(current_path, 'extra_module_doc_install_dir')
    bld_args = ['make', '-j1', 'install_docs', 'INSTALL_ROOT=' + extra_module_doc_install_dir]
    bldinstallercommon.do_execute_sub_process(bld_args, os.path.dirname(extra_module_pro_file), True, False, extra_module_build_environment)
    # create archive
    doc_dir = bldinstallercommon.locate_directory(extra_module_doc_install_dir, 'doc')
    archive_name = os.environ['APPLICATION_NAME'] + '-' + os.environ['LICENSE'] + '-doc-' + os.environ['APPLICATION_VERSION'] + '.7z'
    archive_path = os.path.join(current_path, 'doc_archives', archive_name)
    bld_args = ['7z', 'a', archive_path, 'doc']
    bldinstallercommon.do_execute_sub_process(bld_args, os.path.dirname(doc_dir), True)
    if os.path.exists(archive_path):
        print('Doc archive generated successfully: {0}'.format(archive_path))