Merge pull request #269 from smartdevicelink/bugfix/scm-null-check-capability

Align JS SCM and textgraphicmanager with Java Suite's

Author: crokita

examples/js/hello-sdl/SDL.min.js

@@ -37,6 +37,7 @@ import { LifecycleConfig as manager_LifecycleConfig_js} from './src/manager/Life
 import { SdlManager as manager_SdlManager_js} from './src/manager/SdlManager.js';
 import { SdlManagerListener as manager_SdlManagerListener_js} from './src/manager/SdlManagerListener.js';
 import { SystemCapabilityManager as manager_SystemCapabilityManager_js} from './src/manager/SystemCapabilityManager.js';
+import { _ManagerUtility as manager__ManagerUtility_js} from './src/manager/_ManagerUtility.js';
 import { _SdlManagerBase as manager__SdlManagerBase_js} from './src/manager/_SdlManagerBase.js';
 import { _SubManagerBase as manager__SubManagerBase_js} from './src/manager/_SubManagerBase.js';
 import { FileManager as manager_file_FileManager_js} from './src/manager/file/FileManager.js';
@@ -474,6 +475,7 @@ const SDL = {
         SdlManager: manager_SdlManager_js,
         SdlManagerListener: manager_SdlManagerListener_js,
         SystemCapabilityManager: manager_SystemCapabilityManager_js,
+        _ManagerUtility: manager__ManagerUtility_js,
         _SdlManagerBase: manager__SdlManagerBase_js,
         _SubManagerBase: manager__SubManagerBase_js,
         file: {

examples/node/hello-sdl-tcp/SDL.min.js

@@ -46,6 +46,7 @@ import { FunctionID } from '../rpc/enums/FunctionID.js';
 import { WindowCapability } from '../rpc/structs/WindowCapability.js';
 import { ServiceUpdateReason } from '../rpc/enums/ServiceUpdateReason.js';
 import { RpcResponse } from '../rpc/RpcResponse.js';
+import { _ManagerUtility } from './_ManagerUtility.js';
 
 class SystemCapabilityManager extends _SubManagerBase {
     /**
@@ -236,6 +237,8 @@ class SystemCapabilityManager extends _SubManagerBase {
 
         // return if display capabilities don't exist.
         if (displayCapabilities === null || displayCapabilities === undefined) {
+            defaultWindowCapability.setTextFields(_ManagerUtility.getAllTextFields());
+            defaultWindowCapability.setImageFields(_ManagerUtility.getAllImageFields());
             displayCapability.setWindowCapabilities([defaultWindowCapability]);
             return [displayCapability];
         }

examples/node/hello-sdl/SDL.min.js

@@ -0,0 +1,153 @@
+/*
+* Copyright (c) 2020, Livio, Inc.
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*
+* Redistributions of source code must retain the above copyright notice, this
+* list of conditions and the following disclaimer.
+*
+* Redistributions in binary form must reproduce the above copyright notice,
+* this list of conditions and the following
+* disclaimer in the documentation and/or other materials provided with the
+* distribution.
+*
+* Neither the name of the Livio Inc. nor the names of its contributors
+* may be used to endorse or promote products derived from this software
+* without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+* POSSIBILITY OF SUCH DAMAGE.
+*/
+
+import { TextField } from '../rpc/structs/TextField.js';
+import { ImageField } from '../rpc/structs/ImageField.js';
+import { TextFieldName } from '../rpc/enums/TextFieldName.js';
+import { ImageFieldName } from '../rpc/enums/ImageFieldName.js';
+import { CharacterSet } from '../rpc/enums/CharacterSet.js';
+import { FileType } from '../rpc/enums/FileType.js';
+
+class _ManagerUtility {
+    /**
+     * Check to see if WindowCapability has an ImageFieldName of a given name.
+     * @private
+     * @param {WindowCapability} windowCapability - Represents the capabilities of the desired window
+     * @param {ImageFieldName} name - Representing a name of a given Image field that would be stored in WindowCapability
+     * @return {Boolean} - True if the name exists in WindowCapability, otherwise false
+     */
+    static hasImageFieldOfName (windowCapability, name) {
+        if (windowCapability === null || name === null) {
+            return false;
+        }
+        if (windowCapability.getImageFields() !== null) {
+            for (const field of windowCapability.getImageFields()) {
+                if (field !== null && name === field.getNameParam()) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Check to see if WindowCapability has a textField of a given name.
+     * @private
+     * @param {WindowCapability} windowCapability - Represents the capabilities of the desired window
+     * @param {TextFieldName} name - Representing a name of a given text field that would be stored in WindowCapability
+     * @return {Boolean} - True if the name exists in WindowCapability, otherwise false
+     */
+    static hasTextFieldOfName (windowCapability, name) {
+        if (windowCapability === null || name === null) {
+            return false;
+        }
+        if (windowCapability.getTextFields() !== null) {
+            for (const field of windowCapability.getTextFields()) {
+                if (field !== null && name === field.getNameParam()) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Gets the number of show lines available on the head unit
+     * @private
+     * @param {WindowCapability} windowCapability - Represents the capabilities of the desired window
+     * @returns {Number} - The number of lines.
+     */
+    static getMaxNumberOfMainFieldLines (windowCapability) {
+        let highestFound = 0;
+        if (windowCapability !== null && windowCapability.getTextFields() !== null) {
+            for (const field of windowCapability.getTextFields()) {
+                let fieldNumber = 0;
+                switch (field.getNameParam()) {
+                    case TextFieldName.mainField1:
+                        fieldNumber = 1;
+                        break;
+                    case TextFieldName.mainField2:
+                        fieldNumber = 2;
+                        break;
+                    case TextFieldName.mainField3:
+                        fieldNumber = 3;
+                        break;
+                    case TextFieldName.mainField4:
+                        fieldNumber = 4;
+                        break;
+                }
+                if (fieldNumber > 0) {
+                    highestFound = Math.max(highestFound, fieldNumber);
+                    if (highestFound === 4) {
+                        break;
+                    }
+                }
+            }
+        }
+        return highestFound;
+    }
+
+    /**
+     * Method to get a list of all available text fields
+     * @private
+     * @return {TextField[]} - A list of all available text fields with CID1SET Character Set
+     */
+    static getAllTextFields () {
+        const allTextFields = [];
+        for (const textFieldName in TextFieldName._MAP) {
+            allTextFields.push(new TextField()
+                .setNameParam(TextFieldName._MAP[textFieldName])
+                .setCharacterSet(CharacterSet.CID1SET)
+                .setWidth(500)
+                .setRows(8));
+        }
+        return allTextFields;
+    }
+
+    /**
+     * Method to get a list of all available text fields
+     * @private
+     * @return {ImageField[]} - A list of all available Image fields with GRAPHIC_BMP, GRAPHIC_JPEG, GRAPHIC_PNG File Types
+     */
+    static getAllImageFields () {
+        const allImageFields = [];
+        const allImageFileTypes = [FileType.GRAPHIC_BMP, FileType.GRAPHIC_JPEG, FileType.GRAPHIC_PNG];
+        for (const imageFieldName in ImageFieldName._MAP) {
+            allImageFields.push(new ImageField()
+                .setNameParam(ImageFieldName._MAP[imageFieldName])
+                .setImageTypeSupported(allImageFileTypes));
+        }
+        return allImageFields;
+    }
+}
+
+export { _ManagerUtility };

examples/webengine/hello-sdl/SDL.min.js

@@ -33,7 +33,9 @@
 import { _SubManagerBase } from '../_SubManagerBase.js';
 import { Show } from '../../rpc/messages/Show.js';
 import { MetadataTags } from '../../rpc/structs/MetadataTags.js';
+import { ImageFieldName } from '../../rpc/enums/ImageFieldName.js';
 import { TextFieldName } from '../../rpc/enums/TextFieldName.js';
+import { _ManagerUtility } from '../_ManagerUtility.js';
 
 class _TextAndGraphicManagerBase extends _SubManagerBase {
     /**
@@ -239,11 +241,11 @@ class _TextAndGraphicManagerBase extends _SubManagerBase {
     _assembleShowText (show) {
         show = this._setBlankTextFields(show);
 
-        if (this._mediaTrackTextField !== null) {
+        if (this._mediaTrackTextField !== null && this._shouldUpdateMediaTrackField()) {
             show.setMediaTrack(this._mediaTrackTextField);
         }
 
-        if (this._title !== null) {
+        if (this._title !== null && this._shouldUpdateTitleField()) {
             show.setTemplateTitle(this._title);
         }
 
@@ -252,7 +254,7 @@ class _TextAndGraphicManagerBase extends _SubManagerBase {
             return show;
         }
 
-        const numberOfLines = this._getNumberOfLines();
+        const numberOfLines = this._defaultMainWindowCapability !== null ? _ManagerUtility.getMaxNumberOfMainFieldLines(this._defaultMainWindowCapability) : 4;
 
         switch (numberOfLines) {
             case 1: show = this._assembleOneLineShowText(show, nonNullFields);
@@ -643,21 +645,14 @@ class _TextAndGraphicManagerBase extends _SubManagerBase {
      * @returns {Boolean} - Whether or not the primary image needs to be uploaded.
      */
     _shouldUpdatePrimaryImage () {
-        if (this._defaultMainWindowCapability === null || !Array.isArray(this._defaultMainWindowCapability.getImageTypeSupported())
-            || this._defaultMainWindowCapability.getImageTypeSupported().length > 0) {
-            // Cannot detect if there is a secondary image, so we'll just try to detect if there's a primary image and allow it if there is.
-            if (this._currentScreenData.getGraphic() === null || this._currentScreenData.getGraphic() === undefined) {
-                return this._primaryGraphic !== null;
-            } else {
-                if (this._primaryGraphic === null) {
-                    return false;
-                }
-                const screenDataValue = this._currentScreenData.getGraphic().getValueParam();
-                const secondaryGraphicValue = this._primaryGraphic.getName();
-                return (`${screenDataValue}`).toLowerCase() === (`${secondaryGraphicValue}`).toLowerCase();
-            }
-        }
-        return false;
+        const templateSupportsPrimaryArtwork = this._templateSupportsImageField(ImageFieldName.graphic);
+
+        const currentScreenDataPrimaryGraphicName = (this._currentScreenData !== null && this._currentScreenData.getGraphic() !== null) ? this._currentScreenData.getGraphic().getValueParam() : null;
+        const primaryGraphicName = this._primaryGraphic !== null ? this._primaryGraphic.getName() : null;
+
+        return templateSupportsPrimaryArtwork
+                && (`${currentScreenDataPrimaryGraphicName}`).toLowerCase() !== (`${primaryGraphicName}`).toLowerCase()
+                && this._primaryGraphic !== null;
     }
 
     /**
@@ -666,46 +661,52 @@ class _TextAndGraphicManagerBase extends _SubManagerBase {
      * @returns {Boolean} - Whether or not the secondary image needs to be uploaded.
      */
     _shouldUpdateSecondaryImage () {
-        if (this._defaultMainWindowCapability === null || !Array.isArray(this._defaultMainWindowCapability.getImageTypeSupported())
-            || this._defaultMainWindowCapability.getImageTypeSupported().length > 0) {
-            // Cannot detect if there is a secondary image, so we'll just try to detect if there's a primary image and allow it if there is.
-            if (this._currentScreenData.getGraphic() === null || this._currentScreenData.getGraphic() === undefined) {
-                return this._secondaryGraphic !== null;
-            } else {
-                if (this._secondaryGraphic === null) {
-                    return false;
-                }
-                const screenDataValue = this._currentScreenData.getGraphic().getValueParam();
-                const secondaryGraphicValue = this._secondaryGraphic.getName();
-                return (`${screenDataValue}`).toLowerCase() === (`${secondaryGraphicValue}`).toLowerCase();
-            }
-        }
-        return false;
+        const templateSupportsSecondaryArtwork = this._templateSupportsImageField(ImageFieldName.graphic) || this._templateSupportsImageField(ImageFieldName.secondaryGraphic);
+
+        const currentScreenDataSecondaryGraphicName = (this._currentScreenData !== null && this._currentScreenData.getSecondaryGraphic() !== null) ? this._currentScreenData.getSecondaryGraphic().getValueParam() : null;
+        const secondaryGraphicName = this._secondaryGraphic !== null ? this._secondaryGraphic.getName() : null;
+        
+        return templateSupportsSecondaryArtwork
+                && (`${currentScreenDataSecondaryGraphicName}`).toLowerCase() !== (`${secondaryGraphicName}`).toLowerCase()
+                && this._secondaryGraphic !== null;
     }
 
     /**
-     * Gets the number of show lines available on the head unit
+     * Check to see if mediaTrackTextField should be updated
      * @private
-     * @returns {Number} - The number of lines.
+     * @return {Boolean} - True if mediaTrackTextField should be updated, false if not
      */
-    _getNumberOfLines () {
-        if (this._defaultMainWindowCapability === null) {
-            return 4;
-        }
+    _shouldUpdateMediaTrackField() {
+        return this._templateSupportsTextField(TextFieldName.mediaTrack);
+    }
 
-        let linesFound = 0;
-        const textFields = this._defaultMainWindowCapability.getTextFields();
+    /**
+     * Check to see if title should be updated
+     * @private
+     * @return {Boolean} - True if title should be updated, false if not
+     */
+    _shouldUpdateTitleField() {
+        return this._templateSupportsTextField(TextFieldName.templateTitle);
+    }
 
-        if (Array.isArray(textFields)) {
-            for (const field of textFields) {
-                const name = field.getNameParam();
-                if (name === TextFieldName.mainField1 || name === TextFieldName.mainField2 || name === TextFieldName.mainField3 || name === TextFieldName.mainField4) {
-                    linesFound += 1;
-                }
-            }
-        }
+    /**
+     * Check to see if template supports the specified text field
+     * @private
+     * @param {TextFieldName} name - The text field name to check
+     * @return {Boolean} - True if text field is supported, false if not
+     */
+    _templateSupportsTextField (name) {
+        return this._defaultMainWindowCapability === null || _ManagerUtility.hasTextFieldOfName(this._defaultMainWindowCapability, name);
+    }
 
-        return linesFound;
+    /**
+     * Check to see if template supports the specified image field
+     * @private
+     * @param {ImageFieldName} name - The image field name to check
+     * @return {Boolean} - True if image field is supported, false if not
+     */
+    _templateSupportsImageField (name) {
+        return this._defaultMainWindowCapability === null || _ManagerUtility.hasImageFieldOfName(this._defaultMainWindowCapability, name);
     }
 
     // SCREEN ITEM SETTERS AND GETTERS