Updated README.md for release v1.1.2

Former-commit-id: 4eb7a866fa03d5990a300120974def01ab4babec [formerly 0ce5b1c1f6]
Former-commit-id: b0e3e46e63b15184ad7d600ccc5e33e98c185081

README.md

@@ -40,7 +40,7 @@ What sshyp definitely won't do:
 # Installation
 Please see the [installation guide](https://github.com/rwinkhart/sshyp/wiki/Installation) in the sshyp wiki for directions specific to your distribution/OS.
 
-Pre-built packages exist for Haiku, FreeBSD, Arch Linux, Debian/Ubuntu Linux, Fedora Linux, and Termux. These can be downloaded from the releases page.
+Pre-built packages exist for Haiku, FreeBSD, Alpine Linux, Arch Linux, Debian/Ubuntu Linux, Fedora Linux, and Termux. These can be downloaded from the releases page.
 
 Requests for additional distribution/OS support can be filed as issues.
 
@@ -63,7 +63,7 @@ Haiku and Fedora packaging must be done on their own respective distributions.
 
 The AUR version and the packages attatched to the release tags were already packaged using this script.
 
-Currently, the script can create packages for Haiku, FreeBSD, Arch Linux (PKGBUILD), Debian/Ubuntu Linux, Fedora Linux, Termux, and generic.
+Currently, the script can create packages for Haiku, FreeBSD, Alpine Linux (APKBUILD), Arch Linux (PKGBUILD), Debian/Ubuntu Linux, Fedora Linux, Termux, and generic.
 
 # Usage
 Upon initial installation (on both the server and client devices), be sure to run:

bin/sshync.py

@@ -1,4 +1,4 @@
-#!/bin/python3
+#!/usr/bin/env python3
 
 # external modules
 

bin/sshyp.py

@@ -1,4 +1,4 @@
-#!/bin/python3
+#!/usr/bin/env python3
 
 # external modules
 
@@ -346,7 +346,7 @@ def print_info():  # prints help text based on argument
               'randall winkhart\u001b[38;5;15;48;5;15m   \u001b[38;5;7;48;5;8m/\u001b[0m')
         print('\u001b[38;5;7;48;5;8m/\u001b[38;5;15;48;5;15m                                                      '
               '\u001b[38;5;7;48;5;8m/\u001b[0m')
-        print('\u001b[38;5;7;48;5;8m/\u001b[38;5;15;48;5;15m                    \u001b[38;5;15;48;5;8mversion 1.1.1'
+        print('\u001b[38;5;7;48;5;8m/\u001b[38;5;15;48;5;15m                    \u001b[38;5;15;48;5;8mversion 1.1.2'
               '\u001b[38;5;15;48;5;15m                     \u001b[38;5;7;48;5;8m/\u001b[0m')
         print('\u001b[38;5;7;48;5;8m/\u001b[38;5;15;48;5;15m                 \u001b[38;5;15;48;5;8mthe sheecrets '
               'update\u001b[38;5;15;48;5;15m                 \u001b[38;5;7;48;5;8m/\u001b[0m')
@@ -423,22 +423,16 @@ def sync():  # calls sshync to sync changes to the user's server
         _deletion_database = None
         s_exit(1)
     for _file in _deletion_database:
-        if _file[:-1].endswith('/'):
-            try:
-                if silent_sync != 1:
-                    print(f"\u001b[38;5;208m{_file[:-1]}\u001b[0m has been sheared, removing...")
+        try:
+            if silent_sync != 1:
+                print(f"\u001b[38;5;208m{_file[:-1]}\u001b[0m has been sheared, removing...")
+            if _file[:-1].endswith('/'):
                 rmtree(f"{directory}{_file[:-1]}")
-            except FileNotFoundError:
-                if silent_sync != 1:
-                    print('folder does not exist locally.')
-        else:
-            try:
-                if silent_sync != 1:
-                    print(f"\u001b[38;5;208m{_file[:-1]}\u001b[0m has been sheared, removing...")
+            else:
                 remove(f"{directory}{_file[:-1]}.gpg")
-            except (FileNotFoundError, IsADirectoryError):
-                if silent_sync != 1:
-                    print('file does not exist locally.')
+        except FileNotFoundError:
+            if silent_sync != 1:
+                print('location does not exist locally')
     # check for new folders
     system(f"ssh -i '{path.expanduser('~/.ssh/sshyp')}' -p {port} {username_ssh}@{ip} \"cd /bin; python -c "
            f"'import sshypRemote; sshypRemote.folder_check()'\"")
@@ -513,8 +507,7 @@ def rename():  # renames an entry or folder
     if not Path(f"{directory}{_entry_name}.gpg").is_file() and not Path(f"{directory}{_entry_name}").is_dir():
         print(f"\n\u001b[38;5;9merror: entry ({_entry_name}) does not exist\u001b[0m\n")
         s_exit(1)
-    _new_name = str(input('new name: '))
-    print(f"{directory}{_new_name}")
+    _new_name = entry_name_fetch('new name: ')
     if Path(f"{directory}{_new_name}.gpg").is_file() or Path(f"{directory}{_new_name}").is_dir():
         print(f"\n\u001b[38;5;9merror: ({_new_name}) already exists\u001b[0m\n")
         s_exit(1)
@@ -744,7 +737,11 @@ if __name__ == "__main__":
             elif argument_list[2] == 'username' or argument_list[2] == '-u' or argument_list[2] == 'password' or \
                     argument_list[2] == '-p' or argument_list[2] == 'url' or argument_list[2] == '-l' or \
                     argument_list[2] == 'note' or argument_list[2] == '-n':
-                copy_data()
+                try:
+                    copy_data()
+                except IndexError:
+                    print(f"\n\u001b[38;5;9merror: field does not exist in entry\u001b[0m\n")
+                    s_exit(1)
             else:
                 print_info()
         elif argument_list[1] == 'shear' or argument_list[1] == '-rm':

bin/sshypRemote.py

@@ -1,4 +1,4 @@
-#!/bin/python3
+#!/usr/bin/env python3
 
 # external modules
 
@@ -10,16 +10,13 @@ from shutil import rmtree
 # utility functions
 
 def delete(_file_path):  # deletes an entry or folder, should be run remotely via ssh
-    if _file_path.endswith('/'):
-        try:
+    try:
+        if _file_path.endswith('/'):
             rmtree(f"{expanduser('~/.local/share/sshyp/')}{_file_path}")
-        except FileNotFoundError:
-            print('folder does not exist remotely')
-    else:
-        try:
+        else:
             remove(f"{expanduser('~/.local/share/sshyp/')}{_file_path}.gpg")
-        except FileNotFoundError:
-            print('file does not exist remotely')
+    except FileNotFoundError:
+        print('location does not exist remotely')
     for _device_name in listdir(expanduser('~/.config/sshyp/devices')):
         open(f"{expanduser('~/.config/sshyp/deleted/')}{_file_path.replace('/', '@')}^&*{_device_name}", 'w')
 

extra/changelog-total

@@ -1,3 +1,24 @@
+sshyp v1.1.2
+
+the sheecrets update - patch two
+
+this is a general polish/bugfix release
+
+user-facing features:
+
+- packaging support for Alpine Linux/postmarketOS
+- the rename() function is no longer unnecessarily verbose
+- handled exception for when the user attempts to copy an entry field that does not exist
+
+fixes/optimizations:
+
+- replaced shebang with "#!/usr/bin/env python3" for improved compatibility with various systems
+    ^ does not affect Haiku packaging
+- fixed the generic package not actually being compressed
+- reduced lines of code used for cross-device entry deletion
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
 sshyp v1.1.1
 
 the sheecrets update - patch one

extra/manpage

@@ -1,4 +1,4 @@
-.TH sshyp 1 "21 July 2022" "v1.1.1" "sshyp man page"
+.TH sshyp 1 "27 August 2022" "v1.1.2" "sshyp man page"
 .SH NAME
 sshyp \- A very simple self-hosted, synchronized password manager for UNIX(-like) systems. Alternative to (and compatible with) pass/password-store.
 .SH SYNOPSIS

package.sh

@@ -3,12 +3,13 @@
 # This script packages sshyp (from source) for various UNIX(-like) environments.
 # Dependencies (Arch Linux): dpkg (packaging for Debian/Termux), freebsd-pkg (packaging for FreeBSD)
 # Dependencies (Fedora) (can only package for self): rpmdevtools
+# Dependencies (Alpine): xz (not part of a basic installation, needed for generic package creation and unpacking for abuild), alpine-sdk (required to build the .apk file from the generated APKBUILD), bash
 # NOTE It is recommended to instead use the latest officially packaged and tagged release.
 
 echo -e '\nOptions (please enter the number only):'
 echo -e '\nPackage Formats:\n\n1. Haiku\n2. Debian&Ubuntu Linux\n3. Fedora Linux\n4. FreeBSD\n5. Termux\n6. Generic (used for PKGBUILD/APKBUILD)'
-echo -e '\nBuild Scripts:\n\n7. Arch Linux (PKGBUILD)'
-echo -e '\nOther:\n\n8. All (generates all distribution packages (excluding Haiku and Fedora, as these must be packaged on their respective distributions) and build scripts)\n'
+echo -e '\nBuild Scripts:\n\n7. Arch Linux (PKGBUILD)\n8. Alpine Linux (APKBUILD)'
+echo -e '\nOther:\n\n9. All (generates all distribution packages (excluding Haiku, Fedora, and Alpine, as these must be packaged on their respective distributions) and build scripts)\n'
 read -n 1 -r -p "Distribution: " distro
 
 echo -e '\n\nThe value entered in this field will only affect the version reported to the package manager. The latest source is used regardless.\n'
@@ -17,16 +18,8 @@ read -r -p "Version number: " version
 echo -e '\nThe value entered in this field will only affect the revision number for build scripts.\n'
 read -r -p "Revision number: " revision
 
-if [ "$distro" == "7" ] || [ "$distro" == "8" ]; then
-    echo -e '\nOptions (please enter the number only):'
-    echo -e '\n1. GitHub Release Tag\n2. Local\n'
-    read -r -p "Source (for build scripts): " source
-
-    if [ "$source" == "1" ]; then
-        source='https://github.com/rwinkhart/sshyp/releases/download/v$pkgver/sshyp-$pkgver.tar.xz'
-    else
-        source=local://sshyp-"$version".tar.xz
-    fi
+if [ "$distro" == "7" ] || [ "$distro" == "8" ] || [ "$distro" == "9" ]; then
+	source='https://github.com/rwinkhart/sshyp/releases/download/v$pkgver/sshyp-$pkgver.tar.xz'
 fi
 
 mkdir -p packages
@@ -61,6 +54,9 @@ urls {
 }
 " > packages/haikutemp/.PackageInfo
     cp -r bin packages/haikutemp/
+    sed -i '1 s/.*/#!\/bin\/env\ python3/' packages/haikutemp/bin/sshync.py
+    sed -i '1 s/.*/#!\/bin\/env\ python3/' packages/haikutemp/bin/sshyp.py
+    sed -i '1 s/.*/#!\/bin\/env\ python3/' packages/haikutemp/bin/sshypRemote.py
     ln -s /bin/sshyp.py packages/haikutemp/bin/sshyp
     cp -r share/doc/sshyp/ packages/haikutemp/documentation/packages/
     cp -r share/licenses/sshyp/ packages/haikutemp/documentation/packages/
@@ -75,7 +71,7 @@ urls {
     echo -e "\nHaiku packaging complete.\n"
 fi
 
-if [ "$distro" == "2" ] || [ "$distro" == "8" ]; then
+if [ "$distro" == "2" ] || [ "$distro" == "9" ]; then
     echo -e '\nPackaging for Debian...\n'
     mkdir -p packages/debiantemp/sshyp_"$version"-"$revision"_all/{DEBIAN,usr/share/man/man1}
     echo "Package: sshyp
@@ -99,7 +95,7 @@ Installed-Size: 185
     echo -e "\nDebian packaging complete.\n"
 fi
 
-if [ "$distro" == "5" ] || [ "$distro" == "8" ]; then
+if [ "$distro" == "5" ] || [ "$distro" == "9" ]; then
     echo -e '\nPackaging for Termux...\n'
     mkdir -p packages/termuxtemp/sshyp_"$version"-"$revision"_all_termux/{data/data/com.termux/files/usr/share/man/man1,DEBIAN}
     echo "Package: sshyp
@@ -123,7 +119,7 @@ Installed-Size: 185
     echo -e "\nTermux packaging complete.\n"
 fi
 
-if [ "$distro" == "3" ] || [ "$distro" == "4" ] || [ "$distro" == "6" ] || [ "$distro" == "7" ] || [ "$distro" == "8" ]; then
+if [ "$distro" == "3" ] || [ "$distro" == "4" ] || [ "$distro" == "6" ] || [ "$distro" == "7" ] || [ "$distro" == "8" ] || [ "$distro" == "9" ]; then
     echo -e '\nPackaging as generic...\n'
     mkdir -p packages/generictemp/usr/share/man/man1
     cp -r bin packages/generictemp/usr/
@@ -131,7 +127,7 @@ if [ "$distro" == "3" ] || [ "$distro" == "4" ] || [ "$distro" == "6" ] || [ "$d
     cp -r share packages/generictemp/usr/
     cp extra/manpage packages/generictemp/usr/share/man/man1/sshyp.1
     gzip packages/generictemp/usr/share/man/man1/sshyp.1
-    tar -C packages/generictemp -cvf packages/sshyp-"$version".tar.xz usr/
+    tar -C packages/generictemp -cvJf packages/sshyp-"$version".tar.xz usr/
     rm -rf packages/generictemp
     sha512="$(sha512sum packages/sshyp-"$version".tar.xz | awk '{print $1;}')"
     echo -e "\nsha512 sum:\n$sha512"
@@ -177,11 +173,10 @@ rm -rf ~/rpmbuild
 echo -e "\nFedora packaging complete.\n"
 fi
 
-if [ "$distro" == "4" ] || [ "$distro" == "8" ]; then
+if [ "$distro" == "4" ] || [ "$distro" == "9" ]; then
     echo -e '\nPackaging for FreeBSD...\n'
     mkdir -p packages/FreeBSDtemp/bin
     tar xf packages/sshyp-"$version".tar.xz -C packages/FreeBSDtemp
-    ln -s /usr/local/bin/python3 packages/FreeBSDtemp/bin/python3
     echo "name: sshyp
 version: \""$version"\"
 abi = \"FreeBSD:13:*\";
@@ -207,8 +202,7 @@ prefix: /
                    },
                 },
 " > packages/FreeBSDtemp/+MANIFEST
-echo "/bin/python3
-/usr/bin/sshync.py
+echo "/usr/bin/sshync.py
 /usr/bin/sshyp
 /usr/bin/sshyp.py
 /usr/bin/sshypRemote.py
@@ -221,10 +215,9 @@ rm -rf packages/FreeBSDtemp
 echo -e "\nFreeBSD packaging complete.\n"
 fi
 
-if [ "$distro" == "7" ] || [ "$distro" == "8" ]; then
+if [ "$distro" == "7" ] || [ "$distro" == "9" ]; then
     echo -e '\nGenerating PKGBUILD...'
     echo "# Maintainer: Randall Winkhart <idgr at tutanota dot com>
-
 pkgname=sshyp
 pkgver="$version"
 pkgrel="$revision"
@@ -233,15 +226,38 @@ url='https://github.com/rwinkhart/sshyp'
 arch=('any')
 license=('GPL3')
 depends=(python gnupg openssh xclip wl-clipboard)
-
 source=(\""$source"\")
 sha512sums=('"$sha512"')
 
 package() {
-
     tar xf sshyp-"\"\$pkgver\"".tar.xz -C "\"\${pkgdir}\""
-
 }
 " > packages/PKGBUILD
     echo -e "\nPKGBUILD generated.\n"
 fi
+
+if [ "$distro" == "8" ] || [ "$distro" == "9" ]; then
+    echo -e '\nGenerating APKBUILD...'
+    echo "# Maintainer: Randall Winkhart <idgr@tutanota.com>
+pkgname=sshyp
+pkgver="$version"
+pkgrel="$((revision-1))"
+pkgdesc='A light-weight, self-hosted, synchronized password manager'
+options=!check
+url='https://github.com/rwinkhart/sshyp'
+arch='noarch'
+license='GPL-3.0-or-later'
+depends='python3 gnupg openssh xclip wl-clipboard'
+source=\""$source"\"
+
+package() {
+    mkdir -p "\"\$pkgdir\""
+    cp -r "\"\$srcdir/usr/"\" "\"\$pkgdir\""
+}
+
+sha512sums=\"
+"$sha512'  'sshyp-\"\$pkgver\".tar.xz"
+\"
+" > packages/APKBUILD
+    echo -e "\nAPKBUILD generated.\n"
+fi

share/doc/sshyp/changelog

@@ -1,27 +1,21 @@
-sshyp v1.1.1
+sshyp v1.1.2
 
-the sheecrets update - patch one
+the sheecrets update - patch two
 
-this is a polish/bug fix release that makes tweaks to the entry format (without breaking compatibility)
-
-compatibility-breaking changes:
-
-- none; the entry format tweaks are backward compatible with sshyp v1.0.0+
-    ^ the new format is slightly more efficient in terms of storage space
-        ^ if you would like to upgrade to it, run this script (after updating to v1.1.1):
-          https://raw.githubusercontent.com/rwinkhart/sshyp-labs/main/extra/conversion-scripts/sshyp-refresh-1.1.1%2B.py
+this is a general polish/bugfix release
 
 user-facing features:
 
-- entries (when editing or adding) are now run through the new optimized_edit() function to strip trailing new lines
-and ensure the format of the entries is fully compatible with all of sshyp's functions
+- packaging support for Alpine Linux/postmarketOS
+- the rename() function is no longer unnecessarily verbose
+- handled exception for when the user attempts to copy an entry field that does not exist
 
-fixes:
+fixes/optimizations:
 
-- when adding a note to an entry, there is no longer a chance the first note line will be added as a url
-if the entry is using an older format/pass format
-- the gpg auto-generation file temporarily created by sshyp no longer includes extra spaces
-    ^ seems to serve no functional purpose - fixed for the sake of polish
+- replaced shebang with "#!/usr/bin/env python3" for improved compatibility with various systems
+    ^ does not affect Haiku packaging
+- fixed the generic package not actually being compressed
+- reduced lines of code used for cross-device entry deletion
 
 <><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>