Merge branch 'feature-update'

Makefile

@@ -2,8 +2,9 @@
 
 UUID = dash-to-panel@jderose9.github.com
 BASE_MODULES = extension.js stylesheet.css metadata.json COPYING README.md
-EXTRA_MODULES = appIcons.js convenience.js panel.js panelManager.js proximity.js intellihide.js panelStyle.js overview.js taskbar.js transparency.js windowPreview.js prefs.js utils.js Settings.ui
+EXTRA_MODULES = appIcons.js convenience.js panel.js panelManager.js proximity.js intellihide.js panelStyle.js overview.js taskbar.js transparency.js windowPreview.js prefs.js update.js utils.js Settings.ui
 EXTRA_IMAGES = highlight_stacked_bg.svg highlight_stacked_bg_2.svg highlight_stacked_bg_3.svg
+
 TOLOCALIZE =  prefs.js appIcons.js
 MSGSRC = $(wildcard po/*.po)
 ifeq ($(strip $(DESTDIR)),)

Settings.ui

@@ -7622,6 +7622,147 @@
               <placeholder/>
             </child>
           </object>
+          <packing>
+            <property name="expand">False</property>
+            <property name="fill">True</property>
+            <property name="position">1</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkFrame" id="updates_frame">
+            <property name="can_focus">False</property>
+            <property name="margin_top">20</property>
+            <property name="label_xalign">0</property>
+            <property name="shadow_type">in</property>
+            <child>
+              <object class="GtkListBox" id="updates_listbox">
+                <property name="visible">True</property>
+                <property name="can_focus">False</property>
+                <property name="selection_mode">none</property>
+                <child>
+                  <object class="GtkListBoxRow" id="updates_listboxrow">
+                    <property name="visible">True</property>
+                    <property name="can_focus">True</property>
+                    <child>
+                      <object class="GtkGrid" id="updates_grid">
+                        <property name="visible">True</property>
+                        <property name="can_focus">False</property>
+                        <property name="margin_left">12</property>
+                        <property name="margin_right">12</property>
+                        <property name="margin_top">12</property>
+                        <property name="margin_bottom">12</property>
+                        <property name="row_spacing">6</property>
+                        <property name="column_spacing">32</property>
+                        <child>
+                          <object class="GtkLabel" id="updates_description">
+                            <property name="visible">True</property>
+                            <property name="can_focus">False</property>
+                            <property name="hexpand">True</property>
+                            <property name="label" translatable="yes">This allows you to update the extension directly from the GitHub repository.</property>
+                            <property name="use_markup">True</property>
+                            <property name="wrap">True</property>
+                            <property name="xalign">0</property>
+                            <style>
+                              <class name="dim-label"/>
+                            </style>
+                          </object>
+                          <packing>
+                            <property name="left_attach">0</property>
+                            <property name="top_attach">1</property>
+                            <property name="width">2</property>
+                          </packing>
+                        </child>
+                        <child>
+                          <object class="GtkLabel" id="updates_label">
+                            <property name="visible">True</property>
+                            <property name="can_focus">False</property>
+                            <property name="halign">start</property>
+                            <property name="label" translatable="yes">Updates</property>
+                          </object>
+                          <packing>
+                            <property name="left_attach">0</property>
+                            <property name="top_attach">0</property>
+                            <property name="width">2</property>
+                          </packing>
+                        </child>
+                        <child>
+                          <object class="GtkLabel" id="updates_check_label">
+                            <property name="visible">True</property>
+                            <property name="can_focus">False</property>
+                            <property name="halign">start</property>
+                            <property name="label" translatable="yes">Periodically check for updates</property>
+                          </object>
+                          <packing>
+                            <property name="left_attach">0</property>
+                            <property name="top_attach">3</property>
+                          </packing>
+                        </child>
+                        <child>
+                          <object class="GtkBox">
+                            <property name="visible">True</property>
+                            <property name="can_focus">False</property>
+                            <property name="halign">end</property>
+                            <property name="spacing">6</property>
+                            <child>
+                              <object class="GtkSwitch" id="updates_check_switch">
+                                <property name="visible">True</property>
+                                <property name="can_focus">True</property>
+                                <property name="halign">end</property>
+                                <property name="valign">center</property>
+                              </object>
+                              <packing>
+                                <property name="expand">False</property>
+                                <property name="fill">True</property>
+                                <property name="position">0</property>
+                              </packing>
+                            </child>
+                            <child>
+                              <object class="GtkButton" id="updates_check_now_button">
+                                <property name="label" translatable="yes">Check now</property>
+                                <property name="visible">True</property>
+                                <property name="can_focus">True</property>
+                                <property name="receives_default">True</property>
+                                <property name="halign">end</property>
+                                <property name="valign">center</property>
+                              </object>
+                              <packing>
+                                <property name="expand">False</property>
+                                <property name="fill">True</property>
+                                <property name="position">1</property>
+                              </packing>
+                            </child>
+                          </object>
+                          <packing>
+                            <property name="left_attach">1</property>
+                            <property name="top_attach">3</property>
+                          </packing>
+                        </child>
+                        <child>
+                          <object class="GtkLabel" id="updates_warning_label">
+                            <property name="visible">True</property>
+                            <property name="can_focus">False</property>
+                            <property name="margin_bottom">12</property>
+                            <property name="label" translatable="yes">&lt;span weight="bold" color="#B42B30"&gt;Be aware, these official Dash to Panel releases might not be reviewed yet on extensions.gnome.org!&lt;/span&gt;  &lt;a href="https://extensions.gnome.org/about/"&gt;Read more&lt;/a&gt;</property>
+                            <property name="use_markup">True</property>
+                            <property name="wrap">True</property>
+                            <property name="xalign">0</property>
+                          </object>
+                          <packing>
+                            <property name="left_attach">0</property>
+                            <property name="top_attach">2</property>
+                            <property name="width">2</property>
+                          </packing>
+                        </child>
+                      </object>
+                    </child>
+                  </object>
+                </child>
+              </object>
+            </child>
+            <child type="label_item">
+              <placeholder/>
+            </child>
+          </object>
           <packing>
             <property name="expand">False</property>
             <property name="fill">True</property>

extension.js

@@ -33,6 +33,7 @@ const Signals = imports.signals;
 const Me = ExtensionUtils.getCurrentExtension();
 const Convenience = Me.imports.convenience;
 const PanelManager = Me.imports.panelManager;
+const Update = Me.imports.update;
 const Utils = Me.imports.utils;
 
 const UBUNTU_DOCK_UUID = 'ubuntu-dock@ubuntu.com';
@@ -87,7 +88,10 @@ function _enable() {
 
     Me.settings = Convenience.getSettings('org.gnome.shell.extensions.dash-to-panel');
     Me.desktopSettings = Convenience.getSettings('org.gnome.desktop.interface');
+
+    Update.init(Me.settings);
     panelManager = new PanelManager.dtpPanelManager();
+
     panelManager.enable();
     
     Utils.removeKeybinding('open-application-menu');

prefs.js

@@ -34,6 +34,7 @@ const Convenience = Me.imports.convenience;
 const Gettext = imports.gettext.domain(Me.metadata['gettext-domain']);
 const _ = Gettext.gettext;
 const N_ = function(e) { return e };
+const Update = Me.imports.update;
 
 const SCALE_UPDATE_TIMEOUT = 500;
 const DEFAULT_PANEL_SIZES = [ 128, 96, 64, 48, 32, 24, 16 ];
@@ -1796,6 +1797,15 @@ const Settings = new Lang.Class({
                 }
             );
         });
+
+        this._settings.bind('check-update',
+                            this._builder.get_object('updates_check_switch'),
+                            'active',
+                            Gio.SettingsBindFlags.DEFAULT);
+
+        this._builder.get_object('updates_check_now_button').connect('clicked', widget => {
+            this._settings.set_boolean('force-check-update', true);
+        });
     },
 
     _setPreviewTitlePosition: function() {

schemas/org.gnome.shell.extensions.dash-to-panel.gschema.xml

@@ -71,6 +71,15 @@
     <value value='2' nick='BOTH'/>
   </enum>
   <schema path="/org/gnome/shell/extensions/dash-to-panel/" id="org.gnome.shell.extensions.dash-to-panel">
+    <key type="b" name="check-update">
+      <default>false</default>
+    </key>
+    <key type="b" name="force-check-update">
+      <default>false</default>
+    </key>
+    <key type="s" name="version-to-install">
+      <default>''</default>
+    </key>
     <key name="panel-position" enum="org.gnome.shell.extensions.dash-to-panel.position">
       <default>'BOTTOM'</default>
       <summary>Panel position</summary>

update.js

@@ -0,0 +1,222 @@
+/*
+ * This file is part of the Dash-To-Panel extension for Gnome 3
+ *
+ * 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 2 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/>.
+ */
+
+const GLib = imports.gi.GLib;
+const Gio = imports.gi.Gio;
+const Soup = imports.gi.Soup;
+const FileUtils = imports.misc.fileUtils;
+
+const Me = imports.misc.extensionUtils.getCurrentExtension();
+const Gettext = imports.gettext.domain(Me.metadata['gettext-domain']);
+const _ = Gettext.gettext;
+
+const apiUrl = 'https://api.github.com/repos/home-sweet-gnome/dash-to-panel/';
+const tagsApiUrl = apiUrl + 'tags';
+const releasesApiUrl = apiUrl + 'releases';
+
+let httpSession;
+
+function init(settings) {
+    settings.connect('changed::version-to-install', () => installRelease(settings.get_string('version-to-install'), true));
+    settings.connect('changed::force-check-update', () => {
+        if (settings.get_boolean('force-check-update')) {
+            checkForUpdate(settings, true);
+            settings.set_boolean('force-check-update', false);
+        }
+    });
+
+    //check for update now, then every 4 hours
+    checkForUpdate(settings);
+    imports.mainloop.timeout_add(14400000, () => checkForUpdate(settings));
+}
+
+function checkForUpdate(settings, fromSettings) {
+    if (fromSettings || settings.get_boolean('check-update')) {
+        getLatestReleaseInfo((err, latestRelease) => {
+            if (err) {
+                return notifyError(err);
+            }
+            
+            let latestVersion = latestRelease.tag.substring(1);
+            
+            if (Me.metadata.version < latestVersion && latestRelease.zipUrl) {
+                notify(
+                    _('Version %s (%s) is available').format(latestVersion, latestRelease.name),
+                    [{ text: _('Details'), func: () => imports.misc.util.spawn(['xdg-open', latestRelease.url]) },
+                     { text: _('Update'), func: () => installRelease(latestRelease.zipUrl, fromSettings) }]
+                );
+            } else if (fromSettings) {
+                notify(_('Already up to date'));
+            }
+        });
+    }
+}
+
+function getLatestReleaseInfo(cb) {
+    getReleaseInfo('/latest', cb);
+}
+
+function getTaggedReleaseInfo(releaseTag, cb) {
+    getReleaseInfo('/tags/' + releaseTag, cb);
+}
+
+function getReleaseInfo(suffix, cb) {
+    getHttpMessageResponseBody(createGet(releasesApiUrl + suffix), (err, body) => {
+        if (err) {
+            return cb(err);
+        }
+
+        try {
+            let release = JSON.parse(body.data);
+            let releaseInfo = {
+                name: release.name, 
+                tag: release.tag_name,
+                url: release.html_url,
+                zipUrl: (release.assets.length ? release.assets[0].browser_download_url : 0),
+            };
+
+            cb(null, releaseInfo);
+        } catch (e) {
+            cb(e.message);
+        }
+    });
+}
+
+function installRelease(releaseAssetUrl, fromSettings) {
+    getHttpMessageResponseBody(createGet(releaseAssetUrl), (err, body) => {
+        if (err) {
+            return notifyInstallResult(err);
+        }
+
+        let name = 'dtp_install';
+        let zipFile = createTmp(name + '.zip');
+        let stream = zipFile.replace(null, false, Gio.FileCreateFlags.NONE, null);
+        let extDir = Gio.file_new_for_path(Me.path);
+        let tmpDir = createTmp(name, true);
+        let bckDir = createTmp(Me.uuid, true);
+
+        stream.write_bytes(body.flatten().get_as_bytes(), null);
+        stream.close(null);
+
+        unzipFile(zipFile, tmpDir, err => {
+            if (err) {
+                return notifyInstallResult(err);
+            }
+            
+            try {
+                FileUtils.recursivelyMoveDir(extDir, bckDir);
+                FileUtils.recursivelyMoveDir(tmpDir, extDir);
+
+                if (fromSettings) {
+                    let [success, out, err, exitCode] = GLib.spawn_command_line_sync('pidof "gnome-shell-extension-prefs"');
+
+                    if (success && !exitCode) {
+                        GLib.spawn_command_line_sync('kill -9 ' + imports.byteArray.toString(out));
+                    }
+                }
+            } catch (e) {
+                FileUtils.recursivelyDeleteDir(extDir, false);
+                FileUtils.recursivelyMoveDir(bckDir, extDir);
+
+                return notifyInstallResult(e.message);
+            }
+
+            notifyInstallResult(null);
+        });
+    });
+}
+
+function notifyInstallResult(err) {
+    if (err) {
+        notifyError(err);
+    } else if (imports.gi.Meta.is_wayland_compositor()) {
+        notify(
+            _('Update successful, please log out/in'),
+            { text: _('Log out'), func: () => new imports.misc.systemActions.getDefault().activateLogout() }
+        );
+    } else {
+        notify(
+            _('Update successful, please restart GNOME Shell'), 
+            { text: _('Restart GNOME Shell'), func: () => imports.gi.Meta.restart(_("Restarting GNOME Shell…")) }
+        );
+    }
+}
+
+function notifyError(err) {
+    Me.imports.utils.notify(_('Error: ') + err, 'dialog-error', null, true);
+}
+
+function notify(msg, action) {
+    Me.imports.utils.notify(msg, 'dialog-information', action, true);
+}
+
+function createTmp(name, isDir) {
+    let tmp = Gio.file_new_for_path('/tmp/' + name);
+
+    if (isDir && tmp.query_exists(null)) {
+        FileUtils.recursivelyDeleteDir(tmp, false);
+    }
+
+    return tmp;
+}
+
+function unzipFile(zipFile, destDir, cb) {
+    let [success, pid] = GLib.spawn_async(
+        null,
+        ['unzip', '-uod', destDir.get_path(), '--', zipFile.get_path()],
+        null,
+        GLib.SpawnFlags.SEARCH_PATH | GLib.SpawnFlags.DO_NOT_REAP_CHILD | GLib.SpawnFlags.STDOUT_TO_DEV_NULL,
+        null
+    );
+
+    if (!success) {
+        return cb('unzip spawn error');
+    }
+
+    GLib.child_watch_add(GLib.PRIORITY_DEFAULT, pid, (pid, status) => {
+        GLib.spawn_close_pid(pid);
+
+        if (status != 0) {
+            return cb('extraction error')
+        }
+        
+        return cb(null);
+    });
+}
+
+function createGet(url, params) {
+    return Soup.form_request_new_from_hash('GET', url, params || {});
+}
+
+function getHttpMessageResponseBody(message, cb) {
+    if (!httpSession) {
+        httpSession = new Soup.Session();
+        httpSession.user_agent = Me.metadata.uuid;
+    }
+
+    httpSession.queue_message(message, (httpSession, message) => {
+        try {
+            if (!message.response_body || !message.response_body.data) {
+                return cb('No data received');
+            }
+
+            return cb(null, message.response_body);
+        } catch (e) {
+            return cb(e.message);
+        }
+    });
+}

utils.js

@@ -32,6 +32,7 @@ const Shell = imports.gi.Shell;
 const St = imports.gi.St;
 const Mainloop = imports.mainloop;
 const Main = imports.ui.main;
+const MessageTray = imports.ui.messageTray;
 const Tweener = imports.ui.tweener;
 const Util = imports.misc.util;
 
@@ -412,7 +413,31 @@ var activateSiblingWindow = function(windows, direction, startWindow) {
     if (windowIndex != nextWindowIndex) {
         Main.activateWindow(windows[nextWindowIndex]);
     }
-}
+};
+
+var notify = function(text, iconName, action, isTransient) {
+    let source = new MessageTray.SystemNotificationSource();
+    let notification = new MessageTray.Notification(source, 'Dash to Panel', text);
+    
+    if (iconName) {
+        source.createIcon = function() {
+            return new St.Icon({ icon_name: iconName });
+        };
+    }   
+
+    if (action) {
+        if (!(action instanceof Array)) {
+            action = [action];
+        }
+
+        action.forEach(a => notification.addAction(a.text, a.func));
+    }
+
+    Main.messageTray.add(source);
+
+    notification.setTransient(isTransient);
+    source.notify(notification);
+};
 
 /*
  * This is a copy of the same function in utils.js, but also adjust horizontal scrolling