From abe52c831d08680bf6ab5c01459f9712eab97728 Mon Sep 17 00:00:00 2001 From: a1346054 <36859588+a1346054@users.noreply.github.com> Date: Wed, 25 Aug 2021 21:54:57 +0000 Subject: [PATCH 1/7] Don't parse output of `ls` --- pkg/deb/prerm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg/deb/prerm b/pkg/deb/prerm index d39cc86..61c613b 100755 --- a/pkg/deb/prerm +++ b/pkg/deb/prerm @@ -2,7 +2,7 @@ # Unlink the ffs alias if it links to ffsend if [[ -L /usr/bin/ffs ]] \ - && [[ $(ls -l /usr/bin/ffs | sed -e 's/.* -> //') == "/usr/bin/ffsend" ]]; \ + && [[ $(realpath /usr/bin/ffs) == "/usr/bin/ffsend" ]]; \ then echo "Removing ffs alias for ffsend..." unlink /usr/bin/ffs From 42dffc864d708403b60c26bcdc7269a66d41dcf7 Mon Sep 17 00:00:00 2001 From: a1346054 <36859588+a1346054@users.noreply.github.com> Date: Wed, 25 Aug 2021 22:23:37 +0000 Subject: [PATCH 2/7] Use correct license file The current file was missing the "How to Apply These Terms to Your New Programs" section, which is an integral part of the GPL and is not supposed to be removed: https://www.gnu.org/licenses/gpl-faq.html#GPLOmitPreamble Correct file was downloaded from: https://www.gnu.org/licenses/gpl-3.0.txt --- LICENSE | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 54 insertions(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 94a0453..f288702 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,7 @@ GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 - Copyright (C) 2007 Free Software Foundation, Inc. + Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. @@ -619,3 +619,56 @@ Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. From 485e5cd08810f547bd959dcf432de8aeb76929a7 Mon Sep 17 00:00:00 2001 From: a1346054 <36859588+a1346054@users.noreply.github.com> Date: Wed, 25 Aug 2021 22:29:23 +0000 Subject: [PATCH 3/7] Use https links --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7fa6a04..4be98f1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -115,7 +115,7 @@ members of the project's leadership. ### Attribution This Code of Conduct is adapted from the [Contributor Covenant][coc-homepage], version 1.4, -available at [http://contributor-covenant.org/version/1/4][coc-version] +available at [https://contributor-covenant.org/version/1/4][coc-version] ## License This project is released under the GNU GPL-3.0 license. @@ -128,5 +128,5 @@ Check out the [LICENSE](LICENSE) file for more information. [github]: https://github.com/timvisee/ffsend [github-issues]: https://github.com/timvisee/ffsend/issues [github-pr]: https://github.com/timvisee/ffsend/pulls -[coc-homepage]: http://contributor-covenant.org -[coc-version]: http://contributor-covenant.org/version/1/4/ +[coc-homepage]: https://contributor-covenant.org +[coc-version]: https://contributor-covenant.org/version/1/4/ From 1dcecbc281580f5a439ef55db2bc609d529a921f Mon Sep 17 00:00:00 2001 From: a1346054 <36859588+a1346054@users.noreply.github.com> Date: Wed, 25 Aug 2021 22:30:17 +0000 Subject: [PATCH 4/7] Invoke bash using /usr/bin/env instead of hardcoded path --- res/asciinema-to-svg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/res/asciinema-to-svg b/res/asciinema-to-svg index 33588d1..cc0ef84 100755 --- a/res/asciinema-to-svg +++ b/res/asciinema-to-svg @@ -1,4 +1,4 @@ -#!/bin/bash +#!/usr/bin/env bash # Ensure svg-term is installed if ! [ -x "$(command -v svg-term)" ]; then From c7c53d8649ca7183a377683188b06c374cec2315 Mon Sep 17 00:00:00 2001 From: a1346054 <36859588+a1346054@users.noreply.github.com> Date: Wed, 25 Aug 2021 22:31:38 +0000 Subject: [PATCH 5/7] Fix issues in scripts identified using shellcheck --- contrib/completions/gen_completions | 2 +- pkg/create_deb | 20 ++++++++++---------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/contrib/completions/gen_completions b/contrib/completions/gen_completions index 6a4aad6..6e25225 100755 --- a/contrib/completions/gen_completions +++ b/contrib/completions/gen_completions @@ -4,5 +4,5 @@ set -e echo "Generating all completions using cargo debug binary..." -cargo run -q -- generate completions all --output $PWD +cargo run -q -- generate completions all --output "$PWD" echo "Done." diff --git a/pkg/create_deb b/pkg/create_deb index 253d3d4..bae3012 100755 --- a/pkg/create_deb +++ b/pkg/create_deb @@ -9,13 +9,13 @@ if [[ ! $TRAVIS_TAG =~ ^v([0-9]+\.)*[0-9]+$ ]]; then fi # Ensure the debian architecture is set -if [[ -z "$DEB_ARCH" ]]; then +if [[ -z $DEB_ARCH ]]; then echo "Error: debian architecture not configured in \$DEB_ARCH" exit 1 fi # Define some useful variables -DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" +DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd ) VERSION=${TRAVIS_TAG:1} # Ensure the binary file exists @@ -25,23 +25,23 @@ if [[ ! -f "$DIR/../ffsend" ]]; then fi # Create an application directory, copy the binary into it -mkdir -p $DIR/ffsend-$VERSION -cp $DIR/../ffsend $DIR/ffsend-$VERSION/ffsend +mkdir -p "$DIR/ffsend-$VERSION" +cp -- "$DIR/../ffsend" "$DIR/ffsend-$VERSION/ffsend" # Create an application tarbal -cd $DIR/.. -git archive --format tar.gz -o $DIR/ffsend-$VERSION/ffsend-$VERSION.tar.gz $TRAVIS_TAG +cd -- "$DIR/.." +git archive --format tar.gz -o "$DIR/ffsend-$VERSION/ffsend-$VERSION.tar.gz" "$TRAVIS_TAG" # Change into the app directory -cd $DIR/ffsend-$VERSION +cd -- "$DIR/ffsend-$VERSION" # Build the debian package # TODO: define GPG? -dh_make -e "timvisee@gmail.com" -c gpl3 -f ffsend-$VERSION.tar.gz -s -y -rm *.ex README.Debian README.source +dh_make -e "timvisee@gmail.com" -c gpl3 -f "ffsend-$VERSION.tar.gz" -s -y +rm -- *.ex README.Debian README.source # Remove the project tar ball, we're not using it anymore -rm $DIR/ffsend-$VERSION/ffsend-$VERSION.tar.gz +rm -- "$DIR/ffsend-$VERSION/ffsend-$VERSION.tar.gz" # TODO: configure the debian/control file # TODO: configure copyright file From e2c20840e4c22827aaa6c8453611f3f63c7706dd Mon Sep 17 00:00:00 2001 From: a1346054 <36859588+a1346054@users.noreply.github.com> Date: Wed, 25 Aug 2021 22:40:44 +0000 Subject: [PATCH 6/7] Fix spelling --- src/action/download.rs | 6 +++--- src/action/generate/completions.rs | 2 +- src/action/history.rs | 2 +- src/action/mod.rs | 2 +- src/action/upload.rs | 4 ++-- src/cmd/arg/gen_passphrase.rs | 2 +- src/cmd/arg/mod.rs | 2 +- src/cmd/matcher/upload.rs | 4 ++-- src/history.rs | 4 ++-- src/urlshorten.rs | 2 +- src/util.rs | 22 +++++++++++----------- 11 files changed, 26 insertions(+), 26 deletions(-) diff --git a/src/action/download.rs b/src/action/download.rs index 22604b7..39236fe 100644 --- a/src/action/download.rs +++ b/src/action/download.rs @@ -139,7 +139,7 @@ impl<'a> Download<'a> { { // Allocate an archive file, and update the download and target paths if extract { - // TODO: select the extention dynamically + // TODO: select the extension dynamically let archive_extention = ".tar"; // Allocate a temporary file to download the archive to @@ -210,7 +210,7 @@ impl<'a> Download<'a> { /// /// The full path including the name is returned. /// - /// This method will check whether a file is overwitten, and whether + /// This method will check whether a file is overwritten, and whether /// parent directories must be created. /// /// The program will quit with an error message if a problem occurs. @@ -313,7 +313,7 @@ impl<'a> Download<'a> { // Get the path string let path = target.to_str(); - // If the path is emtpy, use the working directory with the name hint + // If the path is empty, use the working directory with the name hint let use_workdir = path.map(|path| path.trim().is_empty()).unwrap_or(true); if use_workdir { match current_dir() { diff --git a/src/action/generate/completions.rs b/src/action/generate/completions.rs index c9299cf..370f691 100644 --- a/src/action/generate/completions.rs +++ b/src/action/generate/completions.rs @@ -24,7 +24,7 @@ impl<'a> Completions<'a> { let matcher_main = MainMatcher::with(self.cmd_matches).unwrap(); let matcher_completions = CompletionsMatcher::with(self.cmd_matches).unwrap(); - // Obtian shells to generate completions for, build application definition + // Obtain shells to generate completions for, build application definition let shells = matcher_completions.shells(); let dir = matcher_completions.output(); let quiet = matcher_main.quiet(); diff --git a/src/action/history.rs b/src/action/history.rs index 9c47436..f969fa9 100644 --- a/src/action/history.rs +++ b/src/action/history.rs @@ -63,7 +63,7 @@ impl<'a> History<'a> { // Remove history item if let Some(url) = matcher_history.rm() { - // Remove item, print error if no item with URL was foudn + // Remove item, print error if no item with URL was found match history.remove_url(url) { Ok(removed) if !removed => quit_error_msg( "could not remove item from history, no item matches given URL", diff --git a/src/action/mod.rs b/src/action/mod.rs index f2e65e8..32dd7c5 100644 --- a/src/action/mod.rs +++ b/src/action/mod.rs @@ -50,7 +50,7 @@ fn select_api_version( )); } - // Propegate other errors + // Propagate other errors Err(e) => return Err(e), } diff --git a/src/action/upload.rs b/src/action/upload.rs index a59e487..9366421 100644 --- a/src/action/upload.rs +++ b/src/action/upload.rs @@ -224,7 +224,7 @@ impl<'a> Upload<'a> { // Finish the archival process, writes the archive file archiver.finish().map_err(ArchiveError::Write)?; - // Append archive extention to name, set to upload archived file + // Append archive extension to name, set to upload archived file if let Some(ref mut file_name) = file_name { file_name.push_str(archive_extention); } @@ -275,7 +275,7 @@ impl<'a> Upload<'a> { // TODO: set false parameter to authentication state let max_size = upload_size_max(api_version, auth); - // Get the file size, fail on emtpy files, warn about large files + // Get the file size, fail on empty files, warn about large files if let Ok(size) = path.metadata().map(|m| m.len()) { // Enforce files not being 0 bytes if size == 0 && !matcher_main.force() { diff --git a/src/cmd/arg/gen_passphrase.rs b/src/cmd/arg/gen_passphrase.rs index 0bc8957..9e83cc1 100644 --- a/src/cmd/arg/gen_passphrase.rs +++ b/src/cmd/arg/gen_passphrase.rs @@ -11,7 +11,7 @@ pub struct ArgGenPassphrase {} impl ArgGenPassphrase { /// Generate a cryptographically secure passphrase that is easily - /// rememberable using diceware. + /// remembered using diceware. pub fn gen_passphrase() -> String { let mut config = BasicConfig::default(); config.words = PASSPHRASE_WORDS; diff --git a/src/cmd/arg/mod.rs b/src/cmd/arg/mod.rs index 9c5ca46..3878a95 100644 --- a/src/cmd/arg/mod.rs +++ b/src/cmd/arg/mod.rs @@ -8,7 +8,7 @@ pub mod owner; pub mod password; pub mod url; -// Re-eexport to arg module +// Re-export to arg module pub use self::api::ArgApi; pub use self::basic_auth::ArgBasicAuth; pub use self::download_limit::ArgDownloadLimit; diff --git a/src/cmd/matcher/upload.rs b/src/cmd/matcher/upload.rs index d0c1e33..3562ca3 100644 --- a/src/cmd/matcher/upload.rs +++ b/src/cmd/matcher/upload.rs @@ -35,7 +35,7 @@ impl<'a: 'b, 'b> UploadMatcher<'a> { let name = self.matches.value_of("name")?; // The file name must not be empty - // TODO: allow to force an empty name here, and process emtpy names on downloading + // TODO: allow to force an empty name here, and process empty names on downloading if name.trim().is_empty() { quit_error_msg( "the file name must not be empty", @@ -171,7 +171,7 @@ pub enum CopyMode { } impl CopyMode { - /// Build the string to copy, based on the given `url` and currend mode. + /// Build the string to copy, based on the given `url` and current mode. pub fn build(&self, url: &str) -> String { match self { CopyMode::Url => url.into(), diff --git a/src/history.rs b/src/history.rs index b6d9060..dec3d8a 100644 --- a/src/history.rs +++ b/src/history.rs @@ -21,7 +21,7 @@ const VERSION_MAX: &str = crate_version!(); #[derive(Serialize, Deserialize)] pub struct History { /// The application version the history file was built with. - /// Used for compatability checking. + /// Used for compatibility checking. version: Option, /// The file history. @@ -224,7 +224,7 @@ impl History { /// /// If the expiry property is None (thus unknown), the file will be kept. /// - /// The number of exired files is returned. + /// The number of expired files is returned. pub fn gc(&mut self) -> usize { // Get a list of expired files let expired: Vec = self diff --git a/src/urlshorten.rs b/src/urlshorten.rs index 9af73d4..67a8694 100644 --- a/src/urlshorten.rs +++ b/src/urlshorten.rs @@ -76,7 +76,7 @@ pub enum Error { #[fail(display = "failed to shorten URL, got bad response")] Response(#[cause] ResponseError), - /// The server resonded with a malformed repsonse. + /// The server responded with a malformed response. #[fail(display = "failed to shorten URL, got malformed response")] Malformed(#[cause] reqwest::Error), diff --git a/src/util.rs b/src/util.rs index ef93732..a79737d 100644 --- a/src/util.rs +++ b/src/util.rs @@ -291,13 +291,13 @@ pub fn highlight_info(msg: &str) -> ColoredString { } /// Open the given URL in the users default browser. -/// The browsers exit statis is returned. +/// The browsers exit status is returned. pub fn open_url(url: impl Borrow) -> Result { open_path(url.borrow().as_str()) } /// Open the given path or URL using the program configured on the system. -/// The program exit statis is returned. +/// The program exit status is returned. pub fn open_path(path: &str) -> Result { open::that(path) } @@ -318,7 +318,7 @@ pub fn set_clipboard(content: String) -> Result<(), ClipboardError> { /// native clipboard interface only has a lifetime of the application. This means that the /// clipboard is instantly cleared as soon as this application quits, which is always immediately. /// This limitation is due to security reasons as defined by X11. The alternative binaries we set -/// the clipboard with spawn a daemon in the background to keep the clipboad alive until it's +/// the clipboard with spawn a daemon in the background to keep the clipboard alive until it's /// flushed. #[cfg(feature = "clipboard")] #[derive(Clone, Eq, PartialEq)] @@ -491,7 +491,7 @@ pub enum ClipboardError { #[fail(display = "failed to access clipboard using {}", _0)] BinaryIo(&'static str, #[cause] IoError), - /// `xclip` or `xsel` unexpectetly exited with a non-successful status code. + /// `xclip` or `xsel` unexpectedly exited with a non-successful status code. #[cfg(feature = "clipboard-bin")] #[fail( display = "failed to use clipboard, {} exited with status code {}", @@ -500,8 +500,8 @@ pub enum ClipboardError { BinaryStatus(&'static str, i32), } -/// Check for an emtpy password in the given `password`. -/// If the password is emtpy the program will quit with an error unless +/// Check for an empty password in the given `password`. +/// If the password is empty the program will quit with an error unless /// forced. // TODO: move this to a better module pub fn check_empty_password(password: &str, matcher_main: &MainMatcher) { @@ -519,7 +519,7 @@ pub fn check_empty_password(password: &str, matcher_main: &MainMatcher) { /// Prompt the user to enter a password. /// -/// If `empty` is `false`, emtpy passwords aren't allowed unless forced. +/// If `empty` is `false`, empty passwords aren't allowed unless forced. pub fn prompt_password(main_matcher: &MainMatcher, optional: bool) -> Option { // Quit with an error if we may not interact if !optional && main_matcher.no_interact() { @@ -549,7 +549,7 @@ pub fn prompt_password(main_matcher: &MainMatcher, optional: bool) -> Option { if !optional { quit_error( @@ -592,7 +592,7 @@ pub fn ensure_password( return false; } - // Check whehter we allow interaction + // Check whether we allow interaction let interact = !main_matcher.no_interact(); loop { @@ -761,7 +761,7 @@ pub fn ensure_owner_token( main_matcher: &MainMatcher, optional: bool, ) -> bool { - // Check whehter we allow interaction + // Check whether we allow interaction let interact = !main_matcher.no_interact(); // Notify that an owner token is required @@ -984,7 +984,7 @@ pub fn ensure_enough_space>(path: P, size: u64) { } }; - // Return if enough disk space is avaiable + // Return if enough disk space is available if space >= size { return; } From 7e5c750340d1a13d78b784ed4f3906fcf1b5868a Mon Sep 17 00:00:00 2001 From: a1346054 <36859588+a1346054@users.noreply.github.com> Date: Wed, 25 Aug 2021 22:41:18 +0000 Subject: [PATCH 7/7] Trim excess whitespace --- .gitlab-ci.yml | 2 +- CONTRIBUTING.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 5c31920..8666459 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -39,7 +39,7 @@ before_script: rustc --version cargo --version -# Check on stable, beta and nightly +# Check on stable, beta and nightly .check-base: &check-base stage: check script: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4be98f1..571c2ce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ Contributions to the `ffsend` project are welcome! When contributing new features, alternative implementations or bigger improvements, please first discuss the change you wish to make via an issue or email. -Small changes such as fixed commands, fixed spelling or dependency updates +Small changes such as fixed commands, fixed spelling or dependency updates are always welcome without discussion. The `ffsend` repository is primarily hosted on [GitLab][gitlab]. @@ -119,7 +119,7 @@ available at [https://contributor-covenant.org/version/1/4][coc-version] ## License This project is released under the GNU GPL-3.0 license. -Check out the [LICENSE](LICENSE) file for more information. +Check out the [LICENSE](LICENSE) file for more information. [branch-master]: https://gitlab.com/timvisee/ffsend/tree/master [gitlab]: https://gitlab.com/timvisee/ffsend