cmd-queue
v0.1.0
Published
コマンドラインタスクの直列処理とウェブアプリUIへの表示など。
Downloads
3
Readme
cmd-queue
コマンドラインタスクの直列処理とウェブアプリUIへの表示など。
インストール - Install
npm install --save cmd-queue使い方 - Usage
サーバー側 - Server side JavaScript (NodeJS)
var express = require('express'),
app = express();
var server = require('http').Server(app);
var io = require('socket.io')(server);
var CmdQueue = require('cmd-queue');
var cmdQueue = new CmdQueue({
'cd': {
// コマンドを実行するときのカレントディレクトリの一覧
// クライアント側から直接パスを指定できないよう、パスと名前の対として管理します。
'default': process.cwd(),
'tests': process.cwd()+'/tests'
},
'allowedCommands': [
// 実行を許可するコマンド (前方一致で評価)
'ls',
'pwd',
['git', 'status'],
['git', 'log'],
['npm', 'update']
],
'preprocess': function(cmd, callback){
// 実行前の加工などの処理があれば記述
// console.log(cmd);
callback(cmd);
return;
},
'gpiBridge': function(message, done){
// サーバーからクライアントへのメッセージ送信を仲介
io.emit('cmd-queue-message', message);
done();
return;
}
});
app.use( '/path/to/cmd-queue/', express.static( '/path/to/node_modules/cmd-queue/' ) );
app.use( '/apis/cmdQueue', function(req, res, next){
res
.status(200)
.set('Content-Type', 'text/plain')
;
// クライアントから受け取ったメッセージをGPIへ送る
cmdQueue.gpi(req.query.message, function(result){
res.write( JSON.stringify(result) );
res.flushHeaders();
res.end();
});
return;
} );
// 3000番ポートでLISTEN状態にする
server.listen( 3000, function(){
console.log('server-standby');
} );クライアント側 - Client side JavaScript
<!DOCTYPE html>
<html>
<head>
<title>CmdQueue DEMO</title>
<!-- cmd-queue.css -->
<link rel="stylesheet" href="/path/to/cmd-queue/dist/cmd-queue.css" />
</head>
<body>
<div id="finder1"></div>
<!-- Socket.io (required) -->
<script src="/socket.io/socket.io.js"></script>
<!-- cmd-queue.js -->
<script src="/path/to/cmd-queue/dist/cmd-queue.js"></script>
<script>
var socket = io();
var cmdQueue = new CmdQueue(
{
'gpiBridge': function(message, done){
// クライアントからサーバーへのメッセージ送信を仲介
var data = '';
$.ajax({
'url': '/apis/cmdQueue',
'data': {
'message': message
},
'success': function(result){
data += result;
},
'complete': function(){
var result = JSON.parse(data);
done(result);
}
});
}
}
);
socket.on('cmd-queue-message', function(message){
cmdQueue.gpi(message);
});
// 端末を生成する
var terminal = cmdQueue.createTerminal( document.getElementById('finder1') );
// 新しいキューを追加する
cmdQueue.addQueueItem(['pwd']);
</script>
</body>
</html>cmdQueue コンストラクタオプション
gpiBridge
クライアントからサーバーへのメッセージ送信を仲介するコールバック関数を指定します。上記の実装例は、 jQuery を使用してAJAXリクエストを送信するサンプルです。
端末生成時オプション
// 端末を生成する
var terminal = cmdQueue.createTerminal(
document.getElementById('finder1'), // 端末を表示するためのDOM要素
{ // Options
'queueId': queueId, // Queue ID でフィルタリングする
'tags': ['tag1', 'tag2'] // タグでフィルタリングする
}
);新規キュー追加時オプション
// 新しいキューを追加する
cmdQueue.addQueueItem(
['ls', '-la'], // コマンド(CLIオプションはスペース区切りで配列要素に追加する)
{
'cdName': 'tests', // コマンド実行時のカレントディレクトリ。サーバーサイドのオプション `cd` と突き合わせられる。
'tags': ['tag2', 'tag2'], // 端末が表示をフィルタリングするために用いるタグ。
'accept': function(queueId){
// キュー発行の完了イベントハンドラ
// 注意: キューに追加した時点で呼ばれます。コマンドの実行完了イベントではありません。
// 発行したキューのID文字列が返されます。
console.log(queueId);
}
}
);更新履歴 - Change log
[email protected] (2017-10-16)
- Initial Release.
ライセンス - License
MIT License
作者 - Author
- Tomoya Koyanagi [email protected]
- website: http://www.pxt.jp/
- Twitter: @tomk79 http://twitter.com/tomk79/