kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-10-19 19:01:39 +00:00
Code Issues Projects Releases Wiki Activity

Simplified the attachment collector.

Browse Source
This commit is contained in:
James Cole
2016-02-23 06:54:51 +01:00
parent 155801ab2b
commit 0c9c0f2032
2 changed files with 136 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
app/Export/Collector/AttachmentCollector.php
View File

@@ -17,7 +17,9 @@ use FireflyIII\Models\ExportJob;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Repositories\Attachment\AttachmentRepositoryInterface;
use Illuminate\Contracts\Encryption\DecryptException;
use Illuminate\Support\Collection;
use Log;
use Storage;
/**
* Class AttachmentCollector
@@ -28,9 +30,12 @@ class AttachmentCollector extends BasicCollector implements CollectorInterface
{
/** @var string */
private $explanationString = '';
/** @var \Illuminate\Contracts\Filesystem\Filesystem */
private $exportDisk;
/** @var AttachmentRepositoryInterface */
private $repository;
/** @var \Illuminate\Contracts\Filesystem\Filesystem */
private $uploadDisk;
/**
* AttachmentCollector constructor.
@@ -40,6 +45,9 @@ class AttachmentCollector extends BasicCollector implements CollectorInterface
public function __construct(ExportJob $job)
{
$this->repository = app('FireflyIII\Repositories\Attachment\AttachmentRepositoryInterface');
// make storage:
$this->uploadDisk = Storage::disk('upload');
$this->exportDisk = Storage::disk('export');
parent::__construct($job);
}
@@ -50,37 +58,18 @@ class AttachmentCollector extends BasicCollector implements CollectorInterface
public function run()
{
// grab all the users attachments:
$attachments = $this->repository->get();
Log::debug('Found ' . $attachments->count() . ' attachments.');
$attachments = $this->getAttachments();
/** @var Attachment $attachment */
foreach ($attachments as $attachment) {
$originalFile = storage_path('upload') . DIRECTORY_SEPARATOR . 'at-' . $attachment->id . '.data';
Log::debug('Original file is at "' . $originalFile . '".');
if (file_exists($originalFile)) {
try {
$decrypted = Crypt::decrypt(file_get_contents($originalFile));
$newFile = storage_path('export') . DIRECTORY_SEPARATOR . $this->job->key . '-Attachment nr. ' . $attachment->id . ' - '
. $attachment->filename;
file_put_contents($newFile, $decrypted);
$this->getFiles()->push($newFile);
Log::debug('Stored file content in new file "' . $newFile . '", which will be in the final zip file.');
// explain:
$this->explain($attachment);
} catch (DecryptException $e) {
Log::error('Catchable error: could not decrypt attachment #' . $attachment->id . ' because: ' . $e->getMessage());
}
}
$this->exportAttachment($attachment);
}
// put the explanation string in a file and attach it as well.
$explanationFile = storage_path('export') . DIRECTORY_SEPARATOR . $this->job->key . '-Source of all your attachments explained.txt';
file_put_contents($explanationFile, $this->explanationString);
Log::debug('Also put explanation file "' . $explanationFile . '" in the zip.');
$this->getFiles()->push($explanationFile);
$file = $this->job->key . '-Source of all your attachments explained.txt';
$this->exportDisk->put($file, $this->explanationString);
Log::debug('Also put explanation file "' . $file . '" in the zip.');
$this->getFiles()->push($file);
}
/**
@@ -103,4 +92,57 @@ class AttachmentCollector extends BasicCollector implements CollectorInterface
$this->explanationString .= $string;
}
/**
* @param Attachment $attachment
*
* @return bool
*/
private function exportAttachment(Attachment $attachment): bool
{
$file = $attachment->fileName();
Log::debug('Original file is at "' . $file . '".');
if ($this->uploadDisk->exists($file)) {
try {
$decrypted = Crypt::decrypt($this->uploadDisk->get($file));
$exportFile = $this->exportFileName($attachment);
$this->exportDisk->put($exportFile, $decrypted);
$this->getFiles()->push($exportFile);
Log::debug('Stored file content in new file "' . $exportFile . '", which will be in the final zip file.');
// explain:
$this->explain($attachment);
} catch (DecryptException $e) {
Log::error('Catchable error: could not decrypt attachment #' . $attachment->id . ' because: ' . $e->getMessage());
}
}
return true;
}
/**
* Returns the new file name for the export file.
*
* @param $attachment
*
* @return string
*/
private function exportFileName($attachment): string
{
return sprintf('%s-Attachment nr. %s - %s', $this->job->key, strval($attachment->id), $attachment->filename);
}
/**
* @return Collection
*/
private function getAttachments(): Collection
{
$attachments = $this->repository->get();
Log::debug('Found ' . $attachments->count() . ' attachments.');
return $attachments;
}
}

127
app/Models/Attachment.php
View File

@@ -36,6 +36,22 @@ class Attachment extends Model
protected $fillable = ['attachable_id', 'attachable_type', 'user_id', 'md5', 'filename', 'mime', 'title', 'notes', 'description', 'size', 'uploaded'];
/**
* @param Attachment $value
*
* @return Attachment
*/
public static function routeBinder(Attachment $value)
{
if (Auth::check()) {
if ($value->user_id == Auth::user()->id) {
return $value;
}
}
throw new NotFoundHttpException;
}
/**
* Get all of the owning imageable models.
*/
@@ -45,14 +61,30 @@ class Attachment extends Model
}
/**
* @codeCoverageIgnore
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
* Returns the expected filename for this attachment.
*
* @return string
*/
public function user()
public function fileName(): string
{
return $this->belongsTo('FireflyIII\User');
return sprintf('at-%s.data', strval($this->id));
}
/**
* @codeCoverageIgnore
*
* @param $value
*
* @return null|string
*/
public function getDescriptionAttribute($value)
{
if (is_null($value)) {
return null;
}
return Crypt::decrypt($value);
}
/**
* @codeCoverageIgnore
@@ -70,14 +102,6 @@ class Attachment extends Model
return Crypt::decrypt($value);
}
/**
* @param string $value
*/
public function setFilenameAttribute($value)
{
$this->attributes['filename'] = Crypt::encrypt($value);
}
/**
* @codeCoverageIgnore
*
@@ -95,11 +119,19 @@ class Attachment extends Model
}
/**
* @param string $value
* @codeCoverageIgnore
*
* @param $value
*
* @return null|string
*/
public function setMimeAttribute($value)
public function getNotesAttribute($value)
{
$this->attributes['mime'] = Crypt::encrypt($value);
if (is_null($value)) {
return null;
}
return Crypt::decrypt($value);
}
/**
@@ -118,30 +150,6 @@ class Attachment extends Model
return Crypt::decrypt($value);
}
/**
* @param string $value
*/
public function setTitleAttribute($value)
{
$this->attributes['title'] = Crypt::encrypt($value);
}
/**
* @codeCoverageIgnore
*
* @param $value
*
* @return null|string
*/
public function getDescriptionAttribute($value)
{
if (is_null($value)) {
return null;
}
return Crypt::decrypt($value);
}
/**
* @param string $value
*/
@@ -151,19 +159,19 @@ class Attachment extends Model
}
/**
* @codeCoverageIgnore
*
* @param $value
*
* @return null|string
* @param string $value
*/
public function getNotesAttribute($value)
public function setFilenameAttribute($value)
{
if (is_null($value)) {
return null;
}
$this->attributes['filename'] = Crypt::encrypt($value);
}
return Crypt::decrypt($value);
/**
* @param string $value
*/
public function setMimeAttribute($value)
{
$this->attributes['mime'] = Crypt::encrypt($value);
}
/**
@@ -175,19 +183,20 @@ class Attachment extends Model
}
/**
* @param Attachment $value
*
* @return Attachment
* @param string $value
*/
public static function routeBinder(Attachment $value)
public function setTitleAttribute($value)
{
if (Auth::check()) {
$this->attributes['title'] = Crypt::encrypt($value);
}
if ($value->user_id == Auth::user()->id) {
return $value;
}
}
throw new NotFoundHttpException;
/**
* @codeCoverageIgnore
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function user()
{
return $this->belongsTo('FireflyIII\User');
}
}