/lib/class/broadcast_server.class.php

<?php
/* vim:set softtabstop=4 shiftwidth=4 expandtab: */
/**
 *
 * LICENSE: GNU General Public License, version 2 (GPLv2)
 * Copyright 2001 - 2015 Ampache.org
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License v2
 * as published by the Free Software Foundation.
 *
 * 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

use Ratchet\MessageComponentInterface;
use Ratchet\ConnectionInterface;

class Broadcast_Server implements MessageComponentInterface
{
    const BROADCAST_SONG = "SONG";
    const BROADCAST_SONG_POSITION = "SONG_POSITION";
    const BROADCAST_PLAYER_PLAY = "PLAYER_PLAY";
    const BROADCAST_REGISTER_BROADCAST = "REGISTER_BROADCAST";
    const BROADCAST_REGISTER_LISTENER = "REGISTER_LISTENER";
    const BROADCAST_ENDED = "ENDED";
    const BROADCAST_INFO = "INFO";
    const BROADCAST_NB_LISTENERS = "NB_LISTENERS";
    const BROADCAST_AUTH_SID = "AUTH_SID";

    public $verbose;
    /**
     * @var ConnectionInterface[] $clients
     */
    protected $clients;
    /**
     * @var string[] $sids
     */
    protected $sids;
    /**
     * @var ConnectionInterface[] $listeners
     */
    protected $listeners;
    /**
     * @var Broadcast[] $broadcasters
     */
    protected $broadcasters;

    public function __construct()
    {
        $this->verbose = false;
        $this->clients = array();
        $this->sids = array();
        $this->listeners = array();
        $this->broadcasters = array();
    }

    /**
     *
     * @param \Ratchet\ConnectionInterface $conn
     */
    public function onOpen(ConnectionInterface $conn)
    {
        $this->clients[$conn->resourceId] = $conn;
    }

    /**
     *
     * @param \Ratchet\ConnectionInterface $from
     * @param string $msg
     */
    public function onMessage(ConnectionInterface $from, $msg)
    {
        $commands = explode(';', $msg);
        foreach ($commands as $command) {
            $command = trim($command);
            if (!empty($command)) {
                $cmdinfo = explode(':', $command, 2);

                if (count($cmdinfo) == 2) {
                    switch ($cmdinfo[0]) {
                        case self::BROADCAST_SONG:
                            $this->notifySong($from, $cmdinfo[1]);
                        break;
                        case self::BROADCAST_SONG_POSITION:
                            $this->notifySongPosition($from, $cmdinfo[1]);
                        break;
                        case self::BROADCAST_PLAYER_PLAY:
                            $this->notifyPlayerPlay($from, $cmdinfo[1]);
                        break;
                        case self::BROADCAST_ENDED:
                            $this->notifyEnded($from);
                        break;
                        case self::BROADCAST_REGISTER_BROADCAST:
                            $this->registerBroadcast($from, $cmdinfo[1]);
                        break;
                        case self::BROADCAST_REGISTER_LISTENER:
                            $this->registerListener($from, $cmdinfo[1]);
                        break;
                        case self::BROADCAST_AUTH_SID:
                            $this->authSid($from, $cmdinfo[1]);
                        break;
                        default:
                            if ($this->verbose) {
                                echo "[" . time() ."][warning]Unknown message code." . "\r\n";
                            }
                        break;
                    }
                } else {
                    if ($this->verbose) {
                        echo "[" . time() ."][error]Wrong message format (" . $command . ")." . "\r\n";
                    }
                }
            }
        }
    }

    /**
     *
     * @param int $song_id
     * @return string
     */
    protected function getSongJS($song_id)
    {
        $media = array();
        $media[] = array(
            'object_type' => 'song',
            'object_id' => $song_id
        );
        $item = Stream_Playlist::media_to_urlarray($media);

        return WebPlayer::get_media_js_param($item[0]);
    }

    /**
     *
     * @param \Ratchet\ConnectionInterface $from
     * @param int $song_id
     */
    protected function notifySong(ConnectionInterface $from, $song_id)
    {
        if ($this->isBroadcaster($from)) {
            $broadcast = $this->broadcasters[$from->resourceId];
            $clients = $this->getListeners($broadcast);

            Session::extend(Stream::get_session(), 'stream');

            $broadcast->update_song($song_id);
            $this->broadcastMessage($clients, self::BROADCAST_SONG, base64_encode($this->getSongJS($song_id)));

            if ($this->verbose) {
                echo "[" . time() ."][info]Broadcast " . $broadcast->id . " now playing song " . $song_id . "." . "\r\n";
            }
        } else {
            debug_event('broadcast', 'Action unauthorized.', '3');
        }
    }

    /**
     *
     * @param \Ratchet\ConnectionInterface $from
     * @param int $song_position
     */
    protected function notifySongPosition(ConnectionInterface $from, $song_position)
    {
        if ($this->isBroadcaster($from)) {
            $broadcast = $this->broadcasters[$from->resourceId];
            $seekdiff = $broadcast->song_position - $song_position;
            if ($seekdiff > 2 || $seekdiff < -2) {
                $clients = $this->getListeners($broadcast);
                $this->broadcastMessage($clients, self::BROADCAST_SONG_POSITION, $song_position);
            }
            $broadcast->song_position = $song_position;

            if ($this->verbose) {
                echo "[" . time() ."][info]Broadcast " . $broadcast->id . " has song position to " . $song_position . "." . "\r\n";
            }
        } else {
            debug_event('broadcast', 'Action unauthorized.', '3');
        }
    }

    /**
     *
     * @param \Ratchet\ConnectionInterface $from
     * @param boolean $play
     */
    protected function notifyPlayerPlay(ConnectionInterface $from, $play)
    {
        if ($this->isBroadcaster($from)) {
            $broadcast = $this->broadcasters[$from->resourceId];
            $clients = $this->getListeners($broadcast);
            $this->broadcastMessage($clients, self::BROADCAST_PLAYER_PLAY, $play ? 'true' : 'false');

            if ($this->verbose) {
                echo "[" . time() ."][info]Broadcast " . $broadcast->id . " player state: " . $play . "." . "\r\n";
            }
        } else {
            debug_event('broadcast', 'Action unauthorized.', '3');
        }
    }

    /**
     *
     * @param \Ratchet\ConnectionInterface $from
     */
    protected function notifyEnded(ConnectionInterface $from)
    {
        if ($this->isBroadcaster($from)) {
            $broadcast = $this->broadcasters[$from->resourceId];
            $clients = $this->getListeners($broadcast);
            $this->broadcastMessage($clients, self::BROADCAST_ENDED);

            if ($this->verbose) {
                echo "[" . time() ."][info]Broadcast " . $broadcast->id . " ended." . "\r\n";
            }
        } else {
            debug_event('broadcast', 'Action unauthorized.', '3');
        }
    }

    /**
     *
     * @param \Ratchet\ConnectionInterface $from
     * @param string $broadcast_key
     */
    protected function registerBroadcast(ConnectionInterface $from, $broadcast_key)
    {
        $broadcast = Broadcast::get_broadcast($broadcast_key);
        if ($broadcast) {
            $this->broadcasters[$from->resourceId] = $broadcast;
            $this->listeners[$broadcast->id] = array();

            if ($this->verbose) {
                echo "[info]Broadcast " . $broadcast->id . " registered." . "\r\n";
            }
        }
    }

    /**
     *
     * @param \Ratchet\ConnectionInterface $conn
     */
    protected function unregisterBroadcast(ConnectionInterface $conn)
    {
        $broadcast = $this->broadcasters[$conn->resourceId];
        $clients = $this->getListeners($broadcast);
        $this->broadcastMessage($clients, self::BROADCAST_ENDED);
        $broadcast->update_state(false);

        unset($this->listeners[$broadcast->id]);
        unset($this->broadcasters[$conn->resourceId]);

        if ($this->verbose) {
            echo "[" . time() ."][info]Broadcast " . $broadcast->id . " unregistered." . "\r\n";
        }
    }

    /**
     *
     * @param int $broadcast_id
     * @return Broadcast
     */
    protected function getRunningBroadcast($broadcast_id)
    {
        $broadcast = null;
        foreach ($this->broadcasters as $conn_id => $br) {
            if ($br->id == $broadcast_id) {
                $broadcast = $br;
                break;
            }
        }
        return $broadcast;
    }

    /**
     *
     * @param \Ratchet\ConnectionInterface $from
     * @param int $broadcast_id
     */
    protected function registerListener(ConnectionInterface $from, $broadcast_id)
    {
        $broadcast = $this->getRunningBroadcast($broadcast_id);

        if (!$broadcast->is_private || !AmpConfig::get('require_session') || Session::exists('stream', $this->sids[$from->resourceId])) {
            $this->listeners[$broadcast->id][] = $from;

            // Send current song and song position to
            $this->broadcastMessage(array($from), self::BROADCAST_SONG, base64_encode($this->getSongJS($broadcast->song)));
            $this->broadcastMessage(array($from), self::BROADCAST_SONG_POSITION, $broadcast->song_position);
            $this->notifyNbListeners($broadcast);

            if ($this->verbose) {
                echo "[info]New listener on broadcast " . $broadcast->id . "." . "\r\n";
            }
        } else {
            debug_event('broadcast', 'Listener unauthorized.', '3');
        }
    }

    /**
     *
     * @param \Ratchet\ConnectionInterface $conn
     * @param string $sid
     */
    protected function authSid(ConnectionInterface $conn, $sid)
    {
        if (Session::exists('stream', $sid)) {
            $this->sids[$conn->resourceId] = $sid;
        } else {
            if ($this->verbose) {
                echo "Wrong listener session " . $sid . "\r\n";
            }
        }
    }

    /**
     *
     * @param \Ratchet\ConnectionInterface $conn
     */
    protected function unregisterListener(ConnectionInterface $conn)
    {
        foreach ($this->listeners as $broadcast_id => $brlisteners) {
            $lindex = array_search($conn, $brlisteners);
            if ($lindex) {
                unset($this->listeners[$broadcast_id][$lindex]);
                echo "[info]Listener leaved broadcast " . $broadcast_id . "." . "\r\n";

                foreach ($this->broadcasters as $broadcaster_id => $broadcast) {
                    if ($broadcast->id == $broadcast_id) {
                        $this->notifyNbListeners($broadcast);
                        break;
                    }
                }

                break;
            }
        }
    }

    /**
     *
     * @param Broadcast $broadcast
     */
    protected function notifyNbListeners(Broadcast $broadcast)
    {
        $broadcaster_id = array_search($broadcast, $this->broadcasters);
        if ($broadcaster_id) {
            $clients = $this->listeners[$broadcast->id];
            $clients[] = $this->clients[$broadcaster_id];
            $nb_listeners = count($this->listeners[$broadcast->id]);
            $broadcast->update_listeners($nb_listeners);
            $this->broadcastMessage($clients, self::BROADCAST_NB_LISTENERS, $nb_listeners);
        }
    }

    /**
     *
     * @param Broadcast $broadcast
     * @return \Ratchet\ConnectionInterface
     */
    protected function getListeners(Broadcast $broadcast)
    {
        return $this->listeners[$broadcast->id];
    }

    /**
     *
     * @param \Ratchet\ConnectionInterface $conn
     * @return boolean
     */
    protected function isBroadcaster(ConnectionInterface $conn)
    {
        return array_key_exists($conn->resourceId, $this->broadcasters);
    }

    /**
     *
     * @param \Ratchet\ConnectionInterface[] $clients
     * @param string $cmd
     * @param string $value
     */
    protected function broadcastMessage($clients, $cmd, $value='')
    {
        $msg = $cmd . ':' . $value . ';';
        foreach ($clients as $client) {
            $sid = $this->sids[$client->resourceId];
            if ($sid) {
                Session::extend($sid, 'stream');
            }
            $client->send($msg);
        }
    }

    /**
     *
     * @param \Ratchet\ConnectionInterface $conn
     */
    public function onClose(ConnectionInterface $conn)
    {
        if ($this->isBroadcaster($conn)) {
            $this->unregisterBroadcast($conn);
        } else {
            $this->unregisterListener($conn);
        }

        unset($this->clients[$conn->resourceId]);
        unset($this->sids[$conn->resourceId]);
    }

    /**
     *
     * @param \Ratchet\ConnectionInterface $conn
     * @param \Exception $e
     */
    public function onError(ConnectionInterface $conn, \Exception $e)
    {
        $conn->close();
    }

    /**
     *
     * @return string
     */
    public static function get_address()
    {
        $websocket_address = AmpConfig::get('websocket_address');
        if (empty($websocket_address)) {
            $websocket_address = 'ws://' . $_SERVER['HTTP_HOST'] . ':8100';
        }

        return $websocket_address . '/broadcast';
    }

} // end of broadcast_server class