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