teliva/src/teliva.c

1942 lines
64 KiB
C

#include <assert.h>
#include <ctype.h>
#ifdef __NetBSD__
#include <curses.h>
#else
#include <ncurses.h>
#endif
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <unistd.h>
#include "lua.h"
#include "lauxlib.h"
#include "lualib.h"
#undef getstr
#include "lstate.h"
#include "teliva.h"
#include "tlv.h"
int starts_with(const char* s, const char* prefix) {
return strncmp(s, prefix, strlen(prefix)) == 0;
}
int contains(const char* s, const char* sub) {
return strstr(s, sub) != NULL;
}
int any_equal(char* const* arr, const char* s) {
for (int i = 0; arr[i]; ++i)
if (strcmp(arr[i], s) == 0)
return 1;
return 0;
}
int any_starts_with(char* const* arr, const char* s) {
for (int i = 0; arr[i]; ++i)
if (starts_with(s, arr[i]))
return 1;
return 0;
}
/*** Standard UI elements */
int menu_column = 0;
void draw_string_on_menu(const char* s) {
mvaddstr(LINES-1, menu_column, " ");
++menu_column;
mvaddstr(LINES-1, menu_column, s);
menu_column += strlen(s);
mvaddstr(LINES-1, menu_column, " ");
++menu_column;
}
void draw_menu_item(const char* key, const char* name) {
attroff(A_REVERSE);
draw_string_on_menu(key);
attron(A_REVERSE);
draw_string_on_menu(name);
}
static const char* trim(const char* in) {
static char result[1024];
int len = strlen(in);
assert(len < 1020);
const char* str = in;
const char* end = in+len-1;
while (isspace((unsigned char)*str)) {
++str;
--len;
}
while (isspace((unsigned char)*end)) {
--end;
--len;
}
memset(result, '\0', 1024);
memcpy(result, str, len);
return result;
}
int ask_for_permission_on_every_file_operation = 0;
const char* default_file_operations_predicate_body = "return false\n";
const char* file_operations_predicate_body;
int net_operations_permitted = false;
static void render_permissions(lua_State* L);
char* Previous_message;
static void draw_menu(lua_State* L) {
attron(A_BOLD|A_REVERSE);
color_set(COLOR_PAIR_MENU, NULL);
for (int x = 0; x < COLS; ++x)
mvaddch(LINES-1, x, ' ');
menu_column = 2;
draw_menu_item("^x", "exit");
/* if app ran successfully, render any app-specific items */
if (Previous_message == NULL) {
lua_getglobal(L, "menu");
int table = lua_gettop(L);
if (lua_istable(L, -1)) {
for (int i = 1; i <= luaL_getn(L, table); ++i) {
lua_rawgeti(L, table, i);
int menu_item = lua_gettop(L);
lua_rawgeti(L, menu_item, 1); /* key */
lua_rawgeti(L, menu_item, 2); /* value */
draw_menu_item(lua_tostring(L, -2), lua_tostring(L, -1));
lua_pop(L, 3);
}
}
lua_pop(L, 1);
}
else {
/* otherwise render the flash message */
attron(COLOR_PAIR(COLOR_PAIR_ERROR));
addstr(" ");
addstr(Previous_message);
addstr(" ");
attroff(COLOR_PAIR(COLOR_PAIR_ERROR));
}
/* render stuff common to all apps on the right */
menu_column = COLS-37;
draw_menu_item("^u", "edit app");
draw_menu_item("^p", "perms");
attrset(A_NORMAL);
mvaddstr(LINES-1, COLS-12, "");
render_permissions(L);
attrset(A_NORMAL);
}
const char* character_name(char c) {
if (c == '\n') return "ENTER";
if (c == '\t') return "TAB";
if (c == ' ') return "SPACE";
return "UNKNOWN";
}
static void render_permissions(lua_State* L) {
int file_colors = COLOR_PAIR_SAFE;
if (ask_for_permission_on_every_file_operation)
file_colors = COLOR_PAIR_WARN;
else if (file_operations_predicate_body && strcmp("return false", trim(file_operations_predicate_body)) != 0)
file_colors = COLOR_PAIR_WARN;
int net_colors = net_operations_permitted ? COLOR_PAIR_WARN : COLOR_PAIR_SAFE;
if (file_colors == COLOR_PAIR_WARN && net_colors == COLOR_PAIR_WARN) {
file_colors = net_colors = COLOR_PAIR_RISK;
}
attron(COLOR_PAIR(file_colors));
addstr("file ");
attron(A_REVERSE);
addstr(" ");
attroff(COLOR_PAIR(file_colors));
attron(COLOR_PAIR(net_colors));
addstr(" ");
attroff(A_REVERSE);
addstr(" net");
attroff(COLOR_PAIR(net_colors));
}
void render_trusted_teliva_data(lua_State* L) {
init_pair(COLOR_PAIR_ERROR, COLOR_ERROR_FOREGROUND, COLOR_ERROR_BACKGROUND);
init_pair(COLOR_PAIR_MENU, COLOR_FOREGROUND, COLOR_BACKGROUND);
init_pair(COLOR_PAIR_SAFE, COLOR_SAFE_REVERSE, COLOR_FOREGROUND);
init_pair(COLOR_PAIR_WARN, COLOR_WARN_REVERSE, COLOR_FOREGROUND);
init_pair(COLOR_PAIR_RISK, COLOR_RISK_REVERSE, COLOR_FOREGROUND);
int y, x;
getyx(stdscr, y, x);
draw_menu(L);
mvaddstr(y, x, "");
}
/*** Error reporting */
const char* Previous_error = NULL;
/* return final y containing text */
static int render_wrapped_text(int y, int xmin, int xmax, const char* text) {
int x = xmin;
move(y, x);
for (int j = 0; j < strlen(text); ++j) {
char c = text[j];
if (c != '\n') {
addch(text[j]);
++x;
if (x >= xmax) {
++y;
x = xmin;
move(y, x);
}
}
else {
/* newline */
++y;
x = xmin;
move(y, x);
}
}
return y;
}
void render_previous_error(void) {
if (!Previous_error) return;
init_pair(COLOR_PAIR_ERROR, COLOR_ERROR_FOREGROUND, COLOR_ERROR_BACKGROUND);
attron(COLOR_PAIR(COLOR_PAIR_ERROR));
render_wrapped_text(LINES-10, COLS/2, COLS, Previous_error);
attroff(COLOR_PAIR(COLOR_PAIR_ERROR));
}
int report_in_developer_mode(lua_State* L, int status) {
if (status && !lua_isnil(L, -1)) {
Previous_error = strdup(lua_tostring(L, -1)); /* memory leak */
if (Previous_error == NULL) Previous_error = "(error object is not a string)";
lua_pop(L, 1);
for (int x = 0; x < COLS; ++x) {
mvaddch(LINES-2, x, ' ');
mvaddch(LINES-1, x, ' ');
}
render_previous_error();
mvaddstr(LINES-1, 0, "press any key to continue");
getch();
developer_mode(L);
}
return status;
}
/*** Developer mode, big picture view */
#define CURRENT_DEFINITION_LEN 256
static void big_picture_menu(void) {
attrset(A_REVERSE);
for (int x = 0; x < COLS; ++x)
mvaddch(LINES-1, x, ' ');
attrset(A_NORMAL);
menu_column = 2;
draw_menu_item("^x", "go back");
draw_menu_item("^g", "go to highlight");
draw_menu_item("Enter", "submit");
draw_menu_item("^h", "backspace");
draw_menu_item("^u", "clear");
draw_menu_item("^r", "recent changes");
draw_menu_item("^e", "recent events");
attrset(A_NORMAL);
}
static int is_current_definition(lua_State* L, const char* definition_name, int current_history_array_index, int history_array_location, int history_array_size) {
/* Sequentially scan back through history_array until current_history_array_index.
* Is there an earlier definition of definition_name? */
int oldtop = lua_gettop(L);
int found = 0;
for (int i = history_array_size; i > current_history_array_index; --i) {
lua_rawgeti(L, history_array_location, i);
int t = lua_gettop(L);
for (lua_pushnil(L); lua_next(L, t) != 0;) {
lua_pop(L, 1); // value
const char* curr = lua_tostring(L, -1);
if (strcmp(curr, definition_name) == 0) {
found = 1;
lua_pop(L, 1); // key
break;
}
// leave key on stack for next iteration
}
lua_pop(L, 1); // history element
if (found)
break;
}
if(oldtop != lua_gettop(L)) {
endwin();
printf("%d %d\n", oldtop, lua_gettop(L));
exit(1);
}
return !found;
}
void draw_definition_name(const char* definition_name) {
attron(COLOR_PAIR(COLOR_PAIR_SELECTABLE));
addstr(" ");
addstr(definition_name);
addstr(" ");
attroff(COLOR_PAIR(COLOR_PAIR_SELECTABLE));
addstr(" ");
}
void draw_highlighted_definition_name(const char* definition_name) {
attron(A_REVERSE);
addstr(" ");
addstr(definition_name);
addstr(" ");
attroff(A_REVERSE);
addstr(" ");
}
void save_call_graph_depth(lua_State* L, int depth, const char* name) {
/* Maintain a global table mapping from function name to call-stack depth
* at first call to it.
*
* Won't be perfect; might get confused by shadowing locals. But we can't
* be perfect without a bidirectional mapping between interpreter state
* and source code. Which would make Lua either a lot less dynamic or a
* a lot more like Smalltalk. */
// push table
luaL_newmetatable(L, "__teliva_call_graph_depth");
int cgt = lua_gettop(L);
// if key doesn't already exist, set it
lua_getfield(L, cgt, name);
if (lua_isnil(L, -1)) {
lua_pushinteger(L, depth);
lua_setfield(L, cgt, name);
}
// clean up
lua_pop(L, 1); // value
lua_pop(L, 1); // table
}
/* Don't rely on this for security. It's visible to apps and so can be mutated
* by them. */
static const char* name_of_global(lua_State* L, const CallInfo* ci, int frame) {
const char* result = NULL;
Closure* func = ci_func(ci-frame);
int oldtop = lua_gettop(L);
// push table of function names
luaL_newmetatable(L, "__teliva_global_name");
int gt = lua_gettop(L);
lua_pushinteger(L, (long int)func);
lua_rawget(L, gt);
if (!lua_isnil(L, -1))
result = lua_tostring(L, -1); // safe because global names are long-lived and never GC'd
lua_pop(L, 1); // value
lua_pop(L, 1); // table of global names
assert(lua_gettop(L) == oldtop);
return result;
}
static void precompute_names_of_globals(lua_State* L) {
int oldtop = lua_gettop(L);
luaL_newmetatable(L, "__teliva_global_name");
int gt = lua_gettop(L);
lua_pushvalue(L, LUA_GLOBALSINDEX);
int table = lua_gettop(L);
for (lua_pushnil(L); lua_next(L, table) != 0; lua_pop(L, 1)) {
const char* key = lua_tostring(L, -2);
const void* value = lua_topointer(L, -1);
lua_pushinteger(L, (long int)value);
lua_pushstring(L, key);
lua_rawset(L, gt);
}
lua_pop(L, 1); // table of globals
lua_pop(L, 1); // table of global names
assert(lua_gettop(L) == oldtop);
}
static void save_caller(lua_State* L, const char* name, const char* caller_name) {
int oldtop = lua_gettop(L);
// push table of caller tables
luaL_newmetatable(L, "__teliva_caller");
int ct = lua_gettop(L);
// if key doesn't already exist, map it to an empty caller table
lua_getfield(L, ct, name);
if (lua_isnil(L, -1)) {
lua_newtable(L);
lua_setfield(L, ct, name);
}
// append the caller's name to the caller table if necessary
lua_pop(L, 1); // old value
lua_getfield(L, ct, name); // new value = caller table
int curr_caller_index = lua_gettop(L);
lua_pushboolean(L, true);
lua_setfield(L, curr_caller_index, caller_name);
// clean up
lua_pop(L, 1); // caller table
lua_pop(L, 1); // table of caller tables
assert(lua_gettop(L) == oldtop);
}
void record_metadata_about_function_call (lua_State *L, CallInfo *ci) {
const char* function_name = name_of_global(L, ci, 0);
long int call_graph_depth = ci - L->base_ci;
/* note to self: the function pointer is at ci_func(ci) */
if (function_name) {
save_call_graph_depth(L, call_graph_depth, function_name);
if (call_graph_depth <= 1) return;
const char* caller_name = name_of_global(L, ci, 1);
if (caller_name)
save_caller(L, function_name, caller_name);
else if (call_graph_depth == 3)
save_caller(L, function_name, "main");
}
}
static void clear_caller(lua_State* L) {
int oldtop = lua_gettop(L);
luaL_newmetatable(L, "__teliva_caller");
int ct = lua_gettop(L);
lua_pushnil(L);
while (lua_next(L, ct) != 0) {
lua_pop(L, 1); /* old value */
lua_pushvalue(L, -1); /* duplicate key */
lua_pushnil(L); /* new value */
lua_settable(L, ct);
/* one copy of key left for lua_next */
}
lua_pop(L, 1);
assert(lua_gettop(L) == oldtop);
}
/* return true if submitted */
static int edit_current_definition(lua_State* L);
static void recent_changes_view(lua_State* L);
static const char* events_view();
static int look_up_definition (lua_State* L, const char* name);
void default_big_picture_view(lua_State* L) {
/* Without any intervening edits, big_picture_view always stably renders
* definitions in exactly the same spatial order, both in levels from top to
* bottom and in indexes within each level from left to right. */
int highlight_level = 0;
int highlight_index_within_level = 0;
int level_size[30] = {0}; /* number of indexes within each level */
char highlight[CURRENT_DEFINITION_LEN+1] = {0};
restart:
clear();
luaL_newmetatable(L, "__teliva_call_graph_depth");
int cgt = lua_gettop(L);
// segment definitions by depth
lua_getglobal(L, "teliva_program");
int history_array = lua_gettop(L);
int history_array_size = luaL_getn(L, history_array);
int y = 1;
attrset(A_BOLD);
mvaddstr(y, 0, "Big picture");
attrset(A_NORMAL);
y += 2;
int found = look_up_definition(L, "doc:blurb");
if (found) {
assert(lua_isstring(L, -1));
y = render_wrapped_text(y, 8, 68, lua_tostring(L, -1));
y += 2;
lua_pop(L, 1);
}
mvaddstr(y, 0, "data: ");
// first: data (non-functions) that's not the Teliva menu or curses variables
if (highlight_level < 0) highlight_level = 0;
int level = 0;
int index_within_level = 0;
for (int i = history_array_size; i > 0; --i) {
lua_rawgeti(L, history_array, i);
int t = lua_gettop(L);
for (lua_pushnil(L); lua_next(L, t) != 0; lua_pop(L, 1)) {
const char* definition_name = lua_tostring(L, -2);
if (is_special_history_key(definition_name)) continue;
if (starts_with(definition_name, "doc:")) continue;
lua_getglobal(L, definition_name);
int is_userdata = lua_isuserdata(L, -1);
int is_function = lua_isfunction(L, -1);
lua_pop(L, 1);
if (strcmp(definition_name, "menu") != 0 // required by all Teliva programs
&& !is_function // functions are not data
&& !is_userdata // including curses window objects
// (unlikely to have an interesting definition)
) {
if (is_current_definition(L, definition_name, i, history_array, history_array_size)) {
if (level == highlight_level && index_within_level == highlight_index_within_level) {
draw_highlighted_definition_name(definition_name);
strncpy(highlight, definition_name, CURRENT_DEFINITION_LEN);
} else {
draw_definition_name(definition_name);
}
++index_within_level;
}
}
}
lua_pop(L, 1); // history element
}
// second: menu and other userdata
for (int i = history_array_size; i > 0; --i) {
lua_rawgeti(L, history_array, i);
int t = lua_gettop(L);
for (lua_pushnil(L); lua_next(L, t) != 0; lua_pop(L, 1)) {
const char* definition_name = lua_tostring(L, -2);
if (is_special_history_key(definition_name)) continue;
if (starts_with(definition_name, "doc:")) continue;
lua_getglobal(L, definition_name);
int is_userdata = lua_isuserdata(L, -1);
lua_pop(L, 1);
if (strcmp(definition_name, "menu") == 0
|| is_userdata // including curses window objects
) {
if (is_current_definition(L, definition_name, i, history_array, history_array_size)) {
if (level == highlight_level && index_within_level == highlight_index_within_level) {
draw_highlighted_definition_name(definition_name);
strncpy(highlight, definition_name, CURRENT_DEFINITION_LEN);
} else {
draw_definition_name(definition_name);
}
++index_within_level;
}
}
}
lua_pop(L, 1); // history element
}
level_size[level] = index_within_level;
level++;
// documentation (non-code) buffers
y += 2;
mvprintw(y, 0, "prose: ");
index_within_level = 0;
for (int i = history_array_size; i > 0; --i) {
lua_rawgeti(L, history_array, i);
int t = lua_gettop(L);
for (lua_pushnil(L); lua_next(L, t) != 0; lua_pop(L, 1)) {
const char* definition_name = lua_tostring(L, -2);
if (is_special_history_key(definition_name)) continue;
if (starts_with(definition_name, "doc:")) {
if (is_current_definition(L, definition_name, i, history_array, history_array_size)) {
if (level == highlight_level && index_within_level == highlight_index_within_level) {
draw_highlighted_definition_name(definition_name);
strncpy(highlight, definition_name, CURRENT_DEFINITION_LEN);
} else {
draw_definition_name(definition_name);
}
++index_within_level;
}
}
}
lua_pop(L, 1); // history element
}
level_size[level] = index_within_level;
level++;
// functions by level
y += 2;
mvprintw(y, 0, "functions: ");
y++;
for (int depth = /*main*/2; ; ++depth) {
mvaddstr(y, 0, " ");
bool drew_anything = false;
index_within_level = 0;
for (int i = history_array_size; i > 0; --i) {
lua_rawgeti(L, history_array, i);
int t = lua_gettop(L);
for (lua_pushnil(L); lua_next(L, t) != 0; lua_pop(L, 1)) {
const char* definition_name = lua_tostring(L, -2);
if (is_special_history_key(definition_name)) continue;
lua_getfield(L, cgt, definition_name);
int definition_depth = lua_tointeger(L, -1);
if (definition_depth == depth) {
if (is_current_definition(L, definition_name, i, history_array, history_array_size)) {
if (level == highlight_level && index_within_level == highlight_index_within_level) {
draw_highlighted_definition_name(definition_name);
strncpy(highlight, definition_name, CURRENT_DEFINITION_LEN);
} else {
draw_definition_name(definition_name);
}
++index_within_level;
}
drew_anything = true;
}
lua_pop(L, 1); // depth of value
}
lua_pop(L, 1); // history element
}
y += 2;
if (!drew_anything) break;
level_size[level] = index_within_level;
level++;
}
// unused functions
mvaddstr(y, 0, " ");
/* no need to level++ because the final iteration above didn't draw anything */
index_within_level = 0;
for (int i = history_array_size; i > 0; --i) {
lua_rawgeti(L, history_array, i);
int t = lua_gettop(L);
for (lua_pushnil(L); lua_next(L, t) != 0; lua_pop(L, 1)) {
const char* definition_name = lua_tostring(L, -2);
if (is_special_history_key(definition_name)) continue;
lua_getglobal(L, definition_name);
int is_function = lua_isfunction(L, -1);
lua_pop(L, 1);
lua_getfield(L, cgt, definition_name);
if (is_function && lua_isnoneornil(L, -1)) {
if (is_current_definition(L, definition_name, i, history_array, history_array_size)) {
if (level == highlight_level && index_within_level == highlight_index_within_level) {
draw_highlighted_definition_name(definition_name);
strncpy(highlight, definition_name, CURRENT_DEFINITION_LEN);
} else {
draw_definition_name(definition_name);
}
++index_within_level;
}
}
lua_pop(L, 1); // depth of value
}
lua_pop(L, 1); // history element
}
level_size[level] = index_within_level;
int max_level = level;
lua_settop(L, 0);
render_previous_error();
char query[CURRENT_DEFINITION_LEN+1] = {0};
int qlen = 0;
while (1) {
big_picture_menu();
for (int x = 0; x < COLS; ++x)
mvaddch(LINES-2, x, ' ');
//? mvprintw(20, 60, "%d %d\n", highlight_level, highlight_index_within_level);
mvprintw(LINES-2, 0, "Edit: %s", query);
int c = getch();
if (c == KEY_BACKSPACE || c == DELETE || c == CTRL_H) {
if (qlen != 0) query[--qlen] = '\0';
} else if (c == CTRL_X) {
return;
} else if (c == ENTER) {
if (query[0] != '\0') {
save_to_current_definition_and_editor_buffer(L, query);
int back_to_big_picture = edit_current_definition(L);
if (back_to_big_picture) goto restart;
return;
}
} else if (c == CTRL_U) {
qlen = 0;
query[qlen] = '\0';
} else if (c == CTRL_R) {
recent_changes_view(L);
goto restart;
} else if (c == KEY_LEFT) {
highlight_index_within_level--;
if (highlight_index_within_level < 0) highlight_index_within_level = 0;
goto restart;
} else if (c == KEY_RIGHT) {
highlight_index_within_level++;
if (highlight_index_within_level >= level_size[highlight_level])
highlight_index_within_level = level_size[highlight_level]-1;
if (highlight_index_within_level < 0) highlight_index_within_level = 0;
goto restart;
} else if (c == KEY_UP) {
highlight_level--;
if (highlight_level < 0) highlight_level = 0;
if (highlight_index_within_level >= level_size[highlight_level])
highlight_index_within_level = level_size[highlight_level]-1;
if (highlight_index_within_level < 0) highlight_index_within_level = 0;
goto restart;
} else if (c == KEY_DOWN) {
highlight_level++;
if (highlight_level > max_level) highlight_level = max_level;
if (highlight_index_within_level >= level_size[highlight_level])
highlight_index_within_level = level_size[highlight_level]-1;
if (highlight_index_within_level < 0) highlight_index_within_level = 0;
goto restart;
} else if (c == CTRL_G) {
save_to_current_definition_and_editor_buffer(L, highlight);
int back_to_big_picture = edit_current_definition(L);
if (back_to_big_picture) goto restart;
return;
} else if (c == CTRL_E) {
const char* definition = events_view();
if (definition) {
save_to_current_definition_and_editor_buffer(L, definition);
int back_to_big_picture = edit_current_definition(L);
if (back_to_big_picture) goto restart;
}
return;
} else if (isprint(c)) {
if (qlen < CURRENT_DEFINITION_LEN) {
query[qlen++] = c;
query[qlen] = '\0';
}
}
}
/* never gets here */
}
extern int edit(lua_State* L, char* filename, char* definition_name);
void big_picture_view(lua_State* L) {
int oldtop = lua_gettop(L);
if (!look_up_definition(L, "doc:main")) {
lua_settop(L, oldtop);
default_big_picture_view(L);
} else {
save_to_current_definition_and_editor_buffer(L, "doc:main");
int back_to_big_picture = edit_current_definition(L);
if (back_to_big_picture)
default_big_picture_view(L);
}
lua_settop(L, oldtop);
}
/* return true if:
* - editor_state exists, and
* - editor_state is applicable to the current image
* Implicitly loads current editor state. */
int editor_view_in_progress(lua_State* L) {
FILE* in = fopen("teliva_editor_state", "r");
if (in == NULL) return 0;
int oldtop = lua_gettop(L);
teliva_load_definition(L, in);
int t = lua_gettop(L);
lua_getfield(L, t, "image");
const char* image_name = lua_tostring(L, -1);
int result = (strcmp(image_name, Image_name) == 0);
lua_pop(L, 1); /* image value */
lua_setglobal(L, "__teliva_editor_state");
assert(lua_gettop(L) == oldtop);
return result;
}
char Current_definition[CURRENT_DEFINITION_LEN+1] = {0};
void draw_current_definition_name_and_callers(lua_State* L) {
int oldtop = lua_gettop(L);
mvaddstr(0, 0, "");
draw_definition_name(Current_definition);
luaL_newmetatable(L, "__teliva_caller");
int ct = lua_gettop(L);
lua_getfield(L, ct, Current_definition);
if (lua_isnil(L, -1)) {
lua_pop(L, 2);
assert(oldtop == lua_gettop(L));
return;
}
int ctc = lua_gettop(L);
attron(COLOR_PAIR(COLOR_PAIR_FADE));
addstr("callers: ");
attroff(COLOR_PAIR(COLOR_PAIR_FADE));
for (lua_pushnil(L); lua_next(L, ctc) != 0; lua_pop(L, 1)) {
const char* caller_name = lua_tostring(L, -2);
draw_definition_name(caller_name);
}
lua_pop(L, 2); // caller table, __teliva_caller
assert(oldtop == lua_gettop(L));
}
extern int resumeEdit(lua_State* L);
extern int editFrom(lua_State* L, char* filename, char* definition_name, int rowoff, int coloff, int cy, int cx);
int restore_editor_view(lua_State* L) {
lua_getglobal(L, "__teliva_editor_state");
int editor_state_index = lua_gettop(L);
lua_getfield(L, editor_state_index, "definition");
const char* definition = lua_tostring(L, -1);
save_to_current_definition_and_editor_buffer(L, definition);
lua_getfield(L, editor_state_index, "rowoff");
int rowoff = lua_tointeger(L, -1);
lua_getfield(L, editor_state_index, "coloff");
int coloff = lua_tointeger(L, -1);
lua_getfield(L, editor_state_index, "cy");
int cy = lua_tointeger(L, -1);
lua_getfield(L, editor_state_index, "cx");
int cx = lua_tointeger(L, -1);
lua_settop(L, editor_state_index);
int back_to_big_picture = editFrom(L, "teliva_editor_buffer", Current_definition, rowoff, coloff, cy, cx);
if (starts_with(Current_definition, "doc:")) {
load_editor_buffer_to_current_definition_in_image(L);
return back_to_big_picture;
}
// error handling
int oldtop = lua_gettop(L);
while (1) {
int status;
status = load_editor_buffer_to_current_definition_in_image_and_reload(L);
if (status == 0 || lua_isnil(L, -1))
break;
Previous_error = lua_tostring(L, -1);
if (Previous_error == NULL) Previous_error = "(error object is not a string)";
back_to_big_picture = resumeEdit(L);
lua_pop(L, 1);
}
if (lua_gettop(L) != oldtop) {
endwin();
printf("editFrom: memory leak %d -> %d\n", oldtop, lua_gettop(L));
exit(1);
}
return back_to_big_picture;
}
char** Argv = NULL;
extern void cleanup_curses(void);
void developer_mode(lua_State* L) {
/* clobber the app's ncurses colors; we'll restart the app when we rerun it. */
assume_default_colors(COLOR_FOREGROUND, COLOR_BACKGROUND);
init_pair(COLOR_PAIR_NORMAL, COLOR_FOREGROUND, COLOR_BACKGROUND);
init_pair(COLOR_PAIR_SELECTABLE, COLOR_SELECTABLE_FOREGROUND, COLOR_SELECTABLE_BACKGROUND);
init_pair(COLOR_PAIR_FADE, COLOR_FADE, COLOR_BACKGROUND);
init_pair(COLOR_PAIR_MENU_ALTERNATE, COLOR_MENU_ALTERNATE, COLOR_BACKGROUND);
init_pair(COLOR_PAIR_LUA_COMMENT, COLOR_LUA_COMMENT, COLOR_BACKGROUND);
init_pair(COLOR_PAIR_LUA_KEYWORD, COLOR_LUA_KEYWORD, COLOR_BACKGROUND);
init_pair(COLOR_PAIR_LUA_CONSTANT, COLOR_LUA_CONSTANT, COLOR_BACKGROUND);
init_pair(COLOR_PAIR_MATCH, COLOR_MATCH_FOREGROUND, COLOR_MATCH_BACKGROUND);
init_pair(COLOR_PAIR_ERROR, COLOR_ERROR_FOREGROUND, COLOR_ERROR_BACKGROUND);
nodelay(stdscr, 0); /* always make getch() block in developer mode */
curs_set(1); /* always display cursor in developer mode */
int switch_to_big_picture_view = 1;
if (editor_view_in_progress(L))
switch_to_big_picture_view = restore_editor_view(L);
if (switch_to_big_picture_view)
big_picture_view(L);
cleanup_curses();
execv(Argv[0], Argv);
/* never returns */
}
void save_editor_state(int rowoff, int coloff, int cy, int cx) {
if (strlen(Current_definition) == 0) return;
char outfilename[] = "teliva_editor_state_XXXXXX";
int outfd = mkstemp(outfilename);
if (outfd == -1) {
endwin();
perror("error in creating temporary file");
abort();
}
FILE* out = fdopen(outfd, "w");
assert(out != NULL);
fprintf(out, "- image: %s\n", Image_name);
fprintf(out, " definition: %s\n", Current_definition);
fprintf(out, " rowoff: %d\n", rowoff);
fprintf(out, " coloff: %d\n", coloff);
fprintf(out, " cy: %d\n", cy);
fprintf(out, " cx: %d\n", cx);
fclose(out);
rename(outfilename, "teliva_editor_state");
}
/* when found, return 1 and leave string on top of stack
* when not found, return 0
* caller is responsible for cleaning up the stack. */
static int look_up_definition (lua_State* L, const char* name) {
lua_getglobal(L, "teliva_program");
int history_array = lua_gettop(L);
/* iterate over mutations in teliva_program history in reverse order */
int history_array_size = luaL_getn(L, history_array);
for (int i = history_array_size; i > 0; --i) {
lua_rawgeti(L, history_array, i);
int table = lua_gettop(L);
/* iterate over bindings */
/* really we expect only one */
for (lua_pushnil(L); lua_next(L, table) != 0; lua_pop(L, 1)) {
const char* key = lua_tostring(L, -2);
if (strcmp(key, "__teliva_undo") == 0) {
int next_i = lua_tointeger(L, -1);
assert(next_i < i);
i = next_i + 1; /* account for decrement */
lua_pop(L, 1);
break;
}
if (is_special_history_key(key)) continue;
if (strcmp(key, name) == 0)
return 1;
}
lua_pop(L, 1);
}
lua_pop(L, 1);
return 0;
}
void save_to_current_definition_and_editor_buffer(lua_State* L, const char* definition) {
int oldtop = lua_gettop(L);
strncpy(Current_definition, definition, CURRENT_DEFINITION_LEN);
int status = look_up_definition(L, Current_definition);
char outfilename[] = "teliva_editor_buffer_XXXXXX";
int outfd = mkstemp(outfilename);
if (outfd == -1) {
endwin();
perror("save_to_current_definition_and_editor_buffer: error in creating temporary file");
abort();
}
FILE* out = fdopen(outfd, "w");
assert(out != NULL);
if (status)
fprintf(out, "%s", lua_tostring(L, -1));
fclose(out);
rename(outfilename, "teliva_editor_buffer");
lua_settop(L, oldtop);
}
/* I don't understand the best way to read all of a text file.
* I'm currently using fread, but its error handling is really designed for
* binary data containing fixed-size records. */
static void read_editor_buffer(char* out, int capacity) {
FILE* in = fopen("teliva_editor_buffer", "r");
fread(out, capacity, 1, in); /* TODO: handle overly large file */
fclose(in);
}
static void update_definition(lua_State* L, const char* name, char* new_contents) {
int oldtop = lua_gettop(L);
/* if contents are unmodified, return */
if (look_up_definition(L, name)) {
const char* old_contents = lua_tostring(L, -1);
bool contents_unmodified = (strcmp(old_contents, new_contents) == 0);
lua_settop(L, oldtop);
if (contents_unmodified) return;
}
lua_getglobal(L, "teliva_program");
int history_array = lua_gettop(L);
/* create a new table containing a single binding */
lua_createtable(L, /*number of fields per mutation*/2, 0);
lua_pushstring(L, new_contents);
assert(strlen(name) > 0);
lua_setfield(L, -2, name);
/* include timestamp at which binding was created */
time_t t;
time(&t);
char* time_string = ctime(&t);
lua_pushstring(L, time_string);
lua_setfield(L, -2, "__teliva_timestamp");
/* append the new table to the history of mutations */
int history_array_size = luaL_getn(L, history_array);
++history_array_size;
lua_rawseti(L, history_array, history_array_size);
lua_settop(L, oldtop);
}
extern void save_tlv(lua_State* L, char* filename);
void load_editor_buffer_to_current_definition_in_image(lua_State* L) {
char new_contents[8192] = {0};
read_editor_buffer(new_contents, 8190);
update_definition(L, Current_definition, new_contents);
save_tlv(L, Image_name);
}
extern int docall(lua_State* L, int narg, int clear);
int load_editor_buffer_to_current_definition_in_image_and_reload(lua_State* L) {
char new_contents[8192] = {0};
read_editor_buffer(new_contents, 8190);
update_definition(L, Current_definition, new_contents);
save_tlv(L, Image_name);
/* reload binding */
return luaL_loadbuffer(L, new_contents, strlen(new_contents), Current_definition)
|| docall(L, 0, 1);
}
/* return true if user chose to back into the big picture view */
/* But only if there are no errors. Otherwise things can get confusing. */
static int edit_current_definition(lua_State* L) {
int back_to_big_picture = edit(L, "teliva_editor_buffer", Current_definition);
if (starts_with(Current_definition, "doc:")) {
load_editor_buffer_to_current_definition_in_image(L);
return back_to_big_picture;
}
// error handling
int oldtop = lua_gettop(L);
while (1) {
int status;
status = load_editor_buffer_to_current_definition_in_image_and_reload(L);
if (status == 0 || lua_isnil(L, -1))
break;
Previous_error = lua_tostring(L, -1);
if (Previous_error == NULL) Previous_error = "(error object is not a string)";
back_to_big_picture = resumeEdit(L);
lua_pop(L, 1);
}
if (lua_gettop(L) != oldtop) {
endwin();
printf("edit_current_definition: memory leak %d -> %d\n", oldtop, lua_gettop(L));
exit(1);
}
return back_to_big_picture;
}
static void recent_changes_menu(int cursor, int history_array_size) {
attrset(A_REVERSE);
for (int x = 0; x < COLS; ++x)
mvaddch(LINES-1, x, ' ');
attrset(A_NORMAL);
menu_column = 2;
draw_menu_item("^x", "go back");
/* draw_menu_item("↓|space", "older"); */
attroff(A_REVERSE);
mvaddstr(LINES-1, menu_column, "");
attron(COLOR_PAIR(COLOR_PAIR_MENU_ALTERNATE));
addstr("|");
attroff(COLOR_PAIR(COLOR_PAIR_MENU_ALTERNATE));
addstr("space ");
menu_column += 9; /* strlen isn't sufficient */
attron(A_REVERSE);
draw_string_on_menu("older");
/* draw_menu_item("↑|backspace|delete|^h", "newer"); */
attroff(A_REVERSE);
mvaddstr(LINES-1, menu_column, "");
attron(COLOR_PAIR(COLOR_PAIR_MENU_ALTERNATE));
addstr("|");
attroff(COLOR_PAIR(COLOR_PAIR_MENU_ALTERNATE));
addstr("backspace");
attron(COLOR_PAIR(COLOR_PAIR_MENU_ALTERNATE));
addstr("|");
attroff(COLOR_PAIR(COLOR_PAIR_MENU_ALTERNATE));
addstr("delete");
attron(COLOR_PAIR(COLOR_PAIR_MENU_ALTERNATE));
addstr("|");
attroff(COLOR_PAIR(COLOR_PAIR_MENU_ALTERNATE));
addstr("^h ");
menu_column += 23;
attron(A_REVERSE);
draw_string_on_menu("newer");
draw_menu_item("^e", "edit note");
if (cursor < history_array_size)
draw_menu_item("^u", "undo everything after this");
attrset(A_NORMAL);
}
/* return final y containing text */
static int render_wrapped_lua_text(int y, int xmin, int xmax, const char* text) {
int x = xmin;
move(y, x);
for (int j = 0; j < strlen(text); ++j) {
char c = text[j];
if (c == '-' && j+1 < strlen(text) && text[j+1] == '-')
attron(COLOR_PAIR(COLOR_PAIR_LUA_COMMENT));
if (c != '\n') {
addch(text[j]);
++x;
if (x >= xmax) {
++y;
x = xmin;
move(y, x);
}
}
else {
/* newline */
++y;
x = xmin;
move(y, x);
attroff(COLOR_PAIR(COLOR_PAIR_LUA_COMMENT));
}
}
return y;
}
static void render_recent_changes(lua_State* L, int start_index) {
clear();
attrset(A_BOLD);
mvaddstr(1, 0, "Recent changes");
attrset(A_NORMAL);
int oldtop = lua_gettop(L);
lua_getglobal(L, "teliva_program");
int history_array = lua_gettop(L);
int history_array_size = luaL_getn(L, history_array);
int y = 3;
attron(A_REVERSE);
for (int i = start_index; i > 0; --i) {
attron(A_BOLD);
mvprintw(y, 0, "%3d. ", i);
attrset(A_NORMAL);
lua_rawgeti(L, history_array, i);
int t = lua_gettop(L);
for (lua_pushnil(L); lua_next(L, t) != 0; lua_pop(L, 1)) {
if (strcmp(lua_tostring(L, -2), "__teliva_undo") == 0) {
addstr("undo to ");
attron(A_BOLD);
printw("%d", lua_tointeger(L, -1));
attroff(A_BOLD);
y++;
continue;
}
const char* definition_name = lua_tostring(L, -2);
if (is_special_history_key(definition_name)) continue;
addstr(definition_name);
/* save timestamp of binding if available */
lua_getfield(L, t, "__teliva_timestamp");
if (!lua_isnil(L, -1)) {
char buffer[128] = {0};
strncpy(buffer, lua_tostring(L, -1), 120);
if (buffer[strlen(buffer)-1] == '\n')
buffer[strlen(buffer)-1] = '\0';
attron(COLOR_PAIR(COLOR_PAIR_FADE));
printw(" %s", buffer);
attroff(COLOR_PAIR(COLOR_PAIR_FADE));
}
lua_pop(L, 1);
lua_getfield(L, t, "__teliva_note");
if (!lua_isnil(L, -1)) {
attron(COLOR_PAIR(COLOR_PAIR_FADE));
printw(" -- %s", lua_tostring(L, -1));
attroff(COLOR_PAIR(COLOR_PAIR_FADE));
}
lua_pop(L, 1);
y++;
const char* definition_contents = lua_tostring(L, -1);
y = render_wrapped_lua_text(y, 0, COLS, definition_contents);
y++;
if (y >= LINES-1) break; /* leave cruft on the stack */
}
lua_settop(L, t); /* clean up cruft on the stack */
lua_pop(L, 1); // history element
y++;
if (y >= LINES-1) break;
}
lua_pop(L, 1); // history array
if (lua_gettop(L) != oldtop) {
endwin();
printf("render_recent_changes: memory leak %d -> %d\n", oldtop, lua_gettop(L));
exit(1);
}
recent_changes_menu(start_index, history_array_size);
refresh();
}
static void add_undo_event(lua_State* L, int cursor) {
lua_getglobal(L, "teliva_program");
int history_array = lua_gettop(L);
/* create a new table containing the undo event */
lua_createtable(L, /*number of fields per mutation*/2, 0);
lua_pushinteger(L, cursor);
lua_setfield(L, -2, "__teliva_undo");
/* include timestamp at which event was created */
time_t t;
time(&t);
char* time_string = ctime(&t);
lua_pushstring(L, time_string);
lua_setfield(L, -2, "__teliva_timestamp");
/* append the new table to the history of mutations */
int history_array_size = luaL_getn(L, history_array);
++history_array_size;
lua_rawseti(L, history_array, history_array_size);
/* clean up */
lua_pop(L, 1);
}
static void save_note_to_editor_buffer(lua_State* L, int cursor) {
lua_getglobal(L, "teliva_program");
lua_rawgeti(L, -1, cursor);
lua_getfield(L, -1, "__teliva_note");
const char* contents = lua_tostring(L, -1);
char outfilename[] = "teliva_editor_buffer_XXXXXX";
int outfd = mkstemp(outfilename);
if (outfd == -1) {
endwin();
perror("save_note_to_editor_buffer: error in creating temporary file");
abort();
}
FILE* out = fdopen(outfd, "w");
assert(out != NULL);
if (contents != NULL)
fprintf(out, "%s", contents);
fclose(out);
rename(outfilename, "teliva_editor_buffer");
lua_pop(L, 3); /* contents, table at cursor, teliva_program */
}
static void load_note_from_editor_buffer(lua_State* L, int cursor) {
lua_getglobal(L, "teliva_program");
char new_contents[8192] = {0};
read_editor_buffer(new_contents, 8190);
lua_rawgeti(L, -1, cursor);
lua_pushstring(L, new_contents);
lua_setfield(L, -2, "__teliva_note");
lua_pop(L, 2); /* table at cursor, teliva_program */
}
extern void editNonCode(char* filename);
static void recent_changes_view(lua_State* L) {
lua_getglobal(L, "teliva_program");
int history_array = lua_gettop(L);
assert(history_array == 1);
int history_array_size = luaL_getn(L, history_array);
int cursor = history_array_size;
lua_pop(L, 1);
int quit = 0;
while (!quit) {
/* refresh state after each operation so we pick up modifications */
render_recent_changes(L, cursor);
int c = getch();
switch (c) {
case CTRL_X:
quit = 1;
break;
case KEY_DOWN:
case ' ':
if (cursor > 1) --cursor;
break;
case KEY_UP:
case KEY_BACKSPACE:
case DELETE:
case CTRL_H:
if (cursor < history_array_size) ++cursor;
break;
case CTRL_E:
save_note_to_editor_buffer(L, cursor);
/* big picture hotkey unnecessarily available here */
editNonCode("teliva_editor_buffer");
load_note_from_editor_buffer(L, cursor);
save_tlv(L, Image_name);
break;
case CTRL_U:
if (cursor < history_array_size) {
add_undo_event(L, cursor);
save_tlv(L, Image_name);
}
break;
}
}
}
static int binding_exists (lua_State *L, const char *name) {
int result = 0;
lua_getglobal(L, name);
result = !lua_isnil(L, -1);
lua_pop(L, 1);
return result;
}
extern int dostring(lua_State* L, const char* s, const char* name);
static int load_definitions(lua_State* L) {
int status;
lua_getglobal(L, "teliva_program");
int history_array = lua_gettop(L);
/* iterate over mutations in teliva_program history in reverse order */
int history_array_size = luaL_getn(L, history_array);
for (int i = history_array_size; i > 0; --i) {
lua_rawgeti(L, history_array, i);
int table = lua_gettop(L);
/* iterate over bindings */
/* really we expect only one */
for (lua_pushnil(L); lua_next(L, table) != 0; lua_pop(L, 1)) {
const char* key = lua_tostring(L, -2);
if (strcmp(key, "__teliva_undo") == 0) {
int next_i = lua_tointeger(L, -1);
assert(next_i < i);
i = next_i + 1; /* account for decrement */
lua_pop(L, 1);
break;
}
if (is_special_history_key(key)) continue;
if (starts_with(key, "doc:")) continue;
if (binding_exists(L, key))
continue; // most recent binding trumps older ones
const char* value = lua_tostring(L, -1);
status = dostring(L, value, key);
if (status != 0) return report_in_developer_mode(L, status);
}
lua_pop(L, 1);
}
lua_pop(L, 1);
return 0;
}
static int run_tests(lua_State* L) {
clear();
int oldtop = lua_gettop(L);
lua_pushinteger(L, 0);
lua_setglobal(L, "teliva_num_test_failures");
lua_pushnil(L);
lua_setglobal(L, "teliva_first_failure");
lua_pushvalue(L, LUA_GLOBALSINDEX);
int table = lua_gettop(L);
for (lua_pushnil(L); lua_next(L, table) != 0; lua_pop(L, 1)) {
const char* key = lua_tostring(L, -2);
if (strncmp("test_", key, strlen("test_")) != 0) continue;
if (!lua_isfunction(L, -1)) continue;
/* uncomment these lines when it's not clear which test is failing */
//? addstr(key);
//? addstr("|");
int status = lua_pcall(L, 0, 0, 0);
if (status) {
printw("E%d: %s", status, lua_tostring(L, -1));
/* increment teliva_num_test_failures */
lua_getglobal(L, "teliva_num_test_failures");
int num_failures = lua_tointeger(L, -1);
lua_pop(L, 1);
lua_pushinteger(L, num_failures+1);
lua_setglobal(L, "teliva_num_test_failures");
/* if unset, set teliva_first_failure */
lua_getglobal(L, "teliva_first_failure");
int first_failure_clear = lua_isnil(L, -1);
lua_pop(L, 1);
if (first_failure_clear)
lua_setglobal(L, "teliva_first_failure");
else
lua_pop(L, 1);
}
lua_pushnil(L); /* just to undo loop update */
}
lua_pop(L, 1);
lua_getglobal(L, "teliva_num_test_failures");
int num_failures = lua_tointeger(L, -1);
lua_pop(L, 1);
if (lua_gettop(L) != oldtop) {
endwin();
printf("render_recent_changes: memory leak %d -> %d\n", oldtop, lua_gettop(L));
exit(1);
}
if (num_failures == 0) return 0;
if (num_failures == 1)
addstr("1 failure");
else
printw("%d failures", num_failures);
/* take first failure back to developer mode */
lua_getglobal(L, "teliva_first_failure");
assert(!lua_isnil(L, -1));
return 1;
}
static void clear_call_graph_depth(lua_State* L) {
int oldtop = lua_gettop(L);
luaL_newmetatable(L, "__teliva_call_graph_depth");
int cgt = lua_gettop(L);
lua_pushnil(L);
while (lua_next(L, cgt) != 0) {
lua_pop(L, 1); /* old value */
lua_pushvalue(L, -1); /* duplicate key */
lua_pushnil(L); /* new value */
lua_settable(L, cgt);
/* one copy of key left for lua_next */
}
lua_pop(L, 1);
assert(lua_gettop(L) == oldtop);
}
/*** Permissions */
/* Perform privilege calculations in a whole other isolated context. */
lua_State* trustedL = NULL;
static int isarg(lua_State* trustedL) {
const char* arg = luaL_checkstring(trustedL, -1);
lua_pushboolean(trustedL, any_equal(Argv, arg));
return 1;
}
static int inarg(lua_State* trustedL) {
const char* arg = luaL_checkstring(trustedL, -1);
lua_pushboolean(trustedL, any_starts_with(Argv, arg));
return 1;
}
static const luaL_Reg trusted_base_funcs[] = {
{"isarg", isarg},
{"inarg", inarg},
};
void initialize_trustedL() {
trustedL = luaL_newstate();
lua_gc(trustedL, LUA_GCSTOP, 0); /* stop collector during initialization */
luaL_openlibs(trustedL);
luaL_register(trustedL, "_G", trusted_base_funcs);
/* TODO: Should we include ncurses? How to debug policies? */
lua_gc(trustedL, LUA_GCRESTART, 0);
}
static const char* user_configuration_filename() {
const char* home = getenv("HOME");
if (home == NULL) {
endwin();
fprintf(stderr, "$HOME is not set; unclear where to save permissions.\n");
abort();
}
static char config_filename[1024] = {0};
memset(config_filename, '\0', 1024);
const char* config_home = getenv("XDG_CONFIG_HOME");
if (config_home == NULL)
snprintf(config_filename, 1020, "%s/.teliva", home);
else
snprintf(config_filename, 1020, "%s/.teliva", config_home);
return config_filename;
}
static int file_operation_permitted_manually(const char* filename, const char* mode) {
int old_y, old_x;
getyx(stdscr, old_y, old_x);
attr_t old_attrs;
short old_pair;
attr_get(&old_attrs, &old_pair, NULL);
attrset(A_NORMAL);
mvaddstr(LINES-1, 0, "");
clrtoeol();
attrset(A_REVERSE);
if (strncmp(mode, "r", /*strlen("r") + 1 for NULL*/ 2) == 0)
mvprintw(LINES-1, 0, "open file \"%s\" for reading? ", filename);
else
mvprintw(LINES-1, 0, "open file \"%s\" for reading and writing? ", filename);
attrset(A_NORMAL);
int response = getch();
attr_set(old_attrs, old_pair, NULL);
mvaddstr(old_y, old_x, "");
return response == 'y';
}
static int file_operation_permitted_automatically(const char* filename, const char* mode) {
int oldtop = lua_gettop(trustedL);
lua_getglobal(trustedL, "file_operation_permitted");
lua_pushstring(trustedL, filename);
lua_pushboolean(trustedL, strncmp(mode, "r", /*strlen("r") + 1 for NULL*/ 2) != 0);
if (lua_pcall(trustedL, 2 /*args*/, 1 /*result*/, /*errfunc*/0)) {
/* TODO: error handling. Or should we use errfunc above? */
}
if (!lua_isboolean(trustedL, -1)) {
endwin();
printf("Sorry, there's an error in permissions for this image.\n");
printf("Delete '%s' or try editing it by hand.\n", user_configuration_filename());
exit(1);
}
int should_allow = lua_toboolean(trustedL, -1);
lua_settop(trustedL, oldtop);
return should_allow;
}
int file_operation_permitted(const char* filename, const char* mode) {
if (ask_for_permission_on_every_file_operation)
return file_operation_permitted_manually(filename, mode);
else
return file_operation_permitted_automatically(filename, mode);
}
static void permissions_menu() {
attrset(A_REVERSE);
for (int x = 0; x < COLS; ++x)
mvaddch(LINES-1, x, ' ');
attrset(A_NORMAL);
menu_column = 2;
draw_menu_item("^x", "go back");
if (!ask_for_permission_on_every_file_operation) {
draw_menu_item("^f", "edit file permissions");
draw_menu_item("^a", "ask for permission on every file operation");
}
else {
draw_menu_item("^a", "stop asking for permission on every file operation");
}
draw_menu_item("^n", "toggle network permissions");
attrset(A_NORMAL);
}
void characterize_file_operations_predicate() {
static const char* test_filenames[] = { "foo", "/foo", "../foo", NULL };
static const char* test_modes[] = { "r", "r+", "w", "w+", "a", "a+", NULL };
int num_attempts = 0;
int num_rejections = 0;
int num_errors = 0;
for (const char** test_filename = test_filenames; *test_filename; ++test_filename) {
for (const char** test_mode = test_modes; *test_mode; ++test_mode) {
lua_getglobal(trustedL, "file_operation_permitted");
lua_pushstring(trustedL, *test_filename);
lua_pushstring(trustedL, *test_mode);
if (lua_pcall(trustedL, 2 /*args*/, 1 /*result*/, /*errfunc*/0)) {
/* TODO: error handling. Or should we use errfunc above? */
}
++num_attempts;
if (!lua_isboolean(trustedL, -1)) {
++num_errors;
} else {
if (!lua_toboolean(trustedL, -1))
++num_rejections;
}
}
}
if (num_errors > 0) {
attron(COLOR_PAIR(COLOR_PAIR_ERROR));
addstr(" Throws errors some of the time. You should fix them before moving on. ");
attroff(COLOR_PAIR(COLOR_PAIR_ERROR));
}
else if (strcmp("return false", trim(file_operations_predicate_body)) == 0) {
attron(COLOR_PAIR(COLOR_PAIR_SAFE));
addstr("● Rejects all file operations.");
attroff(COLOR_PAIR(COLOR_PAIR_SAFE));
}
else if (strcmp("return true", trim(file_operations_predicate_body)) == 0) {
attron(COLOR_PAIR(COLOR_PAIR_WARN));
addstr("◯ Allows all file operations.");
attroff(COLOR_PAIR(COLOR_PAIR_WARN));
}
else {
static const char* statuses[5] = {
"◯ Weakly suspected to allow all file operations.",
"◔ Weakly suspected to allow most file operations.",
"◑ Weakly suspected to allow many file operations.",
"◕ Weakly suspected to reject most file operations.",
"● Weakly suspected to reject all file operations.",
};
attron(COLOR_PAIR(COLOR_PAIR_FADE));
int frac = (float)num_rejections/num_attempts*4;
addstr(statuses[frac]);
attroff(COLOR_PAIR(COLOR_PAIR_FADE));
}
}
static void render_permissions_screen() {
clear();
attrset(A_BOLD);
mvaddstr(1, 5, "Permissions: What sensitive operations this app is allowed to perform");
mvaddstr(2, 5, "🚧 Be very careful granting permissions 🚧");
attrset(A_NORMAL);
int y = 7;
mvaddstr(y, 5, "File operations");
if (!ask_for_permission_on_every_file_operation) {
mvaddstr(y, 30, "function file_operation_permitted(filename, is_write)");
y = render_wrapped_text(y+1, 32, COLS-5, file_operations_predicate_body);
mvaddstr(y, 30, "end");
y++;
mvaddstr(y, 30, "");
characterize_file_operations_predicate();
}
else {
attron(COLOR_PAIR(COLOR_PAIR_WARN));
attron(A_REVERSE);
mvaddstr(y, 30, " always ask ");
attroff(A_REVERSE);
attroff(COLOR_PAIR(COLOR_PAIR_WARN));
}
y += 2;
int net_colors = net_operations_permitted ? COLOR_PAIR_WARN : COLOR_PAIR_SAFE;
mvaddstr(y, 5, "Network operations");
attron(COLOR_PAIR(net_colors));
attron(A_REVERSE);
switch (net_colors) {
case COLOR_PAIR_SAFE:
mvaddstr(y, 30, " never ");
break;
case COLOR_PAIR_WARN:
mvaddstr(y, 30, " always ");
break;
case COLOR_PAIR_RISK:
mvaddstr(y, 30, " ");
break;
default:
abort();
}
y++;
attroff(A_REVERSE);
attroff(COLOR_PAIR(net_colors));
mvaddstr(y, 30, "(No nuance available for network operations.)");
if (!ask_for_permission_on_every_file_operation) {
int file_operations_safe = strcmp("return false", trim(file_operations_predicate_body)) == 0;
int net_operations_safe = (net_operations_permitted == 0);
int file_operations_unsafe = strcmp("return true", trim(file_operations_predicate_body)) == 0;
int net_operations_unsafe = (net_operations_permitted != 0);
if (file_operations_safe && net_operations_safe) {
attron(COLOR_PAIR(COLOR_PAIR_SAFE));
mvaddstr(5, 5, "This app can't access private data or communicate with other computers.");
attroff(COLOR_PAIR(COLOR_PAIR_SAFE));
}
else if (file_operations_safe || net_operations_safe) {
attron(COLOR_PAIR(COLOR_PAIR_WARN));
if (net_operations_safe) {
mvaddstr(5, 5, "This app can access private data, but they can't leave this computer.");
}
else {
mvaddstr(5, 5, "This app can communicate with other computers, but can't access private data.");
}
attroff(COLOR_PAIR(COLOR_PAIR_WARN));
}
else if (file_operations_unsafe && net_operations_unsafe) {
attron(COLOR_PAIR(COLOR_PAIR_RISK));
// idea: include pentagram emoji. But it isn't widely supported yet on Linux.
mvaddstr(5, 5, "😈 ⚠️ Teliva can't protect you if this app does something sketchy. Consider restricting permissions. ⚠️ 😈");
attroff(COLOR_PAIR(COLOR_PAIR_RISK));
}
else {
attron(COLOR_PAIR(COLOR_PAIR_RISK));
mvaddstr(5, 5, "🦮 🙈 Teliva can't tell how much it's protecting you. Consider simplifying permissions.");
attroff(COLOR_PAIR(COLOR_PAIR_RISK));
}
}
else {
// ask_for_permission_on_every_file_operation is true
if (net_operations_permitted == 0) {
attron(COLOR_PAIR(COLOR_PAIR_WARN));
mvaddstr(5, 5, "You're manually managing file permissions, but they can't leave this computer.");
attroff(COLOR_PAIR(COLOR_PAIR_WARN));
}
else {
attron(COLOR_PAIR(COLOR_PAIR_WARN));
mvaddstr(5, 5, "You're manually managing file permissions, and the app can access the network. Watch out for fatigue.");
attroff(COLOR_PAIR(COLOR_PAIR_WARN));
//? attron(COLOR_PAIR(COLOR_PAIR_RISK));
//? mvaddstr(5, 5, "😈 ⚠️ Manually managing file permissions on a networked app is a losing enterprise. ⚠️ 😈");
//? attroff(COLOR_PAIR(COLOR_PAIR_RISK));
}
}
permissions_menu();
refresh();
}
/* Try running the function to test for errors. If code has an error, leave it
* on the stack and return non-zero */
int validate_file_operations_predicate() {
lua_getglobal(trustedL, "file_operation_permitted");
lua_pushstring(trustedL, "filename");
lua_pushstring(trustedL, "r"); /* open mode */
if (lua_pcall(trustedL, 2 /*args*/, 1 /*result*/, /*errfunc*/0)) {
/* TODO: error handling. Or should we use errfunc above? */
}
int status = 1;
if (lua_isboolean(trustedL, -1)) {
lua_pop(trustedL, 1);
status = 0;
}
return status;
}
static int load_file_operations_predicate(const char* body) {
char buffer[1024] = {0};
strcpy(buffer, "function file_operation_permitted(filename, is_write)\n");
strncat(buffer, body, 1020);
if (buffer[strlen(buffer)-1] != '\n')
strncat(buffer, "\n", 1020);
strncat(buffer, "end\n", 1020);
return luaL_loadbuffer(trustedL, buffer, strlen(buffer), "file_operation_permitted")
|| docall(trustedL, 0, 1)
|| validate_file_operations_predicate();
}
extern void editFilePermissions(char* filename);
extern void resumeFilePermissionsEdit();
static void edit_file_operations_predicate_body() {
static char file_operations_predicate_body_buffer[512];
/* save to disk */
char outfilename[] = "teliva_file_operations_predicate_body_XXXXXX";
int outfd = mkstemp(outfilename);
if (outfd == -1) {
endwin();
perror("edit_file_operations_predicate_body: error in creating temporary file");
abort();
}
FILE* out = fdopen(outfd, "w");
assert(out != NULL);
fprintf(out, "%s", file_operations_predicate_body);
fclose(out);
rename(outfilename, "teliva_file_operations_predicate_body");
Previous_error = "";
editFilePermissions("teliva_file_operations_predicate_body");
// error handling
assert(trustedL);
int oldtop = lua_gettop(trustedL);
while (1) {
int status;
memset(file_operations_predicate_body_buffer, '\0', 512);
FILE* in = fopen("teliva_file_operations_predicate_body", "r");
fread(file_operations_predicate_body_buffer, 500, 1, in); /* TODO: error message if file too large */
fclose(in);
status = load_file_operations_predicate(file_operations_predicate_body_buffer);
if (status == 0 || lua_isnil(trustedL, -1))
break;
Previous_error = lua_tostring(trustedL, -1);
if (Previous_error == NULL) Previous_error = "(error object is not a string)";
resumeFilePermissionsEdit();
lua_pop(trustedL, 1);
}
file_operations_predicate_body = file_operations_predicate_body_buffer;
if (lua_gettop(trustedL) != oldtop) {
endwin();
printf("edit_file_operations_predicate_body: memory leak %d -> %d\n", oldtop, lua_gettop(trustedL));
exit(1);
}
}
void print_file_permission_suggestions(int row) {
mvaddstr(row++, 0, "-- Some ideas:");
mvaddstr(row++, 0, "-- * restrict access to a single file: return filename == 'foo'");
mvaddstr(row++, 0, "-- * restrict to reading only: return is_write == false");
mvaddstr(row++, 0, "-- * restrict to files with a fixed prefix: return string.find(filename, 'foo') == 1");
mvaddstr(row++, 0, "-- * restrict to files with a fixed extension: return filename:sub(-4) == '.txt'");
mvaddstr(row++, 0, "-- * restrict to files under some directory: return string.find(filename, 'foo/') == 1");
mvaddstr(row++, 0, "-- * restrict access only to files specified on commandline: return isarg(filename)");
mvaddstr(row++, 0, "-- * restrict access only to paths under directories specified on commandline: return inargs(filename)");
mvaddstr(row++, 0, "--");
mvaddstr(row++, 0, "-- Each of these has benefits and drawbacks.");
}
static void permissions_view() {
while (true) {
render_permissions_screen();
int c = getch();
switch (c) {
case CTRL_X:
return;
case CTRL_F:
if (!ask_for_permission_on_every_file_operation)
edit_file_operations_predicate_body();
break;
case CTRL_A:
ask_for_permission_on_every_file_operation = !ask_for_permission_on_every_file_operation;
break;
case CTRL_N:
net_operations_permitted = !net_operations_permitted;
break;
}
}
}
static void save_permissions_to_user_configuration(lua_State* L) {
const char* rcfilename = user_configuration_filename();
FILE* in = fopen(rcfilename, "r"); /* can be NULL when rcfile doesn't exist */
char outfilename[] = "telivarc_XXXXXX";
int outfd = mkstemp(outfilename);
if (outfd == -1) {
endwin();
perror("error in creating temporary file");
abort();
}
FILE* out = fdopen(outfd, "w");
assert(out != NULL);
/* read entries from rcfilename and write them to outfilename. If image name
* matches the current Image_name, ignore. */
int oldtop = lua_gettop(L);
while (in && !feof(in)) {
teliva_load_definition(L, in);
if (lua_isnil(L, -1)) break;
lua_getfield(L, -1, "image_name");
const char* image_name = lua_tostring(L, -1);
if (strcmp(image_name, Image_name) != 0) {
fprintf(out, "- image_name: %s\n", image_name);
fprintf(out, " file_operations_predicate_body:\n");
lua_getfield(L, -2, "file_operations_predicate_body");
if (!lua_isnil(L, -1))
emit_multiline_string(out, lua_tostring(L, -1));
lua_pop(L, 1); /* file_operations_predicate_body */
lua_getfield(L, -2, "ask_for_permission_on_every_file_operation");
fprintf(out, " ask_for_permission_on_every_file_operation: %s\n", lua_tostring(L, -1));
lua_pop(L, 1); /* ask_for_permission_on_every_file_operation */
lua_getfield(L, -2, "net_operations_permitted");
fprintf(out, " net_operations_permitted: %s\n", lua_tostring(L, -1));
lua_pop(L, 1); /* net_operations_permitted */
}
lua_pop(L, 1); /* image_name */
}
lua_settop(L, oldtop);
fprintf(out, "- image_name: %s\n", Image_name);
fprintf(out, " file_operations_predicate_body:\n");
assert(file_operations_predicate_body);
emit_multiline_string(out, file_operations_predicate_body);
fprintf(out, " ask_for_permission_on_every_file_operation: %d\n", ask_for_permission_on_every_file_operation);
fprintf(out, " net_operations_permitted: %d\n", net_operations_permitted);
fclose(out);
if (in) fclose(in);
rename(outfilename, rcfilename);
}
static void load_permissions_from_user_configuration(lua_State* L) {
static char file_operations_predicate_body_buffer[512];
initialize_trustedL();
file_operations_predicate_body = default_file_operations_predicate_body;
int status = load_file_operations_predicate(file_operations_predicate_body);
if (status != 0 && lua_isnil(trustedL, -1)) {
endwin();
printf("can't load default file operations predicate_body\n");
exit(1);
}
const char* rcfilename = user_configuration_filename();
FILE* in = fopen(rcfilename, "r");
if (in == NULL) return;
file_operations_predicate_body = default_file_operations_predicate_body;
assert(file_operations_predicate_body);
/* read entries from rcfilename and look for a match with the current
* Image_name. */
int oldtop = lua_gettop(L);
while (!feof(in)) {
teliva_load_definition(L, in);
if (lua_isnil(L, -1)) break;
lua_getfield(L, -1, "image_name");
const char* image_name = lua_tostring(L, -1);
if (strcmp(image_name, Image_name) == 0) {
lua_getfield(L, -2, "file_operations_predicate_body");
if (!lua_isnil(L, -1)) {
memset(file_operations_predicate_body_buffer, '\0', 512);
strncpy(file_operations_predicate_body_buffer, lua_tostring(L, -1), 500);
file_operations_predicate_body = file_operations_predicate_body_buffer;
}
lua_pop(L, 1); /* file_operations_predicate_body */
lua_getfield(L, -2, "ask_for_permission_on_every_file_operation");
ask_for_permission_on_every_file_operation = lua_tointeger(L, -1);
lua_pop(L, 1); /* ask_for_permission_on_every_file_operation */
lua_getfield(L, -2, "net_operations_permitted");
net_operations_permitted = lua_tointeger(L, -1);
lua_pop(L, 1); /* net_operations_permitted */
}
lua_pop(L, 1); /* image_name */
}
lua_settop(L, oldtop);
fclose(in);
/* trusted section */
assert(file_operations_predicate_body);
status = load_file_operations_predicate(file_operations_predicate_body);
if (status == 0 || lua_isnil(trustedL, -1))
return;
/* TODO: more graceful error handling */
endwin();
printf("error in loading file operations predicate_body from %s\n", rcfilename);
exit(1);
}
void permissions_mode(lua_State* L) {
assume_default_colors(COLOR_FOREGROUND, COLOR_BACKGROUND);
init_pair(COLOR_PAIR_NORMAL, COLOR_FOREGROUND, COLOR_BACKGROUND);
init_pair(COLOR_PAIR_SELECTABLE, COLOR_SELECTABLE_FOREGROUND, COLOR_SELECTABLE_BACKGROUND);
init_pair(COLOR_PAIR_FADE, COLOR_FADE, COLOR_BACKGROUND);
init_pair(COLOR_PAIR_MENU_ALTERNATE, COLOR_MENU_ALTERNATE, COLOR_BACKGROUND);
init_pair(COLOR_PAIR_LUA_COMMENT, COLOR_LUA_COMMENT, COLOR_BACKGROUND);
init_pair(COLOR_PAIR_LUA_KEYWORD, COLOR_LUA_KEYWORD, COLOR_BACKGROUND);
init_pair(COLOR_PAIR_LUA_CONSTANT, COLOR_LUA_CONSTANT, COLOR_BACKGROUND);
init_pair(COLOR_PAIR_MATCH, COLOR_MATCH_FOREGROUND, COLOR_MATCH_BACKGROUND);
init_pair(COLOR_PAIR_ERROR, COLOR_ERROR_FOREGROUND, COLOR_ERROR_BACKGROUND);
/* permissions colors slightly different than in the menu */
init_pair(COLOR_PAIR_SAFE, COLOR_SAFE_NORMAL, COLOR_BACKGROUND);
init_pair(COLOR_PAIR_WARN, COLOR_WARN_NORMAL, COLOR_BACKGROUND);
init_pair(COLOR_PAIR_RISK, COLOR_RISK_NORMAL, COLOR_BACKGROUND);
nodelay(stdscr, 0); /* always make getch() block in developer mode */
curs_set(1); /* always display cursor in developer mode */
permissions_view();
save_permissions_to_user_configuration(L);
cleanup_curses();
execv(Argv[0], Argv);
/* never returns */
}
/*** (Audit) Events screen */
typedef struct {
char* line;
char* func;
} AuditEvent;
#define NAUDIT 8192
AuditEvent audit_event[NAUDIT];
int naudit = 0;
int iaudit = 0;
void append_to_audit_log(lua_State* L, const char* buffer) {
lua_Debug ar;
lua_getstack(L, 1, &ar);
lua_getinfo(L, "n", &ar);
if (!ar.name) return;
audit_event[naudit].line = strdup(buffer);
audit_event[naudit].func = strdup(ar.name);
++naudit;
if (naudit >= NAUDIT)
naudit = 0;
if (naudit == iaudit) {
++iaudit;
if (iaudit >= NAUDIT)
iaudit = 0;
}
}
static void events_menu() {
attrset(A_REVERSE);
for (int x = 0; x < COLS; ++x)
mvaddch(LINES-1, x, ' ');
attrset(A_NORMAL);
menu_column = 2;
draw_menu_item("^x", "go back");
draw_menu_item("Enter", "go to highlight");
attrset(A_NORMAL);
}
static void render_event(int i, int y, int cursor) {
mvaddstr(y, 2, "");
if (i == cursor)
draw_highlighted_definition_name(audit_event[i].func);
else
draw_definition_name(audit_event[i].func);
mvaddstr(y, 16, audit_event[i].line);
}
static void render_events(int cursor) {
clear();
attrset(A_BOLD);
mvaddstr(1, 0, "Recent events");
attrset(A_NORMAL);
if (iaudit == 0) {
/* circular buffer might not be full */
for (int i = 0, y = 3; i < naudit; ++i, ++y) {
if (i >= LINES-1) break;
render_event(i, y, cursor);
}
}
else {
/* circular buffer guaranteed to be full */
for (int i = 0, y = 3; i < NAUDIT; ++i, ++y) {
if (i >= LINES-1) break;
render_event((iaudit+i)%NAUDIT, y, cursor);
}
}
events_menu();
refresh();
}
static const char* events_view() {
int cursor = 0;
while (true) {
render_events(cursor);
int c = getch();
switch (c) {
case CTRL_X:
return NULL;
case KEY_UP:
if (cursor > 0)
--cursor;
break;
case KEY_DOWN:
if (cursor < naudit-1)
++cursor;
break;
case ENTER:
return audit_event[cursor].func;
}
}
}
/*** Main */
char* Image_name = NULL;
extern void set_args (lua_State *L, char **argv, int n);
extern void load_tlv(lua_State* L, char* filename);
int load_image(lua_State* L, char** argv, int n) {
int status;
set_args(L, argv, n);
/* parse and load file contents (teliva_program array) */
Image_name = argv[n];
load_tlv(L, Image_name);
//? save_tlv(L, Image_name); // manual test; should always return identical result, modulo key order
//? exit(1);
status = load_definitions(L);
if (status != 0) return 0;
precompute_names_of_globals(L);
/* run tests */
status = run_tests(L);
if (status != 0) return report_in_developer_mode(L, status);
/* clear stats from running tests */
clear_call_graph_depth(L);
clear_caller(L);
/* initialize permissions */
load_permissions_from_user_configuration(L);
return 0;
}