command.php

LINUX下

<?php
/*
 * btg Copyright (C) 2005 Michael Wojciechowski.
 * PHP client written by Johan Str枚m.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * 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
 */

/*
 * $Id: command.php,v 1.1.4.17 2007/09/17 15:34:51 wojci Exp $
 */
if(!defined("BTG_BCORE_PATH"))
	define("BTG_BCORE_PATH", "bcore");

require_once(BTG_BCORE_PATH."/btgexception.php");
require_once(BTG_BCORE_PATH."/serializable.php");

class Command extends BTGSerializable
{
	const INVALID_SESSION = -1;
	
	/* This list of available commands is generated from _gencommands.php! 
		In VIM the following command can be used to exec the command and put the text here:

		:r! php -q _gencommands.php

		Only the const stuff is added from _gencommands, not the maps!
	*/

	const CN_GINITCONNECTION = 1;  //!< Init session.
	const CN_GSETUP = 2;           //!< Setup command.
	const CN_GSETUPRSP = 3;        //!< Setup response command.
	const CN_GKILL = 4;            //!< Bring down the daemon.
	const CN_GLIMIT = 5;           //!< Limit.
	const CN_GLIMITSTAT = 6;       //!< Limit request.
	const CN_GLIMITSTATRSP = 7;    //!< Limit request response.
	const CN_GUPTIME = 8;          //!< Get daemon uptime.
	const CN_GUPTIMERSP = 9;       //!< Daemon uptime response.
	const CN_GLIST = 10;            //!< List request.
	const CN_GLISTRSP = 11;         //!< List request response.
	const CN_CCREATEWITHDATA = 12;  //!< Create a context, using embedded data.
	const CN_CLAST = 13;            //!< Last context.
	const CN_CLASTRSP = 14;         //!< Last context response.
	const CN_CSTART = 15;           //!< Start a context.
	const CN_CSTOP = 16;            //!< Stop a context.
	const CN_CABORT = 17;           //!< Abort a context.
	const CN_CSTATUS = 18;          //!< Request status information about a context.
	const CN_CSTATUSRSP = 19;       //!< Status information about one context.
	const CN_CALLSTATUSRSP = 20;    //!< Status information about all contexts.
	const CN_CFILEINFO = 21;        //!< Request file info information about a context.
	const CN_CFILEINFORSP = 22;     //!< File info information about a context.
	const CN_CALLFILEINFORSP = 23;  //!< File info information about all contexts.
	const CN_CCLEAN = 24;           //!< Request to clean finished contexts.
	const CN_CCLEANRSP = 25;        //!> Response that informs the client that some contexts have been cleaned.
	const CN_CLIMIT = 26;           //!< Limit a context.
	const CN_CLIMITSTATUS = 27;     //!< Limit status.
	const CN_CLIMITSTATUSRSP = 28;  //!< Limit status response.
	const CN_CPEERS = 29;           //!< Request a list of peers.
	const CN_CPEERSRSP = 30;        //!< Response containing a list of peers.

	const CN_CSETFILES = 31;
	const CN_CGETFILES = 32;
	const CN_CGETFILESRSP = 33;

	const CN_ERROR = 34;            //!< General error.
	const CN_ACK = 35;              //!< General acknowlegment.
	const CN_SATTACH = 36;          //!< Attach to a running session.
	const CN_SDETACH = 37;          //!< Detach from a running session.
	const CN_SERROR = 38;           //!< Daemon uses this command to tell clients that their session is invalid.
	const CN_SQUIT = 39;            //!< Quit the current session.
	const CN_SLIST = 40;            //!< Get a list of sessions.
	const CN_SLISTRSP = 41;         //!< Response that lists sessions.
	const CN_MOREAD = 42;           //!< Only read only access. Usefull for writing monitor applets.
	const CN_MOWRITE = 43;          //!< Default write mode.
	const CN_UNDEFINED = 44;        //!< Undefined command.


	/* Map differnt commands to descriptive names */
	private $idToNameMap = array(
         // General:
         Command::CN_GINITCONNECTION => "(g) Init connection",
         Command::CN_GSETUP          => "(g) Setup command",
         Command::CN_GSETUPRSP       => "(g) Setup response command",
         Command::CN_GKILL           => "(g) Kill daemon",
         Command::CN_GLIMIT          => "(g) Limit",
         Command::CN_GLIMITSTAT      => "(g) Limit status",
         Command::CN_GLIMITSTATRSP   => "(g) Limit status response",
         Command::CN_GUPTIME         => "(g) Daemon uptime request",
         Command::CN_GUPTIMERSP      => "(g) Daemon uptime response",
         Command::CN_GLIST           => "(g) List request",
         Command::CN_GLISTRSP        => "(g) List request response",
         // Context:
         Command::CN_CCREATEWITHDATA => "(c) Create context (data)",
         Command::CN_CLAST           => "(c) Last context",
         Command::CN_CLASTRSP        => "(c) Last context response",
         Command::CN_CSTART          => "(c) Start context",
         Command::CN_CSTOP           => "(c) Stop context",
         Command::CN_CABORT          => "(c) Abort context",
         Command::CN_CSTATUS         => "(c) Status",
         Command::CN_CSTATUSRSP      => "(c) Status response",
         Command::CN_CALLSTATUSRSP   => "(c) Status all response",
         Command::CN_CFILEINFO       => "(c) File info",
         Command::CN_CFILEINFORSP    => "(c) File info response",
         Command::CN_CALLFILEINFORSP => "(c) File info all response",
         Command::CN_CCLEAN          => "(c) Clean",
         Command::CN_CCLEANRSP       => "(c) Clean response",
         Command::CN_CLIMIT          => "(c) Limit",
         Command::CN_CLIMITSTATUS    => "(c) Limit status",
         Command::CN_CLIMITSTATUSRSP => "(c) Limit status response",
         Command::CN_CPEERS          => "(c) List peers",
         Command::CN_CPEERSRSP       => "(c) List peers response",
         Command::CN_CSETFILES       => "(c) Set files",
	      Command::CN_CGETFILES       => "(c) Get selected files",
         Command::CN_CGETFILESRSP    => "(c) Get selected files response",
         // General:
         Command::CN_ERROR           => "(g) Error",
         Command::CN_ACK             => "(g) Ack",
         // Session:
         Command::CN_SATTACH         => "(s) Attach",
         Command::CN_SDETACH         => "(s) Detach",
         Command::CN_SQUIT           => "(s) Quit",
         Command::CN_SERROR          => "(s) Error",
         Command::CN_SLIST           => "(s) List",
         Command::CN_SLISTRSP        => "(s) List response",
         // Mode, yet to be implemented.
         Command::CN_MOREAD          => "(m) RO mode",
         Command::CN_MOWRITE         => "(m) RW mode",
         // Undefined.
         Command::CN_UNDEFINED       => "Undefined"
      );

	/* Map differnt commands to method names */
	private $idToMethodNameMap = array(
            // General:
            Command::CN_GINITCONNECTION => "general.initconnection",
            Command::CN_GSETUP          => "general.setup",
            Command::CN_GSETUPRSP       => "general.setuprsp",
            Command::CN_GKILL           => "general.kill",
            Command::CN_GLIMIT          => "general.limit",
            Command::CN_GLIMITSTAT      => "general.limitstat",
            Command::CN_GLIMITSTATRSP   => "general.limitstatrsp",
            Command::CN_GUPTIME         => "general.uptime",
            Command::CN_GUPTIMERSP      => "general.uptimersp",
            Command::CN_GLIST           => "general.list",
            Command::CN_GLISTRSP        => "general.listrsp",
            // Context:
            Command::CN_CCREATEWITHDATA => "context.createwithdata",
            Command::CN_CLAST           => "context.last",
            Command::CN_CLASTRSP        => "context.lastrsp",
            Command::CN_CSTART          => "context.start",
            Command::CN_CCREATEWITHDATA => "context.createwithdata",
            Command::CN_CSTART          => "context.start",
            Command::CN_CSTOP           => "context.stop",
            Command::CN_CABORT          => "context.abort",
            Command::CN_CSTATUS         => "context.status",
            Command::CN_CSTATUSRSP      => "context.statusrsp",
            Command::CN_CALLSTATUSRSP   => "context.statusallrsp",
            Command::CN_CFILEINFO       => "context.fileinfo",
            Command::CN_CFILEINFORSP    => "context.fileinforsp",
            Command::CN_CALLFILEINFORSP => "context.fileinfoallrsp",
            Command::CN_CCLEAN          => "context.clean",
            Command::CN_CCLEANRSP       => "context.cleanrsp",
            Command::CN_CLIMIT          => "context.limit",
            Command::CN_CLIMITSTATUS    => "context.limitstatus",
            Command::CN_CLIMITSTATUSRSP => "context.limitstatusrsp",
            Command::CN_CPEERS          => "context.peers",
            Command::CN_CPEERSRSP       => "context.peersrsp",
            Command::CN_CSETFILES       => "context.setfiles",
            Command::CN_CGETFILES       => "context.getfiles",
            Command::CN_CGETFILESRSP    => "context.getfilesrsp",
            // General:
            Command::CN_ERROR           => "general.error",
            Command::CN_ACK             => "general.ack",
            // Session:
            Command::CN_SATTACH         => "session.attach",
            Command::CN_SDETACH         => "session.detach",
            Command::CN_SQUIT           => "session.quit",
            Command::CN_SERROR          => "session.error",
            Command::CN_SLIST           => "session.list",
            Command::CN_SLISTRSP        => "session.listrsp",
            // Mode, yet to be implemented.
            Command::CN_MOREAD          => "mode.ro",
            Command::CN_MOWRITE         => "mode.rw",
            // Undefined.
            Command::CN_UNDEFINED       => "Undefined"
		);
	
	/* Command specific vars */
	private $type;

	public function Command($type)
	{
		$this->type = $type;
	}

	public function getType()
	{
		return $this->type;
	}

	public function getName()
	{
		return $this->getNameById($this->type);
	}

	public function getNameById($type)
	{
		if(isset($this->idToNameMap[$type]))
			return $this->idToNameMap[$type];
		else
			return $this->idToNameMap[Command::CN_UNDEFINED];
	}

	public function getMethodName()
	{
		return $this->getMethodNameById($this->type);
	}

	public function getMethodNameById($type)
	{
		if(isset($this->idToMethodNameMap[$type]))
			return $this->idToMethodNameMap[$type];
		else
			return $this->idToMethodNameMap[Command::CN_UNDEFINED];
	}

	/**
		Returns an array with items, ready to send to xmlrpc clients query_arg()
	*/
	public function serialize(&$a = array())
	{
		$a[] = $this->getMethodName();
		$this->intToBytes($a, $this->type);
		return $a;
	}

	public function deserialize(&$data)
	{
		$this->bytesToInt($cmdid, $data);

		if($this->getType() !== $cmdid)
			throw new BTGException("Command::deserialize failed, deserialization says $cmdid, command says ".$this->getType()."\n");
	}

	public function isInitialized()
	{
		if($this->getType() != Command::CN_UNDEFINED)
			return true;
		else
			return false;
	}

	public function toString()
	{
		if($this->isInitialized())
			return $this->getName() . ".";
		else
			return $this->getName() . ", not initialized.";
	}
}

?>