PHP Extension Requires Chilkat v11.7.0+
PHP Extension
Box: Upload a Large File in Parts and Commit the Session
See more Box Examples
Run the reusable setup once per HttpCurl object, then select names and execute the operation. The setup is repeated here only to make this published example independently runnable. Resolve documents by name, then perform the explicit chunked-upload session, part, and commit loop. Supports 20 MB through 2 GB using int. Saves recovery information and honors bounded commit Retry-After.
See the Box API guide for setup and the complete workflow.
Chilkat PHP Extension Downloads
<?php
include("chilkat.php");
$success = false;
// Requires Chilkat 11.7.0 or later and a previously unlocked Chilkat bundle.
// See Global Unlock Sample.
// Guide: Box API Guide.
$success = false;
// BEGIN ONE-TIME SETUP
// This block is repeated so each published example can run on its own.
// In an application, run the setup example once and pass the SAME curl object
// to operation code below. Do not recreate it for every operation.
// See Reusable Box HttpCurl Setup.
$curl = new CkHttpCurl();
$curl->SetVar('access_token','BOX_ACCESS_TOKEN');
$curl->SetVar('parent_name','/');
// Box's fixed root ID is an implementation detail; callers supply names.
$curl->SetVar('parent_id','0');
$setupCommand = new CkStringBuilder();
// Register findParent; registration sends no request.
$setupCommand->SetString('curl -X GET \'https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name\' -H \'Authorization: Bearer ACCESS_TOKEN\'');
$setupReplacements = $setupCommand->Replace('ACCESS_TOKEN',$curl->getVar('access_token'));
$success = $curl->AddFunction('findParent',$setupCommand->getAsString());
if ($success != true) {
print $curl->lastErrorText() . "\n";
exit;
}
// Register findFolder; registration sends no request.
$setupCommand->SetString('curl -X GET \'https://api.box.com/2.0/folders/{{parent_id}}/items?limit=1000&fields=id,type,name\' -H \'Authorization: Bearer ACCESS_TOKEN\'');
$setupReplacements = $setupCommand->Replace('ACCESS_TOKEN',$curl->getVar('access_token'));
$success = $curl->AddFunction('findFolder',$setupCommand->getAsString());
if ($success != true) {
print $curl->lastErrorText() . "\n";
exit;
}
// Register findFile; registration sends no request.
$setupCommand->SetString('curl -X GET \'https://api.box.com/2.0/folders/{{folder_id}}/items?limit=1000&fields=id,type,name\' -H \'Authorization: Bearer ACCESS_TOKEN\'');
$setupReplacements = $setupCommand->Replace('ACCESS_TOKEN',$curl->getVar('access_token'));
$success = $curl->AddFunction('findFile',$setupCommand->getAsString());
if ($success != true) {
print $curl->lastErrorText() . "\n";
exit;
}
// Register findDestination; registration sends no request.
$setupCommand->SetString('curl -X GET \'https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name\' -H \'Authorization: Bearer ACCESS_TOKEN\'');
$setupReplacements = $setupCommand->Replace('ACCESS_TOKEN',$curl->getVar('access_token'));
$success = $curl->AddFunction('findDestination',$setupCommand->getAsString());
if ($success != true) {
print $curl->lastErrorText() . "\n";
exit;
}
// Register getFileDetails; registration sends no request.
$setupCommand->SetString('curl -X GET \'https://api.box.com/2.0/files/{{file_id}}?fields=id,sha1,file_version\' -H \'Authorization: Bearer ACCESS_TOKEN\'');
$setupReplacements = $setupCommand->Replace('ACCESS_TOKEN',$curl->getVar('access_token'));
$success = $curl->AddFunction('getFileDetails',$setupCommand->getAsString());
if ($success != true) {
print $curl->lastErrorText() . "\n";
exit;
}
// Register getEnterprise; registration sends no request.
$setupCommand->SetString('curl -X GET \'https://api.box.com/2.0/users/me?fields=enterprise\' -H \'Authorization: Bearer ACCESS_TOKEN\'');
$setupReplacements = $setupCommand->Replace('ACCESS_TOKEN',$curl->getVar('access_token'));
$success = $curl->AddFunction('getEnterprise',$setupCommand->getAsString());
if ($success != true) {
print $curl->lastErrorText() . "\n";
exit;
}
// Register output rules once. Chilkat 11.7.0 evaluates {{name}} variables
// when extracting each output, using the current value at that time.
$success = $curl->AddOutput2('findParent','entries','name','{{parent_name}}',true,'id','parent_id');
if ($success != true) {
print $curl->lastErrorText() . "\n";
exit;
}
$success = $curl->AddOutput2('findFolder','entries','name','{{folder_name}}',true,'id','folder_id');
if ($success != true) {
print $curl->lastErrorText() . "\n";
exit;
}
$success = $curl->AddOutput2('findFile','entries','name','{{file_name}}',true,'id','file_id');
if ($success != true) {
print $curl->lastErrorText() . "\n";
exit;
}
$success = $curl->AddOutput2('findDestination','entries','name','{{destination_name}}',true,'id','destination_id');
if ($success != true) {
print $curl->lastErrorText() . "\n";
exit;
}
$success = $curl->AddOutput('getFileDetails','file_version.id','file_version_id');
if ($success != true) {
print $curl->lastErrorText() . "\n";
exit;
}
$success = $curl->AddOutput('getFileDetails','sha1','file_sha1');
if ($success != true) {
print $curl->lastErrorText() . "\n";
exit;
}
$success = $curl->AddOutput('getEnterprise','enterprise.id','enterprise_id');
if ($success != true) {
print $curl->lastErrorText() . "\n";
exit;
}
// END ONE-TIME SETUP
// The name lookups below assume each listing fits in one page (1000 items).
// Parent and destination names select root children; folder_name selects a child
// of parent_name. "/" selects the root parent. These are not arbitrary paths.
// BEGIN OPERATION -- keep the configured object when reusing it.
// Inputs are names. Retain cached IDs when the selected names have not changed.
$parentName = '/';
$folderName = 'documents';
if (($curl->getVar('parent_name') != $parentName) or (($parentName == '/') and ($curl->VarDefined('parent_id') == false))) {
$curl->SetVar('parent_name',$parentName);
$curl->ClearVar('parent_id');
$curl->ClearVar('folder_id');
$curl->ClearVar('file_id');
$curl->ClearVar('file_version_id');
$curl->ClearVar('file_sha1');
if ($parentName == '/') {
$curl->SetVar('parent_id','0');
}
}
if ($curl->getVar('folder_name') != $folderName) {
$curl->SetVar('folder_name',$folderName);
$curl->ClearVar('folder_id');
$curl->ClearVar('file_id');
$curl->ClearVar('file_version_id');
$curl->ClearVar('file_sha1');
}
// Resolve the named destination first. HttpCurl does not expand variables
// inside multipart -F attributes in the tested build, so this upload is two phases.
$curl->ClearTargetOutput('*');
$authorizedCommand1 = new CkStringBuilder();
$authorizedCommand1->SetString('curl -X GET \'https://api.box.com/2.0/folders/{{folder_id}}?fields=id\' -H \'Authorization: Bearer {{access_token}}\'');
$headerReplacement1 = $authorizedCommand1->Replace('{{access_token}}',$curl->getVar('access_token'));
$success = $curl->DoYourThing($authorizedCommand1->getAsString());
if (($success != true) or ($curl->get_StatusCode() != 200)) {
print 'Box request failed. HTTP status: ' . $curl->get_StatusCode() . "\n";
print 'Failure reason: ' . $curl->get_FailReason() . "\n";
print $curl->responseBodyStr() . "\n";
exit;
}
// This example limits size to 2 GB so offsets fit all generated languages' integers.
// The source must not change during hashing or upload. Create qa_output first.
$localPath = 'qa_data/large-document.zip';
$file = new CkFileAccess();
// Check the decimal size before converting so an oversized file cannot overflow int.
$sizeString = $file->fileSizeStr($localPath);
if ($file->get_LastMethodSuccess() != true) {
print $file->lastErrorText() . "\n";
exit;
}
$sizeText = new CkStringBuilder();
$sizeText->SetString($sizeString);
$sizeMatch = new CkJsonObject();
if ($sizeText->RegexMatch('^([0-9]{1,9}|1[0-9]{9}|2000000000)$',$sizeMatch,100) != 1) {
print 'Choose an input between 20 MB and 2 GB for this example.' . "\n";
exit;
}
$fileSize = $sizeString;
if ($fileSize < 20971520) {
print 'Choose an input between 20 MB and 2 GB for this example.' . "\n";
exit;
}
$http = new CkHttp();
$http->put_AuthToken($curl->getVar('access_token'));
$response = new CkHttpResponse();
$request = new CkJsonObject();
$request->UpdateString('folder_id',$curl->getVar('folder_id'));
$request->UpdateString('file_name','large-document.zip');
$request->UpdateInt('file_size',$fileSize);
$success = $http->HttpJson('POST','https://upload.box.com/api/2.0/files/upload_sessions',$request,'application/json',$response);
if ($success != true) {
print $http->lastErrorText() . "\n";
exit;
}
if ($response->get_StatusCode() != 201) {
print $response->bodyStr() . "\n";
exit;
}
$session = new CkJsonObject();
$success = $session->Load($response->bodyStr());
if ($success != true) {
print $session->lastErrorText() . "\n";
exit;
}
$success = $session->WriteFile('qa_output/box_upload_session.json');
if ($success != true) {
print $session->lastErrorText() . "\n";
exit;
}
$partSize = $session->IntOf('part_size');
$uploadUrl = $session->stringOf('session_endpoints.upload_part');
$commitUrl = $session->stringOf('session_endpoints.commit');
if (($partSize <= 0) or ($uploadUrl == '') or ($commitUrl == '')) {
print 'Invalid session response.' . "\n";
exit;
}
$hash = new CkCrypt2();
$hash->put_HashAlgorithm('sha1');
$hash->put_EncodingMode('base64');
$fileDigest = $hash->hashFileENC($localPath);
if ($hash->get_LastMethodSuccess() != true) {
print $hash->lastErrorText() . "\n";
exit;
}
$success = $file->FileOpen($localPath,2147483648,1,3,0);
if ($success != true) {
print $file->lastErrorText() . "\n";
exit;
}
$commit = new CkJsonObject();
$partResponse = new CkJsonObject();
$chunk = new CkBinData();
$range = new CkStringBuilder();
$digestHeader = new CkStringBuilder();
$offset = 0;
$partIndex = 0;
while ($offset < $fileSize) {
$chunk->Clear();
$success = $file->FileReadBd($partSize,$chunk);
if ($success != true) {
print $file->lastErrorText() . "\n";
$file->FileClose();
exit;
}
$partLength = $chunk->get_NumBytes();
if ($partLength <= 0) {
print 'Unexpected end of file.' . "\n";
$file->FileClose();
exit;
}
$lastByte = $offset + ($partLength - 1);
$range->Clear();
$range->Append('bytes ');
$range->AppendInt($offset);
$range->Append('-');
$range->AppendInt($lastByte);
$range->Append('/');
$range->AppendInt($fileSize);
$partDigest = $hash->hashBdENC($chunk);
if ($hash->get_LastMethodSuccess() != true) {
print $hash->lastErrorText() . "\n";
$file->FileClose();
exit;
}
$digestHeader->SetString('sha=');
$digestHeader->Append($partDigest);
$http->SetRequestHeader('Digest',$digestHeader->getAsString());
$http->SetRequestHeader('Content-Range',$range->getAsString());
$success = $http->HttpBd('PUT',$uploadUrl,$chunk,'application/octet-stream',$response);
if (($success != true) or ($response->get_StatusCode() != 200)) {
print 'Part failed. HTTP status: ' . $response->get_StatusCode() . "\n";
print $response->bodyStr() . "\n";
print 'Inspect the saved session and server list_parts before retrying this part.' . "\n";
$file->FileClose();
exit;
}
$success = $partResponse->Load($response->bodyStr());
if ($success != true) {
$file->FileClose();
exit;
}
$commit->put_I($partIndex);
// Copy the server's acknowledged part fields into the commit manifest.
$commit->UpdateString('parts[i].part_id',$partResponse->stringOf('part.part_id'));
$commit->UpdateInt('parts[i].offset',$partResponse->IntOf('part.offset'));
$commit->UpdateInt('parts[i].size',$partResponse->IntOf('part.size'));
$commit->UpdateString('parts[i].sha1',$partResponse->stringOf('part.sha1'));
$success = $commit->WriteFile('qa_output/box_upload_parts.json');
if ($success != true) {
print $commit->lastErrorText() . "\n";
$file->FileClose();
exit;
}
$offset = $offset + $partLength;
$partIndex = $partIndex + 1;
}
$file->FileClose();
$http->RemoveRequestHeader('Content-Range');
$digestHeader->SetString('sha=');
$digestHeader->Append($fileDigest);
$http->SetRequestHeader('Digest',$digestHeader->getAsString());
$attempts = 0;
$retryHeader = new CkStringBuilder();
$retryMatch = new CkJsonObject();
$completed = false;
while (($attempts < 10) and ($completed == false)) {
$success = $http->HttpJson('POST',$commitUrl,$commit,'application/json',$response);
if ($success != true) {
print 'Commit failed: ' . $response->get_StatusCode() . "\n";
print $response->bodyStr() . "\n";
exit;
}
if ($response->get_StatusCode() == 201) {
$completed = true;
}
else {
if ($response->get_StatusCode() != 202) {
print 'Unexpected commit status: ' . $response->get_StatusCode() . "\n";
exit;
}
// Box's asynchronous commit response supplies Retry-After in seconds.
$retryHeader->SetString($response->getHeaderField('Retry-After'));
if ($retryHeader->RegexMatch('^[0-9]{1,2}$',$retryMatch,100) != 1) {
print 'Commit pending. Preserve the session and inspect Retry-After before resuming: ' . $retryHeader->getAsString() . "\n";
exit;
}
$waitSeconds = $retryHeader->getAsString();
if (($waitSeconds < 1) or ($waitSeconds > 60)) {
print 'Commit pending. Resume commit after Retry-After: ' . $response->getHeaderField('Retry-After') . "\n";
exit;
}
$http->SleepMs($waitSeconds * 1000);
}
$attempts = $attempts + 1;
}
if ($completed == false) {
print 'Commit still pending; retain session and part manifests to resume commit later.' . "\n";
exit;
}
print 'Upload committed: ' . $response->bodyStr() . "\n";
?>