perl/IDZebra.i

   1 %module "IDZebra"
   2 %include typemaps.i                       // Load the typemaps librayr
   3
   4
   5 %{
   6 #include "zebraapi.h"
   7 #include "zebra_perl.h"
   8 #include "data1.h"
   9 #include "yaz/odr.h"
  10 #include "yaz/cql.h"
  11 %}
  12
  13 /* == Typemaps ============================================================= */
  14
  15 %typemap(in) int * {
  16   int i;
  17   if (!SvIOK($input))
  18     croak("Argument $argnum is not an integer.");
  19   i = SvIV($input);
  20   $1 = &i;
  21 }
  22
  23 %typemap(out) int * {
  24   $result=newSViv($1)
  25   sv_2mortal($result);
  26   argvi++;
  27 }
  28
  29 /* RetrievalRecordBuff is a special construct, to allow to map a char * buf
  30    to non-null terminated perl string scalar value (SVpv). */
  31 %typemap(out) RetrievalRecordBuf * {
  32   if ($1->len) {
  33     $result = newSVpv($1->buf,$1->len);
  34   } else {
  35     $result = newSVpv("",0);
  36   }
  37   sv_2mortal($result);
  38   argvi++;
  39 }
  40
  41 /* All char ** values are mapped in-out to array of strings. */
  42 %typemap(in) char ** {
  43         AV *tempav;
  44         I32 len;
  45         int i;
  46         SV  **tv;
  47         STRLEN na;
  48         if (!SvROK($input))
  49             croak("Argument $argnum is not a reference.");
  50         if (SvTYPE(SvRV($input)) != SVt_PVAV)
  51             croak("Argument $argnum is not an array.");
  52         tempav = (AV*)SvRV($input);
  53         len = av_len(tempav);
  54         $1 = (char **) malloc((len+2)*sizeof(char *));
  55         for (i = 0; i <= len; i++) {
  56             tv = av_fetch(tempav, i, 0);
  57             $1[i] = (char *) SvPV(*tv,na);
  58         }
  59         $1[i] = NULL;
  60 };
  61
  62 /* This cleans up the char ** array after the function call */
  63 %typemap(freearg) char ** {
  64         free($1);
  65 }
  66
  67 /* Creates a new Perl array and places a NULL-terminated char ** into it */
  68 %typemap(out) char ** {
  69         AV *myav;
  70         SV **svs;
  71         int i = 0,len = 0;
  72         /* Figure out how many elements we have */
  73         while ($1[len])
  74            len++;
  75         svs = (SV **) malloc(len*sizeof(SV *));
  76         for (i = 0; i < len ; i++) {
  77             svs[i] = sv_newmortal();
  78             sv_setpv((SV*)svs[i],$1[i]);
  79         };
  80         myav =  av_make(len,svs);
  81         free(svs);
  82         $result = newRV((SV*)myav);
  83         sv_2mortal($result);
  84         argvi++;
  85 }
  86
  87 /* == Structures for shadow classes  ======================================= */
  88
  89
  90 /*%include "zebra_perl.h" */
  91
  92 typedef struct {
  93   int noOfRecords;
  94   ZebraRetrievalRecord *records;
  95 } RetrievalObj;
  96
  97 typedef struct {
  98   int  errCode;        /* non-zero if error when fetching this */
  99   char *errString;     /* error string */
 100   int  position;       /* position of record in result set (1,2,..) */
 101   char *base;
 102   long long sysno;
 103   int  score;
 104   char *format;    /* record syntax */
 105   RetrievalRecordBuf *buf;
 106 } RetrievalRecord;
 107
 108 /* Scan Term Descriptor */
 109 typedef struct {
 110     int occurrences;     /* scan term occurrences */
 111     char *term;          /* scan term string */
 112 } scanEntry;
 113
 114 typedef struct {
 115   int num_entries;
 116   int position;
 117   int is_partial;
 118   scanEntry *entries;
 119 } ScanObj;
 120
 121
 122 typedef struct {
 123   int processed;
 124   int inserted;
 125   int updated;
 126   int deleted;
 127   long utime;
 128   long stime;
 129 } ZebraTransactionStatus;
 130
 131 /* == Module initialization and cleanup (zebra_perl.c) ===================== */
 132
 133 void init (void);
 134 void DESTROY (void);
 135
 136 /* == Logging facilities (yaz/log.h) ======================================= */
 137
 138 %name(logLevel)
 139 void yaz_log_init_level (int level);
 140
 141 %name(logFile)
 142 void yaz_log_init_file (const char *fname);
 143
 144 %name(logMsg)
 145 void logMsg  (int level, const char *message);
 146
 147 %name(logPrefix)
 148 void yaz_log_init_prefix (const char *prefix);
 149
 150 %name(logPrefix2)
 151 void yaz_log_init_prefix2 (const char *prefix);
 152
 153 #define LOG_FATAL  0x0001
 154 #define LOG_DEBUG  0x0002
 155 #define LOG_WARN   0x0004
 156 #define LOG_LOG    0x0008
 157 #define LOG_ERRNO  0x0010     /* append strerror to message */
 158 #define LOG_FILE   0x0020
 159 #define LOG_APP    0x0040     /* For application level events */
 160 #define LOG_MALLOC 0x0080     /* debugging mallocs */
 161 #define LOG_ALL    0xff7f
 162 #define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN)
 163
 164 /* == ODR stuff (yaz/odr.h) ================================================ */
 165
 166 #define ODR_DECODE      0
 167 #define ODR_ENCODE      1
 168 #define ODR_PRINT       2
 169 ODR odr_createmem(int direction);
 170 void odr_reset(ODR o);
 171 void odr_destroy(ODR o);
 172 void *odr_malloc(ODR o, int size);
 173
 174
 175 /* == Zebra session and service (index/zebraapi.c) ========================= */
 176
 177 %name(start)
 178 ZebraService zebra_start (const char *configName);
 179
 180 %name(open)
 181 ZebraHandle zebra_open (ZebraService zs);
 182
 183 %name(close)
 184 void zebra_close (ZebraHandle zh);
 185
 186 %name(stop)
 187 void zebra_stop (ZebraService zs);
 188
 189
 190 /* == Error handling and reporting (index/zebraapi.c) ====================== */
 191
 192 /* last error code */
 193 %name(errCode)
 194 int zebra_errCode (ZebraHandle zh);
 195
 196 /* string representatio of above */
 197 %name(errString)
 198 const char * zebra_errString (ZebraHandle zh);
 199
 200 /* extra information associated with error */
 201 %name(errAdd)
 202 char *  zebra_errAdd (ZebraHandle zh);
 203
 204
 205 /* == Zebra resources and database selection =============================== */
 206
 207 /* set a resource */
 208 %name(set_resource)
 209 void zebra_set_resource(ZebraHandle zh, const char *name, const char *value);
 210
 211 /* get a resource */
 212 %name(get_resource)
 213 const char *zebra_set_resource(ZebraHandle zh, const char *name,
 214                                const char *defaultvalue);
 215
 216 /* select database for update purposes (zebraapi.c) */
 217 %name(select_database)
 218 int zebra_select_database (ZebraHandle zh, const char *basename);
 219
 220 /* select databases for record retrieval (zebraapi.c) */
 221 %name(select_databases)
 222 int zebra_select_databases (ZebraHandle zh, int num_bases,
 223                              const char **basenames);
 224
 225
 226 /* == Transactions, locking, shadow register =============================== */
 227
 228 /* begin transaction (add write lock) (zebraapi.c) */
 229 %name(begin_trans)
 230 int zebra_begin_trans (ZebraHandle zh, int rw);
 231
 232 /* end transaction (remove write lock) (zebraapi.c) */
 233 %name(end_trans)
 234 void zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *stat);
 235
 236 %name(trans_no)
 237 int zebra_trans_no (ZebraHandle zh);
 238
 239 /* commit changes from shadow (zebraapi.c) */
 240 %name(commit)
 241 int  zebra_commit (ZebraHandle zh);
 242
 243 /* get shadow status (zebra_api_ext.c) */
 244 %name(get_shadow_enable)
 245 int  zebra_get_shadow_enable (ZebraHandle zh);
 246
 247 /* set shadow status (zebra_api_ext.c) */
 248 %name(set_shadow_enable)
 249 void zebra_set_shadow_enable (ZebraHandle zh, int value);
 250
 251
 252 /* == Repository actions (zebraapi.c) ====================================== */
 253
 254 %name(init)
 255 int  zebra_init (ZebraHandle zh);
 256
 257 %name(compact)
 258 int  zebra_compact (ZebraHandle zh);
 259
 260 %name(repository_update)
 261 void zebra_repository_update (ZebraHandle zh, const char *path);
 262
 263 %name(repository_delete)
 264 void zebra_repository_delete (ZebraHandle zh, const char *path);
 265
 266 %name(repository_show)
 267 void zebra_repository_show (ZebraHandle zh, const char *path);
 268
 269
 270 /* == Record update/delete (zebra_api_ext.c) =============================== */
 271
 272 /* If sysno is provided, then it's used to identify the reocord.
 273    If not, and match_criteria is provided, then sysno is guessed
 274    If not, and a record is provided, then sysno is got from there */
 275
 276 %apply int *REFERENCE { long long *sysno };
 277 %name(insert_record)
 278 int zebra_insert_record (ZebraHandle zh,
 279                          const char *recordType,
 280                          long long *sysno,
 281                          const char *match,
 282                          const char *fname,
 283                          const char *buf,
 284                          int buf_size,
 285                          int force_update);
 286
 287 %name(update_record)
 288 int zebra_update_record (ZebraHandle zh,
 289                          const char *recordType,
 290                          long long *sysno,
 291                          const char *match,
 292                          const char *fname,
 293                          const char *buf,
 294                          int buf_size,
 295                          int force_update);
 296
 297 %name(delete_record)
 298 int zebra_delete_record (ZebraHandle zh,
 299                          const char *recordType,
 300                          long long *sysno,
 301                          const char *match,
 302                          const char *fname,
 303                          const char *buf,
 304                          int buf_size,
 305                          int force_update);
 306
 307 /* == Search (zebraapi.c) ================================================== */
 308 %include "typemaps.i"
 309 %apply int *REFERENCE { int *hits };
 310 %name(search_PQF)
 311 int zebra_search_PQF (ZebraHandle zh,
 312                       const char *pqf_query,
 313                       const char *setname,
 314                       int *hits);
 315
 316 /* == YAZ - query tools ==================================================== */
 317
 318
 319 cql_transform_t cql_transform_open_fname(const char *fname);
 320 void cql_transform_close(cql_transform_t ct);
 321 int cql_transform_error(cql_transform_t ct, const char **addinfo);
 322
 323 %name(cql2pqf)
 324 int zebra_cql2pqf (cql_transform_t ct,
 325                    const char *query, char *res, int len);
 326
 327 /* == Retrieval (zebra_api_ext.c) ========================================== */
 328
 329 /* will get a 'retrieval obj' (simple enough to pass to perl), which can be
 330    used to get the individual records. Elementset, schema and format strings
 331    are threated the same way yaz-client does. */
 332 void records_retrieve(ZebraHandle zh,
 333                       ODR stream,
 334                       const char *setname,      // resultset name
 335                       const char *a_eset,       // optional elementset
 336                       const char *a_schema,     // optional schema
 337                       const char *a_format,     // optional record syntax
 338                       int from,                 // range, 1 based
 339                       int to,
 340                       RetrievalObj *res
 341                       );
 342
 343 /* fetch a record from the retrieval object. pos is 1 based */
 344 void record_retrieve(RetrievalObj *ro,
 345                      ODR stream,
 346                      RetrievalRecord *res,
 347                      int pos);
 348
 349 /* Delete Result Set(s) (zebraapi.c) */
 350 %name(deleteResultSet)
 351 int zebra_deleleResultSet(ZebraHandle zh, int function,
 352                           int num_setnames, char **setnames,
 353                           int *statuses);
 354
 355
 356 /* Resultset terms */
 357 %name(resultSetTerms)
 358 int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
 359                           int no, int *REFERENCE,
 360                           int *REFERENCE, char *out, int *REFERENCE);
 361
 362 /* == Sort ================================================================= */
 363 %name(sort)
 364 int zebra_sort_by_specstr (ZebraHandle zh,
 365           ODR stream,
 366           const char *sort_spec,
 367           const char *output_setname,
 368           const char **input_setnames
 369           );
 370
 371 /* == Scan ================================================================= */
 372 %name(scan_PQF)
 373 void zebra_scan_PQF (ZebraHandle zh,
 374                      ScanObj *so,
 375                      ODR stream,
 376                      const char *pqf_query);
 377
 378 scanEntry *getScanEntry(ScanObj *so, int pos);
 379
 380 %typemap(in) int * (int dvalue);
 381 %typemap(argout) int *;
 382
 383
 384 /* Admin functionality */
 385 /*
 386 %name(admin_start)         void zebra_admin_start (ZebraHandle zh);
 387 %name(admin_shutdown)      void zebra_admin_shutdown (ZebraHandle zh);
 388 */
 389
 390
 391
 392 /* do authentication */
 393 /*
 394 int zebra_auth (ZebraHandle zh, const char *user, const char *pass);
 395
 396 */
 397
 398
 399 /*
 400
 401 void zebra_result (ZebraHandle zh, int *code, char **addinfo);
 402 int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
 403                           int no, int *count,
 404                           int *type, char *out, size_t *len);
 405 */
 406
 407 /*
 408 YAZ_EXPORT void zebra_admin_create (ZebraHandle zh, const char *db);
 409
 410 YAZ_EXPORT void zebra_admin_import_begin (ZebraHandle zh, const char *database);
 411
 412 YAZ_EXPORT void zebra_admin_import_segment (ZebraHandle zh,
 413                                             Z_Segment *segment);
 414
 415 void zebra_admin_shutdown (ZebraHandle zh);
 416 void zebra_admin_start (ZebraHandle zh);
 417 void zebra_admin_import_end (ZebraHandle zh);
 418
 419
 420 */
 421
 422
 423 /* =========================================================================
 424  * NMEM stuff
 425  * =========================================================================
 426 */
 427
 428 NMEM         nmem_create (void);
 429 void         nmem_destroy (NMEM handle);
 430
 431 /* =========================================================================
 432  * Data1 stuff
 433  * =========================================================================
 434 */
 435
 436 typedef enum data1_datatype
 437 {
 438     DATA1K_unknown,
 439     DATA1K_structured,
 440     DATA1K_string,
 441     DATA1K_numeric,
 442     DATA1K_bool,
 443     DATA1K_oid,
 444     DATA1K_generalizedtime,
 445     DATA1K_intunit,
 446     DATA1K_int,
 447     DATA1K_octetstring,
 448     DATA1K_null
 449 } data1_datatype;
 450
 451 #define DATA1T_numeric 1
 452 #define DATA1T_string 2
 453 #define DATA1N_root 1
 454 #define DATA1N_tag  2
 455 #define DATA1N_data 3
 456 #define DATA1N_variant 4
 457 #define DATA1N_comment 5
 458 #define DATA1N_preprocess 6
 459 #define DATA1I_inctxt 1
 460 #define DATA1I_incbin 2
 461 #define DATA1I_text 3
 462 #define DATA1I_num 4
 463 #define DATA1I_oid 5
 464 #define DATA1_LOCALDATA 12
 465 #define DATA1_FLAG_XML  1
 466
 467 data1_handle data1_create (void);
 468 data1_handle data1_createx (int flags);
 469 void data1_destroy(data1_handle dh);
 470
 471 /* Data1 node */
 472 data1_node *get_parent_tag(data1_handle dh, data1_node *n);
 473 data1_node *data1_read_node(data1_handle dh, const char **buf,NMEM m);
 474 data1_node *data1_read_nodex (data1_handle dh, NMEM m, int (*get_byte)(void *fh), void *fh, WRBUF wrbuf);
 475 data1_node *data1_read_record(data1_handle dh, int (*rf)(void *, char *, size_t), void *fh, NMEM m);
 476 data1_absyn *data1_read_absyn(data1_handle dh, const char *file, int file_must_exist);
 477 data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s, int type, int value);
 478
 479 data1_tagset *data1_empty_tagset (data1_handle dh);
 480 data1_tagset *data1_read_tagset(data1_handle dh, const char *file, int type);
 481 data1_element *data1_getelementbytagname(data1_handle dh,
 482                                          data1_absyn *abs,
 483                                          data1_element *parent,
 484                                          const char *tagname);
 485
 486 Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
 487                                 int select, ODR o,
 488                                 int *len);
 489
 490 data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
 491                               const char *name);
 492
 493 void data1_free_tree(data1_handle dh, data1_node *t);
 494
 495 char *data1_nodetobuf(data1_handle dh, data1_node *n,
 496                       int select, int *len);
 497
 498 data1_node *data1_mk_tag_data_wd(data1_handle dh,
 499                                  data1_node *at,
 500                                  const char *tagname, NMEM m);
 501 data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
 502                               const char *tagname, NMEM m);
 503 data1_datatype data1_maptype(data1_handle dh, char *t);
 504 data1_varset *data1_read_varset(data1_handle dh, const char *file);
 505 data1_vartype *data1_getvartypebyct(data1_handle dh,
 506                                     data1_varset *set,
 507                                     char *zclass, char *type);
 508 Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
 509 int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
 510
 511 data1_esetname *data1_getesetbyname(data1_handle dh,
 512                                     data1_absyn *a,
 513                                     const char *name);
 514 data1_element *data1_getelementbyname(data1_handle dh,
 515                                                  data1_absyn *absyn,
 516                                                  const char *name);
 517 data1_node *data1_mk_node2(data1_handle dh, NMEM m,
 518                                       int type, data1_node *parent);
 519
 520 data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
 521                                      const char *tag, const char **attr,
 522                                      data1_node *at);
 523 data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
 524                                        const char *tag, size_t len,
 525                                        const char **attr,
 526                                        data1_node *at);
 527 void data1_tag_add_attr (data1_handle dh, NMEM nmem,
 528                                     data1_node *res, const char **attr);
 529
 530 data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
 531                                         const char *buf, size_t len,
 532                                         data1_node *parent);
 533 data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
 534                                          const char *buf, size_t len,
 535                                          data1_node *parent);
 536 data1_node *data1_mk_text (data1_handle dh, NMEM mem,
 537                                       const char *buf, data1_node *parent);
 538
 539 data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
 540                                            const char *buf, size_t len,
 541                                            data1_node *parent);
 542
 543 data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
 544                                          const char *buf, data1_node *parent);
 545
 546 data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
 547                                             const char *target,
 548                                             const char **attr,
 549                                             data1_node *at);
 550
 551 data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
 552                                       const char *name);
 553 void data1_set_root(data1_handle dh, data1_node *res,
 554                                NMEM nmem, const char *name);
 555
 556 data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
 557                                               const char *tag, int num,
 558                                               NMEM nmem);
 559 data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
 560                                               const char *tag, Odr_oid *oid,
 561                                               NMEM nmem);
 562 data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
 563                                                const char *tag,
 564                                                const char *str,
 565                                                NMEM nmem);
 566 data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
 567                                                    data1_node *at,
 568                                                    const char *tag,
 569                                                    const char *str,
 570                                                    NMEM nmem);
 571
 572 data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
 573
 574 data1_node *data1_search_tag (data1_handle dh, data1_node *n,
 575                                          const char *tag);
 576 data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
 577                                          const char *tag, data1_node *at);
 578 data1_attset *data1_get_attset (data1_handle dh, const char *name);
 579 data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
 580 data1_node *data1_map_record(data1_handle dh, data1_node *n,
 581                                         data1_maptab *map, NMEM m);
 582 data1_marctab *data1_read_marctab (data1_handle dh,
 583                                               const char *file);
 584 char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
 585                                   data1_node *n, int selected, int *len);
 586 char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
 587                                     int select, int *len);
 588 Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
 589                                                 data1_node *n, int select,
 590                                                 ODR o);
 591 Z_BriefBib *data1_nodetosummary(data1_handle dh,
 592                                            data1_node *n, int select,
 593                                            ODR o);
 594 char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
 595                                   int *len);
 596 WRBUF data1_get_wrbuf (data1_handle dp);
 597 char **data1_get_read_buf (data1_handle dp, int **lenp);
 598 char **data1_get_map_buf (data1_handle dp, int **lenp);
 599 data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
 600 data1_attset_cache *data1_attset_cache_get (data1_handle dh);
 601 NMEM data1_nmem_get (data1_handle dh);
 602
 603 void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
 604 void data1_print_tree (data1_handle dh, data1_node *n);
 605
 606
 607 char *data1_insert_string (data1_handle dh, data1_node *res,
 608                                       NMEM m, const char *str);
 609 char *data1_insert_string_n (data1_handle dh, data1_node *res,
 610                                         NMEM m, const char *str, size_t len);
 611 data1_node *data1_read_sgml (data1_handle dh, NMEM m,
 612                                         const char *buf);
 613 /*
 614 data1_node *data1_read_xml (data1_handle dh,
 615                                        int (*rf)(void *, char *, size_t),
 616                                        void *fh, NMEM m);
 617 */
 618 void data1_absyn_trav (data1_handle dh, void *handle,
 619                                   void (*fh)(data1_handle dh,
 620                                              void *h, data1_absyn *a));
 621
 622 data1_attset *data1_attset_search_id (data1_handle dh, int id);
 623
 624 char *data1_getNodeValue(data1_node* node, char* pTagPath);
 625 data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
 626 int data1_CountOccurences(data1_node* node, char* pTagPath);
 627
 628
 629 FILE *data1_path_fopen (data1_handle dh, const char *file,
 630                                    const char *mode);
 631 void data1_set_tabpath(data1_handle dh, const char *path);
 632 void data1_set_tabroot (data1_handle dp, const char *p);
 633 const char *data1_get_tabpath(data1_handle dh);
 634 const char *data1_get_tabroot(data1_handle dh);
 635
 636
 637
 638 /* =========================================================================
 639  * Filter stuff
 640  * =========================================================================
 641  */
 642 int grs_perl_readf(struct perl_context *context, size_t len);
 643 int grs_perl_readline(struct perl_context *context);
 644 char grs_perl_getc(struct perl_context *context);
 645 off_t grs_perl_seekf(struct perl_context *context, off_t offset);
 646 off_t grs_perl_tellf(struct perl_context *context);
 647 void grs_perl_endf(struct perl_context *context, off_t offset);
 648
 649 data1_handle *grs_perl_get_dh(struct perl_context *context);
 650 NMEM *grs_perl_get_mem(struct perl_context *context);
 651 void grs_perl_set_res(struct perl_context *context, data1_node *n);
 652