<reponame>walles/px
import sys
import errno
import getpass
import datetime
import operator

import os
from . import px_file
from . import px_process
from . import px_ipc_map
from . import px_terminal
from . import px_cwdfriends
from . import px_loginhistory


if False:
    # For mypy PEP-484 static typing validation
    from typing import MutableSet  # NOQA
    from typing import Optional  # NOQA
    from typing import Iterable  # NOQA
    from typing import List  # NOQA
    from typing import Tuple  # NOQA
    from six import text_type  # NOQA


def println(fd, string):
    # type: (int, text_type) -> None
    os.write(fd, string.encode() + b"\n")


def find_process_by_pid(pid, processes):
    # type: (int, List[px_process.PxProcess]) -> Optional[px_process.PxProcess]
    for process in processes:
        if process.pid == pid:
            return process

    return None


def print_command_line(fd, process):
    # type: (int, px_process.PxProcess) -> None
    """
    Print command line separated by linefeeds rather than space, this adds
    readability to long command lines
    """
    array = process.get_command_line_array()
    println(fd, array[0])
    for parameter in array[1:]:
        if parameter == "":
            # Print empty parameters as "", otherwise the printout just looks
            # broken.
            parameter = '""'
        println(fd, "  " + parameter)


def print_process_subtree(fd, process, indentation, lines):
    # type: (int, px_process.PxProcess, int, List[Tuple[str, px_process.PxProcess]]) -> None
    lines.append(("  " * indentation + str(process), process))
    for child in sorted(
        process.children, key=operator.attrgetter("lowercase_command", "pid")
    ):
        print_process_subtree(fd, child, indentation + 1, lines)


def print_process_tree(fd, process):
    # type: (int, px_process.PxProcess) -> None
    # Contains tuples; the line to print and the process that line is for
    lines_and_processes = []  # type: List[Tuple[str, px_process.PxProcess]]

    # List all parents up to the top
    parents = []
    here = process
    while here.parent is not None:
        # FIXME: There can actually be loops; we must detect that hand handle it appropriately
        parents.append(here.parent)
        here = here.parent

    # Print all parents
    indentation = 0
    for parent in reversed(parents):
        lines_and_processes.append(("  " * indentation + str(parent), parent))
        indentation += 1

    # Print ourselves
    bold_process = str(px_terminal.bold(str(process)))
    lines_and_processes.append(
        ("--" * (indentation - 1) + "> " + bold_process, process)
    )
    indentation += 1

    # Print all our child trees
    for child in sorted(
        process.children, key=operator.attrgetter("lowercase_command", "pid")
    ):
        print_process_subtree(fd, child, indentation, lines_and_processes)

    # Add an owners column to the right of the tree
    tree_width = max(
        map(lambda lp: px_terminal.visual_length(lp[0]), lines_and_processes)
    )
    lines = []
    current_user = os.environ.get("SUDO_USER") or getpass.getuser()
    for line_and_process in lines_and_processes:
        line = line_and_process[0]

        # NOTE: This logic should match its friend in
        # px_terminal.py/to_screen_lines()
        owner = line_and_process[1].username
        if owner == "root":
            owner = px_terminal.faint(owner)
        elif owner != current_user:
            # Neither root nor ourselves, highlight!
            owner = px_terminal.bold(owner)

        if line_and_process[1].pid == process.pid:
            sudo_user = process.get_sudo_user()
            if sudo_user:
                owner += ", $SUDO_USER=" + sudo_user

        padding = " " * (tree_width + 2 - px_terminal.visual_length(line))
        lines.append(line + padding + owner)

    println(fd, "\n".join(lines))


def to_relative_start_string(base, relative):
    delta_seconds = base.age_seconds - relative.age_seconds
    delta_string = px_process.seconds_to_str(abs(delta_seconds))
    before_or_after = "before"
    if delta_seconds > 0:
        before_or_after = "after"
    elif delta_seconds == 0:
        delta_string = "just"
        if relative.pid > base.pid:
            before_or_after = "after"
    return "{} was started {} {} {}".format(
        relative, delta_string, before_or_after, base
    )


def get_closest_starts(process, all_processes):
    # type: (px_process.PxProcess, List[px_process.PxProcess]) -> List[px_process.PxProcess]
    """
    Return the processes that were started closest in time to the base process.

    All processes started within 1s of the base process are returned, or the
    five closest if not at least five were that close.
    """
    by_temporal_vicinity = sorted(
        all_processes, key=lambda p: abs(p.age_seconds - process.age_seconds)
    )

    closest_raw = set()
    for close in by_temporal_vicinity:
        delta_seconds = abs(close.age_seconds - process.age_seconds)

        if delta_seconds <= 1:
            closest_raw.add(close)
            continue

        # "5" is arbitrarily chosen, look at the printouts to see if it needs tuning
        if len(closest_raw) > 5:
            break

        closest_raw.add(close)

    # Remove ourselves from the closest processes list
    closest = filter(
        lambda p: p is not process, closest_raw
    )  # type: Iterable[px_process.PxProcess]

    # Sort closest processes by age, command and PID in that order
    closest = sorted(closest, key=operator.attrgetter("command", "pid"))
    closest = sorted(closest, key=operator.attrgetter("age_seconds"), reverse=True)
    return closest


def print_processes_started_at_the_same_time(fd, process, all_processes):
    println(fd, "Other processes started close to " + str(process) + ":")
    for close in get_closest_starts(process, all_processes):
        println(fd, "  " + to_relative_start_string(process, close))


def print_users_when_process_started(fd, process):
    # type: (int, px_process.PxProcess) -> None
    println(fd, "Users logged in when " + str(process) + " started:")
    users = px_loginhistory.get_users_at(process.start_time)
    if not users:
        println(
            fd,
            "  <Nobody found, either nobody was logged in or the wtmp logs have been rotated>",
        )
        return

    for user in sorted(users):
        println(fd, "  " + user)


def to_ipc_lines(ipc_map):
    # type: (px_ipc_map.IpcMap) -> Iterable[str]

    return_me = []
    for target in sorted(ipc_map.keys(), key=operator.attrgetter("name", "pid")):
        channels = ipc_map[target]
        channel_names = set()  # type: MutableSet[str]
        for channel_name in map(lambda c: str(c), channels):
            channel_names.add(channel_name)
        for channel_name in sorted(channel_names):
            return_me.append(
                "{}: {}".format(px_terminal.bold(str(target)), channel_name)
            )

    return return_me


def print_cwd_friends(fd, process, all_processes, all_files):
    friends = px_cwdfriends.PxCwdFriends(process, all_processes, all_files)

    cwd_suffix = u""
    if friends.cwd:
        cwd_suffix = u" (" + px_terminal.bold(friends.cwd) + ")"
    println(fd, "Others sharing this process' working directory" + cwd_suffix)
    if not friends.cwd:
        sudo_px = px_terminal.bold("sudo px {}".format(process.pid))
        println(
            fd, '  Working directory unknown, try again or try "{}"'.format(sudo_px)
        )
        return

    if friends.cwd == "/":
        println(fd, "  Working directory too common, never mind.")
        return

    if len(friends.friends) == 0:
        println(fd, "  Nobody else shares this working directory.")
        return

    for friend in friends.friends:
        println(fd, "  " + str(friend))


def print_fds(fd, process, processes):
    # type: (int, px_process.PxProcess, Iterable[px_process.PxProcess]) -> None

    # It's true, I measured it myself /<EMAIL>
    println(
        fd,
        datetime.datetime.now().isoformat()
        + ": Now invoking lsof, this can take over a minute on a big system...",
    )

    # Flush what we have so far so the user has something to read during the pause.
    # This is useful when piping output into a pager like moar or less.

    # NOTE: If we switch to writing to file-like objects we should flush here,
    # our println() function flushes implicitly.

    files = px_file.get_all()
    println(fd, datetime.datetime.now().isoformat() + ": lsof done, proceeding.")

    println(fd, "")
    print_cwd_friends(fd, process, processes, files)

    is_root = os.geteuid() == 0
    ipc_map = px_ipc_map.IpcMap(process, files, processes, is_root=is_root)

    println(fd, "")
    println(fd, "File descriptors:")
    println(fd, "  stdin : " + ipc_map.fds[0])
    println(fd, "  stdout: " + ipc_map.fds[1])
    println(fd, "  stderr: " + ipc_map.fds[2])
    # Note that we used to list all FDs here, but some processes (like Chrome)
    # has silly amounts, making the px output unreadable. Users should consult
    # lsof directly for the full list.

    println(fd, "")
    println(fd, "Network connections:")
    # FIXME: Print "nothing found" or something if we don't find anything to put
    # here, maybe with a hint to run as root if we think that would help.
    for connection in sorted(
        ipc_map.network_connections, key=operator.attrgetter("name")
    ):
        println(fd, "  " + str(connection))

    println(fd, "")
    println(fd, "Inter Process Communication:")
    for line in to_ipc_lines(ipc_map):
        println(fd, "  " + line)

    println(fd, "")
    lsof = px_terminal.bold("sudo lsof -p {}".format(process.pid))
    watch_lsof = px_terminal.bold("sudo watch lsof -p {}".format(process.pid))
    println(
        fd,
        'For a list of all open files, do "{}", '
        'or "{}" for a live view.'.format(lsof, watch_lsof),
    )

    if os.getuid() != 0:
        println(fd, "")
        println(
            fd,
            "NOTE: This information might be incomplete, "
            "running as root sometimes produces better results.",
        )


def print_start_time(fd, process):
    # type: (int, px_process.PxProcess) -> None
    println(
        fd,
        "{} {} was started by {}, at {}.".format(
            px_terminal.bold(process.age_s + " ago"),
            process.command,
            px_terminal.bold(process.username),
            px_terminal.bold(process.start_time.isoformat()),
        ),
    )

    if process.cpu_time_seconds and process.age_seconds:
        cpu_percent = 100.0 * process.cpu_time_seconds / process.age_seconds
        println(
            fd,
            "{} has been its average CPU usage since then, or {}/{}".format(
                px_terminal.bold("{:.1f}%".format(cpu_percent)),
                px_terminal.bold(process.cpu_time_s),
                px_terminal.bold(process.age_s),
            ),
        )


def print_pid_info(fd, pid):
    # type: (int, int) -> None
    processes = px_process.get_all()

    process = find_process_by_pid(pid, processes)
    if not process:
        sys.stderr.write("No such PID: {}\n".format(pid))
        exit(1)

    print_process_info(fd, process, processes)


def print_process_info(fd, process, processes):
    # type: (int, px_process.PxProcess, List[px_process.PxProcess]) -> None
    print_command_line(fd, process)

    # Print a process tree with all PID's parents and all its children
    println(fd, "")
    print_process_tree(fd, process)

    println(fd, "")
    print_start_time(fd, process)

    println(fd, "")
    print_processes_started_at_the_same_time(fd, process, processes)

    println(fd, "")
    print_users_when_process_started(fd, process)

    # List all files PID has open
    println(fd, "")
    try:
        print_fds(fd, process, processes)
    except OSError as e:
        if e.errno != errno.ENOENT:
            raise
        println(
            fd,
            'Can\'t list IPC / network sockets, make sure "lsof" is installed and in your $PATH',
        )

import sys
import errno
import getpass
import datetime
import operator

import os
from . import px_file
from . import px_process
from . import px_ipc_map
from . import px_terminal
from . import px_cwdfriends
from . import px_loginhistory


if False:
    # For mypy PEP-484 static typing validation
    from typing import MutableSet  # NOQA
    from typing import Optional  # NOQA
    from typing import Iterable  # NOQA
    from typing import List  # NOQA
    from typing import Tuple  # NOQA
    from six import text_type  # NOQA


def println(fd, string):
    # type: (int, text_type) -> None
    os.write(fd, string.encode() + b"\n")


def find_process_by_pid(pid, processes):
    # type: (int, List[px_process.PxProcess]) -> Optional[px_process.PxProcess]
    for process in processes:
        if process.pid == pid:
            return process

    return None


def print_command_line(fd, process):
    # type: (int, px_process.PxProcess) -> None
    """
    Print command line separated by linefeeds rather than space, this adds
    readability to long command lines
    """
    array = process.get_command_line_array()
    println(fd, array[0])
    for parameter in array[1:]:
        if parameter == "":
            # Print empty parameters as "", otherwise the printout just looks
            # broken.
            parameter = '""'
        println(fd, "  " + parameter)


def print_process_subtree(fd, process, indentation, lines):
    # type: (int, px_process.PxProcess, int, List[Tuple[str, px_process.PxProcess]]) -> None
    lines.append(("  " * indentation + str(process), process))
    for child in sorted(
        process.children, key=operator.attrgetter("lowercase_command", "pid")
    ):
        print_process_subtree(fd, child, indentation + 1, lines)


def print_process_tree(fd, process):
    # type: (int, px_process.PxProcess) -> None
    # Contains tuples; the line to print and the process that line is for
    lines_and_processes = []  # type: List[Tuple[str, px_process.PxProcess]]

    # List all parents up to the top
    parents = []
    here = process
    while here.parent is not None:
        # FIXME: There can actually be loops; we must detect that hand handle it appropriately
        parents.append(here.parent)
        here = here.parent

    # Print all parents
    indentation = 0
    for parent in reversed(parents):
        lines_and_processes.append(("  " * indentation + str(parent), parent))
        indentation += 1

    # Print ourselves
    bold_process = str(px_terminal.bold(str(process)))
    lines_and_processes.append(
        ("--" * (indentation - 1) + "> " + bold_process, process)
    )
    indentation += 1

    # Print all our child trees
    for child in sorted(
        process.children, key=operator.attrgetter("lowercase_command", "pid")
    ):
        print_process_subtree(fd, child, indentation, lines_and_processes)

    # Add an owners column to the right of the tree
    tree_width = max(
        map(lambda lp: px_terminal.visual_length(lp[0]), lines_and_processes)
    )
    lines = []
    current_user = os.environ.get("SUDO_USER") or getpass.getuser()
    for line_and_process in lines_and_processes:
        line = line_and_process[0]

        # NOTE: This logic should match its friend in
        # px_terminal.py/to_screen_lines()
        owner = line_and_process[1].username
        if owner == "root":
            owner = px_terminal.faint(owner)
        elif owner != current_user:
            # Neither root nor ourselves, highlight!
            owner = px_terminal.bold(owner)

        if line_and_process[1].pid == process.pid:
            sudo_user = process.get_sudo_user()
            if sudo_user:
                owner += ", $SUDO_USER=" + sudo_user

        padding = " " * (tree_width + 2 - px_terminal.visual_length(line))
        lines.append(line + padding + owner)

    println(fd, "\n".join(lines))


def to_relative_start_string(base, relative):
    delta_seconds = base.age_seconds - relative.age_seconds
    delta_string = px_process.seconds_to_str(abs(delta_seconds))
    before_or_after = "before"
    if delta_seconds > 0:
        before_or_after = "after"
    elif delta_seconds == 0:
        delta_string = "just"
        if relative.pid > base.pid:
            before_or_after = "after"
    return "{} was started {} {} {}".format(
        relative, delta_string, before_or_after, base
    )


def get_closest_starts(process, all_processes):
    # type: (px_process.PxProcess, List[px_process.PxProcess]) -> List[px_process.PxProcess]
    """
    Return the processes that were started closest in time to the base process.

    All processes started within 1s of the base process are returned, or the
    five closest if not at least five were that close.
    """
    by_temporal_vicinity = sorted(
        all_processes, key=lambda p: abs(p.age_seconds - process.age_seconds)
    )

    closest_raw = set()
    for close in by_temporal_vicinity:
        delta_seconds = abs(close.age_seconds - process.age_seconds)

        if delta_seconds <= 1:
            closest_raw.add(close)
            continue

        # "5" is arbitrarily chosen, look at the printouts to see if it needs tuning
        if len(closest_raw) > 5:
            break

        closest_raw.add(close)

    # Remove ourselves from the closest processes list
    closest = filter(
        lambda p: p is not process, closest_raw
    )  # type: Iterable[px_process.PxProcess]

    # Sort closest processes by age, command and PID in that order
    closest = sorted(closest, key=operator.attrgetter("command", "pid"))
    closest = sorted(closest, key=operator.attrgetter("age_seconds"), reverse=True)
    return closest


def print_processes_started_at_the_same_time(fd, process, all_processes):
    println(fd, "Other processes started close to " + str(process) + ":")
    for close in get_closest_starts(process, all_processes):
        println(fd, "  " + to_relative_start_string(process, close))


def print_users_when_process_started(fd, process):
    # type: (int, px_process.PxProcess) -> None
    println(fd, "Users logged in when " + str(process) + " started:")
    users = px_loginhistory.get_users_at(process.start_time)
    if not users:
        println(
            fd,
            "  <Nobody found, either nobody was logged in or the wtmp logs have been rotated>",
        )
        return

    for user in sorted(users):
        println(fd, "  " + user)


def to_ipc_lines(ipc_map):
    # type: (px_ipc_map.IpcMap) -> Iterable[str]

    return_me = []
    for target in sorted(ipc_map.keys(), key=operator.attrgetter("name", "pid")):
        channels = ipc_map[target]
        channel_names = set()  # type: MutableSet[str]
        for channel_name in map(lambda c: str(c), channels):
            channel_names.add(channel_name)
        for channel_name in sorted(channel_names):
            return_me.append(
                "{}: {}".format(px_terminal.bold(str(target)), channel_name)
            )

    return return_me


def print_cwd_friends(fd, process, all_processes, all_files):
    friends = px_cwdfriends.PxCwdFriends(process, all_processes, all_files)

    cwd_suffix = u""
    if friends.cwd:
        cwd_suffix = u" (" + px_terminal.bold(friends.cwd) + ")"
    println(fd, "Others sharing this process' working directory" + cwd_suffix)
    if not friends.cwd:
        sudo_px = px_terminal.bold("sudo px {}".format(process.pid))
        println(
            fd, '  Working directory unknown, try again or try "{}"'.format(sudo_px)
        )
        return

    if friends.cwd == "/":
        println(fd, "  Working directory too common, never mind.")
        return

    if len(friends.friends) == 0:
        println(fd, "  Nobody else shares this working directory.")
        return

    for friend in friends.friends:
        println(fd, "  " + str(friend))


def print_fds(fd, process, processes):
    # type: (int, px_process.PxProcess, Iterable[px_process.PxProcess]) -> None

    # It's true, I measured it myself /<EMAIL>
    println(
        fd,
        datetime.datetime.now().isoformat()
        + ": Now invoking lsof, this can take over a minute on a big system...",
    )

    # Flush what we have so far so the user has something to read during the pause.
    # This is useful when piping output into a pager like moar or less.

    # NOTE: If we switch to writing to file-like objects we should flush here,
    # our println() function flushes implicitly.

    files = px_file.get_all()
    println(fd, datetime.datetime.now().isoformat() + ": lsof done, proceeding.")

    println(fd, "")
    print_cwd_friends(fd, process, processes, files)

    is_root = os.geteuid() == 0
    ipc_map = px_ipc_map.IpcMap(process, files, processes, is_root=is_root)

    println(fd, "")
    println(fd, "File descriptors:")
    println(fd, "  stdin : " + ipc_map.fds[0])
    println(fd, "  stdout: " + ipc_map.fds[1])
    println(fd, "  stderr: " + ipc_map.fds[2])
    # Note that we used to list all FDs here, but some processes (like Chrome)
    # has silly amounts, making the px output unreadable. Users should consult
    # lsof directly for the full list.

    println(fd, "")
    println(fd, "Network connections:")
    # FIXME: Print "nothing found" or something if we don't find anything to put
    # here, maybe with a hint to run as root if we think that would help.
    for connection in sorted(
        ipc_map.network_connections, key=operator.attrgetter("name")
    ):
        println(fd, "  " + str(connection))

    println(fd, "")
    println(fd, "Inter Process Communication:")
    for line in to_ipc_lines(ipc_map):
        println(fd, "  " + line)

    println(fd, "")
    lsof = px_terminal.bold("sudo lsof -p {}".format(process.pid))
    watch_lsof = px_terminal.bold("sudo watch lsof -p {}".format(process.pid))
    println(
        fd,
        'For a list of all open files, do "{}", '
        'or "{}" for a live view.'.format(lsof, watch_lsof),
    )

    if os.getuid() != 0:
        println(fd, "")
        println(
            fd,
            "NOTE: This information might be incomplete, "
            "running as root sometimes produces better results.",
        )


def print_start_time(fd, process):
    # type: (int, px_process.PxProcess) -> None
    println(
        fd,
        "{} {} was started by {}, at {}.".format(
            px_terminal.bold(process.age_s + " ago"),
            process.command,
            px_terminal.bold(process.username),
            px_terminal.bold(process.start_time.isoformat()),
        ),
    )

    if process.cpu_time_seconds and process.age_seconds:
        cpu_percent = 100.0 * process.cpu_time_seconds / process.age_seconds
        println(
            fd,
            "{} has been its average CPU usage since then, or {}/{}".format(
                px_terminal.bold("{:.1f}%".format(cpu_percent)),
                px_terminal.bold(process.cpu_time_s),
                px_terminal.bold(process.age_s),
            ),
        )


def print_pid_info(fd, pid):
    # type: (int, int) -> None
    processes = px_process.get_all()

    process = find_process_by_pid(pid, processes)
    if not process:
        sys.stderr.write("No such PID: {}\n".format(pid))
        exit(1)

    print_process_info(fd, process, processes)


def print_process_info(fd, process, processes):
    # type: (int, px_process.PxProcess, List[px_process.PxProcess]) -> None
    print_command_line(fd, process)

    # Print a process tree with all PID's parents and all its children
    println(fd, "")
    print_process_tree(fd, process)

    println(fd, "")
    print_start_time(fd, process)

    println(fd, "")
    print_processes_started_at_the_same_time(fd, process, processes)

    println(fd, "")
    print_users_when_process_started(fd, process)

    # List all files PID has open
    println(fd, "")
    try:
        print_fds(fd, process, processes)
    except OSError as e:
        if e.errno != errno.ENOENT:
            raise
        println(
            fd,
            'Can\'t list IPC / network sockets, make sure "lsof" is installed and in your $PATH',
        )
# For mypy PEP-484 static typing validation # NOQA # NOQA # NOQA # NOQA # NOQA # NOQA # type: (int, text_type) -> None # type: (int, List[px_process.PxProcess]) -> Optional[px_process.PxProcess] # type: (int, px_process.PxProcess) -> None Print command line separated by linefeeds rather than space, this adds     readability to long command lines # Print empty parameters as "", otherwise the printout just looks # broken. # type: (int, px_process.PxProcess, int, List[Tuple[str, px_process.PxProcess]]) -> None # type: (int, px_process.PxProcess) -> None # Contains tuples; the line to print and the process that line is for # type: List[Tuple[str, px_process.PxProcess]] # List all parents up to the top # FIXME: There can actually be loops; we must detect that hand handle it appropriately # Print all parents # Print ourselves # Print all our child trees # Add an owners column to the right of the tree # NOTE: This logic should match its friend in # px_terminal.py/to_screen_lines() # Neither root nor ourselves, highlight! # type: (px_process.PxProcess, List[px_process.PxProcess]) -> List[px_process.PxProcess] Return the processes that were started closest in time to the base process.      All processes started within 1s of the base process are returned, or the     five closest if not at least five were that close. # "5" is arbitrarily chosen, look at the printouts to see if it needs tuning # Remove ourselves from the closest processes list # type: Iterable[px_process.PxProcess] # Sort closest processes by age, command and PID in that order # type: (int, px_process.PxProcess) -> None # type: (px_ipc_map.IpcMap) -> Iterable[str] # type: MutableSet[str] # type: (int, px_process.PxProcess, Iterable[px_process.PxProcess]) -> None # It's true, I measured it myself /<EMAIL> # Flush what we have so far so the user has something to read during the pause. # This is useful when piping output into a pager like moar or less. # NOTE: If we switch to writing to file-like objects we should flush here, # our println() function flushes implicitly. # Note that we used to list all FDs here, but some processes (like Chrome) # has silly amounts, making the px output unreadable. Users should consult # lsof directly for the full list. # FIXME: Print "nothing found" or something if we don't find anything to put # here, maybe with a hint to run as root if we think that would help. # type: (int, px_process.PxProcess) -> None # type: (int, int) -> None # type: (int, px_process.PxProcess, List[px_process.PxProcess]) -> None # Print a process tree with all PID's parents and all its children # List all files PID has open