OSDN Git Service

Show Bug ID link at log dialog
[tortoisegit/TortoiseGitJp.git] / src / TortoiseProc / ProjectProperties.h
1 // TortoiseSVN - a Windows shell extension for easy version control\r
2 \r
3 // Copyright (C) 2003-2008 - TortoiseSVN\r
4 \r
5 // This program is free software; you can redistribute it and/or\r
6 // modify it under the terms of the GNU General Public License\r
7 // as published by the Free Software Foundation; either version 2\r
8 // of the License, or (at your option) any later version.\r
9 \r
10 // This program is distributed in the hope that it will be useful,\r
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of\r
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
13 // GNU General Public License for more details.\r
14 \r
15 // You should have received a copy of the GNU General Public License\r
16 // along with this program; if not, write to the Free Software Foundation,\r
17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\r
18 //\r
19 #pragma once\r
20 #include <iostream>\r
21 #include <string>\r
22 #include "TGitPath.h"\r
23 using namespace std;\r
24 \r
25 #define BUGTRAQPROPNAME_LABEL             _T("bugtraq.label")\r
26 #define BUGTRAQPROPNAME_MESSAGE           _T("bugtraq.message")\r
27 #define BUGTRAQPROPNAME_NUMBER            _T("bugtraq.number")\r
28 #define BUGTRAQPROPNAME_LOGREGEX                  _T("bugtraq.logregex")\r
29 #define BUGTRAQPROPNAME_URL               _T("bugtraq.url")\r
30 #define BUGTRAQPROPNAME_WARNIFNOISSUE     _T("bugtraq.warnifnoissue")\r
31 #define BUGTRAQPROPNAME_APPEND                _T("bugtraq.append")\r
32 \r
33 #define PROJECTPROPNAME_LOGTEMPLATE               _T("tsvn.logtemplate")\r
34 #define PROJECTPROPNAME_LOGWIDTHLINE      _T("tsvn.logwidthmarker")\r
35 #define PROJECTPROPNAME_LOGMINSIZE                _T("tsvn.logminsize")\r
36 #define PROJECTPROPNAME_LOCKMSGMINSIZE    _T("tsvn.lockmsgminsize")\r
37 #define PROJECTPROPNAME_LOGFILELISTLANG   _T("tsvn.logfilelistenglish")\r
38 #define PROJECTPROPNAME_LOGSUMMARY                _T("tsvn.logsummary")\r
39 #define PROJECTPROPNAME_PROJECTLANGUAGE   _T("tsvn.projectlanguage")\r
40 #define PROJECTPROPNAME_USERFILEPROPERTY  _T("tsvn.userfileproperties")\r
41 #define PROJECTPROPNAME_USERDIRPROPERTY   _T("tsvn.userdirproperties")\r
42 #define PROJECTPROPNAME_AUTOPROPS                 _T("tsvn.autoprops")\r
43 \r
44 #define PROJECTPROPNAME_WEBVIEWER_REV     _T("webviewer.revision")\r
45 #define PROJECTPROPNAME_WEBVIEWER_PATHREV _T("webviewer.pathrevision")\r
46 \r
47 class CTSVNPathList;\r
48 struct svn_config_t;\r
49 \r
50 /**\r
51  * \ingroup TortoiseProc\r
52  * Provides methods for retrieving information about bug/issue trackers\r
53  * associated with a Subversion repository/working copy and other project\r
54  * related properties.\r
55  */\r
56 class ProjectProperties\r
57 {\r
58 public:\r
59         ProjectProperties(void);\r
60         ~ProjectProperties(void);\r
61 \r
62         /**\r
63          * Reads the properties from a path. If the path is a file\r
64          * then the properties are read from the parent folder of that file.\r
65          * \param path path to a file or a folder\r
66          */\r
67         BOOL ReadProps(CTGitPath path);\r
68         BOOL GetStringProps(CString &prop,TCHAR *key,bool bRemoveCR=true);\r
69         BOOL GetBOOLProps(BOOL &b, TCHAR*key);\r
70         /**\r
71          * Reads the properties from all paths found in a path list.\r
72          * This method calls ReadProps() for each path .\r
73          * \param list of paths\r
74          */\r
75         BOOL ReadPropsPathList(const CTGitPathList& pathList);\r
76 \r
77         /**\r
78          * Searches for the BugID inside a log message. If one is found,\r
79          * the method returns TRUE. The rich edit control is used to set\r
80          * the CFE_LINK effect on the BugID's.\r
81          * \param msg the log message\r
82          * \param pWnd Pointer to a rich edit control\r
83          */\r
84         BOOL FindBugID(const CString& msg, CWnd * pWnd);\r
85 \r
86         CString FindBugID(const CString& msg);\r
87         std::set<CString> FindBugIDs(const CString& msg);\r
88         /**\r
89          * Searches for the BugID inside a log message. If one is found,\r
90          * that BugID is returned. If none is found, an empty string is returned.\r
91          * The \c msg is trimmed off the BugID.\r
92          */\r
93         CString GetBugIDFromLog(CString& msg);\r
94         \r
95         /**\r
96          * Checks if the bug ID is valid. If bugtraq:number is 'true', then the\r
97          * functions checks if the bug ID doesn't contain any non-number chars in it.\r
98          */\r
99         BOOL CheckBugID(const CString& sID);\r
100         \r
101         /**\r
102          * Checks if the log message \c sMessage contains a bug ID. This is done by\r
103          * using the bugtraq:checkre property.\r
104          */\r
105         BOOL HasBugID(const CString& sMessage);\r
106         \r
107         /**\r
108          * Returns the URL pointing to the Issue in the issue tracker. The URL is\r
109          * created from the bugtraq:url property and the BugID found in the log message.\r
110          * \param msg the BugID extracted from the log message\r
111          */\r
112         CString GetBugIDUrl(const CString& sBugID);\r
113 \r
114         /**\r
115          * Inserts the tGit:autoprops into the Subversion config section.\r
116          * Call this before an import or an add operation.\r
117          */\r
118         //void InsertAutoProps(git_config_t *cfg);\r
119 \r
120         /**\r
121          * Adds all the project properties to the specified entry\r
122          */\r
123         bool AddAutoProps(const CTGitPath& path);\r
124 \r
125         /**\r
126          * Returns the log message summary if the tGit:logsummaryregex property is\r
127          * set and there are actually some matches.\r
128          * Otherwise, an empty string is returned.\r
129          */\r
130         CString GetLogSummary(const CString& sMessage);\r
131 \r
132     /**\r
133      * Transform the log message using \ref GetLogSummary and post-process it\r
134      * to be suitable for 1-line controls.\r
135      */\r
136     CString MakeShortMessage(const CString& message);\r
137 \r
138         /**\r
139          * Returns the path from which the properties were read.\r
140          */\r
141         CTGitPath GetPropsPath() {return propsPath;}\r
142 public:\r
143         /** The label to show in the commit dialog where the issue number/bug id\r
144          * is entered. Example: "Bug-ID: " or "Issue-No.:". Default is "Bug-ID :" */\r
145         CString         sLabel;\r
146 \r
147         /** The message string to add below the log message the user entered.\r
148          * It must contain the string "%BUGID%" which gets replaced by the client \r
149          * with the issue number / bug id the user entered. */\r
150         CString         sMessage;\r
151 \r
152         /** If this is set, then the bug-id / issue number must be a number, no text */\r
153         BOOL            bNumber;\r
154 \r
155         /** replaces bNumer: a regular expression string to check the validity of\r
156           * the entered bug ID. */\r
157         CString         sCheckRe;\r
158         \r
159         /** used to extract the bug ID from the string matched by sCheckRe */\r
160         CString         sBugIDRe;\r
161         \r
162         /** The url pointing to the issue tracker. If the url contains the string\r
163          * "%BUGID% the client has to replace it with the issue number / bug id\r
164          * the user entered. */\r
165         CString         sUrl;\r
166         \r
167         /** If set to TRUE, show a warning dialog if the user forgot to enter\r
168          * an issue number in the commit dialog. */\r
169         BOOL            bWarnIfNoIssue;\r
170 \r
171         /** If set to FALSE, then the bug tracking entry is inserted at the top of the\r
172            log message instead of at the bottom. Default is TRUE */\r
173         BOOL            bAppend;\r
174 \r
175         /** the COM uuid of the bugtraq provider which implements the IBugTraqProvider\r
176            interface. */\r
177         CString         sProviderUuid;\r
178 \r
179         /** the parameters passed to the COM bugtraq provider which implements the\r
180             IBugTraqProvider interface */\r
181         CString         sProviderParams;\r
182 \r
183         /** The number of chars the width marker should be shown at. If the property\r
184          * is not set, then this value is 80 by default. */\r
185         int                     nLogWidthMarker;\r
186 \r
187         /** The template to use for log messages. */\r
188         CString         sLogTemplate;\r
189 \r
190         /** Minimum size a log message must have in chars */\r
191         int                     nMinLogSize;\r
192 \r
193         /** Minimum size a lock message must have in chars */\r
194         int                     nMinLockMsgSize;\r
195 \r
196         /** TRUE if the file list to be inserted in the commit dialog should be in\r
197          * English and not in the localized language. Default is TRUE */\r
198         BOOL            bFileListInEnglish;\r
199         \r
200         /** The language identifier this project uses for log messages. */\r
201         LONG            lProjectLanguage;\r
202 \r
203         /** holds user defined properties for files. */\r
204         CString         sFPPath;\r
205 \r
206         /** holds user defined properties for directories. */\r
207         CString         sDPPath;\r
208 \r
209         /** The url pointing to the web viewer. The string %REVISION% is replaced\r
210          *  with the revision number, "HEAD", or a date */\r
211         CString         sWebViewerRev;\r
212 \r
213         /** The url pointing to the web viewer. The string %REVISION% is replaced\r
214          *  with the revision number, "HEAD", or a date. The string %PATH% is replaced\r
215          *  with the path relative to the repository root, e.g. "/trunk/src/file" */\r
216         CString         sWebViewerPathRev;\r
217 \r
218         /**\r
219          * The regex string to extract a summary from a log message. The summary\r
220          * is the first matching regex group.\r
221          */\r
222         CString         sLogSummaryRe;\r
223 \r
224         /**\r
225          * A regex string to extract revisions from a log message.\r
226          */\r
227         CString         sLogRevRegex;\r
228 private:\r
229         CString         sAutoProps;\r
230         CTGitPath       propsPath;\r
231 #ifdef DEBUG\r
232         friend class PropTest;\r
233 #endif\r
234 };\r