Merge pull request #99 from jrochel/ocsipersist-pgsql

PostgreSQL backend for Ocsipersist

Author: vouillon

README.md

@@ -23,6 +23,7 @@ Libraries:
  * tyxml             (need version 3)
  * ipaddr            (need version >= 2.1)
  * ocamlsqlite3      (tested with 2.0.2) OR
+ * pgocaml           (tested with 2.3) OR
  * dbm               (tested with 1.0)
 
 

configure

@@ -78,6 +78,7 @@ set_defaults () {
     enable_debug=1
     enable_annot=1
     with_sqlite=1
+    with_pgsql=1
     with_camlzip=1
     with_dbm=1
     with_preempt=1
@@ -107,7 +108,7 @@ full_pwd=`pwd`
 
 ## Which options exist? eoptions for enable/disable, woptions for with/without:
 eoptions="debug annot natdynlink"
-woptions="sqlite dbm camlzip preempt"
+woptions="pgsql sqlite dbm camlzip preempt"
 
 print_options () {
 	for opt in $eoptions; do
@@ -184,6 +185,7 @@ usage: ./configure [ options ]
   --enable-natdynlink,	--disable-natdynlink	Enable/disable nativecode dynamic linking
 
   --with-sqlite,	--without-sqlite	Compile ocsipersist with SQLite for persistent storage
+  --with-pgsql,	--without-pgsql		Compile ocsipersist with PostgreSQL for persistent storage
   --with-dbm,		--without-dbm		Compile ocsipersist with DBM for persistent storage
   --with-camlzip,	--without-camlzip	Compile deflatemod extension, requires camlzip
 
@@ -424,6 +426,12 @@ check_library cryptokit "See: http://pauillac.inria.fr/~xleroy/software.html#cry
 
 check_library tyxml "See: http://ocsigen.org/tyxml/"
 
+# Check PostgreSQL
+case "$with_pgsql" in
+ 1) if test_library pgocaml; then with_pgsql=1; else with_pgsql=0; fi;;
+ 2) check_library pgocaml "https://github.com/darioteixeira/pgocaml";;
+esac
+
 # Check Sqlite3
 case "$with_sqlite" in
  1) if test_library sqlite3; then with_sqlite=1; else with_sqlite=0; fi;;
@@ -514,6 +522,11 @@ if [ $with_sqlite -gt 0 ] ; then
 else
 	with_sqlite="NO"
 fi
+if [ $with_pgsql -gt 0 ] ; then
+	with_pgsql="YES"
+else
+	with_pgsql="NO"
+fi
 if [ $with_camlzip -gt 0 ] ; then
 	with_camlzip="YES"
 else
@@ -569,6 +582,9 @@ CAMLZIPNAME:=$zipname
 # Do you want ocsipersist with sqlite? YES/NO
 OCSIPERSISTSQLITE:=$with_sqlite
 
+# Do you want ocsipersist with pgsql? YES/NO
+OCSIPERSISTPGSQL:=$with_pgsql
+
 # Do you want ocsipersist with dbm? YES/NO
 OCSIPERSISTDBM:=$with_dbm
 

doc/manual-wiki/config.wiki

@@ -148,7 +148,10 @@ Here is a simple example:
 </ocsigen>
 }}}
 
-Here is another example, for use as unprivileged user toto on port 8000:
+Here is another example, for use as unprivileged user toto on port 8000.
+We use the PostgreSQL (version >= 9.5) backend for ocsipersist. Note that the
+ocsipersist-database under the specified name (default: "ocsipersist") needs to
+exist. To create it run {{{psql}}} and execute {{{CREATE TABLE ocsipersist;}}}.
 
 {{{
 <ocsigen>
@@ -167,8 +170,14 @@ Here is another example, for use as unprivileged user toto on port 8000:
 
     <extension findlib-package="ocsigenserver.ext.staticmod"/>
 
-    <extension findlib-package="ocsigenserver.ext.ocsipersist-sqlite"/>
-    <!-- sqlite3.cma will be loaded automatically using findlib -->
+    <extension findlib-package="ocsigenserver.ext.ocsipersist-pgsql">
+      <database <!-- optional, as each of the following attributes are -->
+        port="3000"
+        user="toto"
+        password="toto's secret"
+      />
+    </extension>
+    <!-- pa_pgsql.cma will be loaded automatically using findlib -->
 
     <extension findlib-package="ocsigenserver.ext.eliom"/>
     <!-- Eliom's dependencies will be loaded automatically using findlib -->
@@ -182,7 +191,7 @@ Here is another example, for use as unprivileged user toto on port 8000:
       <site path="tuto">
         <eliom module="/usr/local/lib/ocsigenserver/tutoeliom.cmo" />
         <static dir="/home/toto/var/www/ocsigenserver/tutorial" />
-	<!-- Module's path coul be relative but static dir must be absolute -->
+        <!-- Module's path coul be relative but static dir must be absolute -->
       </site>
 
     </host>

doc/manual-wiki/libraries.wiki

@@ -5,15 +5,17 @@
 
 ==Ocsipersist
 
-<<div class="wip"|Ocsipersist (2 implémentations)
+<<div class="wip"|Ocsipersist (3 implémentations)
 Eliom allows to use more persistent data, using the module
 <<a_api project="ocsigenserver" | module Ocsipersist >> is needed in
 {{{ eliom.cma }}}, thus you need to dynlink it in the
 configuration file before {{{ Eliom }}}).
 There are currently two implementations of {{{ Ocsipersist }}}:
-{{{ ocsipersist-dbm.cma }}} (uses the DBM database) and
-{{{ ocsipersist-sqlite.cma }}} (uses the SQLite database,
-and depends on {{{ sqlite3.cma }}}).
+{{{ ocsipersist-dbm.cma }}} (uses the DBM database);
+{{{ ocsipersist-sqlite.cma }}} (uses the SQLite database
+and depends on {{{ sqlite3.cma }}});
+{{{ ocsipersist-pgsql.cma }}} (uses the PostgreSQL (version >= 9.5)
+database and depends on {{{ pa_pgsql.cma }}});
 >>
 
 It is possible to customize the location of the database on the 
@@ -31,3 +33,20 @@ name of the {{{ocsidbm}}} process you want to use:
       <ocsidbm name="_EXTRALIBDIR_/ocsidbm"/>
     </extension>
 }}}
+PostgreSQL has more options to specify how to connect to the database.
+Note that the ocsipersist-database under the specified name (default:
+"ocsipersist") needs to exist. To create it run {{{psql}}} and execute
+{{{CREATE TABLE ocsipersist;}}}.
+{{{
+    <extension findlib-package="ocsigenserver.ext.ocsipersist-pgsql">
+      <database <!-- optional, as each of the following attributes are -->
+        host="localhost"
+        port="3000"
+        user="Aerobic Respirator"
+        password="Guess what I need!"
+        database="ocsipersist" <!-- this is the default value if not specified -->
+        unix_domain_socket_dir="./udsd"
+        size_conn_pool="16" <!-- this is the default value; number of DB connections -->
+      />
+    </extension>
+}}}

opam

@@ -9,7 +9,7 @@ dev-repo: "https://github.com/ocsigen/ocsigenserver.git"
 license: "LGPL-2.1 with OCaml linking exception"
 build: [
   ["sh" "configure" "--prefix" "%{prefix}%" "--ocsigen-user" "%{user}%" "--ocsigen-group" "%{group}%" "--commandpipe" "%{lib}%/ocsigenserver/var/run/ocsigenserver_command" "--logdir" "%{lib}%/ocsigenserver/var/log/ocsigenserver" "--mandir" "%{man}%/man1" "--docdir" "%{lib}%/ocsigenserver/share/doc/ocsigenserver" "--commandpipe" "%{lib}%/ocsigenserver/var/run/ocsigenserver_command" "--staticpagesdir" "%{lib}%/ocsigenserver/var/www" "--datadir" "%{lib}%/ocsigenserver/var/lib/ocsigenserver" "--sysconfdir" "%{lib}%/ocsigenserver/etc/ocsigenserver"]
-  [make]
+  [make "-j%{jobs}%" ]
 ]
 install: [make "install"]
 remove: [
@@ -30,6 +30,7 @@ depends: [
   "tyxml" {> "3.6.0"}
   "dbm"
   "sqlite3"
+  "pgocaml" {>= "2.2"}
   "ipaddr" {>= "2.1"}
   "camlp4"
 ]

src/Makefile.filelist

@@ -82,6 +82,10 @@ ifeq "$(OCSIPERSISTSQLITE)" "YES"
 PLUGINS_IMPL += extensions/ocsipersist-sqlite.cma
 endif
 
+ifeq "$(OCSIPERSISTPGSQL)" "YES"
+PLUGINS_IMPL += extensions/ocsipersist-pgsql.cma
+endif
+
 ifeq "$(OCSIPERSISTDBM)" "YES"
 PLUGINS_IMPL += extensions/ocsipersist-dbm.cma
 PLUGINS_BIN += extensions/ocsipersist-dbm/ocsidbm

src/extensions/Makefile

@@ -46,6 +46,14 @@ ifeq "$(NATDYNLINK)" "YES"
 opt:: ${FILES:.ml=.cmxs}
 endif
 
+### PostgreSQL ###
+
+ifeq "$(OCSIPERSISTPGSQL)" "YES"
+byte::
+	$(MAKE) -C ocsipersist-pgsql byte
+opt::
+	$(MAKE) -C ocsipersist-pgsql opt
+endif
 ### SQLite ###
 
 ifeq "$(OCSIPERSISTSQLITE)" "YES"
@@ -80,20 +88,24 @@ endif
 clean: clean.local
 	${MAKE} -C ocsipersist-dbm clean
 	${MAKE} -C ocsipersist-sqlite clean
+	${MAKE} -C ocsipersist-pgsql clean
 clean.local:
 	-rm -f *.cm* *.o *.a *.annot
 	-rm -f ${PREDEP}
 distclean: clean.local
 	-rm -f *~ \#* .\#*
 	${MAKE} -C ocsipersist-dbm distclean
 	${MAKE} -C ocsipersist-sqlite distclean
+	${MAKE} -C ocsipersist-pgsql distclean
+	-rm -f .depend
 
 ## Dependencies
 
 depend: ${PREDEP}
 	$(OCAMLDEP) ${LIBS} *.mli *.ml > .depend
 	${MAKE} -C ocsipersist-dbm depend
 	${MAKE} -C ocsipersist-sqlite depend
+	${MAKE} -C ocsipersist-pgsql depend
 
 FORCE:
 -include .depend

src/extensions/ocsipersist-dbm/Makefile

@@ -71,6 +71,7 @@ clean:
 	-rm -f ocsidbm ocsidbm.opt
 distclean: clean
 	-rm -f *~ \#* .\#*
+	-rm -f .depend
 
 ## Dependencies
 

src/extensions/ocsipersist-dbm/ocsipersist.ml

@@ -237,7 +237,7 @@ let db_length store =
 (** Type of persistent data *)
 type 'a t = store * string
 
-let open_store name : store = name
+let open_store name = Lwt.return name
 
 let make_persistent_lazy_lwt ~store ~name ~default =
   let pvname = (store, name) in
@@ -270,7 +270,7 @@ let set pvname v =
 (** Type of persistent tables *)
 type 'value table = string
 
-let open_table name = name
+let open_table name = Lwt.return name
 
 let table_name n = Lwt.return n
 

src/extensions/ocsipersist-pgsql/Makefile

@@ -0,0 +1,69 @@
+include ../../../Makefile.config
+
+PACKAGE  := tyxml.parser pgocaml.syntax lwt.syntax
+
+LIBS     := -I ../../baselib -I ../../http -I ../../server \
+	    ${addprefix -package ,${PACKAGE}}
+OCAMLC   := $(OCAMLFIND) ocamlc${BYTEDBG} ${THREAD}
+OCAMLOPT := $(OCAMLFIND) ocamlopt ${OPTDBG} ${THREAD}
+OCAMLDOC := $(OCAMLFIND) ocamldoc
+OCAMLDEP := $(OCAMLFIND) ocamldep
+
+all: byte opt
+
+###
+
+byte: ocsipersist-pgsql.cma
+opt:: ocsipersist-pgsql.cmxa
+ifeq "$(NATDYNLINK)" "YES"
+opt:: ocsipersist-pgsql.cmxs
+endif
+
+PREDEP := ocsipersist.mli
+
+ocsipersist-pgsql.cma: ocsipersist.cmo
+	$(OCAMLC) -a -o $@ $^
+	cp ocsipersist.cmi ..
+	cp $@ ..
+
+ocsipersist-pgsql.cmxa: ocsipersist.cmx
+	$(OCAMLOPT) -a -o $@ $^
+	cp ocsipersist.cmi ..
+	cp $@ ${patsubst %.cmxa,%.a,$@} ..
+
+ocsipersist-pgsql.cmxs: ocsipersist-pgsql.cmxa
+	$(OCAMLOPT) -shared -linkall -o $@ $^
+	cp $@ ..
+
+ocsipersist.mli:
+	ln -s ../ocsipersist.mli .
+
+##########
+
+SYNTAX_FLAGS=-syntax camlp4o
+
+%.cmi: %.mli
+	$(OCAMLC) ${LIBS} -c $<
+%.cmo: %.ml
+	$(OCAMLC) ${LIBS} ${SYNTAX_FLAGS} -c $<
+%.cmx: %.ml
+	$(OCAMLOPT) ${LIBS} ${SYNTAX_FLAGS} -c $<
+%.cmxs: %.cmxa
+	$(OCAMLOPT) -shared -linkall -o $@ $<
+
+## Clean up
+
+clean:
+	-rm -f *.cm[ioax] *.cmxa *.cmxs *.o *.a *.annot
+	-rm -f ${PREDEP}
+distclean: clean
+	-rm -f *~ \#* .\#*
+	-rm -f .depend
+
+## Dependencies
+
+depend: ${PREDEP}
+	$(OCAMLDEP) ${LIBS} *.mli *.ml > .depend
+
+FORCE:
+-include .depend