Adafruit-WebIDE/helpers/git_helper.js

var git = require('gitty'),
    url = require('url'),
    path = require('path'),
    fs_helper = require('./fs_helper'),
    redis = require("redis"),
    client = redis.createClient(),
    request_helper = require('./request_helper'),
    config = require('../config/config');

var REPOSITORY_PATH = path.resolve(__dirname + "/../repositories") + "/";
var push_queue = [], pushInterval, PUSH_TIMER = 30000;

/*
 * Creates a simple queue that is used for pushing git changes to the remote repositories.
 * The queue is currently set using the PUSH_TIMER to delay the remote pushes.
 */
function push_queue_interval() {
  console.log('git push queue init');
  function push(repository_path, remote, branch) {
    git.push(repository_path, remote, branch, function(obj) {
      console.log(obj);
    });
  }

  pushInterval = setInterval(function() {
    if (config.editor.offline) {
      return;
    }
    
    while(push_queue.length > 0) {
      console.log('pushing code to remote repository');
      var element = push_queue.shift();
      push(element.repository_path, element.remote, element.branch);
    }
  }, PUSH_TIMER);
}
push_queue_interval();

/*
 * Clone the adafruit libraries defined in config/config.js.
 * We start the editor off with the Adafruit libraries that may be useful to beginners.
 */
exports.clone_adafruit_libraries = function(adafruit_repository, remote, cb) {
  fs_helper.check_for_repository(adafruit_repository, function(err, status) {
    if (!err && !status) {
      git.clone(REPOSITORY_PATH, remote, function(output) {
        console.log(output);
        cb(true);
      });
    } else {
      cb(false);
    }
  });
};

/*
 * This does a few things in order to clone a repository, and save it to your Bitbucket profile.
 * This allows you to clone from any remote repository, including Github (it's overly complicated...).
 * 1. It first checks if the repository already exists in your bitbucket profile.
 * 2. If not 1, it creates the repository in Bitbucket using the API.
 * 3. It then clones the remote repository you're interested in.
 * 4. It then updates the git remote for that repository to your bitbucket repository.
 * 5. Finally, it pushes the cloned repository to your remote account.
 */
exports.clone_update_remote_push = function(profile, repository_url, cb) {
  var self = this;
  //console.log(profile);
  var repository_name = path.basename(repository_url, '.git');
  console.log(repository_name);
  console.log(repository_url);

  request_helper.list_repositories(profile, function(err, list) {
    var exists = list.some(function(repository) {
      return (repository.name === repository_name);
    });
    if (!exists) {
      //TODO need better error handling eventually
      request_helper.create_repository(profile, repository_name, function(err, response) {
        console.log("created repository in bitbucket: " + repository_name);
        self.clone_repository(repository_url, function(err, results) {
          console.log("clone repository locally: " + repository_name);
          self.update_remote(profile, repository_name, function(err, response) {
            console.log("updated remote for repository: " + repository_name);
            self.push(repository_name, "origin", "master", function(err, response) {
              console.log("git push for repository: " + repository_name);
              cb(null, true);
            });
          });
        });
      });
    } else {
      if (repository_url.toLowerCase().indexOf("bitbucket.org") === -1) {
        cb("Repository Already Exists in Bitbucket, clone with Bitbucket URL.", false);
      } else {
        self.clone_repository(repository_url, function(err, results) {
          console.log("clone repository locally: " + repository_name);
          cb(null, true);
        });
      }
    }
  });
};

exports.clone_repository = function(repository_path, cb) {
  console.log(repository_path);
  var repository_url = url.parse(repository_path);

  console.log("cloning", repository_path);
  git.clone(REPOSITORY_PATH, repository_url.href, function(output) {
    cb(output.error, output.message);
  });
};

exports.validate_config = function validate_config(cb) {
  git.config("user.email", null, function(err, email) {
    git.config("user.name", null, function(err, name) {
      if (err) console.log("validate_config err", err);

      if (name && email) {
        cb(true);
      } else {
        cb(false);
      }
    });
  });
};

exports.set_config = function(cb) {
  var self = this;
  self.validate_config(function(is_valid) {
    if (is_valid) {
      console.log('git config is valid');
      cb();
    } else {
      console.log('git config is invalid');
      client.hgetall('user', function (err, user) {
        console.log("set_config user", user);
        git.config("user.email", user.email, function(err, email) {
          git.config("user.name", user.name, function(err, name) {
            console.log("git config set", email, name);
            cb();
          });
        });
      });
    }
  });

};

/*
 * Updates the remote repository to the users bitbucket repository.
 */
exports.update_remote = function(profile, repository, cb) {
  var remote_url = "ssh://git@bitbucket.org/" + profile.username + "/" + repository.toLowerCase() + ".git";
  git.remote.update(REPOSITORY_PATH + repository, "origin", remote_url, function(output) {
    //console.log(output);
    cb(output.error, output.message);
  });
};

/*
 * Adds an additional remote to a repository.
 */
exports.add_remote = function(repository, remote_name, remote_url, cb) {
  git.remote.add(REPOSITORY_PATH + repository, remote_name, remote_url, function(output) {
    //console.log(output);
    cb(output.error, output.message);
  });
};

/*
 * git add a single file, or an array of files.
 * repository: the name of the repository that resides in the repositories folder.
 * files: the relative path of the files from the root of the repository.
 */
exports.add = function add(repository, files, cb) {
  if (!Array.isArray(files)) {
    files = [files];
  }
  var repository_path = REPOSITORY_PATH + repository;
  git.add(repository_path, files, function(output) {
    //console.log(output);
    cb(output.errors, output.added);
  });
};

/*
 * git remove a single file, or an array of files.
 * repository: the name of the repository that resides in the repositories folder.
 * files: the relative path of the files from the root of the repository.
 */
exports.remove = function remove(repository, files, cb) {
  if (!Array.isArray(files)) {
    files = [files];
  }
  var repository_path = REPOSITORY_PATH + repository;
  git.remove(repository_path, files, function(output) {
    console.log(output);
    cb(output.errors, output.added);
  });
};

/*
 * git remove an entire directory, and it's contents.
 * repository: the name of the repository that resides in the repositories folder.
 * path: the relative path of the directory from the root of the repository.
 */
exports.remove_recursive = function remove_recursive(repository, path, cb) {
  var repository_path = REPOSITORY_PATH + repository;

  git.remove_recursive(repository_path, path, function(output) {
    console.log(output);
    cb(output.errors, output.added);
  });
};

/*
 * git move a single file or folder.
 * repository: the name of the repository that resides in the repositories folder.
 */
exports.move = function move(repository, source, destination, cb) {
  var repository_path = REPOSITORY_PATH + repository;
  git.move(repository_path, source, destination, function(obj) {
    //console.log(obj);
    cb(obj.error, obj.message);
  });
};

/*
 * git commit the changes.
 * repository: the name of the repository that resides in the repositories folder.
 * message: The text to go along with the commit.
 */
exports.commit = function commit(repository, message, cb) {
  var repository_path = REPOSITORY_PATH + repository;
  console.log(repository_path);
  git.commit(repository_path, message, function(obj) {
    //console.log(obj);
    cb(obj.error, obj.message);
  });
};

/*
 * git push the committed changes.  Adds it to the push queue.
 * repository: the name of the repository that resides in the repositories folder.
 */
exports.push = function push(repository, remote, branch, cb) {
  var repository_path = REPOSITORY_PATH + repository;
  var key = repository + remote + branch;
  console.log('called push ' + key);

  //if the repository, remote and branch are already on the queue, just skip it...otherwise add it to the end
  if (push_queue.length > 0) {
    for (var i=0; i<push_queue.length; i++) {
      if (push_queue[i].key === key) {
        break;
      } else {
        console.log('added to queue ' + key);
        push_queue.push({
          key: key,
          repository_path: repository_path,
          repository: repository,
          remote: remote,
          branch: branch
        });
      }
    }
  } else {
    push_queue.push({
      key: key,
      repository_path: repository_path,
      repository: repository,
      remote: remote,
      branch: branch
    });    
  }
  cb();
};

/*
 * git pull remote changes to the repository.
 * repository: the name of the repository that resides in the repositories folder.
 */
exports.pull = function pull(repository, remote, branch, cb) {
  var repository_path = REPOSITORY_PATH + repository;
  git.pull(repository_path, remote, branch, function(obj) {
    //console.log(obj);
    cb(obj.error, obj.message);
  });
};

/*
 * Simply removes a file or directory, commits it, and pushes it out.
 */
exports.remove_commit_push = function(item, cb) {
  var self = this;
  console.log(item);
  var path_array = item.path.split('/');
  var repository = path_array[2];
  var item_path = path_array.slice(3).join('/');
  console.log(item_path);
  console.log(repository);


  if (item.type === 'directory') {
    self.remove_recursive(repository, item_path, function(err, status) {
      var commit_message = "Removed " + item.name;
      self.commit(repository, commit_message,  function(err, status) {
        self.push(repository, "origin", "master", function(err, status) {
          cb(err, status);
        });
      });
    });
  } else {
    self.remove(repository, item_path, function(err, status) {
      var commit_message = "Removed " + item.name;
      self.commit(repository, commit_message,  function(err, status) {
        self.push(repository, "origin", "master", function(err, status) {
          cb(err, status);
        });
      });
    });
  }
};

/*
 * Simply moves a file or directory, commits it, and pushes it out.
 */
exports.move_commit_push = function(item, cb) {
  var self = this;
  var path_array = item.path.split('/');
  var repository = path_array[2];
  var item_path = path_array.slice(3).join('/');
  var destination_path = item.destination.split('/').slice(3).join('/');

  self.move(repository, item_path, destination_path, function(err, status) {
    var commit_message = "Moved " + item.name;
    console.log(commit_message);
    self.commit(repository, commit_message,  function(err, status) {
      console.log("Committed Moved File");
      self.push(repository, "origin", "master", function(err, status) {
        console.log("Pushed latest changes");
        cb(err, status);
      });
    });
  });
};

/*
 * Simply commits a file or directory, commits it, and pushes it out.
 */
exports.commit_push_and_save = function(file, cb) {
  var self = this,
      path_array, repository, file_path;
  if (!file.repository) {
    path_array = file.path.split('/');
    repository = path_array[2];
    file_path = path_array.slice(3).join('/');
  } else {
    repository = file.repository;
    file_path = file.path;
  }

  self.add(repository, file_path, function(err, status) {
    console.log("added", err, status);
    var commit_message = "Modified " + file.name;
    self.commit(repository, commit_message,  function(err, status) {
      console.log("committed", err, status);
      self.push(repository, "origin", "master", function(err, status) {
        console.log("pushed");
        cb(status);
      });
    });
  });
};