silverstripe-frameworktest/code/tasks/FTFileMakerTask.php

236 lines
7.4 KiB
PHP
Raw Normal View History

2017-01-06 07:48:50 +01:00
<?php
use SilverStripe\Assets\File;
use SilverStripe\Assets\Folder;
2019-04-11 03:06:32 +02:00
use SilverStripe\Assets\Image;
2017-01-06 07:48:50 +01:00
use SilverStripe\Dev\BuildTask;
use SilverStripe\ORM\DB;
use GuzzleHttp\Client;
use GuzzleHttp\Promise;
/**
* Creates sample folder and file structure, useful to test performance,
* UI behaviour on deeply nested structures etc.
*
* Downloads around 20MB of data from a public web location on first run,
* in order to create reasonable fixture data (and keep it out of the module repo).
* The related AWS S3 bucket is managed by SilverStripe Ltd.
*
* Protip: In case you want to test thumbnail generation, you can
* recursively delete any generated ones through the following bash command in `assets/`:
* `find . -name '*Resampled*' -print0 | xargs -0 rm`
*
* Parameters:
* - reset=1: Optionally truncate ALL files and folders in the database, plus delete
* the entire `assets/` directory.
*
* @todo Automatically retrieve file listing from S3
* @todo Handle HTTP errors from S3
*/
class FTFileMakerTask extends BuildTask
{
protected $fixtureFileBaseUrl = "https://s3-ap-southeast-2.amazonaws.com/silverstripe-frameworktest-assets/";
2019-04-11 03:06:32 +02:00
protected $defaultImageFileName = 'image-huge-tall.jpg';
2017-01-06 07:48:50 +01:00
protected $fixtureFileNames = [
'archive.zip',
'animated.gif',
'document.docx',
'document.pdf',
'image-huge-tall.jpg',
'image-huge-wide.jpg',
'image-large.jpg',
'image-large.png',
'image-large.gif',
'image-medium.jpg',
'image-small.jpg',
'image-tiny.jpg',
'image-medium.bmp',
'spreadsheet.xlsx',
'video.m4v'
];
protected $fixtureFileTypes = [
'archive.zip' => 'SilverStripe\Assets\File',
'animated.gif' => 'SilverStripe\Assets\Image',
'document.docx' => 'SilverStripe\Assets\File',
'document.pdf' => 'SilverStripe\Assets\File',
'image-huge-tall.jpg' => 'SilverStripe\Assets\Image',
'image-huge-wide.jpg' => 'SilverStripe\Assets\Image',
'image-large.jpg' => 'SilverStripe\Assets\Image',
'image-large.png' => 'SilverStripe\Assets\Image',
'image-large.gif' => 'SilverStripe\Assets\Image',
'image-medium.jpg' => 'SilverStripe\Assets\Image',
'image-small.jpg' => 'SilverStripe\Assets\Image',
'image-tiny.jpg' => 'SilverStripe\Assets\Image',
'image-medium.bmp' => 'SilverStripe\Assets\File',
'spreadsheet.xlsx' => 'SilverStripe\Assets\File',
'video.m4v' => 'SilverStripe\Assets\File',
];
protected $folderCountByDepth = [
0 => 2,
1 => 2,
2 => 2,
3 => 2,
4 => 2,
];
protected $fileCountByDepth = [
0 => 100,
1 => 30,
2 => 5,
3 => 5,
4 => 5,
];
/**
* @var int Constrained by elements in $folderCountByDepth and $fileCountByDepth
*/
protected $depth = 2;
public function run($request)
{
if ($request->getVar('reset')) {
$this->reset();
}
2019-04-11 03:06:32 +02:00
echo "Downloading fixtures\n";
2017-01-06 07:48:50 +01:00
$fixtureFilePaths = $this->downloadFixtureFiles();
2019-04-11 03:06:32 +02:00
echo "Generate thumbnails\n";
$this->generateThumbnails($fixtureFilePaths);
echo "Generate files\n";
2017-01-06 07:48:50 +01:00
$this->generateFiles($fixtureFilePaths);
}
protected function reset()
{
echo "Resetting assets\n";
DB::query('TRUNCATE "File"');
DB::query('TRUNCATE "File_Live"');
2019-04-11 03:06:32 +02:00
DB::query('TRUNCATE "File_Versions"');
2017-01-06 07:48:50 +01:00
if (file_exists(ASSETS_PATH) && ASSETS_PATH && ASSETS_PATH !== '/') {
exec("rm -rf " . ASSETS_PATH);
}
}
protected function downloadFixtureFiles()
{
$client = new Client(['base_uri' => $this->fixtureFileBaseUrl]);
// Initiate each request but do not block
$promises = [];
$paths = [];
foreach ($this->fixtureFileNames as $filename) {
$path = TEMP_FOLDER . '/' . $filename;
$paths[$filename] = $path;
$url = "{$this->fixtureFileBaseUrl}/{$filename}";
if (!file_exists($path)) {
$promises[$filename] = $client->getAsync($filename, [
'sink' => $path
]);
echo "Downloading $url\n";
}
}
// Wait on all of the requests to complete. Throws a ConnectException
// if any of the requests fail
Promise\unwrap($promises);
return $paths;
}
2019-04-11 03:06:32 +02:00
/**
* Creates thumbnails of sample images
*
* @param array $fixtureFilePaths
*/
protected function generateThumbnails($fixtureFilePaths)
{
$folder = Folder::find_or_make('testfolder-thumbnail');
$fileName = $this->defaultImageFileName;
foreach(['draft', 'published'] as $state) {
$file = new Image([
'ParentID' => $folder->ID,
'Title' => "{$fileName} {$state}",
'Name' => $fileName,
]);
$file->File->setFromLocalFile($fixtureFilePaths[$fileName], $folder->getFilename() . $fileName);
$file->write();
if ($state === 'published') {
$file->publishFile();
}
$file->Pad(60,60)->CropHeight(30);
}
}
2017-01-06 07:48:50 +01:00
protected function generateFiles($fixtureFilePaths, $depth = 0, $prefix = "0", $parentID = 0)
{
$folderCount = $this->folderCountByDepth[$depth];
$fileCount = $this->fileCountByDepth[$depth];
for ($i=1; $i<=$folderCount; $i++) {
$folder = new Folder([
'ParentID' => $parentID,
'Title' => "testfolder-{$prefix}{$i}",
'Name' => "testfolder-{$prefix}{$i}",
]);
$folder->write();
echo "\n";
echo "Created Folder: '$folder->Title'\n";
for ($j=1; $j<=$fileCount; $j++) {
$randomFileName = array_keys($fixtureFilePaths)[rand(0, count($fixtureFilePaths)-1)];
$randomFilePath = $fixtureFilePaths[$randomFileName];
$fileName = pathinfo($randomFilePath, PATHINFO_FILENAME)
. "-{$prefix}-{$j}"
. "."
. pathinfo($randomFilePath, PATHINFO_EXTENSION);
// Add a random prefix to avoid all types of files showing up on a single screen page
$fileName = substr(md5($fileName), 0, 5) . '-' . $fileName;
$class = $this->fixtureFileTypes[$randomFileName];
$file = new $class([
'ParentID' => $folder->ID,
'Title' => $fileName,
'Name' => $fileName,
]);
$file->File->setFromLocalFile($randomFilePath, $folder->getFilename() . $fileName);
$file->write();
// Randomly publish
if (rand(0, 1) == 0) {
$file->publishFile();
}
// Randomly set old created date (for testing)
if (rand(0, 10) == 0) {
$file->Created = '2010-01-01 00:00:00';
$file->Title = '[old] ' . $file->Title;
$file->write();
}
echo " Created File: '$file->Title'\n";
}
if ($depth < $this->depth) {
$this->generateFiles($fixtureFilePaths, $depth+1, "{$prefix}-{$i}", $folder->ID);
}
}
}
}