Add MacOS support

This is based on macVNC as the VNC server (no root required!)
and TigerVNC as the VNC client/viewer.

Author: ThomasFarstrike

.gitignore

@@ -98,6 +98,8 @@ dist/
 # external resources
 vnc-software/tigervnc-linux-x86_64
 vnc-software/uvnc-windows
+vnc-software/macVNC.app/
+vnc-software/tigervnc-macos-x86_64/
 
 # trashcan
 trash/

build_release_macos.sh

@@ -0,0 +1,81 @@
+#!/bin/sh
+
+echo "0) make sure all changes are committed"
+diff=$(git diff | wc -l)
+if [ $diff -gt 0 ]; then
+	echo "You have diff"
+	#exit 1
+fi
+
+echo "1) make sure devtools are set to false in src/main.js"
+if grep "devTools: true" src/main.js; then
+	echo "devTools: true found in src/main.js"
+	exit 2
+fi
+
+echo "2) make sure you've incremented the version number in package.json AND package-lock.json"
+read yes
+
+echo "3) Cleaning up old build..."
+rm -rf .webpack
+rm -rf dist
+rm -rf out
+# Don't include Windows and Linux binaries on MacOS
+rm -rf vnc-software/uvnc-windows
+rm -rf vnc-software/tigervnc-linux-x86_64
+if [ ! -d "vnc-software/tigervnc-macos-x86_64" ]; then
+        echo "vnc-software/tigervnc-macos-x86_64 not found, running vnc-software/download_generic.sh"
+        ./vnc-software/download_generic.sh "tigervnc-latest-stable.dmg" "tigervnc-macos-x86_64" "https://altushost-swe.dl.sourceforge.net/project/tigervnc/stable/1.13.1/TigerVNC-1.13.1.dmg" "d823197320e6903458f9039cb9d4dbf5d739ef7f9c18ccabfb68bc3fffe57b9d" "tigervnc.conf" "tigervnc-macos-x86_64/Contents/MacOS/plain.bin"
+	downloadresult=$?
+	if [ $downloadresult -ne 0 ]; then
+		echo "Download of VNC client returned error: $downloadresult"
+		exit 1
+	fi
+fi
+
+if [ ! -d "macVNC.app" ]; then
+	echo "macVNC.app not found, downloading it from https://github.com/LibVNC/macVNC and building it..."
+	brew install libvncserver cmake
+	brewresult=$?
+	if [ $? -ne 0 ]; then
+		echo "brew install libvncserver cmake failed with error: $brewresult"
+		echo "Make sure you have homebrew installed, see brew.sh"
+		exit 3
+	fi
+	cd vnc-software/
+	rm -rf build_macVNC
+	mkdir build_macVNC/
+	cd build_macVNC/
+	curl -L "https://github.com/LibVNC/macVNC/archive/59c58931ed5853f344a500b1674405e85d1e70ea.zip" > macVNC.zip
+	unzip macVNC.zip
+	cd macVNC-*
+	mkdir build
+	cd build
+	cmake ..
+	cmake --build .
+	if [ ! -d "macVNC.app" ]; then
+		echo "ERROR: building macVNC did not result in macVNC.app - something went wrong..."
+		exit 4
+	fi
+	mv macVNC.app ../../..
+	cd ../../..
+	rm -rf build_macVNC
+	cd ..
+fi
+
+
+# If you run it in dev mode first with:
+# npm run start
+# Then the app tries to connect to localhost:3000 instead of packaging the actual files when building with:
+#./node_modules/.bin/electron-builder
+
+# Therefore, first make sure the correct files are packaged with electron-forge:
+echo "4) Packaging with: electron-forge package -p macos -a x64"
+./node_modules/.bin/electron-forge package -p darwin
+
+# NOTE: Don't use prepackage because the electron-builder will not add the tigervnc/ folder:
+#./node_modules/.bin/electron-builder --prepackaged  out/peerviewer-linux-x64/ -l appimage
+echo "5) Building release binaries with: electron-builder --linux appimage deb snap rpm tar.gz"
+export DEBUG=electron-builder
+./node_modules/.bin/electron-builder --macos dmg
+

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "PeerViewer",
   "productName": "PeerViewer",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Peer-to-peer open source remote desktop and support solution, completely free for unlimited personal and commercial use.",
   "homepage": "https://peerviewer.github.io/",
   "main": ".webpack/main",

package.json

@@ -128,8 +128,8 @@ function findResourceFile(filename) {
 
 ipcMain.on('run-server', (event) => {
   // Make sure this OS is supported
-  if (process.platform !== 'linux' && process.platform !== 'win32') {
-    let error = 'Unsupported platform ' + process.platform + '. Only linux and win32 are supported, darwin (MacOS) not yet. Please reach out!';
+  if (process.platform !== 'linux' && process.platform !== 'win32' && process.platform != 'darwin') {
+    let error = 'Unsupported platform ' + process.platform + '. Only Linux, Windows and MacOS are supported, yours not yet. Please reach out!';
     console.log(error);
     event.reply(error);
     return -1;
@@ -153,6 +153,8 @@ ipcMain.on('run-server', (event) => {
       serverChild = runProcess(foundBinary, ['SecurityTypes=VncAuth','localhost=1','interface=127.0.0.1','rfbport=55900','PasswordFile='+dirname+nodePath.sep+'plain.bin']);
     } else if (process.platform === 'win32') {
       serverChild = findAndRunProcess('uvnc-windows\\x64\\winvnc.exe'); // uses the config file next to the binary
+    } else if (process.platform === 'darwin') {
+      serverChild = findAndRunProcess('macVNC.app/Contents/MacOS/macVNC', ['-rfbport','55900','-passwd','nopassword']);
     }
     if (!serverChild) {
       event.reply('run-server-log', "ERROR: Listening for connections using VNC server failed.");
@@ -165,8 +167,8 @@ ipcMain.on('run-server', (event) => {
 
 ipcMain.on('run-client', (event, data) => {
   // Make sure this OS is supported
-  if (process.platform !== 'linux' && process.platform !== 'win32') {
-    let error = 'Unsupported platform ' + process.platform + '. Only linux and win32 are supported, darwin (MacOS) not yet. Please reach out!';
+  if (process.platform !== 'linux' && process.platform !== 'win32' && process.platform != 'darwin') {
+    let error = 'Unsupported platform ' + process.platform + '. Only Linux, Windows and MacOS are supported, yours not yet. Please reach out!';
     console.log(error);
     event.reply(error);
     return -1;
@@ -182,12 +184,23 @@ ipcMain.on('run-client', (event, data) => {
   event.reply('run-client-log', "Network layer initialized.");
 
   event.reply('run-client-log', "Establishing outgoing connection...");
-  if (process.platform === 'linux') {
+  if (process.platform === 'linux' || process.platform === 'darwin') {
     let binaryName = 'tigervnc-linux-x86_64/usr/bin/vncviewer';
-    let foundBinary = findResourceFile(binaryName);
-    if (!foundBinary) {
-      console.log("Binary " + binaryName + " not found.");
-      return -2;
+    let foundBinary = '';
+    if (process.platform === 'linux') {
+      let binaryName = 'tigervnc-linux-x86_64/usr/bin/vncviewer';
+      foundBinary = findResourceFile(binaryName);
+      if (!foundBinary) {
+        console.log("Binary " + binaryName + " not found.");
+        return -2;
+      }
+    } else if (process.platform === 'darwin') {
+      let binaryName = 'tigervnc-macos-x86_64/Contents/MacOS/TigerVNC\ Viewer';
+      foundBinary = findResourceFile(binaryName);
+      if (!foundBinary) {
+        console.log("Binary " + binaryName + " not found.");
+        return -2;
+      }
     }
     // PasswordFile of TigerVNC viewer cannot be passed on commandline, so use the file next to the binary.
     let dirname = nodePath.dirname(foundBinary);

src/main.js

@@ -1,5 +1,8 @@
 #!/bin/sh -x
-# This script needs: readlink, dirname, curl, sha256sum, unzip, tar
+# This script needs: readlink, dirname, curl, shasum, unzip, tar
+# On windows: unzip
+# On linux: tar
+# On macos: hdiutil
 
 outfile="$1"
 outdir="$2"
@@ -19,15 +22,15 @@ mydir=$(dirname "$mydir")
 cd "$mydir"
 
 
-curl "$downloadlink" > "$outfile"
+curl -L "$downloadlink" > "$outfile"
 result=$?
 
 if [ $result -eq 0 ]; then
 	echo "Download successful, checking checksum and extracting..."
 	# make sure outdir is gone so it will be replaced entierly
 	rm -rf "$outdir"
 
-	echo "$shasum  $outfile" | sha256sum -c -
+	echo "$shasum  $outfile" | shasum -a 256 -c -
 	sharesult=$?
 	if [ "$sharesult" -eq 0 ]; then
 		if echo "$outfile" | grep "\.zip"; then
@@ -37,6 +40,12 @@ if [ $result -eq 0 ]; then
 				echo "ERROR: unzip failed!"
 				exit 3
 			fi
+		elif echo "$outfile" | grep "\.dmg"; then
+			echo "Extracting .dmg file"
+			mountpoint=/Volumes/tigervnc-for-peerviewer-build
+			hdiutil attach -mountpoint "$mountpoint" "$outfile"
+			cp -R "$mountpoint"/TigerVNC*.app tigervnc-macos-x86_64/
+			hdiutil detach "$mountpoint"
 		else # assume it's a tar
 			if tar xf "$outfile"; then
 				mv tigervnc-1.13.1.x86_64 tigervnc-linux-x86_64
@@ -48,7 +57,11 @@ if [ $result -eq 0 ]; then
 		fi
 		configfiledstdir=$(dirname "$configfiledst")
 		if [ -f "$configfilesrc" -a -d "$configfiledstdir" ]; then
-			cat "$configfilesrc" | sed  -e 's/\r*$/\r/' > "$configfiledst"
+			# the windows build requires removing \r so the line endings are only \n
+			#cat "$configfilesrc" | sed  -e 's/\r*$/\r/' > "$configfiledst"
+			#cat "$configfilesrc" | tr -d '\r' > "$configfiledst"
+			# Disabled the \r removal because the password file happens to contain a \r
+			cp "$configfilesrc" "$configfiledst"
 		else
 			echo "ERROR: could not write config file because $configfilesrc is not a file or $configfiledstdir is not a directory!"
 			exit 5