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