PHP Extension Requires Chilkat v11.7.0+

Box: Resolve a File Version by Name and Verify the Download

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. One target request requires file_id and file_version_id. The engine uses AddOutput2 for name lookups and AddOutput for version/SHA-1 metadata, then downloads that version to local_path and verifies its digest.

See the Box API guide for setup and the complete workflow.

PHP Extension

<?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 = 'images';
$fileName = 'penguins.jpg';
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');
}

if ($curl->getVar('file_name') != $fileName) {
    $curl->SetVar('file_name',$fileName);
    $curl->ClearVar('file_id');
    $curl->ClearVar('file_version_id');
    $curl->ClearVar('file_sha1');
}

$curl->SetVar('local_path','qa_output/penguins-verified.jpg');
//  file_version_id is also unknown, so getFileDetails becomes a prerequisite.
//  Its AddOutput mappings cache both the selected version and its SHA-1.
$curl->ClearTargetOutput('*');
$authorizedCommand1 = new CkStringBuilder();
$authorizedCommand1->SetString('curl -X GET \'https://api.box.com/2.0/files/{{file_id}}/content?version={{file_version_id}}\' -H \'Authorization: Bearer {{access_token}}\' -L -o \'{{local_path}}\'');
$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;
}

$digest = new CkCrypt2();
$digest->put_HashAlgorithm('sha1');
$digest->put_EncodingMode('hex_lower');
$actualSha1 = $digest->hashFileENC($curl->getVar('local_path'));
if ($digest->get_LastMethodSuccess() != true) {
    print $digest->lastErrorText() . "\n";
    exit;
}

if ($actualSha1 != $curl->getVar('file_sha1')) {
    print 'Downloaded content did not match the selected version's SHA-1.' . "\n";
    exit;
}

print 'Version-specific download verified.' . "\n";

?>