Add Programname and Windowname to logs #152
Final resume:
Mission: Add possibility to include Program and Window name in logs Added argument "--programinfo" The code "on key press (EV_MAKE)" was split into 2 functions, one for newlines and one to encode the scan_codes Added check for program change, which triggers a newline Commented old function that required X11 Cleaned up code On branch windowname-no-x11 Changes to be committed: modified: src/args.cc modified: src/logkeys.cc Untracked files: keymap.map test.log
- Loading branch information
commit 2a4634868645e16af3804f56bfd7d22380b3407b
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -59,6 +59,8 @@ | |
| #define DEFAULT_LOG_FILE "/var/log/logkeys.log" | ||
| #define PID_FILE "/var/run/logkeys.pid" | ||
|
|
||
| #define TIME_FORMAT "%F %T%z > " // results in YYYY-mm-dd HH:MM:SS+ZZZZ | ||
|
|
||
| #include "usage.cc" // usage() function | ||
| #include "args.cc" // global arguments struct and arguments parsing | ||
| #include "keytables.cc" // character and function key tables and helper functions | ||
|
|
@@ -81,37 +83,6 @@ std::string execute(const char* cmd) | |
| return result; | ||
| } | ||
|
|
||
| int input_fd = -1; // input event device file descriptor; global so that signal_handler() can access it | ||
|
|
||
| void signal_handler(int signal) | ||
|
|
@@ -402,6 +373,59 @@ void determine_input_device() | |
| seteuid(0); setegid(0); | ||
| } | ||
|
|
||
| // write newline then add timestamp and programinfo | ||
| ////event is wrong use refercen or pointer | ||
| inline int newline(FILE *& out, struct input_event event, bool program_changed, std::string program_info) { | ||
| char timestamp[32]; | ||
| int inc_size = fprintf(out, "\n"); | ||
|
|
||
| if (!(args.flags & FLAG_NO_TIMESTAMPS)) { | ||
| strftime(timestamp, sizeof(timestamp), TIME_FORMAT, localtime(&event.time.tv_sec)); | ||
| inc_size += fprintf(out, "%s", timestamp); | ||
| } | ||
| if (program_changed) | ||
| inc_size += fprintf(out, "%s", program_info.c_str()); | ||
|
|
||
| return inc_size; | ||
| } | ||
|
|
||
| inline int encode_char(FILE *& out, unsigned int scan_code, bool altgr_in_effect, bool shift_in_effect) { | ||
| int inc_size = 0; | ||
| if (is_char_key(scan_code)) { | ||
| wchar_t wch; | ||
| if (altgr_in_effect) { | ||
| wch = altgr_keys[to_char_keys_index(scan_code)]; | ||
| if (wch == L'\0') { | ||
| if(shift_in_effect) | ||
| wch = shift_keys[to_char_keys_index(scan_code)]; | ||
| else | ||
| wch = char_keys[to_char_keys_index(scan_code)]; | ||
| } | ||
| } | ||
| else if (shift_in_effect) { | ||
| wch = shift_keys[to_char_keys_index(scan_code)]; | ||
| if (wch == L'\0') | ||
| wch = char_keys[to_char_keys_index(scan_code)]; | ||
| } | ||
| else // neither altgr nor shift are effective, this is a normal char | ||
| wch = char_keys[to_char_keys_index(scan_code)]; | ||
|
|
||
| if (wch != L'\0') | ||
| inc_size += fprintf(out, "%lc", wch); // write character to log file | ||
| } | ||
| else if (is_func_key(scan_code)) { | ||
| if (!(args.flags & FLAG_NO_FUNC_KEYS)) { // only log function keys if --no-func-keys not requested | ||
| inc_size += fprintf(out, "%ls", func_keys[to_func_keys_index(scan_code)]); | ||
| } | ||
| else if (scan_code == KEY_SPACE || scan_code == KEY_TAB) { | ||
| inc_size += fprintf(out, " "); // but always log a single space for Space and Tab keys | ||
| } | ||
| } | ||
| else | ||
| inc_size += fprintf(out, "<E-%x>", scan_code); // keycode is neither of character nor function, log error | ||
|
|
||
| return inc_size; | ||
| } | ||
|
|
||
| int main(int argc, char **argv) | ||
| { | ||
|
|
@@ -500,7 +524,6 @@ int main(int argc, char **argv) | |
|
|
||
| time_t cur_time; | ||
| time(&cur_time); | ||
| strftime(timestamp, sizeof(timestamp), TIME_FORMAT, localtime(&cur_time)); | ||
|
|
||
| if (args.flags & FLAG_NO_TIMESTAMPS) | ||
|
|
@@ -509,13 +532,15 @@ int main(int argc, char **argv) | |
| file_size += fprintf(out, "Logging started ...\n\n"); | ||
|
|
||
| fflush(out); | ||
|
|
||
| //// programinfo | ||
| std::string window_id; | ||
| std::string old_window_id; | ||
| std::string cur_process_name; | ||
| std::string cur_window_name; | ||
| std::string program_info; | ||
| bool program_changed = false; | ||
|
|
||
| // infinite loop: exit gracefully by receiving SIGHUP, SIGINT or SIGTERM (of which handler closes input_fd) | ||
| while (read(input_fd, &event, sizeof(struct input_event)) > 0) { | ||
|
|
||
|
|
@@ -534,7 +559,20 @@ int main(int argc, char **argv) | |
| if (inc_size > 0) file_size += inc_size; | ||
| continue; | ||
| } | ||
|
|
||
| //// on processid change update program_info write '[process name] "process title" > ' | ||
| //// on process title change (like firefox tabs) would be better. possibly more ressource intensive? | ||
| if (args.flags & FLAG_PROGRAMINFO) { | ||
| window_id = execute(COMMAND_STR_AWID); | ||
|
There was a problem hiding this comment. This spawns three new processes on each keypress. This indeed feels somewhat intensive. Did you perhaps investigate how cumbersome the use of relevant Xlib function calls would be? |
||
|
|
||
| if (window_id.compare(old_window_id) != 0) { | ||
| cur_process_name = execute(COMMAND_STR_AWPNAME); | ||
|
There was a problem hiding this comment. COMMAND_STR_AWPNAME contains COMMAND_STR_AWID to determine the window id. |
||
| cur_window_name = execute(COMMAND_STR_AWTITLE); | ||
| program_info = "[" + cur_process_name.erase(cur_process_name.size() - 1) + "] " + cur_window_name.erase(cur_window_name.size() - 1) + " > "; // delete newline (why are newlines) | ||
| program_changed = true; | ||
| } | ||
| } | ||
|
|
||
| // if remote posting is enabled and size treshold is reached | ||
| if (args.post_size != 0 && file_size >= args.post_size && stat(UPLOADER_PID_FILE, &st) == -1) { | ||
| fclose(out); | ||
|
|
@@ -573,7 +611,9 @@ int main(int argc, char **argv) | |
| } | ||
| } | ||
| } | ||
|
|
||
| ////possible conflict if key repeated and program changed??? | ||
|
There was a problem hiding this comment. this was just a comment i forgot to remove. |
||
|
|
||
| // on key repeat ; must check before on key press | ||
| if (event.value == EV_REPEAT) { | ||
| ++count_repeats; | ||
|
|
@@ -590,70 +630,24 @@ int main(int argc, char **argv) | |
|
|
||
| // on key press | ||
| if (event.value == EV_MAKE) { | ||
| // on ENTER key or Ctrl+C/Ctrl+D event append timestamp and programinfo | ||
| if (scan_code == KEY_ENTER || scan_code == KEY_KPENTER) { | ||
| inc_size += newline(out, event, program_changed, program_info); | ||
| } | ||
| else if (program_changed || (ctrl_in_effect && (scan_code == KEY_C || scan_code == KEY_D))) { | ||
| inc_size += newline(out, event, program_changed, program_info); | ||
| inc_size += encode_char(out, scan_code, altgr_in_effect, shift_in_effect); | ||
| } | ||
| else { // normal char | ||
| if (scan_code == KEY_LEFTSHIFT || scan_code == KEY_RIGHTSHIFT) | ||
| shift_in_effect = true; | ||
| if (scan_code == KEY_RIGHTALT) | ||
| altgr_in_effect = true; | ||
| if (scan_code == KEY_LEFTCTRL || scan_code == KEY_RIGHTCTRL) | ||
| ctrl_in_effect = true; | ||
|
|
||
| inc_size += encode_char(out, scan_code, altgr_in_effect, shift_in_effect); // print character or string coresponding to received keycode; only print chars when not \0 | ||
| } | ||
| } // if (EV_MAKE) | ||
|
|
||
| // on key release | ||
|
|
@@ -665,10 +659,17 @@ int main(int argc, char **argv) | |
| if (scan_code == KEY_LEFTCTRL || scan_code == KEY_RIGHTCTRL) | ||
| ctrl_in_effect = false; | ||
| } | ||
|
|
||
| // update program id | ||
| if (args.flags & FLAG_PROGRAMINFO) { | ||
| old_window_id = window_id; | ||
| program_changed = false; | ||
| } | ||
|
|
||
| prev_code = scan_code; | ||
| fflush(out); | ||
| if (inc_size > 0) | ||
| file_size += inc_size; | ||
|
|
||
| } // while (read(input_fd)) | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You correctly call it process later on. It's a process that is running and has a window. I would prefer this being exposed as
--process-infoor--window-titleto be more verbose about what this logs (window's name and title, in particular).