1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #include "base/nix/mime_util_xdg.h"
12 #include "base/environment.h"
13 #include "base/file_util.h"
14 #include "base/lazy_instance.h"
15 #include "base/logging.h"
16 #include "base/memory/scoped_ptr.h"
17 #include "base/memory/singleton.h"
18 #include "base/nix/xdg_util.h"
19 #include "base/strings/string_split.h"
20 #include "base/strings/string_util.h"
21 #include "base/synchronization/lock.h"
22 #include "base/third_party/xdg_mime/xdgmime.h"
23 #include "base/threading/thread_restrictions.h"
24 #include "base/time/time.h"
33 // None of the XDG stuff is thread-safe, so serialize all access under
35 LazyInstance
<Lock
>::Leaky g_mime_util_xdg_lock
= LAZY_INSTANCE_INITIALIZER
;
37 class MimeUtilConstants
{
39 typedef std::map
<std::string
, IconTheme
*> IconThemeMap
;
40 typedef std::map
<FilePath
, Time
> IconDirMtimeMap
;
41 typedef std::vector
<std::string
> IconFormats
;
43 // Specified by XDG icon theme specs.
44 static const int kUpdateIntervalInSeconds
= 5;
46 static const size_t kDefaultThemeNum
= 4;
48 static MimeUtilConstants
* GetInstance() {
49 return Singleton
<MimeUtilConstants
>::get();
52 // Store icon directories and their mtimes.
53 IconDirMtimeMap icon_dirs_
;
55 // Store icon formats.
56 IconFormats icon_formats_
;
58 // Store loaded icon_theme.
59 IconThemeMap icon_themes_
;
62 IconTheme
* default_themes_
[kDefaultThemeNum
];
64 TimeTicks last_check_time_
;
66 // The current icon theme, usually set through GTK theme integration.
67 std::string icon_theme_name_
;
71 icon_formats_
.push_back(".png");
72 icon_formats_
.push_back(".svg");
73 icon_formats_
.push_back(".xpm");
75 for (size_t i
= 0; i
< kDefaultThemeNum
; ++i
)
76 default_themes_
[i
] = NULL
;
80 friend struct DefaultSingletonTraits
<MimeUtilConstants
>;
82 DISALLOW_COPY_AND_ASSIGN(MimeUtilConstants
);
85 // IconTheme represents an icon theme as defined by the xdg icon theme spec.
86 // Example themes on GNOME include 'Human' and 'Mist'.
87 // Example themes on KDE include 'crystalsvg' and 'kdeclassic'.
90 // A theme consists of multiple sub-directories, like '32x32' and 'scalable'.
93 // See spec for details.
106 size_t size
; // Nominal size of the icons in this directory.
107 Type type
; // Type of the icon size.
108 size_t max_size
; // Maximum size that the icons can be scaled to.
109 size_t min_size
; // Minimum size that the icons can be scaled to.
110 size_t threshold
; // Maximum difference from desired size. 2 by default.
113 explicit IconTheme(const std::string
& name
);
117 // Returns the path to an icon with the name |icon_name| and a size of |size|
118 // pixels. If the icon does not exist, but |inherits| is true, then look for
119 // the icon in the parent theme.
120 FilePath
GetIconPath(const std::string
& icon_name
, int size
, bool inherits
);
122 // Load a theme with the name |theme_name| into memory. Returns null if theme
124 static IconTheme
* LoadTheme(const std::string
& theme_name
);
127 // Returns the path to an icon with the name |icon_name| in |subdir|.
128 FilePath
GetIconPathUnderSubdir(const std::string
& icon_name
,
129 const std::string
& subdir
);
131 // Whether the theme loaded properly.
133 return index_theme_loaded_
;
136 // Read and parse |file| which is usually named 'index.theme' per theme spec.
137 bool LoadIndexTheme(const FilePath
& file
);
139 // Checks to see if the icons in |info| matches |size| (in pixels). Returns
140 // 0 if they match, or the size difference in pixels.
141 size_t MatchesSize(SubDirInfo
* info
, size_t size
);
143 // Yet another function to read a line.
144 std::string
ReadLine(FILE* fp
);
146 // Set directories to search for icons to the comma-separated list |dirs|.
147 bool SetDirectories(const std::string
& dirs
);
149 bool index_theme_loaded_
; // True if an instance is properly loaded.
150 // store the scattered directories of this theme.
151 std::list
<FilePath
> dirs_
;
153 // store the subdirs of this theme and array index of |info_array_|.
154 std::map
<std::string
, int> subdirs_
;
155 scoped_ptr
<SubDirInfo
[]> info_array_
; // List of sub-directories.
156 std::string inherits_
; // Name of the theme this one inherits from.
159 IconTheme::IconTheme(const std::string
& name
)
160 : index_theme_loaded_(false) {
161 ThreadRestrictions::AssertIOAllowed();
162 // Iterate on all icon directories to find directories of the specified
163 // theme and load the first encountered index.theme.
164 MimeUtilConstants::IconDirMtimeMap::iterator iter
;
166 MimeUtilConstants::IconDirMtimeMap
* icon_dirs
=
167 &MimeUtilConstants::GetInstance()->icon_dirs_
;
168 for (iter
= icon_dirs
->begin(); iter
!= icon_dirs
->end(); ++iter
) {
169 theme_path
= iter
->first
.Append(name
);
170 if (!DirectoryExists(theme_path
))
172 FilePath theme_index
= theme_path
.Append("index.theme");
173 if (!index_theme_loaded_
&& PathExists(theme_index
)) {
174 if (!LoadIndexTheme(theme_index
))
176 index_theme_loaded_
= true;
178 dirs_
.push_back(theme_path
);
182 FilePath
IconTheme::GetIconPath(const std::string
& icon_name
, int size
,
184 std::map
<std::string
, int>::iterator subdir_iter
;
187 for (subdir_iter
= subdirs_
.begin();
188 subdir_iter
!= subdirs_
.end();
190 SubDirInfo
* info
= &info_array_
[subdir_iter
->second
];
191 if (MatchesSize(info
, size
) == 0) {
192 icon_path
= GetIconPathUnderSubdir(icon_name
, subdir_iter
->first
);
193 if (!icon_path
.empty())
197 // Now looking for the mostly matched.
198 size_t min_delta_seen
= 9999;
200 for (subdir_iter
= subdirs_
.begin();
201 subdir_iter
!= subdirs_
.end();
203 SubDirInfo
* info
= &info_array_
[subdir_iter
->second
];
204 size_t delta
= MatchesSize(info
, size
);
205 if (delta
< min_delta_seen
) {
206 FilePath path
= GetIconPathUnderSubdir(icon_name
, subdir_iter
->first
);
208 min_delta_seen
= delta
;
214 if (!icon_path
.empty() || !inherits
|| inherits_
== "")
217 IconTheme
* theme
= LoadTheme(inherits_
);
218 // Inheriting from itself means the theme is buggy but we shouldn't crash.
219 if (theme
&& theme
!= this)
220 return theme
->GetIconPath(icon_name
, size
, inherits
);
225 IconTheme
* IconTheme::LoadTheme(const std::string
& theme_name
) {
226 scoped_ptr
<IconTheme
> theme
;
227 MimeUtilConstants::IconThemeMap
* icon_themes
=
228 &MimeUtilConstants::GetInstance()->icon_themes_
;
229 if (icon_themes
->find(theme_name
) != icon_themes
->end()) {
230 theme
.reset((*icon_themes
)[theme_name
]);
232 theme
.reset(new IconTheme(theme_name
));
233 if (!theme
->IsValid())
235 (*icon_themes
)[theme_name
] = theme
.get();
237 return theme
.release();
240 FilePath
IconTheme::GetIconPathUnderSubdir(const std::string
& icon_name
,
241 const std::string
& subdir
) {
243 std::list
<FilePath
>::iterator dir_iter
;
244 MimeUtilConstants::IconFormats
* icon_formats
=
245 &MimeUtilConstants::GetInstance()->icon_formats_
;
246 for (dir_iter
= dirs_
.begin(); dir_iter
!= dirs_
.end(); ++dir_iter
) {
247 for (size_t i
= 0; i
< icon_formats
->size(); ++i
) {
248 icon_path
= dir_iter
->Append(subdir
);
249 icon_path
= icon_path
.Append(icon_name
+ (*icon_formats
)[i
]);
250 if (PathExists(icon_path
))
257 bool IconTheme::LoadIndexTheme(const FilePath
& file
) {
258 FILE* fp
= base::OpenFile(file
, "r");
259 SubDirInfo
* current_info
= NULL
;
264 while (!feof(fp
) && !ferror(fp
)) {
265 std::string buf
= ReadLine(fp
);
270 TrimWhitespaceASCII(buf
, TRIM_ALL
, &entry
);
271 if (entry
.length() == 0 || entry
[0] == '#') {
272 // Blank line or Comment.
274 } else if (entry
[0] == '[' && info_array_
.get()) {
276 std::string subdir
= entry
.substr(1, entry
.length() - 2);
277 if (subdirs_
.find(subdir
) != subdirs_
.end())
278 current_info
= &info_array_
[subdirs_
[subdir
]];
281 std::string key
, value
;
282 std::vector
<std::string
> r
;
283 SplitStringDontTrim(entry
, '=', &r
);
287 TrimWhitespaceASCII(r
[0], TRIM_ALL
, &key
);
288 for (size_t i
= 1; i
< r
.size(); i
++)
290 TrimWhitespaceASCII(value
, TRIM_ALL
, &value
);
294 current_info
->size
= atoi(value
.c_str());
295 } else if (key
== "Type") {
296 if (value
== "Fixed")
297 current_info
->type
= SubDirInfo::Fixed
;
298 else if (value
== "Scalable")
299 current_info
->type
= SubDirInfo::Scalable
;
300 else if (value
== "Threshold")
301 current_info
->type
= SubDirInfo::Threshold
;
302 } else if (key
== "MaxSize") {
303 current_info
->max_size
= atoi(value
.c_str());
304 } else if (key
== "MinSize") {
305 current_info
->min_size
= atoi(value
.c_str());
306 } else if (key
== "Threshold") {
307 current_info
->threshold
= atoi(value
.c_str());
310 if (key
.compare("Directories") == 0 && !info_array_
.get()) {
311 if (!SetDirectories(value
)) break;
312 } else if (key
.compare("Inherits") == 0) {
313 if (value
!= "hicolor")
320 return info_array_
.get() != NULL
;
323 size_t IconTheme::MatchesSize(SubDirInfo
* info
, size_t size
) {
324 if (info
->type
== SubDirInfo::Fixed
) {
325 if (size
> info
->size
)
326 return size
- info
->size
;
328 return info
->size
- size
;
329 } else if (info
->type
== SubDirInfo::Scalable
) {
330 if (size
< info
->min_size
)
331 return info
->min_size
- size
;
332 if (size
> info
->max_size
)
333 return size
- info
->max_size
;
336 if (size
+ info
->threshold
< info
->size
)
337 return info
->size
- size
- info
->threshold
;
338 if (size
> info
->size
+ info
->threshold
)
339 return size
- info
->size
- info
->threshold
;
344 std::string
IconTheme::ReadLine(FILE* fp
) {
346 return std::string();
349 const size_t kBufferSize
= 100;
350 char buffer
[kBufferSize
];
351 while ((fgets(buffer
, kBufferSize
- 1, fp
)) != NULL
) {
353 size_t len
= result
.length();
356 char end
= result
[len
- 1];
357 if (end
== '\n' || end
== '\0')
364 bool IconTheme::SetDirectories(const std::string
& dirs
) {
366 std::string::size_type pos
= 0, epos
;
368 while ((epos
= dirs
.find(',', pos
)) != std::string::npos
) {
369 TrimWhitespaceASCII(dirs
.substr(pos
, epos
- pos
), TRIM_ALL
, &dir
);
370 if (dir
.length() == 0) {
371 DLOG(WARNING
) << "Invalid index.theme: blank subdir";
374 subdirs_
[dir
] = num
++;
377 TrimWhitespaceASCII(dirs
.substr(pos
), TRIM_ALL
, &dir
);
378 if (dir
.length() == 0) {
379 DLOG(WARNING
) << "Invalid index.theme: blank subdir";
382 subdirs_
[dir
] = num
++;
383 info_array_
.reset(new SubDirInfo
[num
]);
387 bool CheckDirExistsAndGetMtime(const FilePath
& dir
, Time
* last_modified
) {
388 if (!DirectoryExists(dir
))
390 File::Info file_info
;
391 if (!GetFileInfo(dir
, &file_info
))
393 *last_modified
= file_info
.last_modified
;
397 // Make sure |dir| exists and add it to the list of icon directories.
398 void TryAddIconDir(const FilePath
& dir
) {
400 if (!CheckDirExistsAndGetMtime(dir
, &last_modified
))
402 MimeUtilConstants::GetInstance()->icon_dirs_
[dir
] = last_modified
;
405 // For a xdg directory |dir|, add the appropriate icon sub-directories.
406 void AddXDGDataDir(const FilePath
& dir
) {
407 if (!DirectoryExists(dir
))
409 TryAddIconDir(dir
.Append("icons"));
410 TryAddIconDir(dir
.Append("pixmaps"));
413 // Add all the xdg icon directories.
415 FilePath home
= GetHomeDir();
417 FilePath
legacy_data_dir(home
);
418 legacy_data_dir
= legacy_data_dir
.AppendASCII(".icons");
419 if (DirectoryExists(legacy_data_dir
))
420 TryAddIconDir(legacy_data_dir
);
422 const char* env
= getenv("XDG_DATA_HOME");
424 AddXDGDataDir(FilePath(env
));
425 } else if (!home
.empty()) {
426 FilePath
local_data_dir(home
);
427 local_data_dir
= local_data_dir
.AppendASCII(".local");
428 local_data_dir
= local_data_dir
.AppendASCII("share");
429 AddXDGDataDir(local_data_dir
);
432 env
= getenv("XDG_DATA_DIRS");
434 AddXDGDataDir(FilePath("/usr/local/share"));
435 AddXDGDataDir(FilePath("/usr/share"));
437 std::string xdg_data_dirs
= env
;
438 std::string::size_type pos
= 0, epos
;
439 while ((epos
= xdg_data_dirs
.find(':', pos
)) != std::string::npos
) {
440 AddXDGDataDir(FilePath(xdg_data_dirs
.substr(pos
, epos
- pos
)));
443 AddXDGDataDir(FilePath(xdg_data_dirs
.substr(pos
)));
447 void EnsureUpdated() {
448 MimeUtilConstants
* constants
= MimeUtilConstants::GetInstance();
449 if (constants
->last_check_time_
.is_null()) {
450 constants
->last_check_time_
= TimeTicks::Now();
455 // Per xdg theme spec, we should check the icon directories every so often
456 // for newly added icons.
457 TimeDelta time_since_last_check
=
458 TimeTicks::Now() - constants
->last_check_time_
;
459 if (time_since_last_check
.InSeconds() > constants
->kUpdateIntervalInSeconds
) {
460 constants
->last_check_time_
+= time_since_last_check
;
462 bool rescan_icon_dirs
= false;
463 MimeUtilConstants::IconDirMtimeMap
* icon_dirs
= &constants
->icon_dirs_
;
464 MimeUtilConstants::IconDirMtimeMap::iterator iter
;
465 for (iter
= icon_dirs
->begin(); iter
!= icon_dirs
->end(); ++iter
) {
467 if (!CheckDirExistsAndGetMtime(iter
->first
, &last_modified
) ||
468 last_modified
!= iter
->second
) {
469 rescan_icon_dirs
= true;
474 if (rescan_icon_dirs
) {
475 constants
->icon_dirs_
.clear();
476 constants
->icon_themes_
.clear();
482 // Find a fallback icon if we cannot find it in the default theme.
483 FilePath
LookupFallbackIcon(const std::string
& icon_name
) {
484 MimeUtilConstants
* constants
= MimeUtilConstants::GetInstance();
485 MimeUtilConstants::IconDirMtimeMap::iterator iter
;
486 MimeUtilConstants::IconDirMtimeMap
* icon_dirs
= &constants
->icon_dirs_
;
487 MimeUtilConstants::IconFormats
* icon_formats
= &constants
->icon_formats_
;
488 for (iter
= icon_dirs
->begin(); iter
!= icon_dirs
->end(); ++iter
) {
489 for (size_t i
= 0; i
< icon_formats
->size(); ++i
) {
490 FilePath icon
= iter
->first
.Append(icon_name
+ (*icon_formats
)[i
]);
491 if (PathExists(icon
))
498 // Initialize the list of default themes.
499 void InitDefaultThemes() {
500 IconTheme
** default_themes
=
501 MimeUtilConstants::GetInstance()->default_themes_
;
503 scoped_ptr
<Environment
> env(Environment::Create());
504 base::nix::DesktopEnvironment desktop_env
=
505 base::nix::GetDesktopEnvironment(env
.get());
506 if (desktop_env
== base::nix::DESKTOP_ENVIRONMENT_KDE3
||
507 desktop_env
== base::nix::DESKTOP_ENVIRONMENT_KDE4
) {
509 std::string kde_default_theme
;
510 std::string kde_fallback_theme
;
512 // TODO(thestig): Figure out how to get the current icon theme on KDE.
513 // Setting stored in ~/.kde/share/config/kdeglobals under Icons -> Theme.
514 default_themes
[0] = NULL
;
516 // Try some reasonable defaults for KDE.
517 if (desktop_env
== base::nix::DESKTOP_ENVIRONMENT_KDE3
) {
519 kde_default_theme
= "default.kde";
520 kde_fallback_theme
= "crystalsvg";
523 kde_default_theme
= "default.kde4";
524 kde_fallback_theme
= "oxygen";
526 default_themes
[1] = IconTheme::LoadTheme(kde_default_theme
);
527 default_themes
[2] = IconTheme::LoadTheme(kde_fallback_theme
);
529 // Assume it's Gnome and use GTK to figure out the theme.
530 default_themes
[1] = IconTheme::LoadTheme(
531 MimeUtilConstants::GetInstance()->icon_theme_name_
);
532 default_themes
[2] = IconTheme::LoadTheme("gnome");
534 // hicolor needs to be last per icon theme spec.
535 default_themes
[3] = IconTheme::LoadTheme("hicolor");
537 for (size_t i
= 0; i
< MimeUtilConstants::kDefaultThemeNum
; i
++) {
538 if (default_themes
[i
] == NULL
)
540 // NULL out duplicate pointers.
541 for (size_t j
= i
+ 1; j
< MimeUtilConstants::kDefaultThemeNum
; j
++) {
542 if (default_themes
[j
] == default_themes
[i
])
543 default_themes
[j
] = NULL
;
548 // Try to find an icon with the name |icon_name| that's |size| pixels.
549 FilePath
LookupIconInDefaultTheme(const std::string
& icon_name
, int size
) {
551 MimeUtilConstants
* constants
= MimeUtilConstants::GetInstance();
552 MimeUtilConstants::IconThemeMap
* icon_themes
= &constants
->icon_themes_
;
553 if (icon_themes
->empty())
557 IconTheme
** default_themes
= constants
->default_themes_
;
558 for (size_t i
= 0; i
< MimeUtilConstants::kDefaultThemeNum
; i
++) {
559 if (default_themes
[i
]) {
560 icon_path
= default_themes
[i
]->GetIconPath(icon_name
, size
, true);
561 if (!icon_path
.empty())
565 return LookupFallbackIcon(icon_name
);
568 MimeUtilConstants::~MimeUtilConstants() {
569 for (size_t i
= 0; i
< kDefaultThemeNum
; i
++)
570 delete default_themes_
[i
];
575 std::string
GetFileMimeType(const FilePath
& filepath
) {
576 if (filepath
.empty())
577 return std::string();
578 ThreadRestrictions::AssertIOAllowed();
579 AutoLock
scoped_lock(g_mime_util_xdg_lock
.Get());
580 return xdg_mime_get_mime_type_from_file_name(filepath
.value().c_str());
583 std::string
GetDataMimeType(const std::string
& data
) {
584 ThreadRestrictions::AssertIOAllowed();
585 AutoLock
scoped_lock(g_mime_util_xdg_lock
.Get());
586 return xdg_mime_get_mime_type_for_data(data
.data(), data
.length(), NULL
);
589 void SetIconThemeName(const std::string
& name
) {
590 // If the theme name is already loaded, do nothing. Chrome doesn't respond
591 // to changes in the system theme, so we never need to set this more than
593 if (!MimeUtilConstants::GetInstance()->icon_theme_name_
.empty())
596 MimeUtilConstants::GetInstance()->icon_theme_name_
= name
;
599 FilePath
GetMimeIcon(const std::string
& mime_type
, size_t size
) {
600 ThreadRestrictions::AssertIOAllowed();
601 std::vector
<std::string
> icon_names
;
602 std::string icon_name
;
605 if (!mime_type
.empty()) {
606 AutoLock
scoped_lock(g_mime_util_xdg_lock
.Get());
607 const char *icon
= xdg_mime_get_icon(mime_type
.c_str());
608 icon_name
= std::string(icon
? icon
: "");
611 if (icon_name
.length())
612 icon_names
.push_back(icon_name
);
614 // For text/plain, try text-plain.
615 icon_name
= mime_type
;
616 for (size_t i
= icon_name
.find('/', 0); i
!= std::string::npos
;
617 i
= icon_name
.find('/', i
+ 1)) {
620 icon_names
.push_back(icon_name
);
621 // Also try gnome-mime-text-plain.
622 icon_names
.push_back("gnome-mime-" + icon_name
);
624 // Try "deb" for "application/x-deb" in KDE 3.
625 size_t x_substr_pos
= mime_type
.find("/x-");
626 if (x_substr_pos
!= std::string::npos
) {
627 icon_name
= mime_type
.substr(x_substr_pos
+ 3);
628 icon_names
.push_back(icon_name
);
631 // Try generic name like text-x-generic.
632 icon_name
= mime_type
.substr(0, mime_type
.find('/')) + "-x-generic";
633 icon_names
.push_back(icon_name
);
636 icon_names
.push_back("unknown");
638 for (size_t i
= 0; i
< icon_names
.size(); i
++) {
639 if (icon_names
[i
][0] == '/') {
640 icon_file
= FilePath(icon_names
[i
]);
641 if (PathExists(icon_file
))
644 icon_file
= LookupIconInDefaultTheme(icon_names
[i
], size
);
645 if (!icon_file
.empty())