IntenseFinance/firefly-iii
3
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-02-25 18:45:27 -06:00
Code Issues Packages Projects Releases Wiki Activity

More code for the new CSV import

Browse Source
This commit is contained in:
James Cole 2016-06-27 15:15:46 +02:00
parent 93a54780ab
commit 18d2741814
9 changed files with 499 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
app/Http/Controllers/ImportController.php
View File

@ -85,7 +85,7 @@ class ImportController extends Controller
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
* @throws FireflyException
*/
public function process(Request $request, ImportJob $job)
public function postConfigure(Request $request, ImportJob $job)
{
if (!$this->jobInCorrectStep($job, 'process')) {
return $this->redirectToCorrectStep($job);
@ -94,7 +94,8 @@ class ImportController extends Controller
// actual code
$importer = $this->makeImporter($job);
$data = $request->all();
$importer->saveImportConfiguration($data);
$files = $request->files;
$importer->saveImportConfiguration($data, $files);
// update job:
$job->status = 'import_configuration_saved';
@ -121,11 +122,18 @@ class ImportController extends Controller
}
$importer = $this->makeImporter($job);
// now
// now show settings screen to user.
if ($importer->requireUserSettings()) {
$data = $importer->getDataForSettings();
$view = $importer->getViewForSettings();
return view($view, compact('data', 'job'));
}
// if no more settings, save job and continue to process thing.
echo 'now in settings';
echo 'now in settings (done)';
exit;
// actual code

3
app/Http/routes.php
View File

@ -226,8 +226,9 @@ Route::group(
Route::get('/import', ['uses' => 'ImportController@index', 'as' => 'import.index']);
Route::post('/import/upload', ['uses' => 'ImportController@upload', 'as' => 'import.upload']);
Route::get('/import/configure/{importJob}', ['uses' => 'ImportController@configure', 'as' => 'import.configure']);
Route::post('/import/process/{importJob}', ['uses' => 'ImportController@process', 'as' => 'import.process_configuration']);
Route::post('/import/configure/{importJob}', ['uses' => 'ImportController@postConfigure', 'as' => 'import.process_configuration']);
Route::get('/import/settings/{importJob}', ['uses' => 'ImportController@settings', 'as' => 'import.settings']);
Route::post('/import/settings/{importJob}', ['uses' => 'ImportController@postSettings', 'as' => 'import.postSettings']);
/**

93
app/Import/Importer/CsvImporter.php
View File

@ -17,6 +17,8 @@ use FireflyIII\Crud\Account\AccountCrud;
use FireflyIII\Import\Role\Map;
use FireflyIII\Models\AccountType;
use FireflyIII\Models\ImportJob;
use League\Csv\Reader;
use Symfony\Component\HttpFoundation\FileBag;
/**
* Class CsvImporter
@ -25,6 +27,7 @@ use FireflyIII\Models\ImportJob;
*/
class CsvImporter implements ImporterInterface
{
const EXAMPLE_ROWS = 5;
/** @var ImportJob */
public $job;
@ -54,7 +57,7 @@ class CsvImporter implements ImporterInterface
$specifics = [];
// collect specifics.
foreach (config('firefly.csv_import_specifics') as $name => $className) {
foreach (config('csv.import_specifics') as $name => $className) {
$specifics[$name] = [
'name' => $className::getName(),
'description' => $className::getDescription(),
@ -73,6 +76,68 @@ class CsvImporter implements ImporterInterface
return $data;
}
/**
* This method returns the data required for the view that will let the user add settings to the import job.
*
* @return array
*/
public function getDataForSettings(): array
{
$config = $this->job->configuration;
$data = [
'columns' => [],
'columnCount' => 0,
];
if (!isset($config['columns'])) {
// show user column configuration.
$content = $this->job->uploadFileContents();
// create CSV reader.
$reader = Reader::createFromString($content);
$start = $config['has_headers'] ? 1 : 0;
$end = $start + self::EXAMPLE_ROWS; // first X rows
while ($start < $end) {
$row = $reader->fetchOne($start);
foreach ($row as $index => $value) {
$value = trim($value);
if (strlen($value) > 0) {
$data['columns'][$index][] = $value;
}
}
$start++;
$data['columnCount'] = count($row);
}
// make unique
foreach ($data['columns'] as $index => $values) {
$data['columns'][$index] = array_unique($values);
}
// TODO preset roles from config
$data['set_roles'] = [];
// collect possible column roles:
$data['available_roles'] = [];
foreach (array_keys(config('csv.import_roles')) as $role) {
$data['available_roles'][$role] = trans('csv.csv_column_'.$role);
}
return $data;
}
}
/**
* This method returns the name of the view that will be shown to the user to further configure
* the import job.
*
* @return string
*/
public function getViewForSettings(): string
{
return 'import.csv.map';
}
/**
* Returns a Map thing used to allow the user to
* define roles for each entry.
@ -85,21 +150,45 @@ class CsvImporter implements ImporterInterface
exit;
}
/**
* This method returns whether or not the user must configure this import
* job further.
*
* @return bool
*/
public function requireUserSettings(): bool
{
// does the job have both a 'map' array and a 'columns' array.
$config = $this->job->configuration;
if (isset($config['map']) && isset($config['columns'])) {
return false;
}
return true;
}
/**
* @param array $data
*
* @return bool
*/
public function saveImportConfiguration(array $data): bool
public function saveImportConfiguration(array $data, FileBag $files): bool
{
/*
* TODO file upload is ignored for now.
*/
/** @var AccountCrud $repository */
$repository = app(AccountCrud::class);
$account = $repository->find(intval($data['csv_import_account']));
$hasHeaders = isset($data['has_headers']) && intval($data['has_headers']) === 1 ? true : false;
$configuration = [
'has_headers' => $hasHeaders,
'date_format' => $data['date_format'],
'csv_delimiter' => $data['csv_delimiter'],
'csv_import_account' => 0,
'specifics' => [],
];
if (!is_null($account->id)) {

30
app/Import/Importer/ImporterInterface.php
View File

@ -13,6 +13,7 @@ namespace FireflyIII\Import\Importer;
use FireflyIII\Import\Role\Map;
use FireflyIII\Models\ImportJob;
use Symfony\Component\HttpFoundation\FileBag;
/**
* Interface ImporterInterface
@ -37,11 +38,19 @@ interface ImporterInterface
public function getConfigurationData(): array;
/**
* @param array $data
* This method returns the data required for the view that will let the user add settings to the import job.
*
* @return bool
* @return array
*/
public function saveImportConfiguration(array $data): bool;
public function getDataForSettings(): array;
/**
* This method returns the name of the view that will be shown to the user to further configure
* the import job.
*
* @return string
*/
public function getViewForSettings(): string;
/**
* Returns a Map thing used to allow the user to
@ -51,6 +60,21 @@ interface ImporterInterface
*/
public function prepareRoles(): Map;
/**
* This method returns whether or not the user must configure this import
* job further.
*
* @return bool
*/
public function requireUserSettings(): bool;
/**
* @param array $data
*
* @return bool
*/
public function saveImportConfiguration(array $data, FileBag $files): bool;
/**
* @param ImportJob $job
*

36
app/Models/ImportJob.php
View File

@ -12,7 +12,9 @@ declare(strict_types = 1);
namespace FireflyIII\Models;
use Auth;
use Crypt;
use Illuminate\Database\Eloquent\Model;
use Storage;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
@ -67,15 +69,6 @@ class ImportJob extends Model
$this->save();
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function user()
{
return $this->belongsTo('FireflyIII\User');
}
/**
* @param $value
*
@ -86,8 +79,8 @@ class ImportJob extends Model
if (strlen($value) == 0) {
return [];
}
return json_decode($value);
return json_decode($value, true);
}
/**
@ -97,4 +90,25 @@ class ImportJob extends Model
{
$this->attributes['configuration'] = json_encode($value);
}
/**
* @return string
*/
public function uploadFileContents(): string
{
$fileName = $this->key . '.upload';
$disk = Storage::disk('upload');
$encryptedContent = $disk->get($fileName);
$content = Crypt::decrypt($encryptedContent);
return $content;
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function user()
{
return $this->belongsTo('FireflyIII\User');
}
}

203
config/csv.php
View File

@ -3,6 +3,206 @@ declare(strict_types = 1);
return [
/*
* Configuration for the CSV specifics.
*/
'import_specifics' => [
'RabobankDescription' => 'FireflyIII\Import\Specifics\RabobankDescription',
'AbnAmroDescription' => 'FireflyIII\Import\Specifics\AbnAmroDescription',
],
/*
* Configuration for possible column roles.
*/
'import_roles' => [
'_ignore' => [
'mappable' => false,
'converter' => 'Ignore',
'field' => 'ignored',
],
'bill-id' => [
'mappable' => false,
'field' => 'bill',
'converter' => 'BillId',
'mapper' => 'Bill',
],
'bill-name' => [
'mappable' => true,
'converter' => 'BillName',
'field' => 'bill',
'mapper' => 'Bill',
],
'currency-id' => [
'mappable' => true,
'converter' => 'CurrencyId',
'field' => 'currency',
'mapper' => 'TransactionCurrency'
],
'currency-name' => [
'mappable' => true,
'converter' => 'CurrencyName',
'field' => 'currency',
'mapper' => 'TransactionCurrency'
],
'currency-code' => [
'mappable' => true,
'converter' => 'CurrencyCode',
'field' => 'currency',
'mapper' => 'TransactionCurrency'
],
'currency-symbol' => [
'mappable' => true,
'converter' => 'CurrencySymbol',
'field' => 'currency',
'mapper' => 'TransactionCurrency'
],
'description' => [
'mappable' => false,
'converter' => 'Description',
'field' => 'description',
],
'date-transaction' => [
'mappable' => false,
'converter' => 'Date',
'field' => 'date',
],
'date-rent' => [
'mappable' => false,
'converter' => 'Date',
'field' => 'date-rent',
],
'budget-id' => [
'mappable' => true,
'converter' => 'BudgetId',
'field' => 'budget',
'mapper' => 'Budget',
],
'budget-name' => [
'mappable' => true,
'converter' => 'BudgetName',
'field' => 'budget',
'mapper' => 'Budget',
],
'rabo-debet-credit' => [
'mappable' => false,
'converter' => 'RabobankDebetCredit',
'field' => 'amount-modifier',
],
'ing-debet-credit' => [
'mappable' => false,
'converter' => 'INGDebetCredit',
'field' => 'amount-modifier',
],
'category-id' => [
'mappable' => true,
'converter' => 'CategoryId',
'field' => 'category',
'mapper' => 'Category',
],
'category-name' => [
'mappable' => true,
'converter' => 'CategoryName',
'field' => 'category',
'mapper' => 'Category',
],
'tags-comma' => [
'mappable' => true,
'field' => 'tags',
'converter' => 'TagsComma',
'mapper' => 'Tag',
],
'tags-space' => [
'mappable' => true,
'field' => 'tags',
'converter' => 'TagsSpace',
'mapper' => 'Tag',
],
'account-id' => [
'mappable' => true,
'mapper' => 'AssetAccount',
'field' => 'asset-account-id',
'converter' => 'AccountId'
],
'account-name' => [
'mappable' => true,
'mapper' => 'AssetAccount',
'field' => 'asset-account-name',
'converter' => 'AssetAccountName'
],
'account-iban' => [
'mappable' => true,
'converter' => 'AssetAccountIban',
'field' => 'asset-account-iban',
'mapper' => 'AssetAccount'
],
'account-number' => [
'mappable' => true,
'converter' => 'AssetAccountNumber',
'field' => 'asset-account-number',
'mapper' => 'AssetAccount'
],
'opposing-id' => [
'mappable' => true,
'field' => 'opposing-account-id',
'converter' => 'OpposingAccountId',
'mapper' => 'AnyAccount',
],
'opposing-name' => [
'mappable' => true,
'field' => 'opposing-account-name',
'converter' => 'OpposingAccountName',
'mapper' => 'AnyAccount',
],
'opposing-iban' => [
'mappable' => true,
'field' => 'opposing-account-iban',
'converter' => 'OpposingAccountIban',
'mapper' => 'AnyAccount',
],
'opposing-number' => [
'mappable' => true,
'field' => 'opposing-account-number',
'converter' => 'OpposingAccountNumber',
'mapper' => 'AnyAccount',
],
'amount' => [
'mappable' => false,
'converter' => 'Amount',
'field' => 'amount',
],
'amount-comma-separated' => [
'mappable' => false,
'converter' => 'AmountComma',
'field' => 'amount',
],
'sepa-ct-id' => [
'mappable' => false,
'converter' => 'Description',
'field' => 'description',
],
'sepa-ct-op' => [
'mappable' => false,
'converter' => 'Description',
'field' => 'description',
],
'sepa-db' => [
'mappable' => false,
'converter' => 'Description',
'field' => 'description',
],
],
/*
'specifix' => [
'RabobankDescription',
'AbnAmroDescription',
@ -194,4 +394,7 @@ return [
'field' => 'description',
],
]
*/
];

18
config/firefly.php
View File

@ -11,20 +11,14 @@ return [
'resend_confirmation' => 3600,
'confirmation_age' => 14400, // four hours
'export_formats' => [
'export_formats' => [
'csv' => 'FireflyIII\Export\Exporter\CsvExporter',
// mt940 FireflyIII Export Exporter MtExporter
],
'csv_import_specifics' => [
'RabobankDescription' => 'FireflyIII\Import\Specifics\RabobankDescription',
'AbnAmroDescription' => 'FireflyIII\Import\Specifics\AbnAmroDescription',
],
'import_formats' => [
'import_formats' => [
'csv' => 'FireflyIII\Import\Importer\CsvImporter',
// mt940 FireflyIII Import Importer MtImporter
],
'default_export_format' => 'csv',
'default_import_format' => 'csv',
'bill_periods' => ['weekly', 'monthly', 'quarterly', 'half-year', 'yearly'],
@ -142,7 +136,7 @@ return [
'end_date' => 'FireflyIII\Support\Binder\Date',
],
'rule-triggers' => [
'rule-triggers' => [
'user_action' => 'FireflyIII\Rules\Triggers\UserAction',
'from_account_starts' => 'FireflyIII\Rules\Triggers\FromAccountStarts',
'from_account_ends' => 'FireflyIII\Rules\Triggers\FromAccountEnds',
@ -161,7 +155,7 @@ return [
'description_contains' => 'FireflyIII\Rules\Triggers\DescriptionContains',
'description_is' => 'FireflyIII\Rules\Triggers\DescriptionIs',
],
'rule-actions' => [
'rule-actions' => [
'set_category' => 'FireflyIII\Rules\Actions\SetCategory',
'clear_category' => 'FireflyIII\Rules\Actions\ClearCategory',
'set_budget' => 'FireflyIII\Rules\Actions\SetBudget',
@ -174,7 +168,7 @@ return [
'prepend_description' => 'FireflyIII\Rules\Actions\PrependDescription',
],
// all rule actions that require text input:
'rule-actions-text' => [
'rule-actions-text' => [
'set_category',
'set_budget',
'add_tag',
@ -183,7 +177,7 @@ return [
'append_description',
'prepend_description',
],
'test-triggers' => [
'test-triggers' => [
// The maximum number of transactions shown when testing a list of triggers
'limit' => 10,

44
resources/lang/en_US/csv.php Normal file
View File

@ -0,0 +1,44 @@
<?php
/**
* csv.php
* Copyright (C) 2016 thegrumpydictator@gmail.com
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
declare(strict_types = 1);
return [
'csv_column__ignore' => '(ignore this column)',
'csv_column_account-iban' => 'Asset account (IBAN)',
'csv_column_account-id' => 'Asset account ID (matching Firefly)',
'csv_column_account-name' => 'Asset account (name)',
'csv_column_amount' => 'Amount',
'csv_column_amount-comma-separated' => 'Amount (comma as decimal separator)',
'csv_column_bill-id' => 'Bill ID (matching Firefly)',
'csv_column_bill-name' => 'Bill name',
'csv_column_budget-id' => 'Budget ID (matching Firefly)',
'csv_column_budget-name' => 'Budget name',
'csv_column_category-id' => 'Category ID (matching Firefly)',
'csv_column_category-name' => 'Category name',
'csv_column_currency-code' => 'Currency code (ISO 4217)',
'csv_column_currency-id' => 'Currency ID (matching Firefly)',
'csv_column_currency-name' => 'Currency name (matching Firefly)',
'csv_column_currency-symbol' => 'Currency symbol (matching Firefly)',
'csv_column_date-rent' => 'Rent calculation date',
'csv_column_date-transaction' => 'Date',
'csv_column_description' => 'Description',
'csv_column_opposing-iban' => 'Opposing account (IBAN)',
'csv_column_opposing-id' => 'Opposing account ID (matching Firefly)',
'csv_column_opposing-name' => 'Opposing account (name)',
'csv_column_rabo-debet-credit' => 'Rabobank specific debet/credit indicator',
'csv_column_ing-debet-credit' => 'ING specific debet/credit indicator',
'csv_column_sepa-ct-id' => 'SEPA Credit Transfer end-to-end ID',
'csv_column_sepa-ct-op' => 'SEPA Credit Transfer opposing account',
'csv_column_sepa-db' => 'SEPA Direct Debet',
'csv_column_tags-comma' => 'Tags (comma separated)',
'csv_column_tags-space' => 'Tags (space separated)',
'csv_column_account-number' => 'Asset account (account number)',
'csv_column_opposing-number' => 'Opposing account (account number)',
];

88
resources/views/import/csv/map.twig Normal file
View File

@ -0,0 +1,88 @@
{% extends "./layout/default.twig" %}
{% block breadcrumbs %}
{{ Breadcrumbs.renderIfExists(Route.getCurrentRoute.getName) }}
{% endblock %}
{% block content %}
<div class="row">
<div class="col-lg-12">
<div class="box">
<div class="box-header with-border">
<h3 class="box-title">{{ 'csv_column_roles_title'|_ }}</h3>
</div>
<div class="box-body">
<p>{{ 'csv_column_roles_text'|_ }}</p>
</div>
</div>
</div>
</div>
<form action="{{ route('import.postSettings', job.key) }}" method="post">
<input type="hidden" name="_token" value="{{ csrf_token() }}"/>
<div class="row">
<div class="col-lg-12">
<div class="box">
<div class="box-header with-border">
<h3 class="box-title">{{ 'csv_column_roles_table'|_ }}</h3>
</div>
<div class="box-body">
<table class="table">
<thead>
<tr>
<th style="width:20%;">{{ 'csv_column_name'|_ }}</th>
<th style="width:40%;">{{ 'csv_column_example'|_ }}</th>
<th style="width:30%;">{{ 'csv_column_role'|_ }}</th>
<th style="width:10%;">{{ 'csv_do_map_value'|_ }}</th>
</tr>
</thead>
{% for i in 0..data.columnCount %}
<tr>
<td>Column #{{ loop.index }}</td>
<td>
{% if data.columns[i]|length == 0 %}
<em>No example data available</em>
{% else %}
{% for example in data.columns[i] %}
<code>{{ example }}</code><br />
{% endfor %}
{% endif %}
<td>
{{ Form.select(('role['~index~']'), data.available_roles,data.set_roles[index],{class: 'form-control'}) }}
</td>
<td>
{# Form.checkbox(('map['~index~']'),1,map[index]) #}
</td>
</tr>
{% endfor %}
</table>
</div>
</div>
</div>
</div>
<div class="row">
<div class="col-lg-12">
<div class="box">
<div class="box-body">
<a href="{{ route('import.index') }}" class="btn btn-danger"><i class="fa fa-arrow-left"></i> {{ 'csv_go_back'|_ }}</a>
<button type="submit" class="btn btn-success pull-right">
{{ 'csv_continue'|_ }} <i class="fa fa-arrow-right"></i>
</button>
</div>
</div>
</div>
</div>
</form>
{% endblock %}