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   const char *filename;
  98   const char *basename;
  99   int depth;
 100   enum state state;
 101   int statedepth;
 102   char *content;
 103   int lcontent;
 104   int acontent;
 105   int docontent;
 106   Pool *pool;
 107   Repo *repo;
 108   Repodata *data;
 109
 110   struct stateswitch *swtab[NUMSTATES];
 111   enum state sbtab[NUMSTATES];
 112
 113   const char *tmplang;
 114   Id reqtype;
 115   Id condreq;
 116
 117   Solvable *solvable;
 118   Id handle;
 119 };
 120
 121
 122 /*
 123  * find_attr
 124  * find value for xml attribute
 125  * I: txt, name of attribute
 126  * I: atts, list of key/value attributes
 127  * I: dup, strdup it
 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, int dup)
 134 {
 135   for (; *atts; atts += 2)
 136     {
 137       if (!strcmp(*atts, txt))
 138         return dup ? solv_strdup(atts[1]) : 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       pd->tmplang = find_attr("xml:lang", atts, 1);
 203       break;
 204
 205     case STATE_PACKAGEREQ:
 206       {
 207         const char *type = find_attr("type", atts, 0);
 208         pd->condreq = 0;
 209         pd->reqtype = SOLVABLE_RECOMMENDS;
 210         if (type && !strcmp(type, "conditional"))
 211           {
 212             const char *requires = find_attr("requires", atts, 0);
 213             if (requires && *requires)
 214               pd->condreq = pool_str2id(pool, requires, 1);
 215           }
 216         else if (type && !strcmp(type, "mandatory"))
 217           pd->reqtype = SOLVABLE_REQUIRES;
 218         else if (type && !strcmp(type, "optional"))
 219           pd->reqtype = SOLVABLE_SUGGESTS;
 220         break;
 221       }
 222
 223     default:
 224       break;
 225     }
 226 }
 227
 228
 229 static void XMLCALL
 230 endElement(void *userData, const char *name)
 231 {
 232   struct parsedata *pd = userData;
 233   Solvable *s = pd->solvable;
 234   Id id;
 235
 236 #if 0
 237       fprintf(stderr, "end: [%d]%s\n", pd->state, name);
 238 #endif
 239   if (pd->depth != pd->statedepth)
 240     {
 241       pd->depth--;
 242 #if 0
 243       fprintf(stderr, "back from unknown %d %d %d\n", pd->state, pd->depth, pd->statedepth);
 244 #endif
 245       return;
 246     }
 247
 248   pd->depth--;
 249   pd->statedepth--;
 250
 251   switch (pd->state)
 252     {
 253     case STATE_GROUP:
 254     case STATE_CATEGORY:
 255       if (!s->arch)
 256         s->arch = ARCH_NOARCH;
 257       if (!s->evr)
 258         s->evr = ID_EMPTY;
 259       if (s->name && s->arch != ARCH_SRC && s->arch != ARCH_NOSRC)
 260         s->provides = repo_addid_dep(pd->repo, s->provides, pool_rel2id(pd->pool, s->name, s->evr, REL_EQ, 1), 0);
 261       pd->solvable = 0;
 262       break;
 263
 264     case STATE_ID:
 265     case STATE_CID:
 266       s->name = pool_str2id(pd->pool, join2("pattern", ":", pd->content), 1);
 267       break;
 268
 269     case STATE_NAME:
 270     case STATE_CNAME:
 271       repodata_set_str(pd->data, pd->handle, pool_id2langid(pd->pool, SOLVABLE_SUMMARY, pd->tmplang, 1), pd->content);
 272       pd->tmplang = solv_free((void *)pd->tmplang);
 273       break;
 274
 275     case STATE_DESCRIPTION:
 276     case STATE_CDESCRIPTION:
 277       repodata_set_str(pd->data, pd->handle, pool_id2langid(pd->pool, SOLVABLE_DESCRIPTION, pd->tmplang, 1), pd->content);
 278       pd->tmplang = solv_free((void *)pd->tmplang);
 279       break;
 280
 281     case STATE_PACKAGEREQ:
 282       id = pool_str2id(pd->pool, pd->content, 1);
 283       if (pd->condreq)
 284         id = pool_rel2id(pd->pool, id, pd->condreq, REL_COND, 1);
 285       repo_add_idarray(pd->repo, pd->handle, pd->reqtype, id);
 286       break;
 287
 288     case STATE_GROUPID:
 289       id = pool_str2id(pd->pool, join2("pattern", ":", pd->content), 1);
 290       s->requires = repo_addid_dep(pd->repo, s->requires, id, 0);
 291       break;
 292
 293     case STATE_USERVISIBLE:
 294       repodata_set_void(pd->data, pd->handle, SOLVABLE_ISVISIBLE);
 295       break;
 296
 297     case STATE_DISPLAY_ORDER:
 298     case STATE_CDISPLAY_ORDER:
 299       repodata_set_str(pd->data, pd->handle, SOLVABLE_ORDER, pd->content);
 300       break;
 301
 302     case STATE_DEFAULT:
 303       break;
 304
 305     case STATE_LANGONLY:
 306     case STATE_LANG_ONLY:
 307       break;
 308
 309     default:
 310       break;
 311     }
 312
 313   pd->state = pd->sbtab[pd->state];
 314   pd->docontent = 0;
 315
 316 #if 0
 317       fprintf(stderr, "end: [%s] -> %d\n", name, pd->state);
 318 #endif
 319 }
 320
 321
 322 static void XMLCALL
 323 characterData(void *userData, const XML_Char *s, int len)
 324 {
 325   struct parsedata *pd = userData;
 326   int l;
 327   char *c;
 328   if (!pd->docontent)
 329     return;
 330   l = pd->lcontent + len + 1;
 331   if (l > pd->acontent)
 332     {
 333       pd->content = solv_realloc(pd->content, l + 256);
 334       pd->acontent = l + 256;
 335     }
 336   c = pd->content + pd->lcontent;
 337   pd->lcontent += len;
 338   while (len-- > 0)
 339     *c++ = *s++;
 340   *c = 0;
 341 }
 342
 343 #define BUFF_SIZE 8192
 344
 345
 346 int
 347 repo_add_comps(Repo *repo, FILE *fp, int flags)
 348 {
 349   Repodata *data;
 350   struct parsedata pd;
 351   char buf[BUFF_SIZE];
 352   int i, l;
 353   struct stateswitch *sw;
 354   XML_Parser parser;
 355
 356   data = repo_add_repodata(repo, flags);
 357
 358   memset(&pd, 0, sizeof(pd));
 359   pd.repo = repo;
 360   pd.pool = repo->pool;
 361   pd.data = data;
 362
 363   pd.content = solv_malloc(256);
 364   pd.acontent = 256;
 365
 366   for (i = 0, sw = stateswitches; sw->from != NUMSTATES; i++, sw++)
 367     {
 368       if (!pd.swtab[sw->from])
 369         pd.swtab[sw->from] = sw;
 370       pd.sbtab[sw->to] = sw->from;
 371     }
 372
 373   parser = XML_ParserCreate(NULL);
 374   XML_SetUserData(parser, &pd);
 375   XML_SetElementHandler(parser, startElement, endElement);
 376   XML_SetCharacterDataHandler(parser, characterData);
 377   for (;;)
 378     {
 379       l = fread(buf, 1, sizeof(buf), fp);
 380       if (XML_Parse(parser, buf, l, l == 0) == XML_STATUS_ERROR)
 381         {
 382           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));
 383           break;
 384         }
 385       if (l == 0)
 386         break;
 387     }
 388   XML_ParserFree(parser);
 389
 390   solv_free((void *)pd.tmplang);
 391   solv_free(pd.content);
 392   join_freemem();
 393
 394   if (!(flags & REPO_NO_INTERNALIZE))
 395     repodata_internalize(data);
 396   return 0;
 397 }
 398
 399 /* EOF */