kurlnavigator.cpp

/*
    SPDX-FileCopyrightText: 2006-2010 Peter Penz <peter.penz@gmx.at>
    SPDX-FileCopyrightText: 2006 Aaron J. Seigo <aseigo@kde.org>
    SPDX-FileCopyrightText: 2007 Kevin Ottens <ervin@kde.org>
    SPDX-FileCopyrightText: 2007 Urs Wolfer <uwolfer @ kde.org>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
*/
 
#include "kurlnavigator.h"
#include "kcoreurlnavigator.h"
 
#include "../utils_p.h"
#include "kurlnavigatorbutton_p.h"
#include "kurlnavigatordropdownbutton_p.h"
#include "kurlnavigatorpathselectoreventfilter_p.h"
#include "kurlnavigatorplacesselector_p.h"
#include "kurlnavigatorschemecombo_p.h"
#include "kurlnavigatortogglebutton_p.h"
 
#include <KIO/StatJob>
#include <KLocalizedString>
#include <kfileitem.h>
#include <kfileplacesmodel.h>
#include <kprotocolinfo.h>
#include <kurifilter.h>
#include <kurlcombobox.h>
#include <kurlcompletion.h>
 
#include <QActionGroup>
#include <QApplication>
#include <QClipboard>
#include <QDir>
#include <QDropEvent>
#include <QHBoxLayout>
#include <QKeyEvent>
#include <QMenu>
#include <QMetaMethod>
#include <QMimeData>
#include <QMimeDatabase>
#include <QPainter>
#include <QStyle>
#include <QTimer>
#include <QUrlQuery>
 
#include <algorithm>
#include <numeric>
#include <optional>
 
using namespace KDEPrivate;
 
struct KUrlNavigatorData {
    QByteArray state;
};
Q_DECLARE_METATYPE(KUrlNavigatorData)
 
class KUrlNavigatorPrivate
{
public:
    KUrlNavigatorPrivate(const QUrl &url, KUrlNavigator *qq, KFilePlacesModel *placesModel);
 
    ~KUrlNavigatorPrivate()
    {
        m_dropDownButton->removeEventFilter(q);
        m_pathBox->removeEventFilter(q);
        m_toggleEditableMode->removeEventFilter(q);
 
        for (KUrlNavigatorButton *button : std::as_const(m_navButtons)) {
            button->removeEventFilter(q);
        }
    }
 
    enum class ApplyUrlMethod {
        Apply,
        Tab,
        ActiveTab,
        NewWindow
    };
 
    /** Applies the edited URL in m_pathBox to the URL navigator */
    void applyUncommittedUrl(ApplyUrlMethod method);
    void slotApplyUrl(QUrl url);
 
    // Returns the URI if "text" matched a URI filter (i.e. was fitlered),
    // otherwise returns nullopt.
    std::optional<QUrl> checkFilters(const QString &text);
 
    void slotReturnPressed();
    void slotSchemeChanged(const QString &);
    void openPathSelectorMenu();
 
    /**
     * Appends the widget at the end of the URL navigator. It is assured
     * that the filler widget remains as last widget to fill the remaining
     * width.
     */
    void appendWidget(QWidget *widget, int stretch = 0);
 
    /**
     * This slot is connected to the clicked signal of the navigation bar button. It calls switchView().
     * Moreover, if switching from "editable" mode to the breadcrumb view, it calls applyUncommittedUrl().
     */
    void slotToggleEditableButtonPressed();
 
    /**
     * Switches the navigation bar between the breadcrumb view and the
     * traditional view (see setUrlEditable()).
     */
    void switchView();
 
    /** Emits the signal urlsDropped(). */
    void dropUrls(const QUrl &destination, QDropEvent *event, KUrlNavigatorButton *dropButton);
 
    /**
     * Is invoked when a navigator button has been clicked.
     * Different combinations of mouse clicks and keyboard modifiers have different effects on how
     * the url is opened. The behaviours are the following:
     * - shift+middle-click or ctrl+shift+left-click => activeTabRequested() signal is emitted
     * - ctrl+left-click or middle-click => tabRequested() signal is emitted
     * - shift+left-click => newWindowRequested() signal is emitted
     * - left-click => open the new url in-place
     */
    void slotNavigatorButtonClicked(const QUrl &url, Qt::MouseButton button, Qt::KeyboardModifiers modifiers);
 
    void openContextMenu(const QPoint &p);
 
    void slotPathBoxChanged(const QString &text);
 
    void updateContent();
 
    /**
     * Updates all buttons to have one button for each part of the
     * current URL. Existing buttons, which are available by m_navButtons,
     * are reused if possible. If the URL is longer, new buttons will be
     * created, if the URL is shorter, the remaining buttons will be deleted.
     * @param startIndex    Start index of URL part (/), where the buttons
     *                      should be created for each following part.
     */
    void updateButtons(int startIndex);
 
    /**
     * Updates the visibility state of all buttons describing the URL. If the
     * width of the URL navigator is too small, the buttons representing the upper
     * paths of the URL will be hidden and moved to a drop down menu.
     */
    void updateButtonVisibility();
 
    /**
     * Set a sensible Tab key focus order which goes left to right all the way
     * through all visible child widgets. For right-to-left layout directions
     * the order goes right to left.
     * The first widget is set as the focusProxy() of this KUrlNavigator.
     */
    void updateTabOrder();
 
    /**
     * @return Text for the first button of the URL navigator.
     */
    QString firstButtonText() const;
 
    /**
     * Returns the URL that should be applied for the button with the index \a index.
     */
    QUrl buttonUrl(int index) const;
 
    void switchToBreadcrumbMode();
 
    /**
     * Deletes all URL navigator buttons. m_navButtons is
     * empty after this operation.
     */
    void deleteButtons();
 
    /**
     * Retrieves the place url for the current url.
     * E. g. for the path "fish://root@192.168.0.2/var/lib" the string
     * "fish://root@192.168.0.2" will be returned, which leads to the
     * navigation indication 'Custom Path > var > lib". For e. g.
     * "settings:///System/" the path "settings://" will be returned.
     */
    QUrl retrievePlaceUrl() const;
 
    KUrlNavigator *const q;
 
    QHBoxLayout *m_layout = new QHBoxLayout(q);
    KCoreUrlNavigator *m_coreUrlNavigator = nullptr;
    QList<KUrlNavigatorButton *> m_navButtons;
    QStringList m_supportedSchemes;
    QUrl m_homeUrl;
    KUrlNavigatorPlacesSelector *m_placesSelector = nullptr;
    KUrlComboBox *m_pathBox = nullptr;
    KUrlNavigatorSchemeCombo *m_schemes = nullptr;
    KUrlNavigatorDropDownButton *m_dropDownButton = nullptr;
    KUrlNavigatorButtonBase *m_toggleEditableMode = nullptr;
    QWidget *m_dropWidget = nullptr;
    QWidget *m_badgeWidgetContainer = nullptr;
 
    bool m_editable = false;
    bool m_active = true;
    bool m_showPlacesSelector = false;
    bool m_showFullPath = false;
 
    int m_padding = 4;
 
    struct {
        bool showHidden = false;
        bool sortHiddenLast = false;
    } m_subfolderOptions;
};
 
KUrlNavigatorPrivate::KUrlNavigatorPrivate(const QUrl &url, KUrlNavigator *qq, KFilePlacesModel *placesModel)
    : q(qq)
    , m_coreUrlNavigator(new KCoreUrlNavigator(url, qq))
    , m_showPlacesSelector(placesModel != nullptr)
{
    m_layout->setSpacing(0);
    m_layout->setContentsMargins(0, 0, 0, 0);
 
    q->connect(m_coreUrlNavigator, &KCoreUrlNavigator::currentLocationUrlChanged, q, [this]() {
        Q_EMIT q->urlChanged(m_coreUrlNavigator->currentLocationUrl());
    });
    q->connect(m_coreUrlNavigator, &KCoreUrlNavigator::currentUrlAboutToChange, q, [this](const QUrl &url) {
        Q_EMIT q->urlAboutToBeChanged(url);
    });
    q->connect(m_coreUrlNavigator, &KCoreUrlNavigator::historySizeChanged, q, [this]() {
        Q_EMIT q->historyChanged();
    });
    q->connect(m_coreUrlNavigator, &KCoreUrlNavigator::historyIndexChanged, q, [this]() {
        Q_EMIT q->historyChanged();
    });
    q->connect(m_coreUrlNavigator, &KCoreUrlNavigator::historyChanged, q, [this]() {
        Q_EMIT q->historyChanged();
    });
    q->connect(m_coreUrlNavigator, &KCoreUrlNavigator::urlSelectionRequested, q, [this](const QUrl &url) {
        Q_EMIT q->urlSelectionRequested(url);
    });
 
    // initialize the places selector
    q->setAutoFillBackground(false);
 
    if (placesModel != nullptr) {
        m_placesSelector = new KUrlNavigatorPlacesSelector(q, placesModel);
        q->connect(m_placesSelector, &KUrlNavigatorPlacesSelector::placeActivated, q, &KUrlNavigator::setLocationUrl);
        q->connect(m_placesSelector, &KUrlNavigatorPlacesSelector::tabRequested, q, &KUrlNavigator::tabRequested);
 
        auto updateContentFunc = [this]() {
            updateContent();
        };
        q->connect(placesModel, &KFilePlacesModel::rowsInserted, q, updateContentFunc);
        q->connect(placesModel, &KFilePlacesModel::rowsRemoved, q, updateContentFunc);
        q->connect(placesModel, &KFilePlacesModel::dataChanged, q, updateContentFunc);
    }
 
    // create scheme combo
    m_schemes = new KUrlNavigatorSchemeCombo(QString(), q);
    q->connect(m_schemes, &KUrlNavigatorSchemeCombo::activated, q, [this](const QString &schene) {
        slotSchemeChanged(schene);
    });
 
    // create drop down button for accessing all paths of the URL
    m_dropDownButton = new KUrlNavigatorDropDownButton(q);
    m_dropDownButton->setForegroundRole(QPalette::WindowText);
    m_dropDownButton->installEventFilter(q);
    q->connect(m_dropDownButton, &KUrlNavigatorDropDownButton::clicked, q, [this]() {
        openPathSelectorMenu();
    });
 
    // initialize the path box of the traditional view
    m_pathBox = new KUrlComboBox(KUrlComboBox::Directories, true, q);
    m_pathBox->setSizeAdjustPolicy(QComboBox::AdjustToContentsOnFirstShow);
    m_pathBox->installEventFilter(q);
    m_pathBox->setAutoFillBackground(false);
    m_pathBox->setBackgroundRole(QPalette::Base);
    m_pathBox->setFrame(false);
 
    KUrlCompletion *kurlCompletion = new KUrlCompletion(KUrlCompletion::DirCompletion);
    m_pathBox->setCompletionObject(kurlCompletion);
    m_pathBox->setAutoDeleteCompletionObject(true);
 
    // TODO KF6: remove this QOverload, only KUrlComboBox::returnPressed(const QString &) will remain
    q->connect(m_pathBox, &KUrlComboBox::returnPressed, q, [this]() {
        slotReturnPressed();
    });
    q->connect(m_pathBox, &KUrlComboBox::urlActivated, q, &KUrlNavigator::setLocationUrl);
    q->connect(m_pathBox, &QComboBox::editTextChanged, q, [this](const QString &text) {
        slotPathBoxChanged(text);
    });
 
    m_badgeWidgetContainer = new QWidget(q);
    auto badgeLayout = new QHBoxLayout(m_badgeWidgetContainer);
    badgeLayout->setContentsMargins(0, 0, 0, 0);
 
    // create toggle button which allows to switch between
    // the breadcrumb and traditional view
    m_toggleEditableMode = new KUrlNavigatorToggleButton(q);
    m_toggleEditableMode->installEventFilter(q);
    m_toggleEditableMode->setMinimumWidth(20);
    q->connect(m_toggleEditableMode, &KUrlNavigatorToggleButton::clicked, q, [this]() {
        slotToggleEditableButtonPressed();
    });
 
    if (m_placesSelector != nullptr) {
        m_layout->addWidget(m_placesSelector);
    }
    m_layout->addWidget(m_schemes);
    m_layout->addWidget(m_dropDownButton);
    m_layout->addWidget(m_pathBox, 1);
    m_layout->addWidget(m_badgeWidgetContainer);
    m_layout->addWidget(m_toggleEditableMode);
 
    q->setContextMenuPolicy(Qt::CustomContextMenu);
    q->connect(q, &QWidget::customContextMenuRequested, q, [this](const QPoint &pos) {
        openContextMenu(pos);
    });
 
    // Make sure pathBox does not portrude outside of the above frameLineEdit background
    const int paddingLeft = q->style()->pixelMetric(QStyle::PM_LayoutLeftMargin);
    const int paddingRight = q->style()->pixelMetric(QStyle::PM_LayoutRightMargin);
    q->setContentsMargins(paddingLeft, 0, paddingRight, 0);
    m_pathBox->setContentsMargins(paddingLeft, 0, paddingRight, 0);
}
 
void KUrlNavigatorPrivate::appendWidget(QWidget *widget, int stretch)
{
    // insert to the left of: m_badgeWidgetContainer, m_toggleEditableMode
    m_layout->insertWidget(m_layout->count() - 2, widget, stretch);
}
 
void KUrlNavigatorPrivate::slotApplyUrl(QUrl url)
{
    // Parts of the following code have been taken from the class KateFileSelector
    // located in kate/app/katefileselector.hpp of Kate.
    // SPDX-FileCopyrightText: 2001 Christoph Cullmann <cullmann@kde.org>
    // SPDX-FileCopyrightText: 2001 Joseph Wenninger <jowenn@kde.org>
    // SPDX-FileCopyrightText: 2001 Anders Lund <anders.lund@lund.tdcadsl.dk>
 
    // For example "desktop:/" _not_ "desktop:", see the comment in slotSchemeChanged()
    if (!url.isEmpty() && url.path().isEmpty() && KProtocolInfo::protocolClass(url.scheme()) == QLatin1String(":local")) {
        url.setPath(QStringLiteral("/"));
    }
 
    const auto urlStr = url.toString();
    QStringList urls = m_pathBox->urls();
    urls.removeAll(urlStr);
    urls.prepend(urlStr);
    m_pathBox->setUrls(urls, KUrlComboBox::RemoveBottom);
 
    q->setLocationUrl(url);
    // The URL might have been adjusted by KUrlNavigator::setUrl(), hence
    // synchronize the result in the path box.
    m_pathBox->setUrl(q->locationUrl());
}
 
std::optional<QUrl> KUrlNavigatorPrivate::checkFilters(const QString &text)
{
    KUriFilterData filteredData(text);
    filteredData.setCheckForExecutables(false);
    // Using kshorturifilter to fix up e.g. "ftp.kde.org" ---> "ftp://ftp.kde.org"
    const auto filtersList = QStringList{QStringLiteral("kshorturifilter")};
    const bool wasFiltered = KUriFilter::self()->filterUri(filteredData, filtersList);
    if (wasFiltered) {
        return filteredData.uri(); // The text was filtered
    }
    return std::nullopt;
}
 
void KUrlNavigatorPrivate::applyUncommittedUrl(ApplyUrlMethod method)
{
    const QString text = m_pathBox->currentText().trimmed();
    QUrl url = q->locationUrl();
 
    auto applyUrl = [this, method](const QUrl &url) {
        switch (method) {
        case ApplyUrlMethod::Apply:
            slotApplyUrl(url);
            break;
        case ApplyUrlMethod::Tab:
            Q_EMIT q->tabRequested(url);
            break;
        case ApplyUrlMethod::ActiveTab:
            Q_EMIT q->activeTabRequested(url);
            break;
        case ApplyUrlMethod::NewWindow:
            Q_EMIT q->newWindowRequested(url);
            break;
        }
    };
 
    // Using the stat job below, check if the url and text match a local dir; but first
    // handle a special case where "url" is empty in the unittests which use
    // KUrlNavigator::setLocationUrl(QUrl()); in practice (e.g. in Dolphin, or KFileWidget),
    // locationUrl() is never empty
    if (url.isEmpty() && !text.isEmpty()) {
        if (const auto filteredUrl = checkFilters(text); filteredUrl) {
            applyUrl(*filteredUrl);
            return;
        }
    }
 
    // Treat absolute paths as absolute paths.
    // Relative paths get appended to the current path.
    if (text.startsWith(QLatin1Char('/'))) {
        url.setPath(text);
    } else {
        url.setPath(Utils::concatPaths(url.path(), text));
    }
 
    // Dirs and symlinks to dirs
    constexpr auto details = KIO::StatBasic | KIO::StatResolveSymlink;
    auto *job = KIO::stat(url, KIO::StatJob::DestinationSide, details, KIO::HideProgressInfo);
    q->connect(job, &KJob::result, q, [this, job, text, applyUrl]() {
        // If there is a dir matching "text" relative to the current url, use that, e.g.:
        // - typing "bar" while at "/path/to/foo" ---> "/path/to/foo/bar/"
        // - typing ".config" while at "/home/foo" ---> "/home/foo/.config"
        if (!job->error() && job->statResult().isDir()) {
            applyUrl(job->url());
            return;
        }
 
        // Check if text matches a URI filter
        if (const auto filteredUrl = checkFilters(text); filteredUrl) {
            applyUrl(*filteredUrl);
            return;
        }
 
        // ... otherwise fallback to whatever QUrl::fromUserInput() returns
        applyUrl(QUrl::fromUserInput(text));
    });
}
 
void KUrlNavigatorPrivate::slotReturnPressed()
{
    const auto keyboardModifiers = QApplication::keyboardModifiers();
 
    if (keyboardModifiers & Qt::AltModifier) {
        if (keyboardModifiers & Qt::ShiftModifier) {
            applyUncommittedUrl(ApplyUrlMethod::Tab);
        } else {
            applyUncommittedUrl(ApplyUrlMethod::ActiveTab);
        }
    } else if (keyboardModifiers & Qt::ShiftModifier) {
        applyUncommittedUrl(ApplyUrlMethod::NewWindow);
    } else {
        applyUncommittedUrl(ApplyUrlMethod::Apply);
 
        Q_EMIT q->returnPressed();
    }
 
    if (keyboardModifiers & Qt::ControlModifier) {
        // Pressing Ctrl+Return automatically switches back to the breadcrumb mode.
        // The switch must be done asynchronously, as we are in the context of the
        // editor.
        auto switchModeFunc = [this]() {
            switchToBreadcrumbMode();
        };
        QMetaObject::invokeMethod(q, switchModeFunc, Qt::QueuedConnection);
    }
}
 
void KUrlNavigatorPrivate::slotSchemeChanged(const QString &scheme)
{
    Q_ASSERT(m_editable);
 
    QUrl url;
    url.setScheme(scheme);
    if (KProtocolInfo::protocolClass(scheme) == QLatin1String(":local")) {
        // E.g. "file:/" or "desktop:/", _not_ "file:" or "desktop:" respectively.
        // This is the more expected behaviour, "file:somedir" treats somedir as
        // a path relative to current dir; file:/somedir is an absolute path to /somedir.
        url.setPath(QStringLiteral("/"));
    } else {
        // With no authority set we'll get e.g. "ftp:" instead of "ftp://".
        // We want the latter, so let's set an empty authority.
        url.setAuthority(QString());
    }
 
    m_pathBox->setEditUrl(url);
}
 
void KUrlNavigatorPrivate::openPathSelectorMenu()
{
    if (m_navButtons.count() <= 0) {
        return;
    }
 
    const QUrl firstVisibleUrl = m_navButtons.constFirst()->url();
 
    QString spacer;
    QPointer<QMenu> popup = new QMenu(q);
 
    auto *popupFilter = new KUrlNavigatorPathSelectorEventFilter(popup.data());
    q->connect(popupFilter, &KUrlNavigatorPathSelectorEventFilter::tabRequested, q, &KUrlNavigator::tabRequested);
    popup->installEventFilter(popupFilter);
 
    const QUrl placeUrl = retrievePlaceUrl();
    int idx = placeUrl.path().count(QLatin1Char('/')); // idx points to the first directory
    // after the place path
 
    const QString path = m_coreUrlNavigator->locationUrl(m_coreUrlNavigator->historyIndex()).path();
    QString dirName = path.section(QLatin1Char('/'), idx, idx);
    if (dirName.isEmpty()) {
        if (placeUrl.isLocalFile()) {
            dirName = QStringLiteral("/");
        } else {
            dirName = placeUrl.toDisplayString();
        }
    }
    do {
        const QString text = spacer + dirName;
 
        QAction *action = new QAction(text, popup);
        const QUrl currentUrl = buttonUrl(idx);
        if (currentUrl == firstVisibleUrl) {
            popup->addSeparator();
        }
        action->setData(QVariant(currentUrl.toString()));
        popup->addAction(action);
 
        ++idx;
        spacer.append(QLatin1String("  "));
        dirName = path.section(QLatin1Char('/'), idx, idx);
    } while (!dirName.isEmpty());
 
    const QPoint pos = q->mapToGlobal(m_dropDownButton->geometry().bottomRight());
    const QAction *activatedAction = popup->exec(pos);
    if (activatedAction != nullptr) {
        const QUrl url(activatedAction->data().toString());
        q->setLocationUrl(url);
    }
 
    // Delete the menu, unless it has been deleted in its own nested event loop already.
    if (popup) {
        popup->deleteLater();
    }
}
 
void KUrlNavigatorPrivate::slotToggleEditableButtonPressed()
{
    if (m_editable) {
        applyUncommittedUrl(ApplyUrlMethod::Apply);
    }
 
    switchView();
}
 
void KUrlNavigatorPrivate::switchView()
{
    m_toggleEditableMode->setFocus();
    m_editable = !m_editable;
    m_toggleEditableMode->setChecked(m_editable);
    updateContent();
    if (q->isUrlEditable()) {
        m_pathBox->setFocus();
    }
 
    q->requestActivation();
    Q_EMIT q->editableStateChanged(m_editable);
}
 
void KUrlNavigatorPrivate::dropUrls(const QUrl &destination, QDropEvent *event, KUrlNavigatorButton *dropButton)
{
    if (event->mimeData()->hasUrls()) {
        m_dropWidget = qobject_cast<QWidget *>(dropButton);
        Q_EMIT q->urlsDropped(destination, event);
    }
}
 
void KUrlNavigatorPrivate::slotNavigatorButtonClicked(const QUrl &url, Qt::MouseButton button, Qt::KeyboardModifiers modifiers)
{
    if ((button & Qt::MiddleButton && modifiers & Qt::ShiftModifier) || (button & Qt::LeftButton && modifiers & (Qt::ControlModifier | Qt::ShiftModifier))) {
        Q_EMIT q->activeTabRequested(url);
    } else if (button & Qt::MiddleButton || (button & Qt::LeftButton && modifiers & Qt::ControlModifier)) {
        Q_EMIT q->tabRequested(url);
    } else if (button & Qt::LeftButton && modifiers & Qt::ShiftModifier) {
        Q_EMIT q->newWindowRequested(url);
    } else if (button & Qt::LeftButton) {
        q->setLocationUrl(url);
    }
}
 
void KUrlNavigatorPrivate::openContextMenu(const QPoint &p)
{
    q->setActive(true);
 
    QPointer<QMenu> popup = new QMenu(q);
 
    // provide 'Copy' action, which copies the current URL of
    // the URL navigator into the clipboard
    QAction *copyAction = popup->addAction(QIcon::fromTheme(QStringLiteral("edit-copy")), i18n("Copy"));
 
    // provide 'Paste' action, which copies the current clipboard text
    // into the URL navigator
    QAction *pasteAction = popup->addAction(QIcon::fromTheme(QStringLiteral("edit-paste")), i18n("Paste"));
    QClipboard *clipboard = QApplication::clipboard();
    pasteAction->setEnabled(!clipboard->text().isEmpty());
 
    popup->addSeparator();
 
    // We are checking whether the signal is connected because it's odd to have a tab entry even
    // if it's not supported, like in the case of the open dialog
    const bool isTabSignal = q->isSignalConnected(QMetaMethod::fromSignal(&KUrlNavigator::tabRequested));
    const bool isWindowSignal = q->isSignalConnected(QMetaMethod::fromSignal(&KUrlNavigator::newWindowRequested));
    if (isTabSignal || isWindowSignal) {
        auto it = std::find_if(m_navButtons.cbegin(), m_navButtons.cend(), [&p](const KUrlNavigatorButton *button) {
            return button->geometry().contains(p);
        });
        if (it != m_navButtons.cend()) {
            const auto *button = *it;
            const QUrl url = button->url();
            const QString text = button->text();
 
            if (isTabSignal) {
                QAction *openInTab = popup->addAction(QIcon::fromTheme(QStringLiteral("tab-new")), i18nc("@item:inmenu", "Open \"%1\" in New Tab", text));
                q->connect(openInTab, &QAction::triggered, q, [this, url]() {
                    Q_EMIT q->tabRequested(url);
                });
            }
 
            if (isWindowSignal) {
                QAction *openInWindow =
                    popup->addAction(QIcon::fromTheme(QStringLiteral("window-new")), i18nc("@item:inmenu", "Open \"%1\" in New Window", text));
                q->connect(openInWindow, &QAction::triggered, q, [this, url]() {
                    Q_EMIT q->newWindowRequested(url);
                });
            }
        }
    }
 
    // provide radiobuttons for toggling between the edit and the navigation mode
    QAction *editAction = popup->addAction(i18n("Edit"));
    editAction->setCheckable(true);
 
    QAction *navigateAction = popup->addAction(i18n("Navigate"));
    navigateAction->setCheckable(true);
 
    QActionGroup *modeGroup = new QActionGroup(popup);
    modeGroup->addAction(editAction);
    modeGroup->addAction(navigateAction);
    if (q->isUrlEditable()) {
        editAction->setChecked(true);
    } else {
        navigateAction->setChecked(true);
    }
 
    popup->addSeparator();
 
    // allow showing of the full path
    QAction *showFullPathAction = popup->addAction(i18n("Show Full Path"));
    showFullPathAction->setCheckable(true);
    showFullPathAction->setChecked(q->showFullPath());
 
    QAction *activatedAction = popup->exec(QCursor::pos());
    if (activatedAction == copyAction) {
        QMimeData *mimeData = new QMimeData();
        mimeData->setText(q->locationUrl().toDisplayString(QUrl::PreferLocalFile));
        clipboard->setMimeData(mimeData);
    } else if (activatedAction == pasteAction) {
        q->setLocationUrl(QUrl::fromUserInput(clipboard->text()));
    } else if (activatedAction == editAction) {
        q->setUrlEditable(true);
    } else if (activatedAction == navigateAction) {
        q->setUrlEditable(false);
    } else if (activatedAction == showFullPathAction) {
        q->setShowFullPath(showFullPathAction->isChecked());
    }
 
    // Delete the menu, unless it has been deleted in its own nested event loop already.
    if (popup) {
        popup->deleteLater();
    }
}
 
void KUrlNavigatorPrivate::slotPathBoxChanged(const QString &text)
{
    if (text.isEmpty()) {
        const QString scheme = q->locationUrl().scheme();
        m_schemes->setScheme(scheme);
        if (m_supportedSchemes.count() != 1) {
            m_schemes->show();
            updateTabOrder();
        }
    } else {
        m_schemes->hide();
        updateTabOrder();
    }
}
 
void KUrlNavigatorPrivate::updateContent()
{
    const QUrl currentUrl = q->locationUrl();
    if (m_placesSelector != nullptr) {
        m_placesSelector->updateSelection(currentUrl);
    }
 
    if (m_editable) {
        m_schemes->hide();
        m_dropDownButton->hide();
        m_badgeWidgetContainer->hide();
 
        deleteButtons();
        m_toggleEditableMode->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Preferred);
        q->setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Fixed);
 
        m_pathBox->show();
        m_pathBox->setUrl(currentUrl);
 
        q->setTabOrder(m_pathBox, m_toggleEditableMode); // Fixes order for the first time switchView() is called.
        updateTabOrder();
    } else {
        m_pathBox->hide();
        m_badgeWidgetContainer->show();
 
        m_schemes->hide();
 
        m_toggleEditableMode->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Preferred);
        q->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Fixed);
 
        // Calculate the start index for the directories that should be shown as buttons
        // and create the buttons
        QUrl placeUrl;
        if ((m_placesSelector != nullptr) && !m_showFullPath) {
            placeUrl = m_placesSelector->selectedPlaceUrl();
        }
 
        if (!placeUrl.isValid()) {
            placeUrl = retrievePlaceUrl();
        }
        QString placePath = Utils::trailingSlashRemoved(placeUrl.path());
 
        const int startIndex = placePath.count(QLatin1Char('/'));
        updateButtons(startIndex);
    }
}
 
void KUrlNavigatorPrivate::updateButtons(int startIndex)
{
    QUrl currentUrl = q->locationUrl();
    if (!currentUrl.isValid()) { // QFileDialog::setDirectory not called yet
        return;
    }
 
    const QString path = currentUrl.path();
 
    const int oldButtonCount = m_navButtons.count();
 
    int idx = startIndex;
    bool hasNext = true;
    do {
        const bool createButton = (idx - startIndex) >= oldButtonCount;
        const bool isFirstButton = (idx == startIndex);
        const QString dirName = path.section(QLatin1Char('/'), idx, idx);
        hasNext = isFirstButton || !dirName.isEmpty();
        if (hasNext) {
            KUrlNavigatorButton *button = nullptr;
            if (createButton) {
                button = new KUrlNavigatorButton(buttonUrl(idx), q);
                button->installEventFilter(q);
                button->setForegroundRole(QPalette::WindowText);
                q->connect(button, &KUrlNavigatorButton::urlsDroppedOnNavButton, q, [this, button](const QUrl &destination, QDropEvent *event) {
                    dropUrls(destination, event, button);
                });
 
                auto activatedFunc = [this](const QUrl &url, Qt::MouseButton btn, Qt::KeyboardModifiers modifiers) {
                    slotNavigatorButtonClicked(url, btn, modifiers);
                };
                q->connect(button, &KUrlNavigatorButton::navigatorButtonActivated, q, activatedFunc);
 
                q->connect(button, &KUrlNavigatorButton::finishedTextResolving, q, [this]() {
                    updateButtonVisibility();
                });
 
                appendWidget(button);
            } else {
                button = m_navButtons[idx - startIndex];
                button->setUrl(buttonUrl(idx));
            }
 
            if (isFirstButton) {
                button->setText(firstButtonText());
            }
            button->setActive(q->isActive());
 
            if (createButton) {
                if (!isFirstButton) {
                    q->setTabOrder(m_navButtons.constLast(), button);
                }
                m_navButtons.append(button);
            }
 
            ++idx;
            button->setActiveSubDirectory(path.section(QLatin1Char('/'), idx, idx));
        }
    } while (hasNext);
 
    // delete buttons which are not used anymore
    const int newButtonCount = idx - startIndex;
    if (newButtonCount < oldButtonCount) {
        const auto itBegin = m_navButtons.begin() + newButtonCount;
        const auto itEnd = m_navButtons.end();
        for (auto it = itBegin; it != itEnd; ++it) {
            auto *navBtn = *it;
            navBtn->hide();
            navBtn->deleteLater();
        }
        m_navButtons.erase(itBegin, itEnd);
    }
 
    m_dropDownButton->setToolTip(xi18nc("@info:tooltip for button. 1 is path",
                                        "Go to any location on the path <filename>%1</filename>",
                                        currentUrl.toDisplayString(QUrl::RemoveScheme | QUrl::NormalizePathSegments | QUrl::RemoveAuthority))
                                     .replace(QStringLiteral("///"), QStringLiteral("/")));
    updateButtonVisibility();
}
 
void KUrlNavigatorPrivate::updateButtonVisibility()
{
    if (m_editable) {
        return;
    }
 
    const int buttonsCount = m_navButtons.count();
    if (buttonsCount == 0) {
        m_dropDownButton->hide();
        return;
    }
 
    // Subtract all widgets from the available width, that must be shown anyway
    // Make sure to take the padding into account
    int availableWidth = q->width() - (m_padding * 2) - m_toggleEditableMode->minimumWidth();
 
    availableWidth -= m_badgeWidgetContainer->width();
 
    if ((m_placesSelector != nullptr) && m_placesSelector->isVisible()) {
        availableWidth -= m_placesSelector->width();
    }
 
    if ((m_schemes != nullptr) && m_schemes->isVisible()) {
        availableWidth -= m_schemes->width();
    }
 
    // Check whether buttons must be hidden at all...
    int requiredButtonWidth = 0;
    for (const auto *button : std::as_const(m_navButtons)) {
        requiredButtonWidth += button->minimumWidth();
    }
 
    if (requiredButtonWidth > availableWidth) {
        // At least one button must be hidden. This implies that the
        // drop-down button must get visible, which again decreases the
        // available width.
        availableWidth -= m_dropDownButton->width();
    }
 
    // Hide buttons...
    bool isLastButton = true;
    bool hasHiddenButtons = false;
    QList<KUrlNavigatorButton *> buttonsToShow;
    for (auto it = m_navButtons.crbegin(); it != m_navButtons.crend(); ++it) {
        KUrlNavigatorButton *button = *it;
        availableWidth -= button->minimumWidth();
        if ((availableWidth <= 0) && !isLastButton) {
            button->hide();
            hasHiddenButtons = true;
        } else {
            // Don't show the button immediately, as setActive()
            // might change the size and a relayout gets triggered
            // after showing the button. So the showing of all buttons
            // is postponed until all buttons have the correct
            // activation state.
            buttonsToShow.append(button);
        }
        isLastButton = false;
    }
 
    // All buttons have the correct activation state and
    // can be shown now
    for (KUrlNavigatorButton *button : std::as_const(buttonsToShow)) {
        button->show();
    }
 
    if (hasHiddenButtons) {
        m_dropDownButton->show();
    } else {
        // Check whether going upwards is possible. If this is the case, show the drop-down button.
        QUrl url(m_navButtons.front()->url());
        const bool visible = !url.matches(KIO::upUrl(url), QUrl::StripTrailingSlash) //
            && url.scheme() != QLatin1String("baloosearch") //
            && url.scheme() != QLatin1String("filenamesearch");
        m_dropDownButton->setVisible(visible);
    }
 
    auto lastButton = m_navButtons.last();
    for (const auto &button : m_navButtons) {
        if (button != lastButton) {
            button->setDrawSeparator(true);
        } else {
            button->setDrawSeparator(false);
        }
    }
 
    updateTabOrder();
}
 
void KUrlNavigatorPrivate::updateTabOrder()
{
    QMultiMap<int, QWidget *> visibleChildrenSortedByX;
    const auto childWidgets = q->findChildren<QWidget *>();
    for (auto childWidget : childWidgets) {
        if (childWidget->isVisible()) {
            if (q->layoutDirection() == Qt::LeftToRight) {
                visibleChildrenSortedByX.insert(childWidget->x(), childWidget); // sort ascending
            } else {
                visibleChildrenSortedByX.insert(-childWidget->x(), childWidget); // sort descending
            }
        }
    }
 
    if (visibleChildrenSortedByX.isEmpty()) {
        return;
    }
    q->setFocusProxy(visibleChildrenSortedByX.first());
    auto it = visibleChildrenSortedByX.begin();
    auto nextIt = ++visibleChildrenSortedByX.begin();
    while (nextIt != visibleChildrenSortedByX.end()) {
        q->setTabOrder(*it, *nextIt);
        it++;
        nextIt++;
    }
    Q_EMIT q->layoutChanged();
}
 
QString KUrlNavigatorPrivate::firstButtonText() const
{
    QString text;
 
    // The first URL navigator button should get the name of the
    // place instead of the directory name
    if ((m_placesSelector != nullptr) && !m_showFullPath) {
        text = m_placesSelector->selectedPlaceText();
    }
 
    const QUrl currentUrl = q->locationUrl();
 
    if (text.isEmpty()) {
        if (currentUrl.isLocalFile()) {
#ifdef Q_OS_WIN
            text = currentUrl.path().length() > 1 ? currentUrl.path().left(2) : QDir::rootPath();
#else
            text = QStringLiteral("/");
#endif
        }
    }
 
    if (text.isEmpty()) {
        if (currentUrl.path().isEmpty() || currentUrl.path() == QLatin1Char('/')) {
            QUrlQuery query(currentUrl);
            text = query.queryItemValue(QStringLiteral("title"), QUrl::FullyDecoded);
        }
    }
 
    if (text.isEmpty()) {
        text = currentUrl.scheme() + QLatin1Char(':');
        if (!currentUrl.host().isEmpty()) {
            text += QLatin1Char(' ') + currentUrl.host();
        }
    }
 
    return text;
}
 
QUrl KUrlNavigatorPrivate::buttonUrl(int index) const
{
    if (index < 0) {
        index = 0;
    }
 
    // Keep scheme, hostname etc. as this is needed for e. g. browsing
    // FTP directories
    QUrl url = q->locationUrl();
    QString path = url.path();
 
    if (!path.isEmpty()) {
        if (index == 0) {
            // prevent the last "/" from being stripped
            // or we end up with an empty path
#ifdef Q_OS_WIN
            path = path.length() > 1 ? path.left(2) : QDir::rootPath();
#else
            path = QStringLiteral("/");
#endif
        } else {
            path = path.section(QLatin1Char('/'), 0, index);
        }
    }
 
    url.setPath(path);
    return url;
}
 
void KUrlNavigatorPrivate::switchToBreadcrumbMode()
{
    q->setUrlEditable(false);
}
 
void KUrlNavigatorPrivate::deleteButtons()
{
    for (KUrlNavigatorButton *button : std::as_const(m_navButtons)) {
        button->hide();
        button->deleteLater();
    }
    m_navButtons.clear();
}
 
QUrl KUrlNavigatorPrivate::retrievePlaceUrl() const
{
    QUrl currentUrl = q->locationUrl();
    currentUrl.setPath(QString());
    return currentUrl;
}
 
// ------------------------------------------------------------------------------------------------
 
KUrlNavigator::KUrlNavigator(QWidget *parent)
    : KUrlNavigator(nullptr, QUrl{}, parent)
{
}
 
KUrlNavigator::KUrlNavigator(KFilePlacesModel *placesModel, const QUrl &url, QWidget *parent)
    : QWidget(parent)
    , d(new KUrlNavigatorPrivate(url, this, placesModel))
{
    const int minHeight = d->m_pathBox->sizeHint().height();
    setMinimumHeight(minHeight);
 
    setMinimumWidth(100);
 
    installEventFilter(this);
    d->updateContent();
    d->updateTabOrder();
}
 
KUrlNavigator::~KUrlNavigator()
{
    d->m_dropDownButton->removeEventFilter(this);
    d->m_pathBox->removeEventFilter(this);
    for (auto *button : std::as_const(d->m_navButtons)) {
        button->removeEventFilter(this);
    }
    removeEventFilter(this);
}
 
QUrl KUrlNavigator::locationUrl(int historyIndex) const
{
    return d->m_coreUrlNavigator->locationUrl(historyIndex);
}
 
void KUrlNavigator::saveLocationState(const QByteArray &state)
{
    auto current = d->m_coreUrlNavigator->locationState().value<KUrlNavigatorData>();
    current.state = state;
    d->m_coreUrlNavigator->saveLocationState(QVariant::fromValue(current));
}
 
QByteArray KUrlNavigator::locationState(int historyIndex) const
{
    return d->m_coreUrlNavigator->locationState(historyIndex).value<KUrlNavigatorData>().state;
}
 
bool KUrlNavigator::goBack()
{
    return d->m_coreUrlNavigator->goBack();
}
 
bool KUrlNavigator::goForward()
{
    return d->m_coreUrlNavigator->goForward();
}
 
bool KUrlNavigator::goUp()
{
    return d->m_coreUrlNavigator->goUp();
}
 
void KUrlNavigator::goHome()
{
    if (d->m_homeUrl.isEmpty() || !d->m_homeUrl.isValid()) {
        setLocationUrl(QUrl::fromLocalFile(QDir::homePath()));
    } else {
        setLocationUrl(d->m_homeUrl);
    }
}
 
void KUrlNavigator::setHomeUrl(const QUrl &url)
{
    d->m_homeUrl = url;
}
 
QUrl KUrlNavigator::homeUrl() const
{
    return d->m_homeUrl;
}
 
void KUrlNavigator::setUrlEditable(bool editable)
{
    if (d->m_editable != editable) {
        d->switchView();
    }
}
 
bool KUrlNavigator::isUrlEditable() const
{
    return d->m_editable;
}
 
void KUrlNavigator::setShowFullPath(bool show)
{
    if (d->m_showFullPath != show) {
        d->m_showFullPath = show;
        d->updateContent();
    }
}
 
bool KUrlNavigator::showFullPath() const
{
    return d->m_showFullPath;
}
 
void KUrlNavigator::setActive(bool active)
{
    if (active != d->m_active) {
        d->m_active = active;
 
        d->m_dropDownButton->setActive(active);
        for (KUrlNavigatorButton *button : std::as_const(d->m_navButtons)) {
            button->setActive(active);
        }
 
        update();
        if (active) {
            Q_EMIT activated();
        }
    }
}
 
bool KUrlNavigator::isActive() const
{
    return d->m_active;
}
 
void KUrlNavigator::setPlacesSelectorVisible(bool visible)
{
    if (visible == d->m_showPlacesSelector) {
        return;
    }
 
    if (visible && (d->m_placesSelector == nullptr)) {
        // the places selector cannot get visible as no
        // places model is available
        return;
    }
 
    d->m_showPlacesSelector = visible;
 
    if (d->m_placesSelector) {
        d->m_placesSelector->setVisible(visible);
        d->updateTabOrder();
    }
}
 
bool KUrlNavigator::isPlacesSelectorVisible() const
{
    return d->m_showPlacesSelector;
}
 
QUrl KUrlNavigator::uncommittedUrl() const
{
    KUriFilterData filteredData(d->m_pathBox->currentText().trimmed());
    filteredData.setCheckForExecutables(false);
    if (KUriFilter::self()->filterUri(filteredData, QStringList{QStringLiteral("kshorturifilter")})) {
        return filteredData.uri();
    } else {
        return QUrl::fromUserInput(filteredData.typedString());
    }
}
 
void KUrlNavigator::setLocationUrl(const QUrl &newUrl)
{
    d->m_coreUrlNavigator->setCurrentLocationUrl(newUrl);
 
    d->updateContent();
 
    requestActivation();
}
 
void KUrlNavigator::requestActivation()
{
    setActive(true);
}
 
void KUrlNavigator::setFocus()
{
    if (isUrlEditable()) {
        d->m_pathBox->setFocus();
    } else {
        QWidget::setFocus();
    }
}
 
void KUrlNavigator::keyPressEvent(QKeyEvent *event)
{
    if (isUrlEditable() && (event->key() == Qt::Key_Escape)) {
        setUrlEditable(false);
    } else {
        QWidget::keyPressEvent(event);
    }
}
 
void KUrlNavigator::keyReleaseEvent(QKeyEvent *event)
{
    QWidget::keyReleaseEvent(event);
}
 
void KUrlNavigator::mousePressEvent(QMouseEvent *event)
{
    if (event->button() == Qt::MiddleButton) {
        requestActivation();
    }
    QWidget::mousePressEvent(event);
}
 
void KUrlNavigator::mouseReleaseEvent(QMouseEvent *event)
{
    if (event->button() == Qt::MiddleButton) {
        const QRect bounds = d->m_toggleEditableMode->geometry();
        if (bounds.contains(event->pos())) {
            // The middle mouse button has been clicked above the
            // toggle-editable-mode-button. Paste the clipboard content
            // as location URL.
            QClipboard *clipboard = QApplication::clipboard();
            const QMimeData *mimeData = clipboard->mimeData(QClipboard::Mode::Selection);
            if (mimeData && mimeData->hasText()) {
                const QString text = mimeData->text();
                const auto currentUrl = d->m_coreUrlNavigator->currentLocationUrl();
                QString workindDirectory;
                if (currentUrl.isLocalFile()) {
                    workindDirectory = currentUrl.toLocalFile();
                }
                auto url = QUrl::fromUserInput(text, workindDirectory);
                if (url.isValid()) {
                    setLocationUrl(url);
                }
            }
        }
    }
    QWidget::mouseReleaseEvent(event);
}
 
void KUrlNavigator::resizeEvent(QResizeEvent *event)
{
    QTimer::singleShot(0, this, [this]() {
        d->updateButtonVisibility();
    });
    QWidget::resizeEvent(event);
}
 
void KUrlNavigator::wheelEvent(QWheelEvent *event)
{
    setActive(true);
    QWidget::wheelEvent(event);
}
 
void KUrlNavigator::showEvent(QShowEvent *event)
{
    d->updateTabOrder();
    QWidget::showEvent(event);
}
 
bool KUrlNavigator::eventFilter(QObject *watched, QEvent *event)
{
    switch (event->type()) {
    case QEvent::FocusIn:
        if (watched == d->m_pathBox) {
            requestActivation();
            setFocus();
        }
        for (KUrlNavigatorButton *button : std::as_const(d->m_navButtons)) {
            button->setShowMnemonic(true);
        }
        update();
        break;
 
    case QEvent::FocusOut:
        for (KUrlNavigatorButton *button : std::as_const(d->m_navButtons)) {
            button->setShowMnemonic(false);
        }
        update();
        break;
 
    // Avoid the "Properties" action from triggering instead of new tab.
    case QEvent::ShortcutOverride: {
        auto *keyEvent = static_cast<QKeyEvent *>(event);
        if ((keyEvent->key() == Qt::Key_Enter || keyEvent->key() == Qt::Key_Return)
            && (keyEvent->modifiers() & Qt::AltModifier || keyEvent->modifiers() & Qt::ShiftModifier)) {
            event->accept();
            return true;
        }
        break;
    }
 
#if KIO_VERSION < QT_VERSION_CHECK(7, 0, 0)
    case QEvent::Paint: {
        // We can't call this in overridden paintEvent since applications using
        // the paint event is handled through the event filter:
        // Overriding paintEvent might not have an effect in applications
        // compiled against the older KIO, as they might work with an older vtable.
        // However, they would still see the new button style.
        // This makes sure the background is always drawn.
        if (watched == this) {
            auto *pEvent = static_cast<QPaintEvent *>(event);
            if (pEvent) {
                KUrlNavigator::paintEvent(pEvent);
                return true;
            }
        }
        break;
    }
#endif
 
    default:
        break;
    }
 
    return QWidget::eventFilter(watched, event);
}
 
int KUrlNavigator::historySize() const
{
    return d->m_coreUrlNavigator->historySize();
}
 
int KUrlNavigator::historyIndex() const
{
    return d->m_coreUrlNavigator->historyIndex();
}
 
KUrlComboBox *KUrlNavigator::editor() const
{
    return d->m_pathBox;
}
 
void KUrlNavigator::setSupportedSchemes(const QStringList &schemes)
{
    d->m_supportedSchemes = schemes;
    d->m_schemes->setSupportedSchemes(d->m_supportedSchemes);
}
 
QStringList KUrlNavigator::supportedSchemes() const
{
    return d->m_supportedSchemes;
}
 
QWidget *KUrlNavigator::dropWidget() const
{
    return d->m_dropWidget;
}
 
void KUrlNavigator::setShowHiddenFolders(bool showHiddenFolders)
{
    d->m_subfolderOptions.showHidden = showHiddenFolders;
}
 
bool KUrlNavigator::showHiddenFolders() const
{
    return d->m_subfolderOptions.showHidden;
}
 
void KUrlNavigator::setSortHiddenFoldersLast(bool sortHiddenFoldersLast)
{
    d->m_subfolderOptions.sortHiddenLast = sortHiddenFoldersLast;
}
 
bool KUrlNavigator::sortHiddenFoldersLast() const
{
    return d->m_subfolderOptions.sortHiddenLast;
}
 
void KUrlNavigator::setBadgeWidget(QWidget *widget)
{
    QWidget *oldWidget = badgeWidget();
    if (oldWidget) {
        if (widget == oldWidget) {
            return;
        }
        d->m_badgeWidgetContainer->layout()->replaceWidget(oldWidget, widget);
        oldWidget->deleteLater();
    } else {
        d->m_badgeWidgetContainer->layout()->addWidget(widget);
    }
}
 
QWidget *KUrlNavigator::badgeWidget() const
{
    QLayoutItem *item = d->m_badgeWidgetContainer->layout()->itemAt(0);
    if (item) {
        return item->widget();
    } else {
        return nullptr;
    }
}
 
void KUrlNavigator::paintEvent(QPaintEvent *event)
{
    Q_UNUSED(event);
    QPainter painter(this);
    QStyleOptionFrame option;
    option.initFrom(this);
    option.state = QStyle::State_Sunken;
 
    if (hasFocus()) {
        option.palette.setColor(QPalette::Window, palette().color(QPalette::Highlight));
    }
 
    // Adjust the rectangle due to how QRect coordinates work
    option.rect = option.rect.adjusted(1, 0, -1, 0);
    // Draw the background
    style()->drawPrimitive(QStyle::PE_FrameLineEdit, &option, &painter, this);
}
 
#include "moc_kurlnavigator.cpp"