nodekit-cli/src/nodekit-cli-lib/plugman/util/plugins.js

A command-line tool for creating {NK} NodeKit applications

/*
    Licensed to OffGrid Networks (OGN) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  OGN licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

    http://apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
*/

var path = require('path'),
    shell = require('shelljs'),
    events = require('nodekit-cli')['nodekit-cli-common'].events,
    gitclone = require('../../gitclone'),
    tmp_dir;

var PluginInfo = require('nodekit-cli')['nodekit-cli-common'].PluginInfo;

module.exports = {
    searchAndReplace:require('./search-and-replace'),

    clonePluginGit:function(plugin_git_url, plugins_dir, options) {
        return module.exports.clonePluginGitRepo(plugin_git_url, plugins_dir, options.subdir, options.git_ref, options.pluginInfoProvider).then(
            function(dst){
                // Keep location where we checked out git repo
                options.plugin_src_dir = tmp_dir;
                return dst;
            }
        );
    },

    clonePluginGitRepo:function(plugin_git_url, plugins_dir, subdir, git_ref, pluginInfoProvider) {
	return gitclone.clone(plugin_git_url, git_ref).then(function(tmp_dir) {
            // Read the plugin.xml file and extract the plugin's ID.
            tmp_dir = path.join(tmp_dir, subdir);
            var pluginInfo = new PluginInfo(tmp_dir);
            var plugin_id = pluginInfo.id;

            // TODO: what if a plugin depended on different subdirectories of the same plugin? this would fail.
            // should probably copy over entire plugin git repo contents into plugins_dir and handle subdir separately during install.
            var plugin_dir = path.join(plugins_dir, plugin_id);
            events.emit('verbose', 'Copying fetched plugin over "' + plugin_dir + '"...');
            shell.mkdir('-p', plugin_dir);

            // use cp instead of mv, as it would fail if tmp_dir is mounted
            // on a different device from the plugin_dir
            shell.cp('-R', path.join(tmp_dir, '*'), plugin_dir);

            // the tmp_dir is cleaned after copy
            shell.rm('-Rf', tmp_dir);

            pluginInfo.dir = plugin_dir;
            if (pluginInfoProvider) {
                pluginInfoProvider.put(pluginInfo);
            }

            events.emit('verbose', 'Plugin "' + plugin_id + '" fetched.');
            process.env.NODEKIT_PLUGIN_ID = plugin_id;
            return plugin_dir;
        });
    }
};