Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Development #489

Merged
merged 2 commits into from
May 20, 2024
Merged

Development #489

merged 2 commits into from
May 20, 2024

Conversation

estebanways
Copy link
Member

Pull Request Summary:


Consolidating Changes: Enhancing Commbase Functionality

Description:

This pull request aims to enhance the functionality, organization, and security of Commbase through various modifications, additions, movements, and deletions. Here's a summary of the changes:

  1. Modifications and Additions:

    • Implemented a new routine to log messages, facilitating the separation of logs from the terminal-based UI for potential GUI development.
    • Updated variables and descriptions for improved clarity and security, focusing on enhancing the STT engine's security content.
  2. Directory Structure Refinement:

    • Refined the directory structure for better organization, relocating files accordingly to improve navigation and accessibility.
  3. Documentation Update:

    • Updated README.md to reflect the updated directory structure, providing users with easier navigation.
  4. New Additions:

    • Introduced new files, including Bash scripts and documentation, to expand functionality and provide comprehensive descriptions for enhanced usability.
  5. Repository Streamlining:

    • Removed several redundant or outdated files to streamline the repository, optimizing resource utilization and maintenance.
  6. Specific Script Changes:

    • Made specific changes in the commbase.default script, including adding new command sections and routines for enhanced logging and user interaction.
  7. Deletions:

    • Deleted various skills and routines, indicating a cleanup or restructuring of the project to improve efficiency and effectiveness.

Context:
Overall, these changes aim to improve the functionality, organization, and security within the Commbase system, laying a solid foundation for future development and ensuring a seamless user experience.


…ions

Consolidating Changes from Original Repository

### Changes made in this repository

- Add new libcommbase routine append_message_to_log_file.sh to log Commbase and Commbase apps messages in a log file, which will allow programmers to separate logs from the current terminal-based Commbase UI to build graphical interfaces (GUIs) for Commbase apps
- Add variables CONVERSATION_LOGS_PATH and LOG_MESSAGES_FILE to the User's Guide
- Lowercase code comment
- Remove blank space
- Rename .commbase_history as .command_history
- Re add the main log/ directory
- Clean up the directory history
- Improve the variable STT_ENGINE_PATH description
- Improve STT engines security content
- Fix 75% to 90%
- Replace the Python badges with a Shell linter badge
- Complete the repository descriptions
- Remove redundant title
- Fix the title style
- Add languages and variants list
- Call terminal_request_user_password_and_execute() if the script is run directly (not sourced)
- Modify the function terminal_request_user_password_and_execute() to accept a command and 2 arguments
- Create the new interactive terminal commbase commands --stop-commbase, --reboot-system, and --power-off-system, that require the libcommbase/interactive script terminal_request_user_password_and_execute.sh
- Add new file terminal_request_user_password_and_execute.sh to create interactive skills that require the user account password for enhanced security
- Add new files skill.sh and skills_catalog.csv
- Rename the directory skills as interactive
- Improve description

### Changes by file

**INSTALL**
- Adjusted the description of the proactive STT engine to address security implications.

**README.md**
- Updated directory structure, moving files from 'libcommbase/routines' to 'libcommbase/interactive' for better organization.

**bundles/commbase-recorder-transmitter-b/README.md**
- Added description for the voice recorder and transmitter bundle.

**bundles/commbase-recorder-transmitter-b/reccomm.sh**
- Introduced a Bash script for recording audio and transmitting it to a remote host.

**libcommbase/routines/assistant_discourse.sh**
- Relocated to 'libcommbase/interactive' to align with the updated directory structure.

**scripts/configuration/install_commbase_executable/commbase.default**
- Added and updated command options for setting languages, selecting STT engines, and managing system operations.
- Enhanced logging with a new routine to append messages to the log file.
- Introduced commands to handle user password requests for system operations.
- Improved start-up and shutdown processes with additional log messages and directory clean-up operations.

Specific Changes in `commbase.default`:
- Added new command sections:
  - `--set-language`
  - `--select-stt-engine`
  - `--reboot-system`
  - `--power-off-system`
- Modified existing commands:
  - `--stop-commbase`
  - `--restart-stt-engine`
- Added new routines for logging and interactive user password requests:
  - `append_message_to_log_file`
  - `terminal_request_user_password_and_execute`
- Updated routing logic to include new commands and routines.

### Deleted Files

bundles/libcommbase/libcommbase/routines/source_includes
bundles/libcommbase/libcommbase/skills/skills_db/capture_mute
bundles/libcommbase/libcommbase/skills/skills_db/run_skill_disconnect_yourself
bundles/libcommbase/libcommbase/skills/skills_db/run_skill_list_your_command_history
bundles/libcommbase/libcommbase/skills/skills_db/run_skill_reload_recognition
bundles/libcommbase/libcommbase/skills/skills_db/run_skill_stop_capturing_sound
bundles/libcommbase/libcommbase/skills/skills_db/run_skill_tell_me_about_yourself
bundles/libcommbase/libcommbase/skills/skills_db/run_skill_wake_up
bundles/libcommbase/libcommbase/skills/skills_db/terminal_only_select_stt_engine.sh
bundles/libcommbase/libcommbase/skills/skills_db/terminal_only_set_language.sh
bundles/libcommbase/libcommbase/skills/skills_db/toggle_default_capture_device
history/.app_history
history/.messaging_history

### New Files

bundles/libcommbase/libcommbase/interactive/
bundles/libcommbase/libcommbase/routines/append_message_to_log_file.sh
bundles/libcommbase/libcommbase/routines/list_your_command_history
bundles/libcommbase/libcommbase/routines/tell_me_about_yourself
bundles/libcommbase/libcommbase/skill.sh
bundles/libcommbase/libcommbase/skills_catalog.csv
history/.command_history
i18n/log_messages/

### Conclusion

In conclusion, the recent changes represent a holistic effort to consolidate, improve, and secure the Commbase system. Through organizational enhancements, functionality improvements, and security measures, the repository has evolved to better serve its users and maintainers. Moving forward, these changes set a strong foundation for further development and refinement of the Commbase platform.
Consolidating Changes: Modifications, Additions, Movements, and Delet…
@estebanways estebanways merged commit dc65930 into main May 20, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant