1 /* Convention for properties. Read from gradle.properties, use lower_case_underlines for property names.
2 * For properties set within build.gradle, use camelCaseNoSpace.
4 import org.apache.tools.ant.filters.ReplaceTokens
5 import org.gradle.internal.os.OperatingSystem
6 import org.gradle.plugins.ide.internal.generator.PropertiesPersistableConfigurationObject
7 import org.gradle.api.internal.PropertiesTransformer
8 import org.gradle.util.ConfigureUtil
9 import org.gradle.plugins.ide.eclipse.model.Output
10 import org.gradle.plugins.ide.eclipse.model.Library
11 import java.security.MessageDigest
12 import groovy.transform.ExternalizeMethods
13 import groovy.util.XmlParser
14 import groovy.xml.XmlUtil
15 import com.vladsch.flexmark.util.ast.Node
16 import com.vladsch.flexmark.html.HtmlRenderer
17 import com.vladsch.flexmark.parser.Parser
18 import com.vladsch.flexmark.util.data.MutableDataSet
19 import com.vladsch.flexmark.ext.gfm.tasklist.TaskListExtension
20 import com.vladsch.flexmark.ext.tables.TablesExtension
21 import com.vladsch.flexmark.ext.gfm.strikethrough.StrikethroughExtension
22 import com.vladsch.flexmark.ext.autolink.AutolinkExtension
23 import com.vladsch.flexmark.ext.anchorlink.AnchorLinkExtension
24 import com.vladsch.flexmark.ext.toc.TocExtension
32 classpath "com.vladsch.flexmark:flexmark-all:0.62.0"
41 id "com.diffplug.gradle.spotless" version "3.28.0"
42 id 'com.github.johnrengelman.shadow' version '4.0.3'
43 id 'com.install4j.gradle' version '8.0.10'
44 id 'com.dorongold.task-tree' version '1.5' // only needed to display task dependency tree with gradle task1 [task2 ...] taskTree
45 id 'com.palantir.git-version' version '0.12.3'
55 // in ext the values are cast to Object. Ensure string values are cast as String (and not GStringImpl) for later use
56 def string(Object o) {
57 return o == null ? "" : o.toString()
60 def overrideProperties(String propsFileName, boolean output = false) {
61 if (propsFileName == null) {
64 def propsFile = file(propsFileName)
65 if (propsFile != null && propsFile.exists()) {
66 println("Using properties from file '${propsFileName}'")
68 def p = new Properties()
69 def localPropsFIS = new FileInputStream(propsFile)
75 if (project.hasProperty(key)) {
76 oldval = project.findProperty(key)
77 project.setProperty(key, val)
79 println("Overriding property '${key}' ('${oldval}') with ${file(propsFile).getName()} value '${val}'")
82 ext.setProperty(key, val)
84 println("Setting ext property '${key}' with ${file(propsFile).getName()}s value '${val}'")
88 } catch (Exception e) {
89 println("Exception reading local.properties")
96 jalviewDirAbsolutePath = file(jalviewDir).getAbsolutePath()
97 jalviewDirRelativePath = jalviewDir
99 getdownChannelName = CHANNEL.toLowerCase()
100 // default to "default". Currently only has different cosmetics for "develop", "release", "default"
101 propertiesChannelName = ["develop", "release", "test-release", "jalviewjs", "jalviewjs-release" ].contains(getdownChannelName) ? getdownChannelName : "default"
102 // Import channel_properties
103 channelDir = string("${jalviewDir}/${channel_properties_dir}/${propertiesChannelName}")
104 channelGradleProperties = string("${channelDir}/channel_gradle.properties")
105 overrideProperties(channelGradleProperties, false)
106 // local build environment properties
107 // can be "projectDir/local.properties"
108 overrideProperties("${projectDir}/local.properties", true)
109 // or "../projectDir_local.properties"
110 overrideProperties(projectDir.getParent() + "/" + projectDir.getName() + "_local.properties", true)
113 // Import releaseProps from the RELEASE file
114 // or a file specified via JALVIEW_RELEASE_FILE if defined
115 // Expect jalview.version and target release branch in jalview.release
116 def releaseProps = new Properties();
117 def releasePropFile = findProperty("JALVIEW_RELEASE_FILE");
118 def defaultReleasePropFile = "${jalviewDirAbsolutePath}/RELEASE";
120 (new File(releasePropFile!=null ? releasePropFile : defaultReleasePropFile)).withInputStream {
121 releaseProps.load(it)
123 } catch (Exception fileLoadError) {
124 throw new Error("Couldn't load release properties file "+(releasePropFile==null ? defaultReleasePropFile : "from custom location: releasePropFile"),fileLoadError);
127 // Set JALVIEW_VERSION if it is not already set
128 if (findProperty("JALVIEW_VERSION")==null || "".equals(JALVIEW_VERSION)) {
129 JALVIEW_VERSION = releaseProps.get("jalview.version")
132 // this property set when running Eclipse headlessly
133 j2sHeadlessBuildProperty = string("net.sf.j2s.core.headlessbuild")
134 // this property set by Eclipse
135 eclipseApplicationProperty = string("eclipse.application")
136 // CHECK IF RUNNING FROM WITHIN ECLIPSE
137 def eclipseApplicationPropertyVal = System.properties[eclipseApplicationProperty]
138 IN_ECLIPSE = eclipseApplicationPropertyVal != null && eclipseApplicationPropertyVal.startsWith("org.eclipse.ui.")
139 // BUT WITHOUT THE HEADLESS BUILD PROPERTY SET
140 if (System.properties[j2sHeadlessBuildProperty].equals("true")) {
141 println("Setting IN_ECLIPSE to ${IN_ECLIPSE} as System.properties['${j2sHeadlessBuildProperty}'] == '${System.properties[j2sHeadlessBuildProperty]}'")
145 println("WITHIN ECLIPSE IDE")
147 println("HEADLESS BUILD")
150 J2S_ENABLED = (project.hasProperty('j2s.compiler.status') && project['j2s.compiler.status'] != null && project['j2s.compiler.status'] == "enable")
152 println("J2S ENABLED")
155 System.properties.sort { it.key }.each {
156 key, val -> println("SYSTEM PROPERTY ${key}='${val}'")
159 if (false && IN_ECLIPSE) {
160 jalviewDir = jalviewDirAbsolutePath
165 buildDate = new Date().format("yyyyMMdd")
168 bareSourceDir = string(source_dir)
169 sourceDir = string("${jalviewDir}/${bareSourceDir}")
170 resourceDir = string("${jalviewDir}/${resource_dir}")
171 bareTestSourceDir = string(test_source_dir)
172 testDir = string("${jalviewDir}/${bareTestSourceDir}")
174 classesDir = string("${jalviewDir}/${classes_dir}")
177 useClover = clover.equals("true")
178 cloverBuildDir = "${buildDir}/clover"
179 cloverInstrDir = file("${cloverBuildDir}/clover-instr")
180 cloverClassesDir = file("${cloverBuildDir}/clover-classes")
181 cloverReportDir = file("${buildDir}/reports/clover")
182 cloverTestInstrDir = file("${cloverBuildDir}/clover-test-instr")
183 cloverTestClassesDir = file("${cloverBuildDir}/clover-test-classes")
184 //cloverTestClassesDir = cloverClassesDir
185 cloverDb = string("${cloverBuildDir}/clover.db")
187 testSourceDir = useClover ? cloverTestInstrDir : testDir
188 testClassesDir = useClover ? cloverTestClassesDir : "${jalviewDir}/${test_output_dir}"
190 getdownWebsiteDir = string("${jalviewDir}/${getdown_website_dir}/${JAVA_VERSION}")
192 buildProperties = null
194 // the following values might be overridden by the CHANNEL switch
195 getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
196 getdownAppBase = string("${getdown_channel_base}/${getdownDir}")
197 getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher}")
198 getdownAppDistDir = getdown_app_dir_alt
199 getdownImagesDir = string("${jalviewDir}/${getdown_images_dir}")
200 getdownSetAppBaseProperty = false // whether to pass the appbase and appdistdir to the application
201 reportRsyncCommand = false
202 jvlChannelName = CHANNEL.toLowerCase()
203 install4jSuffix = CHANNEL.substring(0, 1).toUpperCase() + CHANNEL.substring(1).toLowerCase(); // BUILD -> Build
204 install4jDMGDSStore = "${install4j_images_dir}/${install4j_dmg_ds_store}"
205 install4jDMGBackgroundImage = "${install4j_images_dir}/${install4j_dmg_background}"
206 install4jInstallerName = "${jalview_name} Non-Release Installer"
207 install4jExecutableName = install4j_executable_name
208 install4jExtraScheme = "jalviewx"
209 install4jMacIconsFile = string("${install4j_images_dir}/${install4j_mac_icons_file}")
210 install4jWindowsIconsFile = string("${install4j_images_dir}/${install4j_windows_icons_file}")
211 install4jPngIconFile = string("${install4j_images_dir}/${install4j_png_icon_file}")
212 install4jBackground = string("${install4j_images_dir}/${install4j_background}")
216 // TODO: get bamboo build artifact URL for getdown artifacts
217 getdown_channel_base = bamboo_channelbase
218 getdownChannelName = string("${bamboo_planKey}/${JAVA_VERSION}")
219 getdownAppBase = string("${bamboo_channelbase}/${bamboo_planKey}${bamboo_getdown_channel_suffix}/${JAVA_VERSION}")
220 jvlChannelName += "_${getdownChannelName}"
221 // automatically add the test group Not-bamboo for exclusion
222 if ("".equals(testng_excluded_groups)) {
223 testng_excluded_groups = "Not-bamboo"
225 install4jExtraScheme = "jalviewb"
228 case [ "RELEASE", "JALVIEWJS-RELEASE" ]:
229 getdownAppDistDir = getdown_app_dir_release
230 reportRsyncCommand = true
232 install4jInstallerName = "${jalview_name} Installer"
236 getdownChannelName = CHANNEL.toLowerCase()+"/${JALVIEW_VERSION}"
237 getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
238 getdownAppBase = string("${getdown_channel_base}/${getdownDir}")
239 if (!file("${ARCHIVEDIR}/${package_dir}").exists()) {
240 throw new GradleException("Must provide an ARCHIVEDIR value to produce an archive distribution")
242 package_dir = string("${ARCHIVEDIR}/${package_dir}")
243 buildProperties = string("${ARCHIVEDIR}/${classes_dir}/${build_properties_file}")
246 reportRsyncCommand = true
247 install4jExtraScheme = "jalviewa"
251 getdownChannelName = string("archive/${JALVIEW_VERSION}")
252 getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
253 getdownAppBase = file(getdownWebsiteDir).toURI().toString()
254 if (!file("${ARCHIVEDIR}/${package_dir}").exists()) {
255 throw new GradleException("Must provide an ARCHIVEDIR value to produce an archive distribution")
257 package_dir = string("${ARCHIVEDIR}/${package_dir}")
258 buildProperties = string("${ARCHIVEDIR}/${classes_dir}/${build_properties_file}")
261 reportRsyncCommand = true
262 getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
263 install4jSuffix = "Archive"
264 install4jExtraScheme = "jalviewa"
268 reportRsyncCommand = true
269 getdownSetAppBaseProperty = true
270 // DEVELOP-RELEASE is usually associated with a Jalview release series so set the version
271 JALVIEW_VERSION=JALVIEW_VERSION+"-d${buildDate}"
273 install4jSuffix = "Develop"
274 install4jExtraScheme = "jalviewd"
275 install4jInstallerName = "${jalview_name} Develop Installer"
279 reportRsyncCommand = true
280 // Don't ignore transpile errors for release build
281 if (jalviewjs_ignore_transpile_errors.equals("true")) {
282 jalviewjs_ignore_transpile_errors = "false"
283 println("Setting jalviewjs_ignore_transpile_errors to 'false'")
285 JALVIEW_VERSION = JALVIEW_VERSION+"-test"
286 install4jSuffix = "Test"
287 install4jExtraScheme = "jalviewt"
288 install4jInstallerName = "${jalview_name} Test Installer"
291 case ~/^SCRATCH(|-[-\w]*)$/:
292 getdownChannelName = CHANNEL
293 JALVIEW_VERSION = JALVIEW_VERSION+"-"+CHANNEL
295 getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
296 getdownAppBase = string("${getdown_channel_base}/${getdownDir}")
297 reportRsyncCommand = true
298 install4jSuffix = "Scratch"
302 if (!file("${LOCALDIR}").exists()) {
303 throw new GradleException("Must provide a LOCALDIR value to produce a local distribution")
305 getdownAppBase = file(file("${LOCALDIR}").getAbsolutePath()).toURI().toString()
306 getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
308 JALVIEW_VERSION = "TEST"
309 install4jSuffix = "Test-Local"
310 install4jExtraScheme = "jalviewt"
311 install4jInstallerName = "${jalview_name} Test Installer"
314 case [ "LOCAL", "JALVIEWJS" ]:
315 JALVIEW_VERSION = "TEST"
316 getdownAppBase = file(getdownWebsiteDir).toURI().toString()
317 getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
318 install4jExtraScheme = "jalviewl"
321 default: // something wrong specified
322 throw new GradleException("CHANNEL must be one of BUILD, RELEASE, ARCHIVE, DEVELOP, TEST-RELEASE, SCRATCH-..., LOCAL [default]")
326 // override getdownAppBase if requested
327 if (findProperty("getdown_appbase_override") != null) {
328 // revert to LOCAL if empty string
329 if (string(getdown_appbase_override) == "") {
330 getdownAppBase = file(getdownWebsiteDir).toURI().toString()
331 getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
332 } else if (string(getdown_appbase_override).startsWith("file://")) {
333 getdownAppBase = string(getdown_appbase_override)
334 getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
336 getdownAppBase = string(getdown_appbase_override)
338 println("Overriding getdown appbase with '${getdownAppBase}'")
340 // sanitise file name for jalview launcher file for this channel
341 jvlChannelName = jvlChannelName.replaceAll("[^\\w\\-]+", "_")
342 // install4j application and folder names
343 if (install4jSuffix == "") {
344 install4jApplicationName = "${jalview_name}"
345 install4jBundleId = "${install4j_bundle_id}"
346 install4jWinApplicationId = install4j_release_win_application_id
348 install4jApplicationName = "${jalview_name} ${install4jSuffix}"
349 install4jBundleId = "${install4j_bundle_id}-" + install4jSuffix.toLowerCase()
350 // add int hash of install4jSuffix to the last part of the application_id
351 def id = install4j_release_win_application_id
352 def idsplitreverse = id.split("-").reverse()
353 idsplitreverse[0] = idsplitreverse[0].toInteger() + install4jSuffix.hashCode()
354 install4jWinApplicationId = idsplitreverse.reverse().join("-")
356 // sanitise folder and id names
357 // install4jApplicationFolder = e.g. "Jalview Build"
358 install4jApplicationFolder = install4jApplicationName
359 .replaceAll("[\"'~:/\\\\\\s]", "_") // replace all awkward filename chars " ' ~ : / \
360 .replaceAll("_+", "_") // collapse __
361 install4jInternalId = install4jApplicationName
363 .replaceAll("[^\\w\\-\\.]", "_") // replace other non [alphanumeric,_,-,.]
364 .replaceAll("_+", "") // collapse __
365 //.replaceAll("_*-_*", "-") // collapse _-_
366 install4jUnixApplicationFolder = install4jApplicationName
368 .replaceAll("[^\\w\\-\\.]", "_") // replace other non [alphanumeric,_,-,.]
369 .replaceAll("_+", "_") // collapse __
370 .replaceAll("_*-_*", "-") // collapse _-_
373 getdownAppDir = string("${getdownWebsiteDir}/${getdownAppDistDir}")
374 //getdownJ11libDir = "${getdownWebsiteDir}/${getdown_j11lib_dir}"
375 getdownResourceDir = string("${getdownWebsiteDir}/${getdown_resource_dir}")
376 getdownInstallDir = string("${getdownWebsiteDir}/${getdown_install_dir}")
377 getdownFilesDir = string("${jalviewDir}/${getdown_files_dir}/${JAVA_VERSION}/")
378 getdownFilesInstallDir = string("${getdownFilesDir}/${getdown_install_dir}")
379 /* compile without modules -- using classpath libraries
380 modules_compileClasspath = fileTree(dir: "${jalviewDir}/${j11modDir}", include: ["*.jar"])
381 modules_runtimeClasspath = modules_compileClasspath
383 def details = versionDetails()
384 gitHash = details.gitHash
385 gitBranch = details.branchName
387 println("Using a ${CHANNEL} profile.")
389 additional_compiler_args = []
390 // configure classpath/args for j8/j11 compilation
391 if (JAVA_VERSION.equals("1.8")) {
392 JAVA_INTEGER_VERSION = string("8")
395 libDistDir = j8libDir
396 compile_source_compatibility = 1.8
397 compile_target_compatibility = 1.8
398 // these are getdown.txt properties defined dependent on the JAVA_VERSION
399 getdownAltJavaMinVersion = string(findProperty("getdown_alt_java8_min_version"))
400 getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java8_max_version"))
401 // this property is assigned below and expanded to multiple lines in the getdown task
402 getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java8_txt_multi_java_location"))
403 // this property is for the Java library used in eclipse
404 eclipseJavaRuntimeName = string("JavaSE-1.8")
405 } else if (JAVA_VERSION.equals("11")) {
406 JAVA_INTEGER_VERSION = string("11")
408 libDistDir = j11libDir
409 compile_source_compatibility = 11
410 compile_target_compatibility = 11
411 getdownAltJavaMinVersion = string(findProperty("getdown_alt_java11_min_version"))
412 getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java11_max_version"))
413 getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java11_txt_multi_java_location"))
414 eclipseJavaRuntimeName = string("JavaSE-11")
415 /* compile without modules -- using classpath libraries
416 additional_compiler_args += [
417 '--module-path', modules_compileClasspath.asPath,
418 '--add-modules', j11modules
421 } else if (JAVA_VERSION.equals("12") || JAVA_VERSION.equals("13")) {
422 JAVA_INTEGER_VERSION = JAVA_VERSION
424 libDistDir = j11libDir
425 compile_source_compatibility = JAVA_VERSION
426 compile_target_compatibility = JAVA_VERSION
427 getdownAltJavaMinVersion = string(findProperty("getdown_alt_java11_min_version"))
428 getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java11_max_version"))
429 getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java11_txt_multi_java_location"))
430 eclipseJavaRuntimeName = string("JavaSE-11")
431 /* compile without modules -- using classpath libraries
432 additional_compiler_args += [
433 '--module-path', modules_compileClasspath.asPath,
434 '--add-modules', j11modules
438 throw new GradleException("JAVA_VERSION=${JAVA_VERSION} not currently supported by Jalview")
443 JAVA_MIN_VERSION = JAVA_VERSION
444 JAVA_MAX_VERSION = JAVA_VERSION
445 def jreInstallsDir = string(jre_installs_dir)
446 if (jreInstallsDir.startsWith("~/")) {
447 jreInstallsDir = System.getProperty("user.home") + jreInstallsDir.substring(1)
449 macosJavaVMDir = string("${jreInstallsDir}/jre-${JAVA_INTEGER_VERSION}-mac-x64/jre")
450 macosJavaVMTgz = string("${jreInstallsDir}/tgz/jre-${JAVA_INTEGER_VERSION}-mac-x64.tar.gz")
451 windowsJavaVMDir = string("${jreInstallsDir}/jre-${JAVA_INTEGER_VERSION}-windows-x64/jre")
452 windowsJavaVMTgz = string("${jreInstallsDir}/tgz/jre-${JAVA_INTEGER_VERSION}-windows-x64.tar.gz")
453 linuxJavaVMDir = string("${jreInstallsDir}/jre-${JAVA_INTEGER_VERSION}-linux-x64/jre")
454 linuxJavaVMTgz = string("${jreInstallsDir}/tgz/jre-${JAVA_INTEGER_VERSION}-linux-x64.tar.gz")
455 install4jDir = string("${jalviewDir}/${install4j_utils_dir}")
456 install4jConfFileName = string("jalview-install4j-conf.install4j")
457 install4jConfFile = file("${install4jDir}/${install4jConfFileName}")
458 install4jHomeDir = install4j_home_dir
459 if (install4jHomeDir.startsWith("~/")) {
460 install4jHomeDir = System.getProperty("user.home") + install4jHomeDir.substring(1)
463 resourceBuildDir = string("${buildDir}/resources")
464 resourcesBuildDir = string("${resourceBuildDir}/resources_build")
465 helpBuildDir = string("${resourceBuildDir}/help_build")
466 docBuildDir = string("${resourceBuildDir}/doc_build")
468 if (buildProperties == null) {
469 buildProperties = string("${resourcesBuildDir}/${build_properties_file}")
471 buildingHTML = string("${jalviewDir}/${doc_dir}/building.html")
472 helpParentDir = string("${jalviewDir}/${help_parent_dir}")
473 helpSourceDir = string("${helpParentDir}/${help_dir}")
474 helpFile = string("${helpBuildDir}/${help_dir}/help.jhm")
477 relativeBuildDir = file(jalviewDirAbsolutePath).toPath().relativize(buildDir.toPath())
478 jalviewjsBuildDir = string("${relativeBuildDir}/jalviewjs")
479 jalviewjsSiteDir = string("${jalviewjsBuildDir}/${jalviewjs_site_dir}")
481 jalviewjsTransferSiteJsDir = string(jalviewjsSiteDir)
483 jalviewjsTransferSiteJsDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_js")
485 jalviewjsTransferSiteLibDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_lib")
486 jalviewjsTransferSiteSwingJsDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_swingjs")
487 jalviewjsTransferSiteCoreDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_core")
488 jalviewjsJalviewCoreHtmlFile = string("")
489 jalviewjsJalviewCoreName = string(jalviewjs_core_name)
490 jalviewjsCoreClasslists = []
491 jalviewjsJalviewTemplateName = string(jalviewjs_name)
492 jalviewjsJ2sSettingsFileName = string("${jalviewDir}/${jalviewjs_j2s_settings}")
493 jalviewjsJ2sAltSettingsFileName = string("${jalviewDir}/${jalviewjs_j2s_alt_settings}")
494 jalviewjsJ2sProps = null
495 jalviewjsJ2sPlugin = jalviewjs_j2s_plugin
497 eclipseWorkspace = null
498 eclipseBinary = string("")
499 eclipseVersion = string("")
509 outputDir = file(classesDir)
513 srcDirs = [ resourcesBuildDir, docBuildDir, helpBuildDir ]
516 compileClasspath = files(sourceSets.main.java.outputDir)
517 compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
519 runtimeClasspath = compileClasspath
520 runtimeClasspath += files(sourceSets.main.resources.srcDirs)
525 srcDirs cloverInstrDir
526 outputDir = cloverClassesDir
530 srcDirs = sourceSets.main.resources.srcDirs
533 compileClasspath = files( sourceSets.clover.java.outputDir )
534 //compileClasspath += files( testClassesDir )
535 compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
536 compileClasspath += fileTree(dir: "${jalviewDir}/${clover_lib_dir}", include: ["*.jar"])
537 compileClasspath += fileTree(dir: "${jalviewDir}/${utils_dir}/testnglibs", include: ["**/*.jar"])
539 runtimeClasspath = compileClasspath
544 srcDirs testSourceDir
545 outputDir = file(testClassesDir)
549 srcDirs = useClover ? sourceSets.clover.resources.srcDirs : sourceSets.main.resources.srcDirs
552 compileClasspath = files( sourceSets.test.java.outputDir )
553 compileClasspath += useClover ? sourceSets.clover.compileClasspath : sourceSets.main.compileClasspath
554 compileClasspath += fileTree(dir: "${jalviewDir}/${utils_dir}/testnglibs", include: ["**/*.jar"])
556 runtimeClasspath = compileClasspath
557 runtimeClasspath += files(sourceSets.test.resources.srcDirs)
563 // eclipse project and settings files creation, also used by buildship
566 name = eclipse_project_name
568 natures 'org.eclipse.jdt.core.javanature',
569 'org.eclipse.jdt.groovy.core.groovyNature',
570 'org.eclipse.buildship.core.gradleprojectnature'
572 buildCommand 'org.eclipse.jdt.core.javabuilder'
573 buildCommand 'org.eclipse.buildship.core.gradleprojectbuilder'
577 //defaultOutputDir = sourceSets.main.java.outputDir
578 configurations.each{ c->
579 if (c.isCanBeResolved()) {
580 minusConfigurations += [c]
584 plusConfigurations = [ ]
588 def removeTheseToo = []
589 HashMap<String, Boolean> alreadyAddedSrcPath = new HashMap<>();
590 cp.entries.each { entry ->
591 // This conditional removes all src classpathentries that a) have already been added or b) aren't "src" or "test".
592 // e.g. this removes the resources dir being copied into bin/main, bin/test AND bin/clover
593 // we add the resources and help/help dirs in as libs afterwards (see below)
594 if (entry.kind == 'src') {
595 if (alreadyAddedSrcPath.getAt(entry.path) || !(entry.path == bareSourceDir || entry.path == bareTestSourceDir)) {
596 removeTheseToo += entry
598 alreadyAddedSrcPath.putAt(entry.path, true)
603 cp.entries.removeAll(removeTheseToo)
605 //cp.entries += new Output("${eclipse_bin_dir}/main")
606 if (file(helpParentDir).isDirectory()) {
607 cp.entries += new Library(fileReference(helpParentDir))
609 if (file(resourceDir).isDirectory()) {
610 cp.entries += new Library(fileReference(resourceDir))
613 HashMap<String, Boolean> alreadyAddedLibPath = new HashMap<>();
615 sourceSets.main.compileClasspath.findAll { it.name.endsWith(".jar") }.any {
616 //don't want to add outputDir as eclipse is using its own output dir in bin/main
617 if (it.isDirectory() || ! it.exists()) {
618 // don't add dirs to classpath, especially if they don't exist
619 return false // groovy "continue" in .any closure
621 def itPath = it.toString()
622 if (itPath.startsWith("${jalviewDirAbsolutePath}/")) {
623 // make relative path
624 itPath = itPath.substring(jalviewDirAbsolutePath.length()+1)
626 if (alreadyAddedLibPath.get(itPath)) {
627 //println("Not adding duplicate entry "+itPath)
629 //println("Adding entry "+itPath)
630 cp.entries += new Library(fileReference(itPath))
631 alreadyAddedLibPath.put(itPath, true)
635 sourceSets.test.compileClasspath.findAll { it.name.endsWith(".jar") }.any {
636 //no longer want to add outputDir as eclipse is using its own output dir in bin/main
637 if (it.isDirectory() || ! it.exists()) {
638 // don't add dirs to classpath
639 return false // groovy "continue" in .any closure
642 def itPath = it.toString()
643 if (itPath.startsWith("${jalviewDirAbsolutePath}/")) {
644 itPath = itPath.substring(jalviewDirAbsolutePath.length()+1)
646 if (alreadyAddedLibPath.get(itPath)) {
649 def lib = new Library(fileReference(itPath))
650 lib.entryAttributes["test"] = "true"
652 alreadyAddedLibPath.put(itPath, true)
660 containers 'org.eclipse.buildship.core.gradleclasspathcontainer'
665 // for the IDE, use java 11 compatibility
666 sourceCompatibility = compile_source_compatibility
667 targetCompatibility = compile_target_compatibility
668 javaRuntimeName = eclipseJavaRuntimeName
670 // add in jalview project specific properties/preferences into eclipse core preferences
672 withProperties { props ->
673 def jalview_prefs = new Properties()
674 def ins = new FileInputStream("${jalviewDirAbsolutePath}/${eclipse_extra_jdt_prefs_file}")
675 jalview_prefs.load(ins)
677 jalview_prefs.forEach { t, v ->
678 if (props.getAt(t) == null) {
682 // codestyle file -- overrides previous formatter prefs
683 def csFile = file("${jalviewDirAbsolutePath}/${eclipse_codestyle_file}")
684 if (csFile.exists()) {
685 XmlParser parser = new XmlParser()
686 def profiles = parser.parse(csFile)
687 def profile = profiles.'profile'.find { p -> (p.'@kind' == "CodeFormatterProfile" && p.'@name' == "Jalview") }
688 if (profile != null) {
689 profile.'setting'.each { s ->
691 def value = s.'@value'
692 if (id != null && value != null) {
693 props.putAt(id, value)
704 // Don't want these to be activated if in headless build
705 synchronizationTasks "eclipseSynchronizationTask"
706 //autoBuildTasks "eclipseAutoBuildTask"
712 /* hack to change eclipse prefs in .settings files other than org.eclipse.jdt.core.prefs */
713 // Class to allow updating arbitrary properties files
714 class PropertiesFile extends PropertiesPersistableConfigurationObject {
715 public PropertiesFile(PropertiesTransformer t) { super(t); }
716 @Override protected void load(Properties properties) { }
717 @Override protected void store(Properties properties) { }
718 @Override protected String getDefaultResourceName() { return ""; }
719 // This is necessary, because PropertiesPersistableConfigurationObject fails
720 // if no default properties file exists.
721 @Override public void loadDefaults() { load(new StringBufferInputStream("")); }
724 // Task to update arbitrary properties files (set outputFile)
725 class PropertiesFileTask extends PropertiesGeneratorTask<PropertiesFile> {
726 private final PropertiesFileContentMerger file;
727 public PropertiesFileTask() { file = new PropertiesFileContentMerger(getTransformer()); }
728 protected PropertiesFile create() { return new PropertiesFile(getTransformer()); }
729 protected void configure(PropertiesFile props) {
730 file.getBeforeMerged().execute(props); file.getWhenMerged().execute(props);
732 public void file(Closure closure) { ConfigureUtil.configure(closure, file); }
735 task eclipseUIPreferences(type: PropertiesFileTask) {
736 description = "Generate Eclipse additional settings"
737 def filename = "org.eclipse.jdt.ui.prefs"
738 outputFile = "$projectDir/.settings/${filename}" as File
741 it.load new FileInputStream("$projectDir/utils/eclipse/${filename}" as String)
746 task eclipseGroovyCorePreferences(type: PropertiesFileTask) {
747 description = "Generate Eclipse additional settings"
748 def filename = "org.eclipse.jdt.groovy.core.prefs"
749 outputFile = "$projectDir/.settings/${filename}" as File
752 it.load new FileInputStream("$projectDir/utils/eclipse/${filename}" as String)
757 task eclipseAllPreferences {
759 dependsOn eclipseUIPreferences
760 dependsOn eclipseGroovyCorePreferences
763 eclipseUIPreferences.mustRunAfter eclipseJdt
764 eclipseGroovyCorePreferences.mustRunAfter eclipseJdt
766 /* end of eclipse preferences hack */
774 delete cloverBuildDir
775 delete cloverReportDir
780 task cloverInstrJava(type: JavaExec) {
781 group = "Verification"
782 description = "Create clover instrumented source java files"
784 dependsOn cleanClover
786 inputs.files(sourceSets.main.allJava)
787 outputs.dir(cloverInstrDir)
789 //classpath = fileTree(dir: "${jalviewDir}/${clover_lib_dir}", include: ["*.jar"])
790 classpath = sourceSets.clover.compileClasspath
791 main = "com.atlassian.clover.CloverInstr"
799 cloverInstrDir.getPath(),
801 def srcFiles = sourceSets.main.allJava.files
804 { file -> file.absolutePath }
807 args argsList.toArray()
810 delete cloverInstrDir
811 println("Clover: About to instrument "+srcFiles.size() +" files")
816 task cloverInstrTests(type: JavaExec) {
817 group = "Verification"
818 description = "Create clover instrumented source test files"
820 dependsOn cleanClover
822 inputs.files(testDir)
823 outputs.dir(cloverTestInstrDir)
825 classpath = sourceSets.clover.compileClasspath
826 main = "com.atlassian.clover.CloverInstr"
836 cloverTestInstrDir.getPath(),
838 args argsList.toArray()
841 delete cloverTestInstrDir
842 println("Clover: About to instrument test files")
848 group = "Verification"
849 description = "Create clover instrumented all source files"
851 dependsOn cloverInstrJava
852 dependsOn cloverInstrTests
856 cloverClasses.dependsOn cloverInstr
859 task cloverConsoleReport(type: JavaExec) {
860 group = "Verification"
861 description = "Creates clover console report"
864 file(cloverDb).exists()
867 inputs.dir cloverClassesDir
869 classpath = sourceSets.clover.runtimeClasspath
870 main = "com.atlassian.clover.reporters.console.ConsoleReporter"
872 if (cloverreport_mem.length() > 0) {
873 maxHeapSize = cloverreport_mem
875 if (cloverreport_jvmargs.length() > 0) {
876 jvmArgs Arrays.asList(cloverreport_jvmargs.split(" "))
886 args argsList.toArray()
890 task cloverHtmlReport(type: JavaExec) {
891 group = "Verification"
892 description = "Creates clover HTML report"
895 file(cloverDb).exists()
898 def cloverHtmlDir = cloverReportDir
899 inputs.dir cloverClassesDir
900 outputs.dir cloverHtmlDir
902 classpath = sourceSets.clover.runtimeClasspath
903 main = "com.atlassian.clover.reporters.html.HtmlReporter"
905 if (cloverreport_mem.length() > 0) {
906 maxHeapSize = cloverreport_mem
908 if (cloverreport_jvmargs.length() > 0) {
909 jvmArgs Arrays.asList(cloverreport_jvmargs.split(" "))
920 if (cloverreport_html_options.length() > 0) {
921 argsList += cloverreport_html_options.split(" ")
924 args argsList.toArray()
928 task cloverXmlReport(type: JavaExec) {
929 group = "Verification"
930 description = "Creates clover XML report"
933 file(cloverDb).exists()
936 def cloverXmlFile = "${cloverReportDir}/clover.xml"
937 inputs.dir cloverClassesDir
938 outputs.file cloverXmlFile
940 classpath = sourceSets.clover.runtimeClasspath
941 main = "com.atlassian.clover.reporters.xml.XMLReporter"
943 if (cloverreport_mem.length() > 0) {
944 maxHeapSize = cloverreport_mem
946 if (cloverreport_jvmargs.length() > 0) {
947 jvmArgs Arrays.asList(cloverreport_jvmargs.split(" "))
958 if (cloverreport_xml_options.length() > 0) {
959 argsList += cloverreport_xml_options.split(" ")
962 args argsList.toArray()
967 group = "Verification"
968 description = "Creates clover reports"
970 dependsOn cloverXmlReport
971 dependsOn cloverHtmlReport
978 sourceCompatibility = compile_source_compatibility
979 targetCompatibility = compile_target_compatibility
980 options.compilerArgs += additional_compiler_args
981 print ("Setting target compatibility to "+targetCompatibility+"\n")
983 //classpath += configurations.cloverRuntime
989 // JBP->BS should the print statement in doFirst refer to compile_target_compatibility ?
990 sourceCompatibility = compile_source_compatibility
991 targetCompatibility = compile_target_compatibility
992 options.compilerArgs = additional_compiler_args
993 options.encoding = "UTF-8"
995 print ("Setting target compatibility to "+compile_target_compatibility+"\n")
1002 sourceCompatibility = compile_source_compatibility
1003 targetCompatibility = compile_target_compatibility
1004 options.compilerArgs = additional_compiler_args
1006 print ("Setting target compatibility to "+targetCompatibility+"\n")
1013 delete sourceSets.main.java.outputDir
1019 dependsOn cleanClover
1021 delete sourceSets.test.java.outputDir
1026 // format is a string like date.format("dd MMMM yyyy")
1027 def getDate(format) {
1028 def date = new Date()
1029 return date.format(format)
1033 def convertMdToHtml (FileTree mdFiles, File cssFile) {
1034 MutableDataSet options = new MutableDataSet()
1036 def extensions = new ArrayList<>()
1037 extensions.add(AnchorLinkExtension.create())
1038 extensions.add(AutolinkExtension.create())
1039 extensions.add(StrikethroughExtension.create())
1040 extensions.add(TaskListExtension.create())
1041 extensions.add(TablesExtension.create())
1042 extensions.add(TocExtension.create())
1044 options.set(Parser.EXTENSIONS, extensions)
1046 // set GFM table parsing options
1047 options.set(TablesExtension.WITH_CAPTION, false)
1048 options.set(TablesExtension.COLUMN_SPANS, false)
1049 options.set(TablesExtension.MIN_HEADER_ROWS, 1)
1050 options.set(TablesExtension.MAX_HEADER_ROWS, 1)
1051 options.set(TablesExtension.APPEND_MISSING_COLUMNS, true)
1052 options.set(TablesExtension.DISCARD_EXTRA_COLUMNS, true)
1053 options.set(TablesExtension.HEADER_SEPARATOR_COLUMN_MATCH, true)
1055 options.set(AnchorLinkExtension.ANCHORLINKS_SET_ID, false)
1056 options.set(AnchorLinkExtension.ANCHORLINKS_ANCHOR_CLASS, "anchor")
1057 options.set(AnchorLinkExtension.ANCHORLINKS_SET_NAME, true)
1058 options.set(AnchorLinkExtension.ANCHORLINKS_TEXT_PREFIX, "<span class=\"octicon octicon-link\"></span>")
1060 Parser parser = Parser.builder(options).build()
1061 HtmlRenderer renderer = HtmlRenderer.builder(options).build()
1063 mdFiles.each { mdFile ->
1064 // add table of contents
1065 def mdText = "[TOC]\n"+mdFile.text
1067 // grab the first top-level title
1069 def titleRegex = /(?m)^#(\s+|([^#]))(.*)/
1070 def matcher = mdText =~ titleRegex
1071 if (matcher.size() > 0) {
1072 // matcher[0][2] is the first character of the title if there wasn't any whitespace after the #
1073 title = (matcher[0][2] != null ? matcher[0][2] : "")+matcher[0][3]
1075 // or use the filename if none found
1076 if (title == null) {
1077 title = mdFile.getName()
1080 Node document = parser.parse(mdText)
1081 String htmlBody = renderer.render(document)
1082 def htmlText = '''<html>
1083 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1084 <html xmlns="http://www.w3.org/1999/xhtml">
1086 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1087 <meta http-equiv="Content-Style-Type" content="text/css" />
1088 <meta name="generator" content="flexmark" />
1090 htmlText += ((title != null) ? " <title>${title}</title>" : '' )
1092 <style type="text/css">code{white-space: pre;}</style>
1094 htmlText += ((cssFile != null) ? cssFile.text : '')
1095 htmlText += '''</head>
1098 htmlText += htmlBody
1104 def htmlFilePath = mdFile.getPath().replaceAll(/\..*?$/, ".html")
1105 def htmlFile = file(htmlFilePath)
1106 println("Creating ${htmlFilePath}")
1107 htmlFile.text = htmlText
1112 task copyDocs(type: Copy) {
1113 def inputDir = "${jalviewDir}/${doc_dir}"
1114 def outputDir = "${docBuildDir}/${doc_dir}"
1118 include('**/*.html')
1120 filter(ReplaceTokens,
1124 'Version-Rel': JALVIEW_VERSION,
1125 'Year-Rel': getDate("yyyy")
1132 exclude('**/*.html')
1137 inputs.dir(inputDir)
1138 outputs.dir(outputDir)
1142 task convertMdFiles {
1144 def mdFiles = fileTree(dir: docBuildDir, include: "**/*.md")
1145 def cssFile = file("${jalviewDir}/${flexmark_css}")
1148 convertMdToHtml(mdFiles, cssFile)
1151 inputs.files(mdFiles)
1152 inputs.file(cssFile)
1155 mdFiles.each { mdFile ->
1156 def htmlFilePath = mdFile.getPath().replaceAll(/\..*?$/, ".html")
1157 htmlFiles.add(file(htmlFilePath))
1159 outputs.files(htmlFiles)
1163 task copyHelp(type: Copy) {
1164 def inputDir = helpSourceDir
1165 def outputDir = "${helpBuildDir}/${help_dir}"
1169 include('**/*.html')
1173 filter(ReplaceTokens,
1177 'Version-Rel': JALVIEW_VERSION,
1178 'Year-Rel': getDate("yyyy")
1185 exclude('**/*.html')
1192 inputs.dir(inputDir)
1193 outputs.files(helpFile)
1194 outputs.dir(outputDir)
1198 task copyResources(type: Copy) {
1200 description = "Copy (and make text substitutions in) the resources dir to the build area"
1202 def inputDir = resourceDir
1203 def outputDir = resourcesBuildDir
1207 include('**/*.html')
1209 filter(ReplaceTokens,
1213 'Version-Rel': JALVIEW_VERSION,
1214 'Year-Rel': getDate("yyyy")
1221 exclude('**/*.html')
1226 inputs.dir(inputDir)
1227 outputs.dir(outputDir)
1230 task copyChannelResources(type: Copy) {
1231 dependsOn copyResources
1233 description = "Copy the channel resources dir to the build resources area"
1235 def inputDir = "${channelDir}/${resource_dir}"
1236 def outputDir = resourcesBuildDir
1240 inputs.dir(inputDir)
1241 outputs.dir(outputDir)
1244 task createBuildProperties(type: WriteProperties) {
1245 dependsOn copyResources
1247 description = "Create the ${buildProperties} file"
1249 inputs.dir(sourceDir)
1250 inputs.dir(resourcesBuildDir)
1251 outputFile (buildProperties)
1252 // taking time specific comment out to allow better incremental builds
1253 comment "--Jalview Build Details--\n"+getDate("yyyy-MM-dd HH:mm:ss")
1254 //comment "--Jalview Build Details--\n"+getDate("yyyy-MM-dd")
1255 property "BUILD_DATE", getDate("HH:mm:ss dd MMMM yyyy")
1256 property "VERSION", JALVIEW_VERSION
1257 property "INSTALLATION", INSTALLATION+" git-commit:"+gitHash+" ["+gitBranch+"]"
1258 if (getdownSetAppBaseProperty) {
1259 property "GETDOWNAPPBASE", getdownAppBase
1260 property "GETDOWNAPPDISTDIR", getdownAppDistDir
1262 outputs.file(outputFile)
1266 task buildIndices(type: JavaExec) {
1268 classpath = sourceSets.main.compileClasspath
1269 main = "com.sun.java.help.search.Indexer"
1270 workingDir = "${helpBuildDir}/${help_dir}"
1273 inputs.dir("${workingDir}/${argDir}")
1275 outputs.dir("${classesDir}/doc")
1276 outputs.dir("${classesDir}/help")
1277 outputs.file("${workingDir}/JavaHelpSearch/DOCS")
1278 outputs.file("${workingDir}/JavaHelpSearch/DOCS.TAB")
1279 outputs.file("${workingDir}/JavaHelpSearch/OFFSETS")
1280 outputs.file("${workingDir}/JavaHelpSearch/POSITIONS")
1281 outputs.file("${workingDir}/JavaHelpSearch/SCHEMA")
1282 outputs.file("${workingDir}/JavaHelpSearch/TMAP")
1285 task buildResources {
1286 dependsOn copyResources
1287 dependsOn copyChannelResources
1288 dependsOn createBuildProperties
1292 dependsOn buildResources
1295 dependsOn convertMdFiles
1296 dependsOn buildIndices
1300 compileJava.dependsOn prepare
1301 run.dependsOn compileJava
1302 //run.dependsOn prepare
1305 //testReportDirName = "test-reports" // note that test workingDir will be $jalviewDir
1310 dependsOn cloverClasses
1312 dependsOn compileJava //?
1316 includeGroups testng_groups
1317 excludeGroups testng_excluded_groups
1319 useDefaultListeners=true
1322 maxHeapSize = "1024m"
1324 workingDir = jalviewDir
1325 def testLaf = project.findProperty("test_laf")
1326 if (testLaf != null) {
1327 println("Setting Test LaF to '${testLaf}'")
1328 systemProperty "laf", testLaf
1330 def testHiDPIScale = project.findProperty("test_HiDPIScale")
1331 if (testHiDPIScale != null) {
1332 println("Setting Test HiDPI Scale to '${testHiDPIScale}'")
1333 systemProperty "sun.java2d.uiScale", testHiDPIScale
1335 sourceCompatibility = compile_source_compatibility
1336 targetCompatibility = compile_target_compatibility
1337 jvmArgs += additional_compiler_args
1341 println("Running tests " + (useClover?"WITH":"WITHOUT") + " clover")
1347 task compileLinkCheck(type: JavaCompile) {
1349 classpath = files("${jalviewDir}/${utils_dir}")
1350 destinationDir = file("${jalviewDir}/${utils_dir}")
1351 source = fileTree(dir: "${jalviewDir}/${utils_dir}", include: ["HelpLinksChecker.java", "BufferedLineReader.java"])
1353 inputs.file("${jalviewDir}/${utils_dir}/HelpLinksChecker.java")
1354 inputs.file("${jalviewDir}/${utils_dir}/HelpLinksChecker.java")
1355 outputs.file("${jalviewDir}/${utils_dir}/HelpLinksChecker.class")
1356 outputs.file("${jalviewDir}/${utils_dir}/BufferedLineReader.class")
1360 task linkCheck(type: JavaExec) {
1362 dependsOn compileLinkCheck
1364 def helpLinksCheckerOutFile = file("${jalviewDir}/${utils_dir}/HelpLinksChecker.out")
1365 classpath = files("${jalviewDir}/${utils_dir}")
1366 main = "HelpLinksChecker"
1367 workingDir = jalviewDir
1368 args = [ "${helpBuildDir}/${help_dir}", "-nointernet" ]
1370 def outFOS = new FileOutputStream(helpLinksCheckerOutFile, false) // false == don't append
1372 standardOutput = new org.apache.tools.ant.util.TeeOutputStream(
1375 errorOutput = new org.apache.tools.ant.util.TeeOutputStream(
1379 inputs.dir(helpBuildDir)
1380 outputs.file(helpLinksCheckerOutFile)
1384 // import the pubhtmlhelp target
1385 ant.properties.basedir = "${jalviewDir}"
1386 ant.properties.helpBuildDir = "${helpBuildDir}/${help_dir}"
1387 ant.importBuild "${utils_dir}/publishHelp.xml"
1390 task cleanPackageDir(type: Delete) {
1392 delete fileTree(dir: "${jalviewDir}/${package_dir}", include: "*.jar")
1402 attributes "Main-Class": main_class,
1403 "Permissions": "all-permissions",
1404 "Application-Name": install4jApplicationName,
1405 "Codebase": application_codebase,
1406 "Implementation-Version": JALVIEW_VERSION
1409 def outputDir = "${jalviewDir}/${package_dir}"
1410 destinationDirectory = file(outputDir)
1411 archiveFileName = rootProject.name+".jar"
1417 exclude "**/*.jar.*"
1419 inputs.dir(sourceSets.main.java.outputDir)
1420 sourceSets.main.resources.srcDirs.each{ dir ->
1423 outputs.file("${outputDir}/${archiveFileName}")
1427 task copyJars(type: Copy) {
1428 from fileTree(dir: classesDir, include: "**/*.jar").files
1429 into "${jalviewDir}/${package_dir}"
1433 // doing a Sync instead of Copy as Copy doesn't deal with "outputs" very well
1434 task syncJars(type: Sync) {
1436 from fileTree(dir: "${jalviewDir}/${libDistDir}", include: "**/*.jar").files
1437 into "${jalviewDir}/${package_dir}"
1439 include jar.archiveFileName.getOrNull()
1446 description = "Put all required libraries in dist"
1447 // order of "cleanPackageDir", "copyJars", "jar" important!
1448 jar.mustRunAfter cleanPackageDir
1449 syncJars.mustRunAfter cleanPackageDir
1450 dependsOn cleanPackageDir
1453 outputs.dir("${jalviewDir}/${package_dir}")
1458 dependsOn cleanPackageDir
1465 group = "distribution"
1466 description = "Create a single jar file with all dependency libraries merged. Can be run with java -jar"
1470 from ("${jalviewDir}/${libDistDir}") {
1474 attributes "Implementation-Version": JALVIEW_VERSION,
1475 "Application-Name": install4jApplicationName
1477 mainClassName = shadow_jar_main_class
1479 classifier = "all-"+JALVIEW_VERSION+"-j"+JAVA_VERSION
1484 task getdownWebsite() {
1485 group = "distribution"
1486 description = "Create the getdown minimal app folder, and website folder for this version of jalview. Website folder also used for offline app installer"
1491 def getdownWebsiteResourceFilenames = []
1492 def getdownTextString = ""
1493 def getdownResourceDir = getdownResourceDir
1494 def getdownResourceFilenames = []
1497 // clean the getdown website and files dir before creating getdown folders
1498 delete getdownWebsiteDir
1499 delete getdownFilesDir
1502 from buildProperties
1503 rename(file(buildProperties).getName(), getdown_build_properties)
1506 getdownWebsiteResourceFilenames += "${getdownAppDistDir}/${getdown_build_properties}"
1508 // set some getdown_txt_ properties then go through all properties looking for getdown_txt_...
1509 def props = project.properties.sort { it.key }
1510 if (getdownAltJavaMinVersion != null && getdownAltJavaMinVersion.length() > 0) {
1511 props.put("getdown_txt_java_min_version", getdownAltJavaMinVersion)
1513 if (getdownAltJavaMaxVersion != null && getdownAltJavaMaxVersion.length() > 0) {
1514 props.put("getdown_txt_java_max_version", getdownAltJavaMaxVersion)
1516 if (getdownAltMultiJavaLocation != null && getdownAltMultiJavaLocation.length() > 0) {
1517 props.put("getdown_txt_multi_java_location", getdownAltMultiJavaLocation)
1519 if (getdownImagesDir != null && file(getdownImagesDir).exists()) {
1520 props.put("getdown_txt_ui.background_image", "${getdownImagesDir}/${getdown_background_image}")
1521 props.put("getdown_txt_ui.instant_background_image", "${getdownImagesDir}/${getdown_instant_background_image}")
1522 props.put("getdown_txt_ui.error_background", "${getdownImagesDir}/${getdown_error_background}")
1523 props.put("getdown_txt_ui.progress_image", "${getdownImagesDir}/${getdown_progress_image}")
1524 props.put("getdown_txt_ui.icon", "${getdownImagesDir}/${getdown_icon}")
1525 props.put("getdown_txt_ui.mac_dock_icon", "${getdownImagesDir}/${getdown_mac_dock_icon}")
1528 props.put("getdown_txt_title", jalview_name)
1529 props.put("getdown_txt_ui.name", install4jApplicationName)
1531 // start with appbase
1532 getdownTextString += "appbase = ${getdownAppBase}\n"
1533 props.each{ prop, val ->
1534 if (prop.startsWith("getdown_txt_") && val != null) {
1535 if (prop.startsWith("getdown_txt_multi_")) {
1536 def key = prop.substring(18)
1537 val.split(",").each{ v ->
1538 def line = "${key} = ${v}\n"
1539 getdownTextString += line
1542 // file values rationalised
1543 if (val.indexOf('/') > -1 || prop.startsWith("getdown_txt_resource")) {
1545 if (val.indexOf('/') == 0) {
1548 } else if (val.indexOf('/') > 0) {
1549 // relative path (relative to jalviewDir)
1550 r = file( "${jalviewDir}/${val}" )
1553 val = "${getdown_resource_dir}/" + r.getName()
1554 getdownWebsiteResourceFilenames += val
1555 getdownResourceFilenames += r.getPath()
1558 if (! prop.startsWith("getdown_txt_resource")) {
1559 def line = prop.substring(12) + " = ${val}\n"
1560 getdownTextString += line
1566 getdownWebsiteResourceFilenames.each{ filename ->
1567 getdownTextString += "resource = ${filename}\n"
1569 getdownResourceFilenames.each{ filename ->
1572 into getdownResourceDir
1576 def getdownWrapperScripts = [ getdown_bash_wrapper_script, getdown_powershell_wrapper_script ]
1577 getdownWrapperScripts.each{ script ->
1578 def s = file( "${jalviewDir}/utils/getdown/${getdown_wrapper_script_dir}/${script}" )
1582 into "${getdownWebsiteDir}/${getdown_wrapper_script_dir}"
1584 getdownTextString += "resource = ${getdown_wrapper_script_dir}/${script}\n"
1589 fileTree(file(package_dir)).each{ f ->
1590 if (f.isDirectory()) {
1591 def files = fileTree(dir: f, include: ["*"]).getFiles()
1593 } else if (f.exists()) {
1597 codeFiles.sort().each{f ->
1598 def name = f.getName()
1599 def line = "code = ${getdownAppDistDir}/${name}\n"
1600 getdownTextString += line
1607 // NOT USING MODULES YET, EVERYTHING SHOULD BE IN dist
1609 if (JAVA_VERSION.equals("11")) {
1610 def j11libFiles = fileTree(dir: "${jalviewDir}/${j11libDir}", include: ["*.jar"]).getFiles()
1611 j11libFiles.sort().each{f ->
1612 def name = f.getName()
1613 def line = "code = ${getdown_j11lib_dir}/${name}\n"
1614 getdownTextString += line
1617 into getdownJ11libDir
1623 // 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.
1624 //getdownTextString += "class = " + file(getdownLauncher).getName() + "\n"
1625 getdownTextString += "resource = ${getdown_launcher_new}\n"
1626 getdownTextString += "class = ${main_class}\n"
1627 // Not setting these properties in general so that getdownappbase and getdowndistdir will default to release version in jalview.bin.Cache
1628 if (getdownSetAppBaseProperty) {
1629 getdownTextString += "jvmarg = -Dgetdowndistdir=${getdownAppDistDir}\n"
1630 getdownTextString += "jvmarg = -Dgetdownappbase=${getdownAppBase}\n"
1633 def getdown_txt = file("${getdownWebsiteDir}/getdown.txt")
1634 getdown_txt.write(getdownTextString)
1636 def getdownLaunchJvl = getdown_launch_jvl_name + ( (jvlChannelName != null && jvlChannelName.length() > 0)?"-${jvlChannelName}":"" ) + ".jvl"
1637 def launchJvl = file("${getdownWebsiteDir}/${getdownLaunchJvl}")
1638 launchJvl.write("appbase=${getdownAppBase}")
1640 // files going into the getdown website dir: getdown-launcher.jar
1642 from getdownLauncher
1643 rename(file(getdownLauncher).getName(), getdown_launcher_new)
1644 into getdownWebsiteDir
1647 // files going into the getdown website dir: getdown-launcher(-local).jar
1649 from getdownLauncher
1650 if (file(getdownLauncher).getName() != getdown_launcher) {
1651 rename(file(getdownLauncher).getName(), getdown_launcher)
1653 into getdownWebsiteDir
1656 // files going into the getdown website dir: ./install dir and files
1657 if (! (CHANNEL.startsWith("ARCHIVE") || CHANNEL.startsWith("DEVELOP"))) {
1660 from getdownLauncher
1661 from "${getdownAppDir}/${getdown_build_properties}"
1662 if (file(getdownLauncher).getName() != getdown_launcher) {
1663 rename(file(getdownLauncher).getName(), getdown_launcher)
1665 into getdownInstallDir
1668 // and make a copy in the getdown files dir (these are not downloaded by getdown)
1670 from getdownInstallDir
1671 into getdownFilesInstallDir
1675 // files going into the getdown files dir: getdown.txt, getdown-launcher.jar, channel-launch.jvl, build_properties
1679 from getdownLauncher
1680 from "${getdownWebsiteDir}/${getdown_build_properties}"
1681 if (file(getdownLauncher).getName() != getdown_launcher) {
1682 rename(file(getdownLauncher).getName(), getdown_launcher)
1684 into getdownFilesDir
1687 // and ./resources (not all downloaded by getdown)
1689 from getdownResourceDir
1690 into "${getdownFilesDir}/${getdown_resource_dir}"
1695 inputs.dir("${jalviewDir}/${package_dir}")
1697 outputs.dir(getdownWebsiteDir)
1698 outputs.dir(getdownFilesDir)
1702 // a helper task to allow getdown digest of any dir: `gradle getdownDigestDir -PDIGESTDIR=/path/to/my/random/getdown/dir
1703 task getdownDigestDir(type: JavaExec) {
1705 description "A task to run a getdown Digest on a dir with getdown.txt. Provide a DIGESTDIR property via -PDIGESTDIR=..."
1707 def digestDirPropertyName = "DIGESTDIR"
1709 classpath = files(getdownLauncher)
1710 def digestDir = findProperty(digestDirPropertyName)
1711 if (digestDir == null) {
1712 throw new GradleException("Must provide a DIGESTDIR value to produce an alternative getdown digest")
1716 main = "com.threerings.getdown.tools.Digester"
1720 task getdownDigest(type: JavaExec) {
1721 group = "distribution"
1722 description = "Digest the getdown website folder"
1723 dependsOn getdownWebsite
1725 classpath = files(getdownLauncher)
1727 main = "com.threerings.getdown.tools.Digester"
1728 args getdownWebsiteDir
1729 inputs.dir(getdownWebsiteDir)
1730 outputs.file("${getdownWebsiteDir}/digest2.txt")
1735 group = "distribution"
1736 description = "Create the minimal and full getdown app folder for installers and website and create digest file"
1737 dependsOn getdownDigest
1739 if (reportRsyncCommand) {
1740 def fromDir = getdownWebsiteDir + (getdownWebsiteDir.endsWith('/')?'':'/')
1741 def toDir = "${getdown_rsync_dest}/${getdownDir}" + (getdownDir.endsWith('/')?'':'/')
1742 println "LIKELY RSYNC COMMAND:"
1743 println "mkdir -p '$toDir'\nrsync -avh --delete '$fromDir' '$toDir'"
1744 if (RUNRSYNC == "true") {
1746 commandLine "mkdir", "-p", toDir
1749 commandLine "rsync", "-avh", "--delete", fromDir, toDir
1757 tasks.withType(JavaCompile) {
1758 options.encoding = 'UTF-8'
1764 delete getdownWebsiteDir
1765 delete getdownFilesDir
1771 if (file(install4jHomeDir).exists()) {
1773 } else if (file(System.getProperty("user.home")+"/buildtools/install4j").exists()) {
1774 install4jHomeDir = System.getProperty("user.home")+"/buildtools/install4j"
1775 } else if (file("/Applications/install4j.app/Contents/Resources/app").exists()) {
1776 install4jHomeDir = "/Applications/install4j.app/Contents/Resources/app"
1778 installDir(file(install4jHomeDir))
1780 mediaTypes = Arrays.asList(install4j_media_types.split(","))
1784 task copyInstall4jTemplate {
1785 def install4jTemplateFile = file("${install4jDir}/${install4j_template}")
1786 def install4jFileAssociationsFile = file("${install4jDir}/${install4j_installer_file_associations}")
1787 inputs.file(install4jTemplateFile)
1788 inputs.file(install4jFileAssociationsFile)
1789 inputs.property("CHANNEL", { CHANNEL })
1790 outputs.file(install4jConfFile)
1793 def install4jConfigXml = new XmlParser().parse(install4jTemplateFile)
1795 // turn off code signing if no OSX_KEYPASS
1796 if (OSX_KEYPASS == "") {
1797 install4jConfigXml.'**'.codeSigning.each { codeSigning ->
1798 codeSigning.'@macEnabled' = "false"
1800 install4jConfigXml.'**'.windows.each { windows ->
1801 windows.'@runPostProcessor' = "false"
1805 // turn off checksum creation for LOCAL channel
1806 def e = install4jConfigXml.application[0]
1807 if (CHANNEL == "LOCAL") {
1808 e.'@createChecksums' = "false"
1810 e.'@createChecksums' = "true"
1813 // put file association actions where placeholder action is
1814 def install4jFileAssociationsText = install4jFileAssociationsFile.text
1815 def fileAssociationActions = new XmlParser().parseText("<actions>${install4jFileAssociationsText}</actions>")
1816 install4jConfigXml.'**'.action.any { a -> // .any{} stops after the first one that returns true
1817 if (a.'@name' == 'EXTENSIONS_REPLACED_BY_GRADLE') {
1818 def parent = a.parent()
1820 fileAssociationActions.each { faa ->
1823 // don't need to continue in .any loop once replacements have been made
1828 // use Windows Program Group with Examples folder for RELEASE, and Program Group without Examples for everything else
1829 // NB we're deleting the /other/ one!
1830 // Also remove the examples subdir from non-release versions
1831 def customizedIdToDelete = "PROGRAM_GROUP_RELEASE"
1832 // 2.11.1.0 NOT releasing with the Examples folder in the Program Group
1833 if (false && CHANNEL=="RELEASE") { // remove 'false && ' to include Examples folder in RELEASE channel
1834 customizedIdToDelete = "PROGRAM_GROUP_NON_RELEASE"
1836 // remove the examples subdir from Full File Set
1837 def files = install4jConfigXml.files[0]
1838 def fileset = files.filesets.fileset.find { fs -> fs.'@customizedId' == "FULL_FILE_SET" }
1839 def root = files.roots.root.find { r -> r.'@fileset' == fileset.'@id' }
1840 def mountPoint = files.mountPoints.mountPoint.find { mp -> mp.'@root' == root.'@id' }
1841 def dirEntry = files.entries.dirEntry.find { de -> de.'@mountPoint' == mountPoint.'@id' && de.'@subDirectory' == "examples" }
1842 dirEntry.parent().remove(dirEntry)
1844 install4jConfigXml.'**'.action.any { a ->
1845 if (a.'@customizedId' == customizedIdToDelete) {
1846 def parent = a.parent()
1852 // write install4j file
1853 install4jConfFile.text = XmlUtil.serialize(install4jConfigXml)
1860 delete install4jConfFile
1865 task installers(type: com.install4j.gradle.Install4jTask) {
1866 group = "distribution"
1867 description = "Create the install4j installers"
1869 dependsOn copyInstall4jTemplate
1871 projectFile = install4jConfFile
1873 // create an md5 for the input files to use as version for install4j conf file
1874 def digest = MessageDigest.getInstance("MD5")
1876 (file("${install4jDir}/${install4j_template}").text +
1877 file("${install4jDir}/${install4j_info_plist_file_associations}").text +
1878 file("${install4jDir}/${install4j_installer_file_associations}").text).bytes)
1879 def filesMd5 = new BigInteger(1, digest.digest()).toString(16)
1880 if (filesMd5.length() >= 8) {
1881 filesMd5 = filesMd5.substring(0,8)
1883 def install4jTemplateVersion = "${JALVIEW_VERSION}_F${filesMd5}_C${gitHash}"
1884 // make install4jBuildDir relative to jalviewDir
1885 def install4jBuildDir = "${install4j_build_dir}/${JAVA_VERSION}"
1888 'JALVIEW_NAME': jalview_name,
1889 'JALVIEW_APPLICATION_NAME': install4jApplicationName,
1890 'JALVIEW_DIR': "../..",
1891 'OSX_KEYSTORE': OSX_KEYSTORE,
1892 'OSX_APPLEID': OSX_APPLEID,
1893 'OSX_ALTOOLPASS': OSX_ALTOOLPASS,
1894 'JSIGN_SH': JSIGN_SH,
1895 'JRE_DIR': getdown_app_dir_java,
1896 'INSTALLER_TEMPLATE_VERSION': install4jTemplateVersion,
1897 'JALVIEW_VERSION': JALVIEW_VERSION,
1898 'JAVA_MIN_VERSION': JAVA_MIN_VERSION,
1899 'JAVA_MAX_VERSION': JAVA_MAX_VERSION,
1900 'JAVA_VERSION': JAVA_VERSION,
1901 'JAVA_INTEGER_VERSION': JAVA_INTEGER_VERSION,
1902 'VERSION': JALVIEW_VERSION,
1903 'MACOS_JAVA_VM_DIR': macosJavaVMDir,
1904 'WINDOWS_JAVA_VM_DIR': windowsJavaVMDir,
1905 'LINUX_JAVA_VM_DIR': linuxJavaVMDir,
1906 'MACOS_JAVA_VM_TGZ': macosJavaVMTgz,
1907 'WINDOWS_JAVA_VM_TGZ': windowsJavaVMTgz,
1908 'LINUX_JAVA_VM_TGZ': linuxJavaVMTgz,
1909 'COPYRIGHT_MESSAGE': install4j_copyright_message,
1910 'BUNDLE_ID': install4jBundleId,
1911 'INTERNAL_ID': install4jInternalId,
1912 'WINDOWS_APPLICATION_ID': install4jWinApplicationId,
1913 'MACOS_DMG_DS_STORE': install4jDMGDSStore,
1914 'MACOS_DMG_BG_IMAGE': install4jDMGBackgroundImage,
1915 'WRAPPER_LINK': getdown_wrapper_link,
1916 'BASH_WRAPPER_SCRIPT': getdown_bash_wrapper_script,
1917 'POWERSHELL_WRAPPER_SCRIPT': getdown_powershell_wrapper_script,
1918 'WRAPPER_SCRIPT_BIN_DIR': getdown_wrapper_script_dir,
1919 'INSTALLER_NAME': install4jInstallerName,
1920 'INSTALL4J_UTILS_DIR': install4j_utils_dir,
1921 'GETDOWN_WEBSITE_DIR': getdown_website_dir,
1922 'GETDOWN_FILES_DIR': getdown_files_dir,
1923 'GETDOWN_RESOURCE_DIR': getdown_resource_dir,
1924 'GETDOWN_DIST_DIR': getdownAppDistDir,
1925 'GETDOWN_ALT_DIR': getdown_app_dir_alt,
1926 'GETDOWN_INSTALL_DIR': getdown_install_dir,
1927 'INFO_PLIST_FILE_ASSOCIATIONS_FILE': install4j_info_plist_file_associations,
1928 'BUILD_DIR': install4jBuildDir,
1929 'APPLICATION_CATEGORIES': install4j_application_categories,
1930 'APPLICATION_FOLDER': install4jApplicationFolder,
1931 'UNIX_APPLICATION_FOLDER': install4jUnixApplicationFolder,
1932 'EXECUTABLE_NAME': install4jExecutableName,
1933 'EXTRA_SCHEME': install4jExtraScheme,
1934 'MAC_ICONS_FILE': install4jMacIconsFile,
1935 'WINDOWS_ICONS_FILE': install4jWindowsIconsFile,
1936 'PNG_ICON_FILE': install4jPngIconFile,
1937 'BACKGROUND': install4jBackground,
1941 //println("INSTALL4J VARIABLES:")
1942 //variables.each{k,v->println("${k}=${v}")}
1944 destination = "${jalviewDir}/${install4jBuildDir}"
1945 buildSelected = true
1947 if (install4j_faster.equals("true") || CHANNEL.startsWith("LOCAL")) {
1949 disableSigning = true
1950 disableNotarization = true
1954 macKeystorePassword = OSX_KEYPASS
1957 if (OSX_ALTOOLPASS) {
1958 appleIdPassword = OSX_ALTOOLPASS
1959 disableNotarization = false
1961 disableNotarization = true
1965 println("Using projectFile "+projectFile)
1966 if (!disableNotarization) { println("Will notarize OSX App DMG") }
1970 inputs.dir(getdownWebsiteDir)
1971 inputs.file(install4jConfFile)
1972 inputs.file("${install4jDir}/${install4j_info_plist_file_associations}")
1973 inputs.dir(macosJavaVMDir)
1974 inputs.dir(windowsJavaVMDir)
1975 outputs.dir("${jalviewDir}/${install4j_build_dir}/${JAVA_VERSION}")
1981 eclipse().configFile(eclipse_codestyle_file)
1986 task sourceDist(type: Tar) {
1987 group "distribution"
1988 description "Create a source .tar.gz file for distribution"
1990 dependsOn createBuildProperties
1991 dependsOn convertMdFiles
1993 def VERSION_UNDERSCORES = JALVIEW_VERSION.replaceAll("\\.", "_")
1994 def outputFileName = "${project.name}_${VERSION_UNDERSCORES}.tar.gz"
1995 archiveFileName = outputFileName
1997 compression Compression.GZIP
2012 "**/*.class","$j11modDir/**/*.jar","appletlib","**/*locales",
2014 "utils/InstallAnywhere",
2029 "gradle.properties",
2040 ".settings/org.eclipse.jdt.core.jalview.prefs",
2044 exclude (EXCLUDE_FILES)
2045 include (PROCESS_FILES)
2046 filter(ReplaceTokens,
2050 'Version-Rel': JALVIEW_VERSION,
2051 'Year-Rel': getDate("yyyy")
2056 exclude (EXCLUDE_FILES)
2057 exclude (PROCESS_FILES)
2058 exclude ("appletlib")
2059 exclude ("**/*locales")
2060 exclude ("*locales/**")
2061 exclude ("utils/InstallAnywhere")
2063 exclude (getdown_files_dir)
2064 exclude (getdown_website_dir)
2066 // exluding these as not using jars as modules yet
2067 exclude ("${j11modDir}/**/*.jar")
2070 include(INCLUDE_FILES)
2072 // from (jalviewDir) {
2073 // // explicit includes for stuff that seemed to not get included
2074 // include(fileTree("test/**/*."))
2075 // exclude(EXCLUDE_FILES)
2076 // exclude(PROCESS_FILES)
2079 from(file(buildProperties).getParent()) {
2080 include(file(buildProperties).getName())
2081 rename(file(buildProperties).getName(), "build_properties")
2083 line.replaceAll("^INSTALLATION=.*\$","INSTALLATION=Source Release"+" git-commit\\\\:"+gitHash+" ["+gitBranch+"]")
2092 dependsOn pubhtmlhelp
2094 inputs.dir("${helpBuildDir}/${help_dir}")
2095 outputs.dir("${buildDir}/distributions/${help_dir}")
2099 task j2sSetHeadlessBuild {
2106 task jalviewjsEnableAltFileProperty(type: WriteProperties) {
2108 description "Enable the alternative J2S Config file for headless build"
2110 outputFile = jalviewjsJ2sSettingsFileName
2111 def j2sPropsFile = file(jalviewjsJ2sSettingsFileName)
2112 def j2sProps = new Properties()
2113 if (j2sPropsFile.exists()) {
2115 def j2sPropsFileFIS = new FileInputStream(j2sPropsFile)
2116 j2sProps.load(j2sPropsFileFIS)
2117 j2sPropsFileFIS.close()
2119 j2sProps.each { prop, val ->
2122 } catch (Exception e) {
2123 println("Exception reading ${jalviewjsJ2sSettingsFileName}")
2127 if (! j2sProps.stringPropertyNames().contains(jalviewjs_j2s_alt_file_property_config)) {
2128 property(jalviewjs_j2s_alt_file_property_config, jalviewjs_j2s_alt_file_property)
2133 task jalviewjsSetEclipseWorkspace {
2134 def propKey = "jalviewjs_eclipse_workspace"
2136 if (project.hasProperty(propKey)) {
2137 propVal = project.getProperty(propKey)
2138 if (propVal.startsWith("~/")) {
2139 propVal = System.getProperty("user.home") + propVal.substring(1)
2142 def propsFileName = "${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_eclipse_workspace_location_file}"
2143 def propsFile = file(propsFileName)
2144 def eclipseWsDir = propVal
2145 def props = new Properties()
2147 def writeProps = true
2148 if (( eclipseWsDir == null || !file(eclipseWsDir).exists() ) && propsFile.exists()) {
2149 def ins = new FileInputStream(propsFileName)
2152 if (props.getProperty(propKey, null) != null) {
2153 eclipseWsDir = props.getProperty(propKey)
2158 if (eclipseWsDir == null || !file(eclipseWsDir).exists()) {
2159 def tempDir = File.createTempDir()
2160 eclipseWsDir = tempDir.getAbsolutePath()
2163 eclipseWorkspace = file(eclipseWsDir)
2166 // do not run a headless transpile when we claim to be in Eclipse
2168 println("Skipping task ${name} as IN_ECLIPSE=${IN_ECLIPSE}")
2169 throw new StopExecutionException("Not running headless transpile whilst IN_ECLIPSE is '${IN_ECLIPSE}'")
2171 println("Running task ${name} as IN_ECLIPSE=${IN_ECLIPSE}")
2175 props.setProperty(propKey, eclipseWsDir)
2176 propsFile.parentFile.mkdirs()
2177 def bytes = new ByteArrayOutputStream()
2178 props.store(bytes, null)
2179 def propertiesString = bytes.toString()
2180 propsFile.text = propertiesString
2186 println("ECLIPSE WORKSPACE: "+eclipseWorkspace.getPath())
2189 //inputs.property(propKey, eclipseWsDir) // eclipseWsDir only gets set once this task runs, so will be out-of-date
2190 outputs.file(propsFileName)
2191 outputs.upToDateWhen { eclipseWorkspace.exists() && propsFile.exists() }
2195 task jalviewjsEclipsePaths {
2198 def eclipseRoot = jalviewjs_eclipse_root
2199 if (eclipseRoot.startsWith("~/")) {
2200 eclipseRoot = System.getProperty("user.home") + eclipseRoot.substring(1)
2202 if (OperatingSystem.current().isMacOsX()) {
2203 eclipseRoot += "/Eclipse.app"
2204 eclipseBinary = "${eclipseRoot}/Contents/MacOS/eclipse"
2205 eclipseProduct = "${eclipseRoot}/Contents/Eclipse/.eclipseproduct"
2206 } else if (OperatingSystem.current().isWindows()) { // check these paths!!
2207 if (file("${eclipseRoot}/eclipse").isDirectory() && file("${eclipseRoot}/eclipse/.eclipseproduct").exists()) {
2208 eclipseRoot += "/eclipse"
2210 eclipseBinary = "${eclipseRoot}/eclipse.exe"
2211 eclipseProduct = "${eclipseRoot}/.eclipseproduct"
2212 } else { // linux or unix
2213 if (file("${eclipseRoot}/eclipse").isDirectory() && file("${eclipseRoot}/eclipse/.eclipseproduct").exists()) {
2214 eclipseRoot += "/eclipse"
2215 println("eclipseDir exists")
2217 eclipseBinary = "${eclipseRoot}/eclipse"
2218 eclipseProduct = "${eclipseRoot}/.eclipseproduct"
2221 eclipseVersion = "4.13" // default
2222 def assumedVersion = true
2223 if (file(eclipseProduct).exists()) {
2224 def fis = new FileInputStream(eclipseProduct)
2225 def props = new Properties()
2227 eclipseVersion = props.getProperty("version")
2229 assumedVersion = false
2232 def propKey = "eclipse_debug"
2233 eclipseDebug = (project.hasProperty(propKey) && project.getProperty(propKey).equals("true"))
2236 // do not run a headless transpile when we claim to be in Eclipse
2238 println("Skipping task ${name} as IN_ECLIPSE=${IN_ECLIPSE}")
2239 throw new StopExecutionException("Not running headless transpile whilst IN_ECLIPSE is '${IN_ECLIPSE}'")
2241 println("Running task ${name} as IN_ECLIPSE=${IN_ECLIPSE}")
2244 if (!assumedVersion) {
2245 println("ECLIPSE VERSION=${eclipseVersion}")
2251 task printProperties {
2253 description "Output to console all System.properties"
2255 System.properties.each { key, val -> System.out.println("Property: ${key}=${val}") }
2261 dependsOn eclipseProject
2262 dependsOn eclipseClasspath
2263 dependsOn eclipseJdt
2267 // this version (type: Copy) will delete anything in the eclipse dropins folder that isn't in fromDropinsDir
2268 task jalviewjsEclipseCopyDropins(type: Copy) {
2269 dependsOn jalviewjsEclipsePaths
2271 def inputFiles = fileTree(dir: "${jalviewDir}/${jalviewjs_eclipse_dropins_dir}", include: "*.jar")
2272 inputFiles += file("${jalviewDir}/${jalviewjsJ2sPlugin}")
2273 def outputDir = "${jalviewDir}/${jalviewjsBuildDir}/${jalviewjs_eclipse_tmp_dropins_dir}"
2280 // this eclipse -clean doesn't actually work
2281 task jalviewjsCleanEclipse(type: Exec) {
2282 dependsOn eclipseSetup
2283 dependsOn jalviewjsEclipsePaths
2284 dependsOn jalviewjsEclipseCopyDropins
2286 executable(eclipseBinary)
2287 args(["-nosplash", "--launcher.suppressErrors", "-data", eclipseWorkspace.getPath(), "-clean", "-console", "-consoleLog"])
2293 def inputString = """exit
2296 def inputByteStream = new ByteArrayInputStream(inputString.getBytes())
2297 standardInput = inputByteStream
2300 /* not really working yet
2301 jalviewjsEclipseCopyDropins.finalizedBy jalviewjsCleanEclipse
2305 task jalviewjsTransferUnzipSwingJs {
2306 def file_zip = "${jalviewDir}/${jalviewjs_swingjs_zip}"
2310 from zipTree(file_zip)
2311 into "${jalviewDir}/${jalviewjsTransferSiteSwingJsDir}"
2315 inputs.file file_zip
2316 outputs.dir "${jalviewDir}/${jalviewjsTransferSiteSwingJsDir}"
2320 task jalviewjsTransferUnzipLib {
2321 def zipFiles = fileTree(dir: "${jalviewDir}/${jalviewjs_libjs_dir}", include: "*.zip")
2324 zipFiles.each { file_zip ->
2326 from zipTree(file_zip)
2327 into "${jalviewDir}/${jalviewjsTransferSiteLibDir}"
2332 inputs.files zipFiles
2333 outputs.dir "${jalviewDir}/${jalviewjsTransferSiteLibDir}"
2337 task jalviewjsTransferUnzipAllLibs {
2338 dependsOn jalviewjsTransferUnzipSwingJs
2339 dependsOn jalviewjsTransferUnzipLib
2343 task jalviewjsCreateJ2sSettings(type: WriteProperties) {
2345 description "Create the alternative j2s file from the j2s.* properties"
2347 jalviewjsJ2sProps = project.properties.findAll { it.key.startsWith("j2s.") }.sort { it.key }
2348 def siteDirProperty = "j2s.site.directory"
2349 def setSiteDir = false
2350 jalviewjsJ2sProps.each { prop, val ->
2352 if (prop == siteDirProperty) {
2353 if (!(val.startsWith('/') || val.startsWith("file://") )) {
2354 val = "${jalviewDir}/${jalviewjsTransferSiteJsDir}/${val}"
2360 if (!setSiteDir) { // default site location, don't override specifically set property
2361 property(siteDirProperty,"${jalviewDirRelativePath}/${jalviewjsTransferSiteJsDir}")
2364 outputFile = jalviewjsJ2sAltSettingsFileName
2367 inputs.properties(jalviewjsJ2sProps)
2368 outputs.file(jalviewjsJ2sAltSettingsFileName)
2373 task jalviewjsEclipseSetup {
2374 dependsOn jalviewjsEclipseCopyDropins
2375 dependsOn jalviewjsSetEclipseWorkspace
2376 dependsOn jalviewjsCreateJ2sSettings
2380 task jalviewjsSyncAllLibs (type: Sync) {
2381 dependsOn jalviewjsTransferUnzipAllLibs
2382 def inputFiles = fileTree(dir: "${jalviewDir}/${jalviewjsTransferSiteLibDir}")
2383 inputFiles += fileTree(dir: "${jalviewDir}/${jalviewjsTransferSiteSwingJsDir}")
2384 def outputDir = "${jalviewDir}/${jalviewjsSiteDir}"
2388 def outputFiles = []
2389 rename { filename ->
2390 outputFiles += "${outputDir}/${filename}"
2396 outputs.files outputFiles
2397 inputs.files inputFiles
2401 task jalviewjsSyncResources (type: Sync) {
2402 dependsOn buildResources
2404 def inputFiles = fileTree(dir: resourcesBuildDir)
2405 def outputDir = "${jalviewDir}/${jalviewjsSiteDir}/${jalviewjs_j2s_subdir}"
2409 def outputFiles = []
2410 rename { filename ->
2411 outputFiles += "${outputDir}/${filename}"
2417 outputs.files outputFiles
2418 inputs.files inputFiles
2422 task jalviewjsSyncSiteResources (type: Sync) {
2423 def inputFiles = fileTree(dir: "${jalviewDir}/${jalviewjs_site_resource_dir}")
2424 def outputDir = "${jalviewDir}/${jalviewjsSiteDir}"
2428 def outputFiles = []
2429 rename { filename ->
2430 outputFiles += "${outputDir}/${filename}"
2436 outputs.files outputFiles
2437 inputs.files inputFiles
2441 task jalviewjsSyncBuildProperties (type: Sync) {
2442 dependsOn createBuildProperties
2443 def inputFiles = [file(buildProperties)]
2444 def outputDir = "${jalviewDir}/${jalviewjsSiteDir}/${jalviewjs_j2s_subdir}"
2448 def outputFiles = []
2449 rename { filename ->
2450 outputFiles += "${outputDir}/${filename}"
2456 outputs.files outputFiles
2457 inputs.files inputFiles
2461 task jalviewjsProjectImport(type: Exec) {
2462 dependsOn eclipseSetup
2463 dependsOn jalviewjsEclipsePaths
2464 dependsOn jalviewjsEclipseSetup
2467 // do not run a headless import when we claim to be in Eclipse
2469 println("Skipping task ${name} as IN_ECLIPSE=${IN_ECLIPSE}")
2470 throw new StopExecutionException("Not running headless import whilst IN_ECLIPSE is '${IN_ECLIPSE}'")
2472 println("Running task ${name} as IN_ECLIPSE=${IN_ECLIPSE}")
2476 //def projdir = eclipseWorkspace.getPath()+"/.metadata/.plugins/org.eclipse.core.resources/.projects/jalview/org.eclipse.jdt.core"
2477 def projdir = eclipseWorkspace.getPath()+"/.metadata/.plugins/org.eclipse.core.resources/.projects/jalview"
2478 executable(eclipseBinary)
2479 args(["-nosplash", "--launcher.suppressErrors", "-application", "com.seeq.eclipse.importprojects.headlessimport", "-data", eclipseWorkspace.getPath(), "-import", jalviewDirAbsolutePath])
2483 args += [ "--launcher.appendVmargs", "-vmargs", "-Dorg.eclipse.equinox.p2.reconciler.dropins.directory=${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_eclipse_tmp_dropins_dir}" ]
2485 args += [ "-D${j2sHeadlessBuildProperty}=true" ]
2486 args += [ "-D${jalviewjs_j2s_alt_file_property}=${jalviewjsJ2sAltSettingsFileName}" ]
2489 inputs.file("${jalviewDir}/.project")
2490 outputs.upToDateWhen {
2491 file(projdir).exists()
2496 task jalviewjsTranspile(type: Exec) {
2497 dependsOn jalviewjsEclipseSetup
2498 dependsOn jalviewjsProjectImport
2499 dependsOn jalviewjsEclipsePaths
2501 dependsOn jalviewjsEnableAltFileProperty
2505 // do not run a headless transpile when we claim to be in Eclipse
2507 println("Skipping task ${name} as IN_ECLIPSE=${IN_ECLIPSE}")
2508 throw new StopExecutionException("Not running headless transpile whilst IN_ECLIPSE is '${IN_ECLIPSE}'")
2510 println("Running task ${name} as IN_ECLIPSE=${IN_ECLIPSE}")
2514 executable(eclipseBinary)
2515 args(["-nosplash", "--launcher.suppressErrors", "-application", "org.eclipse.jdt.apt.core.aptBuild", "-data", eclipseWorkspace, "-${jalviewjs_eclipse_build_arg}", eclipse_project_name ])
2519 args += [ "--launcher.appendVmargs", "-vmargs", "-Dorg.eclipse.equinox.p2.reconciler.dropins.directory=${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_eclipse_tmp_dropins_dir}" ]
2521 args += [ "-D${j2sHeadlessBuildProperty}=true" ]
2522 args += [ "-D${jalviewjs_j2s_alt_file_property}=${jalviewjsJ2sAltSettingsFileName}" ]
2528 stdout = new ByteArrayOutputStream()
2529 stderr = new ByteArrayOutputStream()
2531 def logOutFileName = "${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_j2s_transpile_stdout}"
2532 def logOutFile = file(logOutFileName)
2533 logOutFile.createNewFile()
2534 logOutFile.text = """ROOT: ${jalviewjs_eclipse_root}
2535 BINARY: ${eclipseBinary}
2536 VERSION: ${eclipseVersion}
2537 WORKSPACE: ${eclipseWorkspace}
2538 DEBUG: ${eclipseDebug}
2541 def logOutFOS = new FileOutputStream(logOutFile, true) // true == append
2542 // combine stdout and stderr
2543 def logErrFOS = logOutFOS
2545 if (jalviewjs_j2s_to_console.equals("true")) {
2546 standardOutput = new org.apache.tools.ant.util.TeeOutputStream(
2547 new org.apache.tools.ant.util.TeeOutputStream(
2551 errorOutput = new org.apache.tools.ant.util.TeeOutputStream(
2552 new org.apache.tools.ant.util.TeeOutputStream(
2557 standardOutput = new org.apache.tools.ant.util.TeeOutputStream(
2560 errorOutput = new org.apache.tools.ant.util.TeeOutputStream(
2567 if (stdout.toString().contains("Error processing ")) {
2568 // j2s did not complete transpile
2569 //throw new TaskExecutionException("Error during transpilation:\n${stderr}\nSee eclipse transpile log file '${jalviewDir}/${jalviewjsBuildDir}/${jalviewjs_j2s_transpile_stdout}'")
2570 if (jalviewjs_ignore_transpile_errors.equals("true")) {
2571 println("IGNORING TRANSPILE ERRORS")
2572 println("See eclipse transpile log file '${jalviewDir}/${jalviewjsBuildDir}/${jalviewjs_j2s_transpile_stdout}'")
2574 throw new GradleException("Error during transpilation:\n${stderr}\nSee eclipse transpile log file '${jalviewDir}/${jalviewjsBuildDir}/${jalviewjs_j2s_transpile_stdout}'")
2579 inputs.dir("${jalviewDir}/${sourceDir}")
2580 outputs.dir("${jalviewDir}/${jalviewjsTransferSiteJsDir}")
2581 outputs.upToDateWhen( { file("${jalviewDir}/${jalviewjsTransferSiteJsDir}${jalviewjs_server_resource}").exists() } )
2585 def jalviewjsCallCore(String name, FileCollection list, String prefixFile, String suffixFile, String jsfile, String zjsfile, File logOutFile, Boolean logOutConsole) {
2587 def stdout = new ByteArrayOutputStream()
2588 def stderr = new ByteArrayOutputStream()
2590 def coreFile = file(jsfile)
2592 msg = "Creating core for ${name}...\nGenerating ${jsfile}"
2594 logOutFile.createNewFile()
2595 logOutFile.append(msg+"\n")
2597 def coreTop = file(prefixFile)
2598 def coreBottom = file(suffixFile)
2599 coreFile.getParentFile().mkdirs()
2600 coreFile.createNewFile()
2601 coreFile.write( coreTop.getText("UTF-8") )
2605 def t = f.getText("UTF-8")
2606 t.replaceAll("Clazz\\.([^_])","Clazz_${1}")
2607 coreFile.append( t )
2609 msg = "...file '"+f.getPath()+"' does not exist, skipping"
2611 logOutFile.append(msg+"\n")
2614 coreFile.append( coreBottom.getText("UTF-8") )
2616 msg = "Generating ${zjsfile}"
2618 logOutFile.append(msg+"\n")
2619 def logOutFOS = new FileOutputStream(logOutFile, true) // true == append
2620 def logErrFOS = logOutFOS
2623 classpath = files(["${jalviewDir}/${jalviewjs_closure_compiler}"])
2624 main = "com.google.javascript.jscomp.CommandLineRunner"
2625 jvmArgs = [ "-Dfile.encoding=UTF-8" ]
2626 args = [ "--compilation_level", "SIMPLE_OPTIMIZATIONS", "--warning_level", "QUIET", "--charset", "UTF-8", "--js", jsfile, "--js_output_file", zjsfile ]
2629 msg = "\nRunning '"+commandLine.join(' ')+"'\n"
2631 logOutFile.append(msg+"\n")
2633 if (logOutConsole) {
2634 standardOutput = new org.apache.tools.ant.util.TeeOutputStream(
2635 new org.apache.tools.ant.util.TeeOutputStream(
2639 errorOutput = new org.apache.tools.ant.util.TeeOutputStream(
2640 new org.apache.tools.ant.util.TeeOutputStream(
2645 standardOutput = new org.apache.tools.ant.util.TeeOutputStream(
2648 errorOutput = new org.apache.tools.ant.util.TeeOutputStream(
2655 logOutFile.append(msg+"\n")
2659 task jalviewjsBuildAllCores {
2661 description "Build the core js lib closures listed in the classlists dir"
2662 dependsOn jalviewjsTranspile
2663 dependsOn jalviewjsTransferUnzipSwingJs
2665 def j2sDir = "${jalviewDir}/${jalviewjsTransferSiteJsDir}/${jalviewjs_j2s_subdir}"
2666 def swingJ2sDir = "${jalviewDir}/${jalviewjsTransferSiteSwingJsDir}/${jalviewjs_j2s_subdir}"
2667 def libJ2sDir = "${jalviewDir}/${jalviewjsTransferSiteLibDir}/${jalviewjs_j2s_subdir}"
2668 def jsDir = "${jalviewDir}/${jalviewjsTransferSiteSwingJsDir}/${jalviewjs_js_subdir}"
2669 def outputDir = "${jalviewDir}/${jalviewjsTransferSiteCoreDir}/${jalviewjs_j2s_subdir}/core"
2670 def prefixFile = "${jsDir}/core/coretop2.js"
2671 def suffixFile = "${jsDir}/core/corebottom2.js"
2673 inputs.file prefixFile
2674 inputs.file suffixFile
2676 def classlistFiles = []
2677 // add the classlists found int the jalviewjs_classlists_dir
2678 fileTree(dir: "${jalviewDir}/${jalviewjs_classlists_dir}", include: "*.txt").each {
2680 def name = file.getName() - ".txt"
2687 // _jmol and _jalview cores. Add any other peculiar classlist.txt files here
2688 //classlistFiles += [ 'file': file("${jalviewDir}/${jalviewjs_classlist_jmol}"), 'name': "_jvjmol" ]
2689 classlistFiles += [ 'file': file("${jalviewDir}/${jalviewjs_classlist_jalview}"), 'name': jalviewjsJalviewCoreName ]
2691 jalviewjsCoreClasslists = []
2693 classlistFiles.each {
2696 def file = hash['file']
2697 if (! file.exists()) {
2698 //println("...classlist file '"+file.getPath()+"' does not exist, skipping")
2699 return false // this is a "continue" in groovy .each closure
2701 def name = hash['name']
2703 name = file.getName() - ".txt"
2711 def list = fileTree(dir: j2sDir, includes: filelist)
2713 def jsfile = "${outputDir}/core${name}.js"
2714 def zjsfile = "${outputDir}/core${name}.z.js"
2716 jalviewjsCoreClasslists += [
2725 outputs.file(jsfile)
2726 outputs.file(zjsfile)
2729 // _stevesoft core. add any cores without a classlist here (and the inputs and outputs)
2730 def stevesoftClasslistName = "_stevesoft"
2731 def stevesoftClasslist = [
2732 'jsfile': "${outputDir}/core${stevesoftClasslistName}.js",
2733 'zjsfile': "${outputDir}/core${stevesoftClasslistName}.z.js",
2734 'list': fileTree(dir: j2sDir, include: "com/stevesoft/pat/**/*.js"),
2735 'name': stevesoftClasslistName
2737 jalviewjsCoreClasslists += stevesoftClasslist
2738 inputs.files(stevesoftClasslist['list'])
2739 outputs.file(stevesoftClasslist['jsfile'])
2740 outputs.file(stevesoftClasslist['zjsfile'])
2743 def allClasslistName = "_all"
2744 def allJsFiles = fileTree(dir: j2sDir, include: "**/*.js")
2745 allJsFiles += fileTree(
2749 // these exlusions are files that the closure-compiler produces errors for. Should fix them
2750 "**/org/jmol/jvxl/readers/IsoIntersectFileReader.js",
2751 "**/org/jmol/export/JSExporter.js"
2754 allJsFiles += fileTree(
2758 // these exlusions are files that the closure-compiler produces errors for. Should fix them
2759 "**/sun/misc/Unsafe.js",
2760 "**/swingjs/jquery/jquery-editable-select.js",
2761 "**/swingjs/jquery/j2sComboBox.js",
2762 "**/sun/misc/FloatingDecimal.js"
2765 def allClasslist = [
2766 'jsfile': "${outputDir}/core${allClasslistName}.js",
2767 'zjsfile': "${outputDir}/core${allClasslistName}.z.js",
2769 'name': allClasslistName
2771 // not including this version of "all" core at the moment
2772 //jalviewjsCoreClasslists += allClasslist
2773 inputs.files(allClasslist['list'])
2774 outputs.file(allClasslist['jsfile'])
2775 outputs.file(allClasslist['zjsfile'])
2778 def logOutFile = file("${jalviewDirAbsolutePath}/${jalviewjsBuildDir}/${jalviewjs_j2s_closure_stdout}")
2779 logOutFile.getParentFile().mkdirs()
2780 logOutFile.createNewFile()
2781 logOutFile.write(getDate("yyyy-MM-dd HH:mm:ss")+" jalviewjsBuildAllCores\n----\n")
2783 jalviewjsCoreClasslists.each {
2784 jalviewjsCallCore(it.name, it.list, prefixFile, suffixFile, it.jsfile, it.zjsfile, logOutFile, jalviewjs_j2s_to_console.equals("true"))
2791 def jalviewjsPublishCoreTemplate(String coreName, String templateName, File inputFile, String outputFile) {
2794 into file(outputFile).getParentFile()
2795 rename { filename ->
2796 if (filename.equals(inputFile.getName())) {
2797 return file(outputFile).getName()
2801 filter(ReplaceTokens,
2805 'MAIN': '"'+main_class+'"',
2807 'NAME': jalviewjsJalviewTemplateName+" [core ${coreName}]",
2808 'COREKEY': jalviewjs_core_key,
2809 'CORENAME': coreName
2816 task jalviewjsPublishCoreTemplates {
2817 dependsOn jalviewjsBuildAllCores
2818 def inputFileName = "${jalviewDir}/${j2s_coretemplate_html}"
2819 def inputFile = file(inputFileName)
2820 def outputDir = "${jalviewDir}/${jalviewjsTransferSiteCoreDir}"
2822 def outputFiles = []
2823 jalviewjsCoreClasslists.each { cl ->
2824 def outputFile = "${outputDir}/${jalviewjsJalviewTemplateName}_${cl.name}.html"
2825 cl['outputfile'] = outputFile
2826 outputFiles += outputFile
2830 jalviewjsCoreClasslists.each { cl ->
2831 jalviewjsPublishCoreTemplate(cl.name, jalviewjsJalviewTemplateName, inputFile, cl.outputfile)
2834 inputs.file(inputFile)
2835 outputs.files(outputFiles)
2839 task jalviewjsSyncCore (type: Sync) {
2840 dependsOn jalviewjsBuildAllCores
2841 dependsOn jalviewjsPublishCoreTemplates
2842 def inputFiles = fileTree(dir: "${jalviewDir}/${jalviewjsTransferSiteCoreDir}")
2843 def outputDir = "${jalviewDir}/${jalviewjsSiteDir}"
2847 def outputFiles = []
2848 rename { filename ->
2849 outputFiles += "${outputDir}/${filename}"
2855 outputs.files outputFiles
2856 inputs.files inputFiles
2860 // this Copy version of TransferSiteJs will delete anything else in the target dir
2861 task jalviewjsCopyTransferSiteJs(type: Copy) {
2862 dependsOn jalviewjsTranspile
2863 from "${jalviewDir}/${jalviewjsTransferSiteJsDir}"
2864 into "${jalviewDir}/${jalviewjsSiteDir}"
2868 // this Sync version of TransferSite is used by buildship to keep the website automatically up to date when a file changes
2869 task jalviewjsSyncTransferSiteJs(type: Sync) {
2870 from "${jalviewDir}/${jalviewjsTransferSiteJsDir}"
2872 into "${jalviewDir}/${jalviewjsSiteDir}"
2879 jalviewjsSyncAllLibs.mustRunAfter jalviewjsCopyTransferSiteJs
2880 jalviewjsSyncResources.mustRunAfter jalviewjsCopyTransferSiteJs
2881 jalviewjsSyncSiteResources.mustRunAfter jalviewjsCopyTransferSiteJs
2882 jalviewjsSyncBuildProperties.mustRunAfter jalviewjsCopyTransferSiteJs
2884 jalviewjsSyncAllLibs.mustRunAfter jalviewjsSyncTransferSiteJs
2885 jalviewjsSyncResources.mustRunAfter jalviewjsSyncTransferSiteJs
2886 jalviewjsSyncSiteResources.mustRunAfter jalviewjsSyncTransferSiteJs
2887 jalviewjsSyncBuildProperties.mustRunAfter jalviewjsSyncTransferSiteJs
2890 task jalviewjsPrepareSite {
2892 description "Prepares the website folder including unzipping files and copying resources"
2893 dependsOn jalviewjsSyncAllLibs
2894 dependsOn jalviewjsSyncResources
2895 dependsOn jalviewjsSyncSiteResources
2896 dependsOn jalviewjsSyncBuildProperties
2897 dependsOn jalviewjsSyncCore
2901 task jalviewjsBuildSite {
2903 description "Builds the whole website including transpiled code"
2904 dependsOn jalviewjsCopyTransferSiteJs
2905 dependsOn jalviewjsPrepareSite
2909 task cleanJalviewjsTransferSite {
2911 delete "${jalviewDir}/${jalviewjsTransferSiteJsDir}"
2912 delete "${jalviewDir}/${jalviewjsTransferSiteLibDir}"
2913 delete "${jalviewDir}/${jalviewjsTransferSiteSwingJsDir}"
2914 delete "${jalviewDir}/${jalviewjsTransferSiteCoreDir}"
2919 task cleanJalviewjsSite {
2920 dependsOn cleanJalviewjsTransferSite
2922 delete "${jalviewDir}/${jalviewjsSiteDir}"
2927 task jalviewjsSiteTar(type: Tar) {
2929 description "Creates a tar.gz file for the website"
2930 dependsOn jalviewjsBuildSite
2931 def outputFilename = "jalviewjs-site-${JALVIEW_VERSION}.tar.gz"
2932 archiveFileName = outputFilename
2934 compression Compression.GZIP
2936 from "${jalviewDir}/${jalviewjsSiteDir}"
2937 into jalviewjs_site_dir // this is inside the tar file
2939 inputs.dir("${jalviewDir}/${jalviewjsSiteDir}")
2943 task jalviewjsServer {
2945 def filename = "jalviewjsTest.html"
2946 description "Starts a webserver on localhost to test the website. See ${filename} to access local site on most recently used port."
2947 def htmlFile = "${jalviewDirAbsolutePath}/${filename}"
2950 SimpleHttpFileServerFactory factory = new SimpleHttpFileServerFactory()
2951 def port = Integer.valueOf(jalviewjs_server_port)
2956 while(port < start+1000 && !running) {
2958 def doc_root = new File("${jalviewDirAbsolutePath}/${jalviewjsSiteDir}")
2959 jalviewjsServer = factory.start(doc_root, port)
2961 url = jalviewjsServer.getResourceUrl(jalviewjs_server_resource)
2962 println("SERVER STARTED with document root ${doc_root}.")
2963 println("Go to "+url+" . Run gradle --stop to stop (kills all gradle daemons).")
2964 println("For debug: "+url+"?j2sdebug")
2965 println("For verbose: "+url+"?j2sverbose")
2966 } catch (Exception e) {
2971 <p><a href="${url}">JalviewJS Test. <${url}></a></p>
2972 <p><a href="${url}?j2sdebug">JalviewJS Test with debug. <${url}?j2sdebug></a></p>
2973 <p><a href="${url}?j2sverbose">JalviewJS Test with verbose. <${url}?j2sdebug></a></p>
2975 jalviewjsCoreClasslists.each { cl ->
2976 def urlcore = jalviewjsServer.getResourceUrl(file(cl.outputfile).getName())
2978 <p><a href="${urlcore}">${jalviewjsJalviewTemplateName} [core ${cl.name}]. <${urlcore}></a></p>
2980 println("For core ${cl.name}: "+urlcore)
2983 file(htmlFile).text = htmlText
2986 outputs.file(htmlFile)
2987 outputs.upToDateWhen({false})
2991 task cleanJalviewjsAll {
2993 description "Delete all configuration and build artifacts to do with JalviewJS build"
2994 dependsOn cleanJalviewjsSite
2995 dependsOn jalviewjsEclipsePaths
2998 delete "${jalviewDir}/${jalviewjsBuildDir}"
2999 delete "${jalviewDir}/${eclipse_bin_dir}"
3000 if (eclipseWorkspace != null && file(eclipseWorkspace.getAbsolutePath()+"/.metadata").exists()) {
3001 delete file(eclipseWorkspace.getAbsolutePath()+"/.metadata")
3003 delete jalviewjsJ2sAltSettingsFileName
3006 outputs.upToDateWhen( { false } )
3010 task jalviewjsIDE_checkJ2sPlugin {
3011 group "00 JalviewJS in Eclipse"
3012 description "Compare the swingjs/net.sf.j2s.core(-j11)?.jar file with the Eclipse IDE's plugin version (found in the 'dropins' dir)"
3015 def j2sPlugin = string("${jalviewDir}/${jalviewjsJ2sPlugin}")
3016 def j2sPluginFile = file(j2sPlugin)
3017 def eclipseHome = System.properties["eclipse.home.location"]
3018 if (eclipseHome == null || ! IN_ECLIPSE) {
3019 throw new StopExecutionException("Cannot find running Eclipse home from System.properties['eclipse.home.location']. Skipping J2S Plugin Check.")
3021 def eclipseJ2sPluginDirs = [ "${eclipseHome}/dropins" ]
3022 def altPluginsDir = System.properties["org.eclipse.equinox.p2.reconciler.dropins.directory"]
3023 if (altPluginsDir != null && file(altPluginsDir).exists()) {
3024 eclipseJ2sPluginDirs += altPluginsDir
3026 def foundPlugin = false
3027 def j2sPluginFileName = j2sPluginFile.getName()
3028 def eclipseJ2sPlugin
3029 def eclipseJ2sPluginFile
3030 eclipseJ2sPluginDirs.any { dir ->
3031 eclipseJ2sPlugin = "${dir}/${j2sPluginFileName}"
3032 eclipseJ2sPluginFile = file(eclipseJ2sPlugin)
3033 if (eclipseJ2sPluginFile.exists()) {
3039 def msg = "Eclipse J2S Plugin is not installed (could not find '${j2sPluginFileName}' in\n"+eclipseJ2sPluginDirs.join("\n")+"\n)\nTry running task jalviewjsIDE_copyJ2sPlugin"
3040 System.err.println(msg)
3041 throw new StopExecutionException(msg)
3044 def digest = MessageDigest.getInstance("MD5")
3046 digest.update(j2sPluginFile.text.bytes)
3047 def j2sPluginMd5 = new BigInteger(1, digest.digest()).toString(16).padLeft(32, '0')
3049 digest.update(eclipseJ2sPluginFile.text.bytes)
3050 def eclipseJ2sPluginMd5 = new BigInteger(1, digest.digest()).toString(16).padLeft(32, '0')
3052 if (j2sPluginMd5 != eclipseJ2sPluginMd5) {
3053 def msg = "WARNING! Eclipse J2S Plugin '${eclipseJ2sPlugin}' is different to this commit's version '${j2sPlugin}'"
3054 System.err.println(msg)
3055 throw new StopExecutionException(msg)
3057 def msg = "Eclipse J2S Plugin '${eclipseJ2sPlugin}' is the same as '${j2sPlugin}' (this is good)"
3063 task jalviewjsIDE_copyJ2sPlugin {
3064 group "00 JalviewJS in Eclipse"
3065 description "Copy the swingjs/net.sf.j2s.core(-j11)?.jar file into the Eclipse IDE's 'dropins' dir"
3068 def j2sPlugin = string("${jalviewDir}/${jalviewjsJ2sPlugin}")
3069 def j2sPluginFile = file(j2sPlugin)
3070 def eclipseHome = System.properties["eclipse.home.location"]
3071 if (eclipseHome == null || ! IN_ECLIPSE) {
3072 throw new StopExecutionException("Cannot find running Eclipse home from System.properties['eclipse.home.location']. NOT copying J2S Plugin.")
3074 def eclipseJ2sPlugin = "${eclipseHome}/dropins/${j2sPluginFile.getName()}"
3075 def eclipseJ2sPluginFile = file(eclipseJ2sPlugin)
3076 def msg = "WARNING! Copying this commit's j2s plugin '${j2sPlugin}' to Eclipse J2S Plugin '${eclipseJ2sPlugin}'\n* May require an Eclipse restart"
3077 System.err.println(msg)
3080 eclipseJ2sPluginFile.getParentFile().mkdirs()
3081 into eclipseJ2sPluginFile.getParent()
3087 task jalviewjsIDE_j2sFile {
3088 group "00 JalviewJS in Eclipse"
3089 description "Creates the .j2s file"
3090 dependsOn jalviewjsCreateJ2sSettings
3094 task jalviewjsIDE_SyncCore {
3095 group "00 JalviewJS in Eclipse"
3096 description "Build the core js lib closures listed in the classlists dir and publish core html from template"
3097 dependsOn jalviewjsSyncCore
3101 task jalviewjsIDE_SyncSiteAll {
3102 dependsOn jalviewjsSyncAllLibs
3103 dependsOn jalviewjsSyncResources
3104 dependsOn jalviewjsSyncSiteResources
3105 dependsOn jalviewjsSyncBuildProperties
3109 cleanJalviewjsTransferSite.mustRunAfter jalviewjsIDE_SyncSiteAll
3112 task jalviewjsIDE_PrepareSite {
3113 group "00 JalviewJS in Eclipse"
3114 description "Sync libs and resources to site dir, but not closure cores"
3116 dependsOn jalviewjsIDE_SyncSiteAll
3117 //dependsOn cleanJalviewjsTransferSite // not sure why this clean is here -- will slow down a re-run of this task
3121 task jalviewjsIDE_AssembleSite {
3122 group "00 JalviewJS in Eclipse"
3123 description "Assembles unzipped supporting zipfiles, resources, site resources and closure cores into the Eclipse transpiled site"
3124 dependsOn jalviewjsPrepareSite
3128 task jalviewjsIDE_SiteClean {
3129 group "00 JalviewJS in Eclipse"
3130 description "Deletes the Eclipse transpiled site"
3131 dependsOn cleanJalviewjsSite
3135 task jalviewjsIDE_Server {
3136 group "00 JalviewJS in Eclipse"
3137 description "Starts a webserver on localhost to test the website"
3138 dependsOn jalviewjsServer
3142 // buildship runs this at import or gradle refresh
3143 task eclipseSynchronizationTask {
3144 //dependsOn eclipseSetup
3145 dependsOn createBuildProperties
3147 dependsOn jalviewjsIDE_j2sFile
3148 dependsOn jalviewjsIDE_checkJ2sPlugin
3149 dependsOn jalviewjsIDE_PrepareSite
3154 // buildship runs this at build time or project refresh
3155 task eclipseAutoBuildTask {
3156 //dependsOn jalviewjsIDE_checkJ2sPlugin
3157 //dependsOn jalviewjsIDE_PrepareSite
3163 description "Build the site"
3164 dependsOn jalviewjsBuildSite