database.lib.php 59 KB

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