staf4ruby 0.1.0

data/Rakefile

@@ -0,0 +1,58 @@
+##############################################################################
+# Copyright (c) 2013 Spectra Logic corp
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.eclipse.org/legal/epl-v10.html
+##############################################################################
+
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rake/testtask'
+require 'rake/clean'
+
+file "lib/staf4ruby_ext.so" => Dir.glob("ext/*.{rb,c}") do
+  Dir.chdir("ext") do
+    ruby "extconf.rb"
+    sh "make"
+  end
+  cp "ext/staf4ruby_ext.so", "lib"
+end
+
+  
+Rake::TestTask.new :test do |test|
+  test.verbose = false
+  test.test_files = ['test/test.rb']
+end
+task :test => "lib/staf4ruby_ext.so"
+
+CLEAN.include('ext/Makefile')
+CLEAN.include('ext/*.{o,so}')
+CLOBBER.include('lib/*.{o,so}')
+
+gem_spec = Gem::Specification.new do |s|
+  s.name=%q{staf4ruby}
+  s.version="0.1.0"
+  s.date=%q{2014-01-08}
+  s.authors=["Alan Somers"]
+  s.email=%q{alans@spectralogic.com}
+  s.extensions="ext/extconf.rb"
+  s.homepage="http://www.spectralogic.com"
+  s.rubyforge_project="none"
+  s.summary=%q{Ruby interface to STAF.}
+  s.description=%q{Ruby interface to the STAF C APIs.}
+  s.license='EPL'
+  # Install the Rakefile and the test files so we can test it on the
+  # target
+  s.files=["Rakefile",
+           "ext/extconf.rb",
+           "ext/staf4ruby_ext.c",
+           "lib/staf4ruby.rb",
+           "test/test.rb",
+           "test/test_helper.rb"]
+end
+
+Gem::PackageTask.new(gem_spec) do |pkg|
+  pkg.need_tar = false
+  pkg.need_zip = false
+end

data/ext/extconf.rb

@@ -0,0 +1,19 @@
+##############################################################################
+# Copyright (c) 2013 Spectra Logic corp
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.eclipse.org/legal/epl-v10.html
+##############################################################################
+
+require 'mkmf'
+
+$CFLAGS += " -g3 -O0 -Wall -Werror"
+$INCFLAGS << " " <<
+  "-I/usr/local/staf/include"
+  $LDFLAGS += " -L/usr/local/staf/lib -lSTAF"
+
+puts "Using INCFLAGS='#{$INCFLAGS}'"
+
+
+create_makefile("staf4ruby_ext")

data/ext/staf4ruby_ext.c

@@ -0,0 +1,270 @@
+/* vim: ts=8,sw=8,noexpandtab */
+/*****************************************************************************
+ * Copyright (c) 2013 Spectra Logic corp
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ ****************************************************************************/
+
+/*
+ * Provide a simple interface to the STAF C API, without marshalling
+ */
+
+#include <unistd.h>
+#include <stdint.h>
+#include <stdbool.h>
+#include <stdlib.h>
+#include <errno.h>
+#include <STAF.h>
+#include <STAFString.h>
+
+#include <ruby.h>
+
+/* Global data */
+VALUE rb_mStaf;
+
+typedef struct {
+	STAFHandle_t	handle;
+	STAFSyncOption_t syncOption;
+	char*		machine;
+	char*		service;
+	char*		request;
+	unsigned int	requestLength;
+	STAFRC_t*	rc;
+	char**		result;
+	unsigned int*	resultLen;
+} staf_submit_args_t;
+
+/***************************** Private C Methods *****************************/
+
+static VALUE
+rb_STAFSubmit_blocking(void* data)
+{
+	staf_submit_args_t* args = (staf_submit_args_t*)data;
+
+	*(args->rc) = STAFSubmit2(args->handle, args->syncOption,
+			args->machine, args->service, args->request,
+			args->requestLength, args->result, args->resultLen);
+	if (*(args->result) == NULL)
+		*(args->result) = "";
+
+	return (Qnil);
+}
+
+static void
+rb_STAFCancel(void* data)
+{
+	/* 
+	 * This function ought to cancel any pending submit.  But AFAIK there
+	 * is no way to do that in the STAF API.  Perhaps unregistering the
+	 * handle would work.  I don't know.  TODO: implement me.
+	 */
+	return;
+}
+
+
+/*************************** Staf Module Functions ***********************/
+/*
+ * Register with STAF
+ * \param name a Ruby string used as the handle's name
+ * \return a ruby array of [return code, STAF handle]
+ */
+static VALUE
+rb_STAFRegister(VALUE rb_self, VALUE rb_name)
+{
+	char* name;
+	STAFHandle_t handle = 0;
+	STAFRC_t rc;
+
+	name = StringValueCStr(rb_name);
+	rc = STAFRegister(name, &handle);
+
+	return (rb_ary_new3(2, UINT2NUM(rc), UINT2NUM(handle)));
+}
+
+/*
+ * Unregister from STAF
+ * \param rb_handle a STAF handle as returned by STAFRegister
+ * \return a STAF return code as a ruby number
+ */
+static VALUE
+rb_STAFUnregister(VALUE rb_self, VALUE rb_handle)
+{
+	STAFHandle_t handle;
+	STAFRC_t rc;
+
+	handle = NUM2UINT(rb_handle);
+	rc = STAFUnRegister(handle);
+
+	return (UINT2NUM(rc));
+}
+
+/*
+ * Submit a STAF request
+ * \param 	rb_handle a STAF handle as returned by STAFRegister
+ * \param	rb_syncOption a ruby number sync option as used by STAFSubmit2
+ * \param	rb_machine a ruby string specifying the machine to use
+ * \param	rb_request The STAF request as a ruby string
+ * \return 	a STAF return code as a ruby number
+ */
+static VALUE
+rb_STAFSubmit(VALUE rb_self, VALUE rb_handle, VALUE rb_syncOption, VALUE rb_machine, VALUE rb_service, VALUE rb_request)
+{
+	STAFRC_t rc;
+	char* result;
+	unsigned int resultLen;
+	staf_submit_args_t args;
+	VALUE rb_result;
+
+	args.handle = NUM2UINT(rb_handle);
+	args.syncOption = NUM2UINT(rb_syncOption);
+	args.machine = StringValueCStr(rb_machine);
+	args.service = StringValueCStr(rb_service);
+	args.request = StringValueCStr(rb_request);
+	args.requestLength = RSTRING_LEN(rb_request);
+	args.rc = &rc;
+	args.result = &result;
+	args.resultLen = &resultLen;
+
+	rb_thread_blocking_region(rb_STAFSubmit_blocking, (void*) &args,
+				  rb_STAFCancel, (void*) NULL);
+
+	rb_result = rb_ary_new3(3, UINT2NUM(rc), rb_str_new(result, resultLen),
+				UINT2NUM(resultLen));
+	if (result != NULL && *result != '\0')
+		STAFFree(args.handle, result);
+	return (rb_result);
+}
+
+/*
+ * Add Privacy delimiters to a string
+ * \param	rb_data A ruby string
+ * \return	a ruby array of [return code, output string]
+ */
+static VALUE
+rb_STAFAddPrivacyDelimiters(VALUE rb_self, VALUE rb_data)
+{
+	STAFRC_t rc;
+	char* data;
+	STAFString_t input, result;
+	unsigned int osRC, len;
+	char* buf;
+	VALUE output;
+
+	data = StringValueCStr(rb_data);
+	rc = STAFStringConstructFromCurrentCodePage(&input, data, strlen(data),
+			&osRC);
+	// TODO: validate return codes
+	rc = STAFAddPrivacyDelimiters(input, &result);
+	rc = STAFStringToCurrentCodePage(result, &buf, &len, &osRC);
+	output = rb_ary_new3(2, UINT2NUM(rc), rb_str_new2(buf));
+	STAFStringFreeBuffer(buf, &osRC);
+	return output;
+}
+
+/*
+ * Escape privacy delimiters present in a string
+ * \param	rb_data A ruby string
+ * \return	a ruby array of [return code, output string]
+ */
+static VALUE
+rb_STAFEscapePrivacyDelimiters(VALUE rb_self, VALUE rb_data)
+{
+	STAFRC_t rc;
+	char* data;
+	STAFString_t input, result;
+	unsigned int osRC, len;
+	char* buf;
+	VALUE output;
+
+	data = StringValueCStr(rb_data);
+	rc = STAFStringConstructFromCurrentCodePage(&input, data, strlen(data),
+			&osRC);
+	// TODO: validate return codes
+	rc = STAFEscapePrivacyDelimiters(input, &result);
+	rc = STAFStringToCurrentCodePage(result, &buf, &len, &osRC);
+	output = rb_ary_new3(2, UINT2NUM(rc), rb_str_new2(buf));
+	STAFStringFreeBuffer(buf, &osRC);
+	return output;
+}
+
+/*
+ * Mask delimited private data in a string
+ * \param	rb_data A ruby string
+ * \return	a ruby array of [return code, output string]
+ */
+static VALUE
+rb_STAFMaskPrivateData(VALUE rb_self, VALUE rb_data)
+{
+	STAFRC_t rc;
+	char* data;
+	STAFString_t input, result;
+	unsigned int osRC, len;
+	char* buf;
+	VALUE output;
+
+	data = StringValueCStr(rb_data);
+	rc = STAFStringConstructFromCurrentCodePage(&input, data, strlen(data),
+			&osRC);
+	// TODO: validate return codes
+	rc = STAFMaskPrivateData(input, &result);
+	rc = STAFStringToCurrentCodePage(result, &buf, &len, &osRC);
+	output = rb_ary_new3(2, UINT2NUM(rc), rb_str_new2(buf));
+	STAFStringFreeBuffer(buf, &osRC);
+	return output;
+}
+
+/*
+ * Remove privacy delimiters in a string
+ * \param	rb_data A ruby string
+ * \return	a ruby array of [return code, output string]
+ */
+static VALUE
+rb_STAFRemovePrivacyDelimiters(VALUE rb_self, VALUE rb_data, VALUE rb_levels)
+{	
+	STAFRC_t rc;
+	char* data;
+	STAFString_t input, result;
+	unsigned int osRC, len;
+	char* buf;
+	VALUE output;
+	unsigned int numLevels;
+
+	data = StringValueCStr(rb_data);
+	numLevels = NUM2UINT(rb_levels);
+	// TODO: validate return codes
+	rc = STAFStringConstructFromCurrentCodePage(&input, data, strlen(data),
+			&osRC);
+	rc = STAFRemovePrivacyDelimiters(input, numLevels, &result);
+	rc = STAFStringToCurrentCodePage(result, &buf, &len, &osRC);
+	output = rb_ary_new3(2, UINT2NUM(rc), rb_str_new2(buf));
+	STAFStringFreeBuffer(buf, &osRC);
+	return output;
+}
+
+
+/*************************** Initialize the module ***************************/
+
+void Init_staf4ruby_ext()
+{
+	rb_mStaf = rb_define_module("Staf");
+
+	/* Constants */
+
+	/* module functions */
+	rb_define_module_function(rb_mStaf, "register",
+      rb_STAFRegister, 1);
+  rb_define_module_function(rb_mStaf, "submit", rb_STAFSubmit,
+			5);
+	rb_define_module_function(rb_mStaf, "unregister",
+			rb_STAFUnregister, 1);
+	rb_define_module_function(rb_mStaf, "addPrivacyDelimiters",
+			rb_STAFAddPrivacyDelimiters, 1);
+	rb_define_module_function(rb_mStaf, "escapePrivacyDelimiters",
+			rb_STAFEscapePrivacyDelimiters, 1);
+	rb_define_module_function(rb_mStaf, "maskPrivateData",
+			rb_STAFMaskPrivateData, 1);
+	rb_define_module_function(rb_mStaf, "removePrivacyDelimiters",
+			rb_STAFRemovePrivacyDelimiters, 2);
+}