0x0D-单线程备份(上)

写在最前方

  • 源路径:即 From-Path,你准备要备份的资料

  • 目的路径: 即 To-Path,你准备要存储备份的资料的地方

  • 稍微回想一下,上一次写的代码,本次的任务是遍历目录及其子目录,那么这回要干的就是将上次遍历过的数据,挪一下窝,到我们想要他们去的位置。

  • 这涉及到两个操作,遍历拷贝,前一个动作我们在上一回已经实现了,只需做小小的改动,就能够使用。后一个动作也是需要靠 Windows API来完成,至于哪些,稍后再提。

  • 现在先让我们完成一个魔法,3, 2, 1!

      do{
      	puts("-------------------------------------------------");
      	fprintf(stdout, "The Default Path is : %s \n", DEFAULT_TO_PATH);
      	fprintf(stdout, "Now The Path is     : %s \n", get_backup_topath());
      	puts("-------------------------------------------------");
      	puts("That is a System Back Up Software for Windows! ");
      	puts("List of the software function : ");
      	puts("1. Back Up ");
      	puts("2. Set Back Up TO-PATH ");
      	puts("3. Show TO-PATH History");
      	puts("4. Read Me ");
      	puts("5. Exit ");
      	puts("-------------------------------------------------");
    

    对界面稍微有了一些改动。

    新增了第三行和第四行的 系统默认目的路径和当前使用的目的路径。

    新增了倒数第四行的查看目的路径历史纪录的功能。

    main函数外头需要 extern DEFAULT_TO_PATH;因为引用了setPath.c里的一个全局变量。

写在中间

  • 前一次我们曾经提到要让函数的功能更加清晰,为了达到这个目的,应该把可能用到的一些原生库函数包裹一下,让可能发生的错误尽量掌握在我们自己的手里

  • 安全函数

    • 新建 safeFunc.h safeFunc.c

    • 考虑一下我们需要包裹的函数: mallocfreefopen 三个库函数。

      • 为了不让后方的多线程实现产生更多的以后,不单独使用全局错误输出。

      • 让我来将他们实现一下

      • 我不会省略一些看似不必要的东西,例如注释,而是完整的呈现出来,如果觉得篇幅过长,可以选择跳跃的阅读。

      • 魔法来了,3, 2, 1!

          #include <stdio.h> /* size_t */
          #include <stdlib.h>
          #include <setjmp.h>
          #define TRY_TIMES 3
        
          typedef struct _input_para{
          	char * file; /* 待打开或创建的文件名 */
          	char * mode; /* 打开的模式 */
          }params;
        
          jmp_buf malc_jmp; /*Malloc_s*/
          jmp_buf fopn_jmp; /*Fopen*/
        
          /**
           * @version 1.0 2015/10/01
           * @author  wushengixin
           * @param   ... 参看结构体说明
          			可传入任意的个数的,形式为 .file = "xxx", .mode = "x" 的参数
           * function 用于使用默认参数,并调用函数 Fopen 进行打开操作
           */
          #define Fopen_s(...) Fopen((params){.file = NULL, .mode = "r", __VA_ARGS__})
          FILE* Fopen(const params file_open);
        
          /**
           * @version 1.0 2015/10/01
           * @author  wushengxin
           * param    sizes 输入需要分配的大小
           * function 用于隐藏一些对错误的处理,并调用malloc库函数分配空间
           */
          void * Malloc_s(size_t sizes);
        
          /**
           * @version 1.0 2015/10/01
           * @author  wushengxin
           * @param   input 外部传入的等待释放的指针
           * function 用于隐藏一些对错误的处理,并调用free库函数进行释放指针
           */
          void Free_s(void * input);
        

      里面用到了一些新的特性,如果使用 GCC/Clang作为编译器的,记得要开启-std=c11 支持。

        这几个函数就不再详细解释,而是简略说几个,接下来放上实现代码:
      
        	FILE* Fopen(const params file_open)
        	{
        		int times = 0;
        		FILE* ret_p = NULL;
        		if (file_open.file == NULL)
        		{
        			fputs("The File Name is EMPTY! Comfirm it and Try Again", stderr);
        			return ret_p;
        		}
        		setjmp(fopn_jmp); /* fopn_jmp To there */
        		ret_p = fopen(file_open.file, file_open.mode);
        		if (ret_p == NULL)
        		{
        			if (times++ < TRY_TIMES)  
        			longjmp(fopn_jmp, 0); /* fopn_jmp From here */
        			fprintf(stderr, "The File : %s Open with Mode (%s) Fail!\n", file_open.file, file_open.mode);
        		}
        		return ret_p;
        	}
      
        	void * Malloc_s(size_t sizes)
        	{
        		int times = 0;
        		void * ret_p = NULL;
        		if (sizes == 0)
        			return NULL;
        		setjmp(malc_jmp); /* malc_jmp To There */
        		ret_p = malloc(sizes);
        		if (ret_p == NULL)
        		{
        			if (times++ < TRY_TIMES) /* malc_jmp From Here */
        				longjmp(malc_jmp, 0);
        			fputs("Allocate Memory Fail!", stderr);
        		}
        		return ret_p;
        	}
      
        	void Free_s(void * input)
        	{
        		if (input == NULL)
        		{
        	#if !defined(NOT_DEBUG_AT_ALL)
        			fputs("Sent A NULL pointer to the Free_s Function!", stderr);
        	#endif
        			return;
        		}
        		free(input);
        		input = NULL;
        	}
        第一个函数是用外部定义的宏 `Fopen_s`启动它,这里没有实现隐藏它。
      
        最后一个函数中使用了预处理的机制,如果在头文件中定义了 `#define NOT_DEBUG_AT_ALL`,这个输出将不在出现
      
  • 安全函数已经撰写完成,接下来就是干正事了

    • setPath.h
      • 我们首先要将程序里保存上默认的目的路径,首先想到用常量#define ...

      • 其次应该要确保当前目的路径不被其他非法的渠道访问,那就应该用一个static 字符数组存储。

      • 接下来就是要提供一个函数当作接口(这里用了接口这个术语不知道合不合适),来获取当前实际在使用的目的路径 get_backup_topath

      • 这里还需要将之前实现过的 repl_str ,再次实现一次,因为之前的显示功能只是测试,并不会实际应用到程序当中。

      • 完成这两个功能函数以后,再去考虑实现怎么样设置路径存储路径,以及使用文件流操作来缓存历史目的路径

          #include "safeFunc.h"
        
          #define SELF_LOAD_DEFAULT_PATH "C:/"
          #define MIN_PATH_NAME _MAX_PATH /* 最小的限制 */
          #define LARGEST_PATH_NAME 32767 /* 路径的最大限制 */
        
          /*
           * @version  1.0 2015/10/02
           * @author   wushengxin
           * @function 用于返回当前使用的目的路径
           */
          const char * get_backup_topath();
        
          /**
          * @version 1.0 2015/09/28
          * @author  wushengxin
          * @param   src 外部传入的,用于调整
          * @function 用于替换路径中的 / 为 \ 的
          */
          void repl_str(char * src);
        

        对应的实现中,会定义一个静态的字符数组,且在头文件中能够看见,很多是在showFiles里定义过的。

        定义过的函数,例如 repl_str需要把showFiles.c中的实现,使用#if 0 ... #endif 进行注释掉,不然会发生重定义的错误。

      • setPath.c

          #include "setPath.h"
        
          static char to_path_buf[LARGEST_PATH_NAME] = SELF_LOAD_DEFAULT_PATH;
          const char * DEFAULT_TO_PATH = SELF_LOAD_DEFAULT_PATH;
          const int LARGEST_PATH = LARGEST_PATH_NAME;
        
          const char * get_backup_topath()
          {
          	return to_path_buf;
          }
        
          void repl_str(char * src)
          {
          	size_t length = strlen(src);
          	for (size_t i = 0; i <= length; ++i)
          	{
          		if (src[i] == '/')
          			src[i] = '\\';
          	}
          	return;
          }
        
      • 有了上面的代码,主界面就再次能够无误运行了,那么剩下的就是实现,设置目的路径,存储目的路径到本地,显示目的路径,分别对应主界面的2, 3

      • 怎么实现比较好,再开始之前,分析一下会遇到的情况:

        • 我们在得到目的路径之后,会将其拷贝给默认路径 to_path_buf,并且将其存储到本地缓存文件中,以便下次程序开始时可以直接使用上一次的路径
        • 还可以使用另一个文件存储所有用过的历史路径,包含时间信息。
      • 那么这就要求我们首先实现存储目的路径的功能,其次再实现设置目的路径的功能,最后实现显示目的路径的功能

      • 注:两个看似无用的全局变量(const)是为了其他文件的可见性而设立的,且相对于#define能够省一些无足轻重的空间。

      • 存储目的路径 store_hist_path

        • setPath.h

            #include <time.h>
            /**
             * @version  1.0 2015/10/02
             * @version  wushengxin
             * @param    path 需要存储的路径
             * @function 用于存储路径到本地文件 "show_hist" 和 "use_hist" 
             */
            void store_hist_path(const char * path);
          
        • setPath.c

            void store_hist_path(const char * path)
            {
            	time_t ctimes; 
            	time(&ctimes); /* 获取时间 */
            	FILE* input_use = Fopen_s(.file = "LastPath.conf", .mode = "w"); /* 每次写入覆盖 */
            	FILE* input_show = Fopen_s(.file = "PathHistory.txt", .mode = "a");
            	if (!input_show || !input_use)
            	{
            #if !defined(NOT_DEBUG_AT_ALL)
            		fputs("Open/Create the File Fail!", stderr);
            #endif
            		return;
            	}
            	fprintf(input_use, "%s\n", path); /* 写入 */
            	fprintf(input_show, "%s %s", path, ctime(&ctimes));
            	fclose(input_show);
            	fclose(input_use);
            	return;
            }
          

          timectime 函数的使用网路上的介绍更加全面,这里不做解释。

          完成了存储的函数之后,便是实现从键盘读取并且设置默认路径

      • 设置目的路径 set_enter_path

        • 在此处需要停下来在此思考一下,如果用户输入了错误的路径(无效路径或者恶意路径),也应该被读取吗?所以应该增加一个检查,用于确认路径的有效性。

        • setPath.h

            #include <string.h>
            #include <io.h> /* _access */
            enum {NOT_EXIST = 0, EXIST = 1};
            /**
             * @version  1.0 2015/10/02
             * @author   wushengxin
             * @function 用于读取从键盘输入的路径并将之设置为默认路径,并存储。
             */
            void set_enter_path();
          
            /**
             * @version  1.0 2015/10/02
             * @author   wushengxin
             * @param    path 用于检查的路径
             * @function 用于检查用户输入的路径是否是有效的
             */
            int is_valid_path(const char * path);
          
        • setPath.c

            int is_valid_path(const char * path)
            {/* _access 后方有解释 */
            	if (_access(path, 0) == 0) /* 是否存在 */
            		return EXIST;
            	else
            		return NOT_EXIST;
            }
          
            void set_enter_path()
            {
            	int intJudge = 0; /* 用来判断是否决定完成输入 */
            	char tmpBuf[LARGEST_PATH_NAME]; /** 临时缓冲区 **/
            	while (1)
            	{
            		printf("Enter The Path You want!\n");
            		fgets(tmpBuf, LARGEST_PATH_NAME*sizeof(char), stdin); /* 获取输入的路径 */
            		sscanf(tmpBuf, "%s", to_path_buf);
            		if (is_valid_path(to_path_buf) == NOT_EXIST)
            		{
            			fprintf(stderr, "Your Enter is Empty, So Load the Default Path\n");
            			fprintf(stderr, "%s \n", SELF_LOAD_DEFAULT_PATH);
            			strcpy(to_path_buf, SELF_LOAD_DEFAULT_PATH);
            		}
            		fprintf(stdout, "Your Enter is \" %s \" ?(1 for yes, 0 for no) \n", to_path_buf);
          
            		fgets(tmpBuf, LARGEST_PATH_NAME*sizeof(char), stdin);
            		sscanf(tmpBuf, "%d", &intJudge); /* 获取判断数的输入 */
            		if (intJudge != 0)
            		{
            			if (to_path_buf[strlen(to_path_buf) - 1] != '/')
            				strcat(to_path_buf, "/");/* 如果最后一个字符不是'/',则添加,这里没考虑是否越界 */
            			store_hist_path(to_path_buf);
            			break;
            		} /* if(intJudge) */
            	}/* while (1) */
            	return;
            }/* set_enter_path */
          

          这一组函数的功能稍微复杂,大体来说便是 读取路径输入->检查路径有效性->读取判断数->是否结束循环

          其中_access 函数有些渊源,因为这个函数被大家所熟知的是这个形式 access,但由于这个形式是 POSIX 标准,故 Windows 将其实现为_access,用法上还是一样的,就是名字不同而已。

      • 显示历史路径 show_hist_path

        • setPath.h

            /**
             * @version  1.0 2015/10/02
             * author    wushengxin
             * function  用于在窗口显示所有的历史路径
             */
            void show_hist_path();
          
        • setPath.c

            void show_hist_path()
            {
            	system("cls");
            	char outBufName[LARGEST_PATH_NAME] = {'\0'};
            	FILE* reading = Fopen_s(.file = "PathHistory.txt", .mode = "r");
            	if (!reading)
            	return;
          
            	for (int i = 1; i <= 10 && (!feof(reading)); ++i)	
            	{
            		fgets(outBufName, LARGEST_PATH_NAME*sizeof(char), reading);
            		fprintf(stdout, "%2d. %s", i, outBufName);
            	}
            	fclose(reading);
            	system("pause");
            	return;
            }
          
      • 剩下最后一个收尾工作

        • 初始化路径
        • 每次程序启动的时候,我们都会读取本地文件,获取上一次程序使用的最后一个路径,作为当前使用的目的路径
      • 初始化目的路径 init_path

        • setPath.h

            /**
             * @versions  1.0 2015/10/02
             * @author    wushengxin
             * @function  用于每次程序启动时初始化目的路径
             */
            void init_path();
          
        • setPath.c

            void init_path()
            {
            	int len = 0;
            	char last_path[LARGEST_PATH_NAME] = { '\0' };
            	FILE* hist_file = Fopen_s(.file = "LastPath.conf", .mode = "r");
            	if (!hist_file) /* 打开失败则不初始化 */
            		return;
            	fgets(last_path, LARGEST_PATH_NAME, hist_file);
            	len = strlen(last_path);
            	if (len > 1)
            	{
            		last_path[len - 1] = '\0'; /* 消除一个多余的 ‘\n’ */
            		strcpy(to_path_buf, last_path);
            	}
            	return;
            }
          

          这样就大功告成了,对于这个函数中的后8行代码,没使用惯用的fgets 配合 sscanf 是因为如果这么干的话,需要搭配一个memset函数清零,后面会有解释。

写在最后方

  • 具体思路代码完全都贴出来了,除了主界面的某些细微区别没有贴出来,但是自己应该能够完成。
  • 对于memset的解释
    • 这个函数对于大的内存块的初始化实际上是很慢的,当然我们这个30KB左右大概的内存可能影响还没有那么大,但是上以后,调用memset就是一种性能问题了,很多情况下,编译器在开启高优化等级之后会自动帮你取消memset的隐式调用
    • 什么隐式调用,例如 init_path第二行代码,声明并且用花括号初始化这个数组的时候,就会调用隐式memset

结束

  • 下一次要实现的就是,本程序的主体 备份


书籍推荐

此网站出售,联系QQ:779236454