-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathphp-bencode.php
More file actions
470 lines (422 loc) · 8.8 KB
/
php-bencode.php
File metadata and controls
470 lines (422 loc) · 8.8 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
<?php
/**
* Created by PhpStorm.
* User: frederick
* Date: 9/22/15
* Time: 1:09 AM
*/
/**
* Class BItem
*
* The base class of all other types.
* Actually, only parse(), load() and save() are useful at PHP level
*/
class BItem
{
/**
* @return string "BItem" is always returned
*/
function getType()
{
}
/**
* @param string $ben The string to parse
* @return BDict|BList|BStr|BInt
*/
static function parse($ben)
{
}
/**
* @param string $file The path of the file to be decoded
* @return BDict|BList|BStr|BInt
*/
static function load($file)
{
}
/**
* @param string $file The path of the file to save the encoded content into
*/
function save($file)
{
}
}
/**
* Class BDict
*
* Dictionary of Bencode.
* The key of a BDict is always BStr while value could be BDict, BList, BStr or BInt.
* This is handled by std::map in C++
*/
class BDict extends BItem
{
/**
* @return string "BDict" is always returned
*/
function getType()
{
}
/**
* @param string $key The path of the object to set
* @param BDict|BList|BStr|BInt $value The object
*
* the path is a series of slash split keys
* for example,
* set('key1/0', new BInt(1))
* will do
* (BDict)[ "key1"(BStr) => (BList)[ 0 => THE_NEW_VALUE ] ]
* and if you want to use a slash in key, use
* \/
* instead, this could be sometimes confusing, pay attention to it
*
* what's more, if any parent of the object in the given path does not exist,
* it will be automatically created
* the type of the created parent determines on the format of the key
* for example,
* (BDict)[ ]
* key1/0', new BInt(1))
* ⟱
* (BDict)[ "key1"(BStr) => (BList)[ 0 => 0(BInt) ] ]
*
* (BDict)[ ]
* ⟱
* set('key1/index0', new BInt(1))
* ⟱
* (BDict)[ "key1"(BStr) => (BDict)[ "index0"(BStr) => 0(BInt) ] ]
* so be careful if you want a BDict whose keys are integer-only strings
*/
function set($key, $value)
{
}
/**
* @param string $key The path of the object to get
* @return BDict|BList|BStr|BInt|null $value The object
*
* notice that this function returns a copy rather than a reference
* so something like
* BDict BList BInt
* $dict->get('key1')->set('0', new BInt(1))
* may not work as expected
* you should use
* $dict->set('key1/0', new BInt(1))
* instead
*/
function get($key)
{
}
/**
* @param string $key The path of the object to check
* @return bool
* @see BDict::get()
*/
function has($key)
{
}
/**
* @param string $key The path of the object to delete
* @return bool Deleted, true; not found, false
* @see BDict::get()
*/
function del($key)
{
}
/**
* @return array[string] Return all keys
*/
function getKeys()
{
}
/**
* @return int Return the length of encoded content
*/
function length()
{
}
/**
* @return int Return the number of elements
*/
function size()
{
}
/**
* @return array Return the array without meta
*
* convert the Bencode to a simple PHP array
* notice that it may cause data loss,
* so DO NOT use this function if you're not pretty sure about the content
*
* @see BDict::toMetaArray()
*/
function toArray()
{
}
/**
* @return array Return the meta array
*
* in a meta array, each single element will be described as a array
* for example,
* BInt(10) will be
* [ '_type' => 'BInt', '_length' => 4, '_data' => 10 ]
* BDict will be
* [ '_type' => 'BDict', '_length' => ..., '_size' => ..., '_data' => [ 'key1' => ..., 'key2' => ..., ... ] ]
* this is very useful when the Bencode contains empty BDict or BList,
* with out the _type the only way to distinguish them is to call getType()
*/
function toMetaArray()
{
}
/**
* @param string $needle The string or integer to search
* @param string $mode k[ey], s[tring] or i[nt]
* @return array The result array containing a series of paths
*/
function search($needle, $mode)
{
}
/**
* @return string The encoded content
*
* this magic method will be called implicitly when being converted to string
*/
function __toString()
{
}
/**
* PHP constructor
*/
function __construct()
{
}
/**
* PHP destructor
*/
function __destruct()
{
}
}
/**
* Class BList
*
* List of Bencode
* This is handled by std::vector in C++
*/
class BList extends BItem
{
/**
* @return string "BList" is always returned
*/
function getType()
{
}
/**
* @param string $key The path of the object to set
* @param BDict|BList|BStr|BInt $value The object
* @see BDict::set()
*
* something different is that if the key of a BList is larger than the size of it,
* the value will be simply pushed to the end of the BList
*
* use integer-only-keyed BDict if you need dispersed integers as keys,
* although they will be implemented as strings
*/
function set($key, $value)
{
}
/**
* @param string $key The path of the object to get
* @return BDict|BList|BStr|BInt|null $value The object
* @see BDict::get()
*/
function get($key)
{
}
/**
* @param string $key The path of the object to check
* @return bool
* @see BDict::has()
*/
function has($key)
{
}
/**
* @param string $key The path of the object to delete
* @return bool Deleted, true; not found, false
* @see BDict::del()
*/
function del($key)
{
}
/**
* @return int Return the length of encoded content
*/
function length()
{
}
/**
* @return int Return the number of elements
*/
function size()
{
}
/**
* @return array Return the array without meta
* @see BDict::toArray()
*/
function toArray()
{
}
/**
* @return array Return the meta array
* @see BDict::toMetaArray()
*/
function toMetaArray()
{
}
/**
* @param string $needle The string or integer to search
* @param string $mode k[ey], s[tring] or i[nt]
* @return array The result array containing a series of paths
*/
function search($needle, $mode)
{
}
/**
* @return string The encoded content
*
* this magic method will be called implicitly when being converted to string
*/
function __toString()
{
}
/**
* PHP constructor
*/
function __construct()
{
}
/**
* PHP destructor
*/
function __destruct()
{
}
}
/**
* Class BStr
*
* String of Bencode.
*/
class BStr extends BItem
{
/**
* @return string "BStr" is always returned
*/
function getType()
{
}
/**
* @return string
*/
function get()
{
}
/**
* @param string $value
*/
function set($value)
{
}
/**
* @return int
*/
function length()
{
}
/**
* @return string This will simply return the contained value
*
* this is somehow useless to PHP developers
* it will be called mostly when recursively converting a BDict or BList to array
*/
function toArray()
{
}
/**
* @return array
* @see BDict::toMetaArray()
*/
function toMetaArray()
{
}
/**
* @return string
*/
function __toString()
{
}
/**
* @param string|null $value
*/
function __construct($value)
{
}
}
/**
* Class BInt
*
* Integer of Bencode.
*/
class BInt extends BItem
{
/**
* @return string "BInt" is always returned
*/
function getType()
{
}
/**
* @return int
*/
function get()
{
}
/**
* @param int $value
*/
function set($value)
{
}
/**
* @return int
*/
function length()
{
}
/**
* @return int This will simply return the contained value
*
* this is somehow useless to PHP developers
* it will be called mostly when recursively converting a BDict or BList to array
*/
function toArray()
{
}
/**
* @return array
* @see BDict::toMetaArray()
*/
function toMetaArray()
{
}
/**
* @return string
*/
function __toString()
{
}
/**
* @param int|null $value
*/
function __construct($value)
{
}
}