-
Notifications
You must be signed in to change notification settings - Fork 20
/
rararch.c
1266 lines (1099 loc) · 35.8 KB
/
rararch.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
/*
+----------------------------------------------------------------------+
| PHP Version 5 |
+----------------------------------------------------------------------+
| Copyright (c) 1997-2009 The PHP Group |
+----------------------------------------------------------------------+
| This source file is subject to version 3.0 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: |
| http://www.php.net/license/3_0.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 |
| license@php.net so we can mail you a copy immediately. |
| |
| **** WARNING **** |
| |
| This module makes use of unRAR - free utility for RAR archives. |
| Its license states that you MUST NOT use its code to develop |
| a RAR (WinRAR) compatible archiver. |
| Please, read unRAR license for full information. |
| unRAR & RAR copyrights are owned by Eugene Roshal |
+----------------------------------------------------------------------+
| Author: Antony Dovgal <tony@daylessday.org> |
| Author: Gustavo Lopes <cataphract@php.net> |
+----------------------------------------------------------------------+
*/
/* $Id$ */
#include "zend_types.h"
#include <zend_API.h>
#ifdef __cplusplus
extern "C" {
#endif
#ifndef _GNU_SOURCE
# define _GNU_SOURCE
#endif
#include <string.h>
#include <wchar.h>
#include <php.h>
#include <zend_interfaces.h>
#include "php_rar.h"
#include "php_compat.h"
/* {{{ Type definitions reserved for this translation unit */
typedef struct _ze_rararch_object {
#if PHP_MAJOR_VERSION < 7
zend_object parent;
rar_file_t *rar_file;
#else
rar_file_t *rar_file;
zend_object parent;
#endif
} ze_rararch_object;
typedef struct _rararch_iterator {
zend_object_iterator parent;
rar_find_output *state;
#if PHP_MAJOR_VERSION < 7
zval *value;
#else
zval value;
#endif
int empty_iterator; /* iterator should give nothing */
} rararch_iterator;
/* }}} */
/* {{{ Globals with internal linkage */
static zend_class_entry *rararch_ce_ptr;
static zend_object_handlers rararch_object_handlers;
/* }}} */
/* {{{ Helper macros */
#define RAR_THIS_OR_NO_ARGS(file) \
if (file == NULL) { \
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "O", \
&file, rararch_ce_ptr) == FAILURE) { \
RETURN_NULL(); \
} \
} \
else { \
RAR_RETNULL_ON_ARGS(); \
}
/* }}} */
/* {{{ Function prototypes for functions with internal linkage */
static inline rar_obj_ref rar_obj_ref_fetch(zval *zv);
static inline void rar_obj_ref_make_zv(rar_obj_ref zo, zval *zv TSRMLS_DC);
#if PHP_MAJOR_VERSION >= 7
static inline ze_rararch_object *rararch_object_fetch(zend_object *zobj);
static ze_rararch_object *rararch_object_from_zv(const zval *zv);
static ze_rararch_object *rararch_object_from_ref(const rar_obj_ref ref);
static zend_object *rararch_ce_create_object(zend_class_entry *ce);
static void rararch_ce_free_object_storage(zend_object *zobj);
#else
#define rararch_object_from_zv zend_object_store_get_object
#define rararch_object_from_ref(ref) zend_object_store_get_object_by_handle((ref) TSRMLS_CC)
static zend_object_value rararch_ce_create_object(zend_class_entry *class_type TSRMLS_DC);
static void rararch_ce_free_object_storage(ze_rararch_object *object TSRMLS_DC);
#endif
/* }}} */
/* {{{ RarArchive handlers */
static int rararch_handlers_preamble(handler_this_t *object, rar_file_t **rar TSRMLS_DC);
static int rararch_dimensions_preamble(rar_file_t *rar, zval *offset, long *index, int quiet TSRMLS_DC);
static int rararch_count_elements(handler_this_t *object, long *count TSRMLS_DC);
#if PHP_MAJOR_VERSION < 7
static zval *rararch_read_dimension(zval *object, zval *offset, int type TSRMLS_DC);
#else
static zval *rararch_read_dimension(handler_this_t *object, zval *offset, int type, zval *rv);
#endif
static void rararch_write_dimension(handler_this_t *object, zval *offset, zval *value TSRMLS_DC);
static int rararch_has_dimension(handler_this_t *object, zval *offset, int check_empty TSRMLS_DC);
/* }}} */
/* {{{ Function definitions with external linkage */
int _rar_get_file_resource_zv(zval *zv, rar_file_t **rar_file TSRMLS_DC) /* {{{ */
{
return _rar_get_file_resource_ex(rar_obj_ref_fetch(zv),
rar_file, FALSE TSRMLS_CC);
}
int _rar_get_file_resource_zv_ex(zval *zv, rar_file_t **rar_file, int allow_closed TSRMLS_DC)
{
return _rar_get_file_resource_ex(rar_obj_ref_fetch(zv),
rar_file, allow_closed TSRMLS_CC);
}
/* }}} */
static int _rar_get_file_resource_handler(handler_this_t *thiz,
rar_file_t **rar_file TSRMLS_DC)
{
#if PHP_MAJOR_VERSION < 8
return _rar_get_file_resource_zv(thiz, rar_file TSRMLS_CC);
#else
return _rar_get_file_resource_ex(thiz, rar_file, FALSE);
#endif
}
/* Creates a RarArchive object, all three in args will be dupped */
int _rar_create_rararch_obj(const char* resolved_path,
const char* open_password,
zval *volume_callback, /* must be callable or NULL */
zval *object,
int *err_code TSRMLS_DC) /* {{{ */
{
rar_file_t *rar = NULL;
rar = emalloc(sizeof *rar);
rar->list_open_data = ecalloc(1, sizeof *rar->list_open_data);
rar->list_open_data->ArcName = estrdup(resolved_path);
rar->list_open_data->OpenMode = RAR_OM_LIST_INCSPLIT;
rar->list_open_data->CmtBuf = ecalloc(RAR_MAX_COMMENT_SIZE, 1);
rar->list_open_data->CmtBufSize = RAR_MAX_COMMENT_SIZE;
rar->extract_open_data = ecalloc(1, sizeof *rar->extract_open_data);
rar->extract_open_data->ArcName = estrdup(resolved_path);
rar->extract_open_data->OpenMode = RAR_OM_EXTRACT;
rar->extract_open_data->CmtBuf = NULL; /* not interested in it again */
rar->cb_userdata.password = NULL;
rar->cb_userdata.callable = NULL;
rar->entries = NULL;
rar->allow_broken = 0;
rar->arch_handle = RAROpenArchiveEx(rar->list_open_data);
if (rar->arch_handle != NULL && rar->list_open_data->OpenResult == 0) {
ze_rararch_object *zobj;
if (open_password != NULL) {
rar->cb_userdata.password = estrdup(open_password);
}
if (volume_callback != NULL) {
ZVAL_ALLOC_DUP(rar->cb_userdata.callable, volume_callback);
}
object_init_ex(object, rararch_ce_ptr);
zobj = rararch_object_from_zv(object TSRMLS_CC);
zobj->rar_file = rar;
rar->obj_ref = rar_obj_ref_fetch(object);
RARSetCallback(rar->arch_handle, _rar_unrar_callback,
(LPARAM) &rar->cb_userdata);
return SUCCESS;
} else {
*err_code = rar->list_open_data->OpenResult;
efree(rar->list_open_data->ArcName);
efree(rar->list_open_data->CmtBuf);
efree(rar->list_open_data);
efree(rar->extract_open_data->ArcName);
efree(rar->extract_open_data);
efree(rar);
return FAILURE;
}
}
/* }}} */
void _rar_close_file_resource(rar_file_t *rar) /* {{{ */
{
assert(rar->arch_handle != NULL);
/* When changed from resource to custom object, instead of fiddling
* with the refcount to force object destruction, an indication that
* the file is already closed is given by setting rar->arch_handle
* to NULL. This is checked by _rar_get_file_resource_zv. */
RARCloseArchive(rar->arch_handle);
rar->arch_handle = NULL;
}
/* }}} */
/* Receives archive zval, returns object struct.
* If allow_closed is FALSE, it checks whether the archive is alredy closed, and if it
* is, an exception/error is raised and FAILURE is returned
*/
int _rar_get_file_resource_ex(rar_obj_ref zobjref_file, rar_file_t **rar_file,
int allow_closed TSRMLS_DC) /* {{{ */
{
ze_rararch_object *zobj;
zobj = rararch_object_from_ref(zobjref_file);
if (zobj == NULL) {
php_error_docref(NULL TSRMLS_CC, E_WARNING,
"Could not find object in the store. This is a bug, please report it.");
return FAILURE;
}
*rar_file = zobj->rar_file;
if ((*rar_file)->arch_handle == NULL && !allow_closed) { /* rar_close was called */
_rar_handle_ext_error("The archive is already closed" TSRMLS_CC);
return FAILURE;
}
return SUCCESS;
}
/* }}} */
/* end functions with external linkage }}} */
/* {{{ Helper functions and preprocessor definitions */
/* target should be initialized */
static void _rar_raw_entries_to_array(rar_file_t *rar, zval *target TSRMLS_DC) /* {{{ */
{
rar_find_output *state;
zval rararch_obj;
/* make zval point to the RarArchive object */
rar_obj_ref_make_zv(rar->obj_ref, &rararch_obj TSRMLS_CC);
_rar_entry_search_start(rar, RAR_SEARCH_TRAVERSE, &state TSRMLS_CC);
do {
_rar_entry_search_advance(state, NULL, 0, 0);
if (state->found) {
zval *entry_obj;
MAKE_STD_ZVAL(entry_obj);
_rar_entry_to_zval(&rararch_obj, state->header, state->packed_size,
state->position, entry_obj TSRMLS_CC);
add_next_index_zval(target, entry_obj);
#if PHP_MAJOR_VERSION >= 7
/* PHP 7 copies the zval (but without increasing the refcount of the
* obj), while 5.x simply copies the pointer. Only for PHP 5.x do we
* keep the allocation) */
efree(entry_obj);
#endif
}
} while (state->eof == 0);
_rar_entry_search_end(state);
#if PHP_MAJOR_VERSION < 7
zval_dtor(&rararch_obj);
#else
zval_ptr_dtor(&rararch_obj);
#endif
}
/* }}} */
#if PHP_MAJOR_VERSION >=7
static inline rar_obj_ref rar_obj_ref_fetch(zval *zv)
{
return Z_OBJ(*zv);
}
static inline void rar_obj_ref_make_zv(rar_obj_ref zo, zval *zv TSRMLS_DC)
{
ZVAL_OBJ(zv, zo);
zval_addref_p(zv);
}
#else
inline rar_obj_ref rar_obj_ref_fetch(zval *zv)
{
return Z_OBJ_HANDLE_P(zv);
}
inline void rar_obj_ref_make_zv(rar_obj_ref zoh, zval *zv TSRMLS_DC)
{
INIT_ZVAL(*zv);
Z_TYPE_P(zv) = IS_OBJECT;
Z_OBJ_HANDLE_P(zv) = zoh;
Z_OBJ_HT_P(zv) = &rararch_object_handlers;
/* object has a new reference; if not incremented, the object would be
* be destroyed when this new zval we created was destroyed */
zend_objects_store_add_ref_by_handle(zoh TSRMLS_CC);
}
#endif
#if PHP_MAJOR_VERSION >=7
static inline ze_rararch_object *rararch_object_fetch(zend_object *zobj)
{
return (ze_rararch_object *)
((char *) zobj - XtOffsetOf(ze_rararch_object, parent));
}
static ze_rararch_object *rararch_object_from_zv(const zval *zv)
{
return rararch_object_fetch(Z_OBJ_P(zv));
}
static ze_rararch_object *rararch_object_from_ref(const rar_obj_ref ref)
{
return rararch_object_fetch(ref);
}
#endif
/* {{{ */
#if PHP_MAJOR_VERSION < 7
static zend_object_value rararch_ce_create_object(zend_class_entry *class_type TSRMLS_DC)
{
zend_object_value zov;
ze_rararch_object *zobj;
zobj = emalloc(sizeof *zobj);
/* rararch_ce_free_object_storage will attempt to access it otherwise */
zobj->rar_file = NULL;
zend_object_std_init((zend_object*) zobj, class_type TSRMLS_CC);
#if PHP_VERSION_ID < 50399
zend_hash_copy(((zend_object*)zobj)->properties,
&(class_type->default_properties),
(copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval*));
#else
object_properties_init((zend_object*)zobj, class_type);
#endif
zov.handle = zend_objects_store_put(zobj,
(zend_objects_store_dtor_t) zend_objects_destroy_object,
(zend_objects_free_object_storage_t) rararch_ce_free_object_storage,
NULL TSRMLS_CC);
zov.handlers = &rararch_object_handlers;
return zov;
}
#else
static zend_object *rararch_ce_create_object(zend_class_entry *ce)
{
ze_rararch_object *zobj =
emalloc(sizeof(*zobj) + zend_object_properties_size(ce));
zobj->rar_file = NULL;
zend_object_std_init(&zobj->parent, ce);
zobj->parent.handlers = &rararch_object_handlers;
return &zobj->parent;
}
#endif
/* }}} */
/* {{{ */
#if PHP_MAJOR_VERSION < 7
static void rararch_ce_free_object_storage(ze_rararch_object *object TSRMLS_DC)
{
#else
static void rararch_ce_free_object_storage(zend_object *zobj)
{
ze_rararch_object *object = rararch_object_fetch(zobj);
#endif
rar_file_t *rar = object->rar_file;
/* may be NULL if the user did new RarArchive() */
if (rar != NULL) {
if (rar->arch_handle != NULL) {
RARCloseArchive(rar->arch_handle);
}
_rar_destroy_userdata(&rar->cb_userdata);
_rar_delete_entries(rar TSRMLS_CC);
efree(rar->list_open_data->ArcName);
efree(rar->list_open_data->CmtBuf);
efree(rar->list_open_data);
efree(rar->extract_open_data->ArcName);
efree(rar->extract_open_data);
efree(rar);
}
/* could call zend_objects_free_object_storage here (not before!), but
* instead I'll mimic its behaviour */
zend_object_std_dtor(&object->parent TSRMLS_CC);
#if PHP_MAJOR_VERSION < 7
efree(object);
#endif
}
/* }}} */
/* }}} */
/* {{{ RarArchive handlers */
static int rararch_handlers_preamble(handler_this_t *object,
rar_file_t **rar TSRMLS_DC) /* {{{ */
{
/* don't call zend_objects_get_address or zend_object_store_get directly;
* _rar_get_file_resource_zv checks if the archive was closed */
if (_rar_get_file_resource_handler(object, rar TSRMLS_CC) == FAILURE) {
return FAILURE;
}
return _rar_handle_error(_rar_list_files(*rar TSRMLS_CC) TSRMLS_CC);
}
/* }}} */
#define RAR_DOCREF_IF_UNQUIET(...) \
if (!quiet) { php_error_docref(__VA_ARGS__); }
/* {{{ rararch_dimensions_preamble - semi-strict parsing of int argument */
static int rararch_dimensions_preamble(rar_file_t *rar,
zval *offset,
long *index,
int quiet TSRMLS_DC)
{
if (offset == NULL) {
RAR_DOCREF_IF_UNQUIET(NULL TSRMLS_CC, E_ERROR,
"Empty dimension syntax is not supported for RarArchive objects");
return FAILURE;
}
if (Z_TYPE_P(offset) == IS_LONG) {
*index = Z_LVAL_P(offset);
}
else if (Z_TYPE_P(offset) == IS_STRING) {
int type;
double d;
if ((type = is_numeric_string(Z_STRVAL_P(offset), Z_STRLEN_P(offset),
index, &d, -1)) == 0) {
RAR_DOCREF_IF_UNQUIET(NULL TSRMLS_CC, E_WARNING,
"Attempt to use a non-numeric dimension to access a "
"RarArchive object (invalid string)");
return FAILURE;
}
else if (type == IS_DOUBLE) {
if (d > (double) LONG_MAX || d < (double) LONG_MIN) {
RAR_DOCREF_IF_UNQUIET(NULL TSRMLS_CC, E_WARNING,
"Dimension index is out of integer bounds");
return FAILURE;
}
*index = (long) d;
}
}
else if (Z_TYPE_P(offset) == IS_DOUBLE) {
if (Z_DVAL_P(offset) > (double) LONG_MAX ||
Z_DVAL_P(offset) < (double) LONG_MIN) {
RAR_DOCREF_IF_UNQUIET(NULL TSRMLS_CC, E_WARNING,
"Dimension index is out of integer bounds");
return FAILURE;
}
*index = (long) Z_DVAL_P(offset);
}
else if (Z_TYPE_P(offset) == IS_OBJECT) {
#if PHP_MAJOR_VERSION < 8
if (Z_OBJ_HT_P(offset)->get) {
zval *newoffset = NULL;
int ret;
# if PHP_MAJOR_VERSION < 7
newoffset = Z_OBJ_HT_P(offset)->get(offset TSRMLS_CC);
# else
zval zv_holder;
ZVAL_NULL(&zv_holder);
newoffset = Z_OBJ_HT_P(offset)->get(offset, &zv_holder);
# endif
/* get handler cannot return NULL */
assert(newoffset != NULL);
if (Z_TYPE_P(newoffset) == IS_OBJECT) {
RAR_DOCREF_IF_UNQUIET(NULL TSRMLS_CC, E_WARNING,
"Could not convert object given as dimension index into "
"an integer (get handler returned another object)");
return FAILURE;
}
ret = rararch_dimensions_preamble(rar, newoffset, index, quiet
TSRMLS_CC);
# if PHP_MAJOR_VERSION < 7
zval_ptr_dtor(&newoffset);
# else
zval_ptr_dtor(newoffset);
# endif
return ret;
} else
#endif // PHP < 8
if (Z_OBJ_HT_P(offset)->cast_object) {
zval newoffset;
int res = Z_OBJ_HT_P(offset)->cast_object(
ZV_TO_THIS_FOR_HANDLER(offset), &newoffset, IS_LONG TSRMLS_CC);
if (res == FAILURE) {
RAR_DOCREF_IF_UNQUIET(NULL TSRMLS_CC, E_WARNING,
"Could not convert object given as dimension index into "
"an integer (cast_object failed)");
return FAILURE;
}
if (Z_TYPE(newoffset) != IS_LONG) {
zval_dtor(&newoffset);
RAR_DOCREF_IF_UNQUIET(NULL TSRMLS_CC, E_WARNING,
"Could not convert object given as dimension index into "
"an integer (cast_object did not return int as asked)");
return FAILURE;
}
*index = Z_LVAL(newoffset);
}
else {
RAR_DOCREF_IF_UNQUIET(NULL TSRMLS_CC, E_WARNING,
"Attempt to use an object with no get handler as a dimension "
"to access a RarArchive object");
return FAILURE;
}
}
else {
RAR_DOCREF_IF_UNQUIET(NULL TSRMLS_CC, E_WARNING,
"Attempt to use a non-numeric dimension to access a "
"RarArchive object (invalid type)");
return FAILURE;
}
if (*index < 0L) {
RAR_DOCREF_IF_UNQUIET(NULL TSRMLS_CC, E_WARNING,
"Dimension index must be non-negative, given %ld", *index);
return FAILURE;
}
if ((size_t) *index >= _rar_entry_count(rar)) {
RAR_DOCREF_IF_UNQUIET(NULL TSRMLS_CC, E_WARNING,
"Dimension index exceeds or equals number of entries in RAR "
"archive");
return FAILURE;
}
return SUCCESS;
}
/* }}} */
/* {{{ RarArchive count_elements handler */
static int rararch_count_elements(handler_this_t *object, long *count TSRMLS_DC)
{
rar_file_t *rar = NULL;
size_t entry_count;
if (rararch_handlers_preamble(object, &rar TSRMLS_CC) == FAILURE) {
*count = 0L;
return SUCCESS; /* intentional */
}
entry_count = _rar_entry_count(rar);
if (entry_count > LONG_MAX)
entry_count = (size_t) LONG_MAX;
*count = (long) entry_count;
return SUCCESS;
}
/* }}} */
/* {{{ RarArchive read_dimension handler */
#if PHP_MAJOR_VERSION < 7
static zval *rararch_read_dimension(zval *object, zval *offset, int type TSRMLS_DC)
#else
static zval *rararch_read_dimension(handler_this_t *object, zval *offset, int type, zval *rv)
#endif
{
long index;
rar_file_t *rar = NULL;
struct _rar_find_output *out;
zval *ret = NULL;
if (rararch_handlers_preamble(object, &rar TSRMLS_CC) == FAILURE) {
return NULL;
}
if (rararch_dimensions_preamble(rar, offset, &index, (type == BP_VAR_IS)
TSRMLS_CC) == FAILURE)
return NULL;
if (type == BP_VAR_RW || type == BP_VAR_W || type == BP_VAR_UNSET)
php_error_docref(NULL TSRMLS_CC, E_ERROR,
"A RarArchive object is not modifiable");
_rar_entry_search_start(rar, RAR_SEARCH_INDEX, &out TSRMLS_CC);
_rar_entry_search_seek(out, (size_t) index);
_rar_entry_search_advance(out, NULL, 0, 0);
assert(out->found);
#if PHP_MAJOR_VERSION < 7
ALLOC_INIT_ZVAL(ret);
#else
ret = rv;
#endif
#if PHP_MAJOR_VERSION >= 8
zval object_zv;
ZVAL_OBJ(&object_zv, object);
_rar_entry_to_zval(&object_zv, out->header, out->packed_size, out->position,
ret TSRMLS_CC);
#else
_rar_entry_to_zval(object, out->header, out->packed_size, out->position,
ret TSRMLS_CC);
#endif
_rar_entry_search_end(out);
#if PHP_MAJOR_VERSION < 7
Z_DELREF_P(ret); /* set refcount to 0 */
#endif
return ret;
}
/* }}} */
/* {{{ RarArchive write_dimension handler */
static void rararch_write_dimension(handler_this_t *object, zval *offset, zval *value TSRMLS_DC)
{
php_error_docref(NULL TSRMLS_CC, E_ERROR,
"A RarArchive object is not writable");
}
/* }}} */
/* {{{ RarArchive has_dimension handler */
static int rararch_has_dimension(handler_this_t *object, zval *offset, int check_empty TSRMLS_DC)
{
long index;
rar_file_t *rar = NULL;
(void) check_empty; /* don't care */
if (rararch_handlers_preamble(object, &rar TSRMLS_CC) == FAILURE) {
return 0;
}
return (rararch_dimensions_preamble(rar, offset, &index, 1 TSRMLS_CC) ==
SUCCESS);
}
/* }}} */
/* {{{ RarArchive unset_dimension handler */
static void rararch_unset_dimension(handler_this_t *object, zval *offset TSRMLS_DC)
{
php_error_docref(NULL TSRMLS_CC, E_ERROR,
"A RarArchive object is not writable");
}
/* }}} */
/* }}} */
/* module functions */
/* {{{ proto RarArchive rar_open(string filename [, string password = NULL
[, callback volume_cb = NULL ]])
Open RAR archive and return RarArchive object */
PHP_FUNCTION(rar_open)
{
char *filename;
char *password = NULL;
char resolved_path[MAXPATHLEN];
zpp_s_size_t filename_len,
password_len; /* both ignored */
zval *callable = NULL;
int err_code;
/* Files are only opened here and in _rar_find_file */
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|s!z!", &filename,
&filename_len, &password, &password_len, &callable) == FAILURE) {
return;
}
if (OPENBASEDIR_CHECKPATH(filename)) {
RETURN_FALSE;
}
if (!expand_filepath(filename, resolved_path TSRMLS_CC)) {
RETURN_FALSE;
}
assert(strnlen(resolved_path, MAXPATHLEN) < MAXPATHLEN);
if (callable != NULL) { /* given volume resolver callback */
#if PHP_MAJOR_VERSION == 5 && PHP_MINOR_VERSION == 2
if (!zend_is_callable(callable, IS_CALLABLE_STRICT, NULL)) {
#else
if (!zend_is_callable(callable, IS_CALLABLE_STRICT, NULL TSRMLS_CC)) {
#endif
_rar_handle_ext_error("%s" TSRMLS_CC, "Expected the third "
"argument, if provided, to be a valid callback");
RETURN_FALSE;
}
}
if (_rar_create_rararch_obj(resolved_path, password, callable,
return_value, &err_code TSRMLS_CC) == FAILURE) {
const char *err_str = _rar_error_to_string(err_code);
if (err_str == NULL)
_rar_handle_ext_error("%s" TSRMLS_CC, "Archive opened failed "
"(returned NULL handle), but did not return an error. "
"Should not happen.");
else {
char *preamble;
spprintf(&preamble, 0, "Failed to open %s: ", resolved_path);
_rar_handle_error_ex(preamble, err_code TSRMLS_CC);
efree(preamble);
}
RETURN_FALSE;
}
}
/* }}} */
/* {{{ proto array rar_list(RarArchive rarfile)
Return entries from the rar archive */
PHP_FUNCTION(rar_list)
{
zval *file = getThis();
rar_file_t *rar = NULL;
RAR_THIS_OR_NO_ARGS(file);
if (_rar_get_file_resource_zv(file, &rar TSRMLS_CC) == FAILURE) {
RETURN_FALSE;
}
if (_rar_handle_error(_rar_list_files(rar TSRMLS_CC) TSRMLS_CC) == FAILURE)
RETURN_FALSE;
array_init(return_value);
_rar_raw_entries_to_array(rar, return_value TSRMLS_CC);
}
/* }}} */
/* {{{ proto object rar_entry_get(RarArchive rarfile, string filename)
Return entry from the rar archive */
PHP_FUNCTION(rar_entry_get)
{
zval *file = getThis();
char *filename;
rar_file_t *rar = NULL;
zpp_s_size_t filename_len;
wchar_t *filename_c = NULL;
rar_find_output *sstate;
if (file == NULL) {
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "Os",
&file, rararch_ce_ptr, &filename, &filename_len) == FAILURE) {
return;
}
}
else if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s",
&filename, &filename_len) == FAILURE) {
return;
}
if (_rar_get_file_resource_zv(file, &rar TSRMLS_CC) == FAILURE) {
RETURN_FALSE;
}
if (_rar_handle_error(_rar_list_files(rar TSRMLS_CC) TSRMLS_CC) == FAILURE)
RETURN_FALSE;
filename_c = ecalloc(filename_len + 1, sizeof *filename_c);
_rar_utf_to_wide(filename, filename_c, filename_len + 1);
_rar_entry_search_start(rar, RAR_SEARCH_NAME, &sstate TSRMLS_CC);
_rar_entry_search_advance(sstate, filename_c, 0, 0);
if (sstate->found) {
_rar_entry_to_zval(file, sstate->header, sstate->packed_size,
sstate->position, return_value TSRMLS_CC);
}
else {
_rar_handle_ext_error(
"cannot find file \"%s\" in Rar archive \"%s\""
TSRMLS_CC, filename, rar->list_open_data->ArcName);
RETVAL_FALSE;
}
_rar_entry_search_end(sstate);
efree(filename_c);
}
/* }}} */
/* {{{ proto string rar_solid_is(RarArchive rarfile)
Return whether RAR archive is solid */
PHP_FUNCTION(rar_solid_is)
{
zval *file = getThis();
rar_file_t *rar = NULL;
RAR_THIS_OR_NO_ARGS(file);
if (_rar_get_file_resource_zv(file, &rar TSRMLS_CC) == FAILURE) {
RETURN_FALSE;
}
RETURN_BOOL((rar->list_open_data->Flags & 0x0008) != 0);
}
/* }}} */
/* {{{ proto string rar_comment_get(RarArchive rarfile)
Return comment of the rar archive */
PHP_FUNCTION(rar_comment_get)
{
zval *file = getThis();
rar_file_t *rar = NULL;
unsigned cmt_state;
RAR_THIS_OR_NO_ARGS(file);
if (_rar_get_file_resource_zv(file, &rar TSRMLS_CC) == FAILURE) {
RETURN_FALSE;
}
cmt_state = rar->list_open_data->CmtState;
if (_rar_handle_error(cmt_state TSRMLS_CC) == FAILURE)
RETURN_FALSE;
if (cmt_state == 0) /* comment not present */
RETURN_NULL();
if (cmt_state == 1) { /* comment read completely */
/* CmtSize - 1 because we don't need the null terminator */
RAR_RETURN_STRINGL(rar->list_open_data->CmtBuf,
rar->list_open_data->CmtSize - 1, 1);
}
}
/* }}} */
/* {{{ proto bool rar_is_broken(RarArchive rarfile)
Check whether a RAR archive is broken */
PHP_FUNCTION(rar_broken_is)
{
zval *file = getThis();
rar_file_t *rar = NULL;
int result,
orig_allow_broken;
RAR_THIS_OR_NO_ARGS(file);
if (_rar_get_file_resource_zv(file, &rar TSRMLS_CC) == FAILURE) {
RETURN_FALSE;
}
orig_allow_broken = rar->allow_broken;
rar->allow_broken = 0; /* with 1 we'd always get success from list_files */
result = _rar_list_files(rar TSRMLS_CC);
rar->allow_broken = orig_allow_broken;
RETURN_BOOL(_rar_error_to_string(result) != NULL);
}
/* {{{ proto bool rar_allow_broken_set(RarArchive rarfile, bool allow_broken)
Whether to allow entry retrieval of broken RAR archives */
PHP_FUNCTION(rar_allow_broken_set)
{
zval *file = getThis();
rar_file_t *rar = NULL;
zend_bool allow_broken;
if (file == NULL) {
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "Ob",
&file, rararch_ce_ptr, &allow_broken) == FAILURE) {
return;
}
}
else if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "b",
&allow_broken) == FAILURE) {
return;
}
if (_rar_get_file_resource_zv(file, &rar TSRMLS_CC) == FAILURE) {
RETURN_FALSE;
}
rar->allow_broken = (int) allow_broken;
RETURN_TRUE;
}
/* {{{ proto bool rar_close(RarArchive rarfile)
Close Rar archive and free all resources */
PHP_FUNCTION(rar_close)
{
zval *file = getThis();
rar_file_t *rar = NULL;
RAR_THIS_OR_NO_ARGS(file);
if (_rar_get_file_resource_zv(file, &rar TSRMLS_CC) == FAILURE) {
RETURN_FALSE;
}
_rar_close_file_resource(rar);
RETURN_TRUE;
}
/* }}} */
/* {{{ proto string RarEntry::__toString()
Return string representation for entry */
PHP_METHOD(rararch, __toString)
{
zval *arch_obj = getThis();
rar_file_t *rar = NULL;
const char format[] = "RAR Archive \"%s\"%s",
closed[] = " (closed)";
char *restring;
size_t restring_size;
int is_closed;
RAR_RETNULL_ON_ARGS();
if (_rar_get_file_resource_zv_ex(arch_obj, &rar, TRUE TSRMLS_CC)
== FAILURE) {
RETURN_FALSE; /* should never happen */
}
is_closed = (rar->arch_handle == NULL);
/* 2 is size of %s, 1 is terminating 0 */
restring_size = (sizeof(format) - 1) - 2 * 2 + 1;
restring_size += strlen(rar->list_open_data->ArcName);
if (is_closed)
restring_size += sizeof(closed) - 1;
restring = emalloc(restring_size);
snprintf(restring, restring_size, format, rar->list_open_data->ArcName,
is_closed?closed:"");
restring[restring_size - 1] = '\0'; /* just to be safe */
RAR_RETURN_STRINGL(restring, (int) restring_size - 1, 0);
}
/* }}} */
/* {{{ proto string RarEntry::getIterator() */
#if PHP_MAJOR_VERSION >= 8
PHP_METHOD(rararch, getIterator)
{
if (zend_parse_parameters_none() == FAILURE) {
return;
}
zend_create_internal_iterator_zval(return_value, getThis());
}
#endif
/* }}} */
/* {{{ arginfo */
ZEND_BEGIN_ARG_INFO_EX(arginfo_rararchive_open, 0, 0, 1)
ZEND_ARG_INFO(0, filename)
ZEND_ARG_INFO(0, password)
ZEND_ARG_INFO(0, volume_callback)
ZEND_END_ARG_INFO()
ZEND_BEGIN_ARG_INFO_EX(arginfo_rararchive_getentry, 0, 0, 1)
ZEND_ARG_INFO(0, filename)
ZEND_END_ARG_INFO()
ZEND_BEGIN_ARG_INFO_EX(arginfo_rararchive_setallowbroken, 0, 0, 1)
ZEND_ARG_INFO(0, allow_broken)
ZEND_END_ARG_INFO()
#if PHP_MAJOR_VERSION >= 8
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_rararchive_getiterator, 0, 0, Traversable, 0)
ZEND_END_ARG_INFO()
#endif
ZEND_BEGIN_ARG_INFO(arginfo_rararchive_void, 0)
ZEND_END_ARG_INFO()
/* }}} */
static zend_function_entry php_rararch_class_functions[] = {
PHP_ME_MAPPING(open, rar_open, arginfo_rararchive_open, ZEND_ACC_STATIC | ZEND_ACC_PUBLIC)
PHP_ME_MAPPING(getEntries, rar_list, arginfo_rararchive_void, ZEND_ACC_PUBLIC)
PHP_ME_MAPPING(getEntry, rar_entry_get, arginfo_rararchive_getentry, ZEND_ACC_PUBLIC)
#ifdef RAR_ARCHIVE_LIST_ALIAS
PHP_ME_MAPPING(list, rar_list, arginfo_rararchive_void, ZEND_ACC_PUBLIC | ZEND_ACC_DEPRECATED)
#endif
PHP_ME_MAPPING(isSolid, rar_solid_is, arginfo_rararchive_void, ZEND_ACC_PUBLIC)
PHP_ME_MAPPING(getComment, rar_comment_get, arginfo_rararchive_void, ZEND_ACC_PUBLIC)
PHP_ME_MAPPING(isBroken, rar_broken_is, arginfo_rararchive_void, ZEND_ACC_PUBLIC)
PHP_ME_MAPPING(setAllowBroken, rar_allow_broken_set, arginfo_rararchive_setallowbroken, ZEND_ACC_PUBLIC)
PHP_ME_MAPPING(close, rar_close, arginfo_rararchive_void, ZEND_ACC_PUBLIC)
PHP_ME(rararch, __toString, arginfo_rararchive_void, ZEND_ACC_PUBLIC)
PHP_ME_MAPPING(__construct, rar_bogus_ctor, arginfo_rararchive_void, ZEND_ACC_PRIVATE | ZEND_ACC_CTOR)
#if PHP_MAJOR_VERSION >= 8
PHP_ME(rararch, getIterator, arginfo_rararchive_getiterator, ZEND_ACC_PUBLIC)
#endif
{NULL, NULL, NULL}
};
/* {{{ Iteration. Very boring stuff indeed. */
/* {{{ Iteration Prototypes */
static zend_object_iterator *rararch_it_get_iterator(zend_class_entry *ce,
zval *object,
int by_ref TSRMLS_DC);