Add usage notifications

Author: dinoboy197

README.md

@@ -25,6 +25,4 @@ Open the [PageAccel Chrome Web store link](https://chrome.google.com/webstore/de
 * Register simplified and standard domains as pairs, in case they're different.
  * This may also alleviate the need for the tld domain list
 * Remove unused tabs from storage if not used in last x days
-* After either(days active > 2, pages viewed 500), tell user how many pages have been accelerated and show them which ones. If the percentage is high, show them the % of pages, else, just tell them how many pages. Tell them how many seconds / bytes they've saved by using pageaccel.
- * Do this at some regular intervals
 * Provide stats button in pageaccel so user can see stats anytime.

background.js

@@ -1,5 +1,5 @@
 /*
-Copyright 2016 Taylor Raack.
+Copyright 2016,2017 Taylor Raack.
 
 This file is part of PageAccel.
 
@@ -150,6 +150,40 @@ function buildAmpUrl(status) {
   }
 }
 
+function recordAmpSwitched() {
+  getFromStorage('ampSwitched', function(item) {
+    var newCount = item['count'] + 1;
+    if (Number.isInteger(Math.log(newCount)/Math.log(5))) {
+      // display a notification and increase the counter once the user has closed the notification
+
+      displayNotification(
+        newCount == 1 ?
+          "You're viewing your first PageAccel simplified page!" :
+          "PageAccel is still simplifying your web browsing experience!",
+        newCount == 1 ?
+          "Enjoy!" :
+          "You've viewed " + newCount + " simplified pages with PageAccel.", function () {
+        setToStorage('ampSwitched', {'count':newCount}, function() {});
+      });
+    } else {
+      // don't need to show a notification right now, just increase counter
+      setToStorage('ampSwitched', {'count':newCount}, function() {});
+    }
+  });
+}
+
+function displayNotification(title, message, onClose) {
+  chrome.permissions.contains({permissions: ['notifications']}, function(result) {
+    if (result) {
+      chrome.notifications.create(
+        { type: "basic", title: title, message: message, iconUrl: "amplifier128.png"},
+        function(notificationId) {
+          chrome.notifications.onClosed.addListener(onClose);
+      });
+    }
+  });
+}
+
 /*
  * AMP document discovery (https://www.ampproject.org/docs/reference/spec#amp-document-discovery)
  * 
@@ -195,6 +229,7 @@ function processTabState(tabId, senderUrl) {
       logpa("setting previous url to " + senderUrl, tabId);
       setTabStatus(tabStatus, function() {
         working = false;
+        recordAmpSwitched();
         chrome.tabs.update(tabId, { url : buildAmpUrl(status) });
       });
     } else {
@@ -396,7 +431,27 @@ function setUpInstallUninstallActions() {
   }
 }
 
+function primeAmpSwitchedCount() {
+  getFromStorage('ampSwitched', function(item) {
+    if (!('count' in item)) {
+      setToStorage('ampSwitched', {'count':0}, function() {});
+    }
+  });
+}
+
+function verifyNotificationPermissions() {
+  chrome.permissions.contains({permissions: ['notifications']}, function(result) {
+    if (!result) {
+      chrome.tabs.create({
+        url: chrome.extension.getURL("nonavigation.html")
+      });
+    }
+  });
+}
+
 primePublicSuffixList();
 
 setUpInstallUninstallActions();
 showSplashScreenOnFirstRun();
+primeAmpSwitchedCount();
+verifyNotificationPermissions();

compress.sh

@@ -11,6 +11,7 @@ firstRun2.html \
 firstRun.js \
 LICENSE \
 manifest.json \
+nonavigation.html \
 popup.html \
 popup.js \
 publicsuffixlist.js \

firstRun.js

@@ -1,5 +1,5 @@
 /*
-Copyright 2016 Taylor Raack <[email protected]>.
+Copyright 2016,2017 Taylor Raack <[email protected]>.
 
 This file is part of PageAccel.
 
@@ -38,4 +38,12 @@ $( document ).ready(function() {
       $('#instructions3').removeClass("hidden");
     });
   });
+
+  $("#promptForNavigation").click(function() {
+    chrome.permissions.request({permissions: ['notifications']}, function(granted) {
+      if (granted) {
+        window.close();
+      }
+    });
+  });
 });

manifest.json

@@ -30,5 +30,8 @@
     "activeTab",
     "webNavigation"
   ],
+  "optional_permissions": [
+    "notifications"
+  ],
   "content_security_policy": "script-src 'self' https://ajax.googleapis.com https://maxcdn.bootstrapcdn.com; object-src 'self'"
 }

nonavigation.html

@@ -0,0 +1,65 @@
+<!DOCTYPE html>
+
+<!--
+
+Copyright 2017 Taylor Raack.
+
+This file is part of PageAccel.
+
+PageAccel is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+PageAccel is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with PageAccel.  If not, see <http://www.gnu.org/licenses/>.
+-->
+
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
+    <title>PageAccel - New Permission needed</title>
+
+    <!-- Bootstrap -->
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
+    <link rel="stylesheet" href="style.css" />
+    <link rel="stylesheet" href="colors.css" />
+  </head>
+  <body>
+    <div class="container">
+      <div class="row row-margin mediumbg">
+        <div class="col-md-12 text-center">
+          <img src="amplifier128.png" class="img-responsive center-block" alt="PageAccel logo" /><br />
+          <h1 style="color: #000"><strong>PageAccel needs a new permission</strong></h1>
+        </div>
+      </div>
+      <div class="row row-margin vlightbg">
+        <div class="col-md-12 text-center lead">
+          We hope you are enjoying <strong>PageAccel</strong>. In order to continue displaying streamlined, accelerated, easy-to-use web pages, PageAccel needs a new Chrome permission.
+        </div>
+      </div>
+      <div class="row row-margin vlightbg">
+        <div class="col-md-12 text-center">
+          <div class="lead">
+            <button id="promptForNavigation">Click here to re-enable PageAccel</button>
+          </div>
+        </div>
+      </div>
+    </div>
+
+    <!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
+    <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
+    <!-- Include all compiled plugins (below), or include individual files as needed -->
+    <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
+
+    <script src="firstRun.js"></script>
+  </body>
+</html>