Merge pull request #245 from sas-fossdev/remove-analytics-code

removed analytics code, as it is not being used, modified extension options page

Author: Suhas Hariharan

src/js/background.js

@@ -24,7 +24,6 @@
 
 'use strict';
 
-import $ from 'jquery';
 const browser = require('webextension-polyfill');
 
 // Installation Process
@@ -34,75 +33,14 @@ browser.runtime.onInstalled.addListener((details) => {
     }
 });
 
-// Analytics
-var analytics = {};
-var version = browser.runtime.getManifest().version;
-browser.storage.local.get({ analytics: true, id: "" }).then(function (returned) {
-    analytics.enabled = returned.analytics;
-    analytics.id = returned.id;
-    if (analytics.id.length === 0) {
-        reset_analytics();
-    }
-});
-
 // Listen for requests from tabs
 browser.runtime.onMessage.addListener(message_recieve);
 function message_recieve (message) {
     switch (message.action) {
-        case "analytics_send":
-            analytics_send(message.args);
-            // Requires an args attribute. Args should be an object that must have a 'url' attribute and can have a string called 'action' and a object called 'extra'. The arg object can also have a boolean named 'override'.
-            break;
         case "open_settings":
             browser.runtime.openOptionsPage();
             break;
-        case "reset_analytics":
-            reset_analytics();
-            break;
         default:
             break;
     }
 }
-function analytics_send (arg) {
-    browser.storage.local.get({ analytics: true, percent_main_page: true, save_grades_temp: true }).then(function (returned) {
-        analytics.enabled = returned.analytics;
-        if (analytics.enabled) {
-            const cvar_json = JSON.stringify({ "1": ["version", version], "2": ["FP", returned.percent_main_page.toString()], "3": ["Save Grades Temp", returned.save_grades_temp.toString()] });
-            const send_info = {
-                'idsite': '4',
-                'rec': '1',
-                'url': arg.url,
-                '_id': analytics.id,
-                'apiv': '1',
-                'cid': analytics.id,
-                '_cvar': cvar_json,
-            };
-            if (typeof arg.action !== 'undefined') {
-                send_info.action_name = arg.action;
-            }
-            if (typeof arg.extra === 'object') {
-                const extra_entries = Object.entries(arg.extra);
-                for (let i = 0; i < extra_entries.length; i++) {
-                    send_info[extra_entries[i][0]] = extra_entries[i][1];
-                }
-            }
-            $.ajax({
-                url: "https://analytics.ydgkim.com/piwik.php",
-                type: "get",
-                data: send_info,
-            });
-        }
-    });
-}
-function reset_analytics () {
-    analytics.id = random_str(16, '1234567890abcdef');
-    browser.storage.local.set({ id: analytics.id });
-}
-
-function random_str (len, chars) {
-    let tr = "";
-    for (let i = 0; i < len; i++) {
-        tr += chars[Math.floor(Math.random() * chars.length)];
-    }
-    return tr;
-}

src/js/components/ExtensionInfo.vue

@@ -46,25 +46,21 @@
                     class="saspes-link"
                     href="https://github.com/sas-fossdev/saspes"
                     target="_blank"
-                    @click="link_analytics"
                 >Website/Source Code</a> |
                 <a
                     href="https://github.com/sas-fossdev/saspes/blob/master/CHANGELOG.md"
                     class="saspes-link"
                     target="_blank"
-                    @click="link_analytics"
                 >Changelog</a> |
                 <a
                     class="saspes-link"
                     href="https://github.com/sas-fossdev/saspes/issues"
                     target="_blank"
-                    @click="link_analytics"
                 >Issue Tracker</a> |
                 <a
                     class="saspes-link"
                     href="https://github.com/sas-fossdev/saspes/blob/master/LICENSE"
                     target="_blank"
-                    @click="link_analytics"
                 >License (AGPL-3.0-only)</a> |
                 <a
                     id="login-extension-settings"
@@ -88,13 +84,6 @@ export default {
         };
     },
     methods: {
-        link_analytics (e) {
-            const href = e.currentTarget.href;
-            browser.runtime.sendMessage({
-                action: "analytics_send",
-                args: { url: href, extra: { link: href } },
-            });
-        },
         toggleInfo () {
             this.showInfo = !this.showInfo;
             browser.storage.local.set({ showExtensionInfo: this.showInfo });

src/js/helpers.js

@@ -214,16 +214,6 @@ async function saveGradesLocally (username, courses) {
     browser.storage.local.set(user_data);
 }
 
-/**
- * Send Analytics ping
- * @param {String} action_input the action being taken
- * @param {String} [url] Url to report. Defaults to the current page in the browser
- */
-async function analytics_message (action_input, url) {
-    const href = url || window.location.href.split("?")[0];
-    browser.runtime.sendMessage({ action: "analytics_send", args: { url: href, action: action_input } });
-}
-
 export {
     gradeToFP,
     grade_fp,
@@ -235,7 +225,6 @@ export {
     extractFinalPercent,
     assignments,
     calculate_credit_hours,
-    analytics_message,
     getSavedGrades,
     saveGradesLocally,
 };

src/js/saspowerschoolff.js

@@ -34,7 +34,6 @@ import {
     calculate_gpa,
     extractFinalPercent,
     gradeToGPA,
-    analytics_message,
     saveGradesLocally,
     getSavedGrades,
 } from './helpers';
@@ -67,15 +66,10 @@ function main () {
     const page_url = window.location.href.split('#')[0];
     if (page_url === "https://powerschool.sas.edu.sg/guardian/homeHS.html") {
         main_page();
-        analytics_message("Main Page");
     } else if (page_url.match("https://powerschool.sas.edu.sg/guardian/scores") != null) {
         class_page();
-        analytics_message("Course Page");
     } else if (page_url === "https://powerschool.sas.edu.sg/guardian/home.html" || page_url === "https://powerschool.sas.edu.sg/public/" || page_url === "https://powerschool.sas.edu.sg/public/home.html") {
         login_page();
-        analytics_message("Login Page");
-    } else {
-        analytics_message("default");
     }
 }
 

src/js/views/Options.vue

@@ -2,11 +2,6 @@
     <div>
         <h3>Version: {{ version }}</h3>
         <form>
-            <label><input
-                v-model="options.analytics"
-                type="checkbox"
-            >Enable Analytics</label>
-            <br>
             <label><input
                 v-model="options.percent_main_page"
                 type="checkbox"
@@ -21,15 +16,9 @@
         <br>
         <footer>
             <br>
-            Analytics ID: {{ options.id }}<span style="white-space: nowrap; padding-left: 5px;" /><button @click="copyId">
-                <span v-if="copiedRecently">Copied!</span>
-                <span v-else>Copy</span>
-            </button><br>
-            <br>
-            SAS Powerschool Enhancement Suite is the collective work of many different people working together publicly. Visit our <a href="https://github.com/sas-fossdev/saspes">GitHub page</a> if you'd like to participate as well.<br>
+            SAS Powerschool Enhancement Suite is the collective work of many different people working together publicly. Visit our <a href="https://github.com/sas-fossdev/saspes" target="_blank">GitHub page</a> if you'd like to participate as well.<br>
             <br>
-            More info and source code (Anyone and everyone is welcome to contribute): <br>
-            <a href="https://github.com/sas-fossdev/saspes">https://github.com/sas-fossdev/saspes</a><br>
+            If you believe you have encountered a bug in the extension, or have any other inquiries, please create an issue on <a href="https://github.com/sas-fossdev/saspes/issues" target="_blank"> the repository</a> or email <a href="mailto:[email protected]" target="_blank">[email protected]</a><br>
             <br>
             Credits: <br>
             Special thanks to Alan Chang for the idea. <br>
@@ -42,14 +31,12 @@
 </template>
 
 <script>
-import { analytics_message } from '../helpers';
 import browser from 'webextension-polyfill';
 
 function defaultOptions () {
     return {
         id: "Not set yet",
         percent_main_page: true,
-        analytics: true,
         save_last_grades: true,
     };
 }
@@ -78,7 +65,6 @@ export default {
         },
     },
     async mounted () {
-        analytics_message("Options Page", "saspes://options");
         await this.resetData();
         browser.storage.onChanged.addListener(this.resetData);
     },