Merge branch 'MDL-34633-23' of git://github.com/FMCorz/moodle into MOODLE_23_STABLE
[moodle.git] / user / selector / module.js
1 /**
2  * JavaScript for the user selectors.
3  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4  * @package userselector
5  */
7 // Define the core_user namespace if it has not already been defined
8 M.core_user = M.core_user || {};
9 // Define a user selectors array for against the cure_user namespace
10 M.core_user.user_selectors = [];
11 /**
12  * Retrieves an instantiated user selector or null if there isn't one by the requested name
13  * @param {string} name The name of the selector to retrieve
14  * @return bool
15  */
16 M.core_user.get_user_selector = function (name) {
17     return this.user_selectors[name] || null;
18 };
20 /**
21  * Initialise a new user selector.
22  *
23  * @param {YUI} Y The YUI3 instance
24  * @param {string} name the control name/id.
25  * @param {string} hash the hash that identifies this selector in the user's session.
26  * @param {array} extrafields extra fields we are displaying for each user in addition to fullname.
27  * @param {string} lastsearch The last search that took place
28  */
29 M.core_user.init_user_selector = function (Y, name, hash, extrafields, lastsearch) {
30     // Creates a new user_selector object
31     var user_selector = {
32         /** This id/name used for this control in the HTML. */
33         name : name,
34         /** Array of fields to display for each user, in addition to fullname. */
35         extrafields: extrafields,
36         /** Number of seconds to delay before submitting a query request */
37         querydelay : 0.5,
38         /** The input element that contains the search term. */
39         searchfield : Y.one('#'+name + '_searchtext'),
40         /** The clear button. */
41         clearbutton : null,
42         /** The select element that contains the list of users. */
43         listbox : Y.one('#'+name),
44         /** Used to hold the timeout id of the timeout that waits before doing a search. */
45         timeoutid : null,
46         /** The last string that we searched for, so we can avoid unnecessary repeat searches. */
47         lastsearch : lastsearch,
48         /** Whether any options where selected last time we checked. Used by
49          *  handle_selection_change to track when this status changes. */
50         selectionempty : true,
51         /**
52          * Initialises the user selector object
53          * @constructor
54          */
55         init : function() {
56             // Hide the search button and replace it with a label.
57             var searchbutton = Y.one('#'+this.name + '_searchbutton');
58             this.searchfield.insert(Y.Node.create('<label for="'+this.name + '_searchtext">'+searchbutton.get('value')+'</label>'), this.searchfield);
59             searchbutton.remove();
61             // Hook up the event handler for when the search text changes.
62             this.searchfield.on('keyup', this.handle_keyup, this);
64             // Hook up the event handler for when the selection changes.
65             this.listbox.on('keyup', this.handle_selection_change, this);
66             this.listbox.on('click', this.handle_selection_change, this);
67             this.listbox.on('change', this.handle_selection_change, this);
69             // And when the search any substring preference changes. Do an immediate re-search.
70             Y.one('#userselector_searchanywhereid').on('click', this.handle_searchanywhere_change, this);
72             // Define our custom event.
73             //this.createEvent('selectionchanged');
74             this.selectionempty = this.is_selection_empty();
76             // Replace the Clear submit button with a clone that is not a submit button.
77             var clearbtn = Y.one('#'+this.name + '_clearbutton');
78             this.clearbutton = Y.Node.create('<input type="button" value="'+clearbtn.get('value')+'" />');
79             clearbtn.replace(Y.Node.getDOMNode(this.clearbutton));
80             this.clearbutton.set('id',+this.name+"_clearbutton");
81             this.clearbutton.on('click', this.handle_clear, this);
83             this.send_query(false);
84         },
85         /**
86          * Key up hander for the search text box.
87          * @param {Y.Event} e the keyup event.
88          */
89         handle_keyup : function(e) {
90             //  Trigger an ajax search after a delay.
91             this.cancel_timeout();
92             this.timeoutid = Y.later(this.querydelay*1000, e, function(obj){obj.send_query(false)}, this);
94             // Enable or diable the clear button.
95             this.clearbutton.set('disabled', (this.get_search_text() == ''));
97             // If enter was pressed, prevent a form submission from happening.
98             if (e.keyCode == 13) {
99                 e.halt();
100             }
101         },
102         /**
103          * Handles when the selection has changed. If the selection has changed from
104          * empty to not-empty, or vice versa, then fire the event handlers.
105          */
106         handle_selection_change : function() {
107             var isselectionempty = this.is_selection_empty();
108             if (isselectionempty !== this.selectionempty) {
109                 this.fire('user_selector:selectionchanged', isselectionempty);
110             }
111             this.selectionempty = isselectionempty;
112         },
113         /**
114          * Trigger a re-search when the 'search any substring' option is changed.
115          */
116         handle_searchanywhere_change : function() {
117             if (this.lastsearch != '' && this.get_search_text() != '') {
118                 this.send_query(true);
119             }
120         },
121         /**
122          * Click handler for the clear button..
123          */
124         handle_clear : function() {
125             this.searchfield.set('value', '');
126             this.clearbutton.set('disabled',true);
127             this.send_query(false);
128         },
129         /**
130          * Fires off the ajax search request.
131          */
132         send_query : function(forceresearch) {
133             // Cancel any pending timeout.
134             this.cancel_timeout();
136             var value = this.get_search_text();
137             this.searchfield.set('class', '');
138             if (this.lastsearch == value && !forceresearch) {
139                 return;
140             }
142             Y.io(M.cfg.wwwroot + '/user/selector/search.php', {
143                 method: 'POST',
144                 data: 'selectorid='+hash+'&sesskey='+M.cfg.sesskey+'&search='+value + '&userselector_searchanywhere=' + this.get_option('searchanywhere'),
145                 on: {
146                     success:this.handle_response,
147                     failure:this.handle_failure
148                 },
149                 context:this
150             });
152             this.lastsearch = value;
153             this.listbox.setStyle('background','url(' + M.util.image_url('i/loading', 'moodle') + ') no-repeat center center');
154         },
155         /**
156          * Handle what happens when we get some data back from the search.
157          * @param {int} requestid not used.
158          * @param {object} response the list of users that was returned.
159          */
160         handle_response : function(requestid, response) {
161             try {
162                 this.listbox.setStyle('background','');
163                 var data = Y.JSON.parse(response.responseText);
164                 this.output_options(data);
165             } catch (e) {
166                 this.handle_failure();
167             }
168         },
169         /**
170          * Handles what happens when the ajax request fails.
171          */
172         handle_failure : function() {
173             this.listbox.setStyle('background','');
174             this.searchfield.addClass('error');
176             // If we are in developer debug mode, output a link to help debug the failure.
177             if (M.cfg.developerdebug) {
178                 this.searchfield.insert(Y.Node.create('<a href="'+M.cfg.wwwroot +'/user/selector/search.php?selectorid='+hash+'&sesskey='+M.cfg.sesskey+'&search='+this.get_search_text()+'&debug=1">Ajax call failed. Click here to try the search call directly.</a>'));
179             }
180         },
181         /**
182          * This method should do the same sort of thing as the PHP method
183          * user_selector_base::output_options.
184          * @param {object} data the list of users to populate the list box with.
185          */
186         output_options : function(data) {
187             // Clear out the existing options, keeping any ones that are already selected.
188             var selectedusers = {};
189             this.listbox.all('optgroup').each(function(optgroup){
190                 optgroup.all('option').each(function(option){
191                     if (option.get('selected')) {
192                         selectedusers[option.get('value')] = {
193                             id : option.get('value'),
194                             name : option.get('innerText') || option.get('textContent'),
195                             disabled: option.get('disabled')
196                         }
197                     }
198                     option.remove();
199                 }, this);
200                 optgroup.remove();
201             }, this);
203             // Output each optgroup.
204             var count = 0;
205             for (var groupname in data.results) {
206                 this.output_group(groupname, data.results[groupname], selectedusers, true);
207                 count++;
208             }
209             if (!count) {
210                 var searchstr = (this.lastsearch != '')?this.insert_search_into_str(M.str.moodle.nomatchingusers, this.lastsearch):M.str.moodle.none;
211                 this.output_group(searchstr, {}, selectedusers, true)
212             }
214             // If there were previously selected users who do not match the search, show them too.
215             if (this.get_option('preserveselected') && selectedusers) {
216                 this.output_group(this.insert_search_into_str(M.str.moodle.previouslyselectedusers, this.lastsearch), selectedusers, true, false);
217             }
218             this.handle_selection_change();
219         },
220         /**
221          * This method should do the same sort of thing as the PHP method
222          * user_selector_base::output_optgroup.
223          *
224          * @param {string} groupname the label for this optgroup.v
225          * @param {object} users the users to put in this optgroup.
226          * @param {boolean|object} selectedusers if true, select the users in this group.
227          * @param {boolean} processsingle
228          */
229         output_group : function(groupname, users, selectedusers, processsingle) {
230             var optgroup = Y.Node.create('<optgroup></optgroup>');
231             var count = 0;
232             for (var userid in users) {
233                 var user = users[userid];
234                 var option = Y.Node.create('<option value="'+userid+'">'+user.name+'</option>');
235                 if (user.disabled) {
236                     option.set('disabled', true);
237                 } else if (selectedusers===true || selectedusers[userid]) {
238                     option.set('selected', true);
239                 } else {
240                     option.set('selected', false);
241                 }
242                 optgroup.append(option);
243                 count++;
244             }
246             if (count > 0) {
247                 optgroup.set('label', groupname+' ('+count+')');
248                 if (processsingle && count===1 && this.get_option('autoselectunique') && option.get('disabled')) {
249                     option.set('selected', true);
250                 }
251             } else {
252                 optgroup.append(Y.Node.create('<option disabled="disabled">\u00A0</option>'));
253             }
254             this.listbox.append(optgroup);
255         },
256         /**
257          * Replace
258          * @param {string} str
259          * @param {string} search The search term
260          * @return string
261          */
262         insert_search_into_str : function(str, search) {
263             return str.replace("%%SEARCHTERM%%", search);
264         },
265         /**
266          * Gets the search text
267          * @return String the value to search for, with leading and trailing whitespace trimmed.
268          */
269         get_search_text : function() {
270             return this.searchfield.get('value').toString().replace(/^ +| +$/, '');
271         },
272         /**
273          * Returns true if the selection is empty (nothing is selected)
274          * @return Boolean check all the options and return whether any are selected.
275          */
276         is_selection_empty : function() {
277             var selection = false;
278             this.listbox.all('option').each(function(){
279                 if (this.get('selected')) {
280                     selection = true;
281                 }
282             });
283             return !(selection);
284         },
285         /**
286          * Cancel the search delay timeout, if there is one.
287          */
288         cancel_timeout : function() {
289             if (this.timeoutid) {
290                 clearTimeout(this.timeoutid);
291                 this.timeoutid = null;
292             }
293         },
294         /**
295          * @param {string} name The name of the option to retrieve
296          * @return the value of one of the option checkboxes.
297          */
298         get_option : function(name) {
299             var checkbox = Y.one('#userselector_' + name + 'id');
300             if (checkbox) {
301                 return (checkbox.get('checked'));
302             } else {
303                 return false;
304             }
305         }
306     };
307     // Augment the user selector with the EventTarget class so that we can use
308     // custom events
309     Y.augment(user_selector, Y.EventTarget, null, null, {});
310     // Initialise the user selector
311     user_selector.init();
312     // Store the user selector so that it can be retrieved
313     this.user_selectors[name] = user_selector;
314     // Return the user selector
315     return user_selector;
316 };
318 /**
319  * Initialise a class that updates the user's preferences when they change one of
320  * the options checkboxes.
321  * @constructor
322  * @param {YUI} Y
323  * @return Tracker object
324  */
325 M.core_user.init_user_selector_options_tracker = function(Y) {
326     // Create a user selector options tracker
327     var user_selector_options_tracker = {
328         /**
329          * Initlises the option tracker and gets everything going.
330          * @constructor
331          */
332         init : function() {
333             var settings = [
334                 'userselector_preserveselected',
335                 'userselector_autoselectunique',
336                 'userselector_searchanywhere'
337             ];
338             for (var s in settings) {
339                 var setting = settings[s];
340                 Y.one('#'+setting+'id').on('click', this.set_user_preference, this, setting);
341             }
342         },
343         /**
344          * Sets a user preference for the options tracker
345          * @param {Y.Event|null} e
346          * @param {string} name The name of the preference to set
347          */
348         set_user_preference : function(e, name) {
349             M.util.set_user_preference(name, Y.one('#'+name+'id').get('checked'));
350         }
351     };
352     // Initialise the options tracker
353     user_selector_options_tracker.init();
354     // Return it just incase it is ever wanted
355     return user_selector_options_tracker;
356 };