user_fields.php 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402
  1. <?php // $Id: $
  2. /* For licensing terms, see /dokeos_license.txt */
  3. /**
  4. ==============================================================================
  5. * @package dokeos.admin
  6. ==============================================================================
  7. */
  8. // name of the language file that needs to be included
  9. $language_file = array('admin', 'registration');
  10. $cidReset = true;
  11. // including necessary libraries
  12. require '../inc/global.inc.php';
  13. $libpath = api_get_path(LIBRARY_PATH);
  14. require_once $libpath.'sortabletable.class.php';
  15. require_once $libpath.'usermanager.lib.php';
  16. require_once $libpath.'formvalidator/FormValidator.class.php';
  17. // section for the tabs
  18. $this_section=SECTION_PLATFORM_ADMIN;
  19. // user permissions
  20. api_protect_admin_script();
  21. // Database table definitions
  22. $table_admin = Database :: get_main_table(TABLE_MAIN_ADMIN);
  23. $table_user = Database :: get_main_table(TABLE_MAIN_USER);
  24. $table_uf = Database :: get_main_table(TABLE_MAIN_USER_FIELD);
  25. $table_uf_opt = Database :: get_main_table(TABLE_MAIN_USER_FIELD_OPTIONS);
  26. $table_uf_val = Database :: get_main_table(TABLE_MAIN_USER_FIELD_VALUES);
  27. $interbreadcrumb[] = array ("url" => 'index.php', "name" => get_lang('PlatformAdmin'));
  28. // Display form
  29. if(1)
  30. {
  31. $tool_name = get_lang('UserFields');
  32. Display :: display_header($tool_name, "");
  33. //api_display_tool_title($tool_name);
  34. if (isset ($_GET['action']))
  35. {
  36. $check = Security::check_token('get');
  37. if($check) {
  38. switch ($_GET['action']) {
  39. case 'show_message' :
  40. Display :: display_normal_message($_GET['message']);
  41. break;
  42. case 'show_field' :
  43. if (api_is_platform_admin() && !empty($_GET['field_id']) && UserManager :: update_extra_field($_GET['field_id'],array('field_visible'=>'1'))) {
  44. Display :: display_confirmation_message(get_lang('FieldShown'));
  45. } else {
  46. Display :: display_error_message(get_lang('CannotShowField'));
  47. }
  48. break;
  49. case 'hide_field' :
  50. if (api_is_platform_admin() && !empty($_GET['field_id']) && UserManager :: update_extra_field($_GET['field_id'],array('field_visible'=>'0'))) {
  51. Display :: display_confirmation_message(get_lang('FieldHidden'));
  52. } else {
  53. Display :: display_error_message(get_lang('CannotHideField'));
  54. }
  55. break;
  56. case 'thaw_field' :
  57. if (api_is_platform_admin() && !empty($_GET['field_id']) && UserManager :: update_extra_field($_GET['field_id'],array('field_changeable'=>'1'))) {
  58. Display :: display_confirmation_message(get_lang('FieldMadeChangeable'));
  59. } else {
  60. Display :: display_error_message(get_lang('CannotMakeFieldChangeable'));
  61. }
  62. break;
  63. case 'freeze_field' :
  64. if (api_is_platform_admin() && !empty($_GET['field_id']) && UserManager :: update_extra_field($_GET['field_id'],array('field_changeable'=>'0'))) {
  65. Display :: display_confirmation_message(get_lang('FieldMadeUnchangeable'));
  66. } else {
  67. Display :: display_error_message(get_lang('CannotMakeFieldUnchangeable'));
  68. }
  69. break;
  70. case 'moveup' :
  71. if (api_is_platform_admin() && !empty($_GET['field_id'])) {
  72. if (move_user_field('moveup', $_GET['field_id'])) {
  73. Display :: display_confirmation_message(get_lang('FieldMovedUp'));
  74. } else {
  75. Display :: display_error_message(get_lang('CannotMoveField'));
  76. }
  77. }
  78. break;
  79. case 'movedown' :
  80. if (api_is_platform_admin() && !empty($_GET['field_id'])) {
  81. if (move_user_field('movedown', $_GET['field_id'])) {
  82. Display :: display_confirmation_message(get_lang('FieldMovedDown'));
  83. } else {
  84. Display :: display_error_message(get_lang('CannotMoveField'));
  85. }
  86. }
  87. break;
  88. case 'filter_on' :
  89. if (api_is_platform_admin() && !empty($_GET['field_id']) && UserManager :: update_extra_field($_GET['field_id'],array('field_filter'=>'1'))) {
  90. Display :: display_confirmation_message(get_lang('FieldFilterSetOn'));
  91. } else {
  92. Display :: display_error_message(get_lang('CannotShowField'));
  93. }
  94. break;
  95. case 'filter_off' :
  96. if (api_is_platform_admin() && !empty($_GET['field_id']) && UserManager :: update_extra_field($_GET['field_id'],array('field_filter'=>'0'))) {
  97. Display :: display_confirmation_message(get_lang('FieldFilterSetOff'));
  98. } else {
  99. Display :: display_error_message(get_lang('CannotShowField'));
  100. }
  101. break;
  102. case 'delete':
  103. if (api_is_platform_admin() && !empty($_GET['field_id'])) {
  104. if (delete_user_fields($_GET['field_id'])) {
  105. Display :: display_confirmation_message(get_lang('FieldDeleted'));
  106. } else {
  107. Display :: display_error_message(get_lang('CannotDeleteField'));
  108. }
  109. }
  110. break;
  111. }
  112. Security::clear_token();
  113. }
  114. }
  115. if (isset ($_POST['action'])) {
  116. $check = Security::check_token('get');
  117. if($check) {
  118. switch ($_POST['action']) {
  119. default:
  120. break;
  121. }
  122. Security::clear_token();
  123. }
  124. }
  125. // Create an add-field box
  126. $form = new FormValidator('add_field','post','','',null,false);
  127. $renderer =& $form->defaultRenderer();
  128. $renderer->setElementTemplate('<span>{element}</span> ');
  129. //$form->addElement('text','label',get_lang('FieldLabel'));
  130. //$form->addElement('text','type',get_lang('FieldType'));
  131. //$form->addElement('text','title',get_lang('FieldTitle'));
  132. //$form->addElement('text','default',get_lang('FieldDefaultValue'));
  133. //$form->addElement('submit','submit',get_lang('Search'));
  134. $form->addElement('static','search_advanced_link',null,'<a href="user_fields_add.php?action=fill">'.Display::return_icon('fieldadd.gif', get_lang('AddUserField')).get_lang('AddUserField').'</a>');
  135. echo '<div class="actions">';
  136. $form->display();
  137. echo '</div>';
  138. // Create a sortable table with user-data
  139. $parameters['sec_token'] = Security::get_token();
  140. $column_show = array(1,1,1,1,1,1,1,1,1,0,0);
  141. $column_order = array(1,2,3,4,5,6,7,8,9,10,11);
  142. $extra_fields = UserManager::get_extra_fields(0,100,5,'ASC');
  143. $number_of_extra_fields = count($extra_fields);
  144. $table = new SortableTableFromArrayConfig($extra_fields, 5, 50, '', $column_show, $column_order, 'ASC');
  145. $table->set_additional_parameters($parameters);
  146. $table->set_header(0, '', false);
  147. $table->set_header(1, get_lang('FieldLabel'), false);
  148. $table->set_header(2, get_lang('FieldType'), false);
  149. $table->set_header(3, get_lang('FieldTitle'),false);
  150. $table->set_header(4, get_lang('FieldDefaultValue'),false);
  151. $table->set_header(5, get_lang('FieldOrder'), false);
  152. $table->set_header(6, get_lang('FieldVisibility'), false);
  153. $table->set_header(7, get_lang('FieldChangeability'), false);
  154. $table->set_header(8, get_lang('FieldFilter'), false);
  155. $table->set_header(9, get_lang('Modify'), false);
  156. $table->set_column_filter(5, 'order_filter');
  157. $table->set_column_filter(6, 'modify_visibility');
  158. $table->set_column_filter(7, 'modify_changeability');
  159. $table->set_column_filter(8, 'modify_field_filter');
  160. $table->set_column_filter(9, 'edit_filter');
  161. $table->set_column_filter(2, 'type_filter');
  162. $table->display();
  163. }
  164. /*
  165. ==============================================================================
  166. FOOTER
  167. ==============================================================================
  168. */
  169. Display::display_footer();
  170. //gateway functions to the UserManager methods (provided for SorteableTable callback mechanism)
  171. function get_number_of_extra_fields()
  172. {
  173. return UserManager::get_number_of_extra_fields();
  174. }
  175. function get_extra_fields($f,$n,$o,$d)
  176. {
  177. return UserManager::get_extra_fields($f,$n,$o,$d);
  178. }
  179. /**
  180. * This functions translates the id of the form type into a human readable description
  181. *
  182. * @param integer $type the id of the form type
  183. * @return string the huma readable description of the field type (text, date, select drop-down, ...)
  184. *
  185. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  186. * @version July 2008
  187. * @since Dokeos 1.8.6
  188. */
  189. function type_filter($type)
  190. {
  191. $types[USER_FIELD_TYPE_TEXT] = get_lang('FieldTypeText');
  192. $types[USER_FIELD_TYPE_TEXTAREA] = get_lang('FieldTypeTextarea');
  193. $types[USER_FIELD_TYPE_RADIO] = get_lang('FieldTypeRadio');
  194. $types[USER_FIELD_TYPE_SELECT] = get_lang('FieldTypeSelect');
  195. $types[USER_FIELD_TYPE_SELECT_MULTIPLE] = get_lang('FieldTypeSelectMultiple');
  196. $types[USER_FIELD_TYPE_DATE] = get_lang('FieldTypeDate');
  197. $types[USER_FIELD_TYPE_DATETIME] = get_lang('FieldTypeDatetime');
  198. $types[USER_FIELD_TYPE_DOUBLE_SELECT] = get_lang('FieldTypeDoubleSelect');
  199. $types[USER_FIELD_TYPE_DIVIDER] = get_lang('FieldTypeDivider');
  200. $types[USER_FIELD_TYPE_TAG] = get_lang('FieldTypeTag');
  201. $types[USER_FIELD_TYPE_TIMEZONE] = get_lang('FieldTypeTimezone');
  202. $types[USER_FIELD_TYPE_SOCIAL_PROFILE] = get_lang('FieldTypeSocialProfile');
  203. return $types[$type];
  204. }
  205. /**
  206. * Modify the display order field into up and down arrows
  207. *
  208. * @param unknown_type $field_order
  209. * @param array Url parameters
  210. * @param array The results row
  211. * @return string The link
  212. *
  213. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  214. * @version July 2008
  215. * @since Dokeos 1.8.6
  216. */
  217. function order_filter($field_order,$url_params,$row)
  218. {
  219. global $number_of_extra_fields;
  220. // the up icon only has to appear when the row can be moved up (all but the first row)
  221. if ($row[5]<>1)
  222. {
  223. $return .= '<a href="'.api_get_self().'?action=moveup&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('up.gif', get_lang('Up')).'</a>';
  224. }
  225. else
  226. {
  227. $return .= Display::return_icon('blank.gif','',array('width'=>'21px'));
  228. }
  229. // the down icon only has to appear when the row can be moved down (all but the last row)
  230. if ($row[5]<>$number_of_extra_fields)
  231. {
  232. $return .= '<a href="'.api_get_self().'?action=movedown&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('down.gif', get_lang('Down')).'</a>';
  233. }
  234. return $return;
  235. }
  236. /**
  237. * Modify the visible field to show links and icons
  238. * @param int The current visibility
  239. * @param array Url parameters
  240. * @param array The results row
  241. * @return string The link
  242. */
  243. function modify_visibility($visibility,$url_params,$row)
  244. {
  245. return ($visibility?'<a href="'.api_get_self().'?action=hide_field&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('visible.gif', get_lang('Hide')).'</a>':'<a href="'.api_get_self().'?action=show_field&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('invisible.gif', get_lang('Show')).'</a>');
  246. }
  247. /**
  248. * Modify the changeability field to show links and icons
  249. * @param int The current changeability
  250. * @param array Url parameters
  251. * @param array The results row
  252. * @return string The link
  253. */
  254. function modify_changeability($changeability,$url_params,$row)
  255. {
  256. return ($changeability?'<a href="'.api_get_self().'?action=freeze_field&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('right.gif', get_lang('MakeUnchangeable')).'</a>':'<a href="'.api_get_self().'?action=thaw_field&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('wrong.gif', get_lang('MakeChangeable')).'</a>');
  257. }
  258. function modify_field_filter ($changeability,$url_params,$row)
  259. {
  260. return ($changeability?'<a href="'.api_get_self().'?action=filter_off&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('right.gif', get_lang('FilterOff')).'</a>':'' .
  261. '<a href="'.api_get_self().'?action=filter_on&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('wrong.gif', get_lang('FilterOn')).'</a>');
  262. }
  263. function edit_filter($id,$url_params,$row)
  264. {
  265. global $charset;
  266. $return = '<a href="user_fields_add.php?action=edit&field_id='.$row[0].'&field_type='.$row[2].'&sec_token='.$_SESSION['sec_token'].'">'.Display::return_icon('edit.gif',get_lang('Edit')).'</a>';
  267. $return .= ' <a href="'.api_get_self().'?action=delete&field_id='.$row[0].'&sec_token='.$_SESSION['sec_token'].'" onclick="javascript:if(!confirm('."'".addslashes(api_htmlentities(get_lang("ConfirmYourChoice"),ENT_QUOTES,$charset))."'".')) return false;">'.Display::return_icon('delete.gif',get_lang('Delete')).'</a>';
  268. return $return;
  269. }
  270. /**
  271. * Move a user defined field up or down
  272. *
  273. * @param string $direction the direction we have to move the field to (up or down)
  274. * @param unknown_type $field_id
  275. *
  276. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  277. * @version July 2008
  278. * @since Dokeos 1.8.6
  279. */
  280. function move_user_field($direction,$field_id)
  281. {
  282. // Databse table definitions
  283. $table_user_field = Database::get_main_table(TABLE_MAIN_USER_FIELD);
  284. // check the parameters
  285. if (!in_array($direction,array('moveup','movedown')) OR !is_numeric($field_id))
  286. {
  287. return false;
  288. }
  289. // determine the SQL sort direction
  290. if ($direction == 'moveup')
  291. {
  292. $sortdirection = 'DESC';
  293. }
  294. else
  295. {
  296. $sortdirection = 'ASC';
  297. }
  298. $found = false;
  299. $sql = "SELECT id, field_order FROM $table_user_field ORDER BY field_order $sortdirection";
  300. $result = Database::query($sql);
  301. while($row = Database::fetch_array($result))
  302. {
  303. if ($found)
  304. {
  305. $next_id = $row['id'];
  306. $next_order = $row['field_order'];
  307. break;
  308. }
  309. if ($field_id == $row['id'])
  310. {
  311. $this_id = $row['id'];
  312. $this_order = $row['field_order'];
  313. $found = true;
  314. }
  315. }
  316. $sql1 = "UPDATE ".$table_user_field." SET field_order = '".Database::escape_string($next_order)."' WHERE id = '".Database::escape_string($this_id)."'";
  317. $sql2 = "UPDATE ".$table_user_field." SET field_order = '".Database::escape_string($this_order)."' WHERE id = '".Database::escape_string($next_id)."'";
  318. Database::query($sql1);
  319. Database::query($sql2);
  320. return true;
  321. }
  322. /**
  323. * Delete a user field (and also the options and values entered by the users)
  324. *
  325. * @param integer $field_id the id of the field that has to be deleted
  326. * @return boolean true if the field has been deleted, false if the field could not be deleted (for whatever reason)
  327. *
  328. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  329. * @version July 2008
  330. * @since Dokeos 1.8.6
  331. */
  332. function delete_user_fields($field_id)
  333. {
  334. // Database table definitions
  335. $table_user_field = Database::get_main_table(TABLE_MAIN_USER_FIELD);
  336. $table_user_field_options = Database::get_main_table(TABLE_MAIN_USER_FIELD_OPTIONS);
  337. $table_user_field_values = Database::get_main_table(TABLE_MAIN_USER_FIELD_VALUES);
  338. // delete the fields
  339. $sql = "DELETE FROM $table_user_field WHERE id = '".Database::escape_string($field_id)."'";
  340. $result = Database::query($sql);
  341. if (Database::affected_rows() == 1)
  342. {
  343. // delete the field options
  344. $sql = "DELETE FROM $table_user_field_options WHERE field_id = '".Database::escape_string($field_id)."'";
  345. $result = Database::query($sql);
  346. // delete the field values
  347. $sql = "DELETE FROM $table_user_field_values WHERE field_id = '".Database::escape_string($field_id)."'";
  348. $result = Database::query($sql);
  349. // recalculate the field_order because the value is used to show/hide the up/down icon
  350. // and the field_order value cannot be bigger than the number of fields
  351. $sql = "SELECT * FROM $table_user_field ORDER BY field_order ASC";
  352. $result = Database::query($sql);
  353. $i = 1;
  354. while($row = Database::fetch_array($result))
  355. {
  356. $sql_reorder = "UPDATE $table_user_field SET field_order = '".Database::escape_string($i)."' WHERE id = '".Database::escape_string($row['id'])."'";
  357. $result_reorder = Database::query($sql_reorder);
  358. $i++;
  359. }
  360. // field was deleted so we return true
  361. return true;
  362. }
  363. else
  364. {
  365. // the field was not deleted so we return false
  366. return false;
  367. }
  368. }
  369. ?>