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'
64 * Map of localized message strings exported to script from the PHP
65 * side via Action::getScriptMessages().
67 * Retrieve them via SN.msg(); this array is an implementation detail.
74 * Grabs a localized string that's been previously exported to us
75 * from server-side code via Action::getScriptMessages().
77 * @example alert(SN.msg('coolplugin-failed'));
79 * @param {String} key: string key name to pull from message index
80 * @return matching localized message string
83 if (SN.messages[key] === undefined) {
84 return '[' + key + ']';
86 return SN.messages[key];
91 * Setup function -- DOES NOT trigger actions immediately.
93 * Sets up event handlers on the new notice form.
95 * @param {jQuery} form: jQuery object whose first matching element is the form
98 FormNoticeEnhancements: function (form) {
99 if ($.data(form[0], 'ElementData') === undefined) {
100 var MaxLength = form.find('.count').text();
101 if (MaxLength === undefined) {
102 MaxLength = SN.C.I.MaxLength;
104 $.data(form[0], 'ElementData', {MaxLength: MaxLength});
108 var NDT = form.find('.notice_data-text:first');
110 NDT.on('keyup', function (e) {
114 var delayedUpdate = function (e) {
115 // Cut and paste events fire *before* the operation,
116 // so we need to trigger an update in a little bit.
117 // This would be so much easier if the 'change' event
118 // actually fired every time the value changed. :P
119 window.setTimeout(function () {
123 // Note there's still no event for mouse-triggered 'delete'.
124 NDT.on('cut', delayedUpdate)
125 .on('paste', delayedUpdate);
127 form.find('.count').text($.data(form[0], 'ElementData').MaxLength);
132 * To be called from event handlers on the notice import form.
133 * Triggers an update of the remaining-characters counter.
135 * Additional counter updates will be suppressed during the
136 * next half-second to avoid flooding the layout engine with
137 * updates, followed by another automatic check.
139 * The maximum length is pulled from data established by
140 * FormNoticeEnhancements.
142 * @param {jQuery} form: jQuery object whose first element is the notice posting form
145 Counter: function (form) {
146 SN.C.I.FormNoticeCurrent = form;
148 var MaxLength = $.data(form[0], 'ElementData').MaxLength;
150 if (MaxLength <= 0) {
154 var remaining = MaxLength - SN.U.CharacterCount(form);
155 var counter = form.find('.count');
157 if (remaining.toString() != counter.text()) {
158 if (!SN.C.I.CounterBlackout || remaining === 0) {
159 if (counter.text() != String(remaining)) {
160 counter.text(remaining);
163 form.addClass(SN.C.S.Warning);
165 form.removeClass(SN.C.S.Warning);
167 // Skip updates for the next 500ms.
168 // On slower hardware, updating on every keypress is unpleasant.
169 if (!SN.C.I.CounterBlackout) {
170 SN.C.I.CounterBlackout = true;
171 SN.C.I.FormNoticeCurrent = form;
172 window.setTimeout("SN.U.ClearCounterBlackout(SN.C.I.FormNoticeCurrent);", 500);
179 * Pull the count of characters in the current edit field.
180 * Plugins replacing the edit control may need to override this.
182 * @param {jQuery} form: jQuery object whose first element is the notice posting form
183 * @return number of chars
185 CharacterCount: function (form) {
186 return form.find('.notice_data-text:first').val().length;
190 * Called internally after the counter update blackout period expires;
191 * runs another update to make sure we didn't miss anything.
193 * @param {jQuery} form: jQuery object whose first element is the notice posting form
196 ClearCounterBlackout: function (form) {
197 // Allow keyup events to poke the counter again
198 SN.C.I.CounterBlackout = false;
199 // Check if the string changed since we last looked
204 * Helper function to rewrite default HTTP form action URLs to HTTPS
205 * so we can actually fetch them when on an SSL page in ssl=sometimes
208 * It would be better to output URLs that didn't hardcode protocol
209 * and hostname in the first place...
211 * @param {String} url
214 RewriteAjaxAction: function (url) {
215 // Quick hack: rewrite AJAX submits to HTTPS if they'd fail otherwise.
216 if (document.location.protocol === 'https:' && url.substr(0, 5) === 'http:') {
217 return url.replace(/^http:\/\/[^:\/]+/, 'https://' + document.location.host);
222 FormNoticeUniqueID: function (form) {
223 var oldId = form.attr('id');
224 var newId = 'form_notice_' + Math.floor(Math.random()*999999999);
225 var attrs = ['name', 'for', 'id'];
226 for (var key in attrs) {
227 form.find("[" + attrs[key] + "~='" + oldId + "']").each(function () {
228 var newAttr = $(this).attr(attrs[key]).replace(oldId, newId);
229 $(this).attr(attrs[key], newAttr);
235 * Grabs form data and submits it asynchronously, with 'ajax=1'
236 * parameter added to the rest.
238 * If a successful response includes another form, that form
239 * will be extracted and copied in, replacing the original form.
240 * If there's no form, the first paragraph will be used.
242 * This will automatically be applied on the 'submit' event for
243 * any form with the 'ajax' class.
245 * @fixme can sometimes explode confusingly if returnd data is bogus
246 * @fixme error handling is pretty vague
247 * @fixme can't submit file uploads
249 * @param {jQuery} form: jQuery object whose first element is a form
250 * @param function onSuccess: something extra to do on success
254 FormXHR: function (form, onSuccess) {
258 url: SN.U.RewriteAjaxAction(form.attr('action')),
259 data: form.serialize() + '&ajax=1',
260 beforeSend: function (xhr) {
262 .addClass(SN.C.S.Processing)
264 .addClass(SN.C.S.Disabled)
265 .prop(SN.C.S.Disabled, true);
267 error: function (xhr, textStatus, errorThrown) {
268 // If the server end reported an error from StatusNet,
269 // find it -- otherwise we'll see what was reported
271 var errorReported = null;
272 if (xhr.responseXML) {
273 errorReported = $('#error', xhr.responseXML).text();
275 window.alert(errorReported || errorThrown || textStatus);
277 // Restore the form to original state.
280 .removeClass(SN.C.S.Processing)
282 .removeClass(SN.C.S.Disabled)
283 .prop(SN.C.S.Disabled, false);
285 success: function (data, textStatus) {
286 if ($('form', data)[0] !== undefined) {
287 var form_new = document._importNode($('form', data)[0], true);
288 form.replaceWith(form_new);
292 } else if ($('p', data)[0] !== undefined) {
293 form.replaceWith(document._importNode($('p', data)[0], true));
298 window.alert('Unknown error.');
305 * Setup function -- DOES NOT trigger actions immediately.
307 * Sets up event handlers for special-cased async submission of the
308 * notice-posting form, including some pre-post validation.
310 * Unlike FormXHR() this does NOT submit the form immediately!
311 * It sets up event handlers so that any method of submitting the
312 * form (click on submit button, enter, submit() etc) will trigger
315 * Also unlike FormXHR(), this system will use a hidden iframe
316 * automatically to handle file uploads via <input type="file">
320 * @fixme vast swaths of duplicate code and really long variable names clutter this function up real bad
321 * @fixme error handling is unreliable
322 * @fixme cookieValue is a global variable, but probably shouldn't be
323 * @fixme saving the location cache cookies should be split out
324 * @fixme some error messages are hardcoded english: needs i18n
326 * @param {jQuery} form: jQuery object whose first element is a form
330 FormNoticeXHR: function (form) {
331 SN.C.I.NoticeDataGeo = {};
332 form.append('<input type="hidden" name="ajax" value="1"/>');
334 // Make sure we don't have a mixed HTTP/HTTPS submission...
335 form.attr('action', SN.U.RewriteAjaxAction(form.attr('action')));
338 * Show a response feedback bit under the new-notice dialog.
340 * @param {String} cls: CSS class name to use ('error' or 'success')
341 * @param {String} text
344 var showFeedback = function (cls, text) {
346 $('<p class="form_response"></p>')
353 * Hide the previous response feedback, if any.
355 var removeFeedback = function () {
356 form.find('.form_response').remove();
362 beforeSend: function (formData) {
363 if (form.find('.notice_data-text:first').val() == '') {
364 form.addClass(SN.C.S.Warning);
368 .addClass(SN.C.S.Processing)
370 .addClass(SN.C.S.Disabled)
371 .prop(SN.C.S.Disabled, true);
373 SN.U.normalizeGeoData(form);
377 error: function (xhr, textStatus, errorThrown) {
379 .removeClass(SN.C.S.Processing)
381 .removeClass(SN.C.S.Disabled)
382 .prop(SN.C.S.Disabled, false);
384 if (textStatus == 'timeout') {
386 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.');
388 var response = SN.U.GetResponseXML(xhr);
389 if ($('.' + SN.C.S.Error, response).length > 0) {
390 form.append(document._importNode($('.' + SN.C.S.Error, response)[0], true));
392 if (parseInt(xhr.status) === 0 || $.inArray(parseInt(xhr.status), SN.C.I.HTTP20x30x) >= 0) {
395 .find('.attach-status').remove();
396 SN.U.FormNoticeEnhancements(form);
399 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.');
404 success: function (data, textStatus) {
406 var errorResult = $('#' + SN.C.S.Error, data);
407 if (errorResult.length > 0) {
408 showFeedback('error', errorResult.text());
410 var commandResult = $('#' + SN.C.S.CommandResult, data);
411 if (commandResult.length > 0) {
412 showFeedback('success', commandResult.text());
414 // New notice post was successful. If on our timeline, show it!
415 var notice = document._importNode($('li', data)[0], true);
416 var notices = $('#notices_primary .notices:first');
417 var replyItem = form.closest('li.notice-reply');
419 if (replyItem.length > 0) {
420 // If this is an inline reply, remove the form...
421 var list = form.closest('.threaded-replies');
423 var id = $(notice).attr('id');
424 if ($('#' + id).length == 0) {
425 $(notice).insertBefore(replyItem);
426 } // else Realtime came through before us...
430 } else if (notices.length > 0 && SN.U.belongsOnTimeline(notice)) {
431 // Not a reply. If on our timeline, show it at the top!
433 if ($('#' + notice.id).length === 0) {
434 var notice_irt_value = form.find('[name=inreplyto]').val();
435 var notice_irt = '#notices_primary #notice-' + notice_irt_value;
436 if ($('body')[0].id == 'conversation') {
437 if (notice_irt_value.length > 0 && $(notice_irt + ' .notices').length < 1) {
438 $(notice_irt).append('<ul class="notices"></ul>');
440 $($(notice_irt + ' .notices')[0]).append(notice);
442 notices.prepend(notice);
445 .css({display: 'none'})
447 SN.U.NoticeWithAttachment($('#' + notice.id));
448 SN.U.switchInputFormTab(null);
451 // Not on a timeline that this belongs on?
452 // Just show a success message.
454 showFeedback('success', $('title', data).text());
458 form.find('[name=inreplyto]').val('');
459 form.find('.attach-status').remove();
460 SN.U.FormNoticeEnhancements(form);
463 complete: function (xhr, textStatus) {
465 .removeClass(SN.C.S.Processing)
467 .prop(SN.C.S.Disabled, false)
468 .removeClass(SN.C.S.Disabled);
470 form.find('[name=lat]').val(SN.C.I.NoticeDataGeo.NLat);
471 form.find('[name=lon]').val(SN.C.I.NoticeDataGeo.NLon);
472 form.find('[name=location_ns]').val(SN.C.I.NoticeDataGeo.NLNS);
473 form.find('[name=location_id]').val(SN.C.I.NoticeDataGeo.NLID);
474 form.find('[name=notice_data-geo]').prop('checked', SN.C.I.NoticeDataGeo.NDG);
479 FormProfileSearchXHR: function (form) {
483 url: form.attr('action'),
484 data: form.serialize() + '&ajax=1',
485 beforeSend: function (xhr) {
487 .addClass(SN.C.S.Processing)
489 .addClass(SN.C.S.Disabled)
490 .prop(SN.C.S.Disabled, true);
492 error: function (xhr, textStatus, errorThrown) {
493 window.alert(errorThrown || textStatus);
495 success: function (data, textStatus) {
496 var results_placeholder = $('#profile_search_results');
497 if ($('ul', data)[0] !== undefined) {
498 var list = document._importNode($('ul', data)[0], true);
499 results_placeholder.replaceWith(list);
501 var _error = $('<li/>').append(document._importNode($('p', data)[0], true));
502 results_placeholder.html(_error);
505 .removeClass(SN.C.S.Processing)
507 .removeClass(SN.C.S.Disabled)
508 .prop(SN.C.S.Disabled, false);
513 FormPeopletagsXHR: function (form) {
517 url: form.attr('action'),
518 data: form.serialize() + '&ajax=1',
519 beforeSend: function (xhr) {
521 .addClass(SN.C.S.Processing)
522 .addClass(SN.C.S.Disabled)
523 .prop(SN.C.S.Disabled, true);
525 error: function (xhr, textStatus, errorThrown) {
526 window.alert(errorThrown || textStatus);
528 success: function (data, textStatus) {
529 var results_placeholder = form.parents('.entity_tags');
530 if ($('.entity_tags', data)[0] !== undefined) {
531 var tags = document._importNode($('.entity_tags', data)[0], true);
532 $(tags).find('.editable').append($('<button class="peopletags_edit_button"/>'));
533 results_placeholder.replaceWith(tags);
535 results_placeholder.find('p').remove();
536 results_placeholder.append(document._importNode($('p', data)[0], true));
537 form.removeClass(SN.C.S.Processing)
539 .removeClass(SN.C.S.Disabled)
540 .prop(SN.C.S.Disabled, false);
546 normalizeGeoData: function (form) {
547 SN.C.I.NoticeDataGeo.NLat = form.find('[name=lat]').val();
548 SN.C.I.NoticeDataGeo.NLon = form.find('[name=lon]').val();
549 SN.C.I.NoticeDataGeo.NLNS = form.find('[name=location_ns]').val();
550 SN.C.I.NoticeDataGeo.NLID = form.find('[name=location_id]').val();
551 SN.C.I.NoticeDataGeo.NDG = form.find('[name=notice_data-geo]').prop('checked'); // @fixme (does this still need to be fixed somehow?)
553 var cookieValue = $.cookie(SN.C.S.NoticeDataGeoCookie);
555 if (cookieValue !== undefined && cookieValue != 'disabled') {
556 cookieValue = JSON.parse(cookieValue);
557 SN.C.I.NoticeDataGeo.NLat = form.find('[name=lat]').val(cookieValue.NLat).val();
558 SN.C.I.NoticeDataGeo.NLon = form.find('[name=lon]').val(cookieValue.NLon).val();
559 if (cookieValue.NLNS) {
560 SN.C.I.NoticeDataGeo.NLNS = form.find('[name=location_ns]').val(cookieValue.NLNS).val();
561 SN.C.I.NoticeDataGeo.NLID = form.find('[name=location_id]').val(cookieValue.NLID).val();
563 form.find('[name=location_ns]').val('');
564 form.find('[name=location_id]').val('');
567 if (cookieValue == 'disabled') {
568 SN.C.I.NoticeDataGeo.NDG = form.find('[name=notice_data-geo]').prop('checked', false).prop('checked');
570 SN.C.I.NoticeDataGeo.NDG = form.find('[name=notice_data-geo]').prop('checked', true).prop('checked');
576 * Fetch an XML DOM from an XHR's response data.
578 * Works around unavailable responseXML when document.domain
579 * has been modified by Meteor or other tools, in some but not
582 * @param {XMLHTTPRequest} xhr
583 * @return DOMDocument
585 GetResponseXML: function (xhr) {
587 return xhr.responseXML;
589 return (new DOMParser()).parseFromString(xhr.responseText, "text/xml");
594 * Setup function -- DOES NOT trigger actions immediately.
596 * Sets up event handlers on all visible notice's option <a> elements
597 * with the "popup" class so they behave as expected with AJAX.
599 * (without javascript the link goes to a page that expects you to verify
600 * the action through a form)
604 NoticeOptionsAjax: function () {
605 $(document).on('click', '.notice-options > a.popup', function (e) {
607 var noticeEl = $(this).closest('.notice');
609 url: $(this).attr('href'),
611 success: function (data, textStatus, xhr) {
612 SN.U.NoticeOptionPopup(data, noticeEl);
619 NoticeOptionPopup: function (data, noticeEl) {
620 title = $('head > title', data).text();
621 body = $('body', data).html();
622 dialog = $(body).dialog({
632 * Setup function -- DOES NOT trigger actions immediately.
634 * Sets up event handlers on all visible notice's reply buttons to
635 * tweak the new-notice form with needed variables and focus it
638 * (This replaces the default reply button behavior to submit
639 * directly to a form which comes back with a specialized page
640 * with the form data prefilled.)
644 NoticeReply: function () {
645 $(document).on('click', '#content .notice_reply', function (e) {
647 var notice = $(this).closest('li.notice');
648 SN.U.NoticeInlineReplyTrigger(notice);
654 * Stub -- kept for compat with plugins for now.
657 NoticeReplyTo: function (notice) {
661 * Open up a notice's inline reply box.
663 * @param {jQuery} notice: jQuery object containing one notice
664 * @param {String} initialText
666 NoticeInlineReplyTrigger: function (notice, initialText) {
667 // Find the notice we're replying to...
668 var id = $($('.notice_id', notice)[0]).text();
670 var parentNotice = notice;
671 var stripForm = true; // strip a couple things out of reply forms that are inline
673 var list = notice.find('.threaded-replies');
674 if (list.length == 0) {
675 list = notice.closest('.threaded-replies');
677 if (list.length == 0) {
678 list = $('<ul class="notices threaded-replies xoxo"></ul>');
680 list = notice.find('.threaded-replies');
683 var nextStep = function () {
685 replyForm.find('input[name=inreplyto]').val(id);
687 // Don't do this for old-school reply form, as they don't come back!
688 replyForm.find('#notice_to').prop('disabled', true).hide();
689 replyForm.find('#notice_private').prop('disabled', true).hide();
690 replyForm.find('label[for=notice_to]').hide();
691 replyForm.find('label[for=notice_private]').hide();
696 var text = replyForm.find('textarea');
697 if (text.length == 0) {
702 replyto = initialText + ' ';
704 text.val(replyto + text.val().replace(new RegExp(replyto, 'i'), ''));
705 text.data('initialText', $.trim(initialText));
707 if (text[0].setSelectionRange) {
708 var len = text.val().length;
709 text[0].setSelectionRange(len, len);
713 // Create the reply form entry
714 var replyItem = $('li.notice-reply', list);
715 if (replyItem.length == 0) {
716 replyItem = $('<li class="notice-reply"></li>');
718 replyForm = replyItem.children('form');
719 if (replyForm.length == 0) {
720 // Let's try another trick to avoid fetching by URL
721 var noticeForm = $('#input_form_status > form');
722 if (noticeForm.length == 0) {
723 // No notice form found on the page, so let's just
724 // fetch a fresh copy of the notice form over AJAX.
726 url: SN.V.urlNewNotice,
727 data: {ajax: 1, inreplyto: id},
728 success: function (data, textStatus, xhr) {
729 var formEl = document._importNode($('form', data)[0], true);
730 replyForm = $(formEl);
731 replyItem.append(replyForm);
732 list.append(replyItem);
734 SN.Init.NoticeFormSetup(replyForm);
738 // We do everything relevant in 'success' above
741 replyForm = noticeForm.clone();
742 SN.Init.NoticeFormSetup(replyForm);
743 replyItem.append(replyForm);
744 list.append(replyItem);
746 // replyForm is set, we're not fetching by URL...
747 // Next setp is to configure in-reply-to etc.
752 * Setup function -- DOES NOT apply immediately.
754 * Uses 'on' rather than 'live' or 'bind', so applies to future as well as present items.
756 NoticeInlineReplySetup: function () {
757 // Expand conversation links
758 $(document).on('click', 'li.notice-reply-comments a', function () {
759 var url = $(this).attr('href');
760 var area = $(this).closest('.threaded-replies');
764 success: function (data, textStatus, xhr) {
765 var replies = $('.threaded-replies', data);
766 if (replies.length) {
767 area.replaceWith(document._importNode(replies[0], true));
776 * Setup function -- DOES NOT trigger actions immediately.
778 * Sets up event handlers for repeat forms to toss up a confirmation
779 * popout before submitting.
781 * Uses 'on' rather than 'live' or 'bind', so applies to future as well as present items.
784 NoticeRepeat: function () {
785 $('body').on('click', '.form_repeat', function (e) {
788 SN.U.NoticeRepeatConfirmation($(this));
794 * Shows a confirmation dialog box variant of the repeat button form.
795 * This seems to use a technique where the repeat form contains
796 * _both_ a standalone button _and_ text and buttons for a dialog.
797 * The dialog will close after its copy of the form is submitted,
798 * or if you click its 'close' button.
800 * The dialog is created by duplicating the original form and changing
801 * its style; while clever, this is hard to generalize and probably
802 * duplicates a lot of unnecessary HTML output.
804 * @fixme create confirmation dialogs through a generalized interface
805 * that can be reused instead of hardcoded text and styles.
807 * @param {jQuery} form
809 NoticeRepeatConfirmation: function (form) {
810 var submit_i = form.find('.submit');
812 var submit = submit_i.clone();
814 .addClass('submit_dialogbox')
815 .removeClass('submit');
817 submit.on('click', function () { SN.U.FormXHR(form); return false; });
822 .addClass('dialogbox')
823 .append('<button class="close">×</button>')
824 .closest('.notice-options')
827 form.find('button.close').click(function () {
831 .removeClass('dialogbox')
832 .closest('.notice-options')
833 .removeClass('opaque');
835 form.find('.submit_dialogbox').remove();
836 form.find('.submit').show();
843 * Setup function -- DOES NOT trigger actions immediately.
845 * Goes through all notices currently displayed and sets up attachment
846 * handling if needed.
848 NoticeAttachments: function () {
849 $('.notice a.attachment').each(function () {
850 SN.U.NoticeWithAttachment($(this).closest('.notice'));
855 * Setup function -- DOES NOT trigger actions immediately.
857 * Sets up special attachment link handling if needed. Currently this
858 * consists only of making the "more" button used for OStatus message
859 * cropping turn into an auto-expansion button that loads the full
860 * text from an attachment file.
862 * @param {jQuery} notice
864 NoticeWithAttachment: function (notice) {
865 if (notice.find('.attachment').length === 0) {
869 $(document).on('click','.attachment.more',function () {
871 m.addClass(SN.C.S.Processing);
872 $.get(m.attr('href'), {ajax: 1}, function (data) {
873 m.parent('.e-content').html($(data).find('#attachment_view .e-content').html());
882 * Setup function -- DOES NOT trigger actions immediately.
884 * Sets up event handlers for the file-attachment widget in the
885 * new notice form. When a file is selected, a box will be added
886 * below the text input showing the filename and, if supported
887 * by the browser, a thumbnail preview.
889 * This preview box will also allow removing the attachment
892 * @param {jQuery} form
894 NoticeDataAttach: function (form) {
896 var NDA = form.find('input[type=file]');
897 NDA.change(function (event) {
898 form.find('.attach-status').remove();
900 var filename = $(this).val();
902 // No file -- we've been tricked!
906 var attachStatus = $('<div class="attach-status ' + SN.C.S.Success + '"><code></code> <button class="close">×</button></div>');
907 attachStatus.find('code').text(filename);
908 attachStatus.find('button').click(function () {
909 attachStatus.remove();
914 form.append(attachStatus);
916 if (typeof this.files === "object") {
917 // Some newer browsers will let us fetch the files for preview.
918 for (i = 0; i < this.files.length; i++) {
919 SN.U.PreviewAttach(form, this.files[i]);
926 * Get PHP's MAX_FILE_SIZE setting for this form;
927 * used to apply client-side file size limit checks.
929 * @param {jQuery} form
930 * @return int max size in bytes; 0 or negative means no limit
932 maxFileSize: function (form) {
933 var max = $(form).find('input[name=MAX_FILE_SIZE]').attr('value');
935 return parseInt(max);
941 * For browsers with FileAPI support: make a thumbnail if possible,
942 * and append it into the attachment display widget.
945 * - Firefox 3.6.6, 4.0b7
946 * - Chrome 8.0.552.210
948 * Known ok metadata, can't get contents:
952 * - Opera 10.63, 11 beta (no input.files interface)
954 * @param {jQuery} form
957 * @todo use configured thumbnail size
958 * @todo detect pixel size?
959 * @todo should we render a thumbnail to a canvas and then use the smaller image?
961 PreviewAttach: function (form, file) {
962 var tooltip = file.type + ' ' + Math.round(file.size / 1024) + 'KB';
966 if (window.createObjectURL !== undefined) {
968 * createObjectURL lets us reference the file directly from an <img>
969 * This produces a compact URL with an opaque reference to the file,
970 * which we can reference immediately.
972 * - Firefox 3.6.6: no
973 * - Firefox 4.0b7: no
975 * - Chrome 8.0.552.210: works!
977 blobAsDataURL = function (blob, callback) {
978 callback(window.createObjectURL(blob));
980 } else if (window.FileReader !== undefined) {
982 * FileAPI's FileReader can build a data URL from a blob's contents,
983 * but it must read the file and build it asynchronously. This means
984 * we'll be passing a giant data URL around, which may be inefficient.
986 * - Firefox 3.6.6: works!
987 * - Firefox 4.0b7: works!
989 * - Chrome 8.0.552.210: works!
991 blobAsDataURL = function (blob, callback) {
992 var reader = new FileReader();
993 reader.onload = function (event) {
994 callback(reader.result);
996 reader.readAsDataURL(blob);
1002 var imageTypes = ['image/png', 'image/jpeg', 'image/gif', 'image/svg+xml'];
1003 if ($.inArray(file.type, imageTypes) == -1) {
1004 // We probably don't know how to show the file.
1008 var maxSize = 8 * 1024 * 1024;
1009 if (file.size > maxSize) {
1010 // Don't kill the browser trying to load some giant image.
1015 blobAsDataURL(file, function (url) {
1016 var img = $('<img>')
1017 .attr('title', tooltip)
1018 .attr('alt', tooltip)
1020 .attr('style', 'height: 120px');
1021 form.find('.attach-status').append(img);
1024 var img = $('<div></div>').text(tooltip);
1025 form.find('.attach-status').append(img);
1030 * Setup function -- DOES NOT trigger actions immediately.
1032 * Initializes state for the location-lookup features in the
1033 * new-notice form. Seems to set up some event handlers for
1034 * triggering lookups and using the new values.
1036 * @param {jQuery} form
1039 * @fixme there's not good visual state update here, so users have a
1040 * hard time figuring out if it's working or fixing if it's wrong.
1043 NoticeLocationAttach: function (form) {
1044 // @fixme this should not be tied to the main notice form, as there may be multiple notice forms...
1045 var NLat = form.find('[name=lat]');
1046 var NLon = form.find('[name=lon]');
1047 var NLNS = form.find('[name=location_ns]').val();
1048 var NLID = form.find('[name=location_id]').val();
1049 var NLN = ''; // @fixme
1050 var NDGe = form.find('[name=notice_data-geo]');
1051 var check = form.find('[name=notice_data-geo]');
1052 var label = form.find('label.notice_data-geo');
1054 function removeNoticeDataGeo(error) {
1056 .attr('title', $.trim(label.text()))
1057 .removeClass('checked');
1059 form.find('[name=lat]').val('');
1060 form.find('[name=lon]').val('');
1061 form.find('[name=location_ns]').val('');
1062 form.find('[name=location_id]').val('');
1063 form.find('[name=notice_data-geo]').prop('checked', false);
1065 $.cookie(SN.C.S.NoticeDataGeoCookie, 'disabled', { path: '/' });
1068 form.find('.geo_status_wrapper').removeClass('success').addClass('error');
1069 form.find('.geo_status_wrapper .geo_status').text(error);
1071 form.find('.geo_status_wrapper').remove();
1075 function getJSONgeocodeURL(geocodeURL, data) {
1076 SN.U.NoticeGeoStatus(form, 'Looking up place name...');
1077 $.getJSON(geocodeURL, data, function (location) {
1078 var lns, lid, NLN_text;
1080 if (location.location_ns !== undefined) {
1081 form.find('[name=location_ns]').val(location.location_ns);
1082 lns = location.location_ns;
1085 if (location.location_id !== undefined) {
1086 form.find('[name=location_id]').val(location.location_id);
1087 lid = location.location_id;
1090 if (location.name === undefined) {
1091 NLN_text = data.lat + ';' + data.lon;
1093 NLN_text = location.name;
1096 SN.U.NoticeGeoStatus(form, NLN_text, data.lat, data.lon, location.url);
1098 .attr('title', NoticeDataGeo_text.ShareDisable + ' (' + NLN_text + ')');
1100 form.find('[name=lat]').val(data.lat);
1101 form.find('[name=lon]').val(data.lon);
1102 form.find('[name=location_ns]').val(lns);
1103 form.find('[name=location_id]').val(lid);
1104 form.find('[name=notice_data-geo]').prop('checked', true);
1116 $.cookie(SN.C.S.NoticeDataGeoCookie, JSON.stringify(cookieValue), { path: '/' });
1120 if (check.length > 0) {
1121 if ($.cookie(SN.C.S.NoticeDataGeoCookie) == 'disabled') {
1122 check.prop('checked', false);
1124 check.prop('checked', true);
1127 var NGW = form.find('.notice_data-geo_wrap');
1128 var geocodeURL = NGW.attr('data-api');
1130 label.attr('title', label.text());
1132 check.change(function () {
1133 if (check.prop('checked') === true || $.cookie(SN.C.S.NoticeDataGeoCookie) === null) {
1135 .attr('title', NoticeDataGeo_text.ShareDisable)
1136 .addClass('checked');
1138 if ($.cookie(SN.C.S.NoticeDataGeoCookie) === null || $.cookie(SN.C.S.NoticeDataGeoCookie) == 'disabled') {
1139 if (navigator.geolocation) {
1140 SN.U.NoticeGeoStatus(form, 'Requesting location from browser...');
1141 navigator.geolocation.getCurrentPosition(
1142 function (position) {
1143 form.find('[name=lat]').val(position.coords.latitude);
1144 form.find('[name=lon]').val(position.coords.longitude);
1147 lat: position.coords.latitude,
1148 lon: position.coords.longitude,
1149 token: $('#token').val()
1152 getJSONgeocodeURL(geocodeURL, data);
1156 switch(error.code) {
1157 case error.PERMISSION_DENIED:
1158 removeNoticeDataGeo('Location permission denied.');
1161 //$('#' + SN.C.S.NoticeDataGeo).prop('checked', false);
1162 removeNoticeDataGeo('Location lookup timeout.');
1172 if (NLat.length > 0 && NLon.length > 0) {
1176 token: $('#token').val()
1179 getJSONgeocodeURL(geocodeURL, data);
1181 removeNoticeDataGeo();
1188 var cookieValue = JSON.parse($.cookie(SN.C.S.NoticeDataGeoCookie));
1190 form.find('[name=lat]').val(cookieValue.NLat);
1191 form.find('[name=lon]').val(cookieValue.NLon);
1192 form.find('[name=location_ns]').val(cookieValue.NLNS);
1193 form.find('[name=location_id]').val(cookieValue.NLID);
1194 form.find('[name=notice_data-geo]').prop('checked', cookieValue.NDG);
1196 SN.U.NoticeGeoStatus(form, cookieValue.NLN, cookieValue.NLat, cookieValue.NLon, cookieValue.NLNU);
1198 .attr('title', NoticeDataGeo_text.ShareDisable + ' (' + cookieValue.NLN + ')')
1199 .addClass('checked');
1201 console.log('Parsing error:', e);
1205 removeNoticeDataGeo();
1212 * Create or update a geolocation status widget in this notice posting form.
1214 * @param {jQuery} form
1215 * @param {String} status
1216 * @param {String} lat (optional)
1217 * @param {String} lon (optional)
1218 * @param {String} url (optional)
1220 NoticeGeoStatus: function (form, status, lat, lon, url)
1222 var wrapper = form.find('.geo_status_wrapper');
1223 if (wrapper.length == 0) {
1224 wrapper = $('<div class="' + SN.C.S.Success + ' geo_status_wrapper"><button class="close" style="float:right">×</button><div class="geo_status"></div></div>');
1225 wrapper.find('button.close').click(function () {
1226 form.find('[name=notice_data-geo]').prop('checked', false).change();
1229 form.append(wrapper);
1233 label = $('<a></a>').attr('href', url);
1235 label = $('<span></span>');
1239 var latlon = lat + ';' + lon;
1240 label.attr('title', latlon);
1245 wrapper.find('.geo_status').empty().append(label);
1249 * Setup function -- DOES NOT trigger actions immediately.
1251 * Initializes event handlers for the "Send direct message" link on
1252 * profile pages, setting it up to display a dialog box when clicked.
1254 * Unlike the repeat confirmation form, this appears to fetch
1255 * the form _from the original link target_, so the form itself
1256 * doesn't need to be in the current document.
1258 * @fixme breaks ability to open link in new window?
1260 NewDirectMessage: function () {
1261 NDM = $('.entity_send-a-message a');
1262 NDM.attr({'href': NDM.attr('href') + '&ajax=1'});
1263 NDM.on('click', function () {
1264 var NDMF = $('.entity_send-a-message form');
1265 if (NDMF.length === 0) {
1266 $(this).addClass(SN.C.S.Processing);
1267 $.get(NDM.attr('href'), null, function (data) {
1268 $('.entity_send-a-message').append(document._importNode($('form', data)[0], true));
1269 NDMF = $('.entity_send-a-message .form_notice');
1270 SN.U.FormNoticeXHR(NDMF);
1271 SN.U.FormNoticeEnhancements(NDMF);
1272 NDMF.append('<button class="close">×</button>');
1273 $('.entity_send-a-message button').click(function () {
1277 NDM.removeClass(SN.C.S.Processing);
1281 $('.entity_send-a-message textarea').focus();
1288 * Return a date object with the current local time on the
1289 * given year, month, and day.
1291 * @param {number} year: 4-digit year
1292 * @param {number} month: 0 == January
1293 * @param {number} day: 1 == 1
1296 GetFullYear: function (year, month, day) {
1297 var date = new Date();
1298 date.setFullYear(year, month, day);
1304 * Some sort of object interface for storing some structured
1305 * information in a cookie.
1307 * Appears to be used to save the last-used login nickname?
1308 * That's something that browsers usually take care of for us
1309 * these days, do we really need to do it? Does anything else
1310 * use this interface?
1312 * @fixme what is this?
1313 * @fixme should this use non-cookie local storage when available?
1315 StatusNetInstance: {
1317 * @fixme what is this?
1319 Set: function (value) {
1320 var SNI = SN.U.StatusNetInstance.Get();
1322 value = $.extend(SNI, value);
1326 SN.C.S.StatusNetInstance,
1327 JSON.stringify(value),
1330 expires: SN.U.GetFullYear(2029, 0, 1)
1335 * @fixme what is this?
1338 var cookieValue = $.cookie(SN.C.S.StatusNetInstance);
1339 if (cookieValue !== undefined) {
1340 return JSON.parse(cookieValue);
1346 * @fixme what is this?
1348 Delete: function () {
1349 $.cookie(SN.C.S.StatusNetInstance, null);
1354 * Check if the current page is a timeline where the current user's
1355 * posts should be displayed immediately on success.
1357 * @fixme this should be done in a saner way, with machine-readable
1358 * info about what page we're looking at.
1360 * @param {DOMElement} notice: HTML chunk with formatted notice
1363 belongsOnTimeline: function (notice) {
1364 var action = $("body").attr('id');
1365 if (action == 'public') {
1369 var profileLink = $('#nav_profile a').attr('href');
1371 var authorUrl = $(notice).find('.h-card.p-author').attr('href');
1372 if (authorUrl == profileLink) {
1373 if (action == 'all' || action == 'showstream') {
1374 // Posts always show on your own friends and profile streams.
1380 // @fixme tag, group, reply timelines should be feasible as well.
1381 // Mismatch between id-based and name-based user/group links currently complicates
1382 // the lookup, since all our inline mentions contain the absolute links but the
1383 // UI links currently on the page use malleable names.
1389 * Switch to another active input sub-form.
1390 * This will hide the current form (if any), show the new one, and
1391 * update the input type tab selection state.
1393 * @param {String} tag
1395 switchInputFormTab: function (tag, setFocus) {
1396 if (typeof setFocus === 'undefined') { setFocus = true; }
1397 // The one that's current isn't current anymore
1398 $('.input_form_nav_tab.current').removeClass('current');
1400 $('#input_form_nav_' + tag).addClass('current');
1403 // Don't remove 'current' if we also have the "nonav" class.
1404 // An example would be the message input form. removing
1405 // 'current' will cause the form to vanish from the page.
1406 var nonav = $('.input_form.current.nonav');
1407 if (nonav.length > 0) {
1411 $('.input_form.current').removeClass('current');
1413 // we're done here, no new inputform to focus on
1417 var noticeForm = $('#input_form_' + tag)
1418 .addClass('current')
1419 .find('.ajax-notice').each(function () {
1421 SN.Init.NoticeFormSetup(form);
1424 noticeForm.find('.notice_data-text').focus();
1430 showMoreMenuItems: function (menuid) {
1431 $('#' + menuid + ' .more_link').remove();
1432 var selector = '#' + menuid + ' .extended_menu';
1433 var extended = $(selector);
1434 extended.removeClass('extended_menu');
1441 * If user is logged in, run setup code for the new notice form:
1446 * - file upload events
1448 NoticeForm: function () {
1449 if ($('body.user_in').length > 0) {
1450 // SN.Init.NoticeFormSetup() will get run
1451 // when forms get displayed for the first time...
1453 // Initialize the input form field
1454 $('#input_form_nav .input_form_nav_tab.current').each(function () {
1455 current_tab_id = $(this).attr('id').substring('input_form_nav_'.length);
1456 SN.U.switchInputFormTab(current_tab_id, false);
1459 // Make inline reply forms self-close when clicking out.
1460 $('body').on('click', function (e) {
1461 var openReplies = $('li.notice-reply');
1462 if (openReplies.length > 0) {
1463 var target = $(e.target);
1464 openReplies.each(function () {
1465 // Did we click outside this one?
1466 var replyItem = $(this);
1467 if (replyItem.has(e.target).length == 0) {
1468 var textarea = replyItem.find('.notice_data-text:first');
1469 var cur = $.trim(textarea.val());
1470 // Only close if there's been no edit.
1471 if (cur == '' || cur == textarea.data('initialText')) {
1472 var parentNotice = replyItem.closest('li.notice');
1474 parentNotice.find('li.notice-reply-placeholder').show();
1484 * Encapsulate notice form setup for a single form.
1485 * Plugins can add extra setup by monkeypatching this
1488 * @param {jQuery} form
1490 NoticeFormSetup: function (form) {
1491 if (form.data('NoticeFormSetup')) {
1494 SN.U.NoticeLocationAttach(form);
1495 SN.U.FormNoticeUniqueID(form);
1496 SN.U.FormNoticeXHR(form);
1497 SN.U.FormNoticeEnhancements(form);
1498 SN.U.NoticeDataAttach(form);
1499 form.data('NoticeFormSetup', true);
1503 * Run setup code for notice timeline views items:
1505 * - AJAX submission for fave/repeat/reply (if logged in)
1506 * - Attachment link extras ('more' links)
1508 Notices: function () {
1509 if ($('body.user_in').length > 0) {
1510 SN.U.NoticeRepeat();
1512 SN.U.NoticeInlineReplySetup();
1513 SN.U.NoticeOptionsAjax();
1516 SN.U.NoticeAttachments();
1520 * Run setup code for user & group profile page header area if logged in:
1522 * - AJAX submission for sub/unsub/join/leave/nudge
1523 * - AJAX form popup for direct-message
1525 EntityActions: function () {
1526 if ($('body.user_in').length > 0) {
1527 $(document).on('click', '.form_user_subscribe', function () { SN.U.FormXHR($(this)); return false; });
1528 $(document).on('click', '.form_user_unsubscribe', function () { SN.U.FormXHR($(this)); return false; });
1529 $(document).on('click', '.form_group_join', function () { SN.U.FormXHR($(this)); return false; });
1530 $(document).on('click', '.form_group_leave', function () { SN.U.FormXHR($(this)); return false; });
1531 $(document).on('click', '.form_user_nudge', function () { SN.U.FormXHR($(this)); return false; });
1532 $(document).on('click', '.form_peopletag_subscribe', function () { SN.U.FormXHR($(this)); return false; });
1533 $(document).on('click', '.form_peopletag_unsubscribe', function () { SN.U.FormXHR($(this)); return false; });
1534 $(document).on('click', '.form_user_add_peopletag', function () { SN.U.FormXHR($(this)); return false; });
1535 $(document).on('click', '.form_user_remove_peopletag', function () { SN.U.FormXHR($(this)); return false; });
1537 SN.U.NewDirectMessage();
1541 ProfileSearch: function () {
1542 if ($('body.user_in').length > 0) {
1543 $(document).on('click', '.form_peopletag_edit_user_search input.submit', function () {
1544 SN.U.FormProfileSearchXHR($(this).parents('form')); return false;
1550 * Run setup code for login form:
1552 * - loads saved last-used-nickname from cookie
1553 * - sets event handler to save nickname to cookie on submit
1555 * @fixme is this necessary? Browsers do their own form saving these days.
1557 Login: function () {
1558 if (SN.U.StatusNetInstance.Get() !== null) {
1559 var nickname = SN.U.StatusNetInstance.Get().Nickname;
1560 if (nickname !== null) {
1561 $('#form_login #nickname').val(nickname);
1565 $('#form_login').on('submit', function () {
1566 SN.U.StatusNetInstance.Set({Nickname: $('#form_login #nickname').val()});
1572 * Run setup for the ajax people tags editor
1574 * - show edit button
1575 * - set event handle for click on edit button
1576 * - loads people tag autocompletion data if not already present
1577 * or if it is stale.
1580 PeopleTags: function () {
1581 $('.user_profile_tags .editable').append($('<button class="peopletags_edit_button"/>'));
1583 $(document).on('click', '.peopletags_edit_button', function () {
1584 var form = $(this).parents('dd').eq(0).find('form');
1585 // We can buy time from the above animation
1590 data: {token: $('#token').val()},
1592 success: function (data) {
1593 // item.label is used to match
1594 for (i=0; i < data.length; i++) {
1595 data[i].label = data[i].tag;
1598 SN.C.PtagACData = data;
1602 $(this).parents('ul').eq(0).fadeOut(200, function () {form.fadeIn(200).find('input#tags')});
1605 $(document).on('click', '.user_profile_tags form .submit', function () {
1606 SN.U.FormPeopletagsXHR($(this).parents('form')); return false;
1611 * Set up any generic 'ajax' form so it submits via AJAX with auto-replacement.
1613 AjaxForms: function () {
1614 $(document).on('submit', 'form.ajax', function () {
1615 SN.U.FormXHR($(this));
1618 $(document).on('click', 'form.ajax input[type=submit]', function () {
1619 // Some forms rely on knowing which submit button was clicked.
1620 // Save a hidden input field which'll be picked up during AJAX
1622 var button = $(this);
1623 var form = button.closest('form');
1624 form.find('.hidden-submit-button').remove();
1625 $('<input class="hidden-submit-button" type="hidden" />')
1626 .attr('name', button.attr('name'))
1633 * Add logic to any file upload forms to handle file size limits,
1634 * on browsers that support basic FileAPI.
1636 UploadForms: function () {
1637 $('input[type=file]').change(function (event) {
1638 if (typeof this.files === "object" && this.files.length > 0) {
1640 for (var i = 0; i < this.files.length; i++) {
1641 size += this.files[i].size;
1644 var max = SN.U.maxFileSize($(this.form));
1645 if (max > 0 && size > max) {
1646 var msg = 'File too large: maximum upload size is %d bytes.';
1647 alert(msg.replace('%d', max));
1651 event.preventDefault();
1658 CheckBoxes: function () {
1659 $("span[class='checkbox-wrapper']").addClass("unchecked");
1660 $(".checkbox-wrapper").click(function () {
1661 if ($(this).children("input").prop("checked")) {
1663 $(this).children("input").prop("checked", false);
1664 $(this).removeClass("checked");
1665 $(this).addClass("unchecked");
1666 $(this).children("label").text("Private?");
1669 $(this).children("input").prop("checked", true);
1670 $(this).removeClass("unchecked");
1671 $(this).addClass("checked");
1672 $(this).children("label").text("Private");
1680 * Run initialization functions on DOM-ready.
1682 * Note that if we're waiting on other scripts to load, this won't happen
1683 * until that's done. To load scripts asynchronously without delaying setup,
1684 * don't start them loading until after DOM-ready time!
1687 SN.Init.AjaxForms();
1688 SN.Init.UploadForms();
1689 SN.Init.CheckBoxes();
1690 if ($('.' + SN.C.S.FormNotice).length > 0) {
1691 SN.Init.NoticeForm();
1693 if ($('#content .notices').length > 0) {
1696 if ($('#content .entity_actions').length > 0) {
1697 SN.Init.EntityActions();
1699 if ($('#form_login').length > 0) {
1702 if ($('#profile_search_results').length > 0) {
1703 SN.Init.ProfileSearch();
1705 if ($('.user_profile_tags .editable').length > 0) {
1706 SN.Init.PeopleTags();