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 repositories {
  23   jcenter()
  24   mavenCentral()
  25   mavenLocal()
  26   flatDir {
  27     dirs gradlePluginsDir
  28   }
  29 }
  30
  31 dependencies {
  32   compile 'org.apache.commons:commons-compress:1.18'
  33 }
  34
  35 mainClassName = launcherClass
  36 def cloverInstrDir = file("$buildDir/$cloverSourcesInstrDir")
  37 def classes = "$jalviewDir/$classesDir"
  38
  39 if (clover.equals("true")) {
  40   use_clover = true
  41   classes = "$buildDir/$cloverClassesDir"
  42 } else {
  43   use_clover = false
  44   classes = "$jalviewDir/$classesDir"
  45 }
  46
  47 // configure classpath/args for j8/j11 compilation
  48
  49 def jalviewDirAbsolutePath = file(jalviewDir).getAbsolutePath()
  50 def libDir
  51 def libDistDir
  52 def compile_source_compatibility
  53 def compile_target_compatibility
  54
  55 ext {
  56   // local build environment properties
  57   def localProps = "${jalviewDir}/local.properties"
  58   if (file(localProps).exists()) {
  59     def p = new Properties()
  60     def localPropsFIS = new FileInputStream(localProps)
  61     p.load(localPropsFIS)
  62     localPropsFIS.close()
  63     p.each {
  64       key, val ->
  65       def over = project.properties.get(key) != null
  66       project.properties.put(key, val)
  67       if (over) {
  68         println("Overriding property '${key}' with local.properties value")
  69       }
  70     }
  71   }
  72   getdownWebsiteDir = "${jalviewDir}/${getdown_website_dir}/${JAVA_VERSION}"
  73   getdownDir = ""
  74   reportRsyncCmd = false
  75   buildDist = true
  76   buildProperties = buildPropertiesFile
  77   getdownLauncher = "${jalviewDir}/${getdown_lib_dir}/${getdown_launcher}"
  78   switch (CHANNEL) {
  79
  80     case "BUILD":
  81     // TODO: get bamboo build artifact URL for getdown artifacts
  82     getdown_channel_base = bamboo_channelbase
  83     getdown_channel_name = "${bamboo_planKey}/${JAVA_VERSION}"
  84     getdown_app_base = "${bamboo_channelbase}/${bamboo_planKey}${bamboo_getdown_channel_suffix}/${JAVA_VERSION}"
  85     getdown_app_dir = getdown_app_dir_alt
  86     buildProperties = "${jalviewDir}/${classesDir}/${buildPropertiesFile}"
  87     break
  88
  89     case "RELEASE":
  90     getdown_channel_name = CHANNEL.toLowerCase()
  91     getdownDir = "${getdown_channel_name}/${JAVA_VERSION}"
  92     getdown_app_base = "${getdown_channel_base}/${getdownDir}"
  93     getdown_app_dir = getdown_app_dir_release
  94     buildProperties = "${jalviewDir}/${classesDir}/${buildPropertiesFile}"
  95     reportRsyncCommand = true
  96     break
  97
  98     case "ARCHIVE":
  99     getdown_channel_name = CHANNEL.toLowerCase()+"/${JALVIEW_VERSION}"
 100     getdownDir = "${getdown_channel_name}/${JAVA_VERSION}"
 101     getdown_app_base = "${getdown_channel_base}/${getdownDir}"
 102     getdown_app_dir = getdown_app_dir_alt
 103     if (!file("${ARCHIVEDIR}/${packageDir}").exists()) {
 104       print "Must provide an ARCHIVEDIR value to produce an archive distribution"
 105       exit
 106     } else {
 107       packageDir = "${ARCHIVEDIR}/${packageDir}"
 108       buildProperties = "${ARCHIVEDIR}/${classesDir}/${buildPropertiesFile}"
 109       buildDist = false
 110     }
 111     reportRsyncCommand = true
 112     break
 113
 114     case "ARCHIVELOCAL":
 115     getdown_channel_name = "archive/${JALVIEW_VERSION}"
 116     getdownDir = "${getdown_channel_name}/${JAVA_VERSION}"
 117     getdown_app_base = file(getdownWebsiteDir).toURI().toString()
 118     getdown_app_dir = getdown_app_dir_alt
 119     if (!file("${ARCHIVEDIR}/${packageDir}").exists()) {
 120       print "Must provide an ARCHIVEDIR value to produce an archive distribution"
 121       exit
 122     } else {
 123       packageDir = "${ARCHIVEDIR}/${packageDir}"
 124       buildProperties = "${ARCHIVEDIR}/${classesDir}/${buildPropertiesFile}"
 125       buildDist = false
 126     }
 127     reportRsyncCommand = true
 128     getdownLauncher = "${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}"
 129     break
 130
 131     case "DEVELOP":
 132     getdown_channel_name = CHANNEL.toLowerCase()
 133     getdownDir = "${getdown_channel_name}/${JAVA_VERSION}"
 134     getdown_app_base = "${getdown_channel_base}/${getdownDir}"
 135     getdown_app_dir = getdown_app_dir_alt
 136     buildProperties = "${jalviewDir}/${classesDir}/${buildPropertiesFile}"
 137     reportRsyncCommand = true
 138     break
 139
 140     case "TEST-RELEASE":
 141     getdown_channel_name = CHANNEL.toLowerCase()
 142     getdownDir = "${getdown_channel_name}/${JAVA_VERSION}"
 143     getdown_app_base = "${getdown_channel_base}/${getdownDir}"
 144     getdown_app_dir = getdown_app_dir_alt
 145     buildProperties = "${jalviewDir}/${classesDir}/${buildPropertiesFile}"
 146     reportRsyncCommand = true
 147     break
 148
 149     case ~/^SCRATCH(|-[-\w]*)$/:
 150     getdown_channel_name = CHANNEL
 151     getdownDir = "${getdown_channel_name}/${JAVA_VERSION}"
 152     getdown_app_base = "${getdown_channel_base}/${getdownDir}"
 153     getdown_app_dir = getdown_app_dir_alt
 154     buildProperties = "${jalviewDir}/${classesDir}/${buildPropertiesFile}"
 155     reportRsyncCommand = true
 156     break
 157
 158     case "LOCAL":
 159     getdown_app_base = file(getdownWebsiteDir).toURI().toString()
 160     getdown_app_dir = getdown_app_dir_alt
 161     buildProperties = "${jalviewDir}/${classesDir}/${buildPropertiesFile}"
 162     getdownLauncher = "${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}"
 163     break
 164
 165     default: // something wrong specified
 166     print("CHANNEL must be one of BUILD, RELEASE, ARCHIVE, DEVELOP, TEST-RELEASE, SCRATCH-..., LOCAL [default]")
 167     exit
 168     break
 169
 170   }
 171
 172   getdownAppDir = "${getdownWebsiteDir}/${getdown_app_dir}"
 173   //getdownJ11libDir = "${getdownWebsiteDir}/${getdown_j11lib_dir}"
 174   getdownResourceDir = "${getdownWebsiteDir}/${getdown_resource_dir}"
 175   getdownInstallDir = "${getdownWebsiteDir}/${getdown_install_dir}"
 176   getdownFilesDir = "${jalviewDir}/${getdown_files_dir}/${JAVA_VERSION}/"
 177   getdownFilesInstallDir = "${getdownFilesDir}/${getdown_install_dir}"
 178   /* compile without modules -- using classpath libraries
 179   modules_compileClasspath = fileTree(dir: "${jalviewDir}/${j11modDir}", include: ["*.jar"])
 180   modules_runtimeClasspath = modules_compileClasspath
 181   */
 182   gitHash = ""
 183   gitBranch = ""
 184
 185   println("Using a ${CHANNEL} profile. appbase=${getdown_app_base}")
 186 }
 187
 188 def JAVA_INTEGER_VERSION
 189 def additional_compiler_args = []
 190 // these are getdown.txt properties defined dependent on the JAVA_VERSION
 191 def getdown_alt_java_min_version
 192 def getdown_alt_java_max_version
 193 // this property is assigned below and expanded to multiple lines in the getdown task
 194 def getdown_alt_multi_java_location
 195 // this property is for the Java library used in eclipse
 196 def eclipse_java_runtime_name
 197 if (JAVA_VERSION.equals("1.8")) {
 198   JAVA_INTEGER_VERSION = "8"
 199   //libDir = j8libDir
 200   libDir = j11libDir
 201   libDistDir = j8libDir
 202   compile_source_compatibility = 1.8
 203   compile_target_compatibility = 1.8
 204   getdown_alt_java_min_version = getdown_alt_java8_min_version
 205   getdown_alt_java_max_version = getdown_alt_java8_max_version
 206   getdown_alt_multi_java_location = getdown_alt_java8_txt_multi_java_location
 207   eclipse_java_runtime_name = "JavaSE-1.8"
 208 } else if (JAVA_VERSION.equals("11")) {
 209   JAVA_INTEGER_VERSION = "11"
 210   libDir = j11libDir
 211   libDistDir = j11libDir
 212   compile_source_compatibility = 11
 213   compile_target_compatibility = 11
 214   getdown_alt_java_min_version = getdown_alt_java11_min_version
 215   getdown_alt_java_max_version = getdown_alt_java11_max_version
 216   getdown_alt_multi_java_location = getdown_alt_java11_txt_multi_java_location
 217   eclipse_java_runtime_name = "JavaSE-11"
 218   /* compile without modules -- using classpath libraries
 219   additional_compiler_args += [
 220   '--module-path', ext.modules_compileClasspath.asPath,
 221   '--add-modules', j11modules
 222   ]
 223   */
 224 } else if (JAVA_VERSION.equals("12") || JAVA_VERSION.equals("13")) {
 225   JAVA_INTEGER_VERSION = JAVA_VERSION
 226   libDir = j11libDir
 227   libDistDir = j11libDir
 228   compile_source_compatibility = JAVA_VERSION
 229   compile_target_compatibility = JAVA_VERSION
 230   getdown_alt_java_min_version = getdown_alt_java11_min_version
 231   getdown_alt_java_max_version = getdown_alt_java11_max_version
 232   getdown_alt_multi_java_location = getdown_alt_java11_txt_multi_java_location
 233   eclipse_java_runtime_name = "JavaSE-11"
 234   /* compile without modules -- using classpath libraries
 235   additional_compiler_args += [
 236   '--module-path', ext.modules_compileClasspath.asPath,
 237   '--add-modules', j11modules
 238   ]
 239   */
 240 } else {
 241   throw new GradleException("JAVA_VERSION=${JAVA_VERSION} not currently supported by Jalview")
 242 }
 243
 244 sourceSets {
 245
 246   main {
 247     java {
 248       srcDirs "${jalviewDir}/${sourceDir}"
 249       outputDir = file("${classes}")
 250     }
 251
 252     resources {
 253       srcDirs "${jalviewDir}/${resourceDir}"
 254     }
 255
 256     jar.destinationDir = file("${jalviewDir}/${packageDir}")
 257
 258     compileClasspath = files(sourceSets.main.java.outputDir)
 259     compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
 260
 261     runtimeClasspath = compileClasspath
 262   }
 263
 264   clover {
 265     java {
 266       srcDirs = [ cloverInstrDir ]
 267       outputDir = file("${buildDir}/${cloverClassesDir}")
 268     }
 269
 270     resources {
 271       srcDirs = sourceSets.main.resources.srcDirs
 272     }
 273     compileClasspath = configurations.cloverRuntime + files( sourceSets.clover.java.outputDir )
 274     compileClasspath += files(sourceSets.main.java.outputDir)
 275     compileClasspath += sourceSets.main.compileClasspath
 276     compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}", include: ["**/*.jar"])
 277     compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
 278
 279     runtimeClasspath = compileClasspath
 280   }
 281
 282   test {
 283     java {
 284       srcDirs "${jalviewDir}/${testSourceDir}"
 285       outputDir = file("${jalviewDir}/${testOutputDir}")
 286     }
 287
 288     resources {
 289       srcDirs = sourceSets.main.resources.srcDirs
 290     }
 291
 292     compileClasspath = files( sourceSets.test.java.outputDir )
 293
 294     if (use_clover) {
 295       compileClasspath += sourceSets.clover.compileClasspath
 296     } else {
 297       compileClasspath += files(sourceSets.main.java.outputDir)
 298     }
 299
 300     compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
 301     compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}/testnglibs", include: ["**/*.jar"])
 302     compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}/testlibs", include: ["**/*.jar"])
 303
 304     runtimeClasspath = compileClasspath
 305   }
 306 }
 307
 308 // clover bits
 309 dependencies {
 310   if (use_clover) {
 311     cloverCompile 'org.openclover:clover:4.3.1'
 312     testCompile 'org.openclover:clover:4.3.1'
 313   }
 314 }
 315
 316 configurations {
 317   cloverRuntime
 318   cloverRuntime.extendsFrom cloverCompile
 319 }
 320
 321 eclipse {
 322   project {
 323     name = eclipse_project_name
 324
 325     natures 'org.eclipse.jdt.core.javanature',
 326     'org.eclipse.jdt.groovy.core.groovyNature',
 327     'org.eclipse.buildship.core.gradleprojectnature'
 328
 329     buildCommand 'org.eclipse.jdt.core.javabuilder'
 330     buildCommand 'org.eclipse.buildship.core.gradleprojectbuilder'
 331   }
 332
 333   classpath {
 334     //defaultOutputDir = sourceSets.main.java.outputDir
 335     def removeThese = []
 336     configurations.each{
 337       if (it.isCanBeResolved()) {
 338         removeThese += it
 339       }
 340     }
 341
 342     minusConfigurations += removeThese
 343     plusConfigurations = [ ]
 344     file {
 345
 346       whenMerged { cp ->
 347         def removeTheseToo = []
 348         HashMap<String, Boolean> alreadyAddedSrcPath = new HashMap<>();
 349         cp.entries.each { entry ->
 350           if (entry.kind == 'src') {
 351             if (alreadyAddedSrcPath.getAt(entry.path) || !(entry.path == sourceDir || entry.path == testSourceDir)) {
 352               removeTheseToo += entry
 353             } else {
 354               alreadyAddedSrcPath.putAt(entry.path, true)
 355             }
 356           }
 357         }
 358         cp.entries.removeAll(removeTheseToo)
 359
 360         if (file("${jalviewDir}/${eclipse_bin_dir}/main").isDirectory()) {
 361           cp.entries += new Output("${eclipse_bin_dir}/main")
 362         }
 363         if (file(helpParentDir).isDirectory()) {
 364           cp.entries += new Library(fileReference(helpParentDir))
 365         }
 366         if (file(resourceDir).isDirectory()) {
 367           cp.entries += new Library(fileReference(resourceDir))
 368         }
 369
 370         HashMap<String, Boolean> alreadyAddedLibPath = new HashMap<>();
 371
 372         sourceSets.main.compileClasspath.findAll { it.name.endsWith(".jar") }.each {
 373           //don't want to add outputDir as eclipse is using its own output dir in bin/main
 374           if (it.isDirectory() || ! it.exists()) {
 375             // don't add dirs to classpath
 376             return
 377           }
 378           def itPath = it.toString()
 379           if (itPath.startsWith("${jalviewDirAbsolutePath}/")) {
 380             // make relative path
 381             itPath = itPath.substring(jalviewDirAbsolutePath.length()+1)
 382           }
 383           if (alreadyAddedLibPath.get(itPath)) {
 384             //println("Not adding duplicate entry "+itPath)
 385           } else {
 386             //println("Adding entry "+itPath)
 387             cp.entries += new Library(fileReference(itPath))
 388             alreadyAddedLibPath.put(itPath, true)
 389           }
 390         }
 391
 392         //fileTree(dir: "$jalviewDir/$utilsDir", include: ["test*/*.jar"]).each {
 393         sourceSets.test.compileClasspath.findAll { it.name.endsWith(".jar") }.each {
 394           //no longer want to add outputDir as eclipse is using its own output dir in bin/main
 395           if (it.isDirectory() || ! it.exists()) {
 396             // don't add dirs to classpath
 397             return false // groovy "break" in .each closure
 398           }
 399           def itPath = it.toString()
 400           if (itPath.startsWith("${jalviewDirAbsolutePath}/")) {
 401             itPath = itPath.substring(jalviewDirAbsolutePath.length()+1)
 402           }
 403           if (alreadyAddedLibPath.get(itPath)) {
 404             // don't duplicate
 405           } else {
 406             def lib = new Library(fileReference(itPath))
 407             lib.entryAttributes["test"] = "true"
 408             cp.entries += lib
 409             alreadyAddedLibPath.put(itPath, true)
 410           }
 411         }
 412
 413       } // whenMerged
 414
 415     } // file
 416
 417     containers 'org.eclipse.buildship.core.gradleclasspathcontainer'
 418
 419   } // classpath
 420
 421   jdt {
 422     // for the IDE, use java 11 compatibility
 423     sourceCompatibility = compile_source_compatibility
 424     targetCompatibility = compile_target_compatibility
 425     javaRuntimeName = eclipse_java_runtime_name
 426
 427     // add in jalview project specific properties/preferences into eclipse core preferences
 428     file {
 429       withProperties { props ->
 430         def jalview_prefs = new Properties()
 431         def ins = new FileInputStream("${jalviewDirAbsolutePath}/${eclipse_extra_jdt_prefs_file}")
 432         jalview_prefs.load(ins)
 433         ins.close()
 434         jalview_prefs.forEach { t, v ->
 435           if (props.getAt(t) == null) {
 436             props.putAt(t, v)
 437           }
 438         }
 439       }
 440     }
 441
 442   } // jdt
 443
 444 }
 445
 446 task cloverInstr() {
 447   // only instrument source, we build test classes as normal
 448   inputs.files files (sourceSets.main.allJava) // , fileTree(dir:"$jalviewDir/$testSourceDir", include: ["**/*.java"]))
 449   outputs.dir cloverInstrDir
 450
 451   doFirst {
 452     delete cloverInstrDir
 453     def argsList = ["--initstring", "${buildDir}/clover/clover.db",
 454     "-d", "${buildDir}/${cloverSourcesInstrDir}"]
 455     argsList.addAll(inputs.files.files.collect({ file ->
 456       file.absolutePath
 457     }))
 458     String[] args = argsList.toArray()
 459     println("About to instrument "+args.length +" files")
 460     com.atlassian.clover.CloverInstr.mainImpl(args)
 461   }
 462 }
 463
 464
 465 task cloverReport {
 466   group = "Verification"
 467     description = "Createst the Clover report"
 468     inputs.dir "${buildDir}/clover"
 469     outputs.dir "${reportsDir}/clover"
 470     onlyIf {
 471       file("${buildDir}/clover/clover.db").exists()
 472     }
 473   doFirst {
 474     def argsList = ["--initstring", "${buildDir}/clover/clover.db",
 475     "-o", "${reportsDir}/clover"]
 476     String[] args = argsList.toArray()
 477     com.atlassian.clover.reporters.html.HtmlReporter.runReport(args)
 478
 479     // and generate ${reportsDir}/clover/clover.xml
 480     args = ["--initstring", "${buildDir}/clover/clover.db",
 481     "-o", "${reportsDir}/clover/clover.xml"].toArray()
 482     com.atlassian.clover.reporters.xml.XMLReporter.runReport(args)
 483   }
 484 }
 485
 486 // end clover bits
 487
 488
 489 compileJava {
 490
 491   doFirst {
 492     sourceCompatibility = compile_source_compatibility
 493     targetCompatibility = compile_target_compatibility
 494     options.compilerArgs = additional_compiler_args
 495     print ("Setting target compatibility to "+targetCompatibility+"\n")
 496   }
 497
 498 }
 499
 500 compileTestJava {
 501   if (use_clover) {
 502     dependsOn compileCloverJava
 503     classpath += configurations.cloverRuntime
 504   } else {
 505     classpath += sourceSets.main.runtimeClasspath
 506   }
 507   doFirst {
 508     sourceCompatibility = compile_source_compatibility
 509     targetCompatibility = compile_target_compatibility
 510     options.compilerArgs = additional_compiler_args
 511     print ("Setting target compatibility to "+targetCompatibility+"\n")
 512   }
 513 }
 514
 515
 516 compileCloverJava {
 517
 518   doFirst {
 519     sourceCompatibility = compile_source_compatibility
 520     targetCompatibility = compile_target_compatibility
 521     options.compilerArgs += additional_compiler_args
 522     print ("Setting target compatibility to "+targetCompatibility+"\n")
 523   }
 524   classpath += configurations.cloverRuntime
 525 }
 526
 527 clean {
 528   doFirst {
 529     delete sourceSets.main.java.outputDir
 530   }
 531 }
 532
 533 cleanTest {
 534   doFirst {
 535     delete sourceSets.test.java.outputDir
 536     delete cloverInstrDir
 537   }
 538 }
 539
 540 // format is a string like date.format("dd MMMM yyyy")
 541 def getDate(format) {
 542   def date = new Date()
 543   return date.format(format)
 544 }
 545
 546 task setGitVals {
 547   def hashStdOut = new ByteArrayOutputStream()
 548   exec {
 549     commandLine "git", "rev-parse", "--short", "HEAD"
 550     standardOutput = hashStdOut
 551     ignoreExitValue true
 552   }
 553
 554   def branchStdOut = new ByteArrayOutputStream()
 555   exec {
 556     commandLine "git", "rev-parse", "--abbrev-ref", "HEAD"
 557     standardOutput = branchStdOut
 558     ignoreExitValue true
 559   }
 560
 561   project.ext.gitHash = hashStdOut.toString().trim()
 562   project.ext.gitBranch = branchStdOut.toString().trim()
 563
 564   outputs.upToDateWhen { false }
 565 }
 566
 567 task createBuildProperties(type: WriteProperties) {
 568   dependsOn setGitVals
 569   inputs.dir("${jalviewDir}/${sourceDir}")
 570   inputs.dir("${classes}")
 571   inputs.dir("${jalviewDir}/${resourceDir}")
 572   outputFile (buildProperties)
 573   // taking time specific comment out to allow better incremental builds
 574   comment "--Jalview Build Details--\n"+getDate("yyyy-MM-dd HH:mm:ss")
 575   //comment "--Jalview Build Details--\n"+getDate("yyyy-MM-dd")
 576   property "BUILD_DATE", getDate("HH:mm:ss dd MMMM yyyy")
 577   property "VERSION", JALVIEW_VERSION
 578   property "INSTALLATION", INSTALLATION+" git-commit:"+project.ext.gitHash+" ["+project.ext.gitBranch+"]"
 579   outputs.file(outputFile)
 580 }
 581
 582 def buildingHTML = "${jalviewDir}/${docDir}/building.html"
 583 task cleanBuildingHTML(type: Delete) {
 584   doFirst {
 585     delete buildingHTML
 586   }
 587 }
 588
 589 task convertBuildingMD(type: Exec) {
 590   dependsOn cleanBuildingHTML
 591   def buildingMD = "${jalviewDir}/${docDir}/building.md"
 592   def css = "${jalviewDir}/${docDir}/github.css"
 593
 594   def pandoc = null
 595   pandoc_exec.split(",").each {
 596     if (file(it.trim()).exists()) {
 597       pandoc = it.trim()
 598       return true
 599     }
 600   }
 601
 602   def hostname = "hostname".execute().text.trim()
 603   if ((pandoc == null || ! file(pandoc).exists()) && hostname.equals("jv-bamboo")) {
 604     pandoc = System.getProperty("user.home")+"/buildtools/pandoc/bin/pandoc"
 605   }
 606
 607   doFirst {
 608     if (pandoc != null && file(pandoc).exists()) {
 609         commandLine pandoc, '-s', '-o', buildingHTML, '--metadata', 'pagetitle="Building Jalview from Source"', '--toc', '-H', css, buildingMD
 610     } else {
 611         println("Cannot find pandoc. Skipping convert building.md to HTML")
 612         throw new StopExecutionException()
 613     }
 614   }
 615
 616   ignoreExitValue true
 617
 618   inputs.file(buildingMD)
 619   inputs.file(css)
 620   outputs.file(buildingHTML)
 621 }
 622
 623 clean {
 624   doFirst {
 625     delete buildingHTML
 626   }
 627 }
 628
 629 task syncDocs(type: Sync) {
 630   dependsOn convertBuildingMD
 631   def syncDir = "${classes}/${docDir}"
 632   from fileTree("${jalviewDir}/${docDir}")
 633   into syncDir
 634
 635 }
 636
 637 def helpFile = "${classes}/${helpDir}/help.jhm"
 638
 639 task copyHelp(type: Copy) {
 640   def inputDir = "${jalviewDir}/${helpParentDir}/${helpDir}"
 641   def outputDir = "${classes}/${helpDir}"
 642   from(inputDir) {
 643     exclude '**/*.gif'
 644       exclude '**/*.jpg'
 645       exclude '**/*.png'
 646       filter(ReplaceTokens, beginToken: '$$', endToken: '$$', tokens: ['Version-Rel': JALVIEW_VERSION,'Year-Rel': getDate("yyyy")])
 647   }
 648   from(inputDir) {
 649     include '**/*.gif'
 650       include '**/*.jpg'
 651       include '**/*.png'
 652   }
 653   into outputDir
 654
 655   inputs.dir(inputDir)
 656   outputs.files(helpFile)
 657   outputs.dir(outputDir)
 658 }
 659
 660 task syncLib(type: Sync) {
 661   def syncDir = "${classes}/${libDistDir}"
 662   from fileTree("${jalviewDir}/${libDistDir}")
 663   into syncDir
 664 }
 665
 666 task syncResources(type: Sync) {
 667   from "${jalviewDir}/${resourceDir}"
 668   include "**/*.*"
 669   exclude "install4j"
 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   }
1283   def propsFileName = "${jalviewjsBuildDir}/${jalviewjs_eclipse_workspace_location_file}"
1284   def eclipseWsDir = propVal
1285   def props = new Properties()
1286
1287   if (( eclipseWsDir == null || !file(eclipseWsDir).exists() ) && file(propsFileName).exists()) {
1288     def ins = new FileInputStream("${jalviewDirAbsolutePath}/${propsFileName}")
1289     props.load(ins)
1290     ins.close()
1291     if (props.getProperty(propKey, null) != null) {
1292       eclipseWsDir = props.getProperty(propKey)
1293     }
1294   }
1295
1296   if (eclipseWsDir == null || !file(eclipseWsDir).exists()) {
1297     def tempDir = File.createTempDir()
1298     eclipseWsDir = tempDir.getAbsolutePath()
1299     props.setProperty(propKey, eclipseWsDir)
1300     def propsFile = file(propsFileName)
1301     propsFile.parentFile.mkdirs()
1302     propsFile.createNewFile() // doesn't affect existing file
1303     def outs = new FileOutputStream(propsFile, false)
1304     props.store(outs, null)
1305     outs.close()
1306   }
1307
1308   eclipseWorkspace = file(eclipseWsDir)
1309
1310   doFirst {
1311     println("ECLIPSE WORKSPACE: "+eclipseWorkspace.getPath())
1312   }
1313   inputs.property(propKey, eclipseWsDir)
1314   outputs.file(propsFileName)
1315 }
1316
1317
1318 def eclipseDropinsDir
1319 def utilsDropinsDir
1320 def eclipseBinary
1321 def eclipseVersion
1322 def eclipseDebug = false
1323 def eclipseVersionSuffix = ""
1324 task jalviewjsEclipsePaths {
1325   def eclipseProduct
1326
1327   def eclipseRoot = jalviewjs_eclipse_root
1328   if (eclipseRoot.startsWith("~")) {
1329     eclipseRoot = System.getProperty("user.home") + eclipseRoot.substring(1)
1330   }
1331   if (OperatingSystem.current().isMacOsX()) {
1332     eclipseRoot += "/Eclipse.app"
1333     eclipseDropinsDir = "${eclipseRoot}/Contents/Eclipse/dropins"
1334     eclipseBinary = "${eclipseRoot}/Contents/MacOS/eclipse"
1335     eclipseProduct = "${eclipseRoot}/Contents/Eclipse/.eclipseproduct"
1336   } else if (OperatingSystem.current().isWindows()) { // check these paths!!
1337     if (file("${eclipseRoot}/eclipse").isDirectory() && file("${eclipseRoot}/eclipse/.eclipseproduct").exists()) {
1338       eclipseRoot += "/eclipse"
1339     }
1340     eclipseDropinsDir = "${eclipseRoot}/dropins"
1341     eclipseBinary = "${eclipseRoot}/eclipse"
1342     eclipseProduct = "${eclipseRoot}/.eclipseproduct"
1343   } else { // linux or unix
1344     if (file("${eclipseRoot}/eclipse").isDirectory() && file("${eclipseRoot}/eclipse/.eclipseproduct").exists()) {
1345       eclipseRoot += "/eclipse"
1346     }
1347     eclipseDropinsDir = "${eclipseRoot}/dropins"
1348     eclipseBinary = "${eclipseRoot}/eclipse"
1349     eclipseProduct = "${eclipseRoot}/.eclipseproduct"
1350   }
1351
1352   eclipseVersion = "4.12" // default
1353   def assumedVersion = true
1354   if (file(eclipseProduct).exists()) {
1355     def fis = new FileInputStream(eclipseProduct)
1356     def props = new Properties()
1357     props.load(fis)
1358     eclipseVersion = props.getProperty("version")
1359     fis.close()
1360     assumedVersion = false
1361   }
1362   String[] v = eclipseVersion.split("\\.")
1363   def v0 = Integer.valueOf(v[0])
1364   def v1 = Integer.valueOf(v[1])
1365   if (v0 < 4 || ( v0 == 4 && v1 < 13 )) {
1366     eclipseVersionSuffix = "_4.12"
1367   } else {
1368     eclipseVersionSuffix = "_4.13"
1369   }
1370
1371   utilsDropinsDir = "${jalviewjs_utils_dir}/${jalviewjs_eclipse_dropins_dir}${eclipseVersionSuffix}"
1372   def propKey = "eclipse_debug"
1373   eclipseDebug = (project.hasProperty(propKey) && project.getProperty(propKey).equals("true"))
1374
1375   doFirst {
1376     if (!assumedVersion) {
1377       println("ECLIPSE_VERSION=${eclipseVersion}")
1378     }
1379   }
1380 }
1381
1382 task eclipseSetup {
1383   dependsOn eclipseProject
1384   dependsOn eclipseClasspath
1385   dependsOn eclipseJdt
1386 }
1387
1388 /* using the Copy task below
1389 task OLDjalviewjsEclipseCopyDropins {
1390   dependsOn jalviewjsEclipsePaths
1391   dependsOn jalviewjsCleanEclipse
1392   def inputFiles = fileTree(dir: utilsDropinsDir, include: "*.jar")
1393   def outputDir = eclipseDropinsDir
1394
1395   inputs.files inputFiles
1396   inputFiles.each { file ->
1397     outputs.file("${outputDir}/${file.name}")
1398   }
1399
1400   doLast {
1401     inputFiles.each { file ->
1402       copy {
1403         from file
1404         into outputDir
1405       }
1406     }
1407   }
1408 }
1409 */
1410
1411 // this version (type: Copy) will delete anything in the eclipse dropins folder that isn't in fromDropinsDir
1412 task jalviewjsEclipseCopyDropins(type: Copy) {
1413   dependsOn jalviewjsEclipsePaths
1414
1415   from utilsDropinsDir
1416   into eclipseDropinsDir
1417 }
1418
1419 // this eclipse -clean doesn't actually work
1420 task jalviewjsCleanEclipse(type: Exec) {
1421   dependsOn eclipseSetup
1422   dependsOn jalviewjsEclipsePaths
1423   dependsOn jalviewjsEclipseCopyDropins
1424
1425   executable(eclipseBinary)
1426   args(["-nosplash", "--launcher.suppressErrors", "-data", eclipseWorkspace.getPath(), "-clean", "-console", "-consoleLog"])
1427   if (eclipseDebug) {
1428     args += "-debug"
1429   }
1430   args += "-l"
1431
1432   def inputString = """exit
1433 y
1434 """
1435   def inputByteStream = new ByteArrayInputStream(inputString.getBytes())
1436   standardInput = inputByteStream
1437
1438   doFirst {
1439     println("CLEAN ECLIPSE_DEBUG=${eclipseDebug}")
1440   }
1441 }
1442 /* not really working yet
1443 jalviewjsEclipseCopyDropins.finalizedBy jalviewjsCleanEclipse
1444 */
1445
1446 task jalviewjsUnzipFiles {
1447   dependsOn jalviewjsSitePath
1448
1449   def zipFiles = fileTree(dir: "${jalviewjs_utils_dir}/${jalviewjs_libjs_dir}", include: "*.zip")
1450   zipFiles += "${jalviewjs_utils_dir}/${jalviewjs_swingjs_zip}${eclipseVersionSuffix}"
1451
1452   doLast {
1453     zipFiles.each { file_zip ->
1454       copy {
1455         from zipTree(file_zip)
1456         into jalviewjsSiteDir
1457       }
1458     }
1459   }
1460
1461   inputs.files zipFiles
1462   outputs.dir jalviewjsSiteDir
1463 }
1464
1465 task jalviewjsCreateJ2sSettings(type: WriteProperties) {
1466   dependsOn jalviewjsSitePath
1467   outputFile ("${jalviewDir}/${jalviewjs_j2s_settings}")
1468   def j2s_props = project.properties.findAll { it.key.startsWith("j2s.") }.sort { it.key }
1469   def siteDirProperty = "j2s.site.directory"
1470   def setSiteDir = false
1471   j2s_props.each { prop, val ->
1472     if (val != null) {
1473       if (prop == siteDirProperty) {
1474         if (!(val.startsWith('/') || val.startsWith("file://") )) {
1475           val = "${jalviewjsTransferSiteDir}/${val}"
1476         }
1477         setSiteDir = true
1478       }
1479       property(prop,val)
1480     }
1481     if (!setSiteDir) { // default site location, don't override specifically set property
1482       property(siteDirProperty,jalviewjsTransferSiteDir)
1483     }
1484   }
1485   inputs.properties(j2s_props)
1486   outputs.file(outputFile)
1487 }
1488
1489 task jalviewjsEclipseSetup {
1490   dependsOn jalviewjsEclipseCopyDropins
1491   dependsOn jalviewjsSetEclipseWorkspace
1492   dependsOn jalviewjsCreateJ2sSettings
1493 }
1494
1495 task jalviewjsCopyResources (type: Copy) {
1496   dependsOn jalviewjsSitePath
1497   def inputFiles = fileTree(dir: jalviewjs_resource_dir)
1498   def outputDir = "${jalviewjsSiteDir}/${jalviewjs_j2s_subdir}"
1499
1500   from inputFiles
1501   into outputDir
1502   def outputFiles = []
1503   rename { filename ->
1504     outputFiles += "${outputDir}/${filename}"
1505     null
1506   }
1507   outputs.files outputFiles
1508   inputs.files inputFiles
1509 }
1510
1511 task jalviewjsCopySiteResources (type: Copy) {
1512   dependsOn jalviewjsSitePath
1513   def inputFiles = fileTree(dir: "${jalviewjs_utils_dir}/${jalviewjs_site_resource_dir}")
1514   def outputDir = jalviewjsSiteDir
1515
1516   from inputFiles
1517   into outputDir
1518   def outputFiles = []
1519   rename { filename ->
1520     outputFiles += "${outputDir}/${filename}"
1521     null
1522   }
1523   outputs.files outputFiles
1524   inputs.files inputFiles
1525 }
1526
1527 task jalviewjsProjectImport(type: Exec) {
1528   dependsOn eclipseSetup
1529   dependsOn jalviewjsEclipsePaths
1530   dependsOn jalviewjsEclipseSetup
1531
1532   def projdir = eclipseWorkspace.getPath()+"/.metadata/.plugins/org.eclipse.core.resources/.projects/jalview/org.eclipse.jdt.core"
1533   executable(eclipseBinary)
1534   args(["-nosplash", "--launcher.suppressErrors", "-application", "com.seeq.eclipse.importprojects.headlessimport", "-data", eclipseWorkspace.getPath(), "-import", jalviewDirAbsolutePath])
1535   if (eclipseDebug) {
1536     args += "-debug"
1537   }
1538
1539   doFirst {
1540     println("IMPORT ECLIPSE_DEBUG=${eclipseDebug}")
1541   }
1542
1543   inputs.file("${jalviewDir}/.project")
1544   outputs.dir(projdir)
1545   outputs.upToDateWhen { file(projdir).exists() }
1546 }
1547
1548 task jalviewjsTranspile(type: Exec) {
1549   dependsOn jalviewjsEclipseSetup
1550   dependsOn jalviewjsProjectImport
1551   dependsOn jalviewjsEclipsePaths
1552
1553   executable(eclipseBinary)
1554   args(["-nosplash", "--launcher.suppressErrors", "-application", "org.eclipse.jdt.apt.core.aptBuild", "-data", eclipseWorkspace, "-${jalviewjs_eclipseBuildArg}", eclipse_project_name ])
1555   if (eclipseDebug) {
1556     args += "-debug"
1557   }
1558
1559   def stdout
1560   def stderr
1561   stdout = new ByteArrayOutputStream()
1562   stderr = new ByteArrayOutputStream()
1563
1564   def logOutFileName = "${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_j2s_stdout}"
1565   def logOutFile = file(logOutFileName)
1566   logOutFile.createNewFile()
1567   logOutFile.text = """ROOT: ${jalviewjs_eclipse_root}
1568 BINARY: ${eclipseBinary}
1569 VERSION: ${eclipseVersion}
1570 WORKSPACE: ${eclipseWorkspace}
1571 DEBUG: ${eclipseDebug}
1572 ----
1573 """
1574   def logOutFOS = new FileOutputStream(logOutFile, true) // true == append
1575   //def logErrFileName = "${jalviewjsBuildDir}/${jalviewjs_j2s_stderr}"
1576   //def logErrFile = file(logFileName)
1577   //logErrFile.createNewFile()
1578   //def logErrFOS = new FileErrputStream(logErrFile, false)
1579   // combine stdout and stderr
1580   def logErrFOS = logOutFOS
1581
1582   if (jalviewjs_j2s_to_console.equals("true")) {
1583     standardOutput = new org.apache.tools.ant.util.TeeOutputStream(
1584       new org.apache.tools.ant.util.TeeOutputStream(
1585         logOutFOS,
1586         stdout),
1587       standardOutput)
1588       errorOutput = new org.apache.tools.ant.util.TeeOutputStream(
1589         new org.apache.tools.ant.util.TeeOutputStream(
1590           logErrFOS,
1591           stderr),
1592         errorOutput)
1593   } else {
1594     standardOutput = new org.apache.tools.ant.util.TeeOutputStream(
1595       logOutFOS,
1596       stdout)
1597       errorOutput = new org.apache.tools.ant.util.TeeOutputStream(
1598         logErrFOS,
1599         stderr)
1600   }
1601
1602   doLast {
1603     if (stdout.toString().contains("Error processing ")) {
1604       // j2s did not complete transpile
1605       throw new GradleException("Error during transpilation:\n${stderr}\nSee eclipse transpile log file '${jalviewjsBuildDir}/${jalviewjs_j2s_stdout}'")
1606     }
1607   }
1608
1609   doFirst {
1610     println("TRANSPILE ECLIPSE_DEBUG=${eclipseDebug}")
1611   }
1612
1613   inputs.dir(sourceDir)
1614   outputs.dir("${eclipse_bin_dir}/main")
1615   outputs.dir(jalviewjsTransferSiteDir)
1616   outputs.upToDateWhen { file("${jalviewjsTransferSiteDir}${jalviewjs_server_resource}").exists() }
1617
1618 }
1619
1620 task jalviewjsCopyTransferSite(type: Copy) {
1621   dependsOn jalviewjsTranspile
1622   from jalviewjsTransferSiteDir
1623   into jalviewjsSiteDir
1624 }
1625
1626 jalviewjsUnzipFiles.mustRunAfter jalviewjsCopyTransferSite
1627 jalviewjsCopyResources.mustRunAfter jalviewjsCopyTransferSite
1628 jalviewjsCopySiteResources.mustRunAfter jalviewjsCopyTransferSite
1629
1630 task jalviewjsPrepareSite {
1631   group "JalviewJS"
1632   description "Prepares the website folder including unzipping files and copying resources"
1633   dependsOn jalviewjsSitePath
1634   dependsOn jalviewjsUnzipFiles
1635   dependsOn jalviewjsCopyResources
1636   dependsOn jalviewjsCopySiteResources
1637 }
1638
1639 task jalviewjsBuildSite {
1640   group "JalviewJS"
1641   description "Builds the whole website including transpiled code"
1642   dependsOn jalviewjsCopyTransferSite
1643   dependsOn jalviewjsPrepareSite
1644 }
1645
1646 task cleanJalviewjsSite {
1647   doFirst {
1648     delete jalviewjsTransferSiteDir
1649     delete jalviewjsSiteDir
1650   }
1651 }
1652
1653 task jalviewjsSiteTar(type: Tar) {
1654   group "JalviewJS"
1655   description "Creates a tar.gz file for the website"
1656   dependsOn jalviewjsBuildSite
1657   def outputFilename = "jalviewjs-site-${JALVIEW_VERSION}.tar.gz"
1658   try {
1659     archiveFileName = outputFilename
1660   } catch (Exception e) {
1661     archiveName = outputFilename
1662   }
1663
1664   compression Compression.GZIP
1665
1666   from jalviewjsSiteDir
1667   into jalviewjs_site_dir // this is inside the tar file
1668
1669   inputs.dir(jalviewjsSiteDir)
1670 }
1671
1672 task jalviewjsServer {
1673   group "JalviewJS"
1674   description "Starts a webserver on localhost to test the website"
1675   dependsOn jalviewjsSitePath
1676   def htmlFile = "${jalviewDirAbsolutePath}/jalviewjsTest.html"
1677   doLast {
1678
1679     SimpleHttpFileServerFactory factory = new SimpleHttpFileServerFactory()
1680     def port = Integer.valueOf(jalviewjs_server_port)
1681     def start = port
1682     def running = false
1683     def url
1684     while(port < start+1000 && !running) {
1685       try {
1686         def doc_root = new File("${jalviewDirAbsolutePath}/${jalviewjsSiteDir}")
1687         def jalviewjsServer = factory.start(doc_root, port)
1688         running = true
1689         url = jalviewjsServer.getResourceUrl(jalviewjs_server_resource)
1690         println("SERVER STARTED with document root ${doc_root}.")
1691         println("Go to "+url+" . Run  gradle --stop  to stop (kills all gradle daemons).")
1692         println("For debug: "+url+"?j2sdebug")
1693
1694         file(htmlFile).text = """
1695         <p><a href="${url}">Jalview JS Test. &lt;${url}&gt;</a></p>
1696         <p><a href="${url}?j2sdebug">Jalview JS Test with debug. &lt;${url}?j2sdebug&lt;</a></p>
1697         """
1698
1699       } catch (Exception e) {
1700         port++;
1701       }
1702     }
1703
1704   }
1705
1706   outputs.file(htmlFile)
1707 }
1708
1709 task cleanJalviewjsAll {
1710   group "JalviewJS"
1711   description "Delete all configuration and build artifacts to do with JalviewJS build"
1712   dependsOn cleanJalviewjsSite
1713   dependsOn jalviewjsEclipsePaths
1714
1715   doFirst {
1716     delete jalviewjsBuildDir
1717     delete "${jalviewDir}/${eclipse_bin_dir}"
1718     if (eclipseWorkspace != null && file(eclipseWorkspace.getAbsolutePath()+"/.metadata").exists()) {
1719       delete file(eclipseWorkspace.getAbsolutePath()+"/.metadata")
1720     }
1721     delete "${jalviewDir}/${jalviewjs_j2s_settings}"
1722   }
1723 }
1724
1725 task jalviewjs {
1726   group "JalviewJS"
1727   description "Build the site"
1728   dependsOn jalviewjsBuildSite
1729 }
1730
1731
1732 task jalviewjsIDECopyTransferSite(type: Copy) {
1733   from jalviewjsTransferSiteDir
1734   into jalviewjsSiteDir
1735 }
1736
1737 task jalviewjsIDEj2s {
1738   group "JalviewJS in Eclipse"
1739   description "Creates the .j2s file"
1740   dependsOn jalviewjsCreateJ2sSettings
1741 }
1742
1743 task jalviewjsIDEBuildSite {
1744   group "JalviewJS in Eclipse"
1745   description "Copies the Eclipse transpiled site and unzips supporting zipfiles"
1746   dependsOn jalviewjsIDECopyTransferSite
1747   dependsOn jalviewjsPrepareSite
1748 }
1749
1750 task jalviewjsIDESiteClean {
1751   group "JalviewJS in Eclipse"
1752   description "Deletes the Eclipse transpiled site"
1753   dependsOn cleanJalviewjsSite
1754 }
1755
1756 task jalviewjsIDEServer {
1757   group "JalviewJS in Eclipse"
1758   description "Starts a webserver on localhost to test the website"
1759   dependsOn jalviewjsServer
1760 }
1761