summaryrefslogtreecommitdiff
path: root/tests/test_tools/simpletest/frames.php
blob: 5ea49f35c7c345a80dc3dacf53823f501814aff6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
<?php
    /**
     *	Base include file for SimpleTest
     *	@package	SimpleTest
     *	@subpackage	WebTester
     *	@version	$Id$
     */

    /**#@+
     *	include other SimpleTest class files
     */
    require_once(dirname(__FILE__) . '/page.php');
    require_once(dirname(__FILE__) . '/user_agent.php');
    /**#@-*/

    /**
     *    A composite page. Wraps a frameset page and
     *    adds subframes. The original page will be
     *    mostly ignored. Implements the SimplePage
     *    interface so as to be interchangeable.
	 *    @package SimpleTest
	 *    @subpackage WebTester
     */
    class SimpleFrameset {
        protected $_frameset;
        protected $_frames;
        protected $_focus;
        protected $_names;

        /**
         *    Stashes the frameset page. Will make use of the
         *    browser to fetch the sub frames recursively.
         *    @param SimplePage $page        Frameset page.
         */
        function SimpleFrameset($page) {
            $this->_frameset = $page;
            $this->_frames = array();
            $this->_focus = false;
            $this->_names = array();
        }

        /**
         *    Adds a parsed page to the frameset.
         *    @param SimplePage $page    Frame page.
         *    @param string $name        Name of frame in frameset.
         *    @access public
         */
        function addFrame($page, $name = false) {
            $this->_frames[] = $page;
            if ($name) {
                $this->_names[$name] = count($this->_frames) - 1;
            }
        }

        /**
         *    Replaces existing frame with another. If the
         *    frame is nested, then the call is passed down
         *    one level.
         *    @param array $path        Path of frame in frameset.
         *    @param SimplePage $page   Frame source.
         *    @access public
         */
        function setFrame($path, $page) {
            $name = array_shift($path);
            if (isset($this->_names[$name])) {
                $index = $this->_names[$name];
            } else {
                $index = $name - 1;
            }
            if (count($path) == 0) {
                $this->_frames[$index] = $page;
                return;
            }
            $this->_frames[$index]->setFrame($path, $page);
        }

        /**
         *    Accessor for current frame focus. Will be
         *    false if no frame has focus. Will have the nested
         *    frame focus if any.
         *    @return array     Labels or indexes of nested frames.
         *    @access public
         */
        function getFrameFocus() {
            if ($this->_focus === false) {
                return array();
            }
            return array_merge(
                    array($this->_getPublicNameFromIndex($this->_focus)),
                    $this->_frames[$this->_focus]->getFrameFocus());
        }

        /**
         *    Turns an internal array index into the frames list
         *    into a public name, or if none, then a one offset
         *    index.
         *    @param integer $subject    Internal index.
         *    @return integer/string     Public name.
         *    @access private
         */
        function _getPublicNameFromIndex($subject) {
            foreach ($this->_names as $name => $index) {
                if ($subject == $index) {
                    return $name;
                }
            }
            return $subject + 1;
        }

        /**
         *    Sets the focus by index. The integer index starts from 1.
         *    If already focused and the target frame also has frames,
         *    then the nested frame will be focused.
         *    @param integer $choice    Chosen frame.
         *    @return boolean           True if frame exists.
         *    @access public
         */
        function setFrameFocusByIndex($choice) {
            if (is_integer($this->_focus)) {
                if ($this->_frames[$this->_focus]->hasFrames()) {
                    return $this->_frames[$this->_focus]->setFrameFocusByIndex($choice);
                }
            }
            if (($choice < 1) || ($choice > count($this->_frames))) {
                return false;
            }
            $this->_focus = $choice - 1;
            return true;
        }

        /**
         *    Sets the focus by name. If already focused and the
         *    target frame also has frames, then the nested frame
         *    will be focused.
         *    @param string $name    Chosen frame.
         *    @return boolean        True if frame exists.
         *    @access public
         */
        function setFrameFocus($name) {
            if (is_integer($this->_focus)) {
                if ($this->_frames[$this->_focus]->hasFrames()) {
                    return $this->_frames[$this->_focus]->setFrameFocus($name);
                }
            }
            if (in_array($name, array_keys($this->_names))) {
                $this->_focus = $this->_names[$name];
                return true;
            }
            return false;
        }

        /**
         *    Clears the frame focus.
         *    @access public
         */
        function clearFrameFocus() {
            $this->_focus = false;
            $this->_clearNestedFramesFocus();
        }

        /**
         *    Clears the frame focus for any nested frames.
         *    @access private
         */
        function _clearNestedFramesFocus() {
            for ($i = 0; $i < count($this->_frames); $i++) {
                $this->_frames[$i]->clearFrameFocus();
            }
        }

        /**
         *    Test for the presence of a frameset.
         *    @return boolean        Always true.
         *    @access public
         */
        function hasFrames() {
            return true;
        }

        /**
         *    Accessor for frames information.
         *    @return array/string      Recursive hash of frame URL strings.
         *                              The key is either a numerical
         *                              index or the name attribute.
         *    @access public
         */
        function getFrames() {
            $report = array();
            for ($i = 0; $i < count($this->_frames); $i++) {
                $report[$this->_getPublicNameFromIndex($i)] =
                        $this->_frames[$i]->getFrames();
            }
            return $report;
        }

        /**
         *    Accessor for raw text of either all the pages or
         *    the frame in focus.
         *    @return string        Raw unparsed content.
         *    @access public
         */
        function getRaw() {
            if (is_integer($this->_focus)) {
                return $this->_frames[$this->_focus]->getRaw();
            }
            $raw = '';
            for ($i = 0; $i < count($this->_frames); $i++) {
                $raw .= $this->_frames[$i]->getRaw();
            }
            return $raw;
        }

        /**
         *    Accessor for plain text of either all the pages or
         *    the frame in focus.
         *    @return string        Plain text content.
         *    @access public
         */
        function getText() {
            if (is_integer($this->_focus)) {
                return $this->_frames[$this->_focus]->getText();
            }
            $raw = '';
            for ($i = 0; $i < count($this->_frames); $i++) {
                $raw .= ' ' . $this->_frames[$i]->getText();
            }
            return trim($raw);
        }

        /**
         *    Accessor for last error.
         *    @return string        Error from last response.
         *    @access public
         */
        function getTransportError() {
            if (is_integer($this->_focus)) {
                return $this->_frames[$this->_focus]->getTransportError();
            }
            return $this->_frameset->getTransportError();
        }

        /**
         *    Request method used to fetch this frame.
         *    @return string      GET, POST or HEAD.
         *    @access public
         */
        function getMethod() {
            if (is_integer($this->_focus)) {
                return $this->_frames[$this->_focus]->getMethod();
            }
            return $this->_frameset->getMethod();
        }

        /**
         *    Original resource name.
         *    @return SimpleUrl        Current url.
         *    @access public
         */
        function getUrl() {
            if (is_integer($this->_focus)) {
                $url = $this->_frames[$this->_focus]->getUrl();
                $url->setTarget($this->_getPublicNameFromIndex($this->_focus));
            } else {
                $url = $this->_frameset->getUrl();
            }
            return $url;
        }

        /**
         *    Original request data.
         *    @return mixed              Sent content.
         *    @access public
         */
        function getRequestData() {
            if (is_integer($this->_focus)) {
                return $this->_frames[$this->_focus]->getRequestData();
            }
            return $this->_frameset->getRequestData();
        }

        /**
         *    Accessor for current MIME type.
         *    @return string    MIME type as string; e.g. 'text/html'
         *    @access public
         */
        function getMimeType() {
            if (is_integer($this->_focus)) {
                return $this->_frames[$this->_focus]->getMimeType();
            }
            return $this->_frameset->getMimeType();
        }

        /**
         *    Accessor for last response code.
         *    @return integer    Last HTTP response code received.
         *    @access public
         */
        function getResponseCode() {
            if (is_integer($this->_focus)) {
                return $this->_frames[$this->_focus]->getResponseCode();
            }
            return $this->_frameset->getResponseCode();
        }

        /**
         *    Accessor for last Authentication type. Only valid
         *    straight after a challenge (401).
         *    @return string    Description of challenge type.
         *    @access public
         */
        function getAuthentication() {
            if (is_integer($this->_focus)) {
                return $this->_frames[$this->_focus]->getAuthentication();
            }
            return $this->_frameset->getAuthentication();
        }

        /**
         *    Accessor for last Authentication realm. Only valid
         *    straight after a challenge (401).
         *    @return string    Name of security realm.
         *    @access public
         */
        function getRealm() {
            if (is_integer($this->_focus)) {
                return $this->_frames[$this->_focus]->getRealm();
            }
            return $this->_frameset->getRealm();
        }

        /**
         *    Accessor for outgoing header information.
         *    @return string      Header block.
         *    @access public
         */
        function getRequest() {
            if (is_integer($this->_focus)) {
                return $this->_frames[$this->_focus]->getRequest();
            }
            return $this->_frameset->getRequest();
        }

        /**
         *    Accessor for raw header information.
         *    @return string      Header block.
         *    @access public
         */
        function getHeaders() {
            if (is_integer($this->_focus)) {
                return $this->_frames[$this->_focus]->getHeaders();
            }
            return $this->_frameset->getHeaders();
        }

        /**
         *    Accessor for parsed title.
         *    @return string     Title or false if no title is present.
         *    @access public
         */
        function getTitle() {
            return $this->_frameset->getTitle();
        }

        /**
         *    Accessor for a list of all fixed links.
         *    @return array   List of urls with scheme of
         *                    http or https and hostname.
         *    @access public
         */
        function getAbsoluteUrls() {
            if (is_integer($this->_focus)) {
                return $this->_frames[$this->_focus]->getAbsoluteUrls();
            }
            $urls = array();
            foreach ($this->_frames as $frame) {
                $urls = array_merge($urls, $frame->getAbsoluteUrls());
            }
            return array_values(array_unique($urls));
        }

        /**
         *    Accessor for a list of all relative links.
         *    @return array      List of urls without hostname.
         *    @access public
         */
        function getRelativeUrls() {
            if (is_integer($this->_focus)) {
                return $this->_frames[$this->_focus]->getRelativeUrls();
            }
            $urls = array();
            foreach ($this->_frames as $frame) {
                $urls = array_merge($urls, $frame->getRelativeUrls());
            }
            return array_values(array_unique($urls));
        }

        /**
         *    Accessor for URLs by the link label. Label will match
         *    regardess of whitespace issues and case.
         *    @param string $label    Text of link.
         *    @return array           List of links with that label.
         *    @access public
         */
        function getUrlsByLabel($label) {
            if (is_integer($this->_focus)) {
                return $this->_tagUrlsWithFrame(
                        $this->_frames[$this->_focus]->getUrlsByLabel($label),
                        $this->_focus);
            }
            $urls = array();
            foreach ($this->_frames as $index => $frame) {
                $urls = array_merge(
                        $urls,
                        $this->_tagUrlsWithFrame(
                                    $frame->getUrlsByLabel($label),
                                    $index));
            }
            return $urls;
        }

        /**
         *    Accessor for a URL by the id attribute. If in a frameset
         *    then the first link found with that ID attribute is
         *    returned only. Focus on a frame if you want one from
         *    a specific part of the frameset.
         *    @param string $id       Id attribute of link.
         *    @return string          URL with that id.
         *    @access public
         */
        function getUrlById($id) {
            foreach ($this->_frames as $index => $frame) {
                if ($url = $frame->getUrlById($id)) {
                    if (! $url->gettarget()) {
                        $url->setTarget($this->_getPublicNameFromIndex($index));
                    }
                    return $url;
                }
            }
            return false;
        }

        /**
         *    Attaches the intended frame index to a list of URLs.
         *    @param array $urls        List of SimpleUrls.
         *    @param string $frame      Name of frame or index.
         *    @return array             List of tagged URLs.
         *    @access private
         */
        function _tagUrlsWithFrame($urls, $frame) {
            $tagged = array();
            foreach ($urls as $url) {
                if (! $url->getTarget()) {
                    $url->setTarget($this->_getPublicNameFromIndex($frame));
                }
                $tagged[] = $url;
            }
            return $tagged;
        }

        /**
         *    Finds a held form by button label. Will only
         *    search correctly built forms.
         *    @param SimpleSelector $selector       Button finder.
         *    @return SimpleForm                    Form object containing
         *                                          the button.
         *    @access public
         */
        function &getFormBySubmit($selector) {
            $form = $this->_findForm('getFormBySubmit', $selector);
            return $form;
        }

        /**
         *    Finds a held form by image using a selector.
         *    Will only search correctly built forms. The first
         *    form found either within the focused frame, or
         *    across frames, will be the one returned.
         *    @param SimpleSelector $selector  Image finder.
         *    @return SimpleForm               Form object containing
         *                                     the image.
         *    @access public
         */
        function &getFormByImage($selector) {
            $form = $this->_findForm('getFormByImage', $selector);
            return $form;
        }

        /**
         *    Finds a held form by the form ID. A way of
         *    identifying a specific form when we have control
         *    of the HTML code. The first form found
         *    either within the focused frame, or across frames,
         *    will be the one returned.
         *    @param string $id     Form label.
         *    @return SimpleForm    Form object containing the matching ID.
         *    @access public
         */
        function &getFormById($id) {
            $form = $this->_findForm('getFormById', $id);
            return $form;
        }

        /**
         *    General form finder. Will search all the frames or
         *    just the one in focus.
         *    @param string $method    Method to use to find in a page.
         *    @param string $attribute Label, name or ID.
         *    @return SimpleForm    Form object containing the matching ID.
         *    @access private
         */
        function &_findForm($method, $attribute) {
            if (is_integer($this->_focus)) {
                $form = $this->_findFormInFrame(
                        $this->_frames[$this->_focus],
                        $this->_focus,
                        $method,
                        $attribute);
                return $form;
            }
            for ($i = 0; $i < count($this->_frames); $i++) {
                $form = $this->_findFormInFrame(
                        $this->_frames[$i],
                        $i,
                        $method,
                        $attribute);
                if ($form) {
                    return $form;
                }
            }
            $null = null;
            return $null;
        }

        /**
         *    Finds a form in a page using a form finding method. Will
         *    also tag the form with the frame name it belongs in.
         *    @param SimplePage $page  Page content of frame.
         *    @param integer $index    Internal frame representation.
         *    @param string $method    Method to use to find in a page.
         *    @param string $attribute Label, name or ID.
         *    @return SimpleForm       Form object containing the matching ID.
         *    @access private
         */
        function &_findFormInFrame($page, $index, $method, $attribute) {
            $form = $this->_frames[$index]->$method($attribute);
            if (isset($form)) {
                $form->setDefaultTarget($this->_getPublicNameFromIndex($index));
            }
            return $form;
        }

        /**
         *    Sets a field on each form in which the field is
         *    available.
         *    @param SimpleSelector $selector    Field finder.
         *    @param string $value               Value to set field to.
         *    @return boolean                    True if value is valid.
         *    @access public
         */
        function setField($selector, $value) {
            if (is_integer($this->_focus)) {
                $this->_frames[$this->_focus]->setField($selector, $value);
            } else {
                for ($i = 0; $i < count($this->_frames); $i++) {
                    $this->_frames[$i]->setField($selector, $value);
                }
            }
        }

        /**
         *    Accessor for a form element value within a page.
         *    @param SimpleSelector $selector    Field finder.
         *    @return string/boolean             A string if the field is
         *                                       present, false if unchecked
         *                                       and null if missing.
         *    @access public
         */
        function getField($selector) {
            for ($i = 0; $i < count($this->_frames); $i++) {
                $value = $this->_frames[$i]->getField($selector);
                if (isset($value)) {
                    return $value;
                }
            }
            return null;
        }
    }
?>