Module: Reedb::Core

Includes:: Reedb

Defined in:: lib/reedb.rb

Overview

Core submodule of the Interface stack

Constant Summary

Constants included from Reedb

CERT_PATH, DEBOUNCE_DELTA, DEB_ADD, DEB_REM, DEFAULT_PATH, EXIT_CORRUPT_FS, EXIT_HTTP_MALFUNCT, EXIT_MISSING_USER_CODE, EXIT_OS_PARSE, EXIT_PANIC_INTERUPT, EXIT_STILL_LOCKED, FILE_CACHE_TIME, KEY_CACHE_TIME, KEY_PATH, NET_PORT, THREAD_TIMEOUT_TIME, TOKEN_BYTE_SIZE, VERSION

Class Method Summary collapse

.init(options, &user_code) ⇒ Object

Initialise Reedb with a set of parameters passed into this method.
.terminate(reason = nil, silent = false) ⇒ Object

Terminate Reedb with a reason.

Methods included from Reedb

archos, daemon?, included, passlength, verbose?

Class Method Details

.init(options, &user_code) ⇒ `Object`

Initialise Reedb with a set of parameters passed into this method. Please check the wiki to find out what option parameters are available to use here.

Parameters:

options (Hash) —

Parameters to run Reedb by sorted in a hash datastructure.

Returns:

# File 'lib/reedb.rb', line 273

def init(options, &user_code)
	unless options.include?(:os) && options.include?(:pw_length)
		puts 'Missing :os (:linux|:osx) and/or :pw_length fields from options!'
		exit Reedb::EXIT_OS_PARSE
	end

	# Checks if user code was provided and exits the entire application if not provided!
	if user_code == nil && !options[:daemon]
		puts 'No user function was provided to run! Reedb must run in daemon mode to do that!'
		exit Reedb::EXIT_MISSING_USER_CODE
	end

	@@daemon = options.include?(:daemon) ? options[:daemon] : true
	@@archos = options[:os]
	@@pw_length = options[:pw_length]
	@@verbose = options.include?(:verbose) ? options[:verbose] : false
	@@no_token = options.include?(:no_token) ? options[:no_token] : false
	override = options.include?(:force) ? options[:force] : false

	if @@no_token
		puts 'NO_TOKEN mode has not been implemented yet! Defaulting to token mode.'
		@@no_token = false
	end

	# Now @@path is either a path OR a placeholder.
	@@path = options.include?(:path) ? options[:path] : Reedb::DEFAULT_PATH

	# Enable cleanup mode
	# This means that the config will be cleaned and unused tokens removed
	# instead of leaving them in the file and configurations.
	# It is recommended to use cleanup mode.
	#
	@@cleanup = options.include?(:cleanup) ? options[:cleanup] : true

	# Set of vaults that map a VaultBuffer to the vault itself.
	# Never exposed outside the API
	#
	@@active_vaults = {}

	# List of tokens authorised for this daemon. Maps tokens to vault names.
	# This is used for authentication and never exposed to the outside API
	# NOTE! This is not used when the :no_token option is enabled
	#
	@@tokens = {} unless @@no_token


	# This is called when the default path applies
	if @@path == Reedb::DEFAULT_PATH

		# For good operating systems.
		if @@archos == :linux
			master_path = File.expand_path('~/.config/reedb/')
			master_path = '/etc/reedb' if Utilities::parse_user == 'root'

			log_path = File.expand_path('~/.config/reedb/logs/')

			# For OSX
		elsif @@archos == :osx
			master_path = File.expand_path('~/Library/Application\ Support/reedb/')
			master_path = '/Library/Application\ Support/reedb' if Utilities::parse_user == 'root'

			log_path = File.expand_path('~/Library/Application\ Support/reedb/logs/')

		elsif @@archos == :win
			puts 'This is currently not supported :( Sorry.'
			# Windows crap
		elsif @@archos == :other
			raise UnknownOSError.new, 'Operating system was not specified, yet an override path was not specified either. Can not continue without more information!'
			exit(Reedb::EXIT_OS_PARSE)
		else
			raise UnknownOSError.new, "Could not recognise specified OS. What are you running? Why don't you go here:
 getfedora.org :)"
			exit(Reedb::EXIT_OS_PARSE)
		end
	else
		master_path = @@path
		log_path = File.join("#{master_path}", 'logs')
	end

	# Sets up the config path
	@@config_path = File.join("#{master_path}", 'master.cfg')
	@@lock_file = File.join("#{master_path}", 'lock')

	# Now go create directories if they need to be created.
	FileUtils::mkdir_p("#{log_path}") unless File.directory?("#{log_path}")
	FileUtils::chmod_R(0744, "#{log_path}")
	FileUtils::chmod_R(0744, "#{master_path}")

	# Now that pathing has been established, check if there is a lock file.
	if File.exist?(@@lock_file) && !override
		puts '[FATAL] Another instance of Reedb is already operating from this directory! Choose another directory or terminate the old instance first!'
		exit(Reedb::EXIT_STILL_LOCKED)
	elsif File.exist?(@@lock_file) && override
		puts "There was another instance of Reedb running but you forced my hand. It's dead now..."
	end

	# Create a lock file
	File.open(@@lock_file, 'w+') { |f| f.write('Hier koennte Ihre Werbung stehen.') }

	# Start up the logging service.
	Reedb::DaemonLogger.setup("#{log_path}")

	# Now go and declare this daemon started and log it.
	@@started = true
	Reedb::DaemonLogger.write('Reedb was started successfully. Reading vault information now...', 'debug')

	# Now cache the config
	cache_config

	'' '
	The bottom part initiates the main run look that bounces between debouncer thread and user code.
	This function only returns after all the user code was handled.
	' ''

	# Open debounce object
	@@debouncer = Reedb::Debouncer.new(self)


	# Now actually run the code on two threads and hope that the scheduler does it's job!
	@@debouncerThread = Thread.new { @@debouncer.main }
	user = Thread.new(&user_code)

	# Wait for user code to terminate
	user.join

	# Then call terminate just in case they haven't yet
	Reedb::Core::terminate('null', true)
end

.terminate(reason = nil, silent = false) ⇒ `Object`

Terminate Reedb with a reason. After calling this function the core functionality (and depending interfaces on the stack) is no longer available.