alexandria-zoom 0.6.0

data/ext/zoom/rbzoompackage.c

@@ -0,0 +1,200 @@
+/*
+ * Copyright (C) 2007 Katipo Communications, Ltd.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#include "rbzoom.h"
+#include <stdio.h>
+
+#ifdef MAKING_RDOC_HAPPY
+mZoom = rb_define_module("ZOOM");
+#endif
+
+/* Document-class: ZOOM::Package
+ *
+ * This class represents an Extended Services Package: an instruction to the server 
+ * to do something not covered by the core parts of the Z39.50 standard 
+ */
+static VALUE cZoomPackage;
+
+
+static ZOOM_package
+rbz_package_get (VALUE obj)
+{
+    ZOOM_package package;
+
+	if (cZoomPackage == Qnil)
+		rb_raise(rb_eRuntimeError, "cZoomPackage is nil: has destroy() already been called on this Package?");
+        
+    Data_Get_Struct (obj, struct ZOOM_package_p, package);
+    assert (package != NULL);
+
+    return package;
+}
+
+
+/*
+ * call-seq: 
+ * 	make(connection, options)
+*
+*  Creates a ZOOM::Package from the connection and options specified.
+*
+*  Returns: the created ZOOM::Package or Qnil.
+*/
+VALUE
+rbz_package_make (ZOOM_connection connection, ZOOM_options options)
+{
+
+  ZOOM_package package;
+
+  package =  ZOOM_connection_package(connection, options);
+
+  if (cZoomPackage == Qnil)
+	rb_raise(rb_eRuntimeError, "cZoomPackage is nil: has destroy() already been called on this Package?");
+
+  return package != NULL
+      ? Data_Wrap_Struct (cZoomPackage,
+                          NULL,
+                          ZOOM_package_destroy,
+                          package)
+      : Qnil;
+}
+
+
+/*
+ * call-seq:
+ * 	set_option(key, value)
+ *
+ * key: the name of the option, as a string.
+ *
+ * value: the value of this option (as a string, integer or boolean).
+ *
+ * Sets an option on the package.
+ * 
+ * Returns: self.
+ */
+static VALUE
+rbz_package_set_option (VALUE self, VALUE key, VALUE val)
+{   
+
+	ZOOM_package package;
+    
+    package = rbz_package_get (self);
+    ZOOM_package_option_set (package,
+                                RVAL2CSTR (key),
+                                RVAL2CSTR (rb_obj_as_string (val)));
+   
+    return self;
+}
+
+
+/*
+ * call-seq:
+ * 	get_option(key)
+ *
+ * key: the name of the option, as a string.
+ *
+ * Gets the value of a package's option.
+ * 
+ * Returns: the value of the given option, as a string, integer or boolean.
+ */
+static VALUE
+rbz_package_get_option (VALUE self, VALUE key)
+{
+	ZOOM_package package;
+    const char *value;
+ 
+    package = rbz_package_get (self);
+ 
+    value = ZOOM_package_option_get (package,
+                                        RVAL2CSTR (key));
+
+    return zoom_option_value_to_ruby_value (value);
+}
+
+/*
+ * call-seq:
+ * 	send(type)
+ *
+ * type:  the actual extended service package type to be sent, as a string.
+ *
+ * Sends the package.
+ * 
+ * Returns: self.
+ */
+static VALUE
+rbz_package_send(VALUE self, VALUE type)
+{
+    ZOOM_package package;
+	const char *typeChar;
+
+    package = rbz_package_get (self);
+
+    typeChar = StringValuePtr(type);
+    ZOOM_package_send(package, typeChar);
+  
+    return self;
+}
+
+
+
+/* Interface to a subset of the Z39.50 extended services.
+*/
+void
+Init_zoom_package (VALUE mZoom)
+{
+    VALUE c;
+    
+    c = rb_define_class_under (mZoom, "Package", rb_cObject); 
+    rb_undef_alloc_func(c);
+
+	/* Remove the default constructor to force initialization through Connection#package. */
+    rb_undef_method (CLASS_OF (c), "new");
+
+	/* Instance methods */
+    rb_define_method (c, "set_option", rbz_package_set_option, 2);
+    rb_define_method (c, "get_option", rbz_package_get_option, 1);
+    rb_define_method (c, "send", rbz_package_send, 1);
+
+	// Common Options
+    define_zoom_option (c, "package-name");
+	define_zoom_option (c, "user-id");
+	define_zoom_option (c, "function");
+	define_zoom_option (c, "waitAction");
+	define_zoom_option (c, "targetReference");
+	
+	// Item Order, type must be set to itemorder in ZOOM_package_send.
+	define_zoom_option (c, "contact-name");
+	define_zoom_option (c, "contact-phone");
+	define_zoom_option (c, "contact-email");
+	define_zoom_option (c, "itemorder-item");
+	
+	// Record Update, type must be set to update in ZOOM_package_send.
+	define_zoom_option (c, "action");
+	define_zoom_option (c, "recordIdOpaque");
+	define_zoom_option (c, "recordIdNumber");
+	define_zoom_option (c, "record");
+	define_zoom_option (c, "syntax");
+	define_zoom_option (c, "databaseName");
+	define_zoom_option (c, "correlationInfo.note");
+	define_zoom_option (c, "correlationInfo.id");
+	define_zoom_option (c, "elementSetName");
+	
+	// Database Create, type must be set to create in ZOOM_package_send.
+	// Database Drop, type must be set to drop in ZOOM_package_send.
+	    
+    cZoomPackage = c;
+}

data/ext/zoom/rbzoomquery.c

@@ -0,0 +1,125 @@
+/*
+ * Copyright (C) 2005 Laurent Sansonetti <lrz@chopine.be>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#include "rbzoom.h"
+
+#ifdef MAKING_RDOC_HAPPY
+mZoom = rb_define_module("ZOOM");
+#endif
+
+/* Class: ZOOM::Query
+ * Search queries.
+ */
+static VALUE cZoomQuery;
+
+static VALUE
+rbz_query_make (ZOOM_query query)
+{
+    return query != NULL
+        ? Data_Wrap_Struct (cZoomQuery,
+                            NULL,
+                            ZOOM_query_destroy,
+                            query)
+        : Qnil;
+}
+
+ZOOM_query
+rbz_query_get (VALUE obj)
+{
+    ZOOM_query query;
+        
+    Data_Get_Struct (obj, struct ZOOM_query_p, query);
+    assert (query != NULL);
+
+    return query;
+}
+
+/*
+ * call-seq: new_prefix(prefix)
+ *
+ * prefix: PQF notation.
+ *
+ * Creates a RPN query using the given PQF notation.
+ *
+ * Returns: a newly created ZOOM::Query object.
+ */
+static VALUE
+rbz_query_new_prefix (VALUE self, VALUE prefix)
+{
+    ZOOM_query query;
+
+    query = ZOOM_query_create ();
+    ZOOM_query_prefix (query, RVAL2CSTR (prefix)); 
+    
+    return rbz_query_make (query);
+}
+
+/* call-seq:
+ * 	 new_cql(prefix)
+ *
+ * prefix: CQL notation.
+ *
+ * Creates a CQL query using the given CQL notation.
+ *
+ * Returns: a newly created ZOOM::Query object.
+ */
+static VALUE
+rbz_query_new_cql (VALUE self, VALUE cql)
+{
+    ZOOM_query query;
+
+    query = ZOOM_query_create ();
+    ZOOM_query_cql (query, RVAL2CSTR (cql)); 
+    
+    return rbz_query_make (query);
+}
+
+/*
+ * call-seq: new_sort_by(criteria)
+ *
+ * criteria: a sort criteria.
+ *
+ * Creates a sort query from the YAZ sorting notation.
+ *
+ * Returns: a newly created ZOOM::Query object.
+ */
+static VALUE
+rbz_query_new_sort_by (VALUE self, VALUE criteria)
+{
+    ZOOM_query query;
+
+    query = ZOOM_query_create ();
+    ZOOM_query_sortby (rbz_query_get (self), RVAL2CSTR (criteria)); 
+    
+    return rbz_query_make (query);
+}
+
+void
+Init_zoom_query (VALUE mZoom)
+{
+    VALUE c;
+
+    c = rb_define_class_under (mZoom, "Query", rb_cObject); 
+    rb_undef_alloc_func(c);
+
+    rb_define_singleton_method (c, "new_prefix", rbz_query_new_prefix, 1);
+    rb_define_singleton_method (c, "new_cql", rbz_query_new_cql, 1);
+    rb_define_singleton_method (c, "new_sort_by", rbz_query_new_sort_by, 1);
+            
+    cZoomQuery = c;
+}

data/ext/zoom/rbzoomrecord.c

@@ -0,0 +1,192 @@
+/*
+ * Copyright (C) 2005 Laurent Sansonetti <lrz@chopine.be>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#include "rbzoom.h"
+
+#ifdef MAKING_RDOC_HAPPY
+mZoom = rb_define_module("ZOOM");
+#endif
+
+
+/* 
+ * A record object is a retrieval record on the client side - created from 
+ * result sets.
+ */
+static VALUE cZoomRecord;
+
+VALUE
+rbz_record_make (ZOOM_record record)
+{
+    return record != NULL
+        ? Data_Wrap_Struct (cZoomRecord,
+                            NULL,
+                            ZOOM_record_destroy,
+                            record)
+        : Qnil;
+}
+
+static ZOOM_record
+rbz_record_get (VALUE obj)
+{
+    ZOOM_record record;
+        
+    Data_Get_Struct (obj, struct ZOOM_record_p, record);
+    assert (record != NULL);
+
+    return record;
+}
+
+static char _type [128];
+
+static const char *
+rbz_record_type (const char *form, int argc, VALUE *argv)
+{
+    VALUE charset_from;
+    VALUE charset_to;
+
+    if (argc == 0)
+        return form;
+
+    rb_scan_args (argc, argv, "11", &charset_from, &charset_to);
+   
+    memset (_type, 0, sizeof _type);
+    
+    if (NIL_P (charset_to))
+        snprintf (_type, sizeof _type, "%s; charset=%s", form, 
+                  RVAL2CSTR (charset_from));
+    else
+        snprintf (_type, sizeof _type, "%s; charset=%s,%s", form, 
+                  RVAL2CSTR (charset_from), RVAL2CSTR (charset_to));
+
+    return _type;
+}
+
+/*
+ * call-seq: 
+ * 	database(charset_from=nil, charset_to=nil)
+ *
+ * charset_from: the name of the charset to convert from (optional).
+ *
+ * charset_to: the name of the charset to convert to (optional).
+ *
+ * Returns: the database name of the record.
+ */
+static VALUE
+rbz_record_database (int argc, VALUE *argv, VALUE self)
+{
+    return CSTR2RVAL (ZOOM_record_get (rbz_record_get (self),
+                                       rbz_record_type ("database", argc, argv),
+                                       NULL));    
+}
+
+/*
+ * call-seq: 
+ * 	syntax(charset_from=nil, charset_to=nil)
+ *
+ * charset_from: the name of the charset to convert from (optional).
+ *
+ * charset_to: the name of the charset to convert to (optional).
+ *
+ * Returns: the symbolic transfer syntax name of the record.
+ */
+static VALUE
+rbz_record_syntax (int argc, VALUE *argv, VALUE self)
+{
+    return CSTR2RVAL (ZOOM_record_get (rbz_record_get (self),
+                                       rbz_record_type ("syntax", argc, argv),
+                                       NULL));    
+}
+
+/*
+ * call-seq: 
+ * 	render(charset_from=nil, charset_to=nil)
+ *
+ * charset_from: the name of the charset to convert from (optional).
+ *
+ * charset_to: the name of the charset to convert to (optional).
+ *
+ * Returns: a display friendly description of the record.
+ */
+static VALUE
+rbz_record_render (int argc, VALUE *argv, VALUE self)
+{
+    return CSTR2RVAL (ZOOM_record_get (rbz_record_get (self),
+                                       rbz_record_type ("render", argc, argv),
+                                       NULL));    
+}
+
+/*
+ * call-seq: 
+ * 	xml(charset_from=nil, charset_to=nil)
+ *
+ * charset_from: the name of the charset to convert from (optional).
+ *
+ * charset_to: the name of the charset to convert to (optional).
+ *
+ * Returns an XML description of the record.  SRW/SRU and Z39.50 records with 
+ * transfer syntax XML are returned verbatim.  MARC records are returned in 
+ * MARCXML (converted from ISO2709 to MARCXML by YAZ). GRS-1 and OPAC records are 
+ * not supported for this form. 
+ * 
+ * Returns: an XML description of the record.
+ */
+static VALUE
+rbz_record_xml (int argc, VALUE *argv, VALUE self)
+{
+    return CSTR2RVAL (ZOOM_record_get (rbz_record_get (self),
+                                       rbz_record_type ("xml", argc, argv),
+                                       NULL));    
+}
+
+/*
+ * call-seq: 
+ * 	raw
+ *
+ * MARC records are returned in ISO2709.
+ * GRS-1 and OPAC records are not supported for this form. 
+ * 
+ * Returns: an ISO2709 record.
+ */
+
+static VALUE
+rbz_record_raw (int argc, VALUE *argv, VALUE self)
+{
+    return CSTR2RVAL (ZOOM_record_get (rbz_record_get (self),
+                                       rbz_record_type ("raw", argc, argv),
+                                       NULL));    
+}
+
+void
+Init_zoom_record (VALUE mZoom)
+{
+    VALUE c;
+    
+    c = rb_define_class_under (mZoom, "Record", rb_cObject); 
+    rb_undef_alloc_func(c);
+
+    rb_undef_method (CLASS_OF (c), "new");
+
+    rb_define_method (c, "database", rbz_record_database, -1);
+    rb_define_method (c, "syntax", rbz_record_syntax, -1);
+    rb_define_method (c, "render", rbz_record_render, -1);
+    rb_define_alias (c, "to_s", "render");
+    rb_define_method (c, "xml", rbz_record_xml, -1);
+    rb_define_method (c, "raw", rbz_record_raw, -1);
+    
+    cZoomRecord = c;
+}