2010-10-07 00:18:09 +02:00
< ? php
/**
2011-05-02 15:59:29 +02:00
* EGroupware - InfoLog CSV import
2010-10-07 00:18:09 +02:00
*
* @ license http :// opensource . org / licenses / gpl - license . php GPL - GNU General Public License
* @ package importexport
* @ link http :// www . egroupware . org
* @ author Cornelius Weiss < nelius @ cwtech . de >
* @ copyright Cornelius Weiss < nelius @ cwtech . de >
2011-05-02 15:59:29 +02:00
* @ version $Id $
2010-10-07 00:18:09 +02:00
*/
2016-04-30 19:05:23 +02:00
use EGroupware\Api ;
use EGroupware\Api\Link ;
2010-10-07 00:18:09 +02:00
/**
* class import_csv for infolog
*/
class infolog_import_infologs_csv implements importexport_iface_import_plugin {
private static $plugin_options = array (
'fieldsep' , // char
'charset' , // string
'contact_owner' , // int
'update_cats' , // string {override|add} overides record
// with cat(s) from csv OR add the cat from
// csv file to exeisting cat(s) of record
'num_header_lines' , // int number of header lines
'field_conversion' , // array( $csv_col_num => conversion)
'field_mapping' , // array( $csv_col_num => adb_filed)
'conditions' , /* => array containing condition arrays :
'type' => exists , // exists
'string' => '#kundennummer' ,
'true' => array (
'action' => update ,
'last' => true ,
),
'false' => array (
'action' => insert ,
'last' => true ,
), */
);
public static $special_fields = array (
'projectmanager' => 'Link to Projectmanager, use Project-ID, Title or @project_id(id_or_title)' ,
'addressbook' => 'Link to Addressbook, use nlast,nfirst[,org] or contact_id from addressbook' ,
'link_1' => '1. link: appname:appid the entry should be linked to, eg.: addressbook:123' ,
'link_2' => '2. link: appname:appid the entry should be linked to, eg.: addressbook:123' ,
'link_3' => '3. link: appname:appid the entry should be linked to, eg.: addressbook:123' ,
2011-12-12 21:32:45 +01:00
'link_custom' => 'Link by custom field, use <appname>:<custom_field_name>:|[<field_index>]'
2010-10-07 00:18:09 +02:00
);
/**
* actions wich could be done to data entries
*/
protected static $actions = array ( 'none' , 'update' , 'insert' , 'delete' , );
/**
* conditions for actions
*
* @ var array
*/
protected static $conditions = array ( 'exists' );
/**
* @ var definition
*/
private $definition ;
/**
2012-03-09 10:22:15 +01:00
* @ var infolog_bo
2010-10-07 00:18:09 +02:00
*/
private $boinfolog ;
/**
* For figuring out if a record has changed
2012-03-09 10:22:15 +01:00
*
* @ var infolog_tracking ::
2010-10-07 00:18:09 +02:00
*/
protected $tracking ;
/**
* @ var bool
*/
private $dry_run = false ;
/**
* @ var int
*/
private $user = null ;
2011-12-15 17:24:47 +01:00
/**
* List of import warnings
*/
protected $warnings = array ();
2010-10-07 00:18:09 +02:00
/**
* List of import errors
*/
protected $errors = array ();
/**
2012-03-09 10:22:15 +01:00
* List of actions , and how many times that action was taken
*/
protected $results = array ();
2010-10-07 00:18:09 +02:00
/**
* imports entries according to given definition object .
* @ param resource $_stream
* @ param string $_charset
* @ param definition $_definition
*/
public function import ( $_stream , importexport_definition $_definition ) {
$import_csv = new importexport_import_csv ( $_stream , array (
'fieldsep' => $_definition -> plugin_options [ 'fieldsep' ],
'charset' => $_definition -> plugin_options [ 'charset' ],
));
$this -> definition = $_definition ;
$this -> user = $GLOBALS [ 'egw_info' ][ 'user' ][ 'account_id' ];
// dry run?
$this -> dry_run = isset ( $_definition -> plugin_options [ 'dry_run' ] ) ? $_definition -> plugin_options [ 'dry_run' ] : false ;
// fetch the infolog bo
$this -> boinfolog = new infolog_bo ();
// Get the tracker for changes
$this -> tracking = new infolog_tracking ( $this -> boinfolog );
2012-10-10 18:01:26 +02:00
// Need translations for some human stuff (early type detection)
2016-04-30 19:05:23 +02:00
Api\Translation :: add_app ( 'infolog' );
2012-10-10 18:01:26 +02:00
2010-10-07 00:18:09 +02:00
// set FieldMapping.
$import_csv -> mapping = $_definition -> plugin_options [ 'field_mapping' ];
// set FieldConversion
$import_csv -> conversion = $_definition -> plugin_options [ 'field_conversion' ];
// Add extra conversions
$import_csv -> conversion_class = $this ;
//check if file has a header lines
if ( isset ( $_definition -> plugin_options [ 'num_header_lines' ] ) && $_definition -> plugin_options [ 'num_header_lines' ] > 0 ) {
$import_csv -> skip_records ( $_definition -> plugin_options [ 'num_header_lines' ]);
} elseif ( isset ( $_definition -> plugin_options [ 'has_header_line' ]) && $_definition -> plugin_options [ 'has_header_line' ]) {
// First method is preferred
$import_csv -> skip_records ( 1 );
}
// set Owner
2016-08-03 17:57:49 +02:00
$plugin_options = $_definition -> plugin_options ;
$plugin_options [ 'record_owner' ] = $_definition -> plugin_options [ 'record_owner' ] ?
2010-10-07 00:18:09 +02:00
$_definition -> plugin_options [ 'record_owner' ] : $this -> user ;
2016-08-03 17:57:49 +02:00
$plugin_options [ 'record_owner' ] = $this -> user ;
$_definition -> plugin_options = $plugin_options ;
2011-04-07 17:28:45 +02:00
$_lookups = array (
2012-10-09 17:57:17 +02:00
'info_type' => $this -> boinfolog -> enums [ 'type' ],
2012-10-10 17:00:54 +02:00
'info_status' => $this -> boinfolog -> status [ 'task' ],
'info_priority' => $this -> boinfolog -> enums [ 'priority' ],
'info_confirm' => $this -> boinfolog -> enums [ 'confirm' ]
2011-04-07 17:28:45 +02:00
);
2010-10-07 00:18:09 +02:00
// Start counting successes
$count = 0 ;
$this -> results = array ();
// Failures
$this -> errors = array ();
2012-02-14 19:34:44 +01:00
$this -> warnings = array ();
2010-10-07 00:18:09 +02:00
while ( $record = $import_csv -> get_record () ) {
$success = false ;
// don't import empty records
if ( count ( array_unique ( $record ) ) < 2 ) continue ;
2011-04-07 17:28:45 +02:00
$lookups = $_lookups ;
2012-10-10 18:01:26 +02:00
// Early detection of type, to load appropriate statuses
foreach ( array ( $lookups [ 'info_type' ], array_map ( 'strtolower' , array_map ( 'lang' , $lookups [ 'info_type' ]))) as $types )
2011-12-07 00:05:46 +01:00
{
2012-10-10 18:01:26 +02:00
if ( $record [ 'info_type' ] && $key = array_search ( strtolower ( $record [ 'info_type' ]), $types ))
{
$lookups [ 'info_status' ] = $this -> boinfolog -> status [ $key ];
break ;
}
2011-04-07 17:28:45 +02:00
}
2012-01-25 19:14:57 +01:00
$result = importexport_import_csv :: convert ( $record , infolog_egw_record :: $types , 'infolog' , $lookups , $_definition -> plugin_options [ 'convert' ]);
if ( $result ) $this -> warnings [ $import_csv -> get_current_position ()] = $result ;
2011-04-07 17:28:45 +02:00
2012-02-29 01:39:09 +01:00
// Make sure type is valid
if ( ! $record [ 'info_type' ] || $record [ 'info_type' ] && ! $this -> boinfolog -> enums [ 'type' ][ $record [ 'info_type' ]])
{
2012-10-09 17:57:17 +02:00
// Check for translated type
2016-04-30 19:05:23 +02:00
$un_trans = Api\Translation :: get_message_id ( $record [ 'info_type' ], 'infolog' );
2012-10-09 17:57:17 +02:00
if ( $record [ 'info_type' ] && $this -> boinfolog -> enums [ 'type' ][ $un_trans ])
{
$record [ 'info_type' ] = $un_trans ;
}
else
{
$this -> errors [ $import_csv -> get_current_position ()] .= ( $this -> errors [ $import_csv -> get_current_position ()] ? " \n " : '' ) .
lang ( 'Unknown type: %1' , $record [ 'info_type' ]);
}
2012-02-29 01:39:09 +01:00
}
2011-12-07 00:05:46 +01:00
// Set default status for type, if not specified
if ( ! $record [ 'info_status' ] && $record [ 'info_type' ])
{
$record [ 'info_status' ] = $this -> boinfolog -> status [ 'defaults' ][ $record [ 'info_type' ]];
}
2010-10-07 00:18:09 +02:00
// Set owner, unless it's supposed to come from CSV file
2011-12-07 00:05:46 +01:00
if ( $_definition -> plugin_options [ 'owner_from_csv' ])
{
if ( ! is_numeric ( $record [ 'info_owner' ]))
{
2010-10-07 00:18:09 +02:00
$this -> errors [ $import_csv -> get_current_position ()] = lang (
2011-05-02 15:59:29 +02:00
'Invalid owner ID: %1. Might be a bad field translation. Used %2 instead.' ,
$record [ 'info_owner' ],
2010-10-07 00:18:09 +02:00
$_definition -> plugin_options [ 'record_owner' ]
);
$record [ 'info_owner' ] = $_definition -> plugin_options [ 'record_owner' ];
}
2011-12-07 00:05:46 +01:00
}
else
{
2010-10-07 00:18:09 +02:00
$record [ 'info_owner' ] = $_definition -> plugin_options [ 'record_owner' ];
}
2011-09-29 15:01:32 +02:00
if ( ! isset ( $record [ 'info_owner' ])) $record [ 'info_owner' ] = $GLOBALS [ 'egw_info' ][ 'user' ][ 'account_id' ];
2012-01-20 16:54:10 +01:00
// Responsible has to be an array
$record [ 'info_responsible' ] = $record [ 'info_responsible' ] ? explode ( ',' , $record [ 'info_responsible' ]) : 0 ;
2010-10-07 00:18:09 +02:00
// Special values
if ( $record [ 'addressbook' ] && ! is_numeric ( $record [ 'addressbook' ]))
2012-03-09 10:22:15 +01:00
{
list ( $lastname , $firstname , $org_name ) = explode ( ',' , $record [ 'addressbook' ]);
2014-06-16 22:08:17 +02:00
$record [ 'addressbook' ] = importexport_basic_import_csv :: addr_id ( $lastname , $firstname , $org_name );
2012-03-09 10:22:15 +01:00
}
if ( $record [ 'projectmanager' ] && ! is_numeric ( $record [ 'projectmanager' ]))
{
$record [ 'projectmanager' ] = self :: project_id ( $record [ 'projectmanager' ]);
}
2010-10-07 00:18:09 +02:00
2011-12-07 00:05:46 +01:00
if ( $_definition -> plugin_options [ 'conditions' ] )
{
foreach ( $_definition -> plugin_options [ 'conditions' ] as $condition )
{
2011-03-22 00:02:22 +01:00
$results = array ();
2011-12-07 00:05:46 +01:00
switch ( $condition [ 'type' ] )
{
2010-10-07 00:18:09 +02:00
// exists
case 'exists' :
2011-03-22 00:02:22 +01:00
if ( $record [ $condition [ 'string' ]]) {
2011-04-07 17:28:45 +02:00
$query [ 'col_filter' ] = array ( $condition [ 'string' ] => $record [ $condition [ 'string' ]],);
2011-11-30 19:01:29 +01:00
// Needed to query custom fields
if ( $condition [ 'string' ][ 0 ] == '#' ) $query [ 'custom_fields' ] = true ;
2011-04-07 17:28:45 +02:00
$results = $this -> boinfolog -> search ( $query );
2011-03-22 00:02:22 +01:00
}
if ( is_array ( $results ) && count ( array_keys ( $results )) >= 1 ) {
2010-10-07 00:18:09 +02:00
// apply action to all records matching this exists condition
$action = $condition [ 'true' ];
foreach ( ( array ) $results as $contact ) {
2011-09-29 15:01:32 +02:00
$record [ 'info_id' ] = $contact [ 'info_id' ];
$record [ 'info_owner' ] = $contact [ 'info_owner' ];
2010-10-07 00:18:09 +02:00
if ( $_definition -> plugin_options [ 'update_cats' ] == 'add' ) {
if ( ! is_array ( $contact [ 'cat_id' ] ) ) $contact [ 'cat_id' ] = explode ( ',' , $contact [ 'cat_id' ] );
if ( ! is_array ( $record [ 'cat_id' ] ) ) $record [ 'cat_id' ] = explode ( ',' , $record [ 'cat_id' ] );
$record [ 'cat_id' ] = implode ( ',' , array_unique ( array_merge ( $record [ 'cat_id' ], $contact [ 'cat_id' ] ) ) );
}
$success = $this -> action ( $action [ 'action' ], $record , $import_csv -> get_current_position () );
}
} else {
$action = $condition [ 'false' ];
$success = ( $this -> action ( $action [ 'action' ], $record , $import_csv -> get_current_position () ));
}
break ;
// not supported action
default :
die ( 'condition / action not supported!!!' );
break ;
}
if ( $action [ 'last' ]) break ;
}
2011-12-07 00:05:46 +01:00
}
else
{
2010-10-07 00:18:09 +02:00
// unconditional insert
$success = $this -> action ( 'insert' , $record , $import_csv -> get_current_position () );
}
if ( $success ) $count ++ ;
2012-02-29 18:24:42 +01:00
if ( $this -> warnings [ $import_csv -> get_current_position ()]) {
$this -> warnings [ $import_csv -> get_current_position ()] .= " \n Record: \n " . array2string ( $record );
}
if ( $this -> errors [ $import_csv -> get_current_position ()]) {
$this -> errors [ $import_csv -> get_current_position ()] .= " \n Record: \n " . array2string ( $record );
}
2010-10-07 00:18:09 +02:00
}
return $count ;
}
/**
* perform the required action
*
* @ param int $_action one of $this -> actions
* @ param array $_data contact data for the action
* @ return bool success or not
*/
private function action ( $_action , $_data , $record_num = 0 ) {
$result = true ;
switch ( $_action ) {
case 'none' :
return true ;
case 'update' :
// Only update if there are changes
2011-04-07 17:28:45 +02:00
$old = $this -> boinfolog -> read ( $_data [ 'info_id' ]);
2010-10-07 00:18:09 +02:00
if ( ! $this -> definition -> plugin_options [ 'change_owner' ]) {
// Don't change addressbook of an existing contact
unset ( $_data [ 'owner' ]);
}
// Merge to deal with fields not in import record
$_data = array_merge ( $old , $_data );
$changed = $this -> tracking -> changed_fields ( $_data , $old );
if ( count ( $changed ) == 0 && ! $this -> definition -> plugin_options [ 'update_timestamp' ]) {
break ;
}
2011-05-02 15:59:29 +02:00
2010-10-07 00:18:09 +02:00
// Fall through
case 'insert' :
if ( $this -> dry_run ) {
//print_r($_data);
2012-01-25 19:14:57 +01:00
// Check for link during dry run
if ( $_data [ 'link_custom' ])
{
2016-04-30 19:05:23 +02:00
list ( $app , $app_id2 ) = explode ( ':' , $_data [ 'link_custom' ], 2 );
$app_id = $this -> link_by_cf ( $record_num , $app , $field , $app_id2 );
2012-01-25 19:14:57 +01:00
}
2010-10-07 00:18:09 +02:00
$this -> results [ $_action ] ++ ;
break ;
} else {
2013-01-14 23:59:08 +01:00
$result = $this -> boinfolog -> write (
$_data , true , 2 , true , // 2 = dont touch modification date
$this -> definition -> plugin_options [ 'no_notification' ]
);
2012-03-19 19:45:14 +01:00
if ( ! $result )
{
if ( $result === false )
{
$this -> errors [ $record_num ] = lang ( 'Permissions error - %1 could not %2' ,
$GLOBALS [ 'egw' ] -> accounts -> id2name ( $_data [ 'info_owner' ]),
lang ( $_action )
);
}
else
{
$this -> errors [ $record_num ] = lang ( 'Error: the entry has been updated since you opened it for editing!' );
}
}
else
{
2010-10-07 00:18:09 +02:00
$this -> results [ $_action ] ++ ;
}
break ;
}
default :
2016-04-30 19:05:23 +02:00
throw new Api\Exception ( 'Unsupported action' );
2010-10-07 00:18:09 +02:00
}
// Process some additional fields
if ( ! is_numeric ( $result )) {
return $result ;
}
2011-12-12 21:32:45 +01:00
$info_link_id = $_data [ 'info_link_id' ];
2016-04-30 19:05:23 +02:00
foreach ( array_keys ( self :: $special_fields ) as $field ) {
2010-10-07 00:18:09 +02:00
if ( ! $_data [ $field ]) continue ;
2011-12-12 21:32:45 +01:00
if ( strpos ( $field , 'link' ) === 0 ) {
list ( $app , $app_id ) = explode ( ':' , $_data [ $field ], 2 );
// Linking to another entry based on matching custom fields
if ( $field == 'link_custom' )
{
$app_id = $this -> link_by_cf ( $record_num , $app , $field , $app_id );
}
2010-10-07 00:18:09 +02:00
} else {
$app = $field ;
2011-12-12 21:32:45 +01:00
$app_id = $_data [ $field ];
2010-10-07 00:18:09 +02:00
}
if ( $app && $app_id ) {
2011-12-12 21:32:45 +01:00
$id = $_data [ 'info_id' ] ? $_data [ 'info_id' ] : ( int ) $result ;
2010-10-07 00:18:09 +02:00
//echo "<p>linking infolog:$id with $app:$app_id</p>\n";
2016-04-30 19:05:23 +02:00
$link_id = Link :: link ( 'infolog' , $id , $app , $app_id );
2010-10-07 00:18:09 +02:00
if ( $link_id && ! $info_link_id )
{
$to_write = array (
'info_id' => $id ,
'info_link_id' => $link_id ,
);
2012-03-09 10:22:15 +01:00
$this -> boinfolog -> write ( $to_write , False , false , true , true ); // last true = no notifications, as no real change
2011-12-12 21:32:45 +01:00
$info_link_id = $link_id ;
2010-10-07 00:18:09 +02:00
}
}
}
return $result ;
}
/**
* returns translated name of plugin
*
* @ return string name
*/
public static function get_name () {
return lang ( 'Infolog CSV import' );
}
/**
* returns translated ( user ) description of plugin
*
* @ return string descriprion
*/
public static function get_description () {
return lang ( " Imports entries into the infolog from a CSV File. CSV means 'Comma Seperated Values'. However in the options Tab you can also choose other seperators. " );
}
/**
* retruns file suffix ( s ) plugin can handle ( e . g . csv )
*
* @ return string suffix ( comma seperated )
*/
public static function get_filesuffix () {
return 'csv' ;
}
/**
* return etemplate components for options .
* @ abstract We can ' t deal with etemplate objects here , as an uietemplate
* objects itself are scipt orientated and not " dialog objects "
*
* @ return array (
* name => string ,
* content => array ,
* sel_options => array ,
* preserv => array ,
* )
*/
public function get_options_etpl () {
// lets do it!
}
/**
* returns etemplate name for slectors of this plugin
*
* @ return string etemplate name
*/
public function get_selectors_etpl () {
// lets do it!
}
2011-12-15 17:24:47 +01:00
/**
2012-03-09 10:22:15 +01:00
* Returns warnings that were encountered during importing
* Maximum of one warning message per record , but you can append if you need to
*
* @ return Array (
* record_ # => warning message
* )
*/
public function get_warnings () {
2011-12-15 17:24:47 +01:00
return $this -> warnings ;
}
2010-10-07 00:18:09 +02:00
/**
2012-03-09 10:22:15 +01:00
* Returns errors that were encountered during importing
* Maximum of one error message per record , but you can append if you need to
*
* @ return Array (
* record_ # => error message
* )
*/
public function get_errors () {
2010-10-07 00:18:09 +02:00
return $this -> errors ;
}
/**
2012-03-09 10:22:15 +01:00
* Returns a list of actions taken , and the number of records for that action .
* Actions are things like 'insert' , 'update' , 'delete' , and may be different for each plugin .
*
* @ return Array (
* action => record count
* )
*/
public function get_results () {
return $this -> results ;
}
2010-10-07 00:18:09 +02:00
// end of iface_export_plugin
// Extra conversion functions - must be static
public static function project_id ( $num_or_title )
{
2016-04-30 19:05:23 +02:00
static $boprojects = null ;
2010-10-07 00:18:09 +02:00
if ( ! $num_or_title ) return false ;
if ( ! is_object ( $boprojects ))
{
2015-05-19 22:13:38 +02:00
$boprojects = new projectmanager_bo ();
2010-10-07 00:18:09 +02:00
}
if (( $projects = $boprojects -> search ( array ( 'pm_number' => $num_or_title ))) ||
( $projects = $boprojects -> search ( array ( 'pm_title' => $num_or_title ))))
{
return $projects [ 0 ][ 'pm_id' ];
}
return false ;
}
2011-12-12 21:32:45 +01:00
/**
* Get the primary key for an entry based on a custom field
* Returns key , so regular linking can take over
2014-06-18 16:35:44 +02:00
*
* This is a copy of what ' s in importexport_basic_import_csv , and can go
* away if this is changed to extend it
2011-12-12 21:32:45 +01:00
*/
2016-04-30 19:05:23 +02:00
protected function link_by_cf ( $record_num , $app , $fieldname , $_value )
2011-12-12 21:32:45 +01:00
{
$app_id = false ;
2016-04-30 19:05:23 +02:00
list ( $custom_field , $value ) = explode ( ':' , $_value );
2011-12-12 21:32:45 +01:00
// Find matching entry
if ( $app && $custom_field && $value )
{
2016-04-30 19:05:23 +02:00
$cfs = Api\Storage\Customfields :: get ( $app );
2012-01-20 20:51:03 +01:00
// Error if no custom fields, probably something wrong in definition
2011-12-12 21:32:45 +01:00
if ( ! $cfs [ $custom_field ])
{
// Check for users specifing label instead of name
foreach ( $cfs as $name => $settings )
{
2012-01-20 20:51:03 +01:00
if ( strtolower ( $settings [ 'label' ]) == strtolower ( $custom_field ))
2011-12-12 21:32:45 +01:00
{
$custom_field = $name ;
break ;
}
}
}
2012-01-20 20:51:03 +01:00
// Couldn't find field, give an error - something's wrong
if ( ! $cfs [ $custom_field ] && ! $cfs [ substr ( $custom_field , 1 )]) {
2012-03-09 10:22:15 +01:00
$this -> errors [ $record_num ] .= lang ( 'No custom field "%1" for %2.' ,
2012-01-20 20:51:03 +01:00
$custom_field , lang ( $app ));
return false ;
}
2011-12-12 21:32:45 +01:00
if ( $custom_field [ 0 ] != '#' ) $custom_field = '#' . $custom_field ;
// Search
2016-04-30 19:05:23 +02:00
if ( Link :: get_registry ( $app , 'query' ))
2011-12-12 21:32:45 +01:00
{
2011-12-27 16:36:35 +01:00
$options = array ( 'filter' => array ( " $custom_field = " . $GLOBALS [ 'egw' ] -> db -> quote ( $value )));
2016-04-30 19:05:23 +02:00
$result = Link :: query ( $app , '' , $options );
2012-03-09 10:22:15 +01:00
2011-12-12 21:32:45 +01:00
// Only one allowed
if ( count ( $result ) != 1 )
{
2012-01-25 19:14:57 +01:00
$this -> warnings [ $record_num ] .= ( $this -> warnings [ $record_num ] ? " \n " : '' ) .
2012-03-09 10:22:15 +01:00
lang ( 'Unable to link to %3 by custom field "%1": "%4". %2 matches.' ,
2012-02-02 18:22:23 +01:00
$custom_field , count ( $result ), lang ( $app ), $options [ 'filter' ][ 0 ]
2012-01-25 19:14:57 +01:00
);
2011-12-12 21:32:45 +01:00
return false ;
}
$app_id = key ( $result );
}
}
return $app_id ;
}
2010-10-07 00:18:09 +02:00
}