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',
63 * list of callbacks, categorized into _callbacks['event_name'] = [ callback_function_1, callback_function_2 ]
70 * Map of localized message strings exported to script from the PHP
71 * side via Action::getScriptMessages().
73 * Retrieve them via SN.msg(); this array is an implementation detail.
80 * Grabs a localized string that's been previously exported to us
81 * from server-side code via Action::getScriptMessages().
83 * @example alert(SN.msg('coolplugin-failed'));
85 * @param {String} key: string key name to pull from message index
86 * @return matching localized message string
89 if (SN.messages[key] === undefined) {
90 return '[' + key + ']';
92 return SN.messages[key];
97 * Setup function -- DOES NOT trigger actions immediately.
99 * Sets up event handlers on the new notice form.
101 * @param {jQuery} form: jQuery object whose first matching element is the form
104 FormNoticeEnhancements: function (form) {
105 if ($.data(form[0], 'ElementData') === undefined) {
106 var MaxLength = form.find('.count').text();
107 if (MaxLength === undefined) {
108 MaxLength = SN.C.I.MaxLength;
110 $.data(form[0], 'ElementData', {MaxLength: MaxLength});
114 var NDT = form.find('.notice_data-text:first');
116 NDT.on('keyup', function (e) {
120 var delayedUpdate = function (e) {
121 // Cut and paste events fire *before* the operation,
122 // so we need to trigger an update in a little bit.
123 // This would be so much easier if the 'change' event
124 // actually fired every time the value changed. :P
125 window.setTimeout(function () {
129 // Note there's still no event for mouse-triggered 'delete'.
130 NDT.on('cut', delayedUpdate)
131 .on('paste', delayedUpdate);
133 form.find('.count').text($.data(form[0], 'ElementData').MaxLength);
138 * To be called from event handlers on the notice import form.
139 * Triggers an update of the remaining-characters counter.
141 * Additional counter updates will be suppressed during the
142 * next half-second to avoid flooding the layout engine with
143 * updates, followed by another automatic check.
145 * The maximum length is pulled from data established by
146 * FormNoticeEnhancements.
148 * @param {jQuery} form: jQuery object whose first element is the notice posting form
151 Counter: function (form) {
152 SN.C.I.FormNoticeCurrent = form;
154 var MaxLength = $.data(form[0], 'ElementData').MaxLength;
156 if (MaxLength <= 0) {
160 var remaining = MaxLength - SN.U.CharacterCount(form);
161 var counter = form.find('.count');
163 if (remaining.toString() != counter.text()) {
164 if (!SN.C.I.CounterBlackout || remaining === 0) {
165 if (counter.text() != String(remaining)) {
166 counter.text(remaining);
169 form.addClass(SN.C.S.Warning);
171 form.removeClass(SN.C.S.Warning);
173 // Skip updates for the next 500ms.
174 // On slower hardware, updating on every keypress is unpleasant.
175 if (!SN.C.I.CounterBlackout) {
176 SN.C.I.CounterBlackout = true;
177 SN.C.I.FormNoticeCurrent = form;
178 window.setTimeout("SN.U.ClearCounterBlackout(SN.C.I.FormNoticeCurrent);", 500);
185 * Pull the count of characters in the current edit field.
186 * Plugins replacing the edit control may need to override this.
188 * @param {jQuery} form: jQuery object whose first element is the notice posting form
189 * @return number of chars
191 CharacterCount: function (form) {
192 return form.find('.notice_data-text:first').val().length;
196 * Called internally after the counter update blackout period expires;
197 * runs another update to make sure we didn't miss anything.
199 * @param {jQuery} form: jQuery object whose first element is the notice posting form
202 ClearCounterBlackout: function (form) {
203 // Allow keyup events to poke the counter again
204 SN.C.I.CounterBlackout = false;
205 // Check if the string changed since we last looked
210 * Helper function to rewrite default HTTP form action URLs to HTTPS
211 * so we can actually fetch them when on an SSL page in ssl=sometimes
214 * It would be better to output URLs that didn't hardcode protocol
215 * and hostname in the first place...
217 * @param {String} url
220 RewriteAjaxAction: function (url) {
221 // Quick hack: rewrite AJAX submits to HTTPS if they'd fail otherwise.
222 if (document.location.protocol === 'https:' && url.substr(0, 5) === 'http:') {
223 return url.replace(/^http:\/\/[^:\/]+/, 'https://' + document.location.host);
228 FormNoticeUniqueID: function (form) {
229 var oldId = form.attr('id');
230 var newId = 'form_notice_' + Math.floor(Math.random()*999999999);
231 var attrs = ['name', 'for', 'id'];
232 for (var key in attrs) {
233 if (form.attr(attrs[key]) === undefined) {
236 form.attr(attrs[key], form.attr(attrs[key]).replace(oldId, newId));
238 for (var key in attrs) {
239 form.find("[" + attrs[key] + "*='" + oldId + "']").each(function () {
240 if ($(this).attr(attrs[key]) === undefined) {
241 return; // since we're inside the each(function () { ... });
243 var newAttr = $(this).attr(attrs[key]).replace(oldId, newId);
244 $(this).attr(attrs[key], newAttr);
250 * Grabs form data and submits it asynchronously, with 'ajax=1'
251 * parameter added to the rest.
253 * If a successful response includes another form, that form
254 * will be extracted and copied in, replacing the original form.
255 * If there's no form, the first paragraph will be used.
257 * This will automatically be applied on the 'submit' event for
258 * any form with the 'ajax' class.
260 * @fixme can sometimes explode confusingly if returnd data is bogus
261 * @fixme error handling is pretty vague
262 * @fixme can't submit file uploads
264 * @param {jQuery} form: jQuery object whose first element is a form
265 * @param function onSuccess: something extra to do on success
269 FormXHR: function (form, onSuccess) {
273 url: SN.U.RewriteAjaxAction(form.attr('action')),
274 data: form.serialize() + '&ajax=1',
275 beforeSend: function (xhr) {
277 .addClass(SN.C.S.Processing)
279 .addClass(SN.C.S.Disabled)
280 .prop(SN.C.S.Disabled, true);
282 error: function (xhr, textStatus, errorThrown) {
283 // If the server end reported an error from StatusNet,
284 // find it -- otherwise we'll see what was reported
286 var errorReported = null;
287 if (xhr.responseXML) {
288 errorReported = $('#error', xhr.responseXML).text();
290 window.alert(errorReported || errorThrown || textStatus);
292 // Restore the form to original state.
295 .removeClass(SN.C.S.Processing)
297 .removeClass(SN.C.S.Disabled)
298 .prop(SN.C.S.Disabled, false);
300 success: function (data, textStatus) {
301 if ($('form', data)[0] !== undefined) {
302 var form_new = document._importNode($('form', data)[0], true);
303 form.replaceWith(form_new);
307 } else if ($('p', data)[0] !== undefined) {
308 form.replaceWith(document._importNode($('p', data)[0], true));
313 window.alert('Unknown error.');
320 * Setup function -- DOES NOT trigger actions immediately.
322 * Sets up event handlers for special-cased async submission of the
323 * notice-posting form, including some pre-post validation.
325 * Unlike FormXHR() this does NOT submit the form immediately!
326 * It sets up event handlers so that any method of submitting the
327 * form (click on submit button, enter, submit() etc) will trigger
330 * Also unlike FormXHR(), this system will use a hidden iframe
331 * automatically to handle file uploads via <input type="file">
335 * @fixme vast swaths of duplicate code and really long variable names clutter this function up real bad
336 * @fixme error handling is unreliable
337 * @fixme cookieValue is a global variable, but probably shouldn't be
338 * @fixme saving the location cache cookies should be split out
339 * @fixme some error messages are hardcoded english: needs i18n
341 * @param {jQuery} form: jQuery object whose first element is a form
345 FormNoticeXHR: function (form) {
346 SN.C.I.NoticeDataGeo = {};
347 form.append('<input type="hidden" name="ajax" value="1"/>');
349 // Make sure we don't have a mixed HTTP/HTTPS submission...
350 form.attr('action', SN.U.RewriteAjaxAction(form.attr('action')));
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 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.');
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 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.');
404 success: function (data, textStatus) {
406 var errorResult = $('#' + SN.C.S.Error, data);
407 if (errorResult.length > 0) {
408 SN.U.showFeedback(form, 'error', errorResult.text());
410 SN.E.ajaxNoticePosted(form, data, textStatus);
413 complete: function (xhr, textStatus) {
415 .removeClass(SN.C.S.Processing)
417 .prop(SN.C.S.Disabled, false)
418 .removeClass(SN.C.S.Disabled);
420 form.find('[name=lat]').val(SN.C.I.NoticeDataGeo.NLat);
421 form.find('[name=lon]').val(SN.C.I.NoticeDataGeo.NLon);
422 form.find('[name=location_ns]').val(SN.C.I.NoticeDataGeo.NLNS);
423 form.find('[name=location_id]').val(SN.C.I.NoticeDataGeo.NLID);
424 form.find('[name=notice_data-geo]').prop('checked', SN.C.I.NoticeDataGeo.NDG);
429 FormProfileSearchXHR: function (form) {
433 url: form.attr('action'),
434 data: form.serialize() + '&ajax=1',
435 beforeSend: function (xhr) {
437 .addClass(SN.C.S.Processing)
439 .addClass(SN.C.S.Disabled)
440 .prop(SN.C.S.Disabled, true);
442 error: function (xhr, textStatus, errorThrown) {
443 window.alert(errorThrown || textStatus);
445 success: function (data, textStatus) {
446 var results_placeholder = $('#profile_search_results');
447 if ($('ul', data)[0] !== undefined) {
448 var list = document._importNode($('ul', data)[0], true);
449 results_placeholder.replaceWith(list);
451 var _error = $('<li/>').append(document._importNode($('p', data)[0], true));
452 results_placeholder.html(_error);
455 .removeClass(SN.C.S.Processing)
457 .removeClass(SN.C.S.Disabled)
458 .prop(SN.C.S.Disabled, false);
463 FormPeopletagsXHR: function (form) {
467 url: form.attr('action'),
468 data: form.serialize() + '&ajax=1',
469 beforeSend: function (xhr) {
471 .addClass(SN.C.S.Processing)
472 .addClass(SN.C.S.Disabled)
473 .prop(SN.C.S.Disabled, true);
475 error: function (xhr, textStatus, errorThrown) {
476 window.alert(errorThrown || textStatus);
478 success: function (data, textStatus) {
479 var results_placeholder = form.parents('.entity_tags');
480 if ($('.entity_tags', data)[0] !== undefined) {
481 var tags = document._importNode($('.entity_tags', data)[0], true);
482 $(tags).find('.editable').append($('<button class="peopletags_edit_button"/>'));
483 results_placeholder.replaceWith(tags);
485 results_placeholder.find('p').remove();
486 results_placeholder.append(document._importNode($('p', data)[0], true));
487 form.removeClass(SN.C.S.Processing)
489 .removeClass(SN.C.S.Disabled)
490 .prop(SN.C.S.Disabled, false);
496 normalizeGeoData: function (form) {
497 SN.C.I.NoticeDataGeo.NLat = form.find('[name=lat]').val();
498 SN.C.I.NoticeDataGeo.NLon = form.find('[name=lon]').val();
499 SN.C.I.NoticeDataGeo.NLNS = form.find('[name=location_ns]').val();
500 SN.C.I.NoticeDataGeo.NLID = form.find('[name=location_id]').val();
501 SN.C.I.NoticeDataGeo.NDG = form.find('[name=notice_data-geo]').prop('checked'); // @fixme (does this still need to be fixed somehow?)
503 var cookieValue = $.cookie(SN.C.S.NoticeDataGeoCookie);
505 if (cookieValue !== undefined && cookieValue != 'disabled') {
506 cookieValue = JSON.parse(cookieValue);
507 SN.C.I.NoticeDataGeo.NLat = form.find('[name=lat]').val(cookieValue.NLat).val();
508 SN.C.I.NoticeDataGeo.NLon = form.find('[name=lon]').val(cookieValue.NLon).val();
509 if (cookieValue.NLNS) {
510 SN.C.I.NoticeDataGeo.NLNS = form.find('[name=location_ns]').val(cookieValue.NLNS).val();
511 SN.C.I.NoticeDataGeo.NLID = form.find('[name=location_id]').val(cookieValue.NLID).val();
513 form.find('[name=location_ns]').val('');
514 form.find('[name=location_id]').val('');
517 if (cookieValue == 'disabled') {
518 SN.C.I.NoticeDataGeo.NDG = form.find('[name=notice_data-geo]').prop('checked', false).prop('checked');
520 SN.C.I.NoticeDataGeo.NDG = form.find('[name=notice_data-geo]').prop('checked', true).prop('checked');
526 * Fetch an XML DOM from an XHR's response data.
528 * Works around unavailable responseXML when document.domain
529 * has been modified by Meteor or other tools, in some but not
532 * @param {XMLHTTPRequest} xhr
533 * @return DOMDocument
535 GetResponseXML: function (xhr) {
537 return xhr.responseXML;
539 return (new DOMParser()).parseFromString(xhr.responseText, "text/xml");
544 * Setup function -- DOES NOT trigger actions immediately.
546 * Sets up event handlers on all visible notice's option <a> elements
547 * with the "popup" class so they behave as expected with AJAX.
549 * (without javascript the link goes to a page that expects you to verify
550 * the action through a form)
554 NoticeOptionsAjax: function () {
555 $(document).on('click', '.notice-options > a.popup', function (e) {
557 var noticeEl = $(this).closest('.notice');
559 url: $(this).attr('href'),
561 success: function (data, textStatus, xhr) {
562 SN.U.NoticeOptionPopup(data, noticeEl);
569 NoticeOptionPopup: function (data, noticeEl) {
570 title = $('head > title', data).text();
571 body = $('body', data).html();
572 dialog = $(body).dialog({
582 * Setup function -- DOES NOT trigger actions immediately.
584 * Sets up event handlers on all visible notice's reply buttons to
585 * tweak the new-notice form with needed variables and focus it
588 * (This replaces the default reply button behavior to submit
589 * directly to a form which comes back with a specialized page
590 * with the form data prefilled.)
594 NoticeReply: function () {
595 $(document).on('click', '#content .notice_reply', function (e) {
597 var notice = $(this).closest('li.notice');
598 SN.U.NoticeInlineReplyTrigger(notice);
604 * Stub -- kept for compat with plugins for now.
607 NoticeReplyTo: function (notice) {
611 * Open up a notice's inline reply box.
613 * @param {jQuery} notice: jQuery object containing one notice
614 * @param {String} initialText
616 NoticeInlineReplyTrigger: function (notice, initialText) {
617 // Find the notice we're replying to...
618 var id = $($('.notice_id', notice)[0]).text();
620 var parentNotice = notice;
621 var stripForm = true; // strip a couple things out of reply forms that are inline
623 var list = notice.find('.threaded-replies');
624 if (list.length == 0) {
625 list = notice.closest('.threaded-replies');
627 if (list.length == 0) {
628 list = $('<ul class="notices threaded-replies xoxo"></ul>');
630 list = notice.find('.threaded-replies');
633 var nextStep = function () {
635 replyForm.find('input[name=inreplyto]').val(id);
637 // Don't do this for old-school reply form, as they don't come back!
638 replyForm.find('#notice_to').prop('disabled', true).hide();
639 replyForm.find('#notice_private').prop('disabled', true).hide();
640 replyForm.find('label[for=notice_to]').hide();
641 replyForm.find('label[for=notice_private]').hide();
646 var text = replyForm.find('textarea');
647 if (text.length == 0) {
652 replyto = initialText + ' ';
654 text.val(replyto + text.val().replace(new RegExp(replyto, 'i'), ''));
655 text.data('initialText', $.trim(initialText));
657 if (text[0].setSelectionRange) {
658 var len = text.val().length;
659 text[0].setSelectionRange(len, len);
663 // Create the reply form entry
664 var replyItem = $('li.notice-reply', list);
665 if (replyItem.length == 0) {
666 replyItem = $('<li class="notice-reply"></li>');
668 replyForm = replyItem.children('form');
669 if (replyForm.length == 0) {
670 // Let's try another trick to avoid fetching by URL
671 var noticeForm = $('#input_form_status > form');
672 if (noticeForm.length == 0) {
673 // No notice form found on the page, so let's just
674 // fetch a fresh copy of the notice form over AJAX.
676 url: SN.V.urlNewNotice,
677 data: {ajax: 1, inreplyto: id},
678 success: function (data, textStatus, xhr) {
679 var formEl = document._importNode($('form', data)[0], true);
680 replyForm = $(formEl);
681 replyItem.append(replyForm);
682 list.append(replyItem);
684 SN.Init.NoticeFormSetup(replyForm);
688 // We do everything relevant in 'success' above
691 replyForm = noticeForm.clone();
692 SN.Init.NoticeFormSetup(replyForm);
693 replyItem.append(replyForm);
694 list.append(replyItem);
696 // replyForm is set, we're not fetching by URL...
697 // Next setp is to configure in-reply-to etc.
702 * Setup function -- DOES NOT apply immediately.
704 * Uses 'on' rather than 'live' or 'bind', so applies to future as well as present items.
706 NoticeInlineReplySetup: function () {
707 // Expand conversation links
708 $(document).on('click', 'li.notice-reply-comments a', function () {
709 var url = $(this).attr('href');
710 var area = $(this).closest('.threaded-replies');
714 success: function (data, textStatus, xhr) {
715 var replies = $('.threaded-replies', data);
716 if (replies.length) {
717 area.replaceWith(document._importNode(replies[0], true));
726 * Setup function -- DOES NOT trigger actions immediately.
728 * Sets up event handlers for repeat forms to toss up a confirmation
729 * popout before submitting.
731 * Uses 'on' rather than 'live' or 'bind', so applies to future as well as present items.
734 NoticeRepeat: function () {
735 $('body').on('click', '.form_repeat', function (e) {
738 SN.U.NoticeRepeatConfirmation($(this));
744 * Shows a confirmation dialog box variant of the repeat button form.
745 * This seems to use a technique where the repeat form contains
746 * _both_ a standalone button _and_ text and buttons for a dialog.
747 * The dialog will close after its copy of the form is submitted,
748 * or if you click its 'close' button.
750 * The dialog is created by duplicating the original form and changing
751 * its style; while clever, this is hard to generalize and probably
752 * duplicates a lot of unnecessary HTML output.
754 * @fixme create confirmation dialogs through a generalized interface
755 * that can be reused instead of hardcoded text and styles.
757 * @param {jQuery} form
759 NoticeRepeatConfirmation: function (form) {
760 var submit_i = form.find('.submit');
762 var submit = submit_i.clone();
764 .addClass('submit_dialogbox')
765 .removeClass('submit');
767 submit.on('click', function () { SN.U.FormXHR(form); return false; });
772 .addClass('dialogbox')
773 .append('<button class="close" title="' + SN.msg('popup_close_button') + '">×</button>')
774 .closest('.notice-options')
777 form.find('button.close').click(function () {
781 .removeClass('dialogbox')
782 .closest('.notice-options')
783 .removeClass('opaque');
785 form.find('.submit_dialogbox').remove();
786 form.find('.submit').show();
793 * Setup function -- DOES NOT trigger actions immediately.
795 * Goes through all notices currently displayed and sets up attachment
796 * handling if needed.
798 NoticeAttachments: function () {
799 $('.notice a.attachment').each(function () {
800 SN.U.NoticeWithAttachment($(this).closest('.notice'));
805 * Setup function -- DOES NOT trigger actions immediately.
807 * Sets up special attachment link handling if needed. Currently this
808 * consists only of making the "more" button used for OStatus message
809 * cropping turn into an auto-expansion button that loads the full
810 * text from an attachment file.
812 * @param {jQuery} notice
814 NoticeWithAttachment: function (notice) {
815 if (notice.find('.attachment').length === 0) {
819 $(document).on('click','.attachment.more',function () {
821 m.addClass(SN.C.S.Processing);
822 $.get(m.attr('href'), {ajax: 1}, function (data) {
823 m.parent('.e-content').html($(data).find('#attachment_view .e-content').html());
832 * Setup function -- DOES NOT trigger actions immediately.
834 * Sets up event handlers for the file-attachment widget in the
835 * new notice form. When a file is selected, a box will be added
836 * below the text input showing the filename and, if supported
837 * by the browser, a thumbnail preview.
839 * This preview box will also allow removing the attachment
842 * @param {jQuery} form
844 NoticeDataAttach: function (form) {
846 var NDA = form.find('input[type=file]');
847 NDA.change(function (event) {
848 form.find('.attach-status').remove();
850 var filename = $(this).val();
852 // No file -- we've been tricked!
856 var attachStatus = $('<div class="attach-status ' + SN.C.S.Success + '"><code></code> <button class="close">×</button></div>');
857 attachStatus.find('code').text(filename);
858 attachStatus.find('button').click(function () {
859 attachStatus.remove();
864 form.append(attachStatus);
866 if (typeof this.files === "object") {
867 // Some newer browsers will let us fetch the files for preview.
868 for (i = 0; i < this.files.length; i++) {
869 SN.U.PreviewAttach(form, this.files[i]);
876 * Get PHP's MAX_FILE_SIZE setting for this form;
877 * used to apply client-side file size limit checks.
879 * @param {jQuery} form
880 * @return int max size in bytes; 0 or negative means no limit
882 maxFileSize: function (form) {
883 var max = $(form).find('input[name=MAX_FILE_SIZE]').attr('value');
885 return parseInt(max);
891 * For browsers with FileAPI support: make a thumbnail if possible,
892 * and append it into the attachment display widget.
895 * - Firefox 3.6.6, 4.0b7
896 * - Chrome 8.0.552.210
898 * Known ok metadata, can't get contents:
902 * - Opera 10.63, 11 beta (no input.files interface)
904 * @param {jQuery} form
907 * @todo use configured thumbnail size
908 * @todo detect pixel size?
909 * @todo should we render a thumbnail to a canvas and then use the smaller image?
911 PreviewAttach: function (form, file) {
912 var tooltip = file.type + ' ' + Math.round(file.size / 1024) + 'KB';
916 if (window.createObjectURL !== undefined) {
918 * createObjectURL lets us reference the file directly from an <img>
919 * This produces a compact URL with an opaque reference to the file,
920 * which we can reference immediately.
922 * - Firefox 3.6.6: no
923 * - Firefox 4.0b7: no
925 * - Chrome 8.0.552.210: works!
927 blobAsDataURL = function (blob, callback) {
928 callback(window.createObjectURL(blob));
930 } else if (window.FileReader !== undefined) {
932 * FileAPI's FileReader can build a data URL from a blob's contents,
933 * but it must read the file and build it asynchronously. This means
934 * we'll be passing a giant data URL around, which may be inefficient.
936 * - Firefox 3.6.6: works!
937 * - Firefox 4.0b7: works!
939 * - Chrome 8.0.552.210: works!
941 blobAsDataURL = function (blob, callback) {
942 var reader = new FileReader();
943 reader.onload = function (event) {
944 callback(reader.result);
946 reader.readAsDataURL(blob);
952 var imageTypes = ['image/png', 'image/jpeg', 'image/gif', 'image/svg+xml'];
953 if ($.inArray(file.type, imageTypes) == -1) {
954 // We probably don't know how to show the file.
958 var maxSize = 8 * 1024 * 1024;
959 if (file.size > maxSize) {
960 // Don't kill the browser trying to load some giant image.
965 blobAsDataURL(file, function (url) {
967 .attr('title', tooltip)
968 .attr('alt', tooltip)
970 .attr('style', 'height: 120px');
971 form.find('.attach-status').append(img);
974 var img = $('<div></div>').text(tooltip);
975 form.find('.attach-status').append(img);
980 * Setup function -- DOES NOT trigger actions immediately.
982 * Initializes state for the location-lookup features in the
983 * new-notice form. Seems to set up some event handlers for
984 * triggering lookups and using the new values.
986 * @param {jQuery} form
989 * @fixme there's not good visual state update here, so users have a
990 * hard time figuring out if it's working or fixing if it's wrong.
993 NoticeLocationAttach: function (form) {
994 // @fixme this should not be tied to the main notice form, as there may be multiple notice forms...
995 var NLat = form.find('[name=lat]');
996 var NLon = form.find('[name=lon]');
997 var NLNS = form.find('[name=location_ns]').val();
998 var NLID = form.find('[name=location_id]').val();
999 var NLN = ''; // @fixme
1000 var NDGe = form.find('[name=notice_data-geo]');
1001 var check = form.find('[name=notice_data-geo]');
1002 var label = form.find('label.notice_data-geo');
1004 function removeNoticeDataGeo(error) {
1006 .attr('title', $.trim(label.text()))
1007 .removeClass('checked');
1009 form.find('[name=lat]').val('');
1010 form.find('[name=lon]').val('');
1011 form.find('[name=location_ns]').val('');
1012 form.find('[name=location_id]').val('');
1013 form.find('[name=notice_data-geo]').prop('checked', false);
1015 $.cookie(SN.C.S.NoticeDataGeoCookie, 'disabled', { path: '/' });
1018 form.find('.geo_status_wrapper').removeClass('success').addClass('error');
1019 form.find('.geo_status_wrapper .geo_status').text(error);
1021 form.find('.geo_status_wrapper').remove();
1025 function getJSONgeocodeURL(geocodeURL, data) {
1026 SN.U.NoticeGeoStatus(form, 'Looking up place name...');
1027 $.getJSON(geocodeURL, data, function (location) {
1028 var lns, lid, NLN_text;
1030 if (location.location_ns !== undefined) {
1031 form.find('[name=location_ns]').val(location.location_ns);
1032 lns = location.location_ns;
1035 if (location.location_id !== undefined) {
1036 form.find('[name=location_id]').val(location.location_id);
1037 lid = location.location_id;
1040 if (location.name === undefined) {
1041 NLN_text = data.lat + ';' + data.lon;
1043 NLN_text = location.name;
1046 SN.U.NoticeGeoStatus(form, NLN_text, data.lat, data.lon, location.url);
1048 .attr('title', NoticeDataGeo_text.ShareDisable + ' (' + NLN_text + ')');
1050 form.find('[name=lat]').val(data.lat);
1051 form.find('[name=lon]').val(data.lon);
1052 form.find('[name=location_ns]').val(lns);
1053 form.find('[name=location_id]').val(lid);
1054 form.find('[name=notice_data-geo]').prop('checked', true);
1066 $.cookie(SN.C.S.NoticeDataGeoCookie, JSON.stringify(cookieValue), { path: '/' });
1070 if (check.length > 0) {
1071 if ($.cookie(SN.C.S.NoticeDataGeoCookie) == 'disabled') {
1072 check.prop('checked', false);
1074 check.prop('checked', true);
1077 var NGW = form.find('.notice_data-geo_wrap');
1078 var geocodeURL = NGW.attr('data-api');
1080 label.attr('title', label.text());
1082 check.change(function () {
1083 if (check.prop('checked') === true || $.cookie(SN.C.S.NoticeDataGeoCookie) === undefined) {
1085 .attr('title', NoticeDataGeo_text.ShareDisable)
1086 .addClass('checked');
1088 if ($.cookie(SN.C.S.NoticeDataGeoCookie) === undefined || $.cookie(SN.C.S.NoticeDataGeoCookie) == 'disabled') {
1089 if (navigator.geolocation) {
1090 SN.U.NoticeGeoStatus(form, 'Requesting location from browser...');
1091 navigator.geolocation.getCurrentPosition(
1092 function (position) {
1093 form.find('[name=lat]').val(position.coords.latitude);
1094 form.find('[name=lon]').val(position.coords.longitude);
1097 lat: position.coords.latitude,
1098 lon: position.coords.longitude,
1099 token: $('#token').val()
1102 getJSONgeocodeURL(geocodeURL, data);
1106 switch(error.code) {
1107 case error.PERMISSION_DENIED:
1108 removeNoticeDataGeo('Location permission denied.');
1111 //$('#' + SN.C.S.NoticeDataGeo).prop('checked', false);
1112 removeNoticeDataGeo('Location lookup timeout.');
1122 if (NLat.length > 0 && NLon.length > 0) {
1126 token: $('#token').val()
1129 getJSONgeocodeURL(geocodeURL, data);
1131 removeNoticeDataGeo();
1138 var cookieValue = JSON.parse($.cookie(SN.C.S.NoticeDataGeoCookie));
1140 form.find('[name=lat]').val(cookieValue.NLat);
1141 form.find('[name=lon]').val(cookieValue.NLon);
1142 form.find('[name=location_ns]').val(cookieValue.NLNS);
1143 form.find('[name=location_id]').val(cookieValue.NLID);
1144 form.find('[name=notice_data-geo]').prop('checked', cookieValue.NDG);
1146 SN.U.NoticeGeoStatus(form, cookieValue.NLN, cookieValue.NLat, cookieValue.NLon, cookieValue.NLNU);
1148 .attr('title', NoticeDataGeo_text.ShareDisable + ' (' + cookieValue.NLN + ')')
1149 .addClass('checked');
1151 console.log('Parsing error:', e);
1155 removeNoticeDataGeo();
1162 * Create or update a geolocation status widget in this notice posting form.
1164 * @param {jQuery} form
1165 * @param {String} status
1166 * @param {String} lat (optional)
1167 * @param {String} lon (optional)
1168 * @param {String} url (optional)
1170 NoticeGeoStatus: function (form, status, lat, lon, url)
1172 var wrapper = form.find('.geo_status_wrapper');
1173 if (wrapper.length == 0) {
1174 wrapper = $('<div class="' + SN.C.S.Success + ' geo_status_wrapper"><button class="close" style="float:right">×</button><div class="geo_status"></div></div>');
1175 wrapper.find('button.close').click(function () {
1176 form.find('[name=notice_data-geo]').prop('checked', false).change();
1179 form.append(wrapper);
1183 label = $('<a></a>').attr('href', url);
1185 label = $('<span></span>');
1189 var latlon = lat + ';' + lon;
1190 label.attr('title', latlon);
1195 wrapper.find('.geo_status').empty().append(label);
1199 * Setup function -- DOES NOT trigger actions immediately.
1201 * Initializes event handlers for the "Send direct message" link on
1202 * profile pages, setting it up to display a dialog box when clicked.
1204 * Unlike the repeat confirmation form, this appears to fetch
1205 * the form _from the original link target_, so the form itself
1206 * doesn't need to be in the current document.
1208 * @fixme breaks ability to open link in new window?
1210 NewDirectMessage: function () {
1211 NDM = $('.entity_send-a-message a');
1212 NDM.attr({'href': NDM.attr('href') + '&ajax=1'});
1213 NDM.on('click', function () {
1214 var NDMF = $('.entity_send-a-message form');
1215 if (NDMF.length === 0) {
1216 $(this).addClass(SN.C.S.Processing);
1217 $.get(NDM.attr('href'), null, function (data) {
1218 $('.entity_send-a-message').append(document._importNode($('form', data)[0], true));
1219 NDMF = $('.entity_send-a-message .form_notice');
1220 SN.U.FormNoticeXHR(NDMF);
1221 SN.U.FormNoticeEnhancements(NDMF);
1222 NDMF.append('<button class="close">×</button>');
1223 $('.entity_send-a-message button').click(function () {
1227 NDM.removeClass(SN.C.S.Processing);
1231 $('.entity_send-a-message textarea').focus();
1238 * Return a date object with the current local time on the
1239 * given year, month, and day.
1241 * @param {number} year: 4-digit year
1242 * @param {number} month: 0 == January
1243 * @param {number} day: 1 == 1
1246 GetFullYear: function (year, month, day) {
1247 var date = new Date();
1248 date.setFullYear(year, month, day);
1254 * Check if the current page is a timeline where the current user's
1255 * posts should be displayed immediately on success.
1257 * @fixme this should be done in a saner way, with machine-readable
1258 * info about what page we're looking at.
1260 * @param {DOMElement} notice: HTML chunk with formatted notice
1263 belongsOnTimeline: function (notice) {
1264 var action = $("body").attr('id');
1265 if (action == 'public') {
1269 var profileLink = $('#nav_profile a').attr('href');
1271 var authorUrl = $(notice).find('.h-card.p-author').attr('href');
1272 if (authorUrl == profileLink) {
1273 if (action == 'all' || action == 'showstream') {
1274 // Posts always show on your own friends and profile streams.
1280 // @fixme tag, group, reply timelines should be feasible as well.
1281 // Mismatch between id-based and name-based user/group links currently complicates
1282 // the lookup, since all our inline mentions contain the absolute links but the
1283 // UI links currently on the page use malleable names.
1289 * Switch to another active input sub-form.
1290 * This will hide the current form (if any), show the new one, and
1291 * update the input type tab selection state.
1293 * @param {String} tag
1295 switchInputFormTab: function (tag, setFocus) {
1296 if (typeof setFocus === 'undefined') { setFocus = true; }
1297 // The one that's current isn't current anymore
1298 $('.input_form_nav_tab.current').removeClass('current');
1300 $('#input_form_nav_' + tag).addClass('current');
1303 // Don't remove 'current' if we also have the "nonav" class.
1304 // An example would be the message input form. removing
1305 // 'current' will cause the form to vanish from the page.
1306 var nonav = $('.input_form.current.nonav');
1307 if (nonav.length > 0) {
1311 $('.input_form.current').removeClass('current');
1313 // we're done here, no new inputform to focus on
1317 var noticeForm = $('#input_form_' + tag)
1318 .addClass('current')
1319 .find('.ajax-notice').each(function () {
1321 SN.Init.NoticeFormSetup(form);
1324 noticeForm.find('.notice_data-text').focus();
1330 showMoreMenuItems: function (menuid) {
1331 $('#' + menuid + ' .more_link').remove();
1332 var selector = '#' + menuid + ' .extended_menu';
1333 var extended = $(selector);
1334 extended.removeClass('extended_menu');
1339 * Show a response feedback bit under a form.
1341 * @param {Element} form: the new-notice form usually
1342 * @param {String} cls: CSS class name to use ('error' or 'success')
1343 * @param {String} text
1346 showFeedback: function (form, cls, text) {
1348 $('<p class="form_response"></p>')
1354 addCallback: function (ename, callback) {
1355 // initialize to array if it's undefined
1356 if (typeof SN._callbacks[ename] === 'undefined') {
1357 SN._callbacks[ename] = [];
1359 SN._callbacks[ename].push(callback);
1362 runCallbacks: function (ename, data) {
1363 if (typeof SN._callbacks[ename] === 'undefined') {
1366 for (cbname in SN._callbacks[ename]) {
1367 SN._callbacks[ename][cbname](data);
1373 /* SN.E.ajaxNoticePosted, called when a notice has been posted successfully via an AJAX form
1374 @param form the originating form element
1375 @param data data from success() callback
1376 @param textStatus textStatus from success() callback
1378 ajaxNoticePosted: function (form, data, textStatus) {
1379 var commandResult = $('#' + SN.C.S.CommandResult, data);
1380 if (commandResult.length > 0) {
1381 SN.U.showFeedback(form, 'success', commandResult.text());
1383 // New notice post was successful. If on our timeline, show it!
1384 var notice = document._importNode($('li', data)[0], true);
1385 var notices = $('#notices_primary .notices:first');
1386 var replyItem = form.closest('li.notice-reply');
1388 if (replyItem.length > 0) {
1389 // If this is an inline reply, remove the form...
1390 var list = form.closest('.threaded-replies');
1392 var id = $(notice).attr('id');
1393 if ($('#' + id).length == 0) {
1394 $(notice).insertBefore(replyItem);
1395 } // else Realtime came through before us...
1399 } else if (notices.length > 0 && SN.U.belongsOnTimeline(notice)) {
1400 // Not a reply. If on our timeline, show it at the top!
1402 if ($('#' + notice.id).length === 0) {
1403 var notice_irt_value = form.find('[name=inreplyto]').val();
1404 var notice_irt = '#notices_primary #notice-' + notice_irt_value;
1405 if ($('body')[0].id == 'conversation') {
1406 if (notice_irt_value.length > 0 && $(notice_irt + ' .notices').length < 1) {
1407 $(notice_irt).append('<ul class="notices"></ul>');
1409 $($(notice_irt + ' .notices')[0]).append(notice);
1411 notices.prepend(notice);
1414 .css({display: 'none'})
1416 SN.U.NoticeWithAttachment($('#' + notice.id));
1417 SN.U.switchInputFormTab(null);
1420 // Not on a timeline that this belongs on?
1421 // Just show a success message.
1423 SN.U.showFeedback(form, 'success', $('title', data).text());
1427 form.find('[name=inreplyto]').val('');
1428 form.find('.attach-status').remove();
1429 SN.U.FormNoticeEnhancements(form);
1431 SN.U.runCallbacks('notice_posted', {"notice": notice});
1438 * If user is logged in, run setup code for the new notice form:
1443 * - file upload events
1445 NoticeForm: function () {
1446 if ($('body.user_in').length > 0) {
1447 // SN.Init.NoticeFormSetup() will get run
1448 // when forms get displayed for the first time...
1450 // Initialize the input form field
1451 $('#input_form_nav .input_form_nav_tab.current').each(function () {
1452 current_tab_id = $(this).attr('id').substring('input_form_nav_'.length);
1453 SN.U.switchInputFormTab(current_tab_id, false);
1456 // Make inline reply forms self-close when clicking out.
1457 $('body').on('click', function (e) {
1458 var openReplies = $('li.notice-reply');
1459 if (openReplies.length > 0) {
1460 var target = $(e.target);
1461 openReplies.each(function () {
1462 // Did we click outside this one?
1463 var replyItem = $(this);
1464 if (replyItem.has(e.target).length == 0) {
1465 var textarea = replyItem.find('.notice_data-text:first');
1466 var cur = $.trim(textarea.val());
1467 // Only close if there's been no edit.
1468 if (cur == '' || cur == textarea.data('initialText')) {
1469 var parentNotice = replyItem.closest('li.notice');
1471 parentNotice.find('li.notice-reply-placeholder').show();
1481 * Encapsulate notice form setup for a single form.
1482 * Plugins can add extra setup by monkeypatching this
1485 * @param {jQuery} form
1487 NoticeFormSetup: function (form) {
1488 if (form.data('NoticeFormSetup')) {
1491 SN.U.NoticeLocationAttach(form);
1492 SN.U.FormNoticeUniqueID(form);
1493 SN.U.FormNoticeXHR(form);
1494 SN.U.FormNoticeEnhancements(form);
1495 SN.U.NoticeDataAttach(form);
1496 form.data('NoticeFormSetup', true);
1500 * Run setup code for notice timeline views items:
1502 * - AJAX submission for fave/repeat/reply (if logged in)
1503 * - Attachment link extras ('more' links)
1505 Notices: function () {
1506 if ($('body.user_in').length > 0) {
1507 SN.U.NoticeRepeat();
1509 SN.U.NoticeInlineReplySetup();
1510 SN.U.NoticeOptionsAjax();
1513 SN.U.NoticeAttachments();
1517 * Run setup code for user & group profile page header area if logged in:
1519 * - AJAX submission for sub/unsub/join/leave/nudge
1520 * - AJAX form popup for direct-message
1522 EntityActions: function () {
1523 if ($('body.user_in').length > 0) {
1524 $(document).on('click', '.form_user_subscribe', function () { SN.U.FormXHR($(this)); return false; });
1525 $(document).on('click', '.form_user_unsubscribe', function () { SN.U.FormXHR($(this)); return false; });
1526 $(document).on('click', '.form_group_join', function () { SN.U.FormXHR($(this)); return false; });
1527 $(document).on('click', '.form_group_leave', function () { SN.U.FormXHR($(this)); return false; });
1528 $(document).on('click', '.form_user_nudge', function () { SN.U.FormXHR($(this)); return false; });
1529 $(document).on('click', '.form_peopletag_subscribe', function () { SN.U.FormXHR($(this)); return false; });
1530 $(document).on('click', '.form_peopletag_unsubscribe', function () { SN.U.FormXHR($(this)); return false; });
1531 $(document).on('click', '.form_user_add_peopletag', function () { SN.U.FormXHR($(this)); return false; });
1532 $(document).on('click', '.form_user_remove_peopletag', function () { SN.U.FormXHR($(this)); return false; });
1534 SN.U.NewDirectMessage();
1538 ProfileSearch: function () {
1539 if ($('body.user_in').length > 0) {
1540 $(document).on('click', '.form_peopletag_edit_user_search input.submit', function () {
1541 SN.U.FormProfileSearchXHR($(this).parents('form')); return false;
1547 * Run setup for the ajax people tags editor
1549 * - show edit button
1550 * - set event handle for click on edit button
1551 * - loads people tag autocompletion data if not already present
1552 * or if it is stale.
1555 PeopleTags: function () {
1556 $('.user_profile_tags .editable').append($('<button class="peopletags_edit_button"/>'));
1558 $(document).on('click', '.peopletags_edit_button', function () {
1559 var form = $(this).parents('dd').eq(0).find('form');
1560 // We can buy time from the above animation
1565 data: {token: $('#token').val()},
1567 success: function (data) {
1568 // item.label is used to match
1569 for (i=0; i < data.length; i++) {
1570 data[i].label = data[i].tag;
1573 SN.C.PtagACData = data;
1577 $(this).parents('ul').eq(0).fadeOut(200, function () {form.fadeIn(200).find('input#tags')});
1580 $(document).on('click', '.user_profile_tags form .submit', function () {
1581 SN.U.FormPeopletagsXHR($(this).parents('form')); return false;
1586 * Set up any generic 'ajax' form so it submits via AJAX with auto-replacement.
1588 AjaxForms: function () {
1589 $(document).on('submit', 'form.ajax', function () {
1590 SN.U.FormXHR($(this));
1593 $(document).on('click', 'form.ajax input[type=submit]', function () {
1594 // Some forms rely on knowing which submit button was clicked.
1595 // Save a hidden input field which'll be picked up during AJAX
1597 var button = $(this);
1598 var form = button.closest('form');
1599 form.find('.hidden-submit-button').remove();
1600 $('<input class="hidden-submit-button" type="hidden" />')
1601 .attr('name', button.attr('name'))
1608 * Add logic to any file upload forms to handle file size limits,
1609 * on browsers that support basic FileAPI.
1611 UploadForms: function () {
1612 $('input[type=file]').change(function (event) {
1613 if (typeof this.files === "object" && this.files.length > 0) {
1615 for (var i = 0; i < this.files.length; i++) {
1616 size += this.files[i].size;
1619 var max = SN.U.maxFileSize($(this.form));
1620 if (max > 0 && size > max) {
1621 var msg = 'File too large: maximum upload size is %d bytes.';
1622 alert(msg.replace('%d', max));
1626 event.preventDefault();
1633 CheckBoxes: function () {
1634 $("span[class='checkbox-wrapper']").addClass("unchecked");
1635 $(".checkbox-wrapper").click(function () {
1636 if ($(this).children("input").prop("checked")) {
1638 $(this).children("input").prop("checked", false);
1639 $(this).removeClass("checked");
1640 $(this).addClass("unchecked");
1641 $(this).children("label").text("Private?");
1644 $(this).children("input").prop("checked", true);
1645 $(this).removeClass("unchecked");
1646 $(this).addClass("checked");
1647 $(this).children("label").text("Private");
1655 * Run initialization functions on DOM-ready.
1657 * Note that if we're waiting on other scripts to load, this won't happen
1658 * until that's done. To load scripts asynchronously without delaying setup,
1659 * don't start them loading until after DOM-ready time!
1662 SN.Init.AjaxForms();
1663 SN.Init.UploadForms();
1664 SN.Init.CheckBoxes();
1665 if ($('.' + SN.C.S.FormNotice).length > 0) {
1666 SN.Init.NoticeForm();
1668 if ($('#content .notices').length > 0) {
1671 if ($('#content .entity_actions').length > 0) {
1672 SN.Init.EntityActions();
1674 if ($('#profile_search_results').length > 0) {
1675 SN.Init.ProfileSearch();
1677 if ($('.user_profile_tags .editable').length > 0) {
1678 SN.Init.PeopleTags();