vines 0.1.1 → 0.2.0

data/README

@@ -17,8 +17,8 @@ database. SSL encryption is mandatory on all client and server connections.
 == Dependencies
 
 * bcrypt-ruby >= 2.1.4
-* eventmachine >= 1.0.0
-* nokogiri >= 1.4.4
+* eventmachine >= 0.12.10
+* nokogiri >= 1.5.0
 * ruby >= 1.9.2
 
 == Ubuntu setup

data/Rakefile

@@ -1,7 +1,8 @@
 require 'rake'
 require 'rake/clean'
-require 'rake/gempackagetask'
 require 'rake/testtask'
+require 'rubygems/package_task'
+require 'nokogiri'
 require_relative 'lib/vines/version'
 
 spec = Gem::Specification.new do |s| 
@@ -21,28 +22,28 @@ all client and server connections."
   s.email        = %w[david@negativecode.com chris@negativecode.com]
   s.homepage     = "http://www.getvines.com"
 
-  s.files        = FileList['[A-Z]*', '{bin,lib,conf}/**/*']
+  s.files        = FileList['[A-Z]*', '{bin,lib,conf,web}/**/*']
   s.test_files   = FileList["test/**/*"]
   s.executables  = %w[vines]
   s.require_path = "lib"
 
   s.add_dependency "activerecord", "~> 3.0"
   s.add_dependency "bcrypt-ruby", "~> 2.1"
-  s.add_dependency 'em-http-request', '>= 1.0.0.beta.3'
+  s.add_dependency "em-http-request", "~> 0.3"
   s.add_dependency "em-redis", "~> 0.3"
-  s.add_dependency "eventmachine", ">= 1.0.0.beta.3"
+  s.add_dependency "eventmachine", "~> 0.12"
   s.add_dependency "http_parser.rb", "~> 0.5"
   s.add_dependency "net-ldap", "~> 0.2"
-  s.add_dependency "nokogiri", "~> 1.4"
+  s.add_dependency "nokogiri", "~> 1.5"
 
-  s.add_development_dependency "minitest"
+  s.add_development_dependency "minitest", "= 2.2.2"
   s.add_development_dependency "rake"
   s.add_development_dependency "sqlite3"
 
   s.required_ruby_version = '>= 1.9.2'
 end
 
-Rake::GemPackageTask.new(spec) do |pkg| 
+Gem::PackageTask.new(spec) do |pkg|
   pkg.need_tar = true
 end
 
@@ -62,4 +63,58 @@ Rake::TestTask.new(:test) do |test|
   test.warning = false
 end
 
-task :default => [:clobber, :test, :gem]
+# Find lib and chat js includes and return them as two arrays.
+def scripts(doc)
+  lib, chat = [], []
+  doc.css('script').each do |node|
+    file = node['src'].split('/').last()
+    if node['src'].start_with?('/lib')
+      lib << file
+    elsif node['src'].start_with?('/chat')
+      chat << file
+    end
+  end
+  [lib, chat]
+end
+
+# Replace script tags with combined and minimized files.
+def rewrite_js(doc)
+  doc.css('script').each {|node| node.remove }
+  doc.css('head').each do |node|
+    %w[/lib/javascripts/base.js /chat/javascripts/app.js].each do |src|
+      script = doc.create_element('script',
+        'type' => 'text/javascript',
+        'src' => src)
+      node.add_child(script)
+      node.add_child(doc.create_text_node("\n"))
+    end
+  end
+end
+
+task :compile do
+  index = 'web/chat/index.html'
+  doc = Nokogiri::HTML(File.read(index))
+  lib, chat = scripts(doc)
+
+  rewrite_js(doc)
+  # save index.html before rewriting
+  FileUtils.cp(index, '/tmp/index.html')
+  File.open(index, 'w') {|f| f.write(doc.to_xml(:indent => 2)) }
+
+  lib = lib.map {|f| "web/lib/javascripts/#{f}"}.join(' ')
+  chat = chat.map {|f| "web/chat/javascripts/#{f}"}.join(' ')
+
+  sh %{coffee -c -b -o web/chat/javascripts web/chat/coffeescripts/*.coffee}
+  sh %{cat #{chat} | uglifyjs -nc > web/chat/javascripts/app.js}
+
+  sh %{coffee -c -b -o web/lib/javascripts web/lib/coffeescripts/*.coffee}
+  sh %{cat #{lib} | uglifyjs -nc > web/lib/javascripts/base.js}
+end
+
+task :cleanup do
+  # move index.html back into place after gem packaging
+  FileUtils.cp('/tmp/index.html', 'web/chat/index.html')
+  File.delete('/tmp/index.html')
+end
+
+task :default => [:clobber, :test, :compile, :gem, :cleanup]

data/bin/vines

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: UTF-8
 
-require 'fileutils'
 require 'optparse'
 require 'vines'
 

data/conf/config.rb

@@ -19,13 +19,13 @@ Vines::Config.configure do
   # Shared storage example:
   # host 'verona.lit', 'wonderland.lit' do
   #   storage 'fs' do
-  #     dir 'conf/users'
+  #     dir 'data/users'
   #   end
   # end
 
   host 'wonderland.lit' do
     storage 'fs' do
-      dir 'conf/users'
+      dir 'data/users'
     end
   end
 
@@ -36,7 +36,7 @@ Vines::Config.configure do
   #
   # host 'wonderland.lit' do
   #   storage 'fs' do
-  #     dir 'conf/users'
+  #     dir 'data/users'
   #   end
   #   ldap 'ldap.wonderland.lit', 636 do
   #     dn 'cn=Directory Manager'
@@ -51,7 +51,10 @@ Vines::Config.configure do
 
   # Configure the client-to-server port. The max_resources_per_account attribute
   # limits how many concurrent connections one user can have to the server.
+  # The private_storage attribute allows clients to store XML fragments
+  # on the server, using the XEP-0049 Private XML Storage feature.
   client '0.0.0.0', 5222 do
+    private_storage true
     max_stanza_size 65536
     max_resources_per_account 5
   end
@@ -65,11 +68,17 @@ Vines::Config.configure do
     hosts []
   end
 
-  # Configure the XEP-0124 BOSH port. This allows HTTP clients to connect to
-  # the XMPP server.
+  # Configure the built-in HTTP server that serves static files and responds to
+  # XEP-0124 BOSH requests. This allows HTTP clients to connect to
+  # the XMPP server. The root attribute defines the web server's document root.
+  # It will only serve files out of this directory. The bind attribute defines
+  # the URL to which BOSH clients must POST their XMPP stanza requests.
   http '0.0.0.0', 5280 do
-    max_stanza_size 131072
+    bind '/xmpp'
+    private_storage true
+    max_stanza_size 65536
     max_resources_per_account 5
+    root 'web'
   end
 
   # Configure the XEP-0114 external component port. Add entries for each
@@ -85,7 +94,7 @@ end
 # Available storage implementations:
 
 #storage 'fs' do
-#  dir 'conf/users'
+#  dir 'data/users'
 #end
 
 #storage 'couchdb' do

data/lib/vines.rb

@@ -2,22 +2,25 @@
 
 module Vines
   NAMESPACES = {
-    :stream      => 'http://etherx.jabber.org/streams'.freeze,
-    :client      => 'jabber:client'.freeze,
-    :server      => 'jabber:server'.freeze,
-    :component   => 'jabber:component:accept'.freeze,
-    :roster      => 'jabber:iq:roster'.freeze,
-    :non_sasl    => 'jabber:iq:auth'.freeze,
-    :sasl        => 'urn:ietf:params:xml:ns:xmpp-sasl'.freeze,
-    :tls         => 'urn:ietf:params:xml:ns:xmpp-tls'.freeze,
-    :bind        => 'urn:ietf:params:xml:ns:xmpp-bind'.freeze,
-    :session     => 'urn:ietf:params:xml:ns:xmpp-session'.freeze,
-    :ping        => 'urn:xmpp:ping'.freeze,
-    :disco_items => 'http://jabber.org/protocol/disco#items'.freeze,
-    :disco_info  => 'http://jabber.org/protocol/disco#info'.freeze,
-    :http_bind   => 'http://jabber.org/protocol/httpbind'.freeze,
-    :bosh        => 'urn:xmpp:xbosh'.freeze,
-    :vcard       => 'vcard-temp'.freeze
+    :stream       => 'http://etherx.jabber.org/streams'.freeze,
+    :client       => 'jabber:client'.freeze,
+    :server       => 'jabber:server'.freeze,
+    :component    => 'jabber:component:accept'.freeze,
+    :roster       => 'jabber:iq:roster'.freeze,
+    :non_sasl     => 'jabber:iq:auth'.freeze,
+    :storage      => 'jabber:iq:private'.freeze,
+    :sasl         => 'urn:ietf:params:xml:ns:xmpp-sasl'.freeze,
+    :tls          => 'urn:ietf:params:xml:ns:xmpp-tls'.freeze,
+    :bind         => 'urn:ietf:params:xml:ns:xmpp-bind'.freeze,
+    :session      => 'urn:ietf:params:xml:ns:xmpp-session'.freeze,
+    :ping         => 'urn:xmpp:ping'.freeze,
+    :disco_items  => 'http://jabber.org/protocol/disco#items'.freeze,
+    :disco_info   => 'http://jabber.org/protocol/disco#info'.freeze,
+    :http_bind    => 'http://jabber.org/protocol/httpbind'.freeze,
+    :bosh         => 'urn:xmpp:xbosh'.freeze,
+    :vcard        => 'vcard-temp'.freeze,
+    :si           => 'http://jabber.org/protocol/si'.freeze,
+    :byte_streams => 'http://jabber.org/protocol/bytestreams'.freeze
   }.freeze
 
   module Log
@@ -52,6 +55,7 @@ end
   em-redis
   eventmachine
   fiber
+  fileutils
   http/parser
   logger
   net/ldap
@@ -70,6 +74,7 @@ end
   vines/stanza/iq/disco_items
   vines/stanza/iq/error
   vines/stanza/iq/ping
+  vines/stanza/iq/private_storage
   vines/stanza/iq/result
   vines/stanza/iq/roster
   vines/stanza/iq/session

data/lib/vines/command/init.rb

@@ -10,9 +10,11 @@ module Vines
         raise "Directory already initialized: #{domain}" if File.exists?(dir)
         Dir.mkdir(dir)
 
-        FileUtils.cp_r(File.expand_path('../../../../conf', __FILE__), dir)
-        users, log, pid = %w[conf/users log pid].map do |sub|
-          File.join(dir, sub).tap {|subdir| Dir.mkdir(subdir) }
+        %w[conf web].each do |sub|
+          FileUtils.cp_r(File.expand_path("../../../../#{sub}", __FILE__), dir)
+        end
+        users, log, pid = %w[data/users log pid].map do |sub|
+          File.join(dir, sub).tap {|subdir| FileUtils.makedirs(subdir) }
         end
 
         create_users(domain, users)

data/lib/vines/config.rb

@@ -144,6 +144,14 @@ module Vines
           @settings[:max_resources_per_account]
         end
       end
+
+      def private_storage(enabled)
+        @settings[:private_storage] = !!enabled
+      end
+
+      def private_storage?
+        @settings[:private_storage]
+      end
     end
 
     class ServerPort < Port
@@ -166,6 +174,8 @@ module Vines
       def initialize(config, host='0.0.0.0', port=5280, &block)
         @stream = Vines::Stream::Http
         super(config, host, port, &block)
+        defaults = {:root => File.expand_path('web'), :bind => '/xmpp'}
+        @settings = defaults.merge(@settings)
       end
 
       def max_resources_per_account(max=nil)
@@ -175,6 +185,30 @@ module Vines
           @settings[:max_resources_per_account]
         end
       end
+
+      def private_storage(enabled)
+        @settings[:private_storage] = !!enabled
+      end
+
+      def private_storage?
+        @settings[:private_storage]
+      end
+
+      def root(dir=nil)
+        if dir
+          @settings[:root] = File.expand_path(dir)
+        else
+          @settings[:root]
+        end
+      end
+
+      def bind(url=nil)
+        if url
+          @settings[:bind] = url
+        else
+          @settings[:bind]
+        end
+      end
     end
 
     class ComponentPort < Port

data/lib/vines/contact.rb

@@ -80,6 +80,20 @@ module Vines
       }
     end
 
+    # Write an iq stanza to the recipient stream representing this contact's
+    # current roster item state.
+    def send_roster_push(recipient)
+      doc = Nokogiri::XML::Document.new
+      node = doc.create_element('iq',
+        'id'   => Kit.uuid,
+        'to'   => recipient.user.jid.to_s,
+        'type' => 'set')
+      node << doc.create_element('query', 'xmlns' => NAMESPACES[:roster]) do |query|
+        query << to_roster_xml
+      end
+      recipient.write(node)
+    end
+
     # Returns this contact as an xmpp <item> element.
     def to_roster_xml
       doc = Nokogiri::XML::Document.new

data/lib/vines/stanza.rb

@@ -55,6 +55,32 @@ module Vines
       raise 'subclass must implement'
     end
 
+    # Broadcast unavailable presence from the user's available resources to the
+    # recipient's available resources. Route the stanza to a remote server if
+    # the recipient isn't hosted locally.
+    def send_unavailable(from, to)
+      router.available_resources(from).each do |stream|
+        el = unavailable(stream.user.jid, to)
+        if router.local_jid?(to)
+          router.available_resources(to).each do |recipient|
+            recipient.write(el)
+          end
+        else
+          router.route(el)
+        end
+      end
+    end
+
+    # Return an unavailable presence stanza addressed to the given JID.
+    def unavailable(from, to)
+      doc = Document.new
+      doc.create_element('presence',
+        'from' => from.to_s,
+        'id'   => Kit.uuid,
+        'to'   => to.to_s,
+        'type' => 'unavailable')
+    end
+
     def method_missing(method, *args, &block)
       @node.send(method, *args, &block)
     end

data/lib/vines/stanza/iq.rb

@@ -15,7 +15,7 @@ module Vines
 
       def process
         if self['id'] && VALID_TYPES.include?(self['type'])
-          raise StanzaErrors::FeatureNotImplemented.new(@node, 'cancel')
+          route_iq or raise StanzaErrors::FeatureNotImplemented.new(@node, 'cancel')
         else
           raise StanzaErrors::BadRequest.new(@node, 'modify')
         end

data/lib/vines/stanza/iq/disco_info.rb

@@ -15,6 +15,9 @@ module Vines
               query.default_namespace = NS
               query << el.document.create_element('feature', 'var' => NAMESPACES[:ping])
               query << el.document.create_element('feature', 'var' => NAMESPACES[:vcard])
+              if stream.private_storage?
+                query << el.document.create_element('feature', 'var' => NAMESPACES[:storage])
+              end
             end
           end
           stream.write(result)

data/lib/vines/stanza/iq/private_storage.rb

@@ -0,0 +1,83 @@
+# encoding: UTF-8
+
+module Vines
+  class Stanza
+    class Iq
+      # Implements the Private Storage feature defined in XEP-0049. Clients are
+      # allowed to save arbitrary XML documents on the server, identified by
+      # element name and namespace.
+      class PrivateStorage < Query
+        NS = NAMESPACES[:storage]
+
+        register "/iq[@id and (@type='get' or @type='set')]/ns:query", 'ns' => NS
+
+        def process
+          unless stream.private_storage?
+            raise StanzaErrors::ServiceUnavailable.new(self, 'cancel')
+          end
+          validate_to_address
+          validate_children_size
+          validate_namespaces
+          get? ? retrieve_fragment : update_fragment
+        end
+
+        private
+
+        def retrieve_fragment
+          found = storage.find_fragment(stream.user.jid, elements.first.elements.first)
+          raise StanzaErrors::ItemNotFound.new(self, 'cancel') unless found
+
+          result = to_result do |node|
+            node << node.document.create_element('query') do |query|
+              query.default_namespace = NS
+              query << found
+            end
+          end
+          stream.write(result)
+        end
+
+        def update_fragment
+          elements.first.elements.each do |node|
+            storage.save_fragment(stream.user.jid, node)
+          end
+          stream.write(to_result)
+        end
+
+        private
+
+        def to_result
+          doc = Document.new
+          node = doc.create_element('iq',
+            'from' => stream.user.jid.to_s,
+            'id'   => self['id'],
+            'to'   => stream.user.jid.to_s,
+            'type' => 'result')
+          yield node if block_given?
+          node
+        end
+
+        def validate_children_size
+          size = elements.first.elements.size
+          if (get? && size != 1) || (set? && size == 0)
+            raise StanzaErrors::NotAcceptable.new(self, 'modify')
+          end
+        end
+
+        def validate_to_address
+          to = (self['to'] || '').strip
+          unless to.empty? || to == stream.user.jid.bare.to_s
+            raise StanzaErrors::Forbidden.new(self, 'cancel')
+          end
+        end
+
+        def validate_namespaces
+          elements.first.elements.each do |node|
+            if node.namespace.nil? || NAMESPACES.values.include?(node.namespace.href)
+              raise StanzaErrors::NotAcceptable.new(self, 'modify')
+            end
+          end
+        end
+      end
+    end
+  end
+end