New export functionality.

This commit is contained in:
James Cole 2016-02-04 17:16:16 +01:00
parent d7a66f6782
commit 86c22c9fdd
24 changed files with 1311 additions and 13 deletions

View File

@ -0,0 +1,54 @@
<?php
/**
* AttachmentCollector.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Export\Collector;
use Auth;
use Crypt;
use FireflyIII\Models\Attachment;
use FireflyIII\Models\ExportJob;
use Log;
/**
* Class AttachmentCollector
*
* @package FireflyIII\Export\Collector
*/
class AttachmentCollector extends BasicCollector implements CollectorInterface
{
/**
* AttachmentCollector constructor.
*
* @param ExportJob $job
*/
public function __construct(ExportJob $job)
{
parent::__construct($job);
}
public function run()
{
// grab all the users attachments:
$attachments = Auth::user()->attachments()->get();
Log::debug('Found ' . $attachments->count() . ' attachments.');
/** @var Attachment $attachment */
foreach ($attachments as $attachment) {
$originalFile = storage_path('upload') . DIRECTORY_SEPARATOR . 'at-' . $attachment->id . '.data';
if (file_exists($originalFile)) {
Log::debug('Stored 1 attachment');
$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);
}
}
}
}

View File

@ -0,0 +1,55 @@
<?php
/**
* BasicCollector.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Export\Collector;
use FireflyIII\Models\ExportJob;
use Illuminate\Support\Collection;
/**
* Class BasicCollector
*
* @package FireflyIII\Export\Collector
*/
class BasicCollector
{
/** @var Collection */
private $files;
/** @var ExportJob */
protected $job;
/**
* BasicCollector constructor.
*/
public function __construct(ExportJob $job)
{
$this->files = new Collection;
$this->job = $job;
}
/**
* @return Collection
*/
public function getFiles()
{
return $this->files;
}
/**
* @param Collection $files
*/
public function setFiles($files)
{
$this->files = $files;
}
}

View File

@ -0,0 +1,21 @@
<?php
/**
* CollectorInterface.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Export\Collector;
/**
* Interface CollectorInterface
*
* @package FireflyIII\Export\Collector
*/
interface CollectorInterface
{
public function run();
}

View File

@ -0,0 +1,60 @@
<?php
/**
* UploadCollector.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Export\Collector;
use Auth;
use Crypt;
use FireflyIII\Models\ExportJob;
/**
* Class UploadCollector
*
* @package FireflyIII\Export\Collector
*/
class UploadCollector extends BasicCollector implements CollectorInterface
{
/**
* AttachmentCollector constructor.
*
* @param ExportJob $job
*/
public function __construct(ExportJob $job)
{
parent::__construct($job);
}
public function run()
{
// grab upload directory.
$path = storage_path('upload');
$files = scandir($path);
// only allow old uploads for this user:
$expected = 'csv-upload-' . Auth::user()->id . '-';
$len = strlen($expected);
foreach ($files as $entry) {
if (substr($entry, 0, $len) === $expected) {
// this is an original upload.
$parts = explode('-', str_replace(['.csv.encrypted', $expected], '', $entry));
$originalUpload = intval($parts[1]);
$date = date('Y-m-d \a\t H-i-s', $originalUpload);
$newFileName = 'Old CSV import dated ' . $date . '.csv';
$content = Crypt::decrypt(file_get_contents($path . DIRECTORY_SEPARATOR . $entry));
$fullPath = storage_path('export') . DIRECTORY_SEPARATOR . $this->job->key . '-' . $newFileName;
// write to file:
file_put_contents($fullPath, $content);
// add entry to set:
$this->getFiles()->push($fullPath);
}
}
}
}

View File

@ -0,0 +1,55 @@
<?php
/**
* ConfigurationFile.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Export;
use FireflyIII\Models\ExportJob;
/**
* Class ConfigurationFile
*
* @package FireflyIII\Export
*/
class ConfigurationFile
{
/** @var ExportJob */
private $job;
public function __construct(ExportJob $job)
{
$this->job = $job;
}
/**
* @return bool
*/
public function make()
{
$fields = array_keys(get_class_vars(Entry::class));
$types = Entry::getTypes();
$configuration = [
'date-format' => 'Y-m-d', // unfortunately, this is hard-coded.
'has-headers' => true,
'map' => [], // we could build a map if necessary for easy re-import.
'roles' => [],
'mapped' => [],
'specifix' => [],
];
foreach ($fields as $field) {
$configuration['roles'][] = $types[$field];
}
$file = storage_path('export') . DIRECTORY_SEPARATOR . $this->job->key . '-configuration.json';
file_put_contents($file, json_encode($configuration, JSON_PRETTY_PRINT));
return $file;
}
}

120
app/Export/Entry.php Normal file
View File

@ -0,0 +1,120 @@
<?php
/**
* Entry.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Export;
use FireflyIII\Models\TransactionJournal;
/**
* To extend the exported object, in case of new features in Firefly III for example,
* do the following:
*
* - Add the field(s) to this class
* - Make sure the "fromJournal"-routine fills these fields.
* - Add them to the static function that returns its type (key=value. Remember that the only
* valid types can be found in config/csv.php (under "roles").
*
* These new entries should be should be strings and numbers as much as possible.
*
*
*
* Class Entry
*
* @package FireflyIII\Export
*/
class Entry
{
/** @var string */
public $amount;
/** @var string */
public $date;
/** @var string */
public $description;
/**
* @param TransactionJournal $journal
*
* @return Entry
*/
public static function fromJournal(TransactionJournal $journal)
{
$entry = new self;
$entry->setDescription($journal->description);
$entry->setDate($journal->date->format('Y-m-d'));
$entry->setAmount($journal->amount);
return $entry;
}
/**
* @return array
*/
public static function getTypes()
{
// key = field name (see top of class)
// value = field type (see csv.php under 'roles')
return [
'amount' => 'amount',
'date' => 'date-transaction',
'description' => 'description',
];
}
/**
* @return string
*/
public function getAmount()
{
return $this->amount;
}
/**
* @param string $amount
*/
public function setAmount($amount)
{
$this->amount = $amount;
}
/**
* @return string
*/
public function getDate()
{
return $this->date;
}
/**
* @param string $date
*/
public function setDate($date)
{
$this->date = $date;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
}

View File

@ -0,0 +1,55 @@
<?php
/**
* BasicExporter.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Export\Exporter;
use FireflyIII\Models\ExportJob;
use Illuminate\Support\Collection;
/**
* Class BasicExporter
*
* @package FireflyIII\Export\Exporter
*/
class BasicExporter
{
private $entries;
/** @var ExportJob */
protected $job;
/**
* BasicExporter constructor.
*/
public function __construct(ExportJob $job)
{
$this->entries = new Collection;
$this->job = $job;
}
/**
* @return Collection
*/
public function getEntries()
{
return $this->entries;
}
/**
* @param Collection $entries
*/
public function setEntries(Collection $entries)
{
$this->entries = $entries;
}
}

View File

@ -0,0 +1,80 @@
<?php
/**
* CsvExporter.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Export\Exporter;
use FireflyIII\Export\Entry;
use FireflyIII\Models\ExportJob;
use League\Csv\Writer;
use SplFileObject;
/**
* Class CsvExporter
*
* @package FireflyIII\Export\Exporter
*/
class CsvExporter extends BasicExporter implements ExporterInterface
{
/** @var string */
private $fileName;
/** @var resource */
private $handler;
/**
* CsvExporter constructor.
*/
public function __construct(ExportJob $job)
{
parent::__construct($job);
}
/**
* @return string
*/
public function getFileName()
{
return $this->fileName;
}
/**
*
*/
public function run()
{
// create temporary file:
$this->tempFile();
// create CSV writer:
$writer = Writer::createFromPath(new SplFileObject($this->fileName, 'a+'), 'w');
//the $writer object open mode will be 'w'!!
// all rows:
$rows = [];
// add header:
$first = $this->getEntries()->first();
$rows[] = array_keys(get_object_vars($first));
// then the rest:
/** @var Entry $entry */
foreach ($this->getEntries() as $entry) {
$rows[] = array_values(get_object_vars($entry));
}
$writer->insertAll($rows);
}
private function tempFile()
{
$fileName = $this->job->key . '-records.csv';
$this->fileName = storage_path('export') . DIRECTORY_SEPARATOR . $fileName;
$this->handler = fopen($this->fileName, 'w');
}
}

View File

@ -0,0 +1,41 @@
<?php
/**
* ExporterInterface.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Export\Exporter;
use Illuminate\Support\Collection;
/**
* Interface ExporterInterface
*
* @package FireflyIII\Export\Exporter
*/
interface ExporterInterface
{
/**
* @return Collection
*/
public function getEntries();
/**
*
*/
public function run();
/**
* @param Collection $entries
*
*/
public function setEntries(Collection $entries);
/**
* @return string
*/
public function getFileName();
}

View File

@ -0,0 +1,65 @@
<?php
/**
* JournalCollector.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Export;
use Carbon\Carbon;
use FireflyIII\User;
use Illuminate\Support\Collection;
/**
* Class JournalCollector
*
* @package FireflyIII\Export\Collector
*/
class JournalCollector
{
/** @var Collection */
private $accounts;
/** @var Carbon */
private $end;
/** @var Carbon */
private $start;
/** @var User */
private $user;
/**
* JournalCollector constructor.
*
* @param Collection $accounts
* @param User $user
* @param Carbon $start
* @param Carbon $end
*/
public function __construct(Collection $accounts, User $user, Carbon $start, Carbon $end)
{
$this->accounts = $accounts;
$this->user = $user;
$this->start = $start;
$this->end = $end;
}
/**
* @return Collection
*/
public function collect()
{
// get all the journals:
$ids = $this->accounts->pluck('id')->toArray();
return $this->user->transactionjournals()
->leftJoin('transactions', 'transactions.transaction_journal_id', '=', 'transaction_journals.id')
->whereIn('transactions.account_id', $ids)
->before($this->end)
->after($this->start)
->orderBy('transaction_journals.date')
->get(['transaction_journals.*']);
}
}

154
app/Export/Processor.php Normal file
View File

@ -0,0 +1,154 @@
<?php
/**
* Processor.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Export;
use Auth;
use Config;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\ExportJob;
use FireflyIII\Models\TransactionJournal;
use Illuminate\Support\Collection;
use ZipArchive;
/**
* Class Processor
*
* @package FireflyIII\Export
*/
class Processor
{
/** @var Collection */
public $accounts;
/** @var string */
public $exportFormat;
/** @var bool */
public $includeAttachments;
/** @var bool */
public $includeConfig;
/** @var bool */
public $includeOldUploads;
/** @var ExportJob */
public $job;
/** @var array */
public $settings;
/** @var \FireflyIII\Export\ConfigurationFile */
private $configurationMaker;
/** @var Collection */
private $exportEntries;
/** @var Collection */
private $files;
/** @var Collection */
private $journals;
/**
* Processor constructor.
*
* @param array $settings
*/
public function __construct(array $settings)
{
// save settings
$this->settings = $settings;
$this->accounts = $settings['accounts'];
$this->exportFormat = $settings['exportFormat'];
$this->includeAttachments = $settings['includeAttachments'];
$this->includeConfig = $settings['includeConfig'];
$this->includeOldUploads = $settings['includeOldUploads'];
$this->job = $settings['job'];
$this->journals = new Collection;
$this->exportEntries = new Collection;
$this->files = new Collection;
}
/**
*
*/
public function collectAttachments()
{
$attachmentCollector = app('FireflyIII\Export\Collector\AttachmentCollector', [$this->job]);
$attachmentCollector->run();
$this->files = $this->files->merge($attachmentCollector->getFiles());
}
/**
*
*/
public function collectJournals()
{
$args = [$this->accounts, Auth::user(), $this->settings['startDate'], $this->settings['endDate']];
$journalCollector = app('FireflyIII\Export\JournalCollector', $args);
$this->journals = $journalCollector->collect();
}
public function collectOldUploads()
{
$uploadCollector = app('FireflyIII\Export\Collector\UploadCollector', [$this->job]);
$uploadCollector->run();
$this->files = $this->files->merge($uploadCollector->getFiles());
}
/**
*
*/
public function convertJournals()
{
/** @var TransactionJournal $journal */
foreach ($this->journals as $journal) {
$this->exportEntries->push(Entry::fromJournal($journal));
}
}
public function createConfigFile()
{
$this->configurationMaker = app('FireflyIII\Export\ConfigurationFile', [$this->job]);
$this->files->push($this->configurationMaker->make());
}
public function createZipFile()
{
$zip = new ZipArchive;
$filename = storage_path('export') . DIRECTORY_SEPARATOR . $this->job->key . '.zip';
if ($zip->open($filename, ZipArchive::CREATE) !== true) {
throw new FireflyException('Cannot store zip file.');
}
// for each file in the collection, add it to the zip file.
$search = storage_path('export') . DIRECTORY_SEPARATOR . $this->job->key . '-';
/** @var string $file */
foreach ($this->getFiles() as $file) {
$zipName = str_replace($search, '', $file);
$zip->addFile($file, $zipName);
}
$zip->close();
}
/**
*
*/
public function exportJournals()
{
$exporterClass = Config::get('firefly.export_formats.' . $this->exportFormat);
$exporter = app($exporterClass, [$this->job]);
$exporter->setEntries($this->exportEntries);
$exporter->run();
$this->files->push($exporter->getFileName());
}
/**
* @return Collection
*/
public function getFiles()
{
return $this->files;
}
}

View File

@ -0,0 +1,52 @@
<?php
/**
* ExportFormRequest.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Http\Requests;
use Auth;
use Carbon\Carbon;
/**
* Class ExportFormRequest
*
*
* @package FireflyIII\Http\Requests
*/
class ExportFormRequest extends Request
{
/**
* @return bool
*/
public function authorize()
{
// Only allow logged in users
return Auth::check();
}
/**
* @return array
*/
public function rules()
{
$first = session('first')->subDay()->format('Y-m-d');
$today = Carbon::create()->addDay()->format('Y-m-d');
$formats = join(',', array_keys(config('firefly.export_formats')));
return [
'start_date' => 'required|date|after:' . $first,
'end_date' => 'required|date|before:' . $today,
'accounts' => 'required',
'job' => 'required|belongsToUser:export_jobs,key',
'accounts.*' => 'required|exists:accounts,id|belongsToUser:accounts',
'include_attachments' => 'in:0,1',
'include_config' => 'in:0,1',
'exportFormat' => 'in:' . $formats,
];
}
}

View File

@ -93,6 +93,7 @@ class FireflyServiceProvider extends ServiceProvider
$this->app->bind('FireflyIII\Repositories\Attachment\AttachmentRepositoryInterface', 'FireflyIII\Repositories\Attachment\AttachmentRepository');
$this->app->bind('FireflyIII\Repositories\Rule\RuleRepositoryInterface', 'FireflyIII\Repositories\Rule\RuleRepository');
$this->app->bind('FireflyIII\Repositories\RuleGroup\RuleGroupRepositoryInterface', 'FireflyIII\Repositories\RuleGroup\RuleGroupRepository');
$this->app->bind('FireflyIII\Repositories\ExportJob\ExportJobRepositoryInterface', 'FireflyIII\Repositories\ExportJob\ExportJobRepository');
$this->app->bind('FireflyIII\Support\Search\SearchInterface', 'FireflyIII\Support\Search\Search');
// CSV import
@ -126,7 +127,6 @@ class FireflyServiceProvider extends ServiceProvider
$this->app->bind('FireflyIII\Helpers\Report\BalanceReportHelperInterface', 'FireflyIII\Helpers\Report\BalanceReportHelper');
$this->app->bind('FireflyIII\Helpers\Report\BudgetReportHelperInterface', 'FireflyIII\Helpers\Report\BudgetReportHelper');
}
}

View File

@ -0,0 +1,66 @@
<?php
/**
* ExportJobRepository.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Repositories\ExportJob;
use Auth;
use Carbon\Carbon;
use FireflyIII\Models\ExportJob;
use Illuminate\Support\Str;
/**
* Class ExportJobRepository
*
* @package FireflyIII\Repositories\ExportJob
*/
class ExportJobRepository implements ExportJobRepositoryInterface
{
/**
* @return bool
*/
public function cleanup()
{
$dayAgo = Carbon::create()->subDay();
ExportJob::where('created_at', '<', $dayAgo->format('Y-m-d H:i:s'))
->where('status', 'never_started')
// TODO also delete others.
->delete();
return true;
}
/**
* @return ExportJob
*/
public function create()
{
$exportJob = new ExportJob;
$exportJob->user()->associate(Auth::user());
/*
* In theory this random string could give db error.
*/
$exportJob->key = Str::random(12);
$exportJob->status = 'export_status_never_started';
$exportJob->save();
return $exportJob;
}
/**
* @param $key
*
* @return ExportJob|null
*/
public function findByKey($key)
{
return Auth::user()->exportJobs()->where('key', $key)->first();
}
}

View File

@ -0,0 +1,38 @@
<?php
/**
* ExportJobRepositoryInterface.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Repositories\ExportJob;
use FireflyIII\Models\ExportJob;
/**
* Interface ExportJobRepositoryInterface
*
* @package FireflyIII\Repositories\ExportJob
*/
interface ExportJobRepositoryInterface
{
/**
* @return bool
*/
public function cleanup();
/**
* @return ExportJob
*/
public function create();
/**
* @param $key
*
* @return ExportJob|null
*/
public function findByKey($key);
}

View File

@ -10,8 +10,10 @@ namespace FireflyIII\Support\Migration;
*/
use Carbon\Carbon;
use Crypt;
use FireflyIII\Models\Account;
use FireflyIII\Models\AccountMeta;
use FireflyIII\Models\Attachment;
use FireflyIII\Models\Bill;
use FireflyIII\Models\Budget;
use FireflyIII\Models\BudgetLimit;
@ -22,6 +24,8 @@ use FireflyIII\Models\RuleAction;
use FireflyIII\Models\RuleGroup;
use FireflyIII\Models\RuleTrigger;
use FireflyIII\Models\Tag;
use FireflyIII\Models\Transaction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\User;
use Log;
@ -69,6 +73,84 @@ class TestData
}
/**
* @param User $user
* @param Carbon $start
*/
public static function createAttachments(User $user, Carbon $start)
{
$toAccount = TestData::findAccount($user, 'TestData Checking Account');
$fromAccount = TestData::findAccount($user, 'Job');
$journal = TransactionJournal::create(
[
'user_id' => $user->id,
'transaction_type_id' => 2,
'transaction_currency_id' => 1,
'description' => 'Some journal for attachment',
'completed' => 1,
'date' => $start->format('Y-m-d'),
]
);
Transaction::create(
[
'account_id' => $fromAccount->id,
'transaction_journal_id' => $journal->id,
'amount' => -100,
]
);
Transaction::create(
[
'account_id' => $toAccount->id,
'transaction_journal_id' => $journal->id,
'amount' => 100,
]
);
// and now attachments
$encrypted = Crypt::encrypt('I are secret');
$one = Attachment::create(
[
'attachable_id' => $journal->id,
'attachable_type' => 'FireflyIII\Models\TransactionJournal',
'user_id' => $user->id,
'md5' => md5('Hallo'),
'filename' => 'empty-file.txt',
'title' => 'Empty file',
'description' => 'This file is empty',
'notes' => 'What notes',
'mime' => 'text/plain',
'size' => strlen($encrypted),
'uploaded' => 1,
]
);
// and now attachment.
$two = Attachment::create(
[
'attachable_id' => $journal->id,
'attachable_type' => 'FireflyIII\Models\TransactionJournal',
'user_id' => $user->id,
'md5' => md5('Ook hallo'),
'filename' => 'empty-file-2.txt',
'title' => 'Empty file 2',
'description' => 'This file is empty too',
'notes' => 'What notes do',
'mime' => 'text/plain',
'size' => strlen($encrypted),
'uploaded' => 1,
]
);
// echo crypted data to the file.
file_put_contents(storage_path('upload/at-' . $one->id . '.data'), $encrypted);
file_put_contents(storage_path('upload/at-' . $two->id . '.data'), $encrypted);
}
/**
* @param User $user
*/

View File

@ -49,8 +49,10 @@ class FireflyValidator extends Validator
*/
public function validateBelongsToUser($attribute, $value, $parameters)
{
$field = isset($parameters[1]) ? $parameters[1] : 'id';
$count = DB::table($parameters[0])->where('user_id', Auth::user()->id)->where('id', $value)->count();
$count = DB::table($parameters[0])->where('user_id', Auth::user()->id)->where($field, $value)->count();
if ($count == 1) {
return true;
}

View File

@ -8,11 +8,18 @@ return [
'csv_import_enabled' => true,
'maxUploadSize' => 5242880,
'allowedMimes' => ['image/png', 'image/jpeg', 'application/pdf'],
'export_formats' => [
'csv' => 'FireflyIII\Export\Exporter\CsvExporter',
//'mt940' => 'FireflyIII\Export\Exporter\MtExporter',
],
'default_export_format' => 'csv',
'piggy_bank_periods' => [
'week' => 'Week',
'month' => 'Month',
'quarter' => 'Quarter',
'year' => 'Year'
'year' => 'Year',
],
'periods_to_text' => [
'weekly' => 'A week',
@ -35,10 +42,10 @@ return [
'1M' => 'month',
'3M' => 'three months',
'6M' => 'half year',
'custom' => '(custom)'
'custom' => '(custom)',
],
'ccTypes' => [
'monthlyFull' => 'Full payment every month'
'monthlyFull' => 'Full payment every month',
],
'range_to_name' => [
'1D' => 'one day',
@ -54,7 +61,7 @@ return [
'1M' => 'monthly',
'3M' => 'quarterly',
'6M' => 'half-year',
'custom' => 'monthly'
'custom' => 'monthly',
],
'subTitlesByIdentifier' =>
[
@ -160,6 +167,7 @@ return [
'tag' => 'FireflyIII\Models\Tag',
'rule' => 'FireflyIII\Models\Rule',
'ruleGroup' => 'FireflyIII\Models\RuleGroup',
'jobKey' => 'FireflyIII\Models\ExportJob',
// lists
'accountList' => 'FireflyIII\Support\Binder\AccountList',
'budgetList' => 'FireflyIII\Support\Binder\BudgetList',
@ -167,7 +175,7 @@ return [
// others
'start_date' => 'FireflyIII\Support\Binder\Date',
'end_date' => 'FireflyIII\Support\Binder\Date'
'end_date' => 'FireflyIII\Support\Binder\Date',
],
'rule-triggers' => [
@ -210,6 +218,6 @@ return [
'set_description',
'append_description',
'prepend_description',
]
],
];

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

121
public/js/export/index.js Normal file
View File

@ -0,0 +1,121 @@
/* globals token, jobKey */
/*
* index.js
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
var intervalId = 0;
$(function () {
"use strict";
// on click of export button:
// - hide form
// - post export command
// - start polling progress.
// - return false,
$('#export').submit(startExport);
}
);
function startExport() {
"use strict";
console.log('Start export...');
hideForm();
showLoading();
// do export
callExport();
return false;
}
function hideForm() {
"use strict";
$('#form-body').hide();
$('#do-export-button').hide();
}
function showForm() {
"use strict";
$('#form-body').show();
$('#do-export-button').show();
}
function showLoading() {
"use strict";
$('#export-loading').show();
}
function hideLoading() {
"use strict";
$('#export-loading').hide();
}
function showDownload() {
"use strict";
$('#export-download').show();
}
function showError(text) {
"use strict";
$('#export-error').show();
$('#export-error>p').text(text);
}
function callExport() {
"use strict";
console.log('Start callExport()...')
var data = $('#export').serialize();
// call status, keep calling it until response is "finished"?
intervalId = window.setInterval(checkStatus, 500);
$.post('export/submit', data).done(function (data) {
console.log('Export hath succeeded!');
// stop polling:
window.clearTimeout(intervalId);
// call it one last time:
window.setTimeout(checkStatus, 500);
// somewhere here is a download link.
// keep the loading thing, for debug.
hideLoading();
// show download
showDownload();
}).fail(function () {
// show error.
// show form again.
showError('The export failed. Please check the log files to find out why.');
// stop polling:
window.clearTimeout(intervalId);
hideLoading();
showForm();
});
}
function checkStatus() {
"use strict";
console.log('get status...');
$.getJSON('export/status/' + jobKey).done(function (data) {
putStatusText(data.status);
});
}
function putStatusText(status) {
"use strict";
$('#status-message').text(status);
}

View File

@ -38,6 +38,18 @@ return [
'new_budget' => 'New budget',
'new_bill' => 'New bill',
// export data:
'import_and_export' => 'Import and export',
'export_data' => 'Export data',
'export_data_intro' => 'For backup purposes, when migrating to another system or when migrating to another Firefly III installation.',
'export_format' => 'Export format',
'export_format_csv' => 'Comma separated values (CSV file)',
'export_format_mt940' => 'MT940 compatible format',
'export_included_accounts' => 'Export transactions from these accounts',
'include_config_help' => 'For easy re-import into Firefly III',
'include_old_uploads_help' => 'Firefly III does not throw away the original CSV files you have imported in the past. You can include them in your export.',
'do_export' => 'Export',
// rules
'rules' => 'Rules',
'rules_explanation' => 'Here you can manage rules. Rules are triggered when a transaction is created or updated. Then, if the transaction has certain properties (called "triggers") Firefly will execute the "actions". Combined, you can make Firefly respond in a certain way to new transactions.',

View File

@ -70,6 +70,12 @@ return [
'size' => 'Size',
'trigger' => 'Trigger',
'stop_processing' => 'Stop processing',
'start_date' => 'Start of export range',
'end_date' => 'End of export range',
'export_format' => 'File format',
'include_attachments' => 'Include uploaded attachments',
'include_config' => 'Include configuration file',
'include_old_uploads' => 'Include imported data',
'csv_comma' => 'A comma (,)',
'csv_semicolon' => 'A semicolon (;)',

View File

@ -0,0 +1,129 @@
{% extends "./layout/default.twig" %}
{% block breadcrumbs %}
{{ Breadcrumbs.renderIfExists(Route.getCurrentRoute.getName) }}
{% endblock %}
{% block content %}
<form method="POST" action="{{ route('export.export') }}" accept-charset="UTF-8" class="form-horizontal" id="export">
<input name="_token" type="hidden" value="{{ csrf_token() }}">
<input name="job" type="hidden" value="{{ job.key }}">
<div class="row">
<div class="col-lg-12 col-sm-12 col-xs-12">
<div class="box box-primary">
<div class="box-header with-border">
<h3 class="box-title">{{ 'export_data'|_ }}</h3>
</div>
<div class="box-body">
<div id="export-loading" style="display:none;">
<p class="text-center">
{{ 'export_data_please_wait'|_ }}
</p>
<p class="text-center">
<img src="images/loading-wide.gif" alt="">
</p>
<p class="text-center text-info" id="status-message">
(Please wait for a status message to appear)
</p>
</div>
<div id="export-download" style="display:none;">
<p class="text-center text-info" id="download-holder">
<a id="download-link" class="btn btn-lg btn-success" href="{{ route('export.download', job.key) }}"><i class="fa fa-fw fa-download"></i> Download</a>
</p>
</div>
<div id="export-error" style="display:none;">
<p class="text-center text-danger">
</p>
</div>
<div id="form-body">
<p>
{{ 'export_data_intro'|_ }}
</p>
<div class="row">
<div class="col-lg-6 col-md-8 col-sm-12 col-xs-12">
{{ ExpandedForm.date('start_date', first) }}
{{ ExpandedForm.date('end_date', today) }}
<!-- EXPORT FORMATS -->
<div class="form-group">
<label for="exportFormat" class="col-sm-4 control-label">{{ 'export_format'|_ }}</label>
<div class="col-sm-8">
{% if errors.has('exportFormat') %}
<div class="alert alert-danger" role="alert">
{{ errors.first('exportFormat') }}
</div>
{% endif %}
{% for format in formats %}
<div class="radio">
<label>
<input type="radio" name="exportFormat" id="exportFormat_{{ format }}" value="{{ format }}"
{% if format == defaultFormat %}checked{% endif %}>
{{ ('export_format_'~format)|_ }}
</label>
</div>
{% endfor %}
</div>
</div>
<!-- ACCOUNTS -->
<div class="form-group">
<label for="inputAccounts" class="col-sm-4 control-label">{{ 'export_included_accounts'|_ }}</label>
<div class="col-sm-8">
{% if errors.has('accounts') %}
<div class="alert alert-danger" role="alert">
{{ errors.first('accounts') }}
</div>
{% endif %}
{% for account in accounts %}
<div class="checkbox">
<label>
<input type="checkbox" class="account-checkbox" name="accounts[]" value="{{ account.id }}" checked>
{{ account.name }}
{% if account.getMeta('accountRole') == 'sharedAsset' %}
({{ 'shared'|_|lower }})
{% endif %}
</label>
</div>
{% endfor %}
</div>
</div>
{{ ExpandedForm.checkbox('include_attachments','1', true) }}
{{ ExpandedForm.checkbox('include_config','1', true, {helpText: 'include_config_help'|_}) }}
{{ ExpandedForm.checkbox('include_old_uploads','1', false, {helpText: 'include_old_uploads_help'|_}) }}
</div>
</div>
</div>
</div>
<div class="box-footer">
<input type="submit" name="submit" value="{{ 'do_export'|_ }}" id="do-export-button" class="btn btn-success pull-right"/>
</div>
</div>
</div>
</div>
</form>
{% endblock %}
{% block scripts %}
<script type="text/javascript">
var jobKey = "{{ job.key }}";
</script>
<script type="text/javascript" src="js/export/index.js"></script>
{% endblock %}

View File

@ -109,6 +109,33 @@
</li>
<!-- import and export -->
<li class="{{ activeRoutePartial('export') }} {{ activeRoutePartial('csv') }} treeview">
<a href="#">
<i class="fa fa-arrows-alt fa-fw"></i>
<span>
{% if Config.get('firefly.csv_import_enabled') %}
{{ 'import_and_export'|_ }}
{% else %}
{{ 'export_data'|_ }}
{% endif %}
</span>
<i class="fa fa-angle-left pull-right"></i>
</a>
<ul class="treeview-menu">
{% if Config.get('firefly.csv_import_enabled') %}
<li class="{{ activeRoutePartial('csv') }}">
<a href="{{ route('csv.index') }}"><i class="fa fa-file-text-o fa-fw"></i> {{ 'csv_import'|_ }}</a>
</li>
{% endif %}
<li class="{{ activeRoutePartial('export') }}">
<a href="{{ route('export.index') }}"><i class="fa fa-file-archive-o fa-fw"></i> {{ 'export_data'|_ }}</a>
</li>
</ul>
</li>
<!-- options and preferences -->
<li id="option-menu" class="{{ activeRoutePartial('profile') }} {{ activeRoutePartial('preferences') }} {{ activeRoutePartial('currency') }} treeview">
<a href="#">
@ -127,11 +154,6 @@
<li class="{{ activeRoutePartial('currency') }}">
<a class="{{ activeRoutePartial('currency') }}" href="{{ route('currency.index') }}"><i class="fa fa-usd fa-fw"></i> {{ 'currencies'|_ }}</a>
</li>
{% if Config.get('firefly.csv_import_enabled') %}
<li class="{{ activeRoutePartial('csv') }}">
<a href="{{ route('csv.index') }}"><i class="fa fa-file-text-o fa-fw"></i> {{ 'csv_import'|_ }}</a>
</li>
{% endif %}
</ul>