dlls/hhctrl.ocx/chm.c

   1 /*
   2  * CHM Utility API
   3  *
   4  * Copyright 2005 James Hawkins
   5  * Copyright 2007 Jacek Caban
   6  *
   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.
  11  *
  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.
  16  *
  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
  20  */
  21
  22 #include "hhctrl.h"
  23 #include "stream.h"
  24
  25 #include "winreg.h"
  26 #include "shlwapi.h"
  27 #include "wine/debug.h"
  28
  29 WINE_DEFAULT_DEBUG_CHANNEL(htmlhelp);
  30
  31 /* Reads a string from the #STRINGS section in the CHM file */
  32 static LPCSTR GetChmString(CHMInfo *chm, DWORD offset)
  33 {
  34     LPCSTR str;
  35
  36     if(!chm->strings_stream)
  37         return NULL;
  38
  39     if(chm->strings_size <= (offset >> BLOCK_BITS)) {
  40         chm->strings_size = (offset >> BLOCK_BITS)+1;
  41         if(chm->strings)
  42             chm->strings = heap_realloc_zero(chm->strings,
  43                     chm->strings_size*sizeof(char*));
  44         else
  45             chm->strings = heap_alloc_zero(
  46                     chm->strings_size*sizeof(char*));
  47
  48     }
  49
  50     if(!chm->strings[offset >> BLOCK_BITS]) {
  51         LARGE_INTEGER pos;
  52         DWORD read;
  53         HRESULT hres;
  54
  55         pos.QuadPart = offset & ~BLOCK_MASK;
  56         hres = IStream_Seek(chm->strings_stream, pos, STREAM_SEEK_SET, NULL);
  57         if(FAILED(hres)) {
  58             WARN("Seek failed: %08x\n", hres);
  59             return NULL;
  60         }
  61
  62         chm->strings[offset >> BLOCK_BITS] = heap_alloc(BLOCK_SIZE);
  63
  64         hres = IStream_Read(chm->strings_stream, chm->strings[offset >> BLOCK_BITS],
  65                             BLOCK_SIZE, &read);
  66         if(FAILED(hres)) {
  67             WARN("Read failed: %08x\n", hres);
  68             heap_free(chm->strings[offset >> BLOCK_BITS]);
  69             chm->strings[offset >> BLOCK_BITS] = NULL;
  70             return NULL;
  71         }
  72     }
  73
  74     str = chm->strings[offset >> BLOCK_BITS] + (offset & BLOCK_MASK);
  75     TRACE("offset %#x => %s\n", offset, debugstr_a(str));
  76     return str;
  77 }
  78
  79 static BOOL ReadChmSystem(CHMInfo *chm)
  80 {
  81     IStream *stream;
  82     DWORD ver=0xdeadbeef, read, buf_size;
  83     char *buf;
  84     HRESULT hres;
  85
  86     struct {
  87         WORD code;
  88         WORD len;
  89     } entry;
  90
  91     static const WCHAR wszSYSTEM[] = {'#','S','Y','S','T','E','M',0};
  92
  93     hres = IStorage_OpenStream(chm->pStorage, wszSYSTEM, NULL, STGM_READ, 0, &stream);
  94     if(FAILED(hres)) {
  95         WARN("Could not open #SYSTEM stream: %08x\n", hres);
  96         return FALSE;
  97     }
  98
  99     IStream_Read(stream, &ver, sizeof(ver), &read);
 100     TRACE("version is %x\n", ver);
 101
 102     buf = heap_alloc(8*sizeof(DWORD));
 103     buf_size = 8*sizeof(DWORD);
 104
 105     while(1) {
 106         hres = IStream_Read(stream, &entry, sizeof(entry), &read);
 107         if(hres != S_OK)
 108             break;
 109
 110         if(entry.len > buf_size)
 111             buf = heap_realloc(buf, buf_size=entry.len);
 112
 113         hres = IStream_Read(stream, buf, entry.len, &read);
 114         if(hres != S_OK)
 115             break;
 116
 117         switch(entry.code) {
 118         case 0x0:
 119             TRACE("TOC is %s\n", debugstr_an(buf, entry.len));
 120             heap_free(chm->defToc);
 121             chm->defToc = strdupnAtoW(buf, entry.len);
 122             break;
 123         case 0x2:
 124             TRACE("Default topic is %s\n", debugstr_an(buf, entry.len));
 125             heap_free(chm->defTopic);
 126             chm->defTopic = strdupnAtoW(buf, entry.len);
 127             break;
 128         case 0x3:
 129             TRACE("Title is %s\n", debugstr_an(buf, entry.len));
 130             heap_free(chm->defTitle);
 131             chm->defTitle = strdupnAtoW(buf, entry.len);
 132             break;
 133         case 0x4:
 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;
 139             break;
 140         case 0x5:
 141             TRACE("Window name is %s\n", debugstr_an(buf, entry.len));
 142             chm->defWindow = strdupnAtoW(buf, entry.len);
 143             break;
 144         case 0x6:
 145             TRACE("Compiled file is %s\n", debugstr_an(buf, entry.len));
 146             heap_free(chm->compiledFile);
 147             chm->compiledFile = strdupnAtoW(buf, entry.len);
 148             break;
 149         case 0x9:
 150             TRACE("Version is %s\n", debugstr_an(buf, entry.len));
 151             break;
 152         case 0xa:
 153             TRACE("Time is %08x\n", *(DWORD*)buf);
 154             break;
 155         case 0xc:
 156             TRACE("Number of info types: %d\n", *(DWORD*)buf);
 157             break;
 158         case 0xf:
 159             TRACE("Check sum: %x\n", *(DWORD*)buf);
 160             break;
 161         default:
 162             TRACE("unhandled code %x, size %x\n", entry.code, entry.len);
 163         }
 164     }
 165
 166     heap_free(buf);
 167     IStream_Release(stream);
 168
 169     return SUCCEEDED(hres);
 170 }
 171
 172 LPWSTR FindContextAlias(CHMInfo *chm, DWORD index)
 173 {
 174     IStream *ivb_stream;
 175     DWORD size, read, i;
 176     DWORD *buf;
 177     LPCSTR ret = NULL;
 178     HRESULT hres;
 179
 180     static const WCHAR wszIVB[] = {'#','I','V','B',0};
 181
 182     hres = IStorage_OpenStream(chm->pStorage, wszIVB, NULL, STGM_READ, 0, &ivb_stream);
 183     if(FAILED(hres)) {
 184         WARN("Could not open #IVB stream: %08x\n", hres);
 185         return NULL;
 186     }
 187
 188     hres = IStream_Read(ivb_stream, &size, sizeof(size), &read);
 189     if(FAILED(hres)) {
 190         WARN("Read failed: %08x\n", hres);
 191         IStream_Release(ivb_stream);
 192         return NULL;
 193     }
 194
 195     buf = heap_alloc(size);
 196     hres = IStream_Read(ivb_stream, buf, size, &read);
 197     IStream_Release(ivb_stream);
 198     if(FAILED(hres)) {
 199         WARN("Read failed: %08x\n", hres);
 200         heap_free(buf);
 201         return NULL;
 202     }
 203
 204     size /= 2*sizeof(DWORD);
 205
 206     for(i=0; i<size; i++) {
 207         if(buf[2*i] == index) {
 208             ret = GetChmString(chm, buf[2*i+1]);
 209             break;
 210         }
 211     }
 212
 213     heap_free(buf);
 214
 215     TRACE("returning %s\n", debugstr_a(ret));
 216     return strdupAtoW(ret);
 217 }
 218
 219 /*
 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.
 222  */
 223 static WCHAR *FindHTMLHelpSetting(HHInfo *info, const WCHAR *extW)
 224 {
 225     static const WCHAR periodW[] = {'.',0};
 226     IStorage *pStorage = info->pCHMInfo->pStorage;
 227     IStream *pStream;
 228     WCHAR *filename;
 229     HRESULT hr;
 230
 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);
 237     if (FAILED(hr))
 238     {
 239         heap_free(filename);
 240         return strdupAtoW("");
 241     }
 242     IStream_Release(pStream);
 243     return filename;
 244 }
 245
 246 /* Loads the HH_WINTYPE data from the CHM file
 247  *
 248  * FIXME: There may be more than one window type in the file, so
 249  *        add the ability to choose a certain window type
 250  */
 251 BOOL LoadWinTypeFromCHM(HHInfo *info)
 252 {
 253     LARGE_INTEGER liOffset;
 254     IStorage *pStorage = info->pCHMInfo->pStorage;
 255     IStream *pStream;
 256     HRESULT hr;
 257     DWORD cbRead;
 258
 259     static const WCHAR null[] = {0};
 260     static const WCHAR toc_extW[] = {'h','h','c',0};
 261     static const WCHAR index_extW[] = {'h','h','k',0};
 262     static const WCHAR windowsW[] = {'#','W','I','N','D','O','W','S',0};
 263
 264     hr = IStorage_OpenStream(pStorage, windowsW, NULL, STGM_READ, 0, &pStream);
 265     if (FAILED(hr))
 266     {
 267         /* no defined window types so use (hopefully) sane defaults */
 268         static const WCHAR defaultwinW[] = {'d','e','f','a','u','l','t','w','i','n','\0'};
 269         memset((void*)&(info->WinType), 0, sizeof(info->WinType));
 270         info->WinType.cbStruct=sizeof(info->WinType);
 271         info->WinType.fUniCodeStrings=TRUE;
 272         info->WinType.pszType = strdupW(info->pCHMInfo->defWindow ? info->pCHMInfo->defWindow : defaultwinW);
 273         info->WinType.pszToc = strdupW(info->pCHMInfo->defToc ? info->pCHMInfo->defToc : null);
 274         info->WinType.pszIndex = strdupW(null);
 275         info->WinType.fsValidMembers=0;
 276         info->WinType.fsWinProperties=HHWIN_PROP_TRI_PANE;
 277         info->WinType.pszCaption=strdupW(info->pCHMInfo->defTitle ? info->pCHMInfo->defTitle : null);
 278         info->WinType.dwStyles=WS_POPUP;
 279         info->WinType.dwExStyles=0;
 280         info->WinType.nShowState=SW_SHOW;
 281         info->WinType.pszFile=strdupW(info->pCHMInfo->defTopic ? info->pCHMInfo->defTopic : null);
 282         info->WinType.curNavType=HHWIN_NAVTYPE_TOC;
 283         return TRUE;
 284     }
 285
 286     /* jump past the #WINDOWS header */
 287     liOffset.QuadPart = sizeof(DWORD) * 2;
 288
 289     hr = IStream_Seek(pStream, liOffset, STREAM_SEEK_SET, NULL);
 290     if (FAILED(hr)) goto done;
 291
 292     /* read the HH_WINTYPE struct data */
 293     hr = IStream_Read(pStream, &info->WinType, sizeof(info->WinType), &cbRead);
 294     if (FAILED(hr)) goto done;
 295
 296     /* convert the #STRINGS offsets to actual strings */
 297
 298     info->WinType.pszType      = info->pszType     = strdupAtoW(GetChmString(info->pCHMInfo, (DWORD_PTR)info->WinType.pszType));
 299     info->WinType.pszCaption   = info->pszCaption  = strdupAtoW(GetChmString(info->pCHMInfo, (DWORD_PTR)info->WinType.pszCaption));
 300     info->WinType.pszHome      = info->pszHome     = strdupAtoW(GetChmString(info->pCHMInfo, (DWORD_PTR)info->WinType.pszHome));
 301     info->WinType.pszJump1     = info->pszJump1    = strdupAtoW(GetChmString(info->pCHMInfo, (DWORD_PTR)info->WinType.pszJump1));
 302     info->WinType.pszJump2     = info->pszJump2    = strdupAtoW(GetChmString(info->pCHMInfo, (DWORD_PTR)info->WinType.pszJump2));
 303     info->WinType.pszUrlJump1  = info->pszUrlJump1 = strdupAtoW(GetChmString(info->pCHMInfo, (DWORD_PTR)info->WinType.pszUrlJump1));
 304     info->WinType.pszUrlJump2  = info->pszUrlJump2 = strdupAtoW(GetChmString(info->pCHMInfo, (DWORD_PTR)info->WinType.pszUrlJump2));
 305
 306     if (info->WinType.pszFile)
 307         info->WinType.pszFile  = info->pszFile     = strdupAtoW(GetChmString(info->pCHMInfo, (DWORD_PTR)info->WinType.pszFile));
 308     else
 309         info->WinType.pszFile  = strdupW(info->pCHMInfo->defTopic ? info->pCHMInfo->defTopic : null);
 310     if (info->WinType.pszToc)
 311         info->WinType.pszToc   = info->pszToc      = strdupAtoW(GetChmString(info->pCHMInfo, (DWORD_PTR)info->WinType.pszToc));
 312     else
 313         info->WinType.pszToc   = info->pszToc      = FindHTMLHelpSetting(info, toc_extW);
 314     if (info->WinType.pszIndex)
 315         info->WinType.pszIndex = info->pszIndex    = strdupAtoW(GetChmString(info->pCHMInfo, (DWORD_PTR)info->WinType.pszIndex));
 316     else
 317         info->WinType.pszIndex = info->pszIndex    = FindHTMLHelpSetting(info, index_extW);
 318
 319     /* FIXME: pszCustomTabs is a list of multiple zero-terminated strings so ReadString won't
 320      * work in this case
 321      */
 322 #if 0
 323     info->WinType.pszCustomTabs = info->pszCustomTabs = CHM_ReadString(pChmInfo, (DWORD_PTR)info->WinType.pszCustomTabs);
 324 #endif
 325
 326 done:
 327     IStream_Release(pStream);
 328
 329     return SUCCEEDED(hr);
 330 }
 331
 332 LPCWSTR skip_schema(LPCWSTR url)
 333 {
 334     static const WCHAR its_schema[] = {'i','t','s',':'};
 335     static const WCHAR msits_schema[] = {'m','s','-','i','t','s',':'};
 336     static const WCHAR mk_schema[] = {'m','k',':','@','M','S','I','T','S','t','o','r','e',':'};
 337
 338     if(!strncmpiW(its_schema, url, sizeof(its_schema)/sizeof(WCHAR)))
 339         return url+sizeof(its_schema)/sizeof(WCHAR);
 340     if(!strncmpiW(msits_schema, url, sizeof(msits_schema)/sizeof(WCHAR)))
 341         return url+sizeof(msits_schema)/sizeof(WCHAR);
 342     if(!strncmpiW(mk_schema, url, sizeof(mk_schema)/sizeof(WCHAR)))
 343         return url+sizeof(mk_schema)/sizeof(WCHAR);
 344
 345     return url;
 346 }
 347
 348 void SetChmPath(ChmPath *file, LPCWSTR base_file, LPCWSTR path)
 349 {
 350     LPCWSTR ptr;
 351     static const WCHAR separatorW[] = {':',':',0};
 352
 353     path = skip_schema(path);
 354
 355     ptr = strstrW(path, separatorW);
 356     if(ptr) {
 357         WCHAR chm_file[MAX_PATH];
 358         WCHAR rel_path[MAX_PATH];
 359         WCHAR base_path[MAX_PATH];
 360         LPWSTR p;
 361
 362         strcpyW(base_path, base_file);
 363         p = strrchrW(base_path, '\\');
 364         if(p)
 365             *p = 0;
 366
 367         memcpy(rel_path, path, (ptr-path)*sizeof(WCHAR));
 368         rel_path[ptr-path] = 0;
 369
 370         PathCombineW(chm_file, base_path, rel_path);
 371
 372         file->chm_file = strdupW(chm_file);
 373         ptr += 2;
 374     }else {
 375         file->chm_file = strdupW(base_file);
 376         ptr = path;
 377     }
 378
 379     file->chm_index = strdupW(ptr);
 380
 381     TRACE("ChmFile = {%s %s}\n", debugstr_w(file->chm_file), debugstr_w(file->chm_index));
 382 }
 383
 384 IStream *GetChmStream(CHMInfo *info, LPCWSTR parent_chm, ChmPath *chm_file)
 385 {
 386     IStorage *storage;
 387     IStream *stream = NULL;
 388     HRESULT hres;
 389
 390     TRACE("%s (%s :: %s)\n", debugstr_w(parent_chm), debugstr_w(chm_file->chm_file),
 391           debugstr_w(chm_file->chm_index));
 392
 393     if(parent_chm || chm_file->chm_file) {
 394         hres = IITStorage_StgOpenStorage(info->pITStorage,
 395                 chm_file->chm_file ? chm_file->chm_file : parent_chm, NULL,
 396                 STGM_READ | STGM_SHARE_DENY_WRITE, NULL, 0, &storage);
 397         if(FAILED(hres)) {
 398             WARN("Could not open storage: %08x\n", hres);
 399             return NULL;
 400         }
 401     }else {
 402         storage = info->pStorage;
 403         IStorage_AddRef(info->pStorage);
 404     }
 405
 406     hres = IStorage_OpenStream(storage, chm_file->chm_index, NULL, STGM_READ, 0, &stream);
 407     IStorage_Release(storage);
 408     if(FAILED(hres))
 409         WARN("Could not open stream: %08x\n", hres);
 410
 411     return stream;
 412 }
 413
 414 /*
 415  * Retrieve a CHM document and parse the data from the <title> element to get the document's title.
 416  */
 417 WCHAR *GetDocumentTitle(CHMInfo *info, LPCWSTR document)
 418 {
 419     strbuf_t node, node_name, content;
 420     WCHAR *document_title = NULL;
 421     IStream *str = NULL;
 422     IStorage *storage;
 423     stream_t stream;
 424     HRESULT hres;
 425
 426     TRACE("%s\n", debugstr_w(document));
 427
 428     storage = info->pStorage;
 429     if(!storage) {
 430         WARN("Could not open storage to obtain the title for a document.\n");
 431         return NULL;
 432     }
 433     IStorage_AddRef(storage);
 434
 435     hres = IStorage_OpenStream(storage, document, NULL, STGM_READ, 0, &str);
 436     IStorage_Release(storage);
 437     if(FAILED(hres))
 438         WARN("Could not open stream: %08x\n", hres);
 439
 440     stream_init(&stream, str);
 441     strbuf_init(&node);
 442     strbuf_init(&content);
 443     strbuf_init(&node_name);
 444
 445     while(next_node(&stream, &node)) {
 446         get_node_name(&node, &node_name);
 447
 448         TRACE("%s\n", node.buf);
 449
 450         if(!strcasecmp(node_name.buf, "title")) {
 451             if(next_content(&stream, &content) && content.len > 1)
 452             {
 453                 document_title = strdupnAtoW(&content.buf[1], content.len-1);
 454                 FIXME("magic: %s\n", debugstr_w(document_title));
 455                 break;
 456             }
 457         }
 458
 459         strbuf_zero(&node);
 460     }
 461
 462     strbuf_free(&node);
 463     strbuf_free(&content);
 464     strbuf_free(&node_name);
 465     IStream_Release(str);
 466
 467     return document_title;
 468 }
 469
 470 /* Opens the CHM file for reading */
 471 CHMInfo *OpenCHM(LPCWSTR szFile)
 472 {
 473     HRESULT hres;
 474     CHMInfo *ret;
 475
 476     static const WCHAR wszSTRINGS[] = {'#','S','T','R','I','N','G','S',0};
 477
 478     if (!(ret = heap_alloc_zero(sizeof(CHMInfo))))
 479         return NULL;
 480     ret->codePage = CP_ACP;
 481
 482     if (!(ret->szFile = strdupW(szFile))) {
 483         heap_free(ret);
 484         return NULL;
 485     }
 486
 487     hres = CoCreateInstance(&CLSID_ITStorage, NULL, CLSCTX_INPROC_SERVER,
 488             &IID_IITStorage, (void **) &ret->pITStorage) ;
 489     if(FAILED(hres)) {
 490         WARN("Could not create ITStorage: %08x\n", hres);
 491         return CloseCHM(ret);
 492     }
 493
 494     hres = IITStorage_StgOpenStorage(ret->pITStorage, szFile, NULL,
 495             STGM_READ | STGM_SHARE_DENY_WRITE, NULL, 0, &ret->pStorage);
 496     if(FAILED(hres)) {
 497         WARN("Could not open storage: %08x\n", hres);
 498         return CloseCHM(ret);
 499     }
 500     hres = IStorage_OpenStream(ret->pStorage, wszSTRINGS, NULL, STGM_READ, 0,
 501             &ret->strings_stream);
 502     if(FAILED(hres)) {
 503         WARN("Could not open #STRINGS stream: %08x\n", hres);
 504         /* It's not critical, so we pass */
 505     }
 506
 507     if(!ReadChmSystem(ret)) {
 508         WARN("Could not read #SYSTEM\n");
 509         return CloseCHM(ret);
 510     }
 511
 512     return ret;
 513 }
 514
 515 CHMInfo *CloseCHM(CHMInfo *chm)
 516 {
 517     if(chm->pITStorage)
 518         IITStorage_Release(chm->pITStorage);
 519
 520     if(chm->pStorage)
 521         IStorage_Release(chm->pStorage);
 522
 523     if(chm->strings_stream)
 524         IStream_Release(chm->strings_stream);
 525
 526     if(chm->strings_size) {
 527         DWORD i;
 528
 529         for(i=0; i<chm->strings_size; i++)
 530             heap_free(chm->strings[i]);
 531     }
 532
 533     heap_free(chm->strings);
 534     heap_free(chm->defWindow);
 535     heap_free(chm->defTitle);
 536     heap_free(chm->defTopic);
 537     heap_free(chm->defToc);
 538     heap_free(chm->szFile);
 539     heap_free(chm->compiledFile);
 540     heap_free(chm);
 541
 542     return NULL;
 543 }