openfire_admin 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'nokogiri'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# OpenfireAdmin
+
+Controll Openfire Admin by ruby. (by web scraping,
+ no need openfire plugins)
+
+Openfire is real time collaboration server.
+http://www.igniterealtime.org/projects/openfire/
+
+This library is designed for Opscode chef.
+
+spin out from the openfire-chef recipe.
+https://github.com/team-lab/openfire-chef
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'openfire_admin'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openfire_admin
+
+## TODO
+
+1. write test.
+2. refactoring code
+3. write comment, and document.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/openfire_admin/http_client.rb

@@ -0,0 +1,46 @@
+module OpenfireAdmin
+  # http client ( cookie support )
+  class HttpClient
+    def initialize(url)
+      @cookies = {}
+      @url = url
+      requrie 'net/https' if @url.scheme == 'https'
+    end
+
+    def request(req)
+      Net::HTTP.start(@url.host, @url.port) do |http|
+        http.use_ssl = true if @url.scheme == 'https'
+        puts "#{req.method} #{req.path}" if @verbos
+        req['Host'] = @url.host
+        req['Cookie'] = @cookies.map{|k,v| "#{k}=#{v}"}.join(";") unless @cookies.empty?
+        res = http.request(req)
+        cookies = res.get_fields('Set-Cookie')
+        cookies.each{|str|
+          k,v = str[0...str.index(';')].split('=')
+          @cookies[k] = v
+        } if cookies
+        if @verbos
+          puts "#{res.code} #{res.message}"
+          res.each{|k,v| puts "#{k}=#{v}" }
+        end
+        def res.request
+          @request
+        end
+        res.instance_variable_set(:@request, req)
+        yield res
+      end
+    end
+
+    # post with form data
+    def post(path, form_data)
+      req = Net::HTTP::Post.new(path)
+      req.set_form_data(form_data)
+      request(req){|res|  yield res }
+    end
+
+    # get path
+    def get(path)
+      request(Net::HTTP::Get.new(path)){|res| yield res }
+    end
+  end
+end

data/lib/openfire_admin/response_exception.rb

@@ -0,0 +1,27 @@
+# openfire admin operator
+module OpenfireAdmin
+  # unexpected response found exception
+  class ResponceException < Exception
+    attr_reader :response
+    def initialize(message,res)
+      case res
+      when Net::HTTPSuccess
+        doc = Nokogiri::HTML(res.body)
+        msgs = ( doc.search('.jive-error-text, .error') || [] ).map{|c| c.text.strip}
+        if msgs.empty?
+          super(message)
+        else
+          super("#{message} [#{msgs.join(' / ')}]")
+        end
+      when Net::HTTPRedirection
+        super("#{message} redirct to=>#{res['location']}")
+      when Net::HTTPNotFound
+        super("#{message} Not found #{res.request.path}")
+      else
+        super("#{message} res.code=#{res.code}")
+      end
+
+      @response = res
+    end
+  end
+end

data/lib/openfire_admin/setup_wizard.rb

@@ -0,0 +1,82 @@
+
+module OpenfireAdmin
+  class SetupWizard
+    def initialize(http)
+      @http = http
+    end
+
+    def if_not_redirect message, res
+      raise ResponceException.new(message,res) unless res.code =="302"
+      raise ResponceException.new("setup already run",res) if res["location"] =~ /setup-complete.jsp$/
+    end
+
+    def language(locale)
+      @http.get("/setup/index.jsp?localeCode=#{locale}&save=Continue"){|res|
+        if_not_redirect "cant set locale #{locale}", res
+      } 
+      self
+    end
+    def server(domain, embeddedPort=9090, securePort=9091)
+      @http.post("/setup/setup-host-settings.jsp",{
+        "continue"=>"Continue",
+        "domain"=>domain,
+        "embeddedPort" => embeddedPort,
+        "securePort" => securePort }) do |res|
+          if_not_redirect "cant set server", res
+      end
+      self
+    end
+    def database(mode="embedded")
+      @http.get("/setup/setup-datasource-settings.jsp?next=true&mode=#{mode}&continue=Continue") do |res|
+        if_not_redirect "cant set database #{mode}", res
+      end
+      self
+    end
+    def database_standard(driver,serverURL,username,password,
+                               maxConnections=25,minConnections=5,
+                               connectionTimeout=1.0)
+      database("standard")
+      @http.post("/setup/setup-datasource-standard.jsp",{
+        "connectionTimeout" => connectionTimeout.to_s,
+        "continue"=>"Continue",
+        "driver"=>driver,
+        "maxConnections"=>maxConnections,
+        "minConnections"=>minConnections,
+        "password"=>password,
+        "serverURL"=>serverURL,
+        "username"=>username}) do |res|
+          if_not_redirect "cant set standard database #{serverURL}", res
+      end
+      self
+    end
+
+    def profile(mode="default")
+      @http.post("/setup/setup-profile-settings.jsp",{
+        "mode" => mode,
+        "continue" => "Continue"
+      }) do |res|
+        if_not_redirect "cant set profile #{mode} #{res.request.body}", res
+      end
+      self
+    end
+    def admin(email,password)
+      # on get, server store session to admin user
+      @http.get("/setup/setup-admin-settings.jsp") do |res|
+        raise ResponceException.new("can't get admin settings", res) unless res.code == "200"
+      end
+      @http.post("/setup/setup-admin-settings.jsp",{"continue"=>"Continue",
+                 "email"=>email,
+                 "newPassword"=>password,
+                 "newPasswordConfirm"=>password,
+                 "password"=>password}) do |res|
+        if_not_redirect "cant set admin #{email}", res
+      end
+      self
+    end
+    def finish()
+      @http.get("/setup/setup-finished.jsp") do |res|
+        res.code == "200"
+      end
+    end
+  end
+end

data/lib/openfire_admin/version.rb

@@ -0,0 +1,3 @@
+module OpenfireAdmin
+  VERSION = "0.0.1"
+end

data/lib/openfire_admin.rb

@@ -0,0 +1,315 @@
+# coding: utf-8
+require 'net/http'
+require "nokogiri"
+require 'open-uri'
+require 'openfire_admin/http_client'
+require 'openfire_admin/response_exception'
+
+# openfire admin operator
+class OpenfireAdmin
+  NBSP = "\302\240" # Nokogiri::HTML(" ").text
+  attr_reader :client
+
+  # pure admin console client
+  class AdminClient
+    attr_reader :http
+    def initialize(loginurl)
+      @http = HttpClient.new(URI.parse(loginurl))
+    end
+    def login(username, pass)
+      @http.post( "/login.jsp" , {
+          "login"=> "true",
+          "password"=>pass,
+          "url"=>"/index.jsp",
+          "username"=>username}) do |res|
+        raise ResponceException.new("can't login",res) unless res.code == "302"
+      end
+    end
+    def remove_property(name)
+      @http.post('/server-properties.jsp', 'propName' => name, 'del'=>'true') do |res|
+        raise ResponceException.new("cant save",res) if res.code != "302" or res['location'] !~ /deletesuccess=true$/
+      end
+    end
+    def set_property(name, value)
+      @http.post('/server-properties.jsp', 'propName' => name, 'propValue'=>value.to_s, 'save'=>'Save Property') do |res|
+        raise ResponceException.new("cant save",res) if res.code != "302"
+      end
+    end
+    def get_property(name)
+      @http.post("/server-properties.jsp", "edit"=>"true", "propName"=>name) do |res|
+        ta = Nokogiri::HTML(res.body).at('textarea[name=propValue]')
+        raise ResponceException.new("not found textarea",res) unless ta
+        ta.content.to_s
+      end
+    end
+    def get_properties
+      ret = {}
+      @http.get("/server-properties.jsp") do |res|
+        raise ResponceException.new("can't read",res) unless res.code== "200"
+        doc = Nokogiri::HTML(res.body)
+        doc.search('//h1/parent::node()//table/tbody/tr[@class=""]').each do |tr|
+          v = tr.at('td[2] span')[:title]
+          v = "" if v == NBSP
+          ret[tr.at('td span')[:title]]= v
+        end
+      end
+      ret
+    end
+    def get_installed_plugins
+      @http.get("/plugin-admin.jsp") do |res|
+        doc =Nokogiri::HTML(res.body)
+        doc.at('h1').parent.at('table').search('tbody tr[valign=top]').map do |tr|
+          img = tr.at('a[href*="reloadplugin="]')
+          if img
+            {
+              :key => img[:href].match(/\?reloadplugin=([^"'&>]*)/)[1],
+              :name => tr.search('td')[1].content.gsub(NBSP,' ').strip,
+              :description => tr.search('td')[3].content.strip,
+              :version => tr.search('td')[4].content.strip
+            }
+          end
+        end
+      end
+    end
+    def create_user(username,password,name,email,isadmin=false)
+      params = {
+        "create"=>"Create User",
+        "email"=> email,
+        "name"=> name,
+        "password"=> password,
+        "passwordConfirm"=>password,
+        "username"=>username }
+      params['isadmin'] = "on" if isadmin
+      @http.post("/user-create.jsp", params ) do |res|
+        raise ResponceException.new("can't create user #{username}",res ) unless res.code == "302" and res["location"] =~ /success=true/
+      end
+    end
+    def delete_user(username)
+      @http.get("/user-delete.jsp?username=#{username}&delete=Delete+User") do |res|
+        raise ResponceException.new("can't delete user #{username}",res ) unless res.code == "302" and res["location"] =~ /deletesuccess=true/
+      end
+    end
+    def user_exists?(username)
+      @http.get("/user-password.jsp?username=#{username}") do |res|
+        res.code == "200"
+      end
+    end
+    def install_plugin(url)
+      @http.post("/dwr/exec/downloader.installPlugin.dwr",
+        "callCount"=>"1",
+        "c0-scriptName"=>"downloader",
+        "c0-methodName"=>"installPlugin",
+        "c0-id"=>"0",
+        "c0-param0"=>"string:#{url}",
+        "c0-param1"=>"string:14867746",
+        "xml"=>"true" ) do |res|
+        raise ResponceException.new("plugin install fail",res) unless res.code == "200" and res.body =~ /s0\.successfull=/
+      end
+    end
+    def reload_plugin(key)
+      @http.get("/plugin-admin.jsp?reloadplugin=#{key}") do |res|
+        raise ResponceException.new("cant reload",res) if res.code != "302" or res['location'] !~ /reloadsuccess=true/
+      end
+    end
+    def uninstall_plugin(key)
+      @http.get("/plugin-admin.jsp?deleteplugin=#{key}") do |res|
+        raise ResponceException.new("cant delete",res) if res.code != "302" or res['location'] !~ /deletesuccess=true/
+      end
+    end
+    def system_cache
+      @http.get("/system-cache.jsp") do |res|
+        Nokogiri::HTML(res.body).search('input[type=checkbox][name=cacheID]').map{|i|
+          {
+            :cacheID => i[:value],
+            :name => i.ancestors("tr").first.search("td td")[1].content.strip
+          }
+        }
+      end
+    end
+    def system_cache_clear(cacheID)
+      @http.post("/system-cache.jsp","cacheID"=>cacheID, "clear"=>"Clear") do |res|
+        ! Nokogiri::HTML(res.body).at("div[class='jive-success']").nil?
+      end
+    end
+    def setup_mode?
+      @http.get("/login.jsp") do |res|
+        res.code == "302" and res["location"] =~ %r"/setup/"
+      end
+    end
+  end
+  def setup_mode?
+    @client.setup_mode?
+  end
+  def setup_wizard
+    require File.join(File.dirname(__FILE__),"openfire_admin/setup_wizard")
+    SetupWizard.new(@client.http)
+  end
+
+  def initialize(loginurl="http://localhost:9090")
+    @client = AdminClient.new(loginurl)
+  end
+  def logined?
+    @logined
+  end
+
+  def login(username, password)
+    @client.login(username, password)
+    @logined = true
+  end
+
+  # System property map
+  class PropertyMap
+    def initialize(client)
+      @client = client
+      reload
+    end
+
+    def inspect
+      @cache.inspect
+    end
+
+    # get system property
+    def []( name )
+      v = @cache[name]
+      v = @client.get_property(name) if v.nil? and @cache.has_key?(name)
+      v
+    end
+
+    # reload cache
+    def reload
+      @cache = @client.get_properties
+      self
+    end
+
+    # remove property
+    def remove(name)
+      @client.remove_property(name)
+    end
+
+    # set/add property
+    def []=(name,value)
+      if value.nil?
+        remove(name)
+      else
+        @client.set_property(name, value)
+        @cache[name]=value
+      end
+    end
+  end
+
+  # get properties
+  def system_properties
+    PropertyMap.new(@client)
+  end
+
+  # cache control. this instance can clear cache.
+  class SystemCache
+    attr_reader :cacheID, :name
+    def initialize(client, cacheID, name)
+      @client = client
+      @cacheID = cacheID
+      @name = name
+    end
+    def to_s
+      "#<#{self.class} (#{@cacheID})#{name.inspect}>"
+    end
+    # clear cache
+    def clear
+      @client.system_cache_clear( @cacheID )
+    end
+  end
+
+  # return SystemCache array
+  def system_cache
+    @client.system_cache.map{|c| SystemCache.new( @client, c[:cacheID], c[:name] )}
+  end
+
+  # plugin abstract class
+  class Plugin
+    attr_accessor :name, :description, :version
+    attr_reader :key
+    def initialize(client, key)
+      @client = client
+      @key = key.downcase
+    end
+    def inspect
+      to_s
+    end
+    def to_s
+      "#<#{self.class} #{key} #{version} (#{name.inspect} #{description.inspect})>"
+    end
+    def eql?(obj)
+      case obj
+      when Plugin
+        self.key == obj.key
+      when String
+        self.key == obj.downcase
+      else
+        false
+      end
+    end
+  end
+
+  # installed plugin. this instance can uninstall and reload
+  class InstalledPlugin < Plugin
+    # reload plugin
+    def reload
+      @client.reload_plugin(key)
+    end
+
+    # uninstall plugin
+    def uninstall
+      @client.uninstall_plugin(key)
+    end
+  end
+
+  # available plugin. this can install
+  class AvailablePlugin < Plugin
+    attr_accessor :url
+
+    # install plugin
+    def install
+      @client.install_plugin(url)
+    end
+  end
+
+  # plugin list array. this can find plugin by key.
+  class PluginList < Array
+    def [](name)
+      if name.is_a?(String)
+        self.find{|p| p.eql? name }
+      else
+        super
+      end
+    end
+  end
+
+  # plugins list array of available plugins.
+  # if you need not installed plugins, ( self.available_plugins - self.install_plugin )
+  def available_plugins
+    ret = PluginList.new
+    doc = Nokogiri::XML(open("http://www.igniterealtime.org/projects/openfire/versions.jsp").read)
+    doc.search('plugin').each do |tr|
+      p = AvailablePlugin.new(@client, tr[:url].match(/\/([^\.\/]+)\.[^\/.]+$/)[1])
+      p.name = tr[:name]
+      p.description = tr[:description]
+      p.version = tr[:latest]
+      p.url = tr[:url]
+      ret << p
+    end
+    ret
+  end
+
+  # plugins list array of installed plugins
+  def installed_plugins
+    ret = PluginList.new
+    @client.get_installed_plugins.each{|p|
+      r = InstalledPlugin.new(@client, p[:key])
+      r.name = p[:name]
+      r.description = p[:description]
+      r.version = p[:version]
+      ret << r
+    }
+    ret
+  end
+end

data/openfire_admin.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/openfire_admin/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["nazoking"]
+  gem.email         = ["nazoking@gmai.com"]
+  gem.description   = %q{Manipurate Openfire admin console}
+  gem.summary       = %q{}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "openfire_admin"
+  gem.require_paths = ["lib"]
+  gem.version       = OpenfireAdmin::VERSION
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: openfire_admin
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- nazoking
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-10-05 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: Manipurate Openfire admin console
+email: 
+- nazoking@gmai.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/openfire_admin.rb
+- lib/openfire_admin/http_client.rb
+- lib/openfire_admin/response_exception.rb
+- lib/openfire_admin/setup_wizard.rb
+- lib/openfire_admin/version.rb
+- openfire_admin.gemspec
+has_rdoc: false
+homepage: ""
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: ""
+test_files: []
+