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
   6 import groovy.transform.ExternalizeMethods
   7
   8 buildscript {
   9   dependencies {
  10     classpath 'org.openclover:clover:4.3.1'
  11   }
  12 }
  13
  14 plugins {
  15   id 'java'
  16   id 'application'
  17   id 'eclipse'
  18   id 'com.github.johnrengelman.shadow' version '4.0.3'
  19   id 'com.install4j.gradle' version '7.0.9'
  20 }
  21
  22 // local build environment properties
  23 def localProps = "${jalviewDir}/local.properties"
  24 if (file(localProps).exists()) {
  25   def p = new Properties()
  26   def localPropsFIS = new FileInputStream(localProps)
  27   p.load(localPropsFIS)
  28   localPropsFIS.close()
  29   p.each {
  30     key, val ->
  31       def over = getProperty(key) != null
  32       setProperty(key, val)
  33       if (over) {
  34         println("Overriding property '${key}' with local.properties value '${val}'")
  35       }
  36   }
  37 }
  38
  39 repositories {
  40   jcenter()
  41   mavenCentral()
  42   mavenLocal()
  43   flatDir {
  44     dirs gradlePluginsDir
  45   }
  46 }
  47
  48 dependencies {
  49   compile 'org.apache.commons:commons-compress:1.18'
  50 }
  51
  52 mainClassName = launcherClass
  53 def cloverInstrDir = file("${buildDir}/${cloverSourcesInstrDir}")
  54 def classes = "${jalviewDir}/${classesDir}"
  55
  56 if (clover.equals("true")) {
  57   use_clover = true
  58   classes = "${buildDir}/${cloverClassesDir}"
  59 } else {
  60   use_clover = false
  61   classes = "${jalviewDir}/${classesDir}"
  62 }
  63
  64 // configure classpath/args for j8/j11 compilation
  65
  66 def jalviewDirAbsolutePath = file(jalviewDir).getAbsolutePath()
  67 def libDir
  68 def libDistDir
  69 def compile_source_compatibility
  70 def compile_target_compatibility
  71
  72 ext {
  73   getdownWebsiteDir = "${jalviewDir}/${getdown_website_dir}/${JAVA_VERSION}"
  74   getdownDir = ""
  75   reportRsyncCmd = false
  76   buildDist = true
  77   buildProperties = buildPropertiesFile
  78   getdownLauncher = "${jalviewDir}/${getdown_lib_dir}/${getdown_launcher}"
  79   switch (CHANNEL) {
  80
  81     case "BUILD":
  82     // TODO: get bamboo build artifact URL for getdown artifacts
  83     getdown_channel_base = bamboo_channelbase
  84     getdown_channel_name = "${bamboo_planKey}/${JAVA_VERSION}"
  85     getdown_app_base = "${bamboo_channelbase}/${bamboo_planKey}${bamboo_getdown_channel_suffix}/${JAVA_VERSION}"
  86     getdown_app_dir = getdown_app_dir_alt
  87     buildProperties = "${jalviewDir}/${classesDir}/${buildPropertiesFile}"
  88     break
  89
  90     case "RELEASE":
  91     getdown_channel_name = CHANNEL.toLowerCase()
  92     getdownDir = "${getdown_channel_name}/${JAVA_VERSION}"
  93     getdown_app_base = "${getdown_channel_base}/${getdownDir}"
  94     getdown_app_dir = getdown_app_dir_release
  95     buildProperties = "${jalviewDir}/${classesDir}/${buildPropertiesFile}"
  96     reportRsyncCommand = true
  97     break
  98
  99     case "ARCHIVE":
 100     getdown_channel_name = CHANNEL.toLowerCase()+"/${JALVIEW_VERSION}"
 101     getdownDir = "${getdown_channel_name}/${JAVA_VERSION}"
 102     getdown_app_base = "${getdown_channel_base}/${getdownDir}"
 103     getdown_app_dir = getdown_app_dir_alt
 104     if (!file("${ARCHIVEDIR}/${packageDir}").exists()) {
 105       print "Must provide an ARCHIVEDIR value to produce an archive distribution"
 106       exit
 107     } else {
 108       packageDir = "${ARCHIVEDIR}/${packageDir}"
 109       buildProperties = "${ARCHIVEDIR}/${classesDir}/${buildPropertiesFile}"
 110       buildDist = false
 111     }
 112     reportRsyncCommand = true
 113     break
 114
 115     case "ARCHIVELOCAL":
 116     getdown_channel_name = "archive/${JALVIEW_VERSION}"
 117     getdownDir = "${getdown_channel_name}/${JAVA_VERSION}"
 118     getdown_app_base = file(getdownWebsiteDir).toURI().toString()
 119     getdown_app_dir = getdown_app_dir_alt
 120     if (!file("${ARCHIVEDIR}/${packageDir}").exists()) {
 121       print "Must provide an ARCHIVEDIR value to produce an archive distribution"
 122       exit
 123     } else {
 124       packageDir = "${ARCHIVEDIR}/${packageDir}"
 125       buildProperties = "${ARCHIVEDIR}/${classesDir}/${buildPropertiesFile}"
 126       buildDist = false
 127     }
 128     reportRsyncCommand = true
 129     getdownLauncher = "${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}"
 130     break
 131
 132     case "DEVELOP":
 133     getdown_channel_name = CHANNEL.toLowerCase()
 134     getdownDir = "${getdown_channel_name}/${JAVA_VERSION}"
 135     getdown_app_base = "${getdown_channel_base}/${getdownDir}"
 136     getdown_app_dir = getdown_app_dir_alt
 137     buildProperties = "${jalviewDir}/${classesDir}/${buildPropertiesFile}"
 138     reportRsyncCommand = true
 139     break
 140
 141     case "TEST-RELEASE":
 142     getdown_channel_name = CHANNEL.toLowerCase()
 143     getdownDir = "${getdown_channel_name}/${JAVA_VERSION}"
 144     getdown_app_base = "${getdown_channel_base}/${getdownDir}"
 145     getdown_app_dir = getdown_app_dir_alt
 146     buildProperties = "${jalviewDir}/${classesDir}/${buildPropertiesFile}"
 147     reportRsyncCommand = true
 148     break
 149
 150     case ~/^SCRATCH(|-[-\w]*)$/:
 151     getdown_channel_name = CHANNEL
 152     getdownDir = "${getdown_channel_name}/${JAVA_VERSION}"
 153     getdown_app_base = "${getdown_channel_base}/${getdownDir}"
 154     getdown_app_dir = getdown_app_dir_alt
 155     buildProperties = "${jalviewDir}/${classesDir}/${buildPropertiesFile}"
 156     reportRsyncCommand = true
 157     break
 158
 159     case "LOCAL":
 160     getdown_app_base = file(getdownWebsiteDir).toURI().toString()
 161     getdown_app_dir = getdown_app_dir_alt
 162     buildProperties = "${jalviewDir}/${classesDir}/${buildPropertiesFile}"
 163     getdownLauncher = "${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}"
 164     break
 165
 166     default: // something wrong specified
 167     print("CHANNEL must be one of BUILD, RELEASE, ARCHIVE, DEVELOP, TEST-RELEASE, SCRATCH-..., LOCAL [default]")
 168     exit
 169     break
 170
 171   }
 172
 173   getdownAppDir = "${getdownWebsiteDir}/${getdown_app_dir}"
 174   //getdownJ11libDir = "${getdownWebsiteDir}/${getdown_j11lib_dir}"
 175   getdownResourceDir = "${getdownWebsiteDir}/${getdown_resource_dir}"
 176   getdownInstallDir = "${getdownWebsiteDir}/${getdown_install_dir}"
 177   getdownFilesDir = "${jalviewDir}/${getdown_files_dir}/${JAVA_VERSION}/"
 178   getdownFilesInstallDir = "${getdownFilesDir}/${getdown_install_dir}"
 179   /* compile without modules -- using classpath libraries
 180   modules_compileClasspath = fileTree(dir: "${jalviewDir}/${j11modDir}", include: ["*.jar"])
 181   modules_runtimeClasspath = modules_compileClasspath
 182   */
 183   gitHash = ""
 184   gitBranch = ""
 185
 186   println("Using a ${CHANNEL} profile.")
 187 }
 188
 189 def JAVA_INTEGER_VERSION
 190 def additional_compiler_args = []
 191 // these are getdown.txt properties defined dependent on the JAVA_VERSION
 192 def getdown_alt_java_min_version
 193 def getdown_alt_java_max_version
 194 // this property is assigned below and expanded to multiple lines in the getdown task
 195 def getdown_alt_multi_java_location
 196 // this property is for the Java library used in eclipse
 197 def eclipse_java_runtime_name
 198 if (JAVA_VERSION.equals("1.8")) {
 199   JAVA_INTEGER_VERSION = "8"
 200   //libDir = j8libDir
 201   libDir = j11libDir
 202   libDistDir = j8libDir
 203   compile_source_compatibility = 1.8
 204   compile_target_compatibility = 1.8
 205   getdown_alt_java_min_version = getdown_alt_java8_min_version
 206   getdown_alt_java_max_version = getdown_alt_java8_max_version
 207   getdown_alt_multi_java_location = getdown_alt_java8_txt_multi_java_location
 208   eclipse_java_runtime_name = "JavaSE-1.8"
 209 } else if (JAVA_VERSION.equals("11")) {
 210   JAVA_INTEGER_VERSION = "11"
 211   libDir = j11libDir
 212   libDistDir = j11libDir
 213   compile_source_compatibility = 11
 214   compile_target_compatibility = 11
 215   getdown_alt_java_min_version = getdown_alt_java11_min_version
 216   getdown_alt_java_max_version = getdown_alt_java11_max_version
 217   getdown_alt_multi_java_location = getdown_alt_java11_txt_multi_java_location
 218   eclipse_java_runtime_name = "JavaSE-11"
 219   /* compile without modules -- using classpath libraries
 220   additional_compiler_args += [
 221   '--module-path', ext.modules_compileClasspath.asPath,
 222   '--add-modules', j11modules
 223   ]
 224   */
 225 } else if (JAVA_VERSION.equals("12") || JAVA_VERSION.equals("13")) {
 226   JAVA_INTEGER_VERSION = JAVA_VERSION
 227   libDir = j11libDir
 228   libDistDir = j11libDir
 229   compile_source_compatibility = JAVA_VERSION
 230   compile_target_compatibility = JAVA_VERSION
 231   getdown_alt_java_min_version = getdown_alt_java11_min_version
 232   getdown_alt_java_max_version = getdown_alt_java11_max_version
 233   getdown_alt_multi_java_location = getdown_alt_java11_txt_multi_java_location
 234   eclipse_java_runtime_name = "JavaSE-11"
 235   /* compile without modules -- using classpath libraries
 236   additional_compiler_args += [
 237   '--module-path', ext.modules_compileClasspath.asPath,
 238   '--add-modules', j11modules
 239   ]
 240   */
 241 } else {
 242   throw new GradleException("JAVA_VERSION=${JAVA_VERSION} not currently supported by Jalview")
 243 }
 244
 245 sourceSets {
 246
 247   main {
 248     java {
 249       srcDirs "${jalviewDir}/${sourceDir}"
 250       outputDir = file("${classes}")
 251     }
 252
 253     resources {
 254       srcDirs "${jalviewDir}/${resourceDir}"
 255     }
 256
 257     jar.destinationDir = file("${jalviewDir}/${packageDir}")
 258
 259     compileClasspath = files(sourceSets.main.java.outputDir)
 260     compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
 261
 262     runtimeClasspath = compileClasspath
 263   }
 264
 265   clover {
 266     java {
 267       srcDirs = [ cloverInstrDir ]
 268       outputDir = file("${buildDir}/${cloverClassesDir}")
 269     }
 270
 271     resources {
 272       srcDirs = sourceSets.main.resources.srcDirs
 273     }
 274     compileClasspath = configurations.cloverRuntime + files( sourceSets.clover.java.outputDir )
 275     compileClasspath += files(sourceSets.main.java.outputDir)
 276     compileClasspath += sourceSets.main.compileClasspath
 277     compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}", include: ["**/*.jar"])
 278     compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
 279
 280     runtimeClasspath = compileClasspath
 281   }
 282
 283   test {
 284     java {
 285       srcDirs "${jalviewDir}/${testSourceDir}"
 286       outputDir = file("${jalviewDir}/${testOutputDir}")
 287     }
 288
 289     resources {
 290       srcDirs = sourceSets.main.resources.srcDirs
 291     }
 292
 293     compileClasspath = files( sourceSets.test.java.outputDir )
 294
 295     if (use_clover) {
 296       compileClasspath += sourceSets.clover.compileClasspath
 297     } else {
 298       compileClasspath += files(sourceSets.main.java.outputDir)
 299     }
 300
 301     compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
 302     compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}/testnglibs", include: ["**/*.jar"])
 303     compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}/testlibs", include: ["**/*.jar"])
 304
 305     runtimeClasspath = compileClasspath
 306   }
 307 }
 308
 309 // clover bits
 310 dependencies {
 311   if (use_clover) {
 312     cloverCompile 'org.openclover:clover:4.3.1'
 313     testCompile 'org.openclover:clover:4.3.1'
 314   }
 315 }
 316
 317 configurations {
 318   cloverRuntime
 319   cloverRuntime.extendsFrom cloverCompile
 320 }
 321
 322 eclipse {
 323   project {
 324     name = eclipse_project_name
 325
 326     natures 'org.eclipse.jdt.core.javanature',
 327     'org.eclipse.jdt.groovy.core.groovyNature',
 328     'org.eclipse.buildship.core.gradleprojectnature'
 329
 330     buildCommand 'org.eclipse.jdt.core.javabuilder'
 331     buildCommand 'org.eclipse.buildship.core.gradleprojectbuilder'
 332   }
 333
 334   classpath {
 335     //defaultOutputDir = sourceSets.main.java.outputDir
 336     def removeThese = []
 337     configurations.each{
 338       if (it.isCanBeResolved()) {
 339         removeThese += it
 340       }
 341     }
 342
 343     minusConfigurations += removeThese
 344     plusConfigurations = [ ]
 345     file {
 346
 347       whenMerged { cp ->
 348         def removeTheseToo = []
 349         HashMap<String, Boolean> alreadyAddedSrcPath = new HashMap<>();
 350         cp.entries.each { entry ->
 351           if (entry.kind == 'src') {
 352             if (alreadyAddedSrcPath.getAt(entry.path) || !(entry.path == sourceDir || entry.path == testSourceDir)) {
 353               removeTheseToo += entry
 354             } else {
 355               alreadyAddedSrcPath.putAt(entry.path, true)
 356             }
 357           }
 358         }
 359         cp.entries.removeAll(removeTheseToo)
 360
 361         if (file("${jalviewDir}/${eclipse_bin_dir}/main").isDirectory()) {
 362           cp.entries += new Output("${eclipse_bin_dir}/main")
 363         }
 364         if (file(helpParentDir).isDirectory()) {
 365           cp.entries += new Library(fileReference(helpParentDir))
 366         }
 367         if (file(resourceDir).isDirectory()) {
 368           cp.entries += new Library(fileReference(resourceDir))
 369         }
 370
 371         HashMap<String, Boolean> alreadyAddedLibPath = new HashMap<>();
 372
 373         sourceSets.main.compileClasspath.findAll { it.name.endsWith(".jar") }.each {
 374           //don't want to add outputDir as eclipse is using its own output dir in bin/main
 375           if (it.isDirectory() || ! it.exists()) {
 376             // don't add dirs to classpath
 377             return
 378           }
 379           def itPath = it.toString()
 380           if (itPath.startsWith("${jalviewDirAbsolutePath}/")) {
 381             // make relative path
 382             itPath = itPath.substring(jalviewDirAbsolutePath.length()+1)
 383           }
 384           if (alreadyAddedLibPath.get(itPath)) {
 385             //println("Not adding duplicate entry "+itPath)
 386           } else {
 387             //println("Adding entry "+itPath)
 388             cp.entries += new Library(fileReference(itPath))
 389             alreadyAddedLibPath.put(itPath, true)
 390           }
 391         }
 392
 393         //fileTree(dir: "$jalviewDir/$utilsDir", include: ["test*/*.jar"]).each {
 394         sourceSets.test.compileClasspath.findAll { it.name.endsWith(".jar") }.each {
 395           //no longer want to add outputDir as eclipse is using its own output dir in bin/main
 396           if (it.isDirectory() || ! it.exists()) {
 397             // don't add dirs to classpath
 398             return false // groovy "break" in .each closure
 399           }
 400           def itPath = it.toString()
 401           if (itPath.startsWith("${jalviewDirAbsolutePath}/")) {
 402             itPath = itPath.substring(jalviewDirAbsolutePath.length()+1)
 403           }
 404           if (alreadyAddedLibPath.get(itPath)) {
 405             // don't duplicate
 406           } else {
 407             def lib = new Library(fileReference(itPath))
 408             lib.entryAttributes["test"] = "true"
 409             cp.entries += lib
 410             alreadyAddedLibPath.put(itPath, true)
 411           }
 412         }
 413
 414       } // whenMerged
 415
 416     } // file
 417
 418     containers 'org.eclipse.buildship.core.gradleclasspathcontainer'
 419
 420   } // classpath
 421
 422   jdt {
 423     // for the IDE, use java 11 compatibility
 424     sourceCompatibility = compile_source_compatibility
 425     targetCompatibility = compile_target_compatibility
 426     javaRuntimeName = eclipse_java_runtime_name
 427
 428     // add in jalview project specific properties/preferences into eclipse core preferences
 429     file {
 430       withProperties { props ->
 431         def jalview_prefs = new Properties()
 432         def ins = new FileInputStream("${jalviewDirAbsolutePath}/${eclipse_extra_jdt_prefs_file}")
 433         jalview_prefs.load(ins)
 434         ins.close()
 435         jalview_prefs.forEach { t, v ->
 436           if (props.getAt(t) == null) {
 437             props.putAt(t, v)
 438           }
 439         }
 440       }
 441     }
 442
 443   } // jdt
 444
 445 }
 446
 447 task cloverInstr() {
 448   // only instrument source, we build test classes as normal
 449   inputs.files files (sourceSets.main.allJava) // , fileTree(dir:"$jalviewDir/$testSourceDir", include: ["**/*.java"]))
 450   outputs.dir cloverInstrDir
 451
 452   doFirst {
 453     delete cloverInstrDir
 454     def argsList = ["--initstring", "${buildDir}/clover/clover.db",
 455     "-d", "${buildDir}/${cloverSourcesInstrDir}"]
 456     argsList.addAll(inputs.files.files.collect({ file ->
 457       file.absolutePath
 458     }))
 459     String[] args = argsList.toArray()
 460     println("About to instrument "+args.length +" files")
 461     com.atlassian.clover.CloverInstr.mainImpl(args)
 462   }
 463 }
 464
 465
 466 task cloverReport {
 467   group = "Verification"
 468     description = "Createst the Clover report"
 469     inputs.dir "${buildDir}/clover"
 470     outputs.dir "${reportsDir}/clover"
 471     onlyIf {
 472       file("${buildDir}/clover/clover.db").exists()
 473     }
 474   doFirst {
 475     def argsList = ["--initstring", "${buildDir}/clover/clover.db",
 476     "-o", "${reportsDir}/clover"]
 477     String[] args = argsList.toArray()
 478     com.atlassian.clover.reporters.html.HtmlReporter.runReport(args)
 479
 480     // and generate ${reportsDir}/clover/clover.xml
 481     args = ["--initstring", "${buildDir}/clover/clover.db",
 482     "-o", "${reportsDir}/clover/clover.xml"].toArray()
 483     com.atlassian.clover.reporters.xml.XMLReporter.runReport(args)
 484   }
 485 }
 486
 487 // end clover bits
 488
 489
 490 compileJava {
 491
 492   doFirst {
 493     sourceCompatibility = compile_source_compatibility
 494     targetCompatibility = compile_target_compatibility
 495     options.compilerArgs = additional_compiler_args
 496     print ("Setting target compatibility to "+targetCompatibility+"\n")
 497   }
 498
 499 }
 500
 501 compileTestJava {
 502   if (use_clover) {
 503     dependsOn compileCloverJava
 504     classpath += configurations.cloverRuntime
 505   } else {
 506     classpath += sourceSets.main.runtimeClasspath
 507   }
 508   doFirst {
 509     sourceCompatibility = compile_source_compatibility
 510     targetCompatibility = compile_target_compatibility
 511     options.compilerArgs = additional_compiler_args
 512     print ("Setting target compatibility to "+targetCompatibility+"\n")
 513   }
 514 }
 515
 516
 517 compileCloverJava {
 518
 519   doFirst {
 520     sourceCompatibility = compile_source_compatibility
 521     targetCompatibility = compile_target_compatibility
 522     options.compilerArgs += additional_compiler_args
 523     print ("Setting target compatibility to "+targetCompatibility+"\n")
 524   }
 525   classpath += configurations.cloverRuntime
 526 }
 527
 528 clean {
 529   doFirst {
 530     delete sourceSets.main.java.outputDir
 531   }
 532 }
 533
 534 cleanTest {
 535   doFirst {
 536     delete sourceSets.test.java.outputDir
 537     delete cloverInstrDir
 538   }
 539 }
 540
 541 // format is a string like date.format("dd MMMM yyyy")
 542 def getDate(format) {
 543   def date = new Date()
 544   return date.format(format)
 545 }
 546
 547 task setGitVals {
 548   def hashStdOut = new ByteArrayOutputStream()
 549   exec {
 550     commandLine "git", "rev-parse", "--short", "HEAD"
 551     standardOutput = hashStdOut
 552     ignoreExitValue true
 553   }
 554
 555   def branchStdOut = new ByteArrayOutputStream()
 556   exec {
 557     commandLine "git", "rev-parse", "--abbrev-ref", "HEAD"
 558     standardOutput = branchStdOut
 559     ignoreExitValue true
 560   }
 561
 562   project.ext.gitHash = hashStdOut.toString().trim()
 563   project.ext.gitBranch = branchStdOut.toString().trim()
 564
 565   outputs.upToDateWhen { false }
 566 }
 567
 568 task createBuildProperties(type: WriteProperties) {
 569   dependsOn setGitVals
 570   inputs.dir("${jalviewDir}/${sourceDir}")
 571   inputs.dir("${classes}")
 572   inputs.dir("${jalviewDir}/${resourceDir}")
 573   outputFile (buildProperties)
 574   // taking time specific comment out to allow better incremental builds
 575   comment "--Jalview Build Details--\n"+getDate("yyyy-MM-dd HH:mm:ss")
 576   //comment "--Jalview Build Details--\n"+getDate("yyyy-MM-dd")
 577   property "BUILD_DATE", getDate("HH:mm:ss dd MMMM yyyy")
 578   property "VERSION", JALVIEW_VERSION
 579   property "INSTALLATION", INSTALLATION+" git-commit:"+project.ext.gitHash+" ["+project.ext.gitBranch+"]"
 580   outputs.file(outputFile)
 581 }
 582
 583 def buildingHTML = "${jalviewDir}/${docDir}/building.html"
 584 task cleanBuildingHTML(type: Delete) {
 585   doFirst {
 586     delete buildingHTML
 587   }
 588 }
 589
 590 task convertBuildingMD(type: Exec) {
 591   dependsOn cleanBuildingHTML
 592   def buildingMD = "${jalviewDir}/${docDir}/building.md"
 593   def css = "${jalviewDir}/${docDir}/github.css"
 594
 595   def pandoc = null
 596   pandoc_exec.split(",").each {
 597     if (file(it.trim()).exists()) {
 598       pandoc = it.trim()
 599       return true
 600     }
 601   }
 602
 603   def hostname = "hostname".execute().text.trim()
 604   if ((pandoc == null || ! file(pandoc).exists()) && hostname.equals("jv-bamboo")) {
 605     pandoc = System.getProperty("user.home")+"/buildtools/pandoc/bin/pandoc"
 606   }
 607
 608   doFirst {
 609     if (pandoc != null && file(pandoc).exists()) {
 610         commandLine pandoc, '-s', '-o', buildingHTML, '--metadata', 'pagetitle="Building Jalview from Source"', '--toc', '-H', css, buildingMD
 611     } else {
 612         println("Cannot find pandoc. Skipping convert building.md to HTML")
 613         throw new StopExecutionException()
 614     }
 615   }
 616
 617   ignoreExitValue true
 618
 619   inputs.file(buildingMD)
 620   inputs.file(css)
 621   outputs.file(buildingHTML)
 622 }
 623
 624 clean {
 625   doFirst {
 626     delete buildingHTML
 627   }
 628 }
 629
 630 task syncDocs(type: Sync) {
 631   dependsOn convertBuildingMD
 632   def syncDir = "${classes}/${docDir}"
 633   from fileTree("${jalviewDir}/${docDir}")
 634   into syncDir
 635
 636 }
 637
 638 def helpFile = "${classes}/${helpDir}/help.jhm"
 639
 640 task copyHelp(type: Copy) {
 641   def inputDir = "${jalviewDir}/${helpParentDir}/${helpDir}"
 642   def outputDir = "${classes}/${helpDir}"
 643   from(inputDir) {
 644     exclude '**/*.gif'
 645       exclude '**/*.jpg'
 646       exclude '**/*.png'
 647       filter(ReplaceTokens, beginToken: '$$', endToken: '$$', tokens: ['Version-Rel': JALVIEW_VERSION,'Year-Rel': getDate("yyyy")])
 648   }
 649   from(inputDir) {
 650     include '**/*.gif'
 651     include '**/*.jpg'
 652     include '**/*.png'
 653   }
 654   into outputDir
 655
 656   inputs.dir(inputDir)
 657   outputs.files(helpFile)
 658   outputs.dir(outputDir)
 659 }
 660
 661 task syncLib(type: Sync) {
 662   def syncDir = "${classes}/${libDistDir}"
 663   from fileTree("${jalviewDir}/${libDistDir}")
 664   into syncDir
 665 }
 666
 667 task syncResources(type: Sync) {
 668   from "${jalviewDir}/${resourceDir}"
 669   include "**/*.*"
 670   into "${classes}"
 671   preserve {
 672     include "**"
 673   }
 674 }
 675
 676 task prepare {
 677   dependsOn syncResources
 678   dependsOn syncDocs
 679   dependsOn copyHelp
 680 }
 681
 682
 683 //testReportDirName = "test-reports" // note that test workingDir will be $jalviewDir
 684 test {
 685   dependsOn prepare
 686   dependsOn compileJava
 687   if (use_clover) {
 688     dependsOn cloverInstr
 689   }
 690
 691   if (use_clover) {
 692     print("Running tests " + (use_clover?"WITH":"WITHOUT") + " clover [clover="+use_clover+"]\n")
 693   }
 694
 695   useTestNG() {
 696     includeGroups testngGroups
 697     preserveOrder true
 698     useDefaultListeners=true
 699   }
 700
 701   workingDir = jalviewDir
 702   //systemProperties 'clover.jar' System.properties.clover.jar
 703   sourceCompatibility = compile_source_compatibility
 704   targetCompatibility = compile_target_compatibility
 705   jvmArgs += additional_compiler_args
 706
 707 }
 708
 709 task buildIndices(type: JavaExec) {
 710   dependsOn copyHelp
 711   classpath = sourceSets.main.compileClasspath
 712   main = "com.sun.java.help.search.Indexer"
 713   workingDir = "${classes}/${helpDir}"
 714   def argDir = "html"
 715   args = [ argDir ]
 716   inputs.dir("${workingDir}/${argDir}")
 717
 718   outputs.dir("${classes}/doc")
 719   outputs.dir("${classes}/help")
 720   outputs.file("${workingDir}/JavaHelpSearch/DOCS")
 721   outputs.file("${workingDir}/JavaHelpSearch/DOCS.TAB")
 722   outputs.file("${workingDir}/JavaHelpSearch/OFFSETS")
 723   outputs.file("${workingDir}/JavaHelpSearch/POSITIONS")
 724   outputs.file("${workingDir}/JavaHelpSearch/SCHEMA")
 725   outputs.file("${workingDir}/JavaHelpSearch/TMAP")
 726 }
 727
 728 task compileLinkCheck(type: JavaCompile) {
 729   options.fork = true
 730   classpath = files("${jalviewDir}/${utilsDir}")
 731   destinationDir = file("${jalviewDir}/${utilsDir}")
 732   source = fileTree(dir: "${jalviewDir}/${utilsDir}", include: ["HelpLinksChecker.java", "BufferedLineReader.java"])
 733
 734   inputs.file("${jalviewDir}/${utilsDir}/HelpLinksChecker.java")
 735   inputs.file("${jalviewDir}/${utilsDir}/HelpLinksChecker.java")
 736   outputs.file("${jalviewDir}/${utilsDir}/HelpLinksChecker.class")
 737   outputs.file("${jalviewDir}/${utilsDir}/BufferedLineReader.class")
 738 }
 739
 740 def helplinkscheckertouchfile = file("${jalviewDir}/${utilsDir}/HelpLinksChecker.touch")
 741 task linkCheck(type: JavaExec) {
 742   dependsOn prepare, compileLinkCheck
 743   classpath = files("${jalviewDir}/${utilsDir}")
 744   main = "HelpLinksChecker"
 745   workingDir = jalviewDir
 746   def help = "${classes}/${helpDir}"
 747   args = [ "${classes}/${helpDir}", "-nointernet" ]
 748
 749   doLast {
 750     helplinkscheckertouchfile.createNewFile()
 751   }
 752
 753   inputs.dir("${classes}/${helpDir}")
 754   outputs.file(helplinkscheckertouchfile)
 755 }
 756
 757 // import the pubhtmlhelp target
 758 ant.properties.basedir = "${jalviewDir}"
 759 ant.properties.helpBuildDir = "${jalviewDirAbsolutePath}/${classes}/${helpDir}"
 760 ant.importBuild "${utilsDir}/publishHelp.xml"
 761
 762
 763 task cleanPackageDir(type: Delete) {
 764   doFirst {
 765     delete fileTree(dir: "${jalviewDir}/${packageDir}", include: "*.jar")
 766   }
 767 }
 768
 769 jar {
 770   dependsOn linkCheck
 771   dependsOn buildIndices
 772   dependsOn createBuildProperties
 773
 774   manifest {
 775     attributes "Main-Class": mainClass,
 776     "Permissions": "all-permissions",
 777     "Application-Name": "Jalview Desktop",
 778     "Codebase": application_codebase
 779   }
 780
 781   destinationDir = file("${jalviewDir}/${packageDir}")
 782   archiveName = rootProject.name+".jar"
 783
 784   exclude "cache*/**"
 785   exclude "*.jar"
 786   exclude "*.jar.*"
 787   exclude "**/*.jar"
 788   exclude "**/*.jar.*"
 789
 790   inputs.dir("${classes}")
 791   outputs.file("${jalviewDir}/${packageDir}/${archiveName}")
 792 }
 793
 794 task copyJars(type: Copy) {
 795   from fileTree(dir: "${classes}", include: "**/*.jar").files
 796   into "${jalviewDir}/${packageDir}"
 797 }
 798
 799 // doing a Sync instead of Copy as Copy doesn't deal with "outputs" very well
 800 task syncJars(type: Sync) {
 801   from fileTree(dir: "${jalviewDir}/${libDistDir}", include: "**/*.jar").files
 802   into "${jalviewDir}/${packageDir}"
 803   preserve {
 804     include jar.archiveName
 805   }
 806 }
 807
 808 task makeDist {
 809   group = "build"
 810   description = "Put all required libraries in dist"
 811   // order of "cleanPackageDir", "copyJars", "jar" important!
 812   jar.mustRunAfter cleanPackageDir
 813   syncJars.mustRunAfter cleanPackageDir
 814   dependsOn cleanPackageDir
 815   dependsOn syncJars
 816   dependsOn jar
 817   outputs.dir("${jalviewDir}/${packageDir}")
 818 }
 819
 820 task cleanDist {
 821   dependsOn cleanPackageDir
 822   dependsOn cleanTest
 823   dependsOn clean
 824 }
 825
 826 shadowJar {
 827   group = "distribution"
 828   if (buildDist) {
 829     dependsOn makeDist
 830   }
 831   from ("${jalviewDir}/${libDistDir}") {
 832     include("*.jar")
 833   }
 834   manifest {
 835     attributes 'Implementation-Version': JALVIEW_VERSION
 836   }
 837   mainClassName = shadowJarMainClass
 838   mergeServiceFiles()
 839   classifier = "all-"+JALVIEW_VERSION+"-j"+JAVA_VERSION
 840   minimize()
 841 }
 842
 843 task getdownWebsite() {
 844   group = "distribution"
 845   description = "Create the getdown minimal app folder, and website folder for this version of jalview. Website folder also used for offline app installer"
 846   if (buildDist) {
 847     dependsOn makeDist
 848   }
 849
 850   def getdownWebsiteResourceFilenames = []
 851   def getdownTextString = ""
 852   def getdownResourceDir = project.ext.getdownResourceDir
 853   def getdownAppDir = project.ext.getdownAppDir
 854   def getdownResourceFilenames = []
 855
 856   doFirst {
 857     // clean the getdown website and files dir before creating getdown folders
 858     delete project.ext.getdownWebsiteDir
 859     delete project.ext.getdownFilesDir
 860
 861     copy {
 862       from buildProperties
 863       rename(buildPropertiesFile, getdown_build_properties)
 864       into project.ext.getdownAppDir
 865     }
 866     getdownWebsiteResourceFilenames += "${getdown_app_dir}/${getdown_build_properties}"
 867
 868     // go through properties looking for getdown_txt_...
 869     def props = project.properties.sort { it.key }
 870     if (getdown_alt_java_min_version.length() > 0) {
 871       props.put("getdown_txt_java_min_version", getdown_alt_java_min_version)
 872     }
 873     if (getdown_alt_java_max_version.length() > 0) {
 874       props.put("getdown_txt_java_max_version", getdown_alt_java_max_version)
 875     }
 876     props.put("getdown_txt_multi_java_location", getdown_alt_multi_java_location)
 877
 878     props.put("getdown_txt_appbase", getdown_app_base)
 879     props.each{ prop, val ->
 880       if (prop.startsWith("getdown_txt_") && val != null) {
 881         if (prop.startsWith("getdown_txt_multi_")) {
 882           def key = prop.substring(18)
 883           val.split(",").each{ v ->
 884             def line = "${key} = ${v}\n"
 885             getdownTextString += line
 886           }
 887         } else {
 888           // file values rationalised
 889           if (val.indexOf('/') > -1 || prop.startsWith("getdown_txt_resource")) {
 890             def r = null
 891             if (val.indexOf('/') == 0) {
 892               // absolute path
 893               r = file(val)
 894             } else if (val.indexOf('/') > 0) {
 895               // relative path (relative to jalviewDir)
 896               r = file( "${jalviewDir}/${val}" )
 897             }
 898             if (r.exists()) {
 899               val = "${getdown_resource_dir}/" + r.getName()
 900               getdownWebsiteResourceFilenames += val
 901               getdownResourceFilenames += r.getPath()
 902             }
 903           }
 904           if (! prop.startsWith("getdown_txt_resource")) {
 905             def line = prop.substring(12) + " = ${val}\n"
 906             getdownTextString += line
 907           }
 908         }
 909       }
 910     }
 911
 912     getdownWebsiteResourceFilenames.each{ filename ->
 913       getdownTextString += "resource = ${filename}\n"
 914     }
 915     getdownResourceFilenames.each{ filename ->
 916       copy {
 917         from filename
 918         into project.ext.getdownResourceDir
 919       }
 920     }
 921
 922     def codeFiles = []
 923     fileTree(file(packageDir)).each{ f ->
 924       if (f.isDirectory()) {
 925         def files = fileTree(dir: f, include: ["*"]).getFiles()
 926         codeFiles += files
 927       } else if (f.exists()) {
 928         codeFiles += f
 929       }
 930     }
 931     codeFiles.sort().each{f ->
 932       def name = f.getName()
 933       def line = "code = ${getdown_app_dir}/${name}\n"
 934       getdownTextString += line
 935       copy {
 936         from f.getPath()
 937         into project.ext.getdownAppDir
 938       }
 939     }
 940
 941     // NOT USING MODULES YET, EVERYTHING SHOULD BE IN dist
 942     /*
 943     if (JAVA_VERSION.equals("11")) {
 944     def j11libFiles = fileTree(dir: "${jalviewDir}/${j11libDir}", include: ["*.jar"]).getFiles()
 945     j11libFiles.sort().each{f ->
 946     def name = f.getName()
 947     def line = "code = ${getdown_j11lib_dir}/${name}\n"
 948     getdownTextString += line
 949     copy {
 950     from f.getPath()
 951     into project.ext.getdownJ11libDir
 952     }
 953     }
 954     }
 955      */
 956
 957     // 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.
 958     //getdownTextString += "class = " + file(getdownLauncher).getName() + "\n"
 959     getdownTextString += "resource = ${getdown_launcher_new}\n"
 960     getdownTextString += "class = ${mainClass}\n"
 961
 962     def getdown_txt = file("${project.ext.getdownWebsiteDir}/getdown.txt")
 963     getdown_txt.write(getdownTextString)
 964
 965     def launch_jvl = file("${project.ext.getdownWebsiteDir}/${getdown_launch_jvl}")
 966     launch_jvl.write("appbase="+props.get("getdown_txt_appbase"))
 967
 968     copy {
 969       from getdownLauncher
 970       rename(file(getdownLauncher).getName(), getdown_launcher_new)
 971       into project.ext.getdownWebsiteDir
 972     }
 973
 974     copy {
 975       from getdownLauncher
 976       if (file(getdownLauncher).getName() != getdown_launcher) {
 977         rename(file(getdownLauncher).getName(), getdown_launcher)
 978       }
 979       into project.ext.getdownWebsiteDir
 980     }
 981
 982     if (! (CHANNEL.startsWith("ARCHIVE") || CHANNEL.startsWith("DEVELOP"))) {
 983       copy {
 984         from getdown_txt
 985         from getdownLauncher
 986         from "${getdownWebsiteDir}/${getdown_build_properties}"
 987         if (file(getdownLauncher).getName() != getdown_launcher) {
 988           rename(file(getdownLauncher).getName(), getdown_launcher)
 989         }
 990         into getdownInstallDir
 991       }
 992
 993       copy {
 994         from getdownInstallDir
 995         into getdownFilesInstallDir
 996       }
 997     }
 998
 999     copy {
1000       from getdown_txt
1001       from launch_jvl
1002       from getdownLauncher
1003       from "${getdownWebsiteDir}/${getdown_build_properties}"
1004       if (file(getdownLauncher).getName() != getdown_launcher) {
1005         rename(file(getdownLauncher).getName(), getdown_launcher)
1006       }
1007       into getdownFilesDir
1008     }
1009
1010     copy {
1011       from getdownResourceDir
1012       into "${project.ext.getdownFilesDir}/${getdown_resource_dir}"
1013     }
1014   }
1015
1016   if (buildDist) {
1017     inputs.dir("${jalviewDir}/${packageDir}")
1018   }
1019   outputs.dir(project.ext.getdownWebsiteDir)
1020   outputs.dir(project.ext.getdownFilesDir)
1021 }
1022
1023 task getdownDigest(type: JavaExec) {
1024   group = "distribution"
1025   description = "Digest the getdown website folder"
1026   dependsOn getdownWebsite
1027   doFirst {
1028     classpath = files("${getdownWebsiteDir}/${getdown_launcher}")
1029   }
1030   main = "com.threerings.getdown.tools.Digester"
1031   args project.ext.getdownWebsiteDir
1032   inputs.dir(project.ext.getdownWebsiteDir)
1033   outputs.file("${project.ext.getdownWebsiteDir}/digest2.txt")
1034 }
1035
1036 task getdown() {
1037   group = "distribution"
1038   description = "Create the minimal and full getdown app folder for installers and website and create digest file"
1039   dependsOn getdownDigest
1040   doLast {
1041     if (reportRsyncCommand) {
1042       def fromDir = getdownWebsiteDir + (getdownWebsiteDir.endsWith('/')?'':'/')
1043       def toDir = "${getdown_rsync_dest}/${getdownDir}" + (getdownDir.endsWith('/')?'':'/')
1044       println "LIKELY RSYNC COMMAND:"
1045       println "mkdir -p '$toDir'\nrsync -avh --delete '$fromDir' '$toDir'"
1046       if (RUNRSYNC == "true") {
1047         exec {
1048           commandLine "mkdir", "-p", toDir
1049         }
1050         exec {
1051           commandLine "rsync", "-avh", "--delete", fromDir, toDir
1052         }
1053       }
1054     }
1055   }
1056 }
1057
1058 clean {
1059   doFirst {
1060     delete project.ext.getdownWebsiteDir
1061     delete project.ext.getdownFilesDir
1062   }
1063 }
1064
1065 install4j {
1066   def install4jHomeDir = "/opt/install4j"
1067   def hostname = "hostname".execute().text.trim()
1068   if (hostname.equals("jv-bamboo")) {
1069     install4jHomeDir = System.getProperty("user.home")+"/buildtools/install4j"
1070   } else if (OperatingSystem.current().isMacOsX()) {
1071     install4jHomeDir = '/Applications/install4j.app/Contents/Resources/app'
1072     if (! file(install4jHomeDir).exists()) {
1073       install4jHomeDir = System.getProperty("user.home")+install4jHomeDir
1074     }
1075   } else if (OperatingSystem.current().isLinux()) {
1076     install4jHomeDir = System.getProperty("user.home")+"/buildtools/install4j"
1077   }
1078   installDir = file(install4jHomeDir)
1079   mediaTypes = Arrays.asList(install4jMediaTypes.split(","))
1080   if (install4jFaster.equals("true")) {
1081     faster = true
1082   }
1083 }
1084
1085 def install4jConf
1086 def macosJavaVMDir
1087 def macosJavaVMTgz
1088 def windowsJavaVMDir
1089 def windowsJavaVMTgz
1090 def install4jDir = "${jalviewDir}/${install4jResourceDir}"
1091 def install4jConfFile = "jalview-installers-java${JAVA_VERSION}.install4j"
1092 install4jConf = "${install4jDir}/${install4jConfFile}"
1093
1094 task copyInstall4jTemplate(type: Copy) {
1095   macosJavaVMDir = "${System.env.HOME}/buildtools/jre/openjdk-java_vm/getdown/macos-jre${JAVA_VERSION}/jre"
1096   macosJavaVMTgz = "${System.env.HOME}/buildtools/jre/openjdk-java_vm/install4j/tgz/macos-jre${JAVA_VERSION}.tar.gz"
1097   windowsJavaVMDir = "${System.env.HOME}/buildtools/jre/openjdk-java_vm/getdown/windows-jre${JAVA_VERSION}/jre"
1098   windowsJavaVMTgz = "${System.env.HOME}/buildtools/jre/openjdk-java_vm/install4j/tgz/windows-jre${JAVA_VERSION}.tar.gz"
1099   from (install4jDir) {
1100     include install4jTemplate
1101     rename (install4jTemplate, install4jConfFile)
1102     filter(ReplaceTokens, beginToken: '', endToken: '', tokens: ['9999999999': JAVA_VERSION])
1103     filter(ReplaceTokens, beginToken: '$$', endToken: '$$',
1104     tokens: [
1105     'JAVA_VERSION': JAVA_VERSION,
1106     'JAVA_INTEGER_VERSION': JAVA_INTEGER_VERSION,
1107     'VERSION': JALVIEW_VERSION,
1108     'MACOS_JAVA_VM_DIR': macosJavaVMDir,
1109     'MACOS_JAVA_VM_TGZ': macosJavaVMTgz,
1110     'WINDOWS_JAVA_VM_DIR': windowsJavaVMDir,
1111     'WINDOWS_JAVA_VM_TGZ': windowsJavaVMTgz,
1112     'INSTALL4JINFOPLISTFILEASSOCIATIONS': install4jInfoPlistFileAssociations,
1113     'COPYRIGHT_MESSAGE': install4jCopyrightMessage,
1114     'MACOS_BUNDLE_ID': install4jMacOSBundleId,
1115     'GETDOWN_RESOURCE_DIR': getdown_resource_dir,
1116     'GETDOWN_DIST_DIR': getdown_app_dir,
1117     'GETDOWN_ALT_DIR': getdown_app_dir_alt,
1118     'GETDOWN_INSTALL_DIR': getdown_install_dir
1119     ]
1120     )
1121     if (OSX_KEYPASS=="") {
1122       filter(ReplaceTokens, beginToken: 'codeSigning macEnabled="', endToken: '"', tokens: ['true':'codeSigning macEnabled="false"'])
1123       filter(ReplaceTokens, beginToken: 'runPostProcessor="true" ',endToken: 'Processor', tokens: ['post':'runPostProcessor="false" postProcessor'])
1124     }
1125   }
1126   into install4jDir
1127   outputs.files(install4jConf)
1128
1129   doLast {
1130     // include file associations in installer
1131     def installerFileAssociationsXml = file("${install4jDir}/${install4jInstallerFileAssociations}").text
1132     ant.replaceregexp(
1133       byline: false,
1134       flags: "s",
1135       match: '<action name="EXTENSIONS_REPLACED_BY_GRADLE".*?</action>',
1136       replace: installerFileAssociationsXml,
1137       file: install4jConf
1138     )
1139     /*
1140     // include uninstaller applescript app files in dmg
1141     def installerDMGUninstallerXml = file("$install4jDir/$install4jDMGUninstallerAppFiles").text
1142     ant.replaceregexp(
1143     byline: false,
1144     flags: "s",
1145     match: '<file name="UNINSTALL_OLD_JALVIEW_APP_REPLACED_IN_GRADLE" file=.*?>',
1146     replace: installerDMGUninstallerXml,
1147     file: install4jConf
1148     )
1149      */
1150   }
1151 }
1152
1153 task installers(type: com.install4j.gradle.Install4jTask) {
1154   group = "distribution"
1155   description = "Create the install4j installers"
1156   dependsOn getdown
1157   dependsOn copyInstall4jTemplate
1158   projectFile = file(install4jConf)
1159   variables = [majorVersion: version.substring(2, 11), build: 001, OSX_KEYSTORE: OSX_KEYSTORE, JSIGN_SH: JSIGN_SH]
1160   destination = "${jalviewDir}/${install4jBuildDir}/${JAVA_VERSION}"
1161   buildSelected = true
1162
1163   if (OSX_KEYPASS) {
1164     macKeystorePassword=OSX_KEYPASS
1165   }
1166
1167   doFirst {
1168     println("Using projectFile "+projectFile)
1169   }
1170
1171   inputs.dir(project.ext.getdownWebsiteDir)
1172   inputs.file(install4jConf)
1173   inputs.dir(macosJavaVMDir)
1174   inputs.dir(windowsJavaVMDir)
1175   outputs.dir("${jalviewDir}/${install4jBuildDir}/${JAVA_VERSION}")
1176 }
1177
1178 clean {
1179   doFirst {
1180     delete install4jConf
1181   }
1182 }
1183
1184 task sourceDist (type: Tar) {
1185
1186   def VERSION_UNDERSCORES = JALVIEW_VERSION.replaceAll("\\.", "_")
1187   def outputFileName = "${project.name}_${VERSION_UNDERSCORES}.tar.gz"
1188   // cater for buildship < 3.1 [3.0.1 is max version in eclipse 2018-09]
1189   try {
1190     archiveFileName = outputFileName
1191   } catch (Exception e) {
1192     archiveName = outputFileName
1193   }
1194
1195   compression Compression.GZIP
1196
1197   into project.name
1198
1199   def EXCLUDE_FILES=["build/*","bin/*","test-output/","test-reports","tests","clover*/*"
1200   ,".*"
1201   ,"benchmarking/*"
1202   ,"**/.*"
1203   ,"*.class"
1204   ,"**/*.class","${j11modDir}/**/*.jar","appletlib","**/*locales"
1205   ,"*locales/**",
1206   ,"utils/InstallAnywhere"]
1207   def PROCESS_FILES=[   "AUTHORS",
1208   "CITATION",
1209   "FEATURETODO",
1210   "JAVA-11-README",
1211   "FEATURETODO",
1212   "LICENSE",
1213   "**/README",
1214   "RELEASE",
1215   "THIRDPARTYLIBS","TESTNG",
1216   "build.gradle",
1217   "gradle.properties",
1218   "**/*.java",
1219   "**/*.html",
1220   "**/*.xml",
1221   "**/*.gradle",
1222   "**/*.groovy",
1223   "**/*.properties",
1224   "**/*.perl",
1225   "**/*.sh"]
1226
1227   from(jalviewDir) {
1228     exclude (EXCLUDE_FILES)
1229     include (PROCESS_FILES)
1230     filter(ReplaceTokens, beginToken: '$$', endToken: '$$', tokens: ['Version-Rel': JALVIEW_VERSION,'Year-Rel': getDate("yyyy")])
1231   }
1232   from(jalviewDir) {
1233     exclude (EXCLUDE_FILES)
1234     exclude (PROCESS_FILES)
1235   exclude ("appletlib")
1236   exclude ("**/*locales")
1237   exclude ("*locales/**")
1238   exclude ("utils/InstallAnywhere")
1239
1240     exclude (getdown_files_dir)
1241   exclude (getdown_website_dir)
1242
1243   // exluding these as not using jars as modules yet
1244   exclude ("${j11modDir}/**/*.jar")
1245 }
1246 //  from (jalviewDir) {
1247 //    // explicit includes for stuff that seemed to not get included
1248 //    include(fileTree("test/**/*."))
1249 //    exclude(EXCLUDE_FILES)
1250 //    exclude(PROCESS_FILES)
1251 //  }
1252 }
1253
1254 task helppages  {
1255   dependsOn copyHelp
1256   dependsOn pubhtmlhelp
1257
1258   inputs.dir("${classes}/${helpDir}")
1259   outputs.dir("${helpOutputDir}")
1260 }
1261
1262 def jalviewjsBuildDir
1263 def jalviewjsSiteDir
1264 def jalviewjsTransferSiteDir
1265 task jalviewjsSitePath {
1266   def relativeBuildDir = file(jalviewDirAbsolutePath).toPath().relativize(buildDir.toPath())
1267   jalviewjsBuildDir = "${relativeBuildDir}/jalviewjs"
1268   if (jalviewjs_site_dir.startsWith('/')) {
1269     jalviewjsSiteDir = jalviewjs_site_dir
1270   } else {
1271     jalviewjsSiteDir = "${jalviewjsBuildDir}/${jalviewjs_site_dir}"
1272   }
1273   jalviewjsTransferSiteDir = "${jalviewjsBuildDir}/tmp/site"
1274 }
1275
1276 def eclipseWorkspace
1277 task jalviewjsSetEclipseWorkspace {
1278   def propKey = "jalviewjs_eclipse_workspace"
1279   def propVal = null
1280   if (project.hasProperty(propKey)) {
1281     propVal = project.getProperty(propKey)
1282     if (propVal.startsWith("~/")) {
1283       propVal = System.getProperty("user.home") + propVal.substring(1)
1284     }
1285   }
1286   def propsFileName = "${jalviewjsBuildDir}/${jalviewjs_eclipse_workspace_location_file}"
1287   def eclipseWsDir = propVal
1288   def props = new Properties()
1289
1290   if (( eclipseWsDir == null || !file(eclipseWsDir).exists() ) && file(propsFileName).exists()) {
1291     def ins = new FileInputStream("${jalviewDirAbsolutePath}/${propsFileName}")
1292     props.load(ins)
1293     ins.close()
1294     if (props.getProperty(propKey, null) != null) {
1295       eclipseWsDir = props.getProperty(propKey)
1296     }
1297   }
1298
1299   if (eclipseWsDir == null || !file(eclipseWsDir).exists()) {
1300     def tempDir = File.createTempDir()
1301     eclipseWsDir = tempDir.getAbsolutePath()
1302     props.setProperty(propKey, eclipseWsDir)
1303     def propsFile = file(propsFileName)
1304     propsFile.parentFile.mkdirs()
1305     propsFile.createNewFile() // doesn't affect existing file
1306     def outs = new FileOutputStream(propsFile, false)
1307     props.store(outs, null)
1308     outs.close()
1309   }
1310
1311   eclipseWorkspace = file(eclipseWsDir)
1312
1313   doFirst {
1314     println("ECLIPSE WORKSPACE: "+eclipseWorkspace.getPath())
1315   }
1316   inputs.property(propKey, eclipseWsDir)
1317   outputs.file(propsFileName)
1318 }
1319
1320
1321 def eclipseDropinsDir
1322 def utilsDropinsDir
1323 def eclipseBinary
1324 def eclipseVersion
1325 def eclipseDebug = false
1326 def eclipseVersionSuffix = ""
1327 task jalviewjsEclipsePaths {
1328   def eclipseProduct
1329
1330   def eclipseRoot = jalviewjs_eclipse_root
1331   if (eclipseRoot.startsWith("~/")) {
1332     eclipseRoot = System.getProperty("user.home") + eclipseRoot.substring(1)
1333   }
1334   if (OperatingSystem.current().isMacOsX()) {
1335     eclipseRoot += "/Eclipse.app"
1336     eclipseDropinsDir = "${eclipseRoot}/Contents/Eclipse/dropins"
1337     eclipseBinary = "${eclipseRoot}/Contents/MacOS/eclipse"
1338     eclipseProduct = "${eclipseRoot}/Contents/Eclipse/.eclipseproduct"
1339   } else if (OperatingSystem.current().isWindows()) { // check these paths!!
1340     if (file("${eclipseRoot}/eclipse").isDirectory() && file("${eclipseRoot}/eclipse/.eclipseproduct").exists()) {
1341       eclipseRoot += "/eclipse"
1342     }
1343     eclipseDropinsDir = "${eclipseRoot}/dropins"
1344     eclipseBinary = "${eclipseRoot}/eclipse"
1345     eclipseProduct = "${eclipseRoot}/.eclipseproduct"
1346   } else { // linux or unix
1347     if (file("${eclipseRoot}/eclipse").isDirectory() && file("${eclipseRoot}/eclipse/.eclipseproduct").exists()) {
1348       eclipseRoot += "/eclipse"
1349     }
1350     eclipseDropinsDir = "${eclipseRoot}/dropins"
1351     eclipseBinary = "${eclipseRoot}/eclipse"
1352     eclipseProduct = "${eclipseRoot}/.eclipseproduct"
1353   }
1354
1355   eclipseVersion = "4.12" // default
1356   def assumedVersion = true
1357   if (file(eclipseProduct).exists()) {
1358     def fis = new FileInputStream(eclipseProduct)
1359     def props = new Properties()
1360     props.load(fis)
1361     eclipseVersion = props.getProperty("version")
1362     fis.close()
1363     assumedVersion = false
1364   }
1365   /*
1366   String[] v = eclipseVersion.split("\\.")
1367   def v0 = Integer.valueOf(v[0])
1368   def v1 = Integer.valueOf(v[1])
1369   if (v0 < 4 || ( v0 == 4 && v1 < 13 )) {
1370     eclipseVersionSuffix = "_4.12"
1371   } else {
1372     eclipseVersionSuffix = "_4.13"
1373   }
1374   utilsDropinsDir = "${jalviewDir}/${jalviewjs_eclipse_dropins_dir}${eclipseVersionSuffix}"
1375   */
1376
1377   utilsDropinsDir = "${jalviewDir}/${jalviewjs_eclipse_dropins_dir}"
1378   def propKey = "eclipse_debug"
1379   eclipseDebug = (project.hasProperty(propKey) && project.getProperty(propKey).equals("true"))
1380
1381   doFirst {
1382     if (!assumedVersion) {
1383       println("ECLIPSE_VERSION=${eclipseVersion}")
1384     }
1385   }
1386 }
1387
1388 task eclipseSetup {
1389   dependsOn eclipseProject
1390   dependsOn eclipseClasspath
1391   dependsOn eclipseJdt
1392 }
1393
1394 /* using the Copy task below
1395 task OLDjalviewjsEclipseCopyDropins {
1396   dependsOn jalviewjsEclipsePaths
1397   dependsOn jalviewjsCleanEclipse
1398   def inputFiles = fileTree(dir: utilsDropinsDir, include: "*.jar")
1399   inputFiles += file(jalviewjs_j2s_plugin)
1400   def outputDir = eclipseDropinsDir
1401
1402   inputs.files inputFiles
1403   inputFiles.each { file ->
1404     outputs.file("${outputDir}/${file.name}")
1405   }
1406
1407   doLast {
1408     inputFiles.each { file ->
1409       copy {
1410         from file
1411         into outputDir
1412       }
1413     }
1414   }
1415 }
1416 */
1417
1418 // this version (type: Copy) will delete anything in the eclipse dropins folder that isn't in fromDropinsDir
1419 task jalviewjsEclipseCopyDropins(type: Copy) {
1420   dependsOn jalviewjsEclipsePaths
1421
1422   from utilsDropinsDir
1423   into eclipseDropinsDir
1424
1425   doLast {
1426     copy {
1427       from jalviewjs_j2s_plugin
1428       into eclipseDropinsDir
1429     }
1430   }
1431 }
1432
1433 // this eclipse -clean doesn't actually work
1434 task jalviewjsCleanEclipse(type: Exec) {
1435   dependsOn eclipseSetup
1436   dependsOn jalviewjsEclipsePaths
1437   dependsOn jalviewjsEclipseCopyDropins
1438
1439   executable(eclipseBinary)
1440   args(["-nosplash", "--launcher.suppressErrors", "-data", eclipseWorkspace.getPath(), "-clean", "-console", "-consoleLog"])
1441   if (eclipseDebug) {
1442     args += "-debug"
1443   }
1444   args += "-l"
1445
1446   def inputString = """exit
1447 y
1448 """
1449   def inputByteStream = new ByteArrayInputStream(inputString.getBytes())
1450   standardInput = inputByteStream
1451
1452   doFirst {
1453     println("CLEAN ECLIPSE_DEBUG=${eclipseDebug}")
1454   }
1455 }
1456 /* not really working yet
1457 jalviewjsEclipseCopyDropins.finalizedBy jalviewjsCleanEclipse
1458 */
1459
1460 task jalviewjsUnzipFiles {
1461   dependsOn jalviewjsSitePath
1462
1463   def zipFiles = fileTree(dir: "${jalviewDir}/${jalviewjs_libjs_dir}", include: "*.zip")
1464   zipFiles += "${jalviewDir}/${jalviewjs_swingjs_zip}"
1465
1466   doLast {
1467     zipFiles.each { file_zip ->
1468       copy {
1469         from zipTree(file_zip)
1470         into "${jalviewDir}/${jalviewjsSiteDir}"
1471       }
1472     }
1473   }
1474
1475   inputs.files zipFiles
1476   outputs.dir "${jalviewDir}/${jalviewjsSiteDir}"
1477 }
1478
1479 task jalviewjsCreateJ2sSettings(type: WriteProperties) {
1480   dependsOn jalviewjsSitePath
1481   outputFile ("${jalviewDir}/${jalviewjs_j2s_settings}")
1482   def j2s_props = project.properties.findAll { it.key.startsWith("j2s.") }.sort { it.key }
1483   def siteDirProperty = "j2s.site.directory"
1484   def setSiteDir = false
1485   j2s_props.each { prop, val ->
1486     if (val != null) {
1487       if (prop == siteDirProperty) {
1488         if (!(val.startsWith('/') || val.startsWith("file://") )) {
1489           val = "${jalviewjsTransferSiteDir}/${val}"
1490         }
1491         setSiteDir = true
1492       }
1493       property(prop,val)
1494     }
1495     if (!setSiteDir) { // default site location, don't override specifically set property
1496       property(siteDirProperty,jalviewjsTransferSiteDir)
1497     }
1498   }
1499   inputs.properties(j2s_props)
1500   outputs.file(outputFile)
1501 }
1502
1503 task jalviewjsEclipseSetup {
1504   dependsOn jalviewjsEclipseCopyDropins
1505   dependsOn jalviewjsSetEclipseWorkspace
1506   dependsOn jalviewjsCreateJ2sSettings
1507 }
1508
1509 task jalviewjsCopyResources (type: Sync) {
1510   dependsOn jalviewjsSitePath
1511   def inputFiles = fileTree(dir: "${jalviewDir}/${resourceDir}")
1512   def outputDir = "${jalviewDir}/${jalviewjsSiteDir}/${jalviewjs_j2s_subdir}"
1513
1514   from inputFiles
1515   into outputDir
1516   def outputFiles = []
1517   rename { filename ->
1518     outputFiles += "${outputDir}/${filename}"
1519     null
1520   }
1521   preserve {
1522     include "**"
1523   }
1524   outputs.files outputFiles
1525   inputs.files inputFiles
1526 }
1527
1528 task jalviewjsCopySiteResources (type: Sync) {
1529   dependsOn jalviewjsSitePath
1530   def inputFiles = fileTree(dir: "${jalviewDir}/${jalviewjs_site_resource_dir}")
1531   def outputDir = "${jalviewDir}/${jalviewjsSiteDir}"
1532
1533   from inputFiles
1534   into outputDir
1535   def outputFiles = []
1536   rename { filename ->
1537     outputFiles += "${outputDir}/${filename}"
1538     null
1539   }
1540   preserve {
1541     include "**"
1542   }
1543   outputs.files outputFiles
1544   inputs.files inputFiles
1545 }
1546
1547 task jalviewjsProjectImport(type: Exec) {
1548   dependsOn eclipseSetup
1549   dependsOn jalviewjsEclipsePaths
1550   dependsOn jalviewjsEclipseSetup
1551
1552   def projdir = eclipseWorkspace.getPath()+"/.metadata/.plugins/org.eclipse.core.resources/.projects/jalview/org.eclipse.jdt.core"
1553   executable(eclipseBinary)
1554   args(["-nosplash", "--launcher.suppressErrors", "-application", "com.seeq.eclipse.importprojects.headlessimport", "-data", eclipseWorkspace.getPath(), "-import", jalviewDirAbsolutePath])
1555   if (eclipseDebug) {
1556     args += "-debug"
1557   }
1558   // can we use args += ["--launcher.appendVmargs", "-vmargs", "-Dorg.eclipse.equinox.p2.reconciler.dropins.directory=utils/jalviewjs/eclipse/dropins"] here? (instead of copying plugins to eclipse dropins dir)
1559
1560   doFirst {
1561     println("IMPORT ECLIPSE_DEBUG=${eclipseDebug}")
1562   }
1563
1564   inputs.file("${jalviewDir}/.project")
1565   outputs.dir(projdir)
1566   outputs.upToDateWhen { file(projdir).exists() }
1567 }
1568
1569 task jalviewjsTranspile(type: Exec) {
1570   dependsOn jalviewjsEclipseSetup
1571   dependsOn jalviewjsProjectImport
1572   dependsOn jalviewjsEclipsePaths
1573
1574   executable(eclipseBinary)
1575   args(["-nosplash", "--launcher.suppressErrors", "-application", "org.eclipse.jdt.apt.core.aptBuild", "-data", eclipseWorkspace, "-${jalviewjs_eclipse_build_arg}", eclipse_project_name ])
1576   if (eclipseDebug) {
1577     args += "-debug"
1578   }
1579   // can we use args += ["--launcher.appendVmargs", "-vmargs", "-Dorg.eclipse.equinox.p2.reconciler.dropins.directory=swingjs"] here? (instead of copying plugins to eclipse dropins dir)
1580
1581   def stdout
1582   def stderr
1583   stdout = new ByteArrayOutputStream()
1584   stderr = new ByteArrayOutputStream()
1585
1586   def logOutFileName = "${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_j2s_stdout}"
1587   def logOutFile = file(logOutFileName)
1588   logOutFile.createNewFile()
1589   logOutFile.text = """ROOT: ${jalviewjs_eclipse_root}
1590 BINARY: ${eclipseBinary}
1591 VERSION: ${eclipseVersion}
1592 WORKSPACE: ${eclipseWorkspace}
1593 DEBUG: ${eclipseDebug}
1594 ----
1595 """
1596   def logOutFOS = new FileOutputStream(logOutFile, true) // true == append
1597   //def logErrFileName = "${jalviewjsBuildDir}/${jalviewjs_j2s_stderr}"
1598   //def logErrFile = file(logFileName)
1599   //logErrFile.createNewFile()
1600   //def logErrFOS = new FileErrputStream(logErrFile, false)
1601   // combine stdout and stderr
1602   def logErrFOS = logOutFOS
1603
1604   if (jalviewjs_j2s_to_console.equals("true")) {
1605     standardOutput = new org.apache.tools.ant.util.TeeOutputStream(
1606       new org.apache.tools.ant.util.TeeOutputStream(
1607         logOutFOS,
1608         stdout),
1609       standardOutput)
1610       errorOutput = new org.apache.tools.ant.util.TeeOutputStream(
1611         new org.apache.tools.ant.util.TeeOutputStream(
1612           logErrFOS,
1613           stderr),
1614         errorOutput)
1615   } else {
1616     standardOutput = new org.apache.tools.ant.util.TeeOutputStream(
1617       logOutFOS,
1618       stdout)
1619       errorOutput = new org.apache.tools.ant.util.TeeOutputStream(
1620         logErrFOS,
1621         stderr)
1622   }
1623
1624   doLast {
1625     if (stdout.toString().contains("Error processing ")) {
1626       // j2s did not complete transpile
1627       throw new GradleException("Error during transpilation:\n${stderr}\nSee eclipse transpile log file '${jalviewjsBuildDir}/${jalviewjs_j2s_stdout}'")
1628     }
1629   }
1630
1631   doFirst {
1632     println("TRANSPILE ECLIPSE_DEBUG=${eclipseDebug}")
1633   }
1634
1635   inputs.dir("${jalviewDir}/${sourceDir}")
1636   outputs.dir("${jalviewDir}/${eclipse_bin_dir}/main")
1637   outputs.dir("${jalviewDir}/${jalviewjsTransferSiteDir}")
1638   outputs.upToDateWhen { file("${jalviewDir}/${jalviewjsTransferSiteDir}${jalviewjs_server_resource}").exists() }
1639
1640 }
1641
1642 task jalviewjsCopyTransferSite(type: Copy) {
1643   dependsOn jalviewjsTranspile
1644   from "${jalviewDir}/${jalviewjsTransferSiteDir}"
1645   into "${jalviewDir}/${jalviewjsSiteDir}"
1646 }
1647
1648 jalviewjsUnzipFiles.mustRunAfter jalviewjsCopyTransferSite
1649 jalviewjsCopyResources.mustRunAfter jalviewjsCopyTransferSite
1650 jalviewjsCopySiteResources.mustRunAfter jalviewjsCopyTransferSite
1651
1652 task jalviewjsPrepareSite {
1653   group "JalviewJS"
1654   description "Prepares the website folder including unzipping files and copying resources"
1655   dependsOn jalviewjsSitePath
1656   dependsOn jalviewjsUnzipFiles
1657   dependsOn jalviewjsCopyResources
1658   dependsOn jalviewjsCopySiteResources
1659 }
1660
1661 task jalviewjsBuildSite {
1662   group "JalviewJS"
1663   description "Builds the whole website including transpiled code"
1664   dependsOn jalviewjsCopyTransferSite
1665   dependsOn jalviewjsPrepareSite
1666 }
1667
1668 task cleanJalviewjsSite {
1669   doFirst {
1670     delete jalviewjsTransferSiteDir
1671     delete jalviewjsSiteDir
1672   }
1673 }
1674
1675 task jalviewjsSiteTar(type: Tar) {
1676   group "JalviewJS"
1677   description "Creates a tar.gz file for the website"
1678   dependsOn jalviewjsBuildSite
1679   def outputFilename = "jalviewjs-site-${JALVIEW_VERSION}.tar.gz"
1680   try {
1681     archiveFileName = outputFilename
1682   } catch (Exception e) {
1683     archiveName = outputFilename
1684   }
1685
1686   compression Compression.GZIP
1687
1688   from jalviewjsSiteDir
1689   into jalviewjs_site_dir // this is inside the tar file
1690
1691   inputs.dir(jalviewjsSiteDir)
1692 }
1693
1694 task jalviewjsServer {
1695   group "JalviewJS"
1696   description "Starts a webserver on localhost to test the website"
1697   dependsOn jalviewjsSitePath
1698   def htmlFile = "${jalviewDirAbsolutePath}/jalviewjsTest.html"
1699   doLast {
1700
1701     SimpleHttpFileServerFactory factory = new SimpleHttpFileServerFactory()
1702     def port = Integer.valueOf(jalviewjs_server_port)
1703     def start = port
1704     def running = false
1705     def url
1706     while(port < start+1000 && !running) {
1707       try {
1708         def doc_root = new File("${jalviewDirAbsolutePath}/${jalviewjsSiteDir}")
1709         def jalviewjsServer = factory.start(doc_root, port)
1710         running = true
1711         url = jalviewjsServer.getResourceUrl(jalviewjs_server_resource)
1712         println("SERVER STARTED with document root ${doc_root}.")
1713         println("Go to "+url+" . Run  gradle --stop  to stop (kills all gradle daemons).")
1714         println("For debug: "+url+"?j2sdebug")
1715
1716         file(htmlFile).text = """
1717         <p><a href="${url}">Jalview JS Test. &lt;${url}&gt;</a></p>
1718         <p><a href="${url}?j2sdebug">Jalview JS Test with debug. &lt;${url}?j2sdebug&lt;</a></p>
1719         """
1720
1721       } catch (Exception e) {
1722         port++;
1723       }
1724     }
1725
1726   }
1727
1728   outputs.file(htmlFile)
1729   outputs.upToDateWhen({false})
1730 }
1731
1732 task cleanJalviewjsAll {
1733   group "JalviewJS"
1734   description "Delete all configuration and build artifacts to do with JalviewJS build"
1735   dependsOn cleanJalviewjsSite
1736   dependsOn jalviewjsEclipsePaths
1737
1738   doFirst {
1739     delete jalviewjsBuildDir
1740     delete "${jalviewDir}/${eclipse_bin_dir}"
1741     if (eclipseWorkspace != null && file(eclipseWorkspace.getAbsolutePath()+"/.metadata").exists()) {
1742       delete file(eclipseWorkspace.getAbsolutePath()+"/.metadata")
1743     }
1744     delete "${jalviewDir}/${jalviewjs_j2s_settings}"
1745   }
1746 }
1747
1748 task jalviewjs {
1749   group "JalviewJS"
1750   description "Build the site"
1751   dependsOn jalviewjsBuildSite
1752 }
1753
1754
1755 task jalviewjsIDECopyTransferSite(type: Copy) {
1756   from jalviewjsTransferSiteDir
1757   into jalviewjsSiteDir
1758 }
1759
1760 task jalviewjsIDEj2s {
1761   group "JalviewJS in Eclipse"
1762   description "Creates the .j2s file"
1763   dependsOn jalviewjsCreateJ2sSettings
1764 }
1765
1766 task jalviewjsIDEBuildSite {
1767   group "JalviewJS in Eclipse"
1768   description "Copies the Eclipse transpiled site and unzips supporting zipfiles"
1769   dependsOn jalviewjsIDECopyTransferSite
1770   dependsOn jalviewjsPrepareSite
1771 }
1772
1773 task jalviewjsIDESiteClean {
1774   group "JalviewJS in Eclipse"
1775   description "Deletes the Eclipse transpiled site"
1776   dependsOn cleanJalviewjsSite
1777 }
1778
1779 task jalviewjsIDEServer {
1780   group "JalviewJS in Eclipse"
1781   description "Starts a webserver on localhost to test the website"
1782   dependsOn jalviewjsServer
1783 }
1784