/* * Copyright (c) 2018-2020, Andreas Kling * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * 1. Redistributions of source code must retain the above copyright notice, this * list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #include "GlobalState.h" #include "LineEditor.h" #include "Parser.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include //#define SH_DEBUG GlobalState g; static LineEditor editor; static int run_command(const String&); static String prompt() { if (g.uid == 0) return "# "; StringBuilder builder; builder.appendf("\033]0;%s@%s:%s\007", g.username.characters(), g.hostname, g.cwd.characters()); builder.appendf("\033[31;1m%s\033[0m@\033[37;1m%s\033[0m:\033[32;1m%s\033[0m$> ", g.username.characters(), g.hostname, g.cwd.characters()); return builder.to_string(); } static int sh_pwd(int, char**) { printf("%s\n", g.cwd.characters()); return 0; } static int sh_exit(int, char**) { printf("Good-bye!\n"); exit(0); return 0; } static int sh_export(int argc, char** argv) { if (argc == 1) { for (int i = 0; environ[i]; ++i) puts(environ[i]); return 0; } auto parts = String(argv[1]).split('='); if (parts.size() != 2) { fprintf(stderr, "usage: export variable=value\n"); return 1; } int setenv_return = setenv(parts[0].characters(), parts[1].characters(), 1); if (setenv_return == 0 && parts[0] == "PATH") editor.cache_path(); return setenv_return; } static int sh_unset(int argc, char** argv) { if (argc != 2) { fprintf(stderr, "usage: unset variable\n"); return 1; } unsetenv(argv[1]); return 0; } static int sh_cd(int argc, char** argv) { char pathbuf[PATH_MAX]; if (argc == 1) { strcpy(pathbuf, g.home.characters()); } else { if (strcmp(argv[1], "-") == 0) { char* oldpwd = getenv("OLDPWD"); if (oldpwd == nullptr) return 1; size_t len = strlen(oldpwd); ASSERT(len + 1 <= PATH_MAX); memcpy(pathbuf, oldpwd, len + 1); } else if (argv[1][0] == '/') { memcpy(pathbuf, argv[1], strlen(argv[1]) + 1); } else { sprintf(pathbuf, "%s/%s", g.cwd.characters(), argv[1]); } } FileSystemPath canonical_path(pathbuf); if (!canonical_path.is_valid()) { printf("FileSystemPath failed to canonicalize '%s'\n", pathbuf); return 1; } const char* path = canonical_path.string().characters(); struct stat st; int rc = stat(path, &st); if (rc < 0) { printf("stat(%s) failed: %s\n", path, strerror(errno)); return 1; } if (!S_ISDIR(st.st_mode)) { printf("Not a directory: %s\n", path); return 1; } rc = chdir(path); if (rc < 0) { printf("chdir(%s) failed: %s\n", path, strerror(errno)); return 1; } setenv("OLDPWD", g.cwd.characters(), 1); g.cwd = canonical_path.string(); setenv("PWD", g.cwd.characters(), 1); return 0; } static int sh_history(int, char**) { for (int i = 0; i < editor.history().size(); ++i) { printf("%6d %s\n", i, editor.history()[i].characters()); } return 0; } static int sh_time(int argc, char** argv) { if (argc == 1) { printf("usage: time \n"); return 0; } StringBuilder builder; for (int i = 1; i < argc; ++i) { builder.append(argv[i]); if (i != argc - 1) builder.append(' '); } CElapsedTimer timer; timer.start(); int exit_code = run_command(builder.to_string()); printf("Time: %d ms\n", timer.elapsed()); return exit_code; } static int sh_umask(int argc, char** argv) { if (argc == 1) { mode_t old_mask = umask(0); printf("%#o\n", old_mask); umask(old_mask); return 0; } if (argc == 2) { unsigned mask; int matches = sscanf(argv[1], "%o", &mask); if (matches == 1) { umask(mask); return 0; } } printf("usage: umask \n"); return 0; } static int sh_popd(int argc, char** argv) { if (g.directory_stack.size() <= 1) { fprintf(stderr, "Shell: popd: directory stack empty\n"); return 1; } bool should_switch = true; String path = g.directory_stack.take_last(); // When no arguments are given, popd removes the top directory from the stack and performs a cd to the new top directory. if (argc == 1) { int rc = chdir(path.characters()); if (rc < 0) { fprintf(stderr, "chdir(%s) failed: %s", path.characters(), strerror(errno)); return 1; } g.cwd = path; return 0; } for (int i = 1; i < argc; i++) { const char* arg = argv[i]; if (!strcmp(arg, "-n")) { should_switch = false; } } FileSystemPath canonical_path(path.characters()); if (!canonical_path.is_valid()) { fprintf(stderr, "FileSystemPath failed to canonicalize '%s'\n", path.characters()); return 1; } const char* real_path = canonical_path.string().characters(); struct stat st; int rc = stat(real_path, &st); if (rc < 0) { fprintf(stderr, "stat(%s) failed: %s\n", real_path, strerror(errno)); return 1; } if (!S_ISDIR(st.st_mode)) { fprintf(stderr, "Not a directory: %s\n", real_path); return 1; } if (should_switch) { int rc = chdir(real_path); if (rc < 0) { fprintf(stderr, "chdir(%s) failed: %s\n", real_path, strerror(errno)); return 1; } g.cwd = canonical_path.string(); } return 0; } static int sh_pushd(int argc, char** argv) { StringBuilder path_builder; bool should_switch = true; // From the BASH reference manual: https://www.gnu.org/software/bash/manual/html_node/Directory-Stack-Builtins.html // With no arguments, pushd exchanges the top two directories and makes the new top the current directory. if (argc == 1) { if (g.directory_stack.size() < 2) { fprintf(stderr, "pushd: no other directory\n"); return 1; } String dir1 = g.directory_stack.take_first(); String dir2 = g.directory_stack.take_first(); g.directory_stack.insert(0, dir2); g.directory_stack.insert(1, dir1); int rc = chdir(dir2.characters()); if (rc < 0) { fprintf(stderr, "chdir(%s) failed: %s", dir2.characters(), strerror(errno)); return 1; } g.cwd = dir2; return 0; } // Let's assume the user's typed in 'pushd ' if (argc == 2) { g.directory_stack.append(g.cwd.characters()); if (argv[1][0] == '/') { path_builder.append(argv[1]); } else { path_builder.appendf("%s/%s", g.cwd.characters(), argv[1]); } } else if (argc == 3) { g.directory_stack.append(g.cwd.characters()); for (int i = 1; i < argc; i++) { const char* arg = argv[i]; if (arg[0] != '-') { if (arg[0] == '/') { path_builder.append(arg); } else path_builder.appendf("%s/%s", g.cwd.characters(), arg); } if (!strcmp(arg, "-n")) should_switch = false; } } FileSystemPath canonical_path(path_builder.to_string()); if (!canonical_path.is_valid()) { fprintf(stderr, "FileSystemPath failed to canonicalize '%s'\n", path_builder.to_string().characters()); return 1; } const char* real_path = canonical_path.string().characters(); struct stat st; int rc = stat(real_path, &st); if (rc < 0) { fprintf(stderr, "stat(%s) failed: %s\n", real_path, strerror(errno)); return 1; } if (!S_ISDIR(st.st_mode)) { fprintf(stderr, "Not a directory: %s\n", real_path); return 1; } if (should_switch) { int rc = chdir(real_path); if (rc < 0) { fprintf(stderr, "chdir(%s) failed: %s\n", real_path, strerror(errno)); return 1; } g.cwd = canonical_path.string(); } return 0; } static int sh_dirs(int argc, char** argv) { // The first directory in the stack is ALWAYS the current directory g.directory_stack.at(0) = g.cwd.characters(); if (argc == 1) { for (String dir : g.directory_stack) printf("%s ", dir.characters()); printf("\n"); return 0; } bool printed = false; for (int i = 0; i < argc; i++) { const char* arg = argv[i]; if (!strcmp(arg, "-c")) { for (int i = 1; i < g.directory_stack.size(); i++) g.directory_stack.remove(i); printed = true; continue; } if (!strcmp(arg, "-p") && !printed) { for (auto& directory : g.directory_stack) printf("%s\n", directory.characters()); printed = true; continue; } if (!strcmp(arg, "-v") && !printed) { int idx = 0; for (auto& directory : g.directory_stack) { printf("%d %s\n", idx++, directory.characters()); } printed = true; continue; } } return 0; } static bool handle_builtin(int argc, char** argv, int& retval) { if (argc == 0) return false; if (!strcmp(argv[0], "cd")) { retval = sh_cd(argc, argv); return true; } if (!strcmp(argv[0], "pwd")) { retval = sh_pwd(argc, argv); return true; } if (!strcmp(argv[0], "exit")) { retval = sh_exit(argc, argv); return true; } if (!strcmp(argv[0], "export")) { retval = sh_export(argc, argv); return true; } if (!strcmp(argv[0], "unset")) { retval = sh_unset(argc, argv); return true; } if (!strcmp(argv[0], "history")) { retval = sh_history(argc, argv); return true; } if (!strcmp(argv[0], "umask")) { retval = sh_umask(argc, argv); return true; } if (!strcmp(argv[0], "dirs")) { retval = sh_dirs(argc, argv); return true; } if (!strcmp(argv[0], "pushd")) { retval = sh_pushd(argc, argv); return true; } if (!strcmp(argv[0], "popd")) { retval = sh_popd(argc, argv); return true; } if (!strcmp(argv[0], "time")) { retval = sh_time(argc, argv); return true; } return false; } class FileDescriptionCollector { public: FileDescriptionCollector() {} ~FileDescriptionCollector() { collect(); } void collect() { for (auto fd : m_fds) close(fd); m_fds.clear(); } void add(int fd) { m_fds.append(fd); } private: Vector m_fds; }; class CommandTimer { public: explicit CommandTimer(const String& command) : m_command(command) { m_timer.start(); } ~CommandTimer() { dbg() << "Command \"" << m_command << "\" finished in " << m_timer.elapsed() << " ms"; } private: CElapsedTimer m_timer; String m_command; }; static bool is_glob(const StringView& s) { for (size_t i = 0; i < s.length(); i++) { char c = s.characters_without_null_termination()[i]; if (c == '*' || c == '?') return true; } return false; } static Vector split_path(const StringView& path) { Vector parts; size_t substart = 0; for (size_t i = 0; i < path.length(); i++) { char ch = path.characters_without_null_termination()[i]; if (ch != '/') continue; size_t sublen = i - substart; if (sublen != 0) parts.append(path.substring_view(substart, sublen)); parts.append(path.substring_view(i, 1)); substart = i + 1; } size_t taillen = path.length() - substart; if (taillen != 0) parts.append(path.substring_view(substart, taillen)); return parts; } static Vector expand_globs(const StringView& path, const StringView& base) { auto parts = split_path(path); StringBuilder builder; builder.append(base); Vector res; for (int i = 0; i < parts.size(); ++i) { auto& part = parts[i]; if (!is_glob(part)) { builder.append(part); continue; } // Found a glob. String new_base = builder.to_string(); StringView new_base_v = new_base; if (new_base_v.is_empty()) new_base_v = "."; CDirIterator di(new_base_v, CDirIterator::NoFlags); if (di.has_error()) { return res; } while (di.has_next()) { String name = di.next_path(); // Dotfiles have to be explicitly requested if (name[0] == '.' && part[0] != '.') continue; // And even if they are, skip . and .. if (name == "." || name == "..") continue; if (name.matches(part, String::CaseSensitivity::CaseSensitive)) { StringBuilder nested_base; nested_base.append(new_base); nested_base.append(name); StringView remaining_path = path.substring_view_starting_after_substring(part); Vector nested_res = expand_globs(remaining_path, nested_base.to_string()); for (auto& s : nested_res) res.append(s); } } return res; } // Found no globs. String new_path = builder.to_string(); if (access(new_path.characters(), F_OK) == 0) res.append(new_path); return res; } static Vector expand_parameters(const StringView& param) { bool is_variable = param.length() > 1 && param[0] == '$'; if (!is_variable) return { param }; String variable_name = String(param.substring_view(1, param.length() - 1)); if (variable_name == "?") return { String::number(g.last_return_code) }; else if (variable_name == "$") return { String::number(getpid()) }; char* env_value = getenv(variable_name.characters()); if (env_value == nullptr) return { "" }; Vector res; String str_env_value = String(env_value); const auto& split_text = str_env_value.split_view(' '); for (auto& part : split_text) res.append(part); return res; } static Vector process_arguments(const Vector& args) { Vector argv_string; for (auto& arg : args) { // This will return the text passed in if it wasn't a variable // This lets us just loop over its values auto expanded_parameters = expand_parameters(arg); for (auto& exp_arg : expanded_parameters) { auto expanded_globs = expand_globs(exp_arg, ""); for (auto& path : expanded_globs) argv_string.append(path); if (expanded_globs.is_empty()) argv_string.append(exp_arg); } } return argv_string; } static int run_command(const String& cmd) { if (cmd.is_empty()) return 0; if (cmd.starts_with("#")) return 0; auto commands = Parser(cmd).parse(); #ifdef SH_DEBUG for (auto& command : commands) { for (int i = 0; i < command.subcommands.size(); ++i) { for (int j = 0; j < i; ++j) dbgprintf(" "); for (auto& arg : command.subcommands[i].args) { dbgprintf("<%s> ", arg.characters()); } dbgprintf("\n"); for (auto& redirecton : command.subcommands[i].redirections) { for (int j = 0; j < i; ++j) dbgprintf(" "); dbgprintf(" "); switch (redirecton.type) { case Redirection::Pipe: dbgprintf("Pipe\n"); break; case Redirection::FileRead: dbgprintf("fd:%d = FileRead: %s\n", redirecton.fd, redirecton.path.characters()); break; case Redirection::FileWrite: dbgprintf("fd:%d = FileWrite: %s\n", redirecton.fd, redirecton.path.characters()); break; case Redirection::FileWriteAppend: dbgprintf("fd:%d = FileWriteAppend: %s\n", redirecton.fd, redirecton.path.characters()); break; default: break; } } } dbgprintf("\n"); } #endif struct termios trm; tcgetattr(0, &trm); struct SpawnedProcess { String name; pid_t pid; }; int return_value = 0; for (auto& command : commands) { if (command.subcommands.is_empty()) continue; FileDescriptionCollector fds; for (int i = 0; i < command.subcommands.size(); ++i) { auto& subcommand = command.subcommands[i]; for (auto& redirection : subcommand.redirections) { switch (redirection.type) { case Redirection::Pipe: { int pipefd[2]; int rc = pipe(pipefd); if (rc < 0) { perror("pipe"); return 1; } subcommand.rewirings.append({ STDOUT_FILENO, pipefd[1] }); auto& next_command = command.subcommands[i + 1]; next_command.rewirings.append({ STDIN_FILENO, pipefd[0] }); fds.add(pipefd[0]); fds.add(pipefd[1]); break; } case Redirection::FileWriteAppend: { int fd = open(redirection.path.characters(), O_WRONLY | O_CREAT | O_APPEND, 0666); if (fd < 0) { perror("open"); return 1; } subcommand.rewirings.append({ redirection.fd, fd }); fds.add(fd); break; } case Redirection::FileWrite: { int fd = open(redirection.path.characters(), O_WRONLY | O_CREAT | O_TRUNC, 0666); if (fd < 0) { perror("open"); return 1; } subcommand.rewirings.append({ redirection.fd, fd }); fds.add(fd); break; } case Redirection::FileRead: { int fd = open(redirection.path.characters(), O_RDONLY); if (fd < 0) { perror("open"); return 1; } subcommand.rewirings.append({ redirection.fd, fd }); fds.add(fd); break; } } } } Vector children; CommandTimer timer(cmd); for (int i = 0; i < command.subcommands.size(); ++i) { auto& subcommand = command.subcommands[i]; Vector argv_string = process_arguments(subcommand.args); Vector argv; argv.ensure_capacity(argv_string.size()); for (const auto& s : argv_string) { argv.append(s.characters()); } argv.append(nullptr); #ifdef SH_DEBUG for (auto& arg : argv) { dbgprintf("<%s> ", arg); } dbgprintf("\n"); #endif int retval = 0; if (handle_builtin(argv.size() - 1, const_cast(argv.data()), retval)) return retval; pid_t child = fork(); if (!child) { setpgid(0, 0); tcsetpgrp(0, getpid()); tcsetattr(0, TCSANOW, &g.default_termios); for (auto& rewiring : subcommand.rewirings) { #ifdef SH_DEBUG dbgprintf("in %s<%d>, dup2(%d, %d)\n", argv[0], getpid(), rewiring.rewire_fd, rewiring.fd); #endif int rc = dup2(rewiring.rewire_fd, rewiring.fd); if (rc < 0) { perror("dup2"); return 1; } } fds.collect(); int rc = execvp(argv[0], const_cast(argv.data())); if (rc < 0) { if (errno == ENOENT) fprintf(stderr, "%s: Command not found.\n", argv[0]); else fprintf(stderr, "execvp(%s): %s\n", argv[0], strerror(errno)); _exit(1); } ASSERT_NOT_REACHED(); } children.append({ argv[0], child }); } #ifdef SH_DEBUG dbgprintf("Closing fds in shell process:\n"); #endif fds.collect(); #ifdef SH_DEBUG dbgprintf("Now we gotta wait on children:\n"); for (auto& child : children) dbgprintf(" %d (%s)\n", child.pid, child.name.characters()); #endif int wstatus = 0; for (int i = 0; i < children.size(); ++i) { auto& child = children[i]; do { int rc = waitpid(child.pid, &wstatus, WEXITED | WSTOPPED); if (rc < 0 && errno != EINTR) { if (errno != ECHILD) perror("waitpid"); break; } if (WIFEXITED(wstatus)) { if (WEXITSTATUS(wstatus) != 0) dbg() << "Shell: " << child.name << ":" << child.pid << " exited with status " << WEXITSTATUS(wstatus); if (i == 0) return_value = WEXITSTATUS(wstatus); } else if (WIFSTOPPED(wstatus)) { printf("Shell: %s(%d) stopped.\n", child.name.characters(), child.pid); } else { if (WIFSIGNALED(wstatus)) { printf("Shell: %s(%d) exited due to signal '%s'\n", child.name.characters(), child.pid, strsignal(WTERMSIG(wstatus))); } else { printf("Shell: %s(%d) exited abnormally\n", child.name.characters(), child.pid); } } } while (errno == EINTR); } } g.last_return_code = return_value; // FIXME: Should I really have to tcsetpgrp() after my child has exited? // Is the terminal controlling pgrp really still the PGID of the dead process? tcsetpgrp(0, getpid()); tcsetattr(0, TCSANOW, &trm); return return_value; } static String get_history_path() { StringBuilder builder; builder.append(g.home); builder.append("/.history"); return builder.to_string(); } void load_history() { auto history_file = CFile::construct(get_history_path()); if (!history_file->open(CIODevice::ReadOnly)) return; while (history_file->can_read_line()) { auto b = history_file->read_line(1024); // skip the newline and terminating bytes editor.add_to_history(String(reinterpret_cast(b.data()), b.size() - 2)); } } void save_history() { auto history_file = CFile::construct(get_history_path()); if (!history_file->open(CIODevice::WriteOnly)) return; for (const auto& line : editor.history()) { history_file->write(line); history_file->write("\n"); } } int main(int argc, char** argv) { if (pledge("stdio rpath wpath cpath proc exec tty", nullptr) < 0) { perror("pledge"); return 1; } g.uid = getuid(); g.sid = setsid(); tcsetpgrp(0, getpgrp()); tcgetattr(0, &g.default_termios); g.termios = g.default_termios; // Because we use our own line discipline which includes echoing, // we disable ICANON and ECHO. g.termios.c_lflag &= ~(ECHO | ICANON); tcsetattr(0, TCSANOW, &g.termios); signal(SIGINT, [](int) { g.was_interrupted = true; }); signal(SIGHUP, [](int) { save_history(); }); signal(SIGWINCH, [](int) { g.was_resized = true; }); int rc = gethostname(g.hostname, sizeof(g.hostname)); if (rc < 0) perror("gethostname"); rc = ttyname_r(0, g.ttyname, sizeof(g.ttyname)); if (rc < 0) perror("ttyname_r"); { auto* pw = getpwuid(getuid()); if (pw) { g.username = pw->pw_name; g.home = pw->pw_dir; setenv("HOME", pw->pw_dir, 1); } endpwent(); } if (argc > 2 && !strcmp(argv[1], "-c")) { dbgprintf("sh -c '%s'\n", argv[2]); run_command(argv[2]); return 0; } if (argc == 2 && argv[1][0] != '-') { auto file = CFile::construct(argv[1]); if (!file->open(CIODevice::ReadOnly)) { fprintf(stderr, "Failed to open %s: %s\n", file->filename().characters(), file->error_string()); return 1; } for (;;) { auto line = file->read_line(4096); if (line.is_null()) break; run_command(String::copy(line, Chomp)); } return 0; } { auto* cwd = getcwd(nullptr, 0); g.cwd = cwd; setenv("PWD", cwd, 1); free(cwd); } g.directory_stack.append(g.cwd); load_history(); atexit(save_history); editor.cache_path(); for (;;) { auto line = editor.get_line(prompt()); if (line.is_empty()) continue; run_command(line); editor.add_to_history(line); } return 0; }