Predis.php 104 KB

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