build.gradle

   1 import org.apache.tools.ant.filters.ReplaceTokens
   2 import org.gradle.internal.os.OperatingSystem
   3 import org.gradle.plugins.ide.eclipse.model.Output
   4 import org.gradle.plugins.ide.eclipse.model.Library
   5 import java.security.MessageDigest
   6 import groovy.transform.ExternalizeMethods
   7 import groovy.util.XmlParser
   8 import groovy.xml.XmlUtil
   9
  10
  11 buildscript {
  12   repositories {
  13     mavenCentral()
  14     mavenLocal()
  15   }
  16   dependencies {
  17     classpath 'org.openclover:clover:4.4.1'
  18   }
  19 }
  20
  21
  22 plugins {
  23   id 'java'
  24   id 'application'
  25   id 'eclipse'
  26   id 'com.github.johnrengelman.shadow' version '4.0.3'
  27   id 'com.install4j.gradle' version '8.0.4'
  28   id 'com.dorongold.task-tree' version '1.5' // only needed to display task dependency tree with  gradle task1 [task2 ...] taskTree
  29 }
  30
  31 repositories {
  32   jcenter()
  33   mavenCentral()
  34   mavenLocal()
  35 }
  36
  37
  38 // in ext the values are cast to Object. Ensure string values are cast as String (and not GStringImpl) for later use
  39 def string(Object o) {
  40   return o == null ? "" : o.toString()
  41 }
  42
  43
  44 ext {
  45   jalviewDirAbsolutePath = file(jalviewDir).getAbsolutePath()
  46   jalviewDirRelativePath = jalviewDir
  47
  48   // local build environment properties
  49   // can be "projectDir/local.properties"
  50   def localProps = "${projectDir}/local.properties"
  51   def propsFile = null;
  52   if (file(localProps).exists()) {
  53     propsFile = localProps
  54   }
  55   // or "../projectDir_local.properties"
  56   def dirLocalProps = projectDir.getParent() + "/" + projectDir.getName() + "_local.properties"
  57   if (file(dirLocalProps).exists()) {
  58     propsFile = dirLocalProps
  59   }
  60   if (propsFile != null) {
  61     try {
  62       def p = new Properties()
  63       def localPropsFIS = new FileInputStream(propsFile)
  64       p.load(localPropsFIS)
  65       localPropsFIS.close()
  66       p.each {
  67         key, val ->
  68           def oldval = findProperty(key)
  69           setProperty(key, val)
  70           if (oldval != null) {
  71             println("Overriding property '${key}' ('${oldval}') with ${file(propsFile).getName()} value '${val}'")
  72           } else {
  73             println("Setting unknown property '${key}' with ${file(propsFile).getName()}s value '${val}'")
  74           }
  75       }
  76     } catch (Exception e) {
  77       System.out.println("Exception reading local.properties")
  78     }
  79   }
  80
  81   ////
  82   // Import releaseProps from the RELEASE file
  83   // or a file specified via JALVIEW_RELEASE_FILE if defined
  84   // Expect jalview.version and target release branch in jalview.release
  85   def releaseProps = new Properties();
  86   def releasePropFile = findProperty("JALVIEW_RELEASE_FILE");
  87   def defaultReleasePropFile = "${jalviewDirAbsolutePath}/RELEASE";
  88   try {
  89     (new File(releasePropFile!=null ? releasePropFile : defaultReleasePropFile)).withInputStream {
  90      releaseProps.load(it)
  91     }
  92   } catch (Exception fileLoadError) {
  93     throw new Error("Couldn't load release properties file "+(releasePropFile==null ? defaultReleasePropFile : "from custom location: releasePropFile"),fileLoadError);
  94   }
  95   ////
  96   // Set JALVIEW_VERSION if it is not already set
  97   if (findProperty(JALVIEW_VERSION)==null || "".equals(JALVIEW_VERSION)) {
  98     JALVIEW_VERSION = releaseProps.get("jalview.version")
  99   }
 100
 101   // this property set when running Eclipse headlessly
 102   j2sHeadlessBuildProperty = string("net.sf.j2s.core.headlessbuild")
 103   // this property set by Eclipse
 104   eclipseApplicationProperty = string("eclipse.application")
 105   // CHECK IF RUNNING FROM WITHIN ECLIPSE
 106   def eclipseApplicationPropertyVal = System.properties[eclipseApplicationProperty]
 107   IN_ECLIPSE = eclipseApplicationPropertyVal != null && eclipseApplicationPropertyVal.startsWith("org.eclipse.ui.")
 108   // BUT WITHOUT THE HEADLESS BUILD PROPERTY SET
 109   if (System.properties[j2sHeadlessBuildProperty].equals("true")) {
 110     println("Setting IN_ECLIPSE to ${IN_ECLIPSE} as System.properties['${j2sHeadlessBuildProperty}'] == '${System.properties[j2sHeadlessBuildProperty]}'")
 111     IN_ECLIPSE = false
 112   }
 113   if (IN_ECLIPSE) {
 114     println("WITHIN ECLIPSE IDE")
 115   } else {
 116     println("HEADLESS BUILD")
 117   }
 118   /* *-/
 119   System.properties.sort { it.key }.each {
 120     key, val -> println("SYSTEM PROPERTY ${key}='${val}'")
 121   }
 122   /-* *-/
 123   if (false && IN_ECLIPSE) {
 124     jalviewDir = jalviewDirAbsolutePath
 125   }
 126   */
 127
 128   // essentials
 129   bareSourceDir = string(source_dir)
 130   sourceDir = string("${jalviewDir}/${bareSourceDir}")
 131   resourceDir = string("${jalviewDir}/${resource_dir}")
 132   bareTestSourceDir = string(test_source_dir)
 133   testSourceDir = string("${jalviewDir}/${bareTestSourceDir}")
 134
 135   // clover
 136   cloverInstrDir = file("${buildDir}/${cloverSourcesInstrDir}")
 137   cloverDb = string("${buildDir}/clover/clover.db")
 138   classesDir = string("${jalviewDir}/${classes_dir}")
 139   if (clover.equals("true")) {
 140     use_clover = true
 141     classesDir = string("${buildDir}/${cloverClassesDir}")
 142   } else {
 143     use_clover = false
 144     classesDir = string("${jalviewDir}/${classes_dir}")
 145   }
 146
 147   classes = classesDir
 148
 149   getdownWebsiteDir = string("${jalviewDir}/${getdown_website_dir}/${JAVA_VERSION}")
 150   buildDist = true
 151
 152   // the following values might be overridden by the CHANNEL switch
 153   getdownChannelName = CHANNEL.toLowerCase()
 154   getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
 155   getdownAppBase = string("${getdown_channel_base}/${getdownDir}")
 156   getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher}")
 157   getdownAppDistDir = getdown_app_dir_alt
 158   buildProperties = string("${classesDir}/${build_properties_file}")
 159   reportRsyncCommand = false
 160   jvlChannelName = CHANNEL.toLowerCase()
 161   install4jSuffix = CHANNEL.substring(0, 1).toUpperCase() + CHANNEL.substring(1).toLowerCase(); // BUILD -> Build
 162   install4jDSStore = "DS_Store-NON-RELEASE"
 163   install4jDMGBackgroundImage = "jalview_dmg_background-NON-RELEASE.png"
 164   install4jInstallerName = "${jalview_name} Non-Release Installer"
 165   install4jExecutableName = jalview_name.replaceAll("[^\\w]+", "_").toLowerCase()
 166   install4jExtraScheme = "jalviewx"
 167   switch (CHANNEL) {
 168
 169     case "BUILD":
 170     // TODO: get bamboo build artifact URL for getdown artifacts
 171     getdown_channel_base = bamboo_channelbase
 172     getdownChannelName = string("${bamboo_planKey}/${JAVA_VERSION}")
 173     getdownAppBase = string("${bamboo_channelbase}/${bamboo_planKey}${bamboo_getdown_channel_suffix}/${JAVA_VERSION}")
 174     jvlChannelName += "_${getdownChannelName}"
 175     // automatically add the test group Not-bamboo for exclusion
 176     if ("".equals(testngExcludedGroups)) {
 177       testngExcludedGroups = "Not-bamboo"
 178     }
 179     install4jExtraScheme = "jalviewb"
 180     break
 181
 182     case "RELEASE":
 183     getdownAppDistDir = getdown_app_dir_release
 184     reportRsyncCommand = true
 185     install4jSuffix = ""
 186     install4jDSStore = "DS_Store"
 187     install4jDMGBackgroundImage = "jalview_dmg_background.png"
 188     install4jInstallerName = "${jalview_name} Installer"
 189     break
 190
 191     case "ARCHIVE":
 192     getdownChannelName = CHANNEL.toLowerCase()+"/${JALVIEW_VERSION}"
 193     getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
 194     getdownAppBase = string("${getdown_channel_base}/${getdownDir}")
 195     if (!file("${ARCHIVEDIR}/${packageDir}").exists()) {
 196       throw new GradleException("Must provide an ARCHIVEDIR value to produce an archive distribution")
 197     } else {
 198       packageDir = string("${ARCHIVEDIR}/${packageDir}")
 199       buildProperties = string("${ARCHIVEDIR}/${classes_dir}/${build_properties_file}")
 200       buildDist = false
 201     }
 202     reportRsyncCommand = true
 203     install4jExtraScheme = "jalviewa"
 204     break
 205
 206     case "ARCHIVELOCAL":
 207     getdownChannelName = string("archive/${JALVIEW_VERSION}")
 208     getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
 209     getdownAppBase = file(getdownWebsiteDir).toURI().toString()
 210     if (!file("${ARCHIVEDIR}/${packageDir}").exists()) {
 211       throw new GradleException("Must provide an ARCHIVEDIR value to produce an archive distribution")
 212     } else {
 213       packageDir = string("${ARCHIVEDIR}/${packageDir}")
 214       buildProperties = string("${ARCHIVEDIR}/${classes_dir}/${build_properties_file}")
 215       buildDist = false
 216     }
 217     reportRsyncCommand = true
 218     getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
 219     install4jSuffix = "Archive"
 220     install4jExtraScheme = "jalviewa"
 221     break
 222
 223     case "DEVELOP":
 224     reportRsyncCommand = true
 225
 226     // DEVELOP-RELEASE is usually associated with a Jalview release series so set the version
 227     JALVIEW_VERSION=JALVIEW_VERSION+"-develop"
 228
 229     install4jSuffix = "Develop"
 230     install4jDSStore = "DS_Store-DEVELOP"
 231     install4jDMGBackgroundImage = "jalview_dmg_background-DEVELOP.png"
 232     install4jExtraScheme = "jalviewd"
 233     install4jInstallerName = "${jalview_name} Develop Installer"
 234     break
 235
 236     case "TEST-RELEASE":
 237     reportRsyncCommand = true
 238
 239     // TEST-RELEASE is usually associated with a Jalview release series so set the version
 240     JALVIEW_VERSION=JALVIEW_VERSION+"-test"
 241
 242     install4jSuffix = "Test"
 243     install4jDSStore = "DS_Store-TEST-RELEASE"
 244     install4jDMGBackgroundImage = "jalview_dmg_background-TEST.png"
 245     install4jExtraScheme = "jalviewt"
 246     install4jInstallerName = "${jalview_name} Test Installer"
 247     break
 248
 249     case ~/^SCRATCH(|-[-\w]*)$/:
 250     getdownChannelName = CHANNEL
 251     getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
 252     getdownAppBase = string("${getdown_channel_base}/${getdownDir}")
 253     reportRsyncCommand = true
 254     install4jSuffix = "Scratch"
 255     break
 256
 257     case "TEST-LOCAL":
 258     if (!file("${LOCALDIR}").exists()) {
 259       throw new GradleException("Must provide a LOCALDIR value to produce a local distribution")
 260     } else {
 261       getdownAppBase = file(file("${LOCALDIR}").getAbsolutePath()).toURI().toString()
 262       getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
 263     }
 264     JALVIEW_VERSION = "TEST"
 265     install4jSuffix = "Test-Local"
 266     install4jDSStore = "DS_Store-TEST-RELEASE"
 267     install4jDMGBackgroundImage = "jalview_dmg_background-TEST.png"
 268     install4jExtraScheme = "jalviewt"
 269     install4jInstallerName = "${jalview_name} Test Installer"
 270     break
 271
 272     case "LOCAL":
 273     getdownAppBase = file(getdownWebsiteDir).toURI().toString()
 274     getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
 275     install4jExtraScheme = "jalviewl"
 276     break
 277
 278     default: // something wrong specified
 279     throw new GradleException("CHANNEL must be one of BUILD, RELEASE, ARCHIVE, DEVELOP, TEST-RELEASE, SCRATCH-..., LOCAL [default]")
 280     break
 281
 282   }
 283   // override getdownAppBase if requested
 284   if (findProperty("getdown_appbase_override") != null) {
 285     getdownAppBase = string(getProperty("getdown_appbase_override"))
 286     println("Overriding getdown appbase with '${getdownAppBase}'")
 287   }
 288   // sanitise file name for jalview launcher file for this channel
 289   jvlChannelName = jvlChannelName.replaceAll("[^\\w\\-]+", "_")
 290   // install4j application and folder names
 291   if (install4jSuffix == "") {
 292     install4jApplicationName = "${jalview_name}"
 293     install4jBundleId = "${install4j_bundle_id}"
 294     install4jWinApplicationId = install4j_release_win_application_id
 295   } else {
 296     install4jApplicationName = "${jalview_name} ${install4jSuffix}"
 297     install4jBundleId = "${install4j_bundle_id}-" + install4jSuffix.toLowerCase()
 298     // add int hash of install4jSuffix to the last part of the application_id
 299     def id = install4j_release_win_application_id
 300     def idsplitreverse = id.split("-").reverse()
 301     idsplitreverse[0] = idsplitreverse[0].toInteger() + install4jSuffix.hashCode()
 302     install4jWinApplicationId = idsplitreverse.reverse().join("-")
 303   }
 304   // sanitise folder and id names
 305   // install4jApplicationFolder = e.g. "Jalview Build"
 306   install4jApplicationFolder = install4jApplicationName
 307                                     .replaceAll("[\"'~:/\\\\\\s]", "_") // replace all awkward filename chars " ' ~ : / \
 308                                     .replaceAll("_+", "_") // collapse __
 309   install4jInternalId = install4jApplicationName
 310                                     .replaceAll(" ","_")
 311                                     .replaceAll("[^\\w\\-\\.]", "_") // replace other non [alphanumeric,_,-,.]
 312                                     .replaceAll("_+", "") // collapse __
 313                                     //.replaceAll("_*-_*", "-") // collapse _-_
 314   install4jUnixApplicationFolder = install4jApplicationName
 315                                     .replaceAll(" ","_")
 316                                     .replaceAll("[^\\w\\-\\.]", "_") // replace other non [alphanumeric,_,-,.]
 317                                     .replaceAll("_+", "_") // collapse __
 318                                     .replaceAll("_*-_*", "-") // collapse _-_
 319                                     .toLowerCase()
 320
 321   getdownAppDir = string("${getdownWebsiteDir}/${getdownAppDistDir}")
 322   //getdownJ11libDir = "${getdownWebsiteDir}/${getdown_j11lib_dir}"
 323   getdownResourceDir = string("${getdownWebsiteDir}/${getdown_resource_dir}")
 324   getdownInstallDir = string("${getdownWebsiteDir}/${getdown_install_dir}")
 325   getdownFilesDir = string("${jalviewDir}/${getdown_files_dir}/${JAVA_VERSION}/")
 326   getdownFilesInstallDir = string("${getdownFilesDir}/${getdown_install_dir}")
 327   /* compile without modules -- using classpath libraries
 328   modules_compileClasspath = fileTree(dir: "${jalviewDir}/${j11modDir}", include: ["*.jar"])
 329   modules_runtimeClasspath = modules_compileClasspath
 330   */
 331   gitHash = string("")
 332   gitBranch = string("")
 333
 334   println("Using a ${CHANNEL} profile.")
 335
 336   additional_compiler_args = []
 337   // configure classpath/args for j8/j11 compilation
 338   if (JAVA_VERSION.equals("1.8")) {
 339     JAVA_INTEGER_VERSION = string("8")
 340     //libDir = j8libDir
 341     libDir = j11libDir
 342     libDistDir = j8libDir
 343     compile_source_compatibility = 1.8
 344     compile_target_compatibility = 1.8
 345     // these are getdown.txt properties defined dependent on the JAVA_VERSION
 346     getdownAltJavaMinVersion = string(findProperty("getdown_alt_java8_min_version"))
 347     getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java8_max_version"))
 348     // this property is assigned below and expanded to multiple lines in the getdown task
 349     getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java8_txt_multi_java_location"))
 350     // this property is for the Java library used in eclipse
 351     eclipseJavaRuntimeName = string("JavaSE-1.8")
 352   } else if (JAVA_VERSION.equals("11")) {
 353     JAVA_INTEGER_VERSION = string("11")
 354     libDir = j11libDir
 355     libDistDir = j11libDir
 356     compile_source_compatibility = 11
 357     compile_target_compatibility = 11
 358     getdownAltJavaMinVersion = string(findProperty("getdown_alt_java11_min_version"))
 359     getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java11_max_version"))
 360     getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java11_txt_multi_java_location"))
 361     eclipseJavaRuntimeName = string("JavaSE-11")
 362     /* compile without modules -- using classpath libraries
 363     additional_compiler_args += [
 364     '--module-path', modules_compileClasspath.asPath,
 365     '--add-modules', j11modules
 366     ]
 367      */
 368   } else if (JAVA_VERSION.equals("12") || JAVA_VERSION.equals("13")) {
 369     JAVA_INTEGER_VERSION = JAVA_VERSION
 370     libDir = j11libDir
 371     libDistDir = j11libDir
 372     compile_source_compatibility = JAVA_VERSION
 373     compile_target_compatibility = JAVA_VERSION
 374     getdownAltJavaMinVersion = string(findProperty("getdown_alt_java11_min_version"))
 375     getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java11_max_version"))
 376     getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java11_txt_multi_java_location"))
 377     eclipseJavaRuntimeName = string("JavaSE-11")
 378     /* compile without modules -- using classpath libraries
 379     additional_compiler_args += [
 380     '--module-path', modules_compileClasspath.asPath,
 381     '--add-modules', j11modules
 382     ]
 383      */
 384   } else {
 385     throw new GradleException("JAVA_VERSION=${JAVA_VERSION} not currently supported by Jalview")
 386   }
 387
 388
 389   // for install4j
 390   JAVA_MIN_VERSION = JAVA_VERSION
 391   JAVA_MAX_VERSION = JAVA_VERSION
 392   def jreInstallsDir = string(jre_installs_dir)
 393   if (jreInstallsDir.startsWith("~/")) {
 394     jreInstallsDir = System.getProperty("user.home") + jreInstallsDir.substring(1)
 395   }
 396   macosJavaVMDir = string("${jreInstallsDir}/jre-${JAVA_INTEGER_VERSION}-mac-x64/jre")
 397   macosJavaVMTgz = string("${jreInstallsDir}/tgz/jre-${JAVA_INTEGER_VERSION}-mac-x64.tar.gz")
 398   windowsJavaVMDir = string("${jreInstallsDir}/jre-${JAVA_INTEGER_VERSION}-windows-x64/jre")
 399   windowsJavaVMTgz = string("${jreInstallsDir}/tgz/jre-${JAVA_INTEGER_VERSION}-windows-x64.tar.gz")
 400   linuxJavaVMDir = string("${jreInstallsDir}/jre-${JAVA_INTEGER_VERSION}-linux-x64/jre")
 401   linuxJavaVMTgz = string("${jreInstallsDir}/tgz/jre-${JAVA_INTEGER_VERSION}-linux-x64.tar.gz")
 402   install4jDir = string("${jalviewDir}/${install4j_utils_dir}")
 403   install4jConfFileName = string("jalview-install4j-conf.install4j")
 404   install4jConfFile = file("${install4jDir}/${install4jConfFileName}")
 405   install4jHomeDir = install4j_home_dir
 406   if (install4jHomeDir.startsWith("~/")) {
 407     install4jHomeDir = System.getProperty("user.home") + install4jHomeDir.substring(1)
 408   }
 409
 410
 411
 412   buildingHTML = string("${jalviewDir}/${docDir}/building.html")
 413   helpFile = string("${classesDir}/${help_dir}/help.jhm")
 414   helpParentDir = string("${jalviewDir}/${help_parent_dir}")
 415   helpSourceDir = string("${helpParentDir}/${help_dir}")
 416
 417
 418   relativeBuildDir = file(jalviewDirAbsolutePath).toPath().relativize(buildDir.toPath())
 419   jalviewjsBuildDir = string("${relativeBuildDir}/jalviewjs")
 420   jalviewjsSiteDir = string("${jalviewjsBuildDir}/${jalviewjs_site_dir}")
 421   if (IN_ECLIPSE) {
 422     jalviewjsTransferSiteJsDir = string(jalviewjsSiteDir)
 423   } else {
 424     jalviewjsTransferSiteJsDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_js")
 425   }
 426   jalviewjsTransferSiteLibDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_lib")
 427   jalviewjsTransferSiteSwingJsDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_swingjs")
 428   jalviewjsTransferSiteCoreDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_core")
 429   jalviewjsJalviewCoreHtmlFile = string("")
 430   jalviewjsJalviewCoreName = string(jalviewjs_core_name)
 431   jalviewjsCoreClasslists = []
 432   jalviewjsJalviewTemplateName = string(jalviewjs_name)
 433   jalviewjsJ2sSettingsFileName = string("${jalviewDir}/${jalviewjs_j2s_settings}")
 434   jalviewjsJ2sProps = null
 435
 436   eclipseWorkspace = null
 437   eclipseBinary = string("")
 438   eclipseVersion = string("")
 439   eclipseDebug = false
 440   // ENDEXT
 441 }
 442
 443
 444 sourceSets {
 445   main {
 446     java {
 447       srcDirs sourceDir
 448       outputDir = file(classesDir)
 449     }
 450
 451     resources {
 452       srcDirs resourceDir
 453       srcDirs += helpParentDir
 454     }
 455
 456     jar.destinationDir = file("${jalviewDir}/${packageDir}")
 457
 458     compileClasspath = files(sourceSets.main.java.outputDir)
 459     //compileClasspath += files(sourceSets.main.resources.srcDirs)
 460     compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
 461
 462     runtimeClasspath = compileClasspath
 463   }
 464
 465   clover {
 466     java {
 467       srcDirs = [ cloverInstrDir ]
 468       outputDir = file("${buildDir}/${cloverClassesDir}")
 469     }
 470
 471     resources {
 472       srcDirs = sourceSets.main.resources.srcDirs
 473     }
 474     compileClasspath = configurations.cloverRuntime + files( sourceSets.clover.java.outputDir )
 475     compileClasspath += files(sourceSets.main.java.outputDir)
 476     compileClasspath += sourceSets.main.compileClasspath
 477     compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}", include: ["**/*.jar"])
 478     compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
 479
 480     runtimeClasspath = compileClasspath
 481   }
 482
 483   test {
 484     java {
 485       srcDirs testSourceDir
 486       outputDir = file("${jalviewDir}/${testOutputDir}")
 487     }
 488
 489     resources {
 490       srcDirs = sourceSets.main.resources.srcDirs
 491     }
 492
 493     compileClasspath = files( sourceSets.test.java.outputDir )
 494
 495     if (use_clover) {
 496       compileClasspath = sourceSets.clover.compileClasspath
 497     } else {
 498       compileClasspath += files(sourceSets.main.java.outputDir)
 499     }
 500
 501     compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
 502     compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}/testnglibs", include: ["**/*.jar"])
 503     compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}/testlibs", include: ["**/*.jar"])
 504
 505     runtimeClasspath = compileClasspath
 506   }
 507 }
 508
 509
 510 // clover bits
 511 dependencies {
 512   if (use_clover) {
 513     cloverCompile 'org.openclover:clover:4.4.1'
 514     testCompile 'org.openclover:clover:4.4.1'
 515   }
 516 }
 517
 518 configurations {
 519   cloverRuntime
 520   cloverRuntime.extendsFrom cloverCompile
 521 }
 522
 523
 524 // eclipse project and settings files creation, also used by buildship
 525 eclipse {
 526   project {
 527     name = eclipse_project_name
 528
 529     natures 'org.eclipse.jdt.core.javanature',
 530     'org.eclipse.jdt.groovy.core.groovyNature',
 531     'org.eclipse.buildship.core.gradleprojectnature'
 532
 533     buildCommand 'org.eclipse.jdt.core.javabuilder'
 534     buildCommand 'org.eclipse.buildship.core.gradleprojectbuilder'
 535   }
 536
 537   classpath {
 538     //defaultOutputDir = sourceSets.main.java.outputDir
 539     def removeThese = []
 540     configurations.each{
 541       if (it.isCanBeResolved()) {
 542         removeThese += it
 543       }
 544     }
 545
 546     minusConfigurations += removeThese
 547     plusConfigurations = [ ]
 548     file {
 549
 550       whenMerged { cp ->
 551         def removeTheseToo = []
 552         HashMap<String, Boolean> alreadyAddedSrcPath = new HashMap<>();
 553         cp.entries.each { entry ->
 554           // This conditional removes all src classpathentries that a) have already been added or b) aren't "src" or "test".
 555           // e.g. this removes the resources dir being copied into bin/main, bin/test AND bin/clover
 556           // we add the resources and help/help dirs in as libs afterwards (see below)
 557           if (entry.kind == 'src') {
 558             if (alreadyAddedSrcPath.getAt(entry.path) || !(entry.path == bareSourceDir || entry.path == bareTestSourceDir)) {
 559               removeTheseToo += entry
 560             } else {
 561               alreadyAddedSrcPath.putAt(entry.path, true)
 562             }
 563           }
 564
 565         }
 566         cp.entries.removeAll(removeTheseToo)
 567
 568         //cp.entries += new Output("${eclipse_bin_dir}/main")
 569         if (file(helpParentDir).isDirectory()) {
 570           cp.entries += new Library(fileReference(helpParentDir))
 571         }
 572         if (file(resourceDir).isDirectory()) {
 573           cp.entries += new Library(fileReference(resourceDir))
 574         }
 575
 576         HashMap<String, Boolean> alreadyAddedLibPath = new HashMap<>();
 577
 578         sourceSets.main.compileClasspath.findAll { it.name.endsWith(".jar") }.any {
 579           //don't want to add outputDir as eclipse is using its own output dir in bin/main
 580           if (it.isDirectory() || ! it.exists()) {
 581             // don't add dirs to classpath, especially if they don't exist
 582             return false // groovy "continue" in .any closure
 583           }
 584           def itPath = it.toString()
 585           if (itPath.startsWith("${jalviewDirAbsolutePath}/")) {
 586             // make relative path
 587             itPath = itPath.substring(jalviewDirAbsolutePath.length()+1)
 588           }
 589           if (alreadyAddedLibPath.get(itPath)) {
 590             //println("Not adding duplicate entry "+itPath)
 591           } else {
 592             //println("Adding entry "+itPath)
 593             cp.entries += new Library(fileReference(itPath))
 594             alreadyAddedLibPath.put(itPath, true)
 595           }
 596         }
 597
 598         sourceSets.test.compileClasspath.findAll { it.name.endsWith(".jar") }.any {
 599           //no longer want to add outputDir as eclipse is using its own output dir in bin/main
 600           if (it.isDirectory() || ! it.exists()) {
 601             // don't add dirs to classpath
 602             return false // groovy "continue" in .any closure
 603           }
 604
 605           def itPath = it.toString()
 606           if (itPath.startsWith("${jalviewDirAbsolutePath}/")) {
 607             itPath = itPath.substring(jalviewDirAbsolutePath.length()+1)
 608           }
 609           if (alreadyAddedLibPath.get(itPath)) {
 610             // don't duplicate
 611           } else {
 612             def lib = new Library(fileReference(itPath))
 613             lib.entryAttributes["test"] = "true"
 614             cp.entries += lib
 615             alreadyAddedLibPath.put(itPath, true)
 616           }
 617         }
 618
 619       } // whenMerged
 620
 621     } // file
 622
 623     containers 'org.eclipse.buildship.core.gradleclasspathcontainer'
 624
 625   } // classpath
 626
 627   jdt {
 628     // for the IDE, use java 11 compatibility
 629     sourceCompatibility = compile_source_compatibility
 630     targetCompatibility = compile_target_compatibility
 631     javaRuntimeName = eclipseJavaRuntimeName
 632
 633     // add in jalview project specific properties/preferences into eclipse core preferences
 634     file {
 635       withProperties { props ->
 636         def jalview_prefs = new Properties()
 637         def ins = new FileInputStream("${jalviewDirAbsolutePath}/${eclipse_extra_jdt_prefs_file}")
 638         jalview_prefs.load(ins)
 639         ins.close()
 640         jalview_prefs.forEach { t, v ->
 641           if (props.getAt(t) == null) {
 642             props.putAt(t, v)
 643           }
 644         }
 645       }
 646     }
 647
 648   } // jdt
 649
 650   if (IN_ECLIPSE) {
 651     // Don't want these to be activated if in headless build
 652     synchronizationTasks "eclipseSynchronizationTask"
 653     autoBuildTasks "eclipseAutoBuildTask"
 654
 655   }
 656 }
 657
 658
 659 task cloverInstr {
 660   // only instrument source, we build test classes as normal
 661   inputs.files files (sourceSets.main.allJava,sourceSets.test.allJava) // , fileTree(dir:"$jalviewDir/$testSourceDir", include: ["**/*.java"]))
 662   outputs.dir cloverInstrDir
 663
 664   doFirst {
 665     delete cloverInstrDir
 666     def argsList = [
 667       "--initstring",
 668       cloverDb,
 669       "-d",
 670       cloverInstrDir.getPath(),
 671     ]
 672     argsList.addAll(
 673       inputs.files.files.collect(
 674         { file -> file.absolutePath }
 675       )
 676     )
 677     String[] args = argsList.toArray()
 678     println("About to instrument "+args.length +" files")
 679     com.atlassian.clover.CloverInstr.mainImpl(args)
 680   }
 681 }
 682
 683
 684 cloverClasses.dependsOn cloverInstr
 685
 686
 687 task cloverReport {
 688   group = "Verification"
 689   description = "Creates the Clover report"
 690   inputs.dir "${buildDir}/clover"
 691   outputs.dir "${reportsDir}/clover"
 692   onlyIf {
 693     file(cloverDb).exists()
 694   }
 695   doFirst {
 696     def argsList = [
 697       "--initstring",
 698       cloverDb,
 699       "-o",
 700       "${reportsDir}/clover"
 701     ]
 702     String[] args = argsList.toArray()
 703     com.atlassian.clover.reporters.html.HtmlReporter.runReport(args)
 704
 705     // and generate ${reportsDir}/clover/clover.xml
 706     args = [
 707       "--initstring",
 708       cloverDb,
 709       "-o",
 710       "${reportsDir}/clover/clover.xml"
 711     ].toArray()
 712     com.atlassian.clover.reporters.xml.XMLReporter.runReport(args)
 713   }
 714 }
 715
 716
 717 compileCloverJava {
 718
 719   doFirst {
 720     sourceCompatibility = compile_source_compatibility
 721     targetCompatibility = compile_target_compatibility
 722     options.compilerArgs += additional_compiler_args
 723     print ("Setting target compatibility to "+targetCompatibility+"\n")
 724   }
 725   classpath += configurations.cloverRuntime
 726 }
 727
 728
 729 task cleanClover {
 730   doFirst {
 731     delete cloverInstrDir
 732     delete cloverDb
 733   }
 734 }
 735 // end clover bits
 736
 737
 738 compileJava {
 739
 740   doFirst {
 741     sourceCompatibility = compile_source_compatibility
 742     targetCompatibility = compile_target_compatibility
 743     options.compilerArgs = additional_compiler_args
 744     print ("Setting target compatibility to "+targetCompatibility+"\n")
 745   }
 746
 747 }
 748
 749
 750 compileTestJava {
 751   if (use_clover) {
 752     dependsOn compileCloverJava
 753     classpath += configurations.cloverRuntime
 754   } else {
 755     classpath += sourceSets.main.runtimeClasspath
 756   }
 757   doFirst {
 758     sourceCompatibility = compile_source_compatibility
 759     targetCompatibility = compile_target_compatibility
 760     options.compilerArgs = additional_compiler_args
 761     print ("Setting target compatibility to "+targetCompatibility+"\n")
 762   }
 763 }
 764
 765
 766 clean {
 767   doFirst {
 768     delete sourceSets.main.java.outputDir
 769   }
 770 }
 771
 772
 773 cleanTest {
 774   dependsOn cleanClover
 775   doFirst {
 776     delete sourceSets.test.java.outputDir
 777   }
 778 }
 779
 780
 781 // format is a string like date.format("dd MMMM yyyy")
 782 def getDate(format) {
 783   def date = new Date()
 784   return date.format(format)
 785 }
 786
 787
 788 task setGitVals {
 789   def hashStdOut = new ByteArrayOutputStream()
 790   exec {
 791     commandLine "git", "rev-parse", "--short", "HEAD"
 792     standardOutput = hashStdOut
 793     ignoreExitValue true
 794   }
 795
 796   def branchStdOut = new ByteArrayOutputStream()
 797   exec {
 798     commandLine "git", "rev-parse", "--abbrev-ref", "HEAD"
 799     standardOutput = branchStdOut
 800     ignoreExitValue true
 801   }
 802
 803   gitHash = hashStdOut.toString().trim()
 804   gitBranch = branchStdOut.toString().trim()
 805
 806   outputs.upToDateWhen { false }
 807 }
 808
 809
 810 task createBuildProperties(type: WriteProperties) {
 811   dependsOn setGitVals
 812   inputs.dir(sourceDir)
 813   inputs.dir(resourceDir)
 814   file(buildProperties).getParentFile().mkdirs()
 815   outputFile (buildProperties)
 816   // taking time specific comment out to allow better incremental builds
 817   comment "--Jalview Build Details--\n"+getDate("yyyy-MM-dd HH:mm:ss")
 818   //comment "--Jalview Build Details--\n"+getDate("yyyy-MM-dd")
 819   property "BUILD_DATE", getDate("HH:mm:ss dd MMMM yyyy")
 820   property "VERSION", JALVIEW_VERSION
 821   property "INSTALLATION", INSTALLATION+" git-commit:"+gitHash+" ["+gitBranch+"]"
 822   outputs.file(outputFile)
 823 }
 824
 825
 826 task cleanBuildingHTML(type: Delete) {
 827   doFirst {
 828     delete buildingHTML
 829   }
 830 }
 831
 832
 833 task convertBuildingMD(type: Exec) {
 834   dependsOn cleanBuildingHTML
 835   def buildingMD = "${jalviewDir}/${docDir}/building.md"
 836   def css = "${jalviewDir}/${docDir}/github.css"
 837
 838   def pandoc = null
 839   pandoc_exec.split(",").each {
 840     if (file(it.trim()).exists()) {
 841       pandoc = it.trim()
 842       return true
 843     }
 844   }
 845
 846   def hostname = "hostname".execute().text.trim()
 847   def buildtoolsPandoc = System.getProperty("user.home")+"/buildtools/pandoc/bin/pandoc"
 848   if ((pandoc == null || ! file(pandoc).exists()) && file(buildtoolsPandoc).exists()) {
 849     pandoc = System.getProperty("user.home")+"/buildtools/pandoc/bin/pandoc"
 850   }
 851
 852   doFirst {
 853     if (pandoc != null && file(pandoc).exists()) {
 854         commandLine pandoc, '-s', '-o', buildingHTML, '--metadata', 'pagetitle="Building Jalview from Source"', '--toc', '-H', css, buildingMD
 855     } else {
 856         println("Cannot find pandoc. Skipping convert building.md to HTML")
 857         throw new StopExecutionException("Cannot find pandoc. Skipping convert building.md to HTML")
 858     }
 859   }
 860
 861   ignoreExitValue true
 862
 863   inputs.file(buildingMD)
 864   inputs.file(css)
 865   outputs.file(buildingHTML)
 866 }
 867
 868
 869 clean {
 870   doFirst {
 871     delete buildingHTML
 872   }
 873 }
 874
 875
 876 task syncDocs(type: Sync) {
 877   dependsOn convertBuildingMD
 878   def syncDir = "${classesDir}/${docDir}"
 879   from fileTree("${jalviewDir}/${docDir}")
 880   into syncDir
 881
 882 }
 883
 884
 885 task copyHelp(type: Copy) {
 886   def inputDir = helpSourceDir
 887   def outputDir = "${classesDir}/${help_dir}"
 888   from(inputDir) {
 889     exclude '**/*.gif'
 890     exclude '**/*.jpg'
 891     exclude '**/*.png'
 892     filter(ReplaceTokens,
 893       beginToken: '$$',
 894       endToken: '$$',
 895       tokens: [
 896         'Version-Rel': JALVIEW_VERSION,
 897         'Year-Rel': getDate("yyyy")
 898       ]
 899     )
 900   }
 901   from(inputDir) {
 902     include '**/*.gif'
 903     include '**/*.jpg'
 904     include '**/*.png'
 905   }
 906   into outputDir
 907
 908   inputs.dir(inputDir)
 909   outputs.files(helpFile)
 910   outputs.dir(outputDir)
 911 }
 912
 913
 914 task syncLib(type: Sync) {
 915   def syncDir = "${classesDir}/${libDistDir}"
 916   from fileTree("${jalviewDir}/${libDistDir}")
 917   into syncDir
 918 }
 919
 920
 921 task syncResources(type: Sync) {
 922   from resourceDir
 923   include "**/*.*"
 924   into "${classesDir}"
 925   preserve {
 926     include "**"
 927   }
 928 }
 929
 930
 931 task prepare {
 932   dependsOn syncResources
 933   dependsOn syncDocs
 934   dependsOn copyHelp
 935 }
 936
 937
 938 //testReportDirName = "test-reports" // note that test workingDir will be $jalviewDir
 939 test {
 940   dependsOn prepare
 941   dependsOn compileJava
 942   if (use_clover) {
 943     dependsOn cloverInstr
 944   }
 945
 946   if (use_clover) {
 947     print("Running tests " + (use_clover?"WITH":"WITHOUT") + " clover [clover="+use_clover+"]\n")
 948   }
 949
 950   useTestNG() {
 951     includeGroups testngGroups
 952     excludeGroups testngExcludedGroups
 953     preserveOrder true
 954     useDefaultListeners=true
 955   }
 956
 957   maxHeapSize = "1024m"
 958
 959   workingDir = jalviewDir
 960   //systemProperties 'clover.jar' System.properties.clover.jar
 961   sourceCompatibility = compile_source_compatibility
 962   targetCompatibility = compile_target_compatibility
 963   jvmArgs += additional_compiler_args
 964
 965 }
 966
 967
 968 task buildIndices(type: JavaExec) {
 969   dependsOn copyHelp
 970   classpath = sourceSets.main.compileClasspath
 971   main = "com.sun.java.help.search.Indexer"
 972   workingDir = "${classesDir}/${help_dir}"
 973   def argDir = "html"
 974   args = [ argDir ]
 975   inputs.dir("${workingDir}/${argDir}")
 976
 977   outputs.dir("${classesDir}/doc")
 978   outputs.dir("${classesDir}/help")
 979   outputs.file("${workingDir}/JavaHelpSearch/DOCS")
 980   outputs.file("${workingDir}/JavaHelpSearch/DOCS.TAB")
 981   outputs.file("${workingDir}/JavaHelpSearch/OFFSETS")
 982   outputs.file("${workingDir}/JavaHelpSearch/POSITIONS")
 983   outputs.file("${workingDir}/JavaHelpSearch/SCHEMA")
 984   outputs.file("${workingDir}/JavaHelpSearch/TMAP")
 985 }
 986
 987
 988 task compileLinkCheck(type: JavaCompile) {
 989   options.fork = true
 990   classpath = files("${jalviewDir}/${utilsDir}")
 991   destinationDir = file("${jalviewDir}/${utilsDir}")
 992   source = fileTree(dir: "${jalviewDir}/${utilsDir}", include: ["HelpLinksChecker.java", "BufferedLineReader.java"])
 993
 994   inputs.file("${jalviewDir}/${utilsDir}/HelpLinksChecker.java")
 995   inputs.file("${jalviewDir}/${utilsDir}/HelpLinksChecker.java")
 996   outputs.file("${jalviewDir}/${utilsDir}/HelpLinksChecker.class")
 997   outputs.file("${jalviewDir}/${utilsDir}/BufferedLineReader.class")
 998 }
 999
1000
1001 task linkCheck(type: JavaExec) {
1002   dependsOn prepare, compileLinkCheck
1003
1004   def helpLinksCheckerOutFile = file("${jalviewDir}/${utilsDir}/HelpLinksChecker.out")
1005   classpath = files("${jalviewDir}/${utilsDir}")
1006   main = "HelpLinksChecker"
1007   workingDir = jalviewDir
1008   args = [ "${classesDir}/${help_dir}", "-nointernet" ]
1009
1010   def outFOS = new FileOutputStream(helpLinksCheckerOutFile, false) // false == don't append
1011   def errFOS = outFOS
1012   standardOutput = new org.apache.tools.ant.util.TeeOutputStream(
1013     outFOS,
1014     standardOutput)
1015   errorOutput = new org.apache.tools.ant.util.TeeOutputStream(
1016     outFOS,
1017     errorOutput)
1018
1019   inputs.dir("${classesDir}/${help_dir}")
1020   outputs.file(helpLinksCheckerOutFile)
1021 }
1022
1023 // import the pubhtmlhelp target
1024 ant.properties.basedir = "${jalviewDir}"
1025 ant.properties.helpBuildDir = "${jalviewDirAbsolutePath}/${classes_dir}/${help_dir}"
1026 ant.importBuild "${utilsDir}/publishHelp.xml"
1027
1028
1029 task cleanPackageDir(type: Delete) {
1030   doFirst {
1031     delete fileTree(dir: "${jalviewDir}/${packageDir}", include: "*.jar")
1032   }
1033 }
1034
1035 jar {
1036   dependsOn linkCheck
1037   dependsOn buildIndices
1038   dependsOn createBuildProperties
1039
1040   manifest {
1041     attributes "Main-Class": mainClass,
1042     "Permissions": "all-permissions",
1043     "Application-Name": "Jalview Desktop",
1044     "Codebase": application_codebase
1045   }
1046
1047   destinationDir = file("${jalviewDir}/${packageDir}")
1048   archiveName = rootProject.name+".jar"
1049
1050   exclude "cache*/**"
1051   exclude "*.jar"
1052   exclude "*.jar.*"
1053   exclude "**/*.jar"
1054   exclude "**/*.jar.*"
1055
1056   inputs.dir(classesDir)
1057   outputs.file("${jalviewDir}/${packageDir}/${archiveName}")
1058 }
1059
1060
1061 task copyJars(type: Copy) {
1062   from fileTree(dir: classesDir, include: "**/*.jar").files
1063   into "${jalviewDir}/${packageDir}"
1064 }
1065
1066
1067 // doing a Sync instead of Copy as Copy doesn't deal with "outputs" very well
1068 task syncJars(type: Sync) {
1069   from fileTree(dir: "${jalviewDir}/${libDistDir}", include: "**/*.jar").files
1070   into "${jalviewDir}/${packageDir}"
1071   preserve {
1072     include jar.archiveName
1073   }
1074 }
1075
1076
1077 task makeDist {
1078   group = "build"
1079   description = "Put all required libraries in dist"
1080   // order of "cleanPackageDir", "copyJars", "jar" important!
1081   jar.mustRunAfter cleanPackageDir
1082   syncJars.mustRunAfter cleanPackageDir
1083   dependsOn cleanPackageDir
1084   dependsOn syncJars
1085   dependsOn jar
1086   outputs.dir("${jalviewDir}/${packageDir}")
1087 }
1088
1089
1090 task cleanDist {
1091   dependsOn cleanPackageDir
1092   dependsOn cleanTest
1093   dependsOn clean
1094 }
1095
1096 shadowJar {
1097   group = "distribution"
1098   if (buildDist) {
1099     dependsOn makeDist
1100   }
1101   from ("${jalviewDir}/${libDistDir}") {
1102     include("*.jar")
1103   }
1104   manifest {
1105     attributes 'Implementation-Version': JALVIEW_VERSION
1106   }
1107   mainClassName = shadowJarMainClass
1108   mergeServiceFiles()
1109   classifier = "all-"+JALVIEW_VERSION+"-j"+JAVA_VERSION
1110   minimize()
1111 }
1112
1113
1114 task getdownWebsite() {
1115   group = "distribution"
1116   description = "Create the getdown minimal app folder, and website folder for this version of jalview. Website folder also used for offline app installer"
1117   if (buildDist) {
1118     dependsOn makeDist
1119   }
1120
1121   def getdownWebsiteResourceFilenames = []
1122   def getdownTextString = ""
1123   def getdownResourceDir = getdownResourceDir
1124   def getdownResourceFilenames = []
1125
1126   doFirst {
1127     // clean the getdown website and files dir before creating getdown folders
1128     delete getdownWebsiteDir
1129     delete getdownFilesDir
1130
1131     copy {
1132       from buildProperties
1133       rename(build_properties_file, getdown_build_properties)
1134       into getdownAppDir
1135     }
1136     getdownWebsiteResourceFilenames += "${getdownAppDistDir}/${getdown_build_properties}"
1137
1138     // set some getdown_txt_ properties then go through all properties looking for getdown_txt_...
1139     def props = project.properties.sort { it.key }
1140     if (getdownAltJavaMinVersion != null && getdownAltJavaMinVersion.length() > 0) {
1141       props.put("getdown_txt_java_min_version", getdownAltJavaMinVersion)
1142     }
1143     if (getdownAltJavaMaxVersion != null && getdownAltJavaMaxVersion.length() > 0) {
1144       props.put("getdown_txt_java_max_version", getdownAltJavaMaxVersion)
1145     }
1146     if (getdownAltMultiJavaLocation != null && getdownAltMultiJavaLocation.length() > 0) {
1147       props.put("getdown_txt_multi_java_location", getdownAltMultiJavaLocation)
1148     }
1149
1150     props.put("getdown_txt_title", jalview_name)
1151     props.put("getdown_txt_ui.name", install4jApplicationName)
1152
1153     // start with appbase
1154     getdownTextString += "appbase = ${getdownAppBase}\n"
1155     props.each{ prop, val ->
1156       if (prop.startsWith("getdown_txt_") && val != null) {
1157         if (prop.startsWith("getdown_txt_multi_")) {
1158           def key = prop.substring(18)
1159           val.split(",").each{ v ->
1160             def line = "${key} = ${v}\n"
1161             getdownTextString += line
1162           }
1163         } else {
1164           // file values rationalised
1165           if (val.indexOf('/') > -1 || prop.startsWith("getdown_txt_resource")) {
1166             def r = null
1167             if (val.indexOf('/') == 0) {
1168               // absolute path
1169               r = file(val)
1170             } else if (val.indexOf('/') > 0) {
1171               // relative path (relative to jalviewDir)
1172               r = file( "${jalviewDir}/${val}" )
1173             }
1174             if (r.exists()) {
1175               val = "${getdown_resource_dir}/" + r.getName()
1176               getdownWebsiteResourceFilenames += val
1177               getdownResourceFilenames += r.getPath()
1178             }
1179           }
1180           if (! prop.startsWith("getdown_txt_resource")) {
1181             def line = prop.substring(12) + " = ${val}\n"
1182             getdownTextString += line
1183           }
1184         }
1185       }
1186     }
1187
1188     getdownWebsiteResourceFilenames.each{ filename ->
1189       getdownTextString += "resource = ${filename}\n"
1190     }
1191     getdownResourceFilenames.each{ filename ->
1192       copy {
1193         from filename
1194         into getdownResourceDir
1195       }
1196     }
1197
1198     def codeFiles = []
1199     fileTree(file(packageDir)).each{ f ->
1200       if (f.isDirectory()) {
1201         def files = fileTree(dir: f, include: ["*"]).getFiles()
1202         codeFiles += files
1203       } else if (f.exists()) {
1204         codeFiles += f
1205       }
1206     }
1207     codeFiles.sort().each{f ->
1208       def name = f.getName()
1209       def line = "code = ${getdownAppDistDir}/${name}\n"
1210       getdownTextString += line
1211       copy {
1212         from f.getPath()
1213         into getdownAppDir
1214       }
1215     }
1216
1217     // NOT USING MODULES YET, EVERYTHING SHOULD BE IN dist
1218     /*
1219     if (JAVA_VERSION.equals("11")) {
1220     def j11libFiles = fileTree(dir: "${jalviewDir}/${j11libDir}", include: ["*.jar"]).getFiles()
1221     j11libFiles.sort().each{f ->
1222     def name = f.getName()
1223     def line = "code = ${getdown_j11lib_dir}/${name}\n"
1224     getdownTextString += line
1225     copy {
1226     from f.getPath()
1227     into getdownJ11libDir
1228     }
1229     }
1230     }
1231      */
1232
1233     // 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.
1234     //getdownTextString += "class = " + file(getdownLauncher).getName() + "\n"
1235     getdownTextString += "resource = ${getdown_launcher_new}\n"
1236     getdownTextString += "class = ${mainClass}\n"
1237
1238     def getdown_txt = file("${getdownWebsiteDir}/getdown.txt")
1239     getdown_txt.write(getdownTextString)
1240
1241     def getdownLaunchJvl = getdown_launch_jvl_name + ( (jvlChannelName != null && jvlChannelName.length() > 0)?"-${jvlChannelName}":"" ) + ".jvl"
1242     def launchJvl = file("${getdownWebsiteDir}/${getdownLaunchJvl}")
1243     launchJvl.write("appbase=${getdownAppBase}")
1244
1245     copy {
1246       from getdownLauncher
1247       rename(file(getdownLauncher).getName(), getdown_launcher_new)
1248       into getdownWebsiteDir
1249     }
1250
1251     copy {
1252       from getdownLauncher
1253       if (file(getdownLauncher).getName() != getdown_launcher) {
1254         rename(file(getdownLauncher).getName(), getdown_launcher)
1255       }
1256       into getdownWebsiteDir
1257     }
1258
1259     if (! (CHANNEL.startsWith("ARCHIVE") || CHANNEL.startsWith("DEVELOP"))) {
1260       copy {
1261         from getdown_txt
1262         from getdownLauncher
1263         from "${getdownWebsiteDir}/${getdown_build_properties}"
1264         if (file(getdownLauncher).getName() != getdown_launcher) {
1265           rename(file(getdownLauncher).getName(), getdown_launcher)
1266         }
1267         into getdownInstallDir
1268       }
1269
1270       copy {
1271         from getdownInstallDir
1272         into getdownFilesInstallDir
1273       }
1274     }
1275
1276     copy {
1277       from getdown_txt
1278       from launchJvl
1279       from getdownLauncher
1280       from "${getdownWebsiteDir}/${getdown_build_properties}"
1281       if (file(getdownLauncher).getName() != getdown_launcher) {
1282         rename(file(getdownLauncher).getName(), getdown_launcher)
1283       }
1284       into getdownFilesDir
1285     }
1286
1287     copy {
1288       from getdownResourceDir
1289       into "${getdownFilesDir}/${getdown_resource_dir}"
1290     }
1291   }
1292
1293   if (buildDist) {
1294     inputs.dir("${jalviewDir}/${packageDir}")
1295   }
1296   outputs.dir(getdownWebsiteDir)
1297   outputs.dir(getdownFilesDir)
1298 }
1299
1300
1301 // a helper task to allow getdown digest of any dir: `gradle getdownDigestDir -PDIGESTDIR=/path/to/my/random/getdown/dir
1302 task getdownDigestDir(type: JavaExec) {
1303   group "Help"
1304   description "A task to run a getdown Digest on a dir with getdown.txt. Provide a DIGESTDIR property via -PDIGESTDIR=..."
1305
1306   def digestDirPropertyName = "DIGESTDIR"
1307   doFirst {
1308     classpath = files(getdownLauncher)
1309     def digestDir = findProperty(digestDirPropertyName)
1310     if (digestDir == null) {
1311       throw new GradleException("Must provide a DIGESTDIR value to produce an alternative getdown digest")
1312     }
1313     args digestDir
1314   }
1315   main = "com.threerings.getdown.tools.Digester"
1316 }
1317
1318
1319 task getdownDigest(type: JavaExec) {
1320   group = "distribution"
1321   description = "Digest the getdown website folder"
1322   dependsOn getdownWebsite
1323   doFirst {
1324     classpath = files(getdownLauncher)
1325   }
1326   main = "com.threerings.getdown.tools.Digester"
1327   args getdownWebsiteDir
1328   inputs.dir(getdownWebsiteDir)
1329   outputs.file("${getdownWebsiteDir}/digest2.txt")
1330 }
1331
1332
1333 task getdown() {
1334   group = "distribution"
1335   description = "Create the minimal and full getdown app folder for installers and website and create digest file"
1336   dependsOn getdownDigest
1337   doLast {
1338     if (reportRsyncCommand) {
1339       def fromDir = getdownWebsiteDir + (getdownWebsiteDir.endsWith('/')?'':'/')
1340       def toDir = "${getdown_rsync_dest}/${getdownDir}" + (getdownDir.endsWith('/')?'':'/')
1341       println "LIKELY RSYNC COMMAND:"
1342       println "mkdir -p '$toDir'\nrsync -avh --delete '$fromDir' '$toDir'"
1343       if (RUNRSYNC == "true") {
1344         exec {
1345           commandLine "mkdir", "-p", toDir
1346         }
1347         exec {
1348           commandLine "rsync", "-avh", "--delete", fromDir, toDir
1349         }
1350       }
1351     }
1352   }
1353 }
1354
1355
1356 clean {
1357   doFirst {
1358     delete getdownWebsiteDir
1359     delete getdownFilesDir
1360   }
1361 }
1362
1363
1364 install4j {
1365   if (file(install4jHomeDir).exists()) {
1366     // good to go!
1367   } else if (file(System.getProperty("user.home")+"/buildtools/install4j").exists()) {
1368     install4jHomeDir = System.getProperty("user.home")+"/buildtools/install4j"
1369   } else if (file("/Applications/install4j.app/Contents/Resources/app").exists()) {
1370     install4jHomeDir = "/Applications/install4j.app/Contents/Resources/app"
1371   }
1372   installDir(file(install4jHomeDir))
1373
1374   mediaTypes = Arrays.asList(install4j_media_types.split(","))
1375 }
1376
1377
1378 task copyInstall4jTemplate {
1379   def install4jTemplateFile = file("${install4jDir}/${install4j_template}")
1380   def install4jFileAssociationsFile = file("${install4jDir}/${install4j_installer_file_associations}")
1381   inputs.file(install4jTemplateFile)
1382   inputs.file(install4jFileAssociationsFile)
1383   inputs.property("CHANNEL", { CHANNEL })
1384   outputs.file(install4jConfFile)
1385
1386   doLast {
1387     def install4jConfigXml = new XmlParser().parse(install4jTemplateFile)
1388
1389     // turn off code signing if no OSX_KEYPASS
1390     if (OSX_KEYPASS == "") {
1391       install4jConfigXml.'**'.codeSigning.each { codeSigning ->
1392         codeSigning.'@macEnabled' = "false"
1393       }
1394       install4jConfigXml.'**'.windows.each { windows ->
1395         windows.'@runPostProcessor' = "false"
1396       }
1397     }
1398
1399     // turn off checksum creation for LOCAL channel
1400     def e = install4jConfigXml.application[0]
1401     if (CHANNEL == "LOCAL") {
1402       e.'@createChecksums' = "false"
1403     } else {
1404       e.'@createChecksums' = "true"
1405     }
1406
1407     // put file association actions where placeholder action is
1408     def install4jFileAssociationsText = install4jFileAssociationsFile.text
1409     def fileAssociationActions = new XmlParser().parseText("<actions>${install4jFileAssociationsText}</actions>")
1410     install4jConfigXml.'**'.action.any { a -> // .any{} stops after the first one that returns true
1411       if (a.'@name' == 'EXTENSIONS_REPLACED_BY_GRADLE') {
1412         def parent = a.parent()
1413         parent.remove(a)
1414         fileAssociationActions.each { faa ->
1415             parent.append(faa)
1416         }
1417         // don't need to continue in .any loop once replacements have been made
1418         return true
1419       }
1420     }
1421
1422     // use Windows Program Group with Examples folder for RELEASE, and Program Group without Examples for everything else
1423     // NB we're deleting the /other/ one!
1424     // Also remove the examples subdir from non-release versions
1425     def customizedIdToDelete = "PROGRAM_GROUP_RELEASE"
1426     // 2.11.1.0 NOT releasing with the Examples folder in the Program Group
1427     if (false && CHANNEL=="RELEASE") { // remove 'false && ' to include Examples folder in RELEASE channel
1428       customizedIdToDelete = "PROGRAM_GROUP_NON_RELEASE"
1429     } else {
1430       // remove the examples subdir from Full File Set
1431       def files = install4jConfigXml.files[0]
1432       def fileset = files.filesets.fileset.find { fs -> fs.'@customizedId' == "FULL_FILE_SET" }
1433       def root = files.roots.root.find { r -> r.'@fileset' == fileset.'@id' }
1434       def mountPoint = files.mountPoints.mountPoint.find { mp -> mp.'@root' == root.'@id' }
1435       def dirEntry = files.entries.dirEntry.find { de -> de.'@mountPoint' == mountPoint.'@id' && de.'@subDirectory' == "examples" }
1436       dirEntry.parent().remove(dirEntry)
1437     }
1438     install4jConfigXml.'**'.action.any { a ->
1439       if (a.'@customizedId' == customizedIdToDelete) {
1440         def parent = a.parent()
1441         parent.remove(a)
1442         return true
1443       }
1444     }
1445
1446     // remove the "Uninstall Old Jalview (optional)" symlink from DMG for non-release DS_Stores
1447     if (! (CHANNEL == "RELEASE" || CHANNEL == "TEST-RELEASE" ) ) {
1448       def symlink = install4jConfigXml.'**'.topLevelFiles.symlink.find { sl -> sl.'@name' == "Uninstall Old Jalview (optional).app" }
1449       symlink.parent().remove(symlink)
1450     }
1451
1452     // write install4j file
1453     install4jConfFile.text = XmlUtil.serialize(install4jConfigXml)
1454   }
1455 }
1456
1457
1458 clean {
1459   doFirst {
1460     delete install4jConfFile
1461   }
1462 }
1463
1464
1465 task installers(type: com.install4j.gradle.Install4jTask) {
1466   group = "distribution"
1467   description = "Create the install4j installers"
1468   dependsOn setGitVals
1469   dependsOn getdown
1470   dependsOn copyInstall4jTemplate
1471
1472   projectFile = install4jConfFile
1473
1474   // create an md5 for the input files to use as version for install4j conf file
1475   def digest = MessageDigest.getInstance("MD5")
1476   digest.update(
1477     (file("${install4jDir}/${install4j_template}").text +
1478     file("${install4jDir}/${install4j_info_plist_file_associations}").text +
1479     file("${install4jDir}/${install4j_installer_file_associations}").text).bytes)
1480   def filesMd5 = new BigInteger(1, digest.digest()).toString(16)
1481   if (filesMd5.length() >= 8) {
1482     filesMd5 = filesMd5.substring(0,8)
1483   }
1484   def install4jTemplateVersion = "${JALVIEW_VERSION}_F${filesMd5}_C${gitHash}"
1485   // make install4jBuildDir relative to jalviewDir
1486   def install4jBuildDir = "${install4j_build_dir}/${JAVA_VERSION}"
1487
1488   variables = [
1489     'JALVIEW_NAME': jalview_name,
1490     'JALVIEW_APPLICATION_NAME': install4jApplicationName,
1491     'JALVIEW_DIR': "../..",
1492     'OSX_KEYSTORE': OSX_KEYSTORE,
1493     'JSIGN_SH': JSIGN_SH,
1494     'JRE_DIR': getdown_app_dir_java,
1495     'INSTALLER_TEMPLATE_VERSION': install4jTemplateVersion,
1496     'JALVIEW_VERSION': JALVIEW_VERSION,
1497     'JAVA_MIN_VERSION': JAVA_MIN_VERSION,
1498     'JAVA_MAX_VERSION': JAVA_MAX_VERSION,
1499     'JAVA_VERSION': JAVA_VERSION,
1500     'JAVA_INTEGER_VERSION': JAVA_INTEGER_VERSION,
1501     'VERSION': JALVIEW_VERSION,
1502     'MACOS_JAVA_VM_DIR': macosJavaVMDir,
1503     'WINDOWS_JAVA_VM_DIR': windowsJavaVMDir,
1504     'LINUX_JAVA_VM_DIR': linuxJavaVMDir,
1505     'MACOS_JAVA_VM_TGZ': macosJavaVMTgz,
1506     'WINDOWS_JAVA_VM_TGZ': windowsJavaVMTgz,
1507     'LINUX_JAVA_VM_TGZ': linuxJavaVMTgz,
1508     'COPYRIGHT_MESSAGE': install4j_copyright_message,
1509     'BUNDLE_ID': install4jBundleId,
1510     'INTERNAL_ID': install4jInternalId,
1511     'WINDOWS_APPLICATION_ID': install4jWinApplicationId,
1512     'MACOS_DS_STORE': install4jDSStore,
1513     'MACOS_DMG_BG_IMAGE': install4jDMGBackgroundImage,
1514     'INSTALLER_NAME': install4jInstallerName,
1515     'INSTALL4J_UTILS_DIR': install4j_utils_dir,
1516     'GETDOWN_WEBSITE_DIR': getdown_website_dir,
1517     'GETDOWN_FILES_DIR': getdown_files_dir,
1518     'GETDOWN_RESOURCE_DIR': getdown_resource_dir,
1519     'GETDOWN_DIST_DIR': getdownAppDistDir,
1520     'GETDOWN_ALT_DIR': getdown_app_dir_alt,
1521     'GETDOWN_INSTALL_DIR': getdown_install_dir,
1522     'INFO_PLIST_FILE_ASSOCIATIONS_FILE': install4j_info_plist_file_associations,
1523     'BUILD_DIR': install4jBuildDir,
1524     'APPLICATION_CATEGORIES': install4j_application_categories,
1525     'APPLICATION_FOLDER': install4jApplicationFolder,
1526     'UNIX_APPLICATION_FOLDER': install4jUnixApplicationFolder,
1527     'EXECUTABLE_NAME': install4jExecutableName,
1528     'EXTRA_SCHEME': install4jExtraScheme,
1529   ]
1530
1531   //println("INSTALL4J VARIABLES:")
1532   //variables.each{k,v->println("${k}=${v}")}
1533
1534   destination = "${jalviewDir}/${install4jBuildDir}"
1535   buildSelected = true
1536
1537   if (install4j_faster.equals("true") || CHANNEL.startsWith("LOCAL")) {
1538     faster = true
1539     disableSigning = true
1540   }
1541
1542   if (OSX_KEYPASS) {
1543     macKeystorePassword = OSX_KEYPASS
1544   }
1545
1546   doFirst {
1547     println("Using projectFile "+projectFile)
1548   }
1549
1550   inputs.dir(getdownWebsiteDir)
1551   inputs.file(install4jConfFile)
1552   inputs.file("${install4jDir}/${install4j_info_plist_file_associations}")
1553   inputs.dir(macosJavaVMDir)
1554   inputs.dir(windowsJavaVMDir)
1555   outputs.dir("${jalviewDir}/${install4j_build_dir}/${JAVA_VERSION}")
1556 }
1557
1558
1559 task sourceDist(type: Tar) {
1560
1561   def VERSION_UNDERSCORES = JALVIEW_VERSION.replaceAll("\\.", "_")
1562   def outputFileName = "${project.name}_${VERSION_UNDERSCORES}.tar.gz"
1563   // cater for buildship < 3.1 [3.0.1 is max version in eclipse 2018-09]
1564   try {
1565     archiveFileName = outputFileName
1566   } catch (Exception e) {
1567     archiveName = outputFileName
1568   }
1569
1570   compression Compression.GZIP
1571
1572   into project.name
1573
1574   def EXCLUDE_FILES=[
1575     "build/*",
1576     "bin/*",
1577     "test-output/",
1578     "test-reports",
1579     "tests",
1580     "clover*/*",
1581     ".*",
1582     "benchmarking/*",
1583     "**/.*",
1584     "*.class",
1585     "**/*.class","$j11modDir/**/*.jar","appletlib","**/*locales",
1586     "*locales/**",
1587     "utils/InstallAnywhere",
1588     "**/*.log",
1589   ]
1590   def PROCESS_FILES=[
1591     "AUTHORS",
1592     "CITATION",
1593     "FEATURETODO",
1594     "JAVA-11-README",
1595     "FEATURETODO",
1596     "LICENSE",
1597     "**/README",
1598     "RELEASE",
1599     "THIRDPARTYLIBS",
1600     "TESTNG",
1601     "build.gradle",
1602     "gradle.properties",
1603     "**/*.java",
1604     "**/*.html",
1605     "**/*.xml",
1606     "**/*.gradle",
1607     "**/*.groovy",
1608     "**/*.properties",
1609     "**/*.perl",
1610     "**/*.sh",
1611   ]
1612   def INCLUDE_FILES=[
1613     ".settings/org.eclipse.jdt.core.jalview.prefs",
1614   ]
1615
1616   from(jalviewDir) {
1617     exclude (EXCLUDE_FILES)
1618     include (PROCESS_FILES)
1619     filter(ReplaceTokens,
1620       beginToken: '$$',
1621       endToken: '$$',
1622       tokens: [
1623         'Version-Rel': JALVIEW_VERSION,
1624         'Year-Rel': getDate("yyyy")
1625       ]
1626     )
1627   }
1628   from(jalviewDir) {
1629     exclude (EXCLUDE_FILES)
1630     exclude (PROCESS_FILES)
1631     exclude ("appletlib")
1632     exclude ("**/*locales")
1633     exclude ("*locales/**")
1634     exclude ("utils/InstallAnywhere")
1635
1636     exclude (getdown_files_dir)
1637     exclude (getdown_website_dir)
1638
1639     // exluding these as not using jars as modules yet
1640     exclude ("$j11modDir/**/*.jar")
1641   }
1642   from(jalviewDir) {
1643     include(INCLUDE_FILES)
1644   }
1645 //  from (jalviewDir) {
1646 //    // explicit includes for stuff that seemed to not get included
1647 //    include(fileTree("test/**/*."))
1648 //    exclude(EXCLUDE_FILES)
1649 //    exclude(PROCESS_FILES)
1650 //  }
1651 }
1652
1653
1654 task helppages {
1655   dependsOn copyHelp
1656   dependsOn pubhtmlhelp
1657
1658   inputs.dir("${classesDir}/${help_dir}")
1659   outputs.dir("${buildDir}/distributions/${help_dir}")
1660 }
1661
1662 // LARGE AMOUNT OF JALVIEWJS STUFF DELETED HERE
1663 task eclipseAutoBuildTask {}
1664 task eclipseSynchronizationTask {}