1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
#ifndef PERSISTENCE_CLIENT_LIBRARY_BACKUP_FILELIST_H
#define PERSISTENCE_CLIENT_LIBRARY_BACKUP_FILELIST_H
/******************************************************************************
* Project Persistency
* (c) copyright 2013
* Company XS Embedded GmbH
*****************************************************************************/
/******************************************************************************
* This Source Code Form is subject to the terms of the
* Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed
* with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
******************************************************************************/
/**
* @file persistence_client_library_backup_filelist.h
* @ingroup Persistence client library
* @author Ingo Huerner
* @brief Header of the persistence client library backup file list
* @see
*/
#include "persistence_client_library_handle.h"
#include "persistence_client_library_tree_helper.h"
/**
* @brief Read the blacklist configuration file
*
* @param filename the filename and path to the configuration fiel
*
* @return 1 success, 0 error
*/
int readBlacklistConfigFile(const char* filename);
/**
* @brief Create the file under the given path.
* If the path does not exist, the folders will be created
*
* @param path of the file to be created
* @param cached 1 if file should be cached,
* 0 if file should not be cached
*
* @return the handle to his file
*/
int pclCreateFile(const char* path, int chached);
/**
* @brief Create a backup copy of a file under the given path.
* If the path does not exist, the folders will be created.
*
* @param srcPath the path of the file
* @param srcfd the file descriptor of the file
* @param csumPath the path where to checksum will be stored
* @param csumBuf the checksum string
*
* @return -1 on error or a positive value indicating number of bytes of the backup file created
*/
int pclCreateBackup(const char* srcPath, int srcfd, const char* csumPath, const char* csumBuf);
/**
* @brief calculate crc32 checksum
*
* @param fd the file descriptor to create the checksum from
* @param crc32sum the array to store the checksum
*
* @return -1 on error or 1 if succeeded
*/
int pclCalcCrc32Csum(int fd, char crc32sum[]);
/**
* @brief verify file for consistency
*
* @param origPath the path of the file to verify
* @param backupPath the path of the backup file
* @param csumPath the path to the checksum file
* @param openFlags the file open flags
*
* @return -1 if the file could not be recovered or a positive value (>=0) on successful recovery
*/
int pclVerifyConsistency(const char* origPath, const char* backupPath, const char* csumPath, int openFlags);
/**
* @brief check if file needs a backup
*
* @param path the path of the file
*
* @return 1 if a backup will shall be created,
* 0 if a backup shall be not created or -1 for an error
*/
int pclBackupNeeded(const char* path);
/**
* @brief translate persistence permission into POSIX file open permissions
*
* @param permission the permission enumerator PersistencePermission_e
*
* @return the POSIX file permission will be returned of -1 in an error case.
* If an unknown PersistencePermission_e will be detected the
* default permission O_RDONLY will be returned
*/
int pclGetPosixPermission(PersistencePermission_e permission);
/**
* @brief delete backup tree
*/
void deleteBackupTree(void);
#endif /* PERS_BACKUP_BLACKLIST_H */
|
