forked from php/php-src
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdba.c
1240 lines (1095 loc) · 31.2 KB
/
dba.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 (c) The PHP Group |
+----------------------------------------------------------------------+
| This source file is subject to version 3.01 of the PHP license, |
| that is bundled with this package in the file LICENSE, and is |
| available through the world-wide-web at the following url: |
| https://www.php.net/license/3_01.txt |
| If you did not receive a copy of the PHP license and are unable to |
| obtain it through the world-wide-web, please send a note to |
| [email protected] so we can mail you a copy immediately. |
+----------------------------------------------------------------------+
| Authors: Sascha Schumann <[email protected]> |
| Marcus Boerger <[email protected]> |
+----------------------------------------------------------------------+
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "php.h"
#ifdef HAVE_DBA
#include "php_ini.h"
#include <stdio.h>
#include <fcntl.h>
#ifdef HAVE_SYS_FILE_H
#include <sys/file.h>
#endif
#include "php_dba.h"
#include "ext/standard/info.h"
#include "ext/standard/php_string.h"
#include "ext/standard/flock_compat.h"
#include "php_gdbm.h"
#include "php_ndbm.h"
#include "php_dbm.h"
#include "php_cdb.h"
#include "php_db1.h"
#include "php_db2.h"
#include "php_db3.h"
#include "php_db4.h"
#include "php_flatfile.h"
#include "php_inifile.h"
#include "php_qdbm.h"
#include "php_tcadb.h"
#include "php_lmdb.h"
#include "dba_arginfo.h"
PHP_MINIT_FUNCTION(dba);
PHP_MSHUTDOWN_FUNCTION(dba);
PHP_MINFO_FUNCTION(dba);
ZEND_BEGIN_MODULE_GLOBALS(dba)
const char *default_handler;
const dba_handler *default_hptr;
ZEND_END_MODULE_GLOBALS(dba)
ZEND_DECLARE_MODULE_GLOBALS(dba)
#define DBA_G(v) ZEND_MODULE_GLOBALS_ACCESSOR(dba, v)
static PHP_GINIT_FUNCTION(dba);
zend_module_entry dba_module_entry = {
STANDARD_MODULE_HEADER,
"dba",
ext_functions,
PHP_MINIT(dba),
PHP_MSHUTDOWN(dba),
NULL,
NULL,
PHP_MINFO(dba),
PHP_DBA_VERSION,
PHP_MODULE_GLOBALS(dba),
PHP_GINIT(dba),
NULL,
NULL,
STANDARD_MODULE_PROPERTIES_EX
};
#ifdef COMPILE_DL_DBA
#ifdef ZTS
ZEND_TSRMLS_CACHE_DEFINE()
#endif
ZEND_GET_MODULE(dba)
#endif
/* {{{ php_dba_make_key */
static zend_string* php_dba_make_key(HashTable *key)
{
zval *group, *name;
zend_string *group_str, *name_str;
HashPosition pos;
if (zend_hash_num_elements(key) != 2) {
zend_argument_error(NULL, 1, "must have exactly two elements: \"key\" and \"name\"");
return NULL;
}
// TODO: Use ZEND_HASH_FOREACH_VAL() API?
zend_hash_internal_pointer_reset_ex(key, &pos);
group = zend_hash_get_current_data_ex(key, &pos);
group_str = zval_try_get_string(group);
if (!group_str) {
return NULL;
}
zend_hash_move_forward_ex(key, &pos);
name = zend_hash_get_current_data_ex(key, &pos);
name_str = zval_try_get_string(name);
if (!name_str) {
zend_string_release_ex(group_str, false);
return NULL;
}
// TODO: Check ZSTR_LEN(name) != 0
if (ZSTR_LEN(group_str) == 0) {
zend_string_release_ex(group_str, false);
return name_str;
}
zend_string *key_str = zend_strpprintf(0, "[%s]%s", ZSTR_VAL(group_str), ZSTR_VAL(name_str));
zend_string_release_ex(group_str, false);
zend_string_release_ex(name_str, false);
return key_str;
}
/* }}} */
#define DBA_RELEASE_HT_KEY_CREATION() if (key_ht) {zend_string_release_ex(key_str, false);}
#define DBA_FETCH_RESOURCE(info, id) \
if ((info = (dba_info *)zend_fetch_resource2(Z_RES_P(id), "DBA identifier", le_db, le_pdb)) == NULL) { \
RETURN_THROWS(); \
}
/* check whether the user has write access */
#define DBA_WRITE_CHECK(info) \
if ((info)->mode != DBA_WRITER && (info)->mode != DBA_TRUNC && (info)->mode != DBA_CREAT) { \
php_error_docref(NULL, E_WARNING, "Cannot perform a modification on a readonly database"); \
RETURN_FALSE; \
}
/* a DBA handler must have specific routines */
#define DBA_NAMED_HND(alias, name, flags) \
{\
#alias, flags, dba_open_##name, dba_close_##name, dba_fetch_##name, dba_update_##name, \
dba_exists_##name, dba_delete_##name, dba_firstkey_##name, dba_nextkey_##name, \
dba_optimize_##name, dba_sync_##name, dba_info_##name \
},
#define DBA_HND(name, flags) DBA_NAMED_HND(name, name, flags)
/* }}} */
/* {{{ globals */
static const dba_handler handler[] = {
#ifdef DBA_GDBM
DBA_HND(gdbm, DBA_LOCK_EXT) /* Locking done in library if set */
#endif
#ifdef DBA_DBM
DBA_HND(dbm, DBA_LOCK_ALL) /* No lock in lib */
#endif
#ifdef DBA_NDBM
DBA_HND(ndbm, DBA_LOCK_ALL) /* Could be done in library: filemode = 0644 + S_ENFMT */
#endif
#ifdef DBA_CDB
DBA_HND(cdb, DBA_STREAM_OPEN|DBA_LOCK_ALL) /* No lock in lib */
#endif
#ifdef DBA_CDB_BUILTIN
DBA_NAMED_HND(cdb_make, cdb, DBA_STREAM_OPEN|DBA_LOCK_ALL) /* No lock in lib */
#endif
#ifdef DBA_DB1
DBA_HND(db1, DBA_LOCK_ALL) /* No lock in lib */
#endif
#ifdef DBA_DB2
DBA_HND(db2, DBA_LOCK_ALL) /* No lock in lib */
#endif
#ifdef DBA_DB3
DBA_HND(db3, DBA_LOCK_ALL) /* No lock in lib */
#endif
#ifdef DBA_DB4
DBA_HND(db4, DBA_LOCK_ALL) /* No lock in lib */
#endif
#ifdef DBA_INIFILE
DBA_HND(inifile, DBA_STREAM_OPEN|DBA_LOCK_ALL|DBA_CAST_AS_FD) /* No lock in lib */
#endif
#ifdef DBA_FLATFILE
DBA_HND(flatfile, DBA_STREAM_OPEN|DBA_LOCK_ALL|DBA_NO_APPEND) /* No lock in lib */
#endif
#ifdef DBA_QDBM
DBA_HND(qdbm, DBA_LOCK_EXT)
#endif
#ifdef DBA_TCADB
DBA_HND(tcadb, DBA_LOCK_ALL)
#endif
#ifdef DBA_LMDB
DBA_HND(lmdb, DBA_LOCK_EXT)
#endif
{ NULL, 0, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL }
};
#ifdef DBA_FLATFILE
#define DBA_DEFAULT "flatfile"
#elif defined(DBA_DB4)
#define DBA_DEFAULT "db4"
#elif defined(DBA_DB3)
#define DBA_DEFAULT "db3"
#elif defined(DBA_DB2)
#define DBA_DEFAULT "db2"
#elif defined(DBA_DB1)
#define DBA_DEFAULT "db1"
#elif defined(DBA_GDBM)
#define DBA_DEFAULT "gdbm"
#elif defined(DBA_NBBM)
#define DBA_DEFAULT "ndbm"
#elif defined(DBA_DBM)
#define DBA_DEFAULT "dbm"
#elif defined(DBA_QDBM)
#define DBA_DEFAULT "qdbm"
#elif defined(DBA_TCADB)
#define DBA_DEFAULT "tcadb"
#elif defined(DBA_LMDB)
#define DBA_DEFAULT "lmdb"
#else
#define DBA_DEFAULT ""
#endif
/* cdb/cdb_make and ini are no option here */
static int le_db;
static int le_pdb;
/* }}} */
/* {{{ dba_fetch_resource
PHPAPI void dba_fetch_resource(dba_info **pinfo, zval **id)
{
dba_info *info;
DBA_ID_FETCH
*pinfo = info;
}
*/
/* }}} */
/* {{{ dba_get_handler
PHPAPI dba_handler *dba_get_handler(const char* handler_name)
{
const dba_handler *hptr;
for (hptr = handler; hptr->name && strcasecmp(hptr->name, handler_name); hptr++);
return hptr;
}
*/
/* }}} */
/* {{{ dba_close */
static void dba_close(dba_info *info)
{
if (info->hnd) {
info->hnd->close(info);
}
ZEND_ASSERT(info->path);
zend_string_release_ex(info->path, info->flags&DBA_PERSISTENT);
info->path = NULL;
if (info->fp && info->fp != info->lock.fp) {
if (info->flags & DBA_PERSISTENT) {
php_stream_pclose(info->fp);
} else {
php_stream_close(info->fp);
}
}
if (info->lock.fp) {
if (info->flags & DBA_PERSISTENT) {
php_stream_pclose(info->lock.fp);
} else {
php_stream_close(info->lock.fp);
}
}
pefree(info, info->flags&DBA_PERSISTENT);
}
/* }}} */
/* {{{ dba_close_rsrc */
static void dba_close_rsrc(zend_resource *rsrc)
{
dba_info *info = (dba_info *)rsrc->ptr;
dba_close(info);
}
/* }}} */
/* {{{ dba_close_pe_rsrc_deleter */
static int dba_close_pe_rsrc_deleter(zval *el, void *pDba)
{
if (Z_RES_P(el)->ptr == pDba) {
if (Z_DELREF_P(el) == 0) {
return ZEND_HASH_APPLY_REMOVE;
} else {
return ZEND_HASH_APPLY_KEEP | ZEND_HASH_APPLY_STOP;
}
} else {
return ZEND_HASH_APPLY_KEEP;
}
}
/* }}} */
/* {{{ dba_close_pe_rsrc */
static void dba_close_pe_rsrc(zend_resource *rsrc)
{
dba_info *info = (dba_info *)rsrc->ptr;
/* closes the resource by calling dba_close_rsrc() */
zend_hash_apply_with_argument(&EG(persistent_list), dba_close_pe_rsrc_deleter, info);
}
/* }}} */
/* {{{ PHP_INI */
static ZEND_INI_MH(OnUpdateDefaultHandler)
{
const dba_handler *hptr;
if (!ZSTR_LEN(new_value)) {
DBA_G(default_hptr) = NULL;
return OnUpdateString(entry, new_value, mh_arg1, mh_arg2, mh_arg3, stage);
}
for (hptr = handler; hptr->name && strcasecmp(hptr->name, ZSTR_VAL(new_value)); hptr++);
if (!hptr->name) {
php_error_docref(NULL, E_WARNING, "No such handler: %s", ZSTR_VAL(new_value));
return FAILURE;
}
DBA_G(default_hptr) = hptr;
return OnUpdateString(entry, new_value, mh_arg1, mh_arg2, mh_arg3, stage);
}
PHP_INI_BEGIN()
STD_PHP_INI_ENTRY("dba.default_handler", DBA_DEFAULT, PHP_INI_ALL, OnUpdateDefaultHandler, default_handler, zend_dba_globals, dba_globals)
PHP_INI_END()
/* }}} */
/* {{{ PHP_GINIT_FUNCTION */
static PHP_GINIT_FUNCTION(dba)
{
#if defined(COMPILE_DL_DBA) && defined(ZTS)
ZEND_TSRMLS_CACHE_UPDATE();
#endif
dba_globals->default_handler = "";
dba_globals->default_hptr = NULL;
}
/* }}} */
/* {{{ PHP_MINIT_FUNCTION */
PHP_MINIT_FUNCTION(dba)
{
REGISTER_INI_ENTRIES();
le_db = zend_register_list_destructors_ex(dba_close_rsrc, NULL, "dba", module_number);
le_pdb = zend_register_list_destructors_ex(dba_close_pe_rsrc, dba_close_rsrc, "dba persistent", module_number);
register_dba_symbols(module_number);
return SUCCESS;
}
/* }}} */
/* {{{ PHP_MSHUTDOWN_FUNCTION */
PHP_MSHUTDOWN_FUNCTION(dba)
{
UNREGISTER_INI_ENTRIES();
return SUCCESS;
}
/* }}} */
#include "zend_smart_str.h"
/* {{{ PHP_MINFO_FUNCTION */
PHP_MINFO_FUNCTION(dba)
{
const dba_handler *hptr;
smart_str handlers = {0};
for(hptr = handler; hptr->name; hptr++) {
smart_str_appends(&handlers, hptr->name);
smart_str_appendc(&handlers, ' ');
}
php_info_print_table_start();
php_info_print_table_row(2, "DBA support", "enabled");
if (handlers.s) {
smart_str_0(&handlers);
php_info_print_table_row(2, "Supported handlers", ZSTR_VAL(handlers.s));
smart_str_free(&handlers);
} else {
php_info_print_table_row(2, "Supported handlers", "none");
}
php_info_print_table_end();
DISPLAY_INI_ENTRIES();
}
/* }}} */
/* {{{ php_dba_update */
static void php_dba_update(INTERNAL_FUNCTION_PARAMETERS, int mode)
{
zval *id;
dba_info *info = NULL;
HashTable *key_ht = NULL;
zend_string *key_str = NULL;
zend_string *value;
ZEND_PARSE_PARAMETERS_START(3, 3)
Z_PARAM_ARRAY_HT_OR_STR(key_ht, key_str)
Z_PARAM_STR(value)
Z_PARAM_RESOURCE(id);
ZEND_PARSE_PARAMETERS_END();
DBA_FETCH_RESOURCE(info, id);
DBA_WRITE_CHECK(info);
if (key_ht) {
key_str = php_dba_make_key(key_ht);
if (!key_str) {
// TODO ValueError?
RETURN_FALSE;
}
}
RETVAL_BOOL(info->hnd->update(info, key_str, value, mode) == SUCCESS);
DBA_RELEASE_HT_KEY_CREATION();
}
/* }}} */
/* {{{ php_find_dbm */
static dba_info *php_dba_find(const zend_string *path)
{
zend_resource *le;
dba_info *info;
zend_long numitems, i;
numitems = zend_hash_next_free_element(&EG(regular_list));
for (i=1; i<numitems; i++) {
if ((le = zend_hash_index_find_ptr(&EG(regular_list), i)) == NULL) {
continue;
}
if (le->type == le_db || le->type == le_pdb) {
info = (dba_info *)(le->ptr);
if (zend_string_equals(path, info->path)) {
return (dba_info *)(le->ptr);
}
}
}
return NULL;
}
/* }}} */
static zend_always_inline zend_string *php_dba_zend_string_dup_safe(zend_string *s, bool persistent)
{
if (ZSTR_IS_INTERNED(s) && !persistent) {
return s;
} else {
zend_string *duplicated_str = zend_string_init(ZSTR_VAL(s), ZSTR_LEN(s), persistent);
if (persistent) {
GC_MAKE_PERSISTENT_LOCAL(duplicated_str);
}
return duplicated_str;
}
}
#define FREE_PERSISTENT_RESOURCE_KEY() if (persistent_resource_key) {zend_string_release_ex(persistent_resource_key, false);}
/* {{{ php_dba_open */
static void php_dba_open(INTERNAL_FUNCTION_PARAMETERS, bool persistent)
{
dba_mode_t modenr;
dba_info *info, *other;
const dba_handler *hptr;
const char *error = NULL;
int lock_mode, lock_flag = 0;
const char *file_mode;
const char *lock_file_mode = NULL;
int persistent_flag = persistent ? STREAM_OPEN_PERSISTENT : 0;
char *lock_name;
#ifdef PHP_WIN32
bool restarted = 0;
bool need_creation = 0;
#endif
zend_string *path;
zend_string *mode;
zend_string *handler_str = NULL;
zend_long permission = 0644;
zend_long map_size = 0;
zend_long driver_flags = DBA_DEFAULT_DRIVER_FLAGS;
bool is_flags_null = true;
zend_string *persistent_resource_key = NULL;
if (FAILURE == zend_parse_parameters(ZEND_NUM_ARGS(), "PS|S!lll!", &path, &mode, &handler_str,
&permission, &map_size, &driver_flags, &is_flags_null)) {
RETURN_THROWS();
}
if (ZSTR_LEN(path) == 0) {
zend_argument_value_error(1, "cannot be empty");
RETURN_THROWS();
}
if (ZSTR_LEN(mode) == 0) {
zend_argument_value_error(2, "cannot be empty");
RETURN_THROWS();
}
if (handler_str && ZSTR_LEN(handler_str) == 0) {
zend_argument_value_error(3, "cannot be empty");
RETURN_THROWS();
}
// TODO Check Value for permission
if (map_size < 0) {
zend_argument_value_error(5, "must be greater than or equal to 0");
RETURN_THROWS();
}
if (!is_flags_null && driver_flags < 0) {
zend_argument_value_error(6, "must be greater than or equal to 0");
RETURN_THROWS();
}
if (persistent) {
zend_resource *le;
if (handler_str) {
persistent_resource_key = zend_string_concat3(
ZSTR_VAL(path), ZSTR_LEN(path),
ZSTR_VAL(mode), ZSTR_LEN(mode),
ZSTR_VAL(handler_str), ZSTR_LEN(handler_str)
);
} else {
persistent_resource_key = zend_string_concat2(
ZSTR_VAL(path), ZSTR_LEN(path),
ZSTR_VAL(mode), ZSTR_LEN(mode)
);
}
/* try to find if we already have this link in our persistent list */
if ((le = zend_hash_find_ptr(&EG(persistent_list), persistent_resource_key)) != NULL) {
FREE_PERSISTENT_RESOURCE_KEY();
if (le->type != le_pdb) {
// TODO This should never happen
RETURN_FALSE;
}
info = (dba_info *)le->ptr;
GC_ADDREF(le);
RETURN_RES(zend_register_resource(info, le_pdb));
}
}
if (!handler_str) {
hptr = DBA_G(default_hptr);
if (!hptr) {
php_error_docref(NULL, E_WARNING, "No default handler selected");
FREE_PERSISTENT_RESOURCE_KEY();
RETURN_FALSE;
}
ZEND_ASSERT(hptr->name);
} else {
/* Loop through global static var handlers to see if such a handler exists */
for (hptr = handler; hptr->name && strcasecmp(hptr->name, ZSTR_VAL(handler_str)); hptr++);
if (!hptr->name) {
php_error_docref(NULL, E_WARNING, "Handler \"%s\" is not available", ZSTR_VAL(handler_str));
FREE_PERSISTENT_RESOURCE_KEY();
RETURN_FALSE;
}
}
/* Check mode: [rwnc][dl-]?t?
* r: Read
* w: Write
* n: Create/Truncate
* c: Create
*
* d: force lock on database file
* l: force lock on lck file
* -: ignore locking
*
* t: test open database, warning if locked
*/
bool is_test_lock = false;
bool is_db_lock = false;
bool is_lock_ignored = false;
// bool is_file_lock = false;
if (ZSTR_LEN(mode) == 0) {
zend_argument_value_error(2, "cannot be empty");
FREE_PERSISTENT_RESOURCE_KEY();
RETURN_THROWS();
}
if (ZSTR_LEN(mode) > 3) {
zend_argument_value_error(2, "must be at most 3 characters");
FREE_PERSISTENT_RESOURCE_KEY();
RETURN_THROWS();
}
if (ZSTR_LEN(mode) == 3) {
if (ZSTR_VAL(mode)[2] != 't') {
zend_argument_value_error(2, "third character must be \"t\"");
FREE_PERSISTENT_RESOURCE_KEY();
RETURN_THROWS();
}
is_test_lock = true;
}
if (ZSTR_LEN(mode) >= 2) {
switch (ZSTR_VAL(mode)[1]) {
case 't':
is_test_lock = true;
break;
case '-':
if ((hptr->flags & DBA_LOCK_ALL) == 0) {
php_error_docref(NULL, E_WARNING, "Locking cannot be disabled for handler %s", hptr->name);
FREE_PERSISTENT_RESOURCE_KEY();
RETURN_FALSE;
}
is_lock_ignored = true;
lock_flag = 0;
break;
case 'd':
is_db_lock = true;
if ((hptr->flags & DBA_LOCK_ALL) == 0) {
lock_flag = (hptr->flags & DBA_LOCK_ALL);
break;
}
ZEND_FALLTHROUGH;
case 'l':
// is_file_lock = true;
lock_flag = DBA_LOCK_ALL;
if ((hptr->flags & DBA_LOCK_ALL) == 0) {
php_error_docref(NULL, E_NOTICE, "Handler %s does locking internally", hptr->name);
}
break;
default:
zend_argument_value_error(2, "second character must be one of \"d\", \"l\", \"-\", or \"t\"");
FREE_PERSISTENT_RESOURCE_KEY();
RETURN_THROWS();
}
} else {
lock_flag = (hptr->flags&DBA_LOCK_ALL);
is_db_lock = true;
}
switch (ZSTR_VAL(mode)[0]) {
case 'r':
modenr = DBA_READER;
lock_mode = (lock_flag & DBA_LOCK_READER) ? LOCK_SH : 0;
file_mode = "r";
break;
case 'w':
modenr = DBA_WRITER;
lock_mode = (lock_flag & DBA_LOCK_WRITER) ? LOCK_EX : 0;
file_mode = "r+b";
break;
case 'c': {
#ifdef PHP_WIN32
if (hptr->flags & (DBA_NO_APPEND|DBA_CAST_AS_FD)) {
php_stream_statbuf ssb;
need_creation = (SUCCESS != php_stream_stat_path(ZSTR_VAL(path), &ssb));
}
#endif
modenr = DBA_CREAT;
lock_mode = (lock_flag & DBA_LOCK_CREAT) ? LOCK_EX : 0;
if (lock_mode) {
if (is_db_lock) {
/* the create/append check will be done on the lock
* when the lib opens the file it is already created
*/
file_mode = "r+b"; /* read & write, seek 0 */
#ifdef PHP_WIN32
if (!need_creation) {
lock_file_mode = "r+b";
} else
#endif
lock_file_mode = "a+b"; /* append */
} else {
#ifdef PHP_WIN32
if (!need_creation) {
file_mode = "r+b";
} else
#endif
file_mode = "a+b"; /* append */
lock_file_mode = "w+b"; /* create/truncate */
}
} else {
#ifdef PHP_WIN32
if (!need_creation) {
file_mode = "r+b";
} else
#endif
file_mode = "a+b";
}
/* In case of the 'a+b' append mode, the handler is responsible
* to handle any rewind problems (see flatfile handler).
*/
break;
}
case 'n':
modenr = DBA_TRUNC;
lock_mode = (lock_flag & DBA_LOCK_TRUNC) ? LOCK_EX : 0;
file_mode = "w+b";
break;
default:
zend_argument_value_error(2, "first character must be one of \"r\", \"w\", \"c\", or \"n\"");
FREE_PERSISTENT_RESOURCE_KEY();
RETURN_THROWS();
}
if (!lock_file_mode) {
lock_file_mode = file_mode;
}
if (is_test_lock) {
if (is_lock_ignored) {
zend_argument_value_error(2, "cannot combine mode \"-\" (no lock) and \"t\" (test lock)");
FREE_PERSISTENT_RESOURCE_KEY();
RETURN_THROWS();
}
if (!lock_mode) {
if ((hptr->flags & DBA_LOCK_ALL) == 0) {
php_error_docref(NULL, E_WARNING, "Handler %s uses its own locking which doesn't support mode modifier t (test lock)", hptr->name);
FREE_PERSISTENT_RESOURCE_KEY();
RETURN_FALSE;
} else {
php_error_docref(NULL, E_WARNING, "Handler %s doesn't uses locking for this mode which makes modifier t (test lock) obsolete", hptr->name);
FREE_PERSISTENT_RESOURCE_KEY();
RETURN_FALSE;
}
} else {
lock_mode |= LOCK_NB; /* test =: non blocking */
}
}
info = pemalloc(sizeof(dba_info), persistent);
memset(info, 0, sizeof(dba_info));
info->path = php_dba_zend_string_dup_safe(path, persistent);
info->mode = modenr;
info->file_permission = permission;
info->map_size = map_size;
info->driver_flags = driver_flags;
info->flags = (hptr->flags & ~DBA_LOCK_ALL) | (lock_flag & DBA_LOCK_ALL) | (persistent ? DBA_PERSISTENT : 0);
info->lock.mode = lock_mode;
/* if any open call is a locking call:
* check if we already have a locking call open that should block this call
* the problem is some systems would allow read during write
*/
if (hptr->flags & DBA_LOCK_ALL) {
if ((other = php_dba_find(info->path)) != NULL) {
if ( ( (lock_mode&LOCK_EX) && (other->lock.mode&(LOCK_EX|LOCK_SH)) )
|| ( (other->lock.mode&LOCK_EX) && (lock_mode&(LOCK_EX|LOCK_SH)) )
) {
error = "Unable to establish lock (database file already open)"; /* force failure exit */
}
}
}
#ifdef PHP_WIN32
restart:
#endif
if (!error && lock_mode) {
if (is_db_lock) {
lock_name = ZSTR_VAL(path);
} else {
spprintf(&lock_name, 0, "%s.lck", ZSTR_VAL(info->path));
if (!strcmp(file_mode, "r")) {
zend_string *opened_path = NULL;
/* when in read only mode try to use existing .lck file first */
/* do not log errors for .lck file while in read only mode on .lck file */
lock_file_mode = "rb";
info->lock.fp = php_stream_open_wrapper(lock_name, lock_file_mode, STREAM_MUST_SEEK|IGNORE_PATH|persistent_flag, &opened_path);
if (opened_path) {
zend_string_release_ex(opened_path, 0);
}
}
if (!info->lock.fp) {
/* when not in read mode or failed to open .lck file read only. now try again in create(write) mode and log errors */
lock_file_mode = "a+b";
}
}
if (!info->lock.fp) {
zend_string *opened_path = NULL;
info->lock.fp = php_stream_open_wrapper(lock_name, lock_file_mode, STREAM_MUST_SEEK|REPORT_ERRORS|IGNORE_PATH|persistent_flag, &opened_path);
if (info->lock.fp) {
if (is_db_lock) {
ZEND_ASSERT(opened_path);
/* replace the path info with the real path of the opened file */
zend_string_release(info->path);
info->path = php_dba_zend_string_dup_safe(opened_path, persistent);
}
}
if (opened_path) {
zend_string_release_ex(opened_path, 0);
}
}
if (!is_db_lock) {
efree(lock_name);
}
if (!info->lock.fp) {
dba_close(info);
/* stream operation already wrote an error message */
FREE_PERSISTENT_RESOURCE_KEY();
RETURN_FALSE;
}
if (!php_stream_supports_lock(info->lock.fp)) {
error = "Stream does not support locking";
}
if (php_stream_lock(info->lock.fp, lock_mode)) {
error = "Unable to establish lock"; /* force failure exit */
}
}
/* centralised open stream for builtin */
if (!error && (hptr->flags&DBA_STREAM_OPEN)==DBA_STREAM_OPEN) {
if (info->lock.fp && is_db_lock) {
info->fp = info->lock.fp; /* use the same stream for locking and database access */
} else {
info->fp = php_stream_open_wrapper(ZSTR_VAL(info->path), file_mode, STREAM_MUST_SEEK|REPORT_ERRORS|IGNORE_PATH|persistent_flag, NULL);
}
if (!info->fp) {
dba_close(info);
/* stream operation already wrote an error message */
FREE_PERSISTENT_RESOURCE_KEY();
RETURN_FALSE;
}
if (hptr->flags & (DBA_NO_APPEND|DBA_CAST_AS_FD)) {
/* Needed because some systems do not allow to write to the original
* file contents with O_APPEND being set.
*/
if (SUCCESS != php_stream_cast(info->fp, PHP_STREAM_AS_FD, (void*)&info->fd, 1)) {
php_error_docref(NULL, E_WARNING, "Could not cast stream");
dba_close(info);
FREE_PERSISTENT_RESOURCE_KEY();
RETURN_FALSE;
#ifdef F_SETFL
} else if (modenr == DBA_CREAT) {
int flags = fcntl(info->fd, F_GETFL);
fcntl(info->fd, F_SETFL, flags & ~O_APPEND);
#elif defined(PHP_WIN32)
} else if (modenr == DBA_CREAT && need_creation && !restarted) {
if (info->lock.fp != NULL) {
php_stream_free(info->lock.fp, persistent ? PHP_STREAM_FREE_CLOSE_PERSISTENT : PHP_STREAM_FREE_CLOSE);
}
if (info->fp != info->lock.fp) {
php_stream_free(info->fp, persistent ? PHP_STREAM_FREE_CLOSE_PERSISTENT : PHP_STREAM_FREE_CLOSE);
}
info->fp = NULL;
info->lock.fp = NULL;
info->fd = -1;
lock_file_mode = "r+b";
restarted = 1;
goto restart;
#endif
}
}
}
if (error || hptr->open(info, &error) == FAILURE) {
dba_close(info);
if (EXPECTED(!EG(exception))) {
if (error) {
php_error_docref(NULL, E_WARNING, "Driver initialization failed for handler: %s: %s", hptr->name, error);
} else {
php_error_docref(NULL, E_WARNING, "Driver initialization failed for handler: %s", hptr->name);
}
}
FREE_PERSISTENT_RESOURCE_KEY();
RETURN_FALSE;
}
info->hnd = hptr;
if (persistent) {
ZEND_ASSERT(persistent_resource_key);
if (zend_register_persistent_resource_ex(persistent_resource_key, info, le_pdb) == NULL) {
dba_close(info);
php_error_docref(NULL, E_WARNING, "Could not register persistent resource");
FREE_PERSISTENT_RESOURCE_KEY();
RETURN_FALSE;
}
FREE_PERSISTENT_RESOURCE_KEY();
}
RETURN_RES(zend_register_resource(info, (persistent ? le_pdb : le_db)));
}
/* }}} */
/* {{{ Opens path using the specified handler in mode persistently */
PHP_FUNCTION(dba_popen)
{
php_dba_open(INTERNAL_FUNCTION_PARAM_PASSTHRU, 1);
}
/* }}} */
/* {{{ Opens path using the specified handler in mode*/
PHP_FUNCTION(dba_open)
{
php_dba_open(INTERNAL_FUNCTION_PARAM_PASSTHRU, 0);
}
/* }}} */
/* {{{ Closes database */
PHP_FUNCTION(dba_close)
{
zval *id;
dba_info *info = NULL;
if (zend_parse_parameters(ZEND_NUM_ARGS(), "r", &id) == FAILURE) {
RETURN_THROWS();
}
DBA_FETCH_RESOURCE(info, id);
zend_list_close(Z_RES_P(id));
}
/* }}} */
/* {{{ Checks, if the specified key exists */
PHP_FUNCTION(dba_exists)
{
zval *id;
dba_info *info = NULL;
HashTable *key_ht = NULL;
zend_string *key_str = NULL;
ZEND_PARSE_PARAMETERS_START(2, 2)
Z_PARAM_ARRAY_HT_OR_STR(key_ht, key_str)
Z_PARAM_RESOURCE(id);
ZEND_PARSE_PARAMETERS_END();
DBA_FETCH_RESOURCE(info, id);
if (key_ht) {
key_str = php_dba_make_key(key_ht);
if (!key_str) {
// TODO ValueError?
RETURN_FALSE;
}
}
RETVAL_BOOL(info->hnd->exists(info, key_str) == SUCCESS);
DBA_RELEASE_HT_KEY_CREATION();
}
/* }}} */
/* {{{ Fetches the data associated with key */
PHP_FUNCTION(dba_fetch)
{
zval *id;
dba_info *info = NULL;
HashTable *key_ht = NULL;
zend_string *key_str = NULL;
zend_long skip = 0;
/* Check for legacy signature */
if (ZEND_NUM_ARGS() == 3) {
ZEND_PARSE_PARAMETERS_START_EX(ZEND_PARSE_PARAMS_QUIET, 3, 3)
Z_PARAM_ARRAY_HT_OR_STR(key_ht, key_str)
Z_PARAM_LONG(skip)
Z_PARAM_RESOURCE(id);
ZEND_PARSE_PARAMETERS_END_EX(goto standard;);
zend_error(E_DEPRECATED, "Calling dba_fetch() with $dba at the 3rd parameter is deprecated");
if (UNEXPECTED(EG(exception))) {
RETURN_THROWS();
}
} else {
standard:
ZEND_PARSE_PARAMETERS_START(2, 3)
Z_PARAM_ARRAY_HT_OR_STR(key_ht, key_str)
Z_PARAM_RESOURCE(id);
Z_PARAM_OPTIONAL
Z_PARAM_LONG(skip)
ZEND_PARSE_PARAMETERS_END();
}
DBA_FETCH_RESOURCE(info, id);
if (key_ht) {
key_str = php_dba_make_key(key_ht);
if (!key_str) {
// TODO ValueError?
RETURN_FALSE;
}
}
if (skip != 0) {
if (!strcmp(info->hnd->name, "cdb")) {
// TODO ValueError?
if (skip < 0) {
php_error_docref(NULL, E_NOTICE, "Handler %s accepts only skip values greater than or equal to zero, using skip=0", info->hnd->name);
skip = 0;
}