database.mysqli.lib.php 54 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256
  1. <?php
  2. /* For licensing terms, see /license.txt */
  3. /**
  4. * This is a special version of the main database library for Chamilo focused
  5. * on using the MySQLi driver instead of the MySQL driver.
  6. * To use it, make a backup copy of your database.lib.php file and replace
  7. * database.lib.php by this file.
  8. * Include/require it in your code to use its functionality.
  9. * Because this library contains all the basic database calls, it could be
  10. * replaced by another library for say, PostgreSQL, to actually use Chamilo
  11. * with another database (this is not ready yet because a lot of code still
  12. * uses the MySQL database functions extensively).
  13. *
  14. * @package chamilo.library
  15. */
  16. /* Loading constants */
  17. require_once 'database.constants.inc.php';
  18. /* DATABASE CLASS
  19. The class and its methods
  20. */
  21. class Database {
  22. /*
  23. Accessor methods
  24. Usually, you won't need these directly but instead
  25. rely on of the get_xxx_table methods.
  26. */
  27. /**
  28. * Returns the name of the main database.
  29. */
  30. public static function get_main_database() {
  31. global $_configuration;
  32. return $_configuration['main_database'];
  33. }
  34. /**
  35. * Returns the name of the statistics database.
  36. */
  37. public static function get_statistic_database() {
  38. global $_configuration;
  39. return $_configuration['statistics_database'];
  40. }
  41. /**
  42. * Returns the name of the SCORM database.
  43. * @deprecated
  44. */
  45. public static function get_scorm_database() {
  46. global $_configuration;
  47. return $_configuration['scorm_database'];
  48. }
  49. /**
  50. * Returns the name of the database where all the personal stuff of the user is stored
  51. */
  52. public static function get_user_personal_database() {
  53. global $_configuration;
  54. return $_configuration['user_personal_database'];
  55. }
  56. /**
  57. * Returns the name of the current course database.
  58. * @return mixed Glued database name of false if undefined
  59. */
  60. public static function get_current_course_database() {
  61. $course_info = api_get_course_info();
  62. if (empty($course_info['dbName'])) {
  63. return false;
  64. }
  65. return $course_info['dbName'];
  66. }
  67. /**
  68. * Returns the glued name of the current course database.
  69. * @return mixed Glued database name of false if undefined
  70. */
  71. public static function get_current_course_glued_database() {
  72. $course_info = api_get_course_info();
  73. if (empty($course_info['dbNameGlu'])) {
  74. return false;
  75. }
  76. return $course_info['dbNameGlu'];
  77. }
  78. /**
  79. * The glue is the string needed between database and table.
  80. * The trick is: in multiple databases, this is a period (with backticks).
  81. * In single database, this can be e.g. an underscore so we just fake
  82. * there are multiple databases and the code can be written independent
  83. * of the single / multiple database setting.
  84. */
  85. public static function get_database_glue() {
  86. global $_configuration;
  87. return $_configuration['db_glue'];
  88. }
  89. /**
  90. * Returns the database prefix.
  91. * All created COURSE databases are prefixed with this string.
  92. *
  93. * TIP: This can be convenient e.g. if you have multiple system installations
  94. * on the same physical server.
  95. */
  96. public static function get_database_name_prefix() {
  97. global $_configuration;
  98. return $_configuration['db_prefix'];
  99. }
  100. /**
  101. * Returns the course table prefix for single database.
  102. * Not certain exactly when this is used.
  103. * Do research.
  104. * It's used in local.inc.php.
  105. */
  106. public static function get_course_table_prefix() {
  107. global $_configuration;
  108. return $_configuration['table_prefix'];
  109. }
  110. /*
  111. Table name methods
  112. Use these methods to get table names for queries,
  113. instead of constructing them yourself.
  114. Backticks automatically surround the result,
  115. e.g. `COURSE_NAME`.`link`
  116. so the queries can look cleaner.
  117. Example:
  118. $table = Database::get_course_table(TABLE_DOCUMENT);
  119. $sql_query = "SELECT * FROM $table WHERE $condition";
  120. $sql_result = Database::query($sql_query);
  121. $result = Database::fetch_array($sql_result);
  122. */
  123. /**
  124. * A more generic method than the other get_main_xxx_table methods,
  125. * This one returns the correct complete name of any table of the main database of which you pass
  126. * the short name as a parameter.
  127. * Please, define table names as constants in this library and use them
  128. * instead of directly using magic words in your tool code.
  129. *
  130. * @param string $short_table_name, the name of the table
  131. */
  132. public static function get_main_table($short_table_name) {
  133. return self::format_table_name(self::get_main_database(), $short_table_name);
  134. }
  135. /**
  136. * A more generic method than the older get_course_xxx_table methods,
  137. * This one can return the correct complete name of any course table of which you pass
  138. * the short name as a parameter.
  139. * Please, define table names as constants in this library and use them
  140. * instead of directly using magic words in your tool code.
  141. *
  142. * @param string $short_table_name, the name of the table
  143. * @param string $database_name, optional, name of the course database
  144. * - if you don't specify this, you work on the current course.
  145. */
  146. public static function get_course_table($short_table_name, $database_name = '') {
  147. return self::format_glued_course_table_name(self::fix_database_parameter($database_name), $short_table_name);
  148. }
  149. /**
  150. * Gets a complete course table name from a course code
  151. *
  152. * @param string $course_code
  153. * @param string $table the name of the table
  154. */
  155. public static function get_course_table_from_code($course_code, $table) {
  156. $course_table = self::get_main_table(TABLE_MAIN_COURSE);
  157. $course_cat_table = self::get_main_table(TABLE_MAIN_CATEGORY);
  158. $result = self::fetch_array(self::query(
  159. "SELECT $course_table.db_name, $course_cat_table.code
  160. FROM $course_table
  161. LEFT JOIN $course_cat_table
  162. ON $course_table.category_code = $course_cat_table.code
  163. WHERE $course_table.code = '$course_code'
  164. LIMIT 1"));
  165. return sprintf("%s.%s", $result[0], $table);
  166. }
  167. /**
  168. * This generic method returns the correct and complete name of any statistic table
  169. * of which you pass the short name as a parameter.
  170. * Please, define table names as constants in this library and use them
  171. * instead of directly using magic words in your tool code.
  172. *
  173. * @param string $short_table_name, the name of the table
  174. */
  175. public static function get_statistic_table($short_table_name) {
  176. return self::format_table_name(self::get_statistic_database(), $short_table_name);
  177. }
  178. /**
  179. * This generic method returns the correct and complete name of any scorm
  180. * table of which you pass the short name as a parameter. Please, define
  181. * table names as constants in this library and use them instead of directly
  182. * using magic words in your tool code.
  183. *
  184. * @param string $short_table_name, the name of the table
  185. */
  186. public static function get_scorm_table($short_table_name) {
  187. return self::format_table_name(self::get_scorm_database(), $short_table_name);
  188. }
  189. /**
  190. * This generic method returns the correct and complete name of any scorm
  191. * table of which you pass the short name as a parameter. Please, define
  192. * table names as constants in this library and use them instead of directly
  193. * using magic words in your tool code.
  194. *
  195. * @param string $short_table_name, the name of the table
  196. */
  197. public static function get_user_personal_table($short_table_name) {
  198. return self::format_table_name(self::get_user_personal_database(), $short_table_name);
  199. }
  200. public static function get_course_chat_connected_table($database_name = '') {
  201. return self::format_glued_course_table_name(self::fix_database_parameter($database_name), CHAT_CONNECTED_TABLE);
  202. }
  203. /*
  204. Query methods
  205. These methods execute a query and return the result(s).
  206. */
  207. /**
  208. * @return a list (array) of all courses.
  209. * @todo shouldn't this be in the course.lib.php script?
  210. */
  211. public static function get_course_list() {
  212. $table = self::get_main_table(TABLE_MAIN_COURSE);
  213. return self::store_result(self::query("SELECT * FROM $table"));
  214. }
  215. /**
  216. * Returns an array with all database fields for the specified course.
  217. *
  218. * @param the real (system) code of the course (ID from inside the main course table)
  219. * @todo shouldn't this be in the course.lib.php script?
  220. */
  221. public static function get_course_info($course_code) {
  222. $course_code = self::escape_string($course_code);
  223. $table = self::get_main_table(TABLE_MAIN_COURSE);
  224. $result = self::generate_abstract_course_field_names(
  225. self::fetch_array(self::query("SELECT * FROM $table WHERE `code` = '$course_code'")));
  226. return $result === false ? array('db_name' => '') : $result;
  227. }
  228. /**
  229. * @param $user_id (integer): the id of the user
  230. * @return $user_info (array): user_id, lastname, firstname, username, email, ...
  231. * @author Patrick Cool <patrick.cool@UGent.be>, expanded to get info for any user
  232. * @author Roan Embrechts, first version + converted to Database API
  233. * @version 30 September 2004
  234. * @desc find all the information about a specified user. Without parameter this is the current user.
  235. * @todo shouldn't this be in the user.lib.php script?
  236. */
  237. public static function get_user_info_from_id($user_id = '') {
  238. if (empty($user_id)) {
  239. return $GLOBALS['_user'];
  240. }
  241. $table = self::get_main_table(TABLE_MAIN_USER);
  242. $user_id = self::escape_string($user_id);
  243. return self::generate_abstract_user_field_names(
  244. self::fetch_array(self::query("SELECT * FROM $table WHERE user_id = '$user_id'")));
  245. }
  246. /**
  247. * Returns course code from a given gradebook category's id
  248. * @param int Category ID
  249. * @return string Course code
  250. * @todo move this function in a gradebook-related library
  251. */
  252. public static function get_course_by_category($category_id) {
  253. $info = self::fetch_array(self::query('SELECT course_code FROM '.self::get_main_table(TABLE_MAIN_GRADEBOOK_CATEGORY).' WHERE id='.$category_id), 'ASSOC');
  254. return $info ? $info['course_code'] : false;
  255. }
  256. /**
  257. * This method creates an abstraction layer between database field names
  258. * and field names expected in code.
  259. *
  260. * This approach helps when changing database names.
  261. * It's also useful now to get rid of the 'franglais'.
  262. *
  263. * @todo add more array entries to abstract course info from field names
  264. * @author Roan Embrechts
  265. *
  266. * @todo What's the use of this method. I think this is better removed.
  267. * There should be consistency in the variable names and the use throughout the scripts
  268. * for the database name we should consistently use or db_name or database (db_name probably being the better one)
  269. */
  270. public static function generate_abstract_course_field_names($result_array) {
  271. $visual_code = isset($result_array['visual_code']) ? $result_array['visual_code'] : null;
  272. $code = isset($result_array['code']) ? $result_array['code'] : null;
  273. $title = isset($result_array['title']) ? $result_array['title'] : null;
  274. $db_name = isset($result_array['db_name']) ? $result_array['db_name'] : null;
  275. $category_code = isset($result_array['category_code']) ? $result_array['category_code'] : null;
  276. $result_array['official_code'] = $visual_code;
  277. $result_array['visual_code'] = $visual_code;
  278. $result_array['real_code'] = $code;
  279. $result_array['system_code'] = $code;
  280. $result_array['title'] = $title;
  281. $result_array['database'] = $db_name;
  282. $result_array['faculty'] = $category_code;
  283. //$result_array['directory'] = $result_array['directory'];
  284. /*
  285. still to do: (info taken from local.inc.php)
  286. $_course['id' ] = $cData['cours_id' ]; //auto-assigned integer
  287. $_course['name' ] = $cData['title' ];
  288. $_course['official_code'] = $cData['visual_code' ]; // use in echo
  289. $_course['sysCode' ] = $cData['code' ]; // use as key in db
  290. $_course['path' ] = $cData['directory' ]; // use as key in path
  291. $_course['dbName' ] = $cData['db_name' ]; // use as key in db list
  292. $_course['dbNameGlu' ] = $_configuration['table_prefix'] . $cData['dbName'] . $_configuration['db_glue']; // use in all queries
  293. $_course['titular' ] = $cData['tutor_name' ];
  294. $_course['language' ] = $cData['course_language' ];
  295. $_course['extLink' ]['url' ] = $cData['department_url' ];
  296. $_course['extLink' ]['name'] = $cData['department_name'];
  297. $_course['categoryCode'] = $cData['faCode' ];
  298. $_course['categoryName'] = $cData['faName' ];
  299. $_course['visibility' ] = (bool) ($cData['visibility'] == 2 || $cData['visibility'] == 3);
  300. $_course['registrationAllowed'] = (bool) ($cData['visibility'] == 1 || $cData['visibility'] == 2);
  301. */
  302. return $result_array;
  303. }
  304. /**
  305. * This method creates an abstraction layer between database field names
  306. * and field names expected in code.
  307. *
  308. * This helps when changing database names.
  309. * It's also useful now to get rid of the 'franglais'.
  310. *
  311. * @todo add more array entries to abstract user info from field names
  312. * @author Roan Embrechts
  313. * @author Patrick Cool
  314. *
  315. * @todo what's the use of this function. I think this is better removed.
  316. * There should be consistency in the variable names and the use throughout the scripts
  317. */
  318. public static function generate_abstract_user_field_names($result_array) {
  319. $result_array['firstName'] = $result_array['firstname'];
  320. $result_array['lastName'] = $result_array['lastname'];
  321. $result_array['mail'] = $result_array['email'];
  322. #$result_array['picture_uri'] = $result_array['picture_uri'];
  323. #$result_array ['user_id'] = $result_array['user_id'];
  324. return $result_array;
  325. }
  326. /**
  327. * Counts the number of rows in a table
  328. * @param string $table The table of which the rows should be counted
  329. * @return int The number of rows in the given table.
  330. */
  331. public static function count_rows($table) {
  332. $obj = self::fetch_object(self::query("SELECT COUNT(*) AS n FROM $table"));
  333. return $obj->n;
  334. }
  335. /*
  336. An intermediate API-layer between the system and the dabase server.
  337. */
  338. /**
  339. * Returns the number of affected rows in the last database operation.
  340. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  341. * @return int Returns the number of affected rows on success, and -1 if the last query failed.
  342. */
  343. public static function affected_rows($connection = null) {
  344. global $database_connection;
  345. return $database_connection->affected_rows;
  346. }
  347. /**
  348. * Closes non-persistent database connection.
  349. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  350. * @return bool Returns TRUE on success or FALSE on failure.
  351. */
  352. public static function close($connection = null) {
  353. return self::use_default_connection($connection) ? mysqli::close() : mysqli::close($connection);
  354. }
  355. /**
  356. * Opens a connection to a database server.
  357. * @param array $parameters (optional) An array that contains the necessary parameters for accessing the server.
  358. * @return resource/boolean Returns a database connection on success or FALSE on failure.
  359. * Note: Currently the array could contain MySQL-specific parameters:
  360. * $parameters['server'], $parameters['username'], $parameters['password'],
  361. * $parameters['new_link'], $parameters['client_flags'], $parameters['persistent'].
  362. * For details see documentation about the functions mysql_connect() and mysql_pconnect().
  363. * @link http://php.net/manual/en/function.mysql-connect.php
  364. * @link http://php.net/manual/en/function.mysql-pconnect.php
  365. */
  366. public static function connect($parameters = array()) {
  367. global $database_connection;
  368. // A MySQL-specific implementation.
  369. if (!isset($parameters['server'])) {
  370. $parameters['server'] = @ini_get('mysqli.default_host');
  371. if (empty($parameters['server'])) {
  372. $parameters['server'] = 'localhost:3306';
  373. }
  374. }
  375. if (!isset($parameters['username'])) {
  376. $parameters['username'] = @ini_get('mysqli.default_user');
  377. }
  378. if (!isset($parameters['password'])) {
  379. $parameters['password'] = @ini_get('mysqli.default_pw');
  380. }
  381. $database_connection = $parameters['persistent']
  382. ? new mysqli('p:'.$parameters['server'], $parameters['username'], $parameters['password'])
  383. : new mysqli($parameters['server'], $parameters['username'], $parameters['password']);
  384. if ($database_connection->connect_errno) {
  385. error_log($database_connection->connect_errno());
  386. return false;
  387. } else {
  388. return true;
  389. }
  390. }
  391. /**
  392. * Returns the error number from the last operation done on the database server.
  393. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  394. * @return int Returns the error number from the last database (operation, or 0 (zero) if no error occurred.
  395. */
  396. public static function errno($connection = null) {
  397. return self::use_default_connection($connection) ? mysqli::mysqli_errno() : mysqli::mysqli_errno($connection);
  398. }
  399. /**
  400. * Returns the error text from the last operation done on the database server.
  401. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  402. * @return string Returns the error text from the last database operation, or '' (empty string) if no error occurred.
  403. */
  404. public static function error($connection = null) {
  405. return self::use_default_connection($connection) ? mysqli::mysqli_error() : mysqli::mysqli_error($connection);
  406. }
  407. /**
  408. * Escapes a string to insert into the database as text
  409. * @param string The string to escape
  410. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  411. * @return string The escaped string
  412. * @author Yannick Warnier <yannick.warnier@dokeos.com>
  413. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  414. */
  415. public static function escape_string($string, $connection = null) {
  416. global $database_connection;
  417. return get_magic_quotes_gpc()
  418. ? ( $database_connection->escape_string(stripslashes($string)))
  419. : ( $database_connection->escape_string($string));
  420. }
  421. /**
  422. * Gets the array from a SQL result (as returned by Database::query) - help achieving database independence
  423. * @param resource The result from a call to sql_query (e.g. Database::query)
  424. * @param string Optional: "ASSOC","NUM" or "BOTH", as the constant used in mysqli_fetch_array.
  425. * @return array Array of results as returned by php
  426. * @author Yannick Warnier <yannick.warnier@beeznest.com>
  427. */
  428. public static function fetch_array($result, $option = 'BOTH') {
  429. return ($option == 'ASSOC') ? $result->fetch_array(MYSQLI_ASSOC) : ($option == 'NUM' ? $result->fetch_array(MYSQLI_NUM) : $result->fetch_array());
  430. }
  431. /**
  432. * Gets an associative array from a SQL result (as returned by Database::query).
  433. * This method is equivalent to calling Database::fetch_array() with 'ASSOC' value for the optional second parameter.
  434. * @param resource $result The result from a call to sql_query (e.g. Database::query).
  435. * @return array Returns an associative array that corresponds to the fetched row and moves the internal data pointer ahead.
  436. */
  437. public static function fetch_assoc($result) {
  438. return $result->fetch_assoc();
  439. }
  440. /**
  441. * Gets the next row of the result of the SQL query (as returned by Database::query) in an object form
  442. * @param resource The result from a call to sql_query (e.g. Database::query)
  443. * @param string Optional class name to instanciate
  444. * @param array Optional array of parameters
  445. * @return object Object of class StdClass or the required class, containing the query result row
  446. * @author Yannick Warnier <yannick.warnier@dokeos.com>
  447. */
  448. public static function fetch_object($result, $class = null, $params = null) {
  449. return !empty($class) ? (is_array($params) ? $result->fetch_object($class, $params) : $result->fetch_object($class)) : $result->fetch_object();
  450. }
  451. /**
  452. * Gets the array from a SQL result (as returned by Database::query) - help achieving database independence
  453. * @param resource The result from a call to sql_query (see Database::query()).
  454. * @return array Array of results as returned by php (mysql_fetch_row)
  455. */
  456. public static function fetch_row($result) {
  457. return $result->fetch_row();
  458. }
  459. /**
  460. * Frees all the memory associated with the provided result identifier.
  461. * @return bool Returns TRUE on success or FALSE on failure.
  462. * Notes: Use this method if you are concerned about how much memory is being used for queries that return large result sets.
  463. * Anyway, all associated result memory is automatically freed at the end of the script's execution.
  464. */
  465. public static function free_result($result) {
  466. return $result->free_result();
  467. }
  468. /**
  469. * Returns the database client library version.
  470. * @return strung Returns a string that represents the client library version.
  471. */
  472. public function get_client_info() {
  473. return mysqli_get_client_info();
  474. }
  475. /**
  476. * Returns a list of databases created on the server. The list may contain all of the
  477. * available database names or filtered database names by using a pattern.
  478. * @param string $pattern (optional) A pattern for filtering database names as if it was needed for the SQL's LIKE clause, for example 'chamilo_%'.
  479. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  480. * @return array Returns in an array the retrieved list of database names.
  481. */
  482. public static function get_databases($pattern = '', $connection = null) {
  483. $result = array();
  484. $query_result = Database::query(!empty($pattern) ? "SHOW DATABASES LIKE '".self::escape_string($pattern, $connection)."'" : "SHOW DATABASES", $connection);
  485. while ($row = Database::fetch_row($query_result)) {
  486. $result[] = $row[0];
  487. }
  488. return $result;
  489. }
  490. /**
  491. * Returns a list of the fields that a given table contains. The list may contain all of the available field names or filtered field names by using a pattern.
  492. * By using a special option, this method is able to return an indexed list of fields' properties, where field names are keys.
  493. * @param string $table This is the examined table.
  494. * @param string $pattern (optional) A pattern for filtering field names as if it was needed for the SQL's LIKE clause, for example 'column_%'.
  495. * @param string $database (optional) The name of the targeted database. If it is omited, the current database is assumed, see Database::select_db().
  496. * @param bool $including_properties (optional) When this option is true, the returned result has the followong format:
  497. * array(field_name_1 => array(0 => property_1, 1 => property_2, ...), fieald_name_2 => array(0 => property_1, ...), ...)
  498. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  499. * @return array Returns in an array the retrieved list of field names.
  500. */
  501. public static function get_fields($table, $pattern = '', $database = '', $including_properties = false, $connection = null) {
  502. $result = array();
  503. $query = "SHOW COLUMNS FROM `".self::escape_string($table, $connection)."`";
  504. if (!empty($database)) {
  505. $query .= " FROM `".self::escape_string($database, $connection)."`";
  506. }
  507. if (!empty($pattern)) {
  508. $query .= " LIKE '".self::escape_string($pattern, $connection)."'";
  509. }
  510. $query_result = Database::query($query, $connection);
  511. if ($including_properties) {
  512. // Making an indexed list of the fields and their properties.
  513. while ($row = Database::fetch_row($query_result)) {
  514. $result[$row[0]] = $row;
  515. }
  516. } else {
  517. // Making a plain, flat list.
  518. while ($row = Database::fetch_row($query_result)) {
  519. $result[] = $row[0];
  520. }
  521. }
  522. return $result;
  523. }
  524. /**
  525. * Returns information about the type of the current connection and the server host name.
  526. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  527. * @return string/boolean Returns string data on success or FALSE on failure.
  528. */
  529. public function get_host_info($connection = null) {
  530. return self::use_default_connection($connection) ? mysqli::mysqli_get_host_info() : mysqli::mysqli_get_host_info($connection);
  531. }
  532. /**
  533. * Retrieves database client/server protocol version.
  534. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  535. * @return int/boolean Returns the protocol version on success or FALSE on failure.
  536. */
  537. public function get_proto_info($connection = null) {
  538. return self::use_default_connection($connection) ? mysqli::mysqli_get_proto_info() : mysqli::mysqli_get_proto_info($connection);
  539. }
  540. /**
  541. * Retrieves the database server version.
  542. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  543. * @return string/boolean Returns the MySQL server version on success or FALSE on failure.
  544. */
  545. public function get_server_info($connection = null) {
  546. return self::use_default_connection($connection) ? mysqli::mysqli_get_server_info() : mysqli::mysqli_get_server_info($connection);
  547. }
  548. /**
  549. * Returns a list of tables within a database. The list may contain all of the
  550. * available table names or filtered table names by using a pattern.
  551. * @param string $database (optional) The name of the examined database. If it is omited, the current database is assumed, see Database::select_db().
  552. * @param string $pattern (optional) A pattern for filtering table names as if it was needed for the SQL's LIKE clause, for example 'access_%'.
  553. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  554. * @return array Returns in an array the retrieved list of table names.
  555. */
  556. public static function get_tables($database = '', $pattern = '', $connection = null) {
  557. $result = array();
  558. $query = "SHOW TABLES";
  559. if (!empty($database)) {
  560. $query .= " FROM `".self::escape_string($database, $connection)."`";
  561. }
  562. if (!empty($pattern)) {
  563. $query .= " LIKE '".self::escape_string($pattern, $connection)."'";
  564. }
  565. $query_result = Database::query($query, $connection);
  566. while ($row = Database::fetch_row($query_result)) {
  567. $result[] = $row[0];
  568. }
  569. return $result;
  570. }
  571. /**
  572. * Gets the ID of the last item inserted into the database
  573. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  574. * @return int The last ID as returned by the DB function
  575. * @comment This should be updated to use ADODB at some point
  576. */
  577. public static function insert_id($connection = null) {
  578. global $database_connection;
  579. return $database_connection->insert_id;
  580. }
  581. /**
  582. * Gets the number of rows from the last query result - help achieving database independence
  583. * @param resource The result
  584. * @return integer The number of rows contained in this result
  585. * @author Yannick Warnier <yannick.warnier@dokeos.com>
  586. **/
  587. public static function num_rows($result) {
  588. return is_a($result,'mysqli_result') ? $result->num_rows : false;
  589. }
  590. /**
  591. * Acts as the relative *_result() function of most DB drivers and fetches a
  592. * specific line and a field
  593. * @param resource The database resource to get data from
  594. * @param integer The row number
  595. * @param string Optional field name or number
  596. * @result mixed One cell of the result, or FALSE on error
  597. */
  598. public static function result(&$resource, $row, $field = '') {
  599. if (self::num_rows($resource) > 0) {
  600. if (!empty($field)) {
  601. $r = mysqli_data_seek($resource, $row);
  602. return $r[$field];
  603. } else {
  604. return mysqli_data_seek($resource, $row);
  605. }
  606. } else { return null; }
  607. }
  608. /**
  609. * This method returns a resource
  610. * Documentation has been added by Arthur Portugal
  611. * Some adaptations have been implemented by Ivan Tcholakov, 2009, 2010
  612. * @author Olivier Brouckaert
  613. * @param string $query The SQL query
  614. * @param resource $connection (optional) The database server (MySQL) connection.
  615. * If it is not specified, the connection opened by mysql_connect() is assumed.
  616. * If no connection is found, the server will try to create one as if mysql_connect() was called with no arguments.
  617. * If no connection is found or established, an E_WARNING level error is generated.
  618. * @param string $file (optional) On error it shows the file in which the error has been trigerred (use the "magic" constant __FILE__ as input parameter)
  619. * @param string $line (optional) On error it shows the line in which the error has been trigerred (use the "magic" constant __LINE__ as input parameter)
  620. * @return resource The returned result from the query
  621. * Note: The parameter $connection could be skipped. Here are examples of this method usage:
  622. * Database::query($query);
  623. * $result = Database::query($query);
  624. * Database::query($query, $connection);
  625. * $result = Database::query($query, $connection);
  626. * The following ways for calling this method are obsolete:
  627. * Database::query($query, __FILE__, __LINE__);
  628. * $result = Database::query($query, __FILE__, __LINE__);
  629. * Database::query($query, $connection, __FILE__, __LINE__);
  630. * $result = Database::query($query, $connection, __FILE__, __LINE__);
  631. */
  632. public static function query($query, $connection = null, $file = null, $line = null) {
  633. global $database_connection;
  634. $result = @$database_connection->query($query);
  635. if ($database_connection->errno) {
  636. $backtrace = debug_backtrace(); // Retrieving information about the caller statement.
  637. if (isset($backtrace[0])) {
  638. $caller = & $backtrace[0];
  639. } else {
  640. $caller = array();
  641. }
  642. if (isset($backtrace[1])) {
  643. $owner = & $backtrace[1];
  644. } else {
  645. $owner = array();
  646. }
  647. if (empty($file)) {
  648. $file = $caller['file'];
  649. }
  650. if (empty($line) && $line !== false) {
  651. $line = $caller['line'];
  652. }
  653. $type = $owner['type'];
  654. $function = $owner['function'];
  655. $class = $owner['class'];
  656. $server_type = api_get_setting('server_type');
  657. if (!empty($line) && !empty($server_type) && $server_type != 'production') {
  658. $info = '<pre>' .
  659. '<strong>DATABASE ERROR #'.self::errno($connection).':</strong><br /> ' .
  660. self::remove_XSS(self::error($connection)) . '<br />' .
  661. '<strong>QUERY :</strong><br /> ' .
  662. self::remove_XSS($query) . '<br />' .
  663. '<strong>FILE :</strong><br /> ' .
  664. (empty($file) ? ' unknown ' : $file) . '<br />' .
  665. '<strong>LINE :</strong><br /> ' .
  666. (empty($line) ? ' unknown ' : $line) . '<br />';
  667. if (empty($type)) {
  668. if (!empty($function)) {
  669. $info .= '<strong>FUNCTION :</strong><br /> ' . $function;
  670. }
  671. } else {
  672. if (!empty($class) && !empty($function)) {
  673. $info .= '<strong>CLASS :</strong><br /> ' . $class . '<br />';
  674. $info .= '<strong>METHOD :</strong><br /> ' . $function;
  675. }
  676. }
  677. $info .= '</pre>';
  678. echo $info;
  679. }
  680. }
  681. return $result;
  682. }
  683. /**
  684. * Selects a database.
  685. * @param string $database_name The name of the database that is to be selected.
  686. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  687. * @return bool Returns TRUE on success or FALSE on failure.
  688. */
  689. public static function select_db($database_name, $connection = null) {
  690. global $database_connection;
  691. $database_connection->select_db($database_name);
  692. return !$database_connection->errno;
  693. //return self::use_default_connection($connection) ? mysqli_select_db($connection, $database_name) : mysqli_select_db($connection, $database_name);
  694. }
  695. /**
  696. * Stores a query result into an array.
  697. *
  698. * @author Olivier Brouckaert
  699. * @param resource $result - the return value of the query
  700. * @param option BOTH, ASSOC, or NUM
  701. * @return array - the value returned by the query
  702. */
  703. public static function store_result($result, $option = 'BOTH') {
  704. $array = array();
  705. if ($result !== false) { // For isolation from database engine's behaviour.
  706. while ($row = self::fetch_array($result, $option)) {
  707. $array[] = $row;
  708. }
  709. }
  710. return $array;
  711. }
  712. /*
  713. Encodings and collations supported by MySQL database server
  714. */
  715. /**
  716. * Checks whether a given encoding is supported by the database server.
  717. * @param string $encoding The encoding (a system conventional id, for example 'UTF-8') to be checked.
  718. * @return bool Returns a boolean value as a check-result.
  719. * @author Ivan Tcholakov
  720. */
  721. public static function is_encoding_supported($encoding) {
  722. static $supported = array();
  723. if (!isset($supported[$encoding])) {
  724. $supported[$encoding] = false;
  725. if (strlen($db_encoding = self::to_db_encoding($encoding)) > 0) {
  726. if (self::num_rows(self::query("SHOW CHARACTER SET WHERE Charset = '".self::escape_string($db_encoding)."';")) > 0) {
  727. $supported[$encoding] = true;
  728. }
  729. }
  730. }
  731. return $supported[$encoding];
  732. }
  733. /**
  734. * Constructs a SQL clause about default character set and default collation for newly created databases and tables.
  735. * Example: Database::make_charset_clause('UTF-8', 'bulgarian') returns
  736. * DEFAULT CHARACTER SET `utf8` DEFAULT COLLATE `utf8_general_ci`
  737. * @param string $encoding (optional) The default database/table encoding (a system conventional id) to be used.
  738. * @param string $language (optional) Language (a system conventional id) used for choosing language sensitive collation (if it is possible).
  739. * @return string Returns the constructed SQL clause or empty string if $encoding is not correct or is not supported.
  740. * @author Ivan Tcholakov
  741. */
  742. public static function make_charset_clause($encoding = null, $language = null) {
  743. if (empty($encoding)) {
  744. $encoding = api_get_system_encoding();
  745. }
  746. if (empty($language)) {
  747. $language = api_get_interface_language();
  748. }
  749. $charset_clause = '';
  750. if (self::is_encoding_supported($encoding)) {
  751. $db_encoding = Database::to_db_encoding($encoding);
  752. $charset_clause .= " DEFAULT CHARACTER SET `".$db_encoding."`";
  753. $db_collation = Database::to_db_collation($encoding, $language);
  754. if (!empty($db_collation)) {
  755. $charset_clause .= " DEFAULT COLLATE `".$db_collation."`";
  756. }
  757. }
  758. return $charset_clause;
  759. }
  760. /**
  761. * Converts an encoding identificator to MySQL-specific encoding identifictor,
  762. * i.e. 'UTF-8' --> 'utf8'.
  763. * @param string $encoding The conventional encoding identificator.
  764. * @return string Returns the corresponding MySQL-specific encoding identificator if any, otherwise returns NULL.
  765. * @author Ivan Tcholakov
  766. */
  767. public static function to_db_encoding($encoding) {
  768. static $result = array();
  769. if (!isset($result[$encoding])) {
  770. $result[$encoding] = null;
  771. $encoding_map = & self::get_db_encoding_map();
  772. foreach ($encoding_map as $key => $value) {
  773. if (api_equal_encodings($encoding, $key)) {
  774. $result[$encoding] = $value;
  775. break;
  776. }
  777. }
  778. }
  779. return $result[$encoding];
  780. }
  781. /**
  782. * Converts a MySQL-specific encoding identifictor to conventional encoding identificator,
  783. * i.e. 'utf8' --> 'UTF-8'.
  784. * @param string $encoding The MySQL-specific encoding identificator.
  785. * @return string Returns the corresponding conventional encoding identificator if any, otherwise returns NULL.
  786. * @author Ivan Tcholakov
  787. */
  788. public static function from_db_encoding($db_encoding) {
  789. static $result = array();
  790. if (!isset($result[$db_encoding])) {
  791. $result[$db_encoding] = null;
  792. $encoding_map = & self::get_db_encoding_map();
  793. foreach ($encoding_map as $key => $value) {
  794. if (strtolower($db_encoding) == $value) {
  795. $result[$db_encoding] = $key;
  796. break;
  797. }
  798. }
  799. }
  800. return $result[$db_encoding];
  801. }
  802. /**
  803. * Chooses the default MySQL-specific collation from given encoding and language.
  804. * @param string $encoding A conventional encoding id, i.e. 'UTF-8'
  805. * @param string $language (optional) A conventional for the system language id, i.e. 'bulgarian'. If it is empty, the chosen collation is the default server value corresponding to the given encoding.
  806. * @return string Returns a suitable default collation, for example 'utf8_general_ci', or NULL if collation was not found.
  807. * @author Ivan Tcholakov
  808. */
  809. public static function to_db_collation($encoding, $language = null) {
  810. static $result = array();
  811. if (!isset($result[$encoding][$language])) {
  812. $result[$encoding][$language] = null;
  813. if (self::is_encoding_supported($encoding)) {
  814. $db_encoding = self::to_db_encoding($encoding);
  815. if (!empty($language)) {
  816. $lang = api_purify_language_id($language);
  817. $res = self::check_db_collation($db_encoding, $lang);
  818. if (empty($res)) {
  819. $db_collation_map = & self::get_db_collation_map();
  820. if (isset($db_collation_map[$lang])) {
  821. $res = self::check_db_collation($db_encoding, $db_collation_map[$lang]);
  822. }
  823. }
  824. if (empty($res)) {
  825. $res = self::check_db_collation($db_encoding, null);
  826. }
  827. $result[$encoding][$language] = $res;
  828. } else {
  829. $result[$encoding][$language] = self::check_db_collation($db_encoding, null);
  830. }
  831. }
  832. }
  833. return $result[$encoding][$language];
  834. }
  835. /*
  836. Private methods
  837. You should not access these from outside the class
  838. No effort is made to keep the names / results the same.
  839. */
  840. /**
  841. * Glues a course database.
  842. * glue format from local.inc.php.
  843. */
  844. private static function glue_course_database_name($database_name) {
  845. return self::get_course_table_prefix().$database_name.self::get_database_glue();
  846. }
  847. /**
  848. * @param string $database_name, can be empty to use current course db
  849. *
  850. * @return the glued parameter if it is not empty,
  851. * or the current course database (glued) if the parameter is empty.
  852. */
  853. private static function fix_database_parameter($database_name) {
  854. if (empty($database_name)) {
  855. $course_info = api_get_course_info();
  856. return $course_info['dbNameGlu'];
  857. }
  858. return self::glue_course_database_name($database_name);
  859. }
  860. /**
  861. * Structures a course database and table name to ready them
  862. * for querying. The course database parameter is considered glued:
  863. * e.g. COURSE001`.`
  864. */
  865. private static function format_glued_course_table_name($database_name_with_glue, $table) {
  866. return '`'.$database_name_with_glue.$table.'`';
  867. }
  868. /**
  869. * Structures a database and table name to ready them
  870. * for querying. The database parameter is considered not glued,
  871. * just plain e.g. COURSE001
  872. */
  873. private static function format_table_name($database, $table) {
  874. return '`'.$database.'`.`'.$table.'`';
  875. }
  876. /**
  877. * This private method is to be used by the other methods in this class for
  878. * checking whether the input parameter $connection actually has been provided.
  879. * If the input parameter connection is not a resource or if it is not FALSE (in case of error)
  880. * then the default opened connection should be used by the called method.
  881. * @param resource/boolean $connection The checked parameter $connection.
  882. * @return boolean TRUE means that calling method should use the default connection.
  883. * FALSE means that (valid) parameter $connection has been provided and it should be used.
  884. */
  885. private static function use_default_connection($connection) {
  886. return !is_resource($connection) && $connection !== false;
  887. }
  888. /**
  889. * This private method tackles the XSS injections. It is similar to Security::remove_XSS() and works always,
  890. * including the time of initialization when the class Security has not been loaded yet.
  891. * @param string The input variable to be filtered from XSS, in this class it is expected to be a string.
  892. * @return string Returns the filtered string as a result.
  893. */
  894. private static function remove_XSS(& $var) {
  895. return class_exists('Security') ? Security::remove_XSS($var) : @htmlspecialchars($var, ENT_QUOTES, api_get_system_encoding());
  896. }
  897. /**
  898. * This private method encapsulates a table with relations between
  899. * conventional and MuSQL-specific encoding identificators.
  900. * @author Ivan Tcholakov
  901. */
  902. private static function & get_db_encoding_map() {
  903. static $encoding_map = array(
  904. 'ARMSCII-8' => 'armscii8',
  905. 'BIG5' => 'big5',
  906. 'BINARY' => 'binary',
  907. 'CP866' => 'cp866',
  908. 'EUC-JP' => 'ujis',
  909. 'EUC-KR' => 'euckr',
  910. 'GB2312' => 'gb2312',
  911. 'GBK' => 'gbk',
  912. 'ISO-8859-1' => 'latin1',
  913. 'ISO-8859-2' => 'latin2',
  914. 'ISO-8859-7' => 'greek',
  915. 'ISO-8859-8' => 'hebrew',
  916. 'ISO-8859-9' => 'latin5',
  917. 'ISO-8859-13' => 'latin7',
  918. 'ISO-8859-15' => 'latin1',
  919. 'KOI8-R' => 'koi8r',
  920. 'KOI8-U' => 'koi8u',
  921. 'SHIFT-JIS' => 'sjis',
  922. 'TIS-620' => 'tis620',
  923. 'US-ASCII' => 'ascii',
  924. 'UTF-8' => 'utf8',
  925. 'WINDOWS-1250' => 'cp1250',
  926. 'WINDOWS-1251' => 'cp1251',
  927. 'WINDOWS-1252' => 'latin1',
  928. 'WINDOWS-1256' => 'cp1256',
  929. 'WINDOWS-1257' => 'cp1257'
  930. );
  931. return $encoding_map;
  932. }
  933. /**
  934. * A helper language id translation table for choosing some collations.
  935. * @author Ivan Tcholakov
  936. */
  937. private static function & get_db_collation_map() {
  938. static $db_collation_map = array(
  939. 'german' => 'german2',
  940. 'simpl_chinese' => 'chinese',
  941. 'trad_chinese' => 'chinese',
  942. 'turkce' => 'turkish'
  943. );
  944. return $db_collation_map;
  945. }
  946. /**
  947. * Constructs a MySQL-specific collation and checks whether it is supported by the database server.
  948. * @param string $db_encoding A MySQL-specific encoding id, i.e. 'utf8'
  949. * @param string $language A MySQL-compatible language id, i.e. 'bulgarian'
  950. * @return string Returns a suitable default collation, for example 'utf8_general_ci', or NULL if collation was not found.
  951. * @author Ivan Tcholakov
  952. */
  953. private static function check_db_collation($db_encoding, $language) {
  954. if (empty($db_encoding)) {
  955. return null;
  956. }
  957. if (empty($language)) {
  958. $result = self::fetch_array(self::query("SHOW COLLATION WHERE Charset = '".self::escape_string($db_encoding)."' AND `Default` = 'Yes';"), 'NUM');
  959. return $result ? $result[0] : null;
  960. }
  961. $collation = $db_encoding.'_'.$language.'_ci';
  962. $query_result = self::query("SHOW COLLATION WHERE Charset = '".self::escape_string($db_encoding)."';");
  963. while ($result = self::fetch_array($query_result, 'NUM')) {
  964. if ($result[0] == $collation) {
  965. return $collation;
  966. }
  967. }
  968. return null;
  969. }
  970. /*
  971. New useful DB functions
  972. */
  973. /**
  974. * Experimental useful database insert
  975. * @todo lot of stuff to do here
  976. */
  977. public static function insert($table_name, $attributes) {
  978. if (empty($attributes) || empty($table_name)) {
  979. return false;
  980. }
  981. $filtred_attributes = array();
  982. foreach($attributes as $key => $value) {
  983. $filtred_attributes[$key] = "'".self::escape_string($value)."'";
  984. }
  985. $params = array_keys($filtred_attributes); //@todo check if the field exists in the table we should use a describe of that table
  986. $values = array_values($filtred_attributes);
  987. if (!empty($params) && !empty($values)) {
  988. $sql = 'INSERT INTO '.$table_name.' ('.implode(',',$params).') VALUES ('.implode(',',$values).')';
  989. $result = self::query($sql);
  990. return self::get_last_insert_id();
  991. }
  992. return false;
  993. }
  994. /**
  995. * Experimental useful database finder
  996. * @todo lot of stuff to do here
  997. */
  998. public static function select($columns = '*' , $table_name, $conditions = array(), $type_result = 'all', $option = 'ASSOC') {
  999. $conditions = self::parse_conditions($conditions);
  1000. //@todo we could do a describe here to check the columns ...
  1001. $clean_columns = '';
  1002. if (is_array($columns)) {
  1003. $clean_columns = implode(',', $columns);
  1004. } else {
  1005. if ($columns == '*') {
  1006. $clean_columns = '*';
  1007. } else {
  1008. $clean_columns = (string)$columns;
  1009. }
  1010. }
  1011. $sql = "SELECT $clean_columns FROM $table_name $conditions";
  1012. $result = self::query($sql);
  1013. $array = array();
  1014. //if (self::num_rows($result) > 0 ) {
  1015. if ($type_result == 'all') {
  1016. while ($row = self::fetch_array($result, $option)) {
  1017. if (isset($row['id'])) {
  1018. $array[$row['id']] = $row;
  1019. } else {
  1020. $array[] = $row;
  1021. }
  1022. }
  1023. } else {
  1024. $array = self::fetch_array($result, $option);
  1025. }
  1026. return $array;
  1027. }
  1028. /**
  1029. * Parses WHERE/ORDER conditions i.e array('where'=>array('id = ?' =>'4'), 'order'=>'id DESC'))
  1030. * @param array
  1031. * @todo lot of stuff to do here
  1032. */
  1033. private function parse_conditions($conditions) {
  1034. if (empty($conditions)) {
  1035. return '';
  1036. }
  1037. $return_value = '';
  1038. foreach ($conditions as $type_condition => $condition_data) {
  1039. $type_condition = strtolower($type_condition);
  1040. switch($type_condition) {
  1041. case 'where':
  1042. foreach ($condition_data as $condition => $value_array) {
  1043. if (is_array($value_array)) {
  1044. $clean_values = array();
  1045. foreach($value_array as $item) {
  1046. $item = Database::escape_string($item);
  1047. $clean_values[]= "'$item'";
  1048. }
  1049. } else {
  1050. $value_array = Database::escape_string($value_array);
  1051. $clean_values = "'$value_array'";
  1052. }
  1053. if (!empty($condition) && !empty($clean_values)) {
  1054. $condition = str_replace('?','%s', $condition); //we treat everything as string
  1055. $condition = vsprintf($condition, $clean_values);
  1056. $where_return .= $condition;
  1057. }
  1058. }
  1059. if (!empty($where_return)) {
  1060. $return_value = " WHERE $where_return" ;
  1061. }
  1062. break;
  1063. case 'order':
  1064. $order_array = explode(' ', $condition_data);
  1065. if (!empty($order_array)) {
  1066. if (count($order_array) > 1) {
  1067. $order_array[0] = self::escape_string($order_array[0]);
  1068. if (!empty($order_array[1])) {
  1069. $order_array[1] = strtolower($order_array[1]);
  1070. $order = 'desc';
  1071. if (in_array($order_array[1], array('desc', 'asc'))) {
  1072. $order = $order_array[1];
  1073. }
  1074. }
  1075. $return_value .= ' ORDER BY '.$order_array[0].' '.$order;
  1076. } else {
  1077. $return_value .= ' ORDER BY '.$order_array[0].' DESC ';
  1078. }
  1079. }
  1080. break;
  1081. case 'limit':
  1082. $limit_array = explode(',', $condition_data);
  1083. if (!empty($limit_array)) {
  1084. if (count($limit_array) > 1) {
  1085. $return_value .= ' LIMIT '.intval($limit_array[0]).' , '.intval($limit_array[1]);
  1086. } else {
  1087. $return_value .= ' LIMIT '.intval($limit_array[0]);
  1088. }
  1089. }
  1090. break;
  1091. }
  1092. }
  1093. return $return_value;
  1094. }
  1095. private function parse_where_conditions($coditions){
  1096. return self::parse_conditions(array('where'=>$coditions));
  1097. }
  1098. /**
  1099. * Experimental useful database update
  1100. * @todo lot of stuff to do here
  1101. */
  1102. public static function delete($table_name, $where_conditions) {
  1103. $result = false;
  1104. $where_return = self::parse_where_conditions($where_conditions);
  1105. $sql = "DELETE FROM $table_name $where_return ";
  1106. $result = self::query($sql);
  1107. $affected_rows = self::affected_rows();
  1108. //@todo should return affected_rows for
  1109. return $affected_rows;
  1110. }
  1111. /**
  1112. * Experimental useful database update
  1113. * @todo lot of stuff to do here
  1114. */
  1115. public static function update($table_name, $attributes, $where_conditions = array()) {
  1116. if (!empty($table_name) && !empty($attributes)) {
  1117. $update_sql = '';
  1118. //Cleaning attributes
  1119. $count = 1;
  1120. foreach ($attributes as $key=>$value) {
  1121. $value = self::escape_string($value);
  1122. $update_sql .= "$key = '$value' ";
  1123. if ($count < count($attributes)) {
  1124. $update_sql.=', ';
  1125. }
  1126. $count++;
  1127. }
  1128. if (!empty($update_sql)) {
  1129. //Parsing and cleaning the where conditions
  1130. $where_return = self::parse_where_conditions($where_conditions);
  1131. $sql = "UPDATE $table_name SET $update_sql $where_return ";
  1132. //echo $sql; exit;
  1133. $result = self::query($sql);
  1134. $affected_rows = self::affected_rows();
  1135. return $affected_rows;
  1136. }
  1137. }
  1138. return false;
  1139. }
  1140. /*
  1141. DEPRECATED METHODS
  1142. */
  1143. /**
  1144. * @deprecated Use api_get_language_isocode($language) instead.
  1145. */
  1146. public static function get_language_isocode($language) {
  1147. return api_get_language_isocode($language);
  1148. }
  1149. /**
  1150. * @deprecated Use Database::insert_id() instead.
  1151. */
  1152. public static function get_last_insert_id() {
  1153. global $database_connection;
  1154. return $database_connection->insert_id($database_connection);
  1155. }
  1156. }
  1157. //end class Database