Compare commits
No commits in common. "main" and "v0.0.8" have entirely different histories.
24
README.md
24
README.md
@ -1,39 +1,39 @@
|
||||
<img src="zrep-logo.png" width="150" align="left">
|
||||
|
||||
# Zrep Package Installer (zpi)
|
||||
# Zsh Repository Tool (zrep)
|
||||
|
||||
zpi is a powerful and user-friendly package manager for the Zsh shell. It allows you to easily install, manage, and share Zsh packages, such as plugins, themes, and scripts, directly from a central repository.
|
||||
zrep is a powerful and user-friendly package manager for the Zsh shell. It allows you to easily install, manage, and share Zsh packages, such as plugins, themes, and scripts, directly from a central repository.
|
||||
|
||||
## What is it?
|
||||
|
||||
`zpi` in and of itself is the command line tool that you use to install and manage scripts that are placed in `$fpath` used by Zsh. The packages are available on [the zrep website](https://zrep.kekepower.com) where you can, if you want to share your own scripts, register for an account. By sharing your scripts with the community, you are probably making somebody's day easier.
|
||||
`zrep` in and of itself is the command line tool that you use to install and manage scripts that are placed in `$fpath` used by Zsh. The packages are available on [the zrep website](https://zrep.kekepower.com) where you can, if you want to share your own scripts, register for an account. By sharing your scripts with the community, you are probably making somebody's day easier.
|
||||
|
||||
You can read more in the Wiki.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Easy Installation**: zpi simplifies the process of installing Zsh packages. With a single command, you can install packages from the zrep repository.
|
||||
- **Easy Installation**: zrep simplifies the process of installing Zsh packages. With a single command, you can install packages from the zrep repository.
|
||||
|
||||
- **Package Management**: zpi provides a set of commands to manage your installed packages. You can list, enable, disable, update, and remove packages effortlessly.
|
||||
- **Package Management**: zrep provides a set of commands to manage your installed packages. You can list, enable, disable, update, and remove packages effortlessly.
|
||||
|
||||
- **Centralized Repository**: All packages are stored in a central repository, making it convenient to discover and share Zsh packages with the community.
|
||||
|
||||
- **Automatic Setup**: zpi automatically sets up the necessary configuration files and directories, ensuring a smooth integration with your Zsh environment.
|
||||
- **Automatic Setup**: zrep automatically sets up the necessary configuration files and directories, ensuring a smooth integration with your Zsh environment.
|
||||
|
||||
- **Customizable**: zpi allows you to customize the installation directory and other settings through a configuration file.
|
||||
- **Customizable**: zrep allows you to customize the installation directory and other settings through a configuration file.
|
||||
|
||||
## Getting Started
|
||||
|
||||
To start using zpi, simply run the `zpi init` command to initialize the tool. zpi will guide you through the setup process and create the required configuration files.
|
||||
To start using zrep, simply run the `zrep init` command to initialize the tool. zrep will guide you through the setup process and create the required configuration files.
|
||||
|
||||
Use the search function on **[the zrep website](https://zrep.kekepower.com)** to find useful scripts until a search function is added to the `zpi` script some time in the future.
|
||||
Use the search function on **[the zrep website](https://zrep.kekepower.com)** to find useful scripts until a search function is added to the `zrep` script some time in the future.
|
||||
|
||||
Once initialized, you can explore and install packages using commands like `zpi install <author/package>`, `zpi list`, and `zpi enable <author/package>`.
|
||||
Once initialized, you can explore and install packages using commands like `zrep install <author/package>`, `zrep list`, and `zrep enable <author/package>`.
|
||||
|
||||
## Contributing
|
||||
|
||||
zpi is an open-source project, and contributions are welcome! If you have any ideas, bug reports, or feature requests, please open an issue on the GitHub repository.
|
||||
zrep is an open-source project, and contributions are welcome! If you have any ideas, bug reports, or feature requests, please open an issue on the GitHub repository.
|
||||
|
||||
## License
|
||||
|
||||
zpi is released under the MIT License.
|
||||
zrep is released under the MIT License.
|
||||
|
||||
204
zpi
204
zpi
@ -2,8 +2,8 @@
|
||||
|
||||
setopt extendedglob
|
||||
|
||||
VERSION="0.0.9" # Sat-2024-04-06
|
||||
ZREP="Zrep Package Installer"
|
||||
VERSION="0.0.8" # Fri-2024-04-05
|
||||
ZREP="Zsh Repository Tool"
|
||||
# Define the default path to .zreprc
|
||||
ZREP_CONFIG="${HOME}/.zreprc"
|
||||
|
||||
@ -84,13 +84,13 @@ typeset -A base_colors=(
|
||||
# Define the global associative array to hold the current theme
|
||||
declare -A current_theme
|
||||
|
||||
function zrep_load_theme() {
|
||||
zrep_load_theme() {
|
||||
local theme_name="$1"
|
||||
local theme_file="/home/stig/.zrep/themes/${theme_name}"
|
||||
local theme_file="${config[main_zrep_install_dir]}/themes/${theme_name}"
|
||||
|
||||
if [[ ! -f "$theme_file" ]]; then
|
||||
echo "Error: Theme file for '${theme_name}' not found. Falling back to the 'classic' theme."
|
||||
theme_file="/home/stig/.zrep/themes/classic"
|
||||
theme_file="${config[main_zrep_install_dir]}/themes/classic"
|
||||
fi
|
||||
|
||||
# Source the theme file, which should define 'theme_colors'
|
||||
@ -109,7 +109,7 @@ function zrep_main_version_string() {
|
||||
function zrep_version() {
|
||||
zrep_msg info "\nCreated by kekePower - 2024"
|
||||
zrep_msg info "License: MIT"
|
||||
zrep_msg info "https://git.kekepower.com/kekePower/zpi/"
|
||||
zrep_msg info "https://git.kekepower.com/kekePower/zrep/"
|
||||
zrep_msg info "Please see '${base_colors[${current_theme[help]}]}${ZSH_SCRIPT:t} help${base_colors[end]}${base_colors[${current_theme[info]}]}' for more info${base_colors[end]}"
|
||||
exit
|
||||
}
|
||||
@ -137,7 +137,7 @@ function zrep_msg() {
|
||||
|
||||
#################################################################################################
|
||||
# Function to URL-encode strings in Zsh
|
||||
function zrep_search_url_encode() {
|
||||
zrep_search_url_encode() {
|
||||
local string="${1}"
|
||||
local strlen=${#string}
|
||||
local encoded=""
|
||||
@ -156,13 +156,13 @@ function zrep_search_url_encode() {
|
||||
}
|
||||
|
||||
# Function to perform a search query and process JSON response
|
||||
function zrep_search() {
|
||||
zrep_search() {
|
||||
local searchTerm="${@}"
|
||||
|
||||
local encodedSearch=$(zrep_search_url_encode "${searchTerm}")
|
||||
|
||||
# Use the global_repo_url from the config associative array
|
||||
local response=$(curl -s -A "${ZSH_SCRIPT:t} ${VERSION} (curl)" "${config[global_repo_url]}/find.php?s=${encodedSearch}")
|
||||
local response=$(curl -s -A "zrep ${VERSION} (curl)" "${config[global_repo_url]}/find.php?s=${encodedSearch}")
|
||||
|
||||
# Determine if the JSON response is an object indicating "No scripts found"
|
||||
local jsonType=$(echo "$response" | jq -r 'type')
|
||||
@ -234,7 +234,7 @@ function zrep_init() {
|
||||
if [[ ! -f ${ZREP_CONFIG} ]]; then
|
||||
echo "${ZREP_CONFIG} not found. Creating it..."
|
||||
# Prompt user for install directory
|
||||
read "install_dir?Enter zpi installation directory [${HOME}/.zrep]: "
|
||||
read "install_dir?Enter zrep installation directory [${HOME}/.zrep]: "
|
||||
install_dir=${install_dir:-"${HOME}/.zrep"}
|
||||
mkdir -p ${install_dir}
|
||||
read "downloader?Choose command to download packages [curl, wget, wget2]: "
|
||||
@ -297,7 +297,7 @@ if [[ -n \${addons[@]} ]]; then
|
||||
autoload -Uz \$(basename \${addon})
|
||||
done
|
||||
else
|
||||
echo "zpi: No addons enabled."
|
||||
echo "zrep: No addons enabled."
|
||||
fi
|
||||
EOF
|
||||
echo "File .zrep_addons created and configured."
|
||||
@ -308,12 +308,12 @@ EOF
|
||||
if [[ ! -d ${install_dir}/themes ]]; then
|
||||
echo "Installing the Classic theme to ${install_dir}/themes"
|
||||
mkdir -p ${install_dir}/themes
|
||||
zrep_global_downloader https://git.kekepower.com/kekePower/zpi/raw/branch/main/themes/classic -o ${install_dir}/themes/classic
|
||||
zrep_global_downloader https://git.kekepower.com/kekePower/zrep/raw/branch/main/themes/classic -o ${install_dir}/themes/classic
|
||||
fi
|
||||
echo "zpi initialization complete."
|
||||
echo "You should copy 'zpi' to a path in you 'PATH' so that it's accessible."
|
||||
echo "zrep initialization complete."
|
||||
echo "You should copy 'zrep' to a path in you 'PATH' so that it's accessible."
|
||||
echo "For example '${HOME}/bin'"
|
||||
echo "Remember to 'source ${zshrc_file}' to load the 'zpi' settings."
|
||||
echo "Remember to 'source ${zshrc_file}' to load the 'zrep' settings."
|
||||
}
|
||||
|
||||
function zrep_installed_json() {
|
||||
@ -332,7 +332,6 @@ function zrep_installed_json() {
|
||||
|
||||
# Function to parse remote JSON data and extract author, script, and version
|
||||
# and return the correct download url
|
||||
|
||||
function zrep_parse_remote() {
|
||||
local url="${1}"
|
||||
local package="${2}"
|
||||
@ -340,21 +339,19 @@ function zrep_parse_remote() {
|
||||
local script_name="${package#*/}"
|
||||
local json_data
|
||||
|
||||
# Print the URL being used for debugging
|
||||
echo "Fetching URL: ${url}"
|
||||
|
||||
# Fetch JSON data from the URL
|
||||
json_data=$(zrep_global_downloader "${url}")
|
||||
|
||||
# Print the fetched JSON data for debugging
|
||||
echo "Fetched JSON data: ${json_data}"
|
||||
|
||||
# Directly extract the details based on author_name and script_name
|
||||
version=$(echo "${json_data}" | jq -r --arg author_name "$author_name" --arg script_name "$script_name" '.authors[] | select(.name==$author_name) | .scripts[] | select(.name==$script_name) | .version')
|
||||
|
||||
# Check if the dlurl and version are found
|
||||
if [[ -n "$version" ]]; then
|
||||
# Set the details as global
|
||||
#export author="$author_name"
|
||||
#export script="$script_name"
|
||||
export version
|
||||
#export dlurl
|
||||
else
|
||||
zrep_msg debug "\nPackage ${package} not found.\n"
|
||||
exit 1
|
||||
@ -382,7 +379,7 @@ else
|
||||
.[$author] = [{"script": $script, "version": $version}]
|
||||
end' "$installed_json" > "$installed_json.tmp" && mv "$installed_json.tmp" "$installed_json"
|
||||
|
||||
zrep_msg info "\n - Package '$author/$script' version $version installed/updated successfully."
|
||||
zrep_msg info " - Package '$script' by '$author' version $version installed/updated successfully."
|
||||
}
|
||||
|
||||
# Function to list installed packages from installed.json
|
||||
@ -447,7 +444,7 @@ function zrep_load_config() {
|
||||
zini "${ZREP_CONFIG}"
|
||||
zrep_fpath ${config[main_zrep_install_dir]} zrep_load
|
||||
else
|
||||
echo "${ZREP_CONFIG} not found. Run 'zpi init' to set up."
|
||||
echo "${ZREP_CONFIG} not found. Run 'zrep init' to set up."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
@ -466,7 +463,7 @@ function zrep_remove_package() {
|
||||
|
||||
if [[ -z "$installed_version" || "$installed_version" == "null" ]]; then
|
||||
zrep_msg debug "\nError: Package '${package_name}' is not installed."
|
||||
zrep_msg info "Please see 'zpi list' for installed packages."
|
||||
zrep_msg info "Please see 'zrep list' for installed packages."
|
||||
return 1
|
||||
fi
|
||||
|
||||
@ -524,59 +521,23 @@ function zrep_check_if_installed() {
|
||||
}
|
||||
|
||||
function zrep_global_downloader() {
|
||||
local downloadURL="${1}"
|
||||
local outputFile="${2:-}" # Optional, used for downloading files
|
||||
local cmd
|
||||
local retries=5
|
||||
local delay=5
|
||||
local attempt=0
|
||||
|
||||
case ${config[global_downloader]} in
|
||||
curl)
|
||||
if [[ -n $outputFile ]]; then
|
||||
cmd="curl -s -L -A \"${ZSH_SCRIPT:t} ${VERSION} (curl)\" -w \"%{http_code}\" -o \"$outputFile\" \"$downloadURL\""
|
||||
else
|
||||
cmd="curl -s -L -A \"${ZSH_SCRIPT:t} ${VERSION} (curl)\" -w \"%{http_code}\" \"$downloadURL\""
|
||||
fi
|
||||
dloader="curl -s -A \"zrep ${VERSION} (curl)\""
|
||||
;;
|
||||
wget|wget2)
|
||||
if [[ -n $outputFile ]]; then
|
||||
cmd="${config[global_downloader]} -q -L -U \"${ZSH_SCRIPT:t} ${VERSION} (${config[global_downloader]})\" -O \"$outputFile\" \"$downloadURL\""
|
||||
else
|
||||
cmd="${config[global_downloader]} -q -L -U \"${ZSH_SCRIPT:t} ${VERSION} (${config[global_downloader]})\" \"$downloadURL\""
|
||||
fi
|
||||
wget)
|
||||
dloader="wget -q -U \"zrep ${VERSION} (wget)\""
|
||||
;;
|
||||
wget2)
|
||||
dloader="wget2 -q -U \"zrep ${VERSION} (wget2)\""
|
||||
;;
|
||||
*)
|
||||
echo "Unsupported downloader."
|
||||
return 1
|
||||
echo "Invalid Downloader."
|
||||
exit
|
||||
;;
|
||||
esac
|
||||
|
||||
while (( ++attempt <= retries )); do
|
||||
if [[ ${config[global_downloader]} == "curl" ]]; then
|
||||
local response
|
||||
response=$(eval $cmd)
|
||||
local http_status="${response: -3}"
|
||||
local json_data="${response:0: -3}"
|
||||
if [[ $http_status -eq 200 ]]; then
|
||||
[[ -z $outputFile ]] && echo "$json_data"
|
||||
return 0
|
||||
else
|
||||
echo "HTTP Status: $http_status"
|
||||
return 1
|
||||
fi
|
||||
else
|
||||
eval $cmd
|
||||
exit_status=$?
|
||||
if [[ $exit_status -eq 0 ]]; then
|
||||
[[ -n $outputFile ]] && cat "$outputFile"
|
||||
return 0
|
||||
fi
|
||||
fi
|
||||
sleep $delay
|
||||
done
|
||||
echo "Download failed after $retries attempts."
|
||||
return 1
|
||||
eval ${dloader} "${1}"
|
||||
}
|
||||
|
||||
function zrep_process_updates() {
|
||||
@ -668,21 +629,75 @@ function zrep_update_package() {
|
||||
fi
|
||||
}
|
||||
|
||||
# Enhanced zrep_downloader function with error handling and retry logic.
|
||||
# It attempts to download a file from a given URL to a specified zip file using curl, wget, or wget2 based on the global configuration.
|
||||
# This function supports retries and delays between attempts for robust error handling.
|
||||
#
|
||||
# Usage: zrep_download_package ZipFile DownloadURL
|
||||
#
|
||||
# Parameters:
|
||||
# DownloadURL: The URL from which to download the file.
|
||||
# ZipFile: The name of the file to save the downloaded content to.
|
||||
|
||||
function zrep_download_package() {
|
||||
local ZipFile="${1}"
|
||||
local DownloadURL="${2}"
|
||||
local retries=5
|
||||
local delay=5
|
||||
local attempt=1
|
||||
local downloader=""
|
||||
local http_status
|
||||
local cmd
|
||||
local exit_status
|
||||
|
||||
# Now simply call the unified downloader function
|
||||
if zrep_global_downloader "$DownloadURL" "$ZipFile"; then
|
||||
zrep_msg std "\nDownload successful."
|
||||
else
|
||||
zrep_msg debug "\nDownload failed."
|
||||
case "${config[global_downloader]}" in
|
||||
curl)
|
||||
downloader="curl"
|
||||
cmd="curl -L -A \"zrep ${VERSION} (curl)\" -s -o \"$ZipFile\" \"$DownloadURL\" -w \"%{http_code}\""
|
||||
;;
|
||||
wget)
|
||||
downloader="wget"
|
||||
cmd="wget -L -U \"zrep ${VERSION} (wget)\" -q -O \"$ZipFile\" \"$DownloadURL\""
|
||||
;;
|
||||
wget2)
|
||||
downloader="wget2"
|
||||
cmd="wget2 -L -U \"zrep ${VERSION} (wget2)\" -q -O \"$ZipFile\" \"$DownloadURL\""
|
||||
;;
|
||||
*)
|
||||
zrep_msg debug "Unsupported or unspecified downloader: '${config[global_downloader]}'."
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
|
||||
while (( attempt <= retries )); do
|
||||
# zrep_msg sub "Attempt $attempt of $retries: Downloading using $downloader..."
|
||||
|
||||
if [[ $downloader == "curl" ]]; then
|
||||
http_status=$(eval $cmd)
|
||||
exit_status=$?
|
||||
# For curl, check HTTP status is 200 and exit status is 0
|
||||
if [[ $exit_status -eq 0 && $http_status -eq 200 ]]; then
|
||||
# zrep_msg sub "a.Download successful."
|
||||
return 0
|
||||
fi
|
||||
else # wget or wget2
|
||||
eval $cmd
|
||||
exit_status=$?
|
||||
# For wget/wget2, just check exit status is 0
|
||||
if [[ $exit_status -eq 0 ]]; then
|
||||
# zrep_msg sub "b.Download successful."
|
||||
return 0
|
||||
fi
|
||||
fi
|
||||
sleep $delay
|
||||
((attempt++))
|
||||
done
|
||||
|
||||
zrep_msg debug "Error: The download failed after $retries attempts."
|
||||
return 1
|
||||
}
|
||||
|
||||
# Function to install a package by unzipping it to ${config[main_zrep_install_dir]}
|
||||
|
||||
function zrep_install_package() {
|
||||
|
||||
if [[ ${1} == "u" ]]; then
|
||||
@ -700,28 +715,25 @@ function zrep_install_package() {
|
||||
# Call zrep_check_if_installed to check if the package is already installed
|
||||
if zrep_check_if_installed "${package}"; then
|
||||
zrep_msg debug "\nPackage ${package} is already installed."
|
||||
zrep_msg info "Use 'zpi list' to see installed packages."
|
||||
zrep_msg info "Use 'zrep list' to see installed packages."
|
||||
return 0
|
||||
fi
|
||||
|
||||
zrep_parse_remote "${config[global_repo_url]}/getver.php?p=${package}" ${package}
|
||||
fi
|
||||
|
||||
# If not installed, proceed with fetching the package information
|
||||
# Using the new zrep API to get the package version
|
||||
# zrep_parse_remote "${config[global_repo_url]}/getver.php\?p\=${package}" ${package}
|
||||
|
||||
local tmpDir="${config[main_zrep_install_dir]}/tmp"
|
||||
|
||||
mkdir -p "${tmpDir}"
|
||||
|
||||
author="${package%/*}"
|
||||
script="${package#*/}"
|
||||
|
||||
local zipFile="${tmpDir}/${author}-${script}-${version}.zip"
|
||||
local dlurl="${config[global_repo_url]}/download/${package}/${version}"
|
||||
echo "Download URL: ${dlurl}" # Print the download URL for debugging
|
||||
if ! zrep_download_package "${zipFile}" "${dlurl}"; then
|
||||
zrep_msg debug "\nError: Failed to download the package."
|
||||
return 1
|
||||
fi
|
||||
dlurl="${config[global_repo_url]}/download/${package}/${version}"
|
||||
zrep_download_package "${zipFile}" "${dlurl}"
|
||||
|
||||
unzip -q -o "${zipFile}" -d "${config[main_zrep_install_dir]}"
|
||||
|
||||
if [[ $? -ne 0 ]]; then
|
||||
zrep_msg debug "\nError: Failed to unzip the package."
|
||||
return 1
|
||||
@ -838,25 +850,25 @@ function zrep_disable() {
|
||||
echo ")"
|
||||
} > ${config[main_zrep_install_dir]}/.addons
|
||||
|
||||
zrep_msg info "\nPackage '${package_name}' has been disabled and removed from fpath."
|
||||
zrep_msg info "\nPackage '${package_name} (${script})' has been disabled and removed from fpath."
|
||||
zrep_msg info "You may have to run 'source ~/.zrep_addons' to remove it from your shell."
|
||||
}
|
||||
|
||||
# Help function to display available options
|
||||
function zrep_help() {
|
||||
|
||||
zrep_msg sub "\nUsage: ${ZSH_SCRIPT:t} <command> [arguments]"
|
||||
zrep_msg sub "\nUsage: zrep <command> [arguments]"
|
||||
zrep_msg info "Available commands:"
|
||||
if [[ ! -f ${ZREP_CONFIG} ]]; then
|
||||
zrep_msg info " init: Initialize zpi"
|
||||
zrep_msg info " init: Initialize zrep"
|
||||
fi
|
||||
zrep_msg info " install (i) <author/package>:\t\t\tInstall a package"
|
||||
zrep_msg info " remove (rm, delete, del) <author/package>:\tRemove a package"
|
||||
zrep_msg info " update (u) <author/package>:\t\t\tUpdate zpi package"
|
||||
zrep_msg info " enable <author/package>:\t\t\tEnable zpi package"
|
||||
zrep_msg info " disable <author/package>:\t\t\tDisable zpi package"
|
||||
zrep_msg info " update (u) <author/package>:\t\t\tUpdate zrep package"
|
||||
zrep_msg info " enable <author/package>:\t\t\tEnable zrep package"
|
||||
zrep_msg info " disable <author/package>:\t\t\tDisable zrep package"
|
||||
zrep_msg info " search 'search term':\t\t\t\tSearch for authors, packages or description"
|
||||
zrep_msg info " version:\t\t\t\t\tDisplay zpi version"
|
||||
zrep_msg info " version:\t\t\t\t\tDisplay zrep version"
|
||||
zrep_msg info " list:\t\t\t\t\t\tList installed packages"
|
||||
zrep_msg info " <author/package> help:\t\t\tDisplay help for package (if available)"
|
||||
|
||||
@ -940,7 +952,7 @@ function main() {
|
||||
# Parse the command argument to extract the package name
|
||||
zrep_remove_package_name="${2:-}"
|
||||
if [[ -z "${zrep_remove_package_name}" ]]; then
|
||||
zrep_msg info "\nUsage: zpi ${1} author/package"
|
||||
zrep_msg info "\nUsage: zrep ${1} author/package"
|
||||
else
|
||||
zrep_remove_package "${zrep_remove_package_name}"
|
||||
fi
|
||||
|
||||
Loading…
Reference in New Issue
Block a user