(Visual FoxPro) 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.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loHttp
LOCAL loSbJson
LOCAL lnSuccess
LOCAL loFac
LOCAL loJson
LOCAL lnNumFiles
LOCAL loLastModRemote
LOCAL loLastModLocal
LOCAL loLocalPath
LOCAL loFileUrl
LOCAL i
LOCAL lcFilename
LOCAL lcSLastModified
LOCAL lnBDownload
LOCAL lnNumSeconds

* 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"

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* If SharePoint Windows classic authentication is used, then set the 
* Login, Password, LoginDomain, and NtlmAuth properties.
loHttp.Login = "SHAREPOINT_USERNAME"
loHttp.Password = "SHAREPOINT_PASSWORD"
loHttp.LoginDomain = "SHAREPOINT_NTLM_DOMAIN"
loHttp.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.
loHttp.Accept = "application/json;odata=verbose"
loHttp.AcceptCharset = "utf-8"

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbJson = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents')/Files",loSbJson)
IF (lnSuccess <> 1) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbJson
    CANCEL
ENDIF

* Before proceeding, make sure the local directory where we'll be downloading files exists.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.FileAccess')
loFac = CreateObject('Chilkat.FileAccess')
loFac.DirEnsureExists("qa_output/sharepoint/Documents")

* OK.. load the JSON and iterate over each file
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.LoadSb(loSbJson)

lnNumFiles = loJson.SizeOfArray("d.results")
? "Number of Files in the SharePoint /Documents folder = " + STR(lnNumFiles)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.CkDateTime')
loLastModRemote = CreateObject('Chilkat.CkDateTime')

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loLocalPath = CreateObject('Chilkat.StringBuilder')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loFileUrl = CreateObject('Chilkat.StringBuilder')

i = 0
DO WHILE i < lnNumFiles
    loJson.I = i

    lcFilename = loJson.StringOf("d.results[i].Name")
    lcSLastModified = loJson.StringOf("d.results[i].TimeLastModified")

    ? STR(i + 1) + ": " + lcFilename + " (" + lcSLastModified + ")"

    loLastModRemote.SetFromTimestamp(lcSLastModified)

    lnBDownload = 0
    * Check to see if the local file exists.  If not, then download.
    loLocalPath.SetString("qa_output/sharepoint/Documents/")
    loLocalPath.Append(lcFilename)
    IF (loFac.FileExists(loLocalPath.GetAsString()) <> 1) THEN
        ? "This file does not exist locally."
        lnBDownload = 1
    ELSE
        * Get the local file's date time and compare with the remote file date/time.
        loLastModLocal = loFac.GetLastModified(loLocalPath.GetAsString())
        IF (loFac.LastMethodSuccess = 1) THEN
            * 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.
            lnNumSeconds = loLastModLocal.DiffSeconds(loLastModRemote)
            IF (lnNumSeconds < 0) THEN
                ? "The local file is older than the remote file."
                lnBDownload = 1
            ENDIF

            RELEASE loLastModLocal
        ELSE
            ? "Unable to get the local file's last-modified date/time."
            ? loFac.LastErrorText
        ENDIF

    ENDIF

    IF (lnBDownload = 1) THEN
        loFileUrl.SetString("https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents')/Files('")
        loFileUrl.Append(lcFilename)
        loFileUrl.Append("')/$value")

        ? "Downloading " + lcFilename

        lnSuccess = loHttp.Download(loFileUrl.GetAsString(),loLocalPath.GetAsString())
        IF (lnSuccess <> 1) THEN
            ? loHttp.LastErrorText
            RELEASE loHttp
            RELEASE loSbJson
            RELEASE loFac
            RELEASE loJson
            RELEASE loLastModRemote
            RELEASE loLocalPath
            RELEASE loFileUrl
            CANCEL
        ENDIF

        * Set the local file's last-modified date/time to that of the server's.
        loFac.SetLastModified(loLocalPath.GetAsString(),loLastModRemote)

    ENDIF

    i = i + 1
ENDDO

? "All finished."

RELEASE loHttp
RELEASE loSbJson
RELEASE loFac
RELEASE loJson
RELEASE loLastModRemote
RELEASE loLocalPath
RELEASE loFileUrl