database.mysqli.lib.php 55 KB

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