src/charsets.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2008 Index Data
   3
   4 Pazpar2 is free software; you can redistribute it and/or modify it under
   5 the terms of the GNU General Public License as published by the Free
   6 Software Foundation; either version 2, or (at your option) any later
   7 version.
   8
   9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12 for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17
  18 */
  19
  20 /** \file charsets.c
  21     \brief Pazpar2 Character set facilities
  22 */
  23
  24 #if HAVE_CONFIG_H
  25 #include <config.h>
  26 #endif
  27
  28 #include <yaz/xmalloc.h>
  29 #include <yaz/wrbuf.h>
  30 #include <yaz/log.h>
  31 #include <ctype.h>
  32 #include <assert.h>
  33
  34 #include "charsets.h"
  35 #include "normalize7bit.h"
  36
  37 #ifdef HAVE_ICU
  38 #include "icu_I18N.h"
  39 #endif // HAVE_ICU
  40
  41 /* charset handle */
  42 struct pp2_charset_s {
  43     const char *(*token_next_handler)(pp2_relevance_token_t prt);
  44     const char *(*get_sort_handler)(pp2_relevance_token_t prt, int skip);
  45 #ifdef HAVE_ICU
  46     struct icu_chain * icu_chn;
  47     UErrorCode icu_sts;
  48 #endif // HAVE_ICU
  49 };
  50
  51 static const char *pp2_relevance_token_a_to_z(pp2_relevance_token_t prt);
  52 static const char *pp2_get_sort_ascii(pp2_relevance_token_t prt, int skip_article);
  53
  54 #ifdef HAVE_ICU
  55 static const char *pp2_relevance_token_icu(pp2_relevance_token_t prt);
  56 static const char *pp2_get_sort_icu(pp2_relevance_token_t prt, int skip_article);
  57 #endif // HAVE_ICU
  58
  59 /* tokenzier handle */
  60 struct pp2_relevance_token_s {
  61     const char *cp;     /* unnormalized buffer we're tokenizing */
  62     const char *last_cp;  /* pointer to last token we're dealing with */
  63     pp2_charset_t pct;  /* our main charset handle (type+config) */
  64     WRBUF norm_str;     /* normized string we return (temporarily) */
  65     WRBUF sort_str;     /* sort string we return (temporarily) */
  66 };
  67
  68
  69 pp2_charset_t pp2_charset_create_xml(xmlNode *xml_node)
  70 {
  71 #ifdef HAVE_ICU
  72     UErrorCode status = U_ZERO_ERROR;
  73     struct icu_chain *chain = 0;
  74     if (xml_node)
  75         xml_node = xml_node->children;
  76     while (xml_node && xml_node->type != XML_ELEMENT_NODE)
  77         xml_node = xml_node->next;
  78     chain = icu_chain_xml_config(xml_node, &status);
  79     if (!chain || U_FAILURE(status)){
  80         //xmlDocPtr icu_doc = 0;
  81         //xmlChar *xmlstr = 0;
  82                 //int size = 0;
  83                 //xmlDocDumpMemory(icu_doc, size);
  84
  85         yaz_log(YLOG_FATAL, "Could not parse ICU chain config:\n"
  86                 "<%s>\n ... \n</%s>",
  87                 xml_node->name, xml_node->name);
  88         return 0;
  89     }
  90     return pp2_charset_create(chain);
  91 #else // HAVE_ICU
  92     yaz_log(YLOG_FATAL, "Error: ICU support requested with element:\n"
  93             "<%s>\n ... \n</%s>",
  94             xml_node->name, xml_node->name);
  95     yaz_log(YLOG_FATAL,
  96             "But no ICU support compiled into pazpar2 server.");
  97     yaz_log(YLOG_FATAL,
  98             "Please install libicu36-dev and icu-doc or similar, "
  99             "re-configure and re-compile");
 100     return 0;
 101 #endif // HAVE_ICU
 102 }
 103
 104
 105 pp2_charset_t pp2_charset_create(struct icu_chain * icu_chn)
 106 {
 107     pp2_charset_t pct = xmalloc(sizeof(*pct));
 108
 109     pct->token_next_handler = pp2_relevance_token_a_to_z;
 110     pct->get_sort_handler  = pp2_get_sort_ascii;
 111 #ifdef HAVE_ICU
 112     pct->icu_chn = 0;
 113     if (icu_chn)
 114     {
 115         pct->icu_chn = icu_chn;
 116         pct->icu_sts = U_ZERO_ERROR;
 117         pct->token_next_handler = pp2_relevance_token_icu;
 118         pct->get_sort_handler = pp2_get_sort_icu;
 119     }
 120 #endif // HAVE_ICU
 121     return pct;
 122 }
 123
 124 void pp2_charset_destroy(pp2_charset_t pct)
 125 {
 126     xfree(pct);
 127 }
 128
 129 pp2_relevance_token_t pp2_relevance_tokenize(pp2_charset_t pct,
 130                                              const char *buf)
 131 {
 132     pp2_relevance_token_t prt = xmalloc(sizeof(*prt));
 133
 134     assert(pct);
 135
 136     prt->norm_str = wrbuf_alloc();
 137     prt->sort_str = wrbuf_alloc();
 138     prt->cp = buf;
 139     prt->last_cp = 0;
 140     prt->pct = pct;
 141
 142 #ifdef HAVE_ICU
 143     if (pct->icu_chn)
 144     {
 145         int ok = 0;
 146         pct->icu_sts = U_ZERO_ERROR;
 147         ok = icu_chain_assign_cstr(pct->icu_chn, buf, &pct->icu_sts);
 148         //printf("\nfield ok: %d '%s'\n", ok, buf);
 149         prt->pct = pct;
 150     }
 151 #endif // HAVE_ICU
 152     return prt;
 153 }
 154
 155
 156 void pp2_relevance_token_destroy(pp2_relevance_token_t prt)
 157 {
 158     assert(prt);
 159     if(prt->norm_str)
 160         wrbuf_destroy(prt->norm_str);
 161     if(prt->sort_str)
 162         wrbuf_destroy(prt->sort_str);
 163     xfree(prt);
 164 }
 165
 166 const char *pp2_relevance_token_next(pp2_relevance_token_t prt)
 167 {
 168     assert(prt);
 169     return (prt->pct->token_next_handler)(prt);
 170 }
 171
 172 const char *pp2_get_sort(pp2_relevance_token_t prt, int skip)
 173 {
 174     return prt->pct->get_sort_handler(prt, skip);
 175 }
 176
 177 #define raw_char(c) (((c) >= 'a' && (c) <= 'z') ? (c) : -1)
 178 /* original tokenizer with our tokenize interface, but we
 179    add +1 to ensure no '\0' are in our string (except for EOF)
 180 */
 181 static const char *pp2_relevance_token_a_to_z(pp2_relevance_token_t prt)
 182 {
 183     const char *cp = prt->cp;
 184     int c;
 185
 186     /* skip white space */
 187     while (*cp && (c = raw_char(tolower(*(const unsigned char *)cp))) < 0)
 188         cp++;
 189     if (*cp == '\0')
 190     {
 191         prt->cp = cp;
 192         prt->last_cp = 0;
 193         return 0;
 194     }
 195     /* now read the term itself */
 196
 197     prt->last_cp = cp;
 198     wrbuf_rewind(prt->norm_str);
 199     while (*cp && (c = raw_char(tolower(*cp))) >= 0)
 200     {
 201         wrbuf_putc(prt->norm_str, c);
 202         cp++;
 203     }
 204     prt->cp = cp;
 205     return wrbuf_cstr(prt->norm_str);
 206 }
 207
 208 static const char *pp2_get_sort_ascii(pp2_relevance_token_t prt,
 209                                     int skip_article)
 210 {
 211     if (prt->last_cp == 0)
 212         return 0;
 213     else
 214     {
 215         char *tmp = xstrdup(prt->last_cp);
 216         char *result = 0;
 217         result = normalize7bit_mergekey(tmp, skip_article);
 218
 219         wrbuf_rewind(prt->sort_str);
 220         wrbuf_puts(prt->sort_str, result);
 221         xfree(tmp);
 222         return wrbuf_cstr(prt->sort_str);
 223     }
 224 }
 225
 226
 227 #ifdef HAVE_ICU
 228 static const char *pp2_relevance_token_icu(pp2_relevance_token_t prt)
 229 {
 230     if (icu_chain_next_token(prt->pct->icu_chn, &prt->pct->icu_sts))
 231     {
 232         if (U_FAILURE(prt->pct->icu_sts))
 233         {
 234             return 0;
 235         }
 236         return icu_chain_get_norm(prt->pct->icu_chn);
 237     }
 238     return 0;
 239 }
 240
 241 static const char *pp2_get_sort_icu(pp2_relevance_token_t prt,
 242                                     int skip_article)
 243 {
 244     return icu_chain_get_sort(prt->pct->icu_chn);
 245 }
 246
 247 #endif // HAVE_ICU
 248
 249
 250
 251 /*
 252  * Local variables:
 253  * c-basic-offset: 4
 254  * indent-tabs-mode: nil
 255  * End:
 256  * vim: shiftwidth=4 tabstop=8 expandtab
 257  */