database.lib.php 55 KB

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