chore: add NodeUtils.getSystemSettingsDir

Author: abose

src-node/constants.js

@@ -1,3 +1,16 @@
+const os = require('os');
+
 exports.SYSTEM_SETTINGS_DIR_WIN = 'C:\\Program Files\\Phoenix Code Control\\';
 exports.SYSTEM_SETTINGS_DIR_MAC = '/Library/Application Support/phoenix-code-control/';
 exports.SYSTEM_SETTINGS_DIR_LINUX = '/etc/phoenix-code-control/';
+
+switch (os.platform()) {
+case 'win32':
+    exports.SYSTEM_SETTINGS_DIR = exports.SYSTEM_SETTINGS_DIR_WIN; break;
+case 'darwin':
+    exports.SYSTEM_SETTINGS_DIR = exports.SYSTEM_SETTINGS_DIR_MAC; break;
+case 'linux':
+    exports.SYSTEM_SETTINGS_DIR = exports.SYSTEM_SETTINGS_DIR_LINUX; break;
+default:
+    throw new Error(`Unsupported platform: ${os.platform()}`);
+}

src-node/licence-device.js

@@ -4,22 +4,13 @@ const fs = require('fs');
 const fsPromise = require('fs').promises;
 const path = require('path');
 const { exec } = require('child_process');
-const { SYSTEM_SETTINGS_DIR_WIN, SYSTEM_SETTINGS_DIR_MAC, SYSTEM_SETTINGS_DIR_LINUX } = require('./constants');
+const { SYSTEM_SETTINGS_DIR } = require('./constants');
 
 const options = { name: 'Phoenix Code' };
 const licenseFileContent = JSON.stringify({});
 
 function getLicensePath() {
-    switch (os.platform()) {
-    case 'win32':
-        return `${SYSTEM_SETTINGS_DIR_WIN}device-license`;
-    case 'darwin':
-        return `${SYSTEM_SETTINGS_DIR_MAC}device-license`;
-    case 'linux':
-        return `${SYSTEM_SETTINGS_DIR_LINUX}device-license`;
-    default:
-        throw new Error(`Unsupported platform: ${os.platform()}`);
-    }
+    return `${SYSTEM_SETTINGS_DIR}device-license`;
 }
 
 function sudoExec(command) {

src-node/utils.js

@@ -4,6 +4,7 @@ const fs = require('fs');
 const fsPromise = require('fs').promises;
 const path = require('path');
 const os = require('os');
+const { SYSTEM_SETTINGS_DIR } = require('./constants');
 const { lintFile } = require("./ESLint/service");
 const { addDeviceLicense, getDeviceID, isLicensedDevice, removeDeviceLicense } = require("./licence-device");
 let openModule, open; // dynamic import when needed
@@ -274,6 +275,10 @@ async function getOSUserName() {
     return os.userInfo().username;
 }
 
+async function getSystemSettingsDir() {
+    return SYSTEM_SETTINGS_DIR;
+}
+
 exports.getURLContent = getURLContent;
 exports.setLocaleStrings = setLocaleStrings;
 exports.getPhoenixBinaryVersion = getPhoenixBinaryVersion;
@@ -288,5 +293,6 @@ exports.removeDeviceLicense = removeDeviceLicense;
 exports.isLicensedDevice = isLicensedDevice;
 exports.getDeviceID = getDeviceID;
 exports.getOSUserName = getOSUserName;
+exports.getSystemSettingsDir = getSystemSettingsDir;
 exports._loadNodeExtensionModule = _loadNodeExtensionModule;
 exports._npmInstallInFolder = _npmInstallInFolder;

src/utils/NodeUtils.js

@@ -289,6 +289,23 @@ define(function (require, exports, module) {
         return utilsConnector.execPeer("getOSUserName");
     }
 
+    let _systemSettingsDir;
+    /**
+     * Retrieves the directory path for system settings. This method is applicable to native apps only.
+     *
+     * @return {Promise<string>} A promise that resolves to the path of the system settings directory.
+     * @throws {Error} If the method is called in browser app.
+     */
+    async function getSystemSettingsDir() {
+        if (!Phoenix.isNativeApp) {
+            throw new Error("getSystemSettingsDir is sudo folder is win/linux/mac. not available in browser.");
+        }
+        if(!_systemSettingsDir){
+            _systemSettingsDir = await utilsConnector.execPeer("getSystemSettingsDir");
+        }
+        return _systemSettingsDir;
+    }
+
     if(NodeConnector.isNodeAvailable()) {
         // todo we need to update the strings if a user extension adds its translations. Since we dont support
         // node extensions for now, should consider when we support node extensions.
@@ -332,6 +349,7 @@ define(function (require, exports, module) {
     exports.isLicensedDeviceSystemWide = isLicensedDeviceSystemWide;
     exports.getDeviceID = getDeviceID;
     exports.getOSUserName = getOSUserName;
+    exports.getSystemSettingsDir = getSystemSettingsDir;
 
     /**
      * checks if Node connector is ready