<?php
/**
 * Copyright 2018 Google Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Google\Cloud\Debugger;

/**
 * This class handles searching for a source file in the application's source
 * tree. A debugger breakpoint may be requested for a source path that has
 * extra or missing folders.
 *
 * Example:
 * ```
 * $location = new SourceLocation('Debugger/src/DebuggerClient.php', 1);
 * $resolver = new SourceLocationResolver();
 * $resolvedLocation = $resolver->resolve($location);
 * ```
 * @deprecated see https://cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation
 */
class SourceLocationResolver
{
    /**
     * @var string[] Search paths used to find matching source files.
     */
    private $includePaths = [];

    /**
     * Create a new SourceLocationResolver.
     *
     * @param string[]|null $includePaths The search paths used to find matching
     *     source files. **Defaults to** the configured include path for PHP.
     */
    public function __construct($includePaths = null)
    {
        $this->includePaths = $includePaths ?: explode(PATH_SEPARATOR, get_include_path());
    }

    /**
     * Resolve the full path of an existing file in the application's source.
     * If no matching source file is found, then return null. If found, the
     * resolved location will include the full, absolute path to the source
     * file.
     *
     * There are 3 cases for resolving a SourceLocation:
     *
     * Case 1: The exact path is found
     *
     * Example:
     * ```
     * $location = new SourceLocation('Debugger/src/DebuggerClient.php', 1);
     * $resolver = new SourceLocationResolver();
     * $resolvedLocation = $resolver->resolve($location);
     * ```
     *
     * Case 2: There are extra folder(s) in the requested breakpoint path
     *
     * Example:
     * ```
     * $location = new SourceLocation('extra/folder/Debugger/src/DebuggerClient.php', 1);
     * $resolver = new SourceLocationResolver();
     * $resolvedLocation = $resolver->resolve($location);
     * ```
     *
     * Case 3: There are fewer folders in the requested breakpoint path
     *
     * Example:
     * ```
     * $location = new SourceLocation('src/DebuggerClient.php', 1);
     * $resolver = new SourceLocationResolver();
     * $resolvedLocation = $resolver->resolve($location);
     *
     * @param SourceLocation $location The location to resolve.
     * @return SourceLocation|null
     */
    public function resolve(SourceLocation $location)
    {
        $origPath = str_replace('/', DIRECTORY_SEPARATOR, $location->path());
        $basename = basename($origPath);
        $prefixes = $this->searchPrefixes($origPath);

        $includePaths = array_filter($this->includePaths, function ($path) {
            return file_exists($path);
        });

        // Phase 1: search for an exact file match and try stripping off extra
        // folders
        foreach ($prefixes as $prefix) {
            foreach ($includePaths as $path) {
                $file = implode(DIRECTORY_SEPARATOR, [$path, $prefix, $basename]);
                if (file_exists($file)) {
                    return new SourceLocation($this->realRelativePath($file, $path), $location->line());
                }
            }
        }

        // Phase 2: recursively search folders for a matching file
        foreach ($includePaths as $includePath) {
            $iterator = new MatchingFileIterator(
                $includePath,
                $origPath
            );
            foreach ($iterator as $file => $info) {
                return new SourceLocation($this->realRelativePath($file, $includePath), $location->line());
            }
        }

        return null;
    }

    /**
     * Returns an array of relative paths for this file by recursively removing
     * each leading directory.
     *
     * @param string $path The source path
     * @return string[]
     */
    private function searchPrefixes($path)
    {
        $dirname = dirname($path);
        $directoryParts = explode(DIRECTORY_SEPARATOR, $dirname);
        $directories = [];
        while ($directoryParts) {
            $directories[] = implode(DIRECTORY_SEPARATOR, $directoryParts);
            array_shift($directoryParts);
        }
        return $directories;
    }

    private function realRelativePath($fullPath, $path)
    {
        return str_replace(realpath($path) . DIRECTORY_SEPARATOR, '', realpath($fullPath));
    }
}
