2016-05-17 19:25:17 -07:00
< ? php
namespace App\Console\Commands ;
2016-08-29 15:49:32 -07:00
use Illuminate\Console\Command ;
use Symfony\Component\Console\Input\InputArgument ;
use Symfony\Component\Console\Input\InputOption ;
2016-06-13 21:41:09 -07:00
ini_set ( 'max_execution_time' , 600 ); //600 seconds = 10 minutes
ini_set ( 'memory_limit' , '500M' );
2016-05-17 19:25:17 -07:00
/**
* Class ObjectImportCommand
*/
2016-06-22 12:27:41 -07:00
class ObjectImportCommand extends Command
{
/**
* The console command name .
*
* @ var string
*/
protected $name = 'snipeit:import' ;
/**
* The console command description .
*
* @ var string
*/
protected $description = 'Import Items from CSV' ;
/**
* Create a new command instance .
*
* @ return void
*/
public function __construct ()
{
parent :: __construct ();
}
2016-12-26 15:16:42 -08:00
private $bar ;
2016-06-22 12:27:41 -07:00
/**
* Execute the console command .
*
* @ return mixed
*/
2018-07-25 01:28:44 -07:00
public function handle ()
2016-06-22 12:27:41 -07:00
{
$filename = $this -> argument ( 'filename' );
2017-01-05 15:45:12 -08:00
$class = title_case ( $this -> option ( 'item-type' ));
$classString = " App \\ Importer \\ { $class } Importer " ;
2017-01-10 16:19:18 -08:00
$importer = new $classString ( $filename );
$importer -> setCallbacks ([ $this , 'log' ], [ $this , 'progress' ], [ $this , 'errorCallback' ])
-> setUserId ( $this -> option ( 'user_id' ))
-> setUpdating ( $this -> option ( 'update' ))
2018-10-03 00:52:29 -07:00
-> setShouldNotify ( $this -> option ( 'send-welcome' ))
2017-01-10 16:19:18 -08:00
-> setUsernameFormat ( $this -> option ( 'username_format' ));
2016-12-26 15:16:42 -08:00
$logFile = $this -> option ( 'logfile' );
\Log :: useFiles ( $logFile );
2017-09-29 17:31:39 -07:00
$this -> comment ( '======= Importing Items from ' . $filename . ' =========' );
2016-12-26 15:16:42 -08:00
$importer -> import ();
2016-05-17 19:25:17 -07:00
2016-12-26 15:16:42 -08:00
$this -> bar = null ;
2016-06-22 12:27:41 -07:00
2016-12-26 15:16:42 -08:00
if ( ! empty ( $this -> errors )) {
$this -> comment ( " The following Errors were encountered. " );
foreach ( $this -> errors as $asset => $error ) {
$this -> comment ( 'Error: Item: ' . $asset . ' failed validation: ' . json_encode ( $error ));
2016-06-22 12:27:41 -07:00
}
2016-12-26 15:16:42 -08:00
} else {
$this -> comment ( " All Items imported successfully! " );
2016-06-22 12:27:41 -07:00
}
2016-12-26 15:16:42 -08:00
$this -> comment ( " " );
2016-06-13 21:45:52 -07:00
2016-12-26 15:16:42 -08:00
return ;
}
2016-05-26 19:29:29 -07:00
2016-12-26 15:16:42 -08:00
public function errorCallback ( $item , $field , $errorString )
{
$this -> errors [ $item -> name ][ $field ] = $errorString ;
}
public function progress ( $count )
{
2016-12-29 14:02:18 -08:00
if ( ! $this -> bar ) {
2016-12-26 15:16:42 -08:00
$this -> bar = $this -> output -> createProgressBar ( $count );
}
static $index = 0 ;
$index ++ ;
2016-12-29 14:02:18 -08:00
if ( $index < $count ) {
2016-12-26 15:16:42 -08:00
$this -> bar -> advance ();
2016-06-22 12:27:41 -07:00
} else {
2016-12-26 15:16:42 -08:00
$this -> bar -> finish ();
2016-06-22 12:27:41 -07:00
}
}
// Tracks the current item for error messages
2016-10-25 19:51:13 -07:00
private $updating ;
2016-06-22 12:27:41 -07:00
// An array of errors encountered while parsing
private $errors ;
/**
* Log a message to file , configurable by the -- log - file parameter .
* If a warning message is passed , we ' ll spit it to the console as well .
*
* @ author Daniel Melzter
* @ since 3.0
* @ param string $string
* @ param string $level
*/
2016-12-26 15:16:42 -08:00
public function log ( $string , $level = 'info' )
2016-06-22 12:27:41 -07:00
{
if ( $level === 'warning' ) {
\Log :: warning ( $string );
$this -> comment ( $string );
} else {
\Log :: Info ( $string );
if ( $this -> option ( 'verbose' )) {
$this -> comment ( $string );
}
}
}
/**
* Get the console command arguments .
*
* @ author Daniel Melzter
* @ since 3.0
* @ return array
*/
protected function getArguments ()
{
return array (
array ( 'filename' , InputArgument :: REQUIRED , 'File for the CSV import.' ),
);
}
/**
* Get the console command options .
*
* @ author Daniel Melzter
* @ since 3.0
* @ return array
*/
protected function getOptions ()
{
return array (
array ( 'email_format' , null , InputOption :: VALUE_REQUIRED , 'The format of the email addresses that should be generated. Options are firstname.lastname, firstname, filastname' , null ),
array ( 'username_format' , null , InputOption :: VALUE_REQUIRED , 'The format of the username that should be generated. Options are firstname.lastname, firstname, filastname, email' , null ),
array ( 'logfile' , null , InputOption :: VALUE_REQUIRED , 'The path to log output to. storage/logs/importer.log by default' , storage_path ( 'logs/importer.log' ) ),
Importer mapping - v1 (#3677)
* Move importer to an inline-template, allows for translations and easier passing of data from laravel to vue.
* Pull the modal out into a dedicated partial, move importer to views/importer.
* Add document of CSV->importer mappings. Reorganize some code.
Progress.
* Add header_row and first_row to imports table, and process upon uploading a file
* Use an expandable table row instead of a modal for import processing. This should allow for field mapping interaction easier.
* Fix import processing after moving method.
* Frontend importer mapping improvements.
Invert display so we show found columns and allow users to select an
importer field to map to. Also implement sample data based on first row
of csv.
* Update select2. Maintain selected items properly.
* Backend support for importing. Only works on the web importer currently. Definitely needs testing and polish.
* We no longer use vue-modal plugin.
* Add a column to track field mappings to the imports table.
* Cleanup/rename methods+refactor
* Save field mappings and import type when attempting an import, and repopulate these values when returning to the page.
* Update debugbar to fix a bug in the debugbar code.
* Fix asset tag detection.
Also rename findMatch to be a bit clearer as to what it does.
Remove logging to file of imports for http imports because
it eats an incredible amouint of memory.
This commit also moves imports out of the hardware namespace and into
their own webcontroller and route prefix, remove dead code from
AssetController as a result.
* Dynamically limit options for select2 based on import type selected, and group them by item type.
* Add user importer.
Still need to implement emailing of passwords to new users, and probably
test a bit more.
This also bumps the memory limit for web imports up as well, I need to
profile memory usage here before too long.
* Query the db to find user matches rather than search the array. Performance is much much better.
* Speed/memory improvements in importers.
Move to querying the db rather than maintaining an array for all
importers. Also only store the id of items when we import, rather than
the full model. It saves a decent amount of memory.
* Remove grouping of items in select2
With the values being set dynamically, the grouping is redundant. It
also caused a regression with automatically guessing/matching field
names. This is starting to get close.
* Remove debug line on every create.
* Switch migration to be text field instead of json field for compatibility with older mysql/mariadb
* Fix asset import regression matching email address.
* Rearrange travis order in attempt to fix null settings.
* Use auth::id instead of fetching it off the user. Fixes a null object reference during seeding.
2017-06-21 16:37:37 -07:00
array ( 'item-type' , null , InputOption :: VALUE_REQUIRED , 'Item Type To import. Valid Options are Asset, Consumable, Accessory, License, or User' , 'Asset' ),
2016-08-29 15:49:32 -07:00
array ( 'web-importer' , null , InputOption :: VALUE_NONE , 'Internal: packages output for use with the web importer' ),
array ( 'user_id' , null , InputOption :: VALUE_REQUIRED , 'ID of user creating items' , 1 ),
array ( 'update' , null , InputOption :: VALUE_NONE , 'If a matching item is found, update item information' ),
2018-10-04 04:44:12 -07:00
array ( 'send-welcome' , null , InputOption :: VALUE_NONE , 'Whether to send a welcome email to any new users that are created.' ),
2016-06-22 12:27:41 -07:00
);
2016-05-17 19:25:17 -07:00
2016-06-22 12:27:41 -07:00
}
2016-05-31 17:00:11 -07:00
}