perl/IDZebra.i

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