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 = document._importNode($('form', data)[0], true);
 277                         form.replaceWith(form_new);
 278                         if (onSuccess) {
 279                             onSuccess();
 280                         }
 281                     }
 282                     else if (typeof($('p', data)[0]) != 'undefined') {
 283                         form.replaceWith(document._importNode($('p', data)[0], true));
 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 = document._importNode($('ul', data)[0], true);
 506                         results_placeholder.replaceWith(list);
 507                     }
 508                     else {
 509                         var _error = $('<li/>').append(document._importNode($('p', data)[0], true));
 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 = document._importNode($('.entity_tags', data)[0], true);
 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(document._importNode($('p', data)[0], true));
 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                 }
 656             }
 657
 658             // See if the form's already open...
 659             var replyForm = $('.notice-reply-form', list);
 660
 661             var nextStep = function() {
 662                 // Override...?
 663                 replyForm.find('input[name=inreplyto]').val(id);
 664                 replyForm.find('#notice_to').attr('disabled', 'disabled').hide();
 665                 replyForm.find('#notice_private').attr('disabled', 'disabled').hide();
 666                 replyForm.find('label[for=notice_to]').hide();
 667                 replyForm.find('label[for=notice_private]').hide();
 668
 669                 // Set focus...
 670                 var text = replyForm.find('textarea');
 671                 if (text.length == 0) {
 672                     throw "No textarea";
 673                 }
 674                 var replyto = '';
 675                 if (initialText) {
 676                     replyto = initialText + ' ';
 677                 }
 678                 text.val(replyto + text.val().replace(RegExp(replyto, 'i'), ''));
 679                 text.data('initialText', $.trim(initialText + ''));
 680                 text.focus();
 681                 if (text[0].setSelectionRange) {
 682                     var len = text.val().length;
 683                     text[0].setSelectionRange(len,len);
 684                 }
 685             };
 686             if (replyForm.length > 0) {
 687                 // Update the existing form...
 688                 nextStep();
 689             } else {
 690                 // Hide the placeholder...
 691                 var placeholder = list.find('li.notice-reply-placeholder').hide();
 692
 693                 // Create the reply form entry at the end
 694                 var replyItem = $('li.notice-reply', list);
 695                 if (replyItem.length == 0) {
 696                     replyItem = $('<li class="notice-reply"></li>');
 697
 698                     var intermediateStep = function(formMaster) {
 699                         var formEl = document._importNode(formMaster, true);
 700                         replyItem.append(formEl);
 701                         list.append(replyItem); // *after* the placeholder
 702
 703                         var form = replyForm = $(formEl);
 704                         SN.Init.NoticeFormSetup(form);
 705
 706                         nextStep();
 707                     };
 708                     if (SN.C.I.NoticeFormMaster) {
 709                         // We've already saved a master copy of the form.
 710                         // Clone it in!
 711                         intermediateStep(SN.C.I.NoticeFormMaster);
 712                     } else {
 713                         // Fetch a fresh copy of the notice form over AJAX.
 714                         // Warning: this can have a delay, which looks bad.
 715                         // @fixme this fallback may or may not work
 716                         var url = $('#form_notice').attr('action');
 717                         $.get(url, {ajax: 1}, function(data, textStatus, xhr) {
 718                             intermediateStep($('form', data)[0]);
 719                         });
 720                     }
 721                 }
 722             }
 723         },
 724
 725         NoticeInlineReplyPlaceholder: function(notice) {
 726             var list = notice.find('ul.threaded-replies');
 727             if (list.length == 0) {
 728                 list = $('<ul class="notices threaded-replies xoxo"></ul>');
 729                 notice.append(list);
 730                 list = notice.find('ul.threaded-replies');
 731             }
 732             var placeholder = $('<li class="notice-reply-placeholder">' +
 733                                     '<input class="placeholder">' +
 734                                 '</li>');
 735             placeholder.find('input')
 736                 .val(SN.msg('reply_placeholder'));
 737             list.append(placeholder);
 738         },
 739
 740         /**
 741          * Setup function -- DOES NOT apply immediately.
 742          *
 743          * Sets up event handlers for inline reply mini-form placeholders.
 744          * Uses 'live' rather than 'bind', so applies to future as well as present items.
 745          */
 746         NoticeInlineReplySetup: function() {
 747             $('li.notice-reply-placeholder input')
 748                 .live('focus', function() {
 749                     var notice = $(this).closest('li.notice');
 750                     SN.U.NoticeInlineReplyTrigger(notice);
 751                     return false;
 752                 });
 753             $('li.notice-reply-comments a')
 754                 .live('click', function() {
 755                     var url = $(this).attr('href');
 756                     var area = $(this).closest('.threaded-replies');
 757                     $.get(url, {ajax: 1}, function(data, textStatus, xhr) {
 758                         var replies = $('.threaded-replies', data);
 759                         if (replies.length) {
 760                             area.replaceWith(document._importNode(replies[0], true));
 761                         }
 762                     });
 763                     return false;
 764                 });
 765         },
 766
 767         /**
 768          * Setup function -- DOES NOT trigger actions immediately.
 769          *
 770          * Sets up event handlers for repeat forms to toss up a confirmation
 771          * popout before submitting.
 772          *
 773          * Uses 'live' rather than 'bind', so applies to future as well as present items.
 774          */
 775         NoticeRepeat: function() {
 776             $('.form_repeat').live('click', function(e) {
 777                 e.preventDefault();
 778
 779                 SN.U.NoticeRepeatConfirmation($(this));
 780                 return false;
 781             });
 782         },
 783
 784         /**
 785          * Shows a confirmation dialog box variant of the repeat button form.
 786          * This seems to use a technique where the repeat form contains
 787          * _both_ a standalone button _and_ text and buttons for a dialog.
 788          * The dialog will close after its copy of the form is submitted,
 789          * or if you click its 'close' button.
 790          *
 791          * The dialog is created by duplicating the original form and changing
 792          * its style; while clever, this is hard to generalize and probably
 793          * duplicates a lot of unnecessary HTML output.
 794          *
 795          * @fixme create confirmation dialogs through a generalized interface
 796          * that can be reused instead of hardcoded text and styles.
 797          *
 798          * @param {jQuery} form
 799          */
 800         NoticeRepeatConfirmation: function(form) {
 801             var submit_i = form.find('.submit');
 802
 803             var submit = submit_i.clone();
 804             submit
 805                 .addClass('submit_dialogbox')
 806                 .removeClass('submit');
 807             form.append(submit);
 808             submit.bind('click', function() { SN.U.FormXHR(form); return false; });
 809
 810             submit_i.hide();
 811
 812             form
 813                 .addClass('dialogbox')
 814                 .append('<button class="close">&#215;</button>')
 815                 .closest('.notice-options')
 816                     .addClass('opaque');
 817
 818             form.find('button.close').click(function(){
 819                 $(this).remove();
 820
 821                 form
 822                     .removeClass('dialogbox')
 823                     .closest('.notice-options')
 824                         .removeClass('opaque');
 825
 826                 form.find('.submit_dialogbox').remove();
 827                 form.find('.submit').show();
 828
 829                 return false;
 830             });
 831         },
 832
 833         /**
 834          * Setup function -- DOES NOT trigger actions immediately.
 835          *
 836          * Goes through all notices currently displayed and sets up attachment
 837          * handling if needed.
 838          */
 839         NoticeAttachments: function() {
 840             $('.notice a.attachment').each(function() {
 841                 SN.U.NoticeWithAttachment($(this).closest('.notice'));
 842             });
 843         },
 844
 845         /**
 846          * Setup function -- DOES NOT trigger actions immediately.
 847          *
 848          * Sets up special attachment link handling if needed. Currently this
 849          * consists only of making the "more" button used for OStatus message
 850          * cropping turn into an auto-expansion button that loads the full
 851          * text from an attachment file.
 852          *
 853          * @param {jQuery} notice
 854          */
 855         NoticeWithAttachment: function(notice) {
 856             if (notice.find('.attachment').length === 0) {
 857                 return;
 858             }
 859
 860             var attachment_more = notice.find('.attachment.more');
 861             if (attachment_more.length > 0) {
 862                 $(attachment_more[0]).click(function() {
 863                     var m = $(this);
 864                     m.addClass(SN.C.S.Processing);
 865                     $.get(m.attr('href')+'/ajax', null, function(data) {
 866                         m.parent('.entry-content').html($(data).find('#attachment_view .entry-content').html());
 867                     });
 868
 869                     return false;
 870                 }).attr('title', SN.msg('showmore_tooltip'));
 871             }
 872         },
 873
 874         /**
 875          * Setup function -- DOES NOT trigger actions immediately.
 876          *
 877          * Sets up event handlers for the file-attachment widget in the
 878          * new notice form. When a file is selected, a box will be added
 879          * below the text input showing the filename and, if supported
 880          * by the browser, a thumbnail preview.
 881          *
 882          * This preview box will also allow removing the attachment
 883          * prior to posting.
 884          *
 885          * @param {jQuery} form
 886          */
 887         NoticeDataAttach: function(form) {
 888             var NDA = form.find('input[type=file]');
 889             NDA.change(function(event) {
 890                 form.find('.attach-status').remove();
 891
 892                 var filename = $(this).val();
 893                 if (!filename) {
 894                     // No file -- we've been tricked!
 895                     return false;
 896                 }
 897
 898                 var attachStatus = $('<div class="attach-status '+SN.C.S.Success+'"><code></code> <button class="close">&#215;</button></div>');
 899                 attachStatus.find('code').text(filename);
 900                 attachStatus.find('button').click(function(){
 901                     attachStatus.remove();
 902                     NDA.val('');
 903
 904                     return false;
 905                 });
 906                 form.append(attachStatus);
 907
 908                 if (typeof this.files == "object") {
 909                     // Some newer browsers will let us fetch the files for preview.
 910                     for (var i = 0; i < this.files.length; i++) {
 911                         SN.U.PreviewAttach(form, this.files[i]);
 912                     }
 913                 }
 914             });
 915         },
 916
 917         /**
 918          * Get PHP's MAX_FILE_SIZE setting for this form;
 919          * used to apply client-side file size limit checks.
 920          *
 921          * @param {jQuery} form
 922          * @return int max size in bytes; 0 or negative means no limit
 923          */
 924         maxFileSize: function(form) {
 925             var max = $(form).find('input[name=MAX_FILE_SIZE]').attr('value');
 926             if (max) {
 927                 return parseInt(max);
 928             } else {
 929                 return 0;
 930             }
 931         },
 932
 933         /**
 934          * For browsers with FileAPI support: make a thumbnail if possible,
 935          * and append it into the attachment display widget.
 936          *
 937          * Known good:
 938          * - Firefox 3.6.6, 4.0b7
 939          * - Chrome 8.0.552.210
 940          *
 941          * Known ok metadata, can't get contents:
 942          * - Safari 5.0.2
 943          *
 944          * Known fail:
 945          * - Opera 10.63, 11 beta (no input.files interface)
 946          *
 947          * @param {jQuery} form
 948          * @param {File} file
 949          *
 950          * @todo use configured thumbnail size
 951          * @todo detect pixel size?
 952          * @todo should we render a thumbnail to a canvas and then use the smaller image?
 953          */
 954         PreviewAttach: function(form, file) {
 955             var tooltip = file.type + ' ' + Math.round(file.size / 1024) + 'KB';
 956             var preview = true;
 957
 958             var blobAsDataURL;
 959             if (typeof window.createObjectURL != "undefined") {
 960                 /**
 961                  * createObjectURL lets us reference the file directly from an <img>
 962                  * This produces a compact URL with an opaque reference to the file,
 963                  * which we can reference immediately.
 964                  *
 965                  * - Firefox 3.6.6: no
 966                  * - Firefox 4.0b7: no
 967                  * - Safari 5.0.2: no
 968                  * - Chrome 8.0.552.210: works!
 969                  */
 970                 blobAsDataURL = function(blob, callback) {
 971                     callback(window.createObjectURL(blob));
 972                 }
 973             } else if (typeof window.FileReader != "undefined") {
 974                 /**
 975                  * FileAPI's FileReader can build a data URL from a blob's contents,
 976                  * but it must read the file and build it asynchronously. This means
 977                  * we'll be passing a giant data URL around, which may be inefficient.
 978                  *
 979                  * - Firefox 3.6.6: works!
 980                  * - Firefox 4.0b7: works!
 981                  * - Safari 5.0.2: no
 982                  * - Chrome 8.0.552.210: works!
 983                  */
 984                 blobAsDataURL = function(blob, callback) {
 985                     var reader = new FileReader();
 986                     reader.onload = function(event) {
 987                         callback(reader.result);
 988                     }
 989                     reader.readAsDataURL(blob);
 990                 }
 991             } else {
 992                 preview = false;
 993             }
 994
 995             var imageTypes = ['image/png', 'image/jpeg', 'image/gif', 'image/svg+xml'];
 996             if ($.inArray(file.type, imageTypes) == -1) {
 997                 // We probably don't know how to show the file.
 998                 preview = false;
 999             }
1000
1001             var maxSize = 8 * 1024 * 1024;
1002             if (file.size > maxSize) {
1003                 // Don't kill the browser trying to load some giant image.
1004                 preview = false;
1005             }
1006
1007             if (preview) {
1008                 blobAsDataURL(file, function(url) {
1009                     var img = $('<img>')
1010                         .attr('title', tooltip)
1011                         .attr('alt', tooltip)
1012                         .attr('src', url)
1013                         .attr('style', 'height: 120px');
1014                     form.find('.attach-status').append(img);
1015                 });
1016             } else {
1017                 var img = $('<div></div>').text(tooltip);
1018                 form.find('.attach-status').append(img);
1019             }
1020         },
1021
1022         /**
1023          * Setup function -- DOES NOT trigger actions immediately.
1024          *
1025          * Initializes state for the location-lookup features in the
1026          * new-notice form. Seems to set up some event handlers for
1027          * triggering lookups and using the new values.
1028          *
1029          * @param {jQuery} form
1030          *
1031          * @fixme tl;dr
1032          * @fixme there's not good visual state update here, so users have a
1033          *        hard time figuring out if it's working or fixing if it's wrong.
1034          *
1035          */
1036         NoticeLocationAttach: function(form) {
1037             // @fixme this should not be tied to the main notice form, as there may be multiple notice forms...
1038             var NLat = form.find('[name=lat]')
1039             var NLon = form.find('[name=lon]')
1040             var NLNS = form.find('[name=location_ns]').val();
1041             var NLID = form.find('[name=location_id]').val();
1042             var NLN = ''; // @fixme
1043             var NDGe = form.find('[name=notice_data-geo]');
1044             var check = form.find('[name=notice_data-geo]');
1045             var label = form.find('label.notice_data-geo');
1046
1047             function removeNoticeDataGeo(error) {
1048                 label
1049                     .attr('title', jQuery.trim(label.text()))
1050                     .removeClass('checked');
1051
1052                 form.find('[name=lat]').val('');
1053                 form.find('[name=lon]').val('');
1054                 form.find('[name=location_ns]').val('');
1055                 form.find('[name=location_id]').val('');
1056                 form.find('[name=notice_data-geo]').attr('checked', false);
1057
1058                 $.cookie(SN.C.S.NoticeDataGeoCookie, 'disabled', { path: '/' });
1059
1060                 if (error) {
1061                     form.find('.geo_status_wrapper').removeClass('success').addClass('error');
1062                     form.find('.geo_status_wrapper .geo_status').text(error);
1063                 } else {
1064                     form.find('.geo_status_wrapper').remove();
1065                 }
1066             }
1067
1068             function getJSONgeocodeURL(geocodeURL, data) {
1069                 SN.U.NoticeGeoStatus(form, 'Looking up place name...');
1070                 $.getJSON(geocodeURL, data, function(location) {
1071                     var lns, lid;
1072
1073                     if (typeof(location.location_ns) != 'undefined') {
1074                         form.find('[name=location_ns]').val(location.location_ns);
1075                         lns = location.location_ns;
1076                     }
1077
1078                     if (typeof(location.location_id) != 'undefined') {
1079                         form.find('[name=location_id]').val(location.location_id);
1080                         lid = location.location_id;
1081                     }
1082
1083                     if (typeof(location.name) == 'undefined') {
1084                         NLN_text = data.lat + ';' + data.lon;
1085                     }
1086                     else {
1087                         NLN_text = location.name;
1088                     }
1089
1090                     SN.U.NoticeGeoStatus(form, NLN_text, data.lat, data.lon, location.url);
1091                     label
1092                         .attr('title', NoticeDataGeo_text.ShareDisable + ' (' + NLN_text + ')');
1093
1094                     form.find('[name=lat]').val(data.lat);
1095                     form.find('[name=lon]').val(data.lon);
1096                     form.find('[name=location_ns]').val(lns);
1097                     form.find('[name=location_id]').val(lid);
1098                     form.find('[name=notice_data-geo]').attr('checked', true);
1099
1100                     var cookieValue = {
1101                         NLat: data.lat,
1102                         NLon: data.lon,
1103                         NLNS: lns,
1104                         NLID: lid,
1105                         NLN: NLN_text,
1106                         NLNU: location.url,
1107                         NDG: true
1108                     };
1109
1110                     $.cookie(SN.C.S.NoticeDataGeoCookie, JSON.stringify(cookieValue), { path: '/' });
1111                 });
1112             }
1113
1114             if (check.length > 0) {
1115                 if ($.cookie(SN.C.S.NoticeDataGeoCookie) == 'disabled') {
1116                     check.attr('checked', false);
1117                 }
1118                 else {
1119                     check.attr('checked', true);
1120                 }
1121
1122                 var NGW = form.find('.notice_data-geo_wrap');
1123                 var geocodeURL = NGW.attr('data-api');
1124
1125                 label
1126                     .attr('title', label.text());
1127
1128                 check.change(function() {
1129                     if (check.attr('checked') === true || $.cookie(SN.C.S.NoticeDataGeoCookie) === null) {
1130                         label
1131                             .attr('title', NoticeDataGeo_text.ShareDisable)
1132                             .addClass('checked');
1133
1134                         if ($.cookie(SN.C.S.NoticeDataGeoCookie) === null || $.cookie(SN.C.S.NoticeDataGeoCookie) == 'disabled') {
1135                             if (navigator.geolocation) {
1136                                 SN.U.NoticeGeoStatus(form, 'Requesting location from browser...');
1137                                 navigator.geolocation.getCurrentPosition(
1138                                     function(position) {
1139                                         form.find('[name=lat]').val(position.coords.latitude);
1140                                         form.find('[name=lon]').val(position.coords.longitude);
1141
1142                                         var data = {
1143                                             lat: position.coords.latitude,
1144                                             lon: position.coords.longitude,
1145                                             token: $('#token').val()
1146                                         };
1147
1148                                         getJSONgeocodeURL(geocodeURL, data);
1149                                     },
1150
1151                                     function(error) {
1152                                         switch(error.code) {
1153                                             case error.PERMISSION_DENIED:
1154                                                 removeNoticeDataGeo('Location permission denied.');
1155                                                 break;
1156                                             case error.TIMEOUT:
1157                                                 //$('#'+SN.C.S.NoticeDataGeo).attr('checked', false);
1158                                                 removeNoticeDataGeo('Location lookup timeout.');
1159                                                 break;
1160                                         }
1161                                     },
1162
1163                                     {
1164                                         timeout: 10000
1165                                     }
1166                                 );
1167                             }
1168                             else {
1169                                 if (NLat.length > 0 && NLon.length > 0) {
1170                                     var data = {
1171                                         lat: NLat,
1172                                         lon: NLon,
1173                                         token: $('#token').val()
1174                                     };
1175
1176                                     getJSONgeocodeURL(geocodeURL, data);
1177                                 }
1178                                 else {
1179                                     removeNoticeDataGeo();
1180                                     check.remove();
1181                                     label.remove();
1182                                 }
1183                             }
1184                         }
1185                         else {
1186                             var cookieValue = JSON.parse($.cookie(SN.C.S.NoticeDataGeoCookie));
1187
1188                             form.find('[name=lat]').val(cookieValue.NLat);
1189                             form.find('[name=lon]').val(cookieValue.NLon);
1190                             form.find('[name=location_ns]').val(cookieValue.NLNS);
1191                             form.find('[name=location_id]').val(cookieValue.NLID);
1192                             form.find('[name=notice_data-geo]').attr('checked', cookieValue.NDG);
1193
1194                             SN.U.NoticeGeoStatus(form, cookieValue.NLN, cookieValue.NLat, cookieValue.NLon, cookieValue.NLNU);
1195                             label
1196                                 .attr('title', NoticeDataGeo_text.ShareDisable + ' (' + cookieValue.NLN + ')')
1197                                 .addClass('checked');
1198                         }
1199                     }
1200                     else {
1201                         removeNoticeDataGeo();
1202                     }
1203                 }).change();
1204             }
1205         },
1206
1207         /**
1208          * Create or update a geolocation status widget in this notice posting form.
1209          *
1210          * @param {jQuery} form
1211          * @param {String} status
1212          * @param {String} lat (optional)
1213          * @param {String} lon (optional)
1214          * @param {String} url (optional)
1215          */
1216         NoticeGeoStatus: function(form, status, lat, lon, url)
1217         {
1218             var wrapper = form.find('.geo_status_wrapper');
1219             if (wrapper.length == 0) {
1220                 wrapper = $('<div class="'+SN.C.S.Success+' geo_status_wrapper"><button class="close" style="float:right">&#215;</button><div class="geo_status"></div></div>');
1221                 wrapper.find('button.close').click(function() {
1222                     form.find('[name=notice_data-geo]').removeAttr('checked').change();
1223                     return false;
1224                 });
1225                 form.append(wrapper);
1226             }
1227             var label;
1228             if (url) {
1229                 label = $('<a></a>').attr('href', url);
1230             } else {
1231                 label = $('<span></span>');
1232             }
1233             label.text(status);
1234             if (lat || lon) {
1235                 var latlon = lat + ';' + lon;
1236                 label.attr('title', latlon);
1237                 if (!status) {
1238                     label.text(latlon)
1239                 }
1240             }
1241             wrapper.find('.geo_status').empty().append(label);
1242         },
1243
1244         /**
1245          * Setup function -- DOES NOT trigger actions immediately.
1246          *
1247          * Initializes event handlers for the "Send direct message" link on
1248          * profile pages, setting it up to display a dialog box when clicked.
1249          *
1250          * Unlike the repeat confirmation form, this appears to fetch
1251          * the form _from the original link target_, so the form itself
1252          * doesn't need to be in the current document.
1253          *
1254          * @fixme breaks ability to open link in new window?
1255          */
1256         NewDirectMessage: function() {
1257             NDM = $('.entity_send-a-message a');
1258             NDM.attr({'href':NDM.attr('href')+'&ajax=1'});
1259             NDM.bind('click', function() {
1260                 var NDMF = $('.entity_send-a-message form');
1261                 if (NDMF.length === 0) {
1262                     $(this).addClass(SN.C.S.Processing);
1263                     $.get(NDM.attr('href'), null, function(data) {
1264                         $('.entity_send-a-message').append(document._importNode($('form', data)[0], true));
1265                         NDMF = $('.entity_send-a-message .form_notice');
1266                         SN.U.FormNoticeXHR(NDMF);
1267                         SN.U.FormNoticeEnhancements(NDMF);
1268                         NDMF.append('<button class="close">&#215;</button>');
1269                         $('.entity_send-a-message button').click(function(){
1270                             NDMF.hide();
1271                             return false;
1272                         });
1273                         NDM.removeClass(SN.C.S.Processing);
1274                     });
1275                 }
1276                 else {
1277                     NDMF.show();
1278                     $('.entity_send-a-message textarea').focus();
1279                 }
1280                 return false;
1281             });
1282         },
1283
1284         /**
1285          * Return a date object with the current local time on the
1286          * given year, month, and day.
1287          *
1288          * @param {number} year: 4-digit year
1289          * @param {number} month: 0 == January
1290          * @param {number} day: 1 == 1
1291          * @return {Date}
1292          */
1293         GetFullYear: function(year, month, day) {
1294             var date = new Date();
1295             date.setFullYear(year, month, day);
1296
1297             return date;
1298         },
1299
1300         /**
1301          * Some sort of object interface for storing some structured
1302          * information in a cookie.
1303          *
1304          * Appears to be used to save the last-used login nickname?
1305          * That's something that browsers usually take care of for us
1306          * these days, do we really need to do it? Does anything else
1307          * use this interface?
1308          *
1309          * @fixme what is this?
1310          * @fixme should this use non-cookie local storage when available?
1311          */
1312         StatusNetInstance: {
1313             /**
1314              * @fixme what is this?
1315              */
1316             Set: function(value) {
1317                 var SNI = SN.U.StatusNetInstance.Get();
1318                 if (SNI !== null) {
1319                     value = $.extend(SNI, value);
1320                 }
1321
1322                 $.cookie(
1323                     SN.C.S.StatusNetInstance,
1324                     JSON.stringify(value),
1325                     {
1326                         path: '/',
1327                         expires: SN.U.GetFullYear(2029, 0, 1)
1328                     });
1329             },
1330
1331             /**
1332              * @fixme what is this?
1333              */
1334             Get: function() {
1335                 var cookieValue = $.cookie(SN.C.S.StatusNetInstance);
1336                 if (cookieValue !== null) {
1337                     return JSON.parse(cookieValue);
1338                 }
1339                 return null;
1340             },
1341
1342             /**
1343              * @fixme what is this?
1344              */
1345             Delete: function() {
1346                 $.cookie(SN.C.S.StatusNetInstance, null);
1347             }
1348         },
1349
1350         /**
1351          * Check if the current page is a timeline where the current user's
1352          * posts should be displayed immediately on success.
1353          *
1354          * @fixme this should be done in a saner way, with machine-readable
1355          * info about what page we're looking at.
1356          *
1357          * @param {DOMElement} notice: HTML chunk with formatted notice
1358          * @return boolean
1359          */
1360         belongsOnTimeline: function(notice) {
1361             var action = $("body").attr('id');
1362             if (action == 'public') {
1363                 return true;
1364             }
1365
1366             var profileLink = $('#nav_profile a').attr('href');
1367             if (profileLink) {
1368                 var authorUrl = $(notice).find('.vcard.author a.url').attr('href');
1369                 if (authorUrl == profileLink) {
1370                     if (action == 'all' || action == 'showstream') {
1371                         // Posts always show on your own friends and profile streams.
1372                         return true;
1373                     }
1374                 }
1375             }
1376
1377             // @fixme tag, group, reply timelines should be feasible as well.
1378             // Mismatch between id-based and name-based user/group links currently complicates
1379             // the lookup, since all our inline mentions contain the absolute links but the
1380             // UI links currently on the page use malleable names.
1381
1382             return false;
1383         },
1384
1385         /**
1386          * Switch to another active input sub-form.
1387          * This will hide the current form (if any), show the new one, and
1388          * update the input type tab selection state.
1389          *
1390          * @param {String} tag
1391          */
1392         switchInputFormTab: function(tag) {
1393             // The one that's current isn't current anymore
1394             $('.input_form_nav_tab.current').removeClass('current');
1395             if (tag == 'placeholder') {
1396                 // Hack: when showing the placeholder, mark the tab
1397                 // as current for 'Status'.
1398                 $('#input_form_nav_status').addClass('current');
1399             } else {
1400                 $('#input_form_nav_'+tag).addClass('current');
1401             }
1402
1403             // Don't remove 'current' if we also have the "nonav" class.
1404             // An example would be the message input form. removing
1405             // 'current' will cause the form to vanish from the page.
1406             var nonav = $('.input_form.current.nonav');
1407             if (nonav.length > 0) {
1408                 return;
1409             }
1410
1411             $('.input_form.current').removeClass('current');
1412             $('#input_form_'+tag)
1413                 .addClass('current')
1414                 .find('.ajax-notice').each(function() {
1415                     var form = $(this);
1416                     SN.Init.NoticeFormSetup(form);
1417                 })
1418                 .find('.notice_data-text').focus();
1419         }
1420     },
1421
1422     Init: {
1423         /**
1424          * If user is logged in, run setup code for the new notice form:
1425          *
1426          *  - char counter
1427          *  - AJAX submission
1428          *  - location events
1429          *  - file upload events
1430          */
1431         NoticeForm: function() {
1432             if ($('body.user_in').length > 0) {
1433                 // SN.Init.NoticeFormSetup() will get run
1434                 // when forms get displayed for the first time...
1435
1436                 // Hack to initialize the placeholder at top
1437                 $('#input_form_placeholder input.placeholder').focus(function() {
1438                     SN.U.switchInputFormTab("status");
1439                 });
1440
1441                 // Make inline reply forms self-close when clicking out.
1442                 $('body').bind('click', function(e) {
1443                     var currentForm = $('#content .input_forms div.current');
1444                     if (currentForm.length > 0) {
1445                         if ($('#content .input_forms').has(e.target).length == 0) {
1446                             // If all fields are empty, switch back to the placeholder.
1447                             var fields = currentForm.find('textarea, input[type=text], input[type=""]');
1448                             var anything = false;
1449                             fields.each(function() {
1450                                 anything = anything || $(this).val();
1451                             });
1452                             if (!anything) {
1453                                 SN.U.switchInputFormTab("placeholder");
1454                             }
1455                         }
1456                     }
1457
1458                     var openReplies = $('li.notice-reply');
1459                     if (openReplies.length > 0) {
1460                         var target = $(e.target);
1461                         openReplies.each(function() {
1462                             // Did we click outside this one?
1463                             var replyItem = $(this);
1464                             if (replyItem.has(e.target).length == 0) {
1465                                 var textarea = replyItem.find('.notice_data-text:first');
1466                                 var cur = $.trim(textarea.val());
1467                                 // Only close if there's been no edit.
1468                                 if (cur == '' || cur == textarea.data('initialText')) {
1469                                     var parentNotice = replyItem.closest('li.notice');
1470                                     replyItem.remove();
1471                                     parentNotice.find('li.notice-reply-placeholder').show();
1472                                 }
1473                             }
1474                         });
1475                     }
1476                 });
1477
1478                 // Infield labels for notice form inputs.
1479                 $('.input_forms fieldset fieldset label').inFieldLabels({ fadeOpacity:0 });
1480
1481             }
1482         },
1483
1484         /**
1485          * Encapsulate notice form setup for a single form.
1486          * Plugins can add extra setup by monkeypatching this
1487          * function.
1488          *
1489          * @param {jQuery} form
1490          */
1491         NoticeFormSetup: function(form) {
1492             if (!form.data('NoticeFormSetup')) {
1493                 SN.U.NoticeLocationAttach(form);
1494                 SN.U.FormNoticeXHR(form);
1495                 SN.U.FormNoticeEnhancements(form);
1496                 SN.U.NoticeDataAttach(form);
1497                 form.data('NoticeFormSetup', true);
1498             }
1499         },
1500
1501         /**
1502          * Run setup code for notice timeline views items:
1503          *
1504          * - AJAX submission for fave/repeat/reply (if logged in)
1505          * - Attachment link extras ('more' links)
1506          */
1507         Notices: function() {
1508             if ($('body.user_in').length > 0) {
1509                 var masterForm = $('.form_notice:first');
1510                 if (masterForm.length > 0) {
1511                     SN.C.I.NoticeFormMaster = document._importNode(masterForm[0], true);
1512                 }
1513                 SN.U.NoticeRepeat();
1514                 SN.U.NoticeReply();
1515                 SN.U.NoticeInlineReplySetup();
1516             }
1517
1518             SN.U.NoticeAttachments();
1519         },
1520
1521         /**
1522          * Run setup code for user & group profile page header area if logged in:
1523          *
1524          * - AJAX submission for sub/unsub/join/leave/nudge
1525          * - AJAX form popup for direct-message
1526          */
1527         EntityActions: function() {
1528             if ($('body.user_in').length > 0) {
1529                 $('.form_user_subscribe').live('click', function() { SN.U.FormXHR($(this)); return false; });
1530                 $('.form_user_unsubscribe').live('click', function() { SN.U.FormXHR($(this)); return false; });
1531                 $('.form_group_join').live('click', function() { SN.U.FormXHR($(this)); return false; });
1532                 $('.form_group_leave').live('click', function() { SN.U.FormXHR($(this)); return false; });
1533                 $('.form_user_nudge').live('click', function() { SN.U.FormXHR($(this)); return false; });
1534                 $('.form_peopletag_subscribe').live('click', function() { SN.U.FormXHR($(this)); return false; });
1535                 $('.form_peopletag_unsubscribe').live('click', function() { SN.U.FormXHR($(this)); return false; });
1536                 $('.form_user_add_peopletag').live('click', function() { SN.U.FormXHR($(this)); return false; });
1537                 $('.form_user_remove_peopletag').live('click', function() { SN.U.FormXHR($(this)); return false; });
1538
1539                 SN.U.NewDirectMessage();
1540             }
1541         },
1542
1543         ProfileSearch: function() {
1544             if ($('body.user_in').length > 0) {
1545                 $('.form_peopletag_edit_user_search input.submit').live('click', function() {
1546                     SN.U.FormProfileSearchXHR($(this).parents('form')); return false;
1547                 });
1548             }
1549         },
1550
1551         /**
1552          * Run setup code for login form:
1553          *
1554          * - loads saved last-used-nickname from cookie
1555          * - sets event handler to save nickname to cookie on submit
1556          *
1557          * @fixme is this necessary? Browsers do their own form saving these days.
1558          */
1559         Login: function() {
1560             if (SN.U.StatusNetInstance.Get() !== null) {
1561                 var nickname = SN.U.StatusNetInstance.Get().Nickname;
1562                 if (nickname !== null) {
1563                     $('#form_login #nickname').val(nickname);
1564                 }
1565             }
1566
1567             $('#form_login').bind('submit', function() {
1568                 SN.U.StatusNetInstance.Set({Nickname: $('#form_login #nickname').val()});
1569                 return true;
1570             });
1571         },
1572
1573         /**
1574          * Called when a people tag edit box is shown in the interface
1575          *
1576          * - loads the jQuery UI autocomplete plugin
1577          * - sets event handlers for tag completion
1578          *
1579          */
1580         PeopletagAutocomplete: function(txtBox) {
1581             var split = function(val) {
1582                 return val.split( /\s+/ );
1583             }
1584             var extractLast = function(term) {
1585                 return split(term).pop();
1586             }
1587
1588             // don't navigate away from the field on tab when selecting an item
1589             txtBox.live( "keydown", function( event ) {
1590                 if ( event.keyCode === $.ui.keyCode.TAB &&
1591                         $(this).data( "autocomplete" ).menu.active ) {
1592                     event.preventDefault();
1593                 }
1594             }).autocomplete({
1595                 minLength: 0,
1596                 source: function(request, response) {
1597                             // delegate back to autocomplete, but extract the last term
1598                             response($.ui.autocomplete.filter(
1599                                     SN.C.PtagACData, extractLast(request.term)));
1600                     },
1601                     focus: function() {
1602                         return false;
1603                 },
1604                     select: function(event, ui) {
1605                             var terms = split(this.value);
1606                             terms.pop();
1607                             terms.push(ui.item.value);
1608                             terms.push("");
1609                             this.value = terms.join(" ");
1610                             return false;
1611                     }
1612             }).data('autocomplete')._renderItem = function(ul, item) {
1613                     // FIXME: with jQuery UI you cannot have it highlight the match
1614                     var _l = '<a class="ptag-ac-line-tag">' + item.tag
1615                           + ' <em class="privacy_mode">' + item.mode + '</em>'
1616                           + '<span class="freq">' + item.freq + '</span></a>'
1617
1618                             return $("<li/>")
1619                                 .addClass('mode-' + item.mode)
1620                             .addClass('ptag-ac-line')
1621                             .data("item.autocomplete", item)
1622                             .append(_l)
1623                             .appendTo(ul);
1624                     }
1625         },
1626
1627         /**
1628          * Run setup for the ajax people tags editor
1629          *
1630          * - show edit button
1631          * - set event handle for click on edit button
1632          *   - loads people tag autocompletion data if not already present
1633          *     or if it is stale.
1634          *
1635          */
1636         PeopleTags: function() {
1637             $('.user_profile_tags .editable').append($('<button class="peopletags_edit_button"/>'));
1638
1639             $('.peopletags_edit_button').live('click', function() {
1640                 var form = $(this).parents('dd').eq(0).find('form');
1641                 // We can buy time from the above animation
1642
1643                 $.ajax({
1644                     url: _peopletagAC,
1645                     dataType: 'json',
1646                     data: {token: $('#token').val()},
1647                     ifModified: true,
1648                     success: function(data) {
1649                         // item.label is used to match
1650                         for (i=0; i < data.length; i++) {
1651                             data[i].label = data[i].tag;
1652                         }
1653
1654                         SN.C.PtagACData = data;
1655                         SN.Init.PeopletagAutocomplete(form.find('#tags'));
1656                     }
1657                 });
1658
1659                 $(this).parents('ul').eq(0).fadeOut(200, function() {form.fadeIn(200).find('input#tags')});
1660             });
1661
1662             $('.user_profile_tags form .submit').live('click', function() {
1663                 SN.U.FormPeopletagsXHR($(this).parents('form')); return false;
1664             });
1665         },
1666
1667         /**
1668          * Set up any generic 'ajax' form so it submits via AJAX with auto-replacement.
1669          */
1670         AjaxForms: function() {
1671             $('form.ajax').live('submit', function() {
1672                 SN.U.FormXHR($(this));
1673                 return false;
1674             });
1675             $('form.ajax input[type=submit]').live('click', function() {
1676                 // Some forms rely on knowing which submit button was clicked.
1677                 // Save a hidden input field which'll be picked up during AJAX
1678                 // submit...
1679                 var button = $(this);
1680                 var form = button.closest('form');
1681                 form.find('.hidden-submit-button').remove();
1682                 $('<input class="hidden-submit-button" type="hidden" />')
1683                     .attr('name', button.attr('name'))
1684                     .val(button.val())
1685                     .appendTo(form);
1686             });
1687         },
1688
1689         /**
1690          * Add logic to any file upload forms to handle file size limits,
1691          * on browsers that support basic FileAPI.
1692          */
1693         UploadForms: function () {
1694             $('input[type=file]').change(function(event) {
1695                 if (typeof this.files == "object" && this.files.length > 0) {
1696                     var size = 0;
1697                     for (var i = 0; i < this.files.length; i++) {
1698                         size += this.files[i].size;
1699                     }
1700
1701                     var max = SN.U.maxFileSize($(this.form));
1702                     if (max > 0 && size > max) {
1703                         var msg = 'File too large: maximum upload size is %d bytes.';
1704                         alert(msg.replace('%d', max));
1705
1706                         // Clear the files.
1707                         $(this).val('');
1708                         event.preventDefault();
1709                         return false;
1710                     }
1711                 }
1712             });
1713         },
1714
1715         CheckBoxes: function() {
1716             $("span[class='checkbox-wrapper']").addClass("unchecked");
1717             $(".checkbox-wrapper").click(function(){
1718                 if($(this).children("input").attr("checked")){
1719                     // uncheck
1720                     $(this).children("input").attr({checked: ""});
1721                     $(this).removeClass("checked");
1722                     $(this).addClass("unchecked");
1723                     $(this).children("label").text("Private?");
1724                 }else{
1725                     // check
1726                     $(this).children("input").attr({checked: "checked"});
1727                     $(this).removeClass("unchecked");
1728                     $(this).addClass("checked");
1729                     $(this).children("label").text("Private");
1730                 }
1731             });
1732         }
1733     }
1734 };
1735
1736 /**
1737  * Run initialization functions on DOM-ready.
1738  *
1739  * Note that if we're waiting on other scripts to load, this won't happen
1740  * until that's done. To load scripts asynchronously without delaying setup,
1741  * don't start them loading until after DOM-ready time!
1742  */
1743 $(document).ready(function(){
1744     SN.Init.AjaxForms();
1745     SN.Init.UploadForms();
1746     SN.Init.CheckBoxes();
1747     if ($('.'+SN.C.S.FormNotice).length > 0) {
1748         SN.Init.NoticeForm();
1749     }
1750     if ($('#content .notices').length > 0) {
1751         SN.Init.Notices();
1752     }
1753     if ($('#content .entity_actions').length > 0) {
1754         SN.Init.EntityActions();
1755     }
1756     if ($('#form_login').length > 0) {
1757         SN.Init.Login();
1758     }
1759     if ($('#profile_search_results').length > 0) {
1760         SN.Init.ProfileSearch();
1761     }
1762     if ($('.user_profile_tags .editable').length > 0) {
1763         SN.Init.PeopleTags();
1764     }
1765 });
1766