1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
|
# encoding: utf-8
require 'yaml'
require 'zlib'
require 'thread'
require 'fileutils'
require 'locale'
require 'ncursesw'
require 'rmail'
require 'uri'
begin
require 'fastthread'
rescue LoadError
end
class Object
## this is for debugging purposes because i keep calling #id on the
## wrong object and i want it to throw an exception
def id
raise "wrong id called on #{self.inspect}"
end
end
class Module
def yaml_properties *props
props = props.map { |p| p.to_s }
path = name.gsub(/::/, "/")
yaml_tag "!#{Redwood::YAML_DOMAIN},#{Redwood::YAML_DATE}/#{path}"
define_method :init_with do |coder|
initialize(*coder.map.values_at(*props))
end
define_method :encode_with do |coder|
coder.map = props.inject({}) do |hash, key|
hash[key] = instance_variable_get("@#{key}")
hash
end
end
# Legacy
Psych.load_tags["!#{Redwood::LEGACY_YAML_DOMAIN},#{Redwood::YAML_DATE}/#{path}"] = self
end
end
module Redwood
BASE_DIR = ENV["SUP_BASE"] || File.join(ENV["HOME"], ".sup")
CONFIG_FN = File.join(BASE_DIR, "config.yaml")
COLOR_FN = File.join(BASE_DIR, "colors.yaml")
SOURCE_FN = File.join(BASE_DIR, "sources.yaml")
LABEL_FN = File.join(BASE_DIR, "labels.txt")
CONTACT_FN = File.join(BASE_DIR, "contacts.txt")
DRAFT_DIR = File.join(BASE_DIR, "drafts")
SENT_FN = File.join(BASE_DIR, "sent.mbox")
LOCK_FN = File.join(BASE_DIR, "lock")
SUICIDE_FN = File.join(BASE_DIR, "please-kill-yourself")
HOOK_DIR = File.join(BASE_DIR, "hooks")
SEARCH_FN = File.join(BASE_DIR, "searches.txt")
LOG_FN = File.join(BASE_DIR, "log")
SYNC_OK_FN = File.join(BASE_DIR, "sync-back-ok")
YAML_DOMAIN = "supmua.org"
LEGACY_YAML_DOMAIN = "masanjin.net"
YAML_DATE = "2006-10-01"
MAILDIR_SYNC_CHECK_SKIPPED = 'SKIPPED'
URI_ENCODE_CHARS = "!*'();:@&=+$,?#[] " # see https://en.wikipedia.org/wiki/Percent-encoding
## record exceptions thrown in threads nicely
@exceptions = []
@exception_mutex = Mutex.new
attr_reader :exceptions
def record_exception e, name
@exception_mutex.synchronize do
@exceptions ||= []
@exceptions << [e, name]
end
end
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
module_function :reporting_thread, :record_exception, :exceptions
## one-stop shop for yamliciousness
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
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
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
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
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
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
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
## 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.
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
## set up default configuration file
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
module_function :save_yaml_obj, :load_yaml_obj, :start, :finish,
:report_broken_sources, :load_config, :managers,
:check_syncback_settings
end
require 'sup/version'
require "sup/util"
require "sup/hook"
require "sup/time"
## everything we need to get logging working
require "sup/logger/singleton"
## determine encoding and character set
$encoding = Locale.current.charset
$encoding = "UTF-8" if $encoding == "utf8"
$encoding = "UTF-8" if $encoding == "UTF8"
if $encoding
debug "using character set encoding #{$encoding.inspect}"
else
warn "can't find character set by using locale, defaulting to utf-8"
$encoding = "UTF-8"
end
# test encoding
teststr = "test"
teststr.encode('UTF-8')
begin
teststr.encode($encoding)
rescue Encoding::ConverterNotFoundError
warn "locale encoding is invalid, defaulting to utf-8"
$encoding = "UTF-8"
end
require "sup/buffer"
require "sup/keymap"
require "sup/mode"
require "sup/modes/scroll_mode"
require "sup/modes/text_mode"
require "sup/modes/log_mode"
require "sup/update"
require "sup/message_chunks"
require "sup/message"
require "sup/source"
require "sup/mbox"
require "sup/maildir"
require "sup/person"
require "sup/account"
require "sup/thread"
require "sup/interactive_lock"
require "sup/index"
require "sup/textfield"
require "sup/colormap"
require "sup/label"
require "sup/contact"
require "sup/tagger"
require "sup/draft"
require "sup/poll"
require "sup/crypto"
require "sup/undo"
require "sup/horizontal_selector"
require "sup/modes/line_cursor_mode"
require "sup/modes/help_mode"
require "sup/modes/edit_message_mode"
require "sup/modes/edit_message_async_mode"
require "sup/modes/compose_mode"
require "sup/modes/resume_mode"
require "sup/modes/forward_mode"
require "sup/modes/reply_mode"
require "sup/modes/label_list_mode"
require "sup/modes/contact_list_mode"
require "sup/modes/thread_view_mode"
require "sup/modes/thread_index_mode"
require "sup/modes/label_search_results_mode"
require "sup/modes/search_results_mode"
require "sup/modes/person_search_results_mode"
require "sup/modes/inbox_mode"
require "sup/modes/buffer_list_mode"
require "sup/modes/poll_mode"
require "sup/modes/file_browser_mode"
require "sup/modes/completion_mode"
require "sup/modes/console_mode"
require "sup/sent"
require "sup/search"
require "sup/modes/search_list_mode"
require "sup/idle"
$:.each do |base|
d = File.join base, "sup/share/modes/"
Redwood::Mode.load_all_modes d if File.directory? d
end
|