Class: BMF::Settings

Inherits:
Object
  • Object
show all
Includes:
Singleton
Defined in:
lib/bmf/lib/settings.rb

Constant Summary collapse

SETTINGS_AND_DESCRIPTIONS = 
{
  :server_url => "Url of the BitMessage server to interface with.",
  :sig => "Signature line to attach to messages.",
  :default_send_address => "Default FROM address for messages.",
  :server_interface => "Internet interface to listen on.  Set to 0.0.0.0 to open up BMF to the network.  WARNING!!! Anyone who can access your IP can read/post/delete/etc.",
  :server_port => "Internet port to listen on.",
  :display_sanitized_html => "Show sanitized HTML minus scripts, css, and any non-inline images.",
  :sync_interval => "Frequency to sync inbox with PyBitmessage, in seconds.  Default 60",
  :user => "username for http basic authentication.  (You should be using https in conjunction with this!)",
  :password => "password for http basic authentication.  (You should be using https in conjunction with this!)",
  :https_server_key_file => "file for https key",
  :https_server_certificate_file => "file for https certificate"
}
DEFAULT_SETTINGS = 
{"server_url" => 'http://bmf:bmf@localhost:8442/', "display_sanitized_html" => 'no', 'server_interface' => "localhost" }
VALID_SETTINGS = 
SETTINGS_AND_DESCRIPTIONS.keys
SETTING_DIR = 
".bitmessageforum"
SETTINGS_FILE = 
"settings.yml"

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Settings

Returns a new instance of Settings.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/bmf/lib/settings.rb', line 34

def initialize
  home_dir = ENV["HOME"] || ENV["HOMEPATH"]
  
  setting_dir = File.join(home_dir, SETTING_DIR)
  Dir.mkdir(setting_dir, 0700) if !File.directory? setting_dir

  settings_filename = BMF::Settings.fully_qualified_filename(SETTINGS_FILE)

  if !File.exists? (settings_filename)
    puts "No existing settings.  Copying defaults into place."
    @settings = DEFAULT_SETTINGS
    persist
  end

  @settings = YAML.load_file(settings_filename)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(meth, *args) ⇒ Object 



64
65
66
67
68
69
70
71
72
 
# File 'lib/bmf/lib/settings.rb', line 64

def method_missing(meth, *args)
  if args == [] and VALID_SETTINGS.include?(meth)
    ret = @settings[meth.to_s]
    ret = nil if ret == ""
    return ret
  else
    super
  end
end

Class Method Details

.fully_qualified_filename(filename) ⇒ Object 



29
30
31
32
 
# File 'lib/bmf/lib/settings.rb', line 29

def self.fully_qualified_filename filename
  home_dir = ENV["HOME"] || ENV["HOMEPATH"]
  File.join(home_dir, SETTING_DIR, filename)
end

Instance Method Details

#persist ⇒ Object 



58
59
60
61
62
 
# File 'lib/bmf/lib/settings.rb', line 58

def persist
  File.open(BMF::Settings.fully_qualified_filename(SETTINGS_FILE),'w',0600) do |out|
    out.write(@settings.to_yaml)
  end
end

#update(key, value) ⇒ Object 



51
52
53
54
55
56
 
# File 'lib/bmf/lib/settings.rb', line 51

def update(key, value)
  raise "Bad setting #{key}.  Allowed settings #{VALID_SETTINGS.inspect}" if !VALID_SETTINGS.include?(key.to_sym)
  @settings[key] = value

  BMF::XmlrpcClient.instance.initialize_client if key.to_sym == :server_url
end