islandora_workflow.inc

<?php
/**
 * @file
 *   This is a collection of helper functions for the islandora_workflow module.
 * @author
 *   William Panting
 * @TODO: refactor out object and collection level functions to their own .incs
 * @TODO: refactor to remove as many calls to workflow modules functional
 *   code that substitutes for Fedora item functionality as reasonable.
 */

/**
 * Add a workflow tracking datastream to a Fedora object.
 *
 * @param string $object_id
 *   the Fedora PID of the object to modify
 *
 * @return string
 *   $result the return message from Fedora
 */
function islandora_workflow_init_workflow($object_id) {
  module_load_include('inc', 'fedora_repository', 'api/fedora_item');
  module_load_include('collection.inc', 'islandora_workflow');

  $item = new Fedora_Item($object_id);
  if (!$item->exists()) {
    return FALSE;
  }

  // Object passed in is a collection.
  if (islandora_workflow_check_collection_content_model($object_id)) {
    $parent_pid = islandora_workflow_get_object_parent($object_id);

    if ($parent_pid) {
      if (islandora_workflow_is_collection_workflow_tracked($parent_pid)) {
        drupal_set_message(t('Collection <em>%label</em> (%pid) is now tracked in workflow.',
            array(
              '%label' => $item->objectProfile->objLabel,
              '%pid' => $object_id,
            )
          ));
        return islandora_workflow_track_collection_in_workflow($object_id);
      }
    }
  }
  else {
    // Attach default workflow.
    $default_xml_file_name = drupal_get_path('module', 'islandora_workflow') . '/start_workflow.xml';

    $item->add_datastream_from_file(
        $default_xml_file_name,
        $dsid = 'islandora_workflow',
        $ds_label = 'Workflow Datastream',
        $mimetype = 'text/xml',
        $control_group = 'X',
        $log_message = 'Adding islandora_workflow datastream(editorial workflow tracking).'
    );

    // Set state.
    $result = islandora_workflow_set_object_workflow_state($object_id, 'created');
  }
  return $result;
}

/**
 * Move a Fedora object to the 'Rejected' workflow state.
 *
 * @param string $object_id
 *   the Fedora PID of the object to modify
 *
 * @return string
 *   the return message from Fedora
 * @return boolean
 *   FALSE if the rejection was not attempted
 */
function islandora_workflow_reject_object($object_id) {
  module_load_include('inc', 'islandora_workflow', 'fedora_object_functions');
  module_load_include('permissions.inc', 'islandora_workflow');
  module_load_include('inc', 'fedora_repository', 'api/fedora_item');
  module_load_include('inc', 'islandora_workflow', 'fedora_object_functions');

  // Permission check.
  $user_permission_level = islandora_workflow_user_object_permission_check($object_id);
  if ($user_permission_level != 'islandora_workflow_Editor' && $user_permission_level != 'islandora_workflow_Manager') {
    islandora_workflow_DSM_about_object($object_id, 'could not be rejected, you do not have the necessary permissions.');
    return FALSE;
  }

  $workflow_state = islandora_workflow_get_object_workflow_state($object_id);
  if ($workflow_state != 'created' && $workflow_state != 'rejected') {
    // If the state is published and XACML is enabled you might not be able to.
    // Reject due to XACML.
    global $user;
    if ($workflow_state == 'published' && module_exists('islandora_xacml_api') && $user->uid != 1) {
      module_load_include('inc', 'islandora_xacml_api', 'IslandoraXacml');

      $xacml = new IslandoraXacml($object_id);
      if (!$xacml->managementRule->hasPermission($user->name, $user->roles)) {
        islandora_workflow_DSM_about_object($object_id, 'could not be rejected, you do not have XACML access to the object.');
        return FALSE;
      }
    }

    // Send out email to creator.
    $user_name = islandora_workflow_get_object_creator($object_id);
    if ($user_name) {
      $object = new Fedora_Item($object_id);
      rules_invoke_event('islandora_workflow_rules_reject_object', $object);
    }
    else {
      islandora_workflow_DSM_about_object($object_id, 'had an unknown creator, so no email was sent on rejection.');
    }
    return (islandora_workflow_set_object_workflow_state($object_id, 'rejected'));
  }
  else {
    islandora_workflow_DSM_about_object($object_id, 'could not be rejected, it was not in an appropriate workflow state.');
    return FALSE;
  }
}

/**
 * Move a Fedora object to the 'Approved' workflow state.
 *
 * @param string $object_id
 *   the Fedora PID of the object to modify
 *
 * @return string
 *   the return mesage from Fedora
 * @return boolean
 *   FALSE if the approval was not attempted
 */
function islandora_workflow_approve_object($object_id) {
  module_load_include('permissions.inc', 'islandora_workflow');
  module_load_include('inc', 'fedora_repository', 'api/fedora_item');
  module_load_include('inc', 'islandora_workflow', 'fedora_object_functions');

  // Permission check.
  $tmp = islandora_workflow_user_object_permission_check($object_id);
  if ($tmp != 'islandora_workflow_Editor' && $tmp != 'islandora_workflow_Manager') {
    islandora_workflow_DSM_about_object($object_id, 'could not be approved, you do not have the necessary permissions.');
    return FALSE;
  }

  $workflow_state = islandora_workflow_get_object_workflow_state($object_id);
  if ($workflow_state != 'published' && $workflow_state != 'approved') {

    $object = new Fedora_Item($object_id);
    rules_invoke_event('islandora_workflow_rules_approve_object', $object);
    return (islandora_workflow_set_object_workflow_state($object_id, 'approved'));
  }
  else {
    islandora_workflow_DSM_about_object($object_id, 'could not be approved, it was not in an appropriate workflow state.');
  }
  return FALSE;
}

/**
 * Move a Fedora object to the 'Published' workflow state.
 *
 * @param string $object_id
 *   the Fedora PID of the object to modify
 *
 * @return string
 *   the return mesage from Fedora [on changing state to 'A']
 * @return boolean
 *   FALSE if the publication was not attempted
 */
function islandora_workflow_publish_object($object_id) {
  module_load_include('permissions.inc', 'islandora_workflow');
  module_load_include('inc', 'islandora_workflow', 'fedora_object_functions');

  // Permission check.
  if (islandora_workflow_user_object_permission_check($object_id) != 'islandora_workflow_Manager') {
    islandora_workflow_DSM_about_object($object_id, 'could not be published, you do not have the necessary permissions.');
    return FALSE;
  }

  if (islandora_workflow_get_object_workflow_state($object_id) != 'published') {
    islandora_workflow_set_object_workflow_state($object_id, 'published');
    islandora_workflow_DSM_about_object($object_id, 'has been published.');
  }
  else {
    islandora_workflow_DSM_about_object($object_id, 'could not be published, it was not in an appropriate workflow state.');
    return FALSE;
  }
}

/**
 * Move a Fedora object to the 'Submitted' workflow state.
 *
 * [wrapper function]
 *
 * @param string $object_id
 *   the Fedora PID of the object to modify
 *
 * @return string
 *   the return mesage from Fedora
 * @return boolean
 *   FALSE if the submission was not attempted
 */
function islandora_workflow_submit_object($object_id) {
  module_load_include('permissions.inc', 'islandora_workflow');
  module_load_include('inc', 'fedora_repository', 'api/fedora_item');
  module_load_include('inc', 'islandora_workflow', 'fedora_object_functions');

  // Permission check.
  if (!islandora_workflow_user_object_permission_check($object_id)) {
    islandora_workflow_DSM_about_object($object_id, 'could not be published, you do not have the necessary permissions.');
    return FALSE;
  }

  $workflow_state = islandora_workflow_get_object_workflow_state($object_id);
  if ($workflow_state == 'created' || $workflow_state == 'rejected') {

    // Send email to all editors.
    $object = new Fedora_Item($object_id);
    rules_invoke_event('islandora_workflow_rules_submit_object', $object);
    return (islandora_workflow_set_object_workflow_state($object_id, 'submitted'));
  }
  else {
    islandora_workflow_DSM_about_object($object_id, 'could not be submitted, it was not in an appropriate workflow state.');
  }
  return FALSE;
}

/**
 * Assign a Fedora object to the current user.
 *
 * @param string $object_id
 *   the Fedora PID of the object to modify
 *
 * @return mixed
 *   The return message from Fedora or FALSE if we will not assign the object.
 */
function islandora_workflow_claim_object($object_id) {
  module_load_include('inc', 'islandora_workflow', 'fedora_object_functions');
  global $user;

  $present_assignee = islandora_workflow_get_object_assignee($object_id);
  if ($present_assignee == $user->name) {
    islandora_workflow_DSM_about_object($object_id, 'is already assigned to you.');
    return FALSE;
  }
  return (islandora_workflow_assign_object($object_id, $user->name));
}

/**
 * Assign a Fedora object to a named user.
 *
 * @param string $object_id
 *   the Fedora PID of the object to modify
 * @param string $user_name
 *   the name of the Drupal user to assign the object to
 *
 * @return string
 *   $result the return mesage from Fedora
 */
function islandora_workflow_assign_object($object_id, $user_name) {
  module_load_include('permissions.inc', 'islandora_workflow');
  module_load_include('inc', 'fedora_repository', 'api/fedora_item');
  module_load_include('collection.inc', 'islandora_workflow');
  module_load_include('inc', 'islandora_workflow', 'fedora_object_functions');

  global $user;

  if (islandora_workflow_check_collection_content_model($object_id)) {
    islandora_workflow_DSM_about_object($object_id, 'is a collection and cannot be assigned.');
    return FALSE;
  }

  $present_assignee = islandora_workflow_get_object_assignee($object_id);
  if ($present_assignee == $user_name) {
    if ($user_name == $user->name) {
      islandora_workflow_DSM_about_object($object_id, 'is already assigned to you.');
    }
    else {
      islandora_workflow_DSM_about_object($object_id, 'is already assigned to ' . $user_name . '.');
    }
    return FALSE;
  }

  // Permission check.
  if (!islandora_workflow_user_object_permission_check($object_id)) {
    islandora_workflow_DSM_about_object($object_id, 'could not be assigned, you do not have the necessary permissions.');
    return FALSE;
  }

  $item = new Fedora_Item($object_id);
  rules_invoke_event('islandora_workflow_rules_assign_object', $item);
  // Assign object.
  return (islandora_workflow_set_object_relationship($object_id, 'assignee', $user_name));
}

/**
 * Set the workflow state for an object.
 *
 * uses RELS-EXT.
 *
 * @param string $object_id
 *   the Fedora PID of the object to check the status of
 * @param string $state
 *   The workflow state
 *
 * @return string
 *   $result the return mesage from Fedora
 */
function islandora_workflow_set_object_workflow_state($object_id, $state) {
  module_load_include('object.inc', 'islandora_workflow');
  module_load_include('inc', 'islandora_workflow', 'normalize_assignees');
  module_load_include('inc', 'fedora_repository', 'api/fedora_item');
  module_load_include('inc', 'islandora_workflow', 'fedora_object_functions');

  global $user;
  $workflow_parser = new DOMDocument();
  $item = new Fedora_Item($object_id);
  // Get the collection of this object.
  $collection = islandora_workflow_get_object_parent($object_id);

  if (!$item->exists()) {
    return FALSE;
  }

  // Update last modified user/time.
  if (isset($item->datastreams['islandora_workflow'])) {
    // Build XML from DS.
    $workflow_string = $item->get_datastream_dissemination('islandora_workflow');
    $workflow_parser->loadXML($workflow_string);
    // Get elements to populate dynamicaly.
    $last_modified_by_array = $workflow_parser->getElementsByTagName('last_modified_by');
    $when_last_modified_array = $workflow_parser->getElementsByTagName('when_last_modified');
    // Workflow DS.
    foreach ($last_modified_by_array as $last_modified_by_element) {
      // Create text node.
      $last_modified_by = $workflow_parser->createElement('last_modified_by');
      $last_modified_by->appendChild($workflow_parser->createTextNode($user->name));
      // Insert text node.
      $last_modified_by_element->parentNode->replaceChild($last_modified_by, $last_modified_by_element);
    }
    foreach ($when_last_modified_array as $when_last_modified_element) {
      // Create text node.
      $when_last_modified = $workflow_parser->createElement('when_last_modified');
      $when_last_modified->appendChild($workflow_parser->createTextNode(date('c')));
      // Insert text node.
      $when_last_modified_element->parentNode->replaceChild($when_last_modified, $when_last_modified_element);
    }
    $item->modify_datastream(
        $workflow_parser->saveXML(),
        $ds_id = 'islandora_workflow',
        $ds_label = NULL,
        $mimetype = 'text/xml'
    );
  }
  else {
    // Build xml from default if there is no DS present.
    $default_xml_file_name = drupal_get_path('module', 'islandora_workflow') . '/start_workflow.xml';
    $workflow_parser->load($default_xml_file_name);
    // Get elements to populate dynamicaly.
    $last_modified_by_array = $workflow_parser->getElementsByTagName('last_modified_by');
    $when_last_modified_array = $workflow_parser->getElementsByTagName('when_last_modified');
    // Workflow DS.
    foreach ($last_modified_by_array as $last_modified_by_element) {
      // Create text node.
      $last_modified_by = $workflow_parser->createTextNode($user->name);
      // Insert text node.
      $last_modified_by_element->appendChild($last_modified_by);
    }
    foreach ($when_last_modified_array as $when_last_modified_element) {
      // Create text node.
      // The function date('c') is supposed to give back an xml friendly string.
      $when_last_modified = $workflow_parser->createTextNode(date('c'));

      // Insert text node.
      $when_last_modified_element->appendChild($when_last_modified);
    }
    $item->add_datastream_from_string(
        $workflow_parser->saveXML(),
        $ds_id = 'islandora_workflow',
        $ds_label = 'workflow',
        $mimetype = 'text/xml',
        $control_group = 'X',
        $log_message = 'Adding islandora_workflow stream (workflow tracking).'
    );
  }

  // Change the rels-int.
  islandora_workflow_set_object_relationship($object_id, 'has_workflow_timestamp', date('c'), 'islandora_workflow');

  $label = islandora_workflow_get_object_label($object_id);
  /* Make sure that the object's fedora
   * state is going to be set to I if the object is still in workflow.*/
  if ($state != 'published' && islandora_workflow_get_object_fedora_state($object_id) != 'I') {
    $item->modify_object($label, 'I');
  }
  // Normalize the assignee for the future state of the object.
  islandora_workflow_normalize_assignee($object_id, $state);
  // Set the workflow state.
  $set_state_relationship_return = islandora_workflow_set_object_relationship($object_id, 'state', $state);

  // Make sure there is an appropriate XACML datastream if there should be.
  module_load_include('inc', 'islandora_xacml_api', 'IslandoraXacml');
  module_load_include('permissions.inc', 'islandora_workflow');
  if ($state == 'published') {
    // Make the object viewable(active).
    $item->modify_object($label, 'A');
    // Add the child security policy.
    $collection_item = new Fedora_Item($collection);
    if (isset($collection_item->datastreams['CHILD_SECURITY'])) {
      $child_security = $collection_item->get_datastream_dissemination('CHILD_SECURITY');
      $xacml = new IslandoraXacml($object_id, 'POLICY', $child_security);
    }
    else {
      // Kill the xacml policy from the workflow module.
      $xacml = new IslandoraXacml($object_id);
      $xacml->managementRule->clear();
      $xacml->viewingRule->clear();
      $xacml->managementRule->addRole('administrator');
      $xacml->managementRule->addUser('fedoraAdmin');
    }
    $xacml->writeBackToFedora();
  }
  else {
    // Get users and roles.
    $creator = islandora_workflow_get_object_creator($object_id);
    $xacml = new IslandoraXacml($object_id);

    $perms = islandora_workflow_get_permission_state($collection, $state);

    // Only set this if the creator is not anonymous.
    if ($creator != 'anonymous') {
      $perms['users'][] = $creator;
    }

    // We're going to add new settings...
    $xacml->managementRule->clear();
    $xacml->viewingRule->clear();

    // Add the new settings.
    $xacml->managementRule->addRole($perms['roles']);
    $xacml->viewingRule->addRole($perms['roles']);
    $xacml->managementRule->addUser($perms['users']);
    $xacml->viewingRule->addUser($perms['users']);

    $xacml->writeBackToFedora();
  }

  return ($set_state_relationship_return);
}

/**
 * Set the Fedora state of an object to Deleted.
 *
 * This function does not purge an object.
 *
 * @param string $object_id
 *   the Fedora PID of the object to modify
 *
 * @return string
 *   $result the return message from Fedora
 * @return boolean
 *   FALSE if the state of the object could not be changed by the current user.
 */
function islandora_workflow_delete_object($object_id) {
  module_load_include('permissions.inc', 'islandora_workflow');
  module_load_include('inc', 'fedora_repository', 'api/fedora_item');
  module_load_include('inc', 'islandora_workflow', 'fedora_object_functions');

  $label = islandora_workflow_get_object_label($object_id);

  // Permission check.
  if (!islandora_workflow_user_object_permission_check($object_id)) {
    islandora_workflow_DSM_about_object($object_id, 'could not be deleted, you do not have the necessary permissions.', $label);
    return FALSE;
  }

  $item = new Fedora_Item($object_id);

  islandora_workflow_set_object_workflow_state($object_id, 'deleted');
  $response = $item->modify_object($label, 'D');
  if ($response) {
    rules_invoke_event('islandora_workflow_rules_delete_object', $item);
    return $response;
  }
  else {
    return FALSE;
  }
}

/**
 * Get the name of the creator of an object.
 *
 * Note: The name returned may not necessarily be that of a Drupal user.
 * uses object properties
 *
 * @param string $object_id
 *   the Fedora PID of the object to check the status of
 *
 * @return string
 *   $creator The name of the creator of the object
 * @return boolean
 *   FALSE if the name of the creator could not be retrieved.
 */
function islandora_workflow_get_object_creator($object_id) {

  module_load_include('inc', 'fedora_repository', 'api/fedora_item');

  $params = array(
    'query' => array(
      'conditions' => array(
        array(
          'property' => 'pid',
          'operator' => 'eq',
          'value' => $object_id,
        ),
      ),
    ),
    'resultFields' => array('pid', 'ownerId'),
    'maxResults' => 1,
  );
  $response = Fedora_Item::soap_call('findObjects', $params);

  if (!$response) {
    return FALSE;
  }

  return $response->result->resultList->objectFields->ownerId;
}

/**
 * Get the current Fedora state of an object.
 *
 * uses object properties
 *
 * @param string $object_id
 *   the Fedora PID of the object to check the status of
 *
 * @return string
 *   $state The string representing the state of the object in fedora
 * @return boolean
 *   FALSE if the state of the object could not be retrieved.
 */
function islandora_workflow_get_object_fedora_state($object_id) {
  module_load_include('inc', 'fedora_repository', 'api/fedora_item');

  $params = array(
    'query' => array(
      'conditions' => array(
        array(
          'property' => 'pid',
          'operator' => 'eq',
          'value' => $object_id,
        ),
      ),
    ),
    'resultFields' => array('pid', 'state'),
    'maxResults' => 1,
  );
  $response = Fedora_Item::soap_call('findObjects', $params);

  if (!$response) {
    return FALSE;
  }

  return $response->result->resultList->objectFields->state;
}

/**
 * Get the current workflow state for an object.
 *
 * uses RELS-EXT
 *
 * @param string $object_id
 *   the Fedora PID of the object to check the status of
 *
 * @return string
 *   $state The string representing the state of the object in the workflow
 * @return boolean
 *   FALSE if no workflow state has been set.
 */
function islandora_workflow_get_object_workflow_state($object_id) {

  module_load_include('inc', 'fedora_repository', 'api/fedora_item');

  $islandora_workflow_namespace = 'info:islandora/islandora-system:def/islandora_workflow#';

  $item = new Fedora_Item($object_id);
  if (!$item->exists()) {
    return FALSE;
  }
  $workflow_relationships = $item->get_rdf_relationships($islandora_workflow_namespace);
  if (!empty($workflow_relationships)) {
    return $workflow_relationships['state'][0];
  }
  return FALSE;

}

/**
 * Get the current assignee for a Fedora object tracked by workflow.
 *
 * uses RELS-EXT
 *
 * @param string $object_id
 *   the Fedora PID of the object to check the status of
 *
 * @return string
 *   $assignee The string reperesenting the drupal
 *   user's name, or false if none was set
 */
function islandora_workflow_get_object_assignee($object_id) {
  module_load_include('inc', 'fedora_repository', 'api/fedora_item');

  $item = new Fedora_Item($object_id);
  if (!$item->exists()) {
    return FALSE;
  }
  $namespace = 'info:islandora/islandora-system:def/islandora_workflow#';
  $workflow_relationships = $item->get_rdf_relationships($namespace);

  if (!empty($workflow_relationships['assignee'])) {
    foreach ($workflow_relationships['assignee'] as $assignee) {
      if (!empty($assignee)) {
        return $assignee;
      }
    }
  }
  return FALSE;
}

/**
 * This function will set the indicated relationship on the indicated object.
 *
 * It will create or replace the relationship  as apropriate.
 * The function currently only does literals.
 *
 * @param string $object_id
 *   the Fedora PID of the object whos RELS-EXT or RELS-INT will be modified
 * @param string $relationship
 *   the relationship to set
 * @param string $target
 *   a literal or Fedora PID string (object of the relationship)
 * @param string $subject
 *   This defaults to the object's pid in the REST
 *   interface, only specify if a datastream
 *
 * @return object
 *   the response from fedora for adding/modifying the relationship
 */
function islandora_workflow_set_object_relationship($object_id, $relationship, $target, $subject = NULL, $value_type = RELS_TYPE_PLAIN_LITERAL) {

  module_load_include('inc', 'fedora_repository', 'api/fedora_item');

  $namespace = 'info:islandora/islandora-system:def/islandora_workflow#';

  $item = new Fedora_Item($object_id);
  if (!$item->exists()) {
    return FALSE;
  }

  if ($subject) {
    // Subject is an internal one - use RELS-INT.
    $item->purge_dsid_relationships($subject, $relationship, NULL, $namespace, $value_type);
    return $item->add_dsid_relationship($subject, $relationship, $target, $namespace, $value_type);
  }
  else {
    // External relationship - use RELS-EXT.
    $item->purge_relationships($relationship, NULL, $namespace, $value_type);
    return $item->add_relationship($relationship, $target, $namespace, $value_type);
  }
}

/**
 * Get the parent collection of an object.
 *
 * This function looks for the <isMemberOf> and <isMemberOfCollection>
 * relationships, in that order, in trying to determine a parent collection.
 *
 * If the object has more than one parent, only one will be returned.
 * @TODO determine the order (if any) which determines which parent is returned.
 *
 * @param string $object_id
 *   The PID of the object to get the parent of
 *
 * @return mixed
 *   $parent The PID of the parent object
 * @return boolean
 *   FALSE if no parent found
 */
function islandora_workflow_get_object_parent($object_id) {

  module_load_include('inc', 'fedora_repository', 'api/fedora_item');

  $item = new Fedora_Item($object_id);
  if (!$item->exists()) {
    return FALSE;
  }
  $parents = $item->get_relationships('isMemberOf');
  if (!empty($parents)) {
    return $parents[0]['object'];
  }
  $parents = $item->get_relationships('isMemberOfCollection');
  if (!empty($parents)) {
    return $parents[0]['object'];
  }
  return FALSE;
}

/**
 * Set a workflow note on an object.
 *
 * From and timestamp are generated from the current user/time
 *
 * @param string $object_id
 *   The PID of the object to set the note on
 * @param string $subject
 *   The subject of the message
 * @param string $body
 *   The content of the message
 *
 * @return mixed
 *   the response from fedora_api for adding/modifying the
 *   datastream, or FALSE if the datastream was missing
 */
function islandora_workflow_set_object_note($object_id, $subject, $body) {

  module_load_include('inc', 'fedora_repository', 'api/fedora_item');

  global $user;

  $item = new Fedora_Item($object_id);
  $workflow_parser = new DOMDocument();

  if (!isset($item->datastreams['islandora_workflow'])) {
    return FALSE;
  }
  // Get the DS xml in dom object.
  $workflow_string = $item->get_datastream_dissemination('islandora_workflow');
  $workflow_parser->loadXML($workflow_string);

  // Modify DS xml.
  /* Get elements to populate dynamicaly,
   * these lists are dynamic so no need to update later.*/
  $from_node_list = $workflow_parser->getElementsByTagName('from');
  $timestamp_node_list = $workflow_parser->getElementsByTagName('timestamp');
  $subject_node_list = $workflow_parser->getElementsByTagName('subject');
  $body_node_list = $workflow_parser->getElementsByTagName('body');
  $note_node_list = $workflow_parser->getElementsByTagName('note');
  $notes_node_list = $workflow_parser->getElementsByTagName('notes');

  /* Make sure that the notes and note elements
   * are present and add them if they are not.*/
  if (!$notes_node_list->item(0)) {
    $notes = $workflow_parser->createElement('notes');
    $workflow_node_list = $workflow_parser->getElementsByTagName('workflow');
    $workflow_node_list->item(0)->appendChild($notes);

  }
  if (!$note_node_list->item(0)) {
    $note = $workflow_parser->createElement('note');
    $notes_node_list->item(0)->appendChild($note);
  }

  // Create from node.
  $from = $workflow_parser->createElement('from');
  $from->appendChild($workflow_parser->createTextNode($user->name));
  if ($from_node_list->item(0)) {
    foreach ($from_node_list as $from_element) {
      $from_element->parentNode->replaceChild($from, $from_element);
    }
  }
  else {
    $note_node_list->item(0)->appendChild($from);
  }

  // Create timestamp.
  $timestamp = $workflow_parser->createElement('timestamp');
  $timestamp->appendChild($workflow_parser->createTextNode(date('c')));
  if ($timestamp_node_list->item(0)) {
    foreach ($timestamp_node_list as $timestamp_element) {
      // Insert text node.
      $timestamp_element->parentNode->replaceChild($timestamp, $timestamp_element);
    }
  }
  else {
    $note_node_list->item(0)->appendChild($timestamp);
  }

  // Create subject node.
  $subject_new_element = $workflow_parser->createElement('subject');
  $subject_new_element->appendChild($workflow_parser->createTextNode($subject));
  if ($subject_node_list->item(0)) {
    foreach ($subject_node_list as $subject_element) {
      // Insert text node.
      $subject_element->parentNode->replaceChild($subject_new_element, $subject_element);
    }
  }
  else {
    $note_node_list->item(0)->appendChild($subject_new_element);
  }


  // Create body node.
  $body_new_element = $workflow_parser->createElement('body');
  $body_new_element->appendChild($workflow_parser->createTextNode($body));
  if ($body_node_list->item(0)) {
    foreach ($body_node_list as $body_element) {
      // Insert text node.
      $body_element->parentNode->replaceChild($body_new_element, $body_element);
    }
  }
  else {
    $note_node_list->item(0)->appendChild($body_new_element);
  }

  islandora_workflow_set_object_relationship($object_id, 'has_note_subject', $subject, 'islandora_workflow');

  // Set the new DS content.
  return $item->modify_datastream(
      $workflow_parser->saveXML(),
      $ds_id = 'islandora_workflow',
      $ds_label = 'workflow',
      $mimetype = 'text/xml'
  );
}

/**
 * Retrieve the subject of the workflow note on an object (if present).
 *
 * @param string $object_id
 *   The PID of the object to get the note for
 *
 * @return mixed
 *   The contents of the object's note's subject,
 *   or FALSE if the datastream was missing
 */
function islandora_workflow_get_object_note_subject($object_id) {

  module_load_include('inc', 'fedora_repository', 'api/fedora_item');

  $item = new Fedora_Item($object_id);
  if (!$item->exists()) {
    return FALSE;
  }
  $iw = $item->get_datastream_dissemination('islandora_workflow');
  if (!$iw) {
    return FALSE;
  }
  $dom = new DOMDocument();
  $dom->loadXML($iw);
  return $dom->getElementsByTagName('subject')->item(0)->nodeValue;
}

/**
 * Get the body of the workflow note on an object.
 *
 * @param string $object_id
 *   The PID of the object to get the note for
 *
 * @return mixed
 *   The contents of the object's note's body,
 *   or FALSE if the datastream was missing
 */
function islandora_workflow_get_object_note_body($object_id) {

  module_load_include('inc', 'fedora_repository', 'api/fedora_item');

  $item = new Fedora_Item($object_id);
  if (!$item->exists()) {
    return FALSE;
  }
  $iw = $item->get_datastream_dissemination('islandora_workflow');
  if (!$iw) {
    return FALSE;
  }
  $dom = new DOMDocument();
  $dom->loadXML($iw);
  return $dom->getElementsByTagName('body')->item(0)->nodeValue;

}

/**
 * Get the workflow associated times for an object.
 *
 * @param string $object_id
 *   The pid of the object to return the timestamps for
 *
 * @return array
 *   $times An array of the objects timestamps, the 'created'
 *   element is creation while the 'modified' is the last workflow progression.
 */
function islandora_workflow_get_object_state_time_stamp($object_id) {

  module_load_include('inc', 'fedora_repository', 'api/fedora_item');

  $item = new Fedora_Item($object_id);
  if (!$item->exists()) {
    return FALSE;
  }
  $iw = $item->get_datastream_dissemination('islandora_workflow');
  if (!$iw) {
    return FALSE;
  }
  $times = array();
  $dom = new DOMDocument();
  $dom->loadXML($iw);
  $modified_times = $dom->getElementsByTagName('when_last_modified');
  foreach ($modified_times as $modified_time) {
    $times['islandora_workflow_modified'] = format_date(strtotime($modified_time->nodeValue), 'small');
  }
  return $times;
}

/**
 * Get all users with a specific role.
 *
 * @param int $rid
 *   the Drupal role ID
 *
 * @return array
 *   $user_ids An array of user IDs.
 */
function islandora_workflow_get_users_with_role($rid) {
  $user_ids = array();
  $result = db_query('SELECT uid FROM {users_roles} WHERE rid = %d', $rid);
  while ($row = mysql_fetch_assoc($result)) {
    $user_ids[] = $row['uid'];
  }
  return $user_ids;
}