文档管理系统,可以高效管理文档整个生命周期:创建,修改,版本控制,审批,存储,查询,共享,重用以及归档;解决文档分散,安全控制,版本管理等大量文件管理难题。
设计目标
基于Linux系统设计一个简单的文件系统。
(1)实现一些所需要的基本功能
(2)列文件目录时要列出文件名、存取权限(八进制)、文件长度、时间(三种);
(3)源文件可以进行读写保护。
一、代码编译
Warning 1:
位置:
FileSystem.c
文件的第 110 行警告内容:
warning: implicit declaration of function ‘flock’; did you mean ‘clock’? [-Wimplicit-function-declaration]
警告指示在第 110 行出现了对
flock
命令的隐式声明,建议是否意图使用clock
命令。这可能是因为没有包含正确的头文件导致编译器无法找到flock
命令的声明。Warning 2:
位置:
FileSystem.c
文件的第 218 行警告内容:
warning: ‘%s’ directive output may be truncated writing up to 255 bytes into a region of size 50 [-Wformat-truncation=]
警告指示在第 218 行使用了
%s
指令,可能会将多达 255 字节的内容写入大小为 50 字节的区域,可能导致截断。这意味着snprintf
命令的输出超过了目标缓冲区的大小
二、功能展示
开始界面
功能:用户出现错误选择后的显示
功能:创建文件
(在这里我输入了初始设置的文件权限)
(创建后,界面出现了创建的文件)
功能:写入操作
(由于文件权限不够,我们出现写入失败的情况)
功能:修改权限
(为了进行写操作,我修改文件权限为管理员权限)
(修改文件权限为管理员权限后,我再次执行写入操作,显示成功)
功能:读取文件
(可以根据需求读取)
功能:修改文件内容
(需要有权限)
功能:列出目录
(列出了文件的详细信息)
功能:删除文件
(选定所删文件后,文件成功被删除)
功能:安全退出系统
三、系统相应功能的实现
1. 欢迎信息和主界面
在系统运行的初始阶段,通过print_separator函数打印了双星号的分隔线,并输出欢迎信息。之后用户被引导进入主循环。
2. 创建文件(create_file函数)
当用户选择选项1时,系统会提示用户输入文件名和权限。然后使用open函数以指定的权限(permissions)和创建标志(O_CREAT)创建文件。如果open成功,系统会调用close函数关闭文件描述符,并通过printf函数输出文件创建成功的消息。如果open失败,系统通过perror函数输出具体的错误信息,帮助用户理解失败的原因。
3. 删除文件(delete_file函数)
用户选择选项6后,系统会提示用户输入要删除的文件名。通过使用remove函数删除文件,返回值为0表示删除成功。如果删除成功,通过printf函数输出文件删除成功的消息。如果删除失败,通过perror函数输出具体的错误信息。
4. 读取文件内容(read_file函数)
用户选择选项3后,系统会提示用户输入要读取的文件名。通过使用open函数以只读方式打开文件。使用flock函数进行文件锁定,以避免并发读取时的冲突。循环使用read函数读取文件内容,并通过write函数输出到标准输出。最后解锁文件,释放文件锁。
5. 写入文件内容(write_to_file函数)
用户选择选项2后,系统会提示用户输入文件名和要写入的字符串。通过使用open函数以只写方式创建或截断文件。使用flock函数进行文件锁定,以避免并发写入时的冲突。使用write函数将字符串内容写入文件。最后解锁文件,释放文件锁。
6. 修改文件内容(modify_file_content函数)
用户选择选项4后,系统会提示用户输入文件名和新的文件内容。通过使用open函数以只写方式打开文件,并截断文件内容。使用flock函数进行文件锁定,以避免并发写入时的冲突。使用write函数将新的文件内容写入文件。最后解锁文件,释放文件锁。
7. 列出目录下文件及属性(list_directory函数)
用户选择选项5后,系统会提示用户输入目录路径。通过使用opendir打开目录,返回一个指向DIR结构的指针。使用readdir函数遍历目录,获取每个文件或子目录的信息。对于每个文件,使用stat函数获取文件属性信息。打印文件名、权限、长度以及访问、修改和创建时间。
8. 设置文件权限(chmod函数)
用户选择选项7后,系统会提示用户输入文件名和新的权限。使用chmod函数设置文件权限,传入文件名和新的权限值。设置成功后,通过printf函数输出文件权限设置成功的消息。
9. 退出文件系统
用户选择选项8后,系统会通过使用printf函数输出退出消息。调用exit函数退出文件系统。
10. 其他实现细节
- 文件锁定: 使用flock函数进行文件锁定,避免并发读写操作导致的问题,提高系统的安全性。
- 终端宽度获取:使用ioctl函数获取终端宽度,确保分隔线填满整个终端宽度。
- 错误处理:使用perror函数处理文件操作中的错误,将错误信息输出到标准错误流,帮助用户定位问题。
11. 用户交互
通过主循环,系统一直等待用户输入操作选项。在每个选项下,用户需要输入文件名、权限或内容,系统根据不同的功能进行相应的处理。
12. 安全性
系统考虑了文件锁定,避免了并发读写导致的问题,提高了系统的安全性和稳定性。
四、代码细节展示
Ⅰ.头文件
#include <stdio.h> // 包含标准输入输出库,提供基本输入输出功能
#include <stdlib.h> // 包含标准库,提供动态内存分配等功能
#include <string.h> // 包含字符串处理库,提供字符串相关操作函数
#include <sys/types.h> // 包含系统类型定义库,定义了一些基本的系统数据类型
#include <dirent.h> // 包含目录操作库,提供对目录的操作功能
#include <sys/stat.h> // 包含系统状态库,提供获取文件状态的功能
#include <unistd.h> // 包含 Unix 标准库,提供对 Unix 系统的访问功能
#include <fcntl.h> // 包含文件控制库,提供对文件描述符的控制功能
#include <time.h> // 包含时间库,提供对时间的操作功能
#include <sys/ioctl.h> // 包含输入输出控制库,提供对终端输入输出的控制功能
#define MAX_FILENAME_LENGTH 50 // 定义最大文件名长度
#define MAX_STRING_LENGTH 1000 // 定义最大字符串长度
Ⅱ.获取终端宽度
int get_terminal_width() {
// 定义结构体变量,用于保存终端窗口大小信息
struct winsize w;
// 使用 ioctl 函数获取终端窗口大小信息
// 第一个参数为文件描述符,这里使用 STDOUT_FILENO 表示标准输出文件描述符
// 第二个参数为请求码 TIOCGWINSZ,表示获取窗口大小信息
// 第三个参数为结构体变量的地址,用于保存获取到的窗口大小信息
ioctl(STDOUT_FILENO, TIOCGWINSZ, &w);
// 返回终端窗口的列数
return w.ws_col;
}
Ⅲ.打印分隔线
void print_separator(char character) {
// 获取终端宽度
int width = get_terminal_width();
// 使用循环打印指定字符,填满整个终端宽度
for (int i = 0; i < width; ++i) {
printf("%c", character);
}
// 输出换行符,使下一行内容从新的一行开始
printf("\n");
}
Ⅳ.文件属性结构
struct FileProperties {
// 存储文件名的字符数组,最大长度为 MAX_FILENAME_LENGTH
char filename[MAX_FILENAME_LENGTH];
// 文件权限,使用 mode_t 类型表示
mode_t permissions;
// 文件长度,使用 off_t 类型表示
off_t length;
// 文件创建时间,使用 time_t 类型表示
time_t creation_time;
// 文件最后修改时间,使用 time_t 类型表示
time_t last_modified_time;
// 文件最后访问时间,使用 time_t 类型表示
time_t last_accessed_time;
};
Ⅴ.创建文件
void create_file(char *filename, mode_t permissions) {
// 使用 open 函数创建文件,指定写入权限和创建标志
// 返回文件描述符,若返回值为 -1 表示创建文件失败
int fd = open(filename, O_WRONLY | O_CREAT, permissions);
// 检查文件描述符是否有效
if (fd != -1) {
// 关闭文件描述符,因为在创建文件时只需获取其描述符,无需保持打开状态
close(fd);
// 打印创建成功的消息
printf("文件 '%s' 创建成功。\n", filename);
} else {
// 打印创建文件失败时的错误信息
perror("创建文件时发生错误");
}
}
Ⅵ.删除文件
void delete_file(char *filename) {
// 使用 remove 函数删除指定文件,返回值为 0 表示删除成功
if (remove(filename) == 0) {
// 打印删除成功的消息
printf("文件 '%s' 删除成功。\n", filename);
} else {
// 打印删除文件失败时的错误信息
perror("删除文件时发生错误");
}
}
Ⅶ.读文件
void read_file(char *filename) {
// 使用 open 函数以只读方式打开文件,获取文件描述符
int fd = open(filename, O_RDONLY);
// 检查文件描述符是否有效
if (fd != -1) {
// 锁定文件,避免并发读取时的冲突
if (flock(fd, LOCK_SH) == 0) {
char buffer[MAX_STRING_LENGTH];
ssize_t bytesRead;
// 使用循环读取文件内容到缓冲区,并输出到标准输出
while ((bytesRead = read(fd, buffer, sizeof(buffer))) > 0) {
write(STDOUT_FILENO, buffer, bytesRead);
}
// 解锁文件,释放文件锁
flock(fd, LOCK_UN);
} else {
// 打印文件锁定失败时的错误信息
perror("文件锁定时发生错误");
}
// 关闭文件描述符
close(fd);
// 输出换行符,使下一行内容从新的一行开始
printf("\n");
} else {
// 打印打开文件失败时的错误信息
perror("读文件时发生错误");
}
}
Ⅷ.写文件
void write_to_file(char *filename, char *content) {
// 使用 open 函数以只写方式创建或截断文件,获取文件描述符
int fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, 0666);
// 检查文件描述符是否有效
if (fd != -1) {
// 锁定文件,避免并发写入时的冲突
if (flock(fd, LOCK_EX) == 0) {
// 使用 write 函数将内容写入文件
write(fd, content, strlen(content));
// 解锁文件,释放文件锁
flock(fd, LOCK_UN);
} else {
// 打印文件锁定失败时的错误信息
perror("文件锁定时发生错误");
}
// 关闭文件描述符
close(fd);
// 打印写入成功的消息
printf("内容成功写入 '%s'。\n", filename);
} else {
// 打印创建文件失败时的错误信息
perror("写文件时发生错误");
}
}
Ⅸ.修改文件内容
void modify_file_content(char *filename, char *new_content) {
// 使用 open 函数以只写方式打开文件,并截断文件内容
int fd = open(filename, O_WRONLY | O_TRUNC);
// 检查文件描述符是否有效
if (fd != -1) {
// 锁定文件,避免并发写入时的冲突
if (flock(fd, LOCK_EX) == 0) {
// 使用 write 函数将新内容写入文件
write(fd, new_content, strlen(new_content));
// 解锁文件,释放文件锁
flock(fd, LOCK_UN);
} else {
// 打印文件锁定失败时的错误信息
perror("文件锁定时发生错误");
}
// 关闭文件描述符
close(fd);
// 打印文件内容修改成功的消息
printf("文件内容已成功修改。\n");
} else {
// 打印打开文件失败时的错误信息
perror("修改文件内容时发生错误");
}
}
Ⅹ.列目录
void list_directory(char *path) {
struct stat file_stat;
struct dirent *dir_entry;
DIR *dir = opendir(path);
// 检查目录是否成功打开
if (dir == NULL) {
perror("打开目录时发生错误");
return;
}
// 遍历目录中的文件和子目录
while ((dir_entry = readdir(dir)) != NULL) {
char filepath[MAX_FILENAME_LENGTH + 1];
// 构建文件的完整路径
snprintf(filepath, sizeof(filepath), "%s/%s", path, dir_entry->d_name);
// 获取文件属性信息
if (stat(filepath, &file_stat) == 0) {
print_separator('-');
// 打印文件名
printf("文件名: %s\n", dir_entry->d_name);
// 打印文件权限
printf("权限: %o\n", file_stat.st_mode & 0777);
// 打印文件长度
printf("长度: %ld\n", file_stat.st_size);
// 打印文件访问时间
printf("访问时间: %s", ctime(&file_stat.st_atime));
// 打印文件修改时间
printf("修改时间: %s", ctime(&file_stat.st_mtime));
// 打印文件创建时间
printf("创建时间: %s", ctime(&file_stat.st_ctime));
}
}
// 关闭目录流
closedir(dir);
}
Ⅺ.主函数
int main() {
// 打印欢迎信息
print_separator('*');
print_separator('*');
printf(">>>>>>>>>>>>>>>>>>>>您好,欢迎使用XXX的Linux文件管理系统<<<<<<<<<<<<<<<<<<<<<<\n");
char filename[MAX_FILENAME_LENGTH]; // 存储文件名
char content[MAX_STRING_LENGTH]; // 存储文件内容
char new_content[MAX_STRING_LENGTH]; // 存储新的文件内容
mode_t permissions; // 存储文件权限
// 进入主循环,等待用户输入操作选项
while (1) {
// 打印分隔符和操作选项
print_separator('*');
print_separator('*');
printf("请选择您想要进行的操作:\n");
print_separator('-');
printf("1. 创建文件\n");
printf("2. 写入字符串到文件\n");
printf("3. 读取文件内容\n");
printf("4. 修改文件内容\n");
printf("5. 列出目录\n");
printf("6. 删除文件\n");
printf("7. 设置文件权限\n");
printf("8. 退出文件系统\n");
print_separator('-');
printf("请输入选项(1-8): ");
int choice;
scanf("%d", &choice);
// 打印分隔符和用户选择的操作
print_separator('*');
print_separator('*');
switch (choice) {
case 1:
// 选项1:创建文件
printf("请输入文件名: ");
scanf("%s", filename);
printf("请输入文件权限(八进制数表示,如0644): ");
scanf("%o", &permissions);
create_file(filename, permissions);
break;
case 2:
// 选项2:写入字符串到文件
printf("请输入文件名: ");
scanf("%s", filename);
printf("请输入要写入的字符串: ");
scanf(" %[^\n]s", content);
write_to_file(filename, content);
break;
case 3:
// 选项3:读取文件内容
printf("请输入文件名: ");
scanf("%s", filename);
read_file(filename);
break;
case 4:
// 选项4:修改文件内容
printf("请输入文件名: ");
scanf("%s", filename);
printf("请输入新的文件内容: ");
scanf(" %[^\n]s", new_content);
modify_file_content(filename, new_content);
break;
case 5:
// 选项5:列出目录
printf("请输入需要列出的目录路径: ");
scanf("%s", filename);
printf("%s目录下的文件及其属性情况如下:\n", filename);
list_directory(filename);
break;
case 6:
// 选项6:删除文件
printf("请输入要删除的文件名: ");
scanf("%s", filename);
delete_file(filename);
break;
case 7:
// 选项7:设置文件权限
printf("请输入要设置权限的文件名: ");
scanf("%s", filename);
printf("请输入文件权限(八进制数表示,如0644): ");
scanf("%o", &permissions);
chmod(filename, permissions);
printf("文件权限已成功设置。\n");
break;
case 8:
// 选项8:退出文件系统
printf("退出文件系统。\n");
exit(0);
break;
default:
// 无效的选项
printf("无效的选项。\n");
break;
}
}
return 0;
}
存于Gitee中的代码地址链接
五、感悟
在本次设计中,我认为实现这个系统里的文件读写保护是重中之重,在我的文件管理系统中,我通过使用文件锁定机制实现了读写保护,这是一种在并发环境下确保文件安全性的有效方法。我思考到,在多用户或多进程的环境下,同时对同一个文件进行读写操作可能导致数据不一致或损坏,因此,需要一种机制来确保同一时间只有一个进程可以访问文件。而我想到了文件锁定是一种通用的解决方案,用于协调对共享资源的并发访问,在我的系统中,我选择使用 flock命令,该命令提供了对文件的简单锁定机制。在我的设计中,当一个进程获取读锁定时,其他进程也可以获取读锁定,但不能获取写锁定,这样可以允许多个进程同时读取文件,但防止写入冲突。当一个进程获取写锁定时,其他进程无法获取读写锁定。这确保了在写入时文件不会被其他进程读取或写入。使用 flock命令的好处是,接着使用LOCK_UN参数就可以解锁文件。在读取或写入完成后,我释放文件锁,让其他进程可以访问该文件。
而接下来我考虑了文件读写保护对于并发性能需求,我的实现中采用的是阻塞的文件锁定方式,这意味着当一个进程获取写锁定时,其他进程必须等待释放锁定才能进行操作。了解并发访问的特性,根据实际需求选择合适的并发度。在某些情况下,读锁定可以允许多个进程同时读取,提高并发性能,而在文件锁定过程中,考虑到可能的错误情况,我使用了perror函数输出错误信息,提高了系统的鲁棒性。这对于及时发现问题、定位问题原因非常有帮助。在读取或写入完成后,我及时解锁文件,释放文件锁。这种及时性确保了其他进程能够及时访问文件,提高了系统的效率。