crytic_compile.utils.naming

  1"""
  2Module handling the file naming operation (relative -> absolute, etc)
  3"""
  4
  5import logging
  6import os.path
  7import platform
  8from dataclasses import dataclass
  9from pathlib import Path
 10from typing import TYPE_CHECKING, Union, Callable, Optional
 11
 12from crytic_compile.platform.exceptions import InvalidCompilation
 13
 14# Cycle dependency
 15if TYPE_CHECKING:
 16    from crytic_compile import CryticCompile
 17
 18LOGGER = logging.getLogger("CryticCompile")
 19
 20
 21@dataclass
 22class Filename:
 23    """Path metadata for each file in the compilation unit"""
 24
 25    def __init__(self, absolute: str, used: str, relative: str, short: str):
 26        self.absolute = absolute
 27        self.used = used
 28        self.relative = relative
 29        self.short = short
 30
 31    def __hash__(self) -> int:
 32        return hash(self.relative)
 33
 34    def __eq__(self, other: object) -> bool:
 35        if not isinstance(other, Filename):
 36            return NotImplemented
 37        return self.relative == other.relative
 38
 39    def __repr__(self) -> str:
 40        return f"Filename(absolute={self.absolute}, used={self.used}, relative={self.relative}, short={self.short}))"
 41
 42
 43def extract_name(name: str) -> str:
 44    """Convert '/path:Contract' to Contract
 45
 46    Args:
 47        name (str): name to convert
 48
 49    Returns:
 50        str: extracted contract name
 51    """
 52    return name[name.rfind(":") + 1 :]
 53
 54
 55def extract_filename(name: str) -> str:
 56    """Convert '/path:Contract' to /path
 57
 58    Args:
 59        name (str): name to convert
 60
 61    Returns:
 62        str: extracted filename
 63    """
 64    if not ":" in name:
 65        return name
 66    return name[: name.rfind(":")]
 67
 68
 69def combine_filename_name(filename: str, name: str) -> str:
 70    """Combine the filename with the contract name
 71
 72    Args:
 73        filename (str): filename
 74        name (str): contract name
 75
 76    Returns:
 77        str: Combined names
 78    """
 79    return filename + ":" + name
 80
 81
 82def _verify_filename_existence(filename: Path, cwd: Path) -> Path:
 83    """
 84    Check if the filename exist. If it does not, try multiple heuristics to find the right filename:
 85    - Look for contracts/FILENAME
 86    - Look for node_modules/FILENAME
 87    - Look for node_modules/FILENAME in all the parents directories
 88
 89
 90    Args:
 91        filename (Path): filename to check
 92        cwd (Path): directory
 93
 94    Raises:
 95        InvalidCompilation: if the filename is not found
 96
 97    Returns:
 98        Path: the filename
 99    """
100
101    if filename.exists():
102        return filename
103
104    if cwd.joinpath(Path("contracts"), filename).exists():
105        filename = cwd.joinpath("contracts", filename)
106    elif cwd.joinpath(filename).exists():
107        filename = cwd.joinpath(filename)
108    # how node.js loads dependencies from node_modules:
109    # https://nodejs.org/api/modules.html#loading-from-node_modules-folders
110    elif cwd.joinpath(Path("node_modules"), filename).exists():
111        filename = cwd.joinpath("node_modules", filename)
112    else:
113        for parent in cwd.parents:
114            if parent.joinpath(Path("node_modules"), filename).exists():
115                filename = parent.joinpath(Path("node_modules"), filename)
116                break
117
118    if not filename.exists():
119        raise InvalidCompilation(f"Unknown file: {filename}")
120
121    return filename
122
123
124# pylint: disable=too-many-branches
125def convert_filename(
126    used_filename: Union[str, Path],
127    relative_to_short: Callable[[Path], Path],
128    crytic_compile: "CryticCompile",
129    working_dir: Optional[Union[str, Path]] = None,
130) -> Filename:
131    """Convert a filename to CryticCompile Filename object.
132    The used_filename can be absolute, relative, or missing node_modules/contracts directory
133
134    Args:
135        used_filename (Union[str, Path]): Used filename
136        relative_to_short (Callable[[Path], Path]): Callback to translate the relative to short
137        crytic_compile (CryticCompile): Associated CryticCompile object
138        working_dir (Optional[Union[str, Path]], optional): Working directory. Defaults to None.
139
140    Returns:
141        Filename: Filename converted
142    """
143    filename_txt = used_filename
144    if platform.system() == "Windows":
145        elements = list(Path(filename_txt).parts)
146        if elements[0] == "/" or elements[0] == "\\":
147            elements = elements[1:]  # remove '/'
148            elements[0] = elements[0] + ":/"  # add :/
149        filename = Path(*elements)
150    else:
151        filename = Path(filename_txt)
152
153    # cwd points to the directory to be used
154    if working_dir is None:
155        cwd = Path.cwd()
156    else:
157        working_dir = Path(working_dir)
158        if working_dir.is_absolute():
159            cwd = working_dir
160        else:
161            cwd = Path.cwd().joinpath(Path(working_dir)).resolve()
162
163    if crytic_compile.package_name:
164        try:
165            filename = filename.relative_to(Path(crytic_compile.package_name))
166        except ValueError:
167            pass
168
169    filename = _verify_filename_existence(filename, cwd)
170
171    absolute = Path(os.path.abspath(filename))
172
173    # This returns original path if *path* and *start* are on different drives (for Windows platform).
174    try:
175        relative = Path(os.path.relpath(filename, Path.cwd()))
176    except ValueError:
177        relative = Path(filename)
178
179    # Build the short path
180    try:
181        if cwd.is_absolute():
182            short = absolute.relative_to(cwd)
183        else:
184            short = relative.relative_to(cwd)
185    except ValueError:
186        short = relative
187    except RuntimeError:
188        short = relative
189
190    short = relative_to_short(short)
191    # Starting with v0.8.8 (https://github.com/ethereum/solidity/pull/11545), solc normalizes the paths to not include the drive on Windows,
192    # so it's important we use posix path here to avoid issues with the path comparison.
193    return Filename(
194        absolute=absolute.as_posix(),
195        relative=relative.as_posix(),
196        short=short.as_posix(),
197        used=Path(used_filename).as_posix(),
198    )