oca 3.0.1 → 3.2.1

data/lib/OpenNebula.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
 #                                                                            #
 # 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    #
@@ -14,6 +14,7 @@
 # limitations under the License.                                             #
 #--------------------------------------------------------------------------- #
 
+
 begin # require 'rubygems'
     require 'rubygems'
 rescue Exception
@@ -44,18 +45,27 @@ require 'OpenNebula/AclPool'
 
 module OpenNebula
 
-    # -------------------------------------------------------------------------
     # The Error Class represents a generic error in the OpenNebula
     # library. It contains a readable representation of the error.
     # Any function in the OpenNebula module will return an Error
     # object in case of error.
-    # -------------------------------------------------------------------------
     class Error
-        attr_reader :message
-
-        # +message+ a description of the error
-        def initialize(message=nil)
-            @message=message
+        ESUCCESS        = 0x0000
+        EAUTHENTICATION = 0x0100
+        EAUTHORIZATION  = 0x0200
+        ENO_EXISTS      = 0x0400
+        EACTION         = 0x0800
+        EXML_RPC_API    = 0x1000
+        EINTERNAL       = 0x2000
+        ENOTDEFINED     = 0x1111
+
+        attr_reader :message, :errno
+
+        # +message+ Description of the error
+        # +errno+   OpenNebula code error
+        def initialize(message=nil, errno=0x1111)
+            @message = message
+            @errno   = errno
         end
 
         def to_str()
@@ -63,18 +73,14 @@ module OpenNebula
         end
     end
 
-    # -------------------------------------------------------------------------
     # Returns true if the object returned by a method of the OpenNebula
     # library is an Error
-    # -------------------------------------------------------------------------
     def self.is_error?(value)
         value.class==OpenNebula::Error
     end
 
-    # -------------------------------------------------------------------------
     # The client class, represents the connection with the core and handles the
     # xml-rpc calls.
-    # -------------------------------------------------------------------------
     class Client
         attr_accessor :one_auth
 
@@ -85,41 +91,28 @@ module OpenNebula
             XMLPARSER=false
         end
 
-        def initialize(secret=nil, endpoint=nil, hash=true)
+        def initialize(secret=nil, endpoint=nil)
             if secret
-                one_secret = secret
+                @one_auth = secret
             elsif ENV["ONE_AUTH"] and !ENV["ONE_AUTH"].empty? and File.file?(ENV["ONE_AUTH"])
-                one_secret=File.read(ENV["ONE_AUTH"])
+                @one_auth = File.read(ENV["ONE_AUTH"])
             elsif File.file?(ENV["HOME"]+"/.one/one_auth")
-                one_secret=File.read(ENV["HOME"]+"/.one/one_auth")
+                @one_auth = File.read(ENV["HOME"]+"/.one/one_auth")
             else
                 raise "ONE_AUTH file not present"
             end
 
-            tokens = one_secret.chomp.split(':')
-
-            if tokens.length > 2
-                @one_auth = one_secret
-            elsif tokens.length == 2
-                if hash
-                    pass = Digest::SHA1.hexdigest(tokens[1])
-                else
-                    pass = tokens[1]
-                end
-                @one_auth = "#{tokens[0]}:#{pass}"
-            else
-                raise "Authorization file malformed"
-            end
+            @one_auth.rstrip!
 
             if endpoint
-                @one_endpoint=endpoint
+                @one_endpoint = endpoint
             elsif ENV["ONE_XMLRPC"]
-                @one_endpoint=ENV["ONE_XMLRPC"]
+                @one_endpoint = ENV["ONE_XMLRPC"]
             else
-                @one_endpoint="http://localhost:2633/RPC2"
+                @one_endpoint = "http://localhost:2633/RPC2"
             end
 
-            @server=XMLRPC::Client.new2(@one_endpoint)
+            @server = XMLRPC::Client.new2(@one_endpoint)
         end
 
         def call(action, *args)
@@ -132,7 +125,7 @@ module OpenNebula
                 response = @server.call_async("one."+action, @one_auth, *args)
 
                 if response[0] == false
-                    Error.new(response[1])
+                    Error.new(response[1], response[2])
                 else
                     response[1] #response[1..-1]
                 end

data/lib/OpenNebula/Acl.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
 #                                                                            #
 # 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    #
@@ -14,7 +14,9 @@
 # limitations under the License.                                             #
 #--------------------------------------------------------------------------- #
 
+
 module OpenNebula
+
     # Abstract rules of the type USER RESOURCE RIGHTS
     # which are:
     #     USER      -> #<num>
@@ -30,16 +32,10 @@ module OpenNebula
     #                  GROUP
     #                  ACL
     #     RIGHTS    -> + separated list
-    #                  CREATE
-    #                  DELETE
     #                  USE
     #                  MANAGE
-    #                  INFO
-    #                  INFO_POOL
-    #                  INFO_POOL_MINE
-    #                  INSTANTIATE
-    #                  CHOWN
-    #                  DEPLOY
+    #                  ADMIN
+    #                  CREATE
     class Acl < PoolElement
 
         USERS = {
@@ -61,16 +57,10 @@ module OpenNebula
 
         RIGHTS =
         {
-            "CREATE"        => 0x1,  # Auth. to create an object
-            "DELETE"        => 0x2,  # Auth. to delete an object
-            "USE"           => 0x4,  # Auth. to use an object
-            "MANAGE"        => 0x8,  # Auth. to manage an object
-            "INFO"          => 0x10, # Auth. to view an object
-            "INFO_POOL"     => 0x20, # Auth. to view any object in the pool
-            "INFO_POOL_MINE"=> 0x40, # Auth. to view user and/or group objects
-            "INSTANTIATE"   => 0x80, # Auth. to instantiate a VM from a TEMPLATE
-            "CHOWN"         => 0x100,# Auth. to change ownership of an object
-            "DEPLOY"        => 0x200 # Auth. to deploy a VM in a Host
+            "USE"           => 0x1,  # Auth. to use an object
+            "MANAGE"        => 0x2,  # Auth. to perform management actions
+            "ADMIN"         => 0x4,  # Auth. to perform administrative actions
+            "CREATE"        => 0x8   # Auth. to create an object
         }
 
         # Constructor

data/lib/OpenNebula/AclPool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
 #                                                                            #
 # 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    #
@@ -14,6 +14,7 @@
 # limitations under the License.                                             #
 #--------------------------------------------------------------------------- #
 
+
 require 'OpenNebula/Pool'
 
 module OpenNebula
@@ -22,15 +23,15 @@ module OpenNebula
         #######################################################################
         # Constants and Class Methods
         #######################################################################
+
+
         ACL_POOL_METHODS = {
             :info       => "acl.info",
             :addrule    => "acl.addrule",
             :delrule    => "acl.delrule"
         }
 
-        #######################################################################
         # Class constructor
-        #######################################################################
         def initialize(client)
             super('ACL_POOL','ACL',client)
         end

data/lib/OpenNebula/Group.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
 #                                                                            #
 # 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    #
@@ -14,13 +14,16 @@
 # limitations under the License.                                             #
 #--------------------------------------------------------------------------- #
 
+
 require 'OpenNebula/Pool'
 
 module OpenNebula
     class Group < PoolElement
-        # ---------------------------------------------------------------------
+        #######################################################################
         # Constants and Class Methods
-        # ---------------------------------------------------------------------
+        #######################################################################
+
+
         GROUP_METHODS = {
             :info       => "group.info",
             :allocate   => "group.allocate",
@@ -54,18 +57,14 @@ module OpenNebula
             XMLElement.build_xml(group_xml,'GROUP')
         end
 
-        # ---------------------------------------------------------------------
         # Class constructor
-        # ---------------------------------------------------------------------
         def initialize(xml, client)
             super(xml,client)
-
-            @client = client
         end
-        
-        # --------------------------------------------------------------------
+
+        #######################################################################
         # Group utils
-        # --------------------------------------------------------------------
+        #######################################################################
 
         # Creates ACLs for the group. The ACL rules are described in a file
         def create_acls(filename = GROUP_DEFAULT)
@@ -74,7 +73,7 @@ module OpenNebula
             end
 
             msg = String.new
-            
+
             File.open(filename).each_line{ |l|
                 next if l.match(/^#/)
 
@@ -100,9 +99,9 @@ module OpenNebula
             return 0, msg
         end
 
-        # ---------------------------------------------------------------------
+        #######################################################################
         # XML-RPC Methods for the Group Object
-        # ---------------------------------------------------------------------
+        #######################################################################
 
         # Retrieves the information of the given Group.
         def info()
@@ -127,8 +126,8 @@ module OpenNebula
 
         # Returns whether or not the user with id 'uid' is part of this group
         def contains(uid)
-            # This doesn't work in ruby 1.8.5
-#            return self["USERS/ID[.=#{uid}]"] != nil
+            #This doesn't work in ruby 1.8.5
+            #return self["USERS/ID[.=#{uid}]"] != nil
 
             id_array = retrieve_elements('USERS/ID')
             return id_array != nil && id_array.include?(uid.to_s)

data/lib/OpenNebula/GroupPool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
 #                                                                            #
 # 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    #
@@ -14,21 +14,23 @@
 # limitations under the License.                                             #
 #--------------------------------------------------------------------------- #
 
+
 require 'OpenNebula/Pool'
 
 module OpenNebula
     class GroupPool < Pool
-        # ---------------------------------------------------------------------
+        #######################################################################
         # Constants and Class attribute accessors
-        # ---------------------------------------------------------------------
+        #######################################################################
+
 
         GROUP_POOL_METHODS = {
             :info => "grouppool.info"
         }
 
-        # ---------------------------------------------------------------------
+        #######################################################################
         # Class constructor & Pool Methods
-        # ---------------------------------------------------------------------
+        #######################################################################
 
         # +client+ a Client object that represents a XML-RPC connection
         def initialize(client)
@@ -40,13 +42,13 @@ module OpenNebula
             OpenNebula::Group.new(element_xml,@client)
         end
 
-        # ---------------------------------------------------------------------
+        #######################################################################
         # XML-RPC Methods for the User Object
-        # ---------------------------------------------------------------------
+        #######################################################################
 
         # Retrieves all the Groups in the pool.
         def info()
             super(GROUP_POOL_METHODS[:info])
         end
     end
-end
+end

data/lib/OpenNebula/Host.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
 #                                                                            #
 # 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    #
@@ -14,6 +14,7 @@
 # limitations under the License.                                             #
 #--------------------------------------------------------------------------- #
 
+
 require 'OpenNebula/Pool'
 
 module OpenNebula
@@ -21,6 +22,8 @@ module OpenNebula
         #######################################################################
         # Constants and Class Methods
         #######################################################################
+
+
         HOST_METHODS = {
             :info     => "host.info",
             :allocate => "host.allocate",
@@ -56,9 +59,7 @@ module OpenNebula
             XMLElement.build_xml(host_xml, 'HOST')
         end
 
-        #######################################################################
         # Class constructor
-        #######################################################################
         def initialize(xml, client)
             super(xml,client)
 
@@ -77,15 +78,15 @@ module OpenNebula
 
         # Allocates a new Host in OpenNebula
         #
-        # +hostname+ A string containing the name of the new Host.
-        #
-        # +im+ A string containing the name of the im_driver
-        #
-        # +vmm+ A string containing the name of the vmm_driver
+        # @param hostname [String] Name of the new Host.
+        # @param im [String] Name of the im_driver
+        # @param vmm [String] Name of the vmm_driver
+        # @param tm [String] Name of the tm_driver
         #
-        # +tm+ A string containing the name of the tm_driver
-        def allocate(hostname,im,vmm,tm)
-            super(HOST_METHODS[:allocate],hostname,im,vmm,tm)
+        # @return [Integer, OpenNebula::Error] the new VM ID in case of
+        #   success, error otherwise
+        def allocate(hostname,im,vmm,vnm,tm)
+            super(HOST_METHODS[:allocate],hostname,im,vmm,vnm,tm)
         end
 
         # Deletes the Host

data/lib/OpenNebula/HostPool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
 #                                                                            #
 # 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    #
@@ -14,6 +14,7 @@
 # limitations under the License.                                             #
 #--------------------------------------------------------------------------- #
 
+
 require 'OpenNebula/Pool'
 
 module OpenNebula
@@ -22,6 +23,7 @@ module OpenNebula
         # Constants and Class attribute accessors
         #######################################################################
 
+
         HOST_POOL_METHODS = {
             :info => "hostpool.info"
         }
@@ -29,7 +31,8 @@ module OpenNebula
         #######################################################################
         # Class constructor & Pool Methods
         #######################################################################
-        
+
+
         # +client+ a Client object that represents a XML-RPC connection
         def initialize(client)
             super('HOST_POOL','HOST',client)

data/lib/OpenNebula/Image.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
 #                                                                            #
 # 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    #
@@ -14,23 +14,27 @@
 # limitations under the License.                                             #
 #--------------------------------------------------------------------------- #
 
+
 require 'OpenNebula/Pool'
 require 'fileutils'
 
 module OpenNebula
     class Image < PoolElement
-        # ---------------------------------------------------------------------
+        #######################################################################
         # Constants and Class Methods
-        # ---------------------------------------------------------------------
+        #######################################################################
+
+
         IMAGE_METHODS = {
             :info        => "image.info",
             :allocate    => "image.allocate",
             :update      => "image.update",
             :enable      => "image.enable",
-            :publish     => "image.publish",
             :persistent  => "image.persistent",
             :delete      => "image.delete",
-            :chown       => "image.chown"
+            :chown       => "image.chown",
+            :chmod       => "image.chmod",
+            :chtype      => "image.chtype"
         }
 
         IMAGE_STATES=%w{INIT READY USED DISABLED LOCKED ERROR}
@@ -118,7 +122,7 @@ module OpenNebula
         def unpublish
             set_publish(false)
         end
-        
+
         # Makes the Image persistent
         def persistent
             set_persistent(true)
@@ -142,6 +146,39 @@ module OpenNebula
             super(IMAGE_METHODS[:chown], uid, gid)
         end
 
+        # Changes the Image permissions.
+        #
+        # @param octet [String] Permissions octed , e.g. 640
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def chmod_octet(octet)
+            super(IMAGE_METHODS[:chmod], octet)
+        end
+
+        # Changes the Image permissions.
+        # Each [Integer] argument must be 1 to allow, 0 deny, -1 do not change
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u,
+                other_m, other_a)
+            super(IMAGE_METHODS[:chmod], owner_u, owner_m, owner_a, group_u,
+                group_m, group_a, other_u, other_m, other_a)
+        end
+
+        # Changes the Image type
+        # @param type [String] new Image type
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def chtype(type)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(IMAGE_METHODS[:chtype], @pe_id, type)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
         #######################################################################
         # Helpers to get Image information
         #######################################################################
@@ -182,6 +219,14 @@ module OpenNebula
             self['GID'].to_i
         end
 
+        def public?
+            if self['PERMISSIONS/GROUP_U'] == "1" || self['PERMISSIONS/OTHER_U'] == "1"
+                true
+            else
+                false
+            end
+        end
+
     private
 
         def set_enabled(enabled)
@@ -194,12 +239,9 @@ module OpenNebula
         end
 
         def set_publish(published)
-            return Error.new('ID not defined') if !@pe_id
+            group_u = published ? 1 : 0
 
-            rc = @client.call(IMAGE_METHODS[:publish], @pe_id, published)
-            rc = nil if !OpenNebula.is_error?(rc)
-
-            return rc
+            chmod(-1, -1, -1, group_u, -1, -1, -1, -1, -1)
         end
         
         def set_persistent(persistence)