forked from mongodb/mongo-php-driver-legacy
-
Notifications
You must be signed in to change notification settings - Fork 4
/
bson.c
1599 lines (1319 loc) · 42.2 KB
/
bson.c
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
/**
* Copyright 2009-2014 MongoDB, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include <php.h>
#include <zend_exceptions.h>
#ifdef WIN32
# include <memory.h>
# ifndef int64_t
typedef __int64 int64_t;
# endif
#endif
#include "php_mongo.h"
#include "bson.h"
#include "types/bin_data.h"
#include "types/date.h"
#include "types/id.h"
#include "cursor_shared.h"
#define CHECK_BUFFER_LEN(len) \
do { \
if (buf + (len) >= buf_end) { \
zval_ptr_dtor(&value); \
zend_throw_exception_ex(mongo_ce_CursorException, 21 TSRMLS_CC, "Reading data for type %02x would exceed buffer for key \"%s\"", (unsigned char) type, name); \
return NULL; \
} \
} while (0)
extern zend_class_entry *mongo_ce_BinData,
*mongo_ce_Code,
*mongo_ce_Date,
*mongo_ce_Id,
*mongo_ce_Regex,
*mongo_ce_Timestamp,
*mongo_ce_MinKey,
*mongo_ce_MaxKey,
*mongo_ce_Exception,
*mongo_ce_CursorException,
*mongo_ce_Int32,
*mongo_ce_Int64;
ZEND_EXTERN_MODULE_GLOBALS(mongo)
static int prep_obj_for_db(mongo_buffer *buf, HashTable *array TSRMLS_DC);
static int apply_func_args_wrapper(void **data TSRMLS_DC, int num_args, va_list args, zend_hash_key *key);
static int is_utf8(const char *s, int len);
static int insert_helper(mongo_buffer *buf, zval *doc, int max TSRMLS_DC);
/* The position is not increased, we are just filling in the first 4 bytes with
* the size. */
int php_mongo_serialize_size(char *start, const mongo_buffer *buf, int max_size TSRMLS_DC)
{
int total = MONGO_32((buf->pos - start));
if (buf->pos - start > max_size) {
zend_throw_exception_ex(mongo_ce_Exception, 3 TSRMLS_CC, "document fragment is too large: %d, max: %d", buf->pos - start, max_size);
return FAILURE;
}
memcpy(start, &total, INT_32);
return SUCCESS;
}
static int prep_obj_for_db(mongo_buffer *buf, HashTable *array TSRMLS_DC)
{
zval **data, *newid;
/* if _id field doesn't exist, add it */
if (zend_hash_find(array, "_id", 4, (void**)&data) == FAILURE) {
/* create new MongoId */
MAKE_STD_ZVAL(newid);
object_init_ex(newid, mongo_ce_Id);
php_mongo_mongoid_populate(newid, NULL TSRMLS_CC);
/* add to obj */
zend_hash_add(array, "_id", 4, &newid, sizeof(zval*), NULL);
/* set to data */
data = &newid;
}
php_mongo_serialize_element("_id", 3, data, buf, 0 TSRMLS_CC);
if (EG(exception)) {
return FAILURE;
}
return SUCCESS;
}
/* serialize a zval */
int zval_to_bson(mongo_buffer *buf, HashTable *hash, int prep, int max_document_size TSRMLS_DC)
{
uint start;
int num = 0;
/* check buf size */
if (BUF_REMAINING <= 5) {
resize_buf(buf, 5);
}
/* keep a record of the starting position as an offset, in case the memory
* is resized */
start = buf->pos-buf->start;
/* skip first 4 bytes to leave room for size */
buf->pos += INT_32;
/* It doesn't matter if the document is empty if we need to prep it */
if (zend_hash_num_elements(hash) > 0 || prep) {
if (prep) {
prep_obj_for_db(buf, hash TSRMLS_CC);
num++;
}
zend_hash_apply_with_arguments(hash TSRMLS_CC, (apply_func_args_t)apply_func_args_wrapper, 3, buf, prep, &num);
}
php_mongo_serialize_null(buf);
php_mongo_serialize_size(buf->start + start, buf, max_document_size TSRMLS_CC);
return EG(exception) ? FAILURE : num;
}
static int apply_func_args_wrapper(void **data TSRMLS_DC, int num_args, va_list args, zend_hash_key *key)
{
mongo_buffer *buf = va_arg(args, mongo_buffer*);
int prep = va_arg(args, int);
int *num = va_arg(args, int*);
if (key->nKeyLength) {
return php_mongo_serialize_element(key->arKey, key->nKeyLength - 1, (zval**)data, buf, prep TSRMLS_CC);
} else {
long current = key->h;
int pos = 29, negative = 0;
char name[30];
/* If the key is a number in ascending order, we're still dealing with
* an array, not an object, so increase the count */
if (key->h == (unsigned int)*num) {
(*num)++;
}
name[pos--] = '\0';
/* take care of negative indexes */
if (current < 0) {
current *= -1;
negative = 1;
}
do {
int digit = current % 10;
digit += (int)'0';
name[pos--] = (char)digit;
current = current / 10;
} while (current > 0);
if (negative) {
name[pos--] = '-';
}
return php_mongo_serialize_element(name + pos + 1, strlen(name + pos + 1), (zval**)data, buf, prep TSRMLS_CC);
}
}
int php_mongo_serialize_element(const char *name, int name_len, zval **data, mongo_buffer *buf, int prep TSRMLS_DC)
{
if (prep && strcmp(name, "_id") == 0) {
return ZEND_HASH_APPLY_KEEP;
}
switch (Z_TYPE_PP(data)) {
case IS_NULL:
PHP_MONGO_SERIALIZE_KEY(BSON_NULL);
break;
case IS_LONG:
if (MonGlo(native_long)) {
#if SIZEOF_LONG == 4
PHP_MONGO_SERIALIZE_KEY(BSON_INT);
php_mongo_serialize_int(buf, Z_LVAL_PP(data));
#else
# if SIZEOF_LONG == 8
PHP_MONGO_SERIALIZE_KEY(BSON_LONG);
php_mongo_serialize_long(buf, Z_LVAL_PP(data));
# else
# error The PHP number size is neither 4 or 8 bytes; no clue what to do with that!
# endif
#endif
} else {
PHP_MONGO_SERIALIZE_KEY(BSON_INT);
php_mongo_serialize_int(buf, Z_LVAL_PP(data));
}
break;
case IS_DOUBLE:
PHP_MONGO_SERIALIZE_KEY(BSON_DOUBLE);
php_mongo_serialize_double(buf, Z_DVAL_PP(data));
break;
case IS_BOOL:
PHP_MONGO_SERIALIZE_KEY(BSON_BOOL);
php_mongo_serialize_bool(buf, Z_BVAL_PP(data));
break;
case IS_STRING: {
PHP_MONGO_SERIALIZE_KEY(BSON_STRING);
/* if this is not a valid string, stop */
if (!is_utf8(Z_STRVAL_PP(data), Z_STRLEN_PP(data))) {
zend_throw_exception_ex(mongo_ce_Exception, 12 TSRMLS_CC, "non-utf8 string: %s", Z_STRVAL_PP(data));
return ZEND_HASH_APPLY_STOP;
}
php_mongo_serialize_int(buf, Z_STRLEN_PP(data) + 1);
php_mongo_serialize_string(buf, Z_STRVAL_PP(data), Z_STRLEN_PP(data));
break;
}
case IS_ARRAY: {
int num;
/* if we realloc, we need an offset, not an abs pos (phew) */
int type_offset = buf->pos-buf->start;
/* serialize */
PHP_MONGO_SERIALIZE_KEY(BSON_ARRAY);
num = zval_to_bson(buf, Z_ARRVAL_PP(data), NO_PREP, MONGO_DEFAULT_MAX_DOCUMENT_SIZE TSRMLS_CC);
if (EG(exception)) {
return ZEND_HASH_APPLY_STOP;
}
/* now go back and set the type bit */
if (num == zend_hash_num_elements(Z_ARRVAL_PP(data))) {
buf->start[type_offset] = BSON_ARRAY;
} else {
buf->start[type_offset] = BSON_OBJECT;
}
break;
}
case IS_OBJECT: {
zend_class_entry *clazz = Z_OBJCE_PP(data);
/* check for defined classes */
/* MongoId */
if (clazz == mongo_ce_Id) {
mongo_id *id;
PHP_MONGO_SERIALIZE_KEY(BSON_OID);
id = (mongo_id*)zend_object_store_get_object(*data TSRMLS_CC);
if (!id->id) {
return ZEND_HASH_APPLY_KEEP;
}
php_mongo_serialize_bytes(buf, id->id, OID_SIZE);
}
/* MongoDate */
else if (clazz == mongo_ce_Date) {
PHP_MONGO_SERIALIZE_KEY(BSON_DATE);
php_mongo_serialize_date(buf, *data TSRMLS_CC);
}
/* MongoRegex */
else if (clazz == mongo_ce_Regex) {
PHP_MONGO_SERIALIZE_KEY(BSON_REGEX);
php_mongo_serialize_regex(buf, *data TSRMLS_CC);
}
/* MongoCode */
else if (clazz == mongo_ce_Code) {
PHP_MONGO_SERIALIZE_KEY(BSON_CODE);
php_mongo_serialize_code(buf, *data TSRMLS_CC);
if (EG(exception)) {
return ZEND_HASH_APPLY_STOP;
}
}
/* MongoBin */
else if (clazz == mongo_ce_BinData) {
PHP_MONGO_SERIALIZE_KEY(BSON_BINARY);
php_mongo_serialize_bin_data(buf, *data TSRMLS_CC);
}
/* MongoTimestamp */
else if (clazz == mongo_ce_Timestamp) {
PHP_MONGO_SERIALIZE_KEY(BSON_TIMESTAMP);
php_mongo_serialize_ts(buf, *data TSRMLS_CC);
}
/* MongoMinKey */
else if (clazz == mongo_ce_MinKey) {
PHP_MONGO_SERIALIZE_KEY(BSON_MINKEY);
}
/* MongoMaxKey */
else if (clazz == mongo_ce_MaxKey) {
PHP_MONGO_SERIALIZE_KEY(BSON_MAXKEY);
}
/* Integer types */
else if (clazz == mongo_ce_Int32) {
PHP_MONGO_SERIALIZE_KEY(BSON_INT);
php_mongo_serialize_int32(buf, *data TSRMLS_CC);
}
else if (clazz == mongo_ce_Int64) {
PHP_MONGO_SERIALIZE_KEY(BSON_LONG);
php_mongo_serialize_int64(buf, *data TSRMLS_CC);
}
/* serialize a normal object */
else {
HashTable *hash = Z_OBJPROP_PP(data);
/* go through the k/v pairs and serialize them */
PHP_MONGO_SERIALIZE_KEY(BSON_OBJECT);
zval_to_bson(buf, hash, NO_PREP, MONGO_DEFAULT_MAX_MESSAGE_SIZE TSRMLS_CC);
if (EG(exception)) {
return ZEND_HASH_APPLY_STOP;
}
}
break;
}
}
return ZEND_HASH_APPLY_KEEP;
}
int resize_buf(mongo_buffer *buf, int size)
{
int total = buf->end - buf->start;
int used = buf->pos - buf->start;
total = total < GROW_SLOWLY ? total*2 : total + INITIAL_BUF_SIZE;
while (total-used < size) {
total += size;
}
buf->start = (char*)erealloc(buf->start, total);
buf->pos = buf->start + used;
buf->end = buf->start + total;
return total;
}
/*
* create a bson date
*
* type: 9
* 8 bytes of ms since the epoch
*/
void php_mongo_serialize_date(mongo_buffer *buf, zval *date TSRMLS_DC)
{
int64_t ms;
zval *sec = zend_read_property(mongo_ce_Date, date, "sec", 3, 0 TSRMLS_CC);
zval *usec = zend_read_property(mongo_ce_Date, date, "usec", 4, 0 TSRMLS_CC);
ms = ((int64_t)Z_LVAL_P(sec) * 1000) + ((int64_t)Z_LVAL_P(usec) / 1000);
php_mongo_serialize_long(buf, ms);
}
/*
* create a bson int from an Int32 object
*/
void php_mongo_serialize_int32(mongo_buffer *buf, zval *data TSRMLS_DC)
{
int value;
zval *zvalue = zend_read_property(mongo_ce_Int32, data, "value", 5, 0 TSRMLS_CC);
value = strtol(Z_STRVAL_P(zvalue), NULL, 10);
php_mongo_serialize_int(buf, value);
}
/*
* create a bson long from an Int64 object
*/
void php_mongo_serialize_int64(mongo_buffer *buf, zval *data TSRMLS_DC)
{
int64_t value;
zval *zvalue = zend_read_property(mongo_ce_Int64, data, "value", 5, 0 TSRMLS_CC);
value = strtoll(Z_STRVAL_P(zvalue), NULL, 10);
php_mongo_serialize_long(buf, value);
}
/*
* create a bson regex
*
* type: 11
* cstring cstring
*/
void php_mongo_serialize_regex(mongo_buffer *buf, zval *regex TSRMLS_DC)
{
zval *z;
z = zend_read_property(mongo_ce_Regex, regex, "regex", 5, 0 TSRMLS_CC);
php_mongo_serialize_string(buf, Z_STRVAL_P(z), Z_STRLEN_P(z));
z = zend_read_property(mongo_ce_Regex, regex, "flags", 5, 0 TSRMLS_CC);
php_mongo_serialize_string(buf, Z_STRVAL_P(z), Z_STRLEN_P(z));
}
/*
* create a bson code with scope
*
* type: 15
* 4 bytes total size
* 4 bytes cstring size + NULL
* cstring
* bson object scope
*/
void php_mongo_serialize_code(mongo_buffer *buf, zval *code TSRMLS_DC)
{
uint start;
zval *zid;
/* save spot for size */
start = buf->pos-buf->start;
buf->pos += INT_32;
zid = zend_read_property(mongo_ce_Code, code, "code", 4, NOISY TSRMLS_CC);
/* string size */
php_mongo_serialize_int(buf, Z_STRLEN_P(zid) + 1);
/* string */
php_mongo_serialize_string(buf, Z_STRVAL_P(zid), Z_STRLEN_P(zid));
/* scope */
zid = zend_read_property(mongo_ce_Code, code, "scope", 5, NOISY TSRMLS_CC);
zval_to_bson(buf, HASH_P(zid), NO_PREP, MONGO_DEFAULT_MAX_MESSAGE_SIZE TSRMLS_CC);
if (EG(exception)) {
return;
}
/* get total size */
php_mongo_serialize_size(buf->start + start, buf, MONGO_DEFAULT_MAX_MESSAGE_SIZE TSRMLS_CC);
}
/*
* create bson binary data
*
* type: 5
* 4 bytes: length of bindata
* 1 byte: bindata type
* bindata
*/
void php_mongo_serialize_bin_data(mongo_buffer *buf, zval *bin TSRMLS_DC)
{
zval *zbin, *ztype;
zbin = zend_read_property(mongo_ce_BinData, bin, "bin", 3, 0 TSRMLS_CC);
ztype = zend_read_property(mongo_ce_BinData, bin, "type", 4, 0 TSRMLS_CC);
if (
Z_LVAL_P(ztype) == PHP_MONGO_BIN_UUID_RFC4122 &&
Z_STRLEN_P(zbin) != PHP_MONGO_BIN_UUID_RFC4122_SIZE
) {
zend_throw_exception_ex(mongo_ce_Exception, 25 TSRMLS_CC, "RFC4122 UUID must be %d bytes; actually: %d", PHP_MONGO_BIN_UUID_RFC4122_SIZE, Z_STRLEN_P(zbin));
return;
}
/*
* type 2 has the redundant structure:
*
* |------|--|-------==========|
* length 02 length bindata
*
* - 4 bytes: length of bindata (+4 for length below)
* - 1 byte type (0x02)
* - N bytes: 4 bytes of length of the following bindata + bindata
*
* All other types have:
*
* |------|--|==========|
* length bindata
* type
*/
if (Z_LVAL_P(ztype) == PHP_MONGO_BIN_BYTE_ARRAY) {
/* length */
php_mongo_serialize_int(buf, Z_STRLEN_P(zbin) + 4);
/* 02 */
php_mongo_serialize_byte(buf, PHP_MONGO_BIN_BYTE_ARRAY);
/* length */
php_mongo_serialize_int(buf, Z_STRLEN_P(zbin));
} else {
/* length */
php_mongo_serialize_int(buf, Z_STRLEN_P(zbin));
/* type */
php_mongo_serialize_byte(buf, (unsigned char)Z_LVAL_P(ztype));
}
/* bindata */
php_mongo_serialize_bytes(buf, Z_STRVAL_P(zbin), Z_STRLEN_P(zbin));
}
/*
* create bson timestamp
*
* type: 17
* 4 bytes seconds since epoch
* 4 bytes increment
*/
void php_mongo_serialize_ts(mongo_buffer *buf, zval *time TSRMLS_DC)
{
zval *ts, *inc;
ts = zend_read_property(mongo_ce_Timestamp, time, "sec", strlen("sec"), NOISY TSRMLS_CC);
inc = zend_read_property(mongo_ce_Timestamp, time, "inc", strlen("inc"), NOISY TSRMLS_CC);
php_mongo_serialize_int(buf, Z_LVAL_P(inc));
php_mongo_serialize_int(buf, Z_LVAL_P(ts));
}
void php_mongo_serialize_byte(mongo_buffer *buf, char b)
{
if (BUF_REMAINING <= 1) {
resize_buf(buf, 1);
}
*(buf->pos) = b;
buf->pos += 1;
}
void php_mongo_serialize_bytes(mongo_buffer *buf, const char *str, int str_len)
{
if (BUF_REMAINING <= str_len) {
resize_buf(buf, str_len);
}
memcpy(buf->pos, str, str_len);
buf->pos += str_len;
}
void php_mongo_serialize_string(mongo_buffer *buf, const char *str, int str_len)
{
if (BUF_REMAINING <= str_len + 1) {
resize_buf(buf, str_len + 1);
}
memcpy(buf->pos, str, str_len);
/* add \0 at the end of the string */
buf->pos[str_len] = 0;
buf->pos += str_len + 1;
}
void php_mongo_serialize_int(mongo_buffer *buf, int num)
{
int i = MONGO_32(num);
if (BUF_REMAINING <= INT_32) {
resize_buf(buf, INT_32);
}
memcpy(buf->pos, &i, INT_32);
buf->pos += INT_32;
}
void php_mongo_serialize_long(mongo_buffer *buf, int64_t num)
{
int64_t i = MONGO_64(num);
if (BUF_REMAINING <= INT_64) {
resize_buf(buf, INT_64);
}
memcpy(buf->pos, &i, INT_64);
buf->pos += INT_64;
}
void php_mongo_serialize_double(mongo_buffer *buf, double num)
{
int64_t dest, *dest_p;
dest_p = &dest;
memcpy(dest_p, &num, 8);
dest = MONGO_64(dest);
if (BUF_REMAINING <= INT_64) {
resize_buf(buf, INT_64);
}
memcpy(buf->pos, dest_p, DOUBLE_64);
buf->pos += DOUBLE_64;
}
/*
* prep == true
* we are inserting, so keys can't have .'s in them
*/
void php_mongo_serialize_key(mongo_buffer *buf, const char *str, int str_len, int prep TSRMLS_DC)
{
if (str[0] == '\0' && !MonGlo(allow_empty_keys)) {
zend_throw_exception_ex(mongo_ce_Exception, 1 TSRMLS_CC, "zero-length keys are not allowed, did you use $ with double quotes?");
return;
}
if (BUF_REMAINING <= str_len + 1) {
resize_buf(buf, str_len + 1);
}
if (memchr(str, '\0', str_len) != NULL) {
zend_throw_exception_ex(mongo_ce_Exception, 2 TSRMLS_CC, "'\\0' not allowed in key: %s\\0...", str);
return;
}
if (prep && (strchr(str, '.') != 0)) {
zend_throw_exception_ex(mongo_ce_Exception, 2 TSRMLS_CC, "'.' not allowed in key: %s", str);
return;
}
if (MonGlo(cmd_char) && strchr(str, MonGlo(cmd_char)[0]) == str) {
*(buf->pos) = '$';
memcpy(buf->pos + 1, str + 1, str_len-1);
} else {
memcpy(buf->pos, str, str_len);
}
/* add \0 at the end of the string */
buf->pos[str_len] = 0;
buf->pos += str_len + 1;
}
/*
* replaces collection names starting with MonGlo(cmd_char)
* with the '$' character.
*
* TODO: this doesn't handle main.$oplog-type situations (if
* MonGlo(cmd_char) is set)
*/
void php_mongo_serialize_ns(mongo_buffer *buf, const char *str TSRMLS_DC)
{
char *collection = strchr(str, '.') + 1;
if (BUF_REMAINING <= (int)strlen(str) + 1) {
resize_buf(buf, strlen(str) + 1);
}
if (MonGlo(cmd_char) && strchr(collection, MonGlo(cmd_char)[0]) == collection) {
memcpy(buf->pos, str, collection-str);
buf->pos += collection-str;
*(buf->pos) = '$';
memcpy(buf->pos + 1, collection + 1, strlen(collection)-1);
buf->pos[strlen(collection)] = 0;
buf->pos += strlen(collection) + 1;
} else {
memcpy(buf->pos, str, strlen(str));
buf->pos[strlen(str)] = 0;
buf->pos += strlen(str) + 1;
}
}
/* Returns:
* 0 on success,
* -1 when an exception in zval_to_bson was thrown
* -3 when a fragment or document was too large
* An exception is also thrown when the return value is not 0 */
static int insert_helper(mongo_buffer *buf, zval *doc, int max_document_size TSRMLS_DC)
{
int start = buf->pos - buf->start;
int result = zval_to_bson(buf, HASH_P(doc), PREP, max_document_size TSRMLS_CC);
/* throw exception if serialization crapped out */
if (EG(exception) || FAILURE == result) {
return -1;
}
/* throw an exception if the doc was too big */
if (buf->pos - (buf->start + start) > max_document_size) {
zend_throw_exception_ex(mongo_ce_Exception, 5 TSRMLS_CC, "size of BSON doc is %d bytes, max is %d", buf->pos - (buf->start + start), max_document_size);
return -3;
}
return (php_mongo_serialize_size(buf->start + start, buf, max_document_size TSRMLS_CC) == SUCCESS) ? 0 : -3;
}
int php_mongo_write_insert(mongo_buffer *buf, const char *ns, zval *doc, int max_document_size, int max_message_size TSRMLS_DC)
{
mongo_msg_header header;
int start = buf->pos - buf->start;
CREATE_HEADER(buf, ns, OP_INSERT);
if (insert_helper(buf, doc, max_document_size TSRMLS_CC) != 0) {
return FAILURE;
}
return php_mongo_serialize_size(buf->start + start, buf, max_message_size TSRMLS_CC);
}
int php_mongo_write_batch_insert(mongo_buffer *buf, const char *ns, int flags, zval *docs, int max_document_size, int max_message_size TSRMLS_DC)
{
int start = buf->pos - buf->start, count = 0;
HashPosition pointer;
zval **doc;
mongo_msg_header header;
CREATE_HEADER_WITH_OPTS(buf, ns, OP_INSERT, flags);
for (
zend_hash_internal_pointer_reset_ex(HASH_P(docs), &pointer);
zend_hash_get_current_data_ex(HASH_P(docs), (void**)&doc, &pointer) == SUCCESS;
zend_hash_move_forward_ex(HASH_P(docs), &pointer)
) {
if (IS_SCALAR_PP(doc)) {
continue;
}
if (insert_helper(buf, *doc, max_document_size TSRMLS_CC) != 0) {
/* An exception has already been thrown */
return FAILURE;
}
if (buf->pos - buf->start >= max_message_size) {
zend_throw_exception_ex(mongo_ce_Exception, 5 TSRMLS_CC, "current batch size is too large: %d, max: %d", buf->pos - buf->start, max_message_size);
return FAILURE;
}
count++;
}
/* this is a hard limit in the db server (util/messages.cpp) */
if (buf->pos - (buf->start + start) > max_message_size) {
zend_throw_exception_ex(mongo_ce_Exception, 3 TSRMLS_CC, "insert too large: %d, max: %d", buf->pos - (buf->start + start), max_message_size);
return FAILURE;
}
if (php_mongo_serialize_size(buf->start + start, buf, max_message_size TSRMLS_CC) == FAILURE) {
return FAILURE;
}
return count;
}
int php_mongo_write_update(mongo_buffer *buf, const char *ns, int flags, zval *criteria, zval *newobj, int max_document_size, int max_message_size TSRMLS_DC)
{
mongo_msg_header header;
int start = buf->pos - buf->start;
CREATE_HEADER(buf, ns, OP_UPDATE);
php_mongo_serialize_int(buf, flags);
if (
zval_to_bson(buf, HASH_P(criteria), NO_PREP, max_document_size TSRMLS_CC) == FAILURE ||
EG(exception) ||
zval_to_bson(buf, HASH_P(newobj), NO_PREP, max_document_size TSRMLS_CC) == FAILURE ||
EG(exception) /* Having this twice does make sense, as zval_to_bson can thrown an exception */
) {
return FAILURE;
}
return php_mongo_serialize_size(buf->start + start, buf, max_message_size TSRMLS_CC);
}
int php_mongo_write_delete(mongo_buffer *buf, const char *ns, int flags, zval *criteria, int max_document_size, int max_message_size TSRMLS_DC)
{
mongo_msg_header header;
int start = buf->pos - buf->start;
CREATE_HEADER(buf, ns, OP_DELETE);
php_mongo_serialize_int(buf, flags);
if (zval_to_bson(buf, HASH_P(criteria), NO_PREP, max_document_size TSRMLS_CC) == FAILURE || EG(exception)) {
return FAILURE;
}
return php_mongo_serialize_size(buf->start + start, buf, max_message_size TSRMLS_CC);
}
/*
* Creates a query string in buf.
*
* The following fields of cursor are used:
* - ns
* - opts
* - skip
* - limit
* - query
* - fields
*
*/
int php_mongo_write_query(mongo_buffer *buf, mongo_cursor *cursor, int max_document_size, int max_message_size TSRMLS_DC)
{
mongo_msg_header header;
int start = buf->pos - buf->start;
CREATE_HEADER_WITH_OPTS(buf, cursor->ns, OP_QUERY, cursor->opts);
cursor->send.request_id = header.request_id;
php_mongo_serialize_int(buf, cursor->skip);
php_mongo_serialize_int(buf, php_mongo_calculate_next_request_limit(cursor));
if (zval_to_bson(buf, HASH_P(cursor->query), NO_PREP, max_document_size TSRMLS_CC) == FAILURE || EG(exception)) {
return FAILURE;
}
if (cursor->fields && zend_hash_num_elements(HASH_P(cursor->fields)) > 0) {
if (zval_to_bson(buf, HASH_P(cursor->fields), NO_PREP, max_document_size TSRMLS_CC) == FAILURE || EG(exception)) {
return FAILURE;
}
}
return php_mongo_serialize_size(buf->start + start, buf, max_message_size TSRMLS_CC);
}
int php_mongo_write_kill_cursors(mongo_buffer *buf, int64_t cursor_id, int max_message_size TSRMLS_DC)
{
mongo_msg_header header;
CREATE_MSG_HEADER(MonGlo(request_id)++, 0, OP_KILL_CURSORS);
APPEND_HEADER(buf, 0);
/* # of cursors */
php_mongo_serialize_int(buf, 1);
/* cursor ids */
php_mongo_serialize_long(buf, cursor_id);
return php_mongo_serialize_size(buf->start, buf, max_message_size TSRMLS_CC);
}
/*
* Creates a GET_MORE request
*
* The following fields of cursor are used:
* - ns
* - recv.request_id
* - limit
* - cursor_id
*/
int php_mongo_write_get_more(mongo_buffer *buf, mongo_cursor *cursor TSRMLS_DC)
{
mongo_msg_header header;
int start = buf->pos - buf->start;
CREATE_RESPONSE_HEADER(buf, cursor->ns, cursor->recv.request_id, OP_GET_MORE);
cursor->send.request_id = header.request_id;
php_mongo_serialize_int(buf, php_mongo_calculate_next_request_limit(cursor));
php_mongo_serialize_long(buf, cursor->cursor_id);
return php_mongo_serialize_size(buf->start + start, buf, cursor->connection->max_message_size TSRMLS_CC);
}
/* Parses a single document from the BSON buffer and throws an exception if the
* the buffer is not exhausted (in addition to errors from bson_to_zval_iter).
*/
const char* bson_to_zval(const char *buf, size_t buf_len, HashTable *result, mongo_bson_conversion_options *options TSRMLS_DC)
{
const char *buf_end;
buf_end = bson_to_zval_iter(buf, buf_len, result, options TSRMLS_CC);
if (EG(exception)) {
return NULL;
}
if (buf + buf_len != buf_end) {
zend_throw_exception_ex(mongo_ce_CursorException, 42 TSRMLS_CC, "Document length (%u bytes) is not equal to buffer (%u bytes)", buf_end - buf, buf_len);
return NULL;
}
return buf_end;
}
/* Parses a single document from the BSON buffer and returns a pointer to the
* buffer position immediately following the document. If the buffer is invalid,
* an exception will be thrown and NULL will be returned.
*/
const char* bson_to_zval_iter(const char *buf, size_t buf_len, HashTable *result, mongo_bson_conversion_options *options TSRMLS_DC)
{
/* buf_start is used for debugging
*
* If the deserializer runs into bson it can't parse, it will dump the
* bytes to that point.
*
* We lose buf's position as we iterate, so we need buf_start to save it. */
const char *buf_start = buf, *buf_end;
unsigned char type;
int doc_len;
if (buf == 0) {
return NULL;
}
if (buf_len < 5) {
zend_throw_exception_ex(mongo_ce_CursorException, 38 TSRMLS_CC, "Reading document length would exceed buffer (%u bytes)", buf_len);
return NULL;
}
doc_len = MONGO_32(*((int32_t*)buf));
if (doc_len < 5) {
zend_throw_exception_ex(mongo_ce_CursorException, 39 TSRMLS_CC, "Document length (%d bytes) should be at least 5 (i.e. empty document)", doc_len);
return NULL;
}
if (buf_len < (size_t) doc_len) {
zend_throw_exception_ex(mongo_ce_CursorException, 40 TSRMLS_CC, "Document length (%d bytes) exceeds buffer (%u bytes)", doc_len, buf_len);
return NULL;
}
buf_end = buf + doc_len;
/* for size */
buf += INT_32;
while ((type = *buf++) != 0) {
const char *name;
size_t name_len;
zval *value;
name = buf;
name_len = strlen(name);
if (buf + name_len + 1 >= buf_end) {
zend_throw_exception_ex(mongo_ce_CursorException, 21 TSRMLS_CC, "Reading key name for type %02x would exceed buffer", (unsigned char) type);
return NULL;
}
/* get past field name */
buf += name_len + 1;
MAKE_STD_ZVAL(value);
ZVAL_NULL(value);
/* get value */
switch (type) {
case BSON_OID: {
mongo_id *this_id;
const char *tmp_id;
zval *str = 0;
CHECK_BUFFER_LEN(OID_SIZE);
object_init_ex(value, mongo_ce_Id);
this_id = (mongo_id*)zend_object_store_get_object(value TSRMLS_CC);
this_id->id = estrndup(buf, OID_SIZE);
MAKE_STD_ZVAL(str);
tmp_id = php_mongo_mongoid_to_hex(this_id->id);
ZVAL_STRING(str, tmp_id, 0);
zend_update_property(mongo_ce_Id, value, "$id", strlen("$id"), str TSRMLS_CC);
zval_ptr_dtor(&str);
buf += OID_SIZE;
break;
}
case BSON_DOUBLE: {
double d;
int64_t i, *i_p;
CHECK_BUFFER_LEN(DOUBLE_64);
d = *(double*)buf;
i_p = &i;
memcpy(i_p, &d, DOUBLE_64);
i = MONGO_64(i);
memcpy(&d, i_p, DOUBLE_64);
ZVAL_DOUBLE(value, d);
buf += DOUBLE_64;
break;
}
case BSON_SYMBOL:
case BSON_STRING: {
int len;
CHECK_BUFFER_LEN(INT_32);
len = MONGO_32(*((int32_t*)buf));
buf += INT_32;
/* len includes \0 */
if (len < 1) {
zval_ptr_dtor(&value);
zend_throw_exception_ex(mongo_ce_CursorException, 21 TSRMLS_CC, "invalid string length for key \"%s\": %d", name, len);
return NULL;
}
CHECK_BUFFER_LEN(len);
/* ensure that string is null-terminated */
if (buf[len - 1] != '\0') {
zval_ptr_dtor(&value);
zend_throw_exception_ex(mongo_ce_CursorException, 41 TSRMLS_CC, "string for key \"%s\" is not null-terminated", name);
return NULL;
}
ZVAL_STRINGL(value, buf, len-1, 1);
buf += len;
break;
}
case BSON_OBJECT: