##// END OF EJS Templates
hgweb: support Content Security Policy...
Gregory Szorc -
r30766:d7bf7d2b default
parent child Browse files
Show More
@@ -0,0 +1,129 b''
1 #require serve
2
3 $ cat > web.conf << EOF
4 > [paths]
5 > / = $TESTTMP/*
6 > EOF
7
8 $ hg init repo1
9 $ cd repo1
10 $ touch foo
11 $ hg -q commit -A -m initial
12 $ cd ..
13
14 $ hg serve -p $HGPORT -d --pid-file=hg.pid --web-conf web.conf
15 $ cat hg.pid >> $DAEMON_PIDS
16
17 repo index should not send Content-Security-Policy header by default
18
19 $ get-with-headers.py --headeronly localhost:$HGPORT '' content-security-policy etag
20 200 Script output follows
21
22 static page should not send CSP by default
23
24 $ get-with-headers.py --headeronly localhost:$HGPORT static/mercurial.js content-security-policy etag
25 200 Script output follows
26
27 repo page should not send CSP by default, should send ETag
28
29 $ get-with-headers.py --headeronly localhost:$HGPORT repo1 content-security-policy etag
30 200 Script output follows
31 etag: W/"*" (glob)
32
33 $ killdaemons.py
34
35 Configure CSP without nonce
36
37 $ cat >> web.conf << EOF
38 > [web]
39 > csp = script-src https://example.com/ 'unsafe-inline'
40 > EOF
41
42 $ hg serve -p $HGPORT -d --pid-file=hg.pid --web-conf web.conf
43 $ cat hg.pid > $DAEMON_PIDS
44
45 repo index should send Content-Security-Policy header when enabled
46
47 $ get-with-headers.py --headeronly localhost:$HGPORT '' content-security-policy etag
48 200 Script output follows
49 content-security-policy: script-src https://example.com/ 'unsafe-inline'
50
51 static page should send CSP when enabled
52
53 $ get-with-headers.py --headeronly localhost:$HGPORT static/mercurial.js content-security-policy etag
54 200 Script output follows
55 content-security-policy: script-src https://example.com/ 'unsafe-inline'
56
57 repo page should send CSP by default, include etag w/o nonce
58
59 $ get-with-headers.py --headeronly localhost:$HGPORT repo1 content-security-policy etag
60 200 Script output follows
61 content-security-policy: script-src https://example.com/ 'unsafe-inline'
62 etag: W/"*" (glob)
63
64 nonce should not be added to html if CSP doesn't use it
65
66 $ get-with-headers.py localhost:$HGPORT repo1/graph/tip | egrep 'content-security-policy|<script'
67 <script type="text/javascript" src="/repo1/static/mercurial.js"></script>
68 <!--[if IE]><script type="text/javascript" src="/repo1/static/excanvas.js"></script><![endif]-->
69 <script type="text/javascript">
70 <script type="text/javascript">
71
72 Configure CSP with nonce
73
74 $ killdaemons.py
75 $ cat >> web.conf << EOF
76 > csp = image-src 'self'; script-src https://example.com/ 'nonce-%nonce%'
77 > EOF
78
79 $ hg serve -p $HGPORT -d --pid-file=hg.pid --web-conf web.conf
80 $ cat hg.pid > $DAEMON_PIDS
81
82 nonce should be substituted in CSP header
83
84 $ get-with-headers.py --headeronly localhost:$HGPORT '' content-security-policy etag
85 200 Script output follows
86 content-security-policy: image-src 'self'; script-src https://example.com/ 'nonce-*' (glob)
87
88 nonce should be included in CSP for static pages
89
90 $ get-with-headers.py --headeronly localhost:$HGPORT static/mercurial.js content-security-policy etag
91 200 Script output follows
92 content-security-policy: image-src 'self'; script-src https://example.com/ 'nonce-*' (glob)
93
94 repo page should have nonce, no ETag
95
96 $ get-with-headers.py --headeronly localhost:$HGPORT repo1 content-security-policy etag
97 200 Script output follows
98 content-security-policy: image-src 'self'; script-src https://example.com/ 'nonce-*' (glob)
99
100 nonce should be added to html when used
101
102 $ get-with-headers.py localhost:$HGPORT repo1/graph/tip content-security-policy | egrep 'content-security-policy|<script'
103 content-security-policy: image-src 'self'; script-src https://example.com/ 'nonce-*' (glob)
104 <script type="text/javascript" src="/repo1/static/mercurial.js"></script>
105 <!--[if IE]><script type="text/javascript" src="/repo1/static/excanvas.js"></script><![endif]-->
106 <script type="text/javascript" nonce="*"> (glob)
107 <script type="text/javascript" nonce="*"> (glob)
108
109 hgweb_mod w/o hgwebdir works as expected
110
111 $ killdaemons.py
112
113 $ hg -R repo1 serve -p $HGPORT -d --pid-file=hg.pid --config "web.csp=image-src 'self'; script-src https://example.com/ 'nonce-%nonce%'"
114 $ cat hg.pid > $DAEMON_PIDS
115
116 static page sends CSP
117
118 $ get-with-headers.py --headeronly localhost:$HGPORT static/mercurial.js content-security-policy etag
119 200 Script output follows
120 content-security-policy: image-src 'self'; script-src https://example.com/ 'nonce-*' (glob)
121
122 nonce included in <script> and headers
123
124 $ get-with-headers.py localhost:$HGPORT graph/tip content-security-policy | egrep 'content-security-policy|<script'
125 content-security-policy: image-src 'self'; script-src https://example.com/ 'nonce-*' (glob)
126 <script type="text/javascript" src="/static/mercurial.js"></script>
127 <!--[if IE]><script type="text/javascript" src="/static/excanvas.js"></script><![endif]-->
128 <script type="text/javascript" nonce="*"> (glob)
129 <script type="text/javascript" nonce="*"> (glob)
@@ -1,2303 +1,2317 b''
1 1 The Mercurial system uses a set of configuration files to control
2 2 aspects of its behavior.
3 3
4 4 Troubleshooting
5 5 ===============
6 6
7 7 If you're having problems with your configuration,
8 8 :hg:`config --debug` can help you understand what is introducing
9 9 a setting into your environment.
10 10
11 11 See :hg:`help config.syntax` and :hg:`help config.files`
12 12 for information about how and where to override things.
13 13
14 14 Structure
15 15 =========
16 16
17 17 The configuration files use a simple ini-file format. A configuration
18 18 file consists of sections, led by a ``[section]`` header and followed
19 19 by ``name = value`` entries::
20 20
21 21 [ui]
22 22 username = Firstname Lastname <firstname.lastname@example.net>
23 23 verbose = True
24 24
25 25 The above entries will be referred to as ``ui.username`` and
26 26 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
27 27
28 28 Files
29 29 =====
30 30
31 31 Mercurial reads configuration data from several files, if they exist.
32 32 These files do not exist by default and you will have to create the
33 33 appropriate configuration files yourself:
34 34
35 35 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
36 36
37 37 Global configuration like the username setting is typically put into:
38 38
39 39 .. container:: windows
40 40
41 41 - ``%USERPROFILE%\mercurial.ini`` (on Windows)
42 42
43 43 .. container:: unix.plan9
44 44
45 45 - ``$HOME/.hgrc`` (on Unix, Plan9)
46 46
47 47 The names of these files depend on the system on which Mercurial is
48 48 installed. ``*.rc`` files from a single directory are read in
49 49 alphabetical order, later ones overriding earlier ones. Where multiple
50 50 paths are given below, settings from earlier paths override later
51 51 ones.
52 52
53 53 .. container:: verbose.unix
54 54
55 55 On Unix, the following files are consulted:
56 56
57 57 - ``<repo>/.hg/hgrc`` (per-repository)
58 58 - ``$HOME/.hgrc`` (per-user)
59 59 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
60 60 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
61 61 - ``/etc/mercurial/hgrc`` (per-system)
62 62 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
63 63 - ``<internal>/default.d/*.rc`` (defaults)
64 64
65 65 .. container:: verbose.windows
66 66
67 67 On Windows, the following files are consulted:
68 68
69 69 - ``<repo>/.hg/hgrc`` (per-repository)
70 70 - ``%USERPROFILE%\.hgrc`` (per-user)
71 71 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
72 72 - ``%HOME%\.hgrc`` (per-user)
73 73 - ``%HOME%\Mercurial.ini`` (per-user)
74 74 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
75 75 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
76 76 - ``<install-dir>\Mercurial.ini`` (per-installation)
77 77 - ``<internal>/default.d/*.rc`` (defaults)
78 78
79 79 .. note::
80 80
81 81 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
82 82 is used when running 32-bit Python on 64-bit Windows.
83 83
84 84 .. container:: windows
85 85
86 86 On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``.
87 87
88 88 .. container:: verbose.plan9
89 89
90 90 On Plan9, the following files are consulted:
91 91
92 92 - ``<repo>/.hg/hgrc`` (per-repository)
93 93 - ``$home/lib/hgrc`` (per-user)
94 94 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
95 95 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
96 96 - ``/lib/mercurial/hgrc`` (per-system)
97 97 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
98 98 - ``<internal>/default.d/*.rc`` (defaults)
99 99
100 100 Per-repository configuration options only apply in a
101 101 particular repository. This file is not version-controlled, and
102 102 will not get transferred during a "clone" operation. Options in
103 103 this file override options in all other configuration files.
104 104
105 105 .. container:: unix.plan9
106 106
107 107 On Plan 9 and Unix, most of this file will be ignored if it doesn't
108 108 belong to a trusted user or to a trusted group. See
109 109 :hg:`help config.trusted` for more details.
110 110
111 111 Per-user configuration file(s) are for the user running Mercurial. Options
112 112 in these files apply to all Mercurial commands executed by this user in any
113 113 directory. Options in these files override per-system and per-installation
114 114 options.
115 115
116 116 Per-installation configuration files are searched for in the
117 117 directory where Mercurial is installed. ``<install-root>`` is the
118 118 parent directory of the **hg** executable (or symlink) being run.
119 119
120 120 .. container:: unix.plan9
121 121
122 122 For example, if installed in ``/shared/tools/bin/hg``, Mercurial
123 123 will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
124 124 files apply to all Mercurial commands executed by any user in any
125 125 directory.
126 126
127 127 Per-installation configuration files are for the system on
128 128 which Mercurial is running. Options in these files apply to all
129 129 Mercurial commands executed by any user in any directory. Registry
130 130 keys contain PATH-like strings, every part of which must reference
131 131 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
132 132 be read. Mercurial checks each of these locations in the specified
133 133 order until one or more configuration files are detected.
134 134
135 135 Per-system configuration files are for the system on which Mercurial
136 136 is running. Options in these files apply to all Mercurial commands
137 137 executed by any user in any directory. Options in these files
138 138 override per-installation options.
139 139
140 140 Mercurial comes with some default configuration. The default configuration
141 141 files are installed with Mercurial and will be overwritten on upgrades. Default
142 142 configuration files should never be edited by users or administrators but can
143 143 be overridden in other configuration files. So far the directory only contains
144 144 merge tool configuration but packagers can also put other default configuration
145 145 there.
146 146
147 147 Syntax
148 148 ======
149 149
150 150 A configuration file consists of sections, led by a ``[section]`` header
151 151 and followed by ``name = value`` entries (sometimes called
152 152 ``configuration keys``)::
153 153
154 154 [spam]
155 155 eggs=ham
156 156 green=
157 157 eggs
158 158
159 159 Each line contains one entry. If the lines that follow are indented,
160 160 they are treated as continuations of that entry. Leading whitespace is
161 161 removed from values. Empty lines are skipped. Lines beginning with
162 162 ``#`` or ``;`` are ignored and may be used to provide comments.
163 163
164 164 Configuration keys can be set multiple times, in which case Mercurial
165 165 will use the value that was configured last. As an example::
166 166
167 167 [spam]
168 168 eggs=large
169 169 ham=serrano
170 170 eggs=small
171 171
172 172 This would set the configuration key named ``eggs`` to ``small``.
173 173
174 174 It is also possible to define a section multiple times. A section can
175 175 be redefined on the same and/or on different configuration files. For
176 176 example::
177 177
178 178 [foo]
179 179 eggs=large
180 180 ham=serrano
181 181 eggs=small
182 182
183 183 [bar]
184 184 eggs=ham
185 185 green=
186 186 eggs
187 187
188 188 [foo]
189 189 ham=prosciutto
190 190 eggs=medium
191 191 bread=toasted
192 192
193 193 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
194 194 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
195 195 respectively. As you can see there only thing that matters is the last
196 196 value that was set for each of the configuration keys.
197 197
198 198 If a configuration key is set multiple times in different
199 199 configuration files the final value will depend on the order in which
200 200 the different configuration files are read, with settings from earlier
201 201 paths overriding later ones as described on the ``Files`` section
202 202 above.
203 203
204 204 A line of the form ``%include file`` will include ``file`` into the
205 205 current configuration file. The inclusion is recursive, which means
206 206 that included files can include other files. Filenames are relative to
207 207 the configuration file in which the ``%include`` directive is found.
208 208 Environment variables and ``~user`` constructs are expanded in
209 209 ``file``. This lets you do something like::
210 210
211 211 %include ~/.hgrc.d/$HOST.rc
212 212
213 213 to include a different configuration file on each computer you use.
214 214
215 215 A line with ``%unset name`` will remove ``name`` from the current
216 216 section, if it has been set previously.
217 217
218 218 The values are either free-form text strings, lists of text strings,
219 219 or Boolean values. Boolean values can be set to true using any of "1",
220 220 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
221 221 (all case insensitive).
222 222
223 223 List values are separated by whitespace or comma, except when values are
224 224 placed in double quotation marks::
225 225
226 226 allow_read = "John Doe, PhD", brian, betty
227 227
228 228 Quotation marks can be escaped by prefixing them with a backslash. Only
229 229 quotation marks at the beginning of a word is counted as a quotation
230 230 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
231 231
232 232 Sections
233 233 ========
234 234
235 235 This section describes the different sections that may appear in a
236 236 Mercurial configuration file, the purpose of each section, its possible
237 237 keys, and their possible values.
238 238
239 239 ``alias``
240 240 ---------
241 241
242 242 Defines command aliases.
243 243
244 244 Aliases allow you to define your own commands in terms of other
245 245 commands (or aliases), optionally including arguments. Positional
246 246 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
247 247 are expanded by Mercurial before execution. Positional arguments not
248 248 already used by ``$N`` in the definition are put at the end of the
249 249 command to be executed.
250 250
251 251 Alias definitions consist of lines of the form::
252 252
253 253 <alias> = <command> [<argument>]...
254 254
255 255 For example, this definition::
256 256
257 257 latest = log --limit 5
258 258
259 259 creates a new command ``latest`` that shows only the five most recent
260 260 changesets. You can define subsequent aliases using earlier ones::
261 261
262 262 stable5 = latest -b stable
263 263
264 264 .. note::
265 265
266 266 It is possible to create aliases with the same names as
267 267 existing commands, which will then override the original
268 268 definitions. This is almost always a bad idea!
269 269
270 270 An alias can start with an exclamation point (``!``) to make it a
271 271 shell alias. A shell alias is executed with the shell and will let you
272 272 run arbitrary commands. As an example, ::
273 273
274 274 echo = !echo $@
275 275
276 276 will let you do ``hg echo foo`` to have ``foo`` printed in your
277 277 terminal. A better example might be::
278 278
279 279 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm
280 280
281 281 which will make ``hg purge`` delete all unknown files in the
282 282 repository in the same manner as the purge extension.
283 283
284 284 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
285 285 expand to the command arguments. Unmatched arguments are
286 286 removed. ``$0`` expands to the alias name and ``$@`` expands to all
287 287 arguments separated by a space. ``"$@"`` (with quotes) expands to all
288 288 arguments quoted individually and separated by a space. These expansions
289 289 happen before the command is passed to the shell.
290 290
291 291 Shell aliases are executed in an environment where ``$HG`` expands to
292 292 the path of the Mercurial that was used to execute the alias. This is
293 293 useful when you want to call further Mercurial commands in a shell
294 294 alias, as was done above for the purge alias. In addition,
295 295 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
296 296 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
297 297
298 298 .. note::
299 299
300 300 Some global configuration options such as ``-R`` are
301 301 processed before shell aliases and will thus not be passed to
302 302 aliases.
303 303
304 304
305 305 ``annotate``
306 306 ------------
307 307
308 308 Settings used when displaying file annotations. All values are
309 309 Booleans and default to False. See :hg:`help config.diff` for
310 310 related options for the diff command.
311 311
312 312 ``ignorews``
313 313 Ignore white space when comparing lines.
314 314
315 315 ``ignorewsamount``
316 316 Ignore changes in the amount of white space.
317 317
318 318 ``ignoreblanklines``
319 319 Ignore changes whose lines are all blank.
320 320
321 321
322 322 ``auth``
323 323 --------
324 324
325 325 Authentication credentials for HTTP authentication. This section
326 326 allows you to store usernames and passwords for use when logging
327 327 *into* HTTP servers. See :hg:`help config.web` if
328 328 you want to configure *who* can login to your HTTP server.
329 329
330 330 Each line has the following format::
331 331
332 332 <name>.<argument> = <value>
333 333
334 334 where ``<name>`` is used to group arguments into authentication
335 335 entries. Example::
336 336
337 337 foo.prefix = hg.intevation.de/mercurial
338 338 foo.username = foo
339 339 foo.password = bar
340 340 foo.schemes = http https
341 341
342 342 bar.prefix = secure.example.org
343 343 bar.key = path/to/file.key
344 344 bar.cert = path/to/file.cert
345 345 bar.schemes = https
346 346
347 347 Supported arguments:
348 348
349 349 ``prefix``
350 350 Either ``*`` or a URI prefix with or without the scheme part.
351 351 The authentication entry with the longest matching prefix is used
352 352 (where ``*`` matches everything and counts as a match of length
353 353 1). If the prefix doesn't include a scheme, the match is performed
354 354 against the URI with its scheme stripped as well, and the schemes
355 355 argument, q.v., is then subsequently consulted.
356 356
357 357 ``username``
358 358 Optional. Username to authenticate with. If not given, and the
359 359 remote site requires basic or digest authentication, the user will
360 360 be prompted for it. Environment variables are expanded in the
361 361 username letting you do ``foo.username = $USER``. If the URI
362 362 includes a username, only ``[auth]`` entries with a matching
363 363 username or without a username will be considered.
364 364
365 365 ``password``
366 366 Optional. Password to authenticate with. If not given, and the
367 367 remote site requires basic or digest authentication, the user
368 368 will be prompted for it.
369 369
370 370 ``key``
371 371 Optional. PEM encoded client certificate key file. Environment
372 372 variables are expanded in the filename.
373 373
374 374 ``cert``
375 375 Optional. PEM encoded client certificate chain file. Environment
376 376 variables are expanded in the filename.
377 377
378 378 ``schemes``
379 379 Optional. Space separated list of URI schemes to use this
380 380 authentication entry with. Only used if the prefix doesn't include
381 381 a scheme. Supported schemes are http and https. They will match
382 382 static-http and static-https respectively, as well.
383 383 (default: https)
384 384
385 385 If no suitable authentication entry is found, the user is prompted
386 386 for credentials as usual if required by the remote.
387 387
388 388
389 389 ``committemplate``
390 390 ------------------
391 391
392 392 ``changeset``
393 393 String: configuration in this section is used as the template to
394 394 customize the text shown in the editor when committing.
395 395
396 396 In addition to pre-defined template keywords, commit log specific one
397 397 below can be used for customization:
398 398
399 399 ``extramsg``
400 400 String: Extra message (typically 'Leave message empty to abort
401 401 commit.'). This may be changed by some commands or extensions.
402 402
403 403 For example, the template configuration below shows as same text as
404 404 one shown by default::
405 405
406 406 [committemplate]
407 407 changeset = {desc}\n\n
408 408 HG: Enter commit message. Lines beginning with 'HG:' are removed.
409 409 HG: {extramsg}
410 410 HG: --
411 411 HG: user: {author}\n{ifeq(p2rev, "-1", "",
412 412 "HG: branch merge\n")
413 413 }HG: branch '{branch}'\n{if(activebookmark,
414 414 "HG: bookmark '{activebookmark}'\n") }{subrepos %
415 415 "HG: subrepo {subrepo}\n" }{file_adds %
416 416 "HG: added {file}\n" }{file_mods %
417 417 "HG: changed {file}\n" }{file_dels %
418 418 "HG: removed {file}\n" }{if(files, "",
419 419 "HG: no files changed\n")}
420 420
421 421 ``diff()``
422 422 String: show the diff (see :hg:`help templates` for detail)
423 423
424 424 Sometimes it is helpful to show the diff of the changeset in the editor without
425 425 having to prefix 'HG: ' to each line so that highlighting works correctly. For
426 426 this, Mercurial provides a special string which will ignore everything below
427 427 it::
428 428
429 429 HG: ------------------------ >8 ------------------------
430 430
431 431 For example, the template configuration below will show the diff below the
432 432 extra message::
433 433
434 434 [committemplate]
435 435 changeset = {desc}\n\n
436 436 HG: Enter commit message. Lines beginning with 'HG:' are removed.
437 437 HG: {extramsg}
438 438 HG: ------------------------ >8 ------------------------
439 439 HG: Do not touch the line above.
440 440 HG: Everything below will be removed.
441 441 {diff()}
442 442
443 443 .. note::
444 444
445 445 For some problematic encodings (see :hg:`help win32mbcs` for
446 446 detail), this customization should be configured carefully, to
447 447 avoid showing broken characters.
448 448
449 449 For example, if a multibyte character ending with backslash (0x5c) is
450 450 followed by the ASCII character 'n' in the customized template,
451 451 the sequence of backslash and 'n' is treated as line-feed unexpectedly
452 452 (and the multibyte character is broken, too).
453 453
454 454 Customized template is used for commands below (``--edit`` may be
455 455 required):
456 456
457 457 - :hg:`backout`
458 458 - :hg:`commit`
459 459 - :hg:`fetch` (for merge commit only)
460 460 - :hg:`graft`
461 461 - :hg:`histedit`
462 462 - :hg:`import`
463 463 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
464 464 - :hg:`rebase`
465 465 - :hg:`shelve`
466 466 - :hg:`sign`
467 467 - :hg:`tag`
468 468 - :hg:`transplant`
469 469
470 470 Configuring items below instead of ``changeset`` allows showing
471 471 customized message only for specific actions, or showing different
472 472 messages for each action.
473 473
474 474 - ``changeset.backout`` for :hg:`backout`
475 475 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
476 476 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
477 477 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
478 478 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
479 479 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
480 480 - ``changeset.gpg.sign`` for :hg:`sign`
481 481 - ``changeset.graft`` for :hg:`graft`
482 482 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
483 483 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
484 484 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
485 485 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
486 486 - ``changeset.import.bypass`` for :hg:`import --bypass`
487 487 - ``changeset.import.normal.merge`` for :hg:`import` on merges
488 488 - ``changeset.import.normal.normal`` for :hg:`import` on other
489 489 - ``changeset.mq.qnew`` for :hg:`qnew`
490 490 - ``changeset.mq.qfold`` for :hg:`qfold`
491 491 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
492 492 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
493 493 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
494 494 - ``changeset.rebase.normal`` for :hg:`rebase` on other
495 495 - ``changeset.shelve.shelve`` for :hg:`shelve`
496 496 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
497 497 - ``changeset.tag.remove`` for :hg:`tag --remove`
498 498 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
499 499 - ``changeset.transplant.normal`` for :hg:`transplant` on other
500 500
501 501 These dot-separated lists of names are treated as hierarchical ones.
502 502 For example, ``changeset.tag.remove`` customizes the commit message
503 503 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
504 504 commit message for :hg:`tag` regardless of ``--remove`` option.
505 505
506 506 When the external editor is invoked for a commit, the corresponding
507 507 dot-separated list of names without the ``changeset.`` prefix
508 508 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
509 509 variable.
510 510
511 511 In this section, items other than ``changeset`` can be referred from
512 512 others. For example, the configuration to list committed files up
513 513 below can be referred as ``{listupfiles}``::
514 514
515 515 [committemplate]
516 516 listupfiles = {file_adds %
517 517 "HG: added {file}\n" }{file_mods %
518 518 "HG: changed {file}\n" }{file_dels %
519 519 "HG: removed {file}\n" }{if(files, "",
520 520 "HG: no files changed\n")}
521 521
522 522 ``decode/encode``
523 523 -----------------
524 524
525 525 Filters for transforming files on checkout/checkin. This would
526 526 typically be used for newline processing or other
527 527 localization/canonicalization of files.
528 528
529 529 Filters consist of a filter pattern followed by a filter command.
530 530 Filter patterns are globs by default, rooted at the repository root.
531 531 For example, to match any file ending in ``.txt`` in the root
532 532 directory only, use the pattern ``*.txt``. To match any file ending
533 533 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
534 534 For each file only the first matching filter applies.
535 535
536 536 The filter command can start with a specifier, either ``pipe:`` or
537 537 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
538 538
539 539 A ``pipe:`` command must accept data on stdin and return the transformed
540 540 data on stdout.
541 541
542 542 Pipe example::
543 543
544 544 [encode]
545 545 # uncompress gzip files on checkin to improve delta compression
546 546 # note: not necessarily a good idea, just an example
547 547 *.gz = pipe: gunzip
548 548
549 549 [decode]
550 550 # recompress gzip files when writing them to the working dir (we
551 551 # can safely omit "pipe:", because it's the default)
552 552 *.gz = gzip
553 553
554 554 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
555 555 with the name of a temporary file that contains the data to be
556 556 filtered by the command. The string ``OUTFILE`` is replaced with the name
557 557 of an empty temporary file, where the filtered data must be written by
558 558 the command.
559 559
560 560 .. container:: windows
561 561
562 562 .. note::
563 563
564 564 The tempfile mechanism is recommended for Windows systems,
565 565 where the standard shell I/O redirection operators often have
566 566 strange effects and may corrupt the contents of your files.
567 567
568 568 This filter mechanism is used internally by the ``eol`` extension to
569 569 translate line ending characters between Windows (CRLF) and Unix (LF)
570 570 format. We suggest you use the ``eol`` extension for convenience.
571 571
572 572
573 573 ``defaults``
574 574 ------------
575 575
576 576 (defaults are deprecated. Don't use them. Use aliases instead.)
577 577
578 578 Use the ``[defaults]`` section to define command defaults, i.e. the
579 579 default options/arguments to pass to the specified commands.
580 580
581 581 The following example makes :hg:`log` run in verbose mode, and
582 582 :hg:`status` show only the modified files, by default::
583 583
584 584 [defaults]
585 585 log = -v
586 586 status = -m
587 587
588 588 The actual commands, instead of their aliases, must be used when
589 589 defining command defaults. The command defaults will also be applied
590 590 to the aliases of the commands defined.
591 591
592 592
593 593 ``diff``
594 594 --------
595 595
596 596 Settings used when displaying diffs. Everything except for ``unified``
597 597 is a Boolean and defaults to False. See :hg:`help config.annotate`
598 598 for related options for the annotate command.
599 599
600 600 ``git``
601 601 Use git extended diff format.
602 602
603 603 ``nobinary``
604 604 Omit git binary patches.
605 605
606 606 ``nodates``
607 607 Don't include dates in diff headers.
608 608
609 609 ``noprefix``
610 610 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
611 611
612 612 ``showfunc``
613 613 Show which function each change is in.
614 614
615 615 ``ignorews``
616 616 Ignore white space when comparing lines.
617 617
618 618 ``ignorewsamount``
619 619 Ignore changes in the amount of white space.
620 620
621 621 ``ignoreblanklines``
622 622 Ignore changes whose lines are all blank.
623 623
624 624 ``unified``
625 625 Number of lines of context to show.
626 626
627 627 ``email``
628 628 ---------
629 629
630 630 Settings for extensions that send email messages.
631 631
632 632 ``from``
633 633 Optional. Email address to use in "From" header and SMTP envelope
634 634 of outgoing messages.
635 635
636 636 ``to``
637 637 Optional. Comma-separated list of recipients' email addresses.
638 638
639 639 ``cc``
640 640 Optional. Comma-separated list of carbon copy recipients'
641 641 email addresses.
642 642
643 643 ``bcc``
644 644 Optional. Comma-separated list of blind carbon copy recipients'
645 645 email addresses.
646 646
647 647 ``method``
648 648 Optional. Method to use to send email messages. If value is ``smtp``
649 649 (default), use SMTP (see the ``[smtp]`` section for configuration).
650 650 Otherwise, use as name of program to run that acts like sendmail
651 651 (takes ``-f`` option for sender, list of recipients on command line,
652 652 message on stdin). Normally, setting this to ``sendmail`` or
653 653 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
654 654
655 655 ``charsets``
656 656 Optional. Comma-separated list of character sets considered
657 657 convenient for recipients. Addresses, headers, and parts not
658 658 containing patches of outgoing messages will be encoded in the
659 659 first character set to which conversion from local encoding
660 660 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
661 661 conversion fails, the text in question is sent as is.
662 662 (default: '')
663 663
664 664 Order of outgoing email character sets:
665 665
666 666 1. ``us-ascii``: always first, regardless of settings
667 667 2. ``email.charsets``: in order given by user
668 668 3. ``ui.fallbackencoding``: if not in email.charsets
669 669 4. ``$HGENCODING``: if not in email.charsets
670 670 5. ``utf-8``: always last, regardless of settings
671 671
672 672 Email example::
673 673
674 674 [email]
675 675 from = Joseph User <joe.user@example.com>
676 676 method = /usr/sbin/sendmail
677 677 # charsets for western Europeans
678 678 # us-ascii, utf-8 omitted, as they are tried first and last
679 679 charsets = iso-8859-1, iso-8859-15, windows-1252
680 680
681 681
682 682 ``extensions``
683 683 --------------
684 684
685 685 Mercurial has an extension mechanism for adding new features. To
686 686 enable an extension, create an entry for it in this section.
687 687
688 688 If you know that the extension is already in Python's search path,
689 689 you can give the name of the module, followed by ``=``, with nothing
690 690 after the ``=``.
691 691
692 692 Otherwise, give a name that you choose, followed by ``=``, followed by
693 693 the path to the ``.py`` file (including the file name extension) that
694 694 defines the extension.
695 695
696 696 To explicitly disable an extension that is enabled in an hgrc of
697 697 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
698 698 or ``foo = !`` when path is not supplied.
699 699
700 700 Example for ``~/.hgrc``::
701 701
702 702 [extensions]
703 703 # (the color extension will get loaded from Mercurial's path)
704 704 color =
705 705 # (this extension will get loaded from the file specified)
706 706 myfeature = ~/.hgext/myfeature.py
707 707
708 708
709 709 ``format``
710 710 ----------
711 711
712 712 ``usegeneraldelta``
713 713 Enable or disable the "generaldelta" repository format which improves
714 714 repository compression by allowing "revlog" to store delta against arbitrary
715 715 revision instead of the previous stored one. This provides significant
716 716 improvement for repositories with branches.
717 717
718 718 Repositories with this on-disk format require Mercurial version 1.9.
719 719
720 720 Enabled by default.
721 721
722 722 ``dotencode``
723 723 Enable or disable the "dotencode" repository format which enhances
724 724 the "fncache" repository format (which has to be enabled to use
725 725 dotencode) to avoid issues with filenames starting with ._ on
726 726 Mac OS X and spaces on Windows.
727 727
728 728 Repositories with this on-disk format require Mercurial version 1.7.
729 729
730 730 Enabled by default.
731 731
732 732 ``usefncache``
733 733 Enable or disable the "fncache" repository format which enhances
734 734 the "store" repository format (which has to be enabled to use
735 735 fncache) to allow longer filenames and avoids using Windows
736 736 reserved names, e.g. "nul".
737 737
738 738 Repositories with this on-disk format require Mercurial version 1.1.
739 739
740 740 Enabled by default.
741 741
742 742 ``usestore``
743 743 Enable or disable the "store" repository format which improves
744 744 compatibility with systems that fold case or otherwise mangle
745 745 filenames. Disabling this option will allow you to store longer filenames
746 746 in some situations at the expense of compatibility.
747 747
748 748 Repositories with this on-disk format require Mercurial version 0.9.4.
749 749
750 750 Enabled by default.
751 751
752 752 ``graph``
753 753 ---------
754 754
755 755 Web graph view configuration. This section let you change graph
756 756 elements display properties by branches, for instance to make the
757 757 ``default`` branch stand out.
758 758
759 759 Each line has the following format::
760 760
761 761 <branch>.<argument> = <value>
762 762
763 763 where ``<branch>`` is the name of the branch being
764 764 customized. Example::
765 765
766 766 [graph]
767 767 # 2px width
768 768 default.width = 2
769 769 # red color
770 770 default.color = FF0000
771 771
772 772 Supported arguments:
773 773
774 774 ``width``
775 775 Set branch edges width in pixels.
776 776
777 777 ``color``
778 778 Set branch edges color in hexadecimal RGB notation.
779 779
780 780 ``hooks``
781 781 ---------
782 782
783 783 Commands or Python functions that get automatically executed by
784 784 various actions such as starting or finishing a commit. Multiple
785 785 hooks can be run for the same action by appending a suffix to the
786 786 action. Overriding a site-wide hook can be done by changing its
787 787 value or setting it to an empty string. Hooks can be prioritized
788 788 by adding a prefix of ``priority.`` to the hook name on a new line
789 789 and setting the priority. The default priority is 0.
790 790
791 791 Example ``.hg/hgrc``::
792 792
793 793 [hooks]
794 794 # update working directory after adding changesets
795 795 changegroup.update = hg update
796 796 # do not use the site-wide hook
797 797 incoming =
798 798 incoming.email = /my/email/hook
799 799 incoming.autobuild = /my/build/hook
800 800 # force autobuild hook to run before other incoming hooks
801 801 priority.incoming.autobuild = 1
802 802
803 803 Most hooks are run with environment variables set that give useful
804 804 additional information. For each hook below, the environment
805 805 variables it is passed are listed with names of the form ``$HG_foo``.
806 806
807 807 ``changegroup``
808 808 Run after a changegroup has been added via push, pull or unbundle. ID of the
809 809 first new changeset is in ``$HG_NODE`` and last in ``$HG_NODE_LAST``. URL
810 810 from which changes came is in ``$HG_URL``.
811 811
812 812 ``commit``
813 813 Run after a changeset has been created in the local repository. ID
814 814 of the newly created changeset is in ``$HG_NODE``. Parent changeset
815 815 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
816 816
817 817 ``incoming``
818 818 Run after a changeset has been pulled, pushed, or unbundled into
819 819 the local repository. The ID of the newly arrived changeset is in
820 820 ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``.
821 821
822 822 ``outgoing``
823 823 Run after sending changes from local repository to another. ID of
824 824 first changeset sent is in ``$HG_NODE``. Source of operation is in
825 825 ``$HG_SOURCE``; Also see :hg:`help config.hooks.preoutgoing` hook.
826 826
827 827 ``post-<command>``
828 828 Run after successful invocations of the associated command. The
829 829 contents of the command line are passed as ``$HG_ARGS`` and the result
830 830 code in ``$HG_RESULT``. Parsed command line arguments are passed as
831 831 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
832 832 the python data internally passed to <command>. ``$HG_OPTS`` is a
833 833 dictionary of options (with unspecified options set to their defaults).
834 834 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
835 835
836 836 ``fail-<command>``
837 837 Run after a failed invocation of an associated command. The contents
838 838 of the command line are passed as ``$HG_ARGS``. Parsed command line
839 839 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
840 840 string representations of the python data internally passed to
841 841 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
842 842 options set to their defaults). ``$HG_PATS`` is a list of arguments.
843 843 Hook failure is ignored.
844 844
845 845 ``pre-<command>``
846 846 Run before executing the associated command. The contents of the
847 847 command line are passed as ``$HG_ARGS``. Parsed command line arguments
848 848 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
849 849 representations of the data internally passed to <command>. ``$HG_OPTS``
850 850 is a dictionary of options (with unspecified options set to their
851 851 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
852 852 failure, the command doesn't execute and Mercurial returns the failure
853 853 code.
854 854
855 855 ``prechangegroup``
856 856 Run before a changegroup is added via push, pull or unbundle. Exit
857 857 status 0 allows the changegroup to proceed. Non-zero status will
858 858 cause the push, pull or unbundle to fail. URL from which changes
859 859 will come is in ``$HG_URL``.
860 860
861 861 ``precommit``
862 862 Run before starting a local commit. Exit status 0 allows the
863 863 commit to proceed. Non-zero status will cause the commit to fail.
864 864 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
865 865
866 866 ``prelistkeys``
867 867 Run before listing pushkeys (like bookmarks) in the
868 868 repository. Non-zero status will cause failure. The key namespace is
869 869 in ``$HG_NAMESPACE``.
870 870
871 871 ``preoutgoing``
872 872 Run before collecting changes to send from the local repository to
873 873 another. Non-zero status will cause failure. This lets you prevent
874 874 pull over HTTP or SSH. Also prevents against local pull, push
875 875 (outbound) or bundle commands, but not effective, since you can
876 876 just copy files instead then. Source of operation is in
877 877 ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote
878 878 SSH or HTTP repository. If "push", "pull" or "bundle", operation
879 879 is happening on behalf of repository on same system.
880 880
881 881 ``prepushkey``
882 882 Run before a pushkey (like a bookmark) is added to the
883 883 repository. Non-zero status will cause the key to be rejected. The
884 884 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
885 885 the old value (if any) is in ``$HG_OLD``, and the new value is in
886 886 ``$HG_NEW``.
887 887
888 888 ``pretag``
889 889 Run before creating a tag. Exit status 0 allows the tag to be
890 890 created. Non-zero status will cause the tag to fail. ID of
891 891 changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is
892 892 local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``.
893 893
894 894 ``pretxnopen``
895 895 Run before any new repository transaction is open. The reason for the
896 896 transaction will be in ``$HG_TXNNAME`` and a unique identifier for the
897 897 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
898 898 transaction from being opened.
899 899
900 900 ``pretxnclose``
901 901 Run right before the transaction is actually finalized. Any repository change
902 902 will be visible to the hook program. This lets you validate the transaction
903 903 content or change it. Exit status 0 allows the commit to proceed. Non-zero
904 904 status will cause the transaction to be rolled back. The reason for the
905 905 transaction opening will be in ``$HG_TXNNAME`` and a unique identifier for
906 906 the transaction will be in ``HG_TXNID``. The rest of the available data will
907 907 vary according the transaction type. New changesets will add ``$HG_NODE`` (id
908 908 of the first added changeset), ``$HG_NODE_LAST`` (id of the last added
909 909 changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables, bookmarks and phases
910 910 changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``, etc.
911 911
912 912 ``txnclose``
913 913 Run after any repository transaction has been committed. At this
914 914 point, the transaction can no longer be rolled back. The hook will run
915 915 after the lock is released. See :hg:`help config.hooks.pretxnclose` docs for
916 916 details about available variables.
917 917
918 918 ``txnabort``
919 919 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
920 920 docs for details about available variables.
921 921
922 922 ``pretxnchangegroup``
923 923 Run after a changegroup has been added via push, pull or unbundle, but before
924 924 the transaction has been committed. Changegroup is visible to hook program.
925 925 This lets you validate incoming changes before accepting them. Passed the ID
926 926 of the first new changeset in ``$HG_NODE`` and last in ``$HG_NODE_LAST``.
927 927 Exit status 0 allows the transaction to commit. Non-zero status will cause
928 928 the transaction to be rolled back and the push, pull or unbundle will fail.
929 929 URL that was source of changes is in ``$HG_URL``.
930 930
931 931 ``pretxncommit``
932 932 Run after a changeset has been created but the transaction not yet
933 933 committed. Changeset is visible to hook program. This lets you
934 934 validate commit message and changes. Exit status 0 allows the
935 935 commit to proceed. Non-zero status will cause the transaction to
936 936 be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset
937 937 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
938 938
939 939 ``preupdate``
940 940 Run before updating the working directory. Exit status 0 allows
941 941 the update to proceed. Non-zero status will prevent the update.
942 942 Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID
943 943 of second new parent is in ``$HG_PARENT2``.
944 944
945 945 ``listkeys``
946 946 Run after listing pushkeys (like bookmarks) in the repository. The
947 947 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
948 948 dictionary containing the keys and values.
949 949
950 950 ``pushkey``
951 951 Run after a pushkey (like a bookmark) is added to the
952 952 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
953 953 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
954 954 value is in ``$HG_NEW``.
955 955
956 956 ``tag``
957 957 Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``.
958 958 Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in
959 959 repository if ``$HG_LOCAL=0``.
960 960
961 961 ``update``
962 962 Run after updating the working directory. Changeset ID of first
963 963 new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is
964 964 in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
965 965 update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
966 966
967 967 .. note::
968 968
969 969 It is generally better to use standard hooks rather than the
970 970 generic pre- and post- command hooks as they are guaranteed to be
971 971 called in the appropriate contexts for influencing transactions.
972 972 Also, hooks like "commit" will be called in all contexts that
973 973 generate a commit (e.g. tag) and not just the commit command.
974 974
975 975 .. note::
976 976
977 977 Environment variables with empty values may not be passed to
978 978 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
979 979 will have an empty value under Unix-like platforms for non-merge
980 980 changesets, while it will not be available at all under Windows.
981 981
982 982 The syntax for Python hooks is as follows::
983 983
984 984 hookname = python:modulename.submodule.callable
985 985 hookname = python:/path/to/python/module.py:callable
986 986
987 987 Python hooks are run within the Mercurial process. Each hook is
988 988 called with at least three keyword arguments: a ui object (keyword
989 989 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
990 990 keyword that tells what kind of hook is used. Arguments listed as
991 991 environment variables above are passed as keyword arguments, with no
992 992 ``HG_`` prefix, and names in lower case.
993 993
994 994 If a Python hook returns a "true" value or raises an exception, this
995 995 is treated as a failure.
996 996
997 997
998 998 ``hostfingerprints``
999 999 --------------------
1000 1000
1001 1001 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
1002 1002
1003 1003 Fingerprints of the certificates of known HTTPS servers.
1004 1004
1005 1005 A HTTPS connection to a server with a fingerprint configured here will
1006 1006 only succeed if the servers certificate matches the fingerprint.
1007 1007 This is very similar to how ssh known hosts works.
1008 1008
1009 1009 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
1010 1010 Multiple values can be specified (separated by spaces or commas). This can
1011 1011 be used to define both old and new fingerprints while a host transitions
1012 1012 to a new certificate.
1013 1013
1014 1014 The CA chain and web.cacerts is not used for servers with a fingerprint.
1015 1015
1016 1016 For example::
1017 1017
1018 1018 [hostfingerprints]
1019 1019 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1020 1020 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1021 1021
1022 1022 ``hostsecurity``
1023 1023 ----------------
1024 1024
1025 1025 Used to specify global and per-host security settings for connecting to
1026 1026 other machines.
1027 1027
1028 1028 The following options control default behavior for all hosts.
1029 1029
1030 1030 ``ciphers``
1031 1031 Defines the cryptographic ciphers to use for connections.
1032 1032
1033 1033 Value must be a valid OpenSSL Cipher List Format as documented at
1034 1034 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
1035 1035
1036 1036 This setting is for advanced users only. Setting to incorrect values
1037 1037 can significantly lower connection security or decrease performance.
1038 1038 You have been warned.
1039 1039
1040 1040 This option requires Python 2.7.
1041 1041
1042 1042 ``minimumprotocol``
1043 1043 Defines the minimum channel encryption protocol to use.
1044 1044
1045 1045 By default, the highest version of TLS supported by both client and server
1046 1046 is used.
1047 1047
1048 1048 Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
1049 1049
1050 1050 When running on an old Python version, only ``tls1.0`` is allowed since
1051 1051 old versions of Python only support up to TLS 1.0.
1052 1052
1053 1053 When running a Python that supports modern TLS versions, the default is
1054 1054 ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
1055 1055 weakens security and should only be used as a feature of last resort if
1056 1056 a server does not support TLS 1.1+.
1057 1057
1058 1058 Options in the ``[hostsecurity]`` section can have the form
1059 1059 ``hostname``:``setting``. This allows multiple settings to be defined on a
1060 1060 per-host basis.
1061 1061
1062 1062 The following per-host settings can be defined.
1063 1063
1064 1064 ``ciphers``
1065 1065 This behaves like ``ciphers`` as described above except it only applies
1066 1066 to the host on which it is defined.
1067 1067
1068 1068 ``fingerprints``
1069 1069 A list of hashes of the DER encoded peer/remote certificate. Values have
1070 1070 the form ``algorithm``:``fingerprint``. e.g.
1071 1071 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1072 1072
1073 1073 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1074 1074 ``sha512``.
1075 1075
1076 1076 Use of ``sha256`` or ``sha512`` is preferred.
1077 1077
1078 1078 If a fingerprint is specified, the CA chain is not validated for this
1079 1079 host and Mercurial will require the remote certificate to match one
1080 1080 of the fingerprints specified. This means if the server updates its
1081 1081 certificate, Mercurial will abort until a new fingerprint is defined.
1082 1082 This can provide stronger security than traditional CA-based validation
1083 1083 at the expense of convenience.
1084 1084
1085 1085 This option takes precedence over ``verifycertsfile``.
1086 1086
1087 1087 ``minimumprotocol``
1088 1088 This behaves like ``minimumprotocol`` as described above except it
1089 1089 only applies to the host on which it is defined.
1090 1090
1091 1091 ``verifycertsfile``
1092 1092 Path to file a containing a list of PEM encoded certificates used to
1093 1093 verify the server certificate. Environment variables and ``~user``
1094 1094 constructs are expanded in the filename.
1095 1095
1096 1096 The server certificate or the certificate's certificate authority (CA)
1097 1097 must match a certificate from this file or certificate verification
1098 1098 will fail and connections to the server will be refused.
1099 1099
1100 1100 If defined, only certificates provided by this file will be used:
1101 1101 ``web.cacerts`` and any system/default certificates will not be
1102 1102 used.
1103 1103
1104 1104 This option has no effect if the per-host ``fingerprints`` option
1105 1105 is set.
1106 1106
1107 1107 The format of the file is as follows::
1108 1108
1109 1109 -----BEGIN CERTIFICATE-----
1110 1110 ... (certificate in base64 PEM encoding) ...
1111 1111 -----END CERTIFICATE-----
1112 1112 -----BEGIN CERTIFICATE-----
1113 1113 ... (certificate in base64 PEM encoding) ...
1114 1114 -----END CERTIFICATE-----
1115 1115
1116 1116 For example::
1117 1117
1118 1118 [hostsecurity]
1119 1119 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1120 1120 hg2.example.com:fingerprints = sha1:914f1aff87249c09b6859b88b1906d30756491ca, sha1:fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1121 1121 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1122 1122
1123 1123 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1124 1124 when connecting to ``hg.example.com``::
1125 1125
1126 1126 [hostsecurity]
1127 1127 minimumprotocol = tls1.2
1128 1128 hg.example.com:minimumprotocol = tls1.1
1129 1129
1130 1130 ``http_proxy``
1131 1131 --------------
1132 1132
1133 1133 Used to access web-based Mercurial repositories through a HTTP
1134 1134 proxy.
1135 1135
1136 1136 ``host``
1137 1137 Host name and (optional) port of the proxy server, for example
1138 1138 "myproxy:8000".
1139 1139
1140 1140 ``no``
1141 1141 Optional. Comma-separated list of host names that should bypass
1142 1142 the proxy.
1143 1143
1144 1144 ``passwd``
1145 1145 Optional. Password to authenticate with at the proxy server.
1146 1146
1147 1147 ``user``
1148 1148 Optional. User name to authenticate with at the proxy server.
1149 1149
1150 1150 ``always``
1151 1151 Optional. Always use the proxy, even for localhost and any entries
1152 1152 in ``http_proxy.no``. (default: False)
1153 1153
1154 1154 ``merge``
1155 1155 ---------
1156 1156
1157 1157 This section specifies behavior during merges and updates.
1158 1158
1159 1159 ``checkignored``
1160 1160 Controls behavior when an ignored file on disk has the same name as a tracked
1161 1161 file in the changeset being merged or updated to, and has different
1162 1162 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1163 1163 abort on such files. With ``warn``, warn on such files and back them up as
1164 1164 ``.orig``. With ``ignore``, don't print a warning and back them up as
1165 1165 ``.orig``. (default: ``abort``)
1166 1166
1167 1167 ``checkunknown``
1168 1168 Controls behavior when an unknown file that isn't ignored has the same name
1169 1169 as a tracked file in the changeset being merged or updated to, and has
1170 1170 different contents. Similar to ``merge.checkignored``, except for files that
1171 1171 are not ignored. (default: ``abort``)
1172 1172
1173 1173 ``merge-patterns``
1174 1174 ------------------
1175 1175
1176 1176 This section specifies merge tools to associate with particular file
1177 1177 patterns. Tools matched here will take precedence over the default
1178 1178 merge tool. Patterns are globs by default, rooted at the repository
1179 1179 root.
1180 1180
1181 1181 Example::
1182 1182
1183 1183 [merge-patterns]
1184 1184 **.c = kdiff3
1185 1185 **.jpg = myimgmerge
1186 1186
1187 1187 ``merge-tools``
1188 1188 ---------------
1189 1189
1190 1190 This section configures external merge tools to use for file-level
1191 1191 merges. This section has likely been preconfigured at install time.
1192 1192 Use :hg:`config merge-tools` to check the existing configuration.
1193 1193 Also see :hg:`help merge-tools` for more details.
1194 1194
1195 1195 Example ``~/.hgrc``::
1196 1196
1197 1197 [merge-tools]
1198 1198 # Override stock tool location
1199 1199 kdiff3.executable = ~/bin/kdiff3
1200 1200 # Specify command line
1201 1201 kdiff3.args = $base $local $other -o $output
1202 1202 # Give higher priority
1203 1203 kdiff3.priority = 1
1204 1204
1205 1205 # Changing the priority of preconfigured tool
1206 1206 meld.priority = 0
1207 1207
1208 1208 # Disable a preconfigured tool
1209 1209 vimdiff.disabled = yes
1210 1210
1211 1211 # Define new tool
1212 1212 myHtmlTool.args = -m $local $other $base $output
1213 1213 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1214 1214 myHtmlTool.priority = 1
1215 1215
1216 1216 Supported arguments:
1217 1217
1218 1218 ``priority``
1219 1219 The priority in which to evaluate this tool.
1220 1220 (default: 0)
1221 1221
1222 1222 ``executable``
1223 1223 Either just the name of the executable or its pathname.
1224 1224
1225 1225 .. container:: windows
1226 1226
1227 1227 On Windows, the path can use environment variables with ${ProgramFiles}
1228 1228 syntax.
1229 1229
1230 1230 (default: the tool name)
1231 1231
1232 1232 ``args``
1233 1233 The arguments to pass to the tool executable. You can refer to the
1234 1234 files being merged as well as the output file through these
1235 1235 variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning
1236 1236 of ``$local`` and ``$other`` can vary depending on which action is being
1237 1237 performed. During and update or merge, ``$local`` represents the original
1238 1238 state of the file, while ``$other`` represents the commit you are updating
1239 1239 to or the commit you are merging with. During a rebase ``$local``
1240 1240 represents the destination of the rebase, and ``$other`` represents the
1241 1241 commit being rebased.
1242 1242 (default: ``$local $base $other``)
1243 1243
1244 1244 ``premerge``
1245 1245 Attempt to run internal non-interactive 3-way merge tool before
1246 1246 launching external tool. Options are ``true``, ``false``, ``keep`` or
1247 1247 ``keep-merge3``. The ``keep`` option will leave markers in the file if the
1248 1248 premerge fails. The ``keep-merge3`` will do the same but include information
1249 1249 about the base of the merge in the marker (see internal :merge3 in
1250 1250 :hg:`help merge-tools`).
1251 1251 (default: True)
1252 1252
1253 1253 ``binary``
1254 1254 This tool can merge binary files. (default: False, unless tool
1255 1255 was selected by file pattern match)
1256 1256
1257 1257 ``symlink``
1258 1258 This tool can merge symlinks. (default: False)
1259 1259
1260 1260 ``check``
1261 1261 A list of merge success-checking options:
1262 1262
1263 1263 ``changed``
1264 1264 Ask whether merge was successful when the merged file shows no changes.
1265 1265 ``conflicts``
1266 1266 Check whether there are conflicts even though the tool reported success.
1267 1267 ``prompt``
1268 1268 Always prompt for merge success, regardless of success reported by tool.
1269 1269
1270 1270 ``fixeol``
1271 1271 Attempt to fix up EOL changes caused by the merge tool.
1272 1272 (default: False)
1273 1273
1274 1274 ``gui``
1275 1275 This tool requires a graphical interface to run. (default: False)
1276 1276
1277 1277 .. container:: windows
1278 1278
1279 1279 ``regkey``
1280 1280 Windows registry key which describes install location of this
1281 1281 tool. Mercurial will search for this key first under
1282 1282 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1283 1283 (default: None)
1284 1284
1285 1285 ``regkeyalt``
1286 1286 An alternate Windows registry key to try if the first key is not
1287 1287 found. The alternate key uses the same ``regname`` and ``regappend``
1288 1288 semantics of the primary key. The most common use for this key
1289 1289 is to search for 32bit applications on 64bit operating systems.
1290 1290 (default: None)
1291 1291
1292 1292 ``regname``
1293 1293 Name of value to read from specified registry key.
1294 1294 (default: the unnamed (default) value)
1295 1295
1296 1296 ``regappend``
1297 1297 String to append to the value read from the registry, typically
1298 1298 the executable name of the tool.
1299 1299 (default: None)
1300 1300
1301 1301
1302 1302 ``patch``
1303 1303 ---------
1304 1304
1305 1305 Settings used when applying patches, for instance through the 'import'
1306 1306 command or with Mercurial Queues extension.
1307 1307
1308 1308 ``eol``
1309 1309 When set to 'strict' patch content and patched files end of lines
1310 1310 are preserved. When set to ``lf`` or ``crlf``, both files end of
1311 1311 lines are ignored when patching and the result line endings are
1312 1312 normalized to either LF (Unix) or CRLF (Windows). When set to
1313 1313 ``auto``, end of lines are again ignored while patching but line
1314 1314 endings in patched files are normalized to their original setting
1315 1315 on a per-file basis. If target file does not exist or has no end
1316 1316 of line, patch line endings are preserved.
1317 1317 (default: strict)
1318 1318
1319 1319 ``fuzz``
1320 1320 The number of lines of 'fuzz' to allow when applying patches. This
1321 1321 controls how much context the patcher is allowed to ignore when
1322 1322 trying to apply a patch.
1323 1323 (default: 2)
1324 1324
1325 1325 ``paths``
1326 1326 ---------
1327 1327
1328 1328 Assigns symbolic names and behavior to repositories.
1329 1329
1330 1330 Options are symbolic names defining the URL or directory that is the
1331 1331 location of the repository. Example::
1332 1332
1333 1333 [paths]
1334 1334 my_server = https://example.com/my_repo
1335 1335 local_path = /home/me/repo
1336 1336
1337 1337 These symbolic names can be used from the command line. To pull
1338 1338 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1339 1339 :hg:`push local_path`.
1340 1340
1341 1341 Options containing colons (``:``) denote sub-options that can influence
1342 1342 behavior for that specific path. Example::
1343 1343
1344 1344 [paths]
1345 1345 my_server = https://example.com/my_path
1346 1346 my_server:pushurl = ssh://example.com/my_path
1347 1347
1348 1348 The following sub-options can be defined:
1349 1349
1350 1350 ``pushurl``
1351 1351 The URL to use for push operations. If not defined, the location
1352 1352 defined by the path's main entry is used.
1353 1353
1354 1354 ``pushrev``
1355 1355 A revset defining which revisions to push by default.
1356 1356
1357 1357 When :hg:`push` is executed without a ``-r`` argument, the revset
1358 1358 defined by this sub-option is evaluated to determine what to push.
1359 1359
1360 1360 For example, a value of ``.`` will push the working directory's
1361 1361 revision by default.
1362 1362
1363 1363 Revsets specifying bookmarks will not result in the bookmark being
1364 1364 pushed.
1365 1365
1366 1366 The following special named paths exist:
1367 1367
1368 1368 ``default``
1369 1369 The URL or directory to use when no source or remote is specified.
1370 1370
1371 1371 :hg:`clone` will automatically define this path to the location the
1372 1372 repository was cloned from.
1373 1373
1374 1374 ``default-push``
1375 1375 (deprecated) The URL or directory for the default :hg:`push` location.
1376 1376 ``default:pushurl`` should be used instead.
1377 1377
1378 1378 ``phases``
1379 1379 ----------
1380 1380
1381 1381 Specifies default handling of phases. See :hg:`help phases` for more
1382 1382 information about working with phases.
1383 1383
1384 1384 ``publish``
1385 1385 Controls draft phase behavior when working as a server. When true,
1386 1386 pushed changesets are set to public in both client and server and
1387 1387 pulled or cloned changesets are set to public in the client.
1388 1388 (default: True)
1389 1389
1390 1390 ``new-commit``
1391 1391 Phase of newly-created commits.
1392 1392 (default: draft)
1393 1393
1394 1394 ``checksubrepos``
1395 1395 Check the phase of the current revision of each subrepository. Allowed
1396 1396 values are "ignore", "follow" and "abort". For settings other than
1397 1397 "ignore", the phase of the current revision of each subrepository is
1398 1398 checked before committing the parent repository. If any of those phases is
1399 1399 greater than the phase of the parent repository (e.g. if a subrepo is in a
1400 1400 "secret" phase while the parent repo is in "draft" phase), the commit is
1401 1401 either aborted (if checksubrepos is set to "abort") or the higher phase is
1402 1402 used for the parent repository commit (if set to "follow").
1403 1403 (default: follow)
1404 1404
1405 1405
1406 1406 ``profiling``
1407 1407 -------------
1408 1408
1409 1409 Specifies profiling type, format, and file output. Two profilers are
1410 1410 supported: an instrumenting profiler (named ``ls``), and a sampling
1411 1411 profiler (named ``stat``).
1412 1412
1413 1413 In this section description, 'profiling data' stands for the raw data
1414 1414 collected during profiling, while 'profiling report' stands for a
1415 1415 statistical text report generated from the profiling data. The
1416 1416 profiling is done using lsprof.
1417 1417
1418 1418 ``enabled``
1419 1419 Enable the profiler.
1420 1420 (default: false)
1421 1421
1422 1422 This is equivalent to passing ``--profile`` on the command line.
1423 1423
1424 1424 ``type``
1425 1425 The type of profiler to use.
1426 1426 (default: stat)
1427 1427
1428 1428 ``ls``
1429 1429 Use Python's built-in instrumenting profiler. This profiler
1430 1430 works on all platforms, but each line number it reports is the
1431 1431 first line of a function. This restriction makes it difficult to
1432 1432 identify the expensive parts of a non-trivial function.
1433 1433 ``stat``
1434 1434 Use a statistical profiler, statprof. This profiler is most
1435 1435 useful for profiling commands that run for longer than about 0.1
1436 1436 seconds.
1437 1437
1438 1438 ``format``
1439 1439 Profiling format. Specific to the ``ls`` instrumenting profiler.
1440 1440 (default: text)
1441 1441
1442 1442 ``text``
1443 1443 Generate a profiling report. When saving to a file, it should be
1444 1444 noted that only the report is saved, and the profiling data is
1445 1445 not kept.
1446 1446 ``kcachegrind``
1447 1447 Format profiling data for kcachegrind use: when saving to a
1448 1448 file, the generated file can directly be loaded into
1449 1449 kcachegrind.
1450 1450
1451 1451 ``statformat``
1452 1452 Profiling format for the ``stat`` profiler.
1453 1453 (default: hotpath)
1454 1454
1455 1455 ``hotpath``
1456 1456 Show a tree-based display containing the hot path of execution (where
1457 1457 most time was spent).
1458 1458 ``bymethod``
1459 1459 Show a table of methods ordered by how frequently they are active.
1460 1460 ``byline``
1461 1461 Show a table of lines in files ordered by how frequently they are active.
1462 1462 ``json``
1463 1463 Render profiling data as JSON.
1464 1464
1465 1465 ``frequency``
1466 1466 Sampling frequency. Specific to the ``stat`` sampling profiler.
1467 1467 (default: 1000)
1468 1468
1469 1469 ``output``
1470 1470 File path where profiling data or report should be saved. If the
1471 1471 file exists, it is replaced. (default: None, data is printed on
1472 1472 stderr)
1473 1473
1474 1474 ``sort``
1475 1475 Sort field. Specific to the ``ls`` instrumenting profiler.
1476 1476 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1477 1477 ``inlinetime``.
1478 1478 (default: inlinetime)
1479 1479
1480 1480 ``limit``
1481 1481 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1482 1482 (default: 30)
1483 1483
1484 1484 ``nested``
1485 1485 Show at most this number of lines of drill-down info after each main entry.
1486 1486 This can help explain the difference between Total and Inline.
1487 1487 Specific to the ``ls`` instrumenting profiler.
1488 1488 (default: 5)
1489 1489
1490 1490 ``progress``
1491 1491 ------------
1492 1492
1493 1493 Mercurial commands can draw progress bars that are as informative as
1494 1494 possible. Some progress bars only offer indeterminate information, while others
1495 1495 have a definite end point.
1496 1496
1497 1497 ``delay``
1498 1498 Number of seconds (float) before showing the progress bar. (default: 3)
1499 1499
1500 1500 ``changedelay``
1501 1501 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1502 1502 that value will be used instead. (default: 1)
1503 1503
1504 1504 ``refresh``
1505 1505 Time in seconds between refreshes of the progress bar. (default: 0.1)
1506 1506
1507 1507 ``format``
1508 1508 Format of the progress bar.
1509 1509
1510 1510 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1511 1511 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1512 1512 last 20 characters of the item, but this can be changed by adding either
1513 1513 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1514 1514 first num characters.
1515 1515
1516 1516 (default: topic bar number estimate)
1517 1517
1518 1518 ``width``
1519 1519 If set, the maximum width of the progress information (that is, min(width,
1520 1520 term width) will be used).
1521 1521
1522 1522 ``clear-complete``
1523 1523 Clear the progress bar after it's done. (default: True)
1524 1524
1525 1525 ``disable``
1526 1526 If true, don't show a progress bar.
1527 1527
1528 1528 ``assume-tty``
1529 1529 If true, ALWAYS show a progress bar, unless disable is given.
1530 1530
1531 1531 ``rebase``
1532 1532 ----------
1533 1533
1534 1534 ``allowdivergence``
1535 1535 Default to False, when True allow creating divergence when performing
1536 1536 rebase of obsolete changesets.
1537 1537
1538 1538 ``revsetalias``
1539 1539 ---------------
1540 1540
1541 1541 Alias definitions for revsets. See :hg:`help revsets` for details.
1542 1542
1543 1543 ``server``
1544 1544 ----------
1545 1545
1546 1546 Controls generic server settings.
1547 1547
1548 1548 ``compressionengines``
1549 1549 List of compression engines and their relative priority to advertise
1550 1550 to clients.
1551 1551
1552 1552 The order of compression engines determines their priority, the first
1553 1553 having the highest priority. If a compression engine is not listed
1554 1554 here, it won't be advertised to clients.
1555 1555
1556 1556 If not set (the default), built-in defaults are used. Run
1557 1557 :hg:`debuginstall` to list available compression engines and their
1558 1558 default wire protocol priority.
1559 1559
1560 1560 Older Mercurial clients only support zlib compression and this setting
1561 1561 has no effect for legacy clients.
1562 1562
1563 1563 ``uncompressed``
1564 1564 Whether to allow clients to clone a repository using the
1565 1565 uncompressed streaming protocol. This transfers about 40% more
1566 1566 data than a regular clone, but uses less memory and CPU on both
1567 1567 server and client. Over a LAN (100 Mbps or better) or a very fast
1568 1568 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
1569 1569 regular clone. Over most WAN connections (anything slower than
1570 1570 about 6 Mbps), uncompressed streaming is slower, because of the
1571 1571 extra data transfer overhead. This mode will also temporarily hold
1572 1572 the write lock while determining what data to transfer.
1573 1573 (default: True)
1574 1574
1575 1575 ``preferuncompressed``
1576 1576 When set, clients will try to use the uncompressed streaming
1577 1577 protocol. (default: False)
1578 1578
1579 1579 ``validate``
1580 1580 Whether to validate the completeness of pushed changesets by
1581 1581 checking that all new file revisions specified in manifests are
1582 1582 present. (default: False)
1583 1583
1584 1584 ``maxhttpheaderlen``
1585 1585 Instruct HTTP clients not to send request headers longer than this
1586 1586 many bytes. (default: 1024)
1587 1587
1588 1588 ``bundle1``
1589 1589 Whether to allow clients to push and pull using the legacy bundle1
1590 1590 exchange format. (default: True)
1591 1591
1592 1592 ``bundle1gd``
1593 1593 Like ``bundle1`` but only used if the repository is using the
1594 1594 *generaldelta* storage format. (default: True)
1595 1595
1596 1596 ``bundle1.push``
1597 1597 Whether to allow clients to push using the legacy bundle1 exchange
1598 1598 format. (default: True)
1599 1599
1600 1600 ``bundle1gd.push``
1601 1601 Like ``bundle1.push`` but only used if the repository is using the
1602 1602 *generaldelta* storage format. (default: True)
1603 1603
1604 1604 ``bundle1.pull``
1605 1605 Whether to allow clients to pull using the legacy bundle1 exchange
1606 1606 format. (default: True)
1607 1607
1608 1608 ``bundle1gd.pull``
1609 1609 Like ``bundle1.pull`` but only used if the repository is using the
1610 1610 *generaldelta* storage format. (default: True)
1611 1611
1612 1612 Large repositories using the *generaldelta* storage format should
1613 1613 consider setting this option because converting *generaldelta*
1614 1614 repositories to the exchange format required by the bundle1 data
1615 1615 format can consume a lot of CPU.
1616 1616
1617 1617 ``zliblevel``
1618 1618 Integer between ``-1`` and ``9`` that controls the zlib compression level
1619 1619 for wire protocol commands that send zlib compressed output (notably the
1620 1620 commands that send repository history data).
1621 1621
1622 1622 The default (``-1``) uses the default zlib compression level, which is
1623 1623 likely equivalent to ``6``. ``0`` means no compression. ``9`` means
1624 1624 maximum compression.
1625 1625
1626 1626 Setting this option allows server operators to make trade-offs between
1627 1627 bandwidth and CPU used. Lowering the compression lowers CPU utilization
1628 1628 but sends more bytes to clients.
1629 1629
1630 1630 This option only impacts the HTTP server.
1631 1631
1632 1632 ``zstdlevel``
1633 1633 Integer between ``1`` and ``22`` that controls the zstd compression level
1634 1634 for wire protocol commands. ``1`` is the minimal amount of compression and
1635 1635 ``22`` is the highest amount of compression.
1636 1636
1637 1637 The default (``3``) should be significantly faster than zlib while likely
1638 1638 delivering better compression ratios.
1639 1639
1640 1640 This option only impacts the HTTP server.
1641 1641
1642 1642 See also ``server.zliblevel``.
1643 1643
1644 1644 ``smtp``
1645 1645 --------
1646 1646
1647 1647 Configuration for extensions that need to send email messages.
1648 1648
1649 1649 ``host``
1650 1650 Host name of mail server, e.g. "mail.example.com".
1651 1651
1652 1652 ``port``
1653 1653 Optional. Port to connect to on mail server. (default: 465 if
1654 1654 ``tls`` is smtps; 25 otherwise)
1655 1655
1656 1656 ``tls``
1657 1657 Optional. Method to enable TLS when connecting to mail server: starttls,
1658 1658 smtps or none. (default: none)
1659 1659
1660 1660 ``username``
1661 1661 Optional. User name for authenticating with the SMTP server.
1662 1662 (default: None)
1663 1663
1664 1664 ``password``
1665 1665 Optional. Password for authenticating with the SMTP server. If not
1666 1666 specified, interactive sessions will prompt the user for a
1667 1667 password; non-interactive sessions will fail. (default: None)
1668 1668
1669 1669 ``local_hostname``
1670 1670 Optional. The hostname that the sender can use to identify
1671 1671 itself to the MTA.
1672 1672
1673 1673
1674 1674 ``subpaths``
1675 1675 ------------
1676 1676
1677 1677 Subrepository source URLs can go stale if a remote server changes name
1678 1678 or becomes temporarily unavailable. This section lets you define
1679 1679 rewrite rules of the form::
1680 1680
1681 1681 <pattern> = <replacement>
1682 1682
1683 1683 where ``pattern`` is a regular expression matching a subrepository
1684 1684 source URL and ``replacement`` is the replacement string used to
1685 1685 rewrite it. Groups can be matched in ``pattern`` and referenced in
1686 1686 ``replacements``. For instance::
1687 1687
1688 1688 http://server/(.*)-hg/ = http://hg.server/\1/
1689 1689
1690 1690 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
1691 1691
1692 1692 Relative subrepository paths are first made absolute, and the
1693 1693 rewrite rules are then applied on the full (absolute) path. If ``pattern``
1694 1694 doesn't match the full path, an attempt is made to apply it on the
1695 1695 relative path alone. The rules are applied in definition order.
1696 1696
1697 1697 ``templatealias``
1698 1698 -----------------
1699 1699
1700 1700 Alias definitions for templates. See :hg:`help templates` for details.
1701 1701
1702 1702 ``templates``
1703 1703 -------------
1704 1704
1705 1705 Use the ``[templates]`` section to define template strings.
1706 1706 See :hg:`help templates` for details.
1707 1707
1708 1708 ``trusted``
1709 1709 -----------
1710 1710
1711 1711 Mercurial will not use the settings in the
1712 1712 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
1713 1713 user or to a trusted group, as various hgrc features allow arbitrary
1714 1714 commands to be run. This issue is often encountered when configuring
1715 1715 hooks or extensions for shared repositories or servers. However,
1716 1716 the web interface will use some safe settings from the ``[web]``
1717 1717 section.
1718 1718
1719 1719 This section specifies what users and groups are trusted. The
1720 1720 current user is always trusted. To trust everybody, list a user or a
1721 1721 group with name ``*``. These settings must be placed in an
1722 1722 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
1723 1723 user or service running Mercurial.
1724 1724
1725 1725 ``users``
1726 1726 Comma-separated list of trusted users.
1727 1727
1728 1728 ``groups``
1729 1729 Comma-separated list of trusted groups.
1730 1730
1731 1731
1732 1732 ``ui``
1733 1733 ------
1734 1734
1735 1735 User interface controls.
1736 1736
1737 1737 ``archivemeta``
1738 1738 Whether to include the .hg_archival.txt file containing meta data
1739 1739 (hashes for the repository base and for tip) in archives created
1740 1740 by the :hg:`archive` command or downloaded via hgweb.
1741 1741 (default: True)
1742 1742
1743 1743 ``askusername``
1744 1744 Whether to prompt for a username when committing. If True, and
1745 1745 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
1746 1746 be prompted to enter a username. If no username is entered, the
1747 1747 default ``USER@HOST`` is used instead.
1748 1748 (default: False)
1749 1749
1750 1750 ``clonebundles``
1751 1751 Whether the "clone bundles" feature is enabled.
1752 1752
1753 1753 When enabled, :hg:`clone` may download and apply a server-advertised
1754 1754 bundle file from a URL instead of using the normal exchange mechanism.
1755 1755
1756 1756 This can likely result in faster and more reliable clones.
1757 1757
1758 1758 (default: True)
1759 1759
1760 1760 ``clonebundlefallback``
1761 1761 Whether failure to apply an advertised "clone bundle" from a server
1762 1762 should result in fallback to a regular clone.
1763 1763
1764 1764 This is disabled by default because servers advertising "clone
1765 1765 bundles" often do so to reduce server load. If advertised bundles
1766 1766 start mass failing and clients automatically fall back to a regular
1767 1767 clone, this would add significant and unexpected load to the server
1768 1768 since the server is expecting clone operations to be offloaded to
1769 1769 pre-generated bundles. Failing fast (the default behavior) ensures
1770 1770 clients don't overwhelm the server when "clone bundle" application
1771 1771 fails.
1772 1772
1773 1773 (default: False)
1774 1774
1775 1775 ``clonebundleprefers``
1776 1776 Defines preferences for which "clone bundles" to use.
1777 1777
1778 1778 Servers advertising "clone bundles" may advertise multiple available
1779 1779 bundles. Each bundle may have different attributes, such as the bundle
1780 1780 type and compression format. This option is used to prefer a particular
1781 1781 bundle over another.
1782 1782
1783 1783 The following keys are defined by Mercurial:
1784 1784
1785 1785 BUNDLESPEC
1786 1786 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
1787 1787 e.g. ``gzip-v2`` or ``bzip2-v1``.
1788 1788
1789 1789 COMPRESSION
1790 1790 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
1791 1791
1792 1792 Server operators may define custom keys.
1793 1793
1794 1794 Example values: ``COMPRESSION=bzip2``,
1795 1795 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
1796 1796
1797 1797 By default, the first bundle advertised by the server is used.
1798 1798
1799 1799 ``commitsubrepos``
1800 1800 Whether to commit modified subrepositories when committing the
1801 1801 parent repository. If False and one subrepository has uncommitted
1802 1802 changes, abort the commit.
1803 1803 (default: False)
1804 1804
1805 1805 ``debug``
1806 1806 Print debugging information. (default: False)
1807 1807
1808 1808 ``editor``
1809 1809 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
1810 1810
1811 1811 ``fallbackencoding``
1812 1812 Encoding to try if it's not possible to decode the changelog using
1813 1813 UTF-8. (default: ISO-8859-1)
1814 1814
1815 1815 ``graphnodetemplate``
1816 1816 The template used to print changeset nodes in an ASCII revision graph.
1817 1817 (default: ``{graphnode}``)
1818 1818
1819 1819 ``ignore``
1820 1820 A file to read per-user ignore patterns from. This file should be
1821 1821 in the same format as a repository-wide .hgignore file. Filenames
1822 1822 are relative to the repository root. This option supports hook syntax,
1823 1823 so if you want to specify multiple ignore files, you can do so by
1824 1824 setting something like ``ignore.other = ~/.hgignore2``. For details
1825 1825 of the ignore file format, see the ``hgignore(5)`` man page.
1826 1826
1827 1827 ``interactive``
1828 1828 Allow to prompt the user. (default: True)
1829 1829
1830 1830 ``interface``
1831 1831 Select the default interface for interactive features (default: text).
1832 1832 Possible values are 'text' and 'curses'.
1833 1833
1834 1834 ``interface.chunkselector``
1835 1835 Select the interface for change recording (e.g. :hg:`commit -i`).
1836 1836 Possible values are 'text' and 'curses'.
1837 1837 This config overrides the interface specified by ui.interface.
1838 1838
1839 1839 ``logtemplate``
1840 1840 Template string for commands that print changesets.
1841 1841
1842 1842 ``merge``
1843 1843 The conflict resolution program to use during a manual merge.
1844 1844 For more information on merge tools see :hg:`help merge-tools`.
1845 1845 For configuring merge tools see the ``[merge-tools]`` section.
1846 1846
1847 1847 ``mergemarkers``
1848 1848 Sets the merge conflict marker label styling. The ``detailed``
1849 1849 style uses the ``mergemarkertemplate`` setting to style the labels.
1850 1850 The ``basic`` style just uses 'local' and 'other' as the marker label.
1851 1851 One of ``basic`` or ``detailed``.
1852 1852 (default: ``basic``)
1853 1853
1854 1854 ``mergemarkertemplate``
1855 1855 The template used to print the commit description next to each conflict
1856 1856 marker during merge conflicts. See :hg:`help templates` for the template
1857 1857 format.
1858 1858
1859 1859 Defaults to showing the hash, tags, branches, bookmarks, author, and
1860 1860 the first line of the commit description.
1861 1861
1862 1862 If you use non-ASCII characters in names for tags, branches, bookmarks,
1863 1863 authors, and/or commit descriptions, you must pay attention to encodings of
1864 1864 managed files. At template expansion, non-ASCII characters use the encoding
1865 1865 specified by the ``--encoding`` global option, ``HGENCODING`` or other
1866 1866 environment variables that govern your locale. If the encoding of the merge
1867 1867 markers is different from the encoding of the merged files,
1868 1868 serious problems may occur.
1869 1869
1870 1870 ``origbackuppath``
1871 1871 The path to a directory used to store generated .orig files. If the path is
1872 1872 not a directory, one will be created.
1873 1873
1874 1874 ``patch``
1875 1875 An optional external tool that ``hg import`` and some extensions
1876 1876 will use for applying patches. By default Mercurial uses an
1877 1877 internal patch utility. The external tool must work as the common
1878 1878 Unix ``patch`` program. In particular, it must accept a ``-p``
1879 1879 argument to strip patch headers, a ``-d`` argument to specify the
1880 1880 current directory, a file name to patch, and a patch file to take
1881 1881 from stdin.
1882 1882
1883 1883 It is possible to specify a patch tool together with extra
1884 1884 arguments. For example, setting this option to ``patch --merge``
1885 1885 will use the ``patch`` program with its 2-way merge option.
1886 1886
1887 1887 ``portablefilenames``
1888 1888 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
1889 1889 (default: ``warn``)
1890 1890
1891 1891 ``warn``
1892 1892 Print a warning message on POSIX platforms, if a file with a non-portable
1893 1893 filename is added (e.g. a file with a name that can't be created on
1894 1894 Windows because it contains reserved parts like ``AUX``, reserved
1895 1895 characters like ``:``, or would cause a case collision with an existing
1896 1896 file).
1897 1897
1898 1898 ``ignore``
1899 1899 Don't print a warning.
1900 1900
1901 1901 ``abort``
1902 1902 The command is aborted.
1903 1903
1904 1904 ``true``
1905 1905 Alias for ``warn``.
1906 1906
1907 1907 ``false``
1908 1908 Alias for ``ignore``.
1909 1909
1910 1910 .. container:: windows
1911 1911
1912 1912 On Windows, this configuration option is ignored and the command aborted.
1913 1913
1914 1914 ``quiet``
1915 1915 Reduce the amount of output printed.
1916 1916 (default: False)
1917 1917
1918 1918 ``remotecmd``
1919 1919 Remote command to use for clone/push/pull operations.
1920 1920 (default: ``hg``)
1921 1921
1922 1922 ``report_untrusted``
1923 1923 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
1924 1924 trusted user or group.
1925 1925 (default: True)
1926 1926
1927 1927 ``slash``
1928 1928 Display paths using a slash (``/``) as the path separator. This
1929 1929 only makes a difference on systems where the default path
1930 1930 separator is not the slash character (e.g. Windows uses the
1931 1931 backslash character (``\``)).
1932 1932 (default: False)
1933 1933
1934 1934 ``statuscopies``
1935 1935 Display copies in the status command.
1936 1936
1937 1937 ``ssh``
1938 1938 Command to use for SSH connections. (default: ``ssh``)
1939 1939
1940 1940 ``strict``
1941 1941 Require exact command names, instead of allowing unambiguous
1942 1942 abbreviations. (default: False)
1943 1943
1944 1944 ``style``
1945 1945 Name of style to use for command output.
1946 1946
1947 1947 ``supportcontact``
1948 1948 A URL where users should report a Mercurial traceback. Use this if you are a
1949 1949 large organisation with its own Mercurial deployment process and crash
1950 1950 reports should be addressed to your internal support.
1951 1951
1952 1952 ``textwidth``
1953 1953 Maximum width of help text. A longer line generated by ``hg help`` or
1954 1954 ``hg subcommand --help`` will be broken after white space to get this
1955 1955 width or the terminal width, whichever comes first.
1956 1956 A non-positive value will disable this and the terminal width will be
1957 1957 used. (default: 78)
1958 1958
1959 1959 ``timeout``
1960 1960 The timeout used when a lock is held (in seconds), a negative value
1961 1961 means no timeout. (default: 600)
1962 1962
1963 1963 ``traceback``
1964 1964 Mercurial always prints a traceback when an unknown exception
1965 1965 occurs. Setting this to True will make Mercurial print a traceback
1966 1966 on all exceptions, even those recognized by Mercurial (such as
1967 1967 IOError or MemoryError). (default: False)
1968 1968
1969 1969 ``username``
1970 1970 The committer of a changeset created when running "commit".
1971 1971 Typically a person's name and email address, e.g. ``Fred Widget
1972 1972 <fred@example.com>``. Environment variables in the
1973 1973 username are expanded.
1974 1974
1975 1975 (default: ``$EMAIL`` or ``username@hostname``. If the username in
1976 1976 hgrc is empty, e.g. if the system admin set ``username =`` in the
1977 1977 system hgrc, it has to be specified manually or in a different
1978 1978 hgrc file)
1979 1979
1980 1980 ``verbose``
1981 1981 Increase the amount of output printed. (default: False)
1982 1982
1983 1983
1984 1984 ``web``
1985 1985 -------
1986 1986
1987 1987 Web interface configuration. The settings in this section apply to
1988 1988 both the builtin webserver (started by :hg:`serve`) and the script you
1989 1989 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
1990 1990 and WSGI).
1991 1991
1992 1992 The Mercurial webserver does no authentication (it does not prompt for
1993 1993 usernames and passwords to validate *who* users are), but it does do
1994 1994 authorization (it grants or denies access for *authenticated users*
1995 1995 based on settings in this section). You must either configure your
1996 1996 webserver to do authentication for you, or disable the authorization
1997 1997 checks.
1998 1998
1999 1999 For a quick setup in a trusted environment, e.g., a private LAN, where
2000 2000 you want it to accept pushes from anybody, you can use the following
2001 2001 command line::
2002 2002
2003 2003 $ hg --config web.allow_push=* --config web.push_ssl=False serve
2004 2004
2005 2005 Note that this will allow anybody to push anything to the server and
2006 2006 that this should not be used for public servers.
2007 2007
2008 2008 The full set of options is:
2009 2009
2010 2010 ``accesslog``
2011 2011 Where to output the access log. (default: stdout)
2012 2012
2013 2013 ``address``
2014 2014 Interface address to bind to. (default: all)
2015 2015
2016 2016 ``allow_archive``
2017 2017 List of archive format (bz2, gz, zip) allowed for downloading.
2018 2018 (default: empty)
2019 2019
2020 2020 ``allowbz2``
2021 2021 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
2022 2022 revisions.
2023 2023 (default: False)
2024 2024
2025 2025 ``allowgz``
2026 2026 (DEPRECATED) Whether to allow .tar.gz downloading of repository
2027 2027 revisions.
2028 2028 (default: False)
2029 2029
2030 2030 ``allowpull``
2031 2031 Whether to allow pulling from the repository. (default: True)
2032 2032
2033 2033 ``allow_push``
2034 2034 Whether to allow pushing to the repository. If empty or not set,
2035 2035 pushing is not allowed. If the special value ``*``, any remote
2036 2036 user can push, including unauthenticated users. Otherwise, the
2037 2037 remote user must have been authenticated, and the authenticated
2038 2038 user name must be present in this list. The contents of the
2039 2039 allow_push list are examined after the deny_push list.
2040 2040
2041 2041 ``allow_read``
2042 2042 If the user has not already been denied repository access due to
2043 2043 the contents of deny_read, this list determines whether to grant
2044 2044 repository access to the user. If this list is not empty, and the
2045 2045 user is unauthenticated or not present in the list, then access is
2046 2046 denied for the user. If the list is empty or not set, then access
2047 2047 is permitted to all users by default. Setting allow_read to the
2048 2048 special value ``*`` is equivalent to it not being set (i.e. access
2049 2049 is permitted to all users). The contents of the allow_read list are
2050 2050 examined after the deny_read list.
2051 2051
2052 2052 ``allowzip``
2053 2053 (DEPRECATED) Whether to allow .zip downloading of repository
2054 2054 revisions. This feature creates temporary files.
2055 2055 (default: False)
2056 2056
2057 2057 ``archivesubrepos``
2058 2058 Whether to recurse into subrepositories when archiving.
2059 2059 (default: False)
2060 2060
2061 2061 ``baseurl``
2062 2062 Base URL to use when publishing URLs in other locations, so
2063 2063 third-party tools like email notification hooks can construct
2064 2064 URLs. Example: ``http://hgserver/repos/``.
2065 2065
2066 2066 ``cacerts``
2067 2067 Path to file containing a list of PEM encoded certificate
2068 2068 authority certificates. Environment variables and ``~user``
2069 2069 constructs are expanded in the filename. If specified on the
2070 2070 client, then it will verify the identity of remote HTTPS servers
2071 2071 with these certificates.
2072 2072
2073 2073 To disable SSL verification temporarily, specify ``--insecure`` from
2074 2074 command line.
2075 2075
2076 2076 You can use OpenSSL's CA certificate file if your platform has
2077 2077 one. On most Linux systems this will be
2078 2078 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
2079 2079 generate this file manually. The form must be as follows::
2080 2080
2081 2081 -----BEGIN CERTIFICATE-----
2082 2082 ... (certificate in base64 PEM encoding) ...
2083 2083 -----END CERTIFICATE-----
2084 2084 -----BEGIN CERTIFICATE-----
2085 2085 ... (certificate in base64 PEM encoding) ...
2086 2086 -----END CERTIFICATE-----
2087 2087
2088 2088 ``cache``
2089 2089 Whether to support caching in hgweb. (default: True)
2090 2090
2091 2091 ``certificate``
2092 2092 Certificate to use when running :hg:`serve`.
2093 2093
2094 2094 ``collapse``
2095 2095 With ``descend`` enabled, repositories in subdirectories are shown at
2096 2096 a single level alongside repositories in the current path. With
2097 2097 ``collapse`` also enabled, repositories residing at a deeper level than
2098 2098 the current path are grouped behind navigable directory entries that
2099 2099 lead to the locations of these repositories. In effect, this setting
2100 2100 collapses each collection of repositories found within a subdirectory
2101 2101 into a single entry for that subdirectory. (default: False)
2102 2102
2103 2103 ``comparisoncontext``
2104 2104 Number of lines of context to show in side-by-side file comparison. If
2105 2105 negative or the value ``full``, whole files are shown. (default: 5)
2106 2106
2107 2107 This setting can be overridden by a ``context`` request parameter to the
2108 2108 ``comparison`` command, taking the same values.
2109 2109
2110 2110 ``contact``
2111 2111 Name or email address of the person in charge of the repository.
2112 2112 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
2113 2113
2114 ``csp``
2115 Send a ``Content-Security-Policy`` HTTP header with this value.
2116
2117 The value may contain a special string ``%nonce%``, which will be replaced
2118 by a randomly-generated one-time use value. If the value contains
2119 ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
2120 one-time property of the nonce. This nonce will also be inserted into
2121 ``<script>`` elements containing inline JavaScript.
2122
2123 Note: lots of HTML content sent by the server is derived from repository
2124 data. Please consider the potential for malicious repository data to
2125 "inject" itself into generated HTML content as part of your security
2126 threat model.
2127
2114 2128 ``deny_push``
2115 2129 Whether to deny pushing to the repository. If empty or not set,
2116 2130 push is not denied. If the special value ``*``, all remote users are
2117 2131 denied push. Otherwise, unauthenticated users are all denied, and
2118 2132 any authenticated user name present in this list is also denied. The
2119 2133 contents of the deny_push list are examined before the allow_push list.
2120 2134
2121 2135 ``deny_read``
2122 2136 Whether to deny reading/viewing of the repository. If this list is
2123 2137 not empty, unauthenticated users are all denied, and any
2124 2138 authenticated user name present in this list is also denied access to
2125 2139 the repository. If set to the special value ``*``, all remote users
2126 2140 are denied access (rarely needed ;). If deny_read is empty or not set,
2127 2141 the determination of repository access depends on the presence and
2128 2142 content of the allow_read list (see description). If both
2129 2143 deny_read and allow_read are empty or not set, then access is
2130 2144 permitted to all users by default. If the repository is being
2131 2145 served via hgwebdir, denied users will not be able to see it in
2132 2146 the list of repositories. The contents of the deny_read list have
2133 2147 priority over (are examined before) the contents of the allow_read
2134 2148 list.
2135 2149
2136 2150 ``descend``
2137 2151 hgwebdir indexes will not descend into subdirectories. Only repositories
2138 2152 directly in the current path will be shown (other repositories are still
2139 2153 available from the index corresponding to their containing path).
2140 2154
2141 2155 ``description``
2142 2156 Textual description of the repository's purpose or contents.
2143 2157 (default: "unknown")
2144 2158
2145 2159 ``encoding``
2146 2160 Character encoding name. (default: the current locale charset)
2147 2161 Example: "UTF-8".
2148 2162
2149 2163 ``errorlog``
2150 2164 Where to output the error log. (default: stderr)
2151 2165
2152 2166 ``guessmime``
2153 2167 Control MIME types for raw download of file content.
2154 2168 Set to True to let hgweb guess the content type from the file
2155 2169 extension. This will serve HTML files as ``text/html`` and might
2156 2170 allow cross-site scripting attacks when serving untrusted
2157 2171 repositories. (default: False)
2158 2172
2159 2173 ``hidden``
2160 2174 Whether to hide the repository in the hgwebdir index.
2161 2175 (default: False)
2162 2176
2163 2177 ``ipv6``
2164 2178 Whether to use IPv6. (default: False)
2165 2179
2166 2180 ``labels``
2167 2181 List of string *labels* associated with the repository.
2168 2182
2169 2183 Labels are exposed as a template keyword and can be used to customize
2170 2184 output. e.g. the ``index`` template can group or filter repositories
2171 2185 by labels and the ``summary`` template can display additional content
2172 2186 if a specific label is present.
2173 2187
2174 2188 ``logoimg``
2175 2189 File name of the logo image that some templates display on each page.
2176 2190 The file name is relative to ``staticurl``. That is, the full path to
2177 2191 the logo image is "staticurl/logoimg".
2178 2192 If unset, ``hglogo.png`` will be used.
2179 2193
2180 2194 ``logourl``
2181 2195 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
2182 2196 will be used.
2183 2197
2184 2198 ``maxchanges``
2185 2199 Maximum number of changes to list on the changelog. (default: 10)
2186 2200
2187 2201 ``maxfiles``
2188 2202 Maximum number of files to list per changeset. (default: 10)
2189 2203
2190 2204 ``maxshortchanges``
2191 2205 Maximum number of changes to list on the shortlog, graph or filelog
2192 2206 pages. (default: 60)
2193 2207
2194 2208 ``name``
2195 2209 Repository name to use in the web interface.
2196 2210 (default: current working directory)
2197 2211
2198 2212 ``port``
2199 2213 Port to listen on. (default: 8000)
2200 2214
2201 2215 ``prefix``
2202 2216 Prefix path to serve from. (default: '' (server root))
2203 2217
2204 2218 ``push_ssl``
2205 2219 Whether to require that inbound pushes be transported over SSL to
2206 2220 prevent password sniffing. (default: True)
2207 2221
2208 2222 ``refreshinterval``
2209 2223 How frequently directory listings re-scan the filesystem for new
2210 2224 repositories, in seconds. This is relevant when wildcards are used
2211 2225 to define paths. Depending on how much filesystem traversal is
2212 2226 required, refreshing may negatively impact performance.
2213 2227
2214 2228 Values less than or equal to 0 always refresh.
2215 2229 (default: 20)
2216 2230
2217 2231 ``staticurl``
2218 2232 Base URL to use for static files. If unset, static files (e.g. the
2219 2233 hgicon.png favicon) will be served by the CGI script itself. Use
2220 2234 this setting to serve them directly with the HTTP server.
2221 2235 Example: ``http://hgserver/static/``.
2222 2236
2223 2237 ``stripes``
2224 2238 How many lines a "zebra stripe" should span in multi-line output.
2225 2239 Set to 0 to disable. (default: 1)
2226 2240
2227 2241 ``style``
2228 2242 Which template map style to use. The available options are the names of
2229 2243 subdirectories in the HTML templates path. (default: ``paper``)
2230 2244 Example: ``monoblue``.
2231 2245
2232 2246 ``templates``
2233 2247 Where to find the HTML templates. The default path to the HTML templates
2234 2248 can be obtained from ``hg debuginstall``.
2235 2249
2236 2250 ``websub``
2237 2251 ----------
2238 2252
2239 2253 Web substitution filter definition. You can use this section to
2240 2254 define a set of regular expression substitution patterns which
2241 2255 let you automatically modify the hgweb server output.
2242 2256
2243 2257 The default hgweb templates only apply these substitution patterns
2244 2258 on the revision description fields. You can apply them anywhere
2245 2259 you want when you create your own templates by adding calls to the
2246 2260 "websub" filter (usually after calling the "escape" filter).
2247 2261
2248 2262 This can be used, for example, to convert issue references to links
2249 2263 to your issue tracker, or to convert "markdown-like" syntax into
2250 2264 HTML (see the examples below).
2251 2265
2252 2266 Each entry in this section names a substitution filter.
2253 2267 The value of each entry defines the substitution expression itself.
2254 2268 The websub expressions follow the old interhg extension syntax,
2255 2269 which in turn imitates the Unix sed replacement syntax::
2256 2270
2257 2271 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
2258 2272
2259 2273 You can use any separator other than "/". The final "i" is optional
2260 2274 and indicates that the search must be case insensitive.
2261 2275
2262 2276 Examples::
2263 2277
2264 2278 [websub]
2265 2279 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
2266 2280 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
2267 2281 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
2268 2282
2269 2283 ``worker``
2270 2284 ----------
2271 2285
2272 2286 Parallel master/worker configuration. We currently perform working
2273 2287 directory updates in parallel on Unix-like systems, which greatly
2274 2288 helps performance.
2275 2289
2276 2290 ``numcpus``
2277 2291 Number of CPUs to use for parallel operations. A zero or
2278 2292 negative value is treated as ``use the default``.
2279 2293 (default: 4 or the number of CPUs on the system, whichever is larger)
2280 2294
2281 2295 ``backgroundclose``
2282 2296 Whether to enable closing file handles on background threads during certain
2283 2297 operations. Some platforms aren't very efficient at closing file
2284 2298 handles that have been written or appended to. By performing file closing
2285 2299 on background threads, file write rate can increase substantially.
2286 2300 (default: true on Windows, false elsewhere)
2287 2301
2288 2302 ``backgroundcloseminfilecount``
2289 2303 Minimum number of files required to trigger background file closing.
2290 2304 Operations not writing this many files won't start background close
2291 2305 threads.
2292 2306 (default: 2048)
2293 2307
2294 2308 ``backgroundclosemaxqueue``
2295 2309 The maximum number of opened file handles waiting to be closed in the
2296 2310 background. This option only has an effect if ``backgroundclose`` is
2297 2311 enabled.
2298 2312 (default: 384)
2299 2313
2300 2314 ``backgroundclosethreadcount``
2301 2315 Number of threads to process background file closes. Only relevant if
2302 2316 ``backgroundclose`` is enabled.
2303 2317 (default: 4)
@@ -1,201 +1,222 b''
1 1 # hgweb/common.py - Utility functions needed by hgweb_mod and hgwebdir_mod
2 2 #
3 3 # Copyright 21 May 2005 - (c) 2005 Jake Edge <jake@edge2.net>
4 4 # Copyright 2005, 2006 Matt Mackall <mpm@selenic.com>
5 5 #
6 6 # This software may be used and distributed according to the terms of the
7 7 # GNU General Public License version 2 or any later version.
8 8
9 9 from __future__ import absolute_import
10 10
11 import base64
11 12 import errno
12 13 import mimetypes
13 14 import os
15 import uuid
14 16
15 17 from .. import (
16 18 encoding,
17 19 pycompat,
18 20 util,
19 21 )
20 22
21 23 httpserver = util.httpserver
22 24
23 25 HTTP_OK = 200
24 26 HTTP_NOT_MODIFIED = 304
25 27 HTTP_BAD_REQUEST = 400
26 28 HTTP_UNAUTHORIZED = 401
27 29 HTTP_FORBIDDEN = 403
28 30 HTTP_NOT_FOUND = 404
29 31 HTTP_METHOD_NOT_ALLOWED = 405
30 32 HTTP_SERVER_ERROR = 500
31 33
32 34
33 35 def ismember(ui, username, userlist):
34 36 """Check if username is a member of userlist.
35 37
36 38 If userlist has a single '*' member, all users are considered members.
37 39 Can be overridden by extensions to provide more complex authorization
38 40 schemes.
39 41 """
40 42 return userlist == ['*'] or username in userlist
41 43
42 44 def checkauthz(hgweb, req, op):
43 45 '''Check permission for operation based on request data (including
44 46 authentication info). Return if op allowed, else raise an ErrorResponse
45 47 exception.'''
46 48
47 49 user = req.env.get('REMOTE_USER')
48 50
49 51 deny_read = hgweb.configlist('web', 'deny_read')
50 52 if deny_read and (not user or ismember(hgweb.repo.ui, user, deny_read)):
51 53 raise ErrorResponse(HTTP_UNAUTHORIZED, 'read not authorized')
52 54
53 55 allow_read = hgweb.configlist('web', 'allow_read')
54 56 if allow_read and (not ismember(hgweb.repo.ui, user, allow_read)):
55 57 raise ErrorResponse(HTTP_UNAUTHORIZED, 'read not authorized')
56 58
57 59 if op == 'pull' and not hgweb.allowpull:
58 60 raise ErrorResponse(HTTP_UNAUTHORIZED, 'pull not authorized')
59 61 elif op == 'pull' or op is None: # op is None for interface requests
60 62 return
61 63
62 64 # enforce that you can only push using POST requests
63 65 if req.env['REQUEST_METHOD'] != 'POST':
64 66 msg = 'push requires POST request'
65 67 raise ErrorResponse(HTTP_METHOD_NOT_ALLOWED, msg)
66 68
67 69 # require ssl by default for pushing, auth info cannot be sniffed
68 70 # and replayed
69 71 scheme = req.env.get('wsgi.url_scheme')
70 72 if hgweb.configbool('web', 'push_ssl', True) and scheme != 'https':
71 73 raise ErrorResponse(HTTP_FORBIDDEN, 'ssl required')
72 74
73 75 deny = hgweb.configlist('web', 'deny_push')
74 76 if deny and (not user or ismember(hgweb.repo.ui, user, deny)):
75 77 raise ErrorResponse(HTTP_UNAUTHORIZED, 'push not authorized')
76 78
77 79 allow = hgweb.configlist('web', 'allow_push')
78 80 if not (allow and ismember(hgweb.repo.ui, user, allow)):
79 81 raise ErrorResponse(HTTP_UNAUTHORIZED, 'push not authorized')
80 82
81 83 # Hooks for hgweb permission checks; extensions can add hooks here.
82 84 # Each hook is invoked like this: hook(hgweb, request, operation),
83 85 # where operation is either read, pull or push. Hooks should either
84 86 # raise an ErrorResponse exception, or just return.
85 87 #
86 88 # It is possible to do both authentication and authorization through
87 89 # this.
88 90 permhooks = [checkauthz]
89 91
90 92
91 93 class ErrorResponse(Exception):
92 94 def __init__(self, code, message=None, headers=[]):
93 95 if message is None:
94 96 message = _statusmessage(code)
95 97 Exception.__init__(self, message)
96 98 self.code = code
97 99 self.headers = headers
98 100
99 101 class continuereader(object):
100 102 def __init__(self, f, write):
101 103 self.f = f
102 104 self._write = write
103 105 self.continued = False
104 106
105 107 def read(self, amt=-1):
106 108 if not self.continued:
107 109 self.continued = True
108 110 self._write('HTTP/1.1 100 Continue\r\n\r\n')
109 111 return self.f.read(amt)
110 112
111 113 def __getattr__(self, attr):
112 114 if attr in ('close', 'readline', 'readlines', '__iter__'):
113 115 return getattr(self.f, attr)
114 116 raise AttributeError
115 117
116 118 def _statusmessage(code):
117 119 responses = httpserver.basehttprequesthandler.responses
118 120 return responses.get(code, ('Error', 'Unknown error'))[0]
119 121
120 122 def statusmessage(code, message=None):
121 123 return '%d %s' % (code, message or _statusmessage(code))
122 124
123 125 def get_stat(spath, fn):
124 126 """stat fn if it exists, spath otherwise"""
125 127 cl_path = os.path.join(spath, fn)
126 128 if os.path.exists(cl_path):
127 129 return os.stat(cl_path)
128 130 else:
129 131 return os.stat(spath)
130 132
131 133 def get_mtime(spath):
132 134 return get_stat(spath, "00changelog.i").st_mtime
133 135
134 136 def staticfile(directory, fname, req):
135 137 """return a file inside directory with guessed Content-Type header
136 138
137 139 fname always uses '/' as directory separator and isn't allowed to
138 140 contain unusual path components.
139 141 Content-Type is guessed using the mimetypes module.
140 142 Return an empty string if fname is illegal or file not found.
141 143
142 144 """
143 145 parts = fname.split('/')
144 146 for part in parts:
145 147 if (part in ('', os.curdir, os.pardir) or
146 148 pycompat.ossep in part or
147 149 pycompat.osaltsep is not None and pycompat.osaltsep in part):
148 150 return
149 151 fpath = os.path.join(*parts)
150 152 if isinstance(directory, str):
151 153 directory = [directory]
152 154 for d in directory:
153 155 path = os.path.join(d, fpath)
154 156 if os.path.exists(path):
155 157 break
156 158 try:
157 159 os.stat(path)
158 160 ct = mimetypes.guess_type(path)[0] or "text/plain"
159 161 fp = open(path, 'rb')
160 162 data = fp.read()
161 163 fp.close()
162 164 req.respond(HTTP_OK, ct, body=data)
163 165 except TypeError:
164 166 raise ErrorResponse(HTTP_SERVER_ERROR, 'illegal filename')
165 167 except OSError as err:
166 168 if err.errno == errno.ENOENT:
167 169 raise ErrorResponse(HTTP_NOT_FOUND)
168 170 else:
169 171 raise ErrorResponse(HTTP_SERVER_ERROR, err.strerror)
170 172
171 173 def paritygen(stripecount, offset=0):
172 174 """count parity of horizontal stripes for easier reading"""
173 175 if stripecount and offset:
174 176 # account for offset, e.g. due to building the list in reverse
175 177 count = (stripecount + offset) % stripecount
176 178 parity = (stripecount + offset) / stripecount & 1
177 179 else:
178 180 count = 0
179 181 parity = 0
180 182 while True:
181 183 yield parity
182 184 count += 1
183 185 if stripecount and count >= stripecount:
184 186 parity = 1 - parity
185 187 count = 0
186 188
187 189 def get_contact(config):
188 190 """Return repo contact information or empty string.
189 191
190 192 web.contact is the primary source, but if that is not set, try
191 193 ui.username or $EMAIL as a fallback to display something useful.
192 194 """
193 195 return (config("web", "contact") or
194 196 config("ui", "username") or
195 197 encoding.environ.get("EMAIL") or "")
196 198
197 199 def caching(web, req):
198 200 tag = 'W/"%s"' % web.mtime
199 201 if req.env.get('HTTP_IF_NONE_MATCH') == tag:
200 202 raise ErrorResponse(HTTP_NOT_MODIFIED)
201 203 req.headers.append(('ETag', tag))
204
205 def cspvalues(ui):
206 """Obtain the Content-Security-Policy header and nonce value.
207
208 Returns a 2-tuple of the CSP header value and the nonce value.
209
210 First value is ``None`` if CSP isn't enabled. Second value is ``None``
211 if CSP isn't enabled or if the CSP header doesn't need a nonce.
212 """
213 # Don't allow untrusted CSP setting since it be disable protections
214 # from a trusted/global source.
215 csp = ui.config('web', 'csp', untrusted=False)
216 nonce = None
217
218 if csp and '%nonce%' in csp:
219 nonce = base64.urlsafe_b64encode(uuid.uuid4().bytes).rstrip('=')
220 csp = csp.replace('%nonce%', nonce)
221
222 return csp, nonce
@@ -1,470 +1,483 b''
1 1 # hgweb/hgweb_mod.py - Web interface for a repository.
2 2 #
3 3 # Copyright 21 May 2005 - (c) 2005 Jake Edge <jake@edge2.net>
4 4 # Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
5 5 #
6 6 # This software may be used and distributed according to the terms of the
7 7 # GNU General Public License version 2 or any later version.
8 8
9 9 from __future__ import absolute_import
10 10
11 11 import contextlib
12 12 import os
13 13
14 14 from .common import (
15 15 ErrorResponse,
16 16 HTTP_BAD_REQUEST,
17 17 HTTP_NOT_FOUND,
18 18 HTTP_NOT_MODIFIED,
19 19 HTTP_OK,
20 20 HTTP_SERVER_ERROR,
21 21 caching,
22 cspvalues,
22 23 permhooks,
23 24 )
24 25 from .request import wsgirequest
25 26
26 27 from .. import (
27 28 encoding,
28 29 error,
29 30 hg,
30 31 hook,
31 32 profiling,
32 33 repoview,
33 34 templatefilters,
34 35 templater,
35 36 ui as uimod,
36 37 util,
37 38 )
38 39
39 40 from . import (
40 41 protocol,
41 42 webcommands,
42 43 webutil,
43 44 wsgicgi,
44 45 )
45 46
46 47 perms = {
47 48 'changegroup': 'pull',
48 49 'changegroupsubset': 'pull',
49 50 'getbundle': 'pull',
50 51 'stream_out': 'pull',
51 52 'listkeys': 'pull',
52 53 'unbundle': 'push',
53 54 'pushkey': 'push',
54 55 }
55 56
56 57 archivespecs = util.sortdict((
57 58 ('zip', ('application/zip', 'zip', '.zip', None)),
58 59 ('gz', ('application/x-gzip', 'tgz', '.tar.gz', None)),
59 60 ('bz2', ('application/x-bzip2', 'tbz2', '.tar.bz2', None)),
60 61 ))
61 62
62 63 def makebreadcrumb(url, prefix=''):
63 64 '''Return a 'URL breadcrumb' list
64 65
65 66 A 'URL breadcrumb' is a list of URL-name pairs,
66 67 corresponding to each of the path items on a URL.
67 68 This can be used to create path navigation entries.
68 69 '''
69 70 if url.endswith('/'):
70 71 url = url[:-1]
71 72 if prefix:
72 73 url = '/' + prefix + url
73 74 relpath = url
74 75 if relpath.startswith('/'):
75 76 relpath = relpath[1:]
76 77
77 78 breadcrumb = []
78 79 urlel = url
79 80 pathitems = [''] + relpath.split('/')
80 81 for pathel in reversed(pathitems):
81 82 if not pathel or not urlel:
82 83 break
83 84 breadcrumb.append({'url': urlel, 'name': pathel})
84 85 urlel = os.path.dirname(urlel)
85 86 return reversed(breadcrumb)
86 87
87 88 class requestcontext(object):
88 89 """Holds state/context for an individual request.
89 90
90 91 Servers can be multi-threaded. Holding state on the WSGI application
91 92 is prone to race conditions. Instances of this class exist to hold
92 93 mutable and race-free state for requests.
93 94 """
94 95 def __init__(self, app, repo):
95 96 self.repo = repo
96 97 self.reponame = app.reponame
97 98
98 99 self.archivespecs = archivespecs
99 100
100 101 self.maxchanges = self.configint('web', 'maxchanges', 10)
101 102 self.stripecount = self.configint('web', 'stripes', 1)
102 103 self.maxshortchanges = self.configint('web', 'maxshortchanges', 60)
103 104 self.maxfiles = self.configint('web', 'maxfiles', 10)
104 105 self.allowpull = self.configbool('web', 'allowpull', True)
105 106
106 107 # we use untrusted=False to prevent a repo owner from using
107 108 # web.templates in .hg/hgrc to get access to any file readable
108 109 # by the user running the CGI script
109 110 self.templatepath = self.config('web', 'templates', untrusted=False)
110 111
111 112 # This object is more expensive to build than simple config values.
112 113 # It is shared across requests. The app will replace the object
113 114 # if it is updated. Since this is a reference and nothing should
114 115 # modify the underlying object, it should be constant for the lifetime
115 116 # of the request.
116 117 self.websubtable = app.websubtable
117 118
119 self.csp, self.nonce = cspvalues(self.repo.ui)
120
118 121 # Trust the settings from the .hg/hgrc files by default.
119 122 def config(self, section, name, default=None, untrusted=True):
120 123 return self.repo.ui.config(section, name, default,
121 124 untrusted=untrusted)
122 125
123 126 def configbool(self, section, name, default=False, untrusted=True):
124 127 return self.repo.ui.configbool(section, name, default,
125 128 untrusted=untrusted)
126 129
127 130 def configint(self, section, name, default=None, untrusted=True):
128 131 return self.repo.ui.configint(section, name, default,
129 132 untrusted=untrusted)
130 133
131 134 def configlist(self, section, name, default=None, untrusted=True):
132 135 return self.repo.ui.configlist(section, name, default,
133 136 untrusted=untrusted)
134 137
135 138 def archivelist(self, nodeid):
136 139 allowed = self.configlist('web', 'allow_archive')
137 140 for typ, spec in self.archivespecs.iteritems():
138 141 if typ in allowed or self.configbool('web', 'allow%s' % typ):
139 142 yield {'type': typ, 'extension': spec[2], 'node': nodeid}
140 143
141 144 def templater(self, req):
142 145 # determine scheme, port and server name
143 146 # this is needed to create absolute urls
144 147
145 148 proto = req.env.get('wsgi.url_scheme')
146 149 if proto == 'https':
147 150 proto = 'https'
148 151 default_port = '443'
149 152 else:
150 153 proto = 'http'
151 154 default_port = '80'
152 155
153 156 port = req.env['SERVER_PORT']
154 157 port = port != default_port and (':' + port) or ''
155 158 urlbase = '%s://%s%s' % (proto, req.env['SERVER_NAME'], port)
156 159 logourl = self.config('web', 'logourl', 'https://mercurial-scm.org/')
157 160 logoimg = self.config('web', 'logoimg', 'hglogo.png')
158 161 staticurl = self.config('web', 'staticurl') or req.url + 'static/'
159 162 if not staticurl.endswith('/'):
160 163 staticurl += '/'
161 164
162 165 # some functions for the templater
163 166
164 167 def motd(**map):
165 168 yield self.config('web', 'motd', '')
166 169
167 170 # figure out which style to use
168 171
169 172 vars = {}
170 173 styles = (
171 174 req.form.get('style', [None])[0],
172 175 self.config('web', 'style'),
173 176 'paper',
174 177 )
175 178 style, mapfile = templater.stylemap(styles, self.templatepath)
176 179 if style == styles[0]:
177 180 vars['style'] = style
178 181
179 182 start = req.url[-1] == '?' and '&' or '?'
180 183 sessionvars = webutil.sessionvars(vars, start)
181 184
182 185 if not self.reponame:
183 186 self.reponame = (self.config('web', 'name')
184 187 or req.env.get('REPO_NAME')
185 188 or req.url.strip('/') or self.repo.root)
186 189
187 190 def websubfilter(text):
188 191 return templatefilters.websub(text, self.websubtable)
189 192
190 193 # create the templater
191 194
192 195 defaults = {
193 196 'url': req.url,
194 197 'logourl': logourl,
195 198 'logoimg': logoimg,
196 199 'staticurl': staticurl,
197 200 'urlbase': urlbase,
198 201 'repo': self.reponame,
199 202 'encoding': encoding.encoding,
200 203 'motd': motd,
201 204 'sessionvars': sessionvars,
202 205 'pathdef': makebreadcrumb(req.url),
203 206 'style': style,
207 'nonce': self.nonce,
204 208 }
205 209 tmpl = templater.templater.frommapfile(mapfile,
206 210 filters={'websub': websubfilter},
207 211 defaults=defaults)
208 212 return tmpl
209 213
210 214
211 215 class hgweb(object):
212 216 """HTTP server for individual repositories.
213 217
214 218 Instances of this class serve HTTP responses for a particular
215 219 repository.
216 220
217 221 Instances are typically used as WSGI applications.
218 222
219 223 Some servers are multi-threaded. On these servers, there may
220 224 be multiple active threads inside __call__.
221 225 """
222 226 def __init__(self, repo, name=None, baseui=None):
223 227 if isinstance(repo, str):
224 228 if baseui:
225 229 u = baseui.copy()
226 230 else:
227 231 u = uimod.ui.load()
228 232 r = hg.repository(u, repo)
229 233 else:
230 234 # we trust caller to give us a private copy
231 235 r = repo
232 236
233 237 r.ui.setconfig('ui', 'report_untrusted', 'off', 'hgweb')
234 238 r.baseui.setconfig('ui', 'report_untrusted', 'off', 'hgweb')
235 239 r.ui.setconfig('ui', 'nontty', 'true', 'hgweb')
236 240 r.baseui.setconfig('ui', 'nontty', 'true', 'hgweb')
237 241 # resolve file patterns relative to repo root
238 242 r.ui.setconfig('ui', 'forcecwd', r.root, 'hgweb')
239 243 r.baseui.setconfig('ui', 'forcecwd', r.root, 'hgweb')
240 244 # displaying bundling progress bar while serving feel wrong and may
241 245 # break some wsgi implementation.
242 246 r.ui.setconfig('progress', 'disable', 'true', 'hgweb')
243 247 r.baseui.setconfig('progress', 'disable', 'true', 'hgweb')
244 248 self._repos = [hg.cachedlocalrepo(self._webifyrepo(r))]
245 249 self._lastrepo = self._repos[0]
246 250 hook.redirect(True)
247 251 self.reponame = name
248 252
249 253 def _webifyrepo(self, repo):
250 254 repo = getwebview(repo)
251 255 self.websubtable = webutil.getwebsubs(repo)
252 256 return repo
253 257
254 258 @contextlib.contextmanager
255 259 def _obtainrepo(self):
256 260 """Obtain a repo unique to the caller.
257 261
258 262 Internally we maintain a stack of cachedlocalrepo instances
259 263 to be handed out. If one is available, we pop it and return it,
260 264 ensuring it is up to date in the process. If one is not available,
261 265 we clone the most recently used repo instance and return it.
262 266
263 267 It is currently possible for the stack to grow without bounds
264 268 if the server allows infinite threads. However, servers should
265 269 have a thread limit, thus establishing our limit.
266 270 """
267 271 if self._repos:
268 272 cached = self._repos.pop()
269 273 r, created = cached.fetch()
270 274 else:
271 275 cached = self._lastrepo.copy()
272 276 r, created = cached.fetch()
273 277 if created:
274 278 r = self._webifyrepo(r)
275 279
276 280 self._lastrepo = cached
277 281 self.mtime = cached.mtime
278 282 try:
279 283 yield r
280 284 finally:
281 285 self._repos.append(cached)
282 286
283 287 def run(self):
284 288 """Start a server from CGI environment.
285 289
286 290 Modern servers should be using WSGI and should avoid this
287 291 method, if possible.
288 292 """
289 293 if not encoding.environ.get('GATEWAY_INTERFACE',
290 294 '').startswith("CGI/1."):
291 295 raise RuntimeError("This function is only intended to be "
292 296 "called while running as a CGI script.")
293 297 wsgicgi.launch(self)
294 298
295 299 def __call__(self, env, respond):
296 300 """Run the WSGI application.
297 301
298 302 This may be called by multiple threads.
299 303 """
300 304 req = wsgirequest(env, respond)
301 305 return self.run_wsgi(req)
302 306
303 307 def run_wsgi(self, req):
304 308 """Internal method to run the WSGI application.
305 309
306 310 This is typically only called by Mercurial. External consumers
307 311 should be using instances of this class as the WSGI application.
308 312 """
309 313 with self._obtainrepo() as repo:
310 314 with profiling.maybeprofile(repo.ui):
311 315 for r in self._runwsgi(req, repo):
312 316 yield r
313 317
314 318 def _runwsgi(self, req, repo):
315 319 rctx = requestcontext(self, repo)
316 320
317 321 # This state is global across all threads.
318 322 encoding.encoding = rctx.config('web', 'encoding', encoding.encoding)
319 323 rctx.repo.ui.environ = req.env
320 324
325 if rctx.csp:
326 # hgwebdir may have added CSP header. Since we generate our own,
327 # replace it.
328 req.headers = [h for h in req.headers
329 if h[0] != 'Content-Security-Policy']
330 req.headers.append(('Content-Security-Policy', rctx.csp))
331
321 332 # work with CGI variables to create coherent structure
322 333 # use SCRIPT_NAME, PATH_INFO and QUERY_STRING as well as our REPO_NAME
323 334
324 335 req.url = req.env['SCRIPT_NAME']
325 336 if not req.url.endswith('/'):
326 337 req.url += '/'
327 338 if 'REPO_NAME' in req.env:
328 339 req.url += req.env['REPO_NAME'] + '/'
329 340
330 341 if 'PATH_INFO' in req.env:
331 342 parts = req.env['PATH_INFO'].strip('/').split('/')
332 343 repo_parts = req.env.get('REPO_NAME', '').split('/')
333 344 if parts[:len(repo_parts)] == repo_parts:
334 345 parts = parts[len(repo_parts):]
335 346 query = '/'.join(parts)
336 347 else:
337 348 query = req.env['QUERY_STRING'].partition('&')[0]
338 349 query = query.partition(';')[0]
339 350
340 351 # process this if it's a protocol request
341 352 # protocol bits don't need to create any URLs
342 353 # and the clients always use the old URL structure
343 354
344 355 cmd = req.form.get('cmd', [''])[0]
345 356 if protocol.iscmd(cmd):
346 357 try:
347 358 if query:
348 359 raise ErrorResponse(HTTP_NOT_FOUND)
349 360 if cmd in perms:
350 361 self.check_perm(rctx, req, perms[cmd])
351 362 return protocol.call(rctx.repo, req, cmd)
352 363 except ErrorResponse as inst:
353 364 # A client that sends unbundle without 100-continue will
354 365 # break if we respond early.
355 366 if (cmd == 'unbundle' and
356 367 (req.env.get('HTTP_EXPECT',
357 368 '').lower() != '100-continue') or
358 369 req.env.get('X-HgHttp2', '')):
359 370 req.drain()
360 371 else:
361 372 req.headers.append(('Connection', 'Close'))
362 373 req.respond(inst, protocol.HGTYPE,
363 374 body='0\n%s\n' % inst)
364 375 return ''
365 376
366 377 # translate user-visible url structure to internal structure
367 378
368 379 args = query.split('/', 2)
369 380 if 'cmd' not in req.form and args and args[0]:
370 381
371 382 cmd = args.pop(0)
372 383 style = cmd.rfind('-')
373 384 if style != -1:
374 385 req.form['style'] = [cmd[:style]]
375 386 cmd = cmd[style + 1:]
376 387
377 388 # avoid accepting e.g. style parameter as command
378 389 if util.safehasattr(webcommands, cmd):
379 390 req.form['cmd'] = [cmd]
380 391
381 392 if cmd == 'static':
382 393 req.form['file'] = ['/'.join(args)]
383 394 else:
384 395 if args and args[0]:
385 396 node = args.pop(0).replace('%2F', '/')
386 397 req.form['node'] = [node]
387 398 if args:
388 399 req.form['file'] = args
389 400
390 401 ua = req.env.get('HTTP_USER_AGENT', '')
391 402 if cmd == 'rev' and 'mercurial' in ua:
392 403 req.form['style'] = ['raw']
393 404
394 405 if cmd == 'archive':
395 406 fn = req.form['node'][0]
396 407 for type_, spec in rctx.archivespecs.iteritems():
397 408 ext = spec[2]
398 409 if fn.endswith(ext):
399 410 req.form['node'] = [fn[:-len(ext)]]
400 411 req.form['type'] = [type_]
401 412
402 413 # process the web interface request
403 414
404 415 try:
405 416 tmpl = rctx.templater(req)
406 417 ctype = tmpl('mimetype', encoding=encoding.encoding)
407 418 ctype = templater.stringify(ctype)
408 419
409 420 # check read permissions non-static content
410 421 if cmd != 'static':
411 422 self.check_perm(rctx, req, None)
412 423
413 424 if cmd == '':
414 425 req.form['cmd'] = [tmpl.cache['default']]
415 426 cmd = req.form['cmd'][0]
416 427
417 if rctx.configbool('web', 'cache', True):
428 # Don't enable caching if using a CSP nonce because then it wouldn't
429 # be a nonce.
430 if rctx.configbool('web', 'cache', True) and not rctx.nonce:
418 431 caching(self, req) # sets ETag header or raises NOT_MODIFIED
419 432 if cmd not in webcommands.__all__:
420 433 msg = 'no such method: %s' % cmd
421 434 raise ErrorResponse(HTTP_BAD_REQUEST, msg)
422 435 elif cmd == 'file' and 'raw' in req.form.get('style', []):
423 436 rctx.ctype = ctype
424 437 content = webcommands.rawfile(rctx, req, tmpl)
425 438 else:
426 439 content = getattr(webcommands, cmd)(rctx, req, tmpl)
427 440 req.respond(HTTP_OK, ctype)
428 441
429 442 return content
430 443
431 444 except (error.LookupError, error.RepoLookupError) as err:
432 445 req.respond(HTTP_NOT_FOUND, ctype)
433 446 msg = str(err)
434 447 if (util.safehasattr(err, 'name') and
435 448 not isinstance(err, error.ManifestLookupError)):
436 449 msg = 'revision not found: %s' % err.name
437 450 return tmpl('error', error=msg)
438 451 except (error.RepoError, error.RevlogError) as inst:
439 452 req.respond(HTTP_SERVER_ERROR, ctype)
440 453 return tmpl('error', error=str(inst))
441 454 except ErrorResponse as inst:
442 455 req.respond(inst, ctype)
443 456 if inst.code == HTTP_NOT_MODIFIED:
444 457 # Not allowed to return a body on a 304
445 458 return ['']
446 459 return tmpl('error', error=str(inst))
447 460
448 461 def check_perm(self, rctx, req, op):
449 462 for permhook in permhooks:
450 463 permhook(rctx, req, op)
451 464
452 465 def getwebview(repo):
453 466 """The 'web.view' config controls changeset filter to hgweb. Possible
454 467 values are ``served``, ``visible`` and ``all``. Default is ``served``.
455 468 The ``served`` filter only shows changesets that can be pulled from the
456 469 hgweb instance. The``visible`` filter includes secret changesets but
457 470 still excludes "hidden" one.
458 471
459 472 See the repoview module for details.
460 473
461 474 The option has been around undocumented since Mercurial 2.5, but no
462 475 user ever asked about it. So we better keep it undocumented for now."""
463 476 viewconfig = repo.ui.config('web', 'view', 'served',
464 477 untrusted=True)
465 478 if viewconfig == 'all':
466 479 return repo.unfiltered()
467 480 elif viewconfig in repoview.filtertable:
468 481 return repo.filtered(viewconfig)
469 482 else:
470 483 return repo.filtered('served')
@@ -1,522 +1,528 b''
1 1 # hgweb/hgwebdir_mod.py - Web interface for a directory of repositories.
2 2 #
3 3 # Copyright 21 May 2005 - (c) 2005 Jake Edge <jake@edge2.net>
4 4 # Copyright 2005, 2006 Matt Mackall <mpm@selenic.com>
5 5 #
6 6 # This software may be used and distributed according to the terms of the
7 7 # GNU General Public License version 2 or any later version.
8 8
9 9 from __future__ import absolute_import
10 10
11 11 import os
12 12 import re
13 13 import time
14 14
15 15 from ..i18n import _
16 16
17 17 from .common import (
18 18 ErrorResponse,
19 19 HTTP_NOT_FOUND,
20 20 HTTP_OK,
21 21 HTTP_SERVER_ERROR,
22 cspvalues,
22 23 get_contact,
23 24 get_mtime,
24 25 ismember,
25 26 paritygen,
26 27 staticfile,
27 28 )
28 29 from .request import wsgirequest
29 30
30 31 from .. import (
31 32 encoding,
32 33 error,
33 34 hg,
34 35 profiling,
35 36 scmutil,
36 37 templater,
37 38 ui as uimod,
38 39 util,
39 40 )
40 41
41 42 from . import (
42 43 hgweb_mod,
43 44 webutil,
44 45 wsgicgi,
45 46 )
46 47
47 48 def cleannames(items):
48 49 return [(util.pconvert(name).strip('/'), path) for name, path in items]
49 50
50 51 def findrepos(paths):
51 52 repos = []
52 53 for prefix, root in cleannames(paths):
53 54 roothead, roottail = os.path.split(root)
54 55 # "foo = /bar/*" or "foo = /bar/**" lets every repo /bar/N in or below
55 56 # /bar/ be served as as foo/N .
56 57 # '*' will not search inside dirs with .hg (except .hg/patches),
57 58 # '**' will search inside dirs with .hg (and thus also find subrepos).
58 59 try:
59 60 recurse = {'*': False, '**': True}[roottail]
60 61 except KeyError:
61 62 repos.append((prefix, root))
62 63 continue
63 64 roothead = os.path.normpath(os.path.abspath(roothead))
64 65 paths = scmutil.walkrepos(roothead, followsym=True, recurse=recurse)
65 66 repos.extend(urlrepos(prefix, roothead, paths))
66 67 return repos
67 68
68 69 def urlrepos(prefix, roothead, paths):
69 70 """yield url paths and filesystem paths from a list of repo paths
70 71
71 72 >>> conv = lambda seq: [(v, util.pconvert(p)) for v,p in seq]
72 73 >>> conv(urlrepos('hg', '/opt', ['/opt/r', '/opt/r/r', '/opt']))
73 74 [('hg/r', '/opt/r'), ('hg/r/r', '/opt/r/r'), ('hg', '/opt')]
74 75 >>> conv(urlrepos('', '/opt', ['/opt/r', '/opt/r/r', '/opt']))
75 76 [('r', '/opt/r'), ('r/r', '/opt/r/r'), ('', '/opt')]
76 77 """
77 78 for path in paths:
78 79 path = os.path.normpath(path)
79 80 yield (prefix + '/' +
80 81 util.pconvert(path[len(roothead):]).lstrip('/')).strip('/'), path
81 82
82 83 def geturlcgivars(baseurl, port):
83 84 """
84 85 Extract CGI variables from baseurl
85 86
86 87 >>> geturlcgivars("http://host.org/base", "80")
87 88 ('host.org', '80', '/base')
88 89 >>> geturlcgivars("http://host.org:8000/base", "80")
89 90 ('host.org', '8000', '/base')
90 91 >>> geturlcgivars('/base', 8000)
91 92 ('', '8000', '/base')
92 93 >>> geturlcgivars("base", '8000')
93 94 ('', '8000', '/base')
94 95 >>> geturlcgivars("http://host", '8000')
95 96 ('host', '8000', '/')
96 97 >>> geturlcgivars("http://host/", '8000')
97 98 ('host', '8000', '/')
98 99 """
99 100 u = util.url(baseurl)
100 101 name = u.host or ''
101 102 if u.port:
102 103 port = u.port
103 104 path = u.path or ""
104 105 if not path.startswith('/'):
105 106 path = '/' + path
106 107
107 108 return name, str(port), path
108 109
109 110 class hgwebdir(object):
110 111 """HTTP server for multiple repositories.
111 112
112 113 Given a configuration, different repositories will be served depending
113 114 on the request path.
114 115
115 116 Instances are typically used as WSGI applications.
116 117 """
117 118 def __init__(self, conf, baseui=None):
118 119 self.conf = conf
119 120 self.baseui = baseui
120 121 self.ui = None
121 122 self.lastrefresh = 0
122 123 self.motd = None
123 124 self.refresh()
124 125
125 126 def refresh(self):
126 127 refreshinterval = 20
127 128 if self.ui:
128 129 refreshinterval = self.ui.configint('web', 'refreshinterval',
129 130 refreshinterval)
130 131
131 132 # refreshinterval <= 0 means to always refresh.
132 133 if (refreshinterval > 0 and
133 134 self.lastrefresh + refreshinterval > time.time()):
134 135 return
135 136
136 137 if self.baseui:
137 138 u = self.baseui.copy()
138 139 else:
139 140 u = uimod.ui.load()
140 141 u.setconfig('ui', 'report_untrusted', 'off', 'hgwebdir')
141 142 u.setconfig('ui', 'nontty', 'true', 'hgwebdir')
142 143 # displaying bundling progress bar while serving feels wrong and may
143 144 # break some wsgi implementations.
144 145 u.setconfig('progress', 'disable', 'true', 'hgweb')
145 146
146 147 if not isinstance(self.conf, (dict, list, tuple)):
147 148 map = {'paths': 'hgweb-paths'}
148 149 if not os.path.exists(self.conf):
149 150 raise error.Abort(_('config file %s not found!') % self.conf)
150 151 u.readconfig(self.conf, remap=map, trust=True)
151 152 paths = []
152 153 for name, ignored in u.configitems('hgweb-paths'):
153 154 for path in u.configlist('hgweb-paths', name):
154 155 paths.append((name, path))
155 156 elif isinstance(self.conf, (list, tuple)):
156 157 paths = self.conf
157 158 elif isinstance(self.conf, dict):
158 159 paths = self.conf.items()
159 160
160 161 repos = findrepos(paths)
161 162 for prefix, root in u.configitems('collections'):
162 163 prefix = util.pconvert(prefix)
163 164 for path in scmutil.walkrepos(root, followsym=True):
164 165 repo = os.path.normpath(path)
165 166 name = util.pconvert(repo)
166 167 if name.startswith(prefix):
167 168 name = name[len(prefix):]
168 169 repos.append((name.lstrip('/'), repo))
169 170
170 171 self.repos = repos
171 172 self.ui = u
172 173 encoding.encoding = self.ui.config('web', 'encoding',
173 174 encoding.encoding)
174 175 self.style = self.ui.config('web', 'style', 'paper')
175 176 self.templatepath = self.ui.config('web', 'templates', None)
176 177 self.stripecount = self.ui.config('web', 'stripes', 1)
177 178 if self.stripecount:
178 179 self.stripecount = int(self.stripecount)
179 180 self._baseurl = self.ui.config('web', 'baseurl')
180 181 prefix = self.ui.config('web', 'prefix', '')
181 182 if prefix.startswith('/'):
182 183 prefix = prefix[1:]
183 184 if prefix.endswith('/'):
184 185 prefix = prefix[:-1]
185 186 self.prefix = prefix
186 187 self.lastrefresh = time.time()
187 188
188 189 def run(self):
189 190 if not encoding.environ.get('GATEWAY_INTERFACE',
190 191 '').startswith("CGI/1."):
191 192 raise RuntimeError("This function is only intended to be "
192 193 "called while running as a CGI script.")
193 194 wsgicgi.launch(self)
194 195
195 196 def __call__(self, env, respond):
196 197 req = wsgirequest(env, respond)
197 198 return self.run_wsgi(req)
198 199
199 200 def read_allowed(self, ui, req):
200 201 """Check allow_read and deny_read config options of a repo's ui object
201 202 to determine user permissions. By default, with neither option set (or
202 203 both empty), allow all users to read the repo. There are two ways a
203 204 user can be denied read access: (1) deny_read is not empty, and the
204 205 user is unauthenticated or deny_read contains user (or *), and (2)
205 206 allow_read is not empty and the user is not in allow_read. Return True
206 207 if user is allowed to read the repo, else return False."""
207 208
208 209 user = req.env.get('REMOTE_USER')
209 210
210 211 deny_read = ui.configlist('web', 'deny_read', untrusted=True)
211 212 if deny_read and (not user or ismember(ui, user, deny_read)):
212 213 return False
213 214
214 215 allow_read = ui.configlist('web', 'allow_read', untrusted=True)
215 216 # by default, allow reading if no allow_read option has been set
216 217 if (not allow_read) or ismember(ui, user, allow_read):
217 218 return True
218 219
219 220 return False
220 221
221 222 def run_wsgi(self, req):
222 223 with profiling.maybeprofile(self.ui):
223 224 for r in self._runwsgi(req):
224 225 yield r
225 226
226 227 def _runwsgi(self, req):
227 228 try:
228 229 self.refresh()
229 230
231 csp, nonce = cspvalues(self.ui)
232 if csp:
233 req.headers.append(('Content-Security-Policy', csp))
234
230 235 virtual = req.env.get("PATH_INFO", "").strip('/')
231 tmpl = self.templater(req)
236 tmpl = self.templater(req, nonce)
232 237 ctype = tmpl('mimetype', encoding=encoding.encoding)
233 238 ctype = templater.stringify(ctype)
234 239
235 240 # a static file
236 241 if virtual.startswith('static/') or 'static' in req.form:
237 242 if virtual.startswith('static/'):
238 243 fname = virtual[7:]
239 244 else:
240 245 fname = req.form['static'][0]
241 246 static = self.ui.config("web", "static", None,
242 247 untrusted=False)
243 248 if not static:
244 249 tp = self.templatepath or templater.templatepaths()
245 250 if isinstance(tp, str):
246 251 tp = [tp]
247 252 static = [os.path.join(p, 'static') for p in tp]
248 253 staticfile(static, fname, req)
249 254 return []
250 255
251 256 # top-level index
252 257 elif not virtual:
253 258 req.respond(HTTP_OK, ctype)
254 259 return self.makeindex(req, tmpl)
255 260
256 261 # nested indexes and hgwebs
257 262
258 263 repos = dict(self.repos)
259 264 virtualrepo = virtual
260 265 while virtualrepo:
261 266 real = repos.get(virtualrepo)
262 267 if real:
263 268 req.env['REPO_NAME'] = virtualrepo
264 269 try:
265 270 # ensure caller gets private copy of ui
266 271 repo = hg.repository(self.ui.copy(), real)
267 272 return hgweb_mod.hgweb(repo).run_wsgi(req)
268 273 except IOError as inst:
269 274 msg = inst.strerror
270 275 raise ErrorResponse(HTTP_SERVER_ERROR, msg)
271 276 except error.RepoError as inst:
272 277 raise ErrorResponse(HTTP_SERVER_ERROR, str(inst))
273 278
274 279 up = virtualrepo.rfind('/')
275 280 if up < 0:
276 281 break
277 282 virtualrepo = virtualrepo[:up]
278 283
279 284 # browse subdirectories
280 285 subdir = virtual + '/'
281 286 if [r for r in repos if r.startswith(subdir)]:
282 287 req.respond(HTTP_OK, ctype)
283 288 return self.makeindex(req, tmpl, subdir)
284 289
285 290 # prefixes not found
286 291 req.respond(HTTP_NOT_FOUND, ctype)
287 292 return tmpl("notfound", repo=virtual)
288 293
289 294 except ErrorResponse as err:
290 295 req.respond(err, ctype)
291 296 return tmpl('error', error=err.message or '')
292 297 finally:
293 298 tmpl = None
294 299
295 300 def makeindex(self, req, tmpl, subdir=""):
296 301
297 302 def archivelist(ui, nodeid, url):
298 303 allowed = ui.configlist("web", "allow_archive", untrusted=True)
299 304 archives = []
300 305 for typ, spec in hgweb_mod.archivespecs.iteritems():
301 306 if typ in allowed or ui.configbool("web", "allow" + typ,
302 307 untrusted=True):
303 308 archives.append({"type" : typ, "extension": spec[2],
304 309 "node": nodeid, "url": url})
305 310 return archives
306 311
307 312 def rawentries(subdir="", **map):
308 313
309 314 descend = self.ui.configbool('web', 'descend', True)
310 315 collapse = self.ui.configbool('web', 'collapse', False)
311 316 seenrepos = set()
312 317 seendirs = set()
313 318 for name, path in self.repos:
314 319
315 320 if not name.startswith(subdir):
316 321 continue
317 322 name = name[len(subdir):]
318 323 directory = False
319 324
320 325 if '/' in name:
321 326 if not descend:
322 327 continue
323 328
324 329 nameparts = name.split('/')
325 330 rootname = nameparts[0]
326 331
327 332 if not collapse:
328 333 pass
329 334 elif rootname in seendirs:
330 335 continue
331 336 elif rootname in seenrepos:
332 337 pass
333 338 else:
334 339 directory = True
335 340 name = rootname
336 341
337 342 # redefine the path to refer to the directory
338 343 discarded = '/'.join(nameparts[1:])
339 344
340 345 # remove name parts plus accompanying slash
341 346 path = path[:-len(discarded) - 1]
342 347
343 348 try:
344 349 r = hg.repository(self.ui, path)
345 350 directory = False
346 351 except (IOError, error.RepoError):
347 352 pass
348 353
349 354 parts = [name]
350 355 if 'PATH_INFO' in req.env:
351 356 parts.insert(0, req.env['PATH_INFO'].rstrip('/'))
352 357 if req.env['SCRIPT_NAME']:
353 358 parts.insert(0, req.env['SCRIPT_NAME'])
354 359 url = re.sub(r'/+', '/', '/'.join(parts) + '/')
355 360
356 361 # show either a directory entry or a repository
357 362 if directory:
358 363 # get the directory's time information
359 364 try:
360 365 d = (get_mtime(path), util.makedate()[1])
361 366 except OSError:
362 367 continue
363 368
364 369 # add '/' to the name to make it obvious that
365 370 # the entry is a directory, not a regular repository
366 371 row = {'contact': "",
367 372 'contact_sort': "",
368 373 'name': name + '/',
369 374 'name_sort': name,
370 375 'url': url,
371 376 'description': "",
372 377 'description_sort': "",
373 378 'lastchange': d,
374 379 'lastchange_sort': d[1]-d[0],
375 380 'archives': [],
376 381 'isdirectory': True,
377 382 'labels': [],
378 383 }
379 384
380 385 seendirs.add(name)
381 386 yield row
382 387 continue
383 388
384 389 u = self.ui.copy()
385 390 try:
386 391 u.readconfig(os.path.join(path, '.hg', 'hgrc'))
387 392 except Exception as e:
388 393 u.warn(_('error reading %s/.hg/hgrc: %s\n') % (path, e))
389 394 continue
390 395 def get(section, name, default=None):
391 396 return u.config(section, name, default, untrusted=True)
392 397
393 398 if u.configbool("web", "hidden", untrusted=True):
394 399 continue
395 400
396 401 if not self.read_allowed(u, req):
397 402 continue
398 403
399 404 # update time with local timezone
400 405 try:
401 406 r = hg.repository(self.ui, path)
402 407 except IOError:
403 408 u.warn(_('error accessing repository at %s\n') % path)
404 409 continue
405 410 except error.RepoError:
406 411 u.warn(_('error accessing repository at %s\n') % path)
407 412 continue
408 413 try:
409 414 d = (get_mtime(r.spath), util.makedate()[1])
410 415 except OSError:
411 416 continue
412 417
413 418 contact = get_contact(get)
414 419 description = get("web", "description", "")
415 420 seenrepos.add(name)
416 421 name = get("web", "name", name)
417 422 row = {'contact': contact or "unknown",
418 423 'contact_sort': contact.upper() or "unknown",
419 424 'name': name,
420 425 'name_sort': name,
421 426 'url': url,
422 427 'description': description or "unknown",
423 428 'description_sort': description.upper() or "unknown",
424 429 'lastchange': d,
425 430 'lastchange_sort': d[1]-d[0],
426 431 'archives': archivelist(u, "tip", url),
427 432 'isdirectory': None,
428 433 'labels': u.configlist('web', 'labels', untrusted=True),
429 434 }
430 435
431 436 yield row
432 437
433 438 sortdefault = None, False
434 439 def entries(sortcolumn="", descending=False, subdir="", **map):
435 440 rows = rawentries(subdir=subdir, **map)
436 441
437 442 if sortcolumn and sortdefault != (sortcolumn, descending):
438 443 sortkey = '%s_sort' % sortcolumn
439 444 rows = sorted(rows, key=lambda x: x[sortkey],
440 445 reverse=descending)
441 446 for row, parity in zip(rows, paritygen(self.stripecount)):
442 447 row['parity'] = parity
443 448 yield row
444 449
445 450 self.refresh()
446 451 sortable = ["name", "description", "contact", "lastchange"]
447 452 sortcolumn, descending = sortdefault
448 453 if 'sort' in req.form:
449 454 sortcolumn = req.form['sort'][0]
450 455 descending = sortcolumn.startswith('-')
451 456 if descending:
452 457 sortcolumn = sortcolumn[1:]
453 458 if sortcolumn not in sortable:
454 459 sortcolumn = ""
455 460
456 461 sort = [("sort_%s" % column,
457 462 "%s%s" % ((not descending and column == sortcolumn)
458 463 and "-" or "", column))
459 464 for column in sortable]
460 465
461 466 self.refresh()
462 467 self.updatereqenv(req.env)
463 468
464 469 return tmpl("index", entries=entries, subdir=subdir,
465 470 pathdef=hgweb_mod.makebreadcrumb('/' + subdir, self.prefix),
466 471 sortcolumn=sortcolumn, descending=descending,
467 472 **dict(sort))
468 473
469 def templater(self, req):
474 def templater(self, req, nonce):
470 475
471 476 def motd(**map):
472 477 if self.motd is not None:
473 478 yield self.motd
474 479 else:
475 480 yield config('web', 'motd', '')
476 481
477 482 def config(section, name, default=None, untrusted=True):
478 483 return self.ui.config(section, name, default, untrusted)
479 484
480 485 self.updatereqenv(req.env)
481 486
482 487 url = req.env.get('SCRIPT_NAME', '')
483 488 if not url.endswith('/'):
484 489 url += '/'
485 490
486 491 vars = {}
487 492 styles = (
488 493 req.form.get('style', [None])[0],
489 494 config('web', 'style'),
490 495 'paper'
491 496 )
492 497 style, mapfile = templater.stylemap(styles, self.templatepath)
493 498 if style == styles[0]:
494 499 vars['style'] = style
495 500
496 501 start = url[-1] == '?' and '&' or '?'
497 502 sessionvars = webutil.sessionvars(vars, start)
498 503 logourl = config('web', 'logourl', 'https://mercurial-scm.org/')
499 504 logoimg = config('web', 'logoimg', 'hglogo.png')
500 505 staticurl = config('web', 'staticurl') or url + 'static/'
501 506 if not staticurl.endswith('/'):
502 507 staticurl += '/'
503 508
504 509 defaults = {
505 510 "encoding": encoding.encoding,
506 511 "motd": motd,
507 512 "url": url,
508 513 "logourl": logourl,
509 514 "logoimg": logoimg,
510 515 "staticurl": staticurl,
511 516 "sessionvars": sessionvars,
512 517 "style": style,
518 "nonce": nonce,
513 519 }
514 520 tmpl = templater.templater.frommapfile(mapfile, defaults=defaults)
515 521 return tmpl
516 522
517 523 def updatereqenv(self, env):
518 524 if self._baseurl is not None:
519 525 name, port, path = geturlcgivars(self._baseurl, env['SERVER_PORT'])
520 526 env['SERVER_NAME'] = name
521 527 env['SERVER_PORT'] = port
522 528 env['SCRIPT_NAME'] = path
@@ -1,122 +1,122 b''
1 1 {header}
2 2 <title>{repo|escape}: Graph</title>
3 3 <link rel="alternate" type="application/atom+xml"
4 4 href="{url|urlescape}atom-log" title="Atom feed for {repo|escape}"/>
5 5 <link rel="alternate" type="application/rss+xml"
6 6 href="{url|urlescape}rss-log" title="RSS feed for {repo|escape}"/>
7 7 <!--[if IE]><script type="text/javascript" src="{staticurl|urlescape}excanvas.js"></script><![endif]-->
8 8 </head>
9 9 <body>
10 10
11 11 <div class="page_header">
12 12 <a href="{logourl}" title="Mercurial" style="float: right;">Mercurial</a>
13 13 <a href="/">Mercurial</a> {pathdef%breadcrumb} / graph
14 14 </div>
15 15
16 16 <form action="{url|urlescape}log">
17 17 {sessionvars%hiddenformentry}
18 18 <div class="search">
19 19 <input type="text" name="rev" />
20 20 </div>
21 21 </form>
22 22 <div class="page_nav">
23 23 <a href="{url|urlescape}summary{sessionvars%urlparameter}">summary</a> |
24 24 <a href="{url|urlescape}shortlog/{symrev}{sessionvars%urlparameter}">shortlog</a> |
25 25 <a href="{url|urlescape}log/{symrev}{sessionvars%urlparameter}">changelog</a> |
26 26 graph |
27 27 <a href="{url|urlescape}tags{sessionvars%urlparameter}">tags</a> |
28 28 <a href="{url|urlescape}bookmarks{sessionvars%urlparameter}">bookmarks</a> |
29 29 <a href="{url|urlescape}branches{sessionvars%urlparameter}">branches</a> |
30 30 <a href="{url|urlescape}file/{symrev}{sessionvars%urlparameter}">files</a> |
31 31 <a href="{url|urlescape}help{sessionvars%urlparameter}">help</a>
32 32 <br/>
33 33 <a href="{url|urlescape}graph/{symrev}{lessvars%urlparameter}">less</a>
34 34 <a href="{url|urlescape}graph/{symrev}{morevars%urlparameter}">more</a>
35 35 | {changenav%navgraph}<br/>
36 36 </div>
37 37
38 38 <div class="title">&nbsp;</div>
39 39
40 40 <noscript>The revision graph only works with JavaScript-enabled browsers.</noscript>
41 41
42 42 <div id="wrapper">
43 43 <ul id="nodebgs"></ul>
44 44 <canvas id="graph" width="{canvaswidth}" height="{canvasheight}"></canvas>
45 45 <ul id="graphnodes"></ul>
46 46 </div>
47 47
48 <script>
48 <script{if(nonce, ' nonce="{nonce}"')}>
49 49 <!-- hide script content
50 50
51 51 var data = {jsdata|json};
52 52 var graph = new Graph();
53 53 graph.scale({bg_height});
54 54
55 55 graph.vertex = function(x, y, color, parity, cur) \{
56 56
57 57 this.ctx.beginPath();
58 58 color = this.setColor(color, 0.25, 0.75);
59 59 this.ctx.arc(x, y, radius, 0, Math.PI * 2, true);
60 60 this.ctx.fill();
61 61
62 62 var bg = '<li class="bg parity' + parity + '"></li>';
63 63 var left = (this.bg_height - this.box_size) + (this.columns + 1) * this.box_size;
64 64 var nstyle = 'padding-left: ' + left + 'px;';
65 65
66 66 var tagspan = '';
67 67 if (cur[7].length || cur[8].length || (cur[6][0] != 'default' || cur[6][1])) \{
68 68 tagspan = '<span class="logtags">';
69 69 if (cur[6][1]) \{
70 70 tagspan += '<span class="branchtag" title="' + cur[6][0] + '">';
71 71 tagspan += cur[6][0] + '</span> ';
72 72 } else if (!cur[6][1] && cur[6][0] != 'default') \{
73 73 tagspan += '<span class="inbranchtag" title="' + cur[6][0] + '">';
74 74 tagspan += cur[6][0] + '</span> ';
75 75 }
76 76 if (cur[7].length) \{
77 77 for (var t in cur[7]) \{
78 78 var tag = cur[7][t];
79 79 tagspan += '<span class="tagtag">' + tag + '</span> ';
80 80 }
81 81 }
82 82 if (cur[8].length) \{
83 83 for (var t in cur[8]) \{
84 84 var bookmark = cur[8][t];
85 85 tagspan += '<span class="bookmarktag">' + bookmark + '</span> ';
86 86 }
87 87 }
88 88 tagspan += '</span>';
89 89 }
90 90
91 91 var item = '<li style="' + nstyle + '"><span class="desc">';
92 92 item += '<a class="list" href="{url|urlescape}rev/' + cur[0] + '{sessionvars%urlparameter}" title="' + cur[0] + '"><b>' + cur[3] + '</b></a>';
93 93 item += '</span> ' + tagspan + '';
94 94 item += '<span class="info">' + cur[5] + ', by ' + cur[4] + '</span></li>';
95 95
96 96 return [bg, item];
97 97
98 98 }
99 99
100 100 graph.render(data);
101 101
102 102 // stop hiding script -->
103 103 </script>
104 104
105 105 <div class="page_nav">
106 106 <a href="{url|urlescape}graph/{symrev}{lessvars%urlparameter}">less</a>
107 107 <a href="{url|urlescape}graph/{symrev}{morevars%urlparameter}">more</a>
108 108 | {changenav%navgraph}
109 109 </div>
110 110
111 <script type="text/javascript">
111 <script type="text/javascript"{if(nonce, ' nonce="{nonce}"')}>
112 112 ajaxScrollInit(
113 113 '{url|urlescape}graph/{rev}?revcount=%next%&style={style}',
114 114 {revcount}+60,
115 115 function (htmlText, previousVal) \{ return previousVal + 60; },
116 116 '#wrapper',
117 117 '<div class="%class%" style="text-align: center;">%text%</div>',
118 118 'graph'
119 119 );
120 120 </script>
121 121
122 122 {footer}
@@ -1,58 +1,58 b''
1 1 {header}
2 2 <title>{repo|escape}: Shortlog</title>
3 3 <link rel="alternate" type="application/atom+xml"
4 4 href="{url|urlescape}atom-log" title="Atom feed for {repo|escape}"/>
5 5 <link rel="alternate" type="application/rss+xml"
6 6 href="{url|urlescape}rss-log" title="RSS feed for {repo|escape}"/>
7 7 </head>
8 8 <body>
9 9
10 10 <div class="page_header">
11 11 <a href="{logourl}" title="Mercurial" style="float: right;">Mercurial</a>
12 12 <a href="/">Mercurial</a> {pathdef%breadcrumb} / shortlog
13 13 </div>
14 14
15 15 <form action="{url|urlescape}log">
16 16 {sessionvars%hiddenformentry}
17 17 <div class="search">
18 18 <input type="text" name="rev" />
19 19 </div>
20 20 </form>
21 21 <div class="page_nav">
22 22 <a href="{url|urlescape}summary{sessionvars%urlparameter}">summary</a> |
23 23 shortlog |
24 24 <a href="{url|urlescape}log/{symrev}{sessionvars%urlparameter}">changelog</a> |
25 25 <a href="{url|urlescape}graph/{symrev}{sessionvars%urlparameter}">graph</a> |
26 26 <a href="{url|urlescape}tags{sessionvars%urlparameter}">tags</a> |
27 27 <a href="{url|urlescape}bookmarks{sessionvars%urlparameter}">bookmarks</a> |
28 28 <a href="{url|urlescape}branches{sessionvars%urlparameter}">branches</a> |
29 29 <a href="{url|urlescape}file/{symrev}{sessionvars%urlparameter}">files</a>{archives%archiveentry} |
30 30 <a href="{url|urlescape}help{sessionvars%urlparameter}">help</a>
31 31 <br/>{changenav%navshort}<br/>
32 32 </div>
33 33
34 34 <div class="title">&nbsp;</div>
35 35 <table class="shortlogtable" cellspacing="0">
36 36 {entries%shortlogentry}
37 37 </table>
38 38
39 39 <div class="page_nav">
40 40 {changenav%navshort}
41 41 </div>
42 42
43 <script type="text/javascript">
43 <script type="text/javascript"{if(nonce, ' nonce="{nonce}"')}>
44 44 ajaxScrollInit(
45 45 '{url|urlescape}shortlog/%next%{sessionvars%urlparameter}',
46 46 '{nextentry%"{node}"}', <!-- NEXTHASH
47 47 function (htmlText, previousVal) \{
48 48 var m = htmlText.match(/'(\w+)', <!-- NEXTHASH/);
49 49 return m ? m[1] : null;
50 50 },
51 51 '.shortlogtable > tbody:nth-of-type(1)',
52 52 '<tr class="%class%">\
53 53 <td colspan="4" style="text-align: center;">%text%</td>\
54 54 </tr>'
55 55 );
56 56 </script>
57 57
58 58 {footer}
@@ -1,118 +1,118 b''
1 1 {header}
2 2 <title>{repo|escape}: graph</title>
3 3 <link rel="alternate" type="application/atom+xml" href="{url|urlescape}atom-log" title="Atom feed for {repo|escape}"/>
4 4 <link rel="alternate" type="application/rss+xml" href="{url|urlescape}rss-log" title="RSS feed for {repo|escape}"/>
5 5 <!--[if IE]><script type="text/javascript" src="{staticurl|urlescape}excanvas.js"></script><![endif]-->
6 6 </head>
7 7
8 8 <body>
9 9 <div id="container">
10 10 <div class="page-header">
11 11 <h1 class="breadcrumb"><a href="/">Mercurial</a> {pathdef%breadcrumb} / graph</h1>
12 12
13 13 <form action="{url|urlescape}log">
14 14 {sessionvars%hiddenformentry}
15 15 <dl class="search">
16 16 <dt><label>Search: </label></dt>
17 17 <dd><input type="text" name="rev" /></dd>
18 18 </dl>
19 19 </form>
20 20
21 21 <ul class="page-nav">
22 22 <li><a href="{url|urlescape}summary{sessionvars%urlparameter}">summary</a></li>
23 23 <li><a href="{url|urlescape}shortlog{sessionvars%urlparameter}">shortlog</a></li>
24 24 <li><a href="{url|urlescape}changelog{sessionvars%urlparameter}">changelog</a></li>
25 25 <li class="current">graph</li>
26 26 <li><a href="{url|urlescape}tags{sessionvars%urlparameter}">tags</a></li>
27 27 <li><a href="{url|urlescape}bookmarks{sessionvars%urlparameter}">bookmarks</a></li>
28 28 <li><a href="{url|urlescape}branches{sessionvars%urlparameter}">branches</a></li>
29 29 <li><a href="{url|urlescape}file/{symrev}{sessionvars%urlparameter}">files</a></li>
30 30 <li><a href="{url|urlescape}help{sessionvars%urlparameter}">help</a></li>
31 31 </ul>
32 32 </div>
33 33
34 34 <h2 class="no-link no-border">graph</h2>
35 35
36 36 <div id="noscript">The revision graph only works with JavaScript-enabled browsers.</div>
37 37 <div id="wrapper">
38 38 <ul id="nodebgs"></ul>
39 39 <canvas id="graph" width="{canvaswidth}" height="{canvasheight}"></canvas>
40 40 <ul id="graphnodes"></ul>
41 41 </div>
42 42
43 <script>
43 <script{if(nonce, ' nonce="{nonce}"')}>
44 44 <!-- hide script content
45 45
46 46 document.getElementById('noscript').style.display = 'none';
47 47
48 48 var data = {jsdata|json};
49 49 var graph = new Graph();
50 50 graph.scale({bg_height});
51 51
52 52 graph.vertex = function(x, y, color, parity, cur) \{
53 53
54 54 this.ctx.beginPath();
55 55 color = this.setColor(color, 0.25, 0.75);
56 56 this.ctx.arc(x, y, radius, 0, Math.PI * 2, true);
57 57 this.ctx.fill();
58 58
59 59 var bg = '<li class="bg parity' + parity + '"></li>';
60 60 var left = (this.bg_height - this.box_size) + (this.columns + 1) * this.box_size;
61 61 var nstyle = 'padding-left: ' + left + 'px;';
62 62
63 63 var tagspan = '';
64 64 if (cur[7].length || cur[8].length || (cur[6][0] != 'default' || cur[6][1])) \{
65 65 tagspan = '<span class="logtags">';
66 66 if (cur[6][1]) \{
67 67 tagspan += '<span class="branchtag" title="' + cur[6][0] + '">';
68 68 tagspan += cur[6][0] + '</span> ';
69 69 } else if (!cur[6][1] && cur[6][0] != 'default') \{
70 70 tagspan += '<span class="inbranchtag" title="' + cur[6][0] + '">';
71 71 tagspan += cur[6][0] + '</span> ';
72 72 }
73 73 if (cur[7].length) \{
74 74 for (var t in cur[7]) \{
75 75 var tag = cur[7][t];
76 76 tagspan += '<span class="tagtag">' + tag + '</span> ';
77 77 }
78 78 }
79 79 if (cur[8].length) \{
80 80 for (var t in cur[8]) \{
81 81 var bookmark = cur[8][t];
82 82 tagspan += '<span class="bookmarktag">' + bookmark + '</span> ';
83 83 }
84 84 }
85 85 tagspan += '</span>';
86 86 }
87 87
88 88 var item = '<li style="' + nstyle + '"><span class="desc">';
89 89 item += '<a href="{url|urlescape}rev/' + cur[0] + '{sessionvars%urlparameter}" title="' + cur[0] + '">' + cur[3] + '</a>';
90 90 item += '</span>' + tagspan + '<span class="info">' + cur[5] + ', by ' + cur[4] + '</span></li>';
91 91
92 92 return [bg, item];
93 93
94 94 }
95 95
96 96 graph.render(data);
97 97
98 98 // stop hiding script -->
99 99 </script>
100 100
101 101 <div class="page-path">
102 102 <a href="{url|urlescape}graph/{symrev}{lessvars%urlparameter}">less</a>
103 103 <a href="{url|urlescape}graph/{symrev}{morevars%urlparameter}">more</a>
104 104 | {changenav%navgraph}
105 105 </div>
106 106
107 <script type="text/javascript">
107 <script type="text/javascript"{if(nonce, ' nonce="{nonce}"')}>
108 108 ajaxScrollInit(
109 109 '{url|urlescape}graph/{rev}?revcount=%next%&style={style}',
110 110 {revcount}+60,
111 111 function (htmlText, previousVal) \{ return previousVal + 60; },
112 112 '#wrapper',
113 113 '<div class="%class%" style="text-align: center;">%text%</div>',
114 114 'graph'
115 115 );
116 116 </script>
117 117
118 118 {footer}
@@ -1,59 +1,59 b''
1 1 {header}
2 2 <title>{repo|escape}: shortlog</title>
3 3 <link rel="alternate" type="application/atom+xml" href="{url|urlescape}atom-log" title="Atom feed for {repo|escape}"/>
4 4 <link rel="alternate" type="application/rss+xml" href="{url|urlescape}rss-log" title="RSS feed for {repo|escape}"/>
5 5 </head>
6 6
7 7 <body>
8 8 <div id="container">
9 9 <div class="page-header">
10 10 <h1 class="breadcrumb"><a href="/">Mercurial</a> {pathdef%breadcrumb} / shortlog</h1>
11 11
12 12 <form action="{url|urlescape}log">
13 13 {sessionvars%hiddenformentry}
14 14 <dl class="search">
15 15 <dt><label>Search: </label></dt>
16 16 <dd><input type="text" name="rev" /></dd>
17 17 </dl>
18 18 </form>
19 19
20 20 <ul class="page-nav">
21 21 <li><a href="{url|urlescape}summary{sessionvars%urlparameter}">summary</a></li>
22 22 <li class="current">shortlog</li>
23 23 <li><a href="{url|urlescape}log{sessionvars%urlparameter}">changelog</a></li>
24 24 <li><a href="{url|urlescape}graph/{symrev}{sessionvars%urlparameter}">graph</a></li>
25 25 <li><a href="{url|urlescape}tags{sessionvars%urlparameter}">tags</a></li>
26 26 <li><a href="{url|urlescape}bookmarks{sessionvars%urlparameter}">bookmarks</a></li>
27 27 <li><a href="{url|urlescape}branches{sessionvars%urlparameter}">branches</a></li>
28 28 <li><a href="{url|urlescape}file/{symrev}{sessionvars%urlparameter}">files</a></li>
29 29 {archives%archiveentry}
30 30 <li><a href="{url|urlescape}help{sessionvars%urlparameter}">help</a></li>
31 31 </ul>
32 32 </div>
33 33
34 34 <h2 class="no-link no-border">shortlog</h2>
35 35
36 36 <table class="shortlogtable">
37 37 {entries%shortlogentry}
38 38 </table>
39 39
40 40 <div class="page-path">
41 41 {changenav%navshort}
42 42 </div>
43 43
44 <script type="text/javascript">
44 <script type="text/javascript"{if(nonce, ' nonce="{nonce}"')}>
45 45 ajaxScrollInit(
46 46 '{url|urlescape}shortlog/%next%{sessionvars%urlparameter}',
47 47 '{nextentry%"{node}"}', <!-- NEXTHASH
48 48 function (htmlText, previousVal) \{
49 49 var m = htmlText.match(/'(\w+)', <!-- NEXTHASH/);
50 50 return m ? m[1] : null;
51 51 },
52 52 '.shortlogtable > tbody:nth-of-type(1)',
53 53 '<tr class="%class%">\
54 54 <td colspan="4" style="text-align: center;">%text%</td>\
55 55 </tr>'
56 56 );
57 57 </script>
58 58
59 59 {footer}
@@ -1,138 +1,138 b''
1 1 {header}
2 2 <title>{repo|escape}: revision graph</title>
3 3 <link rel="alternate" type="application/atom+xml"
4 4 href="{url|urlescape}atom-log" title="Atom feed for {repo|escape}: log" />
5 5 <link rel="alternate" type="application/rss+xml"
6 6 href="{url|urlescape}rss-log" title="RSS feed for {repo|escape}: log" />
7 7 <!--[if IE]><script type="text/javascript" src="{staticurl|urlescape}excanvas.js"></script><![endif]-->
8 8 </head>
9 9 <body>
10 10
11 11 <div class="container">
12 12 <div class="menu">
13 13 <div class="logo">
14 14 <a href="{logourl}">
15 15 <img src="{staticurl|urlescape}{logoimg}" alt="mercurial" /></a>
16 16 </div>
17 17 <ul>
18 18 <li><a href="{url|urlescape}shortlog/{symrev}{sessionvars%urlparameter}">log</a></li>
19 19 <li class="active">graph</li>
20 20 <li><a href="{url|urlescape}tags{sessionvars%urlparameter}">tags</a></li>
21 21 <li><a href="{url|urlescape}bookmarks{sessionvars%urlparameter}">bookmarks</a></li>
22 22 <li><a href="{url|urlescape}branches{sessionvars%urlparameter}">branches</a></li>
23 23 </ul>
24 24 <ul>
25 25 <li><a href="{url|urlescape}rev/{symrev}{sessionvars%urlparameter}">changeset</a></li>
26 26 <li><a href="{url|urlescape}file/{symrev}{path|urlescape}{sessionvars%urlparameter}">browse</a></li>
27 27 </ul>
28 28 <ul>
29 29 <li><a href="{url|urlescape}help{sessionvars%urlparameter}">help</a></li>
30 30 </ul>
31 31 <div class="atom-logo">
32 32 <a href="{url|urlescape}atom-log" title="subscribe to atom feed">
33 33 <img class="atom-logo" src="{staticurl|urlescape}feed-icon-14x14.png" alt="atom feed" />
34 34 </a>
35 35 </div>
36 36 </div>
37 37
38 38 <div class="main">
39 39 <h2 class="breadcrumb"><a href="/">Mercurial</a> {pathdef%breadcrumb}</h2>
40 40 <h3>graph</h3>
41 41
42 42 <form class="search" action="{url|urlescape}log">
43 43 {sessionvars%hiddenformentry}
44 44 <p><input name="rev" id="search1" type="text" size="30" /></p>
45 45 <div id="hint">{searchhint}</div>
46 46 </form>
47 47
48 48 <div class="navigate">
49 49 <a href="{url|urlescape}graph/{symrev}{lessvars%urlparameter}">less</a>
50 50 <a href="{url|urlescape}graph/{symrev}{morevars%urlparameter}">more</a>
51 51 | rev {rev}: {changenav%navgraph}
52 52 </div>
53 53
54 54 <noscript><p>The revision graph only works with JavaScript-enabled browsers.</p></noscript>
55 55
56 56 <div id="wrapper">
57 57 <ul id="nodebgs" class="stripes2"></ul>
58 58 <canvas id="graph" width="{canvaswidth}" height="{canvasheight}"></canvas>
59 59 <ul id="graphnodes"></ul>
60 60 </div>
61 61
62 <script type="text/javascript">
62 <script type="text/javascript"{if(nonce, ' nonce="{nonce}"')}>
63 63 <!-- hide script content
64 64
65 65 var data = {jsdata|json};
66 66 var graph = new Graph();
67 67 graph.scale({bg_height});
68 68
69 69 graph.vertex = function(x, y, color, parity, cur) \{
70 70
71 71 this.ctx.beginPath();
72 72 color = this.setColor(color, 0.25, 0.75);
73 73 this.ctx.arc(x, y, radius, 0, Math.PI * 2, true);
74 74 this.ctx.fill();
75 75
76 76 var bg = '<li class="bg"></li>';
77 77 var left = (this.bg_height - this.box_size) + (this.columns + 1) * this.box_size;
78 78 var nstyle = 'padding-left: ' + left + 'px;';
79 79
80 80 var tagspan = '';
81 81 if (cur[7].length || cur[8].length || (cur[6][0] != 'default' || cur[6][1])) \{
82 82 tagspan = '<span class="logtags">';
83 83 if (cur[6][1]) \{
84 84 tagspan += '<span class="branchhead" title="' + cur[6][0] + '">';
85 85 tagspan += cur[6][0] + '</span> ';
86 86 } else if (!cur[6][1] && cur[6][0] != 'default') \{
87 87 tagspan += '<span class="branchname" title="' + cur[6][0] + '">';
88 88 tagspan += cur[6][0] + '</span> ';
89 89 }
90 90 if (cur[7].length) \{
91 91 for (var t in cur[7]) \{
92 92 var tag = cur[7][t];
93 93 tagspan += '<span class="tag">' + tag + '</span> ';
94 94 }
95 95 }
96 96 if (cur[8].length) \{
97 97 for (var b in cur[8]) \{
98 98 var bookmark = cur[8][b];
99 99 tagspan += '<span class="tag">' + bookmark + '</span> ';
100 100 }
101 101 }
102 102 tagspan += '</span>';
103 103 }
104 104
105 105 var item = '<li style="' + nstyle + '"><span class="desc">';
106 106 item += '<a href="{url|urlescape}rev/' + cur[0] + '{sessionvars%urlparameter}" title="' + cur[0] + '">' + cur[3] + '</a>';
107 107 item += '</span>' + tagspan + '<span class="info">' + cur[5] + ', by ' + cur[4] + '</span></li>';
108 108
109 109 return [bg, item];
110 110
111 111 }
112 112
113 113 graph.render(data);
114 114
115 115 // stop hiding script -->
116 116 </script>
117 117
118 118 <div class="navigate">
119 119 <a href="{url|urlescape}graph/{symrev}{lessvars%urlparameter}">less</a>
120 120 <a href="{url|urlescape}graph/{symrev}{morevars%urlparameter}">more</a>
121 121 | rev {rev}: {changenav%navgraph}
122 122 </div>
123 123
124 <script type="text/javascript">
124 <script type="text/javascript"{if(nonce, ' nonce="{nonce}"')}>
125 125 ajaxScrollInit(
126 126 '{url|urlescape}graph/{rev}?revcount=%next%&style={style}',
127 127 {revcount}+60,
128 128 function (htmlText, previousVal) \{ return previousVal + 60; },
129 129 '#wrapper',
130 130 '<div class="%class%" style="text-align: center;">%text%</div>',
131 131 'graph'
132 132 );
133 133 </script>
134 134
135 135 </div>
136 136 </div>
137 137
138 138 {footer}
@@ -1,93 +1,93 b''
1 1 {header}
2 2 <title>{repo|escape}: log</title>
3 3 <link rel="alternate" type="application/atom+xml"
4 4 href="{url|urlescape}atom-log" title="Atom feed for {repo|escape}" />
5 5 <link rel="alternate" type="application/rss+xml"
6 6 href="{url|urlescape}rss-log" title="RSS feed for {repo|escape}" />
7 7 </head>
8 8 <body>
9 9
10 10 <div class="container">
11 11 <div class="menu">
12 12 <div class="logo">
13 13 <a href="{logourl}">
14 14 <img src="{staticurl|urlescape}{logoimg}" alt="mercurial" /></a>
15 15 </div>
16 16 <ul>
17 17 <li class="active">log</li>
18 18 <li><a href="{url|urlescape}graph/{symrev}{sessionvars%urlparameter}">graph</a></li>
19 19 <li><a href="{url|urlescape}tags{sessionvars%urlparameter}">tags</a></li>
20 20 <li><a href="{url|urlescape}bookmarks{sessionvars%urlparameter}">bookmarks</a></li>
21 21 <li><a href="{url|urlescape}branches{sessionvars%urlparameter}">branches</a></li>
22 22 </ul>
23 23 <ul>
24 24 <li><a href="{url|urlescape}rev/{symrev}{sessionvars%urlparameter}">changeset</a></li>
25 25 <li><a href="{url|urlescape}file/{symrev}{path|urlescape}{sessionvars%urlparameter}">browse</a></li>
26 26 </ul>
27 27 <ul>
28 28 {archives%archiveentry}
29 29 </ul>
30 30 <ul>
31 31 <li><a href="{url|urlescape}help{sessionvars%urlparameter}">help</a></li>
32 32 </ul>
33 33 <div class="atom-logo">
34 34 <a href="{url|urlescape}atom-log" title="subscribe to atom feed">
35 35 <img class="atom-logo" src="{staticurl|urlescape}feed-icon-14x14.png" alt="atom feed" />
36 36 </a>
37 37 </div>
38 38 </div>
39 39
40 40 <div class="main">
41 41 <h2 class="breadcrumb"><a href="/">Mercurial</a> {pathdef%breadcrumb}</h2>
42 42 <h3>log</h3>
43 43
44 44 <form class="search" action="{url|urlescape}log">
45 45 {sessionvars%hiddenformentry}
46 46 <p><input name="rev" id="search1" type="text" size="30" value="{query|escape}" /></p>
47 47 <div id="hint">{searchhint}</div>
48 48 </form>
49 49
50 50 <div class="navigate">
51 51 <a href="{url|urlescape}shortlog/{symrev}{lessvars%urlparameter}">less</a>
52 52 <a href="{url|urlescape}shortlog/{symrev}{morevars%urlparameter}">more</a>
53 53 | rev {rev}: {changenav%navshort}
54 54 </div>
55 55
56 56 <table class="bigtable">
57 57 <thead>
58 58 <tr>
59 59 <th class="age">age</th>
60 60 <th class="author">author</th>
61 61 <th class="description">description</th>
62 62 </tr>
63 63 </thead>
64 64 <tbody class="stripes2">
65 65 {entries%shortlogentry}
66 66 </tbody>
67 67 </table>
68 68
69 69 <div class="navigate">
70 70 <a href="{url|urlescape}shortlog/{symrev}{lessvars%urlparameter}">less</a>
71 71 <a href="{url|urlescape}shortlog/{symrev}{morevars%urlparameter}">more</a>
72 72 | rev {rev}: {changenav%navshort}
73 73 </div>
74 74
75 <script type="text/javascript">
75 <script type="text/javascript"{if(nonce, ' nonce="{nonce}"')}>
76 76 ajaxScrollInit(
77 77 '{url|urlescape}shortlog/%next%{sessionvars%urlparameter}',
78 78 '{nextentry%"{node}"}', <!-- NEXTHASH
79 79 function (htmlText, previousVal) \{
80 80 var m = htmlText.match(/'(\w+)', <!-- NEXTHASH/);
81 81 return m ? m[1] : null;
82 82 },
83 83 '.bigtable > tbody',
84 84 '<tr class="%class%">\\
85 85 <td colspan="3" style="text-align: center;">%text%</td>\\
86 86 </tr>'
87 87 );
88 88 </script>
89 89
90 90 </div>
91 91 </div>
92 92
93 93 {footer}
@@ -1,78 +1,78 b''
1 1 {header}
2 2 <title>{repo|escape}: graph</title>
3 3 <link rel="alternate" type="application/atom+xml"
4 4 href="{url|urlescape}atom-tags" title="Atom feed for {repo|escape}: tags">
5 5 <link rel="alternate" type="application/rss+xml"
6 6 href="{url|urlescape}rss-tags" title="RSS feed for {repo|escape}: tags">
7 7 <!--[if IE]><script type="text/javascript" src="{staticurl|urlescape}excanvas.js"></script><![endif]-->
8 8 </head>
9 9 <body>
10 10
11 11 <div class="buttons">
12 12 <a href="{url|urlescape}log/{symrev}{sessionvars%urlparameter}">changelog</a>
13 13 <a href="{url|urlescape}shortlog/{symrev}{sessionvars%urlparameter}">shortlog</a>
14 14 <a href="{url|urlescape}tags{sessionvars%urlparameter}">tags</a>
15 15 <a href="{url|urlescape}branches{sessionvars%urlparameter}">branches</a>
16 16 <a href="{url|urlescape}file/{symrev}/{sessionvars%urlparameter}">files</a>
17 17 <a href="{url|urlescape}help{sessionvars%urlparameter}">help</a>
18 18 </div>
19 19
20 20 <h2><a href="/">Mercurial</a> {pathdef%breadcrumb} / graph</h2>
21 21
22 22 <form action="{url|urlescape}log">
23 23 {sessionvars%hiddenformentry}
24 24 <p>
25 25 <label for="search1">search:</label>
26 26 <input name="rev" id="search1" type="text" size="30">
27 27 navigate: <small class="navigate">{changenav%navgraph}</small>
28 28 </p>
29 29 </form>
30 30
31 31 <noscript>The revision graph only works with JavaScript-enabled browsers.</noscript>
32 32
33 33 <div id="wrapper">
34 34 <ul id="nodebgs"></ul>
35 35 <canvas id="graph" width="{canvaswidth}" height="{canvasheight}"></canvas>
36 36 <ul id="graphnodes"></ul>
37 37 </div>
38 38
39 <script type="text/javascript">
39 <script type="text/javascript"{if(nonce, ' nonce="{nonce}"')}>
40 40 <!-- hide script content
41 41
42 42 var data = {jsdata|json};
43 43 var graph = new Graph();
44 44 graph.scale({bg_height});
45 45
46 46 graph.vertex = function(x, y, color, parity, cur) \{
47 47
48 48 this.ctx.beginPath();
49 49 color = this.setColor(color, 0.25, 0.75);
50 50 this.ctx.arc(x, y, radius, 0, Math.PI * 2, true);
51 51 this.ctx.fill();
52 52
53 53 var bg = '<li class="bg parity' + parity + '"></li>';
54 54 var left = (this.bg_height - this.box_size) + (this.columns + 1) * this.box_size;
55 55 var nstyle = 'padding-left: ' + left + 'px;';
56 56 var item = '<li style="' + nstyle + '"><span class="desc">';
57 57 item += '<a href="{url|urlescape}rev/' + cur[0] + '{sessionvars%urlparameter}" title="' + cur[0] + '">' + cur[3] + '</a>';
58 58 item += '</span><span class="info">' + cur[5] + ', by ' + cur[4] + '</span></li>';
59 59
60 60 return [bg, item];
61 61
62 62 }
63 63
64 64 graph.render(data);
65 65
66 66 // stop hiding script -->
67 67 </script>
68 68
69 69 <form action="{url|urlescape}log">
70 70 {sessionvars%hiddenformentry}
71 71 <p>
72 72 <label for="search1">search:</label>
73 73 <input name="rev" id="search1" type="text" size="30">
74 74 navigate: <small class="navigate">{changenav%navgraph}</small>
75 75 </p>
76 76 </form>
77 77
78 78 {footer}
General Comments 0
You need to be logged in to leave comments. Login now