Merge pull request '[jsdoc][plugins] Fixed reading common methods' (#28) from fix/build-jsdoc-plugins into release/v8.3.0

Reviewed-on: https://git.onlyoffice.com/ONLYOFFICE/build_tools/pulls/28

Dockerfile

@@ -11,5 +11,4 @@ RUN rm /usr/bin/python && ln -s /usr/bin/python2 /usr/bin/python
 ADD . /build_tools
 WORKDIR /build_tools
 
-CMD cd tools/linux && \
-    python3 ./automate.py
+CMD ["sh", "-c", "cd tools/linux && python3 ./automate.py"]

make.py

@@ -92,6 +92,8 @@ if config.check_option("module", "desktop"):
     config.extend_option("config", "updmodule")
     base.set_env("DESKTOP_URL_UPDATES_MAIN_CHANNEL", "https://download.onlyoffice.com/install/desktop/editors/windows/onlyoffice/appcast.json")
     base.set_env("DESKTOP_URL_UPDATES_DEV_CHANNEL", "https://download.onlyoffice.com/install/desktop/editors/windows/onlyoffice/appcastdev.json")
+    base.set_env("DESKTOP_URL_INSTALL_CHANNEL", "https://download.onlyoffice.com/install/desktop/editors/windows/distrib/onlyoffice/<file>")
+    base.set_env("DESKTOP_URL_INSTALL_DEV_CHANNEL", "https://download.onlyoffice.com/install/desktop/editors/windows/onlyoffice/onlineinstallerdev/<file>")
 
 # build
 build_sln.make()

make_package.py

@@ -91,6 +91,8 @@ if "server_enterprise" in common.targets:
   package_server.make("enterprise")
 if "server_developer" in common.targets:
   package_server.make("developer")
+if "server_prerequisites" in common.targets:
+  package_server.make("prerequisites")
 if "mobile" in common.targets:
   package_mobile.make()
 

scripts/base.py

@@ -1223,14 +1223,14 @@ def mac_correct_rpath_x2t(dir):
   mac_correct_rpath_library("HtmlFile2", ["UnicodeConverter", "kernel", "kernel_network", "graphics"])
   mac_correct_rpath_library("EpubFile", ["UnicodeConverter", "kernel", "HtmlFile2", "graphics"])
   mac_correct_rpath_library("Fb2File", ["UnicodeConverter", "kernel", "graphics"])
-  mac_correct_rpath_library("HtmlRenderer", ["UnicodeConverter", "kernel", "graphics"])
   mac_correct_rpath_library("PdfFile", ["UnicodeConverter", "kernel", "graphics", "kernel_network"])
   mac_correct_rpath_library("DjVuFile", ["UnicodeConverter", "kernel", "graphics", "PdfFile"])
   mac_correct_rpath_library("XpsFile", ["UnicodeConverter", "kernel", "graphics", "PdfFile"])
   mac_correct_rpath_library("DocxRenderer", ["UnicodeConverter", "kernel", "graphics"])
+  mac_correct_rpath_library("IWorkFile", ["UnicodeConverter", "kernel"])
   cmd("chmod", ["-v", "+x", "./x2t"])
   cmd("install_name_tool", ["-add_rpath", "@executable_path", "./x2t"], True)
-  mac_correct_rpath_binary("./x2t", ["icudata.58", "icuuc.58", "UnicodeConverter", "kernel", "kernel_network", "graphics", "PdfFile", "HtmlRenderer", "XpsFile", "DjVuFile", "HtmlFile2", "Fb2File", "EpubFile", "doctrenderer", "DocxRenderer"])
+  mac_correct_rpath_binary("./x2t", ["icudata.58", "icuuc.58", "UnicodeConverter", "kernel", "kernel_network", "graphics", "PdfFile", "XpsFile", "DjVuFile", "HtmlFile2", "Fb2File", "EpubFile", "doctrenderer", "DocxRenderer", "IWorkFile"])
   if is_file("./allfontsgen"):
     cmd("chmod", ["-v", "+x", "./allfontsgen"])
     cmd("install_name_tool", ["-add_rpath", "@executable_path", "./allfontsgen"], True)
@@ -1255,7 +1255,7 @@ def mac_correct_rpath_docbuilder(dir):
   os.chdir(dir)
   cmd("chmod", ["-v", "+x", "./docbuilder"])
   cmd("install_name_tool", ["-add_rpath", "@executable_path", "./docbuilder"], True)
-  mac_correct_rpath_binary("./docbuilder", ["icudata.58", "icuuc.58", "UnicodeConverter", "kernel", "kernel_network", "graphics", "PdfFile", "HtmlRenderer", "XpsFile", "DjVuFile", "HtmlFile2", "Fb2File", "EpubFile", "doctrenderer", "DocxRenderer"])  
+  mac_correct_rpath_binary("./docbuilder", ["icudata.58", "icuuc.58", "UnicodeConverter", "kernel", "kernel_network", "graphics", "PdfFile", "XpsFile", "DjVuFile", "HtmlFile2", "Fb2File", "EpubFile", "IWorkFile", "doctrenderer", "DocxRenderer"])  
   mac_correct_rpath_library("docbuilder.c", ["icudata.58", "icuuc.58", "UnicodeConverter", "kernel", "kernel_network", "graphics", "doctrenderer", "PdfFile", "XpsFile", "DjVuFile", "DocxRenderer"])
 
   def add_loader_path_to_rpath(libs):
@@ -1272,9 +1272,9 @@ def mac_correct_rpath_desktop(dir):
   os.chdir(dir)
   mac_correct_rpath_library("hunspell", [])
   mac_correct_rpath_library("ooxmlsignature", ["kernel"])
-  mac_correct_rpath_library("ascdocumentscore", ["UnicodeConverter", "kernel", "graphics", "kernel_network", "PdfFile", "HtmlRenderer", "XpsFile", "DjVuFile", "hunspell", "ooxmlsignature"])
+  mac_correct_rpath_library("ascdocumentscore", ["UnicodeConverter", "kernel", "graphics", "kernel_network", "PdfFile", "XpsFile", "DjVuFile", "hunspell", "ooxmlsignature"])
   cmd("install_name_tool", ["-change", "@executable_path/../Frameworks/Chromium Embedded Framework.framework/Chromium Embedded Framework", "@rpath/Chromium Embedded Framework.framework/Chromium Embedded Framework", "libascdocumentscore.dylib"])
-  mac_correct_rpath_binary("./editors_helper.app/Contents/MacOS/editors_helper", ["ascdocumentscore", "UnicodeConverter", "kernel", "kernel_network", "graphics", "PdfFile", "HtmlRenderer", "XpsFile", "DjVuFile", "hunspell", "ooxmlsignature"])
+  mac_correct_rpath_binary("./editors_helper.app/Contents/MacOS/editors_helper", ["ascdocumentscore", "UnicodeConverter", "kernel", "kernel_network", "graphics", "PdfFile", "XpsFile", "DjVuFile", "hunspell", "ooxmlsignature"])
   cmd("install_name_tool", ["-add_rpath", "@executable_path/../../../../Frameworks", "./editors_helper.app/Contents/MacOS/editors_helper"], True)
   cmd("install_name_tool", ["-add_rpath", "@executable_path/../../../../Resources/converter", "./editors_helper.app/Contents/MacOS/editors_helper"], True)
   cmd("chmod", ["-v", "+x", "./editors_helper.app/Contents/MacOS/editors_helper"])

scripts/build_js.py

@@ -41,6 +41,7 @@ def make():
   base.create_dir(out_dir)
 
   # builder
+  base.cmd_in_dir(base_dir + "/../web-apps/translation", "python", ["merge_and_check.py"])
   build_interface(base_dir + "/../web-apps/build")
   build_sdk_builder(base_dir + "/../sdkjs/build")
   base.create_dir(out_dir + "/builder")
@@ -168,6 +169,7 @@ def build_js_develop(root_dir):
   _run_npm(root_dir + external_folder + "/web-apps/build")
   _run_npm_ci(root_dir + external_folder + "/web-apps/build/sprites")
   _run_grunt(root_dir + external_folder + "/web-apps/build/sprites", [])
+  base.cmd_in_dir(root_dir + external_folder + "/web-apps/translation", "python", ["merge_and_check.py"])
 
   old_cur = os.getcwd()
   old_product_version = base.get_env("PRODUCT_VERSION")

scripts/build_sln.py

@@ -36,16 +36,18 @@ def make(solution=""):
 
   if config.check_option("module", "builder") and base.is_windows() and "onlyoffice" == config.branding():
     # check replace
-    new_replace_path = base.correctPathForBuilder(os.getcwd() + "/../core/DesktopEditor/doctrenderer/docbuilder.com/src/docbuilder.h")
-    if ("2019" == config.option("vs-version")):
-      base.make_sln_project("../core/DesktopEditor/doctrenderer/docbuilder.com/src", "docbuilder.com_2019.sln")
-      if (True):
-        new_path_net = base.correctPathForBuilder(os.getcwd() + "/../core/DesktopEditor/doctrenderer/docbuilder.net/src/docbuilder.net.cpp")
-        base.make_sln_project("../core/DesktopEditor/doctrenderer/docbuilder.net/src", "docbuilder.net.sln")
-        base.restorePathForBuilder(new_path_net)
-    else:
-      base.make_sln_project("../core/DesktopEditor/doctrenderer/docbuilder.com/src", "docbuilder.com.sln")
-    base.restorePathForBuilder(new_replace_path)
+    directory_builder_branding = os.getcwd() + "/../core/DesktopEditor/doctrenderer"
+    if base.is_dir(directory_builder_branding):
+      new_replace_path = base.correctPathForBuilder(directory_builder_branding + "/docbuilder.com/src/docbuilder.h")
+      if ("2019" == config.option("vs-version")):
+        base.make_sln_project("../core/DesktopEditor/doctrenderer/docbuilder.com/src", "docbuilder.com_2019.sln")
+        if (True):
+          new_path_net = base.correctPathForBuilder(directory_builder_branding + "/docbuilder.net/src/docbuilder.net.cpp")
+          base.make_sln_project("../core/DesktopEditor/doctrenderer/docbuilder.net/src", "docbuilder.net.sln")
+          base.restorePathForBuilder(new_path_net)
+      else:
+        base.make_sln_project("../core/DesktopEditor/doctrenderer/docbuilder.com/src", "docbuilder.com.sln")
+      base.restorePathForBuilder(new_replace_path)
 
   # build Java docbuilder wrapper
   if config.check_option("module", "builder") and "onlyoffice" == config.branding():

scripts/core_common/make_common.py

@@ -16,6 +16,7 @@ import curl
 import websocket_all
 import v8
 import html2
+import iwork
 import hunspell
 import glew
 import harfbuzz
@@ -42,6 +43,7 @@ def make():
   openssl.make()
   v8.make()
   html2.make()
+  iwork.make(False)
   hunspell.make(False)
   harfbuzz.make()
   glew.make()

scripts/core_common/modules/iwork.py

@@ -0,0 +1,38 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append('../..')
+import config
+import base
+import os
+import subprocess
+
+def clear_module():
+  directories = ["glm", "libetonyek", "libodfgen", "librevenge", "mdds"]
+
+  for dir in directories:
+    if base.is_dir(dir):
+      base.delete_dir_with_access_error(dir)
+
+def make(use_gperf = True):
+  old_cur_dir = os.getcwd()
+
+  print("[fetch & build]: iwork")
+
+  base_dir = base.get_script_dir() + "/../../core/Common/3dParty/apple"
+  
+  os.chdir(base_dir)
+  base.check_module_version("3", clear_module)
+  os.chdir(old_cur_dir)
+
+  cmd_args = ["fetch.py"]
+
+  if use_gperf:
+    cmd_args.append("--gperf")
+
+  base.cmd_in_dir(base_dir, "python", cmd_args)
+  return
+
+if __name__ == '__main__':
+  # manual compile
+  make(False)

scripts/deploy_builder.py

@@ -40,9 +40,9 @@ def make():
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, root_dir, "DjVuFile")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, root_dir, "XpsFile")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, root_dir, "HtmlFile2")
-    base.copy_lib(core_build_dir + "/lib/" + platform_postfix, root_dir, "HtmlRenderer")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, root_dir, "Fb2File")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, root_dir, "EpubFile")
+    base.copy_lib(core_build_dir + "/lib/" + platform_postfix, root_dir, "IWorkFile")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, root_dir, "DocxRenderer")
     base.copy_file(git_dir + "/sdkjs/pdf/src/engine/cmap.bin", root_dir + "/cmap.bin")
 

scripts/deploy_core.py

@@ -30,7 +30,6 @@ def make():
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, archive_dir, "kernel_network")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, archive_dir, "graphics")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, archive_dir, "doctrenderer")
-    base.copy_lib(core_build_dir + "/lib/" + platform_postfix, archive_dir, "HtmlRenderer")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, archive_dir, "DjVuFile")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, archive_dir, "XpsFile")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, archive_dir, "PdfFile")
@@ -38,6 +37,7 @@ def make():
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, archive_dir, "UnicodeConverter")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, archive_dir, "Fb2File")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, archive_dir, "EpubFile")
+    base.copy_lib(core_build_dir + "/lib/" + platform_postfix, archive_dir, "IWorkFile")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, archive_dir, "DocxRenderer")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, archive_dir, "hunspell")
     base.copy_file(git_dir + "/sdkjs/pdf/src/engine/cmap.bin", archive_dir + "/cmap.bin")

scripts/deploy_desktop.py

@@ -66,9 +66,9 @@ def make():
     base.copy_lib(build_libraries_path, root_dir + "/converter", "DjVuFile")
     base.copy_lib(build_libraries_path, root_dir + "/converter", "XpsFile")
     base.copy_lib(build_libraries_path, root_dir + "/converter", "HtmlFile2")
-    base.copy_lib(build_libraries_path, root_dir + "/converter", "HtmlRenderer")
     base.copy_lib(build_libraries_path, root_dir + "/converter", "Fb2File")
     base.copy_lib(build_libraries_path, root_dir + "/converter", "EpubFile")
+    base.copy_lib(build_libraries_path, root_dir + "/converter", "IWorkFile")
     base.copy_lib(build_libraries_path, root_dir + "/converter", "DocxRenderer")
     
     if ("ios" == platform):
@@ -183,6 +183,7 @@ def make():
         base.copy_file(git_dir + "/desktop-apps/win-linux/extras/projicons/" + apps_postfix + "/projicons.exe", root_dir + "/DesktopEditors.exe")
         if not isWindowsXP:
           base.copy_file(git_dir + "/desktop-apps/win-linux/extras/update-daemon/" + apps_postfix + "/updatesvc.exe", root_dir + "/updatesvc.exe")
+          base.copy_file(git_dir + "/desktop-apps/win-linux/extras/online-installer/" + apps_postfix + "/online-installer.exe", root_dir + "/online-installer.exe")
         base.copy_file(git_dir + "/desktop-apps/win-linux/" + apps_postfix + "/DesktopEditors.exe", root_dir + "/editors.exe")
         base.copy_file(git_dir + "/desktop-apps/win-linux/res/icons/desktopeditors.ico", root_dir + "/app.ico")
       elif (0 == platform.find("linux")):

scripts/deploy_mobile.py

@@ -58,10 +58,10 @@ def make():
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, root_dir, "DjVuFile")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, root_dir, "XpsFile")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, root_dir, "HtmlFile2")
-    base.copy_lib(core_build_dir + "/lib/" + platform_postfix, root_dir, "HtmlRenderer")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, root_dir, "doctrenderer")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, root_dir, "Fb2File")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, root_dir, "EpubFile")
+    base.copy_lib(core_build_dir + "/lib/" + platform_postfix, root_dir, "IWorkFile")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, root_dir, "DocxRenderer")
     base.copy_file(git_dir + "/sdkjs/pdf/src/engine/cmap.bin", root_dir + "/cmap.bin")
 

scripts/deploy_server.py

@@ -78,10 +78,10 @@ def make():
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, converter_dir, "DjVuFile")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, converter_dir, "XpsFile")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, converter_dir, "HtmlFile2")
-    base.copy_lib(core_build_dir + "/lib/" + platform_postfix, converter_dir, "HtmlRenderer")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, converter_dir, "doctrenderer")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, converter_dir, "Fb2File")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, converter_dir, "EpubFile")
+    base.copy_lib(core_build_dir + "/lib/" + platform_postfix, converter_dir, "IWorkFile")
     base.copy_lib(core_build_dir + "/lib/" + platform_postfix, converter_dir, "DocxRenderer")
     base.copy_file(git_dir + "/sdkjs/pdf/src/engine/cmap.bin", converter_dir + "/cmap.bin")
     base.copy_exe(core_build_dir + "/bin/" + platform_postfix, converter_dir, "x2t")

scripts/license_checker/config.json

@@ -21,14 +21,14 @@
 				"core/DesktopEditor/raster/JBig2",
 				"core/DesktopEditor/raster/Jp2",
 				"core/DesktopEditor/xml/libxml2",
-				"core/DesktopEditor/xmlsec",		
+				"core/DesktopEditor/xmlsec",
 				"core/DjVuFile/libdjvu",
 				"core/DjVuFile/wasm",
 				"core/EpubFile",
 				"core/OOXML/PPTXFormat/Limit/pri",
 				"core/Fb2File",
 				"core/HtmlFile2",
-				"core/HtmlFile2",
+				"core/Apple",
 				"core/OdfFile/Common/utf8cpp",
 				"core/OfficeUtils/js/emsdk",
 				"core/OfficeUtils/src/zlib-1.2.11",

scripts/package_desktop.py

@@ -63,6 +63,7 @@ def make_windows():
   make_zip()
   make_inno()
   make_advinst()
+  make_online()
 
   utils.set_cwd(common.workspace_dir)
   return
@@ -176,6 +177,19 @@ def make_advinst():
     utils.set_summary("desktop advinst deploy", ret)
   return
 
+def make_online():
+  if not common.platform in ["windows_x64", "windows_x86"]:
+    return
+  online_file = "%s-%s-%s.exe" % ("OnlineInstaller", package_version, suffix)
+  ret = utils.is_file(online_file)
+  utils.set_summary("desktop online installer build", ret)
+
+  if common.deploy and ret:
+    utils.log_h2("desktop online installer deploy")
+    ret = s3_upload([online_file], "desktop/win/online/")
+    utils.set_summary("desktop online installer deploy", ret)
+  return
+
 #
 # macOS
 #

scripts/package_server.py

@@ -36,10 +36,13 @@ def make_windows(edition):
 
   utils.log_h2("server " + edition + " build")
   ret = utils.cmd("make", "clean", verbose=True)
-  args = ["-e", "PRODUCT_NAME=" + product_name]
+  if edition == "prerequisites":
+    make_args = ["exe-pr"]
+  else:
+    make_args = ["exe", "-e", "PRODUCT_NAME=" + product_name]
   if not branding.onlyoffice:
-    args += ["-e", "BRANDING_DIR=../" + common.branding + "/document-server-package"]
-  ret &= utils.cmd("make", "packages", *args, verbose=True)
+    make_args += ["-e", "BRANDING_DIR=../" + common.branding + "/document-server-package"]
+  ret &= utils.cmd("make", *make_args, verbose=True)
   utils.set_summary("server " + edition + " build", ret)
 
   if common.deploy and ret:

scripts/sdkjs_common/jsdoc/generate_docs_plugins_json.py

@@ -27,24 +27,36 @@ def generate(output_dir, md=False):
         print(f"Generating {editor_name}.json: {command}")
         subprocess.run(command, shell=True)
 
+    common_doclets_file = os.path.join(output_dir, 'common.json')
+    with open(common_doclets_file, 'r', encoding='utf-8') as f:
+        common_doclets_json = json.dumps(json.load(f))
+    os.remove(common_doclets_file)
+    
     # Append examples to JSON documentation
     for config in configs:
+        if (config.find('common') != -1):
+            continue
+        
         editor_name = config.split('/')[-1].replace('.json', '')
+        example_folder_name = editor_name # name of folder with examples
         output_file = os.path.join(output_dir, editor_name + ".json")
         
         # Read the JSON file
         with open(output_file, 'r', encoding='utf-8') as f:
             data = json.load(f)
+            start_common_doclet_idx = len(data)
+            data += json.loads(common_doclets_json)
         
         # Modify JSON data
-        for doclet in data:
+        for idx, doclet in enumerate(data):
+            if idx == start_common_doclet_idx:
+                example_folder_name = 'common'
+            elif editor_name == 'forms':
+                example_folder_name = 'word'
+
             if 'see' in doclet:
                 if doclet['see'] is not None:
-                    if editor_name == 'forms':
-                        doclet['see'][0] = doclet['see'][0].replace('{Editor}', 'Word')
-                    else:
-                        doclet['see'][0] = doclet['see'][0].replace('{Editor}', editor_name.title())
-
+                    doclet['see'][0] = doclet['see'][0].replace('{Editor}', example_folder_name.title())
                     file_path = f'{root}/' + doclet['see'][0]
 
                     if os.path.exists(file_path):

sln.json

@@ -22,8 +22,9 @@
     "core/HtmlFile2/HtmlFile2.pro",
     "core/Fb2File/Fb2File.pro",
     "core/EpubFile/CEpubFile.pro",
-    
-    "core/HtmlRenderer/htmlrenderer.pro",
+
+    "core/Apple/IWork.pro",
+
     "core/DocxRenderer/DocxRenderer.pro",   
 
     "core/DesktopEditor/doctrenderer/doctrenderer.pro",
@@ -90,7 +91,8 @@
     "[win,linux]desktop-apps/win-linux/ASCDocumentEditor.pro",
     
     "[win]desktop-apps/win-linux/extras/projicons/ProjIcons.pro",
-    "[win,!win_xp]desktop-apps/win-linux/extras/update-daemon/UpdateDaemon.pro"
+    "[win,!win_xp]desktop-apps/win-linux/extras/update-daemon/UpdateDaemon.pro",
+    "[win,!win_xp]desktop-apps/win-linux/extras/online-installer/OnlineInstaller.pro"
   ],
 
   "mobile" : [

tools/linux/deps.py

@@ -42,8 +42,8 @@ def install_deps():
               "libncurses5",
               "libncurses6",
               "curl",
-              "libxkbcommon0",
-              "libxkbcommon-x11-0"]
+              "libxkbcommon-dev",
+              "libxkbcommon-x11-dev"]
 
   for package in packages:
     base.cmd("sudo", ["apt-get", "install", "-y", package], True)