-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathclass.FastDFS.php
More file actions
919 lines (848 loc) · 47.6 KB
/
class.FastDFS.php
File metadata and controls
919 lines (848 loc) · 47.6 KB
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
<?php
/**
* FastDFS client Class
* @author Rebill.Ruan
*/
class FastDFS
{
/**
* FastDFS class constructor
*
* @param int $config_index use which config file, base 0. default is 0
* @param bool $bMultiThread if in multi-thread, default is false
*/
public function __construct($config_index = 0, $bMultiThread = false){}
/**
* get a connected tracker server
* return array for success, false for error
* the assoc array including elements: ip_addr, port and sock
*
* @return array|bool
*/
public function tracker_get_connection(){}
/**
* connect to all tracker servers
* return true for success, false for error
*
* @return bool
*/
public function tracker_make_all_connections(){}
/**
* close all connections to the tracker servers
* return true for success, false for error
*
* @return bool
*/
public function tracker_close_all_connections(){}
/**
* send ACTIVE_TEST cmd to the server
* return true for success, false for error
*
* @param array $server_info the assoc array including elements: ip_addr, port and sock, sock must be connected
* @return bool
*/
public function active_test(array $server_info){}
/**
* connect to the server
* return array for success, false for error
*
* @param string $ip_addr the ip address of the server
* @param int $port the port of the server
* @return array|bool
*/
public function connect_server($ip_addr, $port){}
/**
* disconnect from the server
* return true for success, false for error
*
* @param array $server_info the assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function disconnect_server(array $server_info){}
/**
* get group stat info
* return index array for success, false for error, each group as a array element
*
* @param string $group_name the group name of the master file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function tracker_list_groups($group_name='', $tracker_server=array()){}
/**
* get the storage server info to upload file
* return assoc array for success, false for error. the assoc array including elements: ip_addr, port, sock and store_path_index
*
* @param string $group_name the group name of the master file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function tracker_query_storage_store($group_name='', $tracker_server=array()){}
/**
* get the storage server list to upload file
* return indexed storage server array for success, false for error.
* each element is an ssoc array including elements: ip_addr, port, sock and store_path_index
*
* @param string $group_name the group name of the master file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function tracker_query_storage_store_list($group_name='', $tracker_server=array()){}
/**
* get the storage server info to set metadata
* return assoc array for success, false for error
* the assoc array including elements: ip_addr, port and sock
*
* @param string $group_name the group name of the master file
* @param string $remote_filename the filename on the storage server
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function tracker_query_storage_update($group_name, $remote_filename, $tracker_server=array()){}
/**
* get the storage server info to download file (or get metadata)
* return assoc array for success, false for error
* the assoc array including elements: ip_addr, port and sock
*
* @param string $group_name the group name of the master file
* @param string $remote_filename the filename on the storage server
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function tracker_query_storage_fetch($group_name, $remote_filename, $tracker_server=array()){}
/**
* get the storage server list which can retrieve the file content or metadata
* return index array for success, false for error.
* each server as an array element
*
* @param string $group_name the group name of the master file
* @param string $remote_filename the filename on the storage server
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function tracker_query_storage_list($group_name, $remote_filename, $tracker_server=array()){}
/**
* get the storage server info to set metadata
* return assoc array for success, false for error
* the assoc array including elements: ip_addr, port and sock
*
* @param string $file_id the file id of the file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function tracker_query_storage_update1($file_id, $tracker_server=array()){}
/**
* get the storage server info to download file (or get metadata)
* return assoc array for success, false for error
* the assoc array including elements: ip_addr, port and sock
*
* @param string $file_id the file id of the file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function tracker_query_storage_fetch1($file_id, $tracker_server=array()){}
/**
* get the storage server list which can retrieve the file content or metadata
* return index array for success, false for error.
* each server as an array element
*
* @param string $file_id
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function tracker_query_storage_list1($file_id, $tracker_server=array()){}
/**
* delete the storage server from the cluster
* return true for success, false for error
*
* @param string $group_name the group name of the master file
* @param string $storage_ip the ip address of the storage server to be deleted
* @return bool
*/
public function tracker_delete_storage($group_name, $storage_ip){}
/**
* upload local file to storage server
* return assoc array for success, false for error.
* the returned array includes elements: group_name and filename
*
* @param string $local_filename the local filename
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param string $group_name specify the group name to store the file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function storage_upload_by_filename($local_filename, $file_ext_name='', $meta_list=array(), $group_name='', $tracker_server=array(), $storage_server=array()){}
/**
* upload local file to storage server
* return file_id for success, false for error
*
* @param string $local_filename the local filename
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param string $group_name specify the group name to store the file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return string|bool
*/
public function storage_upload_by_filename1($local_filename, $file_ext_name='', $meta_list=array(), $group_name='', $tracker_server=array(), $storage_server=array()){}
/**
* upload file buff to storage server
* return array for success, false for error
*
* @param string $file_buff the file content
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param string $group_name specify the group name to store the file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function storage_upload_by_filebuff($file_buff, $file_ext_name='', $meta_list=array(), $group_name='', $tracker_server=array(), $storage_server=array()){}
/**
* upload file buff to storage server
* return file_id for success, false for error
*
* @param string $file_buff the file content
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param string $group_name specify the group name to store the file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return string|bool
*/
public function storage_upload_by_filebuff1($file_buff, $file_ext_name='', $meta_list=array(), $group_name='', $tracker_server=array(), $storage_server=array()){}
/**
* upload file to storage server by callback
* return assoc array for success, false for error.
* the returned array includes elements: group_name and filename
*
* @param array $callback_array the callback assoc array, must have keys:
* callback - the php callback function name callback function prototype as: function upload_file_callback($sock, $args)
* file_size - the file size
* args - use argument for callback function
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param string $group_name specify the group name to store the file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function storage_upload_by_callback(array $callback_array, $file_ext_name='', $meta_list=array(), $group_name='', $tracker_server=array(), $storage_server=array()){}
/**
* upload file to storage server by callback
* return file_id for success, false for error
*
* @param array $callback_array the callback assoc array, must have keys:
* callback - the php callback function name callback function prototype as: function upload_file_callback($sock, $args)
* file_size - the file size
* args - use argument for callback function
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param string $group_name specify the group name to store the file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return string|bool
*/
public function storage_upload_by_callback1(array $callback_array, $file_ext_name='', $meta_list=array(), $group_name='', $tracker_server=array(), $storage_server=array()){}
/**
* append local file to the appender file of storage server
* return string/array for success, false for error
*
* @param string $local_filename the local filename
* @param string $group_name the the group name of appender file
* @param string $appender_filename the appender filename
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return mixed
*/
public function storage_append_by_filename($local_filename, $group_name, $appender_filename, $tracker_server=array(), $storage_server=array()){}
/**
* append local file to the appender file of storage server
* return file_id for success, false for error
*
* @param string $local_filename the local filename
* @param string $appender_file_id the appender file id
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return string|bool
*/
public function storage_append_by_filename1($local_filename, $appender_file_id, $tracker_server=array(), $storage_server=array()){}
/**
* append file buff to the appender file of storage server
* return array for success, false for error
*
* @param string $file_buff the file content
* @param string $group_name the the group name of appender file
* @param string $appender_filename the appender filename
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function storage_append_by_filebuff($file_buff, $group_name, $appender_filename, $tracker_server=array(), $storage_server=array()){}
/**
* append file buff to the appender file of storage server
* return file_id for success, false for error
*
* @param string $file_buff the file content
* @param string $appender_file_id the appender file id
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return string|bool
*/
public function storage_append_by_filebuff1($file_buff, $appender_file_id, $tracker_server=array(), $storage_server=array()){}
/**
* append file to the appender file of storage server by callback
* return array for success, false for error
*
* @param array $callback_array the callback assoc array, must have keys:
* callback - the php callback function name callback function prototype as: function upload_file_callback($sock, $args)
* file_size - the file size
* args - use argument for callback function
* @param string $group_name the the group name of appender file
* @param string $appender_filename the appender filename
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function storage_append_by_callback(array $callback_array, $group_name, $appender_filename, $tracker_server=array(), $storage_server=array()){}
/**
* append file buff to the appender file of storage server
* return file_id for success, false for error
*
* @param array $callback_array the callback assoc array, must have keys:
* callback - the php callback function name callback function prototype as: function upload_file_callback($sock, $args)
* file_size - the file size
* args - use argument for callback function
* @param string $appender_file_id the appender file id
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return string|bool
*/
public function storage_append_by_callback1(array $callback_array, $appender_file_id, $tracker_server=array(), $storage_server=array()){}
/**
* modify appender file by local file
* return true for success, false for error
*
* @param string $local_filename the local filename
* @param string $group_name the the group name of appender file
* @param string $appender_filename the appender filename
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_modify_by_filename($local_filename, $group_name, $appender_filename, $tracker_server=array(), $storage_server=array()){}
/**
* modify appender file by local file
* return true for success, false for error
*
* @param string $local_filename the local filename
* @param string $appender_file_id the appender file id
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_modify_by_filename1($local_filename, $appender_file_id, $tracker_server=array(), $storage_server=array()){}
/**
* modify appender file by file buff
* return true for success, false for error
*
* @param string $file_buff the file content
* @param string $group_name the the group name of appender file
* @param string $appender_filename the appender filename
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_modify_by_filebuff($file_buff, $group_name, $appender_filename, $tracker_server=array(), $storage_server=array()){}
/**
* modify appender file by file buff
* return true for success, false for error
*
* @param string $file_buff the file content
* @param string $appender_file_id the appender file id
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_modify_by_filebuff1($file_buff, $appender_file_id, $tracker_server=array(), $storage_server=array()){}
/**
* modify appender file by callback
* return true for success, false for error
*
* @param array $callback_array the callback assoc array, must have keys:
* callback - the php callback function name callback function prototype as: function upload_file_callback($sock, $args)
* file_size - the file size
* args - use argument for callback function
* @param string $group_name the the group name of appender file
* @param string $appender_filename the appender filename
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_modify_by_callback(array $callback_array, $group_name, $appender_filename, $tracker_server=array(), $storage_server=array()){}
/**
* modify appender file by callback
* return true for success, false for error
*
* @param array $callback_array the callback assoc array, must have keys:
* callback - the php callback function name callback function prototype as: function upload_file_callback($sock, $args)
* file_size - the file size
* args - use argument for callback function
* @param string $appender_file_id the appender file id
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_modify_by_callback1(array $callback_array, $appender_file_id, $tracker_server=array(), $storage_server=array()){}
/**
* upload local file to storage server as appender file
* return assoc array for success, false for error.
* the returned array includes elements: group_name and filename
*
* @param string $local_filename the local filename
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param string $group_name specify the group name to store the file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function storage_upload_appender_by_filename($local_filename, $file_ext_name='', $meta_list=array(), $group_name='', $tracker_server=array(), $storage_server=array()){}
/**
* upload local file to storage server as appender file
* return file_id for success, false for error
*
* @param string $local_filename the local filename
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param string $group_name specify the group name to store the file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return string|bool
*/
public function storage_upload_appender_by_filename1($local_filename, $file_ext_name='', $meta_list=array(), $group_name='', $tracker_server=array(), $storage_server=array()){}
/**
* upload file buff to storage server as appender file
* return assoc array for success, false for error.
* the returned array includes elements: group_name and filename
*
* @param string $file_buff the file content
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param string $group_name specify the group name to store the file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function storage_upload_appender_by_filebuff($file_buff, $file_ext_name='', $meta_list=array(), $group_name='', $tracker_server=array(), $storage_server=array()){}
/**
* upload file buff to storage server as appender file
* return file_id for success, false for error
*
* @param string $file_buff the file content
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param string $group_name specify the group name to store the file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return string|bool
*/
public function storage_upload_appender_by_filebuff1($file_buff, $file_ext_name='', $meta_list=array(), $group_name='', $tracker_server=array(), $storage_server=array()){}
/**
* upload file to storage server by callback as appender file
* return assoc array for success, false for error.
* the returned array includes elements: group_name and filename
*
* @param array $callback_array the callback assoc array, must have keys:
* callback - the php callback function name callback function prototype as: function upload_file_callback($sock, $args)
* file_size - the file size
* args - use argument for callback function
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param string $group_name specify the group name to store the file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function storage_upload_appender_by_callback(array $callback_array, $file_ext_name='', $meta_list=array(), $group_name='', $tracker_server=array(), $storage_server=array()){}
/**
* upload file to storage server by callback as appender file
* return file_id for success, false for error
*
* @param array $callback_array the callback assoc array, must have keys:
* callback - the php callback function name callback function prototype as: function upload_file_callback($sock, $args)
* file_size - the file size
* args - use argument for callback function
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param string $group_name specify the group name to store the file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return string|bool
*/
public function storage_upload_appender_by_callback1(array $callback_array, $file_ext_name='', $meta_list=array(), $group_name='', $tracker_server=array(), $storage_server=array()){}
/**
* upload local file to storage server (slave file mode)
* return array for success, false for error
*
* @param string $local_filename the local filename
* @param string $group_name the group name of the master file
* @param string $master_filename the master filename to generate the slave file id
* @param string $prefix_name the prefix name to generate the slave file id
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function storage_upload_slave_by_filename($local_filename, $group_name, $master_filename, $prefix_name, $file_ext_name='', $meta_list=array(), $tracker_server=array(), $storage_server=array()){}
/**
* upload local file to storage server (slave file mode)
* return file_id for success, false for error
*
* @param string $local_filename the local filename
* @param string $master_file_id the master file id to generate the slave file id
* @param string $prefix_name the prefix name to generate the slave file id
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return string|bool
*/
public function storage_upload_slave_by_filename1($local_filename, $master_file_id, $prefix_name, $file_ext_name='', $meta_list=array(), $tracker_server=array(), $storage_server=array()){}
/**
* upload file buff to storage server (slave file mode)
* return array for success, false for error
*
* @param string $file_buff the file content
* @param string $group_name the group name of the master file
* @param string $master_filename the master filename to generate the slave file id
* @param string $prefix_name the prefix name to generate the slave file id
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function storage_upload_slave_by_filebuff($file_buff, $group_name, $master_filename, $prefix_name, $file_ext_name='', $meta_list=array(), $tracker_server=array(), $storage_server=array()){}
/**
* upload file buff to storage server (slave file mode)
* return file_id for success, false for error
*
* @param string $file_buff the file content
* @param string $master_file_id the master file id to generate the slave file id
* @param string $prefix_name the prefix name to generate the slave file id
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return string|bool
*/
public function storage_upload_slave_by_filebuff1($file_buff, $master_file_id, $prefix_name, $file_ext_name='', $meta_list=array(), $tracker_server=array(), $storage_server=array()){}
/**
* upload file to storage server by callback (slave file mode)
* return array for success, false for error
* the returned array includes elements: group_name and filename
*
* @param array $callback_array the callback assoc array, must have keys:
* callback - the php callback function name callback function prototype as: function upload_file_callback($sock, $args)
* file_size - the file size
* args - use argument for callback function
* @param string $group_name the group name of the master file
* @param string $master_filename the master filename to generate the slave file id
* @param string $prefix_name the prefix name to generate the slave file id
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function storage_upload_slave_by_callback(array $callback_array, $group_name, $master_filename, $prefix_name, $file_ext_name='', $meta_list=array(), $tracker_server=array(), $storage_server=array()){}
/**
* upload file to storage server by callback (slave file mode)
* return file_id for success, false for error
*
* @param array $callback_array the callback assoc array, must have keys:
* callback - the php callback function name callback function prototype as: function upload_file_callback($sock, $args)
* file_size - the file size
* args - use argument for callback function
* @param string $master_file_id the master file id to generate the slave file id
* @param string $prefix_name the prefix name to generate the slave file id
* @param string $file_ext_name the file extension name, do not include dot(.)
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return string|bool
*/
public function storage_upload_slave_by_callback1(array $callback_array, $master_file_id, $prefix_name, $file_ext_name='', $meta_list=array(), $tracker_server=array(), $storage_server=array()){}
/**
* delete file from storage server
* return true for success, false for error
*
* @param string $group_name the group name of the master file
* @param string $remote_filename the filename on the storage server
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_delete_file($group_name, $remote_filename, $tracker_server=array(), $storage_server=array()){}
/**
* delete file from storage server
* return true for success, false for error
*
* @param string $file_id the file id to be deleted
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_delete_file1($file_id, $tracker_server=array(), $storage_server=array()){}
/**
* truncate appender file to specify size
* return true for success, false for error
*
* @param string $group_name the the group name of appender file
* @param string $remote_filename the filename on the storage server
* @param string $truncated_file_size truncate the file size to
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_truncate_file($group_name, $remote_filename, $truncated_file_size='', $tracker_server=array(), $storage_server=array()){}
/**
* truncate appender file to specify size
* return true for success, false for error
*
* @param string $file_id the appender file id
* @param string $truncated_file_size truncate the file size to
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_truncate_file1($file_id, $truncated_file_size='', $tracker_server=array(), $storage_server=array()){}
/**
* get file content from storage server
* return file content for success, false for error
*
* @param string $group_name the group name of the master file
* @param string $remote_filename the filename on the storage server
* @param int $file_offset file start offset, default value is 0
* @param int $download_bytes 0 (default value) means from the file offset to the file end
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return string|bool
*/
public function storage_download_file_to_buff($group_name, $remote_filename, $file_offset=0, $download_bytes=0, $tracker_server=array(), $storage_server=array()){}
/**
* get file content from storage server
* return file content for success, false for error
*
* @param string $file_id the file id of the file
* @param int $file_offset file start offset, default value is 0
* @param int $download_bytes 0 (default value) means from the file offset to the file end
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return string|bool
*/
public function storage_download_file_to_buff1($file_id, $file_offset=0, $download_bytes=0, $tracker_server=array(), $storage_server=array()){}
/**
* download file from storage server to local file
* return true for success, false for error
*
* @param string $group_name the group name of the master file
* @param string $remote_filename the filename on the storage server
* @param string $local_filename the local filename to save the file content
* @param int $file_offset file start offset, default value is 0
* @param int $download_bytes 0 (default value) means from the file offset to the file end
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_download_file_to_file($group_name, $remote_filename, $local_filename, $file_offset=0, $download_bytes=0, $tracker_server=array(), $storage_server=array()){}
/**
* download file from storage server to local file
* return true for success, false for error
*
* @param string $file_id the file id of the file
* @param string $local_filename the local filename to save the file content
* @param int $file_offset file start offset, default value is 0
* @param int $download_bytes 0 (default value) means from the file offset to the file end
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_download_file_to_file1($file_id, $local_filename, $file_offset=0, $download_bytes=0, $tracker_server=array(), $storage_server=array()){}
/**
* return true for success, false for error
*
* @param string $group_name the group name of the master file
* @param string $remote_filename the filename on the storage server
* @param array $download_callback the download callback array, elements as:
* callback - the php callback function name callback function prototype as: function my_download_file_callback($args, $file_size, $data)
* args - use argument for callback function
* @param int $file_offset file start offset, default value is 0
* @param int $download_bytes 0 (default value) means from the file offset to the file end
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_download_file_to_callback($group_name, $remote_filename, array $download_callback, $file_offset=0, $download_bytes=0, $tracker_server=array(), $storage_server=array()){}
/**
* return true for success, false for error
*
* @param string $file_id the file id of the file
* @param array $download_callback the download callback array, elements as:
* callback - the php callback function name callback function prototype as: function my_download_file_callback($args, $file_size, $data)
* args - use argument for callback function
* @param int $file_offset file start offset, default value is 0
* @param int $download_bytes 0 (default value) means from the file offset to the file end
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_download_file_to_callback1($file_id, array $download_callback, $file_offset=0, $download_bytes=0, $tracker_server=array(), $storage_server=array()){}
/**
* set meta data of the file
* return true for success, false for error
*
* @param string $group_name the group name of the master file
* @param string $remote_filename the filename on the storage server
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param string $op_type operate flag, can be one of following flags:
* FDFS_STORAGE_SET_METADATA_FLAG_MERGE: combined with the old meta data
* FDFS_STORAGE_SET_METADATA_FLAG_OVERWRITE: overwrite the old meta data
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_set_metadata($group_name, $remote_filename, array $meta_list, $op_type='', $tracker_server=array(), $storage_server=array()){}
/**
* set meta data of the file
* return true for success, false for error
*
* @param string $file_id the file id of the file
* @param array $meta_list meta data assoc array, such as array('width'=>1024, 'height'=>768)
* @param string $op_type operate flag, can be one of following flags:
* FDFS_STORAGE_SET_METADATA_FLAG_MERGE: combined with the old meta data
* FDFS_STORAGE_SET_METADATA_FLAG_OVERWRITE: overwrite the old meta data
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_set_metadata1($file_id, array $meta_list, $op_type='', $tracker_server=array(), $storage_server=array()){}
/**
* get meta data of the file
* return array for success, false for error
* returned array like: array('width' => 1024, 'height' => 768)
*
* @param string $group_name the group name of the master file
* @param string $remote_filename the filename on the storage server
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function storage_get_metadata($group_name, $remote_filename, $tracker_server=array(), $storage_server=array()){}
/**
* get meta data of the file
* return array for success, false for error
* returned array like: array('width' => 1024, 'height' => 768)
*
* @param string $file_id the file id of the file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return array|bool
*/
public function storage_get_metadata1($file_id, $tracker_server=array(), $storage_server=array()){}
/**
* check file exist
* return true for exist, false for not exist
*
* @param string $group_name the group name of the file
* @param string $remote_filename the filename on the storage server
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_file_exist($group_name, $remote_filename, $tracker_server=array(), $storage_server=array()){}
/**
* check file exist
* return true for exist, false for not exist
*
* @param string $file_id the file id of the file
* @param array $tracker_server the tracker server assoc array including elements: ip_addr, port and sock
* @param array $storage_server the storage server assoc array including elements: ip_addr, port and sock
* @return bool
*/
public function storage_file_exist1($file_id, $tracker_server=array(), $storage_server=array()){}
/**
* return last error no
*
* @return int
*/
public function get_last_error_no(){}
/**
* return last error info
*
* @return string
*/
public function get_last_error_info(){}
/**
* generate anti-steal token for HTTP download
* return token string for success, false for error
*
* @param string $file_id the file id of the file
* @param int $timestamp the timestamp (unix timestamp)
* @return string|bool
*/
public function http_gen_token($file_id, $timestamp){}
/**
* get file info from the filename
* return assoc array for success, false for error.
* the assoc array including following elements:
* create_timestamp: the file create timestamp (unix timestamp)
* file_size: the file size (bytes)
* source_ip_addr: the source storage server ip address
* crc32: the crc32 signature of the file
*
* @param string $group_name the group name of the file
* @param string $remote_filename the filename on the storage server
* @return array|bool
*/
public function get_file_info($group_name, $remote_filename){}
/**
* get file info from the file id
* return assoc array for success, false for error.
* the assoc array including following elements:
* create_timestamp: the file create timestamp (unix timestamp)
* file_size: the file size (bytes)
* source_ip_addr: the source storage server ip address
*
* @param string $file_id the file id (including group name and filename) or remote filename
* @return array|bool
*/
public function get_file_info1($file_id){}
/**
* return true for success, false for error
*
* @param int $sock the unix socket description
* @param string $buff the buff to send
* @return bool
*/
public function send_data($sock, $buff){}
/**
* generate slave filename by master filename, prefix name and file extension name
* return slave filename string for success, false for error
*
* @param string $master_filename the master filename / file id to generate the slave filename
* @param string $prefix_name the prefix name to generate the slave filename
* @param string $file_ext_name slave file extension name, can be null or empty (do not including dot)
* @return string|bool
*/
public function gen_slave_filename($master_filename, $prefix_name, $file_ext_name=''){}
/**
* close tracker connections
*
* @return void
*/
public function close(){}
}