Merge lp:~zorba-coders/zorba/sqlite-check-for-metadata-availability into lp:zorba/sqlite-module

[Luis Rodriguez Gonzalez]

- New feature detection code added to CMake to be sure that SQLite is able to read metadata (fix for Mac OSX)

- New feature detection code added to CMake to be sure that SQLite is able to read metadata (fix for Mac OSX)

[lp:~zorba-coders/zorba/sqlite-check-for-metadata-availability]

31. By Luis Rodriguez Gonzalez on 2013-01-26

- Fixed bug that affected the error message when trying to use metadata() with a SQLite library that cannot retrieve metadata.

[Chris Hillery (ceejatec)]

Unless I'm missing something, it'd be cleaner to avoid the compilation of JSONMetadataItemSequence entirely by #ifdef-ing out the class and method definitions in the .cpp and .h files.

review: Needs Fixing

[lp:~zorba-coders/zorba/sqlite-check-for-metadata-availability]

32. By Luis Rodriguez Gonzalez on 2013-02-18

JSONMetadataItemSequence is now ommited if sqlite is not compiled with Metadata information.

[Luis Rodriguez Gonzalez (kuraru)]

I think this branch is corrected as Chris suggested. Please re-review.

[Chris Hillery (ceejatec)]

review: Approve

[William Candillon (wcandillon)]

review: Approve

[Zorba Build Bot (zorba-buildbot)]

Validation queue starting for merge proposal.
Log at: http://zorbatest.lambda.nu:8080/remotequeue/sqlite-check-for-metadata-availability-2013-04-30T18-03-45.308Z/log.html

[Zorba Build Bot (zorba-buildbot)]

Validation queue job sqlite-check-for-metadata-availability-2013-04-30T18-03-45.308Z is finished. The final status was:

All tests succeeded!

=== modified file 'cmake_modules/FindSQLite3.cmake'
--- cmake_modules/FindSQLite3.cmake	2012-11-20 16:41:36 +0000
+++ cmake_modules/FindSQLite3.cmake	2013-02-18 22:18:20 +0000
@@ -39,8 +39,9 @@
 
   SET(CMAKE_REQUIRED_INCLUDES "${SQLITE_INCLUDE_DIR}")
   SET(CMAKE_REQUIRED_LIBRARIES "${SQLITE_LIBRARY}")
-#  INCLUDE(CheckFunctionExists)
-#  CHECK_FUNCTION_EXISTS(archive_write_zip_set_compression_deflate #ZORBA_LIBARCHIVE_HAVE_SET_COMPRESSION)
+  
+  INCLUDE(CheckFunctionExists)
+  CHECK_FUNCTION_EXISTS(sqlite3_column_database_name ZORBA_SQLITE_HAVE_METADATA)
 ELSE (SQLITE_INCLUDE_DIR AND SQLITE_LIBRARY)
   SET (SQLITE_FOUND 0)
   SET (SQLITE_LIBRARIES)

=== modified file 'src/config.h.cmake'
--- src/config.h.cmake	2013-01-24 06:17:00 +0000
+++ src/config.h.cmake	2013-02-18 22:18:20 +0000
@@ -21,5 +21,6 @@
 #define ZORBA_SQLITE_CONFIG_H
 
 #cmakedefine SQLITE_WITH_FILE_ACCESS
+#cmakedefine ZORBA_SQLITE_HAVE_METADATA
 
 #endif /* ZORBA_SQLITE_CONFIG_H */

=== modified file 'src/sqlite_module.xq'
--- src/sqlite_module.xq	2013-01-24 06:17:00 +0000
+++ src/sqlite_module.xq	2013-02-18 22:18:20 +0000
@@ -68,6 +68,8 @@
  :
  : @error s:SQLI0001 if the databse name doesn't exist or it couldn't be opened.
  : @error s:SQLI0007 if there is any unknown option specified.
+ : @error s:SQLI0008 if a non-in-memory database is requested and the module
+ :     is built without filesystem access
  : @error s:SQLI9999 if there was an internal error inside SQLite library.
  :)
 declare %an:sequential function s:connect(
@@ -173,6 +175,8 @@
  : @return a object() with the associated the metadata.
  :
  : @error s:SQLI0004 if $pstmnt is not a valid SQLite prepared statement.
+ : @error s:SQLI0009 if no metadata is available (SQLite library compiled without
+ :     SQLITE_ENABLE_COLUMN_METADATA).
  : @error s:SQLI9999 if there was an internal error inside SQLite library.
  :)
 declare %an:sequential function s:metadata(

=== modified file 'src/sqlite_module.xq.src/sqlite_module.cpp'
--- src/sqlite_module.xq.src/sqlite_module.cpp	2013-01-24 06:17:00 +0000
+++ src/sqlite_module.xq.src/sqlite_module.cpp	2013-02-18 22:18:20 +0000
@@ -30,8 +30,8 @@
 #include <iostream>
 #include <stdio.h>
 
+#include <sqlite_module/config.h>
 #include "sqlite_module.h"
-#include <sqlite_module/config.h>
 
 namespace zorba { namespace sqlite {
 
@@ -573,6 +573,12 @@
       return "Only in-memory databases are allowed (Module built without filesystem access)";
     }
 #endif /* not SQLITE_WITH_FILE_ACCESS */
+#ifndef ZORBA_SQLITE_HAVE_METADATA
+    else if(error == "SQLI0009")
+    {
+      return "Metadata not found (SQLite built without SQLITE_ENABLE_COLUMN_METADATA)";
+    }
+#endif /* not ZORBA_SQLITE_HAVE_METADATA */
     else if(error == "SQLI9999")
     {
       return "Internal error ocurred";
@@ -795,6 +801,7 @@
 /*******************************************************************************
  *              JSONMetadataItemSequence::JSONMetadataIterator                 *
  ******************************************************************************/
+#ifdef ZORBA_SQLITE_HAVE_METADATA
   void JSONMetadataItemSequence::JSONMetadataIterator::open(){
     // Get data and create the column names
     if(theStmt != NULL){
@@ -888,6 +895,7 @@
     if(theStmt != NULL)
       sqlite3_reset(theStmt);
   }
+#endif
 
 /*******************************************************************************
  ******************************************************************************/
@@ -1068,6 +1076,7 @@
     const zorba::StaticContext* aSctx,
     const zorba::DynamicContext* aDctx) const 
   {
+#ifdef ZORBA_SQLITE_HAVE_METADATA
     sqlite3_stmt *lPstmt;
     zorba::Item lItemPstmt = getOneItem(aArgs, 0);
     zorba::Item lVecItem, lJSONKey, lJSONArray, lJSONRes;
@@ -1101,6 +1110,9 @@
     lJSONRes = lFactory->createJSONObject(lVectorRes);
     
     return ItemSequence_t(new SingletonItemSequence(lJSONRes));
+#else
+    throwError("SQLI0009", getErrorMessage("SQLI0009"));
+#endif
   }
 
 /*******************************************************************************

=== modified file 'src/sqlite_module.xq.src/sqlite_module.h'
--- src/sqlite_module.xq.src/sqlite_module.h	2013-01-10 21:55:06 +0000
+++ src/sqlite_module.xq.src/sqlite_module.h	2013-02-18 22:18:20 +0000
@@ -158,6 +158,7 @@
 
 /*******************************************************************************
  ******************************************************************************/
+#ifdef ZORBA_SQLITE_HAVE_METADATA
   class JSONMetadataItemSequence : public ItemSequence
   {
     public:
@@ -204,6 +205,7 @@
       zorba::Iterator_t 
         getIterator() { return new JSONMetadataIterator(thePrepStmt); }
   };
+#endif
 
 /*******************************************************************************
  ******************************************************************************/

=== added file 'test/Queries/test3.spec'
--- test/Queries/test3.spec	1970-01-01 00:00:00 +0000
+++ test/Queries/test3.spec	2013-02-18 22:18:20 +0000
@@ -0,0 +1,1 @@
+Error: http://www.zorba-xquery.com/modules/sqlite:SQLI0009

=== added file 'test/Queries/test4.spec'
--- test/Queries/test4.spec	1970-01-01 00:00:00 +0000
+++ test/Queries/test4.spec	2013-02-18 22:18:20 +0000
@@ -0,0 +1,1 @@
+Error: http://www.zorba-xquery.com/modules/sqlite:SQLI0009

=== added file 'test/Queries/test5.spec'
--- test/Queries/test5.spec	1970-01-01 00:00:00 +0000
+++ test/Queries/test5.spec	2013-02-18 22:18:20 +0000
@@ -0,0 +1,1 @@
+Error: http://www.zorba-xquery.com/modules/sqlite:SQLI0009