├── .gitignore ├── src └── main │ ├── resources │ └── plugin.json │ └── java │ └── io │ └── github │ └── gmw │ ├── packetHandler │ ├── PlayerBornHook.java │ └── PlayerJoinHook.java │ ├── config │ ├── MeaMailTemplate.java │ └── MeaMailConfig.java │ ├── utils │ ├── PlayerUtils.java │ └── MailCore.java │ ├── module │ ├── TaskManager.java │ ├── PluginCommand.java │ └── ConfigParser.java │ └── MeaMailPlusCore.java ├── pom.xml ├── README_CN.md ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /.idea/ 2 | /target/ 3 | -------------------------------------------------------------------------------- /src/main/resources/plugin.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "MeaMailPlus", 3 | "description": "A plugin to send some notices to players", 4 | "version": "1.0", 5 | "mainClass": "io.github.gmw.MeaMailPlusCore", 6 | "authors": [ 7 | "Hell", 8 | "ButterCookies" 9 | ] 10 | } -------------------------------------------------------------------------------- /src/main/java/io/github/gmw/packetHandler/PlayerBornHook.java: -------------------------------------------------------------------------------- 1 | package io.github.gmw.packetHandler; 2 | 3 | import emu.grasscutter.game.player.Player; 4 | import emu.grasscutter.net.packet.Opcodes; 5 | import emu.grasscutter.net.packet.PacketOpcodes; 6 | import emu.grasscutter.server.game.GameSession; 7 | import emu.grasscutter.server.packet.recv.HandlerSetPlayerBornDataReq; 8 | import io.github.gmw.utils.MailCore; 9 | import io.github.gmw.utils.PlayerUtils; 10 | 11 | @Opcodes(PacketOpcodes.SetPlayerBornDataReq) 12 | public class PlayerBornHook extends HandlerSetPlayerBornDataReq { 13 | 14 | @Override 15 | public void handle(GameSession session, byte[] header, byte[] payload) throws Exception { 16 | super.handle(session, header, payload); 17 | int playerUid = session.getPlayer().getUid(); 18 | 19 | // 第一次加入 20 | if(playerUid != 0) { 21 | MailCore.sendInitialMailToPlayer(playerUid); 22 | MailCore.sendDailySignInMailToPlayer(playerUid); 23 | } 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /src/main/java/io/github/gmw/config/MeaMailTemplate.java: -------------------------------------------------------------------------------- 1 | package io.github.gmw.config; 2 | 3 | public final class MeaMailTemplate { 4 | public int templateId = 0; 5 | public String title = ""; 6 | public String sender = "Server"; 7 | public long expireTime = 0; 8 | 9 | public long remainTime = 2592000; // 31 days 10 | public int importance = 0; // Starred mail, 0 = No star, 1 = Star. 11 | public MailBody body = new MailBody(); 12 | public static class MailBody { 13 | public String content = ""; 14 | public ItemInfo[] items = {}; 15 | 16 | public static class ItemInfo { 17 | public int id; 18 | public int count; 19 | public int level; 20 | 21 | public ItemInfo(int id, int count) { 22 | this(id, count, 1); 23 | } 24 | 25 | public ItemInfo(int id, int count, int level) { 26 | this.id = id; 27 | this.count = count; 28 | this.level = level; 29 | } 30 | } 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /src/main/java/io/github/gmw/packetHandler/PlayerJoinHook.java: -------------------------------------------------------------------------------- 1 | package io.github.gmw.packetHandler; 2 | 3 | import emu.grasscutter.game.player.Player; 4 | import emu.grasscutter.net.packet.Opcodes; 5 | import emu.grasscutter.net.packet.PacketOpcodes; 6 | import emu.grasscutter.server.packet.recv.HandlerPlayerLoginReq; 7 | import emu.grasscutter.server.game.GameSession; 8 | import io.github.gmw.utils.MailCore; 9 | import io.github.gmw.utils.PlayerUtils; 10 | 11 | @Opcodes(PacketOpcodes.PlayerLoginReq) 12 | public class PlayerJoinHook extends HandlerPlayerLoginReq { 13 | 14 | @Override 15 | public void handle(GameSession session, byte[] header, byte[] payload) throws Exception { 16 | super.handle(session, header, payload); 17 | Player player = session.getPlayer(); 18 | 19 | if (player == null) return; // new player 20 | if(PlayerUtils.isFirstLoginToday(player)) { // first login today 21 | if (PlayerUtils.isPlayerBirthDay(player)) { // is player birthday 22 | MailCore.sendBirthDayMailToPlayer(player); 23 | } 24 | 25 | // daily mail 26 | MailCore.sendDailySignInMailToPlayer(player); 27 | } 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /src/main/java/io/github/gmw/config/MeaMailConfig.java: -------------------------------------------------------------------------------- 1 | package io.github.gmw.config; 2 | 3 | public final class MeaMailConfig { 4 | public int[] updateTime = {4,0,0}; 5 | public int[] initialMail = {1001}; 6 | public int[] birthDayMail = {1004}; 7 | 8 | public DailySignInMailTask[] dailySignInMail = { 9 | new DailySignInMailTask(1002,0) 10 | }; 11 | 12 | public DailyRepetitionTask[] dailyRepetitionMail = { 13 | new DailyRepetitionTask(1003,0,false, new int[]{12, 0, 0}) 14 | }; 15 | 16 | public static class DailyRepetitionTask extends MailTask { 17 | public boolean onlineOnly; 18 | public int[] triggerTime; 19 | 20 | public DailyRepetitionTask(int templateId, int minLevel, boolean onlineOnly, int[] triggerTime) { 21 | super(templateId, minLevel); 22 | this.onlineOnly = onlineOnly; 23 | this.triggerTime = triggerTime; 24 | } 25 | } 26 | 27 | public static class DailySignInMailTask extends MailTask { 28 | public DailySignInMailTask(int templateId, int minLevel) { 29 | super(templateId, minLevel); 30 | } 31 | } 32 | 33 | public static class MailTask { 34 | public int templateId; 35 | public int minLevel; // 0 - 60 36 | 37 | public MailTask(int templateId, int minLevel) { 38 | this.templateId = templateId; 39 | this.minLevel = minLevel; 40 | } 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /src/main/java/io/github/gmw/utils/PlayerUtils.java: -------------------------------------------------------------------------------- 1 | package io.github.gmw.utils; 2 | 3 | import emu.grasscutter.game.player.Player; 4 | import emu.grasscutter.game.player.PlayerBirthday; 5 | import io.github.gmw.MeaMailPlusCore; 6 | 7 | import java.util.Calendar; 8 | 9 | public final class PlayerUtils { 10 | public static long getPlayerBirthDayTime(Player player) { 11 | int[] updateTime = MeaMailPlusCore.getInstance().config.getConfig().updateTime; 12 | PlayerBirthday date = player.getBirthday(); 13 | Calendar cal = Calendar.getInstance(); 14 | 15 | cal.set(Calendar.DAY_OF_MONTH, date.getDay()); 16 | cal.set(Calendar.MONTH, date.getMonth() - 1); 17 | 18 | cal.set(Calendar.HOUR_OF_DAY, updateTime[0]); 19 | cal.set(Calendar.MINUTE, updateTime[1]); 20 | cal.set(Calendar.SECOND, updateTime[2]); 21 | return cal.getTimeInMillis() / 1000; 22 | } 23 | 24 | public static boolean isPlayerBirthDay(Player player) { 25 | if (player.hasBirthday()) { 26 | long playerBirthDayTime = getPlayerBirthDayTime(player); 27 | long playerEndBirthDayTime = playerBirthDayTime + 24 * 60 * 60; 28 | long currentTime = System.currentTimeMillis() / 1000; 29 | 30 | return currentTime >= playerBirthDayTime && currentTime < playerEndBirthDayTime; 31 | } 32 | return false; 33 | } 34 | 35 | public static boolean isFirstLoginToday(Player player) { 36 | long startOfDayTime = MeaMailPlusCore.getInstance().config.getTomorrowUpdateTime() - 24 * 60 * 60; 37 | long playerLastActiveTime = player.getProfile().getLastActiveTime(); 38 | long currentTime = System.currentTimeMillis() / 1000; 39 | 40 | return playerLastActiveTime < startOfDayTime && currentTime >= startOfDayTime; 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /src/main/java/io/github/gmw/module/TaskManager.java: -------------------------------------------------------------------------------- 1 | package io.github.gmw.module; 2 | 3 | import io.github.gmw.MeaMailPlusCore; 4 | import io.github.gmw.config.MeaMailConfig; 5 | import io.github.gmw.utils.MailCore; 6 | 7 | import java.util.Calendar; 8 | import java.util.Date; 9 | import java.util.Timer; 10 | import java.util.TimerTask; 11 | 12 | import io.github.gmw.config.MeaMailConfig.DailyRepetitionTask; 13 | 14 | public class TaskManager { 15 | private Timer timer; 16 | 17 | private static class dailyBeginTask extends TimerTask { 18 | @Override 19 | public void run() { 20 | // new day 21 | MailCore.dailyUpdate(); 22 | } 23 | } 24 | 25 | private static class dailyRepetitionTask extends TimerTask { 26 | private DailyRepetitionTask task; 27 | 28 | public dailyRepetitionTask(DailyRepetitionTask task) { 29 | this.task = task; 30 | } 31 | 32 | @Override 33 | public void run() { 34 | MailCore.repetitionUpdate(task); 35 | } 36 | } 37 | 38 | public Date getTaskStartTime(int hour, int minute, int second) { 39 | Calendar cal = Calendar.getInstance(); 40 | cal.set(Calendar.HOUR_OF_DAY, hour); 41 | cal.set(Calendar.MINUTE, minute); 42 | cal.set(Calendar.SECOND, second); 43 | 44 | if (cal.getTime().before(new Date())) { 45 | cal.add(Calendar.DATE, 1); 46 | } 47 | 48 | return cal.getTime(); 49 | } 50 | 51 | public void enable() { 52 | DailyRepetitionTask[] tasks = MeaMailPlusCore.getInstance().config.getConfig().dailyRepetitionMail; 53 | int[] updateTime = MeaMailPlusCore.getInstance().config.getConfig().updateTime; 54 | int cycleTime = 1000 * 60 * 60 * 24; 55 | 56 | // create timer and task 57 | this.timer = new Timer(); 58 | this.timer.schedule( 59 | new dailyBeginTask(), 60 | getTaskStartTime(updateTime[0], updateTime[1], updateTime[2]), 61 | cycleTime 62 | ); 63 | 64 | for(DailyRepetitionTask task : tasks) { 65 | this.timer.schedule( 66 | new dailyRepetitionTask(task), 67 | getTaskStartTime(task.triggerTime[0], task.triggerTime[1], task.triggerTime[2]), 68 | cycleTime 69 | ); 70 | } 71 | } 72 | 73 | public void disable() { 74 | this.timer.cancel(); 75 | } 76 | } 77 | -------------------------------------------------------------------------------- /src/main/java/io/github/gmw/MeaMailPlusCore.java: -------------------------------------------------------------------------------- 1 | package io.github.gmw; 2 | 3 | import emu.grasscutter.Grasscutter; 4 | import emu.grasscutter.command.CommandMap; 5 | import emu.grasscutter.plugin.Plugin; 6 | import emu.grasscutter.server.game.GameServerPacketHandler; 7 | import io.github.gmw.module.ConfigParser; 8 | import io.github.gmw.module.PluginCommand; 9 | import io.github.gmw.packetHandler.PlayerBornHook; 10 | import io.github.gmw.packetHandler.PlayerJoinHook; 11 | import io.github.gmw.module.TaskManager; 12 | 13 | public class MeaMailPlusCore extends Plugin { 14 | 15 | private static MeaMailPlusCore instance; 16 | public ConfigParser config; 17 | public TaskManager task; 18 | 19 | 20 | @Override 21 | public void onLoad() { 22 | this.logger("Loading..."); 23 | instance = this; 24 | 25 | this.config = new ConfigParser(); 26 | this.config.loadConfig(); 27 | this.config.loadTemplates(); 28 | this.task = new TaskManager(); 29 | 30 | this.logger("Loaded!"); 31 | } 32 | 33 | @Override 34 | public void onEnable() { 35 | CommandMap.getInstance().registerCommand("meamail", new PluginCommand()); 36 | 37 | // register packet handler 38 | GameServerPacketHandler packetHandler = Grasscutter.getGameServer().getPacketHandler(); 39 | packetHandler.registerPacketHandler(PlayerJoinHook.class); 40 | packetHandler.registerPacketHandler(PlayerBornHook.class); 41 | 42 | this.task.enable(); 43 | } 44 | 45 | @Override 46 | public void onDisable() { 47 | CommandMap.getInstance().unregisterCommand("meamail"); 48 | this.task.disable(); 49 | } 50 | 51 | public static MeaMailPlusCore getInstance() { 52 | return instance; 53 | } 54 | 55 | public void reloadConfig() { 56 | this.task.disable(); 57 | this.config.loadConfig(); 58 | this.config.loadTemplates(); 59 | this.task.enable(); 60 | } 61 | 62 | public void logger(String message) { 63 | this.logger(message, "info"); 64 | } 65 | 66 | public void logger(String message, String type) { 67 | if (Grasscutter.getLogger() == null) return; 68 | 69 | String msg = "[MeaMailPlusCore] " + message; 70 | switch (type) { 71 | case "info" -> Grasscutter.getLogger().info(msg); 72 | case "warn" -> Grasscutter.getLogger().warn(msg); 73 | case "error" -> Grasscutter.getLogger().error(msg); 74 | } 75 | } 76 | } 77 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | io.github 8 | MeaMailPlus 9 | 1.0-SNAPSHOT 10 | 11 | 12 | 17 13 | 17 14 | 15 | 16 | 17 | 18 | 19 | org.apache.maven.plugins 20 | maven-compiler-plugin 21 | 3.8.1 22 | 23 | 17 24 | 17 25 | 26 | 27 | 28 | org.apache.maven.plugins 29 | maven-shade-plugin 30 | 3.2.4 31 | 32 | 33 | package 34 | 35 | shade 36 | 37 | 38 | false 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | src/main/resources 47 | true 48 | 49 | 50 | 51 | 52 | 53 | 54 | emu.grasscutter 55 | Grasscutter-api 56 | 1.0 57 | system 58 | ${basedir}/../Grasscutter/grasscutter-1.2.3-dev-beb6906.jar 59 | 60 | 61 | 62 | com.google.code.gson 63 | gson 64 | 2.9.0 65 | 66 | 67 | 68 | 69 | -------------------------------------------------------------------------------- /src/main/java/io/github/gmw/module/PluginCommand.java: -------------------------------------------------------------------------------- 1 | package io.github.gmw.module; 2 | 3 | import emu.grasscutter.Grasscutter; 4 | import emu.grasscutter.command.Command; 5 | import emu.grasscutter.command.CommandHandler; 6 | import emu.grasscutter.game.player.Player; 7 | import io.github.gmw.MeaMailPlusCore; 8 | import io.github.gmw.config.MeaMailConfig; 9 | import io.github.gmw.config.MeaMailTemplate; 10 | import io.github.gmw.utils.MailCore; 11 | 12 | import java.util.*; 13 | 14 | @Command(label = "meamail", usage = "meamail help", 15 | description = "MeaMailPlusCore command", aliases = {"mmail"}, permission = "meo.mail") 16 | 17 | public class PluginCommand implements CommandHandler { 18 | 19 | @Override 20 | public void execute(Player sender, Player targetPlayer, List args) { 21 | switch (args.size()) { 22 | default -> // *No args* 23 | showHelpList(sender); 24 | case 1 -> { 25 | switch (args.get(0)) { 26 | case "reload" -> { 27 | MeaMailPlusCore.getInstance().reloadConfig(); 28 | if (sender == null) 29 | Grasscutter.getLogger().info("[MeaNoticeCore] Reloaded!"); 30 | else 31 | CommandHandler.sendMessage(sender, "MeaNoticeCore config reloaded"); 32 | } 33 | case "help" -> showHelpList(sender); 34 | default -> CommandHandler.sendMessage(sender, "Invalid args."); 35 | } 36 | } 37 | case 2 -> { 38 | int templateId = Integer.parseInt(args.get(1)); 39 | MeaMailTemplate template = MeaMailPlusCore.getInstance().config.getTemplate(templateId); 40 | 41 | 42 | switch (args.get(0)) { 43 | case "sendall" -> { 44 | if (template == null) { 45 | CommandHandler.sendMessage(sender, "Invalid template id."); 46 | return; 47 | } 48 | 49 | MailCore.sendMailToAllPlayers(template); 50 | CommandHandler.sendMessage(sender, "Mail Sended!"); 51 | } 52 | case "sendallonline" -> { 53 | if (template == null) { 54 | CommandHandler.sendMessage(sender, "Invalid template id."); 55 | return; 56 | } 57 | 58 | MailCore.sendMailToAllPlayers(template, 0, true); 59 | CommandHandler.sendMessage(sender, "Mail Sended!"); 60 | } 61 | default -> CommandHandler.sendMessage(sender, "Invalid args."); 62 | } 63 | } 64 | case 3 -> { 65 | int templateId = Integer.parseInt(args.get(1)); 66 | MeaMailTemplate template = MeaMailPlusCore.getInstance().config.getTemplate(templateId); 67 | 68 | switch (args.get(0)) { 69 | case "send" -> { 70 | if (template == null) { 71 | CommandHandler.sendMessage(sender, "Invalid template id."); 72 | return; 73 | } 74 | 75 | int uid = Integer.parseInt(args.get(2)); 76 | CommandHandler.sendMessage(sender, "Mail Sending..."); 77 | MailCore.sendMailToPlayer(uid, template, false); 78 | } 79 | case "sendonline" -> { 80 | if (template == null) { 81 | CommandHandler.sendMessage(sender, "Invalid template id."); 82 | return; 83 | } 84 | 85 | int uid = Integer.parseInt(args.get(2)); 86 | CommandHandler.sendMessage(sender, "Mail Sending..."); 87 | MailCore.sendMailToPlayer(uid, template, true); 88 | } 89 | case "sendall" -> { 90 | if (template == null) { 91 | CommandHandler.sendMessage(sender, "Invalid template id."); 92 | return; 93 | } 94 | 95 | int minLevel = Integer.parseInt(args.get(2)); 96 | MailCore.sendMailToAllPlayers(template, minLevel); 97 | CommandHandler.sendMessage(sender, "Mail Sended!"); 98 | } 99 | case "sendallonline" -> { 100 | if (template == null) { 101 | CommandHandler.sendMessage(sender, "Invalid template id."); 102 | return; 103 | } 104 | 105 | int minLevel = Integer.parseInt(args.get(2)); 106 | MailCore.sendMailToAllPlayers(template, minLevel, true); 107 | CommandHandler.sendMessage(sender, "Mail Sended!"); 108 | } 109 | default -> CommandHandler.sendMessage(sender, "Invalid args."); 110 | } 111 | } 112 | } 113 | } 114 | 115 | public void showHelpList(Player sender) { 116 | String[] helpMap = new String[]{ 117 | "Send Mail:", 118 | " /meamail send ", 119 | " /meamail sendall [minLevel]", 120 | " /meamail sendallonline [minLevel]", 121 | "Other:", 122 | " /meamail reload", 123 | " /meamail help", 124 | }; 125 | 126 | for (String text : helpMap) { 127 | CommandHandler.sendMessage(sender, text); 128 | } 129 | } 130 | } 131 | 132 | -------------------------------------------------------------------------------- /README_CN.md: -------------------------------------------------------------------------------- 1 | ![Group 148.jpg](https://s2.loli.net/2022/05/03/5ZPG2neTlrMW6Az.jpg) 2 | # MeaMailPlus - Grasscutter 邮件增强 3 | MeaMailPlus 是一个 [Grasscutter](https://github.com/Grasscutters/Grasscutter) 插件, 你可以用它来轻松的收发邮件. 4 | 5 | [English](./README.md) | 简体中文 6 | 7 | 推荐使用 Grasscutter 命令生成工具: 8 | [GrasscutterCommandGenerator](https://github.com/jie65535/GrasscutterCommandGenerator) 9 | 10 | ## 💡Feature 11 | 12 | - [x] **生日邮件** - 玩家生日时向他们发送祝福邮件. 13 | - [X] **每日奖励** - 玩家每天登录时都能收到奖励. 14 | - [X] **新手礼包** - 玩家第一次进入服务器时会收到奖励. 15 | - [X] **推送定时邮件** - 你可以设置冒险等级限制，决定哪些玩家能收到定时邮件. 16 | - [X] **支持命令** - 支持用命令发送邮件. 17 | - [ ] **RESTful API** - 使用第三方API发送邮件. 18 | - [ ] **更多** - Comming soon... 19 | 20 | ## 🍗Setup 21 | ### 安装 22 | 1. [下载插件](https://github.com/Coooookies/Grasscutter-MeaMailPlus/releases) 23 | 2. 把插件放进你的Grasscutter服务器的 `plugins` 文件夹。 24 | 3. 启动服务器，插件会自动在你的服务器插件文件夹下生成 `MeaMailPlus` 文件夹。 25 | ``` 26 | Root 27 | │ lib 28 | │ keys 29 | │ resources 30 | │ ... 31 | └───plugins 32 | │ ... 33 | └───MeaMailPlus 34 | │ template // 模板文件 35 | └───config.json // 插件配置 36 | ``` 37 | ### 游戏内乱码了！ 38 | 如果你是Linux： 39 | - 将配置文件和Template模板文件转换成utf8编码 40 | 41 | 如果你是Windows： 42 | - 将配置文件和Template模板文件转换成ansi(gb2312)编码 43 | ### 怎么用？ 44 | 45 | 在插件目录中的`MeaMailPlus`目录下, 包含 `template` 文件夹和 `config.json` 配置文件 46 | #### 配置文件设置 47 | 配置文件是一个 `JSON` 格式的文件。你可以通过修改配置文件来控制插件的行为。 48 | 配置完后，在Console中输入`/meamail reload`即可重载配置文件。 49 | ``` 50 | { 51 | "updateTime": [4, 0, 0], // 设置服务器的邮件推送时间，这里设置的是 04:00:00 (24小时时间制) 52 | "initialMail": [ 1001 ], // 设置新玩家第一次进服时接收的邮件模板ID，可以设置很多个，例如： [1001, 1002, 1003] 53 | "birthDayMail": [ 1004 ], // 设置玩家生日邮件模板ID，当然也可以设置很多个（如果玩家有点贪） 54 | 55 | "dailySignInMail": [ // 玩家每日登录的邮件，会在每天推送时间或者是玩家上线时发送，一天只能领取一次，不上线就没有。 56 | { 57 | "templateId": 1002, // 邮件模板ID 58 | "minLevel": 0 // 设置冒险等级限制，0表示不限制，小于这个冒险等级的玩家不会收到邮件 59 | }, 60 | { 61 | "templateId": 1003, // 设置多个邮件... 62 | "minLevel": 25 63 | }, 64 | { 65 | "templateId": 1004, // 设置多个邮件... 66 | "minLevel": 55 67 | } 68 | ], 69 | 70 | "dailyRepetitionMail": [ // 设置每日定时邮件 71 | { 72 | "onlineOnly": false, // 是否只有在线玩家能接收邮件，如果设置成离线，则所有玩家都能接收到 73 | "triggerTime": [12, 0, 0], // 触发时间 这里是 12:00:00 74 | "templateId": 1003, // 邮件模板ID 75 | "minLevel": 0 // 设置冒险等级限制，0表示不限制，小于这个冒险等级的玩家不会收到邮件 76 | }, 77 | { // 设置多个邮件... 78 | "onlineOnly": true, 79 | "triggerTime": [16, 0, 0], // 16:00:00 80 | "templateId": 1003, 81 | "minLevel": 0 82 | }, 83 | { // 设置多个邮件... 84 | "onlineOnly": true, 85 | "triggerTime": [0, 0, 0], // 24:00:00 86 | "templateId": 1003, 87 | "minLevel": 0 88 | } 89 | ] 90 | } 91 | ``` 92 | #### Template 模板文件 93 | 你可以自行创建多个模板文件放进 `template` 文件夹，命名随意, 同样只支持 `JSON`文件. 94 | 举个栗子: 95 | TemplateExample.json 96 | ``` 97 | { 98 | "templateId": 1001, // 你的邮件模板ID，不能重复。 99 | "title": "Mail title", // 邮件标题 100 | "sender": "KiritaniIwako", // 邮件发送人，你可以设置为 "Server" 101 | "expireTime": 0, // 过期时间，稍后会详细介绍 102 | "remainTime": 2592000, // 剩余时间，如果你设置了剩余时间，则过期时间不会生效 103 | "importance": 0, // 邮件重要等级，0为默认，1为收藏 104 | "body": { // 邮件内容，稍后会详细介绍 105 | "content": "Mail content", 106 | "items": [ 107 | { 108 | "id": 223, // 物品id 109 | "count": 1, // 数量 110 | "level": 1 // 等级(0-90?) 111 | } 112 | ] 113 | } 114 | } 115 | ``` 116 | 1. 如何设置过期时间 `expireTime` 或者是剩余时间 `remainTime`? 117 | - [时间戳转换器](https://tool.lu/timestamp/) 118 | ``` 119 | { 120 | "expireTime": 1651571451, 121 | // 使用十位时间戳来定义到期时间 122 | // 你可以使用下面的转换工具来将时间转换为时间戳（记得选择时间单位为秒） 123 | // https://tool.lu/timestamp/ 124 | 125 | "remainTime": 2592000 126 | // 剩余时间（秒） 127 | // 2592000 秒 = 30 天，计算方法：: 128 | // 2592000 = 30(天) * 24(小时) * 60(分钟) * 60(秒) 129 | // 如果你不确定的话，也可以将两个时间转换成时间戳后相减，得到时间间隔： 130 | // 2592000 = 1651568400 (2022-5-3 9:00:00GMT) - 1648976400 (2022-4-3 9:00:00GMT) 131 | } 132 | ``` 133 | 134 | 2. 如何设置邮件的内容 `body/content`? 135 | ``` 136 | { 137 | "body": { 138 | "content": "Mail content", 139 | // 你可以设置邮件的内容，支持变量：, 140 | // `{playerName}`: (未上线) 玩家名称 141 | // `\r\n`: 换行符 142 | // 你甚至可以创建超链接，有两种打开方式：`browser`对应的是打开系统浏览器，`webview`对应的是打开游戏自带的浏览器: 143 | // 144 | // 比如： 145 | // ``: 打开一个系统浏览器，标签的名字叫 "Discord". 146 | // ``: 打开一个游戏自带的浏览器，标签的名字叫 "Discord". 147 | 148 | "items": [ // 邮件附带的物品，如果设置为`[]`则不会附带物品 149 | { 150 | "id": 223, // 物品id 151 | "count": 1, // 数量 152 | "level": 1 // 等级(1-90?) 153 | }, 154 | { 155 | "id": 224, // 多个物品... 156 | "count": 1, 157 | "level": 1 158 | }, 159 | { 160 | "id": 202, // 多个物品... 161 | "count": 10000000, 162 | "level": 1 163 | } 164 | ] 165 | } 166 | } 167 | ``` 168 | 169 | 在邮件内容里设置超链接: 170 | ``` 171 | 172 | ``` 173 | 比如： 174 | ``` 175 | 176 | 177 | ``` 178 | 179 | ### 命令和权限 180 | Command: 181 | ``` 182 | 发送邮件: 183 | /meamail send <模板Id> 184 | /meamail sendall <模板Id> <最小冒险等级> 185 | /meamail sendallonline <模板Id> <最小冒险等级> 186 | 其他: 187 | /meamail reload 188 | /meamail help 189 | ``` 190 | 191 | Permission: 192 | ``` 193 | meo.mail | 控制插件 194 | ``` -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![Group 148.jpg](https://s2.loli.net/2022/05/03/5ZPG2neTlrMW6Az.jpg) 2 | # MeaMailPlus - Grasscutter Mail enhancements 3 | MeaMailPlus is a plugin of [Grasscutter](https://github.com/Grasscutters/Grasscutter), you can use this plugin to send your mail conveniently. 4 | 5 | English | [简体中文](./README_CN.md) 6 | 7 | Grasscutter's command tools: 8 | [GrasscutterCommandGenerator](https://github.com/jie65535/GrasscutterCommandGenerator) 9 | 10 | ## 💡Feature 11 | 12 | - [x] **Birthday Mail** - Send birthday emails to players on their birthdays. 13 | - [X] **Daily Bonus** - Players will receive rewards when they join the server. 14 | - [X] **Newbie Gift Mail** - Players will receive rewards when they first joined. 15 | - [X] **Scheduled Mail push** - You can limit the level threshold of players to receive the mail. 16 | - [X] **Command support** - Support sending Mails by command. 17 | - [ ] **RESTful API** - Send Mail via third-party API. 18 | - [ ] **MORE** - Comming soon... 19 | 20 | ## 🍗Setup 21 | ### Install 22 | 1. [Download Plugin Jar](https://github.com/Coooookies/Grasscutter-MeaMailPlus/releases) 23 | 2. Put plugins into `plugins` folder of your grasscutter server. 24 | 3. Start your server, then the plugin will create `MeaMailPlus` folder in your server plugin folder. 25 | ``` 26 | Root 27 | │ lib 28 | │ keys 29 | │ resources 30 | │ ... 31 | └───plugins 32 | │ ... 33 | └───MeaMailPlus 34 | │ template // template files 35 | └───config.json // plugin config file 36 | ``` 37 | 38 | ### How to use? 39 | 40 | The plugin will create a `MeaMailPlus` folder in your server plugin folder, include `template` folder and `config.json` file. 41 | #### Config file 42 | The config file is a `JSON` file, you can edit it to set the plugin's behavior. 43 | Run command `/meamail reload` in console to reload the config. 44 | ``` 45 | { 46 | "updateTime": [4, 0, 0], // set the server's start time for send mail of the day, default is 04:00:00(24 hours system) 47 | "initialMail": [ 1001 ], // set the initial mail template id, you can set multiple mail ids like [1001, 1002, 1003] 48 | "birthDayMail": [ 1004 ], // set the birthday mail template id, you can set multiple mail too! 49 | 50 | "dailySignInMail": [ // players can only receive once a day, and will not send if they are not online. 51 | { 52 | "templateId": 1002, // set the template id for daily sign in mail. 53 | "minLevel": 0 // you can limit the level(0-60) threshold of players to receive the mail. 54 | }, 55 | { 56 | "templateId": 1003, // multiple mail... 57 | "minLevel": 25 58 | }, 59 | { 60 | "templateId": 1004, // multiple mail... 61 | "minLevel": 55 62 | } 63 | ], 64 | 65 | "dailyRepetitionMail": [ // send a timed email collectively 66 | { 67 | "onlineOnly": false, // whether the player needs to be online to receive mail 68 | "triggerTime": [12, 0, 0], // 12:00:00 69 | "templateId": 1003, // templateId 70 | "minLevel": 0 // you can limit the level(0-60) threshold of players to receive the mail. 71 | }, 72 | { // multiple mail... 73 | "onlineOnly": true, 74 | "triggerTime": [16, 0, 0], // 16:00:00 75 | "templateId": 1003, 76 | "minLevel": 0 77 | }, 78 | { // multiple mail... 79 | "onlineOnly": true, 80 | "triggerTime": [0, 0, 0], // 24:00:00 81 | "templateId": 1003, 82 | "minLevel": 0 83 | } 84 | ] 85 | } 86 | ``` 87 | #### Template file 88 | You can make multiple template files in `template` folder, only supports `JSON`. 89 | like this: 90 | TemplateExample.json 91 | ``` 92 | { 93 | "templateId": 1001, // Your template id, can't be repeated 94 | "title": "Mail title", // Your Mail title 95 | "sender": "KiritaniIwako", // Your sender name, you can set "Server" 96 | "expireTime": 0, // Your mail expire time, will be explained in detail later. 97 | "remainTime": 2592000, // Your mail remain time, if you have set the remainTime, the expireTime will not take effect. 98 | "importance": 0, // Your mail importance, 0 is normal, 1 is star 99 | "body": { // Your mail content, will be explained in detail later. 100 | "content": "Mail content", 101 | "items": [ 102 | { 103 | "id": 223, // item id 104 | "count": 1, // amount 105 | "level": 1 // item level(0-90?) 106 | } 107 | ] 108 | } 109 | } 110 | ``` 111 | 1. How to set the mail `expireTime` or `remainTime`? 112 | - [Timestamp converter](https://www.epochconverter.com/) 113 | ``` 114 | { 115 | "expireTime": 1651571451, 116 | // use 10 digits timestamp, like this: 117 | // you can use convert tool to convert the timestamp to 10 digits timestamp, 118 | // https://www.epochconverter.com/ 119 | 120 | "remainTime": 2592000 121 | // time in second 122 | // 2592000 is the seconds of 30 days: 123 | // 2592000 = 30(d) * 24(h) * 60(m) * 60(s) 124 | // if you are not sure, you can use two 10 digits timestamp subtraction: 125 | // 2592000 = 1651568400 (2022-5-3 9:00:00GMT) - 1648976400 (2022-4-3 9:00:00GMT) 126 | } 127 | ``` 128 | 129 | 2. How to set the mail `body/content`? 130 | ``` 131 | { 132 | "body": { 133 | "content": "Mail content", 134 | // you can set the content of the mail, 135 | // you can use the variable: 136 | // `{playerName}`: (Testing) player name 137 | // `\r\n`: line feed 138 | // you can use link to open Browser & Webview in-game: 139 | // 140 | // for example: 141 | // ``: open a Browser, tag name is "Discord". 142 | // ``: open a in-game Browser, tag name is "Discord". 143 | 144 | "items": [ // items in the mail, if you set `[]`, no item will be sent 145 | { 146 | "id": 223, // item id 147 | "count": 1, // amount 148 | "level": 1 // item level(1-90?) 149 | }, 150 | { 151 | "id": 224, // Multiple items... 152 | "count": 1, 153 | "level": 1 154 | }, 155 | { 156 | "id": 202, // Multiple items... 157 | "count": 10000000, 158 | "level": 1 159 | } 160 | ] 161 | } 162 | } 163 | ``` 164 | 165 | Hyperlinks in the mail content: 166 | ``` 167 | 168 | ``` 169 | for example: 170 | ``` 171 | 172 | 173 | ``` 174 | ### Command & Permission 175 | Command: 176 | ``` 177 | Send Mail: 178 | /meamail send 179 | /meamail sendall 180 | /meamail sendallonline 181 | Other: 182 | /meamail reload 183 | /meamail help 184 | ``` 185 | 186 | Permission: 187 | ``` 188 | meo.mail | Control plugin functions 189 | ``` 190 | -------------------------------------------------------------------------------- /src/main/java/io/github/gmw/utils/MailCore.java: -------------------------------------------------------------------------------- 1 | package io.github.gmw.utils; 2 | 3 | import emu.grasscutter.Grasscutter; 4 | import emu.grasscutter.database.DatabaseHelper; 5 | import emu.grasscutter.game.player.Player; 6 | import emu.grasscutter.game.mail.Mail; 7 | import io.github.gmw.MeaMailPlusCore; 8 | import io.github.gmw.config.MeaMailConfig; 9 | import io.github.gmw.config.MeaMailTemplate; 10 | 11 | import java.time.Instant; 12 | import java.util.ArrayList; 13 | import java.util.Arrays; 14 | import java.util.List; 15 | import java.util.concurrent.atomic.AtomicBoolean; 16 | import java.util.stream.Collectors; 17 | 18 | 19 | public final class MailCore { 20 | public static void saveMailToDatabase(Player player, MeaMailTemplate template) { 21 | saveMailToDatabase(player, template, 0); 22 | } 23 | 24 | public static void saveMailToDatabase(Player player, MeaMailTemplate template, int minLevel) { 25 | if (player.getLevel() < minLevel) return; 26 | 27 | Mail mail = templateToMail(template); 28 | mail.setOwnerUid(player.getUid()); 29 | DatabaseHelper.saveMail(mail); 30 | MeaMailPlusCore.getInstance().logger("Mail sent to " + player.getUid() + "(Offline): " + template.title); 31 | } 32 | 33 | public static void sendMailToPlayer(int uid, MeaMailTemplate template) { 34 | sendMailToPlayer(uid, template, false); 35 | } 36 | 37 | public static void sendMailToPlayer(int uid, MeaMailTemplate template, boolean onlineOnly) { 38 | Player player = Grasscutter.getGameServer().getPlayerByUid(uid, !onlineOnly); 39 | if (player == null) return; 40 | sendMailToPlayer(player, template); 41 | } 42 | 43 | public static void sendMailToPlayer(Player player, MeaMailTemplate template) { 44 | sendMailToPlayer(player, template, 0); 45 | } 46 | 47 | public static void sendMailToPlayer(Player player, int templateId) { 48 | sendMailToPlayer(player, templateId, 0); 49 | } 50 | 51 | public static void sendMailToPlayer(Player player, int templateId, int minLevel) { 52 | MeaMailTemplate template = getTemplateById(templateId); 53 | if(template == null) { 54 | MeaMailPlusCore.getInstance().logger("Template with id " + templateId + " not found"); 55 | return; 56 | } 57 | sendMailToPlayer(player, template, minLevel); 58 | } 59 | 60 | public static void sendMailToPlayer(Player player, MeaMailTemplate template, int minLevel) { 61 | if (player.getLevel() >= minLevel) { 62 | if (player.isOnline()) { 63 | player.sendMail(templateToMail(template)); 64 | MeaMailPlusCore.getInstance().logger("Mail sent to " + player.getUid() + ": " + template.title); 65 | } else saveMailToDatabase(player, template); 66 | } else { 67 | MeaMailPlusCore.getInstance().logger("Player " + player.getUid() + " is not level " + minLevel + " and mail was not sent"); 68 | } 69 | } 70 | 71 | private static Mail templateToMail(MeaMailTemplate mailTemplate) { 72 | Mail mail = new Mail(); 73 | mail.mailContent.content = mailTemplate.body.content; 74 | mail.mailContent.title = mailTemplate.title; 75 | mail.mailContent.sender = mailTemplate.sender; 76 | mail.importance = mailTemplate.importance; 77 | 78 | if (mailTemplate.remainTime == 0) { 79 | mail.expireTime = mailTemplate.expireTime; 80 | } else { 81 | mail.expireTime = (int) Instant.now().getEpochSecond() + mailTemplate.remainTime; 82 | } 83 | 84 | mail.itemList = Arrays.stream(mailTemplate.body.items) 85 | .map(item -> new Mail.MailItem(item.id, item.count, item.level)) 86 | .collect(Collectors.toList()); 87 | return mail; 88 | } 89 | 90 | private static MeaMailConfig getConfig() { 91 | return MeaMailPlusCore.getInstance().config.getConfig(); 92 | } 93 | 94 | private static MeaMailTemplate getTemplateById(int id) { 95 | return MeaMailPlusCore.getInstance().config.getTemplate(id); 96 | } 97 | 98 | public static void sendMailToAllPlayers(int templateId) { 99 | sendMailToAllPlayers(templateId, 0); 100 | } 101 | 102 | public static void sendMailToAllPlayers(MeaMailTemplate template) { 103 | sendMailToAllPlayers(template, 0); 104 | } 105 | 106 | public static void sendMailToAllPlayers(int templateId, int minLevel) { 107 | sendMailToAllPlayers(templateId, minLevel, false); 108 | } 109 | 110 | public static void sendMailToAllPlayers(MeaMailTemplate template, int minLevel) { 111 | sendMailToAllPlayers(template, minLevel, false); 112 | } 113 | 114 | public static void sendMailToAllPlayers(int templateId, int minLevel, boolean onlineOnly) { 115 | MeaMailTemplate template = getTemplateById(templateId); 116 | if(template == null) { 117 | MeaMailPlusCore.getInstance().logger("Template with id " + templateId + " not found"); 118 | return; 119 | } 120 | sendMailToAllPlayers(template, minLevel, onlineOnly); 121 | } 122 | 123 | public static void sendMailToAllPlayers(MeaMailTemplate template, int minLevel, boolean onlineOnly) { 124 | if (template == null) return; 125 | 126 | List onlinePlayers = new ArrayList<>(); 127 | List offlinePlayers = new ArrayList<>(); 128 | Grasscutter.getGameServer().getPlayers().forEach((index, player) -> onlinePlayers.add(player)); 129 | 130 | if (!onlineOnly) { 131 | DatabaseHelper.getAllPlayers().forEach(player -> { 132 | if (onlinePlayers.stream().noneMatch(onlinePlayer -> onlinePlayer.getUid() == player.getUid())) { 133 | offlinePlayers.add(player); 134 | } 135 | }); 136 | } 137 | 138 | // two methods to send mail 139 | onlinePlayers.forEach(player -> sendMailToPlayer(player, template, minLevel)); 140 | offlinePlayers.forEach(player -> saveMailToDatabase(player, template, minLevel)); 141 | } 142 | 143 | public static void sendDailySignInMailToPlayer(int uid) { 144 | Player player = Grasscutter.getGameServer().getPlayerByUid(uid, false); 145 | if (player == null) return; 146 | sendDailySignInMailToPlayer(player); 147 | } 148 | 149 | public static void sendDailySignInMailToPlayer(Player player) { 150 | MeaMailConfig.DailySignInMailTask[] dailyTasks = getConfig().dailySignInMail; 151 | for(MeaMailConfig.DailySignInMailTask task : dailyTasks) { 152 | sendMailToPlayer(player, task.templateId, task.minLevel); 153 | } 154 | } 155 | 156 | public static void sendBirthDayMailToPlayer(int uid) { 157 | Player player = Grasscutter.getGameServer().getPlayerByUid(uid, false); 158 | if (player == null) return; 159 | sendBirthDayMailToPlayer(player); 160 | } 161 | 162 | public static void sendBirthDayMailToPlayer(Player player) { 163 | int[] BirthdayMailTemplateIds = getConfig().birthDayMail; 164 | for(int templateId : BirthdayMailTemplateIds) { 165 | sendMailToPlayer(player, templateId); 166 | } 167 | } 168 | 169 | public static void sendInitialMailToPlayer(int uid) { 170 | Player player = Grasscutter.getGameServer().getPlayerByUid(uid, false); 171 | if (player == null) return; 172 | sendInitialMailToPlayer(player); 173 | } 174 | 175 | public static void sendInitialMailToPlayer(Player player) { 176 | int[] InitialMailTemplateIds = getConfig().initialMail; 177 | for(int templateId : InitialMailTemplateIds) { 178 | sendMailToPlayer(player, templateId); 179 | } 180 | } 181 | 182 | public static void dailyUpdate() { 183 | // update daily 184 | Grasscutter.getGameServer().getPlayers().forEach((index, player) -> { 185 | // birthday mail 186 | if (PlayerUtils.isPlayerBirthDay(player)) { 187 | sendBirthDayMailToPlayer(player); 188 | } 189 | 190 | // daily sign in 191 | sendDailySignInMailToPlayer(player); 192 | }); 193 | } 194 | 195 | public static void repetitionUpdate(MeaMailConfig.DailyRepetitionTask task) { 196 | // update daily on time 197 | sendMailToAllPlayers(task.templateId, task.minLevel, task.onlineOnly); 198 | } 199 | } 200 | -------------------------------------------------------------------------------- /src/main/java/io/github/gmw/module/ConfigParser.java: -------------------------------------------------------------------------------- 1 | package io.github.gmw.module; 2 | 3 | import java.io.File; 4 | import java.io.FileReader; 5 | import java.io.FileWriter; 6 | import java.time.Instant; 7 | import java.util.ArrayList; 8 | import java.util.Calendar; 9 | 10 | import com.google.gson.Gson; 11 | import com.google.gson.GsonBuilder; 12 | import emu.grasscutter.Grasscutter; 13 | import io.github.gmw.MeaMailPlusCore; 14 | import io.github.gmw.config.MeaMailConfig; 15 | import io.github.gmw.config.MeaMailTemplate; 16 | 17 | public class ConfigParser { 18 | private MeaMailConfig config; 19 | private ArrayList templates; 20 | private final String configPath = Grasscutter.getConfig().folderStructure.plugins + "MeaMailPlus"; 21 | private final String templatePath = this.configPath + "/template"; 22 | private final File configFile = new File( this.configPath + "/config.json"); 23 | private static final Gson gson = new GsonBuilder().setPrettyPrinting().create(); 24 | 25 | public void loadTemplates() { 26 | switch (this.createConfigFolder(this.templatePath)){ 27 | case -1: return; 28 | case 0: { // Without Template 29 | this.createTemplate(); 30 | break; 31 | } 32 | case 1: { 33 | break; 34 | } 35 | } 36 | 37 | 38 | ArrayList templates = new ArrayList<>(); 39 | File[] files = new File(this.templatePath) 40 | .listFiles(); 41 | 42 | if (files == null) return; // No Template 43 | else { 44 | for (File file : files) { 45 | try (FileReader fileReader = new FileReader(file)) { 46 | MeaMailTemplate template = gson.fromJson(fileReader, MeaMailTemplate.class); 47 | templates.add(template); // 加入模板列表 48 | MeaMailPlusCore.getInstance() 49 | .logger("Loaded template: " + file.getName() + " (TemplateId: " + template.templateId + ")"); 50 | } catch (Exception e) { 51 | MeaMailPlusCore.getInstance() 52 | .logger("Unable to load template file: " + file.getName(),"error"); 53 | } 54 | } 55 | } 56 | 57 | this.templates = templates; 58 | MeaMailPlusCore.getInstance() 59 | .logger("Loaded " + templates.size() + " templates. :D"); 60 | 61 | } 62 | 63 | // get template by templateId 64 | public MeaMailTemplate getTemplate(int templateId) { 65 | for (MeaMailTemplate template : this.templates) { 66 | if (template.templateId == templateId) return template; 67 | } 68 | return null; 69 | } 70 | 71 | public void createTemplate() { 72 | MeaMailTemplate template_initialMail = new MeaMailTemplate(); 73 | MeaMailTemplate template_dailySignInMail = new MeaMailTemplate(); 74 | MeaMailTemplate template_dailyRepetitionMail = new MeaMailTemplate(); 75 | MeaMailTemplate template_birthDayMail = new MeaMailTemplate(); 76 | 77 | template_initialMail.templateId = 1001; 78 | template_initialMail.remainTime = 2592000; // 一个月后过期 79 | template_initialMail.title = "Thank you for using MeaMailPlus!"; 80 | template_initialMail.sender= "MeaKiritaniIwako"; 81 | template_initialMail.importance = 1; 82 | template_initialMail.body.content = 83 | "Hi!\r\n" + 84 | "Thank you for using MeaMailPlus! You can use MeaMailPlus to send mail to your friends more conveniently.\r\n\r\n" + 85 | "Github HomePage" + 86 | "\r\n" + 87 | "Grasscutter Discord" + 88 | ""; 89 | template_initialMail.body.items = new MeaMailTemplate.MailBody.ItemInfo[]{ 90 | new MeaMailTemplate.MailBody.ItemInfo(80544, 1, 20), 91 | new MeaMailTemplate.MailBody.ItemInfo(223, 150) 92 | }; 93 | 94 | template_dailySignInMail.templateId = 1002; 95 | template_dailySignInMail.remainTime = 604800; // 1 week 96 | template_dailySignInMail.title = "Daily-Bonus"; 97 | template_dailySignInMail.body.content = "Have a nice day！"; 98 | template_dailySignInMail.body.items = new MeaMailTemplate.MailBody.ItemInfo[]{ 99 | new MeaMailTemplate.MailBody.ItemInfo(223, 20), 100 | new MeaMailTemplate.MailBody.ItemInfo(224, 20) 101 | }; 102 | 103 | template_dailyRepetitionMail.templateId = 1003; 104 | template_dailyRepetitionMail.remainTime = 1209600; // 2 weeks later 105 | template_dailyRepetitionMail.title = "Have a question?"; 106 | template_dailyRepetitionMail.sender= "TeamDarkshin"; 107 | template_dailyRepetitionMail.body.content = 108 | "Join Grasscutter Discord server to ask questions and get answers:" + 109 | ""; 110 | 111 | template_birthDayMail.templateId = 1004; 112 | template_birthDayMail.remainTime = 31536000; // 1 year 113 | template_birthDayMail.title = "Best Wishes on Your Birthday"; 114 | template_birthDayMail.sender = "Mailing System"; 115 | template_birthDayMail.importance = 1; 116 | template_birthDayMail.body.content = 117 | "Happy Birthday, Traveler! Please find your gift attached to this message.\r\n" + 118 | "Thank you for all your support. We wish you a wonderful day, wherever in this world you may roam."; 119 | template_birthDayMail.body.items = new MeaMailTemplate.MailBody.ItemInfo[]{ 120 | new MeaMailTemplate.MailBody.ItemInfo(118003, 1) 121 | }; 122 | 123 | 124 | this.saveTemplate("InitialMail", template_initialMail); 125 | this.saveTemplate("DailySignInMail", template_dailySignInMail); 126 | this.saveTemplate("DailyRepetitionMail", template_dailyRepetitionMail); 127 | this.saveTemplate("BirthDayMail", template_birthDayMail); 128 | } 129 | 130 | public boolean saveTemplate(String fileName, MeaMailTemplate templateClass) { 131 | try (FileWriter file = new FileWriter(this.templatePath + "/" + fileName + ".json")) { 132 | file.write(gson.toJson(templateClass)); 133 | return true; 134 | } catch (Exception e) { 135 | return false; 136 | } 137 | } 138 | 139 | // load config.json 140 | public void loadConfig() { 141 | try (FileReader file = new FileReader(this.configFile)) { 142 | this.config = gson.fromJson(file, MeaMailConfig.class); 143 | MeaMailPlusCore.getInstance().logger("Config Loaded!"); 144 | } catch (Exception e) { 145 | this.config = new MeaMailConfig(); 146 | MeaMailPlusCore.getInstance().logger("Basic config creating..."); 147 | } 148 | 149 | if (!saveConfig()) { 150 | MeaMailPlusCore.getInstance().logger("Unable to save config file.","error"); 151 | } 152 | } 153 | 154 | // save config.json 155 | 156 | public int createConfigFolder(String path) { 157 | File dir = new File(path); 158 | 159 | if (!dir.exists() || !dir.isDirectory()) { 160 | if(new File(String.valueOf(dir)).mkdirs()) return 0; 161 | else return -1; 162 | } 163 | 164 | return 1; 165 | } 166 | 167 | public boolean saveConfig() { 168 | if (this.createConfigFolder(this.configPath) == -1) return false; 169 | 170 | try (FileWriter file = new FileWriter(this.configFile)) { 171 | file.write(gson.toJson(this.config)); 172 | } catch (Exception e) { 173 | return false; 174 | } 175 | 176 | return true; 177 | } 178 | 179 | public MeaMailConfig getConfig() { 180 | return this.config; 181 | } 182 | 183 | public long getTomorrowUpdateTime() { 184 | // get tomorrow's update time 185 | Calendar cal = Calendar.getInstance(); 186 | cal.add(Calendar.DATE, 1); 187 | cal.set(Calendar.HOUR_OF_DAY, this.config.updateTime[0]); 188 | cal.set(Calendar.MINUTE, this.config.updateTime[1]); 189 | cal.set(Calendar.SECOND, this.config.updateTime[2]); 190 | return cal.getTimeInMillis() / 1000; 191 | } 192 | } 193 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------