stealth_browser_automation 1.1.8 → 1.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a69446713baa56fc8ce31194cad216bd8cfb781b
-  data.tar.gz: 0b8821a33b1a8a2dd9323e4d055b7964285cd9a6
+  metadata.gz: 8e5b7d022b4081943660188d38da808fde5a8fb4
+  data.tar.gz: 7d78271edc4513a15d1a8b5ffc97b73ce3954396
 SHA512:
-  metadata.gz: 022264107d17a0cf48a8467e3cdab944f1edf9072a61d4575491ddf8bd57e4c6c853c3b55d16fd792166bbbf6dd0d922963992d32468f4c8fd8f16d61dbab977
-  data.tar.gz: 812b9580f4c2ef495751b0ee4d1c8f071a5f28066b7298d766da817ddf88c3983dbdcae283731ab753a33752438e0b2e5996b06cbd6fe9e17c9e9ea4d567a1ca
+  metadata.gz: b2a3ac895d730e2411fe797056c01b8faba33b84b1a9bf3c7a8c96cf3c669d5ff3abfc2751cc304a5e6bea1d5bddfcc959ab3c3fa625ee74ea3500eed8b9fdbc
+  data.tar.gz: 543b5abc9fa2a7ca7f891964439bd4eceaf8cd71b357cdfd60fa765e75c3d559aa0147e9b878872f0f8b69dbd9772cd1ba6f0d23916864edd4a81b49d1cd2bd3

data/lib/browserfactory.rb

@@ -27,6 +27,7 @@ require "pathname"
 # and user interaction.
 # 
 
+# Custom Selenium elements to stream the browser windows when some events happen. 
 module Selenium
   module WebDriver
     class Element
@@ -41,12 +42,37 @@ module Selenium
   end # module WebDriver
 end # module Selenium
 
+
 module BlackStack
 
+  # clase de base para todos los bots ejecuten acciones con una cuenta de LinkedIn, Facebook, Twitter, etc.
+  class MyBotProcess < BlackStack::MyRemoteProcess
+    def run()
+      begin
+        super
+      rescue Interrupt => e
+        self.logger.reset
+        self.logger.log 'Interrupt signal on MyBotProcess!'
+        
+        self.logger.logs 'Close all browsers... '
+        begin
+          BlackStack::BrowserFactory.destroy
+          self.logger.done
+        rescue => e
+          self.logger.logf("error:#{e.to_s}")
+        end
+        
+        # raise the exception
+        raise e
+      end # begin ... rescue
+    end # def run
+  end # class MyBotProcess
+
+  # Custom Selenium browser to track all browser activity, and stream the browser window.
   class PampaBrowser < Watir::Browser
 
     # TODO: enable this when you move to the "frequency-based-streaming" model
-    #PAMPA_BROWSER_CHANNEL_LOCK_FILENAME = './browserfactory.channel.%PRFILE_NAME%.lock' # manejo de concurrencia en la creación de browsers
+    #PAMPA_BROWSER_CHANNEL_LOCK_FILENAME = './browserfactory.channel.%PROFILE_NAME%.lock' # manejo de concurrencia en la creación de browsers
     #attr_accessor  :lockfile
     
     attr_accessor :proxy, :lnuser, :agent_name, :profile_name
@@ -61,7 +87,7 @@ module BlackStack
 
     def initialize(driver)
       # TODO: enable this when you move to the "frequency-based-streaming" model
-      #fname = PAMPA_BROWSER_CHANNEL_LOCK_FILENAME.gsub('%PRFILE_NAME%', self.profile_name.to_s)
+      #fname = PAMPA_BROWSER_CHANNEL_LOCK_FILENAME.gsub('%PROFILE_NAME%', self.profile_name.to_s)
       #self.lockfile = File.open(fname,"w")
       
       #
@@ -246,22 +272,109 @@ module BlackStack
   
   
   class BrowserFactory
-    LOCKING_FILENAME = BlackStack::MyProcess.macaddress # manejo de concurrencia en la creación de browsers
-    PROFILE_PID_LIST_FILENAME = "./browserfactory.%PRFILE_NAME%.list" # manejo de concurrencia en la creación de browsers
-    PROFILE_PID_LOCK_FILENAME = "./browserfactory.%PRFILE_NAME%.lock" # manejo de concurrencia en la creación de browsers
-    CHROME_EXTENSION_DIRECTORY = File.absolute_path('./chrome_extension')
+    # This file is to launch one browser at time in the same host.
+    # There is one, and only one, lock file for reach host where
+    # Blackstack is running.
+    # More information here: https://bitbucket.org/leandro_sardi/blackstack/issues/1155/browserfactory-use-one-single-lock-file
+    HOST_LOCK_FILENAME = "./sba.host.#{BlackStack::MyProcess.macaddress}.lock" # manejo de concurrencia en la creación de browsers
+    
+    # This file keeps the PIDs of all the child processes of this process. 
+    # It is neccessary to kill all the child processes of this process when 
+    # you have started a chrome browser, and you want to be sure that you 
+    # have closed it. 
+    # More infromation here: https://bitbucket.org/leandro_sardi/blackstack/issues/943/browserfactory-deja-exploradores-abiertos
+    PROFILE_PID_LIST_FILENAME = "./sba.profile.%PROFILE_NAME%.list" # manejo de concurrencia en la creación de browsers
+    
+    # This file store the PID of the last processes that started a browser
+    # with this profile name. There is one, and only one, pid_lockfile for
+    # each browser profile; and such pid_lockfile is shared by all the hosts
+    # where BlackStack is running.
+    PROFILE_LOCK_FILENAME = "./sba.profile.%PROFILE_NAME%.lock" # manejo de concurrencia en la creación de browsers
+    
+    # Page load timeout by default.
+    # Works for chrome browsers only.
     DEFAULT_LOAD_TIMEOUT = 360
+
+    # Location of the chromedriver.exe file by default.
+    # Works for chrome browsers only.
     DEFAULT_CHROMEDRIVER_PATH = './chromedriver.exe'
+        
+    # Different supported browsers. 
+    TYPE_CHROME = 1
+    TYPE_MIMIC = 2
+    
+    # File handler for HOST_LOCK_FILENAME
+    @@fd_host_lock = File.open(HOST_LOCK_FILENAME,"w")
+
+    # File handler for PROFILE_PID_LIST_FILENAME
+    @@fd_profile_pid_list = nil
+
+    # File handler for PROFILE_LOCK_FILENAME
+    @@fd_profile_lock = nil
 
+    # Selenium driver 
+    @@driver = nil
+    
+    # Selenium browser
+    @@browser = nil
+    
+    # PID of this browser.
+    # Works for Chrme only.
+    @@pid = nil
+    
+    # Profile name of this browser.
+    # For Chrome, it will store the name of the profile folder.
+    # For Mimic, it will store the profileId in the MultiLogin APP.
+    @@profile_name = nil
+    
+    # Type of this browser.
+    # Only TYPE_CHROME or TYPE_MIMIC are supported at this moment.
+    @@type = nil
+  
+    # Returns the PampaBrowser object
+    def self.browser
+      @@browser
+    end
+
+    # Returns the list of supported browsers
+    def self.types
+      [BlackStack::BrowserFactory.TYPE_CHROME, BlackStack::BrowserFactory.TYPE_MIMIC]
+    end
+
+    # Returns the description string from a browser type code 
+    def self.typeDesc(type)
+      return 'Chrome' if @@type == BlackStack::BrowserFactory.TYPE_CHROME
+      return 'Mimic' if @@type == BlackStack::BrowserFactory.TYPE_MIMIC
+      raise 'Unknown browser type'
+    end
+
+    # Lock PROFILE_PID_LIST_FILENAME file.
+    # For more information, read documentations about PROFILE_PID_LIST_FILENAME.
+    def self.lockProfileList()
+      #@@fd_profile.flock(File::LOCK_EX)
+    end
+  
+    # Unlock PROFILE_PID_LIST_FILENAME file.
+    # For more information, read documentations about PROFILE_PID_LIST_FILENAME.
+    def self.releaseProfileList()
+      #@@fd_profile.flock(File::LOCK_UN)
+    end
+
+    # Add a PID to the PROFILE_PID_LIST_FILENAME file.
+    # For more information, read documentations about PROFILE_PID_LIST_FILENAME.
+    # This method is used for chrome browsers only.
     def self.addPidToProfileList(profile_name, pid)
-      fname = PROFILE_PID_LIST_FILENAME.gsub('%PRFILE_NAME%', profile_name)
+      fname = PROFILE_PID_LIST_FILENAME.gsub('%PROFILE_NAME%', profile_name)
       f = File.open(fname, 'a')
       f.write("#{pid},")
       f.close
     end
   
+    # Remove a PID from the PROFILE_PID_LIST_FILENAME file.
+    # For more information, read documentations about PROFILE_PID_LIST_FILENAME.
+    # This method is used for chrome browsers only.
     def self.removePidToProfileList(profile_name, pid)
-      fname = PROFILE_PID_LIST_FILENAME.gsub('%PRFILE_NAME%', profile_name)
+      fname = PROFILE_PID_LIST_FILENAME.gsub('%PROFILE_NAME%', profile_name)
       s = File.read(fname)
       s = s.gsub("#{pid},", "")
       f = File.open(fname, 'w')
@@ -269,9 +382,12 @@ module BlackStack
       f.close
     end
   
+    # Returns an array of strings with the PIDs registered for this browser.
+    # For more information, read documentations about PROFILE_PID_LIST_FILENAME.
+    # This method is used for chrome browsers only.
     def self.readPidToProfileList(profile_name)
-      if (profile_name != nil)
-        fname = PROFILE_PID_LIST_FILENAME.gsub('%PRFILE_NAME%', profile_name)
+      if profile_name != nil
+        fname = PROFILE_PID_LIST_FILENAME.gsub('%PROFILE_NAME%', profile_name)
         s = File.read(fname)
         return s.split(",")
       else
@@ -279,43 +395,102 @@ module BlackStack
       end
     end
   
-    def self.updateProfileList()
+    # Add the PID of this browser; and the PID of all the child processes of this, with name like /chrome\.exe/.
+    # For more information, read documentations about PROFILE_PID_LIST_FILENAME.
+    # This method is used for chrome browsers only.
+    def self.updateProfileList
       addPidToProfileList(@@profile_name, @@pid)
-      PROCESS.list().select { |p| p[:ppid] == @@pid && (p[:executablepath] =~ /chrome\.exe/ || p[:executablepath] =~ /mimic/) }.each { |p2|
+      PROCESS.list().select { |p| p[:ppid] == @@pid && p[:executablepath] =~ /chrome\.exe/ }.each { |p2|
         addPidToProfileList(@@profile_name, p2[:pid])                  
       }
     end
-    
-    TYPE_PHANTOMJS = 0 # discontinued!
-    TYPE_FIREFOX = 1
-    TYPE_CHROME = 2
-    TYPE_MIMIC = 3
-    
-    @@fd = File.open(LOCKING_FILENAME,"w")
-    @@fd_profile = nil
-    @@driver = nil
-    @@browser = nil
-    @@pid = nil
-    @@profile_name = nil
-    @@type = nil
-  
-    def self.browser()
-      @@browser
+
+    # Returns true if @@browser is not nil, or @@profile_name is not nil.
+    # Otherwise, returns false
+    # If the browser type is Chrome, this method will return true if the PROFILE_PID_LIST_FILENAME has one or more PIDs registered.
+    # For more information, read documentations about PROFILE_PID_LIST_FILENAME.
+    def self.isCreated
+      if @@type == BlackStack::BrowserFactory.TYPE_CHROME
+        if (self.readPidToProfileList(@@profile_name).size>0)
+          return true
+        end
+      end
+      !@@browser.nil? || !@@profile_name.nil?
     end
   
-    def self.lockProfileList()
-  #    @@fd_profile.flock(File::LOCK_EX)
+    # Call isCreated() method.
+    # For more information, read the documentation of isCreated() method.
+    def self.isCreated?
+      self.isCreated()
+    end
+
+    # Retorna true si el perfil en @@profile_name esta siendo trabajado por este proceso
+    def self.itIsMe?
+      # el archivo tiene una unica primera linea de ancho fijo
+      line_chars = 100
+      # obtengo el id de este proceso que esta corriendo
+      my_pid = PROCESS.pid
+      # bloqueo el archivo de este perfil
+      @@fd_profile_lock.flock(File::LOCK_EX)
+      # valido que my_pid no tenga mas caracteres que al ancho fijo
+      raise 'Cannot work browser profile lockfile because the lenght if the id of this process is larger than the max number of chars allowed (#{line_chars.to_s})' if line_chars < my_pid.size 
+      # obtengo el id del proceso que se reservo este perfil
+      @@fd_profile_lock.seek(-line_chars, IO::SEEK_CUR)
+      lock_pid = @@fd_profile_lock.read.to_s      
+      # libero el archivo de este perfil
+      @@fd_profile_lock.flock(File::LOCK_UN)
+      # return
+      my_pid.strip.upcase == lock_pid.strip.upcase
     end
+
+    # This method is to open no more than one browser of the same profile at time.
+    # It will lock the file at the begining.
+    # If the content of the file is the PID of this process, so this process is good to start the browser.
+    # If the content of the file is different than the PID of this process, but such content is not equal to the PID of any other process alive, so this process is good to start the browser.
+    # If the content of the file is different than the PID of this process, and such content is equal to the PID of another process alive, this method unlock the file and will raise an exception.
+    def self.lockProfile
+      # el archivo tiene una unica primera linea de ancho fijo
+      line_chars = 100
+      # bloqueo el archivo de este perfil
+      @@fd_profile_lock.flock(File::LOCK_EX)
+      # obtengo el id de este proceso que esta corriendo
+      my_pid = PROCESS.pid
+      # valido que my_pid no tenga mas caracteres que al ancho fijo
+      raise 'Cannot work browser profile lockfile because the lenght if the id of this process is larger than the max number of chars allowed (#{line_chars.to_s})' if line_chars < my_pid.size 
+      # obtengo el id del proceso que se reservo este perfil
+      lock_pid = @@fd_profile_lock.read.to_s
+      # 
+      if lock_pid.size == 0
+        @@fd_profile_lock.write my_pid
+        @@fd_profile_lock.write ' ' * (line_chars - my_pid.size)
+        @@fd_profile_lock.flush
+      elsif lock_pid.strip.upcase != my_pid.strip.upcase
+        # verifico si el proceso que reservo este perfil esta activo
+        p = PROCESS.list().select { |h| h[:pid].strip.upcase == lock_pid.strip.upcase }.first
+        lock_process_is_alive = !p.nil?
+        # levanto una excepcion de bloqueo si este perfil fue reservado por otro proceso y el proceso sigue activo
+        if lock_process_is_alive
+          # libero el archivo de este perfil
+          @@fd_profile_lock.flock(File::LOCK_UN)
+          # 
+          raise 'Profile is locked'
+        # me reservo este perfil si fue reservado por un proceso que ya no esta activo
+        else # if lock_process_is_alive
+          @@fd_profile_lock.seek(-line_chars, IO::SEEK_CUR)
+          @@fd_profile_lock.write my_pid
+          @@fd_profile_lock.write ' ' * (line_chars - my_pid.size)
+          @@fd_profile_lock.flush
+        end # if lock_process_is_alive
+      else # lock_pid.strip.upcase == my_pid.strip.upcase
+        # go ahead
+      end # if lock_pid.size == 0
+    end # def self.lockProfile()
   
-    def self.releaseProfileList()
-  #    @@fd_profile.flock(File::LOCK_UN)
-=begin
-      begin
-        @@fd_profile.close
-      rescue
-      end
-      @@fd_profile = nil
-=end
+    # This method is to open no more than one browser of the same profile at time.
+    # It will unlock the file at the begining.
+    def self.releaseProfile
+      # libero el archivo de este perfil
+      @@fd_profile_lock.flock(File::LOCK_UN)
     end
   
     # NOTA: esta lista debe estar permitida por LinkedIn. De caso contrario, aparecera el mensaje "Upgrad your browser"
@@ -330,86 +505,101 @@ module BlackStack
       "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.116 Safari/537.36 Edge/15.15063", 
       ]
     
-    # toma una captura del area visible de la pagina
-    # mas informacion: https://stackoverflow.com/questions/25543651/screenshot-of-entire-webpage-using-selenium-webdriver-rc-rails
+    # Toma una captura del area visible de la pagina.
+    # Mas informacion: https://stackoverflow.com/questions/25543651/screenshot-of-entire-webpage-using-selenium-webdriver-rc-rails
     def self.screenshot(filename)
       @@driver.save_screenshot(filename)
     end
     
-    def self.agents()
+    # Returns a suggested list of user-agents
+    def self.agents
       return @@arAgents
     end
     
-    def self.getPid()
+    # Returns the PID of the browser.
+    # Returns always nill if the browser is Mimic.
+    def self.getPid
       return @@pid
     end
-    
-    def self.isCreated()
-      if (self.readPidToProfileList(@@profile_name).size>0)
-        return true
-      end
-      if (@@browser != nil)
-        return true
-      end
-      
-      return false
+
+    # This method will lock the lockfile regarding this host,
+    # in order to get all processes in the same host launching
+    # one browser at time.
+    # 
+    # Since chromedriver can't take one starting request at time, 
+    # this method is to force the BrowserFactory classs, running
+    # in many processes of the same host at the same time, to try  
+    # to launch browsers at the same time.
+    def self.lock
+      @@fd_host_lock.flock(File::LOCK_EX) if @@type == BlackStack::BrowserFactory::TYPE_CHROME
     end
   
-    def self.isCreated?
-      self.isCreated()
-    end
-    
-    def self.reservation_id()
-      q = "SELECT TOP 1 reservation_id FROM browserfactory WHERE host_name='#{Socket.gethostname}'"
-      row = DB[q].first
-      if (row == nil)
-        DB.execute("INSERT INTO browserfactory (reservation_id, reservation_time, host_name) VALUES (NULL, NULL, '#{Socket.gethostname}')")
-      end
-      row = DB[q].first
-      return row[:reservation_id]
+    # Releases the lockfile regarding this host.
+    def self.release
+      @@fd_host_lock.flock(File::LOCK_UN) if @@type == BlackStack::BrowserFactory::TYPE_CHROME
     end
     
-    def self.lock()
-      @@fd.flock(File::LOCK_EX)
-    end
-  
-    def self.release()
-      @@fd.flock(File::LOCK_UN)
-    end
+    # Close the browser only if itIsMe? returns true.
+    # Set nil to @@browser, @@pid, @@profile_name, @@driver, @@type.
+    def self.destroy
+      if self.itIsMe?
+        begin        
+          # borro el contenido de PROFILE_LOCK_FILENAME 
+          if !@@profile_name.nil?
+            fname = PROFILE_LOCK_FILENAME.gsub('%PROFILE_NAME%', @@profile_name) 
+            File.open(fname,'w')
+          end
+          
+          # 
+          if @@type == BlackStack::BrowserFactory::TYPE_CHROME
+            # kill all child process
+            self.lockProfileList()
+            self.readPidToProfileList(@@profile_name).each { |pid|
+              MyProcess.kill(pid)
+              self.removePidToProfileList(@@profile_name, pid)      
+            }
+            self.releaseProfileList()
+            
+            begin
+              @@browser.close if !@@browser.nil?
+            rescue
+            end
+            
+          elsif @@type == BlackStack::BrowserFactory::TYPE_MIMIC
+            begin
+              #@@browser.close if !@@browser.nil?
+            rescue
+            end
     
-    def self.destroy()
-      if @@type == BlackStack::BrowserFactory::TYPE_CHROME
-        self.lockProfileList()
-        self.readPidToProfileList(@@profile_name).each { |pid|
-          MyProcess.kill(pid)
-          self.removePidToProfileList(@@profile_name, pid)      
-        }
-        self.releaseProfileList()
-        begin
-          @@browser.close if !@@browser.nil?
+            begin
+              # TODO: entender porque debo hacer esta llamada a start para que el perfil se cierre cuando ya estaba iniciado
+              BlackStack::BrowserFactory.mimic(@@profile_name) if !@@profile_name.nil?
+            rescue
+              # nothing here
+            end
+            
+            i = 0
+            max = 3
+            success = false
+            while i<max && !success
+              i+=1
+              url = "http://127.0.0.1:#{BlackStack::StealthBrowserAutomation::Multilogin::mla_local_port}/api/v1/profile/stop?profileId=#{@@profile_name}"
+              uri = URI.parse(url)
+              body = Net::HTTP.get(uri)
+              res = JSON.parse(body)
+              success = true if res['status'].to_s == 'OK'
+            end # while i<max
+            raise 'Error requesting Mimic to stop (tried #{i.to_s} times)' if !success
+          
+          else
+            raise 'Cannot destroy browser due unknown browser type'
+          end
         rescue => e
-          # 
-        end
-      elsif @@type == BlackStack::BrowserFactory::TYPE_MIMIC
-        @@browser.close if !@@browser.nil?
-        begin
-          BlackStack::BrowserFactory.mimic(@@profile_name)
-        rescue
-          # nothing here
+          self.release
+          raise e
         end
-        i = 0
-        max = 3
-        success = false
-        while i<max && !success
-          i+=1
-          url = "http://127.0.0.1:#{BlackStack::StealthBrowserAutomation::Multilogin::mla_local_port}/api/v1/profile/stop?profileId=#{@@profile_name}"
-          uri = URI.parse(url)
-          body = Net::HTTP.get(uri)
-          res = JSON.parse(body)
-          success = true if res['status'].to_s == 'OK'
-        end # while i<max
-        raise 'Error requesting Mimic to stop (tried #{i.to_s} times)' if !success
-      end
+      end # if self.isItMe?
+      
       # reseteo las variables    
       @@browser = nil
       @@pid = nil
@@ -418,7 +608,7 @@ module BlackStack
       @@type = nil
     end
     
-    # 
+    # Returns the version of the availalble chrome browser.
     def self.chrome_version
       res = `reg query \"HKEY_CURRENT_USER\\Software\\Google\\Chrome\\BLBeacon\" /v version`.scan(/REG_SZ    (.*)$/).first
       return nil if res.nil?
@@ -426,7 +616,12 @@ module BlackStack
       return nil
     end
         
+    # Returns the version of the availalble chromedriver.
+    # The filename parameter is the full path of the chromedriver.exe command.
+    # If filename parameter is nil, it will look for the chromedriver.exe in the PATH environment. 
     # 
+    # Not valid for Mimic, since MLA handle its own chromedriver
+    # into its installation folder.
     def self.chromedriver_version(filename=nil)
       res = `chromedriver -v`.scan(/ChromeDriver\s(.*)\s\(/).first if filename.nil?
       res = `#{filename} -v`.scan(/ChromeDriver\s(.*)\s\(/).first if !filename.nil?
@@ -435,31 +630,23 @@ module BlackStack
       return nil
     end
     
-    # 
-    def self.chrome(h)
-      # TODO: check if h is a hash
-      # TODO: check the variable type of each param
-      # TODO: check mandatory params 
-      self.launch_chrome(
-        h[:proxy], 
-        h[:load_timeout].nil? ? DEFAULT_LOAD_TIMEOUT : h[:load_timeout], 
-        h[:user_agent],
-        h[:profile_name],
-        h[:chromedriver_path],
-        h[:chromedriver_signature]
-      )
-    end
-
+    # Launch a Mimic browser.
     def self.mimic(mimic_profile_id)
+      # 
+      @@type = BlackStack::BrowserFactory::TYPE_MIMIC
+      @@profile_name = mimic_profile_id
 
-      # Levantar el flag de reserva a mi favor
-      self.lock()
-
-      begin  
-        @@type = BlackStack::BrowserFactory::TYPE_MIMIC
-        @@profile_name = mimic_profile_id
+      #
+      fname = PROFILE_LOCK_FILENAME.gsub('%PROFILE_NAME%', @@profile_name)
+      File.open(fname,'w') if !File.file?(fname)
+      @@fd_profile_lock = File.open(fname,'r+')
 
-        #self.lockProfileList()
+      begin          
+        # Levantar el flag de reserva a mi favor
+        self.lock()
+  
+        # 
+        self.lockProfile()
 
         url_2 = nil
         i = 0
@@ -503,7 +690,7 @@ module BlackStack
         end
       rescue => e
         # 
-        #self.releaseProfileList()              
+        self.releaseProfile()              
         # libero el flag de reserva de turno para crar un browser
         self.release() 
         # 
@@ -511,7 +698,7 @@ module BlackStack
       end
 
       # 
-      #self.releaseProfileList()              
+      self.releaseProfile()              
 
       # libero el flag de reserva de turno para crar un browser
       self.release() 
@@ -520,8 +707,28 @@ module BlackStack
       @@browser
     end
     
-    # 
-    def self.launch_chrome(proxy=nil, load_timeout=DEFAULT_LOAD_TIMEOUT, user_agent=nil, profile_name=nil, chromedriver_path=nil, chromedriver_signature=nil)
+    # It will call launch_chrome to launch a chrome browser.
+    # The hash parameters musy have the following keys:
+    # * proxy: a BlackStack::RemoteProxy object;
+    # * load_timeout: max number of seconds to wait a page to load;
+    # * user_agent: user agent of the browser;
+    # * profile_name: will create a folder with ths name to store all the data of the chrome profile (history, cookies, saved passwords, etc);
+    # * chromedriver_path: location of the chromedriver.exe file, will use DEFAULT_CHROMEDRIVER_PATH by default.
+    def self.chrome(h)
+      # TODO: check if h is a hash
+      # TODO: check the variable type of each param
+      # TODO: check mandatory params 
+      self.launch_chrome(
+        h[:proxy], 
+        h[:load_timeout].nil? ? DEFAULT_LOAD_TIMEOUT : h[:load_timeout], 
+        h[:user_agent],
+        h[:profile_name],
+        h[:chromedriver_path]
+      )
+    end
+
+    # Launch a chrome browser.
+    def self.launch_chrome(proxy=nil, load_timeout=DEFAULT_LOAD_TIMEOUT, user_agent=nil, profile_name=nil, chromedriver_path=nil)
       #
       @@browser = nil
       @@driver = nil
@@ -529,8 +736,9 @@ module BlackStack
       @@profile_name = profile_name
 
       #
-      fname = PROFILE_PID_LOCK_FILENAME.gsub('%PRFILE_NAME%', @@profile_name)
-      @@fd_profile = File.open(fname,"w")
+      fname = PROFILE_LOCK_FILENAME.gsub('%PROFILE_NAME%', @@profile_name)
+      File.open(fname,'w') if !File.file?(fname)
+      @@fd_profile_lock = File.open(fname, 'r+')
       
       # 
       agent = @@arAgents[0] if user_agent.nil?
@@ -542,10 +750,17 @@ module BlackStack
       # 
       while (@@browser == nil)            
         
-        # Levantar el flag de reserva a mi favor
-        self.lock()
-        
         begin
+          # Levantar el flag de reserva a mi favor
+          self.lock()
+  
+          # 
+          self.lockProfile()
+  
+          # 
+          self.lockProfileList()
+
+          #
           client = Selenium::WebDriver::Remote::Http::Default.new
           begin
             client.read_timeout = load_timeout # for newest selenium webdriver version 
@@ -582,54 +797,54 @@ module BlackStack
           if (proxy!=nil)
             switches += proxy.chrome_switches
           end
-  
-          self.lockProfileList()
-  
-          begin
-
-            Selenium::WebDriver::Chrome.driver_path = chromedriver_path if !chromedriver_path.nil?
-            Selenium::WebDriver::Chrome.driver_path = DEFAULT_CHROMEDRIVER_PATH if chromedriver_path.nil?
-            
-            @@driver = Selenium::WebDriver.for :chrome, :switches => switches
-            bridge = @@driver.instance_variable_get(:@bridge)
-            service = bridge.instance_variable_get(:@service)
-            process = service.instance_variable_get(:@process)
-            @@pid = process.pid.to_s # es el PID del chromedriver
-            @@driver.manage.window().maximize()
-            @@browser = PampaBrowser.new(@@driver)
-            @@browser.proxy = proxy.clone if !proxy.nil?    
-            @@browser.agent_name = agent
-            @@browser.profile_name = profile_name
-            self.updateProfileList              
-          rescue => e
-            p1 = PROCESS.list().select { |p| p[:ppid] == PROCESS.pid && p[:executablepath] =~ /chromedriver(.*)\.exe/ }.first
-            if (p1 != nil)
-              @@pid = p1[:pid]
-              self.updateProfileList              
-            end              
-            self.releaseProfileList()
-            raise e
-          end
-          self.releaseProfileList()
+    
+          Selenium::WebDriver::Chrome.driver_path = chromedriver_path if !chromedriver_path.nil?
+          Selenium::WebDriver::Chrome.driver_path = DEFAULT_CHROMEDRIVER_PATH if chromedriver_path.nil?
             
-          # Liberar el flag de reserva de creacion del browser
-          self.release()
+          @@driver = Selenium::WebDriver.for :chrome, :switches => switches
+          bridge = @@driver.instance_variable_get(:@bridge)
+          service = bridge.instance_variable_get(:@service)
+          process = service.instance_variable_get(:@process)
+          @@pid = process.pid.to_s # es el PID del chromedriver
+          @@driver.manage.window().maximize()
+          @@browser = PampaBrowser.new(@@driver)
+          @@browser.proxy = proxy.clone if !proxy.nil?    
+          @@browser.agent_name = agent
+          @@browser.profile_name = profile_name
+          self.updateProfileList              
   
         # 
         rescue => e # TODO: Se atrapa una expecion porque sigue ocurreiendo el error reportado en el issue #134 y #129
+          # 
+          p1 = PROCESS.list().select { |p| p[:ppid] == PROCESS.pid && p[:executablepath] =~ /chromedriver\.exe/ }.first
+          if (p1 != nil)
+            @@pid = p1[:pid]
+            self.updateProfileList              
+          end              
+          self.releaseProfileList()
+
+          #
+          self.releaseProfile()
+
           # Liberar el flag de reserva de creacion del browser
           self.release()
   
           # disparar la exepcion
           raise e          
         end                  
+
+        #
+        self.releaseProfile()
+            
+        # Liberar el flag de reserva de creacion del browser
+        self.release()
+
       end # while
       
       #
       @@browser
     end # create
   
-  
   end # class
 
 end # module BlackStack

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stealth_browser_automation
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 1.1.9
 platform: ruby
 authors:
 - Leandro Daniel Sardi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-11 00:00:00.000000000 Z
+date: 2020-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick