fernyb_davclient 0.0.9

data/lib/davclient/davcli.rb

@@ -0,0 +1,286 @@
+require 'davclient/dav-ls'
+require 'davclient/dav-put'
+require 'davclient/dav-propfind'
+
+# 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 "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
+    else
+      puts "#{$0}: No working url set. Use 'dav cd url' to set url"
+    end
+
+  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."
+      exit
+    end
+    begin
+      WebDAV.cd(url)
+      puts "Changing WebDAV URL to: " + WebDAV.CWURL
+    rescue Exception => exception
+      puts exception
+    end
+  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 )
+      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]"
+    end
+  end
+
+  def self.delete(args)
+    if(show_help?(args) or args.size != 1)
+      puts "Usage: #{$0} delete [url|path]"
+      puts
+      puts "Delete remote collection (folder) or file."
+    else
+      url = WebDAV.delete(args[0])
+    end
+  end
+
+  def self.options(args)
+    if((args.size == 0 or args.size == 1) and !show_help?(args))
+      puts WebDAV.options(args[0])
+    else
+      puts "Usage: #{$0} options [url]"
+      puts
+      puts "Prints remote server options and http headers. "
+    end
+  end
+
+  def self.propfind(args)
+    PropfindCLI.propfind(args)
+  end
+
+  def self.ls(args)
+    LsCLI.ls(args)
+  end
+
+  def self.cp(args)
+    if(args.size == 2 )
+      WebDAV.cp(args[0], args[1])
+    else
+      puts "Usage '#{$0} cp src dest"
+      puts
+      puts "Copy resources on remote server."
+    end
+  end
+
+
+  def self.mv(args)
+    if(args.size == 2 )
+      WebDAV.mv(args[0], args[1])
+    else
+      puts "Usage '#{$0} copy mv dest"
+      puts
+      puts "Move resources on remote server."
+    end
+  end
+
+  def self.print_dav_usage
+    puts "usage: #{$0} COMMAND [ARGS]"
+    puts ""
+    puts "Available #{$0} commands:"
+    puts "   ls        List files on webdav server"
+    puts "   pwd       Print current working url"
+    puts "   cd        Change current working url"
+    puts "   cp        Copy resource"
+    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
+  end
+
+  def self.dav(args)
+
+    $0 = $0.sub(/.*\//,"").sub(/.rb$/,"")
+
+    command =  args[0]
+
+    if(args.size == 0 or command == "-h" or command =~ /help/ or command =~ /\?/) then
+      print_dav_usage
+    end
+
+    if(command == "-v" or command =~ /version/ ) then
+      puts "#{$0} version " + WebDAV.version
+      exit
+    end
+
+    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
+        LsCLI.ls(args)
+      when "pwd"
+        pwd(args)
+      when "cd"
+        cd(args)
+      when "cp"
+        cp(args)
+      when "copy"
+        cp(args)
+      when "mv"
+        mv(args)
+      when "move"
+        mv(args)
+      when "mkcol"
+         mkcol(args)
+      when "mkdir"
+         mkcol(args)
+      when "put"
+         PutCLI.put(args)
+      when "delete"
+        delete(args)
+      when "del"
+        delete(args)
+      when "rm"
+        delete(args)
+      when "propfind"
+        propfind(args)
+      when "props"
+        propfind(args)
+      when "options"
+        options(args)
+      else
+        puts "Unknown command :'" + command + "'"
+        print_dav_usage
+      end
+  end
+
+end

data/lib/davclient/hpricot_extensions.rb

@@ -0,0 +1,149 @@
+# -*- coding: utf-8 -*-
+# require 'rubygems'
+require 'hpricot'
+require 'davclient'
+require 'davclient/hpricot_extensions'
+
+# Extensions to the Hpricot XML parser.
+module Hpricot
+
+  class Elem
+
+    # Makes properties available as simple method calls.
+    #
+    # Example:
+    #    print item.creationdate()
+    def method_missing(method_name, *args)
+      if(args.size == 0) then
+        return property(method_name.to_s)
+      end
+      raise "Method missing"
+    end
+
+    # Resource url
+    def href()
+      self.at("d:href").innerText
+    end
+
+    # Returns true of resource is a collection, i.e. a folder and not a file.
+    def isCollection?()
+      self.at("d:collection") != nil
+    end
+
+  end
+
+
+  # Get content from resources on server
+  # Example:
+  #    webpage = WebDAV.find("http://example.org/index.html")
+  #    print "html src: " + page.content
+  def content
+    if(!isCollection?)
+      WebDAV.get(self.at("d:href").innerText)
+    end
+  end
+
+  def content=(string)
+    if(!isCollection?)
+      WebDAV.put_string(href,string)
+    end
+  end
+
+  # Get property for resource or collection.
+  # Example:
+  #    page = WebDAV.find(url)
+  #    print page.property("published-date")
+  def property(name)
+
+    # TODO: Make list of recognized namespace prefixes configurable
+
+    property = property = self.at(name)
+    if(property)then
+      returnValue = property.innerText
+      return returnValue
+    end
+
+    property = property = self.at(name.downcase)
+    if(property)then
+      return property.innerText
+    end
+
+    vrtx_property = self.at("v:" + name)
+    if(vrtx_property)then
+      return vrtx_property.innerText
+    end
+
+    vrtx_property = self.at("v:" + name.downcase)
+    if(vrtx_property)then
+      return vrtx_property.innerText
+    end
+
+    dav_property = self.at("d:" +name)
+    if( dav_property)then
+      return dav_property.innerText
+    end
+
+    dav_property = self.at("d:" +name.downcase)
+    if( dav_property)then
+      return dav_property.innerText
+    end
+
+    return nil
+  end
+
+  def basename
+    File.basename(self.at("d:href").innerText)
+  end
+
+
+  # Set the items WebDAV properties. Properties must be a string with XML.
+  # Example:
+  #
+  #    find(url) do |item|
+  #       if(item.href =~ /html$/) then
+  #         item.proppatch("<d:getcontenttype>text/html</d:getcontenttype>")
+  #       end
+  #    end
+  def proppatch(properties)
+    WebDAV.proppatch(href, properties)
+  end
+
+  # :stopdoc:
+
+  # TODO: Move to vortex_lib.rb
+  def dateProperty(name)
+    date = self.property(name)
+    if(date =~ /\dZ$/)then
+      # Fix for bug in vortex:
+      #
+      # Some date properties are in xmlshcema datetime format, but
+      # all tough the time seems to be localtime the timezone is
+      # specified as Z not CEST. Fix is to set timezone and add
+      # 2 hours.
+      date = date.gsub(/\dZ$/," CEST")
+      time = Time.parse(date)
+      time = time + (60 * 60 * 2)
+      return time
+    end
+    time = Time.parse(date)
+    return time
+  end
+
+
+  # TODO Not used. Delete???
+  def type_convert_value(value)
+    if(returnValue == "true")then
+      return true
+    end
+    if(returnValue == "false")then
+      return false
+    end
+    # Number format???
+    ## Dato format
+    return returnValue
+  end
+
+
+  # :startdoc:
+
+end

data/lib/davclient/simple.rb

@@ -0,0 +1,44 @@
+# A minimalistic API for interacting with WebDAV servers.
+#
+# If commands needs to Simple WebDAV API for use in scripts where namespacing is not necessary.
+
+# :stopdoc:
+
+require 'davclient'
+require 'davclient/dav-ls'
+
+# :startdoc:
+
+# Change working directory.
+#
+# Examples:
+#
+#    require 'davclient/simple'
+#
+#    cd("https://example.webdav.org/collection/")
+#    content = get("index.html")
+#    print content
+def cd(args)
+  WebDAV.cd(args)
+end
+
+def pwd
+  WebDAV.CWURL
+end
+
+def find(*args, &block)
+  WebDAV.find(*args, &block)
+end
+
+def ls(*args)
+  if(args == [])
+    LsCLI.ls([WebDAV.CWURL])
+  else
+    LsCLI.ls(*args)
+  end
+end
+
+def get(args)
+  WebDAV.get(args)
+end
+