albanpeignier-ruby-managesieve 0.3.1

data/bin/sievectl

@@ -0,0 +1,358 @@
+#!/usr/bin/env ruby
+#
+#--
+# Copyright (c) 2004-2006 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
+# copyright notice and this permission notice appear in all copies.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# 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.
+#++
+#
+# = 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 myaccount caps
+#  
+#      List available scripts:
+#        sievectl myaccount list
+#  
+#      Show contents of a script:
+#        sievectl myaccount show scriptname
+#  
+#      Add a script:
+#        sievectl myaccount add scriptname script.txt
+#        or
+#        sievectl myaccount add scriptname < script.txt
+#        or
+#        cat script.txt | sievectl myaccount add scriptname
+#  
+#      Delete a script:
+#        sievectl myaccount del scriptname
+#
+#--
+# $Id: sievectl,v 1.27 2006/08/30 18:06:21 andre Exp $
+#++
+#
+
+begin
+  require 'rubygems'
+rescue LoadError
+end
+require 'managesieve'
+
+$has_termios = true
+begin
+  require_gem 'termios'
+rescue LoadError
+  begin
+    require 'termios'
+  rescue LoadError
+    $has_termios = false
+  end
+end
+
+require 'yaml'
+
+class ManageSieve # :nodoc:
+  def print_capabilities
+    puts 'Capabilities:'
+    @capabilities.sort.each { |cap| puts "  - #{cap}" }
+
+    puts 'Login Mechanisms:'
+    @login_mechs.sort.each { |mech| puts "  - #{mech}" }
+  end
+
+  def print_scripts
+    puts 'Available scripts:'
+    scripts.sort.each do |name, active|
+      print "  - #{name}"
+      print active ? " (active)\n" : "\n"
+    end
+  end
+
+  def upload_script(name, script, active=false)
+    put_script(name, script)
+    set_active(name)
+  end
+end
+
+class TemplateError < Exception # :nodoc:
+end
+
+class ConfigFile < File # :nodoc:
+  def ConfigFile.open(name)
+    begin
+      conf = nil
+      super(name) do |file|
+        conf = YAML::load(file)
+      end
+      conf.each_key do |acct|
+        conf[acct].each_key { |k| conf[acct][k] = conf[acct][k].to_s }
+      end
+      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.new(name, 'w', 0600)
+      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
+
+#
+# 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.to_s : STDIN.readlines.to_s
+    unless @manage_sieve.have_space?(script, data.length)
+      raise SieveCommandError, "not enough space for script `#{script}' " +
+                               "(#{data.length} bytes)"
+    end
+    @manage_sieve.put_script(script, data)
+    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, out=STDERR) # :nodoc: #
+  prog = File.basename $0
+  out.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 # :nodoc:
+  prog = File::basename $0
+  usage(false, STDOUT)
+  puts <<-__EOF__
+
+Short forms for some actions are also accepted:
+  caps (capabilities), act (activate), deact (deactivate), addact (addactive),
+  del (delete)
+
+Examples:
+  List server capabilities:
+    #{prog} myaccount caps
+
+  List available scripts:
+    #{prog} myaccount list
+
+  Show contents of a script:
+    #{prog} myaccount show scriptname
+
+  Add a script:
+    #{prog} myaccount add scriptname script.txt
+    or
+    #{prog} myaccount add scriptname < script.txt
+    or
+    cat script.txt | #{prog} myaccount add scriptname
+
+  Delete a script:
+    #{prog} myaccount del scriptname
+  __EOF__
+  exit 0
+end
+
+
+#
+# Main
+#
+
+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
+
+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]
+
+if $has_termios and info['password'].nil?
+  oldt = Termios.tcgetattr(STDIN)
+  newt = oldt.dup
+  newt.lflag &= ~Termios::ECHO
+  Termios.tcsetattr(STDIN, Termios::TCSANOW, newt)
+  print 'Password: '
+  info['password'] = STDIN.gets
+  Termios.tcsetattr(STDIN, Termios::TCSANOW, oldt)
+end
+
+if info['password'].nil?
+  STDERR.puts "* Password not given."
+  exit 1
+end
+
+info['password'].chomp!
+
+begin
+  sievectl = SieveCtl.new(
+    :host     => info['host'],
+    :port     => info['port'] || 2000,
+    :user     => info['user'],
+    :euser    => info['euser'] || info['user'],
+    :password => info['password'],
+    :auth     => info['auth']
+  )
+rescue SieveNetworkError => e
+  STDERR.puts "* #{e}"
+  exit 1
+end
+
+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 ArgumentError, SieveCommandError => e
+  STDERR.puts "* sievectl: #{e}"
+end

data/lib/managesieve.rb

@@ -0,0 +1,351 @@
+#!/usr/bin/env ruby
+#
+#--
+# Copyright (c) 2004-2006 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
+# copyright notice and this permission notice appear in all copies.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# 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.
+#++
+#
+# == Overview
+#
+# This library is a pure-ruby implementation of the MANAGESIEVE protocol, as
+# specified in its
+# Draft[http://managesieve.rubyforge.org/draft-martin-managesieve-04.txt].
+#
+# See the ManageSieve class for documentation and examples.
+#
+#--
+# $Id: managesieve.rb,v 1.13 2006/08/30 14:23:58 andre Exp $
+#++
+#
+
+require 'base64'
+require 'socket'
+
+begin
+  require 'openssl'
+rescue LoadError
+end
+
+#
+# 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 SieveNetworkError < Exception; end
+class SieveResponseError < Exception; end
+
+#
+# ManageSieve implements MANAGESIEVE, a protocol for remote management of
+# Sieve[http://www.cyrusoft.com/sieve/] scripts.
+#
+# The following MANAGESIEVE commands are implemented:
+# * CAPABILITY
+# * DELETESCRIPT
+# * GETSCRIPT
+# * HAVESPACE
+# * LISTSCRIPTS
+# * LOGOUT
+# * PUTSCRIPT
+# * SETACTIVE
+#
+# The AUTHENTICATE command is partially implemented. Currently the +LOGIN+
+# and +PLAIN+ authentication mechanisms are implemented.
+#
+# = Example
+#
+#  # Create a new ManageSieve instance
+#  m = ManageSieve.new(
+#    :host     => 'sievehost.mydomain.com',
+#    :port     => 2000,
+#    :user     => 'johndoe',
+#    :password => 'secret',
+#    :auth     => 'PLAIN'
+#  )
+#
+#  # List installed scripts
+#  m.scripts.sort do |name, active|
+#    print name
+#    print active ? " (active)\n" : "\n"
+#  end
+#
+#  script = <<__EOF__
+#  require "fileinto";
+#  if header :contains ["to", "cc"] "ruby-talk@ruby-lang.org" {
+#    fileinto "Ruby-talk";
+#  }
+#  __EOF__
+#
+#  # Test if there's enough space for script 'foobar'
+#  puts m.have_space?('foobar', script.length)
+#
+#  # Upload it
+#  m.put_script('foobar', script)
+#
+#  # Show its contents
+#  puts m.get_script('foobar')
+#
+#  # Close the connection
+#  m.logout
+#
+class ManageSieve
+  SIEVE_PORT = 2000
+
+  attr_reader :host, :port, :user, :euser, :capabilities, :login_mechs, :use_tls
+
+  # Create a new ManageSieve instance. The +info+ parameter is a hash with the
+  # following keys:
+  #
+  # [<i>:host</i>]      the sieve server
+  # [<i>:port</i>]      the sieve port (defaults to 2000)
+  # [<i>:user</i>]      the name of the user
+  # [<i>:euser</i>]     the name of the effective user (defaults to +:user+)
+  # [<i>:password</i>]  the password of the user
+  # [<i>:auth_mech</i>] the authentication mechanism (defaults to +"ANONYMOUS"+)
+  # [<i>:use_tls</i>]    if true, try to use tls when server supports it
+  #
+  def initialize(info)
+    @host      = info[:host]
+    @port      = info[:port] || 2000
+    @user      = info[:user]
+    @euser     = info[:euser] || @user
+    @password  = info[:password]
+    @auth_mech = info[:auth] || 'ANONYMOUS'
+    @use_tls = info[:use_tls] || true
+
+    @capabilities   = []
+    @login_mechs    = []
+    @implementation = ''
+    @supports_tls   = false
+    @socket = TCPSocket.new(@host, @port)
+
+    data = get_response
+    server_features(data)
+
+    starttls if use_tls and supports_tls?
+
+    authenticate
+    @password = nil
+  end
+
+  
+  # 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: #{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)
+    begin
+      data = send_command('GETSCRIPT', sieve_name(script))
+    rescue SieveCommandError => e
+      raise e, "Cannot get script: #{e}"
+    end
+    return data.to_s.chomp
+  end
+
+  # Uploads +script+ to the server, using +data+ as its contents.
+  def put_script(script, data)
+    args = sieve_name(script)
+    args += ' ' + sieve_string(data) if data
+    send_command('PUTSCRIPT', args)
+  end
+
+  # Deletes +script+ from the server.
+  def delete_script(script)
+    send_command('DELETESCRIPT', sieve_name(script))
+  end
+
+  # Sets +script+ as active.
+  def set_active(script)
+    send_command('SETACTIVE', sieve_name(script))
+  end
+
+  # Returns true if there is space on the server to store +script+ with
+  # size +size+ and false otherwise.
+  def have_space?(script, size)
+    begin
+      args = sieve_name(script) + ' ' + size.to_s
+      send_command('HAVESPACE', args)
+      return true
+    rescue SieveCommandError
+      return false
+    end
+  end
+
+  # Returns true if the server supports TLS and false otherwise.
+  def supports_tls?
+    @supports_tls
+  end
+
+  # Disconnect from the server.
+  def logout
+    send_command('LOGOUT')
+    @socket.close
+  end
+
+  private
+  def authenticate # :nodoc:
+    unless @login_mechs.include? @auth_mech
+      raise SieveAuthError, "Server doesn't allow #{@auth_mech} authentication"
+    end
+    case @auth_mech
+    when /PLAIN/i
+      auth_plain(@euser, @user, @password)
+    when /LOGIN/i
+      auth_login(@user, @password)
+    else
+      raise SieveAuthError, "#{@auth_mech} authentication is not implemented"
+    end
+  end
+
+  private
+  def auth_plain(euser, user, pass) # :nodoc:
+    args = [ euser, user, pass ]
+    params = sieve_name('PLAIN') + ' '
+    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(Base64.encode64(user)).gsub(/\n/, ''), nil, false)
+    send_command(sieve_name(Base64.encode64(pass)).gsub(/\n/, ''))
+  end
+
+  private
+  def server_features(lines) # :nodoc:
+    lines.each do |type, data|
+      case type
+      when 'IMPLEMENTATION'
+        @implementation = data
+      when 'SASL'
+        @login_mechs = data.split
+      when 'SIEVE'
+        @capabilities = data.split
+      when 'STARTTLS'
+        @supports_tls = true
+      end
+    end
+  end
+
+  private
+  def get_line # :nodoc:
+    begin
+      return @socket.readline.chomp
+    rescue EOFError => e
+      raise SieveNetworkError, "Network error: #{e}"
+    end
+  end
+
+  private
+  def send_command(cmd, args=nil, wait_response=true) # :nodoc:
+    cmd += ' ' + args if args
+    begin
+      @socket.write(cmd + "\r\n")
+      resp = get_response if wait_response
+    rescue SieveResponseError => e
+      raise SieveCommandError, "Command error: #{e}"
+    end
+    return resp
+  end
+
+  private
+  def parse_each_line # :nodoc:
+    loop do
+      data = get_line
+
+      # 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
+      
+      # literal
+      m = /\{(\d+)\+?\}/.match(data)
+      size = m.captures.first.to_i
+      yield :literal, @socket.read(size + 2) and next if m  #  + 2 for \r\n
+  
+      # other
+      yield :other, data
+    end
+  end
+
+  private
+  def get_response # :nodoc:
+    response = []
+    parse_each_line do |flag, data|
+      case flag
+      when :ok
+        return response
+      when :error
+        raise SieveResponseError, data.strip.gsub(/\r\n/, ' ')
+      else
+        response << data
+      end
+    end
+  end
+
+  private
+  def sieve_name(name) # :nodoc:
+    return "\"#{name}\""
+  end
+
+  private
+  def sieve_string(string) # :nodoc:
+    return "{#{string.length}+}\r\n#{string}"
+  end
+
+  private
+  def starttls
+    send_command 'STARTTLS'
+
+    @socket = OpenSSL::SSL::SSLSocket.new @socket
+    @socket.sync_close = true
+    @socket.connect
+
+    data = get_response
+    server_features(data)
+  end
+
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification 
+name: albanpeignier-ruby-managesieve
+version: !ruby/object:Gem::Version 
+  version: 0.3.1
+platform: ruby
+authors: 
+- Andre Nathan
+autorequire: managesieve
+bindir: bin
+cert_chain: []
+
+date: 2009-01-11 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: ruby-managesieve is a pure-ruby implementation of the MANAGESIEVE protocol, allowing remote management of Sieve scripts from ruby.
+email: andre@digirati.com.br
+executables: 
+- sievectl
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/managesieve.rb
+has_rdoc: true
+homepage: http://managesieve.rubyforge.org
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- A network connection and a MANAGESIEVE server.
+rubyforge_project: ruby-managesieve
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A Ruby library for the MANAGESIEVE protocol
+test_files: []
+