Software licensing, support for pre-10.11 #47

dxdc · 2020-01-28T04:07:44Z

Ability to add software licensing via one of the following files (in the same folder as the app): license.txt, license.rtf, sla.r. If none of these files are present, nothing will be added.

Fixes #44

Modify to use full system paths
Support for pre-10.11 images (detected encoding based on minimum runtime for app)

…r property

sindresorhus · 2020-01-28T04:29:07Z

Thanks for contributing 🙌

Ability to add software licensing via one of the following files (in the same folder as the app): license.txt, license.rtf, sla.r. If none of these files are present, nothing will be added.

I think it would be better to add this to https://github.com/LinusU/node-appdmg, which is the package handling the actual DMG creation.

Potential fix for #44

👍

Modify to use full system paths

👍

Support for pre-10.11 images (detected encoding based on minimum runtime for app)

Sorry, not interested in this.

dxdc · 2020-01-28T04:33:31Z

I think it would be better to add this to https://github.com/LinusU/node-appdmg, which is the package handling the actual DMG creation.

Would take some refactoring to generalize it. Rather than build a specific one for every language, I tried to just keep it simple. appdmg seems to support a lot more options.

Support for pre-10.11 images (detected encoding based on minimum runtime for app)

Why? It's just a graceful fallback and won't impact things either way. Otherwise, it will fail on pre-10.11.

dxdc · 2020-01-28T14:13:16Z

All tests passing @sindresorhus

sindresorhus · 2020-02-09T11:06:44Z

This part could use some code comments. It's not very easy to follow: https://github.com/sindresorhus/create-dmg/pull/47/files#diff-2cce40143051e25f811b56c79d619bf5R150-R192

sindresorhus · 2020-02-09T10:54:45Z

cli.js

@@ -91,6 +98,12 @@ async function init() {
 	ora.text = 'Creating icon';
 	const composedIconPath = await composeIcon(path.join(appPath, 'Contents/Resources', `${appIconName}.icns`));

+	ora.text = 'Checking minimum runtime';
+	const {stdout: minSystemVersion} = await execa('/usr/libexec/PlistBuddy', ['-c', 'Print :LSMinimumSystemVersion', infoPlistPath]);


We already have the plist loaded as the appInfo variable. You can use that.

Ah, good catch. Fixed.

sindresorhus · 2020-02-09T10:54:48Z

cli.js

+// Adapted from:
+// https://github.com/electron-userland/electron-builder/tree/master/packages/dmg-builder/src
+
+function getRtfUnicodeEscapedString(text) {


I think this and the below methods should be moved to a util.js file.

Moved all logic to sla.js file

sindresorhus · 2020-02-09T10:57:59Z

cli.js

+			if (hasRaw || hasRtf || hasTxt) {
+				ora.text = 'Adding Software License Agreement';
+
+				const tempDmgPath = tempy.file({extension: 'dmg'});


The logic from here and until line 191 should be moved out into a separate function, including the above variables. It could be named addLicenseAgreementIfNeeded() or something.

Ended up moving the entire SLA logic to a separate file

sindresorhus · 2020-02-09T11:02:02Z

cli.js

+					data += '\ndata \'RTF \' (5000, "English") {\n';
+
+					if (hasRtf) {
+						data += serializeString((Buffer.from(fs.readFileSync(rtfSlaFile, 'utf8')).toString('hex').toUpperCase()));


Buffer.from(fs.readFileSync(rtfSlaFile, 'utf8'))

If you drop the utf8 the file will be read directly as a buffer.

sindresorhus · 2020-02-09T11:03:30Z

readme.md


 It will try to code sign the DMG, but the DMG is still created and fine even if the code signing fails, for example if you don't have a developer certificate.

 <img src="screenshot-dmg.png" width="772">

+### Software license
+
+If `license.txt`, `license.rtf`, or `sla.r` (raw SLAResources file) are present in the same folder as the app, they will be added as a software agreement when opening the image. The image will not be mounted unless the user indicates agreement with the license.


Can you linkify raw SLAResources file to a source where the user can read more about raw SLAResource files.

sindresorhus · 2020-02-09T11:05:09Z

readme.md

+
+If `license.txt`, `license.rtf`, or `sla.r` (raw SLAResources file) are present in the same folder as the app, they will be added as a software agreement when opening the image. The image will not be mounted unless the user indicates agreement with the license.
+
+`/usr/bin/rez` (Xcode Developer Tools) must be installed.


Suggested change

`/usr/bin/rez` (Xcode Developer Tools) must be installed.

`/usr/bin/rez` (Xcode Command Line Tools) must be installed.

And linkify it to https://developer.apple.com/download/more/

sindresorhus · 2020-02-09T11:08:37Z

cli.js

@@ -91,6 +98,12 @@ async function init() {
 	ora.text = 'Creating icon';
 	const composedIconPath = await composeIcon(path.join(appPath, 'Contents/Resources', `${appIconName}.icns`));

+	ora.text = 'Checking minimum runtime';
+	const {stdout: minSystemVersion} = await execa('/usr/libexec/PlistBuddy', ['-c', 'Print :LSMinimumSystemVersion', infoPlistPath]);
+	const minorVersion = Number(minSystemVersion.replace('10.', '')) || 0;


This check is not good enough:

'10.10.2'.replace('10.', '') //=> "10.2"

Good catch. Added some modified logic, hope you agree. It's not as sophisticated as a true 'version compare' but hopefully will be sufficient. Otherwise, we can replace this with a true version compare logic (which can compare 10.10.1a for example).

On our usage we've noticed one machine was making bad DMGs.
I'm now investigating the Xcode diffs. but this logic will fail if no LSMinimumSystemVersion exists.

@talaviram normally this is included by default in XCode. Are you running into a situation where it's not?

Something like:

otool -l /usr/local/go/bin/go | grep -B1 -A3 MIN_MACOS

Can also be used to define min versioning, but it will need some more work to incorporate.

sindresorhus · 2020-02-09T11:09:59Z

cli.js

@@ -65,6 +66,12 @@ try {
 	throw error;
 }

+let dmgFormat;


This doesn't need to be top-level.

sindresorhus · 2020-02-09T11:10:14Z

cli.js

 		appInfo = plist.parse(stdout);
 	}

 	const appName = appInfo.CFBundleDisplayName || appInfo.CFBundleName;
 	const appIconName = appInfo.CFBundleIconFile.replace(/\.icns/, '');
-	const dmgTitle = appName.length > 27 ? (cli.flags['dmg-title'] || appName) : appName;
+	const dmgTitle = appName.length > 27 ? (cli.flags['dmgTitle'] || appName) : appName;


Suggested change

const dmgTitle = appName.length > 27 ? (cli.flags['dmgTitle'] || appName) : appName;

const dmgTitle = appName.length > 27 ? (cli.flags.dmgTitle || appName) : appName;

sindresorhus · 2020-02-09T11:10:36Z

cli.js

@@ -91,6 +98,12 @@ async function init() {
 	ora.text = 'Creating icon';
 	const composedIconPath = await composeIcon(path.join(appPath, 'Contents/Resources', `${appIconName}.icns`));

+	ora.text = 'Checking minimum runtime';


I don't think this needs a step. We'll just show the outcome.

dxdc · 2020-02-10T01:47:47Z

@sindresorhus Addressed all code review changes

sindresorhus · 2020-02-19T11:21:06Z

Looks good now. Thanks! :)

dxdc added 5 commits January 27, 2020 21:55

Use full system paths

9b2d66d

Choose DMG encoding based on minimum runtime

74cf64f

Potential fix for #44; errors not handled if error did not have stder…

b771943

…r property

Feature to add software license

fbe17b9

Update documentation

229b53b

dxdc added 3 commits January 28, 2020 07:59

Fixed disk image format

fd2a937

Address lint errors

7683b7e

Fix image type in documentation

804ca3d

Wrong reference to dmgTitle

6de191e

sindresorhus requested changes Feb 9, 2020

View reviewed changes

dxdc added 6 commits February 9, 2020 19:28

Separate sla.js into separate file

9805f65

Remove dmgFormat from top-level

4bd29f1

Use dot notation for dmgTitle

d712516

Fixes to minSystemVersion from code review

c7e44da

Linkify for documentation

e604c70

Tweak logic; add code comments for sla

87d0e9c

sindresorhus changed the title ~~Software licensing, support for pre-10.11, #44~~ Software licensing, support for pre-10.11 Feb 19, 2020

sindresorhus added 2 commits February 19, 2020 18:13

Update readme.md

4ae7b04

Update sla.js

a7e78b5

sindresorhus merged commit 7d684a2 into sindresorhus:master Feb 19, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Software licensing, support for pre-10.11 #47

Software licensing, support for pre-10.11 #47

dxdc commented Jan 28, 2020 •

edited by sindresorhus

sindresorhus commented Jan 28, 2020

dxdc commented Jan 28, 2020

dxdc commented Jan 28, 2020

sindresorhus commented Feb 9, 2020

sindresorhus Feb 9, 2020

dxdc Feb 10, 2020

sindresorhus Feb 9, 2020

dxdc Feb 10, 2020

sindresorhus Feb 9, 2020

dxdc Feb 10, 2020

sindresorhus Feb 9, 2020

dxdc Feb 10, 2020

sindresorhus Feb 9, 2020

dxdc Feb 10, 2020

sindresorhus Feb 9, 2020

dxdc Feb 10, 2020

sindresorhus Feb 9, 2020

dxdc Feb 10, 2020

talaviram Nov 25, 2020

dxdc Nov 25, 2020

sindresorhus Feb 9, 2020

dxdc Feb 10, 2020

sindresorhus Feb 9, 2020

dxdc Feb 10, 2020

sindresorhus Feb 9, 2020

dxdc Feb 10, 2020

dxdc commented Feb 10, 2020

sindresorhus commented Feb 19, 2020


		If `license.txt`, `license.rtf`, or `sla.r` (raw SLAResources file) are present in the same folder as the app, they will be added as a software agreement when opening the image. The image will not be mounted unless the user indicates agreement with the license.

		`/usr/bin/rez` (Xcode Developer Tools) must be installed.

	`/usr/bin/rez` (Xcode Developer Tools) must be installed.
	`/usr/bin/rez` (Xcode Command Line Tools) must be installed.

	const dmgTitle = appName.length > 27 ? (cli.flags['dmgTitle'] \|\| appName) : appName;
	const dmgTitle = appName.length > 27 ? (cli.flags.dmgTitle \|\| appName) : appName;

Software licensing, support for pre-10.11 #47

Software licensing, support for pre-10.11 #47

Conversation

dxdc commented Jan 28, 2020 • edited by sindresorhus

sindresorhus commented Jan 28, 2020

dxdc commented Jan 28, 2020

dxdc commented Jan 28, 2020

sindresorhus commented Feb 9, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dxdc commented Feb 10, 2020

sindresorhus commented Feb 19, 2020

dxdc commented Jan 28, 2020 •

edited by sindresorhus