Update extension for GNOME 49

README.md

@@ -7,10 +7,17 @@ This GNOME Shell Extension aims to display information to center box. Using DBUS
 Installation
 ------------
 
+Install it from https://extensions.gnome.org/extension/2826/generic-monitor/
+
+OR
+
 Create a symbolic link from your _.local_ directory and enable extension
 
-  ln -s $PWD/generic-monitor@gnome-shell-extensions/ ~/.local/share/gnome-shell/extensions/
-  gnome-extensions enable generic-monitor@gnome-shell-extensions
+```bash
+ln -s $PWD/generic-monitor@gnome-shell-extensions/ ~/.local/share/gnome-shell/extensions/
+
+gnome-extensions enable generic-monitor@gnome-shell-extensions
+```
 
 Restart GNOME
 
@@ -20,6 +27,7 @@ DBUS protocol
 
 All functions read JSON formatted parameters
 
+```js
   notify():
   {
       "group": "groupname",
@@ -60,41 +68,54 @@ All functions read JSON formatted parameters
   {
      "item": "<itemName>@<groupName>"
   }
+```
 
 
 DBUS object
 ===========
 
-<text_object> is defined as :
+<text_object> is defined as:
+```js
   "text" : {
+    "name"  : "" // Optional, used with popup nested element
+    <signals_description>,    // Optional, used with popup nested element
     "text"  : "Text to be displayed",
     "style" : "CSS style to be applied", // Optional
   }
+```
 
-<icon_object> is defined as :
+<icon_object> is defined as:
+```js
   "icon" : {
     "path"  : "Icon path",
     "style" : "CSS style to be applied", // Optional
   }
+```
 
-<picture_object> is defined as :
+<picture_object> is defined as:
+```js
   "picture" : {
+    "name"  : "" // Optional, used with popup nested element
+    <signals_description>,    // Optional, used with popup nested element
     "path"   : "Icon path",
     "width"  : XXX, // Optional : Force width in pixels, can be -1 for defaut value
     "height" : XXX, // Optional : Force height in pixels, can be -1 for defaut value
   }
+```
 
-<popup_object is defuned as :
+<popup_object> is defined as:
+```js
   "popup" : {
      "items": [<text_objects> and/or <picture_objects>]
   }
-  
+```
 
 Signals description
 ===================
 
 Signals can be :
 
+```js
   "on-click"          : ["signal"|"delete"|"open-popup"|"close-popup"|"toggle-popup"]
   "on-dblclick"       : ["signal"|"delete"|"open-popup"|"close-popup"|"toggle-popup"]
   "on-rightclick"     : ["signal"|"delete"|"open-popup"|"close-popup"|"toggle-popup"]
@@ -102,17 +123,18 @@ Signals can be :
   "on-enter"          : ["signal"|"delete"|"open-popup"|"close-popup"|"toggle-popup"]
   "on-leave"          : ["signal"|"delete"|"open-popup"|"close-popup"|"toggle-popup"]
   "on-scroll"         : ["signal"|"delete"|"open-popup"|"close-popup"|"toggle-popup"]
+```
 
 Targets :
 
-  * signal : emit a signal to desktop application
-  * delete : Delete item
-  * open-popup : Open the popup if there is one
-  * close-popup : Close the popup if there is one
-  * toggle-popup : Toggle (open/close) the popup if there is one
-  
+  * signal            : Emit a signal to desktop application
+  * delete            : Delete item
+  * open-popup        : Open the popup if there is one
+  * close-popup       : Close the popup if there is one
+  * toggle-popup      : Toggle (open/close) the popup if there is one
 
-Signal names emit when action "signal" is specified :
+
+Signal names emit when action "signal" is specified:
 
   * onClick
   * onDblClick
@@ -123,9 +145,11 @@ Signal names emit when action "signal" is specified :
   * onScrollUp
   * onScrollDown
 
-Each signal is sent with one parameter : "<itemName>@<groupName>"
+Each signal is sent with one parameter: "<itemName>@<groupName>"
+For popup nested elements, parameter is "<nestedName>@<itemName>@<groupName>"
+where nestedName can be empty if not defined by user
 
-Other signals are available when extension is activated/deactivated :
+Other signals are available when extension is activated/deactivated:
 
   * onActivate
   * onDeactivate
@@ -134,13 +158,17 @@ Other signals are available when extension is activated/deactivated :
 Example
 -------
 
-You can test it with command line :
+You can test it with command line:
 
-  gdbus call --session --dest org.gnome.Shell --object-path /com/soutade/GenericMonitor --method com.soutade.GenericMonitor.notify '{"group":"new","items":[{"name":"first","on-click":"toggle-popup","text":"Hello","style":"color:green","popup":{"items":[{"picture":{"path":"/tmp/cat2.jpg"}}]}}]}'
+```bash
+# Create new group and add items
+gdbus call --session --dest org.gnome.Shell --object-path /com/soutade/GenericMonitor --method com.soutade.GenericMonitor.notify '{"group":"new","items":[{"name":"first","on-click":"toggle-popup","text":{"text":"Hello","style":"color:green"},"popup":{"items":[{"picture":{"path":"/tmp/cat.jpg"}}]}}]}'
 
-  gdbus call --session --dest org.gnome.Shell --object-path /com/soutade/GenericMonitor --method com.soutade.GenericMonitor.deleteGroups '{"groups":["new"]}'
+# Delete group
+gdbus call --session --dest org.gnome.Shell --object-path /com/soutade/GenericMonitor --method com.soutade.GenericMonitor.deleteGroups '{"groups":["new"]}'
+```
 
-Python examples is available
+Python examples are available @ https://forge.soutade.fr/soutade/GnomeShellGenericMonitor/src/branch/master/examples
 
 
 Development
@@ -148,12 +176,23 @@ Development
 
 After doing code update, you can test it within a nested window. In other cases you have to restart GNOME.
 
-  dbus-run-session -- gnome-shell --nested [--wayland]
+mutter-dev-bin package is required 
 
-To see log & errors :
+```bash
+dbus-run-session gnome-shell --devkit --wayland
+```
 
-  journalctl /usr/bin/gnome-shell
+before GNOME 48
 
+```bash
+dbus-run-session -- gnome-shell --nested [--wayland]
+```
+
+To see log & errors:
+
+```bash
+journalctl /usr/bin/gnome-shell
+```
 
 Licence
 -------

dbus.xml

@@ -1,47 +1,47 @@
 <interface name="com.soutade.GenericMonitor">
   <!-- Functions -->
   <method name="notify">
-    <arg type="s" direction="in" />
+    <arg name="parameters" type="s" direction="in" />
   </method>
   <method name="deleteItems">
-    <arg type="s" direction="in" />
+    <arg name="items" type="s" direction="in" />
   </method>
   <method name="deleteGroups">
-    <arg type="s" direction="in" />
+    <arg name="groups" type="s" direction="in" />
   </method>
   <method name="openPopup">
-    <arg type="s" direction="in" />
+    <arg name="popup" type="s" direction="in" />
   </method>
   <method name="closePopup">
-    <arg type="s" direction="in" />
+    <arg name="popup" type="s" direction="in" />
   </method>
   <method name="togglePopup">
-    <arg type="s" direction="in" />
+    <arg name="popup" type="s" direction="in" />
   </method>
   <!-- Events -->
   <signal name="onClick">
-    <arg type="s" direction="out" />
+    <arg name="fullName" type="s" direction="out" />
   </signal>
   <signal name="onRightClick">
-    <arg type="s" direction="out" />
+    <arg name="fullName" type="s" direction="out" />
   </signal>
   <signal name="onDblClick">
-    <arg type="s" direction="out" />
+    <arg name="fullName" type="s" direction="out" />
   </signal>
   <signal name="onRightDblClick">
-    <arg type="s" direction="out" />
+    <arg name="fullName" type="s" direction="out" />
   </signal>
   <signal name="onScrollUp">
-    <arg type="s" direction="out" />
+    <arg name="fullName" type="s" direction="out" />
   </signal>
   <signal name="onScrollDown">
-    <arg type="s" direction="out" />
+    <arg name="fullName" type="s" direction="out" />
   </signal>
   <signal name="onEnter">
-    <arg type="s" direction="out" />
+    <arg name="fullName" type="s" direction="out" />
   </signal>
   <signal name="onLeave">
-    <arg type="s" direction="out" />
+    <arg name="fullName" type="s" direction="out" />
   </signal>
   <!-- Activate/Deactivate signals -->
   <signal name="onActivate">

examples/genericmonitor.py

@@ -235,11 +235,25 @@ class GenericMonitor:
 class GenericMonitorGenericWidget:
     """ Generic widget class, parent of all widgets
     """
-    def __init__(self):
-        self.valuesToMap = []
+    def __init__(self, style='', name='', signals={}):
+        """
+        Parameters
+        ----------
+        name : str, optional
+            Widget name
+        signals : dictionary, optional
+            Dictionary of signals and their action
+        """
+        self.valuesToMap = ['name', 'style']
         self.mapValues = {}
         self.mapName = ''
+        self.style = style
+        self.name = name
+        self.signals = signals
         
+    def setStyle(self, style):
+        self.style = style
+
     def _toMap(self):
         """ Return dictionary of class elements to send to addon
         """
@@ -247,12 +261,14 @@ class GenericMonitorGenericWidget:
         for p in self.valuesToMap:
             if self.__dict__[p]:
                 self.mapValues[p] = self.__dict__[p]
+        for (name, value) in self.signals.items():
+            self.mapValues[name] = value
         return {self.mapName:self.mapValues}
 
 class GenericMonitorTextWidget(GenericMonitorGenericWidget):
     """ Text widget
     """
-    def __init__(self, text, style=''):
+    def __init__(self, text, style='', name='', signals={}):
         """
         Parameters
         ----------
@@ -260,19 +276,20 @@ class GenericMonitorTextWidget(GenericMonitorGenericWidget):
             Text to display
         style : str, optional
             CSS style
+        name : str, optional
+            Widget name
+        signals : dictionary, optional
+            Dictionary of signals and their action
         """
-        self.valuesToMap = ('text', 'style')
+        super().__init__(style, name, signals)
+        self.valuesToMap += ['text']
         self.mapName = 'text'
 
         self.text = text
-        self.style = style
 
     def setText(self, text):
         self.text = text
     
-    def setStyle(self, style):
-        self.style = style
-
 class GenericMonitorIconWidget(GenericMonitorGenericWidget):
     """ Icon widget
     """
@@ -285,7 +302,8 @@ class GenericMonitorIconWidget(GenericMonitorGenericWidget):
         style : str, optional
             CSS style
         """
-        self.valuesToMap = ('path', 'style')
+        super().__init__(style=style)
+        self.valuesToMap += ['path']
         self.mapName = 'icon'
 
         self.path = path
@@ -293,15 +311,12 @@ class GenericMonitorIconWidget(GenericMonitorGenericWidget):
 
     def setPath(self, path):
         self.path = path
-        
-    def setStyle(self, style):
-        self.style = style
 
 
-class GenericMonitorPictureWidget(GenericMonitorIconWidget):
+class GenericMonitorPictureWidget(GenericMonitorGenericWidget):
     """ Picture widget
     """
-    def __init__(self, path, style='', width=-1, height=-1):
+    def __init__(self, path, style='', width=-1, height=-1, name='', signals={}):
         """
         Parameters
         ----------
@@ -313,15 +328,23 @@ class GenericMonitorPictureWidget(GenericMonitorIconWidget):
             Width of displayed picture (-1 for default width)
         height : int, optional
             Width of displayed picture (-1 for default width)
+        name : str, optional
+            Widget name
+        signals : dictionary, optional
+            Dictionary of signals and their action
         """
 
-        super().__init__(path, style)
-        self.valuesToMap = ('path', 'style', 'width', 'height')
+        super().__init__(style, name, signals)
+        self.valuesToMap += ['path', 'width', 'height']
         self.mapName = 'picture'
+        self.path = path
 
         self.width = width
         self.height = height
         
+    def setPath(self, path):
+        self.path = path
+
     def setWidth(self, width):
         self.width = width
         

examples/gmail.py

@@ -0,0 +1,85 @@
+#
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#
+# Setup : https://developers.google.com/gmail/api/quickstart/python
+# Need to have credentials.json were you call main script
+#
+# File imported from https://github.com/googleworkspace/python-samples/blob/main/gmail/quickstart/quickstart.py
+#
+
+from __future__ import print_function
+
+import os.path
+import json
+
+from google.auth.transport.requests import Request
+from google.oauth2.credentials import Credentials
+from google_auth_oauthlib.flow import InstalledAppFlow
+from googleapiclient.discovery import build
+
+# If modifying these scopes, delete the file token.json.
+SCOPES = ['https://www.googleapis.com/auth/gmail.readonly']
+
+creds = None
+
+def _initCreds():
+    global creds
+    if creds: return
+
+    # The file token.json stores the user's access and refresh tokens, and is
+    # created automatically when the authorization flow completes for the first
+    # time.
+    if os.path.exists('token.json'):
+        creds = Credentials.from_authorized_user_file('./token.json', SCOPES)
+    # If there are no (valid) credentials available, let the user log in.
+    if not creds or not creds.valid:
+        if creds and creds.expired and creds.refresh_token:
+            creds.refresh(Request())
+        else:
+            flow = InstalledAppFlow.from_client_secrets_file(
+                'credentials.json', SCOPES)
+            creds = flow.run_local_server(port=0)
+        # Save the credentials for the next run
+        with open('token.json', 'w') as token:
+            data = {}
+            data['refresh_token'] = creds.refresh_token
+            data['client_id'] = creds.client_id
+            data['client_secret'] = creds.client_secret
+            data['token_uri'] = creds.token_uri
+            data['id_token'] = creds.id_token
+            token.write(json.dumps(data))
+
+def getUnreadMails():
+    """
+    Get number of unread threads (that may contain multiple messages)
+    """
+
+    _initCreds()
+
+    service = build('gmail', 'v1', credentials=creds)
+    pageToken = ''
+    threads = set()
+    while True:
+        results = service.users().messages().list(userId='me', labelIds=['UNREAD'],\
+                                                  includeSpamTrash=False, pageToken=pageToken)\
+                                            .execute()
+        if not 'messages' in results.keys(): continue
+        threads = threads.union(set([k['threadId'] for k in results['messages']]))
+        # Loop over all result pages (100 results per page by default)
+        pageToken = results.get('nextPageToken', '')
+        if not pageToken: break
+
+    return len(threads)

examples/mail.py

@@ -23,11 +23,11 @@ import time
 import requests
 from requests.auth import HTTPBasicAuth
 import xml.dom.minidom
-import getpass
 from threading import Thread
 from signal import signal, SIGINT
 import sys
 from genericmonitor import *
+from gmail import getUnreadMails
 
 PURPLE_CONV_UPDATE_UNSEEN = 4
 PURPLE_MESSAGE_SEND = 0
@@ -59,31 +59,23 @@ class PidginConversation:
 
 class EventThread(Thread,GenericMonitor):
     SLEEP_TIME = 30
-    MAIL_ADDRESS='XXX@gmail.com'
 
     def stop(self):
         self._stopLoop = True
         self.stopMainLoop()
 
     def _getMail(self):
-        address = "https://mail.google.com/mail/feed/atom"
-        auth = HTTPBasicAuth(self.MAIL_ADDRESS, self._mail_password)
-        req = requests.get(address, auth=auth)
         text = ''
         style = ''
-        if req.status_code == requests.codes.ok:
-            dom = xml.dom.minidom.parseString(req.text)
-            try:
-                nb_messages = int(dom.getElementsByTagName('fullcount')[0].firstChild.nodeValue)
-                if nb_messages == 1:
-                    text = '1 msg'
-                elif nb_messages > 1:
-                    text = '%d msgs' % (nb_messages)
-                style = 'color:white'
-            except Exception as e:
-                text = str(e)
-        else:
-            text = 'Mail error %d' % (req.status_code)
+        try:
+            nb_messages = getUnreadMails()
+            if nb_messages == 1:
+                text = '1 msg'
+            elif nb_messages > 1:
+                text = '%d msgs' % (nb_messages)
+            style = 'color:white'
+        except Exception as e:
+            text = str(e)
 
         self.mailWidget.setText(text)
         self.mailWidget.setStyle(style)
@@ -103,8 +95,6 @@ class EventThread(Thread,GenericMonitor):
         self.add_signal_receiver(self.pidginMessageWrote,        'WroteChatMsg',        'im.pidgin.purple.PurpleInterface')
         self.add_signal_receiver(self.pidginConversationUpdated, 'ConversationUpdated', 'im.pidgin.purple.PurpleInterface')
         
-        self._mail_password = getpass.getpass('Enter password for address %s: ' % (self.MAIL_ADDRESS))
-
         self.mailWidget = GenericMonitorTextWidget('')
         mailItem = GenericMonitorItem('mail', [self.mailWidget])
         self.mailGroup = GenericMonitorGroup('Mail', [mailItem])

examples/picture.py

@@ -19,6 +19,7 @@
 Display random picture from unsplash.com in a popup
 
   * Click : open/close popup
+  * Popup item click : display who clicked
   * ScrollUp/ScrollDown/Double click : display next picture
   * Right click : exit
 '''
@@ -42,20 +43,17 @@ class PicturePopup(GenericMonitor):
         self.runMainLoop()
         
     def display_next_img(self):
-        filedata = urllib.request.urlopen('https://source.unsplash.com/random')
-        # Get redirected URL without parameters
-        url = filedata.url.split('?')[0]
-        filedata = urllib.request.urlopen(url + '?fit=max&width=500&height=500')
+        filedata = urllib.request.urlopen('https://picsum.photos/500/500')
         datatowrite = filedata.read()
         with open('/tmp/cat2.jpg', 'wb') as f:
             f.write(datatowrite)
         widget = GenericMonitorTextWidget('#%d' % self.imgs_idx, 'color:purple')
-        url_widget = GenericMonitorTextWidget(url, 'color:white;font-weight:bold')
-        picture_widget = GenericMonitorPictureWidget('/tmp/cat2.jpg')
+        url_widget = GenericMonitorTextWidget('random_pic', 'color:white;font-weight:bold', signals={'on-click':'signal'}) # No name here
+        picture_widget = GenericMonitorPictureWidget('/tmp/cat2.jpg', name='NestedWidget', signals={'on-click':'signal'})
         popup = GenericMonitorPopup([url_widget, picture_widget])
         signals = {
             'on-click':'toggle-popup',
-            # Could also use this behavior
+            # Could also use this behavior [bugged since GNOME 42]
             # 'on-enter':'open-popup',
             # 'on-leave':'close-popup',
             'on-dblclick':'signal',
@@ -68,7 +66,11 @@ class PicturePopup(GenericMonitor):
         self.imgs_idx += 1
         
     def _forMe(self, sender):
-        return sender == self.item.getFullName()
+        return str(sender).endswith(self.item.getFullName())
+
+    def onClick(self, sender):
+        if not self._forMe(sender): return
+        print('Click from {}'.format(sender))
 
     def _onScroll(self, sender):
         if not self._forMe(sender): return

examples/timer.py

@@ -65,7 +65,7 @@ class TimerThread(Thread,GenericMonitor):
         self._stopLoop = False
         
         self.textWidget = GenericMonitorTextWidget('')
-        signals = {'on-click':'signal'}
+        signals = {'on-click':'signal','on-dblclick':'signal','on-rightclick':'signal'}
         self.monitorItem = GenericMonitorItem('timer', [self.textWidget], signals, box='right')
         self.monitorGroup = GenericMonitorGroup('Timer', self.monitorItem)
         

metadata.json

@@ -2,11 +2,9 @@
     "uuid": "generic-monitor@gnome-shell-extensions",
     "name": "Generic Monitor",
     "description": "Display text & icon on systray using DBUS",
-    "version": "3",
+    "version": "20",
     "shell-version": [
-	"3.38",
-	"3.36",
-	"3.34"
+	"49"
     ],
-    "url": "http://indefero.soutade.fr/p/genericmonitor"
+    "url": "https://forge.soutade.fr/soutade/GnomeShellGenericMonitor"
 }