]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - js/util.js
Merge branch '0.9.x'
[quix0rs-gnu-social.git] / js / util.js
1 /*
2  * StatusNet - a distributed open-source microblogging tool
3  * Copyright (C) 2008, StatusNet, Inc.
4  *
5  * This program is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU Affero General Public License as published by
7  * the Free Software Foundation, either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Affero General Public License for more details.
14  *
15  * You should have received a copy of the GNU Affero General Public License
16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
17  *
18  * @category  UI interaction
19  * @package   StatusNet
20  * @author    Sarven Capadisli <csarven@status.net>
21  * @author    Evan Prodromou <evan@status.net>
22  * @author    Brion Vibber <brion@status.net>
23  * @copyright 2009,2010 StatusNet, Inc.
24  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
25  * @link      http://status.net/
26  */
27
28 var SN = { // StatusNet
29     C: { // Config
30         I: { // Init
31             CounterBlackout: false,
32             MaxLength: 140,
33             PatternUsername: /^[0-9a-zA-Z\-_.]*$/,
34             HTTP20x30x: [200, 201, 202, 203, 204, 205, 206, 300, 301, 302, 303, 304, 305, 306, 307]
35         },
36
37         /**
38          * @fixme are these worth the trouble? They seem to mostly just duplicate
39          * themselves while slightly obscuring the actual selector, so it's hard
40          * to pop over to the HTML and find something.
41          *
42          * In theory, minification could reduce them to shorter variable names,
43          * but at present that doesn't happen with yui-compressor.
44          */
45         S: { // Selector
46             Disabled: 'disabled',
47             Warning: 'warning',
48             Error: 'error',
49             Success: 'success',
50             Processing: 'processing',
51             CommandResult: 'command_result',
52             FormNotice: 'form_notice',
53             NoticeDataText: 'notice_data-text',
54             NoticeTextCount: 'notice_text-count',
55             NoticeInReplyTo: 'notice_in-reply-to',
56             NoticeDataAttach: 'notice_data-attach',
57             NoticeDataAttachSelected: 'notice_data-attach_selected',
58             NoticeActionSubmit: 'notice_action-submit',
59             NoticeLat: 'notice_data-lat',
60             NoticeLon: 'notice_data-lon',
61             NoticeLocationId: 'notice_data-location_id',
62             NoticeLocationNs: 'notice_data-location_ns',
63             NoticeGeoName: 'notice_data-geo_name',
64             NoticeDataGeo: 'notice_data-geo',
65             NoticeDataGeoCookie: 'NoticeDataGeo',
66             NoticeDataGeoSelected: 'notice_data-geo_selected',
67             StatusNetInstance:'StatusNetInstance'
68         }
69     },
70
71     /**
72      * Map of localized message strings exported to script from the PHP
73      * side via Action::getScriptMessages().
74      *
75      * Retrieve them via SN.msg(); this array is an implementation detail.
76      *
77      * @access private
78      */
79     messages: {},
80
81     /**
82      * Grabs a localized string that's been previously exported to us
83      * from server-side code via Action::getScriptMessages().
84      *
85      * @example alert(SN.msg('coolplugin-failed'));
86      *
87      * @param {String} key: string key name to pull from message index
88      * @return matching localized message string
89      */
90     msg: function(key) {
91         if (typeof SN.messages[key] == "undefined") {
92             return '[' + key + ']';
93         } else {
94             return SN.messages[key];
95         }
96     },
97
98     U: { // Utils
99         /**
100          * Setup function -- DOES NOT trigger actions immediately.
101          *
102          * Sets up event handlers on the new notice form.
103          *
104          * @param {jQuery} form: jQuery object whose first matching element is the form
105          * @access private
106          */
107         FormNoticeEnhancements: function(form) {
108             if (jQuery.data(form[0], 'ElementData') === undefined) {
109                 MaxLength = form.find('#'+SN.C.S.NoticeTextCount).text();
110                 if (typeof(MaxLength) == 'undefined') {
111                      MaxLength = SN.C.I.MaxLength;
112                 }
113                 jQuery.data(form[0], 'ElementData', {MaxLength:MaxLength});
114
115                 SN.U.Counter(form);
116
117                 NDT = form.find('#'+SN.C.S.NoticeDataText);
118
119                 NDT.bind('keyup', function(e) {
120                     SN.U.Counter(form);
121                 });
122
123                 var delayedUpdate= function(e) {
124                     // Cut and paste events fire *before* the operation,
125                     // so we need to trigger an update in a little bit.
126                     // This would be so much easier if the 'change' event
127                     // actually fired every time the value changed. :P
128                     window.setTimeout(function() {
129                         SN.U.Counter(form);
130                     }, 50);
131                 };
132                 // Note there's still no event for mouse-triggered 'delete'.
133                 NDT.bind('cut', delayedUpdate)
134                    .bind('paste', delayedUpdate);
135
136                 NDT.bind('keydown', function(e) {
137                     SN.U.SubmitOnReturn(e, form);
138                 });
139             }
140             else {
141                 form.find('#'+SN.C.S.NoticeTextCount).text(jQuery.data(form[0], 'ElementData').MaxLength);
142             }
143
144             if ($('body')[0].id != 'conversation' && window.location.hash.length === 0 && $(window).scrollTop() == 0) {
145                 form.find('textarea').focus();
146             }
147         },
148
149         /**
150          * To be called from keydown event handler on the notice import form.
151          * Checks if return or enter key was pressed, and if so attempts to
152          * submit the form and cancel standard processing of the enter key.
153          *
154          * @param {Event} event
155          * @param {jQuery} el: jQuery object whose first element is the notice posting form
156          *
157          * @return {boolean} whether to cancel the event? Does this actually pass through?
158          * @access private
159          */
160         SubmitOnReturn: function(event, el) {
161             if (event.keyCode == 13 || event.keyCode == 10) {
162                 el.submit();
163                 event.preventDefault();
164                 event.stopPropagation();
165                 $('#'+el[0].id+' #'+SN.C.S.NoticeDataText).blur();
166                 $('body').focus();
167                 return false;
168             }
169             return true;
170         },
171
172         /**
173          * To be called from event handlers on the notice import form.
174          * Triggers an update of the remaining-characters counter.
175          *
176          * Additional counter updates will be suppressed during the
177          * next half-second to avoid flooding the layout engine with
178          * updates, followed by another automatic check.
179          *
180          * The maximum length is pulled from data established by
181          * FormNoticeEnhancements.
182          *
183          * @param {jQuery} form: jQuery object whose first element is the notice posting form
184          * @access private
185          */
186         Counter: function(form) {
187             SN.C.I.FormNoticeCurrent = form;
188
189             var MaxLength = jQuery.data(form[0], 'ElementData').MaxLength;
190
191             if (MaxLength <= 0) {
192                 return;
193             }
194
195             var remaining = MaxLength - SN.U.CharacterCount(form);
196             var counter = form.find('#'+SN.C.S.NoticeTextCount);
197
198             if (remaining.toString() != counter.text()) {
199                 if (!SN.C.I.CounterBlackout || remaining === 0) {
200                     if (counter.text() != String(remaining)) {
201                         counter.text(remaining);
202                     }
203                     if (remaining < 0) {
204                         form.addClass(SN.C.S.Warning);
205                     } else {
206                         form.removeClass(SN.C.S.Warning);
207                     }
208                     // Skip updates for the next 500ms.
209                     // On slower hardware, updating on every keypress is unpleasant.
210                     if (!SN.C.I.CounterBlackout) {
211                         SN.C.I.CounterBlackout = true;
212                         SN.C.I.FormNoticeCurrent = form;
213                         window.setTimeout("SN.U.ClearCounterBlackout(SN.C.I.FormNoticeCurrent);", 500);
214                     }
215                 }
216             }
217         },
218
219         /**
220          * Pull the count of characters in the current edit field.
221          * Plugins replacing the edit control may need to override this.
222          *
223          * @param {jQuery} form: jQuery object whose first element is the notice posting form
224          * @return number of chars
225          */
226         CharacterCount: function(form) {
227             return form.find('#'+SN.C.S.NoticeDataText).val().length;
228         },
229
230         /**
231          * Called internally after the counter update blackout period expires;
232          * runs another update to make sure we didn't miss anything.
233          *
234          * @param {jQuery} form: jQuery object whose first element is the notice posting form
235          * @access private
236          */
237         ClearCounterBlackout: function(form) {
238             // Allow keyup events to poke the counter again
239             SN.C.I.CounterBlackout = false;
240             // Check if the string changed since we last looked
241             SN.U.Counter(form);
242         },
243
244         /**
245          * Helper function to rewrite default HTTP form action URLs to HTTPS
246          * so we can actually fetch them when on an SSL page in ssl=sometimes
247          * mode.
248          *
249          * It would be better to output URLs that didn't hardcode protocol
250          * and hostname in the first place...
251          *
252          * @param {String} url
253          * @return string
254          */
255         RewriteAjaxAction: function(url) {
256             // Quick hack: rewrite AJAX submits to HTTPS if they'd fail otherwise.
257             if (document.location.protocol == 'https:' && url.substr(0, 5) == 'http:') {
258                 return url.replace(/^http:\/\/[^:\/]+/, 'https://' + document.location.host);
259             } else {
260                 return url;
261             }
262         },
263
264         /**
265          * Grabs form data and submits it asynchronously, with 'ajax=1'
266          * parameter added to the rest.
267          *
268          * If a successful response includes another form, that form
269          * will be extracted and copied in, replacing the original form.
270          * If there's no form, the first paragraph will be used.
271          *
272          * @fixme can sometimes explode confusingly if returnd data is bogus
273          * @fixme error handling is pretty vague
274          * @fixme can't submit file uploads
275          *
276          * @param {jQuery} form: jQuery object whose first element is a form
277          *
278          * @access public
279          */
280         FormXHR: function(form) {
281             $.ajax({
282                 type: 'POST',
283                 dataType: 'xml',
284                 url: SN.U.RewriteAjaxAction(form.attr('action')),
285                 data: form.serialize() + '&ajax=1',
286                 beforeSend: function(xhr) {
287                     form
288                         .addClass(SN.C.S.Processing)
289                         .find('.submit')
290                             .addClass(SN.C.S.Disabled)
291                             .attr(SN.C.S.Disabled, SN.C.S.Disabled);
292                 },
293                 error: function (xhr, textStatus, errorThrown) {
294                     alert(errorThrown || textStatus);
295                 },
296                 success: function(data, textStatus) {
297                     if (typeof($('form', data)[0]) != 'undefined') {
298                         form_new = document._importNode($('form', data)[0], true);
299                         form.replaceWith(form_new);
300                     }
301                     else {
302                         form.replaceWith(document._importNode($('p', data)[0], true));
303                     }
304                 }
305             });
306         },
307
308         /**
309          * Setup function -- DOES NOT trigger actions immediately.
310          *
311          * Sets up event handlers for special-cased async submission of the
312          * notice-posting form, including some pre-post validation.
313          *
314          * Unlike FormXHR() this does NOT submit the form immediately!
315          * It sets up event handlers so that any method of submitting the
316          * form (click on submit button, enter, submit() etc) will trigger
317          * it properly.
318          *
319          * Also unlike FormXHR(), this system will use a hidden iframe
320          * automatically to handle file uploads via <input type="file">
321          * controls.
322          *
323          * @fixme tl;dr
324          * @fixme vast swaths of duplicate code and really long variable names clutter this function up real bad
325          * @fixme error handling is unreliable
326          * @fixme cookieValue is a global variable, but probably shouldn't be
327          * @fixme saving the location cache cookies should be split out
328          * @fixme some error messages are hardcoded english: needs i18n
329          * @fixme special-case for bookmarklet is confusing and uses a global var "self". Is this ok?
330          *
331          * @param {jQuery} form: jQuery object whose first element is a form
332          *
333          * @access public
334          */
335         FormNoticeXHR: function(form) {
336             SN.C.I.NoticeDataGeo = {};
337             form.append('<input type="hidden" name="ajax" value="1"/>');
338
339             // Make sure we don't have a mixed HTTP/HTTPS submission...
340             form.attr('action', SN.U.RewriteAjaxAction(form.attr('action')));
341
342             /**
343              * Show a response feedback bit under the new-notice dialog.
344              *
345              * @param {String} cls: CSS class name to use ('error' or 'success')
346              * @param {String} text
347              * @access private
348              */
349             var showFeedback = function(cls, text) {
350                 form.append(
351                     $('<p class="form_response"></p>')
352                         .addClass(cls)
353                         .text(text)
354                 );
355             };
356
357             /**
358              * Hide the previous response feedback, if any.
359              */
360             var removeFeedback = function() {
361                 form.find('.form_response').remove();
362             };
363
364             form.ajaxForm({
365                 dataType: 'xml',
366                 timeout: '60000',
367                 beforeSend: function(formData) {
368                     if (form.find('#'+SN.C.S.NoticeDataText)[0].value.length === 0) {
369                         form.addClass(SN.C.S.Warning);
370                         return false;
371                     }
372                     form
373                         .addClass(SN.C.S.Processing)
374                         .find('#'+SN.C.S.NoticeActionSubmit)
375                             .addClass(SN.C.S.Disabled)
376                             .attr(SN.C.S.Disabled, SN.C.S.Disabled);
377
378                     SN.C.I.NoticeDataGeo.NLat = $('#'+SN.C.S.NoticeLat).val();
379                     SN.C.I.NoticeDataGeo.NLon = $('#'+SN.C.S.NoticeLon).val();
380                     SN.C.I.NoticeDataGeo.NLNS = $('#'+SN.C.S.NoticeLocationNs).val();
381                     SN.C.I.NoticeDataGeo.NLID = $('#'+SN.C.S.NoticeLocationId).val();
382                     SN.C.I.NoticeDataGeo.NDG = $('#'+SN.C.S.NoticeDataGeo).attr('checked');
383
384                     cookieValue = $.cookie(SN.C.S.NoticeDataGeoCookie);
385
386                     if (cookieValue !== null && cookieValue != 'disabled') {
387                         cookieValue = JSON.parse(cookieValue);
388                         SN.C.I.NoticeDataGeo.NLat = $('#'+SN.C.S.NoticeLat).val(cookieValue.NLat).val();
389                         SN.C.I.NoticeDataGeo.NLon = $('#'+SN.C.S.NoticeLon).val(cookieValue.NLon).val();
390                         if ($('#'+SN.C.S.NoticeLocationNs).val(cookieValue.NLNS)) {
391                             SN.C.I.NoticeDataGeo.NLNS = $('#'+SN.C.S.NoticeLocationNs).val(cookieValue.NLNS).val();
392                             SN.C.I.NoticeDataGeo.NLID = $('#'+SN.C.S.NoticeLocationId).val(cookieValue.NLID).val();
393                         }
394                     }
395                     if (cookieValue == 'disabled') {
396                         SN.C.I.NoticeDataGeo.NDG = $('#'+SN.C.S.NoticeDataGeo).attr('checked', false).attr('checked');
397                     }
398                     else {
399                         SN.C.I.NoticeDataGeo.NDG = $('#'+SN.C.S.NoticeDataGeo).attr('checked', true).attr('checked');
400                     }
401
402                     return true;
403                 },
404                 error: function (xhr, textStatus, errorThrown) {
405                     form
406                         .removeClass(SN.C.S.Processing)
407                         .find('#'+SN.C.S.NoticeActionSubmit)
408                             .removeClass(SN.C.S.Disabled)
409                             .removeAttr(SN.C.S.Disabled, SN.C.S.Disabled);
410                     removeFeedback();
411                     if (textStatus == 'timeout') {
412                         // @fixme i18n
413                         showFeedback('error', 'Sorry! We had trouble sending your notice. The servers are overloaded. Please try again, and contact the site administrator if this problem persists.');
414                     }
415                     else {
416                         var response = SN.U.GetResponseXML(xhr);
417                         if ($('.'+SN.C.S.Error, response).length > 0) {
418                             form.append(document._importNode($('.'+SN.C.S.Error, response)[0], true));
419                         }
420                         else {
421                             if (parseInt(xhr.status) === 0 || jQuery.inArray(parseInt(xhr.status), SN.C.I.HTTP20x30x) >= 0) {
422                                 form
423                                     .resetForm()
424                                     .find('#'+SN.C.S.NoticeDataAttachSelected).remove();
425                                 SN.U.FormNoticeEnhancements(form);
426                             }
427                             else {
428                                 // @fixme i18n
429                                 showFeedback('error', '(Sorry! We had trouble sending your notice ('+xhr.status+' '+xhr.statusText+'). Please report the problem to the site administrator if this happens again.');
430                             }
431                         }
432                     }
433                 },
434                 success: function(data, textStatus) {
435                     removeFeedback();
436                     var errorResult = $('#'+SN.C.S.Error, data);
437                     if (errorResult.length > 0) {
438                         showFeedback('error', errorResult.text());
439                     }
440                     else {
441                         if($('body')[0].id == 'bookmarklet') {
442                             // @fixme self is not referenced anywhere?
443                             self.close();
444                         }
445
446                         var commandResult = $('#'+SN.C.S.CommandResult, data);
447                         if (commandResult.length > 0) {
448                             showFeedback('success', commandResult.text());
449                         }
450                         else {
451                             // New notice post was successful. If on our timeline, show it!
452                             var notice = document._importNode($('li', data)[0], true);
453                             var notices = $('#notices_primary .notices');
454                             if (notices.length > 0 && SN.U.belongsOnTimeline(notice)) {
455                                 if ($('#'+notice.id).length === 0) {
456                                     var notice_irt_value = $('#'+SN.C.S.NoticeInReplyTo).val();
457                                     var notice_irt = '#notices_primary #notice-'+notice_irt_value;
458                                     if($('body')[0].id == 'conversation') {
459                                         if(notice_irt_value.length > 0 && $(notice_irt+' .notices').length < 1) {
460                                             $(notice_irt).append('<ul class="notices"></ul>');
461                                         }
462                                         $($(notice_irt+' .notices')[0]).append(notice);
463                                     }
464                                     else {
465                                         notices.prepend(notice);
466                                     }
467                                     $('#'+notice.id)
468                                         .css({display:'none'})
469                                         .fadeIn(2500);
470                                     SN.U.NoticeWithAttachment($('#'+notice.id));
471                                     SN.U.NoticeReplyTo($('#'+notice.id));
472                                 }
473                             }
474                             else {
475                                 // Not on a timeline that this belongs on?
476                                 // Just show a success message.
477                                 showFeedback('success', $('title', data).text());
478                             }
479                         }
480                         form.resetForm();
481                         form.find('#'+SN.C.S.NoticeInReplyTo).val('');
482                         form.find('#'+SN.C.S.NoticeDataAttachSelected).remove();
483                         SN.U.FormNoticeEnhancements(form);
484                     }
485                 },
486                 complete: function(xhr, textStatus) {
487                     form
488                         .removeClass(SN.C.S.Processing)
489                         .find('#'+SN.C.S.NoticeActionSubmit)
490                             .removeAttr(SN.C.S.Disabled)
491                             .removeClass(SN.C.S.Disabled);
492
493                     $('#'+SN.C.S.NoticeLat).val(SN.C.I.NoticeDataGeo.NLat);
494                     $('#'+SN.C.S.NoticeLon).val(SN.C.I.NoticeDataGeo.NLon);
495                     if ($('#'+SN.C.S.NoticeLocationNs)) {
496                         $('#'+SN.C.S.NoticeLocationNs).val(SN.C.I.NoticeDataGeo.NLNS);
497                         $('#'+SN.C.S.NoticeLocationId).val(SN.C.I.NoticeDataGeo.NLID);
498                     }
499                     $('#'+SN.C.S.NoticeDataGeo).attr('checked', SN.C.I.NoticeDataGeo.NDG);
500                 }
501             });
502         },
503
504         /**
505          * Fetch an XML DOM from an XHR's response data.
506          *
507          * Works around unavailable responseXML when document.domain
508          * has been modified by Meteor or other tools, in some but not
509          * all browsers.
510          *
511          * @param {XMLHTTPRequest} xhr
512          * @return DOMDocument
513          */
514         GetResponseXML: function(xhr) {
515             try {
516                 return xhr.responseXML;
517             } catch (e) {
518                 return (new DOMParser()).parseFromString(xhr.responseText, "text/xml");
519             }
520         },
521
522         /**
523          * Setup function -- DOES NOT trigger actions immediately.
524          *
525          * Sets up event handlers on all visible notice's reply buttons to
526          * tweak the new-notice form with needed variables and focus it
527          * when pushed.
528          *
529          * (This replaces the default reply button behavior to submit
530          * directly to a form which comes back with a specialized page
531          * with the form data prefilled.)
532          *
533          * @access private
534          */
535         NoticeReply: function() {
536             if ($('#'+SN.C.S.NoticeDataText).length > 0 && $('#content .notice_reply').length > 0) {
537                 $('#content .notice').each(function() { SN.U.NoticeReplyTo($(this)); });
538             }
539         },
540
541         /**
542          * Setup function -- DOES NOT trigger actions immediately.
543          *
544          * Sets up event handlers on the given notice's reply button to
545          * tweak the new-notice form with needed variables and focus it
546          * when pushed.
547          *
548          * (This replaces the default reply button behavior to submit
549          * directly to a form which comes back with a specialized page
550          * with the form data prefilled.)
551          *
552          * @param {jQuery} notice: jQuery object containing one or more notices
553          * @access private
554          */
555         NoticeReplyTo: function(notice) {
556             notice.find('.notice_reply').live('click', function() {
557                 var nickname = ($('.author .nickname', notice).length > 0) ? $($('.author .nickname', notice)[0]) : $('.author .nickname.uid');
558                 SN.U.NoticeReplySet(nickname.text(), $($('.notice_id', notice)[0]).text());
559                 return false;
560             });
561         },
562
563         /**
564          * Updates the new notice posting form with bits for replying to the
565          * given user. Adds replyto parameter to the form, and a "@foo" to the
566          * text area.
567          *
568          * @fixme replyto is a global variable, but probably shouldn't be
569          *
570          * @param {String} nick
571          * @param {String} id
572          */
573         NoticeReplySet: function(nick,id) {
574             if (nick.match(SN.C.I.PatternUsername)) {
575                 var text = $('#'+SN.C.S.NoticeDataText);
576                 if (text.length > 0) {
577                     replyto = '@' + nick + ' ';
578                     text.val(replyto + text.val().replace(RegExp(replyto, 'i'), ''));
579                     $('#'+SN.C.S.FormNotice+' #'+SN.C.S.NoticeInReplyTo).val(id);
580
581                     text[0].focus();
582                     if (text[0].setSelectionRange) {
583                         var len = text.val().length;
584                         text[0].setSelectionRange(len,len);
585                     }
586                 }
587             }
588         },
589
590         /**
591          * Setup function -- DOES NOT apply immediately.
592          *
593          * Sets up event handlers for favor/disfavor forms to submit via XHR.
594          * Uses 'live' rather than 'bind', so applies to future as well as present items.
595          */
596         NoticeFavor: function() {
597             $('.form_favor').live('click', function() { SN.U.FormXHR($(this)); return false; });
598             $('.form_disfavor').live('click', function() { SN.U.FormXHR($(this)); return false; });
599         },
600
601         /**
602          * Setup function -- DOES NOT trigger actions immediately.
603          *
604          * Sets up event handlers for repeat forms to toss up a confirmation
605          * popout before submitting.
606          *
607          * Uses 'live' rather than 'bind', so applies to future as well as present items.
608          */
609         NoticeRepeat: function() {
610             $('.form_repeat').live('click', function(e) {
611                 e.preventDefault();
612
613                 SN.U.NoticeRepeatConfirmation($(this));
614                 return false;
615             });
616         },
617
618         /**
619          * Shows a confirmation dialog box variant of the repeat button form.
620          * This seems to use a technique where the repeat form contains
621          * _both_ a standalone button _and_ text and buttons for a dialog.
622          * The dialog will close after its copy of the form is submitted,
623          * or if you click its 'close' button.
624          *
625          * The dialog is created by duplicating the original form and changing
626          * its style; while clever, this is hard to generalize and probably
627          * duplicates a lot of unnecessary HTML output.
628          *
629          * @fixme create confirmation dialogs through a generalized interface
630          * that can be reused instead of hardcoded text and styles.
631          *
632          * @param {jQuery} form
633          */
634         NoticeRepeatConfirmation: function(form) {
635             var submit_i = form.find('.submit');
636
637             var submit = submit_i.clone();
638             submit
639                 .addClass('submit_dialogbox')
640                 .removeClass('submit');
641             form.append(submit);
642             submit.bind('click', function() { SN.U.FormXHR(form); return false; });
643
644             submit_i.hide();
645
646             form
647                 .addClass('dialogbox')
648                 .append('<button class="close">&#215;</button>')
649                 .closest('.notice-options')
650                     .addClass('opaque');
651
652             form.find('button.close').click(function(){
653                 $(this).remove();
654
655                 form
656                     .removeClass('dialogbox')
657                     .closest('.notice-options')
658                         .removeClass('opaque');
659
660                 form.find('.submit_dialogbox').remove();
661                 form.find('.submit').show();
662
663                 return false;
664             });
665         },
666
667         /**
668          * Setup function -- DOES NOT trigger actions immediately.
669          *
670          * Goes through all notices currently displayed and sets up attachment
671          * handling if needed.
672          */
673         NoticeAttachments: function() {
674             $('.notice a.attachment').each(function() {
675                 SN.U.NoticeWithAttachment($(this).closest('.notice'));
676             });
677         },
678
679         /**
680          * Setup function -- DOES NOT trigger actions immediately.
681          *
682          * Sets up special attachment link handling if needed. Currently this
683          * consists only of making the "more" button used for OStatus message
684          * cropping turn into an auto-expansion button that loads the full
685          * text from an attachment file.
686          *
687          * @param {jQuery} notice
688          */
689         NoticeWithAttachment: function(notice) {
690             if (notice.find('.attachment').length === 0) {
691                 return;
692             }
693
694             var attachment_more = notice.find('.attachment.more');
695             if (attachment_more.length > 0) {
696                 $(attachment_more[0]).click(function() {
697                     var m = $(this);
698                     m.addClass(SN.C.S.Processing);
699                     $.get(m.attr('href')+'/ajax', null, function(data) {
700                         m.parent('.entry-content').html($(data).find('#attachment_view .entry-content').html());
701                     });
702
703                     return false;
704                 }).attr('title', SN.msg('showmore_tooltip'));
705             }
706         },
707
708         /**
709          * Setup function -- DOES NOT trigger actions immediately.
710          *
711          * Sets up event handlers for the file-attachment widget in the
712          * new notice form. When a file is selected, a box will be added
713          * below the text input showing the filename and, if supported
714          * by the browser, a thumbnail preview.
715          *
716          * This preview box will also allow removing the attachment
717          * prior to posting.
718          */
719         NoticeDataAttach: function() {
720             NDA = $('#'+SN.C.S.NoticeDataAttach);
721             NDA.change(function(event) {
722                 var filename = $(this).val();
723                 if (!filename) {
724                     // No file -- we've been tricked!
725                     $('#'+SN.C.S.NoticeDataAttachSelected).remove();
726                     return false;
727                 }
728
729                 // @fixme appending filename straight in is potentially unsafe
730                 S = '<div id="'+SN.C.S.NoticeDataAttachSelected+'" class="'+SN.C.S.Success+'"><code>'+filename+'</code> <button class="close">&#215;</button></div>';
731                 NDAS = $('#'+SN.C.S.NoticeDataAttachSelected);
732                 if (NDAS.length > 0) {
733                     NDAS.replaceWith(S);
734                 }
735                 else {
736                     $('#'+SN.C.S.FormNotice).append(S);
737                 }
738                 $('#'+SN.C.S.NoticeDataAttachSelected+' button').click(function(){
739                     $('#'+SN.C.S.NoticeDataAttachSelected).remove();
740                     NDA.val('');
741
742                     return false;
743                 });
744                 if (typeof this.files == "object") {
745                     // Some newer browsers will let us fetch the files for preview.
746                     for (var i = 0; i < this.files.length; i++) {
747                         SN.U.PreviewAttach(this.files[i]);
748                     }
749                 }
750             });
751         },
752
753         /**
754          * Get PHP's MAX_FILE_SIZE setting for this form;
755          * used to apply client-side file size limit checks.
756          *
757          * @param {jQuery} form
758          * @return int max size in bytes; 0 or negative means no limit
759          */
760         maxFileSize: function(form) {
761             var max = $(form).find('input[name=MAX_FILE_SIZE]').attr('value');
762             if (max) {
763                 return parseInt(max);
764             } else {
765                 return 0;
766             }
767         },
768
769         /**
770          * For browsers with FileAPI support: make a thumbnail if possible,
771          * and append it into the attachment display widget.
772          *
773          * Known good:
774          * - Firefox 3.6.6, 4.0b7
775          * - Chrome 8.0.552.210
776          *
777          * Known ok metadata, can't get contents:
778          * - Safari 5.0.2
779          *
780          * Known fail:
781          * - Opera 10.63, 11 beta (no input.files interface)
782          *
783          * @param {File} file
784          *
785          * @todo use configured thumbnail size
786          * @todo detect pixel size?
787          * @todo should we render a thumbnail to a canvas and then use the smaller image?
788          */
789         PreviewAttach: function(file) {
790             var tooltip = file.type + ' ' + Math.round(file.size / 1024) + 'KB';
791             var preview = true;
792
793             var blobAsDataURL;
794             if (typeof window.createObjectURL != "undefined") {
795                 /**
796                  * createObjectURL lets us reference the file directly from an <img>
797                  * This produces a compact URL with an opaque reference to the file,
798                  * which we can reference immediately.
799                  *
800                  * - Firefox 3.6.6: no
801                  * - Firefox 4.0b7: no
802                  * - Safari 5.0.2: no
803                  * - Chrome 8.0.552.210: works!
804                  */
805                 blobAsDataURL = function(blob, callback) {
806                     callback(window.createObjectURL(blob));
807                 }
808             } else if (typeof window.FileReader != "undefined") {
809                 /**
810                  * FileAPI's FileReader can build a data URL from a blob's contents,
811                  * but it must read the file and build it asynchronously. This means
812                  * we'll be passing a giant data URL around, which may be inefficient.
813                  *
814                  * - Firefox 3.6.6: works!
815                  * - Firefox 4.0b7: works!
816                  * - Safari 5.0.2: no
817                  * - Chrome 8.0.552.210: works!
818                  */
819                 blobAsDataURL = function(blob, callback) {
820                     var reader = new FileReader();
821                     reader.onload = function(event) {
822                         callback(reader.result);
823                     }
824                     reader.readAsDataURL(blob);
825                 }
826             } else {
827                 preview = false;
828             }
829
830             var imageTypes = ['image/png', 'image/jpeg', 'image/gif', 'image/svg+xml'];
831             if ($.inArray(file.type, imageTypes) == -1) {
832                 // We probably don't know how to show the file.
833                 preview = false;
834             }
835
836             var maxSize = 8 * 1024 * 1024;
837             if (file.size > maxSize) {
838                 // Don't kill the browser trying to load some giant image.
839                 preview = false;
840             }
841
842             if (preview) {
843                 blobAsDataURL(file, function(url) {
844                     var img = $('<img>')
845                         .attr('title', tooltip)
846                         .attr('alt', tooltip)
847                         .attr('src', url)
848                         .attr('style', 'height: 120px');
849                     $('#'+SN.C.S.NoticeDataAttachSelected).append(img);
850                 });
851             } else {
852                 var img = $('<div></div>').text(tooltip);
853                 $('#'+SN.C.S.NoticeDataAttachSelected).append(img);
854             }
855         },
856
857         /**
858          * Setup function -- DOES NOT trigger actions immediately.
859          *
860          * Initializes state for the location-lookup features in the
861          * new-notice form. Seems to set up some event handlers for
862          * triggering lookups and using the new values.
863          *
864          * @fixme tl;dr
865          * @fixme there's not good visual state update here, so users have a
866          *        hard time figuring out if it's working or fixing if it's wrong.
867          *
868          */
869         NoticeLocationAttach: function() {
870             var NLat = $('#'+SN.C.S.NoticeLat).val();
871             var NLon = $('#'+SN.C.S.NoticeLon).val();
872             var NLNS = $('#'+SN.C.S.NoticeLocationNs).val();
873             var NLID = $('#'+SN.C.S.NoticeLocationId).val();
874             var NLN = $('#'+SN.C.S.NoticeGeoName).text();
875             var NDGe = $('#'+SN.C.S.NoticeDataGeo);
876
877             function removeNoticeDataGeo() {
878                 $('label[for='+SN.C.S.NoticeDataGeo+']')
879                     .attr('title', jQuery.trim($('label[for='+SN.C.S.NoticeDataGeo+']').text()))
880                     .removeClass('checked');
881
882                 $('#'+SN.C.S.NoticeLat).val('');
883                 $('#'+SN.C.S.NoticeLon).val('');
884                 $('#'+SN.C.S.NoticeLocationNs).val('');
885                 $('#'+SN.C.S.NoticeLocationId).val('');
886                 $('#'+SN.C.S.NoticeDataGeo).attr('checked', false);
887
888                 $.cookie(SN.C.S.NoticeDataGeoCookie, 'disabled', { path: '/' });
889             }
890
891             function getJSONgeocodeURL(geocodeURL, data) {
892                 $.getJSON(geocodeURL, data, function(location) {
893                     var lns, lid;
894
895                     if (typeof(location.location_ns) != 'undefined') {
896                         $('#'+SN.C.S.NoticeLocationNs).val(location.location_ns);
897                         lns = location.location_ns;
898                     }
899
900                     if (typeof(location.location_id) != 'undefined') {
901                         $('#'+SN.C.S.NoticeLocationId).val(location.location_id);
902                         lid = location.location_id;
903                     }
904
905                     if (typeof(location.name) == 'undefined') {
906                         NLN_text = data.lat + ';' + data.lon;
907                     }
908                     else {
909                         NLN_text = location.name;
910                     }
911
912                     $('label[for='+SN.C.S.NoticeDataGeo+']')
913                         .attr('title', NoticeDataGeo_text.ShareDisable + ' (' + NLN_text + ')');
914
915                     $('#'+SN.C.S.NoticeLat).val(data.lat);
916                     $('#'+SN.C.S.NoticeLon).val(data.lon);
917                     $('#'+SN.C.S.NoticeLocationNs).val(lns);
918                     $('#'+SN.C.S.NoticeLocationId).val(lid);
919                     $('#'+SN.C.S.NoticeDataGeo).attr('checked', true);
920
921                     var cookieValue = {
922                         NLat: data.lat,
923                         NLon: data.lon,
924                         NLNS: lns,
925                         NLID: lid,
926                         NLN: NLN_text,
927                         NLNU: location.url,
928                         NDG: true
929                     };
930
931                     $.cookie(SN.C.S.NoticeDataGeoCookie, JSON.stringify(cookieValue), { path: '/' });
932                 });
933             }
934
935             if (NDGe.length > 0) {
936                 if ($.cookie(SN.C.S.NoticeDataGeoCookie) == 'disabled') {
937                     NDGe.attr('checked', false);
938                 }
939                 else {
940                     NDGe.attr('checked', true);
941                 }
942
943                 var NGW = $('#notice_data-geo_wrap');
944                 var geocodeURL = NGW.attr('title');
945                 NGW.removeAttr('title');
946
947                 $('label[for='+SN.C.S.NoticeDataGeo+']')
948                     .attr('title', jQuery.trim($('label[for='+SN.C.S.NoticeDataGeo+']').text()));
949
950                 NDGe.change(function() {
951                     if ($('#'+SN.C.S.NoticeDataGeo).attr('checked') === true || $.cookie(SN.C.S.NoticeDataGeoCookie) === null) {
952                         $('label[for='+SN.C.S.NoticeDataGeo+']')
953                             .attr('title', NoticeDataGeo_text.ShareDisable)
954                             .addClass('checked');
955
956                         if ($.cookie(SN.C.S.NoticeDataGeoCookie) === null || $.cookie(SN.C.S.NoticeDataGeoCookie) == 'disabled') {
957                             if (navigator.geolocation) {
958                                 navigator.geolocation.getCurrentPosition(
959                                     function(position) {
960                                         $('#'+SN.C.S.NoticeLat).val(position.coords.latitude);
961                                         $('#'+SN.C.S.NoticeLon).val(position.coords.longitude);
962
963                                         var data = {
964                                             lat: position.coords.latitude,
965                                             lon: position.coords.longitude,
966                                             token: $('#token').val()
967                                         };
968
969                                         getJSONgeocodeURL(geocodeURL, data);
970                                     },
971
972                                     function(error) {
973                                         switch(error.code) {
974                                             case error.PERMISSION_DENIED:
975                                                 removeNoticeDataGeo();
976                                                 break;
977                                             case error.TIMEOUT:
978                                                 $('#'+SN.C.S.NoticeDataGeo).attr('checked', false);
979                                                 break;
980                                         }
981                                     },
982
983                                     {
984                                         timeout: 10000
985                                     }
986                                 );
987                             }
988                             else {
989                                 if (NLat.length > 0 && NLon.length > 0) {
990                                     var data = {
991                                         lat: NLat,
992                                         lon: NLon,
993                                         token: $('#token').val()
994                                     };
995
996                                     getJSONgeocodeURL(geocodeURL, data);
997                                 }
998                                 else {
999                                     removeNoticeDataGeo();
1000                                     $('#'+SN.C.S.NoticeDataGeo).remove();
1001                                     $('label[for='+SN.C.S.NoticeDataGeo+']').remove();
1002                                 }
1003                             }
1004                         }
1005                         else {
1006                             var cookieValue = JSON.parse($.cookie(SN.C.S.NoticeDataGeoCookie));
1007
1008                             $('#'+SN.C.S.NoticeLat).val(cookieValue.NLat);
1009                             $('#'+SN.C.S.NoticeLon).val(cookieValue.NLon);
1010                             $('#'+SN.C.S.NoticeLocationNs).val(cookieValue.NLNS);
1011                             $('#'+SN.C.S.NoticeLocationId).val(cookieValue.NLID);
1012                             $('#'+SN.C.S.NoticeDataGeo).attr('checked', cookieValue.NDG);
1013
1014                             $('label[for='+SN.C.S.NoticeDataGeo+']')
1015                                 .attr('title', NoticeDataGeo_text.ShareDisable + ' (' + cookieValue.NLN + ')')
1016                                 .addClass('checked');
1017                         }
1018                     }
1019                     else {
1020                         removeNoticeDataGeo();
1021                     }
1022                 }).change();
1023             }
1024         },
1025
1026         /**
1027          * Setup function -- DOES NOT trigger actions immediately.
1028          *
1029          * Initializes event handlers for the "Send direct message" link on
1030          * profile pages, setting it up to display a dialog box when clicked.
1031          *
1032          * Unlike the repeat confirmation form, this appears to fetch
1033          * the form _from the original link target_, so the form itself
1034          * doesn't need to be in the current document.
1035          *
1036          * @fixme breaks ability to open link in new window?
1037          */
1038         NewDirectMessage: function() {
1039             NDM = $('.entity_send-a-message a');
1040             NDM.attr({'href':NDM.attr('href')+'&ajax=1'});
1041             NDM.bind('click', function() {
1042                 var NDMF = $('.entity_send-a-message form');
1043                 if (NDMF.length === 0) {
1044                     $(this).addClass(SN.C.S.Processing);
1045                     $.get(NDM.attr('href'), null, function(data) {
1046                         $('.entity_send-a-message').append(document._importNode($('form', data)[0], true));
1047                         NDMF = $('.entity_send-a-message .form_notice');
1048                         SN.U.FormNoticeXHR(NDMF);
1049                         SN.U.FormNoticeEnhancements(NDMF);
1050                         NDMF.append('<button class="close">&#215;</button>');
1051                         $('.entity_send-a-message button').click(function(){
1052                             NDMF.hide();
1053                             return false;
1054                         });
1055                         NDM.removeClass(SN.C.S.Processing);
1056                     });
1057                 }
1058                 else {
1059                     NDMF.show();
1060                     $('.entity_send-a-message textarea').focus();
1061                 }
1062                 return false;
1063             });
1064         },
1065
1066         /**
1067          * Return a date object with the current local time on the
1068          * given year, month, and day.
1069          *
1070          * @param {number} year: 4-digit year
1071          * @param {number} month: 0 == January
1072          * @param {number} day: 1 == 1
1073          * @return {Date}
1074          */
1075         GetFullYear: function(year, month, day) {
1076             var date = new Date();
1077             date.setFullYear(year, month, day);
1078
1079             return date;
1080         },
1081
1082         /**
1083          * Some sort of object interface for storing some structured
1084          * information in a cookie.
1085          *
1086          * Appears to be used to save the last-used login nickname?
1087          * That's something that browsers usually take care of for us
1088          * these days, do we really need to do it? Does anything else
1089          * use this interface?
1090          *
1091          * @fixme what is this?
1092          * @fixme should this use non-cookie local storage when available?
1093          */
1094         StatusNetInstance: {
1095             /**
1096              * @fixme what is this?
1097              */
1098             Set: function(value) {
1099                 var SNI = SN.U.StatusNetInstance.Get();
1100                 if (SNI !== null) {
1101                     value = $.extend(SNI, value);
1102                 }
1103
1104                 $.cookie(
1105                     SN.C.S.StatusNetInstance,
1106                     JSON.stringify(value),
1107                     {
1108                         path: '/',
1109                         expires: SN.U.GetFullYear(2029, 0, 1)
1110                     });
1111             },
1112
1113             /**
1114              * @fixme what is this?
1115              */
1116             Get: function() {
1117                 var cookieValue = $.cookie(SN.C.S.StatusNetInstance);
1118                 if (cookieValue !== null) {
1119                     return JSON.parse(cookieValue);
1120                 }
1121                 return null;
1122             },
1123
1124             /**
1125              * @fixme what is this?
1126              */
1127             Delete: function() {
1128                 $.cookie(SN.C.S.StatusNetInstance, null);
1129             }
1130         },
1131
1132         /**
1133          * Check if the current page is a timeline where the current user's
1134          * posts should be displayed immediately on success.
1135          *
1136          * @fixme this should be done in a saner way, with machine-readable
1137          * info about what page we're looking at.
1138          *
1139          * @param {DOMElement} notice: HTML chunk with formatted notice
1140          * @return boolean
1141          */
1142         belongsOnTimeline: function(notice) {
1143             var action = $("body").attr('id');
1144             if (action == 'public') {
1145                 return true;
1146             }
1147
1148             var profileLink = $('#nav_profile a').attr('href');
1149             if (profileLink) {
1150                 var authorUrl = $(notice).find('.entry-title .author a.url').attr('href');
1151                 if (authorUrl == profileLink) {
1152                     if (action == 'all' || action == 'showstream') {
1153                         // Posts always show on your own friends and profile streams.
1154                         return true;
1155                     }
1156                 }
1157             }
1158
1159             // @fixme tag, group, reply timelines should be feasible as well.
1160             // Mismatch between id-based and name-based user/group links currently complicates
1161             // the lookup, since all our inline mentions contain the absolute links but the
1162             // UI links currently on the page use malleable names.
1163
1164             return false;
1165         }
1166     },
1167
1168     Init: {
1169         /**
1170          * If user is logged in, run setup code for the new notice form:
1171          *
1172          *  - char counter
1173          *  - AJAX submission
1174          *  - location events
1175          *  - file upload events
1176          */
1177         NoticeForm: function() {
1178             if ($('body.user_in').length > 0) {
1179                 SN.U.NoticeLocationAttach();
1180
1181                 $('.'+SN.C.S.FormNotice).each(function() {
1182                     SN.U.FormNoticeXHR($(this));
1183                     SN.U.FormNoticeEnhancements($(this));
1184                 });
1185
1186                 SN.U.NoticeDataAttach();
1187             }
1188         },
1189
1190         /**
1191          * Run setup code for notice timeline views items:
1192          *
1193          * - AJAX submission for fave/repeat/reply (if logged in)
1194          * - Attachment link extras ('more' links)
1195          */
1196         Notices: function() {
1197             if ($('body.user_in').length > 0) {
1198                 SN.U.NoticeFavor();
1199                 SN.U.NoticeRepeat();
1200                 SN.U.NoticeReply();
1201             }
1202
1203             SN.U.NoticeAttachments();
1204         },
1205
1206         /**
1207          * Run setup code for user & group profile page header area if logged in:
1208          *
1209          * - AJAX submission for sub/unsub/join/leave/nudge
1210          * - AJAX form popup for direct-message
1211          */
1212         EntityActions: function() {
1213             if ($('body.user_in').length > 0) {
1214                 $('.form_user_subscribe').live('click', function() { SN.U.FormXHR($(this)); return false; });
1215                 $('.form_user_unsubscribe').live('click', function() { SN.U.FormXHR($(this)); return false; });
1216                 $('.form_group_join').live('click', function() { SN.U.FormXHR($(this)); return false; });
1217                 $('.form_group_leave').live('click', function() { SN.U.FormXHR($(this)); return false; });
1218                 $('.form_user_nudge').live('click', function() { SN.U.FormXHR($(this)); return false; });
1219
1220                 SN.U.NewDirectMessage();
1221             }
1222         },
1223
1224         /**
1225          * Run setup code for login form:
1226          *
1227          * - loads saved last-used-nickname from cookie
1228          * - sets event handler to save nickname to cookie on submit
1229          *
1230          * @fixme is this necessary? Browsers do their own form saving these days.
1231          */
1232         Login: function() {
1233             if (SN.U.StatusNetInstance.Get() !== null) {
1234                 var nickname = SN.U.StatusNetInstance.Get().Nickname;
1235                 if (nickname !== null) {
1236                     $('#form_login #nickname').val(nickname);
1237                 }
1238             }
1239
1240             $('#form_login').bind('submit', function() {
1241                 SN.U.StatusNetInstance.Set({Nickname: $('#form_login #nickname').val()});
1242                 return true;
1243             });
1244         },
1245
1246         /**
1247          * Add logic to any file upload forms to handle file size limits,
1248          * on browsers that support basic FileAPI.
1249          */
1250         UploadForms: function () {
1251             $('input[type=file]').change(function(event) {
1252                 if (typeof this.files == "object" && this.files.length > 0) {
1253                     var size = 0;
1254                     for (var i = 0; i < this.files.length; i++) {
1255                         size += this.files[i].size;
1256                     }
1257
1258                     var max = SN.U.maxFileSize($(this.form));
1259                     if (max > 0 && size > max) {
1260                         var msg = 'File too large: maximum upload size is %d bytes.';
1261                         alert(msg.replace('%d', max));
1262
1263                         // Clear the files.
1264                         $(this).val('');
1265                         event.preventDefault();
1266                         return false;
1267                     }
1268                 }
1269             });
1270         }
1271     }
1272 };
1273
1274 /**
1275  * Run initialization functions on DOM-ready.
1276  *
1277  * Note that if we're waiting on other scripts to load, this won't happen
1278  * until that's done. To load scripts asynchronously without delaying setup,
1279  * don't start them loading until after DOM-ready time!
1280  */
1281 $(document).ready(function(){
1282     SN.Init.UploadForms();
1283     if ($('.'+SN.C.S.FormNotice).length > 0) {
1284         SN.Init.NoticeForm();
1285     }
1286     if ($('#content .notices').length > 0) {
1287         SN.Init.Notices();
1288     }
1289     if ($('#content .entity_actions').length > 0) {
1290         SN.Init.EntityActions();
1291     }
1292     if ($('#form_login').length > 0) {
1293         SN.Init.Login();
1294     }
1295 });