better structure

config/waybar/modules/.gitignore

@@ -0,0 +1,3 @@
+publicip.conf
+publicip.cache
+publicip.log

config/waybar/modules/mediaplayer.py

@@ -0,0 +1,221 @@
+#!/usr/bin/env python3
+from gi.repository.Playerctl import Player
+from gi.repository import Playerctl, GLib
+from typing import List
+import os
+import json
+import signal
+import sys
+import logging
+import argparse
+
+import gi
+
+gi.require_version("Playerctl", "2.0")
+
+
+logger = logging.getLogger(__name__)
+
+
+def signal_handler(sig, frame):
+    logger.info("Received signal to stop, exiting")
+    sys.stdout.write("\n")
+    sys.stdout.flush()
+    # loop.quit()
+    sys.exit(0)
+
+
+class PlayerManager:
+    def __init__(self, selected_player=None, excluded_player=[]):
+        self.manager = Playerctl.PlayerManager()
+        self.loop = GLib.MainLoop()
+        self.manager.connect(
+            "name-appeared", lambda *args: self.on_player_appeared(*args)
+        )
+        self.manager.connect(
+            "player-vanished", lambda *args: self.on_player_vanished(*args)
+        )
+
+        signal.signal(signal.SIGINT, signal_handler)
+        signal.signal(signal.SIGTERM, signal_handler)
+        signal.signal(signal.SIGPIPE, signal.SIG_DFL)
+        self.selected_player = selected_player
+        self.excluded_player = excluded_player.split(",") if excluded_player else []
+
+        self.init_players()
+
+    def init_players(self):
+        for player in self.manager.props.player_names:
+            if player.name in self.excluded_player:
+                continue
+            if self.selected_player is not None and self.selected_player != player.name:
+                logger.debug(f"{player.name} is not the filtered player, skipping it")
+                continue
+            self.init_player(player)
+
+    def run(self):
+        logger.info("Starting main loop")
+        self.loop.run()
+
+    def init_player(self, player):
+        logger.info(f"Initialize new player: {player.name}")
+        player = Playerctl.Player.new_from_name(player)
+        player.connect("playback-status", self.on_playback_status_changed, None)
+        player.connect("metadata", self.on_metadata_changed, None)
+        self.manager.manage_player(player)
+        self.on_metadata_changed(player, player.props.metadata)
+
+    def get_players(self) -> List[Player]:
+        return self.manager.props.players
+
+    def write_output(self, text, player):
+        logger.debug(f"Writing output: {text}")
+
+        output = {
+            "text": text,
+            "class": "custom-" + player.props.player_name,
+            "alt": player.props.player_name,
+        }
+
+        sys.stdout.write(json.dumps(output) + "\n")
+        sys.stdout.flush()
+
+    def clear_output(self):
+        sys.stdout.write("\n")
+        sys.stdout.flush()
+
+    def on_playback_status_changed(self, player, status, _=None):
+        logger.debug(
+            f"Playback status changed for player {player.props.player_name}: {status}"
+        )
+        self.on_metadata_changed(player, player.props.metadata)
+
+    def get_first_playing_player(self):
+        players = self.get_players()
+        logger.debug(f"Getting first playing player from {len(players)} players")
+        if len(players) > 0:
+            # if any are playing, show the first one that is playing
+            # reverse order, so that the most recently added ones are preferred
+            for player in players[::-1]:
+                if player.props.status == "Playing":
+                    return player
+            # if none are playing, show the first one
+            return players[0]
+        else:
+            logger.debug("No players found")
+            return None
+
+    def show_most_important_player(self):
+        logger.debug("Showing most important player")
+        # show the currently playing player
+        # or else show the first paused player
+        # or else show nothing
+        current_player = self.get_first_playing_player()
+        if current_player is not None:
+            self.on_metadata_changed(current_player, current_player.props.metadata)
+        else:
+            self.clear_output()
+
+    def on_metadata_changed(self, player, metadata, _=None):
+        logger.debug(f"Metadata changed for player {player.props.player_name}")
+        player_name = player.props.player_name
+        artist = player.get_artist()
+        title = player.get_title()
+        title = title.replace("&", "&")
+
+        track_info = ""
+        if (
+            player_name == "spotify"
+            and "mpris:trackid" in metadata.keys()
+            and ":ad:" in player.props.metadata["mpris:trackid"]
+        ):
+            track_info = "Advertisement"
+        elif artist is not None and title is not None:
+            track_info = f"{artist} - {title}"
+        else:
+            track_info = title
+
+        if track_info:
+            if player.props.status == "Playing":
+                track_info = " " + track_info
+            else:
+                track_info = " " + track_info
+        # only print output if no other player is playing
+        current_playing = self.get_first_playing_player()
+        if (
+            current_playing is None
+            or current_playing.props.player_name == player.props.player_name
+        ):
+            self.write_output(track_info, player)
+        else:
+            logger.debug(
+                f"Other player {current_playing.props.player_name} is playing, skipping"
+            )
+
+    def on_player_appeared(self, _, player):
+        logger.info(f"Player has appeared: {player.name}")
+        if player.name in self.excluded_player:
+            logger.debug(
+                "New player appeared, but it's in exclude player list, skipping"
+            )
+            return
+        if player is not None and (
+            self.selected_player is None or player.name == self.selected_player
+        ):
+            self.init_player(player)
+        else:
+            logger.debug(
+                "New player appeared, but it's not the selected player, skipping"
+            )
+
+    def on_player_vanished(self, _, player):
+        logger.info(f"Player {player.props.player_name} has vanished")
+        self.show_most_important_player()
+
+
+def parse_arguments():
+    parser = argparse.ArgumentParser()
+
+    # Increase verbosity with every occurrence of -v
+    parser.add_argument("-v", "--verbose", action="count", default=0)
+
+    parser.add_argument("-x", "--exclude", "- Comma-separated list of excluded player")
+
+    # Define for which player we"re listening
+    parser.add_argument("--player")
+
+    parser.add_argument("--enable-logging", action="store_true")
+
+    return parser.parse_args()
+
+
+def main():
+    arguments = parse_arguments()
+
+    # Initialize logging
+    if arguments.enable_logging:
+        logfile = os.path.join(
+            os.path.dirname(os.path.realpath(__file__)), "media-player.log"
+        )
+        logging.basicConfig(
+            filename=logfile,
+            level=logging.DEBUG,
+            format="%(asctime)s %(name)s %(levelname)s:%(lineno)d %(message)s",
+        )
+
+    # Logging is set by default to WARN and higher.
+    # With every occurrence of -v it's lowered by one
+    logger.setLevel(max((3 - arguments.verbose) * 10, 0))
+
+    logger.info("Creating player manager")
+    if arguments.player:
+        logger.info(f"Filtering for player: {arguments.player}")
+    if arguments.exclude:
+        logger.info(f"Exclude player {arguments.exclude}")
+
+    player = PlayerManager(arguments.player, arguments.exclude)
+    player.run()
+
+
+if __name__ == "__main__":
+    main()

config/waybar/modules/publicip.sh

@@ -0,0 +1,62 @@
+#!/usr/bin/env bash
+# shellcheck disable=SC1091,SC1090
+
+# Entries in publicip.conf:
+#   IP_QUERY_URL: URL to query public IP of the system.
+#     return: JSON object with "ip" field.
+#     note: This URL will be queried with short intervals (60s for example),
+#           therefore it may not be a good idea to use a public API with
+#           a limited number of calls.
+#   IP_INFO_URL: URL to query IP location.
+#     placeholder: <ip>
+#     return: JSON object with "country_code" field.
+#     note: This URL will only be quetried when public IP changes or when "force" is given as parameter.
+
+path="$(dirname "$(readlink -f "$0")")"
+cache_file="$path/publicip.cache"
+config_file="$path/publicip.conf"
+time_log="$path/publicip.log"
+
+[ -f "$config_file" ] || exit 1
+. "$config_file"
+[ -z "$IP_QUERY_URL" ] && exit 1
+[ -z "$IP_INFO_URL" ] && exit 1
+[ "$1" == "force" ] && rm -f "$cache_file"
+[ -f "$cache_file" ] && . "$cache_file"
+
+# Try to check network connectivity before querying
+if ! ping -c 1 -W 2 1.1.1.1 >/dev/null 2>&1; then
+    # No network, return cached values if available
+    [ -z "$CACHED_IP" ] && CACHED_IP="N/A"
+    [ -z "$CACHED_CODE" ] && CACHED_CODE="N/A"
+
+    echo "$(date +%Y-%m-%dT%H:%M:%S) - Waiting for network" >>"$time_log"
+
+    jq -n --unbuffered --compact-output \
+        --arg ip "$CACHED_IP" \
+        --arg country "$CACHED_CODE" \
+        '{alt: $ip, text: $country}'
+    exit 0
+fi
+
+ip_current=$(curl -s -L -4 "$IP_QUERY_URL" | jq -r '.ip')
+[ -z "$ip_current" ] && exit 1
+
+if [ "$ip_current" != "$CACHED_IP" ]; then
+    echo "$(date +%Y-%m-%dT%H:%M:%S) - IP changed: $CACHED_IP -> $ip_current" >>"$time_log"
+    CACHED_IP="$ip_current"
+
+    ip_info_url=${IP_INFO_URL//<ip>/$ip_current}
+    CACHED_CODE=$(curl -s -L "$ip_info_url" | jq -r '.country_code')
+    [ -z "$CACHED_CODE" ] && CACHED_CODE="N/A"
+
+    echo "CACHED_IP=$CACHED_IP" >"$cache_file"
+    echo "CACHED_CODE=$CACHED_CODE" >>"$cache_file"
+    notify-send "New Public IP detected" "New IP: $ip_current\nCountry: $CACHED_CODE"
+fi
+
+jq -n --unbuffered --compact-output \
+    --arg ip "$CACHED_IP" \
+    --arg country "$CACHED_CODE" \
+    '{alt: $ip, text: $country}'
+