2003-10-20 13:41:43 +00:00
|
|
|
<?php
|
2004-09-03 20:33:01 +00:00
|
|
|
/**
|
|
|
|
|
* memcached diagnostic tool
|
|
|
|
|
*
|
2010-12-16 19:15:12 +00:00
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
|
|
|
* (at your option) any later version.
|
|
|
|
|
*
|
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
|
*
|
|
|
|
|
* You should have received a copy of the GNU General Public License along
|
|
|
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
|
|
|
*
|
WARNING: HUGE COMMIT
Doxygen documentation update:
* Changed alls @addtogroup to @ingroup. @addtogroup adds the comment to the group description, but doesn't add the file, class, function, ... to the group like @ingroup does. See for example http://svn.wikimedia.org/doc/group__SpecialPage.html where it's impossible to see related files, classes, ... that should belong to that group.
* Added @file to file description, it seems that it should be explicitely decalred for file descriptions, otherwise doxygen will think that the comment document the first class, variabled, function, ... that is in that file.
* Removed some empty comments
* Removed some ?>
Added following groups:
* ExternalStorage
* JobQueue
* MaintenanceLanguage
One more thing: there are still a lot of warnings when generating the doc.
2008-05-20 17:13:28 +00:00
|
|
|
* @file
|
2004-09-03 20:33:01 +00:00
|
|
|
* @todo document
|
WARNING: HUGE COMMIT
Doxygen documentation update:
* Changed alls @addtogroup to @ingroup. @addtogroup adds the comment to the group description, but doesn't add the file, class, function, ... to the group like @ingroup does. See for example http://svn.wikimedia.org/doc/group__SpecialPage.html where it's impossible to see related files, classes, ... that should belong to that group.
* Added @file to file description, it seems that it should be explicitely decalred for file descriptions, otherwise doxygen will think that the comment document the first class, variabled, function, ... that is in that file.
* Removed some empty comments
* Removed some ?>
Added following groups:
* ExternalStorage
* JobQueue
* MaintenanceLanguage
One more thing: there are still a lot of warnings when generating the doc.
2008-05-20 17:13:28 +00:00
|
|
|
* @ingroup Maintenance
|
2004-09-03 20:33:01 +00:00
|
|
|
*/
|
2003-10-20 13:41:43 +00:00
|
|
|
|
2004-09-03 20:33:01 +00:00
|
|
|
/** */
|
2012-08-27 19:03:15 +00:00
|
|
|
require_once( __DIR__ . '/commandLine.inc' );
|
2004-06-01 07:42:32 +00:00
|
|
|
|
2013-01-16 14:27:21 +00:00
|
|
|
$debug = in_array( '--debug', $argv );
|
|
|
|
|
$help = in_array( '--help', $argv );
|
|
|
|
|
|
|
|
|
|
if( $help ) {
|
|
|
|
|
mccShowUsage();
|
|
|
|
|
exit( 0 );
|
|
|
|
|
}
|
|
|
|
|
$mcc = new MWMemcached( array(
|
|
|
|
|
'persistent' => true,
|
|
|
|
|
'debug' => $debug,
|
|
|
|
|
) );
|
2013-01-06 23:09:59 +00:00
|
|
|
|
|
|
|
|
if ( $wgMainCacheType === CACHE_MEMCACHED ) {
|
|
|
|
|
$mcc->set_servers( $wgMemCachedServers );
|
|
|
|
|
} elseif( isset( $wgObjectCaches[$wgMainCacheType] ) ) {
|
|
|
|
|
$mcc->set_servers( $wgObjectCaches[$wgMainCacheType]['servers'] );
|
|
|
|
|
} else {
|
|
|
|
|
print "MediaWiki isn't configured for Memcached usage\n";
|
|
|
|
|
exit( 1 );
|
|
|
|
|
}
|
2003-10-20 13:41:43 +00:00
|
|
|
|
2013-01-16 14:27:21 +00:00
|
|
|
/**
|
|
|
|
|
* Show this command line tool usage.
|
|
|
|
|
*/
|
|
|
|
|
function mccShowUsage() {
|
|
|
|
|
echo <<<EOF
|
|
|
|
|
Usage:
|
|
|
|
|
mcc.php [--debug]
|
|
|
|
|
mcc.php --help
|
|
|
|
|
|
|
|
|
|
MemCached Command (mcc) is an interactive command tool that let you interact
|
|
|
|
|
with the MediaWiki memcached cache.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--debug Set debug mode on the memcached connection.
|
|
|
|
|
--help This help screen.
|
|
|
|
|
|
|
|
|
|
Interactive commands:
|
|
|
|
|
|
|
|
|
|
EOF;
|
|
|
|
|
print "\t";
|
|
|
|
|
print str_replace( "\n", "\n\t", mccGetHelp( false ) );
|
|
|
|
|
print "\n";
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function mccGetHelp( $command ) {
|
|
|
|
|
$output = '';
|
2010-05-22 16:50:39 +00:00
|
|
|
$commandList = array(
|
2010-01-22 18:04:40 +00:00
|
|
|
'get' => 'grabs something',
|
|
|
|
|
'getsock' => 'lists sockets',
|
|
|
|
|
'set' => 'changes something',
|
|
|
|
|
'delete' => 'deletes something',
|
|
|
|
|
'history' => 'show command line history',
|
|
|
|
|
'server' => 'show current memcached server',
|
|
|
|
|
'dumpmcc' => 'shows the whole thing',
|
|
|
|
|
'exit' => 'exit mcc',
|
|
|
|
|
'quit' => 'exit mcc',
|
|
|
|
|
'help' => 'help about a command',
|
|
|
|
|
);
|
2010-05-22 16:50:39 +00:00
|
|
|
if ( !$command ) {
|
2010-01-22 18:04:40 +00:00
|
|
|
$command = 'fullhelp';
|
|
|
|
|
}
|
2010-05-22 16:50:39 +00:00
|
|
|
if ( $command === 'fullhelp' ) {
|
2010-12-04 08:58:32 +00:00
|
|
|
$max_cmd_len = max( array_map( 'strlen', array_keys( $commandList ) ) );
|
2010-05-22 16:50:39 +00:00
|
|
|
foreach ( $commandList as $cmd => $desc ) {
|
2013-01-16 14:27:21 +00:00
|
|
|
$output .= sprintf( "%-{$max_cmd_len}s: %s\n", $cmd, $desc );
|
2010-01-22 18:04:40 +00:00
|
|
|
}
|
2010-05-22 16:50:39 +00:00
|
|
|
} elseif ( isset( $commandList[$command] ) ) {
|
2013-01-16 14:27:21 +00:00
|
|
|
$output .= "$command: $commandList[$command]\n";
|
2010-01-22 18:04:40 +00:00
|
|
|
} else {
|
2013-01-16 14:27:21 +00:00
|
|
|
$output .= "$command: command does not exist or no help for it\n";
|
2005-12-03 17:41:34 +00:00
|
|
|
}
|
2013-01-16 14:27:21 +00:00
|
|
|
|
|
|
|
|
return $output;
|
2005-12-03 17:41:34 +00:00
|
|
|
}
|
|
|
|
|
|
2003-10-20 13:41:43 +00:00
|
|
|
do {
|
|
|
|
|
$bad = false;
|
2005-12-03 17:41:34 +00:00
|
|
|
$showhelp = false;
|
2003-10-20 13:41:43 +00:00
|
|
|
$quit = false;
|
2005-12-03 17:02:22 +00:00
|
|
|
|
2010-11-06 22:16:19 +00:00
|
|
|
$line = Maintenance::readconsole();
|
2010-05-22 16:50:39 +00:00
|
|
|
if ( $line === false ) exit;
|
2006-01-07 13:31:29 +00:00
|
|
|
|
2005-12-03 17:02:22 +00:00
|
|
|
$args = explode( ' ', $line );
|
2003-10-20 13:41:43 +00:00
|
|
|
$command = array_shift( $args );
|
2005-12-03 17:02:22 +00:00
|
|
|
|
2005-12-03 17:41:34 +00:00
|
|
|
// process command
|
2003-10-20 13:41:43 +00:00
|
|
|
switch ( $command ) {
|
2005-12-03 17:41:34 +00:00
|
|
|
case 'help':
|
|
|
|
|
// show an help message
|
2013-01-16 14:27:21 +00:00
|
|
|
print mccGetHelp( array_shift( $args ) );
|
2013-01-06 23:09:59 +00:00
|
|
|
break;
|
2005-12-03 17:02:22 +00:00
|
|
|
|
|
|
|
|
case 'get':
|
2009-03-14 20:09:48 +00:00
|
|
|
$sub = '';
|
|
|
|
|
if ( array_key_exists( 1, $args ) ) {
|
|
|
|
|
$sub = $args[1];
|
|
|
|
|
}
|
|
|
|
|
print "Getting {$args[0]}[$sub]\n";
|
2003-11-30 08:21:40 +00:00
|
|
|
$res = $mcc->get( $args[0] );
|
|
|
|
|
if ( array_key_exists( 1, $args ) ) {
|
|
|
|
|
$res = $res[$args[1]];
|
|
|
|
|
}
|
2003-10-20 13:41:43 +00:00
|
|
|
if ( $res === false ) {
|
2010-05-22 16:50:39 +00:00
|
|
|
# print 'Error: ' . $mcc->error_string() . "\n";
|
2004-06-01 07:42:32 +00:00
|
|
|
print "MemCached error\n";
|
2003-10-20 13:41:43 +00:00
|
|
|
} elseif ( is_string( $res ) ) {
|
|
|
|
|
print "$res\n";
|
|
|
|
|
} else {
|
|
|
|
|
var_dump( $res );
|
|
|
|
|
}
|
2013-01-06 23:09:59 +00:00
|
|
|
break;
|
2005-12-03 17:02:22 +00:00
|
|
|
|
|
|
|
|
case 'getsock':
|
2004-09-25 16:54:31 +00:00
|
|
|
$res = $mcc->get( $args[0] );
|
|
|
|
|
$sock = $mcc->get_sock( $args[0] );
|
|
|
|
|
var_dump( $sock );
|
|
|
|
|
break;
|
2005-12-03 17:02:22 +00:00
|
|
|
|
2005-12-03 18:14:19 +00:00
|
|
|
case 'server':
|
2010-01-23 19:00:56 +00:00
|
|
|
if ( $mcc->_single_sock !== null ) {
|
|
|
|
|
print $mcc->_single_sock . "\n";
|
|
|
|
|
break;
|
|
|
|
|
}
|
2005-12-03 18:14:19 +00:00
|
|
|
$res = $mcc->get( $args[0] );
|
2007-01-17 00:54:54 +00:00
|
|
|
$hv = $mcc->_hashfunc( $args[0] );
|
|
|
|
|
for ( $i = 0; $i < 3; $i++ ) {
|
|
|
|
|
print $mcc->_buckets[$hv % $mcc->_bucketcount] . "\n";
|
|
|
|
|
$hv += $mcc->_hashfunc( $i . $args[0] );
|
|
|
|
|
}
|
2005-12-03 18:14:19 +00:00
|
|
|
break;
|
|
|
|
|
|
2005-12-03 17:02:22 +00:00
|
|
|
case 'set':
|
2003-10-20 13:41:43 +00:00
|
|
|
$key = array_shift( $args );
|
2003-11-30 08:21:40 +00:00
|
|
|
if ( $args[0] == "#" && is_numeric( $args[1] ) ) {
|
2005-12-03 17:02:22 +00:00
|
|
|
$value = str_repeat( '*', $args[1] );
|
2003-11-30 08:21:40 +00:00
|
|
|
} else {
|
2005-12-03 17:02:22 +00:00
|
|
|
$value = implode( ' ', $args );
|
2003-11-30 08:21:40 +00:00
|
|
|
}
|
|
|
|
|
if ( !$mcc->set( $key, $value, 0 ) ) {
|
2010-05-22 16:50:39 +00:00
|
|
|
# print 'Error: ' . $mcc->error_string() . "\n";
|
2004-06-01 07:42:32 +00:00
|
|
|
print "MemCached error\n";
|
2003-10-20 13:41:43 +00:00
|
|
|
}
|
|
|
|
|
break;
|
2005-12-03 17:02:22 +00:00
|
|
|
|
|
|
|
|
case 'delete':
|
|
|
|
|
$key = implode( ' ', $args );
|
2003-11-30 08:21:40 +00:00
|
|
|
if ( !$mcc->delete( $key ) ) {
|
2010-05-22 16:50:39 +00:00
|
|
|
# print 'Error: ' . $mcc->error_string() . "\n";
|
2004-06-01 07:42:32 +00:00
|
|
|
print "MemCached error\n";
|
2003-11-30 08:21:40 +00:00
|
|
|
}
|
2005-12-03 17:02:22 +00:00
|
|
|
break;
|
|
|
|
|
|
2005-12-03 17:46:21 +00:00
|
|
|
case 'history':
|
|
|
|
|
if ( function_exists( 'readline_list_history' ) ) {
|
2010-05-22 16:50:39 +00:00
|
|
|
foreach ( readline_list_history() as $num => $line ) {
|
2005-12-04 00:00:06 +00:00
|
|
|
print "$num: $line\n";
|
|
|
|
|
}
|
2005-12-03 17:46:21 +00:00
|
|
|
} else {
|
|
|
|
|
print "readline_list_history() not available\n";
|
|
|
|
|
}
|
|
|
|
|
break;
|
|
|
|
|
|
2005-12-03 17:02:22 +00:00
|
|
|
case 'dumpmcc':
|
2004-09-25 16:54:31 +00:00
|
|
|
var_dump( $mcc );
|
|
|
|
|
break;
|
2005-12-03 17:02:22 +00:00
|
|
|
|
|
|
|
|
case 'quit':
|
|
|
|
|
case 'exit':
|
2003-10-20 13:41:43 +00:00
|
|
|
$quit = true;
|
|
|
|
|
break;
|
2005-12-03 17:02:22 +00:00
|
|
|
|
2003-10-20 13:41:43 +00:00
|
|
|
default:
|
|
|
|
|
$bad = true;
|
2005-12-03 17:41:34 +00:00
|
|
|
} // switch() end
|
|
|
|
|
|
2003-10-20 13:41:43 +00:00
|
|
|
if ( $bad ) {
|
|
|
|
|
if ( $command ) {
|
|
|
|
|
print "Bad command\n";
|
|
|
|
|
}
|
|
|
|
|
} else {
|
2005-12-03 17:02:22 +00:00
|
|
|
if ( function_exists( 'readline_add_history' ) ) {
|
2003-11-21 05:00:22 +00:00
|
|
|
readline_add_history( $line );
|
|
|
|
|
}
|
2003-10-20 13:41:43 +00:00
|
|
|
}
|
|
|
|
|
} while ( !$quit );
|