opennebula 3.9.80.beta

data/lib/opennebula/document_json.rb

@@ -0,0 +1,131 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2013, 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 'json'
+
+module OpenNebula
+    class DocumentJSON < Document
+
+        TEMPLATE_TAG = "BODY"
+
+        # Allocate a new Document containing the json inside the TEMPLATE
+        #
+        # @param [String] template_json json to be inserted in the TEMPLATE
+        #   of the new resource
+        # @param [String, nil] name name of the object, this value will be
+        #   processed by the OpenNebula core
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        #
+        def allocate(template_json, name=nil)
+            text = build_template_xml(template_json, name)
+
+            super(text)
+        end
+
+        # Retrieves the information of the Service and all its Nodes.
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        #
+        def info
+            rc = super
+            if OpenNebula.is_error?(rc)
+                return rc
+            end
+
+            load_body
+        end
+
+        alias_method :info!, :info
+
+        # Updates the current state of this Service in the OpenNebula DB
+        #
+        # @params [String, nil] template_json string to be inserted in the
+        #   template. If nil @body will be used instead
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        #
+        def update(template_json=nil)
+            template_json ||= @body.to_json
+
+            text = build_template_xml(template_json)
+
+            super(text)
+        end
+
+        # Generates a json representing the object
+        #
+        # @param [true, false] pretty_generate
+        # @return [String] json representing the object
+        #
+        def to_json(pretty_generate=true)
+            hash = self.to_hash
+
+            body = hash['DOCUMENT']['TEMPLATE']["#{TEMPLATE_TAG}"]
+            if body
+                body_hash = JSON.parse(body)
+                hash['DOCUMENT']['TEMPLATE']["#{TEMPLATE_TAG}"] = body_hash
+            end
+
+            if pretty_generate
+                JSON.pretty_generate hash
+            else
+                hash.to_json
+            end
+        end
+
+
+        # Fill the @body hash with the values of the template
+        def load_body
+            body_str = self["TEMPLATE/#{TEMPLATE_TAG}"]
+
+            if body_str
+                begin
+                    @body = JSON.parse(body_str)
+                rescue JSON::JSONError
+                    return OpenNebula::Error.new($!)
+                end
+            end
+
+            return nil
+        end
+
+        private
+
+        # Build an xml string incluiding the provided json
+        #
+        # @param [String] template_json The template to be inserted
+        # @param [String, nil] name The string to be inserted as name
+        # @return [String] The xml containing the json
+        #
+        def build_template_xml(template_json, name=nil)
+            template_json ||= ""
+
+            text = "<TEMPLATE>"
+
+            text << "<NAME>#{name}</NAME>" if name
+
+            text << "<#{TEMPLATE_TAG}>"
+            text << "<![CDATA[#{template_json}]]>"
+            text << "</#{TEMPLATE_TAG}>"
+
+            text << "</TEMPLATE>"
+
+            text
+        end
+    end
+end

data/lib/opennebula/document_pool.rb

@@ -0,0 +1,102 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2013, 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'
+
+module OpenNebula
+
+    # All subclasses must define the DOCUMENT_TYPE constant
+    # and the factory method.
+    #
+    # @example
+    #   require 'opennebuña/document_pool'
+    #
+    #   module OpenNebula
+    #       class CustomObjectPool < DocumentPool
+    #
+    #           DOCUMENT_TYPE = 400
+    #
+    #           def factory(element_xml)
+    #               OpenNebula::CustomObject.new(element_xml, @client)
+    #           end
+    #       end
+    #   end
+    class DocumentPool < Pool
+
+        #######################################################################
+        # Constants and Class attribute accessors
+        #######################################################################
+
+        DOCUMENT_POOL_METHODS = {
+            :info => "documentpool.info"
+        }
+
+        #######################################################################
+        # Class constructor & Pool Methods
+        #######################################################################
+
+        # Class constructor
+        #
+        # @param [OpenNebula::Client] client the xml-rpc client
+        # @param [Integer] user_id the filter flag, see
+        #   http://opennebula.org/documentation:rel3.6:api
+        #
+        # @return [DocumentPool] the new object
+        def initialize(client, user_id=-1)
+            super('DOCUMENT_POOL','DOCUMENT',client)
+
+            @user_id  = user_id
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the Document Object
+        #######################################################################
+
+        # Retrieves all or part of the Documents in the pool.
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def info(*args)
+            case args.size
+                when 0
+                    info_filter(DOCUMENT_POOL_METHODS[:info],@user_id,-1,-1, document_type)
+                when 3
+                    info_filter(DOCUMENT_POOL_METHODS[:info],args[0],args[1],args[2], document_type)
+            end
+        end
+
+        def info_all()
+            return super(DOCUMENT_POOL_METHODS[:info], document_type)
+        end
+
+        def info_mine()
+            return super(DOCUMENT_POOL_METHODS[:info], document_type)
+        end
+
+        def info_group()
+            return super(DOCUMENT_POOL_METHODS[:info], document_type)
+        end
+
+        alias_method :info!, :info
+        alias_method :info_all!, :info_all
+        alias_method :info_mine!, :info_mine
+        alias_method :info_group!, :info_group
+
+        def document_type
+            self.class::DOCUMENT_TYPE
+        end
+    end
+end

data/lib/opennebula/document_pool_json.rb

@@ -0,0 +1,58 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2013, 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.                                             #
+#--------------------------------------------------------------------------- #
+
+module OpenNebula
+    class DocumentPoolJSON < DocumentPool
+
+        TEMPLATE_TAG = "BODY"
+
+        def factory(element_xml)
+            doc = OpenNebula::DocumentJSON.new(element_xml, @client)
+            doc.load_body
+            doc
+        end
+
+        # Generates a json representing the object
+        #
+        # @param [true, false] pretty_generate
+        # @return [String] json representing the object
+        #
+        def to_json(pretty_generate=true)
+            hash = self.to_hash
+
+            if hash['DOCUMENT_POOL'] && hash['DOCUMENT_POOL']['DOCUMENT']
+                if !hash['DOCUMENT_POOL']['DOCUMENT'].instance_of?(Array)
+                    array = [hash['DOCUMENT_POOL']['DOCUMENT']]
+                    hash['DOCUMENT_POOL']['DOCUMENT'] = array.compact
+                end
+
+                hash['DOCUMENT_POOL']['DOCUMENT'].each { |doc|
+                    body = doc['TEMPLATE']["#{TEMPLATE_TAG}"]
+                    if body
+                        b_hash = JSON.parse(body)
+                        doc['TEMPLATE']["#{TEMPLATE_TAG}"] = b_hash
+                    end
+                }
+            end
+
+            if pretty_generate
+                JSON.pretty_generate hash
+            else
+                hash.to_json
+            end
+        end
+    end
+end

data/lib/opennebula/error.rb

@@ -0,0 +1,52 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2013, 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.                                             #
+#--------------------------------------------------------------------------- #
+
+
+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
+        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()
+            @message
+        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
+end

data/lib/opennebula/group.rb

@@ -0,0 +1,163 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2013, 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 Group < PoolElement
+        #######################################################################
+        # Constants and Class Methods
+        #######################################################################
+
+        GROUP_METHODS = {
+            :info     => "group.info",
+            :allocate => "group.allocate",
+            :delete   => "group.delete",
+            :quota    => "group.quota"
+        }
+
+        # Flag for requesting connected user's group info
+        SELF = -1
+
+        #Default location for group ACL's
+        if ENV['ONE_LOCATION']
+            GROUP_DEFAULT = ENV['ONE_LOCATION'] + "/etc/group.default"
+        else
+            GROUP_DEFAULT = "/etc/one/group.default"
+        end
+
+        # Creates a Group description with just its identifier
+        # this method should be used to create plain Group objects.
+        # +id+ the id of the user
+        #
+        # Example:
+        #   group = Group.new(Group.build_xml(3),rpc_client)
+        #
+        def Group.build_xml(pe_id=nil)
+            if pe_id
+                group_xml = "<GROUP><ID>#{pe_id}</ID></GROUP>"
+            else
+                group_xml = "<GROUP></GROUP>"
+            end
+
+            XMLElement.build_xml(group_xml,'GROUP')
+        end
+
+        # Class constructor
+        def initialize(xml, client)
+            super(xml,client)
+        end
+
+        #######################################################################
+        # Group utils
+        #######################################################################
+
+        # Creates ACLs for the group. The ACL rules are described in a file
+        def create_acls(filename = GROUP_DEFAULT)
+            if !File.readable?(filename)
+                return -1, "Cannot read deafult ACL file for group"
+            end
+
+            msg = String.new
+
+            File.open(filename).each_line{ |l|
+                next if l.match(/^#/)
+
+                rule  = "@#{@pe_id} #{l}"
+                parse = OpenNebula::Acl.parse_rule(rule)
+
+                if OpenNebula.is_error?(parse)
+                    return -1, "Error parsing rule #{rule}: #{parse.message}"
+                end
+
+                xml = OpenNebula::Acl.build_xml
+                acl = OpenNebula::Acl.new(xml, @client)
+
+                rc = acl.allocate(*parse)
+
+                if OpenNebula.is_error?(rc)
+                    return -1, "Error creating rule #{rule}: #{rc.message}"
+                else
+                    msg << "ACL_ID: #{acl.id}\n"
+                end
+            }
+
+            return 0, msg
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the Group Object
+        #######################################################################
+
+        # Retrieves the information of the given Group.
+        def info()
+            super(GROUP_METHODS[:info], 'GROUP')
+        end
+
+        alias_method :info!, :info
+
+        # Allocates a new Group in OpenNebula
+        #
+        # +groupname+ A string containing the name of the Group.
+        def allocate(groupname)
+            super(GROUP_METHODS[:allocate], groupname)
+        end
+
+        # Deletes the Group
+        def delete()
+            super(GROUP_METHODS[:delete])
+        end
+
+        # Sets the group 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)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(GROUP_METHODS[:quota],@pe_id, quota)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+        # ---------------------------------------------------------------------
+        # Helpers to get information
+        # ---------------------------------------------------------------------
+
+        # 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
+
+            id_array = retrieve_elements('USERS/ID')
+            return id_array != nil && id_array.include?(uid.to_s)
+        end
+
+        # Returns an array with the numeric user ids
+        def user_ids
+            array = Array.new
+
+            self.each("USERS/ID") do |id|
+                array << id.text.to_i
+            end
+
+            return array
+        end
+    end
+end