提交: 46c78720d8de7460f4737b6e0443e6b565e8c3ed - pixiv_down (git)

A CLI tool for downloading from pixiv.net

Commit MetaInfo

• 修订版: 46c78720d8de7460f4737b6e0443e6b565e8c3ed (tree)
• 时间: 2023-09-29 19:04:43
• 作者: mio <stigma@disr...>
• Commiter: mio

Log Message

Further improvements to the progress bar

Still can't say I'm completely happy with this (trailing newlines and
single-paged illustrations not changing the final message to 'Finished')
but it's an improvement.

I did spend a while trying to get a graphic progress bar, but couldn't
integrate the UI in a way that I liked (the current implementation looks
better IMO).

See: https://codeberg.org/supercell/pixiv_down/issues/2

更改概述

• modified: CHANGELOG.md
• modified: dub.sdl
• modified: dub.selections.json
• modified: insert_gitversion.sh
• modified: source/app.d
• modified: source/util.d

差异

--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -21,16 +21,17 @@ anything, has changed.
 * All the help messages have been re-written to be more helpful and
   provide examples.
 * Images can be resumed if interrupted.
+* Progress bars used to display download progress.
 
 ### Artist Command
 
 In the first version of pixiv_down, the `artist` command would only download
 illustrations, requiring the use of `--type manga` if you wanted to download
-their manga as well.  The new version of pixiv_down changes this so it will
-download *both* illustrations and manga by default.
+their manga as well.  The new version of pixiv_down will download *both*
+illustrations and manga by default.
 
-* Allow multiple artist IDs to consecutively download more than one artist
-  in one hit.
+* Permits multiple artist IDs at once to consecutively download more than one
+  artist in a single run.
 * Download both illustrations and manga by default.
   * Specify only one by using the `--type` option.
 
@@ -53,4 +54,11 @@ your publicaly followed accounts.
 * Removed `-l, --limit` option.  It's highly probably this will return with a
   different meaning.
 
+### Bug Fixes
+
+* Using incorrect filename when downloading an Ugoira that uses Japanese in
+  the title.
+* Incorrect behaviour when attempting to resume a previous manga download
+  that wasn't finished.
+
 [Unreleased]: https://codeberg.org/supercell/pixiv_down/compare/v0.1...HEAD

--- a/dub.sdl
+++ b/dub.sdl
@@ -18,7 +18,7 @@ dependency "magickd:graphicsmagick_c" \
 
 dependency "pixivd" \
 	repository="git+https://pf.osdn.net/gitroot/n/ne/nemophila/pixivd.git" \
-	version="c9a28e4f8521840f3919c5a38817906e6be1fdef"
+	version="ec0f80a31846bc9a58dd1a31e583cbfebcfbc050"
 
         ########################################################
         # If you are using the "fetch_dependencies.sh" script, #
@@ -35,10 +35,6 @@ dependency "pixivd" \
 #	version="*"
 
 
-
-
-
-
 # Q16 default as that's what I use. Feel free to change
 # this to suit yourself, just don't commit it.
 configuration "Q16" {

--- a/dub.selections.json
+++ b/dub.selections.json
@@ -2,6 +2,6 @@
 	"fileVersion": 1,
 	"versions": {
 		"magickd": {"version":"dd4985919d78d0cf37ab4b2ab99bb2ecec6aec15","repository":"git+https://repo.or.cz/magickd.git"},
-		"pixivd": {"version":"c9a28e4f8521840f3919c5a38817906e6be1fdef","repository":"git+https://pf.osdn.net/gitroot/n/ne/nemophila/pixivd.git"}
+		"pixivd": {"version":"ec0f80a31846bc9a58dd1a31e583cbfebcfbc050","repository":"git+https://pf.osdn.net/gitroot/n/ne/nemophila/pixivd.git"}
 	}
 }

--- a/insert_gitversion.sh
+++ b/insert_gitversion.sh
@@ -15,7 +15,7 @@ then
     printf 'enum gitDate = "%s";\n' "$gdate" >> source/git_version.d
     printf 'enum gitHash = "%s";\n' "$ghash" >> source/git_version.d
 
-    printf "[insert_gitversion] Success!\n"
+    printf "[prebuild_command] Successfully inserted git version.\n"
 fi
 
    

--- a/source/app.d
+++ b/source/app.d
@@ -48,64 +48,97 @@ import pixivd.client;
 
 class ProgressMonitor
 {
-    import std.format : format;
-    import util : getTerminalColumns;
+    private       size_t currentPage = 1;
+    private const size_t totalPages;
 
-    size_t currentImage = 1;
+    this(size_t totalPages)
+    {
+        this.totalPages = totalPages;
+    }
 
     void alreadyComplete(PageAlreadyDownloadedEvent ev)
     {
         import std.conv : ConvException, to;
+        import std.format : format;
 
-        size_t promptLength = 0;
-
-        try {
-            const numberOfDigits = to!string(ev.totalPages).length;
-            const modifier = format("%%%dd", numberOfDigits);
-            const promptWM = format("\r  Already downloaded page %s.",
-                    modifier);
-            writefln(promptWM, currentImage);
-        } catch (ConvException ce) {
+        string value;
+        if (convertToString(ev.totalPages, value)) {
+            const numerOfDigits = value.length;
+            const modifier = format("%%%dd", numerOfDigits);
+            // ^ Determines the padding (e.g. %2d)
+            const prompt = format("\r  Previously downloaded page %s/%d.",
+                modifier, ev.totalPages);
+            writefln(prompt, ev.currentPage);
+        } else {
             debug(app)
             {
-                stderr.writefln("ERORR converting size_t to string");
-                stderr.writefln("  --> %s", ce.msg);
+                log.errorf("Converting size_t to string: %d", ev.totalPages);
             }
-            writefln("\r Already downloaded page %d.", currentImage);
+            writefln("\r  Previously downloaded page %d/%d.",
+                ev.currentPage, ev.totalPages);
         }
-        currentImage += 1;
+        currentPage += 1;
     }
 
     void update(DownloadProgressEvent ev)
     {
-        import std.math.traits : isNaN, isInfinity;
+        import std.format : format;
+        import std.math : isNaN, isInfinity;
+
+        string value;
+        string prompt;
+        if (convertToString(totalPages, value)) {
+            const modifier = format("%%%dd", value.length);
+            prompt = format("\r  Downloading page %s/%d...", modifier,
+                totalPages);
+            prompt = format(prompt, currentPage);
+        } else {
+            prompt = format("\r  Downloading page %d/%d...");
+        }
+
+        write(prompt);
 
         if (ev.current == 0.0 || ev.total == 0.0) {
-            write("\r 00.00%");
+            write(" (  0.00%).");
         } else {
-            double percentage = (cast(double)ev.current / ev.total) * 100;
+            const percentage = (cast(double)ev.current / ev.total) * 100.0;
             if (isNaN(percentage) || isInfinity(percentage)) {
-                percentage = 0.0;
+                write(" (  0.00%).");
+            } else {
+                writef(" (%6.2f%%).", percentage);
             }
-            writef("\r Downloading page %d... %6.2f%%", currentImage,
-                percentage);
         }
     }
 
     void complete(DownloadCompleteEvent ev)
     {
+        import std.format : format;
+        import std.range : repeat;
+        import util : getTerminalColumns;
+
+        string value;
+
         if (ev.forPage) {
-            string prompt = "\r  Downloaded page %d.".format(currentImage);
-            size_t remLength = getTerminalColumns() - prompt.length;
+            if (convertToString(totalPages, value)) {
+                const modifier = format("%%%dd", value.length);
+                const prompt = format("\r  Finished downloading page  %s/%d.",
+                    modifier, totalPages);
+                const remLength = getTerminalColumns() - prompt.length;
+
+                writef(prompt, currentPage);
+                writefln("%s", ' '.repeat(remLength));
+            } else {
+                const prompt = format("\r  Finished downloading page  %d/%d.",
+                    currentPage, totalPages);
+                const remLength = getTerminalColumns() - prompt.length;
 
-            write(prompt);
-            for (int i = 0; i < remLength; i++) {
-                write(' ');
+                write(prompt);
+                writefln("%s", ' '.repeat(remLength));
             }
-
-            currentImage += 1;
+            currentPage += 1;
+        } else {
+            write("\n");
         }
-        write('\n');
     }
 }
 
@@ -130,6 +163,28 @@ version(appimage) {
 }
 enum PixivDownVersionString = gitDate ~ " (" ~ gitHash ~ ")";
 
+///
+/// Converts *value* to a string *converted*.
+///
+/// Params:
+///   value = the value to convert
+///   converted = the output that will hold the converted string.
+///
+/// Returns: `true` if the conversion was successful, or `false`
+///          if a ConvException was thrown.
+///
+private bool convertToString(size_t value, out string converted)
+{
+    import std.conv : ConvException, to;
+
+    try {
+        converted = to!string(value);
+        return true;
+    } catch (ConvException ce) {
+        return false;
+    }
+}
+
 /**
  * Prompt for the PHPSESSID cookie.
  *
@@ -263,7 +318,7 @@ void downloadIllust(ref Illustration illust, ref Config conf,
         illust.title);
     log.tracef("Downloading post type %s", illust.type);
 
-    scope monitor = new ProgressMonitor();
+    scope monitor = new ProgressMonitor(illust.pages);
     conf.client.connect(&monitor.alreadyComplete);
     conf.client.connect(&monitor.update);
     conf.client.connect(&monitor.complete);
@@ -273,6 +328,7 @@ void downloadIllust(ref Illustration illust, ref Config conf,
     } catch (FileException fe) {
         log.warningf("FileException: %s (overwrite = %s)", fe.msg,
             overwrite ? "true" : "false");
+        stderr.write("\r");
         stderr.writefln("[%s] %s - %s has already been downloaded", illust.type,
             illust.userName, illust.title);
     }

--- a/source/util.d
+++ b/source/util.d
@@ -1,10 +1,31 @@
+/*
+ * pixiv_down - CLI-based downloading tool for https://www.pixiv.net.
+ * Copyright (C) 2023  Mio
+ *
+ * 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, version 3 of the License.
+ *
+ * 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 <https://www.gnu.org/licenses/>.
+ */
 module util;
 
-import std.conv;
-import std.process;
-
+///
+/// Returns the number of columns in the terminal.
+///
+/// Bugs: Only works on Posix.
+///
 ushort getTerminalColumns()
 {
+    import std.process : environment;
+    import std.conv : parse;
+
     string columnsEnv = environment.get("COLUMNS");
     if (null is columnsEnv) {
         return posixGetTerminalColumns();
@@ -12,13 +33,15 @@ ushort getTerminalColumns()
     return parse!ushort(columnsEnv);
 }
 
+private:
+
 version (Posix)
 {
-    import core.sys.posix.sys.ioctl;
-    import core.sys.posix.unistd;
-
     ushort posixGetTerminalColumns()
     {
+        import core.sys.posix.sys.ioctl : winsize, TIOCGWINSZ, ioctl;
+        import core.sys.posix.unistd : STDOUT_FILENO;
+
         winsize w;
         ioctl(STDOUT_FILENO, TIOCGWINSZ, &w);
         return w.ws_col;