phpgt / sync

Synchronise two directories.

Synchronise two directories.

rsync is the tool of choice for ensuring that two directories have the same content, but is only present by default on Unix systems. This repository provides simple recursive directory synchronisation in plain PHP, compatible on Linux, Mac and Windows.

---

Example usage

$source = "/var/www/example.com";
$destination = "/var/backup/example.com";

try {
	$sync = new DirectorySync($source, $destination);
	$sync->exec(DirectorySync::COMPARE_FILEMTIME);
}
catch(SyncException $exception) {
	fwrite(STDERR, "Error performing sync: " . $exception->getMessage());
	exit(1);
}

echo "Sync complete!" . PHP_EOL;
echo "Changed: " . count($sync->getCopiedFilesList());
echo "Deleted: " . count($sync->getDeletedFilesList());
echo "Skipped: " . count($sync->getSkippedFilesList());

Features

• Cross-platform compatible directory synchronisation (Linux, Windows, Mac).
• Selective sync through glob matches (only sync js files within script directory with /script/**/*.js).
• Get statistics of copied/deleted/skipped files after sync execution.
• Low memory footprint.

sync's Issues

Non-zero exit code when not enough arguments

This is probably a CLI issue, but seeing as it's affecting me while using Sync, I'll track it here.

Duplicate issue: PhpGt/Cli#236

Dependabot

Dependabot needs to be tamed, as per PhpGt/WebEngine#568.

Update Sync CI and test automation

Before working on the new functionality, this needs to be completed.

Sync directories that have been deleted

If a source directory is deleted, its files are removed from the destination but the empty folder stays.

If source is directory, sync entire contents, otherwise only sync matches

This is untested specific behaviour. It might already work like this, but it's good to be sure.

When a source attribute is a file, only sync that file.

When a source attribute is a directory, sync the entire contents of the directory (**/*).

When a source attribute is a pattern, use the pattern to decide what to sync.

Exec copy only files that match a glob

Useful to sync directories and only copying .css or .js, for example.

Incorrect usage of default parameter

Sync/src/Command/SyncCommand.php

Line 14 in 75bc747

$pattern = $arguments->get("pattern", null);

Line 14 of SyncCommand passes null into a string parameter. Expected behaviour is to adopt the default parameter value instead.

Pass wildcard glob by default

Expose functionality for checking two directories

Sync will be used by Build to keep the asset directory in sync with www/asset, and any CSS and JS files, but it can also be used to check if there are any changes in a directory for the rest of the Build functionality.

Need the functionality of returning a mtime or hash for a whole directory.

Symlink improvements

After using symlinks for a while, I have identified the following issues:

• Relative paths don't work when there are different parent directories - use realpath
• PHP Warning: symlink(): File exists - no need to symlink if it already exists (unchanged)
• If the origin directory changes, and the symlink already exists, it should be removed first (or re-linked, if possible)

Github actions

Strange issue when using within `gt build`

This needs investigation. Here's the output I get when using gt build on webengine v4:

gt build
asset main.js 68 bytes [compared for emit] [minimized] (name: main) 1 related asset
./script/main.es6 36 bytes [built] [code generated]
webpack 5.54.0 compiled successfully in 122 ms
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied , skipped 67, deleted 0.
Copied , skipped 67, deleted 0.
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied , skipped 67, deleted 0.
Copied , skipped 67, deleted 0.
Copied 0, skipped 67, deleted .
Copied , skipped 67, deleted 0.
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted 0.
Copied , skipped 67, deleted 0.
Copied , skipped 67, deleted 0.
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied , skipped 67, deleted 0.
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted .
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted 0.
Copied , skipped 67, deleted 0.
Copied 0, skipped 67, deleted 0.
Copied 0, skipped 67, deleted .
Copied , skipped 67, deleted 0.
Copied 0, skipped 67, deleted .
2021-09-28 17:53:30	Success: webpack
2021-09-28 17:53:30	Success: sass
2021-09-28 17:53:30	Success: vendor/bin/sync
Build script completed in 8.9 seconds.

Remove files that have been removed from source

Currently in an ordinary webengine application, I just deleted all assets from a directory and the asset directory is still full within www.

Symlinks

It's really useful on some projects to symlink a non-webroot directory into the webroot. This could be set up with a simple ln -s, but doing it as the correct web user, and making sure that nested directories are handled automatically, would be really helpful.

This issue is part of PhpGt/Build#222

Default pattern to *

If a pattern isn't provided, default it to any file.

Document basic Sync functionality

This repo is really simple, so the docs don't need to be long.

Just the basics is required. Let's get it done!