/*
** Copyright (c) 2009 D. Richard Hipp
**
** This program is free software; you can redistribute it and/or
** modify it under the terms of the Simplified BSD License (also
** known as the "2-Clause License" or "FreeBSD License".)
** This program is distributed in the hope that it will be useful,
** but without any warranty; without even the implied warranty of
** merchantability or fitness for a particular purpose.
**
** Author contact information:
** drh@hwaci.com
** http://www.hwaci.com/drh/
**
*******************************************************************************
**
** This file contains code to implement the "/doc" web page and related
** pages.
*/
#include "config.h"
#include "search.h"
#include <assert.h>
#if INTERFACE
/*
** A compiled search patter
*/
struct Search {
int nTerm;
struct srchTerm {
char *z;
int n;
} a[8];
};
#endif
/*
** Compile a search pattern
*/
Search *search_init(const char *zPattern){
int nPattern = strlen(zPattern);
Search *p;
char *z;
int i;
p = malloc( nPattern + sizeof(*p) + 1);
if( p==0 ) fossil_panic("out of memory");
z = (char*)&p[1];
strcpy(z, zPattern);
memset(p, 0, sizeof(*p));
while( *z && p->nTerm<sizeof(p->a)/sizeof(p->a[0]) ){
while( !isalnum(*z) && *z ){ z++; }
if( *z==0 ) break;
p->a[p->nTerm].z = z;
for(i=1; isalnum(z[i]) || z[i]=='_'; i++){}
p->a[p->nTerm].n = i;
z += i;
p->nTerm++;
}
return p;
}
/*
** Destroy a search context.
*/
void search_end(Search *p){
free(p);
}
/*
** Theses characters constitute a word boundary
*/
static const char isBoundary[] = {
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1,
1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 0,
1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
};
/*
** Compare a search pattern against an input string and return a score.
**
** Scoring:
** * All terms must match at least once or the score is zero
** * 10 bonus points if the first occurrance is an exact match
** * 1 additional point for each subsequent match of the same word
** * Extra points of two consecutive words of the pattern are consecutive
** in the document
*/
int search_score(Search *p, const char *zDoc){
int iPrev = 999;
int score = 10;
int iBonus = 0;
int i, j;
unsigned char seen[8];
if (zDoc == 0) return 0;
memset(seen, 0, sizeof(seen));
for(i=0; zDoc[i]; i++){
char c = zDoc[i];
if( isBoundary[c&0xff] ) continue;
for(j=0; j<p->nTerm; j++){
int n = p->a[j].n;
if( sqlite3_strnicmp(p->a[j].z, &zDoc[i], n)==0 ){
score += 1;
if( !seen[j] ){
if( isBoundary[zDoc[i+n]&0xff] ) score += 10;
seen[j] = 1;
}
if( j==iPrev+1 ){
score += iBonus;
}
i += n-1;
iPrev = j;
iBonus = 50;
break;
}
}
iBonus /= 2;
while( !isBoundary[zDoc[i]&0xff] ){ i++; }
}
/* Every term must be seen or else the score is zero */
for(j=0; j<p->nTerm; j++){
if( !seen[j] ) return 0;
}
return score;
}
/*
** This is an SQLite function that scores its input using
** a pre-computed pattern.
*/
static void search_score_sqlfunc(
sqlite3_context *context,
int argc,
sqlite3_value **argv
){
Search *p = (Search*)sqlite3_user_data(context);
int score = search_score(p, (const char*)sqlite3_value_text(argv[0]));
sqlite3_result_int(context, score);
}
/*
** Register the "score()" SQL function to score its input text
** using the given Search object. Once this function is registered,
** do not delete the Search object.
*/
void search_sql_setup(Search *p){
sqlite3_create_function(g.db, "score", 1, SQLITE_UTF8, p,
search_score_sqlfunc, 0, 0);
}
/*
** WEBPAGE: search
** URL: /search
*/
void search(void){
const char *zType;
const char *zSrchType;
const char *zTitle;
const char *zContent;
const char *zSrch;
const char *zUuid;
const char *zRid;
char zrn[4];
char zshUuid[10];
int zScore;
int zSrchTypeFlag;
Search *zSrchpat;
Stmt q;
zSrch = PD("search", "");
zSrchType = PD("type", "");
zSrchpat = search_init(zSrch);
search_sql_setup(zSrchpat);
login_check_credentials();
if( !g.okHistory ){ login_needed(); return; }
db_prepare(&q, "SELECT type, rid, title, content, score(content) AS score FROM "
" "
"(SELECT 'checkin' AS type, objid AS rid, coalesce(ecomment, comment) AS title, "
"coalesce(ecomment, comment) AS content FROM event WHERE type='ci' UNION ALL "
"SELECT 'code' AS type, rid, title, content FROM "
"(SELECT title, rid, content_get(rid) as content FROM "
"(SELECT name AS title, get_file_rid(fnid) AS rid FROM "
"(SELECT name, fnid FROM filename))) UNION ALL "
" "
"SELECT 'ticket' AS type, tkt_uuid AS rid, title, coalesce(title, comment) AS content FROM ticket UNION ALL "
"SELECT 'wiki' AS type, rid, SUBSTR(title, 6) AS title, content_get(rid) as content FROM "
"(SELECT tagname AS title, get_wiki_rid(tagid) AS rid FROM "
"(SELECT tagname, tagid FROM tag WHERE tagname LIKE 'wiki-%%')))"
"ORDER BY score DESC;");
zSrchTypeFlag = 0;
if (strcmp(zSrchType, "code") == 0)
zSrchTypeFlag = 1;
else if (strcmp(zSrchType, "tickets") == 0)
zSrchTypeFlag = 2;
else if (strcmp(zSrchType, "checkins") == 0)
zSrchTypeFlag = 3;
else if (strcmp(zSrchType, "wiki") == 0)
zSrchTypeFlag = 4;
style_header("Search");
style_submenu_element("Code", "Code", "search?search=%T&type=code", zSrch);
style_submenu_element("Tickets", "Tickets", "search?search=%T&type=tickets", zSrch);
style_submenu_element("Checkins", "Checkins", "search?search=%T&type=checkins", zSrch);
style_submenu_element("Wiki", "Wiki", "search?search=%T&type=wiki", zSrch);
@ <table border=1>
@ <tr><td>link</td><td>relevance</td><td>title</td><td>type</td></tr>
while (db_step(&q) == SQLITE_ROW){
zType = db_column_text(&q, 0);
zRid = db_column_text(&q, 1);
zTitle = db_column_text(&q, 2);
zContent = db_column_text(&q, 3);
zScore = db_column_int(&q, 4);
sprintf(zrn, "%i", zScore);
if (zScore > 0){
if (strcmp(zType, "code") == 0 && (zSrchTypeFlag == 0 || zSrchTypeFlag == 1)){
zUuid = db_text("", "SELECT uuid FROM blob WHERE rid=%h", zRid);
strncpy(zshUuid, zUuid, 10);
@ <tr><td><a href='/artifact?name=%h(zUuid)'>%h(zshUuid)</a></td><td>%h(zrn)</td>
@ <td>%h(zTitle)</td><td>%h(zType)</td></tr>
}
else if (strcmp(zType, "ticket") == 0 && (zSrchTypeFlag == 0 || zSrchTypeFlag == 2)){
strncpy(zshUuid, zRid, 10);
@ <tr><td><a href='/tktview?name=%h(zRid)'>%h(zshUuid)</a></td><td>%h(zrn)</td>
@ <td>%h(zTitle)</td><td>%h(zType)</td></tr>
}
else if (strcmp(zType, "checkin") == 0 && (zSrchTypeFlag == 0 || zSrchTypeFlag == 3)){
zUuid = db_text("", "SELECT uuid FROM blob WHERE rid=%h", zRid);
strncpy(zshUuid, zUuid, 10);
@ <tr><td><a href='info/%h(zUuid)'>%h(zshUuid)</a></td><td>%h(zrn)</td>
@ <td>%h(zTitle)</td><td>%h(zType)</td></tr>
}
else if (strcmp(zType, "wiki") == 0 && (zSrchTypeFlag == 0 || zSrchTypeFlag == 4)){
@ <tr><td><a href='/wiki?name=%h(zTitle)'>%h(zTitle)</a></td><td>%h(zrn)</td>
@ <td>%h(zTitle)</td><td>%h(zType)</td></tr>
}
}
}
@ </table>
db_finalize(&q);
style_footer();
}
/*
** Testing the search function.
**
** COMMAND: search
** %fossil search pattern...
**
** Search for timeline entries matching the pattern.
*/
void search_cmd(void){
Search *p;
Blob pattern;
int i;
Stmt q;
int iBest;
db_must_be_within_tree();
if( g.argc<2 ) return;
blob_init(&pattern, g.argv[2], -1);
for(i=3; i<g.argc; i++){
blob_appendf(&pattern, " %s", g.argv[i]);
}
p = search_init(blob_str(&pattern));
blob_reset(&pattern);
search_sql_setup(p);
db_multi_exec(
"CREATE TEMP TABLE srch(rid,uuid,date,comment,x);"
"CREATE INDEX srch_idx1 ON srch(x);"
"INSERT INTO srch(rid,uuid,date,comment,x)"
" SELECT blob.rid, uuid, datetime(event.mtime, 'localtime'),"
" coalesce(ecomment,comment),"
" score(coalesce(ecomment,comment)) AS y"
" FROM event, blob"
" WHERE blob.rid=event.objid AND y>0;"
);
iBest = db_int(0, "SELECT max(x) FROM srch");
db_prepare(&q,
"SELECT rid, uuid, date, comment, 0, 0 FROM srch"
" WHERE x>%d ORDER BY x DESC, date DESC",
iBest/3
);
print_timeline(&q, 1000);
db_finalize(&q);
}