[C#] Fileシステムを利用したバックアッププログラム

こんにちは。明月です。
今日はＦｉｌｅ扱うIOとContextメニューを利用してバックアッププログラムを作成します。

開発概要

我々がＷｉｎｄｏｗＯＳでドキュメント作業、各種業務するときに急いで処理することによって、デスクトップ等にデータを移すことあるいは作成しておくことにすることでパソコンのファイル整理状況が悪くなる場合があります。(たまに仕事しながらデスクトップ画面にドキュメントでいっぱいになったことをみたことあります。その状況で仕事をすることが不思議だと思いました。）
そのたびにディレクトリを整理するしバックアップしてから仕事しますね。その時に筆者はファイル整理とファイルバックアップをマウスクリックの一つで整理をできれば、いいじゃないかだと思い出してプロジェクトを企画しました。

システム概要

プログラム開発言語は「Ｃ＃」で開発します。
実行する方法はコンソールタイプで開発しますがＥｘｐｌｏｒｅｒのＣｏｎｔｅｘｔメニューに登録してメニューからクリックさせたらファイルやディレクトリを特定にバックアップパスにコピーあるいは移動します。

要件定義

Ｉｎｐｕｔ	システム	Ｏｕtｐｕｔ	説明
Iniファイル	Ｉｎｉの環境ファイル読み込むモジュール	-	バックアップするパスとコピーかファイル移動かの区分する設定値がある環境ファイルを読み込むモジュール
-	レジストリ管理モジュール	ファイルやディレクトリのContextメニューにＢａｃｋｕｐ追加	レジストリのＣｏｎｔｅｘｔメニューを修正および登録するモジュール
バックアップする対象のファイルやディレクトリ	ファイルシステム	環境ファイルで設定されたバックアップパスにファイルをコピーあるいは移動	ＩＯを利用してファイル移動およびコピー

実装

環境ファイルを読み込むモジュール（Iniタイプの環境ファイルを読み込む)

IniReader.cs

using System; using System.Text; using System.Runtime.InteropServices; namespace BackupProgram { /// <summary> /// Com+のプロファイル扱うメソッドおよびWindowのポップアップ /// </summary> class IniReader { //Com+　組み込み関数でIniファイルを書き込む時に使います。 [DllImport("kernel32.dll")] private static extern long WritePrivateProfileString(String section, String key, String val, String filepath); //Com+　組み込み関数でIniファイルを読み込む時に使います。 [DllImport("kernel32.dll")] private static extern long GetPrivateProfileString(String section, String key, String def, StringBuilder retVal, int size, String filepath); //Com+　Windowメッセージポップアップ [DllImport("User32.dll")] public static extern int MessageBox(int hWnd, String lpText, String lpCaption, int uType); private const String SECTION = "CONFIG"; private static class CONFIG { public const String DIR = "BACKUP_DIR"; public const String TYPE = "TYPE"; } private const String INI_NAME_BACKUP = "Backup"; private const String CONFIG_NAME = "config.ini"; public static String FILE_MOVE = "M"; public static String FILE_COPY = "C"; private String DEFAULT_DIRECTORY = Util.ExecutablePath + Util.Separator + INI_NAME_BACKUP; private const int BUFFER_SIZE = 4096; private String backup_directory = null; private String process_type = null; /// <summary> /// 基本環境ファイルを生成 /// </summary> public void Apply() { //バックアップするバスを生成 WritePrivateProfileString(SECTION, CONFIG.DIR, DEFAULT_DIRECTORY, Util.ExecutablePath + Util.Separator + CONFIG_NAME); //バックアップするタイプを生成 //M : ファイル移動 //C : ファイルコピー WritePrivateProfileString(SECTION, CONFIG.TYPE, FILE_MOVE, Util.ExecutablePath + Util.Separator + CONFIG_NAME); } /// <summary> /// 環境ファイルからバックアップするパスを取得する。 /// </summary> public String BackupDirectory { get { if (backup_directory == null) { StringBuilder sb = new StringBuilder(); GetPrivateProfileString(SECTION, CONFIG.DIR, DEFAULT_DIRECTORY, sb, BUFFER_SIZE, Util.ExecutablePath + Util.Separator + CONFIG_NAME); backup_directory = sb.ToString(); } return backup_directory; } } /// <summary> /// 環境ファイルからバックアップタイプを取得する。 /// </summary> public String ProcessType { get { if(process_type == null) { StringBuilder sb = new StringBuilder(); GetPrivateProfileString(SECTION, CONFIG.TYPE, FILE_MOVE, sb, BUFFER_SIZE, Util.ExecutablePath + Util.Separator + CONFIG_NAME); process_type = sb.ToString(); } return process_type; } } } }

レジストリの中でＣｏｎｔｅｘｔメニューの項目ににＢａｃｋｕｐメニューを追加するモジュール。

バックアッププログラムで特定パラメタを入力するとレジストリ及び環境ファイルを生成するクラスです。

RegApply.cs

using System; using System.Runtime.InteropServices; using System.Security; using System.Security.Permissions; using Microsoft.Win32; namespace BackupProgram { /// <summary> /// 初期レジストリクラス(WindowのファイルとディレクトリのContextMenu追加) /// </summary> class RegApply { private int APPLY_COUNT = 0; private const String REG_NAME_BACKUP = "Backup"; private const String PARAMETER_OPTION = " \"%V\""; private const String COMMAND_PATH = "command"; private String[] MENU_NAME = new String[] { "Directory" + Util.Separator + "shell" + Util.Separator + REG_NAME_BACKUP, "Directory" + Util.Separator + "Background" + Util.Separator + "shell" + Util.Separator + REG_NAME_BACKUP, "*" + Util.Separator + "shell" + Util.Separator + REG_NAME_BACKUP }; private String[] COMMANDER; private String HKEY_CLASSES_ROOT = "HKEY_CLASSES_ROOT" + Util.Separator; private String FileName; /// <summary> /// コンストラクタ(メンバー変数初期化) /// </summary> public RegApply() { String code = System.Reflection.Assembly.GetExecutingAssembly().GetName().CodeBase; FileName = System.IO.Path.GetFileName(code); APPLY_COUNT = MENU_NAME.Length; COMMANDER = new String[APPLY_COUNT]; for (int i = 0; i < APPLY_COUNT; i++) { COMMANDER[i] = MENU_NAME[i] + Util.Separator + COMMAND_PATH; } } /// <summary> /// 実行 /// </summary> public void Run() { for (int i = 0; i < APPLY_COUNT; i++) { PermissionReg(MENU_NAME[i], COMMANDER[i]); DeleteReg(MENU_NAME[i], COMMANDER[i]); CreateReg(MENU_NAME[i], COMMANDER[i]); } } /// <summary> /// 修正するレジストリに権限を与える。 /// </summary> /// <param name="menuname">ルートレジストリパス</param> /// <param name="command">命令レジストリパス</param> private void PermissionReg(String menuname, String command) { try { RegistryPermission regPerm = new RegistryPermission( RegistryPermissionAccess.Write, HKEY_CLASSES_ROOT + menuname); regPerm.AddPathList( RegistryPermissionAccess.Write, HKEY_CLASSES_ROOT + command); regPerm.Demand(); } catch (Exception e) { Console.WriteLine(e.ToString()); throw e; } } /// <summary> /// 既存レジストリ削除 /// </summary> /// <param name="menuname">ルートレジストリパス</param> /// <param name="command">命令レジストリパス</param> private void DeleteReg(String menuname, String command) { try { Registry.ClassesRoot.DeleteSubKey(command); Registry.ClassesRoot.DeleteSubKey(menuname); } catch (Exception e) { Console.WriteLine(e.ToString()); } } /// <summary> /// レジストリ登録 /// </summary> /// <param name="menuname">ルートレジストリパス</param> /// <param name="command">命令レジストリパス</param> private void CreateReg(String menuname, String command) { try { using (RegistryKey regmenu = Registry.ClassesRoot.CreateSubKey(menuname)) { regmenu.SetValue(String.Empty, REG_NAME_BACKUP); } using (RegistryKey regcmd = Registry.ClassesRoot.CreateSubKey(command)) { regcmd.SetValue(String.Empty, Util.ExecutablePath + Util.Separator + FileName + PARAMETER_OPTION); } } catch (Exception e) { Console.WriteLine(e.ToString()); throw e; } } } }

コンソールあるいはコンテクストメニューから選択する時にファイルをコピーおよび移動するモジュール

実際に本システムのメインクラスになりますが、環境ファイルからバックアップするパスを取得し、コンテクストメニューあるいはコンソールからバックアップするファイルかディレクトリのパスを受け取ってコピーまたは移動させるクラスです。

BackupCopy.cs

using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.IO; namespace BackupProgram { /// <summary> /// バックアップクラス /// </summary> class BackupCopy { private String parameter = null; /// <summary> /// コンストラクタ設定 /// </summary> /// <param name="parameter">バックアップする対象のパス</param> public BackupCopy(String parameter) { this.parameter = parameter; } /// <summary> /// 実行 /// </summary> /// <param name="ini">環境ファイル設定値</param> public void Run(IniReader ini) { String type = ini.ProcessType; DateTime time = DateTime.Now; String path = ini.BackupDirectory + String.Format("{0}{1:0000}{2:00}{3:00}", Util.Separator, time.Year, time.Month, time.Day); String item = CheckItem(parameter); if (!Directory.Exists(path)) { Directory.CreateDirectory(path); } FileAttributes attr = File.GetAttributes(item); if (Object.Equals(attr & FileAttributes.Directory, FileAttributes.Directory)) { DirectoryCopy(item, path, type); } else { FileCopy(item, path, type); } } /// <summary> /// ディレクトリ生成 /// </summary> /// <param name="name">対象のディレクトリパス</param> /// <param name="destinationDir">バックアップするところのパス</param> /// <returns></returns> private String CreateDirectory(String name, String destinationDir) { String directoryName = name; String buffer = directoryName; for (int i = 1; Directory.Exists(destinationDir + Util.Separator + buffer); i++) { buffer = directoryName + "_" + i; } directoryName = destinationDir + Util.Separator + buffer; Directory.CreateDirectory(directoryName); return directoryName; } /// <summary> /// バックアップを行う(ディレクトリ) /// </summary> /// <param name="targetDir">対象ディレクトリ</param> /// <param name="destinationDir">バックアップするところのパス</param> /// <param name="pType">バックアップタイプ C:コピー M:移動</param> private void DirectoryCopy(String targetDir, String destinationDir, String pType) { DirectoryInfo info = new DirectoryInfo(targetDir); String directoryName = CreateDirectory(info.Name, destinationDir); FileInfo[] files = info.GetFiles(); DirectoryInfo[] directorys = info.GetDirectories(); foreach (FileInfo file in files) { FileCopy(file.FullName, directoryName, pType); } foreach (DirectoryInfo directory in directorys) { DirectoryCopy(directory.FullName, directoryName, pType); } if (!Object.Equals(pType, IniReader.FILE_COPY)) { info.Delete(); } } /// <summary> /// バックアップを行う(ファイル) /// <param name="name">対象のディレクトリパス</param> /// /// <param name="ext">拡張子</param> /// <param name="destinationPath">バックアップするところのパス</param> /// <returns></returns> private String CreateFile(String name, String ext, String destinationPath) { String fileName = name; int pos = fileName.LastIndexOf('.'); String buffer; if (pos > -1) { buffer = fileName.Substring(0, pos); } else { buffer = fileName; } for (int i = 0; File.Exists(destinationPath + Util.Separator + buffer + ext); i++) { buffer = fileName.Substring(0, pos) + "(" + i + ")"; } fileName = buffer + ext; return fileName; } private void FileCopy(String targetPath, String destinationPath, String pType) { FileInfo info = new FileInfo(targetPath); String fileName = CreateFile(info.Name, info.Extension, destinationPath); if (Object.Equals(pType, IniReader.FILE_COPY)) { info.CopyTo(destinationPath + Util.Separator + fileName, false); } else { info.MoveTo(destinationPath + Util.Separator + fileName); } } private String CheckItem(String path) { if (File.Exists(path)) { return path; } if (Directory.Exists(path)) { return path; } throw new Exception("バックアップ対象を設定してないです。"); } } }

各種ユーティリティクラス

本システムのディレクト区切り文字、実行するパス、重要なドライブなどを取得するクラスです。

Util.cs

using System; using System.IO; using System.Windows.Forms; namespace BackupProgram { /// <summary> /// 静的メソッドのクラス /// </summary> static class Util { private static String executable_path = null; private static String separator = null; private static String main_drive = null; /// <summary> /// ディレクトリ区切り /// </summary> public static String Separator { get { if(separator == null) { separator = Path.DirectorySeparatorChar.ToString(); } return separator; } } /// <summary> /// 実行プログラムのパス /// </summary> public static String ExecutablePath { get { if(executable_path == null) { String path = Application.ExecutablePath; int pos = path.LastIndexOf(Separator); executable_path = path.Substring(0, pos); } return executable_path; } } /// <summary> /// メインドライブ /// </summary> public static String MainDrive { get { if(main_drive == null) { main_drive = Path.GetPathRoot(Environment.GetFolderPath(Environment.SpecialFolder.System)); } return main_drive; } } } }

実行されるＭａｉｎメソッドのモジュール

スタートポイントになるクラスですが、パラメタ検証、デバック処理などが実行されています。

Program.cs

using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace BackupProgram { class Program { private String[] parameter = null; /// <summary> /// 実行クラスのコンストラクタ /// </summary> /// <param name="parameter"></param> public Program(string[] parameter) { this.parameter = parameter; } /// <summary> /// 実行メソッド /// </summary> public void Run() { String param = parameter[0]; IniReader ini = new IniReader(); //登録処理 if (Object.Equals("APPLY", param.ToUpper())) { if(parameter.Length != 1) { throw new Exception("登録処理中でパラメタが間違っています。"); } new RegApply().Run(); ini.Apply(); return; } //バックアップフォルダーを開く。 if (Object.Equals("OPEN", param.ToUpper())) { if(parameter.Length != 2) { throw new Exception("バックアップフォルダーを開く中でパラメタが間違っています。"); } System.Diagnostics.Process.Start("explorer.exe", ini.BackupDirectory); return; } //バックアップ if(parameter.Length != 1) { throw new Exception("バックアップ中でパラメタが間違っています。"); } new BackupCopy(parameter[0]).Run(ini); } /// <summary> /// メインスタート /// </summary> /// <param name="args">実行パラメタ</param> static void Main(string[] args) { #if DEBUG args = new String[] { @"APPLY" }; #endif try { if (args.Length != 1 && args.Length != 2) { throw new Exception("パラメタが間違っています。"); } new Program(args).Run(); } catch (Exception e) { IniReader.MessageBox(0, e.ToString(), "ERROR", 0); } #if DEBUG Console.WriteLine("Press Any Key..."); Console.ReadLine(); #endif } } }

VisualStuioに上のソースを実装してそのままにデバックすると下記のイメージの結果が表示されます。

環境設定

プロジェクトの「Bin」フォルダの「Debug」フォルダを開くと「BackupProgram.exe」がありますが、コンソール環境で「BackupProgram.exe Apply」の命令語を入れって実行するとレジストリ及び環境ファイルが生成されます。

「Apply」のパラメタを通って環境ファイルを生成すると該当プログラム「BackupProgram.exe」と同じフォルダに「config.ini」ファイルができたことを確認できます。

「config.ini」ファイル(環境ファイル)を開いて「BACKUP_DIR」キーをバッグアップするパスに設定、「TYPE」キーを「Ｍ」の場合はファイルを移動、「Ｃ」の場合はファイルをコピーすることに設定しまう。

実行

ファイルを選択してマウスの右クリックするとコンテクストメニューに「Backup」メニューが追加されることを確認できます。

ファイルと同じ通りにフォルダーを選択してマウスの右クリックするとコンテクストメニューに「Backup」メニューが追加されることを確認できます。

各ファイルとフォルダーのコンテクストメニューの「Backup」メニューをクリックすると上の環境ファイルに設定したバックアップパスにファイルをコピーあるいは移動することを確認できます。

ここまでがコンテクストメニューを経由するバックアップするシステムを開発から運用までの説明です。

Githubリンク - Ｃｏｎｔｅｘｔメニューバックアップソース

zipファイルリンク　- Ｃｏｎｔｅｘｔメニューバックアップソース(zip)

前の投稿で勉強したファイルシステム（IO)から簡単なバックアップシステムを作成してみました。ファイルシステム（IO)を勉強する時にはIOだけでは何もできなさそうだったと思いましたが、コンテクストメニューを利用してIOだけでもバックアップシステムを作ることができます。
もちろん、市販プログラムと比べると性能の差があると思いますが、バックアップ機能だけでも十分に楽なプログラムを開発することができるというのがよいと思います。
一つの投稿で簡単に作成したプログラムなのでバグが結構多いと思いますが、このプログラムからもっと発展させてもっといいプログラムを作る方がいらっしゃればこのソースを遠慮なく利用してください。

筆者ももっと良いアイデアがあれば、本ブログを通って開発しながら投稿します。