opennebula 4.4.0 → 4.5.80.beta

data/lib/opennebula/group_pool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/host.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/host_pool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/image.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/image_pool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/ldap_auth.rb

@@ -1,5 +1,5 @@
 # ---------------------------------------------------------------------------- #
-# Copyright 2010-2013, C12G Labs S.L                                           #
+# Copyright 2010-2014, C12G Labs S.L                                           #
 #                                                                              #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may      #
 # not use this file except in compliance with the License. You may obtain      #

data/lib/opennebula/ldap_auth_spec.rb

@@ -1,5 +1,5 @@
 # ---------------------------------------------------------------------------- #
-# Copyright 2010-2013, C12G Labs S.L                                           #
+# Copyright 2010-2014, C12G Labs S.L                                           #
 #                                                                              #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may      #
 # not use this file except in compliance with the License. You may obtain      #

data/lib/opennebula/oneflow_client.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2010-2013, C12G Labs S.L.                                        #
+# Copyright 2010-2014, C12G Labs S.L.                                        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/pool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #
@@ -24,6 +24,9 @@ module OpenNebula
         include Enumerable
         alias_method :each_with_xpath, :each
 
+        PAGINATED_POOLS=%w{VM_POOL IMAGE_POOL TEMPLATE_POOL VN_POOL
+                           DOCUMENT_POOL}
+
     protected
         #pool:: _String_ XML name of the root element
         #element:: _String_ XML name of the Pool elements
@@ -156,5 +159,58 @@ module OpenNebula
 
             return str
         end
+
+        # Gets a hash from a pool
+        #
+        # size:: nil => default page size
+        #        < 2 => not paginated
+        #        >=2 => page size
+        #
+        # The default page size can be changed with the environment variable
+        # ONE_POOL_PAGE_SIZE. Any value > 2 will set a page size, a non
+        # numeric value disables pagination.
+        def get_hash(size=nil)
+            allow_paginated = PAGINATED_POOLS.include?(@pool_name)
+
+            if OpenNebula.pool_page_size && allow_paginated &&
+                    ( ( size && size >= 2 ) || !size )
+                size = OpenNebula.pool_page_size if !size
+                hash=info_paginated(size)
+
+                return hash if OpenNebula.is_error?(hash)
+                { @pool_name => { @element_name => hash } }
+            else
+                rc=info
+                return rc if OpenNebula.is_error?(rc)
+                to_hash
+            end
+        end
+
+        # Gets a pool in hash form using pagination
+        #
+        # size:: _Integer_ size of each page
+        def info_paginated(size)
+            array=Array.new
+            current=0
+
+            parser=ParsePoolSax.new(@pool_name, @element_name)
+
+            while true
+                a=@client.call("#{@pool_name.delete('_').downcase}.info",
+                    -2, current, -size, -1)
+                return a if OpenNebula.is_error?(a)
+
+                a_array=parser.parse(a)
+
+                array += a_array
+                current += size
+                break if !a || a_array.length<size
+            end
+
+            array.compact!
+            array=nil if array.length == 0
+
+            array
+        end
     end
 end

data/lib/opennebula/pool_element.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/server_cipher_auth.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/server_x509_auth.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/ssh_auth.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/system.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/template.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/template_pool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/user.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #
@@ -172,8 +172,8 @@ module OpenNebula
         end
 
         # Sets the user quota limits
-        # @param quota [String] a template (XML or txt) with the new quota limits 
-        # 
+        # @param quota [String] a template (XML or txt) with the new quota limits
+        #
         # @return [nil, OpenNebula::Error] nil in case of success, Error
         #   otherwise
         def set_quota(quota)
@@ -194,5 +194,12 @@ module OpenNebula
         def gid
             self['GID'].to_i
         end
+
+        # Returns a list with all the group IDs for the user including primary
+        # [return] _Array_ with the group ID's (as integers)
+        def groups
+            all_groups = self.retrieve_elements("GROUPS/ID")
+            all_groups.collect! {|x| x.to_i}
+        end
     end
 end

data/lib/opennebula/user_pool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/virtual_machine.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/virtual_machine_pool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/virtual_network.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/virtual_network_pool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/x509_auth.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/xml_element.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #

data/lib/opennebula/xml_pool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #
@@ -17,6 +17,7 @@
 require 'opennebula/xml_element'
 
 module OpenNebula
+
     # The XMLUtilsPool module provides an abstraction of the underlying
     # XML parser engine. It provides XML-related methods for the Pools
     class XMLPool < XMLElement

data/lib/opennebula/xml_utils.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #
@@ -25,10 +25,113 @@ module OpenNebula
         NOKOGIRI=false
     end
 
+    begin
+        require 'ox'
+        OX=true
+    rescue LoadError
+        OX=false
+    end
+
     begin
         require 'rexml/formatters/pretty'
         REXML_FORMATTERS=true
     rescue LoadError
         REXML_FORMATTERS=false
     end
+
+    # Utilities to parse pools with sax (Nokogiri and Ox)
+
+    # vmpool, imagepool, templatepool, vnpool, documentpool
+
+    module ParsePoolBase
+        attr_accessor :pool
+
+        def initialize (pool_name, elem_name)
+            @current = 0
+            @levels  = [{}]
+            @pool    = Array.new
+
+            @pool_name = pool_name
+            @elem_name = elem_name
+        end
+
+        def start_element(name, attrs = [])
+            return if name == @pool_name
+            @value = nil
+
+            @current = @current + 1
+
+            @levels[@current] = Hash.new if @levels[@current].nil?
+        end
+
+        def characters(s)
+            @value = s
+        end
+
+        def end_element(name)
+            if @levels[@current].empty?
+                @levels[@current-1][name] = @value || {}
+            else
+                @levels[@current-1][name] = @levels[@current]
+                @levels[@current] = Hash.new
+            end
+
+            if name == @elem_name
+                @pool << @levels[0][@elem_name]
+
+                @current   = 0
+                @levels[0] = Hash.new
+            else
+                @current = @current -1
+            end
+        end
+    end
+
+    class ParsePoolSaxBase
+        def initialize(pool_name, elem_name)
+            @pool_sax=ParsePoolSax::PoolSax.new(pool_name, elem_name)
+        end
+
+        def parse(str)
+            @pool_sax.pool.clear
+            sax_parse(str)
+            @pool_sax.pool
+        end
+    end
+
+    if OX
+        class ParsePoolSax < ParsePoolSaxBase
+            def sax_parse(str)
+                Ox.sax_parse(@pool_sax, StringIO.new(str),
+                    :symbolize => false,
+                    :convert_special => true)
+            end
+
+            class PoolSax < Ox::Sax
+                include ParsePoolBase
+
+                alias :text :characters
+                alias :cdata :characters
+            end
+        end
+    elsif NOKOGIRI
+        class ParsePoolSax < ParsePoolSaxBase
+            def initialize(pool_name, elem_name)
+                super(pool_name, elem_name)
+                @parser = Nokogiri::XML::SAX::Parser.new(@pool_sax)
+            end
+
+            def sax_parse(str)
+                @parser.parse(str)
+            end
+
+            class PoolSax < Nokogiri::XML::SAX::Document
+                include ParsePoolBase
+
+                alias :cdata_block :characters
+            end
+        end
+    else
+        raise "nokogiri gem not installed."
+    end
 end

data/lib/opennebula/zone.rb

@@ -0,0 +1,107 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2014, OpenNebula Project (OpenNebula.org), C12G Labs        #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+
+require 'opennebula/pool_element'
+
+module OpenNebula
+    class Zone < PoolElement
+        #######################################################################
+        # Constants and Class Methods
+        #######################################################################
+
+        ZONE_METHODS = {
+            :info           => "zone.info",
+            :allocate       => "zone.allocate",
+            :update         => "zone.update",
+            :rename         => "zone.rename",
+            :delete         => "zone.delete"
+        }
+
+        # Creates a Zone description with just its identifier
+        # this method should be used to create plain Zone objects.
+        # @param id [Integer] the id of the Zone
+        #
+        # Example:
+        #   zone = Zone.new(Zone.build_xml(3),rpc_client)
+        #
+        def Zone.build_xml(pe_id=nil)
+            if pe_id
+                zone_xml = "<ZONE><ID>#{pe_id}</ID></ZONE>"
+            else
+                zone_xml = "<ZONE></ZONE>"
+            end
+
+            XMLElement.build_xml(zone_xml,'ZONE')
+        end
+
+        # Class constructor
+        def initialize(xml, client)
+            super(xml,client)
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the Zone Object
+        #######################################################################
+
+        # Retrieves the information of the given Zone.
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def info()
+            super(ZONE_METHODS[:info], 'ZONE')
+        end
+
+        alias_method :info!, :info
+
+        # Allocates a new Zone in OpenNebula
+        #
+        # @param description [String] The template of the Zone.
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def allocate(description)
+            super(ZONE_METHODS[:allocate], description)
+        end
+
+        # Replaces the template contents
+        #
+        # @param new_template [String] New template contents
+        # @param append [true, false] True to append new attributes instead of
+        #   replace the whole template
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def update(new_template=nil, append=false)
+            super(ZONE_METHODS[:update], new_template, append ? 1 : 0)
+        end       
+
+        # Deletes the Zone
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def delete()
+            super(ZONE_METHODS[:delete])
+        end
+
+        # Renames this Zone
+        #
+        # @param name [String] New name for the Zone.
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def rename(name)
+            return call(ZONE_METHODS[:rename], @pe_id, name)
+        end
+    end
+end