Merge pull request #141 from ppfeufer/js-settings-merge

[CHANGE] Proper JS settings merge
ppfeufer · Dec 15, 2024 · e79be0a · e79be0a
2 parents ed9e43d + 2c17ff1
commit e79be0a
Show file tree

Hide file tree

Showing 9 changed files with 137 additions and 26 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -35,6 +35,10 @@ Section Order:
 ### Security
 -->
 
+### Changed
+
+- Proper JS settings merge
+
 ## [2.2.2] - 2024-12-14
 
 ### Added

diff --git a/sovtimer/static/sovtimer/css/aa-sov-timer.css b/sovtimer/static/sovtimer/css/aa-sov-timer.css
@@ -85,3 +85,12 @@
         vertical-align: middle;
     }
 }
+
+/* Data tables
+------------------------------------------------------------------------------------- */
+@media all {
+    div.dataTables_filter input[type="search"] {
+        margin-left: 0 !important;
+        width: 100% !important;
+    }
+}
diff --git a/sovtimer/static/sovtimer/css/aa-sov-timer.min.css b/sovtimer/static/sovtimer/css/aa-sov-timer.min.css
diff --git a/sovtimer/static/sovtimer/css/aa-sov-timer.min.css.map b/sovtimer/static/sovtimer/css/aa-sov-timer.min.css.map
diff --git a/sovtimer/static/sovtimer/js/aa-sov-timer.js b/sovtimer/static/sovtimer/js/aa-sov-timer.js
@@ -1,8 +1,68 @@
-/* global aaSovtimerSettings, moment */
+/* global sovtimerJsSettingsDefaults, sovtimerJsSettingsOverride, moment */
 
 $(document).ready(() => {
     'use strict';
 
+    /**
+     * Checks if the given item is a plain object, excluding arrays and dates.
+     *
+     * @param {*} item - The item to check.
+     * @returns {boolean} True if the item is a plain object, false otherwise.
+     */
+    function isObject (item) {
+        return (
+            item && typeof item === 'object' && !Array.isArray(item) && !(item instanceof Date)
+        );
+    }
+
+    /**
+     * Recursively merges properties from source objects into a target object. If a property at the current level is an object,
+     * and both target and source have it, the property is merged. Otherwise, the source property overwrites the target property.
+     * This function does not modify the source objects and prevents prototype pollution by not allowing __proto__, constructor,
+     * and prototype property names.
+     *
+     * @param {Object} target - The target object to merge properties into.
+     * @param {...Object} sources - One or more source objects from which to merge properties.
+     * @returns {Object} The target object after merging properties from sources.
+     */
+    function deepMerge (target, ...sources) {
+        if (!sources.length) {
+            return target;
+        }
+
+        // Iterate through each source object without modifying the `sources` array.
+        sources.forEach(source => {
+            if (isObject(target) && isObject(source)) {
+                for (const key in source) {
+                    if (isObject(source[key])) {
+                        if (key === '__proto__' || key === 'constructor' || key === 'prototype') {
+                            continue; // Skip potentially dangerous keys to prevent prototype pollution.
+                        }
+
+                        if (!target[key] || !isObject(target[key])) {
+                            target[key] = {};
+                        }
+
+                        deepMerge(target[key], source[key]);
+                    } else {
+                        target[key] = source[key];
+                    }
+                }
+            }
+        });
+
+        return target;
+    }
+
+    // Build the settings object
+    let sovtimerSettings = sovtimerJsSettingsDefaults;
+    if (typeof sovtimerJsSettingsOverride !== 'undefined') {
+        sovtimerSettings = deepMerge(
+            sovtimerJsSettingsDefaults,
+            sovtimerJsSettingsOverride
+        );
+    }
+
     const elementTimerTotal = $('.aa-sovtimer-timers-total');
     const elementTimerUpcoming = $('.aa-sovtimer-timers-upcoming');
     const elementTimerActive = $('.aa-sovtimer-timers-active');
@@ -58,8 +118,9 @@ $(document).ready(() => {
      * @type {jQuery}
      */
     const sovCampaignTable = $('.aa-sovtimer-campaigns').DataTable({
+        language: sovtimerSettings.dataTables.translation,
         ajax: {
-            url: aaSovtimerSettings.url.ajaxUpdate,
+            url: sovtimerSettings.url.ajaxUpdate,
             dataSrc: '',
             cache: false
         },
@@ -85,7 +146,7 @@ $(document).ready(() => {
             {
                 data: 'start_time',
                 render: (data) => {
-                    return moment(data).utc().format(aaSovtimerSettings.dateformat);
+                    return moment(data).utc().format(sovtimerSettings.dateformat);
                 }
             },
             {
@@ -133,27 +194,28 @@ $(document).ready(() => {
         filterDropDown: {
             columns: [
                 {
-                    idx: 0
+                    idx: 0,
+                    title: sovtimerSettings.translations.type
                 },
                 {
                     idx: 10,
-                    title: aaSovtimerSettings.translations.system
+                    title: sovtimerSettings.translations.system
                 },
                 {
                     idx: 11,
-                    title: aaSovtimerSettings.translations.constellation
+                    title: sovtimerSettings.translations.constellation
                 },
                 {
                     idx: 12,
-                    title: aaSovtimerSettings.translations.region
+                    title: sovtimerSettings.translations.region
                 },
                 {
                     idx: 13,
-                    title: aaSovtimerSettings.translations.owner
+                    title: sovtimerSettings.translations.owner
                 },
                 {
                     idx: 14,
-                    title: aaSovtimerSettings.translations.activeCampaign
+                    title: sovtimerSettings.translations.activeCampaign
                 }
             ],
             autoSize: false,
@@ -168,7 +230,7 @@ $(document).ready(() => {
             elementTimerTotal.html(newTotal);
 
             // Upcoming timer (< 4 hrs)
-            if (data.active_campaign === aaSovtimerSettings.translations.no && data.remaining_time_in_seconds <= 14400) {
+            if (data.active_campaign === sovtimerSettings.translations.no && data.remaining_time_in_seconds <= 14400) {
                 $(row).addClass('aa-sovtimer-upcoming-campaign');
 
                 const currentUpcoming = elementTimerUpcoming.html();
@@ -178,7 +240,7 @@ $(document).ready(() => {
             }
 
             // Active timer
-            if (data.active_campaign === aaSovtimerSettings.translations.yes) {
+            if (data.active_campaign === sovtimerSettings.translations.yes) {
                 $(row).addClass('aa-sovtimer-active-campaign');
 
                 const currentActive = elementTimerActive.html();
@@ -207,15 +269,15 @@ $(document).ready(() => {
                 elementTimerTotal.html(newTotal);
 
                 // Upcoming timer (< 4 hrs)
-                if (item.active_campaign === aaSovtimerSettings.translations.no && item.remaining_time_in_seconds <= 14400) {
+                if (item.active_campaign === sovtimerSettings.translations.no && item.remaining_time_in_seconds <= 14400) {
                     const currentUpcoming = elementTimerUpcoming.html();
                     const newUpcoming = parseInt(currentUpcoming) + 1;
 
                     elementTimerUpcoming.html(newUpcoming);
                 }
 
                 // Active timer
-                if (item.active_campaign === aaSovtimerSettings.translations.yes) {
+                if (item.active_campaign === sovtimerSettings.translations.yes) {
                     const currentActive = elementTimerActive.html();
                     const newActive = parseInt(currentActive) + 1;