<?php
/**
 * This code is free software; you can redistribute it and/or modify it under
 * the terms of the new BSD License.
 *
 * Copyright (c) 2010-2011, Sebastian Staudt
 *
 * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
 */

require_once STEAM_CONDENSER_PATH . 'steam/packets/SteamPacket.php';

/**
 * The S2M_HEARTBEAT2 packet type is used to signal a game servers availability
 * and status to the master servers.
 *
 * @author     Sebastian Staudt
 * @package    steam-condenser
 * @subpackage packets
 * @see        MasterServer::sendHeartbeat()
 */
class S2M_HEARTBEAT2_Packet extends SteamPacket {

    /**
     * @var array Default data to send with a S2M_HEARTBEAT2 packet
     */
    private static $DEFAULT_DATA = array(
            'appid'     => 320,
            'bots'      => 0,
            'challenge' => null,
            'dedicated' => 0,
            'gamedir'   => 'hl2mp',
            'gameport'  => 27015,
            'gametype'  => 'ctf',
            'lan'       => 1,
            'map'       => 'null',
            'max'       => 24,
            'os'        => 'l',
            'password'  => 0,
            'players'   => 0,
            'product'   => 'hl2dm',
            'protocol'  => 7,
            'region'    => 255,
            'secure'    => 0,
            'specport'  => 0,
            'type'      => 'd',
            'version'   => '1.0.0.0'
        );

    /**
     * Creates a new S2M_HEARTBEAT2 packet object based on the given data
     *
     * @param array $data The data to send with the heartbeat. The data
     *        contents are merged with the values from {@link DEFAULT_DATA}.
     * @throws SteamCondenserException when the required challenge number is
     *         missing
     */
    public function __construct($data = array()) {
        $data = array_merge(self::$DEFAULT_DATA, $data);

        if(empty($data['challenge'])) {
            throw new SteamCondenserException('You have to provide a challenge number when sending a heartbeat to a master server.');
        }

        $bytes = "\x0A";
        while(list($k, $v) = each($data)) {
            $bytes .= "\\$k\\$v";
        }
        $bytes .= "\x0A";

        parent::__construct(SteamPacket::S2M_HEARTBEAT2_HEADER, $bytes);
    }

    /**
     * Returns the raw data representing this packet
     *
     * @return string A string containing the raw data of this request packet
     */
    public function __toString() {
        return pack('ca*', $this->headerData, $this->contentData->_array());
    }

}
?>