hunting/middleware/FilesManager/include/IFilesManager.h
2024-07-25 17:09:50 +08:00

93 lines
3.3 KiB
C++

/*
* Copyright (c) 2023 Fancy Code.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef I_FILES_MANAGER_H
#define I_FILES_MANAGER_H
#include "StatusCode.h"
#include <memory>
#include <stdio.h>
#include <time.h>
#include <vector>
/**
* @brief Enum defining different types of file creation.
*/
enum class FileCreateType
{
PIR = 0, ///< Automatically created file (PIR triggered).
MANUAL_TEST, ///< File created for manual testing purposes.
MANUAL_PHONE, ///< File created manually by phone.
TIMED, ///< File created on a timed schedule.
END ///< End.
};
enum class FileStatus
{
RECORDING = 0,
FINISHED_RECORD,
SHOULD_BE_UPLOAD,
UPLOADING,
UPLOADED,
END
};
constexpr unsigned long UNDEFINE_SERIAL_NUMBER = 0;
constexpr unsigned long UNDEFINE_FILE_SIZE = 0;
constexpr unsigned long UNDEFINE_FILE_DURATION = 0;
constexpr time_t UNDEFINE_CREATE_TIME = -1;
typedef struct sync_file_info
{
sync_file_info(const unsigned long &serialNumber, const std::string &fileName, const unsigned int &fileSize,
const unsigned int &fileDuration, const time_t &createTime_s, const FileCreateType &type,
const FileStatus &status);
const unsigned long mSerialNumber;
const std::string mFileName;
std::string mSourceFile; ///< If the source file exists, it will be copied to overwrite the mFileName.
const unsigned int mFileSize;
const unsigned int mFileDuration;
const time_t mCreateTime_s;
const FileCreateType mType;
const FileStatus mStatus;
} SyncFileInfo;
typedef struct save_file_info
{
save_file_info(const std::string &fileName);
const std::string mFileName;
} SaveFileInfo;
typedef struct info_to_be_saved
{
info_to_be_saved(const unsigned long &serialNumber, const std::string mSavingPath);
const unsigned long mSerialNumber; ///< The unique key value of the file in the database.
const std::string mSavingPath; ///< The path where the file will be saved.
} InfoToBeSaved;
bool CreateFilesManagerModule(void);
bool DestroyFilesManagerModule(void);
class IFilesManager
{
public:
IFilesManager() = default;
virtual ~IFilesManager() = default;
static std::shared_ptr<IFilesManager> &GetInstance(std::shared_ptr<IFilesManager> *impl = nullptr);
virtual StatusCode Init(void);
virtual StatusCode UnInit(void);
virtual StatusCode SaveFile(const SaveFileInfo &fileInfo); // TODO: delete
virtual InfoToBeSaved GetInfoForSavingFiles(const unsigned int &count);
/**
* @brief Synchronize file information.
*
* @param info
* @return StatusCode
*/
virtual StatusCode SaveFiles(const std::vector<SyncFileInfo> &info);
virtual StatusCode GetAllFiles(std::vector<SyncFileInfo> &info);
virtual StatusCode GetFiles(const std::vector<FileCreateType> &types, std::vector<SyncFileInfo> &info);
};
#endif