s3sync 0.3.4 → 1.2.5

data/README_s3cmd

@@ -0,0 +1,172 @@
+Welcome to s3cmd.rb 
+------------------- 
+This is a ruby program that wraps S3 operations into a simple command-line tool.
+It is inspired by things like rsh3ll, #sh3ll, etc., but shares no code from
+them. It's meant as a companion utility to s3sync.rb but could be used on its
+own (provided you have read the other readme file and know how to use s3sync in
+theory).
+
+I made this even though lots of other "shell"s exist, because I wanted a
+single-operation utility, instead of a shell "environment".  This lends itself
+more to scripting, etc.  Also the delete operation on rsh3ll seems to be borken
+at the moment? =(
+
+Users not yet familiar with s3sync should read about that first, since s3cmd and
+s3sync share a tremendous amount of conventions and syntax. Particularly you
+have to set up environment variables prior to calling s3cmd, and s3cmd also uses
+the "bucket:key" syntax popularized by s3sync. Many of the options are the same
+too. Really, go read the other readme first if you haven't used s3sync yet.
+Otherwise you will become confused.  It's OK, I'll wait.
+
+....
+
+In general, s3sync and s3cmd complement each other. s3sync is useful to perform
+serious synchronization operations, and s3cmd allows you to do simple things
+such as bucket management, listing, transferring single files, and the like.
+
+Here is the usage, with examples to follow.
+
+s3cmd.rb [options] <command> [arg(s)]           version 1.0.0
+  --help    -h        --verbose     -v     --dryrun    -n
+  --ssl     -s        --debug       -d
+
+Commands:
+s3cmd.rb  listbuckets  [headers]
+s3cmd.rb  createbucket|deletebucket  <bucket>  [headers]
+s3cmd.rb  list  <bucket>[:prefix]  [max/page]  [delimiter]  [headers]
+s3cmd.rb  delete  <bucket>:key  [headers]
+s3cmd.rb  deleteall  <bucket>[:prefix]  [headers]
+s3cmd.rb  get|put  <bucket>:key  <file>  [headers]
+
+
+A note about [headers]
+----------------------
+For some S3 operations, such as "put", you might want to specify certain headers
+to the request such as Cache-Control, Expires, x-amz-acl, etc.  Rather than
+supporting a load of separate command-line options for these, I just allow
+header specification.  So to upload a file with public-read access you could
+say:
+	s3cmd.rb  put  MyBucket:TheFile.txt  x-amz-acl:public-read
+
+If you don't need to add any particular headers then you can just ignore this
+whole [headers] thing and pretend it's not there.  This is somewhat of an
+advanced option.
+
+
+Examples
+--------
+List all the buckets your account owns:
+	s3cmd.rb listbuckets
+
+Create a new bucket:
+	s3cmd.rb createbucket BucketName
+
+Create a new bucket in the EU:
+	s3cmd.rb createbucket BucketName EU
+   
+Find out the location constraint of a bucket:
+   s3cmd.rb location BucketName
+
+Delete an old bucket you don't want any more:
+	s3cmd.rb deletebucket BucketName
+	
+Find out what's in a bucket, 10 lines at a time:
+	s3cmd.rb list BucketName 10
+	
+Only look in a particular prefix:
+	s3cmd.rb list BucketName:startsWithThis
+	
+Look in the virtual "directory" named foo;
+lists sub-"directories" and keys that are at this level.
+Note that if you specify a delimiter you must specify a max before it.
+(until I make the options parsing smarter)
+	s3cmd.rb list BucketName:foo/  10  /
+
+Delete a key:
+	s3cmd.rb delete BucketName:AKey
+
+Delete all keys that match (like a combo between list and delete):
+	s3cmd.rb deleteall BucketName:SomePrefix
+	
+Only pretend you're going to delete all keys that match, but list them: 
+	s3cmd.rb  --dryrun  deleteall  BucketName:SomePrefix
+	
+Delete all keys in a bucket (leaving the bucket):
+	s3cmd.rb deleteall BucketName
+	
+Get a file from S3 and store it to a local file
+	s3cmd.rb get BucketName:TheFileOnS3.txt  ALocalFile.txt
+	
+Put a local file up to S3 
+Note we don't automatically set mime type, etc.
+NOTE that the order of the options doesn't change. S3 stays first!
+	s3cmd.rb put BucketName:TheFileOnS3.txt ALocalFile.txt
+
+	
+Change Log:
+-----------
+2006-10-14:
+Created.
+-----------
+
+2006-10-16
+Version 1.0.1
+Force content length to a string value since some ruby's don't convert it right.
+-----------
+
+2006-10-25
+UTF-8 fixes.
+-----------
+
+2006-11-28
+Version 1.0.3
+Added a couple more error catches to s3try.
+----------
+
+2007-01-25
+Version 1.0.4
+Peter Fales' marker fix.
+Also, markers should be decoded into native charset (because that's what s3
+expects to see).
+----------
+
+2007-02-19
+- Updated s3try and s3_s3sync_mod to allow SSL_CERT_FILE
+----------
+
+2007-2-25
+Added --progress
+----------
+
+2007-07-12
+Version 1.0.6
+Added Alastair Brunton's yaml config code.
+----------
+
+2007-11-17
+Version 1.2.1
+Compatibility for S3 API revisions.
+When retries are exhausted, emit an error.
+----------
+
+2007-11-20
+Version 1.2.2
+Handle EU bucket 307 redirects (in s3try.rb)
+----------
+
+2007-11-20
+Version 1.2.3
+Fix SSL verification settings that broke in new S3 API.
+----------
+
+2008-01-06
+Version 1.2.4
+Run from any dir (search "here" for includes).
+Search out s3config.yml in some likely places.
+Reset connection (properly) on retry-able non-50x errors.
+Fix calling format bug preventing it from working from yml.
+Added http proxy support.
+----------
+
+
+FNORD

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require File.join(File.dirname(__FILE__), 'lib', 'version')
+
+Gem::manage_gems
+
+readmes = ["README","README_s3cmd"]
+
+spec = Gem::Specification.new do |s|
+    s.platform     = Gem::Platform::RUBY
+    s.name         = "s3sync"
+    s.version      = S3sync::VERSION::STRING
+    s.author       = ""
+    s.email        = ""
+    s.homepage     = "http://s3sync.net/"
+    s.rubyforge_project = "s3sync"
+    s.summary      = "rsync-like client for backing up to Amazons S3"
+    s.files        = Dir.glob("{bin,lib,docs}/**/*.rb") + ["Rakefile", "setup.rb", "CHANGELOG"] + readmes
+    s.require_path = "lib"
+    s.executables  = ['s3sync','s3cmd']
+    s.has_rdoc     = true
+    s.extra_rdoc_files  = readmes
+end
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+task :default => "pkg/#{spec.name}-#{spec.version}.gem" do
+    puts "generated latest version"
+end

data/bin/s3cmd

@@ -0,0 +1,245 @@
+#! /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby
+# This software code is made available "AS IS" without warranties of any        
+# kind.  You may copy, display, modify and redistribute the software            
+# code either by itself or as incorporated into your code; provided that        
+# you do not remove any proprietary notices.  Your use of this software         
+# code is at your own risk and you waive any claim against the author
+# with respect to your use of this software code. 
+# (c) 2007 s3sync.net
+#
+
+module S3sync
+
+   # always look "here" for include files (thanks aktxyz)
+   $LOAD_PATH << File.expand_path(File.dirname(__FILE__)) 
+
+	require 's3try'
+	
+	$S3CMD_VERSION = '1.2.5'
+   
+	require 'getoptlong'
+
+   # after other mods, so we don't overwrite yaml vals with defaults
+   require 's3config'
+   include S3Config
+	
+	def S3sync.s3cmdMain 	
+		# ---------- OPTIONS PROCESSING ---------- #	
+	
+		$S3syncOptions = Hash.new
+		optionsParser = GetoptLong.new(
+			  [ '--help',    '-h',	GetoptLong::NO_ARGUMENT ],
+			  [ '--ssl',     '-s',	GetoptLong::NO_ARGUMENT ],
+			  [ '--verbose', '-v',	GetoptLong::NO_ARGUMENT ],
+			  [ '--dryrun',  '-n',	GetoptLong::NO_ARGUMENT ], 
+			  [ '--debug',   '-d',	GetoptLong::NO_ARGUMENT ],
+			  [ '--progress',       GetoptLong::NO_ARGUMENT ],
+           [ '--expires-in', GetoptLong::REQUIRED_ARGUMENT ]
+			  )
+			  
+		def S3sync.s3cmdUsage(message = nil)
+			$stderr.puts message if message
+			name = $0.split('/').last
+			$stderr.puts <<"ENDUSAGE"
+#{name} [options] <command> [arg(s)]\t\tversion #{$S3CMD_VERSION}
+  --help    -h        --verbose     -v     --dryrun    -n	
+  --ssl     -s        --debug       -d     --progress
+  --expires-in=( <# of seconds> | [#d|#h|#m|#s] )
+  
+Commands:
+#{name}  listbuckets  [headers]
+#{name}  createbucket  <bucket>  [constraint (i.e. EU)]
+#{name}  deletebucket  <bucket>  [headers]
+#{name}  list  <bucket>[:prefix]  [max/page]  [delimiter]  [headers]
+#{name}  location  <bucket> [headers]
+#{name}  delete  <bucket>:key  [headers]
+#{name}  deleteall  <bucket>[:prefix]  [headers]
+#{name}  get|put  <bucket>:key  <file>  [headers]
+ENDUSAGE
+		exit
+		end #usage
+		
+		begin
+			optionsParser.each {|opt, arg| $S3syncOptions[opt] = (arg || true)}
+		rescue StandardError
+			s3cmdUsage # the parser already printed an error message
+		end
+		s3cmdUsage if $S3syncOptions['--help']
+		$S3syncOptions['--verbose'] = true if $S3syncOptions['--dryrun'] or $S3syncOptions['--debug'] or $S3syncOptions['--progress']
+		$S3syncOptions['--ssl'] = true if $S3syncOptions['--ssl'] # change from "" to true to appease s3 port chooser
+      
+      if $S3syncOptions['--expires-in'] =~ /d|h|m|s/
+         e = $S3syncOptions['--expires-in']
+         days = (e =~ /(\d+)d/)? (/(\d+)d/.match(e))[1].to_i : 0
+         hours = (e =~ /(\d+)h/)? (/(\d+)h/.match(e))[1].to_i : 0
+         minutes = (e =~ /(\d+)m/)? (/(\d+)m/.match(e))[1].to_i : 0
+         seconds = (e =~ /(\d+)s/)? (/(\d+)s/.match(e))[1].to_i : 0
+         $S3syncOptions['--expires-in'] = seconds + 60 * ( minutes + 60 * ( hours + 24 * ( days ) ) )
+      end
+
+		# ---------- CONNECT ---------- #
+		S3sync::s3trySetup 
+		# ---------- COMMAND PROCESSING ---------- #		
+
+		command, path, file = ARGV
+		
+		s3cmdUsage("You didn't set up your environment variables; see README.txt") if not($AWS_ACCESS_KEY_ID and $AWS_SECRET_ACCESS_KEY) 
+		s3cmdUsage("Need a command (etc)") if not command
+
+		path = '' unless path
+		path = path.dup # modifiable
+		path += ':' unless path.match(':')
+		bucket = (/^(.*?):/.match(path))[1]
+		path.replace((/:(.*)$/.match(path))[1])
+
+		case command
+			when "delete"
+				s3cmdUsage("Need a bucket") if bucket == ''
+				s3cmdUsage("Need a key") if path == ''
+				headers = hashPairs(ARGV[2...ARGV.length])
+				$stderr.puts "delete #{bucket}:#{path} #{headers.inspect if headers}" if $S3syncOptions['--verbose']
+				S3try(:delete, bucket, path) unless $S3syncOptions['--dryrun']
+			when "deleteall"
+				s3cmdUsage("Need a bucket") if bucket == ''
+				headers = hashPairs(ARGV[2...ARGV.length])
+				$stderr.puts "delete ALL entries in #{bucket}:#{path} #{headers.inspect if headers}" if $S3syncOptions['--verbose']
+				more = true
+				marker = nil
+				while more do
+					res = s3cmdList(bucket, path, nil, nil, marker)
+					res.entries.each do |item|
+						# the s3 commands (with my modified UTF-8 conversion) expect native char encoding input
+						key = Iconv.iconv($S3SYNC_NATIVE_CHARSET, "UTF-8", item.key).join
+						$stderr.puts "delete #{bucket}:#{key} #{headers.inspect if headers}" if $S3syncOptions['--verbose']
+						S3try(:delete, bucket, key) unless $S3syncOptions['--dryrun']		
+					end
+					more = res.properties.is_truncated
+					marker = (res.properties.next_marker)? res.properties.next_marker : ((res.entries.length > 0) ? res.entries.last.key : nil)
+					# get this into local charset; when we pass it to s3 that is what's expected
+					marker = Iconv.iconv($S3SYNC_NATIVE_CHARSET, "UTF-8", marker).join if marker
+				end
+			when "list"
+				s3cmdUsage("Need a bucket") if bucket == ''
+				max, delim = ARGV[2..3]
+				headers = hashPairs(ARGV[4...ARGV.length])
+				$stderr.puts "list #{bucket}:#{path} #{max} #{delim} #{headers.inspect if headers}" if $S3syncOptions['--verbose']
+				puts "--------------------"
+				
+				more = true
+				marker = nil
+				while more do
+					res = s3cmdList(bucket, path, max, delim, marker, headers)
+					if delim
+						res.common_prefix_entries.each do |item|
+							
+							puts "dir: " + Iconv.iconv($S3SYNC_NATIVE_CHARSET, "UTF-8", item.prefix).join
+						end
+						puts "--------------------"
+					end
+					res.entries.each do |item|
+						puts Iconv.iconv($S3SYNC_NATIVE_CHARSET, "UTF-8", item.key).join
+					end
+					if res.properties.is_truncated
+						printf "More? Y/n: "
+						more = (STDIN.gets.match('^[Yy]?$'))
+						marker = (res.properties.next_marker)? res.properties.next_marker : ((res.entries.length > 0) ? res.entries.last.key : nil)
+						# get this into local charset; when we pass it to s3 that is what's expected
+						marker = Iconv.iconv($S3SYNC_NATIVE_CHARSET, "UTF-8", marker).join if marker
+						
+					else
+						more = false
+					end
+				end # more
+			when "listbuckets"
+				headers = hashPairs(ARGV[1...ARGV.length])
+				$stderr.puts "list all buckets #{headers.inspect if headers}" if $S3syncOptions['--verbose']
+            if $S3syncOptions['--expires-in']
+               $stdout.puts S3url(:list_all_my_buckets, headers)
+            else
+               res = S3try(:list_all_my_buckets, headers)
+               res.entries.each do |item|
+					   puts item.name
+               end
+            end
+			when "createbucket"
+				s3cmdUsage("Need a bucket") if bucket == ''
+            lc = ''
+            if(ARGV.length > 2)
+               lc = '<CreateBucketConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01"><LocationConstraint>' + ARGV[2] + '</LocationConstraint></CreateBucketConfiguration>'
+            end
+				$stderr.puts "create bucket #{bucket} #{lc}" if $S3syncOptions['--verbose']
+				S3try(:create_bucket, bucket, lc) unless $S3syncOptions['--dryrun']
+			when "deletebucket"
+				s3cmdUsage("Need a bucket") if bucket == ''
+				headers = hashPairs(ARGV[2...ARGV.length])
+				$stderr.puts "delete bucket #{bucket} #{headers.inspect if headers}" if $S3syncOptions['--verbose']
+				S3try(:delete_bucket, bucket, headers) unless $S3syncOptions['--dryrun']
+			when "location"
+				s3cmdUsage("Need a bucket") if bucket == ''
+				headers = hashPairs(ARGV[2...ARGV.length])
+            query = Hash.new
+            query['location'] = 'location'
+				$stderr.puts "location request bucket #{bucket} #{query.inspect} #{headers.inspect if headers}" if $S3syncOptions['--verbose']
+				S3try(:get_query_stream, bucket, '', query, headers, $stdout) unless $S3syncOptions['--dryrun']
+			when "get"
+				s3cmdUsage("Need a bucket") if bucket == ''
+				s3cmdUsage("Need a key") if path == ''
+				s3cmdUsage("Need a file") if file == ''
+				headers = hashPairs(ARGV[3...ARGV.length])
+				$stderr.puts "get from key #{bucket}:#{path} into #{file} #{headers.inspect if headers}" if $S3syncOptions['--verbose']
+				unless $S3syncOptions['--dryrun']
+               if $S3syncOptions['--expires-in']
+                  $stdout.puts S3url(:get, bucket, path, headers)
+               else
+                  outStream = File.open(file, 'wb')
+                  outStream = ProgressStream.new(outStream) if $S3syncOptions['--progress']
+                  S3try(:get_stream, bucket, path, headers, outStream)
+                  outStream.close
+               end
+				end
+			when "put"
+				s3cmdUsage("Need a bucket") if bucket == ''
+				s3cmdUsage("Need a key") if path == ''
+				s3cmdUsage("Need a file") if file == ''
+				headers = hashPairs(ARGV[3...ARGV.length])
+				stream = File.open(file, 'rb')
+				stream = ProgressStream.new(stream, File.stat(file).size) if $S3syncOptions['--progress']
+				s3o = S3::S3Object.new(stream, {}) # support meta later?
+				headers['Content-Length'] = FileTest.size(file).to_s
+				$stderr.puts "put to key #{bucket}:#{path} from #{file} #{headers.inspect if headers}" if $S3syncOptions['--verbose']
+				S3try(:put, bucket, path, s3o, headers) unless $S3syncOptions['--dryrun']
+				stream.close
+			else
+				s3cmdUsage
+		end
+
+	end #main
+	def S3sync.s3cmdList(bucket, path, max=nil, delim=nil, marker=nil, headers={})
+		debug(max)
+		options = Hash.new
+		options['prefix'] = path # start at the right depth
+		options['max-keys'] = max ? max.to_s : 100
+		options['delimiter'] = delim if delim
+		options['marker'] = marker if marker
+		S3try(:list_bucket, bucket, options, headers)
+	end
+	
+	# turn an array into a hash of pairs
+	def S3sync.hashPairs(ar)
+		ret = Hash.new
+		ar.each do |item|
+			name = (/^(.*?):/.match(item))[1]
+			item = (/^.*?:(.*)$/.match(item))[1]
+			ret[name] = item
+		end if ar
+		ret
+	end
+end #module
+
+
+
+def debug(str)
+	$stderr.puts str if $S3syncOptions['--debug']
+end
+
+S3sync::s3cmdMain #go!