Newer
Older
Moshe Weitzman
committed
<?php
/**
* @file
* Drush integration for the devel module.
*/
/**
* Implements hook_drush_command().
*/
function devel_drush_command() {
$items['devel-download'] = array(
'description' => dt('Downloads the FirePHP library from http://firephp.org/.'),
'arguments' => array(
'path' => dt('Optional. A path to the download folder. If omitted Drush will use the default location (sites/all/libraries/firephp).'),
),
);
Moshe Weitzman
committed
$items['devel-reinstall'] = array(
'description' => dt('Disable, Uninstall, and Install a list of projects.'),
'arguments' => array(
'path' => dt('A space separated list of project names.'),
),
'aliases' => array('dre'),
);
Moshe Weitzman
committed
$items['fn-hook'] = array(
'description' => 'List implementations of a given hook and explore source of specified one.',
'arguments' => array(
'hook' => 'The name of the hook to explore.'
),
'aliases' => array('fnh', 'hook'),
);
$items['fn-view'] = array(
'description' => 'Show the source of specified function or method.',
Moshe Weitzman
committed
'arguments' => array(
'function' => 'The name of the function or method to view.',
Moshe Weitzman
committed
),
'options' => array(
'--pipe' => 'Output just the filename of the function',
),
'examples' => array(
'fn-view drupal_set_breadcrumb' => 'View the source code for function "drupal_set_breadcrumb"',
Moshe Weitzman
committed
'vi `drush --pipe fn-view user_access`' => 'Edit the file that contains the function "user_access"',
'fn-view NodeController::load' => 'View the source code for method load in the class NodeController'
Moshe Weitzman
committed
),
'aliases' => array('fnv'),
);
Moshe Weitzman
committed
$items['devel-token'] = array(
'description' => dt('List available tokens'),
'aliases' => array('token'),
'core' => array(7), // Remove once 3.0 is released.
);
Moshe Weitzman
committed
return $items;
}
/**
Moshe Weitzman
committed
* Implementation of hook_drush_help().
*/
function devel_drush_help($section) {
switch ($section) {
case 'drush:devel-reinstall':
return dt('Disable, Uninstall, and Install a list of projects.');
case 'drush:devel-download':
return dt("Downloads the FirePHP library from http://firephp.org/. Places it in the devel module directory. Skips download if library already present. This all happens automatically if you enable devel using drush.");
}
}
/**
* A command callback. This is faster than 3 separate bootstraps.
*/
function drush_devel_reinstall() {
$projects = func_get_args();
$args = array_merge(array('pm-disable'), $projects);
call_user_func_array('drush_invoke', $args);
$args = array_merge(array('pm-uninstall'), $projects);
call_user_func_array('drush_invoke', $args);
$args = array_merge(array('pm-enable'), $projects);
call_user_func_array('drush_invoke', $args);
}
/**
* A command callback.
Moshe Weitzman
committed
*/
Moshe Weitzman
committed
function drush_devel_download() {
Moshe Weitzman
committed
$args = func_get_args();
if (isset($args[0])) {
$path = $args[0];
}
else {
$path = drush_get_context('DRUSH_DRUPAL_ROOT');
if (module_exists('libraries')) {
$path .= libraries_get_path('FirePHPCore') . '/FirePHPCore';
}
else {
$path .= '/'. drupal_get_path('module', 'devel') . '/FirePHPCore';
}
}
if (is_dir($path)) {
drush_log('FirePHP already present. No download required.', 'ok');
}
Moshe Weitzman
committed
elseif (drush_shell_exec('svn checkout http://firephp.googlecode.com/svn/branches/Library-FirePHPCore-0.3 ' . $path)) {
drush_log(dt('FirePHP has been checked out via svn to @path.', array('@path' => $path)), 'success');
Moshe Weitzman
committed
}
else {
drush_log(dt('Drush was unable to checkout FirePHP to @path.', array('@path' => $path)), 'error');
Moshe Weitzman
committed
}
}
/**
* Implements drush_MODULE_post_COMMAND().
*/
function drush_devel_post_pm_enable() {
Moshe Weitzman
committed
$modules = func_get_args();
Moshe Weitzman
committed
if (in_array('devel', $modules) && !drush_get_option('skip')) {
Moshe Weitzman
committed
drush_devel_download();
Moshe Weitzman
committed
}
}
Moshe Weitzman
committed
/**
* Command handler. Show hook implementations
*/
function drush_devel_fn_hook($hook) {
// Get implementations in the .install files as well.
include_once './includes/install.inc';
drupal_load_updates();
if ($hook_implementations = module_implements($hook)) {
if ($choice = drush_choice(array_combine($hook_implementations, $hook_implementations), 'Enter the number of the hook implementation you wish to view.')) {
return drush_devel_fn_view($choice . "_$hook");
}
}
else {
drush_log(dt('No implementations.'), 'ok');
Moshe Weitzman
committed
}
}
/**
* Command handler. Show source code of specified function or method.
Moshe Weitzman
committed
*/
function drush_devel_fn_view($function_name) {
// Get implementations in the .install files as well.
include_once './includes/install.inc';
drupal_load_updates();
if (strpos($function_name, '::') === FALSE) {
if (!function_exists($function_name)) {
return drush_set_error(dt('Function not found'));
}
$reflect = new ReflectionFunction($function_name);
}
else {
list($class, $method) = explode('::', $function_name);
if (!method_exists($class, $method)) {
return drush_set_error(dt('Method not found'));
}
$reflect = new ReflectionMethod($class, $method);
}
$func_info = array('!file' => $reflect->getFileName(), '!startline' => $reflect->getStartLine(), '!endline' => $reflect->getEndLine());
Moshe Weitzman
committed
//drush_print_pipe(dt("!file -line !startline", $func_info));
drush_print_pipe($reflect->getFileName());
Moshe Weitzman
committed
drush_print(dt("// file: !file, lines !startline-!endline", $func_info));
_drush_devel_print_function($reflect->getFileName(), $reflect->getStartLine(), $reflect->getEndLine());
Moshe Weitzman
committed
}
Moshe Weitzman
committed
/**
* Command callback. List available tokens.
*/
function drush_devel_token() {
$rows[] = array(dt('Group'), dt('Token'), dt('Name'));
$all = token_info();
foreach ($all['tokens'] as $group => $tokens) {
foreach ($tokens as $key => $token) {
$rows[] = array($group, $key, $token['name']);
}
}
drush_print_table($rows, TRUE);
}
Moshe Weitzman
committed
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
/**
* Print the specified function, including any
* doxygen-style comments that come before it.
*/
function _drush_devel_print_function($file, $start_line, $end_line) {
$line_num = 0;
$doxygen = NULL;
$fp = fopen( $file, 'r' );
while (!feof($fp) && ($line_num < ($start_line - 1))) {
$line = fgets($fp);
++$line_num;
if (substr($line,0,3) == '/**') {
$doxygen = $line;
}
elseif (isset($doxygen)) {
$doxygen .= $line;
if ($line_num + 1 == $start_line) {
drush_print(rtrim($doxygen));
}
if (strstr($line, '*/') !== FALSE) {
$doxygen = NULL;
}
}
}
while (!feof($fp) && ($line_num < $end_line)) {
$line = fgets($fp);
++$line_num;
drush_print(rtrim($line));
}
}