(Unicode C) 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.

Note: This example requires Chilkat v9.5.0.97 or greater.

Chilkat C/C++ Library Downloads
MS Visual C/C++ Linux/CentOS C/C++ Alpine Linux C/C++ MAC OS X C/C++	armhf/aarch64 C/C++ C++ Builder iOS C/C++ Android C/C++	Solaris C/C++ MinGW C/C++

#include <C_CkJsonObjectW.h>
#include <C_CkHttpW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkFileAccessW.h>
#include <C_CkUrlW.h>
#include <C_CkHttpRequestW.h>
#include <C_CkStringBuilderW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkJsonObjectW json;
    HCkHttpW http;
    const wchar_t *url;
    HCkHttpResponseW resp;
    HCkJsonObjectW jsonSession;
    int fragSize;
    const wchar_t *localFilePath;
    HCkFileAccessW fac;
    int fileSize;
    int numFragments;
    int i;
    HCkUrlW uploadUrl;
    HCkHttpRequestW req;
    HCkStringBuilderW sbOffset;
    HCkStringBuilderW sbNumBytes;
    HCkStringBuilderW sbRange;
    int bytesRemaining;
    int chunkSize;
    int expectedStatusCode;
    int numReplaced;

    // 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
    json = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(json,L"client_id",L"2871da2c-8176-4b7f-869b-2311aa82e743");
    CkJsonObjectW_UpdateString(json,L"client_secret",L"2hu9Q~r5QuryUcEkNbg1btLtnfU1VUXzhSCG6brH");
    CkJsonObjectW_UpdateString(json,L"scope",L"https://graph.microsoft.com/.default");
    CkJsonObjectW_UpdateString(json,L"token_endpoint",L"https://login.microsoftonline.com/114d7ed6-71bf-4dbe-a866-748364121bf2/oauth2/v2.0/token");

    http = CkHttpW_Create();
    CkHttpW_putAuthToken(http,CkJsonObjectW_emit(json));

    // ----------------------------------------------------------------------------
    // 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

    CkHttpW_SetUrlVar(http,L"path_to_item",L"/somefolder/big.zip");
    CkHttpW_SetUrlVar(http,L"user_id",L"4fe732c3-322e-4a6b-b729-2fd1eb5c6104");
    url = L"https://graph.microsoft.com/v1.0/users/{$user_id}/drive/root:/{$path_to_item}:/createUploadSession";
    resp = CkHttpW_PostJson2(http,url,L"application/json",L"{}");
    if (CkHttpW_getLastMethodSuccess(http) != TRUE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkJsonObjectW_Dispose(json);
        CkHttpW_Dispose(http);
        return;
    }

    // If successful, a 200 status code is returned, with the session details (in JSON format).
    jsonSession = CkJsonObjectW_Create();
    CkJsonObjectW_putEmitCompact(jsonSession,FALSE);
    CkJsonObjectW_Load(jsonSession,CkHttpResponseW_bodyStr(resp));

    if (CkHttpResponseW_getStatusCode(resp) != 200) {

        wprintf(L"%s\n",CkJsonObjectW_emit(jsonSession));
        wprintf(L"Response status = %d\n",CkHttpResponseW_getStatusCode(resp));
        CkHttpResponseW_Dispose(resp);
        CkJsonObjectW_Dispose(json);
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(jsonSession);
        return;
    }

    CkHttpResponseW_Dispose(resp);

    wprintf(L"%s\n",CkJsonObjectW_emit(jsonSession));

    // 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.)

    fragSize = 320 * 1024;
    localFilePath = L"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.
    fac = CkFileAccessW_Create();
    fileSize = CkFileAccessW_FileSize(fac,localFilePath);

    // Open the file to get the number of fragments.
    success = CkFileAccessW_OpenForRead(fac,localFilePath);
    if (success == FALSE) {
        wprintf(L"%s\n",CkFileAccessW_lastErrorText(fac));
        CkJsonObjectW_Dispose(json);
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(jsonSession);
        CkFileAccessW_Dispose(fac);
        return;
    }

    numFragments = CkFileAccessW_GetNumBlocks(fac,fragSize);
    CkFileAccessW_FileClose(fac);

    i = 0;

    wprintf(L"fileSize = %d\n",fileSize);
    wprintf(L"numFragments = %d\n",numFragments);

    uploadUrl = CkUrlW_Create();
    CkUrlW_ParseUrl(uploadUrl,CkJsonObjectW_stringOf(jsonSession,L"uploadUrl"));

    CkJsonObjectW_putEmitCompact(json,FALSE);

    req = CkHttpRequestW_Create();
    CkHttpRequestW_putHttpVerb(req,L"PUT");
    CkHttpRequestW_putPath(req,CkUrlW_pathWithQueryParams(uploadUrl));
    CkHttpRequestW_putContentType(req,L"application/octet-stream");

    sbOffset = CkStringBuilderW_Create();
    sbNumBytes = CkStringBuilderW_Create();
    sbRange = CkStringBuilderW_Create();

    // 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.
    CkHttpW_putAuthToken(http,L"");

    bytesRemaining = fileSize;
    while (i < numFragments) {

        // 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.
        chunkSize = fragSize;
        expectedStatusCode = 202;
        if (bytesRemaining < chunkSize) {
            chunkSize = bytesRemaining;
            expectedStatusCode = 201;
        }

        wprintf(L"  this chunkSize = %d\n",chunkSize);

        // Indicate the fragment in the local file to be streamed in the upload.
        CkStringBuilderW_Clear(sbOffset);
        CkStringBuilderW_AppendInt(sbOffset,i * fragSize);
        CkStringBuilderW_Clear(sbNumBytes);
        CkStringBuilderW_AppendInt(sbNumBytes,chunkSize);
        CkHttpRequestW_StreamChunkFromFile(req,localFilePath,CkStringBuilderW_getAsString(sbOffset),CkStringBuilderW_getAsString(sbNumBytes));

        // The Content-Range header field must be set for this fragment.  For example:
        // Content-Range: bytes 0-25/128
        CkStringBuilderW_SetString(sbRange,L"bytes start-end/fileSize");
        numReplaced = CkStringBuilderW_ReplaceI(sbRange,L"start",i * fragSize);
        numReplaced = CkStringBuilderW_ReplaceI(sbRange,L"end",i * fragSize + chunkSize - 1);
        numReplaced = CkStringBuilderW_ReplaceI(sbRange,L"fileSize",fileSize);
        CkHttpRequestW_AddHeader(req,L"Content-Range",CkStringBuilderW_getAsString(sbRange));
        wprintf(L"  this content-range: %s\n",CkStringBuilderW_getAsString(sbRange));

        resp = CkHttpW_SynchronousRequest(http,CkUrlW_host(uploadUrl),443,TRUE,req);
        if (CkHttpW_getLastMethodSuccess(http) != TRUE) {
            wprintf(L"%s\n",CkHttpW_lastErrorText(http));
            CkJsonObjectW_Dispose(json);
            CkHttpW_Dispose(http);
            CkJsonObjectW_Dispose(jsonSession);
            CkFileAccessW_Dispose(fac);
            CkUrlW_Dispose(uploadUrl);
            CkHttpRequestW_Dispose(req);
            CkStringBuilderW_Dispose(sbOffset);
            CkStringBuilderW_Dispose(sbNumBytes);
            CkStringBuilderW_Dispose(sbRange);
            return;
        }

        CkJsonObjectW_Load(json,CkHttpResponseW_bodyStr(resp));
        // A 202 response status code indicates success.
        if (CkHttpResponseW_getStatusCode(resp) != expectedStatusCode) {

            wprintf(L"%s\n",CkJsonObjectW_emit(json));
            wprintf(L"Response status = %d\n",CkHttpResponseW_getStatusCode(resp));
            CkHttpResponseW_Dispose(resp);
            CkJsonObjectW_Dispose(json);
            CkHttpW_Dispose(http);
            CkJsonObjectW_Dispose(jsonSession);
            CkFileAccessW_Dispose(fac);
            CkUrlW_Dispose(uploadUrl);
            CkHttpRequestW_Dispose(req);
            CkStringBuilderW_Dispose(sbOffset);
            CkStringBuilderW_Dispose(sbNumBytes);
            CkStringBuilderW_Dispose(sbRange);
            return;
        }

        CkHttpResponseW_Dispose(resp);
        wprintf(L"%s\n",CkJsonObjectW_emit(json));
        wprintf(L"---- Chunk %d uploaded ----\n",i);

        bytesRemaining = bytesRemaining - chunkSize;
        i = i + 1;
    }

    wprintf(L"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


    CkJsonObjectW_Dispose(json);
    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(jsonSession);
    CkFileAccessW_Dispose(fac);
    CkUrlW_Dispose(uploadUrl);
    CkHttpRequestW_Dispose(req);
    CkStringBuilderW_Dispose(sbOffset);
    CkStringBuilderW_Dispose(sbNumBytes);
    CkStringBuilderW_Dispose(sbRange);

    }