BackupScript release 1.0.0

Author: We0M

7z.dll

@@ -1,3 +1,5 @@
+7zip LICENSE - https://www.7-zip.org/license.txt
+
                   GNU LESSER GENERAL PUBLIC LICENSE
                        Version 2.1, February 1999
 

7z.exe

@@ -0,0 +1,37 @@
+# BackUp Script
+
+**English | [Русский](docs/ru/Readme_ru.md)**
+
+Latest version: **[Download](https://github.com/We0M/BackupScript/releases/download/1.0.0/En_BackUp_Script.zip)**
+
+## Actions after downloading
+
+1. Unzip to a convenient location.
+2. Open **`backup_script_en.ps1`** and customize it for yourself. Almost all parameters have a description, **[below are some aspects](#additional-information)** that may not be entirely obvious.
+3. In **`Task Scheduler`** create a new task with the action **`Start a program`**, in the **`Program/script`** field, enter:
+```cmd
+Powershell
+```
+- In the  **`Add arguments`** field, enter:
+```Powershell
+-ExecutionPolicy RemoteSigned -File "%userprofile%\Desktop\BackupScript\backup_script_ru.ps1"
+```
+> [!NOTE]
+>I added the path to the file in the arguments as an example, but you must specify the full path to the folder with the script there! The path specified in the example leads to the `BackupScript` folder on the desktop. **`%userprofile%`** - macro for accessing the user folder
+
+> [!CAUTION]
+> Check if everything was done correctly by forcing the task. To do this, in the task scheduler, select the task you created and click `Run`, or right-click on this task and click `Run`.
+
+---
+
+## Additional information
+
+- ### Date
+  To use backup more often than once a day, there are 2 options:
+  - update the data in the archive, no action is required for this. In this case, only the data that has changed since the previous backup of the same day will be added;
+  - if separate archives are required, you need to change the date format in the variable `$date = Get-Date -Format "yyyy_MM_dd"` to `$date = Get-Date -Format "yyyy_MM_dd_HH_mm"` i.e. add hours and minutes.
+
+- ### [List sources and exclusions](docs/Sources_and_Exclusions.md)
+- ### [Add task to `Task Scheduler`](docs/Task_Scheduler.md)
+
+---

LICENSE

@@ -0,0 +1,80 @@
+#############################
+### BackUp Script by WeoM ###
+#############################
+
+$version = "1.0"
+$scriptName = "BackUp Script $version by WeoM"
+
+#Load lib WinForms
+Add-Type -AssemblyName System.Windows.Forms
+
+#Create message
+$result = [System.Windows.Forms.MessageBox]::Show("Need to make a backup. Click 'Ok' when you are ready.", "$scriptName", [System.Windows.Forms.MessageBoxButtons]::OKCancel, [System.Windows.Forms.MessageBoxIcon]::Information)
+
+function Get-Timestamp {
+    return (Get-Date).ToString("dd.MM.yyyy HH:mm:ss")
+}
+
+if($result -eq [System.Windows.Forms.DialogResult]::OK) {
+    # get the path to folder where the executable script is located: source.txt exclude.txt 7z.exe 7z.dll
+    $path = $PSScriptRoot
+    $7z = Join-Path -Path $path -ChildPath "7z.exe"
+    # WARNING! in source.txt and exclude.txt files it is necessary to use full paths because of the -spf2 key
+    # in source.txt we add folders and files that are added to the backup
+    $sourceList = Join-Path -Path $path -ChildPath "source.txt"
+    # exclusions are added to exclude.txt
+    $excludeList = Join-Path -Path $path -ChildPath "exclude.txt"
+    # the folder where the backups will be saved
+    $target = "D:\BackupFolderName\"
+    # current date in format 2024_01_01
+    $date = Get-Date -Format "yyyy_MM_dd"
+    # name of the resulting file
+    $filename = "backup_$date.7z"
+    # optionally you can add a password to the archive, to do this you need to enter the desired password between ""
+    $pwd = ""
+
+    $check = $true
+    $counter = 0
+    while($check -and $counter -le 4) {
+        # verification is necessary because of the -mhe key, otherwise the archive will be without a password but with encrypted headers.
+        if(-not $pwd) {
+            Write-Host "`n$(Get-Timestamp) Create a backup without a password" -ForegroundColor Magenta
+            & $7z a -t7z (Join-Path -Path $target -ChildPath $filename) -bt -mx5 -ssw -snh -snl -ssp -spf2 @$sourceList -xr@"$excludeList" -scrcSHA256
+        } else {
+            Write-Host "`n$(Get-Timestamp) Create a backup with a password" -ForegroundColor DarkGreen
+            & $7z a -t7z (Join-Path -Path $target -ChildPath $filename) -bt -mx5 -ssw -snh -snl -ssp -spf2 -p"$pwd" -mhe @$sourceList -xr@"$excludeList" -scrcSHA256
+        }
+
+        # check archive and data integrity
+        Write-Host "`nCheck archive and data integrity. Wait..." -ForegroundColor Blue
+        $result = & $7z t (Join-Path -Path $target -ChildPath $filename) -p"$pwd"
+        if ($result -like "*Everything is Ok*") {
+            foreach ($line in $result) {
+                 Write-Host $line -ForegroundColor DarkYellow
+            }
+            Write-Host "`n$(Get-Timestamp) backup successfully created! `nFile name: $filename  `nPath: $target " -ForegroundColor Green
+            Write-Host "This window will close in 5 seconds..."
+            Start-Sleep -Seconds 5
+            $check = $false
+        } else {
+            Write-Host "`n$(Get-Timestamp) ERROR:" -ForegroundColor Red
+            foreach ($line in $result) {
+                 Write-Host $line -ForegroundColor Red
+            }
+        }
+
+        $counter += 1
+
+        # if the archive could not be created in 5 attempts, the cycle ends
+        if ($counter -gt 4) {
+            $errorMessage  = "`n$(Get-Timestamp) Failed to create archive after $counter attempts. Operation cancelled."
+            Write-Host $errorMessage -ForegroundColor Red
+            [System.Windows.Forms.MessageBox]::Show("$errorMessage", "$scriptName", [System.Windows.Forms.MessageBoxButtons]::OK, [System.Windows.Forms.MessageBoxIcon]::Error)
+            $check = $false
+        }
+    }
+} else {
+    Write-Host "`n$(Get-Timestamp)Backup creation cancelled." -ForegroundColor Red
+    Write-Host "This window will close in 5 seconds..."
+    Start-Sleep -Seconds 5
+}

README.md

@@ -0,0 +1,115 @@
+# List sources and exclusions
+
+Let's assume you have the following folder structure:
+```
+C:\data\
+    ├── important\
+    │   ├── docs\
+    │   │   ├── .exclude\
+    │   │   ├── file5.tmp
+    │   │   └── file6.tmp
+    │   ├── .exclude\
+    │   ├── file1.txt
+    │   └── file2.txt
+    └── temp\
+        ├── .exclude\
+        ├── file3.tmp
+        └── file4.tmp
+```
+
+> [!CAUTION]
+> All paths must be full, not absolute, i.e. the path must start with a drive letter.
+
+
+## List file source.txt
+
+1. **File format**:
+
+In the file, you can specify paths to files and folders that you want to archive, and also add comments, starting the line with `#`. Each path must be on a separate line.
+For example:
+```
+C:\data\important\file1.txt
+C:\data\important\file2.txt
+# this line is ignored by 7-Zip
+C:\data\important\docs\
+```
+
+> [!NOTE]
+> If the path contains spaces, it must be enclosed in quotation marks:
+> ```
+> "C:\path with spaces\file1.txt"
+> ```
+
+2. **Templates**:
+
+You can use wildcards (`*` and `?`) to specify file groups:
+   - `*` - matches any number of characters (including zero).
+     ```md
+      `C:\path\to\*.txt` includes all files with the extension `.txt` in the specified folder.
+     ```
+   - `?` - matches any single character.
+     ```md
+      `C:\path\to\file?.txt` matches `file1.txt`, `file2.txt`, but not `file10.txt`.
+     ```
+You can use `**` to recursively search for files in all subdirectories.
+   ```md
+      `C:\path\to\**\*.jpg` includes all `.jpg` files in the specified folder and all its subdirectories.
+   ```
+
+## exclude.txt
+
+To exclude individual files or folders that you do not want to save in the backup, use the `exclude.txt` file.
+
+### Examples of exceptions:
+
+1. **Single file exclusion**:
+   ```md
+   C:\data\important\file1.txt
+   ```
+
+2. **Exclude all files of a certain type**:
+   ```md
+   C:\data\temp\*.tmp
+   ```
+
+3. **Exclude a specific folder**:
+   ```md
+   C:\data\temp\
+   ```
+
+4. **Exclude all folders of a specific name**:
+   ```md
+   *.exclude\*
+   ```
+
+---
+
+## Example of use
+
+If you want to archive the entire `data` folder, excluding the `temp` folder, all `.tmp` files in all folders, as well as the `.exclude` folders, for this:
+- Add a line to the `source.txt` file
+   ```
+   C:\data\
+   ```
+- Add lines to the `exclude.txt` file
+   ```
+   C:\data\temp\ # excludes temp folder
+   *.tmp # excludes all files with the .tmp extension in all folders
+   *.exclude\* # excludes all folders named .exclude and their contents in all folders
+   ```
+
+As a result, the following structure will be preserved:
+
+```
+C:\data\important\
+        ├── docs\
+        │   ├── file5.tmp
+        │   └── file6.tmp
+        ├── file1.txt
+        └── file2.txt
+```
+
+[<- return to README](/README.md)
+
+---
+

backup_script_en.ps1

@@ -0,0 +1,76 @@
+# Add task to `Task Scheduler`
+
+To add a task to the **Task Scheduler** in Windows, follow these steps:
+
+To create a more advanced task in Task Scheduler, follow these detailed steps:
+
+### 1. **Open Task Scheduler:**
+   - Press `Windows + R` to open the Run dialog.
+   - Type `taskschd.msc` and hit `Enter` to open Task Scheduler.
+
+### 2. **Create a New Task:**
+   - In the left pane, select **Task Scheduler Library** to see existing tasks.
+   - In the **Actions** pane on the right side, click **Create Task** (not **Create Basic Task**). This gives you more control over the task's configuration.
+
+### 3. **General Tab:**
+   - **Name**: Enter a descriptive name for your task.
+   - **Description**: (Optional) Provide a description for the task.
+   - **Security options**:
+     - Choose the user account under which the task will run.
+     - If you want the task to run with elevated privileges (as administrator), check **Run with highest privileges**.
+   - **Configure for**: Select the version of Windows you're using, or leave it set to **Windows 10** (default).
+
+### 4. **Triggers Tab:**
+   Triggers define when the task will run. You can set multiple triggers for one task.
+   - Click **New** to create a trigger.
+   - **Begin the task**: Choose when the task should trigger. Options include:
+     - **On a schedule**: Daily, Weekly, Monthly, etc.
+     - **At logon**: When you log into Windows.
+     - **At startup**: When Windows starts.
+     - **On an event**: When a specific system event occurs.
+     - **On idle**: When the system is idle.
+   - Once you configure the trigger, click **OK**.
+
+### 5. **Actions Tab:**
+   Actions define what the task will actually do once triggered.
+   - Click **New** to define an action.
+   - **Action**: Select **Start a program** (this is the most common option).
+     - In the **Program/script** field, enter:
+     ```cmd
+     Powershell
+     ```
+     - In the  **`Add arguments`** field, enter:
+     ```Powershell
+     -ExecutionPolicy RemoteSigned -File "%userprofile%\Desktop\BackupScript\backup_script_ru.ps1"
+     ```
+> [!NOTE]
+>I added the path to the file in the arguments as an example, but you must specify the full path to the folder with the script there! The path specified in the example leads to the `BackupScript` folder on the desktop. `%userprofile%` - macro for accessing the user folder
+
+   - Once you're done, click **OK**.
+
+### 6. **Conditions Tab:**
+   Conditions define additional requirements for the task to run. These are optional, but helpful if you want the task to have specific conditions:
+   - **Start the task only if the computer is idle for**: Specifies how long the computer must be idle before the task starts.
+   - **Stop if the computer switches to battery power**: Useful for laptops to conserve battery life.
+   - **Wake the computer to run this task**: Check this if you want the task to run even when the system is in sleep mode.
+   - Configure these options as per your needs, then click **OK**.
+
+### 7. **Settings Tab:**
+   The Settings tab allows you to configure additional behaviors for the task.
+   - **Allow task to be run on demand**: This lets you manually start the task if desired.
+   - **If the task fails, restart every**: Set up a retry interval and how many attempts should be made if the task fails.
+   - **Stop the task if it runs longer than**: Useful for long-running tasks to avoid hanging processes.
+   - **If the task is already running, then the following rule applies**: You can specify whether to run a new instance or wait for the existing task to finish.
+   - After configuring, click **OK**.
+
+### 8. **OK and Save the Task:**
+   - After completing all the tabs, click **OK** to save the task.
+   - If prompted, enter your password or provide appropriate credentials if the task is set to run with elevated privileges.
+
+### 9. **Verify the Task:**
+   - Once created, your task will appear in the **Task Scheduler Library**.
+   - You can **right-click** the task and select **Run** to manually trigger it or **Properties** to edit it.
+
+[<- return to README](/README.md)
+
+---

backup_script_ru.ps1

@@ -0,0 +1,37 @@
+# BackUp Script
+
+**[English](/README.md) | Русский**
+
+Последняя версия: **[Скачать](https://github.com/We0M/BackupScript/releases/download/1.0.0/Ru_BackUp_Script.zip)**
+
+## Действия после скачивания
+
+1. Разархивировать в удобное место.
+2. Откройте **`backup_script_ru.ps1`** и настройте под себя. Практически все параметры имеют описание, **[ниже рассмотрены](#дополнительная-информация)** аспекты, которые могут быть не совсем очевидны.
+3. В **`планировщике заданий`** создайте новую задачу с действием **`Запуск программы`**, в поле **`Программа или сценарий`** введите:
+```cmd
+Powershell
+```
+в поле **`Добавить аргументы`** введите:
+```Powershell
+-ExecutionPolicy RemoteSigned -File "%userprofile%\Desktop\BackupScript\backup_script_ru.ps1"
+```
+> [!NOTE]
+> Путь к файлу в аргументах я добавил для примера, вы же должны там указать полный путь к папке со скриптом! Указанный в примере путь ведёт к папке `BackupScript` на рабочем столе. **`%userprofile%`** - макрос для доступа к папке пользователя
+
+> [!CAUTION]
+> Проверьте, всё ли правильно сделали, выполнив принудительно задачу. Для этого в планировщике заданий выделите созданную вами задачу и нажмите `Выполнить`, либо нажмите ПКМ по этой задаче и нажмите `Выполнить`.
+
+---
+
+## Дополнительная информация
+
+- ### Date
+  Для использования бекапа чаще чем раз в сутки есть 2 варианта:
+  - просто обновить данные в архиве, для этого никаких действий не требуется. В этом случае будут добавлены только данные, которые изменились с момента предыдущего бекапа того же дня;
+  - если же требуются отдельные архивы, для этого необходимо изменить формат даты в переменной `$date = Get-Date -Format "yyyy_MM_dd"` на `$date = Get-Date -Format "yyyy_MM_dd_HH_mm"` т.е добавить часы и минуты.
+
+- ### [Список источников и исключения](Sources_and_Exclusions_ru.md)
+- ### [Добавление задачи в `Планировщик заданий`](Task_Scheduler_ru.md)
+
+---