database.mysqli.lib.php 56 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281
  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. /* Variable use only in the installation process to log errors. See the Database::query function */
  25. static $log_queries = false;
  26. /*
  27. Accessor methods
  28. Usually, you won't need these directly but instead
  29. rely on of the get_xxx_table methods.
  30. */
  31. /**
  32. * Returns the name of the main database.
  33. */
  34. public static function get_main_database() {
  35. global $_configuration;
  36. return $_configuration['main_database'];
  37. }
  38. /**
  39. * Returns the name of the statistics database.
  40. */
  41. public static function get_statistic_database() {
  42. global $_configuration;
  43. return $_configuration['statistics_database'];
  44. }
  45. /**
  46. * Returns the name of the SCORM database.
  47. * @deprecated
  48. */
  49. public static function get_scorm_database() {
  50. global $_configuration;
  51. return $_configuration['scorm_database'];
  52. }
  53. /**
  54. * Returns the name of the database where all the personal stuff of the user is stored
  55. */
  56. public static function get_user_personal_database() {
  57. global $_configuration;
  58. return $_configuration['user_personal_database'];
  59. }
  60. /**
  61. * Returns the name of the current course database.
  62. * @return mixed Glued database name of false if undefined
  63. */
  64. public static function get_current_course_database() {
  65. $course_info = api_get_course_info();
  66. if (empty($course_info['dbName'])) {
  67. return false;
  68. }
  69. return $course_info['dbName'];
  70. }
  71. /**
  72. * Returns the glued name of the current course database.
  73. * @return mixed Glued database name of false if undefined
  74. */
  75. public static function get_current_course_glued_database() {
  76. $course_info = api_get_course_info();
  77. if (empty($course_info['dbNameGlu'])) {
  78. return false;
  79. }
  80. return $course_info['dbNameGlu'];
  81. }
  82. /**
  83. * The glue is the string needed between database and table.
  84. * The trick is: in multiple databases, this is a period (with backticks).
  85. * In single database, this can be e.g. an underscore so we just fake
  86. * there are multiple databases and the code can be written independent
  87. * of the single / multiple database setting.
  88. */
  89. public static function get_database_glue() {
  90. global $_configuration;
  91. return $_configuration['db_glue'];
  92. }
  93. /**
  94. * Returns the database prefix.
  95. * All created COURSE databases are prefixed with this string.
  96. *
  97. * TIP: This can be convenient e.g. if you have multiple system installations
  98. * on the same physical server.
  99. */
  100. public static function get_database_name_prefix() {
  101. global $_configuration;
  102. return $_configuration['db_prefix'];
  103. }
  104. /**
  105. * Returns the course table prefix for single database.
  106. * Not certain exactly when this is used.
  107. * Do research.
  108. * It's used in local.inc.php.
  109. */
  110. public static function get_course_table_prefix() {
  111. global $_configuration;
  112. return $_configuration['table_prefix'];
  113. }
  114. /*
  115. Table name methods
  116. Use these methods to get table names for queries,
  117. instead of constructing them yourself.
  118. Backticks automatically surround the result,
  119. e.g. `COURSE_NAME`.`link`
  120. so the queries can look cleaner.
  121. Example:
  122. $table = Database::get_course_table(TABLE_DOCUMENT);
  123. $sql_query = "SELECT * FROM $table WHERE $condition";
  124. $sql_result = Database::query($sql_query);
  125. $result = Database::fetch_array($sql_result);
  126. */
  127. /**
  128. * A more generic method than the other get_main_xxx_table methods,
  129. * This one returns the correct complete name of any table of the main database of which you pass
  130. * the short name as a parameter.
  131. * Please, define table names as constants in this library and use them
  132. * instead of directly using magic words in your tool code.
  133. *
  134. * @param string $short_table_name, the name of the table
  135. */
  136. public static function get_main_table($short_table_name) {
  137. return self::format_table_name(self::get_main_database(), $short_table_name);
  138. }
  139. /**
  140. * A more generic method than the older get_course_xxx_table methods,
  141. * This one can return the correct complete name of any course table of which you pass
  142. * the short name as a parameter.
  143. * Please, define table names as constants in this library and use them
  144. * instead of directly using magic words in your tool code.
  145. *
  146. * @param string $short_table_name, the name of the table
  147. * @param string $database_name, optional, name of the course database
  148. * - if you don't specify this, you work on the current course.
  149. */
  150. public static function get_course_table($short_table_name, $database_name = '') {
  151. return self::format_glued_course_table_name(self::fix_database_parameter($database_name), $short_table_name);
  152. }
  153. /**
  154. * This generic method returns the correct and complete name of any statistic table
  155. * of which you pass the short name as a parameter.
  156. * Please, define table names as constants in this library and use them
  157. * instead of directly using magic words in your tool code.
  158. *
  159. * @param string $short_table_name, the name of the table
  160. */
  161. public static function get_statistic_table($short_table_name) {
  162. return self::format_table_name(self::get_statistic_database(), $short_table_name);
  163. }
  164. /**
  165. * This generic method returns the correct and complete name of any scorm
  166. * table of which you pass the short name as a parameter. Please, define
  167. * table names as constants in this library and use them instead of directly
  168. * using magic words in your tool code.
  169. *
  170. * @param string $short_table_name, the name of the table
  171. */
  172. public static function get_user_personal_table($short_table_name) {
  173. return self::format_table_name(self::get_user_personal_database(), $short_table_name);
  174. }
  175. public static function get_course_chat_connected_table($database_name = '') {
  176. return self::format_glued_course_table_name(self::fix_database_parameter($database_name), TABLE_CHAT_CONNECTED);
  177. }
  178. /*
  179. Query methods
  180. These methods execute a query and return the result(s).
  181. */
  182. /**
  183. * @return a list (array) of all courses.
  184. * @todo shouldn't this be in the course.lib.php script?
  185. */
  186. public static function get_course_list() {
  187. $table = self::get_main_table(TABLE_MAIN_COURSE);
  188. return self::store_result(self::query("SELECT * FROM $table"));
  189. }
  190. /**
  191. * Returns an array with all database fields for the specified course.
  192. *
  193. * @param the real (system) code of the course (ID from inside the main course table)
  194. * @todo shouldn't this be in the course.lib.php script?
  195. */
  196. public static function get_course_info($course_code) {
  197. $course_code = self::escape_string($course_code);
  198. $table = self::get_main_table(TABLE_MAIN_COURSE);
  199. $result = self::generate_abstract_course_field_names(
  200. self::fetch_array(self::query("SELECT * FROM $table WHERE `code` = '$course_code'")));
  201. return $result === false ? array('db_name' => '') : $result;
  202. }
  203. /**
  204. * @param $user_id (integer): the id of the user
  205. * @return $user_info (array): user_id, lastname, firstname, username, email, ...
  206. * @author Patrick Cool <patrick.cool@UGent.be>, expanded to get info for any user
  207. * @author Roan Embrechts, first version + converted to Database API
  208. * @version 30 September 2004
  209. * @desc find all the information about a specified user. Without parameter this is the current user.
  210. * @todo shouldn't this be in the user.lib.php script?
  211. */
  212. public static function get_user_info_from_id($user_id = '') {
  213. if (empty($user_id)) {
  214. return $GLOBALS['_user'];
  215. }
  216. $table = self::get_main_table(TABLE_MAIN_USER);
  217. $user_id = self::escape_string($user_id);
  218. return self::generate_abstract_user_field_names(
  219. self::fetch_array(self::query("SELECT * FROM $table WHERE user_id = '$user_id'")));
  220. }
  221. /**
  222. * Returns course code from a given gradebook category's id
  223. * @param int Category ID
  224. * @return string Course code
  225. * @todo move this function in a gradebook-related library
  226. */
  227. public static function get_course_by_category($category_id) {
  228. $category_id = intval($category_id);
  229. $info = self::fetch_array(self::query('SELECT course_code FROM '.self::get_main_table(TABLE_MAIN_GRADEBOOK_CATEGORY).' WHERE id='.$category_id), 'ASSOC');
  230. return $info ? $info['course_code'] : false;
  231. }
  232. /**
  233. * This method creates an abstraction layer between database field names
  234. * and field names expected in code.
  235. *
  236. * This approach helps when changing database names.
  237. * It's also useful now to get rid of the 'franglais'.
  238. *
  239. * @todo add more array entries to abstract course info from field names
  240. * @author Roan Embrechts
  241. *
  242. * @todo What's the use of this method. I think this is better removed.
  243. * There should be consistency in the variable names and the use throughout the scripts
  244. * for the database name we should consistently use or db_name or database (db_name probably being the better one)
  245. */
  246. public static function generate_abstract_course_field_names($result_array) {
  247. $visual_code = isset($result_array['visual_code']) ? $result_array['visual_code'] : null;
  248. $code = isset($result_array['code']) ? $result_array['code'] : null;
  249. $title = isset($result_array['title']) ? $result_array['title'] : null;
  250. $db_name = isset($result_array['db_name']) ? $result_array['db_name'] : null;
  251. $category_code = isset($result_array['category_code']) ? $result_array['category_code'] : null;
  252. $result_array['official_code'] = $visual_code;
  253. $result_array['visual_code'] = $visual_code;
  254. $result_array['real_code'] = $code;
  255. $result_array['system_code'] = $code;
  256. $result_array['title'] = $title;
  257. $result_array['database'] = $db_name;
  258. $result_array['faculty'] = $category_code;
  259. //$result_array['directory'] = $result_array['directory'];
  260. /*
  261. still to do: (info taken from local.inc.php)
  262. $_course['id' ] = $cData['cours_id' ]; //auto-assigned integer
  263. $_course['name' ] = $cData['title' ];
  264. $_course['official_code'] = $cData['visual_code' ]; // use in echo
  265. $_course['sysCode' ] = $cData['code' ]; // use as key in db
  266. $_course['path' ] = $cData['directory' ]; // use as key in path
  267. $_course['dbName' ] = $cData['db_name' ]; // use as key in db list
  268. $_course['dbNameGlu' ] = $_configuration['table_prefix'] . $cData['dbName'] . $_configuration['db_glue']; // use in all queries
  269. $_course['titular' ] = $cData['tutor_name' ];
  270. $_course['language' ] = $cData['course_language' ];
  271. $_course['extLink' ]['url' ] = $cData['department_url' ];
  272. $_course['extLink' ]['name'] = $cData['department_name'];
  273. $_course['categoryCode'] = $cData['faCode' ];
  274. $_course['categoryName'] = $cData['faName' ];
  275. $_course['visibility' ] = (bool) ($cData['visibility'] == 2 || $cData['visibility'] == 3);
  276. $_course['registrationAllowed'] = (bool) ($cData['visibility'] == 1 || $cData['visibility'] == 2);
  277. */
  278. return $result_array;
  279. }
  280. /**
  281. * This method creates an abstraction layer between database field names
  282. * and field names expected in code.
  283. *
  284. * This helps when changing database names.
  285. * It's also useful now to get rid of the 'franglais'.
  286. *
  287. * @todo add more array entries to abstract user info from field names
  288. * @author Roan Embrechts
  289. * @author Patrick Cool
  290. *
  291. * @todo what's the use of this function. I think this is better removed.
  292. * There should be consistency in the variable names and the use throughout the scripts
  293. */
  294. public static function generate_abstract_user_field_names($result_array) {
  295. $result_array['firstName'] = $result_array['firstname'];
  296. $result_array['lastName'] = $result_array['lastname'];
  297. $result_array['mail'] = $result_array['email'];
  298. #$result_array['picture_uri'] = $result_array['picture_uri'];
  299. #$result_array ['user_id'] = $result_array['user_id'];
  300. return $result_array;
  301. }
  302. /**
  303. * Counts the number of rows in a table
  304. * @param string $table The table of which the rows should be counted
  305. * @return int The number of rows in the given table.
  306. */
  307. public static function count_rows($table) {
  308. $obj = self::fetch_object(self::query("SELECT COUNT(*) AS n FROM $table"));
  309. return $obj->n;
  310. }
  311. /*
  312. An intermediate API-layer between the system and the dabase server.
  313. */
  314. /**
  315. * Returns the number of affected rows in the last database operation.
  316. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  317. * @return int Returns the number of affected rows on success, and -1 if the last query failed.
  318. */
  319. public static function affected_rows($connection = null) {
  320. global $database_connection;
  321. return $database_connection->affected_rows;
  322. }
  323. /**
  324. * Closes non-persistent database connection.
  325. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  326. * @return bool Returns TRUE on success or FALSE on failure.
  327. */
  328. public static function close($connection = null) {
  329. return self::use_default_connection($connection) ? mysqli::close() : mysqli::close($connection);
  330. }
  331. /**
  332. * Opens a connection to a database server.
  333. * @param array $parameters (optional) An array that contains the necessary parameters for accessing the server.
  334. * @return resource/boolean Returns a database connection on success or FALSE on failure.
  335. * Note: Currently the array could contain MySQL-specific parameters:
  336. * $parameters['server'], $parameters['username'], $parameters['password'],
  337. * $parameters['new_link'], $parameters['client_flags'], $parameters['persistent'].
  338. * For details see documentation about the functions mysql_connect() and mysql_pconnect().
  339. * @link http://php.net/manual/en/function.mysql-connect.php
  340. * @link http://php.net/manual/en/function.mysql-pconnect.php
  341. */
  342. public static function connect($parameters = array()) {
  343. global $database_connection;
  344. // A MySQL-specific implementation.
  345. if (!isset($parameters['server'])) {
  346. $parameters['server'] = @ini_get('mysqli.default_host');
  347. if (empty($parameters['server'])) {
  348. $parameters['server'] = 'localhost:3306';
  349. }
  350. }
  351. if (!isset($parameters['username'])) {
  352. $parameters['username'] = @ini_get('mysqli.default_user');
  353. }
  354. if (!isset($parameters['password'])) {
  355. $parameters['password'] = @ini_get('mysqli.default_pw');
  356. }
  357. $database_connection = $parameters['persistent']
  358. ? new mysqli('p:'.$parameters['server'], $parameters['username'], $parameters['password'])
  359. : new mysqli($parameters['server'], $parameters['username'], $parameters['password']);
  360. if ($database_connection->connect_errno) {
  361. error_log($database_connection->connect_errno());
  362. return false;
  363. } else {
  364. return true;
  365. }
  366. }
  367. /**
  368. * Returns the error number from the last operation done on the database server.
  369. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  370. * @return int Returns the error number from the last database (operation, or 0 (zero) if no error occurred.
  371. */
  372. public static function errno($connection = null) {
  373. return self::use_default_connection($connection) ? mysqli::mysqli_errno() : mysqli::mysqli_errno($connection);
  374. }
  375. /**
  376. * Returns the error text from the last operation done on the database server.
  377. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  378. * @return string Returns the error text from the last database operation, or '' (empty string) if no error occurred.
  379. */
  380. public static function error($connection = null) {
  381. return self::use_default_connection($connection) ? mysqli::mysqli_error() : mysqli::mysqli_error($connection);
  382. }
  383. /**
  384. * Escapes a string to insert into the database as text
  385. * @param string The string to escape
  386. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  387. * @return string The escaped string
  388. * @author Yannick Warnier <yannick.warnier@dokeos.com>
  389. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  390. */
  391. public static function escape_string($string, $connection = null) {
  392. global $database_connection;
  393. return get_magic_quotes_gpc()
  394. ? ( $database_connection->escape_string(stripslashes($string)))
  395. : ( $database_connection->escape_string($string));
  396. }
  397. /**
  398. * Gets the array from a SQL result (as returned by Database::query) - help achieving database independence
  399. * @param resource The result from a call to sql_query (e.g. Database::query)
  400. * @param string Optional: "ASSOC","NUM" or "BOTH", as the constant used in mysqli_fetch_array.
  401. * @return array Array of results as returned by php
  402. * @author Yannick Warnier <yannick.warnier@beeznest.com>
  403. */
  404. public static function fetch_array($result, $option = 'BOTH') {
  405. return ($option == 'ASSOC') ? $result->fetch_array(MYSQLI_ASSOC) : ($option == 'NUM' ? $result->fetch_array(MYSQLI_NUM) : $result->fetch_array());
  406. }
  407. /**
  408. * Gets an associative array from a SQL result (as returned by Database::query).
  409. * This method is equivalent to calling Database::fetch_array() with 'ASSOC' value for the optional second parameter.
  410. * @param resource $result The result from a call to sql_query (e.g. Database::query).
  411. * @return array Returns an associative array that corresponds to the fetched row and moves the internal data pointer ahead.
  412. */
  413. public static function fetch_assoc($result) {
  414. return $result->fetch_assoc();
  415. }
  416. /**
  417. * Gets the next row of the result of the SQL query (as returned by Database::query) in an object form
  418. * @param resource The result from a call to sql_query (e.g. Database::query)
  419. * @param string Optional class name to instanciate
  420. * @param array Optional array of parameters
  421. * @return object Object of class StdClass or the required class, containing the query result row
  422. * @author Yannick Warnier <yannick.warnier@dokeos.com>
  423. */
  424. public static function fetch_object($result, $class = null, $params = null) {
  425. return !empty($class) ? (is_array($params) ? $result->fetch_object($class, $params) : $result->fetch_object($class)) : $result->fetch_object();
  426. }
  427. /**
  428. * Gets the array from a SQL result (as returned by Database::query) - help achieving database independence
  429. * @param resource The result from a call to sql_query (see Database::query()).
  430. * @return array Array of results as returned by php (mysql_fetch_row)
  431. */
  432. public static function fetch_row($result) {
  433. return $result->fetch_row();
  434. }
  435. /**
  436. * Frees all the memory associated with the provided result identifier.
  437. * @return bool Returns TRUE on success or FALSE on failure.
  438. * Notes: Use this method if you are concerned about how much memory is being used for queries that return large result sets.
  439. * Anyway, all associated result memory is automatically freed at the end of the script's execution.
  440. */
  441. public static function free_result($result) {
  442. return $result->free_result();
  443. }
  444. /**
  445. * Returns the database client library version.
  446. * @return strung Returns a string that represents the client library version.
  447. */
  448. public function get_client_info() {
  449. return mysqli_get_client_info();
  450. }
  451. /**
  452. * Returns a list of databases created on the server. The list may contain all of the
  453. * available database names or filtered database names by using a pattern.
  454. * @param string $pattern (optional) A pattern for filtering database names as if it was needed for the SQL's LIKE clause, for example 'chamilo_%'.
  455. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  456. * @return array Returns in an array the retrieved list of database names.
  457. */
  458. public static function get_databases($pattern = '', $connection = null) {
  459. $result = array();
  460. $query_result = Database::query(!empty($pattern) ? "SHOW DATABASES LIKE '".self::escape_string($pattern, $connection)."'" : "SHOW DATABASES", $connection);
  461. while ($row = Database::fetch_row($query_result)) {
  462. $result[] = $row[0];
  463. }
  464. return $result;
  465. }
  466. /**
  467. * 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.
  468. * By using a special option, this method is able to return an indexed list of fields' properties, where field names are keys.
  469. * @param string $table This is the examined table.
  470. * @param string $pattern (optional) A pattern for filtering field names as if it was needed for the SQL's LIKE clause, for example 'column_%'.
  471. * @param string $database (optional) The name of the targeted database. If it is omited, the current database is assumed, see Database::select_db().
  472. * @param bool $including_properties (optional) When this option is true, the returned result has the followong format:
  473. * array(field_name_1 => array(0 => property_1, 1 => property_2, ...), fieald_name_2 => array(0 => property_1, ...), ...)
  474. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  475. * @return array Returns in an array the retrieved list of field names.
  476. */
  477. public static function get_fields($table, $pattern = '', $database = '', $including_properties = false, $connection = null) {
  478. $result = array();
  479. $query = "SHOW COLUMNS FROM `".self::escape_string($table, $connection)."`";
  480. if (!empty($database)) {
  481. $query .= " FROM `".self::escape_string($database, $connection)."`";
  482. }
  483. if (!empty($pattern)) {
  484. $query .= " LIKE '".self::escape_string($pattern, $connection)."'";
  485. }
  486. $query_result = Database::query($query, $connection);
  487. if ($including_properties) {
  488. // Making an indexed list of the fields and their properties.
  489. while ($row = Database::fetch_row($query_result)) {
  490. $result[$row[0]] = $row;
  491. }
  492. } else {
  493. // Making a plain, flat list.
  494. while ($row = Database::fetch_row($query_result)) {
  495. $result[] = $row[0];
  496. }
  497. }
  498. return $result;
  499. }
  500. /**
  501. * Returns information about the type of the current connection and the server host name.
  502. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  503. * @return string/boolean Returns string data on success or FALSE on failure.
  504. */
  505. public function get_host_info($connection = null) {
  506. return self::use_default_connection($connection) ? mysqli::mysqli_get_host_info() : mysqli::mysqli_get_host_info($connection);
  507. }
  508. /**
  509. * Retrieves database client/server protocol version.
  510. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  511. * @return int/boolean Returns the protocol version on success or FALSE on failure.
  512. */
  513. public function get_proto_info($connection = null) {
  514. return self::use_default_connection($connection) ? mysqli::mysqli_get_proto_info() : mysqli::mysqli_get_proto_info($connection);
  515. }
  516. /**
  517. * Retrieves the database server version.
  518. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  519. * @return string/boolean Returns the MySQL server version on success or FALSE on failure.
  520. */
  521. public function get_server_info($connection = null) {
  522. return self::use_default_connection($connection) ? mysqli::mysqli_get_server_info() : mysqli::mysqli_get_server_info($connection);
  523. }
  524. /**
  525. * Returns a list of tables within a database. The list may contain all of the
  526. * available table names or filtered table names by using a pattern.
  527. * @param string $database (optional) The name of the examined database. If it is omited, the current database is assumed, see Database::select_db().
  528. * @param string $pattern (optional) A pattern for filtering table names as if it was needed for the SQL's LIKE clause, for example 'access_%'.
  529. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  530. * @return array Returns in an array the retrieved list of table names.
  531. */
  532. public static function get_tables($database = '', $pattern = '', $connection = null) {
  533. $result = array();
  534. $query = "SHOW TABLES";
  535. if (!empty($database)) {
  536. $query .= " FROM `".self::escape_string($database, $connection)."`";
  537. }
  538. if (!empty($pattern)) {
  539. $query .= " LIKE '".self::escape_string($pattern, $connection)."'";
  540. }
  541. $query_result = Database::query($query, $connection);
  542. while ($row = Database::fetch_row($query_result)) {
  543. $result[] = $row[0];
  544. }
  545. return $result;
  546. }
  547. /**
  548. * Gets the ID of the last item inserted into the database
  549. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  550. * @return int The last ID as returned by the DB function
  551. * @comment This should be updated to use ADODB at some point
  552. */
  553. public static function insert_id($connection = null) {
  554. global $database_connection;
  555. return $database_connection->insert_id;
  556. }
  557. /**
  558. * Gets the number of rows from the last query result - help achieving database independence
  559. * @param resource The result
  560. * @return integer The number of rows contained in this result
  561. * @author Yannick Warnier <yannick.warnier@dokeos.com>
  562. **/
  563. public static function num_rows($result) {
  564. return is_a($result,'mysqli_result') ? $result->num_rows : false;
  565. }
  566. /**
  567. * Acts as the relative *_result() function of most DB drivers and fetches a
  568. * specific line and a field
  569. * @param resource The database resource to get data from
  570. * @param integer The row number
  571. * @param string Optional field name or number
  572. * @result mixed One cell of the result, or FALSE on error
  573. */
  574. public static function result(&$resource, $row, $field = '') {
  575. if (self::num_rows($resource) > 0) {
  576. if (!empty($field)) {
  577. $r = mysqli_data_seek($resource, $row);
  578. return $r[$field];
  579. } else {
  580. return mysqli_data_seek($resource, $row);
  581. }
  582. } else { return null; }
  583. }
  584. /**
  585. * This method returns a resource
  586. * Documentation has been added by Arthur Portugal
  587. * Some adaptations have been implemented by Ivan Tcholakov, 2009, 2010
  588. * @author Olivier Brouckaert
  589. * @param string $query The SQL query
  590. * @param resource $connection (optional) The database server (MySQL) connection.
  591. * If it is not specified, the connection opened by mysql_connect() is assumed.
  592. * If no connection is found, the server will try to create one as if mysql_connect() was called with no arguments.
  593. * If no connection is found or established, an E_WARNING level error is generated.
  594. * @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)
  595. * @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)
  596. * @return resource The returned result from the query
  597. * Note: The parameter $connection could be skipped. Here are examples of this method usage:
  598. * Database::query($query);
  599. * $result = Database::query($query);
  600. * Database::query($query, $connection);
  601. * $result = Database::query($query, $connection);
  602. * The following ways for calling this method are obsolete:
  603. * Database::query($query, __FILE__, __LINE__);
  604. * $result = Database::query($query, __FILE__, __LINE__);
  605. * Database::query($query, $connection, __FILE__, __LINE__);
  606. * $result = Database::query($query, $connection, __FILE__, __LINE__);
  607. */
  608. public static function query($query, $connection = null, $file = null, $line = null) {
  609. global $database_connection;
  610. $result = @$database_connection->query($query);
  611. if ($database_connection->errno) {
  612. $backtrace = debug_backtrace(); // Retrieving information about the caller statement.
  613. if (isset($backtrace[0])) {
  614. $caller = & $backtrace[0];
  615. } else {
  616. $caller = array();
  617. }
  618. if (isset($backtrace[1])) {
  619. $owner = & $backtrace[1];
  620. } else {
  621. $owner = array();
  622. }
  623. if (empty($file)) {
  624. $file = $caller['file'];
  625. }
  626. if (empty($line) && $line !== false) {
  627. $line = $caller['line'];
  628. }
  629. $type = $owner['type'];
  630. $function = $owner['function'];
  631. $class = $owner['class'];
  632. $server_type = api_get_setting('server_type');
  633. if (!empty($line) && !empty($server_type) && $server_type != 'production') {
  634. $info = '<pre>' .
  635. '<strong>DATABASE ERROR #'.self::errno($connection).':</strong><br /> ' .
  636. self::remove_XSS(self::error($connection)) . '<br />' .
  637. '<strong>QUERY :</strong><br /> ' .
  638. self::remove_XSS($query) . '<br />' .
  639. '<strong>FILE :</strong><br /> ' .
  640. (empty($file) ? ' unknown ' : $file) . '<br />' .
  641. '<strong>LINE :</strong><br /> ' .
  642. (empty($line) ? ' unknown ' : $line) . '<br />';
  643. if (empty($type)) {
  644. if (!empty($function)) {
  645. $info .= '<strong>FUNCTION :</strong><br /> ' . $function;
  646. }
  647. } else {
  648. if (!empty($class) && !empty($function)) {
  649. $info .= '<strong>CLASS :</strong><br /> ' . $class . '<br />';
  650. $info .= '<strong>METHOD :</strong><br /> ' . $function;
  651. }
  652. }
  653. $info .= '</pre>';
  654. echo $info;
  655. }
  656. if (isset(self::$log_queries) && self::$log_queries) {
  657. error_log("---------------- SQL error ---------------- ");
  658. error_log($query);
  659. error_log('error #'.self::errno($connection));
  660. error_log('error: '.self::error($connection));
  661. $info = 'FILE: ' .(empty($file) ? ' unknown ' : $file);
  662. error_log($info);
  663. $info = 'LINE: '.(empty($line) ? ' unknown ' : $line);
  664. error_log($info);
  665. if (empty($type)) {
  666. if (!empty($function)) {
  667. $info = 'FUNCTION: ' . $function;
  668. error_log($info);
  669. }
  670. } else {
  671. if (!empty($class) && !empty($function)) {
  672. $info .= 'CLASS: ' . $class;
  673. error_log($info);
  674. $info .= 'METHOD: ' . $function;
  675. error_log($info);
  676. }
  677. }
  678. error_log("---------------- end ----------------");
  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. static 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) && $clean_values != '') {
  1054. $condition = str_replace('%',"'@percentage@'", $condition); //replace "%"
  1055. $condition = str_replace("'?'","%s", $condition);
  1056. $condition = str_replace("?","%s", $condition);
  1057. $condition = str_replace("@%s@","@-@", $condition);
  1058. $condition = str_replace("%s","'%s'", $condition);
  1059. $condition = str_replace("@-@","@%s@", $condition);
  1060. //Treat conditons as string
  1061. $condition = vsprintf($condition, $clean_values);
  1062. $condition = str_replace('@percentage@','%', $condition); //replace "%"
  1063. $where_return .= $condition;
  1064. }
  1065. }
  1066. if (!empty($where_return)) {
  1067. $return_value = " WHERE $where_return" ;
  1068. }
  1069. break;
  1070. case 'order':
  1071. $order_array = $condition_data;
  1072. if (!empty($order_array)) {
  1073. // 'order' => 'id desc, name desc'
  1074. $order_array = self::escape_string($order_array);
  1075. $new_order_array = explode(',', $order_array);
  1076. $temp_value = array();
  1077. foreach($new_order_array as $element) {
  1078. $element = explode(' ', $element);
  1079. $element = array_filter($element);
  1080. $element = array_values($element);
  1081. if (!empty($element[1])) {
  1082. $element[1] = strtolower($element[1]);
  1083. $order = 'DESC';
  1084. if (in_array($element[1], array('desc', 'asc'))) {
  1085. $order = $element[1];
  1086. }
  1087. $temp_value[]= $element[0].' '.$order.' ';
  1088. } else {
  1089. //by default DESC
  1090. $temp_value[]= $element[0].' DESC ';
  1091. }
  1092. }
  1093. if (!empty($temp_value)) {
  1094. $return_value .= ' ORDER BY '.implode(', ', $temp_value);
  1095. } else {
  1096. //$return_value .= '';
  1097. }
  1098. }
  1099. break;
  1100. case 'limit':
  1101. $limit_array = explode(',', $condition_data);
  1102. if (!empty($limit_array)) {
  1103. if (count($limit_array) > 1) {
  1104. $return_value .= ' LIMIT '.intval($limit_array[0]).' , '.intval($limit_array[1]);
  1105. } else {
  1106. $return_value .= ' LIMIT '.intval($limit_array[0]);
  1107. }
  1108. }
  1109. break;
  1110. }
  1111. }
  1112. return $return_value;
  1113. }
  1114. public static function parse_where_conditions($coditions){
  1115. return self::parse_conditions(array('where'=>$coditions));
  1116. }
  1117. /**
  1118. * Experimental useful database update
  1119. * @todo lot of stuff to do here
  1120. */
  1121. public static function delete($table_name, $where_conditions) {
  1122. $result = false;
  1123. $where_return = self::parse_where_conditions($where_conditions);
  1124. $sql = "DELETE FROM $table_name $where_return ";
  1125. $result = self::query($sql);
  1126. $affected_rows = self::affected_rows();
  1127. //@todo should return affected_rows for
  1128. return $affected_rows;
  1129. }
  1130. /**
  1131. * Experimental useful database update
  1132. * @todo lot of stuff to do here
  1133. */
  1134. public static function update($table_name, $attributes, $where_conditions = array()) {
  1135. if (!empty($table_name) && !empty($attributes)) {
  1136. $update_sql = '';
  1137. //Cleaning attributes
  1138. $count = 1;
  1139. foreach ($attributes as $key=>$value) {
  1140. $value = self::escape_string($value);
  1141. $update_sql .= "$key = '$value' ";
  1142. if ($count < count($attributes)) {
  1143. $update_sql.=', ';
  1144. }
  1145. $count++;
  1146. }
  1147. if (!empty($update_sql)) {
  1148. //Parsing and cleaning the where conditions
  1149. $where_return = self::parse_where_conditions($where_conditions);
  1150. $sql = "UPDATE $table_name SET $update_sql $where_return ";
  1151. //echo $sql; exit;
  1152. $result = self::query($sql);
  1153. $affected_rows = self::affected_rows();
  1154. return $affected_rows;
  1155. }
  1156. }
  1157. return false;
  1158. }
  1159. /*
  1160. DEPRECATED METHODS
  1161. */
  1162. /**
  1163. * @deprecated Use api_get_language_isocode($language) instead.
  1164. */
  1165. public static function get_language_isocode($language) {
  1166. return api_get_language_isocode($language);
  1167. }
  1168. /**
  1169. * @deprecated Use Database::insert_id() instead.
  1170. */
  1171. public static function get_last_insert_id() {
  1172. global $database_connection;
  1173. return $database_connection->insert_id($database_connection);
  1174. }
  1175. }
  1176. //end class Database