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