settings_form.php 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368
  1. <?php
  2. /**
  3. * Form to add and edit interactive Learning Module (iLM).
  4. * The fields are initially filled at locallib.php:add_edit_copy_ilm($ilm_id, $action)
  5. * The final processing is performed by 'locallib.php', that is called bye './settings_ilm.php' (with ilm_settings::copy_new_version_ilm($formdata))
  6. * then by 'ilm_handlers/(html5 or java).php' with copy_new_version_ilm($param, $files_extract)'
  7. *
  8. * Release Notes:
  9. * - v 2.0.1 2022/09/15
  10. * + Considering table 'iassign_ilm': messages to fields 'evaluate', 'reevaluate', 'editingbehavior'; fixes to allow the edition of 'reevaluate', 'editingbehavior'
  11. * - v 1.6.3 2020/04/28
  12. * + Fixed detail: undefinde variable 'if ($filejars!='')' - it was '$filejar'
  13. * - v 1.6.2 2020/01/20
  14. * + Avoid presence of ' and " in DB to close string to put JavaScript (avoid error)
  15. * - v 1.6.1 2017/12/02
  16. * + New help button, improvements on some helps, new code comments and indentation.
  17. * - v 1.6 2013/12/12
  18. * + Insert support of import iLM from zip packages.
  19. * - v 1.5 2013/10/31
  20. * + Insert support of import iLM from zip packages.
  21. * - v 1.4 2013/10/24
  22. * + Fix required upload an file for new iLM.
  23. * - v 1.3 2013/07/12
  24. * + Fix error messages of 'setType' in debug mode for hidden fields.
  25. * + Form now accept actions: add, edit, copy (new version from an iLM), and new version (empty new version).
  26. *
  27. * To use help button. For instance, to a field named 'file_class' use
  28. * $mform->addHelpButton('file_class', 'file_class_form_help', 'iassign');
  29. * it means that the first parameter is used as 'title' (mouseover) and the second when user "clickover"
  30. * In lang, it is necessary
  31. * file_class_form_help = 'to the title - when mouse over'
  32. * file_class_form_help_help = 'to the complete explanation, when the user click over the help signal'
  33. * 'auto_evaluate_help'] = 'If the iLM has automatic evaluation select Yes to use an activity with it.'; // 'What is automatic evaluation
  34. *
  35. * @see ./locallib.php : 'add_edit_copy_ilm($ilm_id,$action)' load this script and provides data to it (defines initial values to the form fields)
  36. * @see ./settings_ilm.php : load and process this form, it uses data under the name $param, calling 'locallib.php!add_edit_copy_ilm(.)'
  37. * @see ./ilm_handlers/html5.php : save_ilm_by_xml($application_xml, $files_extract): return null;
  38. *
  39. * @author Patricia Alves Rodrigues
  40. * @author Leônidas O. Brandão
  41. * @version v 1.6 2013/12/12
  42. * @package mod_iassign_settings
  43. * @since 2010/09/27
  44. * @copyright iMatica (<a href="http://www.matematica.br">iMath</a>) - Computer Science Dep. of IME-USP (Brazil)
  45. *
  46. * <b>License</b>
  47. * - http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  48. */
  49. // Moodle core defines constant MOODLE_INTERNAL which shall be used to make sure that the script is included and not called directly.
  50. if (!defined('MOODLE_INTERNAL')) {
  51. die('Direct access to this script is forbidden.'); // By security reasons, this must be included in all Moodle pages!
  52. }
  53. require_once($CFG->libdir . '/formslib.php');
  54. require_once($CFG->dirroot . '/course/moodleform_mod.php');
  55. require_once($CFG->dirroot . '/mod/iassign/lib.php');
  56. /// This class create form based moodleform.
  57. // @see moodleform
  58. class mod_ilm_form extends moodleform {
  59. /// Add elements to form
  60. function definition () {
  61. global $CFG, $COURSE, $USER, $DB;
  62. global $description; // defined in 'settings_ilm.php'
  63. // $mform = & $this->_form;
  64. $mform = $this->_form; //leo
  65. if ($CFG->action_ilm != 'import') {
  66. if ($CFG->action_ilm == 'add') {
  67. // $params = array('parent' => '0');
  68. // $tmps = $DB->get_records_sql("SELECT s.id, s.name, s.extension, s.file_jar
  69. // FROM {iassign_ilm} s WHERE s.parent = :parent", $params); // " - jed/emacs
  70. $tmps = $DB->get_records('iassign_ilm', array('parent' => 0));
  71. }
  72. else {
  73. // $params = array('id' => $CFG->ilm_id);
  74. // $tmps = $DB->get_records_sql("SELECT s.id, s.name, s.extension, s.file_jar
  75. // FROM {iassign_ilm} s WHERE s.id != :id AND s.parent = 0", $params); // " - jed/emacs
  76. $tmps = $DB->get_records('iassign_ilm', array('id' => $CFG->ilm_id));
  77. }
  78. $extensions = "";
  79. $names = "";
  80. $versions = "";
  81. $filejars = "";
  82. foreach ($tmps as $tmp) {
  83. $exts = explode(",", $tmp->extension);
  84. foreach ($exts as $ext) {
  85. $extensions .= "'" . $ext . "',";
  86. }
  87. $names .= "'" . $tmp->name . "',";
  88. $filejars .= "'" . $tmp->file_jar . "',";
  89. }
  90. if (!$tmps)
  91. $iassign_ilm = $DB->get_record('iassign_ilm', array('id' => $CFG->ilm_id));
  92. else
  93. $iassign_ilm = $tmps; // it already has these data
  94. if (!$iassign_ilm) {
  95. $iassign_ilm = new stdClass();
  96. $iassign_ilm->parent = 0;
  97. }
  98. //TODO JavaScript code, verify alternatives.
  99. $code_javascript = "\n <script type='text/javascript'>
  100. //<![CDATA[
  101. document.getElementById('id_data_file_html').style.display = 'none'
  102. document.getElementById('id_data_file_jar').classList.remove('collapsed');
  103. document.getElementById('id_data_ilm').classList.remove('collapsed');
  104. function search_name (name) {
  105. var i;
  106. var names = new Array(";
  107. if ($names != '')
  108. $code_javascript .= addslashes($names) . "');\n"; // if the name has ' it implies close JavaScript string => error!
  109. $code_javascript .= "
  110. for (i=0;i<names.length;i++) {
  111. if (names[i].toLowerCase()==name.toLowerCase()) {
  112. document.forms['mform1'].name.value='';
  113. confirm('" . get_string('invalid_name_ilm', 'iassign') . " '+names[i]+'!');
  114. }
  115. }";
  116. $code_javascript .= " }
  117. function search_extension(extensions) {
  118. var i;
  119. var ext_inserteds = extensions.split(',');
  120. var ext_exists = new Array(";
  121. $code_javascript .= $extensions . "'');" . chr(13);
  122. $code_javascript .= "
  123. for (k=0;k<ext_inserteds.length;k++) {
  124. for (i=0;i<ext_exists.length;i++) {
  125. if (ext_exists[i].toLowerCase()==ext_inserteds[k].toLowerCase()) {
  126. document.forms['mform1'].extension.value='';
  127. confirm('" . get_string('invalid_extension_ilm', 'iassign') . " '+ext_exists[i]+'!');
  128. }
  129. }
  130. }\n";
  131. $code_javascript .= " }
  132. function search_filejar (fullfilejar) {
  133. var i;
  134. var tmp = fullfilejar.split('/');
  135. var filejar = tmp[tmp.length-1];
  136. var filejars = new Array("; // close for JavaScript code
  137. if ($filejars!='')
  138. $code_javascript .= addslashes($filejars) . "');" . chr(13); // if the name has ' it implies close JavaScript string => error!
  139. $code_javascript .= "
  140. for (i=0;i<filejars.length;i++) {
  141. if (filejars[i].toLowerCase()==filejar.toLowerCase()) {
  142. document.forms['mform1'].file_jar[0].value='';
  143. confirm('" . get_string('invalid_filejar_ilm', 'iassign') . " '+filejars[i]+'!');
  144. }
  145. }\n";
  146. $code_javascript .= " }
  147. function change_language (lang) {
  148. if (document.forms['mform1'].description_lang.value != '') {
  149. descriptions = eval('(' + document.forms['mform1'].description_lang.value + ')');
  150. descriptions[document.forms['mform1'].set_lang.value] = tinyMCE.activeEditor.getContent();
  151. document.forms['mform1'].description_lang.value = JSON.stringify(descriptions);
  152. if (descriptions[lang] != undefined)
  153. tinyMCE.activeEditor.setContent(descriptions[lang]);
  154. else
  155. tinyMCE.activeEditor.setContent('');
  156. }
  157. else {
  158. document.forms['mform1'].description_lang.value = '{ \"' + document.forms['mform1'].set_lang.value + '\" : \"' + tinyMCE.activeEditor.getContent() + '\" }';
  159. tinyMCE.activeEditor.setContent('');
  160. }
  161. document.forms['mform1'].set_lang.value = lang;
  162. }
  163. //]]>
  164. </script>\n";
  165. //-------------------------------------------------------------------------------
  166. /// Adding the "data_ilm" fieldset, where all the common settings are showed
  167. if ($CFG->action_ilm != 'add') {
  168. // $mform->addElement('header', 'type_ilm', get_string('type_ilm', 'iassign'));
  169. // // Adding the select option for HTML5 or Java
  170. // $options = array('Java' => 'Java', 'HTML5' => 'HTML5');
  171. // $mform->addElement('select', 'ilm_type', get_string('ilm_type', 'iassign'), $options);
  172. // $mform->setDefault('ilm_type', PARAM_TEXT);
  173. // $mform->addHelpButton('ilm_type', 'ilm_type', 'iassign');
  174. // $mform->addElement('header', 'data_ilm', get_string('data_ilm', 'iassign'));
  175. // Adding the standard "name" field
  176. if ($CFG->action_ilm != 'add') {
  177. $mform->addElement('static', 'name_ilm', get_string('name_ilm', 'iassign'));
  178. $mform->addElement('hidden', 'name');
  179. $mform->setType('name', PARAM_TEXT);
  180. }
  181. else {
  182. $mform->addElement('text', 'name', get_string('name_ilm', 'iassign'), array('size' => '55', 'onchange' => 'search_name(this.value);'));
  183. $mform->setType('name', PARAM_TEXT);
  184. }
  185. // Adding the standard "version" field
  186. $mform->addElement('text', 'version', get_string('version_ilm', 'iassign'), array('size' => '55'));
  187. $mform->setType('version', PARAM_TEXT);
  188. $mform->addHelpButton('version', 'version_ilm', 'iassign');
  189. // Adding the type of iLM
  190. $mform->addElement('static', 'ilm_type', get_string('type_ilm', 'iassign'));
  191. $mform->addElement('hidden', 'type');
  192. $mform->setType('type', PARAM_TEXT);
  193. // Adding the standard "url" field
  194. $mform->addElement('text', 'url', get_string('url_ilm', 'iassign'), array('size' => '55'));
  195. $mform->setType('url', PARAM_TEXT);
  196. $mform->addElement('select', 'lang', get_string('language_label', 'iassign'), get_string_manager()->get_list_of_translations(), array('onChange' => 'change_language(this.value);'));
  197. $mform->setDefault('lang', current_language());
  198. //D Came from 'settings_ilm.php: if ($action == 'edit')
  199. //D With 'editor' does not work!
  200. //D $param = $description; // ilm_settings::add_edit_copy_ilm($ilm_id, $action);
  201. //D $param = $mform->get_data(); - erro, function not defined
  202. //D echo "settings_form.php: param="; print_r($param); echo "<br/>";
  203. //D echo "description=" . $description . "<br/>";
  204. // Adding the standard "description" field
  205. //moodle2 $mform->addElement('htmleditor', 'description', get_string('description', 'iassign'));
  206. //TODO $mform->addElement('editor', 'description', get_string('description', 'iassign'), $description); // moodle3 => 'editor', but not working
  207. $mform->addElement('text', 'description', get_string('description', 'iassign'), array('size' => '80'));//, $description, 200); //moodle3
  208. $mform->setType('description', PARAM_RAW);
  209. // Adding the "data_file_jar" fieldset, where all the common settings are showed ---
  210. //REVER texto 'Pacote do novo iMA (Java) a ser inserido (JAR)'
  211. $mform->addElement('header', 'data_file_jar', get_string('data_file_jar', 'iassign'));
  212. $mform->addElement('static', 'file_jar_static', get_string('fields_info', 'iassign')); // non editable text
  213. // Fields: file_jar file_class
  214. $mform->addElement('text', 'file_jar', get_string('file_jar_path', 'iassign'), array('size' => '55')); // editable text
  215. $mform->setType('file_jar', PARAM_TEXT);
  216. $mform->addElement('text', 'file_class', get_string('file_class', 'iassign')); // editable text
  217. $mform->setType('file_class', PARAM_TEXT);
  218. //TODO : acho que vale a pena incluir o campo 'file_jar'...
  219. // $mform->addElement('static', 'file_jar', get_string('file_jar', 'iassign'));
  220. // $mform->addElement('hidden', 'file_jar'); - already bellow! line 288/320
  221. // $mform->setType('file_jar', PARAM_TEXT);
  222. //TD // Adding the standard "file_jar" field
  223. //TD $mform->addElement('text', 'file_jar', get_string('file_jar', 'iassign'), array('size' => '55'));
  224. //TD $mform->setType('file_jar', PARAM_TEXT);
  225. //TD $mform->addHelpButton('file_jar', 'file_jar_form_help', 'iassign'); // first => field name; second => text to be presented
  226. // Adding the standard "extension" field
  227. $mform->addElement('text', 'extension', get_string('extension', 'iassign'), array('size' => '30', 'onchange' => 'search_extension(this.value);'));
  228. $mform->setType('extension', PARAM_TEXT);
  229. //$mform->addRule('extension', get_string('required', 'iassign'), 'required');
  230. $mform->addHelpButton('extension', 'extension', 'iassign');
  231. // Adding the standard "width" field
  232. $mform->addElement('text', 'width', get_string('width', 'iassign'), array('size' => '10'));
  233. $mform->setType('width', PARAM_TEXT);
  234. //$mform->addRule('width', get_string('required', 'iassign'), 'required');
  235. // Adding the standard "height" field
  236. $mform->addElement('text', 'height', get_string('height', 'iassign'), array('size' => '10'));
  237. $mform->setType('height', PARAM_TEXT);
  238. //$mform->addRule('height', get_string('required', 'iassign'), 'required');
  239. // Adding the field "evaluate"
  240. $mform->addElement('selectyesno', 'evaluate', get_string('auto_evaluate', 'iassign'));
  241. $mform->setDefault('evaluate', 1);
  242. //$mform->addRule('evaluate', get_string('required', 'iassign'), 'required');
  243. $mform->addHelpButton('evaluate', 'auto_evaluate', 'iassign');
  244. // Adding the field "reevaluate"
  245. $mform->addElement('selectyesno', 'reevaluate', get_string('auto_reevaluate', 'iassign'));
  246. $mform->setDefault('reevaluate', 1);
  247. $mform->addHelpButton('reevaluate', 'auto_reevaluate', 'iassign');
  248. // Adding the field "editingbehavior"
  249. $mform->addElement('selectyesno', 'editingbehavior', get_string('auto_editingbehavior', 'iassign'));
  250. $mform->setDefault('editingbehavior', 1);
  251. $mform->addHelpButton('editingbehavior', 'auto_editingbehavior', 'iassign');
  252. // Adding the field "submissionbehavior": behaviour after submission
  253. // + 'iassign_ilm.submissionbehavior' = { 0 => remains on the same page; 1 => changes the current page; ... }
  254. $mform->addElement('text', 'submissionbehavior', get_string('auto_evaluate', 'iassign'));
  255. $mform->setType('submissionbehavior', PARAM_INT);
  256. // Adding the "data_file_jar" fieldset, where all the common settings are showed
  257. $mform->addElement('header', 'data_file_html', get_string('data_file_html', 'iassign'));
  258. // Adding static text
  259. $mform->addElement('static', 'data_file_html_static', get_string('data_file_html_static', 'iassign'));
  260. } // if ($CFG->action_ilm != 'add')
  261. // // Upload file ilm
  262. // $mform->addElement('header', 'upload_jar', get_string('upload_jar', 'iassign'));
  263. // //$mform->setExpanded('upload_jar');
  264. // $options = array('subdirs' => 0, 'maxbytes' => $CFG->userquota, 'maxfiles' => -1, 'accepted_types' => '*');
  265. // $mform->addElement('filemanager', 'file', null, null, $options);
  266. $mform->addElement('header', 'upload_jar', get_string('upload_jar', 'iassign'));
  267. $options = array('subdirs' => 0, 'maxbytes' => $CFG->userquota, 'maxfiles' => 1, 'accepted_types' => array('*'));
  268. $mform->addElement('filepicker', 'file', null, null, $options);
  269. $mform->addRule('file', get_string('required', 'iassign'), 'required');
  270. if ($CFG->action_ilm == 'add' || $CFG->action_ilm == 'copy' || $CFG->action_ilm == 'new_version')
  271. $mform->addRule('file', get_string('required', 'iassign'), 'required');
  272. /// Adding the standard "hidden" field
  273. if ($CFG->action_ilm == 'edit') {
  274. $mform->addElement('hidden', 'id');
  275. $mform->setType('id', PARAM_INT);
  276. }
  277. $mform->addElement('hidden', 'set_lang');
  278. $mform->setType('set_lang', PARAM_TEXT);
  279. $mform->setDefault('set_lang', current_language());
  280. $mform->addElement('hidden', 'description_lang');
  281. $mform->setType('description_lang', PARAM_TEXT);
  282. // $mform->addElement('hidden', 'file_jar'); //Remove inserted above to allow to edit this field
  283. // $mform->setType('file_jar', PARAM_TEXT); //Remove idem
  284. $mform->addElement('hidden', 'author');
  285. $mform->setType('author', PARAM_TEXT);
  286. $mform->addElement('hidden', 'action');
  287. $mform->setType('action', PARAM_TEXT); //DEBUG: is it necessary?
  288. $mform->addElement('hidden', 'timecreated');
  289. $mform->setType('timecreated', PARAM_TEXT);
  290. $mform->addElement('hidden', 'timemodified');
  291. $mform->setType('timemodified', PARAM_TEXT);
  292. $mform->addElement('hidden', 'parent');
  293. $mform->setType('parent', PARAM_INT);
  294. $mform->addElement('hidden', 'enable');
  295. $mform->setType('enable', PARAM_INT);
  296. $mform->addElement('html', $code_javascript);
  297. } // if ($CFG->action_ilm != 'import')
  298. else {
  299. $mform->addElement('header', 'upload_ilm', get_string('upload_ilm', 'iassign'));
  300. //$mform->setExpanded('upload_ilm');
  301. $options = array('subdirs' => 0, 'maxbytes' => $CFG->userquota, 'maxfiles' => 1, 'accepted_types' => array('*'));
  302. $mform->addElement('filepicker', 'file', null, null, $options);
  303. $mform->addRule('file', get_string('required', 'iassign'), 'required');
  304. $mform->addElement('hidden', 'action'); //DEBUG: is it necessary?
  305. $mform->setType('action', PARAM_TEXT);
  306. }
  307. $this->add_action_buttons();
  308. } // function definition()
  309. } // class mod_ilm_form extends moodleform