Commit: e18345887020b56f1ffc52446d14c027e0554019 - pixiv_down (git)

A CLI tool for downloading from pixiv.net

Commit MetaInfo

• Revision: e18345887020b56f1ffc52446d14c027e0554019 (tree)
• Zeit: 2023-06-22 12:03:18
• Autor: mio <stigma@disr...>
• Commiter: mio

Log Message

Improve 'artwork' command

The main change is the --group-errors option which will only print the
errors just before the command has finished executing, rather than
immediately after the error occurrs.

This means you don't have to go searching for any errors after
downloading the artworks.

Ändern Zusammenfassung

• modified: source/app.d

Diff

--- a/source/app.d
+++ b/source/app.d
@@ -389,40 +389,76 @@ int artistHandle(string[] args, ref Config config)
 
 int artworkHandle(string[] args, ref Config config)
 {
-    if (3 > args.length) {
-        stderr.writefln("Usage: %s <id>...", args[0]);
-        return 1;
-    }
+   // When an exception occurrs.
+   string[] invalidArtworks;
+   // The error message for the invalidArtworks
+   // each index in the array matches the ID.
+   string[] errorMessages;
+   bool groupErrors = false;
+   int returnCode = 0;
 
-    // Help
-    {
-        string arg = args[2];
-        if ("help" == arg || "--help" == arg || "-h" == arg) {
-            writefln("Usage: %s <id>...", args[0]);
-            return 0;
-        }
-    }
+   if (3 > args.length) {
+      displayArtworkHelp(args[0]);
+      return 1;
+   }
 
-    foreach (arg; args[2..$]) {
-        size_t id;
+   foreach (arg; args[2..$]) {
+      size_t id;
 
-        try {
-            id = to!size_t(arg);
-        } catch (ConvException ce) {
-            log.criticalf("Could not convert \"%s\" to size_t.", arg);
+      if ("--help" == arg || "-h" == arg) {
+         displayArtworkHelp(args[0]);
+         return 0;
+      }
+      if ("--group-errors" == arg) {
+         groupErrors = true;
+         log.info("errors will be grouped");
+         continue;
+      }
 
-            stderr.writefln(`Failed to download artwork ID "%s".`, arg);
-            stderr.writeln("-- It could not be parsed as a number.");
-            return 1;
-        }
+      try {
+         id = to!size_t(arg);
+      } catch (ConvException ce) {
+         log.errorf("Could not convert %s to size_t", arg);
+
+         if (groupErrors) {
+            invalidArtworks ~= arg;
+            errorMessages ~= "Not a valid number.";
+         } else {
+            stderr.writefln("%s: Could not convert '%s' to a valid ID.",
+               args[0], arg);
+            stderr.writeln("The ID must be a valid number.");
+            returnCode = 1;
+         }
+         continue;
+      }
 
-        Illustration illust = config.client.fetchIllustration(id);
-        downloadIllust(illust, config);
+      try {
+         scope illust = config.client.fetchIllustration(id);
+         downloadIllust(illust, config);
+      } catch (PixivJSONException pje) {
+
+         if (groupErrors) {
+            invalidArtworks ~= arg;
+            errorMessages ~= pje.msg;
+         } else {
+            stderr.writefln("%s: Failed to fetch and download ID '%d'",
+               id);
+            stderr.writeln(pje.msg);
+         }
+         continue;
+      }
 
-        sleep(1, 5);
-    }
+      sleep(1, 5);
+   }
 
-    return 0;
+   if (groupErrors && 0 < invalidArtworks.length) {
+      stderr.writeln("Failed to download the following IDs:");
+      foreach(index, id; invalidArtworks) {
+         stderr.writefln("   %s - %s", id, errorMessages[index]);
+      }
+   }
+
+    return returnCode;
 }
 
 int dailyHandle(string[] args, ref Config config)
@@ -687,7 +723,7 @@ helpHandle(string[] args, const ref Config config)
          displayArtistHelp(args[0]);
          break;
       case "artwork":
-         writeln("Artwork help");
+         displayArtworkHelp(args[0]);
          break;
       case "daily":
          displayDailyHelp(args[0]);
@@ -781,6 +817,24 @@ displayArtistHelp(string programName)
       "       pixiv_down artist --type illust 10109777 4938312",
       programName);
 }
+
+void
+displayArtworkHelp(string programName)
+{
+   stderr.writefln(
+      "pixiv_down artwork - Download specific artwork(s)\n" ~
+      "\nUsage:\t%s artwork <id> [<additional ids...>]\n" ~
+      "\nYou can download one or more artworks via this command.  Any\n" ~
+      "artworks that fail to download are mentioned after attempting to\n" ~
+      "download, you can change this to only print at the end by using the\n" ~
+      "--group-errors option.\n" ~
+      "\nOptions:\n" ~
+      " --group-errors\tDisplay errors at the end instead.\n" ~
+      "\nExamples:\n" ~
+      "\n  Download a single artwork:\n" ~
+      "       pixiv_down artwork id\n" ~
+      "\n  Download multiple artworks and display failed IDs at the end:\n" ~
+      "       pixiv_down artwork --group-errors id1 id2\n",
       programName);
 }