sme-configdb 0.1

data/README

@@ -0,0 +1,8 @@
+About sme::configdb:
+====================
+
+Release Notes:
+==============
+
+About version 0.1:
+==================

data/lib/smeserver/configdb.rb

@@ -0,0 +1,371 @@
+# This library provides a simple API for managing SME Server style e-smith
+# database files.
+
+DbPrefix = "/home/e-smith/db"
+DEBUG = true
+
+# = ConfigDBError
+# The base class for all errors produced by this API.
+class ConfigDBError < RuntimeError
+end
+
+# == assert
+# Simple assert function making use of a passed code block. Assertions are
+# disabled if $DEBUG is not set.
+def assert
+    raise ConfigDBError, "Assertion failed !" unless yield if $DEBUG
+end
+
+# == verbose
+# Used for debug messages. The param is sent to puts if $DEBUG is set.
+def verbose(msg)
+    puts msg if $DEBUG
+end
+
+# == screen_key
+# Additional checks for a key.
+def screen_key(key)
+    case key
+    when /=/
+        raise ConfigDBError, "= characters are not permitted in keys: #{key}"
+    end
+    screen_prop key
+end
+
+# == screen_prop
+# Test the incoming parameters for type, or any unsupported characters. We
+# support ascii with no control characters.
+def screen_prop(prop)
+    case prop
+    when nil
+        raise ConfigDBError, "nil params are not permitted: #{prop}"
+    when /\|/
+        raise ConfigDBError, "| characters are not permitted: #{prop}"
+    when /[^[:print:]]/
+        raise ConfigDBError, "Invalid characters found: #{prop}"
+    when String
+        return
+    else
+        raise ConfigDBError, "properties must be of type String"
+    end
+end
+
+# = ConfigDB
+# A representation of a single database.
+class ConfigDB
+    attr_reader :file
+
+    # == initialize
+    # Class constructor. Takes a database name, or a path, defaulting to
+    # the main configuration database.
+    def initialize(dbname = "configuration")
+        @records = Hash.new
+        @file = nil
+        verbose "Initializing db for dbname #{dbname}"
+
+        # Absolute or relative path?
+        if File::exists? dbname
+            @file = dbname
+            lock_and_load
+        else
+            # Ok, try the standard location on disk.
+            dbpath = DbPrefix + '/' + dbname
+            if File::exists? dbpath
+                @file = dbpath
+                lock_and_load
+            else
+                raise ConfigDBError, "#{dbpath} does not exist"
+            end
+        end
+    end
+
+    def inspect
+        return "ConfigDB object for #{@file}"
+    end
+
+    # == get_all
+    # This method returns all of the records in the database as an array.
+    def get_all
+        return @records.values
+    end
+
+    # == get
+    # This method returns the record based on the key passed, returning nil if
+    # no record with that key exists.
+    def get(key)
+        return @records[key]
+    end
+
+    # == get_value
+    # This method returns the value, or type, of the record passed. If there
+    # is no such record, it safely returns nil.
+    def get_value(key)
+        rec = @records[key]
+        return rec.value if rec
+    end
+
+    # == get_prop
+    # This method returns the property passed of the record passed. If either
+    # the record or property does not exist, it safely returns nil.
+    def get_prop(key, prop)
+        rec = @records[key]
+        if rec
+            rec.prop(prop)
+        else
+            nil
+        end
+    end
+
+    # == new_record
+    # This method creates a new record object in the database, and returns it.
+    # The key for the record is a required parameter, along with the type. For
+    # singleton records, the type is the value associated with the key.
+    def new_record(key, type)
+        assert {key !~ /=/}
+        assert {key != nil and key != ''}
+        assert {type != nil}
+        if @records.has_key? key
+            raise ConfigDBError, "Key #{key} already exists in database"
+        end
+
+        record = ConfigDBRecord.new(key, self)
+        record.type = type
+        @records[key] = record
+        return record
+    end
+
+    # == delete_record
+    # This method deletes the record from the database based on the key
+    # passed.
+    def delete_record(key)
+        @records.delete(key)
+    end
+
+    # == reload
+    # This method reloads the database from the file.
+    def reload
+        @records.clear
+        lock_and_load
+    end
+
+    # == save
+    # This method saves the db object to the file.
+    def save
+        begin
+            file = File.new(@file, "w")
+            unless file.flock(File::LOCK_EX)
+                raise ConfigDBError, "Failed to acquire exclusive lock"
+            end
+            @records.keys.sort.each do |key|
+                file.write(@records[key].to_s + "\n")
+            end
+        ensure
+            file.flock(File::LOCK_UN)
+            file.close
+        end
+    end
+
+    # == each
+    # This method is an interator for the records in the db.
+    def each
+        for key in @records.keys.sort
+            yield @records[key]
+        end
+    end
+
+    private
+
+    # == lock_and_load
+    # This method locks the db file, and parses it into an internal list of
+    # records.
+    def lock_and_load
+        begin
+            file = File.new(@file, "r")
+            unless file.flock(File::LOCK_SH)
+                raise ConfigDBError, "Failed to acquire shared lock"
+            end
+            file.each do |line|
+                # Skip any commented or blank lines.
+                next if line =~ /^(\s+)?#/ or line =~ /^(\s*)$/
+
+                key = nil
+                if line =~ /^([^=]+)=/
+                    key = Regexp.last_match(1)
+                else
+                    raise ConfigDBError, "Parse error on line: #{line}"
+                end
+
+                if @records.has_key? key
+                    raise ConfigDBError, "Key #{key} is not unique!"
+                else
+                    record = ConfigDBRecord.new(key, self, false)
+                    record.parse(line)
+                    @records[key] = record
+                end
+            end
+        ensure
+            # No matter what, we always unlock and close the file.
+            file.flock(File::LOCK_UN)
+            file.close
+        end
+    end
+end
+
+# = ConfigDBRecord
+# A representation of a single record in the database.
+class ConfigDBRecord
+    attr_accessor :type
+    attr_reader :key
+
+    # == initialize
+    # Class constructor. A unique key is the only required parameter.
+    def initialize(key, db, save=true)
+        screen_key key
+        @key = key
+        @type = nil
+        @props = Hash.new
+        @db = db
+        @db.save if save
+    end
+
+    def inspect
+        return "ConfigDBRecord, key is #{key}, type is #{type}"
+    end
+
+    def to_s
+        verbose "In method ConfigDBRecord.to_s"
+        verbose "@key is #{@key}, @type is #{@type}"
+        s = @key + '=' + @type
+        @props.keys.sort.each do |key|
+            s += '|' + key + '|' + @props[key]
+        end
+        return s
+    end
+
+    def parse(line)
+        line.chomp!
+        pieces = line.split('=', 2)
+
+        if pieces.length == 1
+            pieces << ''
+        elsif pieces.length != 2
+            raise ConfigDBError, "Invalid line: #{line}"
+        end
+
+        # @key is set by the constructor.
+        unless pieces[1] =~ /\|/
+            @type = pieces[1]
+        else
+            pieces = pieces[1].split('|')
+            @type = pieces.shift
+
+            unless pieces.length % 2 == 0
+                raise ConfigDBError,
+                    "Odd number of name/value pairs in line: #{line}"
+            end
+
+            while pieces.length > 0
+                key = pieces.shift
+                val = pieces.shift
+                screen_key key
+                screen_prop val
+
+                unless @props.has_key? key
+                    @props[key] = val
+                else
+                    raise ConfigDBError, "Duplicate property #{key} in record"
+                end
+            end
+        end
+    end
+
+    # == prop
+    # This method returns the value of the property passed. It returns nil if
+    # the property does not exist.
+    def prop(name)
+        return @props[name]
+    end
+
+    # == props
+    # This method returns all of the property names in the record.
+    def props
+        return @props.keys
+    end
+
+    # == set_prop
+    # This method sets the property passed to the value passed.
+    def set_prop(name, value)
+        screen_prop name
+        screen_prop value
+        @props[name] = value
+        @db.save
+    end
+
+    # == type
+    # This method returns the type of the record, also used as a value for
+    # singleton records.
+    def type
+        return @type
+    end
+
+    # == value
+    # This method is an alias for type.
+    def value
+        type
+    end
+
+    # == set_type
+    # This method sets the type of the record, also used as a value for
+    # singleton records.
+    def set_type(type)
+        screen_prop type
+        @type = type
+    end
+
+    # == set_value
+    # This method is an alias for set_type.
+    def set_value(value)
+        set_type(value)
+    end
+
+    # == has_prop?
+    # This method returns true of the property passed exists in this record,
+    # and false otherwise.
+    def has_prop?(name)
+        return @props.has_key?(name)
+    end
+
+    # == delete_prop
+    # This method deletes a property from the given record.
+    def delete_prop(name)
+        @props.delete(name)
+    end
+
+    # == delete
+    # This method deletes the record.
+    def delete
+        @db.delete_record(@key)
+    end
+
+    # == show
+    # This method returns a pretty-printed string of the record.
+    def show
+        s = @key + '=' + @type + "\n"
+        @props.keys.sort.each do |key|
+            s += "    #{key}=#{@props[key]}\n"
+        end
+        return s
+    end
+
+    # == merge_props
+    # This method takes a hash, and merges it into the current record. The
+    # hash values will clobber any preexisting properties.
+    def merge_props(props)
+        props.each do |key, val|
+            screen_prop key
+            screen_prop val
+            @props[key] = val
+        end
+        @db.save
+    end
+end

data/test/test.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'smeserver/configdb'
+require 'test/unit'
+require 'fileutils'
+
+include FileUtils
+
+$dbfileorig = File.join(File.dirname(__FILE__), 'configuration')
+$dbfile     = File.join(File.dirname(__FILE__), 'configuration.test')
+$db = nil
+
+class TestConfigDB < Test::Unit::TestCase
+    def setup
+        if File.exists? $dbfile
+            rm $dbfile
+        end
+        if File.exists? $dbfileorig
+            cp $dbfileorig, $dbfile
+        else
+            raise "#{$dbfileorig} does not exist!"
+        end
+
+        $db = ConfigDB.new($dbfile)
+    end
+
+    def test_simple
+        assert_equal(ConfigDB, $db.class)
+    end
+
+    def test_read
+        iface = $db.get('InternalInterface')
+        assert_equal(ConfigDBRecord, iface.class)
+        assert_equal('172.16.98.255', iface.prop('Broadcast'))
+        assert_equal('miimon=200 mode=active-backup',
+                     iface.prop('NICBondingOptions'))
+        assert_equal('servergateway', $db.get('SystemMode').value)
+        assert_equal('servergateway', $db.get_value('SystemMode'))
+        assert_equal('172.16.98.255',
+                     $db.get_prop('InternalInterface', 'Broadcast'))
+        assert_equal(117, $db.get_all.length)
+    end
+
+    def test_write
+        iface = $db.get('InternalInterface')
+        iface.set_prop('IPAddress', '192.168.0.1')
+        $db.reload
+        assert_equal('192.168.0.1',
+                     $db.get_prop('InternalInterface', 'IPAddress'))
+        rec = $db.new_record('foo', 'configuration')
+        props = {
+            'bar'  => 1,
+            'bash' => 2,
+            'biff' => 3,
+        }
+        assert_raise(ConfigDBError) { rec.merge_props(props) }
+        props = {
+            'bar'  => '1',
+            'bash' => '2',
+            'biff' => '3',
+        }
+        assert_nothing_raised() { rec.merge_props(props) }
+        $db.reload
+        assert_equal(118, $db.get_all.length)
+    end
+
+    def test_utilities
+        assert_nothing_raised() { screen_prop 'foobar' }
+        assert_nothing_raised() { screen_prop 'foo bar' }
+        assert_nothing_raised() { screen_prop ' foo bar' }
+    end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: sme-configdb
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+date: 2006-10-16 00:00:00 -04:00
+summary: A db API for the esmith dbs on the SME Server
+require_paths: 
+- lib
+email: msoulier@digitaltorque.ca
+homepage: http://sme-configdb.rubyforge.org
+rubyforge_project: 
+description: A db API for the esmith dbs on the SME Server.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Michael P. Soulier
+files: 
+- lib/smeserver/configdb.rb
+- README
+- ChangeLog
+- test/test.rb
+test_files: 
+- test/test.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+