social_stream-presence 0.1.2 → 0.1.4

data/app/assets/javascripts/chat_interface_manager.js.erb

@@ -18,19 +18,20 @@ statusIcons['dnd'] = "dnd";
 
 var connectButtonTimer;
 var periodBetweenAttempts=15; //(seg)
-var connectButtonTimerCounter=periodBetweenAttempts;
+var connectButtonTimerCounter=periodBetweenAttempts+1;
 
 function connectButtonTimerFunction(){
-	  if(connectButtonTimerCounter < periodBetweenAttempts){
-			connectButtonTimerCounter++;
-		} else if (connectButtonTimerCounter == periodBetweenAttempts) {
+		connectButtonTimerCounter++;
+		if (connectButtonTimerCounter > (periodBetweenAttempts-1)) {
+			clearTimeout(connectButtonTimer);
 			$("#chat_header_title").html('<%=I18n.t('chat.disconnected')%>')
 		}
 }
 
 function requestConnectToChat(){
   if (connectButtonTimerCounter > (periodBetweenAttempts-1)) {
-    connectButtonTimerCounter=0; 
+    connectButtonTimerCounter=0;
+		connectButtonTimer = setInterval("connectButtonTimerFunction()", 1000) 
 		$("#chat_header_title").html('<%=I18n.t('chat.connecting')%>')
     return true
   } else {
@@ -292,4 +293,41 @@ function putReceivedMessageOnChatWindow(from_jid,from_slug,body,msgID){
 		playSound("onMessageAudio");
 	}
 	
+}
+
+
+////////////////////
+//Notifications on chat Window
+////////////////////
+
+function showChatNotificationForSlug(slug,msg){
+	var notification = $("#" + slug).parent().find("div.ui-chatbox-notify");
+	showChatNotification(notification,msg);
+}
+
+function showChatNotification(notification,msg){
+  notification.html("<p class==\"ui-chatbox-notify-text\">" + msg + "</p>");
+  notification.css("visibility","visible");
+  notification.fadeIn();
+}
+
+function hideChatNotificationForSlug(slug){
+  var notification = $("#" + slug).parent().find("div.ui-chatbox-notify");
+	hideChatNotification(notification);
+}
+
+function hideChatNotification(notification){
+  notification.fadeOut();
+  notification.css("visibility","hidden");
+}
+
+function notifyWhenUsersDisconnect(){
+	var notification = $("div.ui-chatbox-notify");
+	var msg = '<%=I18n.t('chat.notify.offline')%>';
+	showChatNotification(notification,msg);
+}
+
+function hideAllNotifications(){
+	var notification = $("div.ui-chatbox-notify");
+  hideChatNotification(notification);
 }

data/app/assets/javascripts/chat_utilities.js

@@ -65,6 +65,19 @@ function blinkTitleOnMessage(username){
 
 
 
+////////////////////
+//Control user data input on the chatbox
+////////////////////
+
+//Return true to allow user to send data to the chatbox.
+function userChatDataInputControl(){
+	var floodControlBoolean = floodControl();
+  var offlineDataSendControlBoolean = offlineDataSendControl();
+	return (floodControlBoolean && offlineDataSendControlBoolean);
+}
+
+
+
 ////////////////////
 //Antiflood
 ////////////////////
@@ -190,6 +203,19 @@ function mustBounceBoxForChatWindow(jqueryUIChatbox){
 	
 }
 
+
+
+////////////////////
+//Prevent user to send data to the chatbox when he is offline.
+////////////////////
+
+function offlineDataSendControl(){
+	return ((!disconnectionFlag) && (isStropheConnected()));
+}
+
+
+
+
 ////////////////////
 //Next features...
 ////////////////////

data/app/assets/javascripts/xmpp_client_management.js.erb

@@ -160,6 +160,7 @@ function onConnect(status) {
     log('Strophe is disconnected.');
 		disconnectionFlag = true;
 	  clearTimeout(awayTimer);
+		notifyWhenUsersDisconnect();
 	  reconnectTimer = setTimeout ("onReconnect()", 5000);
   } else if (status == Strophe.Status.CONNECTED) {
     log('Strophe is connected.');
@@ -173,13 +174,14 @@ function onConnect(status) {
 	  sendStatus(userStatus);
     awayTimer = setInterval("awayTimerFunction()", awayTimerPeriod);
 	  timer = setInterval("timerFunction()", timerPeriod);
+		hideAllNotifications();
   }
 	
 	updateChatWindow();
 }
 
 function onReconnect(){
-	log("onReconnect!")
+	
 	if ((!isStropheConnected())&&(userStatus!="offline")) {
 		
 		if (reconnectAttempts>0) {
@@ -273,6 +275,7 @@ function processAvailablePresenceStanza(presence){
       setUserIconStatus(slug, status);
 			if (cacheConnectedUsers.indexOf(slug) != -1) {
 	  	  showConnectionBoxFromSlug(slug);
+				hideChatNotificationForSlug(slug);
 	    }	
 	  } else {
 	    setTimeout("refreshChatWindow()", 3000);
@@ -287,6 +290,7 @@ function processUnavailablePresenceStanza(presence){
 	if (slug != user_slug) {
 	  if (getConnectionBoxFromSlug(slug)!=null){
 	    hideConnectionBoxFromSlug(slug)
+			showChatNotificationForSlug(slug,$(getConnectionBoxFromSlug(slug)).attr("name") + " is offline");
 	  }
   }
 }

data/app/assets/stylesheets/chat.css

@@ -62,6 +62,30 @@
     clear: both;
 }
 
+div.ui-chatbox-notify{
+	visibility: hidden;
+	background: #E5E5E5;
+	background-color: #E5E5E5;
+	color: black;
+	z-index: 1;
+	position:absolute;
+	top: 0;
+	margin-top: 30px;
+	padding: 4px 0px 4px 0px;
+	width: 236px;
+	text-align: center;
+	border-style:solid;
+  border-width:1px;
+	border-color: #CCCCCC;
+	opacity:0.95;
+  filter:alpha(opacity=95); /* For IE8 and earlier */
+}
+
+p.ui-chatbox-notify-text{
+  text-align: center;
+	font-weight: bold;
+}
+
 
 /* Ticks */
 

data/app/views/chat/_off.html.erb

@@ -1,9 +1,6 @@
      <script type="text/javascript">
 				$(document).ready(function () {
 
-          connectButtonTimer = setInterval("connectButtonTimerFunction()", 1000)
-					connectButtonTimerCounter=periodBetweenAttempts+1
-
 					if (authByCookie()){
 					  //Authentication by cookie
             

data/app/views/xmpp/active_users.html.erb

@@ -11,7 +11,7 @@
 <p>&nbsp;</p>
 <ul>
   <%@users.each do |user| %>
-    <li><b><%=user.name%></b></li>
+    <li><b><%=user.name%></b> (<%=user.status%>) </li>
   <%end%>
  </ul>
 <p>&nbsp;</p>

data/config/locales/en.yml

@@ -3,7 +3,7 @@ en:
     connecting: "Chat Connecting"
     reconnecting: "Chat Reconnecting"
     disconnected: "Chat Disconnected"
-    unableconnect: "Chat Disconnected"
+    unableconnect: "Chat Out of Service"
     title: "Chat"
     password: "Password"
     status: 
@@ -15,4 +15,6 @@ en:
     settings:
       title: "Enable and configure Social Stream Chat"  
       checkbox: "Enable or disable Social Stream Chat"  
-      update: "Update Settings"
+      update: "Update Settings"
+    notify:
+      offline: "You are offline"

data/config/locales/es.yml

@@ -3,7 +3,7 @@ es:
     connecting: "Chat Conectando"
     reconnecting: "Chat Reconectando"
     disconnected: "Chat Desconectado"
-    unableconnect: "Chat Desconectado"
+    unableconnect: "Chat Fuera de servicio"
     title: "Chat"
     password: "Contraseña"
     status:
@@ -16,4 +16,6 @@ es:
       title: "Activación y configuración del chat de Social Stream"
       checkbox: "Activar o desactivar chat"  
       update: "Guardar configuración"
+    notify:
+      offline: "Desconectado"
        

data/config/routes.rb

@@ -1,13 +1,13 @@
 Rails.application.routes.draw do
   #match "/active_users" => "Xmpp#active_users"
   
-  match '/xmpp/resetConnection' => "Xmpp#resetConnection"
   match '/xmpp/setConnection' => "Xmpp#setConnection"
   match '/xmpp/unsetConnection' => "Xmpp#unsetConecction"
-  match '/xmpp/synchronizePresence' => "Xmpp#synchronizePresence"
   match '/xmpp/setPresence' => "Xmpp#setPresence"
   match '/xmpp/unsetPresence' => "Xmpp#unsetPresence"
-  match '/chatWindow'=> "Xmpp#chatWindow"
+  match '/xmpp/resetConnection' => "Xmpp#resetConnection"
+  match '/xmpp/synchronizePresence' => "Xmpp#synchronizePresence"
   match '/xmpp/updateSettings'=> "Xmpp#updateSettings"
+  match '/chatWindow'=> "Xmpp#chatWindow"
    
 end

data/ejabberd/conf/ssconfig_example.cfg

@@ -1,38 +1,32 @@
-#Social Stream Presence: ejabberd config
+#Social Stream Presence: Ejabberd configuration file
 
 #Ejabberd node server domain
-server_domain=domain.example.com
+server_domain=xmppdomain.example.com
 
 #Scripts Path
 scripts_path=/my_scripts_path
 
-#Source path: uncomment to compile ejabberd social stream module
-#source_path=/.../ejabberd_source/src
-
 #It is also necessary to modify the file: /etc/ejabberd/ejabberd.cfg
 #%%{auth_method, external}.
 #%%{extauth_program, "scripts_path/authentication_script"}.
 
-#API REST
-auth_api=http://localhost/users/sign_in
-auth_by_cookie_api=http://localhost/api/me
-cookie_name=_rails_server_cookie
-set_connection_api=http://localhost/xmpp/setConnection
-unset_connection_api=http://localhost/xmpp/unsetConnection
-reset_connection_api=http://localhost/xmpp/resetConnection
-synchronize_presence_api=http://localhost/xmpp/synchronizePresence
-set_presence_api=http://localhost/xmpp/setPresence
-unset_presence_api=http://localhost/xmpp/unsetPresence
+#Source path: uncomment to compile ejabberd social stream module
+#source_path=/.../ejabberd_source/src
+
 
-#Social Stream Login
-ss_login=social_stream-presence
+#Web Domain for REST API
+web_domain=ssdomain.example.com
+
+#Rails Web Server Cookie name
+#Check this line in your app/config/initializers/session_store.rb: Global::Application.config.session_store :cookie_store, :key => '_rails_server_cookie'
+cookie_name=_rails_server_cookie
 
-#Social Stream PASSWORD
-ss_password=password
 
 #Ejabberd Server Password
 ejabberd_password=password
 
+
 #Emanagement configuration
-users_require_sudo=user1,user2,...
+ejabberd_server_user=ejabberd
+users_require_sudo=all
 verbose=false

data/ejabberd/ejabberd_scripts/authentication_script

@@ -31,11 +31,9 @@ def getOption(option)
   return "Undefined"
 end
 
-$accessUrl = getOption("auth_api=")
-$accessByCookieUrl = getOption("auth_by_cookie_api=")
+$accessByPasswordUrl = "http://" + getOption("web_domain=") + "/users/sign_in"
+$accessByCookieUrl = "http://" + getOption("web_domain=") + "/api/me"
 $cookie_name = getOption("cookie_name=")
-$sslogin = getOption("ss_login=")
-$sspass = getOption("ss_password=")
 
 
 def auth(username, password)
@@ -48,17 +46,9 @@ def auth(username, password)
   #  return true
   #end
 
-  #Social Stream password
-  if username == $sslogin 
-    if password == $sspass
-      return true
-    else
-      return false
-    end
-  end
 
   begin
-    response = RestClient.post $accessUrl, :user => { :email => username , :password => password }
+    response = RestClient.post $accessByPasswordUrl, :user => { :email => username , :password => password }
 
     if response.code == 201
       return true

data/ejabberd/ejabberd_scripts/development_scripts/show_config.sh

@@ -17,17 +17,21 @@ end
 puts ""
 puts "############### Ejabberd Configuration ###############"
 puts "Config file for Social Stream Presence: /etc/ejabberd/ssconfig.cfg"
+puts "Xmpp Server domain: #{getOption("server_domain=")}"
 puts "Scripts Path: #{getOption("scripts_path=")}"
 puts "mod_sspresence Path: #{getOption("source_path=")}"
-puts "Server domain: #{getOption("server_domain=")}"
-puts "API REST URLs"
-puts "Authentication: #{getOption("auth_api=")}"
-puts "onRegisterConnection: #{getOption("set_connection_api=")}"
-puts "onRemoveConnection: #{getOption("unset_connection_api=")}"
-puts "onPresence: #{getOption("set_presence_api=")}"
-puts "onUnsetPresence: #{getOption("unset_presence_api=")}"
-puts "ResetConnection: #{getOption("reset_connection_api=")}"
-puts "SynchronizePresence: #{getOption("synchronize_presence_api=")}"
+puts "Web Domain for REST API: #{getOption("web_domain=")}"
+puts "##############################"
+puts "REST API"
+puts "Authentication by password: http://#{getOption("web_domain=")}/users/sign_in"
+puts "Authentication by cookie: http://#{getOption("web_domain=")}/api/me"
+puts "onRegisterConnection: http://#{getOption("web_domain=")}/xmpp/setConnection"
+puts "onRemoveConnection: http://#{getOption("web_domain=")}/xmpp/unsetConnection"
+puts "onPresence: http://#{getOption("web_domain=")}/xmpp/setPresence"
+puts "onUnsetPresence: http://#{getOption("web_domain=")}/xmpp/unsetPresence"
+puts "ResetConnection: http://#{getOption("web_domain=")}/xmpp/resetConnection"
+puts "SynchronizePresence: http://#{getOption("web_domain=")}/xmpp/synchronizePresence"
+puts "##############################"
 puts "Social Stream Presence logs in var/log/ejabberd/"
 puts "######################################################"
 puts ""

data/ejabberd/ejabberd_scripts/emanagement

@@ -31,6 +31,8 @@ end
 #Configuration variables
 $domain = getOption("server_domain=")
 $verbose = (getOption("verbose=")=="true")
+$ejabberd_user = getOption("ejabberd_server_user=")
+$checkEjabberdctlQuotedString = false
 
 
 PARAMS_FOR_COMMANDS = {
@@ -41,9 +43,7 @@ PARAMS_FOR_COMMANDS = {
 	'getRoster' => 1,
 	'removeRoster' => 1,
 	'removeAllRosters' => 0,
-	'getBuddysFromRoster' => 1,
 	'getAllUsersWithRoster' => 0,
-	'getAllRosters' => 0,
 	'printAllRosters' => 0,
 	'printAllBidirecctionalBuddys' => 0,
 	'checkUser' => 1,
@@ -54,7 +54,9 @@ PARAMS_FOR_COMMANDS = {
 	'sendMessageToUser' => 3,
 	'getUserResource' => 1,
 	'isEjabberdNodeStarted' => 0,
+	'broadcast' => 2,
 	'checkEjabberdctlQuotedString' => 0,
+        'getConnectedUsers' => 0,
 	'help' => 0,
 }
 
@@ -66,9 +68,7 @@ SYNTAX_FOR_COMMANDS = {
 	'getRoster' => 'getRoster username',
 	'removeRoster' => 'removeRoster username',
 	'removeAllRosters' => 'removeAllRosters',
-	'getBuddysFromRoster' => 'getBuddysFromRoster roster',
 	'getAllUsersWithRoster' => 'getAllUsersWithRoster',
-	'getAllRosters' => 'getAllRosters',
 	'printAllRosters' => 'printAllRosters',
 	'printAllBidirecctionalBuddys' => 'printAllBidirecctionalBuddys',
 	'checkUser' => 'checkUser user',
@@ -79,7 +79,9 @@ SYNTAX_FOR_COMMANDS = {
 	'sendMessageToUser' => 'sendMessageToUser from_name to_name msg',
 	'getUserResource' => 'getUserResource username',
 	'isEjabberdNodeStarted' => 'isEjabberdNodeStarted',
+	'broadcast' => 'broadcast users msg (users values: "all" or slugs array)',
 	'checkEjabberdctlQuotedString' => 'checkEjabberdctlQuotedString',
+        'getConnectedUsers' => 'getConnectedUsers',
 	'help' => 'help',
 }
 
@@ -285,13 +287,6 @@ end
 
 #Manage stanzas Utilities
 
-def sendStanzaUserMessage(username,msg)
-	resource = getUserResource(username);
-	stanza = "\\<\\'message\\'\\>\\<\\'body\\'\\>\\'" + msg + "\\'\\<\\'/body\\'\\>\\<\\'/message\\'\\>"
-	executeCommand("ejabberdctl send_stanza_c2s " + username + " " + $domain + " " + resource + " " + stanza)
-	return "Done"
-end
-
 def setPresence(username)
 	sendPresenceStanzaWithType(username,username,"available")
 end
@@ -305,12 +300,14 @@ def sendPresence(username,show)
 end
 
 def sendPresenceWithShow(from_name,to_name,show)
-	puts from_name
+	#puts from_name
 	resource = getUserResource(from_name);
-	puts resource
+	#puts resource
 	from_sid = from_name + "@" + $domain;
 	to_sid = to_name + "@" + $domain;   
-	pres_stanza = "\\<\\'presence from=\\'\\\"\\'" + from_sid + "\\'\\\"\\' to=\\'\\\"\\'" + to_sid + "\\'\\\"\\>\\<\\'show\\'\\>\\'" + show + "\\'\\<\\'/show\\'\\>\\<\\'/presence\\'\\>" 
+	pres_stanza = "\\<" + buildQuotedString("presence from=") + "\\\"" + buildQuotedString(from_sid) + "\\\"" + buildQuotedString(" to=") + "\\\"" +
+			buildQuotedString(to_sid) + "\\\"\\>\\<" + buildQuotedString("show") + "\\>" + buildQuotedString(show) + "\\<" +
+			buildQuotedString("/show") + "\\>\\<" + buildQuotedString("/presence") + "\\>"
 	executeCommand("ejabberdctl send_stanza_c2s " + from_name + " " + $domain + " " + resource + " " + pres_stanza)
 	return "Done"
 end
@@ -319,7 +316,8 @@ def sendPresenceStanzaWithType(from_name,to_name,presence_type)
 	resource = getUserResource(from_name);
 	from_sid = from_name + "@" + $domain;
 	to_sid = to_name + "@" + $domain;
-	pres_stanza = "\\<\\'presence type=\\'\\\"\\'" + presence_type + "\\'\\\"\\' from=\\'\\\"\\'" + from_sid + "\\'\\\"\\' to=\\'\\\"\\'" + to_sid + "\\'\\\"\\>\\<\\'/presence\\'\\>" 
+	pres_stanza = "\\<" + buildQuotedString("presence type=") + "\\\"" + buildQuotedString(presence_type) + "\\\"" + buildQuotedString(" from=") + "\\\"" + 
+		buildQuotedString(from_sid) + "\\\"" + buildQuotedString(" to=") + "\\\"" + buildQuotedString(to_sid) + "\\\"\\>\\<" + buildQuotedString("/presence") + "\\>" 
 	executeCommand("ejabberdctl send_stanza_c2s " + from_name + " " + $domain + " " + resource + " " + pres_stanza)
 	return "Done"
 end
@@ -356,17 +354,52 @@ def isEjabberdNodeStarted
 	return false
 end
 
+def getConnectedUsers
+        users = []
+	output = executeCommand("ejabberdctl connected-users")
+	sessions = output.split("\n")
+	sessions.each do |session|
+	  users << session.split("@")[0]
+	end
+	return users
+end
+
+def broadcast(users,msg)
+	output = executeCommand("ejabberdctl connected-users")
+        lines = output.split("\n");
+	lines.each do |line|
+		username = line.split("@")[0]
+		if (users == "all") or (users.length > 1 and users.include?(username))
+			s = line.split("@")[1];
+			resource = s.split("/")[1];
+			sendMessageToUser("SocialStream",username,msg)
+		end
+	end
+	return "Done"
+end
+
+#Determine how to scape characters for build quoted strings
 def checkEjabberdctlQuotedString
 	puts "checkForSimpleSlash: " + checkForSimpleSlash.to_s()
 	puts "checkForDoubleSlash: " + checkForDoubleSlash.to_s()
 end
 
+def checkAndSetEjabberdctlQuotedString
+	if checkForSimpleSlash
+		$checkForSimpleSlash = true
+	end
+	if checkForDoubleSlash
+		$checkForDoubleSlash = true
+	end
+	$checkEjabberdctlQuotedString = true	
+end
+
 def checkForDoubleSlash
 	command = "ejabberdctl send_message_chat example@localhost example@localhost \\'Hello quoted string\\'"
 	if execute_as_sudo
 		command = "sudo " + command
 	end
-	#puts "Executing " + command
+	
 	output = %x[#{command}]
 	firstLine = ""
 	lines = output.split("\n")
@@ -414,10 +447,14 @@ def checkForSimpleSlash
 end
 
 def buildQuotedString(msg)
-	if checkForSimpleSlash
+	if !$checkEjabberdctlQuotedString
+		checkAndSetEjabberdctlQuotedString
+	end
+	
+	if $checkForSimpleSlash
 		return "\'" + msg + "\'"
 	end
-	if checkForDoubleSlash
+	if $checkForDoubleSlash
 		return "\\'" + msg + "\\'"
 	end
 	return msg
@@ -431,7 +468,8 @@ def executeCommand(command)
 	command = buildCommand(command)
 	
 	if $verbose
-		puts "Executing: " + command
+		#Logging...
+		#puts "Executing: " + command
 		ejabberdLog("Executing (#{command})")
 	end
 
@@ -442,15 +480,20 @@ end
 
 def buildCommand(command)
 	if execute_as_sudo
-		command = "sudo -u ejabberd " + command
+		command = "sudo -u " + $ejabberd_user + " " + command
 	end
 	return command
 end
 
 def execute_as_sudo
-	current_user = %x["whoami"].split("\n")[0]
 	sudo_users = getOption("users_require_sudo=")
+
+	if sudo_users=="all"
+	 return true
+	end
+
 	sudo_users_array = sudo_users.split(",")
+        current_user = %x["whoami"].split("\n")[0]
 	if sudo_users_array.include?(current_user)
 		return true
 	end
@@ -468,7 +511,7 @@ end
 
 #Main thread
 
-log("Init Ejabberd Maintenance script")
+#log("Init Ejabberd Maintenance script")
 
 begin
 	if ARGV[0] and PARAMS_FOR_COMMANDS.keys.include?(ARGV[0])