-
Notifications
You must be signed in to change notification settings - Fork 4
/
nodejs.main.php
1865 lines (1645 loc) · 45.6 KB
/
nodejs.main.php
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
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* @file
* Nodejs class.
*/
/**
* Generate a token for a piece of content.
*/
function nodejs_generate_content_token()
{
return nodejs_hmac_base64(nodejs_random_bytes(512), nodejs_get_private_key());
}
/**
* Send a content change message to a content channel.
*/
function nodejs_send_content_channel_message($message)
{
Nodejs::sendContentTokenMessage($message);
}
/**
* Send a content channel token to Node.js.
*
* @param mixed $channel
* @param mixed $notify_on_disconnect
* @return mixed
*/
function nodejs_send_content_channel_token($channel, $notify_on_disconnect = false)
{
$message = (object) array(
'token' => nodejs_generate_content_token(),
'channel' => $channel,
'notifyOnDisconnect' => $notify_on_disconnect,
);
// Http request went ok, process Node.js server response.
if($node_response = Nodejs::sendContentToken($message))
{
if($node_response->status == 'ok')
{
// We always set this in e107Nodejs.settings, even though Ajax requests
// will not see it. It's a bit ugly, but it means that setting the
// tokens for full page requests will just work.
// TODO: Add this to the e107Nodejs.settings.
// array(array('nodejs' => array('contentTokens' => array($channel => $message->token))), array('type' => 'setting'));
$node_response->token = $message->token;
return $node_response;
}
else
{
$msg = 'Error sending content channel token for channel "' . $channel . '". Node.js server response: ' . $node_response->error;
$log = e107::getLog();
$log->add('NODEJS', (array) $node_response, E_LOG_INFORMATIVE, $msg);
return false;
}
}
// Http request failed.
else
{
return false;
}
}
/**
* Get a list of users in a content channel.
*
* @param mixed $channel
* @return mixed
*/
function nodejs_get_content_channel_users($channel)
{
$message = (object) array('channel' => $channel);
// Http request went ok, process Node.js server response.
if($node_response = Nodejs::getContentTokenUsers($message))
{
if(isset($node_response->error))
{
$msg = 'Error getting content channel users for channel "' . $channel . '" on the Node.js server. Server response: ' . $node_response->error;
$log = e107::getLog();
$log->add('NODEJS', (array) $node_response, E_LOG_INFORMATIVE, $msg);
return false;
}
else
{
return array(
'uids' => !empty($node_response->users->uids) ? $node_response->users->uids : array(),
'authTokens' => !empty($node_response->users->authTokens) ? $node_response->users->authTokens : array(),
);
}
}
// Http request failed.
else
{
return false;
}
}
/**
* Kick a user from the node.js server.
*
* @param mixed $uid
* @return boolean
* TRUE if the user was kicked, FALSE otherwise.
*/
function nodejs_kick_user($uid)
{
// Http request went ok. Process Node.js server response.
if($node_response = Nodejs::kickUser($uid))
{
if($node_response->status == 'success')
{
return true;
}
else
{
$msg = 'Error kicking uid "' . $uid . '" from the Node.js server. Server response: ' . $node_response->error;
$log = e107::getLog();
$log->add('NODEJS', (array) $node_response, E_LOG_INFORMATIVE, $msg);
return false;
}
}
// Http request failed, hence channel couldn't be added.
else
{
return false;
}
}
/**
* Logout any sockets associated with the given token from the node.js server.
*
* @param mixed $token
* @return boolean
* TRUE if the user was logged out, FALSE otherwise.
*/
function nodejs_logout_user($token)
{
// Http request went ok. Process Node.js server response.
if($node_response = Nodejs::logoutUser($token))
{
if($node_response->status == 'success')
{
return true;
}
else
{
$msg = 'Error logging out token "' . $token . '" from the Node.js server. Server response: ' . $node_response->error;
$log = e107::getLog();
$log->add('NODEJS', (array) $node_response, E_LOG_INFORMATIVE, $msg);
return false;
}
}
// Http request failed, hence channel couldn't be added.
else
{
return false;
}
}
/**
* Set the list of uids a user can see presence notifications for.
*
* @param int $uid
* @param array $uids
* @return boolean
*/
function nodejs_set_user_presence_list($uid, array $uids)
{
// Http request went ok. Process Node.js server response.
if($node_response = Nodejs::setUserPresenceList($uid, $uids))
{
if($node_response->status == 'success')
{
return true;
}
else
{
$msg = 'Error setting user presence list for "' . $uid . '" on the Node.js server. Server response: ' . $node_response->error;
$log = e107::getLog();
$log->add('NODEJS', (array) $node_response, E_LOG_INFORMATIVE, $msg);
return false;
}
}
// Http request failed, hence channel couldn't be added.
else
{
return false;
}
}
/**
* Broadcast a message to all clients.
*
* @param string $subject
* @param string $body
*/
function nodejs_broadcast_message($subject, $body)
{
$message = (object) array(
'broadcast' => true,
'data' => (object) array(
'subject' => $subject,
'body' => $body,
),
'channel' => 'nodejs_notify',
);
nodejs_enqueue_message($message);
}
/**
* Send a message to all users subscribed to a given channel.
*/
function nodejs_send_channel_message($channel, $subject, $body)
{
$message = (object) array(
'data' => (object) array(
'subject' => $subject,
'body' => $body,
),
'channel' => $channel,
);
nodejs_enqueue_message($message);
}
/**
* Send a message to given user.
*
* @param int $uid
* @param string $subject
* @param string $body
*/
function nodejs_send_user_message($uid, $subject, $body)
{
$message = (object) array(
'data' => (object) array(
'subject' => $subject,
'body' => $body,
),
'channel' => 'nodejs_user_' . $uid,
'callback' => 'nodejsNotify',
);
nodejs_enqueue_message($message);
}
/**
* Send a message to multiple users.
*
* @param string|array $uids
* A list of uid seperated by comma (,) or an array of uids
* @param string $subject
* @param string $body
*/
function nodejs_send_user_message_multiple($uids, $subject, $body)
{
if(!is_array($uids))
{
$uids = explode(',', $uids);
}
foreach($uids as $uid)
{
nodejs_send_user_message($uid, $subject, $body);
}
}
/**
* Send a message to users in a role.
*
* @param string $role_name
* @param string $subject
* @param string $body
*/
function nodejs_send_role_message($role_name, $subject, $body)
{
// TODO: Select User IDs associated with a role.
$uids = array();
nodejs_send_user_message_multiple($uids, $subject, $body);
}
/**
* Add a channel to the Node.js server.
*
* @param channel
* @return boolean
*/
function nodejs_add_channel($channel)
{
// Http request went ok. Process Node.js server response.
if($node_response = Nodejs::addChannel($channel))
{
if($node_response->status == 'success')
{
return true;
}
else
{
$msg = 'Error adding channel to the Node.js server. Server response: ' . $node_response->error;
$log = e107::getLog();
$log->add('NODEJS', (array) $node_response, E_LOG_INFORMATIVE, $msg);
return false;
}
}
// Http request failed, hence channel couldn't be added.
else
{
return false;
}
}
/**
* Checks whether a channel exists on the Node.js server.
*
* @param channel
* @return boolean
* TRUE if the specified channel exists on the Node.js server, FALSE otherwise.
*/
function nodejs_check_channel($channel)
{
// Http request went ok. Process Node.js server response.
if($node_response = Nodejs::checkChannel($channel))
{
if($node_response->status == 'success')
{
return $node_response->result;
}
else
{
$msg = 'Error checking channel on the Node.js server. Server response: ' . $node_response->error;
$log = e107::getLog();
$log->add('NODEJS', (array) $node_response, E_LOG_INFORMATIVE, $msg);
return false;
}
}
// Http request failed.
else
{
return false;
}
}
/**
* Remove a channel from the Node.js server.
*
* @param channel
* @return boolean
*/
function nodejs_remove_channel($channel)
{
// Http request went ok. Process Node.js server response.
if($node_response = Nodejs::removeChannel($channel))
{
if($node_response->status == 'success')
{
return true;
}
else
{
$msg = 'Error removing channel from the Node.js server. Server response: ' . $node_response->error;
$log = e107::getLog();
$log->add('NODEJS', (array) $node_response, E_LOG_INFORMATIVE, $msg);
return false;
}
}
// Http request failed.
else
{
return false;
}
}
/**
* Enqueue a message for sending at the end of the request.
*
* @param StdClass $message
* Object contains message details.
*/
function nodejs_enqueue_message(StdClass $message)
{
$message->broadcast = isset($message->broadcast) ? $message->broadcast : false;
Nodejs::enqueueMessage($message);
}
/**
* Send a message immediately.
*
* @param StdClass $message
* Object contains message details.
*
* @return bool|mixed
*/
function nodejs_send_message(StdClass $message)
{
$message->broadcast = isset($message->broadcast) ? $message->broadcast : false;
return Nodejs::sendMessage($message);
}
/**
* Check if the given service key is valid.
*/
function nodejs_is_valid_service_key($service_key)
{
$config = nodejs_get_config();
return $service_key == $config['serviceKey'];
}
/**
* Checks the given key to see if it matches a valid session.
*/
function nodejs_auth_check($message)
{
$uid = nodejs_auth_check_callback($message['authToken']);
$auth_user = new stdClass();
$auth_user->uid = (int) $uid > 0 ? (int) $uid : 0;
$auth_user->authToken = $message['authToken'];
$auth_user->nodejsValidAuthToken = $uid !== false;
$auth_user->clientId = $message['clientId'];
if($auth_user->nodejsValidAuthToken)
{
// Get the list of channels I have access to.
$auth_user->channels = array();
if((int) $auth_user->uid > 0)
{
$auth_user->channels[] = 'nodejs_user_' . $auth_user->uid;
// Add custom js handlers.
$custom_channels = nodejs_get_custom_channels($auth_user);
if(is_array($custom_channels))
{
foreach($custom_channels as $plugin => $channels)
{
foreach($channels as $channel)
{
$auth_user->channels[] = $channel;
}
}
}
}
// Get the list of users who can see presence notifications about me.
$auth_user->presenceUids = array_unique(nodejs_get_user_presence_list($auth_user));
$nodejs_config = nodejs_get_config();
$auth_user->serviceKey = $nodejs_config['serviceKey'];
header('NodejsServiceKey: ' . $nodejs_config['serviceKey']);
if($auth_user->uid)
{
nodejs_user_set_online($auth_user->uid);
}
$auth_user->contentTokens = isset($message['contentTokens']) ? $message['contentTokens'] : array();
}
return $auth_user;
}
/**
* Default Node.js auth check callback implementation.
*/
function nodejs_auth_check_callback($auth_token)
{
$sql = e107::getDb();
$sql->gen("SELECT uid FROM #nodejs_sessions WHERE MD5(sid) = '" . $auth_token . "' ORDER BY uid DESC LIMIT 1 ");
$uid = false;
while($row = $sql->fetch())
{
$uid = (int) $row['uid'];
}
return $uid;
}
/**
* Get a list of user channels are defined in plugins.
*/
function nodejs_get_custom_channels($auth_user)
{
$sql = e107::getDb();
$channels = array();
$enabledPlugins = array();
// Get list of enabled plugins.
$sql->select("plugin", "*", "plugin_id !='' order by plugin_path ASC");
while($row = $sql->fetch())
{
if($row['plugin_installflag'] == 1)
{
$enabledPlugins[] = $row['plugin_path'];
}
}
$addonList = e107::getPlugConfig('nodejs')->get('nodejs_addon_list', array());
foreach($addonList as $plugin)
{
if(in_array($plugin, $enabledPlugins))
{
$file = e_PLUGIN . $plugin . '/e_nodejs.php';
if(is_readable($file))
{
e107_require_once($file);
$addonClass = $plugin . '_nodejs';
if(class_exists($addonClass))
{
$addon = new $addonClass();
if(method_exists($addon, 'userChannels'))
{
$return = $addon->userChannels($auth_user);
if(is_array($return))
{
$channels[$plugin] = $return;
}
}
}
}
}
}
return $channels;
}
/**
* Get a list of users who can see presence notifications about me.
*/
function nodejs_get_user_presence_list($account)
{
$sql = e107::getDb();
$users = array();
$enabledPlugins = array();
// Get list of enabled plugins.
$sql->select("plugin", "*", "plugin_id !='' order by plugin_path ASC");
while($row = $sql->fetch())
{
if($row['plugin_installflag'] == 1)
{
$enabledPlugins[] = $row['plugin_path'];
}
}
$addonList = e107::getPlugConfig('nodejs')->get('nodejs_addon_list', array());
foreach($addonList as $plugin)
{
if(in_array($plugin, $enabledPlugins))
{
$file = e_PLUGIN . $plugin . '/e_nodejs.php';
if(is_readable($file))
{
e107_require_once($file);
$addonClass = $plugin . '_nodejs';
if(class_exists($addonClass))
{
$addon = new $addonClass();
if(method_exists($addon, 'userPresenceList'))
{
$result = $addon->userPresenceList($account);
if(isset($result) && is_array($result))
{
$users = array_merge_recursive($users, $result);
}
elseif(isset($result))
{
$users[] = $result;
}
}
}
}
}
}
return $users;
}
/**
* Handler function to save active sessions to database.
*/
function nodejs_session_db_handler()
{
$db = e107::getDb('nodejssessions');
$db->delete('nodejs_sessions', 'timestamp <= (UNIX_TIMESTAMP() - 6*60*60)');
// Update last seen on every page load.
$updated = $db->update('nodejs_sessions', array(
'uid' => USERID,
'timestamp' => time(),
'WHERE' => 'sid="' . session_id() . '"',
));
if(!$updated)
{
$data = array(
'uid' => USERID,
'sid' => session_id(),
'timestamp' => time(),
);
$db->insert('nodejs_sessions', $data);
}
}
/**
* Set the user as online.
*
* @param $uid
*/
function nodejs_user_set_online($uid)
{
try
{
$insert = array(
'uid' => (int) $uid,
'login_time' => time(),
);
$sql = e107::getDb();
$sql->insert('nodejs_presence', $insert);
} catch(Exception $e)
{
}
finally
{
$event = e107::getEvent();
$event->trigger('nodejs-user-set-online', $uid);
}
}
/**
* Set the user as offline.
*
* @param $uid
*/
function nodejs_user_set_offline($uid)
{
try
{
$sql = e107::getDb();
$sql->delete("nodejs_presence", "uid=" . (int) $uid);
} catch(Exception $e)
{
}
finally
{
$event = e107::getEvent();
$event->trigger('nodejs-user-set-offline', $uid);
}
}
/**
* Remove a user from a channel.
*
* @param mixed $uid
* @param mixed $channel
* @return boolean
*/
function nodejs_remove_user_from_channel($uid, $channel)
{
// Http request went ok. Process Node.js server response.
if($node_response = Nodejs::removeUserFromChannel($uid, $channel))
{
if($node_response->status == 'success')
{
return true;
}
else
{
$params = array(
'uid' => $uid,
'channel' => $channel,
'error' => $node_response->error,
);
$msg = 'Error removing user with uid: ' . $params['uid'] . ' from channel ' . $params['channel'] . ' on the Node.js server. Server response: ' . $params['error'];
$log = e107::getLog();
$log->add('NODEJS', (array) $params, E_LOG_INFORMATIVE, $msg);
return false;
}
}
// Http request failed.
else
{
return false;
}
}
/**
* Add a user to a channel.
*
* @param mixed $uid
* @param mixed $channel
* @return boolean
*/
function nodejs_add_user_to_channel($uid, $channel)
{
// Http request went ok. Process Node.js server response.
if($node_response = Nodejs::addUserToChannel($uid, $channel))
{
if($node_response->status == 'success')
{
return true;
}
else
{
$params = array(
'uid' => $uid,
'channel' => $channel,
'error' => $node_response->error,
);
$msg = 'Error adding user with uid: ' . $params['uid'] . ' to channel ' . $params['channel'] . ' on the Node.js server. Server response: ' . $params['error'];
$log = e107::getLog();
$log->add('NODEJS', (array) $params, E_LOG_INFORMATIVE, $msg);
return false;
}
}
// Http request failed.
else
{
return false;
}
}
/**
* Get nodejs server config.
*
* @return array
*/
function nodejs_get_config()
{
$plugPrefs = e107::getPlugConfig('nodejs')->getPref();
$defaults = array(
'nodejs' => array(
'scheme' => (bool) $plugPrefs['nodejs_protocol'] ? 'http' : 'https',
'secure' => (bool) $plugPrefs['nodejs_protocol'] ? 0 : 1,
'host' => $plugPrefs['nodejs_host'],
'port' => $plugPrefs['nodejs_port'],
),
'client' => array(
'scheme' => (bool) $plugPrefs['nodejs_protocol'] ? 'http' : 'https',
'secure' => (bool) $plugPrefs['nodejs_protocol'] ? 0 : 1,
'host' => $plugPrefs['nodejs_host'],
'port' => $plugPrefs['nodejs_port'],
),
'resource' => !empty($plugPrefs['nodejs_resource']) ? $plugPrefs['nodejs_resource'] : '/socket.io',
'authToken' => nodejs_auth_get_token(),
'serviceKey' => $plugPrefs['nodejs_service_key'],
'websocketSwfLocation' => e_PLUGIN_ABS . 'nodejs' . '/socket_io/socket.io/support/socket.io-client/lib/vendor/web-socket-js/WebSocketMain.swf',
'log_http_errors' => (bool) $plugPrefs['nodejs_log_http_errors'],
);
return $defaults;
}
/**
* Get an auth token for the current user.
*/
function nodejs_auth_get_token()
{
$session_started = session_id() === '' ? false : true;
if($session_started)
{
session_start();
}
return md5(session_id());
}
/**
* Get the URL of a Node.js callback.
*
* @param string $callback
* The path to call on Node.js server (with leading /).
*
* @return string
*/
function nodejs_get_url($config, $callback = '')
{
return $config['nodejs']['scheme'] . '://' . $config['nodejs']['host'] . ':' . $config['nodejs']['port'] . '/' . $callback;
}
/**
* Ported and modified function from Drupal 7 core.
*
* Performs an HTTP request.
*
* This is a flexible and powerful HTTP client implementation. Correctly
* handles GET, POST, PUT or any other HTTP requests. Handles redirects.
*
* @param $url
* A string containing a fully qualified URI.
* @param array $options
* (optional) An array that can have one or more of the following elements:
* - headers: An array containing request headers to send as name/value pairs.
* - method: A string containing the request method. Defaults to 'GET'.
* - data: A string containing the request body, formatted as
* 'param=value¶m=value&...'. Defaults to NULL.
* - max_redirects: An integer representing how many times a redirect
* may be followed. Defaults to 3.
* - timeout: A float representing the maximum number of seconds the function
* call may take. The default is 30 seconds. If a timeout occurs, the error
* code is set to the HTTP_REQUEST_TIMEOUT constant.
* - context: A context resource created with stream_context_create().
*
* @return object
* An object that can have one or more of the following components:
* - request: A string containing the request body that was sent.
* - code: An integer containing the response status code, or the error code
* if an error occurred.
* - protocol: The response protocol (e.g. HTTP/1.1 or HTTP/1.0).
* - status_message: The status message from the response, if a response was
* received.
* - redirect_code: If redirected, an integer containing the initial response
* status code.
* - redirect_url: If redirected, a string containing the URL of the redirect
* target.
* - error: If an error occurred, the error message. Otherwise not set.
* - headers: An array containing the response headers as name/value pairs.
* HTTP header names are case-insensitive (RFC 2616, section 4.2), so for
* easy access the array keys are returned in lower case.
* - data: A string containing the response body that was received.
*/
function nodejs_http_request($url, array $options = array())
{
$result = new stdClass();
// Parse the URL and make sure we can handle the schema.
$uri = @parse_url($url);
if($uri == false)
{
$result->error = 'unable to parse URL';
$result->code = -1001;
return $result;
}
if(!isset($uri['scheme']))
{
$result->error = 'missing schema';
$result->code = -1002;
return $result;
}
nodejs_timer_start(__FUNCTION__);
// Merge the default options.
$options += array(
'headers' => array(),
'method' => 'GET',
'data' => null,
'max_redirects' => 3,
'timeout' => 30.0,
'context' => null,
);
// Merge the default headers.
$options['headers'] += array(
'User-Agent' => 'e107 (+http://e107.org/)',
);
// stream_socket_client() requires timeout to be a float.
$options['timeout'] = (float) $options['timeout'];
// Use a proxy if one is defined and the host is not on the excluded list.
$proxy_server = '';
if($proxy_server && nodejs_http_use_proxy($uri['host']))
{
// Set the scheme so we open a socket to the proxy server.
$uri['scheme'] = 'proxy';
// Set the path to be the full URL.
$uri['path'] = $url;
// Since the URL is passed as the path, we won't use the parsed query.
unset($uri['query']);
// Add in username and password to Proxy-Authorization header if needed.
if($proxy_username = '')
{
$proxy_password = '';
$options['headers']['Proxy-Authorization'] = 'Basic ' . base64_encode($proxy_username . (!empty($proxy_password) ? ":" . $proxy_password : ''));
}
// Some proxies reject requests with any User-Agent headers, while others
// require a specific one.
$proxy_user_agent = '';
// The default value matches neither condition.
if($proxy_user_agent === null)
{
unset($options['headers']['User-Agent']);
}
elseif($proxy_user_agent)
{
$options['headers']['User-Agent'] = $proxy_user_agent;
}
}
switch($uri['scheme'])
{
case 'proxy':
// Make the socket connection to a proxy server.
$socket = 'tcp://' . $proxy_server . ':' . 8080;
// The Host header still needs to match the real request.
$options['headers']['Host'] = $uri['host'];
$options['headers']['Host'] .= isset($uri['port']) && $uri['port'] != 80 ? ':' . $uri['port'] : '';
break;
case 'http':
case 'feed':
$port = isset($uri['port']) ? $uri['port'] : 80;
$socket = 'tcp://' . $uri['host'] . ':' . $port;
// RFC 2616: "non-standard ports MUST, default ports MAY be included".
// We don't add the standard port to prevent from breaking rewrite rules
// checking the host that do not take into account the port number.
$options['headers']['Host'] = $uri['host'] . ($port != 80 ? ':' . $port : '');
break;
case 'https':
// Note: Only works when PHP is compiled with OpenSSL support.
$port = isset($uri['port']) ? $uri['port'] : 443;
$socket = 'ssl://' . $uri['host'] . ':' . $port;
$options['headers']['Host'] = $uri['host'] . ($port != 443 ? ':' . $port : '');
break;
default:
$result->error = 'invalid schema ' . $uri['scheme'];
$result->code = -1003;
return $result;
}
if(empty($options['context']))
{
$fp = @stream_socket_client($socket, $errno, $errstr, $options['timeout']);
}
else
{
// Create a stream with context. Allows verification of a SSL certificate.
$fp = @stream_socket_client($socket, $errno, $errstr, $options['timeout'], STREAM_CLIENT_CONNECT, $options['context']);
}
// Make sure the socket opened properly.
if(!$fp)
{
// When a network error occurs, we use a negative number so it does not
// clash with the HTTP status codes.
$result->code = -$errno;
$result->error = trim($errstr) ? trim($errstr) : 'Error opening socket ' . $socket;
return $result;
}
// Construct the path to act on.
$path = isset($uri['path']) ? $uri['path'] : '/';
if(isset($uri['query']))
{
$path .= '?' . $uri['query'];
}
// Only add Content-Length if we actually have any content or if it is a POST
// or PUT request. Some non-standard servers get confused by Content-Length in
// at least HEAD/GET requests, and Squid always requires Content-Length in
// POST/PUT requests.
$content_length = strlen($options['data']);
if($content_length > 0 || $options['method'] == 'POST' || $options['method'] == 'PUT')
{
$options['headers']['Content-Length'] = $content_length;