database.lib.php 53 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317
  1. <?php // $Id: database.lib.php 22265 2009-07-20 23:26:43Z juliomontoya $
  2. /* See license terms in /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 Dokeos
  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. // Main database tables
  17. define('TABLE_MAIN_COURSE', 'course');
  18. define('TABLE_MAIN_USER', 'user');
  19. define('TABLE_MAIN_CLASS', 'class');
  20. define('TABLE_MAIN_ADMIN', 'admin');
  21. define('TABLE_MAIN_COURSE_CLASS', 'course_rel_class');
  22. define('TABLE_MAIN_COURSE_USER', 'course_rel_user');
  23. define('TABLE_MAIN_CLASS_USER', 'class_user');
  24. define('TABLE_MAIN_CATEGORY', 'course_category');
  25. define('TABLE_MAIN_COURSE_MODULE', 'course_module');
  26. define('TABLE_MAIN_SYSTEM_ANNOUNCEMENTS', 'sys_announcement');
  27. define('TABLE_MAIN_LANGUAGE', 'language');
  28. define('TABLE_MAIN_SETTINGS_OPTIONS', 'settings_options');
  29. define('TABLE_MAIN_SETTINGS_CURRENT', 'settings_current');
  30. define('TABLE_MAIN_SESSION', 'session');
  31. define('TABLE_MAIN_SESSION_CATEGORY', 'session_category');
  32. define('TABLE_MAIN_SESSION_COURSE', 'session_rel_course');
  33. define('TABLE_MAIN_SESSION_USER', 'session_rel_user');
  34. define('TABLE_MAIN_SESSION_CLASS', 'session_rel_class');
  35. define('TABLE_MAIN_SESSION_COURSE_USER', 'session_rel_course_rel_user');
  36. define('TABLE_MAIN_SHARED_SURVEY', 'shared_survey');
  37. define('TABLE_MAIN_SHARED_SURVEY_QUESTION', 'shared_survey_question');
  38. define('TABLE_MAIN_SHARED_SURVEY_QUESTION_OPTION', 'shared_survey_question_option');
  39. define('TABLE_MAIN_TEMPLATES', 'templates');
  40. define('TABLE_MAIN_SYSTEM_TEMPLATE', 'system_template');
  41. define('TABLE_MAIN_OPENID_ASSOCIATION', 'openid_association');
  42. // Gradebook
  43. define('TABLE_MAIN_GRADEBOOK_CATEGORY', 'gradebook_category');
  44. define('TABLE_MAIN_GRADEBOOK_EVALUATION', 'gradebook_evaluation');
  45. define('TABLE_MAIN_GRADEBOOK_LINKEVAL_LOG', 'gradebook_linkeval_log');
  46. define('TABLE_MAIN_GRADEBOOK_RESULT', 'gradebook_result');
  47. define('TABLE_MAIN_GRADEBOOK_RESULT_LOG', 'gradebook_result_log');
  48. define('TABLE_MAIN_GRADEBOOK_LINK', 'gradebook_link');
  49. define('TABLE_MAIN_GRADEBOOK_SCORE_DISPLAY','gradebook_score_display');
  50. define('TABLE_MAIN_GRADEBOOK_CERTIFICATE', 'gradebook_certificate');
  51. //Profiling
  52. define('TABLE_MAIN_USER_FIELD', 'user_field');
  53. define('TABLE_MAIN_USER_FIELD_OPTIONS', 'user_field_options');
  54. define('TABLE_MAIN_USER_FIELD_VALUES', 'user_field_values');
  55. //User tags
  56. define('TABLE_MAIN_TAG', 'tag');
  57. define('TABLE_MAIN_USER_REL_TAG', 'user_rel_tag');
  58. //User groups
  59. define('TABLE_MAIN_GROUP', 'groups');
  60. define('TABLE_MAIN_USER_REL_GROUP', 'group_rel_user');
  61. define('TABLE_MAIN_GROUP_REL_TAG', 'group_rel_tag');
  62. // Search engine
  63. define('TABLE_MAIN_SPECIFIC_FIELD', 'specific_field');
  64. define('TABLE_MAIN_SPECIFIC_FIELD_VALUES', 'specific_field_values');
  65. define('TABLE_MAIN_SEARCH_ENGINE_REF', 'search_engine_ref');
  66. // Access URLs
  67. define('TABLE_MAIN_ACCESS_URL', 'access_url');
  68. define('TABLE_MAIN_ACCESS_URL_REL_USER', 'access_url_rel_user');
  69. define('TABLE_MAIN_ACCESS_URL_REL_COURSE', 'access_url_rel_course');
  70. define('TABLE_MAIN_ACCESS_URL_REL_SESSION', 'access_url_rel_session');
  71. // Global calendar
  72. define('TABLE_MAIN_SYSTEM_CALENDAR', 'sys_calendar');
  73. // Reservation System
  74. define('TABLE_MAIN_RESERVATION_ITEM', 'reservation_item');
  75. define('TABLE_MAIN_RESERVATION_RESERVATION', 'reservation_main');
  76. define('TABLE_MAIN_RESERVATION_SUBSCRIBTION', 'reservation_subscription');
  77. define('TABLE_MAIN_RESERVATION_CATEGORY', 'reservation_category');
  78. define('TABLE_MAIN_RESERVATION_ITEM_RIGHTS', 'reservation_item_rights');
  79. // Social networking
  80. define('TABLE_MAIN_USER_REL_USER', 'user_rel_user');
  81. define('TABLE_MAIN_USER_FRIEND_RELATION_TYPE', 'user_friend_relation_type');
  82. // Web services
  83. define('TABLE_MAIN_USER_API_KEY', 'user_api_key');
  84. define('TABLE_MAIN_COURSE_FIELD', 'course_field');
  85. define('TABLE_MAIN_COURSE_FIELD_VALUES', 'course_field_values');
  86. define('TABLE_MAIN_SESSION_FIELD', 'session_field');
  87. define('TABLE_MAIN_SESSION_FIELD_VALUES', 'session_field_values');
  88. // Message
  89. define('TABLE_MAIN_MESSAGE', 'message');
  90. // Term and conditions
  91. define('TABLE_MAIN_LEGAL', 'legal');
  92. // Dashboard blocks plugin
  93. define('TABLE_MAIN_BLOCK', 'block');
  94. // Statistic database tables
  95. define('TABLE_STATISTIC_TRACK_E_LASTACCESS', 'track_e_lastaccess');
  96. define('TABLE_STATISTIC_TRACK_E_ACCESS', 'track_e_access');
  97. define('TABLE_STATISTIC_TRACK_E_LOGIN', 'track_e_login');
  98. define('TABLE_STATISTIC_TRACK_E_DOWNLOADS', 'track_e_downloads');
  99. define('TABLE_STATISTIC_TRACK_E_LINKS', 'track_e_links');
  100. define('TABLE_STATISTIC_TRACK_E_ONLINE', 'track_e_online');
  101. define('TABLE_STATISTIC_TRACK_E_HOTPOTATOES', 'track_e_hotpotatoes');
  102. define('TABLE_STATISTIC_TRACK_E_COURSE_ACCESS', 'track_e_course_access');
  103. define('TABLE_STATISTIC_TRACK_E_EXERCICES', 'track_e_exercices');
  104. define('TABLE_STATISTIC_TRACK_E_ATTEMPT', 'track_e_attempt');
  105. define('TABLE_STATISTIC_TRACK_E_ATTEMPT_RECORDING', 'track_e_attempt_recording');
  106. define('TABLE_STATISTIC_TRACK_E_DEFAULT', 'track_e_default');
  107. define('TABLE_STATISTIC_TRACK_E_UPLOADS', 'track_e_uploads');
  108. define('TABLE_STATISTIC_TRACK_E_HOTSPOT', 'track_e_hotspot');
  109. define('TABLE_STATISTIC_TRACK_E_ITEM_PROPERTY', 'track_e_item_property');
  110. // SCORM database tables
  111. define('TABLE_SCORM_MAIN', 'scorm_main');
  112. define('TABLE_SCORM_SCO_DATA', 'scorm_sco_data');
  113. // Course tables
  114. define('TABLE_AGENDA', 'calendar_event');
  115. define('TABLE_AGENDA_REPEAT', 'calendar_event_repeat');
  116. define('TABLE_AGENDA_REPEAT_NOT', 'calendar_event_repeat_not');
  117. define('TABLE_AGENDA_ATTACHMENT', 'calendar_event_attachment');
  118. define('TABLE_ANNOUNCEMENT', 'announcement');
  119. define('TABLE_ANNOUNCEMENT_ATTACHMENT', 'announcement_attachment');
  120. define('TABLE_CHAT_CONNECTED', 'chat_connected'); // @todo: probably no longer in use !!!
  121. define('TABLE_COURSE_DESCRIPTION', 'course_description');
  122. define('TABLE_DOCUMENT', 'document');
  123. define('TABLE_ITEM_PROPERTY', 'item_property');
  124. define('TABLE_LINK', 'link');
  125. define('TABLE_LINK_CATEGORY', 'link_category');
  126. define('TABLE_TOOL_LIST', 'tool');
  127. define('TABLE_TOOL_INTRO', 'tool_intro');
  128. define('TABLE_SCORMDOC', 'scormdocument');
  129. define('TABLE_STUDENT_PUBLICATION', 'student_publication');
  130. define('TABLE_STUDENT_PUBLICATION_ASSIGNMENT', 'student_publication_assignment');
  131. define('CHAT_CONNECTED_TABLE', 'chat_connected');
  132. // Course forum tables
  133. define('TABLE_FORUM_CATEGORY', 'forum_category');
  134. define('TABLE_FORUM', 'forum_forum');
  135. define('TABLE_FORUM_THREAD', 'forum_thread');
  136. define('TABLE_FORUM_POST', 'forum_post');
  137. define('TABLE_FORUM_ATTACHMENT', 'forum_attachment');
  138. define('TABLE_FORUM_MAIL_QUEUE', 'forum_mailcue');
  139. define('TABLE_FORUM_THREAD_QUALIFY', 'forum_thread_qualify');
  140. define('TABLE_FORUM_THREAD_QUALIFY_LOG', 'forum_thread_qualify_log');
  141. define('TABLE_FORUM_NOTIFICATION', 'forum_notification');
  142. // Course group tables
  143. define('TABLE_GROUP', 'group_info');
  144. define('TABLE_GROUP_USER', 'group_rel_user');
  145. define('TABLE_GROUP_TUTOR', 'group_rel_tutor');
  146. define('TABLE_GROUP_CATEGORY', 'group_category');
  147. // Course dropbox tables
  148. define('TABLE_DROPBOX_CATEGORY','dropbox_category');
  149. define('TABLE_DROPBOX_FEEDBACK','dropbox_feedback');
  150. define('TABLE_DROPBOX_POST', 'dropbox_post');
  151. define('TABLE_DROPBOX_FILE', 'dropbox_file');
  152. define('TABLE_DROPBOX_PERSON', 'dropbox_person');
  153. // Course quiz (or test, or exercice) tables
  154. define('TABLE_QUIZ_QUESTION', 'quiz_question');
  155. define('TABLE_QUIZ_TEST', 'quiz');
  156. define('TABLE_QUIZ_ANSWER', 'quiz_answer');
  157. define('TABLE_QUIZ_TEST_QUESTION', 'quiz_rel_question');
  158. // Linked resource table
  159. define('TABLE_LINKED_RESOURCES', 'resource');
  160. // New SCORM tables
  161. define('TABLE_LP_MAIN', 'lp');
  162. define('TABLE_LP_ITEM', 'lp_item');
  163. define('TABLE_LP_VIEW', 'lp_view');
  164. define('TABLE_LP_ITEM_VIEW', 'lp_item_view');
  165. define('TABLE_LP_IV_INTERACTION', 'lp_iv_interaction'); // IV = Item View
  166. define('TABLE_LP_IV_OBJECTIVE', 'lp_iv_objective'); // IV = Item View
  167. // Smartblogs (Kevin Van Den Haute::kevin@develop-it.be)
  168. // Permission tables
  169. define('TABLE_PERMISSION_USER', 'permission_user');
  170. define('TABLE_PERMISSION_TASK', 'permission_task');
  171. define('TABLE_PERMISSION_GROUP', 'permission_group');
  172. // Role tables
  173. define('TABLE_ROLE', 'role');
  174. define('TABLE_ROLE_PERMISSION', 'role_permissions');
  175. define('TABLE_ROLE_USER', 'role_user');
  176. define('TABLE_ROLE_GROUP', 'role_group');
  177. // Blog tables
  178. define('TABLE_BLOGS', 'blog');
  179. define('TABLE_BLOGS_POSTS', 'blog_post');
  180. define('TABLE_BLOGS_COMMENTS', 'blog_comment');
  181. define('TABLE_BLOGS_REL_USER', 'blog_rel_user');
  182. define('TABLE_BLOGS_TASKS', 'blog_task');
  183. define('TABLE_BLOGS_TASKS_REL_USER', 'blog_task_rel_user');
  184. define('TABLE_BLOGS_RATING', 'blog_rating');
  185. define('TABLE_BLOGS_ATTACHMENT', 'blog_attachment');
  186. define('TABLE_BLOGS_TASKS_PERMISSIONS', 'permission_task');
  187. //end of Smartblogs
  188. // User information tables
  189. define('TABLE_USER_INFO', 'userinfo_def');
  190. define('TABLE_USER_INFO_CONTENT', 'userinfo_content');
  191. // Course settings table
  192. define('TABLE_COURSE_SETTING', 'course_setting');
  193. // Course online tables
  194. define('TABLE_ONLINE_LINK', 'online_link');
  195. define('TABLE_ONLINE_CONNECTED','online_connected');
  196. // User database
  197. define('TABLE_PERSONAL_AGENDA', 'personal_agenda');
  198. define('TABLE_PERSONAL_AGENDA_REPEAT', 'personal_agenda_repeat');
  199. define('TABLE_PERSONAL_AGENDA_REPEAT_NOT', 'personal_agenda_repeat_not');
  200. define('TABLE_USER_COURSE_CATEGORY', 'user_course_category');
  201. // Survey
  202. // @TODO: Are these MAIN tables or course tables?
  203. // @TODO: Probably these constants are obsolete.
  204. define('TABLE_MAIN_SURVEY', 'survey');
  205. define('TABLE_MAIN_SURVEYQUESTION', 'questions');
  206. // Survey
  207. define('TABLE_SURVEY', 'survey');
  208. define('TABLE_SURVEY_QUESTION', 'survey_question');
  209. define('TABLE_SURVEY_QUESTION_OPTION', 'survey_question_option');
  210. define('TABLE_SURVEY_INVITATION', 'survey_invitation');
  211. define('TABLE_SURVEY_ANSWER', 'survey_answer');
  212. define('TABLE_SURVEY_QUESTION_GROUP', 'survey_group');
  213. define('TABLE_SURVEY_REPORT', 'survey_report');
  214. // Wiki tables
  215. define('TABLE_WIKI', 'wiki');
  216. define('TABLE_WIKI_CONF', 'wiki_conf');
  217. define('TABLE_WIKI_DISCUSS', 'wiki_discuss');
  218. define('TABLE_WIKI_MAILCUE', 'wiki_mailcue');
  219. // Glossary
  220. define('TABLE_GLOSSARY', 'glossary');
  221. // Notebook
  222. define('TABLE_NOTEBOOK', 'notebook');
  223. // Message
  224. define('TABLE_MESSAGE', 'message');
  225. define('TABLE_MESSAGE_ATTACHMENT', 'message_attachment');
  226. // Metadata
  227. define('TABLE_METADATA', 'metadata');
  228. // Attendance Sheet
  229. define('TABLE_ATTENDANCE', 'attendance');
  230. define('TABLE_ATTENDANCE_CALENDAR', 'attendance_calendar');
  231. define('TABLE_ATTENDANCE_SHEET', 'attendance_sheet');
  232. define('TABLE_ATTENDANCE_RESULT', 'attendance_result');
  233. /* DATABASE CLASS
  234. the class and its functions
  235. */
  236. class Database {
  237. /*
  238. -----------------------------------------------------------------------------
  239. Accessor Functions
  240. Usually, you won't need these directly but instead
  241. rely on of the get_xxx_table functions.
  242. -----------------------------------------------------------------------------
  243. */
  244. /**
  245. * Returns the name of the main database.
  246. */
  247. public static function get_main_database() {
  248. global $_configuration;
  249. return $_configuration['main_database'];
  250. }
  251. /**
  252. * Returns the name of the statistics database.
  253. */
  254. public static function get_statistic_database() {
  255. global $_configuration;
  256. return $_configuration['statistics_database'];
  257. }
  258. /**
  259. * Returns the name of the SCORM database.
  260. * @deprecated
  261. */
  262. public static function get_scorm_database() {
  263. global $_configuration;
  264. return $_configuration['scorm_database'];
  265. }
  266. /**
  267. * Returns the name of the database where all the personal stuff of the user is stored
  268. */
  269. public static function get_user_personal_database() {
  270. global $_configuration;
  271. return $_configuration['user_personal_database'];
  272. }
  273. /**
  274. * Returns the name of the main database.
  275. */
  276. public static function get_current_course_database() {
  277. $course_info = api_get_course_info();
  278. return $course_info['dbName'];
  279. }
  280. /**
  281. * Returns the glued name of the current course database.
  282. */
  283. public static function get_current_course_glued_database() {
  284. $course_info = api_get_course_info();
  285. return $course_info['dbNameGlu'];
  286. }
  287. /**
  288. * The glue is the string needed between database and table.
  289. * The trick is: in multiple databases, this is a period (with backticks)
  290. * In single database, this can be e.g. an underscore so we just fake
  291. * there are multiple databases and the code can be written independent
  292. * of the single / multiple database setting.
  293. */
  294. public static function get_database_glue() {
  295. global $_configuration;
  296. return $_configuration['db_glue'];
  297. }
  298. /**
  299. * Returns the database prefix.
  300. * All created COURSE databases are prefixed with this string.
  301. *
  302. * TIP: This can be convenient e.g. if you have multiple system installations
  303. * on the same physical server.
  304. */
  305. public static function get_database_name_prefix() {
  306. global $_configuration;
  307. return $_configuration['db_prefix'];
  308. }
  309. /**
  310. * Returns the course table prefix for single database.
  311. * Not certain exactly when this is used.
  312. * Do research.
  313. * It's used in local.inc.php.
  314. */
  315. public static function get_course_table_prefix() {
  316. global $_configuration;
  317. return $_configuration['table_prefix'];
  318. }
  319. /*
  320. -----------------------------------------------------------------------------
  321. Table Name functions
  322. use these functions to get a table name for queries,
  323. instead of constructing them yourself.
  324. Backticks automatically surround the result,
  325. e.g. `COURSE_NAME`.`link`
  326. so the queries can look cleaner.
  327. Example:
  328. $table = Database::get_course_table(TABLE_DOCUMENT);
  329. $sql_query = "SELECT * FROM $table WHERE $condition";
  330. $sql_result = Database::query($sql_query);
  331. $result = Database::fetch_array($sql_result);
  332. -----------------------------------------------------------------------------
  333. */
  334. /**
  335. * A more generic function than the other get_main_xxx_table functions,
  336. * this one can return the correct complete name of any table of the main database of which you pass
  337. * the short name as a parameter.
  338. * Please define table names as constants in this library and use them
  339. * instead of directly using magic words in your tool code.
  340. *
  341. * @param string $short_table_name, the name of the table
  342. */
  343. public static function get_main_table($short_table_name) {
  344. return self::format_table_name(self::get_main_database(), $short_table_name);
  345. }
  346. /**
  347. * A more generic function than the older get_course_xxx_table functions,
  348. * this one can return the correct complete name of any course table of which you pass
  349. * the short name as a parameter.
  350. * Please define table names as constants in this library and use them
  351. * instead of directly using magic words in your tool code.
  352. *
  353. * @param string $short_table_name, the name of the table
  354. * @param string $database_name, optional, name of the course database
  355. * - if you don't specify this, you work on the current course.
  356. */
  357. public static function get_course_table($short_table_name, $database_name = '') {
  358. return self::format_glued_course_table_name(self::fix_database_parameter($database_name), $short_table_name);
  359. }
  360. /**
  361. * Get a complete course table name from a course code
  362. *
  363. * @param string $course_code
  364. * @param string $table the name of the table
  365. */
  366. public static function get_course_table_from_code($course_code, $table) {
  367. $course_table = self::get_main_table(TABLE_MAIN_COURSE);
  368. $course_cat_table = self::get_main_table(TABLE_MAIN_CATEGORY);
  369. $result = self::fetch_array(self::query(
  370. "SELECT $course_table.db_name, $course_cat_table.code
  371. FROM $course_table
  372. LEFT JOIN $course_cat_table
  373. ON $course_table.category_code = $course_cat_table.code
  374. WHERE $course_table.code = '$course_code'
  375. LIMIT 1"));
  376. return sprintf("%s.%s", $result[0], $table);
  377. }
  378. /**
  379. * This generic function returns the correct and complete name of any statistic table
  380. * of which you pass the short name as a parameter.
  381. * Please define table names as constants in this library and use them
  382. * instead of directly using magic words in your tool code.
  383. *
  384. * @param string $short_table_name, the name of the table
  385. */
  386. public static function get_statistic_table($short_table_name) {
  387. return self::format_table_name(self::get_statistic_database(), $short_table_name);
  388. }
  389. /**
  390. * This generic function returns the correct and complete name of any scorm
  391. * table of which you pass the short name as a parameter. Please define
  392. * table names as constants in this library and use them instead of directly
  393. * using magic words in your tool code.
  394. *
  395. * @param string $short_table_name, the name of the table
  396. */
  397. public static function get_scorm_table($short_table_name) {
  398. return self::format_table_name(self::get_scorm_database(), $short_table_name);
  399. }
  400. /**
  401. * This generic function returns the correct and complete name of any scorm
  402. * table of which you pass the short name as a parameter. Please define
  403. * table names as constants in this library and use them instead of directly
  404. * using magic words in your tool code.
  405. *
  406. * @param string $short_table_name, the name of the table
  407. */
  408. public static function get_user_personal_table($short_table_name) {
  409. return self::format_table_name(self::get_user_personal_database(), $short_table_name);
  410. }
  411. public static function get_course_chat_connected_table($database_name = '') {
  412. return self::format_glued_course_table_name(self::fix_database_parameter($database_name), CHAT_CONNECTED_TABLE);
  413. }
  414. /*
  415. -----------------------------------------------------------------------------
  416. Query Functions
  417. these execute a query and return the result(s).
  418. -----------------------------------------------------------------------------
  419. */
  420. /**
  421. * @return a list (array) of all courses.
  422. * @todo shouldn't this be in the course.lib.php script?
  423. */
  424. public static function get_course_list() {
  425. $table = self::get_main_table(TABLE_MAIN_COURSE);
  426. return self::store_result(self::query("SELECT * FROM $table"));
  427. }
  428. /**
  429. * Returns an array with all database fields for the specified course.
  430. *
  431. * @param the real (system) code of the course (ID from inside the main course table)
  432. * @todo shouldn't this be in the course.lib.php script?
  433. */
  434. public static function get_course_info($course_code) {
  435. $course_code = self::escape_string($course_code);
  436. $table = self::get_main_table(TABLE_MAIN_COURSE);
  437. $result = self::generate_abstract_course_field_names(
  438. self::fetch_array(self::query("SELECT * FROM $table WHERE `code` = '$course_code'")));
  439. return $result === false ? array('db_name' => '') : $result;
  440. }
  441. /**
  442. * @param $user_id (integer): the id of the user
  443. * @return $user_info (array): user_id, lastname, firstname, username, email, ...
  444. * @author Patrick Cool <patrick.cool@UGent.be>, expanded to get info for any user
  445. * @author Roan Embrechts, first version + converted to Database API
  446. * @version 30 September 2004
  447. * @desc find all the information about a specified user. Without parameter this is the current user.
  448. * @todo shouldn't this be in the user.lib.php script?
  449. */
  450. public static function get_user_info_from_id($user_id = '') {
  451. if (empty($user_id)) {
  452. return $GLOBALS['_user'];
  453. }
  454. $table = self::get_main_table(TABLE_MAIN_USER);
  455. $user_id = self::escape_string($user_id);
  456. return self::generate_abstract_user_field_names(
  457. self::fetch_array(self::query("SELECT * FROM $table WHERE user_id = '$user_id'")));
  458. }
  459. /**
  460. * Returns course code from a given gradebook category's id
  461. * @param int Category ID
  462. * @return string Course code
  463. * @todo move this function in a gradebook-related library
  464. */
  465. public static function get_course_by_category($category_id) {
  466. $info = self::fetch_array(self::query('SELECT course_code FROM '.self::get_main_table(TABLE_MAIN_GRADEBOOK_CATEGORY).' WHERE id='.$category_id), 'ASSOC');
  467. return $info ? $info['course_code'] : false;
  468. }
  469. /**
  470. * This creates an abstraction layer between database field names
  471. * and field names expected in code.
  472. *
  473. * This helps when changing database names.
  474. * It's also useful now to get rid of the 'franglais'.
  475. *
  476. * @todo add more array entries to abstract course info from field names
  477. * @author Roan Embrechts
  478. *
  479. * @todo what's the use of this function. I think this is better removed.
  480. * There should be consistency in the variable names and the use throughout the scripts
  481. * for the database name we should consistently use or db_name or database (db_name probably being the better one)
  482. */
  483. public static function generate_abstract_course_field_names($result_array) {
  484. $visual_code = isset($result_array['visual_code']) ? $result_array['visual_code'] : null;
  485. $code = isset($result_array['code']) ? $result_array['code'] : null;
  486. $title = isset($result_array['title']) ? $result_array['title'] : null;
  487. $db_name = isset($result_array['db_name']) ? $result_array['db_name'] : null;
  488. $category_code= isset($result_array['category_code']) ? $result_array['category_code'] : null;
  489. $result_array['official_code'] = $visual_code;
  490. $result_array['visual_code'] = $visual_code;
  491. $result_array['real_code'] = $code;
  492. $result_array['system_code'] = $code;
  493. $result_array['title'] = $title;
  494. $result_array['database'] = $db_name;
  495. $result_array['faculty'] = $category_code;
  496. //$result_array['directory'] = $result_array['directory'];
  497. /*
  498. still to do: (info taken from local.inc.php)
  499. $_course['id' ] = $cData['cours_id' ]; //auto-assigned integer
  500. $_course['name' ] = $cData['title' ];
  501. $_course['official_code'] = $cData['visual_code' ]; // use in echo
  502. $_course['sysCode' ] = $cData['code' ]; // use as key in db
  503. $_course['path' ] = $cData['directory' ]; // use as key in path
  504. $_course['dbName' ] = $cData['db_name' ]; // use as key in db list
  505. $_course['dbNameGlu' ] = $_configuration['table_prefix'] . $cData['dbName'] . $_configuration['db_glue']; // use in all queries
  506. $_course['titular' ] = $cData['tutor_name' ];
  507. $_course['language' ] = $cData['course_language' ];
  508. $_course['extLink' ]['url' ] = $cData['department_url' ];
  509. $_course['extLink' ]['name'] = $cData['department_name'];
  510. $_course['categoryCode'] = $cData['faCode' ];
  511. $_course['categoryName'] = $cData['faName' ];
  512. $_course['visibility' ] = (bool) ($cData['visibility'] == 2 || $cData['visibility'] == 3);
  513. $_course['registrationAllowed'] = (bool) ($cData['visibility'] == 1 || $cData['visibility'] == 2);
  514. */
  515. return $result_array;
  516. }
  517. /**
  518. * This creates an abstraction layer between database field names
  519. * and field names expected in code.
  520. *
  521. * This helps when changing database names.
  522. * It's also useful now to get rid of the 'franglais'.
  523. *
  524. * @todo add more array entries to abstract user info from field names
  525. * @author Roan Embrechts
  526. * @author Patrick Cool
  527. *
  528. * @todo what's the use of this function. I think this is better removed.
  529. * There should be consistency in the variable names and the use throughout the scripts
  530. */
  531. public static function generate_abstract_user_field_names($result_array) {
  532. $result_array['firstName'] = $result_array['firstname'];
  533. $result_array['lastName'] = $result_array['lastname'];
  534. $result_array['mail'] = $result_array['email'];
  535. #$result_array['picture_uri'] = $result_array['picture_uri'];
  536. #$result_array ['user_id'] = $result_array['user_id'];
  537. return $result_array;
  538. }
  539. /**
  540. * Count the number of rows in a table
  541. * @param string $table The table of which the rows should be counted
  542. * @return int The number of rows in the given table.
  543. */
  544. public static function count_rows($table) {
  545. $obj = self::fetch_object(self::query("SELECT COUNT(*) AS n FROM $table"));
  546. return $obj->n;
  547. }
  548. /*
  549. -----------------------------------------------------------------------------
  550. An intermediate API-layer between the system and the dabase server.
  551. -----------------------------------------------------------------------------
  552. */
  553. /**
  554. * Returns the number of affected rows in the last database operation.
  555. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  556. * @return int Returns the number of affected rows on success, and -1 if the last query failed.
  557. */
  558. public static function affected_rows($connection = null) {
  559. return self::use_default_connection($connection) ? mysql_affected_rows() : mysql_affected_rows($connection);
  560. }
  561. /**
  562. * Closes non-persistent database connection.
  563. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  564. * @return bool Returns TRUE on success or FALSE on failure.
  565. */
  566. public static function close($connection = null) {
  567. return self::use_default_connection($connection) ? mysql_close() : mysql_close($connection);
  568. }
  569. /**
  570. * Opens a connection to a database server.
  571. * @param array $parameters (optional) An array that contains the necessary parameters for accessing the server.
  572. * @return resource/boolean Returns a database connection on success or FALSE on failure.
  573. * Note: Currently the array could contain MySQL-specific parameters:
  574. * $parameters['server'], $parameters['username'], $parameters['password'],
  575. * $parameters['new_link'], $parameters['client_flags'], $parameters['persistent'].
  576. * For details see documentation about the functions mysql_connect() and mysql_pconnect().
  577. * @link http://php.net/manual/en/function.mysql-connect.php
  578. * @link http://php.net/manual/en/function.mysql-pconnect.php
  579. */
  580. public static function connect($parameters = array()) {
  581. // A MySQL-specific implementation.
  582. if (!isset($parameters['server'])) {
  583. $parameters['server'] = @ini_get('mysql.default_host');
  584. if (empty($parameters['server'])) {
  585. $parameters['server'] = 'localhost:3306';
  586. }
  587. }
  588. if (!isset($parameters['username'])) {
  589. $parameters['username'] = @ini_get('mysql.default_user');
  590. }
  591. if (!isset($parameters['password'])) {
  592. $parameters['password'] = @ini_get('mysql.default_password');
  593. }
  594. if (!isset($parameters['new_link'])) {
  595. $parameters['new_link'] = false;
  596. }
  597. if (!isset($parameters['client_flags'])) {
  598. $parameters['client_flags'] = 0;
  599. }
  600. return $parameters['persistent']
  601. ? mysql_pconnect($parameters['server'], $parameters['username'], $parameters['password'], $parameters['client_flags'])
  602. : mysql_connect($parameters['server'], $parameters['username'], $parameters['password'], $parameters['new_link'], $parameters['client_flags']);
  603. }
  604. /**
  605. * Returns the error number from the last operation done on the database server.
  606. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  607. * @return int Returns the error number from the last database (operation, or 0 (zero) if no error occurred.
  608. */
  609. public static function errno($connection = null) {
  610. return self::use_default_connection($connection) ? mysql_errno() : mysql_errno($connection);
  611. }
  612. /**
  613. * Returns the error text from the last operation done on the database server.
  614. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  615. * @return string Returns the error text from the last database operation, or '' (empty string) if no error occurred.
  616. */
  617. public static function error($connection = null) {
  618. return self::use_default_connection($connection) ? mysql_error() : mysql_error($connection);
  619. }
  620. /**
  621. * Escapes a string to insert into the database as text
  622. * @param string The string to escape
  623. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  624. * @return string The escaped string
  625. * @author Yannick Warnier <yannick.warnier@dokeos.com>
  626. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  627. */
  628. public static function escape_string($string, $connection = null) {
  629. return get_magic_quotes_gpc()
  630. ? (self::use_default_connection($connection)
  631. ? mysql_real_escape_string(stripslashes($string))
  632. : mysql_real_escape_string(stripslashes($string), $connection))
  633. : (self::use_default_connection($connection)
  634. ? mysql_real_escape_string($string)
  635. : mysql_real_escape_string($string, $connection));
  636. }
  637. /**
  638. * Gets the array from a SQL result (as returned by Database::query) - help achieving database independence
  639. * @param resource The result from a call to sql_query (e.g. Database::query)
  640. * @param string Optional: "ASSOC","NUM" or "BOTH", as the constant used in mysql_fetch_array.
  641. * @return array Array of results as returned by php
  642. * @author Yannick Warnier <yannick.warnier@dokeos.com>
  643. */
  644. public static function fetch_array($result, $option = 'BOTH') {
  645. return $option == 'ASSOC' ? mysql_fetch_array($result, MYSQL_ASSOC) : ($option == 'NUM' ? mysql_fetch_array($result, MYSQL_NUM) : mysql_fetch_array($result));
  646. }
  647. /**
  648. * Gets an associative array from a SQL result (as returned by Database::query).
  649. * This method is equivalent to calling Database::fetch_array() with 'ASSOC' value for the optional second parameter.
  650. * @param resource $result The result from a call to sql_query (e.g. Database::query).
  651. * @return array Returns an associative array that corresponds to the fetched row and moves the internal data pointer ahead.
  652. */
  653. public static function fetch_assoc($result) {
  654. return mysql_fetch_assoc($result);
  655. }
  656. /**
  657. * Gets the next row of the result of the SQL query (as returned by Database::query) in an object form
  658. * @param resource The result from a call to sql_query (e.g. Database::query)
  659. * @param string Optional class name to instanciate
  660. * @param array Optional array of parameters
  661. * @return object Object of class StdClass or the required class, containing the query result row
  662. * @author Yannick Warnier <yannick.warnier@dokeos.com>
  663. */
  664. public static function fetch_object($result, $class = null, $params = null) {
  665. return !empty($class) ? (is_array($params) ? mysql_fetch_object($result, $class, $params) : mysql_fetch_object($result, $class)) : mysql_fetch_object($result);
  666. }
  667. /**
  668. * Gets the array from a SQL result (as returned by Database::query) - help achieving database independence
  669. * @param resource The result from a call to sql_query (see Database::query()).
  670. * @return array Array of results as returned by php (mysql_fetch_row)
  671. */
  672. public static function fetch_row($result) {
  673. return mysql_fetch_row($result);
  674. }
  675. /**
  676. * Frees all the memory associated with the provided result identifier.
  677. * @return bool Returns TRUE on success or FALSE on failure.
  678. * Notes: Use this method if you are concerned about how much memory is being used for queries that return large result sets.
  679. * Anyway, all associated result memory is automatically freed at the end of the script's execution.
  680. */
  681. public static function free_result($result) {
  682. return mysql_free_result($result);
  683. }
  684. /**
  685. * Returns the database client library version.
  686. * @return strung Returns a string that represents the client library version.
  687. */
  688. public function get_client_info() {
  689. return mysql_get_client_info();
  690. }
  691. /**
  692. * Returns a list of databases created on the server. The list may contain all of the
  693. * available database names or filtered database names by using a pattern.
  694. * @param string $pattern (optional) A pattern for filtering database names as if it was needed for the SQL's LIKE clause, for example 'chamilo_%'.
  695. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  696. * @return array Returns in an array the retrieved list of database names.
  697. */
  698. public static function get_databases($pattern = '', $connection = null) {
  699. $result = array();
  700. $query_result = Database::query(!empty($pattern) ? "SHOW DATABASES LIKE '".self::escape_string($pattern, $connection)."'" : "SHOW DATABASES", $connection);
  701. while ($row = Database::fetch_row($query_result)) {
  702. $result[] = $row[0];
  703. }
  704. return $result;
  705. }
  706. /**
  707. * 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.
  708. * By using a special option, this method is able to return an indexed list of fields' properties, where field names are keys.
  709. * @param string $table This is the examined table.
  710. * @param string $pattern (optional) A pattern for filtering field names as if it was needed for the SQL's LIKE clause, for example 'column_%'.
  711. * @param string $database (optional) The name of the targeted database. If it is omited, the current database is assumed, see Database::select_db().
  712. * @param bool $including_properties (optional) When this option is true, the returned result has the followong format:
  713. * array(field_name_1 => array(0 => property_1, 1 => property_2, ...), fieald_name_2 => array(0 => property_1, ...), ...)
  714. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  715. * @return array Returns in an array the retrieved list of field names.
  716. */
  717. public static function get_fields($table, $pattern = '', $database = '', $including_properties = false, $connection = null) {
  718. $result = array();
  719. $query = "SHOW COLUMNS FROM `".self::escape_string($table, $connection)."`";
  720. if (!empty($database)) {
  721. $query .= " FROM `".self::escape_string($database, $connection)."`";
  722. }
  723. if (!empty($pattern)) {
  724. $query .= " LIKE '".self::escape_string($pattern, $connection)."'";
  725. }
  726. $query_result = Database::query($query, $connection);
  727. if ($including_properties) {
  728. // Making an indexed list of the fields and their properties.
  729. while ($row = Database::fetch_row($query_result)) {
  730. $result[$row[0]] = $row;
  731. }
  732. } else {
  733. // Making a plain, flat list.
  734. while ($row = Database::fetch_row($query_result)) {
  735. $result[] = $row[0];
  736. }
  737. }
  738. return $result;
  739. }
  740. /**
  741. * Returns information about the type of the current connection and the server host name.
  742. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  743. * @return string/boolean Returns string data on success or FALSE on failure.
  744. */
  745. public function get_host_info($connection = null) {
  746. return self::use_default_connection($connection) ? mysql_get_host_info() : mysql_get_host_info($connection);
  747. }
  748. /**
  749. * Retrieves database client/server protocol version.
  750. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  751. * @return int/boolean Returns the protocol version on success or FALSE on failure.
  752. */
  753. public function get_proto_info($connection = null) {
  754. return self::use_default_connection($connection) ? mysql_get_proto_info() : mysql_get_proto_info($connection);
  755. }
  756. /**
  757. * Retrieves the database server version.
  758. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  759. * @return string/boolean Returns the MySQL server version on success or FALSE on failure.
  760. */
  761. public function get_server_info($connection = null) {
  762. return self::use_default_connection($connection) ? mysql_get_server_info() : mysql_get_server_info($connection);
  763. }
  764. /**
  765. * Returns a list of tables within a database. The list may contain all of the
  766. * available table names or filtered table names by using a pattern.
  767. * @param string $database (optional) The name of the examined database. If it is omited, the current database is assumed, see Database::select_db().
  768. * @param string $pattern (optional) A pattern for filtering table names as if it was needed for the SQL's LIKE clause, for example 'access_%'.
  769. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  770. * @return array Returns in an array the retrieved list of table names.
  771. */
  772. public static function get_tables($database = '', $pattern = '', $connection = null) {
  773. $result = array();
  774. $query = "SHOW TABLES";
  775. if (!empty($database)) {
  776. $query .= " FROM `".self::escape_string($database, $connection)."`";
  777. }
  778. if (!empty($pattern)) {
  779. $query .= " LIKE '".self::escape_string($pattern, $connection)."'";
  780. }
  781. $query_result = Database::query($query, $connection);
  782. while ($row = Database::fetch_row($query_result)) {
  783. $result[] = $row[0];
  784. }
  785. return $result;
  786. }
  787. /**
  788. * Gets the ID of the last item inserted into the database
  789. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  790. * @return int The last ID as returned by the DB function
  791. * @comment This should be updated to use ADODB at some point
  792. */
  793. public static function insert_id($connection = null) {
  794. return self::use_default_connection($connection) ? mysql_insert_id() : mysql_insert_id($connection);
  795. }
  796. /**
  797. * Gets the number of rows from the last query result - help achieving database independence
  798. * @param resource The result
  799. * @return integer The number of rows contained in this result
  800. * @author Yannick Warnier <yannick.warnier@dokeos.com>
  801. **/
  802. public static function num_rows($result) {
  803. return mysql_num_rows($result);
  804. }
  805. /**
  806. * Acts as the relative *_result() function of most DB drivers and fetches a
  807. * specific line and a field
  808. * @param resource The database resource to get data from
  809. * @param integer The row number
  810. * @param string Optional field name or number
  811. * @result mixed One cell of the result, or FALSE on error
  812. */
  813. public static function result($resource, $row, $field = '') {
  814. return mysql_num_rows($resource) > 0 ? (!empty($field) ? mysql_result($resource, $row, $field) : mysql_result($resource, $row)) : null;
  815. }
  816. /**
  817. * This function returns a resource
  818. * Documentation has been added by Arthur Portugal
  819. * Some adaptations have been implemented by Ivan Tcholakov, 2009, 2010
  820. * @author Olivier Brouckaert
  821. * @param string $query The SQL query
  822. * @param resource $connection (optional) The database server (MySQL) connection.
  823. * If it is not specified, the connection opened by mysql_connect() is assumed.
  824. * If no connection is found, the server will try to create one as if mysql_connect() was called with no arguments.
  825. * If no connection is found or established, an E_WARNING level error is generated.
  826. * @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)
  827. * @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)
  828. * @return resource The returned result from the query
  829. * Note: The parameter $connection could be skipped. Here are examples of this method usage:
  830. * Database::query($query);
  831. * $result = Database::query($query);
  832. * Database::query($query, $connection);
  833. * $result = Database::query($query, $connection);
  834. * The following ways for calling this method are obsolete:
  835. * Database::query($query, __FILE__, __LINE__);
  836. * $result = Database::query($query, __FILE__, __LINE__);
  837. * Database::query($query, $connection, __FILE__, __LINE__);
  838. * $result = Database::query($query, $connection, __FILE__, __LINE__);
  839. */
  840. public static function query($query, $connection = null, $file = null, $line = null) {
  841. $use_default_connection = self::use_default_connection($connection);
  842. if ($use_default_connection) {
  843. // Let us do parameter shifting, thus the method would be similar
  844. // (in regard to parameter order) to the original function mysql_query().
  845. $line = $file;
  846. $file = $connection;
  847. $connection = null;
  848. }
  849. if (!($result = $use_default_connection ? @mysql_query($query) : @mysql_query($query, $connection))) {
  850. $backtrace = debug_backtrace(); // Retrieving information about the caller statement.
  851. if (isset($backtrace[0])) {
  852. $caller = & $backtrace[0];
  853. } else {
  854. $caller = array();
  855. }
  856. if (isset($backtrace[1])) {
  857. $owner = & $backtrace[1];
  858. } else {
  859. $owner = array();
  860. }
  861. if (empty($file)) {
  862. $file = $caller['file'];
  863. }
  864. if (empty($line)) {
  865. $line = $caller['line'];
  866. }
  867. $type = $owner['type'];
  868. $function = $owner['function'];
  869. $class = $owner['class'];
  870. $server_type = api_get_setting('server_type');
  871. if (!empty($line) && !empty($server_type) && $server_type != 'production') {
  872. $info = '<pre>' .
  873. '<strong>DATABASE ERROR #'.self::errno($connection).':</strong><br /> ' .
  874. self::remove_XSS(self::error($connection)) . '<br />' .
  875. '<strong>QUERY :</strong><br /> ' .
  876. self::remove_XSS($query) . '<br />' .
  877. '<strong>FILE :</strong><br /> ' .
  878. (empty($file) ? ' unknown ' : $file) . '<br />' .
  879. '<strong>LINE :</strong><br /> ' .
  880. (empty($line) ? ' unknown ' : $line) . '<br />';
  881. if (empty($type)) {
  882. if (!empty($function)) {
  883. $info .= '<strong>FUNCTION :</strong><br /> ' . $function;
  884. }
  885. } else {
  886. if (!empty($class) && !empty($function)) {
  887. $info .= '<strong>CLASS :</strong><br /> ' . $class . '<br />';
  888. $info .= '<strong>METHOD :</strong><br /> ' . $function;
  889. }
  890. }
  891. $info .= '</pre>';
  892. echo $info;
  893. }
  894. }
  895. return $result;
  896. }
  897. /**
  898. * Selects a database.
  899. * @param string $database_name The name of the database that is to be selected.
  900. * @param resource $connection (optional) The database server connection, for detailed description see the method query().
  901. * @return bool Returns TRUE on success or FALSE on failure.
  902. */
  903. public static function select_db($database_name, $connection = null) {
  904. return self::use_default_connection($connection) ? mysql_select_db($database_name) : mysql_select_db($database_name, $connection);
  905. }
  906. /**
  907. * Stores a query result into an array.
  908. *
  909. * @author Olivier Brouckaert
  910. * @param resource $result - the return value of the query
  911. * @param option BOTH, ASSOC, or NUM
  912. * @return array - the value returned by the query
  913. */
  914. public static function store_result($result, $option = 'BOTH') {
  915. $array = array();
  916. if ($result !== false) { // For isolation from database engine's behaviour.
  917. while ($row = self::fetch_array($result, $option)) {
  918. $array[] = $row;
  919. }
  920. }
  921. return $array;
  922. }
  923. /*
  924. -----------------------------------------------------------------------------
  925. Encodings and collations supported by MySQL database server
  926. -----------------------------------------------------------------------------
  927. */
  928. /**
  929. * Checks whether a given encoding is supported by the database server.
  930. * @param string $encoding The encoding (a system conventional id, for example 'UTF-8') to be checked.
  931. * @return bool Returns a boolean value as a check-result.
  932. * @author Ivan Tcholakov
  933. */
  934. public static function is_encoding_supported($encoding) {
  935. static $supported = array();
  936. if (!isset($supported[$encoding])) {
  937. $supported[$encoding] = false;
  938. if (strlen($db_encoding = self::to_db_encoding($encoding)) > 0) {
  939. if (self::num_rows(self::query("SHOW CHARACTER SET WHERE Charset = '".self::escape_string($db_encoding)."';")) > 0) {
  940. $supported[$encoding] = true;
  941. }
  942. }
  943. }
  944. return $supported[$encoding];
  945. }
  946. /**
  947. * Constructs a SQL clause about default character set and default collation for newly created databases and tables.
  948. * Example: Database::make_charset_clause('UTF-8', 'bulgarian') returns
  949. * DEFAULT CHARACTER SET `utf8` DEFAULT COLLATE `utf8_general_ci`
  950. * @param string $encoding (optional) The default database/table encoding (a system conventional id) to be used.
  951. * @param string $language (optional) Language (a system conventional id) used for choosing language sensitive collation (if it is possible).
  952. * @return string Returns the constructed SQL clause or empty string if $encoding is not correct or is not supported.
  953. * @author Ivan Tcholakov
  954. */
  955. public static function make_charset_clause($encoding = null, $language = null) {
  956. if (empty($encoding)) {
  957. $encoding = api_get_system_encoding();
  958. }
  959. if (empty($language)) {
  960. $language = api_get_interface_language();
  961. }
  962. $charset_clause = '';
  963. if (self::is_encoding_supported($encoding)) {
  964. $db_encoding = Database::to_db_encoding($encoding);
  965. $charset_clause .= " DEFAULT CHARACTER SET `".$db_encoding."`";
  966. $db_collation = Database::to_db_collation($encoding, $language);
  967. if (!empty($db_collation)) {
  968. $charset_clause .= " DEFAULT COLLATE `".$db_collation."`";
  969. }
  970. }
  971. return $charset_clause;
  972. }
  973. /**
  974. * Converts an encoding identificator to MySQL-specific encoding identifictor,
  975. * i.e. 'UTF-8' --> 'utf8'.
  976. * @param string $encoding The conventional encoding identificator.
  977. * @return string Returns the corresponding MySQL-specific encoding identificator if any, otherwise returns NULL.
  978. * @author Ivan Tcholakov
  979. */
  980. public static function to_db_encoding($encoding) {
  981. static $result = array();
  982. if (!isset($result[$encoding])) {
  983. $result[$encoding] = null;
  984. $encoding_map = & self::get_db_encoding_map();
  985. foreach ($encoding_map as $key => $value) {
  986. if (api_equal_encodings($encoding, $key)) {
  987. $result[$encoding] = $value;
  988. break;
  989. }
  990. }
  991. }
  992. return $result[$encoding];
  993. }
  994. /**
  995. * Converts a MySQL-specific encoding identifictor to conventional encoding identificator,
  996. * i.e. 'utf8' --> 'UTF-8'.
  997. * @param string $encoding The MySQL-specific encoding identificator.
  998. * @return string Returns the corresponding conventional encoding identificator if any, otherwise returns NULL.
  999. * @author Ivan Tcholakov
  1000. */
  1001. public static function from_db_encoding($db_encoding) {
  1002. static $result = array();
  1003. if (!isset($result[$db_encoding])) {
  1004. $result[$db_encoding] = null;
  1005. $encoding_map = & self::get_db_encoding_map();
  1006. foreach ($encoding_map as $key => $value) {
  1007. if (strtolower($db_encoding) == $value) {
  1008. $result[$db_encoding] = $key;
  1009. break;
  1010. }
  1011. }
  1012. }
  1013. return $result[$db_encoding];
  1014. }
  1015. /**
  1016. * Chooses the default MySQL-specific collation from given encoding and language.
  1017. * @param string $encoding A conventional encoding id, i.e. 'UTF-8'
  1018. * @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.
  1019. * @return string Returns a suitable default collation, for example 'utf8_general_ci', or NULL if collation was not found.
  1020. * @author Ivan Tcholakov
  1021. */
  1022. public static function to_db_collation($encoding, $language = null) {
  1023. static $result = array();
  1024. if (!isset($result[$encoding][$language])) {
  1025. $result[$encoding][$language] = null;
  1026. if (self::is_encoding_supported($encoding)) {
  1027. $db_encoding = self::to_db_encoding($encoding);
  1028. if (!empty($language)) {
  1029. $lang = api_purify_language_id($language);
  1030. $res = self::check_db_collation($db_encoding, $lang);
  1031. if (empty($res)) {
  1032. $db_collation_map = & self::get_db_collation_map();
  1033. if (isset($db_collation_map[$lang])) {
  1034. $res = self::check_db_collation($db_encoding, $db_collation_map[$lang]);
  1035. }
  1036. }
  1037. if (empty($res)) {
  1038. $res = self::check_db_collation($db_encoding, null);
  1039. }
  1040. $result[$encoding][$language] = $res;
  1041. } else {
  1042. $result[$encoding][$language] = self::check_db_collation($db_encoding, null);
  1043. }
  1044. }
  1045. }
  1046. return $result[$encoding][$language];
  1047. }
  1048. /*
  1049. -----------------------------------------------------------------------------
  1050. Private methods
  1051. You should not access these from outside the class
  1052. No effort is made to keep the names / results the same.
  1053. -----------------------------------------------------------------------------
  1054. */
  1055. /**
  1056. * Glues a course database.
  1057. * glue format from local.inc.php.
  1058. */
  1059. private static function glue_course_database_name($database_name) {
  1060. return self::get_course_table_prefix().$database_name.self::get_database_glue();
  1061. }
  1062. /**
  1063. * @param string $database_name, can be empty to use current course db
  1064. *
  1065. * @return the glued parameter if it is not empty,
  1066. * or the current course database (glued) if the parameter is empty.
  1067. */
  1068. private static function fix_database_parameter($database_name) {
  1069. if (empty($database_name)) {
  1070. $course_info = api_get_course_info();
  1071. return $course_info['dbNameGlu'];
  1072. }
  1073. return self::glue_course_database_name($database_name);
  1074. }
  1075. /**
  1076. * Structures a course database and table name to ready them
  1077. * for querying. The course database parameter is considered glued:
  1078. * e.g. COURSE001`.`
  1079. */
  1080. private static function format_glued_course_table_name($database_name_with_glue, $table) {
  1081. return '`'.$database_name_with_glue.$table.'`';
  1082. }
  1083. /**
  1084. * Structures a database and table name to ready them
  1085. * for querying. The database parameter is considered not glued,
  1086. * just plain e.g. COURSE001
  1087. */
  1088. private static function format_table_name($database, $table) {
  1089. return '`'.$database.'`.`'.$table.'`';
  1090. }
  1091. /**
  1092. * This private method is to be used by the other methods in this class for
  1093. * checking whether the input parameter $connection actually has been provided.
  1094. * If the input parameter connection is not a resource or if it is not FALSE (in case of error)
  1095. * then the default opened connection should be used by the called method.
  1096. * @param resource/boolean $connection The checked parameter $connection.
  1097. * @return boolean TRUE means that calling method should use the default connection.
  1098. * FALSE means that (valid) parameter $connection has been provided and it should be used.
  1099. */
  1100. private static function use_default_connection($connection) {
  1101. return !is_resource($connection) && $connection !== false;
  1102. }
  1103. /**
  1104. * This private method tackles the XSS injections. It is similar to Security::remove_XSS() and works always,
  1105. * including the time of initialization when the class Security has not been loaded yet.
  1106. * @param string The input variable to be filtered from XSS, in this class it is expected to be a string.
  1107. * @return string Returns the filtered string as a result.
  1108. */
  1109. private static function remove_XSS(& $var) {
  1110. return class_exists('Security') && class_exists('HTMLPurifier') ? Security::remove_XSS($var) : api_htmlentities($var, ENT_QUOTES);
  1111. }
  1112. /**
  1113. * This private function encapsulates a table with relations between
  1114. * conventional and MuSQL-specific encoding identificators.
  1115. * @author Ivan Tcholakov
  1116. */
  1117. private static function & get_db_encoding_map() {
  1118. static $encoding_map = array(
  1119. 'ARMSCII-8' => 'armscii8',
  1120. 'BIG5' => 'big5',
  1121. 'BINARY' => 'binary',
  1122. 'CP866' => 'cp866',
  1123. 'EUC-JP' => 'ujis',
  1124. 'EUC-KR' => 'euckr',
  1125. 'GB2312' => 'gb2312',
  1126. 'GBK' => 'gbk',
  1127. 'ISO-8859-1' => 'latin1',
  1128. 'ISO-8859-2' => 'latin2',
  1129. 'ISO-8859-7' => 'greek',
  1130. 'ISO-8859-8' => 'hebrew',
  1131. 'ISO-8859-9' => 'latin5',
  1132. 'ISO-8859-13' => 'latin7',
  1133. 'ISO-8859-15' => 'latin1',
  1134. 'KOI8-R' => 'koi8r',
  1135. 'KOI8-U' => 'koi8u',
  1136. 'SHIFT-JIS' => 'sjis',
  1137. 'TIS-620' => 'tis620',
  1138. 'US-ASCII' => 'ascii',
  1139. 'UTF-8' => 'utf8',
  1140. 'WINDOWS-1250' => 'cp1250',
  1141. 'WINDOWS-1251' => 'cp1251',
  1142. 'WINDOWS-1252' => 'latin1',
  1143. 'WINDOWS-1256' => 'cp1256',
  1144. 'WINDOWS-1257' => 'cp1257'
  1145. );
  1146. return $encoding_map;
  1147. }
  1148. /**
  1149. * A helper language id translation table for choosing some collations.
  1150. * @author Ivan Tcholakov
  1151. */
  1152. private static function & get_db_collation_map() {
  1153. static $db_collation_map = array(
  1154. 'german' => 'german2',
  1155. 'simpl_chinese' => 'chinese',
  1156. 'trad_chinese' => 'chinese',
  1157. 'turkce' => 'turkish'
  1158. );
  1159. return $db_collation_map;
  1160. }
  1161. /**
  1162. * Constructs a MySQL-specific collation and checks whether it is supported by the database server.
  1163. * @param string $db_encoding A MySQL-specific encoding id, i.e. 'utf8'
  1164. * @param string $language A MySQL-compatible language id, i.e. 'bulgarian'
  1165. * @return string Returns a suitable default collation, for example 'utf8_general_ci', or NULL if collation was not found.
  1166. * @author Ivan Tcholakov
  1167. */
  1168. private static function check_db_collation($db_encoding, $language) {
  1169. if (empty($db_encoding)) {
  1170. return null;
  1171. }
  1172. if (empty($language)) {
  1173. $result = self::fetch_array(self::query("SHOW COLLATION WHERE Charset = '".self::escape_string($db_encoding)."' AND `Default` = 'Yes';"), 'NUM');
  1174. return $result ? $result[0] : null;
  1175. }
  1176. $collation = $db_encoding.'_'.$language.'_ci';
  1177. $query_result = self::query("SHOW COLLATION WHERE Charset = '".self::escape_string($db_encoding)."';");
  1178. while ($result = self::fetch_array($query_result, 'NUM')) {
  1179. if ($result[0] == $collation) {
  1180. return $collation;
  1181. }
  1182. }
  1183. return null;
  1184. }
  1185. /*
  1186. ==============================================================================
  1187. DEPRECATED METHODS
  1188. ==============================================================================
  1189. */
  1190. /**
  1191. * @deprecated Use api_get_language_isocode($language) instead.
  1192. */
  1193. public static function get_language_isocode($language) {
  1194. return api_get_language_isocode($language);
  1195. }
  1196. /**
  1197. * @deprecated Use Database::insert_id() instead.
  1198. */
  1199. public static function get_last_insert_id() {
  1200. return mysql_insert_id();
  1201. }
  1202. }
  1203. //end class Database