Module: Sambala::Gardener

Included in:
Sambala
Defined in:
lib/sambala_gardener.rb

Overview

The Sambala::Gardener module bings Abundance into Sambala. A bunch of mixins used inside Sambala to access Abundance Non-Blocking Threading. These methods are a higher level abstraction of Abundance methods, serving as reusable general purpose agents inside Sambala, mainly for those repetitive execution commands.

Author

lp ([email protected])

Copyright

2008 Louis-Philippe Perron - Released under the terms of the MIT license

:title:Sambala::Gardener

Instance Method Summary collapse

Instance Method Details

#clean_path(path) ⇒ Object

The clean_path method cleans the slashes, as backslashes, for the Windows servers.

Parameters

  • path = the path to be cleaned

Example

cleaned = clean_path(‘/My/Path/’) # => ‘MyPath’



21
22
23
24
25
26
27
 
# File 'lib/sambala_gardener.rb', line 21

def clean_path(path)
	if @posix_support
		return path
	else
		return path.gsub(/\//,'\\')
	end
end

#exec_interactive(command, data) ⇒ Object

The exec_interactive method follows execute when queue=false.

Parameters

  • command = the command as a string

  • data = the command argument as a string

Example

result = exec_interactive('put','aFile.txt')    # =>  [false, "aFile.txt does not exist\r\n"]



60
61
62
63
64
65
 
# File 'lib/sambala_gardener.rb', line 60

def exec_interactive(command,data)
  id = @gardener.seed("#{command} #{data}")
  result = @gardener.harvest(:one,id)
			$log_sambala.debug("exec_interactive result") {"#{result.inspect}"}
  return result[:success], result[:message]
end

#exec_queue(command, data) ⇒ Object

The exec_queue method follows execute when queue=true

Parameters

  • command = the command as a string

  • data = the command argument as a string

Example

result = exec_queue('get','aFile.txt')  # => [true,1]



73
74
75
76
77
 
# File 'lib/sambala_gardener.rb', line 73

def exec_queue(command,data)
  result = @gardener.seed("#{command} #{data}")
			$log_sambala.debug("exec_queue result") {"#{result.inspect}"}
			result.integer? ? [true,result] : [false,result]
end

#execute(command, data, queue) ⇒ Object

The execute method splits the execution according to the operation mode: queue or interactive.

Parameters

  • command = the command as a string

  • data = the command argument as a string

  • queue = the command operation mode

Example

result = execute('cd','dir/otherDir*',false)  # =>  true



36
37
38
 
# File 'lib/sambala_gardener.rb', line 36

def execute(command,data,queue)
  (queue.is_a? TrueClass) ? exec_queue(command,data) : exec_interactive(command,data)
end

#execute_all(command, data) ⇒ Object

The execute_all method does a special command invocation where all smbclient workers running in parallel are all sent the same command. The method returns one boolean value for all workers success.

Parameters

  • command = the command as a string

  • data = the command argument as a string

Example

result = execute_all('mask','match*')   # =>  true



47
48
49
50
51
52
 
# File 'lib/sambala_gardener.rb', line 47

def execute_all(command,data)
  result = @gardener.seed_all("#{command} #{data}")
			$log_sambala.debug("execute_all result") {"#{result.inspect}"}
  bools = result.map { |row| row[:success] }
  bools.uniq.size == 1 ? true : false
end

#gardener_ok ⇒ Object

The gardener_ok method does the init_gardener invocation, degrading the options parameters until it initializes, or raise SmbInitError exception after 4 try.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/sambala_gardener.rb', line 86

def gardener_ok
  init = []
  catch :gardener do
    4.times do |num|
      init_gardener; sleep 1
	begin
		Timeout.timeout(2) { @init_status = @gardener.init_status }
		init = Array.new(@init_status)
      	init.map! { |result| result[:success] }
      	throw :gardener if init.uniq.size == 1 and init[0] == true
	rescue Timeout::Error
		$log_sambala.error("Having problem setting the smb client... TRY #{num}")
	end
	kill_gardener_and_incr
    end
$log_sambala.fatal("All Attemps Failed, Gardener could not be initiated")
    raise SmbInitError.exception("Couldn't set smbclient properly (#{$!.to_s})")
  end
			@posix_support = posix?(@init_status[0][:message])
end

#init_gardener ⇒ Object

The init_gardener method initialize a gardener class object



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/sambala_gardener.rb', line 108

def init_gardener
  @gardener = Abundance.gardener(:rows => @options[:threads], :init_timeout => @options[:init_timeout]) do

PTY.spawn("smbclient //#{@options[:host]}/#{@options[:share]} #{@options[:password]} -W #{@options[:domain]} -U #{@options[:user]}") do |r,w,pid|
      w.sync = true
      $expect_verbose = false
      catch :init do
        loop do
          r.expect(/.*\xD\xAsmb:[ \x5C]*\x3E.*/) do |text|
            if text != nil
              text[0] =~ /.*Server=.*/i ? Abundance.init_status(true,"#{text.inspect}") : Abundance.init_status(false,"#{text.inspect}")
              throw :init
            end
          end
        end
      end
      Abundance.grow do |seed|
        w.print "#{seed.sprout}\r"; $log_sambala.debug("smbclient") {"sprout: -- #{seed.sprout} --"}
        catch :result do
			iter = 1
          loop do
            r.expect(/.*\xD\xAsmb: [\x5C]*\w*[\x5C]+\x3E.*/) do |text|
					$log_sambala.debug("smbclient") {"expect: -- #{text} --"}
              if text != nil
                msg = text[0]
						
                msg.gsub!(/smb: \w*\x5C\x3E\s*$/, '')
                msg.gsub!(/^\s*#{seed.sprout}/, '')
                msg.lstrip!; $log_sambala.debug("smbclient") {"msg: -- #{msg} --"}

                success = case seed.sprout
                  when /^put/
                    msg['putting'].nil? ? false : true
                  else
                    if msg['NT_STATUS']
									false
								elsif msg['timed out'] || msg['Server stopped']
									false
								else
									true
								end
                  end

                seed.crop(success, msg)
                throw :result
					elsif iter > 20
						$log_sambala.warn("Failed to #{seed.sprout}")
						seed.crop(false, "Failed to #{seed.sprout}")
						throw :result
					else
						iter += 1
              end
            end
          end
        end
      end
    end

  end
end

#parse_results(results) ⇒ Object

The parse_results method map the gardener’s return hash values to an array



80
81
82
 
# File 'lib/sambala_gardener.rb', line 80

def parse_results(results)
	results.map { |result| [result[:id], result[:success], result[:seed], result[:message]] }
end