JAL-3447 MSI installer for windows
[jalview.git] / build.gradle
index 1e2c719..810eb57 100644 (file)
@@ -38,7 +38,7 @@ dependencies {
 
 // in ext the values are cast to Object. Ensure string values are cast as String (and not GStringImpl) for later use
 def string(Object o) {
-  return o.toString()
+  return o == null ? "" : o.toString()
 }
 
 
@@ -56,10 +56,12 @@ ext {
       localPropsFIS.close()
       p.each {
         key, val -> 
-          def over = getProperty(key) != null
+          def oldval = findProperty(key)
           setProperty(key, val)
-          if (over) {
-            println("Overriding property '${key}' with local.properties value '${val}'")
+          if (oldval != null) {
+            println("Overriding property '${key}' ('${oldval}') with local.properties value '${val}'")
+          } else {
+            println("Setting unknown property '${key}' with local.properties value '${val}'")
           }
       }
     } catch (Exception e) {
@@ -208,11 +210,16 @@ ext {
     break
 
     default: // something wrong specified
-    print("CHANNEL must be one of BUILD, RELEASE, ARCHIVE, DEVELOP, TEST-RELEASE, SCRATCH-..., LOCAL [default]")
+    println("CHANNEL must be one of BUILD, RELEASE, ARCHIVE, DEVELOP, TEST-RELEASE, SCRATCH-..., LOCAL [default]")
     exit
     break
 
   }
+  // override getdown_app_base if requested
+  if (findProperty("getdown_appbase_override") != null) {
+    getdown_app_base = string(getProperty("getdown_appbase_override"))
+    println("Overriding getdown appbase with '${getdown_app_base}'")
+  }
 
   getdownAppDir = string("${getdownWebsiteDir}/${getdown_app_dir}")
   //getdownJ11libDir = "${getdownWebsiteDir}/${getdown_j11lib_dir}"
@@ -239,22 +246,22 @@ ext {
     compile_source_compatibility = 1.8
     compile_target_compatibility = 1.8
     // these are getdown.txt properties defined dependent on the JAVA_VERSION
-    getdown_alt_java_min_version = getdown_alt_java8_min_version
-    getdown_alt_java_max_version = getdown_alt_java8_max_version
+    getdownAltJavaMinVersion = string(findProperty("getdown_alt_java8_min_version"))
+    getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java8_max_version"))
     // this property is assigned below and expanded to multiple lines in the getdown task
-    getdown_alt_multi_java_location = getdown_alt_java8_txt_multi_java_location
+    getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java8_txt_multi_java_location"))
     // this property is for the Java library used in eclipse
-    eclipse_java_runtime_name = string("JavaSE-1.8")
+    eclipseJavaRuntimeName = string("JavaSE-1.8")
   } else if (JAVA_VERSION.equals("11")) {
     JAVA_INTEGER_VERSION = string("11")
     libDir = j11libDir
     libDistDir = j11libDir
     compile_source_compatibility = 11
     compile_target_compatibility = 11
-    getdown_alt_java_min_version = getdown_alt_java11_min_version
-    getdown_alt_java_max_version = getdown_alt_java11_max_version
-    getdown_alt_multi_java_location = getdown_alt_java11_txt_multi_java_location
-    eclipse_java_runtime_name = string("JavaSE-11")
+    getdownAltJavaMinVersion = string(findProperty("getdown_alt_java11_min_version"))
+    getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java11_max_version"))
+    getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java11_txt_multi_java_location"))
+    eclipseJavaRuntimeName = string("JavaSE-11")
     /* compile without modules -- using classpath libraries
     additional_compiler_args += [
     '--module-path', modules_compileClasspath.asPath,
@@ -267,10 +274,10 @@ ext {
     libDistDir = j11libDir
     compile_source_compatibility = JAVA_VERSION
     compile_target_compatibility = JAVA_VERSION
-    getdown_alt_java_min_version = getdown_alt_java11_min_version
-    getdown_alt_java_max_version = getdown_alt_java11_max_version
-    getdown_alt_multi_java_location = getdown_alt_java11_txt_multi_java_location
-    eclipse_java_runtime_name = string("JavaSE-11")
+    getdownAltJavaMinVersion = string(findProperty("getdown_alt_java11_min_version"))
+    getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java11_max_version"))
+    getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java11_txt_multi_java_location"))
+    eclipseJavaRuntimeName = string("JavaSE-11")
     /* compile without modules -- using classpath libraries
     additional_compiler_args += [
     '--module-path', modules_compileClasspath.asPath,
@@ -285,10 +292,16 @@ ext {
   // for install4j
   JAVA_MIN_VERSION = JAVA_VERSION
   JAVA_MAX_VERSION = JAVA_VERSION
-  macosJavaVMDir = string("${System.env.HOME}/buildtools/jre/openjdk-java_vm/getdown/macos-jre${JAVA_VERSION}/jre")
-  macosJavaVMTgz = string("${System.env.HOME}/buildtools/jre/openjdk-java_vm/install4j/tgz/macos-jre${JAVA_VERSION}.tar.gz")
-  windowsJavaVMDir = string("${System.env.HOME}/buildtools/jre/openjdk-java_vm/getdown/windows-jre${JAVA_VERSION}/jre")
-  windowsJavaVMTgz = string("${System.env.HOME}/buildtools/jre/openjdk-java_vm/install4j/tgz/windows-jre${JAVA_VERSION}.tar.gz")
+  def jreInstallsDir = string(jre_installs_dir)
+  if (jreInstallsDir.startsWith("~/")) {
+    jreInstallsDir = System.getProperty("user.home") + jreInstallsDir.substring(1)
+  }
+  macosJavaVMDir = string("${jreInstallsDir}/jre-${JAVA_INTEGER_VERSION}-mac-x64/jre")
+  macosJavaVMTgz = string("${jreInstallsDir}/tgz/jre-${JAVA_INTEGER_VERSION}-mac-x64.tar.gz")
+  windowsJavaVMDir = string("${jreInstallsDir}/jre-${JAVA_INTEGER_VERSION}-windows-x64/jre")
+  windowsJavaVMTgz = string("${jreInstallsDir}/tgz/jre-${JAVA_INTEGER_VERSION}-windows-x64.tar.gz")
+  linuxJavaVMDir = string("${jreInstallsDir}/jre-${JAVA_INTEGER_VERSION}-linux-x64/jre")
+  linuxJavaVMTgz = string("${jreInstallsDir}/tgz/jre-${JAVA_INTEGER_VERSION}-linux-x64.tar.gz")
   install4jDir = string("${jalviewDir}/${install4j_utils_dir}")
   install4jConfFileName = string("jalview-install4j-conf.install4j")
   install4jConfFile = file("${install4jDir}/${install4jConfFileName}")
@@ -302,8 +315,7 @@ ext {
   buildingHTML = string("${jalviewDir}/${docDir}/building.html")
   helpFile = string("${classesDir}/${help_dir}/help.jhm")
   helpParentDir = string("${jalviewDir}/${help_parent_dir}")
-  helpDir = string("${help_dir}")
-  helpSourceDir = string("${helpParentDir}/${helpDir}")
+  helpSourceDir = string("${helpParentDir}/${help_dir}")
 
 
   relativeBuildDir = file(jalviewDirAbsolutePath).toPath().relativize(buildDir.toPath())
@@ -341,11 +353,13 @@ sourceSets {
 
     resources {
       srcDirs resourceDir
+      srcDirs += helpParentDir
     }
 
     jar.destinationDir = file("${jalviewDir}/${packageDir}")
 
     compileClasspath = files(sourceSets.main.java.outputDir)
+    //compileClasspath += files(sourceSets.main.resources.srcDirs)
     compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
 
     runtimeClasspath = compileClasspath
@@ -454,8 +468,8 @@ eclipse {
         cp.entries.removeAll(removeTheseToo)
 
         //cp.entries += new Output("${eclipse_bin_dir}/main")
-        if (file(helpSourceDir).isDirectory()) {
-          cp.entries += new Library(fileReference(helpSourceDir))
+        if (file(helpParentDir).isDirectory()) {
+          cp.entries += new Library(fileReference(helpParentDir))
         }
         if (file(resourceDir).isDirectory()) {
           cp.entries += new Library(fileReference(resourceDir))
@@ -516,7 +530,7 @@ eclipse {
     // for the IDE, use java 11 compatibility
     sourceCompatibility = compile_source_compatibility
     targetCompatibility = compile_target_compatibility
-    javaRuntimeName = eclipse_java_runtime_name
+    javaRuntimeName = eclipseJavaRuntimeName
 
     // add in jalview project specific properties/preferences into eclipse core preferences
     file {
@@ -707,7 +721,8 @@ task convertBuildingMD(type: Exec) {
   }
 
   def hostname = "hostname".execute().text.trim()
-  if ((pandoc == null || ! file(pandoc).exists()) && hostname.equals("jv-bamboo")) {
+  def buildtoolsPandoc = System.getProperty("user.home")+"/buildtools/pandoc/bin/pandoc"
+  if ((pandoc == null || ! file(pandoc).exists()) && file(buildtoolsPandoc).exists()) {
     pandoc = System.getProperty("user.home")+"/buildtools/pandoc/bin/pandoc"
   }
 
@@ -746,7 +761,7 @@ task syncDocs(type: Sync) {
 
 task copyHelp(type: Copy) {
   def inputDir = helpSourceDir
-  def outputDir = "${classesDir}/${helpDir}"
+  def outputDir = "${classesDir}/${help_dir}"
   from(inputDir) {
     exclude '**/*.gif'
     exclude '**/*.jpg'
@@ -828,7 +843,7 @@ task buildIndices(type: JavaExec) {
   dependsOn copyHelp
   classpath = sourceSets.main.compileClasspath
   main = "com.sun.java.help.search.Indexer"
-  workingDir = "${classesDir}/${helpDir}"
+  workingDir = "${classesDir}/${help_dir}"
   def argDir = "html"
   args = [ argDir ]
   inputs.dir("${workingDir}/${argDir}")
@@ -864,8 +879,7 @@ task linkCheck(type: JavaExec) {
   classpath = files("${jalviewDir}/${utilsDir}")
   main = "HelpLinksChecker"
   workingDir = jalviewDir
-  def help = "${classesDir}/${helpDir}"
-  args = [ "${classesDir}/${helpDir}", "-nointernet" ]
+  args = [ "${classesDir}/${help_dir}", "-nointernet" ]
 
   def outFOS = new FileOutputStream(helpLinksCheckerOutFile, false) // false == don't append
   def errFOS = outFOS
@@ -876,13 +890,13 @@ task linkCheck(type: JavaExec) {
     outFOS,
     errorOutput)
 
-  inputs.dir("${classesDir}/${helpDir}")
+  inputs.dir("${classesDir}/${help_dir}")
   outputs.file(helpLinksCheckerOutFile)
 }
 
 // import the pubhtmlhelp target
 ant.properties.basedir = "${jalviewDir}"
-ant.properties.helpBuildDir = "${jalviewDirAbsolutePath}/${classes_dir}/${helpDir}"
+ant.properties.helpBuildDir = "${jalviewDirAbsolutePath}/${classes_dir}/${help_dir}"
 ant.importBuild "${utilsDir}/publishHelp.xml"
 
 
@@ -998,13 +1012,15 @@ task getdownWebsite() {
 
     // go through properties looking for getdown_txt_...
     def props = project.properties.sort { it.key }
-    if (getdown_alt_java_min_version.length() > 0) {
-      props.put("getdown_txt_java_min_version", getdown_alt_java_min_version)
+    if (getdownAltJavaMinVersion != null && getdownAltJavaMinVersion.length() > 0) {
+      props.put("getdown_txt_java_min_version", getdownAltJavaMinVersion)
     }
-    if (getdown_alt_java_max_version.length() > 0) {
-      props.put("getdown_txt_java_max_version", getdown_alt_java_max_version)
+    if (getdownAltJavaMaxVersion != null && getdownAltJavaMaxVersion.length() > 0) {
+      props.put("getdown_txt_java_max_version", getdownAltJavaMaxVersion)
+    }
+    if (getdownAltMultiJavaLocation != null && getdownAltMultiJavaLocation.length() > 0) {
+      props.put("getdown_txt_multi_java_location", getdownAltMultiJavaLocation)
     }
-    props.put("getdown_txt_multi_java_location", getdown_alt_multi_java_location)
 
     props.put("getdown_txt_appbase", getdown_app_base)
     props.each{ prop, val ->
@@ -1212,7 +1228,6 @@ install4j {
 
 
 task copyInstall4jTemplate {
-
   def install4jTemplateFile = file("${install4jDir}/${install4j_template}")
   def install4jFileAssociationsFile = file("${install4jDir}/${install4j_installer_file_associations}")
   inputs.file(install4jTemplateFile)
@@ -1220,14 +1235,14 @@ task copyInstall4jTemplate {
   outputs.file(install4jConfFile)
 
   doLast {
-    def install4j = new XmlParser().parse(install4jTemplateFile)
+    def install4jConfigXml = new XmlParser().parse(install4jTemplateFile)
 
     // turn off code signing if no OSX_KEYPASS
     if (OSX_KEYPASS == "") {
-      install4j.'**'.codeSigning.each { codeSigning ->
+      install4jConfigXml.'**'.codeSigning.each { codeSigning ->
         codeSigning.'@macEnabled' = "false"
       }
-      install4j.'**'.windows.each { windows ->
+      install4jConfigXml.'**'.windows.each { windows ->
         windows.'@runPostProcessor' = "false"
       }
     }
@@ -1235,7 +1250,7 @@ task copyInstall4jTemplate {
     // put file association actions where placeholder action is
     def install4jFileAssociationsText = install4jFileAssociationsFile.text
     def fileAssociationActions = new XmlParser().parseText("<actions>${install4jFileAssociationsText}</actions>")
-    install4j.'**'.action.any { a ->
+    install4jConfigXml.'**'.action.any { a ->
       if (a.'@name' == 'EXTENSIONS_REPLACED_BY_GRADLE') {
         def parent = a.parent()
         parent.remove(a)
@@ -1248,7 +1263,7 @@ task copyInstall4jTemplate {
     }
 
     // write install4j file
-    install4jConfFile.text = XmlUtil.serialize(install4j)
+    install4jConfFile.text = XmlUtil.serialize(install4jConfigXml)
   }
 }
 
@@ -1270,7 +1285,6 @@ task installers(type: com.install4j.gradle.Install4jTask) {
   projectFile = install4jConfFile
 
   // create an md5 for the input files to use as version for install4j conf file
-  def install4jTemplateMd5 = ""
   def digest = MessageDigest.getInstance("MD5")
   digest.update(
     (file("${install4jDir}/${install4j_template}").text + 
@@ -1280,14 +1294,16 @@ task installers(type: com.install4j.gradle.Install4jTask) {
   if (filesMd5.length() >= 8) {
     filesMd5 = filesMd5.substring(0,8)
   }
-  install4jTemplateMd5 += filesMd5
-  install4jTemplateMd5 += "_${gitHash}"
-  def install4jTemplateVersion = "${JALVIEW_VERSION}_${install4jTemplateMd5}"
-  def infoPlistFileAssociations = file("${install4jDir}/${install4j_info_plist_file_associations}").text
+  def install4jTemplateVersion = "${JALVIEW_VERSION}_F${filesMd5}_C${gitHash}"
+  // make install4jBuildDir relative to jalviewDir
+  def install4jBuildDir = "${install4j_build_dir}/${JAVA_VERSION}"
 
   variables = [
+    'JALVIEW_DIR': "../..",
     'OSX_KEYSTORE': OSX_KEYSTORE,
     'JSIGN_SH': JSIGN_SH,
+    'JRE_DIR': getdown_app_dir_java,
+    'INSTALLER_TEMPLATE_VERSION': install4jTemplateVersion,
     'JALVIEW_VERSION': JALVIEW_VERSION,
     'JAVA_MIN_VERSION': JAVA_MIN_VERSION,
     'JAVA_MAX_VERSION': JAVA_MAX_VERSION,
@@ -1295,20 +1311,25 @@ task installers(type: com.install4j.gradle.Install4jTask) {
     'JAVA_INTEGER_VERSION': JAVA_INTEGER_VERSION,
     'VERSION': JALVIEW_VERSION,
     'MACOS_JAVA_VM_DIR': macosJavaVMDir,
-    'MACOS_JAVA_VM_TGZ': macosJavaVMTgz,
     'WINDOWS_JAVA_VM_DIR': windowsJavaVMDir,
+    'LINUX_JAVA_VM_DIR': linuxJavaVMDir,
+    'MACOS_JAVA_VM_TGZ': macosJavaVMTgz,
     'WINDOWS_JAVA_VM_TGZ': windowsJavaVMTgz,
-    'INSTALL4JINFOPLISTFILEASSOCIATIONS': install4j_info_plist_file_associations,
-    'INSTALLER_TEMPLATE_VERSION': install4jTemplateVersion,
+    'LINUX_JAVA_VM_TGZ': linuxJavaVMTgz,
     'COPYRIGHT_MESSAGE': install4j_copyright_message,
     'MACOS_BUNDLE_ID': install4j_macOS_bundle_id,
+    'INSTALL4J_UTILS_DIR': install4j_utils_dir,
+    'GETDOWN_WEBSITE_DIR': getdown_website_dir,
+    'GETDOWN_FILES_DIR': getdown_files_dir,
     'GETDOWN_RESOURCE_DIR': getdown_resource_dir,
     'GETDOWN_DIST_DIR': getdown_app_dir,
     'GETDOWN_ALT_DIR': getdown_app_dir_alt,
     'GETDOWN_INSTALL_DIR': getdown_install_dir,
-    'INFO_PLIST_FILE_ASSOCIATIONS': infoPlistFileAssociations
+    'INFO_PLIST_FILE_ASSOCIATIONS_FILE': install4j_info_plist_file_associations,
+    'BUILD_DIR': install4jBuildDir,
   ]
-  destination = "${jalviewDir}/${install4j_build_dir}/${JAVA_VERSION}"
+
+  destination = "${jalviewDir}/${install4jBuildDir}"
   buildSelected = true
 
   if (install4j_faster.equals("true") || CHANNEL.startsWith("DEVELOP") || CHANNEL.startsWith("LOCAL")) {
@@ -1416,8 +1437,8 @@ task helppages {
   dependsOn copyHelp
   dependsOn pubhtmlhelp
   
-  inputs.dir("${classesDir}/${helpDir}")
-  outputs.dir("${buildDir}/distributions/${helpDir}")
+  inputs.dir("${classesDir}/${help_dir}")
+  outputs.dir("${buildDir}/distributions/${help_dir}")
 }
 
 // LARGE AMOUNT OF JALVIEWJS STUFF DELETED HERE