process.cc 20.8 KB
Newer Older
1
// Copyright 2012 the V8 project authors. All rights reserved.
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#include <v8.h>
29

30 31 32
#include <string>
#include <map>

33 34 35 36
#ifdef COMPRESS_STARTUP_DATA_BZ2
#error Using compressed startup data is not supported for this sample
#endif

37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
using namespace std;
using namespace v8;

// These interfaces represent an existing request processing interface.
// The idea is to imagine a real application that uses these interfaces
// and then add scripting capabilities that allow you to interact with
// the objects through JavaScript.

/**
 * A simplified http request.
 */
class HttpRequest {
 public:
  virtual ~HttpRequest() { }
  virtual const string& Path() = 0;
  virtual const string& Referrer() = 0;
  virtual const string& Host() = 0;
  virtual const string& UserAgent() = 0;
};

/**
 * The abstract superclass of http request processors.
 */
class HttpRequestProcessor {
 public:
  virtual ~HttpRequestProcessor() { }

  // Initialize this processor.  The map contains options that control
  // how requests should be processed.
  virtual bool Initialize(map<string, string>* options,
67
                          map<string, string>* output) = 0;
68 69 70 71 72 73 74 75 76 77 78 79 80 81

  // Process a single request.
  virtual bool Process(HttpRequest* req) = 0;

  static void Log(const char* event);
};

/**
 * An http request processor that is scriptable using JavaScript.
 */
class JsHttpRequestProcessor : public HttpRequestProcessor {
 public:
  // Creates a new processor that processes requests by invoking the
  // Process function of the JavaScript script given as an argument.
82 83
  JsHttpRequestProcessor(Isolate* isolate, Handle<String> script)
      : isolate_(isolate), script_(script) { }
84 85 86
  virtual ~JsHttpRequestProcessor();

  virtual bool Initialize(map<string, string>* opts,
87
                          map<string, string>* output);
88 89 90
  virtual bool Process(HttpRequest* req);

 private:
91 92
  // Execute the script associated with this processor and extract the
  // Process function.  Returns true if this succeeded, otherwise false.
93 94 95 96 97 98 99 100
  bool ExecuteScript(Handle<String> script);

  // Wrap the options and output map in a JavaScript objects and
  // install it in the global namespace as 'options' and 'output'.
  bool InstallMaps(map<string, string>* opts, map<string, string>* output);

  // Constructs the template that describes the JavaScript wrapper
  // type for requests.
101 102
  static Handle<ObjectTemplate> MakeRequestTemplate(Isolate* isolate);
  static Handle<ObjectTemplate> MakeMapTemplate(Isolate* isolate);
103 104 105

  // Callbacks that access the individual fields of request objects.
  static Handle<Value> GetPath(Local<String> name, const AccessorInfo& info);
106 107
  static Handle<Value> GetReferrer(Local<String> name,
                                   const AccessorInfo& info);
108
  static Handle<Value> GetHost(Local<String> name, const AccessorInfo& info);
109 110
  static Handle<Value> GetUserAgent(Local<String> name,
                                    const AccessorInfo& info);
111 112 113

  // Callbacks that access maps
  static Handle<Value> MapGet(Local<String> name, const AccessorInfo& info);
114 115 116
  static Handle<Value> MapSet(Local<String> name,
                              Local<Value> value,
                              const AccessorInfo& info);
117 118 119

  // Utility methods for wrapping C++ objects as JavaScript objects,
  // and going back again.
120
  Handle<Object> WrapMap(map<string, string>* obj);
121
  static map<string, string>* UnwrapMap(Handle<Object> obj);
122
  Handle<Object> WrapRequest(HttpRequest* obj);
123 124
  static HttpRequest* UnwrapRequest(Handle<Object> obj);

125
  Isolate* GetIsolate() { return isolate_; }
126

127
  Isolate* isolate_;
128 129 130 131 132 133 134 135 136 137 138 139 140
  Handle<String> script_;
  Persistent<Context> context_;
  Persistent<Function> process_;
  static Persistent<ObjectTemplate> request_template_;
  static Persistent<ObjectTemplate> map_template_;
};

// -------------------------
// --- P r o c e s s o r ---
// -------------------------


static Handle<Value> LogCallback(const Arguments& args) {
141 142
  if (args.Length() < 1) return Undefined();
  HandleScope scope(args.GetIsolate());
143
  Handle<Value> arg = args[0];
144
  String::Utf8Value value(arg);
145
  HttpRequestProcessor::Log(*value);
146
  return Undefined();
147 148 149 150 151
}


// Execute the script and fetch the Process method.
bool JsHttpRequestProcessor::Initialize(map<string, string>* opts,
152
                                        map<string, string>* output) {
153
  // Create a handle scope to hold the temporary references.
154
  HandleScope handle_scope(GetIsolate());
155 156 157 158 159 160

  // Create a template for the global object where we set the
  // built-in global functions.
  Handle<ObjectTemplate> global = ObjectTemplate::New();
  global->Set(String::New("log"), FunctionTemplate::New(LogCallback));

161 162 163 164 165 166
  // Each processor gets its own context so different processors don't
  // affect each other. Context::New returns a persistent handle which
  // is what we need for the reference to remain after we return from
  // this method. That persistent handle has to be disposed in the
  // destructor.
  context_ = Context::New(NULL, global);
167 168 169

  // Enter the new context so all the following operations take place
  // within it.
170
  Context::Scope context_scope(context_);
171 172 173 174 175 176 177 178 179 180 181 182

  // Make the options mapping available within the context
  if (!InstallMaps(opts, output))
    return false;

  // Compile and run the script
  if (!ExecuteScript(script_))
    return false;

  // The script compiled and ran correctly.  Now we fetch out the
  // Process function from the global object.
  Handle<String> process_name = String::New("Process");
183
  Handle<Value> process_val = context_->Global()->Get(process_name);
184 185 186 187 188 189 190 191 192 193

  // If there is no Process function, or if it is not a function,
  // bail out
  if (!process_val->IsFunction()) return false;

  // It is a function; cast it to a Function
  Handle<Function> process_fun = Handle<Function>::Cast(process_val);

  // Store the function in a Persistent handle, since we also want
  // that to remain after this call returns
194
  process_ = Persistent<Function>::New(GetIsolate(), process_fun);
195 196 197 198 199 200 201

  // All done; all went well
  return true;
}


bool JsHttpRequestProcessor::ExecuteScript(Handle<String> script) {
202
  HandleScope handle_scope(GetIsolate());
203 204 205 206 207 208 209 210

  // We're just about to compile the script; set up an error handler to
  // catch any exceptions the script might throw.
  TryCatch try_catch;

  // Compile the script and check for errors.
  Handle<Script> compiled_script = Script::Compile(script);
  if (compiled_script.IsEmpty()) {
211
    String::Utf8Value error(try_catch.Exception());
212 213 214 215 216 217 218 219 220
    Log(*error);
    // The script failed to compile; bail out.
    return false;
  }

  // Run the script!
  Handle<Value> result = compiled_script->Run();
  if (result.IsEmpty()) {
    // The TryCatch above is still in effect and will have caught the error.
221
    String::Utf8Value error(try_catch.Exception());
222 223 224 225 226 227 228 229 230
    Log(*error);
    // Running the script failed; bail out.
    return false;
  }
  return true;
}


bool JsHttpRequestProcessor::InstallMaps(map<string, string>* opts,
231
                                         map<string, string>* output) {
232
  HandleScope handle_scope(GetIsolate());
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248

  // Wrap the map object in a JavaScript wrapper
  Handle<Object> opts_obj = WrapMap(opts);

  // Set the options object as a property on the global object.
  context_->Global()->Set(String::New("options"), opts_obj);

  Handle<Object> output_obj = WrapMap(output);
  context_->Global()->Set(String::New("output"), output_obj);

  return true;
}


bool JsHttpRequestProcessor::Process(HttpRequest* request) {
  // Create a handle scope to keep the temporary object references.
249
  HandleScope handle_scope(GetIsolate());
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266

  // Enter this processor's context so all the remaining operations
  // take place there
  Context::Scope context_scope(context_);

  // Wrap the C++ request object in a JavaScript wrapper
  Handle<Object> request_obj = WrapRequest(request);

  // Set up an exception handler before calling the Process function
  TryCatch try_catch;

  // Invoke the process function, giving the global object as 'this'
  // and one argument, the request.
  const int argc = 1;
  Handle<Value> argv[argc] = { request_obj };
  Handle<Value> result = process_->Call(context_->Global(), argc, argv);
  if (result.IsEmpty()) {
267
    String::Utf8Value error(try_catch.Exception());
268 269 270 271 272 273 274 275 276 277 278 279
    Log(*error);
    return false;
  } else {
    return true;
  }
}


JsHttpRequestProcessor::~JsHttpRequestProcessor() {
  // Dispose the persistent handles.  When noone else has any
  // references to the objects stored in the handles they will be
  // automatically reclaimed.
280
  Isolate* isolate = GetIsolate();
281 282
  context_.Dispose(isolate);
  process_.Dispose(isolate);
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
}


Persistent<ObjectTemplate> JsHttpRequestProcessor::request_template_;
Persistent<ObjectTemplate> JsHttpRequestProcessor::map_template_;


// -----------------------------------
// --- A c c e s s i n g   M a p s ---
// -----------------------------------

// Utility function that wraps a C++ http request object in a
// JavaScript object.
Handle<Object> JsHttpRequestProcessor::WrapMap(map<string, string>* obj) {
  // Handle scope for temporary handles.
298
  HandleScope handle_scope(GetIsolate());
299 300 301

  // Fetch the template for creating JavaScript map wrappers.
  // It only has to be created once, which we do on demand.
302
  if (map_template_.IsEmpty()) {
303
    Handle<ObjectTemplate> raw_template = MakeMapTemplate(GetIsolate());
304
    map_template_ = Persistent<ObjectTemplate>::New(GetIsolate(), raw_template);
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
  }
  Handle<ObjectTemplate> templ = map_template_;

  // Create an empty map wrapper.
  Handle<Object> result = templ->NewInstance();

  // Wrap the raw C++ pointer in an External so it can be referenced
  // from within JavaScript.
  Handle<External> map_ptr = External::New(obj);

  // Store the map pointer in the JavaScript wrapper.
  result->SetInternalField(0, map_ptr);

  // Return the result through the current handle scope.  Since each
  // of these handles will go away when the handle scope is deleted
  // we need to call Close to let one, the result, escape into the
  // outer handle scope.
  return handle_scope.Close(result);
}


// Utility function that extracts the C++ map pointer from a wrapper
// object.
map<string, string>* JsHttpRequestProcessor::UnwrapMap(Handle<Object> obj) {
  Handle<External> field = Handle<External>::Cast(obj->GetInternalField(0));
  void* ptr = field->Value();
  return static_cast<map<string, string>*>(ptr);
}


// Convert a JavaScript string to a std::string.  To not bother too
// much with string encodings we just use ascii.
string ObjectToString(Local<Value> value) {
338 339
  String::Utf8Value utf8_value(value);
  return string(*utf8_value);
340 341 342 343
}


Handle<Value> JsHttpRequestProcessor::MapGet(Local<String> name,
344
                                             const AccessorInfo& info) {
345 346 347 348 349 350 351 352 353 354 355 356 357 358
  // Fetch the map wrapped by this object.
  map<string, string>* obj = UnwrapMap(info.Holder());

  // Convert the JavaScript string to a std::string.
  string key = ObjectToString(name);

  // Look up the value if it exists using the standard STL ideom.
  map<string, string>::iterator iter = obj->find(key);

  // If the key is not present return an empty handle as signal
  if (iter == obj->end()) return Handle<Value>();

  // Otherwise fetch the value and wrap it in a JavaScript string
  const string& value = (*iter).second;
359
  return String::New(value.c_str(), static_cast<int>(value.length()));
360 361 362 363
}


Handle<Value> JsHttpRequestProcessor::MapSet(Local<String> name,
364 365
                                             Local<Value> value_obj,
                                             const AccessorInfo& info) {
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
  // Fetch the map wrapped by this object.
  map<string, string>* obj = UnwrapMap(info.Holder());

  // Convert the key and value to std::strings.
  string key = ObjectToString(name);
  string value = ObjectToString(value_obj);

  // Update the map.
  (*obj)[key] = value;

  // Return the value; any non-empty handle will work.
  return value_obj;
}


381 382 383
Handle<ObjectTemplate> JsHttpRequestProcessor::MakeMapTemplate(
    Isolate* isolate) {
  HandleScope handle_scope(isolate);
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403

  Handle<ObjectTemplate> result = ObjectTemplate::New();
  result->SetInternalFieldCount(1);
  result->SetNamedPropertyHandler(MapGet, MapSet);

  // Again, return the result through the current handle scope.
  return handle_scope.Close(result);
}


// -------------------------------------------
// --- A c c e s s i n g   R e q u e s t s ---
// -------------------------------------------

/**
 * Utility function that wraps a C++ http request object in a
 * JavaScript object.
 */
Handle<Object> JsHttpRequestProcessor::WrapRequest(HttpRequest* request) {
  // Handle scope for temporary handles.
404
  HandleScope handle_scope(GetIsolate());
405 406 407 408

  // Fetch the template for creating JavaScript http request wrappers.
  // It only has to be created once, which we do on demand.
  if (request_template_.IsEmpty()) {
409
    Handle<ObjectTemplate> raw_template = MakeRequestTemplate(GetIsolate());
410 411
    request_template_ =
        Persistent<ObjectTemplate>::New(GetIsolate(), raw_template);
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
  }
  Handle<ObjectTemplate> templ = request_template_;

  // Create an empty http request wrapper.
  Handle<Object> result = templ->NewInstance();

  // Wrap the raw C++ pointer in an External so it can be referenced
  // from within JavaScript.
  Handle<External> request_ptr = External::New(request);

  // Store the request pointer in the JavaScript wrapper.
  result->SetInternalField(0, request_ptr);

  // Return the result through the current handle scope.  Since each
  // of these handles will go away when the handle scope is deleted
  // we need to call Close to let one, the result, escape into the
  // outer handle scope.
  return handle_scope.Close(result);
}


/**
 * Utility function that extracts the C++ http request object from a
 * wrapper object.
 */
HttpRequest* JsHttpRequestProcessor::UnwrapRequest(Handle<Object> obj) {
  Handle<External> field = Handle<External>::Cast(obj->GetInternalField(0));
  void* ptr = field->Value();
  return static_cast<HttpRequest*>(ptr);
}


Handle<Value> JsHttpRequestProcessor::GetPath(Local<String> name,
445
                                              const AccessorInfo& info) {
446 447 448 449 450 451 452
  // Extract the C++ request object from the JavaScript wrapper.
  HttpRequest* request = UnwrapRequest(info.Holder());

  // Fetch the path.
  const string& path = request->Path();

  // Wrap the result in a JavaScript string and return it.
453
  return String::New(path.c_str(), static_cast<int>(path.length()));
454 455 456 457
}


Handle<Value> JsHttpRequestProcessor::GetReferrer(Local<String> name,
458
                                                  const AccessorInfo& info) {
459 460
  HttpRequest* request = UnwrapRequest(info.Holder());
  const string& path = request->Referrer();
461
  return String::New(path.c_str(), static_cast<int>(path.length()));
462 463 464 465
}


Handle<Value> JsHttpRequestProcessor::GetHost(Local<String> name,
466
                                              const AccessorInfo& info) {
467 468
  HttpRequest* request = UnwrapRequest(info.Holder());
  const string& path = request->Host();
469
  return String::New(path.c_str(), static_cast<int>(path.length()));
470 471 472 473
}


Handle<Value> JsHttpRequestProcessor::GetUserAgent(Local<String> name,
474
                                                   const AccessorInfo& info) {
475 476
  HttpRequest* request = UnwrapRequest(info.Holder());
  const string& path = request->UserAgent();
477
  return String::New(path.c_str(), static_cast<int>(path.length()));
478 479 480
}


481 482 483
Handle<ObjectTemplate> JsHttpRequestProcessor::MakeRequestTemplate(
    Isolate* isolate) {
  HandleScope handle_scope(isolate);
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511

  Handle<ObjectTemplate> result = ObjectTemplate::New();
  result->SetInternalFieldCount(1);

  // Add accessors for each of the fields of the request.
  result->SetAccessor(String::NewSymbol("path"), GetPath);
  result->SetAccessor(String::NewSymbol("referrer"), GetReferrer);
  result->SetAccessor(String::NewSymbol("host"), GetHost);
  result->SetAccessor(String::NewSymbol("userAgent"), GetUserAgent);

  // Again, return the result through the current handle scope.
  return handle_scope.Close(result);
}


// --- Test ---


void HttpRequestProcessor::Log(const char* event) {
  printf("Logged: %s\n", event);
}


/**
 * A simplified http request.
 */
class StringHttpRequest : public HttpRequest {
 public:
512 513 514 515
  StringHttpRequest(const string& path,
                    const string& referrer,
                    const string& host,
                    const string& user_agent);
516 517 518 519 520 521 522 523 524 525 526 527 528
  virtual const string& Path() { return path_; }
  virtual const string& Referrer() { return referrer_; }
  virtual const string& Host() { return host_; }
  virtual const string& UserAgent() { return user_agent_; }
 private:
  string path_;
  string referrer_;
  string host_;
  string user_agent_;
};


StringHttpRequest::StringHttpRequest(const string& path,
529 530 531
                                     const string& referrer,
                                     const string& host,
                                     const string& user_agent)
532 533 534 535 536 537
    : path_(path),
      referrer_(referrer),
      host_(host),
      user_agent_(user_agent) { }


538 539 540 541
void ParseOptions(int argc,
                  char* argv[],
                  map<string, string>& options,
                  string* file) {
542 543
  for (int i = 1; i < argc; i++) {
    string arg = argv[i];
544
    size_t index = arg.find('=', 0);
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
    if (index == string::npos) {
      *file = arg;
    } else {
      string key = arg.substr(0, index);
      string value = arg.substr(index+1);
      options[key] = value;
    }
  }
}


// Reads a file into a v8 string.
Handle<String> ReadFile(const string& name) {
  FILE* file = fopen(name.c_str(), "rb");
  if (file == NULL) return Handle<String>();

  fseek(file, 0, SEEK_END);
562
  int size = ftell(file);
563 564 565 566
  rewind(file);

  char* chars = new char[size + 1];
  chars[size] = '\0';
567
  for (int i = 0; i < size;) {
568
    int read = static_cast<int>(fread(&chars[i], 1, size - i, file));
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
    i += read;
  }
  fclose(file);
  Handle<String> result = String::New(chars, size);
  delete[] chars;
  return result;
}


const int kSampleSize = 6;
StringHttpRequest kSampleRequests[kSampleSize] = {
  StringHttpRequest("/process.cc", "localhost", "google.com", "firefox"),
  StringHttpRequest("/", "localhost", "google.net", "firefox"),
  StringHttpRequest("/", "localhost", "google.org", "safari"),
  StringHttpRequest("/", "localhost", "yahoo.com", "ie"),
  StringHttpRequest("/", "localhost", "yahoo.com", "safari"),
  StringHttpRequest("/", "localhost", "yahoo.com", "firefox")
};


bool ProcessEntries(HttpRequestProcessor* processor, int count,
590
                    StringHttpRequest* reqs) {
591 592 593 594 595 596 597 598
  for (int i = 0; i < count; i++) {
    if (!processor->Process(&reqs[i]))
      return false;
  }
  return true;
}


599 600
void PrintMap(map<string, string>* m) {
  for (map<string, string>::iterator i = m->begin(); i != m->end(); i++) {
601 602 603 604 605 606 607 608 609 610 611 612 613 614
    pair<string, string> entry = *i;
    printf("%s: %s\n", entry.first.c_str(), entry.second.c_str());
  }
}


int main(int argc, char* argv[]) {
  map<string, string> options;
  string file;
  ParseOptions(argc, argv, options, &file);
  if (file.empty()) {
    fprintf(stderr, "No script was specified.\n");
    return 1;
  }
615 616
  Isolate* isolate = Isolate::GetCurrent();
  HandleScope scope(isolate);
617 618 619 620 621
  Handle<String> source = ReadFile(file);
  if (source.IsEmpty()) {
    fprintf(stderr, "Error reading '%s'.\n", file.c_str());
    return 1;
  }
622
  JsHttpRequestProcessor processor(isolate, source);
623 624 625 626 627 628 629
  map<string, string> output;
  if (!processor.Initialize(&options, &output)) {
    fprintf(stderr, "Error initializing processor.\n");
    return 1;
  }
  if (!ProcessEntries(&processor, kSampleSize, kSampleRequests))
    return 1;
630
  PrintMap(&output);
631
}