MenuUiNodeTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\menu_ui\Functional;

use Drupal\language\Entity\ConfigurableLanguage;
use Drupal\menu_link_content\Entity\MenuLinkContent;
use Drupal\node\Entity\Node;
use Drupal\node\Entity\NodeType;
use Drupal\system\Entity\Menu;
use Drupal\Tests\BrowserTestBase;
use Drupal\Tests\content_translation\Traits\ContentTranslationTestTrait;

/**
 * Add, edit, and delete a node with menu link.
 *
 * @group menu_ui
 */
class MenuUiNodeTest extends BrowserTestBase {
    use ContentTranslationTestTrait;
    
    /**
     * An editor user.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $editor;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'menu_ui',
        'test_page_test',
        'node',
        'block',
        'locale',
        'language',
        'content_translation',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->drupalPlaceBlock('system_menu_block:main');
        $this->drupalPlaceBlock('page_title_block');
        $this->drupalCreateContentType([
            'type' => 'page',
            'name' => 'Basic page',
        ]);
        $this->editor = $this->drupalCreateUser([
            'access administration pages',
            'administer content types',
            'administer menu',
            'create page content',
            'edit any page content',
            'delete any page content',
            'create content translations',
            'update content translations',
            'delete content translations',
            'translate any entity',
        ]);
        $this->drupalLogin($this->editor);
    }
    
    /**
     * Tests creating, editing, deleting menu links via node form widget.
     */
    public function testMenuNodeFormWidget() : void {
        // Verify that cacheability metadata is bubbled from the menu link tree
        // access checking that is performed when determining the "default parent
        // item" options in menu_ui_form_node_type_form_alter(). The "log out" link
        // adds the "user.roles:authenticated" cache context.
        $this->drupalGet('admin/structure/types/manage/page');
        $this->assertSession()
            ->responseHeaderContains('X-Drupal-Cache-Contexts', 'user.roles:authenticated');
        // Assert the description of "Available menus" checkboxes field.
        $this->assertSession()
            ->pageTextContains('Content of this type can be placed in the selected menus.');
        // Verify that the menu link title has the correct maxlength.
        $title_max_length = \Drupal::service('entity_field.manager')->getBaseFieldDefinitions('menu_link_content')['title']
            ->getSetting('max_length');
        $this->drupalGet('node/add/page');
        $this->assertSession()
            ->responseMatches('/<input .* id="edit-menu-title" .* maxlength="' . $title_max_length . '" .* \\/>/');
        // Verify that the menu link description has the correct maxlength.
        $description_max_length = \Drupal::service('entity_field.manager')->getBaseFieldDefinitions('menu_link_content')['description']
            ->getSetting('max_length');
        $this->drupalGet('node/add/page');
        $this->assertSession()
            ->responseMatches('/<input .* id="edit-menu-description" .* maxlength="' . $description_max_length . '" .* \\/>/');
        // Disable the default main menu, so that no menus are enabled.
        $edit = [
            'menu_options[main]' => FALSE,
        ];
        $this->drupalGet('admin/structure/types/manage/page');
        $this->submitForm($edit, 'Save');
        // Verify that no menu settings are displayed and nodes can be created.
        $this->drupalGet('node/add/page');
        $this->assertSession()
            ->pageTextContains('Create Basic page');
        $this->assertSession()
            ->pageTextNotContains('Menu settings');
        $node_title = $this->randomMachineName();
        $edit = [
            'title[0][value]' => $node_title,
            'body[0][value]' => $this->randomString(),
        ];
        $this->submitForm($edit, 'Save');
        $node = $this->drupalGetNodeByTitle($node_title);
        $this->assertEquals($edit['title[0][value]'], $node->getTitle());
        // Test that we cannot set a menu item from a menu that is not set as
        // available.
        $edit = [
            'menu_options[tools]' => 1,
            'menu_parent' => 'main:',
        ];
        $this->drupalGet('admin/structure/types/manage/page');
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->pageTextContains('The selected menu link is not under one of the selected menus.');
        $this->assertSession()
            ->pageTextNotContains("The content type Basic page has been updated.");
        // Enable Tools menu as available menu.
        $edit = [
            'menu_options[main]' => 1,
            'menu_options[tools]' => 1,
            'menu_parent' => 'main:',
        ];
        $this->drupalGet('admin/structure/types/manage/page');
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->pageTextContains("The content type Basic page has been updated.");
        // Test that we can preview a node that will create a menu item.
        $edit = [
            'title[0][value]' => $node_title,
            'menu[enabled]' => 1,
            'menu[title]' => 'Test preview',
        ];
        $this->drupalGet('node/add/page');
        $this->submitForm($edit, 'Preview');
        // Create a node.
        $node_title = $this->randomMachineName();
        $edit = [
            'title[0][value]' => $node_title,
            'body[0][value]' => $this->randomString(),
        ];
        $this->drupalGet('node/add/page');
        $this->submitForm($edit, 'Save');
        $node = $this->drupalGetNodeByTitle($node_title);
        // Assert that there is no link for the node.
        $this->drupalGet('test-page');
        $this->assertSession()
            ->linkNotExists($node_title);
        // Edit the node, enable the menu link setting, but skip the link title.
        $edit = [
            'menu[enabled]' => 1,
        ];
        $this->drupalGet('node/' . $node->id() . '/edit');
        $this->submitForm($edit, 'Save');
        // Assert that there is a link for the node.
        $this->drupalGet('test-page');
        $this->assertSession()
            ->linkExists($node_title);
        // Make sure the menu links only appear when the node is published.
        // These buttons just appear for 'administer nodes' users.
        $admin_user = $this->drupalCreateUser([
            'access administration pages',
            'administer content types',
            'administer nodes',
            'administer menu',
            'create page content',
            'edit any page content',
        ]);
        $this->drupalLogin($admin_user);
        // Assert that the link does not exist if unpublished.
        $edit = [
            'menu[enabled]' => 1,
            'menu[title]' => $node_title,
            'status[value]' => FALSE,
        ];
        $this->drupalGet('node/' . $node->id() . '/edit');
        $this->submitForm($edit, 'Save');
        $this->drupalGet('test-page');
        $this->assertSession()
            ->linkNotExists($node_title, 'Found no menu link with the node unpublished');
        // Assert that the link exists if published.
        $edit['status[value]'] = TRUE;
        $this->drupalGet('node/' . $node->id() . '/edit');
        $this->submitForm($edit, 'Save');
        $this->drupalGet('test-page');
        $this->assertSession()
            ->linkExists($node_title, 0, 'Found a menu link with the node published');
        // Log back in as normal user.
        $this->drupalLogin($this->editor);
        // Edit the node and create a menu link.
        $edit = [
            'menu[enabled]' => 1,
            'menu[title]' => $node_title,
            'menu[weight]' => 17,
        ];
        $this->drupalGet('node/' . $node->id() . '/edit');
        $this->submitForm($edit, 'Save');
        // Assert that the link exists.
        $this->drupalGet('test-page');
        $this->assertSession()
            ->linkExists($node_title);
        // Check if menu weight is 17.
        $this->drupalGet('node/' . $node->id() . '/edit');
        $this->assertSession()
            ->fieldValueEquals('edit-menu-weight', 17);
        // Verify that the menu link title field has correct maxlength in node edit
        // form.
        $this->assertSession()
            ->responseMatches('/<input .* id="edit-menu-title" .* maxlength="' . $title_max_length . '" .* \\/>/');
        // Verify that the menu link description field has correct maxlength in
        // node add form.
        $this->assertSession()
            ->responseMatches('/<input .* id="edit-menu-description" .* maxlength="' . $description_max_length . '" .* \\/>/');
        // Disable the menu link, then edit the node--the link should stay disabled.
        $link_id = menu_ui_get_menu_link_defaults($node)['entity_id'];
        
        /** @var \Drupal\menu_link_content\Entity\MenuLinkContent $link */
        $link = MenuLinkContent::load($link_id);
        $link->set('enabled', FALSE);
        $link->save();
        $this->drupalGet($node->toUrl('edit-form'));
        $this->submitForm($edit, 'Save');
        $link = MenuLinkContent::load($link_id);
        $this->assertFalse($link->isEnabled(), 'Saving a node with a disabled menu link keeps the menu link disabled.');
        // Edit the node and remove the menu link.
        $edit = [
            'menu[enabled]' => FALSE,
        ];
        $this->drupalGet('node/' . $node->id() . '/edit');
        $this->submitForm($edit, 'Save');
        // Assert that there is no link for the node.
        $this->drupalGet('test-page');
        $this->assertSession()
            ->linkNotExists($node_title);
        // Add a menu link to the Administration menu.
        $item = MenuLinkContent::create([
            'link' => [
                [
                    'uri' => 'entity:node/' . $node->id(),
                ],
            ],
            'title' => $this->randomMachineName(16),
            'menu_name' => 'admin',
        ]);
        $item->save();
        // Assert that disabled Administration menu is not shown on the
        // node/$nid/edit page.
        $this->drupalGet('node/' . $node->id() . '/edit');
        $this->assertSession()
            ->pageTextContains('Provide a menu link');
        // Assert that the link is still in the Administration menu after save.
        $this->drupalGet('node/' . $node->id() . '/edit');
        $this->submitForm($edit, 'Save');
        $link = MenuLinkContent::load($item->id());
        $this->assertInstanceOf(MenuLinkContent::class, $link);
        // Move the menu link back to the Tools menu.
        $item->menu_name->value = 'tools';
        $item->save();
        // Create a second node.
        $child_node = $this->drupalCreateNode([
            'type' => 'article',
        ]);
        // Assign a menu link to the second node, being a child of the first one.
        $child_item = MenuLinkContent::create([
            'link' => [
                [
                    'uri' => 'entity:node/' . $child_node->id(),
                ],
            ],
            'title' => $this->randomMachineName(16),
            'parent' => $item->getPluginId(),
            'menu_name' => $item->getMenuName(),
        ]);
        $child_item->save();
        // Edit the first node.
        $this->drupalGet('node/' . $node->id() . '/edit');
        // Assert that it is not possible to set the parent of the first node to itself or the second node.
        $this->assertSession()
            ->optionNotExists('edit-menu-menu-parent', 'tools:' . $item->getPluginId());
        $this->assertSession()
            ->optionNotExists('edit-menu-menu-parent', 'tools:' . $child_item->getPluginId());
        // Assert that disallowed Administration menu is not available in options.
        $this->assertSession()
            ->optionNotExists('edit-menu-menu-parent', 'admin:');
    }
    
    /**
     * Testing correct loading and saving of menu links via node form widget in a multilingual environment.
     */
    public function testMultilingualMenuNodeFormWidget() : void {
        // Setup languages.
        $langcodes = [
            'de',
        ];
        foreach ($langcodes as $langcode) {
            static::createLanguageFromLangcode($langcode);
        }
        array_unshift($langcodes, \Drupal::languageManager()->getDefaultLanguage()
            ->getId());
        $config = \Drupal::service('config.factory')->getEditable('language.negotiation');
        // Ensure path prefix is used to determine the language.
        $config->set('url.source', 'path_prefix');
        // Ensure that there's a path prefix set for english as well.
        $config->set('url.prefixes.' . $langcodes[0], $langcodes[0]);
        $config->save();
        $languages = [];
        foreach ($langcodes as $langcode) {
            $languages[$langcode] = ConfigurableLanguage::load($langcode);
        }
        // Enable translation for pages and menu link content..
        $this->enableContentTranslation('node', 'page');
        $this->enableContentTranslation('menu_link_content', 'menu_link_content');
        $this->rebuildContainer();
        // Create a node.
        $node_title = $this->randomMachineName(8);
        $node = Node::create([
            'type' => 'page',
            'title' => $node_title,
            'body' => $this->randomMachineName(16),
            'uid' => $this->editor
                ->id(),
            'status' => 1,
            'langcode' => $langcodes[0],
        ]);
        $node->save();
        // Create translation.
        $translated_node_title = $this->randomMachineName(8);
        $node->addTranslation($langcodes[1], [
            'title' => $translated_node_title,
            'body' => $this->randomMachineName(16),
            'status' => 1,
        ]);
        $node->save();
        // Edit the node and create a menu link.
        $edit = [
            'menu[enabled]' => 1,
            'menu[title]' => $node_title,
            'menu[weight]' => 17,
        ];
        $options = [
            'language' => $languages[$langcodes[0]],
        ];
        $url = $node->toUrl('edit-form', $options);
        $this->drupalGet($url);
        $this->submitForm($edit, 'Save (this translation)');
        // Edit the node in a different language and translate the menu link.
        $edit = [
            'menu[enabled]' => 1,
            'menu[title]' => $translated_node_title,
            'menu[weight]' => 17,
        ];
        $options = [
            'language' => $languages[$langcodes[1]],
        ];
        $url = $node->toUrl('edit-form', $options);
        $this->drupalGet($url);
        $this->submitForm($edit, 'Save (this translation)');
        // Assert that the original link exists in the frontend.
        $this->drupalGet('node/' . $node->id(), [
            'language' => $languages[$langcodes[0]],
        ]);
        $this->assertSession()
            ->linkExists($node_title);
        // Assert that the translated link exists in the frontend.
        $this->drupalGet('node/' . $node->id(), [
            'language' => $languages[$langcodes[1]],
        ]);
        $this->assertSession()
            ->linkExists($translated_node_title);
        // Revisit the edit page in original language, check the loaded menu item title and save.
        $options = [
            'language' => $languages[$langcodes[0]],
        ];
        $url = $node->toUrl('edit-form', $options);
        $this->drupalGet($url);
        $this->assertSession()
            ->fieldValueEquals('edit-menu-title', $node_title);
        $this->submitForm([], 'Save (this translation)');
        // Revisit the edit page of the translation and check the loaded menu item title.
        $options = [
            'language' => $languages[$langcodes[1]],
        ];
        $url = $node->toUrl('edit-form', $options);
        $this->drupalGet($url);
        $this->assertSession()
            ->fieldValueEquals('edit-menu-title', $translated_node_title);
    }
    
    /**
     * Tests creating menu links via node form widget for nodes with grants.
     */
    public function testMenuNodeWithGrantsFormWidget() : void {
        \Drupal::service('module_installer')->install([
            'node_access_test',
        ]);
        node_access_rebuild();
        $this->assertTrue(\Drupal::moduleHandler()->hasImplementations('node_grants'));
        $admin_user = $this->drupalCreateUser([
            'access administration pages',
            'administer content types',
            'administer nodes',
            'administer menu',
            'create page content',
            'edit any page content',
        ]);
        $this->drupalLogin($admin_user);
        $node_title = $this->randomMachineName();
        $edit = [
            'title[0][value]' => $node_title,
            'menu[enabled]' => 1,
            'menu[title]' => $node_title,
            'status[value]' => 0,
        ];
        $this->drupalGet('node/add/page');
        $this->submitForm($edit, 'Save');
        $node = $this->drupalGetNodeByTitle($node_title);
        $this->assertTrue($node->access('view', $admin_user));
        $this->drupalGet('node/add/page');
        $link_id = menu_ui_get_menu_link_defaults($node)['entity_id'];
        
        /** @var \Drupal\menu_link_content\Entity\MenuLinkContent $link */
        $link = MenuLinkContent::load($link_id);
        $this->assertSession()
            ->optionExists('edit-menu-menu-parent', 'main:' . $link->getPluginId());
        // Assert that the unpublished node cannot be selected as a parent menu link
        // for users without access to the node.
        $admin_user_without_content_access = $this->drupalCreateUser([
            'access administration pages',
            'administer content types',
            'administer nodes',
            'administer menu',
            'create page content',
            'edit any page content',
        ]);
        $this->drupalLogin($admin_user_without_content_access);
        $this->assertFalse($node->access('view', $admin_user_without_content_access));
        $this->drupalGet('node/add/page');
        $this->assertSession()
            ->optionNotExists('edit-menu-menu-parent', 'main:' . $link->getPluginId());
    }
    
    /**
     * Tests main menu links are prioritized when editing nodes.
     *
     * @see menu_ui_get_menu_link_defaults()
     */
    public function testMainMenuIsPrioritized() : void {
        $this->drupalLogin($this->drupalCreateUser([
            'administer menu',
            'edit any page content',
        ]));
        $menu_name = $this->randomMachineName();
        $mainLinkTitle = $this->randomMachineName();
        $nonMainLinkTitle = $this->randomMachineName();
        Menu::create([
            'id' => $menu_name,
            'label' => $menu_name,
        ])->save();
        $nodeType = NodeType::load('page');
        $nodeType->setThirdPartySetting('menu_ui', 'available_menus', [
            $menu_name,
            'main',
        ])
            ->save();
        $node = Node::create([
            'type' => 'page',
            'title' => $this->randomMachineName(),
            'uid' => $this->rootUser
                ->id(),
            'status' => 1,
        ]);
        $node->save();
        MenuLinkContent::create([
            'link' => [
                [
                    'uri' => 'entity:node/' . $node->id(),
                ],
            ],
            'title' => $nonMainLinkTitle,
            'menu_name' => $menu_name,
        ])
            ->save();
        MenuLinkContent::create([
            'link' => [
                [
                    'uri' => 'entity:node/' . $node->id(),
                ],
            ],
            'title' => $mainLinkTitle,
            'menu_name' => 'main',
        ])
            ->save();
        $this->drupalGet('node/' . $node->id() . '/edit');
        $element = $this->assertSession()
            ->elementExists('css', 'input[name="menu[title]"]');
        $this->assertEquals($mainLinkTitle, $element->getValue());
    }

}