├── .gitignore ├── LICENSE ├── Makefile ├── README.md ├── config.cfg └── src ├── main.c ├── shell_commands.h └── shell_config.h /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | #Ignore executanle file 3 | yss_dev 4 | 5 | #Ignore object file 6 | main.o 7 | 8 | 9 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | CC=gcc 2 | DEPS=src/shell_commands.h 3 | 4 | run: src/main.c 5 | $(CC) -o yss_dev src/main.c -lconfig 6 | debug: 7 | $(CC) -g -o yss_dev src/main.c -lconfig 8 | clean: 9 | rm yss_dev 10 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | # Young SimpleShell 3 | Young SimpleShell, or yss, is a easy to use and extremely effective command line for unix based systems. Unlike command lines 4 | such as bash, Young SimpleShell uses explicit language instead of symbols in the command line to make it easier to 5 | use. It's currently a work in progress though you are more than welcome to download and compile the current 6 | source code and try it out, however the functionality is currently very limited. 7 | 8 | # Installation 9 | Clone the repository 10 | cd into the repo and then type the following commands 11 | 12 | To compile: 13 | ``` 14 | make 15 | ``` 16 | To run the shell: 17 | ``` 18 | ./yss_dev 19 | ``` 20 | Note: You can exit out of it with Ctrl^C like any normal program 21 | 22 | # Usage 23 | yss can be executed from the bash shell or can be set as a users default shell. Currently the shell 24 | does have very limited functionality but can be used to execute all day to day shell tasks, such as 25 | executing other shell programs and commands. To see the built-in yss commands in yss enter 'help' into 26 | the command line. These are the commands that yss executes itself, to achieve other tasks the programs 27 | will have the same names as in bash. For example 'ls' will list the contents of the current directory 28 | and you can still use 'nano' to edit a file. 29 | 30 | # Contact Me 31 | Feel free to send me a message on github with your thoughts and wisdom on Simple Shell, or if you have any 32 | promlems! 33 | -------------------------------------------------------------------------------- /config.cfg: -------------------------------------------------------------------------------- 1 | dir_on_prompt = false -------------------------------------------------------------------------------- /src/main.c: -------------------------------------------------------------------------------- 1 | /* 2 | * --------------------------------------------------------------------------- 3 | * Simple Shell main.c 4 | * 2019 (c) Thomas Young 5 | * --------------------------------------------------------------------------- 6 | */ 7 | 8 | #include 9 | #include 10 | #include 11 | #include 12 | #include 13 | #include 14 | 15 | int dir_on_prompt = 0; 16 | /* Function declarations for shell_config.h */ 17 | 18 | void generate_new_config_file(void); 19 | int config_shell(void); 20 | 21 | /* Function declarations for main.c */ 22 | 23 | char **change_args(char **args); 24 | void simpleshell(void); 25 | int shell_process_line(char **args); 26 | int execute(char **args); 27 | char **readline(void); 28 | 29 | #include "shell_commands.h" 30 | #include "shell_config.h" 31 | 32 | #define VERSION_NUMBER "0.1.1" 33 | #define MAX_ARGS 64 34 | #define MAX_COMMAND_LENGTH 4096 35 | 36 | /* Calls the main shell Function */ 37 | 38 | int main(void){ 39 | 40 | simpleshell(); 41 | 42 | return 0; 43 | } 44 | 45 | /* Loops the input and process function indefinetly*/ 46 | 47 | void simpleshell(void){ 48 | 49 | printf("Simple Shell. Version: %s. Thomas Young (c) 2019\n", VERSION_NUMBER); 50 | printf("A Young Enterprise Application.\n"); 51 | 52 | config_shell(); 53 | 54 | char **args; 55 | 56 | while(1){ 57 | 58 | if(dir_on_prompt){ 59 | printf("%s ", shell_wai()); 60 | } 61 | printf(">"); 62 | 63 | args = readline(); 64 | if(args == NULL){ 65 | continue; 66 | } 67 | else{ 68 | 69 | /* If realine fails it returns a 1 in the first entry of args */ 70 | 71 | if(strcmp(args[0], "1") == 0){ 72 | continue; 73 | } 74 | else { 75 | shell_process_line(args); 76 | } 77 | 78 | free(args); 79 | } 80 | } 81 | } 82 | 83 | /* Checks to see if the user specified a shell command, if so it is executed with the arguments being passed 84 | * to the function, if not, it is passed to a fucntion that will look for and then execute programs */ 85 | 86 | int shell_process_line(char **args){ 87 | 88 | if(strcmp(args[0], "help") == 0){ 89 | shell_help(); 90 | } 91 | else if(strcmp(args[0], "goto") == 0){ 92 | shell_goto(args); 93 | } 94 | else if(strcmp(args[0], "wai") == 0){ 95 | printf("%s\n", shell_wai()); 96 | } 97 | else if(strcmp(args[0], "exit") == 0){ 98 | shell_exit(); 99 | } 100 | else { 101 | if(execute(args) != 0){ 102 | exit(1); 103 | } 104 | } 105 | return 0; 106 | } 107 | 108 | /* Moves the arguments forward so it can be passed to function run to execute with the correct 109 | * program arguments */ 110 | 111 | char **change_args(char **args){ 112 | if (*args == NULL){ 113 | return args; 114 | } 115 | else{ 116 | return args + 1; 117 | } 118 | } 119 | 120 | int execute(char **args){ 121 | 122 | pid_t pid = fork(); 123 | if(pid < 0){ 124 | printf("ssl: Failed to fork to execute program. I'm afraid it's all over...\n"); 125 | return 0; 126 | } else if(pid == 0){ //Is child process 127 | if(execvp(args[0], args) == -1){ 128 | printf("ssl: Couldn't execute program\n"); 129 | exit(0); 130 | } 131 | } 132 | 133 | wait(NULL); 134 | 135 | return 0; 136 | } 137 | 138 | char **readline(void){ 139 | 140 | char **args = malloc(64 * sizeof(char *)); 141 | char command[MAX_COMMAND_LENGTH]; 142 | 143 | char c; 144 | 145 | int count = 0; 146 | 147 | while(1){ 148 | 149 | c = getchar(); 150 | 151 | if( c == '\n' && (count < 1) ){ 152 | return NULL; 153 | 154 | } else if(c == '\n'){ 155 | command[count] = '\0'; 156 | break; 157 | 158 | } else if(c == EOF){ 159 | printf("exit\n"); 160 | shell_exit(); 161 | 162 | } else if(count >= MAX_COMMAND_LENGTH){ 163 | printf("Oh no! The shell can only take commands up to 4096 characters long!\n"); 164 | args[0] = "1"; 165 | return args; 166 | 167 | } else { 168 | command[count] = c; 169 | } 170 | count++; 171 | } 172 | 173 | count = 0; 174 | 175 | char *argument = strtok(command, " "); 176 | 177 | while(argument != NULL && count < MAX_ARGS - 1){ 178 | args[count] = argument; 179 | argument = strtok(NULL, " "); 180 | count++; 181 | } 182 | args[count] = NULL; 183 | 184 | return args; 185 | } -------------------------------------------------------------------------------- /src/shell_commands.h: -------------------------------------------------------------------------------- 1 | /* 2 | * --------------------------------------------------------------------------- 3 | * Simple Shell shell_commands.h 4 | * 2019 (c) Thomas Young 5 | * --------------------------------------------------------------------------- 6 | */ 7 | 8 | #include 9 | #include 10 | #include 11 | 12 | /* Displays a help message listing the built-in shell commands */ 13 | 14 | void shell_help(void){ 15 | printf("--SimpleShell Help--\n"); 16 | printf("Command:\tWhat it does:\n"); 17 | printf("goto\t\tChanges the shell's directory or folder to that specified.\n\t\tTakes one argument which is file path.\n"); 18 | printf("wai\t\tAKA Where am I. Displays the current location of the shell\n\t\tin the filesystem. Takes no arguments.\n"); 19 | printf("exit\t\tExit's the shell.\n"); 20 | printf("help\t\tDisplays this help message on the built-in commands.\n"); 21 | } 22 | 23 | void shell_goto(char **args){ 24 | if(args[1] == NULL){ 25 | printf("No path specified\n"); 26 | return; 27 | } 28 | else if(chdir(args[1]) != 0){ 29 | printf("Failed to navigate to path: %s\n", args[1]); 30 | } 31 | } 32 | 33 | char* shell_wai(){ 34 | char *location = (char*) malloc(FILENAME_MAX +1);; 35 | getcwd(location, FILENAME_MAX); 36 | return location; 37 | } 38 | 39 | 40 | void shell_exit(void){ 41 | printf("------------------------------------------------------------\n"); 42 | exit(0); 43 | } 44 | -------------------------------------------------------------------------------- /src/shell_config.h: -------------------------------------------------------------------------------- 1 | /* 2 | * --------------------------------------------------------------------------- 3 | * Simple Shell shell_config.h 4 | * 2019 (c) Thomas Young 5 | * --------------------------------------------------------------------------- 6 | */ 7 | 8 | #include 9 | #include 10 | #include 11 | 12 | #define CONFIG_PATH "config.cfg" 13 | 14 | static config_t config_file; 15 | 16 | /* Generate's the config file if one is not present */ 17 | void config_file_init(void){ 18 | 19 | config_init(&config_file); 20 | 21 | //If config read causes an error 22 | if(!config_read_file(&config_file, CONFIG_PATH)){ 23 | 24 | fprintf(stderr, "%s:%d - %s\n", config_error_file(&config_file), 25 | config_error_line(&config_file), config_error_text(&config_file)); 26 | 27 | config_destroy(&config_file); 28 | } 29 | 30 | } 31 | 32 | /* Get's the configurations of respective settings from CONFIG_PATH */ 33 | int config_shell(void){ 34 | 35 | config_file_init(); 36 | 37 | //Just an idea of how we would get the respective settings. Could use an array in the future 38 | config_setting_t *dir_on_prompt_setting = config_lookup(&config_file, "dir_on_prompt"); 39 | 40 | //Asigns the bool setting to global variable 41 | dir_on_prompt = config_setting_get_bool(dir_on_prompt_setting); 42 | 43 | //To avoid memory leak 44 | config_destroy(&config_file); 45 | } 46 | --------------------------------------------------------------------------------