Habari is a sufficiently complex PHP application that sometimes the only way to figure out what is going on is to fire up a debugger. Following a suggestion on #habari and some google searching, I found an article on the Box.net blog on using XDebug with vim. The instructions were for a linux box, and I initially struggled to get things working on Windows (XAMPP). But, I finally got it through digging through the comments on the Box.net article and Vim documentation. I thought it would be useful to gather the required steps in one place, so here are my instructions:
- Read the Box.net article.
- Download XDebug and put it in xampplite\php\ext
- Edit xampplite\apache\bin\php.ini. Add these lines:
zend_extension_ts="c:/xampplite/php/ext/php_xdebug-2.0.3-5.2.5.dll"
xdebug.remote_enable = 1
xdebug.remote_port = 9000
xdebug.remote_host = localhost - Restart Apache. Check that xdebug appears on your phpinfo() page.
- Download the xdebug plugin for Vim and put it in: C:\Program Files\Vim\vim71\plugin
- Download and install Python 2.4 (not 2.5). You can see which version of Python your copy of gVim is looking for by looking for the ‘python’ string in the gVim binary (dirty, but it works!)
- Now you need to modify debugger.py to work with windows paths, so open debugger.py in gVim
- Change the session file to something reasonable. XAMPP has a directory that already serves this purpose, so you might change
self.sessfileto
self.sessfile = "C:\\xampplite\\tmp\\debugger_vim_saved_session." + str(os.getpid()) - Now change every occurance of
getAttribute['filename'][7:]togetAttribute['filename'][8:]. Do the same withgetAttribute['fileuri'][7:]
- Change the session file to something reasonable. XAMPP has a directory that already serves this purpose, so you might change
- Open up a browser and append
?XDEBUG_SESSION_START=1to the end of an address on your local webserver. - Open gVim. Hit F5, then refresh your browser page. You should now be debugging!
Hey Blake, thanks for the tips. I am so close to getting this working. Hope you can help…
Developing on WinXP with GVIM connected via sftpdrive to the remote Ubuntu box with the website on it.
Set up php.ini for remote debugging on my local WinXP IP.
I edit the file in vim, hit F5, refresh the page in firefox. It connects, but I get the following error in gVim:
E185: Invalid buffer name: var/www/{siteName}}/htdocs/filename.php
Seems to me that its trying to map the same directory structure on my locally mapped drive (via sftp) to the one on the webserver and they don’t match.
Any ideas? Any help appreciated. Thanks.
Hi David,
It sounds like you need to modify the paths that debugger.py is trying to open. I actually don’t do any python programming myself, so I can’t give you specifics, but I would imagine that you want to write a function which takes in a linux path and maps it to your sftpdrive path.
In PHP your function would look like
function remap( $path ) { return ‘F:' + preg_replace( ‘%/%’, ‘\’, $path ); }
where “F:” is the drive letter of your sftpdrive. Then you want to wrap every reference to getAttribute[‘filename’][7:]. You just need to convert my function to Python.
If I am not mistaken, in Python my function would be:
def remap (path): return ‘F:\’ + path.replace(‘/’, ‘\’)
Thanks Blake,
It’s more complex than that, since the full paths are not even close.
I gave up on it.
Thanks for your efforts though.
Thanks, I wouldn’t have gotten very far without this!
Apache was dying on me until I made this edit on line 675 in my php.ini:
extension=php_xdebug-2.0.4-5.2.8.dllThen I kept getting an error with the sessfile edit in debugger.py. In the end I added “import tempfile” at the top and changed it to:
self.sessfile = tempfile.NamedTemporaryFile().name;Now I can start the debugger, but I always seem to get a socket timeout error before I can do anything in it. Probably an apache configuration issue…
I had a small problem where debugger.py tried to open files with spaces in their pathnames. Xdebug sent the filenames with space as ‘%20’.
To fix it i changed all occurences of getAttribute[‘filename’][7:] to getAttribute[‘filename’][7:].replace(‘%20’, ’ ‘) and getAttribute[‘fileuri’][7:] to getAttribute[‘fileuri’][7:].replace(‘%20’, ’ ‘)
Im sure there are some elite python command to strip html entities but that atleast fixed it for me.
Thanks for the tip, Kim.
Blake, Thank you very much for this great tutorial. This is an extremely helpful tool to have attached to vim!
Hi Blake, I just ran across an error. After setting a breakpoint, and then hitting F5 to run the code I would get a command not recognized error back. After some tinkering, I found the problem was that I was using a newer version of XDebug. So maybe it would be good to specify that this works for XDebug php_xdebug-2.0.3-5.2.5.dll This is the version that you used, but it is not explicitly stated that this is the version that the scripts work with.
Thanks again!
Apologies for all the comments, but What I thought was a solution, is not actually one at all. It was working for a while, and now is not any longer. Feel free to delete both of these comments. I am still getting a
error code=5 : Command not available (Is used for async commands. For instance if the engine is in state "run" than only "break" and "status" are available). message command is not available
error when i try to run the program.
Looking more closely, it seems the error is actually on the stack_get call that is automatically run after the run command when F5 is hit. Again, sorry for all the emails. If you have any idea what is causing this, I would appreciate the insight. If not, I will keep plugging away at it.
Has anyone come up with a good solution on how to do this from an actual remote machine? I want to be able to debug code from my workstation when its on our in house server. There shouldn’t be any firewall problems… but the server box is running linux, while my machine is running windows. So I need to be able to map changes in the path…
I was using a newer version of XDebug. So maybe it would be good to specify that this works for XDebug php_xdebug.So thanks for providing the information.
I’m using vim 7.2 on windows with PHP 5.3.0 (cgi), Xdebug v2.1.0-dev and vim plugin: DBGp client 1.1.1
Put the plugin in the c:\program files\vim\vimfiles\plugin
Insert: elseif filereadable($VIMRUNTIME."/../vimfiles/plugin/debugger.py") pyfile $VIMRUNTIME/../vimfiles/plugin/debugger.py to the debugger.vim file at line 124
Replace: node.getAttribute(‘filename’)[7:] by: node.getAttribute(‘filename’)[7:].replace(‘%20’,’ ‘).replace(‘/’,’\’).lstrip(‘\’) to the debugger.py file (3 times, lines: 295, 791, 823)
You have to express more your opinion to attract more readers, because just a video or plain text without any personal approach is not that valuable. But it is just form my point of view
Good useful post. Knowledge of Debugging information is very useful and necessary to save time and increase performance. And this article has helped me alot.Thanks.