From 94c62f3d6b4ea318defb645246c1ea11ce1a0e7b Mon Sep 17 00:00:00 2001 From: netbenixcn Date: Fri, 24 Jul 2020 16:50:12 +0200 Subject: [PATCH] Added some comments to the code --- commands/change_dir.c | 8 ++++---- commands/help.c | 1 + commands/show_dir.c | 8 ++++---- etc/logo.c | 1 + main.c | 19 +++++++++++-------- utils/gtk_test.c | 19 ++++++++++++------- utils/logger.c | 1 + utils/sql_test.c | 11 ++++++----- utils/update_check.c | 19 ++++++++++--------- 9 files changed, 50 insertions(+), 37 deletions(-) diff --git a/commands/change_dir.c b/commands/change_dir.c index 9202b76..501584a 100644 --- a/commands/change_dir.c +++ b/commands/change_dir.c @@ -9,12 +9,12 @@ void changeCurrentWorkDir(char *arg[]){ DIR *d; struct dirent *dir; - d = opendir(arg[1]); - if(d == NULL){ + d = opendir(arg[1]); //Try to open directory + if(d == NULL){ //Check if directory exists printf("Folder not found.\n"); return; } else { - chdir(arg[1]); + chdir(arg[1]); //If directory exists, change workpath } - closedir(d); + closedir(d); //Close directory } \ No newline at end of file diff --git a/commands/help.c b/commands/help.c index 1f45664..9323cf1 100644 --- a/commands/help.c +++ b/commands/help.c @@ -3,6 +3,7 @@ #include "help.h" +//Print the help void outputHelp(){ printf("usage: netbenixCMD [option]\n"); printf("Options:\n"); diff --git a/commands/show_dir.c b/commands/show_dir.c index 6b5e540..d1dadb0 100644 --- a/commands/show_dir.c +++ b/commands/show_dir.c @@ -27,12 +27,12 @@ void showDirectory(char *arg[]){ struct dirent *dir; char path[PATH_MAX]; - d = opendir(arg[1]); - if(d == NULL){ + d = opendir(arg[1]); //Try to open directory + if(d == NULL){ //Check if directory exists printf("Folder not found.\n"); return; } - realpath(arg[1], path); + realpath(arg[1], path); //Get the absolute path of the directory if(d){ while((dir = readdir(d))){ if(dir->d_type == 8){ //IF IS FILE @@ -43,6 +43,6 @@ void showDirectory(char *arg[]){ printf("%s\n", dir->d_name); } } - closedir(d); + closedir(d); //Close directory } } \ No newline at end of file diff --git a/etc/logo.c b/etc/logo.c index 8accac7..eb7cceb 100644 --- a/etc/logo.c +++ b/etc/logo.c @@ -6,6 +6,7 @@ char logo_row3[59] = "| '_ \\ / _ \\ __| '_ \\ / _ \\ '_ \\| \\ \\/ / | | |\\/ char logo_row4[59] = "| | | | __/ |_| |_) | __/ | | | |> <| |___| | | | |_| |"; char logo_row5[59] = "|_| |_|\\___|\\__|_.__/ \\___|_| |_|_/_/\\_\\\\____|_| |_|____/ "; +//Prints the logo void showLogo(){ printf("\033[0;34m%s\033[0m\n", logo_row1); printf("\033[0;34m%s\033[0m\n", logo_row2); diff --git a/main.c b/main.c index e1ce72a..76085f8 100644 --- a/main.c +++ b/main.c @@ -22,11 +22,6 @@ #define VERSION "0.2.2" #define AUTHOR "netbenix" -void exit_app(){ - logger("Exiting."); - exit(0); -} - // Color Codes: // Reset: \033[0m // Red: \033[0;31m @@ -42,7 +37,12 @@ void exit_app(){ // BoldMagenta: \033[1;35m // BoldCyan: \033[1;36m +void exit_app(){ + logger("Exiting."); + exit(0); +} +//Handles the commands int commandHandler(char *cmd){ char *token = strtok(cmd, " "); @@ -61,6 +61,7 @@ int commandHandler(char *cmd){ p[strlen(p)-1] = 0; arg[i] = p; + //Start to compare the command if(!strcmp(arg[0], "list")){ printf("\033[1;34mcd\033[0m : change directory\n"); printf("\033[1;34mdir\033[0m : show contents of directory\n"); @@ -89,7 +90,7 @@ int commandHandler(char *cmd){ } } - +//Action starts here int main(int argc, char *argv[]){ char buffer[1024]; extern char loggerDirPath[PATH_MAX]; @@ -98,15 +99,16 @@ int main(int argc, char *argv[]){ snprintf(buffer, sizeof(buffer), "Starting netbenixCMD (Version: %s)", VERSION); logger(buffer); log_Specs(); //Log system specs - showLogo(); //Show the Logo + showLogo(); //Show the logo logger("Logo Displayed."); - checkForUpdate(VERSION); //Check for Update + checkForUpdate(VERSION); //Check for newer version of client if(argc > 2){ printf("Too many arguments. Please use --help for more information.\n"); snprintf(buffer, sizeof(buffer), "[ERROR] Too many arguments. Argument count: %i", argc-1); logger(buffer); } + //Check the startup args if(argc == 2){ if(!strcmp(argv[1], "--help")){ logger("Showing Help."); @@ -127,6 +129,7 @@ int main(int argc, char *argv[]){ } } + //If no startup arg is given, start command handler if(argc == 1){ int exit = 0; char cmd[128]; diff --git a/utils/gtk_test.c b/utils/gtk_test.c index a1db4af..6abf0a7 100644 --- a/utils/gtk_test.c +++ b/utils/gtk_test.c @@ -13,24 +13,26 @@ void createGTKTestWindow(){ - gtk_init(0, NULL); + gtk_init(0, NULL); //Init - builder = gtk_builder_new_from_file("glade/test_window.glade"); - window = GTK_WIDGET(gtk_builder_get_object(builder, "window")); - g_signal_connect(window, "destroy", G_CALLBACK(gtk_main_quit), NULL); - gtk_builder_connect_signals(builder, NULL); + builder = gtk_builder_new_from_file("glade/test_window.glade"); //Set builder + window = GTK_WIDGET(gtk_builder_get_object(builder, "window")); //Tell the window what to build + g_signal_connect(window, "destroy", G_CALLBACK(gtk_main_quit), NULL); //Connect destroy signal + gtk_builder_connect_signals(builder, NULL); //Connect the signals to builder + //Init the widgets fixed1 = GTK_WIDGET(gtk_builder_get_object(builder, "fixed1")); button1 = GTK_WIDGET(gtk_builder_get_object(builder, "button1")); label = GTK_WIDGET(gtk_builder_get_object(builder, "label")); check = GTK_WIDGET(gtk_builder_get_object(builder, "check")); level = GTK_WIDGET(gtk_builder_get_object(builder, "level")); - gtk_widget_show(window); - gtk_main(); + gtk_widget_show(window); //Show the widgets + gtk_main(); //Create window logger("[GTK] Window closed."); } +//Set the level of the bar void setBarLevel(){ if(gtk_level_bar_get_value(GTK_LEVEL_BAR(level)) == 100){ gtk_label_set_text(GTK_LABEL(label), (const gchar*) "LEVEL UP!"); @@ -45,6 +47,7 @@ void setBarLevel(){ } } +//Button event void on_button1_clicked(GtkButton *b){ gtk_label_set_text(GTK_LABEL(label), (const gchar*) "DO NOT PUSH THE BUUUTTTON"); logger("[GTK] Button 'button1' clicked."); @@ -61,11 +64,13 @@ void on_gay_check_toggled(GtkToggleButton *t){ } } +//Window-focus-loss event void on_window_focus_out_event(GtkWindow *w){ gtk_label_set_text(GTK_LABEL(label), (const gchar*) "HEY! COME BACK!"); logger("[GTK] Window focus lost."); } +//Windows-focus-regain event void on_window_focus_in_event(GtkWindow *w){ gtk_label_set_text(GTK_LABEL(label), (const gchar*) "Welcome Back!"); logger("[GTK] Window regained focus."); diff --git a/utils/logger.c b/utils/logger.c index 1ff3478..2f01dfc 100644 --- a/utils/logger.c +++ b/utils/logger.c @@ -6,6 +6,7 @@ char loggerDirPath[PATH_MAX]; +//Logs given message into output.log void logger(char message[512]){ FILE *log_file; time_t t = time(NULL); diff --git a/utils/sql_test.c b/utils/sql_test.c index 775b71d..f4ce89f 100644 --- a/utils/sql_test.c +++ b/utils/sql_test.c @@ -9,8 +9,8 @@ void testSQLConnection(){ - MYSQL *sql; - sql = mysql_init(NULL); + MYSQL *sql; //SQL connection + sql = mysql_init(NULL); //Init connection char hostname[200]; unsigned int port; char user[200]; @@ -28,17 +28,18 @@ void testSQLConnection(){ scanf("%s", &user); password = getpass("Password: "); + //Try to connect with given data if(mysql_real_connect(sql, hostname, user, password, database, 33000, NULL, 0) == NULL){ fprintf (stderr, "ERROR: mysql_real_connect():" - "%u (%s)\n",mysql_errno (sql), mysql_error (sql)); + "%u (%s)\n",mysql_errno (sql), mysql_error (sql)); //On Error, print it char buffer[1024]; snprintf(buffer, sizeof(buffer), "[ERROR] mysql_read_connect(): %u (%s)\n", mysql_errno(sql), mysql_error(sql)); logger(buffer); - mysql_close(sql); + mysql_close(sql); //Close connection } else { printf("Successfully connected to: %s", hostname); logger("SQL Test Successful."); } - mysql_close(sql); + mysql_close(sql); //Close connection } \ No newline at end of file diff --git a/utils/update_check.c b/utils/update_check.c index 2487e07..c7dc213 100644 --- a/utils/update_check.c +++ b/utils/update_check.c @@ -10,41 +10,42 @@ int checkForUpdate(char ver[10]){ struct sockaddr_in server; char server_reply[2000]; - //Create Socket + //Create socket sock = socket(AF_INET, SOCK_STREAM, 0); if( sock == -1){ printf("Error while creating socket."); logger("Error while creating socket"); } - server.sin_addr.s_addr = inet_addr("127.0.0.1"); + server.sin_addr.s_addr = inet_addr("127.0.0.1"); //Set the IP address of the server server.sin_family = AF_INET; - server.sin_port = htons( 34000 ); + server.sin_port = htons( 34000 ); //Set the server port - //Connect to Server + //Connect to server if(connect(sock, (struct sockaddr *)&server, sizeof(server)) < 0){ perror("Error. Connnection to update server failed."); logger("[ERROR] Connection to update server failed."); return 1; } - - if( send(sock, ver, strlen(ver), 0) < 0){ + //Send message + if( send(sock, ver, strlen(ver), 0) < 0){ puts("Error while communicating with server."); logger("[ERROR] Send to server failed."); } - + //Receive response if( recv(sock, server_reply, 2000, 0) < 0){ puts("Error while communicating with server."); logger("[ERROR] Receive from server failed."); } + //Say that client outdated if(!strcmp(server_reply, "VERSION_OUTDATED")){ printf("\033[0;31mYour client is outdated. Please update your client.\033[0m\n"); logger("[WARNING] Client is outdated."); } - + //Say that client is up-to-date if(!strcmp(server_reply, "VERSION_OK")){ logger("[INFO] Client is up-to-date."); } - close(sock); + close(sock); //Close the socket return 0; } \ No newline at end of file