[Version] 更新版本(2.5.2-20200520.1-SNAPSHOT -> 2.5.2-20200522.1-SNAPSHOT);

[Add] BufferMessageEvent 增加用于获取Sender发送内容的Event实现;
[Change] BotEventHandler Handler现在允许命令处理方法不返回消息(返回'null');

.gitignore

@@ -1,6 +1,16 @@
+# Ignore test date folder
 /pluginData/
 /logs/
-/.idea/
-/CGJ_2.iml
 /cookies.store
 /target/
+
+# Ignore Idea files
+/.idea/
+/CGJ_2.iml
+
+# Ignore Visual Studio Code files
+.classpath
+.factorypath
+.project
+/.settings/
+/.vscode/

README.md

@@ -0,0 +1,35 @@
+# ContentGrabbingJi
+Pixiv爬虫一只，同时也是一个机器人/插件！
+
+## 支持的机器人平台 ##
+- [Mirai](https://github.com/mamoe/mirai)
+- [CoolQ](https://cqp.cc)(基于`SpringCQ`, 不支持多账号使用, 需要使用`CQHttp`插件)
+
+## Usage ##
+
+> 注意: 运行色图姬前, 你需要准备一个Pixiv账号的会话Cookie存储文件, 否则色图姬将无法运行.  
+
+### Arguments ###
+- 通用参数
+  - `proxy` / `CGJ_PROXY`: 设置代理
+    - 格式: `协议://地址:端口`
+    - 示例: `socks5://127.0.0.1:1080`
+- 机器人参数
+  - `botDataDir` / `CGJ_BOT_DATA_DIR`: 设置`botMode`运行模式下机器人数据存储目录
+    - 格式: `路径`
+    - 示例: `./data`
+    - 默认: `./`
+  - `redisAddress` / `CGJ_REDIS_URI`: Redis服务器地址
+    - 格式: `地址:端口`
+    - 示例: `127.0.0.1:6379`
+
+### Commands ###
+- `pluginMode`: CoolQ插件模式
+- `botMode`: Mirai独立模式
+- `collectionDownload`: 收藏下载, 以原图画质下载Cookie所属账号的所有收藏作品
+- `getRecommends`: 将访问主页获得的推荐作品全部以原图画质下载
+- `getRankingIllust`: 以原图画质下载指定排行榜类型的全部作品
+- `search`: 搜索指定内容并获取相关作品信息(不下载)
+
+
+

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>net.lamgc</groupId>
     <artifactId>ContentGrabbingJi</artifactId>
-    <version>2.5.2-20200517.1-SNAPSHOT</version>
+    <version>2.5.2-20200522.1-SNAPSHOT</version>
 
     <repositories>
         <repository>

src/main/java/net/lamgc/cgj/Main.java

@@ -86,13 +86,15 @@ public class Main {
         File cookieStoreFile = new File(System.getProperty("cgj.botDataDir"), "cookies.store");
         if(!cookieStoreFile.exists()) {
             log.warn("未找到cookies.store文件, 是否启动PixivLoginProxyServer? (yes/no)");
-            Scanner scanner = new Scanner(System.in);
-            if(scanner.nextLine().trim().equalsIgnoreCase("yes")) {
-                startPixivLoginProxyServer();
-            } else {
-                System.exit(1);
-                return;
+            try(Scanner scanner = new Scanner(System.in)) {
+                if(scanner.nextLine().trim().equalsIgnoreCase("yes")) {
+                    startPixivLoginProxyServer();
+                } else {
+                    System.exit(1);
+                    return;
+                }
             }
+            
         }
         ObjectInputStream ois = new ObjectInputStream(new FileInputStream(cookieStoreFile));
         cookieStore = (CookieStore) ois.readObject();
@@ -137,7 +139,9 @@ public class Main {
 
     @Command
     public static void botMode(@Argument(name = "args", force = false) String argsStr) {
-        new MiraiMain().init();
+        MiraiMain main = new MiraiMain();
+        main.init();
+        main.close();
     }
 
     @Command
@@ -423,23 +427,25 @@ public class Main {
         proxyServerStartThread.setName("LoginProxyServerThread");
         proxyServerStartThread.start();
         //System.console().readLine();
-        Scanner scanner = new Scanner(System.in);
+        
         log.info("登录完成后, 使用\"done\"命令结束登录过程.");
-        while(true) {
-            if (scanner.nextLine().equalsIgnoreCase("done")) {
-                log.info("关闭PLPS服务器...");
-                proxyServer.close();
-                cookieStore = proxyServer.getCookieStore();
-                try {
-                    log.info("正在保存CookieStore...");
-                    saveCookieStoreToFile();
-                    log.info("CookieStore保存完成.");
-                } catch (IOException e) {
-                    log.error("CookieStore保存时发生异常, 本次CookieStore仅可在本次运行使用.", e);
+        try(Scanner scanner = new Scanner(System.in)) {
+            while(true) {
+                if (scanner.nextLine().equalsIgnoreCase("done")) {
+                    log.info("关闭PLPS服务器...");
+                    proxyServer.close();
+                    cookieStore = proxyServer.getCookieStore();
+                    try {
+                        log.info("正在保存CookieStore...");
+                        saveCookieStoreToFile();
+                        log.info("CookieStore保存完成.");
+                    } catch (IOException e) {
+                        log.error("CookieStore保存时发生异常, 本次CookieStore仅可在本次运行使用.", e);
+                    }
+                    break;
+                } else {
+                    log.warn("要结束登录过程, 请使用\"done\"命令.");
                 }
-                break;
-            } else {
-                log.warn("要结束登录过程, 请使用\"done\"命令.");
             }
         }
     }

src/main/java/net/lamgc/cgj/bot/AutoArtworksSender.java

@@ -1,57 +0,0 @@
-package net.lamgc.cgj.bot;
-
-import net.lz1998.cq.robot.CoolQ;
-import org.apache.http.client.methods.HttpGet;
-
-import java.util.Random;
-import java.util.Timer;
-import java.util.TimerTask;
-
-public class AutoArtworksSender {
-
-    private final CoolQ CQ;
-    private final ReceiveType receiveType;
-    private final long targetReceiveId;
-    private Timer timer = new Timer();
-    private TimerTask task = new TimerTask() {
-        @Override
-        public void run() {
-            HttpGet request = new HttpGet();
-
-            // https://api.imjad.cn/pixiv/v2/?type=tags
-        }
-    };
-
-    public AutoArtworksSender(CoolQ cq, ReceiveType receiveType, long receiveId) {
-        this.CQ = cq;
-        this.receiveType = receiveType;
-        this.targetReceiveId = receiveId;
-    }
-
-    public void reset(long time) {
-        if(time <= 0) {
-            timer.schedule(task, new Random().nextInt(10 * 60 * 60 * 1000) + 7200000L); //2H ~ 12H
-        } else {
-            timer.schedule(task, time);
-        }
-    }
-
-    public void sendMessage(String message, boolean auto_escape) {
-        switch (receiveType) {
-            case GROUP:
-                CQ.sendGroupMsg(targetReceiveId, message, auto_escape);
-                break;
-            case Discuss:
-                CQ.sendDiscussMsg(targetReceiveId, message, auto_escape);
-                break;
-            case PRIVATE:
-                CQ.sendPrivateMsg(targetReceiveId, message, auto_escape);
-                break;
-        }
-    }
-
-    public enum ReceiveType {
-        PRIVATE, GROUP, Discuss
-    }
-
-}

src/main/java/net/lamgc/cgj/bot/BotCommandProcess.java

@@ -7,10 +7,14 @@ import io.netty.handler.codec.http.HttpHeaderNames;
 import net.lamgc.cgj.Main;
 import net.lamgc.cgj.bot.cache.*;
 import net.lamgc.cgj.bot.event.BotEventHandler;
+import net.lamgc.cgj.bot.event.BufferMessageEvent;
 import net.lamgc.cgj.bot.sort.PreLoadDataComparator;
 import net.lamgc.cgj.pixiv.PixivDownload;
 import net.lamgc.cgj.pixiv.PixivSearchBuilder;
 import net.lamgc.cgj.pixiv.PixivURL;
+import net.lamgc.cgj.pixiv.PixivDownload.PageQuality;
+import net.lamgc.cgj.pixiv.PixivURL.RankingContentType;
+import net.lamgc.cgj.pixiv.PixivURL.RankingMode;
 import net.lamgc.cgj.util.URLs;
 import net.lamgc.utils.base.runner.Argument;
 import net.lamgc.utils.base.runner.Command;
@@ -25,6 +29,7 @@ import org.slf4j.LoggerFactory;
 import java.io.File;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
 import java.text.SimpleDateFormat;
 import java.util.*;
 import java.util.concurrent.atomic.AtomicInteger;
@@ -109,7 +114,7 @@ public class BotCommandProcess {
         helpStrBuilder.append("CGJ Bot使用指南").append("\n");
         helpStrBuilder.append("使用方法：.cgj <命令> [参数...]").append("\n");
         helpStrBuilder.append("例如查询作品信息功能：").append("\n");
-        helpStrBuilder.append(".cgj artwork -id 80846159").append("\n");
+        helpStrBuilder.append(".cgj info -id 80846159").append("\n");
         helpStrBuilder.append("目前可用的命令:").append("\n");
         helpStrBuilder.append("\t").append("ranking - 获取今天或指定日期排行榜的前10名作品").append("\n");
         helpStrBuilder.append("\t\t").append("-date - 指定查询日期(年-月-日)").append("\n");
@@ -144,7 +149,7 @@ public class BotCommandProcess {
     @Command(commandName = "info")
     public static String artworkInfo(@Argument(name = "$fromGroup") long fromGroup, @Argument(name = "id") int illustId) {
         if(illustId <= 0) {
-            return "错误的作品id！";
+            return "这个作品Id是错误的！";
         }
 
         try {
@@ -295,6 +300,18 @@ public class BotCommandProcess {
         return "功能未完成";
     }
 
+    @Command(commandName = "st")
+    public static String r18Image() {
+        BufferMessageEvent event = new BufferMessageEvent();
+        RandomRankingArtworksSender artworksSender = 
+            new RandomRankingArtworksSender(event, 1, 200, 
+            RankingMode.MODE_MALE, 
+            RankingContentType.TYPE_ALL, 
+            PageQuality.ORIGINAL);
+        artworksSender.send();
+        return event.getBufferMessage();
+    }
+
     /**
      * 搜索命令
      * @param fromGroup 来源群(系统提供)
@@ -692,13 +709,6 @@ public class BotCommandProcess {
         return reportStore.exists(String.valueOf(illustId));
     }
 
-    /*
-    下一目标：
-    添加定时发图
-    定时发图支持设置关注标签
-    标签....标签支持搜索吧
-     */
-
     /**
      * 检查指定作品是否为r18
      * @param illustId 作品Id
@@ -706,13 +716,22 @@ public class BotCommandProcess {
      * @param returnRaw 是否返回原始值
      * @return 如果为true, 则不为全年龄
      * @throws IOException 获取数据时发生异常时抛出
+     * @throws NoSuchElementException 当作品不存在时抛出
      */
-    public static boolean isNoSafe(int illustId, Properties settingProp, boolean returnRaw) throws IOException {
+    public static boolean isNoSafe(int illustId, Properties settingProp, boolean returnRaw) throws IOException, NoSuchElementException {
         boolean rawValue = getIllustInfo(illustId, false).getAsJsonArray("tags").contains(new JsonPrimitive("R-18"));
         return returnRaw || settingProp == null ? rawValue : rawValue && !settingProp.getProperty("image.allowR18", "false").equalsIgnoreCase("true");
     }
 
-    private static JsonObject getIllustInfo(int illustId, boolean flushCache) throws IOException {
+    /**
+     * 获取作品信息
+     * @param illustId 作品Id
+     * @param flushCache 强制刷新缓存
+     * @return 返回作品信息
+     * @throws IOException 当Http请求发生异常时抛出
+     * @throws NoSuchElementException 当作品未找到时抛出
+     */
+    private static JsonObject getIllustInfo(int illustId, boolean flushCache) throws IOException, NoSuchElementException {
         String illustIdStr = buildSyncKey(Integer.toString(illustId));
         JsonObject illustInfoObj = null;
         if (!illustInfoCache.exists(illustIdStr) || flushCache) {
@@ -793,11 +812,19 @@ public class BotCommandProcess {
         }
         return result;
     }
-    
+
+    /**
+     * 获取图片存储目录.
+     * <p>每次调用都会检查目录是否存在, 如不存在则会抛出异常</p>
+     * @return 返回File对象
+     * @throws RuntimeException 当目录创建失败时将包装{@link IOException}异常并抛出.
+     */
     private static File getImageStoreDir() {
-        if(!imageStoreDir.exists() && !imageStoreDir.mkdirs()) {
-            log.warn("酷Q图片缓存目录失效！(Path: {} )", imageStoreDir.getAbsolutePath());
-            throw new RuntimeException(new IOException("文件夹创建失败!"));
+        if(!imageStoreDir.exists() && !Files.isSymbolicLink(imageStoreDir.toPath())) {
+            if(!imageStoreDir.mkdirs()) {
+                log.warn("酷Q图片缓存目录失效！(Path: {} )", imageStoreDir.getAbsolutePath());
+                throw new RuntimeException(new IOException("文件夹创建失败!"));
+            }
         }
         return imageStoreDir;
     }

src/main/java/net/lamgc/cgj/bot/MessageEventExecutionDebugger.java

@@ -26,13 +26,19 @@ public enum MessageEventExecutionDebugger {
 
         try {
             rotation = Integer.parseInt(properties.getProperty("debug.pm.rotation", "5"));
-        } catch(NumberFormatException ignored) {}
+        } catch(NumberFormatException e) {
+            log.warn("配置项 {} 值无效, 将使用默认值.({})", "debug.pm.rotation", rotation);
+        }
         try {
             number = Integer.parseInt(properties.getProperty("debug.pm.number", "50"));
-        } catch(NumberFormatException ignored) {}
+        } catch(NumberFormatException e) {
+            log.warn("配置项 {} 值无效, 将使用默认值.({})", "debug.pm.number", number);
+        }
         try {
             interval = Integer.parseInt(properties.getProperty("debug.pm.interval", "2500"));
-        } catch(NumberFormatException ignored) {}
+        } catch(NumberFormatException e) {
+            log.warn("配置项 {} 值无效, 将使用默认值.({})", "debug.pm.interval", interval);
+        }
 
         boolean interrupted = false;
         Thread currentThread = Thread.currentThread();

src/main/java/net/lamgc/cgj/bot/RankingUpdateTimer.java

@@ -27,8 +27,9 @@ public class RankingUpdateTimer {
         Calendar cal = Calendar.getInstance();
         cal.setTime(firstRunDate == null ? new Date() : firstRunDate);
         LocalDate currentLocalDate = LocalDate.now();
-        if(cal.get(Calendar.DAY_OF_YEAR) <= currentLocalDate.getDayOfYear() &&
-                cal.get(Calendar.HOUR_OF_DAY) >= 11 && cal.get(Calendar.MINUTE) >= 30) {
+        if(cal.get(Calendar.DAY_OF_YEAR) < currentLocalDate.getDayOfYear() || (
+                cal.get(Calendar.DAY_OF_YEAR) == currentLocalDate.getDayOfYear() &&
+                        (cal.get(Calendar.HOUR_OF_DAY) * 60 + cal.get(Calendar.MINUTE) >= 690))) {
             cal.set(Calendar.DAY_OF_YEAR, currentLocalDate.getDayOfYear() + 1);
         }
         cal.set(Calendar.HOUR_OF_DAY, 11);
@@ -36,7 +37,7 @@ public class RankingUpdateTimer {
         cal.set(Calendar.SECOND, 0);
         cal.set(Calendar.MILLISECOND, 0);
 
-        long delay = cal.getTime().getTime() - (System.currentTimeMillis());
+        long delay = cal.getTime().getTime() - System.currentTimeMillis();
         log.warn("已设置排行榜定时更新, 首次运行时间: {} ({}min)", cal.getTime(), delay / 1000 / 60);
         timer.schedule(new TimerTask() {
             @Override

src/main/java/net/lamgc/cgj/bot/cache/ImageCacheStore.java

@@ -8,7 +8,6 @@ import java.util.Hashtable;
 import java.util.Map;
 import java.util.concurrent.*;
 import java.util.concurrent.atomic.AtomicReference;
-import java.util.concurrent.locks.Condition;
 import java.util.concurrent.locks.ReentrantLock;
 
 public final class ImageCacheStore {
@@ -102,8 +101,6 @@ public final class ImageCacheStore {
 
         public final AtomicReference<TaskState> taskState = new AtomicReference<>(TaskState.READY);
 
-        public final Condition condition = lock.newCondition();
-
     }
 
 }

src/main/java/net/lamgc/cgj/bot/cache/LocalHashCacheStore.java

@@ -12,19 +12,45 @@ import java.util.concurrent.atomic.AtomicReference;
  * 基于Hashtable的本地缓存库
  * @param <T> 缓存类型
  */
-public class LocalHashCacheStore<T> implements CacheStore<T> {
+public class LocalHashCacheStore<T> implements CacheStore<T>, Cleanable {
 
     private final Hashtable<String, CacheObject<T>> cache;
 
+    /**
+     * 构造一个基于Hashtable的本地缓存库
+     * @see Hashtable
+     */
     public LocalHashCacheStore() {
         this(0);
     }
 
+    /**
+     * 构造一个基于Hashtable的本地缓存库
+     * @param initialCapacity 初始容量
+     * @see Hashtable
+     */
     public LocalHashCacheStore(int initialCapacity) {
         this(initialCapacity, 0F);
     }
 
+    /**
+     * 构造一个基于Hashtable的本地缓存库
+     * @param initialCapacity 初始容量
+     * @param loadFactor 重载因子
+     * @see Hashtable
+     */
     public LocalHashCacheStore(int initialCapacity, float loadFactor) {
+        this(initialCapacity, loadFactor, false);
+    }
+
+    /**
+     * 构造一个基于Hashtable的本地缓存库
+     * @param initialCapacity 初始容量
+     * @param loadFactor 重载因子
+     * @param autoClean 是否自动清理
+     * @see Hashtable
+     */
+    public LocalHashCacheStore(int initialCapacity, float loadFactor, boolean autoClean) {
         if(initialCapacity != 0) {
             if(loadFactor <= 0F) {
                 cache = new Hashtable<>(initialCapacity);
@@ -34,6 +60,10 @@ public class LocalHashCacheStore<T> implements CacheStore<T> {
         } else {
             cache = new Hashtable<>();
         }
+
+        if(autoClean) {
+            AutoCleanTimer.add(this);
+        }
     }
 
     @Override
@@ -118,6 +148,15 @@ public class LocalHashCacheStore<T> implements CacheStore<T> {
         return false;
     }
 
+    @Override
+    public void clean() throws Exception {
+        Date currentDate = new Date();
+        cache.forEach((key, value) -> {
+            if(value.isExpire(currentDate)) {
+                cache.remove(key);
+            }
+        });
+    }
 
     public static class CacheObject<T> implements Comparable<CacheObject<T>> {
 

src/main/java/net/lamgc/cgj/bot/event/BotEventHandler.java

@@ -215,16 +215,21 @@ public class BotEventHandler implements EventHandler {
         } catch(ParameterNoFoundException e) {
             result = "命令缺少参数: " + e.getParameterName();
         } catch(DeveloperRunnerException e) {
-            if (!(e.getCause() instanceof InterruptedException)) {
-                log.error("执行命令时发生异常", e);
-                result = "色图姬在执行命令时遇到了一个错误！";
-            } else {
+            Throwable cause = e.getCause();
+            if (cause instanceof InterruptedException) {
                 log.error("命令执行超时, 终止执行.");
                 result = "色图姬发现这个命令的处理时间太久了！所以打断了这个命令。";
+            } else if(cause instanceof NoSuchElementException && cause.getMessage().startsWith("No work found: ")) {
+                String message = cause.getMessage();
+                log.error("指定作品不存在.(Id: {})", message.substring(message.lastIndexOf(": ") + 2));
+                result = "色图姬找不到这个作品！";
+            } else {
+                log.error("执行命令时发生异常", e);
+                result = "色图姬在执行命令时遇到了一个错误！";
             }
         }
         long processTime = System.currentTimeMillis() - time;
-        if(Objects.requireNonNull(result) instanceof String && !isMute(event.getFromGroup())) {
+        if(!Objects.isNull(result) && result instanceof String && !isMute(event.getFromGroup())) {
             try {
                 event.sendMessage((String) result);
             } catch (Exception e) {

src/main/java/net/lamgc/cgj/bot/event/BufferMessageEvent.java

@@ -0,0 +1,59 @@
+package net.lamgc.cgj.bot.event;
+
+import java.util.Objects;
+
+public class BufferMessageEvent extends MessageEvent {
+
+    StringBuffer buffer = new StringBuffer();
+
+    public final MessageEvent parent;
+
+    /**
+     * 以空消息空Id生成BufferMessageEvent
+     */
+    public BufferMessageEvent() {
+        super(0, 0, "");
+        parent = null;
+    }
+
+    /**
+     * 提供消息内容构造BufferMessageEvent
+     * @param message 传入的消息内容
+     */
+    public BufferMessageEvent(String message) {
+        super(0, 0, message);
+        parent = null;
+    }
+
+    /**
+     * 使用事件构造BufferMessageEvent
+     * @param parentEvent 父级消息事件对象
+     */
+    public BufferMessageEvent(MessageEvent parentEvent) {
+        super(parentEvent.getFromGroup(), parentEvent.getFromQQ(), parentEvent.getMessage());
+        parent = parentEvent;
+    }
+
+    @Override
+    public int sendMessage(String message) {
+        buffer.append(message);
+        return 0;
+    }
+
+    /**
+     * 当提供了父级消息事件时, 本方法调用父级消息事件对象的{@code getImageUrl(String)}, 如果没有, 返回{@code null}
+     */
+    @Override
+    public String getImageUrl(String image) {
+        return Objects.isNull(this.parent) ? null : this.parent.getImageUrl(image);
+    }
+
+    /**
+     * 获取缓冲区消息内容
+     * @return 消息内容
+     */
+    public String getBufferMessage() {
+        return buffer.toString();
+    }
+
+}

src/main/java/net/lamgc/cgj/pixiv/PixivDownload.java

@@ -542,8 +542,9 @@ public class PixivDownload {
      *       }
      *      </pre>
      * @throws IOException 当请求发生异常, 或接口返回错误信息时抛出.
+     * @throws NoSuchElementException 当该作品不存在时抛出异常
      */
-    public JsonObject getIllustInfoByIllustId(int illustId) throws IOException {
+    public JsonObject getIllustInfoByIllustId(int illustId) throws IOException, NoSuchElementException {
         HttpGet request = createHttpGetRequest(PixivURL.getPixivIllustInfoAPI(illustId));
         HttpResponse response = httpClient.execute(request);
         String responseStr = EntityUtils.toString(response.getEntity());
@@ -558,7 +559,7 @@ public class PixivDownload {
         if(illustsArray.size() == 1) {
             return illustsArray.get(0).getAsJsonObject();
         } else {
-            return null;
+            throw new NoSuchElementException("No work found: " + illustId);
         }
     }
 

src/main/java/net/lamgc/cgj/proxy/PixivAccessProxyServer.java

@@ -99,7 +99,7 @@ public class PixivAccessProxyServer {
                                     }*/
                                     log.info("Response Cookie: " + value);
                                     BasicClientCookie cookie = parseRawCookie(value);
-                                    cookieStore.addCookie(null);
+                                    cookieStore.addCookie(cookie);
                                 });
                                 httpResponse.headers().remove(HttpHeaderNames.SET_COOKIE);
                                 super.afterResponse(clientChannel, proxyChannel, httpResponse, pipeline);

src/main/java/net/lamgc/cgj/util/PagesQualityParser.java

@@ -1,7 +1,6 @@
 package net.lamgc.cgj.util;
 
 import net.lamgc.cgj.pixiv.PixivDownload;
-import net.lamgc.cgj.pixiv.PixivURL;
 import net.lamgc.utils.base.runner.StringParameterParser;
 
 public class PagesQualityParser implements StringParameterParser<PixivDownload.PageQuality> {