move help text from include/usage.src.h to archival/*.c
[oweals/busybox.git] / archival / rpm.c
1 /* vi: set sw=4 ts=4: */
2 /*
3  * Mini rpm applet for busybox
4  *
5  * Copyright (C) 2001,2002 by Laurence Anderson
6  *
7  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
8  */
9
10 //usage:#define rpm_trivial_usage
11 //usage:       "-i PACKAGE.rpm; rpm -qp[ildc] PACKAGE.rpm"
12 //usage:#define rpm_full_usage "\n\n"
13 //usage:       "Manipulate RPM packages\n"
14 //usage:     "\nCommands:"
15 //usage:     "\n        -i      Install package"
16 //usage:     "\n        -qp     Query package"
17 //usage:     "\nOptions:"
18 //usage:     "\n        -i      Show information"
19 //usage:     "\n        -l      List contents"
20 //usage:     "\n        -d      List documents"
21 //usage:     "\n        -c      List config files"
22
23 #include "libbb.h"
24 #include "archive.h"
25 #include "rpm.h"
26
27 #define RPM_CHAR_TYPE           1
28 #define RPM_INT8_TYPE           2
29 #define RPM_INT16_TYPE          3
30 #define RPM_INT32_TYPE          4
31 /* #define RPM_INT64_TYPE       5   ---- These aren't supported (yet) */
32 #define RPM_STRING_TYPE         6
33 #define RPM_BIN_TYPE            7
34 #define RPM_STRING_ARRAY_TYPE   8
35 #define RPM_I18NSTRING_TYPE     9
36
37 #define TAG_NAME                1000
38 #define TAG_VERSION             1001
39 #define TAG_RELEASE             1002
40 #define TAG_SUMMARY             1004
41 #define TAG_DESCRIPTION         1005
42 #define TAG_BUILDTIME           1006
43 #define TAG_BUILDHOST           1007
44 #define TAG_SIZE                1009
45 #define TAG_VENDOR              1011
46 #define TAG_LICENSE             1014
47 #define TAG_PACKAGER            1015
48 #define TAG_GROUP               1016
49 #define TAG_URL                 1020
50 #define TAG_PREIN               1023
51 #define TAG_POSTIN              1024
52 #define TAG_FILEFLAGS           1037
53 #define TAG_FILEUSERNAME        1039
54 #define TAG_FILEGROUPNAME       1040
55 #define TAG_SOURCERPM           1044
56 #define TAG_PREINPROG           1085
57 #define TAG_POSTINPROG          1086
58 #define TAG_PREFIXS             1098
59 #define TAG_DIRINDEXES          1116
60 #define TAG_BASENAMES           1117
61 #define TAG_DIRNAMES            1118
62
63 #define RPMFILE_CONFIG          (1 << 0)
64 #define RPMFILE_DOC             (1 << 1)
65
66 enum rpm_functions_e {
67         rpm_query = 1,
68         rpm_install = 2,
69         rpm_query_info = 4,
70         rpm_query_package = 8,
71         rpm_query_list = 16,
72         rpm_query_list_doc = 32,
73         rpm_query_list_config = 64
74 };
75
76 typedef struct {
77         uint32_t tag; /* 4 byte tag */
78         uint32_t type; /* 4 byte type */
79         uint32_t offset; /* 4 byte offset */
80         uint32_t count; /* 4 byte count */
81 } rpm_index;
82
83 static void *map;
84 static rpm_index **mytags;
85 static int tagcount;
86
87 static void extract_cpio(int fd, const char *source_rpm);
88 static rpm_index **rpm_gettags(int fd, int *num_tags);
89 static int bsearch_rpmtag(const void *key, const void *item);
90 static char *rpm_getstr(int tag, int itemindex);
91 static int rpm_getint(int tag, int itemindex);
92 static int rpm_getcount(int tag);
93 static void fileaction_dobackup(char *filename, int fileref);
94 static void fileaction_setowngrp(char *filename, int fileref);
95 static void loop_through_files(int filetag, void (*fileaction)(char *filename, int fileref));
96
97 int rpm_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
98 int rpm_main(int argc, char **argv)
99 {
100         int opt = 0, func = 0, rpm_fd, offset;
101         const int pagesize = getpagesize();
102
103         while ((opt = getopt(argc, argv, "iqpldc")) != -1) {
104                 switch (opt) {
105                 case 'i': /* First arg: Install mode, with q: Information */
106                         if (!func) func = rpm_install;
107                         else func |= rpm_query_info;
108                         break;
109                 case 'q': /* First arg: Query mode */
110                         if (func) bb_show_usage();
111                         func = rpm_query;
112                         break;
113                 case 'p': /* Query a package */
114                         func |= rpm_query_package;
115                         break;
116                 case 'l': /* List files in a package */
117                         func |= rpm_query_list;
118                         break;
119                 case 'd': /* List doc files in a package (implies list) */
120                         func |= rpm_query_list;
121                         func |= rpm_query_list_doc;
122                         break;
123                 case 'c': /* List config files in a package (implies list) */
124                         func |= rpm_query_list;
125                         func |= rpm_query_list_config;
126                         break;
127                 default:
128                         bb_show_usage();
129                 }
130         }
131         argv += optind;
132         //argc -= optind;
133         if (!argv[0]) {
134                 bb_show_usage();
135         }
136
137         while (*argv) {
138                 const char *source_rpm;
139
140                 rpm_fd = xopen(*argv++, O_RDONLY);
141                 mytags = rpm_gettags(rpm_fd, &tagcount);
142                 if (!mytags)
143                         bb_error_msg_and_die("error reading rpm header");
144                 offset = xlseek(rpm_fd, 0, SEEK_CUR);
145                 /* Mimimum is one page */
146                 map = mmap(0, offset > pagesize ? (offset + offset % pagesize) : pagesize, PROT_READ, MAP_PRIVATE, rpm_fd, 0);
147
148                 source_rpm = rpm_getstr(TAG_SOURCERPM, 0);
149
150                 if (func & rpm_install) {
151                         /* Backup any config files */
152                         loop_through_files(TAG_BASENAMES, fileaction_dobackup);
153                         /* Extact the archive */
154                         extract_cpio(rpm_fd, source_rpm);
155                         /* Set the correct file uid/gid's */
156                         loop_through_files(TAG_BASENAMES, fileaction_setowngrp);
157                 }
158                 else if ((func & (rpm_query|rpm_query_package)) == (rpm_query|rpm_query_package)) {
159                         if (!(func & (rpm_query_info|rpm_query_list))) {
160                                 /* If just a straight query, just give package name */
161                                 printf("%s-%s-%s\n", rpm_getstr(TAG_NAME, 0), rpm_getstr(TAG_VERSION, 0), rpm_getstr(TAG_RELEASE, 0));
162                         }
163                         if (func & rpm_query_info) {
164                                 /* Do the nice printout */
165                                 time_t bdate_time;
166                                 struct tm *bdate_ptm;
167                                 char bdatestring[50];
168                                 const char *p;
169
170                                 p = rpm_getstr(TAG_PREFIXS, 0);
171                                 if (!p) p = "(not relocateable)";
172                                 printf("Name        : %-29sRelocations: %s\n", rpm_getstr(TAG_NAME, 0), p);
173                                 p = rpm_getstr(TAG_VENDOR, 0);
174                                 if (!p) p = "(none)";
175                                 printf("Version     : %-34sVendor: %s\n", rpm_getstr(TAG_VERSION, 0), p);
176                                 bdate_time = rpm_getint(TAG_BUILDTIME, 0);
177                                 bdate_ptm = localtime(&bdate_time);
178                                 strftime(bdatestring, 50, "%a %d %b %Y %T %Z", bdate_ptm);
179                                 printf("Release     : %-30sBuild Date: %s\n", rpm_getstr(TAG_RELEASE, 0), bdatestring);
180                                 printf("Install date: %-30sBuild Host: %s\n", "(not installed)", rpm_getstr(TAG_BUILDHOST, 0));
181                                 printf("Group       : %-30sSource RPM: %s\n", rpm_getstr(TAG_GROUP, 0), source_rpm);
182                                 printf("Size        : %-33dLicense: %s\n", rpm_getint(TAG_SIZE, 0), rpm_getstr(TAG_LICENSE, 0));
183                                 printf("URL         : %s\n", rpm_getstr(TAG_URL, 0));
184                                 printf("Summary     : %s\n", rpm_getstr(TAG_SUMMARY, 0));
185                                 printf("Description :\n%s\n", rpm_getstr(TAG_DESCRIPTION, 0));
186                         }
187                         if (func & rpm_query_list) {
188                                 int count, it, flags;
189                                 count = rpm_getcount(TAG_BASENAMES);
190                                 for (it = 0; it < count; it++) {
191                                         flags = rpm_getint(TAG_FILEFLAGS, it);
192                                         switch (func & (rpm_query_list_doc|rpm_query_list_config)) {
193                                         case rpm_query_list_doc:
194                                                 if (!(flags & RPMFILE_DOC)) continue;
195                                                 break;
196                                         case rpm_query_list_config:
197                                                 if (!(flags & RPMFILE_CONFIG)) continue;
198                                                 break;
199                                         case rpm_query_list_doc|rpm_query_list_config:
200                                                 if (!(flags & (RPMFILE_CONFIG|RPMFILE_DOC))) continue;
201                                                 break;
202                                         }
203                                         printf("%s%s\n",
204                                                 rpm_getstr(TAG_DIRNAMES, rpm_getint(TAG_DIRINDEXES, it)),
205                                                 rpm_getstr(TAG_BASENAMES, it));
206                                 }
207                         }
208                 }
209                 free(mytags);
210         }
211         return 0;
212 }
213
214 static void extract_cpio(int fd, const char *source_rpm)
215 {
216         archive_handle_t *archive_handle;
217
218         if (source_rpm != NULL) {
219                 /* Binary rpm (it was built from some SRPM), install to root */
220                 xchdir("/");
221         } /* else: SRPM, install to current dir */
222
223         /* Initialize */
224         archive_handle = init_handle();
225         archive_handle->seek = seek_by_read;
226         archive_handle->action_data = data_extract_all;
227 #if 0 /* For testing (rpm -i only lists the files in internal cpio): */
228         archive_handle->action_header = header_list;
229         archive_handle->action_data = data_skip;
230 #endif
231         archive_handle->ah_flags = ARCHIVE_RESTORE_DATE | ARCHIVE_CREATE_LEADING_DIRS
232                 /* compat: overwrite existing files.
233                  * try "rpm -i foo.src.rpm" few times in a row -
234                  * standard rpm will not complain.
235                  * (TODO? real rpm creates "file;1234" and then renames it) */
236                 | ARCHIVE_UNLINK_OLD;
237         archive_handle->src_fd = fd;
238         /*archive_handle->offset = 0; - init_handle() did it */
239
240         setup_unzip_on_fd(archive_handle->src_fd /*, fail_if_not_detected: 1*/);
241         while (get_header_cpio(archive_handle) == EXIT_SUCCESS)
242                 continue;
243 }
244
245 static rpm_index **rpm_gettags(int fd, int *num_tags)
246 {
247         /* We should never need more than 200 (shrink via realloc later) */
248         rpm_index **tags = xzalloc(200 * sizeof(tags[0]));
249         int pass, tagindex = 0;
250
251         xlseek(fd, 96, SEEK_CUR); /* Seek past the unused lead */
252
253         /* 1st pass is the signature headers, 2nd is the main stuff */
254         for (pass = 0; pass < 2; pass++) {
255                 struct rpm_header header;
256                 rpm_index *tmpindex;
257                 int storepos;
258
259                 xread(fd, &header, sizeof(header));
260                 if (header.magic_and_ver != htonl(RPM_HEADER_MAGICnVER))
261                         return NULL; /* Invalid magic, or not version 1 */
262                 header.size = ntohl(header.size);
263                 header.entries = ntohl(header.entries);
264                 storepos = xlseek(fd, 0, SEEK_CUR) + header.entries * 16;
265
266                 while (header.entries--) {
267                         tmpindex = tags[tagindex++] = xmalloc(sizeof(*tmpindex));
268                         xread(fd, tmpindex, sizeof(*tmpindex));
269                         tmpindex->tag = ntohl(tmpindex->tag);
270                         tmpindex->type = ntohl(tmpindex->type);
271                         tmpindex->count = ntohl(tmpindex->count);
272                         tmpindex->offset = storepos + ntohl(tmpindex->offset);
273                         if (pass == 0)
274                                 tmpindex->tag -= 743;
275                 }
276                 storepos = xlseek(fd, header.size, SEEK_CUR); /* Seek past store */
277                 /* Skip padding to 8 byte boundary after reading signature headers */
278                 if (pass == 0)
279                         xlseek(fd, (-storepos) & 0x7, SEEK_CUR);
280         }
281         /* realloc tags to save space */
282         tags = xrealloc(tags, tagindex * sizeof(tags[0]));
283         *num_tags = tagindex;
284         /* All done, leave the file at the start of the gzipped cpio archive */
285         return tags;
286 }
287
288 static int bsearch_rpmtag(const void *key, const void *item)
289 {
290         int *tag = (int *)key;
291         rpm_index **tmp = (rpm_index **) item;
292         return (*tag - tmp[0]->tag);
293 }
294
295 static int rpm_getcount(int tag)
296 {
297         rpm_index **found;
298         found = bsearch(&tag, mytags, tagcount, sizeof(struct rpmtag *), bsearch_rpmtag);
299         if (!found)
300                 return 0;
301         return found[0]->count;
302 }
303
304 static char *rpm_getstr(int tag, int itemindex)
305 {
306         rpm_index **found;
307         found = bsearch(&tag, mytags, tagcount, sizeof(struct rpmtag *), bsearch_rpmtag);
308         if (!found || itemindex >= found[0]->count)
309                 return NULL;
310         if (found[0]->type == RPM_STRING_TYPE
311          || found[0]->type == RPM_I18NSTRING_TYPE
312          || found[0]->type == RPM_STRING_ARRAY_TYPE
313         ) {
314                 int n;
315                 char *tmpstr = (char *) map + found[0]->offset;
316                 for (n = 0; n < itemindex; n++)
317                         tmpstr = tmpstr + strlen(tmpstr) + 1;
318                 return tmpstr;
319         }
320         return NULL;
321 }
322
323 static int rpm_getint(int tag, int itemindex)
324 {
325         rpm_index **found;
326         int *tmpint; /* NB: using int8_t* would be easier to code */
327
328         /* gcc throws warnings here when sizeof(void*)!=sizeof(int) ...
329          * it's ok to ignore it because tag won't be used as a pointer */
330         found = bsearch(&tag, mytags, tagcount, sizeof(struct rpmtag *), bsearch_rpmtag);
331         if (!found || itemindex >= found[0]->count)
332                 return -1;
333
334         tmpint = (int *) ((char *) map + found[0]->offset);
335
336         if (found[0]->type == RPM_INT32_TYPE) {
337                 tmpint = (int *) ((char *) tmpint + itemindex*4);
338                 /*return ntohl(*tmpint);*/
339                 /* int can be != int32_t */
340                 return ntohl(*(int32_t*)tmpint);
341         }
342         if (found[0]->type == RPM_INT16_TYPE) {
343                 tmpint = (int *) ((char *) tmpint + itemindex*2);
344                 /* ??? read int, and THEN ntohs() it?? */
345                 /*return ntohs(*tmpint);*/
346                 return ntohs(*(int16_t*)tmpint);
347         }
348         if (found[0]->type == RPM_INT8_TYPE) {
349                 tmpint = (int *) ((char *) tmpint + itemindex);
350                 /* ??? why we don't read byte here??? */
351                 /*return ntohs(*tmpint);*/
352                 return *(int8_t*)tmpint;
353         }
354         return -1;
355 }
356
357 static void fileaction_dobackup(char *filename, int fileref)
358 {
359         struct stat oldfile;
360         int stat_res;
361         char *newname;
362         if (rpm_getint(TAG_FILEFLAGS, fileref) & RPMFILE_CONFIG) {
363                 /* Only need to backup config files */
364                 stat_res = lstat(filename, &oldfile);
365                 if (stat_res == 0 && S_ISREG(oldfile.st_mode)) {
366                         /* File already exists  - really should check MD5's etc to see if different */
367                         newname = xasprintf("%s.rpmorig", filename);
368                         copy_file(filename, newname, FILEUTILS_RECUR | FILEUTILS_PRESERVE_STATUS);
369                         remove_file(filename, FILEUTILS_RECUR | FILEUTILS_FORCE);
370                         free(newname);
371                 }
372         }
373 }
374
375 static void fileaction_setowngrp(char *filename, int fileref)
376 {
377         /* real rpm warns: "user foo does not exist - using <you>" */
378         struct passwd *pw = getpwnam(rpm_getstr(TAG_FILEUSERNAME, fileref));
379         int uid = pw ? pw->pw_uid : getuid(); /* or euid? */
380         struct group *gr = getgrnam(rpm_getstr(TAG_FILEGROUPNAME, fileref));
381         int gid = gr ? gr->gr_gid : getgid();
382         chown(filename, uid, gid);
383 }
384
385 static void loop_through_files(int filetag, void (*fileaction)(char *filename, int fileref))
386 {
387         int count = 0;
388         while (rpm_getstr(filetag, count)) {
389                 char* filename = xasprintf("%s%s",
390                         rpm_getstr(TAG_DIRNAMES, rpm_getint(TAG_DIRINDEXES, count)),
391                         rpm_getstr(TAG_BASENAMES, count));
392                 fileaction(filename, count++);
393                 free(filename);
394         }
395 }