source: trunk/include/functions_search.inc.php @ 28065

Last change on this file since 28065 was 28065, checked in by rvelices, 7 years ago

bug 3056: quick search -
added scoped searches tag: photo: file:
added range searches width:..1024 height: ratio: size: filesize: hits: score:

  • Property svn:eol-style set to LF
File size: 32.6 KB
Line 
1<?php
2// +-----------------------------------------------------------------------+
3// | Piwigo - a PHP based photo gallery                                    |
4// +-----------------------------------------------------------------------+
5// | Copyright(C) 2008-2014 Piwigo Team                  http://piwigo.org |
6// | Copyright(C) 2003-2008 PhpWebGallery Team    http://phpwebgallery.net |
7// | Copyright(C) 2002-2003 Pierrick LE GALL   http://le-gall.net/pierrick |
8// +-----------------------------------------------------------------------+
9// | This program is free software; you can redistribute it and/or modify  |
10// | it under the terms of the GNU General Public License as published by  |
11// | the Free Software Foundation                                          |
12// |                                                                       |
13// | This program is distributed in the hope that it will be useful, but   |
14// | WITHOUT ANY WARRANTY; without even the implied warranty of            |
15// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      |
16// | General Public License for more details.                              |
17// |                                                                       |
18// | You should have received a copy of the GNU General Public License     |
19// | along with this program; if not, write to the Free Software           |
20// | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
21// | USA.                                                                  |
22// +-----------------------------------------------------------------------+
23
24/**
25 * @package functions\search
26 */
27
28
29/**
30 * Returns search rules stored into a serialized array in "search"
31 * table. Each search rules set is numericaly identified.
32 *
33 * @param int $search_id
34 * @return array
35 */
36function get_search_array($search_id)
37{
38  if (!is_numeric($search_id))
39  {
40    die('Search id must be an integer');
41  }
42
43  $query = '
44SELECT rules
45  FROM '.SEARCH_TABLE.'
46  WHERE id = '.$search_id.'
47;';
48  list($serialized_rules) = pwg_db_fetch_row(pwg_query($query));
49
50  return unserialize($serialized_rules);
51}
52
53/**
54 * Returns the SQL clause for a search.
55 * Transforms the array returned by get_search_array() into SQL sub-query.
56 *
57 * @param array $search
58 * @return string
59 */
60function get_sql_search_clause($search)
61{
62  // SQL where clauses are stored in $clauses array during query
63  // construction
64  $clauses = array();
65
66  foreach (array('file','name','comment','author') as $textfield)
67  {
68    if (isset($search['fields'][$textfield]))
69    {
70      $local_clauses = array();
71      foreach ($search['fields'][$textfield]['words'] as $word)
72      {
73        $local_clauses[] = $textfield." LIKE '%".$word."%'";
74      }
75
76      // adds brackets around where clauses
77      $local_clauses = prepend_append_array_items($local_clauses, '(', ')');
78
79      $clauses[] = implode(
80        ' '.$search['fields'][$textfield]['mode'].' ',
81        $local_clauses
82        );
83    }
84  }
85
86  if (isset($search['fields']['allwords']))
87  {
88    $fields = array('file', 'name', 'comment', 'author');
89    // in the OR mode, request bust be :
90    // ((field1 LIKE '%word1%' OR field2 LIKE '%word1%')
91    // OR (field1 LIKE '%word2%' OR field2 LIKE '%word2%'))
92    //
93    // in the AND mode :
94    // ((field1 LIKE '%word1%' OR field2 LIKE '%word1%')
95    // AND (field1 LIKE '%word2%' OR field2 LIKE '%word2%'))
96    $word_clauses = array();
97    foreach ($search['fields']['allwords']['words'] as $word)
98    {
99      $field_clauses = array();
100      foreach ($fields as $field)
101      {
102        $field_clauses[] = $field." LIKE '%".$word."%'";
103      }
104      // adds brackets around where clauses
105      $word_clauses[] = implode(
106        "\n          OR ",
107        $field_clauses
108        );
109    }
110
111    array_walk(
112      $word_clauses,
113      create_function('&$s','$s="(".$s.")";')
114      );
115
116    // make sure the "mode" is either OR or AND
117    if ($search['fields']['allwords']['mode'] != 'AND' and $search['fields']['allwords']['mode'] != 'OR')
118    {
119      $search['fields']['allwords']['mode'] = 'AND';
120    }
121
122    $clauses[] = "\n         ".
123      implode(
124        "\n         ". $search['fields']['allwords']['mode']. "\n         ",
125        $word_clauses
126        );
127  }
128
129  foreach (array('date_available', 'date_creation') as $datefield)
130  {
131    if (isset($search['fields'][$datefield]))
132    {
133      $clauses[] = $datefield." = '".$search['fields'][$datefield]['date']."'";
134    }
135
136    foreach (array('after','before') as $suffix)
137    {
138      $key = $datefield.'-'.$suffix;
139
140      if (isset($search['fields'][$key]))
141      {
142        $clauses[] = $datefield.
143          ($suffix == 'after'             ? ' >' : ' <').
144          ($search['fields'][$key]['inc'] ? '='  : '').
145          " '".$search['fields'][$key]['date']."'";
146      }
147    }
148  }
149
150  if (isset($search['fields']['cat']))
151  {
152    if ($search['fields']['cat']['sub_inc'])
153    {
154      // searching all the categories id of sub-categories
155      $cat_ids = get_subcat_ids($search['fields']['cat']['words']);
156    }
157    else
158    {
159      $cat_ids = $search['fields']['cat']['words'];
160    }
161
162    $local_clause = 'category_id IN ('.implode(',', $cat_ids).')';
163    $clauses[] = $local_clause;
164  }
165
166  // adds brackets around where clauses
167  $clauses = prepend_append_array_items($clauses, '(', ')');
168
169  $where_separator =
170    implode(
171      "\n    ".$search['mode'].' ',
172      $clauses
173      );
174
175  $search_clause = $where_separator;
176
177  return $search_clause;
178}
179
180/**
181 * Returns the list of items corresponding to the advanced search array.
182 *
183 * @param array $search
184 * @param string $images_where optional additional restriction on images table
185 * @return array
186 */
187function get_regular_search_results($search, $images_where='')
188{
189  global $conf;
190  $forbidden = get_sql_condition_FandF(
191        array
192          (
193            'forbidden_categories' => 'category_id',
194            'visible_categories' => 'category_id',
195            'visible_images' => 'id'
196          ),
197        "\n  AND"
198    );
199
200  $items = array();
201  $tag_items = array();
202
203  if (isset($search['fields']['tags']))
204  {
205    $tag_items = get_image_ids_for_tags(
206      $search['fields']['tags']['words'],
207      $search['fields']['tags']['mode']
208      );
209  }
210
211  $search_clause = get_sql_search_clause($search);
212
213  if (!empty($search_clause))
214  {
215    $query = '
216SELECT DISTINCT(id)
217  FROM '.IMAGES_TABLE.' i
218    INNER JOIN '.IMAGE_CATEGORY_TABLE.' AS ic ON id = ic.image_id
219  WHERE '.$search_clause;
220    if (!empty($images_where))
221    {
222      $query .= "\n  AND ".$images_where;
223    }
224    $query .= $forbidden.'
225  '.$conf['order_by'];
226    $items = array_from_query($query, 'id');
227  }
228
229  if ( !empty($tag_items) )
230  {
231    switch ($search['mode'])
232    {
233      case 'AND':
234        if (empty($search_clause))
235        {
236          $items = $tag_items;
237        }
238        else
239        {
240          $items = array_values( array_intersect($items, $tag_items) );
241        }
242        break;
243      case 'OR':
244        $before_count = count($items);
245        $items = array_unique(
246          array_merge(
247            $items,
248            $tag_items
249            )
250          );
251        break;
252    }
253  }
254
255  return $items;
256}
257
258/**
259 * Finds if a char is a letter, a figure or any char of the extended ASCII table (>127).
260 *
261 * @param char $ch
262 * @return bool
263 */
264function is_word_char($ch)
265{
266  return ($ch>='0' && $ch<='9') || ($ch>='a' && $ch<='z') || ($ch>='A' && $ch<='Z') || ord($ch)>127;
267}
268
269/**
270 * Finds if a char is a special token for word start: [{<=*+
271 *
272 * @param char $ch
273 * @return bool
274 */
275function is_odd_wbreak_begin($ch)
276{
277  return strpos('[{<=*+', $ch)===false ? false:true;
278}
279
280/**
281 * Finds if a char is a special token for word end: ]}>=*+
282 *
283 * @param char $ch
284 * @return bool
285 */
286function is_odd_wbreak_end($ch)
287{
288  return strpos(']}>=*+', $ch)===false ? false:true;
289}
290
291
292define('QST_QUOTED',         0x01);
293define('QST_NOT',            0x02);
294define('QST_OR',             0x04);
295define('QST_WILDCARD_BEGIN', 0x08);
296define('QST_WILDCARD_END',   0x10);
297define('QST_WILDCARD', QST_WILDCARD_BEGIN|QST_WILDCARD_END);
298
299
300class QSearchScope
301{
302  var $id;
303  var $aliases;
304  var $is_text;
305  var $allow_empty;
306
307  function __construct($id, $aliases, $allow_empty=false, $is_text=true)
308  {
309    $this->id = $id;
310    $this->aliases = $aliases;
311    $this->is_text = $is_text;
312    $this->allow_empty =$allow_empty;
313  }
314}
315
316class QNumericRangeScope extends QSearchScope
317{
318  function __construct($id, $aliases, $allow_empty=false)
319  {
320    parent::__construct($id, $aliases, $allow_empty, false);
321  }
322
323  function parse($token)
324  {
325    $str = $token->term;
326    if ( ($pos = strpos($str, '..')) !== false)
327      $range = array( substr($str,0,$pos), substr($str, $pos+2));
328    else
329      $range = array($str, $str);
330    foreach ($range as $i =>&$val)
331    {
332      if (preg_match('/^([0-9.]+)([km])?/i', $val, $matches))
333      {
334        $val = floatval($matches[1]);
335        if (isset($matches[2]))
336        {
337          if ($matches[2]=='k' || $matches[2]=='K')
338          {
339            $val *= 1000;
340            if ($i) $val += 999;
341          }
342          if ($matches[2]=='m' || $matches[2]=='M')
343          {
344            $val *= 1000000;
345            if ($i) $val += 999999;
346          }
347        }
348      }
349      else
350        $val = '';
351    }
352
353    if (!$this->allow_empty && $range[0]=='' && $range[1] == '')
354      return false;
355    $token->scope_data = $range;
356    return true;
357  }
358
359  function get_sql($field, $token)
360  {
361    $clauses = array();
362    if ($token->scope_data[0]!=='')
363      $clauses[] = $field.' >= ' .$token->scope_data[0].' ';
364    if ($token->scope_data[1]!=='')
365      $clauses[] = $field.' <= ' .$token->scope_data[1].' ';
366
367    if (empty($clauses))
368      return $field.' IS NULL';
369    return '('.implode(' AND ', $clauses).')';
370  }
371}
372
373/**
374 * Analyzes and splits the quick/query search query $q into tokens.
375 * q='john bill' => 2 tokens 'john' 'bill'
376 * Special characters for MySql full text search (+,<,>,~) appear in the token modifiers.
377 * The query can contain a phrase: 'Pierre "New York"' will return 'pierre' qnd 'new york'.
378 *
379 * @param string $q
380 */
381
382/** Represents a single word or quoted phrase to be searched.*/
383class QSingleToken
384{
385  var $is_single = true;
386  var $modifier;
387  var $term; /* the actual word/phrase string*/
388  var $scope;
389
390  var $scope_data;
391  var $idx;
392
393  function __construct($term, $modifier, $scope)
394  {
395    $this->term = $term;
396    $this->modifier = $modifier;
397    $this->scope = $scope;
398  }
399
400  function __toString()
401  {
402    $s = '';
403    if (isset($this->scope))
404      $s .= $this->scope->id .':';
405    if ($this->modifier & QST_WILDCARD_BEGIN)
406      $s .= '*';
407    if ($this->modifier & QST_QUOTED)
408      $s .= '"';
409    $s .= $this->term;
410    if ($this->modifier & QST_QUOTED)
411      $s .= '"';
412    if ($this->modifier & QST_WILDCARD_END)
413      $s .= '*';
414    return $s;
415  }
416}
417
418/** Represents an expression of several words or sub expressions to be searched.*/
419class QMultiToken
420{
421  var $is_single = false;
422  var $modifier;
423  var $tokens = array(); // the actual array of QSingleToken or QMultiToken
424
425  function __toString()
426  {
427    $s = '';
428    for ($i=0; $i<count($this->tokens); $i++)
429    {
430      $modifier = $this->tokens[$i]->modifier;
431      if ($i)
432        $s .= ' ';
433      if ($modifier & QST_OR)
434        $s .= 'OR ';
435      if ($modifier & QST_NOT)
436        $s .= 'NOT ';
437      if (! ($this->tokens[$i]->is_single) )
438      {
439        $s .= '(';
440        $s .= $this->tokens[$i];
441        $s .= ')';
442      }
443      else
444      {
445        $s .= $this->tokens[$i];
446      }
447    }
448    return $s;
449  }
450
451  private function push(&$token, &$modifier, &$scope)
452  {
453    if (strlen($token) || (isset($scope) && $scope->allow_empty))
454    {
455      $this->tokens[] = new QSingleToken($token, $modifier, $scope);
456    }
457    $token = "";
458    $modifier = 0;
459    $scope = null;
460  }
461
462  /**
463  * Parses the input query string by tokenizing the input, generating the modifiers (and/or/not/quotation/wildcards...).
464  * Recursivity occurs when parsing ()
465  * @param string $q the actual query to be parsed
466  * @param int $qi the character index in $q where to start parsing
467  * @param int $level the depth from root in the tree (number of opened and unclosed opening brackets)
468  */
469  protected function parse_expression($q, &$qi, $level, $root)
470  {
471    $crt_token = "";
472    $crt_modifier = 0;
473    $crt_scope = null;
474
475    for ($stop=false; !$stop && $qi<strlen($q); $qi++)
476    {
477      $ch = $q[$qi];
478      if ( ($crt_modifier&QST_QUOTED)==0)
479      {
480        switch ($ch)
481        {
482          case '(':
483            if (strlen($crt_token))
484              $this->push($crt_token, $crt_modifier, $crt_scope);
485            $sub = new QMultiToken;
486            $qi++;
487            $sub->parse_expression($q, $qi, $level+1, $root);
488            $sub->modifier = $crt_modifier;
489            if (isset($crt_scope) && $crt_scope->is_text)
490            {
491              $sub->apply_scope($crt_scope); // eg. 'tag:(John OR Bill)'
492            }
493            $this->tokens[] = $sub;
494            $crt_modifier = 0;
495            $crt_scope = null;
496            break;
497          case ')':
498            if ($level>0)
499              $stop = true;
500            break;
501          case ':':
502            $scope = @$root->scopes[$crt_token];
503            if (!isset($scope) || isset($crt_scope))
504            { // white space
505              $this->push($crt_token, $crt_modifier, $crt_scope);
506            }
507            else
508            {
509              $crt_token = "";
510              $crt_scope = $scope;
511            }
512            break;
513          case '"':
514            if (strlen($crt_token))
515              $this->push($crt_token, $crt_modifier, $crt_scope);
516            $crt_modifier |= QST_QUOTED;
517            break;
518          case '-':
519            if (strlen($crt_token) || isset($crt_scope))
520              $crt_token .= $ch;
521            else
522              $crt_modifier |= QST_NOT;
523            break;
524          case '*':
525            if (strlen($crt_token))
526              $crt_token .= $ch; // wildcard end later
527            else
528              $crt_modifier |= QST_WILDCARD_BEGIN;
529            break;
530          case '.':
531            if (isset($crt_scope) && !$crt_scope->is_text)
532            {
533              $crt_token .= $ch;
534              break;
535            }
536            // else white space go on..
537          default:
538            if (preg_match('/[\s,.;!\?]+/', $ch))
539            { // white space
540              if (strlen($crt_token))
541                $this->push($crt_token, $crt_modifier, $crt_scope);
542              $crt_modifier = 0;
543            }
544            else
545              $crt_token .= $ch;
546            break;
547        }
548      }
549      else
550      {// quoted
551        if ($ch=='"')
552        {
553          if ($qi+1 < strlen($q) && $q[$qi+1]=='*')
554          {
555            $crt_modifier |= QST_WILDCARD_END;
556            $qi++;
557          }
558          $this->push($crt_token, $crt_modifier, $crt_scope);
559        }
560        else
561          $crt_token .= $ch;
562      }
563    }
564
565    $this->push($crt_token, $crt_modifier, $crt_scope);
566
567    for ($i=0; $i<count($this->tokens); $i++)
568    {
569      $token = $this->tokens[$i];
570      $remove = false;
571      if ($token->is_single)
572      {
573        if (!isset($token->scope))
574        {
575          if ( ($token->modifier & QST_QUOTED)==0 )
576          {
577            if ('not' == strtolower($token->term))
578            {
579              if ($i+1 < count($this->tokens))
580                $this->tokens[$i+1]->modifier |= QST_NOT;
581              $token->term = "";
582            }
583            if ('or' == strtolower($token->term))
584            {
585              if ($i+1 < count($this->tokens))
586                $this->token[$i+1]->modifier |= QST_OR;
587              $token->term = "";
588            }
589            if ('and' == strtolower($token->term))
590            {
591              $token->term = "";
592            }
593            if ( substr($token->term, -1)=='*' )
594            {
595              $token->term = rtrim($token->term, '*');
596              $token->modifier |= QST_WILDCARD_END;
597            }
598          }
599          if (!strlen($token->term))
600            $remove = true;
601        }
602        elseif (!$token->scope->is_text)
603        {
604          if (!$token->scope->parse($token))
605            $remove = true;
606        }
607      }
608      else
609      {
610        if (!count($token->tokens))
611          $remove = true;
612      }
613      if ($remove)
614      {
615        array_splice($this->tokens, $i, 1);
616        $i--;
617      }
618    }
619  }
620
621  private static function priority($modifier)
622  {
623    return $modifier & QST_OR ? 0 :1;
624  }
625
626  /* because evaluations occur left to right, we ensure that 'a OR b c d' is interpreted as 'a OR (b c d)'*/
627  protected function check_operator_priority()
628  {
629    for ($i=0; $i<count($this->tokens); $i++)
630    {
631      if (!$this->tokens[$i]->is_single)
632        $this->tokens[$i]->check_operator_priority();
633      if ($i==1)
634        $crt_prio = self::priority($this->tokens[$i]->modifier);
635      if ($i<=1)
636        continue;
637      $prio = self::priority($this->tokens[$i]->modifier);
638      if ($prio > $crt_prio)
639      {// e.g. 'a OR b c d' i=2, operator(c)=AND -> prio(AND) > prio(OR) = operator(b)
640        $term_count = 2; // at least b and c to be regrouped
641        for ($j=$i+1; $j<count($this->tokens); $j++)
642        {
643          if (self::priority($this->tokens[$j]->modifier) >= $prio)
644            $term_count++; // also take d
645          else
646            break;
647        }
648
649        $i--; // move pointer to b
650        // crate sub expression (b c d)
651        $sub = new QMultiToken;
652        $sub->tokens = array_splice($this->tokens, $i, $term_count);
653
654        // rewrite ourseleves as a (b c d)
655        array_splice($this->tokens, $i, 0, array($sub));
656        $sub->modifier = $sub->tokens[0]->modifier & QST_OR;
657        $sub->tokens[0]->modifier &= ~QST_OR;
658
659        $sub->check_operator_priority();
660      }
661      else
662        $crt_prio = $prio;
663    }
664  }
665}
666
667class QExpression extends QMultiToken
668{
669  var $scopes = array();
670  var $stokens = array();
671  var $stoken_modifiers = array();
672
673  function __construct($q, $scopes)
674  {
675    foreach ($scopes as $scope)
676    {
677      $this->scopes[$scope->id] = $scope;
678      foreach ($scope->aliases as $alias)
679        $this->scopes[strtolower($alias)] = $scope;
680    }
681    $i = 0;
682    $this->parse_expression($q, $i, 0, $this);
683    //manipulate the tree so that 'a OR b c' is the same as 'b c OR a'
684    $this->check_operator_priority();
685    $this->build_single_tokens($this, 0);
686  }
687
688  private function build_single_tokens(QMultiToken $expr, $this_is_not)
689  {
690    for ($i=0; $i<count($expr->tokens); $i++)
691    {
692      $token = $expr->tokens[$i];
693      $crt_is_not = ($token->modifier ^ $this_is_not) & QST_NOT; // no negation OR double negation -> no negation;
694
695      if ($token->is_single)
696      {
697        $token->idx = count($this->stokens);
698        $this->stokens[] = $token;
699
700        $modifier = $token->modifier;
701        if ($crt_is_not)
702          $modifier |= QST_NOT;
703        else
704          $modifier &= ~QST_NOT;
705        $this->stoken_modifiers[] = $modifier;
706      }
707      else
708        $this->build_single_tokens($token, $crt_is_not);
709    }
710  }
711}
712
713/**
714  Structure of results being filled from different tables
715*/
716class QResults
717{
718  var $all_tags;
719  var $tag_ids;
720  var $tag_iids;
721  var $images_iids;
722  var $iids;
723
724  var $variants;
725}
726
727function qsearch_get_images(QExpression $expr, QResults $qsr)
728{
729  $qsr->images_iids = array_fill(0, count($expr->tokens), array());
730
731  $inflector = null;
732  $lang_code = substr(get_default_language(),0,2);
733  include_once(PHPWG_ROOT_PATH.'include/inflectors/'.$lang_code.'.php');
734  $class_name = 'Inflector_'.$lang_code;
735  if (class_exists($class_name))
736  {
737    $inflector = new $class_name;
738  }
739
740  $query_base = 'SELECT id from '.IMAGES_TABLE.' i WHERE ';
741  for ($i=0; $i<count($expr->stokens); $i++)
742  {
743    $token = $expr->stokens[$i];
744    $term = $token->term;
745    $scope_id = isset($token->scope) ? $token->scope->id : 'photo';
746    $clauses = array();
747
748    $like = addslashes($term);
749    $like = str_replace( array('%','_'), array('\\%','\\_'), $like); // escape LIKE specials %_
750    $file_like = 'CONVERT(file, CHAR) LIKE \'%'.$like.'%\'';
751
752    switch ($scope_id)
753    {
754      case 'photo':
755        $clauses[] = $file_like;
756
757        if ($inflector!=null && strlen($term)>2
758          && ($expr->stoken_modifiers[$i] & (QST_QUOTED|QST_WILDCARD))==0
759          && strcspn($term, '\'0123456789') == strlen($term)
760          )
761        {
762          $variants = array_unique( array_diff( $inflector->get_variants($term), array($term) ) );
763          $qsr->variants[$term] = $variants;
764        }
765        else
766        {
767          $variants = array();
768        }
769
770        if (strlen($term)>3) // default minimum full text index
771        {
772          $ft = $term;
773          if ($expr->stoken_modifiers[$i] & QST_QUOTED)
774            $ft = '"'.$ft.'"';
775          if ($expr->stoken_modifiers[$i] & QST_WILDCARD_END)
776            $ft .= '*';
777          foreach ($variants as $variant)
778          {
779            $ft.=' '.$variant;
780          }
781          $clauses[] = 'MATCH(i.name, i.comment) AGAINST( \''.addslashes($ft).'\' IN BOOLEAN MODE)';
782        }
783        else
784        {
785          foreach( array('i.name', 'i.comment') as $field)
786          {
787            $clauses[] = $field.' REGEXP \'[[:<:]]'.addslashes(preg_quote($term)).'[[:>:]]\'';
788          }
789        }
790        break;
791
792      case 'file':
793        $clauses[] = $file_like;
794        break;
795      case 'width':
796      case 'height':
797      case 'hits':
798      case 'rating_score':
799        $clauses[] = $token->scope->get_sql($scope_id, $token);
800        break;
801      case 'ratio':
802        $clauses[] = $token->scope->get_sql('width/height', $token);
803        break;
804      case 'size':
805        $clauses[] = $token->scope->get_sql('width*height', $token);
806        break;
807      case 'filesize':
808        $clauses[] = $token->scope->get_sql('filesize', $token);
809        break;
810
811    }
812    if (!empty($clauses))
813    {
814      $query = $query_base.'('.implode(' OR ', $clauses).')';
815      $qsr->images_iids[$i] = query2array($query,null,'id');
816    }
817  }
818}
819
820function qsearch_get_tags(QExpression $expr, QResults $qsr)
821{
822  $tokens = $expr->stokens;
823  $token_modifiers = $expr->stoken_modifiers;
824
825  $token_tag_ids = array_fill(0, count($tokens), array() );
826  $all_tags = array();
827
828  $token_tag_scores = $token_tag_ids;
829  $transliterated_tokens = array();
830  foreach ($tokens as $token)
831  {
832    if (!isset($token->scope) || 'tag' == $token->scope)
833    {
834      $transliterated_tokens[] = transliterate($token->term);
835    }
836    else
837    {
838      $transliterated_tokens[] = '';
839    }
840  }
841
842  $query = '
843SELECT t.*, COUNT(image_id) AS counter
844  FROM '.TAGS_TABLE.' t
845    INNER JOIN '.IMAGE_TAG_TABLE.' ON id=tag_id
846  GROUP BY id';
847  $result = pwg_query($query);
848  while ($tag = pwg_db_fetch_assoc($result))
849  {
850    $transliterated_tag = transliterate($tag['name']);
851
852    // find how this tag matches query tokens
853    for ($i=0; $i<count($tokens); $i++)
854    {
855      $transliterated_token = $transliterated_tokens[$i];
856      if (strlen($transliterated_token)==0)
857        continue;
858
859      $match = false;
860      $pos = 0;
861      while ( ($pos = strpos($transliterated_tag, $transliterated_token, $pos)) !== false)
862      {
863        if ( ($token_modifiers[$i]&QST_WILDCARD)==QST_WILDCARD )
864        {// wildcard in this token
865          $match = 1;
866          break;
867        }
868        $token_len = strlen($transliterated_token);
869
870        // search begin of word
871        $wbegin_len=0; $wbegin_char=' ';
872        while ($pos-$wbegin_len > 0)
873        {
874          if (! is_word_char($transliterated_tag[$pos-$wbegin_len-1]) )
875          {
876            $wbegin_char = $transliterated_tag[$pos-$wbegin_len-1];
877            break;
878          }
879          $wbegin_len++;
880        }
881
882        // search end of word
883        $wend_len=0; $wend_char=' ';
884        while ($pos+$token_len+$wend_len < strlen($transliterated_tag))
885        {
886          if (! is_word_char($transliterated_tag[$pos+$token_len+$wend_len]) )
887          {
888            $wend_char = $transliterated_tag[$pos+$token_len+$wend_len];
889            break;
890          }
891          $wend_len++;
892        }
893
894        $this_score = 0;
895        if ( ($token_modifiers[$i]&QST_WILDCARD)==0 )
896        {// no wildcard begin or end
897          if ($token_len <= 2)
898          {// search for 1 or 2 characters must match exactly to avoid retrieving too much data
899            if ($wbegin_len==0 && $wend_len==0 && !is_odd_wbreak_begin($wbegin_char) && !is_odd_wbreak_end($wend_char) )
900              $this_score = 1;
901          }
902          elseif ($token_len == 3)
903          {
904            if ($wbegin_len==0)
905              $this_score = $token_len / ($token_len + $wend_len);
906          }
907          else
908          {
909            $this_score = $token_len / ($token_len + 1.1 * $wbegin_len + 0.9 * $wend_len);
910          }
911        }
912
913        if ($this_score>0)
914          $match = max($match, $this_score );
915        $pos++;
916      }
917
918      if ($match)
919      {
920        $tag_id = (int)$tag['id'];
921        $all_tags[$tag_id] = $tag;
922        $token_tag_ids[$i][] = $tag_id;
923        $token_tag_scores[$i][] = $match;
924      }
925    }
926  }
927
928  // process tags
929  $not_tag_ids = array();
930  for ($i=0; $i<count($tokens); $i++)
931  {
932    array_multisort($token_tag_scores[$i], SORT_DESC|SORT_NUMERIC, $token_tag_ids[$i]);
933    $is_not = $token_modifiers[$i]&QST_NOT;
934    $counter = 0;
935
936    for ($j=0; $j<count($token_tag_scores[$i]); $j++)
937    {
938      if ($is_not)
939      {
940        if ($token_tag_scores[$i][$j] < 0.8 ||
941              ($j>0 && $token_tag_scores[$i][$j] < $token_tag_scores[$i][0]) )
942        {
943          array_splice($token_tag_scores[$i], $j);
944          array_splice($token_tag_ids[$i], $j);
945        }
946      }
947      else
948      {
949        $tag_id = $token_tag_ids[$i][$j];
950        $counter += $all_tags[$tag_id]['counter'];
951        if ( $j>0 && (
952          ($counter > 100 && $token_tag_scores[$i][0] > $token_tag_scores[$i][$j]) // "many" images in previous tags and starting from this tag is less relevant
953          || ($token_tag_scores[$i][0]==1 && $token_tag_scores[$i][$j]<0.8)
954          || ($token_tag_scores[$i][0]>0.8 && $token_tag_scores[$i][$j]<0.5)
955          ))
956        {// we remove this tag from the results, but we still leave it in all_tags list so that if we are wrong, the user chooses it
957          array_splice($token_tag_ids[$i], $j);
958          array_splice($token_tag_scores[$i], $j);
959          break;
960        }
961      }
962    }
963
964    if ($is_not)
965    {
966      $not_tag_ids = array_merge($not_tag_ids, $token_tag_ids[$i]);
967    }
968  }
969
970  $all_tags = array_diff_key($all_tags, array_flip($not_tag_ids));
971  usort($all_tags, 'tag_alpha_compare');
972  foreach ( $all_tags as &$tag )
973  {
974    $tag['name'] = trigger_event('render_tag_name', $tag['name'], $tag);
975  }
976  $qsr->all_tags = $all_tags;
977
978  $qsr->tag_ids = $token_tag_ids;
979  $qsr->tag_iids = array_fill(0, count($tokens), array() );
980
981  for ($i=0; $i<count($tokens); $i++)
982  {
983    $tag_ids = $token_tag_ids[$i];
984
985    if (!empty($tag_ids))
986    {
987      $query = '
988SELECT image_id FROM '.IMAGE_TAG_TABLE.'
989  WHERE tag_id IN ('.implode(',',$tag_ids).')
990  GROUP BY image_id';
991      $qsr->tag_iids[$i] = query2array($query, null, 'image_id');
992    }
993    elseif (isset($tokens[$i]->scope) && 'tag' == $tokens[$i]->scope->id && strlen($token->term)==0)
994    {
995      if ($tokens[$i]->modifier & QST_WILDCARD)
996      {// eg. 'tag:*' returns all tagged images
997        $qsr->tag_iids[$i] = query2array('SELECT DISTINCT image_id FROM '.IMAGE_TAG_TABLE, null, 'image_id');
998      }
999      else
1000      {// eg. 'tag:' returns all untagged images
1001        $qsr->tag_iids[$i] = query2array('SELECT id FROM '.IMAGES_TABLE.' LEFT JOIN '.IMAGE_TAG_TABLE.' ON id=image_id WHERE image_id IS NULL', null, 'id');
1002      }
1003    }
1004  }
1005}
1006
1007
1008function qsearch_eval(QMultiToken $expr, QResults $qsr, &$qualifies, &$ignored_terms)
1009{
1010  $qualifies = false; // until we find at least one positive term
1011  $ignored_terms = array();
1012
1013  $ids = $not_ids = array();
1014
1015  for ($i=0; $i<count($expr->tokens); $i++)
1016  {
1017    $crt = $expr->tokens[$i];
1018    if ($crt->is_single)
1019    {
1020      $crt_ids = $qsr->iids[$crt->idx] = array_unique( array_merge($qsr->images_iids[$crt->idx], $qsr->tag_iids[$crt->idx]) );
1021      $crt_qualifies = count($crt_ids)>0 || count($qsr->tag_ids[$crt->idx])>0;
1022      $crt_ignored_terms = $crt_qualifies ? array() : array($crt->term);
1023    }
1024    else
1025      $crt_ids = qsearch_eval($crt, $qsr, $crt_qualifies, $crt_ignored_terms);
1026
1027    $modifier = $crt->modifier;
1028    if ($modifier & QST_NOT)
1029      $not_ids = array_unique( array_merge($not_ids, $crt_ids));
1030    else
1031    {
1032      $ignored_terms = array_merge($ignored_terms, $crt_ignored_terms);
1033      if ($modifier & QST_OR)
1034      {
1035        $ids = array_unique( array_merge($ids, $crt_ids) );
1036        $qualifies |= $crt_qualifies;
1037      }
1038      elseif ($crt_qualifies)
1039      {
1040        if ($qualifies)
1041          $ids = array_intersect($ids, $crt_ids);
1042        else
1043          $ids = $crt_ids;
1044        $qualifies = true;
1045      }
1046    }
1047  }
1048
1049  if (count($not_ids))
1050    $ids = array_diff($ids, $not_ids);
1051  return $ids;
1052}
1053
1054/**
1055 * Returns the search results corresponding to a quick/query search.
1056 * A quick/query search returns many items (search is not strict), but results
1057 * are sorted by relevance unless $super_order_by is true. Returns:
1058 *  array (
1059 *    'items' => array of matching images
1060 *    'qs'    => array(
1061 *      'unmatched_terms' => array of terms from the input string that were not matched
1062 *      'matching_tags' => array of matching tags
1063 *      'matching_cats' => array of matching categories
1064 *      'matching_cats_no_images' =>array(99) - matching categories without images
1065 *      )
1066 *    )
1067 *
1068 * @param string $q
1069 * @param bool $super_order_by
1070 * @param string $images_where optional additional restriction on images table
1071 * @return array
1072 */
1073function get_quick_search_results($q, $super_order_by, $images_where='')
1074{
1075  global $conf;
1076  //@TODO: maybe cache for 10 minutes the result set to avoid many expensive sql calls when navigating the pictures
1077  $q = trim(stripslashes($q));
1078  $search_results =
1079    array(
1080      'items' => array(),
1081      'qs' => array('q'=>$q),
1082    );
1083
1084  $scopes = array();
1085  $scopes[] = new QSearchScope('tag', array('tags'));
1086  $scopes[] = new QSearchScope('photo', array('photos'));
1087  $scopes[] = new QSearchScope('file', array('filename'));
1088  $scopes[] = new QNumericRangeScope('width', array());
1089  $scopes[] = new QNumericRangeScope('height', array());
1090  $scopes[] = new QNumericRangeScope('ratio', array());
1091  $scopes[] = new QNumericRangeScope('size', array());
1092  $scopes[] = new QNumericRangeScope('filesize', array());
1093  $scopes[] = new QNumericRangeScope('hits', array('hit', 'visit', 'visits'));
1094  $scopes[] = new QNumericRangeScope('rating_score', array('score'), true);
1095  $expression = new QExpression($q, $scopes);
1096//var_export($expression);
1097
1098  $qsr = new QResults;
1099  qsearch_get_tags($expression, $qsr);
1100  qsearch_get_images($expression, $qsr);
1101//var_export($qsr->all_tags);
1102
1103  $ids = qsearch_eval($expression, $qsr, $tmp, $search_results['qs']['unmatched_terms']);
1104
1105  $debug[] = "<!--\nparsed: ".$expression;
1106  $debug[] = count($expression->stokens).' tokens';
1107  for ($i=0; $i<count($expression->stokens); $i++)
1108  {
1109    $debug[] = $expression->stokens[$i].': '.count($qsr->tag_ids[$i]).' tags, '.count($qsr->tag_iids[$i]).' tiids, '.count($qsr->images_iids[$i]).' iiids, '.count($qsr->iids[$i]).' iids'
1110      .( !empty($qsr->variants[$expression->stokens[$i]->term]) ? ' variants: '.implode(', ',$qsr->variants[$expression->stokens[$i]->term]): '');
1111  }
1112  $debug[] = 'before perms '.count($ids);
1113
1114  $search_results['qs']['matching_tags'] = $qsr->all_tags;
1115  global $template;
1116
1117  if (empty($ids))
1118  {
1119    $debug[] = '-->';
1120    $template->append('footer_elements', implode("\n", $debug) );
1121    return $search_results;
1122  }
1123
1124  $where_clauses = array();
1125  $where_clauses[]='i.id IN ('. implode(',', $ids) . ')';
1126  if (!empty($images_where))
1127  {
1128    $where_clauses[]='('.$images_where.')';
1129  }
1130  $where_clauses[] = get_sql_condition_FandF(
1131      array
1132        (
1133          'forbidden_categories' => 'category_id',
1134          'visible_categories' => 'category_id',
1135          'visible_images' => 'i.id'
1136        ),
1137      null,true
1138    );
1139
1140  $query = '
1141SELECT DISTINCT(id)
1142  FROM '.IMAGES_TABLE.' i
1143    INNER JOIN '.IMAGE_CATEGORY_TABLE.' AS ic ON id = ic.image_id
1144  WHERE '.implode("\n AND ", $where_clauses)."\n".
1145  $conf['order_by'];
1146
1147  $ids = query2array($query, null, 'id');
1148
1149  $debug[] = count($ids).' final photo count -->';
1150  $template->append('footer_elements', implode("\n", $debug) );
1151
1152  $search_results['items'] = $ids;
1153  return $search_results;
1154}
1155
1156/**
1157 * Returns an array of 'items' corresponding to the search id.
1158 * It can be either a quick search or a regular search.
1159 *
1160 * @param int $search_id
1161 * @param bool $super_order_by
1162 * @param string $images_where optional aditional restriction on images table
1163 * @return array
1164 */
1165function get_search_results($search_id, $super_order_by, $images_where='')
1166{
1167  $search = get_search_array($search_id);
1168  if ( !isset($search['q']) )
1169  {
1170    $result['items'] = get_regular_search_results($search, $images_where);
1171    return $result;
1172  }
1173  else
1174  {
1175    return get_quick_search_results($search['q'], $super_order_by, $images_where);
1176  }
1177}
1178
1179?>
Note: See TracBrowser for help on using the repository browser.