- clean up repo parsing code
[platform/upstream/libsolv.git] / ext / repo_products.c
1 /*
2  * repo_products.c
3  *
4  * Parses all files below 'proddir'
5  * See http://en.opensuse.org/Product_Management/Code11
6  *
7  *
8  * Copyright (c) 2008, Novell Inc.
9  *
10  * This program is licensed under the BSD license, read LICENSE.BSD
11  * for further information
12  */
13
14 #include <sys/types.h>
15 #include <sys/stat.h>
16 #include <unistd.h>
17 #include <limits.h>
18 #include <fcntl.h>
19 #include <ctype.h>
20 #include <stdio.h>
21 #include <stdlib.h>
22 #include <string.h>
23 #include <assert.h>
24 #include <dirent.h>
25 #include <expat.h>
26
27 #include "pool.h"
28 #include "repo.h"
29 #include "util.h"
30 #define DISABLE_SPLIT
31 #include "tools_util.h"
32 #include "repo_content.h"
33 #include "repo_zyppdb.h"
34 #include "repo_releasefile_products.h"
35
36
37 //#define DUMPOUT 0
38
39 enum state {
40   STATE_START,           // 0
41   STATE_PRODUCT,         // 1
42   STATE_VENDOR,          // 2
43   STATE_NAME,            // 3
44   STATE_VERSION,         // 4
45   STATE_RELEASE,         // 5
46   STATE_ARCH,            // 6
47   STATE_SUMMARY,         // 7
48   STATE_SHORTSUMMARY,
49   STATE_DESCRIPTION,     // 8
50   STATE_UPDATEREPOKEY,   // 9 should go away
51   STATE_CPEID,         // 9
52   STATE_URLS,            // 10
53   STATE_URL,             // 11
54   STATE_RUNTIMECONFIG,   // 12
55   STATE_LINGUAS,         // 13
56   STATE_LANG,            // 14
57   STATE_REGISTER,        // 15
58   STATE_TARGET,          // 16
59   STATE_REGRELEASE,      // 18
60   STATE_PRODUCTLINE,     // 19
61   NUMSTATES              // 0
62 };
63
64 struct stateswitch {
65   enum state from;
66   char *ename;
67   enum state to;
68   int docontent;
69 };
70
71 /* !! must be sorted by first column !! */
72 static struct stateswitch stateswitches[] = {
73   { STATE_START,     "product",       STATE_PRODUCT,       0 },
74   { STATE_PRODUCT,   "vendor",        STATE_VENDOR,        1 },
75   { STATE_PRODUCT,   "name",          STATE_NAME,          1 },
76   { STATE_PRODUCT,   "version",       STATE_VERSION,       1 },
77   { STATE_PRODUCT,   "release",       STATE_RELEASE,       1 },
78   { STATE_PRODUCT,   "arch",          STATE_ARCH,          1 },
79   { STATE_PRODUCT,   "productline",   STATE_PRODUCTLINE,   1 },
80   { STATE_PRODUCT,   "summary",       STATE_SUMMARY,       1 },
81   { STATE_PRODUCT,   "shortsummary",  STATE_SHORTSUMMARY,  1 },
82   { STATE_PRODUCT,   "description",   STATE_DESCRIPTION,   1 },
83   { STATE_PRODUCT,   "register",      STATE_REGISTER,      0 },
84   { STATE_PRODUCT,   "urls",          STATE_URLS,          0 },
85   { STATE_PRODUCT,   "runtimeconfig", STATE_RUNTIMECONFIG, 0 },
86   { STATE_PRODUCT,   "linguas",       STATE_LINGUAS,       0 },
87   { STATE_PRODUCT,   "updaterepokey", STATE_UPDATEREPOKEY, 1 },
88   { STATE_PRODUCT,   "cpeid",         STATE_CPEID,         1 },
89   { STATE_URLS,      "url",           STATE_URL,           1 },
90   { STATE_LINGUAS,   "lang",          STATE_LANG,          0 },
91   { STATE_REGISTER,  "target",        STATE_TARGET,        1 },
92   { STATE_REGISTER,  "release",       STATE_REGRELEASE,    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
115   const char *tmpvers;
116   const char *tmprel;
117   const char *tmpurltype;
118
119   unsigned int ctime;
120
121   Solvable *solvable;
122   Id handle;
123
124   ino_t baseproduct;
125   ino_t currentproduct;
126   int productscheme;
127 };
128
129
130 /*
131  * find_attr
132  * find value for xml attribute
133  * I: txt, name of attribute
134  * I: atts, list of key/value attributes
135  * I: dup, strdup it
136  * O: pointer to value of matching key, or NULL
137  *
138  */
139
140 static inline const char *
141 find_attr(const char *txt, const char **atts, int dup)
142 {
143   for (; *atts; atts += 2)
144     {
145       if (!strcmp(*atts, txt))
146         return dup ? solv_strdup(atts[1]) : atts[1];
147     }
148   return 0;
149 }
150
151
152 /*
153  * XML callback: startElement
154  */
155
156 static void XMLCALL
157 startElement(void *userData, const char *name, const char **atts)
158 {
159   struct parsedata *pd = userData;
160   Pool *pool = pd->pool;
161   Solvable *s = pd->solvable;
162   struct stateswitch *sw;
163
164 #if 0
165       fprintf(stderr, "start: [%d]%s\n", pd->state, name);
166 #endif
167   if (pd->depth != pd->statedepth)
168     {
169       pd->depth++;
170       return;
171     }
172
173   pd->depth++;
174   if (!pd->swtab[pd->state])    /* no statetable -> no substates */
175     {
176 #if 0
177       fprintf(stderr, "into unknown: %s (from: %d)\n", name, pd->state);
178 #endif
179       return;
180     }
181   for (sw = pd->swtab[pd->state]; sw->from == pd->state; sw++)  /* find name in statetable */
182     if (!strcmp(sw->ename, name))
183       break;
184
185   if (sw->from != pd->state)
186     {
187 #if 0
188       fprintf(stderr, "into unknown: %s (from: %d)\n", name, pd->state);
189 #endif
190       return;
191     }
192   pd->state = sw->to;
193   pd->docontent = sw->docontent;
194   pd->statedepth = pd->depth;
195   pd->lcontent = 0;
196   *pd->content = 0;
197
198   switch(pd->state)
199     {
200     case STATE_PRODUCT:
201       /* parse 'schemeversion' and store in global variable */
202       {
203         const char * scheme = find_attr("schemeversion", atts, 0);
204         pd->productscheme = (scheme && *scheme) ? atoi(scheme) : -1;
205       }
206       if (!s)
207         {
208           s = pd->solvable = pool_id2solvable(pool, repo_add_solvable(pd->repo));
209           pd->handle = s - pool->solvables;
210         }
211       break;
212
213       /* <summary lang="xy">... */
214     case STATE_SUMMARY:
215       pd->tmplang = find_attr("lang", atts, 1);
216       break;
217     case STATE_DESCRIPTION:
218       pd->tmplang = find_attr("lang", atts, 1);
219       break;
220     case STATE_URL:
221       pd->tmpurltype = find_attr("name", atts, 1);
222       break;
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
235 #if 0
236       fprintf(stderr, "end: [%d]%s\n", pd->state, name);
237 #endif
238   if (pd->depth != pd->statedepth)
239     {
240       pd->depth--;
241 #if 0
242       fprintf(stderr, "back from unknown %d %d %d\n", pd->state, pd->depth, pd->statedepth);
243 #endif
244       return;
245     }
246
247   pd->depth--;
248   pd->statedepth--;
249
250   switch (pd->state)
251     {
252     case STATE_PRODUCT:
253       /* product done, finish solvable */
254       if (pd->ctime)
255         repodata_set_num(pd->data, pd->handle, SOLVABLE_INSTALLTIME, pd->ctime);
256
257       if (pd->basename)
258         repodata_set_str(pd->data, pd->handle, PRODUCT_REFERENCEFILE, pd->basename);
259
260       /* this is where <productsdir>/baseproduct points to */
261       if (pd->currentproduct == pd->baseproduct)
262         repodata_set_str(pd->data, pd->handle, PRODUCT_TYPE, "base");
263
264       if (pd->tmprel)
265         {
266           if (pd->tmpvers)
267             s->evr = makeevr(pd->pool, join2(pd->tmpvers, "-", pd->tmprel));
268           else
269             {
270               fprintf(stderr, "Seen <release> but no <version>\n");
271             }
272         }
273       else if (pd->tmpvers)
274         s->evr = makeevr(pd->pool, pd->tmpvers); /* just version, no release */
275       pd->tmpvers = solv_free((void *)pd->tmpvers);
276       pd->tmprel = solv_free((void *)pd->tmprel);
277       if (!s->arch)
278         s->arch = ARCH_NOARCH;
279       if (!s->evr)
280         s->evr = ID_EMPTY;
281       if (s->name && s->arch != ARCH_SRC && s->arch != ARCH_NOSRC)
282         s->provides = repo_addid_dep(pd->repo, s->provides, pool_rel2id(pd->pool, s->name, s->evr, REL_EQ, 1), 0);
283       pd->solvable = 0;
284       break;
285     case STATE_VENDOR:
286       s->vendor = pool_str2id(pd->pool, pd->content, 1);
287       break;
288     case STATE_NAME:
289       s->name = pool_str2id(pd->pool, join2("product", ":", pd->content), 1);
290       break;
291     case STATE_VERSION:
292       pd->tmpvers = solv_strdup(pd->content);
293       break;
294     case STATE_RELEASE:
295       pd->tmprel = solv_strdup(pd->content);
296       break;
297     case STATE_ARCH:
298       s->arch = pool_str2id(pd->pool, pd->content, 1);
299       break;
300     case STATE_PRODUCTLINE:
301       repodata_set_str(pd->data, pd->handle, PRODUCT_PRODUCTLINE, pd->content);
302     break;
303     case STATE_UPDATEREPOKEY:
304       /** obsolete **/
305       break;
306     case STATE_SUMMARY:
307       repodata_set_str(pd->data, pd->handle, pool_id2langid(pd->pool, SOLVABLE_SUMMARY, pd->tmplang, 1), pd->content);
308       pd->tmplang = solv_free((void *)pd->tmplang);
309       break;
310     case STATE_SHORTSUMMARY:
311       repodata_set_str(pd->data, pd->handle, PRODUCT_SHORTLABEL, pd->content);
312       break;
313     case STATE_DESCRIPTION:
314       repodata_set_str(pd->data, pd->handle, pool_id2langid(pd->pool, SOLVABLE_DESCRIPTION, pd->tmplang, 1), pd->content);
315       pd->tmplang = solv_free((void *)pd->tmplang);
316       break;
317     case STATE_URL:
318       if (pd->tmpurltype)
319         {
320           repodata_add_poolstr_array(pd->data, pd->handle, PRODUCT_URL, pd->content);
321           repodata_add_idarray(pd->data, pd->handle, PRODUCT_URL_TYPE, pool_str2id(pd->pool, pd->tmpurltype, 1));
322         }
323       pd->tmpurltype = solv_free((void *)pd->tmpurltype);
324       break;
325     case STATE_TARGET:
326       repodata_set_str(pd->data, pd->handle, PRODUCT_REGISTER_TARGET, pd->content);
327       break;
328     case STATE_REGRELEASE:
329       repodata_set_str(pd->data, pd->handle, PRODUCT_REGISTER_RELEASE, pd->content);
330       break;
331     case STATE_CPEID:
332       if (pd->content)
333         repodata_set_str(pd->data, pd->handle, SOLVABLE_CPEID, pd->content);
334     default:
335       break;
336     }
337
338   pd->state = pd->sbtab[pd->state];
339   pd->docontent = 0;
340
341 #if 0
342       fprintf(stderr, "end: [%s] -> %d\n", name, pd->state);
343 #endif
344 }
345
346
347 static void XMLCALL
348 characterData(void *userData, const XML_Char *s, int len)
349 {
350   struct parsedata *pd = userData;
351   int l;
352   char *c;
353   if (!pd->docontent)
354     return;
355   l = pd->lcontent + len + 1;
356   if (l > pd->acontent)
357     {
358       pd->content = solv_realloc(pd->content, l + 256);
359       pd->acontent = l + 256;
360     }
361   c = pd->content + pd->lcontent;
362   pd->lcontent += len;
363   while (len-- > 0)
364     *c++ = *s++;
365   *c = 0;
366 }
367
368 #define BUFF_SIZE 8192
369
370
371 /*
372  * add single product to repo
373  *
374  */
375
376 static void
377 add_code11_product(struct parsedata *pd, FILE *fp)
378 {
379   char buf[BUFF_SIZE];
380   int l;
381   struct stat st;
382   XML_Parser parser;
383
384   if (!fstat(fileno(fp), &st))
385     {
386       pd->currentproduct = st.st_ino;
387       pd->ctime = (unsigned int)st.st_ctime;
388     }
389   else
390     {
391       pd->currentproduct = pd->baseproduct + 1; /* make it != baseproduct if stat fails */
392       perror("fstat");
393       pd->ctime = 0;
394     }
395
396   parser = XML_ParserCreate(NULL);
397   XML_SetUserData(parser, pd);
398   XML_SetElementHandler(parser, startElement, endElement);
399   XML_SetCharacterDataHandler(parser, characterData);
400
401   for (;;)
402     {
403       l = fread(buf, 1, sizeof(buf), fp);
404       if (XML_Parse(parser, buf, l, l == 0) == XML_STATUS_ERROR)
405         {
406           pool_debug(pd->pool, SOLV_ERROR, "%s: %s at line %u:%u\n", pd->filename, XML_ErrorString(XML_GetErrorCode(parser)), (unsigned int)XML_GetCurrentLineNumber(parser), (unsigned int)XML_GetCurrentColumnNumber(parser));
407           pool_debug(pd->pool, SOLV_ERROR, "skipping this product\n");
408           XML_ParserFree(parser);
409           return;
410         }
411       if (l == 0)
412         break;
413     }
414   XML_ParserFree(parser);
415 }
416
417
418 void
419 repo_add_code11_products(Repo *repo, const char *dirpath, int flags)
420 {
421   Repodata *data;
422   struct parsedata pd;
423   struct stateswitch *sw;
424   DIR *dir;
425   int i;
426
427   data = repo_add_repodata(repo, flags);
428
429   memset(&pd, 0, sizeof(pd));
430   pd.repo = repo;
431   pd.pool = repo->pool;
432   pd.data = data;
433
434   pd.content = solv_malloc(256);
435   pd.acontent = 256;
436
437   for (i = 0, sw = stateswitches; sw->from != NUMSTATES; i++, sw++)
438     {
439       if (!pd.swtab[sw->from])
440         pd.swtab[sw->from] = sw;
441       pd.sbtab[sw->to] = sw->from;
442     }
443
444   dir = opendir(dirpath);
445   if (dir)
446     {
447       struct dirent *entry;
448       struct stat st;
449       char *fullpath;
450
451       /* check for <productsdir>/baseproduct on code11 and remember its target inode */
452       if (stat(join2(dirpath, "/", "baseproduct"), &st) == 0) /* follow symlink */
453         pd.baseproduct = st.st_ino;
454       else
455         pd.baseproduct = 0;
456
457       while ((entry = readdir(dir)))
458         {
459           int len = strlen(entry->d_name);
460           FILE *fp;
461           if (len <= 5 || strcmp(entry->d_name + len - 5, ".prod") != 0)
462             continue;
463           fullpath = join2(dirpath, "/", entry->d_name);
464           fp = fopen(fullpath, "r");
465           if (!fp)
466             {
467               perror(fullpath);
468               continue;
469             }
470           pd.filename = fullpath;
471           pd.basename = entry->d_name;
472           add_code11_product(&pd, fp);
473           fclose(fp);
474         }
475       closedir(dir);
476     }
477   solv_free((void *)pd.tmplang);
478   solv_free(pd.content);
479   join_freemem();
480
481   if (!(flags & REPO_NO_INTERNALIZE))
482     repodata_internalize(data);
483 }
484
485
486 /******************************************************************************************/
487
488
489 /*
490  * read all installed products
491  *
492  * try proddir (reading all .xml files from this directory) first
493  * if not available, assume non-code11 layout and parse /etc/xyz-release
494  *
495  * parse each one as a product
496  */
497
498 /* Oh joy! Three parsers for the price of one! */
499
500 void
501 repo_add_products(Repo *repo, const char *proddir, const char *root, int flags)
502 {
503   const char *fullpath;
504   DIR *dir;
505
506   dir = opendir(proddir);
507   if (dir)
508     {
509       /* assume code11 stype products */
510       closedir(dir);
511       repo_add_code11_products(repo, proddir, flags);
512       return;
513     }
514
515   /* code11 didn't work, try old zyppdb */
516   fullpath = root ? join2(root, "", "/var/lib/zypp/db/products") : "/var/lib/zypp/db/products";
517   dir = opendir(fullpath);
518   if (dir)
519     {
520       closedir(dir);
521       /* assume code10 style products */
522       repo_add_zyppdb_products(repo, fullpath, flags);
523       join_freemem();
524       return;
525     }
526
527   /* code11 didn't work, try -release files parsing */
528   fullpath = root ? join2(root, "", "/etc") : "/etc";
529   dir = opendir(fullpath);
530   if (dir)
531     {
532       closedir(dir);
533       repo_add_releasefile_products(repo, fullpath, flags);
534       join_freemem();
535       return;
536     }
537
538   /* no luck. print an error message in case the root argument is wrong */
539   perror(fullpath);
540   join_freemem();
541
542   /* the least we can do... */
543   if (!(flags & REPO_NO_INTERNALIZE) && (flags & REPO_REUSE_REPODATA) != 0)
544     repodata_internalize(repo_last_repodata(repo));
545 }
546
547 /* EOF */