' . t('The selected roles will be notified of each state change selected.') . '
'; } } -/** - * Implements hook_menu(). - */ -function workflow_notify_menu() { - $items = array(); - - $items['admin/config/workflow/workflow/notify/%workflow'] = array( - 'title' => 'Notifications', - 'access arguments' => array('administer workflow'), - 'page callback' => 'drupal_get_form', - 'page arguments' => array('workflow_notify_settings_form', 5), - 'type' => MENU_CALLBACK, - 'file' => 'workflow_notify.admin.inc', - ); - - return $items; -} - /** * Implements hook_theme(). */ @@ -51,7 +89,7 @@ function workflow_notify_theme() { return array( 'workflow_notify_settings_form' => array( 'render element' => 'form', - 'file' => 'workflow_notify.admin.inc', + 'file' => 'workflow_notify.pages.inc', ), ); } @@ -66,30 +104,6 @@ function workflow_notify_hook_info() { return $hooks; } -/** - * Implements hook_workflow_operations(). - * Add an action link to this module. - */ -function workflow_notify_workflow_operations($op, $workflow = NULL) { - switch ($op) { - case 'workflow': - $wid = $workflow->getWorkflowId(); - - $actions = array( - 'workflow_notify_settings' => array( - 'title' => t('Notifications'), - 'href' => "admin/config/workflow/workflow/notify/$wid", - 'attributes' => array('alt' => t('Notify users about state changes.')), - ), - ); - - $actions['workflow_notify_settings']['attributes']['title'] = - $actions['workflow_notify_settings']['attributes']['alt']; - - return $actions; - } -} - /** * Implements hook_workflow(). * Calls drupal_mail via _workflow_notify() for Workflow Field; @@ -118,6 +132,17 @@ function workflow_notify_workflow($op, $old_state, $new_state, $entity, $force, } } +/** + * Implements hook_entity_insert(). + * Calls drupal_mail via _workflow_notify() for Workflow Field; + * + * @param $entity + * @param $entity_type + */ +function workflow_notify_entity_insert($entity, $entity_type) { + _workflow_notify_entity_update($entity, $entity_type); +} + /** * Implements hook_entity_update(). * Calls drupal_mail via _workflow_notify() for Workflow Field; @@ -126,6 +151,16 @@ function workflow_notify_workflow($op, $old_state, $new_state, $entity, $force, * @param $entity_type */ function workflow_notify_entity_update($entity, $entity_type) { + _workflow_notify_entity_update($entity, $entity_type); +} + +/** + * Calls drupal_mail via _workflow_notify() for Workflow Field; + * + * @param $entity + * @param $entity_type + */ +function _workflow_notify_entity_update($entity, $entity_type) { if (isset($entity->workflow_transitions)) { $new_state = workflow_node_current_state($entity, $entity_type, $field_name); foreach ($entity->workflow_transitions as $field_name => &$transition) { @@ -146,6 +181,11 @@ function workflow_notify_mail($key, &$message, $params) { $filter = $params['filter']; $message['send'] = TRUE; + $entity_type = $params['data']['entity_type']; + $entity = isset($params['data']['entity']) ? $params['data']['entity'] : $params['data']['node']; + $entity_uri = entity_uri($entity_type, $entity); + list($entity_id, , $entity_bundle) = entity_extract_ids($entity_type, $entity); + $message['subject'] = filter_xss(token_replace($params['context']['subject'], $params['data'], $params)); $message['body'][] = check_markup(token_replace($params['context']['body'], $params['data'], $params), $filter); @@ -156,12 +196,11 @@ function workflow_notify_mail($key, &$message, $params) { '@to' => $message['to'], '@from' => $message['from'], ), - WATCHDOG_INFO, l(t('view'), 'node/' . $params['data']['node']->nid)); + WATCHDOG_INFO, l(t('view'), $entity_uri['path'])); return; } } - /** * Calls drupal_mail() to notify users. * @@ -188,12 +227,13 @@ function _workflow_notify($new_state, $entity, $entity_type = '', $field_name = // Okay, we are notifying someone of this change. // So let's get the workflow object. + $entity_uri = entity_uri($entity_type, $entity); list($entity_id, , $entity_bundle) = entity_extract_ids($entity_type, $entity); /* @var $workflow Workflow */ $workflow = workflow_get_workflows_by_type($entity_bundle, $entity_type); $wid = $workflow->getWorkflowId(); - // And all the states. + // And all the states. $states = $workflow->getStates(TRUE); // Get the specific roles to notify. @@ -212,7 +252,8 @@ function _workflow_notify($new_state, $entity, $entity_type = '', $field_name = . "WHERE ur.rid IN (:rids) " . "AND u.status = 1 "; $users = db_query($query, array(':rids' => $notify))->fetchCol(); - } else { + } + else { $users = array(); } @@ -227,13 +268,13 @@ function _workflow_notify($new_state, $entity, $entity_type = '', $field_name = // Call all modules that want to limit the list. $args = array( 'users' => $accounts, - 'node' => $entity, - 'entity' => $entity, // Preparing for entities, keeping backward compatibility. 'entity_type' => $entity_type, 'state' => $new_state, 'roles' => $notify, 'workflow' => $workflow, ); + // Preparing for entities, keeping backward compatibility. + $args += $entity_type == 'node' ? array('node' => $entity) : array('entity' => $entity); foreach (module_implements('workflow_notify') as $module) { $function = $module . '_workflow_notify'; $function('users', $args); @@ -241,40 +282,42 @@ function _workflow_notify($new_state, $entity, $entity_type = '', $field_name = // Retrieve the remaining list without duplicates. $accounts = $args['users']; - $addr_list = array(); - // Just quit if there are no users. if (empty($accounts)) { watchdog('workflow_notify', 'No recipients - email skipped.', array(), - WATCHDOG_DEBUG, l(t('view'), 'node/' . $entity_id)); // @todo: other entity types. + WATCHDOG_DEBUG, l(t('view'), $entity_uri['path'])); return; } - + $addr_list = array(); foreach ($accounts as $uid => $account) { - $addr_list[] = format_username($account) . '<' . $account->mail . '>'; + $addr_list[] = format_username($account) . ' <' . $account->mail . '>'; } + // The to-parameter to drupal_mail is a string, not an array, separated by commas. + $to = implode(', ', $addr_list); + // Retrieve the params parameter for drupal_mail. $params = array( 'clear' => TRUE, 'sanitize' => FALSE, 'data' => array( - 'node' => $entity, - 'entity' => $entity, // Preparing for entities, keeping backward compatibility. - 'entity_type' => $entity_type, 'user' => $user, + 'entity_type' => $entity_type, ), 'filter' => variable_get('workflow_notify_filter_format_' . $wid, 'filtered_html'), ); + // Preparing for entities, keeping backward compatibility. + $params['data'] += $entity_type == 'node' ? array('node' => $entity) : array('entity' => $entity); // Build the subject and body of the mail. // Token replacement occurs in hook_mail(). - // @TODO: Currently no translation occurs. + // @todo: Currently no translation occurs. $params['context']['subject'] = variable_get("workflow_notify_subject_$new_state", '[node:title] is now "[workflow:workflow-current-state-name]"'); $params['context']['body'] = variable_get("workflow_notify_body_$new_state", '[node:title] is now "@state".'); + // Retrieve the from-address. switch (variable_get('workflow_notify_from_address_' . $wid, 'site')) { case 'site': $from = variable_get('site_mail', ini_get('sendmail_from')); @@ -285,13 +328,21 @@ function _workflow_notify($new_state, $entity, $entity_type = '', $field_name = break; } - // Send the email. - drupal_mail('workflow_notify', - 'workflow_notify', - implode(', ', $addr_list), - language_default(), - $params, - $from); + // Send the mail, and check for success. Note that this does not guarantee + // message delivery; only that there were no PHP-related issues encountered + // while sending. + $module = 'workflow_notify'; + $key = 'workflow_notify'; + $language = language_default(); + // https://api.drupal.org/api/drupal/includes!mail.inc/function/drupal_mail/7.x + $result = drupal_mail($module, $key, $to, $language, $params, $from); + /* + if ($result['result'] == TRUE) { + drupal_set_message(t('Your message has been sent.')); + } + else { + drupal_set_message(t('There was a problem sending your message and it was not sent.'), 'error'); + } + */ - return; } diff --git a/sites/all/modules/contrib/admin/workflow/workflow_notify/workflow_notify.pages.inc b/sites/all/modules/contrib/admin/workflow/workflow_notify/workflow_notify.pages.inc new file mode 100644 index 00000000..e15d5311 --- /dev/null +++ b/sites/all/modules/contrib/admin/workflow/workflow_notify/workflow_notify.pages.inc @@ -0,0 +1,230 @@ + $workflow->label()))); + + // Let's add some breadcrumbs. + // workflow_admin_ui_breadcrumbs($workflow); + + $form['#tree'] = TRUE; + $form['#wid'] = $wid = $workflow->getWorkflowId(); + $form['#workflow'] = $workflow; + + $noyes = array(t('No'), t('Yes')); + + // Get all the states for this workflow, except the (creation) state. + $states = $workflow->getStates(); + $form['#states'] = $states; + if (!$states) { + $form['#columns'] = array(); + $form['error'] = array( + '#type' => 'markup', + '#value' => t('There are no states defined for this workflow.'), + ); + return $form; + } + + // A list of role names keyed by role ID, including the 'author' role. + $roles = workflow_get_roles('participate in workflow'); + // The module_invoke_all function does not allow passing by reference. + $args = array('roles' => $roles); + foreach (module_implements('workflow_notify') as $module) { + $function = $module . '_workflow_notify'; + // Call the $op='roles' hooks so the list may be modified. + $function('roles', $args); + } + // Get the modified list. + $roles = $args['roles']; + + // Setting for "from" address. + $form['from_address'] = array( + '#title' => t('Set "From" address to'), + '#type' => 'radios', + '#options' => array( + 'site' => t('Site email address'), + 'changer' => t('Current user'), + ), + '#default_value' => variable_get("workflow_notify_from_address_$wid", 'site'), + '#attributes' => array('class' => array('container-inline')), + '#description' => t('Determines whether to use the site address or the address of the person + causing the state change.'), + ); + + // Get the list of input formats. + $formats = array(); + foreach (filter_formats() as $fid => $filter) { + $formats[$fid] = $filter->name; + } + + $form['filter'] = array( + '#title' => t('Filter format to use on message'), + '#type' => 'radios', + '#options' => $formats, + '#default_value' => variable_get("workflow_notify_filter_format_$wid", 'filtered_html'), + '#attributes' => array('class' => array('container-inline')), + '#description' => t('The message body will be processed using this filter format + in order to ensure security.'), + ); + + $form['tokens'] = array( + '#theme' => 'token_tree_link', + '#token_types' => array('node', 'workflow'), + ); + + // Column names for theme function. + $columns = array( + 'state' => t('State'), + 'roles' => t('Roles to notify'), + ); + + $args = array('columns' => $columns); + // The module_invoke_all function does not allow passing by reference. + foreach (module_implements('workflow_notify') as $module) { + $function = $module . '_workflow_notify'; + $function('columns', $args); + } + $form['#columns'] = $args['columns']; + + // We always want subject and body last. + $form['#columns']['subject'] = t('Subject'); + $form['#columns']['body'] = t('Body'); + + $notify = variable_get('workflow_notify_roles', array()); + + foreach ($states as $sid => $state) { + // Allow modules to insert state operations. + $state_links = module_invoke_all('workflow_operations', 'state', $workflow, $state); + + $form['states'][$sid] = array( + 'state' => array( + '#type' => 'markup', + '#markup' => filter_xss($state->state), + ), + + 'roles' => array( + '#type' => 'checkboxes', + '#options' => $roles, + '#default_value' => (isset($notify[$sid]) ? $notify[$sid] : array()), + '#attributes' => array('class' => array('state-roles')), + ), + + 'subject' => array( + '#type' => 'textarea', + '#rows' => 5, + '#default_value' => variable_get('workflow_notify_subject_' . $sid, + '[node:title] is now "[node:field_workflow_state:new-state:label]"'), + '#attributes' => array('class' => array('subject')), + ), + + 'body' => array( + '#type' => 'textarea', + '#rows' => 5, + '#default_value' => variable_get('workflow_notify_body_' . $sid, + '[node:title] is now "[node:field_workflow_state:new-state:label]".'), + '#attributes' => array('class' => array('body')), + ), + ); + } + + $form['submit'] = array('#type' => 'submit', '#value' => t('Save configuration')); + + return $form; +} + +/** + * Theme the settings form. + */ +function theme_workflow_notify_settings_form($variables) { + $form = $variables['form']; + $output = ''; + $table_id = 'workflow-notify-settings'; + + $output .= drupal_render($form['from_address']); + $output .= drupal_render($form['filter']); + $output .= drupal_render($form['tokens']); + + $table = array( + 'rows' => array(), + 'header' => array(), // To be filled in. + 'attributes' => array('id' => $table_id, 'style' => 'width: 100%; margin-top: 1em;'), + ); + + $columns = $form['#columns']; + $colspan = count($columns); + + foreach ($columns as $field => $title) { + $table['header'][] = $title; + } + + // 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. + $row = array(); + + foreach ($columns as $field => $title) { + $row[] = array( + 'data' => drupal_render($form['states'][$id][$field]), + 'class' => array(drupal_html_class($field)), + ); + } + + // Put the data row into the table. + $table['rows'][] = array('data' => $row); + } + + $output .= theme('table', $table); + + $output .= drupal_render($form['explain']); + + // And then render any remaining form elements (such as our submit button) + $output .= drupal_render_children($form); + + return $output; +} + +function workflow_notify_settings_form_submit($form, &$form_state) { + $wid = $form['#wid']; + $workflow = $form['#workflow']; + $roles = variable_get('workflow_notify_roles', array()); + + $form_state['redirect'] = WORKFLOW_ADMIN_UI_PATH; + + variable_set("workflow_notify_from_address_$wid" , $form_state['values']['from_address']); + variable_set("workflow_notify_filter_format_$wid" , $form_state['values']['filter']); + + foreach ($form_state['values']['states'] as $sid => $values) { + $selected = array_filter($values['roles']); + // Are there any roles selected? + if ($selected) { + $roles[$sid] = $selected; + } + else { + // No, so make sure this state is gone. + unset($roles[$sid]); + } + + variable_set("workflow_notify_subject_$sid", $values['subject']); + variable_set("workflow_notify_body_$sid", $values['body']); + } + + variable_set('workflow_notify_roles', $roles); + + drupal_set_message(t('The notification settings have been saved.')); +} diff --git a/sites/all/modules/contrib/admin/workflow/workflow_notify/workflow_notify_og/workflow_notify_og.info b/sites/all/modules/contrib/admin/workflow/workflow_notify/workflow_notify_og/workflow_notify_og.info index 3d367f36..b5c6c869 100644 --- a/sites/all/modules/contrib/admin/workflow/workflow_notify/workflow_notify_og/workflow_notify_og.info +++ b/sites/all/modules/contrib/admin/workflow/workflow_notify/workflow_notify_og/workflow_notify_og.info @@ -1,12 +1,14 @@ name = Workflow Notify OG description = Notify roles by OG groups of Workflow transitions. -dependencies[] = workflow_notify -core = 7.x package = Workflow +core = 7.x -; Information added by Drupal.org packaging script on 2017-01-15 -version = "7.x-2.9+10-dev" +dependencies[] = workflow_notify + +configure = admin/config/workflow/workflow + +; Information added by Drupal.org packaging script on 2019-05-23 +version = "7.x-2.13" core = "7.x" project = "workflow" -datestamp = "1484510888" - +datestamp = "1558597389" diff --git a/sites/all/modules/contrib/admin/workflow/workflow_notify/workflow_notify_og/workflow_notify_og.module b/sites/all/modules/contrib/admin/workflow/workflow_notify/workflow_notify_og/workflow_notify_og.module index c5a581db..c2d409fa 100644 --- a/sites/all/modules/contrib/admin/workflow/workflow_notify/workflow_notify_og/workflow_notify_og.module +++ b/sites/all/modules/contrib/admin/workflow/workflow_notify/workflow_notify_og/workflow_notify_og.module @@ -1,4 +1,5 @@ $element) { - $form['states'][$sid]['limit_by_group'] = array( - '#type' => 'radios', - '#options' => array(t('No'), t('Yes')), - '#attributes' => array('class' => array('limit-by-group')), - '#default_value' => (isset($limit[$sid]) ? $limit[$sid] : 0), + if (!empty($form['states'])) { + // Add a group limit flag to each state. + foreach ($form['states'] as $sid => $element) { + $form['states'][$sid]['limit_by_group'] = array( + '#type' => 'radios', + '#options' => array(t('No'), t('Yes')), + '#attributes' => array('class' => array('limit-by-group')), + '#default_value' => (isset($limit[$sid]) ? $limit[$sid] : 0), ); + } + // Add our submission handler. + $form['#submit'][] = 'workflow_notify_og_form_submit'; } - - // Add our submission handler. - $form['#submit'][] = 'workflow_notify_og_form_submit'; } } @@ -109,6 +112,4 @@ function workflow_notify_og_form_submit(&$form, &$form_state) { // Save the new limit flags. variable_set('workflow_notify_og', $limit); - - $form_state['redirect'] = "admin/config/workflow/workflow/$workflow->wid"; } diff --git a/sites/all/modules/contrib/admin/workflow/workflow_revert/workflow_revert.info b/sites/all/modules/contrib/admin/workflow/workflow_revert/workflow_revert.info index 5cb78a4c..0508ca7e 100644 --- a/sites/all/modules/contrib/admin/workflow/workflow_revert/workflow_revert.info +++ b/sites/all/modules/contrib/admin/workflow/workflow_revert/workflow_revert.info @@ -1,12 +1,12 @@ name = Workflow Revert -description = "Adds a 'Revert' link to the first workflow history row." -dependencies[] = workflow -core = 7.x +description = Adds a 'Revert' link to the first workflow history row. package = Workflow +core = 7.x -; Information added by Drupal.org packaging script on 2017-01-15 -version = "7.x-2.9+10-dev" +dependencies[] = workflow + +; Information added by Drupal.org packaging script on 2019-05-23 +version = "7.x-2.13" core = "7.x" project = "workflow" -datestamp = "1484510888" - +datestamp = "1558597389" diff --git a/sites/all/modules/contrib/admin/workflow/workflow_revert/workflow_revert.pages.inc b/sites/all/modules/contrib/admin/workflow/workflow_revert/workflow_revert.pages.inc index 43cd5b90..fa3223cf 100644 --- a/sites/all/modules/contrib/admin/workflow/workflow_revert/workflow_revert.pages.inc +++ b/sites/all/modules/contrib/admin/workflow/workflow_revert/workflow_revert.pages.inc @@ -9,7 +9,7 @@ * * @todo: add support for Field in workflow_revert. */ -function workflow_revert_form($form, $form_state, $entity_type, $id, $field_name, $previous_sid = NULL) { +function workflow_revert_form($form, &$form_state, $entity_type, $id, $field_name, $previous_sid = NULL) { $entity = entity_load_single($entity_type, $id); $uri = entity_uri($entity_type, $entity); $return_uri = $uri['path'] . '/workflow'; @@ -45,7 +45,7 @@ function workflow_revert_form($form, $form_state, $entity_type, $id, $field_name * * The function is magically called, due to its name