ruby-managesieve 0.1.0 → 0.2.0

data/bin/sievectl

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 #
-# Copyright (c) 2004 Andre Nathan <andre@digirati.com.br>
+#--
+# Copyright (c) 2004, 2005 Andre Nathan <andre@digirati.com.br>
 #
 # Permission to use, copy, modify, and distribute this software for any
 # purpose with or without fee is hereby granted, provided that the above
@@ -13,8 +14,69 @@
 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#++
 #
-# $Id: sievectl,v 1.1.1.1 2004/12/20 17:49:51 andre Exp $
+# = Overview
+#
+# Sievectl is a utility that allows for management of
+# Sieve[http://www.cyrusoft.com/sieve/] scripts from the command line. It
+# supports multiple accounts, configured in the .sievectlrc file located in
+# the user's home directory.
+#
+# == Configuration file example
+#
+#  accountA:
+#    host:     sieve.accounta.tld
+#    port:     2000
+#    user:     johndoe
+#    euser:    johndoe
+#    password: secret
+#    auth:     PLAIN
+#
+#  accountB:
+#    host:     mail.accountb.tld
+#    user:     john
+#    password: secret
+#    auth:     PLAIN
+#
+# The +port+ and +euser+ parameters can be ommited, and will respectively
+# default to 2000 and the value of the +user+ parameter. If the +auth+
+# parameter is ommited, it will default to +ANONYMOUS+.
+#
+# == Usage and examples
+#
+#  $ sievectl help
+#  Usage: sievectl <account> <action> [script name]
+#  Action is one of:
+#    capabilities, list, show, activate, deactivate, add, addactive, delete
+#  
+#  Short forms for some actions are also accepted:
+#    caps (capabilities), act (activate), deact (deactivate), addact (addactive),
+#    del (delete)
+#  
+#    Examples:
+#      List server capabilities:
+#        sievectl caps
+#  
+#      List available scripts:
+#        sievectl list
+#  
+#      Show contents of a script:
+#        sievectl show scriptname
+#  
+#      Add a script:
+#        sievectl add scriptname script.txt
+#        or
+#        sievectl add scriptname < script.txt
+#        or
+#        cat script.txt | sievectl add scriptname
+#  
+#      Delete a script:
+#        sievectl del scriptname
+#
+#--
+# $Id: sievectl,v 1.15 2005/01/21 14:45:30 andre Exp $
+#++
 #
 
 begin
@@ -26,18 +88,18 @@ end
 require 'managesieve'
 require 'yaml'
 
-class ManageSieve
+class ManageSieve # :nodoc:
   def print_capabilities
     puts 'Capabilities:'
-    @capabilities.each { |cap| puts "  - #{cap}" }
+    @capabilities.sort.each { |cap| puts "  - #{cap}" }
 
     puts 'Login Mechanisms:'
-    @login_mechs.each { |mech| puts "  - #{mech}" }
+    @login_mechs.sort.each { |mech| puts "  - #{mech}" }
   end
 
   def print_scripts
     puts 'Available scripts:'
-    each_script do |name, active|
+    scripts.sort.each do |name, active|
       print "  - #{name}"
       print active ? " (active)\n" : "\n"
     end
@@ -49,25 +111,124 @@ class ManageSieve
   end
 end
 
-class ConfigFile < File
-  def ConfigFile.open(*args)
-    file = super(*args)
-    conf = YAML::load(file)
-    file.close
-    return conf
+class TemplateError # :nodoc:
+end
+
+class ConfigFile < File # :nodoc:
+  def ConfigFile.open(name)
+    begin
+      file = super(name)
+      conf = YAML::load(file)
+      file.close
+      return conf
+    rescue Errno::ENOENT
+      ConfigFile::create_template(name)
+      exit 0
+    end
+  end
+
+  private
+  def ConfigFile.create_template(name)
+    STDERR.puts <<-__EOF__
+* Could not find configuration file #{name}.
+* A template file will be created. Please edit the values to fit your
+* local configuration and run `#{File::basename $0}' again.
+    __EOF__
+
+    begin
+      file = File::open(name, 'w+')
+      file.puts <<-__EOF__
+accountname:
+  host:     servername
+  port:     port
+  user:     username
+  euser:    effectiveusername
+  password: password
+  auth:     authmethod
+      __EOF__
+    rescue => e
+      raise TemplateError, e
+    end
   end
 end
 
-def usage
-  STDERR.puts <<__EOF__
-Usage: #{File::basename($0)} <caps|list|show|activate|add|addactive|del> [script name]
-__EOF__
+#
+# The SieveCtl class is a simple set of wrapper methods around the ones
+# available on the #ManageSieve class.
+#
+class SieveCtl
+  def initialize(conf)
+    @manage_sieve = ManageSieve.new(conf)
+  end
+
+  # Prints the server capabilities.
+  def capabilities
+    @manage_sieve.print_capabilities
+  end
+
+  # Lists the available scripts, specifying which one is active.
+  def list
+    @manage_sieve.print_scripts
+  end
+
+  # Shows the contents of +script+.
+  def show(script)
+    raise ArgumentError, "`show' requires a script name" unless script
+    puts @manage_sieve.get_script(script)
+  end
+
+  # Activates +script+.
+  def activate(script)
+    raise ArgumentError, "`activate' requires a script name" unless script
+    @manage_sieve.set_active(script)
+  end
+
+  # Deactivates +script+. There is no +DEACTIVATE+ command in the MANAGESIEVE
+  # draft, so we fetch the script, remove it and upload it again.
+  def deactivate(script)
+    raise ArgumentError, "`deactivate' requires a script name" unless script
+    data = @manage_sieve.get_script(script)
+    @manage_sieve.delete_script(script)
+    @manage_sieve.put_script(script, data)
+  end
+
+  # Adds a script named +script+, from file +file+. If +file+ is +nil+, read
+  # the script from +STDIN+. Activates the script is +active+ is true.
+  def add(script, file=nil, active=false)
+    action = "add#{active ? 'active' : ''}"
+    raise ArgumentError, "`#{action}' requires a script name" unless script
+    data = file ? File.open(file).readlines : STDIN.readlines
+    @manage_sieve.put_script(script, data.to_s)
+    activate script if active
+  end
+
+  # Deletes +script+
+  def delete(script)
+    raise ArgumentError, "`activate' requires a script name" unless script
+    @manage_sieve.delete_script(script)
+  end
+end
+
+def usage(quit=true) # :nodoc: #
+  prog = File::basename $0
+  STDERR.puts <<-__EOF__
+Usage: #{prog} <account> <action> [script name]
+Action is one of:
+  capabilities, list, show, activate, deactivate, add, addactive, delete
+
+You can also try `#{prog} help' for usage examples.
+  __EOF__
+  exit 1 if quit
 end
 
-def help
+def help # :nodoc:
   prog = File::basename $0
-  puts <<__EOF__
-Usage: #{prog} <caps|list|show|activate|add|addactive|del> [script name]
+  usage(false)
+  puts <<-__EOF__
+
+Short forms for some actions are also accepted:
+  caps (capabilities), act (activate), deact (deactivate), addact (addactive),
+  del (delete)
 
 Examples:
   List server capabilities:
@@ -82,11 +243,14 @@ Examples:
   Add a script:
     #{prog} add scriptname script.txt
     or
+    #{prog} add scriptname < script.txt
+    or
     cat script.txt | #{prog} add scriptname
 
   Delete a script:
     #{prog} del scriptname
-__EOF__
+  __EOF__
+  exit 0
 end
 
 
@@ -94,44 +258,61 @@ end
 # Main
 #
 
-conf = ConfigFile::open(ENV['HOME'] + '/.sievectlrc')
+help if ARGV[0] =~ /^h(elp)?$/i
+
+account, action, name, file = ARGV
+usage if action.nil?
+
+begin
+  conf = ConfigFile::open(ENV['HOME'] + '/.sievectlrc')
+rescue TemplateError => e
+  STDERR.puts "Cannot create template configuration file: #{e}"
+  exit 1
+rescue => e
+  STDERR.puts "Cannot load configuration file: `#{e}'"
+  exit 1
+end
 
-m = ManageSieve.new(
-  :host     => conf['host'],
-  :port     => conf['port'],
-  :user     => conf['user'],
-  :euser    => conf['euser'],
-  :password => conf['password'],
-  :auth     => conf['auth']
+unless conf.has_key? account
+  STDERR.puts <<-__EOF__
+* Configuration for account `#{account}' not found.
+* Maybe your configuration file is in the old format?
+  __EOF__
+  exit 1
+end
+
+info = conf[account]
+
+sievectl = SieveCtl.new(
+  :host     => info['host'],
+  :port     => info['port'],
+  :user     => info['user'],
+  :euser    => info['euser'],
+  :password => info['password'],
+  :auth     => info['auth']
 )
 
-action, name, file = ARGV
-
-case action
-when /^cap(abilitie)?s$/
-  m.print_capabilities
-when /^list$/
-  m.print_scripts
-when /^show$/
-  raise ArgumentError, "`show' requires a script name" unless name
-  puts m.get_script(name)
-when /^act(ivate)?$/
-  raise ArgumentError, "`activate' requires a script name" unless name
-  m.set_active(name)
-when /^add$/
-  raise ArgumentError, "`add' requires a script name" unless name
-  script = file ? File.open(file).readlines : STDIN.readlines
-  m.put_script(name, script.to_s)
-when /^addact(ive)?/
-  raise ArgumentError, "`add' requires a script name" unless name
-  script = file ? File.open(file).readlines : STDIN.readlines
-  m.put_script(name, script.to_s)
-  m.set_active(name)
-when /^del(ete)?$/
-  raise ArgumentError, "`activate' requires a script name" unless name
-  m.delete_script(name)
-when /^h(elp)?$/
-  help
-else
-  usage
+begin
+  case action
+  when /^act(ivate)?$/
+    sievectl.activate(name)
+  when /^add$/
+    sievectl.add(name, file)
+  when /^addact(ive)?/
+    sievectl.add(name, file, true)
+  when /^cap(abilitie)?s$/
+    sievectl.capabilities
+  when /^deact(ivate)?$/
+    sievectl.deactivate(name)
+  when /^del(ete)?$/
+    sievectl.delete(name)
+  when /^list$/
+    sievectl.list
+  when /^show$/
+    sievectl.show(name)
+  else
+    usage
+  end
+rescue SieveCommandError => e
+  STDERR.puts "* #{e}"
 end

data/lib/managesieve.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 #
 #--
-# Copyright (c) 2004 Andre Nathan <andre@digirati.com.br>
+# Copyright (c) 2004, 2005 Andre Nathan <andre@digirati.com.br>
 #
 # Permission to use, copy, modify, and distribute this software for any
 # purpose with or without fee is hereby granted, provided that the above
@@ -25,13 +25,24 @@
 # See the ManageSieve class for documentation and examples.
 #
 #--
-# $Id: managesieve.rb,v 1.3 2004/12/20 18:34:32 andre Exp $
+# $Id: managesieve.rb,v 1.10 2005/01/17 11:25:56 andre Exp $
 #++
 #
 
 require 'base64'
 require 'socket'
 
+#
+# Define our own Base64.encode64 for compatibility with ruby <= 1.8.1, which
+# defines encode64() at the top level.
+#
+module Base64 # :nodoc:
+  def encode64(s)
+    [s].pack('m')
+  end
+  module_function :encode64
+end
+
 class SieveAuthError < Exception; end
 class SieveCommandError < Exception; end
 class SieveResponseError < Exception; end
@@ -65,7 +76,7 @@ class SieveResponseError < Exception; end
 #  )
 #
 #  # List installed scripts
-#  m.each_script do |name, active|
+#  m.scripts.sort do |name, active|
 #    print name
 #    print active ? " (active)\n" : "\n"
 #  end
@@ -125,17 +136,20 @@ class ManageSieve
   end
 
   
-  # Calls the given block for each script stored on the server, passing
-  # its name and status as parameters. The status is either 'ACTIVE' or
-  # nil.
-  def each_script
+  # If a block is given, calls it for each script stored on the server,
+  # passing its name and status as parameters. Else, and array
+  # of [ +name+, +status+ ] arrays is returned. The status is either
+  # 'ACTIVE' or nil.
+  def scripts
     begin
       scripts = send_command('LISTSCRIPTS')
     rescue SieveCommandError => e
-      raise e, "Cannot list scripts"
+      raise e, "Cannot list scripts: #{e}"
     end
+    return scripts unless block_given?
     scripts.each { |name, status| yield(name, status) }
   end
+  alias :each_script :scripts
 
   # Returns the contents of +script+ as a string.
   def get_script(script)
@@ -144,7 +158,7 @@ class ManageSieve
     rescue SieveCommandError => e
       raise e, "Cannot get script: #{e}"
     end
-    return data.to_s
+    return data.to_s.chomp
   end
 
   # Uploads +script+ to the server, using +data+ as its contents.
@@ -206,15 +220,15 @@ class ManageSieve
   def auth_plain(euser, user, pass) # :nodoc:
     args = [ euser, user, pass ]
     params = sieve_name('PLAIN') + ' '
-    params += sieve_name(encode64(args.join(0.chr)).gsub(/\n/, ''))
+    params += sieve_name(Base64.encode64(args.join(0.chr)).gsub(/\n/, ''))
     send_command('AUTHENTICATE', params)
   end
 
   private
   def auth_login(user, pass) # :nodoc:
     send_command('AUTHENTICATE', sieve_name('LOGIN'), false)
-    send_command(sieve_name(encode64(user)).gsub(/\n/, ''), nil, false)
-    send_command(sieve_name(encode64(pass)).gsub(/\n/, ''))
+    send_command(sieve_name(Base64.encode64(user)).gsub(/\n/, ''), nil, false)
+    send_command(sieve_name(Base64.encode64(pass)).gsub(/\n/, ''))
   end
 
   private
@@ -255,10 +269,19 @@ class ManageSieve
     loop do
       data = get_line
 
-      # server response
-      m = /(OK|NO|BYE)( \((.*)\))?( (.*))?/.match(data)
-      yield :response, m.captures.values_at(0, 3) and next if m
-  
+      # server ok
+      m = /^OK$/.match(data)
+      yield :ok, m.captures.values_at(0, 3) and next if m
+
+      # server error
+      m = /^(NO|BYE)(.*)?$/.match(data)
+      if m
+        err, msg = m.captures
+        size = msg.scan(/\{(\d+)\+?\}/).to_s.to_i
+        yield :error, @socket.read(size.to_i + 2) and next if size > 0
+        yield :error, msg and next
+      end
+
       # quoted text
       m = /"([^"]*)"(\s"?([^"]*)"?)?$/.match(data)
       yield :quoted, m.captures.values_at(0,2) and next if m
@@ -278,10 +301,10 @@ class ManageSieve
     response = []
     parse_each_line do |flag, data|
       case flag
-      when :response
-        type, error = data
-        raise SieveResponseError, error unless type == 'OK'
+      when :ok
         return response
+      when :error
+        raise SieveResponseError, data.strip.gsub(/\r\n/, ' ')
       else
         response << data
       end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.1
 specification_version: 1
 name: ruby-managesieve
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2004-12-20
+  version: 0.2.0
+date: 2005-01-21
 summary: A Ruby library for the MANAGESIEVE protocol
 require_paths: 
   - lib
@@ -12,7 +12,8 @@ author: Andre Nathan
 email: andre@digirati.com.br
 homepage: http://managesieve.rubyforge.org
 rubyforge_project: ruby-managesieve
-description: "ruby-managesieve is a pure-ruby implementation of the MANAGESIEVE protocol, allowing remote management of Sieve scripts from ruby."
+description: "ruby-managesieve is a pure-ruby implementation of the MANAGESIEVE protocol,
+  allowing remote management of Sieve scripts from ruby."
 autorequire: managesieve
 default_executable: 
 bindir: bin