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