[Opensrf-commits] r1852 - in trunk: include/opensrf src/libopensrf (scottmk)

[svn at svn.open-ils.org]

Author: scottmk
Date: 2009-11-15 12:57:33 -0500 (Sun, 15 Nov 2009)
New Revision: 1852

Modified:
   trunk/include/opensrf/osrf_message.h
   trunk/src/libopensrf/osrf_message.c
Log:
Create a new function osrfMessageDeserialize(), as a 
replacement for osrf_message_deserialize().

The older osrf_message_deserialize() receives an array of
pointers to populate, along with a maximum number.  If the
JSON input contains more than the maximum number of
messages, the extras are silently discarded.  This design
forces the calling code to guess how many messages it
might ever receive at one time, with no way to determine
whether its guess was good enough.

The newer function returns an osrfList of pointers, and
can therefore return all the messages it finds in the
input, with no risk of loss.

M    include/opensrf/osrf_message.h
M    src/libopensrf/osrf_message.c


Modified: trunk/include/opensrf/osrf_message.h
===================================================================
--- trunk/include/opensrf/osrf_message.h	2009-11-15 16:25:34 UTC (rev 1851)
+++ trunk/include/opensrf/osrf_message.h	2009-11-15 17:57:33 UTC (rev 1852)
@@ -108,6 +108,8 @@
 
 char* osrf_message_serialize(const osrfMessage*);
 
+osrfList* osrfMessageDeserialize( const char* string, osrfList* list );
+
 int osrf_message_deserialize(const char* json, osrfMessage* msgs[], int count);
 
 void osrf_message_set_params( osrfMessage* msg, const jsonObject* o );

Modified: trunk/src/libopensrf/osrf_message.c
===================================================================
--- trunk/src/libopensrf/osrf_message.c	2009-11-15 16:25:34 UTC (rev 1851)
+++ trunk/src/libopensrf/osrf_message.c	2009-11-15 17:57:33 UTC (rev 1852)
@@ -428,7 +428,75 @@
 	return json;
 }
 
+/**
+	@brief Translate a JSON array into an osrfList of osrfMessages.
+	@param string The JSON string to be translated.
+	@param msgs Pointer to an osrfList (may be NULL)
+	@return Pointer to an osrfList containing pointers to osrfMessages.
 
+	The JSON string is expected to be a JSON array, with each element encoding an osrfMessage.
+
+	Translate each element of the JSON array into an osrfMessage, and store a pointer to the
+	osrfMessage in an osrfList.
+
+	If the @a list parameter is NULL, create a new osrfList (with osrfMessageFree() as the
+	callback function for freeing items), populate it, and return a pointer to it.  Otherwise
+	clear the osrfList provided and reuse it.
+
+	When calling osrfMessageDeserialize repeatedly, a reasonable strategy is to pass a NULL
+	for the @a list parameter on the first call, and pass the value returned from the first
+	call on subsequent calls.
+
+	The calling code is responsible for eventually freeing the returned osrfList by calling
+	osrfListFree().
+ */
+osrfList* osrfMessageDeserialize( const char* string, osrfList* list ) {
+
+	if( list )
+		osrfListClear( list );
+
+	if( ! string  || ! *string ) {
+		if( ! list ) {
+			list = osrfNewList( 1 );
+			list->freeItem = (void(*)(void*)) osrfMessageFree;
+		}
+		return list;                   // No string?  Return empty list.
+	}
+	
+	// Parse the JSON
+	jsonObject* json = jsonParseString(string);
+	if(!json) {
+		osrfLogWarning( OSRF_LOG_MARK,
+				"osrfMessageDeserialize() unable to parse data: \n%s\n", string);
+		if( ! list ) {
+			list = osrfNewList( 1 );
+			list->freeItem = (void(*)(void*)) osrfMessageFree;
+		}
+		return list;                   // Bad JSON?  Return empty list.
+	}
+
+	const unsigned int count = (int) json->size;
+	if( ! list ) {
+		// Create a right-sized osrfList
+		list = osrfNewList( count );
+		list->freeItem = (void(*)(void*)) osrfMessageFree;
+	}
+
+	// Traverse the JSON_ARRAY, turning each element into an osrfMessage
+	int i;
+	for( i = 0; i < count; ++i ) {
+
+		const jsonObject* message = jsonObjectGetIndex( json, i );
+		if( message && message->type != JSON_NULL &&
+				  message->classname && !strcmp(message->classname, "osrfMessage" )) {
+			osrfListPush( list, deserialize_one_message( message ) );
+		}
+	}
+
+	jsonObjectFree( json );
+	return list;
+}
+
 /**
 	@brief Translate a JSON array into an array of osrfMessages.
 	@param string The JSON string to be translated.