hhctrl.ocx: Find node attributes in a case-insensitive way.
[wine] / dlls / hhctrl.ocx / content.c
1 /*
2  * Copyright 2007 Jacek Caban for CodeWeavers
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
17  */
18
19 #define NONAMELESSUNION
20 #define NONAMELESSSTRUCT
21
22 #include "hhctrl.h"
23
24 #include "wine/debug.h"
25
26 WINE_DEFAULT_DEBUG_CHANNEL(htmlhelp);
27
28 #define BLOCK_SIZE 0x1000
29
30 typedef enum {
31     INSERT_NEXT,
32     INSERT_CHILD
33 } insert_type_t;
34
35 static void free_content_item(ContentItem *item)
36 {
37     ContentItem *next;
38
39     while(item) {
40         next = item->next;
41
42         free_content_item(item->child);
43
44         heap_free(item->name);
45         heap_free(item->local);
46         heap_free(item->merge.chm_file);
47         heap_free(item->merge.chm_index);
48
49         item = next;
50     }
51 }
52
53 typedef struct {
54     char *buf;
55     int size;
56     int len;
57 } strbuf_t;
58
59 static void strbuf_init(strbuf_t *buf)
60 {
61     buf->size = 8;
62     buf->len = 0;
63     buf->buf = heap_alloc(buf->size);
64 }
65
66 static void strbuf_zero(strbuf_t *buf)
67 {
68     buf->len = 0;
69 }
70
71 static void strbuf_free(strbuf_t *buf)
72 {
73     heap_free(buf->buf);
74 }
75
76 static void strbuf_append(strbuf_t *buf, const char *data, int len)
77 {
78     if(buf->len+len > buf->size) {
79         buf->size = buf->len+len;
80         buf->buf = heap_realloc(buf->buf, buf->size);
81     }
82
83     memcpy(buf->buf+buf->len, data, len);
84     buf->len += len;
85 }
86
87 typedef struct {
88     IStream *str;
89     char buf[BLOCK_SIZE];
90     ULONG size;
91     ULONG p;
92 } stream_t;
93
94 static void stream_init(stream_t *stream, IStream *str)
95 {
96     memset(stream, 0, sizeof(stream_t));
97     stream->str = str;
98 }
99
100 static BOOL stream_chr(stream_t *stream, strbuf_t *buf, char c)
101 {
102     BOOL b = TRUE;
103     ULONG i;
104
105     while(b) {
106         for(i=stream->p; i<stream->size; i++) {
107             if(stream->buf[i] == c) {
108                 b = FALSE;
109                 break;
110             }
111         }
112
113         if(buf && i > stream->p)
114             strbuf_append(buf, stream->buf+stream->p, i-stream->p);
115         stream->p = i;
116
117         if(stream->p == stream->size) {
118             stream->p = 0;
119             IStream_Read(stream->str, stream->buf, sizeof(stream->buf), &stream->size);
120             if(!stream->size)
121                 break;
122         }
123     }
124
125     return stream->size != 0;
126 }
127
128 static void get_node_name(strbuf_t *node, strbuf_t *name)
129 {
130     const char *ptr = node->buf+1;
131
132     strbuf_zero(name);
133
134     while(*ptr != '>' && !isspace(*ptr))
135         ptr++;
136
137     strbuf_append(name, node->buf+1, ptr-node->buf-1);
138     strbuf_append(name, "", 1);
139 }
140
141 static BOOL next_node(stream_t *stream, strbuf_t *buf)
142 {
143     if(!stream_chr(stream, NULL, '<'))
144         return FALSE;
145
146     if(!stream_chr(stream, buf, '>'))
147         return FALSE;
148
149     strbuf_append(buf, ">", 2);
150
151     return TRUE;
152 }
153
154 /*
155  * Find the value of a named HTML attribute.
156  *
157  * Note: Attribute names are case insensitive, so it is necessary to
158  * put both the node text and the attribute name in the same case
159  * before attempting a string search.
160  */
161 static const char *get_attr(const char *node, const char *name, int *len)
162 {
163     const char *ptr, *ptr2;
164     int name_len, node_len;
165     char name_buf[32];
166     char *node_buf;
167     int i;
168
169     /* Create a lower case copy of the node */
170     node_len = strlen(node)+1;
171     node_buf = heap_alloc(node_len*sizeof(char));
172     if(!node_buf)
173         return NULL;
174     memcpy(node_buf, node, node_len);
175     for(i=0;i<node_len;i++)
176         node_buf[i] = tolower(node_buf[i]);
177     /* Create a lower case copy of the attribute name (search string) */
178     name_len = strlen(name);
179     memcpy(name_buf, name, name_len);
180     for(i=0;i<name_len;i++)
181         name_buf[i] = tolower(name_buf[i]);
182     name_buf[name_len++] = '=';
183     name_buf[name_len++] = '\"';
184     name_buf[name_len] = 0;
185
186     ptr = strstr(node_buf, name_buf);
187     if(!ptr) {
188         WARN("name not found\n");
189         heap_free(name_buf);
190         return NULL;
191     }
192
193     ptr += name_len;
194     ptr2 = strchr(ptr, '\"');
195     if(!ptr2)
196     {
197         heap_free(name_buf);
198         return NULL;
199     }
200
201     *len = ptr2-ptr;
202     heap_free(name_buf);
203     /* Return the pointer offset within the original string */
204     return node+(ptr-node_buf);
205 }
206
207 static void parse_obj_node_param(ContentItem *item, ContentItem *hhc_root, const char *text)
208 {
209     const char *ptr;
210     LPWSTR *param, merge;
211     int len, wlen;
212
213     ptr = get_attr(text, "name", &len);
214     if(!ptr) {
215         WARN("name attr not found\n");
216         return;
217     }
218
219     if(!strncasecmp("name", ptr, len)) {
220         param = &item->name;
221     }else if(!strncasecmp("merge", ptr, len)) {
222         param = &merge;
223     }else if(!strncasecmp("local", ptr, len)) {
224         param = &item->local;
225     }else {
226         WARN("unhandled param %s\n", debugstr_an(ptr, len));
227         return;
228     }
229
230     ptr = get_attr(text, "value", &len);
231     if(!ptr) {
232         WARN("value attr not found\n");
233         return;
234     }
235
236     wlen = MultiByteToWideChar(CP_ACP, 0, ptr, len, NULL, 0);
237     *param = heap_alloc((wlen+1)*sizeof(WCHAR));
238     MultiByteToWideChar(CP_ACP, 0, ptr, len, *param, wlen);
239     (*param)[wlen] = 0;
240
241     if(param == &merge) {
242         SetChmPath(&item->merge, hhc_root->merge.chm_file, merge);
243         heap_free(merge);
244     }
245 }
246
247 static ContentItem *parse_hhc(HHInfo*,IStream*,ContentItem*,insert_type_t*);
248
249 static ContentItem *insert_item(ContentItem *item, ContentItem *new_item, insert_type_t insert_type)
250 {
251     if(!item)
252         return new_item;
253
254     if(!new_item)
255         return item;
256
257     switch(insert_type) {
258     case INSERT_NEXT:
259         item->next = new_item;
260         return new_item;
261     case INSERT_CHILD:
262         if(item->child) {
263             ContentItem *iter = item->child;
264             while(iter->next)
265                 iter = iter->next;
266             iter->next = new_item;
267         }else {
268             item->child = new_item;
269         }
270         return item;
271     }
272
273     return NULL;
274 }
275
276 static ContentItem *parse_sitemap_object(HHInfo *info, stream_t *stream, ContentItem *hhc_root,
277         insert_type_t *insert_type)
278 {
279     strbuf_t node, node_name;
280     ContentItem *item;
281
282     *insert_type = INSERT_NEXT;
283
284     strbuf_init(&node);
285     strbuf_init(&node_name);
286
287     item = heap_alloc_zero(sizeof(ContentItem));
288
289     while(next_node(stream, &node)) {
290         get_node_name(&node, &node_name);
291
292         TRACE("%s\n", node.buf);
293
294         if(!strcasecmp(node_name.buf, "/object"))
295             break;
296         if(!strcasecmp(node_name.buf, "param"))
297             parse_obj_node_param(item, hhc_root, node.buf);
298
299         strbuf_zero(&node);
300     }
301
302     strbuf_free(&node);
303     strbuf_free(&node_name);
304
305     if(item->merge.chm_index) {
306         IStream *merge_stream;
307
308         merge_stream = GetChmStream(info->pCHMInfo, item->merge.chm_file, &item->merge);
309         if(merge_stream) {
310             item->child = parse_hhc(info, merge_stream, hhc_root, insert_type);
311             IStream_Release(merge_stream);
312         }else {
313             WARN("Could not get %s::%s stream\n", debugstr_w(item->merge.chm_file),
314                  debugstr_w(item->merge.chm_file));
315
316             if(!item->name) {
317                 free_content_item(item);
318                 item = NULL;
319             }
320         }
321
322     }
323
324     return item;
325 }
326
327 static ContentItem *parse_ul(HHInfo *info, stream_t *stream, ContentItem *hhc_root)
328 {
329     strbuf_t node, node_name;
330     ContentItem *ret = NULL, *prev = NULL, *new_item = NULL;
331     insert_type_t it;
332
333     strbuf_init(&node);
334     strbuf_init(&node_name);
335
336     while(next_node(stream, &node)) {
337         get_node_name(&node, &node_name);
338
339         TRACE("%s\n", node.buf);
340
341         if(!strcasecmp(node_name.buf, "object")) {
342             const char *ptr;
343             int len;
344
345             static const char sz_text_sitemap[] = "text/sitemap";
346
347             ptr = get_attr(node.buf, "type", &len);
348
349             if(ptr && len == sizeof(sz_text_sitemap)-1
350                && !memcmp(ptr, sz_text_sitemap, len)) {
351                 new_item = parse_sitemap_object(info, stream, hhc_root, &it);
352                 prev = insert_item(prev, new_item, it);
353                 if(!ret)
354                     ret = prev;
355             }
356         }else if(!strcasecmp(node_name.buf, "ul")) {
357             new_item = parse_ul(info, stream, hhc_root);
358             insert_item(prev, new_item, INSERT_CHILD);
359         }else if(!strcasecmp(node_name.buf, "/ul")) {
360             break;
361         }
362
363         strbuf_zero(&node);
364     }
365
366     strbuf_free(&node);
367     strbuf_free(&node_name);
368
369     return ret;
370 }
371
372 static ContentItem *parse_hhc(HHInfo *info, IStream *str, ContentItem *hhc_root,
373         insert_type_t *insert_type)
374 {
375     stream_t stream;
376     strbuf_t node, node_name;
377     ContentItem *ret = NULL, *prev = NULL;
378
379     *insert_type = INSERT_NEXT;
380
381     strbuf_init(&node);
382     strbuf_init(&node_name);
383
384     stream_init(&stream, str);
385
386     while(next_node(&stream, &node)) {
387         get_node_name(&node, &node_name);
388
389         TRACE("%s\n", node.buf);
390
391         if(!strcasecmp(node_name.buf, "ul")) {
392             ContentItem *item = parse_ul(info, &stream, hhc_root);
393             prev = insert_item(prev, item, INSERT_CHILD);
394             if(!ret)
395                 ret = prev;
396             *insert_type = INSERT_CHILD;
397         }
398
399         strbuf_zero(&node);
400     }
401
402     strbuf_free(&node);
403     strbuf_free(&node_name);
404
405     return ret;
406 }
407
408 static void insert_content_item(HWND hwnd, ContentItem *parent, ContentItem *item)
409 {
410     TVINSERTSTRUCTW tvis;
411
412     memset(&tvis, 0, sizeof(tvis));
413     tvis.u.item.mask = TVIF_TEXT|TVIF_PARAM;
414     tvis.u.item.cchTextMax = strlenW(item->name)+1;
415     tvis.u.item.pszText = item->name;
416     tvis.u.item.lParam = (LPARAM)item;
417     tvis.hParent = parent ? parent->id : 0;
418     tvis.hInsertAfter = TVI_LAST;
419
420     item->id = (HTREEITEM)SendMessageW(hwnd, TVM_INSERTITEMW, 0, (LPARAM)&tvis);
421 }
422
423 static void fill_content_tree(HWND hwnd, ContentItem *parent, ContentItem *item)
424 {
425     while(item) {
426         if(item->name) {
427             insert_content_item(hwnd, parent, item);
428             fill_content_tree(hwnd, item, item->child);
429         }else {
430             fill_content_tree(hwnd, parent, item->child);
431         }
432         item = item->next;
433     }
434 }
435
436 static void set_item_parents(ContentItem *parent, ContentItem *item)
437 {
438     while(item) {
439         item->parent = parent;
440         set_item_parents(item, item->child);
441         item = item->next;
442     }
443 }
444
445 void InitContent(HHInfo *info)
446 {
447     IStream *stream;
448     insert_type_t insert_type;
449
450     info->content = heap_alloc_zero(sizeof(ContentItem));
451     SetChmPath(&info->content->merge, info->pCHMInfo->szFile, info->WinType.pszToc);
452
453     stream = GetChmStream(info->pCHMInfo, info->pCHMInfo->szFile, &info->content->merge);
454     if(!stream) {
455         TRACE("Could not get content stream\n");
456         return;
457     }
458
459     info->content->child = parse_hhc(info, stream, info->content, &insert_type);
460     IStream_Release(stream);
461
462     set_item_parents(NULL, info->content);
463     fill_content_tree(info->tabs[TAB_CONTENTS].hwnd, NULL, info->content);
464 }
465
466 void ReleaseContent(HHInfo *info)
467 {
468     free_content_item(info->content);
469 }