forked from Studio-42/elFinder
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathelFinderVolumeBox.class.php
1812 lines (1567 loc) · 54.1 KB
/
elFinderVolumeBox.class.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
/**
* Simple elFinder driver for BoxDrive
* Box.com API v2.0.
*
* @author Dmitry (dio) Levashov
* @author Cem (discofever)
**/
class elFinderVolumeBox extends elFinderVolumeDriver
{
/**
* Driver id
* Must be started from letter and contains [a-z0-9]
* Used as part of volume id.
*
* @var string
**/
protected $driverId = 'bd';
/**
* @var string The base URL for API requests
*/
const API_URL = 'https://api.box.com/2.0';
/**
* @var string The base URL for authorization requests
*/
const AUTH_URL = 'https://www.box.com/api/oauth2/authorize';
/**
* @var string The base URL for token requests
*/
const TOKEN_URL = 'https://www.box.com/api/oauth2/token';
/**
* @var string The base URL for upload requests
*/
const UPLOAD_URL = 'https://upload.box.com/api/2.0';
/**
* Fetch fields list.
*
* @var string
*/
const FETCHFIELDS = 'type,id,name,created_at,modified_at,description,size,parent,permissions,file_version,shared_link';
/**
* Box.com token object.
*
* @var object
**/
protected $token = null;
/**
* Directory for tmp files
* If not set driver will try to use tmbDir as tmpDir.
*
* @var string
**/
protected $tmp = '';
/**
* Net mount key.
*
* @var string
**/
public $netMountKey = '';
/**
* Thumbnail prefix.
*
* @var string
**/
private $tmbPrefix = '';
/**
* hasCache by folders.
*
* @var array
**/
protected $HasdirsCache = array();
/**
* Constructor
* Extend options with required fields.
*
* @author Dmitry (dio) Levashov
* @author Cem (DiscoFever)
**/
public function __construct()
{
$opts = array(
'client_id' => '',
'client_secret' => '',
'accessToken' => '',
'root' => 'Box.com',
'path' => '/',
'separator' => '/',
'tmbPath' => '',
'tmbURL' => '',
'tmpPath' => '',
'acceptedName' => '#^[^/\\?*:|"<>]*[^./\\?*:|"<>]$#',
'rootCssClass' => 'elfinder-navbar-root-box',
);
$this->options = array_merge($this->options, $opts);
$this->options['mimeDetect'] = 'internal';
}
/*********************************************************************/
/* ORIGINAL FUNCTIONS */
/*********************************************************************/
/**
* Get Parent ID, Item ID, Parent Path as an array from path.
*
* @param string $path
*
* @return array
*/
protected function _bd_splitPath($path)
{
$path = trim($path, '/');
$pid = '';
if ($path === '') {
$id = '0';
$parent = '';
} else {
$paths = explode('/', trim($path, '/'));
$id = array_pop($paths);
if ($paths) {
$parent = '/' . implode('/', $paths);
$pid = array_pop($paths);
} else {
$pid = '0';
$parent = '/';
}
}
return array($pid, $id, $parent);
}
/**
* Obtains a new access token from OAuth. This token is valid for one hour.
*
* @param string $clientSecret The Box client secret
* @param string $code The code returned by Box after
* successful log in
* @param string $redirectUri Must be the same as the redirect URI passed
* to LoginUrl
*
* @return bool|object
* @throws \Exception Thrown if this Client instance's clientId is not set
* @throws \Exception Thrown if the redirect URI of this Client instance's
* state is not set
*/
protected function _bd_obtainAccessToken($client_id, $client_secret, $code)
{
if (null === $client_id) {
return $this->setError('The client ID must be set to call obtainAccessToken()');
}
if (null === $client_secret) {
return $this->setError('The client Secret must be set to call obtainAccessToken()');
}
if (null === $code) {
return $this->setError('Authorization code must be set to call obtainAccessToken()');
}
$url = self::TOKEN_URL;
$curl = curl_init();
$fields = http_build_query(
array(
'client_id' => $client_id,
'client_secret' => $client_secret,
'code' => $code,
'grant_type' => 'authorization_code',
)
);
curl_setopt_array($curl, array(
// General options.
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $fields,
CURLOPT_URL => $url,
));
$decoded = $this->_bd_curlExec($curl, true, array('Content-Length: ' . strlen($fields)));
return (object)array(
'expires' => time() + $decoded->expires_in - 30,
'data' => $decoded,
);
}
/**
* Get token and auto refresh.
*
* @return true|string error message
* @throws Exception
*/
protected function _bd_refreshToken()
{
if (!property_exists($this->token, 'expires') || $this->token->expires < time()) {
if (!$token = $this->session->get('BoxTokens')) {
$token = $this->token;
}
if (empty($token->data->refresh_token)) {
$this->session->remove('BoxTokens');
throw new \Exception(elFinder::ERROR_REAUTH_REQUIRE);
}
if (!$this->options['client_id']) {
$this->options['client_id'] = ELFINDER_BOX_CLIENTID;
}
if (!$this->options['client_secret']) {
$this->options['client_secret'] = ELFINDER_BOX_CLIENTSECRET;
}
$url = self::TOKEN_URL;
$curl = curl_init();
curl_setopt_array($curl, array(
// General options.
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true, // i am sending post data
CURLOPT_POSTFIELDS => 'client_id=' . urlencode($this->options['client_id'])
. '&client_secret=' . urlencode($this->options['client_secret'])
. '&grant_type=refresh_token'
. '&refresh_token=' . urlencode($token->data->refresh_token),
CURLOPT_URL => $url,
));
$decoded = $this->_bd_curlExec($curl);
if (empty($decoded->access_token)) {
throw new \Exception(elFinder::ERROR_REAUTH_REQUIRE);
}
$token = (object)array(
'expires' => time() + $decoded->expires_in - 30,
'data' => $decoded,
);
$this->session->set('BoxTokens', $token);
$this->options['accessToken'] = json_encode($token);
$this->token = $token;
if (!empty($this->options['netkey'])) {
elFinder::$instance->updateNetVolumeOption($this->options['netkey'], 'accessToken', $this->options['accessToken']);
}
}
return true;
}
/**
* Creates a base cURL object which is compatible with the Box.com API.
*
* @param array $options cURL options
*
* @return resource A compatible cURL object
*/
protected function _bd_prepareCurl($options = array())
{
$curl = curl_init();
$defaultOptions = array(
// General options.
CURLOPT_RETURNTRANSFER => true,
);
curl_setopt_array($curl, $options + $defaultOptions);
return $curl;
}
/**
* Creates a base cURL object which is compatible with the Box.com API.
*
* @param $url
* @param bool $contents
*
* @return boolean|array
* @throws Exception
*/
protected function _bd_fetch($url, $contents = false)
{
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
if ($contents) {
return $this->_bd_curlExec($curl, false);
} else {
$result = $this->_bd_curlExec($curl);
if (isset($result->entries)) {
$res = $result->entries;
$cnt = count($res);
$total = $result->total_count;
$offset = $result->offset;
$single = ($result->limit == 1) ? true : false;
if (!$single && $total > ($offset + $cnt)) {
$offset = $offset + $cnt;
if (strpos($url, 'offset=') === false) {
$url .= '&offset=' . $offset;
} else {
$url = preg_replace('/^(.+?offset=)\d+(.*)$/', '${1}' . $offset . '$2', $url);
}
$more = $this->_bd_fetch($url);
if (is_array($more)) {
$res = array_merge($res, $more);
}
}
return $res;
} else {
if (isset($result->type) && $result->type === 'error') {
return false;
} else {
return $result;
}
}
}
}
/**
* Call curl_exec().
*
* @param resource $curl
* @param bool|string $decodeOrParent
* @param array $headers
*
* @throws \Exception
* @return mixed
*/
protected function _bd_curlExec($curl, $decodeOrParent = true, $headers = array())
{
$headers = array_merge(array(
'Authorization: Bearer ' . $this->token->data->access_token,
), $headers);
$result = elFinder::curlExec($curl, array(), $headers);
if (!$decodeOrParent) {
return $result;
}
$decoded = json_decode($result);
if (!empty($decoded->error_code)) {
$errmsg = $decoded->error_code;
if (!empty($decoded->message)) {
$errmsg .= ': ' . $decoded->message;
}
throw new \Exception($errmsg);
}
// make catch
if ($decodeOrParent && $decodeOrParent !== true) {
$raws = null;
if (isset($decoded->entries)) {
$raws = $decoded->entries;
} elseif (isset($decoded->id)) {
$raws = array($decoded);
}
if ($raws) {
foreach ($raws as $raw) {
if (isset($raw->id)) {
$stat = $this->_bd_parseRaw($raw);
$itemPath = $this->_joinPath($decodeOrParent, $raw->id);
$this->updateCache($itemPath, $stat);
}
}
}
}
return $decoded;
}
/**
* Drive query and fetchAll.
*
* @param $itemId
* @param bool $fetch_self
* @param bool $recursive
*
* @return bool|object
* @throws Exception
*/
protected function _bd_query($itemId, $fetch_self = false, $recursive = false)
{
$result = [];
if (null === $itemId) {
$itemId = '0';
}
if ($fetch_self) {
$path = '/folders/' . $itemId . '?fields=' . self::FETCHFIELDS;
} else {
$path = '/folders/' . $itemId . '/items?limit=1000&fields=' . self::FETCHFIELDS;
}
$url = self::API_URL . $path;
if ($recursive) {
foreach ($this->_bd_fetch($url) as $file) {
if ($file->type == 'folder') {
$result[] = $file;
$result = array_merge($result, $this->_bd_query($file->id, $fetch_self = false, $recursive = true));
} elseif ($file->type == 'file') {
$result[] = $file;
}
}
} else {
$result = $this->_bd_fetch($url);
if ($fetch_self && !$result) {
$path = '/files/' . $itemId . '?fields=' . self::FETCHFIELDS;
$url = self::API_URL . $path;
$result = $this->_bd_fetch($url);
}
}
return $result;
}
/**
* Get dat(box metadata) from Box.com.
*
* @param string $path
*
* @return object box metadata
* @throws Exception
*/
protected function _bd_getRawItem($path)
{
if ($path == '/') {
return $this->_bd_query('0', $fetch_self = true);
}
list(, $itemId) = $this->_bd_splitPath($path);
try {
return $this->_bd_query($itemId, $fetch_self = true);
} catch (Exception $e) {
$empty = new stdClass;
return $empty;
}
}
/**
* Parse line from box metadata output and return file stat (array).
*
* @param object $raw line from ftp_rawlist() output
*
* @return array
* @author Dmitry Levashov
**/
protected function _bd_parseRaw($raw)
{
$stat = array();
$stat['rev'] = isset($raw->id) ? $raw->id : 'root';
$stat['name'] = $raw->name;
if (!empty($raw->modified_at)) {
$stat['ts'] = strtotime($raw->modified_at);
}
if ($raw->type === 'folder') {
$stat['mime'] = 'directory';
$stat['size'] = 0;
$stat['dirs'] = -1;
} else {
$stat['size'] = (int)$raw->size;
if (!empty($raw->shared_link->url) && $raw->shared_link->access == 'open') {
if ($url = $this->getSharedWebContentLink($raw)) {
$stat['url'] = $url;
}
} elseif (!$this->disabledGetUrl) {
$stat['url'] = '1';
}
}
return $stat;
}
/**
* Get thumbnail from Box.com.
*
* @param string $path
* @param string $size
*
* @return string | boolean
*/
protected function _bd_getThumbnail($path)
{
list(, $itemId) = $this->_bd_splitPath($path);
try {
$url = self::API_URL . '/files/' . $itemId . '/thumbnail.png?min_height=' . $this->tmbSize . '&min_width=' . $this->tmbSize;
$contents = $this->_bd_fetch($url, true);
return $contents;
} catch (Exception $e) {
return false;
}
}
/**
* Remove item.
*
* @param string $path file path
*
* @return bool
**/
protected function _bd_unlink($path, $type = null)
{
try {
list(, $itemId) = $this->_bd_splitPath($path);
if ($type == 'folders') {
$url = self::API_URL . '/' . $type . '/' . $itemId . '?recursive=true';
} else {
$url = self::API_URL . '/' . $type . '/' . $itemId;
}
$curl = $this->_bd_prepareCurl(array(
CURLOPT_URL => $url,
CURLOPT_CUSTOMREQUEST => 'DELETE',
));
//unlink or delete File or Folder in the Parent
$this->_bd_curlExec($curl);
} catch (Exception $e) {
return $this->setError('Box error: ' . $e->getMessage());
}
return true;
}
/*********************************************************************/
/* OVERRIDE FUNCTIONS */
/*********************************************************************/
/**
* Prepare
* Call from elFinder::netmout() before volume->mount().
*
* @return array
* @author Naoki Sawada
* @author Raja Sharma updating for Box
**/
public function netmountPrepare($options)
{
if (empty($options['client_id']) && defined('ELFINDER_BOX_CLIENTID')) {
$options['client_id'] = ELFINDER_BOX_CLIENTID;
}
if (empty($options['client_secret']) && defined('ELFINDER_BOX_CLIENTSECRET')) {
$options['client_secret'] = ELFINDER_BOX_CLIENTSECRET;
}
if (isset($options['pass']) && $options['pass'] === 'reauth') {
$options['user'] = 'init';
$options['pass'] = '';
$this->session->remove('BoxTokens');
}
if (isset($options['id'])) {
$this->session->set('nodeId', $options['id']);
} elseif ($_id = $this->session->get('nodeId')) {
$options['id'] = $_id;
$this->session->set('nodeId', $_id);
}
try {
if (empty($options['client_id']) || empty($options['client_secret'])) {
return array('exit' => true, 'body' => '{msg:errNetMountNoDriver}');
}
if (isset($_GET['code'])) {
try {
// Obtain the token using the code received by the Box.com API
$this->session->set('BoxTokens',
$this->_bd_obtainAccessToken($options['client_id'], $options['client_secret'], $_GET['code']));
$out = array(
'node' => $options['id'],
'json' => '{"protocol": "box", "mode": "done", "reset": 1}',
'bind' => 'netmount',
);
return array('exit' => 'callback', 'out' => $out);
} catch (Exception $e) {
$out = array(
'node' => $options['id'],
'json' => json_encode(array('error' => $e->getMessage())),
);
return array('exit' => 'callback', 'out' => $out);
}
} elseif (!empty($_GET['error'])) {
$out = array(
'node' => $options['id'],
'json' => json_encode(array('error' => elFinder::ERROR_ACCESS_DENIED)),
);
return array('exit' => 'callback', 'out' => $out);
}
if ($options['user'] === 'init') {
$this->token = $this->session->get('BoxTokens');
if ($this->token) {
try {
$this->_bd_refreshToken();
} catch (Exception $e) {
$this->setError($e->getMessage());
$this->token = null;
$this->session->remove('BoxTokens');
}
}
if (empty($this->token)) {
$result = false;
} else {
$path = $options['path'];
if ($path === '/' || $path === 'root') {
$path = '0';
}
$result = $this->_bd_query($path, $fetch_self = false, $recursive = false);
}
if ($result === false) {
$cdata = '';
$innerKeys = array('cmd', 'host', 'options', 'pass', 'protocol', 'user');
$this->ARGS = $_SERVER['REQUEST_METHOD'] === 'POST' ? $_POST : $_GET;
foreach ($this->ARGS as $k => $v) {
if (!in_array($k, $innerKeys)) {
$cdata .= '&' . $k . '=' . rawurlencode($v);
}
}
if (empty($options['url'])) {
$options['url'] = elFinder::getConnectorUrl();
}
$callback = $options['url']
. '?cmd=netmount&protocol=box&host=box.com&user=init&pass=return&node=' . $options['id'] . $cdata;
try {
$this->session->set('BoxTokens', (object)array('token' => null));
$url = self::AUTH_URL . '?' . http_build_query(array('response_type' => 'code', 'client_id' => $options['client_id'], 'redirect_uri' => elFinder::getConnectorUrl() . '?cmd=netmount&protocol=box&host=1'));
$url .= '&oauth_callback=' . rawurlencode($callback);
} catch (Exception $e) {
return array('exit' => true, 'body' => '{msg:errAccess}');
}
$html = '<input id="elf-volumedriver-box-host-btn" class="ui-button ui-widget ui-state-default ui-corner-all ui-button-text-only" value="{msg:btnApprove}" type="button" onclick="window.open(\'' . $url . '\')">';
$html .= '<script>
$("#' . $options['id'] . '").elfinder("instance").trigger("netmount", {protocol: "box", mode: "makebtn"});
</script>';
return array('exit' => true, 'body' => $html);
} else {
$folders = [];
if ($result) {
foreach ($result as $res) {
if ($res->type == 'folder') {
$folders[$res->id . ' '] = $res->name;
}
}
natcasesort($folders);
}
if ($options['pass'] === 'folders') {
return ['exit' => true, 'folders' => $folders];
}
$folders = ['root' => 'My Box'] + $folders;
$folders = json_encode($folders);
$expires = empty($this->token->data->refresh_token) ? (int)$this->token->expires : 0;
$json = '{"protocol": "box", "mode": "done", "folders": ' . $folders . ', "expires": ' . $expires . '}';
$html = 'Box.com';
$html .= '<script>
$("#' . $options['id'] . '").elfinder("instance").trigger("netmount", ' . $json . ');
</script>';
return array('exit' => true, 'body' => $html);
}
}
} catch (Exception $e) {
return array('exit' => true, 'body' => '{msg:errNetMountNoDriver}');
}
if ($_aToken = $this->session->get('BoxTokens')) {
$options['accessToken'] = json_encode($_aToken);
} else {
$this->setError(elFinder::ERROR_NETMOUNT, $options['host'], implode(' ', $this->error()));
return array('exit' => true, 'error' => $this->error());
}
$this->session->remove('nodeId');
unset($options['user'], $options['pass'], $options['id']);
return $options;
}
/**
* process of on netunmount
* Drop `box` & rm thumbs.
*
* @param $netVolumes
* @param $key
*
* @return bool
*/
public function netunmount($netVolumes, $key)
{
if ($tmbs = glob(rtrim($this->options['tmbPath'], '\\/') . DIRECTORY_SEPARATOR . $this->tmbPrefix . '*.png')) {
foreach ($tmbs as $file) {
unlink($file);
}
}
return true;
}
/**
* Return debug info for client.
*
* @return array
**/
public function debug()
{
$res = parent::debug();
if (!empty($this->options['accessToken'])) {
$res['accessToken'] = $this->options['accessToken'];
}
return $res;
}
/*********************************************************************/
/* INIT AND CONFIGURE */
/*********************************************************************/
/**
* Prepare FTP connection
* Connect to remote server and check if credentials are correct, if so, store the connection id in $ftp_conn.
*
* @return bool
* @throws Exception
* @author Dmitry (dio) Levashov
* @author Cem (DiscoFever)
*/
protected function init()
{
if (!$this->options['accessToken']) {
return $this->setError('Required option `accessToken` is undefined.');
}
try {
$this->token = json_decode($this->options['accessToken']);
$this->_bd_refreshToken();
} catch (Exception $e) {
$this->token = null;
$this->session->remove('BoxTokens');
return $this->setError($e->getMessage());
}
if (empty($options['netkey'])) {
// make net mount key
$_tokenKey = isset($this->token->data->refresh_token) ? $this->token->data->refresh_token : $this->token->data->access_token;
$this->netMountKey = md5(implode('-', array('box', $this->options['path'], $_tokenKey)));
} else {
$this->netMountKey = $options['netkey'];
}
// normalize root path
if ($this->options['path'] == 'root') {
$this->options['path'] = '/';
}
$this->root = $this->options['path'] = $this->_normpath($this->options['path']);
$this->options['root'] == '' ? $this->options['root'] = 'Box.com' : $this->options['root'];
if (empty($this->options['alias'])) {
list(, $itemId) = $this->_bd_splitPath($this->options['path']);
$this->options['alias'] = ($this->options['path'] === '/') ? $this->options['root'] :
$this->_bd_query($itemId, $fetch_self = true)->name . '@Box.com';
}
$this->rootName = $this->options['alias'];
$this->tmbPrefix = 'box' . base_convert($this->netMountKey, 10, 32);
if (!empty($this->options['tmpPath'])) {
if ((is_dir($this->options['tmpPath']) || mkdir($this->options['tmpPath'])) && is_writable($this->options['tmpPath'])) {
$this->tmp = $this->options['tmpPath'];
}
}
if (!$this->tmp && ($tmp = elFinder::getStaticVar('commonTempPath'))) {
$this->tmp = $tmp;
}
// This driver dose not support `syncChkAsTs`
$this->options['syncChkAsTs'] = false;
// 'lsPlSleep' minmum 10 sec
$this->options['lsPlSleep'] = max(10, $this->options['lsPlSleep']);
// enable command archive
$this->options['useRemoteArchive'] = true;
return true;
}
/**
* Configure after successfull mount.
*
* @author Dmitry (dio) Levashov
* @throws elFinderAbortException
*/
protected function configure()
{
parent::configure();
// fallback of $this->tmp
if (!$this->tmp && $this->tmbPathWritable) {
$this->tmp = $this->tmbPath;
}
}
/*********************************************************************/
/* FS API */
/*********************************************************************/
/**
* Close opened connection.
*
* @author Dmitry (dio) Levashov
**/
public function umount()
{
}
/**
* Return fileinfo based on filename
* For item ID based path file system
* Please override if needed on each drivers.
*
* @param string $path file cache
*
* @return array|boolean
* @throws elFinderAbortException
*/
protected function isNameExists($path)
{
list(, $name, $parent) = $this->_bd_splitPath($path);
// We can not use it because the search of Box.com there is a time lag.
// ref. https://docs.box.com/reference#searching-for-content
// > Note: If an item is added to Box then it becomes accessible through the search endpoint after ten minutes.
/***
* $url = self::API_URL.'/search?limit=1&offset=0&content_types=name&ancestor_folder_ids='.rawurlencode($pid)
* .'&query='.rawurlencode('"'.$name.'"')
* .'fields='.self::FETCHFIELDS;
* $raw = $this->_bd_fetch($url);
* if (is_array($raw) && count($raw)) {
* return $this->_bd_parseRaw($raw);
* }
***/
$phash = $this->encode($parent);
// do not recursive search
$searchExDirReg = $this->options['searchExDirReg'];
$this->options['searchExDirReg'] = '/.*/';
$search = $this->search($name, array(), $phash);
$this->options['searchExDirReg'] = $searchExDirReg;
if ($search) {
return $search[0];
}
return false;
}
/**
* Cache dir contents.
*
* @param string $path dir path
*
* @return
* @throws Exception
* @author Dmitry Levashov
*/
protected function cacheDir($path)
{
$this->dirsCache[$path] = array();
$hasDir = false;
if ($path == '/') {
$items = $this->_bd_query('0', $fetch_self = true); // get root directory with folder & files
$itemId = $items->id;
} else {
list(, $itemId) = $this->_bd_splitPath($path);
}
$res = $this->_bd_query($itemId);
if ($res) {
foreach ($res as $raw) {
if ($stat = $this->_bd_parseRaw($raw)) {
$itemPath = $this->_joinPath($path, $raw->id);
$stat = $this->updateCache($itemPath, $stat);
if (empty($stat['hidden'])) {
if (!$hasDir && $stat['mime'] === 'directory') {
$hasDir = true;
}
$this->dirsCache[$path][] = $itemPath;
}
}
}
}
if (isset($this->sessionCache['subdirs'])) {
$this->sessionCache['subdirs'][$path] = $hasDir;
}
return $this->dirsCache[$path];
}
/**
* Copy file/recursive copy dir only in current volume.
* Return new file path or false.
*
* @param string $src source path
* @param string $dst destination dir path
* @param string $name new file name (optionaly)
*
* @return string|false
* @author Dmitry (dio) Levashov
* @author Naoki Sawada
**/
protected function copy($src, $dst, $name)
{
if ($res = $this->_copy($src, $dst, $name)) {
$this->added[] = $this->stat($res);
return $res;
} else {
return $this->setError(elFinder::ERROR_COPY, $this->_path($src));
}
}
/**
* Remove file/ recursive remove dir.
*
* @param string $path file path
* @param bool $force try to remove even if file locked
*
* @return bool
* @throws elFinderAbortException
* @author Dmitry (dio) Levashov
* @author Naoki Sawada
*/
protected function remove($path, $force = false)
{
$stat = $this->stat($path);
$stat['realpath'] = $path;
$this->rmTmb($stat);
$this->clearcache();
if (empty($stat)) {
return $this->setError(elFinder::ERROR_RM, $this->_path($path), elFinder::ERROR_FILE_NOT_FOUND);
}
if (!$force && !empty($stat['locked'])) {
return $this->setError(elFinder::ERROR_LOCKED, $this->_path($path));
}
if ($stat['mime'] == 'directory') {
if (!$this->_rmdir($path)) {
return $this->setError(elFinder::ERROR_RM, $this->_path($path));