14.12.Ruby Hosting

Virtuoso functionality can be enhanced through external libraries by loading shared objects or DLLs. The new functions are written in a language of choice and compiled to produce a shared library appropriate to the operating system. The path to the shared library must be declared in the Virtuoso INI file and the server restarted before it can be used.

The Ruby language is hosted within Virtuoso in this way. hosting_ruby.so (or hosting_ruby.dll ) is the library used.

The Ruby hosting module requires the Ruby library, version 1.8.3 or above, to build and use the module, which then must be installed in the Plugins-Load-path defined in the Virtuoso ini file. The source code for building the hosting_ruby.so module are included in the Unix distribution in the custom/hosting/ruby directory. The Unix installer will offer to build it near the end of the installation process.

The Virtuoso INI file uses a [Plugins] configuration section for listing shared libraries for the server to load upon startup. An example of this is:

LoadPath = /home/virtuoso/hosting
Load1 = Hosting, hosting_ruby.so

The "Hosting" type defines the entry points for initialization of the runtime hosting environment, destruction of the user environment and execution of a file or string containing commands in the hosted language. It also returns a list of file extensions that it is capable of processing. Virtuoso dynamically defines memory-resident (no disk image) HTTP server handlers for each specified type.

The Ruby hosting plugin supports the 'rb' extension. Hence, upon initialization of the hosting plugin, Virtuoso defines the __http_handler_rb(..) function according to the API for file type handlers in the Virtuoso HTTP server. With this handler in place, each hit on a .rb file (file system or WebDAV) with appropriate execute permissions will cause the HTTP server to execute the code within it and return the result instead of simple the file contents.

The ruby interpreter has a global lock unrelated to the Virtuoso hosting module, thus no more than one thread can run ruby code at a time.

The handler will call the __hosting_http_handler VSE with a special set of parameters to represent the HTTP environment correctly. Virtuoso will, by default call the plugin to memory as required, and expel it when finished. This behavior can be controlled by the INI file parameter:

PersistentHostingModules = 1/0 default 0

Setting PersistentHostingModules to "1" prevents Virtuoso from removing the interpreters from the HTTP threads after each request.

[Tip] See Also:

VSEI Plugins

Example14.69.Using the Ruby Plugin

Executing Ruby code directly:

select __hosting_http_handler ('rb', 'print "hello world"; ', '', vector (), 'helloworld.rb');
returns : hello world

Executing a ruby script file (ruby/test_print.rb in the Virtuoso working directory):

print "hello world file";
select __hosting_http_handler ('rb', 'ruby/test_print.rb');
returns : hello world file