// Copyright 2013 The Chromium Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #include "shell/browser/ui/gtk/app_indicator_icon.h" #include #include #include #include #include #include "base/bind.h" #include "base/environment.h" #include "base/files/file_util.h" #include "base/hash/md5.h" #include "base/memory/ref_counted_memory.h" #include "base/strings/string_number_conversions.h" #include "base/strings/stringprintf.h" #include "base/strings/utf_string_conversions.h" #include "base/task/post_task.h" #include "content/public/browser/browser_thread.h" #include "shell/browser/ui/gtk/app_indicator_icon_menu.h" #include "third_party/skia/include/core/SkBitmap.h" #include "third_party/skia/include/core/SkCanvas.h" #include "ui/base/models/menu_model.h" #include "ui/gfx/codec/png_codec.h" #include "ui/gfx/image/image.h" #include "ui/gfx/image/image_skia.h" namespace { typedef enum { APP_INDICATOR_CATEGORY_APPLICATION_STATUS, APP_INDICATOR_CATEGORY_COMMUNICATIONS, APP_INDICATOR_CATEGORY_SYSTEM_SERVICES, APP_INDICATOR_CATEGORY_HARDWARE, APP_INDICATOR_CATEGORY_OTHER } AppIndicatorCategory; typedef enum { APP_INDICATOR_STATUS_PASSIVE, APP_INDICATOR_STATUS_ACTIVE, APP_INDICATOR_STATUS_ATTENTION } AppIndicatorStatus; typedef AppIndicator* (*app_indicator_new_func)(const gchar* id, const gchar* icon_name, AppIndicatorCategory category); typedef AppIndicator* (*app_indicator_new_with_path_func)( const gchar* id, const gchar* icon_name, AppIndicatorCategory category, const gchar* icon_theme_path); typedef void (*app_indicator_set_status_func)(AppIndicator* self, AppIndicatorStatus status); typedef void (*app_indicator_set_attention_icon_full_func)( AppIndicator* self, const gchar* icon_name, const gchar* icon_desc); typedef void (*app_indicator_set_menu_func)(AppIndicator* self, GtkMenu* menu); typedef void (*app_indicator_set_icon_full_func)(AppIndicator* self, const gchar* icon_name, const gchar* icon_desc); typedef void (*app_indicator_set_icon_theme_path_func)( AppIndicator* self, const gchar* icon_theme_path); bool g_attempted_load = false; bool g_opened = false; // Retrieved functions from libappindicator. app_indicator_new_func app_indicator_new = nullptr; app_indicator_new_with_path_func app_indicator_new_with_path = nullptr; app_indicator_set_status_func app_indicator_set_status = nullptr; app_indicator_set_attention_icon_full_func app_indicator_set_attention_icon_full = nullptr; app_indicator_set_menu_func app_indicator_set_menu = nullptr; app_indicator_set_icon_full_func app_indicator_set_icon_full = nullptr; app_indicator_set_icon_theme_path_func app_indicator_set_icon_theme_path = nullptr; void EnsureLibAppIndicatorLoaded() { if (g_attempted_load) return; g_attempted_load = true; std::string lib_name = "libappindicator" + base::NumberToString(GTK_MAJOR_VERSION) + ".so"; void* indicator_lib = dlopen(lib_name.c_str(), RTLD_LAZY); if (!indicator_lib) { lib_name += ".1"; indicator_lib = dlopen(lib_name.c_str(), RTLD_LAZY); } if (!indicator_lib) return; g_opened = true; app_indicator_new = reinterpret_cast( dlsym(indicator_lib, "app_indicator_new")); app_indicator_new_with_path = reinterpret_cast( dlsym(indicator_lib, "app_indicator_new_with_path")); app_indicator_set_status = reinterpret_cast( dlsym(indicator_lib, "app_indicator_set_status")); app_indicator_set_attention_icon_full = reinterpret_cast( dlsym(indicator_lib, "app_indicator_set_attention_icon_full")); app_indicator_set_menu = reinterpret_cast( dlsym(indicator_lib, "app_indicator_set_menu")); app_indicator_set_icon_full = reinterpret_cast( dlsym(indicator_lib, "app_indicator_set_icon_full")); app_indicator_set_icon_theme_path = reinterpret_cast( dlsym(indicator_lib, "app_indicator_set_icon_theme_path")); } // Writes |bitmap| to a file at |path|. Returns true if successful. bool WriteFile(const base::FilePath& path, const SkBitmap& bitmap) { std::vector png_data; if (!gfx::PNGCodec::EncodeBGRASkBitmap(bitmap, false, &png_data)) return false; int bytes_written = base::WriteFile( path, reinterpret_cast(&png_data[0]), png_data.size()); return (bytes_written == static_cast(png_data.size())); } void DeleteTempDirectory(const base::FilePath& dir_path) { if (dir_path.empty()) return; base::DeletePathRecursively(dir_path); } } // namespace namespace electron { namespace gtkui { AppIndicatorIcon::AppIndicatorIcon(std::string id, const gfx::ImageSkia& image, const base::string16& tool_tip) : id_(id), icon_(nullptr), menu_model_(nullptr), icon_change_count_(0) { std::unique_ptr env(base::Environment::Create()); desktop_env_ = base::nix::GetDesktopEnvironment(env.get()); EnsureLibAppIndicatorLoaded(); tool_tip_ = base::UTF16ToUTF8(tool_tip); SetIcon(image); } AppIndicatorIcon::~AppIndicatorIcon() { if (icon_) { app_indicator_set_status(icon_, APP_INDICATOR_STATUS_PASSIVE); g_object_unref(icon_); base::PostTask( FROM_HERE, {base::ThreadPool(), base::MayBlock(), base::TaskPriority::BEST_EFFORT}, base::BindOnce(&DeleteTempDirectory, temp_dir_)); } } // static bool AppIndicatorIcon::CouldOpen() { EnsureLibAppIndicatorLoaded(); return g_opened; } void AppIndicatorIcon::SetIcon(const gfx::ImageSkia& image) { if (!g_opened) return; ++icon_change_count_; // Copy the bitmap because it may be freed by the time it's accessed in // another thread. SkBitmap safe_bitmap = *image.bitmap(); const base::TaskTraits kTraits = { base::ThreadPool(), base::MayBlock(), base::TaskPriority::USER_VISIBLE, base::TaskShutdownBehavior::SKIP_ON_SHUTDOWN}; if (desktop_env_ == base::nix::DESKTOP_ENVIRONMENT_KDE4 || desktop_env_ == base::nix::DESKTOP_ENVIRONMENT_KDE5) { base::PostTaskAndReplyWithResult( FROM_HERE, kTraits, base::BindOnce(AppIndicatorIcon::WriteKDE4TempImageOnWorkerThread, safe_bitmap, temp_dir_), base::BindOnce(&AppIndicatorIcon::SetImageFromFile, weak_factory_.GetWeakPtr())); } else { base::PostTaskAndReplyWithResult( FROM_HERE, kTraits, base::BindOnce(AppIndicatorIcon::WriteUnityTempImageOnWorkerThread, safe_bitmap, icon_change_count_, id_), base::BindOnce(&AppIndicatorIcon::SetImageFromFile, weak_factory_.GetWeakPtr())); } } void AppIndicatorIcon::SetToolTip(const base::string16& tool_tip) { DCHECK(!tool_tip_.empty()); tool_tip_ = base::UTF16ToUTF8(tool_tip); UpdateClickActionReplacementMenuItem(); } void AppIndicatorIcon::UpdatePlatformContextMenu(ui::MenuModel* model) { if (!g_opened) return; menu_model_ = model; // The icon is created asynchronously so it might not exist when the menu is // set. if (icon_) SetMenu(); } void AppIndicatorIcon::RefreshPlatformContextMenu() { menu_->Refresh(); } // static AppIndicatorIcon::SetImageFromFileParams AppIndicatorIcon::WriteKDE4TempImageOnWorkerThread( const SkBitmap& bitmap, const base::FilePath& existing_temp_dir) { base::FilePath temp_dir = existing_temp_dir; if (temp_dir.empty() && !base::CreateNewTempDirectory(base::FilePath::StringType(), &temp_dir)) { LOG(WARNING) << "Could not create temporary directory"; return SetImageFromFileParams(); } base::FilePath icon_theme_path = temp_dir.AppendASCII("icons"); // On KDE4, an image located in a directory ending with // "icons/hicolor/22x22/apps" can be used as the app indicator image because // "/usr/share/icons/hicolor/22x22/apps" exists. base::FilePath image_dir = icon_theme_path.AppendASCII("hicolor").AppendASCII("22x22").AppendASCII( "apps"); if (!base::CreateDirectory(image_dir)) return SetImageFromFileParams(); // On KDE4, the name of the image file for each different looking bitmap must // be unique. It must also be unique across runs of Chrome. std::vector bitmap_png_data; if (!gfx::PNGCodec::EncodeBGRASkBitmap(bitmap, false, &bitmap_png_data)) { LOG(WARNING) << "Could not encode icon"; return SetImageFromFileParams(); } base::MD5Digest digest; base::MD5Sum(reinterpret_cast(&bitmap_png_data[0]), bitmap_png_data.size(), &digest); std::string icon_name = base::StringPrintf( "electron_app_indicator2_%s", base::MD5DigestToBase16(digest).c_str()); // If |bitmap| is smaller than 22x22, KDE does some really ugly resizing. // Pad |bitmap| with transparent pixels to make it 22x22. const int kMinimalSize = 22; SkBitmap scaled_bitmap; scaled_bitmap.allocN32Pixels(std::max(bitmap.width(), kMinimalSize), std::max(bitmap.height(), kMinimalSize)); scaled_bitmap.eraseARGB(0, 0, 0, 0); SkCanvas canvas(scaled_bitmap); canvas.drawBitmap(bitmap, (scaled_bitmap.width() - bitmap.width()) / 2, (scaled_bitmap.height() - bitmap.height()) / 2); base::FilePath image_path = image_dir.Append(icon_name + ".png"); if (!WriteFile(image_path, scaled_bitmap)) return SetImageFromFileParams(); SetImageFromFileParams params; params.parent_temp_dir = temp_dir; params.icon_theme_path = icon_theme_path.value(); params.icon_name = icon_name; return params; } // static AppIndicatorIcon::SetImageFromFileParams AppIndicatorIcon::WriteUnityTempImageOnWorkerThread(const SkBitmap& bitmap, int icon_change_count, const std::string& id) { // Create a new temporary directory for each image on Unity since using a // single temporary directory seems to have issues when changing icons in // quick succession. base::FilePath temp_dir; if (!base::CreateNewTempDirectory(base::FilePath::StringType(), &temp_dir)) { LOG(WARNING) << "Could not create temporary directory"; return SetImageFromFileParams(); } std::string icon_name = base::StringPrintf("%s_%d", id.c_str(), icon_change_count); base::FilePath image_path = temp_dir.Append(icon_name + ".png"); SetImageFromFileParams params; if (WriteFile(image_path, bitmap)) { params.parent_temp_dir = temp_dir; params.icon_theme_path = temp_dir.value(); params.icon_name = icon_name; } return params; } void AppIndicatorIcon::SetImageFromFile(const SetImageFromFileParams& params) { DCHECK_CURRENTLY_ON(content::BrowserThread::UI); if (params.icon_theme_path.empty()) return; if (!icon_) { icon_ = app_indicator_new_with_path(id_.c_str(), params.icon_name.c_str(), APP_INDICATOR_CATEGORY_APPLICATION_STATUS, params.icon_theme_path.c_str()); app_indicator_set_status(icon_, APP_INDICATOR_STATUS_ACTIVE); SetMenu(); } else { app_indicator_set_icon_theme_path(icon_, params.icon_theme_path.c_str()); app_indicator_set_icon_full(icon_, params.icon_name.c_str(), "icon"); } if (temp_dir_ != params.parent_temp_dir) { base::PostTask( FROM_HERE, {base::ThreadPool(), base::MayBlock(), base::TaskPriority::BEST_EFFORT}, base::BindOnce(&DeleteTempDirectory, temp_dir_)); temp_dir_ = params.parent_temp_dir; } } void AppIndicatorIcon::SetMenu() { menu_ = std::make_unique(menu_model_); UpdateClickActionReplacementMenuItem(); app_indicator_set_menu(icon_, menu_->GetGtkMenu()); } void AppIndicatorIcon::UpdateClickActionReplacementMenuItem() { // The menu may not have been created yet. if (!menu_.get()) return; if (!delegate()->HasClickAction() && menu_model_) return; DCHECK(!tool_tip_.empty()); menu_->UpdateClickActionReplacementMenuItem( tool_tip_.c_str(), base::Bind(&AppIndicatorIcon::OnClickActionReplacementMenuItemActivated, base::Unretained(this))); } void AppIndicatorIcon::OnClickActionReplacementMenuItemActivated() { if (delegate()) delegate()->OnClick(); } } // namespace gtkui } // namespace electron