gnome-control-center/panels/background/cc-background-preview.c

/* cc-background-preview.c
 *
 * Copyright 2019 Georges Basile Stavracas Neto <georges.stavracas@gmail.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */

#include "cc-background-preview.h"

struct _CcBackgroundPreview
{
  GtkBox            parent;

  GtkWidget        *animated_background_icon;
  GtkLabel         *desktop_clock_label;
  GtkWidget        *drawing_area;
  GtkLabel         *lock_screen_label;
  GtkStack         *stack;

  GnomeDesktopThumbnailFactory *thumbnail_factory;

  CcBackgroundItem *item;
  GSettings        *desktop_settings;

  guint             lock_screen_time_timeout_id;
  gboolean          is_lock_screen;
  GDateTime        *previous_time;
  gboolean          is_24h_format;
};

G_DEFINE_TYPE (CcBackgroundPreview, cc_background_preview, GTK_TYPE_BOX)

enum
{
  PROP_0,
  PROP_IS_LOCK_SCREEN,
  PROP_ITEM,
  N_PROPS
};

static GParamSpec *properties [N_PROPS];

/* Auxiliary methods */

static void
update_lock_screen_label (CcBackgroundPreview *self,
                          gboolean             force)
{
  g_autoptr(GDateTime) now = NULL;
  g_autofree gchar *label = NULL;

  now = g_date_time_new_now_local ();

  /* Don't update the label if the hour:minute pair did not change */
  if (!force && self->previous_time &&
      g_date_time_get_hour (now) == g_date_time_get_hour (self->previous_time) &&
      g_date_time_get_minute (now) == g_date_time_get_minute (self->previous_time))
    {
      return;
    }

  if (self->is_24h_format)
    label = g_date_time_format (now, "%R");
  else
    label = g_date_time_format (now, "%I:%M %p");

  gtk_label_set_label (self->lock_screen_label, label);
  gtk_label_set_label (self->desktop_clock_label, label);

  g_clear_pointer (&self->previous_time, g_date_time_unref);
  self->previous_time = g_steal_pointer (&now);
}

static void
update_clock_format (CcBackgroundPreview *self)
{
  g_autofree gchar *clock_format = NULL;
  gboolean is_24h_format;

  clock_format = g_settings_get_string (self->desktop_settings, "clock-format");
  is_24h_format = g_strcmp0 (clock_format, "24h") == 0;

  if (is_24h_format != self->is_24h_format)
    {
      self->is_24h_format = is_24h_format;
      update_lock_screen_label (self, TRUE);
    }
}

static void
load_custom_css (CcBackgroundPreview *self)
{
  g_autoptr(GtkCssProvider) provider = NULL;

  /* use custom CSS */
  provider = gtk_css_provider_new ();
  gtk_css_provider_load_from_resource (provider, "/org/gnome/control-center/background/preview.css");
  gtk_style_context_add_provider_for_screen (gdk_screen_get_default (),
                                             GTK_STYLE_PROVIDER (provider),
                                             GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);

}

static gboolean
update_clock_cb (gpointer data)
{
  CcBackgroundPreview *self = data;

  update_lock_screen_label (self, FALSE);

  return G_SOURCE_CONTINUE;
}

static void
start_monitor_time (CcBackgroundPreview *self)
{
  if (self->lock_screen_time_timeout_id > 0)
    return;

  self->lock_screen_time_timeout_id = g_timeout_add_seconds (1,
                                                             update_clock_cb,
                                                             self);
}

static void
stop_monitor_time (CcBackgroundPreview *self)
{
  if (self->lock_screen_time_timeout_id > 0)
    {
      g_source_remove (self->lock_screen_time_timeout_id);
      self->lock_screen_time_timeout_id = 0;
    }
}


/* Callbacks */

static gboolean
on_preview_draw_cb (GtkWidget           *widget,
                    cairo_t             *cr,
                    CcBackgroundPreview *self)
{
  g_autoptr(GdkPixbuf) pixbuf = NULL;
  GtkAllocation allocation;
  gint scale_factor;

  if (!self->item)
    return FALSE;

  scale_factor = gtk_widget_get_scale_factor (widget);
  gtk_widget_get_allocation (widget, &allocation);
  pixbuf = cc_background_item_get_frame_thumbnail (self->item,
                                                   self->thumbnail_factory,
                                                   allocation.width,
                                                   allocation.height,
                                                   scale_factor,
                                                   0,
                                                   TRUE);


  gdk_cairo_set_source_pixbuf (cr, pixbuf, 0, 0);
  cairo_paint (cr);

  return TRUE;
}

/* GObject overrides */

static void
cc_background_preview_finalize (GObject *object)
{
  CcBackgroundPreview *self = (CcBackgroundPreview *)object;

  g_clear_object (&self->desktop_settings);
  g_clear_object (&self->item);
  g_clear_object (&self->thumbnail_factory);

  g_clear_pointer (&self->previous_time, g_date_time_unref);

  stop_monitor_time (self);

  G_OBJECT_CLASS (cc_background_preview_parent_class)->finalize (object);
}

static void
cc_background_preview_get_property (GObject    *object,
                                    guint       prop_id,
                                    GValue     *value,
                                    GParamSpec *pspec)
{
  CcBackgroundPreview *self = CC_BACKGROUND_PREVIEW (object);

  switch (prop_id)
    {
    case PROP_IS_LOCK_SCREEN:
      g_value_set_boolean (value, self->is_lock_screen);
      break;

    case PROP_ITEM:
      g_value_set_object (value, self->item);
      break;

    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
cc_background_preview_set_property (GObject      *object,
                                    guint         prop_id,
                                    const GValue *value,
                                    GParamSpec   *pspec)
{
  CcBackgroundPreview *self = CC_BACKGROUND_PREVIEW (object);

  switch (prop_id)
    {
    case PROP_IS_LOCK_SCREEN:
      self->is_lock_screen = g_value_get_boolean (value);
      gtk_stack_set_visible_child_name (self->stack,
                                        self->is_lock_screen ? "lock" : "desktop");
      if (self->is_lock_screen)
        start_monitor_time (self);
      else
        stop_monitor_time (self);
      break;

    case PROP_ITEM:
      cc_background_preview_set_item (self, g_value_get_object (value));
      break;

    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static GtkSizeRequestMode
cc_background_preview_get_request_mode (GtkWidget *widget)
{
  return GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH;
}

static gfloat
get_primary_monitor_aspect_ratio (void)
{
  GdkDisplay *display;
  GdkMonitor *primary_monitor;
  gfloat aspect_ratio;

  display = gdk_display_get_default ();
  primary_monitor = gdk_display_get_primary_monitor (display);
  aspect_ratio = 16.0 / 9.0;

  if (primary_monitor)
    {
      GdkRectangle monitor_layout;
      gdk_monitor_get_geometry (primary_monitor, &monitor_layout);
      aspect_ratio = monitor_layout.width / (gfloat) monitor_layout.height;
    }

  return aspect_ratio;
}

static void
cc_background_preview_get_preferred_height_for_width (GtkWidget *widget,
                                                      gint       width,
                                                      gint      *minimum,
                                                      gint      *natural)
{
  gfloat aspect_ratio = get_primary_monitor_aspect_ratio ();

  *minimum = *natural = MAX (2, width / aspect_ratio);
}

static void
cc_background_preview_get_preferred_width_for_height (GtkWidget *widget,
                                                      gint       height,
                                                      gint      *minimum,
                                                      gint      *natural)
{
  gfloat aspect_ratio = get_primary_monitor_aspect_ratio ();

  *minimum = *natural = MAX (2, height * aspect_ratio);
}

static void
cc_background_preview_class_init (CcBackgroundPreviewClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);
  GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);

  object_class->finalize = cc_background_preview_finalize;
  object_class->get_property = cc_background_preview_get_property;
  object_class->set_property = cc_background_preview_set_property;

  widget_class->get_request_mode = cc_background_preview_get_request_mode;
  widget_class->get_preferred_height_for_width = cc_background_preview_get_preferred_height_for_width;
  widget_class->get_preferred_width_for_height = cc_background_preview_get_preferred_width_for_height;

  properties[PROP_IS_LOCK_SCREEN] = g_param_spec_boolean ("is-lock-screen",
                                                          "Lock screen",
                                                          "Whether the preview is of the lock screen",
                                                          FALSE,
                                                          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

  properties[PROP_ITEM] = g_param_spec_object ("item",
                                               "Item",
                                               "Background item",
                                               CC_TYPE_BACKGROUND_ITEM,
                                               G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

  g_object_class_install_properties (object_class, N_PROPS, properties);

  gtk_widget_class_set_template_from_resource (widget_class, "/org/gnome/control-center/background/cc-background-preview.ui");

  gtk_widget_class_bind_template_child (widget_class, CcBackgroundPreview, animated_background_icon);
  gtk_widget_class_bind_template_child (widget_class, CcBackgroundPreview, desktop_clock_label);
  gtk_widget_class_bind_template_child (widget_class, CcBackgroundPreview, drawing_area);
  gtk_widget_class_bind_template_child (widget_class, CcBackgroundPreview, lock_screen_label);
  gtk_widget_class_bind_template_child (widget_class, CcBackgroundPreview, stack);

  gtk_widget_class_bind_template_callback (widget_class, on_preview_draw_cb);
}

static void
cc_background_preview_init (CcBackgroundPreview *self)
{
  gtk_widget_init_template (GTK_WIDGET (self));

  self->thumbnail_factory = gnome_desktop_thumbnail_factory_new (GNOME_DESKTOP_THUMBNAIL_SIZE_LARGE);
  self->desktop_settings = g_settings_new ("org.gnome.desktop.interface");

  g_signal_connect_object (self->desktop_settings,
                           "changed::clock-format",
                           G_CALLBACK (update_clock_format),
                           self,
                           G_CONNECT_SWAPPED);

  update_clock_format (self);
  load_custom_css (self);
}

CcBackgroundItem*
cc_background_preview_get_item (CcBackgroundPreview *self)
{
  g_return_val_if_fail (CC_IS_BACKGROUND_PREVIEW (self), NULL);

  return self->item;
}

void
cc_background_preview_set_item (CcBackgroundPreview *self,
                                CcBackgroundItem    *item)
{
  g_return_if_fail (CC_IS_BACKGROUND_PREVIEW (self));
  g_return_if_fail (CC_IS_BACKGROUND_ITEM (item));

  if (!g_set_object (&self->item, item))
    return;

  gtk_widget_set_visible (self->animated_background_icon,
                          cc_background_item_changes_with_time (item));

  gtk_widget_queue_draw (self->drawing_area);

  g_object_notify_by_pspec (G_OBJECT (self), properties[PROP_ITEM]);
}