Merge pull request #3738 from WhelanB/clkshortcuts

New app "Shortcuts"

Author: thyttan

apps/clkshortcuts/ChangeLog

@@ -0,0 +1 @@
+0.01: New app!

apps/clkshortcuts/README.md

@@ -0,0 +1,10 @@
+# Shortcuts
+
+An app that allows you to create custom ClockInfos that act as shortcuts to your favourite apps.
+
+## Create a Shortcut
+After installing the app, you can open the app to add and manage existing shortcuts. If no shortcuts exist, the app will display a ``[+] Shortcuts`` button as a ClockInfo on your Clock (see screenshots), which when clicked will quickly launch into the app so you can add new shortcuts.
+
+When adding a shortcut, first select the app you wish to use, then select the icon you wish to register to the shortcut. If a keyboard is installed, you'll get the option to rename the shortcut before saving.
+
+Once created, your shortcut will appear on any Clocks with ClockInfo support, and tapping the shortcut will launch the chosen app

apps/clkshortcuts/add_shortcuts_screenshot.png

@@ -0,0 +1,224 @@
+var storage = require("Storage");
+var keyboard = "textinput";
+try {
+  keyboard = require(keyboard);
+} catch (e) {
+  keyboard = null;
+}
+
+var icons = [
+  {name:"agenda", img :"GBiBAAAAAAA8AAB+AA/n8B/n+BgAGBgAGBn/mBn/mBgAGBgAGBn/mBn/+BgD/BgHDhn+Bhn8MxgMIxgMIx/8Ew/+BgAHDgAD/AAA8A=="},
+  {name:"alarm", img:"GBiBAAAAAAAAAAYAYA4AcBx+ODn/nAOBwAcA4A4YcAwYMBgYGBgYGBgYGBgYGBgeGBgHGAwBMA4AcAcA4AOBwAH/gAB+AAAAAAAAAA=="},
+  {name:"mail", img:"GBiBAAAAAAAAAAAAAAAAAB//+D///DAADDgAHDwAPDcA7DPDzDDnDDA8DDAYDDAADDAADDAADDAADD///B//+AAAAAAAAAAAAAAAAA=="},
+  {name:"android", img: "GBiBAAAAAAEAgAD/AAD/AAHDgAGBgAMkwAMAwAP/wBv/2BsA2BsA2BsA2BsA2BsA2BsA2Bv/2AP/wADnAADnAADnAADnAADnAAAAAA=="},
+  {name:"add", img:"GBiBAAAAAAAAAAAAAA//8B//+BgAGBgAGBgYGBgYGBgYGBgYGBn/mBn/mBgYGBgYGBgYGBgYGBgAGBgAGB//+A//8AAAAAAAAAAAAA=="},
+  {name:"bangle", img:"GBiBAAD+AAH+AAH+AAH+AAH/AAOHAAYBgAwAwBgwYBgwYBgwIBAwOBAwOBgYIBgMYBgAYAwAwAYBgAOHAAH/AAH+AAH+AAH+AAD+AA=="},
+  {name:"bike", img:"GBiBAAAAAAAAAAAAAAAD+AAD/AADjAABjAfhnAfjyAMDwAcGwB4O+H8M/GGZ5sD7c8fzM8fjM8DDA2GBhn8B/h4AeAAAAAAAAAAAAA=="},
+  {name:"map", img:"GBiBAAAAAAAAAAAAAADgGAf8+B//+BjHGBjDGBjDGBjDGBjDGBjDGBjDGBjDGBjDGBjDGBjDGBjjGB//+B8/4BgHAAAAAAAAAAAAAA=="},
+  {name:"play", img:"GBiBAAAAAAAAAAAAAA//8B//+BgAGBjAGBjwGBj8GBjeGBjHmBjB2BjB2BjHmBjeGBj8GBjwGBjAGBgAGB//+A//8AAAAAAAAAAAAA=="},
+  {name:"fast forward", img:"GBiBAAAAAAAAAAAAAH///v///8AAA8YYA8eeA8f/g8b7w8Y488YYO8YYO8Y488b7w8f/g8eeA8YYA8AAA////3///gAAAAAAAAAAAA=="},
+  {name:"rewind", img:"GBiBAAAAAAAAAAAAAH///v///8AAA8AYY8B548H/48PfY88cY9wYY9wYY88cY8PfY8H/48B548AYY8AAA////3///gAAAAAAAAAAAA=="},
+  {name:"timer", img:"GBiBAAAAAAB+AAB+AAAAMAB+OAH/nAOByAcA4A4YcAwYMBgYGBgYGBgYGBgYGBgAGBgAGAwAMA4AcAcA4AOBwAH/gAB+AAAAAAAAAA=="},
+  {name:"connected", img:"GBiBAAAAAAAAAAAAAA//8B//+BgAGBgAGBngGBn4GBgcGBgOGBnHGBnzGBgxmBgZmBmZmBmZmBgAGBgAGB//+A//8AAAAAAAAAAAAA=="},
+  {name:"lock", img:"GBiBAAAAAAA8AAD/AAHDgAGBgAMAwAMAwAMAwAf/4A//8AwAMAwAMAwAMAwYMAw8MAw8MAwYMAwAMAwAMAwAMA//8Af/4AAAAAAAAA=="},
+  {name:"battery", img:"GBiBAAAAAAAAAAB+AAB+AAHngAPnwAMAwAMAwAMIwAMIwAMYwAM4wAM+wAN8wAMcwAMYwAMQwAMQwAMAwAMAwAP/wAH/gAAAAAAAAA=="},
+  {name:"game", img:"GBiBAAAAAAAAAAAAAAA8AAB+AABmAABmAAB+AAA8AAAYAAAYAAAYAAMYAA//8B//+BgAGBgAGBgAGBgAGB//+A//8AAAAAAAAAAAAA=="},
+  {name:"dice", img:"GBiBAAAAAB//8D//+HAAPGMDHmeHnmeHnmMDHmAAHmMDHmeHnmeHnmMDHmAAHmMDHmeHnmeHnmMDHnAAPn///j///h///g///AAAAA=="},
+  {name:"gear", img:"GBiBAAAAAAAAAAA8AAB+AABmAA3nsA/D8B8A+Dg8HBx+OAznMAzDMAzDMAznMBx+ODg8HB8A+A/D8A3nsABmAAB+AAA8AAAAAAAAAA=="},
+  {name:"wrench", img:"GBiBAAAAAAAAAAAAAAAHgAAfwAA7gAAzEABjOABj+ABh+ABgGADgMAHAcAOP4AcfgA44AB9wADHgADHAADGAAB8AAA4AAAAAAAAAAA=="},
+  {name:"calendar", img:"FhgBDADAMAMP/////////////////////8AADwAAPAAA8AADwAAPAAA8AADwAAPAAA8AADwAAPAAA8AADwAAP///////"},
+  {name:"power", img:"GBiBAAAAAAAAAAB+AAH/gAeBwA4YcAwYMBjbGBnbmDGZjDMYzDMYzDMAzDMAzDGBjBnDmBj/GAw8MA4AcAeB4AH/gAB+AAAAAAAAAA=="},
+  {name:"terminal", img:"GBiBAAAAAAAAAAAAAA//8B//+B//+B//+B//+BgAGBgAGBgAGBmAGBjAGBhgGBhgGBjAGBmPmBgAGBgAGB//+A//8AAAAAAAAAAAAA=="},
+  {name:"camera", img:"GBiBAAAAAAAAAAD/AAH/gAMAwD8A/H8A/mA8BmD/BmHDhmGBhmMAxmMAxmMAxmMAxmGBhmHDhmD/BmA8BmAABn///j///AAAAAAAAA=="},
+  {name:"phone", img:"GBiBAAAAAAAAAAOAAA/AABzgADBgADBgADBgABjgABjAABzAAAxgAA5wAAc58AMf+AGHHADgDABwDAA8GAAfGAAH8AAA4AAAAAAAAA=="},
+  {name:"two prong plug", img:"GBiBAAABgAADwAAHwAAPgACfAAHOAAPkBgHwDwP4Hwf8Pg/+fB//OD//kD//wD//4D//8D//4B//QB/+AD/8AH/4APnwAHAAACAAAA=="},
+  {name:"steps", img:"GBiBAAcAAA+AAA/AAA/AAB/AAB/gAA/g4A/h8A/j8A/D8A/D+AfH+AAH8AHn8APj8APj8AHj4AHg4AADAAAHwAAHwAAHgAAHgAADAA=="},
+  {name:"graph", img:"GBiBAAAAAAAAAAAAAAAAAAAAAADAAADAAAHAAAHjAAHjgAPngH9n/n82/gA+AAA8AAA8AAAcAAAYAAAYAAAAAAAAAAAAAAAAAAAAAA=="},
+  {name:"hills", img:"GBiBAAAAAAAAAAAAAAAAAAAAAAACAAAGAAAPAAEZgAOwwAPwQAZgYAwAMBgAGBAACDAADGAABv///////wAAAAAAAAAAAAAAAAAAAA=="},
+  {name:"sun", img:"GBiBAAAYAAAYAAAYAAgAEBwAOAx+MAD/AAHDgAMAwAcA4AYAYOYAZ+YAZwYAYAcA4AMAwAHDgAD/AAx+MBwAOAgAEAAYAAAYAAAYAA=="},
+  {name:"home", img:"GBiBAAAAAAAAAAAAAAH/gAP/wAdg4A5wYA44MBwf+DgP/BgAGBgAGBgAGBnnmBnnmBnnmBnnmBngGBngGB//+B//+AAAAAAAAAAAAA=="},
+  {name:"bell", img:"GBiBAAAAAAAAAAAfgAB/2ADw+AHAMAOAGAcAGD4ADHgADDgADBwADA4AHAcAGAOAOAHAcAPg4ANxwAM5gAP/AAHvAAAHAAACAAAAAA=="},
+  {name:"bin", img:"GBiBAAAAAAAAAAB+AB//+B//+AwAMAwAMAxmMAZmYAZmYAZmYAZmYAZmYAZmYAZmYAZmYAZmYANmwAMAwAMAwAP/wAH/gAAAAAAAAA=="},
+];
+
+let storedApps;
+var showMainMenu = () => {
+  storedApps = storage.readJSON("clkshortcuts.json", 1) || {};
+
+  var mainMenu = {
+    "": {
+      title: "Shortcuts",
+    },
+    "< Back": () => {
+      load();
+    },
+    "New": () => {
+          // Select the app
+      getSelectedApp().then((app) => {
+          getSelectedIcon().then((icon) => {
+            promptForRename(app.name).then((name) => {
+              E.showMessage("Saving...");
+              storedApps[app.src] = {
+                name: name, src: app.src, icon: icon
+              };
+              storage.writeJSON("clkshortcuts.json", storedApps);
+              showMainMenu();
+            }).catch(() => {
+              E.showMessage("Saving...");
+              storedApps[app.src] = {
+                name: app.name, src: app.src, icon: icon
+              };
+              storage.writeJSON("clkshortcuts.json", storedApps);
+              showMainMenu();
+            } );
+          }).catch(() => {showMainMenu();});
+        }).catch(() => {showMainMenu();});
+    },
+  };
+  getStoredAppsArray(storedApps).forEach((app) => {
+    mainMenu[app.name] = {
+        onchange: () => {
+          showEditMenu(app).then((dirty) => {
+            if (dirty) {
+              E.showMessage("Saving...");
+              storage.writeJSON("clkshortcuts.json", storedApps);
+            }
+            showMainMenu();
+          });
+        },
+        format: v=>"\0" + atob(app.icon)
+      };
+  });
+  E.showMenu(mainMenu);
+};
+
+var showEditMenu = (app) => {
+  return new Promise((resolve, reject) => {
+    var editMenu = {
+      "": {
+        title: "Edit " + app.name,
+      },
+      "< Back": () => {
+        resolve(false);
+      },
+      "Name":{
+        onchange: () => {
+          promptForRename(app.name).then((name) => {
+            storedApps[app.src].name = name;
+            resolve(true);
+          }).catch();
+        },
+        format: v=>app.name.substring(0, 7)
+      },
+      "Icon": {
+        onchange: () => {
+          getSelectedIcon().then((icon) => {
+            storedApps[app.src].icon = icon;
+            resolve(true);
+          }).catch(() => resolve(false));
+        },
+        format: v=>"\0" + atob(app.icon)
+      },
+      "Delete": {
+        onchange: () => {
+          delete storedApps[app.src]
+          resolve(true);
+        },
+        format: v=>"\0" + atob("GBiBAAAAAAAAAAB+AB//+B//+AwAMAwAMAxmMAZmYAZmYAZmYAZmYAZmYAZmYAZmYAZmYAZmYANmwAMAwAMAwAP/wAH/gAAAAAAAAA==")
+      }
+    };
+      E.showMenu(editMenu);
+  });
+};
+
+var promptForRename = (name) => {
+  return new Promise((resolve, reject) => {
+    if (!keyboard) { reject("No textinput is available"); }
+    else {
+      return require("textinput").input({text:name}).then((result) => resolve(result));
+    }
+  });
+};
+
+var getStoredAppsArray = (apps) => {
+  var appList = Object.keys(apps);
+  var storedAppArray = [];
+  for (var i = 0; i < appList.length; i++) {
+    var app = "" + appList[i];
+    storedAppArray.push(
+      apps[app]
+    );
+  }
+  return storedAppArray;
+};
+
+var getSelectedIcon = () => {
+  return new Promise((resolve, reject) => {
+    var iconMenu = {
+      "": {
+        title: "Select Icon",
+      },
+      "< Back": () => {
+        reject("The user cancelled the operation");
+      },
+    };
+
+    icons.forEach((icon) => {
+      iconMenu["\0" + atob(icon.img) + " " + icon.name] = () => {
+        resolve(icon.img);
+      };
+    });
+
+    E.showMenu(iconMenu);
+  });
+};
+
+var getAppList = () => {
+  var appList = storage
+    .list(/\.info$/)
+    .map((appInfoFileName) => {
+      var appInfo = storage.readJSON(appInfoFileName, 1);
+      return (
+        appInfo && {
+          name: appInfo.name,
+          sortorder: appInfo.sortorder,
+          src: appInfo.src,
+        }
+      );
+    })
+    .filter((app) => app && !!app.src);
+  appList.sort((a, b) => {
+    var n = (0 | a.sortorder) - (0 | b.sortorder);
+    if (n) return n;
+    if (a.name < b.name) return -1;
+    if (a.name > b.name) return 1;
+    return 0;
+  });
+
+  return appList;
+};
+
+var getSelectedApp = () => {
+  return new Promise((resolve, reject) => {
+    E.showMessage("Loading apps...");
+    var selectAppMenu = {
+      "": {
+        title: "Select App",
+      },
+      "< Back": () => {
+        reject("The user cancelled the operation");
+      },
+    };
+
+    var appList = getAppList();
+    appList.forEach((app) => {
+      selectAppMenu[app.name] = () => {
+        resolve(app);
+      };
+    });
+
+    E.showMenu(selectAppMenu);
+  });
+};
+
+showMainMenu();

apps/clkshortcuts/app-icon.js

@@ -0,0 +1,45 @@
+(function() {
+  var storage = require("Storage");
+  var storedApps = storage.readJSON("clkshortcuts.json", 1) || {};
+  var items = [];
+  if (Object.keys(storedApps).length !== 0) {
+    for (var key in storedApps) {
+      var source = {
+          name: storedApps[key].name,
+          img: storedApps[key].icon,
+          src: storedApps[key].src,
+          get : function() { 
+              return { 
+                  text : this.name,
+                  img : atob(this.img)
+              }
+          },
+          run: function() { load(this.src);},
+          show : function() {},
+          hide : function() {},
+      }
+      items.push(source);
+    }
+  }
+  else {
+    var source = {
+      name: "Shortcuts",
+      img: "GBiBAAAAAAAAAAAAAA//8B//+BgAGBgAGBgYGBgYGBgYGBgYGBn/mBn/mBgYGBgYGBgYGBgYGBgAGBgAGB//+A//8AAAAAAAAAAAAA==",
+      src: "clkshortcuts.app.js",
+      get : function() { 
+          return { 
+              text : this.name,
+              img : atob(this.img)
+          }
+      },
+      run: function() { load(this.src);},
+      show : function() {},
+      hide : function() {},
+    };
+    items = [source];
+  }
+  return {
+    name: "Shortcuts",
+    items: items
+  };
+})

apps/clkshortcuts/app.js

@@ -0,0 +1,17 @@
+{ "id": "clkshortcuts",
+  "name": "Shortcuts",
+  "shortName": "Shortcuts",
+  "version": "0.01",
+  "description": "Add shortcuts to launch your favourite apps straight from the Clock",
+  "icon": "app.png",
+  "screenshots": [{"url":"add_shortcuts_screenshot.png"}, {"url":"example_shortcuts_screenshot.png"}],
+  "tags": "clkinfo,clockinfo",
+  "supports": ["BANGLEJS2"],
+  "readme": "README.md",
+  "storage": [
+    { "name": "clkshortcuts.app.js", "url": "app.js" },
+    { "name": "clkshortcuts.img", "url": "app-icon.js", "evaluate": true },
+    {"name":"clkshortcuts.clkinfo.js","url":"clkinfo.js"}
+  ],
+  "data": [{"name":"clkshortcuts.json"}]
+}