Predis.php 104 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047
  1. <?php
  2. namespace Predis;
  3. class PredisException extends \Exception { }
  4. class ClientException extends PredisException { } // Client-side errors
  5. class AbortedMultiExec extends PredisException { } // Aborted multi/exec
  6. class ServerException extends PredisException { // Server-side errors
  7. public function toResponseError() {
  8. return new ResponseError($this->getMessage());
  9. }
  10. }
  11. class CommunicationException extends PredisException { // Communication errors
  12. private $_connection;
  13. public function __construct(Connection $connection, $message = null, $code = null) {
  14. $this->_connection = $connection;
  15. parent::__construct($message, $code);
  16. }
  17. public function getConnection() { return $this->_connection; }
  18. public function shouldResetConnection() { return true; }
  19. }
  20. class MalformedServerResponse extends CommunicationException { } // Unexpected responses
  21. /* ------------------------------------------------------------------------- */
  22. class Client {
  23. private $_options, $_connection, $_serverProfile, $_responseReader;
  24. public function __construct($parameters = null, $clientOptions = null) {
  25. $this->setupClient($clientOptions ?: new ClientOptions());
  26. $this->setupConnection($parameters);
  27. }
  28. public static function create(/* arguments */) {
  29. $argv = func_get_args();
  30. $argc = func_num_args();
  31. $options = null;
  32. $lastArg = $argv[$argc-1];
  33. if ($argc > 0 && !is_string($lastArg) && ($lastArg instanceof ClientOptions ||
  34. is_subclass_of($lastArg, '\Predis\RedisServerProfile'))) {
  35. $options = array_pop($argv);
  36. $argc--;
  37. }
  38. if ($argc === 0) {
  39. throw new ClientException('Missing connection parameters');
  40. }
  41. return new Client($argc === 1 ? $argv[0] : $argv, $options);
  42. }
  43. private static function filterClientOptions($options) {
  44. if ($options instanceof ClientOptions) {
  45. return $options;
  46. }
  47. if (is_array($options)) {
  48. return new ClientOptions($options);
  49. }
  50. if ($options instanceof RedisServerProfile) {
  51. return new ClientOptions(array(
  52. 'profile' => $options
  53. ));
  54. }
  55. if (is_string($options)) {
  56. return new ClientOptions(array(
  57. 'profile' => RedisServerProfile::get($options)
  58. ));
  59. }
  60. throw new \InvalidArgumentException("Invalid type for client options");
  61. }
  62. private function setupClient($options) {
  63. $this->_responseReader = new ResponseReader();
  64. $this->_options = self::filterClientOptions($options);
  65. $this->setProfile($this->_options->profile);
  66. if ($this->_options->iterable_multibulk === true) {
  67. $this->_responseReader->setHandler(
  68. Protocol::PREFIX_MULTI_BULK,
  69. new ResponseMultiBulkStreamHandler()
  70. );
  71. }
  72. if ($this->_options->throw_on_error === false) {
  73. $this->_responseReader->setHandler(
  74. Protocol::PREFIX_ERROR,
  75. new ResponseErrorSilentHandler()
  76. );
  77. }
  78. }
  79. private function setupConnection($parameters) {
  80. if ($parameters !== null && !(is_array($parameters) || is_string($parameters))) {
  81. throw new ClientException('Invalid parameters type (array or string expected)');
  82. }
  83. if (is_array($parameters) && isset($parameters[0])) {
  84. $cluster = new ConnectionCluster($this->_options->key_distribution);
  85. foreach ($parameters as $shardParams) {
  86. $cluster->add($this->createConnection($shardParams));
  87. }
  88. $this->setConnection($cluster);
  89. }
  90. else {
  91. $this->setConnection($this->createConnection($parameters));
  92. }
  93. }
  94. private function createConnection($parameters) {
  95. $params = $parameters instanceof ConnectionParameters
  96. ? $parameters
  97. : new ConnectionParameters($parameters);
  98. $connection = new Connection($params, $this->_responseReader);
  99. if ($params->password !== null) {
  100. $connection->pushInitCommand($this->createCommand(
  101. 'auth', array($params->password)
  102. ));
  103. }
  104. if ($params->database !== null) {
  105. $connection->pushInitCommand($this->createCommand(
  106. 'select', array($params->database)
  107. ));
  108. }
  109. return $connection;
  110. }
  111. private function setConnection(IConnection $connection) {
  112. $this->_connection = $connection;
  113. }
  114. public function setProfile($serverProfile) {
  115. if (!($serverProfile instanceof RedisServerProfile || is_string($serverProfile))) {
  116. throw new \InvalidArgumentException(
  117. "Invalid type for server profile, \Predis\RedisServerProfile or string expected"
  118. );
  119. }
  120. $this->_serverProfile = (is_string($serverProfile)
  121. ? RedisServerProfile::get($serverProfile)
  122. : $serverProfile
  123. );
  124. }
  125. public function getProfile() {
  126. return $this->_serverProfile;
  127. }
  128. public function getResponseReader() {
  129. return $this->_responseReader;
  130. }
  131. public function getClientFor($connectionAlias) {
  132. if (!Shared\Utils::isCluster($this->_connection)) {
  133. throw new ClientException(
  134. 'This method is supported only when the client is connected to a cluster of connections'
  135. );
  136. }
  137. $connection = $this->_connection->getConnectionById($connectionAlias);
  138. if ($connection === null) {
  139. throw new \InvalidArgumentException(
  140. "Invalid connection alias: '$connectionAlias'"
  141. );
  142. }
  143. $newClient = new Client();
  144. $newClient->setupClient($this->_options);
  145. $newClient->setConnection($connection);
  146. return $newClient;
  147. }
  148. public function connect() {
  149. $this->_connection->connect();
  150. }
  151. public function disconnect() {
  152. $this->_connection->disconnect();
  153. }
  154. public function isConnected() {
  155. return $this->_connection->isConnected();
  156. }
  157. public function getConnection($id = null) {
  158. if (!isset($id)) {
  159. return $this->_connection;
  160. }
  161. else {
  162. return Shared\Utils::isCluster($this->_connection)
  163. ? $this->_connection->getConnectionById($id)
  164. : $this->_connection;
  165. }
  166. }
  167. public function __call($method, $arguments) {
  168. $command = $this->_serverProfile->createCommand($method, $arguments);
  169. return $this->_connection->executeCommand($command);
  170. }
  171. public function createCommand($method, $arguments = array()) {
  172. return $this->_serverProfile->createCommand($method, $arguments);
  173. }
  174. public function executeCommand(Command $command) {
  175. return $this->_connection->executeCommand($command);
  176. }
  177. public function executeCommandOnShards(Command $command) {
  178. $replies = array();
  179. if (Shared\Utils::isCluster($this->_connection)) {
  180. foreach($this->_connection as $connection) {
  181. $replies[] = $connection->executeCommand($command);
  182. }
  183. }
  184. else {
  185. $replies[] = $this->_connection->executeCommand($command);
  186. }
  187. return $replies;
  188. }
  189. public function rawCommand($rawCommandData, $closesConnection = false) {
  190. if (Shared\Utils::isCluster($this->_connection)) {
  191. throw new ClientException('Cannot send raw commands when connected to a cluster of Redis servers');
  192. }
  193. return $this->_connection->rawCommand($rawCommandData, $closesConnection);
  194. }
  195. private function sharedInitializer($argv, $initializer) {
  196. $argc = count($argv);
  197. if ($argc === 0) {
  198. return $this->$initializer();
  199. }
  200. else if ($argc === 1) {
  201. list($arg0) = $argv;
  202. return is_array($arg0) ? $this->$initializer($arg0) : $this->$initializer(null, $arg0);
  203. }
  204. else if ($argc === 2) {
  205. list($arg0, $arg1) = $argv;
  206. return $this->$initializer($arg0, $arg1);
  207. }
  208. return $this->$initializer($this, $arguments);
  209. }
  210. public function pipeline(/* arguments */) {
  211. return $this->sharedInitializer(func_get_args(), 'initPipeline');
  212. }
  213. public function pipelineSafe($pipelineBlock = null) {
  214. return $this->initPipeline(array('safe' => true), $pipelineBlock);
  215. }
  216. private function initPipeline(Array $options = null, $pipelineBlock = null) {
  217. $pipeline = null;
  218. if (isset($options)) {
  219. if (isset($options['safe']) && $options['safe'] == true) {
  220. $connection = $this->getConnection();
  221. $pipeline = new CommandPipeline($this, $connection instanceof Connection
  222. ? new Pipeline\SafeExecutor($connection)
  223. : new Pipeline\SafeClusterExecutor($connection)
  224. );
  225. }
  226. else {
  227. $pipeline = new CommandPipeline($this);
  228. }
  229. }
  230. else {
  231. $pipeline = new CommandPipeline($this);
  232. }
  233. return $this->pipelineExecute($pipeline, $pipelineBlock);
  234. }
  235. private function pipelineExecute(CommandPipeline $pipeline, $block) {
  236. return $block !== null ? $pipeline->execute($block) : $pipeline;
  237. }
  238. public function multiExec(/* arguments */) {
  239. return $this->sharedInitializer(func_get_args(), 'initMultiExec');
  240. }
  241. private function initMultiExec(Array $options = null, $transBlock = null) {
  242. $multi = isset($options) ? new MultiExecBlock($this, $options) : new MultiExecBlock($this);
  243. return $transBlock !== null ? $multi->execute($transBlock) : $multi;
  244. }
  245. public function pubSubContext() {
  246. return new PubSubContext($this);
  247. }
  248. }
  249. /* ------------------------------------------------------------------------- */
  250. interface IClientOptionsHandler {
  251. public function validate($option, $value);
  252. public function getDefault();
  253. }
  254. class ClientOptionsProfile implements IClientOptionsHandler {
  255. public function validate($option, $value) {
  256. if ($value instanceof \Predis\RedisServerProfile) {
  257. return $value;
  258. }
  259. if (is_string($value)) {
  260. return \Predis\RedisServerProfile::get($value);
  261. }
  262. throw new \InvalidArgumentException("Invalid value for option $option");
  263. }
  264. public function getDefault() {
  265. return \Predis\RedisServerProfile::getDefault();
  266. }
  267. }
  268. class ClientOptionsKeyDistribution implements IClientOptionsHandler {
  269. public function validate($option, $value) {
  270. if ($value instanceof \Predis\Distribution\IDistributionStrategy) {
  271. return $value;
  272. }
  273. if (is_string($value)) {
  274. $valueReflection = new \ReflectionClass($value);
  275. if ($valueReflection->isSubclassOf('\Predis\Distribution\IDistributionStrategy')) {
  276. return new $value;
  277. }
  278. }
  279. throw new \InvalidArgumentException("Invalid value for option $option");
  280. }
  281. public function getDefault() {
  282. return new \Predis\Distribution\HashRing();
  283. }
  284. }
  285. class ClientOptionsIterableMultiBulk implements IClientOptionsHandler {
  286. public function validate($option, $value) {
  287. return (bool) $value;
  288. }
  289. public function getDefault() {
  290. return false;
  291. }
  292. }
  293. class ClientOptionsThrowOnError implements IClientOptionsHandler {
  294. public function validate($option, $value) {
  295. return (bool) $value;
  296. }
  297. public function getDefault() {
  298. return true;
  299. }
  300. }
  301. class ClientOptions {
  302. private static $_optionsHandlers;
  303. private $_options;
  304. public function __construct($options = null) {
  305. self::initializeOptionsHandlers();
  306. $this->initializeOptions($options ?: array());
  307. }
  308. private static function initializeOptionsHandlers() {
  309. if (!isset(self::$_optionsHandlers)) {
  310. self::$_optionsHandlers = self::getOptionsHandlers();
  311. }
  312. }
  313. private static function getOptionsHandlers() {
  314. return array(
  315. 'profile' => new \Predis\ClientOptionsProfile(),
  316. 'key_distribution' => new \Predis\ClientOptionsKeyDistribution(),
  317. 'iterable_multibulk' => new \Predis\ClientOptionsIterableMultiBulk(),
  318. 'throw_on_error' => new \Predis\ClientOptionsThrowOnError(),
  319. );
  320. }
  321. private function initializeOptions($options) {
  322. foreach ($options as $option => $value) {
  323. if (isset(self::$_optionsHandlers[$option])) {
  324. $handler = self::$_optionsHandlers[$option];
  325. $this->_options[$option] = $handler->validate($option, $value);
  326. }
  327. }
  328. }
  329. public function __get($option) {
  330. if (!isset($this->_options[$option])) {
  331. $defaultValue = self::$_optionsHandlers[$option]->getDefault();
  332. $this->_options[$option] = $defaultValue;
  333. }
  334. return $this->_options[$option];
  335. }
  336. public function __isset($option) {
  337. return isset(self::$_optionsHandlers[$option]);
  338. }
  339. }
  340. /* ------------------------------------------------------------------------- */
  341. class Protocol {
  342. const NEWLINE = "\r\n";
  343. const OK = 'OK';
  344. const ERROR = 'ERR';
  345. const QUEUED = 'QUEUED';
  346. const NULL = 'nil';
  347. const PREFIX_STATUS = '+';
  348. const PREFIX_ERROR = '-';
  349. const PREFIX_INTEGER = ':';
  350. const PREFIX_BULK = '$';
  351. const PREFIX_MULTI_BULK = '*';
  352. }
  353. abstract class Command {
  354. private $_hash;
  355. private $_arguments = array();
  356. public abstract function getCommandId();
  357. public abstract function serializeRequest($command, $arguments);
  358. public function canBeHashed() {
  359. return true;
  360. }
  361. public function getHash(Distribution\IDistributionStrategy $distributor) {
  362. if (isset($this->_hash)) {
  363. return $this->_hash;
  364. }
  365. else {
  366. if (isset($this->_arguments[0])) {
  367. // TODO: should we throw an exception if the command does
  368. // not support sharding?
  369. $key = $this->_arguments[0];
  370. $start = strpos($key, '{');
  371. $end = strpos($key, '}');
  372. if ($start !== false && $end !== false) {
  373. $key = substr($key, ++$start, $end - $start);
  374. }
  375. $this->_hash = $distributor->generateKey($key);
  376. return $this->_hash;
  377. }
  378. }
  379. return null;
  380. }
  381. public function closesConnection() {
  382. return false;
  383. }
  384. protected function filterArguments(Array $arguments) {
  385. return $arguments;
  386. }
  387. public function setArguments(/* arguments */) {
  388. $this->_arguments = $this->filterArguments(func_get_args());
  389. unset($this->_hash);
  390. }
  391. public function setArgumentsArray(Array $arguments) {
  392. $this->_arguments = $this->filterArguments($arguments);
  393. unset($this->_hash);
  394. }
  395. public function getArguments() {
  396. return $this->_arguments;
  397. }
  398. public function getArgument($index = 0) {
  399. if (isset($this->_arguments[$index]) === true) {
  400. return $this->_arguments[$index];
  401. }
  402. }
  403. public function parseResponse($data) {
  404. return $data;
  405. }
  406. public final function __invoke() {
  407. return $this->serializeRequest($this->getCommandId(), $this->getArguments());
  408. }
  409. }
  410. abstract class InlineCommand extends Command {
  411. public function serializeRequest($command, $arguments) {
  412. if (isset($arguments[0]) && is_array($arguments[0])) {
  413. $arguments[0] = implode($arguments[0], ' ');
  414. }
  415. return $command . (count($arguments) > 0
  416. ? ' ' . implode($arguments, ' ') . Protocol::NEWLINE
  417. : Protocol::NEWLINE
  418. );
  419. }
  420. }
  421. abstract class BulkCommand extends Command {
  422. public function serializeRequest($command, $arguments) {
  423. $data = array_pop($arguments);
  424. if (is_array($data)) {
  425. $data = implode($data, ' ');
  426. }
  427. return $command . ' ' . implode($arguments, ' ') . ' ' . strlen($data) .
  428. Protocol::NEWLINE . $data . Protocol::NEWLINE;
  429. }
  430. }
  431. abstract class MultiBulkCommand extends Command {
  432. public function serializeRequest($command, $arguments) {
  433. $cmd_args = null;
  434. $argsc = count($arguments);
  435. if ($argsc === 1 && is_array($arguments[0])) {
  436. $cmd_args = $arguments[0];
  437. $argsc = count($cmd_args);
  438. }
  439. else {
  440. $cmd_args = $arguments;
  441. }
  442. $newline = Protocol::NEWLINE;
  443. $cmdlen = strlen($command);
  444. $reqlen = $argsc + 1;
  445. $buffer = "*{$reqlen}{$newline}\${$cmdlen}{$newline}{$command}{$newline}";
  446. for ($i = 0; $i < $reqlen - 1; $i++) {
  447. $argument = $cmd_args[$i];
  448. $arglen = strlen($argument);
  449. $buffer .= "\${$arglen}{$newline}{$argument}{$newline}";
  450. }
  451. return $buffer;
  452. }
  453. }
  454. /* ------------------------------------------------------------------------- */
  455. interface IResponseHandler {
  456. function handle(Connection $connection, $payload);
  457. }
  458. class ResponseStatusHandler implements IResponseHandler {
  459. public function handle(Connection $connection, $status) {
  460. if ($status === Protocol::OK) {
  461. return true;
  462. }
  463. if ($status === Protocol::QUEUED) {
  464. return new ResponseQueued();
  465. }
  466. return $status;
  467. }
  468. }
  469. class ResponseErrorHandler implements IResponseHandler {
  470. public function handle(Connection $connection, $errorMessage) {
  471. throw new ServerException(substr($errorMessage, 4));
  472. }
  473. }
  474. class ResponseErrorSilentHandler implements IResponseHandler {
  475. public function handle(Connection $connection, $errorMessage) {
  476. return new ResponseError(substr($errorMessage, 4));
  477. }
  478. }
  479. class ResponseBulkHandler implements IResponseHandler {
  480. public function handle(Connection $connection, $dataLength) {
  481. if (!is_numeric($dataLength)) {
  482. Shared\Utils::onCommunicationException(new MalformedServerResponse(
  483. $connection, "Cannot parse '$dataLength' as data length"
  484. ));
  485. }
  486. $dataLength = (int) $dataLength;
  487. if ($dataLength >= 0) {
  488. $value = $dataLength > 0 ? $connection->readBytes($dataLength) : '';
  489. if ($connection->readBytes(2) !== Protocol::NEWLINE) {
  490. Shared\Utils::onCommunicationException(new MalformedServerResponse(
  491. $connection, 'Did not receive a new-line at the end of a bulk response'
  492. ));
  493. }
  494. return $value;
  495. }
  496. if ($dataLength == -1) {
  497. return null;
  498. }
  499. }
  500. }
  501. class ResponseMultiBulkHandler implements IResponseHandler {
  502. public function handle(Connection $connection, $rawLength) {
  503. if (!is_numeric($rawLength)) {
  504. Shared\Utils::onCommunicationException(new MalformedServerResponse(
  505. $connection, "Cannot parse '$rawLength' as data length"
  506. ));
  507. }
  508. $listLength = (int) $rawLength;
  509. if ($listLength === -1) {
  510. return null;
  511. }
  512. $list = array();
  513. if ($listLength > 0) {
  514. $handlers = array();
  515. $reader = $connection->getResponseReader();
  516. for ($i = 0; $i < $listLength; $i++) {
  517. $header = $connection->readLine();
  518. $prefix = $header[0];
  519. if (isset($handlers[$prefix])) {
  520. $handler = $handlers[$prefix];
  521. }
  522. else {
  523. $handler = $reader->getHandler($prefix);
  524. $handlers[$prefix] = $handler;
  525. }
  526. $list[$i] = $handler->handle($connection, substr($header, 1));
  527. }
  528. }
  529. return $list;
  530. }
  531. }
  532. class ResponseMultiBulkStreamHandler implements IResponseHandler {
  533. public function handle(Connection $connection, $rawLength) {
  534. if (!is_numeric($rawLength)) {
  535. Shared\Utils::onCommunicationException(new MalformedServerResponse(
  536. $connection, "Cannot parse '$rawLength' as data length"
  537. ));
  538. }
  539. return new Shared\MultiBulkResponseIterator($connection, (int)$rawLength);
  540. }
  541. }
  542. class ResponseIntegerHandler implements IResponseHandler {
  543. public function handle(Connection $connection, $number) {
  544. if (is_numeric($number)) {
  545. return (int) $number;
  546. }
  547. else {
  548. if ($number !== Protocol::NULL) {
  549. Shared\Utils::onCommunicationException(new MalformedServerResponse(
  550. $connection, "Cannot parse '$number' as numeric response"
  551. ));
  552. }
  553. return null;
  554. }
  555. }
  556. }
  557. class ResponseReader {
  558. private $_prefixHandlers;
  559. public function __construct() {
  560. $this->initializePrefixHandlers();
  561. }
  562. private function initializePrefixHandlers() {
  563. $this->_prefixHandlers = array(
  564. Protocol::PREFIX_STATUS => new ResponseStatusHandler(),
  565. Protocol::PREFIX_ERROR => new ResponseErrorHandler(),
  566. Protocol::PREFIX_INTEGER => new ResponseIntegerHandler(),
  567. Protocol::PREFIX_BULK => new ResponseBulkHandler(),
  568. Protocol::PREFIX_MULTI_BULK => new ResponseMultiBulkHandler(),
  569. );
  570. }
  571. public function setHandler($prefix, IResponseHandler $handler) {
  572. $this->_prefixHandlers[$prefix] = $handler;
  573. }
  574. public function getHandler($prefix) {
  575. if (isset($this->_prefixHandlers[$prefix])) {
  576. return $this->_prefixHandlers[$prefix];
  577. }
  578. }
  579. public function read(Connection $connection) {
  580. $header = $connection->readLine();
  581. if ($header === '') {
  582. $this->throwMalformedResponse($connection, 'Unexpected empty header');
  583. }
  584. $prefix = $header[0];
  585. if (!isset($this->_prefixHandlers[$prefix])) {
  586. $this->throwMalformedResponse($connection, "Unknown prefix '$prefix'");
  587. }
  588. $handler = $this->_prefixHandlers[$prefix];
  589. return $handler->handle($connection, substr($header, 1));
  590. }
  591. private function throwMalformedResponse(Connection $connection, $message) {
  592. Shared\Utils::onCommunicationException(new MalformedServerResponse(
  593. $connection, $message
  594. ));
  595. }
  596. }
  597. class ResponseError {
  598. private $_message;
  599. public function __construct($message) {
  600. $this->_message = $message;
  601. }
  602. public function __get($property) {
  603. if ($property == 'error') {
  604. return true;
  605. }
  606. if ($property == 'message') {
  607. return $this->_message;
  608. }
  609. }
  610. public function __isset($property) {
  611. return $property === 'error';
  612. }
  613. public function __toString() {
  614. return $this->_message;
  615. }
  616. }
  617. class ResponseQueued {
  618. public $queued = true;
  619. public function __toString() {
  620. return Protocol::QUEUED;
  621. }
  622. }
  623. /* ------------------------------------------------------------------------- */
  624. class CommandPipeline {
  625. private $_redisClient, $_pipelineBuffer, $_returnValues, $_running, $_executor;
  626. public function __construct(Client $redisClient, Pipeline\IPipelineExecutor $executor = null) {
  627. $this->_redisClient = $redisClient;
  628. $this->_executor = $executor ?: new Pipeline\StandardExecutor();
  629. $this->_pipelineBuffer = array();
  630. $this->_returnValues = array();
  631. }
  632. public function __call($method, $arguments) {
  633. $command = $this->_redisClient->createCommand($method, $arguments);
  634. $this->recordCommand($command);
  635. return $this;
  636. }
  637. private function recordCommand(Command $command) {
  638. $this->_pipelineBuffer[] = $command;
  639. }
  640. private function getRecordedCommands() {
  641. return $this->_pipelineBuffer;
  642. }
  643. public function flushPipeline() {
  644. if (count($this->_pipelineBuffer) > 0) {
  645. $connection = $this->_redisClient->getConnection();
  646. $this->_returnValues = array_merge(
  647. $this->_returnValues,
  648. $this->_executor->execute($connection, $this->_pipelineBuffer)
  649. );
  650. $this->_pipelineBuffer = array();
  651. }
  652. return $this;
  653. }
  654. private function setRunning($bool) {
  655. if ($bool == true && $this->_running == true) {
  656. throw new ClientException("This pipeline is already opened");
  657. }
  658. $this->_running = $bool;
  659. }
  660. public function execute($block = null) {
  661. if ($block && !is_callable($block)) {
  662. throw new \InvalidArgumentException('Argument passed must be a callable object');
  663. }
  664. // TODO: do not reuse previously executed pipelines
  665. $this->setRunning(true);
  666. $pipelineBlockException = null;
  667. try {
  668. if ($block !== null) {
  669. $block($this);
  670. }
  671. $this->flushPipeline();
  672. }
  673. catch (\Exception $exception) {
  674. $pipelineBlockException = $exception;
  675. }
  676. $this->setRunning(false);
  677. if ($pipelineBlockException !== null) {
  678. throw $pipelineBlockException;
  679. }
  680. return $this->_returnValues;
  681. }
  682. }
  683. class MultiExecBlock {
  684. private $_initialized, $_discarded, $_insideBlock, $_checkAndSet;
  685. private $_redisClient, $_options, $_commands;
  686. private $_supportsWatch;
  687. public function __construct(Client $redisClient, Array $options = null) {
  688. $this->checkCapabilities($redisClient);
  689. $this->_options = $options ?: array();
  690. $this->_redisClient = $redisClient;
  691. $this->reset();
  692. }
  693. private function checkCapabilities(Client $redisClient) {
  694. if (Shared\Utils::isCluster($redisClient->getConnection())) {
  695. throw new \Predis\ClientException(
  696. 'Cannot initialize a MULTI/EXEC context over a cluster of connections'
  697. );
  698. }
  699. $profile = $redisClient->getProfile();
  700. if ($profile->supportsCommands(array('multi', 'exec', 'discard')) === false) {
  701. throw new \Predis\ClientException(
  702. 'The current profile does not support MULTI, EXEC and DISCARD commands'
  703. );
  704. }
  705. $this->_supportsWatch = $profile->supportsCommands(array('watch', 'unwatch'));
  706. }
  707. private function isWatchSupported() {
  708. if ($this->_supportsWatch === false) {
  709. throw new \Predis\ClientException(
  710. 'The current profile does not support WATCH and UNWATCH commands'
  711. );
  712. }
  713. }
  714. private function reset() {
  715. $this->_initialized = false;
  716. $this->_discarded = false;
  717. $this->_checkAndSet = false;
  718. $this->_insideBlock = false;
  719. $this->_commands = array();
  720. }
  721. private function initialize() {
  722. if ($this->_initialized === true) {
  723. return;
  724. }
  725. $options = &$this->_options;
  726. $this->_checkAndSet = isset($options['cas']) && $options['cas'];
  727. if (isset($options['watch'])) {
  728. $this->watch($options['watch']);
  729. }
  730. if (!$this->_checkAndSet || ($this->_discarded && $this->_checkAndSet)) {
  731. $this->_redisClient->multi();
  732. if ($this->_discarded) {
  733. $this->_checkAndSet = false;
  734. }
  735. }
  736. $this->_initialized = true;
  737. $this->_discarded = false;
  738. }
  739. public function __call($method, $arguments) {
  740. $this->initialize();
  741. $client = $this->_redisClient;
  742. if ($this->_checkAndSet) {
  743. return call_user_func_array(array($client, $method), $arguments);
  744. }
  745. $command = $client->createCommand($method, $arguments);
  746. $response = $client->executeCommand($command);
  747. if (!isset($response->queued)) {
  748. $this->malformedServerResponse(
  749. 'The server did not respond with a QUEUED status reply'
  750. );
  751. }
  752. $this->_commands[] = $command;
  753. return $this;
  754. }
  755. public function watch($keys) {
  756. $this->isWatchSupported();
  757. if ($this->_initialized && !$this->_checkAndSet) {
  758. throw new ClientException('WATCH inside MULTI is not allowed');
  759. }
  760. return $this->_redisClient->watch($keys);
  761. }
  762. public function multi() {
  763. if ($this->_initialized && $this->_checkAndSet) {
  764. $this->_checkAndSet = false;
  765. $this->_redisClient->multi();
  766. return $this;
  767. }
  768. $this->initialize();
  769. return $this;
  770. }
  771. public function unwatch() {
  772. $this->isWatchSupported();
  773. $this->_redisClient->unwatch();
  774. return $this;
  775. }
  776. public function discard() {
  777. $this->_redisClient->discard();
  778. $this->reset();
  779. $this->_discarded = true;
  780. return $this;
  781. }
  782. public function exec() {
  783. return $this->execute();
  784. }
  785. private function checkBeforeExecution($block) {
  786. if ($this->_insideBlock === true) {
  787. throw new \Predis\ClientException(
  788. "Cannot invoke 'execute' or 'exec' inside an active client transaction block"
  789. );
  790. }
  791. if ($block) {
  792. if (!is_callable($block)) {
  793. throw new \InvalidArgumentException(
  794. 'Argument passed must be a callable object'
  795. );
  796. }
  797. if (count($this->_commands) > 0) {
  798. throw new ClientException(
  799. 'Cannot execute a transaction block after using fluent interface'
  800. );
  801. }
  802. }
  803. if (isset($this->_options['retry']) && !isset($block)) {
  804. $this->discard();
  805. throw new \InvalidArgumentException(
  806. 'Automatic retries can be used only when a transaction block is provided'
  807. );
  808. }
  809. }
  810. public function execute($block = null) {
  811. $this->checkBeforeExecution($block);
  812. $reply = null;
  813. $returnValues = array();
  814. $attemptsLeft = isset($this->_options['retry']) ? (int)$this->_options['retry'] : 0;
  815. do {
  816. $blockException = null;
  817. if ($block !== null) {
  818. $this->_insideBlock = true;
  819. try {
  820. $block($this);
  821. }
  822. catch (CommunicationException $exception) {
  823. $blockException = $exception;
  824. }
  825. catch (ServerException $exception) {
  826. $blockException = $exception;
  827. }
  828. catch (\Exception $exception) {
  829. $blockException = $exception;
  830. if ($this->_initialized === true) {
  831. $this->discard();
  832. }
  833. }
  834. $this->_insideBlock = false;
  835. if ($blockException !== null) {
  836. throw $blockException;
  837. }
  838. }
  839. if ($this->_initialized === false || count($this->_commands) == 0) {
  840. return;
  841. }
  842. $reply = $this->_redisClient->exec();
  843. if ($reply === null) {
  844. if ($attemptsLeft === 0) {
  845. throw new AbortedMultiExec(
  846. 'The current transaction has been aborted by the server'
  847. );
  848. }
  849. $this->reset();
  850. continue;
  851. }
  852. break;
  853. } while ($attemptsLeft-- > 0);
  854. $execReply = $reply instanceof \Iterator ? iterator_to_array($reply) : $reply;
  855. $sizeofReplies = count($execReply);
  856. $commands = &$this->_commands;
  857. if ($sizeofReplies !== count($commands)) {
  858. $this->malformedServerResponse(
  859. 'Unexpected number of responses for a MultiExecBlock'
  860. );
  861. }
  862. for ($i = 0; $i < $sizeofReplies; $i++) {
  863. $returnValues[] = $commands[$i]->parseResponse($execReply[$i] instanceof \Iterator
  864. ? iterator_to_array($execReply[$i])
  865. : $execReply[$i]
  866. );
  867. unset($commands[$i]);
  868. }
  869. return $returnValues;
  870. }
  871. private function malformedServerResponse($message) {
  872. // Since a MULTI/EXEC block cannot be initialized over a clustered
  873. // connection, we can safely assume that Predis\Client::getConnection()
  874. // will always return an instance of Predis\Connection.
  875. Utils::onCommunicationException(new MalformedServerResponse(
  876. $this->_redisClient->getConnection(), $message
  877. ));
  878. }
  879. }
  880. class PubSubContext implements \Iterator {
  881. const SUBSCRIBE = 'subscribe';
  882. const UNSUBSCRIBE = 'unsubscribe';
  883. const PSUBSCRIBE = 'psubscribe';
  884. const PUNSUBSCRIBE = 'punsubscribe';
  885. const MESSAGE = 'message';
  886. const PMESSAGE = 'pmessage';
  887. const STATUS_VALID = 0x0001;
  888. const STATUS_SUBSCRIBED = 0x0010;
  889. const STATUS_PSUBSCRIBED = 0x0100;
  890. private $_redisClient, $_subscriptions, $_isStillValid, $_position;
  891. public function __construct(Client $redisClient) {
  892. $this->checkCapabilities($redisClient);
  893. $this->_redisClient = $redisClient;
  894. $this->_statusFlags = self::STATUS_VALID;
  895. }
  896. public function __destruct() {
  897. $this->closeContext();
  898. }
  899. private function checkCapabilities(Client $redisClient) {
  900. if (Shared\Utils::isCluster($redisClient->getConnection())) {
  901. throw new \Predis\ClientException(
  902. 'Cannot initialize a PUB/SUB context over a cluster of connections'
  903. );
  904. }
  905. $profile = $redisClient->getProfile();
  906. $commands = array('publish', 'subscribe', 'unsubscribe', 'psubscribe', 'punsubscribe');
  907. if ($profile->supportsCommands($commands) === false) {
  908. throw new \Predis\ClientException(
  909. 'The current profile does not support PUB/SUB related commands'
  910. );
  911. }
  912. }
  913. private function isFlagSet($value) {
  914. return ($this->_statusFlags & $value) === $value;
  915. }
  916. public function subscribe(/* arguments */) {
  917. $this->writeCommand(self::SUBSCRIBE, func_get_args());
  918. $this->_statusFlags |= self::STATUS_SUBSCRIBED;
  919. }
  920. public function unsubscribe(/* arguments */) {
  921. $this->writeCommand(self::UNSUBSCRIBE, func_get_args());
  922. }
  923. public function psubscribe(/* arguments */) {
  924. $this->writeCommand(self::PSUBSCRIBE, func_get_args());
  925. $this->_statusFlags |= self::STATUS_PSUBSCRIBED;
  926. }
  927. public function punsubscribe(/* arguments */) {
  928. $this->writeCommand(self::PUNSUBSCRIBE, func_get_args());
  929. }
  930. public function closeContext() {
  931. if ($this->valid()) {
  932. if ($this->isFlagSet(self::STATUS_SUBSCRIBED)) {
  933. $this->unsubscribe();
  934. }
  935. if ($this->isFlagSet(self::STATUS_PSUBSCRIBED)) {
  936. $this->punsubscribe();
  937. }
  938. }
  939. }
  940. private function writeCommand($method, $arguments) {
  941. if (count($arguments) === 1 && is_array($arguments[0])) {
  942. $arguments = $arguments[0];
  943. }
  944. $command = $this->_redisClient->createCommand($method, $arguments);
  945. $this->_redisClient->getConnection()->writeCommand($command);
  946. }
  947. public function rewind() {
  948. // NOOP
  949. }
  950. public function current() {
  951. return $this->getValue();
  952. }
  953. public function key() {
  954. return $this->_position;
  955. }
  956. public function next() {
  957. if ($this->isFlagSet(self::STATUS_VALID)) {
  958. $this->_position++;
  959. }
  960. return $this->_position;
  961. }
  962. public function valid() {
  963. $subscriptions = self::STATUS_SUBSCRIBED + self::STATUS_PSUBSCRIBED;
  964. return $this->isFlagSet(self::STATUS_VALID)
  965. && ($this->_statusFlags & $subscriptions) > 0;
  966. }
  967. private function invalidate() {
  968. $this->_statusFlags = 0x0000;
  969. }
  970. private function getValue() {
  971. $reader = $this->_redisClient->getResponseReader();
  972. $connection = $this->_redisClient->getConnection();
  973. $response = $reader->read($connection);
  974. switch ($response[0]) {
  975. case self::SUBSCRIBE:
  976. case self::UNSUBSCRIBE:
  977. case self::PSUBSCRIBE:
  978. case self::PUNSUBSCRIBE:
  979. if ($response[2] === 0) {
  980. $this->invalidate();
  981. }
  982. case self::MESSAGE:
  983. return (object) array(
  984. 'kind' => $response[0],
  985. 'channel' => $response[1],
  986. 'payload' => $response[2],
  987. );
  988. case self::PMESSAGE:
  989. return (object) array(
  990. 'kind' => $response[0],
  991. 'pattern' => $response[1],
  992. 'channel' => $response[2],
  993. 'payload' => $response[3],
  994. );
  995. default:
  996. throw new \Predis\ClientException(
  997. "Received an unknown message type {$response[0]} inside of a pubsub context"
  998. );
  999. }
  1000. }
  1001. }
  1002. /* ------------------------------------------------------------------------- */
  1003. class ConnectionParameters {
  1004. const DEFAULT_HOST = '127.0.0.1';
  1005. const DEFAULT_PORT = 6379;
  1006. const DEFAULT_TIMEOUT = 5;
  1007. private $_parameters;
  1008. public function __construct($parameters = null) {
  1009. $parameters = $parameters ?: array();
  1010. $this->_parameters = is_array($parameters)
  1011. ? self::filterConnectionParams($parameters)
  1012. : self::parseURI($parameters);
  1013. }
  1014. private static function parseURI($uri) {
  1015. $parsed = @parse_url($uri);
  1016. if ($parsed == false || $parsed['scheme'] != 'redis' || $parsed['host'] == null) {
  1017. throw new ClientException("Invalid URI: $uri");
  1018. }
  1019. if (array_key_exists('query', $parsed)) {
  1020. $details = array();
  1021. foreach (explode('&', $parsed['query']) as $kv) {
  1022. list($k, $v) = explode('=', $kv);
  1023. switch ($k) {
  1024. case 'database':
  1025. $details['database'] = $v;
  1026. break;
  1027. case 'password':
  1028. $details['password'] = $v;
  1029. break;
  1030. case 'connection_async':
  1031. $details['connection_async'] = $v;
  1032. break;
  1033. case 'connection_persistent':
  1034. $details['connection_persistent'] = $v;
  1035. break;
  1036. case 'connection_timeout':
  1037. $details['connection_timeout'] = $v;
  1038. break;
  1039. case 'read_write_timeout':
  1040. $details['read_write_timeout'] = $v;
  1041. break;
  1042. case 'alias':
  1043. $details['alias'] = $v;
  1044. break;
  1045. case 'weight':
  1046. $details['weight'] = $v;
  1047. break;
  1048. }
  1049. }
  1050. $parsed = array_merge($parsed, $details);
  1051. }
  1052. return self::filterConnectionParams($parsed);
  1053. }
  1054. private static function getParamOrDefault(Array $parameters, $param, $default = null) {
  1055. return array_key_exists($param, $parameters) ? $parameters[$param] : $default;
  1056. }
  1057. private static function filterConnectionParams($parameters) {
  1058. return array(
  1059. 'host' => self::getParamOrDefault($parameters, 'host', self::DEFAULT_HOST),
  1060. 'port' => (int) self::getParamOrDefault($parameters, 'port', self::DEFAULT_PORT),
  1061. 'database' => self::getParamOrDefault($parameters, 'database'),
  1062. 'password' => self::getParamOrDefault($parameters, 'password'),
  1063. 'connection_async' => self::getParamOrDefault($parameters, 'connection_async', false),
  1064. 'connection_persistent' => self::getParamOrDefault($parameters, 'connection_persistent', false),
  1065. 'connection_timeout' => self::getParamOrDefault($parameters, 'connection_timeout', self::DEFAULT_TIMEOUT),
  1066. 'read_write_timeout' => self::getParamOrDefault($parameters, 'read_write_timeout'),
  1067. 'alias' => self::getParamOrDefault($parameters, 'alias'),
  1068. 'weight' => self::getParamOrDefault($parameters, 'weight'),
  1069. );
  1070. }
  1071. public function __get($parameter) {
  1072. return $this->_parameters[$parameter];
  1073. }
  1074. public function __isset($parameter) {
  1075. return isset($this->_parameters[$parameter]);
  1076. }
  1077. }
  1078. interface IConnection {
  1079. public function connect();
  1080. public function disconnect();
  1081. public function isConnected();
  1082. public function writeCommand(Command $command);
  1083. public function readResponse(Command $command);
  1084. public function executeCommand(Command $command);
  1085. }
  1086. class Connection implements IConnection {
  1087. private $_params, $_socket, $_initCmds, $_reader;
  1088. public function __construct(ConnectionParameters $parameters, ResponseReader $reader = null) {
  1089. $this->_params = $parameters;
  1090. $this->_initCmds = array();
  1091. $this->_reader = $reader ?: new ResponseReader();
  1092. }
  1093. public function __destruct() {
  1094. if (!$this->_params->connection_persistent) {
  1095. $this->disconnect();
  1096. }
  1097. }
  1098. public function isConnected() {
  1099. return is_resource($this->_socket);
  1100. }
  1101. public function connect() {
  1102. if ($this->isConnected()) {
  1103. throw new ClientException('Connection already estabilished');
  1104. }
  1105. $uri = sprintf('tcp://%s:%d/', $this->_params->host, $this->_params->port);
  1106. $connectFlags = STREAM_CLIENT_CONNECT;
  1107. if ($this->_params->connection_async) {
  1108. $connectFlags |= STREAM_CLIENT_ASYNC_CONNECT;
  1109. }
  1110. if ($this->_params->connection_persistent) {
  1111. $connectFlags |= STREAM_CLIENT_PERSISTENT;
  1112. }
  1113. $this->_socket = @stream_socket_client(
  1114. $uri, $errno, $errstr, $this->_params->connection_timeout, $connectFlags
  1115. );
  1116. if (!$this->_socket) {
  1117. $this->onCommunicationException(trim($errstr), $errno);
  1118. }
  1119. if (isset($this->_params->read_write_timeout)) {
  1120. $timeoutSeconds = floor($this->_params->read_write_timeout);
  1121. $timeoutUSeconds = ($this->_params->read_write_timeout - $timeoutSeconds) * 1000000;
  1122. stream_set_timeout($this->_socket, $timeoutSeconds, $timeoutUSeconds);
  1123. }
  1124. if (count($this->_initCmds) > 0){
  1125. $this->sendInitializationCommands();
  1126. }
  1127. }
  1128. public function disconnect() {
  1129. if ($this->isConnected()) {
  1130. fclose($this->_socket);
  1131. }
  1132. }
  1133. public function pushInitCommand(Command $command){
  1134. $this->_initCmds[] = $command;
  1135. }
  1136. private function sendInitializationCommands() {
  1137. foreach ($this->_initCmds as $command) {
  1138. $this->writeCommand($command);
  1139. }
  1140. foreach ($this->_initCmds as $command) {
  1141. $this->readResponse($command);
  1142. }
  1143. }
  1144. private function onCommunicationException($message, $code = null) {
  1145. Shared\Utils::onCommunicationException(
  1146. new CommunicationException($this, $message, $code)
  1147. );
  1148. }
  1149. public function writeCommand(Command $command) {
  1150. $this->writeBytes($command());
  1151. }
  1152. public function readResponse(Command $command) {
  1153. $response = $this->_reader->read($this);
  1154. $skipparse = isset($response->queued) || isset($response->error);
  1155. return $skipparse ? $response : $command->parseResponse($response);
  1156. }
  1157. public function executeCommand(Command $command) {
  1158. $this->writeCommand($command);
  1159. if ($command->closesConnection()) {
  1160. return $this->disconnect();
  1161. }
  1162. return $this->readResponse($command);
  1163. }
  1164. public function rawCommand($rawCommandData, $closesConnection = false) {
  1165. $this->writeBytes($rawCommandData);
  1166. if ($closesConnection) {
  1167. $this->disconnect();
  1168. return;
  1169. }
  1170. return $this->_reader->read($this);
  1171. }
  1172. public function writeBytes($value) {
  1173. $socket = $this->getSocket();
  1174. while (($length = strlen($value)) > 0) {
  1175. $written = fwrite($socket, $value);
  1176. if ($length === $written) {
  1177. return true;
  1178. }
  1179. if ($written === false || $written === 0) {
  1180. $this->onCommunicationException('Error while writing bytes to the server');
  1181. }
  1182. $value = substr($value, $written);
  1183. }
  1184. return true;
  1185. }
  1186. public function readBytes($length) {
  1187. if ($length <= 0) {
  1188. throw new \InvalidArgumentException('Length parameter must be greater than 0');
  1189. }
  1190. $socket = $this->getSocket();
  1191. $value = '';
  1192. do {
  1193. $chunk = fread($socket, $length);
  1194. if ($chunk === false || $chunk === '') {
  1195. $this->onCommunicationException('Error while reading bytes from the server');
  1196. }
  1197. $value .= $chunk;
  1198. }
  1199. while (($length -= strlen($chunk)) > 0);
  1200. return $value;
  1201. }
  1202. public function readLine() {
  1203. $socket = $this->getSocket();
  1204. $value = '';
  1205. do {
  1206. $chunk = fgets($socket);
  1207. if ($chunk === false || strlen($chunk) == 0) {
  1208. $this->onCommunicationException('Error while reading line from the server');
  1209. }
  1210. $value .= $chunk;
  1211. }
  1212. while (substr($value, -2) !== Protocol::NEWLINE);
  1213. return substr($value, 0, -2);
  1214. }
  1215. public function getSocket() {
  1216. if (!$this->isConnected()) {
  1217. $this->connect();
  1218. }
  1219. return $this->_socket;
  1220. }
  1221. public function getResponseReader() {
  1222. return $this->_reader;
  1223. }
  1224. public function getParameters() {
  1225. return $this->_params;
  1226. }
  1227. public function __toString() {
  1228. return sprintf('%s:%d', $this->_params->host, $this->_params->port);
  1229. }
  1230. }
  1231. class ConnectionCluster implements IConnection, \IteratorAggregate {
  1232. private $_pool, $_distributor;
  1233. public function __construct(Distribution\IDistributionStrategy $distributor = null) {
  1234. $this->_pool = array();
  1235. $this->_distributor = $distributor ?: new Distribution\HashRing();
  1236. }
  1237. public function isConnected() {
  1238. foreach ($this->_pool as $connection) {
  1239. if ($connection->isConnected()) {
  1240. return true;
  1241. }
  1242. }
  1243. return false;
  1244. }
  1245. public function connect() {
  1246. foreach ($this->_pool as $connection) {
  1247. $connection->connect();
  1248. }
  1249. }
  1250. public function disconnect() {
  1251. foreach ($this->_pool as $connection) {
  1252. $connection->disconnect();
  1253. }
  1254. }
  1255. public function add(Connection $connection) {
  1256. $parameters = $connection->getParameters();
  1257. if (isset($parameters->alias)) {
  1258. $this->_pool[$parameters->alias] = $connection;
  1259. }
  1260. else {
  1261. $this->_pool[] = $connection;
  1262. }
  1263. $this->_distributor->add($connection, $parameters->weight);
  1264. }
  1265. public function getConnection(Command $command) {
  1266. if ($command->canBeHashed() === false) {
  1267. throw new ClientException(
  1268. sprintf("Cannot send '%s' commands to a cluster of connections", $command->getCommandId())
  1269. );
  1270. }
  1271. return $this->_distributor->get($command->getHash($this->_distributor));
  1272. }
  1273. public function getConnectionById($id = null) {
  1274. $alias = $id ?: 0;
  1275. return isset($this->_pool[$alias]) ? $this->_pool[$alias] : null;
  1276. }
  1277. public function getIterator() {
  1278. return new \ArrayIterator($this->_pool);
  1279. }
  1280. public function writeCommand(Command $command) {
  1281. $this->getConnection($command)->writeCommand($command);
  1282. }
  1283. public function readResponse(Command $command) {
  1284. return $this->getConnection($command)->readResponse($command);
  1285. }
  1286. public function executeCommand(Command $command) {
  1287. $connection = $this->getConnection($command);
  1288. $connection->writeCommand($command);
  1289. return $connection->readResponse($command);
  1290. }
  1291. }
  1292. /* ------------------------------------------------------------------------- */
  1293. abstract class RedisServerProfile {
  1294. private static $_serverProfiles;
  1295. private $_registeredCommands;
  1296. public function __construct() {
  1297. $this->_registeredCommands = $this->getSupportedCommands();
  1298. }
  1299. public abstract function getVersion();
  1300. protected abstract function getSupportedCommands();
  1301. public static function getDefault() {
  1302. return self::get('default');
  1303. }
  1304. public static function getDevelopment() {
  1305. return self::get('dev');
  1306. }
  1307. private static function predisServerProfiles() {
  1308. return array(
  1309. '1.2' => '\Predis\RedisServer_v1_2',
  1310. '2.0' => '\Predis\RedisServer_v2_0',
  1311. 'default' => '\Predis\RedisServer_v2_0',
  1312. 'dev' => '\Predis\RedisServer_vNext',
  1313. );
  1314. }
  1315. public static function registerProfile($profileClass, $aliases) {
  1316. if (!isset(self::$_serverProfiles)) {
  1317. self::$_serverProfiles = self::predisServerProfiles();
  1318. }
  1319. $profileReflection = new \ReflectionClass($profileClass);
  1320. if (!$profileReflection->isSubclassOf('\Predis\RedisServerProfile')) {
  1321. throw new ClientException("Cannot register '$profileClass' as it is not a valid profile class");
  1322. }
  1323. if (is_array($aliases)) {
  1324. foreach ($aliases as $alias) {
  1325. self::$_serverProfiles[$alias] = $profileClass;
  1326. }
  1327. }
  1328. else {
  1329. self::$_serverProfiles[$aliases] = $profileClass;
  1330. }
  1331. }
  1332. public static function get($version) {
  1333. if (!isset(self::$_serverProfiles)) {
  1334. self::$_serverProfiles = self::predisServerProfiles();
  1335. }
  1336. if (!isset(self::$_serverProfiles[$version])) {
  1337. throw new ClientException("Unknown server profile: $version");
  1338. }
  1339. $profile = self::$_serverProfiles[$version];
  1340. return new $profile();
  1341. }
  1342. public function supportsCommands(Array $commands) {
  1343. foreach ($commands as $command) {
  1344. if ($this->supportsCommand($command) === false) {
  1345. return false;
  1346. }
  1347. }
  1348. return true;
  1349. }
  1350. public function supportsCommand($command) {
  1351. return isset($this->_registeredCommands[$command]);
  1352. }
  1353. public function createCommand($method, $arguments = array()) {
  1354. if (!isset($this->_registeredCommands[$method])) {
  1355. throw new ClientException("'$method' is not a registered Redis command");
  1356. }
  1357. $commandClass = $this->_registeredCommands[$method];
  1358. $command = new $commandClass();
  1359. $command->setArgumentsArray($arguments);
  1360. return $command;
  1361. }
  1362. public function registerCommands(Array $commands) {
  1363. foreach ($commands as $command => $aliases) {
  1364. $this->registerCommand($command, $aliases);
  1365. }
  1366. }
  1367. public function registerCommand($command, $aliases) {
  1368. $commandReflection = new \ReflectionClass($command);
  1369. if (!$commandReflection->isSubclassOf('\Predis\Command')) {
  1370. throw new ClientException("Cannot register '$command' as it is not a valid Redis command");
  1371. }
  1372. if (is_array($aliases)) {
  1373. foreach ($aliases as $alias) {
  1374. $this->_registeredCommands[$alias] = $command;
  1375. }
  1376. }
  1377. else {
  1378. $this->_registeredCommands[$aliases] = $command;
  1379. }
  1380. }
  1381. public function __toString() {
  1382. return $this->getVersion();
  1383. }
  1384. }
  1385. class RedisServer_v1_2 extends RedisServerProfile {
  1386. public function getVersion() { return '1.2'; }
  1387. public function getSupportedCommands() {
  1388. return array(
  1389. /* miscellaneous commands */
  1390. 'ping' => '\Predis\Commands\Ping',
  1391. 'echo' => '\Predis\Commands\DoEcho',
  1392. 'auth' => '\Predis\Commands\Auth',
  1393. /* connection handling */
  1394. 'quit' => '\Predis\Commands\Quit',
  1395. /* commands operating on string values */
  1396. 'set' => '\Predis\Commands\Set',
  1397. 'setnx' => '\Predis\Commands\SetPreserve',
  1398. 'setPreserve' => '\Predis\Commands\SetPreserve',
  1399. 'mset' => '\Predis\Commands\SetMultiple',
  1400. 'setMultiple' => '\Predis\Commands\SetMultiple',
  1401. 'msetnx' => '\Predis\Commands\SetMultiplePreserve',
  1402. 'setMultiplePreserve' => '\Predis\Commands\SetMultiplePreserve',
  1403. 'get' => '\Predis\Commands\Get',
  1404. 'mget' => '\Predis\Commands\GetMultiple',
  1405. 'getMultiple' => '\Predis\Commands\GetMultiple',
  1406. 'getset' => '\Predis\Commands\GetSet',
  1407. 'getSet' => '\Predis\Commands\GetSet',
  1408. 'incr' => '\Predis\Commands\Increment',
  1409. 'increment' => '\Predis\Commands\Increment',
  1410. 'incrby' => '\Predis\Commands\IncrementBy',
  1411. 'incrementBy' => '\Predis\Commands\IncrementBy',
  1412. 'decr' => '\Predis\Commands\Decrement',
  1413. 'decrement' => '\Predis\Commands\Decrement',
  1414. 'decrby' => '\Predis\Commands\DecrementBy',
  1415. 'decrementBy' => '\Predis\Commands\DecrementBy',
  1416. 'exists' => '\Predis\Commands\Exists',
  1417. 'del' => '\Predis\Commands\Delete',
  1418. 'delete' => '\Predis\Commands\Delete',
  1419. 'type' => '\Predis\Commands\Type',
  1420. /* commands operating on the key space */
  1421. 'keys' => '\Predis\Commands\Keys',
  1422. 'randomkey' => '\Predis\Commands\RandomKey',
  1423. 'randomKey' => '\Predis\Commands\RandomKey',
  1424. 'rename' => '\Predis\Commands\Rename',
  1425. 'renamenx' => '\Predis\Commands\RenamePreserve',
  1426. 'renamePreserve' => '\Predis\Commands\RenamePreserve',
  1427. 'expire' => '\Predis\Commands\Expire',
  1428. 'expireat' => '\Predis\Commands\ExpireAt',
  1429. 'expireAt' => '\Predis\Commands\ExpireAt',
  1430. 'dbsize' => '\Predis\Commands\DatabaseSize',
  1431. 'databaseSize' => '\Predis\Commands\DatabaseSize',
  1432. 'ttl' => '\Predis\Commands\TimeToLive',
  1433. 'timeToLive' => '\Predis\Commands\TimeToLive',
  1434. /* commands operating on lists */
  1435. 'rpush' => '\Predis\Commands\ListPushTail',
  1436. 'pushTail' => '\Predis\Commands\ListPushTail',
  1437. 'lpush' => '\Predis\Commands\ListPushHead',
  1438. 'pushHead' => '\Predis\Commands\ListPushHead',
  1439. 'llen' => '\Predis\Commands\ListLength',
  1440. 'listLength' => '\Predis\Commands\ListLength',
  1441. 'lrange' => '\Predis\Commands\ListRange',
  1442. 'listRange' => '\Predis\Commands\ListRange',
  1443. 'ltrim' => '\Predis\Commands\ListTrim',
  1444. 'listTrim' => '\Predis\Commands\ListTrim',
  1445. 'lindex' => '\Predis\Commands\ListIndex',
  1446. 'listIndex' => '\Predis\Commands\ListIndex',
  1447. 'lset' => '\Predis\Commands\ListSet',
  1448. 'listSet' => '\Predis\Commands\ListSet',
  1449. 'lrem' => '\Predis\Commands\ListRemove',
  1450. 'listRemove' => '\Predis\Commands\ListRemove',
  1451. 'lpop' => '\Predis\Commands\ListPopFirst',
  1452. 'popFirst' => '\Predis\Commands\ListPopFirst',
  1453. 'rpop' => '\Predis\Commands\ListPopLast',
  1454. 'popLast' => '\Predis\Commands\ListPopLast',
  1455. 'rpoplpush' => '\Predis\Commands\ListPopLastPushHead',
  1456. 'listPopLastPushHead' => '\Predis\Commands\ListPopLastPushHead',
  1457. /* commands operating on sets */
  1458. 'sadd' => '\Predis\Commands\SetAdd',
  1459. 'setAdd' => '\Predis\Commands\SetAdd',
  1460. 'srem' => '\Predis\Commands\SetRemove',
  1461. 'setRemove' => '\Predis\Commands\SetRemove',
  1462. 'spop' => '\Predis\Commands\SetPop',
  1463. 'setPop' => '\Predis\Commands\SetPop',
  1464. 'smove' => '\Predis\Commands\SetMove',
  1465. 'setMove' => '\Predis\Commands\SetMove',
  1466. 'scard' => '\Predis\Commands\SetCardinality',
  1467. 'setCardinality' => '\Predis\Commands\SetCardinality',
  1468. 'sismember' => '\Predis\Commands\SetIsMember',
  1469. 'setIsMember' => '\Predis\Commands\SetIsMember',
  1470. 'sinter' => '\Predis\Commands\SetIntersection',
  1471. 'setIntersection' => '\Predis\Commands\SetIntersection',
  1472. 'sinterstore' => '\Predis\Commands\SetIntersectionStore',
  1473. 'setIntersectionStore' => '\Predis\Commands\SetIntersectionStore',
  1474. 'sunion' => '\Predis\Commands\SetUnion',
  1475. 'setUnion' => '\Predis\Commands\SetUnion',
  1476. 'sunionstore' => '\Predis\Commands\SetUnionStore',
  1477. 'setUnionStore' => '\Predis\Commands\SetUnionStore',
  1478. 'sdiff' => '\Predis\Commands\SetDifference',
  1479. 'setDifference' => '\Predis\Commands\SetDifference',
  1480. 'sdiffstore' => '\Predis\Commands\SetDifferenceStore',
  1481. 'setDifferenceStore' => '\Predis\Commands\SetDifferenceStore',
  1482. 'smembers' => '\Predis\Commands\SetMembers',
  1483. 'setMembers' => '\Predis\Commands\SetMembers',
  1484. 'srandmember' => '\Predis\Commands\SetRandomMember',
  1485. 'setRandomMember' => '\Predis\Commands\SetRandomMember',
  1486. /* commands operating on sorted sets */
  1487. 'zadd' => '\Predis\Commands\ZSetAdd',
  1488. 'zsetAdd' => '\Predis\Commands\ZSetAdd',
  1489. 'zincrby' => '\Predis\Commands\ZSetIncrementBy',
  1490. 'zsetIncrementBy' => '\Predis\Commands\ZSetIncrementBy',
  1491. 'zrem' => '\Predis\Commands\ZSetRemove',
  1492. 'zsetRemove' => '\Predis\Commands\ZSetRemove',
  1493. 'zrange' => '\Predis\Commands\ZSetRange',
  1494. 'zsetRange' => '\Predis\Commands\ZSetRange',
  1495. 'zrevrange' => '\Predis\Commands\ZSetReverseRange',
  1496. 'zsetReverseRange' => '\Predis\Commands\ZSetReverseRange',
  1497. 'zrangebyscore' => '\Predis\Commands\ZSetRangeByScore',
  1498. 'zsetRangeByScore' => '\Predis\Commands\ZSetRangeByScore',
  1499. 'zcard' => '\Predis\Commands\ZSetCardinality',
  1500. 'zsetCardinality' => '\Predis\Commands\ZSetCardinality',
  1501. 'zscore' => '\Predis\Commands\ZSetScore',
  1502. 'zsetScore' => '\Predis\Commands\ZSetScore',
  1503. 'zremrangebyscore' => '\Predis\Commands\ZSetRemoveRangeByScore',
  1504. 'zsetRemoveRangeByScore' => '\Predis\Commands\ZSetRemoveRangeByScore',
  1505. /* multiple databases handling commands */
  1506. 'select' => '\Predis\Commands\SelectDatabase',
  1507. 'selectDatabase' => '\Predis\Commands\SelectDatabase',
  1508. 'move' => '\Predis\Commands\MoveKey',
  1509. 'moveKey' => '\Predis\Commands\MoveKey',
  1510. 'flushdb' => '\Predis\Commands\FlushDatabase',
  1511. 'flushDatabase' => '\Predis\Commands\FlushDatabase',
  1512. 'flushall' => '\Predis\Commands\FlushAll',
  1513. 'flushDatabases' => '\Predis\Commands\FlushAll',
  1514. /* sorting */
  1515. 'sort' => '\Predis\Commands\Sort',
  1516. /* remote server control commands */
  1517. 'info' => '\Predis\Commands\Info',
  1518. 'slaveof' => '\Predis\Commands\SlaveOf',
  1519. 'slaveOf' => '\Predis\Commands\SlaveOf',
  1520. /* persistence control commands */
  1521. 'save' => '\Predis\Commands\Save',
  1522. 'bgsave' => '\Predis\Commands\BackgroundSave',
  1523. 'backgroundSave' => '\Predis\Commands\BackgroundSave',
  1524. 'lastsave' => '\Predis\Commands\LastSave',
  1525. 'lastSave' => '\Predis\Commands\LastSave',
  1526. 'shutdown' => '\Predis\Commands\Shutdown',
  1527. 'bgrewriteaof' => '\Predis\Commands\BackgroundRewriteAppendOnlyFile',
  1528. 'backgroundRewriteAppendOnlyFile' => '\Predis\Commands\BackgroundRewriteAppendOnlyFile',
  1529. );
  1530. }
  1531. }
  1532. class RedisServer_v2_0 extends RedisServer_v1_2 {
  1533. public function getVersion() { return '2.0'; }
  1534. public function getSupportedCommands() {
  1535. return array_merge(parent::getSupportedCommands(), array(
  1536. /* transactions */
  1537. 'multi' => '\Predis\Commands\Multi',
  1538. 'exec' => '\Predis\Commands\Exec',
  1539. 'discard' => '\Predis\Commands\Discard',
  1540. /* commands operating on string values */
  1541. 'setex' => '\Predis\Commands\SetExpire',
  1542. 'setExpire' => '\Predis\Commands\SetExpire',
  1543. 'append' => '\Predis\Commands\Append',
  1544. 'substr' => '\Predis\Commands\Substr',
  1545. /* commands operating on lists */
  1546. 'blpop' => '\Predis\Commands\ListPopFirstBlocking',
  1547. 'popFirstBlocking' => '\Predis\Commands\ListPopFirstBlocking',
  1548. 'brpop' => '\Predis\Commands\ListPopLastBlocking',
  1549. 'popLastBlocking' => '\Predis\Commands\ListPopLastBlocking',
  1550. /* commands operating on sorted sets */
  1551. 'zunionstore' => '\Predis\Commands\ZSetUnionStore',
  1552. 'zsetUnionStore' => '\Predis\Commands\ZSetUnionStore',
  1553. 'zinterstore' => '\Predis\Commands\ZSetIntersectionStore',
  1554. 'zsetIntersectionStore' => '\Predis\Commands\ZSetIntersectionStore',
  1555. 'zcount' => '\Predis\Commands\ZSetCount',
  1556. 'zsetCount' => '\Predis\Commands\ZSetCount',
  1557. 'zrank' => '\Predis\Commands\ZSetRank',
  1558. 'zsetRank' => '\Predis\Commands\ZSetRank',
  1559. 'zrevrank' => '\Predis\Commands\ZSetReverseRank',
  1560. 'zsetReverseRank' => '\Predis\Commands\ZSetReverseRank',
  1561. 'zremrangebyrank' => '\Predis\Commands\ZSetRemoveRangeByRank',
  1562. 'zsetRemoveRangeByRank' => '\Predis\Commands\ZSetRemoveRangeByRank',
  1563. /* commands operating on hashes */
  1564. 'hset' => '\Predis\Commands\HashSet',
  1565. 'hashSet' => '\Predis\Commands\HashSet',
  1566. 'hsetnx' => '\Predis\Commands\HashSetPreserve',
  1567. 'hashSetPreserve' => '\Predis\Commands\HashSetPreserve',
  1568. 'hmset' => '\Predis\Commands\HashSetMultiple',
  1569. 'hashSetMultiple' => '\Predis\Commands\HashSetMultiple',
  1570. 'hincrby' => '\Predis\Commands\HashIncrementBy',
  1571. 'hashIncrementBy' => '\Predis\Commands\HashIncrementBy',
  1572. 'hget' => '\Predis\Commands\HashGet',
  1573. 'hashGet' => '\Predis\Commands\HashGet',
  1574. 'hmget' => '\Predis\Commands\HashGetMultiple',
  1575. 'hashGetMultiple' => '\Predis\Commands\HashGetMultiple',
  1576. 'hdel' => '\Predis\Commands\HashDelete',
  1577. 'hashDelete' => '\Predis\Commands\HashDelete',
  1578. 'hexists' => '\Predis\Commands\HashExists',
  1579. 'hashExists' => '\Predis\Commands\HashExists',
  1580. 'hlen' => '\Predis\Commands\HashLength',
  1581. 'hashLength' => '\Predis\Commands\HashLength',
  1582. 'hkeys' => '\Predis\Commands\HashKeys',
  1583. 'hashKeys' => '\Predis\Commands\HashKeys',
  1584. 'hvals' => '\Predis\Commands\HashValues',
  1585. 'hashValues' => '\Predis\Commands\HashValues',
  1586. 'hgetall' => '\Predis\Commands\HashGetAll',
  1587. 'hashGetAll' => '\Predis\Commands\HashGetAll',
  1588. /* publish - subscribe */
  1589. 'subscribe' => '\Predis\Commands\Subscribe',
  1590. 'unsubscribe' => '\Predis\Commands\Unsubscribe',
  1591. 'psubscribe' => '\Predis\Commands\SubscribeByPattern',
  1592. 'punsubscribe' => '\Predis\Commands\UnsubscribeByPattern',
  1593. 'publish' => '\Predis\Commands\Publish',
  1594. /* remote server control commands */
  1595. 'config' => '\Predis\Commands\Config',
  1596. 'configuration' => '\Predis\Commands\Config',
  1597. ));
  1598. }
  1599. }
  1600. class RedisServer_vNext extends RedisServer_v2_0 {
  1601. public function getVersion() { return '2.1'; }
  1602. public function getSupportedCommands() {
  1603. return array_merge(parent::getSupportedCommands(), array(
  1604. /* transactions */
  1605. 'watch' => '\Predis\Commands\Watch',
  1606. 'unwatch' => '\Predis\Commands\Unwatch',
  1607. /* commands operating on string values */
  1608. 'strlen' => '\Predis\Commands\Strlen',
  1609. 'setrange' => '\Predis\Commands\SetRange',
  1610. 'getrange' => '\Predis\Commands\Substr',
  1611. 'setbit' => '\Predis\Commands\SetBit',
  1612. 'getbit' => '\Predis\Commands\GetBit',
  1613. /* commands operating on the key space */
  1614. 'persist' => '\Predis\Commands\Persist',
  1615. /* commands operating on lists */
  1616. 'rpushx' => '\Predis\Commands\ListPushTailX',
  1617. 'lpushx' => '\Predis\Commands\ListPushHeadX',
  1618. 'linsert' => '\Predis\Commands\ListInsert',
  1619. 'brpoplpush' => '\Predis\Commands\ListPopLastPushHeadBlocking',
  1620. /* commands operating on sorted sets */
  1621. 'zrevrangebyscore' => '\Predis\Commands\ZSetReverseRangeByScore',
  1622. ));
  1623. }
  1624. }
  1625. /* ------------------------------------------------------------------------- */
  1626. namespace Predis\Pipeline;
  1627. interface IPipelineExecutor {
  1628. public function execute(\Predis\IConnection $connection, &$commands);
  1629. }
  1630. class StandardExecutor implements IPipelineExecutor {
  1631. public function execute(\Predis\IConnection $connection, &$commands) {
  1632. $sizeofPipe = count($commands);
  1633. $values = array();
  1634. foreach ($commands as $command) {
  1635. $connection->writeCommand($command);
  1636. }
  1637. try {
  1638. for ($i = 0; $i < $sizeofPipe; $i++) {
  1639. $response = $connection->readResponse($commands[$i]);
  1640. $values[] = $response instanceof \Iterator
  1641. ? iterator_to_array($response)
  1642. : $response;
  1643. unset($commands[$i]);
  1644. }
  1645. }
  1646. catch (\Predis\ServerException $exception) {
  1647. // force disconnection to prevent protocol desynchronization
  1648. $connection->disconnect();
  1649. throw $exception;
  1650. }
  1651. return $values;
  1652. }
  1653. }
  1654. class SafeExecutor implements IPipelineExecutor {
  1655. public function execute(\Predis\IConnection $connection, &$commands) {
  1656. $sizeofPipe = count($commands);
  1657. $values = array();
  1658. foreach ($commands as $command) {
  1659. try {
  1660. $connection->writeCommand($command);
  1661. }
  1662. catch (\Predis\CommunicationException $exception) {
  1663. return array_fill(0, $sizeofPipe, $exception);
  1664. }
  1665. }
  1666. for ($i = 0; $i < $sizeofPipe; $i++) {
  1667. $command = $commands[$i];
  1668. unset($commands[$i]);
  1669. try {
  1670. $response = $connection->readResponse($command);
  1671. $values[] = ($response instanceof \Iterator
  1672. ? iterator_to_array($response)
  1673. : $response
  1674. );
  1675. }
  1676. catch (\Predis\ServerException $exception) {
  1677. $values[] = $exception->toResponseError();
  1678. }
  1679. catch (\Predis\CommunicationException $exception) {
  1680. $toAdd = count($commands) - count($values);
  1681. $values = array_merge($values, array_fill(0, $toAdd, $exception));
  1682. break;
  1683. }
  1684. }
  1685. return $values;
  1686. }
  1687. }
  1688. class SafeClusterExecutor implements IPipelineExecutor {
  1689. public function execute(\Predis\IConnection $connection, &$commands) {
  1690. $connectionExceptions = array();
  1691. $sizeofPipe = count($commands);
  1692. $values = array();
  1693. foreach ($commands as $command) {
  1694. $cmdConnection = $connection->getConnection($command);
  1695. if (isset($connectionExceptions[spl_object_hash($cmdConnection)])) {
  1696. continue;
  1697. }
  1698. try {
  1699. $cmdConnection->writeCommand($command);
  1700. }
  1701. catch (\Predis\CommunicationException $exception) {
  1702. $connectionExceptions[spl_object_hash($cmdConnection)] = $exception;
  1703. }
  1704. }
  1705. for ($i = 0; $i < $sizeofPipe; $i++) {
  1706. $command = $commands[$i];
  1707. unset($commands[$i]);
  1708. $cmdConnection = $connection->getConnection($command);
  1709. $connectionObjectHash = spl_object_hash($cmdConnection);
  1710. if (isset($connectionExceptions[$connectionObjectHash])) {
  1711. $values[] = $connectionExceptions[$connectionObjectHash];
  1712. continue;
  1713. }
  1714. try {
  1715. $response = $cmdConnection->readResponse($command);
  1716. $values[] = ($response instanceof \Iterator
  1717. ? iterator_to_array($response)
  1718. : $response
  1719. );
  1720. }
  1721. catch (\Predis\ServerException $exception) {
  1722. $values[] = $exception->toResponseError();
  1723. }
  1724. catch (\Predis\CommunicationException $exception) {
  1725. $values[] = $exception;
  1726. $connectionExceptions[$connectionObjectHash] = $exception;
  1727. }
  1728. }
  1729. return $values;
  1730. }
  1731. }
  1732. /* ------------------------------------------------------------------------- */
  1733. namespace Predis\Distribution;
  1734. interface IDistributionStrategy {
  1735. public function add($node, $weight = null);
  1736. public function remove($node);
  1737. public function get($key);
  1738. public function generateKey($value);
  1739. }
  1740. class EmptyRingException extends \Exception { }
  1741. class HashRing implements IDistributionStrategy {
  1742. const DEFAULT_REPLICAS = 128;
  1743. const DEFAULT_WEIGHT = 100;
  1744. private $_nodes, $_ring, $_ringKeys, $_ringKeysCount, $_replicas;
  1745. public function __construct($replicas = self::DEFAULT_REPLICAS) {
  1746. $this->_replicas = $replicas;
  1747. $this->_nodes = array();
  1748. }
  1749. public function add($node, $weight = null) {
  1750. // NOTE: in case of collisions in the hashes of the nodes, the node added
  1751. // last wins, thus the order in which nodes are added is significant.
  1752. $this->_nodes[] = array('object' => $node, 'weight' => (int) $weight ?: $this::DEFAULT_WEIGHT);
  1753. $this->reset();
  1754. }
  1755. public function remove($node) {
  1756. // NOTE: a node is removed by resetting the ring so that it's recreated from
  1757. // scratch, in order to reassign possible hashes with collisions to the
  1758. // right node according to the order in which they were added in the
  1759. // first place.
  1760. for ($i = 0; $i < count($this->_nodes); ++$i) {
  1761. if ($this->_nodes[$i]['object'] === $node) {
  1762. array_splice($this->_nodes, $i, 1);
  1763. $this->reset();
  1764. break;
  1765. }
  1766. }
  1767. }
  1768. private function reset() {
  1769. unset($this->_ring);
  1770. unset($this->_ringKeys);
  1771. unset($this->_ringKeysCount);
  1772. }
  1773. private function isInitialized() {
  1774. return isset($this->_ringKeys);
  1775. }
  1776. private function computeTotalWeight() {
  1777. // TODO: array_reduce + lambda for PHP 5.3
  1778. $totalWeight = 0;
  1779. foreach ($this->_nodes as $node) {
  1780. $totalWeight += $node['weight'];
  1781. }
  1782. return $totalWeight;
  1783. }
  1784. private function initialize() {
  1785. if ($this->isInitialized()) {
  1786. return;
  1787. }
  1788. if (count($this->_nodes) === 0) {
  1789. throw new EmptyRingException('Cannot initialize empty hashring');
  1790. }
  1791. $this->_ring = array();
  1792. $totalWeight = $this->computeTotalWeight();
  1793. $nodesCount = count($this->_nodes);
  1794. foreach ($this->_nodes as $node) {
  1795. $weightRatio = $node['weight'] / $totalWeight;
  1796. $this->addNodeToRing($this->_ring, $node, $nodesCount, $this->_replicas, $weightRatio);
  1797. }
  1798. ksort($this->_ring, SORT_NUMERIC);
  1799. $this->_ringKeys = array_keys($this->_ring);
  1800. $this->_ringKeysCount = count($this->_ringKeys);
  1801. }
  1802. protected function addNodeToRing(&$ring, $node, $totalNodes, $replicas, $weightRatio) {
  1803. $nodeObject = $node['object'];
  1804. $nodeHash = (string) $nodeObject;
  1805. $replicas = (int) round($weightRatio * $totalNodes * $replicas);
  1806. for ($i = 0; $i < $replicas; $i++) {
  1807. $key = crc32("$nodeHash:$i");
  1808. $ring[$key] = $nodeObject;
  1809. }
  1810. }
  1811. public function generateKey($value) {
  1812. return crc32($value);
  1813. }
  1814. public function get($key) {
  1815. return $this->_ring[$this->getNodeKey($key)];
  1816. }
  1817. private function getNodeKey($key) {
  1818. $this->initialize();
  1819. $ringKeys = $this->_ringKeys;
  1820. $upper = $this->_ringKeysCount - 1;
  1821. $lower = 0;
  1822. while ($lower <= $upper) {
  1823. $index = ($lower + $upper) >> 1;
  1824. $item = $ringKeys[$index];
  1825. if ($item > $key) {
  1826. $upper = $index - 1;
  1827. }
  1828. else if ($item < $key) {
  1829. $lower = $index + 1;
  1830. }
  1831. else {
  1832. return $item;
  1833. }
  1834. }
  1835. return $ringKeys[$this->wrapAroundStrategy($upper, $lower, $this->_ringKeysCount)];
  1836. }
  1837. protected function wrapAroundStrategy($upper, $lower, $ringKeysCount) {
  1838. // NOTE: binary search for the last item in _ringkeys with a value
  1839. // less or equal to the key. If no such item exists, return the
  1840. // last item.
  1841. return $upper >= 0 ? $upper : $ringKeysCount - 1;
  1842. }
  1843. }
  1844. class KetamaPureRing extends HashRing {
  1845. const DEFAULT_REPLICAS = 160;
  1846. public function __construct() {
  1847. parent::__construct($this::DEFAULT_REPLICAS);
  1848. }
  1849. protected function addNodeToRing(&$ring, $node, $totalNodes, $replicas, $weightRatio) {
  1850. $nodeObject = $node['object'];
  1851. $nodeHash = (string) $nodeObject;
  1852. $replicas = (int) floor($weightRatio * $totalNodes * ($replicas / 4));
  1853. for ($i = 0; $i < $replicas; $i++) {
  1854. $unpackedDigest = unpack('V4', md5("$nodeHash-$i", true));
  1855. foreach ($unpackedDigest as $key) {
  1856. $ring[$key] = $nodeObject;
  1857. }
  1858. }
  1859. }
  1860. public function generateKey($value) {
  1861. $hash = unpack('V', md5($value, true));
  1862. return $hash[1];
  1863. }
  1864. protected function wrapAroundStrategy($upper, $lower, $ringKeysCount) {
  1865. // NOTE: binary search for the first item in _ringkeys with a value
  1866. // greater or equal to the key. If no such item exists, return the
  1867. // first item.
  1868. return $lower < $ringKeysCount ? $lower : 0;
  1869. }
  1870. }
  1871. /* ------------------------------------------------------------------------- */
  1872. namespace Predis\Shared;
  1873. class Utils {
  1874. public static function isCluster(\Predis\IConnection $connection) {
  1875. return $connection instanceof \Predis\ConnectionCluster;
  1876. }
  1877. public static function onCommunicationException(\Predis\CommunicationException $exception) {
  1878. if ($exception->shouldResetConnection()) {
  1879. $connection = $exception->getConnection();
  1880. if ($connection->isConnected()) {
  1881. $connection->disconnect();
  1882. }
  1883. }
  1884. throw $exception;
  1885. }
  1886. }
  1887. abstract class MultiBulkResponseIteratorBase implements \Iterator, \Countable {
  1888. protected $_position, $_current, $_replySize;
  1889. public function rewind() {
  1890. // NOOP
  1891. }
  1892. public function current() {
  1893. return $this->_current;
  1894. }
  1895. public function key() {
  1896. return $this->_position;
  1897. }
  1898. public function next() {
  1899. if (++$this->_position < $this->_replySize) {
  1900. $this->_current = $this->getValue();
  1901. }
  1902. return $this->_position;
  1903. }
  1904. public function valid() {
  1905. return $this->_position < $this->_replySize;
  1906. }
  1907. public function count() {
  1908. // NOTE: use count if you want to get the size of the current multi-bulk
  1909. // response without using iterator_count (which actually consumes
  1910. // our iterator to calculate the size, and we cannot perform a rewind)
  1911. return $this->_replySize;
  1912. }
  1913. protected abstract function getValue();
  1914. }
  1915. class MultiBulkResponseIterator extends MultiBulkResponseIteratorBase {
  1916. private $_connection;
  1917. public function __construct(\Predis\Connection $connection, $size) {
  1918. $this->_connection = $connection;
  1919. $this->_reader = $connection->getResponseReader();
  1920. $this->_position = 0;
  1921. $this->_current = $size > 0 ? $this->getValue() : null;
  1922. $this->_replySize = $size;
  1923. }
  1924. public function __destruct() {
  1925. // when the iterator is garbage-collected (e.g. it goes out of the
  1926. // scope of a foreach) but it has not reached its end, we must sync
  1927. // the client with the queued elements that have not been read from
  1928. // the connection with the server.
  1929. $this->sync();
  1930. }
  1931. public function sync($drop = false) {
  1932. if ($drop == true) {
  1933. if ($this->valid()) {
  1934. $this->_position = $this->_replySize;
  1935. $this->_connection->disconnect();
  1936. }
  1937. }
  1938. else {
  1939. while ($this->valid()) {
  1940. $this->next();
  1941. }
  1942. }
  1943. }
  1944. protected function getValue() {
  1945. return $this->_reader->read($this->_connection);
  1946. }
  1947. }
  1948. class MultiBulkResponseKVIterator extends MultiBulkResponseIteratorBase {
  1949. private $_iterator;
  1950. public function __construct(MultiBulkResponseIterator $iterator) {
  1951. $virtualSize = count($iterator) / 2;
  1952. $this->_iterator = $iterator;
  1953. $this->_position = 0;
  1954. $this->_current = $virtualSize > 0 ? $this->getValue() : null;
  1955. $this->_replySize = $virtualSize;
  1956. }
  1957. public function __destruct() {
  1958. $this->_iterator->sync();
  1959. }
  1960. protected function getValue() {
  1961. $k = $this->_iterator->current();
  1962. $this->_iterator->next();
  1963. $v = $this->_iterator->current();
  1964. $this->_iterator->next();
  1965. return array($k, $v);
  1966. }
  1967. }
  1968. /* ------------------------------------------------------------------------- */
  1969. namespace Predis\Commands;
  1970. /* miscellaneous commands */
  1971. class Ping extends \Predis\MultiBulkCommand {
  1972. public function canBeHashed() { return false; }
  1973. public function getCommandId() { return 'PING'; }
  1974. public function parseResponse($data) {
  1975. return $data === 'PONG' ? true : false;
  1976. }
  1977. }
  1978. class DoEcho extends \Predis\MultiBulkCommand {
  1979. public function canBeHashed() { return false; }
  1980. public function getCommandId() { return 'ECHO'; }
  1981. }
  1982. class Auth extends \Predis\MultiBulkCommand {
  1983. public function canBeHashed() { return false; }
  1984. public function getCommandId() { return 'AUTH'; }
  1985. }
  1986. /* connection handling */
  1987. class Quit extends \Predis\MultiBulkCommand {
  1988. public function canBeHashed() { return false; }
  1989. public function getCommandId() { return 'QUIT'; }
  1990. public function closesConnection() { return true; }
  1991. }
  1992. /* commands operating on string values */
  1993. class Set extends \Predis\MultiBulkCommand {
  1994. public function getCommandId() { return 'SET'; }
  1995. }
  1996. class SetExpire extends \Predis\MultiBulkCommand {
  1997. public function getCommandId() { return 'SETEX'; }
  1998. }
  1999. class SetPreserve extends \Predis\MultiBulkCommand {
  2000. public function getCommandId() { return 'SETNX'; }
  2001. public function parseResponse($data) { return (bool) $data; }
  2002. }
  2003. class SetMultiple extends \Predis\MultiBulkCommand {
  2004. public function canBeHashed() { return false; }
  2005. public function getCommandId() { return 'MSET'; }
  2006. public function filterArguments(Array $arguments) {
  2007. if (count($arguments) === 1 && is_array($arguments[0])) {
  2008. $flattenedKVs = array();
  2009. $args = &$arguments[0];
  2010. foreach ($args as $k => $v) {
  2011. $flattenedKVs[] = $k;
  2012. $flattenedKVs[] = $v;
  2013. }
  2014. return $flattenedKVs;
  2015. }
  2016. return $arguments;
  2017. }
  2018. }
  2019. class SetMultiplePreserve extends \Predis\Commands\SetMultiple {
  2020. public function canBeHashed() { return false; }
  2021. public function getCommandId() { return 'MSETNX'; }
  2022. public function parseResponse($data) { return (bool) $data; }
  2023. }
  2024. class Get extends \Predis\MultiBulkCommand {
  2025. public function getCommandId() { return 'GET'; }
  2026. }
  2027. class GetMultiple extends \Predis\MultiBulkCommand {
  2028. public function canBeHashed() { return false; }
  2029. public function getCommandId() { return 'MGET'; }
  2030. }
  2031. class GetSet extends \Predis\MultiBulkCommand {
  2032. public function getCommandId() { return 'GETSET'; }
  2033. }
  2034. class Increment extends \Predis\MultiBulkCommand {
  2035. public function getCommandId() { return 'INCR'; }
  2036. }
  2037. class IncrementBy extends \Predis\MultiBulkCommand {
  2038. public function getCommandId() { return 'INCRBY'; }
  2039. }
  2040. class Decrement extends \Predis\MultiBulkCommand {
  2041. public function getCommandId() { return 'DECR'; }
  2042. }
  2043. class DecrementBy extends \Predis\MultiBulkCommand {
  2044. public function getCommandId() { return 'DECRBY'; }
  2045. }
  2046. class Exists extends \Predis\MultiBulkCommand {
  2047. public function getCommandId() { return 'EXISTS'; }
  2048. public function parseResponse($data) { return (bool) $data; }
  2049. }
  2050. class Delete extends \Predis\MultiBulkCommand {
  2051. public function getCommandId() { return 'DEL'; }
  2052. }
  2053. class Type extends \Predis\MultiBulkCommand {
  2054. public function getCommandId() { return 'TYPE'; }
  2055. }
  2056. class Append extends \Predis\MultiBulkCommand {
  2057. public function getCommandId() { return 'APPEND'; }
  2058. }
  2059. class SetRange extends \Predis\MultiBulkCommand {
  2060. public function getCommandId() { return 'SETRANGE'; }
  2061. }
  2062. class Substr extends \Predis\MultiBulkCommand {
  2063. public function getCommandId() { return 'SUBSTR'; }
  2064. }
  2065. class SetBit extends \Predis\MultiBulkCommand {
  2066. public function getCommandId() { return 'SETBIT'; }
  2067. }
  2068. class GetBit extends \Predis\MultiBulkCommand {
  2069. public function getCommandId() { return 'GETBIT'; }
  2070. }
  2071. class Strlen extends \Predis\MultiBulkCommand {
  2072. public function getCommandId() { return 'STRLEN'; }
  2073. }
  2074. /* commands operating on the key space */
  2075. class Keys extends \Predis\MultiBulkCommand {
  2076. public function canBeHashed() { return false; }
  2077. public function getCommandId() { return 'KEYS'; }
  2078. public function parseResponse($data) {
  2079. // TODO: is this behaviour correct?
  2080. if (is_array($data) || $data instanceof \Iterator) {
  2081. return $data;
  2082. }
  2083. return strlen($data) > 0 ? explode(' ', $data) : array();
  2084. }
  2085. }
  2086. class RandomKey extends \Predis\MultiBulkCommand {
  2087. public function canBeHashed() { return false; }
  2088. public function getCommandId() { return 'RANDOMKEY'; }
  2089. public function parseResponse($data) { return $data !== '' ? $data : null; }
  2090. }
  2091. class Rename extends \Predis\MultiBulkCommand {
  2092. public function canBeHashed() { return false; }
  2093. public function getCommandId() { return 'RENAME'; }
  2094. }
  2095. class RenamePreserve extends \Predis\MultiBulkCommand {
  2096. public function canBeHashed() { return false; }
  2097. public function getCommandId() { return 'RENAMENX'; }
  2098. public function parseResponse($data) { return (bool) $data; }
  2099. }
  2100. class Expire extends \Predis\MultiBulkCommand {
  2101. public function getCommandId() { return 'EXPIRE'; }
  2102. public function parseResponse($data) { return (bool) $data; }
  2103. }
  2104. class ExpireAt extends \Predis\MultiBulkCommand {
  2105. public function getCommandId() { return 'EXPIREAT'; }
  2106. public function parseResponse($data) { return (bool) $data; }
  2107. }
  2108. class Persist extends \Predis\MultiBulkCommand {
  2109. public function getCommandId() { return 'PERSIST'; }
  2110. public function parseResponse($data) { return (bool) $data; }
  2111. }
  2112. class DatabaseSize extends \Predis\MultiBulkCommand {
  2113. public function canBeHashed() { return false; }
  2114. public function getCommandId() { return 'DBSIZE'; }
  2115. }
  2116. class TimeToLive extends \Predis\MultiBulkCommand {
  2117. public function getCommandId() { return 'TTL'; }
  2118. }
  2119. /* commands operating on lists */
  2120. class ListPushTail extends \Predis\MultiBulkCommand {
  2121. public function getCommandId() { return 'RPUSH'; }
  2122. }
  2123. class ListPushTailX extends \Predis\MultiBulkCommand {
  2124. public function getCommandId() { return 'RPUSHX'; }
  2125. }
  2126. class ListPushHead extends \Predis\MultiBulkCommand {
  2127. public function getCommandId() { return 'LPUSH'; }
  2128. }
  2129. class ListPushHeadX extends \Predis\MultiBulkCommand {
  2130. public function getCommandId() { return 'LPUSHX'; }
  2131. }
  2132. class ListLength extends \Predis\MultiBulkCommand {
  2133. public function getCommandId() { return 'LLEN'; }
  2134. }
  2135. class ListRange extends \Predis\MultiBulkCommand {
  2136. public function getCommandId() { return 'LRANGE'; }
  2137. }
  2138. class ListTrim extends \Predis\MultiBulkCommand {
  2139. public function getCommandId() { return 'LTRIM'; }
  2140. }
  2141. class ListIndex extends \Predis\MultiBulkCommand {
  2142. public function getCommandId() { return 'LINDEX'; }
  2143. }
  2144. class ListSet extends \Predis\MultiBulkCommand {
  2145. public function getCommandId() { return 'LSET'; }
  2146. }
  2147. class ListRemove extends \Predis\MultiBulkCommand {
  2148. public function getCommandId() { return 'LREM'; }
  2149. }
  2150. class ListPopLastPushHead extends \Predis\MultiBulkCommand {
  2151. public function getCommandId() { return 'RPOPLPUSH'; }
  2152. }
  2153. class ListPopLastPushHeadBlocking extends \Predis\MultiBulkCommand {
  2154. public function getCommandId() { return 'BRPOPLPUSH'; }
  2155. }
  2156. class ListPopFirst extends \Predis\MultiBulkCommand {
  2157. public function getCommandId() { return 'LPOP'; }
  2158. }
  2159. class ListPopLast extends \Predis\MultiBulkCommand {
  2160. public function getCommandId() { return 'RPOP'; }
  2161. }
  2162. class ListPopFirstBlocking extends \Predis\MultiBulkCommand {
  2163. public function getCommandId() { return 'BLPOP'; }
  2164. }
  2165. class ListPopLastBlocking extends \Predis\MultiBulkCommand {
  2166. public function getCommandId() { return 'BRPOP'; }
  2167. }
  2168. class ListInsert extends \Predis\MultiBulkCommand {
  2169. public function getCommandId() { return 'LINSERT'; }
  2170. }
  2171. /* commands operating on sets */
  2172. class SetAdd extends \Predis\MultiBulkCommand {
  2173. public function getCommandId() { return 'SADD'; }
  2174. public function parseResponse($data) { return (bool) $data; }
  2175. }
  2176. class SetRemove extends \Predis\MultiBulkCommand {
  2177. public function getCommandId() { return 'SREM'; }
  2178. public function parseResponse($data) { return (bool) $data; }
  2179. }
  2180. class SetPop extends \Predis\MultiBulkCommand {
  2181. public function getCommandId() { return 'SPOP'; }
  2182. }
  2183. class SetMove extends \Predis\MultiBulkCommand {
  2184. public function canBeHashed() { return false; }
  2185. public function getCommandId() { return 'SMOVE'; }
  2186. public function parseResponse($data) { return (bool) $data; }
  2187. }
  2188. class SetCardinality extends \Predis\MultiBulkCommand {
  2189. public function getCommandId() { return 'SCARD'; }
  2190. }
  2191. class SetIsMember extends \Predis\MultiBulkCommand {
  2192. public function getCommandId() { return 'SISMEMBER'; }
  2193. public function parseResponse($data) { return (bool) $data; }
  2194. }
  2195. class SetIntersection extends \Predis\MultiBulkCommand {
  2196. public function getCommandId() { return 'SINTER'; }
  2197. }
  2198. class SetIntersectionStore extends \Predis\MultiBulkCommand {
  2199. public function getCommandId() { return 'SINTERSTORE'; }
  2200. }
  2201. class SetUnion extends \Predis\MultiBulkCommand {
  2202. public function getCommandId() { return 'SUNION'; }
  2203. }
  2204. class SetUnionStore extends \Predis\MultiBulkCommand {
  2205. public function getCommandId() { return 'SUNIONSTORE'; }
  2206. }
  2207. class SetDifference extends \Predis\MultiBulkCommand {
  2208. public function getCommandId() { return 'SDIFF'; }
  2209. }
  2210. class SetDifferenceStore extends \Predis\MultiBulkCommand {
  2211. public function getCommandId() { return 'SDIFFSTORE'; }
  2212. }
  2213. class SetMembers extends \Predis\MultiBulkCommand {
  2214. public function getCommandId() { return 'SMEMBERS'; }
  2215. }
  2216. class SetRandomMember extends \Predis\MultiBulkCommand {
  2217. public function getCommandId() { return 'SRANDMEMBER'; }
  2218. }
  2219. /* commands operating on sorted sets */
  2220. class ZSetAdd extends \Predis\MultiBulkCommand {
  2221. public function getCommandId() { return 'ZADD'; }
  2222. public function parseResponse($data) { return (bool) $data; }
  2223. }
  2224. class ZSetIncrementBy extends \Predis\MultiBulkCommand {
  2225. public function getCommandId() { return 'ZINCRBY'; }
  2226. }
  2227. class ZSetRemove extends \Predis\MultiBulkCommand {
  2228. public function getCommandId() { return 'ZREM'; }
  2229. public function parseResponse($data) { return (bool) $data; }
  2230. }
  2231. class ZSetUnionStore extends \Predis\MultiBulkCommand {
  2232. public function getCommandId() { return 'ZUNIONSTORE'; }
  2233. public function filterArguments(Array $arguments) {
  2234. $options = array();
  2235. $argc = count($arguments);
  2236. if ($argc > 1 && is_array($arguments[$argc - 1])) {
  2237. $options = $this->prepareOptions(array_pop($arguments));
  2238. }
  2239. $args = is_array($arguments[0]) ? $arguments[0] : $arguments;
  2240. return array_merge($args, $options);
  2241. }
  2242. private function prepareOptions($options) {
  2243. $opts = array_change_key_case($options, CASE_UPPER);
  2244. $finalizedOpts = array();
  2245. if (isset($opts['WEIGHTS']) && is_array($opts['WEIGHTS'])) {
  2246. $finalizedOpts[] = 'WEIGHTS';
  2247. foreach ($opts['WEIGHTS'] as $weight) {
  2248. $finalizedOpts[] = $weight;
  2249. }
  2250. }
  2251. if (isset($opts['AGGREGATE'])) {
  2252. $finalizedOpts[] = 'AGGREGATE';
  2253. $finalizedOpts[] = $opts['AGGREGATE'];
  2254. }
  2255. return $finalizedOpts;
  2256. }
  2257. }
  2258. class ZSetIntersectionStore extends \Predis\Commands\ZSetUnionStore {
  2259. public function getCommandId() { return 'ZINTERSTORE'; }
  2260. }
  2261. class ZSetRange extends \Predis\MultiBulkCommand {
  2262. private $_withScores = false;
  2263. public function getCommandId() { return 'ZRANGE'; }
  2264. public function filterArguments(Array $arguments) {
  2265. if (count($arguments) === 4) {
  2266. $lastType = gettype($arguments[3]);
  2267. if ($lastType === 'string' && strtolower($arguments[3]) === 'withscores') {
  2268. // used for compatibility with older versions
  2269. $arguments[3] = array('WITHSCORES' => true);
  2270. $lastType = 'array';
  2271. }
  2272. if ($lastType === 'array') {
  2273. $options = $this->prepareOptions(array_pop($arguments));
  2274. return array_merge($arguments, $options);
  2275. }
  2276. }
  2277. return $arguments;
  2278. }
  2279. protected function prepareOptions($options) {
  2280. $opts = array_change_key_case($options, CASE_UPPER);
  2281. $finalizedOpts = array();
  2282. if (isset($opts['WITHSCORES'])) {
  2283. $finalizedOpts[] = 'WITHSCORES';
  2284. $this->_withScores = true;
  2285. }
  2286. return $finalizedOpts;
  2287. }
  2288. public function parseResponse($data) {
  2289. if ($this->_withScores) {
  2290. if ($data instanceof \Iterator) {
  2291. return new \Predis\Shared\MultiBulkResponseKVIterator($data);
  2292. }
  2293. $result = array();
  2294. for ($i = 0; $i < count($data); $i++) {
  2295. $result[] = array($data[$i], $data[++$i]);
  2296. }
  2297. return $result;
  2298. }
  2299. return $data;
  2300. }
  2301. }
  2302. class ZSetReverseRange extends \Predis\Commands\ZSetRange {
  2303. public function getCommandId() { return 'ZREVRANGE'; }
  2304. }
  2305. class ZSetRangeByScore extends \Predis\Commands\ZSetRange {
  2306. public function getCommandId() { return 'ZRANGEBYSCORE'; }
  2307. protected function prepareOptions($options) {
  2308. $opts = array_change_key_case($options, CASE_UPPER);
  2309. $finalizedOpts = array();
  2310. if (isset($opts['LIMIT']) && is_array($opts['LIMIT'])) {
  2311. $limit = array_change_key_case($opts['LIMIT'], CASE_UPPER);
  2312. $finalizedOpts[] = 'LIMIT';
  2313. $finalizedOpts[] = isset($limit['OFFSET']) ? $limit['OFFSET'] : $limit[0];
  2314. $finalizedOpts[] = isset($limit['COUNT']) ? $limit['COUNT'] : $limit[1];
  2315. }
  2316. return array_merge($finalizedOpts, parent::prepareOptions($options));
  2317. }
  2318. }
  2319. class ZSetReverseRangeByScore extends \Predis\Commands\ZSetRangeByScore {
  2320. public function getCommandId() { return 'ZREVRANGEBYSCORE'; }
  2321. }
  2322. class ZSetCount extends \Predis\MultiBulkCommand {
  2323. public function getCommandId() { return 'ZCOUNT'; }
  2324. }
  2325. class ZSetCardinality extends \Predis\MultiBulkCommand {
  2326. public function getCommandId() { return 'ZCARD'; }
  2327. }
  2328. class ZSetScore extends \Predis\MultiBulkCommand {
  2329. public function getCommandId() { return 'ZSCORE'; }
  2330. }
  2331. class ZSetRemoveRangeByScore extends \Predis\MultiBulkCommand {
  2332. public function getCommandId() { return 'ZREMRANGEBYSCORE'; }
  2333. }
  2334. class ZSetRank extends \Predis\MultiBulkCommand {
  2335. public function getCommandId() { return 'ZRANK'; }
  2336. }
  2337. class ZSetReverseRank extends \Predis\MultiBulkCommand {
  2338. public function getCommandId() { return 'ZREVRANK'; }
  2339. }
  2340. class ZSetRemoveRangeByRank extends \Predis\MultiBulkCommand {
  2341. public function getCommandId() { return 'ZREMRANGEBYRANK'; }
  2342. }
  2343. /* commands operating on hashes */
  2344. class HashSet extends \Predis\MultiBulkCommand {
  2345. public function getCommandId() { return 'HSET'; }
  2346. public function parseResponse($data) { return (bool) $data; }
  2347. }
  2348. class HashSetPreserve extends \Predis\MultiBulkCommand {
  2349. public function getCommandId() { return 'HSETNX'; }
  2350. public function parseResponse($data) { return (bool) $data; }
  2351. }
  2352. class HashSetMultiple extends \Predis\MultiBulkCommand {
  2353. public function getCommandId() { return 'HMSET'; }
  2354. public function filterArguments(Array $arguments) {
  2355. if (count($arguments) === 2 && is_array($arguments[1])) {
  2356. $flattenedKVs = array($arguments[0]);
  2357. $args = &$arguments[1];
  2358. foreach ($args as $k => $v) {
  2359. $flattenedKVs[] = $k;
  2360. $flattenedKVs[] = $v;
  2361. }
  2362. return $flattenedKVs;
  2363. }
  2364. return $arguments;
  2365. }
  2366. }
  2367. class HashIncrementBy extends \Predis\MultiBulkCommand {
  2368. public function getCommandId() { return 'HINCRBY'; }
  2369. }
  2370. class HashGet extends \Predis\MultiBulkCommand {
  2371. public function getCommandId() { return 'HGET'; }
  2372. }
  2373. class HashGetMultiple extends \Predis\MultiBulkCommand {
  2374. public function getCommandId() { return 'HMGET'; }
  2375. public function filterArguments(Array $arguments) {
  2376. if (count($arguments) === 2 && is_array($arguments[1])) {
  2377. $flattenedKVs = array($arguments[0]);
  2378. $args = &$arguments[1];
  2379. foreach ($args as $v) {
  2380. $flattenedKVs[] = $v;
  2381. }
  2382. return $flattenedKVs;
  2383. }
  2384. return $arguments;
  2385. }
  2386. }
  2387. class HashDelete extends \Predis\MultiBulkCommand {
  2388. public function getCommandId() { return 'HDEL'; }
  2389. public function parseResponse($data) { return (bool) $data; }
  2390. }
  2391. class HashExists extends \Predis\MultiBulkCommand {
  2392. public function getCommandId() { return 'HEXISTS'; }
  2393. public function parseResponse($data) { return (bool) $data; }
  2394. }
  2395. class HashLength extends \Predis\MultiBulkCommand {
  2396. public function getCommandId() { return 'HLEN'; }
  2397. }
  2398. class HashKeys extends \Predis\MultiBulkCommand {
  2399. public function getCommandId() { return 'HKEYS'; }
  2400. }
  2401. class HashValues extends \Predis\MultiBulkCommand {
  2402. public function getCommandId() { return 'HVALS'; }
  2403. }
  2404. class HashGetAll extends \Predis\MultiBulkCommand {
  2405. public function getCommandId() { return 'HGETALL'; }
  2406. public function parseResponse($data) {
  2407. if ($data instanceof \Iterator) {
  2408. return new \Predis\Shared\MultiBulkResponseKVIterator($data);
  2409. }
  2410. $result = array();
  2411. for ($i = 0; $i < count($data); $i++) {
  2412. $result[$data[$i]] = $data[++$i];
  2413. }
  2414. return $result;
  2415. }
  2416. }
  2417. /* multiple databases handling commands */
  2418. class SelectDatabase extends \Predis\MultiBulkCommand {
  2419. public function canBeHashed() { return false; }
  2420. public function getCommandId() { return 'SELECT'; }
  2421. }
  2422. class MoveKey extends \Predis\MultiBulkCommand {
  2423. public function canBeHashed() { return false; }
  2424. public function getCommandId() { return 'MOVE'; }
  2425. public function parseResponse($data) { return (bool) $data; }
  2426. }
  2427. class FlushDatabase extends \Predis\MultiBulkCommand {
  2428. public function canBeHashed() { return false; }
  2429. public function getCommandId() { return 'FLUSHDB'; }
  2430. }
  2431. class FlushAll extends \Predis\MultiBulkCommand {
  2432. public function canBeHashed() { return false; }
  2433. public function getCommandId() { return 'FLUSHALL'; }
  2434. }
  2435. /* sorting */
  2436. class Sort extends \Predis\MultiBulkCommand {
  2437. public function getCommandId() { return 'SORT'; }
  2438. public function filterArguments(Array $arguments) {
  2439. if (count($arguments) === 1) {
  2440. return $arguments;
  2441. }
  2442. $query = array($arguments[0]);
  2443. $sortParams = array_change_key_case($arguments[1], CASE_UPPER);
  2444. if (isset($sortParams['BY'])) {
  2445. $query[] = 'BY';
  2446. $query[] = $sortParams['BY'];
  2447. }
  2448. if (isset($sortParams['GET'])) {
  2449. $getargs = $sortParams['GET'];
  2450. if (is_array($getargs)) {
  2451. foreach ($getargs as $getarg) {
  2452. $query[] = 'GET';
  2453. $query[] = $getarg;
  2454. }
  2455. }
  2456. else {
  2457. $query[] = 'GET';
  2458. $query[] = $getargs;
  2459. }
  2460. }
  2461. if (isset($sortParams['LIMIT']) && is_array($sortParams['LIMIT'])
  2462. && count($sortParams['LIMIT']) == 2) {
  2463. $query[] = 'LIMIT';
  2464. $query[] = $sortParams['LIMIT'][0];
  2465. $query[] = $sortParams['LIMIT'][1];
  2466. }
  2467. if (isset($sortParams['SORT'])) {
  2468. $query[] = strtoupper($sortParams['SORT']);
  2469. }
  2470. if (isset($sortParams['ALPHA']) && $sortParams['ALPHA'] == true) {
  2471. $query[] = 'ALPHA';
  2472. }
  2473. if (isset($sortParams['STORE'])) {
  2474. $query[] = 'STORE';
  2475. $query[] = $sortParams['STORE'];
  2476. }
  2477. return $query;
  2478. }
  2479. }
  2480. /* transactions */
  2481. class Multi extends \Predis\MultiBulkCommand {
  2482. public function canBeHashed() { return false; }
  2483. public function getCommandId() { return 'MULTI'; }
  2484. }
  2485. class Exec extends \Predis\MultiBulkCommand {
  2486. public function canBeHashed() { return false; }
  2487. public function getCommandId() { return 'EXEC'; }
  2488. }
  2489. class Discard extends \Predis\MultiBulkCommand {
  2490. public function canBeHashed() { return false; }
  2491. public function getCommandId() { return 'DISCARD'; }
  2492. }
  2493. class Watch extends \Predis\MultiBulkCommand {
  2494. public function canBeHashed() { return false; }
  2495. public function getCommandId() { return 'WATCH'; }
  2496. public function filterArguments(Array $arguments) {
  2497. if (isset($arguments[0]) && is_array($arguments[0])) {
  2498. return $arguments[0];
  2499. }
  2500. return $arguments;
  2501. }
  2502. public function parseResponse($data) { return (bool) $data; }
  2503. }
  2504. class Unwatch extends \Predis\MultiBulkCommand {
  2505. public function canBeHashed() { return false; }
  2506. public function getCommandId() { return 'UNWATCH'; }
  2507. public function parseResponse($data) { return (bool) $data; }
  2508. }
  2509. /* publish/subscribe */
  2510. class Subscribe extends \Predis\MultiBulkCommand {
  2511. public function canBeHashed() { return false; }
  2512. public function getCommandId() { return 'SUBSCRIBE'; }
  2513. }
  2514. class Unsubscribe extends \Predis\MultiBulkCommand {
  2515. public function canBeHashed() { return false; }
  2516. public function getCommandId() { return 'UNSUBSCRIBE'; }
  2517. }
  2518. class SubscribeByPattern extends \Predis\MultiBulkCommand {
  2519. public function canBeHashed() { return false; }
  2520. public function getCommandId() { return 'PSUBSCRIBE'; }
  2521. }
  2522. class UnsubscribeByPattern extends \Predis\MultiBulkCommand {
  2523. public function canBeHashed() { return false; }
  2524. public function getCommandId() { return 'PUNSUBSCRIBE'; }
  2525. }
  2526. class Publish extends \Predis\MultiBulkCommand {
  2527. public function canBeHashed() { return false; }
  2528. public function getCommandId() { return 'PUBLISH'; }
  2529. }
  2530. /* persistence control commands */
  2531. class Save extends \Predis\MultiBulkCommand {
  2532. public function canBeHashed() { return false; }
  2533. public function getCommandId() { return 'SAVE'; }
  2534. }
  2535. class BackgroundSave extends \Predis\MultiBulkCommand {
  2536. public function canBeHashed() { return false; }
  2537. public function getCommandId() { return 'BGSAVE'; }
  2538. public function parseResponse($data) {
  2539. if ($data == 'Background saving started') {
  2540. return true;
  2541. }
  2542. return $data;
  2543. }
  2544. }
  2545. class BackgroundRewriteAppendOnlyFile extends \Predis\MultiBulkCommand {
  2546. public function canBeHashed() { return false; }
  2547. public function getCommandId() { return 'BGREWRITEAOF'; }
  2548. public function parseResponse($data) {
  2549. return $data == 'Background append only file rewriting started';
  2550. }
  2551. }
  2552. class LastSave extends \Predis\MultiBulkCommand {
  2553. public function canBeHashed() { return false; }
  2554. public function getCommandId() { return 'LASTSAVE'; }
  2555. }
  2556. class Shutdown extends \Predis\MultiBulkCommand {
  2557. public function canBeHashed() { return false; }
  2558. public function getCommandId() { return 'SHUTDOWN'; }
  2559. public function closesConnection() { return true; }
  2560. }
  2561. /* remote server control commands */
  2562. class Info extends \Predis\MultiBulkCommand {
  2563. public function canBeHashed() { return false; }
  2564. public function getCommandId() { return 'INFO'; }
  2565. public function parseResponse($data) {
  2566. $info = array();
  2567. $infoLines = explode("\r\n", $data, -1);
  2568. foreach ($infoLines as $row) {
  2569. list($k, $v) = explode(':', $row);
  2570. if (!preg_match('/^db\d+$/', $k)) {
  2571. $info[$k] = $v;
  2572. }
  2573. else {
  2574. $db = array();
  2575. foreach (explode(',', $v) as $dbvar) {
  2576. list($dbvk, $dbvv) = explode('=', $dbvar);
  2577. $db[trim($dbvk)] = $dbvv;
  2578. }
  2579. $info[$k] = $db;
  2580. }
  2581. }
  2582. return $info;
  2583. }
  2584. }
  2585. class SlaveOf extends \Predis\MultiBulkCommand {
  2586. public function canBeHashed() { return false; }
  2587. public function getCommandId() { return 'SLAVEOF'; }
  2588. public function filterArguments(Array $arguments) {
  2589. if (count($arguments) === 0 || $arguments[0] === 'NO ONE') {
  2590. return array('NO', 'ONE');
  2591. }
  2592. return $arguments;
  2593. }
  2594. }
  2595. class Config extends \Predis\MultiBulkCommand {
  2596. public function canBeHashed() { return false; }
  2597. public function getCommandId() { return 'CONFIG'; }
  2598. }
  2599. ?>