Add sounds.py

sounds.py

@@ -0,0 +1,123 @@
+"""
+Play sounds on various events.
+Requires mpg123 to be installed on the host system:
+    sudo apt-get install mpg123
+    brew install mpg123
+"""
+
+import subprocess
+from os.path import expanduser
+
+import prof
+
+
+def _play_sound(soundfile):
+    if soundfile.startswith("~/"):
+        soundfilenew = soundfile.replace("~", expanduser("~"), 1)
+    else:
+        soundfilenew = soundfile
+    subprocess.Popen(["mpg123", "-q", soundfilenew])
+
+
+def _cmd_sounds(arg1=None, arg2=None, arg3=None):
+    if not arg1:
+        chatsound = prof.settings_string_get("sounds", "chat", None)
+        roomsound = prof.settings_string_get("sounds", "room", None)
+        privatesound = prof.settings_string_get("sounds", "private", None)
+
+        if chatsound or roomsound or privatesound:
+            prof.cons_show("Sounds:")
+            if chatsound:
+                prof.cons_show("  Chat    : " + chatsound)
+            if roomsound:
+                prof.cons_show("  Room    : " + roomsound)
+            if privatesound:
+                prof.cons_show("  Private : " + privatesound)
+        else:
+            prof.cons_show("No sounds set.")
+        
+        return
+
+    if arg1 == "set":
+        if arg2 == "chat":
+            prof.settings_string_set("sounds", "chat", arg3)
+            prof.cons_show("Set chat sound: " + arg3)
+        elif arg2 == "room":
+            prof.settings_string_set("sounds", "room", arg3)
+            prof.cons_show("Set room sound: " + arg3)
+        elif arg2 == "private":
+            prof.settings_string_set("sounds", "private", arg3)
+            prof.cons_show("Set private sound: " + arg3)
+        else:
+            prof.cons_bad_cmd_usage("/sounds")
+
+        return
+
+    if arg1 == "clear":
+        if arg2 == "chat":
+            prof.settings_string_set("sounds", "chat", "")
+            prof.cons_show("Removed chat sound.")
+        elif arg2 == "room":
+            prof.settings_string_set("sounds", "room", "")
+            prof.cons_show("Removed room sound.")
+        elif arg2 == "private":
+            prof.settings_string_set("sounds", "private", "")
+            prof.cons_show("Removed private sound.")
+        else:
+            prof.cons_bad_cmd_usage("/sounds")
+
+        return
+
+    prof.cons_bad_cmd_usage("/sounds")
+
+
+def prof_init(version, status, account_name, fulljid):
+    synopsis = [ 
+        "/sounds",
+        "/sounds set chat <file>",
+        "/sounds set room <file>",
+        "/sounds set private <file>",
+        "/sounds clear chat",
+        "/sounds clear room",
+        "/sounds clear private"
+    ]
+    description = "Play mp3 sounds on various Profanity events. Calling with no args shows current sound files."
+    args = [
+        [ "set chat <file>", "Path to mp3 file to play on chat messages." ],
+        [ "set room <file>", "Path to mp3 file to play on room messages." ],
+        [ "set private <file>", "Path to mp3 file to play on private room messages." ],
+        [ "clear chat", "Remove the sound for chat messages." ],
+        [ "clear room", "Remove the sound for room messages." ],
+        [ "clear private", "Remove the sound for private messages." ]
+    ]
+    examples = [
+        "/sounds set chat ~/sounds/woof.mp3",
+        "/sounds set room ~/sounds/meow.mp3",
+        "/sounds set private ~/sounds/shhh.mp3",
+        "/sounds remove private"
+    ]
+
+    prof.register_command("/sounds", 0, 3, synopsis, description, args, examples, _cmd_sounds)
+
+    prof.completer_add("/sounds", [ "set", "clear" ])
+    prof.completer_add("/sounds set", [ "chat", "room", "private" ])
+    prof.completer_add("/sounds clear", [ "chat", "room", "private" ])
+
+
+def prof_post_chat_message_display(barejid, resource, message):
+    soundfile = prof.settings_string_get("sounds", "chat", None)
+    if soundfile:
+        _play_sound(soundfile)
+
+
+def prof_post_room_message_display(barejid, nick, message):
+    soundfile = prof.settings_string_get("sounds", "room", None)
+    if soundfile:
+        _play_sound(soundfile)
+
+
+def prof_post_priv_message_display(barejid, nick, message):
+    soundfile = prof.settings_string_get("sounds", "private", None)
+    if soundfile:
+        _play_sound(soundfile)
+