optional support for Docker (paths mapping) + urldecode

[xpavp03]

Here's a version that allows for passing a third parameter describing which project the file belongs to. That way a part of the path can be replaced. It also decodes slashes etc. in the path.

#!/usr/bin/env bash

# PhpStorm URL Handler
# phpstorm://open?url=file://@file&line=@line
# phpstorm://open?file=@file&line=@line
#
# @license GPL
# @author Stefan Auditor <stefan.auditor@erdfisch.de>
# @author Petr 'PePa' Pavel <petr.pavel@pepa.info>

input=${1}

# https://stackoverflow.com/a/37840948/465732
function urldecode() { : "${*//+/ }"; echo -e "${_//%/\\x}"; }

arg=$(urldecode "$input")
pattern=".*file(:\/\/|\=)(.*)&line=(.*)(&project=(.*))?"

# Get the file path.
file=$(echo "${arg}" | sed -r "s/${pattern}/\2/")

# Get the line number.
line=$(echo "${arg}" | sed -r "s/${pattern}/\3/")

# Project name for path replacement
project=$(echo "${arg}" | sed -r "s/${pattern}/\5/")

if [ -n "$project" ]; then
	basePath="/home/myusername/projects"

	declare -A paths
	paths["project5.6"]="projectdirname/php-5.6"

	file=$(echo "${file}" | sed -r "s#/var/www/app#${basePath}/${paths[$project]}#")
fi

# Check if phpstorm|pstorm command exist.
if type phpstorm > /dev/null; then
    /usr/bin/env phpstorm --line "${line}" "${file}"
elif type pstorm > /dev/null; then
    /usr/bin/env pstorm --line "${line}" "${file}"
fi

[bernhardh]

PHP Storm says:

Cannot find file 'phpstorm://open?file=/home/www/project1/app/Models/Users/UserBookmarkGroup.php&line=63'

when I try to open a url?

[xpavp03]

PhpStorm should not be getting the full url but only the file part. Does the original script work for you? You're not passing a project parameter so you don't need my enhanced version.

Edit: Oh snap, my pattern was missing a question mark at the end. Without it the project parameter was obligatory.
I just added it.

[bernhardh]

The original script doesn't work either. Since i got an "ugly" url in the error message with the original one, I thought I try it with yours.

Cannot find file '%2Fhome%2Fwww%2Fproject1%plugins%2FUserBookmark%2FUserBookmarkController.php'

Btw. the url is generated by my framework (Laravel):

[bernhardh]

Thanks. Your updated version is now working for me 👍 - the version from this repo is not.

[melkyfb]

I made this simple version to make that work for me

#!/usr/bin/env bash

# PhpStorm URL Handler
# phpstorm://open?url=file://@file&line=@line
# phpstorm://open?file=@file&line=@line
#
# @license GPL
# @author Stefan Auditor <stefan.auditor@erdfisch.de>

arg=${1}
pattern=".*file(:\/\/|\=)(.*)&line=(.*)"

networkshare='/var/www/app'
projectfolder='/home/melkyfb/PhpstormProjects/app'

# Get the file path.
file=$(echo "${arg}" | sed -r "s/${pattern}/\2/")
file=${file/$networkshare/$projectfolder}

# Get the line number.
line=$(echo "${arg}" | sed -r "s/${pattern}/\3/")

# Check if phpstorm|pstorm command exist.
if type phpstorm > /dev/null; then
    /usr/bin/env phpstorm --line "${line}" "${file}"
elif type pstorm > /dev/null; then
    /usr/bin/env pstorm --line "${line}" "${file}"
fi

[TangoMan75]

As an alternative you can use a symlink on your host machine that mirrors your docker project directory structure like so :

ln -s "${_host_directory}" "${_container_directory}"
# example
ln -s "/home/username/project" "/var/www"

It works like a charm.

[sanduhrs]

The original script doesn't work either. Since i got an "ugly" url in the error message with the original one, I thought I try it with yours.

Cannot find file '%2Fhome%2Fwww%2Fproject1%plugins%2FUserBookmark%2FUserBookmarkController.php'

This should be fixed in environment variables e46793a