o3de/Gems/Atom/Tools/MaterialEditor/Code/Source/Window/MaterialBrowserInteractions.cpp

/*
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
* its licensors.
*
* For complete copyright and license terms please see the LICENSE at the root of this
* distribution (the "License"). All use of this software is governed by the License,
* or, if provided, by the license below or the license accompanying this file. Do not
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
*/

#include <QApplication>
#include <QClipboard>
#include <QMenu>
#include <QInputDialog>
#include <QMessageBox>
#include <QFileDialog>
#include <QDesktopServices>

#include <AzQtComponents/Utilities/DesktopUtilities.h>

#include <AzToolsFramework/AssetBrowser/AssetBrowserEntry.h>
#include <AzToolsFramework/AssetBrowser/AssetSelectionModel.h>
#include <AzToolsFramework/AssetBrowser/AssetBrowserBus.h>
#include <AzToolsFramework/Thumbnails/SourceControlThumbnail.h>
#include <AtomToolsFramework/Util/Util.h>

#include <Atom/Document/MaterialDocumentSystemRequestBus.h>

#include <Source/Window/MaterialBrowserInteractions.h>

#include <Atom/RPI.Reflect/Material/MaterialAsset.h>
#include <Atom/RPI.Edit/Material/MaterialSourceData.h>
#include <Atom/RPI.Edit/Material/MaterialTypeSourceData.h>

namespace MaterialEditor
{
    MaterialBrowserInteractions::MaterialBrowserInteractions()
    {
        using namespace AzToolsFramework::AssetBrowser;

        AssetBrowserInteractionNotificationBus::Handler::BusConnect();
    }

    MaterialBrowserInteractions::~MaterialBrowserInteractions()
    {
        AssetBrowserInteractionNotificationBus::Handler::BusDisconnect();
    }

    void MaterialBrowserInteractions::AddContextMenuActions(QWidget* caller, QMenu* menu, const AZStd::vector<AzToolsFramework::AssetBrowser::AssetBrowserEntry*>& entries)
    {
        AssetBrowserEntry* entry = entries.empty() ? nullptr : entries.front();
        if (!entry)
        {
            return;
        }

        m_caller = caller;
        QObject::connect(m_caller, &QObject::destroyed, [this]()
        {
            m_caller = nullptr;
        });

        AddGenericContextMenuActions(caller, menu, entry);

        if (entry->GetEntryType() == AssetBrowserEntry::AssetEntryType::Source)
        {
            const auto source = azalias_cast<const SourceAssetBrowserEntry*>(entry);
            if (AzFramework::StringFunc::Path::IsExtension(entry->GetFullPath().c_str(), MaterialExtension))
            {
                AddContextMenuActionsForMaterialSource(caller, menu, source);
            }
            else if (AzFramework::StringFunc::Path::IsExtension(entry->GetFullPath().c_str(), MaterialTypeExtension))
            {
                AddContextMenuActionsForMaterialTypeSource(caller, menu, source);
            }
            else
            {
                AddContextMenuActionsForOtherSource(caller, menu, source);
            }
        }
        else if (entry->GetEntryType() == AssetBrowserEntry::AssetEntryType::Folder)
        {
            const auto folder = azalias_cast<const FolderAssetBrowserEntry*>(entry);
            AddContextMenuActionsForFolder(caller, menu, folder);
        }
    }

    void MaterialBrowserInteractions::AddGenericContextMenuActions([[maybe_unused]] QWidget* caller, QMenu* menu, const AzToolsFramework::AssetBrowser::AssetBrowserEntry* entry)
    {
        menu->addAction(QObject::tr("Copy Name To Clipboard"), [=]()
            {
                QApplication::clipboard()->setText(entry->GetName().c_str());
            });
        menu->addAction(QObject::tr("Copy Path To Clipboard"), [=]()
            {
                QApplication::clipboard()->setText(entry->GetFullPath().c_str());
            });
    }

    void MaterialBrowserInteractions::AddContextMenuActionsForMaterialTypeSource(QWidget* caller, QMenu* menu, const AzToolsFramework::AssetBrowser::SourceAssetBrowserEntry* entry)
    {
        menu->addAction(AzQtComponents::fileBrowserActionName(), [entry]()
        {
            AzQtComponents::ShowFileOnDesktop(entry->GetFullPath().c_str());
        });

        menu->addSeparator();

        menu->addAction("Create Material...", [entry]()
        {
            const QString defaultPath = AtomToolsFramework::GetUniqueFileInfo(
                QString(AZ::IO::FileIOBase::GetInstance()->GetAlias("@devassets@")) +
                AZ_CORRECT_FILESYSTEM_SEPARATOR + "Materials" +
                AZ_CORRECT_FILESYSTEM_SEPARATOR + "untitled." +
                AZ::RPI::MaterialSourceData::Extension).absoluteFilePath();

            MaterialDocumentSystemRequestBus::Broadcast(&MaterialDocumentSystemRequestBus::Events::CreateDocumentFromFile,
                entry->GetFullPath(), AtomToolsFramework::GetSaveFileInfo(defaultPath).absoluteFilePath().toUtf8().constData());
        });

        AddPerforceMenuActions(caller, menu, entry);
    }

    void MaterialBrowserInteractions::AddContextMenuActionsForOtherSource(QWidget* caller, QMenu* menu, const AzToolsFramework::AssetBrowser::SourceAssetBrowserEntry* entry)
    {
        menu->addAction("Open", [entry]()
        {
            QDesktopServices::openUrl(QUrl::fromLocalFile(entry->GetFullPath().c_str()));
        });

        menu->addAction("Duplicate...", [entry, caller]()
        {
            const QFileInfo duplicateFileInfo(AtomToolsFramework::GetDuplicationFileInfo(entry->GetFullPath().c_str()));
            if (!duplicateFileInfo.absoluteFilePath().isEmpty())
            {
                if (QFile::copy(entry->GetFullPath().c_str(), duplicateFileInfo.absoluteFilePath()))
                {
                    QFile::setPermissions(duplicateFileInfo.absoluteFilePath(), QFile::ReadOther | QFile::WriteOther);

                    // Auto add file to source control
                    AzToolsFramework::SourceControlCommandBus::Broadcast(&AzToolsFramework::SourceControlCommandBus::Events::RequestEdit,
                        duplicateFileInfo.absoluteFilePath().toUtf8().constData(), true, [](bool, const AzToolsFramework::SourceControlFileInfo&) {});
                }
            }
        });

        menu->addAction(AzQtComponents::fileBrowserActionName(), [entry]()
        {
            AzQtComponents::ShowFileOnDesktop(entry->GetFullPath().c_str());
        });

        AddPerforceMenuActions(caller, menu, entry);
    }

    void MaterialBrowserInteractions::AddContextMenuActionsForMaterialSource(QWidget* caller, QMenu* menu, const AzToolsFramework::AssetBrowser::SourceAssetBrowserEntry* entry)
    {
        menu->addAction("Open", [entry]()
        {
            MaterialDocumentSystemRequestBus::Broadcast(&MaterialDocumentSystemRequestBus::Events::OpenDocument, entry->GetFullPath());
        });

        menu->addAction("Duplicate...", [entry, caller]()
        {
            const QFileInfo duplicateFileInfo(AtomToolsFramework::GetDuplicationFileInfo(entry->GetFullPath().c_str()));
            if (!duplicateFileInfo.absoluteFilePath().isEmpty())
            {
                if (QFile::copy(entry->GetFullPath().c_str(), duplicateFileInfo.absoluteFilePath()))
                {
                    QFile::setPermissions(duplicateFileInfo.absoluteFilePath(), QFile::ReadOther | QFile::WriteOther);

                    // Auto add file to source control
                    AzToolsFramework::SourceControlCommandBus::Broadcast(&AzToolsFramework::SourceControlCommandBus::Events::RequestEdit,
                        duplicateFileInfo.absoluteFilePath().toUtf8().constData(), true, [](bool, const AzToolsFramework::SourceControlFileInfo&) {});
                }
            }
        });

        menu->addAction(AzQtComponents::fileBrowserActionName(), [entry]()
        {
            AzQtComponents::ShowFileOnDesktop(entry->GetFullPath().c_str());
        });

        menu->addSeparator();

        menu->addAction("Create Child Material...", [entry]()
        {
            const QString defaultPath = AtomToolsFramework::GetUniqueFileInfo(
                QString(AZ::IO::FileIOBase::GetInstance()->GetAlias("@devassets@")) +
                AZ_CORRECT_FILESYSTEM_SEPARATOR + "Materials" +
                AZ_CORRECT_FILESYSTEM_SEPARATOR + "untitled." +
                AZ::RPI::MaterialSourceData::Extension).absoluteFilePath();

            MaterialDocumentSystemRequestBus::Broadcast(&MaterialDocumentSystemRequestBus::Events::CreateDocumentFromFile,
                entry->GetFullPath(), AtomToolsFramework::GetSaveFileInfo(defaultPath).absoluteFilePath().toUtf8().constData());
        });

        menu->addSeparator();

        QAction* openParentAction = menu->addAction("Open Parent Material", [entry]()
        {
            AZ_UNUSED(entry);
            // ToDo
        });
        openParentAction->setEnabled(false);

        AddPerforceMenuActions(caller, menu, entry);
    }

    void MaterialBrowserInteractions::AddContextMenuActionsForFolder(QWidget* caller, QMenu* menu, const AzToolsFramework::AssetBrowser::FolderAssetBrowserEntry* entry)
    {
        menu->addAction(AzQtComponents::fileBrowserActionName(), [entry]()
        {
            AzQtComponents::ShowFileOnDesktop(entry->GetFullPath().c_str());
        });

        QAction* createFolderAction = menu->addAction(QObject::tr("Create new sub folder..."));
        QObject::connect(createFolderAction, &QAction::triggered, caller, [caller, entry]()
        {
            bool ok;
            QString newFolderName = QInputDialog::getText(caller, "Enter new folder name", "name:", QLineEdit::Normal, "NewFolder", &ok);
            if (ok)
            {
                if (newFolderName.isEmpty())
                {
                    QMessageBox msgBox(QMessageBox::Icon::Critical, "Error", "Folder name can't be empty", QMessageBox::Ok, caller);
                    msgBox.exec();
                }
                else
                {
                    AZStd::string newFolderPath;
                    AzFramework::StringFunc::Path::Join(entry->GetFullPath().c_str(), newFolderName.toUtf8().constData(), newFolderPath);
                    QDir dir(newFolderPath.c_str());
                    if (dir.exists())
                    {
                        QMessageBox::critical(caller, "Error", "Folder with this name already exists");
                        return;
                    }
                    auto result = dir.mkdir(newFolderPath.c_str());
                    if (!result)
                    {
                        AZ_Error("MaterialBrowser", false, "Failed to make new folder");
                        return;
                    }
                }
            }
        });
    }

    void MaterialBrowserInteractions::AddPerforceMenuActions([[maybe_unused]] QWidget* caller, QMenu* menu, const AzToolsFramework::AssetBrowser::AssetBrowserEntry* entry)
    {
        using namespace AzToolsFramework;

        bool isActive = false;
        SourceControlConnectionRequestBus::BroadcastResult(isActive, &SourceControlConnectionRequests::IsActive);

        if (isActive)
        {
            menu->addSeparator();

            AZStd::string path = entry->GetFullPath();
            AzFramework::StringFunc::Path::Normalize(path);

            QMenu* sourceControlMenu = menu->addMenu("Source Control");

            // Update the enabled state of source control menu actions only if menu is shown
            QMenu::connect(sourceControlMenu, &QMenu::aboutToShow, [this, path]()
            {
                SourceControlCommandBus::Broadcast(&SourceControlCommandBus::Events::GetFileInfo, path.c_str(),
                    [this](bool success, const SourceControlFileInfo& info) { UpdateSourceControlActions(success, info); });
            });

            // add get latest action
            m_getLatestAction = sourceControlMenu->addAction("Get Latest", [path, this]()
            {
                SourceControlCommandBus::Broadcast(&SourceControlCommandBus::Events::RequestLatest, path.c_str(),
                    [](bool, const SourceControlFileInfo&) {});
            });
            QObject::connect(m_getLatestAction, &QObject::destroyed, [this]()
            {
                m_getLatestAction = nullptr;
            });
            m_getLatestAction->setEnabled(false);

            // add add action
            m_addAction = sourceControlMenu->addAction("Add", [path]()
            {
                SourceControlCommandBus::Broadcast(&SourceControlCommandBus::Events::RequestEdit, path.c_str(), true,
                    [path](bool, const SourceControlFileInfo&)
                {
                    SourceControlThumbnailRequestBus::Broadcast(&SourceControlThumbnailRequests::FileStatusChanged, path.c_str());
                });
            });
            QObject::connect(m_addAction, &QObject::destroyed, [this]()
            {
                m_addAction = nullptr;
            });
            m_addAction->setEnabled(false);

            // add checkout action
            m_checkOutAction = sourceControlMenu->addAction("Check Out", [path]()
            {
                SourceControlCommandBus::Broadcast(&SourceControlCommandBus::Events::RequestEdit, path.c_str(), true,
                    [path](bool, const SourceControlFileInfo&)
                {
                    SourceControlThumbnailRequestBus::Broadcast(&SourceControlThumbnailRequests::FileStatusChanged, path.c_str());
                });
            });
            QObject::connect(m_checkOutAction, &QObject::destroyed, [this]()
            {
                m_checkOutAction = nullptr;
            });
            m_checkOutAction->setEnabled(false);

            // add undo checkout action
            m_undoCheckOutAction = sourceControlMenu->addAction("Undo Check Out", [path]()
            {
                SourceControlCommandBus::Broadcast(&SourceControlCommandBus::Events::RequestRevert, path.c_str(),
                    [path](bool, const SourceControlFileInfo&)
                {
                    SourceControlThumbnailRequestBus::Broadcast(&SourceControlThumbnailRequests::FileStatusChanged, path.c_str());
                });
            });
            QObject::connect(m_undoCheckOutAction, &QObject::destroyed, [this]()
            {
                m_undoCheckOutAction = nullptr;
            });
            m_undoCheckOutAction->setEnabled(false);
        }
    }

    void MaterialBrowserInteractions::UpdateSourceControlActions(bool success, AzToolsFramework::SourceControlFileInfo info)
    {
        if (!success && m_caller)
        {
            QMessageBox::critical(m_caller, "Error", "Source control operation failed.");
        }
        if (m_getLatestAction)
        {
            m_getLatestAction->setEnabled(info.IsManaged() && info.HasFlag(AzToolsFramework::SCF_OutOfDate));
        }
        if (m_addAction)
        {
            m_addAction->setEnabled(!info.IsManaged());
        }
        if (m_checkOutAction)
        {
            m_checkOutAction->setEnabled(info.IsManaged() && info.IsReadOnly() && !info.IsLockedByOther());
        }
        if (m_undoCheckOutAction)
        {
            m_undoCheckOutAction->setEnabled(info.IsManaged() && !info.IsReadOnly());
        }
    }
} // namespace MaterialEditor