Merge lp:~teemperor/pantheon-greeter/wallpaper-settings-from-file into lp:~elementary-pantheon/pantheon-greeter/trunk

[Raphael Isemann]

LightDM-API doesn't supply things like scaling-method and primary/secondary-color via it's API and there is no way to read a dconf-db on in a folder where we don't have the access rights. Also, the LightDM Api seems to no longer recognize our way of determining the wallpapers (?).

So we read from now on the necessary information for the wallpaper from a file from the disk.
The file is named greeter-settings and is just a set of UTF-8-encoded key-value pars.
It is located directory in the home-folder of each user as we can read that on elementary OS due to 755 rights.

For other distributions like arch (which use 700-rights by default) we need to make a workaround with an external directory in case the user wants it background displayed without making his home 755 or 711.

This merge adds the functionality to the greeter that we read the file from the disk and display the wallpaper itself. Things like scaling and color are ignored for now, if i would add this too to the patch we would end up with a humongous match that nobody wants to review (like last time when i started dumping patches on lp).

Things that should be tested:

* It can read the wallpaper from the disk and displays it in any form (scaling is as said not the target of this patch).

* It doesn't crash on a malformed greeter-settings file

You can use this program [1] to generate a greeter-settings file for now. It's up to decision on what way this file will be written (gala-plugin, cerbere-service, directly from the shell-plug).

Cheers

[1] http://pastebin.com/pUD257Xw

[Raphael Isemann (teemperor)]

Patch was not supposed to be that big, i renamed Wallpaper.vala to WallpaperActor.vala due to the fact that one now represents the actual Wallpaper and the other the actor on the screen. The renaming made the diff quite big.

[Raphael Isemann (teemperor)]

It seems i also fixed the no-wallpaper without userchange bug with that.

[Cody Garver (codygarver)]

Use bzr mv!

review: Needs Fixing

Unmerged revisions

276. By Raphael Isemann on 2014-08-04

We now read the wallpaper from a .greeter-settings file

=== modified file 'src/PantheonGreeter.vala'
--- src/PantheonGreeter.vala	2014-03-13 21:16:43 +0000
+++ src/PantheonGreeter.vala	2014-08-04 20:29:46 +0000
@@ -30,12 +30,10 @@
 
     TimeLabel time;
     Indicators indicators;
-    Wallpaper wallpaper;
+    WallpaperActor wallpaper;
 
     Settings settings;
 
-
-
     public static PantheonGreeter instance { get; private set; }
 
     //from this width on we use the shrinked down version
@@ -73,7 +71,7 @@
         userlist_actor = new UserListActor (userlist);
         time = new TimeLabel ();
         indicators = new Indicators (settings);
-        wallpaper = new Wallpaper ();
+        wallpaper = new WallpaperActor ();
 
 
         get_screen ().monitors_changed.connect (monitors_changed);
@@ -86,7 +84,7 @@
         monitors_changed ();
 
         userlist.current_user_changed.connect ((user) => {
-            wallpaper.set_wallpaper (user.background);
+            wallpaper.set_wallpaper (user.wallpaper);
             indicators.keyboard_menu.user_changed_cb (user);
         });
 
@@ -260,4 +258,4 @@
     Gtk.main ();
 
     return Posix.EXIT_SUCCESS;
-}
+}
\ No newline at end of file

=== modified file 'src/PantheonUser.vala'
--- src/PantheonUser.vala	2014-03-13 15:53:44 +0000
+++ src/PantheonUser.vala	2014-08-04 20:29:46 +0000
@@ -35,11 +35,14 @@
 
     public UserType usertype { get; private set; }
 
+    public Wallpaper wallpaper { get; private set; }
+
     public LoginOption (int index, LightDM.User user) {
         this.index = index;
         this.user = user;
         usertype = UserType.NORMAL;
         avatar_ready = false;
+        wallpaper = new Wallpaper.from_user (user);
     }
 
     public LoginOption.Guest (int index) {
@@ -47,6 +50,7 @@
         usertype = UserType.GUEST;
         user = null;
         avatar_ready = true;
+        wallpaper = new Wallpaper.with_default_settings ();
     }
 
     public LoginOption.Manual (int index) {
@@ -54,6 +58,7 @@
         usertype = UserType.MANUAL;
         user = null;
         avatar_ready = true;
+        wallpaper = new Wallpaper.with_default_settings ();
     }
 
     public string get_markup () {
@@ -99,17 +104,6 @@
         }
     }
 
-    public string background {
-        get {
-            switch(usertype) {
-            case UserType.NORMAL: return get_lightdm_user ().background;
-            case UserType.MANUAL: return "";
-            case UserType.GUEST: return "";
-            }
-            return "";
-        }
-    }
-
     public string display_name {
         get {
             switch(usertype) {
@@ -131,7 +125,7 @@
             return "";
         }
     }
-    
+
     public bool logged_in {
         get {
             switch(usertype) {
@@ -157,4 +151,4 @@
     public bool is_normal () {
         return usertype == UserType.NORMAL;
     }
-}
+}
\ No newline at end of file

=== modified file 'src/UserList.vala'
--- src/UserList.vala	2014-03-12 00:26:46 +0000
+++ src/UserList.vala	2014-08-04 20:29:46 +0000
@@ -62,7 +62,7 @@
         size = index;
 
         foreach (LoginOption user in users) {
-            user.load_avatar ();
+            user.load_avatar.begin ();
         }
     }
 
@@ -91,4 +91,4 @@
             return get_user (i - 1);
         return get_user (i);
     }
-}
+}
\ No newline at end of file

=== modified file 'src/Wallpaper.vala'
--- src/Wallpaper.vala	2014-03-13 17:16:53 +0000
+++ src/Wallpaper.vala	2014-08-04 20:29:46 +0000
@@ -19,192 +19,107 @@
     END LICENSE
 ***/
 
-/**
- * Represents a area on the screen where the current wallpaper of a user gets
- * displayed.
- */
-public class Wallpaper : Clutter.Group {
-    /**
-     * 
-     */
-    List<GtkClutter.Texture> wallpapers = new List<GtkClutter.Texture> ();
-    List<Cancellable> loading_wallpapers = new List<Cancellable> ();
-    
-    /**
-     * Contains old Textures that were used for wallpapers. They are recycled
-     * in the @make_texture method.
-     */
-    Queue<GtkClutter.Texture> unused_wallpapers = new Queue<GtkClutter.Texture> ();
-
-    int gpu_limit;
-
-    string[] cache_path = {};
-    Gdk.Pixbuf[] cache_pixbuf = {};
-    int max_cache = 3;
-
-    string last_loaded = "";
-
-    public int screen_width { get; set; }
-    public int screen_height { get; set; }
-
-    public Wallpaper () {
-        GL.GLint result = 1;
-        GL.glGetIntegerv(GL.GL_MAX_TEXTURE_SIZE, out result);
-        gpu_limit = result;
-    }
-
-    string get_default () {
-        return new GLib.Settings ("org.pantheon.desktop.greeter").get_string ("default-wallpaper");
-    }
-
-    public void reposition () {
-        set_wallpaper (last_loaded);
-    }
-
-    public void set_wallpaper (string? path) {
-        var file_path = (path == null || path == "") ? get_default () : path;
-
-        var file = File.new_for_path (file_path);
-
-        if (!file.query_exists ()) {
-            warning ("File %s does not exist!\n", file_path);
-            return;
-        }
-
-        last_loaded = file_path;
-
-        clean_cache ();
-        load_wallpaper.begin (file_path, file);
-    }
-
-    async void load_wallpaper (string path, File file) {
-
+public errordomain SettingsParserError { NO_FILE, MALFORMED, OPTION, COLOR }
+
+public enum PictureOption { NONE, WALLPAPER, CENTERED, SCALED, STRETCHED, ZOOM, SPANNED }
+
+public class Wallpaper {
+
+    public string uri { get; private set; }
+    public PictureOption option { get; private set; }
+    public Clutter.Color primary_color { get; private set; }
+    public Clutter.Color secondary_color { get; private set; }
+    public string fallback_uri { get; private set; }
+
+    public Wallpaper.with_default_settings () {
+        apply_default_settings ();
+    }
+
+    public Wallpaper.from_user (LightDM.User user) {
+        apply_default_settings ();
         try {
-            Gdk.Pixbuf? buf = try_load_from_cache (path);
-            //if we still dont have a wallpaper now, load from file
-            if (buf == null) {
-                var cancelable = new Cancellable ();
-                loading_wallpapers.append (cancelable);
-                InputStream stream = yield file.read_async (GLib.Priority.DEFAULT);
-                buf = yield Gdk.Pixbuf.new_from_stream_async (stream, cancelable);
-                loading_wallpapers.remove (cancelable);
-                // we downscale the pixbuf as far as we can on the CPU
-                buf = validate_pixbuf (buf);
-                //add loaded wallpapers and paths to cache
-                cache_path += path;
-                cache_pixbuf += buf;
-            }
-            //check if the currently loaded wallpaper is the one we loaded in this method
-            if (last_loaded != path)
-                return; //if not, abort
-
-            var new_wallpaper = make_texture ();
-            new_wallpaper.opacity = 0;
-            new_wallpaper.set_from_pixbuf (buf);
-            resize (new_wallpaper);
-            add_child (new_wallpaper);
-            new_wallpaper.animate (Clutter.AnimationMode.EASE_OUT_QUINT, 500, opacity: 255);
-
-            // abort all currently loading wallpapers
-            foreach (var c in loading_wallpapers) {
-                c.cancel ();
-            }
-            foreach (var other_wallpaper in wallpapers) {
-                wallpapers.remove (other_wallpaper);
-                other_wallpaper.animate (Clutter.AnimationMode.EASE_IN_QUINT, 500, opacity: 0).completed.connect (() => {
-                    remove_child (other_wallpaper);
-                    unused_wallpapers.push_tail (other_wallpaper);
-                });
-            }
-            wallpapers.append (new_wallpaper);
-
+            string settings_path = Path.build_path ("/",
+                    user.home_directory, ".greeter-settings");
+            File settings_file = File.new_for_path (settings_path);
+
+            if (!settings_file.query_exists ()) {
+                throw new SettingsParserError.NO_FILE ("Missing .greeter-settings file in home-directory");
+            }
+
+            var dis = new DataInputStream (settings_file.read ());
+            string line;
+
+            while ((line = dis.read_line (null)) != null) {
+                string[] keyvalue = line.split ("=", 2);
+                if (keyvalue.length != 2) {
+                    throw new SettingsParserError.MALFORMED ("Missing = delimiter in file");
+                }
+                keyvalue[0] = keyvalue[0].strip ();
+                keyvalue[1] = keyvalue[1].strip ();
+                switch (keyvalue[0]) {
+                    case "picture-uri":
+                        uri = keyvalue[1];
+                        break;
+                    case "picture-option":
+                        option = parse_option (keyvalue[1]);
+                        break;
+                    case "primary-color":
+                        if (!primary_color.parse_string (keyvalue[1]))
+                            throw new SettingsParserError.COLOR ("primary-color couldn't be parsed");
+                        break;
+                    case "secondary-color":
+                        if (!secondary_color.parse_string (keyvalue[1]))
+                            throw new SettingsParserError.COLOR ("secondary-color couldn't be parsed");
+                        break;
+                    default:
+                        throw new SettingsParserError.MALFORMED ("Unknown key on the left side of the =");
+                }
+            }
         } catch (Error e) {
-            if (get_default() != path) {
-                set_wallpaper (get_default ());
-            }
-            warning (@"Can't load: '$path' due to $(e.message)");
-        }
-    }
-
-    /**
-     * Creates a texture. It also recycles old unused wallpapers if possible
-     * as spamming constructors is expensive.
-     */
-    GtkClutter.Texture make_texture () {
-        if (unused_wallpapers.is_empty ()) {
-            return new GtkClutter.Texture ();
-        } else {
-            return unused_wallpapers.pop_head ();
-        }
-    }
-
-    /**
-     * Resizes the cache if there are more pixbufs cached then max_mache allows
-     */
-    void clean_cache () {
-        int l = cache_path.length;
-        if (l > max_cache) {
-            cache_path = cache_path [l - max_cache : l];
-            cache_pixbuf = cache_pixbuf [l - max_cache : l];
-        }
-    }
-
-    /**
-     * Looks up the pixbuf of the image-file with the given path in the cache.
-     * Returns null if there is no pixbuf for that file in cache
-     */
-    Gdk.Pixbuf? try_load_from_cache (string path) {
-        for (int i = 0; i < cache_path.length; i++) {
-            if (cache_path[i] == path)
-                return cache_pixbuf[i];
-        }
-        return null;
-    }
-
-    /**
-     * makes the pixbuf fit inside the GPU limit and scales it to
-     * screen size to save memory.
-     */
-    Gdk.Pixbuf validate_pixbuf (Gdk.Pixbuf pixbuf) {
-        Gdk.Pixbuf result = scale_to_rect (pixbuf, gpu_limit, gpu_limit);
-        result = scale_to_rect (pixbuf, screen_width, screen_height);
-        return result;
-    }
-
-    /**
-     * Scales the pixbuf down to fit in the given dimensions.
-     */
-    Gdk.Pixbuf scale_to_rect (Gdk.Pixbuf pixbuf, int rw, int rh) {
-        int h = pixbuf.height;
-        int w = pixbuf.width;
-
-        if (h > rh || w > rw) {
-            float hw = (float)h/w*rw;
-            float wh = (float)w/h*rh;
-            if (h < w) {
-                return pixbuf.scale_simple (rw, (int) (hw), Gdk.InterpType.BILINEAR);
-            } else {
-                return pixbuf.scale_simple ((int) (wh), rh, Gdk.InterpType.BILINEAR);
-            }
-        }
-        return pixbuf;
-    }
-
-    void resize (GtkClutter.Texture tex) {
-        int w, h;
-        tex.get_base_size (out w, out h);
-
-        if (width > (w * height) / h) {
-            tex.width = width;
-            tex.height = (int) (h * width / w);
-
-            if (height > tex.height) {
-                tex.height = height;
-                tex.width = (int) (w * height / h);
-            }
-        } else {
-            tex.height = height;
-            tex.width = (int) (w * height / h);
-        }
-    }
-}
+            warning ("Error while parsing settings-file for " + user.name + ": " + e.message);
+            apply_default_settings ();
+        }
+    }
+
+    /**
+     * Resets this Wallpaper to safe default-settings
+     */
+    private void apply_default_settings () {
+        uri = "";
+        option = PictureOption.WALLPAPER;
+        primary_color = Clutter.Color.from_pixel (0);
+        secondary_color = Clutter.Color.from_pixel (0);
+        fallback_uri = new GLib.Settings ("org.pantheon.desktop.greeter").get_string ("default-wallpaper");
+    }
+
+    // helper functions below
+
+    private PictureOption parse_option (string str) throws SettingsParserError {
+        switch (str.up ()) {
+            case "NONE":
+                return PictureOption.NONE;
+
+            case "WALLPAPER":
+                return PictureOption.WALLPAPER;
+
+            case "CENTERED":
+                return PictureOption.CENTERED;
+
+            case "SCALED":
+                return PictureOption.SCALED;
+
+            case "STRETCHED":
+                return PictureOption.STRETCHED;
+
+            case "ZOOM":
+                return PictureOption.ZOOM;
+
+            case "SPANNED":
+                return PictureOption.SPANNED;
+
+            default:
+                throw new SettingsParserError.OPTION ("Couldn't parse option-parameter");
+        }
+    }
+
+}
\ No newline at end of file

=== added file 'src/WallpaperActor.vala'
--- src/WallpaperActor.vala	1970-01-01 00:00:00 +0000
+++ src/WallpaperActor.vala	2014-08-04 20:29:46 +0000
@@ -0,0 +1,213 @@
+// -*- Mode: vala; indent-tabs-mode: nil; tab-width: 4 -*-
+/***
+    BEGIN LICENSE
+
+    Copyright (C) 2011-2014 elementary Developers
+
+    This program is free software: you can redistribute it and/or modify it
+    under the terms of the GNU Lesser General Public License version 3, as published
+    by the Free Software Foundation.
+
+    This program is distributed in the hope that it will be useful, but
+    WITHOUT ANY WARRANTY; without even the implied warranties of
+    MERCHANTABILITY, SATISFACTORY QUALITY, 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/>
+
+    END LICENSE
+***/
+
+/**
+ * Represents a area on the screen where the current wallpaper of a user gets
+ * displayed.
+ */
+public class WallpaperActor : Clutter.Group {
+
+    List<GtkClutter.Texture> wallpapers = new List<GtkClutter.Texture> ();
+    List<Cancellable> loading_wallpapers = new List<Cancellable> ();
+
+    /**
+     * Contains old Textures that were used for wallpapers. They are recycled
+     * in the @make_texture method.
+     */
+    Queue<GtkClutter.Texture> unused_wallpapers = new Queue<GtkClutter.Texture> ();
+
+    int gpu_limit;
+
+    string[] cache_path = {};
+    Gdk.Pixbuf[] cache_pixbuf = {};
+    int max_cache = 3;
+
+    Wallpaper? last_loaded = null;
+
+    public int screen_width { get; set; }
+    public int screen_height { get; set; }
+
+    public WallpaperActor () {
+        GL.GLint result = 1;
+        GL.glGetIntegerv(GL.GL_MAX_TEXTURE_SIZE, out result);
+        gpu_limit = result;
+    }
+
+    public void reposition () {
+        if (last_loaded != null)
+            set_wallpaper (last_loaded);
+    }
+
+    public void set_wallpaper (Wallpaper wallpaper) {
+        last_loaded = wallpaper;
+
+        clean_cache ();
+        load_wallpaper.begin (wallpaper, false);
+    }
+
+    async void load_wallpaper (Wallpaper wallpaper, bool use_fallback) {
+        string path = "";
+        if (use_fallback) {
+            path = wallpaper.fallback_uri;
+        } else {
+            path = wallpaper.uri;
+        }
+        warning ("starting to load " + path + " with fall back " + use_fallback.to_string ());
+        File file = File.new_for_path (path);
+        try {
+            Gdk.Pixbuf? buf = try_load_from_cache (path);
+            //if we still dont have a wallpaper now, load from file
+            if (buf == null) {
+                var cancelable = new Cancellable ();
+                loading_wallpapers.append (cancelable);
+                InputStream stream = yield file.read_async (GLib.Priority.DEFAULT);
+                buf = yield Gdk.Pixbuf.new_from_stream_async (stream, cancelable);
+                loading_wallpapers.remove (cancelable);
+                // we downscale the pixbuf as far as we can on the CPU
+                buf = validate_pixbuf (buf);
+                //add loaded wallpapers and paths to cache
+                cache_path += path;
+                cache_pixbuf += buf;
+            }
+            //check if the currently loaded wallpaper is the one we loaded in this method
+            if (last_loaded != wallpaper)
+                return; //if not, abort
+
+            var new_wallpaper = make_texture ();
+            new_wallpaper.opacity = 0;
+            new_wallpaper.set_from_pixbuf (buf);
+            resize (new_wallpaper);
+            add_child (new_wallpaper);
+            new_wallpaper.animate (Clutter.AnimationMode.EASE_OUT_QUINT, 500, opacity: 255);
+
+            // abort all currently loading wallpapers
+            foreach (var c in loading_wallpapers) {
+                c.cancel ();
+            }
+            loading_wallpapers = new List<Cancellable> ();
+            foreach (var other_wallpaper in wallpapers) {
+                wallpapers.remove (other_wallpaper);
+                other_wallpaper.animate (Clutter.AnimationMode.EASE_IN_QUINT, 500, opacity: 0).completed.connect (() => {
+                    remove_child (other_wallpaper);
+                    unused_wallpapers.push_tail (other_wallpaper);
+                });
+            }
+            wallpapers.append (new_wallpaper);
+
+        }
+        catch (IOError.CANCELLED e) {
+            // do nothing, we cancelled on purpose
+        } catch (Error e) {
+            // empty paths are not worth the report as for example guest-users have empthy paths
+            // to their non-exisiting wallpapers.
+            // !use_fallback because a malformed/missing fallback-wallpaper (e.g. the default-wallpaper)
+            // is worth a report
+            if (path != "" && !use_fallback) {
+                warning (@"Can't load: '$path' due to $(e.message) from $(e.code.to_string ())");
+            }
+            if (!use_fallback) {
+                load_wallpaper (wallpaper, true);
+            }
+        }
+    }
+
+    /**
+     * Creates a texture. It also recycles old unused wallpapers if possible
+     * as spamming constructors is expensive.
+     */
+    GtkClutter.Texture make_texture () {
+        if (unused_wallpapers.is_empty ()) {
+            return new GtkClutter.Texture ();
+        } else {
+            return unused_wallpapers.pop_head ();
+        }
+    }
+
+    /**
+     * Resizes the cache if there are more pixbufs cached then max_mache allows
+     */
+    void clean_cache () {
+        int l = cache_path.length;
+        if (l > max_cache) {
+            cache_path = cache_path [l - max_cache : l];
+            cache_pixbuf = cache_pixbuf [l - max_cache : l];
+        }
+    }
+
+    /**
+     * Looks up the pixbuf of the image-file with the given path in the cache.
+     * Returns null if there is no pixbuf for that file in cache
+     */
+    Gdk.Pixbuf? try_load_from_cache (string path) {
+        for (int i = 0; i < cache_path.length; i++) {
+            if (cache_path[i] == path)
+                return cache_pixbuf[i];
+        }
+        return null;
+    }
+
+    /**
+     * makes the pixbuf fit inside the GPU limit and scales it to
+     * screen size to save memory.
+     */
+    Gdk.Pixbuf validate_pixbuf (Gdk.Pixbuf pixbuf) {
+        Gdk.Pixbuf result = scale_to_rect (pixbuf, gpu_limit, gpu_limit);
+        result = scale_to_rect (pixbuf, screen_width, screen_height);
+        return result;
+    }
+
+    /**
+     * Scales the pixbuf down to fit in the given dimensions.
+     */
+    Gdk.Pixbuf scale_to_rect (Gdk.Pixbuf pixbuf, int rw, int rh) {
+        int h = pixbuf.height;
+        int w = pixbuf.width;
+
+        if (h > rh || w > rw) {
+            float hw = (float)h/w*rw;
+            float wh = (float)w/h*rh;
+            if (h < w) {
+                return pixbuf.scale_simple (rw, (int) (hw), Gdk.InterpType.BILINEAR);
+            } else {
+                return pixbuf.scale_simple ((int) (wh), rh, Gdk.InterpType.BILINEAR);
+            }
+        }
+        return pixbuf;
+    }
+
+    void resize (GtkClutter.Texture tex) {
+        int w, h;
+        tex.get_base_size (out w, out h);
+
+        if (width > (w * height) / h) {
+            tex.width = width;
+            tex.height = (int) (h * width / w);
+
+            if (height > tex.height) {
+                tex.height = height;
+                tex.width = (int) (w * height / h);
+            }
+        } else {
+            tex.height = height;
+            tex.width = (int) (w * height / h);
+        }
+    }
+}
\ No newline at end of file