Add file associations when installing

[tobiasdiez]

Latest development version does not associate bib files with JabRef (using Windows installer, but probably applies to Linux and Mac as well).

jpackage has the following option:

--file-associations — Path to a Properties file that contains list of key, value pairs (absolute path or relative to the current directory). The keys "extension", "mime-type", "icon", and "description" can be used to describe the association. This option can be used multiple times.

The documentation is a bit sparse at this point. Probably needs a bit of experimentation using different formats. Relevant part of the build script:

jabref/build.gradle

Lines 565 to 607 in 9fd49bc

	if (OperatingSystem.current().isWindows()) {
	// This requires WiX to be installed: https://github.com/wixtoolset/wix3/releases
	installerType = "msi"
	imageOptions = [
	'--win-console',
	'--icon', "${projectDir}/src/main/resources/icons/jabref.ico",
	]
	installerOptions = [
	'--vendor', 'JabRef',
	'--app-version', "${project.version}",
	'--win-upgrade-uuid', 'd636b4ee-6f10-451e-bf57-c89656780e36',
	'--win-dir-chooser',
	'--win-shortcut',
	'--temp', "$buildDir/installer",
	'--resource-dir', "${projectDir}/buildres/windows"
	]
	}
	if (OperatingSystem.current().isLinux()) {
	imageOptions = [
	'--icon', "${projectDir}/src/main/resources/icons/JabRef-icon-64.png",
	]
	installerOptions = [
	'--vendor', 'JabRef',
	'--app-version', "${project.version}",
	// '--temp', "$buildDir/installer",
	'--resource-dir', "${projectDir}/buildres/linux",
	'--linux-menu-group', 'Office;',
	'--linux-rpm-license-type', 'MIT',
	// '--license-file', "${projectDir}/LICENSE.md",
	'--description', 'JabRef is an open source bibliography reference manager. The native file format used by JabRef is BibTeX, the standard LaTeX bibliography format.',
	'--linux-shortcut'
	]
	}
	if (OperatingSystem.current().isMacOsX()) {
	imageOptions = [
	'--icon', "${projectDir}/src/main/resources/icons/jabref.icns",
	]
	installerOptions = [
	'--vendor', 'JabRef',
	'--app-version', "${project.version}"
	]

[UltimaBGD]

Can I poke around at this?

[tobiasdiez]

Welcome @UltimaBGD! Feel free to work on this issue. Also have a look at our contribution guide and feel free to drop by in our developer chat if you have questions!

[UltimaBGD]

As of now, I have tried to input the
--file-associations
option within the Installer Options list with a path to a properties file. As of now it seems to be locating the file, but fails building with a null pointer exception for reasons I am not sure of.

[tobiasdiez]

Thanks for having a look at this. Could you please post the full exception details here, then I'll have a look.

[UltimaBGD]

Sorry for the late response, I will post a write-up of my attempts and the scan from Gradle, and we will see if I am missing something obvious. I will try to get to it later today.

[UltimaBGD]

Okay, so I added an additional line to the installerOptions for Windows following the same format as the other file paths.

I know it is able to locate the properties file I was creating as I tried specifying an incorrect pathname a number of times, and it would give an error stating that the filename could not be found in addition to the null pointer exception. When adding --file-associations is the only time it gives that null pointer exception. Had I removed it and changed nothing I am able to build an MSI successfully. I have tried a few pathnames, but as stated before it does seem to actually be locating the file. I do not know if it is the properties file itself or something with the command that is causing this at the moment.

Running the jpackage command through the scan option produces this:

https://scans.gradle.com/s/277hsazt3rx6w

It does note that it is a configuration problem, but I am not sure wherein the issue is. I could honestly be missing something really obvious.

[Siedlerchr]

I found this bug report which seems to be related:
https://bugs.openjdk.java.net/browse/JDK-8232935?filter=37667

[UltimaBGD]

So it seems to be isolated to when no mimetype is provided. I will check it out.

[Siedlerchr]

Note that there has been a new release of the jpackage tool (v64)
Build 14-jpackage+1-64 (2019/10/28)

Edit:// After the update oft the jpackage, the windows build fails. It would be cool if you could look into that as well: https://github.com/JabRef/jabref/runs/278995661

[UltimaBGD]

On the version we are currently on, that bug report is indeed the same cause. Adding a mime-type does allow for the build to continue.

[Siedlerchr]

@UltimaBGD Thanks for your testing and your digging into the issue! It would be reall nice if you could prepare a Pull Request to fix this issue and to fix our build.