1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748
|
(* PG'OCaml is a set of OCaml bindings for the PostgreSQL database.
*
* PG'OCaml - type safe interface to PostgreSQL.
* Copyright (C) 2005-2009 Richard Jones and other authors.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this library; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*)
open Printf
IFDEF USE_BATTERIES THEN
module String = struct
include String
include BatString
end
module Option = BatOption
ELSE
open ExtString
ENDIF
open CalendarLib
module type THREAD = sig
type 'a t
val return : 'a -> 'a t
val (>>=) : 'a t -> ('a -> 'b t) -> 'b t
val fail : exn -> 'a t
type in_channel
type out_channel
val open_connection : Unix.sockaddr -> (in_channel * out_channel) t
val output_char : out_channel -> char -> unit t
val output_binary_int : out_channel -> int -> unit t
val output_string : out_channel -> string -> unit t
val flush : out_channel -> unit t
val input_char : in_channel -> char t
val input_binary_int : in_channel -> int t
val really_input : in_channel -> string -> int -> int -> unit t
val close_in : in_channel -> unit t
end
module type PGOCAML_GENERIC =
sig
type 'a t (** Database handle. *)
type 'a monad
type isolation = [ `Serializable | `Repeatable_read | `Read_committed | `Read_uncommitted ]
type access = [ `Read_write | `Read_only ]
exception Error of string
(** For library errors. *)
exception PostgreSQL_Error of string * (char * string) list
(** For errors generated by the PostgreSQL database back-end. The
* first argument is a printable error message. The second argument
* is the complete set of error fields returned from the back-end.
* See [http://www.postgresql.org/docs/8.1/static/protocol-error-fields.html]
*)
(** {6 Connection management} *)
val connect : ?host:string -> ?port:int -> ?user:string -> ?password:string -> ?database:string -> ?unix_domain_socket_dir:string -> unit -> 'a t monad
(** Connect to the database. The normal [$PGDATABASE], etc. environment
* variables are available.
*)
val close : 'a t -> unit monad
(** Close the database handle. You must call this after you have
* finished with the handle, or else you will get leaked file
* descriptors.
*)
val ping : 'a t -> unit monad
(** Ping the database. If the database is not available, some sort of
* exception will be thrown.
*)
(** {6 Transactions} *)
val begin_work : ?isolation:isolation -> ?access:access -> ?deferrable:bool -> 'a t -> unit monad
(** Start a transaction. *)
val commit : 'a t -> unit monad
(** Perform a COMMIT operation on the database. *)
val rollback : 'a t -> unit monad
(** Perform a ROLLBACK operation on the database. *)
(** {6 Serial column} *)
val serial : 'a t -> string -> int64 monad
(** This is a shorthand for [SELECT CURRVAL(serial)]. For a table
* called [table] with serial column [id] you would typically
* call this as [serial dbh "table_id_seq"] after the previous INSERT
* operation to get the serial number of the inserted row.
*)
val serial4 : 'a t -> string -> int32 monad
(** As {!serial} but assumes that the column is a SERIAL or
* SERIAL4 type.
*)
val serial8 : 'a t -> string -> int64 monad
(** Same as {!serial}.
*)
(** {6 Miscellaneous} *)
val max_message_length : int ref
(** Maximum message length accepted from the back-end. The default
* is [Sys.max_string_length], which means that we will try to read as
* much data from the back-end as we can, and this may cause us to
* run out of memory (particularly on 64 bit machines), causing a
* possible denial of service. You may want to set this to a smaller
* size to avoid this happening.
*)
val verbose : int ref
(** Verbosity. 0 means don't print anything. 1 means print short
* error messages as returned from the back-end. 2 means print all
* messages as returned from the back-end. Messages are printed on [stderr].
* Default verbosity level is 1.
*)
val set_private_data : 'a t -> 'a -> unit
(** Attach some private data to the database handle.
*
* NB. The pa_pgsql camlp4 extension uses this for its own purposes, which
* means that in most programs you will not be able to attach private data
* to the database handle.
*)
val private_data : 'a t -> 'a
(** Retrieve some private data previously attached to the database handle.
* If no data has been attached, raises [Not_found].
*
* NB. The pa_pgsql camlp4 extension uses this for its own purposes, which
* means that in most programs you will not be able to attach private data
* to the database handle.
*)
type pa_pg_data = (string, bool) Hashtbl.t
(** When using pa_pgsql, database handles have type
* [PGOCaml.pa_pg_data PGOCaml.t]
*)
(** {6 Low level query interface - DO NOT USE DIRECTLY} *)
type oid = int32
type param = string option (** None is NULL. *)
type result = string option (** None is NULL. *)
type row = result list (** One row is a list of fields. *)
val prepare : 'a t -> query:string -> ?name:string -> ?types:oid list -> unit -> unit monad
(** [prepare conn ~query ?name ?types ()] prepares the statement [query]
* and optionally names it [name] and sets the parameter types to [types].
* If no name is given, then the "unnamed" statement is overwritten. If
* no types are given, then the PostgreSQL engine infers types.
* Synchronously checks for errors.
*)
val execute_rev : 'a t -> ?name:string -> ?portal:string -> params:param list -> unit -> row list monad
val execute : 'a t -> ?name:string -> ?portal:string -> params:param list -> unit -> row list monad
(** [execute conn ?name ~params ()] executes the named or unnamed
* statement [name], with the given parameters [params],
* returning the result rows (if any).
*
* There are several steps involved at the protocol layer:
* (1) a "portal" is created from the statement, binding the
* parameters in the statement (Bind).
* (2) the portal is executed (Execute).
* (3) we synchronise the connection (Sync).
*
* The optional [?portal] parameter may be used to name the portal
* created in step (1) above (otherwise the unnamed portal is used).
* This is only important if you want to call {!PGOCaml.describe_portal}
* to find out the result types.
*)
val cursor : 'a t -> ?name:string -> ?portal:string -> params:param list -> (row -> unit monad) -> unit monad
val close_statement : 'a t -> ?name:string -> unit -> unit monad
(** [close_statement conn ?name ()] closes a prepared statement and frees
* up any resources.
*)
val close_portal : 'a t -> ?portal:string -> unit -> unit monad
(** [close_portal conn ?portal ()] closes a portal and frees up any resources.
*)
type row_description = result_description list
and result_description = {
name : string; (** Field name. *)
table : oid option; (** OID of table. *)
column : int option; (** Column number of field in table. *)
field_type : oid; (** The type of the field. *)
length : int; (** Length of the field. *)
modifier : int32; (** Type modifier. *)
}
type params_description = param_description list
and param_description = {
param_type : oid; (** The type of the parameter. *)
}
val describe_statement : 'a t -> ?name:string -> unit -> (params_description * row_description option) monad
(** [describe_statement conn ?name ()] describes the named or unnamed
* statement's parameter types and result types.
*)
val describe_portal : 'a t -> ?portal:string -> unit -> row_description option monad
(** [describe_portal conn ?portal ()] describes the named or unnamed
* portal's result types.
*)
(** {6 Low level type conversion functions - DO NOT USE DIRECTLY} *)
val name_of_type : ?modifier:int32 -> oid -> string
(** Returns the OCaml equivalent type name to the PostgreSQL type [oid].
* For instance, [name_of_type (Int32.of_int 23)] returns ["int32"] because
* the OID for PostgreSQL's internal [int4] type is [23]. As another
* example, [name_of_type (Int32.of_int 25)] returns ["string"].
*)
type inet = Unix.inet_addr * int
type timestamptz = Calendar.t * Time_Zone.t
type int16 = int
type bytea = string (* XXX *)
type point = float * float
type hstore = (string * string option) list
type bool_array = bool array
type int32_array = int32 array
type int64_array = int64 array
type string_array = string array
type float_array = float array
(** The following conversion functions are used by pa_pgsql to convert
* values in and out of the database.
*)
val string_of_oid : oid -> string
val string_of_bool : bool -> string
val string_of_int : int -> string
val string_of_int16 : int16 -> string
val string_of_int32 : int32 -> string
val string_of_int64 : int64 -> string
val string_of_float : float -> string
val string_of_point : point -> string
val string_of_hstore : hstore -> string
val string_of_inet : inet -> string
val string_of_timestamp : Calendar.t -> string
val string_of_timestamptz : timestamptz -> string
val string_of_date : Date.t -> string
val string_of_time : Time.t -> string
val string_of_interval : Calendar.Period.t -> string
val string_of_bytea : bytea -> string
val string_of_string : string -> string
val string_of_unit : unit -> string
val string_of_bool_array : bool_array -> string
val string_of_int32_array : int32_array -> string
val string_of_int64_array : int64_array -> string
val string_of_string_array : string_array -> string
val string_of_float_array : float_array -> string
val oid_of_string : string -> oid
val bool_of_string : string -> bool
val int_of_string : string -> int
val int16_of_string : string -> int16
val int32_of_string : string -> int32
val int64_of_string : string -> int64
val float_of_string : string -> float
val point_of_string : string -> point
val hstore_of_string : string -> hstore
val inet_of_string : string -> inet
val timestamp_of_string : string -> Calendar.t
val timestamptz_of_string : string -> timestamptz
val date_of_string : string -> Date.t
val time_of_string : string -> Time.t
val interval_of_string : string -> Calendar.Period.t
val bytea_of_string : string -> bytea
val unit_of_string : string -> unit
val bool_array_of_string : string -> bool_array
val int32_array_of_string : string -> int32_array
val int64_array_of_string : string -> int64_array
val string_array_of_string : string -> string_array
val float_array_of_string : string -> float_array
val bind : 'a monad -> ('a -> 'b monad) -> 'b monad
val return : 'a -> 'a monad
end
module Make (Thread : THREAD) = struct
open Thread
type 'a t = {
ichan : in_channel; (* In_channel wrapping socket. *)
chan : out_channel; (* Out_channel wrapping socket. *)
mutable private_data : 'a option;
uuid : string; (* UUID for this connection. *)
}
type 'a monad = 'a Thread.t
type isolation = [ `Serializable | `Repeatable_read | `Read_committed | `Read_uncommitted ]
type access = [ `Read_write | `Read_only ]
exception Error of string
exception PostgreSQL_Error of string * (char * string) list
(* If true, emit a lot of debugging information about the protocol on stderr.*)
let debug_protocol = false
(*----- Code to generate messages for the back-end. -----*)
let new_message typ =
let buf = Buffer.create 128 in
buf, Some typ
(* StartUpMessage and SSLRequest are special messages which don't
* have a type byte field.
*)
let new_start_message () =
let buf = Buffer.create 128 in
buf, None
let add_byte (buf, _) i =
(* Deliberately throw an exception if i isn't [0..255]. *)
Buffer.add_char buf (Char.chr i)
let add_char (buf, _) c =
Buffer.add_char buf c
let add_int16 (buf, _) i =
if i < 0 || i > 65_535 then
raise (Error "PGOCaml: int16 is outside range [0..65535].");
Buffer.add_char buf (Char.unsafe_chr ((i lsr 8) land 0xff));
Buffer.add_char buf (Char.unsafe_chr (i land 0xff))
let add_int32 (buf, _) i =
let base = Int32.to_int i in
let big = Int32.to_int (Int32.shift_right_logical i 24) in
Buffer.add_char buf (Char.unsafe_chr (big land 0xff));
Buffer.add_char buf (Char.unsafe_chr ((base lsr 16) land 0xff));
Buffer.add_char buf (Char.unsafe_chr ((base lsr 8) land 0xff));
Buffer.add_char buf (Char.unsafe_chr (base land 0xff))
let add_int64 msg i =
add_int32 msg (Int64.to_int32 (Int64.shift_right_logical i 32));
add_int32 msg (Int64.to_int32 i)
let add_string_no_trailing_nil (buf, _) str =
(* Check the string doesn't contain '\0' characters. *)
if String.contains str '\000' then
raise (Error (sprintf "PGOCaml: string contains ASCII NIL character: %S" str));
if String.length str > 0x3fff_ffff then
raise (Error "PGOCaml: string is too long.");
Buffer.add_string buf str
let add_string msg str =
add_string_no_trailing_nil msg str;
add_byte msg 0
let send_message { chan = chan } (buf, typ) =
(* Get the length in bytes. *)
let len = 4 + Buffer.length buf in
(* If the length is longer than a 31 bit integer, then the message is
* too long to send. This limits messages to 1 GB, which should be
* enough for anyone :-)
*)
if Int64.of_int len >= 0x4000_0000L then
raise (Error "PGOCaml: message is larger than 1 GB");
if debug_protocol then
eprintf "> %s%d %S\n%!"
(match typ with
| None -> ""
| Some c -> sprintf "%c " c)
len (Buffer.contents buf);
(* Write the type byte? *)
(match typ with
| None -> Thread.return ()
| Some c -> output_char chan c
) >>= fun () ->
(* Write the length field. *)
output_binary_int chan len >>= fun () ->
(* Write the buffer. *)
output_string chan (Buffer.contents buf)
(* Max message length accepted from back-end. *)
let max_message_length = ref Sys.max_string_length
(* Receive a single result message. Parse out the message type,
* message length, and binary message content.
*)
let receive_message { ichan = ichan; chan = chan } =
(* Flush output buffer. *)
flush chan >>= fun () ->
input_char ichan >>= fun typ ->
input_binary_int ichan >>= fun len ->
(* Discount the length word itself. *)
let len = len - 4 in
(* If the message is too long, give up now. *)
if len > !max_message_length then (
(* Skip the message so we stay in synch with the stream. *)
let bufsize = 65_536 in
let buf = String.create bufsize in
let rec loop n =
if n > 0 then begin
let m = min n bufsize in
really_input ichan buf 0 m >>= fun () ->
loop (n - m)
end else
return ()
in
loop len >>= fun () ->
fail (Error
"PGOCaml: back-end message is longer than max_message_length")
) else (
(* Read the binary message content. *)
let msg = String.create len in
really_input ichan msg 0 len >>= fun () ->
return (typ, msg)
)
(* Send a message and expect a single result. *)
let send_recv conn msg =
send_message conn msg >>= fun () ->
receive_message conn
(* Parse a back-end message. *)
type msg_t =
| AuthenticationOk
| AuthenticationKerberosV5
| AuthenticationCleartextPassword
| AuthenticationCryptPassword of string
| AuthenticationMD5Password of string
| AuthenticationSCMCredential
| BackendKeyData of int32 * int32
| BindComplete
| CloseComplete
| CommandComplete of string
| DataRow of (int * string) list
| EmptyQueryResponse
| ErrorResponse of (char * string) list
| NoData
| NoticeResponse of (char * string) list
| ParameterDescription of int32 list
| ParameterStatus of string * string
| ParseComplete
| ReadyForQuery of char
| RowDescription of (string * int32 * int * int32 * int * int32 * int) list
| UnknownMessage of char * string
let string_of_msg_t = function
| AuthenticationOk -> "AuthenticationOk"
| AuthenticationKerberosV5 -> "AuthenticationKerberosV5"
| AuthenticationCleartextPassword -> "AuthenticationCleartextPassword"
| AuthenticationCryptPassword str ->
sprintf "AuthenticationCleartextPassword %S" str
| AuthenticationMD5Password str ->
sprintf "AuthenticationMD5Password %S" str
| AuthenticationSCMCredential -> "AuthenticationMD5Password"
| BackendKeyData (i1, i2) ->
sprintf "BackendKeyData %ld, %ld" i1 i2
| BindComplete -> "BindComplete"
| CloseComplete -> "CloseComplete"
| CommandComplete str ->
sprintf "CommandComplete %S" str
| DataRow fields ->
sprintf "DataRow [%s]"
(String.concat "; "
(List.map (fun (len, bytes) -> sprintf "%d, %S" len bytes) fields))
| EmptyQueryResponse -> "EmptyQueryResponse"
| ErrorResponse strs ->
sprintf "ErrorResponse [%s]"
(String.concat "; "
(List.map (fun (k, v) -> sprintf "%c, %S" k v) strs))
| NoData -> "NoData"
| NoticeResponse strs ->
sprintf "NoticeResponse [%s]"
(String.concat "; "
(List.map (fun (k, v) -> sprintf "%c, %S" k v) strs))
| ParameterDescription fields ->
sprintf "ParameterDescription [%s]"
(String.concat "; "
(List.map (fun oid -> sprintf "%ld" oid) fields))
| ParameterStatus (s1, s2) ->
sprintf "ParameterStatus %S, %S" s1 s2
| ParseComplete -> "ParseComplete"
| ReadyForQuery c ->
sprintf "ReadyForQuery %s"
(match c with
| 'I' -> "Idle"
| 'T' -> "inTransaction"
| 'E' -> "Error"
| c -> sprintf "unknown(%c)" c)
| RowDescription fields ->
sprintf "RowDescription [%s]"
(String.concat "; "
(List.map (fun (name, table, col, oid, len, modifier, format) ->
sprintf "%s %ld %d %ld %d %ld %d"
name table col oid len modifier format) fields))
| UnknownMessage (typ, msg) ->
sprintf "UnknownMessage %c, %S" typ msg
let parse_backend_message (typ, msg) =
let pos = ref 0 in
let len = String.length msg in
(* Functions to grab the next object from the string 'msg'. *)
let get_char where =
if !pos < len then (
let r = msg.[!pos] in
incr pos;
r
) else
raise (Error ("PGOCaml: parse_backend_message: " ^ where ^
": short message"))
in
let get_byte where = Char.code (get_char where) in
let get_int16 () =
let r0 = get_byte "get_int16" in
let r1 = get_byte "get_int16" in
(r0 lsr 8) + r1
in
let get_int32 () =
let r0 = get_byte "get_int32" in
let r1 = get_byte "get_int32" in
let r2 = get_byte "get_int32" in
let r3 = get_byte "get_int32" in
let r = Int32.of_int r0 in
let r = Int32.shift_left r 8 in
let r = Int32.logor r (Int32.of_int r1) in
let r = Int32.shift_left r 8 in
let r = Int32.logor r (Int32.of_int r2) in
let r = Int32.shift_left r 8 in
let r = Int32.logor r (Int32.of_int r3) in
r
in
(*let get_int64 () =
let r0 = get_byte "get_int64" in
let r1 = get_byte "get_int64" in
let r2 = get_byte "get_int64" in
let r3 = get_byte "get_int64" in
let r4 = get_byte "get_int64" in
let r5 = get_byte "get_int64" in
let r6 = get_byte "get_int64" in
let r7 = get_byte "get_int64" in
let r = Int64.of_int r0 in
let r = Int64.shift_left r 8 in
let r = Int64.logor r (Int64.of_int r1) in
let r = Int64.shift_left r 8 in
let r = Int64.logor r (Int64.of_int r2) in
let r = Int64.shift_left r 8 in
let r = Int64.logor r (Int64.of_int r3) in
let r = Int64.shift_left r 8 in
let r = Int64.logor r (Int64.of_int r4) in
let r = Int64.shift_left r 8 in
let r = Int64.logor r (Int64.of_int r5) in
let r = Int64.shift_left r 8 in
let r = Int64.logor r (Int64.of_int r6) in
let r = Int64.shift_left r 8 in
let r = Int64.logor r (Int64.of_int r7) in
r
in*)
let get_string () =
let buf = Buffer.create 16 in
let rec loop () =
let c = get_char "get_string" in
if c <> '\000' then (
Buffer.add_char buf c;
loop ()
) else
Buffer.contents buf
in
loop ()
in
let get_n_bytes n =
let str = String.create n in
for i = 0 to n-1 do
str.[i] <- get_char "get_n_bytes"
done;
str
in
let get_char () = get_char "get_char" in
(*let get_byte () = get_byte "get_byte" in*)
let msg =
match typ with
| 'R' ->
let t = get_int32 () in
(match t with
| 0l -> AuthenticationOk
| 2l -> AuthenticationKerberosV5
| 3l -> AuthenticationCleartextPassword
| 4l ->
let salt = String.create 2 in
for i = 0 to 2 do
salt.[i] <- get_char ()
done;
AuthenticationCryptPassword salt
| 5l ->
let salt = String.create 4 in
for i = 0 to 3 do
salt.[i] <- get_char ()
done;
AuthenticationMD5Password salt
| 6l -> AuthenticationSCMCredential
| _ -> UnknownMessage (typ, msg)
);
| 'E' ->
let strs = ref [] in
let rec loop () =
let field_type = get_char () in
if field_type = '\000' then List.rev !strs (* end of list *)
else (
strs := (field_type, get_string ()) :: !strs;
loop ()
)
in
ErrorResponse (loop ())
| 'N' ->
let strs = ref [] in
let rec loop () =
let field_type = get_char () in
if field_type = '\000' then List.rev !strs (* end of list *)
else (
strs := (field_type, get_string ()) :: !strs;
loop ()
)
in
NoticeResponse (loop ())
| 'Z' ->
let c = get_char () in
ReadyForQuery c
| 'K' ->
let pid = get_int32 () in
let key = get_int32 () in
BackendKeyData (pid, key)
| 'S' ->
let param = get_string () in
let value = get_string () in
ParameterStatus (param, value)
| '1' -> ParseComplete
| '2' -> BindComplete
| '3' -> CloseComplete
| 'C' ->
let str = get_string () in
CommandComplete str
| 'D' ->
let nr_fields = get_int16 () in
let fields = ref [] in
for i = 0 to nr_fields-1 do
let len = get_int32 () in
let field =
if len < 0l then (-1, "")
else (
if len >= 0x4000_0000l then
raise (Error "PGOCaml: result field is too long");
let len = Int32.to_int len in
if len > Sys.max_string_length then
raise (Error "PGOCaml: result field is too wide for string");
let bytes = get_n_bytes len in
len, bytes
) in
fields := field :: !fields
done;
DataRow (List.rev !fields)
| 'I' -> EmptyQueryResponse
| 'n' -> NoData
| 'T' ->
let nr_fields = get_int16 () in
let fields = ref [] in
for i = 0 to nr_fields-1 do
let name = get_string () in
let table = get_int32 () in
let column = get_int16 () in
let oid = get_int32 () in
let length = get_int16 () in
let modifier = get_int32 () in
let format = get_int16 () in
fields := (name, table, column, oid, length, modifier, format)
:: !fields
done;
RowDescription (List.rev !fields)
| 't' ->
let nr_fields = get_int16 () in
let fields = ref [] in
for i = 0 to nr_fields - 1 do
let oid = get_int32 () in
fields := oid :: !fields
done;
ParameterDescription (List.rev !fields)
| _ -> UnknownMessage (typ, msg) in
if debug_protocol then eprintf "< %s\n%!" (string_of_msg_t msg);
msg
let verbose = ref 1
(* Print an ErrorResponse on stderr. *)
let print_ErrorResponse fields =
if !verbose >= 1 then (
try
let severity = List.assoc 'S' fields in
let code = List.assoc 'C' fields in
let message = List.assoc 'M' fields in
if !verbose = 1 then
match severity with
| "ERROR" | "FATAL" | "PANIC" ->
eprintf "%s: %s: %s\n%!" severity code message
| _ -> ()
else
eprintf "%s: %s: %s\n%!" severity code message
with
Not_found ->
eprintf
"WARNING: 'Always present' field is missing in error message\n%!"
);
if !verbose >= 2 then (
List.iter (
fun (field_type, field) ->
if field_type <> 'S' && field_type <> 'C' && field_type <> 'M' then
eprintf "%c: %s\n%!" field_type field
) fields
)
(* Handle an ErrorResponse anywhere, by printing and raising an exception. *)
let pg_error ?conn fields =
print_ErrorResponse fields;
let str =
try
let severity = List.assoc 'S' fields in
let code = List.assoc 'C' fields in
let message = List.assoc 'M' fields in
sprintf "%s: %s: %s" severity code message
with
Not_found ->
"WARNING: 'Always present' field is missing in error message" in
(* If conn parameter was given, then resynch - read messages until we
* see ReadyForQuery.
*)
(match conn with
| None -> return ()
| Some conn ->
let rec loop () =
receive_message conn >>= fun msg ->
let msg = parse_backend_message msg in
match msg with ReadyForQuery _ -> return () | _ -> loop ()
in
loop ()
) >>= fun () ->
fail (PostgreSQL_Error (str, fields))
(*----- Profiling. -----*)
type 'a retexn = Ret of 'a | Exn of exn
(* profile_op : string -> string -> string list -> (unit -> 'a) -> 'a *)
let profile_op uuid op detail f =
let chan =
try
let filename = Sys.getenv "PGPROFILING" in
let flags = [ Open_wronly; Open_append; Open_creat ] in
let chan = open_out_gen flags 0o644 filename in
Some chan
with
| Not_found
| Sys_error _ -> None in
match chan with
| None -> f () (* No profiling - just run it. *)
| Some chan -> (* Profiling. *)
let start_time = Unix.gettimeofday () in
let ret = try Ret (f ()) with exn -> Exn exn in
let end_time = Unix.gettimeofday () in
let elapsed_time_ms = int_of_float (1000. *. (end_time -. start_time)) in
let row = [
"1"; (* Version number. *)
uuid;
op;
string_of_int elapsed_time_ms;
match ret with
| Ret _ -> "ok"
| Exn exn -> Printexc.to_string exn
] @ detail in
(* Lock the output channel while we write the row, to prevent
* corruption from multiple writers.
*)
let fd = Unix.descr_of_out_channel chan in
Unix.lockf fd Unix.F_LOCK 0;
Csv.save_out chan [row];
close_out chan;
(* Return result or re-raise the exception. *)
match ret with
| Ret r -> r
| Exn exn -> raise exn
(*----- Connection. -----*)
let connect ?host ?port ?user ?password ?database
?(unix_domain_socket_dir = PGOCaml_config.default_unix_domain_socket_dir)
() =
(* Get the username. *)
let user =
match user with
| Some user -> user
| None ->
try Sys.getenv "PGUSER"
with Not_found ->
try
let pw = Unix.getpwuid (Unix.geteuid ()) in
pw.Unix.pw_name
with
Not_found -> "postgres" in
(* Get the password. *)
let password =
match password with
| Some password -> password
| None ->
try Sys.getenv "PGPASSWORD"
with Not_found -> "" in
(* Get the database name. *)
let database =
match database with
| Some database -> database
| None ->
try Sys.getenv "PGDATABASE"
with Not_found -> user in
(* Hostname and port number. *)
let host =
match host with
| Some _ -> host
| None ->
try Some (Sys.getenv "PGHOST")
with Not_found -> None in (* use Unix domain socket. *)
let port =
match port with
| Some port -> port
| None ->
try int_of_string (Sys.getenv "PGPORT")
with Not_found | Failure "int_of_string" -> 5432 in
(* Make the socket address. *)
let sockaddr =
match host with
| Some hostname ->
(try
let hostent = Unix.gethostbyname hostname in
let domain = hostent.Unix.h_addrtype in
match domain with
| Unix.PF_INET | Unix.PF_INET6 ->
(* Choose a random address from the list. *)
let addrs = hostent.Unix.h_addr_list in
let len = Array.length addrs in
if len <= 0 then
raise (Error ("PGOCaml: unknown host: " ^ hostname));
let i = Random.int len in
let addr = addrs.(i) in
Unix.ADDR_INET (addr, port)
| Unix.PF_UNIX ->
(* Would we trust a pathname returned through DNS? *)
raise (Error "PGOCaml: DNS returned PF_UNIX record")
with
Not_found ->
raise (Error ("PGOCaml: unknown host: " ^ hostname))
);
| None -> (* Unix domain socket. *)
let sockaddr = sprintf "%s/.s.PGSQL.%d" unix_domain_socket_dir port in
Unix.ADDR_UNIX sockaddr in
(* Create a universally unique identifier for this connection. This
* is mainly for debugging and profiling.
*)
let uuid =
(*
* On Windows, the result of Unix.getpid is largely meaningless (it's not unique)
* and, more importantly, Unix.getppid is not implemented.
*)
let ppid =
try
Unix.getppid ()
with Invalid_argument "Unix.getppid not implemented" -> 0
in
sprintf "%s %d %d %g %s %g"
(Unix.gethostname ())
(Unix.getpid ())
ppid
(Unix.gettimeofday ())
Sys.executable_name
((Unix.times ()).Unix.tms_utime) in
let uuid = Digest.to_hex (Digest.string uuid) in
let do_connect () =
open_connection sockaddr >>= fun (ichan, chan) ->
(* Create the connection structure. *)
let conn = { ichan = ichan;
chan = chan;
private_data = None;
uuid = uuid } in
(* Send the StartUpMessage. NB. At present we do not support SSL. *)
let msg = new_start_message () in
add_int32 msg 196608l;
add_string msg "user"; add_string msg user;
add_string msg "database"; add_string msg database;
add_byte msg 0;
(* Loop around here until the database gives a ReadyForQuery message. *)
let rec loop msg =
(match msg with
| Some msg -> send_recv conn msg
| None -> receive_message conn) >>= fun msg ->
let msg = parse_backend_message msg in
match msg with
| ReadyForQuery _ -> return () (* Finished connecting! *)
| BackendKeyData _ ->
(* XXX We should save this key. *)
loop None
| ParameterStatus _ ->
(* Should we do something with this? *)
loop None
| AuthenticationOk -> loop None
| AuthenticationKerberosV5 ->
fail (Error "PGOCaml: Kerberos authentication not supported")
| AuthenticationCleartextPassword ->
let msg = new_message 'p' in (* PasswordMessage *)
add_string msg password;
loop (Some msg)
| AuthenticationCryptPassword salt ->
(* Crypt password not supported because there is no crypt(3) function
* in OCaml.
*)
fail (Error "PGOCaml: crypt password authentication not supported")
| AuthenticationMD5Password salt ->
(* (* This is a guess at how the salt is used ... *)
let password = salt ^ password in
let password = Digest.string password in*)
let password = "md5" ^ Digest.to_hex (Digest.string (Digest.to_hex (Digest.string (password ^ user)) ^ salt)) in
let msg = new_message 'p' in (* PasswordMessage *)
add_string msg password;
loop (Some msg)
| AuthenticationSCMCredential ->
fail (Error "PGOCaml: SCM Credential authentication not supported")
| ErrorResponse err ->
pg_error ~conn err
| NoticeResponse err ->
(* XXX Do or print something here? *)
loop None
| _ ->
(* Silently ignore unknown or unexpected message types. *)
loop None
in
loop (Some msg) >>= fun () ->
return conn
in
let detail = [
"user"; user;
"database"; database;
"host"; Option.default "unix" host;
"port"; string_of_int port;
"prog"; Sys.executable_name
] in
profile_op uuid "connect" detail do_connect
let close conn =
let do_close () =
(* Be nice and send the terminate message. *)
let msg = new_message 'X' in
send_message conn msg >>= fun () ->
flush conn.chan >>= fun () ->
(* Closes the underlying socket too. *)
close_in conn.ichan
in
profile_op conn.uuid "close" [] do_close
let set_private_data conn data =
conn.private_data <- Some data
let private_data { private_data = private_data } =
match private_data with
| None -> raise Not_found
| Some private_data -> private_data
type pa_pg_data = (string, bool) Hashtbl.t
let ping conn =
let do_ping () =
let msg = new_message 'S' in
send_message conn msg >>= fun () ->
(* Wait for ReadyForQuery. *)
let rec loop () =
receive_message conn >>= fun msg ->
let msg = parse_backend_message msg in
match msg with
| ReadyForQuery _ -> return () (* Finished! *)
| ErrorResponse err -> pg_error ~conn err (* Error *)
| _ -> loop ()
in
loop ()
in
profile_op conn.uuid "ping" [] do_ping
type oid = int32
type param = string option
type result = string option
type row = result list
let flush_msg conn =
let msg = new_message 'H' in
send_message conn msg >>= fun () ->
(* Might as well actually flush the channel too, otherwise what is the
* point of executing this command?
*)
flush conn.chan
let prepare conn ~query ?(name = "") ?(types = []) () =
let do_prepare () =
let msg = new_message 'P' in
add_string msg name;
add_string msg query;
add_int16 msg (List.length types);
List.iter (add_int32 msg) types;
send_message conn msg >>= fun () ->
flush_msg conn >>= fun () ->
let rec loop () =
receive_message conn >>= fun msg ->
let msg = parse_backend_message msg in
match msg with
| ErrorResponse err -> pg_error err
| ParseComplete -> return () (* Finished! *)
| NoticeResponse _ ->
(* XXX Do or print something here? *)
loop ()
| _ ->
fail (Error ("PGOCaml: unknown response from parse: " ^
string_of_msg_t msg))
in
loop ()
in
let details = [ "query"; query; "name"; name ] in
profile_op conn.uuid "prepare" details do_prepare
let iter_execute conn name portal params proc () =
(* Bind *)
let msg = new_message 'B' in
add_string msg portal;
add_string msg name;
add_int16 msg 0; (* Send all parameters as text. *)
add_int16 msg (List.length params);
List.iter (
fun param ->
match param with
| None -> add_int32 msg 0xffff_ffffl (* NULL *)
| Some str ->
add_int32 msg (Int32.of_int (String.length str));
add_string_no_trailing_nil msg str
) params;
add_int16 msg 0; (* Send back all results as text. *)
send_message conn msg >>= fun () ->
(* Execute *)
let msg = new_message 'E' in
add_string msg portal;
add_int32 msg 0l; (* no limit on rows *)
send_message conn msg >>= fun () ->
(* Sync *)
let msg = new_message 'S' in
send_message conn msg >>= fun () ->
(* Process the message(s) received from the database until we read
* ReadyForQuery. In the process we may get some rows back from
* the database, no data, or an error.
*)
let rec loop () =
(* NB: receive_message flushes the output connection. *)
receive_message conn >>= fun msg ->
let msg = parse_backend_message msg in
match msg with
| ReadyForQuery _ -> return () (* Finished! *)
| ErrorResponse err -> pg_error ~conn err (* Error *)
| NoticeResponse err ->
(* XXX Do or print something here? *)
loop ()
| BindComplete -> loop ()
| CommandComplete _ -> loop ()
| EmptyQueryResponse -> loop ()
| DataRow fields ->
let fields = List.map (
function
| (i, _) when i < 0 -> None (* NULL *)
| (0, _) -> Some ""
| (i, bytes) -> Some bytes
) fields in
proc fields >>= loop
| NoData -> loop ()
| ParameterStatus _ ->
(* 43.2.6: ParameterStatus messages will be generated whenever
* the active value changes for any of the parameters the backend
* believes the frontend should know about. Most commonly this
* occurs in response to a SET SQL command executed by the
* frontend, and this case is effectively synchronous -- but it
* is also possible for parameter status changes to occur because
* the administrator changed a configuration file and then sent
* the SIGHUP signal to the postmaster.
*)
loop ()
| _ ->
fail
(Error ("PGOCaml: unknown response message: " ^
string_of_msg_t msg))
in
loop ()
let do_execute conn name portal params rev () =
let rows = ref [] in
iter_execute conn name portal params
(fun fields -> return (rows := fields :: !rows)) () >>= fun () ->
(* Return the result rows. *)
return (if rev then List.rev !rows else !rows)
let execute_rev conn ?(name = "") ?(portal = "") ~params () =
let do_execute = do_execute conn name portal params false in
let details = [ "name"; name; "portal"; portal ] in
profile_op conn.uuid "execute" details do_execute
let execute conn ?(name = "") ?(portal = "") ~params () =
let do_execute = do_execute conn name portal params true in
let details = [ "name"; name; "portal"; portal ] in
profile_op conn.uuid "execute" details do_execute
let cursor conn ?(name = "") ?(portal = "") ~params proc =
let do_execute = iter_execute conn name portal params proc in
let details = [ "name"; name; "portal"; portal ] in
profile_op conn.uuid "cursor" details do_execute
let begin_work ?isolation ?access ?deferrable conn =
let isolation_str = match isolation with
| None -> ""
| Some x -> " isolation level " ^ (match x with
| `Serializable -> "serializable"
| `Repeatable_read -> "repeatable read"
| `Read_committed -> "read committed"
| `Read_uncommitted -> "read uncommitted")
and access_str = match access with
| None -> ""
| Some x -> match x with
| `Read_write -> " read write"
| `Read_only -> " read only"
and deferrable_str = match deferrable with
| None -> ""
| Some x -> (match x with true -> "" | false -> " not") ^ " deferrable" in
let query = "begin work" ^ isolation_str ^ access_str ^ deferrable_str in
prepare conn ~query () >>= fun () ->
execute conn ~params:[] () >>= fun _ ->
return ()
let commit conn =
let query = "commit" in
prepare conn ~query () >>= fun () ->
execute conn ~params:[] () >>= fun _ ->
return ()
let rollback conn =
let query = "rollback" in
prepare conn ~query () >>= fun () ->
execute conn ~params:[] () >>= fun _ ->
return ()
let serial conn name =
let query = "select currval ($1)" in
prepare conn ~query () >>= fun () ->
execute conn ~params:[Some name] () >>= fun rows ->
let row = List.hd rows in
let result = List.hd row in
(* NB. According to the manual, the return type of currval is
* always a bigint, whether or not the column is serial or bigserial.
*)
return (Int64.of_string (Option.get result))
let serial4 conn name =
serial conn name >>= fun s -> return (Int64.to_int32 s)
let serial8 = serial
let close_statement conn ?(name = "") () =
let msg = new_message 'C' in
add_char msg 'S';
add_string msg name;
send_message conn msg >>= fun () ->
flush_msg conn >>= fun () ->
let rec loop () =
receive_message conn >>= fun msg ->
let msg = parse_backend_message msg in
match msg with
| ErrorResponse err -> pg_error err
| CloseComplete -> return () (* Finished! *)
| NoticeResponse _ ->
(* XXX Do or print something here? *)
loop ()
| _ ->
fail (Error ("PGOCaml: unknown response from close: " ^
string_of_msg_t msg))
in
loop ()
let close_portal conn ?(portal = "") () =
let msg = new_message 'C' in
add_char msg 'P';
add_string msg portal;
send_message conn msg >>= fun () ->
flush_msg conn >>= fun () ->
let rec loop () =
receive_message conn >>= fun msg ->
let msg = parse_backend_message msg in
match msg with
| ErrorResponse err -> pg_error err
| CloseComplete -> return ()
| NoticeResponse _ ->
(* XXX Do or print something here? *)
loop ()
| _ ->
fail (Error ("PGOCaml: unknown response from close: " ^
string_of_msg_t msg))
in
loop ()
type row_description = result_description list
and result_description = {
name : string;
table : oid option;
column : int option;
field_type : oid;
length : int;
modifier : int32;
}
type params_description = param_description list
and param_description = {
param_type : oid;
}
let describe_statement conn ?(name = "") () =
let msg = new_message 'D' in
add_char msg 'S';
add_string msg name;
send_message conn msg >>= fun () ->
flush_msg conn >>= fun () ->
receive_message conn >>= fun msg ->
let msg = parse_backend_message msg in
( match msg with
| ErrorResponse err -> pg_error err
| ParameterDescription params ->
let params = List.map (
fun oid ->
{ param_type = oid }
) params in
return params
| _ ->
fail (Error ("PGOCaml: unknown response from describe: " ^
string_of_msg_t msg))) >>= fun params ->
receive_message conn >>= fun msg ->
let msg = parse_backend_message msg in
match msg with
| ErrorResponse err -> pg_error err
| NoData -> return (params, None)
| RowDescription fields ->
let fields = List.map (
fun (name, table, column, oid, length, modifier, _) ->
{
name = name;
table = if table = 0l then None else Some table;
column = if column = 0 then None else Some column;
field_type = oid;
length = length;
modifier = modifier;
}
) fields in
return (params, Some fields)
| _ ->
fail (Error ("PGOCaml: unknown response from describe: " ^
string_of_msg_t msg))
let describe_portal conn ?(portal = "") () =
let msg = new_message 'D' in
add_char msg 'P';
add_string msg portal;
send_message conn msg >>= fun () ->
flush_msg conn >>= fun () ->
receive_message conn >>= fun msg ->
let msg = parse_backend_message msg in
match msg with
| ErrorResponse err -> pg_error err
| NoData -> return None
| RowDescription fields ->
let fields = List.map (
fun (name, table, column, oid, length, modifier, _) ->
{
name = name;
table = if table = 0l then None else Some table;
column = if column = 0 then None else Some column;
field_type = oid;
length = length;
modifier = modifier;
}
) fields in
return (Some fields)
| _ ->
fail (Error ("PGOCaml: unknown response from describe: " ^
string_of_msg_t msg))
(*----- Type conversion. -----*)
(* For certain types, more information is available by looking
* at the modifier field as well as just the OID. For example,
* for NUMERIC the modifier tells us the precision.
* However we don't always have the modifier field available -
* in particular for parameters.
*)
let name_of_type ?modifier = function
| 16_l -> "bool" (* BOOLEAN *)
| 17_l -> "bytea" (* BYTEA *)
| 20_l -> "int64" (* INT8 *)
| 21_l -> "int16" (* INT2 *)
| 23_l -> "int32" (* INT4 *)
| 25_l -> "string" (* TEXT *)
| 600_l -> "point" (* POINT *)
| 700_l
| 701_l -> "float" (* FLOAT4, FLOAT8 *)
| 869_l -> "inet" (* INET *)
| 1000_l -> "bool_array" (* BOOLEAN[] *)
| 1007_l -> "int32_array" (* INT4[] *)
| 1009_l -> "string_array" (* TEXT[] *)
| 1016_l -> "int64_array" (* INT8[] *)
| 1021_l
| 1022_l -> "float_array" (* FLOAT4[], FLOAT8[] *)
| 1042_l -> "string" (* CHAR(n) - treat as string *)
| 1043_l -> "string" (* VARCHAR(n) - treat as string *)
| 1082_l -> "date" (* DATE *)
| 1083_l -> "time" (* TIME *)
| 1114_l -> "timestamp" (* TIMESTAMP *)
| 1184_l -> "timestamptz" (* TIMESTAMP WITH TIME ZONE *)
| 1186_l -> "interval" (* INTERVAL *)
| 2278_l -> "unit" (* VOID *)
| 1700_l ->
(* XXX This is wrong - it will be changed to a fixed precision
* numeric type later.
*)
(match modifier with
| None -> "float"
| Some modifier when modifier = -1_l -> "float"
| Some modifier ->
(* XXX *)
eprintf "numeric modifier = %ld\n%!" modifier;
"float"
);
| i ->
(* For unknown types, look at <postgresql/catalog/pg_type.h>. *)
raise (Error ("PGOCaml: unknown type for OID " ^ Int32.to_string i))
type inet = Unix.inet_addr * int
type timestamptz = Calendar.t * Time_Zone.t
type int16 = int
type bytea = string
type point = float * float
type hstore = (string * string option) list
type bool_array = bool array
type int32_array = int32 array
type int64_array = int64 array
type string_array = string array
type float_array = float array
let string_of_hstore hstore =
let string_of_quoted str = "\"" ^ str ^ "\"" in
let string_of_mapping (key, value) =
let key_str = string_of_quoted key
and value_str = match value with
| Some v -> string_of_quoted v
| None -> "NULL"
in key_str ^ "=>" ^ value_str
in String.join ", " (List.map string_of_mapping hstore)
let string_of_inet (addr, mask) =
let hostmask =
if Unix.domain_of_sockaddr (Unix.ADDR_INET(addr, 1)) = Unix.PF_INET6
then 128
else 32
in
let addr = Unix.string_of_inet_addr addr
in
if mask = hostmask
then addr
else if mask >= 0 && mask < hostmask
then addr ^ "/" ^ string_of_int mask
else failwith "string_of_inet"
let string_of_oid = Int32.to_string
let string_of_bool = function
| true -> "t"
| false -> "f"
let string_of_int = Pervasives.string_of_int
let string_of_int16 = Pervasives.string_of_int
let string_of_int32 = Int32.to_string
let string_of_int64 = Int64.to_string
let string_of_float = string_of_float
let string_of_point (x, y) = "(" ^ (string_of_float x) ^ "," ^ (string_of_float y) ^ ")"
let string_of_timestamp = Printer.Calendar.to_string
let string_of_timestamptz (cal, tz) =
Printer.Calendar.to_string cal ^
match tz with
| Time_Zone.UTC -> "+00"
| Time_Zone.Local ->
let gap = Time_Zone.gap Time_Zone.UTC Time_Zone.Local in
if gap >= 0 then sprintf "+%02d" gap
else sprintf "-%02d" (-gap)
| Time_Zone.UTC_Plus gap ->
if gap >= 0 then sprintf "+%02d" gap
else sprintf "-%02d" (-gap)
let string_of_date = Printer.Date.to_string
let string_of_time = Printer.Time.to_string
let string_of_interval p =
let y, m, d, s = Calendar.Period.ymds p in
sprintf "%d years %d mons %d days %d seconds" y m d s
let string_of_unit () = ""
(* NB. It is the responsibility of the caller of this function to
* properly escape array elements.
*)
let string_of_any_array a =
let buf = Buffer.create 128 in
Buffer.add_char buf '{';
for i = 0 to Array.length a - 1 do
if i > 0 then Buffer.add_char buf ',';
Buffer.add_string buf a.(i);
done;
Buffer.add_char buf '}';
Buffer.contents buf
let string_of_bool_array a = string_of_any_array (Array.map string_of_bool a)
let string_of_int32_array a = string_of_any_array (Array.map Int32.to_string a)
let string_of_int64_array a = string_of_any_array (Array.map Int64.to_string a)
let string_of_string_array a = string_of_any_array a
let string_of_float_array a = string_of_any_array (Array.map string_of_float a)
let string_of_bytea b =
let len = String.length b in
let buf = Buffer.create (len * 2) in
for i = 0 to len - 1 do
let c = b.[i] in
let cc = Char.code c in
if cc < 0x20 || cc > 0x7e then
Buffer.add_string buf (sprintf "\\%03o" cc) (* non-print -> \ooo *)
else if c = '\\' then
Buffer.add_string buf "\\\\" (* \ -> \\ *)
else
Buffer.add_char buf c
done;
Buffer.contents buf
let string_of_string (x : string) = x
let oid_of_string = Int32.of_string
let bool_of_string = function
| "true" | "t" -> true
| "false" | "f" -> false
| str ->
raise (Error ("PGOCaml: not a boolean: " ^ str))
let int_of_string = Pervasives.int_of_string
let int16_of_string = Pervasives.int_of_string
let int32_of_string = Int32.of_string
let int64_of_string = Int64.of_string
let float_of_string = float_of_string
let hstore_of_string str =
let expect target stream =
if List.exists (fun c -> c <> Stream.next stream) target
then raise (Error ("PGOCaml: unexpected input in hstore_of_string")) in
let parse_quoted stream =
let rec loop accum stream = match Stream.next stream with
| '"' -> String.implode (List.rev accum)
| '\\' -> loop (Stream.next stream :: accum) stream
| x -> loop (x :: accum) stream in
expect ['"'] stream;
loop [] stream in
let parse_value stream = match Stream.peek stream with
| Some 'N' -> (expect ['N'; 'U'; 'L'; 'L'] stream; None)
| _ -> Some (parse_quoted stream) in
let parse_mapping stream =
let key = parse_quoted stream in
expect ['='; '>'] stream;
let value = parse_value stream in
(key, value) in
let parse_main stream =
let rec loop accum stream =
let mapping = parse_mapping stream in
match Stream.peek stream with
| Some _ -> (expect [','; ' '] stream; loop (mapping :: accum) stream)
| None -> mapping :: accum in
match Stream.peek stream with
| Some _ -> loop [] stream
| None -> [] in
parse_main (Stream.of_string str)
let inet_of_string =
let rex = Pcre.regexp "([^:./]*([:.])[^/]+)(?:/(.+))?"
in
fun str ->
let res = Pcre.extract ~rex ~full_match:false str
in
let addr = Unix.inet_addr_of_string res.(0)
and mask = res.(2)
in
if mask = ""
then (addr, (if res.(1) = "." then 32 else 128))
else (addr, int_of_string mask)
let point_of_string =
let float_pat = "[+-]?[0-9]+.*[0-9]*|[Nn]a[Nn]|[+-]?[Ii]nfinity" in
let point_pat = "\\([ \t]*(" ^ float_pat ^ ")[ \t]*,[ \t]*(" ^ float_pat ^ ")[ \t]*\\)" in
let rex = Pcre.regexp point_pat
in fun str ->
try
let res = Pcre.extract ~rex ~full_match:false str
in ((float_of_string res.(0)), (float_of_string res.(1)))
with
| _ -> failwith "point_of_string"
let date_of_string = Printer.Date.from_string
let time_of_string str =
(* Remove trailing ".microsecs" if present. *)
let n = String.length str in
let str =
if n > 8 && str.[8] = '.' then
String.sub str 0 8
else str in
Printer.Time.from_string str
let timestamp_of_string str =
(* Remove trailing ".microsecs" if present. *)
let n = String.length str in
let str =
if n > 19 && str.[19] = '.' then
String.sub str 0 19
else str in
Printer.Calendar.from_string str
let timestamptz_of_string str =
(* Split into datetime+timestamp. *)
let n = String.length str in
let cal, tz =
if n >= 3 && (str.[n-3] = '+' || str.[n-3] = '-') then
String.sub str 0 (n-3), Some (String.sub str (n-3) 3)
else
str, None in
let cal = timestamp_of_string cal in
let tz = match tz with
| None -> Time_Zone.Local (* best guess? *)
| Some tz ->
let sgn = match tz.[0] with '+' -> 1 | '-' -> 0 | _ -> assert false in
let mag = int_of_string (String.sub tz 1 2) in
Time_Zone.UTC_Plus (sgn * mag) in
cal, tz
let re_interval =
Pcre.regexp ~flags:[`EXTENDED]
("(?:(\\d+)\\syears?)? # years\n"^
"\\s* # \n"^
"(?:(\\d+)\\smons?)? # months\n"^
"\\s* # \n"^
"(?:(\\d+)\\sdays?)? # days\n"^
"\\s* # \n"^
"(?:(\\d\\d):(\\d\\d) # HH:MM\n"^
" (?::(\\d\\d))? # optional :SS\n"^
")?")
let interval_of_string =
let int_opt s = if s = "" then 0 else int_of_string s in
fun str ->
try
let sub = Pcre.extract ~rex:re_interval str in
Calendar.Period.make
(int_opt sub.(1)) (* year *)
(int_opt sub.(2)) (* month *)
(int_opt sub.(3)) (* day *)
(int_opt sub.(4)) (* hour *)
(int_opt sub.(5)) (* min *)
(int_opt sub.(6)) (* sec *)
with
Not_found -> failwith ("interval_of_string: bad interval: " ^ str)
let unit_of_string _ = ()
(* NB. It is the responsibility of the caller of this function to
* properly unescape returned elements.
*)
let any_array_of_string str =
let n = String.length str in
assert (str.[0] = '{');
assert (str.[n-1] = '}');
let str = String.sub str 1 (n-2) in
let fields = String.nsplit str "," in
Array.of_list fields
let bool_array_of_string str = Array.map bool_of_string (any_array_of_string str)
let int32_array_of_string str = Array.map Int32.of_string (any_array_of_string str)
let int64_array_of_string str = Array.map Int64.of_string (any_array_of_string str)
let string_array_of_string str = any_array_of_string str
let float_array_of_string str = Array.map float_of_string (any_array_of_string str)
let is_first_oct_digit c = c >= '0' && c <= '3'
let is_oct_digit c = c >= '0' && c <= '7'
let oct_val c = Char.code c - 0x30
let is_hex_digit = function '0'..'9' | 'a'..'f' | 'A'..'F' -> true | _ -> false
let hex_val c =
let offset = match c with
| '0'..'9' -> 0x30
| 'a'..'f' -> 0x57
| 'A'..'F' -> 0x37
| _ -> failwith "hex_val"
in Char.code c - offset
(* Deserialiser for the new 'hex' format introduced in PostgreSQL 9.0. *)
let bytea_of_string_hex str =
let len = String.length str in
let buf = Buffer.create ((len-2)/2) in
let i = ref 3 in
while !i < len do
let hi_nibble = str.[!i-1] in
let lo_nibble = str.[!i] in
i := !i+2;
if is_hex_digit hi_nibble && is_hex_digit lo_nibble
then begin
let byte = ((hex_val hi_nibble) lsl 4) + (hex_val lo_nibble) in
Buffer.add_char buf (Char.chr byte)
end
done;
Buffer.contents buf
(* Deserialiser for the old 'escape' format used in PostgreSQL < 9.0. *)
let bytea_of_string_escape str =
let len = String.length str in
let buf = Buffer.create len in
let i = ref 0 in
while !i < len do
let c = str.[!i] in
if c = '\\' then (
incr i;
if !i < len && str.[!i] = '\\' then (
Buffer.add_char buf '\\';
incr i
) else if !i+2 < len &&
is_first_oct_digit str.[!i] &&
is_oct_digit str.[!i+1] &&
is_oct_digit str.[!i+2] then (
let byte = oct_val str.[!i] in
incr i;
let byte = (byte lsl 3) + oct_val str.[!i] in
incr i;
let byte = (byte lsl 3) + oct_val str.[!i] in
incr i;
Buffer.add_char buf (Char.chr byte)
)
) else (
incr i;
Buffer.add_char buf c
)
done;
Buffer.contents buf
(* PostgreSQL 9.0 introduced the new 'hex' format for binary data.
We must therefore check whether the data begins with a magic sequence
that identifies this new format and if so call the appropriate parser;
if it doesn't, then we invoke the parser for the old 'escape' format.
*)
let bytea_of_string str =
if String.starts_with str "\\x"
then bytea_of_string_hex str
else bytea_of_string_escape str
let bind = (>>=)
let return = Thread.return
end
|