3 // Copyright (c) 2009 Kyle Banker
4 // Licensed under the MIT Licence.
5 // http://www.opensource.org/licenses/mit-license.php
7 // Readline class to handle line input.
8 var ReadLine = function(options) {
9 this.options = options || {};
10 this.htmlForInput = this.options.htmlForInput;
11 this.inputHandler = this.options.handler || this.mockHandler;
12 this.scoper = this.options.scoper;
13 this.terminal = $(this.options.terminalId || "#terminal");
14 this.lineClass = this.options.lineClass || '.readLine';
21 ReadLine.prototype = {
23 initialize: function() {
27 // Enter a new input line with proper behavior.
28 addInputLine: function(stackLevel) {
29 stackLevel = stackLevel || 0;
30 this.terminal.append(this.htmlForInput(stackLevel));
32 ctx.activeLine = $(this.lineClass + '.active');
34 // Bind key events for entering and navigting history.
35 ctx.activeLine.bind("keydown", function(ev) {
38 ctx.processInput(this.value);
41 ctx.getCommand('previous');
43 case DownArrowKeyCode:
44 ctx.getCommand('next');
49 this.activeLine.focus();
52 // Returns the 'next' or 'previous' command in this history.
53 getCommand: function(direction) {
54 if(this.history.length === 0) {
57 this.adjustHistoryPointer(direction);
58 this.activeLine[0].value = this.history[this.historyPtr];
59 $(this.activeLine[0]).focus();
60 //this.activeLine[0].value = this.activeLine[0].value;
63 // Moves the history pointer to the 'next' or 'previous' position.
64 adjustHistoryPointer: function(direction) {
65 if(direction == 'previous') {
66 if(this.historyPtr - 1 >= 0) {
71 if(this.historyPtr + 1 < this.history.length) {
77 // Return the handler's response.
78 processInput: function(value) {
79 var response = this.inputHandler.apply(this.scoper, [value]);
80 this.insertResponse(response.result);
82 // Save to the command history...
83 if((lineValue = value.trim()) !== "") {
84 this.history.push(lineValue);
85 this.historyPtr = this.history.length;
88 // deactivate the line...
89 this.activeLine.value = "";
90 this.activeLine.attr({disabled: true});
91 this.activeLine.removeClass('active');
93 // and add add a new command line.
94 this.addInputLine(response.stack);
97 insertResponse: function(response) {
98 if((response.length < 1) || (response=='"donotprintme"')) {
99 this.activeLine.parent().append("<p class='response'></p>");
102 this.activeLine.parent().append("<p class='response'>" + response + "</p>");
106 // Simply return the entered string if the user hasn't specified a smarter handler.
107 mockHandler: function(inputString) {
109 this._process = function() { return inputString; };
114 var MongoHandler = function() {
115 this._currentCommand = "";
116 this._rawCommand = "";
117 this._commandStack = 0;
118 this._tutorialPtr = 0;
119 this._tutorialMax = 4;
122 this._mongo.test = [];
123 this.collections = [];
126 MongoHandler.prototype = {
128 _process: function(inputString, errorCheck) {
129 this._rawCommand += ' ' + inputString;
132 inputString += ' '; // fixes certain bugs with the tokenizer.
133 var tokens = inputString.tokens();
134 var mongoFunc = this._getCommand(tokens);
135 if(this._commandStack === 0 && inputString.match(/^\s*$/)) {
136 return {stack: 0, result: ''};
138 else if(this._commandStack === 0 && mongoFunc) {
139 this._resetCurrentCommand();
140 return {stack: 0, result: mongoFunc.apply(this, [tokens])};
143 return this._evaluator(tokens);
148 this._resetCurrentCommand();
150 return {stack: 0, result: "JS Error: " + err};
154 // Calls eval on the input string when ready.
155 _evaluator: function(tokens) {
156 isAssignment = tokens.length>=2 && tokens[0].type=="name" && tokens[1].type=="operator" && tokens[1].value=="=";
158 this._currentCommand += " " + this._massageTokens(tokens);
159 if(this._shouldEvaluateCommand(tokens)) {
160 opencloud = new OpenCloud();
163 // So this eval statement is the heart of the REPL.
164 var result = eval(this._currentCommand.trim());
165 if(result === undefined) {
166 throw('result is undefined');
168 result = $htmlFormat(result);
170 this._resetCurrentCommand();
172 return {stack: this._commandStack, result: ""};
174 return {stack: this._commandStack, result: result};
179 return {stack: this._commandStack, result: ""};
183 _resetCurrentCommand: function() {
184 this._currentCommand = '';
185 this._rawCommand = '';
188 // Evaluate only when we've exited any blocks.
189 _shouldEvaluateCommand: function(tokens) {
190 for(var i=0; i < tokens.length; i++) {
191 var token = tokens[i];
192 if(token.type == 'operator') {
193 if(token.value == '(' || token.value == '{') {
194 this._commandStack += 1;
196 else if(token.value == ')' || token.value == '}') {
197 this._commandStack -= 1;
202 if(this._commandStack === 0) {
210 _massageTokens: function(tokens) {
211 for(var i=0; i < tokens.length; i++) {
212 if(tokens[i].type == 'name') {
213 if(tokens[i].value == 'var') {
214 tokens[i].value = '';
218 return this._collectTokens(tokens);
221 // Collects tokens into a string, placing spaces between variables.
222 // This methods is called after we scope the vars.
223 _collectTokens: function(tokens) {
225 for(var i=0; i < tokens.length; i++) {
226 if(tokens[i].type == "name" && tokens[i+1] && tokens[i+1].type == 'name') {
227 result += tokens[i].value + ' ';
229 else if (tokens[i].type == 'string') {
230 result += "'" + tokens[i].value + "'";
233 result += tokens[i].value;
239 // print output to the screen, e.g., in a loop
240 // TODO: remove dependency here
242 $('.readLine.active').parent().append('<p>' + JSON.stringify(arguments[0]) + '</p>');
243 return "donotprintme";
247 /* ________________________________________ */
251 return PTAG('HELP') +
252 PTAG('opencloud list opencloud API object types') +
253 PTAG('opencloud.slices list methods to can call on slices') +
254 PTAG('opencloud.slices.all() get all slices') +
255 PTAG('opencloud.slices.filter({key: "value"}) filter using dictionary') +
256 PTAG('opencloud.slices.get({key: "value"})) get using dictionary')
260 _tutorial: function() {
261 this._tutorialPtr = 0;
262 return PTAG("This is a self-guided tutorial on the OpenCloud shell.") +
263 PTAG("The tutorial is simple, more or less a few basic commands to try.") +
264 PTAG("To go directly to any part tutorial, enter one of the commands t0, t1, t2...t10") +
265 PTAG("Otherwise, use 'next' and 'back'. Start by typing 'next' and pressing enter.");
268 // go to the next step in the tutorial.
270 if(this._tutorialPtr < this._tutorialMax) {
271 return this['_t' + (this._tutorialPtr + 1)]();
274 return "You've reached the end of the tutorial. To go to the beginning, type 'tutorial'";
278 // go to the previous step in the tutorial.
280 if(this._tutorialPtr > 1) {
281 return this['_t' + (this._tutorialPtr - 1)]();
284 return this._tutorial();
289 this._tutorialPtr = 1;
290 return PTAG('1. JavaScript Shell') +
291 PTAG('The first thing to notice is that the MongoDB shell is JavaScript-based.') +
292 PTAG('So you can do things like:') +
295 PTAG(' print(a); ') +
296 PTAG(" for(i=0; i<10; i++) { print('hello'); }; ") +
297 PTAG("Try a few JS commands; when you're ready to move on, enter 'next'");
302 this._tutorialPtr = 2;
303 return PTAG('2. List some objects') +
305 PTAG(' opencloud.slices.all();') +
306 PTAG(' opencloud.slivers.all();') +
307 PTAG(' opencloud.sites.all();') +
308 PTAG(' opencloud.nodes.all();');
313 this._tutorialPtr = 3;
314 return PTAG('3. Filter some objects') +
316 PTAG(' opencloud.slices.get({name: "HyperCache"});');
317 PTAG(' opencloud.nodes.filter({site_id: opencloud.sites.get({name: "Princeton"})["id"]});');
322 this._tutorialPtr = 4;
323 return PTAG('4. Available OpenCloud objects and methods') +
325 PTAG(' opencloud;') +
326 PTAG(' opencloud.nodes;');
330 _getCommand: function(tokens) {
331 if(tokens[0] && ArrayInclude(MongoKeywords,(tokens[0].value + '').toLowerCase())) {
332 switch(tokens[0].value.toLowerCase()) {
337 return this._tutorial;
343 return this._tutorial;
357 $htmlFormat = function(obj) {
358 result=tojson(obj, ' ', ' ', true);
362 function startTerminal() {
363 var mongo = new MongoHandler();
364 var terminal = new ReadLine({htmlForInput: DefaultInputHtml,
365 handler: mongo._process,
367 $("#terminal_help1").show();
368 $("#terminal_help2").show();
369 $("#terminal_wait").hide();
371 $("#terminal").bind('click', function() { $(".readLine.active").focus(); });
374 $(document).ready(function() {
375 updateOpenCloud(onLoaded = startTerminal);