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',
60 // These get set on runtime via inline scripting, so don't put anything here.
64 * list of callbacks, categorized into _callbacks['event_name'] = [ callback_function_1, callback_function_2 ]
71 * Map of localized message strings exported to script from the PHP
72 * side via Action::getScriptMessages().
74 * Retrieve them via SN.msg(); this array is an implementation detail.
81 * Grabs a localized string that's been previously exported to us
82 * from server-side code via Action::getScriptMessages().
84 * @example alert(SN.msg('coolplugin-failed'));
86 * @param {String} key: string key name to pull from message index
87 * @return matching localized message string
90 if (SN.messages[key] === undefined) {
91 return '[' + key + ']';
93 return SN.messages[key];
98 * Setup function -- DOES NOT trigger actions immediately.
100 * Sets up event handlers on the new notice form.
102 * @param {jQuery} form: jQuery object whose first matching element is the form
105 FormNoticeEnhancements: function (form) {
106 if ($.data(form[0], 'ElementData') === undefined) {
107 var MaxLength = form.find('.count').text();
108 if (MaxLength === undefined) {
109 MaxLength = SN.C.I.MaxLength;
111 $.data(form[0], 'ElementData', {MaxLength: MaxLength});
115 var NDT = form.find('.notice_data-text:first');
117 NDT.on('keyup', function (e) {
121 var delayedUpdate = function (e) {
122 // Cut and paste events fire *before* the operation,
123 // so we need to trigger an update in a little bit.
124 // This would be so much easier if the 'change' event
125 // actually fired every time the value changed. :P
126 window.setTimeout(function () {
130 // Note there's still no event for mouse-triggered 'delete'.
131 NDT.on('cut', delayedUpdate)
132 .on('paste', delayedUpdate);
134 form.find('.count').text($.data(form[0], 'ElementData').MaxLength);
139 * To be called from event handlers on the notice import form.
140 * Triggers an update of the remaining-characters counter.
142 * Additional counter updates will be suppressed during the
143 * next half-second to avoid flooding the layout engine with
144 * updates, followed by another automatic check.
146 * The maximum length is pulled from data established by
147 * FormNoticeEnhancements.
149 * @param {jQuery} form: jQuery object whose first element is the notice posting form
152 Counter: function (form) {
153 SN.C.I.FormNoticeCurrent = form;
155 var MaxLength = $.data(form[0], 'ElementData').MaxLength;
157 if (MaxLength <= 0) {
161 var remaining = MaxLength - SN.U.CharacterCount(form);
162 var counter = form.find('.count');
164 if (remaining.toString() != counter.text()) {
165 if (!SN.C.I.CounterBlackout || remaining === 0) {
166 if (counter.text() != String(remaining)) {
167 counter.text(remaining);
170 form.addClass(SN.C.S.Warning);
172 form.removeClass(SN.C.S.Warning);
174 // Skip updates for the next 500ms.
175 // On slower hardware, updating on every keypress is unpleasant.
176 if (!SN.C.I.CounterBlackout) {
177 SN.C.I.CounterBlackout = true;
178 SN.C.I.FormNoticeCurrent = form;
179 window.setTimeout("SN.U.ClearCounterBlackout(SN.C.I.FormNoticeCurrent);", 500);
186 * Pull the count of characters in the current edit field.
187 * Plugins replacing the edit control may need to override this.
189 * @param {jQuery} form: jQuery object whose first element is the notice posting form
190 * @return number of chars
192 CharacterCount: function (form) {
193 return form.find('.notice_data-text:first').val().length;
197 * Called internally after the counter update blackout period expires;
198 * runs another update to make sure we didn't miss anything.
200 * @param {jQuery} form: jQuery object whose first element is the notice posting form
203 ClearCounterBlackout: function (form) {
204 // Allow keyup events to poke the counter again
205 SN.C.I.CounterBlackout = false;
206 // Check if the string changed since we last looked
211 * Helper function to rewrite default HTTP form action URLs to HTTPS
212 * so we can actually fetch them when on an SSL page in ssl=sometimes
215 * It would be better to output URLs that didn't hardcode protocol
216 * and hostname in the first place...
218 * @param {String} url
221 RewriteAjaxAction: function (url) {
222 // Quick hack: rewrite AJAX submits to HTTPS if they'd fail otherwise.
223 if (document.location.protocol === 'https:' && url.substr(0, 5) === 'http:') {
224 return url.replace(/^http:\/\/[^:\/]+/, 'https://' + document.location.host);
229 FormNoticeUniqueID: function (form) {
230 var oldId = form.attr('id');
231 var newId = 'form_notice_' + Math.floor(Math.random()*999999999);
232 var attrs = ['name', 'for', 'id'];
233 for (var key in attrs) {
234 if (form.attr(attrs[key]) === undefined) {
237 form.attr(attrs[key], form.attr(attrs[key]).replace(oldId, newId));
239 for (var key in attrs) {
240 form.find("[" + attrs[key] + "*='" + oldId + "']").each(function () {
241 if ($(this).attr(attrs[key]) === undefined) {
242 return; // since we're inside the each(function () { ... });
244 var newAttr = $(this).attr(attrs[key]).replace(oldId, newId);
245 $(this).attr(attrs[key], newAttr);
251 * Grabs form data and submits it asynchronously, with 'ajax=1'
252 * parameter added to the rest.
254 * If a successful response includes another form, that form
255 * will be extracted and copied in, replacing the original form.
256 * If there's no form, the first paragraph will be used.
258 * This will automatically be applied on the 'submit' event for
259 * any form with the 'ajax' class.
261 * @fixme can sometimes explode confusingly if returnd data is bogus
262 * @fixme error handling is pretty vague
263 * @fixme can't submit file uploads
265 * @param {jQuery} form: jQuery object whose first element is a form
266 * @param function onSuccess: something extra to do on success
270 FormXHR: function (form, onSuccess) {
274 url: SN.U.RewriteAjaxAction(form.attr('action')),
275 data: form.serialize() + '&ajax=1',
276 beforeSend: function (xhr) {
278 .addClass(SN.C.S.Processing)
280 .addClass(SN.C.S.Disabled)
281 .prop(SN.C.S.Disabled, true);
283 error: function (xhr, textStatus, errorThrown) {
284 // If the server end reported an error from StatusNet,
285 // find it -- otherwise we'll see what was reported
287 var errorReported = null;
288 if (xhr.responseXML) {
289 errorReported = $('#error', xhr.responseXML).text();
291 window.alert(errorReported || errorThrown || textStatus);
293 // Restore the form to original state.
296 .removeClass(SN.C.S.Processing)
298 .removeClass(SN.C.S.Disabled)
299 .prop(SN.C.S.Disabled, false);
301 success: function (data, textStatus) {
302 if ($('form', data)[0] !== undefined) {
303 var form_new = document._importNode($('form', data)[0], true);
304 form.replaceWith(form_new);
308 } else if ($('p', data)[0] !== undefined) {
309 form.replaceWith(document._importNode($('p', data)[0], true));
314 window.alert('Unknown error.');
321 * Setup function -- DOES NOT trigger actions immediately.
323 * Sets up event handlers for special-cased async submission of the
324 * notice-posting form, including some pre-post validation.
326 * Unlike FormXHR() this does NOT submit the form immediately!
327 * It sets up event handlers so that any method of submitting the
328 * form (click on submit button, enter, submit() etc) will trigger
331 * Also unlike FormXHR(), this system will use a hidden iframe
332 * automatically to handle file uploads via <input type="file">
336 * @fixme vast swaths of duplicate code and really long variable names clutter this function up real bad
337 * @fixme error handling is unreliable
338 * @fixme cookieValue is a global variable, but probably shouldn't be
339 * @fixme saving the location cache cookies should be split out
340 * @fixme some error messages are hardcoded english: needs i18n
342 * @param {jQuery} form: jQuery object whose first element is a form
346 FormNoticeXHR: function (form) {
347 SN.C.I.NoticeDataGeo = {};
348 form.append('<input type="hidden" name="ajax" value="1"/>');
350 // Make sure we don't have a mixed HTTP/HTTPS submission...
351 form.attr('action', SN.U.RewriteAjaxAction(form.attr('action')));
354 * Hide the previous response feedback, if any.
356 var removeFeedback = function () {
357 form.find('.form_response').remove();
362 timeout: SN.V.xhrTimeout,
363 beforeSend: function (formData) {
364 if (form.find('.notice_data-text:first').val() == '') {
365 form.addClass(SN.C.S.Warning);
369 .addClass(SN.C.S.Processing)
371 .addClass(SN.C.S.Disabled)
372 .prop(SN.C.S.Disabled, true);
374 SN.U.normalizeGeoData(form);
378 error: function (xhr, textStatus, errorThrown) {
380 .removeClass(SN.C.S.Processing)
382 .removeClass(SN.C.S.Disabled)
383 .prop(SN.C.S.Disabled, false);
385 if (textStatus == 'timeout') {
387 SN.U.showFeedback(form, 'error', 'Sorry! We had trouble sending your notice. The servers are overloaded. Please try again, and contact the site administrator if this problem persists.');
389 var response = SN.U.GetResponseXML(xhr);
390 if ($('.' + SN.C.S.Error, response).length > 0) {
391 form.append(document._importNode($('.' + SN.C.S.Error, response)[0], true));
393 if (parseInt(xhr.status) === 0 || $.inArray(parseInt(xhr.status), SN.C.I.HTTP20x30x) >= 0) {
396 .find('.attach-status').remove();
397 SN.U.FormNoticeEnhancements(form);
400 SN.U.showFeedback(form, 'error', '(Sorry! We had trouble sending your notice (' + xhr.status + ' ' + xhr.statusText + '). Please report the problem to the site administrator if this happens again.');
405 success: function (data, textStatus) {
407 var errorResult = $('#' + SN.C.S.Error, data);
408 if (errorResult.length > 0) {
409 SN.U.showFeedback(form, 'error', errorResult.text());
411 SN.E.ajaxNoticePosted(form, data, textStatus);
414 complete: function (xhr, textStatus) {
416 .removeClass(SN.C.S.Processing)
418 .prop(SN.C.S.Disabled, false)
419 .removeClass(SN.C.S.Disabled);
421 form.find('[name=lat]').val(SN.C.I.NoticeDataGeo.NLat);
422 form.find('[name=lon]').val(SN.C.I.NoticeDataGeo.NLon);
423 form.find('[name=location_ns]').val(SN.C.I.NoticeDataGeo.NLNS);
424 form.find('[name=location_id]').val(SN.C.I.NoticeDataGeo.NLID);
425 form.find('[name=notice_data-geo]').prop('checked', SN.C.I.NoticeDataGeo.NDG);
430 FormProfileSearchXHR: function (form) {
434 url: form.attr('action'),
435 data: form.serialize() + '&ajax=1',
436 beforeSend: function (xhr) {
438 .addClass(SN.C.S.Processing)
440 .addClass(SN.C.S.Disabled)
441 .prop(SN.C.S.Disabled, true);
443 error: function (xhr, textStatus, errorThrown) {
444 window.alert(errorThrown || textStatus);
446 success: function (data, textStatus) {
447 var results_placeholder = $('#profile_search_results');
448 if ($('ul', data)[0] !== undefined) {
449 var list = document._importNode($('ul', data)[0], true);
450 results_placeholder.replaceWith(list);
452 var _error = $('<li/>').append(document._importNode($('p', data)[0], true));
453 results_placeholder.html(_error);
456 .removeClass(SN.C.S.Processing)
458 .removeClass(SN.C.S.Disabled)
459 .prop(SN.C.S.Disabled, false);
464 FormPeopletagsXHR: function (form) {
468 url: form.attr('action'),
469 data: form.serialize() + '&ajax=1',
470 beforeSend: function (xhr) {
472 .addClass(SN.C.S.Processing)
473 .addClass(SN.C.S.Disabled)
474 .prop(SN.C.S.Disabled, true);
476 error: function (xhr, textStatus, errorThrown) {
477 window.alert(errorThrown || textStatus);
479 success: function (data, textStatus) {
480 var results_placeholder = form.parents('.entity_tags');
481 if ($('.entity_tags', data)[0] !== undefined) {
482 var tags = document._importNode($('.entity_tags', data)[0], true);
483 $(tags).find('.editable').append($('<button class="peopletags_edit_button"/>'));
484 results_placeholder.replaceWith(tags);
486 results_placeholder.find('p').remove();
487 results_placeholder.append(document._importNode($('p', data)[0], true));
488 form.removeClass(SN.C.S.Processing)
490 .removeClass(SN.C.S.Disabled)
491 .prop(SN.C.S.Disabled, false);
497 normalizeGeoData: function (form) {
498 SN.C.I.NoticeDataGeo.NLat = form.find('[name=lat]').val();
499 SN.C.I.NoticeDataGeo.NLon = form.find('[name=lon]').val();
500 SN.C.I.NoticeDataGeo.NLNS = form.find('[name=location_ns]').val();
501 SN.C.I.NoticeDataGeo.NLID = form.find('[name=location_id]').val();
502 SN.C.I.NoticeDataGeo.NDG = form.find('[name=notice_data-geo]').prop('checked'); // @fixme (does this still need to be fixed somehow?)
504 var cookieValue = $.cookie(SN.C.S.NoticeDataGeoCookie);
506 if (cookieValue !== undefined && cookieValue != 'disabled') {
507 cookieValue = JSON.parse(cookieValue);
508 SN.C.I.NoticeDataGeo.NLat = form.find('[name=lat]').val(cookieValue.NLat).val();
509 SN.C.I.NoticeDataGeo.NLon = form.find('[name=lon]').val(cookieValue.NLon).val();
510 if (cookieValue.NLNS) {
511 SN.C.I.NoticeDataGeo.NLNS = form.find('[name=location_ns]').val(cookieValue.NLNS).val();
512 SN.C.I.NoticeDataGeo.NLID = form.find('[name=location_id]').val(cookieValue.NLID).val();
514 form.find('[name=location_ns]').val('');
515 form.find('[name=location_id]').val('');
518 if (cookieValue == 'disabled') {
519 SN.C.I.NoticeDataGeo.NDG = form.find('[name=notice_data-geo]').prop('checked', false).prop('checked');
521 SN.C.I.NoticeDataGeo.NDG = form.find('[name=notice_data-geo]').prop('checked', true).prop('checked');
527 * Fetch an XML DOM from an XHR's response data.
529 * Works around unavailable responseXML when document.domain
530 * has been modified by Meteor or other tools, in some but not
533 * @param {XMLHTTPRequest} xhr
534 * @return DOMDocument
536 GetResponseXML: function (xhr) {
538 return xhr.responseXML;
540 return (new DOMParser()).parseFromString(xhr.responseText, "text/xml");
545 * Setup function -- DOES NOT trigger actions immediately.
547 * Sets up event handlers on all visible notice's option <a> elements
548 * with the "popup" class so they behave as expected with AJAX.
550 * (without javascript the link goes to a page that expects you to verify
551 * the action through a form)
555 NoticeOptionsAjax: function () {
556 $(document).on('click', '.notice-options > a.popup', function (e) {
558 var noticeEl = $(this).closest('.notice');
560 url: $(this).attr('href'),
562 success: function (data, textStatus, xhr) {
563 SN.U.NoticeOptionPopup(data, noticeEl);
570 NoticeOptionPopup: function (data, noticeEl) {
571 title = $('head > title', data).text();
572 body = $('body', data).html();
573 dialog = $(body).dialog({
583 * Setup function -- DOES NOT trigger actions immediately.
585 * Sets up event handlers on all visible notice's reply buttons to
586 * tweak the new-notice form with needed variables and focus it
589 * (This replaces the default reply button behavior to submit
590 * directly to a form which comes back with a specialized page
591 * with the form data prefilled.)
595 NoticeReply: function () {
596 $(document).on('click', '#content .notice_reply', function (e) {
598 var notice = $(this).closest('li.notice');
599 SN.U.NoticeInlineReplyTrigger(notice);
605 * Stub -- kept for compat with plugins for now.
608 NoticeReplyTo: function (notice) {
612 * Open up a notice's inline reply box.
614 * @param {jQuery} notice: jQuery object containing one notice
615 * @param {String} initialText
617 NoticeInlineReplyTrigger: function (notice, initialText) {
618 // Find the notice we're replying to...
619 var id = $($('.notice_id', notice)[0]).text();
621 var parentNotice = notice;
622 var stripForm = true; // strip a couple things out of reply forms that are inline
624 var list = notice.find('.threaded-replies');
625 if (list.length == 0) {
626 list = notice.closest('.threaded-replies');
628 if (list.length == 0) {
629 list = $('<ul class="notices threaded-replies xoxo"></ul>');
631 list = notice.find('.threaded-replies');
634 var nextStep = function () {
636 replyForm.find('input[name=inreplyto]').val(id);
638 // Don't do this for old-school reply form, as they don't come back!
639 replyForm.find('#notice_to').prop('disabled', true).hide();
640 replyForm.find('#notice_private').prop('disabled', true).hide();
641 replyForm.find('label[for=notice_to]').hide();
642 replyForm.find('label[for=notice_private]').hide();
647 var text = replyForm.find('textarea');
648 if (text.length == 0) {
653 replyto = initialText + ' ';
655 text.val(replyto + text.val().replace(new RegExp(replyto, 'i'), ''));
656 text.data('initialText', $.trim(initialText));
658 if (text[0].setSelectionRange) {
659 var len = text.val().length;
660 text[0].setSelectionRange(len, len);
664 // Create the reply form entry
665 var replyItem = $('li.notice-reply', list);
666 if (replyItem.length == 0) {
667 replyItem = $('<li class="notice-reply"></li>');
669 replyForm = replyItem.children('form');
670 if (replyForm.length == 0) {
671 // Let's try another trick to avoid fetching by URL
672 var noticeForm = $('#input_form_status > form');
673 if (noticeForm.length == 0) {
674 // No notice form found on the page, so let's just
675 // fetch a fresh copy of the notice form over AJAX.
677 url: SN.V.urlNewNotice,
678 data: {ajax: 1, inreplyto: id},
679 success: function (data, textStatus, xhr) {
680 var formEl = document._importNode($('form', data)[0], true);
681 replyForm = $(formEl);
682 replyItem.append(replyForm);
683 list.append(replyItem);
685 SN.Init.NoticeFormSetup(replyForm);
689 // We do everything relevant in 'success' above
692 replyForm = noticeForm.clone();
693 SN.Init.NoticeFormSetup(replyForm);
694 replyItem.append(replyForm);
695 list.append(replyItem);
697 // replyForm is set, we're not fetching by URL...
698 // Next setp is to configure in-reply-to etc.
703 * Setup function -- DOES NOT apply immediately.
705 * Uses 'on' rather than 'live' or 'bind', so applies to future as well as present items.
707 NoticeInlineReplySetup: function () {
708 // Expand conversation links
709 $(document).on('click', 'li.notice-reply-comments a', function () {
710 var url = $(this).attr('href');
711 var area = $(this).closest('.threaded-replies');
715 success: function (data, textStatus, xhr) {
716 var replies = $('.threaded-replies', data);
717 if (replies.length) {
718 area.replaceWith(document._importNode(replies[0], true));
727 * Setup function -- DOES NOT trigger actions immediately.
729 * Sets up event handlers for repeat forms to toss up a confirmation
730 * popout before submitting.
732 * Uses 'on' rather than 'live' or 'bind', so applies to future as well as present items.
735 NoticeRepeat: function () {
736 $('body').on('click', '.form_repeat', function (e) {
739 SN.U.NoticeRepeatConfirmation($(this));
745 * Shows a confirmation dialog box variant of the repeat button form.
746 * This seems to use a technique where the repeat form contains
747 * _both_ a standalone button _and_ text and buttons for a dialog.
748 * The dialog will close after its copy of the form is submitted,
749 * or if you click its 'close' button.
751 * The dialog is created by duplicating the original form and changing
752 * its style; while clever, this is hard to generalize and probably
753 * duplicates a lot of unnecessary HTML output.
755 * @fixme create confirmation dialogs through a generalized interface
756 * that can be reused instead of hardcoded text and styles.
758 * @param {jQuery} form
760 NoticeRepeatConfirmation: function (form) {
761 var submit_i = form.find('.submit');
763 var submit = submit_i.clone();
765 .addClass('submit_dialogbox')
766 .removeClass('submit');
768 submit.on('click', function () { SN.U.FormXHR(form); return false; });
773 .addClass('dialogbox')
774 .append('<button class="close" title="' + SN.msg('popup_close_button') + '">×</button>')
775 .closest('.notice-options')
778 form.find('button.close').click(function () {
782 .removeClass('dialogbox')
783 .closest('.notice-options')
784 .removeClass('opaque');
786 form.find('.submit_dialogbox').remove();
787 form.find('.submit').show();
794 * Setup function -- DOES NOT trigger actions immediately.
796 * Goes through all notices currently displayed and sets up attachment
797 * handling if needed.
799 NoticeAttachments: function () {
800 $('.notice a.attachment').each(function () {
801 SN.U.NoticeWithAttachment($(this).closest('.notice'));
806 * Setup function -- DOES NOT trigger actions immediately.
808 * Sets up special attachment link handling if needed. Currently this
809 * consists only of making the "more" button used for OStatus message
810 * cropping turn into an auto-expansion button that loads the full
811 * text from an attachment file.
813 * @param {jQuery} notice
815 NoticeWithAttachment: function (notice) {
816 if (notice.find('.attachment').length === 0) {
820 $(document).on('click','.attachment.more',function () {
822 m.addClass(SN.C.S.Processing);
823 $.get(m.attr('href'), {ajax: 1}, function (data) {
824 m.parent('.e-content').html($(data).find('#attachment_view .e-content').html());
833 * Setup function -- DOES NOT trigger actions immediately.
835 * Sets up event handlers for the file-attachment widget in the
836 * new notice form. When a file is selected, a box will be added
837 * below the text input showing the filename and, if supported
838 * by the browser, a thumbnail preview.
840 * This preview box will also allow removing the attachment
843 * @param {jQuery} form
845 NoticeDataAttach: function (form) {
847 var NDA = form.find('input[type=file]');
848 NDA.change(function (event) {
849 form.find('.attach-status').remove();
851 if (typeof this.files === "object") {
852 var attachStatus = $('<ul class="attach-status ' + SN.C.S.Success + '"></ul>');
853 form.append(attachStatus);
854 // Some newer browsers will let us fetch the files for preview.
855 for (i = 0; i < this.files.length; i++) {
856 SN.U.PreviewAttach(form, this.files[i]);
859 var filename = $(this).val();
861 // No file -- we've been tricked!
865 var attachStatus = $('<div class="attach-status ' + SN.C.S.Success + '"><code></code> <button class="close">×</button></div>');
866 attachStatus.find('code').text(filename);
867 attachStatus.find('button').click(function () {
868 attachStatus.remove();
873 form.append(attachStatus);
879 * Get PHP's MAX_FILE_SIZE setting for this form;
880 * used to apply client-side file size limit checks.
882 * @param {jQuery} form
883 * @return int max size in bytes; 0 or negative means no limit
885 maxFileSize: function (form) {
886 var max = $(form).find('input[name=MAX_FILE_SIZE]').attr('value');
888 return parseInt(max);
894 * For browsers with FileAPI support: make a thumbnail if possible,
895 * and append it into the attachment display widget.
898 * - Firefox 3.6.6, 4.0b7
899 * - Chrome 8.0.552.210
901 * Known ok metadata, can't get contents:
905 * - Opera 10.63, 11 beta (no input.files interface)
907 * @param {jQuery} form
910 * @todo use configured thumbnail size
911 * @todo detect pixel size?
912 * @todo should we render a thumbnail to a canvas and then use the smaller image?
914 PreviewAttach: function (form, file) {
915 var tooltip = file.type + ' ' + Math.round(file.size / 1024) + 'KB';
919 if (window.createObjectURL !== undefined) {
921 * createObjectURL lets us reference the file directly from an <img>
922 * This produces a compact URL with an opaque reference to the file,
923 * which we can reference immediately.
925 * - Firefox 3.6.6: no
926 * - Firefox 4.0b7: no
928 * - Chrome 8.0.552.210: works!
930 blobAsDataURL = function (blob, callback) {
931 callback(window.createObjectURL(blob));
933 } else if (window.FileReader !== undefined) {
935 * FileAPI's FileReader can build a data URL from a blob's contents,
936 * but it must read the file and build it asynchronously. This means
937 * we'll be passing a giant data URL around, which may be inefficient.
939 * - Firefox 3.6.6: works!
940 * - Firefox 4.0b7: works!
942 * - Chrome 8.0.552.210: works!
944 blobAsDataURL = function (blob, callback) {
945 var reader = new FileReader();
946 reader.onload = function (event) {
947 callback(reader.result);
949 reader.readAsDataURL(blob);
955 var imageTypes = ['image/png', 'image/jpeg', 'image/gif', 'image/svg+xml',
956 'image/bmp', 'image/webp', 'image/vnd.microsoft.icon'];
957 if ($.inArray(file.type, imageTypes) == -1) {
958 // We probably don't know how to show the file.
962 var maxSize = 8 * 1024 * 1024;
963 if (file.size > maxSize) {
964 // Don't kill the browser trying to load some giant image.
968 var fileentry = $('<li>')
969 .attr('class', 'attachment')
970 .attr('style', 'text-align: center');
972 blobAsDataURL(file, function (url) {
974 .attr('title', tooltip)
975 .attr('alt', tooltip)
977 .attr('style', 'height: 120px');
978 fileentry.append(img);
979 fileentry.append($('<br><code>' + file.name + '</code>'));
980 form.find('.attach-status').append(fileentry);
983 fileentry.append($('<code>' + file.type + '</code>'));
984 fileentry.append($('<br><code>' + file.name + '</code>'));
985 form.find('.attach-status').append(fileentry);
990 * Setup function -- DOES NOT trigger actions immediately.
992 * Initializes state for the location-lookup features in the
993 * new-notice form. Seems to set up some event handlers for
994 * triggering lookups and using the new values.
996 * @param {jQuery} form
999 * @fixme there's not good visual state update here, so users have a
1000 * hard time figuring out if it's working or fixing if it's wrong.
1003 NoticeLocationAttach: function (form) {
1004 // @fixme this should not be tied to the main notice form, as there may be multiple notice forms...
1005 var NLat = form.find('[name=lat]');
1006 var NLon = form.find('[name=lon]');
1007 var NLNS = form.find('[name=location_ns]').val();
1008 var NLID = form.find('[name=location_id]').val();
1009 var NLN = ''; // @fixme
1010 var NDGe = form.find('[name=notice_data-geo]');
1011 var check = form.find('[name=notice_data-geo]');
1012 var label = form.find('label.notice_data-geo');
1014 function removeNoticeDataGeo(error) {
1016 .attr('title', $.trim(label.text()))
1017 .removeClass('checked');
1019 form.find('[name=lat]').val('');
1020 form.find('[name=lon]').val('');
1021 form.find('[name=location_ns]').val('');
1022 form.find('[name=location_id]').val('');
1023 form.find('[name=notice_data-geo]').prop('checked', false);
1025 $.cookie(SN.C.S.NoticeDataGeoCookie, 'disabled', { path: '/' });
1028 form.find('.geo_status_wrapper').removeClass('success').addClass('error');
1029 form.find('.geo_status_wrapper .geo_status').text(error);
1031 form.find('.geo_status_wrapper').remove();
1035 function getJSONgeocodeURL(geocodeURL, data) {
1036 SN.U.NoticeGeoStatus(form, 'Looking up place name...');
1037 $.getJSON(geocodeURL, data, function (location) {
1038 var lns, lid, NLN_text;
1040 if (location.location_ns !== undefined) {
1041 form.find('[name=location_ns]').val(location.location_ns);
1042 lns = location.location_ns;
1045 if (location.location_id !== undefined) {
1046 form.find('[name=location_id]').val(location.location_id);
1047 lid = location.location_id;
1050 if (location.name === undefined) {
1051 NLN_text = data.lat + ';' + data.lon;
1053 NLN_text = location.name;
1056 SN.U.NoticeGeoStatus(form, NLN_text, data.lat, data.lon, location.url);
1058 .attr('title', NoticeDataGeo_text.ShareDisable + ' (' + NLN_text + ')');
1060 form.find('[name=lat]').val(data.lat);
1061 form.find('[name=lon]').val(data.lon);
1062 form.find('[name=location_ns]').val(lns);
1063 form.find('[name=location_id]').val(lid);
1064 form.find('[name=notice_data-geo]').prop('checked', true);
1076 $.cookie(SN.C.S.NoticeDataGeoCookie, JSON.stringify(cookieValue), { path: '/' });
1080 if (check.length > 0) {
1081 if ($.cookie(SN.C.S.NoticeDataGeoCookie) == 'disabled') {
1082 check.prop('checked', false);
1084 check.prop('checked', true);
1087 var NGW = form.find('.notice_data-geo_wrap');
1088 var geocodeURL = NGW.attr('data-api');
1090 label.attr('title', label.text());
1092 check.change(function () {
1093 if (check.prop('checked') === true || $.cookie(SN.C.S.NoticeDataGeoCookie) === undefined) {
1095 .attr('title', NoticeDataGeo_text.ShareDisable)
1096 .addClass('checked');
1098 if ($.cookie(SN.C.S.NoticeDataGeoCookie) === undefined || $.cookie(SN.C.S.NoticeDataGeoCookie) == 'disabled') {
1099 if (navigator.geolocation) {
1100 SN.U.NoticeGeoStatus(form, 'Requesting location from browser...');
1101 navigator.geolocation.getCurrentPosition(
1102 function (position) {
1103 form.find('[name=lat]').val(position.coords.latitude);
1104 form.find('[name=lon]').val(position.coords.longitude);
1107 lat: position.coords.latitude,
1108 lon: position.coords.longitude,
1109 token: $('#token').val()
1112 getJSONgeocodeURL(geocodeURL, data);
1116 switch(error.code) {
1117 case error.PERMISSION_DENIED:
1118 removeNoticeDataGeo('Location permission denied.');
1121 //$('#' + SN.C.S.NoticeDataGeo).prop('checked', false);
1122 removeNoticeDataGeo('Location lookup timeout.');
1132 if (NLat.length > 0 && NLon.length > 0) {
1136 token: $('#token').val()
1139 getJSONgeocodeURL(geocodeURL, data);
1141 removeNoticeDataGeo();
1148 var cookieValue = JSON.parse($.cookie(SN.C.S.NoticeDataGeoCookie));
1150 form.find('[name=lat]').val(cookieValue.NLat);
1151 form.find('[name=lon]').val(cookieValue.NLon);
1152 form.find('[name=location_ns]').val(cookieValue.NLNS);
1153 form.find('[name=location_id]').val(cookieValue.NLID);
1154 form.find('[name=notice_data-geo]').prop('checked', cookieValue.NDG);
1156 SN.U.NoticeGeoStatus(form, cookieValue.NLN, cookieValue.NLat, cookieValue.NLon, cookieValue.NLNU);
1158 .attr('title', NoticeDataGeo_text.ShareDisable + ' (' + cookieValue.NLN + ')')
1159 .addClass('checked');
1161 console.log('Parsing error:', e);
1165 removeNoticeDataGeo();
1172 * Create or update a geolocation status widget in this notice posting form.
1174 * @param {jQuery} form
1175 * @param {String} status
1176 * @param {String} lat (optional)
1177 * @param {String} lon (optional)
1178 * @param {String} url (optional)
1180 NoticeGeoStatus: function (form, status, lat, lon, url)
1182 var wrapper = form.find('.geo_status_wrapper');
1183 if (wrapper.length == 0) {
1184 wrapper = $('<div class="' + SN.C.S.Success + ' geo_status_wrapper"><button class="close" style="float:right">×</button><div class="geo_status"></div></div>');
1185 wrapper.find('button.close').click(function () {
1186 form.find('[name=notice_data-geo]').prop('checked', false).change();
1189 form.append(wrapper);
1193 label = $('<a></a>').attr('href', url);
1195 label = $('<span></span>');
1199 var latlon = lat + ';' + lon;
1200 label.attr('title', latlon);
1205 wrapper.find('.geo_status').empty().append(label);
1209 * Setup function -- DOES NOT trigger actions immediately.
1211 * Initializes event handlers for the "Send direct message" link on
1212 * profile pages, setting it up to display a dialog box when clicked.
1214 * Unlike the repeat confirmation form, this appears to fetch
1215 * the form _from the original link target_, so the form itself
1216 * doesn't need to be in the current document.
1218 * @fixme breaks ability to open link in new window?
1220 NewDirectMessage: function () {
1221 NDM = $('.entity_send-a-message a');
1222 NDM.attr({'href': NDM.attr('href') + '&ajax=1'});
1223 NDM.on('click', function () {
1224 var NDMF = $('.entity_send-a-message form');
1225 if (NDMF.length === 0) {
1226 $(this).addClass(SN.C.S.Processing);
1227 $.get(NDM.attr('href'), null, function (data) {
1228 $('.entity_send-a-message').append(document._importNode($('form', data)[0], true));
1229 NDMF = $('.entity_send-a-message .form_notice');
1230 SN.U.FormNoticeXHR(NDMF);
1231 SN.U.FormNoticeEnhancements(NDMF);
1232 NDMF.append('<button class="close">×</button>');
1233 $('.entity_send-a-message button').click(function () {
1237 NDM.removeClass(SN.C.S.Processing);
1241 $('.entity_send-a-message textarea').focus();
1248 * Return a date object with the current local time on the
1249 * given year, month, and day.
1251 * @param {number} year: 4-digit year
1252 * @param {number} month: 0 == January
1253 * @param {number} day: 1 == 1
1256 GetFullYear: function (year, month, day) {
1257 var date = new Date();
1258 date.setFullYear(year, month, day);
1264 * Check if the current page is a timeline where the current user's
1265 * posts should be displayed immediately on success.
1267 * @fixme this should be done in a saner way, with machine-readable
1268 * info about what page we're looking at.
1270 * @param {DOMElement} notice: HTML chunk with formatted notice
1273 belongsOnTimeline: function (notice) {
1274 var action = $("body").attr('id');
1275 if (action == 'public') {
1279 var profileLink = $('#nav_profile a').attr('href');
1281 var authorUrl = $(notice).find('.h-card.p-author').attr('href');
1282 if (authorUrl == profileLink) {
1283 if (action == 'all' || action == 'showstream') {
1284 // Posts always show on your own friends and profile streams.
1290 // @fixme tag, group, reply timelines should be feasible as well.
1291 // Mismatch between id-based and name-based user/group links currently complicates
1292 // the lookup, since all our inline mentions contain the absolute links but the
1293 // UI links currently on the page use malleable names.
1299 * Switch to another active input sub-form.
1300 * This will hide the current form (if any), show the new one, and
1301 * update the input type tab selection state.
1303 * @param {String} tag
1305 switchInputFormTab: function (tag, setFocus) {
1306 if (typeof setFocus === 'undefined') { setFocus = true; }
1307 // The one that's current isn't current anymore
1308 $('.input_form_nav_tab.current').removeClass('current');
1310 $('#input_form_nav_' + tag).addClass('current');
1313 // Don't remove 'current' if we also have the "nonav" class.
1314 // An example would be the message input form. removing
1315 // 'current' will cause the form to vanish from the page.
1316 var nonav = $('.input_form.current.nonav');
1317 if (nonav.length > 0) {
1321 $('.input_form.current').removeClass('current');
1323 // we're done here, no new inputform to focus on
1327 var noticeForm = $('#input_form_' + tag)
1328 .addClass('current')
1329 .find('.ajax-notice').each(function () {
1331 SN.Init.NoticeFormSetup(form);
1334 noticeForm.find('.notice_data-text').focus();
1340 showMoreMenuItems: function (menuid) {
1341 $('#' + menuid + ' .more_link').remove();
1342 var selector = '#' + menuid + ' .extended_menu';
1343 var extended = $(selector);
1344 extended.removeClass('extended_menu');
1349 * Show a response feedback bit under a form.
1351 * @param {Element} form: the new-notice form usually
1352 * @param {String} cls: CSS class name to use ('error' or 'success')
1353 * @param {String} text
1356 showFeedback: function (form, cls, text) {
1358 $('<p class="form_response"></p>')
1364 addCallback: function (ename, callback) {
1365 // initialize to array if it's undefined
1366 if (typeof SN._callbacks[ename] === 'undefined') {
1367 SN._callbacks[ename] = [];
1369 SN._callbacks[ename].push(callback);
1372 runCallbacks: function (ename, data) {
1373 if (typeof SN._callbacks[ename] === 'undefined') {
1376 for (cbname in SN._callbacks[ename]) {
1377 SN._callbacks[ename][cbname](data);
1383 /* SN.E.ajaxNoticePosted, called when a notice has been posted successfully via an AJAX form
1384 @param form the originating form element
1385 @param data data from success() callback
1386 @param textStatus textStatus from success() callback
1388 ajaxNoticePosted: function (form, data, textStatus) {
1389 var commandResult = $('#' + SN.C.S.CommandResult, data);
1390 if (commandResult.length > 0) {
1391 SN.U.showFeedback(form, 'success', commandResult.text());
1393 // New notice post was successful. If on our timeline, show it!
1394 var notice = document._importNode($('li', data)[0], true);
1395 var notices = $('#notices_primary .notices:first');
1396 var replyItem = form.closest('li.notice-reply');
1398 if (replyItem.length > 0) {
1399 // If this is an inline reply, remove the form...
1400 var list = form.closest('.threaded-replies');
1402 var id = $(notice).attr('id');
1403 if ($('#' + id).length == 0) {
1404 $(notice).insertBefore(replyItem);
1405 } // else Realtime came through before us...
1409 } else if (notices.length > 0 && SN.U.belongsOnTimeline(notice)) {
1410 // Not a reply. If on our timeline, show it at the top!
1412 if ($('#' + notice.id).length === 0) {
1413 var notice_irt_value = form.find('[name=inreplyto]').val();
1414 var notice_irt = '#notices_primary #notice-' + notice_irt_value;
1415 if ($('body')[0].id == 'conversation') {
1416 if (notice_irt_value.length > 0 && $(notice_irt + ' .notices').length < 1) {
1417 $(notice_irt).append('<ul class="notices"></ul>');
1419 $($(notice_irt + ' .notices')[0]).append(notice);
1421 notices.prepend(notice);
1424 .css({display: 'none'})
1426 SN.U.NoticeWithAttachment($('#' + notice.id));
1427 SN.U.switchInputFormTab(null);
1430 // Not on a timeline that this belongs on?
1431 // Just show a success message.
1433 SN.U.showFeedback(form, 'success', $('title', data).text());
1437 form.find('[name=inreplyto]').val('');
1438 form.find('.attach-status').remove();
1439 SN.U.FormNoticeEnhancements(form);
1441 SN.U.runCallbacks('notice_posted', {"notice": notice});
1448 * If user is logged in, run setup code for the new notice form:
1453 * - file upload events
1455 NoticeForm: function () {
1456 if ($('body.user_in').length > 0) {
1457 // SN.Init.NoticeFormSetup() will get run
1458 // when forms get displayed for the first time...
1460 // Initialize the input form field
1461 $('#input_form_nav .input_form_nav_tab.current').each(function () {
1462 current_tab_id = $(this).attr('id').substring('input_form_nav_'.length);
1463 SN.U.switchInputFormTab(current_tab_id, false);
1466 // Make inline reply forms self-close when clicking out.
1467 $('body').on('click', function (e) {
1468 var openReplies = $('li.notice-reply');
1469 if (openReplies.length > 0) {
1470 var target = $(e.target);
1471 openReplies.each(function () {
1472 // Did we click outside this one?
1473 var replyItem = $(this);
1474 if (replyItem.has(e.target).length == 0) {
1475 var textarea = replyItem.find('.notice_data-text:first');
1476 var cur = $.trim(textarea.val());
1477 // Only close if there's been no edit.
1478 if (cur == '' || cur == textarea.data('initialText')) {
1479 var parentNotice = replyItem.closest('li.notice');
1481 parentNotice.find('li.notice-reply-placeholder').show();
1491 * Encapsulate notice form setup for a single form.
1492 * Plugins can add extra setup by monkeypatching this
1495 * @param {jQuery} form
1497 NoticeFormSetup: function (form) {
1498 if (form.data('NoticeFormSetup')) {
1501 SN.U.NoticeLocationAttach(form);
1502 SN.U.FormNoticeUniqueID(form);
1503 SN.U.FormNoticeXHR(form);
1504 SN.U.FormNoticeEnhancements(form);
1505 SN.U.NoticeDataAttach(form);
1506 form.data('NoticeFormSetup', true);
1510 * Run setup code for notice timeline views items:
1512 * - AJAX submission for fave/repeat/reply (if logged in)
1513 * - Attachment link extras ('more' links)
1515 Notices: function () {
1516 if ($('body.user_in').length > 0) {
1517 SN.U.NoticeRepeat();
1519 SN.U.NoticeInlineReplySetup();
1520 SN.U.NoticeOptionsAjax();
1523 SN.U.NoticeAttachments();
1527 * Run setup code for user & group profile page header area if logged in:
1529 * - AJAX submission for sub/unsub/join/leave/nudge
1530 * - AJAX form popup for direct-message
1532 EntityActions: function () {
1533 if ($('body.user_in').length > 0) {
1534 $(document).on('click', '.form_user_subscribe', function () { SN.U.FormXHR($(this)); return false; });
1535 $(document).on('click', '.form_user_unsubscribe', function () { SN.U.FormXHR($(this)); return false; });
1536 $(document).on('click', '.form_group_join', function () { SN.U.FormXHR($(this)); return false; });
1537 $(document).on('click', '.form_group_leave', function () { SN.U.FormXHR($(this)); return false; });
1538 $(document).on('click', '.form_user_nudge', function () { SN.U.FormXHR($(this)); return false; });
1539 $(document).on('click', '.form_peopletag_subscribe', function () { SN.U.FormXHR($(this)); return false; });
1540 $(document).on('click', '.form_peopletag_unsubscribe', function () { SN.U.FormXHR($(this)); return false; });
1541 $(document).on('click', '.form_user_add_peopletag', function () { SN.U.FormXHR($(this)); return false; });
1542 $(document).on('click', '.form_user_remove_peopletag', function () { SN.U.FormXHR($(this)); return false; });
1544 SN.U.NewDirectMessage();
1548 ProfileSearch: function () {
1549 if ($('body.user_in').length > 0) {
1550 $(document).on('click', '.form_peopletag_edit_user_search input.submit', function () {
1551 SN.U.FormProfileSearchXHR($(this).parents('form')); return false;
1557 * Run setup for the ajax people tags editor
1559 * - show edit button
1560 * - set event handle for click on edit button
1561 * - loads people tag autocompletion data if not already present
1562 * or if it is stale.
1565 PeopleTags: function () {
1566 $('.user_profile_tags .editable').append($('<button class="peopletags_edit_button"/>'));
1568 $(document).on('click', '.peopletags_edit_button', function () {
1569 var form = $(this).parents('dd').eq(0).find('form');
1570 // We can buy time from the above animation
1575 data: {token: $('#token').val()},
1577 success: function (data) {
1578 // item.label is used to match
1579 for (i=0; i < data.length; i++) {
1580 data[i].label = data[i].tag;
1583 SN.C.PtagACData = data;
1587 $(this).parents('ul').eq(0).fadeOut(200, function () {form.fadeIn(200).find('input#tags')});
1590 $(document).on('click', '.user_profile_tags form .submit', function () {
1591 SN.U.FormPeopletagsXHR($(this).parents('form')); return false;
1596 * Set up any generic 'ajax' form so it submits via AJAX with auto-replacement.
1598 AjaxForms: function () {
1599 $(document).on('submit', 'form.ajax', function () {
1600 SN.U.FormXHR($(this));
1603 $(document).on('click', 'form.ajax input[type=submit]', function () {
1604 // Some forms rely on knowing which submit button was clicked.
1605 // Save a hidden input field which'll be picked up during AJAX
1607 var button = $(this);
1608 var form = button.closest('form');
1609 form.find('.hidden-submit-button').remove();
1610 $('<input class="hidden-submit-button" type="hidden" />')
1611 .attr('name', button.attr('name'))
1618 * Add logic to any file upload forms to handle file size limits,
1619 * on browsers that support basic FileAPI.
1621 UploadForms: function () {
1622 $('input[type=file]').change(function (event) {
1623 if (typeof this.files === "object" && this.files.length > 0) {
1625 for (var i = 0; i < this.files.length; i++) {
1626 size += this.files[i].size;
1629 var max = SN.U.maxFileSize($(this.form));
1630 if (max > 0 && size > max) {
1631 var msg = 'File too large: maximum upload size is %d bytes.';
1632 alert(msg.replace('%d', max));
1636 event.preventDefault();
1643 CheckBoxes: function () {
1644 $("span[class='checkbox-wrapper']").addClass("unchecked");
1645 $(".checkbox-wrapper").click(function () {
1646 if ($(this).children("input").prop("checked")) {
1648 $(this).children("input").prop("checked", false);
1649 $(this).removeClass("checked");
1650 $(this).addClass("unchecked");
1651 $(this).children("label").text("Private?");
1654 $(this).children("input").prop("checked", true);
1655 $(this).removeClass("unchecked");
1656 $(this).addClass("checked");
1657 $(this).children("label").text("Private");
1665 * Run initialization functions on DOM-ready.
1667 * Note that if we're waiting on other scripts to load, this won't happen
1668 * until that's done. To load scripts asynchronously without delaying setup,
1669 * don't start them loading until after DOM-ready time!
1672 SN.Init.AjaxForms();
1673 SN.Init.UploadForms();
1674 SN.Init.CheckBoxes();
1675 if ($('.' + SN.C.S.FormNotice).length > 0) {
1676 SN.Init.NoticeForm();
1678 if ($('#content .notices').length > 0) {
1681 if ($('#content .entity_actions').length > 0) {
1682 SN.Init.EntityActions();
1684 if ($('#profile_search_results').length > 0) {
1685 SN.Init.ProfileSearch();
1687 if ($('.user_profile_tags .editable').length > 0) {
1688 SN.Init.PeopleTags();