2 * StatusNet - a distributed open-source microblogging tool
3 * Copyright (C) 2008, StatusNet, Inc.
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.
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.
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/>.
18 * @category UI interaction
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/
28 var SN = { // StatusNet
31 CounterBlackout: false,
33 PatternUsername: /^[0-9a-zA-Z\-_.]*$/,
34 HTTP20x30x: [200, 201, 202, 203, 204, 205, 206, 300, 301, 302, 303, 304, 305, 306, 307],
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.
42 * In theory, minification could reduce them to shorter variable names,
43 * but at present that doesn't happen with yui-compressor.
50 Processing: 'processing',
51 CommandResult: 'command_result',
52 FormNotice: 'form_notice',
53 NoticeDataGeo: 'notice_data-geo',
54 NoticeDataGeoCookie: 'NoticeDataGeo',
55 NoticeDataGeoSelected: 'notice_data-geo_selected',
56 StatusNetInstance: 'StatusNetInstance'
61 * Map of localized message strings exported to script from the PHP
62 * side via Action::getScriptMessages().
64 * Retrieve them via SN.msg(); this array is an implementation detail.
71 * Grabs a localized string that's been previously exported to us
72 * from server-side code via Action::getScriptMessages().
74 * @example alert(SN.msg('coolplugin-failed'));
76 * @param {String} key: string key name to pull from message index
77 * @return matching localized message string
80 if (SN.messages[key] === undefined) {
81 return '[' + key + ']';
83 return SN.messages[key];
88 * Setup function -- DOES NOT trigger actions immediately.
90 * Sets up event handlers on the new notice form.
92 * @param {jQuery} form: jQuery object whose first matching element is the form
95 FormNoticeEnhancements: function (form) {
96 if ($.data(form[0], 'ElementData') === undefined) {
97 var MaxLength = form.find('.count').text();
98 if (MaxLength === undefined) {
99 MaxLength = SN.C.I.MaxLength;
101 $.data(form[0], 'ElementData', {MaxLength: MaxLength});
105 var NDT = form.find('.notice_data-text:first');
107 NDT.on('keyup', function (e) {
111 var delayedUpdate = function (e) {
112 // Cut and paste events fire *before* the operation,
113 // so we need to trigger an update in a little bit.
114 // This would be so much easier if the 'change' event
115 // actually fired every time the value changed. :P
116 window.setTimeout(function () {
120 // Note there's still no event for mouse-triggered 'delete'.
121 NDT.on('cut', delayedUpdate)
122 .on('paste', delayedUpdate);
124 form.find('.count').text($.data(form[0], 'ElementData').MaxLength);
129 * To be called from event handlers on the notice import form.
130 * Triggers an update of the remaining-characters counter.
132 * Additional counter updates will be suppressed during the
133 * next half-second to avoid flooding the layout engine with
134 * updates, followed by another automatic check.
136 * The maximum length is pulled from data established by
137 * FormNoticeEnhancements.
139 * @param {jQuery} form: jQuery object whose first element is the notice posting form
142 Counter: function (form) {
143 SN.C.I.FormNoticeCurrent = form;
145 var MaxLength = $.data(form[0], 'ElementData').MaxLength;
147 if (MaxLength <= 0) {
151 var remaining = MaxLength - SN.U.CharacterCount(form);
152 var counter = form.find('.count');
154 if (remaining.toString() != counter.text()) {
155 if (!SN.C.I.CounterBlackout || remaining === 0) {
156 if (counter.text() != String(remaining)) {
157 counter.text(remaining);
160 form.addClass(SN.C.S.Warning);
162 form.removeClass(SN.C.S.Warning);
164 // Skip updates for the next 500ms.
165 // On slower hardware, updating on every keypress is unpleasant.
166 if (!SN.C.I.CounterBlackout) {
167 SN.C.I.CounterBlackout = true;
168 SN.C.I.FormNoticeCurrent = form;
169 window.setTimeout("SN.U.ClearCounterBlackout(SN.C.I.FormNoticeCurrent);", 500);
176 * Pull the count of characters in the current edit field.
177 * Plugins replacing the edit control may need to override this.
179 * @param {jQuery} form: jQuery object whose first element is the notice posting form
180 * @return number of chars
182 CharacterCount: function (form) {
183 return form.find('.notice_data-text:first').val().length;
187 * Called internally after the counter update blackout period expires;
188 * runs another update to make sure we didn't miss anything.
190 * @param {jQuery} form: jQuery object whose first element is the notice posting form
193 ClearCounterBlackout: function (form) {
194 // Allow keyup events to poke the counter again
195 SN.C.I.CounterBlackout = false;
196 // Check if the string changed since we last looked
201 * Helper function to rewrite default HTTP form action URLs to HTTPS
202 * so we can actually fetch them when on an SSL page in ssl=sometimes
205 * It would be better to output URLs that didn't hardcode protocol
206 * and hostname in the first place...
208 * @param {String} url
211 RewriteAjaxAction: function (url) {
212 // Quick hack: rewrite AJAX submits to HTTPS if they'd fail otherwise.
213 if (document.location.protocol === 'https:' && url.substr(0, 5) === 'http:') {
214 return url.replace(/^http:\/\/[^:\/]+/, 'https://' + document.location.host);
220 * Grabs form data and submits it asynchronously, with 'ajax=1'
221 * parameter added to the rest.
223 * If a successful response includes another form, that form
224 * will be extracted and copied in, replacing the original form.
225 * If there's no form, the first paragraph will be used.
227 * This will automatically be applied on the 'submit' event for
228 * any form with the 'ajax' class.
230 * @fixme can sometimes explode confusingly if returnd data is bogus
231 * @fixme error handling is pretty vague
232 * @fixme can't submit file uploads
234 * @param {jQuery} form: jQuery object whose first element is a form
235 * @param function onSuccess: something extra to do on success
239 FormXHR: function (form, onSuccess) {
243 url: SN.U.RewriteAjaxAction(form.attr('action')),
244 data: form.serialize() + '&ajax=1',
245 beforeSend: function (xhr) {
247 .addClass(SN.C.S.Processing)
249 .addClass(SN.C.S.Disabled)
250 .prop(SN.C.S.Disabled, true);
252 error: function (xhr, textStatus, errorThrown) {
253 // If the server end reported an error from StatusNet,
254 // find it -- otherwise we'll see what was reported
256 var errorReported = null;
257 if (xhr.responseXML) {
258 errorReported = $('#error', xhr.responseXML).text();
260 window.alert(errorReported || errorThrown || textStatus);
262 // Restore the form to original state.
265 .removeClass(SN.C.S.Processing)
267 .removeClass(SN.C.S.Disabled)
268 .prop(SN.C.S.Disabled, false);
270 success: function (data, textStatus) {
271 if ($('form', data)[0] !== undefined) {
272 var form_new = document._importNode($('form', data)[0], true);
273 form.replaceWith(form_new);
277 } else if ($('p', data)[0] !== undefined) {
278 form.replaceWith(document._importNode($('p', data)[0], true));
283 window.alert('Unknown error.');
290 * Setup function -- DOES NOT trigger actions immediately.
292 * Sets up event handlers for special-cased async submission of the
293 * notice-posting form, including some pre-post validation.
295 * Unlike FormXHR() this does NOT submit the form immediately!
296 * It sets up event handlers so that any method of submitting the
297 * form (click on submit button, enter, submit() etc) will trigger
300 * Also unlike FormXHR(), this system will use a hidden iframe
301 * automatically to handle file uploads via <input type="file">
305 * @fixme vast swaths of duplicate code and really long variable names clutter this function up real bad
306 * @fixme error handling is unreliable
307 * @fixme cookieValue is a global variable, but probably shouldn't be
308 * @fixme saving the location cache cookies should be split out
309 * @fixme some error messages are hardcoded english: needs i18n
311 * @param {jQuery} form: jQuery object whose first element is a form
315 FormNoticeXHR: function (form) {
316 SN.C.I.NoticeDataGeo = {};
317 form.append('<input type="hidden" name="ajax" value="1"/>');
319 // Make sure we don't have a mixed HTTP/HTTPS submission...
320 form.attr('action', SN.U.RewriteAjaxAction(form.attr('action')));
323 * Show a response feedback bit under the new-notice dialog.
325 * @param {String} cls: CSS class name to use ('error' or 'success')
326 * @param {String} text
329 var showFeedback = function (cls, text) {
331 $('<p class="form_response"></p>')
338 * Hide the previous response feedback, if any.
340 var removeFeedback = function () {
341 form.find('.form_response').remove();
347 beforeSend: function (formData) {
348 if (form.find('.notice_data-text:first').val() == '') {
349 form.addClass(SN.C.S.Warning);
353 .addClass(SN.C.S.Processing)
355 .addClass(SN.C.S.Disabled)
356 .prop(SN.C.S.Disabled, true);
358 SN.U.normalizeGeoData(form);
362 error: function (xhr, textStatus, errorThrown) {
364 .removeClass(SN.C.S.Processing)
366 .removeClass(SN.C.S.Disabled)
367 .prop(SN.C.S.Disabled, false);
369 if (textStatus == 'timeout') {
371 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.');
373 var response = SN.U.GetResponseXML(xhr);
374 if ($('.' + SN.C.S.Error, response).length > 0) {
375 form.append(document._importNode($('.' + SN.C.S.Error, response)[0], true));
377 if (parseInt(xhr.status) === 0 || $.inArray(parseInt(xhr.status), SN.C.I.HTTP20x30x) >= 0) {
380 .find('.attach-status').remove();
381 SN.U.FormNoticeEnhancements(form);
384 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.');
389 success: function (data, textStatus) {
391 var errorResult = $('#' + SN.C.S.Error, data);
392 if (errorResult.length > 0) {
393 showFeedback('error', errorResult.text());
395 var commandResult = $('#' + SN.C.S.CommandResult, data);
396 if (commandResult.length > 0) {
397 showFeedback('success', commandResult.text());
399 // New notice post was successful. If on our timeline, show it!
400 var notice = document._importNode($('li', data)[0], true);
401 var notices = $('#notices_primary .notices:first');
402 var replyItem = form.closest('li.notice-reply');
404 if (replyItem.length > 0) {
405 // If this is an inline reply, remove the form...
406 var list = form.closest('.threaded-replies');
408 var id = $(notice).attr('id');
409 if ($('#' + id).length == 0) {
410 $(notice).insertBefore(replyItem);
411 } // else Realtime came through before us...
415 } else if (notices.length > 0 && SN.U.belongsOnTimeline(notice)) {
416 // Not a reply. If on our timeline, show it at the top!
418 if ($('#' + notice.id).length === 0) {
419 var notice_irt_value = form.find('[name=inreplyto]').val();
420 var notice_irt = '#notices_primary #notice-' + notice_irt_value;
421 if ($('body')[0].id == 'conversation') {
422 if (notice_irt_value.length > 0 && $(notice_irt + ' .notices').length < 1) {
423 $(notice_irt).append('<ul class="notices"></ul>');
425 $($(notice_irt + ' .notices')[0]).append(notice);
427 notices.prepend(notice);
430 .css({display: 'none'})
432 SN.U.NoticeWithAttachment($('#' + notice.id));
433 SN.U.switchInputFormTab(null);
436 // Not on a timeline that this belongs on?
437 // Just show a success message.
439 showFeedback('success', $('title', data).text());
443 form.find('[name=inreplyto]').val('');
444 form.find('.attach-status').remove();
445 SN.U.FormNoticeEnhancements(form);
448 complete: function (xhr, textStatus) {
450 .removeClass(SN.C.S.Processing)
452 .prop(SN.C.S.Disabled, false)
453 .removeClass(SN.C.S.Disabled);
455 form.find('[name=lat]').val(SN.C.I.NoticeDataGeo.NLat);
456 form.find('[name=lon]').val(SN.C.I.NoticeDataGeo.NLon);
457 form.find('[name=location_ns]').val(SN.C.I.NoticeDataGeo.NLNS);
458 form.find('[name=location_id]').val(SN.C.I.NoticeDataGeo.NLID);
459 form.find('[name=notice_data-geo]').prop('checked', SN.C.I.NoticeDataGeo.NDG);
464 FormProfileSearchXHR: function (form) {
468 url: form.attr('action'),
469 data: form.serialize() + '&ajax=1',
470 beforeSend: function (xhr) {
472 .addClass(SN.C.S.Processing)
474 .addClass(SN.C.S.Disabled)
475 .prop(SN.C.S.Disabled, true);
477 error: function (xhr, textStatus, errorThrown) {
478 window.alert(errorThrown || textStatus);
480 success: function (data, textStatus) {
481 var results_placeholder = $('#profile_search_results');
482 if ($('ul', data)[0] !== undefined) {
483 var list = document._importNode($('ul', data)[0], true);
484 results_placeholder.replaceWith(list);
486 var _error = $('<li/>').append(document._importNode($('p', data)[0], true));
487 results_placeholder.html(_error);
490 .removeClass(SN.C.S.Processing)
492 .removeClass(SN.C.S.Disabled)
493 .prop(SN.C.S.Disabled, false);
498 FormPeopletagsXHR: function (form) {
502 url: form.attr('action'),
503 data: form.serialize() + '&ajax=1',
504 beforeSend: function (xhr) {
506 .addClass(SN.C.S.Processing)
507 .addClass(SN.C.S.Disabled)
508 .prop(SN.C.S.Disabled, true);
510 error: function (xhr, textStatus, errorThrown) {
511 window.alert(errorThrown || textStatus);
513 success: function (data, textStatus) {
514 var results_placeholder = form.parents('.entity_tags');
515 if ($('.entity_tags', data)[0] !== undefined) {
516 var tags = document._importNode($('.entity_tags', data)[0], true);
517 $(tags).find('.editable').append($('<button class="peopletags_edit_button"/>'));
518 results_placeholder.replaceWith(tags);
520 results_placeholder.find('p').remove();
521 results_placeholder.append(document._importNode($('p', data)[0], true));
522 form.removeClass(SN.C.S.Processing)
524 .removeClass(SN.C.S.Disabled)
525 .prop(SN.C.S.Disabled, false);
531 normalizeGeoData: function (form) {
532 SN.C.I.NoticeDataGeo.NLat = form.find('[name=lat]').val();
533 SN.C.I.NoticeDataGeo.NLon = form.find('[name=lon]').val();
534 SN.C.I.NoticeDataGeo.NLNS = form.find('[name=location_ns]').val();
535 SN.C.I.NoticeDataGeo.NLID = form.find('[name=location_id]').val();
536 SN.C.I.NoticeDataGeo.NDG = form.find('[name=notice_data-geo]').prop('checked'); // @fixme (does this still need to be fixed somehow?)
538 var cookieValue = $.cookie(SN.C.S.NoticeDataGeoCookie);
540 if (cookieValue !== undefined && cookieValue != 'disabled') {
541 cookieValue = JSON.parse(cookieValue);
542 SN.C.I.NoticeDataGeo.NLat = form.find('[name=lat]').val(cookieValue.NLat).val();
543 SN.C.I.NoticeDataGeo.NLon = form.find('[name=lon]').val(cookieValue.NLon).val();
544 if (cookieValue.NLNS) {
545 SN.C.I.NoticeDataGeo.NLNS = form.find('[name=location_ns]').val(cookieValue.NLNS).val();
546 SN.C.I.NoticeDataGeo.NLID = form.find('[name=location_id]').val(cookieValue.NLID).val();
548 form.find('[name=location_ns]').val('');
549 form.find('[name=location_id]').val('');
552 if (cookieValue == 'disabled') {
553 SN.C.I.NoticeDataGeo.NDG = form.find('[name=notice_data-geo]').prop('checked', false).prop('checked');
555 SN.C.I.NoticeDataGeo.NDG = form.find('[name=notice_data-geo]').prop('checked', true).prop('checked');
561 * Fetch an XML DOM from an XHR's response data.
563 * Works around unavailable responseXML when document.domain
564 * has been modified by Meteor or other tools, in some but not
567 * @param {XMLHTTPRequest} xhr
568 * @return DOMDocument
570 GetResponseXML: function (xhr) {
572 return xhr.responseXML;
574 return (new DOMParser()).parseFromString(xhr.responseText, "text/xml");
579 * Setup function -- DOES NOT trigger actions immediately.
581 * Sets up event handlers on all visible notice's option <a> elements
582 * with the "popup" class so they behave as expected with AJAX.
584 * (without javascript the link goes to a page that expects you to verify
585 * the action through a form)
589 NoticeOptionsAjax: function () {
590 $(document).on('click', '.notice-options > a.popup', function (e) {
592 var noticeEl = $(this).closest('.notice');
593 $.get($(this).attr('href'), {ajax: 1}, function (data, textStatus, xhr) {
594 SN.U.NoticeOptionPopup(data, noticeEl);
600 NoticeOptionPopup: function (data, noticeEl) {
601 title = $('head > title', data).text();
602 body = $('body', data).html();
603 dialog = $(body).dialog({
613 * Setup function -- DOES NOT trigger actions immediately.
615 * Sets up event handlers on all visible notice's reply buttons to
616 * tweak the new-notice form with needed variables and focus it
619 * (This replaces the default reply button behavior to submit
620 * directly to a form which comes back with a specialized page
621 * with the form data prefilled.)
625 NoticeReply: function () {
626 $(document).on('click', '#content .notice_reply', function (e) {
628 var notice = $(this).closest('li.notice');
629 SN.U.NoticeInlineReplyTrigger(notice);
635 * Stub -- kept for compat with plugins for now.
638 NoticeReplyTo: function (notice) {
642 * Open up a notice's inline reply box.
644 * @param {jQuery} notice: jQuery object containing one notice
645 * @param {String} initialText
647 NoticeInlineReplyTrigger: function (notice, initialText) {
648 // Find the notice we're replying to...
649 var id = $($('.notice_id', notice)[0]).text();
651 var parentNotice = notice;
652 var stripForm = true; // strip a couple things out of reply forms that are inline
654 var list = notice.find('.threaded-replies');
655 if (list.length == 0) {
656 list = notice.closest('.threaded-replies');
658 var nextStep = function () {
660 replyForm.find('input[name=inreplyto]').val(id);
662 // Don't do this for old-school reply form, as they don't come back!
663 replyForm.find('#notice_to').prop('disabled', true).hide();
664 replyForm.find('#notice_private').prop('disabled', true).hide();
665 replyForm.find('label[for=notice_to]').hide();
666 replyForm.find('label[for=notice_private]').hide();
671 var text = replyForm.find('textarea');
672 if (text.length == 0) {
677 replyto = initialText + ' ';
679 text.val(replyto + text.val().replace(new RegExp(replyto, 'i'), ''));
680 text.data('initialText', $.trim(initialText));
682 if (text[0].setSelectionRange) {
683 var len = text.val().length;
684 text[0].setSelectionRange(len, len);
688 // Create the reply form entry
689 var replyItem = $('li.notice-reply', list);
690 if (replyItem.length == 0) {
691 replyItem = $('<li class="notice-reply"></li>');
693 // Fetch a fresh copy of the notice form over AJAX.
694 var url = $('#input_form_status > form').attr('action');
695 $.get(url, {ajax: 1, inreplyto: id}, function (data, textStatus, xhr) {
696 var formEl = document._importNode($('form', data)[0], true);
697 replyItem.append(formEl);
698 list.append(replyItem);
700 replyForm = $(formEl);
701 SN.Init.NoticeFormSetup(replyForm);
705 replyForm = replyItem.children('form');
711 * Setup function -- DOES NOT apply immediately.
713 * Uses 'on' rather than 'live' or 'bind', so applies to future as well as present items.
715 NoticeInlineReplySetup: function () {
716 // Expand conversation links
717 $(document).on('click', 'li.notice-reply-comments a', function () {
718 var url = $(this).attr('href');
719 var area = $(this).closest('.threaded-replies');
720 $.get(url, {ajax: 1}, function (data, textStatus, xhr) {
721 var replies = $('.threaded-replies', data);
722 if (replies.length) {
723 area.replaceWith(document._importNode(replies[0], true));
731 * Setup function -- DOES NOT trigger actions immediately.
733 * Sets up event handlers for repeat forms to toss up a confirmation
734 * popout before submitting.
736 * Uses 'on' rather than 'live' or 'bind', so applies to future as well as present items.
739 NoticeRepeat: function () {
740 $('body').on('click', '.form_repeat', function (e) {
743 SN.U.NoticeRepeatConfirmation($(this));
749 * Shows a confirmation dialog box variant of the repeat button form.
750 * This seems to use a technique where the repeat form contains
751 * _both_ a standalone button _and_ text and buttons for a dialog.
752 * The dialog will close after its copy of the form is submitted,
753 * or if you click its 'close' button.
755 * The dialog is created by duplicating the original form and changing
756 * its style; while clever, this is hard to generalize and probably
757 * duplicates a lot of unnecessary HTML output.
759 * @fixme create confirmation dialogs through a generalized interface
760 * that can be reused instead of hardcoded text and styles.
762 * @param {jQuery} form
764 NoticeRepeatConfirmation: function (form) {
765 var submit_i = form.find('.submit');
767 var submit = submit_i.clone();
769 .addClass('submit_dialogbox')
770 .removeClass('submit');
772 submit.on('click', function () { SN.U.FormXHR(form); return false; });
777 .addClass('dialogbox')
778 .append('<button class="close">×</button>')
779 .closest('.notice-options')
782 form.find('button.close').click(function () {
786 .removeClass('dialogbox')
787 .closest('.notice-options')
788 .removeClass('opaque');
790 form.find('.submit_dialogbox').remove();
791 form.find('.submit').show();
798 * Setup function -- DOES NOT trigger actions immediately.
800 * Goes through all notices currently displayed and sets up attachment
801 * handling if needed.
803 NoticeAttachments: function () {
804 $('.notice a.attachment').each(function () {
805 SN.U.NoticeWithAttachment($(this).closest('.notice'));
810 * Setup function -- DOES NOT trigger actions immediately.
812 * Sets up special attachment link handling if needed. Currently this
813 * consists only of making the "more" button used for OStatus message
814 * cropping turn into an auto-expansion button that loads the full
815 * text from an attachment file.
817 * @param {jQuery} notice
819 NoticeWithAttachment: function (notice) {
820 if (notice.find('.attachment').length === 0) {
824 $(document).on('click','.attachment.more',function () {
826 m.addClass(SN.C.S.Processing);
827 $.get(m.attr('href'), {ajax: 1}, function (data) {
828 m.parent('.e-content').html($(data).find('#attachment_view .e-content').html());
837 * Setup function -- DOES NOT trigger actions immediately.
839 * Sets up event handlers for the file-attachment widget in the
840 * new notice form. When a file is selected, a box will be added
841 * below the text input showing the filename and, if supported
842 * by the browser, a thumbnail preview.
844 * This preview box will also allow removing the attachment
847 * @param {jQuery} form
849 NoticeDataAttach: function (form) {
851 var NDA = form.find('input[type=file]');
852 NDA.change(function (event) {
853 form.find('.attach-status').remove();
855 var filename = $(this).val();
857 // No file -- we've been tricked!
861 var attachStatus = $('<div class="attach-status ' + SN.C.S.Success + '"><code></code> <button class="close">×</button></div>');
862 attachStatus.find('code').text(filename);
863 attachStatus.find('button').click(function () {
864 attachStatus.remove();
869 form.append(attachStatus);
871 if (typeof this.files === "object") {
872 // Some newer browsers will let us fetch the files for preview.
873 for (i = 0; i < this.files.length; i++) {
874 SN.U.PreviewAttach(form, this.files[i]);
881 * Get PHP's MAX_FILE_SIZE setting for this form;
882 * used to apply client-side file size limit checks.
884 * @param {jQuery} form
885 * @return int max size in bytes; 0 or negative means no limit
887 maxFileSize: function (form) {
888 var max = $(form).find('input[name=MAX_FILE_SIZE]').attr('value');
890 return parseInt(max);
896 * For browsers with FileAPI support: make a thumbnail if possible,
897 * and append it into the attachment display widget.
900 * - Firefox 3.6.6, 4.0b7
901 * - Chrome 8.0.552.210
903 * Known ok metadata, can't get contents:
907 * - Opera 10.63, 11 beta (no input.files interface)
909 * @param {jQuery} form
912 * @todo use configured thumbnail size
913 * @todo detect pixel size?
914 * @todo should we render a thumbnail to a canvas and then use the smaller image?
916 PreviewAttach: function (form, file) {
917 var tooltip = file.type + ' ' + Math.round(file.size / 1024) + 'KB';
921 if (window.createObjectURL !== undefined) {
923 * createObjectURL lets us reference the file directly from an <img>
924 * This produces a compact URL with an opaque reference to the file,
925 * which we can reference immediately.
927 * - Firefox 3.6.6: no
928 * - Firefox 4.0b7: no
930 * - Chrome 8.0.552.210: works!
932 blobAsDataURL = function (blob, callback) {
933 callback(window.createObjectURL(blob));
935 } else if (window.FileReader !== undefined) {
937 * FileAPI's FileReader can build a data URL from a blob's contents,
938 * but it must read the file and build it asynchronously. This means
939 * we'll be passing a giant data URL around, which may be inefficient.
941 * - Firefox 3.6.6: works!
942 * - Firefox 4.0b7: works!
944 * - Chrome 8.0.552.210: works!
946 blobAsDataURL = function (blob, callback) {
947 var reader = new FileReader();
948 reader.onload = function (event) {
949 callback(reader.result);
951 reader.readAsDataURL(blob);
957 var imageTypes = ['image/png', 'image/jpeg', 'image/gif', 'image/svg+xml'];
958 if ($.inArray(file.type, imageTypes) == -1) {
959 // We probably don't know how to show the file.
963 var maxSize = 8 * 1024 * 1024;
964 if (file.size > maxSize) {
965 // Don't kill the browser trying to load some giant image.
970 blobAsDataURL(file, function (url) {
972 .attr('title', tooltip)
973 .attr('alt', tooltip)
975 .attr('style', 'height: 120px');
976 form.find('.attach-status').append(img);
979 var img = $('<div></div>').text(tooltip);
980 form.find('.attach-status').append(img);
985 * Setup function -- DOES NOT trigger actions immediately.
987 * Initializes state for the location-lookup features in the
988 * new-notice form. Seems to set up some event handlers for
989 * triggering lookups and using the new values.
991 * @param {jQuery} form
994 * @fixme there's not good visual state update here, so users have a
995 * hard time figuring out if it's working or fixing if it's wrong.
998 NoticeLocationAttach: function (form) {
999 // @fixme this should not be tied to the main notice form, as there may be multiple notice forms...
1000 var NLat = form.find('[name=lat]');
1001 var NLon = form.find('[name=lon]');
1002 var NLNS = form.find('[name=location_ns]').val();
1003 var NLID = form.find('[name=location_id]').val();
1004 var NLN = ''; // @fixme
1005 var NDGe = form.find('[name=notice_data-geo]');
1006 var check = form.find('[name=notice_data-geo]');
1007 var label = form.find('label.notice_data-geo');
1009 function removeNoticeDataGeo(error) {
1011 .attr('title', $.trim(label.text()))
1012 .removeClass('checked');
1014 form.find('[name=lat]').val('');
1015 form.find('[name=lon]').val('');
1016 form.find('[name=location_ns]').val('');
1017 form.find('[name=location_id]').val('');
1018 form.find('[name=notice_data-geo]').prop('checked', false);
1020 $.cookie(SN.C.S.NoticeDataGeoCookie, 'disabled', { path: '/' });
1023 form.find('.geo_status_wrapper').removeClass('success').addClass('error');
1024 form.find('.geo_status_wrapper .geo_status').text(error);
1026 form.find('.geo_status_wrapper').remove();
1030 function getJSONgeocodeURL(geocodeURL, data) {
1031 SN.U.NoticeGeoStatus(form, 'Looking up place name...');
1032 $.getJSON(geocodeURL, data, function (location) {
1033 var lns, lid, NLN_text;
1035 if (location.location_ns !== undefined) {
1036 form.find('[name=location_ns]').val(location.location_ns);
1037 lns = location.location_ns;
1040 if (location.location_id !== undefined) {
1041 form.find('[name=location_id]').val(location.location_id);
1042 lid = location.location_id;
1045 if (location.name === undefined) {
1046 NLN_text = data.lat + ';' + data.lon;
1048 NLN_text = location.name;
1051 SN.U.NoticeGeoStatus(form, NLN_text, data.lat, data.lon, location.url);
1053 .attr('title', NoticeDataGeo_text.ShareDisable + ' (' + NLN_text + ')');
1055 form.find('[name=lat]').val(data.lat);
1056 form.find('[name=lon]').val(data.lon);
1057 form.find('[name=location_ns]').val(lns);
1058 form.find('[name=location_id]').val(lid);
1059 form.find('[name=notice_data-geo]').prop('checked', true);
1071 $.cookie(SN.C.S.NoticeDataGeoCookie, JSON.stringify(cookieValue), { path: '/' });
1075 if (check.length > 0) {
1076 if ($.cookie(SN.C.S.NoticeDataGeoCookie) == 'disabled') {
1077 check.prop('checked', false);
1079 check.prop('checked', true);
1082 var NGW = form.find('.notice_data-geo_wrap');
1083 var geocodeURL = NGW.attr('data-api');
1085 label.attr('title', label.text());
1087 check.change(function () {
1088 if (check.prop('checked') === true || $.cookie(SN.C.S.NoticeDataGeoCookie) === null) {
1090 .attr('title', NoticeDataGeo_text.ShareDisable)
1091 .addClass('checked');
1093 if ($.cookie(SN.C.S.NoticeDataGeoCookie) === null || $.cookie(SN.C.S.NoticeDataGeoCookie) == 'disabled') {
1094 if (navigator.geolocation) {
1095 SN.U.NoticeGeoStatus(form, 'Requesting location from browser...');
1096 navigator.geolocation.getCurrentPosition(
1097 function (position) {
1098 form.find('[name=lat]').val(position.coords.latitude);
1099 form.find('[name=lon]').val(position.coords.longitude);
1102 lat: position.coords.latitude,
1103 lon: position.coords.longitude,
1104 token: $('#token').val()
1107 getJSONgeocodeURL(geocodeURL, data);
1111 switch(error.code) {
1112 case error.PERMISSION_DENIED:
1113 removeNoticeDataGeo('Location permission denied.');
1116 //$('#' + SN.C.S.NoticeDataGeo).prop('checked', false);
1117 removeNoticeDataGeo('Location lookup timeout.');
1127 if (NLat.length > 0 && NLon.length > 0) {
1131 token: $('#token').val()
1134 getJSONgeocodeURL(geocodeURL, data);
1136 removeNoticeDataGeo();
1143 var cookieValue = JSON.parse($.cookie(SN.C.S.NoticeDataGeoCookie));
1145 form.find('[name=lat]').val(cookieValue.NLat);
1146 form.find('[name=lon]').val(cookieValue.NLon);
1147 form.find('[name=location_ns]').val(cookieValue.NLNS);
1148 form.find('[name=location_id]').val(cookieValue.NLID);
1149 form.find('[name=notice_data-geo]').prop('checked', cookieValue.NDG);
1151 SN.U.NoticeGeoStatus(form, cookieValue.NLN, cookieValue.NLat, cookieValue.NLon, cookieValue.NLNU);
1153 .attr('title', NoticeDataGeo_text.ShareDisable + ' (' + cookieValue.NLN + ')')
1154 .addClass('checked');
1156 console.log('Parsing error:', e);
1160 removeNoticeDataGeo();
1167 * Create or update a geolocation status widget in this notice posting form.
1169 * @param {jQuery} form
1170 * @param {String} status
1171 * @param {String} lat (optional)
1172 * @param {String} lon (optional)
1173 * @param {String} url (optional)
1175 NoticeGeoStatus: function (form, status, lat, lon, url)
1177 var wrapper = form.find('.geo_status_wrapper');
1178 if (wrapper.length == 0) {
1179 wrapper = $('<div class="' + SN.C.S.Success + ' geo_status_wrapper"><button class="close" style="float:right">×</button><div class="geo_status"></div></div>');
1180 wrapper.find('button.close').click(function () {
1181 form.find('[name=notice_data-geo]').prop('checked', false).change();
1184 form.append(wrapper);
1188 label = $('<a></a>').attr('href', url);
1190 label = $('<span></span>');
1194 var latlon = lat + ';' + lon;
1195 label.attr('title', latlon);
1200 wrapper.find('.geo_status').empty().append(label);
1204 * Setup function -- DOES NOT trigger actions immediately.
1206 * Initializes event handlers for the "Send direct message" link on
1207 * profile pages, setting it up to display a dialog box when clicked.
1209 * Unlike the repeat confirmation form, this appears to fetch
1210 * the form _from the original link target_, so the form itself
1211 * doesn't need to be in the current document.
1213 * @fixme breaks ability to open link in new window?
1215 NewDirectMessage: function () {
1216 NDM = $('.entity_send-a-message a');
1217 NDM.attr({'href': NDM.attr('href') + '&ajax=1'});
1218 NDM.on('click', function () {
1219 var NDMF = $('.entity_send-a-message form');
1220 if (NDMF.length === 0) {
1221 $(this).addClass(SN.C.S.Processing);
1222 $.get(NDM.attr('href'), null, function (data) {
1223 $('.entity_send-a-message').append(document._importNode($('form', data)[0], true));
1224 NDMF = $('.entity_send-a-message .form_notice');
1225 SN.U.FormNoticeXHR(NDMF);
1226 SN.U.FormNoticeEnhancements(NDMF);
1227 NDMF.append('<button class="close">×</button>');
1228 $('.entity_send-a-message button').click(function () {
1232 NDM.removeClass(SN.C.S.Processing);
1236 $('.entity_send-a-message textarea').focus();
1243 * Return a date object with the current local time on the
1244 * given year, month, and day.
1246 * @param {number} year: 4-digit year
1247 * @param {number} month: 0 == January
1248 * @param {number} day: 1 == 1
1251 GetFullYear: function (year, month, day) {
1252 var date = new Date();
1253 date.setFullYear(year, month, day);
1259 * Some sort of object interface for storing some structured
1260 * information in a cookie.
1262 * Appears to be used to save the last-used login nickname?
1263 * That's something that browsers usually take care of for us
1264 * these days, do we really need to do it? Does anything else
1265 * use this interface?
1267 * @fixme what is this?
1268 * @fixme should this use non-cookie local storage when available?
1270 StatusNetInstance: {
1272 * @fixme what is this?
1274 Set: function (value) {
1275 var SNI = SN.U.StatusNetInstance.Get();
1277 value = $.extend(SNI, value);
1281 SN.C.S.StatusNetInstance,
1282 JSON.stringify(value),
1285 expires: SN.U.GetFullYear(2029, 0, 1)
1290 * @fixme what is this?
1293 var cookieValue = $.cookie(SN.C.S.StatusNetInstance);
1294 if (cookieValue !== undefined) {
1295 return JSON.parse(cookieValue);
1301 * @fixme what is this?
1303 Delete: function () {
1304 $.cookie(SN.C.S.StatusNetInstance, null);
1309 * Check if the current page is a timeline where the current user's
1310 * posts should be displayed immediately on success.
1312 * @fixme this should be done in a saner way, with machine-readable
1313 * info about what page we're looking at.
1315 * @param {DOMElement} notice: HTML chunk with formatted notice
1318 belongsOnTimeline: function (notice) {
1319 var action = $("body").attr('id');
1320 if (action == 'public') {
1324 var profileLink = $('#nav_profile a').attr('href');
1326 var authorUrl = $(notice).find('.h-card.p-author').attr('href');
1327 if (authorUrl == profileLink) {
1328 if (action == 'all' || action == 'showstream') {
1329 // Posts always show on your own friends and profile streams.
1335 // @fixme tag, group, reply timelines should be feasible as well.
1336 // Mismatch between id-based and name-based user/group links currently complicates
1337 // the lookup, since all our inline mentions contain the absolute links but the
1338 // UI links currently on the page use malleable names.
1344 * Switch to another active input sub-form.
1345 * This will hide the current form (if any), show the new one, and
1346 * update the input type tab selection state.
1348 * @param {String} tag
1350 switchInputFormTab: function (tag, setFocus) {
1351 if (typeof setFocus === 'undefined') { setFocus = true; }
1352 // The one that's current isn't current anymore
1353 $('.input_form_nav_tab.current').removeClass('current');
1355 $('#input_form_nav_' + tag).addClass('current');
1358 // Don't remove 'current' if we also have the "nonav" class.
1359 // An example would be the message input form. removing
1360 // 'current' will cause the form to vanish from the page.
1361 var nonav = $('.input_form.current.nonav');
1362 if (nonav.length > 0) {
1366 $('.input_form.current').removeClass('current');
1368 // we're done here, no new inputform to focus on
1372 var noticeForm = $('#input_form_' + tag)
1373 .addClass('current')
1374 .find('.ajax-notice').each(function () {
1376 SN.Init.NoticeFormSetup(form);
1379 noticeForm.find('.notice_data-text').focus();
1385 showMoreMenuItems: function (menuid) {
1386 $('#' + menuid + ' .more_link').remove();
1387 var selector = '#' + menuid + ' .extended_menu';
1388 var extended = $(selector);
1389 extended.removeClass('extended_menu');
1396 * If user is logged in, run setup code for the new notice form:
1401 * - file upload events
1403 NoticeForm: function () {
1404 if ($('body.user_in').length > 0) {
1405 // SN.Init.NoticeFormSetup() will get run
1406 // when forms get displayed for the first time...
1408 // Initialize the input form field
1409 $('#input_form_nav .input_form_nav_tab.current').each(function () {
1410 current_tab_id = $(this).attr('id').substring('input_form_nav_'.length);
1411 SN.U.switchInputFormTab(current_tab_id, false);
1414 // Make inline reply forms self-close when clicking out.
1415 $('body').on('click', function (e) {
1416 var openReplies = $('li.notice-reply');
1417 if (openReplies.length > 0) {
1418 var target = $(e.target);
1419 openReplies.each(function () {
1420 // Did we click outside this one?
1421 var replyItem = $(this);
1422 if (replyItem.has(e.target).length == 0) {
1423 var textarea = replyItem.find('.notice_data-text:first');
1424 var cur = $.trim(textarea.val());
1425 // Only close if there's been no edit.
1426 if (cur == '' || cur == textarea.data('initialText')) {
1427 var parentNotice = replyItem.closest('li.notice');
1429 parentNotice.find('li.notice-reply-placeholder').show();
1439 * Encapsulate notice form setup for a single form.
1440 * Plugins can add extra setup by monkeypatching this
1443 * @param {jQuery} form
1445 NoticeFormSetup: function (form) {
1446 if (form.data('NoticeFormSetup')) {
1449 SN.U.NoticeLocationAttach(form);
1450 SN.U.FormNoticeXHR(form);
1451 SN.U.FormNoticeEnhancements(form);
1452 SN.U.NoticeDataAttach(form);
1453 form.data('NoticeFormSetup', true);
1457 * Run setup code for notice timeline views items:
1459 * - AJAX submission for fave/repeat/reply (if logged in)
1460 * - Attachment link extras ('more' links)
1462 Notices: function () {
1463 if ($('body.user_in').length > 0) {
1464 SN.U.NoticeRepeat();
1466 SN.U.NoticeInlineReplySetup();
1467 SN.U.NoticeOptionsAjax();
1470 SN.U.NoticeAttachments();
1474 * Run setup code for user & group profile page header area if logged in:
1476 * - AJAX submission for sub/unsub/join/leave/nudge
1477 * - AJAX form popup for direct-message
1479 EntityActions: function () {
1480 if ($('body.user_in').length > 0) {
1481 $(document).on('click', '.form_user_subscribe', function () { SN.U.FormXHR($(this)); return false; });
1482 $(document).on('click', '.form_user_unsubscribe', function () { SN.U.FormXHR($(this)); return false; });
1483 $(document).on('click', '.form_group_join', function () { SN.U.FormXHR($(this)); return false; });
1484 $(document).on('click', '.form_group_leave', function () { SN.U.FormXHR($(this)); return false; });
1485 $(document).on('click', '.form_user_nudge', function () { SN.U.FormXHR($(this)); return false; });
1486 $(document).on('click', '.form_peopletag_subscribe', function () { SN.U.FormXHR($(this)); return false; });
1487 $(document).on('click', '.form_peopletag_unsubscribe', function () { SN.U.FormXHR($(this)); return false; });
1488 $(document).on('click', '.form_user_add_peopletag', function () { SN.U.FormXHR($(this)); return false; });
1489 $(document).on('click', '.form_user_remove_peopletag', function () { SN.U.FormXHR($(this)); return false; });
1491 SN.U.NewDirectMessage();
1495 ProfileSearch: function () {
1496 if ($('body.user_in').length > 0) {
1497 $(document).on('click', '.form_peopletag_edit_user_search input.submit', function () {
1498 SN.U.FormProfileSearchXHR($(this).parents('form')); return false;
1504 * Run setup code for login form:
1506 * - loads saved last-used-nickname from cookie
1507 * - sets event handler to save nickname to cookie on submit
1509 * @fixme is this necessary? Browsers do their own form saving these days.
1511 Login: function () {
1512 if (SN.U.StatusNetInstance.Get() !== null) {
1513 var nickname = SN.U.StatusNetInstance.Get().Nickname;
1514 if (nickname !== null) {
1515 $('#form_login #nickname').val(nickname);
1519 $('#form_login').on('submit', function () {
1520 SN.U.StatusNetInstance.Set({Nickname: $('#form_login #nickname').val()});
1526 * Run setup for the ajax people tags editor
1528 * - show edit button
1529 * - set event handle for click on edit button
1530 * - loads people tag autocompletion data if not already present
1531 * or if it is stale.
1534 PeopleTags: function () {
1535 $('.user_profile_tags .editable').append($('<button class="peopletags_edit_button"/>'));
1537 $(document).on('click', '.peopletags_edit_button', function () {
1538 var form = $(this).parents('dd').eq(0).find('form');
1539 // We can buy time from the above animation
1544 data: {token: $('#token').val()},
1546 success: function (data) {
1547 // item.label is used to match
1548 for (i=0; i < data.length; i++) {
1549 data[i].label = data[i].tag;
1552 SN.C.PtagACData = data;
1556 $(this).parents('ul').eq(0).fadeOut(200, function () {form.fadeIn(200).find('input#tags')});
1559 $(document).on('click', '.user_profile_tags form .submit', function () {
1560 SN.U.FormPeopletagsXHR($(this).parents('form')); return false;
1565 * Set up any generic 'ajax' form so it submits via AJAX with auto-replacement.
1567 AjaxForms: function () {
1568 $(document).on('submit', 'form.ajax', function () {
1569 SN.U.FormXHR($(this));
1572 $(document).on('click', 'form.ajax input[type=submit]', function () {
1573 // Some forms rely on knowing which submit button was clicked.
1574 // Save a hidden input field which'll be picked up during AJAX
1576 var button = $(this);
1577 var form = button.closest('form');
1578 form.find('.hidden-submit-button').remove();
1579 $('<input class="hidden-submit-button" type="hidden" />')
1580 .attr('name', button.attr('name'))
1587 * Add logic to any file upload forms to handle file size limits,
1588 * on browsers that support basic FileAPI.
1590 UploadForms: function () {
1591 $('input[type=file]').change(function (event) {
1592 if (typeof this.files === "object" && this.files.length > 0) {
1594 for (var i = 0; i < this.files.length; i++) {
1595 size += this.files[i].size;
1598 var max = SN.U.maxFileSize($(this.form));
1599 if (max > 0 && size > max) {
1600 var msg = 'File too large: maximum upload size is %d bytes.';
1601 alert(msg.replace('%d', max));
1605 event.preventDefault();
1612 CheckBoxes: function () {
1613 $("span[class='checkbox-wrapper']").addClass("unchecked");
1614 $(".checkbox-wrapper").click(function () {
1615 if ($(this).children("input").prop("checked")) {
1617 $(this).children("input").prop("checked", false);
1618 $(this).removeClass("checked");
1619 $(this).addClass("unchecked");
1620 $(this).children("label").text("Private?");
1623 $(this).children("input").prop("checked", true);
1624 $(this).removeClass("unchecked");
1625 $(this).addClass("checked");
1626 $(this).children("label").text("Private");
1634 * Run initialization functions on DOM-ready.
1636 * Note that if we're waiting on other scripts to load, this won't happen
1637 * until that's done. To load scripts asynchronously without delaying setup,
1638 * don't start them loading until after DOM-ready time!
1641 SN.Init.AjaxForms();
1642 SN.Init.UploadForms();
1643 SN.Init.CheckBoxes();
1644 if ($('.' + SN.C.S.FormNotice).length > 0) {
1645 SN.Init.NoticeForm();
1647 if ($('#content .notices').length > 0) {
1650 if ($('#content .entity_actions').length > 0) {
1651 SN.Init.EntityActions();
1653 if ($('#form_login').length > 0) {
1656 if ($('#profile_search_results').length > 0) {
1657 SN.Init.ProfileSearch();
1659 if ($('.user_profile_tags .editable').length > 0) {
1660 SN.Init.PeopleTags();