/**
* Restore the database from a local file.
*
* @SideEffects:
* Restores dump file to local database
*
* @return bool true on success, false on fail
* @throws PermissionFailureException
* @throws Exception
*/
public function execute()
{
$this->checkPerm();
$fullPath = FileSystemTools::build_path($this->Path, $this->FileName);
if (!file_exists($fullPath)) {
$this->failed("No such file '{$fullPath}'");
throw new Exception("No such file {$fullPath}");
}
// detect if we should use GZIP from the file name terminal extension being '.gz'
if (substr($this->FileName, -3) == '.gz') {
$this->UseGZIP = true;
$command = sprintf("gunzip < %s | %s --host=%s --user=%s --password=%s %s ", $fullPath, Replicant::config()->get('path_to_mysql'), DatabaseTools::getDBCredential('Server'), DatabaseTools::getDBCredential('UserName'), DatabaseTools::getDBCredential('Password'), $this->Database);
} else {
$command = sprintf("%s --host=%s --user=%s --password=%s %s < %s", Replicant::config()->get('path_to_mysql'), DatabaseTools::getDBCredential('Server'), DatabaseTools::getDBCredential('UserName'), DatabaseTools::getDBCredential('Password'), $this->Database, $fullPath);
}
$this->step("Restoring database '{$this->UserName}@{$this->RemoteHost}:{$this->Database}' from '{$fullPath}'");
if ($this->system($command, $retval)) {
// we need a new one here as existing one will be gone when database
// ReplicantActionRestore::create(static::ActionRestore, "", static::ResultMessageSuccess, "Restoring database '$this->UserName@$this->RemoteHost:$this->Database' from '$fullPath'");
$this->success("Restored database '{$this->Database}' from '{$fullPath}'");
return true;
} else {
$this->failed("Failed, command returned #{$retval}");
return false;
}
}
/**
* Dump database to the local filesystem via mysqldump command and optionally gzipping output.
*
* @SideEffects:
* Dumps database to local filesystem.
*
* @return bool true on success, false on fail
* @throws PermissionFailureException
*/
public function execute()
{
$fullPath = FileSystemTools::build_path($this->Path, $this->FileName) . ($this->UseGZIP ? ".gz" : '');
$this->step("Dumping database '{$this->Database}' to '{$fullPath}'");
// local server dump requested, create paths and dump the file.
if (!is_dir($this->Path)) {
// path doesn't exist, create it recursively
$this->step("Creating folder '{$this->Path}'");
if (!FileSystemTools::make_path($this->Path)) {
$this->failed("Failed to create path '{$this->Path}'");
return false;
}
}
$excludeTables = '';
if (count(Replicant::config()->get('exclude_tables'))) {
$excludeTables = " --ignore-table={$this->Database}." . implode(" --ignore-table={$this->Database}.", Replicant::config()->get('exclude_tables')) . " ";
}
$command = sprintf("%s --host=%s --user=%s --password=%s %s %s %s %s", Replicant::config()->get('path_to_mysqldump'), DatabaseTools::getDBCredential('Server'), DatabaseTools::getDBCredential('UserName'), DatabaseTools::getDBCredential('Password'), $excludeTables, $this->Database, $this->UseGZIP ? " | gzip > " : " > ", $fullPath);
$ok = $this->system($command, $retval);
if ($ok) {
$this->success("Dumped Database to {$fullPath}");
} else {
$this->failed("Execute returned #{$retval}");
}
return $ok;
}
/**
* Read the file to the output buffer.
*
* SideEffects:
* Writes file contents to output buffer if found
*
* Path to file is hard-coded as Replicant::asset_path() setting.
*
* Content-Type returned is text/plain.
*
* @return bool|int result from readfile (bytes output to buffer or false if failed)
*/
public function execute()
{
$this->checkPerm();
$fullPath = FileSystemTools::build_path($this->Path, "{$this->FileName}");
if (!file_exists($fullPath)) {
$this->failed("File '{$fullPath}' doesn't exist");
return false;
}
$this->step("Reading file '{$fullPath}'");
ob_clean();
Header('Content-Type: text/plain');
$res = readfile($fullPath);
if ($res === false) {
$this->failed("Failed to read file '{$fullPath}'");
} else {
$this->success("Read #{$res} bytes");
}
return $res;
}
/**
* Fetch a file or if no FileName set all files found at remote location.
*
* @SideEffects:
* Writes files to local filesystem
*
* If all files then don't overwrite existing files, otherwise if a single file then overwrite it every time.
*
* @return int number of files fetched
*/
public function execute()
{
$this->checkPerm();
$transport = Replicant::transportFactory($this->Protocol, $this->RemoteHost, $this->Proxy, $this->UserName, $this->Password);
// if we have a FileName then only enqueue that file, otherwise get a list of files from remote host and enqueue all for fetching (existing files won't be refetched in this case).
if (!$this->FileName) {
$this->step("Fetching file list from '{$this->Protocol}://{$this->UserName}@{$this->RemoteHost}/{$this->Path}'");
try {
$files = $transport->fetchFileList($this->Path);
} catch (Exception $e) {
$this->failed("Failed to get file list: " . $e->getMessage());
return 0;
}
} else {
$fullPath = FileSystemTools::build_path($this->Path, $this->FileName);
$this->step("Enqueuing file '{$fullPath}'");
// create the files array as a single entry with path and name
$files = array(array('Path' => $this->Path, 'FileName' => $this->FileName));
}
$numFiles = count($files);
$numFetched = 0;
$this->step("Fetching #{$numFiles} files");
foreach ($files as $fileInfo) {
// strip off extension here or alpha will reject request
$fileName = $fileInfo['FileName'];
$remotePathName = FileSystemTools::build_path(Replicant::config()->get('remote_path'), basename($fileName));
$localPathName = FileSystemTools::build_path(Replicant::asset_path(), $fileName);
$overwrite = $this->FileName != '';
$this->step("Fetching file '{$remotePathName}' with overwrite (" . ($overwrite ? "set" : "not set") . ")");
try {
if (false !== $transport->fetchFile($remotePathName, $localPathName, $overwrite)) {
$numFetched++;
}
} catch (Exception $e) {
$this->failed("Failed to fetch file '{$remotePathName}': " . $e->getMessage());
// EARLY EXIT!
return false;
}
}
$this->success("Fetched #{$numFetched} files of #{$numFiles}");
return $numFetched;
}