File indexing completed on 2024-04-21 05:40:58

 /*
     SPDX-FileCopyrightText: 2010 Peter Penz <peter.penz@gmx.at>
     SPDX-FileCopyrightText: 2010 Sebastian Doerner <sebastian@sebastian-doerner.de>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #ifndef FILEVIEWGITPLUGIN_H
 #define FILEVIEWGITPLUGIN_H
 
 #include <Dolphin/KVersionControlPlugin>
 #include <KIO/CommandLauncherJob>
 #include <KJobUiDelegate>
 #include <KDialogJobUiDelegate>
 
 #include <KFileItem>
 
 #include <QList>
 #include <QHash>
 #include <QProcess>
 #include <QString>
 
 /**
  * @brief Git implementation for the KVersionControlPlugin2 interface.
  */
 class FileViewGitPlugin : public KVersionControlPlugin
 {
     Q_OBJECT
 
 public:
     FileViewGitPlugin(QObject* parent, const QList<QVariant>& args);
     ~FileViewGitPlugin() override;
     QString fileName() const override;
     QString localRepositoryRoot(const QString& directory) const override;
     bool beginRetrieval(const QString& directory) override;
     void endRetrieval() override;
     ItemVersion itemVersion(const KFileItem& item) const override;
     QList<QAction*> versionControlActions(const KFileItemList& items) const override;
     QList<QAction*> outOfVersionControlActions(const KFileItemList& items) const override;
 
 private Q_SLOTS:
     void addFiles();
     void revertFiles();
     void showLocalChanges();
     void removeFiles();
     void checkout();
     void commit();
     void createTag();
     void push();
     void pull();
     void log();
     void showDiff(const QUrl &link);
     void merge();
 
     void slotOperationCompleted(int exitCode, QProcess::ExitStatus exitStatus);
     void slotOperationError();
 private:
     QList<QAction*> contextMenuFilesActions(const KFileItemList& items) const;
     QList<QAction*> contextMenuDirectoryActions(const QString& directory) const;
     /**
      * Reads into buffer from device until we reach the next \0 or maxChars have been read.
      * @returns The number of characters read.
      */
     int readUntilZeroChar(QIODevice* device, char* buffer, const int maxChars);
     /**
      * Parses the output of the git push command and returns an appropriate message,
      * that should be displayed to the user.
      * @returns The error or success message to be printed to the user
      */
     QString parsePushOutput();
     /**
      * Parses the output of the git pull command and returns an appropriate message,
      * that should be displayed to the user.
      * @returns The error or success message to be printed to the user
      */
     QString parsePullOutput();
     /**
      * Executes the command "git {svnCommand}" for the files that have been
      * set by getting the context menu actions (see contextMenuActions()).
      * @param infoMsg     Message that should be shown before the command is executed.
      * @param errorMsg    Message that should be shown if the execution of the command
      *                    has failed.
      * @param operationCompletedMsg
      *                    Message that should be shown if the execution of the command
      *                    has been completed successfully.
      */
     void execGitCommand(const QString& gitCommand,
                         const QStringList& arguments,
                         const QString& infoMsg,
                         const QString& errorMsg,
                         const QString& operationCompletedMsg);
     void startGitCommandProcess();
 private:
     bool m_pendingOperation;
     /**
      * Contains all files in the current directory, whose version state is not
      * NormalVersion and directories containing such files (except for directories
      * whose only special contained file type is IgnoredVersion).
      */
     QHash<QString, ItemVersion> m_versionInfoHash;
     QAction* m_addAction;
     QAction* m_revertAction;
     QAction* m_showLocalChangesAction;
     QAction* m_removeAction;
     QAction* m_checkoutAction;
     QAction* m_commitAction;
     QAction* m_tagAction;
     QAction* m_pushAction;
     QAction* m_pullAction;
     QAction* m_logAction;
     QAction* m_mergeAction;
 
     QString m_currentDir;
     QProcess m_process;
     QString m_command;
     QStringList m_arguments;
     QString m_operationCompletedMsg;
     QString m_errorMsg;
 
     QWidget* m_parentWidget;
 
     //Current targets. m_contextItems is used if and only if m_contextDir is empty.
     mutable QString m_contextDir;
     mutable KFileItemList m_contextItems;
 
     // Utility method, because the method call is the same except for the command
     void runCommand(const QString &command)
     {
         auto *job = new KIO::CommandLauncherJob(command);
         job->setWorkingDirectory(m_currentDir);
         job->setUiDelegate(new KDialogJobUiDelegate(KJobUiDelegate::AutoHandlingEnabled, nullptr));
         job->start();
     }
 };
 #endif // FILEVIEWGITPLUGIN_H