2 * Copyright (C) 2011 Red Hat Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
32 #include "guestfs-internal.h"
33 #include "guestfs-internal-actions.h"
34 #include "guestfs_protocol.h"
36 static int read_whole_file (guestfs_h *g, const char *filename, char **data_r, size_t *size_r);
38 /* All these icon_*() functions return the same way. One of:
41 * An error occurred. Error has been set in the handle. The caller
42 * should return NULL immediately.
45 * Not an error, but no icon was found. 'ret' is just a dummy value
46 * which should be ignored (do not free it!)
48 * ret == ordinary pointer:
49 * An icon was found. 'ret' points to the icon buffer, and *size_r
52 static char *icon_favicon (guestfs_h *g, struct inspect_fs *fs, size_t *size_r);
53 static char *icon_fedora (guestfs_h *g, struct inspect_fs *fs, size_t *size_r);
54 static char *icon_rhel (guestfs_h *g, struct inspect_fs *fs, size_t *size_r);
55 static char *icon_debian (guestfs_h *g, struct inspect_fs *fs, size_t *size_r);
56 static char *icon_mageia (guestfs_h *g, struct inspect_fs *fs, size_t *size_r);
57 static char *icon_windows (guestfs_h *g, struct inspect_fs *fs, size_t *size_r);
59 /* Dummy static object. */
60 static char *NOT_FOUND = (char *) "not_found";
62 /* For the unexpected legal consequences of this function, see:
63 * http://lists.fedoraproject.org/pipermail/legal/2011-April/001615.html
65 * Returns an RBufferOut, so the length of the returned buffer is
66 * returned in *size_r.
68 * Check optargs for the optional argument.
71 guestfs__inspect_get_icon (guestfs_h *g, const char *root, size_t *size_r,
72 const struct guestfs_inspect_get_icon_argv *optargs)
74 struct inspect_fs *fs;
76 int favicon, highquality;
79 fs = guestfs___search_for_root (g, root);
83 /* Get optargs, or defaults. */
85 optargs->bitmask & GUESTFS_INSPECT_GET_ICON_FAVICON_BITMASK ?
89 optargs->bitmask & GUESTFS_INSPECT_GET_ICON_HIGHQUALITY_BITMASK ?
90 optargs->highquality : 0;
92 /* Favicons are never high quality, so ... */
96 /* Try looking for a favicon first. */
98 r = icon_favicon (g, fs, &size);
102 if (r != NOT_FOUND) {
103 /* try_favicon succeeded in finding a favicon. */
109 /* Favicon failed, so let's try a method based on the detected operating
114 switch (fs->distro) {
115 case OS_DISTRO_FEDORA:
116 r = icon_fedora (g, fs, &size);
120 case OS_DISTRO_REDHAT_BASED:
121 case OS_DISTRO_CENTOS:
122 case OS_DISTRO_SCIENTIFIC_LINUX:
123 r = icon_rhel (g, fs, &size);
126 case OS_DISTRO_DEBIAN:
127 r = icon_debian (g, fs, &size);
130 case OS_DISTRO_MAGEIA:
131 r = icon_mageia (g, fs, &size);
134 /* These are just to keep gcc warnings happy. */
135 case OS_DISTRO_ARCHLINUX:
136 case OS_DISTRO_GENTOO:
137 case OS_DISTRO_LINUX_MINT:
138 case OS_DISTRO_MANDRIVA:
139 case OS_DISTRO_MEEGO:
140 case OS_DISTRO_PARDUS:
141 case OS_DISTRO_SLACKWARE:
142 case OS_DISTRO_TTYLINUX:
143 case OS_DISTRO_UBUNTU:
144 case OS_DISTRO_WINDOWS:
145 case OS_DISTRO_UNKNOWN:
150 case OS_TYPE_WINDOWS:
151 /* We don't know how to get high quality icons from a Windows guest,
152 * so disable this if high quality was specified.
155 r = icon_windows (g, fs, &size);
158 case OS_TYPE_FREEBSD:
159 case OS_TYPE_UNKNOWN:
163 if (r == NOT_FOUND) {
164 /* Not found, but not an error. So return the special zero-length
165 * buffer. Use malloc(1) here to ensure that malloc won't return
168 r = safe_malloc (g, 1);
176 /* Check that the named file 'filename' is a PNG file and is reasonable.
177 * If it is, download and return it.
180 get_png (guestfs_h *g, struct inspect_fs *fs, const char *filename,
181 size_t *size_r, size_t max_size)
183 char *ret = NOT_FOUND;
188 r = guestfs_exists (g, filename);
190 ret = NULL; /* a real error */
193 if (r == 0) goto out;
195 /* Check the file type and geometry. */
196 type = guestfs_file (g, filename);
199 if (!STRPREFIX (type, "PNG image data, ")) goto out;
200 if (sscanf (&type[16], "%d x %d", &w, &h) != 2) goto out;
201 if (w < 16 || h < 16 || w > 1024 || h > 1024) goto out;
203 /* Define a maximum reasonable size based on the geometry. This
204 * also limits the maximum we allocate below to around 4 MB.
207 max_size = 4 * w * h;
209 local = guestfs___download_to_tmp (g, fs, filename, "icon", max_size);
210 if (!local) goto out;
212 /* Successfully passed checks and downloaded. Read it into memory. */
213 if (read_whole_file (g, local, &ret, size_r) == -1) {
225 /* Return /etc/favicon.png (or \etc\favicon.png) if it exists and if
226 * it has a reasonable size and format.
229 icon_favicon (guestfs_h *g, struct inspect_fs *fs, size_t *size_r)
232 char *filename = safe_strdup (g, "/etc/favicon.png");
234 if (fs->type == OS_TYPE_WINDOWS) {
235 char *f = guestfs___case_sensitive_path_silently (g, filename);
242 ret = get_png (g, fs, filename, size_r, 0);
247 /* Return FEDORA_ICON. I checked that this exists on at least Fedora 6
250 #define FEDORA_ICON "/usr/share/icons/hicolor/96x96/apps/fedora-logo-icon.png"
253 icon_fedora (guestfs_h *g, struct inspect_fs *fs, size_t *size_r)
255 return get_png (g, fs, FEDORA_ICON, size_r, 0);
259 * /usr/share/pixmaps/redhat/shadowman-transparent.png is a 517x515
260 * PNG with alpha channel, around 64K in size.
263 * As above, but the file has been optimized to about 16K.
265 * Conveniently the RHEL clones also have the same file with the
266 * same name, but containing their own logos. Sense prevails!
268 #define SHADOWMAN_ICON "/usr/share/pixmaps/redhat/shadowman-transparent.png"
271 icon_rhel (guestfs_h *g, struct inspect_fs *fs, size_t *size_r)
275 if (fs->distro == OS_DISTRO_RHEL) {
276 if (fs->major_version <= 4)
282 return get_png (g, fs, SHADOWMAN_ICON, size_r, max_size);
285 /* NB: I've not located an Ubuntu logo yet. */
286 #define DEBIAN_ICON "/usr/share/pixmaps/debian-logo.png"
289 icon_debian (guestfs_h *g, struct inspect_fs *fs, size_t *size_r)
291 return get_png (g, fs, DEBIAN_ICON, size_r, 2048);
294 #define MAGEIA_ICON "/usr/share/icons/mageia.png"
297 icon_mageia (guestfs_h *g, struct inspect_fs *fs, size_t *size_r)
299 return get_png (g, fs, MAGEIA_ICON, size_r, 2048);
301 /* Windows, as usual, has to be much more complicated and stupid than
304 * We have to download %systemroot%\explorer.exe and use a special
305 * program called 'wrestool' to extract the icons from this file. For
306 * each version of Windows, the icon we want is in a different place.
307 * The icon is in a stupid format (BMP), and in some cases multiple
308 * icons are in a single BMP file so we have to do some manipulation
311 * XXX I've only bothered with this nonsense for a few versions of
312 * Windows that I have handy. Please send patches to support other
317 icon_windows_xp (guestfs_h *g, struct inspect_fs *fs, const char *explorer,
325 pngfile = safe_asprintf (g, "%s/windows-xp-icon.png", g->tmpdir);
327 cmd = safe_asprintf (g,
328 "wrestool -x --type=2 --name=143 %s | "
329 "bmptopnm | pnmtopng > %s",
332 if (r == -1 || WEXITSTATUS (r) != 0) {
333 debug (g, "external command failed: %s", cmd);
341 if (read_whole_file (g, pngfile, &ret, size_r) == -1) {
352 icon_windows_7 (guestfs_h *g, struct inspect_fs *fs, const char *explorer,
360 pngfile = safe_asprintf (g, "%s/windows-7-icon.png", g->tmpdir);
362 cmd = safe_asprintf (g,
363 "wrestool -x --type=2 --name=6801 %s | "
364 "bmptopnm | pamcut -bottom 54 | pnmtopng > %s",
367 if (r == -1 || WEXITSTATUS (r) != 0) {
368 debug (g, "external command failed: %s", cmd);
376 if (read_whole_file (g, pngfile, &ret, size_r) == -1) {
387 icon_windows (guestfs_h *g, struct inspect_fs *fs, size_t *size_r)
389 char *(*fn) (guestfs_h *g, struct inspect_fs *fs, const char *explorer,
391 char *filename1, *filename2, *filename3;
395 if (fs->major_version == 5 && fs->minor_version == 1)
396 fn = icon_windows_xp;
399 else if (fs->major_version == 6 && fs->minor_version == 1)
402 /* Not (yet) a supported version of Windows. */
403 else return NOT_FOUND;
405 if (fs->windows_systemroot == NULL)
408 /* Download %systemroot%\explorer.exe */
409 filename1 = safe_asprintf (g, "%s/explorer.exe", fs->windows_systemroot);
410 filename2 = guestfs___case_sensitive_path_silently (g, filename1);
412 if (filename2 == NULL)
415 filename3 = guestfs___download_to_tmp (g, fs, filename2, "explorer",
416 MAX_WINDOWS_EXPLORER_SIZE);
418 if (filename3 == NULL)
421 ret = fn (g, fs, filename3, size_r);
426 /* Read the whole file into a memory buffer and return it. The file
427 * should be a regular, local, trusted file.
430 read_whole_file (guestfs_h *g, const char *filename,
431 char **data_r, size_t *size_r)
440 fd = open (filename, O_RDONLY);
442 perrorf (g, "open: %s", filename);
446 if (fstat (fd, &statbuf) == -1) {
447 perrorf (g, "stat: %s", filename);
452 size = statbuf.st_size;
453 data = safe_malloc (g, size);
457 r = read (fd, &data[n], size - n);
459 perrorf (g, "read: %s", filename);
465 error (g, _("read: %s: unexpected end of file"), filename);
473 if (close (fd) == -1) {
474 perrorf (g, "close: %s", filename);