src/Utils/Hooks.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2011-2014 - TortoiseGit
   4 // Copyright (C) 2006-2008 - TortoiseSVN
   5
   6 // This program is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU General Public License
   8 // as published by the Free Software Foundation; either version 2
   9 // of the License, or (at your option) any later version.
  10
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the Free Software Foundation,
  18 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 //
  20 #pragma once
  21 #include <map>
  22 #include "registry.h"
  23 #include "TGitPath.h"
  24 #include "GitRev.h"
  25 #include "GitStatus.h"
  26
  27 /**
  28  * \ingroup TortoiseProc
  29  * enumeration of all client hook types
  30  */
  31 typedef enum hooktype
  32 {
  33         unknown_hook,
  34         start_commit_hook,
  35         pre_commit_hook,
  36         post_commit_hook,
  37         issue_tracker_hook,
  38         pre_push_hook,
  39         post_push_hook,
  40 } hooktype;
  41
  42 /**
  43  * \ingroup TortoiseProc
  44  * helper class, used as the key to the std::map we store
  45  * the data for the client hook scripts in.
  46  */
  47 class hookkey
  48 {
  49 public:
  50         hooktype                htype;
  51         CTGitPath               path;
  52
  53         bool operator < (const hookkey& hk) const
  54         {
  55                 if (htype == hk.htype)
  56                         return (path < hk.path);
  57                 else
  58                         return htype < hk.htype;
  59         }
  60 };
  61
  62 /**
  63  * \ingroup TortoiseProc
  64  * helper struct, used as the value to the std::map we
  65  * store the data for the client hook scripts in.
  66  */
  67 typedef struct hookcmd
  68 {
  69         CString                 commandline;
  70         bool                    bWait;
  71         bool                    bShow;
  72 } hookcmd;
  73
  74 typedef std::map<hookkey, hookcmd>::iterator hookiterator;
  75 typedef std::map<hookkey, hookcmd>::const_iterator const_hookiterator;
  76
  77 /**
  78  * \ingroup TortoiseProc
  79  * Singleton class which deals with the client hook scripts.
  80  */
  81 class CHooks : public std::map<hookkey, hookcmd>
  82 {
  83 private:
  84         CHooks();
  85         ~CHooks();
  86         static void AddPathParam(CString& sCmd, const CTGitPathList& pathList);
  87         static void AddCWDParam(CString& sCmd, const CString& workingTree);
  88         static void AddErrorParam(CString& sCmd, const CString& error);
  89         static void AddParam(CString& sCmd, const CString& param);
  90         static CTGitPath AddMessageFileParam(CString& sCmd, const CString& message);
  91 public:
  92         /// Create the singleton. Call this at the start of the program.
  93         static bool                     Create();
  94         /// Returns the singleton instance
  95         static CHooks&          Instance();
  96         /// Destroys the singleton object. Call this at the end of the program.
  97         static void                     Destroy();
  98
  99 public:
 100         /// Saves the hook script information to the registry.
 101         bool                            Save();
 102         /**
 103          * Removes the hook script identified by \c key. To make the change persistent
 104          * call Save().
 105          */
 106         bool                            Remove(const hookkey &key);
 107         /**
 108          * Adds a new hook script. To make the change persistent, call Save().
 109          */
 110         void                            Add(hooktype ht, const CTGitPath& Path, LPCTSTR szCmd,
 111                                                         bool bWait, bool bShow);
 112
 113         /// returns the string representation of the hook type.
 114         static CString          GetHookTypeString(hooktype t);
 115         /// returns the hooktype from a string representation of the same.
 116         static hooktype         GetHookType(const CString& s);
 117
 118         /**
 119          * Executes the Start-Commit-Hook that first matches the path in
 120          * \c workingTree.
 121          * \param workingTree working tree root directory
 122          * \param pathList a list of paths to look for the hook scripts
 123          * \param message a commit message
 124          * \param exitcode on return, contains the exit code of the hook script
 125          * \param error the data the hook script outputs to stderr
 126          * \remark the string "%PATHS% in the command line of the hook script is
 127          * replaced with the path to a temporary file which contains a list of files
 128          * in \c pathList, separated by newlines. The hook script can parse this
 129          * file to get all the paths the commit is about to be done on.
 130          * The string %MESSAGEFILE% is replaced with path to temporary file containing
 131          * \c message. If the script finishes successfully, contents of this file
 132          * is read back into \c message parameter.
 133          */
 134         bool                            StartCommit(const CString& workingTree, const CTGitPathList& pathList, CString& message,
 135                                                                         DWORD& exitcode, CString& error);
 136         /**
 137          * Executes the Pre-Commit-Hook that first matches the path in
 138          * \c workingTree.
 139          * \param workingTree working tree root directory
 140          * \param pathList a list of paths to look for the hook scripts
 141          * \param message the commit message
 142          * \param exitcode on return, contains the exit code of the hook script
 143          * \param error the data the hook script outputs to stderr
 144          * \remark the string "%PATHS% in the command line of the hook script is
 145          * replaced with the path to a temporary file which contains a list of files
 146          * in \c pathList, separated by newlines. The hook script can parse this
 147          * file to get all the paths the update is about to be done on.
 148          * If the script finishes successfully, contents of this file is read back
 149          * into \c message parameter.
 150          */
 151         bool                            PreCommit(const CString& workingTree, const CTGitPathList& pathList,
 152                                                                         CString& message, DWORD& exitcode,
 153                                                                         CString& error);
 154         /**
 155          * Executes the Post-Commit-Hook that first matches the path in
 156          * \c workingTree.
 157          * \param workingTree working tree root directory
 158          * \param pathList a list of paths to look for the hook scripts
 159          * \param message the commit message
 160          * \param rev the revision the commit was done to
 161          * \param exitcode on return, contains the exit code of the hook script
 162          * \param error the data the hook script outputs to stderr
 163          * \remark the string "%PATHS% in the command line of the hook script is
 164          * replaced with the path to a temporary file which contains a list of files
 165          * in \c pathList, separated by newlines. The hook script can parse this
 166          * file to get all the paths the commit is about to be done on.
 167          */
 168         bool                            PostCommit(const CString& workingTree, const CTGitPathList& pathList,
 169                                                                         const GitRev& rev, const CString& message,
 170                                                                         DWORD& exitcode, CString& error);
 171
 172         bool    PrePush(const CString& workingTree, DWORD& exitcode, CString& error);
 173         bool    PostPush(const CString& workingTree, DWORD& exitcode, CString& error);
 174
 175         bool    IsHookPresent(hooktype t, const CString& workingTree) const;
 176
 177 private:
 178         /**
 179          * Starts a new process, specified in \c cmd.
 180          * \param error the data the process writes to stderr
 181          * \param bWait if true, then this method waits until the created process has finished. If false, then the return
 182          * value will always be 0 and \c error will be an empty string.
 183          * \param bShow set to true if the process should be started visible.
 184          * \return the exit code of the process if \c bWait is true, zero otherwise.
 185          */
 186         static DWORD            RunScript(CString cmd, LPCTSTR currentDir, CString& error, bool bWait, bool bShow);
 187         /**
 188          * Find the hook script information for the hook type \c t which matches the
 189          * path in \c workingTree.
 190          */
 191         const_hookiterator      FindItem(hooktype t, const CString& workingTree) const;
 192         static CHooks *         m_pInstance;
 193 };