4 * Copyright 2005 James Hawkins
5 * Copyright 2007 Jacek Caban
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
27 #include "wine/debug.h"
29 WINE_DEFAULT_DEBUG_CHANNEL(htmlhelp
);
31 /* Reads a string from the #STRINGS section in the CHM file */
32 static LPCSTR
GetChmString(CHMInfo
*chm
, DWORD offset
)
36 if(!chm
->strings_stream
)
39 if(chm
->strings_size
<= (offset
>> BLOCK_BITS
)) {
40 chm
->strings_size
= (offset
>> BLOCK_BITS
)+1;
42 chm
->strings
= heap_realloc_zero(chm
->strings
,
43 chm
->strings_size
*sizeof(char*));
45 chm
->strings
= heap_alloc_zero(
46 chm
->strings_size
*sizeof(char*));
50 if(!chm
->strings
[offset
>> BLOCK_BITS
]) {
55 pos
.QuadPart
= offset
& ~BLOCK_MASK
;
56 hres
= IStream_Seek(chm
->strings_stream
, pos
, STREAM_SEEK_SET
, NULL
);
58 WARN("Seek failed: %08x\n", hres
);
62 chm
->strings
[offset
>> BLOCK_BITS
] = heap_alloc(BLOCK_SIZE
);
64 hres
= IStream_Read(chm
->strings_stream
, chm
->strings
[offset
>> BLOCK_BITS
],
67 WARN("Read failed: %08x\n", hres
);
68 heap_free(chm
->strings
[offset
>> BLOCK_BITS
]);
69 chm
->strings
[offset
>> BLOCK_BITS
] = NULL
;
74 str
= chm
->strings
[offset
>> BLOCK_BITS
] + (offset
& BLOCK_MASK
);
75 TRACE("offset %#x => %s\n", offset
, debugstr_a(str
));
79 static BOOL
ReadChmSystem(CHMInfo
*chm
)
82 DWORD ver
=0xdeadbeef, read
, buf_size
;
91 static const WCHAR wszSYSTEM
[] = {'#','S','Y','S','T','E','M',0};
93 hres
= IStorage_OpenStream(chm
->pStorage
, wszSYSTEM
, NULL
, STGM_READ
, 0, &stream
);
95 WARN("Could not open #SYSTEM stream: %08x\n", hres
);
99 IStream_Read(stream
, &ver
, sizeof(ver
), &read
);
100 TRACE("version is %x\n", ver
);
102 buf
= heap_alloc(8*sizeof(DWORD
));
103 buf_size
= 8*sizeof(DWORD
);
106 hres
= IStream_Read(stream
, &entry
, sizeof(entry
), &read
);
110 if(entry
.len
> buf_size
)
111 buf
= heap_realloc(buf
, buf_size
=entry
.len
);
113 hres
= IStream_Read(stream
, buf
, entry
.len
, &read
);
119 TRACE("TOC is %s\n", debugstr_an(buf
, entry
.len
));
120 heap_free(chm
->defToc
);
121 chm
->defToc
= strdupnAtoW(buf
, entry
.len
);
124 TRACE("Default topic is %s\n", debugstr_an(buf
, entry
.len
));
125 heap_free(chm
->defTopic
);
126 chm
->defTopic
= strdupnAtoW(buf
, entry
.len
);
129 TRACE("Title is %s\n", debugstr_an(buf
, entry
.len
));
130 heap_free(chm
->defTitle
);
131 chm
->defTitle
= strdupnAtoW(buf
, entry
.len
);
134 /* TODO: Currently only the Locale ID is loaded from this field */
135 TRACE("Locale is: %d\n", *(LCID
*)&buf
[0]);
136 if(!GetLocaleInfoW(*(LCID
*)&buf
[0], LOCALE_IDEFAULTANSICODEPAGE
|LOCALE_RETURN_NUMBER
,
137 (WCHAR
*)&chm
->codePage
, sizeof(chm
->codePage
)/sizeof(WCHAR
)))
138 chm
->codePage
= CP_ACP
;
141 TRACE("Window name is %s\n", debugstr_an(buf
, entry
.len
));
142 chm
->defWindow
= strdupnAtoW(buf
, entry
.len
);
145 TRACE("Compiled file is %s\n", debugstr_an(buf
, entry
.len
));
146 heap_free(chm
->compiledFile
);
147 chm
->compiledFile
= strdupnAtoW(buf
, entry
.len
);
150 TRACE("Version is %s\n", debugstr_an(buf
, entry
.len
));
153 TRACE("Time is %08x\n", *(DWORD
*)buf
);
156 TRACE("Number of info types: %d\n", *(DWORD
*)buf
);
159 TRACE("Check sum: %x\n", *(DWORD
*)buf
);
162 TRACE("unhandled code %x, size %x\n", entry
.code
, entry
.len
);
167 IStream_Release(stream
);
169 return SUCCEEDED(hres
);
172 LPWSTR
FindContextAlias(CHMInfo
*chm
, DWORD index
)
180 static const WCHAR wszIVB
[] = {'#','I','V','B',0};
182 hres
= IStorage_OpenStream(chm
->pStorage
, wszIVB
, NULL
, STGM_READ
, 0, &ivb_stream
);
184 WARN("Could not open #IVB stream: %08x\n", hres
);
188 hres
= IStream_Read(ivb_stream
, &size
, sizeof(size
), &read
);
190 WARN("Read failed: %08x\n", hres
);
191 IStream_Release(ivb_stream
);
195 buf
= heap_alloc(size
);
196 hres
= IStream_Read(ivb_stream
, buf
, size
, &read
);
197 IStream_Release(ivb_stream
);
199 WARN("Read failed: %08x\n", hres
);
204 size
/= 2*sizeof(DWORD
);
206 for(i
=0; i
<size
; i
++) {
207 if(buf
[2*i
] == index
) {
208 ret
= GetChmString(chm
, buf
[2*i
+1]);
215 TRACE("returning %s\n", debugstr_a(ret
));
216 return strdupAtoW(ret
);
220 * Tests if the file <chmfile>.<ext> exists, used for loading Indices, Table of Contents, etc.
221 * when these files are not available from the HH_WINTYPE structure.
223 static WCHAR
*FindHTMLHelpSetting(HHInfo
*info
, const WCHAR
*extW
)
225 static const WCHAR periodW
[] = {'.',0};
226 IStorage
*pStorage
= info
->pCHMInfo
->pStorage
;
231 filename
= heap_alloc( (strlenW(info
->pCHMInfo
->compiledFile
)
232 + strlenW(periodW
) + strlenW(extW
) + 1) * sizeof(WCHAR
) );
233 strcpyW(filename
, info
->pCHMInfo
->compiledFile
);
234 strcatW(filename
, periodW
);
235 strcatW(filename
, extW
);
236 hr
= IStorage_OpenStream(pStorage
, filename
, NULL
, STGM_READ
, 0, &pStream
);
240 return strdupAtoW("");
242 IStream_Release(pStream
);
246 static inline WCHAR
*MergeChmString(LPCWSTR src
, WCHAR
**dst
)
253 void MergeChmProperties(HH_WINTYPEW
*src
, HHInfo
*info
, BOOL override
)
255 DWORD unhandled_params
= src
->fsValidMembers
& ~(HHWIN_PARAM_PROPERTIES
|HHWIN_PARAM_STYLES
256 |HHWIN_PARAM_EXSTYLES
|HHWIN_PARAM_RECT
|HHWIN_PARAM_NAV_WIDTH
257 |HHWIN_PARAM_SHOWSTATE
|HHWIN_PARAM_INFOTYPES
|HHWIN_PARAM_TB_FLAGS
258 |HHWIN_PARAM_EXPANSION
|HHWIN_PARAM_TABPOS
|HHWIN_PARAM_TABORDER
259 |HHWIN_PARAM_HISTORY_COUNT
|HHWIN_PARAM_CUR_TAB
);
260 HH_WINTYPEW
*dst
= &info
->WinType
;
261 DWORD merge
= override
? src
->fsValidMembers
: src
->fsValidMembers
& ~dst
->fsValidMembers
;
263 if (unhandled_params
)
264 FIXME("Unsupported fsValidMembers fields: 0x%x\n", unhandled_params
);
266 dst
->fsValidMembers
|= merge
;
267 if (dst
->cbStruct
== 0)
269 /* If the structure has not been filled in yet then use all of the values */
270 dst
->cbStruct
= sizeof(HH_WINTYPEW
);
273 if (merge
& HHWIN_PARAM_PROPERTIES
) dst
->fsWinProperties
= src
->fsWinProperties
;
274 if (merge
& HHWIN_PARAM_STYLES
) dst
->dwStyles
= src
->dwStyles
;
275 if (merge
& HHWIN_PARAM_EXSTYLES
) dst
->dwExStyles
= src
->dwExStyles
;
276 if (merge
& HHWIN_PARAM_RECT
) dst
->rcWindowPos
= src
->rcWindowPos
;
277 if (merge
& HHWIN_PARAM_NAV_WIDTH
) dst
->iNavWidth
= src
->iNavWidth
;
278 if (merge
& HHWIN_PARAM_SHOWSTATE
) dst
->nShowState
= src
->nShowState
;
279 if (merge
& HHWIN_PARAM_INFOTYPES
) dst
->paInfoTypes
= src
->paInfoTypes
;
280 if (merge
& HHWIN_PARAM_TB_FLAGS
) dst
->fsToolBarFlags
= src
->fsToolBarFlags
;
281 if (merge
& HHWIN_PARAM_EXPANSION
) dst
->fNotExpanded
= src
->fNotExpanded
;
282 if (merge
& HHWIN_PARAM_TABPOS
) dst
->tabpos
= src
->tabpos
;
283 if (merge
& HHWIN_PARAM_TABORDER
) memcpy(dst
->tabOrder
, src
->tabOrder
, sizeof(src
->tabOrder
));
284 if (merge
& HHWIN_PARAM_HISTORY_COUNT
) dst
->cHistory
= src
->cHistory
;
285 if (merge
& HHWIN_PARAM_CUR_TAB
) dst
->curNavType
= src
->curNavType
;
288 * Note: We assume that hwndHelp, hwndCaller, hwndToolBar, hwndNavigation, and hwndHTML cannot be
289 * modified by the user. rcHTML and rcMinSize are not currently supported, so don't bother to copy them.
292 dst
->pszType
= MergeChmString(src
->pszType
, &info
->stringsW
.pszType
);
293 dst
->pszFile
= MergeChmString(src
->pszFile
, &info
->stringsW
.pszFile
);
294 dst
->pszToc
= MergeChmString(src
->pszToc
, &info
->stringsW
.pszToc
);
295 dst
->pszIndex
= MergeChmString(src
->pszIndex
, &info
->stringsW
.pszIndex
);
296 dst
->pszCaption
= MergeChmString(src
->pszCaption
, &info
->stringsW
.pszCaption
);
297 dst
->pszHome
= MergeChmString(src
->pszHome
, &info
->stringsW
.pszHome
);
298 dst
->pszJump1
= MergeChmString(src
->pszJump1
, &info
->stringsW
.pszJump1
);
299 dst
->pszJump2
= MergeChmString(src
->pszJump2
, &info
->stringsW
.pszJump2
);
300 dst
->pszUrlJump1
= MergeChmString(src
->pszUrlJump1
, &info
->stringsW
.pszUrlJump1
);
301 dst
->pszUrlJump2
= MergeChmString(src
->pszUrlJump2
, &info
->stringsW
.pszUrlJump2
);
303 /* FIXME: pszCustomTabs is a list of multiple zero-terminated strings so ReadString won't
307 dst
->pszCustomTabs
= MergeChmString(src
->pszCustomTabs
, &info
->pszCustomTabs
);
311 static inline WCHAR
*ConvertChmString(HHInfo
*info
, const WCHAR
**str
)
316 *str
= ret
= strdupAtoW(GetChmString(info
->pCHMInfo
, (DWORD_PTR
)*str
));
320 /* Loads the HH_WINTYPE data from the CHM file
322 * FIXME: There may be more than one window type in the file, so
323 * add the ability to choose a certain window type
325 BOOL
LoadWinTypeFromCHM(HHInfo
*info
)
327 LARGE_INTEGER liOffset
;
328 WCHAR
*pszType
= NULL
, *pszFile
= NULL
, *pszToc
= NULL
, *pszIndex
= NULL
, *pszCaption
= NULL
;
329 WCHAR
*pszHome
= NULL
, *pszJump1
= NULL
, *pszJump2
= NULL
, *pszUrlJump1
= NULL
, *pszUrlJump2
= NULL
;
330 IStorage
*pStorage
= info
->pCHMInfo
->pStorage
;
331 IStream
*pStream
= NULL
;
337 static const WCHAR null
[] = {0};
338 static const WCHAR toc_extW
[] = {'h','h','c',0};
339 static const WCHAR index_extW
[] = {'h','h','k',0};
340 static const WCHAR windowsW
[] = {'#','W','I','N','D','O','W','S',0};
342 hr
= IStorage_OpenStream(pStorage
, windowsW
, NULL
, STGM_READ
, 0, &pStream
);
345 /* jump past the #WINDOWS header */
346 liOffset
.QuadPart
= sizeof(DWORD
) * 2;
348 hr
= IStream_Seek(pStream
, liOffset
, STREAM_SEEK_SET
, NULL
);
349 if (FAILED(hr
)) goto done
;
351 /* read the HH_WINTYPE struct data */
352 hr
= IStream_Read(pStream
, &wintype
, sizeof(wintype
), &cbRead
);
353 if (FAILED(hr
)) goto done
;
355 /* convert the #STRINGS offsets to actual strings */
356 pszType
= ConvertChmString(info
, &wintype
.pszType
);
357 pszFile
= ConvertChmString(info
, &wintype
.pszFile
);
358 pszToc
= ConvertChmString(info
, &wintype
.pszToc
);
359 pszIndex
= ConvertChmString(info
, &wintype
.pszIndex
);
360 pszCaption
= ConvertChmString(info
, &wintype
.pszCaption
);
361 pszHome
= ConvertChmString(info
, &wintype
.pszHome
);
362 pszJump1
= ConvertChmString(info
, &wintype
.pszJump1
);
363 pszJump2
= ConvertChmString(info
, &wintype
.pszJump2
);
364 pszUrlJump1
= ConvertChmString(info
, &wintype
.pszUrlJump1
);
365 pszUrlJump2
= ConvertChmString(info
, &wintype
.pszUrlJump2
);
369 /* no defined window types so use (hopefully) sane defaults */
370 static const WCHAR defaultwinW
[] = {'d','e','f','a','u','l','t','w','i','n','\0'};
371 memset(&wintype
, 0, sizeof(wintype
));
372 wintype
.cbStruct
= sizeof(wintype
);
373 wintype
.fUniCodeStrings
= TRUE
;
374 wintype
.pszType
= pszType
= strdupW(info
->pCHMInfo
->defWindow
? info
->pCHMInfo
->defWindow
: defaultwinW
);
375 wintype
.pszToc
= pszToc
= strdupW(info
->pCHMInfo
->defToc
? info
->pCHMInfo
->defToc
: null
);
376 wintype
.pszIndex
= pszIndex
= strdupW(null
);
377 wintype
.fsValidMembers
= 0;
378 wintype
.fsWinProperties
= HHWIN_PROP_TRI_PANE
;
379 wintype
.dwStyles
= WS_POPUP
;
380 wintype
.dwExStyles
= 0;
381 wintype
.nShowState
= SW_SHOW
;
382 wintype
.curNavType
= HHWIN_NAVTYPE_TOC
;
385 /* merge the new data with any pre-existing HH_WINTYPE structure */
386 MergeChmProperties(&wintype
, info
, FALSE
);
387 if (!info
->WinType
.pszCaption
)
388 info
->WinType
.pszCaption
= info
->stringsW
.pszCaption
= strdupW(info
->pCHMInfo
->defTitle
? info
->pCHMInfo
->defTitle
: null
);
389 if (!info
->WinType
.pszFile
)
390 info
->WinType
.pszFile
= info
->stringsW
.pszFile
= strdupW(info
->pCHMInfo
->defTopic
? info
->pCHMInfo
->defTopic
: null
);
391 if (!info
->WinType
.pszToc
)
392 info
->WinType
.pszToc
= info
->stringsW
.pszToc
= FindHTMLHelpSetting(info
, toc_extW
);
393 if (!info
->WinType
.pszIndex
)
394 info
->WinType
.pszIndex
= info
->stringsW
.pszIndex
= FindHTMLHelpSetting(info
, index_extW
);
400 heap_free(pszCaption
);
404 heap_free(pszUrlJump1
);
405 heap_free(pszUrlJump2
);
410 IStream_Release(pStream
);
415 LPCWSTR
skip_schema(LPCWSTR url
)
417 static const WCHAR its_schema
[] = {'i','t','s',':'};
418 static const WCHAR msits_schema
[] = {'m','s','-','i','t','s',':'};
419 static const WCHAR mk_schema
[] = {'m','k',':','@','M','S','I','T','S','t','o','r','e',':'};
421 if(!strncmpiW(its_schema
, url
, sizeof(its_schema
)/sizeof(WCHAR
)))
422 return url
+sizeof(its_schema
)/sizeof(WCHAR
);
423 if(!strncmpiW(msits_schema
, url
, sizeof(msits_schema
)/sizeof(WCHAR
)))
424 return url
+sizeof(msits_schema
)/sizeof(WCHAR
);
425 if(!strncmpiW(mk_schema
, url
, sizeof(mk_schema
)/sizeof(WCHAR
)))
426 return url
+sizeof(mk_schema
)/sizeof(WCHAR
);
431 void SetChmPath(ChmPath
*file
, LPCWSTR base_file
, LPCWSTR path
)
434 static const WCHAR separatorW
[] = {':',':',0};
436 path
= skip_schema(path
);
438 ptr
= strstrW(path
, separatorW
);
440 WCHAR chm_file
[MAX_PATH
];
441 WCHAR rel_path
[MAX_PATH
];
442 WCHAR base_path
[MAX_PATH
];
445 strcpyW(base_path
, base_file
);
446 p
= strrchrW(base_path
, '\\');
450 memcpy(rel_path
, path
, (ptr
-path
)*sizeof(WCHAR
));
451 rel_path
[ptr
-path
] = 0;
453 PathCombineW(chm_file
, base_path
, rel_path
);
455 file
->chm_file
= strdupW(chm_file
);
458 file
->chm_file
= strdupW(base_file
);
462 file
->chm_index
= strdupW(ptr
);
464 TRACE("ChmFile = {%s %s}\n", debugstr_w(file
->chm_file
), debugstr_w(file
->chm_index
));
467 IStream
*GetChmStream(CHMInfo
*info
, LPCWSTR parent_chm
, ChmPath
*chm_file
)
470 IStream
*stream
= NULL
;
473 TRACE("%s (%s :: %s)\n", debugstr_w(parent_chm
), debugstr_w(chm_file
->chm_file
),
474 debugstr_w(chm_file
->chm_index
));
476 if(parent_chm
|| chm_file
->chm_file
) {
477 hres
= IITStorage_StgOpenStorage(info
->pITStorage
,
478 chm_file
->chm_file
? chm_file
->chm_file
: parent_chm
, NULL
,
479 STGM_READ
| STGM_SHARE_DENY_WRITE
, NULL
, 0, &storage
);
481 WARN("Could not open storage: %08x\n", hres
);
485 storage
= info
->pStorage
;
486 IStorage_AddRef(info
->pStorage
);
489 hres
= IStorage_OpenStream(storage
, chm_file
->chm_index
, NULL
, STGM_READ
, 0, &stream
);
490 IStorage_Release(storage
);
492 WARN("Could not open stream: %08x\n", hres
);
498 * Retrieve a CHM document and parse the data from the <title> element to get the document's title.
500 WCHAR
*GetDocumentTitle(CHMInfo
*info
, LPCWSTR document
)
502 strbuf_t node
, node_name
, content
;
503 WCHAR
*document_title
= NULL
;
509 TRACE("%s\n", debugstr_w(document
));
511 storage
= info
->pStorage
;
513 WARN("Could not open storage to obtain the title for a document.\n");
516 IStorage_AddRef(storage
);
518 hres
= IStorage_OpenStream(storage
, document
, NULL
, STGM_READ
, 0, &str
);
519 IStorage_Release(storage
);
521 WARN("Could not open stream: %08x\n", hres
);
523 stream_init(&stream
, str
);
525 strbuf_init(&content
);
526 strbuf_init(&node_name
);
528 while(next_node(&stream
, &node
)) {
529 get_node_name(&node
, &node_name
);
531 TRACE("%s\n", node
.buf
);
533 if(!strcasecmp(node_name
.buf
, "title")) {
534 if(next_content(&stream
, &content
) && content
.len
> 1)
536 document_title
= strdupnAtoW(&content
.buf
[1], content
.len
-1);
537 FIXME("magic: %s\n", debugstr_w(document_title
));
546 strbuf_free(&content
);
547 strbuf_free(&node_name
);
548 IStream_Release(str
);
550 return document_title
;
553 /* Opens the CHM file for reading */
554 CHMInfo
*OpenCHM(LPCWSTR szFile
)
559 static const WCHAR wszSTRINGS
[] = {'#','S','T','R','I','N','G','S',0};
561 if (!(ret
= heap_alloc_zero(sizeof(CHMInfo
))))
563 ret
->codePage
= CP_ACP
;
565 if (!(ret
->szFile
= strdupW(szFile
))) {
570 hres
= CoCreateInstance(&CLSID_ITStorage
, NULL
, CLSCTX_INPROC_SERVER
,
571 &IID_IITStorage
, (void **) &ret
->pITStorage
) ;
573 WARN("Could not create ITStorage: %08x\n", hres
);
574 return CloseCHM(ret
);
577 hres
= IITStorage_StgOpenStorage(ret
->pITStorage
, szFile
, NULL
,
578 STGM_READ
| STGM_SHARE_DENY_WRITE
, NULL
, 0, &ret
->pStorage
);
580 WARN("Could not open storage: %08x\n", hres
);
581 return CloseCHM(ret
);
583 hres
= IStorage_OpenStream(ret
->pStorage
, wszSTRINGS
, NULL
, STGM_READ
, 0,
584 &ret
->strings_stream
);
586 WARN("Could not open #STRINGS stream: %08x\n", hres
);
587 /* It's not critical, so we pass */
590 if(!ReadChmSystem(ret
)) {
591 WARN("Could not read #SYSTEM\n");
592 return CloseCHM(ret
);
598 CHMInfo
*CloseCHM(CHMInfo
*chm
)
601 IITStorage_Release(chm
->pITStorage
);
604 IStorage_Release(chm
->pStorage
);
606 if(chm
->strings_stream
)
607 IStream_Release(chm
->strings_stream
);
609 if(chm
->strings_size
) {
612 for(i
=0; i
<chm
->strings_size
; i
++)
613 heap_free(chm
->strings
[i
]);
616 heap_free(chm
->strings
);
617 heap_free(chm
->defWindow
);
618 heap_free(chm
->defTitle
);
619 heap_free(chm
->defTopic
);
620 heap_free(chm
->defToc
);
621 heap_free(chm
->szFile
);
622 heap_free(chm
->compiledFile
);