RubyGems - davclient - Versions diffs - 0.0.4 → 0.0.5 - Mend

davclient 0.0.4 → 0.0.5

Files changed (6) hide show

data/README.rdoc CHANGED Viewed

@@ -5,9 +5,15 @@
 == DESCRIPTION:
+A scriptable WebDAV command line client for
 WebDAV command line client written in Ruby for managing content on
 webservers that support the WebDAV extensions.
+This is still very much work in progress. Especially the command line interface
+is changed a lot recently. The ruby library however is starting to settle.
 == Requirements
 The command line utility curl installed and available in your unix path.
@@ -70,7 +76,20 @@ authentication. DavClient instead uses the command line tool 'curl' to do all th
 authentication and networking. To avoid handling authentication all togheter, curl
 are told to look up all usernames and passwords are in a file named ~/.netrc.
-The command 'dav' is  non-interactive and inspired by git, making it suitable for
+The command line utility 'dav' is non-interactive and inspired by git, making it more suitable for
 use in scripts. If you can script in Ruby, the examples folder includes sample
 scripts using the davclient Ruby library.
+== Licence
+DavClient (davclient and the dav utility) is copyrighted free software by Thomas Flemming
+<thomas dot flemming at usit.uio.no> and contributors. You can redistribute it
+and/or modify it under either the terms of the GPL2 or the conditions below:
+See LICENCE file for details.
+== Comments
+Feel free to contact me at thomas dot flemming at usit.uio.no.

data/lib/davclient.rb CHANGED Viewed

@@ -19,7 +19,7 @@ require 'davclient/curl_commands'
 module WebDAV
   # :stopdoc:
-  VERSION = '0.0.5'
+  VERSION = '0.0.4'
   # :startdoc:
   # Returns the version string for the library.
@@ -61,6 +61,18 @@ module WebDAV
     return url
   end
+  # Returns true if url is a collection
+  def self.isCollection?(url)
+    url = absoluteUrl(url)
+    url = url + "/" if(not(url =~ /\/$/))
+    resource = WebDAV.propfind(url)
+    if(resource == nil)
+      return false
+    else
+      return resource.isCollection?
+    end
+  end
   # Change current working url. Takes relative pathnames.
   #
   # Examples:
@@ -71,13 +83,11 @@ module WebDAV
   def self.cd(url)
     url = absoluteUrl(url)
     url = url + "/" if(not(url =~ /\/$/))
     resource = WebDAV.propfind(url)
     if(resource and resource.isCollection?)then
       WebDAV.CWURL = url
     else
-      # TODO Make proper exception
-      raise Exception, "cd: URL '#{cwurl} is not a WebDAV collection."
+      raise Exception, "#{$0} cd: #{url}: No such collection on remote server."
     end
   end
@@ -88,31 +98,6 @@ module WebDAV
     File.open(cwurl_filename, 'w') {|f| f.write(url) }
   end
-  # Lock resource
-  #
-  def self.lock(*args)
-    url = args[0]
-  end
-# Original code from davlib.py
-#
-#   def lock(self, url, owner='', timeout=None, depth=None,
-#            scope='exclusive', type='write', extra_hdrs={ }):
-#     headers = extra_hdrs.copy()
-#     headers['Content-Type'] = XML_CONTENT_TYPE
-#     if depth is not None:
-#       headers['Depth'] = str(depth)
-#     if timeout is not None:
-#       headers['Timeout'] = timeout
-#     body = XML_DOC_HEADER + \
-#            '<DAV:lockinfo xmlns:DAV="DAV:">' + \
-#            '<DAV:lockscope><DAV:%s/></DAV:lockscope>' % scope + \
-#            '<DAV:locktype><DAV:%s/></DAV:locktype>' % type + \
-#            owner + \
-#            '</DAV:lockinfo>'
-#     return self._request('LOCK', url, body, extra_hdrs=headers)
   # Get content of resource as string
   #
@@ -372,24 +357,29 @@ module WebDAV
   end
   # Puts content of string to file on server with url
   #
   # Example:
   #
   #   WebDAV.put("https://dav.webdav.org/file.html", "<html><h1>Test</h1></html>"
-  def self.put_string(url, html)
+  def self.put_string(url,str)
     url = absoluteUrl(url)
     if(url =~ /\/$/)then
       raise "Error: WebDAV.put_html: url can not be a collection (folder)."
     end
-    tmp_dir = "/tmp/" + rand.to_s[2..10] + "/"
-    FileUtils.mkdir_p tmp_dir
-    tmp_file = tmp_dir + "webdav.tmp"
-    File.open(tmp_file, 'w') {|f| f.write(html) }
+    filename = string2tempfile(str)
+    put(url,filename)
+  end
-    curl_command = "#{$curl} --netrc --silent --upload-file #{tmp_file} #{url}"
+  # Upload local file
+  def self.put(url, file_name)
+    url = absoluteUrl(url)
+    curl_command = "#{$curl} --netrc --silent --upload-file #{file_name} #{url}"
     response = exec_curl(curl_command)
     if(response != "" and not(response =~ /200 OK/)) then
       raise "Error:\n WebDAV.put: WebDAV Request:\n" + curl_command + "\n\nResponse: " + response
@@ -404,29 +394,35 @@ module WebDAV
     return self.exec_curl(CURL_OPTIONS + url )
   end
-  # :stopdoc:
+  # Returns name of temp folder we're using
+  # TODO: Move this to utility library
+  def self.tmp_folder
+    tmp_file = Tempfile.new("dummy").path
+    basename = File.basename(tmp_file)
+    return  tmp_file.gsub(basename, "")
+  end
-  # TODO put file utility
-  # TESTME
-  def put_file(filename, href)
-    # TODO Detect if href is a collection or not??
-    curl_command = "#{$curl} --netrc --request PUT #{filename} #{href}"
-    return exec_curl(curl_command)
-    # return execute_curl_cmd(curl_put_cmd)
+  # TODO: Move this to utility library
+  # Write string to tempfile and returns filename
+  def self.string2tempfile(str)
+    tmp_dir = tmp_folder + rand.to_s[2..10] + "/"
+    FileUtils.mkdir_p tmp_dir
+    tmp_file = tmp_dir + "webdav.tmp"
+    File.open(tmp_file, 'w') {|f| f.write(str) }
+    return tmp_file
   end
-  # :startdoc:
-  private
   # Returns filename /tmp/cwurl.#pid that holds the current working directory
   # for the shell's pid
   def self.cwurl_filename
-    tmp_file = Tempfile.new("dummy").path
-    basename = File.basename(tmp_file)
-    tmp_folder = tmp_file.gsub(basename, "")
     return tmp_folder +  "cwurl." + Process.ppid.to_s
   end
+  private
   # Display instructions for adding credentials to .netrc file
   def self.display_unauthorized_message(href)
     puts "Error: 401 Unauthorized: " + href

data/lib/davclient/dav-ls.rb CHANGED Viewed

@@ -6,7 +6,7 @@
 #
 #     ruby dav-ls  [options][url]
-require 'rubygems'
+# require 'rubygems'
 require 'davclient'
 require 'optparse'
@@ -24,22 +24,58 @@ class LsCLI
         exit
       end
     else
-      WebDAV.cd(url)
+      WebDAV.cd(url)  # TODO Hva er denne til?. Crasher 'dav-ls filnavn.html'!
     end
     url = WebDAV.CWURL
+    names = []
+    items_data = { }
     WebDAV.find(url, :recursive => false ) do |item|
       if(options[:showUrl])then
         puts item.href
       elsif(options[:longFormat])
+        locked = item.search("d:lockdiscovery").search("d:owner").inner_text
+        items_data.merge!(item.basename => [item.href,
+                                            locked,
+                                            item.getlastmodified,
+                                            item.getcontentlength])
       else
-        print item.basename
-        print "/" if item.isCollection?
-        puts
+        # Collect all names in a folder and show them with multiple columns
+        name = item.basename
+        if(item.isCollection?)
+          path = item.href.sub(/#{name}\/$/,"")
+        else
+          path = item.href.sub(/#{name}$/,"")
+        end
+        name +=  "/" if item.isCollection?
+        # puts name.ljust(35) + path
+        names << name
       end
     end
+    if(options[:oneColumn])
+      puts names.sort.join("\n")
+    elsif(options[:longFormat])
+      max_key_size = max_string_size(items_data.keys)
+      items_data.keys.sort.each do |key|
+        locked = ""
+        locked = "Locked by: " + items_data[key][1] if(items_data[key][1] != "")
+        puts key.ljust(max_key_size) + "  " + items_data[key][2] +
+          "  " + items_data[key][3].rjust(12) +
+          "  " + locked
+      end
+    else
+      multicolumn_print(names.sort)
+    end
     # Restore CWURL
     WebDAV.cd(tmp_cwurl)
   end
@@ -58,15 +94,22 @@ class LsCLI
       end
       options[:longFormat] = false
-      opts.on( '-l', "List in long format" ) do
+      opts.on( '-l', '--long',"List in long format" ) do
         options[:longFormat] = true
       end
       options[:showUrl] = false
-      opts.on('-a', "Include full url in names.") do
+      opts.on('-u', '--url',"Include full url in names.") do
         options[:showUrl] = true
       end
+      options[:oneColumn] = false
+      opts.on( '-1', "Force output to be one entry per line" ) do
+        options[:oneColumn] = true
+      end
     end
     begin
@@ -80,6 +123,43 @@ class LsCLI
     return options
   end
+  # Used to make adjust to number of columns to terminal size
+  # when printing names of files and folders
+  def self.terminal_size
+    `stty size`.split.map { |x| x.to_i }.reverse
+  end
+  def self.max_string_size(string_array)
+    return string_array.max  {|a,b| a.length <=> b.length }.size
+  end
+  # Spread output across multiple columns like unix ls does.
+  def self.multicolumn_print(files)
+    if(files.size == 0)
+      return
+    end
+    terminal_width, terminal_height = terminal_size()
+    max_filename_size = max_string_size(files)
+    columns = terminal_width / max_filename_size
+    column_width = max_filename_size + 2
+    row_size = (files.size.to_f / columns.to_f).ceil
+    row_size.times do |row_number|
+      columns.times do |column_number|
+        filename = files[row_number+(column_number*row_size)].to_s + ""
+        if(column_number == columns - 1)then
+          print filename
+        else
+          print filename.ljust(column_width)
+        end
+      end
+      print "\n"
+    end
+  end
 end
 # Make this file an executable script

data/lib/davclient/dav-put.rb CHANGED Viewed

@@ -1,10 +1,4 @@
-# WebDav put command line utility
-# Synopsis:
-#       dav put [options][url]
-#
-# or standalone:
-#
-#     ruby dav-ls  [options][url]
+# Implementation of the 'dav-put' command line utility.
 require 'rubygems'
 require 'davclient'
@@ -13,40 +7,112 @@ require 'optparse'
 class PutCLI
   def self.put(args)
     options = read_options(args)
     url = args[0]
     if(options[:string])then
+      # Put string
+      if(!url.match(/^http.*\/\/([^\/]*)/) and !WebDAV.CWURL)
+        raise "Error: No current working url set. Use '#{$0} cd url' to set url."
+      end
       begin
         WebDAV.put_string(url,options[:string])
       rescue
         puts $0 + ": " + $!
       end
-      puts "Published content to " + url
+      puts "Published content to: " + url
     else
-      puts "PUT file not implemented"
+      # Put files(s)
+      #  puts "DEBUG: size:" + args.size.to_s
+      if(args.size == 1 )
+        local_file = args[0]
+        if(not(File.exists?(local_file)))
+          raise "File not found: #{local_file}"
+        end
+        if(!WebDAV.CWURL)
+          raise "Error: No current working url set. Use '#{$0} cd url' to set url."
+        end
+        WebDAV.put(WebDAV.CWURL, local_file)
+      elsif(args.size == 2 and args[1].match(/^http.*\/\/([^\/]*)/) )
+        local_file = args[0]
+        url = args[1]
+        if(not(File.exists?(local_file)))
+          raise "File not found: #{local_file}"
+        end
+        if(WebDAV.isCollection?(url))
+          url += File.basename(local_file)
+        end
+        WebDAV.put(url, local_file)
+      else
+        # Put more than one file
+        if(args.last.match(/^http.*\/\/([^\/]*)/) )
+           url = args.last
+           if(!WebDAV.isCollection?(url))
+             raise "Destination collection not found: " + url
+           end
+           args = args[0..(args.size-2)]
+        else
+          url = WebDAV.CWURL
+        end
+        count = 0
+        args.each do | arg|
+          # puts "arg:" + arg
+          if(File.ftype(arg) == 'directory')
+            raise "Upload directories not implemented"
+          end
+          if(File.exists?(arg))
+            basename = File.basename(arg)
+            WebDAV.put(url + basename, arg)
+            count = count + 1
+          else
+            raise "Error: File not found " + arg
+          end
+        end
+        puts "Published #{count} files to #{url}"
+      end
     end
   end
   private
-  def self.usage()
-    puts "Usage: #{$0} put --string \"<html>..</html>\" url"
-  end
   def self.read_options(args)
     options = {}
     optparse = OptionParser.new do|opts|
-      opts.banner = "Usage: #{$0} put [options] url"
+      opts.banner = "Usage: #{$0} put [options] [filelist][url]"
       opts.on( '-h', '--help', 'Display this screen' ) do
         puts opts
+        puts
+        puts "Upload local file or files to server."
+        puts
+        puts "Examples:"
+        puts
+        puts "       #{$0} put local_file"
+        puts "       #{$0} put local_filename https://dav.org/remote_filename"
+        puts "       #{$0} put *.html https://dav.org/remote_collection/"
+        puts "       #{$0} put --string \"Hello world\" hello_world.html"
+        puts
         exit
       end
       options[:string] = false
-      opts.on( '-s', '--string', "Put contents of string" ) do |str |
+      opts.on( '-s', '--string STRING', "Put contents of string" ) do |str |
         options[:string] = str
       end

data/lib/davclient/davcli.rb CHANGED Viewed

@@ -2,21 +2,93 @@ require 'davclient/dav-ls'
 require 'davclient/dav-put'
 require 'davclient/dav-propfind'
-# Handle the 'dav' command line commands
+# DavClient Command Line Utility
 class DavCLI
+  def self.print_edit_usage
+    puts "Usage: #{$0} edit [url|resource-name]"
+    puts
+    puts "Edit remote file in editor. File is transfered back to "
+    puts "server after execution of editor is ended. "
+    puts
+  end
+  def self.edit(args)
+    if(show_help?(args))
+      print_edit_usage
+    else
+      if(args.size == 1)
+        url = args[0]
+        content = WebDAV.get(url)
+        tmp_filename = WebDAV.tmp_folder + File.basename(url)
+        File.open(tmp_filename, 'w') {|f| f.write(content) }
+        system("emacs --quick -nw " + tmp_filename)
+        new_content = nil
+        File.open(tmp_filename, 'r') {|f| new_content = f.read() }
+        WebDAV.put_string(url, new_content)
+      else
+        puts "Illegal arguments: " + args[1..100].join(" ")
+        print_edit_usage
+      end
+    end
+  end
+  # TODO
+  #  - Handle glob (ie *.gif) => Tell user to quote to avoid shell glob: dav get "*.html"
+  def self.get(args)
+    puts "DEBUG:"
+    if(args.size == 1 or args.size == 2 )
+      url = args[0]
+      content =  WebDAV.get(url)
+      filename = ""
+      if(args.size == 1)
+        filename = File.basename(url)
+      else
+        # Handle relative paths in local filenames or local dir
+        path = Pathname.new(Pathname.pwd)
+        path = path + args[1]
+        filename = path.to_s
+        if(args[1] =~ /\/$/ or args[1] =~ /\.$/)
+          path = path + filename = filename + "/" + File.basename(url)
+        end
+      end
+      File.open(filename, 'w') {|f| f.write(content) }
+    else
+      puts "Illegal arguments: " + args[1..100].join(" ")
+      puts "#{$0}: usage '#{$0} get remote-url [local]"
+    end
+  end
   def self.cat(args)
+    if(show_help?(args))
+      puts "Usage: #{$0} cat [url|filename]"
+      puts
+      puts "Concatenate and print remote files to local terminal."
+    end
     if(args.size == 1)
       url = args[0]
       puts WebDAV.get(url)
     else
       puts "Illegal arguments: " + args[1..100].join(" ")
-      puts "#{$0}: usage '#{$0} cat [url|filename]"
+      puts "Usage: #{$0} cat [url|filename]"
     end
   end
+  def self.show_help?(args)
+    return (args.grep("-?").size > 0 or
+            args.grep("-h").size > 0 or
+            args.grep("--help").size > 0 )
+  end
   def self.pwd(args)
+    if(show_help?(args))
+      puts "Usage: #{$0} pwd"
+      puts ""
+      puts "Print current working url."
+      exit
+    end
     cwurl = WebDAV.CWURL
     if(cwurl)
       puts cwurl
@@ -27,6 +99,17 @@ class DavCLI
   end
   def self.cd(args)
+    if(show_help?(args))
+      puts "Usage: #{$0} cd [url|remote-path]"
+      puts
+      puts "Change current working working url."
+      puts
+      puts "Examples: "
+      puts "     #{$0} cd https://www.webdav.org/"
+      puts "     #{$0} cd ../test"
+      puts
+      exit
+    end
     url = args[0]
     if(url == nil)then
       puts "#{$0} cd: Missing mandatory url."
@@ -41,27 +124,47 @@ class DavCLI
   end
   def self.mkcol(args)
+    if(show_help?(args))
+      puts "Usage: #{$0} mkcol [url|remote-path]"
+      puts
+      puts "Create collection (folder) on remote server."
+      puts "The command 'mkdir' is an alias for 'mkcol'."
+      puts
+      puts "Examples: "
+      puts "     #{$0} mkcol new_collection"
+      puts "     #{$0} mkcol https://www.webdav.org/new_collection/"
+      puts "     #{$0} mkcol ../new_collection"
+      puts
+      exit
+    end
     if(args.size == 1 )
-      WebDAV.mkcol(args[0])
+      if( args[0] =~ /^http/ || WebDAV.CWURL )
+        WebDAV.mkcol(args[0])
+      else
+        puts "Error: #{$0} mkcol: No working url set. Use '#{$0} cd url' to set url."
+      end
     else
-      puts "#{$0}: usage '#{$0} mkcol url|path"
+      puts "#{$0}: usage '#{$0} mkcol [url|path]"
     end
   end
   def self.delete(args)
-    if(args.size == 1)
-      url = WebDAV.delete(args[0])
-      puts "#{$0} delete: Deleted '#{url}'"
+    if(show_help?(args) or args.size != 1)
+      puts "Usage: #{$0} delete [url|path]"
+      puts
+      puts "Delete remote collection (folder) or file."
     else
-      puts "#{$0}: usage '#{$0} delete url|path"
+      url = WebDAV.delete(args[0])
     end
   end
   def self.options(args)
-    if(args.size == 0 or args.size == 1)
+    if((args.size == 0 or args.size == 1) and !show_help?(args))
       puts WebDAV.options(args[0])
     else
-      puts "#{$0}: usage '#{$0} options [url]"
+      puts "Usage: #{$0} options [url]"
+      puts
+      puts "Prints remote server options and http headers. "
     end
   end
@@ -77,7 +180,9 @@ class DavCLI
     if(args.size == 2 )
       WebDAV.cp(args[0], args[1])
     else
-      puts "#{$0}: usage '#{$0} cp src dest"
+      puts "Usage '#{$0} cp src dest"
+      puts
+      puts "Copy resources on remote server."
     end
   end
@@ -86,7 +191,9 @@ class DavCLI
     if(args.size == 2 )
       WebDAV.mv(args[0], args[1])
     else
-      puts "#{$0}: usage '#{$0} copy mv dest"
+      puts "Usage '#{$0} copy mv dest"
+      puts
+      puts "Move resources on remote server."
     end
   end
@@ -101,9 +208,13 @@ class DavCLI
     puts "   mv        Move resource"
     puts "   rm        Remove resource"
     puts "   cat       Print content of resource"
+    puts "   mkdir     Create remote collection (directory) (mkcol alias)"
+    puts "   get       Download resource"
+    puts "   put       Upload local file"
     puts "   propfind  Print webdav properties for url"
     puts "   mkcol     Make collection"
     puts "   options   Display webservers WebDAV options"
+    puts "   edit      Edit contents of remote file with editor"
     puts ""
     puts "See '#{$0} COMMAND -h' for more information on a specific command."
     exit
@@ -115,7 +226,7 @@ class DavCLI
     command =  args[0]
-    if(command == "-h" or command =~ /help/ or command =~ /\?/) then
+    if(args.size == 0 or command == "-h" or command =~ /help/ or command =~ /\?/) then
       print_dav_usage
     end
@@ -126,6 +237,12 @@ class DavCLI
     args = args[1..100]
     case command
+      when "put" then
+        PutCLI.put(args)
+      when "get" then
+        get(args)
+      when "edit" then
+        edit(args)
       when "cat" then
         cat(args)
       when "ls" then

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: davclient
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Thomas Flemming
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2009-09-11 00:00:00 +02:00
+date: 2009-09-18 00:00:00 +02:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency