plugins/Realtime/realtimeupdate.js

   1 /*
   2  * StatusNet - a distributed open-source microblogging tool
   3  * Copyright (C) 2008, StatusNet, Inc.
   4  *
   5  * Add a notice encoded as JSON into the current timeline
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  *
  20  * @category  Plugin
  21  * @package   StatusNet
  22  * @author    Evan Prodromou <evan@status.net>
  23  * @author    Sarven Capadisli <csarven@status.net>
  24  * @copyright 2009 StatusNet, Inc.
  25  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  26  * @link      http://status.net/
  27  */
  28
  29 // TODO: i18n
  30
  31 RealtimeUpdate = {
  32      _userid: 0,
  33      _replyurl: '',
  34      _favorurl: '',
  35      _deleteurl: '',
  36      _updatecounter: 0,
  37      _maxnotices: 50,
  38      _windowhasfocus: true,
  39      _documenttitle: '',
  40      _paused:false,
  41      _queuedNotices:[],
  42
  43      init: function(userid, replyurl, favorurl, deleteurl)
  44      {
  45         RealtimeUpdate._userid = userid;
  46         RealtimeUpdate._replyurl = replyurl;
  47         RealtimeUpdate._favorurl = favorurl;
  48         RealtimeUpdate._deleteurl = deleteurl;
  49
  50         RealtimeUpdate._documenttitle = document.title;
  51
  52         $(window).bind('focus', function(){ RealtimeUpdate._windowhasfocus = true; });
  53
  54         $(window).bind('blur', function() {
  55           $('#notices_primary .notice').removeClass('mark-top');
  56
  57           $('#notices_primary .notice:first').addClass('mark-top');
  58
  59           RealtimeUpdate._updatecounter = 0;
  60           document.title = RealtimeUpdate._documenttitle;
  61           RealtimeUpdate._windowhasfocus = false;
  62
  63           return false;
  64         });
  65      },
  66
  67      receive: function(data)
  68      {
  69           if (RealtimeUpdate._paused === false) {
  70               RealtimeUpdate.purgeLastNoticeItem();
  71
  72               RealtimeUpdate.insertNoticeItem(data);
  73           }
  74           else {
  75               RealtimeUpdate._queuedNotices.push(data);
  76
  77               RealtimeUpdate.updateQueuedCounter();
  78           }
  79
  80           RealtimeUpdate.updateWindowCounter();
  81      },
  82
  83      insertNoticeItem: function(data) {
  84         // Don't add it if it already exists
  85         if ($("#notice-"+data.id).length > 0) {
  86             return;
  87         }
  88
  89         var noticeItem = RealtimeUpdate.makeNoticeItem(data);
  90         var noticeItemID = $(noticeItem).attr('id');
  91
  92         $("#notices_primary .notices").prepend(noticeItem);
  93         $("#notices_primary .notice:first").css({display:"none"});
  94         $("#notices_primary .notice:first").fadeIn(1000);
  95
  96         SN.U.FormXHR($('#'+noticeItemID+' .form_favor'));
  97         SN.U.NoticeReplyTo($('#'+noticeItemID));
  98      },
  99
 100      purgeLastNoticeItem: function() {
 101         if ($('#notices_primary .notice').length > RealtimeUpdate._maxnotices) {
 102             $("#notices_primary .notice:last").remove();
 103         }
 104      },
 105
 106      updateWindowCounter: function() {
 107           if (RealtimeUpdate._windowhasfocus === false) {
 108               RealtimeUpdate._updatecounter += 1;
 109               document.title = '('+RealtimeUpdate._updatecounter+') ' + RealtimeUpdate._documenttitle;
 110           }
 111      },
 112
 113      makeNoticeItem: function(data)
 114      {
 115           user = data['user'];
 116           html = data['html'].replace(/&amp;/g,'&').replace(/&lt;/g,'<').replace(/&gt;/g,'>').replace(/&quot;/g,'"');
 117           source = data['source'].replace(/&amp;/g,'&').replace(/&lt;/g,'<').replace(/&gt;/g,'>').replace(/&quot;/g,'"');
 118
 119           ni = "<li class=\"hentry notice\" id=\"notice-"+data['id']+"\">"+
 120                "<div class=\"entry-title\">"+
 121                "<span class=\"vcard author\">"+
 122                "<a href=\""+user['profile_url']+"\" class=\"url\">"+
 123                "<img src=\""+user['profile_image_url']+"\" class=\"avatar photo\" width=\"48\" height=\"48\" alt=\""+user['screen_name']+"\"/>"+
 124                "<span class=\"nickname fn\">"+user['screen_name']+"</span>"+
 125                "</a>"+
 126                "</span>"+
 127                "<p class=\"entry-content\">"+html+"</p>"+
 128                "</div>"+
 129                "<div class=\"entry-content\">"+
 130                "<a class=\"timestamp\" rel=\"bookmark\" href=\""+data['url']+"\" >"+
 131                "<abbr class=\"published\" title=\""+data['created_at']+"\">a few seconds ago</abbr>"+
 132                "</a> "+
 133                "<span class=\"source\">"+
 134                "from "+
 135                 "<span class=\"device\">"+source+"</span>"+ // may have a link
 136                "</span>";
 137           if (data['in_reply_to_status_id']) {
 138                ni = ni+" <a class=\"response\" href=\""+data['in_reply_to_status_url']+"\">in context</a>";
 139           }
 140
 141           ni = ni+"</div>"+
 142             "<div class=\"notice-options\">";
 143
 144           if (RealtimeUpdate._userid != 0) {
 145                var input = $("form#form_notice fieldset input#token");
 146                var session_key = input.val();
 147                ni = ni+RealtimeUpdate.makeFavoriteForm(data['id'], session_key);
 148                ni = ni+RealtimeUpdate.makeReplyLink(data['id'], data['user']['screen_name']);
 149                if (RealtimeUpdate._userid == data['user']['id']) {
 150                     ni = ni+RealtimeUpdate.makeDeleteLink(data['id']);
 151                }
 152           }
 153
 154           ni = ni+"</div>"+
 155                "</li>";
 156           return ni;
 157      },
 158
 159      makeFavoriteForm: function(id, session_key)
 160      {
 161           var ff;
 162
 163           ff = "<form id=\"favor-"+id+"\" class=\"form_favor\" method=\"post\" action=\""+RealtimeUpdate._favorurl+"\">"+
 164                 "<fieldset>"+
 165                "<legend>Favor this notice</legend>"+
 166                "<input name=\"token-"+id+"\" type=\"hidden\" id=\"token-"+id+"\" value=\""+session_key+"\"/>"+
 167                "<input name=\"notice\" type=\"hidden\" id=\"notice-n"+id+"\" value=\""+id+"\"/>"+
 168                "<input type=\"submit\" id=\"favor-submit-"+id+"\" name=\"favor-submit-"+id+"\" class=\"submit\" value=\"Favor\" title=\"Favor this notice\"/>"+
 169                 "</fieldset>"+
 170                "</form>";
 171           return ff;
 172      },
 173
 174      makeReplyLink: function(id, nickname)
 175      {
 176           var rl;
 177           rl = "<a class=\"notice_reply\" href=\""+RealtimeUpdate._replyurl+"?replyto="+nickname+"\" title=\"Reply to this notice\">Reply <span class=\"notice_id\">"+id+"</span></a>";
 178           return rl;
 179         },
 180
 181      makeDeleteLink: function(id)
 182      {
 183           var dl, delurl;
 184           delurl = RealtimeUpdate._deleteurl.replace("0000000000", id);
 185
 186           dl = "<a class=\"notice_delete\" href=\""+delurl+"\" title=\"Delete this notice\">Delete</a>";
 187
 188           return dl;
 189      },
 190
 191      initActions: function(url, timeline, path)
 192      {
 193         var NP = $('#notices_primary');
 194         NP.prepend('<ul id="realtime_actions"><li id="realtime_playpause"></li><li id="realtime_timeline"></li></ul>');
 195
 196         RealtimeUpdate._pluginPath = path;
 197
 198         RealtimeUpdate.initPlayPause();
 199         RealtimeUpdate.initAddPopup(url, timeline, RealtimeUpdate._pluginPath);
 200      },
 201
 202      initPlayPause: function()
 203      {
 204         RealtimeUpdate.showPause();
 205      },
 206
 207      showPause: function()
 208      {
 209         RT_PP = $('#realtime_playpause');
 210         RT_PP.empty();
 211         RT_PP.append('<button id="realtime_pause" class="pause" title="Pause">Pause</button>');
 212
 213         RT_P = $('#realtime_pause');
 214         RT_P.bind('click', function() {
 215             RealtimeUpdate._paused = true;
 216
 217             RealtimeUpdate.showPlay();
 218             return false;
 219         });
 220      },
 221
 222      showPlay: function()
 223      {
 224         RT_PP = $('#realtime_playpause');
 225         RT_PP.empty();
 226         RT_PP.append('<span id="queued_counter"></span> <button id="realtime_play" class="play" title="Play">Play</button>');
 227
 228         RT_P = $('#realtime_play');
 229         RT_P.bind('click', function() {
 230             RealtimeUpdate._paused = false;
 231
 232             RealtimeUpdate.showPause();
 233
 234             RealtimeUpdate.showQueuedNotices();
 235
 236             return false;
 237         });
 238      },
 239
 240      showQueuedNotices: function()
 241      {
 242         $.each(RealtimeUpdate._queuedNotices, function(i, n) {
 243             RealtimeUpdate.insertNoticeItem(n);
 244         });
 245
 246         RealtimeUpdate._queuedNotices = [];
 247
 248         RealtimeUpdate.removeQueuedCounter();
 249      },
 250
 251      updateQueuedCounter: function()
 252      {
 253         $('#realtime_playpause #queued_counter').html('('+RealtimeUpdate._queuedNotices.length+')');
 254      },
 255
 256      removeQueuedCounter: function()
 257      {
 258         $('#realtime_playpause #queued_counter').empty();
 259      },
 260
 261      initAddPopup: function(url, timeline, path)
 262      {
 263          var NP = $('#realtime_timeline');
 264          NP.append('<button id="realtime_popup" title="Pop up in a window">Pop up</button>');
 265
 266          var PP = $('#realtime_popup');
 267          PP.bind('click', function() {
 268              window.open(url,
 269                          '',
 270                          'toolbar=no,resizable=yes,scrollbars=yes,status=no,menubar=no,personalbar=no,location=no,width=500,height=550');
 271
 272              return false;
 273          });
 274      },
 275
 276      initPopupWindow: function()
 277      {
 278          $('.notices .entry-title a, .notices .entry-content a').bind('click', function() {
 279             window.open(this.href, '');
 280
 281             return false;
 282          });
 283      }
 284 }
 285