def set_node_state (database_nodeobject, end_state):
  """
  <Purpose>
    given a list of vessels, change the userkeys of all the vessels.
    Only one of the vessel should carry the end_state, all other vessels
    will have empty state as transitional state. Keep in mind that the 
    userkey_list contains the transitional state of the node.
  
  <Arguments>
    end_state - the state that the node should end in.

    database_nodeobject - an object that has been retrieved from the database

  <Exceptions>
    NodeError - raised if unable to change node state
    
    NodemanagerCommunicationError - incase we are unable to retrieve node_info

  <Side Effects>
    None

  <Return>
    None
  """

  # Convert the end_state pubkey to string format and then set the key.
  final_state_str = _do_rsa_publickey_to_string(end_state)

  # Try to change the node state by setting the new state in the
  # userkeys list of the extra vessel
  try:
    backend.set_vessel_user_keylist(database_nodeobject, database_nodeobject.extra_vessel_name, [final_state_str])
  except:
    raise NodeError("Unable to change state of node: " + database_nodeobject.node_identifier + 
                    " "+traceback.format_exc())
  log("Successfully changed the node state to "+str(end_state))
def split_vessels (node_string, node_info, database_nodeobject, resourcetemplate):
  """
  <Purpose>
    The purpose of this function is to take a node has an extra vessel that is
    big enough to be split into two or more vessels. The resources on a vessel
    is determined by the resourcetemplate that is provided as well as the usable
    ports on the node.

  <Arguments>
    node_string - the name of the node. ip:port or NAT:port

    node_info - a dictionary containing information about the node

    database_nodeobject - a database object for the node

    resourcetemplate - the file that has information about resources

  <Exceptions>
    NodeError - Error raised if node is not in the right state

    NodemanagerCommunicationError - raised if we cannot retrieve the usable ports for a node

    NodeProcessError - raised if unable to split vessels properly

    DatabaseError - raised if unable to modify the database

  <Side Effects>
    Database gets modified.

  <Return>
    None
  """

  log("Beginning to divide vessel on node: "+node_string)

  # Extract the ip/NAT and the port.
  # Note that the first portion of the node might be an ip or a NAT string.
  (ip_or_nat_string, port_num) = split_node_string(node_string)

  donated_vesselname = database_nodeobject.extra_vessel_name

  # Retrieve the usable ports list for the node and then shuffle
  # the ports so each vessel gets a random subset of the ports
  usable_ports_list = nodemanager.get_vessel_resources(ip_or_nat_string, port_num, donated_vesselname)['usableports']
  log("List of usable ports in node: "+node_string+". "+str(usable_ports_list))
  random.shuffle(usable_ports_list)

  #the vessel that we start with
  current_vessel = donated_vesselname
  log("Name of starting vessel: "+current_vessel)

  # Keep splittiing the vessel until we run out of resources.
  # Note that when split_vessel is called the left vessel
  # has the leftover (extra vessel)and the right vessel has
  # the vessel with the exact resources.
  while len(usable_ports_list) >= 10:
    desired_resourcedata = get_resource_data(resourcetemplate, usable_ports_list)

    #use the first 10 ports so remove them from the list of usable_ports_list
    used_ports_list = usable_ports_list[:10]
    usable_ports_list = usable_ports_list[10:]

    log("Ports we are going to use for the new vessel: "+str(used_ports_list))
    log("Starting to split vessel: "+current_vessel)

    # Split the current vessel. The exact vessel is the right vessel
    # and the extra vessel is the left vessel.
    try:
      leftover_vessel, new_vessel = backend.split_vessel(database_nodeobject, current_vessel, desired_resourcedata)
    except NodemanagerCommunicationError, e:
      # The object 'e' will already include traceback info that has the actual node error.
      # If the failure is due to inability to split further, that's ok.
      if 'Insufficient quantity:' in str(e):
        log("Could not split " + current_vessel + " any further due to insufficient resource/quantity. " + str(e))
        # We must break out of the while loop here. If we let the exception get,
        # raised, it will look like the transition failed.
        break
      raise

    log("Successfully split vessel: "+current_vessel+" into vessels: "+leftover_vessel+" and "+new_vessel)
    current_vessel = leftover_vessel

    # Make sure to update the database and record the new
    # name of the extra vessel as when backend.split_vessels()
    # is called, the old vessel does not exist anymore.
    # Instead two new vessels are created, where the first
    # vessel is the extra vessel with leftover resources
    # and the second vessel has the actual amount of resources
    maindb.set_node_extra_vessel_name(database_nodeobject, current_vessel)

    # Set the user_list for the new vesel to be empty. Remember that user_list is what determines
    # the transition state, and only the extra vessel should have this set.
    backend.set_vessel_user_keylist(database_nodeobject, new_vessel, [])
    log("Changed the userkeys for the vessel "+new_vessel+" to []")

    # Add the newly created vessel to the database and then add the ports associated with
    # the vessel to the database also.
    log("Creating a vessel record in the database for vessel "+new_vessel+" for node "+node_string)
    try:
      vessel_object = maindb.create_vessel(database_nodeobject, new_vessel)
      log("Setting the vessel ports in the database for vessel "+new_vessel+" with port list: "+str(used_ports_list))
      maindb.set_vessel_ports(vessel_object, used_ports_list)
    except:
      raise DatabaseError("Failed to create vessel entry or change vessel entry for vessel: " +
                          new_vessel + ". " + traceback.format_exc())
def onepercentmanyevents_divide(node_string, node_info, database_nodeobject,
                                onepercent_resourcetemplate):
    """
  <Purpose>
    The purpose of this function is to take a node thats in canonical state
    with one vessel, and split it into the 1% vessels so the vessels can
    be acquired by users.

  <Arguments>
    node_string - the name of the node. ip:port or NAT:port

    node_info - a dictionary containing information about the node

    database_nodeobject - a database object for the node
 
    onepercent_resourcetemplate - the file that has information about resources

  <Exceptions>
    NodeError - Error raised if node is not in the right state 

    NodemanagerCommunicationError - raised if we cannot retrieve the usable ports for a node

    NodeProcessError - raised if unable to split vessels properly

    DatabaseError - raised if unable to modify the database    

  <Side Effects>
    Database gets modified.        

  <Return>
    None
  """

    node_transition_lib.log("Beginning onepercentmanyevents_divide on node: " +
                            node_string)

    # Extract the ip/NAT and the port.
    # Note that the first portion of the node might be an ip or a NAT string.
    (ip_or_nat_string,
     port_num) = node_transition_lib.split_node_string(node_string)

    donated_vesselname = database_nodeobject.extra_vessel_name

    # Retrieve the usable ports list for the node and then shuffle
    # the ports so each vessel gets a random subset of the ports
    usable_ports_list = nodemanager.get_vessel_resources(
        ip_or_nat_string, port_num, donated_vesselname)['usableports']
    node_transition_lib.log("List of usable ports in node: " + node_string +
                            ". " + str(usable_ports_list))
    random.shuffle(usable_ports_list)

    #the vessel that we start with
    current_vessel = donated_vesselname
    node_transition_lib.log("Name of starting vessel: " + current_vessel)

    # Keep splittiing the vessel until we run out of resources.
    # Note that when split_vessel is called the left vessel
    # has the leftover (extra vessel)and the right vessel has
    # the vessel with the exact resources.
    while len(usable_ports_list) >= 10:
        desired_resourcedata = get_resource_data(onepercent_resourcetemplate,
                                                 usable_ports_list)

        #use the first 10 ports so remove them from the list of usable_ports_list
        used_ports_list = usable_ports_list[:10]
        usable_ports_list = usable_ports_list[10:]

        node_transition_lib.log(
            "Ports we are going to use for the new vessel: " +
            str(used_ports_list))
        node_transition_lib.log("Starting to split vessel: " + current_vessel)

        # Split the current vessel. The exact vessel is the right vessel
        # and the extra vessel is the left vessel.
        try:
            leftover_vessel, new_vessel = backend.split_vessel(
                database_nodeobject, current_vessel, desired_resourcedata)
        except NodemanagerCommunicationError, e:
            # The object 'e' will already include traceback info that has the actual node error.
            # If the failure is due to inability to split further, that's ok.
            if 'Insufficient quantity:' in str(e):
                node_transition_lib.log(
                    "Could not split " + current_vessel +
                    " any further due to insufficient resource/quantity. " +
                    str(e))
                # We must break out of the while loop here. If we let the exception get,
                # raised, it will look like the transition failed.
                break
            raise

        node_transition_lib.log("Successfully split vessel: " +
                                current_vessel + " into vessels: " +
                                leftover_vessel + " and " + new_vessel)
        current_vessel = leftover_vessel

        # Make sure to update the database and record the new
        # name of the extra vessel as when backend.split_vessels()
        # is called, the old vessel does not exist anymore.
        # Instead two new vessels are created, where the first
        # vessel is the extra vessel with leftover resources
        # and the second vessel has the actual amount of resources
        maindb.set_node_extra_vessel_name(database_nodeobject, current_vessel)

        #set the user_list for the new vesel to be empty. Remember that user_list is what determines
        #the transition state, and only the extra vessel should have this set.
        backend.set_vessel_user_keylist(database_nodeobject, new_vessel, [])
        node_transition_lib.log("Changed the userkeys for the vessel " +
                                new_vessel + " to []")

        # Add the newly created vessel to the database and then add the ports associated with
        # the vessel to the database also.
        try:
            node_transition_lib.log(
                "Creating a vessel record in the database for vessel " +
                new_vessel + " for node " + node_string)
            vessel_object = maindb.create_vessel(database_nodeobject,
                                                 new_vessel)
            node_transition_lib.log(
                "Setting the vessel ports in the database for vessel " +
                new_vessel + " with port list: " + str(used_ports_list))
            maindb.set_vessel_ports(vessel_object, used_ports_list)
        except:
            raise node_transition_lib.DatabaseError(
                "Failed to create vessel entry or change vessel entry for vessel: "
                + new_vessel + ". " + traceback.format_exc())