Lazarus Pascal Requires Chilkat v11.7.0+
Lazarus Pascal
Box: Resolve Folder and File IDs with the HttpCurl Dependency Engine
See more Box Examples
Download images/penguins.jpg using search-based HttpCurl dependencies and one DoYourThing call. Register search requests/output rules once, then supply names. Search results must each contain exactly one item; exact names and immediate parent IDs are checked before saving the downloaded bytes. The candidate content is downloaded into memory before validation, so this example is for small files. Multiple results are rejected instead of paginated or silently choosing a candidate. Search indexing can delay visibility of newly created or renamed items.
See the Box API guide for setup and the complete workflow.
Chilkat Lazarus Pascal Downloads
program ChilkatDemo;
// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.
{$IFDEF FPC}
{$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}
uses
{$IFDEF UNIX}
cthreads,
{$ENDIF}
SysUtils,
CkDllLoader,
Chilkat.HttpCurl,
Chilkat.BinData,
Chilkat.StringBuilder,
Chilkat.JsonObject;
// ---------------------------------------------------------------------------
procedure RunDemo;
var
success: Boolean;
curl: THttpCurl;
setupCommand: TStringBuilder;
setupReplacements: Integer;
folderName: string;
fileName: string;
queryText: TStringBuilder;
localPath: string;
plan: TJsonObject;
authorizedCommand1: TStringBuilder;
headerReplacement1: Integer;
authorizedCommand2: TStringBuilder;
headerReplacement2: Integer;
contents: TBinData;
begin
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
// Requires Chilkat 11.7.0. Registration sends no requests.
// Run this once and keep the SAME HttpCurl object for later downloads.
// This focused setup searches for a root folder and a file directly inside it.
curl := THttpCurl.Create;
curl.SetVar('access_token','BOX_ACCESS_TOKEN');
setupCommand := TStringBuilder.Create;
// searchFolder: Box searches names; quotes request a phrase match.
setupCommand.SetString('curl -X GET "https://api.box.com/2.0/search?query={{folder_query}}&type=folder&content_types=name&fields=id,type,name,parent&limit=2" -H "Authorization: Bearer ACCESS_TOKEN"');
setupReplacements := setupCommand.Replace('ACCESS_TOKEN',curl.GetVar('access_token'));
success := curl.AddFunction('searchFolder',setupCommand.GetAsString());
if (success <> True) then
begin
WriteLn(curl.LastErrorText);
Exit;
end;
// Deferred selection: folder_name need not be set during setup.
success := curl.AddOutput2('searchFolder','entries','name','{{folder_name}}',True,'id','folder_id');
if (success <> True) then
begin
WriteLn(curl.LastErrorText);
Exit;
end;
success := curl.AddOutput2('searchFolder','entries','name','{{folder_name}}',True,'name','folder_result_name');
if (success <> True) then
begin
WriteLn(curl.LastErrorText);
Exit;
end;
success := curl.AddOutput2('searchFolder','entries','name','{{folder_name}}',True,'parent.id','folder_parent_id');
if (success <> True) then
begin
WriteLn(curl.LastErrorText);
Exit;
end;
success := curl.AddOutput('searchFolder','total_count','folder_search_count');
if (success <> True) then
begin
WriteLn(curl.LastErrorText);
Exit;
end;
// searchFile: Box searches names; quotes request a phrase match.
setupCommand.SetString('curl -X GET "https://api.box.com/2.0/search?query={{file_query}}&type=file&content_types=name&fields=id,type,name,parent&limit=2&ancestor_folder_ids={{folder_id}}" -H "Authorization: Bearer ACCESS_TOKEN"');
setupReplacements := setupCommand.Replace('ACCESS_TOKEN',curl.GetVar('access_token'));
success := curl.AddFunction('searchFile',setupCommand.GetAsString());
if (success <> True) then
begin
WriteLn(curl.LastErrorText);
Exit;
end;
// Deferred selection: file_name need not be set during setup.
success := curl.AddOutput2('searchFile','entries','name','{{file_name}}',True,'id','file_id');
if (success <> True) then
begin
WriteLn(curl.LastErrorText);
Exit;
end;
success := curl.AddOutput2('searchFile','entries','name','{{file_name}}',True,'name','file_result_name');
if (success <> True) then
begin
WriteLn(curl.LastErrorText);
Exit;
end;
success := curl.AddOutput2('searchFile','entries','name','{{file_name}}',True,'parent.id','file_parent_id');
if (success <> True) then
begin
WriteLn(curl.LastErrorText);
Exit;
end;
success := curl.AddOutput('searchFile','total_count','file_search_count');
if (success <> True) then
begin
WriteLn(curl.LastErrorText);
Exit;
end;
// END ONE-TIME SETUP
// Search is indexed: newly uploaded/renamed items may not appear immediately.
// Search matches phrases, not exact strings, and ancestor filtering includes
// subfolders. The operation validates counts, exact names, and immediate parents.
// limit=2 is enough to demonstrate an ambiguous search; total_count covers all
// results, not just this page. This introductory example requires exactly one
// search result at each step and does not select among multiple candidates.
// BEGIN OPERATION -- use the previously configured object.
// Human-readable inputs. No resource IDs are supplied by the caller.
folderName := 'images';
fileName := 'penguins.jpg';
// Encode the quoted search queries separately from the literal output filters.
// In this build, URL variable substitution does not encode '&' in a name.
queryText := TStringBuilder.Create;
queryText.SetString('"');
queryText.Append(folderName);
queryText.Append('"');
curl.SetVar('folder_query',queryText.GetEncoded('url','utf-8'));
queryText.SetString('"');
queryText.Append(fileName);
queryText.Append('"');
curl.SetVar('file_query',queryText.GetEncoded('url','utf-8'));
if (curl.GetVar('folder_name') <> folderName) then
begin
curl.ClearVar('folder_id');
curl.ClearVar('folder_result_name');
curl.ClearVar('folder_parent_id');
curl.ClearVar('folder_search_count');
curl.ClearVar('file_id');
curl.ClearVar('file_result_name');
curl.ClearVar('file_parent_id');
curl.ClearVar('file_search_count');
curl.SetVar('folder_name',folderName);
end;
if (curl.GetVar('file_name') <> fileName) then
begin
curl.ClearVar('file_id');
curl.ClearVar('file_result_name');
curl.ClearVar('file_parent_id');
curl.ClearVar('file_search_count');
curl.SetVar('file_name',fileName);
end;
// With unchanged names, cached IDs and validation fields can be reused.
// Clear the corresponding cached fields to refresh after a remote rename/move.
localPath := 'qa_output/penguins.jpg';
// A cold plan is searchFolder -> searchFile -> targetCurl.
// No listing endpoint or manual search call is used.
plan := TJsonObject.Create;
plan.EmitCompact := False;
authorizedCommand1 := TStringBuilder.Create;
authorizedCommand1.SetString('curl -X GET "https://api.box.com/2.0/files/{{file_id}}/content" -H "Authorization: Bearer {{access_token}}" -L');
headerReplacement1 := authorizedCommand1.Replace('{{access_token}}',curl.GetVar('access_token'));
success := curl.ExaminePlan(authorizedCommand1.GetAsString(),plan);
if (success <> True) then
begin
WriteLn(curl.LastErrorText);
Exit;
end;
WriteLn(plan.Emit());
// Keep the candidate download in memory; do not write an unvalidated result.
curl.ResponseFilePath := '';
curl.ClearTargetOutput('*');
authorizedCommand2 := TStringBuilder.Create;
authorizedCommand2.SetString('curl -X GET "https://api.box.com/2.0/files/{{file_id}}/content" -H "Authorization: Bearer {{access_token}}" -L');
headerReplacement2 := authorizedCommand2.Replace('{{access_token}}',curl.GetVar('access_token'));
success := curl.DoYourThing(authorizedCommand2.GetAsString());
if ((success <> True) or (curl.StatusCode <> 200)) then
begin
WriteLn('Box request failed. HTTP status: ' + curl.StatusCode);
WriteLn('Failure reason: ' + curl.FailReason);
Exit;
end;
// AddOutput2 supplies candidate IDs. Box's phrase search and recursive
// ancestor filter are not an exact path lookup, so validate before saving.
if ((curl.GetVar('folder_search_count') <> '1') or (curl.GetVar('file_search_count') <> '1')) then
begin
WriteLn('Search was ambiguous or incomplete. Expected exactly one result per search; no file was saved.');
WriteLn('Folder results: ' + curl.GetVar('folder_search_count') + ' File results: ' + curl.GetVar('file_search_count'));
curl.ClearVar('folder_id');
curl.ClearVar('folder_result_name');
curl.ClearVar('folder_parent_id');
curl.ClearVar('folder_search_count');
curl.ClearVar('file_id');
curl.ClearVar('file_result_name');
curl.ClearVar('file_parent_id');
curl.ClearVar('file_search_count');
Exit;
end;
if ((curl.GetVar('folder_result_name') <> folderName) or (curl.GetVar('folder_parent_id') <> '0') or (curl.GetVar('file_result_name') <> fileName) or (curl.GetVar('file_parent_id') <> curl.GetVar('folder_id'))) then
begin
WriteLn('The search result is not the exact root-folder/filename requested; no file was saved.');
curl.ClearVar('folder_id');
curl.ClearVar('folder_result_name');
curl.ClearVar('folder_parent_id');
curl.ClearVar('folder_search_count');
curl.ClearVar('file_id');
curl.ClearVar('file_result_name');
curl.ClearVar('file_parent_id');
curl.ClearVar('file_search_count');
Exit;
end;
// Validation is after the network download but before writing the destination.
// This in-memory example is intended for small files such as penguins.jpg.
// Create qa_output before running it.
contents := TBinData.Create;
success := curl.GetResponseBd(contents);
if (success <> True) then
begin
WriteLn(curl.LastErrorText);
Exit;
end;
success := contents.WriteFile(localPath);
if (success <> True) then
begin
WriteLn(contents.LastErrorText);
Exit;
end;
WriteLn('Downloaded to ' + localPath);
curl.Free;
setupCommand.Free;
queryText.Free;
plan.Free;
authorizedCommand1.Free;
authorizedCommand2.Free;
contents.Free;
end;
// ---------------------------------------------------------------------------
begin
try
RunDemo;
except
on E: Exception do
WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
end;
WriteLn;
{$IFDEF MSWINDOWS}
WriteLn('Press Enter to exit...');
ReadLn;
{$ENDIF}
end.