VBScript

SharePoint -- Download Newer Files

See more SharePoint Examples

Demonstrates how to download all files from a SharePoint folder that are newer than the local files. VBScript

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

success = 0

' This requires the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

' -------------------------------------------------------------------------
' The following comments apply to SharePoint Windows classic authentication.
' -------------------------------------------------------------------------
' For example, imagine our SharePoint endpoint is https://xyzoffice.mycompany.com/
' The SHAREPOINT_NTLM_DOMAIN would be "mycompany.com"
' The SHAREPOINT_HTTPS_DOMAIN would be "xyzoffice.mycompany.com"
' Also, the SHAREPOINT_USERNAME would be just the name, not a full email address.
' for example, "chilkat" instead of "chilkat@mycompany.com"

set http = CreateObject("Chilkat.Http")

' If SharePoint Windows classic authentication is used, then set the 
' Login, Password, LoginDomain, and NtlmAuth properties.
http.Login = "SHAREPOINT_USERNAME"
http.Password = "SHAREPOINT_PASSWORD"
http.LoginDomain = "SHAREPOINT_NTLM_DOMAIN"
http.NtlmAuth = 1

' -------------------------------------------------------------------------
' The more common case is to use SharePoint Online authentication (via the SPOIDCRL cookie).
' If so, do not set Login, Password, LoginDomain, and NtlmAuth, and instead
' establish the cookie as shown at SharePoint Online Authentication
' -------------------------------------------------------------------------

' First we'll download a list of all the files in the /Documents folder.
' This provides the names and last-modified date/times of the files located
' on the SharePoint server.
http.Accept = "application/json;odata=verbose"
http.AcceptCharset = "utf-8"

set sbJson = CreateObject("Chilkat.StringBuilder")
success = http.QuickGetSb("https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents')/Files",sbJson)
If (success = 0) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

' Before proceeding, make sure the local directory where we'll be downloading files exists.
set fac = CreateObject("Chilkat.FileAccess")
success = fac.DirEnsureExists("qa_output/sharepoint/Documents")

' OK.. load the JSON and iterate over each file
set json = CreateObject("Chilkat.JsonObject")
success = json.LoadSb(sbJson)

numFiles = json.SizeOfArray("d.results")
outFile.WriteLine("Number of Files in the SharePoint /Documents folder = " & numFiles)

set lastModRemote = CreateObject("Chilkat.CkDateTime")
set lastModLocal = CreateObject("Chilkat.CkDateTime")

set localPath = CreateObject("Chilkat.StringBuilder")
set fileUrl = CreateObject("Chilkat.StringBuilder")

i = 0
Do While i < numFiles
    json.I = i

    filename = json.StringOf("d.results[i].Name")
    sLastModified = json.StringOf("d.results[i].TimeLastModified")

    outFile.WriteLine((i + 1) & ": " & filename & " (" & sLastModified & ")")

    success = lastModRemote.SetFromTimestamp(sLastModified)

    bDownload = 0
    ' Check to see if the local file exists.  If not, then download.
    success = localPath.SetString("qa_output/sharepoint/Documents/")
    success = localPath.Append(filename)
    If (fac.FileExists(localPath.GetAsString()) <> 1) Then
        outFile.WriteLine("This file does not exist locally.")
        bDownload = 1
    Else
        ' Get the local file's date time and compare with the remote file date/time.
        success = lastModLocal.SetFromTimestamp(fac.GetFileTimeStr(localPath.GetAsString(),0))

        ' Get the difference in seconds between the local and remote last-modified times.
        ' if the return value is negative, then the caller's time is 
        ' older than the argument.  (in this case, a negative return value means
        ' the local file is older than the remote file.

        ' Note: The DiffSeconds method was found to be missing in the Chilkat .NET build
        ' (and possibly in other builds). It will be present in the v9.5.0.67 release and later.
        numSeconds = lastModLocal.DiffSeconds(lastModRemote)
        If (numSeconds < 0) Then
            outFile.WriteLine("The local file is older than the remote file.")
            bDownload = 1
        End If

    End If

    If (bDownload = 1) Then
        success = fileUrl.SetString("https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents')/Files('")
        success = fileUrl.Append(filename)
        success = fileUrl.Append("')/$value")

        outFile.WriteLine("Downloading " & filename)

        success = http.Download(fileUrl.GetAsString(),localPath.GetAsString())
        If (success = 0) Then
            outFile.WriteLine(http.LastErrorText)
            WScript.Quit
        End If

        ' Set the local file's last-modified date/time to that of the server's.
        success = fac.SetLastModified(localPath.GetAsString(),lastModRemote)

    End If

    i = i + 1
Loop

outFile.WriteLine("All finished.")

outFile.Close