extern/egroupware_official
1
0
Fork 0
mirror of https://github.com/EGroupware/egroupware.git synced 2024-11-28 19:03:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

moving so_sql* to Api\Storage

Browse Source
This commit is contained in:
Ralf Becker 2016-03-06 09:05:20 +00:00
parent 29c7d2d1f8
commit fcca19cfcf
7 changed files with 2653 additions and 2546 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

744
api/src/Storage.php Normal file
View File

@ -0,0 +1,744 @@
<?php
/**
* EGroupware generalized SQL Storage Object with build in custom field support
*
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @package api
* @subpackage storage
* @link http://www.egroupware.org
* @author Ralf Becker <RalfBecker@outdoor-training.de>
* @copyright 2009-16 by RalfBecker@outdoor-training.de
* @version $Id$
*/
namespace EGroupware\Api;
/**
* Generalized SQL Storage Object with build in custom field support
*
* This class allows to display, search, order and filter by custom fields simply by replacing Storage\Base
* by it and adding custom field widgets to the eTemplates of an applications.
* It's inspired by the code from Klaus Leithoff, which does the same thing limited to addressbook.
*
* The schema of the custom fields table should be like (the lenght of the cf name is nowhere enfored and
* varies throughout eGW from 40-255, the value column from varchar(255) to longtext!):
*
* 'egw_app_extra' => array(
* 'fd' => array(
* 'prefix_id' => array('type' => 'int','precision' => '4','nullable' => False),
* 'prefix_name' => array('type' => 'string','precision' => '64','nullable' => False),
* 'prefix_value' => array('type' => 'text'),
* ),
* 'pk' => array('prefix_id','prefix_name'),
* 'fk' => array(),
* 'ix' => array(),
* 'uc' => array()
* )
*
* @package etemplate
* @subpackage api
* @author RalfBecker-AT-outdoor-training.de
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
*/
class Storage extends Storage\Base
{
/**
* Prefix used by the class
*/
const CF_PREFIX = '#';
/**
* name of customefields table
*
* @var string
*/
var $extra_table;
/**
* name of id column, defaults to the regular tables auto id
*
* @var string
*/
var $extra_id = '_id';
/**
* Name of key (cf name) column or just a postfix added to the table prefix
*
* @var string
*/
var $extra_key = '_name';
/**
* Name of value column or just a postfix added to the table prefix
*
* @var string
*/
var $extra_value = '_value';
var $extra_join;
var $extra_join_order;
var $extra_join_filter;
/**
* Does extra table has a unique index (over id and name)
*
* @var boolean
*/
var $extra_has_unique_index;
/**
* Custom fields of $app, read by the constructor
*
* @var array
*/
var $customfields;
/**
* Do we allow AND store multiple values for a cf (1:N) relations
*
* @var boolean
*/
var $allow_multiple_values = false;
/**
* constructor of the class
*
* Please note the different params compared to Storage\Base!
*
* @param string $app application name to load table schemas
* @param string $table name of the table to use
* @param string $extra_table name of the custom field table
* @param string $column_prefix ='' column prefix to automatic remove from the column-name, if the column name starts with it
* @param string $extra_key ='_name' column name for cf name column (will be prefixed with colum prefix, if starting with _)
* @param string $extra_value ='_value' column name for cf value column (will be prefixed with colum prefix, if starting with _)
* @param string $extra_id ='_id' column name for cf id column (will be prefixed with colum prefix, if starting with _)
* @param Db $db =null database object, if not the one in $GLOBALS['egw']->db should be used, eg. for an other database
* @param boolean $no_clone =true can we avoid to clone the db-object, default yes (different from Storage\Base!)
* new code using appnames and foreach(select(...,$app) can set it to avoid an extra instance of the db object
* @param boolean $allow_multiple_values =false should we allow AND store multiple values (1:N relations)
* @param string $timestamp_type =null default null=leave them as is, 'ts'|'integer' use integer unix timestamps, 'object' use DateTime objects
*/
function __construct($app,$table,$extra_table,$column_prefix='',
$extra_key='_name',$extra_value='_value',$extra_id='_id',
Db $db=null,$no_clone=true,$allow_multiple_values=false,$timestamp_type=null)
{
// calling the Storage\Base constructor
parent::__construct($app,$table,$db,$column_prefix,$no_clone,$timestamp_type);
$this->allow_multiple_values = $allow_multiple_values;
$this->extra_table = $extra_table;
if (!$this->extra_id) $this->extra_id = $this->autoinc_id; // default to auto id of regular table
// if names from columns of extra table are only postfixes (starting with _), prepend column prefix
if (!($prefix=$column_prefix))
{
list($prefix) = explode('_',$this->autoinc_id);
}
elseif(substr($prefix,-1) == '_')
{
$prefix = substr($prefix,0,-1); // remove trailing underscore from column prefix parameter
}
foreach(array(
'extra_id' => $extra_id,
'extra_key' => $extra_key,
'extra_value' => $extra_value
) as $col => $val)
{
$this->$col = $col_name = $val;
if ($col_name[0] == '_') $this->$col = $prefix . $val;
}
// some sanity checks, maybe they should be active only for development
if (!($extra_defs = $this->db->get_table_definitions($app,$extra_table)))
{
throw new Exception\WrongParameter("extra table $extra_table is NOT defined!");
}
foreach(array('extra_id','extra_key','extra_value') as $col)
{
if (!$this->$col || !isset($extra_defs['fd'][$this->$col]))
{
throw new Exception\WrongParameter("$col column $extra_table.{$this->$col} is NOT defined!");
}
}
// check if our extra table has a unique index (if not we have to delete the old values, as replacing does not work!)
$this->extra_has_unique_index = $extra_defs['pk'] || $extra_defs['uc'];
// setting up our extra joins, now we know table and column names
$this->extra_join = " LEFT JOIN $extra_table ON $table.$this->autoinc_id=$extra_table.$this->extra_id";
$this->extra_join_order = " LEFT JOIN $extra_table extra_order ON $table.$this->autoinc_id=extra_order.$this->extra_id";
$this->extra_join_filter = " JOIN $extra_table extra_filter ON $table.$this->autoinc_id=extra_filter.$this->extra_id";
$this->customfields = Customfields::get($app, false, null, $db);
}
/**
* Read all customfields of the given id's
*
* @param int|array $ids one ore more id's
* @param array $field_names =null custom fields to read, default all
* @return array id => $this->cf_field(name) => value
*/
function read_customfields($ids,$field_names=null)
{
if (is_null($field_names)) $field_names = array_keys($this->customfields);
foreach((array)$ids as $key => $id)
{
if (!(int)$id && is_array($ids)) unset($ids[$key]);
}
if (!$ids || !$field_names) return array(); // nothing to do
$entries = array();
foreach($this->db->select($this->extra_table,'*',array(
$this->extra_id => $ids,
$this->extra_key => $field_names,
),__LINE__,__FILE__,false,'',$this->app) as $row)
{
$entry =& $entries[$row[$this->extra_id]];
if (!is_array($entry)) $entry = array();
$field = $this->get_cf_field($row[$this->extra_key]);
if ($this->allow_multiple_values && $this->is_multiple($row[$this->extra_key]))
{
$entry[$field][] = $row[$this->extra_value];
}
else
{
$entry[$field] = $row[$this->extra_value];
}
}
return $entries;
}
/**
* saves custom field data
*
* @param array $data data to save (cf's have to be prefixed with self::CF_PREFIX = #)
* @param array $extra_cols =array() extra-data to be saved
* @return bool false on success, errornumber on failure
*/
function save_customfields($data, array $extra_cols=array())
{
foreach (array_keys((array)$this->customfields) as $name)
{
if (!isset($data[$field = $this->get_cf_field($name)])) continue;
$where = array(
$this->extra_id => isset($data[$this->autoinc_id]) ? $data[$this->autoinc_id] : $data[$this->db_key_cols[$this->autoinc_id]],
$this->extra_key => $name,
);
$is_multiple = $this->is_multiple($name);
// we explicitly need to delete fields, if value is empty or field allows multiple values or we have no unique index
if(empty($data[$field]) || $is_multiple || !$this->extra_has_unique_index)
{
$this->db->delete($this->extra_table,$where,__LINE__,__FILE__,$this->app);
if (empty($data[$field])) continue; // nothing else to do for empty values
}
foreach($is_multiple && !is_array($data[$field]) ? explode(',',$data[$field]) :
// regular custom fields (!$is_multiple) eg. addressbook store multiple values comma-separated
(array)(!$is_multiple && is_array($data[$field]) ? implode(',', $data[$field]) : $data[$field]) as $value)
{
if (!$this->db->insert($this->extra_table,array($this->extra_value => $value)+$extra_cols,$where,__LINE__,__FILE__,$this->app))
{
return $this->db->Errno;
}
}
}
return false; // no error
}
/**
* merges in new values from the given new data-array
*
* reimplemented to also merge the customfields
*
* @param $new array in form col => new_value with values to set
*/
function data_merge($new)
{
parent::data_merge($new);
if ($this->customfields)
{
foreach(array_keys($this->customfields) as $name)
{
if (isset($new[$field = $this->get_cf_field($name)]))
{
$this->data[$field] = $new[$field];
}
}
}
}
/**
* reads row matched by key and puts all cols in the data array
*
* reimplented to also read the custom fields
*
* @param array $keys array with keys in form internalName => value, may be a scalar value if only one key
* @param string|array $extra_cols string or array of strings to be added to the SELECT, eg. "count(*) as num"
* @param string $join sql to do a join, added as is after the table-name, eg. ", table2 WHERE x=y" or
* @return array|boolean data if row could be retrived else False
*/
function read($keys,$extra_cols='',$join='')
{
if (!parent::read($keys,$extra_cols,$join))
{
return false;
}
if (($id = (int)$this->data[$this->db_key_cols[$this->autoinc_id]]) && $this->customfields &&
($cfs = $this->read_customfields($id)))
{
$this->data = array_merge($this->data,$cfs[$id]);
}
return $this->data;
}
/**
* saves the content of data to the db
*
* reimplented to also save the custom fields
*
* @param array $keys if given $keys are copied to data before saveing => allows a save as
* @param string|array $extra_where =null extra where clause, eg. to check an etag, returns true if no affected rows!
* @return int|boolean 0 on success, or errno != 0 on error, or true if $extra_where is given and no rows affected
*/
function save($keys=null,$extra_where=null)
{
if (is_array($keys) && count($keys) && !isset($keys[0])) // allow to use an etag, eg array('etag=etag+1')
{
$this->data_merge($keys);
$keys = null;
}
$ret = parent::save($keys,$extra_where);
if ($ret == 0 && $this->customfields)
{
$this->save_customfields($this->data);
}
return $ret;
}
/**
* deletes row representing keys in internal data or the supplied $keys if != null
*
* reimplented to also delete the custom fields
*
* @param array|int $keys =null if given array with col => value pairs to characterise the rows to delete, or integer autoinc id
* @param boolean $only_return_ids =false return $ids of delete call to db object, but not run it (can be used by extending classes!)
* @return int|array affected rows, should be 1 if ok, 0 if an error or array with id's if $only_return_ids
*/
function delete($keys=null,$only_return_ids=false)
{
if ($this->customfields || $only_return_ids)
{
$query = parent::delete($keys,true);
// check if query contains more then the id's
if (!isset($query[$this->autoinc_id]) || count($query) != 1)
{
foreach($this->db->select($this->table_name,$this->autoinc_id,$query,__LINE__,__FILE__,false,'',$this->app) as $row)
{
$ids[] = $row[$this->autoinc_id];
}
if (!$ids) return 0; // no rows affected
}
else
{
$ids = (array)$query[$this->autoinc_id];
}
if ($only_return_ids) return $ids;
$this->db->delete($this->extra_table,array($this->extra_id => $ids),__LINE__,__FILE__);
}
return parent::delete($keys);
}
/**
* query rows for the nextmatch widget
*
* Reimplemented to also read the custom fields (if enabled via $query['selectcols']).
*
* Please note: the name of the nextmatch-customfields has to be 'customfields'!
*
* @param array $query with keys 'start', 'search', 'order', 'sort', 'col_filter'
* For other keys like 'filter', 'cat_id' you have to reimplement this method in a derived class.
* @param array &$rows returned rows/competitions
* @param array &$readonlys eg. to disable buttons based on acl, not use here, maybe in a derived class
* @param string $join ='' sql to do a join, added as is after the table-name, eg. ", table2 WHERE x=y" or
* "LEFT JOIN table2 ON (x=y)", Note: there's no quoting done on $join!
* @param boolean $need_full_no_count =false If true an unlimited query is run to determine the total number of rows, default false
* @param mixed $only_keys =false, see search
* @param string|array $extra_cols =array()
* @return int total number of rows
*/
function get_rows($query,&$rows,&$readonlys,$join='',$need_full_no_count=false,$only_keys=false,$extra_cols=array())
{
parent::get_rows($query,$rows,$readonlys,$join,$need_full_no_count,$only_keys,$extra_cols);
$selectcols = $query['selectcols'] ? explode(',',$query['selectcols']) : array();
if ($rows && $this->customfields && (!$selectcols || in_array('customfields',$selectcols)))
{
$id2keys = array();
foreach($rows as $key => $row)
{
$id2keys[$row[$this->db_key_cols[$this->autoinc_id]]] = $key;
}
// check if only certain cf's to show
if (!in_array('customfields', $selectcols))
{
foreach($selectcols as $col)
{
if ($this->is_cf($col)) $fields[] = $this->get_cf_name($col);
}
}
if (($cfs = $this->read_customfields(array_keys($id2keys),$fields)))
{
foreach($cfs as $id => $data)
{
$rows[$id2keys[$id]] = array_merge($rows[$id2keys[$id]],$data);
}
}
}
return $this->total;
}
/**
* searches db for rows matching searchcriteria
*
* Reimplemented to search, order and filter by custom fields
*
* @param array|string $criteria array of key and data cols, OR string with search pattern (incl. * or ? as wildcards)
* @param boolean|string/array $only_keys =true True returns only keys, False returns all cols. or
* comma seperated list or array of columns to return
* @param string $order_by ='' fieldnames + {ASC|DESC} separated by colons ',', can also contain a GROUP BY (if it contains ORDER BY)
* @param string|array $extra_cols ='' string or array of strings to be added to the SELECT, eg. "count(*) as num"
* @param string $wildcard ='' appended befor and after each criteria
* @param boolean $empty =false False=empty criteria are ignored in query, True=empty have to be empty in row
* @param string $op ='AND' defaults to 'AND', can be set to 'OR' too, then criteria's are OR'ed together
* @param mixed $start =false if != false, return only maxmatch rows begining with start, or array($start,$num), or 'UNION' for a part of a union query
* @param array $filter =null if set (!=null) col-data pairs, to be and-ed (!) into the query without wildcards
* @param string $join ='' sql to do a join, added as is after the table-name, eg. "JOIN table2 ON x=y" or
* "LEFT JOIN table2 ON (x=y AND z=o)", Note: there's no quoting done on $join, you are responsible for it!!!
* @param boolean $need_full_no_count =false If true an unlimited query is run to determine the total number of rows, default false
* @return array|NULL array of matching rows (the row is an array of the cols) or NULL
*/
function &search($criteria,$only_keys=True,$order_by='',$extra_cols='',$wildcard='',$empty=False,$op='AND',$start=false,$filter=null,$join='',$need_full_no_count=false)
{
//error_log(__METHOD__.'('.array2string(array_combine(array_slice(array('criteria','only_keys','order_by','extra_cols','wildcard','empty','op','start','filter','join','need_full_no_count'), 0, count(func_get_args())), func_get_args())).')');
if (!$this->customfields)
{
return parent::search($criteria,$only_keys,$order_by,$extra_cols,$wildcard,$empty,$op,$start,$filter,$join,$need_full_no_count);
}
if ($only_keys === false)
{
$only_keys = $this->table_name.'.*';
}
// if string given as criteria --> search in all (or $this->columns_to_search) columns including custom fields
if ($criteria && is_string($criteria))
{
$criteria = $this->search2criteria($criteria,$wildcard,$op);
}
if ($criteria && is_array($criteria))
{
// check if we search in the custom fields
if (isset($criteria[$this->extra_value]))
{
if (($negate = $criteria[$this->extra_value][0] === '!'))
{
$criteria[$this->extra_value] = substr($criteria[$this->extra_value],1);
}
$criteria[] = $this->extra_table.'.'.$this->extra_value . ' ' .($negate ? 'NOT ' : '').
$this->db->capabilities[Db::CAPABILITY_CASE_INSENSITIV_LIKE]. ' ' .
$this->db->quote($wildcard.$criteria[$this->extra_value].$wildcard);
unset($criteria[$this->extra_value]);
}
// replace ambiguous auto-id with (an exact match of) table_name.autoid
if (isset($criteria[$this->autoinc_id]))
{
if ($criteria[$this->autoinc_id])
{
$criteria[] = $this->db->expression($this->table_name,$this->table_name.'.',
array($this->autoinc_id => $criteria[$this->autoinc_id]));
}
unset($criteria[$this->autoinc_id]);
}
// replace ambiguous column with (an exact match of) table_name.column
$extra_join_added = $join && strpos($join, $this->extra_join) !== false;
foreach($criteria as $name => $val)
{
// only add extra_join, if we really need it
if (!$extra_join_added && (
is_int($name) && strpos($val, $this->extra_value) !== false ||
is_string($name) && $this->is_cf($name)
))
{
$join .= $this->extra_join;
$extra_join_added = true;
}
$extra_columns = $this->db->get_table_definitions($this->app, $this->extra_table);
if(is_string($name) && $extra_columns['fd'][array_search($name, $this->db_cols)])
{
$criteria[] = $this->db->expression($this->table_name,$this->table_name.'.',array(
array_search($name, $this->db_cols) => $val,
));
unset($criteria[$name]);
}
elseif (is_string($name) && $this->is_cf($name))
{
if ($op != 'AND')
{
$name = substr($name, 1);
if (($negate = $criteria[$name][0] === '!'))
{
$val = substr($val,1);
}
$cfcriteria[] = '(' . $this->extra_table.'.'.$this->extra_value . ' ' .($negate ? 'NOT ' : '').
$this->db->capabilities[Db::CAPABILITY_CASE_INSENSITIV_LIKE]. ' ' .
$this->db->quote($wildcard.$val.$wildcard) . ' AND ' .
$this->extra_table.'.'.$this->extra_key . ' = ' . $this->db->quote($name) .
')';
unset($criteria[self::CF_PREFIX.$name]);
}
else
{
// criteria operator is AND we remap the criteria to be transformed to filters
$filter[$name] = $val;
unset($criteria[$name]);
}
}
}
if ($cfcriteria && $op =='OR') $criteria[] = implode(' OR ',$cfcriteria);
}
if($only_keys === true)
{
// Expand to keys here, so table_name can be prepended below
$only_keys = array_values($this->db_key_cols);
}
// replace ambiguous column with (an exact match of) table_name.column
if(is_array($only_keys))
{
foreach($only_keys as $key => &$col)
{
if(is_numeric($key) && in_array($col, $this->db_cols, true))
{
$col = $this->table_name .'.'.array_search($col, $this->db_cols).' AS '.$col;
}
}
}
// check if we order by a custom field --> join cf table for given cf and order by it's value
if (strpos($order_by,self::CF_PREFIX) !== false)
{
// fields to order by, as cutomfields may have names with spaces, we examine each order by criteria
$fields2order = explode(',',$order_by);
foreach($fields2order as $v)
{
if (strpos($v,self::CF_PREFIX) !== false)
{
// we found a customfield, so we split that part by space char in order to get Sorting Direction and Fieldname
$buff = explode(' ',trim($v));
$orderDir = array_pop($buff);
$key = substr(trim(implode(' ',$buff)), 1);
switch($this->customfields[$key]['type'])
{
case 'int':
$order_by = str_replace($v, 'extra_order.'.$this->extra_value.' IS NULL,'.
$this->db->to_int('extra_order.'.$this->extra_value).' '.$orderDir, $order_by);
break;
case 'float':
$order_by = str_replace($v, 'extra_order.'.$this->extra_value.' IS NULL,'.
$this->db->to_double('extra_order.'.$this->extra_value).' '.$orderDir, $order_by);
break;
default:
$order_by = str_replace($v, 'extra_order.'.$this->extra_value.' IS NULL,extra_order.'.
$this->extra_value.' '.$orderDir, $order_by);
}
// postgres requires that expressions in order by appear in the columns of a distinct select
if ($this->db->Type != 'mysql')
{
if (!is_array($extra_cols))
{
$extra_cols = $extra_cols ? explode(',', $extra_cols) : array();
}
$extra_cols[] = 'extra_order.'.$this->extra_value;
$extra_cols[] = 'extra_order.'.$this->extra_value.' IS NULL';
}
$join .= $this->extra_join_order.' AND extra_order.'.$this->extra_key.'='.$this->db->quote($key);
}
}
}
// check if we filter by a custom field
if (is_array($filter))
{
$_cfnames = array_keys($this->customfields);
$extra_filter = null;
foreach($filter as $name => $val)
{
// replace ambiguous auto-id with (an exact match of) table_name.autoid
if (is_string($name) && $name == $this->autoinc_id)
{
if ((int)$filter[$this->autoinc_id])
{
$filter[] = $this->db->expression($this->table_name,$this->table_name.'.',array(
$this->autoinc_id => $filter[$this->autoinc_id],
));
}
unset($filter[$this->autoinc_id]);
}
// replace ambiguous column with (an exact match of) table_name.column
elseif (is_string($name) && $val!=null && in_array($name, $this->db_cols))
{
$extra_columns = $this->db->get_table_definitions($this->app, $this->extra_table);
if ($extra_columns['fd'][array_search($name, $this->db_cols)])
{
$filter[] = $this->db->expression($this->table_name,$this->table_name.'.',array(
array_search($name, $this->db_cols) => $val,
));
unset($filter[$name]);
}
}
elseif (is_string($name) && $this->is_cf($name))
{
if (!empty($val)) // empty -> dont filter
{
if ($val[0] === '!') // negative filter
{
$sql_filter = 'extra_filter.'.$this->extra_value.'!='.$this->db->quote(substr($val,1));
}
else // using Db::expression to allow to use array() with possible values or NULL
{
if($this->customfields[$this->get_cf_name($name)]['type'] == 'select' &&
$this->customfields[$this->get_cf_name($name)]['rows'] > 1)
{
// Multi-select - any entry with the filter value selected matches
$sql_filter = str_replace($this->extra_value,'extra_filter.'.
$this->extra_value,$this->db->expression($this->extra_table,array(
$this->db->concat("','",$this->extra_value,"','").' '.$this->db->capabilities[Db::CAPABILITY_CASE_INSENSITIV_LIKE].' '.$this->db->quote('%,'.$val.',%')
))
);
}
elseif ($this->customfields[$this->get_cf_name($name)]['type'] == 'text')
{
$sql_filter = str_replace($this->extra_value,'extra_filter.'.$this->extra_value,
$this->db->expression($this->extra_table,array(
$this->extra_value.' '.$this->db->capabilities[Db::CAPABILITY_CASE_INSENSITIV_LIKE].' '.$this->db->quote($wildcard.$val.$wildcard)
))
);
}
else
{
$sql_filter = str_replace($this->extra_value,'extra_filter.'.
$this->extra_value,$this->db->expression($this->extra_table,array($this->extra_value => $val)));
}
}
// need to use a LEFT JOIN for negative search or to allow NULL values
$need_left_join = $val[0] === '!' || strpos($sql_filter,'IS NULL') !== false ? ' LEFT ' : '';
$join .= str_replace('extra_filter','extra_filter'.$extra_filter,$need_left_join.$this->extra_join_filter.
' AND extra_filter.'.$this->extra_key.'='.$this->db->quote($this->get_cf_name($name)).
' AND '.$sql_filter);
++$extra_filter;
}
unset($filter[$name]);
}
elseif(is_int($name) && $this->is_cf($val)) // lettersearch: #cfname LIKE 's%'
{
$_cf = explode(' ',$val);
foreach($_cf as $cf_np)
{
// building cf_name by glueing parts together (, in case someone used whitespace in their custom field names)
$tcf_name = ($tcf_name?$tcf_name.' ':'').$cf_np;
// reacts on the first one found that matches an existing customfield, should be better then the old behavior of
// simply splitting by " " and using the first part
if ($this->is_cf($tcf_name) && ($cfn = $this->get_cf_name($tcf_name)) && array_search($cfn,(array)$_cfnames,true)!==false )
{
$cf = $tcf_name;
break;
}
}
$join .= str_replace('extra_filter','extra_filter'.$extra_filter,$this->extra_join_filter.
' AND extra_filter.'.$this->extra_key.'='.$this->db->quote($this->get_cf_name($cf)).
' AND '.str_replace($cf,'extra_filter.'.$this->extra_value,$val));
++$extra_filter;
unset($filter[$name]);
}
}
}
// add DISTINCT as by joining custom fields for search a row can be returned multiple times
if ($join && strpos($join, $this->extra_join) !== false)
{
if (is_array($only_keys))
{
$only_keys = array_values($only_keys);
$only_keys[0] = 'DISTINCT '.($only_keys[0] != $this->autoinc_id ? $only_keys[0] :
$this->table_name.'.'.$this->autoinc_id.' AS '.$this->autoinc_id);
}
else
{
$only_keys = 'DISTINCT '.$only_keys;
}
}
return parent::search($criteria,$only_keys,$order_by,$extra_cols,$wildcard,$empty,$op,$start,$filter,$join,$need_full_no_count);
}
/**
* Get a default list of columns to search
*
* Reimplemented to search custom fields by default.
*
* @return array of column names
*/
protected function get_default_search_columns()
{
$cols = parent::get_default_search_columns();
if ($this->customfields && !isset($this->columns_to_search))
{
$cols[] = $this->extra_table.'.'.$this->extra_value;
}
//error_log(__METHOD__."() this->columns_to_search=".array2string($this->columns_to_search).' returning '.array2string($cols));
return $cols;
}
/**
* Function to test if $field is a custom field: check for the prefix
*
* @param string $field
* @return boolean true if $name is a custom field, false otherwise
*/
function is_cf($field)
{
return $field[0] == self::CF_PREFIX;
}
/**
* Get name part from a custom field: remove the prefix
*
* @param string $field
* @return string name without prefix
*/
function get_cf_name($field)
{
return substr($field,1);
}
/**
* Get the field-name from the name of a custom field: prepend the prefix
*
* @param string $name
* @return string prefix-name
*/
function get_cf_field($name)
{
return self::CF_PREFIX.$name;
}
/**
* Check if cf is stored as 1:N relation in DB and array in memory
*
* @param string $name
* @return string
*/
function is_multiple($name)
{
return $this->allow_multiple_values && in_array($this->customfields[$name]['type'],array('select','select-account')) &&
$this->customfields[$name]['rows'] > 1;
}
}

1646
api/src/Storage/Base.php Normal file
View File

File diff suppressed because it is too large Load Diff

114
api/src/Storage/Base2.php Normal file
View File

@ -0,0 +1,114 @@
<?php
/**
* EGroupware generalized SQL Storage Object Version 2
*
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @package api
* @subpackage storage
* @link http://www.egroupware.org
* @author Ralf Becker <RalfBecker@outdoor-training.de>
* @copyright 2007-16 by RalfBecker@outdoor-training.de
* @version $Id$
*/
namespace EGroupware\Api\Storage;
use EGroupware\Api;
/**
* generalized SQL Storage Object
*
* the class can be used in following ways:
* 1) by calling the constructor with an app and table-name or
* 2) by setting the following documented class-vars in a class derifed from this one
* Of cause can you derife the class and call the constructor with params.
*
* The Base2 class uses a privat $data array and __get and __set methods to set its data.
* Please note:
* You have to explicitly declare other object-properties of derived classes, which should NOT
* be handled by that mechanism!
*/
class Base2 extends Base
{
/**
* Private array containing all the object-data
*
* Colides with the original definition in Storage\Base and I dont want to change it there at the moment.
*
* @var array
*/
//private $data;
/**
* constructor of the class
*
* NEED to be called from the constructor of the derived class !!!
*
* @param string $app should be set if table-defs to be read from <app>/setup/tables_current.inc.php
* @param string $table should be set if table-defs to be read from <app>/setup/tables_current.inc.php
* @param Api\Db $db database object, if not the one in $GLOBALS['egw']->db should be used, eg. for an other database
* @param string $column_prefix ='' column prefix to automatic remove from the column-name, if the column name starts with it
* @param boolean $no_clone =false can we avoid to clone the db-object, default no
* new code using appnames and foreach(select(...,$app) can set it to avoid an extra instance of the db object
*
* @return so_sql2
*/
function __construct($app='',$table='',Api\Db $db=null,$column_prefix='',$no_clone=false)
{
parent::__construct($app,$table,$db,$column_prefix,$no_clone);
}
/**
* magic method to read a property from $this->data
*
* The special property 'id' always refers to the auto-increment id of the object, independent of its name.
*
* @param string $property
* @return mixed
*/
function __get($property)
{
switch($property)
{
case 'id':
$property = $this->autoinc_id;
break;
}
if (in_array($property,$this->db_cols) || in_array($property,$this->non_db_cols))
{
return $this->data[$property];
}
}
/**
* magic method to set a property in $this->data
*
* The special property 'id' always refers to the auto-increment id of the object, independent of its name.
*
* @param string $property
* @param mixed $value
*/
function __set($property,$value)
{
switch($property)
{
case 'id':
$property = $this->autoinc_id;
break;
}
if (in_array($property,$this->db_cols) || in_array($property,$this->non_db_cols))
{
$this->data[$property] = $value;
}
}
/**
* Return the whole object-data as array, it's a cast of the object to an array
*
* @return array
*/
function as_array()
{
return $this->data;
}
}

130
api/src/Storage/Db2DataIterator.php Normal file
View File

@ -0,0 +1,130 @@
<?php
/**
* EGroupware generalized SQL Storage Object: Iterator applying db2data method
*
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @package api
* @subpackage storage
* @link http://www.egroupware.org
* @author Ralf Becker <RalfBecker@outdoor-training.de>
* @copyright 2002-16 by RalfBecker@outdoor-training.de
* @version $Id$
*/
namespace EGroupware\Api\Storage;
/**
* Iterator applying a Storage's db2data method on each element retrived
*
*/
class Db2DataIterator implements \Iterator
{
/**
* Reference of Storage\Base class to use it's db2data method
*
* @var Base
*/
private $storage;
/**
* Instance of ADOdb record set to iterate
*
* @var \Traversible
*/
private $rs;
/**
* Total count of entries
*
* @var int
*/
public $total;
/**
* Constructor
*
* @param Base $storage
* @param \Traversable $rs
*/
public function __construct(Base $storage, \Traversable $rs=null)
{
$this->storage = $storage;
$this->total = $storage->total;
if (is_a($rs,'IteratorAggregate'))
{
$this->rs = $rs->getIterator();
}
else
{
$this->rs = $rs;
}
}
/**
* Return the current element
*
* @return array
*/
public function current()
{
if (is_a($this->rs,'iterator'))
{
$data = $this->rs->current();
return $this->storage->data2db($data);
}
return null;
}
/**
* Return the key of the current element
*
* @return int
*/
public function key()
{
if (is_a($this->rs,'iterator'))
{
return $this->rs->key();
}
return 0;
}
/**
* Move forward to next element (called after each foreach loop)
*/
public function next()
{
if (is_a($this->rs,'iterator'))
{
return $this->rs->next();
}
}
/**
* Rewind the Iterator to the first element (called at beginning of foreach loop)
*/
public function rewind()
{
if (is_a($this->rs,'iterator'))
{
return $this->rs->rewind();
}
}
/**
* Checks if current position is valid
*
* @return boolean
*/
public function valid ()
{
if (is_a($this->rs,'iterator'))
{
return $this->rs->valid();
}
return false;
}
}

1747
etemplate/inc/class.so_sql.inc.php
View File

File diff suppressed because it is too large Load Diff

106
etemplate/inc/class.so_sql2.inc.php
View File

@ -1,15 +1,17 @@
<?php <?php
/** /**
* eGroupWare generalized SQL Storage Object Version 2 - requires PHP5.1.2+!!! * EGroupware generalized SQL Storage Object Version 2
* *
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @package etemplate * @package etemplate
* @link http://www.egroupware.org * @link http://www.egroupware.org
* @author Ralf Becker <RalfBecker@outdoor-training.de> * @author Ralf Becker <RalfBecker@outdoor-training.de>
* @copyright 2007/8 by RalfBecker@outdoor-training.de * @copyright 2002-16 by RalfBecker@outdoor-training.de
* @version $Id$ * @version $Id$
*/ */
use EGroupware\Api;
/** /**
* generalized SQL Storage Object * generalized SQL Storage Object
* *
@ -23,102 +25,6 @@
* You have to explicitly declare other object-properties of derived classes, which should NOT * You have to explicitly declare other object-properties of derived classes, which should NOT
* be handled by that mechanism! * be handled by that mechanism!
* *
* @package etemplate * @deprecated use Api\Storage\Base
* @subpackage api
* @author RalfBecker-AT-outdoor-training.de
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
*/ */
class so_sql2 extends so_sql class so_sql2 extends Api\Storage\Base2 {}
{
/**
* Private array containing all the object-data
*
* Colides with the original definition in so_sql and I dont want to change it there at the moment.
*
* @var array
*/
//private $data;
/**
* constructor of the class
*
* NEED to be called from the constructor of the derived class !!!
*
* @param string $app should be set if table-defs to be read from <app>/setup/tables_current.inc.php
* @param string $table should be set if table-defs to be read from <app>/setup/tables_current.inc.php
* @param object/db $db database object, if not the one in $GLOBALS['egw']->db should be used, eg. for an other database
* @param string $colum_prefix='' column prefix to automatic remove from the column-name, if the column name starts with it
* @param boolean $no_clone=false can we avoid to clone the db-object, default no
* new code using appnames and foreach(select(...,$app) can set it to avoid an extra instance of the db object
*
* @return so_sql2
*/
function __construct($app='',$table='',$db=null,$column_prefix='',$no_clone=false)
{
parent::__construct($app,$table,$db,$column_prefix,$no_clone);
}
/**
* php4 constructor
*
* @deprecated use __construct
*/
function so_sql2($app='',$table='',$db=null,$column_prefix='',$no_clone=false)
{
self::__construct($app,$table,$db,$column_prefix,$no_clone);
}
/**
* magic method to read a property from $this->data
*
* The special property 'id' always refers to the auto-increment id of the object, independent of its name.
*
* @param string $property
* @return mixed
*/
function __get($property)
{
switch($property)
{
case 'id':
$property = $this->autoinc_id;
break;
}
if (in_array($property,$this->db_cols) || in_array($property,$this->non_db_cols))
{
return $this->data[$property];
}
}
/**
* magic method to set a property in $this->data
*
* The special property 'id' always refers to the auto-increment id of the object, independent of its name.
*
* @param string $property
* @param mixed $value
*/
function __set($property,$value)
{
switch($property)
{
case 'id':
$property = $this->autoinc_id;
break;
}
if (in_array($property,$this->db_cols) || in_array($property,$this->non_db_cols))
{
$this->data[$property] = $value;
}
}
/**
* Return the whole object-data as array, it's a cast of the object to an array
*
* @return array
*/
function as_array()
{
return $this->data;
}
}

712
etemplate/inc/class.so_sql_cf.inc.php
View File

@ -6,10 +6,12 @@
* @package etemplate * @package etemplate
* @link http://www.egroupware.org * @link http://www.egroupware.org
* @author Ralf Becker <RalfBecker@outdoor-training.de> * @author Ralf Becker <RalfBecker@outdoor-training.de>
* @copyright 2009-14 by RalfBecker@outdoor-training.de * @copyright 2009-16 by RalfBecker@outdoor-training.de
* @version $Id$ * @version $Id$
*/ */
use EGroupware\Api;
/** /**
* Generalized SQL Storage Object with build in custom field support * Generalized SQL Storage Object with build in custom field support
* *
@ -32,710 +34,6 @@
* 'uc' => array() * 'uc' => array()
* ) * )
* *
* @package etemplate * @deprecated use Api\Storage
* @subpackage api
* @author RalfBecker-AT-outdoor-training.de
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
*/ */
class so_sql_cf extends so_sql class so_sql_cf extends Api\Storage {}
{
/**
* Prefix used by the class
*/
const CF_PREFIX = '#';
/**
* name of customefields table
*
* @var string
*/
var $extra_table;
/**
* name of id column, defaults to the regular tables auto id
*
* @var string
*/
var $extra_id = '_id';
/**
* Name of key (cf name) column or just a postfix added to the table prefix
*
* @var string
*/
var $extra_key = '_name';
/**
* Name of value column or just a postfix added to the table prefix
*
* @var string
*/
var $extra_value = '_value';
var $extra_join;
var $extra_join_order;
var $extra_join_filter;
/**
* Does extra table has a unique index (over id and name)
*
* @var boolean
*/
var $extra_has_unique_index;
/**
* Custom fields of $app, read by the constructor
*
* @var array
*/
var $customfields;
/**
* Do we allow AND store multiple values for a cf (1:N) relations
*
* @var boolean
*/
var $allow_multiple_values = false;
/**
* constructor of the class
*
* Please note the different params compared to so_sql!
*
* @param string $app application name to load table schemas
* @param string $table name of the table to use
* @param string $extra_table name of the custom field table
* @param string $column_prefix ='' column prefix to automatic remove from the column-name, if the column name starts with it
* @param string $extra_key ='_name' column name for cf name column (will be prefixed with colum prefix, if starting with _)
* @param string $extra_value ='_value' column name for cf value column (will be prefixed with colum prefix, if starting with _)
* @param string $extra_id ='_id' column name for cf id column (will be prefixed with colum prefix, if starting with _)
* @param egw_db $db =null database object, if not the one in $GLOBALS['egw']->db should be used, eg. for an other database
* @param boolean $no_clone =true can we avoid to clone the db-object, default yes (different from so_sql!)
* new code using appnames and foreach(select(...,$app) can set it to avoid an extra instance of the db object
* @param boolean $allow_multiple_values =false should we allow AND store multiple values (1:N relations)
* @param string $timestamp_type =null default null=leave them as is, 'ts'|'integer' use integer unix timestamps, 'object' use egw_time objects
*/
function __construct($app,$table,$extra_table,$column_prefix='',
$extra_key='_name',$extra_value='_value',$extra_id='_id',
$db=null,$no_clone=true,$allow_multiple_values=false,$timestamp_type=null)
{
// calling the so_sql constructor
parent::__construct($app,$table,$db,$column_prefix,$no_clone,$timestamp_type);
$this->allow_multiple_values = $allow_multiple_values;
$this->extra_table = $extra_table;
if (!$this->extra_id) $this->extra_id = $this->autoinc_id; // default to auto id of regular table
// if names from columns of extra table are only postfixes (starting with _), prepend column prefix
if (!($prefix=$column_prefix))
{
list($prefix) = explode('_',$this->autoinc_id);
}
elseif(substr($prefix,-1) == '_')
{
$prefix = substr($prefix,0,-1); // remove trailing underscore from column prefix parameter
}
foreach(array(
'extra_id' => $extra_id,
'extra_key' => $extra_key,
'extra_value' => $extra_value
) as $col => $val)
{
$this->$col = $col_name = $val;
if ($col_name[0] == '_') $this->$col = $prefix . $val;
}
// some sanity checks, maybe they should be active only for development
if (!($extra_defs = $this->db->get_table_definitions($app,$extra_table)))
{
throw new egw_exception_wrong_parameter("extra table $extra_table is NOT defined!");
}
foreach(array('extra_id','extra_key','extra_value') as $col)
{
if (!$this->$col || !isset($extra_defs['fd'][$this->$col]))
{
throw new egw_exception_wrong_parameter("$col column $extra_table.{$this->$col} is NOT defined!");
}
}
// check if our extra table has a unique index (if not we have to delete the old values, as replacing does not work!)
$this->extra_has_unique_index = $extra_defs['pk'] || $extra_defs['uc'];
// setting up our extra joins, now we know table and column names
$this->extra_join = " LEFT JOIN $extra_table ON $table.$this->autoinc_id=$extra_table.$this->extra_id";
$this->extra_join_order = " LEFT JOIN $extra_table extra_order ON $table.$this->autoinc_id=extra_order.$this->extra_id";
$this->extra_join_filter = " JOIN $extra_table extra_filter ON $table.$this->autoinc_id=extra_filter.$this->extra_id";
$this->customfields = egw_customfields::get($app, false, null, $db);
}
/**
* Read all customfields of the given id's
*
* @param int|array $ids one ore more id's
* @param array $field_names =null custom fields to read, default all
* @return array id => $this->cf_field(name) => value
*/
function read_customfields($ids,$field_names=null)
{
if (is_null($field_names)) $field_names = array_keys($this->customfields);
foreach((array)$ids as $key => $id)
{
if (!(int)$id && is_array($ids)) unset($ids[$key]);
}
if (!$ids || !$field_names) return array(); // nothing to do
$entries = array();
foreach($this->db->select($this->extra_table,'*',array(
$this->extra_id => $ids,
$this->extra_key => $field_names,
),__LINE__,__FILE__,false,'',$this->app) as $row)
{
$entry =& $entries[$row[$this->extra_id]];
if (!is_array($entry)) $entry = array();
$field = $this->get_cf_field($row[$this->extra_key]);
if ($this->allow_multiple_values && $this->is_multiple($row[$this->extra_key]))
{
$entry[$field][] = $row[$this->extra_value];
}
else
{
$entry[$field] = $row[$this->extra_value];
}
}
return $entries;
}
/**
* saves custom field data
*
* @param array $data data to save (cf's have to be prefixed with self::CF_PREFIX = #)
* @param array $extra_cols =array() extra-data to be saved
* @return bool false on success, errornumber on failure
*/
function save_customfields($data, array $extra_cols=array())
{
foreach (array_keys((array)$this->customfields) as $name)
{
if (!isset($data[$field = $this->get_cf_field($name)])) continue;
$where = array(
$this->extra_id => isset($data[$this->autoinc_id]) ? $data[$this->autoinc_id] : $data[$this->db_key_cols[$this->autoinc_id]],
$this->extra_key => $name,
);
$is_multiple = $this->is_multiple($name);
// we explicitly need to delete fields, if value is empty or field allows multiple values or we have no unique index
if(empty($data[$field]) || $is_multiple || !$this->extra_has_unique_index)
{
$this->db->delete($this->extra_table,$where,__LINE__,__FILE__,$this->app);
if (empty($data[$field])) continue; // nothing else to do for empty values
}
foreach($is_multiple && !is_array($data[$field]) ? explode(',',$data[$field]) :
// regular custom fields (!$is_multiple) eg. addressbook store multiple values comma-separated
(array)(!$is_multiple && is_array($data[$field]) ? implode(',', $data[$field]) : $data[$field]) as $value)
{
if (!$this->db->insert($this->extra_table,array($this->extra_value => $value)+$extra_cols,$where,__LINE__,__FILE__,$this->app))
{
return $this->db->Errno;
}
}
}
return false; // no error
}
/**
* merges in new values from the given new data-array
*
* reimplemented to also merge the customfields
*
* @param $new array in form col => new_value with values to set
*/
function data_merge($new)
{
parent::data_merge($new);
if ($this->customfields)
{
foreach(array_keys($this->customfields) as $name)
{
if (isset($new[$field = $this->get_cf_field($name)]))
{
$this->data[$field] = $new[$field];
}
}
}
}
/**
* reads row matched by key and puts all cols in the data array
*
* reimplented to also read the custom fields
*
* @param array $keys array with keys in form internalName => value, may be a scalar value if only one key
* @param string|array $extra_cols string or array of strings to be added to the SELECT, eg. "count(*) as num"
* @param string $join sql to do a join, added as is after the table-name, eg. ", table2 WHERE x=y" or
* @return array|boolean data if row could be retrived else False
*/
function read($keys,$extra_cols='',$join='')
{
if (!parent::read($keys,$extra_cols,$join))
{
return false;
}
if (($id = (int)$this->data[$this->db_key_cols[$this->autoinc_id]]) && $this->customfields &&
($cfs = $this->read_customfields($id)))
{
$this->data = array_merge($this->data,$cfs[$id]);
}
return $this->data;
}
/**
* saves the content of data to the db
*
* reimplented to also save the custom fields
*
* @param array $keys if given $keys are copied to data before saveing => allows a save as
* @param string|array $extra_where =null extra where clause, eg. to check an etag, returns true if no affected rows!
* @return int|boolean 0 on success, or errno != 0 on error, or true if $extra_where is given and no rows affected
*/
function save($keys=null,$extra_where=null)
{
if (is_array($keys) && count($keys) && !isset($keys[0])) // allow to use an etag, eg array('etag=etag+1')
{
$this->data_merge($keys);
$keys = null;
}
$ret = parent::save($keys,$extra_where);
if ($ret == 0 && $this->customfields)
{
$this->save_customfields($this->data);
}
return $ret;
}
/**
* deletes row representing keys in internal data or the supplied $keys if != null
*
* reimplented to also delete the custom fields
*
* @param array|int $keys =null if given array with col => value pairs to characterise the rows to delete, or integer autoinc id
* @param boolean $only_return_ids =false return $ids of delete call to db object, but not run it (can be used by extending classes!)
* @return int|array affected rows, should be 1 if ok, 0 if an error or array with id's if $only_return_ids
*/
function delete($keys=null,$only_return_ids=false)
{
if ($this->customfields || $only_return_ids)
{
$query = parent::delete($keys,true);
// check if query contains more then the id's
if (!isset($query[$this->autoinc_id]) || count($query) != 1)
{
foreach($this->db->select($this->table_name,$this->autoinc_id,$query,__LINE__,__FILE__,false,'',$this->app) as $row)
{
$ids[] = $row[$this->autoinc_id];
}
if (!$ids) return 0; // no rows affected
}
else
{
$ids = (array)$query[$this->autoinc_id];
}
if ($only_return_ids) return $ids;
$this->db->delete($this->extra_table,array($this->extra_id => $ids),__LINE__,__FILE__);
}
return parent::delete($keys);
}
/**
* query rows for the nextmatch widget
*
* Reimplemented to also read the custom fields (if enabled via $query['selectcols']).
*
* Please note: the name of the nextmatch-customfields has to be 'customfields'!
*
* @param array $query with keys 'start', 'search', 'order', 'sort', 'col_filter'
* For other keys like 'filter', 'cat_id' you have to reimplement this method in a derived class.
* @param array &$rows returned rows/competitions
* @param array &$readonlys eg. to disable buttons based on acl, not use here, maybe in a derived class
* @param string $join ='' sql to do a join, added as is after the table-name, eg. ", table2 WHERE x=y" or
* "LEFT JOIN table2 ON (x=y)", Note: there's no quoting done on $join!
* @param boolean $need_full_no_count =false If true an unlimited query is run to determine the total number of rows, default false
* @param mixed $only_keys =false, see search
* @param string|array $extra_cols =array()
* @return int total number of rows
*/
function get_rows($query,&$rows,&$readonlys,$join='',$need_full_no_count=false,$only_keys=false,$extra_cols=array())
{
parent::get_rows($query,$rows,$readonlys,$join,$need_full_no_count,$only_keys,$extra_cols);
$selectcols = $query['selectcols'] ? explode(',',$query['selectcols']) : array();
if ($rows && $this->customfields && (!$selectcols || in_array('customfields',$selectcols)))
{
$id2keys = array();
foreach($rows as $key => $row)
{
$id2keys[$row[$this->db_key_cols[$this->autoinc_id]]] = $key;
}
// check if only certain cf's to show
if (!in_array('customfields', $selectcols))
{
foreach($selectcols as $col)
{
if ($this->is_cf($col)) $fields[] = $this->get_cf_name($col);
}
}
if (($cfs = $this->read_customfields(array_keys($id2keys),$fields)))
{
foreach($cfs as $id => $data)
{
$rows[$id2keys[$id]] = array_merge($rows[$id2keys[$id]],$data);
}
}
}
return $this->total;
}
/**
* searches db for rows matching searchcriteria
*
* Reimplemented to search, order and filter by custom fields
*
* @param array|string $criteria array of key and data cols, OR string with search pattern (incl. * or ? as wildcards)
* @param boolean|string/array $only_keys =true True returns only keys, False returns all cols. or
* comma seperated list or array of columns to return
* @param string $order_by ='' fieldnames + {ASC|DESC} separated by colons ',', can also contain a GROUP BY (if it contains ORDER BY)
* @param string|array $extra_cols ='' string or array of strings to be added to the SELECT, eg. "count(*) as num"
* @param string $wildcard ='' appended befor and after each criteria
* @param boolean $empty =false False=empty criteria are ignored in query, True=empty have to be empty in row
* @param string $op ='AND' defaults to 'AND', can be set to 'OR' too, then criteria's are OR'ed together
* @param mixed $start =false if != false, return only maxmatch rows begining with start, or array($start,$num), or 'UNION' for a part of a union query
* @param array $filter =null if set (!=null) col-data pairs, to be and-ed (!) into the query without wildcards
* @param string $join ='' sql to do a join, added as is after the table-name, eg. "JOIN table2 ON x=y" or
* "LEFT JOIN table2 ON (x=y AND z=o)", Note: there's no quoting done on $join, you are responsible for it!!!
* @param boolean $need_full_no_count =false If true an unlimited query is run to determine the total number of rows, default false
* @return array|NULL array of matching rows (the row is an array of the cols) or NULL
*/
function &search($criteria,$only_keys=True,$order_by='',$extra_cols='',$wildcard='',$empty=False,$op='AND',$start=false,$filter=null,$join='',$need_full_no_count=false)
{
//error_log(__METHOD__.'('.array2string(array_combine(array_slice(array('criteria','only_keys','order_by','extra_cols','wildcard','empty','op','start','filter','join','need_full_no_count'), 0, count(func_get_args())), func_get_args())).')');
if (!$this->customfields)
{
return parent::search($criteria,$only_keys,$order_by,$extra_cols,$wildcard,$empty,$op,$start,$filter,$join,$need_full_no_count);
}
if ($only_keys === false)
{
$only_keys = $this->table_name.'.*';
}
// if string given as criteria --> search in all (or $this->columns_to_search) columns including custom fields
if ($criteria && is_string($criteria))
{
$criteria = $this->search2criteria($criteria,$wildcard,$op);
}
if ($criteria && is_array($criteria))
{
// check if we search in the custom fields
if (isset($criteria[$this->extra_value]))
{
if (($negate = $criteria[$this->extra_value][0] === '!'))
{
$criteria[$this->extra_value] = substr($criteria[$this->extra_value],1);
}
$criteria[] = $this->extra_table.'.'.$this->extra_value . ' ' .($negate ? 'NOT ' : '').
$this->db->capabilities[egw_db::CAPABILITY_CASE_INSENSITIV_LIKE]. ' ' .
$this->db->quote($wildcard.$criteria[$this->extra_value].$wildcard);
unset($criteria[$this->extra_value]);
}
// replace ambiguous auto-id with (an exact match of) table_name.autoid
if (isset($criteria[$this->autoinc_id]))
{
if ($criteria[$this->autoinc_id])
{
$criteria[] = $this->db->expression($this->table_name,$this->table_name.'.',
array($this->autoinc_id => $criteria[$this->autoinc_id]));
}
unset($criteria[$this->autoinc_id]);
}
// replace ambiguous column with (an exact match of) table_name.column
$extra_join_added = $join && strpos($join, $this->extra_join) !== false;
foreach($criteria as $name => $val)
{
// only add extra_join, if we really need it
if (!$extra_join_added && (
is_int($name) && strpos($val, $this->extra_value) !== false ||
is_string($name) && $this->is_cf($name)
))
{
$join .= $this->extra_join;
$extra_join_added = true;
}
$extra_columns = $this->db->get_table_definitions($this->app, $this->extra_table);
if(is_string($name) && $extra_columns['fd'][array_search($name, $this->db_cols)])
{
$criteria[] = $this->db->expression($this->table_name,$this->table_name.'.',array(
array_search($name, $this->db_cols) => $val,
));
unset($criteria[$name]);
}
elseif (is_string($name) && $this->is_cf($name))
{
if ($op != 'AND')
{
$name = substr($name, 1);
if (($negate = $criteria[$name][0] === '!'))
{
$val = substr($val,1);
}
$cfcriteria[] = '(' . $this->extra_table.'.'.$this->extra_value . ' ' .($negate ? 'NOT ' : '').
$this->db->capabilities[egw_db::CAPABILITY_CASE_INSENSITIV_LIKE]. ' ' .
$this->db->quote($wildcard.$val.$wildcard) . ' AND ' .
$this->extra_table.'.'.$this->extra_key . ' = ' . $this->db->quote($name) .
')';
unset($criteria[self::CF_PREFIX.$name]);
}
else
{
// criteria operator is AND we remap the criteria to be transformed to filters
$filter[$name] = $val;
unset($criteria[$name]);
}
}
}
if ($cfcriteria && $op =='OR') $criteria[] = implode(' OR ',$cfcriteria);
}
if($only_keys === true)
{
// Expand to keys here, so table_name can be prepended below
$only_keys = array_values($this->db_key_cols);
}
// replace ambiguous column with (an exact match of) table_name.column
if(is_array($only_keys))
{
foreach($only_keys as $key => &$col)
{
if(is_numeric($key) && in_array($col, $this->db_cols, true))
{
$col = $this->table_name .'.'.array_search($col, $this->db_cols).' AS '.$col;
}
}
}
// check if we order by a custom field --> join cf table for given cf and order by it's value
if (strpos($order_by,self::CF_PREFIX) !== false)
{
// fields to order by, as cutomfields may have names with spaces, we examine each order by criteria
$fields2order = explode(',',$order_by);
foreach($fields2order as $v)
{
if (strpos($v,self::CF_PREFIX) !== false)
{
// we found a customfield, so we split that part by space char in order to get Sorting Direction and Fieldname
$buff = explode(' ',trim($v));
$orderDir = array_pop($buff);
$key = substr(trim(implode(' ',$buff)), 1);
switch($this->customfields[$key]['type'])
{
case 'int':
$order_by = str_replace($v, 'extra_order.'.$this->extra_value.' IS NULL,'.
$this->db->to_int('extra_order.'.$this->extra_value).' '.$orderDir, $order_by);
break;
case 'float':
$order_by = str_replace($v, 'extra_order.'.$this->extra_value.' IS NULL,'.
$this->db->to_double('extra_order.'.$this->extra_value).' '.$orderDir, $order_by);
break;
default:
$order_by = str_replace($v, 'extra_order.'.$this->extra_value.' IS NULL,extra_order.'.
$this->extra_value.' '.$orderDir, $order_by);
}
// postgres requires that expressions in order by appear in the columns of a distinct select
if ($this->db->Type != 'mysql')
{
if (!is_array($extra_cols))
{
$extra_cols = $extra_cols ? explode(',', $extra_cols) : array();
}
$extra_cols[] = 'extra_order.'.$this->extra_value;
$extra_cols[] = 'extra_order.'.$this->extra_value.' IS NULL';
}
$join .= $this->extra_join_order.' AND extra_order.'.$this->extra_key.'='.$this->db->quote($key);
}
}
}
// check if we filter by a custom field
if (is_array($filter))
{
$_cfnames = array_keys($this->customfields);
$extra_filter = null;
foreach($filter as $name => $val)
{
// replace ambiguous auto-id with (an exact match of) table_name.autoid
if (is_string($name) && $name == $this->autoinc_id)
{
if ((int)$filter[$this->autoinc_id])
{
$filter[] = $this->db->expression($this->table_name,$this->table_name.'.',array(
$this->autoinc_id => $filter[$this->autoinc_id],
));
}
unset($filter[$this->autoinc_id]);
}
// replace ambiguous column with (an exact match of) table_name.column
elseif (is_string($name) && $val!=null && in_array($name, $this->db_cols))
{
$extra_columns = $this->db->get_table_definitions($this->app, $this->extra_table);
if ($extra_columns['fd'][array_search($name, $this->db_cols)])
{
$filter[] = $this->db->expression($this->table_name,$this->table_name.'.',array(
array_search($name, $this->db_cols) => $val,
));
unset($filter[$name]);
}
}
elseif (is_string($name) && $this->is_cf($name))
{
if (!empty($val)) // empty -> dont filter
{
if ($val[0] === '!') // negative filter
{
$sql_filter = 'extra_filter.'.$this->extra_value.'!='.$this->db->quote(substr($val,1));
}
else // using egw_db::expression to allow to use array() with possible values or NULL
{
if($this->customfields[$this->get_cf_name($name)]['type'] == 'select' &&
$this->customfields[$this->get_cf_name($name)]['rows'] > 1)
{
// Multi-select - any entry with the filter value selected matches
$sql_filter = str_replace($this->extra_value,'extra_filter.'.
$this->extra_value,$this->db->expression($this->extra_table,array(
$this->db->concat("','",$this->extra_value,"','").' '.$this->db->capabilities[egw_db::CAPABILITY_CASE_INSENSITIV_LIKE].' '.$this->db->quote('%,'.$val.',%')
))
);
}
elseif ($this->customfields[$this->get_cf_name($name)]['type'] == 'text')
{
$sql_filter = str_replace($this->extra_value,'extra_filter.'.$this->extra_value,
$this->db->expression($this->extra_table,array(
$this->extra_value.' '.$this->db->capabilities[egw_db::CAPABILITY_CASE_INSENSITIV_LIKE].' '.$this->db->quote($wildcard.$val.$wildcard)
))
);
}
else
{
$sql_filter = str_replace($this->extra_value,'extra_filter.'.
$this->extra_value,$this->db->expression($this->extra_table,array($this->extra_value => $val)));
}
}
// need to use a LEFT JOIN for negative search or to allow NULL values
$need_left_join = $val[0] === '!' || strpos($sql_filter,'IS NULL') !== false ? ' LEFT ' : '';
$join .= str_replace('extra_filter','extra_filter'.$extra_filter,$need_left_join.$this->extra_join_filter.
' AND extra_filter.'.$this->extra_key.'='.$this->db->quote($this->get_cf_name($name)).
' AND '.$sql_filter);
++$extra_filter;
}
unset($filter[$name]);
}
elseif(is_int($name) && $this->is_cf($val)) // lettersearch: #cfname LIKE 's%'
{
$_cf = explode(' ',$val);
foreach($_cf as $cf_np)
{
// building cf_name by glueing parts together (, in case someone used whitespace in their custom field names)
$tcf_name = ($tcf_name?$tcf_name.' ':'').$cf_np;
// reacts on the first one found that matches an existing customfield, should be better then the old behavior of
// simply splitting by " " and using the first part
if ($this->is_cf($tcf_name) && ($cfn = $this->get_cf_name($tcf_name)) && array_search($cfn,(array)$_cfnames,true)!==false )
{
$cf = $tcf_name;
break;
}
}
$join .= str_replace('extra_filter','extra_filter'.$extra_filter,$this->extra_join_filter.
' AND extra_filter.'.$this->extra_key.'='.$this->db->quote($this->get_cf_name($cf)).
' AND '.str_replace($cf,'extra_filter.'.$this->extra_value,$val));
++$extra_filter;
unset($filter[$name]);
}
}
}
// add DISTINCT as by joining custom fields for search a row can be returned multiple times
if ($join && strpos($join, $this->extra_join) !== false)
{
if (is_array($only_keys))
{
$only_keys = array_values($only_keys);
$only_keys[0] = 'DISTINCT '.($only_keys[0] != $this->autoinc_id ? $only_keys[0] :
$this->table_name.'.'.$this->autoinc_id.' AS '.$this->autoinc_id);
}
else
{
$only_keys = 'DISTINCT '.$only_keys;
}
}
return parent::search($criteria,$only_keys,$order_by,$extra_cols,$wildcard,$empty,$op,$start,$filter,$join,$need_full_no_count);
}
/**
* Get a default list of columns to search
*
* Reimplemented to search custom fields by default.
*
* @return array of column names
*/
protected function get_default_search_columns()
{
$cols = parent::get_default_search_columns();
if ($this->customfields && !isset($this->columns_to_search))
{
$cols[] = $this->extra_table.'.'.$this->extra_value;
}
//error_log(__METHOD__."() this->columns_to_search=".array2string($this->columns_to_search).' returning '.array2string($cols));
return $cols;
}
/**
* Function to test if $field is a custom field: check for the prefix
*
* @param string $field
* @return boolean true if $name is a custom field, false otherwise
*/
function is_cf($field)
{
return $field[0] == self::CF_PREFIX;
}
/**
* Get name part from a custom field: remove the prefix
*
* @param string $field
* @return string name without prefix
*/
function get_cf_name($field)
{
return substr($field,1);
}
/**
* Get the field-name from the name of a custom field: prepend the prefix
*
* @param string $name
* @return string prefix-name
*/
function get_cf_field($name)
{
return self::CF_PREFIX.$name;
}
/**
* Check if cf is stored as 1:N relation in DB and array in memory
*
* @param string $name
* @return string
*/
function is_multiple($name)
{
return $this->allow_multiple_values && in_array($this->customfields[$name]['type'],array('select','select-account')) &&
$this->customfields[$name]['rows'] > 1;
}
}