🎈 Epoche 2 / Golang Refactor

Author: cookiengineer

PKGBUILD

@@ -1,12 +1,11 @@
 # Maintainer: Cookie Engineer <@cookiengineer>
 
 pkgname=pacman-backup
-pkgver=r7.e8dd759
+pkgver=r16.7a7623c
 pkgrel=1
-pkgdesc='Backup tool for off-the-grid updates via portable USB sticks or (mesh) LAN networks.'
+pkgdesc='Pacman Backup tool for off-the-grid updates via portable USB sticks or (mesh) LAN networks.'
 arch=('i686' 'x86_64' 'armv6h' 'armv7h' 'aarch64')
-makedepends=('git')
-depends=('nodejs')
+makedepends=('git' 'go')
 url='https://github.com/cookiengineer/pacman-backup'
 license=('GPL')
 provides=('pacman-backup')
@@ -20,8 +19,12 @@ pkgver() {
 	printf "r%s.%s" "$(git rev-list --count HEAD)" "$(git rev-parse --short HEAD)"
 }
 
+build() {
+	cd "${srcdir}/${_gitname}";
+	bash build.sh;
+}
 package() {
-	cd "${srcdir}/${_gitname}"
-	install -Dm755 pacman-backup.js "$pkgdir/usr/bin/pacman-backup";
+	cd "${srcdir}/${_gitname}";
+	install -Dm755 "build/pacman-backup_linux_amd64" "$pkgdir/usr/bin/pacman-backup";
 }
 

README.md

@@ -1,299 +1,82 @@
 
 # Pacman Backup
 
-Backup tool for off-the-grid updates via portable USB sticks or (mesh) LAN networks.
+Offline Pacman Cache management tool that allows off-the-grid updates via
+sneakernet (usb drives) or mesh Wi-Fi networks.
 
 
 ## Share Updates via USB Drive
 
-In the below example, make sure that `pacman-usbdrive` is writable.
-Replace the path with the correct one that points to your mounted USB drive.
+In the below example, make sure that `usb-drive` is writable. Replace the path with
+the correct one that points to your mounted USB drive.
 
-**Step 1**:
-
-On the machine with internet connection, insert and mount the USB drive.
-
-Use `pacman-backup archive` to copy the package cache to the backup folder.
-Use `pacman-backup cleanup` to remain only the latest version of each package.
-
-The `archive` action will also copy the necessary database files for `pacman -Sy`.
+**Step 1**: On the machine _with_ internet connection, insert and mount the USB drive.
 
 ```bash
 # Machine with internet connection
-
-sudo pacman -Sy;
-sudo pacman -Suw;
-
-pacman-backup archive /run/media/$USER/pacman-usbdrive;
-pacman-backup cleanup /run/media/$USER/pacman-usbdrive;
+pacman-backup download /run/media/$USER/usb-drive;
+pacman-backup cleanup /run/media/$USER/usb-drive;
 sync;
 
-# Unmount the USB drive and walk to other machine
+# Unmount the USB drive and sneak/walk to other machine
 ```
 
-**Step 2**:
-
-On the machine without internet connection, insert and mount the USB drive.
-
-Copy the necessary database files to pacman's `sync` folder (which is `$DBPath/sync` of `pacman.conf`).
-
-Use `pacman-backup upgrade` to update from the backupfolder.
-This will output the pacman command that you should verify manually before executing it.
+**Step 2**: On the machine _without_ internet connection, insert and mount the USB drive.
 
 ```bash
 # Machine without internet connection
-
-sudo cp /run/media/$USER/pacman-usbdrive/sync/*.db /var/lib/pacman/sync/;
-pacman-backup upgrade /run/media/$USER/pacman-usbdrive;
-
-# :: Use this to install upgrades from cache:
-#    (...) pacman -U command (...)
+pacman-backup upgrade /run/media/$USER/usb-drive;
 ```
 
+## Share Updates via Wi-Fi Mesh Network
 
-## Share Updates via LAN Connection
-
-In the below example, the machine with internet connection has the IP `192.168.0.10`.
+In the below example, the machine _with_ internet connection has the IP `192.168.0.10`.
 Replace the IP with the correct one that matches your setup. If in doubt, use `ip` or `ifconfig`.
 
 
-**Step 1**:
-
-On the machine with internet connection, connect the LAN cable (and internet connection).
-
-Use `pacman-backup serve` to start a pacman server that can be used by other pacman clients.
+**Step 1**: On the machine with internet connection, download all updates and serve them as
+local pacman archive mirror.
 
 ```bash
 # Machine with internet connection
-
-sudo pacman -Sy;
-sudo pacman -Suw;
-
+sudo pacman-backup download;
 pacman-backup serve;
 ```
 
-**Step 2**:
-
-On the machine without internet connection, connect the LAN cable and verify that the server
-(the machine with internet connection) is reachable via its IP. If in doubt, use `ping`.
-
-Use `pacman-backup download 192.168.0.10` to download the packages to pacman's package cache.
-
-Use `pacman-backup upgrade` to update from the local pacman cache.
-This will output the pacman command that you should verify manually before executing it.
+**Step 2**: On the machine _without_ direct internet connection, download updates from the
+local pacman archive mirror.
 
 ```bash
 # Machine without internet connection
-
-sudo pacman-backup download 192.168.0.10;
-pacman-backup upgrade;
+sudo pacman-backup download http://192.168.0.10:15678/;
+sudo pacman-backup upgrade;
 ```
 
-## Share Updates via LAN Cache Proxy
-
-`pacman-backup` can also emulate a local Cache Proxy for other pacman clients.
-If `pacman-backup serve` is running on the machine with internet connection, it
-can be used for `pacman` directly.
-
-Note that if the packages don't exist, they will appear in the logs but aren't downloaded
-directly; and that partial upgrades are not officially supported by Arch Linux.
 
-In the below example, the machine with internet connection has the IP `192.168.0.10`.
-Replace the IP with the correct one that matches your setup. If in doubt, use `ip` or `ifconfig`.
-
-**Step 1**:
-
-On the machine with internet connection, connect the LAN cable (and internet connection).
-
-Use `pacman-backup serve` to start a pacman server that can be used by other pacman clients.
+## Manual Export and Import of Database Files and Package Cache
 
+If you don't trust automated upgrades and want to use `pacman` directly, that's fine. You
+can do so by using `export` on the machine with internet connection and `import` on the
+machine without internet connection.
 
 ```bash
 # Machine with internet connection
+sudo pacman -Syuw;
+pacman-backup export /run/media/$USER/usb-drive;
+sync;
 
-sudo pacman -Sy;
-sudo pacman -Suw;
-
-pacman-backup serve;
-```
-
-**Step 2**:
-
-Modify the `/etc/pacman.d/mirrorlist` to have as a first entry the following line:
-
-```conf
-# Machine without internet connection
-# Pacman Mirrorlist for local server
-
-Server = http://192.168.0.10:15678
+# Unmount the USB drive and sneak/walk to other machine
 ```
 
-Use `pacman -Sy` and `pacman -Su` to update from the Cache Proxy.
-
 ```bash
 # Machine without internet connection
+sudo pacman-backup import /run/media/$USER/usb-drive;
+sync;
 
-sudo pacman -Sy;
-sudo pacman -Su; # or use -Suw
-```
-
-
-## Advanced Usage
-
-### Available CLI parameters
-
-The `pacman-backup` script tries to identify parameters dynamically, which means that
-they do not have to be written in a specific order. However, to avoid confusion, the
-parameters are detected in different ways; and that is documented here:
-
-- `ACTION` can be either of `archive`, `cleanup`, `download`, `serve`, or `upgrade`. Defaulted with `null` (and shows help).
-- `FOLDER` has to start with `/`. Defaulted with `null` (and uses `/var/cache/pacman/pkg` and `/var/lib/pacman/sync`).
-- `MIRROR` has to start with `https://` and contain the full `mirrorlist` syntaxed URL. Supported variables are `$arch` and `$repo`. Defaulted with `https://arch.eckner.net/os/$arch`.
-- `SERVER` has to be an `IPv4` separated by `.` or an `IPv6` separated by `:`. Defaulted with `null`.
-- `SERVER` can optionally be a `hostname`. If it is a `hostname`, make sure it's setup in the `/etc/hosts` file.
-
-Full example (which won't make sense but is parsed correctly):
-
-```bash
-# IMPORTANT: MIRROR string needs to be escaped, otherwise bash will try to replace it.
-
-pacman-backup download /run/media/cookiengineer/my-usb-drive "https://my.own.mirror/archlinux/\$repo/os/\$arch" 192.168.0.123;
-
-# :: pacmab-backup download
-#    -> FOLDER: "/run/media/cookiengineer/my-usb-drive"
-#    -> MIRROR: "https://my.own/mirror/archlinux/$repo/os/$arch"
-#    -> SERVER: "192.168.0.123"
-#    -> USER:   "cookiengineer"
-```
-
-### archive
-
-`archive` allows to backup everything to a specified folder. It copies the files from
-`/var/cache/pacman/pkg` and `/var/lib/pacman/sync` into `$FOLDER/pkgs` and `$FOLDER/sync`.
-
-```bash
-# copy local packages to /target/folder/pkgs
-# copy local database to /target/folder/sync
-
-pacman-backup archive /target/folder;
-```
-
-### cleanup
-
-`cleanup` allows to cleanup the package cache in a way that only the latest version of
-each package is kept (for each architecture).
-
-If no folder is specified, it will clean up `/var/cache/pacman/pkg`.
-If a folder is specified, it will clean up `$FOLDER/pkgs`.
-
-```bash
-# cleanup /var/cache/pacman/pkg
-
-sudo pacman-backup cleanup;
-```
-
-```bash
-# cleanup /target/folder/pkgs
-
-pacman-backup cleanup /target/folder;
-```
-
-### download
-
-`download` allows to download packages from a `pacman-backup serve` based server.
-
-If no folder and a server is specified, it will run `pacman -Sy` in advance and download to `/var/cache/pacman/pkg`.
-If a folder and a server is specified, it will run `pacman -Sy` in advance and download to `$FOLDER/pkgs`.
-
-If no folder and no server is specified, it will generate a URL list of packages
-that can be copy/pasted into a download manager of choice (e.g. uGet or jdownloader).
-
-```bash
-# download packages to /var/cache/pacman/pkg
-# download database to /var/lib/pacman/sync
-
-sudo pacman-backup download 1.3.3.7;
-```
-
-```bash
-# download packages to /target/folder/pkgs
-# download database to /target/folder/sync
-
-pacman-backup download 1.3.3.7 /target/folder;
-```
-
-```bash
-# generate HTTP/S URL list for packages that need downloading
-
-pacman-backup download;
-```
-
-### serve
-
-`serve` allows to start a `pacman` server that can be used as a local mirror.
-
-If no folder is specified, it will serve from `/var/cache/pacman/pkg` and `/var/lib/pacman/sync`.
-If a folder is specified, it will serve from `$FOLDER/pkgs` and `$FOLDER/sync`.
-
-```bash
-# serve packages from /var/cache/pacman/pkg
-# serve database from /var/lib/pacman/sync
-
-pacman-backup serve;
-```
-
-```bash
-# serve packages from /source/folder/pkgs
-# serve database from /source/folder/sync
-
-pacman-backup serve /source/folder;
-```
-
-### upgrade
-
-`upgrade` allows to generate an executable `pacman` command that uses the specified
-cache folder as a package source by leveraging the `--cachedir` parameter.
-
-If no folder is specified, it will upgrade from `/var/cache/pacman/pkg`.
-If a folder is specified, it will upgrade from `$FOLDER/pkgs`.
-
-```bash
-# generate upgrade command via packages from /var/cache/pacman/pkg
-
-pacman-backup upgrade;
-```
-
-```bash
-# generate upgrade command via packages from /source/folder/pkgs
-
-pacman-backup upgrade /source/folder;
+sudo pacman -Su;
 ```
 
-### upgrade (Partial Upgrades)
-
-`upgrade` also prints out a command for missing packages that need downloading.
-
-In the scenario that the local database says that more packages need to be downloaded
-to update everything, it will output an additional command that is prepared to let
-`pacman` download the packages to the specified folder.
 
-This is helpful in the scenario that the "offline machine" has more packages installed
-than the "online machine" (so that more packages need to be downloaded to fully
-upgrade the "offline machine").
+# License
 
-Then you can simply copy/paste the generated command to a text file and execute it
-next time you're online - in order to automatically download everything that's
-required for the "offline machine".
-
-```bash
-# Example output for partial upgrade scenario
-# (executed on machine without internet connection)
-
-pacman-backup upgrade 1.3.3.7;
-
-# :: Use this to install upgrades from cache:
-#    (...) pacman -U command (...)
-
-# :: Use this to download upgrades into cache:
-#    (...) pacman -Sw --cachedir command (...)
-```
+GPL3

TODO.md

@@ -0,0 +1,8 @@
+
+# actions/Cleanup
+
+- [ ] Implement a cleanup mechanism
+- [ ] Keep only the newest version of package files in the cache
+
+- [ ] Maybe harfbuzz and icu need to be preserved in older versions?
+