egroupware_official/infolog/inc/class.infolog_so.inc.php
2024-06-20 11:12:09 +02:00

1108 lines
39 KiB
PHP

<?php
/**
* EGroupare - InfoLog - Storage object
*
* @link http://www.egroupware.org
* @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
* @package infolog
* @copyright (c) 2003-17 by Ralf Becker <RalfBecker-AT-outdoor-training.de>
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
*/
use EGroupware\Api;
use EGroupware\Api\Link;
use EGroupware\Api\Acl;
/**
* storage object / db-layer for InfoLog
*
* all values passed to this class are run either through intval or addslashes to prevent query-insertion
* and for pgSql 7.3 compatibility
*/
class infolog_so
{
/**
* Instance of the db class
*
* @var Api\Db
*/
var $db;
/**
* Grants from other users
*
* @var array
*/
var $grants;
/**
* Internal data array
*
* @var array
*/
var $data = array( );
/**
* Current user (account_id)
*
* @var int
*/
var $user;
/**
* Infolog table-name
*
* @var string
*/
var $info_table = 'egw_infolog';
/**
* Infolog custom fileds table-name
*
* @var string
*/
var $extra_table = 'egw_infolog_extra';
/**
* Infolog delegation / iCal attendees
*
* @var string
*/
var $users_table = 'egw_infolog_users';
/**
* Offset between server- and user-time in h
*
* @var int
*/
var $tz_offset;
/**
* Constructor
*
* @param array $grants =array()
* @return soinfolog
*/
function __construct( $grants=array() )
{
$this->db = clone($GLOBALS['egw']->db);
$this->db->set_app('infolog');
$this->grants = $grants;
$this->user = $GLOBALS['egw_info']['user']['account_id'];
$this->tz_offset = $GLOBALS['egw_info']['user']['preferences']['common']['tz_offset'];
}
/**
* Check if user is responsible for an entry: he or one of his memberships is in responsible
*
* @param array $info infolog entry as array
* @param int $user =null user to check for, default $this->user
* @return boolean
*/
function is_responsible($info,$user=null)
{
if (!$user) $user = $this->user;
return self::is_responsible_user($info, $user);
}
/**
* Check if user is responsible for an entry: he or one of his memberships is in responsible
*
* @param array $info infolog entry as array
* @param int $user =null user to check for
* @return boolean
*/
static function is_responsible_user($info, $user)
{
static $um_cache = array();
$user_and_memberships =& $um_cache[$user];
if (!isset($user_and_memberships))
{
$user_and_memberships = $GLOBALS['egw']->accounts->memberships($user,true);
$user_and_memberships[] = $user;
}
return $info['info_responsible'] && array_intersect((array)$info['info_responsible'],$user_and_memberships);
}
/**
* checks if user has the $required_rights to access $info_id (private access is handled too)
*
* @param array|int $info data or info_id of InfoLog entry
* @param int $required_rights EGW_ACL_xyz anded together
* @param boolean $implicit_edit =false responsible has only implicit read and add rigths, unless this is set to true
* @param array $grants =null grants to use, default (null) $this->grants
* @param int $user =null user to check, default (null) $this->user
* @return boolean True if access is granted else False
*/
function check_access( $info,$required_rights,$implicit_edit=false,array $grants=null,$user=null )
{
if (is_null($grants)) $grants = $this->grants;
if (!$user) $user = $this->user;
// if info-array, but no owner given, force reading of info from db
if (is_array($info) && !$info['info_owner']) $info = $info['info_id'];
if (is_array($info))
{
}
elseif ((int) $info != $this->data['info_id']) // already loaded?
{
// dont change our own internal data,
$backup_data = $this->data;
$info = $this->read(array('info_id'=>$info));
$this->data = $backup_data;
}
else
{
$info = $this->data;
}
if (!$info)
{
return False;
}
$owner = $info['info_owner'];
$access_ok = $owner == $user || // user has all rights
// ACL only on public entrys || $owner granted _PRIVATE
(!!($grants[$owner] & $required_rights) ||
$this->is_responsible($info,$user) && // implicite rights for responsible user(s) and his memberships
($required_rights == Acl::READ || $required_rights == Acl::ADD || $implicit_edit && $required_rights == Acl::EDIT)) &&
($info['info_access'] == 'public' || !!($this->grants[$user] & Acl::PRIVAT));
// error_log(__METHOD__."($info[info_id],$required_rights,$implicit_edit,".array2string($grants).",$user) returning ".array2string($access_ok));
return $access_ok;
}
/**
* Filter for a given responsible user: info_responsible either contains a the user or one of his memberships
*
* @param int|array $users one or more account_ids
* @param boolean $deleted_too =false true: also use deleted entries
* @return string
*/
function responsible_filter($users, $deleted_too=false)
{
if (!$users) return '0';
$responsible = array();
foreach((array)$users as $user)
{
$responsible = array_merge($responsible,(array)
($user > 0 ? $GLOBALS['egw']->accounts->memberships($user,true) :
$GLOBALS['egw']->accounts->members($user,true)));
$responsible[] = $user;
}
if (is_array($users))
{
$responsible = array_unique($responsible);
}
$sql = "$this->users_table.account_id IN (".implode(',', array_map(array($this->db, 'quote'), $responsible)).')';
if (!$deleted_too)
{
// we use NULL or true, not false!
$sql .= " AND $this->users_table.info_res_deleted IS NULL";
}
return $sql;
}
/**
* generate sql to be AND'ed into a query to ensure ACL is respected (incl. _PRIVATE)
*
* @param string $_filter ''|all - list all entrys user have rights to see<br>
* private|own - list only his personal entrys (incl. those he is responsible for !!!),
* responsible|my = entries the user is responsible for
* delegated = entries the user delegated to someone else
* @return string the necesary sql
*/
function aclFilter($_filter = False)
{
$vars = null;
preg_match('/(my|responsible|delegated|own|privat|private|all|user)([0-9,-]*)(\+deleted)?/',$_filter,$vars);
$filter = $vars[1];
$f_user = $vars[2];
$deleted_too = !empty($vars[3]);
if (isset($this->acl_filter[$filter.$f_user]))
{
return $this->acl_filter[$filter.$f_user]; // used cached filter if found
}
if ($f_user && strpos($f_user,',') !== false)
{
$f_user = explode(',',$f_user);
}
$filtermethod = " (info_owner=$this->user"; // user has all rights
if ($filter == 'my' || $filter == 'responsible')
{
$filtermethod .= " AND $this->users_table.account_id IS NULL";
}
if ($filter == 'delegated')
{
$filtermethod .= " AND $this->users_table.account_id IS NOT NULL)";
}
else
{
if (is_array($this->grants))
{
foreach($this->grants as $user => $grant)
{
// echo "<p>grants: user=$user, grant=$grant</p>";
if ($grant & (EGW_ACL_READ|EGW_ACL_EDIT))
{
$public_user_list[] = $user;
}
if ($grant & Acl::PRIVAT)
{
$private_user_list[] = $user;
}
}
if (count($private_user_list))
{
$has_private_access = $this->db->expression($this->info_table,array('info_owner' => $private_user_list));
}
}
$public_access = $this->db->expression($this->info_table,array('info_owner' => $public_user_list));
// implicit read-rights for responsible user
$filtermethod .= " OR (".$this->responsible_filter($this->user, $deleted_too).')';
// private: own entries plus the one user is responsible for
if ($filter == 'private' || $filter == 'privat' || $filter == 'own')
{
$filtermethod .= " OR (".$this->responsible_filter($this->user, $deleted_too).
($filter == 'own' && count($public_user_list) ? // offer's should show up in own, eg. startpage, but need read-access
" OR info_status = 'offer' AND $public_access" : '').")".
" AND (info_access='public'".($has_private_access?" OR $has_private_access":'').')';
}
elseif ($filter != 'my' && $filter != 'responsible') // none --> all entrys user has rights to see
{
if ($has_private_access)
{
$filtermethod .= " OR $has_private_access";
}
if (count($public_user_list))
{
$filtermethod .= " OR (info_access='public' AND $public_access)";
}
}
$filtermethod .= ') ';
if ($filter == 'user' && $f_user)
{
$filtermethod .= $this->db->expression($this->info_table,' AND (',array(
'info_owner' => $f_user,
)," AND $this->users_table.account_id IS NULL OR ",$this->responsible_filter($f_user, $deleted_too),')');
}
}
//echo "<p>aclFilter(filter='$_filter',user='$f_user') = '$filtermethod', privat_user_list=".print_r($privat_user_list,True).", public_user_list=".print_r($public_user_list,True)."</p>\n";
return $this->acl_filter[$filter.$f_user] = $filtermethod; // cache the filter
}
/**
* generate sql to filter based on the status of the log-entry
*
* @param string $_filter done = done or billed, open = not (done, billed, cancelled or deleted), offer = offer
* @param boolean $prefix_and =true if true prefix the filter with ' AND '
* @return string the necessary sql
*/
function statusFilter($_filter = '',$prefix_and=true)
{
$vars = null;
preg_match('/(done|open|offer|deleted|\+deleted|\+archived)/',$_filter,$vars);
$filter = $vars[1]??null;
switch ($filter)
{
case 'done': $filter = "info_status IN ('done','billed','cancelled')"; break;
case 'open': $filter = "NOT (info_status IN ('done','billed','cancelled','deleted','template','nonactive','archive'))"; break;
case 'offer': $filter = "info_status = 'offer'"; break;
case 'deleted': $filter = "info_status = 'deleted'"; break;
case '+deleted':$filter = "NOT (info_status IN ('template','nonactive','archive'))"; break;
case '+archived':$filter = "NOT (info_status IN ('deleted','template','nonactive'))"; break;
default: $filter = "NOT (info_status IN ('deleted','template','nonactive','archive'))"; break;
}
return ($prefix_and ? ' AND ' : '').$filter;
}
/**
* generate sql to filter based on the start- and enddate of the log-entry
*
* @param string $_filter upcoming = startdate is in the future
* today: startdate < tomorrow
* overdue: enddate < tomorrow
* date: today <= startdate && startdate < tomorrow
* enddate: today <= enddate && enddate < tomorrow
* limitYYYY/MM/DD not older or open
* @return string the necesary sql
*/
function dateFilter($_filter = '')
{
$vars = null;
preg_match('/(open-upcoming|upcoming|today|overdue|date|enddate)([-\\/.0-9]*)/',$_filter,$vars);
$filter = $vars[1]??null;
if (isset($vars[2]) && !empty($vars[2]) && ($date = preg_split('/[-\\/.]/',$vars[2])))
{
$today = mktime(-$this->tz_offset,0,0,intval($date[1]),intval($date[2]),intval($date[0]));
$tomorrow = mktime(-$this->tz_offset,0,0,intval($date[1]),intval($date[2])+1,intval($date[0]));
}
else
{
$now = getdate(time()-60*60*$this->tz_offset);
$tomorrow = mktime(-$this->tz_offset,0,0,$now['mon'],$now['mday']+1,$now['year']);
}
switch ($filter)
{
case 'open-upcoming':
return "AND (info_startdate >= $tomorrow OR NOT (info_status IN ('done','billed','cancelled','deleted','template','nonactive','archive')))";
case 'upcoming':
return " AND info_startdate >= $tomorrow";
case 'today':
return " AND info_startdate < $tomorrow";
case 'overdue':
return " AND (info_enddate != 0 AND info_enddate < $tomorrow)";
case 'date':
if (!$today || !$tomorrow)
{
return '';
}
return " AND ($today <= info_startdate AND info_startdate < $tomorrow)";
case 'enddate':
if (!$today || !$tomorrow)
{
return '';
}
return " AND ($today <= info_enddate AND info_enddate < $tomorrow)";
case 'limit':
return " AND (info_modified >= $today OR NOT (info_status IN ('done','billed','cancelled')))";
}
return '';
}
/**
* initialise the internal $this->data to be empty
*
* only non-empty values got initialised
*/
function init()
{
$this->data = array(
'info_owner' => $this->user,
'info_priority' => 1,
'info_responsible' => array(),
);
}
/**
* read InfoLog entry $info_id
*
* some cacheing is done to prevent multiple reads of the same entry
*
* @param array $where where clause for entry to read
* @return array|boolean the entry as array or False on error (eg. entry not found)
*/
function read(array $where) // did _not_ ensure ACL
{
//error_log(__METHOD__.'('.array2string($where).')');
if (isset($GLOBALS['egw_info']['user']['preferences']['syncml']['minimum_uid_length']))
{
$minimum_uid_length = $GLOBALS['egw_info']['user']['preferences']['syncml']['minimum_uid_length'];
}
else
{
$minimum_uid_length = 8;
}
if (isset($where['info_id']))
{
$where[] = $this->db->expression($this->info_table, $this->info_table.'.', array('info_id' => $where['info_id']));
unset($where['info_id']);
}
if (!$where ||
!($this->data = $this->db->select($this->info_table,
$this->info_table.'.*,'.$this->db->group_concat('account_id').' AS info_responsible,'.
$this->db->group_concat('info_res_attendee').' AS info_cc,'.
$this->info_table.'.info_id AS info_id',
$where, __LINE__, __FILE__, false, "GROUP BY $this->info_table.info_id", 'infolog', 1,
"LEFT JOIN $this->users_table ON $this->info_table.info_id=$this->users_table.info_id AND $this->users_table.info_res_deleted IS NULL")->fetch()))
{
$this->init( );
//error_log(__METHOD__.'('.array2string($where).') returning FALSE');
return False;
}
// entry without uid --> create one based on our info_id and save it
if (!$this->data['info_uid'] || strlen($this->data['info_uid']) < $minimum_uid_length)
{
$this->data['info_uid'] = Api\CalDAV::generate_uid('infolog', $this->data['info_id']);
$this->db->update($this->info_table,
array('info_uid' => $this->data['info_uid']),
array('info_id' => $this->data['info_id']), __LINE__,__FILE__);
}
if (!is_array($this->data['info_responsible']))
{
$this->data['info_responsible'] = $this->data['info_responsible'] ? explode(',',$this->data['info_responsible']) : array();
foreach($this->data['info_responsible'] as $k => $v)
{
if (!is_numeric($v)) unset($this->data['info_responsible'][$k]);
}
$this->data['info_responsible'] = array_values($this->data['info_responsible']);
}
// Cast back to integer
$this->data['info_id_parent'] = (int)$this->data['info_id_parent'];
foreach($this->db->select($this->extra_table,'info_extra_name,info_extra_value',array('info_id'=>$this->data['info_id']),__LINE__,__FILE__) as $row)
{
$this->data['#'.$row['info_extra_name']] = $row['info_extra_value'];
}
//error_log(__METHOD__.'('.array2string($where).') returning '.array2string($this->data));
return $this->data;
}
/**
* delete InfoLog entry $info_id AND the links to it
*
* @param int $info_id id of log-entry
* @param boolean $delete_children delete the children, if not set there parent-id to $new_parent
* @param int $new_parent new parent-id to set for subs
*/
function delete($info_id,$delete_children=True,$new_parent=0) // did _not_ ensure ACL
{
//echo "<p>soinfolog::delete($info_id,'$delete_children',$new_parent)</p>\n";
if ((int) $info_id <= 0)
{
return;
}
$this->db->delete($this->info_table,array('info_id'=>$info_id),__LINE__,__FILE__);
$this->db->delete($this->extra_table,array('info_id'=>$info_id),__LINE__,__FILE__);
$this->db->delete($this->users_table,array('info_id'=>$info_id),__LINE__,__FILE__);
Link::unlink(0,'infolog',$info_id);
if ($this->data['info_id'] == $info_id)
{
$this->init( );
}
// delete children, if they are owned by the user
if ($delete_children)
{
$db2 = clone($this->db); // we need an extra result-set
foreach($db2->select($this->info_table,'info_id',array(
'info_id_parent' => $info_id,
'info_owner' => $this->user,
),__LINE__,__FILE__) as $row)
{
$this->delete($row['info_id'], $delete_children);
}
}
// set parent_id to $new_parent or 0 for all not deleted children
$this->db->update($this->info_table,array('info_id_parent'=>$new_parent),array('info_id_parent'=>$info_id),__LINE__,__FILE__);
}
/**
* Return array with children of $info_id as info_id => info_owner pairs
*
* @param int $info_id
* @return array with info_id => info_owner pairs
*/
function get_children($info_id)
{
$children = array();
foreach($this->db->select($this->info_table, 'info_id,info_owner', array(
'info_id_parent' => $info_id,
),__LINE__,__FILE__) as $row)
{
$children[$row['info_id']] = $row['info_owner'];
}
return $children;
}
/**
* changes or deletes entries with a spezified owner (for hook_delete_account)
*
* @param array $args hook arguments
* @param int $args['account_id'] account to delete
* @param int $args['new_owner']=0 new owner
* @todo test deleting an owner with replace and without
*/
function change_delete_owner(array $args) // new_owner=0 means delete
{
if (!(int) $args['new_owner'])
{
foreach($this->db->select($this->info_table,'info_id',array('info_owner'=>$args['account_id']),__LINE__,__FILE__,false,'','infolog') as $row)
{
$this->delete($row['info_id'],False);
}
}
else
{
$this->db->update($this->info_table,array('info_owner'=>$args['new_owner']),array('info_owner'=>$args['account_id']),__LINE__,__FILE__,'infolog');
}
if ($args['new_owner'])
{
// we cant just set the new owner, as he might be already set and we have a unique index
$this->db->query('UPDATE '.$this->users_table.
" LEFT JOIN $this->users_table new_owner ON new_owner.info_id=$this->users_table.info_id".
" AND new_owner.account_id=".$this->db->quote($args['new_owner']).
' SET '.$this->users_table.'.account_id='.$this->db->quote($args['new_owner']).
' WHERE '.$this->users_table.'.account_id='.$this->db->quote($args['account_id']).
' AND new_owner.account_id IS NULL',
__LINE__, __FILE__);
}
$this->db->delete($this->users_table, array('account_id' => $args['account_id']), __LINE__, __FILE__, 'infolog');
}
/**
* writes the given $values to InfoLog, a new entry gets created if info_id is not set or 0
*
* @param array $values with the data of the log-entry
* @param int $check_modified =0 old modification date to check before update (include in WHERE)
* @param string $purge_cfs =null null=dont, 'ical'=only iCal X-properties (cfs name starting with "#"), 'all'=all cfs
* @param boolean $force_insert =false force using insert, even if an id is given eg. for import
* @return int|boolean info_id, false on error or 0 if the entry has been updated in the meantime
*/
function write($values, $check_modified=0, $purge_cfs=null, $force_insert=false) // did _not_ ensure ACL
{
if (isset($GLOBALS['egw_info']['user']['preferences']['syncml']['minimum_uid_length']))
{
$minimum_uid_length = $GLOBALS['egw_info']['user']['preferences']['syncml']['minimum_uid_length'];
}
else
{
$minimum_uid_length = 8;
}
//echo "soinfolog::write(,$check_modified) values="; _debug_array($values);
$info_id = (int) $values['info_id'];
$table_def = $this->db->get_table_definitions('infolog',$this->info_table);
$to_write = array();
foreach($values as $key => $val)
{
if (($key != 'info_id' || $force_insert && $info_id > 0) && isset($table_def['fd'][$key]))
{
$to_write[$key] = $this->data[$key] = $val; // update internal data
}
}
// If no price list use NULL not 0
if($to_write['pl_id'] == '')
{
$to_write['pl_id'] = NULL;
}
// writing no price as SQL NULL (required by postgres)
if ($to_write['info_price'] === '') $to_write['info_price'] = NULL;
if (($this->data['info_id'] = $info_id) && !$force_insert)
{
$where = array('info_id' => $info_id);
if ($check_modified)
{
$where['info_datemodified'] = $check_modified;
// also check etag, if we got it
if (isset($values['info_etag']))
{
$where['info_etag'] = $values['info_etag'];
}
unset($to_write['info_etag']);
// and increment it
$to_write[] = 'info_etag=info_etag+1';
}
if (!$this->db->update($this->info_table,$to_write,$where,__LINE__,__FILE__))
{
//error_log("### soinfolog::write(".print_r($to_write,true).") where=".print_r($where,true)." returning false");
return false; // Error
}
if ($check_modified && $this->db->affected_rows() < 1)
{
//error_log("### soinfolog::write(".print_r($to_write,true).") where=".print_r($where,true)." returning 0 (nothing updated, eg. condition not met)");
return 0; // someone else updated the modtime or deleted the entry
}
}
else
{
if (!isset($to_write['info_id_parent'])) $to_write['info_id_parent'] = 0; // must not be null
$this->db->insert($this->info_table,$to_write,false,__LINE__,__FILE__);
$info_id = $this->data['info_id'] = $this->db->get_last_insert_id($this->info_table,'info_id');
}
$update = array();
// entry without (reasonable) uid --> create one based on our info_id and save it
if (!$this->data['info_uid'] || strlen($this->data['info_uid']) < $minimum_uid_length)
{
$update['info_uid'] = $this->data['info_uid'] = Api\CalDAV::generate_uid('infolog', $info_id);
}
// entry without caldav_name --> generate one based on info_id plus '.ics' extension
if (empty($this->data['caldav_name']))
{
$update['caldav_name'] = $this->data['caldav_name'] = $info_id.'.ics';
}
if ($update)
{
$this->db->update($this->info_table,$update,
array('info_id' => $info_id), __LINE__,__FILE__);
}
//echo "<p>soinfolog.write values= "; _debug_array($values);
// write customfields now
if ($purge_cfs)
{
$where = array('info_id' => $info_id);
if ($purge_cfs == 'ical') $where[] = "info_extra_name LIKE '#%'";
$this->db->delete($this->extra_table,$where,__LINE__,__FILE__);
}
$to_delete = array();
// Deal with files in new entries
Api\Storage\Customfields::handle_files('infolog',$info_id,$values);
foreach($values as $key => $val)
{
if ($key[0] != '#')
{
continue; // no customfield
}
$this->data[$key] = $val; // update internal data
if ($val)
{
$this->db->insert($this->extra_table,array(
// store multivalued CalDAV properties as serialized array, everything else get comma-separated
'info_extra_value' => is_array($val) ? ($key[1] == '#' ? json_encode($val) : implode(',',$val)) : $val,
),array(
'info_id' => $info_id,
'info_extra_name' => substr($key,1),
),__LINE__,__FILE__);
}
else
{
$to_delete[] = substr($key,1);
}
}
if ($to_delete && !$purge_cfs)
{
$this->db->delete($this->extra_table,array(
'info_id' => $info_id,
'info_extra_name' => $to_delete,
),__LINE__,__FILE__);
}
// echo "<p>soinfolog.write this->data= "; _debug_array($this->data);
//error_log("### soinfolog::write(".print_r($to_write,true).") where=".print_r($where,true)." returning id=".$this->data['info_id']);
// update attendees/delegates
if (array_key_exists('info_responsible', $values) || array_key_exists('info_cc', $values))
{
if (!is_array($values['info_responsible']))
{
$values['info_responsible'] = empty($values['info_responsible']) ? [] : explode(',', $values['info_responsible']);
}
$users = array_combine($values['info_responsible'], array_fill(0, count($values['info_responsible']), null));
foreach(!empty($values['info_cc']) ? explode(',', $values['info_cc']) : array() as $email)
{
$email = trim($email);
$matches = null;
if (preg_match('/<[^>]+@[^>]+>$/', $email, $matches))
{
$hash = md5(strtolower($matches[1]));
}
else
{
$hash = md5(strtolower($email));
}
$users[$hash] = $email;
}
// mark removed attendees as deleted
$this->db->update($this->users_table, array(
'info_res_deleted' => true,
'info_res_modifier' => $this->user,
), array(
'info_id' => $this->data['info_id'],
'info_res_deleted IS NULL',
)+(!$values['info_responsible'] ? array() :
array(1=>'account_id NOT IN ('.implode(',', array_map(array($this->db, 'quote'), array_keys($users))).')')),
__LINE__, __FILE__, 'infolog');
// add newly added attendees
if ($users)
{
$old_users = array();
foreach($this->db->select($this->users_table,'account_id,info_res_attendee',array(
'info_id' => $this->data['info_id'],
'info_res_deleted IS NULL',
), __LINE__, __FILE__, false, '', 'infolog') as $row)
{
$old_users[] = $row['account_id'];
}
foreach(array_diff(array_keys($users), $old_users) as $account_id)
{
$this->db->insert($this->users_table, array(
'info_res_modifier' => $this->user,
'info_res_status' => 'NEEDS-ACTION',
'info_res_attendee' => $users[$account_id],
'info_res_deleted' => null,
), array(
'info_id' => $this->data['info_id'],
'account_id' => $account_id,
), __LINE__, __FILE__, 'infolog');
}
}
}
return $this->data['info_id'];
}
/**
* count the sub-entries of $info_id
*
* This is done now be search too (in key info_anz_subs), if DB can use sub-queries
*
* @param int|array $info_id id(s) of log-entry
* @return int|array the number of sub-entries or indexed by info_id, if array as param given
*/
function anzSubs( $info_id )
{
if (!is_array($info_id) || !$info_id)
{
if ((int)$info_id <= 0) return 0;
}
$counts = array();
foreach($this->db->select($this->info_table,'info_id_parent,COUNT(*) AS info_anz_subs',array(
'info_id_parent' => $info_id,
"info_status != 'deleted'", // dont count deleted subs as subs, as they are not shown by default
),__LINE__,__FILE__,
false,'GROUP BY info_id_parent','infolog') as $row)
{
$counts[$row['info_id_parent']] = (int)$row['info_anz_subs'];
}
//echo '<p>'.__METHOD__."($info_id) = ".array2string($counts)."</p>\n";
return is_array($info_id) ? $counts : (int)array_pop($counts);
}
/**
* searches InfoLog for a certain pattern in $query
*
* @param string $query[order] column-name to sort after
* @param string $query[sort] sort-order DESC or ASC
* @param string $query[filter] string with combination of acl-, date- and status-filters, eg. 'own-open-today' or ''
* @param int $query[cat_id] category to use or 0 or unset
* @param string $query[search] pattern to search, search is done in info_from, info_subject and info_des
* @param string $query[action] / $query[action_id] if only entries linked to a specified app/entry show be used
* @param int &$query[start], &$query[total] nextmatch-parameters will be used and set if query returns less entries
* @param array $query[col_filter] array with column-name - data pairs, data == '' means no filter (!)
* @param boolean $query[subs] return subs or not, if unset the user preference is used
* @param int $query[num_rows] number of rows to return if $query[start] is set, default is to use the value from the general prefs
* @param string|array $query[cols]=null what to query, if set the recordset / iterator get's returned
* @param string $query[append]=null get's appended to sql query, eg. for GROUP BY
* @param boolean $query['custom_fields']=false query custom-fields too, default not
* @param boolean $no_acl =false true: ignore all acl
* @return array|iterator with id's as key of the matching log-entries or recordset/iterator if cols is set
*/
function search(&$query, $no_acl=false)
{
//error_log(__METHOD__.'('.array2string($query).')');
$action2app = array(
'addr' => 'addressbook',
'proj' => 'projects',
'event' => 'calendar'
);
// query children independent of action
if (empty($query['col_filter']['info_id_parent']))
{
$action = isset($action2app[$query['action']??null]) ? $action2app[$query['action']] : ($query['action'] ?? null);
if ($action)
{
$links = Link\Storage::get_links($action=='sp'?'infolog':$action,
is_array($query['action_id']) ? $query['action_id'] : explode(',',$query['action_id']),'infolog','',$query['col_filter']['info_status'] =='deleted');
if (count($links))
{
$links = call_user_func_array('array_merge',$links); // flatten the array
$link_extra = ($action == 'sp' ? 'OR' : 'AND')." main.info_id IN (".implode(',',$links).')';
}
}
}
$sortbycf='';
if (!empty($query['order']) && preg_match('/^#?[a-z_0-9, ]+$/i',$query['order']) &&
(empty($query['sort']) || is_string($query['sort']) && preg_match('/^(DESC|ASC)$/i',$query['sort'])))
{
$order = array();
foreach(explode(',',$query['order']) as $val)
{
$val = trim($val);
if ($val[0] == '#')
{
$sortbycf = substr($val,1);
$val = "cfsortcrit IS NULL,cfsortcrit";
}
else
{
static $table_def = null;
if (is_null($table_def)) $table_def = $this->db->get_table_definitions('infolog',$this->info_table);
if (substr($val,0,5) != 'info_' && isset($table_def['fd']['info_'.$val])) $val = 'info_'.$val;
if ($val == 'info_des' && $this->db->capabilities['order_on_text'] !== true)
{
if (!$this->db->capabilities['order_on_text']) continue;
$val = sprintf($this->db->capabilities['order_on_text'],$val);
}
}
$order[] = $val;
}
$ordermethod = 'ORDER BY ' . implode(',',$order) . ' ' . $query['sort'];
}
else
{
$ordermethod = 'ORDER BY info_datemodified DESC'; // newest first
}
$filtermethod = $no_acl ? '1=1' : $this->aclFilter($query['filter']);
if (empty($query['col_filter']['info_status'])) $filtermethod .= $this->statusFilter($query['filter']);
$filtermethod .= $this->dateFilter($query['filter']);
$cfcolfilter=0;
if (isset($query['col_filter']) && is_array($query['col_filter']))
{
foreach($query['col_filter'] as $col => $data)
{
if (is_int($col))
{
$filtermethod .= ' AND '.$data;
continue;
}
if ($col[0] != '#' && substr($col,0,5) != 'info_' && isset($table_def['fd']['info_'.$col])) $col = 'info_'.$col;
if ((!empty($data) || (string)$data !== '') && preg_match('/^[a-z_0-9]+$/i',$col))
{
switch ($col)
{
case 'info_responsible':
$data = (int) $data;
if (!$data) continue 2; // +1 for switch
$filtermethod .= ' AND ('.$this->responsible_filter($data)." OR $this->users_table.account_id IS NULL AND ".
$this->db->expression($this->info_table,array(
'info_owner' => $data > 0 ? $data : $GLOBALS['egw']->accounts->members($data,true)
)).')';
break;
case 'info_id': // info_id itself is ambigous
$filtermethod .= ' AND '.$this->db->expression($this->info_table,'main.',array('info_id' => $data));
break;
default:
$filtermethod .= ' AND '.$this->db->expression($this->info_table,array($col => $data));
break;
}
}
if ($col[0] == '#' && $query['custom_fields'] && $data)
{
$filtermethod .= " AND main.info_id IN (SELECT DISTINCT info_id FROM $this->extra_table WHERE ";
$custom_fields = Api\Storage\Customfields::get('infolog');
if($custom_fields[substr($col,1)]['type'] == 'select' && $custom_fields[substr($col,1)]['rows'] > 1)
{
// Multi-select - any entry with the filter value selected matches
$filtermethod .= $this->db->expression($this->extra_table, array(
'info_extra_name' => substr($col,1),
$this->db->concat("','",'info_extra_value',"','").' '.$this->db->capabilities[Api\Db::CAPABILITY_CASE_INSENSITIV_LIKE].' '.$this->db->quote('%,'.$data.',%'),
)).')';
}
else
{
$filtermethod .= $this->db->expression($this->extra_table,array(
'info_extra_name' => substr($col,1),
'info_extra_value' => $data,
)).')';
}
$cfcolfilter++;
}
}
}
//echo "<p>filtermethod='$filtermethod'</p>";
if (!empty($query['cat_id']) && (int)$query['cat_id'])
{
$categories = new Api\Categories('','infolog');
$cats = $categories->return_all_children((int)$query['cat_id']);
$filtermethod .= ' AND info_cat'.(count($cats)>1? ' IN ('.implode(',',$cats).') ' : '='.(int)$query['cat_id']);
}
$join = $distinct = '';
if (!empty($query['query'])) $query['search'] = $query['query']; // allow both names
if (!empty($query['search'])) // we search in _from, _subject, _des and _extra_value for $query
{
$columns = array('info_from','info_location','info_subject');
// at the moment MaxDB 7.5 cant cast nor search text columns, it's suppost to change in 7.6
if ($this->db->capabilities['like_on_text']) $columns[] = 'info_des';
$wildcard = '%'; $op = null;
$so_sql = new Api\Storage('infolog', $this->info_table, $this->extra_table, '', 'info_extra_name', 'info_extra_value', 'info_id', $this->db);
$so_sql->table_name = 'main';
$search = $so_sql->search2criteria($query['search'], $wildcard, $op, null, $columns);
$sql_query = 'AND ('.(is_numeric($query['search']) ? 'main.info_id='.(int)$query['search'].' OR ' : '').
implode($op, $search) .')';
}
$join .= " LEFT JOIN $this->users_table ON main.info_id=$this->users_table.info_id";
if (strpos($query['filter'], '+deleted') === false)
{
$join .= " AND $this->users_table.info_res_deleted IS NULL";
}
// do not return deleted attendees
$join .= " LEFT JOIN $this->users_table attendees ON main.info_id=attendees.info_id AND attendees.info_res_deleted IS NULL";
$group_by = ' GROUP BY main.info_id ';
// check if $query['append'] already contains a GROUP BY clause
if (!empty($query['append']) && stripos($query['append'], 'group by') !== false)
{
$query['append'] .= ',main.info_id ';
}
else
{
$query['append'] = $group_by;
}
$pid = 'AND ' . $this->db->expression($this->info_table,array('info_id_parent' => ($action == 'sp' ?$query['action_id'] : 0)));
if ($GLOBALS['egw_info']['user']['preferences']['infolog']['listNoSubs'] != '1' && $action != 'sp' ||
($query['col_filter']['info_id_parent']??'') !== '' ||
isset($query['subs']) && $query['subs'] || $action != 'sp' && !empty($query['search']))
{
$pid = '';
}
$ids = array( );
if ($action == '' || $action == 'sp' || count($links))
{
$sql_query = "FROM $this->info_table main $join WHERE ($filtermethod $pid ".($sql_query ?? '').') '.($link_extra??'');
#error_log("infolog.so.search:\n" . print_r($sql_query, true));
if ($this->db->Type == 'mysql' && (float)$this->db->ServerInfo['version'] >= 4.0)
{
$mysql_calc_rows = 'SQL_CALC_FOUND_ROWS ';
unset($query['total']);
}
else
{
$query['total'] = $this->db->query($sql="SELECT $distinct main.info_id ".$sql_query.$group_by,__LINE__,__FILE__)->NumRows();
}
$info_customfield = '';
if ($sortbycf != '')
{
$sort_col = "(SELECT DISTINCT info_extra_value FROM $this->extra_table sub2 WHERE sub2.info_id=main.info_id AND info_extra_name=".$this->db->quote($sortbycf).")";
if (!isset($custom_fields)) $custom_fields = Api\Storage\Customfields::get('infolog');
switch($custom_fields[$sortbycf]['type'])
{
case 'int':
$sort_col = $this->db->to_int($sort_col);
break;
case 'float':
$sort_col = $this->db->to_double($sort_col);
break;
}
$info_customfield = ", $sort_col AS cfsortcrit ";
}
//echo "SELECT $distinct main.* $info_customfield $sql_query $ordermethod"."<br>";
do
{
if (isset($query['start']) && isset($query['total']) && $query['start'] > $query['total'])
{
$query['start'] = 0;
}
$cols = isset($query['cols']) ? $query['cols'] : 'main.*';
if (is_array($cols)) $cols = implode(',',$cols);
$cols .= ','.$this->db->group_concat('attendees.account_id').' AS info_responsible';
$cols .= ','.$this->db->group_concat('attendees.info_res_attendee').' AS info_cc';
$rs = $this->db->query($sql='SELECT '.$mysql_calc_rows.' '.$distinct.' '.$cols.' '.$info_customfield.' '.$sql_query.
$query['append'].$ordermethod,__LINE__,__FILE__,
(int)($query['start']??0),isset($query['start']) ? (int) $query['num_rows'] : -1,false,Api\Db::FETCH_ASSOC);
//echo "<p>db::query('$sql',,,".(int)$query['start'].','.(isset($query['start']) ? (int) $query['num_rows'] : -1).")</p>\n";
if ($mysql_calc_rows)
{
$query['total'] = $this->db->Link_ID->GetOne('SELECT FOUND_ROWS()');
}
}
// check if start is behind total --> loop to set start=0
while (isset($query['start']) && $query['start'] > $query['total']);
if (isset($query['cols']))
{
return $rs;
}
foreach($rs as $info)
{
$info['info_responsible'] = $info['info_responsible'] ? array_unique(explode(',',$info['info_responsible'])) : array();
foreach($info['info_responsible'] as $k => $v)
{
if (!is_numeric($v)) unset($info['info_responsible'][$k]);
}
$info['info_responsible'] = array_values($info['info_responsible']);
$ids[$info['info_id']] = $info;
}
static $index_load_cfs = null;
if (is_null($index_load_cfs) && !empty($query['col_filter']['info_type']))
{
$config_data = Api\Config::read('infolog');
$index_load_cfs = $config_data['index_load_cfs'] ?? [];
if (!is_array($index_load_cfs)) $index_load_cfs = explode(',', $index_load_cfs);
}
// if no specific custom field is selected, show/query all custom fields
if ($ids && (!empty($query['custom_fields']) || !empty($query['csv_export']) ||
$index_load_cfs && !empty($query['col_filter']['info_type']) && in_array($query['col_filter']['info_type'],$index_load_cfs)))
{
$where = array('info_id' => array_keys($ids));
if (!($query['csv_export'] || strchr(is_array($query['selectcols']) ? implode(',',$query['selectcols']):$query['selectcols'],'#') === false ||
$index_load_cfs && $query['col_filter']['info_type'] && in_array($query['col_filter']['info_type'],$index_load_cfs)))
{
$where['info_extra_name'] = array();
foreach(is_array($query['selectcols']) ? $query['selectcols'] : explode(',',$query['selectcols']) as $col)
{
if ($col[0] == '#') $where['info_extra_name'][] = substr($col,1);
}
}
foreach($this->db->select($this->extra_table,'*',$where,__LINE__,__FILE__) as $row)
{
$ids[$row['info_id']]['#'.$row['info_extra_name']] = $row['info_extra_value'];
}
}
}
else
{
$query['start'] = $query['total'] = 0;
}
return $ids;
}
/**
* Query infolog for users with open entries, either own or responsible, with start or end within 4 days
*
* This functions tries to minimize the users really checked with the complete filters, as creating a
* user enviroment and running the specific check costs ...
*
* @return array with acount_id's groups get resolved to there memebers
*/
function users_with_open_entries()
{
$users = array();
foreach($this->db->select($this->info_table,'DISTINCT info_owner',array(
str_replace(' AND ','',$this->statusFilter('open')),
'(ABS(info_startdate-'.time().')<'.(4*24*60*60).' OR '. // start_day within 4 days
'ABS(info_enddate-'.time().')<'.(4*24*60*60).')', // end_day within 4 days
),__LINE__,__FILE__) as $row)
{
$users[] = $row['info_owner'];
}
foreach($this->db->select($this->info_table, "DISTINCT $this->users_table.account_id AS account_id",
$this->statusFilter('open',false), __LINE__, __FILE__, false, '', 'infolog', 0,
"JOIN $this->users_table ON $this->info_table.info_id=$this->users_table.info_id AND info_res_deleted IS NULL") as $row)
{
$responsible = $row['account_id'];
if ($GLOBALS['egw']->accounts->get_type($responsible) == 'g')
{
$responsible = $GLOBALS['egw']->accounts->members($responsible,true);
}
if ($responsible)
{
foreach((array)$responsible as $user)
{
if ($user && !in_array($user,$users)) $users[] = $user;
}
}
}
return $users;
}
}