Zig Requires Chilkat v11.0.0+
Zig
OneDrive -- Upload Large Files with an Upload Session
See more OneDrive Examples
Demonstrates how to upload large files with an upload session. See OneDrive Upload Session for more general information.Chilkat Zig Downloads
const std = @import("std");
const chilkat = @import("chilkat");
pub fn main(init: std.process.Init) !void {
const alloc = init.arena.allocator();
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// This example uses the OAuth client credentials flow.
// See How to Create an Azure App Registration for OAuth 2.0 Client Credentials
// Use your client ID, client secret, and tenant ID in the following lines
const json = try chilkat.JsonObject.init();
defer json.deinit();
json.updateString("client_id", "2871da2c-8176-4b7f-869b-2311aa82e743") catch {};
json.updateString("client_secret", "2hu9Q~r5QuryUcEkNbg1btLtnfU1VUXzhSCG6brH") catch {};
json.updateString("scope", "https://graph.microsoft.com/.default") catch {};
json.updateString("token_endpoint", "https://login.microsoftonline.com/114d7ed6-71bf-4dbe-a866-748364121bf2/oauth2/v2.0/token") catch {};
const http = try chilkat.Http.init();
defer http.deinit();
http.setAuthToken(try json.emit(alloc));
// ----------------------------------------------------------------------------
// Step 1: Create an upload session
// To begin a large file upload, your app must first request a new upload session. This creates a
// temporary storage location where the bytes of the file will be saved until the complete file is uploaded.
// Once the last byte of the file has been uploaded the upload session is completed and the final file is shown
// in the destination folder.
// Send the following POST to create an upload session:
// If not using "me", then the path should be /v1.0/users/{id | userPrincipalName}/...
// POST /v1.0/users/{user_id}/drive/root:/{path_to_item}:/createUploadSession
http.setUrlVar("path_to_item", "/somefolder/big.zip") catch {};
http.setUrlVar("user_id", "4fe732c3-322e-4a6b-b729-2fd1eb5c6104") catch {};
const url = "https://graph.microsoft.com/v1.0/users/{$user_id}/drive/root:/{$path_to_item}:/createUploadSession";
const resp = try chilkat.HttpResponse.init();
defer resp.deinit();
http.httpStr("POST", url, "{}", "utf-8", "application/json", resp) catch {
std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
return;
};
// If successful, a 200 status code is returned, with the session details (in JSON format).
const json_session = try chilkat.JsonObject.init();
defer json_session.deinit();
json_session.setEmitCompact(false);
json_session.load(try resp.getBodyStr(alloc)) catch {};
if (resp.getStatusCode() != 200) {
std.debug.print("{s}\n", .{try json_session.emit(alloc)});
std.debug.print("Response status = {d}\n", .{resp.getStatusCode()});
return;
}
std.debug.print("{s}\n", .{try json_session.emit(alloc)});
// A sample response:
// {
// "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.uploadSession",
// "uploadUrl": "https://api.onedrive.com/rup/3a33fceb9b74cc15/eyJSZXNvdXJjZUlEI ... 65yDYUiS3JTDnnhqCHxw",
// "expirationDateTime": "2017-06-11T12:40:23.239Z",
// "nextExpectedRanges": [
// "0-"
// ]
// }
//
// ----------------------------------------------------------------------------
// Step 2: Upload Data in Segments (a.k.a. Fragments or Chunks)
// Microsoft states this requirement: Use a fragment size that is a multiple of 320 KiB (320 * 1024 bytes).
// Failing to use a fragment size that is a multiple of 320 KiB can result in large file transfers failing after the
// last fragment is uploaded. (Note: This is a detail imposed by Microsoft's OneDrive server-side implementation.)
const frag_size = 320 * 1024;
const local_file_path = "qa_data/zips/big.zip";
// Upload the file big.zip in 320KiB segments.
// Note: The FileSize method returns a signed 32-bit integer. If the file is potentially larger than 2GB, call FileSizeStr instead to return
// the size of the file as a string, then convert to an integer value.
const fac = try chilkat.FileAccess.init();
defer fac.deinit();
const file_size = fac.fileSize(local_file_path);
// Open the file to get the number of fragments.
fac.openForRead(local_file_path) catch {
std.debug.print("{s}\n", .{try fac.getLastErrorText(alloc)});
return;
};
const num_fragments = fac.getNumBlocks(frag_size);
fac.fileClose();
var i: i32 = 0;
std.debug.print("fileSize = {d}\n", .{file_size});
std.debug.print("numFragments = {d}\n", .{num_fragments});
const upload_url = try chilkat.Url.init();
defer upload_url.deinit();
upload_url.parseUrl(try json_session.stringOf(alloc, "uploadUrl")) catch {};
json.setEmitCompact(false);
const req = try chilkat.HttpRequest.init();
defer req.deinit();
req.setHttpVerb("PUT");
req.setPath(try upload_url.getPathWithQueryParams(alloc));
req.setContentType("application/octet-stream");
const sb_offset = try chilkat.StringBuilder.init();
defer sb_offset.deinit();
const sb_num_bytes = try chilkat.StringBuilder.init();
defer sb_num_bytes.deinit();
const sb_range = try chilkat.StringBuilder.init();
defer sb_range.deinit();
// IMPORTANT: The uploadUrl is a temporary URL to be used to upload the fragment.
// It requires no authentication (because the URL itself could only have been obtained from an authenticated
// request to start the upload session). Therefore, do not allow the upload URL to be publicly seen,
// otherwise anybody could upload to your OneDrive.
http.setAuthToken("");
var bytes_remaining: i32 = file_size;
while (i < num_fragments) {
// The success response code for intermediate chunks is 202,
// whereas the final chunk will have a 201 success response where
// the response body is the JSON DriveItem.
var chunk_size: i32 = frag_size;
var expected_status_code: i32 = 202;
if (bytes_remaining < chunk_size) {
chunk_size = bytes_remaining;
expected_status_code = 201;
}
std.debug.print(" this chunkSize = {d}\n", .{chunk_size});
// Indicate the fragment in the local file to be streamed in the upload.
sb_offset.clear();
sb_offset.appendInt(i * frag_size) catch {};
sb_num_bytes.clear();
sb_num_bytes.appendInt(chunk_size) catch {};
req.streamChunkFromFile(local_file_path, try sb_offset.getAsString(alloc), try sb_num_bytes.getAsString(alloc)) catch {};
// The Content-Range header field must be set for this fragment. For example:
// Content-Range: bytes 0-25/128
sb_range.setString("bytes start-end/fileSize") catch {};
var num_replaced: i32 = sb_range.replaceI("start", i * frag_size);
num_replaced = sb_range.replaceI("end", i * frag_size + chunk_size - 1);
num_replaced = sb_range.replaceI("fileSize", file_size);
req.addHeader("Content-Range", try sb_range.getAsString(alloc));
std.debug.print(" this content-range: {s}\n", .{try sb_range.getAsString(alloc)});
const domain = try upload_url.getHost(alloc);
http.httpSReq(domain, 443, true, req, resp) catch {
std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
return;
};
json.load(try resp.getBodyStr(alloc)) catch {};
// A 202 response status code indicates success.
if (resp.getStatusCode() != expected_status_code) {
std.debug.print("{s}\n", .{try json.emit(alloc)});
std.debug.print("Response status = {d}\n", .{resp.getStatusCode()});
return;
}
std.debug.print("{s}\n", .{try json.emit(alloc)});
std.debug.print("---- Chunk {d} uploaded ----\n", .{i});
bytes_remaining = bytes_remaining - chunk_size;
i = i + 1;
}
std.debug.print("data uploaded.\n", .{});
// ----------------------------------------------------------------------------
// Sample output for the above session:
// {
// "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.uploadSession",
// "uploadUrl": "https://api.onedrive.com/rup/3a33fceb9b74cc15/eyJSZXNvd ... QoKK2iuh1A",
// "expirationDateTime": "2017-06-11T14:04:45.438Z",
// "nextExpectedRanges": [
// "0-"
// ]
// }
//
// fileSize = 1366807
// numFragments = 5
// this chunkSize = 327680
// this content-range: bytes 0-327679/1366807
// {
// "expirationDateTime": "2017-06-11T14:04:45.438Z",
// "nextExpectedRanges": [
// "327680-1366806"
// ]
// }
//
// ---- Chunk 0 uploaded ----
// this chunkSize = 327680
// this content-range: bytes 327680-655359/1366807
// {
// "expirationDateTime": "2017-06-11T14:04:45.438Z",
// "nextExpectedRanges": [
// "655360-1366806"
// ]
// }
//
// ---- Chunk 1 uploaded ----
// this chunkSize = 327680
// this content-range: bytes 655360-983039/1366807
// {
// "expirationDateTime": "2017-06-11T14:04:45.438Z",
// "nextExpectedRanges": [
// "983040-1366806"
// ]
// }
//
// ---- Chunk 2 uploaded ----
// this chunkSize = 327680
// this content-range: bytes 983040-1310719/1366807
// {
// "expirationDateTime": "2017-06-11T14:04:45.438Z",
// "nextExpectedRanges": [
// "1310720-1366806"
// ]
// }
//
// ---- Chunk 3 uploaded ----
// this chunkSize = 56087
// this content-range: bytes 1310720-1366806/1366807
// {
// "createdBy": {
// "application": {
// "displayName": "Chilkat",
// "id": "441c9990"
// },
// "user": {
// "id": "3a33fceb9b74cc15"
// }
// },
// "createdDateTime": "2017-06-04T14:04:47.247Z",
// "cTag": "aYzozQTMzRkNFQjlCNzRDQzE1ITQ4NjguMjU3",
// "eTag": "aM0EzM0ZDRUI5Qjc0Q0MxNSE0ODY4LjA",
// "id": "3A33FCEB9B74CC15!4868",
// "lastModifiedBy": {
// "application": {
// "displayName": "Chilkat",
// "id": "441c9990"
// },
// "user": {
// "id": "3a33fceb9b74cc15"
// }
// },
// "lastModifiedDateTime": "2017-06-04T14:04:47.247Z",
// "name": "big.zip",
// "parentReference": {
// "driveId": "3a33fceb9b74cc15",
// "id": "3A33FCEB9B74CC15!4862",
// "name": "someFolder",
// "path": "/drive/root:/someFolder"
// },
// "size": 1366807,
// "webUrl": "https://1drv.ms/u/s!ABXMdJvr_DM6pgQ",
// "file": {
// "hashes": {
// "sha1Hash": "252059AA13004220DB912B97D4D3FF9599CCD8D9"
// },
// "mimeType": "application/zip"
// },
// "fileSystemInfo": {
// "createdDateTime": "2017-06-04T14:04:47.246Z",
// "lastModifiedDateTime": "2017-06-04T14:04:47.246Z"
// },
// "tags": [
// ],
// "lenses": [
// ]
// }
//
// Response status = 201
}