| 1 |
/* |
| 2 |
* integrate swish-e into PostgreSQL |
| 3 |
* |
| 4 |
* Dobrica Pavlinusic <dpavlin@rot13.org> 2005-02-18 |
| 5 |
* |
| 6 |
* TODO: |
| 7 |
* - check null input using PG_ARGISNULL before using PG_GETARG_xxxx |
| 8 |
* - support composite type arguments |
| 9 |
* |
| 10 |
* NOTES: |
| 11 |
* - clear structures with memset to support hash indexes (who whould like |
| 12 |
* to create hash index on table returned from function?) |
| 13 |
* - number of returned rows is set by PostgreSQL evaluator, see: |
| 14 |
* http://archives.postgresql.org/pgsql-hackers/2005-02/msg00546.php |
| 15 |
* |
| 16 |
* Based on: |
| 17 |
* - C example from PostgreSQL documentation (BSD licence) |
| 18 |
* - swish-e example src/libtest.c (GPL) |
| 19 |
* - _textin/_textout from pgcurl.c (LGPL) |
| 20 |
* |
| 21 |
* This code is licenced under GPL |
| 22 |
*/ |
| 23 |
|
| 24 |
#include "postgres.h" |
| 25 |
#include "fmgr.h" |
| 26 |
#include "funcapi.h" |
| 27 |
#include "utils/builtins.h" |
| 28 |
#include <swish-e.h> |
| 29 |
|
| 30 |
#define _textin(str) DirectFunctionCall1(textin, CStringGetDatum(str)) |
| 31 |
#define _textout(str) DatumGetPointer(DirectFunctionCall1(textout, PointerGetDatum(str))) |
| 32 |
#define GET_STR(textp) DatumGetCString(DirectFunctionCall1(textout, PointerGetDatum(textp))) |
| 33 |
#define GET_TEXT(cstrp) DatumGetTextP(DirectFunctionCall1(textin, CStringGetDatum(cstrp))) |
| 34 |
|
| 35 |
|
| 36 |
SW_HANDLE swish_handle = NULL;/* Database handle */ |
| 37 |
SW_SEARCH search = NULL; /* search handle -- holds search parameters */ |
| 38 |
SW_RESULTS swish_results = NULL; /* results handle -- holds list of results */ |
| 39 |
SW_RESULT *sw_res = NULL; /* one row from swish-e results */ |
| 40 |
|
| 41 |
/* define PostgreSQL v1 function */ |
| 42 |
PG_FUNCTION_INFO_V1(pgswish); |
| 43 |
Datum pgswish(PG_FUNCTION_ARGS) { |
| 44 |
|
| 45 |
FuncCallContext *funcctx; |
| 46 |
int call_cntr; |
| 47 |
int max_calls; |
| 48 |
TupleDesc tupdesc; |
| 49 |
TupleTableSlot *slot; |
| 50 |
AttInMetadata *attinmeta; |
| 51 |
char *index_path; |
| 52 |
char *query; |
| 53 |
|
| 54 |
/* stuff done only on the first call of the function */ |
| 55 |
if (SRF_IS_FIRSTCALL()) { |
| 56 |
MemoryContext oldcontext; |
| 57 |
|
| 58 |
/* take arguments from function */ |
| 59 |
//index_path = _textout(PG_GETARG_TEXT_P(0)); |
| 60 |
index_path = _textout(PG_GETARG_TEXT_P(0)); |
| 61 |
query = _textout(PG_GETARG_TEXT_P(1)); |
| 62 |
|
| 63 |
/* create a function context for cross-call persistence */ |
| 64 |
funcctx = SRF_FIRSTCALL_INIT(); |
| 65 |
|
| 66 |
/* switch to memory context appropriate for multiple function calls */ |
| 67 |
oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx); |
| 68 |
|
| 69 |
|
| 70 |
/* Send any errors or warnings to stderr (default is stdout) */ |
| 71 |
SwishErrorsToStderr(); |
| 72 |
|
| 73 |
elog(INFO, "pgswish: SwishInit(%s)", index_path); |
| 74 |
|
| 75 |
swish_handle = SwishInit( index_path ); |
| 76 |
|
| 77 |
if (! swish_handle) { |
| 78 |
elog(ERROR, "pgswish: can't open %s", index_path); |
| 79 |
SRF_RETURN_DONE(funcctx); |
| 80 |
} |
| 81 |
|
| 82 |
error_or_abort( swish_handle ); |
| 83 |
/* set ranking scheme. default is 0 */ |
| 84 |
SwishRankScheme( swish_handle, 0 ); |
| 85 |
error_or_abort( swish_handle ); |
| 86 |
|
| 87 |
elog(INFO, "pgswish: SwishQuery(%s)", query); |
| 88 |
/* Here's a short-cut to searching that creates a search object and searches at the same time */ |
| 89 |
swish_results = SwishQuery( swish_handle, query); |
| 90 |
error_or_abort( swish_handle ); |
| 91 |
|
| 92 |
/* total number of tuples to be returned */ |
| 93 |
funcctx->max_calls = SwishHits( swish_results ); |
| 94 |
|
| 95 |
/* check if results exists */ |
| 96 |
if ( 0 == funcctx->max_calls ) |
| 97 |
elog(INFO, "no results for: %s", query ); |
| 98 |
|
| 99 |
elog(INFO, "pgswish: SwishHits = %d", funcctx->max_calls); |
| 100 |
|
| 101 |
/* Build a tuple description for a __pgswish tuple */ |
| 102 |
tupdesc = RelationNameGetTupleDesc("__pgswish"); |
| 103 |
|
| 104 |
/* allocate a slot for a tuple with this tupdesc */ |
| 105 |
slot = TupleDescGetSlot(tupdesc); |
| 106 |
|
| 107 |
/* assign slot to function context */ |
| 108 |
funcctx->slot = slot; |
| 109 |
|
| 110 |
/* |
| 111 |
* generate attribute metadata needed later to produce tuples from raw |
| 112 |
* C strings |
| 113 |
*/ |
| 114 |
attinmeta = TupleDescGetAttInMetadata(tupdesc); |
| 115 |
funcctx->attinmeta = attinmeta; |
| 116 |
|
| 117 |
MemoryContextSwitchTo(oldcontext); |
| 118 |
|
| 119 |
elog(INFO, "SRF_IS_FIRSTCALL done"); |
| 120 |
} |
| 121 |
|
| 122 |
/* stuff done on every call of the function */ |
| 123 |
funcctx = SRF_PERCALL_SETUP(); |
| 124 |
|
| 125 |
call_cntr = funcctx->call_cntr; |
| 126 |
max_calls = funcctx->max_calls; |
| 127 |
slot = funcctx->slot; |
| 128 |
attinmeta = funcctx->attinmeta; |
| 129 |
|
| 130 |
if (call_cntr < max_calls) { |
| 131 |
char **values; |
| 132 |
HeapTuple tuple; |
| 133 |
Datum result; |
| 134 |
|
| 135 |
elog(INFO, "pgswish: loop count %d", call_cntr); |
| 136 |
|
| 137 |
if (! swish_results) { |
| 138 |
elog(ERROR, "pgswish: no swish-e results"); |
| 139 |
SRF_RETURN_DONE(funcctx); |
| 140 |
} |
| 141 |
|
| 142 |
elog(DEBUG1, "pgswish: check for swish-e error"); |
| 143 |
error_or_abort( swish_handle ); |
| 144 |
|
| 145 |
/* |
| 146 |
* Prepare a values array for storage in our slot. |
| 147 |
* This should be an array of C strings which will |
| 148 |
* be processed later by the type input functions. |
| 149 |
*/ |
| 150 |
|
| 151 |
sw_res = SwishNextResult( swish_results ); |
| 152 |
if (! sw_res) { |
| 153 |
elog(ERROR, "pgswish: swish-e sort result list: %d rows expected %d", call_cntr, max_calls - 1); |
| 154 |
SRF_RETURN_DONE(funcctx); |
| 155 |
} |
| 156 |
|
| 157 |
elog(INFO, "Path: %s\n Rank: %lu\n Size: %lu\n Title: %s\n Index: %s\n Modified: %s\n Record #: %lu\n File #: %lu\n\n", |
| 158 |
SwishResultPropertyStr ( sw_res, "swishdocpath" ), |
| 159 |
SwishResultPropertyULong ( sw_res, "swishrank" ), |
| 160 |
SwishResultPropertyULong ( sw_res, "swishdocsize" ), |
| 161 |
SwishResultPropertyStr ( sw_res, "swishtitle"), |
| 162 |
SwishResultPropertyStr ( sw_res, "swishdbfile" ), |
| 163 |
SwishResultPropertyStr ( sw_res, "swishlastmodified" ), |
| 164 |
SwishResultPropertyULong ( sw_res, "swishreccount" ), /* can figure this out in loop, of course */ |
| 165 |
SwishResultPropertyULong ( sw_res, "swishfilenum" ) |
| 166 |
); |
| 167 |
|
| 168 |
values = (char **) palloc(4 * sizeof(char *)); |
| 169 |
|
| 170 |
values[0] = prop2int( sw_res, "swishrank" ); |
| 171 |
values[1] = prop2text( sw_res, "swishdocpath" ); |
| 172 |
values[2] = prop2text( sw_res, "swishtitle" ); |
| 173 |
values[3] = prop2int( sw_res, "swishdocsize" ); |
| 174 |
|
| 175 |
/* |
| 176 |
values[0] = (char *) palloc(16 * sizeof(char)); |
| 177 |
snprintf(values[0], 16, "%d", 1); |
| 178 |
values[1] = (char *) palloc(16 * sizeof(char)); |
| 179 |
snprintf(values[1], 16, "%d", 2); |
| 180 |
values[2] = (char *) palloc(16 * sizeof(char)); |
| 181 |
snprintf(values[2], 16, "%d", 3); |
| 182 |
values[3] = (char *) palloc(16 * sizeof(char)); |
| 183 |
snprintf(values[3], 16, "%d", 4); |
| 184 |
*/ |
| 185 |
|
| 186 |
/* build a tuple */ |
| 187 |
tuple = BuildTupleFromCStrings(attinmeta, values); |
| 188 |
|
| 189 |
/* make the tuple into a datum */ |
| 190 |
result = TupleGetDatum(slot, tuple); |
| 191 |
|
| 192 |
/* clean up ? */ |
| 193 |
pfree(values[0]); |
| 194 |
pfree(values[1]); |
| 195 |
pfree(values[2]); |
| 196 |
pfree(values[3]); |
| 197 |
pfree(values); |
| 198 |
|
| 199 |
elog(INFO, "row: %s|%s|%s|%s",values[0],values[1],values[2],values[3]); |
| 200 |
|
| 201 |
SRF_RETURN_NEXT(funcctx, result); |
| 202 |
} else { |
| 203 |
elog(INFO, "loop over"); |
| 204 |
|
| 205 |
/* free swish object and close */ |
| 206 |
Free_Search_Object( search ); |
| 207 |
SwishClose( swish_handle ); |
| 208 |
|
| 209 |
/* do when there is no more left */ |
| 210 |
SRF_RETURN_DONE(funcctx); |
| 211 |
} |
| 212 |
} |
| 213 |
|
| 214 |
Datum swtextprop(PG_FUNCTION_ARGS) { |
| 215 |
char *prop; |
| 216 |
char *val; |
| 217 |
|
| 218 |
prop = _textout(PG_GETARG_TEXT_P(0)); |
| 219 |
elog(INFO, "pgswish: swextprop(%s)", prop); |
| 220 |
|
| 221 |
val = prop2int( sw_res, prop ); |
| 222 |
error_or_abort( swish_handle ); |
| 223 |
|
| 224 |
elog(INFO, "pgswish: swextprop(%s) = '%s'", prop, val ); |
| 225 |
|
| 226 |
PG_FREE_IF_COPY(prop, 0); |
| 227 |
PG_RETURN_TEXT_P( _textin(val) ); |
| 228 |
} |
| 229 |
|
| 230 |
/* make text var prom property */ |
| 231 |
char *prop2text(SW_RESULT sw_res, char *propname) { |
| 232 |
char *val; |
| 233 |
char *prop; |
| 234 |
int len; |
| 235 |
|
| 236 |
elog(DEBUG1, "prop2text(%s)", propname); |
| 237 |
|
| 238 |
prop = SwishResultPropertyStr( sw_res, propname ); |
| 239 |
error_or_abort( swish_handle ); |
| 240 |
|
| 241 |
len = strlen(prop); |
| 242 |
elog(INFO, "prop2text(%s) = '%s' %d bytes", propname, prop, len); |
| 243 |
|
| 244 |
len++; |
| 245 |
len *= sizeof(char); |
| 246 |
|
| 247 |
elog(DEBUG1, "palloc(%d)", len); |
| 248 |
|
| 249 |
val = palloc(len); |
| 250 |
|
| 251 |
memset(val, 0, len); |
| 252 |
strncpy(val, prop, len); |
| 253 |
|
| 254 |
elog(DEBUG1, "val=%s", val); |
| 255 |
|
| 256 |
return val; |
| 257 |
} |
| 258 |
|
| 259 |
/* make integer variable from property */ |
| 260 |
char *prop2int(SW_RESULT sw_res, char *propname) { |
| 261 |
char *val; |
| 262 |
unsigned long prop; |
| 263 |
int len; |
| 264 |
|
| 265 |
elog(DEBUG1, "prop2int(%s)", propname); |
| 266 |
|
| 267 |
prop = SwishResultPropertyULong( sw_res, propname ); |
| 268 |
error_or_abort( swish_handle ); |
| 269 |
|
| 270 |
elog(INFO, "prop2int(%s) = %lu", propname, prop); |
| 271 |
|
| 272 |
len = 128 * sizeof(char); |
| 273 |
elog(DEBUG1, "palloc(%d)", len); |
| 274 |
|
| 275 |
val = palloc(len); |
| 276 |
memset(val, 0, len); |
| 277 |
|
| 278 |
snprintf(val, len, "%lu", prop); |
| 279 |
|
| 280 |
elog(DEBUG1, "val=%s", val); |
| 281 |
|
| 282 |
return val; |
| 283 |
} |
| 284 |
|
| 285 |
|
| 286 |
/* |
| 287 |
* check if swish has returned error, and elog it. |
| 288 |
*/ |
| 289 |
static void error_or_abort( SW_HANDLE swish_handle ) { |
| 290 |
if ( !SwishError( swish_handle ) ) |
| 291 |
return; |
| 292 |
|
| 293 |
/* print a message */ |
| 294 |
elog(ERROR, |
| 295 |
"pgswish error: Number [%d], Type [%s], Optional Message: [%s]\n", |
| 296 |
SwishError( swish_handle ), |
| 297 |
SwishErrorString( swish_handle ), |
| 298 |
SwishLastErrorMsg( swish_handle ) |
| 299 |
); |
| 300 |
if ( search ) Free_Search_Object( search ); |
| 301 |
SwishClose( swish_handle ); |
| 302 |
} |
| 303 |
|
Parent Directory
| 
Revision Log