(SQL Server) 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

// Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
//
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @sTmp1 nvarchar(4000)
    -- 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"

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

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

    DECLARE @sbJson int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbJson OUT

    DECLARE @success int
    EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl(''/Documents'')/Files', @sbJson
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbJson
        RETURN
      END

    -- Before proceeding, make sure the local directory where we'll be downloading files exists.
    DECLARE @fac int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.FileAccess', @fac OUT

    EXEC sp_OAMethod @fac, 'DirEnsureExists', @success OUT, 'qa_output/sharepoint/Documents'

    -- OK.. load the JSON and iterate over each file
    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'LoadSb', @success OUT, @sbJson

    DECLARE @numFiles int
    EXEC sp_OAMethod @json, 'SizeOfArray', @numFiles OUT, 'd.results'

    PRINT 'Number of Files in the SharePoint /Documents folder = ' + @numFiles

    DECLARE @lastModRemote int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.CkDateTime', @lastModRemote OUT

    DECLARE @lastModLocal int

    DECLARE @localPath int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @localPath OUT

    DECLARE @fileUrl int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @fileUrl OUT

    DECLARE @i int
    SELECT @i = 0
    WHILE @i < @numFiles
      BEGIN
        EXEC sp_OASetProperty @json, 'I', @i

        DECLARE @filename nvarchar(4000)
        EXEC sp_OAMethod @json, 'StringOf', @filename OUT, 'd.results[i].Name'
        DECLARE @sLastModified nvarchar(4000)
        EXEC sp_OAMethod @json, 'StringOf', @sLastModified OUT, 'd.results[i].TimeLastModified'




        PRINT @i + 1 + ': ' + @filename + ' (' + @sLastModified + ')'

        EXEC sp_OAMethod @lastModRemote, 'SetFromTimestamp', @success OUT, @sLastModified

        DECLARE @bDownload int
        SELECT @bDownload = 0
        -- Check to see if the local file exists.  If not, then download.
        EXEC sp_OAMethod @localPath, 'SetString', @success OUT, 'qa_output/sharepoint/Documents/'
        EXEC sp_OAMethod @localPath, 'Append', @success OUT, @filename
        EXEC sp_OAMethod @localPath, 'GetAsString', @sTmp0 OUT
        EXEC sp_OAMethod @fac, 'FileExists', @iTmp0 OUT, @sTmp0
        IF @iTmp0 <> 1
          BEGIN

            PRINT 'This file does not exist locally.'
            SELECT @bDownload = 1
          END
        ELSE
          BEGIN
            -- Get the local file's date time and compare with the remote file date/time.
            EXEC sp_OAMethod @localPath, 'GetAsString', @sTmp0 OUT
            EXEC sp_OAMethod @fac, 'GetLastModified', @lastModLocal OUT, @sTmp0
            EXEC sp_OAGetProperty @fac, 'LastMethodSuccess', @iTmp0 OUT
            IF @iTmp0 = 1
              BEGIN
                -- 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.
                DECLARE @numSeconds int
                EXEC sp_OAMethod @lastModLocal, 'DiffSeconds', @numSeconds OUT, @lastModRemote
                IF @numSeconds < 0
                  BEGIN

                    PRINT 'The local file is older than the remote file.'
                    SELECT @bDownload = 1
                  END
                EXEC @hr = sp_OADestroy @lastModLocal

              END
            ELSE
              BEGIN

                PRINT 'Unable to get the local file''s last-modified date/time.'
                EXEC sp_OAGetProperty @fac, 'LastErrorText', @sTmp0 OUT
                PRINT @sTmp0
              END
          END

        IF @bDownload = 1
          BEGIN
            EXEC sp_OAMethod @fileUrl, 'SetString', @success OUT, 'https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl(''/Documents'')/Files('''
            EXEC sp_OAMethod @fileUrl, 'Append', @success OUT, @filename
            EXEC sp_OAMethod @fileUrl, 'Append', @success OUT, ''')/$value'


            PRINT 'Downloading ' + @filename

            EXEC sp_OAMethod @fileUrl, 'GetAsString', @sTmp0 OUT
            EXEC sp_OAMethod @localPath, 'GetAsString', @sTmp1 OUT
            EXEC sp_OAMethod @http, 'Download', @success OUT, @sTmp0, @sTmp1
            IF @success <> 1
              BEGIN
                EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
                PRINT @sTmp0
                EXEC @hr = sp_OADestroy @http
                EXEC @hr = sp_OADestroy @sbJson
                EXEC @hr = sp_OADestroy @fac
                EXEC @hr = sp_OADestroy @json
                EXEC @hr = sp_OADestroy @lastModRemote
                EXEC @hr = sp_OADestroy @localPath
                EXEC @hr = sp_OADestroy @fileUrl
                RETURN
              END

            -- Set the local file's last-modified date/time to that of the server's.
            EXEC sp_OAMethod @localPath, 'GetAsString', @sTmp0 OUT
            EXEC sp_OAMethod @fac, 'SetLastModified', @success OUT, @sTmp0, @lastModRemote

          END

        SELECT @i = @i + 1
      END


    PRINT 'All finished.'

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @sbJson
    EXEC @hr = sp_OADestroy @fac
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @lastModRemote
    EXEC @hr = sp_OADestroy @localPath
    EXEC @hr = sp_OADestroy @fileUrl


END
GO