Merge branch 'ksarunas-feature/add_downloading_in_multi_threads'

.gitignore

@@ -5,6 +5,7 @@ doc
 rdoc
 log
 websites
+.DS_Store
 
 ## BUNDLER
 *.gem

.travis.yml

@@ -6,3 +6,4 @@ rvm:
   - 2.1
   - 2.2
   - jruby
+  - rbx-2

README.md

@@ -34,6 +34,7 @@ It will download the last version of every file present on Wayback Machine to `.
           -x, --exclude EXCLUDE_FILTER     Skip downloading of urls that match this filter (use // notation for the filter to be treated as a regex)
           -a, --all                        Expand downloading to error files (40x and 50x) and redirections (30x)
           -l, --list                       Only list file urls in a JSON format with the archived timestamps. Won't download anything.
+          -c, --concurrency NUMBER         Number of multiple files to download at a time. Default is one file at a time. (ie. 20)
           -v, --version                    Display version
 
 ## From Timestamp
@@ -106,6 +107,16 @@ Example:
 
     wayback_machine_downloader http://example.com --list
 
+## Download multiple files at a time
+
+    -c, --concurrency NUMBER  
+
+Optional. Specify the number of multiple files you want to download at the same time. Allows to speed up the download of a website significantly. Default is to download one file at the time.
+
+Example:
+
+    wayback_machine_downloader http://example.com --concurrency 20
+
 ## Using the Docker image
 
 As an alternative installation way, we have a Docker image! Retrieve the wayback-machine-downloader Docker image this way:

bin/wayback_machine_downloader

@@ -38,6 +38,10 @@ option_parser = OptionParser.new do |opts|
     options[:list] = true
   end
 
+  opts.on("-c", "--concurrency NUMBER", Integer, "Number of multiple files to dowload at a time. Default is one file at a time. (ie. 20)") do |t|
+    options[:threads_count] = t
+  end
+
   opts.on("-v", "--version", "Display version") do |t|
     options[:version] = t
   end

lib/wayback_machine_downloader.rb

@@ -9,9 +9,9 @@ require_relative 'wayback_machine_downloader/to_regex'
 
 class WaybackMachineDownloader
 
-  VERSION = "0.4.9"
+  VERSION = "0.5.0"
 
-  attr_accessor :base_url, :from_timestamp, :to_timestamp, :only_filter, :exclude_filter, :all, :list
+  attr_accessor :base_url, :from_timestamp, :to_timestamp, :only_filter, :exclude_filter, :all, :list, :threads_count
 
   def initialize params
     @base_url = params[:base_url]
@@ -21,6 +21,7 @@ class WaybackMachineDownloader
     @exclude_filter = params[:exclude_filter]
     @all = params[:all]
     @list = params[:list]
+    @threads_count = params[:threads_count].to_i
   end
 
   def backup_name
@@ -121,9 +122,10 @@ class WaybackMachineDownloader
   end
 
   def download_files
+    start_time = Time.now
     puts "Downloading #{@base_url} to #{backup_path} from Wayback Machine..."
     puts
-    file_list_by_timestamp = get_file_list_by_timestamp
+
     if file_list_by_timestamp.count == 0
       puts "No files to download."
       puts "Possible reasons:"
@@ -134,9 +136,49 @@ class WaybackMachineDownloader
       puts "\t* Exclude filter too wide (#{exclude_filter.to_s})" if @exclude_filter
       return
     end
-    count = 0
-    file_list_by_timestamp.each do |file_remote_info|
-      count += 1
+
+    threads = []
+    @processed_file_count = 0
+    @threads_count = 1 unless @threads_count != 0
+    @threads_count.times do
+      threads << Thread.new do
+        until file_queue.empty?
+          file_remote_info = file_queue.pop(true) rescue nil
+          download_file(file_remote_info) if file_remote_info
+        end
+      end
+    end
+
+    threads.each(&:join)
+    end_time = Time.now
+    puts
+    puts "Download completed in #{(end_time - start_time).round(2)}s, saved in #{backup_path} (#{file_list_by_timestamp.size} files)"
+  end
+
+  def structure_dir_path dir_path
+    begin
+      FileUtils::mkdir_p dir_path unless File.exists? dir_path
+    rescue Errno::EEXIST => e
+      error_to_string = e.to_s
+      puts "# #{error_to_string}"
+      if error_to_string.include? "File exists @ dir_s_mkdir - "
+        file_already_existing = error_to_string.split("File exists @ dir_s_mkdir - ")[-1]
+      elsif error_to_string.include? "File exists - "
+        file_already_existing = error_to_string.split("File exists - ")[-1]
+      else
+        raise "Unhandled directory restructure error # #{error_to_string}"
+      end
+      file_already_existing_temporary = file_already_existing + '.temp'
+      file_already_existing_permanent = file_already_existing + '/index.html'
+      FileUtils::mv file_already_existing, file_already_existing_temporary
+      FileUtils::mkdir_p file_already_existing
+      FileUtils::mv file_already_existing_temporary, file_already_existing_permanent
+      puts "#{file_already_existing} -> #{file_already_existing_permanent}"
+      structure_dir_path dir_path
+    end
+  end
+
+  def download_file file_remote_info
     file_url = file_remote_info[:file_url]
     file_id = file_remote_info[:file_id]
     file_timestamp = file_remote_info[:timestamp]
@@ -180,36 +222,27 @@ class WaybackMachineDownloader
           puts "#{file_path} was empty and was removed."
         end
       end
-        puts "#{file_url} -> #{file_path} (#{count}/#{file_list_by_timestamp.size})"
+      semaphore.synchronize do
+        @processed_file_count += 1
+        puts "#{file_url} -> #{file_path} (#{@processed_file_count}/#{file_list_by_timestamp.size})"
+      end
     else
-        puts "#{file_url} # #{file_path} already exists. (#{count}/#{file_list_by_timestamp.size})"
+      semaphore.synchronize do
+        @processed_file_count += 1
+        puts "#{file_url} # #{file_path} already exists. (#{@processed_file_count}/#{file_list_by_timestamp.size})"
       end
     end
-    puts
-    puts "Download complete, saved in #{backup_path} (#{file_list_by_timestamp.size} files)"
-  end
-
-  def structure_dir_path dir_path
-    begin
-      FileUtils::mkdir_p dir_path unless File.exists? dir_path
-    rescue Errno::EEXIST => e
-      error_to_string = e.to_s
-      puts "# #{error_to_string}"
-      if error_to_string.include? "File exists @ dir_s_mkdir - "
-        file_already_existing = error_to_string.split("File exists @ dir_s_mkdir - ")[-1]
-      elsif error_to_string.include? "File exists - "
-        file_already_existing = error_to_string.split("File exists - ")[-1]
-      else
-        raise "Unhandled directory restructure error # #{error_to_string}"
-      end
-      file_already_existing_temporary = file_already_existing + '.temp'
-      file_already_existing_permanent = file_already_existing + '/index.html'
-      FileUtils::mv file_already_existing, file_already_existing_temporary
-      FileUtils::mkdir_p file_already_existing
-      FileUtils::mv file_already_existing_temporary, file_already_existing_permanent
-      puts "#{file_already_existing} -> #{file_already_existing_permanent}"
-      structure_dir_path dir_path
-    end
   end
 
+  def file_queue
+    @file_queue ||= file_list_by_timestamp.each_with_object(Queue.new) { |file_info, q| q << file_info }
+  end
+
+  def file_list_by_timestamp
+    @file_list_by_timestamp ||= get_file_list_by_timestamp
+  end
+
+  def semaphore
+    @semaphore ||= Mutex.new
+  end
 end