Xbase++ Requires Chilkat v11.0.0+
Xbase++
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 Xbase++ Downloads
LOCAL nSuccess
LOCAL oJson
LOCAL oHttp
LOCAL cUrl
LOCAL oResp
LOCAL oJsonSession
LOCAL nFragSize
LOCAL cLocalFilePath
LOCAL oFac
LOCAL nFileSize
LOCAL nNumFragments
LOCAL i
LOCAL oUploadUrl
LOCAL oReq
LOCAL oSbOffset
LOCAL oSbNumBytes
LOCAL oSbRange
LOCAL nBytesRemaining
LOCAL nChunkSize
LOCAL nExpectedStatusCode
LOCAL nNumReplaced
LOCAL cDomain
nSuccess := 0
// 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
oJson := CreateObject("Chilkat.JsonObject")
oJson:UpdateString("client_id", "2871da2c-8176-4b7f-869b-2311aa82e743")
oJson:UpdateString("client_secret", "2hu9Q~r5QuryUcEkNbg1btLtnfU1VUXzhSCG6brH")
oJson:UpdateString("scope", "https://graph.microsoft.com/.default")
oJson:UpdateString("token_endpoint", "https://login.microsoftonline.com/114d7ed6-71bf-4dbe-a866-748364121bf2/oauth2/v2.0/token")
oHttp := CreateObject("Chilkat.Http")
oHttp:AuthToken := oJson:Emit()
// ----------------------------------------------------------------------------
// 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
oHttp:SetUrlVar("path_to_item", "/somefolder/big.zip")
oHttp:SetUrlVar("user_id", "4fe732c3-322e-4a6b-b729-2fd1eb5c6104")
cUrl := "https://graph.microsoft.com/v1.0/users/{$user_id}/drive/root:/{$path_to_item}:/createUploadSession"
oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpStr("POST", cUrl, "{}", "utf-8", "application/json", oResp)
IF (nSuccess == 0)
? oHttp:LastErrorText
oJson:destroy()
oHttp:destroy()
oResp:destroy()
RETURN
ENDIF
// If successful, a 200 status code is returned, with the session details (in JSON format).
oJsonSession := CreateObject("Chilkat.JsonObject")
oJsonSession:EmitCompact := 0
oJsonSession:Load(oResp:BodyStr)
IF (oResp:StatusCode != 200)
? oJsonSession:Emit()
? "Response status = " + Str(oResp:StatusCode)
oJson:destroy()
oHttp:destroy()
oResp:destroy()
oJsonSession:destroy()
RETURN
ENDIF
? oJsonSession:Emit()
// 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.)
nFragSize := 320 * 1024
cLocalFilePath := "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.
oFac := CreateObject("Chilkat.FileAccess")
nFileSize := oFac:FileSize(cLocalFilePath)
// Open the file to get the number of fragments.
nSuccess := oFac:OpenForRead(cLocalFilePath)
IF (nSuccess == 0)
? oFac:LastErrorText
oJson:destroy()
oHttp:destroy()
oResp:destroy()
oJsonSession:destroy()
oFac:destroy()
RETURN
ENDIF
nNumFragments := oFac:GetNumBlocks(nFragSize)
oFac:FileClose()
i := 0
? "fileSize = " + Str(nFileSize)
? "numFragments = " + Str(nNumFragments)
oUploadUrl := CreateObject("Chilkat.Url")
oUploadUrl:ParseUrl(oJsonSession:StringOf("uploadUrl"))
oJson:EmitCompact := 0
oReq := CreateObject("Chilkat.HttpRequest")
oReq:HttpVerb := "PUT"
oReq:Path := oUploadUrl:PathWithQueryParams
oReq:ContentType := "application/octet-stream"
oSbOffset := CreateObject("Chilkat.StringBuilder")
oSbNumBytes := CreateObject("Chilkat.StringBuilder")
oSbRange := CreateObject("Chilkat.StringBuilder")
// 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.
oHttp:AuthToken := ""
nBytesRemaining := nFileSize
DO WHILE i < nNumFragments
// 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.
nChunkSize := nFragSize
nExpectedStatusCode := 202
IF (nBytesRemaining < nChunkSize)
nChunkSize := nBytesRemaining
nExpectedStatusCode := 201
ENDIF
? " this chunkSize = " + Str(nChunkSize)
// Indicate the fragment in the local file to be streamed in the upload.
oSbOffset:Clear()
oSbOffset:AppendInt(i * nFragSize)
oSbNumBytes:Clear()
oSbNumBytes:AppendInt(nChunkSize)
oReq:StreamChunkFromFile(cLocalFilePath, oSbOffset:GetAsString(), oSbNumBytes:GetAsString())
// The Content-Range header field must be set for this fragment. For example:
// Content-Range: bytes 0-25/128
oSbRange:SetString("bytes start-end/fileSize")
nNumReplaced := oSbRange:ReplaceI("start", i * nFragSize)
nNumReplaced := oSbRange:ReplaceI("end", i * nFragSize + nChunkSize - 1)
nNumReplaced := oSbRange:ReplaceI("fileSize", nFileSize)
oReq:AddHeader("Content-Range", oSbRange:GetAsString())
? " this content-range: " + oSbRange:GetAsString()
cDomain := oUploadUrl:Host
nSuccess := oHttp:HttpSReq(cDomain, 443, 1, oReq, oResp)
IF (nSuccess == 0)
? oHttp:LastErrorText
oJson:destroy()
oHttp:destroy()
oResp:destroy()
oJsonSession:destroy()
oFac:destroy()
oUploadUrl:destroy()
oReq:destroy()
oSbOffset:destroy()
oSbNumBytes:destroy()
oSbRange:destroy()
RETURN
ENDIF
oJson:Load(oResp:BodyStr)
// A 202 response status code indicates success.
IF (oResp:StatusCode != nExpectedStatusCode)
? oJson:Emit()
? "Response status = " + Str(oResp:StatusCode)
oJson:destroy()
oHttp:destroy()
oResp:destroy()
oJsonSession:destroy()
oFac:destroy()
oUploadUrl:destroy()
oReq:destroy()
oSbOffset:destroy()
oSbNumBytes:destroy()
oSbRange:destroy()
RETURN
ENDIF
? oJson:Emit()
? "---- Chunk " + Str(i) + " uploaded ----"
nBytesRemaining := nBytesRemaining - nChunkSize
i := i + 1
ENDDO
? "data uploaded."
// ----------------------------------------------------------------------------
// 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
oJson:destroy()
oHttp:destroy()
oResp:destroy()
oJsonSession:destroy()
oFac:destroy()
oUploadUrl:destroy()
oReq:destroy()
oSbOffset:destroy()
oSbNumBytes:destroy()
oSbRange:destroy()