js/util.js

   1 /*
   2  * StatusNet - a distributed open-source microblogging tool
   3  * Copyright (C) 2008, StatusNet, Inc.
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU Affero General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU Affero General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Affero General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  * @category  UI interaction
  19  * @package   StatusNet
  20  * @author    Sarven Capadisli <csarven@status.net>
  21  * @author    Evan Prodromou <evan@status.net>
  22  * @author    Brion Vibber <brion@status.net>
  23  * @copyright 2009,2010 StatusNet, Inc.
  24  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  25  * @link      http://status.net/
  26  */
  27
  28 var SN = { // StatusNet
  29     C: { // Config
  30         I: { // Init
  31             CounterBlackout: false,
  32             MaxLength: 140,
  33             PatternUsername: /^[0-9a-zA-Z\-_.]*$/,
  34             HTTP20x30x: [200, 201, 202, 203, 204, 205, 206, 300, 301, 302, 303, 304, 305, 306, 307],
  35             NoticeFormMaster: null // to be cloned from the one at top
  36         },
  37
  38         /**
  39          * @fixme are these worth the trouble? They seem to mostly just duplicate
  40          * themselves while slightly obscuring the actual selector, so it's hard
  41          * to pop over to the HTML and find something.
  42          *
  43          * In theory, minification could reduce them to shorter variable names,
  44          * but at present that doesn't happen with yui-compressor.
  45          */
  46         S: { // Selector
  47             Disabled: 'disabled',
  48             Warning: 'warning',
  49             Error: 'error',
  50             Success: 'success',
  51             Processing: 'processing',
  52             CommandResult: 'command_result',
  53             FormNotice: 'form_notice',
  54             NoticeDataGeo: 'notice_data-geo',
  55             NoticeDataGeoCookie: 'NoticeDataGeo',
  56             NoticeDataGeoSelected: 'notice_data-geo_selected',
  57             StatusNetInstance:'StatusNetInstance'
  58         }
  59     },
  60
  61     /**
  62      * Map of localized message strings exported to script from the PHP
  63      * side via Action::getScriptMessages().
  64      *
  65      * Retrieve them via SN.msg(); this array is an implementation detail.
  66      *
  67      * @access private
  68      */
  69     messages: {},
  70
  71     /**
  72      * Grabs a localized string that's been previously exported to us
  73      * from server-side code via Action::getScriptMessages().
  74      *
  75      * @example alert(SN.msg('coolplugin-failed'));
  76      *
  77      * @param {String} key: string key name to pull from message index
  78      * @return matching localized message string
  79      */
  80     msg: function(key) {
  81         if (typeof SN.messages[key] == "undefined") {
  82             return '[' + key + ']';
  83         } else {
  84             return SN.messages[key];
  85         }
  86     },
  87
  88     U: { // Utils
  89         /**
  90          * Setup function -- DOES NOT trigger actions immediately.
  91          *
  92          * Sets up event handlers on the new notice form.
  93          *
  94          * @param {jQuery} form: jQuery object whose first matching element is the form
  95          * @access private
  96          */
  97         FormNoticeEnhancements: function(form) {
  98             if (jQuery.data(form[0], 'ElementData') === undefined) {
  99                 MaxLength = form.find('.count').text();
 100                 if (typeof(MaxLength) == 'undefined') {
 101                      MaxLength = SN.C.I.MaxLength;
 102                 }
 103                 jQuery.data(form[0], 'ElementData', {MaxLength:MaxLength});
 104
 105                 SN.U.Counter(form);
 106
 107                 NDT = form.find('.notice_data-text:first');
 108
 109                 NDT.bind('keyup', function(e) {
 110                     SN.U.Counter(form);
 111                 });
 112
 113                 var delayedUpdate= function(e) {
 114                     // Cut and paste events fire *before* the operation,
 115                     // so we need to trigger an update in a little bit.
 116                     // This would be so much easier if the 'change' event
 117                     // actually fired every time the value changed. :P
 118                     window.setTimeout(function() {
 119                         SN.U.Counter(form);
 120                     }, 50);
 121                 };
 122                 // Note there's still no event for mouse-triggered 'delete'.
 123                 NDT.bind('cut', delayedUpdate)
 124                    .bind('paste', delayedUpdate);
 125             }
 126             else {
 127                 form.find('.count').text(jQuery.data(form[0], 'ElementData').MaxLength);
 128             }
 129         },
 130
 131         /**
 132          * To be called from event handlers on the notice import form.
 133          * Triggers an update of the remaining-characters counter.
 134          *
 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.
 138          *
 139          * The maximum length is pulled from data established by
 140          * FormNoticeEnhancements.
 141          *
 142          * @param {jQuery} form: jQuery object whose first element is the notice posting form
 143          * @access private
 144          */
 145         Counter: function(form) {
 146             SN.C.I.FormNoticeCurrent = form;
 147
 148             var MaxLength = jQuery.data(form[0], 'ElementData').MaxLength;
 149
 150             if (MaxLength <= 0) {
 151                 return;
 152             }
 153
 154             var remaining = MaxLength - SN.U.CharacterCount(form);
 155             var counter = form.find('.count');
 156
 157             if (remaining.toString() != counter.text()) {
 158                 if (!SN.C.I.CounterBlackout || remaining === 0) {
 159                     if (counter.text() != String(remaining)) {
 160                         counter.text(remaining);
 161                     }
 162                     if (remaining < 0) {
 163                         form.addClass(SN.C.S.Warning);
 164                     } else {
 165                         form.removeClass(SN.C.S.Warning);
 166                     }
 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);
 173                     }
 174                 }
 175             }
 176         },
 177
 178         /**
 179          * Pull the count of characters in the current edit field.
 180          * Plugins replacing the edit control may need to override this.
 181          *
 182          * @param {jQuery} form: jQuery object whose first element is the notice posting form
 183          * @return number of chars
 184          */
 185         CharacterCount: function(form) {
 186             return form.find('.notice_data-text:first').val().length;
 187         },
 188
 189         /**
 190          * Called internally after the counter update blackout period expires;
 191          * runs another update to make sure we didn't miss anything.
 192          *
 193          * @param {jQuery} form: jQuery object whose first element is the notice posting form
 194          * @access private
 195          */
 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
 200             SN.U.Counter(form);
 201         },
 202
 203         /**
 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
 206          * mode.
 207          *
 208          * It would be better to output URLs that didn't hardcode protocol
 209          * and hostname in the first place...
 210          *
 211          * @param {String} url
 212          * @return string
 213          */
 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);
 218             } else {
 219                 return url;
 220             }
 221         },
 222
 223         /**
 224          * Grabs form data and submits it asynchronously, with 'ajax=1'
 225          * parameter added to the rest.
 226          *
 227          * If a successful response includes another form, that form
 228          * will be extracted and copied in, replacing the original form.
 229          * If there's no form, the first paragraph will be used.
 230          *
 231          * This will automatically be applied on the 'submit' event for
 232          * any form with the 'ajax' class.
 233          *
 234          * @fixme can sometimes explode confusingly if returnd data is bogus
 235          * @fixme error handling is pretty vague
 236          * @fixme can't submit file uploads
 237          *
 238          * @param {jQuery} form: jQuery object whose first element is a form
 239          * @param function onSuccess: something extra to do on success
 240          *
 241          * @access public
 242          */
 243         FormXHR: function(form, onSuccess) {
 244             $.ajax({
 245                 type: 'POST',
 246                 dataType: 'xml',
 247                 url: SN.U.RewriteAjaxAction(form.attr('action')),
 248                 data: form.serialize() + '&ajax=1',
 249                 beforeSend: function(xhr) {
 250                     form
 251                         .addClass(SN.C.S.Processing)
 252                         .find('.submit')
 253                             .addClass(SN.C.S.Disabled)
 254                             .attr(SN.C.S.Disabled, SN.C.S.Disabled);
 255                 },
 256                 error: function (xhr, textStatus, errorThrown) {
 257                     // If the server end reported an error from StatusNet,
 258                     // find it -- otherwise we'll see what was reported
 259                     // from the browser.
 260                     var errorReported = null;
 261                     if (xhr.responseXML) {
 262                         errorReported = $('#error', xhr.responseXML).text();
 263                     }
 264                     alert(errorReported || errorThrown || textStatus);
 265
 266                     // Restore the form to original state.
 267                     // Hopefully. :D
 268                     form
 269                         .removeClass(SN.C.S.Processing)
 270                         .find('.submit')
 271                             .removeClass(SN.C.S.Disabled)
 272                             .removeAttr(SN.C.S.Disabled);
 273                 },
 274                 success: function(data, textStatus) {
 275                     if (typeof($('form', data)[0]) != 'undefined') {
 276                         form_new = $('form', $(data).children());
 277                         form.replaceWith(form_new);
 278                         if (onSuccess) {
 279                             onSuccess();
 280                         }
 281                     }
 282                     else if (typeof($('p', data)[0]) != 'undefined') {
 283                         form.replaceWith$('form', $(data).children());
 284                         if (onSuccess) {
 285                             onSuccess();
 286                         }
 287                     }
 288                     else {
 289                         alert('Unknown error.');
 290                     }
 291                 }
 292             });
 293         },
 294
 295         /**
 296          * Setup function -- DOES NOT trigger actions immediately.
 297          *
 298          * Sets up event handlers for special-cased async submission of the
 299          * notice-posting form, including some pre-post validation.
 300          *
 301          * Unlike FormXHR() this does NOT submit the form immediately!
 302          * It sets up event handlers so that any method of submitting the
 303          * form (click on submit button, enter, submit() etc) will trigger
 304          * it properly.
 305          *
 306          * Also unlike FormXHR(), this system will use a hidden iframe
 307          * automatically to handle file uploads via <input type="file">
 308          * controls.
 309          *
 310          * @fixme tl;dr
 311          * @fixme vast swaths of duplicate code and really long variable names clutter this function up real bad
 312          * @fixme error handling is unreliable
 313          * @fixme cookieValue is a global variable, but probably shouldn't be
 314          * @fixme saving the location cache cookies should be split out
 315          * @fixme some error messages are hardcoded english: needs i18n
 316          * @fixme special-case for bookmarklet is confusing and uses a global var "self". Is this ok?
 317          *
 318          * @param {jQuery} form: jQuery object whose first element is a form
 319          *
 320          * @access public
 321          */
 322         FormNoticeXHR: function(form) {
 323             SN.C.I.NoticeDataGeo = {};
 324             form.append('<input type="hidden" name="ajax" value="1"/>');
 325
 326             // Make sure we don't have a mixed HTTP/HTTPS submission...
 327             form.attr('action', SN.U.RewriteAjaxAction(form.attr('action')));
 328
 329             /**
 330              * Show a response feedback bit under the new-notice dialog.
 331              *
 332              * @param {String} cls: CSS class name to use ('error' or 'success')
 333              * @param {String} text
 334              * @access private
 335              */
 336             var showFeedback = function(cls, text) {
 337                 form.append(
 338                     $('<p class="form_response"></p>')
 339                         .addClass(cls)
 340                         .text(text)
 341                 );
 342             };
 343
 344             /**
 345              * Hide the previous response feedback, if any.
 346              */
 347             var removeFeedback = function() {
 348                 form.find('.form_response').remove();
 349             };
 350
 351             form.ajaxForm({
 352                 dataType: 'xml',
 353                 timeout: '60000',
 354                 beforeSend: function(formData) {
 355                     if (form.find('.notice_data-text:first').val() == '') {
 356                         form.addClass(SN.C.S.Warning);
 357                         return false;
 358                     }
 359                     form
 360                         .addClass(SN.C.S.Processing)
 361                         .find('.submit')
 362                             .addClass(SN.C.S.Disabled)
 363                             .attr(SN.C.S.Disabled, SN.C.S.Disabled);
 364
 365                     SN.U.normalizeGeoData(form);
 366
 367                     return true;
 368                 },
 369                 error: function (xhr, textStatus, errorThrown) {
 370                     form
 371                         .removeClass(SN.C.S.Processing)
 372                         .find('.submit')
 373                             .removeClass(SN.C.S.Disabled)
 374                             .removeAttr(SN.C.S.Disabled, SN.C.S.Disabled);
 375                     removeFeedback();
 376                     if (textStatus == 'timeout') {
 377                         // @fixme i18n
 378                         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.');
 379                     }
 380                     else {
 381                         var response = SN.U.GetResponseXML(xhr);
 382                         if ($('.'+SN.C.S.Error, response).length > 0) {
 383                             form.append(document._importNode($('.'+SN.C.S.Error, response)[0], true));
 384                         }
 385                         else {
 386                             if (parseInt(xhr.status) === 0 || jQuery.inArray(parseInt(xhr.status), SN.C.I.HTTP20x30x) >= 0) {
 387                                 form
 388                                     .resetForm()
 389                                     .find('.attach-status').remove();
 390                                 SN.U.FormNoticeEnhancements(form);
 391                             }
 392                             else {
 393                                 // @fixme i18n
 394                                 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.');
 395                             }
 396                         }
 397                     }
 398                 },
 399                 success: function(data, textStatus) {
 400                     removeFeedback();
 401                     var errorResult = $('#'+SN.C.S.Error, data);
 402                     if (errorResult.length > 0) {
 403                         showFeedback('error', errorResult.text());
 404                     }
 405                     else {
 406                         if($('body')[0].id == 'bookmarklet') {
 407                             // @fixme self is not referenced anywhere?
 408                             self.close();
 409                         }
 410
 411                         var commandResult = $('#'+SN.C.S.CommandResult, data);
 412                         if (commandResult.length > 0) {
 413                             showFeedback('success', commandResult.text());
 414                         }
 415                         else {
 416                             // New notice post was successful. If on our timeline, show it!
 417                             var notice = document._importNode($('li', data)[0], true);
 418                             var notices = $('#notices_primary .notices:first');
 419                             var replyItem = form.closest('li.notice-reply');
 420
 421                             if (replyItem.length > 0) {
 422                                 // If this is an inline reply, remove the form...
 423                                 var list = form.closest('.threaded-replies');
 424                                 var placeholder = list.find('.notice-reply-placeholder');
 425                                 replyItem.remove();
 426
 427                                 var id = $(notice).attr('id');
 428                                 if ($("#"+id).length == 0) {
 429                                     $(notice).insertBefore(placeholder);
 430                                 } else {
 431                                     // Realtime came through before us...
 432                                 }
 433
 434                                 // ...and show the placeholder form.
 435                                 placeholder.show();
 436                             } else if (notices.length > 0 && SN.U.belongsOnTimeline(notice)) {
 437                                 // Not a reply. If on our timeline, show it at the top!
 438
 439                                 if ($('#'+notice.id).length === 0) {
 440                                     var notice_irt_value = form.find('[name=inreplyto]').val();
 441                                     var notice_irt = '#notices_primary #notice-'+notice_irt_value;
 442                                     if($('body')[0].id == 'conversation') {
 443                                         if(notice_irt_value.length > 0 && $(notice_irt+' .notices').length < 1) {
 444                                             $(notice_irt).append('<ul class="notices"></ul>');
 445                                         }
 446                                         $($(notice_irt+' .notices')[0]).append(notice);
 447                                     }
 448                                     else {
 449                                         notices.prepend(notice);
 450                                     }
 451                                     $('#'+notice.id)
 452                                         .css({display:'none'})
 453                                         .fadeIn(2500);
 454                                     SN.U.NoticeWithAttachment($('#'+notice.id));
 455                                     SN.U.switchInputFormTab("placeholder");
 456                                 }
 457                             } else {
 458                                 // Not on a timeline that this belongs on?
 459                                 // Just show a success message.
 460                                 // @fixme inline
 461                                 showFeedback('success', $('title', data).text());
 462                             }
 463                         }
 464                         form.resetForm();
 465                         form.find('[name=inreplyto]').val('');
 466                         form.find('.attach-status').remove();
 467                         SN.U.FormNoticeEnhancements(form);
 468                     }
 469                 },
 470                 complete: function(xhr, textStatus) {
 471                     form
 472                         .removeClass(SN.C.S.Processing)
 473                         .find('.submit')
 474                             .removeAttr(SN.C.S.Disabled)
 475                             .removeClass(SN.C.S.Disabled);
 476
 477                     form.find('[name=lat]').val(SN.C.I.NoticeDataGeo.NLat);
 478                     form.find('[name=lon]').val(SN.C.I.NoticeDataGeo.NLon);
 479                     form.find('[name=location_ns]').val(SN.C.I.NoticeDataGeo.NLNS);
 480                     form.find('[name=location_id]').val(SN.C.I.NoticeDataGeo.NLID);
 481                     form.find('[name=notice_data-geo]').attr('checked', SN.C.I.NoticeDataGeo.NDG);
 482                 }
 483             });
 484         },
 485
 486         FormProfileSearchXHR: function(form) {
 487             $.ajax({
 488                 type: 'POST',
 489                 dataType: 'xml',
 490                 url: form.attr('action'),
 491                 data: form.serialize() + '&ajax=1',
 492                 beforeSend: function(xhr) {
 493                     form
 494                         .addClass(SN.C.S.Processing)
 495                         .find('.submit')
 496                             .addClass(SN.C.S.Disabled)
 497                             .attr(SN.C.S.Disabled, SN.C.S.Disabled);
 498                 },
 499                 error: function (xhr, textStatus, errorThrown) {
 500                     alert(errorThrown || textStatus);
 501                 },
 502                 success: function(data, textStatus) {
 503                     var results_placeholder = $('#profile_search_results');
 504                     if (typeof($('ul', data)[0]) != 'undefined') {
 505                         var list = $('ul', $(data).children());
 506                         results_placeholder.replaceWith(list);
 507                     }
 508                     else {
 509                         var _error = $('<li/>').append($('p', $(data).children()));
 510                         results_placeholder.html(_error);
 511                     }
 512                     form
 513                         .removeClass(SN.C.S.Processing)
 514                         .find('.submit')
 515                             .removeClass(SN.C.S.Disabled)
 516                             .attr(SN.C.S.Disabled, false);
 517                 }
 518             });
 519         },
 520
 521         FormPeopletagsXHR: function(form) {
 522             $.ajax({
 523                 type: 'POST',
 524                 dataType: 'xml',
 525                 url: form.attr('action'),
 526                 data: form.serialize() + '&ajax=1',
 527                 beforeSend: function(xhr) {
 528                     form.find('.submit')
 529                             .addClass(SN.C.S.Processing)
 530                             .addClass(SN.C.S.Disabled)
 531                             .attr(SN.C.S.Disabled, SN.C.S.Disabled);
 532                 },
 533                 error: function (xhr, textStatus, errorThrown) {
 534                     alert(errorThrown || textStatus);
 535                 },
 536                 success: function(data, textStatus) {
 537                     var results_placeholder = form.parents('.entity_tags');
 538                     if (typeof($('.entity_tags', data)[0]) != 'undefined') {
 539                         var tags = $('.entity_tags', $(data).children());
 540                         $(tags).find('.editable').append($('<button class="peopletags_edit_button"/>'));
 541                         results_placeholder.replaceWith(tags);
 542                     } else {
 543                         results_placeholder.find('p').remove();
 544                         results_placeholder.append($('p', $(data).children()));
 545                         form.removeClass(SN.C.S.Processing)
 546                             .find('.submit')
 547                                 .removeClass(SN.C.S.Disabled)
 548                                 .attr(SN.C.S.Disabled, false);
 549                     }
 550                 }
 551             });
 552         },
 553
 554         normalizeGeoData: function(form) {
 555             SN.C.I.NoticeDataGeo.NLat = form.find('[name=lat]').val();
 556             SN.C.I.NoticeDataGeo.NLon = form.find('[name=lon]').val();
 557             SN.C.I.NoticeDataGeo.NLNS = form.find('[name=location_ns]').val();
 558             SN.C.I.NoticeDataGeo.NLID = form.find('[name=location_id]').val();
 559             SN.C.I.NoticeDataGeo.NDG = form.find('[name=notice_data-geo]').attr('checked'); // @fixme
 560
 561             var cookieValue = $.cookie(SN.C.S.NoticeDataGeoCookie);
 562
 563             if (cookieValue !== null && cookieValue != 'disabled') {
 564                 cookieValue = JSON.parse(cookieValue);
 565                 SN.C.I.NoticeDataGeo.NLat = form.find('[name=lat]').val(cookieValue.NLat).val();
 566                 SN.C.I.NoticeDataGeo.NLon = form.find('[name=lon]').val(cookieValue.NLon).val();
 567                 if (cookieValue.NLNS) {
 568                     SN.C.I.NoticeDataGeo.NLNS = form.find('[name=location_ns]').val(cookieValue.NLNS).val();
 569                     SN.C.I.NoticeDataGeo.NLID = form.find('[name=location_id]').val(cookieValue.NLID).val();
 570                 } else {
 571                     form.find('[name=location_ns]').val('');
 572                     form.find('[name=location_id]').val('');
 573                 }
 574             }
 575             if (cookieValue == 'disabled') {
 576                 SN.C.I.NoticeDataGeo.NDG = form.find('[name=notice_data-geo]').attr('checked', false).attr('checked');
 577             }
 578             else {
 579                 SN.C.I.NoticeDataGeo.NDG = form.find('[name=notice_data-geo]').attr('checked', true).attr('checked');
 580             }
 581
 582         },
 583
 584         /**
 585          * Fetch an XML DOM from an XHR's response data.
 586          *
 587          * Works around unavailable responseXML when document.domain
 588          * has been modified by Meteor or other tools, in some but not
 589          * all browsers.
 590          *
 591          * @param {XMLHTTPRequest} xhr
 592          * @return DOMDocument
 593          */
 594         GetResponseXML: function(xhr) {
 595             try {
 596                 return xhr.responseXML;
 597             } catch (e) {
 598                 return (new DOMParser()).parseFromString(xhr.responseText, "text/xml");
 599             }
 600         },
 601
 602         /**
 603          * Setup function -- DOES NOT trigger actions immediately.
 604          *
 605          * Sets up event handlers on all visible notice's reply buttons to
 606          * tweak the new-notice form with needed variables and focus it
 607          * when pushed.
 608          *
 609          * (This replaces the default reply button behavior to submit
 610          * directly to a form which comes back with a specialized page
 611          * with the form data prefilled.)
 612          *
 613          * @access private
 614          */
 615         NoticeReply: function() {
 616             $('#content .notice_reply').live('click', function(e) {
 617                 e.preventDefault();
 618                 var notice = $(this).closest('li.notice');
 619                 SN.U.NoticeInlineReplyTrigger(notice);
 620                 return false;
 621             });
 622         },
 623
 624         /**
 625          * Stub -- kept for compat with plugins for now.
 626          * @access private
 627          */
 628         NoticeReplyTo: function(notice) {
 629         },
 630
 631         /**
 632          * Open up a notice's inline reply box.
 633          *
 634          * @param {jQuery} notice: jQuery object containing one notice
 635          * @param {String} initialText
 636          */
 637         NoticeInlineReplyTrigger: function(notice, initialText) {
 638             // Find the notice we're replying to...
 639             var id = $($('.notice_id', notice)[0]).text();
 640             var parentNotice = notice;
 641
 642             // Find the threaded replies view we'll be adding to...
 643             var list = notice.closest('.notices');
 644             if (list.hasClass('threaded-replies')) {
 645                 // We're replying to a reply; use reply form on the end of this list.
 646                 // We'll add our form at the end of this; grab the root notice.
 647                 parentNotice = list.closest('.notice');
 648             } else {
 649                 // We're replying to a parent notice; pull its threaded list
 650                 // and we'll add on the end of it. Will add if needed.
 651                 list = $('ul.threaded-replies', notice);
 652                 if (list.length == 0) {
 653                     SN.U.NoticeInlineReplyPlaceholder(notice);
 654                     list = $('ul.threaded-replies', notice);
 655                 } else {
 656                     var placeholder = $('li.notice-reply-placeholder', notice);
 657                     if (placeholder.length == 0) {
 658                         SN.U.NoticeInlineReplyPlaceholder(notice);
 659                     }
 660                 }
 661             }
 662
 663             // See if the form's already open...
 664             var replyForm = $('.notice-reply-form', list);
 665
 666             var nextStep = function() {
 667                 // Override...?
 668                 replyForm.find('input[name=inreplyto]').val(id);
 669                 replyForm.find('#notice_to').attr('disabled', 'disabled').hide();
 670                 replyForm.find('#notice_private').attr('disabled', 'disabled').hide();
 671                 replyForm.find('label[for=notice_to]').hide();
 672                 replyForm.find('label[for=notice_private]').hide();
 673
 674                 // Set focus...
 675                 var text = replyForm.find('textarea');
 676                 if (text.length == 0) {
 677                     throw "No textarea";
 678                 }
 679                 var replyto = '';
 680                 if (initialText) {
 681                     replyto = initialText + ' ';
 682                 }
 683                 text.val(replyto + text.val().replace(RegExp(replyto, 'i'), ''));
 684                 text.data('initialText', $.trim(initialText + ''));
 685                 text.focus();
 686                 if (text[0].setSelectionRange) {
 687                     var len = text.val().length;
 688                     text[0].setSelectionRange(len,len);
 689                 }
 690             };
 691             if (replyForm.length > 0) {
 692                 // Update the existing form...
 693                 nextStep();
 694             } else {
 695                 // Hide the placeholder...
 696                 var placeholder = list.find('li.notice-reply-placeholder').hide();
 697
 698                 // Create the reply form entry at the end
 699                 var replyItem = $('li.notice-reply', list);
 700                 if (replyItem.length == 0) {
 701                     replyItem = $('<li class="notice-reply"></li>');
 702
 703                     var intermediateStep = function(formMaster) {
 704                         replyItem.append(formMaster);
 705                         list.append(replyItem); // *after* the placeholder
 706
 707                         var form = replyForm = formMaster;
 708                         SN.Init.NoticeFormSetup(form);
 709
 710                         nextStep();
 711                     };
 712                     if (SN.C.I.NoticeFormMaster) {
 713                         // We've already saved a master copy of the form.
 714                         // Clone it in!
 715                         intermediateStep(SN.C.I.NoticeFormMaster);
 716                     } else {
 717                         // Fetch a fresh copy of the notice form over AJAX.
 718                         // Warning: this can have a delay, which looks bad.
 719                         // @fixme this fallback may or may not work
 720                         var url = $('#form_notice').attr('action');
 721                         $.get(url, {ajax: 1}, function(data, textStatus, xhr) {
 722                             intermediateStep($('form', $(data).children()));
 723                         }, 'xml');
 724                     }
 725                 }
 726             }
 727         },
 728
 729         NoticeInlineReplyPlaceholder: function(notice) {
 730             var list = notice.find('ul.threaded-replies');
 731             if (list.length == 0) {
 732                 list = $('<ul class="notices threaded-replies xoxo"></ul>');
 733                 notice.append(list);
 734                 list = notice.find('ul.threaded-replies');
 735             }
 736             var placeholder = $('<li class="notice-reply-placeholder">' +
 737                                     '<input class="placeholder">' +
 738                                 '</li>');
 739             placeholder.find('input')
 740                 .val(SN.msg('reply_placeholder'));
 741             list.append(placeholder);
 742         },
 743
 744         /**
 745          * Setup function -- DOES NOT apply immediately.
 746          *
 747          * Sets up event handlers for inline reply mini-form placeholders.
 748          * Uses 'live' rather than 'bind', so applies to future as well as present items.
 749          */
 750         NoticeInlineReplySetup: function() {
 751             $('li.notice-reply-placeholder input')
 752                 .live('focus', function() {
 753                     var notice = $(this).closest('li.notice');
 754                     SN.U.NoticeInlineReplyTrigger(notice);
 755                     return false;
 756                 });
 757             $('li.notice-reply-comments a')
 758                 .live('click', function() {
 759                     var url = $(this).attr('href');
 760                     var area = $(this).closest('.threaded-replies');
 761                     $.get(url, {ajax: 1}, function(data, textStatus, xhr) {
 762                         var replies = $('.threaded-replies', $(data).children());
 763                         if (replies.length) {
 764                             area.replaceWith(replies);
 765                         }
 766                     }, 'xml');
 767                     return false;
 768                 });
 769         },
 770
 771         /**
 772          * Setup function -- DOES NOT trigger actions immediately.
 773          *
 774          * Sets up event handlers for repeat forms to toss up a confirmation
 775          * popout before submitting.
 776          *
 777          * Uses 'live' rather than 'bind', so applies to future as well as present items.
 778          *
 779          */
 780         NoticeRepeat: function() {
 781             $('.form_repeat').live('click', function(e) {
 782                 e.preventDefault();
 783
 784                 SN.U.NoticeRepeatConfirmation($(this));
 785                 return false;
 786             });
 787         },
 788
 789         /**
 790          * Shows a confirmation dialog box variant of the repeat button form.
 791          * This seems to use a technique where the repeat form contains
 792          * _both_ a standalone button _and_ text and buttons for a dialog.
 793          * The dialog will close after its copy of the form is submitted,
 794          * or if you click its 'close' button.
 795          *
 796          * The dialog is created by duplicating the original form and changing
 797          * its style; while clever, this is hard to generalize and probably
 798          * duplicates a lot of unnecessary HTML output.
 799          *
 800          * @fixme create confirmation dialogs through a generalized interface
 801          * that can be reused instead of hardcoded text and styles.
 802          *
 803          * @param {jQuery} form
 804          */
 805         NoticeRepeatConfirmation: function(form) {
 806             var submit_i = form.find('.submit');
 807
 808             var submit = submit_i.clone();
 809             submit
 810                 .addClass('submit_dialogbox')
 811                 .removeClass('submit');
 812             form.append(submit);
 813             submit.bind('click', function() { SN.U.FormXHR(form); return false; });
 814
 815             submit_i.hide();
 816
 817             form
 818                 .addClass('dialogbox')
 819                 .append('<button class="close">&#215;</button>')
 820                 .closest('.notice-options')
 821                     .addClass('opaque');
 822
 823             form.find('button.close').click(function(){
 824                 $(this).remove();
 825
 826                 form
 827                     .removeClass('dialogbox')
 828                     .closest('.notice-options')
 829                         .removeClass('opaque');
 830
 831                 form.find('.submit_dialogbox').remove();
 832                 form.find('.submit').show();
 833
 834                 return false;
 835             });
 836         },
 837
 838         /**
 839          * Setup function -- DOES NOT trigger actions immediately.
 840          *
 841          * Goes through all notices currently displayed and sets up attachment
 842          * handling if needed.
 843          */
 844         NoticeAttachments: function() {
 845             $('.notice a.attachment').each(function() {
 846                 SN.U.NoticeWithAttachment($(this).closest('.notice'));
 847             });
 848         },
 849
 850         /**
 851          * Setup function -- DOES NOT trigger actions immediately.
 852          *
 853          * Sets up special attachment link handling if needed. Currently this
 854          * consists only of making the "more" button used for OStatus message
 855          * cropping turn into an auto-expansion button that loads the full
 856          * text from an attachment file.
 857          *
 858          * @param {jQuery} notice
 859          */
 860         NoticeWithAttachment: function(notice) {
 861             if (notice.find('.attachment').length === 0) {
 862                 return;
 863             }
 864
 865             var attachment_more = notice.find('.attachment.more');
 866             if (attachment_more.length > 0) {
 867                 $(attachment_more[0]).click(function() {
 868                     var m = $(this);
 869                     m.addClass(SN.C.S.Processing);
 870                     $.get(m.attr('href')+'/ajax', null, function(data) {
 871                         m.parent('.entry-content').html($(data).find('#attachment_view .entry-content').html());
 872                     });
 873
 874                     return false;
 875                 }).attr('title', SN.msg('showmore_tooltip'));
 876             }
 877         },
 878
 879         /**
 880          * Setup function -- DOES NOT trigger actions immediately.
 881          *
 882          * Sets up event handlers for the file-attachment widget in the
 883          * new notice form. When a file is selected, a box will be added
 884          * below the text input showing the filename and, if supported
 885          * by the browser, a thumbnail preview.
 886          *
 887          * This preview box will also allow removing the attachment
 888          * prior to posting.
 889          *
 890          * @param {jQuery} form
 891          */
 892         NoticeDataAttach: function(form) {
 893             var NDA = form.find('input[type=file]');
 894             NDA.change(function(event) {
 895                 form.find('.attach-status').remove();
 896
 897                 var filename = $(this).val();
 898                 if (!filename) {
 899                     // No file -- we've been tricked!
 900                     return false;
 901                 }
 902
 903                 var attachStatus = $('<div class="attach-status '+SN.C.S.Success+'"><code></code> <button class="close">&#215;</button></div>');
 904                 attachStatus.find('code').text(filename);
 905                 attachStatus.find('button').click(function(){
 906                     attachStatus.remove();
 907                     NDA.val('');
 908
 909                     return false;
 910                 });
 911                 form.append(attachStatus);
 912
 913                 if (typeof this.files == "object") {
 914                     // Some newer browsers will let us fetch the files for preview.
 915                     for (var i = 0; i < this.files.length; i++) {
 916                         SN.U.PreviewAttach(form, this.files[i]);
 917                     }
 918                 }
 919             });
 920         },
 921
 922         /**
 923          * Get PHP's MAX_FILE_SIZE setting for this form;
 924          * used to apply client-side file size limit checks.
 925          *
 926          * @param {jQuery} form
 927          * @return int max size in bytes; 0 or negative means no limit
 928          */
 929         maxFileSize: function(form) {
 930             var max = $(form).find('input[name=MAX_FILE_SIZE]').attr('value');
 931             if (max) {
 932                 return parseInt(max);
 933             } else {
 934                 return 0;
 935             }
 936         },
 937
 938         /**
 939          * For browsers with FileAPI support: make a thumbnail if possible,
 940          * and append it into the attachment display widget.
 941          *
 942          * Known good:
 943          * - Firefox 3.6.6, 4.0b7
 944          * - Chrome 8.0.552.210
 945          *
 946          * Known ok metadata, can't get contents:
 947          * - Safari 5.0.2
 948          *
 949          * Known fail:
 950          * - Opera 10.63, 11 beta (no input.files interface)
 951          *
 952          * @param {jQuery} form
 953          * @param {File} file
 954          *
 955          * @todo use configured thumbnail size
 956          * @todo detect pixel size?
 957          * @todo should we render a thumbnail to a canvas and then use the smaller image?
 958          */
 959         PreviewAttach: function(form, file) {
 960             var tooltip = file.type + ' ' + Math.round(file.size / 1024) + 'KB';
 961             var preview = true;
 962
 963             var blobAsDataURL;
 964             if (typeof window.createObjectURL != "undefined") {
 965                 /**
 966                  * createObjectURL lets us reference the file directly from an <img>
 967                  * This produces a compact URL with an opaque reference to the file,
 968                  * which we can reference immediately.
 969                  *
 970                  * - Firefox 3.6.6: no
 971                  * - Firefox 4.0b7: no
 972                  * - Safari 5.0.2: no
 973                  * - Chrome 8.0.552.210: works!
 974                  */
 975                 blobAsDataURL = function(blob, callback) {
 976                     callback(window.createObjectURL(blob));
 977                 }
 978             } else if (typeof window.FileReader != "undefined") {
 979                 /**
 980                  * FileAPI's FileReader can build a data URL from a blob's contents,
 981                  * but it must read the file and build it asynchronously. This means
 982                  * we'll be passing a giant data URL around, which may be inefficient.
 983                  *
 984                  * - Firefox 3.6.6: works!
 985                  * - Firefox 4.0b7: works!
 986                  * - Safari 5.0.2: no
 987                  * - Chrome 8.0.552.210: works!
 988                  */
 989                 blobAsDataURL = function(blob, callback) {
 990                     var reader = new FileReader();
 991                     reader.onload = function(event) {
 992                         callback(reader.result);
 993                     }
 994                     reader.readAsDataURL(blob);
 995                 }
 996             } else {
 997                 preview = false;
 998             }
 999
1000             var imageTypes = ['image/png', 'image/jpeg', 'image/gif', 'image/svg+xml'];
1001             if ($.inArray(file.type, imageTypes) == -1) {
1002                 // We probably don't know how to show the file.
1003                 preview = false;
1004             }
1005
1006             var maxSize = 8 * 1024 * 1024;
1007             if (file.size > maxSize) {
1008                 // Don't kill the browser trying to load some giant image.
1009                 preview = false;
1010             }
1011
1012             if (preview) {
1013                 blobAsDataURL(file, function(url) {
1014                     var img = $('<img>')
1015                         .attr('title', tooltip)
1016                         .attr('alt', tooltip)
1017                         .attr('src', url)
1018                         .attr('style', 'height: 120px');
1019                     form.find('.attach-status').append(img);
1020                 });
1021             } else {
1022                 var img = $('<div></div>').text(tooltip);
1023                 form.find('.attach-status').append(img);
1024             }
1025         },
1026
1027         /**
1028          * Setup function -- DOES NOT trigger actions immediately.
1029          *
1030          * Initializes state for the location-lookup features in the
1031          * new-notice form. Seems to set up some event handlers for
1032          * triggering lookups and using the new values.
1033          *
1034          * @param {jQuery} form
1035          *
1036          * @fixme tl;dr
1037          * @fixme there's not good visual state update here, so users have a
1038          *        hard time figuring out if it's working or fixing if it's wrong.
1039          *
1040          */
1041         NoticeLocationAttach: function(form) {
1042             // @fixme this should not be tied to the main notice form, as there may be multiple notice forms...
1043             var NLat = form.find('[name=lat]')
1044             var NLon = form.find('[name=lon]')
1045             var NLNS = form.find('[name=location_ns]').val();
1046             var NLID = form.find('[name=location_id]').val();
1047             var NLN = ''; // @fixme
1048             var NDGe = form.find('[name=notice_data-geo]');
1049             var check = form.find('[name=notice_data-geo]');
1050             var label = form.find('label.notice_data-geo');
1051
1052             function removeNoticeDataGeo(error) {
1053                 label
1054                     .attr('title', jQuery.trim(label.text()))
1055                     .removeClass('checked');
1056
1057                 form.find('[name=lat]').val('');
1058                 form.find('[name=lon]').val('');
1059                 form.find('[name=location_ns]').val('');
1060                 form.find('[name=location_id]').val('');
1061                 form.find('[name=notice_data-geo]').attr('checked', false);
1062
1063                 $.cookie(SN.C.S.NoticeDataGeoCookie, 'disabled', { path: '/' });
1064
1065                 if (error) {
1066                     form.find('.geo_status_wrapper').removeClass('success').addClass('error');
1067                     form.find('.geo_status_wrapper .geo_status').text(error);
1068                 } else {
1069                     form.find('.geo_status_wrapper').remove();
1070                 }
1071             }
1072
1073             function getJSONgeocodeURL(geocodeURL, data) {
1074                 SN.U.NoticeGeoStatus(form, 'Looking up place name...');
1075                 $.getJSON(geocodeURL, data, function(location) {
1076                     var lns, lid;
1077
1078                     if (typeof(location.location_ns) != 'undefined') {
1079                         form.find('[name=location_ns]').val(location.location_ns);
1080                         lns = location.location_ns;
1081                     }
1082
1083                     if (typeof(location.location_id) != 'undefined') {
1084                         form.find('[name=location_id]').val(location.location_id);
1085                         lid = location.location_id;
1086                     }
1087
1088                     if (typeof(location.name) == 'undefined') {
1089                         NLN_text = data.lat + ';' + data.lon;
1090                     }
1091                     else {
1092                         NLN_text = location.name;
1093                     }
1094
1095                     SN.U.NoticeGeoStatus(form, NLN_text, data.lat, data.lon, location.url);
1096                     label
1097                         .attr('title', NoticeDataGeo_text.ShareDisable + ' (' + NLN_text + ')');
1098
1099                     form.find('[name=lat]').val(data.lat);
1100                     form.find('[name=lon]').val(data.lon);
1101                     form.find('[name=location_ns]').val(lns);
1102                     form.find('[name=location_id]').val(lid);
1103                     form.find('[name=notice_data-geo]').attr('checked', true);
1104
1105                     var cookieValue = {
1106                         NLat: data.lat,
1107                         NLon: data.lon,
1108                         NLNS: lns,
1109                         NLID: lid,
1110                         NLN: NLN_text,
1111                         NLNU: location.url,
1112                         NDG: true
1113                     };
1114
1115                     $.cookie(SN.C.S.NoticeDataGeoCookie, JSON.stringify(cookieValue), { path: '/' });
1116                 });
1117             }
1118
1119             if (check.length > 0) {
1120                 if ($.cookie(SN.C.S.NoticeDataGeoCookie) == 'disabled') {
1121                     check.attr('checked', false);
1122                 }
1123                 else {
1124                     check.attr('checked', true);
1125                 }
1126
1127                 var NGW = form.find('.notice_data-geo_wrap');
1128                 var geocodeURL = NGW.attr('data-api');
1129
1130                 label
1131                     .attr('title', label.text());
1132
1133                 check.change(function() {
1134                     if (check.attr('checked') === true || $.cookie(SN.C.S.NoticeDataGeoCookie) === null) {
1135                         label
1136                             .attr('title', NoticeDataGeo_text.ShareDisable)
1137                             .addClass('checked');
1138
1139                         if ($.cookie(SN.C.S.NoticeDataGeoCookie) === null || $.cookie(SN.C.S.NoticeDataGeoCookie) == 'disabled') {
1140                             if (navigator.geolocation) {
1141                                 SN.U.NoticeGeoStatus(form, 'Requesting location from browser...');
1142                                 navigator.geolocation.getCurrentPosition(
1143                                     function(position) {
1144                                         form.find('[name=lat]').val(position.coords.latitude);
1145                                         form.find('[name=lon]').val(position.coords.longitude);
1146
1147                                         var data = {
1148                                             lat: position.coords.latitude,
1149                                             lon: position.coords.longitude,
1150                                             token: $('#token').val()
1151                                         };
1152
1153                                         getJSONgeocodeURL(geocodeURL, data);
1154                                     },
1155
1156                                     function(error) {
1157                                         switch(error.code) {
1158                                             case error.PERMISSION_DENIED:
1159                                                 removeNoticeDataGeo('Location permission denied.');
1160                                                 break;
1161                                             case error.TIMEOUT:
1162                                                 //$('#'+SN.C.S.NoticeDataGeo).attr('checked', false);
1163                                                 removeNoticeDataGeo('Location lookup timeout.');
1164                                                 break;
1165                                         }
1166                                     },
1167
1168                                     {
1169                                         timeout: 10000
1170                                     }
1171                                 );
1172                             }
1173                             else {
1174                                 if (NLat.length > 0 && NLon.length > 0) {
1175                                     var data = {
1176                                         lat: NLat,
1177                                         lon: NLon,
1178                                         token: $('#token').val()
1179                                     };
1180
1181                                     getJSONgeocodeURL(geocodeURL, data);
1182                                 }
1183                                 else {
1184                                     removeNoticeDataGeo();
1185                                     check.remove();
1186                                     label.remove();
1187                                 }
1188                             }
1189                         }
1190                         else {
1191                             var cookieValue = JSON.parse($.cookie(SN.C.S.NoticeDataGeoCookie));
1192
1193                             form.find('[name=lat]').val(cookieValue.NLat);
1194                             form.find('[name=lon]').val(cookieValue.NLon);
1195                             form.find('[name=location_ns]').val(cookieValue.NLNS);
1196                             form.find('[name=location_id]').val(cookieValue.NLID);
1197                             form.find('[name=notice_data-geo]').attr('checked', cookieValue.NDG);
1198
1199                             SN.U.NoticeGeoStatus(form, cookieValue.NLN, cookieValue.NLat, cookieValue.NLon, cookieValue.NLNU);
1200                             label
1201                                 .attr('title', NoticeDataGeo_text.ShareDisable + ' (' + cookieValue.NLN + ')')
1202                                 .addClass('checked');
1203                         }
1204                     }
1205                     else {
1206                         removeNoticeDataGeo();
1207                     }
1208                 }).change();
1209             }
1210         },
1211
1212         /**
1213          * Create or update a geolocation status widget in this notice posting form.
1214          *
1215          * @param {jQuery} form
1216          * @param {String} status
1217          * @param {String} lat (optional)
1218          * @param {String} lon (optional)
1219          * @param {String} url (optional)
1220          */
1221         NoticeGeoStatus: function(form, status, lat, lon, url)
1222         {
1223             var wrapper = form.find('.geo_status_wrapper');
1224             if (wrapper.length == 0) {
1225                 wrapper = $('<div class="'+SN.C.S.Success+' geo_status_wrapper"><button class="close" style="float:right">&#215;</button><div class="geo_status"></div></div>');
1226                 wrapper.find('button.close').click(function() {
1227                     form.find('[name=notice_data-geo]').removeAttr('checked').change();
1228                     return false;
1229                 });
1230                 form.append(wrapper);
1231             }
1232             var label;
1233             if (url) {
1234                 label = $('<a></a>').attr('href', url);
1235             } else {
1236                 label = $('<span></span>');
1237             }
1238             label.text(status);
1239             if (lat || lon) {
1240                 var latlon = lat + ';' + lon;
1241                 label.attr('title', latlon);
1242                 if (!status) {
1243                     label.text(latlon)
1244                 }
1245             }
1246             wrapper.find('.geo_status').empty().append(label);
1247         },
1248
1249         /**
1250          * Setup function -- DOES NOT trigger actions immediately.
1251          *
1252          * Initializes event handlers for the "Send direct message" link on
1253          * profile pages, setting it up to display a dialog box when clicked.
1254          *
1255          * Unlike the repeat confirmation form, this appears to fetch
1256          * the form _from the original link target_, so the form itself
1257          * doesn't need to be in the current document.
1258          *
1259          * @fixme breaks ability to open link in new window?
1260          */
1261         NewDirectMessage: function() {
1262             NDM = $('.entity_send-a-message a');
1263             NDM.attr({'href':NDM.attr('href')+'&ajax=1'});
1264             NDM.bind('click', function() {
1265                 var NDMF = $('.entity_send-a-message form');
1266                 if (NDMF.length === 0) {
1267                     $(this).addClass(SN.C.S.Processing);
1268                     $.get(NDM.attr('href'), null, function(data) {
1269                         $('.entity_send-a-message').append($('form', $(data).children()));
1270                         NDMF = $('.entity_send-a-message .form_notice');
1271                         SN.U.FormNoticeXHR(NDMF);
1272                         SN.U.FormNoticeEnhancements(NDMF);
1273                         NDMF.append('<button class="close">&#215;</button>');
1274                         $('.entity_send-a-message button').click(function(){
1275                             NDMF.hide();
1276                             return false;
1277                         });
1278                         NDM.removeClass(SN.C.S.Processing);
1279                     }, 'xml');
1280                 }
1281                 else {
1282                     NDMF.show();
1283                     $('.entity_send-a-message textarea').focus();
1284                 }
1285                 return false;
1286             });
1287         },
1288
1289         /**
1290          * Return a date object with the current local time on the
1291          * given year, month, and day.
1292          *
1293          * @param {number} year: 4-digit year
1294          * @param {number} month: 0 == January
1295          * @param {number} day: 1 == 1
1296          * @return {Date}
1297          */
1298         GetFullYear: function(year, month, day) {
1299             var date = new Date();
1300             date.setFullYear(year, month, day);
1301
1302             return date;
1303         },
1304
1305         /**
1306          * Some sort of object interface for storing some structured
1307          * information in a cookie.
1308          *
1309          * Appears to be used to save the last-used login nickname?
1310          * That's something that browsers usually take care of for us
1311          * these days, do we really need to do it? Does anything else
1312          * use this interface?
1313          *
1314          * @fixme what is this?
1315          * @fixme should this use non-cookie local storage when available?
1316          */
1317         StatusNetInstance: {
1318             /**
1319              * @fixme what is this?
1320              */
1321             Set: function(value) {
1322                 var SNI = SN.U.StatusNetInstance.Get();
1323                 if (SNI !== null) {
1324                     value = $.extend(SNI, value);
1325                 }
1326
1327                 $.cookie(
1328                     SN.C.S.StatusNetInstance,
1329                     JSON.stringify(value),
1330                     {
1331                         path: '/',
1332                         expires: SN.U.GetFullYear(2029, 0, 1)
1333                     });
1334             },
1335
1336             /**
1337              * @fixme what is this?
1338              */
1339             Get: function() {
1340                 var cookieValue = $.cookie(SN.C.S.StatusNetInstance);
1341                 if (cookieValue !== null) {
1342                     return JSON.parse(cookieValue);
1343                 }
1344                 return null;
1345             },
1346
1347             /**
1348              * @fixme what is this?
1349              */
1350             Delete: function() {
1351                 $.cookie(SN.C.S.StatusNetInstance, null);
1352             }
1353         },
1354
1355         /**
1356          * Check if the current page is a timeline where the current user's
1357          * posts should be displayed immediately on success.
1358          *
1359          * @fixme this should be done in a saner way, with machine-readable
1360          * info about what page we're looking at.
1361          *
1362          * @param {DOMElement} notice: HTML chunk with formatted notice
1363          * @return boolean
1364          */
1365         belongsOnTimeline: function(notice) {
1366             var action = $("body").attr('id');
1367             if (action == 'public') {
1368                 return true;
1369             }
1370
1371             var profileLink = $('#nav_profile a').attr('href');
1372             if (profileLink) {
1373                 var authorUrl = $(notice).find('.vcard.author a.url').attr('href');
1374                 if (authorUrl == profileLink) {
1375                     if (action == 'all' || action == 'showstream') {
1376                         // Posts always show on your own friends and profile streams.
1377                         return true;
1378                     }
1379                 }
1380             }
1381
1382             // @fixme tag, group, reply timelines should be feasible as well.
1383             // Mismatch between id-based and name-based user/group links currently complicates
1384             // the lookup, since all our inline mentions contain the absolute links but the
1385             // UI links currently on the page use malleable names.
1386
1387             return false;
1388         },
1389
1390         /**
1391          * Switch to another active input sub-form.
1392          * This will hide the current form (if any), show the new one, and
1393          * update the input type tab selection state.
1394          *
1395          * @param {String} tag
1396          */
1397         switchInputFormTab: function(tag) {
1398             // The one that's current isn't current anymore
1399             $('.input_form_nav_tab.current').removeClass('current');
1400             if (tag == 'placeholder') {
1401                 // Hack: when showing the placeholder, mark the tab
1402                 // as current for 'Status'.
1403                 $('#input_form_nav_status').addClass('current');
1404             } else {
1405                 $('#input_form_nav_'+tag).addClass('current');
1406             }
1407
1408             // Don't remove 'current' if we also have the "nonav" class.
1409             // An example would be the message input form. removing
1410             // 'current' will cause the form to vanish from the page.
1411             var nonav = $('.input_form.current.nonav');
1412             if (nonav.length > 0) {
1413                 return;
1414             }
1415
1416             $('.input_form.current').removeClass('current');
1417             $('#input_form_'+tag)
1418                 .addClass('current')
1419                 .find('.ajax-notice').each(function() {
1420                     var form = $(this);
1421                     SN.Init.NoticeFormSetup(form);
1422                 })
1423                 .find('.notice_data-text').focus();
1424         }
1425     },
1426
1427     Init: {
1428         /**
1429          * If user is logged in, run setup code for the new notice form:
1430          *
1431          *  - char counter
1432          *  - AJAX submission
1433          *  - location events
1434          *  - file upload events
1435          */
1436         NoticeForm: function() {
1437             if ($('body.user_in').length > 0) {
1438                 // SN.Init.NoticeFormSetup() will get run
1439                 // when forms get displayed for the first time...
1440
1441                 // Hack to initialize the placeholder at top
1442                 $('#input_form_placeholder input.placeholder').focus(function() {
1443                     SN.U.switchInputFormTab("status");
1444                 });
1445
1446                 // Make inline reply forms self-close when clicking out.
1447                 $('body').bind('click', function(e) {
1448                     var currentForm = $('#content .input_forms div.current');
1449                     if (currentForm.length > 0) {
1450                         if ($('#content .input_forms').has(e.target).length == 0) {
1451                             // If all fields are empty, switch back to the placeholder.
1452                             var fields = currentForm.find('textarea, input[type=text], input[type=""]');
1453                             var anything = false;
1454                             fields.each(function() {
1455                                 anything = anything || $(this).val();
1456                             });
1457                             if (!anything) {
1458                                 SN.U.switchInputFormTab("placeholder");
1459                             }
1460                         }
1461                     }
1462
1463                     var openReplies = $('li.notice-reply');
1464                     if (openReplies.length > 0) {
1465                         var target = $(e.target);
1466                         openReplies.each(function() {
1467                             // Did we click outside this one?
1468                             var replyItem = $(this);
1469                             if (replyItem.has(e.target).length == 0) {
1470                                 var textarea = replyItem.find('.notice_data-text:first');
1471                                 var cur = $.trim(textarea.val());
1472                                 // Only close if there's been no edit.
1473                                 if (cur == '' || cur == textarea.data('initialText')) {
1474                                     var parentNotice = replyItem.closest('li.notice');
1475                                     replyItem.remove();
1476                                     parentNotice.find('li.notice-reply-placeholder').show();
1477                                 }
1478                             }
1479                         });
1480                     }
1481                 });
1482
1483                 // Infield labels for notice form inputs.
1484                 $('.input_forms fieldset fieldset label').inFieldLabels({ fadeOpacity:0 });
1485
1486             }
1487         },
1488
1489         /**
1490          * Encapsulate notice form setup for a single form.
1491          * Plugins can add extra setup by monkeypatching this
1492          * function.
1493          *
1494          * @param {jQuery} form
1495          */
1496         NoticeFormSetup: function(form) {
1497             if (!form.data('NoticeFormSetup')) {
1498                 SN.U.NoticeLocationAttach(form);
1499                 SN.U.FormNoticeXHR(form);
1500                 SN.U.FormNoticeEnhancements(form);
1501                 SN.U.NoticeDataAttach(form);
1502                 form.data('NoticeFormSetup', true);
1503             }
1504         },
1505
1506         /**
1507          * Run setup code for notice timeline views items:
1508          *
1509          * - AJAX submission for fave/repeat/reply (if logged in)
1510          * - Attachment link extras ('more' links)
1511          */
1512         Notices: function() {
1513             if ($('body.user_in').length > 0) {
1514                 var masterForm = $('.form_notice:first');
1515                 if (masterForm.length > 0) {
1516                     SN.C.I.NoticeFormMaster = masterForm;
1517                 }
1518                 SN.U.NoticeRepeat();
1519                 SN.U.NoticeReply();
1520                 SN.U.NoticeInlineReplySetup();
1521             }
1522
1523             SN.U.NoticeAttachments();
1524         },
1525
1526         /**
1527          * Run setup code for user & group profile page header area if logged in:
1528          *
1529          * - AJAX submission for sub/unsub/join/leave/nudge
1530          * - AJAX form popup for direct-message
1531          */
1532         EntityActions: function() {
1533             if ($('body.user_in').length > 0) {
1534                 $('.form_user_subscribe').live('click', function() { SN.U.FormXHR($(this)); return false; });
1535                 $('.form_user_unsubscribe').live('click', function() { SN.U.FormXHR($(this)); return false; });
1536                 $('.form_group_join').live('click', function() { SN.U.FormXHR($(this)); return false; });
1537                 $('.form_group_leave').live('click', function() { SN.U.FormXHR($(this)); return false; });
1538                 $('.form_user_nudge').live('click', function() { SN.U.FormXHR($(this)); return false; });
1539                 $('.form_peopletag_subscribe').live('click', function() { SN.U.FormXHR($(this)); return false; });
1540                 $('.form_peopletag_unsubscribe').live('click', function() { SN.U.FormXHR($(this)); return false; });
1541                 $('.form_user_add_peopletag').live('click', function() { SN.U.FormXHR($(this)); return false; });
1542                 $('.form_user_remove_peopletag').live('click', function() { SN.U.FormXHR($(this)); return false; });
1543
1544                 SN.U.NewDirectMessage();
1545             }
1546         },
1547
1548         ProfileSearch: function() {
1549             if ($('body.user_in').length > 0) {
1550                 $('.form_peopletag_edit_user_search input.submit').live('click', function() {
1551                     SN.U.FormProfileSearchXHR($(this).parents('form')); return false;
1552                 });
1553             }
1554         },
1555
1556         /**
1557          * Run setup code for login form:
1558          *
1559          * - loads saved last-used-nickname from cookie
1560          * - sets event handler to save nickname to cookie on submit
1561          *
1562          * @fixme is this necessary? Browsers do their own form saving these days.
1563          */
1564         Login: function() {
1565             if (SN.U.StatusNetInstance.Get() !== null) {
1566                 var nickname = SN.U.StatusNetInstance.Get().Nickname;
1567                 if (nickname !== null) {
1568                     $('#form_login #nickname').val(nickname);
1569                 }
1570             }
1571
1572             $('#form_login').bind('submit', function() {
1573                 SN.U.StatusNetInstance.Set({Nickname: $('#form_login #nickname').val()});
1574                 return true;
1575             });
1576         },
1577
1578         /**
1579          * Called when a people tag edit box is shown in the interface
1580          *
1581          * - loads the jQuery UI autocomplete plugin
1582          * - sets event handlers for tag completion
1583          *
1584          */
1585         PeopletagAutocomplete: function(txtBox) {
1586             var split = function(val) {
1587                 return val.split( /\s+/ );
1588             }
1589             var extractLast = function(term) {
1590                 return split(term).pop();
1591             }
1592
1593             // don't navigate away from the field on tab when selecting an item
1594             txtBox.live( "keydown", function( event ) {
1595                 if ( event.keyCode === $.ui.keyCode.TAB &&
1596                         $(this).data( "autocomplete" ).menu.active ) {
1597                     event.preventDefault();
1598                 }
1599             }).autocomplete({
1600                 minLength: 0,
1601                 source: function(request, response) {
1602                             // delegate back to autocomplete, but extract the last term
1603                             response($.ui.autocomplete.filter(
1604                                     SN.C.PtagACData, extractLast(request.term)));
1605                     },
1606                     focus: function() {
1607                         return false;
1608                 },
1609                     select: function(event, ui) {
1610                             var terms = split(this.value);
1611                             terms.pop();
1612                             terms.push(ui.item.value);
1613                             terms.push("");
1614                             this.value = terms.join(" ");
1615                             return false;
1616                     }
1617             }).data('autocomplete')._renderItem = function(ul, item) {
1618                     // FIXME: with jQuery UI you cannot have it highlight the match
1619                     var _l = '<a class="ptag-ac-line-tag">' + item.tag
1620                           + ' <em class="privacy_mode">' + item.mode + '</em>'
1621                           + '<span class="freq">' + item.freq + '</span></a>'
1622
1623                             return $("<li/>")
1624                                 .addClass('mode-' + item.mode)
1625                             .addClass('ptag-ac-line')
1626                             .data("item.autocomplete", item)
1627                             .append(_l)
1628                             .appendTo(ul);
1629                     }
1630         },
1631
1632         /**
1633          * Run setup for the ajax people tags editor
1634          *
1635          * - show edit button
1636          * - set event handle for click on edit button
1637          *   - loads people tag autocompletion data if not already present
1638          *     or if it is stale.
1639          *
1640          */
1641         PeopleTags: function() {
1642             $('.user_profile_tags .editable').append($('<button class="peopletags_edit_button"/>'));
1643
1644             $('.peopletags_edit_button').live('click', function() {
1645                 var form = $(this).parents('dd').eq(0).find('form');
1646                 // We can buy time from the above animation
1647
1648                 $.ajax({
1649                     url: _peopletagAC,
1650                     dataType: 'json',
1651                     data: {token: $('#token').val()},
1652                     ifModified: true,
1653                     success: function(data) {
1654                         // item.label is used to match
1655                         for (i=0; i < data.length; i++) {
1656                             data[i].label = data[i].tag;
1657                         }
1658
1659                         SN.C.PtagACData = data;
1660                         SN.Init.PeopletagAutocomplete(form.find('#tags'));
1661                     }
1662                 });
1663
1664                 $(this).parents('ul').eq(0).fadeOut(200, function() {form.fadeIn(200).find('input#tags')});
1665             });
1666
1667             $('.user_profile_tags form .submit').live('click', function() {
1668                 SN.U.FormPeopletagsXHR($(this).parents('form')); return false;
1669             });
1670         },
1671
1672         /**
1673          * Set up any generic 'ajax' form so it submits via AJAX with auto-replacement.
1674          */
1675         AjaxForms: function() {
1676             $('form.ajax').live('submit', function() {
1677                 SN.U.FormXHR($(this));
1678                 return false;
1679             });
1680             $('form.ajax input[type=submit]').live('click', function() {
1681                 // Some forms rely on knowing which submit button was clicked.
1682                 // Save a hidden input field which'll be picked up during AJAX
1683                 // submit...
1684                 var button = $(this);
1685                 var form = button.closest('form');
1686                 form.find('.hidden-submit-button').remove();
1687                 $('<input class="hidden-submit-button" type="hidden" />')
1688                     .attr('name', button.attr('name'))
1689                     .val(button.val())
1690                     .appendTo(form);
1691             });
1692         },
1693
1694         /**
1695          * Add logic to any file upload forms to handle file size limits,
1696          * on browsers that support basic FileAPI.
1697          */
1698         UploadForms: function () {
1699             $('input[type=file]').change(function(event) {
1700                 if (typeof this.files == "object" && this.files.length > 0) {
1701                     var size = 0;
1702                     for (var i = 0; i < this.files.length; i++) {
1703                         size += this.files[i].size;
1704                     }
1705
1706                     var max = SN.U.maxFileSize($(this.form));
1707                     if (max > 0 && size > max) {
1708                         var msg = 'File too large: maximum upload size is %d bytes.';
1709                         alert(msg.replace('%d', max));
1710
1711                         // Clear the files.
1712                         $(this).val('');
1713                         event.preventDefault();
1714                         return false;
1715                     }
1716                 }
1717             });
1718         },
1719
1720         CheckBoxes: function() {
1721             $("span[class='checkbox-wrapper']").addClass("unchecked");
1722             $(".checkbox-wrapper").click(function(){
1723                 if($(this).children("input").attr("checked")){
1724                     // uncheck
1725                     $(this).children("input").attr({checked: ""});
1726                     $(this).removeClass("checked");
1727                     $(this).addClass("unchecked");
1728                     $(this).children("label").text("Private?");
1729                 }else{
1730                     // check
1731                     $(this).children("input").attr({checked: "checked"});
1732                     $(this).removeClass("unchecked");
1733                     $(this).addClass("checked");
1734                     $(this).children("label").text("Private");
1735                 }
1736             });
1737         }
1738     }
1739 };
1740
1741 /**
1742  * Run initialization functions on DOM-ready.
1743  *
1744  * Note that if we're waiting on other scripts to load, this won't happen
1745  * until that's done. To load scripts asynchronously without delaying setup,
1746  * don't start them loading until after DOM-ready time!
1747  */
1748 $(document).ready(function(){
1749     SN.Init.AjaxForms();
1750     SN.Init.UploadForms();
1751     SN.Init.CheckBoxes();
1752     if ($('.'+SN.C.S.FormNotice).length > 0) {
1753         SN.Init.NoticeForm();
1754     }
1755     if ($('#content .notices').length > 0) {
1756         SN.Init.Notices();
1757     }
1758     if ($('#content .entity_actions').length > 0) {
1759         SN.Init.EntityActions();
1760     }
1761     if ($('#form_login').length > 0) {
1762         SN.Init.Login();
1763     }
1764     if ($('#profile_search_results').length > 0) {
1765         SN.Init.ProfileSearch();
1766     }
1767     if ($('.user_profile_tags .editable').length > 0) {
1768         SN.Init.PeopleTags();
1769     }
1770 });
1771