#
# Copyright (c) 2005-2006, John Mettraux, OpenWFE.org
# All rights reserved.
# 
# Redistribution and use in source and binary forms, with or without 
# modification, are permitted provided that the following conditions are met:
# 
# . Redistributions of source code must retain the above copyright notice, this
#   list of conditions and the following disclaimer.  
# 
# . Redistributions in binary form must reproduce the above copyright notice, 
#   this list of conditions and the following disclaimer in the documentation 
#   and/or other materials provided with the distribution.
# 
# . Neither the name of the "OpenWFE" nor the names of its contributors may be
#   used to endorse or promote products derived from this software without
#   specific prior written permission.
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
# POSSIBILITY OF SUCH DAMAGE.
#
# $Id: utils.rb 3454 2006-10-08 16:51:00Z jmettraux $
#

#
# "hecho en Costa Rica"
#
# john.mettraux@openwfe.org
#

module OpenWFE

    #
    # Returns the first subelt of xmlElt that matches the given xpath.
    # If xpath is null, the first elt will be returned.
    #
    def OpenWFE.firstElement (xmlElt, elementName=nil)

        return nil if not xmlElt

        return xmlElt.elements[1] if not elementName

        xmlElt.elements.each do |elt|
            return elt if elt.name == elementName
        end

        return nil
    end

    #
    # Used in tests, is equivalent to Perl's die() method.
    #
    def OpenWFE.die (text)
        puts text
        exit 1
    end

    #
    # Attempts a deep cloning of the object
    #
    def OpenWFE.copy (object)

        return nil if object == nil

        if object.kind_of?(Array)
            result = []
            object.each do |i|
                result << copy(i)
            end
            return result
        end

        if object.kind_of?(Hash)
            result = {}
            object.each do |k, v|
                result[copy(k)] = copy(v)
            end
            return result
        end

        return object.dup
    end

end