ext/repo_comps.c

   1 /*
   2  * repo_comps.c
   3  *
   4  * Parses RedHat comps format
   5  *
   6  * Copyright (c) 2012, Novell Inc.
   7  *
   8  * This program is licensed under the BSD license, read LICENSE.BSD
   9  * for further information
  10  */
  11
  12 #include <sys/types.h>
  13 #include <sys/stat.h>
  14 #include <unistd.h>
  15 #include <limits.h>
  16 #include <fcntl.h>
  17 #include <ctype.h>
  18 #include <stdio.h>
  19 #include <stdlib.h>
  20 #include <string.h>
  21 #include <assert.h>
  22 #include <dirent.h>
  23 #include <expat.h>
  24
  25 #include "pool.h"
  26 #include "repo.h"
  27 #include "util.h"
  28 #define DISABLE_SPLIT
  29 #include "tools_util.h"
  30 #include "repo_comps.h"
  31
  32 /*
  33  * TODO:
  34  *
  35  * what's the difference between group/category?
  36  * handle "default" and "langonly".
  37  *
  38  * maybe handle REL_COND in solver recommends handling?
  39  */
  40
  41 enum state {
  42   STATE_START,
  43   STATE_COMPS,
  44   STATE_GROUP,
  45   STATE_ID,
  46   STATE_NAME,
  47   STATE_DESCRIPTION,
  48   STATE_DISPLAY_ORDER,
  49   STATE_DEFAULT,
  50   STATE_LANGONLY,
  51   STATE_LANG_ONLY,
  52   STATE_USERVISIBLE,
  53   STATE_PACKAGELIST,
  54   STATE_PACKAGEREQ,
  55   STATE_CATEGORY,
  56   STATE_CID,
  57   STATE_CNAME,
  58   STATE_CDESCRIPTION,
  59   STATE_CDISPLAY_ORDER,
  60   STATE_GROUPLIST,
  61   STATE_GROUPID,
  62   NUMSTATES
  63 };
  64
  65 struct stateswitch {
  66   enum state from;
  67   char *ename;
  68   enum state to;
  69   int docontent;
  70 };
  71
  72 /* must be sorted by first column */
  73 static struct stateswitch stateswitches[] = {
  74   { STATE_START,       "comps",         STATE_COMPS,         0 },
  75   { STATE_COMPS,       "group",         STATE_GROUP,         0 },
  76   { STATE_COMPS,       "category",      STATE_CATEGORY,      0 },
  77   { STATE_GROUP,       "id",            STATE_ID,            1 },
  78   { STATE_GROUP,       "name",          STATE_NAME,          1 },
  79   { STATE_GROUP,       "description",   STATE_DESCRIPTION,   1 },
  80   { STATE_GROUP,       "uservisible",   STATE_USERVISIBLE,   1 },
  81   { STATE_GROUP,       "display_order", STATE_DISPLAY_ORDER, 1 },
  82   { STATE_GROUP,       "default",       STATE_DEFAULT,       1 },
  83   { STATE_GROUP,       "langonly",      STATE_LANGONLY,      1 },
  84   { STATE_GROUP,       "lang_only",     STATE_LANG_ONLY,     1 },
  85   { STATE_GROUP,       "packagelist",   STATE_PACKAGELIST,   0 },
  86   { STATE_PACKAGELIST, "packagereq",    STATE_PACKAGEREQ,    1 },
  87   { STATE_CATEGORY,    "id",            STATE_CID,           1 },
  88   { STATE_CATEGORY,    "name",          STATE_CNAME,         1 },
  89   { STATE_CATEGORY,    "description",   STATE_CDESCRIPTION,  1 },
  90   { STATE_CATEGORY ,   "grouplist",     STATE_GROUPLIST,     0 },
  91   { STATE_CATEGORY ,   "display_order", STATE_CDISPLAY_ORDER, 1 },
  92   { STATE_GROUPLIST,   "groupid",       STATE_GROUPID,       1 },
  93   { NUMSTATES }
  94 };
  95
  96 struct parsedata {
  97   Pool *pool;
  98   Repo *repo;
  99   Repodata *data;
 100   const char *filename;
 101   const char *basename;
 102   int depth;
 103   enum state state;
 104   int statedepth;
 105   char *content;
 106   int lcontent;
 107   int acontent;
 108   int docontent;
 109
 110   struct stateswitch *swtab[NUMSTATES];
 111   enum state sbtab[NUMSTATES];
 112   struct joindata jd;
 113
 114   const char *tmplang;
 115   Id reqtype;
 116   Id condreq;
 117
 118   Solvable *solvable;
 119   Id handle;
 120 };
 121
 122
 123 /*
 124  * find_attr
 125  * find value for xml attribute
 126  * I: txt, name of attribute
 127  * I: atts, list of key/value attributes
 128  * O: pointer to value of matching key, or NULL
 129  *
 130  */
 131
 132 static inline const char *
 133 find_attr(const char *txt, const char **atts)
 134 {
 135   for (; *atts; atts += 2)
 136     {
 137       if (!strcmp(*atts, txt))
 138         return atts[1];
 139     }
 140   return 0;
 141 }
 142
 143
 144 /*
 145  * XML callback: startElement
 146  */
 147
 148 static void XMLCALL
 149 startElement(void *userData, const char *name, const char **atts)
 150 {
 151   struct parsedata *pd = userData;
 152   Pool *pool = pd->pool;
 153   Solvable *s = pd->solvable;
 154   struct stateswitch *sw;
 155
 156 #if 0
 157       fprintf(stderr, "start: [%d]%s\n", pd->state, name);
 158 #endif
 159   if (pd->depth != pd->statedepth)
 160     {
 161       pd->depth++;
 162       return;
 163     }
 164
 165   pd->depth++;
 166   if (!pd->swtab[pd->state])    /* no statetable -> no substates */
 167     {
 168 #if 0
 169       fprintf(stderr, "into unknown: %s (from: %d)\n", name, pd->state);
 170 #endif
 171       return;
 172     }
 173   for (sw = pd->swtab[pd->state]; sw->from == pd->state; sw++)  /* find name in statetable */
 174     if (!strcmp(sw->ename, name))
 175       break;
 176
 177   if (sw->from != pd->state)
 178     {
 179 #if 0
 180       fprintf(stderr, "into unknown: %s (from: %d)\n", name, pd->state);
 181 #endif
 182       return;
 183     }
 184   pd->state = sw->to;
 185   pd->docontent = sw->docontent;
 186   pd->statedepth = pd->depth;
 187   pd->lcontent = 0;
 188   *pd->content = 0;
 189
 190   switch(pd->state)
 191     {
 192     case STATE_GROUP:
 193     case STATE_CATEGORY:
 194       s = pd->solvable = pool_id2solvable(pool, repo_add_solvable(pd->repo));
 195       pd->handle = s - pool->solvables;
 196       break;
 197
 198     case STATE_NAME:
 199     case STATE_CNAME:
 200     case STATE_DESCRIPTION:
 201     case STATE_CDESCRIPTION:
 202       {
 203         const char *lang = find_attr("xml:lang", atts);
 204         pd->tmplang = lang ? join2(&pd->jd, lang, 0, 0) : 0;
 205         break;
 206       }
 207
 208     case STATE_PACKAGEREQ:
 209       {
 210         const char *type = find_attr("type", atts);
 211         pd->condreq = 0;
 212         pd->reqtype = SOLVABLE_RECOMMENDS;
 213         if (type && !strcmp(type, "conditional"))
 214           {
 215             const char *requires = find_attr("requires", atts);
 216             if (requires && *requires)
 217               pd->condreq = pool_str2id(pool, requires, 1);
 218           }
 219         else if (type && !strcmp(type, "mandatory"))
 220           pd->reqtype = SOLVABLE_REQUIRES;
 221         else if (type && !strcmp(type, "optional"))
 222           pd->reqtype = SOLVABLE_SUGGESTS;
 223         break;
 224       }
 225
 226     default:
 227       break;
 228     }
 229 }
 230
 231
 232 static void XMLCALL
 233 endElement(void *userData, const char *name)
 234 {
 235   struct parsedata *pd = userData;
 236   Solvable *s = pd->solvable;
 237   Id id;
 238
 239 #if 0
 240       fprintf(stderr, "end: [%d]%s\n", pd->state, name);
 241 #endif
 242   if (pd->depth != pd->statedepth)
 243     {
 244       pd->depth--;
 245 #if 0
 246       fprintf(stderr, "back from unknown %d %d %d\n", pd->state, pd->depth, pd->statedepth);
 247 #endif
 248       return;
 249     }
 250
 251   pd->depth--;
 252   pd->statedepth--;
 253
 254   switch (pd->state)
 255     {
 256     case STATE_GROUP:
 257     case STATE_CATEGORY:
 258       if (!s->arch)
 259         s->arch = ARCH_NOARCH;
 260       if (!s->evr)
 261         s->evr = ID_EMPTY;
 262       if (s->name && s->arch != ARCH_SRC && s->arch != ARCH_NOSRC)
 263         s->provides = repo_addid_dep(pd->repo, s->provides, pool_rel2id(pd->pool, s->name, s->evr, REL_EQ, 1), 0);
 264       pd->solvable = 0;
 265       break;
 266
 267     case STATE_ID:
 268     case STATE_CID:
 269       s->name = pool_str2id(pd->pool, join2(&pd->jd, "pattern", ":", pd->content), 1);
 270       break;
 271
 272     case STATE_NAME:
 273     case STATE_CNAME:
 274       repodata_set_str(pd->data, pd->handle, pool_id2langid(pd->pool, SOLVABLE_SUMMARY, pd->tmplang, 1), pd->content);
 275       break;
 276
 277     case STATE_DESCRIPTION:
 278     case STATE_CDESCRIPTION:
 279       repodata_set_str(pd->data, pd->handle, pool_id2langid(pd->pool, SOLVABLE_DESCRIPTION, pd->tmplang, 1), pd->content);
 280       break;
 281
 282     case STATE_PACKAGEREQ:
 283       id = pool_str2id(pd->pool, pd->content, 1);
 284       if (pd->condreq)
 285         id = pool_rel2id(pd->pool, id, pd->condreq, REL_COND, 1);
 286       repo_add_idarray(pd->repo, pd->handle, pd->reqtype, id);
 287       break;
 288
 289     case STATE_GROUPID:
 290       id = pool_str2id(pd->pool, join2(&pd->jd, "pattern", ":", pd->content), 1);
 291       s->requires = repo_addid_dep(pd->repo, s->requires, id, 0);
 292       break;
 293
 294     case STATE_USERVISIBLE:
 295       repodata_set_void(pd->data, pd->handle, SOLVABLE_ISVISIBLE);
 296       break;
 297
 298     case STATE_DISPLAY_ORDER:
 299     case STATE_CDISPLAY_ORDER:
 300       repodata_set_str(pd->data, pd->handle, SOLVABLE_ORDER, pd->content);
 301       break;
 302
 303     case STATE_DEFAULT:
 304       break;
 305
 306     case STATE_LANGONLY:
 307     case STATE_LANG_ONLY:
 308       break;
 309
 310     default:
 311       break;
 312     }
 313
 314   pd->state = pd->sbtab[pd->state];
 315   pd->docontent = 0;
 316
 317 #if 0
 318       fprintf(stderr, "end: [%s] -> %d\n", name, pd->state);
 319 #endif
 320 }
 321
 322
 323 static void XMLCALL
 324 characterData(void *userData, const XML_Char *s, int len)
 325 {
 326   struct parsedata *pd = userData;
 327   int l;
 328   char *c;
 329   if (!pd->docontent)
 330     return;
 331   l = pd->lcontent + len + 1;
 332   if (l > pd->acontent)
 333     {
 334       pd->content = solv_realloc(pd->content, l + 256);
 335       pd->acontent = l + 256;
 336     }
 337   c = pd->content + pd->lcontent;
 338   pd->lcontent += len;
 339   while (len-- > 0)
 340     *c++ = *s++;
 341   *c = 0;
 342 }
 343
 344 #define BUFF_SIZE 8192
 345
 346
 347 int
 348 repo_add_comps(Repo *repo, FILE *fp, int flags)
 349 {
 350   Repodata *data;
 351   struct parsedata pd;
 352   char buf[BUFF_SIZE];
 353   int i, l;
 354   struct stateswitch *sw;
 355   XML_Parser parser;
 356
 357   data = repo_add_repodata(repo, flags);
 358
 359   memset(&pd, 0, sizeof(pd));
 360   pd.repo = repo;
 361   pd.pool = repo->pool;
 362   pd.data = data;
 363
 364   pd.content = solv_malloc(256);
 365   pd.acontent = 256;
 366
 367   for (i = 0, sw = stateswitches; sw->from != NUMSTATES; i++, sw++)
 368     {
 369       if (!pd.swtab[sw->from])
 370         pd.swtab[sw->from] = sw;
 371       pd.sbtab[sw->to] = sw->from;
 372     }
 373
 374   parser = XML_ParserCreate(NULL);
 375   XML_SetUserData(parser, &pd);
 376   XML_SetElementHandler(parser, startElement, endElement);
 377   XML_SetCharacterDataHandler(parser, characterData);
 378   for (;;)
 379     {
 380       l = fread(buf, 1, sizeof(buf), fp);
 381       if (XML_Parse(parser, buf, l, l == 0) == XML_STATUS_ERROR)
 382         {
 383           pool_debug(pd.pool, SOLV_ERROR, "%s at line %u:%u\n", XML_ErrorString(XML_GetErrorCode(parser)), (unsigned int)XML_GetCurrentLineNumber(parser), (unsigned int)XML_GetCurrentColumnNumber(parser));
 384           break;
 385         }
 386       if (l == 0)
 387         break;
 388     }
 389   XML_ParserFree(parser);
 390
 391   solv_free(pd.content);
 392   join_freemem(&pd.jd);
 393
 394   if (!(flags & REPO_NO_INTERNALIZE))
 395     repodata_internalize(data);
 396   return 0;
 397 }
 398
 399 /* EOF */