diff --git a/CHANGES.rst b/CHANGES.rst index 7d0a73efa..4807fc37b 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -4,10 +4,15 @@ Changelog 0.7.0 (Unreleased) ------------------ +.. Note :: + This release introduces a backward incompatible change. The boilerplate + HTML needed in your webpage for converse.js to work has been reduced to a + single div:
+ * Add a toolbar for single user chat [jcbrand] * Add support for OTR (off-the-record) encryption [jcbrand] * Add support for smileys [jcbrand] -* Simplified initial boilerplate markup [jcbrand] +* Simplified boilerplate markup [jcbrand] * New configuration settings, ``xhr_custom_status_url`` and ``xhr_user_search_url`` [jcbrand] 0.6.6 (2013-10-16) diff --git a/converse.css b/converse.css index 95c7eadf5..1c23a8b07 100644 --- a/converse.css +++ b/converse.css @@ -17,12 +17,12 @@ user-select: none; } -#chatpanel, #chatpanel input { +#conversejs, #conversejs input { color: rgb(79, 79, 79); } -#chatpanel .emoticon { +#conversejs .emoticon { font-size: 14px; } @@ -54,7 +54,7 @@ span.spinner.hor_centered { position: absolute; } -#chatpanel { +#conversejs { z-index: 99; /*--Keeps the panel on top of all other elements--*/ position: fixed; bottom: 0; right: 0; @@ -478,7 +478,7 @@ a.close-chatbox-button:active { margin-top: 0.5em; } -#chatpanel dd.available-chatroom { +#conversejs dd.available-chatroom { overflow-x: hidden; text-overflow: ellipsis; white-space: nowrap; @@ -486,7 +486,7 @@ a.close-chatbox-button:active { width: 175px; } -#chatpanel dd.available-chatroom a.open-room { +#conversejs dd.available-chatroom a.open-room { width: 148px; } @@ -613,7 +613,7 @@ dd.available-chatroom:hover a.room-info { background-color: #DCEAC5; } -#chatpanel div.controlbox-panes { +#conversejs div.controlbox-panes { background: -moz-linear-gradient(top, rgba(255,255,255,1) 0%, rgba(240,240,240,1) 100%); /* FF3.6+ */ background: -ms-linear-gradient(top, rgba(255,255,255,1) 0%,rgba(240,240,240,1) 100%); /* IE10+ */ background: -o-linear-gradient(top, rgba(255,255,255,1) 0%,rgba(240,240,240,1) 100%); /* Opera 11.10+ */ diff --git a/converse.js b/converse.js index a3dfb8a67..f443dc292 100644 --- a/converse.js +++ b/converse.js @@ -110,7 +110,7 @@ // Translation machinery // --------------------- var __ = $.proxy(function (str) { - // Translation factory + // Translation factory if (this.i18n === undefined) { this.i18n = locales.en; } @@ -332,35 +332,6 @@ this.updateMsgCounter(); }; - this.showControlBox = function () { - var controlbox = this.chatboxes.get('controlbox'); - if (!controlbox) { - this.chatboxes.add({ - id: 'controlbox', - box_id: 'controlbox', - visible: true - }); - if (this.connection) { - this.chatboxes.get('controlbox').save(); - } - } else { - controlbox.trigger('show'); - } - }; - - this.toggleControlBox = function () { - if ($("div#controlbox").is(':visible')) { - var controlbox = this.chatboxes.get('controlbox'); - if (this.connection) { - controlbox.destroy(); - } else { - controlbox.trigger('hide'); - } - } else { - this.showControlBox(); - } - }; - this.initStatus = function (callback) { this.xmppstatus = new this.XMPPStatus(); var id = hex_sha1('converse.xmppstatus-'+this.bare_jid); @@ -455,7 +426,7 @@ this.set({ 'user_id' : Strophe.getNodeFromJid(this.get('jid')), 'box_id' : hex_sha1(this.get('jid')), - 'otr_status': this.get('otr_status') || UNENCRYPTED + 'otr_status': this.get('otr_status') || UNENCRYPTED }); } }, @@ -479,14 +450,14 @@ 'instance_tag': instance_tag }; } - } + } // We need to generate a new key and instance tag result = alert(__('Your browser needs to generate a private key, which will be used in your encrypted chat session. This can take up to 30 seconds during which your browser might freeze and become unresponsive.')); instance_tag = otr.OTR.makeInstanceTag(); key = new otr.DSA(); // Encrypt the key and set in sessionStorage. Also store // instance tag - window.sessionStorage[hex_sha1(this.id+'priv_key')] = + window.sessionStorage[hex_sha1(this.id+'priv_key')] = cipher.encrypt(crypto.algo.AES, key.packPrivate(), pass).toString(); window.sessionStorage[hex_sha1(this.id+'instance_tag')] = instance_tag; @@ -1107,10 +1078,10 @@ this.$el.find('div.chat-event').remove(); } } - } + } if (_.has(item.changed, 'status')) { this.showStatusMessage(item.get('status')); - } + } if (_.has(item.changed, 'image')) { this.renderAvatar(); } @@ -1183,7 +1154,7 @@ data.allow_otr = converse.allow_otr && !this.is_chatroom; data.show_emoticons = converse.show_emoticons; data.otr_translated_status = OTR_TRANSLATED_MAPPING[data.otr_status]; - data.otr_status_class = OTR_CLASS_MAPPING[data.otr_status]; + data.otr_status_class = OTR_CLASS_MAPPING[data.otr_status]; this.$el.find('.chat-toolbar').html(this.toolbar_template(data)); } return this; @@ -2348,7 +2319,7 @@ }); this.ChatBoxesView = Backbone.View.extend({ - el: '#chatpanel', + el: '#conversejs', initialize: function () { // boxesviewinit @@ -2503,7 +2474,7 @@ } else if (ask === 'request') { this.$el.addClass('requesting-xmpp-contact'); this.$el.html(this.request_template(item.toJSON())); - converse.showControlBox(); + converse.controlboxtoggle.showControlBox(); } else if (subscription === 'both' || subscription === 'to') { this.$el.addClass('current-xmpp-contact'); this.$el.html(this.template( @@ -3204,7 +3175,8 @@ 'submit form#converse-login': 'authenticate' }, tab_template: _.template( - 'Finally, Converse.js requires a special snippet of HTML markup to be included in your page:
-<div id="chatpanel">
- <div id="collective-xmpp-chat-data"></div>
- <div id="toggle-controlbox">
- <a href="#" class="chat toggle-online-users">
- <strong class="conn-feedback">Toggle chat</strong> <strong style="display: none" id="online-count">(0)</strong>
- </a>
- </div>
-</div>
+<div id="conversejs"></div>
The index.html file inside the Converse.js repository serves as a nice usable example of this.
@@ -547,23 +543,62 @@ page load.If set to true, only online users will be shown in the contacts roster. Users with any other status (e.g. away, busy etc.) will not be shown.
Default = false
+Note
+XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
+This option will let converse.js make an AJAX POST with your changed custom chat status to a +remote server.
+Note
+XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
+Default = Empty string
+Used only in conjunction with xhr_custom_status.
+This is the URL to which the AJAX POST request to set the user’s custom status +message will be made.
+The message itself is sent in the request under the key msg.
+Default = false
+Note
+XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
+There are two ways to add users.
This setting enables the second mechanism, otherwise by default the first will -be used.
+This setting enables the second mechanism, otherwise by default the first will be used.
+What is expected from the remote server?
+A default JSON encoded list of objects must be returned. Each object +corresponds to a matched user and needs the keys id and fullname.
+Note
+XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
+Default = Empty string
+Used only in conjunction with xhr_user_search.
+This is the URL to which an AJAX GET request will be made to fetch user data from your remote server. +The query string will be included in the request with q as its key.
Please make sure to read the section Development and that you have installed all development dependencies (long story short, you can run npm install and then grunt fetch).
@@ -580,7 +615,7 @@ using almNote
Translations take up a lot of space and will bloat your minified file. diff --git a/docs/html/searchindex.js b/docs/html/searchindex.js index 446b8b29c..d848b9489 100644 --- a/docs/html/searchindex.js +++ b/docs/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({objects:{},terms:{all:0,code:0,partial:0,queri:0,global:0,webchat:0,follow:0,middl:0,depend:0,sensit:0,punjab:0,present:0,under:0,spec:0,string:0,fals:0,account:0,facebook:0,jack:0,veri:0,tri:0,chatpanel:0,list:0,sane:0,div:0,pleas:0,prevent:0,almond:0,past:0,second:0,pass:0,download:0,further:0,fullnam:0,click:0,even:0,index:0,what:0,hide:0,appear:0,section:0,access:0,"public":0,version:0,"new":0,net:0,method:0,widget:0,themselv:0,gener:0,here:0,bodi:0,let:0,path:0,strong:0,modifi:0,valu:0,box:0,great:0,convers:0,mysit:0,ajax:0,fetch:0,implement:0,sorri:0,via:0,repositori:0,extra:0,solut:0,prefer:0,put:0,href:0,org:0,auto_list_room:0,instal:0,should:0,getsess:0,from:0,zip:0,commun:0,doubl:0,two:0,websit:0,few:0,stylesheet:0,call:0,recommend:0,type:0,until:0,toggl:0,more:0,peopl:0,notic:0,site:0,particular:0,vcard:0,must:0,none:0,room:0,work:0,xhr:0,can:0,lc_messag:0,purpos:0,root:0,blogpost:0,control:0,quickstart:0,give:0,share:0,templat:0,tag:0,proprietari:0,explor:0,onlin:0,occup:0,end:0,goal:0,thing:0,anoth:0,write:0,how:0,sid:0,roster:0,instead:0,css:0,updat:0,npm:0,regener:0,product:0,resourc:0,after:0,usabl:0,befor:0,allow_contact_request:0,underscor:0,data:0,demonstr:0,man:0,"short":0,practic:0,bind:0,show_controlbox_by_default:0,element:0,caus:0,inform:0,show_only_online_us:0,allow:0,parti:0,mechan:0,order:0,feedback:0,chatbox:0,xmpp:0,over:0,becaus:0,through:0,streamlin:0,snippet:0,jid:0,"8147a27e4a7f9b55ffc85c2683f9529a":0,directli:0,fit:0,fix:0,"static":0,pend:0,hidden:0,therefor:0,might:0,them:0,anim:0,"return":0,thei:0,initi:0,rewriterul:0,front:0,now:0,introduct:0,edit:0,revers:0,authent:0,token:0,ejabberd:0,each:0,debug:0,side:0,mean:0,domain:0,individu:0,realli:0,legwork:0,connect:0,happen:0,extract:0,special:0,variabl:0,shown:0,"3rd":0,space:0,miss:0,proxy_pass:0,content:0,rel:0,internet:0,plural:0,factori:0,po2json:0,proxi:0,insid:0,standard:0,standalon:0,reason:0,releas:0,succesfulli:0,afterward:0,rewriteengin:0,could:0,ask:0,keep:0,turn:0,first:0,origin:0,softwar:0,render:0,onc:0,hoop:0,lastnam:0,number:0,yourself:0,restrict:0,instruct:0,alreadi:0,done:0,submit:0,owner:0,custom:0,jabber:0,differ:0,script:0,top:0,attack:0,messag:0,attach:0,stori:0,master:0,jed:0,jcbrand:0,"final":0,listen:0,luckili:0,consol:0,option:0,tool:0,specifi:0,github:0,pars:0,grunt:0,haven:0,serv:0,jump:0,kind:0,bloat:0,provid:0,remov:0,exampl:0,bridg:0,someothersit:0,browser:0,pre:0,"function":0,saa:0,modern:0,ani:0,packag:0,have:0,tabl:0,need:0,moffitt:0,django:0,bosh_service_url:0,prebind:0,min:0,latter:0,port:0,note:0,also:0,contact:0,take:0,which:0,singl:0,sure:0,though:0,unsur:0,who:0,most:0,deploi:0,homepag:0,"class":0,don:0,url:0,request:0,doe:0,part:0,runtim:0,bower:0,usual:0,xdomainrequest:0,devdepend:0,show:0,german:0,text:0,server_nam:0,session:0,fine:0,find:0,help:0,current:0,onli:0,exactli:0,locat:0,just:0,configur:0,apach:0,than:0,busi:0,folder:0,local:0,meant:0,count:0,get:0,soon:0,opkod:0,nativ:0,cannot:0,requir:0,enabl:0,emb:0,mainspec:0,patch:0,reload:0,bad:0,integr:0,contain:0,where:0,set:0,habit:0,stroph:0,see:0,result:0,close:0,page:0,statu:0,said:0,extend:0,state:0,muc:0,between:0,awai:0,experi:0,jasmin:0,screen:0,attribut:0,appreci:0,kei:0,hide_muc_serv:0,javascript:0,style:0,job:0,bosh:0,"5e64a30272af065bd72258c565a03f2f":0,both:0,cor:0,instant:0,shortliv:0,conversej:0,myself:0,etc:0,grain:0,mani:0,login:0,com:0,load:0,node_modul:0,pot:0,assum:0,backend:0,quit:0,sucessfulli:0,addition:0,rebuild:0,compon:0,json:0,much:0,subscrib:0,blob:0,session_kei:0,convert:0,minifi:0,togeth:0,i18n:0,those:0,multi:0,main:0,look:0,servic:0,plugin:0,defin:0,abov:0,error:0,hightlight:0,chat:0,helper:0,demo:0,auto_subscrib:0,non:0,incom:0,rid:0,conn:0,develop:0,open:0,receiv:0,media:0,make:0,minif:0,cross:0,same:0,read:0,onconnectfacebook:0,html:0,chatroom:0,document:0,medit:0,complet:0,signon:0,http:0,webserv:0,optim:0,upon:0,someon:0,hand:0,"50kb":0,user:0,xhr_user_search:0,cssmin:0,recent:0,stateless:0,markup:0,well:0,without:0,command:0,wherebi:0,thi:0,choos:0,latest:0,plural_form:0,protocol:0,firstnam:0,when:0,jshint:0,languag:0,web:0,xmlhttprequest:0,had:0,add:0,other:0,non_amd:0,input:0,match:0,bin:0,applic:0,format:0,webpag:0,amd:0,nginx:0,traffic:0,know:0,background:0,like:0,xss:0,backbon:0,specif:0,server:0,collect:0,benefit:0,either:0,output:0,manag:0,facebookconnect:0,deal:0,nplural:0,some:0,back:0,librari:0,bottom:0,deploy:0,achiev:0,track:0,overcom:0,localhost:0,refer:0,object:0,run:0,host:0,although:0,panel:0,src:0,about:0,controlbox:0,unfortun:0,act:0,own:0,curiou:0,encod:0,automat:0,wrap:0,your:0,merg:0,log:0,wai:0,transfer:0,support:0,"long":0,happi:0,avail:0,includ:0,lot:0,suit:0,analysi:0,head:0,properli:0,form:0,bundl:0,link:0,translat:0,synonym:0,line:0,inlin:0,"true":0,bug:0,congratul:0,longer:0,info:0,pull:0,made:0,dirti:0,tab:0,possibl:0,"default":0,bugfix:0,displai:0,asynchron:0,below:0,tightli:0,otherwis:0,problem:0,expect:0,featur:0,creat:0,doesn:0,msgmerg:0,exist:0,file:0,face:0,check:0,want:0,tip:0,detail:0,gettext:0,field:0,valid:0,rememb:0,test:0,you:0,servernam:0,nice:0,node:0,intend:0,stai:0,lang:0,requirej:0,directori:0,virtualhost:0,getjson:0,allow_muc:0,ignor:0,locale_data:0,potenti:0,time:0},objtypes:{},titles:["Quickstart (to get a demo up and running)"],objnames:{},filenames:["index"]}) \ No newline at end of file +Search.setIndex({objects:{},terms:{all:0,code:0,partial:0,queri:0,global:0,webchat:0,follow:0,middl:0,depend:0,sensit:0,punjab:0,those:0,under:0,sens:0,spec:0,sent:0,string:0,fals:0,account:0,facebook:0,jack:0,veri:0,tri:0,chatpanel:[],list:0,sane:0,div:0,pleas:0,prevent:0,xhr_user_search_url:0,almond:0,past:0,second:0,pass:0,download:0,further:0,fullnam:0,click:0,even:0,index:0,what:0,hide:0,appear:0,section:0,access:0,version:0,"new":0,net:0,"public":0,manag:0,widget:0,themselv:0,gener:0,here:0,bodi:0,let:0,path:0,strong:[],modifi:0,valu:0,box:0,great:0,convers:0,mysit:0,reason:0,fetch:0,implement:0,sorri:0,via:0,although:0,extra:0,apach:0,prefer:0,ask:0,href:0,succesfulli:0,auto_list_room:0,instal:0,getsess:0,from:0,zip:0,commun:0,doubl:0,two:0,websit:0,few:0,stylesheet:0,call:0,recommend:0,msg:0,type:0,until:0,toggl:0,more:0,peopl:0,notic:0,particular:0,vcard:0,must:0,none:[],room:0,work:0,xhr:0,can:0,lc_messag:0,purpos:0,root:0,blogpost:0,control:0,quickstart:0,give:0,share:0,templat:0,tag:0,proprietari:0,explor:0,onlin:0,occup:0,end:0,goal:0,turn:0,anoth:0,snippet:0,how:0,sid:0,instead:0,css:0,updat:0,npm:0,regener:0,product:0,resourc:0,haven:0,after:0,usabl:0,befor:0,allow_contact_request:0,underscor:0,data:0,demonstr:0,man:0,github:0,practic:0,bind:0,show_controlbox_by_default:0,correspond:0,django:0,caus:0,inform:0,show_only_online_us:0,allow:0,media:0,mechan:0,order:0,feedback:0,chatbox:0,xmpp:0,over:0,becaus:0,through:0,streamlin:0,write:0,conjunct:0,"8147a27e4a7f9b55ffc85c2683f9529a":0,directli:0,fit:0,fix:0,pend:0,hidden:0,therefor:0,might:0,them:0,anim:0,"return":0,thei:0,initi:0,rewriterul:0,front:0,now:0,introduct:0,edit:0,revers:0,authent:0,token:0,ejabberd:0,each:0,debug:0,side:0,mean:0,domain:0,"short":0,individu:0,realli:0,legwork:0,connect:0,happen:0,patch:0,extract:0,special:0,variabl:0,shown:0,"3rd":0,space:0,miss:0,proxy_pass:0,content:0,rel:0,internet:0,plural:0,factori:0,po2json:0,proxi:0,insid:0,standard:0,standalon:0,ajax:0,put:0,org:0,afterward:0,xhr_custom_status_url:0,could:0,keep:0,thing:0,xhr_custom_statu:0,first:0,origin:0,softwar:0,render:0,onc:0,hoop:0,lastnam:0,number:0,yourself:0,restrict:0,instruct:0,alreadi:0,done:0,"long":0,owner:0,happi:0,jabber:0,differ:0,script:0,top:0,attack:0,messag:0,attach:0,stori:0,master:0,jed:0,jcbrand:0,"final":0,listen:0,luckili:0,consol:0,option:0,tool:0,specifi:0,part:0,pars:0,grunt:0,than:0,serv:0,jump:0,kind:0,bloat:0,provid:0,remov:0,bridg:0,someothersit:0,browser:0,pre:0,analysi:0,saa:0,modern:0,ani:0,packag:0,style:[],have:0,tabl:0,need:0,moffitt:0,element:0,bosh_service_url:0,prebind:0,min:0,latter:0,port:0,note:0,also:0,exampl:0,take:0,which:0,singl:0,sure:0,deploy:0,unsur:0,who:0,most:0,deploi:0,homepag:0,"class":0,don:0,url:0,request:0,doe:0,runtim:0,bower:0,latest:0,xdomainrequest:0,devdepend:0,show:0,german:0,text:0,server_nam:0,session:0,fine:0,find:0,help:0,xml:0,current:0,onli:0,exactli:0,locat:0,firstnam:0,configur:0,solut:0,should:0,busi:0,folder:0,local:0,meant:0,info:0,get:0,soon:0,opkod:0,nativ:0,cannot:0,requir:0,enabl:0,emb:0,mainspec:0,multi:0,achiev:0,method:0,reload:0,bad:0,integr:0,though:0,contain:0,where:0,set:0,habit:0,stroph:0,see:0,result:0,close:0,statu:0,said:0,kei:0,state:0,muc:0,between:0,awai:0,experi:0,jasmin:0,hide_muc_serv:0,attribut:0,appreci:0,extend:0,screen:0,javascript:0,jid:0,job:0,bosh:0,otherwis:0,"5e64a30272af065bd72258c565a03f2f":0,both:0,cor:0,instant:0,shortliv:0,conversej:0,etc:0,grain:0,mani:0,login:0,com:0,load:0,node_modul:0,pot:0,non:0,assum:0,backend:0,quit:0,sucessfulli:0,addition:0,rebuild:0,empti:0,compon:0,json:0,much:0,subscrib:0,non_amd:0,session_kei:0,convert:0,minifi:0,togeth:0,i18n:0,present:0,myself:0,main:0,look:0,servic:0,plugin:0,defin:0,abov:0,error:0,hightlight:0,file:0,helper:0,demo:0,auto_subscrib:0,site:0,itself:0,incom:0,rid:0,conn:[],develop:0,open:0,receiv:0,parti:0,make:0,minif:0,cross:0,same:0,webpag:0,onconnectfacebook:0,html:0,chatroom:0,document:0,medit:0,complet:0,signon:0,http:0,webserv:0,optim:0,upon:0,someon:0,hand:0,remot:0,"50kb":0,user:0,xhr_user_search:0,cssmin:0,recent:0,stateless:0,markup:0,well:0,without:0,command:0,wherebi:0,thi:0,choos:0,usual:0,plural_form:0,protocol:0,just:0,tip:0,jshint:0,languag:0,web:0,xmlhttprequest:0,had:0,add:0,valid:0,blob:0,input:0,match:0,bin:0,applic:0,format:0,read:0,amd:0,nginx:0,traffic:0,know:0,background:0,backbon:0,xss:0,like:0,specif:0,server:0,collect:[],benefit:0,either:0,output:0,page:0,facebookconnect:0,deal:0,nplural:0,some:0,back:0,librari:0,bottom:0,roster:0,rewriteengin:0,track:0,contact:0,overcom:0,localhost:0,refer:0,object:0,run:0,host:0,repositori:0,post:0,panel:0,src:0,about:0,controlbox:0,unfortun:0,stand:0,act:0,own:0,curiou:0,encod:0,automat:0,wrap:0,chang:0,your:0,merg:0,log:0,wai:0,transfer:0,support:0,submit:0,custom:0,avail:0,includ:0,lot:0,suit:0,"function":0,head:0,properli:0,form:0,bundl:0,link:0,translat:0,synonym:0,line:0,inlin:0,"true":0,bug:0,congratul:0,requirej:0,count:[],pull:0,made:0,dirti:0,tab:0,possibl:0,"default":0,bugfix:0,displai:[],asynchron:0,below:0,tightli:0,"static":0,problem:0,expect:0,featur:0,creat:0,doesn:0,msgmerg:0,exist:0,chat:0,face:0,check:0,want:0,when:0,detail:0,gettext:0,field:0,other:0,rememb:0,test:0,you:0,servernam:0,nice:0,node:0,intend:0,releas:0,stai:0,lang:0,longer:0,directori:0,virtualhost:0,getjson:0,allow_muc:0,ignor:0,locale_data:0,potenti:0,time:0},objtypes:{},titles:["Quickstart (to get a demo up and running)"],objnames:{},filenames:["index"]}) \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index c840448f6..e6dbccf4e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -57,14 +57,7 @@ Finally, Converse.js requires a special snippet of HTML markup to be included in :: -