social_stream 0.11.2 → 0.11.3

data/presence/ejabberd/mod_sspresence/mod_sspresence.erl

@@ -0,0 +1,230 @@
+-module(mod_sspresence).
+
+-behavior(gen_mod).
+
+-include("ejabberd.hrl").
+
+-export([start/2, stop/1, on_register_connection/3, on_remove_connection/3, on_presence/4, on_unset_presence/4, isConnected/1, on_packet_send/3]).
+
+start(Host, _Opts) ->
+    ?INFO_MSG("mod_sspresence starting", []),
+    ejabberd_hooks:add(sm_register_connection_hook, 	Host, ?MODULE, on_register_connection, 50),
+    ejabberd_hooks:add(sm_remove_connection_hook, 	Host, ?MODULE, on_remove_connection, 50),
+    ejabberd_hooks:add(set_presence_hook, 		Host, ?MODULE, on_presence, 50),
+    ejabberd_hooks:add(unset_presence_hook, 		Host, ?MODULE, on_unset_presence, 50),
+    ejabberd_hooks:add(user_send_packet, 		Host, ?MODULE, on_packet_send, 50),
+    %Uncomment to reset connected users directly when module sspresence starts.
+    %reset_connections(),
+    ok.
+
+stop(Host) ->
+    ?INFO_MSG("mod_sspresence stopping", []),
+    ejabberd_hooks:delete(sm_register_connection_hook, 	Host, ?MODULE, on_register_connection, 50),
+    ejabberd_hooks:delete(sm_remove_connection_hook, 	Host, ?MODULE, on_remove_connection, 50),
+    ejabberd_hooks:delete(set_presence_hook, 		Host, ?MODULE, on_presence, 50),
+    ejabberd_hooks:delete(unset_presence_hook, 		Host, ?MODULE, on_unset_presence, 50),
+    ejabberd_hooks:delete(user_send_packet, 		Host, ?MODULE, on_packet_send, 50),
+    ok.
+
+
+
+on_register_connection(_SID, _JID, _Info) ->
+    {_A,User,_B,_C,_D,_E,_F} = _JID,
+    ?INFO_MSG("mod_sspresence: on_register_connection (~p)", [User]),
+    Login_path = string:concat(getOptionValue("scripts_path="), "/set_connection_script "),
+    os:cmd(string:join([Login_path, User ], " ")),
+    ok.
+
+on_remove_connection(_SID, _JID, _SessionInfo) ->
+    {_A,User,_B,_C,_D,_E,_F} = _JID,
+    ?INFO_MSG("mod_sspresence: on_remove_connection (~p)", [User]),
+    Connected = isConnected(User),
+    case Connected of
+	true -> ok;
+	_ -> Logout_path = string:concat(getOptionValue("scripts_path="), "/unset_connection_script "),
+             os:cmd(string:join([Logout_path, User ], " "))
+    end,
+    ok.
+
+on_presence(User, _Server, _Resource, Packet) ->
+     ?INFO_MSG("mod_sspresence: on_presence (~p)", [User]),
+     {_xmlelement, Type, _Attr, Subel} = Packet,
+
+    case Type of
+	"presence" -> Status = getStatusFromSubel(Subel),
+		      Login_path = string:concat(getOptionValue("scripts_path="), "/set_presence_script "),
+		      ?INFO_MSG("mod_sspresence: set_presence_script call with  user (~p) and status (~p)", [User,Status]),
+    		      os:cmd(string:join([Login_path, User , Status], " "));
+	_ -> ok
+    end,
+    ok.
+
+on_unset_presence(User, _Server, _Resource, _Status) ->
+    ?INFO_MSG("mod_sspresence: on_unset_presence (~p)", [User]),
+    ok.
+
+on_packet_send(From, _To, {xmlelement, Type, _Attr, Subel} = _Packet) ->
+    case Type of
+	"message" -> 
+		{_SenderJID,Sender,_SenderDomain,_A,_B,_C,_D} = From,
+		
+		SSlogin = getOptionValue("ss_login="),
+
+		case Sender of
+			SSlogin ->
+                                Message = getMessageFromSubel(Subel),
+				execute(Message);
+                   	_ -> ok
+                end;
+	_ -> ok
+    end.
+
+
+getStatusFromSubel(Subel) ->	
+	try
+            %Strophe tuples
+	    [{_A,"status",[],[{_B,_StatusStrophe}]},{_C,"show",[],[{_D,ShowStrophe}]}|_R1] = Subel,
+	    parseXmlCdata(ShowStrophe)
+	catch
+		_:Reason ->      
+			try
+				%Pidgin tuples
+				[{_E,"show",[],[{_F,ShowPidgin}]}|_R2] = Subel,
+			     	parseXmlCdata(ShowPidgin)
+			catch
+				_:Reason -> "chat" %Status when parsed failed
+			after
+				noop
+			end
+	after
+		noop
+	end. 
+
+
+getMessageFromSubel(Subel) ->
+    [{_I,_J,_K,[{_L,MessageData}]}] = Subel,
+    parseXmlCdata(MessageData).
+
+
+parseXmlCdata(Msg) ->
+	MessageString = binary_to_list(list_to_binary(io_lib:format("~p", [Msg]))),
+	lists:sublist(MessageString, 4, string:len(MessageString)-6).
+
+
+execute(Message) ->
+    %?INFO_MSG("Message vale: ~p", [Message]),
+    [Order|Params] = string:tokens(Message, "&"),
+
+    case Order of
+	"AddItemToRoster" -> 
+	  	case length(Params) of
+			4 -> 	[UserSID,BuddySID,BuddyName,Subscription_type] = Params,
+				?INFO_MSG("Execute: ~p with params ~p", [Order,Params]),
+
+				%Command Name: add_rosteritem
+				% Needs mod_admin_extra (http://www.ejabberd.im/ejabberd-modules)
+				% ejabberdctl add_rosteritem localuser localserver user server nick group subs
+				%subs= none, from, to or both",
+
+				%frank-williamson@trapo adds demo@trapo to its roster 
+				%ejabberdctl add_rosteritem frank-williamson trapo demo trapo NickName SocialStream from
+
+				%frank-williamson@trapo adds demo@trapo and demo@trapo adds frank-williamson@trapo to its roster
+				%ejabberdctl add_rosteritem frank-williamson trapo demo trapo NickName SocialStream both
+				
+				[ContactName|_R] = string:tokens(BuddyName, " "),
+				[UserSlug,UserDomain] = string:tokens(UserSID, "@"),
+				[BuddySlug,BuddyDomain] = string:tokens(BuddySID, "@"),
+
+				Command = lists:concat(["ejabberdctl add_rosteritem ", UserSlug , " ", UserDomain, " ", BuddySlug, " ", BuddyDomain , " ", ContactName , " ", 					"SocialStream" , " ", Subscription_type]),
+				os:cmd(Command),
+				?INFO_MSG("Execute command: ~p", [Command]),
+				ok;
+			_ -> 	?INFO_MSG("Incorrect parameters", []),
+				ok
+	  	end,
+		ok;
+
+	"Synchronize" ->
+	synchronize(),
+	ok;
+
+	_ -> ?INFO_MSG("Command not found", []),
+		ok
+    end.
+
+
+%%GETTERS CONFIG VALUES
+%%CONFIG FILE: /etc/ejabberd/ssconfig.cfg
+
+getOptionValue(Option) ->
+{_, In} = file:open("/etc/ejabberd/ssconfig.cfg", read),
+parser(In,Option).
+
+
+parser(In,Option) ->
+  L = io:get_line(In, ''),
+
+  case L of
+  	eof -> "Undefined";
+  	_ -> {_,S,_} = regexp:gsub(L, "\\n", ""),
+
+
+	%%IGNORE COMMENTS
+	case string:str(S, "#") of
+        	0 -> 
+			case string:str(S, Option) of
+				0 -> ok,
+				%% Continue with next line
+				parser(In,Option);
+		
+				%% return path
+				_ ->  lists:sublist(S, string:len(Option)+1, string:len(S))	
+			end;
+
+        	_ ->  %% Comment: Continue with next line
+		     parser(In,Option)
+	end
+  end. 
+
+
+%%Check if a user is connected (any active session with Ejabberd server)
+isConnected(User) ->
+
+Command = string:concat("ejabberdctl connected-users | grep ", User),
+Output = os:cmd(Command),
+
+case Output of
+  [] -> false;
+  _ -> Sessions = string:tokens(Output, "\n"),
+
+      catch lists:foreach(
+		fun(S) ->
+		        [Slug|_R] = string:tokens(S, "@"),
+		        %User.slug connected = Slug
+			
+			case Slug of
+			  User -> throw(true);
+			  _ -> false
+			end                
+
+		end,
+		Sessions)
+end.
+
+
+%%Send all connected users to Social Stream Rails Application
+synchronize() ->
+	Synchronize_path = string:concat(getOptionValue("scripts_path="), "/synchronize_presence_script "),
+	os:cmd(Synchronize_path),
+ok.
+
+
+%Reset all connections
+%reset_connections() ->
+%	Reset_path = string:concat(getOptionValue("scripts_path="), "/reset_connection_script "),
+%	os:cmd(Reset_path),
+%ok.
+
+
+

data/presence/lib/social_stream-presence.rb

@@ -0,0 +1,13 @@
+require 'social_stream-base'
+
+module SocialStream
+  module Presence   
+
+    module Models
+      autoload :BuddyManager, 'social_stream/presence/models/buddy_manager'
+    end
+
+  end
+end
+
+require 'social_stream/presence/engine'

data/presence/lib/social_stream/migrations/presence.rb

@@ -0,0 +1,9 @@
+require 'social_stream/migrations/components'
+
+module SocialStream
+  module Migrations
+    # Migrate Documents
+    class Presence < Components
+    end
+  end
+end

data/presence/lib/social_stream/presence/config.rb

@@ -0,0 +1,9 @@
+module Socialstream
+  module Presence
+    DOMAIN = "trapo"
+    BOSH_SERVICE = "http://localhost:8080/http-bind"
+    PASSWORD = "DnVCB8G|R$VGmZ@2?5=CYS8z)NrL@LuQ&LTCUh^9B(DF4gC&sQpfbCMbaNKEdNrGYkT4L5zxM0wNWs5q3?ww(b&0d5fK87z^BmgJMMF2SKXT9pEk^UEcch!GX!Avf5GT9)j@FpHe)4RH)BK7J98u!sUmJHUN(Je6aBmn!FtZ4Ab5h8$|nsvUt3Jkq?21HOH$r0sDyJZZvGOCgFS2EKw@0wXsJRHYVRPBe&Eb!1X55e55bQ^h2AW&^R70TK0m)Fu8"
+    XMPP_SERVER_PASSWORD = "G&s6GBnO)anw2Ene%K12Cb=0quj@uDmA"
+    VERSION = "0.0.3"
+  end
+end

data/presence/lib/social_stream/presence/engine.rb

@@ -0,0 +1,49 @@
+require 'xmpp4r'
+require 'xmpp4r/muc'
+require 'xmpp4r/roster'
+require 'xmpp4r/client'
+require 'xmpp4r/message'
+
+module SocialStream
+  module Presence
+    class Engine < Rails::Engine
+      config.to_prepare do
+        
+        #Patching Tie
+        Tie.class_eval do
+          include SocialStream::Presence::Models::BuddyManager
+        end
+        
+      end 
+               
+      initializer "social_stream-presence.synchronize" do
+          #Synchronize User Presence
+          #Implement case XMMP Server Down
+          Thread.start {
+            begin
+              client = Jabber::Client.new(Jabber::JID.new('social_stream-presence@trapo'))
+              client.connect
+              password = Socialstream::Presence::PASSWORD
+              client.auth(password)
+       
+              msg = Jabber::Message::new("social_stream-presence@trapo", "Synchronize")
+              msg.type=:chat
+              client.send(msg)
+              client.close()
+            
+            rescue Errno::ECONNREFUSED
+              #XMPP Server Down
+              #Reset Connected Users
+              users = User.find_all_by_connected(true)
+              users.each do |user|
+                user.connected = false
+                user.save!
+              end
+              
+            end
+          }
+      end
+      
+    end
+  end
+end

data/presence/lib/social_stream/presence/models/buddy_manager.rb

@@ -0,0 +1,67 @@
+require "social_stream/presence/config"
+require 'xmpp4r'
+require 'xmpp4r/muc'
+require 'xmpp4r/roster'
+require 'xmpp4r/client'
+require 'xmpp4r/message'
+
+module SocialStream
+  module Presence
+    module Models
+      module BuddyManager
+        extend ActiveSupport::Concern
+        
+        included do
+          after_create :save_buddy
+        end
+        
+        module InstanceMethods
+          
+          def save_buddy
+
+            unless self.receiver.subject_type == "User" and self.sender.subject_type == "User"
+              return
+            end
+
+            #XMPP DOMAIN
+            domain = Socialstream::Presence::DOMAIN
+            #PASSWORD
+            password= Socialstream::Presence::PASSWORD
+            
+            user_sid = self.sender.slug + "@" + domain
+            buddy_sid = self.receiver.slug + "@" + domain
+            buddy_name =  self.receiver.name
+              
+            #Check Subscription_type
+            if isBidirectionalTie
+              sType = "both"
+            else
+              sType = "from"
+            end 
+            
+            begin
+              client = Jabber::Client.new(Jabber::JID.new('social_stream-presence@trapo'))
+              client.connect
+              password = Socialstream::Presence::PASSWORD
+              client.auth(password)
+   
+              #Sending a message
+              #AddItemToRoster[UserSID,BuddySID,BuddyName,Subscription_type]
+              msg = Jabber::Message::new('social_stream-presence@trapo', "AddItemToRoster&" + user_sid + "&" + buddy_sid + "&" + buddy_name + "&" + sType)
+              msg.type=:chat
+              client.send(msg) 
+            rescue Errno::ECONNREFUSED
+              #Rescue...
+            end
+            
+          end
+          
+          def isBidirectionalTie
+            return true
+          end
+          
+        end
+      end
+    end
+  end
+end

data/presence/social_stream-presence.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "social_stream/presence/config"
+
+Gem::Specification.new do |s|
+  s.name        = "social_stream-presence"
+  s.version     = Socialstream::Presence::VERSION
+  s.authors     = ["Aldo Gordillo"]
+  s.email       = ["iamchrono@gmail.com"]
+  s.homepage    = "https://github.com/ging/social_stream-presence"
+  s.summary = "Presence capabilities for Social Stream, the core for building social network websites"
+  s.description = "Social Stream is a Ruby on Rails engine providing your application with social networking features and activity streams."
+
+  s.rubyforge_project = "social_stream-presence"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  # Gem dependencies
+  s.add_runtime_dependency('social_stream-base','~> 0.9.18')
+  
+  s.add_runtime_dependency "xmpp4r"
+  
+  s.add_development_dependency "ruby-debug19"
+  
+end

data/presence/spec/demo/.gitignore

@@ -0,0 +1,5 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/
+.sass-cache/

data/presence/spec/demo/.rspec

@@ -0,0 +1 @@
+--colour

data/presence/spec/demo/README

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.