1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484 |
- <?php
- class PredisException extends Exception { }
- // Client-side errors
- class Predis_ClientException extends PredisException { }
- // Aborted multi/exec
- class Predis_AbortedMultiExec extends PredisException { }
- // Server-side errors
- class Predis_ServerException extends PredisException {
- public function toResponseError() {
- return new Predis_ResponseError($this->getMessage());
- }
- }
- // Communication errors
- class Predis_CommunicationException extends PredisException {
- private $_connection;
- public function __construct(Predis_Connection $connection, $message = null, $code = null) {
- $this->_connection = $connection;
- parent::__construct($message, $code);
- }
- public function getConnection() { return $this->_connection; }
- public function shouldResetConnection() { return true; }
- }
- // Unexpected responses
- class Predis_MalformedServerResponse extends Predis_CommunicationException { }
- /* ------------------------------------------------------------------------- */
- class Predis_Client {
- const VERSION = '0.6.6';
- private $_options, $_connection, $_serverProfile, $_responseReader;
- public function __construct($parameters = null, $clientOptions = null) {
- $this->setupClient($clientOptions !== null ? $clientOptions : new Predis_ClientOptions());
- $this->setupConnection($parameters);
- }
- public static function create(/* arguments */) {
- $argv = func_get_args();
- $argc = func_num_args();
- $options = null;
- $lastArg = $argv[$argc-1];
- if ($argc > 0 && !is_string($lastArg) && ($lastArg instanceof Predis_ClientOptions ||
- is_subclass_of($lastArg, 'Predis_RedisServerProfile'))) {
- $options = array_pop($argv);
- $argc--;
- }
- if ($argc === 0) {
- throw new Predis_ClientException('Missing connection parameters');
- }
- return new Predis_Client($argc === 1 ? $argv[0] : $argv, $options);
- }
- private static function filterClientOptions($options) {
- if ($options instanceof Predis_ClientOptions) {
- return $options;
- }
- if (is_array($options)) {
- return new Predis_ClientOptions($options);
- }
- if ($options instanceof Predis_RedisServerProfile) {
- return new Predis_ClientOptions(array(
- 'profile' => $options
- ));
- }
- if (is_string($options)) {
- return new Predis_ClientOptions(array(
- 'profile' => Predis_RedisServerProfile::get($options)
- ));
- }
- throw new InvalidArgumentException("Invalid type for client options");
- }
- private function setupClient($options) {
- $options = self::filterClientOptions($options);
- $this->setProfile($options->profile);
- $reader = $options->reader;
- $reader->setOption('iterable_multibulk', $options->iterable_multibulk);
- $reader->setOption('throw_on_error', $options->throw_on_error);
- $this->_options = $options;
- $this->_responseReader = $reader;
- }
- private function setupConnection($parameters) {
- if ($parameters !== null && !(is_array($parameters) || is_string($parameters))) {
- throw new Predis_ClientException('Invalid parameters type (array or string expected)');
- }
- if (is_array($parameters) && isset($parameters[0])) {
- $cluster = new Predis_ConnectionCluster($this->_options->key_distribution);
- foreach ($parameters as $shardParams) {
- $cluster->add($this->createConnection($shardParams));
- }
- $this->setConnection($cluster);
- }
- else {
- $this->setConnection($this->createConnection($parameters));
- }
- }
- private function createConnection($parameters) {
- if (!$parameters instanceof Predis_ConnectionParameters) {
- $parameters = new Predis_ConnectionParameters($parameters);
- }
- $connection = new Predis_Connection($parameters, $this->_responseReader);
- if ($parameters->password !== null) {
- $connection->pushInitCommand($this->createCommand(
- 'auth', array($parameters->password)
- ));
- }
- if ($parameters->database !== null) {
- $connection->pushInitCommand($this->createCommand(
- 'select', array($parameters->database)
- ));
- }
- return $connection;
- }
- private function setConnection(Predis_IConnection $connection) {
- $this->_connection = $connection;
- }
- public function setProfile($serverProfile) {
- if ($serverProfile instanceof Predis_RedisServerProfile) {
- $this->_serverProfile = $serverProfile;
- }
- else if (is_string($serverProfile)) {
- $this->_serverProfile = Predis_RedisServerProfile::get($serverProfile);
- }
- else {
- throw new InvalidArgumentException(
- "Invalid type for server profile, Predis_RedisServerProfile or string expected"
- );
- }
- }
- public function getProfile() {
- return $this->_serverProfile;
- }
- public function getResponseReader() {
- return $this->_responseReader;
- }
- public function getClientFor($connectionAlias) {
- if (!Predis_Shared_Utils::isCluster($this->_connection)) {
- throw new Predis_ClientException(
- 'This method is supported only when the client is connected to a cluster of connections'
- );
- }
- $connection = $this->_connection->getConnectionById($connectionAlias);
- if ($connection === null) {
- throw new InvalidArgumentException(
- "Invalid connection alias: '$connectionAlias'"
- );
- }
- $newClient = new Predis_Client();
- $newClient->setupClient($this->_options);
- $newClient->setConnection($connection);
- return $newClient;
- }
- public function connect() {
- $this->_connection->connect();
- }
- public function disconnect() {
- $this->_connection->disconnect();
- }
- public function isConnected() {
- return $this->_connection->isConnected();
- }
- public function getConnection($id = null) {
- if (!isset($id)) {
- return $this->_connection;
- }
- else {
- return Predis_Shared_Utils::isCluster($this->_connection)
- ? $this->_connection->getConnectionById($id)
- : $this->_connection;
- }
- }
- public function __call($method, $arguments) {
- $command = $this->_serverProfile->createCommand($method, $arguments);
- return $this->_connection->executeCommand($command);
- }
- public function createCommand($method, $arguments = array()) {
- return $this->_serverProfile->createCommand($method, $arguments);
- }
- public function executeCommand(Predis_Command $command) {
- return $this->_connection->executeCommand($command);
- }
- public function executeCommandOnShards(Predis_Command $command) {
- $replies = array();
- if (Predis_Shared_Utils::isCluster($this->_connection)) {
- foreach($this->_connection as $connection) {
- $replies[] = $connection->executeCommand($command);
- }
- }
- else {
- $replies[] = $this->_connection->executeCommand($command);
- }
- return $replies;
- }
- public function rawCommand($rawCommandData, $closesConnection = false) {
- if (Predis_Shared_Utils::isCluster($this->_connection)) {
- throw new Predis_ClientException('Cannot send raw commands when connected to a cluster of Redis servers');
- }
- return $this->_connection->rawCommand($rawCommandData, $closesConnection);
- }
- private function sharedInitializer($argv, $initializer) {
- $argc = count($argv);
- if ($argc === 0) {
- return $this->$initializer();
- }
- else if ($argc === 1) {
- list($arg0) = $argv;
- return is_array($arg0) ? $this->$initializer($arg0) : $this->$initializer(null, $arg0);
- }
- else if ($argc === 2) {
- list($arg0, $arg1) = $argv;
- return $this->$initializer($arg0, $arg1);
- }
- return $this->$initializer($this, $arguments);
- }
- public function pipeline(/* arguments */) {
- $args = func_get_args();
- return $this->sharedInitializer($args, 'initPipeline');
- }
- public function pipelineSafe($pipelineBlock = null) {
- return $this->initPipeline(array('safe' => true), $pipelineBlock);
- }
- private function initPipeline(Array $options = null, $pipelineBlock = null) {
- $pipeline = null;
- if (isset($options)) {
- if (isset($options['safe']) && $options['safe'] == true) {
- $connection = $this->getConnection();
- $pipeline = new Predis_CommandPipeline($this, $connection instanceof Predis_Connection
- ? new Predis_Pipeline_SafeExecutor($connection)
- : new Predis_Pipeline_SafeClusterExecutor($connection)
- );
- }
- else {
- $pipeline = new Predis_CommandPipeline($this);
- }
- }
- else {
- $pipeline = new Predis_CommandPipeline($this);
- }
- return $this->pipelineExecute($pipeline, $pipelineBlock);
- }
- private function pipelineExecute(Predis_CommandPipeline $pipeline, $block) {
- return $block !== null ? $pipeline->execute($block) : $pipeline;
- }
- public function multiExec(/* arguments */) {
- $args = func_get_args();
- return $this->sharedInitializer($args, 'initMultiExec');
- }
- private function initMultiExec(Array $options = null, $transBlock = null) {
- $multi = isset($options) ? new Predis_MultiExecBlock($this, $options) : new Predis_MultiExecBlock($this);
- return $transBlock !== null ? $multi->execute($transBlock) : $multi;
- }
- public function pubSubContext(Array $options = null) {
- return new Predis_PubSubContext($this, $options);
- }
- }
- /* ------------------------------------------------------------------------- */
- interface Predis_IClientOptionsHandler {
- public function validate($option, $value);
- public function getDefault();
- }
- class Predis_ClientOptionsProfile implements Predis_IClientOptionsHandler {
- public function validate($option, $value) {
- if ($value instanceof Predis_RedisServerProfile) {
- return $value;
- }
- if (is_string($value)) {
- return Predis_RedisServerProfile::get($value);
- }
- throw new InvalidArgumentException("Invalid value for option $option");
- }
- public function getDefault() {
- return Predis_RedisServerProfile::getDefault();
- }
- }
- class Predis_ClientOptionsKeyDistribution implements Predis_IClientOptionsHandler {
- public function validate($option, $value) {
- if ($value instanceof Predis_Distribution_IDistributionStrategy) {
- return $value;
- }
- if (is_string($value)) {
- $valueReflection = new ReflectionClass($value);
- if ($valueReflection->isSubclassOf('Predis_Distribution_IDistributionStrategy')) {
- return new $value;
- }
- }
- throw new InvalidArgumentException("Invalid value for option $option");
- }
- public function getDefault() {
- return new Predis_Distribution_HashRing();
- }
- }
- class Predis_ClientOptionsIterableMultiBulk implements Predis_IClientOptionsHandler {
- public function validate($option, $value) {
- return (bool) $value;
- }
- public function getDefault() {
- return false;
- }
- }
- class Predis_ClientOptionsThrowOnError implements Predis_IClientOptionsHandler {
- public function validate($option, $value) {
- return (bool) $value;
- }
- public function getDefault() {
- return true;
- }
- }
- class Predis_ClientOptionsReader implements Predis_IClientOptionsHandler {
- public function validate($option, $value) {
- if ($value instanceof Predis_IResponseReader) {
- return $value;
- }
- if (is_string($value)) {
- if ($value === 'composable') {
- return new Predis_ResponseReader();
- }
- $valueReflection = new ReflectionClass($value);
- if ($valueReflection->isSubclassOf('Predis_IResponseReader')) {
- return new $value;
- }
- }
- throw new InvalidArgumentException("Invalid value for option $option");
- }
- public function getDefault() {
- return new Predis_FastResponseReader();
- }
- }
- class Predis_ClientOptions {
- private static $_optionsHandlers;
- private $_options;
- public function __construct($options = null) {
- self::initializeOptionsHandlers();
- $this->initializeOptions($options !== null ? $options : array());
- }
- private static function initializeOptionsHandlers() {
- if (!isset(self::$_optionsHandlers)) {
- self::$_optionsHandlers = self::getOptionsHandlers();
- }
- }
- private static function getOptionsHandlers() {
- return array(
- 'profile' => new Predis_ClientOptionsProfile(),
- 'key_distribution' => new Predis_ClientOptionsKeyDistribution(),
- 'iterable_multibulk' => new Predis_ClientOptionsIterableMultiBulk(),
- 'throw_on_error' => new Predis_ClientOptionsThrowOnError(),
- 'reader' => new Predis_ClientOptionsReader(),
- );
- }
- private function initializeOptions($options) {
- foreach ($options as $option => $value) {
- if (isset(self::$_optionsHandlers[$option])) {
- $handler = self::$_optionsHandlers[$option];
- $this->_options[$option] = $handler->validate($option, $value);
- }
- }
- }
- public function __get($option) {
- if (!isset($this->_options[$option])) {
- $defaultValue = self::$_optionsHandlers[$option]->getDefault();
- $this->_options[$option] = $defaultValue;
- }
- return $this->_options[$option];
- }
- public function __isset($option) {
- return isset(self::$_optionsHandlers[$option]);
- }
- }
- /* ------------------------------------------------------------------------- */
- class Predis_Protocol {
- const NEWLINE = "\r\n";
- const OK = 'OK';
- const ERROR = 'ERR';
- const QUEUED = 'QUEUED';
- const NULL = 'nil';
- const PREFIX_STATUS = '+';
- const PREFIX_ERROR = '-';
- const PREFIX_INTEGER = ':';
- const PREFIX_BULK = '$';
- const PREFIX_MULTI_BULK = '*';
- }
- abstract class Predis_Command {
- private $_hash;
- private $_arguments = array();
- public abstract function getCommandId();
- public abstract function serializeRequest($command, $arguments);
- public function canBeHashed() {
- return true;
- }
- public function getHash(Predis_Distribution_IDistributionStrategy $distributor) {
- if (isset($this->_hash)) {
- return $this->_hash;
- }
- if (isset($this->_arguments[0])) {
- // TODO: should we throw an exception if the command does
- // not support sharding?
- $key = $this->_arguments[0];
- $start = strpos($key, '{');
- if ($start !== false) {
- $end = strpos($key, '}', $start);
- if ($end !== false) {
- $key = substr($key, ++$start, $end - $start);
- }
- }
- $this->_hash = $distributor->generateKey($key);
- return $this->_hash;
- }
- return null;
- }
- public function closesConnection() {
- return false;
- }
- protected function filterArguments(Array $arguments) {
- return $arguments;
- }
- public function setArguments(/* arguments */) {
- $this->_arguments = $this->filterArguments(func_get_args());
- unset($this->_hash);
- }
- public function setArgumentsArray(Array $arguments) {
- $this->_arguments = $this->filterArguments($arguments);
- unset($this->_hash);
- }
- public function getArguments() {
- return $this->_arguments;
- }
- public function getArgument($index = 0) {
- if (isset($this->_arguments[$index]) === true) {
- return $this->_arguments[$index];
- }
- }
- public function parseResponse($data) {
- return $data;
- }
- public final function invoke() {
- return $this->serializeRequest($this->getCommandId(), $this->getArguments());
- }
- }
- abstract class Predis_InlineCommand extends Predis_Command {
- public function serializeRequest($command, $arguments) {
- if (isset($arguments[0]) && is_array($arguments[0])) {
- $arguments[0] = implode($arguments[0], ' ');
- }
- return $command . (count($arguments) > 0
- ? ' ' . implode($arguments, ' ') . "\r\n" : "\r\n"
- );
- }
- }
- abstract class Predis_BulkCommand extends Predis_Command {
- public function serializeRequest($command, $arguments) {
- $data = array_pop($arguments);
- if (is_array($data)) {
- $data = implode($data, ' ');
- }
- return $command . ' ' . implode($arguments, ' ') . ' ' . strlen($data) .
- "\r\n" . $data . "\r\n";
- }
- }
- abstract class Predis_MultiBulkCommand extends Predis_Command {
- public function serializeRequest($command, $arguments) {
- $cmd_args = null;
- $argsc = count($arguments);
- if ($argsc === 1 && is_array($arguments[0])) {
- $cmd_args = $arguments[0];
- $argsc = count($cmd_args);
- }
- else {
- $cmd_args = $arguments;
- }
- $cmdlen = strlen($command);
- $reqlen = $argsc + 1;
- $buffer = "*{$reqlen}\r\n\${$cmdlen}\r\n{$command}\r\n";
- for ($i = 0; $i < $reqlen - 1; $i++) {
- $argument = $cmd_args[$i];
- $arglen = strlen($argument);
- $buffer .= "\${$arglen}\r\n{$argument}\r\n";
- }
- return $buffer;
- }
- }
- /* ------------------------------------------------------------------------- */
- interface Predis_IResponseHandler {
- function handle(Predis_Connection $connection, $payload);
- }
- class Predis_ResponseStatusHandler implements Predis_IResponseHandler {
- public function handle(Predis_Connection $connection, $status) {
- if ($status === "OK") {
- return true;
- }
- if ($status === "QUEUED") {
- return new Predis_ResponseQueued();
- }
- return $status;
- }
- }
- class Predis_ResponseErrorHandler implements Predis_IResponseHandler {
- public function handle(Predis_Connection $connection, $errorMessage) {
- throw new Predis_ServerException(substr($errorMessage, 4));
- }
- }
- class Predis_ResponseErrorSilentHandler implements Predis_IResponseHandler {
- public function handle(Predis_Connection $connection, $errorMessage) {
- return new Predis_ResponseError(substr($errorMessage, 4));
- }
- }
- class Predis_ResponseBulkHandler implements Predis_IResponseHandler {
- public function handle(Predis_Connection $connection, $lengthString) {
- $length = (int) $lengthString;
- if ($length != $lengthString) {
- Predis_Shared_Utils::onCommunicationException(new Predis_MalformedServerResponse(
- $connection, "Cannot parse '$length' as data length"
- ));
- }
- if ($length >= 0) {
- return substr($connection->readBytes($length + 2), 0, -2);
- }
- if ($length == -1) {
- return null;
- }
- }
- }
- class Predis_ResponseMultiBulkHandler implements Predis_IResponseHandler {
- public function handle(Predis_Connection $connection, $lengthString) {
- $listLength = (int) $lengthString;
- if ($listLength != $lengthString) {
- Predis_Shared_Utils::onCommunicationException(new Predis_MalformedServerResponse(
- $connection, "Cannot parse '$lengthString' as data length"
- ));
- }
- if ($listLength === -1) {
- return null;
- }
- $list = array();
- if ($listLength > 0) {
- $handlers = array();
- $reader = $connection->getResponseReader();
- for ($i = 0; $i < $listLength; $i++) {
- $header = $connection->readLine();
- $prefix = $header[0];
- if (isset($handlers[$prefix])) {
- $handler = $handlers[$prefix];
- }
- else {
- $handler = $reader->getHandler($prefix);
- $handlers[$prefix] = $handler;
- }
- $list[$i] = $handler->handle($connection, substr($header, 1));
- }
- }
- return $list;
- }
- }
- class Predis_ResponseMultiBulkStreamHandler implements Predis_IResponseHandler {
- public function handle(Predis_Connection $connection, $lengthString) {
- $listLength = (int) $lengthString;
- if ($listLength != $lengthString) {
- Predis_Shared_Utils::onCommunicationException(new Predis_MalformedServerResponse(
- $connection, "Cannot parse '$lengthString' as data length"
- ));
- }
- return new Predis_Shared_MultiBulkResponseIterator($connection, $lengthString);
- }
- }
- class Predis_ResponseIntegerHandler implements Predis_IResponseHandler {
- public function handle(Predis_Connection $connection, $number) {
- if (is_numeric($number)) {
- return (int) $number;
- }
- else {
- if ($number !== 'nil') {
- Predis_Shared_Utils::onCommunicationException(new Predis_MalformedServerResponse(
- $connection, "Cannot parse '$number' as numeric response"
- ));
- }
- return null;
- }
- }
- }
- interface Predis_IResponseReader {
- public function read(Predis_Connection $connection);
- public function setOption($option, $value);
- public function getOption($option);
- }
- class Predis_FastResponseReader implements Predis_IResponseReader {
- private $_iterableMultibulk, $_throwErrors;
- public function __construct() {
- $this->_iterableMultibulk = false;
- $this->_throwErrors = true;
- }
- public function read(Predis_Connection $connection) {
- $chunk = $connection->readLine();
- $prefix = $chunk[0];
- $payload = substr($chunk, 1);
- switch ($prefix) {
- case '+': // inline
- switch ($payload) {
- case 'OK':
- return true;
- case 'QUEUED':
- return new Predis_ResponseQueued();
- default:
- return $payload;
- }
- case '$': // bulk
- $size = (int) $payload;
- if ($size === -1) {
- return null;
- }
- return substr($connection->readBytes($size + 2), 0, -2);
- case '*': // multi bulk
- $count = (int) $payload;
- if ($count === -1) {
- return null;
- }
- if ($this->_iterableMultibulk) {
- return new Predis_Shared_MultiBulkResponseIterator($connection, $count);
- }
- $multibulk = array();
- for ($i = 0; $i < $count; $i++) {
- $multibulk[$i] = $this->read($connection);
- }
- return $multibulk;
- case ':': // integer
- return (int) $payload;
- case '-': // error
- $errorMessage = substr($payload, 4);
- if ($this->_throwErrors) {
- throw new Predis_ServerException($errorMessage);
- }
- return new Predis_ResponseError($errorMessage);
- default:
- throw new Predis_CommunicationException(
- $connection, "Unknown prefix: '$prefix'"
- );
- }
- }
- public function setOption($option, $value) {
- switch ($option) {
- case 'iterable_multibulk':
- $this->_iterableMultibulk = (bool) $value;
- break;
- case 'throw_on_error':
- $this->_throwErrors = (bool) $value;
- break;
- }
- }
- public function getOption($option) {
- switch ($option) {
- case 'iterable_multibulk':
- return $this->_iterableMultibulk;
- case 'throw_on_error':
- return $this->_throwErrors;
- }
- }
- }
- class Predis_ResponseReader implements Predis_IResponseReader {
- private $_prefixHandlers;
- public function __construct() {
- $this->initializePrefixHandlers();
- }
- private function initializePrefixHandlers() {
- $this->_prefixHandlers = array(
- Predis_Protocol::PREFIX_STATUS => new Predis_ResponseStatusHandler(),
- Predis_Protocol::PREFIX_ERROR => new Predis_ResponseErrorHandler(),
- Predis_Protocol::PREFIX_INTEGER => new Predis_ResponseIntegerHandler(),
- Predis_Protocol::PREFIX_BULK => new Predis_ResponseBulkHandler(),
- Predis_Protocol::PREFIX_MULTI_BULK => new Predis_ResponseMultiBulkHandler(),
- );
- }
- public function setHandler($prefix, Predis_IResponseHandler $handler) {
- $this->_prefixHandlers[$prefix] = $handler;
- }
- public function getHandler($prefix) {
- if (isset($this->_prefixHandlers[$prefix])) {
- return $this->_prefixHandlers[$prefix];
- }
- }
- public function read(Predis_Connection $connection) {
- $header = $connection->readLine();
- if ($header === '') {
- $this->throwMalformedResponse($connection, 'Unexpected empty header');
- }
- $prefix = $header[0];
- if (!isset($this->_prefixHandlers[$prefix])) {
- $this->throwMalformedResponse($connection, "Unknown prefix '$prefix'");
- }
- $handler = $this->_prefixHandlers[$prefix];
- return $handler->handle($connection, substr($header, 1));
- }
- private function throwMalformedResponse(Predis_Connection $connection, $message) {
- Predis_Shared_Utils::onCommunicationException(new Predis_MalformedServerResponse(
- $connection, $message
- ));
- }
- public function setOption($option, $value) {
- switch ($option) {
- case 'iterable_multibulk':
- $handler = $value ? 'Predis_ResponseMultiBulkStreamHandler' : 'Predis_ResponseMultiBulkHandler';
- $this->_prefixHandlers[Predis_Protocol::PREFIX_MULTI_BULK] = new $handler();
- break;
- case 'throw_on_error':
- $handler = $value ? 'Predis_ResponseErrorHandler' : 'Predis_ResponseErrorSilentHandler';
- $this->_prefixHandlers[Predis_Protocol::PREFIX_ERROR] = new $handler();
- break;
- }
- }
- public function getOption($option) {
- switch ($option) {
- case 'iterable_multibulk':
- return $this->_prefixHandlers[Predis_Protocol::PREFIX_MULTI_BULK] instanceof Predis_ResponseMultiBulkStreamHandler;
- case 'throw_on_error':
- return $this->_prefixHandlers[Predis_Protocol::PREFIX_ERROR] instanceof Predis_ResponseErrorHandler;
- }
- }
- }
- class Predis_ResponseError {
- public $skipParse = true;
- private $_message;
- public function __construct($message) {
- $this->_message = $message;
- }
- public function __get($property) {
- if ($property === 'error') {
- return true;
- }
- if ($property === 'message') {
- return $this->_message;
- }
- }
- public function __isset($property) {
- return $property === 'error';
- }
- public function __toString() {
- return $this->_message;
- }
- }
- class Predis_ResponseQueued {
- public $skipParse = true;
- public function __toString() {
- return Predis_Protocol::QUEUED;
- }
- public function __get($property) {
- if ($property === 'queued') {
- return true;
- }
- }
- public function __isset($property) {
- return $property === 'queued';
- }
- }
- /* ------------------------------------------------------------------------- */
- class Predis_CommandPipeline {
- private $_redisClient, $_pipelineBuffer, $_returnValues, $_running, $_executor;
- public function __construct(Predis_Client $redisClient, Predis_Pipeline_IPipelineExecutor $executor = null) {
- $this->_redisClient = $redisClient;
- $this->_executor = $executor !== null ? $executor : new Predis_Pipeline_StandardExecutor();
- $this->_pipelineBuffer = array();
- $this->_returnValues = array();
- }
- public function __call($method, $arguments) {
- $command = $this->_redisClient->createCommand($method, $arguments);
- $this->recordCommand($command);
- return $this;
- }
- private function recordCommand(Predis_Command $command) {
- $this->_pipelineBuffer[] = $command;
- }
- private function getRecordedCommands() {
- return $this->_pipelineBuffer;
- }
- public function flushPipeline() {
- if (count($this->_pipelineBuffer) > 0) {
- $connection = $this->_redisClient->getConnection();
- $this->_returnValues = array_merge(
- $this->_returnValues,
- $this->_executor->execute($connection, $this->_pipelineBuffer)
- );
- $this->_pipelineBuffer = array();
- }
- return $this;
- }
- private function setRunning($bool) {
- if ($bool == true && $this->_running == true) {
- throw new Predis_ClientException("This pipeline is already opened");
- }
- $this->_running = $bool;
- }
- public function execute($block = null) {
- if ($block && !is_callable($block)) {
- throw new InvalidArgumentException('Argument passed must be a callable object');
- }
- // TODO: do not reuse previously executed pipelines
- $this->setRunning(true);
- $pipelineBlockException = null;
- try {
- if ($block !== null) {
- $block($this);
- }
- $this->flushPipeline();
- }
- catch (Exception $exception) {
- $pipelineBlockException = $exception;
- }
- $this->setRunning(false);
- if ($pipelineBlockException !== null) {
- throw $pipelineBlockException;
- }
- return $this->_returnValues;
- }
- }
- class Predis_MultiExecBlock {
- private $_initialized, $_discarded, $_insideBlock, $_checkAndSet, $_watchedKeys;
- private $_redisClient, $_options, $_commands;
- private $_supportsWatch;
- public function __construct(Predis_Client $redisClient, Array $options = null) {
- $this->checkCapabilities($redisClient);
- $this->_options = isset($options) ? $options : array();
- $this->_redisClient = $redisClient;
- $this->reset();
- }
- private function checkCapabilities(Predis_Client $redisClient) {
- if (Predis_Shared_Utils::isCluster($redisClient->getConnection())) {
- throw new Predis_ClientException(
- 'Cannot initialize a MULTI/EXEC context over a cluster of connections'
- );
- }
- $profile = $redisClient->getProfile();
- if ($profile->supportsCommands(array('multi', 'exec', 'discard')) === false) {
- throw new Predis_ClientException(
- 'The current profile does not support MULTI, EXEC and DISCARD commands'
- );
- }
- $this->_supportsWatch = $profile->supportsCommands(array('watch', 'unwatch'));
- }
- private function isWatchSupported() {
- if ($this->_supportsWatch === false) {
- throw new Predis_ClientException(
- 'The current profile does not support WATCH and UNWATCH commands'
- );
- }
- }
- private function reset() {
- $this->_initialized = false;
- $this->_discarded = false;
- $this->_checkAndSet = false;
- $this->_insideBlock = false;
- $this->_watchedKeys = false;
- $this->_commands = array();
- }
- private function initialize() {
- if ($this->_initialized === true) {
- return;
- }
- $options = &$this->_options;
- $this->_checkAndSet = isset($options['cas']) && $options['cas'];
- if (isset($options['watch'])) {
- $this->watch($options['watch']);
- }
- if (!$this->_checkAndSet || ($this->_discarded && $this->_checkAndSet)) {
- $this->_redisClient->multi();
- if ($this->_discarded) {
- $this->_checkAndSet = false;
- }
- }
- $this->_initialized = true;
- $this->_discarded = false;
- }
- public function __call($method, $arguments) {
- $this->initialize();
- $client = $this->_redisClient;
- if ($this->_checkAndSet) {
- return call_user_func_array(array($client, $method), $arguments);
- }
- $command = $client->createCommand($method, $arguments);
- $response = $client->executeCommand($command);
- if (!$response instanceof Predis_ResponseQueued) {
- $this->malformedServerResponse(
- 'The server did not respond with a QUEUED status reply'
- );
- }
- $this->_commands[] = $command;
- return $this;
- }
- public function watch($keys) {
- $this->isWatchSupported();
- if ($this->_initialized && !$this->_checkAndSet) {
- throw new Predis_ClientException('WATCH inside MULTI is not allowed');
- }
- $this->_watchedKeys = true;
- return $this->_redisClient->watch($keys);
- }
- public function multi() {
- if ($this->_initialized && $this->_checkAndSet) {
- $this->_checkAndSet = false;
- $this->_redisClient->multi();
- return $this;
- }
- $this->initialize();
- return $this;
- }
- public function unwatch() {
- $this->isWatchSupported();
- $this->_watchedKeys = false;
- $this->_redisClient->unwatch();
- return $this;
- }
- public function discard() {
- if ($this->_initialized === true) {
- $command = $this->_checkAndSet ? 'unwatch' : 'discard';
- $this->_redisClient->$command();
- $this->reset();
- $this->_discarded = true;
- }
- return $this;
- }
- public function exec() {
- return $this->execute();
- }
- private function checkBeforeExecution($block) {
- if ($this->_insideBlock === true) {
- throw new Predis_ClientException(
- "Cannot invoke 'execute' or 'exec' inside an active client transaction block"
- );
- }
- if ($block) {
- if (!is_callable($block)) {
- throw new InvalidArgumentException(
- 'Argument passed must be a callable object'
- );
- }
- if (count($this->_commands) > 0) {
- $this->discard();
- throw new Predis_ClientException(
- 'Cannot execute a transaction block after using fluent interface'
- );
- }
- }
- if (isset($this->_options['retry']) && !isset($block)) {
- $this->discard();
- throw new InvalidArgumentException(
- 'Automatic retries can be used only when a transaction block is provided'
- );
- }
- }
- public function execute($block = null) {
- $this->checkBeforeExecution($block);
- $reply = null;
- $returnValues = array();
- $attemptsLeft = isset($this->_options['retry']) ? (int)$this->_options['retry'] : 0;
- do {
- $blockException = null;
- if ($block !== null) {
- $this->_insideBlock = true;
- try {
- $block($this);
- }
- catch (Predis_CommunicationException $exception) {
- $blockException = $exception;
- }
- catch (Predis_ServerException $exception) {
- $blockException = $exception;
- }
- catch (Exception $exception) {
- $blockException = $exception;
- $this->discard();
- }
- $this->_insideBlock = false;
- if ($blockException !== null) {
- throw $blockException;
- }
- }
- if (count($this->_commands) === 0) {
- if ($this->_watchedKeys) {
- $this->discard();
- return;
- }
- return;
- }
- $reply = $this->_redisClient->exec();
- if ($reply === null) {
- if ($attemptsLeft === 0) {
- throw new Predis_AbortedMultiExec(
- 'The current transaction has been aborted by the server'
- );
- }
- $this->reset();
- if (isset($this->_options['on_retry']) && is_callable($this->_options['on_retry'])) {
- call_user_func($this->_options['on_retry'], $this, $attemptsLeft);
- }
- continue;
- }
- break;
- } while ($attemptsLeft-- > 0);
- $execReply = $reply instanceof Iterator ? iterator_to_array($reply) : $reply;
- $sizeofReplies = count($execReply);
- $commands = &$this->_commands;
- if ($sizeofReplies !== count($commands)) {
- $this->malformedServerResponse(
- 'Unexpected number of responses for a MultiExecBlock'
- );
- }
- for ($i = 0; $i < $sizeofReplies; $i++) {
- $returnValues[] = $commands[$i]->parseResponse($execReply[$i] instanceof Iterator
- ? iterator_to_array($execReply[$i])
- : $execReply[$i]
- );
- unset($commands[$i]);
- }
- return $returnValues;
- }
- private function malformedServerResponse($message) {
- // Since a MULTI/EXEC block cannot be initialized over a clustered
- // connection, we can safely assume that Predis_Client::getConnection()
- // will always return an instance of Predis_Connection.
- Predis_Shared_Utils::onCommunicationException(
- new Predis_MalformedServerResponse(
- $this->_redisClient->getConnection(), $message
- )
- );
- }
- }
- class Predis_PubSubContext implements Iterator {
- const SUBSCRIBE = 'subscribe';
- const UNSUBSCRIBE = 'unsubscribe';
- const PSUBSCRIBE = 'psubscribe';
- const PUNSUBSCRIBE = 'punsubscribe';
- const MESSAGE = 'message';
- const PMESSAGE = 'pmessage';
- const STATUS_VALID = 0x0001;
- const STATUS_SUBSCRIBED = 0x0010;
- const STATUS_PSUBSCRIBED = 0x0100;
- private $_redisClient, $_position, $_options;
- public function __construct(Predis_Client $redisClient, Array $options = null) {
- $this->checkCapabilities($redisClient);
- $this->_options = isset($options) ? $options : array();
- $this->_redisClient = $redisClient;
- $this->_statusFlags = self::STATUS_VALID;
- $this->genericSubscribeInit('subscribe');
- $this->genericSubscribeInit('psubscribe');
- }
- public function __destruct() {
- if ($this->valid()) {
- $this->closeContext();
- }
- }
- private function checkCapabilities(Predis_Client $redisClient) {
- if (Predis_Shared_Utils::isCluster($redisClient->getConnection())) {
- throw new Predis_ClientException(
- 'Cannot initialize a PUB/SUB context over a cluster of connections'
- );
- }
- $profile = $redisClient->getProfile();
- $commands = array('publish', 'subscribe', 'unsubscribe', 'psubscribe', 'punsubscribe');
- if ($profile->supportsCommands($commands) === false) {
- throw new Predis_ClientException(
- 'The current profile does not support PUB/SUB related commands'
- );
- }
- }
- private function genericSubscribeInit($subscribeAction) {
- if (isset($this->_options[$subscribeAction])) {
- $this->$subscribeAction($this->_options[$subscribeAction]);
- }
- }
- private function isFlagSet($value) {
- return ($this->_statusFlags & $value) === $value;
- }
- public function subscribe(/* arguments */) {
- $args = func_get_args();
- $this->writeCommand(self::SUBSCRIBE, $args);
- $this->_statusFlags |= self::STATUS_SUBSCRIBED;
- }
- public function unsubscribe(/* arguments */) {
- $args = func_get_args();
- $this->writeCommand(self::UNSUBSCRIBE, $args);
- }
- public function psubscribe(/* arguments */) {
- $args = func_get_args();
- $this->writeCommand(self::PSUBSCRIBE, $args);
- $this->_statusFlags |= self::STATUS_PSUBSCRIBED;
- }
- public function punsubscribe(/* arguments */) {
- $args = func_get_args();
- $this->writeCommand(self::PUNSUBSCRIBE, $args);
- }
- public function closeContext() {
- if ($this->valid()) {
- if ($this->isFlagSet(self::STATUS_SUBSCRIBED)) {
- $this->unsubscribe();
- }
- if ($this->isFlagSet(self::STATUS_PSUBSCRIBED)) {
- $this->punsubscribe();
- }
- }
- }
- private function writeCommand($method, $arguments) {
- if (count($arguments) === 1 && is_array($arguments[0])) {
- $arguments = $arguments[0];
- }
- $command = $this->_redisClient->createCommand($method, $arguments);
- $this->_redisClient->getConnection()->writeCommand($command);
- }
- public function rewind() {
- // NOOP
- }
- public function current() {
- return $this->getValue();
- }
- public function key() {
- return $this->_position;
- }
- public function next() {
- if ($this->isFlagSet(self::STATUS_VALID)) {
- $this->_position++;
- }
- return $this->_position;
- }
- public function valid() {
- $subscriptions = self::STATUS_SUBSCRIBED + self::STATUS_PSUBSCRIBED;
- return $this->isFlagSet(self::STATUS_VALID)
- && ($this->_statusFlags & $subscriptions) > 0;
- }
- private function invalidate() {
- $this->_statusFlags = 0x0000;
- }
- private function getValue() {
- $reader = $this->_redisClient->getResponseReader();
- $connection = $this->_redisClient->getConnection();
- $response = $reader->read($connection);
- switch ($response[0]) {
- case self::SUBSCRIBE:
- case self::UNSUBSCRIBE:
- case self::PSUBSCRIBE:
- case self::PUNSUBSCRIBE:
- if ($response[2] === 0) {
- $this->invalidate();
- }
- case self::MESSAGE:
- return (object) array(
- 'kind' => $response[0],
- 'channel' => $response[1],
- 'payload' => $response[2],
- );
- case self::PMESSAGE:
- return (object) array(
- 'kind' => $response[0],
- 'pattern' => $response[1],
- 'channel' => $response[2],
- 'payload' => $response[3],
- );
- default:
- throw new Predis_ClientException(
- "Received an unknown message type {$response[0]} inside of a pubsub context"
- );
- }
- }
- }
- /* ------------------------------------------------------------------------- */
- class Predis_ConnectionParameters {
- const DEFAULT_SCHEME = 'redis';
- const DEFAULT_HOST = '127.0.0.1';
- const DEFAULT_PORT = 6379;
- const DEFAULT_TIMEOUT = 5;
- private static $_defaultParameters = array(
- 'scheme' => self::DEFAULT_SCHEME,
- 'host' => self::DEFAULT_HOST,
- 'port' => self::DEFAULT_PORT,
- 'database' => null,
- 'password' => null,
- 'connection_async' => false,
- 'connection_persistent' => false,
- 'connection_timeout' => self::DEFAULT_TIMEOUT,
- 'read_write_timeout' => null,
- 'alias' => null,
- 'weight' => null,
- 'path' => null,
- );
- private $_parameters;
- public function __construct($parameters = null) {
- $parameters = $parameters !== null ? $parameters : array();
- $extractor = is_array($parameters) ? 'filter' : 'parseURI';
- $this->_parameters = $this->$extractor($parameters);
- }
- private function parseURI($uri) {
- if (stripos($uri, 'unix') === 0) {
- // Hack to support URIs for UNIX sockets with minimal effort.
- $uri = str_ireplace('unix:///', 'unix://localhost/', $uri);
- }
- if (($parsed = @parse_url($uri)) === false || !isset($parsed['host'])) {
- throw new Predis_ClientException("Invalid URI: $uri");
- }
- if (isset($parsed['query'])) {
- foreach (explode('&', $parsed['query']) as $kv) {
- @list($k, $v) = explode('=', $kv);
- $parsed[$k] = $v;
- }
- unset($parsed['query']);
- }
- return $this->filter($parsed);
- }
- private function filter($parameters) {
- return array_merge(self::$_defaultParameters, $parameters);
- }
- public function __get($parameter) {
- return $this->_parameters[$parameter];
- }
- public function __isset($parameter) {
- return isset($this->_parameters[$parameter]);
- }
- }
- interface Predis_IConnection {
- public function connect();
- public function disconnect();
- public function isConnected();
- public function writeCommand(Predis_Command $command);
- public function readResponse(Predis_Command $command);
- public function executeCommand(Predis_Command $command);
- }
- class Predis_Connection implements Predis_IConnection {
- private static $_allowedSchemes = array('redis', 'tcp', 'unix');
- private $_params, $_socket, $_initCmds, $_reader;
- public function __construct(Predis_ConnectionParameters $parameters, Predis_IResponseReader $reader = null) {
- if (!in_array($parameters->scheme, self::$_allowedSchemes)) {
- throw new InvalidArgumentException("Invalid scheme: {$parameters->scheme}");
- }
- $this->_params = $parameters;
- $this->_initCmds = array();
- $this->_reader = $reader !== null ? $reader : new Predis_FastResponseReader();
- }
- public function __destruct() {
- if (!$this->_params->connection_persistent) {
- $this->disconnect();
- }
- }
- public function isConnected() {
- return isset($this->_socket);
- }
- public function connect() {
- if ($this->isConnected()) {
- throw new Predis_ClientException('Connection already estabilished');
- }
- $initializer = "{$this->_params->scheme}StreamInitializer";
- $this->_socket = $this->$initializer($this->_params);
- if (count($this->_initCmds) > 0){
- $this->sendInitializationCommands();
- }
- }
- private function tcpStreamInitializer(Predis_ConnectionParameters $parameters) {
- return $this->redisStreamInitializer($parameters);
- }
- private function redisStreamInitializer(Predis_ConnectionParameters $parameters) {
- $uri = sprintf('tcp://%s:%d/', $parameters->host, $parameters->port);
- $connectFlags = STREAM_CLIENT_CONNECT;
- if ($parameters->connection_async) {
- $connectFlags |= STREAM_CLIENT_ASYNC_CONNECT;
- }
- if ($parameters->connection_persistent) {
- $connectFlags |= STREAM_CLIENT_PERSISTENT;
- }
- $socket = @stream_socket_client(
- $uri, $errno, $errstr, $parameters->connection_timeout, $connectFlags
- );
- if (!$socket) {
- $this->onCommunicationException(trim($errstr), $errno);
- }
- if (isset($parameters->read_write_timeout)) {
- $rwtimeout = $parameters->read_write_timeout;
- $rwtimeout = $rwtimeout > 0 ? $rwtimeout : -1;
- $timeoutSeconds = floor($parameters->read_write_timeout);
- $timeoutUSeconds = ($rwtimeout - $timeoutSeconds) * 1000000;
- stream_set_timeout($socket, $rwtimeout, $timeoutUSeconds);
- }
- return $socket;
- }
- private function unixStreamInitializer(Predis_ConnectionParameters $parameters) {
- $uri = sprintf('unix:///%s', $parameters->path);
- $connectFlags = STREAM_CLIENT_CONNECT;
- if ($parameters->connection_persistent) {
- $connectFlags |= STREAM_CLIENT_PERSISTENT;
- }
- $socket = @stream_socket_client(
- $uri, $errno, $errstr, $parameters->connection_timeout, $connectFlags
- );
- if (!$socket) {
- $this->onCommunicationException(trim($errstr), $errno);
- }
- return $socket;
- }
- public function disconnect() {
- if ($this->isConnected()) {
- fclose($this->_socket);
- unset($this->_socket);
- }
- }
- public function pushInitCommand(Predis_Command $command){
- $this->_initCmds[] = $command;
- }
- private function sendInitializationCommands() {
- foreach ($this->_initCmds as $command) {
- $this->writeCommand($command);
- }
- foreach ($this->_initCmds as $command) {
- $this->readResponse($command);
- }
- }
- private function onCommunicationException($message, $code = null) {
- Predis_Shared_Utils::onCommunicationException(
- new Predis_CommunicationException($this, $message, $code)
- );
- }
- public function writeCommand(Predis_Command $command) {
- $this->writeBytes($command->invoke());
- }
- public function readResponse(Predis_Command $command) {
- $response = $this->_reader->read($this);
- return isset($response->skipParse) ? $response : $command->parseResponse($response);
- }
- public function executeCommand(Predis_Command $command) {
- $this->writeCommand($command);
- if ($command->closesConnection()) {
- return $this->disconnect();
- }
- return $this->readResponse($command);
- }
- public function rawCommand($rawCommandData, $closesConnection = false) {
- $this->writeBytes($rawCommandData);
- if ($closesConnection) {
- $this->disconnect();
- return;
- }
- return $this->_reader->read($this);
- }
- public function writeBytes($value) {
- $socket = $this->getSocket();
- while (($length = strlen($value)) > 0) {
- $written = fwrite($socket, $value);
- if ($length === $written) {
- return true;
- }
- if ($written === false || $written === 0) {
- $this->onCommunicationException('Error while writing bytes to the server');
- }
- $value = substr($value, $written);
- }
- return true;
- }
- public function readBytes($length) {
- if ($length <= 0) {
- throw new InvalidArgumentException('Length parameter must be greater than 0');
- }
- $socket = $this->getSocket();
- $value = '';
- do {
- $chunk = fread($socket, $length);
- if ($chunk === false || $chunk === '') {
- $this->onCommunicationException('Error while reading bytes from the server');
- }
- $value .= $chunk;
- }
- while (($length -= strlen($chunk)) > 0);
- return $value;
- }
- public function readLine() {
- $socket = $this->getSocket();
- $value = '';
- do {
- $chunk = fgets($socket);
- if ($chunk === false || $chunk === '') {
- $this->onCommunicationException('Error while reading line from the server');
- }
- $value .= $chunk;
- }
- while (substr($value, -2) !== "\r\n");
- return substr($value, 0, -2);
- }
- public function getSocket() {
- if (isset($this->_socket)) {
- return $this->_socket;
- }
- $this->connect();
- return $this->_socket;
- }
- public function getResponseReader() {
- return $this->_reader;
- }
- public function getParameters() {
- return $this->_params;
- }
- public function __toString() {
- return sprintf('%s:%d', $this->_params->host, $this->_params->port);
- }
- }
- class Predis_ConnectionCluster implements Predis_IConnection, IteratorAggregate {
- private $_pool, $_distributor;
- public function __construct(Predis_Distribution_IDistributionStrategy $distributor = null) {
- $this->_pool = array();
- $this->_distributor = $distributor !== null ? $distributor : new Predis_Distribution_HashRing();
- }
- public function isConnected() {
- foreach ($this->_pool as $connection) {
- if ($connection->isConnected()) {
- return true;
- }
- }
- return false;
- }
- public function connect() {
- foreach ($this->_pool as $connection) {
- $connection->connect();
- }
- }
- public function disconnect() {
- foreach ($this->_pool as $connection) {
- $connection->disconnect();
- }
- }
- public function add(Predis_Connection $connection) {
- $parameters = $connection->getParameters();
- if (isset($parameters->alias)) {
- $this->_pool[$parameters->alias] = $connection;
- }
- else {
- $this->_pool[] = $connection;
- }
- $this->_distributor->add($connection, $parameters->weight);
- }
- public function getConnection(Predis_Command $command) {
- if ($command->canBeHashed() === false) {
- throw new Predis_ClientException(
- sprintf("Cannot send '%s' commands to a cluster of connections", $command->getCommandId())
- );
- }
- return $this->_distributor->get($command->getHash($this->_distributor));
- }
- public function getConnectionById($id = null) {
- $alias = $id !== null ? $id : 0;
- return isset($this->_pool[$alias]) ? $this->_pool[$alias] : null;
- }
- public function getIterator() {
- return new ArrayIterator($this->_pool);
- }
- public function writeCommand(Predis_Command $command) {
- $this->getConnection($command)->writeCommand($command);
- }
- public function readResponse(Predis_Command $command) {
- return $this->getConnection($command)->readResponse($command);
- }
- public function executeCommand(Predis_Command $command) {
- $connection = $this->getConnection($command);
- $connection->writeCommand($command);
- return $connection->readResponse($command);
- }
- }
- /* ------------------------------------------------------------------------- */
- abstract class Predis_RedisServerProfile {
- private static $_serverProfiles;
- private $_registeredCommands;
- public function __construct() {
- $this->_registeredCommands = $this->getSupportedCommands();
- }
- public abstract function getVersion();
- protected abstract function getSupportedCommands();
- public static function getDefault() {
- return self::get('default');
- }
- public static function getDevelopment() {
- return self::get('dev');
- }
- private static function predisServerProfiles() {
- return array(
- '1.2' => 'Predis_RedisServer_v1_2',
- '2.0' => 'Predis_RedisServer_v2_0',
- '2.2' => 'Predis_RedisServer_v2_2',
- 'default' => 'Predis_RedisServer_v2_2',
- 'dev' => 'Predis_RedisServer_vNext',
- );
- }
- public static function registerProfile($profileClass, $aliases) {
- if (!isset(self::$_serverProfiles)) {
- self::$_serverProfiles = self::predisServerProfiles();
- }
- $profileReflection = new ReflectionClass($profileClass);
- if (!$profileReflection->isSubclassOf('Predis_RedisServerProfile')) {
- throw new Predis_ClientException("Cannot register '$profileClass' as it is not a valid profile class");
- }
- if (is_array($aliases)) {
- foreach ($aliases as $alias) {
- self::$_serverProfiles[$alias] = $profileClass;
- }
- }
- else {
- self::$_serverProfiles[$aliases] = $profileClass;
- }
- }
- public static function get($version) {
- if (!isset(self::$_serverProfiles)) {
- self::$_serverProfiles = self::predisServerProfiles();
- }
- if (!isset(self::$_serverProfiles[$version])) {
- throw new Predis_ClientException("Unknown server profile: $version");
- }
- $profile = self::$_serverProfiles[$version];
- return new $profile();
- }
- public function supportsCommands(Array $commands) {
- foreach ($commands as $command) {
- if ($this->supportsCommand($command) === false) {
- return false;
- }
- }
- return true;
- }
- public function supportsCommand($command) {
- return isset($this->_registeredCommands[$command]);
- }
- public function createCommand($method, $arguments = array()) {
- if (!isset($this->_registeredCommands[$method])) {
- throw new Predis_ClientException("'$method' is not a registered Redis command");
- }
- $commandClass = $this->_registeredCommands[$method];
- $command = new $commandClass();
- $command->setArgumentsArray($arguments);
- return $command;
- }
- public function registerCommands(Array $commands) {
- foreach ($commands as $command => $aliases) {
- $this->registerCommand($command, $aliases);
- }
- }
- public function registerCommand($command, $aliases) {
- $commandReflection = new ReflectionClass($command);
- if (!$commandReflection->isSubclassOf('Predis_Command')) {
- throw new ClientException("Cannot register '$command' as it is not a valid Redis command");
- }
- if (is_array($aliases)) {
- foreach ($aliases as $alias) {
- $this->_registeredCommands[$alias] = $command;
- }
- }
- else {
- $this->_registeredCommands[$aliases] = $command;
- }
- }
- public function __toString() {
- return $this->getVersion();
- }
- }
- class Predis_RedisServer_v1_2 extends Predis_RedisServerProfile {
- public function getVersion() { return '1.2'; }
- public function getSupportedCommands() {
- return array(
- /* ---------------- Redis 1.2 ---------------- */
- /* miscellaneous commands */
- 'ping' => 'Predis_Commands_Ping',
- 'echo' => 'Predis_Commands_DoEcho',
- 'auth' => 'Predis_Commands_Auth',
- /* connection handling */
- 'quit' => 'Predis_Commands_Quit',
- /* commands operating on string values */
- 'set' => 'Predis_Commands_Set',
- 'setnx' => 'Predis_Commands_SetPreserve',
- 'mset' => 'Predis_Commands_SetMultiple',
- 'msetnx' => 'Predis_Commands_SetMultiplePreserve',
- 'get' => 'Predis_Commands_Get',
- 'mget' => 'Predis_Commands_GetMultiple',
- 'getset' => 'Predis_Commands_GetSet',
- 'incr' => 'Predis_Commands_Increment',
- 'incrby' => 'Predis_Commands_IncrementBy',
- 'decr' => 'Predis_Commands_Decrement',
- 'decrby' => 'Predis_Commands_DecrementBy',
- 'exists' => 'Predis_Commands_Exists',
- 'del' => 'Predis_Commands_Delete',
- 'type' => 'Predis_Commands_Type',
- /* commands operating on the key space */
- 'keys' => 'Predis_Commands_Keys_v1_2',
- 'randomkey' => 'Predis_Commands_RandomKey',
- 'rename' => 'Predis_Commands_Rename',
- 'renamenx' => 'Predis_Commands_RenamePreserve',
- 'expire' => 'Predis_Commands_Expire',
- 'expireat' => 'Predis_Commands_ExpireAt',
- 'dbsize' => 'Predis_Commands_DatabaseSize',
- 'ttl' => 'Predis_Commands_TimeToLive',
- /* commands operating on lists */
- 'rpush' => 'Predis_Commands_ListPushTail',
- 'lpush' => 'Predis_Commands_ListPushHead',
- 'llen' => 'Predis_Commands_ListLength',
- 'lrange' => 'Predis_Commands_ListRange',
- 'ltrim' => 'Predis_Commands_ListTrim',
- 'lindex' => 'Predis_Commands_ListIndex',
- 'lset' => 'Predis_Commands_ListSet',
- 'lrem' => 'Predis_Commands_ListRemove',
- 'lpop' => 'Predis_Commands_ListPopFirst',
- 'rpop' => 'Predis_Commands_ListPopLast',
- 'rpoplpush' => 'Predis_Commands_ListPopLastPushHead',
- /* commands operating on sets */
- 'sadd' => 'Predis_Commands_SetAdd',
- 'srem' => 'Predis_Commands_SetRemove',
- 'spop' => 'Predis_Commands_SetPop',
- 'smove' => 'Predis_Commands_SetMove',
- 'scard' => 'Predis_Commands_SetCardinality',
- 'sismember' => 'Predis_Commands_SetIsMember',
- 'sinter' => 'Predis_Commands_SetIntersection',
- 'sinterstore' => 'Predis_Commands_SetIntersectionStore',
- 'sunion' => 'Predis_Commands_SetUnion',
- 'sunionstore' => 'Predis_Commands_SetUnionStore',
- 'sdiff' => 'Predis_Commands_SetDifference',
- 'sdiffstore' => 'Predis_Commands_SetDifferenceStore',
- 'smembers' => 'Predis_Commands_SetMembers',
- 'srandmember' => 'Predis_Commands_SetRandomMember',
- /* commands operating on sorted sets */
- 'zadd' => 'Predis_Commands_ZSetAdd',
- 'zincrby' => 'Predis_Commands_ZSetIncrementBy',
- 'zrem' => 'Predis_Commands_ZSetRemove',
- 'zrange' => 'Predis_Commands_ZSetRange',
- 'zrevrange' => 'Predis_Commands_ZSetReverseRange',
- 'zrangebyscore' => 'Predis_Commands_ZSetRangeByScore',
- 'zcard' => 'Predis_Commands_ZSetCardinality',
- 'zscore' => 'Predis_Commands_ZSetScore',
- 'zremrangebyscore' => 'Predis_Commands_ZSetRemoveRangeByScore',
- /* multiple databases handling commands */
- 'select' => 'Predis_Commands_SelectDatabase',
- 'move' => 'Predis_Commands_MoveKey',
- 'flushdb' => 'Predis_Commands_FlushDatabase',
- 'flushall' => 'Predis_Commands_FlushAll',
- /* sorting */
- 'sort' => 'Predis_Commands_Sort',
- /* remote server control commands */
- 'info' => 'Predis_Commands_Info',
- 'slaveof' => 'Predis_Commands_SlaveOf',
- /* persistence control commands */
- 'save' => 'Predis_Commands_Save',
- 'bgsave' => 'Predis_Commands_BackgroundSave',
- 'lastsave' => 'Predis_Commands_LastSave',
- 'shutdown' => 'Predis_Commands_Shutdown',
- 'bgrewriteaof' => 'Predis_Commands_BackgroundRewriteAppendOnlyFile',
- );
- }
- }
- class Predis_RedisServer_v2_0 extends Predis_RedisServerProfile {
- public function getVersion() { return '2.0'; }
- public function getSupportedCommands() {
- return array(
- /* ---------------- Redis 1.2 ---------------- */
- /* miscellaneous commands */
- 'ping' => 'Predis_Commands_Ping',
- 'echo' => 'Predis_Commands_DoEcho',
- 'auth' => 'Predis_Commands_Auth',
- /* connection handling */
- 'quit' => 'Predis_Commands_Quit',
- /* commands operating on string values */
- 'set' => 'Predis_Commands_Set',
- 'setnx' => 'Predis_Commands_SetPreserve',
- 'mset' => 'Predis_Commands_SetMultiple',
- 'msetnx' => 'Predis_Commands_SetMultiplePreserve',
- 'get' => 'Predis_Commands_Get',
- 'mget' => 'Predis_Commands_GetMultiple',
- 'getset' => 'Predis_Commands_GetSet',
- 'incr' => 'Predis_Commands_Increment',
- 'incrby' => 'Predis_Commands_IncrementBy',
- 'decr' => 'Predis_Commands_Decrement',
- 'decrby' => 'Predis_Commands_DecrementBy',
- 'exists' => 'Predis_Commands_Exists',
- 'del' => 'Predis_Commands_Delete',
- 'type' => 'Predis_Commands_Type',
- /* commands operating on the key space */
- 'keys' => 'Predis_Commands_Keys',
- 'randomkey' => 'Predis_Commands_RandomKey',
- 'rename' => 'Predis_Commands_Rename',
- 'renamenx' => 'Predis_Commands_RenamePreserve',
- 'expire' => 'Predis_Commands_Expire',
- 'expireat' => 'Predis_Commands_ExpireAt',
- 'dbsize' => 'Predis_Commands_DatabaseSize',
- 'ttl' => 'Predis_Commands_TimeToLive',
- /* commands operating on lists */
- 'rpush' => 'Predis_Commands_ListPushTail',
- 'lpush' => 'Predis_Commands_ListPushHead',
- 'llen' => 'Predis_Commands_ListLength',
- 'lrange' => 'Predis_Commands_ListRange',
- 'ltrim' => 'Predis_Commands_ListTrim',
- 'lindex' => 'Predis_Commands_ListIndex',
- 'lset' => 'Predis_Commands_ListSet',
- 'lrem' => 'Predis_Commands_ListRemove',
- 'lpop' => 'Predis_Commands_ListPopFirst',
- 'rpop' => 'Predis_Commands_ListPopLast',
- 'rpoplpush' => 'Predis_Commands_ListPopLastPushHead',
- /* commands operating on sets */
- 'sadd' => 'Predis_Commands_SetAdd',
- 'srem' => 'Predis_Commands_SetRemove',
- 'spop' => 'Predis_Commands_SetPop',
- 'smove' => 'Predis_Commands_SetMove',
- 'scard' => 'Predis_Commands_SetCardinality',
- 'sismember' => 'Predis_Commands_SetIsMember',
- 'sinter' => 'Predis_Commands_SetIntersection',
- 'sinterstore' => 'Predis_Commands_SetIntersectionStore',
- 'sunion' => 'Predis_Commands_SetUnion',
- 'sunionstore' => 'Predis_Commands_SetUnionStore',
- 'sdiff' => 'Predis_Commands_SetDifference',
- 'sdiffstore' => 'Predis_Commands_SetDifferenceStore',
- 'smembers' => 'Predis_Commands_SetMembers',
- 'srandmember' => 'Predis_Commands_SetRandomMember',
- /* commands operating on sorted sets */
- 'zadd' => 'Predis_Commands_ZSetAdd',
- 'zincrby' => 'Predis_Commands_ZSetIncrementBy',
- 'zrem' => 'Predis_Commands_ZSetRemove',
- 'zrange' => 'Predis_Commands_ZSetRange',
- 'zrevrange' => 'Predis_Commands_ZSetReverseRange',
- 'zrangebyscore' => 'Predis_Commands_ZSetRangeByScore',
- 'zcard' => 'Predis_Commands_ZSetCardinality',
- 'zscore' => 'Predis_Commands_ZSetScore',
- 'zremrangebyscore' => 'Predis_Commands_ZSetRemoveRangeByScore',
- /* multiple databases handling commands */
- 'select' => 'Predis_Commands_SelectDatabase',
- 'move' => 'Predis_Commands_MoveKey',
- 'flushdb' => 'Predis_Commands_FlushDatabase',
- 'flushall' => 'Predis_Commands_FlushAll',
- /* sorting */
- 'sort' => 'Predis_Commands_Sort',
- /* remote server control commands */
- 'info' => 'Predis_Commands_Info',
- 'slaveof' => 'Predis_Commands_SlaveOf',
- /* persistence control commands */
- 'save' => 'Predis_Commands_Save',
- 'bgsave' => 'Predis_Commands_BackgroundSave',
- 'lastsave' => 'Predis_Commands_LastSave',
- 'shutdown' => 'Predis_Commands_Shutdown',
- 'bgrewriteaof' => 'Predis_Commands_BackgroundRewriteAppendOnlyFile',
- /* ---------------- Redis 2.0 ---------------- */
- /* transactions */
- 'multi' => 'Predis_Commands_Multi',
- 'exec' => 'Predis_Commands_Exec',
- 'discard' => 'Predis_Commands_Discard',
- /* commands operating on string values */
- 'setex' => 'Predis_Commands_SetExpire',
- 'append' => 'Predis_Commands_Append',
- 'substr' => 'Predis_Commands_Substr',
- /* commands operating on lists */
- 'blpop' => 'Predis_Commands_ListPopFirstBlocking',
- 'brpop' => 'Predis_Commands_ListPopLastBlocking',
- /* commands operating on sorted sets */
- 'zunionstore' => 'Predis_Commands_ZSetUnionStore',
- 'zinterstore' => 'Predis_Commands_ZSetIntersectionStore',
- 'zcount' => 'Predis_Commands_ZSetCount',
- 'zrank' => 'Predis_Commands_ZSetRank',
- 'zrevrank' => 'Predis_Commands_ZSetReverseRank',
- 'zremrangebyrank' => 'Predis_Commands_ZSetRemoveRangeByRank',
- /* commands operating on hashes */
- 'hset' => 'Predis_Commands_HashSet',
- 'hsetnx' => 'Predis_Commands_HashSetPreserve',
- 'hmset' => 'Predis_Commands_HashSetMultiple',
- 'hincrby' => 'Predis_Commands_HashIncrementBy',
- 'hget' => 'Predis_Commands_HashGet',
- 'hmget' => 'Predis_Commands_HashGetMultiple',
- 'hdel' => 'Predis_Commands_HashDelete',
- 'hexists' => 'Predis_Commands_HashExists',
- 'hlen' => 'Predis_Commands_HashLength',
- 'hkeys' => 'Predis_Commands_HashKeys',
- 'hvals' => 'Predis_Commands_HashValues',
- 'hgetall' => 'Predis_Commands_HashGetAll',
- /* publish - subscribe */
- 'subscribe' => 'Predis_Commands_Subscribe',
- 'unsubscribe' => 'Predis_Commands_Unsubscribe',
- 'psubscribe' => 'Predis_Commands_SubscribeByPattern',
- 'punsubscribe' => 'Predis_Commands_UnsubscribeByPattern',
- 'publish' => 'Predis_Commands_Publish',
- /* remote server control commands */
- 'config' => 'Predis_Commands_Config',
- );
- }
- }
- class Predis_RedisServer_v2_2 extends Predis_RedisServerProfile {
- public function getVersion() { return '2.2'; }
- public function getSupportedCommands() {
- return array(
- /* ---------------- Redis 1.2 ---------------- */
- /* miscellaneous commands */
- 'ping' => 'Predis_Commands_Ping',
- 'echo' => 'Predis_Commands_DoEcho',
- 'auth' => 'Predis_Commands_Auth',
- /* connection handling */
- 'quit' => 'Predis_Commands_Quit',
- /* commands operating on string values */
- 'set' => 'Predis_Commands_Set',
- 'setnx' => 'Predis_Commands_SetPreserve',
- 'mset' => 'Predis_Commands_SetMultiple',
- 'msetnx' => 'Predis_Commands_SetMultiplePreserve',
- 'get' => 'Predis_Commands_Get',
- 'mget' => 'Predis_Commands_GetMultiple',
- 'getset' => 'Predis_Commands_GetSet',
- 'incr' => 'Predis_Commands_Increment',
- 'incrby' => 'Predis_Commands_IncrementBy',
- 'decr' => 'Predis_Commands_Decrement',
- 'decrby' => 'Predis_Commands_DecrementBy',
- 'exists' => 'Predis_Commands_Exists',
- 'del' => 'Predis_Commands_Delete',
- 'type' => 'Predis_Commands_Type',
- /* commands operating on the key space */
- 'keys' => 'Predis_Commands_Keys',
- 'randomkey' => 'Predis_Commands_RandomKey',
- 'rename' => 'Predis_Commands_Rename',
- 'renamenx' => 'Predis_Commands_RenamePreserve',
- 'expire' => 'Predis_Commands_Expire',
- 'expireat' => 'Predis_Commands_ExpireAt',
- 'dbsize' => 'Predis_Commands_DatabaseSize',
- 'ttl' => 'Predis_Commands_TimeToLive',
- /* commands operating on lists */
- 'rpush' => 'Predis_Commands_ListPushTail',
- 'lpush' => 'Predis_Commands_ListPushHead',
- 'llen' => 'Predis_Commands_ListLength',
- 'lrange' => 'Predis_Commands_ListRange',
- 'ltrim' => 'Predis_Commands_ListTrim',
- 'lindex' => 'Predis_Commands_ListIndex',
- 'lset' => 'Predis_Commands_ListSet',
- 'lrem' => 'Predis_Commands_ListRemove',
- 'lpop' => 'Predis_Commands_ListPopFirst',
- 'rpop' => 'Predis_Commands_ListPopLast',
- 'rpoplpush' => 'Predis_Commands_ListPopLastPushHead',
- /* commands operating on sets */
- 'sadd' => 'Predis_Commands_SetAdd',
- 'srem' => 'Predis_Commands_SetRemove',
- 'spop' => 'Predis_Commands_SetPop',
- 'smove' => 'Predis_Commands_SetMove',
- 'scard' => 'Predis_Commands_SetCardinality',
- 'sismember' => 'Predis_Commands_SetIsMember',
- 'sinter' => 'Predis_Commands_SetIntersection',
- 'sinterstore' => 'Predis_Commands_SetIntersectionStore',
- 'sunion' => 'Predis_Commands_SetUnion',
- 'sunionstore' => 'Predis_Commands_SetUnionStore',
- 'sdiff' => 'Predis_Commands_SetDifference',
- 'sdiffstore' => 'Predis_Commands_SetDifferenceStore',
- 'smembers' => 'Predis_Commands_SetMembers',
- 'srandmember' => 'Predis_Commands_SetRandomMember',
- /* commands operating on sorted sets */
- 'zadd' => 'Predis_Commands_ZSetAdd',
- 'zincrby' => 'Predis_Commands_ZSetIncrementBy',
- 'zrem' => 'Predis_Commands_ZSetRemove',
- 'zrange' => 'Predis_Commands_ZSetRange',
- 'zrevrange' => 'Predis_Commands_ZSetReverseRange',
- 'zrangebyscore' => 'Predis_Commands_ZSetRangeByScore',
- 'zcard' => 'Predis_Commands_ZSetCardinality',
- 'zscore' => 'Predis_Commands_ZSetScore',
- 'zremrangebyscore' => 'Predis_Commands_ZSetRemoveRangeByScore',
- /* multiple databases handling commands */
- 'select' => 'Predis_Commands_SelectDatabase',
- 'move' => 'Predis_Commands_MoveKey',
- 'flushdb' => 'Predis_Commands_FlushDatabase',
- 'flushall' => 'Predis_Commands_FlushAll',
- /* sorting */
- 'sort' => 'Predis_Commands_Sort',
- /* remote server control commands */
- 'info' => 'Predis_Commands_Info',
- 'slaveof' => 'Predis_Commands_SlaveOf',
- /* persistence control commands */
- 'save' => 'Predis_Commands_Save',
- 'bgsave' => 'Predis_Commands_BackgroundSave',
- 'lastsave' => 'Predis_Commands_LastSave',
- 'shutdown' => 'Predis_Commands_Shutdown',
- 'bgrewriteaof' => 'Predis_Commands_BackgroundRewriteAppendOnlyFile',
- /* ---------------- Redis 2.0 ---------------- */
- /* transactions */
- 'multi' => 'Predis_Commands_Multi',
- 'exec' => 'Predis_Commands_Exec',
- 'discard' => 'Predis_Commands_Discard',
- /* commands operating on string values */
- 'setex' => 'Predis_Commands_SetExpire',
- 'append' => 'Predis_Commands_Append',
- 'substr' => 'Predis_Commands_Substr',
- /* commands operating on lists */
- 'blpop' => 'Predis_Commands_ListPopFirstBlocking',
- 'brpop' => 'Predis_Commands_ListPopLastBlocking',
- /* commands operating on sorted sets */
- 'zunionstore' => 'Predis_Commands_ZSetUnionStore',
- 'zinterstore' => 'Predis_Commands_ZSetIntersectionStore',
- 'zcount' => 'Predis_Commands_ZSetCount',
- 'zrank' => 'Predis_Commands_ZSetRank',
- 'zrevrank' => 'Predis_Commands_ZSetReverseRank',
- 'zremrangebyrank' => 'Predis_Commands_ZSetRemoveRangeByRank',
- /* commands operating on hashes */
- 'hset' => 'Predis_Commands_HashSet',
- 'hsetnx' => 'Predis_Commands_HashSetPreserve',
- 'hmset' => 'Predis_Commands_HashSetMultiple',
- 'hincrby' => 'Predis_Commands_HashIncrementBy',
- 'hget' => 'Predis_Commands_HashGet',
- 'hmget' => 'Predis_Commands_HashGetMultiple',
- 'hdel' => 'Predis_Commands_HashDelete',
- 'hexists' => 'Predis_Commands_HashExists',
- 'hlen' => 'Predis_Commands_HashLength',
- 'hkeys' => 'Predis_Commands_HashKeys',
- 'hvals' => 'Predis_Commands_HashValues',
- 'hgetall' => 'Predis_Commands_HashGetAll',
- /* publish - subscribe */
- 'subscribe' => 'Predis_Commands_Subscribe',
- 'unsubscribe' => 'Predis_Commands_Unsubscribe',
- 'psubscribe' => 'Predis_Commands_SubscribeByPattern',
- 'punsubscribe' => 'Predis_Commands_UnsubscribeByPattern',
- 'publish' => 'Predis_Commands_Publish',
- /* remote server control commands */
- 'config' => 'Predis_Commands_Config',
- /* ---------------- Redis 2.2 ---------------- */
- /* transactions */
- 'watch' => 'Predis_Commands_Watch',
- 'unwatch' => 'Predis_Commands_Unwatch',
- /* commands operating on string values */
- 'strlen' => 'Predis_Commands_Strlen',
- 'setrange' => 'Predis_Commands_SetRange',
- 'getrange' => 'Predis_Commands_Substr',
- 'setbit' => 'Predis_Commands_SetBit',
- 'getbit' => 'Predis_Commands_GetBit',
- /* commands operating on the key space */
- 'persist' => 'Predis_Commands_Persist',
- /* commands operating on lists */
- 'rpushx' => 'Predis_Commands_ListPushTailX',
- 'lpushx' => 'Predis_Commands_ListPushHeadX',
- 'linsert' => 'Predis_Commands_ListInsert',
- 'brpoplpush' => 'Predis_Commands_ListPopLastPushHeadBlocking',
- /* commands operating on sorted sets */
- 'zrevrangebyscore' => 'Predis_Commands_ZSetReverseRangeByScore',
- );
- }
- }
- class Predis_RedisServer_vNext extends Predis_RedisServer_v2_2 {
- public function getVersion() { return 'DEV'; }
- public function getSupportedCommands() {
- return array_merge(parent::getSupportedCommands(), array(
- /* remote server control commands */
- 'info' => 'Predis_Commands_Info_v24',
- ));
- }
- }
- /* ------------------------------------------------------------------------- */
- interface Predis_Pipeline_IPipelineExecutor {
- public function execute(Predis_IConnection $connection, &$commands);
- }
- class Predis_Pipeline_StandardExecutor implements Predis_Pipeline_IPipelineExecutor {
- public function execute(Predis_IConnection $connection, &$commands) {
- $sizeofPipe = count($commands);
- $values = array();
- foreach ($commands as $command) {
- $connection->writeCommand($command);
- }
- try {
- for ($i = 0; $i < $sizeofPipe; $i++) {
- $response = $connection->readResponse($commands[$i]);
- $values[] = $response instanceof Iterator
- ? iterator_to_array($response)
- : $response;
- unset($commands[$i]);
- }
- }
- catch (Predis_ServerException $exception) {
- // force disconnection to prevent protocol desynchronization
- $connection->disconnect();
- throw $exception;
- }
- return $values;
- }
- }
- class Predis_Pipeline_SafeExecutor implements Predis_Pipeline_IPipelineExecutor {
- public function execute(Predis_IConnection $connection, &$commands) {
- $sizeofPipe = count($commands);
- $values = array();
- foreach ($commands as $command) {
- try {
- $connection->writeCommand($command);
- }
- catch (Predis_CommunicationException $exception) {
- return array_fill(0, $sizeofPipe, $exception);
- }
- }
- for ($i = 0; $i < $sizeofPipe; $i++) {
- $command = $commands[$i];
- unset($commands[$i]);
- try {
- $response = $connection->readResponse($command);
- $values[] = ($response instanceof Iterator
- ? iterator_to_array($response)
- : $response
- );
- }
- catch (Predis_ServerException $exception) {
- $values[] = $exception->toResponseError();
- }
- catch (Predis_CommunicationException $exception) {
- $toAdd = count($commands) - count($values);
- $values = array_merge($values, array_fill(0, $toAdd, $exception));
- break;
- }
- }
- return $values;
- }
- }
- class Predis_Pipeline_SafeClusterExecutor implements Predis_Pipeline_IPipelineExecutor {
- public function execute(Predis_IConnection $connection, &$commands) {
- $connectionExceptions = array();
- $sizeofPipe = count($commands);
- $values = array();
- foreach ($commands as $command) {
- $cmdConnection = $connection->getConnection($command);
- if (isset($connectionExceptions[spl_object_hash($cmdConnection)])) {
- continue;
- }
- try {
- $cmdConnection->writeCommand($command);
- }
- catch (Predis_CommunicationException $exception) {
- $connectionExceptions[spl_object_hash($cmdConnection)] = $exception;
- }
- }
- for ($i = 0; $i < $sizeofPipe; $i++) {
- $command = $commands[$i];
- unset($commands[$i]);
- $cmdConnection = $connection->getConnection($command);
- $connectionObjectHash = spl_object_hash($cmdConnection);
- if (isset($connectionExceptions[$connectionObjectHash])) {
- $values[] = $connectionExceptions[$connectionObjectHash];
- continue;
- }
- try {
- $response = $cmdConnection->readResponse($command);
- $values[] = ($response instanceof Iterator
- ? iterator_to_array($response)
- : $response
- );
- }
- catch (Predis_ServerException $exception) {
- $values[] = $exception->toResponseError();
- }
- catch (Predis_CommunicationException $exception) {
- $values[] = $exception;
- $connectionExceptions[$connectionObjectHash] = $exception;
- }
- }
- return $values;
- }
- }
- /* ------------------------------------------------------------------------- */
- interface Predis_Distribution_IDistributionStrategy {
- public function add($node, $weight = null);
- public function remove($node);
- public function get($key);
- public function generateKey($value);
- }
- class Predis_Distribution_EmptyRingException extends Exception { }
- class Predis_Distribution_HashRing implements Predis_Distribution_IDistributionStrategy {
- const DEFAULT_REPLICAS = 128;
- const DEFAULT_WEIGHT = 100;
- private $_nodes, $_ring, $_ringKeys, $_ringKeysCount, $_replicas;
- public function __construct($replicas = self::DEFAULT_REPLICAS) {
- $this->_replicas = $replicas;
- $this->_nodes = array();
- }
- public function add($node, $weight = null) {
- // NOTE: in case of collisions in the hashes of the nodes, the node added
- // last wins, thus the order in which nodes are added is significant.
- // TODO: self::DEFAULT_WEIGHT does not work for inherited classes that
- // override the DEFAULT_WEIGHT constant.
- $this->_nodes[] = array(
- 'object' => $node,
- 'weight' => (int) ($weight !== null ? $weight : self::DEFAULT_WEIGHT),
- );
- $this->reset();
- }
- public function remove($node) {
- // NOTE: a node is removed by resetting the ring so that it's recreated from
- // scratch, in order to reassign possible hashes with collisions to the
- // right node according to the order in which they were added in the
- // first place.
- for ($i = 0; $i < count($this->_nodes); ++$i) {
- if ($this->_nodes[$i]['object'] === $node) {
- array_splice($this->_nodes, $i, 1);
- $this->reset();
- break;
- }
- }
- }
- private function reset() {
- unset($this->_ring);
- unset($this->_ringKeys);
- unset($this->_ringKeysCount);
- }
- private function isInitialized() {
- return isset($this->_ringKeys);
- }
- private function computeTotalWeight() {
- $totalWeight = 0;
- foreach ($this->_nodes as $node) {
- $totalWeight += $node['weight'];
- }
- return $totalWeight;
- }
- private function initialize() {
- if ($this->isInitialized()) {
- return;
- }
- if (count($this->_nodes) === 0) {
- throw new Predis_Distribution_EmptyRingException('Cannot initialize empty hashring');
- }
- $this->_ring = array();
- $totalWeight = $this->computeTotalWeight();
- $nodesCount = count($this->_nodes);
- foreach ($this->_nodes as $node) {
- $weightRatio = $node['weight'] / $totalWeight;
- $this->addNodeToRing($this->_ring, $node, $nodesCount, $this->_replicas, $weightRatio);
- }
- ksort($this->_ring, SORT_NUMERIC);
- $this->_ringKeys = array_keys($this->_ring);
- $this->_ringKeysCount = count($this->_ringKeys);
- }
- protected function addNodeToRing(&$ring, $node, $totalNodes, $replicas, $weightRatio) {
- $nodeObject = $node['object'];
- $nodeHash = (string) $nodeObject;
- $replicas = (int) round($weightRatio * $totalNodes * $replicas);
- for ($i = 0; $i < $replicas; $i++) {
- $key = crc32("$nodeHash:$i");
- $ring[$key] = $nodeObject;
- }
- }
- public function generateKey($value) {
- return crc32($value);
- }
- public function get($key) {
- return $this->_ring[$this->getNodeKey($key)];
- }
- private function getNodeKey($key) {
- $this->initialize();
- $ringKeys = $this->_ringKeys;
- $upper = $this->_ringKeysCount - 1;
- $lower = 0;
- while ($lower <= $upper) {
- $index = ($lower + $upper) >> 1;
- $item = $ringKeys[$index];
- if ($item > $key) {
- $upper = $index - 1;
- }
- else if ($item < $key) {
- $lower = $index + 1;
- }
- else {
- return $item;
- }
- }
- return $ringKeys[$this->wrapAroundStrategy($upper, $lower, $this->_ringKeysCount)];
- }
- protected function wrapAroundStrategy($upper, $lower, $ringKeysCount) {
- // NOTE: binary search for the last item in _ringkeys with a value
- // less or equal to the key. If no such item exists, return the
- // last item.
- return $upper >= 0 ? $upper : $ringKeysCount - 1;
- }
- }
- class Predis_Distribution_KetamaPureRing extends Predis_Distribution_HashRing {
- const DEFAULT_REPLICAS = 160;
- public function __construct() {
- parent::__construct(self::DEFAULT_REPLICAS);
- }
- protected function addNodeToRing(&$ring, $node, $totalNodes, $replicas, $weightRatio) {
- $nodeObject = $node['object'];
- $nodeHash = (string) $nodeObject;
- $replicas = (int) floor($weightRatio * $totalNodes * ($replicas / 4));
- for ($i = 0; $i < $replicas; $i++) {
- $unpackedDigest = unpack('V4', md5("$nodeHash-$i", true));
- foreach ($unpackedDigest as $key) {
- $ring[$key] = $nodeObject;
- }
- }
- }
- public function generateKey($value) {
- $hash = unpack('V', md5($value, true));
- return $hash[1];
- }
- protected function wrapAroundStrategy($upper, $lower, $ringKeysCount) {
- // NOTE: binary search for the first item in _ringkeys with a value
- // greater or equal to the key. If no such item exists, return the
- // first item.
- return $lower < $ringKeysCount ? $lower : 0;
- }
- }
- /* ------------------------------------------------------------------------- */
- class Predis_Shared_Utils {
- public static function isCluster(Predis_IConnection $connection) {
- return $connection instanceof Predis_ConnectionCluster;
- }
- public static function onCommunicationException(Predis_CommunicationException $exception) {
- if ($exception->shouldResetConnection()) {
- $connection = $exception->getConnection();
- if ($connection->isConnected()) {
- $connection->disconnect();
- }
- }
- throw $exception;
- }
- public static function filterArrayArguments(Array $arguments) {
- if (count($arguments) === 1 && is_array($arguments[0])) {
- return $arguments[0];
- }
- return $arguments;
- }
- }
- abstract class Predis_Shared_MultiBulkResponseIteratorBase implements Iterator, Countable {
- protected $_position, $_current, $_replySize;
- public function rewind() {
- // NOOP
- }
- public function current() {
- return $this->_current;
- }
- public function key() {
- return $this->_position;
- }
- public function next() {
- if (++$this->_position < $this->_replySize) {
- $this->_current = $this->getValue();
- }
- return $this->_position;
- }
- public function valid() {
- return $this->_position < $this->_replySize;
- }
- public function count() {
- // NOTE: use count if you want to get the size of the current multi-bulk
- // response without using iterator_count (which actually consumes
- // our iterator to calculate the size, and we cannot perform a rewind)
- return $this->_replySize;
- }
- protected abstract function getValue();
- }
- class Predis_Shared_MultiBulkResponseIterator extends Predis_Shared_MultiBulkResponseIteratorBase {
- private $_connection;
- public function __construct(Predis_Connection $connection, $size) {
- $this->_connection = $connection;
- $this->_reader = $connection->getResponseReader();
- $this->_position = 0;
- $this->_current = $size > 0 ? $this->getValue() : null;
- $this->_replySize = $size;
- }
- public function __destruct() {
- // when the iterator is garbage-collected (e.g. it goes out of the
- // scope of a foreach) but it has not reached its end, we must sync
- // the client with the queued elements that have not been read from
- // the connection with the server.
- $this->sync();
- }
- public function sync($drop = false) {
- if ($drop == true) {
- if ($this->valid()) {
- $this->_position = $this->_replySize;
- $this->_connection->disconnect();
- }
- }
- else {
- while ($this->valid()) {
- $this->next();
- }
- }
- }
- protected function getValue() {
- return $this->_reader->read($this->_connection);
- }
- }
- class Predis_Shared_MultiBulkResponseKVIterator extends Predis_Shared_MultiBulkResponseIteratorBase {
- private $_iterator;
- public function __construct(Predis_Shared_MultiBulkResponseIterator $iterator) {
- $virtualSize = count($iterator) / 2;
- $this->_iterator = $iterator;
- $this->_position = 0;
- $this->_current = $virtualSize > 0 ? $this->getValue() : null;
- $this->_replySize = $virtualSize;
- }
- public function __destruct() {
- $this->_iterator->sync();
- }
- protected function getValue() {
- $k = $this->_iterator->current();
- $this->_iterator->next();
- $v = $this->_iterator->current();
- $this->_iterator->next();
- return array($k, $v);
- }
- }
- /* ------------------------------------------------------------------------- */
- /* miscellaneous commands */
- class Predis_Commands_Ping extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'PING'; }
- public function parseResponse($data) {
- return $data === 'PONG';
- }
- }
- class Predis_Commands_DoEcho extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'ECHO'; }
- }
- class Predis_Commands_Auth extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'AUTH'; }
- }
- /* connection handling */
- class Predis_Commands_Quit extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'QUIT'; }
- public function closesConnection() { return true; }
- }
- /* commands operating on string values */
- class Predis_Commands_Set extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SET'; }
- }
- class Predis_Commands_SetExpire extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SETEX'; }
- }
- class Predis_Commands_SetPreserve extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SETNX'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_SetMultiple extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'MSET'; }
- public function filterArguments(Array $arguments) {
- if (count($arguments) === 1 && is_array($arguments[0])) {
- $flattenedKVs = array();
- $args = &$arguments[0];
- foreach ($args as $k => $v) {
- $flattenedKVs[] = $k;
- $flattenedKVs[] = $v;
- }
- return $flattenedKVs;
- }
- return $arguments;
- }
- }
- class Predis_Commands_SetMultiplePreserve extends Predis_Commands_SetMultiple {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'MSETNX'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_Get extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'GET'; }
- }
- class Predis_Commands_GetMultiple extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'MGET'; }
- public function filterArguments(Array $arguments) {
- return Predis_Shared_Utils::filterArrayArguments($arguments);
- }
- }
- class Predis_Commands_GetSet extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'GETSET'; }
- }
- class Predis_Commands_Increment extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'INCR'; }
- }
- class Predis_Commands_IncrementBy extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'INCRBY'; }
- }
- class Predis_Commands_Decrement extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'DECR'; }
- }
- class Predis_Commands_DecrementBy extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'DECRBY'; }
- }
- class Predis_Commands_Exists extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'EXISTS'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_Delete extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'DEL'; }
- }
- class Predis_Commands_Type extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'TYPE'; }
- }
- class Predis_Commands_Append extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'APPEND'; }
- }
- class Predis_Commands_SetRange extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SETRANGE'; }
- }
- class Predis_Commands_Substr extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SUBSTR'; }
- }
- class Predis_Commands_SetBit extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SETBIT'; }
- }
- class Predis_Commands_GetBit extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'GETBIT'; }
- }
- class Predis_Commands_Strlen extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'STRLEN'; }
- }
- /* commands operating on the key space */
- class Predis_Commands_Keys extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'KEYS'; }
- }
- class Predis_Commands_Keys_v1_2 extends Predis_Commands_Keys {
- public function parseResponse($data) {
- return explode(' ', $data);
- }
- }
- class Predis_Commands_RandomKey extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'RANDOMKEY'; }
- public function parseResponse($data) { return $data !== '' ? $data : null; }
- }
- class Predis_Commands_Rename extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'RENAME'; }
- }
- class Predis_Commands_RenamePreserve extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'RENAMENX'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_Expire extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'EXPIRE'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_ExpireAt extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'EXPIREAT'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_Persist extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'PERSIST'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_DatabaseSize extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'DBSIZE'; }
- }
- class Predis_Commands_TimeToLive extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'TTL'; }
- }
- /* commands operating on lists */
- class Predis_Commands_ListPushTail extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'RPUSH'; }
- }
- class Predis_Commands_ListPushTailX extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'RPUSHX'; }
- }
- class Predis_Commands_ListPushHead extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'LPUSH'; }
- }
- class Predis_Commands_ListPushHeadX extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'LPUSHX'; }
- }
- class Predis_Commands_ListLength extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'LLEN'; }
- }
- class Predis_Commands_ListRange extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'LRANGE'; }
- }
- class Predis_Commands_ListTrim extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'LTRIM'; }
- }
- class Predis_Commands_ListIndex extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'LINDEX'; }
- }
- class Predis_Commands_ListSet extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'LSET'; }
- }
- class Predis_Commands_ListRemove extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'LREM'; }
- }
- class Predis_Commands_ListPopLastPushHead extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'RPOPLPUSH'; }
- }
- class Predis_Commands_ListPopLastPushHeadBlocking extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'BRPOPLPUSH'; }
- }
- class Predis_Commands_ListPopFirst extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'LPOP'; }
- }
- class Predis_Commands_ListPopLast extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'RPOP'; }
- }
- class Predis_Commands_ListPopFirstBlocking extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'BLPOP'; }
- }
- class Predis_Commands_ListPopLastBlocking extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'BRPOP'; }
- }
- class Predis_Commands_ListInsert extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'LINSERT'; }
- }
- /* commands operating on sets */
- class Predis_Commands_SetAdd extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SADD'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_SetRemove extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SREM'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_SetPop extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SPOP'; }
- }
- class Predis_Commands_SetMove extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'SMOVE'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_SetCardinality extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SCARD'; }
- }
- class Predis_Commands_SetIsMember extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SISMEMBER'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_SetIntersection extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SINTER'; }
- public function filterArguments(Array $arguments) {
- return Predis_Shared_Utils::filterArrayArguments($arguments);
- }
- }
- class Predis_Commands_SetIntersectionStore extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SINTERSTORE'; }
- public function filterArguments(Array $arguments) {
- if (count($arguments) === 2 && is_array($arguments[1])) {
- return array_merge(array($arguments[0]), $arguments[1]);
- }
- return $arguments;
- }
- }
- class Predis_Commands_SetUnion extends Predis_Commands_SetIntersection {
- public function getCommandId() { return 'SUNION'; }
- }
- class Predis_Commands_SetUnionStore extends Predis_Commands_SetIntersectionStore {
- public function getCommandId() { return 'SUNIONSTORE'; }
- }
- class Predis_Commands_SetDifference extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SDIFF'; }
- }
- class Predis_Commands_SetDifferenceStore extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SDIFFSTORE'; }
- }
- class Predis_Commands_SetMembers extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SMEMBERS'; }
- }
- class Predis_Commands_SetRandomMember extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SRANDMEMBER'; }
- }
- /* commands operating on sorted sets */
- class Predis_Commands_ZSetAdd extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'ZADD'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_ZSetIncrementBy extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'ZINCRBY'; }
- }
- class Predis_Commands_ZSetRemove extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'ZREM'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_ZSetUnionStore extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'ZUNIONSTORE'; }
- public function filterArguments(Array $arguments) {
- $options = array();
- $argc = count($arguments);
- if ($argc > 2 && is_array($arguments[$argc - 1])) {
- $options = $this->prepareOptions(array_pop($arguments));
- }
- if (is_array($arguments[1])) {
- $arguments = array_merge(
- array($arguments[0], count($arguments[1])),
- $arguments[1]
- );
- }
- return array_merge($arguments, $options);
- }
- private function prepareOptions($options) {
- $opts = array_change_key_case($options, CASE_UPPER);
- $finalizedOpts = array();
- if (isset($opts['WEIGHTS']) && is_array($opts['WEIGHTS'])) {
- $finalizedOpts[] = 'WEIGHTS';
- foreach ($opts['WEIGHTS'] as $weight) {
- $finalizedOpts[] = $weight;
- }
- }
- if (isset($opts['AGGREGATE'])) {
- $finalizedOpts[] = 'AGGREGATE';
- $finalizedOpts[] = $opts['AGGREGATE'];
- }
- return $finalizedOpts;
- }
- }
- class Predis_Commands_ZSetIntersectionStore extends Predis_Commands_ZSetUnionStore {
- public function getCommandId() { return 'ZINTERSTORE'; }
- }
- class Predis_Commands_ZSetRange extends Predis_MultiBulkCommand {
- private $_withScores = false;
- public function getCommandId() { return 'ZRANGE'; }
- public function filterArguments(Array $arguments) {
- if (count($arguments) === 4) {
- $lastType = gettype($arguments[3]);
- if ($lastType === 'string' && strtolower($arguments[3]) === 'withscores') {
- // used for compatibility with older versions
- $arguments[3] = array('WITHSCORES' => true);
- $lastType = 'array';
- }
- if ($lastType === 'array') {
- $options = $this->prepareOptions(array_pop($arguments));
- return array_merge($arguments, $options);
- }
- }
- return $arguments;
- }
- protected function prepareOptions($options) {
- $opts = array_change_key_case($options, CASE_UPPER);
- $finalizedOpts = array();
- if (isset($opts['WITHSCORES'])) {
- $finalizedOpts[] = 'WITHSCORES';
- $this->_withScores = true;
- }
- return $finalizedOpts;
- }
- public function parseResponse($data) {
- if ($this->_withScores) {
- if ($data instanceof Iterator) {
- return new Predis_Shared_MultiBulkResponseKVIterator($data);
- }
- $result = array();
- for ($i = 0; $i < count($data); $i++) {
- $result[] = array($data[$i], $data[++$i]);
- }
- return $result;
- }
- return $data;
- }
- }
- class Predis_Commands_ZSetReverseRange extends Predis_Commands_ZSetRange {
- public function getCommandId() { return 'ZREVRANGE'; }
- }
- class Predis_Commands_ZSetRangeByScore extends Predis_Commands_ZSetRange {
- public function getCommandId() { return 'ZRANGEBYSCORE'; }
- protected function prepareOptions($options) {
- $opts = array_change_key_case($options, CASE_UPPER);
- $finalizedOpts = array();
- if (isset($opts['LIMIT']) && is_array($opts['LIMIT'])) {
- $limit = array_change_key_case($opts['LIMIT'], CASE_UPPER);
- $finalizedOpts[] = 'LIMIT';
- $finalizedOpts[] = isset($limit['OFFSET']) ? $limit['OFFSET'] : $limit[0];
- $finalizedOpts[] = isset($limit['COUNT']) ? $limit['COUNT'] : $limit[1];
- }
- return array_merge($finalizedOpts, parent::prepareOptions($options));
- }
- }
- class Predis_Commands_ZSetReverseRangeByScore extends Predis_Commands_ZSetRangeByScore {
- public function getCommandId() { return 'ZREVRANGEBYSCORE'; }
- }
- class Predis_Commands_ZSetCount extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'ZCOUNT'; }
- }
- class Predis_Commands_ZSetCardinality extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'ZCARD'; }
- }
- class Predis_Commands_ZSetScore extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'ZSCORE'; }
- }
- class Predis_Commands_ZSetRemoveRangeByScore extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'ZREMRANGEBYSCORE'; }
- }
- class Predis_Commands_ZSetRank extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'ZRANK'; }
- }
- class Predis_Commands_ZSetReverseRank extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'ZREVRANK'; }
- }
- class Predis_Commands_ZSetRemoveRangeByRank extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'ZREMRANGEBYRANK'; }
- }
- /* commands operating on hashes */
- class Predis_Commands_HashSet extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'HSET'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_HashSetPreserve extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'HSETNX'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_HashSetMultiple extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'HMSET'; }
- public function filterArguments(Array $arguments) {
- if (count($arguments) === 2 && is_array($arguments[1])) {
- $flattenedKVs = array($arguments[0]);
- $args = &$arguments[1];
- foreach ($args as $k => $v) {
- $flattenedKVs[] = $k;
- $flattenedKVs[] = $v;
- }
- return $flattenedKVs;
- }
- return $arguments;
- }
- }
- class Predis_Commands_HashIncrementBy extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'HINCRBY'; }
- }
- class Predis_Commands_HashGet extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'HGET'; }
- }
- class Predis_Commands_HashGetMultiple extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'HMGET'; }
- public function filterArguments(Array $arguments) {
- if (count($arguments) === 2 && is_array($arguments[1])) {
- $flattenedKVs = array($arguments[0]);
- $args = &$arguments[1];
- foreach ($args as $v) {
- $flattenedKVs[] = $v;
- }
- return $flattenedKVs;
- }
- return $arguments;
- }
- }
- class Predis_Commands_HashDelete extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'HDEL'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_HashExists extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'HEXISTS'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_HashLength extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'HLEN'; }
- }
- class Predis_Commands_HashKeys extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'HKEYS'; }
- }
- class Predis_Commands_HashValues extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'HVALS'; }
- }
- class Predis_Commands_HashGetAll extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'HGETALL'; }
- public function parseResponse($data) {
- if ($data instanceof Iterator) {
- return new Predis_Shared_MultiBulkResponseKVIterator($data);
- }
- $result = array();
- for ($i = 0; $i < count($data); $i++) {
- $result[$data[$i]] = $data[++$i];
- }
- return $result;
- }
- }
- /* multiple databases handling commands */
- class Predis_Commands_SelectDatabase extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'SELECT'; }
- }
- class Predis_Commands_MoveKey extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'MOVE'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_FlushDatabase extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'FLUSHDB'; }
- }
- class Predis_Commands_FlushAll extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'FLUSHALL'; }
- }
- /* sorting */
- class Predis_Commands_Sort extends Predis_MultiBulkCommand {
- public function getCommandId() { return 'SORT'; }
- public function filterArguments(Array $arguments) {
- if (count($arguments) === 1) {
- return $arguments;
- }
- $query = array($arguments[0]);
- $sortParams = array_change_key_case($arguments[1], CASE_UPPER);
- if (isset($sortParams['BY'])) {
- $query[] = 'BY';
- $query[] = $sortParams['BY'];
- }
- if (isset($sortParams['GET'])) {
- $getargs = $sortParams['GET'];
- if (is_array($getargs)) {
- foreach ($getargs as $getarg) {
- $query[] = 'GET';
- $query[] = $getarg;
- }
- }
- else {
- $query[] = 'GET';
- $query[] = $getargs;
- }
- }
- if (isset($sortParams['LIMIT']) && is_array($sortParams['LIMIT'])
- && count($sortParams['LIMIT']) == 2) {
- $query[] = 'LIMIT';
- $query[] = $sortParams['LIMIT'][0];
- $query[] = $sortParams['LIMIT'][1];
- }
- if (isset($sortParams['SORT'])) {
- $query[] = strtoupper($sortParams['SORT']);
- }
- if (isset($sortParams['ALPHA']) && $sortParams['ALPHA'] == true) {
- $query[] = 'ALPHA';
- }
- if (isset($sortParams['STORE'])) {
- $query[] = 'STORE';
- $query[] = $sortParams['STORE'];
- }
- return $query;
- }
- }
- /* transactions */
- class Predis_Commands_Multi extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'MULTI'; }
- }
- class Predis_Commands_Exec extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'EXEC'; }
- }
- class Predis_Commands_Discard extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'DISCARD'; }
- }
- /* publish/subscribe */
- class Predis_Commands_Subscribe extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'SUBSCRIBE'; }
- public function filterArguments(Array $arguments) {
- return Predis_Shared_Utils::filterArrayArguments($arguments);
- }
- }
- class Predis_Commands_Unsubscribe extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'UNSUBSCRIBE'; }
- }
- class Predis_Commands_SubscribeByPattern extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'UNSUBSCRIBE'; }
- public function filterArguments(Array $arguments) {
- return Predis_Shared_Utils::filterArrayArguments($arguments);
- }
- }
- class Predis_Commands_UnsubscribeByPattern extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'PUNSUBSCRIBE'; }
- }
- class Predis_Commands_Publish extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'PUBLISH'; }
- }
- class Predis_Commands_Watch extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'WATCH'; }
- public function filterArguments(Array $arguments) {
- if (isset($arguments[0]) && is_array($arguments[0])) {
- return $arguments[0];
- }
- return $arguments;
- }
- public function parseResponse($data) { return (bool) $data; }
- }
- class Predis_Commands_Unwatch extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'UNWATCH'; }
- public function parseResponse($data) { return (bool) $data; }
- }
- /* persistence control commands */
- class Predis_Commands_Save extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'SAVE'; }
- }
- class Predis_Commands_BackgroundSave extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'BGSAVE'; }
- public function parseResponse($data) {
- if ($data == 'Background saving started') {
- return true;
- }
- return $data;
- }
- }
- class Predis_Commands_BackgroundRewriteAppendOnlyFile extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'BGREWRITEAOF'; }
- public function parseResponse($data) {
- return $data == 'Background append only file rewriting started';
- }
- }
- class Predis_Commands_LastSave extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'LASTSAVE'; }
- }
- class Predis_Commands_Shutdown extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'SHUTDOWN'; }
- public function closesConnection() { return true; }
- }
- /* remote server control commands */
- class Predis_Commands_Info extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'INFO'; }
- public function parseResponse($data) {
- $info = array();
- $infoLines = explode("\r\n", $data, -1);
- foreach ($infoLines as $row) {
- @list($k, $v) = explode(':', $row);
- if ($row === '' || !isset($v)) {
- continue;
- }
- if (!preg_match('/^db\d+$/', $k)) {
- if ($k === 'allocation_stats') {
- $info[$k] = $this->parseAllocationStats($v);
- continue;
- }
- $info[$k] = $v;
- }
- else {
- $info[$k] = $this->parseDatabaseStats($v);
- }
- }
- return $info;
- }
- protected function parseDatabaseStats($str) {
- $db = array();
- foreach (explode(',', $str) as $dbvar) {
- list($dbvk, $dbvv) = explode('=', $dbvar);
- $db[trim($dbvk)] = $dbvv;
- }
- return $db;
- }
- protected function parseAllocationStats($str) {
- $stats = array();
- foreach (explode(',', $str) as $kv) {
- @list($size, $objects, $extra) = explode('=', $kv);
- // hack to prevent incorrect values when parsing the >=256 key
- if (isset($extra)) {
- $size = ">=$objects";
- $objects = $extra;
- }
- $stats[$size] = $objects;
- }
- return $stats;
- }
- }
- class Predis_Commands_Info_v24 extends Predis_Commands_Info {
- public function parseResponse($data) {
- $info = array();
- $current = null;
- $infoLines = explode("\r\n", $data, -1);
- foreach ($infoLines as $row) {
- if ($row === '') {
- continue;
- }
- if (preg_match('/^# (\w+)$/', $row, $matches)) {
- $info[$matches[1]] = array();
- $current = &$info[$matches[1]];
- continue;
- }
- list($k, $v) = explode(':', $row);
- if (!preg_match('/^db\d+$/', $k)) {
- if ($k === 'allocation_stats') {
- $current[$k] = $this->parseAllocationStats($v);
- continue;
- }
- $current[$k] = $v;
- }
- else {
- $current[$k] = $this->parseDatabaseStats($v);
- }
- }
- return $info;
- }
- }
- class Predis_Commands_SlaveOf extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'SLAVEOF'; }
- public function filterArguments(Array $arguments) {
- if (count($arguments) === 0 || $arguments[0] === 'NO ONE') {
- return array('NO', 'ONE');
- }
- return $arguments;
- }
- }
- class Predis_Commands_Config extends Predis_MultiBulkCommand {
- public function canBeHashed() { return false; }
- public function getCommandId() { return 'CONFIG'; }
- }
- ?>
|