summaryrefslogtreecommitdiffstats
path: root/examples/httprl.examples.php
blob: 71c8302513d0674672ae8acd82667cca0eb843f0 (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
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
<?php
/**
 * @file
 * HTTP Parallel Request Library code examples.
 */
?>

**Simple HTTP**
Request http://drupal.org/.

<?php
// Queue up the request.
httprl_request('http://drupal.org/');
// Execute request.
$request = httprl_send_request();

// Echo out the results.
echo httprl_pr($request);
?>


Request http://drupal.org/robots.txt and save it to tmp folder.

<?php
// Queue up the request.
httprl_request('http://drupal.org/robots.txt');
// Execute request.
$request = httprl_send_request();

// Save file if we got a 200 back.
if ($request['http://drupal.org/robots.txt']->code == 200) {
  file_put_contents('/tmp/robots.txt', $request['http://drupal.org/robots.txt']->data);
}
?>


Request this servers own front page & the node page.

<?php
$options = array(
  'headers' => array(
    // Set the Host header to self.
    'Host' => $_SERVER['HTTP_HOST'],
  ),
);
// Build URL to point to front page of this server.
$url_front = httprl_build_url_self();
// Build URL to point to /node on this server.
$url_node = httprl_build_url_self('node');
// Queue up the requests.
httprl_request($url_front, $options);
httprl_request($url_node, $options);
// Execute requests.
$request = httprl_send_request();

// Echo out the results.
echo httprl_pr($request);
?>


**Non Blocking HTTP Operations**

Request 10 URLs in a non blocking manner on this server. Checkout watchdog as
this should generate 10 404s and the $request object won't contain much info.

<?php
// Set the blocking mode.
$options = array(
  'blocking' => FALSE,
  'headers' => array(
    // Set the Host header to self.
    'Host' => $_SERVER['HTTP_HOST'],
  ),
);
// Queue up the requests.
$max = 10;
for ($i=1; $i <= $max; $i++) {
  // Build URL to a page that doesn't exist.
  $url = httprl_build_url_self('asdf-asdf-asdf-' . $i);
  httprl_request($url, $options);
}
// Execute requests.
$request = httprl_send_request();

// Echo out the results.
echo httprl_pr($request);
?>


Request 10 URLs in a non blocking manner with one httprl_request() call. These
URLs will all have the same options.

<?php
// Set the blocking mode.
$options = array(
  'method' => 'HEAD',
  'blocking' => FALSE,
  'headers' => array(
    // Set the Host header to self.
    'Host' => $_SERVER['HTTP_HOST'],
  ),
);
// Queue up the requests.
$max = 10;
$urls = array();
for ($i=1; $i <= $max; $i++) {
  // Build URL to a page that doesn't exist.
  $urls[] = httprl_build_url_self('asdf-asdf-asdf-' . $i);
}
// Queue up the requests.
httprl_request($urls, $options);
// Execute requests.
$request = httprl_send_request();

// Echo out the results.
echo httprl_pr($request);
?>


Request 1000 URLs in a non blocking manner with one httprl_request() call. These
URLs will all have the same options. This will saturate the server and any
connections that couldn't be made will be dropped.

<?php
// Set the blocking mode.
$options = array(
  'method' => 'HEAD',
  'blocking' => FALSE,
  'domain_connections' => 1000,
  'global_connections' => 1000,
  'headers' => array(
    // Set the Host header to self.
    'Host' => $_SERVER['HTTP_HOST'],
  ),
);
// Queue up the requests.
$max = 1000;
$urls = array();
for ($i=1; $i <= $max; $i++) {
  // Build URL to a page that doesn't exist.
  $urls[] = httprl_build_url_self('asdf-asdf-asdf-' . $i);
}
// Queue up the requests.
httprl_request($urls, $options);
// Execute requests.
$request = httprl_send_request();

// Echo out the results.
echo httprl_pr($request);
?>


Request 1000 URLs in a non blocking manner with one httprl_request() call. These
URLs will all have the same options. This will saturate the server. Usually all
1000 requests will eventually hit the server due to it waiting for the
connection to be established; `async_connect` is FALSE.

<?php
// Set the blocking mode.
$options = array(
  'method' => 'HEAD',
  'blocking' => FALSE,
  'async_connect' => FALSE,
  // domain_connections must be smaller than the servers max number of
  // clients.
  'domain_connections' => 32,
  'global_connections' => 1000,
  'headers' => array(
    // Set the Host header to self.
    'Host' => $_SERVER['HTTP_HOST'],
  ),
);
// Queue up the requests.
$max = 1000;
$urls = array();
for ($i=1; $i <= $max; $i++) {
  // Build URL to a page that doesn't exist.
  $urls[] = httprl_build_url_self('asdf-asdf-asdf-' . $i);
}
// Queue up the requests.
httprl_request($urls, $options);
// Execute requests.
$request = httprl_send_request();

// Echo out the results.
echo httprl_pr($request);
?>


**HTTP Operations and Callbacks**

Use a callback in the event loop to do processing on the request. In this case
we are going to use httprl_pr() as the callback function.

<?php
// Setup return variable.
$x = '';
// Setup options array.
$options = array(
  'method' => 'HEAD',
  'callback' => array(
    array(
      'function' => 'httprl_pr',
      'return' => &$x,
    ),
  ),
  'headers' => array(
    // Set the Host header to self.
    'Host' => $_SERVER['HTTP_HOST'],
  ),
);
// Build URL to point to front page of this server.
$url_front = httprl_build_url_self();
// Queue up the request.
httprl_request($url_front, $options);
// Execute request.
$request = httprl_send_request();

// Echo returned value from function callback.
echo $x;
?>


Use a background callback in the event loop to do processing on the request.
In this case we are going to use httprl_pr() as the callback function. A
background callback creates a new thread to run this function in.

<?php
// Setup return variable.
$x = '';
// Setup options array.
$options = array(
  'method' => 'HEAD',
  'background_callback' => array(
    array(
      'function' => 'httprl_pr',
      'return' => &$x,
    ),
  ),
  'headers' => array(
    // Set the Host header to self.
    'Host' => $_SERVER['HTTP_HOST'],
  ),
);
// Build URL to point to front page of this server.
$url_front = httprl_build_url_self();
// Queue up the request.
httprl_request($url_front, $options);
// Execute request.
$request = httprl_send_request();

// Echo returned value from function callback.
echo $x;
?>


Use a background callback in the event loop to do processing on the request.
In this case we are going to use print_r() as the callback function. A
background callback creates a new thread to run this function in. The first
argument passed in is the request object, the FALSE tells print_r to echo out
instead of returning a value.

<?php
// Setup return & print variable.
$x = '';
$y = '';
// Setup options array.
$options = array(
  'method' => 'HEAD',
  'background_callback' => array(
    array(
      'function' => 'print_r',
      'return' => &$x,
      'printed' => &$y,
    ),
    FALSE,
  ),
  'headers' => array(
    // Set the Host header to self.
    'Host' => $_SERVER['HTTP_HOST'],
  ),
);
// Build URL to point to front page of this server.
$url_front = httprl_build_url_self();
// Queue up the request.
httprl_request($url_front, $options);
// Execute request.
$request = httprl_send_request();

// Echo what was returned and printed from function callback.
echo $x . "<br />\n";
echo $y;
?>


**More Advanced HTTP Operations**

Hit 5 different URLs, Using at least 2 that has a status code of 200 and
erroring out the others that didn't return fast. Using the Range header so only
the first and last 128 bytes are returned.

<?php
// Array of URLs to get.
$urls = array(
  'http://google.com/',
  'http://bing.com/',
  'http://yahoo.com/',
  'http://www.duckduckgo.com/',
  'http://www.drupal.org/',
);

// Process list of URLs.
$options = array(
  'alter_all_streams_function' => 'need_two_good_results',
  'headers' => array('Range' => 'bytes=0-127,-128'),
);
// Queue up the requests.
httprl_request($urls, $options);

// Execute requests.
$requests = httprl_send_request();

// Print what was done.
echo httprl_pr($requests);

function need_two_good_results($id, &$responses) {
  static $counter = 0;
  foreach ($responses as $id => &$result) {
    // Skip if we got a 200 or 206.
    if ($result->code == 200 || $result->code == 206) {
      $counter += 1;
      continue;
    }
    if ($result->status == 'Done.') {
      continue;
    }

    if ($counter >= 2) {
      // Set the code to request was aborted.
      $result->code = HTTPRL_REQUEST_ABORTED;
      $result->error = 'Software caused connection abort.';
      // Set status to done and set timeout.
      $result->status = 'Done.';
      $result->options['timeout'] -= $result->running_time;

      // Close the file pointer and remove from the stream from the array.
      fclose($result->fp);
      unset($result->fp);
    }
  }
}
?>


Send 2 files in one field via a POST request.

<?php
// Set options.
$options = array(
  'method' => 'POST',
  'data' => array(
    'x' => 1,
    'y' => 2,
    'z' => 3,
    'files' => array(
      'core_js' => array(
        'misc/form.js',
        'misc/batch.js',
      ),
    ),
  ),
  'headers' => array(
    // Set the Host header to self.
    'Host' => $_SERVER['HTTP_HOST'],
  ),
);
// Send request to front page.
$url_front = httprl_build_url_self();

// Queue up the request.
httprl_request($url_front, $options);
// Execute request.
$request = httprl_send_request();
// Echo what was returned.
echo httprl_pr($request);
?>


Send out 8 requests. In this example we are going to stall the call to fread()
`'stall_fread' => TRUE,`. By doing this we can issue a bunch of requests, do
some other stuff and then get the results later on in the PHP process. A useful
example would be for ESI emulation. Issue a bunch of requests at the start of
the request, generate the main content and then add in the ESI-ed components at
the end of the request.

<?php
// Queue up the request.
$urls = array(
  'http://www.google.com/',
  'http://www.bing.com/',
  'http://www.yahoo.com/',
  'http://duckduckgo.com/',
  'http://drupal.org/',
  'http://drupal.org/robots.txt',
  'http://drupal.org/CHANGELOG.txt',
  'http://drupal.org/MAINTAINERS.txt',
);
$options = array(
  // Do fread in a second request.
  'stall_fread' => TRUE,
  'headers' => array(
    // Only grab the last 128 bytes of the request.
    'Range' => 'bytes=-128',
    // Accept Compression.
    'Accept-Encoding' => 'gzip, deflate',
  ),
  // Increase the read chunk size to 512KB.
  'chunk_size_read' => 524288,
  // Increase domain_connections to 4 (drupal.org).
  'domain_connections' => 4,
  // If we can't connect quick (0.5 seconds), bail out.
  'connect_timeout' => 0.5,
  'dns_timeout' => 0.5,
);
httprl_request($urls, $options);
// Execute request.
echo round(timer_read('page')/1000, 3) . " - Time taken to get requests ready.<br> \n";
$request = httprl_send_request();
echo strtoupper(var_export($request, TRUE)) . " - Output from first httprl_send_request() call<br> \n";

echo round(timer_read('page')/1000, 3) . " - Time taken to send out all fwrites().<br> \n";
sleep(2);
echo round(timer_read('page')/1000, 3) . " - Time taken for sleep(2).<br> \n";

$request = httprl_send_request();
echo round(timer_read('page')/1000, 3) . " - Time taken for all freads().<br> \n";
echo "Output from second httprl_send_request() below:<br> \n<br> \n";
echo httprl_pr($request);
?>


**Threading Examples**

Use 2 threads to load up 4 different nodes.

<?php
// Bail out here if background callbacks are disabled.
if (!httprl_is_background_callback_capable()) {
  return FALSE;
}

// List of nodes to load; 241-244.
$nodes = array(241 => '', 242 => '', 243 => '', 244 => '');
foreach ($nodes as $nid => &$node) {
  // Setup callback options array.
  $callback_options = array(
    array(
      'function' => 'node_load',
      'return' => &$node,
      // Setup options array.
      'options' => array(
        'domain_connections' => 2, // Only use 2 threads for this request.
      ),
    ),
    $nid,
  );
  // Queue up the request.
  httprl_queue_background_callback($callback_options);
}
// Execute request.
httprl_send_request();

// Echo what was returned.
echo httprl_pr($nodes);
?>



Load nodes 50-100 using httprl_batch_callback and node_load_multiple.

<?php
// List of nodes to load; 50-100.
$nids = range(50, 100);
// Run not parallel if background callbacks are disabled.
if (!httprl_is_background_callback_capable()) {
  $results = node_load_multiple($nids);
}
else {
  // Queue & Execute requests.
  $results = httprl_batch_callback('node_load_multiple', $nids);
}
// Echo what was returned.
echo httprl_pr($results);
?>



Load nodes 50-100 using httprl_batch_callback and node_load.

<?php
// List of nodes to load; 50-100.
$nids = range(50, 100);
// Run not parallel if background callbacks are disabled.
if (!httprl_is_background_callback_capable()) {
  // httprl_run_multiple does a foreach on $nids running every $value through
  // the given callback.
  $results = httprl_run_multiple('node_load', $nids);
}
else {
  // Set options.
  $options = array(
    'multiple_helper' => TRUE,
  );
  // Queue & Execute requests.
  $results = httprl_batch_callback('node_load', $nids, $options);
}
// Echo what was returned.
echo httprl_pr($results);
?>


Load nodes 50-100 using httprl_batch_callback and node_load_multiple as user 1.

<?php
// List of nodes to load; 50-100.
$nids = range(50, 100);
// Run not parallel if background callbacks are disabled.
if (!httprl_is_background_callback_capable()) {
  // Run node_load_multiple as user 1
  $current_account = $GLOBALS['user']->uid;
  $GLOBALS['user'] = user_load(1);
  $results = node_load_multiple($nids);
  // Set global user back.
  $GLOBALS['user'] = $current_account;
}
else {
  // Set options.
  $options = array(
    'context' => array(
      'uid' => 1,
    ),
  );
  // Queue & Execute requests.
  $results = httprl_batch_callback('node_load_multiple', $nids, $options);
}
// Echo what was returned.
echo httprl_pr($results);
?>



Run a function in the background. Notice that there is no return or printed key
in the callback options.

<?php
// Bail out here if background callbacks are disabled.
if (!httprl_is_background_callback_capable()) {
  return FALSE;
}

// Setup callback options array; call watchdog in the background.
$callback_options = array(
  array(
    'function' => 'watchdog',
  ),
  'httprl-test', 'background watchdog call done', array(), WATCHDOG_DEBUG,
);
// Queue up the request.
httprl_queue_background_callback($callback_options);

// Execute request.
httprl_send_request();
?>


Pass by reference example. Example is D7 only; pass by reference works in
D6 & D7.

<?php
// Code from system_rebuild_module_data().
$modules = _system_rebuild_module_data();
ksort($modules);

// Show first module before running system_get_files_database().
echo httprl_pr(current($modules));

// Bail out here if background callbacks are disabled.
if (!httprl_is_background_callback_capable()) {
  return FALSE;
}

$callback_options = array(
  array(
    'function' => 'system_get_files_database',
    'return' => '',
  ),
  &$modules, 'module'
);
httprl_queue_background_callback($callback_options);

// Execute requests.
httprl_send_request();

// Show first module after running system_get_files_database().
echo httprl_pr(current($modules));
?>


Get 2 results from 2 different queries at the hook_boot bootstrap level in D6.

<?php
// Run 2 queries and get the result.
$x = db_result(db_query_range("SELECT filename FROM {system} ORDER BY filename ASC", 0, 1));
$y = db_result(db_query_range("SELECT filename FROM {system} ORDER BY filename DESC", 0, 1));
echo $x . "<br \>\n" . $y . "<br \>\n";
unset($x, $y);


// Bail out here if background callbacks are disabled.
if (!httprl_is_background_callback_capable()) {
  return FALSE;
}

// Run above 2 queries and get the result via a background callback.
$args = array(
  // First query.
  array(
    'type' => 'function',
    'call' => 'db_query_range',
    'args' => array('SELECT filename FROM {system} ORDER BY filename ASC', 0, 1),
  ),
  array(
    'type' => 'function',
    'call' => 'db_result',
    'args' => array('last' => NULL),
    'return' => &$x,
  ),

  // Second Query.
  array(
    'type' => 'function',
    'call' => 'db_query_range',
    'args' => array('SELECT filename FROM {system} ORDER BY filename DESC', 0, 1),
  ),
  array(
    'type' => 'function',
    'call' => 'db_result',
    'args' => array('last' => NULL),
    'return' => &$y,
  ),
);
$callback_options = array(array('return' => ''), &$args);
// Queue up the request.
httprl_queue_background_callback($callback_options);
// Execute request.
httprl_send_request();

// Echo what was returned.
echo httprl_pr($x, $y);
?>


Get 2 results from 2 different queries at the hook_boot bootstrap level in D7.

<?php
$x = db_select('system', 's')
  ->fields('s', array('filename'))
  ->orderBy('filename', 'ASC')
  ->range(0, 1)
  ->execute()
  ->fetchField();
$y = db_select('system', 's')
  ->fields('s', array('filename'))
  ->orderBy('filename', 'DESC')
  ->range(0, 1)
  ->execute()
  ->fetchField();
echo $x . "<br \>\n" . $y . "<br \>\n";
unset($x, $y);


// Bail out here if background callbacks are disabled.
if (!httprl_is_background_callback_capable()) {
  return FALSE;
}

// Run above 2 queries and get the result via a background callback.
$args = array(
  // First query.
  array(
    'type' => 'function',
    'call' => 'db_select',
    'args' => array('system', 's',),
  ),
  array(
    'type' => 'method',
    'call' => 'fields',
    'args' => array('s', array('filename')),
  ),
  array(
    'type' => 'method',
    'call' => 'orderBy',
    'args' => array('filename', 'ASC'),
  ),
  array(
    'type' => 'method',
    'call' => 'range',
    'args' => array(0, 1),
  ),
  array(
    'type' => 'method',
    'call' => 'execute',
    'args' => array(),
  ),
  array(
    'type' => 'method',
    'call' => 'fetchField',
    'args' => array(),
    'return' => &$x,
  ),

  // Second Query.
  array(
    'type' => 'function',
    'call' => 'db_select',
    'args' => array('system', 's',),
  ),
  array(
    'type' => 'method',
    'call' => 'fields',
    'args' => array('s', array('filename')),
  ),
  array(
    'type' => 'method',
    'call' => 'orderBy',
    'args' => array('filename', 'DESC'),
  ),
  array(
    'type' => 'method',
    'call' => 'range',
    'args' => array(0, 1),
  ),
  array(
    'type' => 'method',
    'call' => 'execute',
    'args' => array(),
  ),
  array(
    'type' => 'method',
    'call' => 'fetchField',
    'args' => array(),
    'return' => &$y,
  ),
);
$callback_options = array(array('return' => ''), &$args);
// Queue up the request.
httprl_queue_background_callback($callback_options);
// Execute request.
httprl_send_request();

// Echo what was returned.
echo httprl_pr($x, $y);
?>


Run a cache clear at the DRUPAL_BOOTSTRAP_FULL level as the current user in a
non blocking background request.

<?php
// Normal way to do this.
drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
module_load_include('inc', 'system', 'system.admin');
system_clear_cache_submit();


// Bail out here if background callbacks are disabled.
if (!httprl_is_background_callback_capable()) {
  return FALSE;
}

// How to do it in a non blocking background request.
$args = array(
  array(
    'type' => 'function',
    'call' => 'drupal_bootstrap',
    'args' => array(DRUPAL_BOOTSTRAP_FULL),
  ),
  array(
    'type' => 'function',
    'call' => 'module_load_include',
    'args' => array('inc', 'system', 'system.admin'),
  ),
  array(
    'type' => 'function',
    'call' => 'system_clear_cache_submit',
    'args' => array('', ''),
  ),
  array(
    'type' => 'function',
    'call' => 'watchdog',
    'args' => array('httprl-test', 'background cache clear done', array(), WATCHDOG_DEBUG),
  ),
);

// Pass the current session to the sub request.
if (!empty($_COOKIE[session_name()])) {
  $options = array('headers' => array('Cookie' => session_name() . '=' . $_COOKIE[session_name()] . ';'));
}
else {
  $options = array();
}
$callback_options = array(array('options' => $options), &$args);

// Queue up the request.
httprl_queue_background_callback($callback_options);
// Execute request.
httprl_send_request();
?>


print 'My Text'; cut the connection by sending the data over the wire and do
processing in the background.

<?php
httprl_background_processing('My Text');
// Everything after this point does not affect page load time.
sleep(5);
echo 'You should not see this text';
?>