lightning_workflow-8.x-3.x-dev/lightning_workflow.module
lightning_workflow.module
<?php
/**
* @file
* Provides workflow enhancements for Drupal.
*/
use Drupal\content_moderation\Plugin\WorkflowType\ContentModerationInterface;
use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityPublishedInterface;
use Drupal\Core\Entity\RevisionableInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Serialization\Yaml;
use Drupal\lightning_workflow\Override;
use Drupal\lightning_workflow\Plugin\views\field\NodeBulkForm;
use Drupal\lightning_workflow\Routing\RouteSubscriber;
use Drupal\node\Entity\NodeType;
use Drupal\node\NodeTypeInterface;
use Drupal\views\Entity\View;
use Drupal\views\ViewExecutable;
use Drupal\workflows\Entity\Workflow;
/**
* Implements hook_form_FORM_ID_alter().
*/
function lightning_workflow_form_node_type_add_form_alter(array &$form) {
$map = function (Workflow $workflow) {
return $workflow->label();
};
$workflows = array_map($map, Workflow::loadMultipleByType('content_moderation'));
$form['workflow']['workflow'] = [
'#type' => 'select',
'#title' => t('Add this content type to workflow'),
'#options' => $workflows,
'#access' => (bool) $workflows,
'#empty_value' => '',
];
if (array_key_exists('editorial', $workflows)) {
$form['workflow']['workflow']['#default_value'] = 'editorial';
}
// If Field UI is installed, there will be a button to save the content type
// and add more fields.
if (isset($form['actions']['save_continue'])) {
$submit_handlers = &$form['actions']['save_continue']['#submit'];
}
else {
$submit_handlers = &$form['actions']['submit']['#submit'];
}
$index = array_search('::save', $submit_handlers);
if (is_integer($index)) {
array_splice($submit_handlers, $index, 0, ['_lightning_workflow_node_type_add_form_submit']);
}
}
/**
* Submit handler for node_type_add_form.
*/
function _lightning_workflow_node_type_add_form_submit(array &$form, FormStateInterface $form_state) {
$workflow = $form_state->getValue('workflow');
if ($workflow) {
/** @var \Drupal\node\NodeTypeInterface $node_type */
$node_type = $form_state->getFormObject()->getEntity();
assert($node_type->isNew());
$node_type->setThirdPartySetting('lightning_workflow', 'workflow', $workflow);
}
}
/**
* Implements hook_ENTITY_TYPE_insert().
*/
function lightning_workflow_node_type_insert(NodeTypeInterface $node_type) {
// Don't do anything during a config sync.
if (Drupal::isConfigSyncing()) {
return;
}
$workflow = $node_type->getThirdPartySetting('lightning_workflow', 'workflow');
if ($workflow) {
_lightning_workflow_moderate_content_type($node_type, $workflow);
}
// If autosave_form is present, enable it for this content type by default.
if (Drupal::moduleHandler()->moduleExists('autosave_form') && $node_type->getThirdPartySetting('lightning_workflow', 'autosave', TRUE)) {
$id = $node_type->id();
Drupal::configFactory()
->getEditable('autosave_form.settings')
->set("allowed_content_entity_types.node.bundles.$id", $id)
->save();
}
}
/**
* Adds a content type to a moderation workflow.
*
* @param \Drupal\node\NodeTypeInterface $node_type
* The content type.
* @param string $workflow_id
* The workflow ID. The workflow must exist and use a plugin that implements
* \Drupal\content_moderation\Plugin\WorkflowType\ContentModerationInterface.
*
* @internal
* This function may be changed or removed at any time without warning. It
* should NOT be called by external code!
*/
function _lightning_workflow_moderate_content_type(NodeTypeInterface $node_type, $workflow_id) {
$workflow = Workflow::load($workflow_id);
if (empty($workflow)) {
return;
}
$plugin = $workflow->getTypePlugin();
if ($plugin instanceof ContentModerationInterface) {
$plugin->addEntityTypeAndBundle('node', $node_type->id());
$workflow->save();
// The moderation_history view depends on the existence of the
// moderation_state base field, which is only defined once a content type
// has been opted into moderation. Now that's done, so create the
// moderation_history view if it doesn't already exist.
if (Drupal::moduleHandler()->moduleExists('views')) {
$view = View::load('moderation_history');
if (empty($view)) {
$values = file_get_contents(__DIR__ . '/config/dynamic/views.view.moderation_history.yml');
$values = Yaml::decode($values);
View::create($values)->save();
}
}
// We need to rebuild all routes because Content Moderation needs to ensure
// that edit forms load the latest revision, and that the moderation_history
// view's routes are registered if needed.
Drupal::service('router.builder')->rebuild();
}
}
/**
* Implements hook_theme_registry_alter().
*/
function lightning_workflow_theme_registry_alter(array &$theme_registry) {
foreach ($theme_registry as $hook => &$info) {
if ($hook == 'field' || (isset($info['base hook']) && $info['base hook'] == 'field')) {
// We wrap around Quick Edit's preprocess function, so it should not be
// run directly.
$info['preprocess functions'] = array_diff($info['preprocess functions'], ['quickedit_preprocess_field']);
}
}
}
/**
* Implements template_preprocess_field().
*/
function lightning_workflow_preprocess_field(array &$variables) {
if (\Drupal::moduleHandler()->moduleExists('quickedit')) {
quickedit_preprocess_field($variables);
/** @var \Drupal\Core\Entity\EntityInterface $entity */
$entity = $variables['element']['#object'];
if ($entity instanceof EntityPublishedInterface && $entity->isPublished() && RouteSubscriber::isViewing($entity)) {
unset($variables['attributes']['data-quickedit-field-id']);
}
}
}
/**
* Implements template_preprocess_block().
*/
function lightning_workflow_preprocess_block(array &$variables) {
$variables['attributes']['data-block-plugin-id'] = $variables['elements']['#plugin_id'];
}
/**
* Implements hook_local_tasks_alter().
*/
function lightning_workflow_local_tasks_alter(array &$local_tasks) {
// When Content Moderation is installed, the "Edit" tab may have different
// text, depending on the circumstances. In order for Behat tests to visit
// the edit form, there must be a consistent way to target the tab. Rather
// than rely on the text, set a consistent 'rel' attribute which step
// definitions can reliably target.
$local_tasks['entity.node.edit_form']['options']['attributes']['rel'] = 'edit-form';
}
/**
* Implements hook_module_implements_alter().
*/
function lightning_workflow_module_implements_alter(array &$implementations, $hook) {
// We have to check for hook_node_view_alter() because of absolute insanity
// in ModuleHandler::alter() and the way it determines the implementations of
// 'secondary' alter hooks. It's weird logic that is pretty close to
// inexplicable...but trust me, to wrap around quickedit_entity_view_alter(),
// we need to alter the implementations of hook_node_view_alter(). Granted,
// this will only work for nodes. If we want to do this for another entity
// type, we'll have to check for its entity type-specific view_alter hook as
// well.
if ($hook == 'node_view_alter') {
unset($implementations['quickedit']);
}
}
/**
* Implements hook_entity_view_alter().
*/
function lightning_workflow_entity_view_alter(array &$build, EntityInterface $entity, EntityViewDisplayInterface $display) {
if (\Drupal::moduleHandler()->moduleExists('quickedit')) {
quickedit_entity_view_alter($build, $entity, $display);
if ($entity instanceof EntityPublishedInterface && $entity->isPublished() && RouteSubscriber::isViewing($entity)) {
unset($build['#attributes']['data-quickedit-entity-id']);
}
}
// Ensure that Quick Edit will be enabled on the latest revision. This
// implements the logic in
// https://www.drupal.org/project/drupal/issues/2815221, but without needing
// to patch core. This can all be removed when that issue is committed; see
// also \Drupal\lightning_workflow\Routing\RouteSubscriber.
$entity_type_id = $entity->getEntityTypeId();
if (isset($build['#contextual_links']["{$entity_type_id}_revision"]) && $entity instanceof RevisionableInterface && $entity->isLatestRevision()) {
$build['#contextual_links']["{$entity_type_id}_latest_version"] = $build['#contextual_links']["{$entity_type_id}_revision"];
}
}
/**
* Implements hook_modules_installed().
*/
function lightning_workflow_modules_installed(array $modules) {
// Don't do anything during config sync.
if (Drupal::isConfigSyncing()) {
return;
}
if (in_array('lightning_roles', $modules, TRUE)) {
Drupal::service('lightning.content_roles')
->grantPermissions('creator', [
'use editorial transition create_new_draft',
'use editorial transition review',
'view any unpublished content',
'view latest version',
'use moderation sidebar',
])
->grantPermissions('reviewer', [
'use editorial transition publish',
'use editorial transition review',
'use editorial transition archive',
'view any unpublished content',
'view latest version',
'access toolbar',
'use moderation sidebar',
]);
}
if (in_array('autosave_form', $modules, TRUE)) {
// Find all content types that would like to opt into autosave by default,
// either implicitly or explicitly. I'm not sure this can be done with a
// simple entity query, since it's not clear if one can specify a condition
// that a third-party setting is "not FALSE".
$node_types = array_filter(NodeType::loadMultiple(), function (NodeTypeInterface $node_type) {
return $node_type->getThirdPartySetting('lightning_workflow', 'autosave', TRUE);
});
$node_types = array_keys($node_types);
Drupal::configFactory()
->getEditable('autosave_form.settings')
->set('interval', 20000)
->set('allowed_content_entity_types.node.bundles', array_combine($node_types, $node_types))
->save();
}
}
/**
* Implements hook_views_data_alter().
*/
function lightning_workflow_views_data_alter(array &$data) {
foreach ($data as $table => $table_data) {
if (isset($table_data['moderation_state']['field'])) {
$data[$table]['moderation_state']['field'] += ['id' => 'null'];
}
}
}
/**
* Implements hook_entity_type_alter().
*/
function lightning_workflow_entity_type_alter(array &$entity_types) {
// If autosave_form is installed, all entity types should use our special
// autosave handler which disables autosave in the Layout Builder UI.
if (Drupal::moduleHandler()->moduleExists('autosave_form')) {
/** @var \Drupal\Core\Entity\EntityTypeInterface $entity_type */
foreach ($entity_types as $entity_type) {
// We cannot use the ::class form here, because it will go kaboom if
// autosave_form is not installed.
Override::entityHandler($entity_type, 'autosave_form', '\Drupal\lightning_workflow\AutosaveEntityFormHandler');
}
}
}
/**
* Implements hook_views_plugins_field_alter().
*/
function lightning_workflow_views_plugins_field_alter(array &$plugins) {
if (isset($plugins['node_bulk_form'])) {
$plugins['node_bulk_form']['class'] = NodeBulkForm::class;
}
}
/**
* Implements hook_views_pre_render().
*/
function lightning_workflow_views_pre_render(ViewExecutable $view) {
if ($view->id() == 'moderation_history') {
foreach ($view->result as $index => $row) {
$entity = $row->_entity;
if (empty($previous) || $previous->moderation_state->value != $entity->moderation_state->value) {
$previous = $entity;
}
else {
unset($view->result[$index]);
$view->total_rows--;
}
}
}
}
/**
* Implements hook_entity_extra_field_info_alter().
*/
function lightning_workflow_entity_extra_field_info_alter(array &$info) {
$moderation_sidebar_exists = Drupal::moduleHandler()->moduleExists('moderation_sidebar');
foreach ($info as &$entity_type) {
foreach ($entity_type as &$bundle) {
if (isset($bundle['display']['content_moderation_control'])) {
// Hide moderation pseudo-fields if Moderation Sidebar is enabled.
$bundle['display']['content_moderation_control']['visible'] = !$moderation_sidebar_exists;
}
}
}
}
