components/hmysql/hSqlite3.ml

   1 (* Copyright (C) 2005, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://cs.unibo.it/helm/.
  24  *)
  25
  26 (* $Id: hMysql.ml 5769 2006-01-08 18:00:22Z sacerdot $ *)
  27
  28 (*
  29 type result = Mysql.result option
  30 *)
  31
  32 type result = Sqlite3.row list
  33 type dbd = Sqlite3.db option
  34
  35 type error_code =
  36  | OK
  37  | Table_exists_error
  38  | Dup_keyname
  39  | No_such_table
  40  | No_such_index
  41  | Bad_table_error
  42  | GENERIC_ERROR of string
  43
  44 exception Error of string
  45
  46 let prerr_endline s = ()(*HLog.debug s;;*)
  47
  48 let profiler = HExtlib.profile "Sqlite3"
  49
  50 let quick_connect ?host ?(database = "sqlite") ?port ?password ?user () =
  51   let username = Helm_registry.get "user.name" in
  52   let tmp_db_name =
  53     if HExtlib.is_dir "/dev/shm/" && HExtlib.writable_dir "/dev/shm/" then
  54       ((*HLog.debug "using /dev/shm to store the working copy of the db";*)
  55       "/dev/shm/matita.db." ^ username ^ "." ^ string_of_int (Unix.getpid ()))
  56     else
  57       ((*HLog.debug "/dev/shm not available";*)
  58       Helm_registry.get "matita.basedir" ^ "/matita.db." ^ username ^ "." ^
  59         string_of_int (Unix.getpid ()))
  60   in
  61   let db_name = Helm_registry.get "matita.basedir" ^ "/" ^ database ^ ".db" in
  62   let standard_db_name =
  63     Helm_registry.get "matita.rt_base_dir" ^ "/metadata.db"
  64   in
  65   let cp_to_ram_cmd =
  66     if HExtlib.is_regular db_name then
  67       "cp " ^ db_name ^ " " ^ tmp_db_name
  68     else
  69       (* we start from the standard library *)
  70       "cp " ^ standard_db_name ^ " " ^ tmp_db_name
  71   in
  72   ignore (Sys.command cp_to_ram_cmd);
  73   let mv_to_disk_cmd _ =
  74     ignore (Sys.command ("mv " ^ tmp_db_name ^ " " ^ db_name))
  75   in
  76   at_exit mv_to_disk_cmd;
  77   let db = Sqlite3.db_open tmp_db_name in
  78   (* attach the REGEX function *)
  79   Sqlite3.create_fun_2 db "REGEXP"
  80       (fun s rex ->
  81          match rex, s with
  82          | Sqlite3.Data.TEXT rex, Sqlite3.Data.BLOB s
  83          | Sqlite3.Data.TEXT rex, Sqlite3.Data.TEXT s ->
  84              let r = Str.regexp rex in
  85              if Str.string_match r s 0 then
  86                Sqlite3.Data.INT 1L
  87              else
  88                Sqlite3.Data.INT 0L
  89          | _ -> raise (Error "wrong types to 'REGEXP'"));
  90   Some db
  91 ;;
  92
  93 let disconnect db =
  94   match db with
  95   | None -> ()
  96   | Some db ->
  97       let b = Sqlite3.db_close db in
  98       if b=false then prerr_endline "No Closed DataBase"
  99 ;;
 100
 101 (* XXX hack, sqlite has a print "%q" that should be used, but is not bound *)
 102 let escape s = Pcre.replace ~pat:"([^'])'([^'])" ~templ:"$1''$2" s
 103
 104 let string_of_rc = function
 105   |Sqlite3.Rc.OK -> "Sqlite3.Rc.OK"
 106   |Sqlite3.Rc.ERROR -> "Sqlite3.Rc.ERROR"
 107   |Sqlite3.Rc.INTERNAL -> "Sqlite3.Rc.INTERNAL"
 108   |Sqlite3.Rc.PERM -> "Sqlite3.Rc.PERM"
 109   |Sqlite3.Rc.ABORT -> "Sqlite3.Rc.ABORT"
 110   |Sqlite3.Rc.BUSY -> "Sqlite3.Rc.BUSY"
 111   |Sqlite3.Rc.LOCKED -> "Sqlite3.Rc.LOCKED"
 112   |Sqlite3.Rc.NOMEM -> "Sqlite3.Rc.NOMEM"
 113   |Sqlite3.Rc.READONLY -> "Sqlite3.Rc.READONLY"
 114   |Sqlite3.Rc.INTERRUPT -> "Sqlite3.Rc.INTERRUPT"
 115   |Sqlite3.Rc.IOERR -> "Sqlite3.Rc.IOERR"
 116   |Sqlite3.Rc.CORRUPT -> "Sqlite3.Rc.CORRUPT"
 117   |Sqlite3.Rc.NOTFOUND -> "Sqlite3.Rc.NOTFOUND"
 118   |Sqlite3.Rc.FULL -> "Sqlite3.Rc.FULL"
 119   |Sqlite3.Rc.CANTOPEN -> "Sqlite3.Rc.CANTOPEN"
 120   |Sqlite3.Rc.PROTOCOL -> "Sqlite3.Rc.PROTOCOL"
 121   |Sqlite3.Rc.EMPTY -> "Sqlite3.Rc.EMPTY"
 122   |Sqlite3.Rc.SCHEMA -> "Sqlite3.Rc.SCHEMA"
 123   |Sqlite3.Rc.TOOBIG -> "Sqlite3.Rc.TOOBIG"
 124   |Sqlite3.Rc.CONSTRAINT -> "Sqlite3.Rc.CONSTRAINT"
 125   |Sqlite3.Rc.MISMATCH -> "Sqlite3.Rc.MISMATCH"
 126   |Sqlite3.Rc.MISUSE -> "Sqlite3.Rc.MISUSE"
 127   |Sqlite3.Rc.NOFLS -> "Sqlite3.Rc.NOFLS"
 128   |Sqlite3.Rc.AUTH -> "Sqlite3.Rc.AUTH"
 129   |Sqlite3.Rc.FORMAT -> "Sqlite3.Rc.FORMAT"
 130   |Sqlite3.Rc.RANGE -> "Sqlite3.Rc.RANGE"
 131   |Sqlite3.Rc.NOTADB -> "Sqlite3.Rc.NOTADB"
 132   |Sqlite3.Rc.ROW -> "Sqlite3.Rc.ROW"
 133   |Sqlite3.Rc.DONE -> "Sqlite3.Rc.DONE"
 134   |Sqlite3.Rc.UNKNOWN n ->
 135     "Sqlite3.Rc.UNKNOWN " ^ string_of_int (Sqlite3.Rc.int_of_unknown n)
 136 ;;
 137
 138 let pp_rc rc = prerr_endline (string_of_rc rc);;
 139
 140 let exec db s =
 141  prerr_endline s;
 142   let stored_result = ref [] in
 143   let store row =
 144     stored_result := row :: !stored_result
 145   in
 146   match db with
 147   | None -> []
 148   | Some db ->
 149       let rc =
 150         profiler.HExtlib.profile (Sqlite3.exec_no_headers db ~cb:store) s
 151       in
 152       match rc with
 153       | Sqlite3.Rc.OK -> !stored_result
 154       | _ -> raise (Error (string_of_rc rc))
 155 ;;
 156
 157 let rec map res ~f =
 158   let map f = List.map f res in
 159   profiler.HExtlib.profile map f
 160 ;;
 161
 162 let iter res ~f =
 163   let iter f = List.iter f res in
 164   profiler.HExtlib.profile iter f
 165 ;;
 166
 167 let errno = function
 168   | None -> OK
 169   | Some db ->
 170       match Sqlite3.errcode db with
 171       |Sqlite3.Rc.OK -> OK
 172       |Sqlite3.Rc.ERROR ->
 173          let errmsg = (Sqlite3.errmsg db) in
 174          if Pcre.pmatch errmsg ~pat:"^table .* already exists" then
 175            Table_exists_error
 176          else
 177          if Pcre.pmatch errmsg ~pat:"^index .* already exists" then Dup_keyname
 178          else if Pcre.pmatch errmsg ~pat:"^no such table: .*" then No_such_table
 179          else if Pcre.pmatch errmsg ~pat:"^no such index: .*" then No_such_index
 180          else GENERIC_ERROR errmsg
 181       |Sqlite3.Rc.INTERNAL |Sqlite3.Rc.PERM |Sqlite3.Rc.ABORT
 182       |Sqlite3.Rc.BUSY |Sqlite3.Rc.LOCKED |Sqlite3.Rc.NOMEM
 183       |Sqlite3.Rc.READONLY |Sqlite3.Rc.INTERRUPT |Sqlite3.Rc.IOERR
 184       |Sqlite3.Rc.CORRUPT |Sqlite3.Rc.NOTFOUND |Sqlite3.Rc.FULL
 185       |Sqlite3.Rc.CANTOPEN |Sqlite3.Rc.PROTOCOL |Sqlite3.Rc.EMPTY
 186       |Sqlite3.Rc.SCHEMA |Sqlite3.Rc.TOOBIG |Sqlite3.Rc.CONSTRAINT
 187       |Sqlite3.Rc.MISMATCH |Sqlite3.Rc.MISUSE |Sqlite3.Rc.NOFLS
 188       |Sqlite3.Rc.AUTH |Sqlite3.Rc.FORMAT |Sqlite3.Rc.RANGE
 189       |Sqlite3.Rc.NOTADB |Sqlite3.Rc.ROW |Sqlite3.Rc.DONE
 190       |Sqlite3.Rc.UNKNOWN _ -> GENERIC_ERROR "Sqlite3_generic_error"
 191 ;;
 192
 193 let isMysql = false
 194
 195 let escape_string_for_like = ("ESCAPE \"\\\"" : ('a,'b,'c,'a) format4);;