b8c45afc02f27e383455e4c702bad85d6d6625dd
[WebKit-https.git] / WebKitTools / DumpRenderTree / mac / DumpRenderTree.mm
1 /*
2  * Copyright (C) 2005, 2006, 2007 Apple Inc. All rights reserved.
3  *           (C) 2007 Graham Dennis (graham.dennis@gmail.com)
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer. 
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution. 
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission. 
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29  
30 #import "DumpRenderTree.h"
31
32 #import "CheckedMalloc.h"
33 #import "DumpRenderTreePasteboard.h"
34 #import "DumpRenderTreeWindow.h"
35 #import "EditingDelegate.h"
36 #import "EventSendingController.h"
37 #import "FrameLoadDelegate.h"
38 #import "JavaScriptThreading.h"
39 #import "LayoutTestController.h"
40 #import "NavigationController.h"
41 #import "ObjCPlugin.h"
42 #import "ObjCPluginFunction.h"
43 #import "PixelDumpSupport.h"
44 #import "PolicyDelegate.h"
45 #import "ResourceLoadDelegate.h"
46 #import "UIDelegate.h"
47 #import "WatchdogMac.h"
48 #import "WorkQueue.h"
49 #import "WorkQueueItem.h"
50 #import <CoreFoundation/CoreFoundation.h>
51 #import <WebKit/DOMElementPrivate.h>
52 #import <WebKit/DOMExtensions.h>
53 #import <WebKit/DOMRange.h>
54 #import <WebKit/WebBackForwardList.h>
55 #import <WebKit/WebCoreStatistics.h>
56 #import <WebKit/WebDatabaseManagerPrivate.h>
57 #import <WebKit/WebDataSourcePrivate.h>
58 #import <WebKit/WebDocumentPrivate.h>
59 #import <WebKit/WebEditingDelegate.h>
60 #import <WebKit/WebFrameView.h>
61 #import <WebKit/WebHistory.h>
62 #import <WebKit/WebHistoryItemPrivate.h>
63 #import <WebKit/WebPluginDatabase.h>
64 #import <WebKit/WebPreferences.h>
65 #import <WebKit/WebPreferencesPrivate.h>
66 #import <WebKit/WebResourceLoadDelegate.h>
67 #import <WebKit/WebViewPrivate.h>
68 #import <getopt.h>
69 #import <mach-o/getsect.h>
70 #import <objc/objc-runtime.h>
71 #import <wtf/Assertions.h>
72 #import <wtf/RetainPtr.h>
73 #import <wtf/OwnPtr.h>
74
75 @interface DumpRenderTreeEvent : NSEvent
76 @end
77
78 static void runTest(const char *pathOrURL);
79
80 // Deciding when it's OK to dump out the state is a bit tricky.  All these must be true:
81 // - There is no load in progress
82 // - There is no work queued up (see workQueue var, below)
83 // - waitToDump==NO.  This means either waitUntilDone was never called, or it was called
84 //       and notifyDone was called subsequently.
85 // Note that the call to notifyDone and the end of the load can happen in either order.
86
87 volatile bool done;
88
89 NavigationController* navigationController = 0;
90 LayoutTestController* layoutTestController = 0;
91
92 WebFrame *mainFrame = 0;
93 // This is the topmost frame that is loading, during a given load, or nil when no load is 
94 // in progress.  Usually this is the same as the main frame, but not always.  In the case
95 // where a frameset is loaded, and then new content is loaded into one of the child frames,
96 // that child frame is the "topmost frame that is loading".
97 WebFrame *topLoadingFrame = nil;     // !nil iff a load is in progress
98
99
100 CFMutableSetRef disallowedURLs = 0;
101 CFRunLoopTimerRef waitToDumpWatchdog = 0;
102 OwnPtr<Watchdog> watchdog;
103
104 // Delegates
105 static FrameLoadDelegate *frameLoadDelegate;
106 static UIDelegate *uiDelegate;
107 static EditingDelegate *editingDelegate;
108 static ResourceLoadDelegate *resourceLoadDelegate;
109 PolicyDelegate *policyDelegate;
110
111 static int dumpPixels;
112 static int dumpAllPixels;
113 static int threaded;
114 static int testRepaintDefault;
115 static int repaintSweepHorizontallyDefault;
116 static int dumpTree = YES;
117 static BOOL printSeparators;
118 static NSString *currentTest = nil;
119 static RetainPtr<CFStringRef> persistentUserStyleSheetLocation;
120
121 static WebHistoryItem *prevTestBFItem = nil;  // current b/f item at the end of the previous test
122
123 const unsigned maxViewHeight = 600;
124 const unsigned maxViewWidth = 800;
125
126 void setPersistentUserStyleSheetLocation(CFStringRef url)
127 {
128     persistentUserStyleSheetLocation = url;
129 }
130
131 static BOOL shouldIgnoreWebCoreNodeLeaks(CFStringRef URLString)
132 {
133     static CFStringRef const ignoreSet[] = {
134         // Keeping this infrastructure around in case we ever need it again.
135     };
136     static const int ignoreSetCount = sizeof(ignoreSet) / sizeof(CFStringRef);
137     
138     for (int i = 0; i < ignoreSetCount; i++) {
139         CFStringRef ignoreString = ignoreSet[i];
140         CFRange range = CFRangeMake(0, CFStringGetLength(URLString));
141         CFOptionFlags flags = kCFCompareAnchored | kCFCompareBackwards | kCFCompareCaseInsensitive;
142         if (CFStringFindWithOptions(URLString, ignoreString, range, flags, NULL))
143             return YES;
144     }
145     return NO;
146 }
147
148 static void activateAhemFont()
149 {    
150     unsigned long fontDataLength;
151     char* fontData = getsectdata("__DATA", "Ahem", &fontDataLength);
152     if (!fontData) {
153         fprintf(stderr, "Failed to locate the Ahem font.\n");
154         exit(1);
155     }
156
157     ATSFontContainerRef fontContainer;
158     OSStatus status = ATSFontActivateFromMemory(fontData, fontDataLength, kATSFontContextLocal, kATSFontFormatUnspecified, NULL, kATSOptionFlagsDefault, &fontContainer);
159
160     if (status != noErr) {
161         fprintf(stderr, "Failed to activate the Ahem font.\n");
162         exit(1);
163     }
164 }
165
166 WebView *createWebViewAndOffscreenWindow()
167 {
168     NSRect rect = NSMakeRect(0, 0, maxViewWidth, maxViewHeight);
169     WebView *webView = [[WebView alloc] initWithFrame:rect frameName:nil groupName:@"org.webkit.DumpRenderTree"];
170         
171     [webView setUIDelegate:uiDelegate];
172     [webView setFrameLoadDelegate:frameLoadDelegate];
173     [webView setEditingDelegate:editingDelegate];
174     [webView setResourceLoadDelegate:resourceLoadDelegate];
175
176     // Register the same schemes that Safari does
177     [WebView registerURLSchemeAsLocal:@"feed"];
178     [WebView registerURLSchemeAsLocal:@"feeds"];
179     [WebView registerURLSchemeAsLocal:@"feedsearch"];
180     
181     [webView setContinuousSpellCheckingEnabled:YES];
182     
183     // To make things like certain NSViews, dragging, and plug-ins work, put the WebView a window, but put it off-screen so you don't see it.
184     // Put it at -10000, -10000 in "flipped coordinates", since WebCore and the DOM use flipped coordinates.
185     NSRect windowRect = NSOffsetRect(rect, -10000, [[[NSScreen screens] objectAtIndex:0] frame].size.height - rect.size.height + 10000);
186     DumpRenderTreeWindow *window = [[DumpRenderTreeWindow alloc] initWithContentRect:windowRect styleMask:NSBorderlessWindowMask backing:NSBackingStoreBuffered defer:YES];
187     [[window contentView] addSubview:webView];
188     [window orderBack:nil];
189     [window setAutodisplay:NO];
190     
191     // For reasons that are not entirely clear, the following pair of calls makes WebView handle its
192     // dynamic scrollbars properly. Without it, every frame will always have scrollbars.
193     NSBitmapImageRep *imageRep = [webView bitmapImageRepForCachingDisplayInRect:[webView bounds]];
194     [webView cacheDisplayInRect:[webView bounds] toBitmapImageRep:imageRep];
195         
196     return webView;
197 }
198
199 void testStringByEvaluatingJavaScriptFromString()
200 {
201     // maps expected result <= JavaScript expression
202     NSDictionary *expressions = [NSDictionary dictionaryWithObjectsAndKeys:
203         @"0", @"0", 
204         @"0", @"'0'", 
205         @"", @"",
206         @"", @"''", 
207         @"", @"new String()", 
208         @"", @"new String('0')", 
209         @"", @"throw 1", 
210         @"", @"{ }", 
211         @"", @"[ ]", 
212         @"", @"//", 
213         @"", @"a.b.c", 
214         @"", @"(function() { throw 'error'; })()", 
215         @"", @"null",
216         @"", @"undefined",
217         @"true", @"true",
218         @"false", @"false",
219         nil
220     ];
221
222     NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
223     WebView *webView = [[WebView alloc] initWithFrame:NSZeroRect frameName:@"" groupName:@""];
224
225     NSEnumerator *enumerator = [expressions keyEnumerator];
226     id expression;
227     while ((expression = [enumerator nextObject])) {
228         NSString *expectedResult = [expressions objectForKey:expression];
229         NSString *result = [webView stringByEvaluatingJavaScriptFromString:expression];
230         assert([result isEqualToString:expectedResult]);
231     }
232
233     [webView close];
234     [webView release];
235     [pool release];
236 }
237
238 static void setDefaultsToConsistentValuesForTesting()
239 {
240     // Give some clear to undocumented defaults values
241     static const int MediumFontSmoothing = 2;
242     static const int BlueTintedAppearance = 1;
243
244     NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
245     [defaults setObject:@"DoubleMax" forKey:@"AppleScrollBarVariant"];
246     [defaults setInteger:4 forKey:@"AppleAntiAliasingThreshold"]; // smallest font size to CG should perform antialiasing on
247     [defaults setInteger:MediumFontSmoothing forKey:@"AppleFontSmoothing"];
248     [defaults setInteger:BlueTintedAppearance forKey:@"AppleAquaColorVariant"];
249     [defaults setObject:@"0.709800 0.835300 1.000000" forKey:@"AppleHighlightColor"];
250     [defaults setObject:@"0.500000 0.500000 0.500000" forKey:@"AppleOtherHighlightColor"];
251     [defaults setObject:[NSArray arrayWithObject:@"en"] forKey:@"AppleLanguages"];
252
253     NSString *libraryPath = [@"~/Library/Application Support/DumpRenderTree" stringByExpandingTildeInPath];
254     [defaults setObject:[libraryPath stringByAppendingPathComponent:@"Databases"] forKey:WebDatabaseDirectoryDefaultsKey];
255     
256     WebPreferences *preferences = [WebPreferences standardPreferences];
257
258     [preferences setStandardFontFamily:@"Times"];
259     [preferences setFixedFontFamily:@"Courier"];
260     [preferences setSerifFontFamily:@"Times"];
261     [preferences setSansSerifFontFamily:@"Helvetica"];
262     [preferences setCursiveFontFamily:@"Apple Chancery"];
263     [preferences setFantasyFontFamily:@"Papyrus"];
264     [preferences setDefaultFontSize:16];
265     [preferences setDefaultFixedFontSize:13];
266     [preferences setMinimumFontSize:1];
267     [preferences setJavaEnabled:NO];
268     [preferences setEditableLinkBehavior:WebKitEditableLinkOnlyLiveWithShiftKey];
269     [preferences setTabsToLinks:NO];
270     [preferences setDOMPasteAllowed:YES];
271
272     // The back/forward cache is causing problems due to layouts during transition from one page to another.
273     // So, turn it off for now, but we might want to turn it back on some day.
274     [preferences setUsesPageCache:NO];
275 }
276
277 static void crashHandler(int sig)
278 {
279     fprintf(stderr, "%s\n", strsignal(sig));
280     restoreColorSpace(0);
281     exit(128 + sig);
282 }
283
284 static void installSignalHandlers()
285 {
286     signal(SIGILL, crashHandler);    /* 4:   illegal instruction (not reset when caught) */
287     signal(SIGTRAP, crashHandler);   /* 5:   trace trap (not reset when caught) */
288     signal(SIGEMT, crashHandler);    /* 7:   EMT instruction */
289     signal(SIGFPE, crashHandler);    /* 8:   floating point exception */
290     signal(SIGBUS, crashHandler);    /* 10:  bus error */
291     signal(SIGSEGV, crashHandler);   /* 11:  segmentation violation */
292     signal(SIGSYS, crashHandler);    /* 12:  bad argument to system call */
293     signal(SIGPIPE, crashHandler);   /* 13:  write on a pipe with no reader */
294     signal(SIGXCPU, crashHandler);   /* 24:  exceeded CPU time limit */
295     signal(SIGXFSZ, crashHandler);   /* 25:  exceeded file size limit */
296 }
297
298 static void allocateGlobalControllers()
299 {
300     // FIXME: We should remove these and move to the ObjC standard [Foo sharedInstance] model
301     navigationController = [[NavigationController alloc] init];
302     frameLoadDelegate = [[FrameLoadDelegate alloc] init];
303     uiDelegate = [[UIDelegate alloc] init];
304     editingDelegate = [[EditingDelegate alloc] init];
305     resourceLoadDelegate = [[ResourceLoadDelegate alloc] init];
306     policyDelegate = [[PolicyDelegate alloc] init];
307 }
308
309 // ObjC++ doens't seem to let me pass NSObject*& sadly.
310 static inline void releaseAndZero(NSObject** object)
311 {
312     [*object release];
313     *object = nil;
314 }
315
316 static void releaseGlobalControllers()
317 {
318     releaseAndZero(&navigationController);
319     releaseAndZero(&frameLoadDelegate);
320     releaseAndZero(&editingDelegate);
321     releaseAndZero(&resourceLoadDelegate);
322     releaseAndZero(&uiDelegate);
323     releaseAndZero(&policyDelegate);
324 }
325
326 static void initializeGlobalsFromCommandLineOptions(int argc, const char *argv[])
327 {
328     struct option options[] = {
329         {"dump-all-pixels", no_argument, &dumpAllPixels, YES},
330         {"horizontal-sweep", no_argument, &repaintSweepHorizontallyDefault, YES},
331         {"notree", no_argument, &dumpTree, NO},
332         {"pixel-tests", no_argument, &dumpPixels, YES},
333         {"repaint", no_argument, &testRepaintDefault, YES},
334         {"tree", no_argument, &dumpTree, YES},
335         {"threaded", no_argument, &threaded, YES},
336         {NULL, 0, NULL, 0}
337     };
338     
339     int option;
340     while ((option = getopt_long(argc, (char * const *)argv, "", options, NULL)) != -1) {
341         switch (option) {
342             case '?':   // unknown or ambiguous option
343             case ':':   // missing argument
344                 exit(1);
345                 break;
346         }
347     }
348 }
349
350 static void addTestPluginsToPluginSearchPath(const char* executablePath)
351 {
352     NSString *pwd = [[NSString stringWithUTF8String:executablePath] stringByDeletingLastPathComponent];
353     [WebPluginDatabase setAdditionalWebPlugInPaths:[NSArray arrayWithObject:pwd]];
354     [[WebPluginDatabase sharedDatabase] refresh];
355 }
356
357 static bool useLongRunningServerMode(int argc, const char *argv[])
358 {
359     // This assumes you've already called getopt_long
360     return (argc == optind+1 && strcmp(argv[optind], "-") == 0);
361 }
362
363 static void runTestingServerLoop()
364 {
365     // When DumpRenderTree run in server mode, we just wait around for file names
366     // to be passed to us and read each in turn, passing the results back to the client
367     char filenameBuffer[2048];
368     while (fgets(filenameBuffer, sizeof(filenameBuffer), stdin)) {
369         char *newLineCharacter = strchr(filenameBuffer, '\n');
370         if (newLineCharacter)
371             *newLineCharacter = '\0';
372
373         if (strlen(filenameBuffer) == 0)
374             continue;
375
376         runTest(filenameBuffer);
377     }
378 }
379
380 static void prepareConsistentTestingEnvironment()
381 {
382     class_poseAs(objc_getClass("DumpRenderTreePasteboard"), objc_getClass("NSPasteboard"));
383     class_poseAs(objc_getClass("DumpRenderTreeEvent"), objc_getClass("NSEvent"));
384
385     setDefaultsToConsistentValuesForTesting();
386     activateAhemFont();
387     
388     if (dumpPixels)
389         initializeColorSpaceAndScreeBufferForPixelTests();
390     allocateGlobalControllers();
391     
392     makeLargeMallocFailSilently();
393 }
394
395 void dumpRenderTree(int argc, const char *argv[])
396 {
397     initializeGlobalsFromCommandLineOptions(argc, argv);
398     prepareConsistentTestingEnvironment();
399     addTestPluginsToPluginSearchPath(argv[0]);
400     if (dumpPixels)
401         installSignalHandlers();
402     
403     WebView *webView = createWebViewAndOffscreenWindow();
404     mainFrame = [webView mainFrame];
405
406     [[NSURLCache sharedURLCache] removeAllCachedResponses];
407
408     // <rdar://problem/5222911>
409     testStringByEvaluatingJavaScriptFromString();
410
411     if (threaded)
412         startJavaScriptThreads();
413
414     watchdog.set(new WatchdogMac());
415     watchdog->start();
416
417     if (useLongRunningServerMode(argc, argv)) {
418         printSeparators = YES;
419         runTestingServerLoop();
420     } else {
421         printSeparators = (optind < argc-1 || (dumpPixels && dumpTree));
422         for (int i = optind; i != argc; ++i)
423             runTest(argv[i]);
424     }
425     watchdog->stop();
426     watchdog.clear();
427
428     if (threaded)
429         stopJavaScriptThreads();
430
431     [WebCoreStatistics emptyCache]; // Otherwise SVGImages trigger false positives for Frame/Node counts    
432     [webView close];
433     mainFrame = nil;
434
435     // Work around problem where registering drag types leaves an outstanding
436     // "perform selector" on the window, which retains the window. It's a bit
437     // inelegant and perhaps dangerous to just blow them all away, but in practice
438     // it probably won't cause any trouble (and this is just a test tool, after all).
439     NSWindow *window = [webView window];
440     [NSObject cancelPreviousPerformRequestsWithTarget:window];
441     
442     [window close]; // releases when closed
443     [webView release];
444     
445     releaseGlobalControllers();
446     
447     [DumpRenderTreePasteboard releaseLocalPasteboards];
448
449     // FIXME: This should be moved onto LayoutTestController and made into a HashSet
450     if (disallowedURLs) {
451         CFRelease(disallowedURLs);
452         disallowedURLs = 0;
453     }
454
455     if (dumpPixels)
456         restoreColorSpace(0);
457 }
458
459 int main(int argc, const char *argv[])
460 {
461     NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
462     [NSApplication sharedApplication]; // Force AppKit to init itself
463     dumpRenderTree(argc, argv);
464     [WebCoreStatistics garbageCollectJavaScriptObjects];
465     [pool release];
466     return 0;
467 }
468
469 static int compareHistoryItems(id item1, id item2, void *context)
470 {
471     return [[item1 target] caseInsensitiveCompare:[item2 target]];
472 }
473
474 static void dumpHistoryItem(WebHistoryItem *item, int indent, BOOL current)
475 {
476     int start = 0;
477     if (current) {
478         printf("curr->");
479         start = 6;
480     }
481     for (int i = start; i < indent; i++)
482         putchar(' ');
483     printf("%s", [[item URLString] UTF8String]);
484     NSString *target = [item target];
485     if (target && [target length] > 0)
486         printf(" (in frame \"%s\")", [target UTF8String]);
487     if ([item isTargetItem])
488         printf("  **nav target**");
489     putchar('\n');
490     NSArray *kids = [item children];
491     if (kids) {
492         // must sort to eliminate arbitrary result ordering which defeats reproducible testing
493         kids = [kids sortedArrayUsingFunction:&compareHistoryItems context:nil];
494         for (unsigned i = 0; i < [kids count]; i++)
495             dumpHistoryItem([kids objectAtIndex:i], indent+4, NO);
496     }
497 }
498
499 static void dumpFrameScrollPosition(WebFrame *f)
500 {
501     NSPoint scrollPosition = [[[[f frameView] documentView] superview] bounds].origin;
502     if (ABS(scrollPosition.x) > 0.00000001 || ABS(scrollPosition.y) > 0.00000001) {
503         if ([f parentFrame] != nil)
504             printf("frame '%s' ", [[f name] UTF8String]);
505         printf("scrolled to %.f,%.f\n", scrollPosition.x, scrollPosition.y);
506     }
507
508     if (layoutTestController->dumpChildFrameScrollPositions()) {
509         NSArray *kids = [f childFrames];
510         if (kids)
511             for (unsigned i = 0; i < [kids count]; i++)
512                 dumpFrameScrollPosition([kids objectAtIndex:i]);
513     }
514 }
515
516 static NSString *dumpFramesAsText(WebFrame *frame)
517 {
518     DOMDocument *document = [frame DOMDocument];
519     DOMElement *documentElement = [document documentElement];
520
521     if (!documentElement)
522         return @"";
523
524     NSMutableString *result = [[[NSMutableString alloc] init] autorelease];
525
526     // Add header for all but the main frame.
527     if ([frame parentFrame])
528         result = [NSMutableString stringWithFormat:@"\n--------\nFrame: '%@'\n--------\n", [frame name]];
529
530     [result appendFormat:@"%@\n", [documentElement innerText]];
531
532     if (layoutTestController->dumpChildFramesAsText()) {
533         NSArray *kids = [frame childFrames];
534         if (kids) {
535             for (unsigned i = 0; i < [kids count]; i++)
536                 [result appendString:dumpFramesAsText([kids objectAtIndex:i])];
537         }
538     }
539
540     return result;
541 }
542
543 static void convertMIMEType(NSMutableString *mimeType)
544 {
545     if ([mimeType isEqualToString:@"application/x-javascript"])
546         [mimeType setString:@"text/javascript"];
547 }
548
549 static void convertWebResourceDataToString(NSMutableDictionary *resource)
550 {
551     NSMutableString *mimeType = [resource objectForKey:@"WebResourceMIMEType"];
552     convertMIMEType(mimeType);
553     
554     if ([mimeType hasPrefix:@"text/"]) {
555         NSData *data = [resource objectForKey:@"WebResourceData"];
556         NSString *dataAsString = [[[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding] autorelease];
557         [resource setObject:dataAsString forKey:@"WebResourceData"];
558     }
559 }
560
561 static void normalizeWebResourceURL(NSMutableString *webResourceURL)
562 {
563     static int fileUrlLength = [@"file://" length];
564     NSRange layoutTestsWebArchivePathRange = [webResourceURL rangeOfString:@"/LayoutTests/" options:NSBackwardsSearch];
565     if (layoutTestsWebArchivePathRange.location == NSNotFound)
566         return;
567     NSRange currentWorkingDirectoryRange = NSMakeRange(fileUrlLength, layoutTestsWebArchivePathRange.location - fileUrlLength);
568     [webResourceURL replaceCharactersInRange:currentWorkingDirectoryRange withString:@""];
569 }
570
571 static void convertWebResourceResponseToDictionary(NSMutableDictionary *propertyList)
572 {
573     NSURLResponse *response = nil;
574     NSData *responseData = [propertyList objectForKey:@"WebResourceResponse"]; // WebResourceResponseKey in WebResource.m
575     if ([responseData isKindOfClass:[NSData class]]) {
576         // Decode NSURLResponse
577         NSKeyedUnarchiver *unarchiver = [[NSKeyedUnarchiver alloc] initForReadingWithData:responseData];
578         response = [unarchiver decodeObjectForKey:@"WebResourceResponse"]; // WebResourceResponseKey in WebResource.m
579         [unarchiver finishDecoding];
580         [unarchiver release];
581     }        
582     
583     NSMutableDictionary *responseDictionary = [[NSMutableDictionary alloc] init];
584     
585     NSMutableString *urlString = [[[response URL] description] mutableCopy];
586     normalizeWebResourceURL(urlString);
587     [responseDictionary setObject:urlString forKey:@"URL"];
588     [urlString release];
589     
590     NSMutableString *mimeTypeString = [[response MIMEType] mutableCopy];
591     convertMIMEType(mimeTypeString);
592     [responseDictionary setObject:mimeTypeString forKey:@"MIMEType"];
593     [mimeTypeString release];
594
595     NSString *textEncodingName = [response textEncodingName];
596     if (textEncodingName)
597         [responseDictionary setObject:textEncodingName forKey:@"textEncodingName"];
598     [responseDictionary setObject:[NSNumber numberWithLongLong:[response expectedContentLength]] forKey:@"expectedContentLength"];
599     
600     if ([response isKindOfClass:[NSHTTPURLResponse class]]) {
601         NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *)response;
602         
603         [responseDictionary setObject:[httpResponse allHeaderFields] forKey:@"allHeaderFields"];
604         [responseDictionary setObject:[NSNumber numberWithInt:[httpResponse statusCode]] forKey:@"statusCode"];
605     }
606     
607     [propertyList setObject:responseDictionary forKey:@"WebResourceResponse"];
608     [responseDictionary release];
609 }
610
611 static NSString *serializeWebArchiveToXML(WebArchive *webArchive)
612 {
613     NSString *errorString;
614     NSMutableDictionary *propertyList = [NSPropertyListSerialization propertyListFromData:[webArchive data]
615                                                                          mutabilityOption:NSPropertyListMutableContainersAndLeaves
616                                                                                    format:NULL
617                                                                          errorDescription:&errorString];
618     if (!propertyList)
619         return errorString;
620
621     NSMutableArray *resources = [NSMutableArray arrayWithCapacity:1];
622     [resources addObject:propertyList];
623
624     while ([resources count]) {
625         NSMutableDictionary *resourcePropertyList = [resources objectAtIndex:0];
626         [resources removeObjectAtIndex:0];
627
628         NSMutableDictionary *mainResource = [resourcePropertyList objectForKey:@"WebMainResource"];
629         normalizeWebResourceURL([mainResource objectForKey:@"WebResourceURL"]);
630         convertWebResourceDataToString(mainResource);
631
632         // Add subframeArchives to list for processing
633         NSMutableArray *subframeArchives = [resourcePropertyList objectForKey:@"WebSubframeArchives"]; // WebSubframeArchivesKey in WebArchive.m
634         if (subframeArchives)
635             [resources addObjectsFromArray:subframeArchives];
636
637         NSMutableArray *subresources = [resourcePropertyList objectForKey:@"WebSubresources"]; // WebSubresourcesKey in WebArchive.m
638         NSEnumerator *enumerator = [subresources objectEnumerator];
639         NSMutableDictionary *subresourcePropertyList;
640         while ((subresourcePropertyList = [enumerator nextObject])) {
641             normalizeWebResourceURL([subresourcePropertyList objectForKey:@"WebResourceURL"]);
642             convertWebResourceResponseToDictionary(subresourcePropertyList);
643             convertWebResourceDataToString(subresourcePropertyList);
644         }
645     }
646
647     NSData *xmlData = [NSPropertyListSerialization dataFromPropertyList:propertyList
648                                                                  format:NSPropertyListXMLFormat_v1_0
649                                                        errorDescription:&errorString];
650     if (!xmlData)
651         return errorString;
652
653     NSMutableString *string = [[[NSMutableString alloc] initWithData:xmlData encoding:NSUTF8StringEncoding] autorelease];
654
655     // Replace "Apple Computer" with "Apple" in the DTD declaration.
656     NSRange range = [string rangeOfString:@"-//Apple Computer//"];
657     if (range.location != NSNotFound)
658         [string replaceCharactersInRange:range withString:@"-//Apple//"];
659     
660     return string;
661 }
662
663 static void dumpBackForwardListForWebView(WebView *view)
664 {
665     printf("\n============== Back Forward List ==============\n");
666     WebBackForwardList *bfList = [view backForwardList];
667
668     // Print out all items in the list after prevTestBFItem, which was from the previous test
669     // Gather items from the end of the list, the print them out from oldest to newest
670     NSMutableArray *itemsToPrint = [[NSMutableArray alloc] init];
671     for (int i = [bfList forwardListCount]; i > 0; i--) {
672         WebHistoryItem *item = [bfList itemAtIndex:i];
673         // something is wrong if the item from the last test is in the forward part of the b/f list
674         assert(item != prevTestBFItem);
675         [itemsToPrint addObject:item];
676     }
677             
678     assert([bfList currentItem] != prevTestBFItem);
679     [itemsToPrint addObject:[bfList currentItem]];
680     int currentItemIndex = [itemsToPrint count] - 1;
681
682     for (int i = -1; i >= -[bfList backListCount]; i--) {
683         WebHistoryItem *item = [bfList itemAtIndex:i];
684         if (item == prevTestBFItem)
685             break;
686         [itemsToPrint addObject:item];
687     }
688
689     for (int i = [itemsToPrint count]-1; i >= 0; i--)
690         dumpHistoryItem([itemsToPrint objectAtIndex:i], 8, i == currentItemIndex);
691
692     [itemsToPrint release];
693     printf("===============================================\n");
694 }
695
696 static void sizeWebViewForCurrentTest()
697 {
698     // W3C SVG tests expect to be 480x360
699     bool isSVGW3CTest = ([currentTest rangeOfString:@"svg/W3C-SVG-1.1"].length);
700     if (isSVGW3CTest)
701         [[mainFrame webView] setFrameSize:NSMakeSize(480, 360)];
702     else
703         [[mainFrame webView] setFrameSize:NSMakeSize(maxViewWidth, maxViewHeight)];
704 }
705
706 static const char *methodNameStringForFailedTest()
707 {
708     const char *errorMessage;
709     if (layoutTestController->dumpAsText())
710         errorMessage = "[documentElement innerText]";
711     else if (layoutTestController->dumpDOMAsWebArchive())
712         errorMessage = "[[mainFrame DOMDocument] webArchive]";
713     else if (layoutTestController->dumpSourceAsWebArchive())
714         errorMessage = "[[mainFrame dataSource] webArchive]";
715     else
716         errorMessage = "[mainFrame renderTreeAsExternalRepresentation]";
717
718     return errorMessage;
719 }
720
721 static void dumpBackForwardListForAllWindows()
722 {
723     CFArrayRef openWindows = (CFArrayRef)[DumpRenderTreeWindow openWindows];
724     unsigned count = CFArrayGetCount(openWindows);
725     for (unsigned i = 0; i < count; i++) {
726         NSWindow *window = (NSWindow *)CFArrayGetValueAtIndex(openWindows, i);
727         WebView *webView = [[[window contentView] subviews] objectAtIndex:0];
728         dumpBackForwardListForWebView(webView);
729     }
730 }
731
732 static void invalidateAnyPreviousWaitToDumpWatchdog()
733 {
734     if (waitToDumpWatchdog) {
735         CFRunLoopTimerInvalidate(waitToDumpWatchdog);
736         CFRelease(waitToDumpWatchdog);
737         waitToDumpWatchdog = 0;
738     }
739 }
740
741 void dump()
742 {
743     invalidateAnyPreviousWaitToDumpWatchdog();
744
745     if (dumpTree) {
746         NSString *resultString = nil;
747         NSData *resultData = nil;
748
749         bool dumpAsText = layoutTestController->dumpAsText();
750         dumpAsText |= [[[mainFrame dataSource] _responseMIMEType] isEqualToString:@"text/plain"];
751         layoutTestController->setDumpAsText(dumpAsText);
752         if (layoutTestController->dumpAsText()) {
753             resultString = dumpFramesAsText(mainFrame);
754         } else if (layoutTestController->dumpDOMAsWebArchive()) {
755             WebArchive *webArchive = [[mainFrame DOMDocument] webArchive];
756             resultString = serializeWebArchiveToXML(webArchive);
757         } else if (layoutTestController->dumpSourceAsWebArchive()) {
758             WebArchive *webArchive = [[mainFrame dataSource] webArchive];
759             resultString = serializeWebArchiveToXML(webArchive);
760         } else {
761             sizeWebViewForCurrentTest();
762             resultString = [mainFrame renderTreeAsExternalRepresentation];
763         }
764
765         if (resultString && !resultData)
766             resultData = [resultString dataUsingEncoding:NSUTF8StringEncoding];
767
768         if (resultData) {
769             fwrite([resultData bytes], 1, [resultData length], stdout);
770
771             if (!layoutTestController->dumpAsText() && !layoutTestController->dumpDOMAsWebArchive() && !layoutTestController->dumpSourceAsWebArchive())
772                 dumpFrameScrollPosition(mainFrame);
773
774             if (layoutTestController->dumpBackForwardList())
775                 dumpBackForwardListForAllWindows();
776         } else
777             printf("ERROR: nil result from %s", methodNameStringForFailedTest());
778
779         if (printSeparators) {
780             puts("#EOF");
781             fputs("#EOF\n", stderr);
782         }            
783     }
784     
785     if (dumpPixels)
786         dumpWebViewAsPixelsAndCompareWithExpected([currentTest UTF8String], dumpAllPixels);
787
788     fflush(stdout);
789     fflush(stderr);
790
791     done = YES;
792 }
793
794 static bool shouldLogFrameLoadDelegates(const char *pathOrURL)
795 {
796     return strstr(pathOrURL, "loading/");
797 }
798
799 static CFURLRef createCFURLFromPathOrURL(CFStringRef pathOrURLString)
800 {
801     CFURLRef URL;
802     if (CFStringHasPrefix(pathOrURLString, CFSTR("http://")) || CFStringHasPrefix(pathOrURLString, CFSTR("https://")))
803         URL = CFURLCreateWithString(NULL, pathOrURLString, NULL);
804     else
805         URL = CFURLCreateWithFileSystemPath(NULL, pathOrURLString, kCFURLPOSIXPathStyle, FALSE);
806     return URL;
807 }
808
809 static void resetWebViewToConsistentStateBeforeTesting()
810 {
811     WebView *webView = [mainFrame webView];
812     [(EditingDelegate *)[webView editingDelegate] setAcceptsEditing:YES];
813     [webView makeTextStandardSize:nil];
814     [webView resetPageZoom:nil];
815     [webView setTabKeyCyclesThroughElements:YES];
816     [webView setPolicyDelegate:nil];
817     [webView _setDashboardBehavior:WebDashboardBehaviorUseBackwardCompatibilityMode to:NO];
818
819     WebPreferences *preferences = [webView preferences];
820     [preferences setPrivateBrowsingEnabled:NO];
821     [preferences setAuthorAndUserStylesEnabled:YES];
822     [preferences setJavaScriptCanOpenWindowsAutomatically:YES];
823
824     if (persistentUserStyleSheetLocation) {
825         [preferences setUserStyleSheetLocation:[NSURL URLWithString:(NSString *)(persistentUserStyleSheetLocation.get())]];
826         [preferences setUserStyleSheetEnabled:YES];
827     } else
828         [preferences setUserStyleSheetEnabled:NO];
829
830     [WebView _setUsesTestModeFocusRingColor:YES];
831 }
832
833 static void runTest(const char *pathOrURL)
834 {
835     CFStringRef pathOrURLString = CFStringCreateWithCString(NULL, pathOrURL, kCFStringEncodingUTF8);
836     if (!pathOrURLString) {
837         fprintf(stderr, "Failed to parse filename as UTF-8: %s\n", pathOrURL);
838         return;
839     }
840
841     CFURLRef URL = createCFURLFromPathOrURL(pathOrURLString);
842     if (!URL) {
843         CFRelease(pathOrURLString);
844         fprintf(stderr, "Can't turn %s into a CFURL\n", pathOrURL);
845         return;
846     }
847
848     resetWebViewToConsistentStateBeforeTesting();
849
850     layoutTestController = new LayoutTestController(testRepaintDefault, repaintSweepHorizontallyDefault);
851     topLoadingFrame = nil;
852     done = NO;
853
854     if (disallowedURLs)
855         CFSetRemoveAllValues(disallowedURLs);
856     if (shouldLogFrameLoadDelegates(pathOrURL))
857         layoutTestController->setDumpFrameLoadCallbacks(true);
858
859     if ([WebHistory optionalSharedHistory])
860         [WebHistory setOptionalSharedHistory:nil];
861     lastMousePosition = NSZeroPoint;
862     lastClickPosition = NSZeroPoint;
863
864     if (currentTest != nil)
865         CFRelease(currentTest);
866     currentTest = (NSString *)pathOrURLString;
867     [prevTestBFItem release];
868     prevTestBFItem = [[[[mainFrame webView] backForwardList] currentItem] retain];
869
870     WorkQueue::shared()->clear();
871     WorkQueue::shared()->setFrozen(false);
872
873     BOOL _shouldIgnoreWebCoreNodeLeaks = shouldIgnoreWebCoreNodeLeaks(CFURLGetString(URL));
874     if (_shouldIgnoreWebCoreNodeLeaks)
875         [WebCoreStatistics startIgnoringWebCoreNodeLeaks];
876
877     NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
878     [mainFrame loadRequest:[NSURLRequest requestWithURL:(NSURL *)URL]];
879     CFRelease(URL);
880     [pool release];
881     while (!done) {
882         pool = [[NSAutoreleasePool alloc] init];
883         [[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:[NSDate distantPast]];
884         [pool release];
885     }
886     pool = [[NSAutoreleasePool alloc] init];
887     [EventSendingController clearSavedEvents];
888     [[mainFrame webView] setSelectedDOMRange:nil affinity:NSSelectionAffinityDownstream];
889
890     WorkQueue::shared()->clear();
891
892     if (layoutTestController->closeRemainingWindowsWhenComplete()) {
893         NSArray* array = [DumpRenderTreeWindow openWindows];
894
895         unsigned count = [array count];
896         for (unsigned i = 0; i < count; i++) {
897             NSWindow *window = [array objectAtIndex:i];
898
899             // Don't try to close the main window
900             if (window == [[mainFrame webView] window])
901                 continue;
902             
903             WebView *webView = [[[window contentView] subviews] objectAtIndex:0];
904
905             [webView close];
906             [window close];
907         }
908     }
909     
910     [mainFrame loadHTMLString:@"<html></html>" baseURL:[NSURL URLWithString:@"about:blank"]];
911     [mainFrame stopLoading];
912     
913     [pool release];
914
915     // We should only have our main window left open when we're done
916     ASSERT(CFArrayGetCount(openWindowsRef) == 1);
917     ASSERT(CFArrayGetValueAtIndex(openWindowsRef, 0) == [[mainFrame webView] window]);
918
919     delete layoutTestController;
920     layoutTestController = 0;
921
922     if (_shouldIgnoreWebCoreNodeLeaks)
923         [WebCoreStatistics stopIgnoringWebCoreNodeLeaks];
924         
925     // Check-in with the watchdog after every test is complete
926     watchdog->checkIn();
927 }
928
929 void displayWebView()
930 {
931     NSView *webView = [mainFrame webView];
932     [webView display];
933     [webView lockFocus];
934     [[[NSColor blackColor] colorWithAlphaComponent:0.66] set];
935     NSRectFillUsingOperation([webView frame], NSCompositeSourceOver);
936     [webView unlockFocus];
937 }
938
939 @implementation DumpRenderTreeEvent
940
941 + (NSPoint)mouseLocation
942 {
943     return [[[mainFrame webView] window] convertBaseToScreen:lastMousePosition];
944 }
945
946 @end