fernyb_davclient 0.0.9

data/lib/davclient/curl_commands.rb

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+
+#
+# Templates for curl commands
+#
+
+# Used to improve readability of curl commands that always
+# needs to be on one line
+def remove_newlines(string)
+  string.gsub("\n","").gsub(/ +/," ") + " "
+end
+
+# Templates for curl commands:
+curl_propfind_cmd = <<EOF
+  --request PROPFIND
+  --max-redirs 1
+  --header 'Content-Type: text/xml; charset="utf-8"'
+  --header "Depth: 1"
+  --data-ascii '<?xml version="1.0" encoding="utf-8"?>
+      <DAV:propfind xmlns:DAV="DAV:"><DAV:allprop/></DAV:propfind>'
+EOF
+CURL_PROPFIND = remove_newlines(curl_propfind_cmd)
+
+curl_proppatch_cmd = <<EOF
+  --request PROPPATCH
+  --header 'Content-Type: text/xml; charset="utf-8"'
+  --header "Depth: 1"
+  --data-ascii '<?xml version="1.0"?>
+      <d:propertyupdate xmlns:d="DAV:" xmlns:v="vrtx">
+        <d:set>
+          <d:prop>
+            <!--property-and-value-->
+          </d:prop>
+        </d:set>
+      </d:propertyupdate>'
+EOF
+CURL_PROPPATCH = remove_newlines(curl_proppatch_cmd)
+
+curl_delete_cmd = <<EOF
+  --request DELETE
+  --header 'Content-Type: text/xml; charset="utf-8"'
+EOF
+CURL_DELETE = remove_newlines(curl_delete_cmd)
+
+curl_mkcol_cmd = <<EOF
+  --request MKCOL
+  --header 'Content-Type: text/xml; charset="utf-8"'
+EOF
+CURL_MKCOL = remove_newlines(curl_mkcol_cmd)
+
+CURL_OPTIONS = "-i -X OPTIONS "
+
+curl_copy = <<EOF
+  --request COPY
+  --header 'Content-Type: text/xml; charset="utf-8"'
+  --header 'Destination: <!--destination-->'
+EOF
+
+CURL_COPY  = remove_newlines(curl_copy)
+
+
+curl_move = <<EOF
+  --request MOVE
+  --header 'Content-Type: text/xml; charset="utf-8"'
+  --header 'Destination: <!--destination-->'
+EOF
+
+CURL_MOVE  = remove_newlines(curl_move)
+
+CURL_UPLOAD = "--upload-file"

data/lib/davclient/dav-ls.rb

@@ -0,0 +1,168 @@
+# WebDav ls command line utility
+# Synopsis:
+#       dav ls [options][url]
+#
+# or standalone:
+#
+#     ruby dav-ls  [options][url]
+
+# require 'rubygems'
+require 'davclient'
+require 'optparse'
+
+class LsCLI
+
+  def self.ls(args)
+    options = read_options(args)
+    url = args[0]
+    tmp_cwurl = WebDAV.CWURL
+    if(not url)then
+      url = WebDAV.CWURL
+      if(not url)then
+        puts "#{$0} ls: no current working url"
+        puts "Usage: Use '#{$0} cd [url|dir] to set current working url"
+        exit
+      end
+    else
+      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
+        # 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
+
+  private
+
+  def self.read_options(args)
+    options = {}
+
+    optparse = OptionParser.new do|opts|
+      opts.banner = "Usage: #{$0} ls [options] url"
+
+      opts.on( '-h', '--help', 'Display this screen' ) do
+        puts opts
+        exit
+      end
+
+      options[:longFormat] = false
+      opts.on( '-l', '--long',"List in long format" ) do
+        options[:longFormat] = true
+      end
+
+      options[:showUrl] = false
+      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
+      optparse.parse! args
+    rescue
+      puts "Error: " + $!
+      puts optparse
+      exit
+    end
+
+    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
+if $0 == __FILE__
+  LsCLI.ls(ARGV)
+end

data/lib/davclient/dav-propfind.rb

@@ -0,0 +1,92 @@
+# Handle 'dav propfind [URL]' command
+require 'rubygems'
+require 'davclient'
+require 'optparse'
+
+class PropfindCLI
+
+  def self.propfind(args)
+    options = read_options(args)
+
+    url = args[0]
+    if(not(url)) then
+      url = WebDAV.CWURL
+    end
+
+    if(not(url)) then
+      puts "Error: Missing mandatory url"
+      puts optparse
+      exit
+    end
+
+    if(options[:xml])then
+      puts WebDAV.propfind(url, :xml => true)
+    else
+
+      # TODO This is experimental code in desperat need
+      # of love and attention
+      item = WebDAV.propfind(url)
+      puts item.collection
+
+      prev_url = nil
+      WebDAV.find(url, :children => options[:children]) do | url, item |
+        if(prev_url != url) then
+          puts
+          puts "url = " + url.to_s
+          prev_url = url
+        end
+
+        name = item.prefix
+        if(item.namespace)then
+          name = name + "(" + item.namespace + ")"
+        end
+        name = name + item.name
+        puts name.ljust(40) + " = '" + item.text.to_s + "'"
+      end
+
+    end
+
+  end
+
+  private
+
+  def self.read_options(args)
+    options = {}
+
+    title = nil
+    optparse = OptionParser.new do|opts|
+      opts.banner = "Usage: #{$0} propfind [options] url"
+
+      opts.on( '-h', '--help', 'Display this screen' ) do
+        puts opts
+        exit
+      end
+
+      options[:xml] = true
+      opts.on( '-p', '--pretty', "Pretty print output instead of returning xml" ) do
+        options[:xml] = false
+      end
+
+      options[:children] = false
+      opts.on('-c', '--children', "Show children if viewing collection (folder)") do
+        options[:children] = true
+      end
+
+    end
+
+    begin
+      optparse.parse!
+    rescue
+      puts "Error: " + $!
+      puts optparse
+      exit
+    end
+
+    return options
+  end
+
+end
+
+if $0 == __FILE__
+  PropfindCLI.propfind(ARGV)
+end

data/lib/davclient/dav-put.rb

@@ -0,0 +1,137 @@
+# Implementation of the 'dav-put' command line utility.
+
+require 'rubygems'
+require 'davclient'
+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
+    else
+
+      # 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.read_options(args)
+    options = {}
+
+    optparse = OptionParser.new do|opts|
+      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 STRING', "Put contents of string" ) do |str |
+        options[:string] = str
+      end
+
+    end
+
+    begin
+      optparse.parse! args
+    rescue
+      puts "Error: " + $!
+      puts optparse
+      exit
+    end
+
+    return options
+  end
+
+end
+
+# Make this file an executable script
+if $0 == __FILE__
+  PutCLI.put(ARGV)
+end