database.mysqli.lib.php 56 KB

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