file_handler.h

Go to the documentation of this file.

/*
 *
 * Copyright (c) Microsoft Corporation.
 * All rights reserved.
 *
 * This code is licensed under the MIT License.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files(the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions :
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */
 
#ifndef API_MIP_FILE_FILE_HANDLER_H_
#define API_MIP_FILE_FILE_HANDLER_H_
 
#include <memory>
 
#include "mip/file/file_export.h"
#include "mip/file/file_inspector.h"
#include "mip/file/file_status.h"
#include "mip/file/labeling_options.h"
#include "mip/file/protection_settings.h"
#include "mip/mip_context.h"
#include "mip/mip_namespace.h"
#include "mip/protection_descriptor.h"
#include "mip/protection/protection_handler.h"
#include "mip/stream.h"
#include "mip/upe/action.h"
#include "mip/upe/content_label.h"
#include "mip/protection/protection_engine.h"
 
MIP_NAMESPACE_BEGIN
 
class FileHandler {
public:
 
  class Observer {
  public:
    virtual ~Observer() {}
    virtual void OnCreateFileHandlerSuccess(
      const std::shared_ptr<FileHandler>& fileHandler,
      const std::shared_ptr<void>& context) { UNUSED(fileHandler); UNUSED(context); }
 
    virtual void OnCreateFileHandlerFailure(
      const std::exception_ptr& error,
      const std::shared_ptr<void>& context) { UNUSED(error); UNUSED(context); }
 
    virtual void OnClassifySuccess(
        const std::vector<std::shared_ptr<Action>>& actions, const std::shared_ptr<void>& context) {
      UNUSED(actions);
      UNUSED(context);
    }
 
    virtual void OnClassifyFailure(const std::exception_ptr& error, const std::shared_ptr<void>& context) {
      UNUSED(error);
      UNUSED(context);
    }
 
    virtual void OnGetDecryptedTemporaryFileSuccess(
        const std::string& decryptedFilePath, const std::shared_ptr<void>& context) {
      UNUSED(decryptedFilePath);
      UNUSED(context);
    }
 
    virtual void OnGetDecryptedTemporaryFileFailure(const std::exception_ptr& error, const std::shared_ptr<void>& context) {
      UNUSED(error);
      UNUSED(context);
    }
 
    virtual void OnGetDecryptedTemporaryStreamSuccess(
        const std::shared_ptr<Stream>& decryptedStream, const std::shared_ptr<void>& context) {
      UNUSED(decryptedStream);
      UNUSED(context);
    }
 
    virtual void OnGetDecryptedTemporaryStreamFailure(
        const std::exception_ptr& error, const std::shared_ptr<void>& context) {
      UNUSED(error);
      UNUSED(context);
    }
 
    virtual void OnCommitSuccess(
      bool committed, 
      const std::shared_ptr<void>& context) { UNUSED(committed); UNUSED(context); }
 
    virtual void OnCommitFailure(
      const std::exception_ptr& error, 
      const std::shared_ptr<void>& context) { UNUSED(error); UNUSED(context); }
 
    virtual void OnInspectSuccess(
        const std::shared_ptr<FileInspector>& fileInspector, const std::shared_ptr<void>& context) {
      UNUSED(fileInspector);
      UNUSED(context);
    }
 
    virtual void OnInspectFailure(const std::exception_ptr& error, const std::shared_ptr<void>& context) {
      UNUSED(error);
      UNUSED(context);
    }
 
  protected:
    Observer() {}
  };
 
  virtual std::shared_ptr<ContentLabel> GetLabel() = 0;
 
  virtual std::vector<std::pair<std::string, std::string>> GetProperties(uint32_t version) = 0;
 
  virtual std::shared_ptr<ProtectionHandler> GetProtection() = 0;
 
  virtual void RegisterContentForTrackingAndRevocationAsync(
      bool isOwnerNotificationEnabled,
      const std::shared_ptr<ProtectionEngine::Observer>& observer,
      const std::shared_ptr<void>& context) = 0;
 
  virtual void RevokeContentAsync(
      const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context) = 0;
  
  FILE_API static bool __CDECL IsProtected(
      const std::string& filePath,
      const std::shared_ptr<MipContext>& mipContext);
 
  FILE_API static bool __CDECL IsProtected(
      const std::string& filePath,
      const std::shared_ptr<MipContext>& mipContext,
      const std::shared_ptr<void>& loggerContext);
    
  FILE_API static bool __CDECL IsProtected(
      const std::shared_ptr<Stream>& stream,
      const std::string& filePath,
      const std::shared_ptr<MipContext>& mipContext);
 
  FILE_API static bool __CDECL IsProtected(
      const std::shared_ptr<Stream>& stream,
      const std::string& filePath,
      const std::shared_ptr<MipContext>& mipContext,
      const std::shared_ptr<void>& loggerContext);
 
  FILE_API static bool __CDECL IsLabeledOrProtected(
      const std::string& filePath,
      const std::shared_ptr<MipContext>& mipContext);
 
  FILE_API static bool __CDECL IsLabeledOrProtected(
      const std::string& filePath,
      const std::shared_ptr<MipContext>& mipContext,
      const std::shared_ptr<void>& loggerContext);
    
  FILE_API static bool __CDECL IsLabeledOrProtected(
      const std::shared_ptr<Stream>& stream,
      const std::string& filePath,
      const std::shared_ptr<MipContext>& mipContext);
 
  FILE_API static bool __CDECL IsLabeledOrProtected(
      const std::shared_ptr<Stream>& stream,
      const std::string& filePath,
      const std::shared_ptr<MipContext>& mipContext,
      const std::shared_ptr<void>& loggerContext);
 
  FILE_API static std::shared_ptr<FileStatus> __CDECL GetFileStatus(
      const std::string& filePath,
      const std::shared_ptr<MipContext>& mipContext,
      const std::shared_ptr<void>& loggerContext = nullptr);
 
  FILE_API static std::shared_ptr<FileStatus> __CDECL GetFileStatus(
      const std::shared_ptr<Stream>& stream,
      const std::string& filePath,
      const std::shared_ptr<MipContext>& mipContext,
      const std::shared_ptr<void>& loggerContext = nullptr);
 
  FILE_API static std::vector<uint8_t> __CDECL GetSerializedPublishingLicense(
      const std::string& filePath,
      const std::shared_ptr<MipContext>& mipContext);
 
  FILE_API static std::vector<uint8_t> __CDECL GetSerializedPublishingLicense(
      const std::string& filePath,
      const std::shared_ptr<MipContext>& mipContext,
      const std::shared_ptr<void>& loggerContext);
 
  FILE_API static std::vector<uint8_t> __CDECL GetSerializedPublishingLicense(
      const std::shared_ptr<Stream>& stream,
      const std::string& filePath,
      const std::shared_ptr<MipContext>& mipContext);
 
  FILE_API static std::vector<uint8_t> __CDECL GetSerializedPublishingLicense(
      const std::shared_ptr<Stream>& stream,
      const std::string& filePath,
      const std::shared_ptr<MipContext>& mipContext,
      const std::shared_ptr<void>& loggerContext);
 
  virtual void ClassifyAsync(const std::shared_ptr<void>& context) = 0;
 
  virtual void InspectAsync(const std::shared_ptr<void>& context) = 0;
  
  virtual void SetLabel(
      const std::shared_ptr<Label>& label,
      const LabelingOptions& labelingOptions,
      const ProtectionSettings& protectionSettings) = 0;
 
  virtual void DeleteLabel(const LabelingOptions& labelingOptions) = 0;
 
  virtual void SetProtection(
      const std::shared_ptr<ProtectionDescriptor>& protectionDescriptor,
      const ProtectionSettings& protectionSettings) = 0;
 
  virtual void SetProtection(
      const std::shared_ptr<ProtectionHandler>& protectionHandler) = 0;
 
  virtual void RemoveProtection() = 0;
 
  virtual void CommitAsync(const std::string& outputFilePath, const std::shared_ptr<void>& context) = 0;
 
  virtual void CommitAsync(const std::shared_ptr<Stream>& outputStream, const std::shared_ptr<void>& context) = 0;
 
  virtual bool IsModified() = 0;        
  
  virtual void GetDecryptedTemporaryFileAsync(const std::shared_ptr<void>& context) = 0;
 
  virtual void GetDecryptedTemporaryStreamAsync(const std::shared_ptr<void>& context) = 0;
 
  virtual void NotifyCommitSuccessful(const std::string& actualFilePath) = 0;
 
  virtual std::string GetOutputFileName() = 0;
 
  virtual ~FileHandler() {}
protected:
  FileHandler() {}
};
 
MIP_NAMESPACE_END
 
#endif // API_MIP_FILE_FILE_HANDLER_H_