module Redwood
simple singleton module. far less complete and insane than the ruby standard library one, but it automatically forwards methods calls and allows for constructors that take arguments.
classes that inherit this can define initialize. however, you cannot call .new on the class. To get the instance of the class, call .instance; to create the instance, call init.
Constants
- BASE_DIR
- COLOR_FN
- CONFIG_FN
- CONTACT_FN
- DRAFT_DIR
- HOOK_DIR
- LABEL_FN
- LEGACY_YAML_DOMAIN
- LOCK_FN
- LOG_FN
- MAILDIR_SYNC_CHECK_SKIPPED
- SEARCH_FN
- SENT_FN
- SOURCE_FN
- SUICIDE_FN
- SYNC_OK_FN
- URI_ENCODE_CHARS
- VERSION
- YAML_DATE
- YAML_DOMAIN
Attributes
Public Class Methods
# File lib/sup.rb, line 202 def check_syncback_settings # don't check if syncback was never performed return unless File.exist? Redwood::SYNC_OK_FN active_sync_sources = File.readlines(Redwood::SYNC_OK_FN).collect { |e| e.strip }.find_all { |e| not e.empty? } return if active_sync_sources.length == 1 and active_sync_sources[0] == Redwood::MAILDIR_SYNC_CHECK_SKIPPED sources = SourceManager.sources newly_synced = sources.select { |s| s.is_a? Maildir and s.sync_back_enabled? and not active_sync_sources.include? s.uri } unless newly_synced.empty? details =<<EOS It appears that the option "sync_back" of the following source(s) has been changed from false to true since the last execution of sup: EOS newly_synced.each do |s| details += "#{s} (usual: #{s.usual})\n" end Redwood.warn_syncback details end end
# File lib/sup.rb, line 252 def finish Redwood::LabelManager.save if Redwood::LabelManager.instantiated? Redwood::ContactManager.save if Redwood::ContactManager.instantiated? Redwood::SearchManager.save if Redwood::SearchManager.instantiated? Redwood::Logger.remove_sink @log_io managers.each { |x| x.deinstantiate! if x.instantiated? } @log_io.close if @log_io @log_io = nil $config = nil end
set up default configuration file
# File lib/sup.rb, line 316 def load_config filename default_config = { :editor => ENV["EDITOR"] || "/usr/bin/vim -f -c 'setlocal spell spelllang=en_us' -c 'set filetype=mail'", :thread_by_subject => false, :edit_signature => false, :ask_for_from => false, :ask_for_to => true, :ask_for_cc => true, :ask_for_bcc => false, :ask_for_subject => true, :account_selector => true, :confirm_no_attachments => true, :confirm_top_posting => true, :jump_to_open_message => true, :discard_snippets_from_encrypted_messages => false, :load_more_threads_when_scrolling => true, :default_attachment_save_dir => "", :sent_source => "sup://sent", :archive_sent => true, :poll_interval => 300, :wrap_width => 0, :slip_rows => 0, :col_jump => 2, :stem_language => "english", :sync_back_to_maildir => false, :continuous_scroll => false, :always_edit_async => false, } if File.exist? filename config = Redwood::load_yaml_obj filename abort "#{filename} is not a valid configuration file (it's a #{config.class}, not a hash)" unless config.is_a?(Hash) default_config.merge config else require 'etc' require 'socket' name = Etc.getpwnam(ENV["USER"]).gecos.split(/,/).first.force_encoding($encoding).fix_encoding! rescue nil name ||= ENV["USER"] email = ENV["USER"] + "@" + begin Socket.gethostbyname(Socket.gethostname).first rescue SocketError Socket.gethostname end config = { :accounts => { :default => { :name => name.dup.fix_encoding!, :email => email.dup.fix_encoding!, :alternates => [], :sendmail => "/usr/sbin/sendmail -oem -ti", :signature => File.join(ENV["HOME"], ".signature"), :gpgkey => "" } }, } config.merge! default_config begin Redwood::save_yaml_obj config, filename, false, true rescue StandardError => e $stderr.puts "warning: #{e.message}" end config end end
# File lib/sup.rb, line 144 def load_yaml_obj fn, compress=false o = if File.exist? fn if compress Zlib::GzipReader.open(fn) { |f| YAML::load f } else YAML::load_file fn end end if o.is_a?(Array) o.each { |x| x.after_unmarshal! if x.respond_to?(:after_unmarshal!) } else o.after_unmarshal! if o.respond_to?(:after_unmarshal!) end o end
# File lib/sup.rb, line 160 def managers %w(HookManager SentManager ContactManager LabelManager AccountManager DraftManager UpdateManager PollManager CryptoManager UndoManager SourceManager SearchManager IdleManager).map { |x| Redwood.const_get x.to_sym } end
# File lib/sup.rb, line 78 def record_exception e, name @exception_mutex.synchronize do @exceptions ||= [] @exceptions << [e, name] end end
not really a good place for this, so I'll just dump it here.
a source error is either a FatalSourceError
or an OutOfSyncSourceError
. the superclass SourceError
is just a generic.
# File lib/sup.rb, line 269 def report_broken_sources opts={} return unless BufferManager.instantiated? broken_sources = SourceManager.sources.select { |s| s.error.is_a? FatalSourceError } unless broken_sources.empty? BufferManager.spawn_unless_exists("Broken source notification for #{broken_sources.join(',')}", opts) do TextMode.new(<<EOM) Source error notification ------------------------- Hi there. It looks like one or more message sources is reporting errors. Until this is corrected, messages from these sources cannot be viewed, and new messages will not be detected. #{broken_sources.map { |s| "Source: " + s.to_s + "\n Error: " + s.error.message.wrap(70).join("\n ")}.join("\n\n")} EOM #' stupid ruby-mode end end desynced_sources = SourceManager.sources.select { |s| s.error.is_a? OutOfSyncSourceError } unless desynced_sources.empty? BufferManager.spawn_unless_exists("Out-of-sync source notification for #{broken_sources.join(',')}", opts) do TextMode.new(<<EOM) Out-of-sync source notification ------------------------------- Hi there. It looks like one or more sources has fallen out of sync with my index. This can happen when you modify these sources with other email clients. (Sorry, I don't play well with others.) Until this is corrected, messages from these sources cannot be viewed, and new messages will not be detected. Luckily, this is easy to correct! #{desynced_sources.map do |s| "Source: " + s.to_s + "\n Error: " + s.error.message.wrap(70).join("\n ") + "\n Fix: sup-sync --changed #{s.to_s}" end} EOM #' stupid ruby-mode end end end
# File lib/sup.rb, line 85 def reporting_thread name if $opts[:no_threads] yield else ::Thread.new do begin yield rescue Exception => e record_exception e, name end end end end
one-stop shop for yamliciousness
# File lib/sup.rb, line 102 def save_yaml_obj o, fn, safe=false, backup=false o = if o.is_a?(Array) o.map { |x| (x.respond_to?(:before_marshal) && x.before_marshal) || x } elsif o.respond_to? :before_marshal o.before_marshal else o end mode = if File.exist? fn File.stat(fn).mode else 0600 end if backup backup_fn = fn + '.bak' if File.exist?(fn) && File.size(fn) > 0 File.open(backup_fn, "w", mode) do |f| File.open(fn, "r") { |old_f| FileUtils.copy_stream old_f, f } f.fsync end end File.open(fn, "w") do |f| f.puts o.to_yaml f.fsync end elsif safe safe_fn = "#{File.dirname fn}/safe_#{File.basename fn}" File.open(safe_fn, "w", mode) do |f| f.puts o.to_yaml f.fsync end FileUtils.mv safe_fn, fn else File.open(fn, "w", mode) do |f| f.puts o.to_yaml f.fsync end end end
# File lib/sup.rb, line 166 def start bypass_sync_check = false managers.each { |x| fail "#{x} already instantiated" if x.instantiated? } FileUtils.mkdir_p Redwood::BASE_DIR $config = load_config Redwood::CONFIG_FN @log_io = File.open(Redwood::LOG_FN, 'a') Redwood::Logger.add_sink @log_io Redwood::HookManager.init Redwood::HOOK_DIR Redwood::SentManager.init $config[:sent_source] || 'sup://sent' Redwood::ContactManager.init Redwood::CONTACT_FN Redwood::LabelManager.init Redwood::LABEL_FN Redwood::AccountManager.init $config[:accounts] Redwood::DraftManager.init Redwood::DRAFT_DIR Redwood::SearchManager.init Redwood::SEARCH_FN managers.each { |x| x.init unless x.instantiated? } return if bypass_sync_check if $config[:sync_back_to_maildir] if not File.exist? Redwood::SYNC_OK_FN Redwood.warn_syncback <<EOS It appears that the "sync_back_to_maildir" option has been changed from false to true since the last execution of sup. EOS $stderr.puts <<EOS Should I complain about this again? (Y/n) EOS File.open(Redwood::SYNC_OK_FN, 'w') {|f| f.write(Redwood::MAILDIR_SYNC_CHECK_SKIPPED) } if STDIN.gets.chomp.downcase == 'n' end elsif not $config[:sync_back_to_maildir] and File.exist? Redwood::SYNC_OK_FN File.delete(Redwood::SYNC_OK_FN) end end
# File lib/sup.rb, line 225 def self.warn_syncback details $stderr.puts <<EOS WARNING ------- #{details} It is *strongly* recommended that you run "sup-sync-back-maildir" before continuing, otherwise you might lose changes you have made in sup to your Xapian index. This script should be run each time you change the "sync_back_to_maildir" flag in config.yaml from false to true or the "sync_back" flag is changed to true for a source in sources.yaml. Please run "sup-sync-back-maildir -h" for more information and why this is needed. Note that if you have any sources that are not marked as 'ususal' in sources.yaml you need to manually specify them when running the sup-sync-back-maildir script. Are you really sure you want to continue? (y/N) EOS abort "Aborted" unless STDIN.gets.chomp.downcase == 'y' end
Private Instance Methods
# File lib/sup.rb, line 202 def check_syncback_settings # don't check if syncback was never performed return unless File.exist? Redwood::SYNC_OK_FN active_sync_sources = File.readlines(Redwood::SYNC_OK_FN).collect { |e| e.strip }.find_all { |e| not e.empty? } return if active_sync_sources.length == 1 and active_sync_sources[0] == Redwood::MAILDIR_SYNC_CHECK_SKIPPED sources = SourceManager.sources newly_synced = sources.select { |s| s.is_a? Maildir and s.sync_back_enabled? and not active_sync_sources.include? s.uri } unless newly_synced.empty? details =<<EOS It appears that the option "sync_back" of the following source(s) has been changed from false to true since the last execution of sup: EOS newly_synced.each do |s| details += "#{s} (usual: #{s.usual})\n" end Redwood.warn_syncback details end end
# File lib/sup.rb, line 252 def finish Redwood::LabelManager.save if Redwood::LabelManager.instantiated? Redwood::ContactManager.save if Redwood::ContactManager.instantiated? Redwood::SearchManager.save if Redwood::SearchManager.instantiated? Redwood::Logger.remove_sink @log_io managers.each { |x| x.deinstantiate! if x.instantiated? } @log_io.close if @log_io @log_io = nil $config = nil end
set up default configuration file
# File lib/sup.rb, line 316 def load_config filename default_config = { :editor => ENV["EDITOR"] || "/usr/bin/vim -f -c 'setlocal spell spelllang=en_us' -c 'set filetype=mail'", :thread_by_subject => false, :edit_signature => false, :ask_for_from => false, :ask_for_to => true, :ask_for_cc => true, :ask_for_bcc => false, :ask_for_subject => true, :account_selector => true, :confirm_no_attachments => true, :confirm_top_posting => true, :jump_to_open_message => true, :discard_snippets_from_encrypted_messages => false, :load_more_threads_when_scrolling => true, :default_attachment_save_dir => "", :sent_source => "sup://sent", :archive_sent => true, :poll_interval => 300, :wrap_width => 0, :slip_rows => 0, :col_jump => 2, :stem_language => "english", :sync_back_to_maildir => false, :continuous_scroll => false, :always_edit_async => false, } if File.exist? filename config = Redwood::load_yaml_obj filename abort "#{filename} is not a valid configuration file (it's a #{config.class}, not a hash)" unless config.is_a?(Hash) default_config.merge config else require 'etc' require 'socket' name = Etc.getpwnam(ENV["USER"]).gecos.split(/,/).first.force_encoding($encoding).fix_encoding! rescue nil name ||= ENV["USER"] email = ENV["USER"] + "@" + begin Socket.gethostbyname(Socket.gethostname).first rescue SocketError Socket.gethostname end config = { :accounts => { :default => { :name => name.dup.fix_encoding!, :email => email.dup.fix_encoding!, :alternates => [], :sendmail => "/usr/sbin/sendmail -oem -ti", :signature => File.join(ENV["HOME"], ".signature"), :gpgkey => "" } }, } config.merge! default_config begin Redwood::save_yaml_obj config, filename, false, true rescue StandardError => e $stderr.puts "warning: #{e.message}" end config end end
# File lib/sup.rb, line 144 def load_yaml_obj fn, compress=false o = if File.exist? fn if compress Zlib::GzipReader.open(fn) { |f| YAML::load f } else YAML::load_file fn end end if o.is_a?(Array) o.each { |x| x.after_unmarshal! if x.respond_to?(:after_unmarshal!) } else o.after_unmarshal! if o.respond_to?(:after_unmarshal!) end o end
# File lib/sup.rb, line 160 def managers %w(HookManager SentManager ContactManager LabelManager AccountManager DraftManager UpdateManager PollManager CryptoManager UndoManager SourceManager SearchManager IdleManager).map { |x| Redwood.const_get x.to_sym } end
# File lib/sup.rb, line 78 def record_exception e, name @exception_mutex.synchronize do @exceptions ||= [] @exceptions << [e, name] end end
not really a good place for this, so I'll just dump it here.
a source error is either a FatalSourceError
or an OutOfSyncSourceError
. the superclass SourceError
is just a generic.
# File lib/sup.rb, line 269 def report_broken_sources opts={} return unless BufferManager.instantiated? broken_sources = SourceManager.sources.select { |s| s.error.is_a? FatalSourceError } unless broken_sources.empty? BufferManager.spawn_unless_exists("Broken source notification for #{broken_sources.join(',')}", opts) do TextMode.new(<<EOM) Source error notification ------------------------- Hi there. It looks like one or more message sources is reporting errors. Until this is corrected, messages from these sources cannot be viewed, and new messages will not be detected. #{broken_sources.map { |s| "Source: " + s.to_s + "\n Error: " + s.error.message.wrap(70).join("\n ")}.join("\n\n")} EOM #' stupid ruby-mode end end desynced_sources = SourceManager.sources.select { |s| s.error.is_a? OutOfSyncSourceError } unless desynced_sources.empty? BufferManager.spawn_unless_exists("Out-of-sync source notification for #{broken_sources.join(',')}", opts) do TextMode.new(<<EOM) Out-of-sync source notification ------------------------------- Hi there. It looks like one or more sources has fallen out of sync with my index. This can happen when you modify these sources with other email clients. (Sorry, I don't play well with others.) Until this is corrected, messages from these sources cannot be viewed, and new messages will not be detected. Luckily, this is easy to correct! #{desynced_sources.map do |s| "Source: " + s.to_s + "\n Error: " + s.error.message.wrap(70).join("\n ") + "\n Fix: sup-sync --changed #{s.to_s}" end} EOM #' stupid ruby-mode end end end
# File lib/sup.rb, line 85 def reporting_thread name if $opts[:no_threads] yield else ::Thread.new do begin yield rescue Exception => e record_exception e, name end end end end
one-stop shop for yamliciousness
# File lib/sup.rb, line 102 def save_yaml_obj o, fn, safe=false, backup=false o = if o.is_a?(Array) o.map { |x| (x.respond_to?(:before_marshal) && x.before_marshal) || x } elsif o.respond_to? :before_marshal o.before_marshal else o end mode = if File.exist? fn File.stat(fn).mode else 0600 end if backup backup_fn = fn + '.bak' if File.exist?(fn) && File.size(fn) > 0 File.open(backup_fn, "w", mode) do |f| File.open(fn, "r") { |old_f| FileUtils.copy_stream old_f, f } f.fsync end end File.open(fn, "w") do |f| f.puts o.to_yaml f.fsync end elsif safe safe_fn = "#{File.dirname fn}/safe_#{File.basename fn}" File.open(safe_fn, "w", mode) do |f| f.puts o.to_yaml f.fsync end FileUtils.mv safe_fn, fn else File.open(fn, "w", mode) do |f| f.puts o.to_yaml f.fsync end end end
# File lib/sup.rb, line 166 def start bypass_sync_check = false managers.each { |x| fail "#{x} already instantiated" if x.instantiated? } FileUtils.mkdir_p Redwood::BASE_DIR $config = load_config Redwood::CONFIG_FN @log_io = File.open(Redwood::LOG_FN, 'a') Redwood::Logger.add_sink @log_io Redwood::HookManager.init Redwood::HOOK_DIR Redwood::SentManager.init $config[:sent_source] || 'sup://sent' Redwood::ContactManager.init Redwood::CONTACT_FN Redwood::LabelManager.init Redwood::LABEL_FN Redwood::AccountManager.init $config[:accounts] Redwood::DraftManager.init Redwood::DRAFT_DIR Redwood::SearchManager.init Redwood::SEARCH_FN managers.each { |x| x.init unless x.instantiated? } return if bypass_sync_check if $config[:sync_back_to_maildir] if not File.exist? Redwood::SYNC_OK_FN Redwood.warn_syncback <<EOS It appears that the "sync_back_to_maildir" option has been changed from false to true since the last execution of sup. EOS $stderr.puts <<EOS Should I complain about this again? (Y/n) EOS File.open(Redwood::SYNC_OK_FN, 'w') {|f| f.write(Redwood::MAILDIR_SYNC_CHECK_SKIPPED) } if STDIN.gets.chomp.downcase == 'n' end elsif not $config[:sync_back_to_maildir] and File.exist? Redwood::SYNC_OK_FN File.delete(Redwood::SYNC_OK_FN) end end