4 * Parses AppSteam Data files.
5 * See http://people.freedesktop.org/~hughsient/appdata/
8 * Copyright (c) 2013, Novell Inc.
10 * This program is licensed under the BSD license, read LICENSE.BSD
11 * for further information
14 #include <sys/types.h>
31 #include "repo_appdata.h"
63 /* !! must be sorted by first column !! */
64 static struct stateswitch stateswitches[] = {
65 { STATE_START, "applications", STATE_START, 0 },
66 { STATE_START, "components", STATE_START, 0 },
67 { STATE_START, "application", STATE_APPLICATION, 0 },
68 { STATE_START, "component", STATE_APPLICATION, 0 },
69 { STATE_APPLICATION, "id", STATE_ID, 1 },
70 { STATE_APPLICATION, "pkgname", STATE_PKGNAME, 1 },
71 { STATE_APPLICATION, "product_license", STATE_LICENCE, 1 },
72 { STATE_APPLICATION, "name", STATE_NAME, 1 },
73 { STATE_APPLICATION, "summary", STATE_SUMMARY, 1 },
74 { STATE_APPLICATION, "description", STATE_DESCRIPTION, 0 },
75 { STATE_APPLICATION, "url", STATE_URL, 1 },
76 { STATE_APPLICATION, "project_group", STATE_GROUP, 1 },
77 { STATE_APPLICATION, "keywords", STATE_KEYWORDS, 0 },
78 { STATE_APPLICATION, "extends", STATE_EXTENDS, 1 },
79 { STATE_DESCRIPTION, "p", STATE_P, 1 },
80 { STATE_DESCRIPTION, "ul", STATE_UL, 0 },
81 { STATE_DESCRIPTION, "ol", STATE_OL, 0 },
82 { STATE_UL, "li", STATE_UL_LI, 1 },
83 { STATE_OL, "li", STATE_OL_LI, 1 },
84 { STATE_KEYWORDS, "keyword", STATE_KEYWORD, 1 },
100 struct stateswitch *swtab[NUMSTATES];
101 enum state sbtab[NUMSTATES];
112 const char *filename;
117 static inline const char *
118 find_attr(const char *txt, const char **atts)
120 for (; *atts; atts += 2)
121 if (!strcmp(*atts, txt))
128 startElement(void *userData, const char *name, const char **atts)
130 struct parsedata *pd = userData;
131 Pool *pool = pd->pool;
132 Solvable *s = pd->solvable;
133 struct stateswitch *sw;
137 fprintf(stderr, "start: [%d]%s\n", pd->state, name);
139 if (pd->depth != pd->statedepth)
146 if (!pd->swtab[pd->state]) /* no statetable -> no substates */
149 fprintf(stderr, "into unknown: %s (from: %d)\n", name, pd->state);
153 for (sw = pd->swtab[pd->state]; sw->from == pd->state; sw++) /* find name in statetable */
154 if (!strcmp(sw->ename, name))
157 if (sw->from != pd->state)
160 fprintf(stderr, "into unknown: %s (from: %d)\n", name, pd->state);
165 pd->docontent = sw->docontent;
166 pd->statedepth = pd->depth;
170 if (!pd->skip_depth && find_attr("xml:lang", atts))
171 pd->skip_depth = pd->depth;
180 case STATE_APPLICATION:
181 s = pd->solvable = pool_id2solvable(pool, repo_add_solvable(pd->repo));
182 pd->handle = s - pool->solvables;
184 type = find_attr("type", atts);
187 repodata_set_poolstr(pd->data, pd->handle, SOLVABLE_CATEGORY, type);
189 case STATE_DESCRIPTION:
190 pd->description = solv_free(pd->description);
201 /* replace whitespace with one space/newline */
202 /* also strip starting/ending whitespace */
204 wsstrip(struct parsedata *pd)
208 for (i = j = 0; pd->content[i]; i++)
210 if (pd->content[i] == ' ' || pd->content[i] == '\t' || pd->content[i] == '\n')
212 ws |= pd->content[i] == '\n' ? 2 : 1;
216 pd->content[j++] = (ws & 2) ? '\n' : ' ';
218 pd->content[j++] = pd->content[i];
224 /* indent all lines */
226 indent(struct parsedata *pd, int il)
229 for (l = 0; pd->content[l]; )
231 if (pd->content[l] == '\n')
236 if (pd->lcontent + il + 1 > pd->acontent)
238 pd->acontent = pd->lcontent + il + 256;
239 pd->content = realloc(pd->content, pd->acontent);
241 memmove(pd->content + l + il, pd->content + l, pd->lcontent - l + 1);
242 for (i = 0; i < il; i++)
243 pd->content[l + i] = ' ';
245 while (pd->content[l] && pd->content[l] != '\n')
251 add_missing_tags_from_desktop_file(struct parsedata *pd, Solvable *s, const char *desktop_file)
253 Pool *pool = pd->pool;
255 const char *filepath;
260 filepath = pool_tmpjoin(pool, "/usr/share/applications/", desktop_file, 0);
261 if (pd->flags & REPO_USE_ROOTDIR)
262 filepath = pool_prepend_rootdir_tmp(pool, filepath);
263 if (!(fp = fopen(filepath, "r")))
265 while (fgets(buf, sizeof(buf), fp) > 0)
267 int c, l = strlen(buf);
270 if (buf[l - 1] != '\n')
272 /* ignore overlong lines */
273 while ((c = getc(fp)) != EOF)
281 while (l && (buf[l - 1] == ' ' || buf[l - 1] == '\t'))
284 while (*p == ' ' || *p == '\t')
286 if (!*p || *p == '#')
290 if (!strcmp(p, "[Desktop Entry]"))
301 for (p3 = p2 - 1; *p3 == ' ' || *p3 == '\t'; p3--)
304 while (*p2 == ' ' || *p2 == '\t')
308 if (!s->name && !strcmp(p, "Name"))
309 s->name = pool_str2id(pool, pool_tmpjoin(pool, "application:", p2, 0), 1);
310 else if (!pd->havesummary && !strcmp(p, "Comment"))
313 repodata_set_str(pd->data, pd->handle, SOLVABLE_SUMMARY, p2);
317 if (s->name && pd->havesummary)
318 break; /* our work is done */
324 guess_filename_from_id(Pool *pool, const char *id)
327 char *r = pool_tmpjoin(pool, id, ".metainfo.xml", 0);
328 if (l > 8 && !strcmp(".desktop", id + l - 8))
329 strcpy(r + l - 8, ".appdata.xml");
330 else if (l > 4 && !strcmp(".ttf", id + l - 4))
331 strcpy(r + l - 4, ".metainfo.xml");
332 else if (l > 4 && !strcmp(".otf", id + l - 4))
333 strcpy(r + l - 4, ".metainfo.xml");
334 else if (l > 4 && !strcmp(".xml", id + l - 4))
335 strcpy(r + l - 4, ".metainfo.xml");
336 else if (l > 3 && !strcmp(".db", id + l - 3))
337 strcpy(r + l - 3, ".metainfo.xml");
344 endElement(void *userData, const char *name)
346 struct parsedata *pd = userData;
347 Pool *pool = pd->pool;
348 Solvable *s = pd->solvable;
352 fprintf(stderr, "end: [%d]%s\n", pd->state, name);
354 if (pd->depth != pd->statedepth)
358 fprintf(stderr, "back from unknown %d %d %d\n", pd->state, pd->depth, pd->statedepth);
366 if (pd->skip_depth && pd->depth + 1 >= pd->skip_depth)
368 if (pd->depth + 1 == pd->skip_depth)
370 pd->state = pd->sbtab[pd->state];
378 case STATE_APPLICATION:
380 s->arch = ARCH_NOARCH;
383 if ((!s->name || !pd->havesummary) && (pd->flags & APPDATA_CHECK_DESKTOP_FILE) != 0 && pd->desktop_file)
384 add_missing_tags_from_desktop_file(pd, s, pd->desktop_file);
385 if (!s->name && pd->desktop_file)
387 char *name = pool_tmpjoin(pool, "application:", pd->desktop_file, 0);
388 int l = strlen(name);
389 if (l > 8 && !strcmp(".desktop", name + l - 8))
391 s->name = pool_strn2id(pool, name, l, 1);
393 if (!s->requires && pd->owners)
397 for (i = 0; i < pd->owners->count; i++)
399 Solvable *os = pd->pool->solvables + pd->owners->elements[i];
400 s->requires = repo_addid_dep(pd->repo, s->requires, os->name, 0);
401 id = pool_str2id(pd->pool, pool_tmpjoin(pd->pool, "application-appdata(", pool_id2str(pd->pool, os->name), ")"), 1);
402 s->provides = repo_addid_dep(pd->repo, s->provides, id, 0);
405 if (!s->requires && (pd->desktop_file || pd->filename))
407 /* add appdata() link requires/provides */
408 const char *filename = pd->filename;
410 filename = guess_filename_from_id(pool, pd->desktop_file);
413 filename = pool_tmpjoin(pool, "application-appdata(", filename, ")");
414 s->requires = repo_addid_dep(pd->repo, s->requires, pool_str2id(pd->pool, filename + 12, 1), 0);
415 s->provides = repo_addid_dep(pd->repo, s->provides, pool_str2id(pd->pool, filename, 1), 0);
418 if (s->name && s->arch != ARCH_SRC && s->arch != ARCH_NOSRC)
419 s->provides = repo_addid_dep(pd->repo, s->provides, pool_rel2id(pd->pool, s->name, s->evr, REL_EQ, 1), 0);
421 pd->desktop_file = solv_free(pd->desktop_file);
424 pd->desktop_file = solv_strdup(pd->content);
427 s->name = pool_str2id(pd->pool, pool_tmpjoin(pool, "application:", pd->content, 0), 1);
430 repodata_add_poolstr_array(pd->data, pd->handle, SOLVABLE_LICENSE, pd->content);
434 repodata_set_str(pd->data, pd->handle, SOLVABLE_SUMMARY, pd->content);
437 repodata_set_str(pd->data, pd->handle, SOLVABLE_URL, pd->content);
440 repodata_add_poolstr_array(pd->data, pd->handle, SOLVABLE_GROUP, pd->content);
443 repodata_add_poolstr_array(pd->data, pd->handle, SOLVABLE_EXTENDS, pd->content);
445 case STATE_DESCRIPTION:
448 /* strip trailing newlines */
449 int l = strlen(pd->description);
450 while (l && pd->description[l - 1] == '\n')
451 pd->description[--l] = 0;
452 repodata_set_str(pd->data, pd->handle, SOLVABLE_DESCRIPTION, pd->description);
457 pd->description = solv_dupappend(pd->description, pd->content, "\n\n");
462 pd->content[2] = '-';
463 pd->description = solv_dupappend(pd->description, pd->content, "\n");
468 if (++pd->licnt >= 10)
469 pd->content[0] = '0' + (pd->licnt / 10) % 10;
470 pd->content[1] = '0' + pd->licnt % 10;
471 pd->content[2] = '.';
472 pd->description = solv_dupappend(pd->description, pd->content, "\n");
476 pd->description = solv_dupappend(pd->description, "\n", 0);
479 id = pool_str2id(pd->pool, pd->content, 1);
480 s->requires = repo_addid_dep(pd->repo, s->requires, id, 0);
481 id = pool_str2id(pd->pool, pool_tmpjoin(pd->pool, "application-appdata(", pd->content, ")"), 1);
482 s->provides = repo_addid_dep(pd->repo, s->provides, id, 0);
485 repodata_add_poolstr_array(pd->data, pd->handle, SOLVABLE_KEYWORDS, pd->content);
491 pd->state = pd->sbtab[pd->state];
495 fprintf(stderr, "end: [%s] -> %d\n", name, pd->state);
501 characterData(void *userData, const XML_Char *s, int len)
503 struct parsedata *pd = userData;
508 l = pd->lcontent + len + 1;
509 if (l > pd->acontent)
511 pd->acontent = l + 256;
512 pd->content = realloc(pd->content, pd->acontent);
514 c = pd->content + pd->lcontent;
521 #define BUFF_SIZE 8192
524 repo_add_appdata_fn(Repo *repo, FILE *fp, int flags, const char *filename, Queue *owners)
526 Pool *pool = repo->pool;
528 struct stateswitch *sw;
534 data = repo_add_repodata(repo, flags);
535 memset(&pd, 0, sizeof(pd));
537 pd.pool = repo->pool;
540 pd.filename = filename;
543 pd.content = malloc(256);
546 for (i = 0, sw = stateswitches; sw->from != NUMSTATES; i++, sw++)
548 if (!pd.swtab[sw->from])
549 pd.swtab[sw->from] = sw;
550 pd.sbtab[sw->to] = sw->from;
553 XML_Parser parser = XML_ParserCreate(NULL);
554 XML_SetUserData(parser, &pd);
555 XML_SetElementHandler(parser, startElement, endElement);
556 XML_SetCharacterDataHandler(parser, characterData);
560 l = fread(buf, 1, sizeof(buf), fp);
561 if (XML_Parse(parser, buf, l, l == 0) == XML_STATUS_ERROR)
563 pool_error(pool, -1, "repo_appdata: %s at line %u:%u\n", XML_ErrorString(XML_GetErrorCode(parser)), (unsigned int)XML_GetCurrentLineNumber(parser), (unsigned int)XML_GetCurrentColumnNumber(parser));
566 repo_free_solvable(repo, pd.solvable - pd.pool->solvables, 1);
575 XML_ParserFree(parser);
577 if (!(flags & REPO_NO_INTERNALIZE))
578 repodata_internalize(data);
580 solv_free(pd.content);
581 solv_free(pd.desktop_file);
582 solv_free(pd.description);
587 repo_add_appdata(Repo *repo, FILE *fp, int flags)
589 return repo_add_appdata_fn(repo, fp, flags, 0, 0);
593 search_uninternalized_filelist(Repo *repo, const char *dir, Queue *res)
595 Pool *pool = repo->pool;
599 for (rdid = 1; rdid < repo->nrepodata; rdid++)
601 Repodata *data = repo_id2repodata(repo, rdid);
604 if (data->state == REPODATA_STUB)
606 if (!repodata_has_keyname(data, SOLVABLE_FILELIST))
608 did = repodata_str2dir(data, dir, 0);
611 for (p = data->start; p < data->end; p++)
613 if (p >= pool->nsolvables)
615 if (pool->solvables[p].repo != repo)
624 str = repodata_lookup_dirstrarray_uninternalized(data, p, SOLVABLE_FILELIST, &idid, &iter);
628 if (l > 12 && strncmp(str + l - 12, ".appdata.xml", 12))
629 id = pool_str2id(pool, str, 1);
630 else if (l > 13 && strncmp(str + l - 13, ".metainfo.xml", 13))
631 id = pool_str2id(pool, str, 1);
634 queue_push2(res, p, id);
640 /* add all files ending in .appdata.xml */
642 repo_add_appdata_dir(Repo *repo, const char *appdatadir, int flags)
652 if (flags & APPDATA_SEARCH_UNINTERNALIZED_FILELIST)
653 search_uninternalized_filelist(repo, appdatadir, &flq);
654 data = repo_add_repodata(repo, flags);
655 if (flags & REPO_USE_ROOTDIR)
656 dirpath = pool_prepend_rootdir(repo->pool, appdatadir);
658 dirpath = solv_strdup(appdatadir);
659 if ((dir = opendir(dirpath)) != 0)
661 struct dirent *entry;
662 while ((entry = readdir(dir)))
666 int len = strlen(entry->d_name);
667 if (entry->d_name[0] == '.')
669 if (!(len > 12 && !strcmp(entry->d_name + len - 12, ".appdata.xml")) &&
670 !(len > 13 && !strcmp(entry->d_name + len - 13, ".metainfo.xml")))
672 n = pool_tmpjoin(repo->pool, dirpath, "/", entry->d_name);
676 pool_error(repo->pool, 0, "%s: %s", n, strerror(errno));
679 if (flags & APPDATA_SEARCH_UNINTERNALIZED_FILELIST)
681 Id id = pool_str2id(repo->pool, entry->d_name, 0);
686 for (i = 0; i < flq.count; i += 2)
687 if (flq.elements[i + 1] == id)
688 queue_push(&oq, flq.elements[i]);
691 repo_add_appdata_fn(repo, fp, flags | REPO_NO_INTERNALIZE | REPO_REUSE_REPODATA | APPDATA_CHECK_DESKTOP_FILE, entry->d_name, oq.count ? &oq : 0);
697 if (!(flags & REPO_NO_INTERNALIZE))
698 repodata_internalize(data);