Zig Requires Chilkat v11.7.0+
Zig
Box: Reuse HttpCurl and Invalidate Cached IDs
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. Perform three operations with one configured object: cold file lookup, warm download without lookups, then another download to a different local path after clearing only file state. Functions and output rules are registered only once; their variables are evaluated when used.
See the Box API guide for setup and the complete workflow.
Chilkat Zig Downloads
const std = @import("std");
const chilkat = @import("chilkat");
pub fn main(init: std.process.Init) !void {
const alloc = init.arena.allocator();
var success: bool = 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.
const curl = try chilkat.HttpCurl.init();
defer curl.deinit();
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");
const setup_command = try chilkat.StringBuilder.init();
defer setup_command.deinit();
var setup_replacements: i32 = 0;
// Register findParent; registration sends no request.
setup_command.setString("curl -X GET \"https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\"") catch {};
setup_replacements = setup_command.replace("ACCESS_TOKEN", try curl.getVar(alloc, "access_token"));
success = if (curl.addFunction("findParent", try setup_command.getAsString(alloc))) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
// Register findFolder; registration sends no request.
setup_command.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\"") catch {};
setup_replacements = setup_command.replace("ACCESS_TOKEN", try curl.getVar(alloc, "access_token"));
success = if (curl.addFunction("findFolder", try setup_command.getAsString(alloc))) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
// Register findFile; registration sends no request.
setup_command.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\"") catch {};
setup_replacements = setup_command.replace("ACCESS_TOKEN", try curl.getVar(alloc, "access_token"));
success = if (curl.addFunction("findFile", try setup_command.getAsString(alloc))) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
// Register findDestination; registration sends no request.
setup_command.setString("curl -X GET \"https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\"") catch {};
setup_replacements = setup_command.replace("ACCESS_TOKEN", try curl.getVar(alloc, "access_token"));
success = if (curl.addFunction("findDestination", try setup_command.getAsString(alloc))) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
// Register getFileDetails; registration sends no request.
setup_command.setString("curl -X GET \"https://api.box.com/2.0/files/{{file_id}}?fields=id,sha1,file_version\" -H \"Authorization: Bearer ACCESS_TOKEN\"") catch {};
setup_replacements = setup_command.replace("ACCESS_TOKEN", try curl.getVar(alloc, "access_token"));
success = if (curl.addFunction("getFileDetails", try setup_command.getAsString(alloc))) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
// Register getEnterprise; registration sends no request.
setup_command.setString("curl -X GET \"https://api.box.com/2.0/users/me?fields=enterprise\" -H \"Authorization: Bearer ACCESS_TOKEN\"") catch {};
setup_replacements = setup_command.replace("ACCESS_TOKEN", try curl.getVar(alloc, "access_token"));
success = if (curl.addFunction("getEnterprise", try setup_command.getAsString(alloc))) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
// Register output rules once. Chilkat 11.7.0 evaluates {{name}} variables
// when extracting each output, using the current value at that time.
success = if (curl.addOutput2("findParent", "entries", "name", "{{parent_name}}", true, "id", "parent_id")) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
success = if (curl.addOutput2("findFolder", "entries", "name", "{{folder_name}}", true, "id", "folder_id")) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
success = if (curl.addOutput2("findFile", "entries", "name", "{{file_name}}", true, "id", "file_id")) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
success = if (curl.addOutput2("findDestination", "entries", "name", "{{destination_name}}", true, "id", "destination_id")) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
success = if (curl.addOutput("getFileDetails", "file_version.id", "file_version_id")) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
success = if (curl.addOutput("getFileDetails", "sha1", "file_sha1")) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
success = if (curl.addOutput("getEnterprise", "enterprise.id", "enterprise_id")) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
// 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.
const parent_name = "/";
const folder_name = "images";
const file_name = "penguins.jpg";
if ((!std.mem.eql(u8, try curl.getVar(alloc, "parent_name"), parent_name)) or ((std.mem.eql(u8, parent_name, "/")) and (!curl.varDefined("parent_id")))) {
curl.setVar("parent_name", parent_name);
curl.clearVar("parent_id");
curl.clearVar("folder_id");
curl.clearVar("file_id");
curl.clearVar("file_version_id");
curl.clearVar("file_sha1");
if (std.mem.eql(u8, parent_name, "/")) {
curl.setVar("parent_id", "0");
}
}
if (!std.mem.eql(u8, try curl.getVar(alloc, "folder_name"), folder_name)) {
curl.setVar("folder_name", folder_name);
curl.clearVar("folder_id");
curl.clearVar("file_id");
curl.clearVar("file_version_id");
curl.clearVar("file_sha1");
}
if (!std.mem.eql(u8, try curl.getVar(alloc, "file_name"), file_name)) {
curl.setVar("file_name", file_name);
curl.clearVar("file_id");
curl.clearVar("file_version_id");
curl.clearVar("file_sha1");
}
curl.setVar("local_path", "qa_output/penguins.jpg");
// Operation 1: get information by name. This resolves folder_id and file_id.
curl.clearTargetOutput("*");
const authorized_command1 = try chilkat.StringBuilder.init();
defer authorized_command1.deinit();
authorized_command1.setString("curl -X GET \"https://api.box.com/2.0/files/{{file_id}}?fields=id,name\" -H \"Authorization: Bearer {{access_token}}\"") catch {};
_ = authorized_command1.replace("{{access_token}}", try curl.getVar(alloc, "access_token"));
success = if (curl.doYourThing(try authorized_command1.getAsString(alloc))) true else |_| false;
if ((!success) or (curl.getStatusCode() != 200)) {
std.debug.print("Box request failed. HTTP status: {d}\n", .{curl.getStatusCode()});
std.debug.print("Failure reason: {d}\n", .{curl.getFailReason()});
std.debug.print("{s}\n", .{try curl.getResponseBodyStr(alloc)});
return;
}
// Operation 2: keep the same object and IDs. Only the final download is needed.
const warm_plan = try chilkat.JsonObject.init();
defer warm_plan.deinit();
warm_plan.setEmitCompact(false);
const authorized_command2 = try chilkat.StringBuilder.init();
defer authorized_command2.deinit();
authorized_command2.setString("curl -X GET \"https://api.box.com/2.0/files/{{file_id}}/content\" -H \"Authorization: Bearer {{access_token}}\" -L -o \"{{local_path}}\"") catch {};
_ = authorized_command2.replace("{{access_token}}", try curl.getVar(alloc, "access_token"));
success = if (curl.examinePlan(try authorized_command2.getAsString(alloc), warm_plan)) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
std.debug.print("{s}\n", .{try warm_plan.emit(alloc)});
curl.clearTargetOutput("*");
const authorized_command3 = try chilkat.StringBuilder.init();
defer authorized_command3.deinit();
authorized_command3.setString("curl -X GET \"https://api.box.com/2.0/files/{{file_id}}/content\" -H \"Authorization: Bearer {{access_token}}\" -L -o \"{{local_path}}\"") catch {};
_ = authorized_command3.replace("{{access_token}}", try curl.getVar(alloc, "access_token"));
success = if (curl.doYourThing(try authorized_command3.getAsString(alloc))) true else |_| false;
if ((!success) or (curl.getStatusCode() != 200)) {
std.debug.print("Box request failed. HTTP status: {d}\n", .{curl.getStatusCode()});
std.debug.print("Failure reason: {d}\n", .{curl.getFailReason()});
std.debug.print("{s}\n", .{try curl.getResponseBodyStr(alloc)});
return;
}
// Operation 3: explicitly invalidate file state, retaining the known folder.
// Here we select the same name so this demonstration needs only one real file.
// Substitute another filename to switch files in this folder.
// The existing output rule reads the current file_name; do not register it again.
curl.clearVar("file_id");
curl.clearVar("file_version_id");
curl.clearVar("file_sha1");
curl.setVar("file_name", "penguins.jpg");
curl.setVar("local_path", "qa_output/penguins-copy.jpg");
const authorized_command4 = try chilkat.StringBuilder.init();
defer authorized_command4.deinit();
authorized_command4.setString("curl -X GET \"https://api.box.com/2.0/files/{{file_id}}/content\" -H \"Authorization: Bearer {{access_token}}\" -L -o \"{{local_path}}\"") catch {};
_ = authorized_command4.replace("{{access_token}}", try curl.getVar(alloc, "access_token"));
success = if (curl.examinePlan(try authorized_command4.getAsString(alloc), warm_plan)) true else |_| false;
if (!success) {
std.debug.print("{s}\n", .{try curl.getLastErrorText(alloc)});
return;
}
std.debug.print("{s}\n", .{try warm_plan.emit(alloc)});
curl.clearTargetOutput("*");
const authorized_command5 = try chilkat.StringBuilder.init();
defer authorized_command5.deinit();
authorized_command5.setString("curl -X GET \"https://api.box.com/2.0/files/{{file_id}}/content\" -H \"Authorization: Bearer {{access_token}}\" -L -o \"{{local_path}}\"") catch {};
_ = authorized_command5.replace("{{access_token}}", try curl.getVar(alloc, "access_token"));
success = if (curl.doYourThing(try authorized_command5.getAsString(alloc))) true else |_| false;
if ((!success) or (curl.getStatusCode() != 200)) {
std.debug.print("Box request failed. HTTP status: {d}\n", .{curl.getStatusCode()});
std.debug.print("Failure reason: {d}\n", .{curl.getFailReason()});
std.debug.print("{s}\n", .{try curl.getResponseBodyStr(alloc)});
return;
}
// Changing parent_name invalidates parent_id, folder_id, and file state.
// Changing folder_name invalidates folder_id and file state.
// Changing destination_name invalidates destination_id.
}