annotate src/plugins/plugin_misc_radiocol.py @ 746:539f278bc265

plugin room_games, radiocol: send the current queue to new players
author souliane <souliane@mailoo.org>
date Thu, 28 Nov 2013 19:23:59 +0100
parents 074970227bc0
children d0e809014ea2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
450
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
1 #!/usr/bin/python
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
2 # -*- coding: utf-8 -*-
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
3
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
4 # SAT plugin for managing Radiocol
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
5 # Copyright (C) 2009, 2010, 2011, 2012, 2013 Jérôme Poisson (goffi@goffi.org)
450
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
6
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
7 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
8 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
9 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
10 # (at your option) any later version.
450
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
11
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
12 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
15 # GNU Affero General Public License for more details.
450
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
16
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
17 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 594
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
450
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
19
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
20 from logging import debug, info, warning, error
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
21 from twisted.words.xish import domish
577
593331663b80 plugin radiocol: songs are deleted once played (Q&D need to be reworked once file are properly transfered to server)
Goffi <goffi@goffi.org>
parents: 572
diff changeset
22 from twisted.internet import reactor
593331663b80 plugin radiocol: songs are deleted once played (Q&D need to be reworked once file are properly transfered to server)
Goffi <goffi@goffi.org>
parents: 572
diff changeset
23 from twisted.words.protocols.jabber import jid
593331663b80 plugin radiocol: songs are deleted once played (Q&D need to be reworked once file are properly transfered to server)
Goffi <goffi@goffi.org>
parents: 572
diff changeset
24
455
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
25 import os.path
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
26 import copy
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
27 import time
577
593331663b80 plugin radiocol: songs are deleted once played (Q&D need to be reworked once file are properly transfered to server)
Goffi <goffi@goffi.org>
parents: 572
diff changeset
28 from os import unlink
464
794f60e2da27 plugin radiocol: fixed missing import
Goffi <goffi@goffi.org>
parents: 459
diff changeset
29 from mutagen.oggvorbis import OggVorbis, OggVorbisHeaderError
450
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
30
717
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games:
souliane <souliane@mailoo.org>
parents: 714
diff changeset
31
450
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
32 NC_RADIOCOL = 'http://www.goffi.org/protocol/radiocol'
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
33 RADIOC_TAG = 'radiocol'
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
34
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
35 PLUGIN_INFO = {
594
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
36 "name": "Radio collective plugin",
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
37 "import_name": "Radiocol",
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
38 "type": "Exp",
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
39 "protocols": [],
718
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py
souliane <souliane@mailoo.org>
parents: 717
diff changeset
40 "dependencies": ["XEP-0045", "XEP-0249", "ROOM-GAME"],
594
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
41 "main": "Radiocol",
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
42 "handler": "yes",
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
43 "description": _("""Implementation of radio collective""")
450
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
44 }
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
45
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
46
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
47 # Number of songs needed in the queue before we start playing
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
48 QUEUE_TO_START = 2
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
49 # Maximum number of songs in the queue (the song being currently played doesn't count)
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
50 QUEUE_LIMIT = 2
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
51
450
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
52
718
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py
souliane <souliane@mailoo.org>
parents: 717
diff changeset
53 class Radiocol(object):
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py
souliane <souliane@mailoo.org>
parents: 717
diff changeset
54
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py
souliane <souliane@mailoo.org>
parents: 717
diff changeset
55 def inheritFromRoomGame(self, host):
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py
souliane <souliane@mailoo.org>
parents: 717
diff changeset
56 global RoomGame
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py
souliane <souliane@mailoo.org>
parents: 717
diff changeset
57 RoomGame = host.plugins["ROOM-GAME"].__class__
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py
souliane <souliane@mailoo.org>
parents: 717
diff changeset
58 self.__class__ = type(self.__class__.__name__, (self.__class__, RoomGame, object), {})
450
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
59
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
60 def __init__(self, host):
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
61 info(_("Radio collective initialization"))
718
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py
souliane <souliane@mailoo.org>
parents: 717
diff changeset
62 self.inheritFromRoomGame(host)
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py
souliane <souliane@mailoo.org>
parents: 717
diff changeset
63 RoomGame._init_(self, host, PLUGIN_INFO, (NC_RADIOCOL, RADIOC_TAG),
717
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games:
souliane <souliane@mailoo.org>
parents: 714
diff changeset
64 game_init={'queue': [], 'upload': True, 'playing': False, 'to_delete': {}})
450
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
65 self.host = host
712
f610864eb7a5 plugins (MUC, tools, games): generalize the generation of a unique room name when joining a MUC and no room is specified:
souliane <souliane@mailoo.org>
parents: 683
diff changeset
66 host.bridge.addMethod("radiocolLaunch", ".plugin", in_sign='asss', out_sign='', method=self.prepareRoom)
717
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games:
souliane <souliane@mailoo.org>
parents: 714
diff changeset
67 host.bridge.addMethod("radiocolCreate", ".plugin", in_sign='sass', out_sign='', method=self.createGame)
455
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
68 host.bridge.addMethod("radiocolSongAdded", ".plugin", in_sign='sss', out_sign='', method=self.radiocolSongAdded)
717
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games:
souliane <souliane@mailoo.org>
parents: 714
diff changeset
69 host.bridge.addSignal("radiocolPlayers", ".plugin", signature='ssass') # room_jid, referee, players, profile
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
70 host.bridge.addSignal("radiocolStarted", ".plugin", signature='ssasais') # room_jid, referee, players, [QUEUE_TO_START, QUEUE_LIMIT], profile
594
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
71 host.bridge.addSignal("radiocolSongRejected", ".plugin", signature='sss') # room_jid, reason, profile
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
72 host.bridge.addSignal("radiocolPreload", ".plugin", signature='sssssss') # room_jid, timestamp, filename, title, artist, album, profile
594
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
73 host.bridge.addSignal("radiocolPlay", ".plugin", signature='sss') # room_jid, filename, profile
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
74 host.bridge.addSignal("radiocolNoUpload", ".plugin", signature='ss') # room_jid, profile
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
75 host.bridge.addSignal("radiocolUploadOk", ".plugin", signature='ss') # room_jid, profile
450
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
76
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
77 def __create_preload_elt(self, sender, song_added_elt):
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
78 preload_elt = copy.deepcopy(song_added_elt)
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
79 preload_elt.name = 'preload'
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
80 preload_elt['sender'] = sender
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
81 preload_elt['timestamp'] = str(time.time())
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
82 # attributes filename, title, artist, album, length have been copied
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
83 # XXX: the frontend should know the temporary directory where file is put
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
84 return preload_elt
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
85
455
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
86 def radiocolSongAdded(self, referee, song_path, profile):
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
87 """This method is called by libervia when a song has been uploaded
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
88 @param room_jid_param: jid of the room
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
89 @song_path: absolute path of the song added
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
90 @param profile_key: %(doc_profile_key)s"""
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
91 #XXX: this is a Q&D way for the proof of concept. In the future, the song should
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
92 # be streamed to the backend using XMPP file copy
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
93 # Here we cheat because we know we are on the same host, and we don't
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
94 # check data. Referee will have to parse the song himself to check it
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
95 client = self.host.getClient(profile)
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
96 if not client:
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
97 error(_("Can't access profile's data"))
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 577
diff changeset
98 return
455
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
99 try:
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
100 song = OggVorbis(song_path)
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
101 except OggVorbisHeaderError:
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
102 #this file is not ogg vorbis, we reject it
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
103 self.deleteFile(song_path) # FIXME: same host trick (see note above)
594
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
104 self.host.bridge.radiocolSongRejected(jid.JID(referee).userhost(),
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
105 "Uploaded file is not Ogg Vorbis song, only Ogg Vorbis songs are acceptable", profile)
683
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization
souliane <souliane@mailoo.org>
parents: 609
diff changeset
106 """mess = self.createGameElt(jid.JID(referee))
455
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
107 reject_elt = mess.firstChildElement().addElement(('','song_rejected'))
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
108 reject_elt['sender'] = client.jid
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
109 reject_elt['reason'] = "Uploaded file is not Ogg Vorbis song, only Ogg Vorbis songs are acceptable"
455
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
110 #FIXME: add an error code
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
111 self.host.profiles[profile].xmlstream.send(mess)"""
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
112 return
714
ecc5a5b34ee1 plugins (games): add a method to send messages more easily
souliane <souliane@mailoo.org>
parents: 712
diff changeset
113 attrs = {'filename': os.path.basename(song_path),
ecc5a5b34ee1 plugins (games): add a method to send messages more easily
souliane <souliane@mailoo.org>
parents: 712
diff changeset
114 'title': song.get("title", ["Unknown"])[0],
ecc5a5b34ee1 plugins (games): add a method to send messages more easily
souliane <souliane@mailoo.org>
parents: 712
diff changeset
115 'artist': song.get("artist", ["Unknown"])[0],
ecc5a5b34ee1 plugins (games): add a method to send messages more easily
souliane <souliane@mailoo.org>
parents: 712
diff changeset
116 'album': song.get("album", ["Unknown"])[0],
ecc5a5b34ee1 plugins (games): add a method to send messages more easily
souliane <souliane@mailoo.org>
parents: 712
diff changeset
117 'length': str(song.info.length)
ecc5a5b34ee1 plugins (games): add a method to send messages more easily
souliane <souliane@mailoo.org>
parents: 712
diff changeset
118 }
ecc5a5b34ee1 plugins (games): add a method to send messages more easily
souliane <souliane@mailoo.org>
parents: 712
diff changeset
119 self.send(jid.JID(referee), ('', 'song_added'), attrs, profile=profile)
577
593331663b80 plugin radiocol: songs are deleted once played (Q&D need to be reworked once file are properly transfered to server)
Goffi <goffi@goffi.org>
parents: 572
diff changeset
120
683
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization
souliane <souliane@mailoo.org>
parents: 609
diff changeset
121 radio_data = self.games[jid.JID(referee).userhost()] # FIXME: referee comes from Libervia's client side, it's unsecure
714
ecc5a5b34ee1 plugins (games): add a method to send messages more easily
souliane <souliane@mailoo.org>
parents: 712
diff changeset
122 radio_data['to_delete'][attrs['filename']] = song_path # FIXME: works only because of the same host trick, see the note under the docstring
455
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
123
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
124 def playNext(self, room_jid, profile):
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
125 """"Play next song in queue if exists, and put a timer
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
126 which trigger after the song has been played to play next one"""
464
794f60e2da27 plugin radiocol: fixed missing import
Goffi <goffi@goffi.org>
parents: 459
diff changeset
127 #TODO: songs need to be erased once played or found invalids
577
593331663b80 plugin radiocol: songs are deleted once played (Q&D need to be reworked once file are properly transfered to server)
Goffi <goffi@goffi.org>
parents: 572
diff changeset
128 # ==> unlink done the Q&D way with the same host trick (see above)
683
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization
souliane <souliane@mailoo.org>
parents: 609
diff changeset
129 radio_data = self.games[room_jid.userhost()]
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
130 if len(radio_data['players']) == 0:
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
131 debug(_('No more participants in the radiocol: cleaning data'))
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
132 radio_data['queue'] = []
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
133 for filename in radio_data['to_delete']:
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
134 self.deleteFile(radio_data, filename)
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
135 radio_data['to_delete'] = {}
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
136 queue = radio_data['queue']
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
137 if not queue:
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
138 #nothing left to play, we need to wait for uploads
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
139 radio_data['playing'] = False
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
140 return
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
141
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
142 song = queue.pop(0)
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
143 filename, length = song['filename'], float(song['length'])
714
ecc5a5b34ee1 plugins (games): add a method to send messages more easily
souliane <souliane@mailoo.org>
parents: 712
diff changeset
144 self.send(room_jid, ('', 'play'), {'filename': filename}, profile=profile)
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
145
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
146 if not radio_data['upload'] and len(queue) < QUEUE_LIMIT:
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
147 #upload is blocked and we now have resources to get more, we reactivate it
714
ecc5a5b34ee1 plugins (games): add a method to send messages more easily
souliane <souliane@mailoo.org>
parents: 712
diff changeset
148 self.send(room_jid, ('', 'upload_ok'), profile=profile)
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
149 radio_data['upload'] = True
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
150
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
151 reactor.callLater(length, self.playNext, room_jid, profile)
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
152 #we wait more than the song length to delete the file, to manage poorly reactive networks/clients
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
153 reactor.callLater(length + 90, self.deleteFile, radio_data, filename) # FIXME: same host trick (see above)
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
154
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
155 def deleteFile(self, radio_data, filename):
577
593331663b80 plugin radiocol: songs are deleted once played (Q&D need to be reworked once file are properly transfered to server)
Goffi <goffi@goffi.org>
parents: 572
diff changeset
156 try:
593331663b80 plugin radiocol: songs are deleted once played (Q&D need to be reworked once file are properly transfered to server)
Goffi <goffi@goffi.org>
parents: 572
diff changeset
157 file_to_delete = radio_data['to_delete'][filename]
593331663b80 plugin radiocol: songs are deleted once played (Q&D need to be reworked once file are properly transfered to server)
Goffi <goffi@goffi.org>
parents: 572
diff changeset
158 except KeyError:
593331663b80 plugin radiocol: songs are deleted once played (Q&D need to be reworked once file are properly transfered to server)
Goffi <goffi@goffi.org>
parents: 572
diff changeset
159 error(_("INTERNAL ERROR: can't find full path of the song to delete"))
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
160 return False
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
161 try:
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
162 unlink(file_to_delete)
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
163 except OSError:
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
164 error(_("INTERNAL ERROR: can't find %s on the file system" % file_to_delete))
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
165 return False
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
166 return True
455
72522263cbc9 plugin RadioCol: basic functionnality working approximately
Goffi <goffi@goffi.org>
parents: 453
diff changeset
167
717
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games:
souliane <souliane@mailoo.org>
parents: 714
diff changeset
168 def room_game_cmd(self, mess_elt, profile):
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 577
diff changeset
169 from_jid = jid.JID(mess_elt['from'])
450
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
170 room_jid = jid.JID(from_jid.userhost())
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
171 radio_elt = mess_elt.firstChildElement()
683
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization
souliane <souliane@mailoo.org>
parents: 609
diff changeset
172 radio_data = self.games[room_jid.userhost()]
717
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games:
souliane <souliane@mailoo.org>
parents: 714
diff changeset
173 if 'queue' in radio_data:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games:
souliane <souliane@mailoo.org>
parents: 714
diff changeset
174 queue = radio_data['queue']
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 577
diff changeset
175
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
176 from_referee = self.isReferee(room_jid.userhost(), from_jid.resource)
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
177 to_referee = self.isReferee(room_jid.userhost(), jid.JID(mess_elt['to']).user)
450
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
178 for elt in radio_elt.elements():
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
179 if not from_referee and not (to_referee and elt.name == 'song_added'):
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
180 continue # sender must be referee, expect when a song is submitted
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 577
diff changeset
181
717
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games:
souliane <souliane@mailoo.org>
parents: 714
diff changeset
182 if elt.name == 'started' or elt.name == 'players': # new game created
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games:
souliane <souliane@mailoo.org>
parents: 714
diff changeset
183 players = []
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games:
souliane <souliane@mailoo.org>
parents: 714
diff changeset
184 for player in elt.elements():
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games:
souliane <souliane@mailoo.org>
parents: 714
diff changeset
185 players.append(unicode(player))
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games:
souliane <souliane@mailoo.org>
parents: 714
diff changeset
186 signal = self.host.bridge.radiocolStarted if elt.name == 'started' else self.host.bridge.radiocolPlayers
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
187 signal(room_jid.userhost(), from_jid.full(), players, [QUEUE_TO_START, QUEUE_LIMIT], profile)
594
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
188 elif elt.name == 'preload': # a song is in queue and must be preloaded
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
189 self.host.bridge.radiocolPreload(room_jid.userhost(), elt['timestamp'], elt['filename'], elt['title'], elt['artist'], elt['album'], profile)
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
190 elif elt.name == 'play':
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
191 self.host.bridge.radiocolPlay(room_jid.userhost(), elt['filename'], profile)
594
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
192 elif elt.name == 'song_rejected': # a song has been refused
577
593331663b80 plugin radiocol: songs are deleted once played (Q&D need to be reworked once file are properly transfered to server)
Goffi <goffi@goffi.org>
parents: 572
diff changeset
193 self.host.bridge.radiocolSongRejected(room_jid.userhost(), elt['reason'], profile)
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
194 elif elt.name == 'no_upload':
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
195 self.host.bridge.radiocolNoUpload(room_jid.userhost(), profile)
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
196 elif elt.name == 'upload_ok':
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
197 self.host.bridge.radiocolUploadOk(room_jid.userhost(), profile)
594
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
198 elif elt.name == 'song_added': # a song has been added
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
199 #FIXME: we are KISS for the proof of concept: every song is added, to a limit of 3 in queue.
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
200 # Need to manage some sort of rules to allow peoples to send songs
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 577
diff changeset
201
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
202 if len(queue) >= QUEUE_LIMIT:
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
203 #there are already too many songs in queue, we reject this one
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
204 #FIXME: add an error code
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
205 self.send(from_jid, ('', 'song_rejected'), {'reason': "Too many songs in queue"}, profile=profile)
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
206 return
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 577
diff changeset
207
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
208 #The song is accepted and added in queue
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
209 preload_elt = self.__create_preload_elt(from_jid.resource, elt)
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
210 queue.append(preload_elt)
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
211
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
212 if len(queue) >= QUEUE_LIMIT:
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
213 #We are at the limit, we refuse new upload until next play
714
ecc5a5b34ee1 plugins (games): add a method to send messages more easily
souliane <souliane@mailoo.org>
parents: 712
diff changeset
214 self.send(room_jid, ('', 'no_upload'), profile=profile)
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
215 radio_data['upload'] = False
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
216
714
ecc5a5b34ee1 plugins (games): add a method to send messages more easily
souliane <souliane@mailoo.org>
parents: 712
diff changeset
217 self.send(room_jid, preload_elt, profile=profile)
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
218 if not radio_data['playing'] and len(queue) == QUEUE_TO_START:
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
219 # We have not started playing yet, and we have QUEUE_TO_START
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
220 # songs in queue. We can now start the party :)
457
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
221 radio_data['playing'] = True
fbe7c9118ce4 plugin radiocol: working Radio Collective \o/
Goffi <goffi@goffi.org>
parents: 456
diff changeset
222 self.playNext(room_jid, profile)
450
afe9cfd2ddbb plugins: radio collective first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
223 else:
594
e629371a28d3 Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 588
diff changeset
224 error(_('Unmanaged game element: %s') % elt.name)
746
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
225
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
226 def getSyncData(self, room_jid_s):
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
227 data = self.games[room_jid_s]['queue']
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
228 if len(data) == QUEUE_LIMIT:
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
229 data.append(domish.Element((None, 'no_upload')))
539f278bc265 plugin room_games, radiocol: send the current queue to new players
souliane <souliane@mailoo.org>
parents: 718
diff changeset
230 return data