onboard.rb

# -*- coding: UTF-8 -*-

$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib'

require 'rubygems'
require 'find'
require 'logger'
require 'etc'

require 'onboard/exceptions'
require 'onboard/extensions/object'
require 'onboard/extensions/logger'
require 'onboard/menu/node'
require 'onboard/system/command'
require 'onboard/platform/debian'

begin
  require 'onboard/constants/custom'
rescue LoadError
end

if Process.uid == 0
  fail 'OnBoard should not be run as root: use an user who can sudo with no-password instead!'
end

class OnBoard
  LONGNAME          ||= 'OnBoard'
  VERSION           = '2013.12'

  PLATFORM          = Platform::Debian # TODO? make it configurable? get rid of Platform?

  ROOTDIR           = File.dirname File.expand_path(__FILE__)
  DATADIR = RWDIR = (
      ENV['ONBOARD_RWDIR'] or 
      ENV['ONBOARD_DATADIR'] or 
      File.join(ENV['HOME'], '.onboard')
  )
  FileUtils.mkdir_p RWDIR
  FileUtils.chmod 0700, RWDIR # too much sensible data here ;-)
  CONFDIR             = File.join RWDIR, '/etc/config'
  LOGDIR              = File.join RWDIR, '/var/log'
  FILESDIR            = File.join ENV['HOME'], 'files' # mass storage...
  # sometimes files are uploaded elsewhere, as best suitable
  DEFAULT_UPLOAD_DIR  = File.join RWDIR, '/var/uploads'
  LOGFILE_BASENAME    = 'onboard.log'
  LOGFILE_PATH        = File.join LOGDIR, LOGFILE_BASENAME

  VARRUN              ||= '/var/run/onboard'

  VARLIB              ||= File.join RWDIR, 'var/lib'
 
  FileUtils.mkdir_p LOGDIR unless Dir.exists? LOGDIR
  # NOTE: we are re-defining a constant!
  # ...really, it should not be a constant... :-(
  # TODO TODO TODO ...
  LOGGER            = Logger.new(LOGDIR + '/' + 'onboard.log')
  
  LOGGER.formatter = proc { |severity, datetime, progname, msg|
    "#{datetime} #{severity}: #{msg}\n"
  }

  LOGGER.level = Logger::INFO
  LOGGER.level = Logger::DEBUG if 
      $0 == __FILE__ and not
      ENV['ONBOARD_ENVIRONMENT'] =~ /production/i
      # this is required because there is no Sinatra environment until
      # controller.rb is loaded (where OnBoard::Controller inherits 
      # from Sinatra::Base)

  MENU_ROOT = Menu::MenuNode.new('ROOT', {
    :href => '/',
    :name => 'Home',
    :desc => 'Home page',
    :n    => 0
  })

  def self.find_n_load(dir)
    # sort to resamble /etc/rc*.d/* or run-parts behavior
    Find.find(dir).sort.each do |file|
      if file =~ /\.rb$/
        print "loading: #{file}... "
        STDOUT.flush
        if load file
          print "OK\n"
          STDOUT.flush
        end
      end
    end
  end

  def self.web?
    return true unless ARGV.include? '--no-web'
    return false
  end

  def self.prepare
    system "sudo mkdir -p #{VARRUN}"
    system "sudo chown onboard #{VARRUN}"

    # modules
    Dir.foreach(ROOTDIR + '/modules') do |dir|
      dir_fullpath = ROOTDIR + '/modules/' + dir
      if File.directory? dir_fullpath and not dir =~ /^\./
        file = dir_fullpath + '/load.rb'
        if File.readable? file
          if File.exists? dir_fullpath + '/.disable'
            puts "Module #{dir}: disabled!"
          else
            load dir_fullpath + '/load.rb'
          end
        else
          STDERR.puts "Warning: Couldn't load modules/#{dir}/load.rb: Skipped!"
        end
      end 
    end

    # After the modules, 'cause we want to know, among other things,
    # whether to activate public pages layout configuration page
    # (and relative menu item).
    if web?
      require 'onboard/controller/helpers'
      require 'onboard/controller'
      
      # modular menu
      find_n_load ROOTDIR + '/etc/menu/'
    end

    # restore scripts, sorted like /etc/rc?.d/ SysVInit/Unix/Linux scripts
    if ARGV.include? '--restore' 
      restore_scripts = 
          Dir.glob(ROOTDIR + '/etc/restore/[0-9][0-9]*.rb')           #+
          #Dir.glob(ROOTDIR + '/modules/*/etc/restore/[0-9][0-9]*.rb') 
      Dir.glob(ROOTDIR + '/modules/*').each do |module_dir|
        next if File.exists? "#{module_dir}/.disable"
        restore_scripts += Dir.glob("#{module_dir}/etc/restore/[0-9][0-9]*.rb")
      end
      restore_scripts.sort!{|x,y| File.basename(x) <=> File.basename(y)}
      restore_scripts.each do |script|
        print "loading: #{script}... "
        STDOUT.flush
        begin
          load script and puts "OK"
        rescue Exception
          exception = $!

          puts "ERR!"
          puts "#{exception.class}: #{exception.message}"

          LOGGER.error "loading #{script}: #{exception.inspect}"
          backtrace_str = "Exception backtrace follows:"
          exception.backtrace.each{|line| backtrace_str << "\n" << line} 
          LOGGER.error backtrace_str
        end
      end
    end
    # TODO: DRY DRY DRY
    if ARGV.include? '--shutdown' 
      shutdown_scripts = 
          Dir.glob(ROOTDIR + '/etc/shutdown/[0-9][0-9]*.rb')           
      Dir.glob(ROOTDIR + '/modules/*').each do |module_dir|
        next if File.exists? "#{module_dir}/.disable"
        shutdown_scripts += Dir.glob("#{module_dir}/etc/shutdown/[0-9][0-9]*.rb")
      end
      shutdown_scripts.sort!{|x,y| File.basename(x) <=> File.basename(y)}
      shutdown_scripts.each do |script|
        print "loading: #{script}... "
        STDOUT.flush
        begin
          load script and puts "OK"
        rescue Exception
          exception = $!

          puts exception.inspect

          LOGGER.error "loading #{script}: #{exception.inspect}"
          backtrace_str = "Exception backtrace follows:"
          exception.backtrace.each{|line| backtrace_str << "\n" << line} 
          LOGGER.error backtrace_str
        end
      end
    end

  end

  def self.save!
    LOGGER.info 'Saving configuration...'
    find_n_load ROOTDIR + '/etc/save/'

    # modules
    Dir.glob(ROOTDIR + '/modules/*').each do |module_dir|
      next if File.exists? "#{module_dir}/.disable"
      Dir.glob("#{module_dir}/etc/save/*.rb").each do |script| 
        print "loading: #{script}... " and STDOUT.flush
        load script and puts ' OK'
      end
    end

    # for Voyage-Linux embedded Debian flavour http://linux.voyage.hk
    voyage_sync = '/etc/init.d/voyage-sync'
    if File.file? voyage_sync and File.executable? voyage_sync
      # TODO: move this to a specific file/module/method...
      rootfsmode = `(sudo touch /.rw 2> /dev/null) && echo 'rw' || echo 'ro'`.strip.to_sym
      System::Command.run "remountrw",            :sudo if rootfsmode == :ro
      System::Command.run "#{voyage_sync} sync",  :sudo
      System::Command.run "remountro",            :sudo if rootfsmode == :ro
    end

    System::Command.run 'sync'
  end

end

OnBoard.prepare

if OnBoard.web?
  #require 'onboard/controller'
  #require 'onboard/controller/helpers'
  if $0 == __FILE__
    OnBoard::Controller.run! :bind => '0.0.0.0'
  end
end