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_windows (guestfs_h *g, struct inspect_fs *fs, size_t *size_r);
58 /* Dummy static object. */
59 static char *NOT_FOUND = (char *) "not_found";
61 /* For the unexpected legal consequences of this function, see:
62 * http://lists.fedoraproject.org/pipermail/legal/2011-April/001615.html
64 * Returns an RBufferOut, so the length of the returned buffer is
65 * returned in *size_r.
67 * Check optargs for the optional argument.
70 guestfs__inspect_get_icon (guestfs_h *g, const char *root, size_t *size_r,
71 const struct guestfs_inspect_get_icon_argv *optargs)
73 struct inspect_fs *fs;
75 int favicon, highquality;
78 fs = guestfs___search_for_root (g, root);
82 /* Get optargs, or defaults. */
84 optargs->bitmask & GUESTFS_INSPECT_GET_ICON_FAVICON_BITMASK ?
88 optargs->bitmask & GUESTFS_INSPECT_GET_ICON_HIGHQUALITY_BITMASK ?
89 optargs->highquality : 0;
91 /* Favicons are never high quality, so ... */
95 /* Try looking for a favicon first. */
97 r = icon_favicon (g, fs, &size);
101 if (r != NOT_FOUND) {
102 /* try_favicon succeeded in finding a favicon. */
108 /* Favicon failed, so let's try a method based on the detected operating
113 switch (fs->distro) {
114 case OS_DISTRO_FEDORA:
115 r = icon_fedora (g, fs, &size);
119 case OS_DISTRO_REDHAT_BASED:
120 case OS_DISTRO_CENTOS:
121 case OS_DISTRO_SCIENTIFIC_LINUX:
122 r = icon_rhel (g, fs, &size);
125 case OS_DISTRO_DEBIAN:
126 r = icon_debian (g, fs, &size);
129 /* These are just to keep gcc warnings happy. */
130 case OS_DISTRO_ARCHLINUX:
131 case OS_DISTRO_GENTOO:
132 case OS_DISTRO_LINUX_MINT:
133 case OS_DISTRO_MANDRIVA:
134 case OS_DISTRO_MEEGO:
135 case OS_DISTRO_PARDUS:
136 case OS_DISTRO_SLACKWARE:
137 case OS_DISTRO_UBUNTU:
138 case OS_DISTRO_WINDOWS:
139 case OS_DISTRO_UNKNOWN:
144 case OS_TYPE_WINDOWS:
145 /* We don't know how to get high quality icons from a Windows guest,
146 * so disable this if high quality was specified.
149 r = icon_windows (g, fs, &size);
152 case OS_TYPE_FREEBSD:
153 case OS_TYPE_UNKNOWN:
157 if (r == NOT_FOUND) {
158 /* Not found, but not an error. So return the special zero-length
159 * buffer. Use malloc(1) here to ensure that malloc won't return
162 r = safe_malloc (g, 1);
170 /* Check that the named file 'filename' is a PNG file and is reasonable.
171 * If it is, download and return it.
174 get_png (guestfs_h *g, struct inspect_fs *fs, const char *filename,
175 size_t *size_r, size_t max_size)
177 char *ret = NOT_FOUND;
182 r = guestfs_exists (g, filename);
184 ret = NULL; /* a real error */
187 if (r == 0) goto out;
189 /* Check the file type and geometry. */
190 type = guestfs_file (g, filename);
193 if (!STRPREFIX (type, "PNG image data, ")) goto out;
194 if (sscanf (&type[16], "%d x %d", &w, &h) != 2) goto out;
195 if (w < 16 || h < 16 || w > 1024 || h > 1024) goto out;
197 /* Define a maximum reasonable size based on the geometry. This
198 * also limits the maximum we allocate below to around 4 MB.
201 max_size = 4 * w * h;
203 local = guestfs___download_to_tmp (g, fs, filename, "icon", max_size);
204 if (!local) goto out;
206 /* Successfully passed checks and downloaded. Read it into memory. */
207 if (read_whole_file (g, local, &ret, size_r) == -1) {
219 /* Return /etc/favicon.png (or \etc\favicon.png) if it exists and if
220 * it has a reasonable size and format.
223 icon_favicon (guestfs_h *g, struct inspect_fs *fs, size_t *size_r)
226 char *filename = safe_strdup (g, "/etc/favicon.png");
228 if (fs->type == OS_TYPE_WINDOWS) {
229 char *f = guestfs___case_sensitive_path_silently (g, filename);
236 ret = get_png (g, fs, filename, size_r, 0);
241 /* Return FEDORA_ICON. I checked that this exists on at least Fedora 6
244 #define FEDORA_ICON "/usr/share/icons/hicolor/96x96/apps/fedora-logo-icon.png"
247 icon_fedora (guestfs_h *g, struct inspect_fs *fs, size_t *size_r)
249 return get_png (g, fs, FEDORA_ICON, size_r, 0);
253 * /usr/share/pixmaps/redhat/shadowman-transparent.png is a 517x515
254 * PNG with alpha channel, around 64K in size.
257 * As above, but the file has been optimized to about 16K.
259 * Conveniently the RHEL clones also have the same file with the
260 * same name, but containing their own logos. Sense prevails!
262 #define SHADOWMAN_ICON "/usr/share/pixmaps/redhat/shadowman-transparent.png"
265 icon_rhel (guestfs_h *g, struct inspect_fs *fs, size_t *size_r)
269 if (fs->distro == OS_DISTRO_RHEL) {
270 if (fs->major_version <= 4)
276 return get_png (g, fs, SHADOWMAN_ICON, size_r, max_size);
279 /* NB: I've not located an Ubuntu logo yet. */
280 #define DEBIAN_ICON "/usr/share/pixmaps/debian-logo.png"
283 icon_debian (guestfs_h *g, struct inspect_fs *fs, size_t *size_r)
285 return get_png (g, fs, DEBIAN_ICON, size_r, 2048);
288 /* Windows, as usual, has to be much more complicated and stupid than
291 * We have to download %systemroot%\explorer.exe and use a special
292 * program called 'wrestool' to extract the icons from this file. For
293 * each version of Windows, the icon we want is in a different place.
294 * The icon is in a stupid format (BMP), and in some cases multiple
295 * icons are in a single BMP file so we have to do some manipulation
298 * XXX I've only bothered with this nonsense for a few versions of
299 * Windows that I have handy. Please send patches to support other
304 icon_windows_xp (guestfs_h *g, struct inspect_fs *fs, const char *explorer,
312 pngfile = safe_asprintf (g, "%s/windows-xp-icon.png", g->tmpdir);
314 cmd = safe_asprintf (g,
315 "wrestool -x --type=2 --name=143 %s | "
316 "bmptopnm | pnmtopng > %s",
319 if (r == -1 || WEXITSTATUS (r) != 0) {
320 debug (g, "external command failed: %s", cmd);
328 if (read_whole_file (g, pngfile, &ret, size_r) == -1) {
339 icon_windows_7 (guestfs_h *g, struct inspect_fs *fs, const char *explorer,
347 pngfile = safe_asprintf (g, "%s/windows-7-icon.png", g->tmpdir);
349 cmd = safe_asprintf (g,
350 "wrestool -x --type=2 --name=6801 %s | "
351 "bmptopnm | pamcut -bottom 54 | pnmtopng > %s",
354 if (r == -1 || WEXITSTATUS (r) != 0) {
355 debug (g, "external command failed: %s", cmd);
363 if (read_whole_file (g, pngfile, &ret, size_r) == -1) {
374 icon_windows (guestfs_h *g, struct inspect_fs *fs, size_t *size_r)
376 char *(*fn) (guestfs_h *g, struct inspect_fs *fs, const char *explorer,
378 char *filename1, *filename2, *filename3;
382 if (fs->major_version == 5 && fs->minor_version == 1)
383 fn = icon_windows_xp;
386 else if (fs->major_version == 6 && fs->minor_version == 1)
389 /* Not (yet) a supported version of Windows. */
390 else return NOT_FOUND;
392 if (fs->windows_systemroot == NULL)
395 /* Download %systemroot%\explorer.exe */
396 filename1 = safe_asprintf (g, "%s/explorer.exe", fs->windows_systemroot);
397 filename2 = guestfs___case_sensitive_path_silently (g, filename1);
399 if (filename2 == NULL)
402 filename3 = guestfs___download_to_tmp (g, fs, filename2, "explorer",
403 MAX_WINDOWS_EXPLORER_SIZE);
405 if (filename3 == NULL)
408 ret = fn (g, fs, filename3, size_r);
413 /* Read the whole file into a memory buffer and return it. The file
414 * should be a regular, local, trusted file.
417 read_whole_file (guestfs_h *g, const char *filename,
418 char **data_r, size_t *size_r)
427 fd = open (filename, O_RDONLY);
429 perrorf (g, "open: %s", filename);
433 if (fstat (fd, &statbuf) == -1) {
434 perrorf (g, "stat: %s", filename);
439 size = statbuf.st_size;
440 data = safe_malloc (g, size);
444 r = read (fd, &data[n], size - n);
446 perrorf (g, "read: %s", filename);
452 error (g, _("read: %s: unexpected end of file"), filename);
460 if (close (fd) == -1) {
461 perrorf (g, "close: %s", filename);