(PureBasic) OneDrive -- Streaming File Upload

See more OneDrive Examples

Uploads a local file by path to the signed-in user's OneDrive. This uses OneDrive's simple upload API to upload in a single API call. Uploading in this way only supports files up to 4MB in size. The 4MB limitation is a OneDrive limitation, not a Chilkat limitation. (See the other example(s) for uploading larger files.)

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

For more information, see https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_put_content?view=odsp-graph-online

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttpRequest.pb"

Procedure ChilkatExample()

    ; 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.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"client_id","2871da2c-8176-4b7f-869b-2311aa82e743")
    CkJsonObject::ckUpdateString(json,"client_secret","2hu9Q~r5QuryUcEkNbg1btLtnfU1VUXzhSCG6brH")
    CkJsonObject::ckUpdateString(json,"scope","https://graph.microsoft.com/.default")
    CkJsonObject::ckUpdateString(json,"token_endpoint","https://login.microsoftonline.com/114d7ed6-71bf-4dbe-a866-748364121bf2/oauth2/v2.0/token")

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttp::setCkAuthToken(http, CkJsonObject::ckEmit(json))

    ; To upload in a single HTTP request, send a PUT request such as the following:

    ; 	PUT /v1.0/users/{$user-id}/drive/root:/{item-path}:/content
    ; 	Content-type: text/plain
    ; 	Content-Length: <the actual content length>
    ; 
    ; 	The contents of the file goes here.

    ; Note: This example can upload any type of file.
    ; Chilkat automatically adds the Content-Length header.

    req.i = CkHttpRequest::ckCreate()
    If req.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpRequest::setCkHttpVerb(req, "PUT")
    ; Use your actual user-id instead of "4fe732c3-322e-4a6b-b729-2fd1eb5c6104"
    CkHttpRequest::setCkPath(req, "/v1.0/users/4fe732c3-322e-4a6b-b729-2fd1eb5c6104/drive/root:/TestDir/penguins.jpg:/content")
    ; Indicate the local file to be streamed in the upload.
    CkHttpRequest::ckStreamBodyFromFile(req,"qa_data/jpg/penguins.jpg")
    ; If you're uploading a file and don't know what the Content-Type should be,
    ; just use "application/octet-stream".  See below for an example..
    CkHttpRequest::setCkContentType(req, "image/jpeg")

    resp.i = CkHttp::ckSynchronousRequest(http,"graph.microsoft.com",443,1,req)
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkJsonObject::ckDispose(json)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        ProcedureReturn
    EndIf

    ; If successful, a 201 status code is returned, with the driveItem object in the response body for the newly created file.
    CkJsonObject::setCkEmitCompact(json, 0)
    CkJsonObject::ckLoad(json,CkHttpResponse::ckBodyStr(resp))

    If CkHttpResponse::ckStatusCode(resp) <> 201

        ; Here is an example of an error:

        ; 		{
        ; 		  "error": {
        ; 		    "code": "nameAlreadyExists",
        ; 		    "message": "An item with the same name already exists under the parent",
        ; 		    "innerError": {
        ; 		      "request-id": "22302ba5-b885-4b67-9e20-8f6801aec372",
        ; 		      "date": "2017-06-03T14:22:27"
        ; 		    }
        ; 		  }
        ; 		}
        ; 
        ; 		Response status = 409

        Debug CkJsonObject::ckEmit(json)
        Debug "Response status = " + Str(CkHttpResponse::ckStatusCode(resp))
        CkHttpResponse::ckDispose(resp)

        CkJsonObject::ckDispose(json)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ; Success.  Examine the driveItem JSON object:
    Debug CkJsonObject::ckEmit(json)
    Debug "-- Success --"

    ; Here is a sample successful response:

    ; 	{
    ; 	  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/drive/root/$entity",
    ; 	  "@microsoft.graph.downloadUrl": "https://s5ucmg.dm2301.livefilestore.com/y4p0MT4NGBshn3EMBjrq8NuU3c_3Bt4DBz0BjZiQPNhiCDj3DjXEHrMr71M6wAGRrvT6WJmPIqNo_lxBP4Uen5MXFVtO3Dz_tdZ531hC_J9fb-eU6CoEmvjonwapmTorJb6hbi6g8VNxBQLItDyVgWM-InmxoNRo0N6xpcAuIbKZccN5vuctIs-Wqxefaza19thlu__bOl8kfG_SkgsrbBzKdTjOS0phBhIi8kYo9wG25k",
    ; 	  "createdBy": {
    ; 	    "application": {
    ; 	      "displayName": "Chilkat",
    ; 	      "id": "441c9990"
    ; 	    },
    ; 	    "user": {
    ; 	      "displayName": "Matt Smith",
    ; 	      "id": "3a33fceb9b74cc15"
    ; 	    }
    ; 	  },
    ; 	  "createdDateTime": "2017-06-03T14:23:52.153Z",
    ; 	  "cTag": "aYzozQTMzRkNFQjlCNzRDQzE1ITQ4NjMuMjU3",
    ; 	  "eTag": "aM0EzM0ZDRUI5Qjc0Q0MxNSE0ODYzLjA",
    ; 	  "id": "3A33FCEB9B74CC15!4863",
    ; 	  "lastModifiedBy": {
    ; 	    "application": {
    ; 	      "displayName": "Chilkat",
    ; 	      "id": "441c9990"
    ; 	    },
    ; 	    "user": {
    ; 	      "displayName": "Matt Smith",
    ; 	      "id": "3a33fceb9b74cc15"
    ; 	    }
    ; 	  },
    ; 	  "lastModifiedDateTime": "2017-06-03T14:23:52.153Z",
    ; 	  "name": "penguins.jpg",
    ; 	  "parentReference": {
    ; 	    "driveId": "3a33fceb9b74cc15",
    ; 	    "id": "3A33FCEB9B74CC15!4862",
    ; 	    "name": "someFolder",
    ; 	    "path": "/drive/root:/someFolder"
    ; 	  },
    ; 	  "size": 777835,
    ; 	  "webUrl": "https://1drv.ms/i/s!ABXMdJvr_DM6pX8",
    ; 	  "file": {
    ; 	    "hashes": {
    ; 	      "sha1Hash": "DF7BE9DC4F467187783ACA68C7CE98E4DF2172D0"
    ; 	    },
    ; 	    "mimeType": "image/jpeg",
    ; 	    "processingMetadata": true
    ; 	  },
    ; 	  "fileSystemInfo": {
    ; 	    "createdDateTime": "2017-06-03T14:23:52.153Z",
    ; 	    "lastModifiedDateTime": "2017-06-03T14:23:52.153Z"
    ; 	  }
    ; 	}

    ; ------------------------------------------------------------------------------------
    ; Now let's upload some file where we don't know what the Content-Type should be.
    ; 
    ; In this case, we're uploading the same JPG file but instead of providing "image/jpeg" for the
    ; Content-Type, we provide "application/octet-stream".  ("application/octet-stream" is the general
    ; HTTP content-type used for anything unkown.  "octet" is a synonym for "byte".  It's just a way of
    ; saying: Here's a stream of bytes that comprise the file.)

    ; Also, you'll notice in the successful JSON response (below), that Microsoft automatically
    ; detected the Content-Type as "image/jpeg", because the mimeType is set as such.
    ; It is likely Microsoft set the MIME type (i.e. Content-Type) based on the file extension, or even better
    ; it may have determined the MIME type by examining the initial bytes of the file to find the standard 
    ; identifying markers that signify common file types such as PDF, JPG, ZIP, and many more.

    ; In a nutshell:  Don't worry about setting the ContentType precisely. If you know it, great.  If not, just
    ; use "application/octet-stream".

    CkHttpRequest::setCkHttpVerb(req, "PUT")
    ; Use your actual user-id instead of "4fe732c3-322e-4a6b-b729-2fd1eb5c6104"
    CkHttpRequest::setCkPath(req, "/v1.0/users/4fe732c3-322e-4a6b-b729-2fd1eb5c6104/drive/root:/TestDir/penguins2.jpg:/content")
    CkHttpRequest::ckStreamBodyFromFile(req,"qa_data/jpg/penguins.jpg")
    CkHttpRequest::setCkContentType(req, "application/octet-stream")

    resp = CkHttp::ckSynchronousRequest(http,"graph.microsoft.com",443,1,req)
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkJsonObject::ckDispose(json)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoad(json,CkHttpResponse::ckBodyStr(resp))
    If CkHttpResponse::ckStatusCode(resp) <> 201
        Debug CkJsonObject::ckEmit(json)
        Debug "Response status = " + Str(CkHttpResponse::ckStatusCode(resp))
        CkHttpResponse::ckDispose(resp)

        CkJsonObject::ckDispose(json)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ; Success.  Examine the driveItem JSON object:
    Debug CkJsonObject::ckEmit(json)
    Debug "-- Success --"

    ; 	{
    ; 	  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/drive/root/$entity",
    ; 	  "@microsoft.graph.downloadUrl": "https://s5ucmg.dm2301.livefilestore.com/y4pKX-VIcxZfOUa1iYzGo7K4dX8an2xkcL7i-bb1YLE2ralUEPAixycWzekSn6-lUl5ojvZLQzpce45pgX2SIZfHe9l9scGcYu1viPHxKQ67Xh5b6iMhQNwbjbPQdr3ez6DET55DL25f7kS-fnksazALBtHiTLYayEqMc3WokdQYPsCj7AtzyNPzgKh6ye9R0FxM6ZRS5y6ARY23dIWuGkAKE9lKLgC4PPjvgNBBvl7zi8",
    ; 	  "createdBy": {
    ; 	    "application": {
    ; 	      "displayName": "Chilkat",
    ; 	      "id": "441c9990"
    ; 	    },
    ; 	    "user": {
    ; 	      "displayName": "Matt Smith",
    ; 	      "id": "3a33fceb9b74cc15"
    ; 	    }
    ; 	  },
    ; 	  "createdDateTime": "2017-06-03T14:30:22.017Z",
    ; 	  "cTag": "aYzozQTMzRkNFQjlCNzRDQzE1ITQ4NjUuMjU3",
    ; 	  "eTag": "aM0EzM0ZDRUI5Qjc0Q0MxNSE0ODY1LjA",
    ; 	  "id": "3A33FCEB9B74CC15!4865",
    ; 	  "lastModifiedBy": {
    ; 	    "application": {
    ; 	      "displayName": "Chilkat",
    ; 	      "id": "441c9990"
    ; 	    },
    ; 	    "user": {
    ; 	      "displayName": "Matt Smith",
    ; 	      "id": "3a33fceb9b74cc15"
    ; 	    }
    ; 	  },
    ; 	  "lastModifiedDateTime": "2017-06-03T14:30:22.017Z",
    ; 	  "name": "penguins2.jpg",
    ; 	  "parentReference": {
    ; 	    "driveId": "3a33fceb9b74cc15",
    ; 	    "id": "3A33FCEB9B74CC15!4862",
    ; 	    "name": "someFolder",
    ; 	    "path": "/drive/root:/someFolder"
    ; 	  },
    ; 	  "size": 777835,
    ; 	  "webUrl": "https://1drv.ms/i/s!ABXMdJvr_DM6pgE",
    ; 	  "file": {
    ; 	    "hashes": {
    ; 	      "sha1Hash": "DF7BE9DC4F467187783ACA68C7CE98E4DF2172D0"
    ; 	    },
    ; 	    "mimeType": "image/jpeg",
    ; 	    "processingMetadata": true
    ; 	  },
    ; 	  "fileSystemInfo": {
    ; 	    "createdDateTime": "2017-06-03T14:30:22.016Z",
    ; 	    "lastModifiedDateTime": "2017-06-03T14:30:22.016Z"
    ; 	  }
    ; 	}


    CkJsonObject::ckDispose(json)
    CkHttp::ckDispose(http)
    CkHttpRequest::ckDispose(req)


    ProcedureReturn
EndProcedure