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         },
  36
  37         /**
  38          * @fixme are these worth the trouble? They seem to mostly just duplicate
  39          * themselves while slightly obscuring the actual selector, so it's hard
  40          * to pop over to the HTML and find something.
  41          *
  42          * In theory, minification could reduce them to shorter variable names,
  43          * but at present that doesn't happen with yui-compressor.
  44          */
  45         S: { // Selector
  46             Disabled: 'disabled',
  47             Warning: 'warning',
  48             Error: 'error',
  49             Success: 'success',
  50             Processing: 'processing',
  51             CommandResult: 'command_result',
  52             FormNotice: 'form_notice',
  53             NoticeDataText: 'notice_data-text',
  54             NoticeTextCount: 'notice_text-count',
  55             NoticeInReplyTo: 'notice_in-reply-to',
  56             NoticeDataAttach: 'notice_data-attach',
  57             NoticeDataAttachSelected: 'notice_data-attach_selected',
  58             NoticeActionSubmit: 'notice_action-submit',
  59             NoticeLat: 'notice_data-lat',
  60             NoticeLon: 'notice_data-lon',
  61             NoticeLocationId: 'notice_data-location_id',
  62             NoticeLocationNs: 'notice_data-location_ns',
  63             NoticeGeoName: 'notice_data-geo_name',
  64             NoticeDataGeo: 'notice_data-geo',
  65             NoticeDataGeoCookie: 'NoticeDataGeo',
  66             NoticeDataGeoSelected: 'notice_data-geo_selected',
  67             StatusNetInstance:'StatusNetInstance'
  68         }
  69     },
  70
  71     /**
  72      * Map of localized message strings exported to script from the PHP
  73      * side via Action::getScriptMessages().
  74      *
  75      * Retrieve them via SN.msg(); this array is an implementation detail.
  76      *
  77      * @access private
  78      */
  79     messages: {},
  80
  81     /**
  82      * Grabs a localized string that's been previously exported to us
  83      * from server-side code via Action::getScriptMessages().
  84      *
  85      * @example alert(SN.msg('coolplugin-failed'));
  86      *
  87      * @param {String} key: string key name to pull from message index
  88      * @return matching localized message string
  89      */
  90     msg: function(key) {
  91         if (typeof SN.messages[key] == "undefined") {
  92             return '[' + key + ']';
  93         } else {
  94             return SN.messages[key];
  95         }
  96     },
  97
  98     U: { // Utils
  99         /**
 100          * Setup function -- DOES NOT trigger actions immediately.
 101          *
 102          * Sets up event handlers on the new notice form.
 103          *
 104          * @param {jQuery} form: jQuery object whose first matching element is the form
 105          * @access private
 106          */
 107         FormNoticeEnhancements: function(form) {
 108             if (jQuery.data(form[0], 'ElementData') === undefined) {
 109                 MaxLength = form.find('#'+SN.C.S.NoticeTextCount).text();
 110                 if (typeof(MaxLength) == 'undefined') {
 111                      MaxLength = SN.C.I.MaxLength;
 112                 }
 113                 jQuery.data(form[0], 'ElementData', {MaxLength:MaxLength});
 114
 115                 SN.U.Counter(form);
 116
 117                 NDT = form.find('#'+SN.C.S.NoticeDataText);
 118
 119                 NDT.bind('keyup', function(e) {
 120                     SN.U.Counter(form);
 121                 });
 122
 123                 var delayedUpdate= function(e) {
 124                     // Cut and paste events fire *before* the operation,
 125                     // so we need to trigger an update in a little bit.
 126                     // This would be so much easier if the 'change' event
 127                     // actually fired every time the value changed. :P
 128                     window.setTimeout(function() {
 129                         SN.U.Counter(form);
 130                     }, 50);
 131                 };
 132                 // Note there's still no event for mouse-triggered 'delete'.
 133                 NDT.bind('cut', delayedUpdate)
 134                    .bind('paste', delayedUpdate);
 135
 136                 NDT.bind('keydown', function(e) {
 137                     SN.U.SubmitOnReturn(e, form);
 138                 });
 139             }
 140             else {
 141                 form.find('#'+SN.C.S.NoticeTextCount).text(jQuery.data(form[0], 'ElementData').MaxLength);
 142             }
 143
 144             if ($('body')[0].id != 'conversation' && window.location.hash.length === 0 && $(window).scrollTop() == 0) {
 145                 form.find('textarea').focus();
 146             }
 147         },
 148
 149         /**
 150          * To be called from keydown event handler on the notice import form.
 151          * Checks if return or enter key was pressed, and if so attempts to
 152          * submit the form and cancel standard processing of the enter key.
 153          *
 154          * @param {Event} event
 155          * @param {jQuery} el: jQuery object whose first element is the notice posting form
 156          *
 157          * @return {boolean} whether to cancel the event? Does this actually pass through?
 158          * @access private
 159          */
 160         SubmitOnReturn: function(event, el) {
 161             if (event.keyCode == 13 || event.keyCode == 10) {
 162                 el.submit();
 163                 event.preventDefault();
 164                 event.stopPropagation();
 165                 $('#'+el[0].id+' #'+SN.C.S.NoticeDataText).blur();
 166                 $('body').focus();
 167                 return false;
 168             }
 169             return true;
 170         },
 171
 172         /**
 173          * To be called from event handlers on the notice import form.
 174          * Triggers an update of the remaining-characters counter.
 175          *
 176          * Additional counter updates will be suppressed during the
 177          * next half-second to avoid flooding the layout engine with
 178          * updates, followed by another automatic check.
 179          *
 180          * The maximum length is pulled from data established by
 181          * FormNoticeEnhancements.
 182          *
 183          * @param {jQuery} form: jQuery object whose first element is the notice posting form
 184          * @access private
 185          */
 186         Counter: function(form) {
 187             SN.C.I.FormNoticeCurrent = form;
 188
 189             var MaxLength = jQuery.data(form[0], 'ElementData').MaxLength;
 190
 191             if (MaxLength <= 0) {
 192                 return;
 193             }
 194
 195             var remaining = MaxLength - SN.U.CharacterCount(form);
 196             var counter = form.find('#'+SN.C.S.NoticeTextCount);
 197
 198             if (remaining.toString() != counter.text()) {
 199                 if (!SN.C.I.CounterBlackout || remaining === 0) {
 200                     if (counter.text() != String(remaining)) {
 201                         counter.text(remaining);
 202                     }
 203                     if (remaining < 0) {
 204                         form.addClass(SN.C.S.Warning);
 205                     } else {
 206                         form.removeClass(SN.C.S.Warning);
 207                     }
 208                     // Skip updates for the next 500ms.
 209                     // On slower hardware, updating on every keypress is unpleasant.
 210                     if (!SN.C.I.CounterBlackout) {
 211                         SN.C.I.CounterBlackout = true;
 212                         SN.C.I.FormNoticeCurrent = form;
 213                         window.setTimeout("SN.U.ClearCounterBlackout(SN.C.I.FormNoticeCurrent);", 500);
 214                     }
 215                 }
 216             }
 217         },
 218
 219         /**
 220          * Pull the count of characters in the current edit field.
 221          * Plugins replacing the edit control may need to override this.
 222          *
 223          * @param {jQuery} form: jQuery object whose first element is the notice posting form
 224          * @return number of chars
 225          */
 226         CharacterCount: function(form) {
 227             return form.find('#'+SN.C.S.NoticeDataText).val().length;
 228         },
 229
 230         /**
 231          * Called internally after the counter update blackout period expires;
 232          * runs another update to make sure we didn't miss anything.
 233          *
 234          * @param {jQuery} form: jQuery object whose first element is the notice posting form
 235          * @access private
 236          */
 237         ClearCounterBlackout: function(form) {
 238             // Allow keyup events to poke the counter again
 239             SN.C.I.CounterBlackout = false;
 240             // Check if the string changed since we last looked
 241             SN.U.Counter(form);
 242         },
 243
 244         /**
 245          * Helper function to rewrite default HTTP form action URLs to HTTPS
 246          * so we can actually fetch them when on an SSL page in ssl=sometimes
 247          * mode.
 248          *
 249          * It would be better to output URLs that didn't hardcode protocol
 250          * and hostname in the first place...
 251          *
 252          * @param {String} url
 253          * @return string
 254          */
 255         RewriteAjaxAction: function(url) {
 256             // Quick hack: rewrite AJAX submits to HTTPS if they'd fail otherwise.
 257             if (document.location.protocol == 'https:' && url.substr(0, 5) == 'http:') {
 258                 return url.replace(/^http:\/\/[^:\/]+/, 'https://' + document.location.host);
 259             } else {
 260                 return url;
 261             }
 262         },
 263
 264         /**
 265          * Grabs form data and submits it asynchronously, with 'ajax=1'
 266          * parameter added to the rest.
 267          *
 268          * If a successful response includes another form, that form
 269          * will be extracted and copied in, replacing the original form.
 270          * If there's no form, the first paragraph will be used.
 271          *
 272          * @fixme can sometimes explode confusingly if returnd data is bogus
 273          * @fixme error handling is pretty vague
 274          * @fixme can't submit file uploads
 275          *
 276          * @param {jQuery} form: jQuery object whose first element is a form
 277          *
 278          * @access public
 279          */
 280         FormXHR: function(form) {
 281             $.ajax({
 282                 type: 'POST',
 283                 dataType: 'xml',
 284                 url: SN.U.RewriteAjaxAction(form.attr('action')),
 285                 data: form.serialize() + '&ajax=1',
 286                 beforeSend: function(xhr) {
 287                     form
 288                         .addClass(SN.C.S.Processing)
 289                         .find('.submit')
 290                             .addClass(SN.C.S.Disabled)
 291                             .attr(SN.C.S.Disabled, SN.C.S.Disabled);
 292                 },
 293                 error: function (xhr, textStatus, errorThrown) {
 294                     alert(errorThrown || textStatus);
 295                 },
 296                 success: function(data, textStatus) {
 297                     if (typeof($('form', data)[0]) != 'undefined') {
 298                         form_new = document._importNode($('form', data)[0], true);
 299                         form.replaceWith(form_new);
 300                     }
 301                     else {
 302                         form.replaceWith(document._importNode($('p', data)[0], true));
 303                     }
 304                 }
 305             });
 306         },
 307
 308         /**
 309          * Setup function -- DOES NOT trigger actions immediately.
 310          *
 311          * Sets up event handlers for special-cased async submission of the
 312          * notice-posting form, including some pre-post validation.
 313          *
 314          * Unlike FormXHR() this does NOT submit the form immediately!
 315          * It sets up event handlers so that any method of submitting the
 316          * form (click on submit button, enter, submit() etc) will trigger
 317          * it properly.
 318          *
 319          * Also unlike FormXHR(), this system will use a hidden iframe
 320          * automatically to handle file uploads via <input type="file">
 321          * controls.
 322          *
 323          * @fixme tl;dr
 324          * @fixme vast swaths of duplicate code and really long variable names clutter this function up real bad
 325          * @fixme error handling is unreliable
 326          * @fixme cookieValue is a global variable, but probably shouldn't be
 327          * @fixme saving the location cache cookies should be split out
 328          * @fixme some error messages are hardcoded english: needs i18n
 329          * @fixme special-case for bookmarklet is confusing and uses a global var "self". Is this ok?
 330          *
 331          * @param {jQuery} form: jQuery object whose first element is a form
 332          *
 333          * @access public
 334          */
 335         FormNoticeXHR: function(form) {
 336             SN.C.I.NoticeDataGeo = {};
 337             form.append('<input type="hidden" name="ajax" value="1"/>');
 338
 339             // Make sure we don't have a mixed HTTP/HTTPS submission...
 340             form.attr('action', SN.U.RewriteAjaxAction(form.attr('action')));
 341
 342             /**
 343              * Show a response feedback bit under the new-notice dialog.
 344              *
 345              * @param {String} cls: CSS class name to use ('error' or 'success')
 346              * @param {String} text
 347              * @access private
 348              */
 349             var showFeedback = function(cls, text) {
 350                 form.append(
 351                     $('<p class="form_response"></p>')
 352                         .addClass(cls)
 353                         .text(text)
 354                 );
 355             };
 356
 357             /**
 358              * Hide the previous response feedback, if any.
 359              */
 360             var removeFeedback = function() {
 361                 form.find('.form_response').remove();
 362             };
 363
 364             form.ajaxForm({
 365                 dataType: 'xml',
 366                 timeout: '60000',
 367                 beforeSend: function(formData) {
 368                     if (form.find('#'+SN.C.S.NoticeDataText)[0].value.length === 0) {
 369                         form.addClass(SN.C.S.Warning);
 370                         return false;
 371                     }
 372                     form
 373                         .addClass(SN.C.S.Processing)
 374                         .find('#'+SN.C.S.NoticeActionSubmit)
 375                             .addClass(SN.C.S.Disabled)
 376                             .attr(SN.C.S.Disabled, SN.C.S.Disabled);
 377
 378                     SN.C.I.NoticeDataGeo.NLat = $('#'+SN.C.S.NoticeLat).val();
 379                     SN.C.I.NoticeDataGeo.NLon = $('#'+SN.C.S.NoticeLon).val();
 380                     SN.C.I.NoticeDataGeo.NLNS = $('#'+SN.C.S.NoticeLocationNs).val();
 381                     SN.C.I.NoticeDataGeo.NLID = $('#'+SN.C.S.NoticeLocationId).val();
 382                     SN.C.I.NoticeDataGeo.NDG = $('#'+SN.C.S.NoticeDataGeo).attr('checked');
 383
 384                     cookieValue = $.cookie(SN.C.S.NoticeDataGeoCookie);
 385
 386                     if (cookieValue !== null && cookieValue != 'disabled') {
 387                         cookieValue = JSON.parse(cookieValue);
 388                         SN.C.I.NoticeDataGeo.NLat = $('#'+SN.C.S.NoticeLat).val(cookieValue.NLat).val();
 389                         SN.C.I.NoticeDataGeo.NLon = $('#'+SN.C.S.NoticeLon).val(cookieValue.NLon).val();
 390                         if ($('#'+SN.C.S.NoticeLocationNs).val(cookieValue.NLNS)) {
 391                             SN.C.I.NoticeDataGeo.NLNS = $('#'+SN.C.S.NoticeLocationNs).val(cookieValue.NLNS).val();
 392                             SN.C.I.NoticeDataGeo.NLID = $('#'+SN.C.S.NoticeLocationId).val(cookieValue.NLID).val();
 393                         }
 394                     }
 395                     if (cookieValue == 'disabled') {
 396                         SN.C.I.NoticeDataGeo.NDG = $('#'+SN.C.S.NoticeDataGeo).attr('checked', false).attr('checked');
 397                     }
 398                     else {
 399                         SN.C.I.NoticeDataGeo.NDG = $('#'+SN.C.S.NoticeDataGeo).attr('checked', true).attr('checked');
 400                     }
 401
 402                     return true;
 403                 },
 404                 error: function (xhr, textStatus, errorThrown) {
 405                     form
 406                         .removeClass(SN.C.S.Processing)
 407                         .find('#'+SN.C.S.NoticeActionSubmit)
 408                             .removeClass(SN.C.S.Disabled)
 409                             .removeAttr(SN.C.S.Disabled, SN.C.S.Disabled);
 410                     removeFeedback();
 411                     if (textStatus == 'timeout') {
 412                         // @fixme i18n
 413                         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.');
 414                     }
 415                     else {
 416                         var response = SN.U.GetResponseXML(xhr);
 417                         if ($('.'+SN.C.S.Error, response).length > 0) {
 418                             form.append(document._importNode($('.'+SN.C.S.Error, response)[0], true));
 419                         }
 420                         else {
 421                             if (parseInt(xhr.status) === 0 || jQuery.inArray(parseInt(xhr.status), SN.C.I.HTTP20x30x) >= 0) {
 422                                 form
 423                                     .resetForm()
 424                                     .find('#'+SN.C.S.NoticeDataAttachSelected).remove();
 425                                 SN.U.FormNoticeEnhancements(form);
 426                             }
 427                             else {
 428                                 // @fixme i18n
 429                                 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.');
 430                             }
 431                         }
 432                     }
 433                 },
 434                 success: function(data, textStatus) {
 435                     removeFeedback();
 436                     var errorResult = $('#'+SN.C.S.Error, data);
 437                     if (errorResult.length > 0) {
 438                         showFeedback('error', errorResult.text());
 439                     }
 440                     else {
 441                         if($('body')[0].id == 'bookmarklet') {
 442                             // @fixme self is not referenced anywhere?
 443                             self.close();
 444                         }
 445
 446                         var commandResult = $('#'+SN.C.S.CommandResult, data);
 447                         if (commandResult.length > 0) {
 448                             showFeedback('success', commandResult.text());
 449                         }
 450                         else {
 451                             // New notice post was successful. If on our timeline, show it!
 452                             var notice = document._importNode($('li', data)[0], true);
 453                             var notices = $('#notices_primary .notices:first');
 454                             if (notices.length > 0 && SN.U.belongsOnTimeline(notice)) {
 455                                 if ($('#'+notice.id).length === 0) {
 456                                     var notice_irt_value = $('#'+SN.C.S.NoticeInReplyTo).val();
 457                                     var notice_irt = '#notices_primary #notice-'+notice_irt_value;
 458                                     if($('body')[0].id == 'conversation') {
 459                                         if(notice_irt_value.length > 0 && $(notice_irt+' .notices').length < 1) {
 460                                             $(notice_irt).append('<ul class="notices"></ul>');
 461                                         }
 462                                         $($(notice_irt+' .notices')[0]).append(notice);
 463                                     }
 464                                     else {
 465                                         notices.prepend(notice);
 466                                     }
 467                                     $('#'+notice.id)
 468                                         .css({display:'none'})
 469                                         .fadeIn(2500);
 470                                     SN.U.NoticeWithAttachment($('#'+notice.id));
 471                                     SN.U.NoticeReplyTo($('#'+notice.id));
 472                                 }
 473                             }
 474                             else {
 475                                 // Not on a timeline that this belongs on?
 476                                 // Just show a success message.
 477                                 showFeedback('success', $('title', data).text());
 478                             }
 479                         }
 480                         form.resetForm();
 481                         form.find('#'+SN.C.S.NoticeInReplyTo).val('');
 482                         form.find('#'+SN.C.S.NoticeDataAttachSelected).remove();
 483                         SN.U.FormNoticeEnhancements(form);
 484                     }
 485                 },
 486                 complete: function(xhr, textStatus) {
 487                     form
 488                         .removeClass(SN.C.S.Processing)
 489                         .find('#'+SN.C.S.NoticeActionSubmit)
 490                             .removeAttr(SN.C.S.Disabled)
 491                             .removeClass(SN.C.S.Disabled);
 492
 493                     $('#'+SN.C.S.NoticeLat).val(SN.C.I.NoticeDataGeo.NLat);
 494                     $('#'+SN.C.S.NoticeLon).val(SN.C.I.NoticeDataGeo.NLon);
 495                     if ($('#'+SN.C.S.NoticeLocationNs)) {
 496                         $('#'+SN.C.S.NoticeLocationNs).val(SN.C.I.NoticeDataGeo.NLNS);
 497                         $('#'+SN.C.S.NoticeLocationId).val(SN.C.I.NoticeDataGeo.NLID);
 498                     }
 499                     $('#'+SN.C.S.NoticeDataGeo).attr('checked', SN.C.I.NoticeDataGeo.NDG);
 500                 }
 501             });
 502         },
 503
 504         /**
 505          * Fetch an XML DOM from an XHR's response data.
 506          *
 507          * Works around unavailable responseXML when document.domain
 508          * has been modified by Meteor or other tools, in some but not
 509          * all browsers.
 510          *
 511          * @param {XMLHTTPRequest} xhr
 512          * @return DOMDocument
 513          */
 514         GetResponseXML: function(xhr) {
 515             try {
 516                 return xhr.responseXML;
 517             } catch (e) {
 518                 return (new DOMParser()).parseFromString(xhr.responseText, "text/xml");
 519             }
 520         },
 521
 522         /**
 523          * Setup function -- DOES NOT trigger actions immediately.
 524          *
 525          * Sets up event handlers on all visible notice's reply buttons to
 526          * tweak the new-notice form with needed variables and focus it
 527          * when pushed.
 528          *
 529          * (This replaces the default reply button behavior to submit
 530          * directly to a form which comes back with a specialized page
 531          * with the form data prefilled.)
 532          *
 533          * @access private
 534          */
 535         NoticeReply: function() {
 536             if ($('#'+SN.C.S.NoticeDataText).length > 0 && $('#content .notice_reply').length > 0) {
 537                 $('#content .notice').each(function() { SN.U.NoticeReplyTo($(this)); });
 538             }
 539         },
 540
 541         /**
 542          * Setup function -- DOES NOT trigger actions immediately.
 543          *
 544          * Sets up event handlers on the given notice's reply button to
 545          * tweak the new-notice form with needed variables and focus it
 546          * when pushed.
 547          *
 548          * (This replaces the default reply button behavior to submit
 549          * directly to a form which comes back with a specialized page
 550          * with the form data prefilled.)
 551          *
 552          * @param {jQuery} notice: jQuery object containing one or more notices
 553          * @access private
 554          */
 555         NoticeReplyTo: function(notice) {
 556             notice.find('.notice_reply').live('click', function(e) {
 557                 e.preventDefault();
 558                 var nickname = ($('.author .nickname', notice).length > 0) ? $($('.author .nickname', notice)[0]) : $('.author .nickname.uid');
 559                 /* SN.U.NoticeReplySet(nickname.text(), $($('.notice_id', notice)[0]).text()); */
 560                 SN.U.NoticeInlineReplyTrigger(notice, '@' + nickname.text());
 561                 return false;
 562             });
 563         },
 564
 565         /**
 566          * Open up a notice's inline reply box.
 567          *
 568          * @param {jQuery} notice: jQuery object containing one notice
 569          * @param {String} initialText
 570          */
 571         NoticeInlineReplyTrigger: function(notice, initialText) {
 572             // Find the notice we're replying to...
 573             var id = $($('.notice_id', notice)[0]).text();
 574             var parentNotice = notice;
 575
 576             // Find the threaded replies view we'll be adding to...
 577             var list = notice.closest('.notices');
 578             if (list.hasClass('threaded-notices')) {
 579                 // We're replying to a reply; use reply form on the end of this list.
 580                 // We'll add our form at the end of this; grab the root notice.
 581                 parentNotice = list.closest('.notice');
 582             } else {
 583                 // We're replying to a parent notice; pull its threaded list
 584                 // and we'll add on the end of it. Will add if needed.
 585                 list = $('ul.threaded-notices', notice);
 586                 if (list.length == 0) {
 587                     list = $('<ul class="notices threaded-notices xoxo"></ul>');
 588                     notice.append(list);
 589                 }
 590             }
 591
 592             // See if the form's already open...
 593             var replyForm = $('.notice-reply-form', list);
 594             if (replyForm.length == 0) {
 595                 // Remove placeholder if any
 596                 $('li.notice-reply-placeholder').remove();
 597
 598                 // Create the reply form entry at the end
 599                 var replyItem = $('li.notice-reply', list);
 600                 if (replyItem.length == 0) {
 601                     replyItem = $('<li class="notice-reply">' +
 602                                       '<form class="notice-reply-form" method="post">' +
 603                                           '<textarea name="status_textarea"></textarea>' +
 604                                           '<div class="controls">' +
 605                                           '<input type="hidden" name="token">' +
 606                                           '<input type="hidden" name="inreplyto">' +
 607                                           '<input type="submit" class="submit">' +
 608                                       '</div>' +
 609                                       '</form>' +
 610                                   '</li>');
 611
 612                     var baseForm = $('#form_notice');
 613                     replyForm = replyItem.find('form');
 614                     replyForm.attr('action', baseForm.attr('action'));
 615                     replyForm.find('input[name="token"]').val(baseForm.find('input[name=token]').val());
 616                     replyForm.find('input[type="submit"]').val(SN.msg('reply_submit'));
 617                     list.append(replyItem);
 618
 619                     replyForm.find('textarea').blur(function() {
 620                         var textarea = $(this);
 621                         var txt = $.trim(textarea.val());
 622                         if (txt == '' || txt == textarea.data('initialText')) {
 623                             // Nothing to say? Begone!
 624                             replyItem.remove();
 625                             if (list.find('li').length > 0) {
 626                                 SN.U.NoticeInlineReplyPlaceholder(parentNotice);
 627                             } else {
 628                                 list.remove();
 629                             }
 630                         }
 631                     });
 632                     replyForm.submit(function(event) {
 633                         var form = replyForm;
 634                         $.ajax({
 635                             type: 'POST',
 636                             dataType: 'xml',
 637                             url: SN.U.RewriteAjaxAction(form.attr('action')),
 638                             data: form.serialize() + '&ajax=1',
 639                             beforeSend: function(xhr) {
 640                                 form
 641                                     .addClass(SN.C.S.Processing)
 642                                     .find('.submit')
 643                                         .addClass(SN.C.S.Disabled)
 644                                         .attr(SN.C.S.Disabled, SN.C.S.Disabled)
 645                                         .end()
 646                                     .find('textarea')
 647                                         .addClass(SN.C.S.Disabled)
 648                                         .attr(SN.C.S.Disabled, SN.C.S.Disabled);
 649                             },
 650                             error: function (xhr, textStatus, errorThrown) {
 651                                 alert(errorThrown || textStatus);
 652                             },
 653                             success: function(data, textStatus) {
 654                                 var orig_li = $('li', data)[0];
 655                                 if (orig_li) {
 656                                     var li = document._importNode(orig_li, true);
 657                                     replyItem.replaceWith(li);
 658                                     SN.U.NoticeInlineReplyPlaceholder(parentNotice);
 659                                 }
 660                             }
 661                         });
 662                         event.preventDefault();
 663                         return false;
 664                     });
 665                 }
 666             }
 667
 668             // Override...?
 669             replyForm.find('input[name=inreplyto]').val(id);
 670
 671             // Set focus...
 672             var text = replyForm.find('textarea');
 673             if (text.length == 0) {
 674                 throw "No textarea";
 675             }
 676             var replyto = '';
 677             if (initialText) {
 678                 replyto = initialText + ' ';
 679             }
 680             text.val(replyto + text.val().replace(RegExp(replyto, 'i'), ''));
 681             text.data('initialText', $.trim(initialText + ''));
 682             text.focus();
 683             if (text[0].setSelectionRange) {
 684                 var len = text.val().length;
 685                 text[0].setSelectionRange(len,len);
 686             }
 687         },
 688
 689         /**
 690          * FIXME OBSOLETE?
 691          * Updates the new notice posting form with bits for replying to the
 692          * given user. Adds replyto parameter to the form, and a "@foo" to the
 693          * text area.
 694          *
 695          * @fixme replyto is a global variable, but probably shouldn't be
 696          *
 697          * @param {String} nick
 698          * @param {String} id
 699          */
 700         NoticeReplySet: function(nick,id) {
 701             if (nick.match(SN.C.I.PatternUsername)) {
 702                 var text = $('#'+SN.C.S.NoticeDataText);
 703                 if (text.length > 0) {
 704                     replyto = '@' + nick + ' ';
 705                     text.val(replyto + text.val().replace(RegExp(replyto, 'i'), ''));
 706                     $('#'+SN.C.S.FormNotice+' #'+SN.C.S.NoticeInReplyTo).val(id);
 707
 708                     text[0].focus();
 709                     if (text[0].setSelectionRange) {
 710                         var len = text.val().length;
 711                         text[0].setSelectionRange(len,len);
 712                     }
 713                 }
 714             }
 715         },
 716
 717         /**
 718          * Setup function -- DOES NOT apply immediately.
 719          *
 720          * Sets up event handlers for favor/disfavor forms to submit via XHR.
 721          * Uses 'live' rather than 'bind', so applies to future as well as present items.
 722          */
 723         NoticeFavor: function() {
 724             $('.form_favor').live('click', function() { SN.U.FormXHR($(this)); return false; });
 725             $('.form_disfavor').live('click', function() { SN.U.FormXHR($(this)); return false; });
 726         },
 727
 728         NoticeInlineReplyPlaceholder: function(notice) {
 729             var list = notice.find('ul.threaded-notices');
 730             var placeholder = $('<li class="notice-reply-placeholder">' +
 731                                     '<input class="placeholder">' +
 732                                 '</li>');
 733             placeholder.click(function() {
 734                 SN.U.NoticeInlineReplyTrigger(notice);
 735             });
 736             placeholder.find('input').val(SN.msg('reply_comment'));
 737             list.append(placeholder);
 738         },
 739
 740         /**
 741          * Setup function -- DOES NOT apply immediately.
 742          *
 743          * Sets up event handlers for favor/disfavor forms to submit via XHR.
 744          * Uses 'live' rather than 'bind', so applies to future as well as present items.
 745          */
 746         NoticeInlineReplySetup: function() {
 747             $('.threaded-notices').each(function() {
 748                 var list = $(this);
 749                 var notice = list.closest('.notice');
 750                 SN.U.NoticeInlineReplyPlaceholder(notice);
 751             });
 752         },
 753
 754         /**
 755          * Setup function -- DOES NOT trigger actions immediately.
 756          *
 757          * Sets up event handlers for repeat forms to toss up a confirmation
 758          * popout before submitting.
 759          *
 760          * Uses 'live' rather than 'bind', so applies to future as well as present items.
 761          */
 762         NoticeRepeat: function() {
 763             $('.form_repeat').live('click', function(e) {
 764                 e.preventDefault();
 765
 766                 SN.U.NoticeRepeatConfirmation($(this));
 767                 return false;
 768             });
 769         },
 770
 771         /**
 772          * Shows a confirmation dialog box variant of the repeat button form.
 773          * This seems to use a technique where the repeat form contains
 774          * _both_ a standalone button _and_ text and buttons for a dialog.
 775          * The dialog will close after its copy of the form is submitted,
 776          * or if you click its 'close' button.
 777          *
 778          * The dialog is created by duplicating the original form and changing
 779          * its style; while clever, this is hard to generalize and probably
 780          * duplicates a lot of unnecessary HTML output.
 781          *
 782          * @fixme create confirmation dialogs through a generalized interface
 783          * that can be reused instead of hardcoded text and styles.
 784          *
 785          * @param {jQuery} form
 786          */
 787         NoticeRepeatConfirmation: function(form) {
 788             var submit_i = form.find('.submit');
 789
 790             var submit = submit_i.clone();
 791             submit
 792                 .addClass('submit_dialogbox')
 793                 .removeClass('submit');
 794             form.append(submit);
 795             submit.bind('click', function() { SN.U.FormXHR(form); return false; });
 796
 797             submit_i.hide();
 798
 799             form
 800                 .addClass('dialogbox')
 801                 .append('<button class="close">&#215;</button>')
 802                 .closest('.notice-options')
 803                     .addClass('opaque');
 804
 805             form.find('button.close').click(function(){
 806                 $(this).remove();
 807
 808                 form
 809                     .removeClass('dialogbox')
 810                     .closest('.notice-options')
 811                         .removeClass('opaque');
 812
 813                 form.find('.submit_dialogbox').remove();
 814                 form.find('.submit').show();
 815
 816                 return false;
 817             });
 818         },
 819
 820         /**
 821          * Setup function -- DOES NOT trigger actions immediately.
 822          *
 823          * Goes through all notices currently displayed and sets up attachment
 824          * handling if needed.
 825          */
 826         NoticeAttachments: function() {
 827             $('.notice a.attachment').each(function() {
 828                 SN.U.NoticeWithAttachment($(this).closest('.notice'));
 829             });
 830         },
 831
 832         /**
 833          * Setup function -- DOES NOT trigger actions immediately.
 834          *
 835          * Sets up special attachment link handling if needed. Currently this
 836          * consists only of making the "more" button used for OStatus message
 837          * cropping turn into an auto-expansion button that loads the full
 838          * text from an attachment file.
 839          *
 840          * @param {jQuery} notice
 841          */
 842         NoticeWithAttachment: function(notice) {
 843             if (notice.find('.attachment').length === 0) {
 844                 return;
 845             }
 846
 847             var attachment_more = notice.find('.attachment.more');
 848             if (attachment_more.length > 0) {
 849                 $(attachment_more[0]).click(function() {
 850                     var m = $(this);
 851                     m.addClass(SN.C.S.Processing);
 852                     $.get(m.attr('href')+'/ajax', null, function(data) {
 853                         m.parent('.entry-content').html($(data).find('#attachment_view .entry-content').html());
 854                     });
 855
 856                     return false;
 857                 }).attr('title', SN.msg('showmore_tooltip'));
 858             }
 859         },
 860
 861         /**
 862          * Setup function -- DOES NOT trigger actions immediately.
 863          *
 864          * Sets up event handlers for the file-attachment widget in the
 865          * new notice form. When a file is selected, a box will be added
 866          * below the text input showing the filename and, if supported
 867          * by the browser, a thumbnail preview.
 868          *
 869          * This preview box will also allow removing the attachment
 870          * prior to posting.
 871          */
 872         NoticeDataAttach: function() {
 873             NDA = $('#'+SN.C.S.NoticeDataAttach);
 874             NDA.change(function(event) {
 875                 var filename = $(this).val();
 876                 if (!filename) {
 877                     // No file -- we've been tricked!
 878                     $('#'+SN.C.S.NoticeDataAttachSelected).remove();
 879                     return false;
 880                 }
 881
 882                 // @fixme appending filename straight in is potentially unsafe
 883                 S = '<div id="'+SN.C.S.NoticeDataAttachSelected+'" class="'+SN.C.S.Success+'"><code>'+filename+'</code> <button class="close">&#215;</button></div>';
 884                 NDAS = $('#'+SN.C.S.NoticeDataAttachSelected);
 885                 if (NDAS.length > 0) {
 886                     NDAS.replaceWith(S);
 887                 }
 888                 else {
 889                     $('#'+SN.C.S.FormNotice).append(S);
 890                 }
 891                 $('#'+SN.C.S.NoticeDataAttachSelected+' button').click(function(){
 892                     $('#'+SN.C.S.NoticeDataAttachSelected).remove();
 893                     NDA.val('');
 894
 895                     return false;
 896                 });
 897                 if (typeof this.files == "object") {
 898                     // Some newer browsers will let us fetch the files for preview.
 899                     for (var i = 0; i < this.files.length; i++) {
 900                         SN.U.PreviewAttach(this.files[i]);
 901                     }
 902                 }
 903             });
 904         },
 905
 906         /**
 907          * Get PHP's MAX_FILE_SIZE setting for this form;
 908          * used to apply client-side file size limit checks.
 909          *
 910          * @param {jQuery} form
 911          * @return int max size in bytes; 0 or negative means no limit
 912          */
 913         maxFileSize: function(form) {
 914             var max = $(form).find('input[name=MAX_FILE_SIZE]').attr('value');
 915             if (max) {
 916                 return parseInt(max);
 917             } else {
 918                 return 0;
 919             }
 920         },
 921
 922         /**
 923          * For browsers with FileAPI support: make a thumbnail if possible,
 924          * and append it into the attachment display widget.
 925          *
 926          * Known good:
 927          * - Firefox 3.6.6, 4.0b7
 928          * - Chrome 8.0.552.210
 929          *
 930          * Known ok metadata, can't get contents:
 931          * - Safari 5.0.2
 932          *
 933          * Known fail:
 934          * - Opera 10.63, 11 beta (no input.files interface)
 935          *
 936          * @param {File} file
 937          *
 938          * @todo use configured thumbnail size
 939          * @todo detect pixel size?
 940          * @todo should we render a thumbnail to a canvas and then use the smaller image?
 941          */
 942         PreviewAttach: function(file) {
 943             var tooltip = file.type + ' ' + Math.round(file.size / 1024) + 'KB';
 944             var preview = true;
 945
 946             var blobAsDataURL;
 947             if (typeof window.createObjectURL != "undefined") {
 948                 /**
 949                  * createObjectURL lets us reference the file directly from an <img>
 950                  * This produces a compact URL with an opaque reference to the file,
 951                  * which we can reference immediately.
 952                  *
 953                  * - Firefox 3.6.6: no
 954                  * - Firefox 4.0b7: no
 955                  * - Safari 5.0.2: no
 956                  * - Chrome 8.0.552.210: works!
 957                  */
 958                 blobAsDataURL = function(blob, callback) {
 959                     callback(window.createObjectURL(blob));
 960                 }
 961             } else if (typeof window.FileReader != "undefined") {
 962                 /**
 963                  * FileAPI's FileReader can build a data URL from a blob's contents,
 964                  * but it must read the file and build it asynchronously. This means
 965                  * we'll be passing a giant data URL around, which may be inefficient.
 966                  *
 967                  * - Firefox 3.6.6: works!
 968                  * - Firefox 4.0b7: works!
 969                  * - Safari 5.0.2: no
 970                  * - Chrome 8.0.552.210: works!
 971                  */
 972                 blobAsDataURL = function(blob, callback) {
 973                     var reader = new FileReader();
 974                     reader.onload = function(event) {
 975                         callback(reader.result);
 976                     }
 977                     reader.readAsDataURL(blob);
 978                 }
 979             } else {
 980                 preview = false;
 981             }
 982
 983             var imageTypes = ['image/png', 'image/jpeg', 'image/gif', 'image/svg+xml'];
 984             if ($.inArray(file.type, imageTypes) == -1) {
 985                 // We probably don't know how to show the file.
 986                 preview = false;
 987             }
 988
 989             var maxSize = 8 * 1024 * 1024;
 990             if (file.size > maxSize) {
 991                 // Don't kill the browser trying to load some giant image.
 992                 preview = false;
 993             }
 994
 995             if (preview) {
 996                 blobAsDataURL(file, function(url) {
 997                     var img = $('<img>')
 998                         .attr('title', tooltip)
 999                         .attr('alt', tooltip)
1000                         .attr('src', url)
1001                         .attr('style', 'height: 120px');
1002                     $('#'+SN.C.S.NoticeDataAttachSelected).append(img);
1003                 });
1004             } else {
1005                 var img = $('<div></div>').text(tooltip);
1006                 $('#'+SN.C.S.NoticeDataAttachSelected).append(img);
1007             }
1008         },
1009
1010         /**
1011          * Setup function -- DOES NOT trigger actions immediately.
1012          *
1013          * Initializes state for the location-lookup features in the
1014          * new-notice form. Seems to set up some event handlers for
1015          * triggering lookups and using the new values.
1016          *
1017          * @fixme tl;dr
1018          * @fixme there's not good visual state update here, so users have a
1019          *        hard time figuring out if it's working or fixing if it's wrong.
1020          *
1021          */
1022         NoticeLocationAttach: function() {
1023             var NLat = $('#'+SN.C.S.NoticeLat).val();
1024             var NLon = $('#'+SN.C.S.NoticeLon).val();
1025             var NLNS = $('#'+SN.C.S.NoticeLocationNs).val();
1026             var NLID = $('#'+SN.C.S.NoticeLocationId).val();
1027             var NLN = $('#'+SN.C.S.NoticeGeoName).text();
1028             var NDGe = $('#'+SN.C.S.NoticeDataGeo);
1029
1030             function removeNoticeDataGeo() {
1031                 $('label[for='+SN.C.S.NoticeDataGeo+']')
1032                     .attr('title', jQuery.trim($('label[for='+SN.C.S.NoticeDataGeo+']').text()))
1033                     .removeClass('checked');
1034
1035                 $('#'+SN.C.S.NoticeLat).val('');
1036                 $('#'+SN.C.S.NoticeLon).val('');
1037                 $('#'+SN.C.S.NoticeLocationNs).val('');
1038                 $('#'+SN.C.S.NoticeLocationId).val('');
1039                 $('#'+SN.C.S.NoticeDataGeo).attr('checked', false);
1040
1041                 $.cookie(SN.C.S.NoticeDataGeoCookie, 'disabled', { path: '/' });
1042             }
1043
1044             function getJSONgeocodeURL(geocodeURL, data) {
1045                 $.getJSON(geocodeURL, data, function(location) {
1046                     var lns, lid;
1047
1048                     if (typeof(location.location_ns) != 'undefined') {
1049                         $('#'+SN.C.S.NoticeLocationNs).val(location.location_ns);
1050                         lns = location.location_ns;
1051                     }
1052
1053                     if (typeof(location.location_id) != 'undefined') {
1054                         $('#'+SN.C.S.NoticeLocationId).val(location.location_id);
1055                         lid = location.location_id;
1056                     }
1057
1058                     if (typeof(location.name) == 'undefined') {
1059                         NLN_text = data.lat + ';' + data.lon;
1060                     }
1061                     else {
1062                         NLN_text = location.name;
1063                     }
1064
1065                     $('label[for='+SN.C.S.NoticeDataGeo+']')
1066                         .attr('title', NoticeDataGeo_text.ShareDisable + ' (' + NLN_text + ')');
1067
1068                     $('#'+SN.C.S.NoticeLat).val(data.lat);
1069                     $('#'+SN.C.S.NoticeLon).val(data.lon);
1070                     $('#'+SN.C.S.NoticeLocationNs).val(lns);
1071                     $('#'+SN.C.S.NoticeLocationId).val(lid);
1072                     $('#'+SN.C.S.NoticeDataGeo).attr('checked', true);
1073
1074                     var cookieValue = {
1075                         NLat: data.lat,
1076                         NLon: data.lon,
1077                         NLNS: lns,
1078                         NLID: lid,
1079                         NLN: NLN_text,
1080                         NLNU: location.url,
1081                         NDG: true
1082                     };
1083
1084                     $.cookie(SN.C.S.NoticeDataGeoCookie, JSON.stringify(cookieValue), { path: '/' });
1085                 });
1086             }
1087
1088             if (NDGe.length > 0) {
1089                 if ($.cookie(SN.C.S.NoticeDataGeoCookie) == 'disabled') {
1090                     NDGe.attr('checked', false);
1091                 }
1092                 else {
1093                     NDGe.attr('checked', true);
1094                 }
1095
1096                 var NGW = $('#notice_data-geo_wrap');
1097                 var geocodeURL = NGW.attr('title');
1098                 NGW.removeAttr('title');
1099
1100                 $('label[for='+SN.C.S.NoticeDataGeo+']')
1101                     .attr('title', jQuery.trim($('label[for='+SN.C.S.NoticeDataGeo+']').text()));
1102
1103                 NDGe.change(function() {
1104                     if ($('#'+SN.C.S.NoticeDataGeo).attr('checked') === true || $.cookie(SN.C.S.NoticeDataGeoCookie) === null) {
1105                         $('label[for='+SN.C.S.NoticeDataGeo+']')
1106                             .attr('title', NoticeDataGeo_text.ShareDisable)
1107                             .addClass('checked');
1108
1109                         if ($.cookie(SN.C.S.NoticeDataGeoCookie) === null || $.cookie(SN.C.S.NoticeDataGeoCookie) == 'disabled') {
1110                             if (navigator.geolocation) {
1111                                 navigator.geolocation.getCurrentPosition(
1112                                     function(position) {
1113                                         $('#'+SN.C.S.NoticeLat).val(position.coords.latitude);
1114                                         $('#'+SN.C.S.NoticeLon).val(position.coords.longitude);
1115
1116                                         var data = {
1117                                             lat: position.coords.latitude,
1118                                             lon: position.coords.longitude,
1119                                             token: $('#token').val()
1120                                         };
1121
1122                                         getJSONgeocodeURL(geocodeURL, data);
1123                                     },
1124
1125                                     function(error) {
1126                                         switch(error.code) {
1127                                             case error.PERMISSION_DENIED:
1128                                                 removeNoticeDataGeo();
1129                                                 break;
1130                                             case error.TIMEOUT:
1131                                                 $('#'+SN.C.S.NoticeDataGeo).attr('checked', false);
1132                                                 break;
1133                                         }
1134                                     },
1135
1136                                     {
1137                                         timeout: 10000
1138                                     }
1139                                 );
1140                             }
1141                             else {
1142                                 if (NLat.length > 0 && NLon.length > 0) {
1143                                     var data = {
1144                                         lat: NLat,
1145                                         lon: NLon,
1146                                         token: $('#token').val()
1147                                     };
1148
1149                                     getJSONgeocodeURL(geocodeURL, data);
1150                                 }
1151                                 else {
1152                                     removeNoticeDataGeo();
1153                                     $('#'+SN.C.S.NoticeDataGeo).remove();
1154                                     $('label[for='+SN.C.S.NoticeDataGeo+']').remove();
1155                                 }
1156                             }
1157                         }
1158                         else {
1159                             var cookieValue = JSON.parse($.cookie(SN.C.S.NoticeDataGeoCookie));
1160
1161                             $('#'+SN.C.S.NoticeLat).val(cookieValue.NLat);
1162                             $('#'+SN.C.S.NoticeLon).val(cookieValue.NLon);
1163                             $('#'+SN.C.S.NoticeLocationNs).val(cookieValue.NLNS);
1164                             $('#'+SN.C.S.NoticeLocationId).val(cookieValue.NLID);
1165                             $('#'+SN.C.S.NoticeDataGeo).attr('checked', cookieValue.NDG);
1166
1167                             $('label[for='+SN.C.S.NoticeDataGeo+']')
1168                                 .attr('title', NoticeDataGeo_text.ShareDisable + ' (' + cookieValue.NLN + ')')
1169                                 .addClass('checked');
1170                         }
1171                     }
1172                     else {
1173                         removeNoticeDataGeo();
1174                     }
1175                 }).change();
1176             }
1177         },
1178
1179         /**
1180          * Setup function -- DOES NOT trigger actions immediately.
1181          *
1182          * Initializes event handlers for the "Send direct message" link on
1183          * profile pages, setting it up to display a dialog box when clicked.
1184          *
1185          * Unlike the repeat confirmation form, this appears to fetch
1186          * the form _from the original link target_, so the form itself
1187          * doesn't need to be in the current document.
1188          *
1189          * @fixme breaks ability to open link in new window?
1190          */
1191         NewDirectMessage: function() {
1192             NDM = $('.entity_send-a-message a');
1193             NDM.attr({'href':NDM.attr('href')+'&ajax=1'});
1194             NDM.bind('click', function() {
1195                 var NDMF = $('.entity_send-a-message form');
1196                 if (NDMF.length === 0) {
1197                     $(this).addClass(SN.C.S.Processing);
1198                     $.get(NDM.attr('href'), null, function(data) {
1199                         $('.entity_send-a-message').append(document._importNode($('form', data)[0], true));
1200                         NDMF = $('.entity_send-a-message .form_notice');
1201                         SN.U.FormNoticeXHR(NDMF);
1202                         SN.U.FormNoticeEnhancements(NDMF);
1203                         NDMF.append('<button class="close">&#215;</button>');
1204                         $('.entity_send-a-message button').click(function(){
1205                             NDMF.hide();
1206                             return false;
1207                         });
1208                         NDM.removeClass(SN.C.S.Processing);
1209                     });
1210                 }
1211                 else {
1212                     NDMF.show();
1213                     $('.entity_send-a-message textarea').focus();
1214                 }
1215                 return false;
1216             });
1217         },
1218
1219         /**
1220          * Return a date object with the current local time on the
1221          * given year, month, and day.
1222          *
1223          * @param {number} year: 4-digit year
1224          * @param {number} month: 0 == January
1225          * @param {number} day: 1 == 1
1226          * @return {Date}
1227          */
1228         GetFullYear: function(year, month, day) {
1229             var date = new Date();
1230             date.setFullYear(year, month, day);
1231
1232             return date;
1233         },
1234
1235         /**
1236          * Some sort of object interface for storing some structured
1237          * information in a cookie.
1238          *
1239          * Appears to be used to save the last-used login nickname?
1240          * That's something that browsers usually take care of for us
1241          * these days, do we really need to do it? Does anything else
1242          * use this interface?
1243          *
1244          * @fixme what is this?
1245          * @fixme should this use non-cookie local storage when available?
1246          */
1247         StatusNetInstance: {
1248             /**
1249              * @fixme what is this?
1250              */
1251             Set: function(value) {
1252                 var SNI = SN.U.StatusNetInstance.Get();
1253                 if (SNI !== null) {
1254                     value = $.extend(SNI, value);
1255                 }
1256
1257                 $.cookie(
1258                     SN.C.S.StatusNetInstance,
1259                     JSON.stringify(value),
1260                     {
1261                         path: '/',
1262                         expires: SN.U.GetFullYear(2029, 0, 1)
1263                     });
1264             },
1265
1266             /**
1267              * @fixme what is this?
1268              */
1269             Get: function() {
1270                 var cookieValue = $.cookie(SN.C.S.StatusNetInstance);
1271                 if (cookieValue !== null) {
1272                     return JSON.parse(cookieValue);
1273                 }
1274                 return null;
1275             },
1276
1277             /**
1278              * @fixme what is this?
1279              */
1280             Delete: function() {
1281                 $.cookie(SN.C.S.StatusNetInstance, null);
1282             }
1283         },
1284
1285         /**
1286          * Check if the current page is a timeline where the current user's
1287          * posts should be displayed immediately on success.
1288          *
1289          * @fixme this should be done in a saner way, with machine-readable
1290          * info about what page we're looking at.
1291          *
1292          * @param {DOMElement} notice: HTML chunk with formatted notice
1293          * @return boolean
1294          */
1295         belongsOnTimeline: function(notice) {
1296             var action = $("body").attr('id');
1297             if (action == 'public') {
1298                 return true;
1299             }
1300
1301             var profileLink = $('#nav_profile a').attr('href');
1302             if (profileLink) {
1303                 var authorUrl = $(notice).find('.entry-title .author a.url').attr('href');
1304                 if (authorUrl == profileLink) {
1305                     if (action == 'all' || action == 'showstream') {
1306                         // Posts always show on your own friends and profile streams.
1307                         return true;
1308                     }
1309                 }
1310             }
1311
1312             // @fixme tag, group, reply timelines should be feasible as well.
1313             // Mismatch between id-based and name-based user/group links currently complicates
1314             // the lookup, since all our inline mentions contain the absolute links but the
1315             // UI links currently on the page use malleable names.
1316
1317             return false;
1318         }
1319     },
1320
1321     Init: {
1322         /**
1323          * If user is logged in, run setup code for the new notice form:
1324          *
1325          *  - char counter
1326          *  - AJAX submission
1327          *  - location events
1328          *  - file upload events
1329          */
1330         NoticeForm: function() {
1331             if ($('body.user_in').length > 0) {
1332                 SN.U.NoticeLocationAttach();
1333
1334                 $('.'+SN.C.S.FormNotice).each(function() {
1335                     SN.U.FormNoticeXHR($(this));
1336                     SN.U.FormNoticeEnhancements($(this));
1337                 });
1338
1339                 SN.U.NoticeDataAttach();
1340             }
1341         },
1342
1343         /**
1344          * Run setup code for notice timeline views items:
1345          *
1346          * - AJAX submission for fave/repeat/reply (if logged in)
1347          * - Attachment link extras ('more' links)
1348          */
1349         Notices: function() {
1350             if ($('body.user_in').length > 0) {
1351                 SN.U.NoticeFavor();
1352                 SN.U.NoticeRepeat();
1353                 SN.U.NoticeReply();
1354                 SN.U.NoticeInlineReplySetup();
1355             }
1356
1357             SN.U.NoticeAttachments();
1358         },
1359
1360         /**
1361          * Run setup code for user & group profile page header area if logged in:
1362          *
1363          * - AJAX submission for sub/unsub/join/leave/nudge
1364          * - AJAX form popup for direct-message
1365          */
1366         EntityActions: function() {
1367             if ($('body.user_in').length > 0) {
1368                 $('.form_user_subscribe').live('click', function() { SN.U.FormXHR($(this)); return false; });
1369                 $('.form_user_unsubscribe').live('click', function() { SN.U.FormXHR($(this)); return false; });
1370                 $('.form_group_join').live('click', function() { SN.U.FormXHR($(this)); return false; });
1371                 $('.form_group_leave').live('click', function() { SN.U.FormXHR($(this)); return false; });
1372                 $('.form_user_nudge').live('click', function() { SN.U.FormXHR($(this)); return false; });
1373
1374                 SN.U.NewDirectMessage();
1375             }
1376         },
1377
1378         /**
1379          * Run setup code for login form:
1380          *
1381          * - loads saved last-used-nickname from cookie
1382          * - sets event handler to save nickname to cookie on submit
1383          *
1384          * @fixme is this necessary? Browsers do their own form saving these days.
1385          */
1386         Login: function() {
1387             if (SN.U.StatusNetInstance.Get() !== null) {
1388                 var nickname = SN.U.StatusNetInstance.Get().Nickname;
1389                 if (nickname !== null) {
1390                     $('#form_login #nickname').val(nickname);
1391                 }
1392             }
1393
1394             $('#form_login').bind('submit', function() {
1395                 SN.U.StatusNetInstance.Set({Nickname: $('#form_login #nickname').val()});
1396                 return true;
1397             });
1398         },
1399
1400         /**
1401          * Add logic to any file upload forms to handle file size limits,
1402          * on browsers that support basic FileAPI.
1403          */
1404         UploadForms: function () {
1405             $('input[type=file]').change(function(event) {
1406                 if (typeof this.files == "object" && this.files.length > 0) {
1407                     var size = 0;
1408                     for (var i = 0; i < this.files.length; i++) {
1409                         size += this.files[i].size;
1410                     }
1411
1412                     var max = SN.U.maxFileSize($(this.form));
1413                     if (max > 0 && size > max) {
1414                         var msg = 'File too large: maximum upload size is %d bytes.';
1415                         alert(msg.replace('%d', max));
1416
1417                         // Clear the files.
1418                         $(this).val('');
1419                         event.preventDefault();
1420                         return false;
1421                     }
1422                 }
1423             });
1424         }
1425     }
1426 };
1427
1428 /**
1429  * Run initialization functions on DOM-ready.
1430  *
1431  * Note that if we're waiting on other scripts to load, this won't happen
1432  * until that's done. To load scripts asynchronously without delaying setup,
1433  * don't start them loading until after DOM-ready time!
1434  */
1435 $(document).ready(function(){
1436     SN.Init.UploadForms();
1437     if ($('.'+SN.C.S.FormNotice).length > 0) {
1438         SN.Init.NoticeForm();
1439     }
1440     if ($('#content .notices').length > 0) {
1441         SN.Init.Notices();
1442     }
1443     if ($('#content .entity_actions').length > 0) {
1444         SN.Init.EntityActions();
1445     }
1446     if ($('#form_login').length > 0) {
1447         SN.Init.Login();
1448     }
1449 });