Adding Vi mode for keyboard shortcuts

.github/workflows/build.yml

@@ -0,0 +1,39 @@
+name: Build
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  debian:
+    name: Debian
+    runs-on: ubuntu-latest
+    container: docker.io/library/debian:sid
+    steps:
+    - name: Checkout Source
+      uses: actions/checkout@v2
+    - name: Update repository
+      run: apt-get update -y
+    - name: Install the basic dev packages
+      run: apt-get install -y equivs curl git devscripts lintian build-essential automake autotools-dev cmake g++
+    - name: Install build dependencies
+      run: mk-build-deps -i -t "apt-get --yes" -r
+    - name: Build Package
+      run: dpkg-buildpackage -b -uc -us -j$(nproc)
+
+  ubuntu:
+    name: Ubuntu
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Source
+      uses: actions/checkout@v2
+    - name: Update repository
+      run: sudo apt-get update -y
+    - name: Install the basic dev packages
+      run: sudo apt-get install -y equivs curl git devscripts lintian build-essential automake autotools-dev cmake g++
+    - name: Install build dependencies
+      run: sudo mk-build-deps -i -t "apt-get --yes" -r
+    - name: Build Package
+      run: dpkg-buildpackage -b -uc -us -j$(nproc)

.gitignore

@@ -52,4 +52,5 @@ compile_commands.json
 *creator.user*
 
 /build/*
-.vscode
+.vscode
+tags

CMakeLists.txt

@@ -12,38 +12,66 @@ set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 find_package(Qt5 COMPONENTS Core DBus Quick LinguistTools REQUIRED)
-find_package(FishUI REQUIRED)
+# find_package(FishUI REQUIRED)
 
 find_package(KF5KIO)
 find_package(KF5Solid)
+find_package(KF5WindowSystem)
+find_package(KF5Config)
+
+qt5_add_dbus_adaptor(DBUS_SOURCES
+                    com.cutefish.FileManager.xml
+                    application.h Application)
 
 add_executable(cutefish-filemanager
   main.cpp
+  application.cpp
+  window.cpp
+  dbusinterface.cpp
+
+  draganddrop/declarativedroparea.cpp
+  draganddrop/declarativedragdropevent.cpp
+  draganddrop/declarativemimedata.cpp
+
   model/foldermodel.cpp
   model/placesmodel.cpp
   model/placesitem.cpp
   model/pathbarmodel.cpp
   model/dirlister.cpp
   model/positioner.cpp
 
-  dialogs/propertiesdialog.cpp
+  cio/cfilejob.cpp
+  cio/cfilesizejob.cpp
+
   dialogs/createfolderdialog.cpp
+  dialogs/filepropertiesdialog.cpp
+  dialogs/openwithdialog.cpp
   widgets/rubberband.cpp
   widgets/itemviewadapter.cpp
 
+  desktop/desktop.cpp
   desktop/desktopview.cpp
   desktop/desktopsettings.cpp
+  desktop/dockdbusinterface.cpp
 
   helper/datehelper.cpp
-  helper/thumbnailer.cpp
   helper/pathhistory.cpp
   helper/fm.cpp
   helper/shortcut.cpp
-  helper/thumbnailerjob.cpp
+  helper/filelauncher.cpp
+  helper/keyboardsearchmanager.cpp
+
+  mimetype/mimeappmanager.cpp
+  mimetype/xdgdesktopfile.cpp
+
+  thumbnailer/thumbnailprovider.cpp
+  thumbnailer/thumbnailcache.cpp
 
   desktopiconprovider.cpp
 
   qml.qrc
+
+  ${DBUS_SOURCES}
 )
 
 target_link_libraries(cutefish-filemanager
@@ -56,15 +84,17 @@ target_link_libraries(cutefish-filemanager
   KF5::KIOFileWidgets
   KF5::KIOWidgets
   KF5::Solid
+  KF5::WindowSystem
+  KF5::ConfigCore
 
-  FishUI
+  # FishUI
 )
 
 file(GLOB TS_FILES translations/*.ts)
 qt5_create_translation(QM_FILES ${TS_FILES})
 add_custom_target(translations DEPENDS ${QM_FILES} SOURCES ${TS_FILES})
 add_dependencies(cutefish-filemanager translations)
 
-install(TARGETS cutefish-filemanager RUNTIME DESTINATION /usr/bin)
+install(TARGETS cutefish-filemanager RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
 install(FILES cutefish-filemanager.desktop DESTINATION "/usr/share/applications")
 install(FILES ${QM_FILES} DESTINATION /usr/share/cutefish-filemanager/translations)

README.md

@@ -1,13 +1,25 @@
-# File Manager
+# File Manager Vi version
 
-Cutefish File Manager, simple to use, beautiful, and retain the classic PC interactive design. 
+Cutefish File Manager, simple to use, beautiful, and retain the classic PC interactive design.
+
+On this branch, the Cutefish File Manager has an even easier way to browse your files thanks to the vi mode. Instead of the classical shortcuts, vim fans will be pleased to use some of the vim shortcuts to browse their files.
+
+![screenshot](screenshots/Screenshot_20211025_151224.png)
 
 ## Dependencies
 
 ### Ubuntu
 
 ```
-sudo apt install libkf5solid-dev libkf5kio-dev -y
+sudo apt install equivs curl git devscripts lintian build-essential automake autotools-dev --no-install-recommends
+
+sudo mk-build-deps -i -t "apt-get --yes" -r
+```
+
+### Debian
+
+```
+sudo apt install build-essential cmake extra-cmake-modules libkf5kio-dev libkf5solid-dev libkf5windowsystem-dev libkf5config-dev qtbase5-dev qtbase5-private-dev qtdeclarative5-dev qtquickcontrols2-5-dev qttools5-dev qttools5-dev-tools
 ```
 
 ### ArchLinux
@@ -19,9 +31,10 @@ sudo pacman -S extra-cmake-modules qt5-base qt5-quickcontrols2 taglib kio
 ## Build
 
 ```shell
+git checkout vi-mode
 mkdir build
 cd build
-cmake ..
+cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr ..
 make
 ```
 
@@ -31,6 +44,26 @@ make
 sudo make install
 ```
 
+## Keybindings
+
+Most of those keybindings are coming from Vim, but not all of them. Here is a list of them :  
+- h,j,k,l : directions,  
+- y : (yank) copy,  
+- p : paste here,  
+- r : rename,  
+- Return/Enter : open/launch,  
+- % : display hidden files,  
+- u : undo last change,  
+- d : cut,  
+- x : delete,  
+- q : close the window,  
+- a : refresh,  
+- colon (:) : focus path input,  
+- v : select all files,  
+- backspace : go back  
+
+> Developper info : all of these shortcuts are noted in `helper/shortcut.h`
+
 ## License
 
 This project has been licensed by GPLv3.

application.cpp

@@ -0,0 +1,182 @@
+/*
+ * Copyright (C) 2021 CutefishOS Team.
+ *
+ * Author:     Reion Wong <[email protected]>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "application.h"
+#include "dbusinterface.h"
+#include "window.h"
+#include "desktop/desktop.h"
+#include "thumbnailer/thumbnailprovider.h"
+#include "filemanageradaptor.h"
+
+#include <QCommandLineParser>
+#include <QQmlApplicationEngine>
+#include <QQmlContext>
+
+#include <QDBusConnection>
+#include <QPixmapCache>
+#include <QTranslator>
+#include <QFileInfo>
+#include <QIcon>
+#include <QDir>
+
+// KIO
+#include <KIO/CopyJob>
+#include <KIO/Job>
+#include <KIO/PreviewJob>
+#include <KIO/DeleteJob>
+#include <KIO/DropJob>
+#include <KIO/FileUndoManager>
+#include <KIO/JobUiDelegate>
+#include <KIO/Paste>
+#include <KIO/PasteJob>
+#include <KIO/RestoreJob>
+
+Application::Application(int& argc, char** argv)
+    : QApplication(argc, argv)
+    , m_instance(false)
+{
+    if (QDBusConnection::sessionBus().registerService("com.cutefish.FileManager")) {
+        setOrganizationName("cutefishos");
+        setWindowIcon(QIcon::fromTheme("file-manager"));
+
+        new FileManagerAdaptor(this);
+        new DBusInterface;
+        QDBusConnection::sessionBus().registerObject("/FileManager", this);
+
+        // Translations
+        QLocale locale;
+        QString qmFilePath = QString("%1/%2.qm").arg("/usr/share/cutefish-filemanager/translations/").arg(locale.name());
+        if (QFile::exists(qmFilePath)) {
+            QTranslator *translator = new QTranslator(this);
+            if (translator->load(qmFilePath)) {
+                installTranslator(translator);
+            } else {
+                translator->deleteLater();
+            }
+        }
+
+        m_instance = true;
+    }
+}
+
+int Application::run()
+{
+    if (!parseCommandLineArgs())
+        return 0;
+
+    return QApplication::exec();
+}
+
+void Application::openFiles(const QStringList &paths)
+{
+    for (const QString &path : paths) {
+        openWindow(path);
+    }
+}
+
+void Application::moveToTrash(const QStringList &paths)
+{
+    if (paths.isEmpty())
+        return;
+
+    QList<QUrl> urls;
+
+    for (const QString &path : paths) {
+        urls.append(QUrl::fromLocalFile(path));
+    }
+
+    KIO::Job *job = KIO::trash(urls);
+    job->uiDelegate()->setAutoErrorHandlingEnabled(true);
+    KIO::FileUndoManager::self()->recordJob(KIO::FileUndoManager::Trash, urls, QUrl(QStringLiteral("trash:/")), job);
+}
+
+void Application::emptyTrash()
+{
+    Window *w = new Window;
+    w->load(QUrl("qrc:/qml/Dialogs/EmptyTrashDialog.qml"));
+}
+
+void Application::openWindow(const QString &path)
+{
+    Window *w = new Window;
+    w->rootContext()->setContextProperty("arg", path);
+    w->addImageProvider("thumbnailer", new ThumbnailProvider());
+    w->load(QUrl("qrc:/qml/main.qml"));
+}
+
+QStringList Application::formatUriList(const QStringList &list)
+{
+    QStringList val;
+
+    for (const QString &path : list) {
+        val.append(path == "." ? QDir::currentPath() : path);
+    }
+
+    if (val.isEmpty()) {
+        val.append(QDir::currentPath());
+    }
+
+    return val;
+}
+
+bool Application::parseCommandLineArgs()
+{
+    QCommandLineParser parser;
+    parser.setApplicationDescription(QStringLiteral("File Manager"));
+    parser.addHelpOption();
+
+    parser.addPositionalArgument("files", "Files", "[FILE1, FILE2,...]");
+
+    QCommandLineOption desktopOption(QStringList() << "d" << "desktop" << "Desktop Mode");
+    parser.addOption(desktopOption);
+
+    QCommandLineOption emptyTrashOption(QStringList() << "e" << "empty-trash" << "Empty Trash");
+    parser.addOption(emptyTrashOption);
+
+    QCommandLineOption moveToTrashOption(QStringList() << "mtr" << "move-to-trash" << "Move To Trash");
+    parser.addOption(moveToTrashOption);
+
+    parser.process(arguments());
+
+    if (m_instance) {
+        QPixmapCache::setCacheLimit(2048);
+
+        if (parser.isSet(desktopOption)) {
+            Desktop desktop;
+        } else {
+            openFiles(formatUriList(parser.positionalArguments()));
+        }
+    } else {
+        QDBusInterface iface("com.cutefish.FileManager",
+                             "/FileManager",
+                             "com.cutefish.FileManager",
+                             QDBusConnection::sessionBus(), this);
+
+        if (parser.isSet(emptyTrashOption)) {
+            // Empty Dialog
+            iface.call("emptyTrash");
+        } else if (parser.isSet(moveToTrashOption)) {
+            iface.call("moveToTrash", parser.positionalArguments());
+        } else {
+            iface.call("openFiles", formatUriList(parser.positionalArguments()));
+        }
+    }
+
+    return m_instance;
+}