vendor/stomp-php/stomp-php/src/Protocol/Protocol.php line 324

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Stomp package.
  5.  *
  6.  * For the full copyright and license information, please view the LICENSE
  7.  * file that was distributed with this source code.
  8.  */
  10. namespace Stomp\Protocol;
  12. use Stomp\Exception\StompException;
  13. use Stomp\Transport\Frame;
  15. /**
  16.  * Stomp base protocol
  17.  *
  18.  *
  19.  * @package Stomp
  20.  * @author Hiram Chirino <hiram@hiramchirino.com>
  21.  * @author Dejan Bosanac <dejan@nighttale.net>
  22.  * @author Michael Caplan <mcaplan@labnet.net>
  23.  * @author Jens Radtke <swefl.oss@fin-sn.de>
  24.  */
  25. class Protocol
  26. {
  27.     /**
  28.      * Client id used for durable subscriptions
  29.      *
  30.      * @var string
  31.      */
  32.     private $clientId;
  34.     /**
  35.      * @var string
  36.      */
  37.     private $version;
  39.     /**
  40.      * Server Version
  41.      *
  42.      * @var string
  43.      */
  44.     private $server;
  46.     /**
  47.      * Setup stomp protocol with configuration.
  48.      *
  49.      * @param string $clientId
  50.      * @param string $version
  51.      * @param string $server
  52.      */
  53.     public function __construct($clientId, $version = Version::VERSION_1_0, $server = null)
  54.     {
  55.         $this->clientId = $clientId;
  56.         $this->server = $server;
  57.         $this->version = $version;
  58.     }
  60.     /**
  61.      * Get the connect frame
  62.      *
  63.      * @param string $login
  64.      * @param string $passcode
  65.      * @param array $versions
  66.      * @param string $host
  67.      * @param int[] $heartbeat
  68.      * @return \Stomp\Transport\Frame
  69.      */
  70.     final public function getConnectFrame(
  71.         $login = '',
  72.         $passcode = '',
  73.         array $versions = [],
  74.         $host = null,
  75.         $heartbeat = [0, 0]
  76.     ) {
  77.         $frame = $this->createFrame('CONNECT');
  78.         $frame->legacyMode(true);
  80.         if ($login || $passcode) {
  81.             $frame->addHeaders(['login' => $login, 'passcode' => $passcode]);
  82.         }
  84.         if ($this->hasClientId()) {
  85.             $frame['client-id'] = $this->getClientId();
  86.         }
  88.         if (!empty($versions)) {
  89.             $frame['accept-version'] = implode(',', $versions);
  90.         }
  92.         $frame['host'] = $host;
  94.         $frame['heart-beat'] = $heartbeat[0] . ',' . $heartbeat[1];
  96.         return $frame;
  97.     }
  99.     /**
  100.      * Get subscribe frame.
  101.      *
  102.      * @param string $destination
  103.      * @param string $subscriptionId
  104.      * @param string $ack
  105.      * @param string $selector
  106.      * @return \Stomp\Transport\Frame
  107.      * @throws StompException;
  108.      */
  109.     public function getSubscribeFrame($destination, $subscriptionId = null, $ack = 'auto', $selector = null)
  110.     {
  111.         // validate ACK types per spec
  112.         // https://stomp.github.io/stomp-specification-1.0.html#frame-ACK
  113.         // https://stomp.github.io/stomp-specification-1.1.html#ACK
  114.         // https://stomp.github.io/stomp-specification-1.2.html#ACK
  115.         if ($this->hasVersion(Version::VERSION_1_1)) {
  116.             $validAcks = ['auto', 'client', 'client-individual'];
  117.         } else {
  118.             $validAcks = ['auto', 'client'];
  119.         }
  120.         if (!in_array($ack, $validAcks)) {
  121.             throw new StompException(
  122.                 sprintf(
  123.                     '"%s" is not a valid ack value for STOMP %s. A valid value is one of %s',
  124.                     $ack,
  125.                     $this->version,
  126.                     implode(',', $validAcks)
  127.                 )
  128.             );
  129.         }
  130.         
  131.         $frame = $this->createFrame('SUBSCRIBE');
  133.         $frame['destination'] = $destination;
  134.         $frame['ack'] = $ack;
  135.         $frame['id'] = $subscriptionId;
  136.         $frame['selector'] = $selector;
  137.         return $frame;
  138.     }
  140.     /**
  141.      * Get unsubscribe frame.
  142.      *
  143.      * @param string $destination
  144.      * @param string $subscriptionId
  145.      * @return \Stomp\Transport\Frame
  146.      */
  147.     public function getUnsubscribeFrame($destination, $subscriptionId = null)
  148.     {
  149.         $frame = $this->createFrame('UNSUBSCRIBE');
  150.         $frame['destination'] = $destination;
  151.         $frame['id'] = $subscriptionId;
  152.         return $frame;
  153.     }
  155.     /**
  156.      * Get transaction begin frame.
  157.      *
  158.      * @param string $transactionId
  159.      * @return \Stomp\Transport\Frame
  160.      */
  161.     public function getBeginFrame($transactionId = null)
  162.     {
  163.         $frame = $this->createFrame('BEGIN');
  164.         $frame['transaction'] = $transactionId;
  165.         return $frame;
  166.     }
  168.     /**
  169.      * Get transaction commit frame.
  170.      *
  171.      * @param string $transactionId
  172.      * @return \Stomp\Transport\Frame
  173.      */
  174.     public function getCommitFrame($transactionId = null)
  175.     {
  176.         $frame = $this->createFrame('COMMIT');
  177.         $frame['transaction'] = $transactionId;
  178.         return $frame;
  179.     }
  181.     /**
  182.      * Get transaction abort frame.
  183.      *
  184.      * @param string $transactionId
  185.      * @return \Stomp\Transport\Frame
  186.      */
  187.     public function getAbortFrame($transactionId = null)
  188.     {
  189.         $frame = $this->createFrame('ABORT');
  190.         $frame['transaction'] = $transactionId;
  191.         return $frame;
  192.     }
  194.     /**
  195.      * Get message acknowledge frame.
  196.      *
  197.      * @param Frame $frame
  198.      * @param string $transactionId
  199.      * @return Frame
  200.      */
  201.     public function getAckFrame(Frame $frame, $transactionId = null)
  202.     {
  203.         $ack = $this->createFrame('ACK');
  204.         $ack['transaction'] = $transactionId;
  205.         if ($this->hasVersion(Version::VERSION_1_2)) {
  206.             if (isset($frame['ack'])) {
  207.                 $ack['id'] = $frame['ack'];
  208.             } else {
  209.                 $ack['id'] = $frame->getMessageId();
  210.             }
  211.         } else {
  212.             $ack['message-id'] = $frame->getMessageId();
  213.             if ($this->hasVersion(Version::VERSION_1_1)) {
  214.                 $ack['subscription'] = $frame['subscription'];
  215.             }
  216.         }
  217.         return $ack;
  218.     }
  220.     /**
  221.      * Get message not acknowledge frame.
  222.      *
  223.      * @param \Stomp\Transport\Frame $frame
  224.      * @param string $transactionId
  225.      * @param bool $requeue Requeue header
  226.      * @return \Stomp\Transport\Frame
  227.      * @throws StompException
  228.      * @throws \LogicException
  229.      */
  230.     public function getNackFrame(Frame $frame, $transactionId = null, $requeue = null)
  231.     {
  232.         if ($requeue !== null) {
  233.             throw new \LogicException('requeue header not supported');
  234.         }
  235.         if ($this->version === Version::VERSION_1_0) {
  236.             throw new StompException('Stomp Version 1.0 has no support for NACK Frames.');
  237.         }
  238.         $nack = $this->createFrame('NACK');
  239.         $nack['transaction'] = $transactionId;
  240.         if ($this->hasVersion(Version::VERSION_1_2)) {
  241.             $nack['id'] = $frame->getMessageId();
  242.         } else {
  243.             $nack['message-id'] = $frame->getMessageId();
  244.             if ($this->hasVersion(Version::VERSION_1_1)) {
  245.                 $nack['subscription'] = $frame['subscription'];
  246.             }
  247.         }
  249.         $nack['message-id'] = $frame->getMessageId();
  250.         return $nack;
  251.     }
  253.     /**
  254.      * Get the disconnect frame.
  255.      *
  256.      * @return \Stomp\Transport\Frame
  257.      */
  258.     public function getDisconnectFrame()
  259.     {
  260.         $frame = $this->createFrame('DISCONNECT');
  261.         if ($this->hasClientId()) {
  262.             $frame['client-id'] = $this->getClientId();
  263.         }
  264.         return $frame;
  265.     }
  267.     /**
  268.      * Client Id is set
  269.      *
  270.      * @return boolean
  271.      */
  272.     public function hasClientId()
  273.     {
  274.         return (boolean) $this->clientId;
  275.     }
  277.     /**
  278.      * Client Id is set
  279.      *
  280.      * @return string
  281.      */
  282.     public function getClientId()
  283.     {
  284.         return $this->clientId;
  285.     }
  287.     /**
  288.      * Stomp Version
  289.      *
  290.      * @return string
  291.      */
  292.     public function getVersion()
  293.     {
  294.         return $this->version;
  295.     }
  297.     /**
  298.      * Server Version Info
  299.      *
  300.      * @return string
  301.      */
  302.     public function getServer()
  303.     {
  304.         return $this->server;
  305.     }
  307.     /**
  308.      * Checks if given version is included (equal or lower) in active protocol version.
  309.      *
  310.      * @param string $version
  311.      * @return bool
  312.      */
  313.     public function hasVersion($version)
  314.     {
  315.         return version_compare($this->version, $version, '>=');
  316.     }
  318.     /**
  319.      * Creates a Frame according to the detected STOMP version.
  320.      *
  321.      * @param string $command
  322.      * @return Frame
  323.      */
  324.     protected function createFrame($command)
  325.     {
  326.         $frame = new Frame($command);
  328.         if ($this->version === Version::VERSION_1_0) {
  329.             $frame->legacyMode(true);
  330.         }
  332.         return $frame;
  333.     }
  334. }