Пример провайдера к внешнему хранилищу Google Drive

В данном пункте рассмотрен пример создания провайдера к внешнему хранилищу Google Drive для хранения бинарных данных файлов Docsvision.

Данный пример не является готовым решением для использования Google Drive в качестве внешнего хранилища, а только демонстрирует способ создания провайдера к нему.

Облачное хранилище Google Drive предоставляет возможность и API для работы с файлами из собственного приложения. Инструкция по работе с Google Drive API приведена на этой странице.

Для работы с Google Drive в данном примере используется предоставляемая реализация обертки для работы с Google Drive API в .NET (NuGet пакет).

Исходный код примера доступен по ссылке.

Пример содержит два проекта:
  1. GoogleDriveStorageProvider — проект компонента провайдера к файловому хранилищу с классами:

    1. GoogleDriveStorage — класс провайдера с реализацией интерфейсов IBinaryStorage, IExtensionInitialize, IStreamedBinaryStorage, IEnumerableBinaryStorage.

    2. GoogleDriveProviderPropertyControl — класс графического интерфейса настройки провайдера.

    3. GoogleDriveProxy — класс-посредник для работы с Google Drive API.

    4. ProviderSettings — вспомогательный класс с методами сериализации и десериализации настроек провайдера.

    5. LogWriter — вспомогательный класс журналирования работы провайдера.

    6. LocalizedDisplayNameAttribute — класс для получения локализованных ресурсов в атрибутах класса.

  2. AskToken — проект консольного приложения для получения токена для работы с Google Drive.

Требования примера

На компьютере программиста должны быть установлены:
  1. Microsoft Visual Studio 2022 и выше.

  2. .NET SDK версии 8.0 и выше.

Последовательность работы с примером

  1. Распакуйте архив примера на локальный диск.

  2. Получите файл с конфигурацией клиента (credentials.json) по инструкции в шаге 1 на странице. Потребуется авторизоваться в Google.

  3. Загрузите файл credentials.json в папку GoogleDriveStorageProvider\AskToken\bin\Debug\ распакованного архива примера.

  4. Включите в Visual Studio настройку Allow Nuget to download missing package для автоматической загрузки необходимых пакетов библиотеки Google Drive API.

  5. Повторно подключите зависимости DocsVision.Platform.StorageServer и DocsVision.Platform.WinForms в проекте GoogleDriveStorageProvider. К проекту должны быть подключены компоненты, используемые на сервере Docsvision.

  6. Соберите проект GoogleDriveStorageProvider.

  7. Соберите и запустите проект AskToken. В процессе работы программы AskToken будет вызван код из класса GoogleDriveProxy (проект GoogleDriveStorageProvider):

    using (var stream =
                    new FileStream(credentialsFile, FileMode.Open, FileAccess.Read))
                {
                    credential = GoogleWebAuthorizationBroker.AuthorizeAsync(
                        GoogleClientSecrets.Load(stream).Secrets,
                        new string[] { DriveService.Scope.Drive },
                        "user",
                        CancellationToken.None,
                        new FileDataStore(tokenFolder, true)).Result;
    
                    logWriter.Write("Токен получен из папки: " + tokenFolder);
                }

    Данный код сформирует файл с токеном, который необходим для работы с API Google Drive (см. описание в шаге 3 данного примера). Для получения токена нужно разрешить приложению (название приложения указывается при выполнении п. 2) доступ к аккаунту Google.

    Токен будет сохранен в папку GoogleDriveStorageProvider\AskToken\bin\Debug\token.json\.

  8. Скопируйте на сервер Docsvision файлы из папки GoogleDriveStorageProvider\bin\Debug\:

    • GoogleDriveStorageProvider.dll,

    • ru\GoogleDriveStorageProvider.resources.dll,

    • Google.Apis.Drive.v3.dll,

    • Google.Apis.Auth.PlatformServices.dll,

    • Google.Apis.Auth.dll,

    • Google.Apis.PlatformServices.dll,

    • Google.Apis.Core.dll,

    • Google.Apis.dll,

    • Newtonsoft.Json.dll.

  9. Поместите скопированные файлы в каталог /usr/lib/docsvision/common в Linux и C:\Program Files\Docsvision\Common в Windows.

  10. Скопируйте на сервер Docsvision папку AskToken\bin\Debug\token.json\ и файл AskToken\bin\Debug\credentials.json. Данные файлы потребуются для работы провайдера к Google Drive. Файл и папку нужно скопировать в каталог доступный для сервера Docsvision, но недоступный рядовым пользователям (из-за наличия конфиденциальных данных в файлах).

  11. Подключите новый тип хранилища к Docsvision.

    Проверяйте работу компонентов на тестовом сервере Docsvision.
  12. В Консоли управления Docsvision выберите настраиваемую базу данных на странице Серверы  Имя-сервера  Сервер приложений  Базы данных и нажмите на строку нужной базы данных.

  13. Настройте параметры в группе Внешние хранилища при настройке свойств БД, см. раздел "Работа с внешними хранилищами в Docsvision" в документации Консоли управления Docsvision.

  14. Нажмите на кнопку Плюс в столбце настроек

  15. Добавьте новое хранилище. В окне настройки хранилища в поле Тип выберите вариант Собственное хранилище и укажите в поле Имя сборки имя сборки GoogleDriveStorageProvider.dll из каталога на сервере, затем нажмите кнопку Получить данные.

    В появившемся блоке Свойства необходимо указать: путь к файлу credentials.json и папке token.json (загружены в п. 10), путь к файлу журнала работы провайдера.

    Пример настройки хранилища в Google Drive
    Рисунок 1. Пример настройки хранилища в Google Drive
  16. В список типов хранилищ будет добавлено хранилище с названием "Хранилище в Google Drive". Настройте для нового хранилища группу и правило, следуя инструкции, приведенной в разделе "Подключить внешнее хранилище" документации модуля Консоль управления Docsvision.

  17. Нажмите кнопку Применить в правом верхнем углу окна Консоли, чтобы применить настройки хранилищ и перезапустите службу Сервера Docsvision. Уже сохранённые в БД хранилища, группы и правила отображаются обычным шрифтом, новые и отредактированные — выделяются жирным. После применения и успешного сохранения настроек в БД выделение жирным пропадает. .После перезапуска сервера Docsvision (будет выполнен после добавления хранилища) в Google Drive будут созданы две папки:

    • DV_PrimaryPart — представляет раздел для основных файлов.

    • DV_ArchivePart — представляет раздел для архивных файлов.

      Проверить работу провайдера можно настроив правило на помещение в хранилище файлов с расширением .pdf. При добавлении в карточку Docsvision файла с типом .pdf, соответствующий файл будет загружен в Google Drive.