'));
$bc[] = l(t('Configuration'), 'admin/config');
$bc[] = l(t('Workflow'), 'admin/config/workflow');
$bc[] = l(t('Workflow'), 'admin/config/workflow/workflow');
drupal_set_breadcrumb($bc);
$form = array('#tree' => TRUE);
$form['wid'] = array('#type' => 'value', '#value' => $workflow->wid);
$form['#wf_name'] = $workflow->name;
// Get the state objects and make the array keys the same as the sids.
$states = workflow_get_workflow_states_by_wid($workflow->wid);
$sids = array();
foreach ($states as $state) {
$sids[] = $state->sid;
}
$states = array_combine($sids, $states);
// Save the list in the form for later.
$form['#workflow_states'] = $states;
// Allow modules to insert their own workflow operations.
$links = module_invoke_all('workflow_operations', 'workflow', $workflow);
drupal_set_title(t('Workflow: ') . t($workflow->name));
$links_args = array(
'links' => $links,
'attributes' => array('class' => array('inline', 'action-links')),
);
$form['action-links'] = array(
'#type' => 'markup',
'#markup' => theme('links', $links_args),
);
// Build select options for reassigning states.
// We put a blank state first for validation.
$state_list = array('' => ' ');
foreach ($states as $sid => $state) {
// Leave out the creation state and any inactive states.
if ($state->sysid == 0 && $state->status == 1) {
$state_list[$sid] = $state->state;
}
}
// Is this the last state available?
$form['#last'] = count($state_list) == 2;
// Dummy object for new state item.
$states[] = (object) array(
'sid' => 0,
'state' => '',
'status' => 1,
'sysid' => 0,
'weight' => 99,
);
foreach ($states as $state) {
// Allow modules to insert state operations.
$state_links = module_invoke_all('workflow_operations', 'state', $workflow, $state);
$form['states'][$state->sid] = array(
'state' => array(
'#type' => 'textfield',
'#size' => 30,
'#maxlength' => 255,
'#default_value' => $state->state,
),
'weight' => array(
'#type' => 'weight',
'#delta' => 20,
'#default_value' => $state->weight,
'#title-display' => 'invisible',
'#attributes' => array('class' => array('state-weight')),
),
'status' => array(
'#type' => 'checkbox',
'#default_value' => $state->status,
),
// Save the original status for the validation handler.
'orig_status' => array(
'#type' => 'value',
'#value' => $state->status,
),
'reassign' => array(
'#type' => 'select',
'#options' => $state_list,
),
'count' => array(
'#type' => 'value',
'#value' => count(workflow_get_workflow_node_by_sid($state->sid)),
),
'ops' => array(
'#type' => 'markup',
'#markup' => theme('links', array('links' => $state_links)),
),
'sysid' => array(
'#type' => 'value',
'#value' => $state->sysid,
),
);
// Don't let the creation state change weight or status or name.
if ($state->sid == $workflow->creation_state) {
$form['states'][$state->sid]['weight']['#value'] = -50;
$form['states'][$state->sid]['sysid']['#value'] = 1;
$form['states'][$state->sid]['state']['#disabled'] = TRUE;
$form['states'][$state->sid]['status']['#disabled'] = TRUE;
$form['states'][$state->sid]['reassign']['#disabled'] = TRUE;
}
}
$form['instructions'] = array(
'#type' => 'markup',
'#markup' => '' . t('You may enter a new state name in the empty space.
Check the "Active" box to make it effective. You may also drag it to the appropriate position.') . '
'
. '' . t('A state not marked as active will not be shown as available in the workflow settings.') . '
'
. '' . t('If you wish to inactivate a state that has content (i.e. count is not zero),
then you need to select a state to which to reassign that content.') . '
'
);
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array( '#type' => 'submit', '#value' => t('Save Changes'));
return $form;
}
function theme_workflow_admin_ui_overview_form($variables) {
$form = $variables['form'];
$output = '';
$table_id = 'workflow_admin_ui_overview';
$table = array(
'rows' => array(),
'header' => array(
t('State'),
t('Weight'),
t('Active'),
t('Reassign'),
t('Count'),
array('data' => t('Operations'), 'class' => 'state-ops'),
),
'attributes' => array('id' => $table_id, 'style' => 'width: auto;'),
);
// The out put needs to have the action links at the top.
$output .= drupal_render($form['action-links']);
// Iterate over each element in our $form['states'] array
foreach (element_children($form['states']) as $id) {
// We are now ready to add each element of our $form data to the rows
// array, so that they end up as individual table cells when rendered
// in the final table. We run each element through the drupal_render()
// function to generate the final html markup for that element.
$table['rows'][] = array(
'data' => array(
// Add our 'name' column
array('data' => drupal_render($form['states'][$id]['state']), 'class' => 'state-name'),
// Add our 'weight' column
drupal_render($form['states'][$id]['weight']),
// Add our 'status' column
array('data' => drupal_render($form['states'][$id]['status']), 'class' => 'state-status'),
// Add our 'reassign' column
array('data' => drupal_render($form['states'][$id]['reassign']), 'class' => 'state-reassign'),
// Add our 'count' column
array('data' => $form['states'][$id]['count']['#value'], 'class' => 'state-count'),
// Add our 'operations' column
array('data' => drupal_render($form['states'][$id]['ops']), 'class' => 'state-ops'),
// Add our 'sysid' column
drupal_render($form['states'][$id]['sysid']),
),
// To support the tabledrag behaviour, we need to assign each row of the
// table a class attribute of 'draggable'. This will add the 'draggable'
// class to the element for that row when the final table is
// rendered.
'class' => array('draggable'),
);
}
$output .= theme('table', $table);
// And then render any remaining form elements (such as our submit button)
$output .= drupal_render_children($form);
// We now call the drupal_add_tabledrag() function in order to add the
// tabledrag.js goodness onto our page.
//
// For a basic sortable table, we need to pass it:
// - the $table_id of our element,
// - the $action to be performed on our form items ('order'),
// - a string describing where $action should be applied ('siblings'),
// - and the class of the element containing our 'weight' element.
drupal_add_tabledrag($table_id, 'order', 'sibling', 'state-weight');
return $output;
}
/**
* Validation handler for the state form.
*/
function workflow_admin_ui_overview_form_validate($form, &$form_state) {
// Get the workflow id.
$wid = $form_state['values']['wid'];
// Get the state objects.
$states = $form['#workflow_states'];
// Because the form elements were keyed with the item ids from the database,
// we can simply iterate through the submitted values.
foreach ($form_state['values']['states'] as $sid => $item) {
// Do they want to deactivate the state?
if (($item['status'] != $item['orig_status']) && ($item['status'] == 0)) {
// Does that state have nodes in it?
if ($item['count'] > 0 && empty($item['reassign'])) {
if ($form['#last']) {
drupal_set_message(t('Since you are deleting the last available workflow state
in this workflow, all content items which are in that state will have their
workflow state removed.'), 'warning');
}
else {
form_set_error("states'][$sid]['reassign'",
t('The %state state has content; you must reassign the content to another state.',
array('%state' => $states[$sid]->state)));
}
}
}
}
}
/**
* Submission handler for the state form.
*/
function workflow_admin_ui_overview_form_submit($form, &$form_state) {
// Get the workflow id, then save it for the next round.
$wid = $form_state['values']['wid'];
$wf_name = $form['#wf_name'];
// Get the state objects.
$states = $form['#workflow_states'];
// Because the form elements were keyed with the item ids from the database,
// we can simply iterate through the submitted values.
foreach ($form_state['values']['states'] as $id => $item) {
$item['sid'] = $id;
$item['wid'] = $wid;
// Is there not a new state name?
if (empty($item['state'])) {
// No new state entered, so skip it.
continue;
}
// Is this a new state?
if ($id == 0) {
// Remove the key for the updating.
unset($item['sid']);
}
// Do they want to deactivate the state?
if ($item['status'] == 0) {
// Does that state have nodes in it?
if ($item['count'] > 0) {
if ($form['#last']) {
$new_sid = NULL;
drupal_set_message(t('Removing workflow states from content in the %workflow.',
array('%workflow' => $wf_name)));
}
else {
// Prepare the state delete function.
$new_sid = $item['reassign'];
drupal_set_message(t('Reassigning content from %old_state to %new_state.',
array('%old_state' => $states[$id]->state, '%new_state' => $states[$new_sid]->state)));
}
// Delete the old state without orphaning nodes, move them to the new state.
workflow_delete_workflow_states_by_sid($id, $new_sid);
$args = array(
'%state' => $states[$id]->state,
'%workflow' => $wf_name,
);
watchdog('workflow', 'Deactivated workflow state %state in %workflow.', $args);
drupal_set_message(t('The workflow state %state was deleted from %workflow.', $args));
}
}
// Call the update function.
workflow_update_workflow_states($item);
}
$form_state['redirect'] = "admin/config/workflow/workflow/$wid";
}
/**
* Form builder. Allow administrator to map workflows to content types
* and determine placement.
*/
function workflow_admin_ui_types_form($form) {
$form = array();
// Allow modules to insert their own action links.
$links = module_invoke_all('workflow_operations', 'top_actions', NULL);
$links_args = array(
'links' => $links,
'attributes' => array('class' => array('inline', 'action-links')),
);
$form['action-links'] = array(
'#type' => 'markup',
'#markup' => theme('links', $links_args),
);
$these_workflows = array();
foreach (workflow_get_workflows() as $data) {
// Don't allow workflows with no states.
$states = workflow_get_workflow_states_by_wid($data->wid, array('status' => 1));
// There should always be a creation state.
if (count($states) == 1) {
// That's all, so let's remind them to create some states.
drupal_set_message(t('%workflow has no states defined, so it cannot be assigned to content yet.',
array('%workflow' => ucwords($data->name))), 'warning');
// Skip allowing this workflow.
continue;
}
// Also check for transitions at least out of the creation state.
// This always gets at least the "from" state.
$transitions = workflow_allowable_transitions($data->creation_state, 'to');
if (count($transitions) == 1) {
// That's all, so let's remind them to create some transitions.
drupal_set_message(t('%workflow has no transitions defined, so it cannot be assigned to content yet.',
array('%workflow' => ucwords($data->name))), 'warning');
// Skip allowing this workflow.
continue;
}
// Add this workflow to the allowed list.
$these_workflows[$data->wid] = t($data->name);
}
$workflows = array(t('None')) + $these_workflows;
if (count($workflows) == 1) {
drupal_set_message(t('You must create at least one workflow before content can be assigned to a workflow.'));
return $form;
}
$type_map = workflow_get_workflow_type_map();
$form['#tree'] = TRUE;
$form['help'] = array(
'#type' => 'item',
'#title' => '' . t('Content Type Mapping') . '
',
'#markup' => t('Each content type may have a separate workflow. The form for changing workflow state can be '
. 'displayed when editing a node, editing a comment for a node, or both.'),
);
$placement_options = array(
'node' => t('Post'),
'comment' => t('Comment'),
);
foreach (node_type_get_names() as $type => $name) {
$form[$type]['workflow'] = array(
'#type' => 'select',
'#options' => $workflows,
'#default_value' => isset($type_map[$type]) ? $type_map[$type] : 0,
);
$form[$type]['placement'] = array(
'#type' => 'checkboxes',
'#options' => $placement_options,
'#default_value' => variable_get('workflow_' . $type, array()),
);
}
$form['submit'] = array(
'#type' => 'submit',
'#value' => t('Save workflow mapping'),
'#weight' => 100,
);
return $form;
}
/**
* Theme the workflow type mapping form.
*/
function theme_workflow_admin_ui_types_form($variables) {
$output = '';
$form = $variables['form'];
// Do the action links at the top.
$output .= drupal_render($form['action-links']);
$header = array(t('Content Type'), t('Workflow'), t('Display Workflow Form on:'));
$rows = array();
foreach (node_type_get_names() as $type => $name) {
$rows[] = array(
check_plain(t($name)),
drupal_render($form[$type]['workflow']),
drupal_render($form[$type]['placement']),
);
}
$output .= drupal_render($form['help']);
$output .= theme('table', array(
'header' => $header,
'rows' => $rows,
'attributes' => array('style' => 'width: auto; clear: both;'),
));
return $output . drupal_render_children($form);
}
/**
* Submit handler for workflow type mapping form.
*
* @see workflow_types_form()
*/
function workflow_admin_ui_types_form_submit($form, &$form_state) {
workflow_admin_ui_types_save($form_state['values']);
drupal_set_message(t('The workflow mapping was saved.'));
}
/**
* Get a list of roles.
*
* @return
* Array of role names keyed by role ID, including the 'author' role.
*/
function workflow_admin_ui_get_roles() {
static $roles = NULL;
if (!$roles) {
$roles = array('author' => 'author');
$list = user_roles(FALSE, 'participate in workflow');
foreach ($list as $rid => $name) {
$roles[$rid] = check_plain($name);
}
}
return $roles;
}
/**
* Save mapping of workflow to node type. E.g., the story node type is using the Foo workflow.
*
* @param $form_state['values']
*/
function workflow_admin_ui_types_save($form_values) {
// Empty the table so that types no longer under workflow go away.
workflow_delete_workflow_type_map_all();
$node_types = node_type_get_names();
foreach ($node_types as $type => $name) {
$data = array(
'type' => $type,
'wid' => $form_values[$type]['workflow'],
);
workflow_insert_workflow_type_map($data);
variable_set('workflow_' . $type, array_keys(array_filter(($form_values[$type]['placement']))));
// If this type uses workflow, make sure pre-existing nodes are set
// to the workflow's creation state.
if ($form_values[$type]['workflow']) {
workflow_initialize_nodes($type, $name);
}
}
}
/**
* Initialize all pre-existing nodes of a type to their first state..
*
* @param $type - node type
* @param $name - node type name
*/
function workflow_initialize_nodes($type, $name) {
// Build the select query.
// We want all published nodes of this type that don't already have a workflow state.
$query = db_select('node', 'n');
$query->leftJoin('workflow_node', 'wn', 'wn.nid = n.nid');
// Add the fields.
$query->addField('n', 'nid');
// Add conditions.
$query->condition('n.type', $type);
$query->condition('n.status', 1);
$query->isNull('wn.sid');
$nids = $query->execute()->fetchCol();
$how_many = count($nids);
if ($how_many == 0) {
return;
}
$comment = t('Pre-existing content set to initial state.');
// Get the initial state for this content type.
$first_state = db_query("SELECT s.sid "
. "FROM {workflow_type_map} m "
. "INNER JOIN {workflow_states} s ON s.wid = m.wid "
. "WHERE m.type = :type AND s.sysid <> :creation "
. "ORDER BY s.weight ASC ",
array(':type' => $type, ':creation' => WORKFLOW_CREATION)
)->fetchField(0);
// Load them all up.
$nodes = node_load_multiple($nids);
foreach ($nodes as $node) {
// Force it to transition to the first state and get a history record.
workflow_execute_transition($node, $first_state, $comment, TRUE);
}
return;
drupal_set_message(t('!count @type nodes have been initialized.', array('@type' => $name, '!count' => $how_many)));
}
/**
* Update the transitions for a workflow.
*
* @param array $transitions from values.
* Transitions, for example:
* 18 => array(
* 20 => array(
* 'author' => 1,
* 1 => 0,
* 2 => 1,
* )
* )
* means the transition from state 18 to state 20 can be executed by
* the node author or a user in role 2. The $transitions array should
* contain ALL transitions for the workflow.
*/
function workflow_update_transitions($transitions = array()) {
// Empty string is sometimes passed in instead of an array.
if (!$transitions) {
return;
}
foreach ($transitions as $from => $to_data) {
foreach ($to_data as $to => $role_data) {
foreach ($role_data as $role => $can_do) {
if ($can_do) {
$transition = array(
'sid' => $from,
'target_sid' => $to,
'roles' => $role,
);
workflow_update_workflow_transitions($transition);
}
else {
$roles = array();
if ($transition = workflow_get_workflow_transitions_by_sid_target_sid($from, $to)) {
$roles = explode(',', $transition->roles);
$tid = $transition->tid;
if (($i = array_search($role, $roles)) !== FALSE) {
unset($roles[$i]);
workflow_update_workflow_transitions_roles($tid, $roles);
}
}
}
}
}
}
workflow_delete_workflow_transitions_by_roles('');
}