build.gradle

   1 /* Convention for properties.  Read from gradle.properties, use lower_case_underlines for property names.
   2  * For properties set within build.gradle, use camelCaseNoSpace.
   3  */
   4 import org.apache.tools.ant.filters.ReplaceTokens
   5 import org.gradle.internal.os.OperatingSystem
   6 import org.gradle.plugins.ide.internal.generator.PropertiesPersistableConfigurationObject
   7 import org.gradle.api.internal.PropertiesTransformer
   8 import org.gradle.util.ConfigureUtil
   9 import org.gradle.plugins.ide.eclipse.model.Output
  10 import org.gradle.plugins.ide.eclipse.model.Library
  11 import java.security.MessageDigest
  12 import java.util.regex.Matcher
  13 import java.util.concurrent.Executors
  14 import java.util.concurrent.Future
  15 import java.util.concurrent.ScheduledExecutorService
  16 import java.util.concurrent.TimeUnit
  17 import groovy.transform.ExternalizeMethods
  18 import groovy.util.XmlParser
  19 import groovy.xml.XmlUtil
  20 import groovy.json.JsonBuilder
  21 import com.vladsch.flexmark.util.ast.Node
  22 import com.vladsch.flexmark.html.HtmlRenderer
  23 import com.vladsch.flexmark.parser.Parser
  24 import com.vladsch.flexmark.util.data.MutableDataSet
  25 import com.vladsch.flexmark.ext.gfm.tasklist.TaskListExtension
  26 import com.vladsch.flexmark.ext.tables.TablesExtension
  27 import com.vladsch.flexmark.ext.gfm.strikethrough.StrikethroughExtension
  28 import com.vladsch.flexmark.ext.autolink.AutolinkExtension
  29 import com.vladsch.flexmark.ext.anchorlink.AnchorLinkExtension
  30 import com.vladsch.flexmark.ext.toc.TocExtension
  31 import com.google.common.hash.HashCode
  32 import com.google.common.hash.Hashing
  33 import com.google.common.io.Files
  34 import org.jsoup.Jsoup
  35 import org.jsoup.nodes.Element
  36
  37 buildscript {
  38   repositories {
  39     mavenCentral()
  40     mavenLocal()
  41   }
  42   dependencies {
  43     classpath "com.vladsch.flexmark:flexmark-all:0.62.0"
  44     classpath "org.jsoup:jsoup:1.14.3"
  45     classpath "com.eowise:gradle-imagemagick:0.5.1"
  46   }
  47 }
  48
  49
  50 plugins {
  51   id 'java'
  52   id 'application'
  53   id 'eclipse'
  54   id "com.diffplug.gradle.spotless" version "3.28.0"
  55   id 'com.github.johnrengelman.shadow' version '6.0.0'
  56   id 'com.install4j.gradle' version '10.0.3'
  57   id 'com.dorongold.task-tree' version '2.1.1' // only needed to display task dependency tree with  gradle task1 [task2 ...] taskTree
  58   id 'com.palantir.git-version' version '0.13.0' apply false
  59 }
  60
  61 repositories {
  62   jcenter()
  63   mavenCentral()
  64   mavenLocal()
  65 }
  66
  67
  68
  69 // in ext the values are cast to Object. Ensure string values are cast as String (and not GStringImpl) for later use
  70 def string(Object o) {
  71   return o == null ? "" : o.toString()
  72 }
  73
  74 def overrideProperties(String propsFileName, boolean output = false) {
  75   if (propsFileName == null) {
  76     return
  77   }
  78   def propsFile = file(propsFileName)
  79   if (propsFile != null && propsFile.exists()) {
  80     println("Using properties from file '${propsFileName}'")
  81     try {
  82       def p = new Properties()
  83       def localPropsFIS = new FileInputStream(propsFile)
  84       p.load(localPropsFIS)
  85       localPropsFIS.close()
  86       p.each {
  87         key, val ->
  88           def oldval
  89           if (project.hasProperty(key)) {
  90             oldval = project.findProperty(key)
  91             project.setProperty(key, val)
  92             if (output) {
  93               println("Overriding property '${key}' ('${oldval}') with ${file(propsFile).getName()} value '${val}'")
  94             }
  95           } else {
  96             ext.setProperty(key, val)
  97             if (output) {
  98               println("Setting ext property '${key}' with ${file(propsFile).getName()}s value '${val}'")
  99             }
 100           }
 101       }
 102     } catch (Exception e) {
 103       println("Exception reading local.properties")
 104       e.printStackTrace()
 105     }
 106   }
 107 }
 108
 109 ext {
 110   jalviewDirAbsolutePath = file(jalviewDir).getAbsolutePath()
 111   jalviewDirRelativePath = jalviewDir
 112   date = new Date()
 113
 114   getdownChannelName = CHANNEL.toLowerCase()
 115   // default to "default". Currently only has different cosmetics for "develop", "release", "default"
 116   propertiesChannelName = ["develop", "release", "test-release", "jalviewjs", "jalviewjs-release" ].contains(getdownChannelName) ? getdownChannelName : "default"
 117   channelDirName = propertiesChannelName
 118   // Import channel_properties
 119   if (getdownChannelName.startsWith("develop-")) {
 120     channelDirName = "develop-SUFFIX"
 121   }
 122   channelDir = string("${jalviewDir}/${channel_properties_dir}/${channelDirName}")
 123   channelGradleProperties = string("${channelDir}/channel_gradle.properties")
 124   channelPropsFile = string("${channelDir}/${resource_dir}/${channel_props}")
 125   overrideProperties(channelGradleProperties, false)
 126   // local build environment properties
 127   // can be "projectDir/local.properties"
 128   overrideProperties("${projectDir}/local.properties", true)
 129   // or "../projectDir_local.properties"
 130   overrideProperties(projectDir.getParent() + "/" + projectDir.getName() + "_local.properties", true)
 131
 132   ////
 133   // Import releaseProps from the RELEASE file
 134   // or a file specified via JALVIEW_RELEASE_FILE if defined
 135   // Expect jalview.version and target release branch in jalview.release
 136   releaseProps = new Properties();
 137   def releasePropFile = findProperty("JALVIEW_RELEASE_FILE");
 138   def defaultReleasePropFile = "${jalviewDirAbsolutePath}/RELEASE";
 139   try {
 140     (new File(releasePropFile!=null ? releasePropFile : defaultReleasePropFile)).withInputStream {
 141      releaseProps.load(it)
 142     }
 143   } catch (Exception fileLoadError) {
 144     throw new Error("Couldn't load release properties file "+(releasePropFile==null ? defaultReleasePropFile : "from custom location: releasePropFile"),fileLoadError);
 145   }
 146   ////
 147   // Set JALVIEW_VERSION if it is not already set
 148   if (findProperty("JALVIEW_VERSION")==null || "".equals(JALVIEW_VERSION)) {
 149     JALVIEW_VERSION = releaseProps.get("jalview.version")
 150   }
 151   println("JALVIEW_VERSION is set to '${JALVIEW_VERSION}'")
 152
 153   // this property set when running Eclipse headlessly
 154   j2sHeadlessBuildProperty = string("net.sf.j2s.core.headlessbuild")
 155   // this property set by Eclipse
 156   eclipseApplicationProperty = string("eclipse.application")
 157   // CHECK IF RUNNING FROM WITHIN ECLIPSE
 158   def eclipseApplicationPropertyVal = System.properties[eclipseApplicationProperty]
 159   IN_ECLIPSE = eclipseApplicationPropertyVal != null && eclipseApplicationPropertyVal.startsWith("org.eclipse.ui.")
 160   // BUT WITHOUT THE HEADLESS BUILD PROPERTY SET
 161   if (System.properties[j2sHeadlessBuildProperty].equals("true")) {
 162     println("Setting IN_ECLIPSE to ${IN_ECLIPSE} as System.properties['${j2sHeadlessBuildProperty}'] == '${System.properties[j2sHeadlessBuildProperty]}'")
 163     IN_ECLIPSE = false
 164   }
 165   if (IN_ECLIPSE) {
 166     println("WITHIN ECLIPSE IDE")
 167   } else {
 168     println("HEADLESS BUILD")
 169   }
 170
 171   J2S_ENABLED = (project.hasProperty('j2s.compiler.status') && project['j2s.compiler.status'] != null && project['j2s.compiler.status'] == "enable")
 172   if (J2S_ENABLED) {
 173     println("J2S ENABLED")
 174   }
 175   /* *-/
 176   System.properties.sort { it.key }.each {
 177     key, val -> println("SYSTEM PROPERTY ${key}='${val}'")
 178   }
 179   /-* *-/
 180   if (false && IN_ECLIPSE) {
 181     jalviewDir = jalviewDirAbsolutePath
 182   }
 183   */
 184
 185   // datestamp
 186   buildDate = new Date().format("yyyyMMdd")
 187
 188   // essentials
 189   bareSourceDir = string(source_dir)
 190   sourceDir = string("${jalviewDir}/${bareSourceDir}")
 191   resourceDir = string("${jalviewDir}/${resource_dir}")
 192   bareTestSourceDir = string(test_source_dir)
 193   testDir = string("${jalviewDir}/${bareTestSourceDir}")
 194
 195   classesDir = string("${jalviewDir}/${classes_dir}")
 196
 197   // clover
 198   useClover = clover.equals("true")
 199   cloverBuildDir = "${buildDir}/clover"
 200   cloverInstrDir = file("${cloverBuildDir}/clover-instr")
 201   cloverClassesDir = file("${cloverBuildDir}/clover-classes")
 202   cloverReportDir = file("${buildDir}/reports/clover")
 203   cloverTestInstrDir = file("${cloverBuildDir}/clover-test-instr")
 204   cloverTestClassesDir = file("${cloverBuildDir}/clover-test-classes")
 205   //cloverTestClassesDir = cloverClassesDir
 206   cloverDb = string("${cloverBuildDir}/clover.db")
 207
 208   testSourceDir = useClover ? cloverTestInstrDir : testDir
 209   testClassesDir = useClover ? cloverTestClassesDir : "${jalviewDir}/${test_output_dir}"
 210
 211   channelSuffix = ""
 212   backgroundImageText = BACKGROUNDIMAGETEXT
 213   getdownChannelDir = string("${getdown_website_dir}/${propertiesChannelName}")
 214   getdownAppBaseDir = string("${jalviewDir}/${getdownChannelDir}/${JAVA_VERSION}")
 215   getdownArchiveDir = string("${jalviewDir}/${getdown_archive_dir}")
 216   getdownFullArchiveDir = null
 217   getdownTextLines = []
 218   getdownLaunchJvl = null
 219   getdownVersionLaunchJvl = null
 220   buildDist = true
 221   buildProperties = null
 222
 223   // the following values might be overridden by the CHANNEL switch
 224   getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
 225   getdownAppBase = string("${getdown_channel_base}/${getdownDir}")
 226   getdownArchiveAppBase = getdown_archive_base
 227   getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher}")
 228   getdownAppDistDir = getdown_app_dir_alt
 229   getdownImagesDir = string("${jalviewDir}/${getdown_images_dir}")
 230   getdownImagesBuildDir = string("${buildDir}/imagemagick/getdown")
 231   getdownSetAppBaseProperty = false // whether to pass the appbase and appdistdir to the application
 232   reportRsyncCommand = false
 233   jvlChannelName = CHANNEL.toLowerCase()
 234   install4jSuffix = CHANNEL.substring(0, 1).toUpperCase() + CHANNEL.substring(1).toLowerCase(); // BUILD -> Build
 235   install4jDMGDSStore = "${install4j_images_dir}/${install4j_dmg_ds_store}"
 236   install4jDMGBackgroundImageDir = "${install4j_images_dir}"
 237   install4jDMGBackgroundImageBuildDir = "build/imagemagick/install4j"
 238   install4jDMGBackgroundImageFile = "${install4j_dmg_background}"
 239   install4jInstallerName = "${jalview_name} Non-Release Installer"
 240   install4jExecutableName = install4j_executable_name
 241   install4jExtraScheme = "jalviewx"
 242   install4jMacIconsFile = string("${install4j_images_dir}/${install4j_mac_icons_file}")
 243   install4jWindowsIconsFile = string("${install4j_images_dir}/${install4j_windows_icons_file}")
 244   install4jPngIconFile = string("${install4j_images_dir}/${install4j_png_icon_file}")
 245   install4jBackground = string("${install4j_images_dir}/${install4j_background}")
 246   install4jBuildDir = "${install4j_build_dir}/${JAVA_VERSION}"
 247   install4jCheckSums = true
 248
 249   applicationName = "${jalview_name}"
 250   switch (CHANNEL) {
 251
 252     case "BUILD":
 253     // TODO: get bamboo build artifact URL for getdown artifacts
 254     getdown_channel_base = bamboo_channelbase
 255     getdownChannelName = string("${bamboo_planKey}/${JAVA_VERSION}")
 256     getdownAppBase = string("${bamboo_channelbase}/${bamboo_planKey}${bamboo_getdown_channel_suffix}/${JAVA_VERSION}")
 257     jvlChannelName += "_${getdownChannelName}"
 258     // automatically add the test group Not-bamboo for exclusion
 259     if ("".equals(testng_excluded_groups)) {
 260       testng_excluded_groups = "Not-bamboo"
 261     }
 262     install4jExtraScheme = "jalviewb"
 263     backgroundImageText = true
 264     break
 265
 266     case [ "RELEASE", "JALVIEWJS-RELEASE" ]:
 267     getdownAppDistDir = getdown_app_dir_release
 268     getdownSetAppBaseProperty = true
 269     reportRsyncCommand = true
 270     install4jSuffix = ""
 271     install4jInstallerName = "${jalview_name} Installer"
 272     break
 273
 274     case "ARCHIVE":
 275     getdownChannelName = CHANNEL.toLowerCase()+"/${JALVIEW_VERSION}"
 276     getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
 277     getdownAppBase = string("${getdown_channel_base}/${getdownDir}")
 278     if (!file("${ARCHIVEDIR}/${package_dir}").exists()) {
 279       throw new GradleException("Must provide an ARCHIVEDIR value to produce an archive distribution")
 280     } else {
 281       package_dir = string("${ARCHIVEDIR}/${package_dir}")
 282       buildProperties = string("${ARCHIVEDIR}/${classes_dir}/${build_properties_file}")
 283       buildDist = false
 284     }
 285     reportRsyncCommand = true
 286     install4jExtraScheme = "jalviewa"
 287     break
 288
 289     case "ARCHIVELOCAL":
 290     getdownChannelName = string("archive/${JALVIEW_VERSION}")
 291     getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
 292     getdownAppBase = file(getdownAppBaseDir).toURI().toString()
 293     if (!file("${ARCHIVEDIR}/${package_dir}").exists()) {
 294       throw new GradleException("Must provide an ARCHIVEDIR value to produce an archive distribution [did not find '${ARCHIVEDIR}/${package_dir}']")
 295     } else {
 296       package_dir = string("${ARCHIVEDIR}/${package_dir}")
 297       buildProperties = string("${ARCHIVEDIR}/${classes_dir}/${build_properties_file}")
 298       buildDist = false
 299     }
 300     reportRsyncCommand = true
 301     getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
 302     install4jSuffix = "Archive"
 303     install4jExtraScheme = "jalviewa"
 304     break
 305
 306     case ~/^DEVELOP-([\.\-\w]*)$/:
 307     def suffix = Matcher.lastMatcher[0][1]
 308     reportRsyncCommand = true
 309     getdownSetAppBaseProperty = true
 310     JALVIEW_VERSION=JALVIEW_VERSION+"-d${suffix}-${buildDate}"
 311     install4jSuffix = "Develop ${suffix}"
 312     install4jExtraScheme = "jalviewd"
 313     install4jInstallerName = "${jalview_name} Develop ${suffix} Installer"
 314     getdownChannelName = string("develop-${suffix}")
 315     getdownChannelDir = string("${getdown_website_dir}/${getdownChannelName}")
 316     getdownAppBaseDir = string("${jalviewDir}/${getdownChannelDir}/${JAVA_VERSION}")
 317     getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
 318     getdownAppBase = string("${getdown_channel_base}/${getdownDir}")
 319     channelSuffix = string(suffix)
 320     backgroundImageText = true
 321     break
 322
 323     case "DEVELOP":
 324     reportRsyncCommand = true
 325     getdownSetAppBaseProperty = true
 326     // DEVELOP-RELEASE is usually associated with a Jalview release series so set the version
 327     JALVIEW_VERSION=JALVIEW_VERSION+"-d${buildDate}"
 328
 329     install4jSuffix = "Develop"
 330     install4jExtraScheme = "jalviewd"
 331     install4jInstallerName = "${jalview_name} Develop Installer"
 332     backgroundImageText = true
 333     break
 334
 335     case "TEST-RELEASE":
 336     reportRsyncCommand = true
 337     getdownSetAppBaseProperty = true
 338     // Don't ignore transpile errors for release build
 339     if (jalviewjs_ignore_transpile_errors.equals("true")) {
 340       jalviewjs_ignore_transpile_errors = "false"
 341       println("Setting jalviewjs_ignore_transpile_errors to 'false'")
 342     }
 343     JALVIEW_VERSION = JALVIEW_VERSION+"-test"
 344     install4jSuffix = "Test"
 345     install4jExtraScheme = "jalviewt"
 346     install4jInstallerName = "${jalview_name} Test Installer"
 347     backgroundImageText = true
 348     break
 349
 350     case ~/^SCRATCH(|-[-\w]*)$/:
 351     getdownChannelName = CHANNEL
 352     JALVIEW_VERSION = JALVIEW_VERSION+"-"+CHANNEL
 353
 354     getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
 355     getdownAppBase = string("${getdown_channel_base}/${getdownDir}")
 356     reportRsyncCommand = true
 357     install4jSuffix = "Scratch"
 358     break
 359
 360     case "TEST-LOCAL":
 361     if (!file("${LOCALDIR}").exists()) {
 362       throw new GradleException("Must provide a LOCALDIR value to produce a local distribution")
 363     } else {
 364       getdownAppBase = file(file("${LOCALDIR}").getAbsolutePath()).toURI().toString()
 365       getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
 366     }
 367     JALVIEW_VERSION = "TEST"
 368     install4jSuffix = "Test-Local"
 369     install4jExtraScheme = "jalviewt"
 370     install4jInstallerName = "${jalview_name} Test Installer"
 371     backgroundImageText = true
 372     break
 373
 374     case [ "LOCAL", "JALVIEWJS" ]:
 375     JALVIEW_VERSION = "TEST"
 376     getdownAppBase = file(getdownAppBaseDir).toURI().toString()
 377     getdownArchiveAppBase = file("${jalviewDir}/${getdown_archive_dir}").toURI().toString()
 378     getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
 379     install4jExtraScheme = "jalviewl"
 380     install4jCheckSums = false
 381     break
 382
 383     default: // something wrong specified
 384     throw new GradleException("CHANNEL must be one of BUILD, RELEASE, ARCHIVE, DEVELOP, TEST-RELEASE, SCRATCH-..., LOCAL [default]")
 385     break
 386
 387   }
 388   JALVIEW_VERSION_UNDERSCORES = JALVIEW_VERSION.replaceAll("\\.", "_")
 389   hugoDataJsonFile = file("${jalviewDir}/${hugo_build_dir}/${hugo_data_installers_dir}/installers-${JALVIEW_VERSION_UNDERSCORES}.json")
 390   hugoArchiveMdFile = file("${jalviewDir}/${hugo_build_dir}/${hugo_version_archive_dir}/Version-${JALVIEW_VERSION_UNDERSCORES}/_index.md")
 391   // override getdownAppBase if requested
 392   if (findProperty("getdown_appbase_override") != null) {
 393     // revert to LOCAL if empty string
 394     if (string(getdown_appbase_override) == "") {
 395       getdownAppBase = file(getdownAppBaseDir).toURI().toString()
 396       getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
 397     } else if (string(getdown_appbase_override).startsWith("file://")) {
 398       getdownAppBase = string(getdown_appbase_override)
 399       getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
 400     } else {
 401       getdownAppBase = string(getdown_appbase_override)
 402     }
 403     println("Overriding getdown appbase with '${getdownAppBase}'")
 404   }
 405   // sanitise file name for jalview launcher file for this channel
 406   jvlChannelName = jvlChannelName.replaceAll("[^\\w\\-]+", "_")
 407   // install4j application and folder names
 408   if (install4jSuffix == "") {
 409     install4jBundleId = "${install4j_bundle_id}"
 410     install4jWinApplicationId = install4j_release_win_application_id
 411   } else {
 412     applicationName = "${jalview_name} ${install4jSuffix}"
 413     install4jBundleId = "${install4j_bundle_id}-" + install4jSuffix.toLowerCase()
 414     // add int hash of install4jSuffix to the last part of the application_id
 415     def id = install4j_release_win_application_id
 416     def idsplitreverse = id.split("-").reverse()
 417     idsplitreverse[0] = idsplitreverse[0].toInteger() + install4jSuffix.hashCode()
 418     install4jWinApplicationId = idsplitreverse.reverse().join("-")
 419   }
 420   // sanitise folder and id names
 421   // install4jApplicationFolder = e.g. "Jalview Build"
 422   install4jApplicationFolder = applicationName
 423                                     .replaceAll("[\"'~:/\\\\\\s]", "_") // replace all awkward filename chars " ' ~ : / \
 424                                     .replaceAll("_+", "_") // collapse __
 425   install4jInternalId = applicationName
 426                                     .replaceAll(" ","_")
 427                                     .replaceAll("[^\\w\\-\\.]", "_") // replace other non [alphanumeric,_,-,.]
 428                                     .replaceAll("_+", "") // collapse __
 429                                     //.replaceAll("_*-_*", "-") // collapse _-_
 430   install4jUnixApplicationFolder = applicationName
 431                                     .replaceAll(" ","_")
 432                                     .replaceAll("[^\\w\\-\\.]", "_") // replace other non [alphanumeric,_,-,.]
 433                                     .replaceAll("_+", "_") // collapse __
 434                                     .replaceAll("_*-_*", "-") // collapse _-_
 435                                     .toLowerCase()
 436
 437   getdownWrapperLink = install4jUnixApplicationFolder // e.g. "jalview_local"
 438   getdownAppDir = string("${getdownAppBaseDir}/${getdownAppDistDir}")
 439   //getdownJ11libDir = "${getdownAppBaseDir}/${getdown_j11lib_dir}"
 440   getdownResourceDir = string("${getdownAppBaseDir}/${getdown_resource_dir}")
 441   getdownInstallDir = string("${getdownAppBaseDir}/${getdown_install_dir}")
 442   getdownFilesDir = string("${jalviewDir}/${getdown_files_dir}/${JAVA_VERSION}/")
 443   getdownFilesInstallDir = string("${getdownFilesDir}/${getdown_install_dir}")
 444   /* compile without modules -- using classpath libraries
 445   modules_compileClasspath = fileTree(dir: "${jalviewDir}/${j11modDir}", include: ["*.jar"])
 446   modules_runtimeClasspath = modules_compileClasspath
 447   */
 448
 449   gitHash = "SOURCE"
 450   gitBranch = "Source"
 451   try {
 452     apply plugin: "com.palantir.git-version"
 453     def details = versionDetails()
 454     gitHash = details.gitHash
 455     gitBranch = details.branchName
 456   } catch(org.gradle.api.internal.plugins.PluginApplicationException e) {
 457     println("Not in a git repository. Using git values from RELEASE properties file.")
 458     gitHash = releaseProps.getProperty("git.hash")
 459     gitBranch = releaseProps.getProperty("git.branch")
 460   } catch(java.lang.RuntimeException e1) {
 461     throw new GradleException("Error with git-version plugin.  Directory '.git' exists but versionDetails() cannot be found.")
 462   }
 463
 464   println("Using a ${CHANNEL} profile.")
 465
 466   additional_compiler_args = []
 467   // configure classpath/args for j8/j11 compilation
 468   if (JAVA_VERSION.equals("1.8")) {
 469     JAVA_INTEGER_VERSION = string("8")
 470     //libDir = j8libDir
 471     libDir = j11libDir
 472     libDistDir = j8libDir
 473     compile_source_compatibility = 1.8
 474     compile_target_compatibility = 1.8
 475     // these are getdown.txt properties defined dependent on the JAVA_VERSION
 476     getdownAltJavaMinVersion = string(findProperty("getdown_alt_java8_min_version"))
 477     getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java8_max_version"))
 478     // this property is assigned below and expanded to multiple lines in the getdown task
 479     getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java8_txt_multi_java_location"))
 480     // this property is for the Java library used in eclipse
 481     eclipseJavaRuntimeName = string("JavaSE-1.8")
 482   } else if (JAVA_VERSION.equals("11")) {
 483     JAVA_INTEGER_VERSION = string("11")
 484     libDir = j11libDir
 485     libDistDir = j11libDir
 486     compile_source_compatibility = 11
 487     compile_target_compatibility = 11
 488     getdownAltJavaMinVersion = string(findProperty("getdown_alt_java11_min_version"))
 489     getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java11_max_version"))
 490     getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java11_txt_multi_java_location"))
 491     eclipseJavaRuntimeName = string("JavaSE-11")
 492     /* compile without modules -- using classpath libraries
 493     additional_compiler_args += [
 494     '--module-path', modules_compileClasspath.asPath,
 495     '--add-modules', j11modules
 496     ]
 497      */
 498   } else if (JAVA_VERSION.equals("17")) {
 499     JAVA_INTEGER_VERSION = string("17")
 500     libDir = j17libDir
 501     libDistDir = j17libDir
 502     compile_source_compatibility = 17
 503     compile_target_compatibility = 17
 504     getdownAltJavaMinVersion = string(findProperty("getdown_alt_java11_min_version"))
 505     getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java11_max_version"))
 506     getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java11_txt_multi_java_location"))
 507     eclipseJavaRuntimeName = string("JavaSE-17")
 508     /* compile without modules -- using classpath libraries
 509     additional_compiler_args += [
 510     '--module-path', modules_compileClasspath.asPath,
 511     '--add-modules', j11modules
 512     ]
 513      */
 514   } else {
 515     throw new GradleException("JAVA_VERSION=${JAVA_VERSION} not currently supported by Jalview")
 516   }
 517
 518
 519   // for install4j
 520   JAVA_MIN_VERSION = JAVA_VERSION
 521   JAVA_MAX_VERSION = JAVA_VERSION
 522   jreInstallsDir = string(jre_installs_dir)
 523   if (jreInstallsDir.startsWith("~/")) {
 524     jreInstallsDir = System.getProperty("user.home") + jreInstallsDir.substring(1)
 525   }
 526   install4jDir = string("${jalviewDir}/${install4j_utils_dir}")
 527   install4jConfFileName = string("jalview-install4j-conf.install4j")
 528   install4jConfFile = file("${install4jDir}/${install4jConfFileName}")
 529   install4jHomeDir = install4j_home_dir
 530   if (install4jHomeDir.startsWith("~/")) {
 531     install4jHomeDir = System.getProperty("user.home") + install4jHomeDir.substring(1)
 532   }
 533
 534   resourceBuildDir = string("${buildDir}/resources")
 535   resourcesBuildDir = string("${resourceBuildDir}/resources_build")
 536   helpBuildDir = string("${resourceBuildDir}/help_build")
 537   docBuildDir = string("${resourceBuildDir}/doc_build")
 538
 539   if (buildProperties == null) {
 540     buildProperties = string("${resourcesBuildDir}/${build_properties_file}")
 541   }
 542   buildingHTML = string("${jalviewDir}/${doc_dir}/building.html")
 543   helpParentDir = string("${jalviewDir}/${help_parent_dir}")
 544   helpSourceDir = string("${helpParentDir}/${help_dir}")
 545   helpFile = string("${helpBuildDir}/${help_dir}/help.jhm")
 546
 547   convertBinary = null
 548   convertBinaryExpectedLocation = imagemagick_convert
 549   if (convertBinaryExpectedLocation.startsWith("~/")) {
 550     convertBinaryExpectedLocation = System.getProperty("user.home") + convertBinaryExpectedLocation.substring(1)
 551   }
 552   if (file(convertBinaryExpectedLocation).exists()) {
 553     convertBinary = convertBinaryExpectedLocation
 554   }
 555
 556   relativeBuildDir = file(jalviewDirAbsolutePath).toPath().relativize(buildDir.toPath())
 557   jalviewjsBuildDir = string("${relativeBuildDir}/jalviewjs")
 558   jalviewjsSiteDir = string("${jalviewjsBuildDir}/${jalviewjs_site_dir}")
 559   if (IN_ECLIPSE) {
 560     jalviewjsTransferSiteJsDir = string(jalviewjsSiteDir)
 561   } else {
 562     jalviewjsTransferSiteJsDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_js")
 563   }
 564   jalviewjsTransferSiteLibDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_lib")
 565   jalviewjsTransferSiteSwingJsDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_swingjs")
 566   jalviewjsTransferSiteMergeDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_merge")
 567   jalviewjsTransferSiteCoreDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_core")
 568   jalviewjsJalviewCoreHtmlFile = string("")
 569   jalviewjsJalviewCoreName = string(jalviewjs_core_name)
 570   jalviewjsCoreClasslists = []
 571   jalviewjsJalviewTemplateName = string(jalviewjs_name)
 572   jalviewjsJ2sSettingsFileName = string("${jalviewDir}/${jalviewjs_j2s_settings}")
 573   jalviewjsJ2sAltSettingsFileName = string("${jalviewDir}/${jalviewjs_j2s_alt_settings}")
 574   jalviewjsJ2sProps = null
 575   jalviewjsJ2sPlugin = jalviewjs_j2s_plugin
 576   jalviewjsStderrLaunchFilename = "${jalviewjsSiteDir}/"+(file(jalviewjs_stderr_launch).getName())
 577
 578   eclipseWorkspace = null
 579   eclipseBinary = string("")
 580   eclipseVersion = string("")
 581   eclipseDebug = false
 582
 583   jalviewjsChromiumUserDir = "${jalviewjsBuildDir}/${jalviewjs_chromium_user_dir}"
 584   jalviewjsChromiumProfileDir = "${ext.jalviewjsChromiumUserDir}/${jalviewjs_chromium_profile_name}"
 585
 586   // ENDEXT
 587 }
 588
 589
 590 sourceSets {
 591   main {
 592     java {
 593       srcDirs sourceDir
 594       outputDir = file(classesDir)
 595     }
 596
 597     resources {
 598       srcDirs = [ resourcesBuildDir, docBuildDir, helpBuildDir ]
 599     }
 600
 601     compileClasspath = files(sourceSets.main.java.outputDir)
 602     compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
 603
 604     runtimeClasspath = compileClasspath
 605     runtimeClasspath += files(sourceSets.main.resources.srcDirs)
 606   }
 607
 608   clover {
 609     java {
 610       srcDirs cloverInstrDir
 611       outputDir = cloverClassesDir
 612     }
 613
 614     resources {
 615       srcDirs = sourceSets.main.resources.srcDirs
 616     }
 617
 618     compileClasspath = files( sourceSets.clover.java.outputDir )
 619     //compileClasspath += files( testClassesDir )
 620     compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
 621     compileClasspath += fileTree(dir: "${jalviewDir}/${clover_lib_dir}", include: ["*.jar"])
 622     compileClasspath += fileTree(dir: "${jalviewDir}/${utils_dir}/testnglibs", include: ["**/*.jar"])
 623
 624     runtimeClasspath = compileClasspath
 625   }
 626
 627   test {
 628     java {
 629       srcDirs testSourceDir
 630       outputDir = file(testClassesDir)
 631     }
 632
 633     resources {
 634       srcDirs = useClover ? sourceSets.clover.resources.srcDirs : sourceSets.main.resources.srcDirs
 635     }
 636
 637     compileClasspath = files( sourceSets.test.java.outputDir )
 638     compileClasspath += useClover ? sourceSets.clover.compileClasspath : sourceSets.main.compileClasspath
 639     compileClasspath += fileTree(dir: "${jalviewDir}/${utils_dir}/testnglibs", include: ["**/*.jar"])
 640
 641     runtimeClasspath = compileClasspath
 642     runtimeClasspath += files(sourceSets.test.resources.srcDirs)
 643   }
 644
 645 }
 646
 647
 648 // eclipse project and settings files creation, also used by buildship
 649 eclipse {
 650   project {
 651     name = eclipse_project_name
 652
 653     natures 'org.eclipse.jdt.core.javanature',
 654     'org.eclipse.jdt.groovy.core.groovyNature',
 655     'org.eclipse.buildship.core.gradleprojectnature'
 656
 657     buildCommand 'org.eclipse.jdt.core.javabuilder'
 658     buildCommand 'org.eclipse.buildship.core.gradleprojectbuilder'
 659   }
 660
 661   classpath {
 662     //defaultOutputDir = sourceSets.main.java.outputDir
 663     configurations.each{ c->
 664       if (c.isCanBeResolved()) {
 665         minusConfigurations += [c]
 666       }
 667     }
 668
 669     plusConfigurations = [ ]
 670     file {
 671
 672       whenMerged { cp ->
 673         def removeTheseToo = []
 674         HashMap<String, Boolean> alreadyAddedSrcPath = new HashMap<>();
 675         cp.entries.each { entry ->
 676           // This conditional removes all src classpathentries that a) have already been added or b) aren't "src" or "test".
 677           // e.g. this removes the resources dir being copied into bin/main, bin/test AND bin/clover
 678           // we add the resources and help/help dirs in as libs afterwards (see below)
 679           if (entry.kind == 'src') {
 680             if (alreadyAddedSrcPath.getAt(entry.path) || !(entry.path == bareSourceDir || entry.path == bareTestSourceDir)) {
 681               removeTheseToo += entry
 682             } else {
 683               alreadyAddedSrcPath.putAt(entry.path, true)
 684             }
 685           }
 686
 687         }
 688         cp.entries.removeAll(removeTheseToo)
 689
 690         //cp.entries += new Output("${eclipse_bin_dir}/main")
 691         if (file(helpParentDir).isDirectory()) {
 692           cp.entries += new Library(fileReference(helpParentDir))
 693         }
 694         if (file(resourceDir).isDirectory()) {
 695           cp.entries += new Library(fileReference(resourceDir))
 696         }
 697
 698         HashMap<String, Boolean> alreadyAddedLibPath = new HashMap<>();
 699
 700         sourceSets.main.compileClasspath.findAll { it.name.endsWith(".jar") }.any {
 701           //don't want to add outputDir as eclipse is using its own output dir in bin/main
 702           if (it.isDirectory() || ! it.exists()) {
 703             // don't add dirs to classpath, especially if they don't exist
 704             return false // groovy "continue" in .any closure
 705           }
 706           def itPath = it.toString()
 707           if (itPath.startsWith("${jalviewDirAbsolutePath}/")) {
 708             // make relative path
 709             itPath = itPath.substring(jalviewDirAbsolutePath.length()+1)
 710           }
 711           if (alreadyAddedLibPath.get(itPath)) {
 712             //println("Not adding duplicate entry "+itPath)
 713           } else {
 714             //println("Adding entry "+itPath)
 715             cp.entries += new Library(fileReference(itPath))
 716             alreadyAddedLibPath.put(itPath, true)
 717           }
 718         }
 719
 720         sourceSets.test.compileClasspath.findAll { it.name.endsWith(".jar") }.any {
 721           //no longer want to add outputDir as eclipse is using its own output dir in bin/main
 722           if (it.isDirectory() || ! it.exists()) {
 723             // don't add dirs to classpath
 724             return false // groovy "continue" in .any closure
 725           }
 726
 727           def itPath = it.toString()
 728           if (itPath.startsWith("${jalviewDirAbsolutePath}/")) {
 729             itPath = itPath.substring(jalviewDirAbsolutePath.length()+1)
 730           }
 731           if (alreadyAddedLibPath.get(itPath)) {
 732             // don't duplicate
 733           } else {
 734             def lib = new Library(fileReference(itPath))
 735             lib.entryAttributes["test"] = "true"
 736             cp.entries += lib
 737             alreadyAddedLibPath.put(itPath, true)
 738           }
 739         }
 740
 741       } // whenMerged
 742
 743     } // file
 744
 745     containers 'org.eclipse.buildship.core.gradleclasspathcontainer'
 746
 747   } // classpath
 748
 749   jdt {
 750     // for the IDE, use java 11 compatibility
 751     sourceCompatibility = compile_source_compatibility
 752     targetCompatibility = compile_target_compatibility
 753     javaRuntimeName = eclipseJavaRuntimeName
 754
 755     // add in jalview project specific properties/preferences into eclipse core preferences
 756     file {
 757       withProperties { props ->
 758         def jalview_prefs = new Properties()
 759         def ins = new FileInputStream("${jalviewDirAbsolutePath}/${eclipse_extra_jdt_prefs_file}")
 760         jalview_prefs.load(ins)
 761         ins.close()
 762         jalview_prefs.forEach { t, v ->
 763           if (props.getAt(t) == null) {
 764             props.putAt(t, v)
 765           }
 766         }
 767         // codestyle file -- overrides previous formatter prefs
 768         def csFile = file("${jalviewDirAbsolutePath}/${eclipse_codestyle_file}")
 769         if (csFile.exists()) {
 770           XmlParser parser = new XmlParser()
 771           def profiles = parser.parse(csFile)
 772           def profile = profiles.'profile'.find { p -> (p.'@kind' == "CodeFormatterProfile" && p.'@name' == "Jalview") }
 773           if (profile != null) {
 774             profile.'setting'.each { s ->
 775               def id = s.'@id'
 776               def value = s.'@value'
 777               if (id != null && value != null) {
 778                 props.putAt(id, value)
 779               }
 780             }
 781           }
 782         }
 783       }
 784     }
 785
 786   } // jdt
 787
 788   if (IN_ECLIPSE) {
 789     // Don't want these to be activated if in headless build
 790     synchronizationTasks "eclipseSynchronizationTask"
 791     //autoBuildTasks "eclipseAutoBuildTask"
 792
 793   }
 794 }
 795
 796
 797 /* hack to change eclipse prefs in .settings files other than org.eclipse.jdt.core.prefs */
 798 // Class to allow updating arbitrary properties files
 799 class PropertiesFile extends PropertiesPersistableConfigurationObject {
 800   public PropertiesFile(PropertiesTransformer t) { super(t); }
 801   @Override protected void load(Properties properties) { }
 802   @Override protected void store(Properties properties) { }
 803   @Override protected String getDefaultResourceName() { return ""; }
 804   // This is necessary, because PropertiesPersistableConfigurationObject fails
 805   // if no default properties file exists.
 806   @Override public void loadDefaults() { load(new StringBufferInputStream("")); }
 807 }
 808
 809 // Task to update arbitrary properties files (set outputFile)
 810 class PropertiesFileTask extends PropertiesGeneratorTask<PropertiesFile> {
 811   private final PropertiesFileContentMerger file;
 812   public PropertiesFileTask() { file = new PropertiesFileContentMerger(getTransformer()); }
 813   protected PropertiesFile create() { return new PropertiesFile(getTransformer()); }
 814   protected void configure(PropertiesFile props) {
 815     file.getBeforeMerged().execute(props); file.getWhenMerged().execute(props);
 816   }
 817   public void file(Closure closure) { ConfigureUtil.configure(closure, file); }
 818 }
 819
 820 task eclipseUIPreferences(type: PropertiesFileTask) {
 821   description = "Generate Eclipse additional settings"
 822   def filename = "org.eclipse.jdt.ui.prefs"
 823   outputFile = "$projectDir/.settings/${filename}" as File
 824   file {
 825     withProperties {
 826       it.load new FileInputStream("$projectDir/utils/eclipse/${filename}" as String)
 827     }
 828   }
 829 }
 830
 831 task eclipseGroovyCorePreferences(type: PropertiesFileTask) {
 832   description = "Generate Eclipse additional settings"
 833   def filename = "org.eclipse.jdt.groovy.core.prefs"
 834   outputFile = "$projectDir/.settings/${filename}" as File
 835   file {
 836     withProperties {
 837       it.load new FileInputStream("$projectDir/utils/eclipse/${filename}" as String)
 838     }
 839   }
 840 }
 841
 842 task eclipseAllPreferences {
 843   dependsOn eclipseJdt
 844   dependsOn eclipseUIPreferences
 845   dependsOn eclipseGroovyCorePreferences
 846 }
 847
 848 eclipseUIPreferences.mustRunAfter eclipseJdt
 849 eclipseGroovyCorePreferences.mustRunAfter eclipseJdt
 850
 851 /* end of eclipse preferences hack */
 852
 853
 854 // clover bits
 855
 856
 857 task cleanClover {
 858   doFirst {
 859     delete cloverBuildDir
 860     delete cloverReportDir
 861   }
 862 }
 863
 864
 865 task cloverInstrJava(type: JavaExec) {
 866   group = "Verification"
 867   description = "Create clover instrumented source java files"
 868
 869   dependsOn cleanClover
 870
 871   inputs.files(sourceSets.main.allJava)
 872   outputs.dir(cloverInstrDir)
 873
 874   //classpath = fileTree(dir: "${jalviewDir}/${clover_lib_dir}", include: ["*.jar"])
 875   classpath = sourceSets.clover.compileClasspath
 876   main = "com.atlassian.clover.CloverInstr"
 877
 878   def argsList = [
 879     "--encoding",
 880     "UTF-8",
 881     "--initstring",
 882     cloverDb,
 883     "--destdir",
 884     cloverInstrDir.getPath(),
 885   ]
 886   def srcFiles = sourceSets.main.allJava.files
 887   argsList.addAll(
 888     srcFiles.collect(
 889       { file -> file.absolutePath }
 890     )
 891   )
 892   args argsList.toArray()
 893
 894   doFirst {
 895     delete cloverInstrDir
 896     println("Clover: About to instrument "+srcFiles.size() +" files")
 897   }
 898 }
 899
 900
 901 task cloverInstrTests(type: JavaExec) {
 902   group = "Verification"
 903   description = "Create clover instrumented source test files"
 904
 905   dependsOn cleanClover
 906
 907   inputs.files(testDir)
 908   outputs.dir(cloverTestInstrDir)
 909
 910   classpath = sourceSets.clover.compileClasspath
 911   main = "com.atlassian.clover.CloverInstr"
 912
 913   def argsList = [
 914     "--encoding",
 915     "UTF-8",
 916     "--initstring",
 917     cloverDb,
 918     "--srcdir",
 919     testDir,
 920     "--destdir",
 921     cloverTestInstrDir.getPath(),
 922   ]
 923   args argsList.toArray()
 924
 925   doFirst {
 926     delete cloverTestInstrDir
 927     println("Clover: About to instrument test files")
 928   }
 929 }
 930
 931
 932 task cloverInstr {
 933   group = "Verification"
 934   description = "Create clover instrumented all source files"
 935
 936   dependsOn cloverInstrJava
 937   dependsOn cloverInstrTests
 938 }
 939
 940
 941 cloverClasses.dependsOn cloverInstr
 942
 943
 944 task cloverConsoleReport(type: JavaExec) {
 945   group = "Verification"
 946   description = "Creates clover console report"
 947
 948   onlyIf {
 949     file(cloverDb).exists()
 950   }
 951
 952   inputs.dir cloverClassesDir
 953
 954   classpath = sourceSets.clover.runtimeClasspath
 955   main = "com.atlassian.clover.reporters.console.ConsoleReporter"
 956
 957   if (cloverreport_mem.length() > 0) {
 958     maxHeapSize = cloverreport_mem
 959   }
 960   if (cloverreport_jvmargs.length() > 0) {
 961     jvmArgs Arrays.asList(cloverreport_jvmargs.split(" "))
 962   }
 963
 964   def argsList = [
 965     "--alwaysreport",
 966     "--initstring",
 967     cloverDb,
 968     "--unittests"
 969   ]
 970
 971   args argsList.toArray()
 972 }
 973
 974
 975 task cloverHtmlReport(type: JavaExec) {
 976   group = "Verification"
 977   description = "Creates clover HTML report"
 978
 979   onlyIf {
 980     file(cloverDb).exists()
 981   }
 982
 983   def cloverHtmlDir = cloverReportDir
 984   inputs.dir cloverClassesDir
 985   outputs.dir cloverHtmlDir
 986
 987   classpath = sourceSets.clover.runtimeClasspath
 988   main = "com.atlassian.clover.reporters.html.HtmlReporter"
 989
 990   if (cloverreport_mem.length() > 0) {
 991     maxHeapSize = cloverreport_mem
 992   }
 993   if (cloverreport_jvmargs.length() > 0) {
 994     jvmArgs Arrays.asList(cloverreport_jvmargs.split(" "))
 995   }
 996
 997   def argsList = [
 998     "--alwaysreport",
 999     "--initstring",
1000     cloverDb,
1001     "--outputdir",
1002     cloverHtmlDir
1003   ]
1004
1005   if (cloverreport_html_options.length() > 0) {
1006     argsList += cloverreport_html_options.split(" ")
1007   }
1008
1009   args argsList.toArray()
1010 }
1011
1012
1013 task cloverXmlReport(type: JavaExec) {
1014   group = "Verification"
1015   description = "Creates clover XML report"
1016
1017   onlyIf {
1018     file(cloverDb).exists()
1019   }
1020
1021   def cloverXmlFile = "${cloverReportDir}/clover.xml"
1022   inputs.dir cloverClassesDir
1023   outputs.file cloverXmlFile
1024
1025   classpath = sourceSets.clover.runtimeClasspath
1026   main = "com.atlassian.clover.reporters.xml.XMLReporter"
1027
1028   if (cloverreport_mem.length() > 0) {
1029     maxHeapSize = cloverreport_mem
1030   }
1031   if (cloverreport_jvmargs.length() > 0) {
1032     jvmArgs Arrays.asList(cloverreport_jvmargs.split(" "))
1033   }
1034
1035   def argsList = [
1036     "--alwaysreport",
1037     "--initstring",
1038     cloverDb,
1039     "--outfile",
1040     cloverXmlFile
1041   ]
1042
1043   if (cloverreport_xml_options.length() > 0) {
1044     argsList += cloverreport_xml_options.split(" ")
1045   }
1046
1047   args argsList.toArray()
1048 }
1049
1050
1051 task cloverReport {
1052   group = "Verification"
1053   description = "Creates clover reports"
1054
1055   dependsOn cloverXmlReport
1056   dependsOn cloverHtmlReport
1057 }
1058
1059
1060 compileCloverJava {
1061
1062   doFirst {
1063     sourceCompatibility = compile_source_compatibility
1064     targetCompatibility = compile_target_compatibility
1065     options.compilerArgs += additional_compiler_args
1066     print ("Setting target compatibility to "+targetCompatibility+"\n")
1067   }
1068   //classpath += configurations.cloverRuntime
1069 }
1070 // end clover bits
1071
1072
1073 compileJava {
1074   // JBP->BS should the print statement in doFirst refer to compile_target_compatibility ?
1075   sourceCompatibility = compile_source_compatibility
1076   targetCompatibility = compile_target_compatibility
1077   options.compilerArgs += additional_compiler_args
1078   options.encoding = "UTF-8"
1079   doFirst {
1080     print ("Setting target compatibility to "+compile_target_compatibility+"\n")
1081   }
1082
1083 }
1084
1085
1086 compileTestJava {
1087   sourceCompatibility = compile_source_compatibility
1088   targetCompatibility = compile_target_compatibility
1089   options.compilerArgs += additional_compiler_args
1090   doFirst {
1091     print ("Setting target compatibility to "+targetCompatibility+"\n")
1092   }
1093 }
1094
1095
1096 clean {
1097   doFirst {
1098     delete sourceSets.main.java.outputDir
1099   }
1100 }
1101
1102
1103 cleanTest {
1104   dependsOn cleanClover
1105   doFirst {
1106     delete sourceSets.test.java.outputDir
1107   }
1108 }
1109
1110
1111 // format is a string like date.format("dd MMMM yyyy")
1112 def getDate(format) {
1113   return date.format(format)
1114 }
1115
1116
1117 def convertMdToHtml (FileTree mdFiles, File cssFile) {
1118   MutableDataSet options = new MutableDataSet()
1119
1120   def extensions = new ArrayList<>()
1121   extensions.add(AnchorLinkExtension.create())
1122   extensions.add(AutolinkExtension.create())
1123   extensions.add(StrikethroughExtension.create())
1124   extensions.add(TaskListExtension.create())
1125   extensions.add(TablesExtension.create())
1126   extensions.add(TocExtension.create())
1127
1128   options.set(Parser.EXTENSIONS, extensions)
1129
1130   // set GFM table parsing options
1131   options.set(TablesExtension.WITH_CAPTION, false)
1132   options.set(TablesExtension.COLUMN_SPANS, false)
1133   options.set(TablesExtension.MIN_HEADER_ROWS, 1)
1134   options.set(TablesExtension.MAX_HEADER_ROWS, 1)
1135   options.set(TablesExtension.APPEND_MISSING_COLUMNS, true)
1136   options.set(TablesExtension.DISCARD_EXTRA_COLUMNS, true)
1137   options.set(TablesExtension.HEADER_SEPARATOR_COLUMN_MATCH, true)
1138   // GFM anchor links
1139   options.set(AnchorLinkExtension.ANCHORLINKS_SET_ID, false)
1140   options.set(AnchorLinkExtension.ANCHORLINKS_ANCHOR_CLASS, "anchor")
1141   options.set(AnchorLinkExtension.ANCHORLINKS_SET_NAME, true)
1142   options.set(AnchorLinkExtension.ANCHORLINKS_TEXT_PREFIX, "<span class=\"octicon octicon-link\"></span>")
1143
1144   Parser parser = Parser.builder(options).build()
1145   HtmlRenderer renderer = HtmlRenderer.builder(options).build()
1146
1147   mdFiles.each { mdFile ->
1148     // add table of contents
1149     def mdText = "[TOC]\n"+mdFile.text
1150
1151     // grab the first top-level title
1152     def title = null
1153     def titleRegex = /(?m)^#(\s+|([^#]))(.*)/
1154     def matcher = mdText =~ titleRegex
1155     if (matcher.size() > 0) {
1156       // matcher[0][2] is the first character of the title if there wasn't any whitespace after the #
1157       title = (matcher[0][2] != null ? matcher[0][2] : "")+matcher[0][3]
1158     }
1159     // or use the filename if none found
1160     if (title == null) {
1161       title = mdFile.getName()
1162     }
1163
1164     Node document = parser.parse(mdText)
1165     String htmlBody = renderer.render(document)
1166     def htmlText = '''<html>
1167 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1168 <html xmlns="http://www.w3.org/1999/xhtml">
1169   <head>
1170     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1171     <meta http-equiv="Content-Style-Type" content="text/css" />
1172     <meta name="generator" content="flexmark" />
1173 '''
1174     htmlText += ((title != null) ? "  <title>${title}</title>" : '' )
1175     htmlText += '''
1176     <style type="text/css">code{white-space: pre;}</style>
1177 '''
1178     htmlText += ((cssFile != null) ? cssFile.text : '')
1179     htmlText += '''</head>
1180   <body>
1181 '''
1182     htmlText += htmlBody
1183     htmlText += '''
1184   </body>
1185 </html>
1186 '''
1187
1188     def htmlFilePath = mdFile.getPath().replaceAll(/\..*?$/, ".html")
1189     def htmlFile = file(htmlFilePath)
1190     println("Creating ${htmlFilePath}")
1191     htmlFile.text = htmlText
1192   }
1193 }
1194
1195
1196 task copyDocs(type: Copy) {
1197   def inputDir = "${jalviewDir}/${doc_dir}"
1198   def outputDir = "${docBuildDir}/${doc_dir}"
1199   from(inputDir) {
1200     include('**/*.txt')
1201     include('**/*.md')
1202     include('**/*.html')
1203     include('**/*.xml')
1204     filter(ReplaceTokens,
1205       beginToken: '$$',
1206       endToken: '$$',
1207       tokens: [
1208         'Version-Rel': JALVIEW_VERSION,
1209         'Year-Rel': getDate("yyyy")
1210       ]
1211     )
1212   }
1213   from(inputDir) {
1214     exclude('**/*.txt')
1215     exclude('**/*.md')
1216     exclude('**/*.html')
1217     exclude('**/*.xml')
1218   }
1219   into outputDir
1220
1221   inputs.dir(inputDir)
1222   outputs.dir(outputDir)
1223 }
1224
1225
1226 task convertMdFiles {
1227   dependsOn copyDocs
1228   def mdFiles = fileTree(dir: docBuildDir, include: "**/*.md")
1229   def cssFile = file("${jalviewDir}/${flexmark_css}")
1230
1231   doLast {
1232     convertMdToHtml(mdFiles, cssFile)
1233   }
1234
1235   inputs.files(mdFiles)
1236   inputs.file(cssFile)
1237
1238   def htmlFiles = []
1239   mdFiles.each { mdFile ->
1240     def htmlFilePath = mdFile.getPath().replaceAll(/\..*?$/, ".html")
1241     htmlFiles.add(file(htmlFilePath))
1242   }
1243   outputs.files(htmlFiles)
1244 }
1245
1246
1247 def hugoTemplateSubstitutions(String input, Map extras=null) {
1248   def replacements = [
1249     DATE: getDate("yyyy-MM-dd"),
1250     CHANNEL: propertiesChannelName,
1251     APPLICATION_NAME: applicationName,
1252     GIT_HASH: gitHash,
1253     GIT_BRANCH: gitBranch,
1254     VERSION: JALVIEW_VERSION,
1255     JAVA_VERSION: JAVA_VERSION,
1256     VERSION_UNDERSCORES: JALVIEW_VERSION_UNDERSCORES,
1257     DRAFT: "false",
1258     JVL_HEADER: ""
1259   ]
1260   def output = input
1261   if (extras != null) {
1262     extras.each{ k, v ->
1263       output = output.replaceAll("__${k}__", ((v == null)?"":v))
1264     }
1265   }
1266   replacements.each{ k, v ->
1267     output = output.replaceAll("__${k}__", ((v == null)?"":v))
1268   }
1269   return output
1270 }
1271
1272 def mdFileComponents(File mdFile, def dateOnly=false) {
1273   def map = [:]
1274   def content = ""
1275   if (mdFile.exists()) {
1276     def inFrontMatter = false
1277     def firstLine = true
1278     mdFile.eachLine { line ->
1279       if (line.matches("---")) {
1280         def prev = inFrontMatter
1281         inFrontMatter = firstLine
1282         if (inFrontMatter != prev)
1283           return false
1284       }
1285       if (inFrontMatter) {
1286         def m = null
1287         if (m = line =~ /^date:\s*(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2})/) {
1288           map["date"] = new Date().parse("yyyy-MM-dd HH:mm:ss", m[0][1])
1289         } else if (m = line =~ /^date:\s*(\d{4}-\d{2}-\d{2})/) {
1290           map["date"] = new Date().parse("yyyy-MM-dd", m[0][1])
1291         } else if (m = line =~ /^channel:\s*(\S+)/) {
1292           map["channel"] = m[0][1]
1293         } else if (m = line =~ /^version:\s*(\S+)/) {
1294           map["version"] = m[0][1]
1295         } else if (m = line =~ /^\s*([^:]+)\s*:\s*(\S.*)/) {
1296           map[ m[0][1] ] = m[0][2]
1297         }
1298         if (dateOnly && map["date"] != null) {
1299           return false
1300         }
1301       } else {
1302         if (dateOnly)
1303           return false
1304         content += line+"\n"
1305       }
1306       firstLine = false
1307     }
1308   }
1309   return dateOnly ? map["date"] : [map, content]
1310 }
1311
1312 task hugoTemplates {
1313   group "website"
1314   description "Create partially populated md pages for hugo website build"
1315
1316   def hugoTemplatesDir = file("${jalviewDir}/${hugo_templates_dir}")
1317   def hugoBuildDir = "${jalviewDir}/${hugo_build_dir}"
1318   def templateFiles = fileTree(dir: hugoTemplatesDir)
1319   def releaseMdFile = file("${jalviewDir}/${releases_dir}/release-${JALVIEW_VERSION_UNDERSCORES}.md")
1320   def whatsnewMdFile = file("${jalviewDir}/${whatsnew_dir}/whatsnew-${JALVIEW_VERSION_UNDERSCORES}.md")
1321   def oldJvlFile = file("${jalviewDir}/${hugo_old_jvl}")
1322   def jalviewjsFile = file("${jalviewDir}/${hugo_jalviewjs}")
1323
1324   doFirst {
1325     // specific release template for version archive
1326     def changes = ""
1327     def whatsnew = null
1328     def givenDate = null
1329     def givenChannel = null
1330     def givenVersion = null
1331     if (CHANNEL == "RELEASE") {
1332       def (map, content) = mdFileComponents(releaseMdFile)
1333       givenDate = map.date
1334       givenChannel = map.channel
1335       givenVersion = map.version
1336       changes = content
1337       if (givenVersion != null && givenVersion != JALVIEW_VERSION) {
1338         throw new GradleException("'version' header (${givenVersion}) found in ${releaseMdFile} does not match JALVIEW_VERSION (${JALVIEW_VERSION})")
1339       }
1340
1341       if (whatsnewMdFile.exists())
1342         whatsnew = whatsnewMdFile.text
1343     }
1344
1345     def oldJvl = oldJvlFile.exists() ? oldJvlFile.collect{it} : []
1346     def jalviewjsLink = jalviewjsFile.exists() ? jalviewjsFile.collect{it} : []
1347
1348     def changesHugo = null
1349     if (changes != null) {
1350       changesHugo = '<div class="release_notes">\n\n'
1351       def inSection = false
1352       changes.eachLine { line ->
1353         def m = null
1354         if (m = line =~ /^##([^#].*)$/) {
1355           if (inSection) {
1356             changesHugo += "</div>\n\n"
1357           }
1358           def section = m[0][1].trim()
1359           section = section.toLowerCase()
1360           section = section.replaceAll(/ +/, "_")
1361           section = section.replaceAll(/[^a-z0-9_\-]/, "")
1362           changesHugo += "<div class=\"${section}\">\n\n"
1363           inSection = true
1364         } else if (m = line =~ /^(\s*-\s*)<!--([^>]+)-->(.*?)(<br\/?>)?\s*$/) {
1365           def comment = m[0][2].trim()
1366           if (comment != "") {
1367             comment = comment.replaceAll('"', "&quot;")
1368             def issuekeys = []
1369             comment.eachMatch(/JAL-\d+/) { jal -> issuekeys += jal }
1370             def newline = m[0][1]
1371             if (comment.trim() != "")
1372               newline += "{{<comment>}}${comment}{{</comment>}}  "
1373             newline += m[0][3].trim()
1374             if (issuekeys.size() > 0)
1375               newline += "  {{< jal issue=\"${issuekeys.join(",")}\" alt=\"${comment}\" >}}"
1376             if (m[0][4] != null)
1377               newline += m[0][4]
1378             line = newline
1379           }
1380         }
1381         changesHugo += line+"\n"
1382       }
1383       if (inSection) {
1384         changesHugo += "\n</div>\n\n"
1385       }
1386       changesHugo += '</div>'
1387     }
1388
1389     templateFiles.each{ templateFile ->
1390       def newFileName = string(hugoTemplateSubstitutions(templateFile.getName()))
1391       def relPath = hugoTemplatesDir.toPath().relativize(templateFile.toPath()).getParent()
1392       def newRelPathName = hugoTemplateSubstitutions( relPath.toString() )
1393
1394       def outPathName = string("${hugoBuildDir}/$newRelPathName")
1395
1396       copy {
1397         from templateFile
1398         rename(templateFile.getName(), newFileName)
1399         into outPathName
1400       }
1401
1402       def newFile = file("${outPathName}/${newFileName}".toString())
1403       def content = newFile.text
1404       newFile.text = hugoTemplateSubstitutions(content,
1405         [
1406           WHATSNEW: whatsnew,
1407           CHANGES: changesHugo,
1408           DATE: givenDate == null ? "" : givenDate.format("yyyy-MM-dd"),
1409           DRAFT: givenDate == null ? "true" : "false",
1410           JALVIEWJSLINK: jalviewjsLink.contains(JALVIEW_VERSION) ? "true" : "false",
1411           JVL_HEADER: oldJvl.contains(JALVIEW_VERSION) ? "jvl: true" : ""
1412         ]
1413       )
1414     }
1415
1416   }
1417
1418   inputs.file(oldJvlFile)
1419   inputs.dir(hugoTemplatesDir)
1420   inputs.property("JALVIEW_VERSION", { JALVIEW_VERSION })
1421   inputs.property("CHANNEL", { CHANNEL })
1422 }
1423
1424 def getMdDate(File mdFile) {
1425   return mdFileComponents(mdFile, true)
1426 }
1427
1428 def getMdSections(String content) {
1429   def sections = [:]
1430   def sectionContent = ""
1431   def sectionName = null
1432   content.eachLine { line ->
1433     def m = null
1434     if (m = line =~ /^##([^#].*)$/) {
1435       if (sectionName != null) {
1436         sections[sectionName] = sectionContent
1437         sectionName = null
1438         sectionContent = ""
1439       }
1440       sectionName = m[0][1].trim()
1441       sectionName = sectionName.toLowerCase()
1442       sectionName = sectionName.replaceAll(/ +/, "_")
1443       sectionName = sectionName.replaceAll(/[^a-z0-9_\-]/, "")
1444     } else if (sectionName != null) {
1445       sectionContent += line+"\n"
1446     }
1447   }
1448   if (sectionContent != null) {
1449     sections[sectionName] = sectionContent
1450   }
1451   return sections
1452 }
1453
1454
1455 task copyHelp(type: Copy) {
1456   def inputDir = helpSourceDir
1457   def outputDir = "${helpBuildDir}/${help_dir}"
1458   from(inputDir) {
1459     include('**/*.txt')
1460     include('**/*.md')
1461     include('**/*.html')
1462     include('**/*.hs')
1463     include('**/*.xml')
1464     include('**/*.jhm')
1465     filter(ReplaceTokens,
1466       beginToken: '$$',
1467       endToken: '$$',
1468       tokens: [
1469         'Version-Rel': JALVIEW_VERSION,
1470         'Year-Rel': getDate("yyyy")
1471       ]
1472     )
1473   }
1474   from(inputDir) {
1475     exclude('**/*.txt')
1476     exclude('**/*.md')
1477     exclude('**/*.html')
1478     exclude('**/*.hs')
1479     exclude('**/*.xml')
1480     exclude('**/*.jhm')
1481   }
1482   into outputDir
1483
1484   inputs.dir(inputDir)
1485   outputs.files(helpFile)
1486   outputs.dir(outputDir)
1487 }
1488
1489
1490 task releasesTemplates {
1491   group "help"
1492   description "Recreate whatsNew.html and releases.html from markdown files and templates in help"
1493
1494   dependsOn copyHelp
1495
1496   def releasesTemplateFile = file("${jalviewDir}/${releases_template}")
1497   def whatsnewTemplateFile = file("${jalviewDir}/${whatsnew_template}")
1498   def releasesHtmlFile = file("${helpBuildDir}/${help_dir}/${releases_html}")
1499   def whatsnewHtmlFile = file("${helpBuildDir}/${help_dir}/${whatsnew_html}")
1500   def releasesMdDir = "${jalviewDir}/${releases_dir}"
1501   def whatsnewMdDir = "${jalviewDir}/${whatsnew_dir}"
1502
1503   doFirst {
1504     def releaseMdFile = file("${releasesMdDir}/release-${JALVIEW_VERSION_UNDERSCORES}.md")
1505     def whatsnewMdFile = file("${whatsnewMdDir}/whatsnew-${JALVIEW_VERSION_UNDERSCORES}.md")
1506
1507     if (CHANNEL == "RELEASE") {
1508       if (!releaseMdFile.exists()) {
1509         throw new GradleException("File ${releaseMdFile} must be created for RELEASE")
1510       }
1511       if (!whatsnewMdFile.exists()) {
1512         throw new GradleException("File ${whatsnewMdFile} must be created for RELEASE")
1513       }
1514     }
1515
1516     def releaseFiles = fileTree(dir: releasesMdDir, include: "release-*.md")
1517     def releaseFilesDates = releaseFiles.collectEntries {
1518       [(it): getMdDate(it)]
1519     }
1520     releaseFiles = releaseFiles.sort { a,b -> releaseFilesDates[a].compareTo(releaseFilesDates[b]) }
1521
1522     def releasesTemplate = releasesTemplateFile.text
1523     def m = releasesTemplate =~ /(?s)__VERSION_LOOP_START__(.*)__VERSION_LOOP_END__/
1524     def versionTemplate = m[0][1]
1525
1526     MutableDataSet options = new MutableDataSet()
1527
1528     def extensions = new ArrayList<>()
1529     options.set(Parser.EXTENSIONS, extensions)
1530     options.set(Parser.HTML_BLOCK_COMMENT_ONLY_FULL_LINE, true)
1531
1532     Parser parser = Parser.builder(options).build()
1533     HtmlRenderer renderer = HtmlRenderer.builder(options).build()
1534
1535     def actualVersions = releaseFiles.collect { rf ->
1536       def (rfMap, rfContent) = mdFileComponents(rf)
1537       return rfMap.version
1538     }
1539     def versionsHtml = ""
1540     def linkedVersions = []
1541     releaseFiles.reverse().each { rFile ->
1542       def (rMap, rContent) = mdFileComponents(rFile)
1543
1544       def versionLink = ""
1545       def partialVersion = ""
1546       def firstPart = true
1547       rMap.version.split("\\.").each { part ->
1548         def displayPart = ( firstPart ? "" : "." ) + part
1549         partialVersion += displayPart
1550         if (
1551             linkedVersions.contains(partialVersion)
1552             || ( actualVersions.contains(partialVersion) && partialVersion != rMap.version )
1553             ) {
1554           versionLink += displayPart
1555         } else {
1556           versionLink += "<a id=\"Jalview.${partialVersion}\">${displayPart}</a>"
1557           linkedVersions += partialVersion
1558         }
1559         firstPart = false
1560       }
1561       def displayDate = releaseFilesDates[rFile].format("dd/MM/yyyy")
1562
1563       def lm = null
1564       def rContentProcessed = ""
1565       rContent.eachLine { line ->
1566         if (lm = line =~ /^(\s*-)(\s*<!--[^>]*?-->)(.*)$/) {
1567           line = "${lm[0][1]}${lm[0][3]}${lm[0][2]}"
1568       } else if (lm = line =~ /^###([^#]+.*)$/) {
1569           line = "_${lm[0][1].trim()}_"
1570         }
1571         rContentProcessed += line + "\n"
1572       }
1573
1574       def rContentSections = getMdSections(rContentProcessed)
1575       def rVersion = versionTemplate
1576       if (rVersion != "") {
1577         def rNewFeatures = rContentSections["new_features"]
1578         def rIssuesResolved = rContentSections["issues_resolved"]
1579         Node newFeaturesNode = parser.parse(rNewFeatures)
1580         String newFeaturesHtml = renderer.render(newFeaturesNode)
1581         Node issuesResolvedNode = parser.parse(rIssuesResolved)
1582         String issuesResolvedHtml = renderer.render(issuesResolvedNode)
1583         rVersion = hugoTemplateSubstitutions(rVersion,
1584           [
1585             VERSION: rMap.version,
1586             VERSION_LINK: versionLink,
1587             DISPLAY_DATE: displayDate,
1588             NEW_FEATURES: newFeaturesHtml,
1589             ISSUES_RESOLVED: issuesResolvedHtml
1590           ]
1591         )
1592         versionsHtml += rVersion
1593       }
1594     }
1595
1596     releasesTemplate = releasesTemplate.replaceAll("(?s)__VERSION_LOOP_START__.*__VERSION_LOOP_END__", versionsHtml)
1597     releasesTemplate = hugoTemplateSubstitutions(releasesTemplate)
1598     releasesHtmlFile.text = releasesTemplate
1599
1600     if (whatsnewMdFile.exists()) {
1601       def wnDisplayDate = releaseFilesDates[releaseMdFile] != null ? releaseFilesDates[releaseMdFile].format("dd MMMM yyyy") : ""
1602       def whatsnewMd = hugoTemplateSubstitutions(whatsnewMdFile.text)
1603       Node whatsnewNode = parser.parse(whatsnewMd)
1604       String whatsnewHtml = renderer.render(whatsnewNode)
1605       whatsnewHtml = whatsnewTemplateFile.text.replaceAll("__WHATS_NEW__", whatsnewHtml)
1606       whatsnewHtmlFile.text = hugoTemplateSubstitutions(whatsnewHtml,
1607         [
1608             VERSION: JALVIEW_VERSION,
1609           DISPLAY_DATE: wnDisplayDate
1610         ]
1611       )
1612     } else if (gradle.taskGraph.hasTask(":linkCheck")) {
1613       whatsnewHtmlFile.text = "Development build " + getDate("yyyy-MM-dd HH:mm:ss")
1614     }
1615
1616   }
1617
1618   inputs.file(releasesTemplateFile)
1619   inputs.file(whatsnewTemplateFile)
1620   inputs.dir(releasesMdDir)
1621   inputs.dir(whatsnewMdDir)
1622   outputs.file(releasesHtmlFile)
1623   outputs.file(whatsnewHtmlFile)
1624 }
1625
1626
1627 task copyResources(type: Copy) {
1628   group = "build"
1629   description = "Copy (and make text substitutions in) the resources dir to the build area"
1630
1631   def inputDir = resourceDir
1632   def outputDir = resourcesBuildDir
1633   from(inputDir) {
1634     include('**/*.txt')
1635     include('**/*.md')
1636     include('**/*.html')
1637     include('**/*.xml')
1638     filter(ReplaceTokens,
1639       beginToken: '$$',
1640       endToken: '$$',
1641       tokens: [
1642         'Version-Rel': JALVIEW_VERSION,
1643         'Year-Rel': getDate("yyyy")
1644       ]
1645     )
1646   }
1647   from(inputDir) {
1648     exclude('**/*.txt')
1649     exclude('**/*.md')
1650     exclude('**/*.html')
1651     exclude('**/*.xml')
1652   }
1653   into outputDir
1654
1655   inputs.dir(inputDir)
1656   outputs.dir(outputDir)
1657 }
1658
1659 task copyChannelResources(type: Copy) {
1660   dependsOn copyResources
1661   group = "build"
1662   description = "Copy the channel resources dir to the build resources area"
1663
1664   def inputDir = "${channelDir}/${resource_dir}"
1665   def outputDir = resourcesBuildDir
1666   from(inputDir) {
1667     include(channel_props)
1668     filter(ReplaceTokens,
1669       beginToken: '__',
1670       endToken: '__',
1671       tokens: [
1672         'SUFFIX': channelSuffix
1673       ]
1674     )
1675   }
1676   from(inputDir) {
1677     exclude(channel_props)
1678   }
1679   into outputDir
1680
1681   inputs.dir(inputDir)
1682   outputs.dir(outputDir)
1683 }
1684
1685 task createBuildProperties(type: WriteProperties) {
1686   dependsOn copyResources
1687   group = "build"
1688   description = "Create the ${buildProperties} file"
1689
1690   inputs.dir(sourceDir)
1691   inputs.dir(resourcesBuildDir)
1692   outputFile (buildProperties)
1693   // taking time specific comment out to allow better incremental builds
1694   comment "--Jalview Build Details--\n"+getDate("yyyy-MM-dd HH:mm:ss")
1695   //comment "--Jalview Build Details--\n"+getDate("yyyy-MM-dd")
1696   property "BUILD_DATE", getDate("HH:mm:ss dd MMMM yyyy")
1697   property "VERSION", JALVIEW_VERSION
1698   property "INSTALLATION", INSTALLATION+" git-commit:"+gitHash+" ["+gitBranch+"]"
1699   property "JAVA_COMPILE_VERSION", JAVA_INTEGER_VERSION
1700   if (getdownSetAppBaseProperty) {
1701     property "GETDOWNAPPBASE", getdownAppBase
1702     property "GETDOWNAPPDISTDIR", getdownAppDistDir
1703   }
1704   outputs.file(outputFile)
1705 }
1706
1707
1708 task buildIndices(type: JavaExec) {
1709   dependsOn copyHelp
1710   classpath = sourceSets.main.compileClasspath
1711   main = "com.sun.java.help.search.Indexer"
1712   workingDir = "${helpBuildDir}/${help_dir}"
1713   def argDir = "html"
1714   args = [ argDir ]
1715   inputs.dir("${workingDir}/${argDir}")
1716
1717   outputs.dir("${classesDir}/doc")
1718   outputs.dir("${classesDir}/help")
1719   outputs.file("${workingDir}/JavaHelpSearch/DOCS")
1720   outputs.file("${workingDir}/JavaHelpSearch/DOCS.TAB")
1721   outputs.file("${workingDir}/JavaHelpSearch/OFFSETS")
1722   outputs.file("${workingDir}/JavaHelpSearch/POSITIONS")
1723   outputs.file("${workingDir}/JavaHelpSearch/SCHEMA")
1724   outputs.file("${workingDir}/JavaHelpSearch/TMAP")
1725 }
1726
1727 task buildResources {
1728   dependsOn copyResources
1729   dependsOn copyChannelResources
1730   dependsOn createBuildProperties
1731 }
1732
1733 task prepare {
1734   dependsOn buildResources
1735   dependsOn copyDocs
1736   dependsOn copyHelp
1737   dependsOn releasesTemplates
1738   dependsOn convertMdFiles
1739   dependsOn buildIndices
1740 }
1741
1742
1743 compileJava.dependsOn prepare
1744 run.dependsOn compileJava
1745 compileTestJava.dependsOn compileJava
1746
1747
1748
1749 test {
1750   group = "Verification"
1751   description = "Runs all testTaskN tasks)"
1752
1753   if (useClover) {
1754     dependsOn cloverClasses
1755   } else { //?
1756     dependsOn testClasses
1757   }
1758
1759   // not running tests in this task
1760   exclude "**/*"
1761 }
1762 /* testTask0 is the main test task */
1763 task testTask0(type: Test) {
1764   group = "Verification"
1765   description = "The main test task. Runs all non-testTaskN-labelled tests (unless excluded)"
1766   useTestNG() {
1767     includeGroups testng_groups.split(",")
1768     excludeGroups testng_excluded_groups.split(",")
1769     tasks.withType(Test).matching {it.name.startsWith("testTask") && it.name != name}.all {t -> excludeGroups t.name}
1770     preserveOrder true
1771     useDefaultListeners=true
1772   }
1773 }
1774
1775 /* separated tests */
1776 task testTask1(type: Test) {
1777   group = "Verification"
1778   description = "Tests that need to be isolated from the main test run"
1779   useTestNG() {
1780     includeGroups name
1781     excludeGroups testng_excluded_groups.split(",")
1782     preserveOrder true
1783     useDefaultListeners=true
1784   }
1785 }
1786
1787 task testTask2(type: Test) {
1788   group = "Verification"
1789   description = "Tests that need to be isolated from the main test run"
1790   useTestNG() {
1791     includeGroups name
1792     excludeGroups testng_excluded_groups.split(",")
1793     preserveOrder true
1794     useDefaultListeners=true
1795   }
1796 }
1797 task testTask3(type: Test) {
1798   group = "Verification"
1799   description = "Tests that need to be isolated from the main test run"
1800   useTestNG() {
1801     includeGroups name
1802     excludeGroups testng_excluded_groups.split(",")
1803     preserveOrder true
1804     useDefaultListeners=true
1805   }
1806 }
1807
1808 /* insert more testTaskNs here -- change N to next digit or other string */
1809 /*
1810 task testTaskN(type: Test) {
1811   group = "Verification"
1812   description = "Tests that need to be isolated from the main test run"
1813   useTestNG() {
1814     includeGroups name
1815     excludeGroups testng_excluded_groups.split(",")
1816     preserveOrder true
1817     useDefaultListeners=true
1818   }
1819 }
1820 */
1821
1822 /*
1823  * adapted from https://medium.com/@wasyl/pretty-tests-summary-in-gradle-744804dd676c
1824  * to summarise test results from all Test tasks
1825  */
1826 /* START of test tasks results summary */
1827 import groovy.time.TimeCategory
1828 import org.gradle.api.tasks.testing.logging.TestExceptionFormat
1829 import org.gradle.api.tasks.testing.logging.TestLogEvent
1830 rootProject.ext.testsResults = [] // Container for tests summaries
1831
1832 tasks.withType(Test).matching {t -> t.getName().startsWith("testTask")}.all { testTask ->
1833
1834   // from original test task
1835   if (useClover) {
1836     dependsOn cloverClasses
1837   } else { //?
1838     dependsOn testClasses //?
1839   }
1840
1841   // run main tests first
1842   if (!testTask.name.equals("testTask0"))
1843     testTask.mustRunAfter "testTask0"
1844
1845   testTask.testLogging { logging ->
1846     events TestLogEvent.FAILED
1847 //      TestLogEvent.SKIPPED,
1848 //      TestLogEvent.STANDARD_OUT,
1849 //      TestLogEvent.STANDARD_ERROR
1850
1851     exceptionFormat TestExceptionFormat.FULL
1852     showExceptions true
1853     showCauses true
1854     showStackTraces true
1855     if (test_output) {
1856       showStandardStreams true
1857     }
1858     info.events = [ TestLogEvent.FAILED ]
1859   }
1860
1861   if (OperatingSystem.current().isMacOsX()) {
1862     testTask.systemProperty "apple.awt.UIElement", "true"
1863     testTask.environment "JAVA_TOOL_OPTIONS", "-Dapple.awt.UIElement=true"
1864   }
1865
1866
1867   ignoreFailures = true // Always try to run all tests for all modules
1868
1869   afterSuite { desc, result ->
1870     if (desc.parent)
1871       return // Only summarize results for whole modules
1872
1873     def resultsInfo = [testTask.project.name, testTask.name, result, TimeCategory.minus(new Date(result.endTime), new Date(result.startTime)), testTask.reports.html.entryPoint]
1874
1875     rootProject.ext.testsResults.add(resultsInfo)
1876   }
1877
1878   // from original test task
1879   maxHeapSize = "1024m"
1880
1881   workingDir = jalviewDir
1882   def testLaf = project.findProperty("test_laf")
1883   if (testLaf != null) {
1884     println("Setting Test LaF to '${testLaf}'")
1885     systemProperty "laf", testLaf
1886   }
1887   def testHiDPIScale = project.findProperty("test_HiDPIScale")
1888   if (testHiDPIScale != null) {
1889     println("Setting Test HiDPI Scale to '${testHiDPIScale}'")
1890     systemProperty "sun.java2d.uiScale", testHiDPIScale
1891   }
1892   sourceCompatibility = compile_source_compatibility
1893   targetCompatibility = compile_target_compatibility
1894   jvmArgs += additional_compiler_args
1895
1896   doFirst {
1897     // this is not perfect yet -- we should only add the commandLineIncludePatterns to the
1898     // testTasks that include the tests, and exclude all from the others.
1899     // get --test argument
1900     filter.commandLineIncludePatterns = test.filter.commandLineIncludePatterns
1901     // do something with testTask.getCandidateClassFiles() to see if the test should silently finish because of the
1902     // commandLineIncludePatterns not matching anything.  Instead we are doing setFailOnNoMatchingTests(false) below
1903
1904
1905     if (useClover) {
1906       println("Running tests " + (useClover?"WITH":"WITHOUT") + " clover")
1907     }
1908   }
1909
1910
1911   /* don't fail on no matching tests (so --tests will run across all testTasks) */
1912   testTask.filter.setFailOnNoMatchingTests(false)
1913
1914   /* ensure the "test" task dependsOn all the testTasks */
1915   test.dependsOn testTask
1916 }
1917
1918 gradle.buildFinished {
1919     def allResults = rootProject.ext.testsResults
1920
1921     if (!allResults.isEmpty()) {
1922         printResults allResults
1923         allResults.each {r ->
1924           if (r[2].resultType == TestResult.ResultType.FAILURE)
1925             throw new GradleException("Failed tests!")
1926         }
1927     }
1928 }
1929
1930 private static String colString(styler, col, colour, text) {
1931   return col?"${styler[colour](text)}":text
1932 }
1933
1934 private static String getSummaryLine(s, pn, tn, rt, rc, rs, rf, rsk, t, col) {
1935   def colour = 'black'
1936   def text = rt
1937   def nocol = false
1938   if (rc == 0) {
1939     text = "-----"
1940     nocol = true
1941   } else {
1942     switch(rt) {
1943       case TestResult.ResultType.SUCCESS:
1944         colour = 'green'
1945         break;
1946       case TestResult.ResultType.FAILURE:
1947         colour = 'red'
1948         break;
1949       default:
1950         nocol = true
1951         break;
1952     }
1953   }
1954   StringBuilder sb = new StringBuilder()
1955   sb.append("${pn}")
1956   if (tn != null)
1957     sb.append(":${tn}")
1958   sb.append(" results: ")
1959   sb.append(colString(s, col && !nocol, colour, text))
1960   sb.append(" (")
1961   sb.append("${rc} tests, ")
1962   sb.append(colString(s, col && rs > 0, 'green', rs))
1963   sb.append(" successes, ")
1964   sb.append(colString(s, col && rf > 0, 'red', rf))
1965   sb.append(" failures, ")
1966   sb.append("${rsk} skipped) in ${t}")
1967   return sb.toString()
1968 }
1969
1970 private static void printResults(allResults) {
1971
1972     // styler from https://stackoverflow.com/a/56139852
1973     def styler = 'black red green yellow blue magenta cyan white'.split().toList().withIndex(30).collectEntries { key, val -> [(key) : { "\033[${val}m${it}\033[0m" }] }
1974
1975     def maxLength = 0
1976     def failedTests = false
1977     def summaryLines = []
1978     def totalcount = 0
1979     def totalsuccess = 0
1980     def totalfail = 0
1981     def totalskip = 0
1982     def totaltime = TimeCategory.getSeconds(0)
1983     // sort on project name then task name
1984     allResults.sort {a, b -> a[0] == b[0]? a[1]<=>b[1]:a[0] <=> b[0]}.each {
1985       def projectName = it[0]
1986       def taskName = it[1]
1987       def result = it[2]
1988       def time = it[3]
1989       def report = it[4]
1990       def summaryCol = getSummaryLine(styler, projectName, taskName, result.resultType, result.testCount, result.successfulTestCount, result.failedTestCount, result.skippedTestCount, time, true)
1991       def summaryPlain = getSummaryLine(styler, projectName, taskName, result.resultType, result.testCount, result.successfulTestCount, result.failedTestCount, result.skippedTestCount, time, false)
1992       def reportLine = "Report file: ${report}"
1993       def ls = summaryPlain.length()
1994       def lr = reportLine.length()
1995       def m = [ls, lr].max()
1996       if (m > maxLength)
1997         maxLength = m
1998       def info = [ls, summaryCol, reportLine]
1999       summaryLines.add(info)
2000       failedTests |= result.resultType == TestResult.ResultType.FAILURE
2001       totalcount += result.testCount
2002       totalsuccess += result.successfulTestCount
2003       totalfail += result.failedTestCount
2004       totalskip += result.skippedTestCount
2005       totaltime += time
2006     }
2007     def totalSummaryCol = getSummaryLine(styler, "OVERALL", "", failedTests?TestResult.ResultType.FAILURE:TestResult.ResultType.SUCCESS, totalcount, totalsuccess, totalfail, totalskip, totaltime, true)
2008     def totalSummaryPlain = getSummaryLine(styler, "OVERALL", "", failedTests?TestResult.ResultType.FAILURE:TestResult.ResultType.SUCCESS, totalcount, totalsuccess, totalfail, totalskip, totaltime, false)
2009     def tls = totalSummaryPlain.length()
2010     if (tls > maxLength)
2011       maxLength = tls
2012     def info = [tls, totalSummaryCol, null]
2013     summaryLines.add(info)
2014
2015     def allSummaries = []
2016     for(sInfo : summaryLines) {
2017       def ls = sInfo[0]
2018       def summary = sInfo[1]
2019       def report = sInfo[2]
2020
2021       StringBuilder sb = new StringBuilder()
2022       sb.append("│" + summary + " " * (maxLength - ls) + "│")
2023       if (report != null) {
2024         sb.append("\n│" + report + " " * (maxLength - report.length()) + "│")
2025       }
2026       allSummaries += sb.toString()
2027     }
2028
2029     println "┌${"${"─" * maxLength}"}┐"
2030     println allSummaries.join("\n├${"${"─" * maxLength}"}┤\n")
2031     println "└${"${"─" * maxLength}"}┘"
2032 }
2033 /* END of test tasks results summary */
2034
2035
2036 task compileLinkCheck(type: JavaCompile) {
2037   options.fork = true
2038   classpath = files("${jalviewDir}/${utils_dir}")
2039   destinationDir = file("${jalviewDir}/${utils_dir}")
2040   source = fileTree(dir: "${jalviewDir}/${utils_dir}", include: ["HelpLinksChecker.java", "BufferedLineReader.java"])
2041
2042   inputs.file("${jalviewDir}/${utils_dir}/HelpLinksChecker.java")
2043   inputs.file("${jalviewDir}/${utils_dir}/HelpLinksChecker.java")
2044   outputs.file("${jalviewDir}/${utils_dir}/HelpLinksChecker.class")
2045   outputs.file("${jalviewDir}/${utils_dir}/BufferedLineReader.class")
2046 }
2047
2048
2049 task linkCheck(type: JavaExec) {
2050   dependsOn prepare
2051   dependsOn compileLinkCheck
2052
2053   def helpLinksCheckerOutFile = file("${jalviewDir}/${utils_dir}/HelpLinksChecker.out")
2054   classpath = files("${jalviewDir}/${utils_dir}")
2055   main = "HelpLinksChecker"
2056   workingDir = "${helpBuildDir}"
2057   args = [ "${helpBuildDir}/${help_dir}", "-nointernet" ]
2058
2059   def outFOS = new FileOutputStream(helpLinksCheckerOutFile, false) // false == don't append
2060   standardOutput = new org.apache.tools.ant.util.TeeOutputStream(
2061     outFOS,
2062     System.out)
2063   errorOutput = new org.apache.tools.ant.util.TeeOutputStream(
2064     outFOS,
2065     System.err)
2066
2067   inputs.dir(helpBuildDir)
2068   outputs.file(helpLinksCheckerOutFile)
2069 }
2070
2071
2072 // import the pubhtmlhelp target
2073 ant.properties.basedir = "${jalviewDir}"
2074 ant.properties.helpBuildDir = "${helpBuildDir}/${help_dir}"
2075 ant.importBuild "${utils_dir}/publishHelp.xml"
2076
2077
2078 task cleanPackageDir(type: Delete) {
2079   doFirst {
2080     delete fileTree(dir: "${jalviewDir}/${package_dir}", include: "*.jar")
2081   }
2082 }
2083
2084
2085 jar {
2086   dependsOn prepare
2087   dependsOn linkCheck
2088
2089   manifest {
2090     attributes "Main-Class": main_class,
2091     "Permissions": "all-permissions",
2092     "Application-Name": applicationName,
2093     "Codebase": application_codebase,
2094     "Implementation-Version": JALVIEW_VERSION
2095   }
2096
2097   def outputDir = "${jalviewDir}/${package_dir}"
2098   destinationDirectory = file(outputDir)
2099   archiveFileName = rootProject.name+".jar"
2100   duplicatesStrategy "EXCLUDE"
2101
2102
2103   exclude "cache*/**"
2104   exclude "*.jar"
2105   exclude "*.jar.*"
2106   exclude "**/*.jar"
2107   exclude "**/*.jar.*"
2108
2109   inputs.dir(sourceSets.main.java.outputDir)
2110   sourceSets.main.resources.srcDirs.each{ dir ->
2111     inputs.dir(dir)
2112   }
2113   outputs.file("${outputDir}/${archiveFileName}")
2114 }
2115
2116
2117 task copyJars(type: Copy) {
2118   from fileTree(dir: classesDir, include: "**/*.jar").files
2119   into "${jalviewDir}/${package_dir}"
2120 }
2121
2122
2123 // doing a Sync instead of Copy as Copy doesn't deal with "outputs" very well
2124 task syncJars(type: Sync) {
2125   dependsOn jar
2126   from fileTree(dir: "${jalviewDir}/${libDistDir}", include: "**/*.jar").files
2127   into "${jalviewDir}/${package_dir}"
2128   preserve {
2129     include jar.archiveFileName.getOrNull()
2130   }
2131 }
2132
2133
2134 task makeDist {
2135   group = "build"
2136   description = "Put all required libraries in dist"
2137   // order of "cleanPackageDir", "copyJars", "jar" important!
2138   jar.mustRunAfter cleanPackageDir
2139   syncJars.mustRunAfter cleanPackageDir
2140   dependsOn cleanPackageDir
2141   dependsOn syncJars
2142   dependsOn jar
2143   outputs.dir("${jalviewDir}/${package_dir}")
2144 }
2145
2146
2147 task cleanDist {
2148   dependsOn cleanPackageDir
2149   dependsOn cleanTest
2150   dependsOn clean
2151 }
2152
2153
2154 shadowJar {
2155   group = "distribution"
2156   description = "Create a single jar file with all dependency libraries merged. Can be run with java -jar"
2157   if (buildDist) {
2158     dependsOn makeDist
2159   }
2160
2161   def jarFiles = fileTree(dir: "${jalviewDir}/${libDistDir}", include: "*.jar", exclude: "regex.jar").getFiles()
2162   def groovyJars = jarFiles.findAll {it1 -> file(it1).getName().startsWith("groovy-swing")}
2163   def otherJars = jarFiles.findAll {it2 -> !file(it2).getName().startsWith("groovy-swing")}
2164   from groovyJars
2165   from otherJars
2166
2167   // we need to include the groovy-swing Include-Package for it to run in the shadowJar
2168   doFirst {
2169     def jarFileManifests = []
2170     groovyJars.each { jarFile ->
2171       def mf = zipTree(jarFile).getFiles().find { it.getName().equals("MANIFEST.MF") }
2172       if (mf != null) {
2173         jarFileManifests += mf
2174       }
2175     }
2176
2177     manifest {
2178       attributes "Implementation-Version": JALVIEW_VERSION, "Application-Name": applicationName
2179       from (jarFileManifests) {
2180         eachEntry { details ->
2181           if (!details.key.equals("Import-Package")) {
2182             details.exclude()
2183           }
2184         }
2185       }
2186     }
2187   }
2188
2189   duplicatesStrategy "INCLUDE"
2190
2191   mainClassName = shadow_jar_main_class
2192   mergeServiceFiles()
2193   classifier = "all-"+JALVIEW_VERSION+"-j"+JAVA_VERSION
2194   minimize()
2195 }
2196
2197 task getdownImagesCopy() {
2198   inputs.dir getdownImagesDir
2199   outputs.dir getdownImagesBuildDir
2200
2201   doFirst {
2202     copy {
2203       from(getdownImagesDir) {
2204         include("*getdown*.png")
2205       }
2206       into getdownImagesBuildDir
2207     }
2208   }
2209 }
2210
2211 task getdownImagesProcess() {
2212   dependsOn getdownImagesCopy
2213
2214   doFirst {
2215     if (backgroundImageText) {
2216       if (convertBinary == null) {
2217         throw new StopExecutionException("No ImageMagick convert binary installed at '${convertBinaryExpectedLocation}'")
2218       }
2219       if (!project.hasProperty("getdown_background_image_text_suffix_cmd")) {
2220         throw new StopExecutionException("No property 'getdown_background_image_text_suffix_cmd' defined. See channel_gradle.properties for channel ${CHANNEL}")
2221       }
2222       fileTree(dir: getdownImagesBuildDir, include: "*background*.png").getFiles().each { file ->
2223         exec {
2224           executable convertBinary
2225           args = [
2226             file.getPath(),
2227             '-font', getdown_background_image_text_font,
2228             '-fill', getdown_background_image_text_colour,
2229             '-draw', sprintf(getdown_background_image_text_suffix_cmd, channelSuffix),
2230             '-draw', sprintf(getdown_background_image_text_commit_cmd, "git-commit: ${gitHash}"),
2231             '-draw', sprintf(getdown_background_image_text_date_cmd, getDate("yyyy-MM-dd HH:mm:ss")),
2232             file.getPath()
2233           ]
2234         }
2235       }
2236     }
2237   }
2238 }
2239
2240 task getdownImages() {
2241   dependsOn getdownImagesProcess
2242 }
2243
2244 task getdownWebsiteBuild() {
2245   group = "distribution"
2246   description = "Create the getdown minimal app folder, and website folder for this version of jalview. Website folder also used for offline app installer. No digest is created."
2247
2248   dependsOn getdownImages
2249   if (buildDist) {
2250     dependsOn makeDist
2251   }
2252
2253   def getdownWebsiteResourceFilenames = []
2254   def getdownResourceDir = getdownResourceDir
2255   def getdownResourceFilenames = []
2256
2257   doFirst {
2258     // clean the getdown website and files dir before creating getdown folders
2259     delete getdownAppBaseDir
2260     delete getdownFilesDir
2261
2262     copy {
2263       from buildProperties
2264       rename(file(buildProperties).getName(), getdown_build_properties)
2265       into getdownAppDir
2266     }
2267     getdownWebsiteResourceFilenames += "${getdownAppDistDir}/${getdown_build_properties}"
2268
2269     copy {
2270       from channelPropsFile
2271       filter(ReplaceTokens,
2272         beginToken: '__',
2273         endToken: '__',
2274         tokens: [
2275           'SUFFIX': channelSuffix
2276         ]
2277       )
2278       into getdownAppBaseDir
2279     }
2280     getdownWebsiteResourceFilenames += file(channelPropsFile).getName()
2281
2282     // set some getdownTxt_ properties then go through all properties looking for getdownTxt_...
2283     def props = project.properties.sort { it.key }
2284     if (getdownAltJavaMinVersion != null && getdownAltJavaMinVersion.length() > 0) {
2285       props.put("getdown_txt_java_min_version", getdownAltJavaMinVersion)
2286     }
2287     if (getdownAltJavaMaxVersion != null && getdownAltJavaMaxVersion.length() > 0) {
2288       props.put("getdown_txt_java_max_version", getdownAltJavaMaxVersion)
2289     }
2290     if (getdownAltMultiJavaLocation != null && getdownAltMultiJavaLocation.length() > 0) {
2291       props.put("getdown_txt_multi_java_location", getdownAltMultiJavaLocation)
2292     }
2293     if (getdownImagesBuildDir != null && file(getdownImagesBuildDir).exists()) {
2294       props.put("getdown_txt_ui.background_image", "${getdownImagesBuildDir}/${getdown_background_image}")
2295       props.put("getdown_txt_ui.instant_background_image", "${getdownImagesBuildDir}/${getdown_instant_background_image}")
2296       props.put("getdown_txt_ui.error_background", "${getdownImagesBuildDir}/${getdown_error_background}")
2297       props.put("getdown_txt_ui.progress_image", "${getdownImagesBuildDir}/${getdown_progress_image}")
2298       props.put("getdown_txt_ui.icon", "${getdownImagesDir}/${getdown_icon}")
2299       props.put("getdown_txt_ui.mac_dock_icon", "${getdownImagesDir}/${getdown_mac_dock_icon}")
2300     }
2301
2302     props.put("getdown_txt_title", jalview_name)
2303     props.put("getdown_txt_ui.name", applicationName)
2304
2305     // start with appbase
2306     getdownTextLines += "appbase = ${getdownAppBase}"
2307     props.each{ prop, val ->
2308       if (prop.startsWith("getdown_txt_") && val != null) {
2309         if (prop.startsWith("getdown_txt_multi_")) {
2310           def key = prop.substring(18)
2311           val.split(",").each{ v ->
2312             def line = "${key} = ${v}"
2313             getdownTextLines += line
2314           }
2315         } else {
2316           // file values rationalised
2317           if (val.indexOf('/') > -1 || prop.startsWith("getdown_txt_resource")) {
2318             def r = null
2319             if (val.indexOf('/') == 0) {
2320               // absolute path
2321               r = file(val)
2322             } else if (val.indexOf('/') > 0) {
2323               // relative path (relative to jalviewDir)
2324               r = file( "${jalviewDir}/${val}" )
2325             }
2326             if (r.exists()) {
2327               val = "${getdown_resource_dir}/" + r.getName()
2328               getdownWebsiteResourceFilenames += val
2329               getdownResourceFilenames += r.getPath()
2330             }
2331           }
2332           if (! prop.startsWith("getdown_txt_resource")) {
2333             def line = prop.substring(12) + " = ${val}"
2334             getdownTextLines += line
2335           }
2336         }
2337       }
2338     }
2339
2340     getdownWebsiteResourceFilenames.each{ filename ->
2341       getdownTextLines += "resource = ${filename}"
2342     }
2343     getdownResourceFilenames.each{ filename ->
2344       copy {
2345         from filename
2346         into getdownResourceDir
2347       }
2348     }
2349
2350     def getdownWrapperScripts = [ getdown_bash_wrapper_script, getdown_powershell_wrapper_script, getdown_batch_wrapper_script ]
2351     getdownWrapperScripts.each{ script ->
2352       def s = file( "${jalviewDir}/utils/getdown/${getdown_wrapper_script_dir}/${script}" )
2353       if (s.exists()) {
2354         copy {
2355           from s
2356           into "${getdownAppBaseDir}/${getdown_wrapper_script_dir}"
2357         }
2358         getdownTextLines += "xresource = ${getdown_wrapper_script_dir}/${script}"
2359       }
2360     }
2361
2362     def codeFiles = []
2363     fileTree(file(package_dir)).each{ f ->
2364       if (f.isDirectory()) {
2365         def files = fileTree(dir: f, include: ["*"]).getFiles()
2366         codeFiles += files
2367       } else if (f.exists()) {
2368         codeFiles += f
2369       }
2370     }
2371     def jalviewJar = jar.archiveFileName.getOrNull()
2372     // put jalview.jar first for CLASSPATH and .properties files reasons
2373     codeFiles.sort{a, b -> ( a.getName() == jalviewJar ? -1 : ( b.getName() == jalviewJar ? 1 : a <=> b ) ) }.each{f ->
2374       def name = f.getName()
2375       def line = "code = ${getdownAppDistDir}/${name}"
2376       getdownTextLines += line
2377       copy {
2378         from f.getPath()
2379         into getdownAppDir
2380       }
2381     }
2382
2383     // NOT USING MODULES YET, EVERYTHING SHOULD BE IN dist
2384     /*
2385     if (JAVA_VERSION.equals("11")) {
2386     def j11libFiles = fileTree(dir: "${jalviewDir}/${j11libDir}", include: ["*.jar"]).getFiles()
2387     j11libFiles.sort().each{f ->
2388     def name = f.getName()
2389     def line = "code = ${getdown_j11lib_dir}/${name}"
2390     getdownTextLines += line
2391     copy {
2392     from f.getPath()
2393     into getdownJ11libDir
2394     }
2395     }
2396     }
2397      */
2398
2399     // getdown-launcher.jar should not be in main application class path so the main application can move it when updated.  Listed as a resource so it gets updated.
2400     //getdownTextLines += "class = " + file(getdownLauncher).getName()
2401     getdownTextLines += "resource = ${getdown_launcher_new}"
2402     getdownTextLines += "class = ${main_class}"
2403     // Not setting these properties in general so that getdownappbase and getdowndistdir will default to release version in jalview.bin.Cache
2404     if (getdownSetAppBaseProperty) {
2405       getdownTextLines += "jvmarg = -Dgetdowndistdir=${getdownAppDistDir}"
2406       getdownTextLines += "jvmarg = -Dgetdownappbase=${getdownAppBase}"
2407     }
2408
2409     def getdownTxt = file("${getdownAppBaseDir}/getdown.txt")
2410     getdownTxt.write(getdownTextLines.join("\n"))
2411
2412     getdownLaunchJvl = getdown_launch_jvl_name + ( (jvlChannelName != null && jvlChannelName.length() > 0)?"-${jvlChannelName}":"" ) + ".jvl"
2413     def launchJvl = file("${getdownAppBaseDir}/${getdownLaunchJvl}")
2414     launchJvl.write("appbase=${getdownAppBase}")
2415
2416     // files going into the getdown website dir: getdown-launcher.jar
2417     copy {
2418       from getdownLauncher
2419       rename(file(getdownLauncher).getName(), getdown_launcher_new)
2420       into getdownAppBaseDir
2421     }
2422
2423     // files going into the getdown website dir: getdown-launcher(-local).jar
2424     copy {
2425       from getdownLauncher
2426       if (file(getdownLauncher).getName() != getdown_launcher) {
2427         rename(file(getdownLauncher).getName(), getdown_launcher)
2428       }
2429       into getdownAppBaseDir
2430     }
2431
2432     // files going into the getdown website dir: ./install dir and files
2433     if (! (CHANNEL.startsWith("ARCHIVE") || CHANNEL.startsWith("DEVELOP"))) {
2434       copy {
2435         from getdownTxt
2436         from getdownLauncher
2437         from "${getdownAppDir}/${getdown_build_properties}"
2438         if (file(getdownLauncher).getName() != getdown_launcher) {
2439           rename(file(getdownLauncher).getName(), getdown_launcher)
2440         }
2441         into getdownInstallDir
2442       }
2443
2444       // and make a copy in the getdown files dir (these are not downloaded by getdown)
2445       copy {
2446         from getdownInstallDir
2447         into getdownFilesInstallDir
2448       }
2449     }
2450
2451     // files going into the getdown files dir: getdown.txt, getdown-launcher.jar, channel-launch.jvl, build_properties
2452     copy {
2453       from getdownTxt
2454       from launchJvl
2455       from getdownLauncher
2456       from "${getdownAppBaseDir}/${getdown_build_properties}"
2457       from "${getdownAppBaseDir}/${channel_props}"
2458       if (file(getdownLauncher).getName() != getdown_launcher) {
2459         rename(file(getdownLauncher).getName(), getdown_launcher)
2460       }
2461       into getdownFilesDir
2462     }
2463
2464     // and ./resource (not all downloaded by getdown)
2465     copy {
2466       from getdownResourceDir
2467       into "${getdownFilesDir}/${getdown_resource_dir}"
2468     }
2469   }
2470
2471   if (buildDist) {
2472     inputs.dir("${jalviewDir}/${package_dir}")
2473   }
2474   outputs.dir(getdownAppBaseDir)
2475   outputs.dir(getdownFilesDir)
2476 }
2477
2478
2479 // a helper task to allow getdown digest of any dir: `gradle getdownDigestDir -PDIGESTDIR=/path/to/my/random/getdown/dir
2480 task getdownDigestDir(type: JavaExec) {
2481   group "Help"
2482   description "A task to run a getdown Digest on a dir with getdown.txt. Provide a DIGESTDIR property via -PDIGESTDIR=..."
2483
2484   def digestDirPropertyName = "DIGESTDIR"
2485   doFirst {
2486     classpath = files(getdownLauncher)
2487     def digestDir = findProperty(digestDirPropertyName)
2488     if (digestDir == null) {
2489       throw new GradleException("Must provide a DIGESTDIR value to produce an alternative getdown digest")
2490     }
2491     args digestDir
2492   }
2493   main = "com.threerings.getdown.tools.Digester"
2494 }
2495
2496
2497 task getdownDigest(type: JavaExec) {
2498   group = "distribution"
2499   description = "Digest the getdown website folder"
2500
2501   dependsOn getdownWebsiteBuild
2502
2503   doFirst {
2504     classpath = files(getdownLauncher)
2505   }
2506   main = "com.threerings.getdown.tools.Digester"
2507   args getdownAppBaseDir
2508   inputs.dir(getdownAppBaseDir)
2509   outputs.file("${getdownAppBaseDir}/digest2.txt")
2510 }
2511
2512
2513 task getdown() {
2514   group = "distribution"
2515   description = "Create the minimal and full getdown app folder for installers and website and create digest file"
2516   dependsOn getdownDigest
2517   doLast {
2518     if (reportRsyncCommand) {
2519       def fromDir = getdownAppBaseDir + (getdownAppBaseDir.endsWith('/')?'':'/')
2520       def toDir = "${getdown_rsync_dest}/${getdownDir}" + (getdownDir.endsWith('/')?'':'/')
2521       println "LIKELY RSYNC COMMAND:"
2522       println "mkdir -p '$toDir'\nrsync -avh --delete '$fromDir' '$toDir'"
2523       if (RUNRSYNC == "true") {
2524         exec {
2525           commandLine "mkdir", "-p", toDir
2526         }
2527         exec {
2528           commandLine "rsync", "-avh", "--delete", fromDir, toDir
2529         }
2530       }
2531     }
2532   }
2533 }
2534
2535 task getdownWebsite {
2536   group = "distribution"
2537   description = "A task to create the whole getdown channel website dir including digest file"
2538
2539   dependsOn getdownWebsiteBuild
2540   dependsOn getdownDigest
2541 }
2542
2543 task getdownArchiveBuild() {
2544   group = "distribution"
2545   description = "Put files in the archive dir to go on the website"
2546
2547   dependsOn getdownWebsiteBuild
2548
2549   def v = "v${JALVIEW_VERSION_UNDERSCORES}"
2550   def vDir = "${getdownArchiveDir}/${v}"
2551   getdownFullArchiveDir = "${vDir}/getdown"
2552   getdownVersionLaunchJvl = "${vDir}/jalview-${v}.jvl"
2553
2554   def vAltDir = "alt_${v}"
2555   def archiveImagesDir = "${jalviewDir}/${channel_properties_dir}/old/images"
2556
2557   doFirst {
2558     // cleanup old "old" dir
2559     delete getdownArchiveDir
2560
2561     def getdownArchiveTxt = file("${getdownFullArchiveDir}/getdown.txt")
2562     getdownArchiveTxt.getParentFile().mkdirs()
2563     def getdownArchiveTextLines = []
2564     def getdownFullArchiveAppBase = "${getdownArchiveAppBase}${getdownArchiveAppBase.endsWith("/")?"":"/"}${v}/getdown/"
2565
2566     // the libdir
2567     copy {
2568       from "${getdownAppBaseDir}/${getdownAppDistDir}"
2569       into "${getdownFullArchiveDir}/${vAltDir}"
2570     }
2571
2572     getdownTextLines.each { line ->
2573       line = line.replaceAll("^(?<s>appbase\\s*=\\s*).*", '${s}'+getdownFullArchiveAppBase)
2574       line = line.replaceAll("^(?<s>(resource|code)\\s*=\\s*)${getdownAppDistDir}/", '${s}'+vAltDir+"/")
2575       line = line.replaceAll("^(?<s>ui.background_image\\s*=\\s*).*\\.png", '${s}'+"${getdown_resource_dir}/jalview_archive_getdown_background.png")
2576       line = line.replaceAll("^(?<s>ui.instant_background_image\\s*=\\s*).*\\.png", '${s}'+"${getdown_resource_dir}/jalview_archive_getdown_background_initialising.png")
2577       line = line.replaceAll("^(?<s>ui.error_background\\s*=\\s*).*\\.png", '${s}'+"${getdown_resource_dir}/jalview_archive_getdown_background_error.png")
2578       line = line.replaceAll("^(?<s>ui.progress_image\\s*=\\s*).*\\.png", '${s}'+"${getdown_resource_dir}/jalview_archive_getdown_progress_bar.png")
2579       // remove the existing resource = resource/ or bin/ lines
2580       if (! line.matches("resource\\s*=\\s*(resource|bin)/.*")) {
2581         getdownArchiveTextLines += line
2582       }
2583     }
2584
2585     // the resource dir -- add these files as resource lines in getdown.txt
2586     copy {
2587       from "${archiveImagesDir}"
2588       into "${getdownFullArchiveDir}/${getdown_resource_dir}"
2589       eachFile { file ->
2590         getdownArchiveTextLines += "resource = ${getdown_resource_dir}/${file.getName()}"
2591       }
2592     }
2593
2594     getdownArchiveTxt.write(getdownArchiveTextLines.join("\n"))
2595
2596     def vLaunchJvl = file(getdownVersionLaunchJvl)
2597     vLaunchJvl.getParentFile().mkdirs()
2598     vLaunchJvl.write("appbase=${getdownFullArchiveAppBase}\n")
2599     def vLaunchJvlPath = vLaunchJvl.toPath().toAbsolutePath()
2600     def jvlLinkPath = file("${vDir}/jalview.jvl").toPath().toAbsolutePath()
2601     // for some reason filepath.relativize(fileInSameDirPath) gives a path to "../" which is wrong
2602     //java.nio.file.Files.createSymbolicLink(jvlLinkPath, jvlLinkPath.relativize(vLaunchJvlPath));
2603     java.nio.file.Files.createSymbolicLink(jvlLinkPath, java.nio.file.Paths.get(".",vLaunchJvl.getName()));
2604
2605     // files going into the getdown files dir: getdown.txt, getdown-launcher.jar, channel-launch.jvl, build_properties
2606     copy {
2607       from getdownLauncher
2608       from "${getdownAppBaseDir}/${getdownLaunchJvl}"
2609       from "${getdownAppBaseDir}/${getdown_launcher_new}"
2610       from "${getdownAppBaseDir}/${channel_props}"
2611       if (file(getdownLauncher).getName() != getdown_launcher) {
2612         rename(file(getdownLauncher).getName(), getdown_launcher)
2613       }
2614       into getdownFullArchiveDir
2615     }
2616
2617   }
2618 }
2619
2620 task getdownArchiveDigest(type: JavaExec) {
2621   group = "distribution"
2622   description = "Digest the getdown archive folder"
2623
2624   dependsOn getdownArchiveBuild
2625
2626   doFirst {
2627     classpath = files(getdownLauncher)
2628     args getdownFullArchiveDir
2629   }
2630   main = "com.threerings.getdown.tools.Digester"
2631   inputs.dir(getdownFullArchiveDir)
2632   outputs.file("${getdownFullArchiveDir}/digest2.txt")
2633 }
2634
2635 task getdownArchive() {
2636   group = "distribution"
2637   description = "Build the website archive dir with getdown digest"
2638
2639   dependsOn getdownArchiveBuild
2640   dependsOn getdownArchiveDigest
2641 }
2642
2643 tasks.withType(JavaCompile) {
2644         options.encoding = 'UTF-8'
2645 }
2646
2647
2648 clean {
2649   doFirst {
2650     delete getdownAppBaseDir
2651     delete getdownFilesDir
2652     delete getdownArchiveDir
2653   }
2654 }
2655
2656
2657 install4j {
2658   if (file(install4jHomeDir).exists()) {
2659     // good to go!
2660   } else if (file(System.getProperty("user.home")+"/buildtools/install4j").exists()) {
2661     install4jHomeDir = System.getProperty("user.home")+"/buildtools/install4j"
2662   } else if (file("/Applications/install4j.app/Contents/Resources/app").exists()) {
2663     install4jHomeDir = "/Applications/install4j.app/Contents/Resources/app"
2664   }
2665   installDir(file(install4jHomeDir))
2666
2667   mediaTypes = Arrays.asList(install4j_media_types.split(","))
2668 }
2669
2670
2671 task copyInstall4jTemplate {
2672   def install4jTemplateFile = file("${install4jDir}/${install4j_template}")
2673   def install4jFileAssociationsFile = file("${install4jDir}/${install4j_installer_file_associations}")
2674   inputs.file(install4jTemplateFile)
2675   inputs.file(install4jFileAssociationsFile)
2676   inputs.property("CHANNEL", { CHANNEL })
2677   outputs.file(install4jConfFile)
2678
2679   doLast {
2680     def install4jConfigXml = new XmlParser().parse(install4jTemplateFile)
2681
2682     // turn off code signing if no OSX_KEYPASS
2683     if (OSX_KEYPASS == "") {
2684       install4jConfigXml.'**'.codeSigning.each { codeSigning ->
2685         codeSigning.'@macEnabled' = "false"
2686       }
2687       install4jConfigXml.'**'.windows.each { windows ->
2688         windows.'@runPostProcessor' = "false"
2689       }
2690     }
2691
2692     // disable install screen for OSX dmg (for 2.11.2.0)
2693     install4jConfigXml.'**'.macosArchive.each { macosArchive ->
2694       macosArchive.attributes().remove('executeSetupApp')
2695       macosArchive.attributes().remove('setupAppId')
2696     }
2697
2698     // turn off checksum creation for LOCAL channel
2699     def e = install4jConfigXml.application[0]
2700     e.'@createChecksums' = string(install4jCheckSums)
2701
2702     // put file association actions where placeholder action is
2703     def install4jFileAssociationsText = install4jFileAssociationsFile.text
2704     def fileAssociationActions = new XmlParser().parseText("<actions>${install4jFileAssociationsText}</actions>")
2705     install4jConfigXml.'**'.action.any { a -> // .any{} stops after the first one that returns true
2706       if (a.'@name' == 'EXTENSIONS_REPLACED_BY_GRADLE') {
2707         def parent = a.parent()
2708         parent.remove(a)
2709         fileAssociationActions.each { faa ->
2710             parent.append(faa)
2711         }
2712         // don't need to continue in .any loop once replacements have been made
2713         return true
2714       }
2715     }
2716
2717     // use Windows Program Group with Examples folder for RELEASE, and Program Group without Examples for everything else
2718     // NB we're deleting the /other/ one!
2719     // Also remove the examples subdir from non-release versions
2720     def customizedIdToDelete = "PROGRAM_GROUP_RELEASE"
2721     // 2.11.1.0 NOT releasing with the Examples folder in the Program Group
2722     if (false && CHANNEL=="RELEASE") { // remove 'false && ' to include Examples folder in RELEASE channel
2723       customizedIdToDelete = "PROGRAM_GROUP_NON_RELEASE"
2724     } else {
2725       // remove the examples subdir from Full File Set
2726       def files = install4jConfigXml.files[0]
2727       def fileset = files.filesets.fileset.find { fs -> fs.'@customizedId' == "FULL_FILE_SET" }
2728       def root = files.roots.root.find { r -> r.'@fileset' == fileset.'@id' }
2729       def mountPoint = files.mountPoints.mountPoint.find { mp -> mp.'@root' == root.'@id' }
2730       def dirEntry = files.entries.dirEntry.find { de -> de.'@mountPoint' == mountPoint.'@id' && de.'@subDirectory' == "examples" }
2731       dirEntry.parent().remove(dirEntry)
2732     }
2733     install4jConfigXml.'**'.action.any { a ->
2734       if (a.'@customizedId' == customizedIdToDelete) {
2735         def parent = a.parent()
2736         parent.remove(a)
2737         return true
2738       }
2739     }
2740
2741     // write install4j file
2742     install4jConfFile.text = XmlUtil.serialize(install4jConfigXml)
2743   }
2744 }
2745
2746
2747 clean {
2748   doFirst {
2749     delete install4jConfFile
2750   }
2751 }
2752
2753 task cleanInstallersDataFiles {
2754   def installersOutputTxt = file("${jalviewDir}/${install4jBuildDir}/output.txt")
2755   def installersSha256 = file("${jalviewDir}/${install4jBuildDir}/sha256sums")
2756   def hugoDataJsonFile = file("${jalviewDir}/${install4jBuildDir}/installers-${JALVIEW_VERSION_UNDERSCORES}.json")
2757   doFirst {
2758     delete installersOutputTxt
2759     delete installersSha256
2760     delete hugoDataJsonFile
2761   }
2762 }
2763
2764 task install4jDMGBackgroundImageCopy {
2765   inputs.file "${install4jDMGBackgroundImageDir}/${install4jDMGBackgroundImageFile}"
2766   outputs.dir "${install4jDMGBackgroundImageBuildDir}"
2767   doFirst {
2768     copy {
2769       from(install4jDMGBackgroundImageDir) {
2770         include(install4jDMGBackgroundImageFile)
2771       }
2772       into install4jDMGBackgroundImageBuildDir
2773     }
2774   }
2775 }
2776
2777 task install4jDMGBackgroundImageProcess {
2778   dependsOn install4jDMGBackgroundImageCopy
2779
2780   doFirst {
2781     if (backgroundImageText) {
2782       if (convertBinary == null) {
2783         throw new StopExecutionException("No ImageMagick convert binary installed at '${convertBinaryExpectedLocation}'")
2784       }
2785       if (!project.hasProperty("install4j_background_image_text_suffix_cmd")) {
2786         throw new StopExecutionException("No property 'install4j_background_image_text_suffix_cmd' defined. See channel_gradle.properties for channel ${CHANNEL}")
2787       }
2788       fileTree(dir: install4jDMGBackgroundImageBuildDir, include: "*.png").getFiles().each { file ->
2789         exec {
2790           executable convertBinary
2791           args = [
2792             file.getPath(),
2793             '-font', install4j_background_image_text_font,
2794             '-fill', install4j_background_image_text_colour,
2795             '-draw', sprintf(install4j_background_image_text_suffix_cmd, channelSuffix),
2796             '-draw', sprintf(install4j_background_image_text_commit_cmd, "git-commit: ${gitHash}"),
2797             '-draw', sprintf(install4j_background_image_text_date_cmd, getDate("yyyy-MM-dd HH:mm:ss")),
2798             file.getPath()
2799           ]
2800         }
2801       }
2802     }
2803   }
2804 }
2805
2806 task install4jDMGBackgroundImage {
2807   dependsOn install4jDMGBackgroundImageProcess
2808 }
2809
2810 task installerFiles(type: com.install4j.gradle.Install4jTask) {
2811   group = "distribution"
2812   description = "Create the install4j installers"
2813   dependsOn getdown
2814   dependsOn copyInstall4jTemplate
2815   dependsOn cleanInstallersDataFiles
2816   dependsOn install4jDMGBackgroundImage
2817
2818   projectFile = install4jConfFile
2819
2820   // create an md5 for the input files to use as version for install4j conf file
2821   def digest = MessageDigest.getInstance("MD5")
2822   digest.update(
2823     (file("${install4jDir}/${install4j_template}").text +
2824     file("${install4jDir}/${install4j_info_plist_file_associations}").text +
2825     file("${install4jDir}/${install4j_installer_file_associations}").text).bytes)
2826   def filesMd5 = new BigInteger(1, digest.digest()).toString(16)
2827   if (filesMd5.length() >= 8) {
2828     filesMd5 = filesMd5.substring(0,8)
2829   }
2830   def install4jTemplateVersion = "${JALVIEW_VERSION}_F${filesMd5}_C${gitHash}"
2831
2832   variables = [
2833     'JALVIEW_NAME': jalview_name,
2834     'JALVIEW_APPLICATION_NAME': applicationName,
2835     'JALVIEW_DIR': "../..",
2836     'OSX_KEYSTORE': OSX_KEYSTORE,
2837     'OSX_APPLEID': OSX_APPLEID,
2838     'OSX_ALTOOLPASS': OSX_ALTOOLPASS,
2839     'JSIGN_SH': JSIGN_SH,
2840     'JRE_DIR': getdown_app_dir_java,
2841     'INSTALLER_TEMPLATE_VERSION': install4jTemplateVersion,
2842     'JALVIEW_VERSION': JALVIEW_VERSION,
2843     'JAVA_MIN_VERSION': JAVA_MIN_VERSION,
2844     'JAVA_MAX_VERSION': JAVA_MAX_VERSION,
2845     'JAVA_VERSION': JAVA_VERSION,
2846     'JAVA_INTEGER_VERSION': JAVA_INTEGER_VERSION,
2847     'VERSION': JALVIEW_VERSION,
2848     'COPYRIGHT_MESSAGE': install4j_copyright_message,
2849     'BUNDLE_ID': install4jBundleId,
2850     'INTERNAL_ID': install4jInternalId,
2851     'WINDOWS_APPLICATION_ID': install4jWinApplicationId,
2852     'MACOS_DMG_DS_STORE': install4jDMGDSStore,
2853     'MACOS_DMG_BG_IMAGE': "${install4jDMGBackgroundImageBuildDir}/${install4jDMGBackgroundImageFile}",
2854     'WRAPPER_LINK': getdownWrapperLink,
2855     'BASH_WRAPPER_SCRIPT': getdown_bash_wrapper_script,
2856     'POWERSHELL_WRAPPER_SCRIPT': getdown_powershell_wrapper_script,
2857     'BATCH_WRAPPER_SCRIPT': getdown_batch_wrapper_script,
2858     'WRAPPER_SCRIPT_BIN_DIR': getdown_wrapper_script_dir,
2859     'INSTALLER_NAME': install4jInstallerName,
2860     'INSTALL4J_UTILS_DIR': install4j_utils_dir,
2861     'GETDOWN_CHANNEL_DIR': getdownChannelDir,
2862     'GETDOWN_FILES_DIR': getdown_files_dir,
2863     'GETDOWN_RESOURCE_DIR': getdown_resource_dir,
2864     'GETDOWN_DIST_DIR': getdownAppDistDir,
2865     'GETDOWN_ALT_DIR': getdown_app_dir_alt,
2866     'GETDOWN_INSTALL_DIR': getdown_install_dir,
2867     'INFO_PLIST_FILE_ASSOCIATIONS_FILE': install4j_info_plist_file_associations,
2868     'BUILD_DIR': install4jBuildDir,
2869     'APPLICATION_CATEGORIES': install4j_application_categories,
2870     'APPLICATION_FOLDER': install4jApplicationFolder,
2871     'UNIX_APPLICATION_FOLDER': install4jUnixApplicationFolder,
2872     'EXECUTABLE_NAME': install4jExecutableName,
2873     'EXTRA_SCHEME': install4jExtraScheme,
2874     'MAC_ICONS_FILE': install4jMacIconsFile,
2875     'WINDOWS_ICONS_FILE': install4jWindowsIconsFile,
2876     'PNG_ICON_FILE': install4jPngIconFile,
2877     'BACKGROUND': install4jBackground,
2878   ]
2879
2880   def varNameMap = [
2881     'mac': 'MACOS',
2882     'windows': 'WINDOWS',
2883     'linux': 'LINUX'
2884   ]
2885
2886   // these are the bundled OS/architecture VMs needed by install4j
2887   def osArch = [
2888     [ "mac", "x64" ],
2889     [ "mac", "aarch64" ],
2890     [ "windows", "x64" ],
2891     [ "linux", "x64" ],
2892     [ "linux", "aarch64" ]
2893   ]
2894   osArch.forEach { os, arch ->
2895     variables[ sprintf("%s_%s_JAVA_VM_DIR", varNameMap[os], arch.toUpperCase(Locale.ROOT)) ] = sprintf("%s/jre-%s-%s-%s/jre", jreInstallsDir, JAVA_INTEGER_VERSION, os, arch)
2896     // N.B. For some reason install4j requires the below filename to have underscores and not hyphens
2897     // otherwise running `gradle installers` generates a non-useful error:
2898     // `install4j: compilation failed. Reason: java.lang.NumberFormatException: For input string: "windows"`
2899     variables[ sprintf("%s_%s_JAVA_VM_TGZ", varNameMap[os], arch.toUpperCase(Locale.ROOT)) ] = sprintf("%s/tgz/jre_%s_%s_%s.tar.gz", jreInstallsDir, JAVA_INTEGER_VERSION, os, arch)
2900   }
2901
2902   //println("INSTALL4J VARIABLES:")
2903   //variables.each{k,v->println("${k}=${v}")}
2904
2905   destination = "${jalviewDir}/${install4jBuildDir}"
2906   buildSelected = true
2907
2908   if (install4j_faster.equals("true") || CHANNEL.startsWith("LOCAL")) {
2909     faster = true
2910     disableSigning = true
2911     disableNotarization = true
2912   }
2913
2914   if (OSX_KEYPASS) {
2915     macKeystorePassword = OSX_KEYPASS
2916   }
2917
2918   if (OSX_ALTOOLPASS) {
2919     appleIdPassword = OSX_ALTOOLPASS
2920     disableNotarization = false
2921   } else {
2922     disableNotarization = true
2923   }
2924
2925   doFirst {
2926     println("Using projectFile "+projectFile)
2927     if (!disableNotarization) { println("Will notarize OSX App DMG") }
2928   }
2929   //verbose=true
2930
2931   inputs.dir(getdownAppBaseDir)
2932   inputs.file(install4jConfFile)
2933   inputs.file("${install4jDir}/${install4j_info_plist_file_associations}")
2934   outputs.dir("${jalviewDir}/${install4j_build_dir}/${JAVA_VERSION}")
2935 }
2936
2937 def getDataHash(File myFile) {
2938   HashCode hash = Files.asByteSource(myFile).hash(Hashing.sha256())
2939   return myFile.exists()
2940   ? [
2941       "file" : myFile.getName(),
2942       "filesize" : myFile.length(),
2943       "sha256" : hash.toString()
2944     ]
2945   : null
2946 }
2947
2948 def writeDataJsonFile(File installersOutputTxt, File installersSha256, File dataJsonFile) {
2949   def hash = [
2950     "channel" : getdownChannelName,
2951     "date" : getDate("yyyy-MM-dd HH:mm:ss"),
2952     "git-commit" : "${gitHash} [${gitBranch}]",
2953     "version" : JALVIEW_VERSION
2954   ]
2955   // install4j installer files
2956   if (installersOutputTxt.exists()) {
2957     def idHash = [:]
2958     installersOutputTxt.readLines().each { def line ->
2959       if (line.startsWith("#")) {
2960         return;
2961       }
2962       line.replaceAll("\n","")
2963       def vals = line.split("\t")
2964       def filename = vals[3]
2965       def filesize = file(filename).length()
2966       filename = filename.replaceAll(/^.*\//, "")
2967       hash[vals[0]] = [ "id" : vals[0], "os" : vals[1], "name" : vals[2], "file" : filename, "filesize" : filesize ]
2968       idHash."${filename}" = vals[0]
2969     }
2970     if (install4jCheckSums && installersSha256.exists()) {
2971       installersSha256.readLines().each { def line ->
2972         if (line.startsWith("#")) {
2973           return;
2974         }
2975         line.replaceAll("\n","")
2976         def vals = line.split(/\s+\*?/)
2977         def filename = vals[1]
2978         def innerHash = (hash.(idHash."${filename}"))."sha256" = vals[0]
2979       }
2980     }
2981   }
2982
2983   [
2984     "JAR": shadowJar.archiveFile, // executable JAR
2985     "JVL": getdownVersionLaunchJvl, // version JVL
2986     "SOURCE": sourceDist.archiveFile // source TGZ
2987   ].each { key, value ->
2988     def file = file(value)
2989     if (file.exists()) {
2990       def fileHash = getDataHash(file)
2991       if (fileHash != null) {
2992         hash."${key}" = fileHash;
2993       }
2994     }
2995   }
2996   return dataJsonFile.write(new JsonBuilder(hash).toPrettyString())
2997 }
2998
2999 task staticMakeInstallersJsonFile {
3000   doFirst {
3001     def output = findProperty("i4j_output")
3002     def sha256 = findProperty("i4j_sha256")
3003     def json = findProperty("i4j_json")
3004     if (output == null || sha256 == null || json == null) {
3005       throw new GradleException("Must provide paths to all of output.txt, sha256sums, and output.json with '-Pi4j_output=... -Pi4j_sha256=... -Pi4j_json=...")
3006     }
3007     writeDataJsonFile(file(output), file(sha256), file(json))
3008   }
3009 }
3010
3011 task installers {
3012   dependsOn installerFiles
3013 }
3014
3015
3016 spotless {
3017   java {
3018     eclipse().configFile(eclipse_codestyle_file)
3019   }
3020 }
3021
3022 task createSourceReleaseProperties(type: WriteProperties) {
3023   group = "distribution"
3024   description = "Create the source RELEASE properties file"
3025
3026   def sourceTarBuildDir = "${buildDir}/sourceTar"
3027   def sourceReleasePropertiesFile = "${sourceTarBuildDir}/RELEASE"
3028   outputFile (sourceReleasePropertiesFile)
3029
3030   doFirst {
3031     releaseProps.each{ key, val -> property key, val }
3032     property "git.branch", gitBranch
3033     property "git.hash", gitHash
3034   }
3035
3036   outputs.file(outputFile)
3037 }
3038
3039 task sourceDist(type: Tar) {
3040   group "distribution"
3041   description "Create a source .tar.gz file for distribution"
3042
3043   dependsOn createBuildProperties
3044   dependsOn convertMdFiles
3045   dependsOn eclipseAllPreferences
3046   dependsOn createSourceReleaseProperties
3047
3048
3049   def outputFileName = "${project.name}_${JALVIEW_VERSION_UNDERSCORES}.tar.gz"
3050   archiveFileName = outputFileName
3051
3052   compression Compression.GZIP
3053
3054   into project.name
3055
3056   def EXCLUDE_FILES=[
3057     "dist/*",
3058     "build/*",
3059     "bin/*",
3060     "test-output/",
3061     "test-reports",
3062     "tests",
3063     "clover*/*",
3064     ".*",
3065     "benchmarking/*",
3066     "**/.*",
3067     "*.class",
3068     "**/*.class","$j11modDir/**/*.jar","appletlib","**/*locales",
3069     "*locales/**",
3070     "utils/InstallAnywhere",
3071     "**/*.log",
3072     "RELEASE",
3073   ]
3074   def PROCESS_FILES=[
3075     "AUTHORS",
3076     "CITATION",
3077     "FEATURETODO",
3078     "JAVA-11-README",
3079     "FEATURETODO",
3080     "LICENSE",
3081     "**/README",
3082     "THIRDPARTYLIBS",
3083     "TESTNG",
3084     "build.gradle",
3085     "gradle.properties",
3086     "**/*.java",
3087     "**/*.html",
3088     "**/*.xml",
3089     "**/*.gradle",
3090     "**/*.groovy",
3091     "**/*.properties",
3092     "**/*.perl",
3093     "**/*.sh",
3094   ]
3095   def INCLUDE_FILES=[
3096     ".classpath",
3097     ".settings/org.eclipse.buildship.core.prefs",
3098     ".settings/org.eclipse.jdt.core.prefs"
3099   ]
3100
3101   from(jalviewDir) {
3102     exclude (EXCLUDE_FILES)
3103     include (PROCESS_FILES)
3104     filter(ReplaceTokens,
3105       beginToken: '$$',
3106       endToken: '$$',
3107       tokens: [
3108         'Version-Rel': JALVIEW_VERSION,
3109         'Year-Rel': getDate("yyyy")
3110       ]
3111     )
3112   }
3113   from(jalviewDir) {
3114     exclude (EXCLUDE_FILES)
3115     exclude (PROCESS_FILES)
3116     exclude ("appletlib")
3117     exclude ("**/*locales")
3118     exclude ("*locales/**")
3119     exclude ("utils/InstallAnywhere")
3120
3121     exclude (getdown_files_dir)
3122     // getdown_website_dir and getdown_archive_dir moved to build/website/docroot/getdown
3123     //exclude (getdown_website_dir)
3124     //exclude (getdown_archive_dir)
3125
3126     // exluding these as not using jars as modules yet
3127     exclude ("${j11modDir}/**/*.jar")
3128   }
3129   from(jalviewDir) {
3130     include(INCLUDE_FILES)
3131   }
3132 //  from (jalviewDir) {
3133 //    // explicit includes for stuff that seemed to not get included
3134 //    include(fileTree("test/**/*."))
3135 //    exclude(EXCLUDE_FILES)
3136 //    exclude(PROCESS_FILES)
3137 //  }
3138
3139   from(file(buildProperties).getParent()) {
3140     include(file(buildProperties).getName())
3141     rename(file(buildProperties).getName(), "build_properties")
3142     filter({ line ->
3143       line.replaceAll("^INSTALLATION=.*\$","INSTALLATION=Source Release"+" git-commit\\\\:"+gitHash+" ["+gitBranch+"]")
3144     })
3145   }
3146
3147   def sourceTarBuildDir = "${buildDir}/sourceTar"
3148   from(sourceTarBuildDir) {
3149     // this includes the appended RELEASE properties file
3150   }
3151 }
3152
3153 task dataInstallersJson {
3154   group "website"
3155   description "Create the installers-VERSION.json data file for installer files created"
3156
3157   mustRunAfter installers
3158   mustRunAfter shadowJar
3159   mustRunAfter sourceDist
3160   mustRunAfter getdownArchive
3161
3162   def installersOutputTxt = file("${jalviewDir}/${install4jBuildDir}/output.txt")
3163   def installersSha256 = file("${jalviewDir}/${install4jBuildDir}/sha256sums")
3164
3165   if (installersOutputTxt.exists()) {
3166     inputs.file(installersOutputTxt)
3167   }
3168   if (install4jCheckSums && installersSha256.exists()) {
3169     inputs.file(installersSha256)
3170   }
3171   [
3172     shadowJar.archiveFile, // executable JAR
3173     getdownVersionLaunchJvl, // version JVL
3174     sourceDist.archiveFile // source TGZ
3175   ].each { fileName ->
3176     if (file(fileName).exists()) {
3177       inputs.file(fileName)
3178     }
3179   }
3180
3181   outputs.file(hugoDataJsonFile)
3182
3183   doFirst {
3184     writeDataJsonFile(installersOutputTxt, installersSha256, hugoDataJsonFile)
3185   }
3186 }
3187
3188 task helppages {
3189   group "help"
3190   description "Copies all help pages to build dir. Runs ant task 'pubhtmlhelp'."
3191
3192   dependsOn copyHelp
3193   dependsOn pubhtmlhelp
3194
3195   inputs.dir("${helpBuildDir}/${help_dir}")
3196   outputs.dir("${buildDir}/distributions/${help_dir}")
3197 }
3198
3199
3200 task j2sSetHeadlessBuild {
3201   doFirst {
3202     IN_ECLIPSE = false
3203   }
3204 }
3205
3206
3207 task jalviewjsEnableAltFileProperty(type: WriteProperties) {
3208   group "jalviewjs"
3209   description "Enable the alternative J2S Config file for headless build"
3210
3211   outputFile = jalviewjsJ2sSettingsFileName
3212   def j2sPropsFile = file(jalviewjsJ2sSettingsFileName)
3213   def j2sProps = new Properties()
3214   if (j2sPropsFile.exists()) {
3215     try {
3216       def j2sPropsFileFIS = new FileInputStream(j2sPropsFile)
3217       j2sProps.load(j2sPropsFileFIS)
3218       j2sPropsFileFIS.close()
3219
3220       j2sProps.each { prop, val ->
3221         property(prop, val)
3222       }
3223     } catch (Exception e) {
3224       println("Exception reading ${jalviewjsJ2sSettingsFileName}")
3225       e.printStackTrace()
3226     }
3227   }
3228   if (! j2sProps.stringPropertyNames().contains(jalviewjs_j2s_alt_file_property_config)) {
3229     property(jalviewjs_j2s_alt_file_property_config, jalviewjs_j2s_alt_file_property)
3230   }
3231 }
3232
3233
3234 task jalviewjsSetEclipseWorkspace {
3235   def propKey = "jalviewjs_eclipse_workspace"
3236   def propVal = null
3237   if (project.hasProperty(propKey)) {
3238     propVal = project.getProperty(propKey)
3239     if (propVal.startsWith("~/")) {
3240       propVal = System.getProperty("user.home") + propVal.substring(1)
3241     }
3242   }
3243   def propsFileName = "${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_eclipse_workspace_location_file}"
3244   def propsFile = file(propsFileName)
3245   def eclipseWsDir = propVal
3246   def props = new Properties()
3247
3248   def writeProps = true
3249   if (( eclipseWsDir == null || !file(eclipseWsDir).exists() ) && propsFile.exists()) {
3250     def ins = new FileInputStream(propsFileName)
3251     props.load(ins)
3252     ins.close()
3253     if (props.getProperty(propKey, null) != null) {
3254       eclipseWsDir = props.getProperty(propKey)
3255       writeProps = false
3256     }
3257   }
3258
3259   if (eclipseWsDir == null || !file(eclipseWsDir).exists()) {
3260     def tempDir = File.createTempDir()
3261     eclipseWsDir = tempDir.getAbsolutePath()
3262     writeProps = true
3263   }
3264   eclipseWorkspace = file(eclipseWsDir)
3265
3266   doFirst {
3267     // do not run a headless transpile when we claim to be in Eclipse
3268     if (IN_ECLIPSE) {
3269       println("Skipping task ${name} as IN_ECLIPSE=${IN_ECLIPSE}")
3270       throw new StopExecutionException("Not running headless transpile whilst IN_ECLIPSE is '${IN_ECLIPSE}'")
3271     } else {
3272       println("Running task ${name} as IN_ECLIPSE=${IN_ECLIPSE}")
3273     }
3274
3275     if (writeProps) {
3276       props.setProperty(propKey, eclipseWsDir)
3277       propsFile.parentFile.mkdirs()
3278       def bytes = new ByteArrayOutputStream()
3279       props.store(bytes, null)
3280       def propertiesString = bytes.toString()
3281       propsFile.text = propertiesString
3282       print("NEW ")
3283     } else {
3284       print("EXISTING ")
3285     }
3286
3287     println("ECLIPSE WORKSPACE: "+eclipseWorkspace.getPath())
3288   }
3289
3290   //inputs.property(propKey, eclipseWsDir) // eclipseWsDir only gets set once this task runs, so will be out-of-date
3291   outputs.file(propsFileName)
3292   outputs.upToDateWhen { eclipseWorkspace.exists() && propsFile.exists() }
3293 }
3294
3295
3296 task jalviewjsEclipsePaths {
3297   def eclipseProduct
3298
3299   def eclipseRoot = jalviewjs_eclipse_root
3300   if (eclipseRoot.startsWith("~/")) {
3301     eclipseRoot = System.getProperty("user.home") + eclipseRoot.substring(1)
3302   }
3303   if (OperatingSystem.current().isMacOsX()) {
3304     eclipseRoot += "/Eclipse.app"
3305     eclipseBinary = "${eclipseRoot}/Contents/MacOS/eclipse"
3306     eclipseProduct = "${eclipseRoot}/Contents/Eclipse/.eclipseproduct"
3307   } else if (OperatingSystem.current().isWindows()) { // check these paths!!
3308     if (file("${eclipseRoot}/eclipse").isDirectory() && file("${eclipseRoot}/eclipse/.eclipseproduct").exists()) {
3309       eclipseRoot += "/eclipse"
3310     }
3311     eclipseBinary = "${eclipseRoot}/eclipse.exe"
3312     eclipseProduct = "${eclipseRoot}/.eclipseproduct"
3313   } else { // linux or unix
3314     if (file("${eclipseRoot}/eclipse").isDirectory() && file("${eclipseRoot}/eclipse/.eclipseproduct").exists()) {
3315       eclipseRoot += "/eclipse"
3316 println("eclipseDir exists")
3317     }
3318     eclipseBinary = "${eclipseRoot}/eclipse"
3319     eclipseProduct = "${eclipseRoot}/.eclipseproduct"
3320   }
3321
3322   eclipseVersion = "4.13" // default
3323   def assumedVersion = true
3324   if (file(eclipseProduct).exists()) {
3325     def fis = new FileInputStream(eclipseProduct)
3326     def props = new Properties()
3327     props.load(fis)
3328     eclipseVersion = props.getProperty("version")
3329     fis.close()
3330     assumedVersion = false
3331   }
3332
3333   def propKey = "eclipse_debug"
3334   eclipseDebug = (project.hasProperty(propKey) && project.getProperty(propKey).equals("true"))
3335
3336   doFirst {
3337     // do not run a headless transpile when we claim to be in Eclipse
3338     if (IN_ECLIPSE) {
3339       println("Skipping task ${name} as IN_ECLIPSE=${IN_ECLIPSE}")
3340       throw new StopExecutionException("Not running headless transpile whilst IN_ECLIPSE is '${IN_ECLIPSE}'")
3341     } else {
3342       println("Running task ${name} as IN_ECLIPSE=${IN_ECLIPSE}")
3343     }
3344
3345     if (!assumedVersion) {
3346       println("ECLIPSE VERSION=${eclipseVersion}")
3347     }
3348   }
3349 }
3350
3351
3352 task printProperties {
3353   group "Debug"
3354   description "Output to console all System.properties"
3355   doFirst {
3356     System.properties.each { key, val -> System.out.println("Property: ${key}=${val}") }
3357   }
3358 }
3359
3360
3361 task eclipseSetup {
3362   dependsOn eclipseProject
3363   dependsOn eclipseClasspath
3364   dependsOn eclipseJdt
3365 }
3366
3367
3368 // this version (type: Copy) will delete anything in the eclipse dropins folder that isn't in fromDropinsDir
3369 task jalviewjsEclipseCopyDropins(type: Copy) {
3370   dependsOn jalviewjsEclipsePaths
3371
3372   def inputFiles = fileTree(dir: "${jalviewDir}/${jalviewjs_eclipse_dropins_dir}", include: "*.jar")
3373   inputFiles += file("${jalviewDir}/${jalviewjsJ2sPlugin}")
3374   def outputDir = "${jalviewDir}/${jalviewjsBuildDir}/${jalviewjs_eclipse_tmp_dropins_dir}"
3375
3376   from inputFiles
3377   into outputDir
3378 }
3379
3380
3381 // this eclipse -clean doesn't actually work
3382 task jalviewjsCleanEclipse(type: Exec) {
3383   dependsOn eclipseSetup
3384   dependsOn jalviewjsEclipsePaths
3385   dependsOn jalviewjsEclipseCopyDropins
3386
3387   executable(eclipseBinary)
3388   args(["-nosplash", "--launcher.suppressErrors", "-data", eclipseWorkspace.getPath(), "-clean", "-console", "-consoleLog"])
3389   if (eclipseDebug) {
3390     args += "-debug"
3391   }
3392   args += "-l"
3393
3394   def inputString = """exit
3395 y
3396 """
3397   def inputByteStream = new ByteArrayInputStream(inputString.getBytes())
3398   standardInput = inputByteStream
3399 }
3400
3401 /* not really working yet
3402 jalviewjsEclipseCopyDropins.finalizedBy jalviewjsCleanEclipse
3403 */
3404
3405
3406 task jalviewjsTransferUnzipSwingJs {
3407   def file_zip = "${jalviewDir}/${jalviewjs_swingjs_zip}"
3408
3409   doLast {
3410     copy {
3411       from zipTree(file_zip)
3412       into "${jalviewDir}/${jalviewjsTransferSiteSwingJsDir}"
3413     }
3414   }
3415
3416   inputs.file file_zip
3417   outputs.dir "${jalviewDir}/${jalviewjsTransferSiteSwingJsDir}"
3418 }
3419
3420
3421 task jalviewjsTransferUnzipLib {
3422   def zipFiles = fileTree(dir: "${jalviewDir}/${jalviewjs_libjs_dir}", include: "*.zip").sort()
3423
3424   doLast {
3425     zipFiles.each { file_zip ->
3426       copy {
3427         from zipTree(file_zip)
3428         into "${jalviewDir}/${jalviewjsTransferSiteLibDir}"
3429
3430         // The following replace() is needed due to a mismatch in Jmol calls to
3431         // colorPtToFFRGB$javajs_util_T3d when only colorPtToFFRGB$javajs_util_T3 is defined
3432         // in the SwingJS.zip (github or the one distributed with JSmol)
3433         if (file_zip.getName().startsWith("Jmol-SwingJS")) {
3434           filter { line ->
3435             def l = ""
3436             while(!line.equals(l)) {
3437               line = line.replace('colorPtToFFRGB$javajs_util_T3d', 'colorPtToFFRGB$javajs_util_T3')
3438               l = line
3439             }
3440             return line
3441           }
3442         }
3443       }
3444     }
3445   }
3446
3447   inputs.files zipFiles
3448   outputs.dir "${jalviewDir}/${jalviewjsTransferSiteLibDir}"
3449 }
3450
3451
3452 task jalviewjsTransferUnzipAllLibs {
3453   dependsOn jalviewjsTransferUnzipLib
3454   dependsOn jalviewjsTransferUnzipSwingJs
3455 }
3456
3457
3458 task jalviewjsCreateJ2sSettings(type: WriteProperties) {
3459   group "JalviewJS"
3460   description "Create the alternative j2s file from the j2s.* properties"
3461
3462   jalviewjsJ2sProps = project.properties.findAll { it.key.startsWith("j2s.") }.sort { it.key }
3463   def siteDirProperty = "j2s.site.directory"
3464   def setSiteDir = false
3465   jalviewjsJ2sProps.each { prop, val ->
3466     if (val != null) {
3467       if (prop == siteDirProperty) {
3468         if (!(val.startsWith('/') || val.startsWith("file://") )) {
3469           val = "${jalviewDir}/${jalviewjsTransferSiteJsDir}/${val}"
3470         }
3471         setSiteDir = true
3472       }
3473       property(prop,val)
3474     }
3475     if (!setSiteDir) { // default site location, don't override specifically set property
3476       property(siteDirProperty,"${jalviewDirRelativePath}/${jalviewjsTransferSiteJsDir}")
3477     }
3478   }
3479   outputFile = jalviewjsJ2sAltSettingsFileName
3480
3481   if (! IN_ECLIPSE) {
3482     inputs.properties(jalviewjsJ2sProps)
3483     outputs.file(jalviewjsJ2sAltSettingsFileName)
3484   }
3485 }
3486
3487
3488 task jalviewjsEclipseSetup {
3489   dependsOn jalviewjsEclipseCopyDropins
3490   dependsOn jalviewjsSetEclipseWorkspace
3491   dependsOn jalviewjsCreateJ2sSettings
3492 }
3493
3494
3495 task jalviewjsSyncAllLibs (type: Sync) {
3496   dependsOn jalviewjsTransferUnzipAllLibs
3497   def inputFiles = []
3498   inputFiles += fileTree(dir: "${jalviewDir}/${jalviewjsTransferSiteLibDir}")
3499   inputFiles += fileTree(dir: "${jalviewDir}/${jalviewjsTransferSiteSwingJsDir}")
3500   def outputDir = "${jalviewDir}/${jalviewjsSiteDir}"
3501
3502   from inputFiles
3503   into outputDir
3504   def outputFiles = []
3505   rename { filename ->
3506     outputFiles += "${outputDir}/${filename}"
3507     null
3508   }
3509   preserve {
3510     include "**"
3511   }
3512
3513   // should this be exclude really ? No, swingjs dir should be transferred last (and overwrite)
3514   duplicatesStrategy "INCLUDE"
3515
3516   outputs.files outputFiles
3517   inputs.files inputFiles
3518 }
3519
3520
3521 task jalviewjsSyncResources (type: Sync) {
3522   dependsOn buildResources
3523
3524   def inputFiles = fileTree(dir: resourcesBuildDir)
3525   def outputDir = "${jalviewDir}/${jalviewjsSiteDir}/${jalviewjs_j2s_subdir}"
3526
3527   from inputFiles
3528   into outputDir
3529   def outputFiles = []
3530   rename { filename ->
3531     outputFiles += "${outputDir}/${filename}"
3532     null
3533   }
3534   preserve {
3535     include "**"
3536   }
3537   outputs.files outputFiles
3538   inputs.files inputFiles
3539 }
3540
3541
3542 task jalviewjsSyncSiteResources (type: Sync) {
3543   def inputFiles = fileTree(dir: "${jalviewDir}/${jalviewjs_site_resource_dir}")
3544   def outputDir = "${jalviewDir}/${jalviewjsSiteDir}"
3545
3546   from inputFiles
3547   into outputDir
3548   def outputFiles = []
3549   rename { filename ->
3550     outputFiles += "${outputDir}/${filename}"
3551     null
3552   }
3553   preserve {
3554     include "**"
3555   }
3556   outputs.files outputFiles
3557   inputs.files inputFiles
3558 }
3559
3560
3561 task jalviewjsSyncBuildProperties (type: Sync) {
3562   dependsOn createBuildProperties
3563   def inputFiles = [file(buildProperties)]
3564   def outputDir = "${jalviewDir}/${jalviewjsSiteDir}/${jalviewjs_j2s_subdir}"
3565
3566   from inputFiles
3567   into outputDir
3568   def outputFiles = []
3569   rename { filename ->
3570     outputFiles += "${outputDir}/${filename}"
3571     null
3572   }
3573   preserve {
3574     include "**"
3575   }
3576   outputs.files outputFiles
3577   inputs.files inputFiles
3578 }
3579
3580
3581 task jalviewjsProjectImport(type: Exec) {
3582   dependsOn eclipseSetup
3583   dependsOn jalviewjsEclipsePaths
3584   dependsOn jalviewjsEclipseSetup
3585
3586   doFirst {
3587     // do not run a headless import when we claim to be in Eclipse
3588     if (IN_ECLIPSE) {
3589       println("Skipping task ${name} as IN_ECLIPSE=${IN_ECLIPSE}")
3590       throw new StopExecutionException("Not running headless import whilst IN_ECLIPSE is '${IN_ECLIPSE}'")
3591     } else {
3592       println("Running task ${name} as IN_ECLIPSE=${IN_ECLIPSE}")
3593     }
3594   }
3595
3596   //def projdir = eclipseWorkspace.getPath()+"/.metadata/.plugins/org.eclipse.core.resources/.projects/jalview/org.eclipse.jdt.core"
3597   def projdir = eclipseWorkspace.getPath()+"/.metadata/.plugins/org.eclipse.core.resources/.projects/jalview"
3598   executable(eclipseBinary)
3599   args(["-nosplash", "--launcher.suppressErrors", "-application", "com.seeq.eclipse.importprojects.headlessimport", "-data", eclipseWorkspace.getPath(), "-import", jalviewDirAbsolutePath])
3600   if (eclipseDebug) {
3601     args += "-debug"
3602   }
3603   args += [ "--launcher.appendVmargs", "-vmargs", "-Dorg.eclipse.equinox.p2.reconciler.dropins.directory=${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_eclipse_tmp_dropins_dir}" ]
3604   if (!IN_ECLIPSE) {
3605     args += [ "-D${j2sHeadlessBuildProperty}=true" ]
3606     args += [ "-D${jalviewjs_j2s_alt_file_property}=${jalviewjsJ2sAltSettingsFileName}" ]
3607   }
3608
3609   inputs.file("${jalviewDir}/.project")
3610   outputs.upToDateWhen {
3611     file(projdir).exists()
3612   }
3613 }
3614
3615
3616 task jalviewjsTranspile(type: Exec) {
3617   dependsOn jalviewjsEclipseSetup
3618   dependsOn jalviewjsProjectImport
3619   dependsOn jalviewjsEclipsePaths
3620   if (!IN_ECLIPSE) {
3621     dependsOn jalviewjsEnableAltFileProperty
3622   }
3623
3624   doFirst {
3625     // do not run a headless transpile when we claim to be in Eclipse
3626     if (IN_ECLIPSE) {
3627       println("Skipping task ${name} as IN_ECLIPSE=${IN_ECLIPSE}")
3628       throw new StopExecutionException("Not running headless transpile whilst IN_ECLIPSE is '${IN_ECLIPSE}'")
3629     } else {
3630       println("Running task ${name} as IN_ECLIPSE=${IN_ECLIPSE}")
3631     }
3632   }
3633
3634   executable(eclipseBinary)
3635   args(["-nosplash", "--launcher.suppressErrors", "-application", "org.eclipse.jdt.apt.core.aptBuild", "-data", eclipseWorkspace, "-${jalviewjs_eclipse_build_arg}", eclipse_project_name ])
3636   if (eclipseDebug) {
3637     args += "-debug"
3638   }
3639   args += [ "--launcher.appendVmargs", "-vmargs", "-Dorg.eclipse.equinox.p2.reconciler.dropins.directory=${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_eclipse_tmp_dropins_dir}" ]
3640   if (!IN_ECLIPSE) {
3641     args += [ "-D${j2sHeadlessBuildProperty}=true" ]
3642     args += [ "-D${jalviewjs_j2s_alt_file_property}=${jalviewjsJ2sAltSettingsFileName}" ]
3643   }
3644
3645   def stdout
3646   def stderr
3647   doFirst {
3648     stdout = new ByteArrayOutputStream()
3649     stderr = new ByteArrayOutputStream()
3650
3651     def logOutFileName = "${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_j2s_transpile_stdout}"
3652     def logOutFile = file(logOutFileName)
3653     logOutFile.createNewFile()
3654     logOutFile.text = """ROOT: ${jalviewjs_eclipse_root}
3655 BINARY: ${eclipseBinary}
3656 VERSION: ${eclipseVersion}
3657 WORKSPACE: ${eclipseWorkspace}
3658 DEBUG: ${eclipseDebug}
3659 ----
3660 """
3661     def logOutFOS = new FileOutputStream(logOutFile, true) // true == append
3662     // combine stdout and stderr
3663     def logErrFOS = logOutFOS
3664
3665     if (jalviewjs_j2s_to_console.equals("true")) {
3666       standardOutput = new org.apache.tools.ant.util.TeeOutputStream(
3667         new org.apache.tools.ant.util.TeeOutputStream(
3668           logOutFOS,
3669           stdout),
3670         System.out)
3671       errorOutput = new org.apache.tools.ant.util.TeeOutputStream(
3672         new org.apache.tools.ant.util.TeeOutputStream(
3673           logErrFOS,
3674           stderr),
3675         System.err)
3676     } else {
3677       standardOutput = new org.apache.tools.ant.util.TeeOutputStream(
3678         logOutFOS,
3679         stdout)
3680       errorOutput = new org.apache.tools.ant.util.TeeOutputStream(
3681         logErrFOS,
3682         stderr)
3683     }
3684   }
3685
3686   doLast {
3687     if (stdout.toString().contains("Error processing ")) {
3688       // j2s did not complete transpile
3689       //throw new TaskExecutionException("Error during transpilation:\n${stderr}\nSee eclipse transpile log file '${jalviewDir}/${jalviewjsBuildDir}/${jalviewjs_j2s_transpile_stdout}'")
3690       if (jalviewjs_ignore_transpile_errors.equals("true")) {
3691         println("IGNORING TRANSPILE ERRORS")
3692         println("See eclipse transpile log file '${jalviewDir}/${jalviewjsBuildDir}/${jalviewjs_j2s_transpile_stdout}'")
3693       } else {
3694         throw new GradleException("Error during transpilation:\n${stderr}\nSee eclipse transpile log file '${jalviewDir}/${jalviewjsBuildDir}/${jalviewjs_j2s_transpile_stdout}'")
3695       }
3696     }
3697   }
3698
3699   inputs.dir("${jalviewDir}/${sourceDir}")
3700   outputs.dir("${jalviewDir}/${jalviewjsTransferSiteJsDir}")
3701   outputs.upToDateWhen( { file("${jalviewDir}/${jalviewjsTransferSiteJsDir}${jalviewjs_server_resource}").exists() } )
3702 }
3703
3704
3705 task jalviewjsTranserSiteMergeLibDirs (type: Sync) {
3706   dependsOn jalviewjsTransferUnzipAllLibs
3707   dependsOn jalviewjsTransferUnzipSwingJs
3708   dependsOn jalviewjsTranspile
3709
3710   def inputFiles = fileTree(dir: "${jalviewDir}/${jalviewjsTransferSiteLibDir}")
3711   // merge swingjs lib last
3712   inputFiles += fileTree(dir: "${jalviewDir}/${jalviewjsTransferSiteSwingJsDir}")
3713
3714   def outputDir = "${jalviewDir}/${jalviewjsTransferSiteMergeDir}"
3715
3716   from inputFiles
3717   into outputDir
3718   def outputFiles = []
3719   rename { filename ->
3720     outputFiles += "${outputDir}/${filename}"
3721     null
3722   }
3723
3724   exclude "**/*.html"
3725   exclude "**/*.htm"
3726
3727   // should this be exclude really ? No, swingjs dir should be transferred last (and overwrite)
3728   duplicatesStrategy "INCLUDE"
3729
3730   outputs.files outputFiles
3731   inputs.files inputFiles
3732 }
3733
3734
3735 task jalviewjsTranserSiteMergeSwingDir (type: Sync) {
3736   dependsOn jalviewjsTransferUnzipAllLibs
3737   dependsOn jalviewjsTransferUnzipSwingJs
3738   dependsOn jalviewjsTranspile
3739
3740   // merge jalview files very last
3741   def inputFiles = fileTree(dir: "${jalviewDir}/${jalviewjsTransferSiteJsDir}")
3742
3743   def outputDir = "${jalviewDir}/${jalviewjsTransferSiteMergeDir}"
3744
3745   from inputFiles
3746   into outputDir
3747   def outputFiles = []
3748   rename { filename ->
3749     outputFiles += "${outputDir}/${filename}"
3750     null
3751   }
3752   preserve {
3753     include "**"
3754   }
3755
3756   // should this be exclude really ? No, jalview dir should be transferred last (and overwrite)
3757   duplicatesStrategy "INCLUDE"
3758
3759   outputs.files outputFiles
3760   inputs.files inputFiles
3761 }
3762
3763
3764 task jalviewjsTranserSiteMergeDirs {
3765   dependsOn jalviewjsTranserSiteMergeLibDirs
3766   dependsOn jalviewjsTranserSiteMergeSwingDir
3767 }
3768
3769
3770 def jalviewjsCallCore(String name, FileCollection list, String prefixFile, String suffixFile, String jsfile, String zjsfile, File logOutFile, Boolean logOutConsole) {
3771
3772   def stdout = new ByteArrayOutputStream()
3773   def stderr = new ByteArrayOutputStream()
3774
3775   def coreFile = file(jsfile)
3776   def msg = ""
3777   msg = "Creating core for ${name}...\nGenerating ${jsfile}"
3778   println(msg)
3779   logOutFile.createNewFile()
3780   logOutFile.append(msg+"\n")
3781
3782   def coreTop = file(prefixFile)
3783   def coreBottom = file(suffixFile)
3784   def missingFiles = []
3785   coreFile.getParentFile().mkdirs()
3786   coreFile.createNewFile()
3787   coreFile.write( coreTop.getText("UTF-8") )
3788   list.each {
3789     f ->
3790     if (f.exists()) {
3791       def t = f.getText("UTF-8")
3792       t.replaceAll("Clazz\\.([^_])","Clazz_${1}")
3793       coreFile.append( t )
3794     } else {
3795       msg = "...file '"+f.getPath()+"' does not exist, skipping"
3796       println(msg)
3797       logOutFile.append(msg+"\n")
3798       missingFiles += f
3799     }
3800   }
3801   coreFile.append( coreBottom.getText("UTF-8") )
3802
3803   msg = "Generating ${zjsfile}"
3804   println(msg)
3805   logOutFile.append(msg+"\n")
3806   def logOutFOS = new FileOutputStream(logOutFile, true) // true == append
3807   def logErrFOS = logOutFOS
3808
3809   javaexec {
3810     classpath = files(["${jalviewDir}/${jalviewjs_closure_compiler}"])
3811     main = "com.google.javascript.jscomp.CommandLineRunner"
3812     jvmArgs = [ "-Dfile.encoding=UTF-8" ]
3813     args = [ "--compilation_level", jalviewjs_closure_compiler_optimization_level, "--warning_level", "QUIET", "--charset", "UTF-8", "--js", jsfile, "--js_output_file", zjsfile ]
3814     maxHeapSize = "2g"
3815
3816     msg = "\nRunning '"+commandLine.join(' ')+"'\n"
3817     println(msg)
3818     logOutFile.append(msg+"\n")
3819
3820     if (logOutConsole) {
3821       standardOutput = new org.apache.tools.ant.util.TeeOutputStream(
3822         new org.apache.tools.ant.util.TeeOutputStream(
3823           logOutFOS,
3824           stdout),
3825         standardOutput)
3826         errorOutput = new org.apache.tools.ant.util.TeeOutputStream(
3827           new org.apache.tools.ant.util.TeeOutputStream(
3828             logErrFOS,
3829             stderr),
3830           System.err)
3831     } else {
3832       standardOutput = new org.apache.tools.ant.util.TeeOutputStream(
3833         logOutFOS,
3834         stdout)
3835         errorOutput = new org.apache.tools.ant.util.TeeOutputStream(
3836           logErrFOS,
3837           stderr)
3838     }
3839   }
3840   msg = "--"
3841   if (missingFiles.size() > 0) {
3842     msg += "\n!!! These files were listed but missing:\n"
3843     missingFiles.each { file -> msg += "!!!  " + file.getPath() + "\n" }
3844     msg = "--"
3845   }
3846   println(msg)
3847   logOutFile.append(msg+"\n")
3848 }
3849
3850
3851 task jalviewjsBuildAllCores {
3852   group "JalviewJS"
3853   description "Build the core js lib closures listed in the classlists dir"
3854   dependsOn jalviewjsTranserSiteMergeDirs
3855
3856   def j2sDir = "${jalviewDir}/${jalviewjsTransferSiteMergeDir}/${jalviewjs_j2s_subdir}"
3857   def swingJ2sDir = "${jalviewDir}/${jalviewjsTransferSiteMergeDir}/${jalviewjs_j2s_subdir}"
3858   def libJ2sDir = "${jalviewDir}/${jalviewjsTransferSiteMergeDir}/${jalviewjs_j2s_subdir}"
3859   def jsDir = "${jalviewDir}/${jalviewjsTransferSiteMergeDir}/${jalviewjs_js_subdir}"
3860   def outputDir = "${jalviewDir}/${jalviewjsTransferSiteCoreDir}/${jalviewjs_j2s_subdir}/core"
3861   def prefixFile = "${jsDir}/core/coretop2.js"
3862   def suffixFile = "${jsDir}/core/corebottom2.js"
3863
3864   inputs.file prefixFile
3865   inputs.file suffixFile
3866
3867   def classlistFiles = []
3868   // add the classlists found int the jalviewjs_classlists_dir
3869   fileTree(dir: "${jalviewDir}/${jalviewjs_classlists_dir}", include: "*.txt").each {
3870     file ->
3871     def name = file.getName() - ".txt"
3872     classlistFiles += [
3873       'file': file,
3874       'name': name
3875     ]
3876   }
3877
3878   // _jmol and _jalview cores. Add any other peculiar classlist.txt files here
3879   //classlistFiles += [ 'file': file("${jalviewDir}/${jalviewjs_classlist_jmol}"), 'name': "_jvjmol" ]
3880   classlistFiles += [ 'file': file("${jalviewDir}/${jalviewjs_classlist_jalview}"), 'name': jalviewjsJalviewCoreName ]
3881
3882   jalviewjsCoreClasslists = []
3883
3884   classlistFiles.each {
3885     hash ->
3886
3887     def file = hash['file']
3888     if (! file.exists()) {
3889       //println("...classlist file '"+file.getPath()+"' does not exist, skipping")
3890       return false // this is a "continue" in groovy .each closure
3891     }
3892     def name = hash['name']
3893     if (name == null) {
3894       name = file.getName() - ".txt"
3895     }
3896
3897     def filelist = []
3898     file.eachLine {
3899       line ->
3900         filelist += line
3901     }
3902     def list = fileTree(dir: j2sDir, includes: filelist)
3903
3904     def jsfile = "${outputDir}/core${name}.js"
3905     def zjsfile = "${outputDir}/core${name}.z.js"
3906
3907     jalviewjsCoreClasslists += [
3908       'jsfile': jsfile,
3909       'zjsfile': zjsfile,
3910       'list': list,
3911       'name': name
3912     ]
3913
3914     inputs.file(file)
3915     inputs.files(list)
3916     outputs.file(jsfile)
3917     outputs.file(zjsfile)
3918   }
3919
3920   // _all core
3921   def allClasslistName = "_all"
3922   def allJsFiles = fileTree(dir: j2sDir, include: "**/*.js")
3923   allJsFiles += fileTree(
3924     dir: libJ2sDir,
3925     include: "**/*.js",
3926     excludes: [
3927       // these exlusions are files that the closure-compiler produces errors for. Should fix them
3928       "**/org/jmol/jvxl/readers/IsoIntersectFileReader.js",
3929       "**/org/jmol/export/JSExporter.js"
3930     ]
3931   )
3932   allJsFiles += fileTree(
3933     dir: swingJ2sDir,
3934     include: "**/*.js",
3935     excludes: [
3936       // these exlusions are files that the closure-compiler produces errors for. Should fix them
3937       "**/sun/misc/Unsafe.js",
3938       "**/swingjs/jquery/jquery-editable-select.js",
3939       "**/swingjs/jquery/j2sComboBox.js",
3940       "**/sun/misc/FloatingDecimal.js"
3941     ]
3942   )
3943   def allClasslist = [
3944     'jsfile': "${outputDir}/core${allClasslistName}.js",
3945     'zjsfile': "${outputDir}/core${allClasslistName}.z.js",
3946     'list': allJsFiles,
3947     'name': allClasslistName
3948   ]
3949   // not including this version of "all" core at the moment
3950   //jalviewjsCoreClasslists += allClasslist
3951   inputs.files(allClasslist['list'])
3952   outputs.file(allClasslist['jsfile'])
3953   outputs.file(allClasslist['zjsfile'])
3954
3955   doFirst {
3956     def logOutFile = file("${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_j2s_closure_stdout}")
3957     logOutFile.getParentFile().mkdirs()
3958     logOutFile.createNewFile()
3959     logOutFile.write(getDate("yyyy-MM-dd HH:mm:ss")+" jalviewjsBuildAllCores\n----\n")
3960
3961     jalviewjsCoreClasslists.each {
3962       jalviewjsCallCore(it.name, it.list, prefixFile, suffixFile, it.jsfile, it.zjsfile, logOutFile, jalviewjs_j2s_to_console.equals("true"))
3963     }
3964   }
3965
3966 }
3967
3968
3969 def jalviewjsPublishCoreTemplate(String coreName, String templateName, File inputFile, String outputFile) {
3970   copy {
3971     from inputFile
3972     into file(outputFile).getParentFile()
3973     rename { filename ->
3974       if (filename.equals(inputFile.getName())) {
3975         return file(outputFile).getName()
3976       }
3977       return null
3978     }
3979     filter(ReplaceTokens,
3980       beginToken: '_',
3981       endToken: '_',
3982       tokens: [
3983         'MAIN': '"'+main_class+'"',
3984         'CODE': "null",
3985         'NAME': jalviewjsJalviewTemplateName+" [core ${coreName}]",
3986         'COREKEY': jalviewjs_core_key,
3987         'CORENAME': coreName
3988       ]
3989     )
3990   }
3991 }
3992
3993
3994 task jalviewjsPublishCoreTemplates {
3995   dependsOn jalviewjsBuildAllCores
3996
3997   def inputFileName = "${jalviewDir}/${j2s_coretemplate_html}"
3998   def inputFile = file(inputFileName)
3999   def outputDir = "${jalviewDir}/${jalviewjsTransferSiteCoreDir}"
4000
4001   def outputFiles = []
4002   jalviewjsCoreClasslists.each { cl ->
4003     def outputFile = "${outputDir}/${jalviewjsJalviewTemplateName}_${cl.name}.html"
4004     cl['outputfile'] = outputFile
4005     outputFiles += outputFile
4006   }
4007
4008   doFirst {
4009     jalviewjsCoreClasslists.each { cl ->
4010       jalviewjsPublishCoreTemplate(cl.name, jalviewjsJalviewTemplateName, inputFile, cl.outputfile)
4011     }
4012   }
4013   inputs.file(inputFile)
4014   outputs.files(outputFiles)
4015 }
4016
4017
4018 task jalviewjsSyncCore (type: Sync) {
4019   dependsOn jalviewjsBuildAllCores
4020   dependsOn jalviewjsPublishCoreTemplates
4021
4022   def inputFiles = fileTree(dir: "${jalviewDir}/${jalviewjsTransferSiteCoreDir}")
4023   def outputDir = "${jalviewDir}/${jalviewjsSiteDir}"
4024
4025   from inputFiles
4026   into outputDir
4027   def outputFiles = []
4028   rename { filename ->
4029     outputFiles += "${outputDir}/${filename}"
4030     null
4031   }
4032   preserve {
4033     include "**"
4034   }
4035   outputs.files outputFiles
4036   inputs.files inputFiles
4037 }
4038
4039
4040 // this Copy version of TransferSiteJs will delete anything else in the target dir
4041 task jalviewjsCopyTransferSiteMergeDir(type: Copy) {
4042   dependsOn jalviewjsTranserSiteMergeDirs
4043
4044   from "${jalviewDir}/${jalviewjsTransferSiteMergeDir}"
4045   into "${jalviewDir}/${jalviewjsSiteDir}"
4046 }
4047
4048
4049 // this Copy version of TransferSiteJs will delete anything else in the target dir
4050 task jalviewjsCopyTransferSiteJs(type: Copy) {
4051   dependsOn jalviewjsTranspile
4052
4053   from "${jalviewDir}/${jalviewjsTransferSiteJsDir}"
4054   into "${jalviewDir}/${jalviewjsSiteDir}"
4055 }
4056
4057
4058 // this Sync version of TransferSite is used by buildship to keep the website automatically up to date when a file changes
4059 task jalviewjsSyncTransferSiteJs(type: Sync) {
4060   from "${jalviewDir}/${jalviewjsTransferSiteJsDir}"
4061   include "**/*.*"
4062   into "${jalviewDir}/${jalviewjsSiteDir}"
4063   preserve {
4064     include "**"
4065   }
4066 }
4067
4068
4069 jalviewjsSyncAllLibs.mustRunAfter jalviewjsCopyTransferSiteJs
4070 jalviewjsSyncResources.mustRunAfter jalviewjsCopyTransferSiteJs
4071 jalviewjsSyncSiteResources.mustRunAfter jalviewjsCopyTransferSiteJs
4072 jalviewjsSyncBuildProperties.mustRunAfter jalviewjsCopyTransferSiteJs
4073
4074 jalviewjsSyncAllLibs.mustRunAfter jalviewjsSyncTransferSiteJs
4075 jalviewjsSyncResources.mustRunAfter jalviewjsSyncTransferSiteJs
4076 jalviewjsSyncSiteResources.mustRunAfter jalviewjsSyncTransferSiteJs
4077 jalviewjsSyncBuildProperties.mustRunAfter jalviewjsSyncTransferSiteJs
4078
4079
4080 task jalviewjsPrepareSite {
4081   group "JalviewJS"
4082   description "Prepares the website folder including unzipping files and copying resources"
4083   //dependsOn jalviewjsSyncAllLibs // now using jalviewjsCopyTransferSiteMergeDir
4084   dependsOn jalviewjsSyncResources
4085   dependsOn jalviewjsSyncSiteResources
4086   dependsOn jalviewjsSyncBuildProperties
4087   dependsOn jalviewjsSyncCore
4088 }
4089
4090
4091 task jalviewjsBuildSite {
4092   group "JalviewJS"
4093   description "Builds the whole website including transpiled code"
4094   dependsOn jalviewjsCopyTransferSiteMergeDir
4095   dependsOn jalviewjsPrepareSite
4096 }
4097
4098
4099 task cleanJalviewjsTransferSite {
4100   doFirst {
4101     delete "${jalviewDir}/${jalviewjsTransferSiteJsDir}"
4102     delete "${jalviewDir}/${jalviewjsTransferSiteLibDir}"
4103     delete "${jalviewDir}/${jalviewjsTransferSiteSwingJsDir}"
4104     delete "${jalviewDir}/${jalviewjsTransferSiteCoreDir}"
4105   }
4106 }
4107
4108
4109 task cleanJalviewjsSite {
4110   dependsOn cleanJalviewjsTransferSite
4111   doFirst {
4112     delete "${jalviewDir}/${jalviewjsSiteDir}"
4113   }
4114 }
4115
4116
4117 task jalviewjsSiteTar(type: Tar) {
4118   group "JalviewJS"
4119   description "Creates a tar.gz file for the website"
4120   dependsOn jalviewjsBuildSite
4121   def outputFilename = "jalviewjs-site-${JALVIEW_VERSION}.tar.gz"
4122   archiveFileName = outputFilename
4123
4124   compression Compression.GZIP
4125
4126   from "${jalviewDir}/${jalviewjsSiteDir}"
4127   into jalviewjs_site_dir // this is inside the tar file
4128
4129   inputs.dir("${jalviewDir}/${jalviewjsSiteDir}")
4130 }
4131
4132
4133 task jalviewjsServer {
4134   group "JalviewJS"
4135   def filename = "jalviewjsTest.html"
4136   description "Starts a webserver on localhost to test the website. See ${filename} to access local site on most recently used port."
4137   def htmlFile = "${jalviewDirAbsolutePath}/${filename}"
4138   doLast {
4139
4140     def factory
4141     try {
4142       def f = Class.forName("org.gradle.plugins.javascript.envjs.http.simple.SimpleHttpFileServerFactory")
4143       factory = f.newInstance()
4144     } catch (ClassNotFoundException e) {
4145       throw new GradleException("Unable to create SimpleHttpFileServerFactory")
4146     }
4147     def port = Integer.valueOf(jalviewjs_server_port)
4148     def start = port
4149     def running = false
4150     def url
4151     def jalviewjsServer
4152     while(port < start+1000 && !running) {
4153       try {
4154         def doc_root = new File("${jalviewDirAbsolutePath}/${jalviewjsSiteDir}")
4155         jalviewjsServer = factory.start(doc_root, port)
4156         running = true
4157         url = jalviewjsServer.getResourceUrl(jalviewjs_server_resource)
4158         println("SERVER STARTED with document root ${doc_root}.")
4159         println("Go to "+url+" . Run  gradle --stop  to stop (kills all gradle daemons).")
4160         println("For debug: "+url+"?j2sdebug")
4161         println("For verbose: "+url+"?j2sverbose")
4162       } catch (Exception e) {
4163         port++;
4164       }
4165     }
4166     def htmlText = """
4167       <p><a href="${url}">JalviewJS Test. &lt;${url}&gt;</a></p>
4168       <p><a href="${url}?j2sdebug">JalviewJS Test with debug. &lt;${url}?j2sdebug&gt;</a></p>
4169       <p><a href="${url}?j2sverbose">JalviewJS Test with verbose. &lt;${url}?j2sdebug&gt;</a></p>
4170       """
4171     jalviewjsCoreClasslists.each { cl ->
4172       def urlcore = jalviewjsServer.getResourceUrl(file(cl.outputfile).getName())
4173       htmlText += """
4174       <p><a href="${urlcore}">${jalviewjsJalviewTemplateName} [core ${cl.name}]. &lt;${urlcore}&gt;</a></p>
4175       """
4176       println("For core ${cl.name}: "+urlcore)
4177     }
4178
4179     file(htmlFile).text = htmlText
4180   }
4181
4182   outputs.file(htmlFile)
4183   outputs.upToDateWhen({false})
4184 }
4185
4186
4187 task cleanJalviewjsAll {
4188   group "JalviewJS"
4189   description "Delete all configuration and build artifacts to do with JalviewJS build"
4190   dependsOn cleanJalviewjsSite
4191   dependsOn jalviewjsEclipsePaths
4192
4193   doFirst {
4194     delete "${jalviewDir}/${jalviewjsBuildDir}"
4195     delete "${jalviewDir}/${eclipse_bin_dir}"
4196     if (eclipseWorkspace != null && file(eclipseWorkspace.getAbsolutePath()+"/.metadata").exists()) {
4197       delete file(eclipseWorkspace.getAbsolutePath()+"/.metadata")
4198     }
4199     delete jalviewjsJ2sAltSettingsFileName
4200   }
4201
4202   outputs.upToDateWhen( { false } )
4203 }
4204
4205
4206 task jalviewjsIDE_checkJ2sPlugin {
4207   group "00 JalviewJS in Eclipse"
4208   description "Compare the swingjs/net.sf.j2s.core(-j11)?.jar file with the Eclipse IDE's plugin version (found in the 'dropins' dir)"
4209
4210   doFirst {
4211     def j2sPlugin = string("${jalviewDir}/${jalviewjsJ2sPlugin}")
4212     def j2sPluginFile = file(j2sPlugin)
4213     def eclipseHome = System.properties["eclipse.home.location"]
4214     if (eclipseHome == null || ! IN_ECLIPSE) {
4215       throw new StopExecutionException("Cannot find running Eclipse home from System.properties['eclipse.home.location']. Skipping J2S Plugin Check.")
4216     }
4217     def eclipseJ2sPluginDirs = [ "${eclipseHome}/dropins" ]
4218     def altPluginsDir = System.properties["org.eclipse.equinox.p2.reconciler.dropins.directory"]
4219     if (altPluginsDir != null && file(altPluginsDir).exists()) {
4220       eclipseJ2sPluginDirs += altPluginsDir
4221     }
4222     def foundPlugin = false
4223     def j2sPluginFileName = j2sPluginFile.getName()
4224     def eclipseJ2sPlugin
4225     def eclipseJ2sPluginFile
4226     eclipseJ2sPluginDirs.any { dir ->
4227       eclipseJ2sPlugin = "${dir}/${j2sPluginFileName}"
4228       eclipseJ2sPluginFile = file(eclipseJ2sPlugin)
4229       if (eclipseJ2sPluginFile.exists()) {
4230         foundPlugin = true
4231         return true
4232       }
4233     }
4234     if (!foundPlugin) {
4235       def msg = "Eclipse J2S Plugin is not installed (could not find '${j2sPluginFileName}' in\n"+eclipseJ2sPluginDirs.join("\n")+"\n)\nTry running task jalviewjsIDE_copyJ2sPlugin"
4236       System.err.println(msg)
4237       throw new StopExecutionException(msg)
4238     }
4239
4240     def digest = MessageDigest.getInstance("MD5")
4241
4242     digest.update(j2sPluginFile.text.bytes)
4243     def j2sPluginMd5 = new BigInteger(1, digest.digest()).toString(16).padLeft(32, '0')
4244
4245     digest.update(eclipseJ2sPluginFile.text.bytes)
4246     def eclipseJ2sPluginMd5 = new BigInteger(1, digest.digest()).toString(16).padLeft(32, '0')
4247
4248     if (j2sPluginMd5 != eclipseJ2sPluginMd5) {
4249       def msg = "WARNING! Eclipse J2S Plugin '${eclipseJ2sPlugin}' is different to this commit's version '${j2sPlugin}'"
4250       System.err.println(msg)
4251       throw new StopExecutionException(msg)
4252     } else {
4253       def msg = "Eclipse J2S Plugin '${eclipseJ2sPlugin}' is the same as '${j2sPlugin}' (this is good)"
4254       println(msg)
4255     }
4256   }
4257 }
4258
4259 task jalviewjsIDE_copyJ2sPlugin {
4260   group "00 JalviewJS in Eclipse"
4261   description "Copy the swingjs/net.sf.j2s.core(-j11)?.jar file into the Eclipse IDE's 'dropins' dir"
4262
4263   doFirst {
4264     def j2sPlugin = string("${jalviewDir}/${jalviewjsJ2sPlugin}")
4265     def j2sPluginFile = file(j2sPlugin)
4266     def eclipseHome = System.properties["eclipse.home.location"]
4267     if (eclipseHome == null || ! IN_ECLIPSE) {
4268       throw new StopExecutionException("Cannot find running Eclipse home from System.properties['eclipse.home.location']. NOT copying J2S Plugin.")
4269     }
4270     def eclipseJ2sPlugin = "${eclipseHome}/dropins/${j2sPluginFile.getName()}"
4271     def eclipseJ2sPluginFile = file(eclipseJ2sPlugin)
4272     def msg = "WARNING! Copying this commit's j2s plugin '${j2sPlugin}' to Eclipse J2S Plugin '${eclipseJ2sPlugin}'\n* May require an Eclipse restart"
4273     System.err.println(msg)
4274     copy {
4275       from j2sPlugin
4276       eclipseJ2sPluginFile.getParentFile().mkdirs()
4277       into eclipseJ2sPluginFile.getParent()
4278     }
4279   }
4280 }
4281
4282
4283 task jalviewjsIDE_j2sFile {
4284   group "00 JalviewJS in Eclipse"
4285   description "Creates the .j2s file"
4286   dependsOn jalviewjsCreateJ2sSettings
4287 }
4288
4289
4290 task jalviewjsIDE_SyncCore {
4291   group "00 JalviewJS in Eclipse"
4292   description "Build the core js lib closures listed in the classlists dir and publish core html from template"
4293   dependsOn jalviewjsSyncCore
4294 }
4295
4296
4297 task jalviewjsIDE_SyncSiteAll {
4298   dependsOn jalviewjsSyncAllLibs
4299   dependsOn jalviewjsSyncResources
4300   dependsOn jalviewjsSyncSiteResources
4301   dependsOn jalviewjsSyncBuildProperties
4302 }
4303
4304
4305 cleanJalviewjsTransferSite.mustRunAfter jalviewjsIDE_SyncSiteAll
4306
4307
4308 task jalviewjsIDE_PrepareSite {
4309   group "00 JalviewJS in Eclipse"
4310   description "Sync libs and resources to site dir, but not closure cores"
4311
4312   dependsOn jalviewjsIDE_SyncSiteAll
4313   //dependsOn cleanJalviewjsTransferSite // not sure why this clean is here -- will slow down a re-run of this task
4314 }
4315
4316
4317 task jalviewjsIDE_AssembleSite {
4318   group "00 JalviewJS in Eclipse"
4319   description "Assembles unzipped supporting zipfiles, resources, site resources and closure cores into the Eclipse transpiled site"
4320   dependsOn jalviewjsPrepareSite
4321 }
4322
4323
4324 task jalviewjsIDE_SiteClean {
4325   group "00 JalviewJS in Eclipse"
4326   description "Deletes the Eclipse transpiled site"
4327   dependsOn cleanJalviewjsSite
4328 }
4329
4330
4331 task jalviewjsIDE_Server {
4332   group "00 JalviewJS in Eclipse"
4333   description "Starts a webserver on localhost to test the website"
4334   dependsOn jalviewjsServer
4335 }
4336
4337
4338 // buildship runs this at import or gradle refresh
4339 task eclipseSynchronizationTask {
4340   //dependsOn eclipseSetup
4341   dependsOn createBuildProperties
4342   if (J2S_ENABLED) {
4343     dependsOn jalviewjsIDE_j2sFile
4344     dependsOn jalviewjsIDE_checkJ2sPlugin
4345     dependsOn jalviewjsIDE_PrepareSite
4346   }
4347 }
4348
4349
4350 // buildship runs this at build time or project refresh
4351 task eclipseAutoBuildTask {
4352   //dependsOn jalviewjsIDE_checkJ2sPlugin
4353   //dependsOn jalviewjsIDE_PrepareSite
4354 }
4355
4356
4357 task jalviewjsCopyStderrLaunchFile(type: Copy) {
4358   from file(jalviewjs_stderr_launch)
4359   into jalviewjsSiteDir
4360
4361   inputs.file jalviewjs_stderr_launch
4362   outputs.file jalviewjsStderrLaunchFilename
4363 }
4364
4365 task cleanJalviewjsChromiumUserDir {
4366   doFirst {
4367     delete jalviewjsChromiumUserDir
4368   }
4369   outputs.dir jalviewjsChromiumUserDir
4370   // always run when depended on
4371   outputs.upToDateWhen { !file(jalviewjsChromiumUserDir).exists() }
4372 }
4373
4374 task jalviewjsChromiumProfile {
4375   dependsOn cleanJalviewjsChromiumUserDir
4376   mustRunAfter cleanJalviewjsChromiumUserDir
4377
4378   def firstRun = file("${jalviewjsChromiumUserDir}/First Run")
4379
4380   doFirst {
4381     mkdir jalviewjsChromiumProfileDir
4382     firstRun.text = ""
4383   }
4384   outputs.file firstRun
4385 }
4386
4387 task jalviewjsLaunchTest {
4388   group "Test"
4389   description "Check JalviewJS opens in a browser"
4390   dependsOn jalviewjsBuildSite
4391   dependsOn jalviewjsCopyStderrLaunchFile
4392   dependsOn jalviewjsChromiumProfile
4393
4394   def macOS = OperatingSystem.current().isMacOsX()
4395   def chromiumBinary = macOS ? jalviewjs_macos_chromium_binary : jalviewjs_chromium_binary
4396   if (chromiumBinary.startsWith("~/")) {
4397     chromiumBinary = System.getProperty("user.home") + chromiumBinary.substring(1)
4398   }
4399
4400   def stdout
4401   def stderr
4402   doFirst {
4403     def timeoutms = Integer.valueOf(jalviewjs_chromium_overall_timeout) * 1000
4404
4405     def binary = file(chromiumBinary)
4406     if (!binary.exists()) {
4407       throw new StopExecutionException("Could not find chromium binary '${chromiumBinary}'. Cannot run task ${name}.")
4408     }
4409     stdout = new ByteArrayOutputStream()
4410     stderr = new ByteArrayOutputStream()
4411     def execStdout
4412     def execStderr
4413     if (jalviewjs_j2s_to_console.equals("true")) {
4414       execStdout = new org.apache.tools.ant.util.TeeOutputStream(
4415         stdout,
4416         System.out)
4417       execStderr = new org.apache.tools.ant.util.TeeOutputStream(
4418         stderr,
4419         System.err)
4420     } else {
4421       execStdout = stdout
4422       execStderr = stderr
4423     }
4424     // macOS not running properly with timeout arguments
4425     def execArgs = macOS ? [] : [
4426       "--virtual-time-budget=${timeoutms}",
4427     ]
4428     execArgs += [
4429       "--no-sandbox", // --no-sandbox IS USED BY THE THORIUM APPIMAGE ON THE BUILDSERVER
4430       "--headless=new",
4431       "--disable-gpu",
4432       "--user-data-dir=${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_chromium_user_dir}",
4433       "--profile-directory=${jalviewjs_chromium_profile_name}",
4434       "--allow-file-access-from-files",
4435       "--enable-logging=stderr",
4436       "file://${jalviewDirAbsolutePath}/${jalviewjsStderrLaunchFilename}"
4437     ]
4438
4439     if (true || macOS) {
4440       ScheduledExecutorService executor = Executors.newScheduledThreadPool(3);
4441       Future f1 = executor.submit(
4442         () -> {
4443           exec {
4444             standardOutput = execStdout
4445             errorOutput = execStderr
4446             executable(chromiumBinary)
4447             args(execArgs)
4448             println "COMMAND: '"+commandLine.join(" ")+"'"
4449           }
4450           executor.shutdownNow()
4451         }
4452       )
4453
4454       def noChangeBytes = 0
4455       def noChangeIterations = 0
4456       executor.scheduleAtFixedRate(
4457         () -> {
4458           String stderrString = stderr.toString()
4459           // shutdown the task if we have a success string
4460           if (stderrString.contains(jalviewjs_desktop_init_string)) {
4461             f1.cancel()
4462             Thread.sleep(1000)
4463             executor.shutdownNow()
4464           }
4465           // if no change in stderr for 10s then also end
4466           if (noChangeIterations >= jalviewjs_chromium_idle_timeout) {
4467             executor.shutdownNow()
4468           }
4469           if (stderrString.length() == noChangeBytes) {
4470             noChangeIterations++
4471           } else {
4472             noChangeBytes = stderrString.length()
4473             noChangeIterations = 0
4474           }
4475         },
4476         1, 1, TimeUnit.SECONDS)
4477
4478       executor.schedule(new Runnable(){
4479         public void run(){
4480           f1.cancel()
4481           executor.shutdownNow()
4482         }
4483       }, timeoutms, TimeUnit.MILLISECONDS)
4484
4485       executor.awaitTermination(timeoutms+10000, TimeUnit.MILLISECONDS)
4486       executor.shutdownNow()
4487     }
4488
4489   }
4490
4491   doLast {
4492     def found = false
4493     stderr.toString().eachLine { line ->
4494       if (line.contains(jalviewjs_desktop_init_string)) {
4495         println("Found line '"+line+"'")
4496         found = true
4497         return
4498       }
4499     }
4500     if (!found) {
4501       throw new GradleException("Could not find evidence of Desktop launch in JalviewJS.")
4502     }
4503   }
4504 }
4505
4506
4507 task jalviewjs {
4508   group "JalviewJS"
4509   description "Build the JalviewJS site and run the launch test"
4510   dependsOn jalviewjsBuildSite
4511   dependsOn jalviewjsLaunchTest
4512 }