github: store_id and repo=

doc/notes.txt

@@ -143,6 +143,8 @@ TODO:
   - what if files already open in editor
   - import twice?
   - un-bind from repo?
+  - repo/platform dichotomy
+  - navigate to/from repo
 
 
 WEB WORKER FORMAT

index.html

@@ -67,8 +67,6 @@ if (window.location.host.endsWith('8bitworkshop.com')) {
       <li class="dropdown dropdown-submenu">
         <a tabindex="-1" href="#">Sync</a>
         <ul class="dropdown-menu">
-          <li><a class="dropdown-item" href="/login.html">Login to GitHub...</a></li>
-          <hr>
           <li><a class="dropdown-item" href="#" id="item_github_import">Import Project from GitHub...</a></li>
           <li><a class="dropdown-item" href="#" id="item_github_publish">Publish Project on GitHub...</a></li>
           <hr>

src/project.ts

@@ -339,13 +339,13 @@ export class CodeProject {
     return path;
   }
   
-  migrateToNewFolder(newprefix : string) {
+  migrateToNewFolder(newprefix : string, newstore?) {
     // TODO: must end with /
     var newPath = newprefix + this.stripLocalPath(this.mainPath);
     console.log(this.mainPath + "->" + newPath);
     var data = this.filedata[this.mainPath];
     console.log(data.length + " bytes");
-    return this.store.setItem(newPath, data).then(() => {
+    return (newstore || this.store).setItem(newPath, data).then(() => {
       //return this.store.removeItem(this.mainPath);
       console.log("moved " + this.mainPath + " to " + newPath);
       this.filedata[newPath] = this.filedata[this.mainPath]; //TODO?

src/services.ts

@@ -8,13 +8,14 @@ declare var exports;
 declare var firebase;
 
 export interface GHSession {
-  url : string;
+  url : string;		// github url
-  user : string;
+  user : string;	// user name
-  reponame : string;
+  reponame : string;	// repo name
-  repo : any;
+  repopath : string;	// "user/repo"
-  prefix : string;
+  prefix : string;	// file prefix, "local/" or ""
+  repo : any;		// [repo object]
+  mainPath?: string;	// main file path
   paths? : string[];
-  mainPath?: string;
 }
 
 const README_md_template = "$NAME\n=====\n\nCompatible with the [$PLATFORM](http://8bitworkshop.com/redir.html?platform=$PLATFORM&importURL=$GITHUBURL) platform in [8bitworkshop](http://8bitworkshop.com/). Main file is [$MAINFILE]($MAINFILE#mainfile).\n";
@@ -75,11 +76,7 @@ export class GithubService {
     if (toks.length < 5) return null;
     if (toks[0] != 'https:') return null;
     if (toks[2] != 'github.com') return null;
-    return {user:toks[3], repo:toks[4]};
+    return {user:toks[3], repo:toks[4], repopath:toks[3]+'/'+toks[4]};
-  }
-  
-  getPrefix(user, reponame) : string {
-    return 'shared/' + user + '/' + reponame + '/';
   }
   
   getGithubSession(ghurl:string) : Promise<GHSession> {
@@ -92,28 +89,26 @@ export class GithubService {
         url: ghurl,
         user: urlparse.user,
         reponame: urlparse.repo,
-        prefix: this.getPrefix(urlparse.user, urlparse.repo),
+        repopath: urlparse.repopath,
+        prefix: '', //this.getPrefix(urlparse.user, urlparse.repo),
         repo: this.github.repos(urlparse.user, urlparse.repo)
       };
       yes(sess);
     });
   }
   
-  // bind a folder path to the Github URL in local storage  
+  getRepos() {
-  bind(sess : GHSession, dobind : boolean) {
+    return JSON.parse(localStorage.getItem('__repos') || '{}');
-    var key = '__github_url_' + sess.prefix;
-    console.log('bind', key, dobind);
-    if (dobind)
-      localStorage.setItem(key, sess.url);
-    else
-      localStorage.removeItem(key);
   }
   
-  getBoundURL(path : string) : string {
+  bind(sess:GHSession, dobind:boolean) {
-    var p = getFolderForPath(path);
+    var repos = this.getRepos();
-    var key = '__github_url_' + p + '/';
+    if (dobind) {
-    console.log("getBoundURL", key);
+      repos[sess.repopath] = sess.url;
-    return localStorage.getItem(key) as string; // TODO
+    } else {
+      delete repos[sess.repopath];
+    }
+    localStorage.setItem('__repos', JSON.stringify(repos));
   }
   
   import(ghurl:string) : Promise<GHSession> {
@@ -147,7 +142,7 @@ export class GithubService {
     });
   }
   
-  pull(ghurl:string) : Promise<GHSession> {
+  pull(ghurl:string, deststore?) : Promise<GHSession> {
     var sess : GHSession;
     return this.getGithubSession(ghurl).then( (session) => {
       sess = session;
@@ -168,7 +163,7 @@ export class GithubService {
             var size = item.size;
             var isBinary = isProbablyBinary(blob);
             var data = isBinary ? stringToByteArray(blob) : blob; //byteArrayToUTF8(blob);
-            return this.store.setItem(path, data);
+            return (deststore || this.store).setItem(path, data);
           });
           blobreads.push(read);
         } else {

src/store.ts

@@ -31,14 +31,14 @@ var Ver2xFileStore = function(storage, prefix:string) {
 }
 
 // copy localStorage to new driver
-function copyFromVer2xStorageFormat(platformid:string, newstore, callback:(store)=>void) {
+function copyFromVer2xStorageFormat(storeid:string, newstore, callback:(store)=>void) {
-  var alreadyMigratedKey = "__migrated_" + platformid;
+  var alreadyMigratedKey = "__migrated_" + storeid;
   //localStorage.removeItem(alreadyMigratedKey);
   if (localStorage.getItem(alreadyMigratedKey)) {
     callback(newstore);
     return;
   }
-  var oldstore = new Ver2xFileStore(localStorage, platformid + '/');
+  var oldstore = new Ver2xFileStore(localStorage, storeid + '/');
   var keys = oldstore.getFiles('');
   // no files to convert?
   if (keys.length == 0) {
@@ -73,11 +73,11 @@ function copyFromVer2xStorageFormat(platformid:string, newstore, callback:(store
   migrateNext(); // start the conversion
 }
 
-export function createNewPersistentStore(platformid:string, callback:(store)=>void) {
+export function createNewPersistentStore(storeid:string, callback:(store)=>void) {
   var store = localforage.createInstance({
-    name: "__" + platformid,
+    name: "__" + storeid,
     version: 2.0
   });
-  copyFromVer2xStorageFormat(platformid, store, callback);
+  copyFromVer2xStorageFormat(storeid, store, callback);
   return store;
 }

src/ui.ts

@@ -12,7 +12,7 @@ import { PLATFORMS, EmuHalt, Toolbar } from "./emu";
 import * as Views from "./views";
 import { createNewPersistentStore } from "./store";
 import { getFilenameForPath, getFilenamePrefix, highlightDifferences, invertMap, byteArrayToString, compressLZG,
-         byteArrayToUTF8, isProbablyBinary, getWithBinary } from "./util";
+         byteArrayToUTF8, isProbablyBinary, getWithBinary, getBasePlatform } from "./util";
 import { StateRecorderImpl } from "./recorder";
 import { GHSession, GithubService } from "./services";
 
@@ -26,8 +26,10 @@ if (window['Javatari']) window['Javatari'].AUTO_START = false;
 
 var PRESETS : Preset[];			// presets array
 
-export var platform_id : string;	// platform ID string
+export var platform_id : string;	// platform ID string (platform)
-export var platform : Platform;	// platform object
+export var store_id : string;		// store ID string (repo || platform)
+export var repo_id : string;		// repository ID (repo)
+export var platform : Platform;		// emulator object
 
 var toolbar = $("#controls_top");
 
@@ -258,16 +260,17 @@ function loadProject(preset_id:string) {
   });
 }
 
-function reloadPresetNamed(id:string) {
+function reloadProject(id:string, repo?:string) {
   qs['platform'] = platform_id;
   qs['file'] = id;
+  if (repo) qs['repo'] = repo;
   gotoNewLocation();
 }
 
 function getSkeletonFile(fileid:string, callback) {
   var ext = platform.getToolForFilename(fileid);
   // TODO: .mame
-  $.get( "presets/"+platform_id+"/skeleton."+ext, function( text ) {
+  $.get( "presets/"+getBasePlatform(platform_id)+"/skeleton."+ext, function( text ) {
     callback(null, text);
   }, 'text')
   .fail(() => {
@@ -299,7 +302,7 @@ function _createNewFile(e) {
           if (err)
             alert(err+"");
           if (result != null)
-            reloadPresetNamed("local/" + filename);
+            reloadProject("local/" + filename);
         });
       }
     });
@@ -392,11 +395,43 @@ function getGithubService() {
 }
 
 function getBoundGithubURL() : string {
-  console.log("main path: " + current_project.mainPath);
+  var toks = (repo_id||'').split('/');
-  var ghurl = getGithubService().getBoundURL(current_project.mainPath);
+  if (toks.length != 2) {
-  console.log("Github URL: " + ghurl);
+    alert("This project is not bound to a GitHub project.");
-  if (!ghurl) alert("This project (" + current_project.mainPath + ") is not bound to a GitHub project.")
+    return null;
-  return ghurl;
+  }
+  return 'https://github.com/' + toks[0] + '/' + toks[1];
+}
+
+function importProjectFromGithub(githuburl:string, modal?) {
+  var sess : GHSession;
+  // create new repository store
+  var urlparse = getGithubService().parseGithubURL(githuburl);
+  if (!urlparse) {
+    alert('Could not parse Github URL.');
+    if (modal) modal.modal('hide');
+    return;
+  }
+  var newstore = createNewPersistentStore(urlparse.repopath, () => {
+    // import into new store
+    return getGithubService().import(githuburl).then( (sess1:GHSession) => {
+      sess = sess1;
+      return getGithubService().pull(githuburl, newstore);
+    }).then( (sess2:GHSession) => {
+      if (modal) modal.modal('hide');
+      // TODO: only first sessino has mainPath
+      if (sess.mainPath) {
+        reloadProject(sess.mainPath, sess.repopath);
+      } else {
+        updateSelector();
+        alert("Files imported, but no main file was found so you'll have to select this project in the pulldown.");
+      }
+    }).catch( (e) => {
+      if (modal) modal.modal('hide');
+      console.log(e);
+      alert("Could not import " + githuburl + ": " + e);
+    });
+  });
 }
 
 function _importProjectFromGithub(e) {
@@ -405,31 +440,12 @@ function _importProjectFromGithub(e) {
   modal.modal('show');
   btn.off('click').on('click', () => {
     var githuburl = $("#importGithubURL").val()+"";
-    var sess;
+    importProjectFromGithub(githuburl, modal);
-    getGithubService().import(githuburl).then( (sess1:GHSession) => {
-      sess = sess1;
-      return getGithubService().pull(githuburl);
-    }).then( (sess2:GHSession) => {
-      // TODO: only first sessino has mainPath
-      if (sess.mainPath) {
-        reloadPresetNamed(sess.prefix + sess.mainPath);
-      } else {
-        updateSelector();
-        alert("Files imported, but no main file was found so you'll have to select this project in the pulldown.");
-      }
-      // TODO : redirect to main file
-      modal.modal('hide');
-    }).catch( (e) => {
-      modal.modal('hide');
-      console.log(e);
-      alert("Could not import " + githuburl + ": " + e);
-    });
   });
 }
 
 function _publishProjectToGithub(e) {
-  var ghurl = getGithubService().getBoundURL(current_project.mainPath);
+  if (repo_id) {
-  if (ghurl) {
     alert("This project (" + current_project.mainPath + ") is already bound to a Github repository. Choose 'Push Changes' to update.");
     return;
   }
@@ -446,14 +462,11 @@ function _publishProjectToGithub(e) {
     setWaitDialog(true);
     getGithubService().login().then( () => {
       return getGithubService().publish(name, desc, license, priv);
-    }).then( (_sess) => {
+    }).then( (sess) => {
-      sess = _sess;
+      repo_id = qs['repo'] = sess.repopath;
-      console.log(sess);
-      return current_project.migrateToNewFolder(sess.prefix);
-    }).then( () => {
       return pushChangesToGithub('initial import from 8bitworkshop.com');
     }).then( () => {
-      reloadPresetNamed(current_project.mainPath);
+      reloadProject(current_project.mainPath);
     }).catch( (e) => {
       setWaitDialog(false);
       console.log(e);
@@ -511,28 +524,6 @@ function pushChangesToGithub(message:string) {
   });
 }
 
-// TODO: remove?
-function loadSharedGist(gistkey : string) {
-  var github = new exports['Octokat']();
-  var gist = this.github.gists(gistkey);
-  gist.fetch().done( (val) => {
-    var filename;
-    var newid;
-    console.log("Fetched " + gistkey, val);
-    store = createNewPersistentStore(platform_id, (store) => {
-      for (filename in val.files) {
-        store.setItem('shared/'+filename, val.files[filename].content);
-        if (!newid) newid = 'shared/'+filename;
-      }
-      // TODO: wait for set?
-      delete qs['gistkey'];
-      reloadPresetNamed(newid);
-    });
-  }).fail(function(err) {
-    alert("Error loading share file: " + err.message);
-  });
-}
-
 function _shareEmbedLink(e) {
   if (current_output == null) { // TODO
     alert("Please fix errors before sharing.");
@@ -619,7 +610,7 @@ function _downloadCassetteFile(e) {
 
 function fixFilename(fn : string) : string {
   if (platform_id.startsWith('vcs') && fn.indexOf('.') <= 0)
-    fn += ".a"; // legacy stuff
+    fn += ".a"; // TODO: legacy stuff
   return fn;
 }
 
@@ -628,7 +619,7 @@ function _revertFile(e) {
   if (wnd && wnd.setText) {
     var fn = fixFilename(projectWindows.getActiveID());
     // TODO: .mame
-    $.get( "presets/"+getFilenamePrefix(platform_id)+"/"+fn, function(text) {
+    $.get( "presets/"+getBasePlatform(platform_id)+"/"+fn, function(text) {
       if (confirm("Reset '" + fn + "' to default?")) {
         wnd.setText(text);
       }
@@ -680,7 +671,7 @@ function _renameFile(e) {
           alert("Renamed " + fn + " to " + newfn);
           updateSelector();
           if (fn == current_project.mainPath) {
-            reloadPresetNamed(newfn);
+            reloadProject(newfn);
           }
         });
       });
@@ -788,15 +779,23 @@ function populateFiles(sel:JQuery, category:string, prefix:string, callback:() =
 
 function updateSelector() {
   var sel = $("#preset_select").empty();
+  if (!repo_id) {
+    // normal: populate local and shared files
     populateFiles(sel, "Local Files", "local/", () => {
       populateFiles(sel, "Shared", "shared/", () => {
         populateExamples(sel);
         sel.css('visibility','visible');
       });
     });
+  } else {
+    // repo: populate all files
+    populateFiles(sel, "Repository Files", "", () => {
+      sel.css('visibility','visible');
+    });
+  }
   // set click handlers
   sel.off('change').change(function(e) {
-    reloadPresetNamed($(this).val().toString());
+    reloadProject($(this).val().toString());
   });
 }
 
@@ -1302,7 +1301,7 @@ function setupDebugControls() {
   $("#item_download_zip").click(_downloadProjectZipFile);
   $("#item_download_allzip").click(_downloadAllFilesZipFile);
   $("#item_record_video").click(_recordVideo);
-  if (platform_id == 'apple2')
+  if (platform_id.startsWith('apple2'))
     $("#item_export_cassette").click(_downloadCassetteFile);
   else
     $("#item_export_cassette").hide();
@@ -1386,7 +1385,7 @@ function isLandscape() {
 function showWelcomeMessage() {
   if (hasLocalStorage && !localStorage.getItem("8bitworkshop.hello")) {
     // Instance the tour
-    var is_vcs = platform_id == 'vcs';
+    var is_vcs = platform_id.startsWith('vcs');
     var steps = [
         {
           element: "#workspace",
@@ -1557,7 +1556,7 @@ export function loadScript(scriptfn, onload, onerror?) {
 export function setupSplits() {
   const splitName = 'workspace-split3-' + platform_id;
   var sizes = [0, 50, 50];
-  if (platform_id != 'vcs') // TODO
+  if (platform_id.startsWith('vcs')) // TODO
     sizes = [12, 44, 44];
   var sizesStr = hasLocalStorage && localStorage.getItem(splitName);
   if (sizesStr) {
@@ -1619,16 +1618,12 @@ export function startUI(loadplatform : boolean) {
   }
   $("#item_platform_"+platform_id).addClass("dropdown-item-checked");
   setupSplits();
-  // parse query string
+  // create store
-  // is this a share URL? can't create store until we know platform_id...
+  repo_id = qs['repo'];
-  if (qs['gistkey']) {
+  store_id = repo_id || getBasePlatform(platform_id);
-    loadSharedGist(qs['gistkey']);
+  store = createNewPersistentStore(store_id, (store) => {
-  }
-  // otherwise, open IDE
-  else {
-    // create store for platform
-    store = createNewPersistentStore(platform_id, (store) => {
     // is this an importURL?
+    // TODO: use repo
     if (qs['githubURL']) {
       getGithubService().import(qs['githubURL']);
       return;
@@ -1646,7 +1641,6 @@ export function startUI(loadplatform : boolean) {
     }
   });
 }
-}
 
 function loadAndStartPlatform() {
   var scriptfn = 'gen/platform/' + platform_id.split(/[.-]/)[0] + '.js';
@@ -1654,7 +1648,7 @@ function loadAndStartPlatform() {
     console.log("loaded platform", platform_id);
     startPlatform();
     showWelcomeMessage();
-    document.title = document.title + " [" + platform_id + "] - " + current_project.mainPath;
+    document.title = document.title + " [" + platform_id + "] - " + (('['+repo_id+'] - ')||'') + current_project.mainPath;
   }, () => {
     alert('Platform "' + platform_id + '" not supported.');
   });

src/util.ts

@@ -468,3 +468,18 @@ export function getWithBinary(url:string, success:(text:string|Uint8Array)=>void
   oReq.send(null);
 }
 
+// get platform ID without . emulator
+export function getBasePlatform(platform : string) : string {
+  return platform.split('.')[0];
+}
+
+// get platform ID without - specialization
+export function getRootPlatform(platform : string) : string {
+  return platform.split('-')[0];
+}
+
+// get platform ID without emulator or specialization
+export function getRootBasePlatform(platform : string) : string {
+  return getRootPlatform(getBasePlatform(platform));
+}
+

test/cli/testgithub.js

@@ -19,7 +19,7 @@ function newGH(store, platform_id) {
   var project = new prj.CodeProject({}, platform_id||test_platform_id, null, store);
   project.mainPath = 'local/main.asm';
   project.updateFileInStore(project.mainPath, '\torg $0 ; test\n');
-  return new serv.GithubService(Octokat, 'ec64fdd81dedab8b7547388eabef09288e9243a9', store, project);
+  return new serv.GithubService(Octokat, process.env.TEST8BIT_GITHUB_TOKEN, store, project);
 }
 
 const t0 = new Date().getTime();
@@ -95,11 +95,11 @@ describe('Store', function() {
   it('Should bind paths to Github', function(done) {
     var store = mstore.createNewPersistentStore(test_platform_id, function(store) {
       var gh = newGH(store);
-      var sess = {prefix:'shared/foo/bar/', url:'_'};
+      var sess = {repopath:'foo/bar', url:'_'};
       gh.bind(sess, true);
-      assert.equal(gh.getBoundURL('shared/foo/bar/'), '_');
+      assert.deepEqual(gh.getRepos(), {'foo/bar':'_'});
       gh.bind(sess, false);
-      assert.equal(gh.getBoundURL('shared/foo/bar/'), null);
+      assert.deepEqual(gh.getRepos(), {});
       done();
     });
   });