mirror of
https://gitlab.com/davical-project/davical.git
synced 2026-08-17 16:26:02 +00:00
CardDAV Query Report
This commit is contained in:
“Paul
parent
9dc026eb28
commit
ba5c7e90e1
@ -47,13 +47,24 @@ if ( empty($properties) ) $properties['DAV::allprop'] = 1;
|
||||
* There can only be *one* FILTER element.
|
||||
*/
|
||||
$qry_filters = $xmltree->GetPath('/urn:ietf:params:xml:ns:carddav:addressbook-query/urn:ietf:params:xml:ns:carddav:filter/*');
|
||||
if ( count($qry_filters) != 1 ) {
|
||||
/* $qry_filters = $qry_filters[0]; // There can only be one FILTER element
|
||||
}
|
||||
else { */
|
||||
if ( count($qry_filters) == 0 ) {
|
||||
$qry_filters = false;
|
||||
}
|
||||
|
||||
$qry_limit = -1; // everything
|
||||
$qry_filters_combination='OR';
|
||||
if ( is_array($qry_filters) ) {
|
||||
$filters_parent = $xmltree->GetPath('/urn:ietf:params:xml:ns:carddav:addressbook-query/urn:ietf:params:xml:ns:carddav:filter')[0];
|
||||
// only anyof (OR) or allof (AND) allowed, if missing anyof is default (RFC6352 10.5)
|
||||
if ( $filters_parent->GetAttribute("test") == 'allof' ) {
|
||||
$qry_filters_combination='AND';
|
||||
}
|
||||
|
||||
$limits = $xmltree->GetPath('/urn:ietf:params:xml:ns:carddav:addressbook-query/urn:ietf:params:xml:ns:carddav:limit/urn:ietf:params:xml:ns:carddav:nresults');
|
||||
if ( count($limits) == 1) {
|
||||
$qry_limit = intval($limits[0]->GetContent());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* While we can construct our SQL to apply some filters in the query, other filters
|
||||
@ -61,126 +72,174 @@ else { */
|
||||
*
|
||||
* @param array $filter An array of XMLElement which is the filter definition
|
||||
* @param string $item The database row retrieved for this calendar item
|
||||
* @param string $filter_type possible values AND or OR (for OR only one filter fragment must match)
|
||||
*
|
||||
* @return boolean True if the check succeeded, false otherwise.
|
||||
*/
|
||||
function apply_filter( $filters, $item ) {
|
||||
function apply_filter( $filters, $item, $filter_type) {
|
||||
global $session, $c, $request;
|
||||
|
||||
if ( count($filters) == 0 ) return true;
|
||||
|
||||
dbg_error_log("cardquery","Applying filter for item '%s'", $item->dav_name );
|
||||
$vcard = new vComponent( $item->caldav_data );
|
||||
return $vcard->TestFilter($filters);
|
||||
|
||||
if ( $filter_type === 'AND' ) {
|
||||
return $vcard->TestFilter($filters);
|
||||
} else {
|
||||
foreach($filters AS $filter) {
|
||||
$filter_fragment[0] = $filter;
|
||||
if ( $vcard->TestFilter($filter_fragment) ) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Process a filter fragment returning an SQL fragment
|
||||
*/
|
||||
$need_post_filter = false;
|
||||
$post_filters = array();
|
||||
$matchnum = 0;
|
||||
function SqlFilterCardDAV( $filter, $components, $property = null, $parameter = null ) {
|
||||
global $need_post_filter, $target_collection, $matchnum;
|
||||
global $post_filters, $target_collection, $matchnum;
|
||||
$sql = "";
|
||||
$params = array();
|
||||
if ( !is_array($filter) ) {
|
||||
dbg_error_log( "cardquery", "Filter is of type '%s', but should be an array of XML Tags.", gettype($filter) );
|
||||
}
|
||||
|
||||
foreach( $filter AS $k => $v ) {
|
||||
$tag = $v->GetNSTag();
|
||||
dbg_error_log("cardquery", "Processing $tag into SQL - %d, '%s', %d\n", count($components), $property, isset($parameter) );
|
||||
$tag = $filter->GetNSTag();
|
||||
dbg_error_log("cardquery", "Processing $tag into SQL - %d, '%s', %d\n", count($components), $property, isset($parameter) );
|
||||
|
||||
$not_defined = "";
|
||||
switch( $tag ) {
|
||||
case 'urn:ietf:params:xml:ns:carddav:text-match':
|
||||
$search = $v->GetContent();
|
||||
$negate = $v->GetAttribute("negate-condition");
|
||||
$collation = $v->GetAttribute("collation");
|
||||
switch( strtolower($collation) ) {
|
||||
case 'i;octet':
|
||||
$comparison = 'LIKE';
|
||||
break;
|
||||
case 'i;ascii-casemap':
|
||||
case 'i;unicode-casemap':
|
||||
default:
|
||||
$comparison = 'ILIKE';
|
||||
break;
|
||||
$not_defined = "";
|
||||
switch( $tag ) {
|
||||
case 'urn:ietf:params:xml:ns:carddav:is-not-defined':
|
||||
$sql .= $property . 'IS NULL';
|
||||
break;
|
||||
|
||||
case 'urn:ietf:params:xml:ns:carddav:text-match':
|
||||
if ( empty($property) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$collation = $filter->GetAttribute("collation");
|
||||
switch( strtolower($collation) ) {
|
||||
case 'i;octet':
|
||||
$comparison = 'LIKE';
|
||||
break;
|
||||
case 'i;ascii-casemap':
|
||||
case 'i;unicode-casemap':
|
||||
default:
|
||||
$comparison = 'ILIKE';
|
||||
break;
|
||||
}
|
||||
|
||||
$search = $filter->GetContent();
|
||||
$match = $filter->GetAttribute("match-type");
|
||||
switch( strtolower($match) ) {
|
||||
case 'equals':
|
||||
break;
|
||||
case 'starts-with':
|
||||
$search = $search.'%';
|
||||
break;
|
||||
case 'ends-with':
|
||||
$search = $search.'%';
|
||||
break;
|
||||
case 'contains':
|
||||
default:
|
||||
$search = '%'.$search.'%';
|
||||
break;
|
||||
}
|
||||
|
||||
$pname = ':text_match_'.$matchnum++;
|
||||
$params[$pname] = $search;
|
||||
|
||||
$negate = $filter->GetAttribute("negate-condition");
|
||||
$negate = ( (isset($negate) && strtolower($negate) ) == "yes" ) ? "NOT " : "";
|
||||
dbg_error_log("cardquery", " text-match: (%s%s %s '%s') ", $negate, $property, $comparison, $search );
|
||||
$sql .= sprintf( "(%s%s %s $pname)", $negate, $property, $comparison );
|
||||
break;
|
||||
|
||||
case 'urn:ietf:params:xml:ns:carddav:prop-filter':
|
||||
$propertyname = $filter->GetAttribute("name");
|
||||
switch( $propertyname ) {
|
||||
case 'VERSION':
|
||||
case 'UID':
|
||||
case 'NICKNAME':
|
||||
case 'FN':
|
||||
case 'NOTE':
|
||||
case 'ORG':
|
||||
case 'URL':
|
||||
case 'FBURL':
|
||||
case 'CALADRURI':
|
||||
case 'CALURI':
|
||||
$property = strtolower($propertyname);
|
||||
break;
|
||||
|
||||
case 'N':
|
||||
$property = 'name';
|
||||
break;
|
||||
|
||||
default:
|
||||
$post_filters[] = $filter;
|
||||
dbg_error_log("cardquery", "Could not handle 'prop-filter' on %s in SQL", $propertyname );
|
||||
return false;
|
||||
}
|
||||
|
||||
$test_type = $filter->GetAttribute("test");
|
||||
switch( $test_type ) {
|
||||
case 'allOf':
|
||||
$test_type = 'AND';
|
||||
break;
|
||||
case 'anyOf':
|
||||
default:
|
||||
$test_type = 'OR';
|
||||
}
|
||||
|
||||
$subfilters = $filter->GetContent();
|
||||
if (count($subfilters) <= 1) {
|
||||
$success = SqlFilterCardDAV( $subfilters[0], $components, $property, $parameter );
|
||||
if ( $success !== false ) {
|
||||
$sql .= $success['sql'];
|
||||
$params = array_merge( $params, $success['params'] );
|
||||
}
|
||||
$pname = ':text_match_'.$matchnum++;
|
||||
$match_type = $v->GetAttribute("match-type");
|
||||
switch( strtolower($match_type) ) {
|
||||
case 'starts-with':
|
||||
$params[$pname] = $search.'%';
|
||||
break;
|
||||
case 'ends-with':
|
||||
$params[$pname] = '%'.$search;
|
||||
break;
|
||||
case 'equals':
|
||||
$params[$pname] = $search;
|
||||
case 'contains':
|
||||
default:
|
||||
$params[$pname] = '%'.$search.'%';
|
||||
break;
|
||||
} else {
|
||||
$subfilter_added_counter=0;
|
||||
foreach ($subfilters as $subfilter) {
|
||||
$success = SqlFilterCardDAV( $subfilter, $components, $property, $parameter );
|
||||
if ( $success === false ) continue; else {
|
||||
if ($subfilter_added_counter <= 0) {
|
||||
$sql .= '(' . $success['sql'];
|
||||
} else {
|
||||
$sql .= $test_type . ' ' . $success['sql'];
|
||||
}
|
||||
$params = array_merge( $params, $success['params'] );
|
||||
$subfilter_added_counter++;
|
||||
}
|
||||
}
|
||||
dbg_error_log("cardquery", " text-match: (%s%s %s '%s') ", (isset($negate) && strtolower($negate) == "yes" ? "NOT ": ""),
|
||||
$property, $comparison, $params[$pname] );
|
||||
$sql .= sprintf( "AND (%s%s %s $pname) ", (isset($negate) && strtolower($negate) == "yes" ? "NOT ": ""),
|
||||
$property, $comparison );
|
||||
break;
|
||||
|
||||
case 'urn:ietf:params:xml:ns:carddav:prop-filter':
|
||||
$propertyname = $v->GetAttribute("name");
|
||||
switch( $propertyname ) {
|
||||
case 'VERSION':
|
||||
case 'UID':
|
||||
case 'NICKNAME':
|
||||
case 'FN':
|
||||
case 'NOTE':
|
||||
case 'ORG':
|
||||
case 'URL':
|
||||
case 'FBURL':
|
||||
case 'CALADRURI':
|
||||
case 'CALURI':
|
||||
$property = strtolower($propertyname);
|
||||
break;
|
||||
|
||||
case 'N':
|
||||
$property = 'name';
|
||||
break;
|
||||
|
||||
default:
|
||||
$need_post_filter = true;
|
||||
dbg_error_log("cardquery", "Could not handle 'prop-filter' on %s in SQL", $propertyname );
|
||||
continue;
|
||||
if ($subfilter_added_counter > 0) {
|
||||
$sql .= ')';
|
||||
}
|
||||
$subfilter = $v->GetContent();
|
||||
$success = SqlFilterCardDAV( $subfilter, $components, $property, $parameter );
|
||||
if ( $success === false ) continue; else {
|
||||
$sql .= $success['sql'];
|
||||
$params = array_merge( $params, $success['params'] );
|
||||
}
|
||||
break;
|
||||
}
|
||||
break;
|
||||
|
||||
case 'urn:ietf:params:xml:ns:carddav:param-filter':
|
||||
$need_post_filter = true;
|
||||
return false; /** Figure out how to handle PARAM-FILTER conditions in the SQL */
|
||||
/*
|
||||
$parameter = $v->GetAttribute("name");
|
||||
$subfilter = $v->GetContent();
|
||||
$success = SqlFilterCardDAV( $subfilter, $components, $property, $parameter );
|
||||
if ( $success === false ) continue; else {
|
||||
$sql .= $success['sql'];
|
||||
$params = array_merge( $params, $success['params'] );
|
||||
}
|
||||
break;
|
||||
*/
|
||||
case 'urn:ietf:params:xml:ns:carddav:param-filter':
|
||||
$post_filters[] = $filter;
|
||||
return false; /** Figure out how to handle PARAM-FILTER conditions in the SQL */
|
||||
/*
|
||||
$parameter = $filter->GetAttribute("name");
|
||||
$subfilter = $filter->GetContent();
|
||||
$success = SqlFilterCardDAV( $subfilter, $components, $property, $parameter );
|
||||
if ( $success === false ) continue; else {
|
||||
$sql .= $success['sql'];
|
||||
$params = array_merge( $params, $success['params'] );
|
||||
}
|
||||
break;
|
||||
*/
|
||||
|
||||
default:
|
||||
dbg_error_log("cardquery", "Could not handle unknown tag '%s' in calendar query report", $tag );
|
||||
break;
|
||||
}
|
||||
default:
|
||||
dbg_error_log("cardquery", "Could not handle unknown tag '%s' in calendar query report", $tag );
|
||||
break;
|
||||
}
|
||||
dbg_error_log("cardquery", "Generated SQL was '%s'", $sql );
|
||||
return array( 'sql' => $sql, 'params' => $params );
|
||||
@ -213,23 +272,50 @@ $params = array();
|
||||
$where = ' WHERE caldav_data.collection_id = ' . $target_collection->resource_id();
|
||||
if ( is_array($qry_filters) ) {
|
||||
dbg_log_array( 'cardquery', 'qry_filters', $qry_filters, true );
|
||||
$components = array();
|
||||
$filter_fragment = SqlFilterCardDAV( $qry_filters, $components );
|
||||
if ( $filter_fragment !== false ) {
|
||||
$where .= ' '.$filter_fragment['sql'];
|
||||
$params = $filter_fragment['params'];
|
||||
|
||||
$appended_where_counter=0;
|
||||
foreach ($qry_filters as $qry_filter) {
|
||||
$components = array();
|
||||
$filter_fragment = SqlFilterCardDAV( $qry_filter, $components );
|
||||
if ( $filter_fragment !== false ) {
|
||||
$filter_fragment_sql = $filter_fragment['sql'];
|
||||
if ( empty($filter_fragment_sql) ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ( $appended_where_counter == 0 ) {
|
||||
$where .= ' AND (' . $filter_fragment_sql;
|
||||
$params = $filter_fragment['params'];
|
||||
} else {
|
||||
$where .= ' ' . $qry_filters_combination . ' ' . $filter_fragment_sql;
|
||||
$params = array_merge( $params, $filter_fragment['params'] );
|
||||
}
|
||||
$appended_where_counter++;
|
||||
}
|
||||
}
|
||||
if ( $appended_where_counter > 0 ) {
|
||||
$where .= ')';
|
||||
}
|
||||
}
|
||||
else {
|
||||
dbg_error_log( 'cardquery', 'No query filters' );
|
||||
}
|
||||
|
||||
$need_post_filter = !empty($post_filters);
|
||||
if ( $need_post_filter && ( $qry_filters_combination == 'OR' )) {
|
||||
// we need a post_filter step, and it should be sufficient, that only one
|
||||
// filter is enough to display the item => we can't prefilter values via SQL
|
||||
$where = '';
|
||||
$params = array();
|
||||
$post_filters = $qry_filters;
|
||||
}
|
||||
|
||||
$sql = 'SELECT * FROM caldav_data INNER JOIN addressbook_resource USING(dav_id)'. $where;
|
||||
if ( isset($c->strict_result_ordering) && $c->strict_result_ordering ) $sql .= " ORDER BY dav_id";
|
||||
$qry = new AwlQuery( $sql, $params );
|
||||
if ( $qry->Exec("cardquery",__LINE__,__FILE__) && $qry->rows() > 0 ) {
|
||||
while( $address_object = $qry->Fetch() ) {
|
||||
if ( !$need_post_filter || apply_filter( $qry_filters, $address_object ) ) {
|
||||
if ( !$need_post_filter || apply_filter( $post_filters, $address_object, $qry_filters_combination ) ) {
|
||||
if ( $bound_from != $target_collection->dav_name() ) {
|
||||
$address_object->dav_name = str_replace( $bound_from, $target_collection->dav_name(), $address_object->dav_name);
|
||||
}
|
||||
@ -239,9 +325,12 @@ if ( $qry->Exec("cardquery",__LINE__,__FILE__) && $qry->rows() > 0 ) {
|
||||
$address_object->caldav_data = $vcard->Render();
|
||||
}
|
||||
$responses[] = component_to_xml( $properties, $address_object );
|
||||
if ( ($qry_limit > 0) && ( count($responses) >= $qry_limit ) ) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
$multistatus = new XMLElement( "multistatus", $responses, $reply->GetXmlNsArray() );
|
||||
|
||||
$request->XMLResponse( 207, $multistatus );
|
||||
$request->XMLResponse( 207, $multistatus );
|
||||
Loading…
x
Reference in New Issue
Block a user