pgleadershipbook
This repository has no backups
This repository's network speed is throttled to 100KB/sec
Upgrade your account to fix these warnings, or use backups.vc for automated backups
@ 2
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 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 |
<?php /** * CodeIgniter * * An open source application development framework for PHP * * This content is released under the MIT License (MIT) * * Copyright (c) 2014-2019 British Columbia Institute of Technology * Copyright (c) 2019-2020 CodeIgniter Foundation * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * * @package CodeIgniter * @author CodeIgniter Dev Team * @copyright 2019-2020 CodeIgniter Foundation * @license https://opensource.org/licenses/MIT MIT License * @link https://codeigniter.com * @since Version 4.0.0 * @filesource */ namespace CodeIgniter\Database; use CodeIgniter\Database\Exceptions\DatabaseException; use CodeIgniter\Events\Events; /** * Class BaseConnection */ abstract class BaseConnection implements ConnectionInterface { /** * Data Source Name / Connect string * * @var string */ protected $DSN; /** * Database port * * @var integer */ protected $port = ''; /** * Hostname * * @var string */ protected $hostname; /** * Username * * @var string */ protected $username; /** * Password * * @var string */ protected $password; /** * Database name * * @var string */ protected $database; /** * Database driver * * @var string */ protected $DBDriver = 'MySQLi'; /** * Sub-driver * * @used-by CI_DB_pdo_driver * @var string */ protected $subdriver; /** * Table prefix * * @var string */ protected $DBPrefix = ''; /** * Persistent connection flag * * @var boolean */ protected $pConnect = false; /** * Debug flag * * Whether to display error messages. * * @var boolean */ protected $DBDebug = false; /** * Should we cache results? * * @var boolean */ protected $cacheOn = false; /** * Path to store cache files. * * @var string */ protected $cacheDir; /** * Character set * * @var string */ protected $charset = 'utf8'; /** * Collation * * @var string */ protected $DBCollat = 'utf8_general_ci'; /** * Swap Prefix * * @var string */ protected $swapPre = ''; /** * Encryption flag/data * * @var mixed */ protected $encrypt = false; /** * Compression flag * * @var boolean */ protected $compress = false; /** * Strict ON flag * * Whether we're running in strict SQL mode. * * @var boolean */ protected $strictOn; /** * Settings for a failover connection. * * @var array */ protected $failover = []; //-------------------------------------------------------------------- /** * The last query object that was executed * on this connection. * * @var array */ protected $lastQuery; /** * Connection ID * * @var object|resource */ public $connID = false; /** * Result ID * * @var object|resource */ public $resultID = false; /** * Protect identifiers flag * * @var boolean */ public $protectIdentifiers = true; /** * List of reserved identifiers * * Identifiers that must NOT be escaped. * * @var array */ protected $reservedIdentifiers = ['*']; /** * Identifier escape character * * @var string */ public $escapeChar = '"'; /** * ESCAPE statement string * * @var string */ public $likeEscapeStr = " ESCAPE '%s' "; /** * ESCAPE character * * @var string */ public $likeEscapeChar = '!'; /** * Holds previously looked up data * for performance reasons. * * @var array */ public $dataCache = []; /** * Microtime when connection was made * * @var float */ protected $connectTime; /** * How long it took to establish connection. * * @var float */ protected $connectDuration; /** * If true, no queries will actually be * ran against the database. * * @var boolean */ protected $pretend = false; /** * Transaction enabled flag * * @var boolean */ public $transEnabled = true; /** * Strict transaction mode flag * * @var boolean */ public $transStrict = true; /** * Transaction depth level * * @var integer */ protected $transDepth = 0; /** * Transaction status flag * * Used with transactions to determine if a rollback should occur. * * @var boolean */ protected $transStatus = true; /** * Transaction failure flag * * Used with transactions to determine if a transaction has failed. * * @var boolean */ protected $transFailure = false; /** * Array of table aliases. * * @var array */ protected $aliasedTables = []; //-------------------------------------------------------------------- /** * Saves our connection settings. * * @param array $params */ public function __construct(array $params) { foreach ($params as $key => $value) { if (property_exists($this, $key)) { $this->$key = $value; } } } //-------------------------------------------------------------------- /** * Initializes the database connection/settings. * * @return mixed|void * @throws \CodeIgniter\Database\Exceptions\DatabaseException */ public function initialize() { /* If an established connection is available, then there's * no need to connect and select the database. * * Depending on the database driver, conn_id can be either * boolean TRUE, a resource or an object. */ if ($this->connID) { return; } //-------------------------------------------------------------------- $this->connectTime = microtime(true); try { // Connect to the database and set the connection ID $this->connID = $this->connect($this->pConnect); } catch (\Throwable $e) { log_message('error', 'Error connecting to the database: ' . $e->getMessage()); } // No connection resource? Check if there is a failover else throw an error if (! $this->connID) { // Check if there is a failover set if (! empty($this->failover) && is_array($this->failover)) { // Go over all the failovers foreach ($this->failover as $failover) { // Replace the current settings with those of the failover foreach ($failover as $key => $val) { if (property_exists($this, $key)) { $this->$key = $val; } } try { // Try to connect $this->connID = $this->connect($this->pConnect); } catch (\Throwable $e) { log_message('error', 'Error connecting to the database: ' . $e->getMessage()); } // If a connection is made break the foreach loop if ($this->connID) { break; } } } // We still don't have a connection? if (! $this->connID) { throw new DatabaseException('Unable to connect to the database.'); } } $this->connectDuration = microtime(true) - $this->connectTime; } //-------------------------------------------------------------------- /** * Connect to the database. * * @param boolean $persistent * @return mixed */ abstract public function connect(bool $persistent = false); //-------------------------------------------------------------------- /** * Close the database connection. * * @return void */ public function close() { if ($this->connID) { $this->_close(); $this->connID = false; } } //-------------------------------------------------------------------- /** * Platform dependent way method for closing the connection. * * @return mixed */ abstract protected function _close(); //-------------------------------------------------------------------- /** * Create a persistent database connection. * * @return mixed */ public function persistentConnect() { return $this->connect(true); } //-------------------------------------------------------------------- /** * Keep or establish the connection if no queries have been sent for * a length of time exceeding the server's idle timeout. * * @return mixed */ abstract public function reconnect(); //-------------------------------------------------------------------- /** * Returns the actual connection object. If both a 'read' and 'write' * connection has been specified, you can pass either term in to * get that connection. If you pass either alias in and only a single * connection is present, it must return the sole connection. * * @param string|null $alias * * @return mixed */ public function getConnection(string $alias = null) { //@todo work with read/write connections return $this->connID; } //-------------------------------------------------------------------- /** * Select a specific database table to use. * * @param string $databaseName * * @return mixed */ abstract public function setDatabase(string $databaseName); //-------------------------------------------------------------------- /** * Returns the name of the current database being used. * * @return string */ public function getDatabase(): string { return empty($this->database) ? '' : $this->database; } //-------------------------------------------------------------------- /** * Set DB Prefix * * Set's the DB Prefix to something new without needing to reconnect * * @param string $prefix The prefix * * @return string */ public function setPrefix(string $prefix = ''): string { return $this->DBPrefix = $prefix; } //-------------------------------------------------------------------- /** * Returns the database prefix. * * @return string */ public function getPrefix(): string { return $this->DBPrefix; } //-------------------------------------------------------------------- /** * The name of the platform in use (MySQLi, mssql, etc) * * @return string */ public function getPlatform(): string { return $this->DBDriver; } //-------------------------------------------------------------------- /** * Returns a string containing the version of the database being used. * * @return string */ abstract public function getVersion(): string; //-------------------------------------------------------------------- /** * Sets the Table Aliases to use. These are typically * collected during use of the Builder, and set here * so queries are built correctly. * * @param array $aliases * * @return $this */ public function setAliasedTables(array $aliases) { $this->aliasedTables = $aliases; return $this; } //-------------------------------------------------------------------- /** * Add a table alias to our list. * * @param string $table * * @return $this */ public function addTableAlias(string $table) { if (! in_array($table, $this->aliasedTables)) { $this->aliasedTables[] = $table; } return $this; } /** * Executes the query against the database. * * @param $sql * * @return mixed */ abstract protected function execute(string $sql); //-------------------------------------------------------------------- /** * Orchestrates a query against the database. Queries must use * Database\Statement objects to store the query and build it. * This method works with the cache. * * Should automatically handle different connections for read/write * queries if needed. * * @param string $sql * @param mixed ...$binds * @param boolean $setEscapeFlags * @param string $queryClass * * @return BaseResult|Query|false */ public function query(string $sql, $binds = null, bool $setEscapeFlags = true, string $queryClass = 'CodeIgniter\\Database\\Query') { if (empty($this->connID)) { $this->initialize(); } $resultClass = str_replace('Connection', 'Result', get_class($this)); /** * @var Query $query */ $query = new $queryClass($this); $query->setQuery($sql, $binds, $setEscapeFlags); if (! empty($this->swapPre) && ! empty($this->DBPrefix)) { $query->swapPrefix($this->DBPrefix, $this->swapPre); } $startTime = microtime(true); // Always save the last query so we can use // the getLastQuery() method. $this->lastQuery = $query; // Run the query for real if (! $this->pretend && false === ($this->resultID = $this->simpleQuery($query->getQuery()))) { $query->setDuration($startTime, $startTime); // This will trigger a rollback if transactions are being used if ($this->transDepth !== 0) { $this->transStatus = false; } if ($this->DBDebug) { // We call this function in order to roll-back queries // if transactions are enabled. If we don't call this here // the error message will trigger an exit, causing the // transactions to remain in limbo. while ($this->transDepth !== 0) { $transDepth = $this->transDepth; $this->transComplete(); if ($transDepth === $this->transDepth) { log_message('error', 'Database: Failure during an automated transaction commit/rollback!'); break; } } return false; } if (! $this->pretend) { // Let others do something with this query. Events::trigger('DBQuery', $query); } return new $resultClass($this->connID, $this->resultID); } $query->setDuration($startTime); if (! $this->pretend) { // Let others do something with this query Events::trigger('DBQuery', $query); } // If $pretend is true, then we just want to return // the actual query object here. There won't be // any results to return. return $this->pretend ? $query : new $resultClass($this->connID, $this->resultID); } //-------------------------------------------------------------------- /** * Performs a basic query against the database. No binding or caching * is performed, nor are transactions handled. Simply takes a raw * query string and returns the database-specific result id. * * @param string $sql * * @return mixed */ public function simpleQuery(string $sql) { if (empty($this->connID)) { $this->initialize(); } return $this->execute($sql); } //-------------------------------------------------------------------- /** * Disable Transactions * * This permits transactions to be disabled at run-time. * * @return void */ public function transOff() { $this->transEnabled = false; } //-------------------------------------------------------------------- /** * Enable/disable Transaction Strict Mode * * When strict mode is enabled, if you are running multiple groups of * transactions, if one group fails all subsequent groups will be * rolled back. * * If strict mode is disabled, each group is treated autonomously, * meaning a failure of one group will not affect any others * * @param boolean $mode = true * * @return $this */ public function transStrict(bool $mode = true) { $this->transStrict = $mode; return $this; } //-------------------------------------------------------------------- /** * Start Transaction * * @param boolean $test_mode = FALSE * @return boolean */ public function transStart(bool $test_mode = false): bool { if (! $this->transEnabled) { return false; } return $this->transBegin($test_mode); } //-------------------------------------------------------------------- /** * Complete Transaction * * @return boolean */ public function transComplete(): bool { if (! $this->transEnabled) { return false; } // The query() function will set this flag to FALSE in the event that a query failed if ($this->transStatus === false || $this->transFailure === true) { $this->transRollback(); // If we are NOT running in strict mode, we will reset // the _trans_status flag so that subsequent groups of // transactions will be permitted. if ($this->transStrict === false) { $this->transStatus = true; } // log_message('debug', 'DB Transaction Failure'); return false; } return $this->transCommit(); } //-------------------------------------------------------------------- /** * Lets you retrieve the transaction flag to determine if it has failed * * @return boolean */ public function transStatus(): bool { return $this->transStatus; } //-------------------------------------------------------------------- /** * Begin Transaction * * @param boolean $test_mode * @return boolean */ public function transBegin(bool $test_mode = false): bool { if (! $this->transEnabled) { return false; } // When transactions are nested we only begin/commit/rollback the outermost ones elseif ($this->transDepth > 0) { $this->transDepth ++; return true; } if (empty($this->connID)) { $this->initialize(); } // Reset the transaction failure flag. // If the $test_mode flag is set to TRUE transactions will be rolled back // even if the queries produce a successful result. $this->transFailure = ($test_mode === true); if ($this->_transBegin()) { $this->transDepth ++; return true; } return false; } //-------------------------------------------------------------------- /** * Commit Transaction * * @return boolean */ public function transCommit(): bool { if (! $this->transEnabled || $this->transDepth === 0) { return false; } // When transactions are nested we only begin/commit/rollback the outermost ones elseif ($this->transDepth > 1 || $this->_transCommit()) { $this->transDepth --; return true; } return false; } //-------------------------------------------------------------------- /** * Rollback Transaction * * @return boolean */ public function transRollback(): bool { if (! $this->transEnabled || $this->transDepth === 0) { return false; } // When transactions are nested we only begin/commit/rollback the outermost ones elseif ($this->transDepth > 1 || $this->_transRollback()) { $this->transDepth --; return true; } return false; } //-------------------------------------------------------------------- /** * Begin Transaction * * @return boolean */ abstract protected function _transBegin(): bool; //-------------------------------------------------------------------- /** * Commit Transaction * * @return boolean */ abstract protected function _transCommit(): bool; //-------------------------------------------------------------------- /** * Rollback Transaction * * @return boolean */ abstract protected function _transRollback(): bool; //-------------------------------------------------------------------- /** * Returns an instance of the query builder for this connection. * * @param string|array $tableName * * @return BaseBuilder * @throws DatabaseException */ public function table($tableName) { if (empty($tableName)) { throw new DatabaseException('You must set the database table to be used with your query.'); } $className = str_replace('Connection', 'Builder', get_class($this)); return new $className($tableName, $this); } //-------------------------------------------------------------------- /** * Creates a prepared statement with the database that can then * be used to execute multiple statements against. Within the * closure, you would build the query in any normal way, though * the Query Builder is the expected manner. * * Example: * $stmt = $db->prepare(function($db) * { * return $db->table('users') * ->where('id', 1) * ->get(); * }) * * @param \Closure $func * @param array $options Passed to the prepare() method * * @return BasePreparedQuery|null */ public function prepare(\Closure $func, array $options = []) { if (empty($this->connID)) { $this->initialize(); } $this->pretend(); $sql = $func($this); $this->pretend(false); if ($sql instanceof QueryInterface) { $sql = $sql->getOriginalQuery(); } $class = str_ireplace('Connection', 'PreparedQuery', get_class($this)); /** * @var BasePreparedQuery $class */ $class = new $class($this); return $class->prepare($sql, $options); } //-------------------------------------------------------------------- /** * Returns the last query's statement object. * * @return mixed */ public function getLastQuery() { return $this->lastQuery; } //-------------------------------------------------------------------- /** * Returns a string representation of the last query's statement object. * * @return string */ public function showLastQuery(): string { return (string) $this->lastQuery; } //-------------------------------------------------------------------- /** * Returns the time we started to connect to this database in * seconds with microseconds. * * Used by the Debug Toolbar's timeline. * * @return float|null */ public function getConnectStart(): ?float { return $this->connectTime; } //-------------------------------------------------------------------- /** * Returns the number of seconds with microseconds that it took * to connect to the database. * * Used by the Debug Toolbar's timeline. * * @param integer $decimals * * @return string */ public function getConnectDuration(int $decimals = 6): string { return number_format($this->connectDuration, $decimals); } //-------------------------------------------------------------------- /** * Protect Identifiers * * This function is used extensively by the Query Builder class, and by * a couple functions in this class. * It takes a column or table name (optionally with an alias) and inserts * the table prefix onto it. Some logic is necessary in order to deal with * column names that include the path. Consider a query like this: * * SELECT hostname.database.table.column AS c FROM hostname.database.table * * Or a query with aliasing: * * SELECT m.member_id, m.member_name FROM members AS m * * Since the column name can include up to four segments (host, DB, table, column) * or also have an alias prefix, we need to do a bit of work to figure this out and * insert the table prefix (if it exists) in the proper position, and escape only * the correct identifiers. * * @param string|array $item * @param boolean $prefixSingle * @param boolean $protectIdentifiers * @param boolean $fieldExists * * @return string|array */ public function protectIdentifiers($item, bool $prefixSingle = false, bool $protectIdentifiers = null, bool $fieldExists = true) { if (! is_bool($protectIdentifiers)) { $protectIdentifiers = $this->protectIdentifiers; } if (is_array($item)) { $escaped_array = []; foreach ($item as $k => $v) { $escaped_array[$this->protectIdentifiers($k)] = $this->protectIdentifiers($v, $prefixSingle, $protectIdentifiers, $fieldExists); } return $escaped_array; } // This is basically a bug fix for queries that use MAX, MIN, etc. // If a parenthesis is found we know that we do not need to // escape the data or add a prefix. There's probably a more graceful // way to deal with this, but I'm not thinking of it // // Added exception for single quotes as well, we don't want to alter // literal strings. if (strcspn($item, "()'") !== strlen($item)) { return $item; } // Convert tabs or multiple spaces into single spaces $item = preg_replace('/\s+/', ' ', trim($item)); // If the item has an alias declaration we remove it and set it aside. // Note: strripos() is used in order to support spaces in table names if ($offset = strripos($item, ' AS ')) { $alias = ($protectIdentifiers) ? substr($item, $offset, 4) . $this->escapeIdentifiers(substr($item, $offset + 4)) : substr($item, $offset); $item = substr($item, 0, $offset); } elseif ($offset = strrpos($item, ' ')) { $alias = ($protectIdentifiers) ? ' ' . $this->escapeIdentifiers(substr($item, $offset + 1)) : substr($item, $offset); $item = substr($item, 0, $offset); } else { $alias = ''; } // Break the string apart if it contains periods, then insert the table prefix // in the correct location, assuming the period doesn't indicate that we're dealing // with an alias. While we're at it, we will escape the components if (strpos($item, '.') !== false) { $parts = explode('.', $item); // Does the first segment of the exploded item match // one of the aliases previously identified? If so, // we have nothing more to do other than escape the item // // NOTE: The ! empty() condition prevents this method // from breaking when QB isn't enabled. if (! empty($this->aliasedTables) && in_array($parts[0], $this->aliasedTables)) { if ($protectIdentifiers === true) { foreach ($parts as $key => $val) { if (! in_array($val, $this->reservedIdentifiers)) { $parts[$key] = $this->escapeIdentifiers($val); } } $item = implode('.', $parts); } return $item . $alias; } // Is there a table prefix defined in the config file? If not, no need to do anything if ($this->DBPrefix !== '') { // We now add the table prefix based on some logic. // Do we have 4 segments (hostname.database.table.column)? // If so, we add the table prefix to the column name in the 3rd segment. if (isset($parts[3])) { $i = 2; } // Do we have 3 segments (database.table.column)? // If so, we add the table prefix to the column name in 2nd position elseif (isset($parts[2])) { $i = 1; } // Do we have 2 segments (table.column)? // If so, we add the table prefix to the column name in 1st segment else { $i = 0; } // This flag is set when the supplied $item does not contain a field name. // This can happen when this function is being called from a JOIN. if ($fieldExists === false) { $i++; } // Verify table prefix and replace if necessary if ($this->swapPre !== '' && strpos($parts[$i], $this->swapPre) === 0) { $parts[$i] = preg_replace('/^' . $this->swapPre . '(\S+?)/', $this->DBPrefix . '\\1', $parts[$i]); } // We only add the table prefix if it does not already exist elseif (strpos($parts[$i], $this->DBPrefix) !== 0) { $parts[$i] = $this->DBPrefix . $parts[$i]; } // Put the parts back together $item = implode('.', $parts); } if ($protectIdentifiers === true) { $item = $this->escapeIdentifiers($item); } return $item . $alias; } // In some cases, especially 'from', we end up running through // protect_identifiers twice. This algorithm won't work when // it contains the escapeChar so strip it out. $item = trim($item, $this->escapeChar); // Is there a table prefix? If not, no need to insert it if ($this->DBPrefix !== '') { // Verify table prefix and replace if necessary if ($this->swapPre !== '' && strpos($item, $this->swapPre) === 0) { $item = preg_replace('/^' . $this->swapPre . '(\S+?)/', $this->DBPrefix . '\\1', $item); } // Do we prefix an item with no segments? elseif ($prefixSingle === true && strpos($item, $this->DBPrefix) !== 0) { $item = $this->DBPrefix . $item; } } if ($protectIdentifiers === true && ! in_array($item, $this->reservedIdentifiers)) { $item = $this->escapeIdentifiers($item); } return $item . $alias; } //-------------------------------------------------------------------- /** * Escape the SQL Identifiers * * This function escapes column and table names * * @param mixed $item * * @return mixed */ public function escapeIdentifiers($item) { if ($this->escapeChar === '' || empty($item) || in_array($item, $this->reservedIdentifiers)) { return $item; } elseif (is_array($item)) { foreach ($item as $key => $value) { $item[$key] = $this->escapeIdentifiers($value); } return $item; } // Avoid breaking functions and literal values inside queries elseif (ctype_digit($item) || $item[0] === "'" || ( $this->escapeChar !== '"' && $item[0] === '"') || strpos($item, '(') !== false ) { return $item; } static $preg_ec = []; if (empty($preg_ec)) { if (is_array($this->escapeChar)) { $preg_ec = [ preg_quote($this->escapeChar[0], '/'), preg_quote($this->escapeChar[1], '/'), $this->escapeChar[0], $this->escapeChar[1], ]; } else { $preg_ec[0] = $preg_ec[1] = preg_quote($this->escapeChar, '/'); $preg_ec[2] = $preg_ec[3] = $this->escapeChar; } } foreach ($this->reservedIdentifiers as $id) { if (strpos($item, '.' . $id) !== false) { return preg_replace('/' . $preg_ec[0] . '?([^' . $preg_ec[1] . '\.]+)' . $preg_ec[1] . '?\./i', $preg_ec[2] . '$1' . $preg_ec[3] . '.', $item); } } return preg_replace('/' . $preg_ec[0] . '?([^' . $preg_ec[1] . '\.]+)' . $preg_ec[1] . '?(\.)?/i', $preg_ec[2] . '$1' . $preg_ec[3] . '$2', $item); } //-------------------------------------------------------------------- /** * DB Prefix * * Prepends a database prefix if one exists in configuration * * @param string $table the table * * @return string * @throws \CodeIgniter\Database\Exceptions\DatabaseException */ public function prefixTable(string $table = ''): string { if ($table === '') { throw new DatabaseException('A table name is required for that operation.'); } return $this->DBPrefix . $table; } //-------------------------------------------------------------------- /** * Returns the total number of rows affected by this query. * * @return mixed */ abstract public function affectedRows(): int; //-------------------------------------------------------------------- /** * "Smart" Escape String * * Escapes data based on type. * Sets boolean and null types * * @param mixed $str * * @return mixed */ public function escape($str) { if (is_array($str)) { return array_map([&$this, 'escape'], $str); } else if (is_string($str) || ( is_object($str) && method_exists($str, '__toString'))) { return "'" . $this->escapeString($str) . "'"; } else if (is_bool($str)) { return ($str === false) ? 0 : 1; } else if (is_numeric($str) && $str < 0) { return "'{$str}'"; } else if ($str === null) { return 'NULL'; } return $str; } //-------------------------------------------------------------------- /** * Escape String * * @param string|string[] $str Input string * @param boolean $like Whether or not the string will be used in a LIKE condition * @return string|string[] */ public function escapeString($str, bool $like = false) { if (is_array($str)) { foreach ($str as $key => $val) { $str[$key] = $this->escapeString($val, $like); } return $str; } $str = $this->_escapeString($str); // escape LIKE condition wildcards if ($like === true) { return str_replace([ $this->likeEscapeChar, '%', '_', ], [ $this->likeEscapeChar . $this->likeEscapeChar, $this->likeEscapeChar . '%', $this->likeEscapeChar . '_', ], $str ); } return $str; } //-------------------------------------------------------------------- /** * Escape LIKE String * * Calls the individual driver for platform * specific escaping for LIKE conditions * * @param string|string[] * @return string|string[] */ public function escapeLikeString($str) { return $this->escapeString($str, true); } //-------------------------------------------------------------------- /** * Platform independent string escape. * * Will likely be overridden in child classes. * * @param string $str * * @return string */ protected function _escapeString(string $str): string { return str_replace("'", "''", remove_invisible_characters($str, false)); } //-------------------------------------------------------------------- /** * This function enables you to call PHP database functions that are not natively included * in CodeIgniter, in a platform independent manner. * * @param string $functionName * @param array ...$params * * @return boolean * @throws DatabaseException */ public function callFunction(string $functionName, ...$params): bool { $driver = ($this->DBDriver === 'postgre' ? 'pg' : strtolower($this->DBDriver)) . '_'; if (false === strpos($driver, $functionName)) { $functionName = $driver . $functionName; } if (! function_exists($functionName)) { if ($this->DBDebug) { throw new DatabaseException('This feature is not available for the database you are using.'); } return false; } return $functionName(...$params); } //-------------------------------------------------------------------- //-------------------------------------------------------------------- // META Methods //-------------------------------------------------------------------- /** * Returns an array of table names * * @param boolean $constrainByPrefix = FALSE * @return boolean|array * @throws \CodeIgniter\Database\Exceptions\DatabaseException */ public function listTables(bool $constrainByPrefix = false) { // Is there a cached result? if (isset($this->dataCache['table_names']) && $this->dataCache['table_names']) { return $constrainByPrefix ? preg_grep("/^{$this->DBPrefix}/", $this->dataCache['table_names']) : $this->dataCache['table_names']; } if (false === ($sql = $this->_listTables($constrainByPrefix))) { if ($this->DBDebug) { throw new DatabaseException('This feature is not available for the database you are using.'); } return false; } $this->dataCache['table_names'] = []; $query = $this->query($sql); foreach ($query->getResultArray() as $row) { // Do we know from which column to get the table name? if (! isset($key)) { if (isset($row['table_name'])) { $key = 'table_name'; } elseif (isset($row['TABLE_NAME'])) { $key = 'TABLE_NAME'; } else { /* We have no other choice but to just get the first element's key. * Due to array_shift() accepting its argument by reference, if * E_STRICT is on, this would trigger a warning. So we'll have to * assign it first. */ $key = array_keys($row); $key = array_shift($key); } } $this->dataCache['table_names'][] = $row[$key]; } return $this->dataCache['table_names']; } //-------------------------------------------------------------------- /** * Determine if a particular table exists * * @param string $tableName * @return boolean */ public function tableExists(string $tableName): bool { return in_array($this->protectIdentifiers($tableName, true, false, false), $this->listTables()); } //-------------------------------------------------------------------- /** * Fetch Field Names * * @param string $table Table name * * @return array|false * @throws DatabaseException */ public function getFieldNames(string $table) { // Is there a cached result? if (isset($this->dataCache['field_names'][$table])) { return $this->dataCache['field_names'][$table]; } if (empty($this->connID)) { $this->initialize(); } if (false === ($sql = $this->_listColumns($table))) { if ($this->DBDebug) { throw new DatabaseException('This feature is not available for the database you are using.'); } return false; } $query = $this->query($sql); $this->dataCache['field_names'][$table] = []; foreach ($query->getResultArray() as $row) { // Do we know from where to get the column's name? if (! isset($key)) { if (isset($row['column_name'])) { $key = 'column_name'; } elseif (isset($row['COLUMN_NAME'])) { $key = 'COLUMN_NAME'; } else { // We have no other choice but to just get the first element's key. $key = key($row); } } $this->dataCache['field_names'][$table][] = $row[$key]; } return $this->dataCache['field_names'][$table]; } //-------------------------------------------------------------------- /** * Determine if a particular field exists * * @param string $fieldName * @param string $tableName * @return boolean */ public function fieldExists(string $fieldName, string $tableName): bool { return in_array($fieldName, $this->getFieldNames($tableName)); } //-------------------------------------------------------------------- /** * Returns an object with field data * * @param string $table the table name * @return array|false */ public function getFieldData(string $table) { $fields = $this->_fieldData($this->protectIdentifiers($table, true, false, false)); return $fields ?? false; } //-------------------------------------------------------------------- /** * Returns an object with key data * * @param string $table the table name * @return array|false */ public function getIndexData(string $table) { $fields = $this->_indexData($this->protectIdentifiers($table, true, false, false)); return $fields ?? false; } //-------------------------------------------------------------------- /** * Returns an object with foreign key data * * @param string $table the table name * @return array|false */ public function getForeignKeyData(string $table) { $fields = $this->_foreignKeyData($this->protectIdentifiers($table, true, false, false)); return $fields ?? false; } //-------------------------------------------------------------------- /** * Disables foreign key checks temporarily. */ public function disableForeignKeyChecks() { $sql = $this->_disableForeignKeyChecks(); return $this->query($sql); } //-------------------------------------------------------------------- /** * Enables foreign key checks temporarily. */ public function enableForeignKeyChecks() { $sql = $this->_enableForeignKeyChecks(); return $this->query($sql); } //-------------------------------------------------------------------- /** * Allows the engine to be set into a mode where queries are not * actually executed, but they are still generated, timed, etc. * * This is primarily used by the prepared query functionality. * * @param boolean $pretend * * @return $this */ public function pretend(bool $pretend = true) { $this->pretend = $pretend; return $this; } //-------------------------------------------------------------------- /** * Empties our data cache. Especially helpful during testing. * * @return $this */ public function resetDataCache() { $this->dataCache = []; return $this; } //-------------------------------------------------------------------- /** * Returns the last error code and message. * * Must return an array with keys 'code' and 'message': * * return ['code' => null, 'message' => null); * * @return array */ abstract public function error(): array; //-------------------------------------------------------------------- /** * Insert ID * * @return integer */ abstract public function insertID(): int; //-------------------------------------------------------------------- /** * Generates the SQL for listing tables in a platform-dependent manner. * * @param boolean $constrainByPrefix * * @return string */ abstract protected function _listTables(bool $constrainByPrefix = false): string; //-------------------------------------------------------------------- /** * Generates a platform-specific query string so that the column names can be fetched. * * @param string $table * * @return string */ abstract protected function _listColumns(string $table = ''): string; //-------------------------------------------------------------------- /** * Platform-specific field data information. * * @param string $table * @see getFieldData() * @return array */ abstract protected function _fieldData(string $table): array; //-------------------------------------------------------------------- /** * Platform-specific index data. * * @param string $table * @see getIndexData() * @return array */ abstract protected function _indexData(string $table): array; //-------------------------------------------------------------------- /** * Platform-specific foreign keys data. * * @param string $table * @see getForeignKeyData() * @return array */ abstract protected function _foreignKeyData(string $table): array; //-------------------------------------------------------------------- /** * Accessor for properties if they exist. * * @param string $key * * @return mixed */ public function __get(string $key) { if (property_exists($this, $key)) { return $this->$key; } return null; } //-------------------------------------------------------------------- /** * Checker for properties existence. * * @param string $key * * @return boolean */ public function __isset(string $key): bool { return property_exists($this, $key); } //-------------------------------------------------------------------- } |
Commits for pgleadershipbook/trunk/system/Database/BaseConnection.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Thu 04 Feb, 2021 09:33:04 +0000 | PG Leadership book initial commit |