-
Notifications
You must be signed in to change notification settings - Fork 78
/
Client.php
1305 lines (1158 loc) · 45.5 KB
/
Client.php
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
namespace Dropbox;
/**
* The class used to make most Dropbox API calls. You can use this once you've gotten an
* {@link AccessToken} via {@link WebAuth}.
*
* This class is stateless so it can be shared/reused.
*/
final class Client
{
/**
* The config used when making requests to the Dropbox server.
*
* @return Config
*/
function getConfig() { return $this->config; }
/** @var Config */
private $config;
/**
* The access token used by this client to make authenticated API calls. You can get an
* access token via {@link WebAuth}.
*
* @return AccessToken
*/
function getAccessToken() { return $this->accessToken; }
/** @var AccessToken */
private $accessToken;
/**
* Constructor.
*
* <code>
* use \Dropbox as dbx;
* $config = new Config(...);
* list($accessToken, $dropboxUserId) = $webAuth->finish(...);
* $client = new dbx\Client($config, $accessToken);
* </code>
*
* @param Config $config
* See {@link getConfig()}
* @param AccessToken $accessToken
* See {@link getAccessToken()}
*/
function __construct($config, $accessToken)
{
Config::checkArg("config", $config);
AccessToken::checkArg("accessToken", $accessToken);
$this->config = $config;
$this->accessToken = $accessToken;
// These fields are redundant, but it makes these values a little more convenient
// to access.
$this->apiHost = $config->getAppInfo()->getHost()->getApi();
$this->contentHost = $config->getAppInfo()->getHost()->getContent();
$this->root = $config->getAppInfo()->getAccessType()->getUrlPart();
}
/** @var string */
private $apiHost;
/** @var string */
private $contentHost;
/** @var string */
private $root;
private function appendFilePath($base, $path)
{
return $base . "/" . $this->root . "/" . rawurlencode(substr($path, 1));
}
/**
* Returns a basic account and quota information.
*
* <code>
* $client = ...
* $accountInfo = $client->getAccountInfo();
* print_r($accountInfo);
* </code>
*
* @return array
* See <a href="https://www.dropbox.com/developers/core/api#account-info">/account/info</a>.
*
* @throws Exception
*/
function getAccountInfo()
{
$response = $this->doGet($this->apiHost, "1/account/info");
if ($response->statusCode !== 200) throw RequestUtil::unexpectedStatus($response);
return RequestUtil::parseResponseJson($response->body);
}
/**
* Downloads a file from Dropbox. The file's contents are written to the
* given <code>$outStream</code> and the file's metadata is returned.
*
* <code>
* $client = ...;
* $metadata = $client->getFile("/Photos/Frog.jpeg",
* fopen("./Frog.jpeg", "wb"));
* print_r($metadata);
* </code>
*
* @param string $path
* The path to the file on Dropbox (UTF-8).
*
* @param resource $outStream
* If the file exists, the file contents will be written to this stream.
*
* @param string|null $rev
* If you want the latest revision of the file at the given path, pass in <code>null</code>.
* If you want a specific version of a file, pass in value of the file metadata's "rev" field.
*
* @return null|array
* The <a href="https://www.dropbox.com/developers/core/api#metadata-details">metadata
* object</a> for the file at the given $path and $rev, or <code>null</code> if the file
* doesn't exist,
*
* @throws Exception
*/
function getFile($path, $outStream, $rev = null)
{
Path::checkArgNonRoot("path", $path);
Checker::argResource("outStream", $outStream);
Checker::argStringNonEmptyOrNull("rev", $rev);
$url = RequestUtil::buildUrl(
$this->config,
$this->contentHost,
$this->appendFilePath("1/files", $path),
array("rev" => $rev));
$curl = self::mkCurl($url);
$metadataCatcher = new DropboxMetadataHeaderCatcher($curl->handle);
$streamRelay = new CurlStreamRelay($curl->handle, $outStream);
$response = $curl->exec();
if ($response->statusCode === 404) return null;
if ($response->statusCode !== 200) {
$response->body = $streamRelay->getErrorBody();
throw RequestUtil::unexpectedStatus($response);
}
return $metadataCatcher->getMetadata();
}
/**
* Calling 'uploadFile' with <code>$numBytes</code> less than this value, will cause this SDK
* to use the standard /files_put endpoint. When <code>$numBytes</code> is greater than this
* value, we'll use the /chunked_upload endpoint.
*
* @var int
*/
private static $AUTO_CHUNKED_UPLOAD_THRESHOLD = 9863168; // 8 MB
/**
* @var int
*/
private static $DEFAULT_CHUNK_SIZE = 4194304; // 4 MB
/**
* Creates a file on Dropbox, using the data from <code>$inStream</code> for the file contents.
*
* <code>
* use \Dropbox as dbx;
* $client = ...;
* $md1 = $client->uploadFile("/Photos/Frog.jpeg",
* dbx\WriteMode::add(),
* fopen("./frog.jpeg", "rb"));
* print_r($md1);
*
* // Re-upload with WriteMode::update(...), which will overwrite the
* // file if it hasn't been modified from our original upload.
* $md2 = $client->uploadFile("/Photos/Frog.jpeg",
* dbx\WriteMode::update($md1["rev"]),
* fopen("./frog-new.jpeg", "rb"));
* print_r($md2);
* </code>
*
* @param string $path
* The Dropbox path to save the file to (UTF-8).
*
* @param WriteMode $writeMode
* What to do if there's already a file at the given path.
*
* @param resource $inStream
*
* @param int|null $numBytes
* You can pass in <code>null</code> if you don't know. If you do provide the size, we can
* perform a slightly more efficient upload (fewer network round-trips) for files smaller
* than 8 MB.
*
* @return mixed
* The <a href="https://www.dropbox.com/developers/core/api#metadata-details>metadata
* object</a> for the newly-added file.
*
* @throws Exception
*/
function uploadFile($path, $writeMode, $inStream, $numBytes = null)
{
try {
Path::checkArgNonRoot("path", $path);
WriteMode::checkArg("writeMode", $writeMode);
Checker::argResource("inStream", $inStream);
Checker::argNatOrNull("numBytes", $numBytes);
// If we don't know how many bytes are coming, we have to use chunked upload.
// If $numBytes is large, we elect to use chunked upload.
// In all other cases, use regular upload.
if ($numBytes === null || $numBytes > self::$AUTO_CHUNKED_UPLOAD_THRESHOLD) {
$metadata = $this->_uploadFileChunked($path, $writeMode, $inStream, $numBytes,
self::$DEFAULT_CHUNK_SIZE);
} else {
$metadata = $this->_uploadFile($path, $writeMode,
function(Curl $curl) use ($inStream, $numBytes) {
$curl->set(CURLOPT_PUT, true);
$curl->set(CURLOPT_INFILE, $inStream);
$curl->set(CURLOPT_INFILESIZE, $numBytes);
});
}
}
catch (\Exception $ex) {
fclose($inStream);
throw $ex;
}
fclose($inStream);
return $metadata;
}
/**
* Creates a file on Dropbox, using the given $data string as the file contents.
*
* <code>
* use \Dropbox as dbx;
* $client = ...;
* $md = $client->uploadFile("/Grocery List.txt",
* dbx\WriteMode::add(),
* "1. Coke\n2. Popcorn\n3. Toothpaste\n");
* print_r($md);
* </code>
*
* @param string $path
* The Dropbox path to save the file to (UTF-8).
*
* @param WriteMode $writeMode
* What to do if there's already a file at the given path.
*
* @param string $data
* The data to use for the contents of the file.
*
* @return mixed
* The <a href="https://www.dropbox.com/developers/core/api#metadata-details>metadata
* object</a> for the newly-added file.
*
* @throws Exception
*/
function uploadFileFromString($path, $writeMode, $data)
{
Path::checkArgNonRoot("path", $path);
WriteMode::checkArg("writeMode", $writeMode);
Checker::argString("data", $data);
return $this->_uploadFile($path, $writeMode, function(Curl $curl) use ($data) {
$curl->set(CURLOPT_CUSTOMREQUEST, "PUT");
$curl->set(CURLOPT_POSTFIELDS, $data);
$curl->addHeader("Content-Type: application/octet-stream");
});
}
/**
* Creates a file on Dropbox, using the data from $inStream as the file contents.
*
* This version of <code>uploadFile</code> splits uploads the file ~4MB chunks at a time and
* will retry a few times if one chunk fails to upload. Uses {@link chunkedUploadStart()},
* {@link chunkedUploadContinue()}, and {@link chunkedUploadFinish()}.
*
* @param string $path
* The Dropbox path to save the file to (UTF-8).
*
* @param WriteMode $writeMode
* What to do if there's already a file at the given path.
*
* @param resource $inStream
*
* @param int|null $numBytes
* The number of bytes available from $inStream.
* You can pass in <code>null</code> if you don't know.
*
* @param int|null $chunkSize
* The number of bytes to upload in each chunk. You can omit this (or pass in
* <code>null</code> and the library will use a reasonable default.
*
* @return mixed
* The <a href="https://www.dropbox.com/developers/core/api#metadata-details>metadata
* object</a> for the newly-added file.
*
* @throws Exception
*/
function uploadFileChunked($path, $writeMode, $inStream, $numBytes = null, $chunkSize = null)
{
try {
if ($chunkSize === null) {
$chunkSize = self::$DEFAULT_CHUNK_SIZE;
}
Path::checkArgNonRoot("path", $path);
WriteMode::checkArg("writeMode", $writeMode);
Checker::argResource("inStream", $inStream);
Checker::argNatOrNull("numBytes", $numBytes);
Checker::argIntPositive("chunkSize", $chunkSize);
$metadata = $this->_uploadFileChunked($path, $writeMode, $inStream, $numBytes,
$chunkSize);
}
catch (\Exception $ex) {
fclose($inStream);
throw $ex;
}
fclose($inStream);
return $metadata;
}
/**
* @param string $path
*
* @param WriteMode $writeMode
* What to do if there's already a file at the given path (UTF-8).
*
* @param resource $inStream
* The source of data to upload.
*
* @param int|null $numBytes
* You can pass in <code>null</code>. But if you know how many bytes you expect, pass in
* that value and this function will do a sanity check at the end to make sure the number of
* bytes read from $inStream matches up.
*
* @param int $chunkSize
*
* @return array
* The <a href="https://www.dropbox.com/developers/core/api#metadata-details>metadata
* object</a> for the newly-added file.
*/
private function _uploadFileChunked($path, $writeMode, $inStream, $numBytes, $chunkSize)
{
Path::checkArg("path", $path);
WriteMode::checkArg("writeMode", $writeMode);
Checker::argResource("inStream", $inStream);
Checker::argNatOrNull("numBytes", $numBytes);
Checker::argNat("chunkSize", $chunkSize);
// NOTE: This function performs 3 retries on every call. This is maybe not the right
// layer to make retry decisions. It's also awkward because none of the other calls
// perform retries.
assert($chunkSize > 0);
$data = fread($inStream, $chunkSize);
$len = strlen($data);
$client = $this;
$uploadId = RequestUtil::runWithRetry(3, function() use ($data, $client) {
return $client->chunkedUploadStart($data);
});
$byteOffset = $len;
while (!feof($inStream)) {
$data = fread($inStream, $chunkSize);
$len = strlen($data);
while (true) {
$r = RequestUtil::runWithRetry(3,
function() use ($client, $uploadId, $byteOffset, $data) {
return $client->chunkedUploadContinue($uploadId, $byteOffset, $data);
});
if ($r === true) { // Chunk got uploaded!
$byteOffset += $len;
break;
}
if ($r === false) { // Server didn't recognize our upload ID
// This is very unlikely since we're uploading all the chunks in sequence.
throw new Exception_BadResponse("Server forgot our uploadId");
}
// Otherwise, the server is at a different byte offset from us.
$serverByteOffset = $r;
assert($serverByteOffset !== $byteOffset); // chunkedUploadContinue ensures this.
// An earlier byte offset means the server has lost data we sent earlier.
if ($r < $byteOffset) throw new Exception_BadResponse(
"Server is at an ealier byte offset: us=$byteOffset, server=$serverByteOffset");
// The normal case is that the server is a bit further along than us because of a
// partially-uploaded chunk.
$diff = $serverByteOffset - $byteOffset;
if ($diff > $len) throw new Exception_BadResponse(
"Server is more than a chunk ahead: us=$byteOffset, server=$serverByteOffset");
// Finish the rest of this chunk.
$byteOffset += $diff;
$data = substr($data, $diff);
}
}
if ($numBytes !== null && $byteOffset !== $numBytes) throw new \InvalidArgumentException(
"You passed numBytes=$numBytes but the stream had $byteOffset bytes.");
$metadata = RequestUtil::runWithRetry(3,
function() use ($client, $uploadId, $path, $writeMode) {
return $client->chunkedUploadFinish($uploadId, $path, $writeMode);
});
return $metadata;
}
/**
* @param string $path
* @param WriteMode $writeMode
* @param callable $curlConfigClosure
* @return array
*/
private function _uploadFile($path, $writeMode, $curlConfigClosure)
{
Path::checkArg("path", $path);
WriteMode::checkArg("writeMode", $writeMode);
Checker::argCallable("curlConfigClosure", $curlConfigClosure);
$url = RequestUtil::buildUrl(
$this->config,
$this->contentHost,
$this->appendFilePath("1/files_put", $path),
$writeMode->getExtraParams());
$curl = $this->mkCurl($url);
$curlConfigClosure($curl);
$curl->set(CURLOPT_RETURNTRANSFER, true);
$response = $curl->exec();
if ($response->statusCode !== 200) throw RequestUtil::unexpectedStatus($response);
return RequestUtil::parseResponseJson($response->body);
}
/**
* Start a new chunked upload session and upload the first chunk of data.
*
* @param string $data
* The data to start off the chunked upload session.
*
* @return array
* A pair of <code>(string $uploadId, int $byteOffset)</code>. <code>$uploadId</code>
* is a unique identifier for this chunked upload session. You pass this in to
* {@link chunkedUploadContinue} and {@link chuunkedUploadFinish}. <code>$byteOffset</code>
* is the number of bytes that were successfully uploaded.
*
* @throws Exception
*/
function chunkedUploadStart($data)
{
Checker::argString("data", $data);
$response = $this->_chunkedUpload(array(), $data);
if ($response->statusCode === 404) {
throw new Exception_BadResponse("Got a 404, but we didn't send up an 'upload_id'");
}
$correction = self::_chunkedUploadCheckForOffsetCorrection($response);
if ($correction !== null) throw new Exception_BadResponse(
"Got an offset-correcting 400 response, but we didn't send an offset");
if ($response->statusCode !== 200) throw RequestUtil::unexpectedStatus($response);
list($uploadId, $byteOffset) = self::_chunkedUploadParse200Response($response->body);
$len = strlen($data);
if ($byteOffset !== $len) throw new Exception_BadResponse(
"We sent $len bytes, but server returned an offset of $byteOffset");
return $uploadId;
}
/**
* Append another chunk data to a previously-started chunked upload session.
*
* @param string $uploadId
* The unique identifier for the chunked upload session. This is obtained via
* {@link chunkedUploadStart}.
*
* @param int $byteOffset
* The number of bytes you think you've already uploaded to the given chunked upload
* session. The server will append the new chunk of data after that point.
*
* @param string $data
* The data to append to the existing chunked upload session.
*
* @return int|bool
* If <code>false</code>, it means the server didn't know about the given
* <code>$uploadId</code>. This may be because the chunked upload session has expired
* (they last around 24 hours).
* If <code>true</code>, the chunk was successfully uploaded. If an integer, it means
* you and the server don't agree on the current <code>$byteOffset</code>. The returned
* integer is the server's internal byte offset for the chunked upload session. You need
* to adjust your input to match.
*
* @throws Exception
*/
function chunkedUploadContinue($uploadId, $byteOffset, $data)
{
Checker::argStringNonEmpty("uploadId", $uploadId);
Checker::argNat("byteOffset", $byteOffset);
Checker::argString("data", $data);
$response = $this->_chunkedUpload(
array("upload_id" => $uploadId, "offset" => $byteOffset), $data);
if ($response->statusCode === 404) {
// The server doesn't know our upload ID. Maybe it expired?
return false;
}
$correction = self::_chunkedUploadCheckForOffsetCorrection($response);
if ($correction !== null) {
list($correctedUploadId, $correctedByteOffset) = $correction;
if ($correctedUploadId !== $uploadId) throw new Exception_BadResponse(
"Corrective 400 upload_id mismatch: us=".
self::q($uploadId)." server=".self::q($correctedUploadId));
if ($correctedByteOffset === $byteOffset) throw new Exception_BadResponse(
"Corrective 400 offset is the same as ours: $byteOffset");
return $correctedByteOffset;
}
if ($response->statusCode !== 200) throw RequestUtil::unexpectedStatus($response);
list($retUploadId, $retByteOffset) = self::_chunkedUploadParse200Response($response->body);
$nextByteOffset = $byteOffset + strlen($data);
if ($uploadId !== $retUploadId) throw new Exception_BadResponse(
"upload_id mismatch: us=".self::q($uploadId).", server=".self::q($uploadId));
if ($nextByteOffset !== $retByteOffset) throw new Exception_BadResponse(
"next-offset mismatch: us=$nextByteOffset, server=$retByteOffset");
return true;
}
/**
* @param string $body
* @return array
*/
private static function _chunkedUploadParse200Response($body)
{
$j = RequestUtil::parseResponseJson($body);
$uploadId = self::getField($j, "upload_id");
$byteOffset = self::getField($j, "offset");
return array($uploadId, $byteOffset);
}
/**
* @param HttpResponse $response
* @return array|null
*/
private static function _chunkedUploadCheckForOffsetCorrection($response)
{
if ($response->statusCode !== 400) return null;
$j = json_decode($response->body, true);
if ($j === null) return null;
if (!array_key_exists("upload_id", $j) || !array_key_exists("offset", $j)) return null;
$uploadId = $j["upload_id"];
$byteOffset = $j["offset"];
return array($uploadId, $byteOffset);
}
/**
* Creates a file on Dropbox using the accumulated contents of the given chunked upload session.
*
* @param string $uploadId
* The unique identifier for the chunked upload session. This is obtained via
* {@link chunkedUploadStart}.
*
* @param string $path
* The Dropbox path to save the file to ($path).
*
* @param WriteMode $writeMode
* What to do if there's already a file at the given path.
*
* @return array|null
* If <code>null</code>, it means the Dropbox server wasn't aware of the
* <code>$uploadId</code> you gave it.
* Otherwise, you get back the
* <a href="https://www.dropbox.com/developers/core/api#metadata-details>metadata object</a>
* for the newly-created file.
*
* @throws Exception
*/
function chunkedUploadFinish($uploadId, $path, $writeMode)
{
Checker::argStringNonEmpty("uploadId", $uploadId);
Path::checkArgNonRoot("path", $path);
WriteMode::checkArg("writeMode", $writeMode);
$params = array_merge(array("upload_id" => $uploadId), $writeMode->getExtraParams());
$response = $this->doPost(
$this->contentHost,
$this->appendFilePath("1/commit_chunked_upload", $path),
$params);
if ($response->statusCode === 404) return null;
if ($response->statusCode !== 200) throw RequestUtil::unexpectedStatus($response);
return RequestUtil::parseResponseJson($response->body);
}
/**
* @param array $params
* @param string $data
* @return HttpResponse
*/
private function _chunkedUpload($params, $data)
{
$url = RequestUtil::buildUrl(
$this->config, $this->contentHost, "1/chunked_upload", $params);
$curl = $this->mkCurl($url);
// We can't use CURLOPT_PUT because it wants a stream, but we already have $data in memory.
$curl->set(CURLOPT_CUSTOMREQUEST, "PUT");
$curl->set(CURLOPT_POSTFIELDS, $data);
$curl->addHeader("Content-Type: application/octet-stream");
$curl->set(CURLOPT_RETURNTRANSFER, true);
return $curl->exec();
}
/**
* Returns the metadata for whatever file or folder is at the given path.
*
* <code>
* $client = ...;
* $md = $client->getMetadata("/Photos/Frog.jpeg");
* print_r($md);
* </code>
*
* @param string $path
* The Dropbox path to a file or folder (UTF-8).
*
* @return array|null
* If there is a file or folder at the given path, you'll get back the
* <a href="https://www.dropbox.com/developers/core/api#metadata-details>metadata object</a>
* for that file or folder. If not, you'll get back <code>null</code>.
*
* @throws Exception
*/
function getMetadata($path)
{
Path::checkArg("path", $path);
return $this->_getMetadata($path, array("list" => "false"));
}
/**
* Returns the metadata for whatever file or folder is at the given path and, if it's a folder,
* also include the metadata for all the immediate children of that folder.
*
* <code>
* $client = ...;
* $md = $client->getMetadataWithChildren("/Photos");
* print_r($md);
* </code>
*
* @param string $path
* The Dropbox path to a file or folder (UTF-8).
*
* @return array|null
* If there is a file or folder at the given path, you'll get back the
* <a href="https://www.dropbox.com/developers/core/api#metadata-details>metadata object</a>
* for that file or folder, along with all immediate children if it's a folder. If not,
* you'll get back <code>null</code>.
*
* @throws Exception
*/
function getMetadataWithChildren($path)
{
Path::checkArg("path", $path);
return $this->_getMetadata($path, array("list" => "true", "file_limit" => "25000"));
}
/**
* @param string $path
* @param array $params
* @return array
*/
private function _getMetadata($path, $params)
{
$response = $this->doGet(
$this->apiHost,
$this->appendFilePath("1/metadata", $path),
$params);
if ($response->statusCode === 404) return null;
if ($response->statusCode !== 200) throw RequestUtil::unexpectedStatus($response);
$metadata = RequestUtil::parseResponseJson($response->body);
if (array_key_exists("is_deleted", $metadata) && $metadata["is_deleted"]) return null;
return $metadata;
}
/**
* If you've previously retrieved the metadata for a folder and its children, this method will
* retrieve updated metadata only if something has changed. This is more efficient than
* calling {@link getMetadataWithChildren} if you have a cache of previous results.
*
* <code>
* $client = ...;
* $md = $client->getMetadataWithChildren("/Photos");
* print_r($md);
* assert($md["is_dir"], "expecting \"/Photos\" to be a folder");
*
* sleep(10);
*
* // Now see if anything changed...
* list($changed, $new_md) = $client->getMetadataWithChildrenIfChanged(
* "/Photos", $md["hash"]);
* if ($changed) {
* echo "Folder changed.\n";
* print_r($new_md);
* } else {
* echo "Folder didn't change.\n";
* }
* </code>
*
* @param string $path
* The Dropbox path to a folder (UTF-8).
*
* @param string $previousFolderHash
* The "hash" field from the previously retrieved folder metadata.
*
* @return array
* A <code>list(boolean $changed, array $metadata)</code>. If the metadata hasn't changed,
* you'll get <code>list(false, null)</code>. If the metadata of the folder or any of its
* children has changed, you'll get <code>list(true, $newMetadata)</code>. $metadata is a
* <a href="https://www.dropbox.com/developers/core/api#metadata-details>metadata object</a>.
*
* @throws Exception
*/
function getMetadataWithChildrenIfChanged($path, $previousFolderHash)
{
Path::checkArg("path", $path);
Checker::argStringNonEmpty("previousFolderHash", $previousFolderHash);
$params = array("list" => "true", "limit" => "25000", "hash" => $previousFolderHash);
$response = $this->doGet(
$this->apiHost, "1/metadata",
$this->appendFilePath("1/metadata", $path),
$params);
if ($response->statusCode === 304) return array(false, null);
if ($response->statusCode === 404) return array(true, null);
if ($response->statusCode !== 404) throw RequestUtil::unexpectedStatus($response);
$metadata = RequestUtil::parseResponseJson($response->body);
if (array_key_exists("is_deleted", $metadata) && $metadata["is_deleted"]) {
return array(true, null);
}
return array(true, $metadata);
}
/**
* A way of letting you keep up with changes to files and folders in a user's Dropbox.
*
* @param string|null $cursor
* If this is the first time you're calling this, pass in <code>null</code>. Otherwise,
* pass in whatever cursor was returned by the previous call.
*
* @return array
* A <a href="https://www.dropbox.com/developers/core/api#delta">delta page</a>, which
* contains a list of changes to apply along with a new "cursor" that should be passed into
* future <code>getDelta</code> calls. If the "reset" field is <code>true</code>, you
* should clear your local state before applying the changes. If the "has_more" field is
* <code>true</code>, call <code>getDelta</code> immediately to get more results, otherwise
* wait a while (at least 5 minutes) before calling <code>getDelta</code> again.
*
* @throws Exception
*/
function getDelta($cursor = null)
{
Checker::argStringNonEmptyOrNull("cursor", $cursor);
$response = $this->doPost($this->apiHost, "1/delta", array("cursor" => $cursor));
if ($response->statusCode !== 200) throw RequestUtil::unexpectedStatus($response);
return RequestUtil::parseResponseJson($response->body);
}
/**
* Gets the metadata for all the file revisions (up to a limit) for a given path.
*
* See <a href="https://www.dropbox.com/developers/core/api#revisions">/revisions</a>.
*
* @param string path
* The Dropbox path that you want file revision metadata for (UTF-8).
*
* @param int|null limit
* The maximum number of revisions to return.
*
* @return array|null
* A list of <a href="https://www.dropbox.com/developers/core/api#metadata-details>metadata
* objects</a>, one for each file revision. The later revisions appear first in the list.
* If <code>null</code>, then there were too many revisions at that path.
*
* @throws Exception
*/
function getRevisions($path, $limit = null)
{
Path::checkArgNonRoot("path", $path);
Checker::argIntPositiveOrNull("limit", $limit);
$response = $this->doGet(
$this->apiHost,
$this->appendFilePath("1/revisions", $path),
array("rev_limit" => $limit));
if ($response->statusCode === 406) return null;
if ($response->statusCode !== 200) throw RequestUtil::unexpectedStatus($response);
return RequestUtil::parseResponseJson($response->body);
}
/**
* Takes a copy of the file at the given revision and saves it over the current copy. This
* will create a new revision, but the file contents will match the revision you specified.
*
* See <a href="https://www.dropbox.com/developers/core/api#restore">/restore</a>.
*
* @param string $path
* The Dropbox path of the file to restore (UTF-8).
*
* @param string $rev
* The revision to restore the contents to.
*
* @return mixed
* The <a href="https://www.dropbox.com/developers/core/api#metadata-details">metadata
* object</a>
*
* @throws Exception
*/
function restoreFile($path, $rev)
{
Path::checkArgNonRoot("path", $path);
Checker::argStringNonEmpty("rev", $rev);
$response = $this->doPost(
$this->apiHost,
$this->appendFilePath("1/restore", $path),
array("rev" => $rev));
if ($response->statusCode === 404) return null;
if ($response->statusCode !== 200) throw RequestUtil::unexpectedStatus($response);
return RequestUtil::parseResponseJson($response->body);
}
/**
* Returns metadata for all files and folders whose filename matches the query string.
*
* @param string $basePath
* The path to limit the search to (UTF-8). Pass in "/" to search everything.
*
* @param string $query
* A space-separated list of substrings to search for. A file matches only if it contains
* all the substrings.
*
* @param int|null $limit
* The maximum number of results to return.
*
* @param bool $includeDeleted
* Whether to include deleted files in the results.
*
* @return mixed
* A list of <a href="https://www.dropbox.com/developers/core/api#metadata-details>metadata
* objects</a> of files that match the search query.
*
* @throws Exception
*/
function searchFileNames($basePath, $query, $limit = null, $includeDeleted = false)
{
Path::checkArg("basePath", $basePath);
Checker::argStringNonEmpty("query", $query);
Checker::argNatOrNull("limit", $limit);
Checker::argBool("includeDeleted", $includeDeleted);
$response = $this->doPost(
$this->apiHost,
$this->appendFilePath("1/search", $basePath),
array(
"query" => $query,
"file_limit" => $limit,
"include_deleted" => $includeDeleted,
));
if ($response->statusCode !== 200) throw RequestUtil::unexpectedStatus($response);
return RequestUtil::parseResponseJson($response->body);
}
/**
* Creates and returns a public link to a file or folder's "preview page". This link can be
* used without authentication. The preview page may contain a thumbnail or some other
* preview of the file, along with a download link to download the actual file.
*
* See <a href="https://www.dropbox.com/developers/core/api#shares">/shares</a>.
*
* @param string $path
* The Dropbox path to the file or folder you want to create a shareable link to (UTF-8).
*
* @return string
* The URL of the preview page.
*
* @throws Exception
*/
function createShareableLink($path)
{
Path::checkArg("path", $path);
$response = $this->doPost(
$this->apiHost,
$this->appendFilePath("1/shares", $path),
array(
"short_url" => "false",
));
if ($response->statusCode === 404) return null;
if ($response->statusCode !== 200) throw RequestUtil::unexpectedStatus($response);
$j = RequestUtil::parseResponseJson($response->body);
return self::getField($j, "url");
}
/**
* Creates and returns a direct link to a file. This link can be used without authentication.
* This link will expire in a few hours.
*
* @param string $path
* The Dropbox path to a file or folder (UTF-8).
*
* @return array
* A <code>list(string $url, \DateTime $expires) where <code>$url</code> is a direct link to
* the requested file and <code>$expires</code> is a standard PHP <code>\DateTime</code>
* representing when <code>$url</code> will stop working.
*
* @throws Exception
*/
function createTemporaryDirectLink($path)
{
Path::checkArgNonRoot("path", $path);
$response = $this->doPost(
$this->apiHost,
$this->appendFilePath("1/media", $path));
if ($response->statusCode === 404) return null;
if ($response->statusCode !== 200) throw RequestUtil::unexpectedStatus($response);
$j = RequestUtil::parseResponseJson($response->body);
$url = self::getField($j, "url");
$expires = self::parseDateTime(self::getField($j, "expires"));
return array($url, $expires);
}
/**
* Creates and returns a "copy ref" to a file. A copy ref can be used to copy a file across
* different Dropbox accounts without downloading and re-uploading.
*
* For example: Create a <code>Client</code> using the access token from one account and call
* <code>createCopyRef</code>. Then, create a <code>Client</code> using the access token for
* another account and call <code>copyFromCopyRef</code> using the copy ref. (You need to use
* the same app key both times.)
*
* @param string path
* The Dropbox path of the file or folder you want to create a copy ref for (UTF-8).
*
* @return string
* The copy ref (just a string that you keep track of).
*
* @throws Exception
*/
function createCopyRef($path)
{
Path::checkArg("path", $path);
$response = $this->doGet(