components/hmysql/hMysql.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$ *)
  27
  28 type dbd = Mysql.dbd option
  29 type result = Mysql.result option
  30 type error_code =
  31  | OK
  32  | Table_exists_error
  33  | Dup_keyname
  34  | No_such_table
  35  | No_such_index
  36  | Bad_table_error
  37  | GENERIC_ERROR of string
  38 exception Error of string
  39
  40 let profiler = HExtlib.profile "mysql"
  41
  42 let use_real_db () =
  43   not (Helm_registry.get_opt_default Helm_registry.bool
  44     ~default:false "db.nodb")
  45
  46 let quick_connect ?host ?database ?port ?password ?user () =
  47  profiler.HExtlib.profile
  48    (fun () ->
  49      if use_real_db () then
  50        (Some (Mysql.quick_connect ?host ?database ?port ?password ?user ()))
  51      else
  52        None)
  53    ()
  54
  55 let disconnect = function
  56   | None -> ()
  57   | Some dbd -> profiler.HExtlib.profile Mysql.disconnect dbd
  58
  59 let escape s =
  60  profiler.HExtlib.profile Mysql.escape s
  61
  62 let exec dbd s =
  63   match dbd with
  64   | None -> None
  65   | Some dbd ->
  66      try
  67       Some (profiler.HExtlib.profile (Mysql.exec dbd) s)
  68      with Mysql.Error s -> raise (Error s)
  69
  70 let map res ~f =
  71   match res with
  72   | None ->  []
  73   | Some res ->
  74       let map f = Mysql.map res ~f in
  75       profiler.HExtlib.profile map f
  76
  77 let iter res ~f =
  78   match res with
  79   | None ->     ()
  80   | Some res ->
  81       let iter f = Mysql.iter res ~f in
  82       profiler.HExtlib.profile iter f
  83
  84 let errno = function
  85   | None -> GENERIC_ERROR "Mysql.Connection_error"
  86   | Some dbd ->
  87       match Mysql.errno dbd with
  88       | Mysql.No_such_table -> No_such_table
  89       | Mysql.Table_exists_error -> Table_exists_error
  90       | Mysql.Dup_keyname -> Dup_keyname
  91       | Mysql.No_such_index -> No_such_index
  92       | Mysql.Bad_table_error -> Bad_table_error
  93       | _ -> GENERIC_ERROR "Mysql_generic_error"
  94 ;;
  95
  96 let isMysql = true
  97
  98 let escape_string_for_like = ("ESCAPE \"\\\\\"" : ('a,'b,'c,'a) format4);;