Compare commits

..

7 Commits

Author SHA1 Message Date
Xavier Roche
4ae6124257 Translate the webhttrack WARC strings into the remaining languages
PR #672 added a WARC toggle to the webhttrack GUI with 4 new LANG keys,
translated only in English and French. Append the same 4 msgid/translation
pairs to the other 28 lang/*.txt so those locales stop falling back to
English. Each translation is encoded in the file's declared LANGUAGE_CHARSET
(the charset the server serves the page and parses the form as) with a strict
lossless round-trip, matching each file's existing CRLF/LF line ending.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Xavier Roche <roche@httrack.com>
2026-07-22 22:27:59 +02:00
Xavier Roche
76dcf61d20 Expose --warc / --warc-file in the webhttrack GUI
Add a WARC output checkbox and an optional archive-name field to the
"Log, Index, Cache" option tab, beside store-all-in-cache. The checkbox
emits --warc (auto-named archive); the text field emits --warc-file NAME.
Wiring mirrors how #589 added cookies-file and strip-query: the option9.html
form fields, the generated httrack command and winprofile.ini in step4.html,
and the reload remap in step2.html.

New LANG_WARC / LANG_WARCFILE strings and tooltips land in lang.def,
English.txt and Francais.txt; the remaining 28 language files fall back to
French for now and are a follow-up.

The webhttrack smoke test now also fetches option9.html and requires the
WARC control to render.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Xavier Roche <roche@httrack.com>
2026-07-22 21:17:33 +02:00
Xavier Roche
1e0c009273 Add WARC/1.1 archive output (--warc) (#671)
Adds `--warc` / `--warc-file NAME`, writing an ISO-28500 WARC/1.1 archive of a crawl (warcinfo + request + response records, gzip per record, SHA-1 digests under OpenSSL) so HTTrack output replays in Wayback-style tools (ReplayWeb.page, pywb). Under `--update`, unchanged resources become `revisit` records instead of duplicate copies. No new dependency.

Fidelity note: HTTrack decodes gzip/br/zstd inline, so v1 stores the decoded body and normalizes the encoding headers (drops `Content-Encoding`/`Transfer-Encoding`, recomputes `Content-Length`). Valid and replayable; verbatim-compressed capture and WACZ are v2. Logic is isolated in a new `src/warc.c`.

First phase (v1) of #668.

Signed-off-by: Xavier Roche <roche@httrack.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 20:58:01 +02:00
Xavier Roche
f894a64ff8 Skip an oversized -%F footer instead of aborting the crawl (#670)
* Skip an oversized -%F footer instead of aborting the crawl

The per-page footer is expanded into a fixed ~3KB stack buffer. On overflow
hts_footer_format returns <0 and leaves the buffer unterminated, but the call
site ignored the return and ran strcatbuff on it regardless; strcatbuff's
bounded strlen finds no terminator within capacity and abort()s, killing the
crawl with SIGABRT. Reachable whenever the footer expansion exceeds the buffer
(a field referenced several times with a long URL/path, or a URL that triples
under the HTML-comment escaping); the pre-existing default footer has the same
exposure.

Guard the emit on the formatter's return: on overflow, drop the footer rather
than crash. Regression test drives a file:// crawl of a deep path with a footer
repeating {path} and asserts the crawl completes; it aborts on the pre-fix
binary.

Closes #669

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Xavier Roche <roche@httrack.com>

* Skip the footer-overflow test on Windows (MAX_PATH)

The test triggers the overflow with a path longer than Windows MAX_PATH (260),
which the source tree and mirror output both exceed there, so httrack can't
create it and the crawl fails for an unrelated reason. Restrict it to POSIX; the
fix is platform-independent and the formatter's overflow-return contract is
still covered cross-platform by the footerfmt self-test.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Xavier Roche <roche@httrack.com>

* Allowlist the Windows skip of the footer-overflow test

The Windows CI pins expected skips so an all-skipped suite can't pass green;
01_engine-footer-overflow.test now skips there (MAX_PATH), so add it to the list.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Xavier Roche <roche@httrack.com>

---------

Signed-off-by: Xavier Roche <roche@httrack.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 19:33:19 +02:00
Xavier Roche
febdd08cae Named footer fields for -%F (#667)
* Add named {addr}{path}{date}{version} footer fields alongside the legacy %s form

The -%F footer was a bare positional printf: each %s consumed the next of a
fixed addr/path/date/version arg list. It is order-coupled and inexpressive
(you cannot reach {date} without emitting addr and path first, cannot reorder,
and a wrong %s count silently yields "???" or shifted values), and the help
text advertised a cryptic bracket syntax.

hts_footer_format now dispatches on content: a footer containing %s keeps the
legacy positional model byte-for-byte (the default footer and every existing
-%F string are unaffected), while a footer without %s uses named fields
{addr} {path} {date} {version}, with "{{"/"}}" for a literal brace and any
unrecognized {...} left verbatim so typos stay visible. Sanitization is
unchanged: addr/path still pass through html_inline_safe() at the call site,
so the comment-injection guard (#165) still holds.

Driven by a new -#test=footerfmt self-test (tests/01_engine-footerfmt.test)
covering both models, brace escaping, the mixed-mode dispatch boundary, and
the overflow/zero-size return paths.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Xavier Roche <roche@httrack.com>

* Regenerate html/httrack.man.html for the -%F help change

The man/html sync CI guard requires html/httrack.man.html to change whenever
man/httrack.1 does; the -%F help-text update regenerated the man page but not
its html rendering.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Xavier Roche <roche@httrack.com>

* Add {url}{lastmodified}{mime}{charset}{status}{size} footer fields

Extends the named footer set beyond addr/path/date/version. hts_footer_format
now takes a {name,value} table instead of four fixed parameters, so the field
set is data rather than signature and the legacy %s path looks addr/path/date/
version up by name (order-independent, still byte-for-byte). The call site
supplies the new fields from the current response: {url} (scheme + host + path,
credentials stripped like {addr}), {lastmodified}, {mime}, {charset}, {status}
and {size}.

Every network-derived string is html_inline_safe()'d, since the footer sits
inside an HTML comment and a value holding "-->" would otherwise close it and
inject markup (#165); {status}/{size} are formatted integers and need none.
Documented in --help, the man pages and the Command-Line Guide, and covered by
the -#test=footerfmt self-test.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Xavier Roche <roche@httrack.com>

---------

Signed-off-by: Xavier Roche <roche@httrack.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 18:15:12 +02:00
Xavier Roche
3e1d1abdab Poll longer for the test server's port so a cold Windows CI start can't flake (#666)
The offline crawl harness reads the server's ephemeral port from the "PORT <n>"
line it prints once bound, but only waited 5s (50 x 0.1s) and matched head -n1.
Under `make check -jN` up to 16 Python servers cold-start at once; on a loaded
Windows runner a cold MSYS Python start can lag past 5s, so discovery timed out
with an empty log ("could not discover server port:") and failed 13_local-cookies
spuriously. Give it a 30s deadline, and match the PORT line anywhere so a stray
startup warning merged via 2>&1 can't wedge discovery until timeout.

Signed-off-by: Xavier Roche <roche@httrack.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 17:51:01 +02:00
Xavier Roche
8f7bfbb2f6 Fix duplicate and dead --help option letters, document -%z, -%t, -y (#665)
#R was listed twice: "cache repair" and "old FTP routines". The FTP handler
is commented out in the parser, so the only live meaning is cache repair;
drop the bogus line. #X is a no-op (the parser prints "option has no effect"),
so remove its help line and misleading default marker.

Add help lines for three real but undocumented options: -%z
(--disable-compression), -%t (keep the original file extension), and -y
(--background-on-suspend).

Regenerate man/httrack.1 and html/httrack.man.html from the updated --help.

Signed-off-by: Xavier Roche <roche@httrack.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 13:52:08 +02:00
61 changed files with 2186 additions and 71 deletions

View File

@@ -202,7 +202,8 @@ jobs:
# Every gate here exits 77, so an all-skipped suite would report green having
# tested nothing: pin the skips, and floor the passes in case the glob empties.
expected_skips=" 48_local-crange-memresume.test 71_local-crange-repaircache.test" # pending #581
# footer-overflow skips on Windows (needs a path past MAX_PATH); crange pending #581.
expected_skips=" 01_engine-footer-overflow.test 48_local-crange-memresume.test 71_local-crange-repaircache.test"
[ "$pass" -ge 90 ] || { echo "::error::only $pass tests passed ($skip skipped)"; exit 1; }
[ "$skipped" = "$expected_skips" ] || { echo "::error::unexpected skips:$skipped"; exit 1; }
[ "$fail" -eq 0 ] || { echo "::error::failing:$failed"; exit 1; }

View File

@@ -323,10 +323,18 @@ options control what HTTrack says about itself.</p>
<tr><td><tt>--user-agent (-F)</tt></td><td>The <tt>User-Agent</tt>. Set a browser string to get past crawler blocks; <tt>--user-agent ""</tt> sends none.</td></tr>
<tr><td><tt>--referer (-%R), --from (-%E), --language (-%l), --accept (-%a)</tt></td><td>Referer, From, Accept-Language and Accept headers.</td></tr>
<tr><td><tt>--headers (-%X)</tt></td><td>Add raw header lines to every request.</td></tr>
<tr><td><tt>--footer (-%F)</tt></td><td>A footer written into saved pages (on disk, not a network header).</td></tr>
<tr><td><tt>--footer (-%F)</tt></td><td>A footer written into saved pages (on disk, not a network header). See <b>Footer fields</b> below.</td></tr>
<tr><td><tt>--cookies (-b), --cookies-file (-%K)</tt></td><td>Accept cookies, and preload a Netscape <tt>cookies.txt</tt>.</td></tr>
</table>
<p><b>Footer fields.</b> A footer with no <tt>%s</tt> may reference named fields:
<tt>{addr}</tt>, <tt>{path}</tt>, <tt>{url}</tt>, <tt>{date}</tt> (mirror time),
<tt>{lastmodified}</tt> (the page's Last-Modified), <tt>{version}</tt>,
<tt>{mime}</tt>, <tt>{charset}</tt>, <tt>{status}</tt> and <tt>{size}</tt>; write
<tt>{{</tt> or <tt>}}</tt> for a literal brace. A footer that contains <tt>%s</tt>
keeps the older positional form (host, path, date in that order). Example:
<tt>-%F "&lt;!-- Mirrored from {url} on {date} --&gt;"</tt>.</p>
<p><b>Login.</b> For HTTP Basic auth, put the credentials in the URL:
<tt>http://user:pass@host/</tt>. An <tt>@</tt> inside the username must be written
<tt>%40</tt>. Only Basic is supported, not Digest.</p>

View File

@@ -90,18 +90,19 @@ offline browser : copy websites to a local directory</p>
] [ <b>-NN, --structure[=N]</b> ] [ <b>-%N,
--delayed-type-check</b> ] [ <b>-%D,
--cached-delayed-type-check</b> ] [ <b>-%M, --mime-html</b>
] [ <b>-LN, --long-names[=N]</b> ] [ <b>-KN,
--keep-links[=N]</b> ] [ <b>-x, --replace-external</b> ] [
<b>-%x, --disable-passwords</b> ] [ <b>-%q,
--include-query-string</b> ] [ <b>-%g, --strip-query</b> ] [
<b>-o, --generate-errors</b> ] [ <b>-X, --purge-old[=N]</b>
] [ <b>-%p, --preserve</b> ] [ <b>-%T, --utf8-conversion</b>
] [ <b>-bN, --cookies[=N]</b> ] [ <b>-%K, --cookies-file</b>
] [ <b>-%Y, --why</b> ] [ <b>-u, --check-type[=N]</b> ] [
<b>-j, --parse-java[=N]</b> ] [ <b>-sN, --robots[=N]</b> ] [
<b>-%h, --http-10</b> ] [ <b>-%k, --keep-alive</b> ] [
<b>-%z, --disable-compression</b> ] [ <b>-%B, --tolerant</b>
] [ <b>-%s, --updatehack</b> ] [ <b>-%u, --urlhack</b> ] [
] [ <b>-%r, --warc</b> ] [ <b>-LN, --long-names[=N]</b> ] [
<b>-KN, --keep-links[=N]</b> ] [ <b>-x,
--replace-external</b> ] [ <b>-%x, --disable-passwords</b> ]
[ <b>-%q, --include-query-string</b> ] [ <b>-%g,
--strip-query</b> ] [ <b>-o, --generate-errors</b> ] [
<b>-X, --purge-old[=N]</b> ] [ <b>-%p, --preserve</b> ] [
<b>-%T, --utf8-conversion</b> ] [ <b>-bN, --cookies[=N]</b>
] [ <b>-%K, --cookies-file</b> ] [ <b>-%Y, --why</b> ] [
<b>-u, --check-type[=N]</b> ] [ <b>-j, --parse-java[=N]</b>
] [ <b>-sN, --robots[=N]</b> ] [ <b>-%h, --http-10</b> ] [
<b>-%k, --keep-alive</b> ] [ <b>-%z,
--disable-compression</b> ] [ <b>-%B, --tolerant</b> ] [
<b>-%s, --updatehack</b> ] [ <b>-%u, --urlhack</b> ] [
<b>-%A, --assume</b> ] [ <b>-@iN, --protocol[=N]</b> ] [
<b>-%w, --disable-module</b> ] [ <b>-F, --user-agent</b> ] [
<b>-%R, --referer</b> ] [ <b>-%E, --from</b> ] [ <b>-%F,
@@ -648,6 +649,18 @@ don&rsquo;t wait) (--cached-delayed-type-check)</p></td></tr>
<td width="4%">
<p>-%r</p></td>
<td width="5%"></td>
<td width="82%">
<p>write an ISO-28500 WARC/1.1 archive; --warc-file NAME
sets the output name (--warc)</p></td></tr>
<tr valign="top" align="left">
<td width="9%"></td>
<td width="4%">
<p>-%t</p></td>
<td width="5%"></td>
<td width="82%">
@@ -1049,9 +1062,10 @@ headers (-F &quot;user-agent name&quot;) (--user-agent
<td width="82%">
<p>footer string in Html code (-%F &quot;Mirrored [from
host %s [file %s [at %s]]]&quot; (--footer
&lt;param&gt;)</p> </td></tr>
<p>footer string in Html code (-%F &quot;Mirrored from
{url} on {date}&quot;; fields {addr} {path} {url} {date}
{lastmodified} {version} {mime} {charset} {status} {size},
or legacy %s) (--footer &lt;param&gt;)</p></td></tr>
<tr valign="top" align="left">
<td width="9%"></td>
<td width="4%">

View File

@@ -103,6 +103,17 @@ ${do:end-if}
> ${LANG_I61}
<br><br>
<input type="checkbox" name="warc" ${checked:warc}
title='${html:LANG_WARCTIP}' onMouseOver="info('${html:LANG_WARCTIP}'); return true" onMouseOut="info('&nbsp;'); return true"
> ${LANG_WARC}
<br><br>
${LANG_WARCFILE}
<input name="warcfile" value="${warcfile}" size="40"
title='${html:LANG_WARCFILETIP}' onMouseOver="info('${html:LANG_WARCFILETIP}'); return true" onMouseOut="info('&nbsp;'); return true"
>
<br><br>
<input type="checkbox" name="norecatch" ${checked:norecatch}
title='${html:LANG_I5b}' onMouseOver="info('${html:LANG_I5b}'); return true" onMouseOut="info('&nbsp;'); return true"
> ${LANG_I34b}

View File

@@ -141,6 +141,8 @@ ${do:copy:KeepSlashes:keepslashes}
${do:copy:KeepQueryOrder:keepqueryorder}
${do:copy:StripQuery:stripquery}
${do:copy:StoreAllInCache:cache2}
${do:copy:Warc:warc}
${do:copy:WarcFile:warcfile}
${do:copy:LogType:logtype}
${do:copy:UseHTTPProxyForFTP:ftpprox}
${do:copy:ProxyType:proxytype}

View File

@@ -187,6 +187,8 @@ ${do:end-if}
${test:toler:--tolerant}
${test:http10:--http-10}
${test:cache2:--store-all-in-cache}
${test:warc:--warc}
${test:warcfile:--warc-file "}${html:warcfile}${test:warcfile:"}
${test:norecatch:--do-not-recatch}
${test:logf:--single-log}
${test:logtype:::--extra-log:--debug-log}
@@ -237,6 +239,8 @@ KeepSlashes=${ztest:keepslashes:0:1}
KeepQueryOrder=${ztest:keepqueryorder:0:1}
StripQuery=${stripquery}
StoreAllInCache=${ztest:cache2:0:1}
Warc=${ztest:warc:0:1}
WarcFile=${warcfile}
LogType=${logtype}
UseHTTPProxyForFTP=${ztest:ftpprox:0:1}
ProxyType=${proxytype}

View File

@@ -1034,3 +1034,11 @@ LANG_STRIPQUERY
Strip query keys:
LANG_STRIPQUERYTIP
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
LANG_WARC
Write a WARC archive of the crawl
LANG_WARCTIP
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
LANG_WARCFILE
WARC archive name:
LANG_WARCFILETIP
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Ïðåìàõâàíå íà êëþ÷îâå îò çàÿâêàòà:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Êëþ÷îâå îò çàÿâêàòà, ðàçäåëåíè ñúñ çàïåòàÿ, êîèòî äà ñå ïðåìàõíàò îò èìåòî íà çàïèñàíèÿ ôàéë (íàïðèìåð sid,utm_source).
Write a WARC archive of the crawl
Çàïèñâàíå íà WARC àðõèâ íà îáõîæäàíåòî
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Çàïèñâàíå íà âñåêè èçòåãëåí îòãîâîð è â WARC/1.1 àðõèâ ïî ISO-28500, äî îãëåäàëîòî.
WARC archive name:
Èìå íà WARC àðõèâà:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Íåçàäúëæèòåëíî áàçîâî èìå çà WARC àðõèâà; îñòàâåòå ïðàçíî çà àâòîìàòè÷íî èìåíóâàíå â èçõîäíàòà äèðåêòîðèÿ.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Eliminar claves de query string:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Claves de query string, separadas por comas, que se eliminarán del nombre de los archivos guardados (p. ej. sid,utm_source).
Write a WARC archive of the crawl
Escribir un archivo WARC del rastreo
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Guardar también cada respuesta descargada en un archivo WARC/1.1 ISO-28500, junto a la réplica.
WARC archive name:
Nombre del archivo WARC:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Nombre base opcional para el archivo WARC; déjelo en blanco para nombrarlo automáticamente en el directorio de salida.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Odebrat klíèe dotazu:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Klíèe dotazu oddìlené èárkami, které se vynechají z pojmenování ukládaných souborù (napø. sid,utm_source).
Write a WARC archive of the crawl
Zapsat archiv WARC z procházení
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Uložit také každou staženou odpovìï do archivu WARC/1.1 podle ISO-28500 vedle zrcadla.
WARC archive name:
Název archivu WARC:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Volitelný základní název archivu WARC; ponechte prázdné pro automatické pojmenování ve výstupním adresáøi.

View File

@@ -956,3 +956,11 @@ Strip query keys:
移除查詢鍵:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
以逗號分隔的查詢鍵,將其從儲存檔案的命名中移除 (例如 sid,utm_source)。
Write a WARC archive of the crawl
寫入此次抓取的 WARC 封存檔
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
同時將每個已擷取的回應儲存為 ISO-28500 WARC/1.1 封存檔,置於鏡像網站旁。
WARC archive name:
WARC 封存檔名稱:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
WARC 封存檔的選用基本名稱;留空則於輸出目錄中自動命名。

View File

@@ -956,3 +956,11 @@ Strip query keys:
剥离查询键:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
用逗号分隔的查询键,将其从保存文件的命名中删除 (例如 sid,utm_source)。
Write a WARC archive of the crawl
写入本次抓取的 WARC 归档
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
同时将每个已获取的响应保存为 ISO-28500 WARC/1.1 归档,置于镜像站点旁边。
WARC archive name:
WARC 归档名称:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
WARC 归档的可选基本名称;留空则在输出目录中自动命名。

View File

@@ -958,3 +958,11 @@ Strip query keys:
Ukloniti kljuèeve upita:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Zarezom odvojeni kljuèevi upita koji se izostavljaju iz naziva spremljenih datoteka (npr. sid,utm_source).
Write a WARC archive of the crawl
Zapi¹i WARC arhivu obilaska
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Spremi i svaki preuzeti odgovor u ISO-28500 WARC/1.1 arhivu, uz zrcalo.
WARC archive name:
Naziv WARC arhive:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Neobavezni osnovni naziv WARC arhive; ostavite prazno za automatsko imenovanje u izlaznom direktoriju.

View File

@@ -1004,3 +1004,11 @@ Strip query keys:
Fjern forespørgselsnøgler:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Kommaseparerede forespørgselsnøgler, der udelades i navngivningen af gemte filer (f.eks. sid,utm_source).
Write a WARC archive of the crawl
Skriv et WARC-arkiv af gennemsøgningen
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Gem også hvert hentet svar i et ISO-28500 WARC/1.1-arkiv ved siden af spejlet.
WARC archive name:
Navn på WARC-arkiv:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Valgfrit basisnavn til WARC-arkivet; lad feltet stå tomt for automatisk navngivning i outputmappen.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Query-Schlüssel entfernen:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Kommagetrennte Query-Schlüssel, die bei der Benennung gespeicherter Dateien entfallen (z. B. sid,utm_source).
Write a WARC archive of the crawl
WARC-Archiv des Crawls schreiben
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Jede heruntergeladene Antwort zusätzlich in einem ISO-28500-WARC/1.1-Archiv neben dem Spiegel speichern.
WARC archive name:
Name des WARC-Archivs:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Optionaler Basisname für das WARC-Archiv; leer lassen, um es automatisch im Ausgabeverzeichnis zu benennen.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Eemalda päringuvõtmed:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Komadega eraldatud päringuvõtmed, mis jäetakse salvestatud faili nimest välja (nt sid,utm_source).
Write a WARC archive of the crawl
Kirjuta läbimise WARC-arhiiv
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Salvesta iga alla laaditud vastus ka ISO-28500 WARC/1.1 arhiivi peegli kõrvale.
WARC archive name:
WARC-arhiivi nimi:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
WARC-arhiivi valikuline põhinimi; jäta tühjaks, et see väljundkataloogis automaatselt nimetada.

View File

@@ -1004,3 +1004,11 @@ Strip query keys:
Strip query keys:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Write a WARC archive of the crawl
Write a WARC archive of the crawl
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
WARC archive name:
WARC archive name:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.

View File

@@ -958,3 +958,11 @@ Strip query keys:
Poista kyselyavaimet:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Pilkuin erotellut kyselyavaimet, jotka jätetään pois tallennettujen tiedostojen nimeämisestä (esim. sid,utm_source).
Write a WARC archive of the crawl
Kirjoita imuroinnin WARC-arkisto
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Tallenna myös jokainen noudettu vastaus ISO-28500 WARC/1.1 -arkistoon peilin viereen.
WARC archive name:
WARC-arkiston nimi:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Valinnainen WARC-arkiston perusnimi; jätä tyhjäksi, jotta se nimetään automaattisesti tulostehakemistoon.

View File

@@ -1004,3 +1004,11 @@ Strip query keys:
Supprimer les clés de query string :
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Clés de query string à retirer du nommage des fichiers enregistrés, séparées par des virgules (par ex. sid,utm_source).
Write a WARC archive of the crawl
Écrire une archive WARC du crawl
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Enregistrer aussi chaque réponse téléchargée dans une archive WARC/1.1 (ISO-28500), à côté du miroir.
WARC archive name:
Nom de l'archive WARC :
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Nom de base optionnel pour l'archive WARC ; laissez vide pour le générer automatiquement dans le répertoire de sortie.

View File

@@ -958,3 +958,11 @@ Strip query keys:
Αφαίρεση κλειδιών ερωτήματος:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Κλειδιά ερωτήματος χωρισμένα με κόμμα, που θα αφαιρεθούν από την ονομασία των αποθηκευμένων αρχείων (π.χ. sid,utm_source).
Write a WARC archive of the crawl
Εγγραφή αρχείου WARC της ανίχνευσης
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Αποθήκευση κάθε ληφθείσας απόκρισης και σε αρχείο WARC/1.1 ISO-28500, δίπλα στο είδωλο.
WARC archive name:
Όνομα αρχείου WARC:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Προαιρετικό βασικό όνομα για το αρχείο WARC. Αφήστε το κενό για αυτόματη ονομασία στον κατάλογο εξόδου.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Rimuovi chiavi della query string:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Chiavi della query string, separate da virgole, da rimuovere dai nomi dei file salvati (ad es. sid,utm_source).
Write a WARC archive of the crawl
Scrivi un archivio WARC della scansione
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Salva anche ogni risposta scaricata in un archivio WARC/1.1 ISO-28500, accanto al mirror.
WARC archive name:
Nome dell'archivio WARC:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Nome di base facoltativo per l'archivio WARC; lascia vuoto per assegnarlo automaticamente nella directory di output.

View File

@@ -956,3 +956,11 @@ Strip query keys:
削除するクエリキー:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
保存ファイル名の生成から除外するクエリキーをカンマ区切りで指定します (例: sid,utm_source)。
Write a WARC archive of the crawl
クロールの WARC アーカイブを書き出す
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
取得した各レスポンスを ISO-28500 WARC/1.1 アーカイブとしてミラーの隣にも保存します。
WARC archive name:
WARC アーカイブ名:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
WARC アーカイブの任意のベース名。空欄にすると出力ディレクトリ内で自動的に名前が付けられます。

View File

@@ -956,3 +956,11 @@ Strip query keys:
¾âáâàÐÝØ ÚÛãçÕÒØ ÞÔ ÑÐàÐúÕâÞ:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
ºÛãçÕÒØ ÞÔ ÑÐàÐúÕâÞ, ÞÔÔÕÛÕÝØ áÞ ×ÐߨàÚÐ, èâÞ áÕ ÞâáâàÐÝãÒÐÐâ ÞÔ ØÜÕâÞ ÝÐ ×ÐçãÒÐÝÐâÐ ÔÐâÞâÕÚÐ (ÝÐ ßàØÜÕà sid,utm_source).
Write a WARC archive of the crawl
·ÐßØèØ WARC ÐàåØÒÐ ÝÐ ßàÕÑÐàãÒÐúÕâÞ
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
·ÐçãÒÐø ÓÞ áÕÚÞø ßàÕ×ÕÜÕÝ ÞÔÓÞÒÞà Ø ÒÞ ISO-28500 WARC/1.1 ÐàåØÒÐ, ßÞÚàÐø ÞÓÛÕÔÐÛÞâÞ.
WARC archive name:
¸ÜÕ ÝÐ WARC ÐàåØÒÐâÐ:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
¸×ÑÞàÝÞ ÞáÝÞÒÝÞ ØÜÕ ×Ð WARC ÐàåØÒÐâÐ; ÞáâÐÒÕâÕ ßàÐ×ÝÞ ×Ð ÐÒâÞÜÐâáÚÞ ØÜÕÝãÒÐúÕ ÒÞ Ø×ÛÕ×ÝØÞâ ÔØàÕÚâÞàØãÜ.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Lekérdezési kulcsok eltávolítása:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Vesszõvel elválasztott lekérdezési kulcsok, amelyeket el kell hagyni a mentett fájl elnevezésébõl (pl. sid,utm_source).
Write a WARC archive of the crawl
A bejárás WARC archívumának írása
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Minden letöltött válasz mentése ISO-28500 WARC/1.1 archívumba is, a tükör mellé.
WARC archive name:
WARC archívum neve:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
A WARC archívum opcionális alapneve; hagyja üresen az automatikus elnevezéshez a kimeneti könyvtárban.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Query-sleutels verwijderen:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Door komma's gescheiden query-sleutels die bij het benoemen van opgeslagen bestanden worden weggelaten (bijv. sid,utm_source).
Write a WARC archive of the crawl
Schrijf een WARC-archief van de crawl
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Sla ook elke opgehaalde respons op in een ISO-28500 WARC/1.1-archief, naast de mirror.
WARC archive name:
Naam van WARC-archief:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Optionele basisnaam voor het WARC-archief; laat leeg om het automatisch een naam te geven in de uitvoermap.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Fjern spørrenøkler:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Kommaseparerte spørrenøkler som utelates i navngivingen av lagrede filer (f.eks. sid,utm_source).
Write a WARC archive of the crawl
Skriv et WARC-arkiv av gjennomgangen
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Lagre også hvert nedlastet svar i et ISO-28500 WARC/1.1-arkiv ved siden av speilet.
WARC archive name:
Navn på WARC-arkiv:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Valgfritt basisnavn for WARC-arkivet; la feltet stå tomt for automatisk navngivning i utdatamappen.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Usuñ klucze zapytania:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Rozdzielone przecinkami klucze zapytania pomijane przy nazywaniu zapisanych plików (np. sid,utm_source).
Write a WARC archive of the crawl
Zapisz archiwum WARC z indeksowania
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Zapisz te¿ ka¿d± pobran± odpowied¼ do archiwum WARC/1.1 ISO-28500, obok kopii lustrzanej.
WARC archive name:
Nazwa archiwum WARC:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Opcjonalna nazwa bazowa archiwum WARC; pozostaw puste, aby nazwaæ je automatycznie w katalogu wyj¶ciowym.

View File

@@ -1004,3 +1004,11 @@ Strip query keys:
Remover chaves da query string:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Chaves da query string, separadas por vírgulas, a serem removidas da nomeação dos arquivos salvos (ex.: sid,utm_source).
Write a WARC archive of the crawl
Gravar um arquivo WARC do rastreamento
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Salvar também cada resposta baixada em um arquivo WARC/1.1 ISO-28500, ao lado do espelho.
WARC archive name:
Nome do arquivo WARC:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Nome base opcional para o arquivo WARC; deixe em branco para nomeá-lo automaticamente no diretório de saída.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Remover chaves da query string:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Chaves da query string, separadas por vírgulas, a remover da nomeação dos ficheiros guardados (por ex. sid,utm_source).
Write a WARC archive of the crawl
Escrever um arquivo WARC do rastreio
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Guardar também cada resposta transferida num arquivo WARC/1.1 ISO-28500, ao lado do espelho.
WARC archive name:
Nome do arquivo WARC:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Nome base opcional para o arquivo WARC; deixe em branco para o nomear automaticamente no diretório de saída.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Elimina cheile din query string:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Chei din query string, separate prin virgula, de eliminat din denumirea fisierelor salvate (de ex. sid,utm_source).
Write a WARC archive of the crawl
Scrie o arhiva WARC a parcurgerii
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Salveaza si fiecare raspuns descarcat intr-o arhiva WARC/1.1 ISO-28500, langa oglinda.
WARC archive name:
Numele arhivei WARC:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Nume de baza optional pentru arhiva WARC; lasati gol pentru a-l denumi automat in directorul de iesire.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Óäàëÿòü êëþ÷è çàïðîñà:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Êëþ÷è çàïðîñà ÷åðåç çàïÿòóþ, óäàëÿåìûå èç èìåíè ñîõðàíÿåìîãî ôàéëà (íàïðèìåð, sid,utm_source).
Write a WARC archive of the crawl
Çàïèñàòü WARC-àðõèâ îáõîäà
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Ñîõðàíÿòü êàæäûé çàãðóæåííûé îòâåò òàêæå â àðõèâ WARC/1.1 ISO-28500 ðÿäîì ñ çåðêàëîì.
WARC archive name:
Èìÿ WARC-àðõèâà:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Íåîáÿçàòåëüíîå áàçîâîå èìÿ WARC-àðõèâà; îñòàâüòå ïóñòûì äëÿ àâòîìàòè÷åñêîãî èìåíîâàíèÿ â âûõîäíîì êàòàëîãå.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Odstráni» kµúèe dotazu:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Kµúèe dotazu oddelené èiarkami, ktoré sa vynechajú z pomenovania ukladaných súborov (napr. sid,utm_source).
Write a WARC archive of the crawl
Zapísa» archív WARC z prehµadávania
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Ulo¾i» aj ka¾dú stiahnutú odpoveï do archívu WARC/1.1 ISO-28500 vedµa zrkadla.
WARC archive name:
Názov archívu WARC:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Voliteµný základný názov archívu WARC; ponechajte prázdne pre automatické pomenovanie vo výstupnom adresári.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Odstrani kljuce poizvedbe:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Z vejicami loceni kljuci poizvedbe, ki se izpustijo pri poimenovanju shranjenih datotek (npr. sid,utm_source).
Write a WARC archive of the crawl
Zapisi arhiv WARC iz pregledovanja
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Shrani tudi vsak preneseni odgovor v arhiv WARC/1.1 ISO-28500 poleg zrcala.
WARC archive name:
Ime arhiva WARC:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Neobvezno osnovno ime arhiva WARC; pustite prazno za samodejno poimenovanje v izhodni mapi.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Ta bort frågenycklar:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Kommaseparerade frågenycklar som utelämnas vid namngivningen av sparade filer (t.ex. sid,utm_source).
Write a WARC archive of the crawl
Skriv ett WARC-arkiv av genomsökningen
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Spara även varje hämtat svar i ett ISO-28500 WARC/1.1-arkiv, bredvid spegeln.
WARC archive name:
WARC-arkivets namn:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Valfritt basnamn för WARC-arkivet; lämna tomt för att namnge det automatiskt i utdatakatalogen.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Sorgu anahtarlarýný çýkar:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Kaydedilen dosya adlandýrmasýndan çýkarýlacak, virgülle ayrýlmýþ sorgu anahtarlarý (örn. sid,utm_source).
Write a WARC archive of the crawl
Taramanýn WARC arþivini yaz
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Ýndirilen her yanýtý ayrýca aynanýn yanýna bir ISO-28500 WARC/1.1 arþivine kaydet.
WARC archive name:
WARC arþivi adý:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
WARC arþivi için isteðe baðlý temel ad; çýktý dizininde otomatik adlandýrma için boþ býrakýn.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Âèëó÷àòè êëþ÷³ çàïèòó:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Êëþ÷³ çàïèòó ÷åðåç êîìó, ÿê³ âèëó÷àþòüñÿ ç ³ìåí³ çáåðåæåíîãî ôàéëó (íàïðèêëàä, sid,utm_source).
Write a WARC archive of the crawl
Çàïèñàòè WARC-àðõ³â îáõîäó
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Çáåð³ãàòè êîæíó çàâàíòàæåíó â³äïîâ³äü òàêîæ ó àðõ³â WARC/1.1 ISO-28500 ïîðÿä ³ç äçåðêàëîì.
WARC archive name:
²ì'ÿ WARC-àðõ³âó:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
Íåîáîâ'ÿçêîâà áàçîâà íàçâà WARC-àðõ³âó; çàëèøòå ïîðîæí³ì äëÿ àâòîìàòè÷íîãî íàéìåíóâàííÿ ó âèõ³äíîìó êàòàëîç³.

View File

@@ -956,3 +956,11 @@ Strip query keys:
Olib tashlanadigan sorov kalitlari:
Comma-separated query keys to drop from the saved-file naming (e.g. sid,utm_source).
Saqlangan fayl nomidan olib tashlanadigan, vergul bilan ajratilgan sorov kalitlari (masalan, sid,utm_source).
Write a WARC archive of the crawl
Qidiruvning WARC arxivini yozish
Also save every fetched response into an ISO-28500 WARC/1.1 archive, next to the mirror.
Har bir yuklab olingan javobni ISO-28500 WARC/1.1 arxiviga ham, ko'zgu yonida saqlash.
WARC archive name:
WARC arxivi nomi:
Optional base name for the WARC archive; leave blank to auto-name it under the output directory.
WARC arxivi uchun ixtiyoriy asosiy nom; chiqish katalogida avtomatik nomlash uchun bo'sh qoldiring.

View File

@@ -40,6 +40,7 @@ httrack \- offline browser : copy websites to a local directory
[ \fB\-%N, \-\-delayed\-type\-check\fR ]
[ \fB\-%D, \-\-cached\-delayed\-type\-check\fR ]
[ \fB\-%M, \-\-mime\-html\fR ]
[ \fB\-%r, \-\-warc\fR ]
[ \fB\-LN, \-\-long\-names[=N]\fR ]
[ \fB\-KN, \-\-keep\-links[=N]\fR ]
[ \fB\-x, \-\-replace\-external\fR ]
@@ -197,6 +198,8 @@ delayed type check, don't make any link test but wait for files download to star
cached delayed type check, don't wait for remote type during updates, to speedup them (%D0 wait, * %D1 don't wait) (\-\-cached\-delayed\-type\-check)
.IP \-%M
generate a RFC MIME\-encapsulated full\-archive (.mht) (\-\-mime\-html)
.IP \-%r
write an ISO\-28500 WARC/1.1 archive; \-\-warc\-file NAME sets the output name (\-\-warc)
.IP \-%t
keep the original file extension, don't rewrite it from the MIME type (%t0 rewrite)
.IP \-LN
@@ -264,7 +267,7 @@ default referer field sent in HTTP headers (\-\-referer <param>)
.IP \-%E
from email address sent in HTTP headers (\-\-from <param>)
.IP \-%F
footer string in Html code (\-%F "Mirrored [from host %s [file %s [at %s]]]" (\-\-footer <param>)
footer string in Html code (\-%F "Mirrored from {url} on {date}"; fields {addr} {path} {url} {date} {lastmodified} {version} {mime} {charset} {status} {size}, or legacy %s) (\-\-footer <param>)
.IP \-%l
preferred language (\-%l "fr, en, jp, *" (\-\-language <param>)
.IP \-%a

View File

@@ -63,7 +63,7 @@ libhttrack_la_SOURCES = htscore.c htsparse.c htsback.c htscache.c \
htshelp.c htslib.c htsurlport.c htscoremain.c \
htsname.c htsrobots.c htstools.c htswizard.c \
htsalias.c htsthread.c htsindex.c htsbauth.c \
htsmd5.c htscodec.c htsproxy.c htszlib.c htswrap.c htsconcat.c \
htsmd5.c htscodec.c htswarc.c htsproxy.c htszlib.c htswrap.c htsconcat.c \
htsmodules.c htscharset.c punycode.c htsencoding.c htssniff.c \
md5.c \
minizip/ioapi.c minizip/mztools.c minizip/unzip.c minizip/zip.c \
@@ -74,7 +74,7 @@ libhttrack_la_SOURCES = htscore.c htsparse.c htsback.c htscache.c \
htshelp.h htsindex.h htslib.h htsurlport.h htsmd5.h \
htsmodules.h htsname.h htsnet.h htssniff.h \
htsopt.h htsrobots.h htsthread.h \
htstools.h htswizard.h htswrap.h htscodec.h htsproxy.h htszlib.h \
htstools.h htswizard.h htswrap.h htscodec.h htswarc.h htsproxy.h htszlib.h \
htsstrings.h htsarrays.h httrack-library.h \
htscharset.h punycode.h htsencoding.h \
htsentities.h htsentities.sh htsbasiccharsets.sh htscodepages.h \

View File

@@ -114,6 +114,8 @@ const char *hts_optalias[][4] = {
"strip [host/pattern=]key1,key2,... from URLs"},
{"cookies-file", "-%K", "param1",
"load extra cookies from a Netscape cookies.txt"},
{"warc", "-%r", "single", "write an ISO-28500 WARC/1.1 archive of the crawl"},
{"warc-file", "-%rf", "param1", "write a WARC archive to the given base name"},
{"why", "-%Y", "param1",
"explain which filter rule accepts or rejects a URL, then exit"},
{"pause", "-%G", "param1",

View File

@@ -37,6 +37,7 @@ Please visit our Website: http://www.httrack.com
/* specific definitions */
#include "htsnet.h"
#include "htscore.h"
#include "htswarc.h"
#include "htsthread.h"
#include <time.h>
/* END specific definitions */
@@ -979,6 +980,10 @@ int back_finalize(httrackp * opt, cache_back * cache, struct_back * sback,
// status finished callback
RUN_CALLBACK1(opt, xfrstatus, &back[p]);
// WARC archive of the transaction (request + response/revisit)
if (StringNotEmpty(opt->warc_file))
warc_write_backtransaction(opt, &back[p]);
return 0;
} else { // testmode
if (back[p].r.statuscode / 100 >= 3) { /* Store 3XX, 4XX, 5XX test response codes, but NOT 2XX */
@@ -1055,6 +1060,8 @@ void back_copy_static(const lien_back * src, lien_back * dst) {
dst->r.soc = INVALID_SOCKET;
dst->r.adr = NULL;
dst->r.headers = NULL;
dst->r.warc_reqhdr = NULL;
dst->r.warc_resphdr = NULL;
dst->r.out = NULL;
dst->r.location = dst->location_buffer;
dst->r.fp = NULL;
@@ -1118,6 +1125,8 @@ int back_unserialize(FILE * fp, lien_back ** dst) {
(*dst)->chunk_adr = NULL;
(*dst)->r.adr = NULL;
(*dst)->r.out = NULL;
(*dst)->r.warc_reqhdr = NULL;
(*dst)->r.warc_resphdr = NULL;
(*dst)->r.location = (*dst)->location_buffer;
(*dst)->r.fp = NULL;
(*dst)->r.soc = INVALID_SOCKET;
@@ -1585,6 +1594,7 @@ int back_clear_entry(lien_back * back) {
freet(back->r.headers);
back->r.headers = NULL;
}
warc_free_request(&back->r);
// Tout nettoyer
memset(back, 0, sizeof(lien_back));
back->r.soc = INVALID_SOCKET;
@@ -3631,6 +3641,10 @@ void back_wait(struct_back * sback, httrackp * opt, cache_back * cache,
deleteaddr(&back[i].r);
back[i].r.headers = block;
}
// Stash the raw response headers for WARC (deletehttp frees
// r.headers when the socket closes, before back_finalize)
if (StringNotEmpty(opt->warc_file))
warc_stash_response(&back[i].r, back[i].r.headers);
/*
Status code and header-response hacks

View File

@@ -39,6 +39,7 @@ Please visit our Website: http://www.httrack.com
/* File defs */
#include "htscore.h"
#include "htswarc.h"
/* specific definitions */
#include "htsbase.h"
@@ -2245,6 +2246,7 @@ int httpmirror(char *url1, httrackp * opt) {
// ending
usercommand(opt, 0, NULL, NULL, NULL, NULL);
warc_close_opt(opt);
// désallocation mémoire & buffers
XH_uninit;
@@ -3628,6 +3630,9 @@ HTSEXT_API int copy_htsopt(const httrackp * from, httrackp * to) {
if (StringNotEmpty(from->cookies_file))
StringCopyS(to->cookies_file, from->cookies_file);
if (StringNotEmpty(from->warc_file))
StringCopyS(to->warc_file, from->warc_file);
if (from->pause_max_ms > 0) {
to->pause_min_ms = from->pause_min_ms;
to->pause_max_ms = from->pause_max_ms;

View File

@@ -40,6 +40,7 @@ Please visit our Website: http://www.httrack.com
#include "htscore.h"
#include "htsdefines.h"
#include "htsalias.h"
#include "htswarc.h"
#include "htsbauth.h"
#include "htswrap.h"
#include "htsmodules.h"
@@ -1622,10 +1623,9 @@ static int hts_main_internal(int argc, char **argv, httrackp * opt) {
if ((na + 1 >= argc) || (argv[na + 1][0] == '-')) {
HTS_PANIC_PRINTF
("Option %F needs to be followed by a blank space, and a footer string");
printf
("Example: -%%F \"<!-- Mirrored from %%s by HTTrack Website Copier/"
HTTRACK_AFF_VERSION " " HTTRACK_AFF_AUTHORS
", %%s -->\"\n");
printf("Example: -%%F \"<!-- Mirrored from {addr}{path} by "
"HTTrack Website Copier/"
"{version} " HTTRACK_AFF_AUTHORS ", {date} -->\"\n");
htsmain_free();
return -1;
} else {
@@ -1790,6 +1790,26 @@ static int hts_main_internal(int argc, char **argv, httrackp * opt) {
StringCopy(opt->cookies_file, argv[na]);
}
break;
case 'r': // warc / warc-file: write an ISO-28500 WARC archive
if (*(com + 1) == 'f') { // --warc-file NAME: explicit basename
com++;
if ((na + 1 >= argc) || (argv[na + 1][0] == '-')) {
HTS_PANIC_PRINTF(
"Option warc-file needs a blank space and a WARC name");
htsmain_free();
return -1;
}
na++;
if (strlen(argv[na]) >= 1024) {
HTS_PANIC_PRINTF("WARC file name too long");
htsmain_free();
return -1;
}
StringCopy(opt->warc_file, argv[na]);
} else { // --warc: auto-named archive under the output dir
StringCopy(opt->warc_file, WARC_AUTONAME);
}
break;
case 'Y': // why: explain the filter verdict for a URL, no crawl
if ((na + 1 >= argc) || (argv[na + 1][0] == '-')) {
HTS_PANIC_PRINTF("Option why needs a blank space and a URL");

View File

@@ -524,6 +524,8 @@ void help(const char *app, int more) {
infomsg
(" %D cached delayed type check, don't wait for remote type during updates, to speedup them (%D0 wait, * %D1 don't wait)");
infomsg(" %M generate a RFC MIME-encapsulated full-archive (.mht)");
infomsg(" %r write an ISO-28500 WARC/1.1 archive; --warc-file NAME sets the "
"output name");
infomsg(" %t keep the original file extension, don't rewrite it from the "
"MIME type (%t0 rewrite)");
infomsg
@@ -581,8 +583,10 @@ void help(const char *app, int more) {
(" F user-agent field sent in HTTP headers (-F \"user-agent name\")");
infomsg(" %R default referer field sent in HTTP headers");
infomsg(" %E from email address sent in HTTP headers");
infomsg
(" %F footer string in Html code (-%F \"Mirrored [from host %s [file %s [at %s]]]\"");
infomsg(
" %F footer string in Html code (-%F \"Mirrored from {url} on "
"{date}\"; fields {addr} {path} {url} {date} {lastmodified} {version} "
"{mime} {charset} {status} {size}, or legacy %s)");
infomsg(" %l preferred language (-%l \"fr, en, jp, *\"");
infomsg(" %a accepted formats (-%a \"text/html,image/png;q=0.9,*/*;q=0.1\"");
infomsg(" %X additional HTTP header line (-%X \"X-Magic: 42\"");

View File

@@ -36,6 +36,7 @@ Please visit our Website: http://www.httrack.com
// Fichier librairie .c
#include "htscore.h"
#include "htswarc.h"
/* specific definitions */
#include "htsbase.h"
@@ -1201,6 +1202,11 @@ int http_sendhead(httrackp * opt, t_cookie * cookie, int mode,
} // Fin test pas postfile
//
// Stash the raw request for the WARC request record (freed at
// back_clear_entry)
if (StringNotEmpty(opt->warc_file))
warc_stash_request(retour, bstr.buffer);
// Callback
{
int test_head =
@@ -2114,6 +2120,8 @@ htsblk http_test(httrackp * opt, const char *adr, const char *fil, char *loc) {
#if HTS_DEBUG_CLOSESOCK
DEBUG_W("http_test: deletehttp\n");
#endif
// this probe's htsblk is discarded by callers, so free any WARC stash here
warc_free_request(&retour);
deletehttp(&retour);
retour.soc = INVALID_SOCKET;
}
@@ -6010,6 +6018,7 @@ HTSEXT_API httrackp *hts_create_opt(void) {
StringCopy(opt->footer, HTS_DEFAULT_FOOTER);
StringCopy(opt->strip_query, "");
StringCopy(opt->cookies_file, "");
StringCopy(opt->warc_file, "");
StringCopy(opt->why_url, "");
opt->pause_min_ms = 0;
opt->pause_max_ms = 0;
@@ -6161,6 +6170,7 @@ HTSEXT_API void hts_free_opt(httrackp * opt) {
StringFree(opt->strip_query);
StringFree(opt->cookies_file);
StringFree(opt->why_url);
StringFree(opt->warc_file);
StringFree(opt->path_html);
StringFree(opt->path_html_utf8);

View File

@@ -256,6 +256,7 @@ struct htsoptstate {
unsigned int debug_state;
unsigned int tmpnameid; /**< counter for temporary file names */
int is_ended; /**< mirror has finished */
void *warc; /**< open WARC writer (warc_writer*), or NULL */
};
/* Library handles */
@@ -538,6 +539,8 @@ struct httrackp {
int pause_max_ms; /**< inter-file pause upper bound, ms */
String why_url; /**< URL to diagnose (--why): print the deciding filter rule
and exit without crawling */
String warc_file; /**< WARC output: WARC_AUTONAME for --warc, or the
--warc-file basename (appended at the tail: ABI) */
};
/* Running statistics for a mirror. */
@@ -661,6 +664,9 @@ struct htsblk {
/* Restart-whole signal: a resume this response rejected (unusable 206) must
retry with no Range, else a surviving partial/temp-ref loops (#581). */
hts_boolean refetch_wholefile;
char *warc_reqhdr; /**< stashed raw request header block for WARC (or NULL) */
char *
warc_resphdr; /**< stashed raw response header block for WARC (or NULL) */
/*char digest[32+2]; // md5 digest generated by the engine ("" if none) */
};

View File

@@ -792,17 +792,72 @@ int htsparse(htsmoduleStruct * str, htsmoduleStructExtended * stre) {
char gmttime[256];
char BIGSTK safe_adr[HTS_URLMAXSIZE * 3 + 4];
char BIGSTK safe_fil[HTS_URLMAXSIZE * 3 + 4];
char BIGSTK safe_url[HTS_URLMAXSIZE * 6 + 16];
char safe_lastmod[sizeof(r->lastmodified) * 3 + 4];
char safe_ctype[sizeof(r->contenttype) * 3 + 4];
char safe_charset[sizeof(r->charset) * 3 + 4];
char status_str[16];
char size_str[32];
// {url} scheme: jump_identification_const strips it for
// http/https/ftp, so re-add it (bare host is http); for any
// other scheme the host keeps its "scheme://" and we add
// none.
const char *const url_host =
jump_identification_const(urladr());
const char *const url_scheme =
strstr(url_host, "://") != NULL ? ""
: strfield(urladr(), "https://") ? "https://"
: strfield(urladr(), "ftp://") ? "ftp://"
: "http://";
tempo[0] = '\0';
// {addr}/{path} are the escaped host and remote path; {url}
// prepends the scheme to them (credentials already stripped
// by jump_identification_const, and the scheme is a safe
// literal, so no re-escaping is needed).
html_inline_safe(url_host, safe_adr, sizeof(safe_adr));
html_inline_safe(urlfil(), safe_fil, sizeof(safe_fil));
snprintf(safe_url, sizeof(safe_url), "%s%s%s", url_scheme,
safe_adr, safe_fil);
snprintf(status_str, sizeof(status_str), "%d", r->statuscode);
snprintf(size_str, sizeof(size_str), LLintP, (LLint) r->size);
time_gmt_rfc822(gmttime);
strcatbuff(tempo, eol);
hts_template_format_str(tempo + strlen(tempo), sizeof(tempo) - strlen(tempo),
StringBuff(opt->footer),
html_inline_safe(jump_identification_const(urladr()), safe_adr, sizeof(safe_adr)),
html_inline_safe(urlfil(), safe_fil, sizeof(safe_fil)), gmttime,
HTTRACK_VERSIONID, /* EOF */ NULL);
strcatbuff(tempo, eol);
HT_ADD(tempo);
{
// Every network-derived string is html_inline_safe()'d: the
// footer sits inside an HTML comment, so a value holding
// "-->" would otherwise close it and inject markup (#165).
// status/size are formatted integers and need no escaping.
const hts_footer_field fields[] = {
{"addr", safe_adr},
{"path", safe_fil},
{"url", safe_url},
{"date", gmttime},
{"lastmodified",
html_inline_safe(r->lastmodified, safe_lastmod,
sizeof(safe_lastmod))},
{"version", HTTRACK_VERSIONID},
{"mime", html_inline_safe(r->contenttype, safe_ctype,
sizeof(safe_ctype))},
{"charset", html_inline_safe(r->charset, safe_charset,
sizeof(safe_charset))},
{"status", status_str},
{"size", size_str},
};
tempo[0] = '\0';
strcatbuff(tempo, eol);
// hts_footer_format returns <0 on overflow, leaving tempo
// unterminated; emitting it would abort in strcatbuff
// below.
if (hts_footer_format(tempo + strlen(tempo),
sizeof(tempo) - strlen(tempo),
StringBuff(opt->footer), fields,
sizeof(fields) / sizeof(fields[0])) >=
0) {
strcatbuff(tempo, eol);
HT_ADD(tempo);
}
}
}
// Emit charset ?
if (emited_footer == 1 && strnotempty(r->charset)) {

View File

@@ -57,6 +57,7 @@ Please visit our Website: http://www.httrack.com
#include "htssniff.h"
#include "htscodec.h"
#include "htsproxy.h"
#include "htswarc.h"
#if HTS_USEZLIB
#include "htszlib.h"
#endif
@@ -971,6 +972,47 @@ static int st_entities(httrackp *opt, int argc, char **argv) {
return 0;
}
// -#test=footerfmt <template>: expand a -%F footer with fixed fields (drives
// tests/01_engine-footerfmt.test). Also asserts the overflow/zero-size returns
// the CLI cap keeps out of reach.
static int st_footerfmt(httrackp *opt, int argc, char **argv) {
static const hts_footer_field fields[] = {
{"addr", "host.example"},
{"path", "/dir/page.html"},
{"url", "http://host.example/dir/page.html"},
{"date", "DATE"},
{"lastmodified", "LASTMOD"},
{"version", "VER"},
{"mime", "text/html"},
{"charset", "utf-8"},
{"status", "200"},
{"size", "1234"},
};
const size_t nfields = sizeof(fields) / sizeof(fields[0]);
char out[1024];
char tiny[4];
(void) opt;
// Overflow (named and legacy) and a zero-size buffer must return <0, never
// truncate silently or write out of bounds.
assertf(hts_footer_format(tiny, sizeof(tiny), "{addr}", fields, nfields) < 0);
assertf(hts_footer_format(tiny, sizeof(tiny), "a %s b", fields, nfields) < 0);
assertf(hts_footer_format(out, 0, "", fields, nfields) < 0);
// An empty template yields an empty, terminated string.
assertf(hts_footer_format(out, sizeof(out), "", fields, nfields) == 1 &&
out[0] == '\0');
if (argc < 1) {
fprintf(stderr, "footerfmt: needs a template\n");
return 1;
}
if (hts_footer_format(out, sizeof(out), argv[0], fields, nfields) < 0) {
fprintf(stderr, "footerfmt: overflow\n");
return 1;
}
printf("%s\n", out);
return 0;
}
/* The unescapers must reserve one byte for the trailing NUL: a 'max'-byte
dest holding 'max' output chars pre-fix wrote dest[max] (1-byte OOB, caught
by ASan). Both unescapeEntities and unescapeUrl share the guard. */
@@ -1260,6 +1302,13 @@ static int st_copyopt(httrackp *opt, int argc, char **argv) {
if (strcmp(StringBuff(to->cookies_file), "/tmp/jar.txt") != 0)
err = 1;
/* warc_file: same String deep-copy path as cookies_file */
StringCopy(from->warc_file, "run.warc.gz");
StringCopy(to->warc_file, "");
copy_htsopt(from, to);
if (strcmp(StringBuff(to->warc_file), "run.warc.gz") != 0)
err = 1;
/* #185 pause pair: copied when enabled (max>0), the 0 sentinel skips */
from->pause_min_ms = 5000;
from->pause_max_ms = 10000;
@@ -3215,6 +3264,276 @@ static int st_ftpuser(httrackp *opt, int argc, char **argv) {
return 0;
}
/* Bounded substring search (records carry NUL bytes; strstr won't do). */
static const char *warc_memstr(const char *hay, const char *needle,
size_t haylen, size_t nlen) {
if (nlen == 0 || haylen < nlen)
return NULL;
{
size_t i;
for (i = 0; i + nlen <= haylen; i++) {
if (memcmp(hay + i, needle, nlen) == 0)
return hay + i;
}
}
return NULL;
}
/* Slurp a whole file into a malloc'd buffer; sets *len. NULL on error. */
static unsigned char *warc_slurp(const char *path, size_t *len) {
FILE *f = FOPEN(path, "rb");
unsigned char *buf;
long sz;
if (f == NULL)
return NULL;
if (fseek(f, 0, SEEK_END) != 0 || (sz = ftell(f)) < 0) {
fclose(f);
return NULL;
}
rewind(f);
buf = malloct((size_t) sz + 1);
if (buf == NULL) {
fclose(f);
return NULL;
}
*len = fread(buf, 1, (size_t) sz, f);
fclose(f);
return buf;
}
/* Inflate one gzip member at *in (limit end); returns the decompressed record
in a malloc'd buffer (*out_len), advancing *in past the member. NULL at end
or on error (*out_len distinguishes: 0 and NULL = clean end). */
static unsigned char *warc_next_member(const unsigned char **in,
const unsigned char *end,
size_t *out_len) {
z_stream zs;
unsigned char *out = NULL;
size_t len = 0;
int zerr;
*out_len = 0;
if (*in >= end)
return NULL;
memset(&zs, 0, sizeof(zs));
if (inflateInit2(&zs, 15 + 32) != Z_OK)
return NULL;
zs.next_in = (const Bytef *) *in;
zs.avail_in = (uInt) (end - *in);
do {
unsigned char tmp[8192];
size_t got;
zs.next_out = tmp;
zs.avail_out = sizeof(tmp);
zerr = inflate(&zs, Z_NO_FLUSH);
if (zerr != Z_OK && zerr != Z_STREAM_END) {
freet(out);
inflateEnd(&zs);
return NULL;
}
got = sizeof(tmp) - zs.avail_out;
if (got > 0) {
unsigned char *n = realloct(out, len + got + 1);
if (n == NULL) {
freet(out);
inflateEnd(&zs);
return NULL;
}
out = n;
memcpy(out + len, tmp, got);
len += got;
}
} while (zerr != Z_STREAM_END);
*in = (const unsigned char *) zs.next_in; /* start of the next member */
inflateEnd(&zs);
if (out != NULL)
out[len] = '\0';
*out_len = len;
return out;
}
/* Feed a synthetic transaction and validate the resulting .warc.gz against the
WARC/1.1 spec: each record a self-standing gzip member starting WARC/1.,
Content-Length == block length, the \r\n\r\n trailer intact, the response
body round-trips, and the encoding headers are stripped (strategy B). */
static int st_warc(httrackp *opt, int argc, char **argv) {
char path[HTS_URLMAXSIZE];
warc_writer *w;
unsigned char *data;
size_t data_len = 0;
const unsigned char *p, *end;
int err = 0, nrec = 0, nresp = 0, nreq = 0, nrevisit = 0, ninfo = 0;
int seen_a_body = 0, body_occurrences = 0, a2_bodyless = 0, nm_cl_ok = 0;
static const char a_body[] = "Hello, WARC!\n";
if (argc < 1) {
fprintf(stderr, "warc: needs a writable directory\n");
return 1;
}
fconcat(path, sizeof(path), argv[0], "warc-selftest.warc.gz");
w = warc_open(opt, path);
assertf(w != NULL);
/* 200 HTML: bogus Content-Length + gzip/chunked encodings must be stripped.
*/
warc_write_transaction(
w, "http://test.local/a.html", "127.0.0.1",
"GET /a.html HTTP/1.1\r\nHost: test.local\r\n\r\n",
"HTTP/1.1 200 OK\r\nContent-Type: text/html\r\nContent-Encoding: "
"gzip\r\nTransfer-Encoding: chunked\r\nContent-Length: 999\r\n\r\n",
a_body, sizeof(a_body) - 1, NULL, 200, 0);
/* 302 redirect: header-only, no body. */
warc_write_transaction(
w, "http://test.local/r", "127.0.0.1",
"GET /r HTTP/1.1\r\nHost: test.local\r\n\r\n",
"HTTP/1.1 302 Found\r\nLocation: http://test.local/a.html\r\n\r\n", NULL,
0, NULL, 302, 0);
/* 200 binary, chunked coding on the wire (already de-chunked here). */
warc_write_transaction(
w, "http://test.local/b.bin", "127.0.0.1",
"GET /b.bin HTTP/1.1\r\nHost: test.local\r\n\r\n",
"HTTP/1.1 200 OK\r\nContent-Type: application/octet-stream\r\n"
"Transfer-Encoding: chunked\r\n\r\n",
"\x00\x01\x02\x03\x04", 5, NULL, 200, 0);
/* 200 with a body shorter than the declared Content-Length (rewritten). */
warc_write_transaction(
w, "http://test.local/trunc", "127.0.0.1",
"GET /trunc HTTP/1.1\r\nHost: test.local\r\n\r\n",
"HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: "
"100\r\n\r\n",
"short", 5, NULL, 200, 0);
/* Same payload as a.html at a new URL: identical-payload-digest revisit
(OpenSSL builds only; a plain build writes a second full response). */
warc_write_transaction(w, "http://test.local/a2.html", "127.0.0.1",
"GET /a2.html HTTP/1.1\r\nHost: test.local\r\n\r\n",
"HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n",
a_body, sizeof(a_body) - 1, NULL, 200, 0);
/* 304 revisit with an EMPTY response-header block: the block is just the
2-byte separator, so declared Content-Length must be exactly 2 (F3). */
warc_write_transaction(w, "http://test.local/nm", "127.0.0.1",
"GET /nm HTTP/1.1\r\nHost: test.local\r\n\r\n", "",
NULL, 0, NULL, 304, 1);
warc_close(w);
data = warc_slurp(path, &data_len);
assertf(data != NULL);
p = data;
end = data + data_len;
while (p < end) {
size_t rlen = 0;
unsigned char *rec = warc_next_member(&p, end, &rlen);
const char *sep, *cl;
long long block_len = 0; /* 0 on a parse failure; err is already set */
size_t hdr_len;
if (rec == NULL) {
if (rlen == 0)
break; /* clean end */
err = 1;
break;
}
nrec++;
/* magic */
if (rlen < 8 || memcmp(rec, "WARC/1.", 7) != 0)
err = 1;
/* record header ends at the first blank line */
sep = warc_memstr((char *) rec, "\r\n\r\n", rlen, 4);
if (sep == NULL) {
err = 1;
freet(rec);
continue;
}
hdr_len = (size_t) ((const unsigned char *) sep - rec) + 4;
/* Content-Length must equal the actual block length */
cl = warc_memstr((char *) rec, "Content-Length:", hdr_len, 15);
if (cl == NULL || sscanf(cl + 15, "%lld", &block_len) != 1)
err = 1;
else {
if (hdr_len + (size_t) block_len + 4 != rlen)
err = 1; /* header + block + trailing CRLFCRLF */
else if (memcmp(rec + hdr_len + block_len, "\r\n\r\n", 4) != 0)
err = 1; /* trailer intact */
}
if (warc_memstr((char *) rec, "WARC-Type: warcinfo", hdr_len, 19) != NULL)
ninfo++;
if (warc_memstr((char *) rec, "WARC-Type: request", hdr_len, 18) != NULL)
nreq++;
if (warc_memstr((char *) rec, "WARC-Type: response", hdr_len, 19) != NULL)
nresp++;
if (warc_memstr((char *) rec, "WARC-Type: revisit", hdr_len, 18) != NULL)
nrevisit++;
/* F1: the full body must appear exactly once across the whole file (a
revisit must not re-embed it). */
if (warc_memstr((char *) rec, a_body, rlen, sizeof(a_body) - 1) != NULL)
body_occurrences++;
/* F1: the a2.html identical-payload-digest revisit carries no body. */
if (warc_memstr((char *) rec, "WARC-Target-URI: http://test.local/a2.html",
hdr_len, 42) != NULL &&
warc_memstr((char *) rec, "WARC-Type: revisit", hdr_len, 18) != NULL)
a2_bodyless =
(warc_memstr((char *) rec, a_body, rlen, sizeof(a_body) - 1) == NULL);
/* F3: the empty-header 304 revisit block is exactly the 2-byte separator
(the request record shares this target URI, so match the revisit only).
*/
if (warc_memstr((char *) rec, "WARC-Target-URI: http://test.local/nm",
hdr_len, 37) != NULL &&
warc_memstr((char *) rec, "WARC-Type: revisit", hdr_len, 18) != NULL)
nm_cl_ok = (block_len == 2);
/* a.html response body must round-trip and carry no encoding headers */
if (warc_memstr((char *) rec, "WARC-Target-URI: http://test.local/a.html",
hdr_len, 41) != NULL &&
warc_memstr((char *) rec, "msgtype=response", hdr_len, 16) != NULL) {
const char *bsep = warc_memstr((char *) rec + hdr_len, "\r\n\r\n",
(size_t) block_len, 4);
if (bsep == NULL)
err = 1;
else {
size_t bodyoff = (size_t) (bsep - (char *) rec) + 4;
size_t got = rlen - 4 - bodyoff; /* minus record trailer */
if (got != sizeof(a_body) - 1 ||
memcmp(rec + bodyoff, a_body, got) != 0)
err = 1;
seen_a_body = 1;
}
if (warc_memstr((char *) rec, "Content-Encoding", hdr_len + block_len,
16) != NULL ||
warc_memstr((char *) rec, "Transfer-Encoding", hdr_len + block_len,
17) != NULL)
err = 1;
}
freet(rec);
}
freet(data);
/* warcinfo + 6 transactions (response/revisit + request each) = 13 records.
*/
if (ninfo != 1 || nreq != 6 || nrec != 13 || !seen_a_body || !nm_cl_ok)
err = 1;
#if HTS_USEOPENSSL
/* a.html + b.bin + trunc + 302 are full responses; a2.html deduped to a
revisit (bodyless), nm is the 304 revisit; the body appears exactly once.
*/
if (nrevisit != 2 || nresp != 4 || !a2_bodyless || body_occurrences != 1)
err = 1;
#else
/* No digests: a2.html is a second full response, so the body appears twice
and only the 304 nm is a revisit. */
if (nrevisit != 1 || nresp != 5 || body_occurrences != 2)
err = 1;
(void) a2_bodyless; /* only meaningful with digests */
#endif
printf("warc: %d records (%d response, %d request, %d revisit): %s\n", nrec,
nresp, nreq, nrevisit, err ? "FAIL" : "OK");
return err;
}
/* ------------------------------------------------------------ */
/* Registry: name -> handler, with a usage hint and a one-line description. */
/* ------------------------------------------------------------ */
@@ -3257,6 +3576,8 @@ static const struct selftest_entry {
{"idna-decode", "<host>", "decode an IDNA/punycode hostname",
st_idna_decode},
{"entities", "<string> [encoding]", "unescape HTML entities", st_entities},
{"footerfmt", "<template>", "-%F footer positional/named expansion",
st_footerfmt},
{"unescape-bounds", "", "unescapers reserve the NUL byte (no 1-byte OOB)",
st_unescape_bounds},
{"hashtable", "<count|file>", "coucal hashtable stress test", st_hashtable},
@@ -3332,6 +3653,8 @@ static const struct selftest_entry {
{"ftp-line", "", "get_ftp_line bounds a hostile FTP reply line",
st_ftpline},
{"ftp-userpass", "", "ftp_split_userpass bounds URL userinfo", st_ftpuser},
{"warc", "<dir>", "WARC/1.1 writer: framing, digests, revisit dedup",
st_warc},
};
static void list_selftests(void) {

View File

@@ -754,35 +754,48 @@ typedef struct hts_template_format_buf {
size_t offset;
} hts_template_format_buf;
// Bounded append to a template buffer (or FILE); returns -1 on overflow/error.
static int htsfmt_putc(hts_template_format_buf *buf, char c) {
if (buf->fp != NULL) {
assertf(buf->buffer == NULL);
if (fputc(c, buf->fp) < 0)
return -1;
} else {
assertf(buf->buffer != NULL);
if (buf->offset + 1 < buf->size)
buf->buffer[buf->offset++] = c;
else
return -1;
}
return 0;
}
static int htsfmt_puts(hts_template_format_buf *buf, const char *s) {
size_t i;
assertf(s != NULL);
for (i = 0; s[i] != '\0'; i++) {
if (htsfmt_putc(buf, s[i]) < 0)
return -1;
}
return 0;
}
// note: upstream arg list MUST be NULL-terminated for safety
// returns a negative value upon error
static int hts_template_formatv(hts_template_format_buf *buf,
static int hts_template_formatv(hts_template_format_buf *buf,
const char *format, va_list args) {
#undef FPUTC
#undef FPUTS
#define FPUTC(C) do { \
if (buf->fp != NULL) { \
assertf(buf->buffer == NULL); \
if (fputc(C, buf->fp) < 0) { \
return -1; \
} \
} else { \
assertf(buf->buffer != NULL); \
if (buf->offset + 1 < buf->size) { \
buf->buffer[buf->offset++] = (C); \
} else { \
return -1; \
} \
} \
} while(0)
#define FPUTS(S) do { \
size_t i; \
const char *const str_ = (S); \
assertf(str_ != NULL); \
for(i = 0 ; str_[i] != '\0' ; i++) { \
FPUTC(str_[i]); \
} \
} while(0)
#define FPUTC(C) \
do { \
if (htsfmt_putc(buf, (C)) < 0) \
return -1; \
} while (0)
#define FPUTS(S) \
do { \
if (htsfmt_puts(buf, (S)) < 0) \
return -1; \
} while (0)
if (buf != NULL && format != NULL) {
const char *arg_expanded[32];
@@ -859,6 +872,74 @@ int hts_template_format_str(char *buffer, size_t size, const char *format, ...)
return success;
}
// Value of the named field, or "" if absent (never NULL, so callers can pass it
// straight to a formatter).
static const char *footer_field_value(const hts_footer_field *fields,
size_t nfields, const char *name) {
size_t j;
for (j = 0; j < nfields; j++) {
if (strcmp(fields[j].name, name) == 0)
return fields[j].value != NULL ? fields[j].value : "";
}
return "";
}
int hts_footer_format(char *buffer, size_t size, const char *footer,
const hts_footer_field *fields, size_t nfields) {
hts_template_format_buf buf = {NULL, buffer, size, 0};
size_t i;
if (footer == NULL || buffer == NULL || size == 0)
return -1;
// %s keeps the legacy positional model, byte-for-byte for existing -%F
// strings: addr, path, date, version, looked up by name and
// order-independent.
if (strstr(footer, "%s") != NULL)
return hts_template_format_str(
buffer, size, footer, footer_field_value(fields, nfields, "addr"),
footer_field_value(fields, nfields, "path"),
footer_field_value(fields, nfields, "date"),
footer_field_value(fields, nfields, "version"), /* EOF */ NULL);
// "{{"/"}}" emit a literal brace; an unknown "{...}" is left verbatim so
// typos stay visible.
for (i = 0; footer[i] != '\0'; i++) {
const char c = footer[i];
if (c == '{' && footer[i + 1] == '{') {
if (htsfmt_putc(&buf, '{') < 0)
return -1;
i++;
} else if (c == '}' && footer[i + 1] == '}') {
if (htsfmt_putc(&buf, '}') < 0)
return -1;
i++;
} else if (c == '{') {
const char *const end = strchr(footer + i + 1, '}');
int matched = 0;
if (end != NULL) {
const size_t namelen = (size_t) (end - (footer + i + 1));
size_t j;
for (j = 0; j < nfields; j++) {
if (strlen(fields[j].name) == namelen &&
strncmp(fields[j].name, footer + i + 1, namelen) == 0) {
if (htsfmt_puts(&buf,
fields[j].value != NULL ? fields[j].value : "") < 0)
return -1;
i += namelen + 1; // consume the name and its closing '}'
matched = 1;
break;
}
}
}
if (!matched && htsfmt_putc(&buf, '{') < 0)
return -1;
} else if (htsfmt_putc(&buf, c) < 0) {
return -1;
}
}
buffer[buf.offset] = '\0';
return 1;
}
/* Note: NOT utf-8 */
HTSEXT_API int hts_buildtopindex(httrackp * opt, const char *path,
const char *binpath) {

View File

@@ -73,6 +73,20 @@ HTS_INLINE int rech_tageq_all(const char *adr, const char *s);
int hts_template_format(FILE *const out, const char *format, ...);
int hts_template_format_str(char *buffer, size_t size, const char *format, ...);
// A footer named field and its already-context-escaped value.
typedef struct hts_footer_field {
const char *name;
const char *value;
} hts_footer_field;
// Expand a footer template. A "%s" in it selects the legacy positional model,
// consuming the "addr"/"path"/"date"/"version" fields in that order; otherwise
// "{name}" is substituted from fields by name ("{{"/"}}" emit a literal brace,
// an unknown "{...}" is left verbatim). Values must already be escaped for the
// target context by the caller. Returns <0 on overflow.
int hts_footer_format(char *buffer, size_t size, const char *footer,
const hts_footer_field *fields, size_t nfields);
#define rech_tageq(adr,s) \
( \
( (*((adr)-1)=='<') || (is_space(*((adr)-1))) ) ? \

866
src/htswarc.c Normal file
View File

@@ -0,0 +1,866 @@
/* ------------------------------------------------------------ */
/*
HTTrack Website Copier, Offline Browser for Windows and Unix
Copyright (C) 2026 Xavier Roche and other contributors
SPDX-License-Identifier: GPL-3.0-or-later
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Ethical use: we kindly ask that you NOT use this software to harvest email
addresses or to collect any other private information about people. Doing so
would dishonor our work and waste the many hours we have spent on it.
Please visit our Website: http://www.httrack.com
*/
/* ------------------------------------------------------------ */
/* HTTrack WARC/1.1 output writer (ISO 28500). See warc.h.
Strategy B (see design): the response record stores the decoded body and a
normalized header block (Content-Encoding/Transfer-Encoding stripped,
Content-Length rewritten to the decoded length). Valid, replayable WARC. */
/* ------------------------------------------------------------ */
#define HTS_INTERNAL_BYTECODE
#include "htswarc.h"
#include "htscore.h"
#include "htslib.h"
#include "htstools.h"
#include "htssafe.h"
#include "htszlib.h"
#include "coucal/coucal.h"
#include <stdarg.h>
#include <stdint.h>
#include <time.h>
#if HTS_USEOPENSSL
#include <openssl/evp.h>
#include <openssl/rand.h>
#endif
/* opt->state.warc value meaning "open failed once, do not retry". */
#define WARC_DISABLED ((void *) ~(uintptr_t) 0)
struct warc_writer {
FILE *f;
int gz; /* 1: one gzip member per record; 0: raw */
uint64_t offset; /* running byte offset (member starts, for a future index) */
uint64_t counter; /* monotonic record counter */
uint64_t rng; /* PRNG state for the UUID fallback */
char info_id[64]; /* warcinfo WARC-Record-ID, referenced by every record */
coucal seen; /* base32 payload digest -> "uri\001date" (revisit dedup) */
};
/* ---- growable byte buffer (overflow-safe, project allocators) ---- */
typedef struct {
char *data;
size_t len;
size_t cap;
} wbuf;
static void wbuf_free(wbuf *b) {
freet(b->data);
b->len = b->cap = 0;
}
/* Append n bytes; returns 0 on success, -1 on OOM/overflow. */
static int wbuf_add(wbuf *b, const void *p, size_t n) {
if (n > (size_t) -1 - b->len)
return -1;
if (b->len + n > b->cap) {
size_t ncap = b->cap ? b->cap : 256;
char *nd;
while (ncap < b->len + n) {
if (ncap > (size_t) -1 / 2)
return -1;
ncap *= 2;
}
nd = realloct(b->data, ncap);
if (nd == NULL)
return -1;
b->data = nd;
b->cap = ncap;
}
memcpy(b->data + b->len, p, n);
b->len += n;
return 0;
}
static int wbuf_puts(wbuf *b, const char *s) {
return wbuf_add(b, s, strlen(s));
}
static int wbuf_printf(wbuf *b, const char *fmt, ...) HTS_PRINTF_FUN(2, 3);
static int wbuf_printf(wbuf *b, const char *fmt, ...) {
char tmp[1024];
int n;
va_list ap;
va_start(ap, fmt);
n = vsnprintf(tmp, sizeof(tmp), fmt, ap);
va_end(ap);
if (n < 0 || (size_t) n >= sizeof(tmp))
return -1;
return wbuf_add(b, tmp, (size_t) n);
}
/* ---- gzip-per-record member writer (mirrors ae_write_packed) ---- */
typedef struct {
warc_writer *w;
z_stream strm;
int active; /* deflate stream initialized */
} member;
static int member_begin(member *m, warc_writer *w) {
m->w = w;
m->active = 0;
if (w->gz) {
memset(&m->strm, 0, sizeof(m->strm));
/* windowBits=31 => full RFC1952 gzip member */
if (deflateInit2(&m->strm, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
Z_DEFAULT_STRATEGY) != Z_OK)
return -1;
m->active = 1;
}
return 0;
}
static int member_write(member *m, const void *p, size_t n) {
if (!m->w->gz)
return (n == 0 || fwrite(p, 1, n, m->w->f) == n) ? 0 : -1;
m->strm.next_in = (const Bytef *) p;
while (n > 0) {
unsigned char out[8192];
size_t got;
uInt chunk = (n > (uInt) -1) ? (uInt) -1 : (uInt) n;
m->strm.avail_in = chunk;
do {
m->strm.next_out = out;
m->strm.avail_out = sizeof(out);
if (deflate(&m->strm, Z_NO_FLUSH) != Z_OK)
return -1;
got = sizeof(out) - m->strm.avail_out;
if (got > 0 && fwrite(out, 1, got, m->w->f) != got)
return -1;
} while (m->strm.avail_out == 0);
n -= chunk;
}
return 0;
}
static int member_end(member *m) {
int rc = 0;
if (m->active) {
unsigned char out[8192];
int zerr;
m->strm.avail_in = 0;
do {
m->strm.next_out = out;
m->strm.avail_out = sizeof(out);
zerr = deflate(&m->strm, Z_FINISH);
{
size_t got = sizeof(out) - m->strm.avail_out;
if (got > 0 && fwrite(out, 1, got, m->w->f) != got)
rc = -1;
}
} while (zerr == Z_OK);
if (zerr != Z_STREAM_END)
rc = -1;
deflateEnd(&m->strm);
m->active = 0;
}
return rc;
}
/* ---- SHA-1 + Base32 (digests are OpenSSL-only; omitted otherwise) ---- */
#if HTS_USEOPENSSL
/* Streaming SHA-1 over the block (all regions) and the payload (body only). */
typedef struct {
EVP_MD_CTX *block;
EVP_MD_CTX *payload;
} digester;
static void base32_20(const unsigned char in[20], char out[33]) {
static const char a[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567";
int i, o = 0;
uint64_t buf = 0;
int bits = 0;
for (i = 0; i < 20; i++) {
buf = (buf << 8) | in[i];
bits += 8;
while (bits >= 5) {
bits -= 5;
out[o++] = a[(buf >> bits) & 0x1F];
}
}
out[o] = '\0'; /* 20 bytes => exactly 32 base32 chars, no padding */
}
#endif
/* Stream a block to a sink. When http_section, the HTTP header bytes (may be
empty) plus their terminating CRLF are emitted first; the separator is bound
to http_section, not to http_hdr being non-NULL, so an empty header still
emits (and is counted in) the 2-byte separator (F3). The on-disk body is
written as EXACTLY body_len octets — capped if the file grew, zero-padded if
it shrank — so the declared Content-Length always equals the bytes written
across every pass (F2). region 0=header, 1=body. Returns 0 on success. */
typedef int (*warc_sink)(void *ctx, int region, const void *p, size_t n);
static int stream_body_pad(warc_sink sink, void *ctx, size_t remaining) {
static const char zeros[4096] = {0};
while (remaining > 0) {
size_t chunk = (remaining < sizeof(zeros)) ? remaining : sizeof(zeros);
if (sink(ctx, 1, zeros, chunk) != 0)
return -1;
remaining -= chunk;
}
return 0;
}
static int stream_block(int http_section, const char *http_hdr,
size_t http_hdr_len, int has_body, const char *body,
size_t body_len, const char *body_path, warc_sink sink,
void *ctx) {
if (http_section) {
if (http_hdr != NULL && http_hdr_len > 0 &&
sink(ctx, 0, http_hdr, http_hdr_len) != 0)
return -1;
if (sink(ctx, 0, "\r\n", 2) != 0)
return -1;
}
if (has_body) {
if (body != NULL) {
if (body_len > 0 && sink(ctx, 1, body, body_len) != 0)
return -1;
} else if (body_path != NULL) {
char catbuff[CATBUFF_SIZE];
size_t remaining = body_len;
FILE *fp = FOPEN(fconv(catbuff, sizeof(catbuff), body_path), "rb");
if (fp == NULL)
return -1;
while (remaining > 0) {
char b[32768];
size_t want = (remaining < sizeof(b)) ? remaining : sizeof(b);
size_t nl = fread(b, 1, want, fp);
if (nl == 0)
break; /* short file: pad below so written == declared */
if (sink(ctx, 1, b, nl) != 0) {
fclose(fp);
return -1;
}
remaining -= nl;
}
fclose(fp);
if (stream_body_pad(sink, ctx, remaining) != 0)
return -1;
}
}
return 0;
}
#if HTS_USEOPENSSL
static int digest_sink(void *ctx, int region, const void *p, size_t n) {
digester *d = (digester *) ctx;
if (d->block != NULL && EVP_DigestUpdate(d->block, p, n) != 1)
return -1;
if (region == 1 && d->payload != NULL &&
EVP_DigestUpdate(d->payload, p, n) != 1)
return -1;
return 0;
}
#endif
static int write_sink(void *ctx, int region, const void *p, size_t n) {
(void) region;
return member_write((member *) ctx, p, n);
}
/* Base32 SHA-1 of a transaction payload (body only), for revisit dedup.
Returns 1 and fills out[33] on success, 0 without OpenSSL or on error. */
static int payload_digest_b32(const char *body, size_t body_len,
const char *body_path, char out[33]) {
#if HTS_USEOPENSSL
digester d;
unsigned char md[EVP_MAX_MD_SIZE];
unsigned int mdlen = 0;
int ok;
d.block = NULL;
d.payload = EVP_MD_CTX_new();
if (d.payload == NULL)
return 0;
if (EVP_DigestInit_ex(d.payload, EVP_sha1(), NULL) != 1) {
EVP_MD_CTX_free(d.payload);
return 0;
}
ok = stream_block(0, NULL, 0, 1, body, body_len, body_path, digest_sink,
&d) == 0 &&
EVP_DigestFinal_ex(d.payload, md, &mdlen) == 1 && mdlen == 20;
EVP_MD_CTX_free(d.payload);
if (!ok)
return 0;
base32_20(md, out);
return 1;
#else
(void) body;
(void) body_len;
(void) body_path;
(void) out;
return 0;
#endif
}
/* ---- misc record helpers ---- */
static void warc_fill_random(warc_writer *w, unsigned char *b, size_t n) {
size_t i;
#if HTS_USEOPENSSL
if (n <= (size_t) 0x7fffffff && RAND_bytes(b, (int) n) == 1)
return;
#endif
for (i = 0; i < n; i++) {
w->rng ^= w->rng << 13;
w->rng ^= w->rng >> 7;
w->rng ^= w->rng << 17;
b[i] = (unsigned char) (w->rng >> 24);
}
}
/* urn:uuid: v4-shaped record id (uniqueness within the run is what matters). */
static void warc_make_id(warc_writer *w, char out[64]) {
unsigned char b[16];
w->counter++;
warc_fill_random(w, b, sizeof(b));
b[6] = (unsigned char) ((b[6] & 0x0F) | 0x40);
b[8] = (unsigned char) ((b[8] & 0x3F) | 0x80);
snprintf(out, 64,
"<urn:uuid:%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-"
"%02x%02x%02x%02x%02x%02x>",
b[0], b[1], b[2], b[3], b[4], b[5], b[6], b[7], b[8], b[9], b[10],
b[11], b[12], b[13], b[14], b[15]);
}
static void warc_now_iso8601(char out[32]) {
time_t t = time(NULL);
struct tm tmv;
#if defined(_WIN32)
struct tm *g = gmtime(&t);
if (g != NULL)
tmv = *g;
else
memset(&tmv, 0, sizeof(tmv));
#else
if (gmtime_r(&t, &tmv) == NULL)
memset(&tmv, 0, sizeof(tmv));
#endif
strftime(out, 32, "%Y-%m-%dT%H:%M:%SZ", &tmv);
}
/* Case-insensitive "does line start with name:" test. */
static int header_is(const char *line, size_t line_len, const char *name) {
size_t nl = strlen(name);
if (line_len < nl + 1)
return 0;
if (strncasecmp(line, name, nl) != 0)
return 0;
return line[nl] == ':';
}
/* Build the normalized HTTP header block from raw resp_hdr into out (no
trailing CRLF terminator). Always drops Transfer-Encoding (hop-by-hop).
When set_cl>=0, also drops Content-Encoding and the original Content-Length
and appends "Content-Length: <set_cl>". Returns 0 on success. */
static int normalize_http_headers(const char *resp_hdr, long long set_cl,
wbuf *out) {
const char *p = resp_hdr;
int first = 1;
if (resp_hdr == NULL)
return -1;
while (*p != '\0') {
const char *eol = strchr(p, '\n');
size_t len = (eol != NULL) ? (size_t) (eol - p) : strlen(p);
size_t raw = len;
if (len > 0 && p[len - 1] == '\r')
len--; /* strip CR; re-added as CRLF below */
if (len == 0)
break; /* blank line: end of headers */
if (first) {
first = 0; /* status line: keep verbatim */
} else if (header_is(p, len, "Transfer-Encoding")) {
goto next;
} else if (set_cl >= 0 && (header_is(p, len, "Content-Encoding") ||
header_is(p, len, "Content-Length"))) {
goto next;
}
if (wbuf_add(out, p, len) != 0 || wbuf_add(out, "\r\n", 2) != 0)
return -1;
next:
if (eol == NULL)
break;
p = eol + 1;
(void) raw;
}
if (set_cl >= 0 && wbuf_printf(out, "Content-Length: %lld\r\n", set_cl) != 0)
return -1;
return 0;
}
/* Emit one full WARC record. When http_section, the block carries an HTTP
header block (http_hdr, possibly empty) + a CRLF separator; body follows when
has_body. block_len is derived here (single source of truth: separator and
payload are counted exactly as stream_block emits them), so a declared
Content-Length can never desync from the written bytes. The payload digest
(body-only) is passed in when already known. On success the record id is
copied to out_id (may be NULL). */
static int warc_emit(warc_writer *w, const char *type, const char *content_type,
const char *target_uri, const char *ip,
const char *concurrent_to, const char *refers_uri,
const char *refers_date, const char *profile,
const char *payload_digest, int http_section,
const char *http_hdr, size_t http_hdr_len, int has_body,
const char *body, size_t body_len, const char *body_path,
char out_id[64]) {
wbuf hdr;
member m;
char id[64], date[32];
size_t sep = http_section ? 2 : 0;
size_t payload = has_body ? body_len : 0;
size_t block_len;
int rc = -1;
#if HTS_USEOPENSSL
digester d;
unsigned char md[EVP_MAX_MD_SIZE];
unsigned int mdlen = 0;
char block_b32[33];
int have_block_digest = 0;
#endif
/* F4: overflow-safe block length; http_hdr_len+sep is provably small. */
if (payload > (size_t) -1 - http_hdr_len - sep)
return -1;
block_len = http_hdr_len + sep + payload;
memset(&hdr, 0, sizeof(hdr));
warc_make_id(w, id);
warc_now_iso8601(date);
#if HTS_USEOPENSSL
/* Block digest over the whole block, in one streaming pass. */
d.block = EVP_MD_CTX_new();
d.payload = NULL;
if (d.block != NULL && EVP_DigestInit_ex(d.block, EVP_sha1(), NULL) == 1 &&
stream_block(http_section, http_hdr, http_hdr_len, has_body, body,
body_len, body_path, digest_sink, &d) == 0 &&
EVP_DigestFinal_ex(d.block, md, &mdlen) == 1 && mdlen == 20) {
base32_20(md, block_b32);
have_block_digest = 1;
}
if (d.block != NULL)
EVP_MD_CTX_free(d.block);
#endif
if (wbuf_puts(&hdr, "WARC/1.1\r\n") != 0 ||
wbuf_printf(&hdr, "WARC-Type: %s\r\n", type) != 0 ||
wbuf_printf(&hdr, "WARC-Record-ID: %s\r\n", id) != 0 ||
wbuf_printf(&hdr, "WARC-Date: %s\r\n", date) != 0)
goto done;
if (content_type != NULL &&
wbuf_printf(&hdr, "Content-Type: %s\r\n", content_type) != 0)
goto done;
if (wbuf_printf(&hdr, "Content-Length: %llu\r\n",
(unsigned long long) block_len) != 0)
goto done;
if (w->info_id[0] != '\0' && strcmp(type, "warcinfo") != 0 &&
wbuf_printf(&hdr, "WARC-Warcinfo-ID: %s\r\n", w->info_id) != 0)
goto done;
if (target_uri != NULL && target_uri[0] != '\0' &&
wbuf_printf(&hdr, "WARC-Target-URI: %s\r\n", target_uri) != 0)
goto done;
if (ip != NULL && ip[0] != '\0' &&
wbuf_printf(&hdr, "WARC-IP-Address: %s\r\n", ip) != 0)
goto done;
if (concurrent_to != NULL && concurrent_to[0] != '\0' &&
wbuf_printf(&hdr, "WARC-Concurrent-To: %s\r\n", concurrent_to) != 0)
goto done;
if (profile != NULL &&
wbuf_printf(&hdr, "WARC-Profile: %s\r\n", profile) != 0)
goto done;
if (refers_uri != NULL && refers_uri[0] != '\0' &&
wbuf_printf(&hdr, "WARC-Refers-To-Target-URI: %s\r\n", refers_uri) != 0)
goto done;
if (refers_date != NULL && refers_date[0] != '\0' &&
wbuf_printf(&hdr, "WARC-Refers-To-Date: %s\r\n", refers_date) != 0)
goto done;
#if HTS_USEOPENSSL
if (have_block_digest &&
wbuf_printf(&hdr, "WARC-Block-Digest: sha1:%s\r\n", block_b32) != 0)
goto done;
#endif
if (payload_digest != NULL && payload_digest[0] != '\0' &&
wbuf_printf(&hdr, "WARC-Payload-Digest: sha1:%s\r\n", payload_digest) !=
0)
goto done;
if (wbuf_puts(&hdr, "\r\n") != 0)
goto done;
if (member_begin(&m, w) != 0)
goto done;
if (member_write(&m, hdr.data, hdr.len) != 0 ||
stream_block(http_section, http_hdr, http_hdr_len, has_body, body,
body_len, body_path, write_sink, &m) != 0 ||
member_write(&m, "\r\n\r\n", 4) != 0) {
member_end(&m);
goto done;
}
if (member_end(&m) != 0)
goto done;
{
long pos = ftell(w->f);
if (pos >= 0)
w->offset = (uint64_t) pos;
}
if (out_id != NULL)
strlcpybuff(out_id, id, 64);
rc = 0;
done:
wbuf_free(&hdr);
return rc;
}
/* ---- request stash (engine hooks) ---- */
void warc_stash_request(htsblk *r, const char *reqhdr) {
if (r == NULL)
return;
freet(r->warc_reqhdr);
if (reqhdr != NULL)
r->warc_reqhdr = strdupt(reqhdr);
}
void warc_stash_response(htsblk *r, const char *resphdr) {
if (r == NULL)
return;
freet(r->warc_resphdr);
if (resphdr != NULL)
r->warc_resphdr = strdupt(resphdr);
}
void warc_free_request(htsblk *r) {
if (r != NULL) {
freet(r->warc_reqhdr);
freet(r->warc_resphdr);
}
}
/* ---- open / close ---- */
warc_writer *warc_open(httrackp *opt, const char *path) {
warc_writer *w;
char namebuf[HTS_URLMAXSIZE * 2];
char catbuff[CATBUFF_SIZE];
wbuf info;
const char *robots;
size_t plen;
if (path == NULL)
return NULL;
/* --warc with no name: <output>/httrack-<timestamp>.warc.gz */
if (strcmp(path, WARC_AUTONAME) == 0) {
char ts[32];
time_t t = time(NULL);
struct tm tmv;
#if defined(_WIN32)
struct tm *g = gmtime(&t);
if (g != NULL)
tmv = *g;
else
memset(&tmv, 0, sizeof(tmv));
#else
if (gmtime_r(&t, &tmv) == NULL)
memset(&tmv, 0, sizeof(tmv));
#endif
strftime(ts, sizeof(ts), "%Y%m%d%H%M%S", &tmv);
snprintf(catbuff, sizeof(catbuff), "httrack-%s.warc.gz", ts);
path =
fconcat(namebuf, sizeof(namebuf), StringBuff(opt->path_html), catbuff);
} else {
/* --warc-file NAME: append .warc.gz unless already a .warc/.warc.gz name;
place bare basenames under the output directory (like the auto name). */
size_t l = strlen(path);
int has_warc = (l >= 5 && strcasecmp(path + l - 5, ".warc") == 0);
int has_gz = (l >= 3 && strcasecmp(path + l - 3, ".gz") == 0);
char named[HTS_URLMAXSIZE];
if (has_warc || has_gz)
strlcpybuff(named, path, sizeof(named));
else
snprintf(named, sizeof(named), "%s.warc.gz", path);
if (strchr(named, '/') == NULL && strchr(named, '\\') == NULL) {
path =
fconcat(namebuf, sizeof(namebuf), StringBuff(opt->path_html), named);
} else {
strlcpybuff(namebuf, named, sizeof(namebuf));
path = namebuf;
}
}
w = calloct(1, sizeof(*w));
if (w == NULL)
return NULL;
plen = strlen(path);
w->gz = (plen >= 3 && strcasecmp(path + plen - 3, ".gz") == 0);
w->rng = (uint64_t) time(NULL) ^ ((uint64_t) (uintptr_t) w << 16) ^
0x9e3779b97f4a7c15ULL;
w->seen = coucal_new(0);
if (w->seen != NULL)
coucal_value_is_malloc(w->seen, 1);
w->f = FOPEN(fconv(catbuff, sizeof(catbuff), path), "wb");
if (w->f == NULL) {
if (w->seen != NULL)
coucal_delete(&w->seen);
freet(w);
return NULL;
}
robots = (opt->robots == HTS_ROBOTS_NEVER) ? "ignore" : "obey";
memset(&info, 0, sizeof(info));
if (wbuf_printf(&info,
"software: HTTrack/%s (+https://www.httrack.com/)\r\n"
"format: WARC file version 1.1\r\n"
"conformsTo: http://iipc.github.io/warc-specifications/"
"specifications/warc-format/warc-1.1/\r\n"
"robots: %s\r\n",
HTTRACK_VERSION, robots) != 0 ||
(StringNotEmpty(opt->path_html) &&
wbuf_printf(&info, "isPartOf: %s\r\n", StringBuff(opt->path_html)) !=
0)) {
wbuf_free(&info);
warc_close(w);
return NULL;
}
w->info_id[0] = '\0'; /* not yet known: warcinfo omits WARC-Warcinfo-ID */
if (warc_emit(w, "warcinfo", "application/warc-fields", NULL, NULL, NULL,
NULL, NULL, NULL, NULL, 0, NULL, 0, 1, info.data, info.len,
NULL, w->info_id) != 0) {
wbuf_free(&info);
warc_close(w);
return NULL;
}
wbuf_free(&info);
return w;
}
void warc_close(warc_writer *w) {
if (w == NULL)
return;
if (w->f != NULL)
fclose(w->f);
if (w->seen != NULL)
coucal_delete(&w->seen);
freet(w);
}
void warc_close_opt(httrackp *opt) {
if (opt->state.warc != NULL && opt->state.warc != WARC_DISABLED) {
warc_close((warc_writer *) opt->state.warc);
}
opt->state.warc = NULL;
}
/* ---- one transaction ---- */
int warc_write_transaction(warc_writer *w, const char *target_uri,
const char *ip, const char *req_hdr,
const char *resp_hdr, const char *body,
size_t body_len, const char *body_path,
int statuscode, int is_update_unchanged) {
wbuf http;
char resp_id[64];
char pdig[33];
int have_pdig;
int is_revisit = 0;
const char *profile = NULL;
const char *refers_uri = NULL;
const char *refers_date = NULL;
char refers_buf[HTS_URLMAXSIZE * 2 + 64];
int has_payload;
int emit_body;
int rc = -1;
if (resp_hdr == NULL)
return -1;
/* A payload exists (for digesting) unless this is a bodyless 304. */
has_payload = (body_len > 0 && (body != NULL || body_path != NULL) &&
!is_update_unchanged);
/* Payload digest drives identical-payload-digest dedup (OpenSSL only). */
have_pdig =
has_payload ? payload_digest_b32(body, body_len, body_path, pdig) : 0;
if (is_update_unchanged) {
is_revisit = 1;
profile = "http://netpreserve.org/warc/1.1/revisit/server-not-modified";
} else if (have_pdig && w->seen != NULL) {
void *prev = NULL;
if (coucal_read_pvoid(w->seen, pdig, &prev) && prev != NULL) {
char *slot = (char *) prev;
char *sep = strchr(slot, '\001');
is_revisit = 1;
profile =
"http://netpreserve.org/warc/1.1/revisit/identical-payload-digest";
if (sep != NULL) {
size_t n = (size_t) (sep - slot);
if (n < sizeof(refers_buf)) {
memcpy(refers_buf, slot, n);
refers_buf[n] = '\0';
refers_uri = refers_buf;
refers_date = sep + 1;
}
}
}
}
/* Both revisit kinds (server-304 and identical-payload-digest) are bodyless;
only a full response carries the payload (F1). */
emit_body = has_payload && !is_revisit;
/* Normalize headers: full response rewrites Content-Length to the decoded
body length and strips Content-Encoding; a revisit keeps them (no body). */
memset(&http, 0, sizeof(http));
if (normalize_http_headers(resp_hdr, emit_body ? (long long) body_len : -1,
&http) != 0) {
wbuf_free(&http);
return -1;
}
/* Response first: its id links the request via WARC-Concurrent-To. */
resp_id[0] = '\0';
if (warc_emit(w, is_revisit ? "revisit" : "response",
"application/http;msgtype=response", target_uri, ip, NULL,
refers_uri, refers_date, profile, have_pdig ? pdig : NULL, 1,
http.data, http.len, emit_body, body, body_len, body_path,
resp_id) != 0) {
wbuf_free(&http);
return -1;
}
wbuf_free(&http);
if (req_hdr != NULL && req_hdr[0] != '\0') {
size_t rlen = strlen(req_hdr);
if (warc_emit(w, "request", "application/http;msgtype=request", target_uri,
NULL, resp_id, NULL, NULL, NULL, NULL, 0, NULL, 0, 1, req_hdr,
rlen, NULL, NULL) != 0)
return -1;
}
/* Record this payload for later identical-payload-digest revisits. */
if (!is_revisit && have_pdig && w->seen != NULL && target_uri != NULL) {
char date[32];
char *slot;
size_t need;
warc_now_iso8601(date);
need = strlen(target_uri) + 1 + strlen(date) + 1;
slot = malloct(need);
if (slot != NULL) {
snprintf(slot, need, "%s\001%s", target_uri, date);
if (coucal_write_pvoid(w->seen, pdig, slot) == 0) {
/* replaced an existing entry: coucal freed the old value */
}
}
}
(void) statuscode;
rc = 0;
return rc;
}
/* ---- engine emit hook ---- */
void warc_write_backtransaction(httrackp *opt, lien_back *back) {
warc_writer *w;
char uri[HTS_URLMAXSIZE * 4 + 16];
char ip[128];
const char *body;
size_t body_len;
const char *body_path;
const char *resp_hdr;
char synth[512];
int is_unchanged;
if (opt->state.warc == WARC_DISABLED)
return;
if (opt->state.warc == NULL) {
w = warc_open(opt, StringBuff(opt->warc_file));
if (w == NULL) {
opt->state.warc = WARC_DISABLED;
hts_log_print(opt, LOG_ERROR, "could not create WARC archive %s",
StringBuff(opt->warc_file));
return;
}
opt->state.warc = w;
}
w = (warc_writer *) opt->state.warc;
if (back->r.statuscode <= 0)
return;
snprintf(uri, sizeof(uri), "%s%s%s",
link_has_authority(back->url_adr) ? "" : "http://", back->url_adr,
back->url_fil);
ip[0] = '\0';
SOCaddr_inetntoa(ip, sizeof(ip), back->r.address);
if (!back->r.is_write) {
body = back->r.adr;
body_len = (back->r.size > 0) ? (size_t) back->r.size : 0;
body_path = NULL;
} else {
LLint fs;
body = NULL;
body_path = back->url_sav;
fs = fsize_utf8(body_path);
/* F4: an on-disk body past size_t (LLP32/ILP32, >4GB) would wrap the length
used as Content-Length; drop the body rather than desync the record. */
if (fs > 0 && (uint64_t) fs <= (uint64_t) (size_t) -1)
body_len = (size_t) fs;
else
body_len = 0;
}
is_unchanged = (back->r.notmodified && opt->is_update) ? 1 : 0;
/* Prefer the stashed raw headers; synthesize a minimal status line for the
header-less (HTTP/0.9-style) responses that never carried a header block.
*/
resp_hdr = back->r.warc_resphdr;
if (resp_hdr == NULL) {
snprintf(synth, sizeof(synth), "HTTP/1.1 %d %s\r\nContent-Type: %s\r\n\r\n",
back->r.statuscode, back->r.msg[0] ? back->r.msg : "OK",
back->r.contenttype[0] ? back->r.contenttype
: "application/octet-stream");
resp_hdr = synth;
}
warc_write_transaction(w, uri, ip, back->r.warc_reqhdr, resp_hdr, body,
body_len, body_path, back->r.statuscode, is_unchanged);
}

98
src/htswarc.h Normal file
View File

@@ -0,0 +1,98 @@
/* ------------------------------------------------------------ */
/*
HTTrack Website Copier, Offline Browser for Windows and Unix
Copyright (C) 2026 Xavier Roche and other contributors
SPDX-License-Identifier: GPL-3.0-or-later
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Ethical use: we kindly ask that you NOT use this software to harvest email
addresses or to collect any other private information about people. Doing so
would dishonor our work and waste the many hours we have spent on it.
Please visit our Website: http://www.httrack.com
*/
/* ------------------------------------------------------------ */
/* HTTrack WARC/1.1 output writer (ISO 28500). Internal, not installed.
All WARC record serialization, gzip-member framing, digests, UUID and
revisit dedup live here; the engine only stashes the request, frees it,
and calls one entry point per finished transaction. */
/* ------------------------------------------------------------ */
#ifndef HTS_WARC_DEFH
#define HTS_WARC_DEFH
#include "htsopt.h"
#ifdef __cplusplus
extern "C" {
#endif
/* opt->warc_file sentinel: --warc with no argument => auto-name the archive
under the project's output directory at open time. */
#define WARC_AUTONAME "\001auto"
typedef struct warc_writer warc_writer;
/* Stash the raw request header block (bstr.buffer) on r for the later WARC
request record; frees any prior stash. No-op when reqhdr is NULL. */
void warc_stash_request(htsblk *r, const char *reqhdr);
/* Stash the raw response header block: deletehttp frees r.headers when the
socket closes, before back_finalize, so keep a WARC-owned copy. */
void warc_stash_response(htsblk *r, const char *resphdr);
/* Free both stashed header blocks (idempotent, NULL-safe). */
void warc_free_request(htsblk *r);
/* Emit the request + response (or revisit) records for one finished
transaction. Lazily opens the writer into opt->state.warc; a no-op (logged
once) if the archive cannot be created. */
void warc_write_backtransaction(httrackp *opt, lien_back *back);
/* Close and free the writer held in opt->state.warc, if any. */
void warc_close_opt(httrackp *opt);
/* --- Direct writer API (used by the hooks above and the self-test). --- */
/* Create the archive at path (auto-named when path is WARC_AUTONAME), writing
the warcinfo record. .warc.gz => one gzip member per record; .warc => raw.
Returns NULL on failure. */
warc_writer *warc_open(httrackp *opt, const char *path);
/* Flush, close and free the writer (NULL-safe). */
void warc_close(warc_writer *w);
/* Write one transaction's request + response (or revisit) records.
target_uri: absolute URL fetched.
ip: numeric peer IP, or NULL/"" to omit.
req_hdr: exact request header block sent, or NULL to skip the request.
resp_hdr: raw received response header block (status line + headers).
body/body_len: decoded in-memory body, or NULL when on disk.
body_path: file re-read for the body when body==NULL (may be NULL).
is_update_unchanged: nonzero for a 304 server-not-modified revisit.
Returns 0 on success, -1 on error. */
int warc_write_transaction(warc_writer *w, const char *target_uri,
const char *ip, const char *req_hdr,
const char *resp_hdr, const char *body,
size_t body_len, const char *body_path,
int statuscode, int is_update_unchanged);
#ifdef __cplusplus
}
#endif
#endif

View File

@@ -135,6 +135,7 @@
<ClCompile Include="htswizard.c" />
<ClCompile Include="htswrap.c" />
<ClCompile Include="htszlib.c" />
<ClCompile Include="htswarc.c" />
<ClCompile Include="md5.c" />
<ClCompile Include="minizip\ioapi.c" />
<ClCompile Include="minizip\iowin32.c" />

View File

@@ -0,0 +1,56 @@
#!/bin/bash
#
# Keep this POSIX-portable: the harness runs it via $(BASH), which is a plain
# POSIX /bin/sh on some platforms (e.g. macOS), so avoid bashisms despite the
# #!/bin/bash above.
# A -%F footer whose expansion overflows the on-page buffer must be dropped, not
# crash the crawl. Before the fix the unchecked hts_footer_format return left the
# buffer unterminated and the next strcatbuff aborted (SIGABRT).
set -eu
# The overflow needs a path longer than Windows MAX_PATH (260), so both the
# source tree and the mirror output blow past it there; run on POSIX only. The
# fix itself is platform-independent and covered on Linux/macOS.
case "$(uname -s 2>/dev/null)" in
MINGW* | MSYS* | CYGWIN*) exit 77 ;;
esac
dir=$(mktemp -d)
trap 'rm -rf "$dir"' EXIT
# A few-hundred-char file path (kept well under the URL length limit) makes the
# {path} field long.
seg=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
deep="$dir"
i=0
while [ "$i" -lt 6 ]; do
deep="$deep/$seg"
i=$((i + 1))
done
mkdir -p "$deep"
printf '<html><body>hi</body></html>' >"$deep/index.html"
# 40 {path} references (~240 chars, under the 254-char -%F cap); expanded against
# a few-hundred-char path this far exceeds the per-page footer buffer.
footer=""
i=0
while [ "$i" -lt 40 ]; do
footer="$footer{path}"
i=$((i + 1))
done
mir="$dir/mir"
httrack "file://$deep/index.html" -O "$mir" -%F "$footer" -q -s0 -%v0 \
>/dev/null 2>&1 || {
echo "crawl failed/aborted (exit $?) on an oversized footer" >&2
exit 1
}
# The crawled page must exist (proves the URL wasn't rejected for length, so the
# footer path ran). Look under file/, not $mir, to skip the makeindex top index.
find "$mir/file" -name index.html | grep -q . || {
echo "page not mirrored; the oversized-footer path was not exercised" >&2
exit 1
}

42
tests/01_engine-footerfmt.test Executable file
View File

@@ -0,0 +1,42 @@
#!/bin/bash
#
set -euo pipefail
# -%F footer expansion (hts_footer_format via -#test=footerfmt). Fixed fields:
# addr=host.example path=/dir/page.html date=DATE version=VER.
ftr() {
out="$(httrack -O /dev/null -#test=footerfmt "$1")"
test "$out" == "$2" || {
echo "FAIL: '$1' -> '$out' (want '$2')"
exit 1
}
}
# Legacy positional model: a template with %s keeps the historic addr/path/date
# order byte-for-byte (backward compatibility).
ftr '<!-- Mirrored from %s%s by X, %s -->' \
'<!-- Mirrored from host.example/dir/page.html by X, DATE -->'
# Legacy arg overflow past the four fields yields the historic "???" marker.
ftr 'a %s b %s c %s d %s e %s' 'a host.example b /dir/page.html c DATE d VER e ???'
# Legacy %% is a literal percent; an unknown %x passes through verbatim.
ftr '100%% %d %s' '100% %d host.example'
# Named model (no %s): fields substitute by name, in any order or subset.
ftr '{addr}{path} {version} {date}' 'host.example/dir/page.html VER DATE'
ftr 'built {date}' 'built DATE'
# A literal char abutting a field's '}' survives (guards the index advance).
ftr '{date}!{addr}' 'DATE!host.example'
# {{ and }} escape to a literal brace.
ftr 'a {{ b }} {addr}' 'a { b } host.example'
# Unknown, empty, or unterminated braces are emitted verbatim (typos stay visible).
ftr '{bogus} {} {addr' '{bogus} {} {addr'
# A literal percent is untouched in named mode (no positional interpretation).
ftr '100% {path}' '100% /dir/page.html'
# %s anywhere forces legacy mode, so a mixed template leaves {addr} literal.
ftr '{addr} %s' '{addr} host.example'
# The added named fields (url, lastmodified, mime, charset, status, size).
ftr '{url}' 'http://host.example/dir/page.html'
ftr 'src {lastmodified}, got {date}' 'src LASTMOD, got DATE'
ftr '{mime}; {charset}; {status}; {size}' 'text/html; utf-8; 200; 1234'

19
tests/01_zlib-warc.test Executable file
View File

@@ -0,0 +1,19 @@
#!/bin/bash
#
set -euo pipefail
# WARC/1.1 writer self-test: framing, Content-Length, gzip members, round-trip,
# and identical-payload-digest revisit dedup, over synthetic transactions.
httrack_bin=$(cd "$(dirname "$(command -v httrack)")" && pwd)/httrack
scratch=$(mktemp -d)
trap 'rm -rf "$scratch"' EXIT
out=$("$httrack_bin" -O /dev/null -#test=warc "$scratch/")
echo "$out"
case "$out" in
*": OK") ;;
*) exit 1 ;;
esac

21
tests/73_local-warc.test Executable file
View File

@@ -0,0 +1,21 @@
#!/bin/bash
#
# A --warc crawl writes a standards-conformant WARC/1.1 archive, and an
# --update re-crawl of an unchanged (all-304) site emits revisit records.
# The stdlib validator (no warcio) is the real gate: it byte-compares the
# fresh page.html response body against what the server served, asserts the
# encoding headers were stripped and the payload digest matches, then checks
# the update pass turned the unchanged assets into revisits (no full response).
set -eu
: "${top_srcdir:=..}"
# page.html body served by tests/local-server.py (route_mini304_page).
export WARC_VALIDATE_BODY="page.html=3c68746d6c3e3c626f64793e74696e7920636163686561626c6520706167653c2f626f64793e3c2f68746d6c3e0a"
export WARC_VALIDATE_NORESP="index.html page.html"
bash "$top_srcdir/tests/local-crawl.sh" --errors 0 --rerun --warc-validate \
--log-found 'no files updated' \
--found 'mini304/index.html' --found 'mini304/page.html' \
httrack 'BASEURL/mini304/index.html' --warc-file warc-out

View File

@@ -3,7 +3,7 @@
# silently drop it from the dist tarball and break "make distcheck".
EXTRA_DIST = $(TESTS) crawl-test.sh run-all-tests.sh check-network.sh \
proxy-https-server.py socks5-server.py proxy-connect-server.py \
proxytestlib.py tls-stall-server.py \
proxytestlib.py tls-stall-server.py warc-validate.py \
local-crawl.sh local-server.py testlib.sh server.crt server.key \
server-root/simple/basic.html server-root/simple/link.html \
server-root/stripquery/index.html server-root/stripquery/a.html \
@@ -38,6 +38,8 @@ TESTS = \
01_engine-dnstimeout.test \
01_engine-doitlog.test \
01_engine-entities.test \
01_engine-footerfmt.test \
01_engine-footer-overflow.test \
01_engine-filelist.test \
01_engine-filter.test \
01_engine-filterdual.test \
@@ -78,6 +80,7 @@ TESTS = \
01_engine-version-macros.test \
01_engine-xfread.test \
01_zlib-acceptencoding.test \
01_zlib-warc.test \
01_zlib-contentcodings.test \
01_zlib-cache.test \
01_zlib-cache-corrupt.test \
@@ -153,6 +156,7 @@ TESTS = \
68_webhttrack-outdir-charset.test \
69_local-intl-logdir.test \
71_local-crange-repaircache.test \
72_watchdog-crawl.test
72_watchdog-crawl.test \
73_local-warc.test
CLEANFILES = check-network_sh.cache

View File

@@ -47,6 +47,7 @@ key="${testdir}/server.key"
tls=
verbose=
warc_validate=
html_subdir=
outdir_intl=
rerun=
@@ -114,6 +115,8 @@ while test "$pos" -lt "$nargs"; do
--debug) verbose=1 ;;
--rerun) rerun=1 ;; # run httrack a second time (update pass) before auditing
--rerun-dead) rerun_dead=1 ;; # re-run with the server stopped (cache rollback)
# validate the produced .warc.gz (see the validation block near the end)
--warc-validate) warc_validate=1 ;;
--no-purge)
nopurge=1
audit+=("--no-purge")
@@ -183,16 +186,12 @@ debug "starting $python $server ${serverargs[*]}"
"$python" "$(nativepath "$server")" "${serverargs[@]}" >"$serverlog" 2>&1 &
serverpid=$!
# Wait for the "PORT <n>" line (server prints it once bound).
# Wait for the "PORT <n>" line (server prints it once bound). A cold Python
# start under a parallel `make check -jN` can lag past a second on a loaded Windows runner.
port=
for _ in $(seq 1 50); do
if test -s "$serverlog"; then
line=$(head -n1 "$serverlog")
if test "${line%% *}" == "PORT"; then
port="${line#PORT }"
break
fi
fi
for _ in $(seq 1 300); do
# Match anywhere: a startup warning merged via 2>&1 could precede the PORT line.
line=$(grep -m1 '^PORT ' "$serverlog" 2>/dev/null) && port="${line#PORT }" && break
kill -0 "$serverpid" 2>/dev/null || die "server exited early: $(cat "$serverlog")"
sleep 0.1
done
@@ -263,6 +262,13 @@ test "$crawlres" -eq 0 || ! result "httrack exited $crawlres" || {
result "OK"
grep -iE "^[0-9:]*[[:space:]]Error:" "${logroot}/hts-log.txt" >&2
# Snapshot the first-pass WARC before an update pass overwrites it: the fresh
# crawl carries the full response bodies, the update pass only revisits.
if test -n "$warc_validate"; then
w1=$(find "$mirrorroot" -maxdepth 2 -name '*.warc.gz' 2>/dev/null | sort | tail -n1)
test -z "$w1" || cp "$w1" "${tmpdir}/warc-pass1.gz"
fi
# --- optional second pass: re-mirror into the same dir (cache/update path) ----
if test -n "$rerun"; then
info "re-running httrack (update pass)"
@@ -354,6 +360,44 @@ done
test -n "$hostroot" || die "could not find host root under $out"
debug "host root: $hostroot"
# --- optional WARC validation (stdlib validator, no warcio) ------------------
# WARC_VALIDATE_BODY="URLSUB=HEX" byte-checks a fresh-crawl response body;
# WARC_VALIDATE_NORESP="URLSUB..." asserts those assets are revisits post-update.
if test -n "$warc_validate"; then
validator=$(nativepath "${testdir}/warc-validate.py")
warc=$(find "$mirrorroot" -maxdepth 2 \( -name '*.warc.gz' -o -name '*.warc' \) 2>/dev/null | sort | tail -n1)
test -n "$warc" || die "no WARC file produced under $mirrorroot"
# Fresh-crawl file (snapshot if an update pass overwrote it): full responses.
fresh="${tmpdir}/warc-pass1.gz"
test -f "$fresh" || fresh="$warc"
declare -a bodyargs=()
if test -n "${WARC_VALIDATE_BODY:-}"; then
bodyargs=(--expect-body-hex "$WARC_VALIDATE_BODY")
fi
info "validating fresh WARC (response bodies)"
"$python" "$validator" "$(nativepath "$fresh")" "${bodyargs[@]}" >&2 ||
die "fresh WARC validation failed"
result "OK"
# Final file: after an update pass the unchanged assets must be revisits.
if test -n "$rerun"; then
declare -a revargs=(--expect-revisit)
for sub in ${WARC_VALIDATE_NORESP:-}; do
revargs+=(--no-response-for "$sub")
done
info "validating update WARC (revisits)"
"$python" "$validator" "$(nativepath "$warc")" "${revargs[@]}" >&2 ||
die "update WARC validation failed"
result "OK"
fi
if command -v warcio >/dev/null 2>&1; then
info "warcio check (optional)"
if warcio check -v "$warc" >&2; then result "OK"; else die "warcio check failed"; fi
fi
fi
# No crawl, even a cancelled one, may leave engine temporaries: .delayed (#107,
# #483), or the .z/.u content-coding temps (#557).
info "checking for leftover engine temporaries"

136
tests/warc-validate.py Executable file
View File

@@ -0,0 +1,136 @@
#!/usr/bin/env python3
# Structural + semantic WARC/1.1 validator, Python stdlib only (no warcio):
# walks the concatenated gzip members with zlib (gzip.decompress would fuse them
# and lose per-record boundaries) and checks each record against the spec.
#
# Options:
# --expect-revisit at least one revisit record must be present
# --expect-body-hex SUB=HEX a response whose WARC-Target-URI contains SUB must
# have an entity body byte-equal to bytes.fromhex(HEX),
# no Content-Encoding/Transfer-Encoding header, and a
# WARC-Payload-Digest matching sha1(body) when present
# --no-response-for SUB the asset containing SUB must be a revisit: no
# response may target it, and a revisit must
import base64
import hashlib
import sys
import zlib
def records(data):
"""Yield each record's decompressed bytes (one gzip member per record)."""
if data[:2] != b"\x1f\x8b": # uncompressed .warc: split on the record magic
parts = data.split(b"WARC/1.")
for p in parts[1:]:
yield b"WARC/1." + p
return
while data:
d = zlib.decompressobj(zlib.MAX_WBITS | 16)
block = d.decompress(data) + d.flush()
yield block
data = d.unused_data
def field(header, name):
for line in header.split(b"\r\n"):
if line.lower().startswith(name.lower() + b":"):
return line.split(b":", 1)[1].strip()
return None
def opt_values(argv, name):
out = []
for i, a in enumerate(argv):
if a == name and i + 1 < len(argv):
out.append(argv[i + 1])
return out
def check_body(rec, http_hdr, body, sub, want):
if b"Content-Encoding" in http_hdr or b"Transfer-Encoding" in http_hdr:
sys.exit("record for %s kept a content/transfer-encoding header" % sub)
if body != want:
sys.exit(
"body mismatch for %s: got %d bytes, expected %d"
% (sub, len(body), len(want))
)
pd = field(rec[: rec.find(b"\r\n\r\n")], b"WARC-Payload-Digest")
if pd is not None and pd.startswith(b"sha1:"):
want_b32 = base64.b32encode(hashlib.sha1(want).digest()).decode("ascii")
if pd[5:].decode("ascii") != want_b32:
sys.exit("WARC-Payload-Digest mismatch for %s" % sub)
def main():
argv = sys.argv[1:]
expect_revisit = "--expect-revisit" in argv
body_specs = [s.split("=", 1) for s in opt_values(argv, "--expect-body-hex")]
no_resp = opt_values(argv, "--no-response-for")
path = [a for a in argv if not a.startswith("--") and "=" not in a][0]
data = open(path, "rb").read()
total = revisits = responses = infos = 0
body_hits = {sub: False for sub, _ in body_specs}
revisit_hits = {sub: False for sub in no_resp}
for rec in records(data):
total += 1
if not rec.startswith(b"WARC/1."):
sys.exit("record %d: bad magic %r" % (total, rec[:16]))
sep = rec.find(b"\r\n\r\n")
if sep < 0:
sys.exit("record %d: no header terminator" % total)
hdr_end = sep + 4
header = rec[:sep]
cl = field(header, b"Content-Length")
if cl is None:
sys.exit("record %d: no Content-Length" % total)
block_len = int(cl)
if hdr_end + block_len + 4 != len(rec):
sys.exit(
"record %d: Content-Length %d != block length %d"
% (total, block_len, len(rec) - hdr_end - 4)
)
if rec[hdr_end + block_len :] != b"\r\n\r\n":
sys.exit("record %d: missing \\r\\n\\r\\n trailer" % total)
wtype = field(header, b"WARC-Type")
uri = field(header, b"WARC-Target-URI") or b""
if wtype == b"warcinfo":
infos += 1
elif wtype == b"response":
responses += 1
for sub in no_resp:
if sub.encode() in uri:
sys.exit("unexpected full response for %s (want revisit)" % sub)
block = rec[hdr_end : hdr_end + block_len]
bsep = block.find(b"\r\n\r\n")
http_hdr, body = block[:bsep], block[bsep + 4 :]
for sub, hexval in body_specs:
if sub.encode() in uri:
check_body(rec, http_hdr, body, sub, bytes.fromhex(hexval))
body_hits[sub] = True
elif wtype == b"revisit":
revisits += 1
for sub in no_resp:
if sub.encode() in uri:
revisit_hits[sub] = True
if total < 1:
sys.exit("no records found")
if infos != 1:
sys.exit("expected exactly one warcinfo record, got %d" % infos)
if expect_revisit and revisits < 1:
sys.exit("expected at least one revisit record, found none")
for sub, hit in body_hits.items():
if not hit:
sys.exit("no response record found for --expect-body-hex %s" % sub)
for sub, hit in revisit_hits.items():
if not hit:
sys.exit("no revisit record found for unchanged asset %s" % sub)
print(
"warc-validate: %d records OK (%d response, %d revisit)"
% (total, responses, revisits)
)
if __name__ == "__main__":
main()

View File

@@ -46,9 +46,12 @@ cat >"$stubdir/x-www-browser" <<EOF
echo "stub browser invoked with: \$1" >&2
# Also fetch an option page and require a rendered title='' tooltip: proves the
# option template expands and the \${html:} filter escapes into the attribute.
# option9 additionally proves the WARC control renders with its expanded label.
opturl="\${1%/}/server/option2.html"
warcurl="\${1%/}/server/option9.html"
if body="\$(curl -fsSL --max-time 20 "\$1")" && printf '%s' "\$body" | grep -qai httrack && printf '%s' "\$body" | grep -qaF step2.html &&
opt="\$(curl -fsSL --max-time 20 "\$opturl")" && printf '%s' "\$opt" | grep -qaF "title='"; then
opt="\$(curl -fsSL --max-time 20 "\$opturl")" && printf '%s' "\$opt" | grep -qaF "title='" &&
warc="\$(curl -fsSL --max-time 20 "\$warcurl")" && printf '%s' "\$warc" | grep -qaF 'name="warcfile"' && printf '%s' "\$warc" | grep -qaF WARC; then
echo PASS >"$marker"
else
echo "FAIL: unexpected response from \$1" >"$marker"