content: /*
   * Solo - A small and beautiful blogging system written in Java.
   * Copyright (c) 2010-present, b3log.org
   *
   * Solo is licensed under Mulan PSL v2.
   * You can use this software according to the terms and conditions of the Mulan PSL v2.
   * You may obtain a copy of Mulan PSL v2 at:
   *         http://license.coscl.org.cn/MulanPSL2
   * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
   * See the Mulan PSL v2 for more details.
   */
  package org.b3log.solo.processor.console;
  
  import jodd.io.ZipUtil;
  import org.apache.commons.io.FileUtils;
  import org.apache.commons.io.IOUtils;
  import org.apache.commons.lang3.StringUtils;
  import org.apache.commons.lang3.time.DateFormatUtils;
  import org.apache.logging.log4j.Level;
  import org.apache.logging.log4j.LogManager;
  import org.apache.logging.log4j.Logger;
  import org.b3log.latke.Keys;
  import org.b3log.latke.Latkes;
  import org.b3log.latke.event.Event;
  import org.b3log.latke.event.EventManager;
  import org.b3log.latke.http.FileUpload;
  import org.b3log.latke.http.Request;
  import org.b3log.latke.http.RequestContext;
  import org.b3log.latke.http.Response;
  import org.b3log.latke.http.renderer.AbstractFreeMarkerRenderer;
  import org.b3log.latke.ioc.Inject;
  import org.b3log.latke.ioc.Singleton;
  import org.b3log.latke.model.Plugin;
  import org.b3log.latke.model.User;
  import org.b3log.latke.plugin.ViewLoadEventData;
  import org.b3log.latke.service.LangPropsService;
  import org.b3log.solo.Server;
  import org.b3log.solo.model.Common;
  import org.b3log.solo.model.Option;
  import org.b3log.solo.model.UserExt;
  import org.b3log.solo.service.*;
  import org.b3log.solo.util.Markdowns;
  import org.b3log.solo.util.Solos;
  import org.b3log.solo.util.StatusCodes;
  import org.json.JSONObject;
  
  import java.io.File;
  import java.io.FileInputStream;
  import java.io.FileOutputStream;
  import java.io.OutputStream;
  import java.nio.charset.StandardCharsets;
  import java.util.*;
  
  /**
   * Admin console render processing.
   *
   * @author <a href="http://88250.b3log.org">Liang Ding</a>
   * @version 2.0.0.1, May 21, 2020
   * @since 0.4.1
   */
  @Singleton
  public class AdminConsole {
  
      /**
       * Logger.
       */
      private static final Logger LOGGER = LogManager.getLogger(AdminConsole.class);
  
      /**
       * Language service.
       */
      @Inject
      private LangPropsService langPropsService;
  
      /**
       * Option query service.
       */
      @Inject
      private OptionQueryService optionQueryService;
  
      /**
       * User query service.
       */
      @Inject
      private UserQueryService userQueryService;
  
      /**
       * Export service.
       */
      @Inject
      private ExportService exportService;
  
      /**
       * DataModelService.
       */
      @Inject
      private DataModelService dataModelService;
  
      /**
       * Event manager.
       */
      @Inject
      private EventManager eventManager;
  
      /**
       * Import service.
       */
      @Inject
      private ImportService importService;
  
      /**
       * Shows administrator index with the specified context.
       *
       * @param context the specified context
       */
      public void showAdminIndex(final RequestContext context) {
          final String templateName = "admin-index.ftl";
          final AbstractFreeMarkerRenderer renderer = new ConsoleRenderer(context, templateName);
          final Map<String, String> langs = langPropsService.getAll(Latkes.getLocale());
          final Map<String, Object> dataModel = renderer.getDataModel();
          dataModel.putAll(langs);
          final JSONObject currentUser = Solos.getCurrentUser(context);
          final String userName = currentUser.optString(User.USER_NAME);
          dataModel.put(User.USER_NAME, userName);
          final String roleName = currentUser.optString(User.USER_ROLE);
          dataModel.put(User.USER_ROLE, roleName);
          final String userAvatar = currentUser.optString(UserExt.USER_AVATAR);
          dataModel.put(Common.GRAVATAR, userAvatar);
  
          try {
              final JSONObject preference = optionQueryService.getPreference();
              // 支持配置编辑器模式 https://github.com/88250/solo/issues/95
              String editorMode = preference.optString(Option.ID_C_EDITOR_MODE);
              if (StringUtils.isBlank(editorMode)) {
                  editorMode = "wysiwyg";
              }
              dataModel.put(Option.ID_C_EDITOR_MODE, editorMode);
  
              dataModel.put(Option.ID_C_LOCALE_STRING, preference.getString(Option.ID_C_LOCALE_STRING));
              dataModel.put(Option.ID_C_BLOG_TITLE, preference.getString(Option.ID_C_BLOG_TITLE));
              dataModel.put(Option.ID_C_BLOG_SUBTITLE, preference.getString(Option.ID_C_BLOG_SUBTITLE));
              dataModel.put(Common.VERSION, Server.VERSION);
              dataModel.put(Common.STATIC_RESOURCE_VERSION, Latkes.getStaticResourceVersion());
              dataModel.put(Common.YEAR, String.valueOf(Calendar.getInstance().get(Calendar.YEAR)));
              dataModel.put(Option.ID_C_ARTICLE_LIST_DISPLAY_COUNT, preference.getInt(Option.ID_C_ARTICLE_LIST_DISPLAY_COUNT));
              dataModel.put(Option.ID_C_ARTICLE_LIST_PAGINATION_WINDOW_SIZE, preference.getInt(Option.ID_C_ARTICLE_LIST_PAGINATION_WINDOW_SIZE));
              final JSONObject skin = optionQueryService.getSkin();
              dataModel.put(Option.CATEGORY_C_SKIN, skin.optString(Option.ID_C_SKIN_DIR_NAME));
              Keys.fillRuntime(dataModel);
              dataModel.put(Common.LUTE_AVAILABLE, Markdowns.LUTE_AVAILABLE);
              // 内置 HTTPS+CDN 文件存储 https://github.com/b3log/solo/issues/12556
              dataModel.put(Common.UPLOAD_TOKEN, "");
              dataModel.put(Common.UPLOAD_URL, "");
              dataModel.put(Common.UPLOAD_MSG, langPropsService.get("getUploadTokenErrLabel"));
              final JSONObject upload = Solos.getUploadToken(context);
              if (null != upload) {
                  dataModel.put(Common.UPLOAD_TOKEN, upload.optString(Common.UPLOAD_TOKEN));
                  dataModel.put(Common.UPLOAD_URL, upload.optString(Common.UPLOAD_URL));
                  dataModel.put(Common.UPLOAD_MSG, upload.optString(Common.UPLOAD_MSG));
              }
              dataModelService.fillFaviconURL(dataModel, preference);
              dataModelService.fillUsite(dataModel);
              dataModelService.fillCommon(context, dataModel, preference);
          } catch (final Exception e) {
              LOGGER.log(Level.ERROR, "Admin index render failed", e);
          }
  
          fireFreeMarkerActionEvent(templateName, dataModel);
      }
  
      /**
       * Shows administrator functions with the specified context.
       *
       * @param context the specified context
       */
      public void showAdminFunctions(final RequestContext context) {
          final String requestURI = context.requestURI();
          final String templateName = StringUtils.substringBetween(requestURI, Latkes.getContextPath() + '/', ".") + ".ftl";
          final AbstractFreeMarkerRenderer renderer = new ConsoleRenderer(context, templateName);
  
          final Locale locale = Latkes.getLocale();
          final Map<String, String> langs = langPropsService.getAll(locale);
          final Map<String, Object> dataModel = renderer.getDataModel();
  
          // 使用 MySQL 时不启用 SQL 导出功能 https://github.com/b3log/solo/issues/12806
          dataModel.put("supportExport", Latkes.RuntimeDatabase.H2 == Latkes.getRuntimeDatabase());
          dataModel.putAll(langs);
          Keys.fillRuntime(dataModel);
          dataModel.put(Option.ID_C_LOCALE_STRING, locale.toString());
  
          fireFreeMarkerActionEvent(templateName, dataModel);
      }
  
      /**
       * Shows administrator preference function with the specified context.
       *
       * @param context the specified context
       */
      public void showAdminPreferenceFunction(final RequestContext context) {
          final String templateName = "admin-preference.ftl";
          final AbstractFreeMarkerRenderer renderer = new ConsoleRenderer(context, templateName);
  
          final Locale locale = Latkes.getLocale();
          final Map<String, String> langs = langPropsService.getAll(locale);
          final Map<String, Object> dataModel = renderer.getDataModel();
          dataModel.putAll(langs);
          dataModel.put(Option.ID_C_LOCALE_STRING, locale.toString());
  
          final JSONObject preference = optionQueryService.getPreference();
          final StringBuilder timeZoneIdOptions = new StringBuilder();
          final String[] availableIDs = TimeZone.getAvailableIDs();
          for (int i = 0; i < availableIDs.length; i++) {
              final String id = availableIDs[i];
              String option;
  
              if (id.equals(preference.optString(Option.ID_C_TIME_ZONE_ID))) {
                  option = "<option value=\"" + id + "\" selected=\"true\">" + id + "</option>";
              } else {
                  option = "<option value=\"" + id + "\">" + id + "</option>";
              }
  
              timeZoneIdOptions.append(option);
          }
  
          dataModel.put(Common.LUTE_AVAILABLE, Markdowns.LUTE_AVAILABLE);
          dataModel.put("timeZoneIdOptions", timeZoneIdOptions.toString());
          fireFreeMarkerActionEvent(templateName, dataModel);
      }
  
      /**
       * Imports markdown zip.
       *
       * @param context the specified context
       */
      public void importMarkdownZip(final RequestContext context) {
          context.renderJSON(StatusCodes.ERR);
          final Request request = context.getRequest();
          final FileUpload file = request.getFileUpload("file");
          if (null == file) {
              context.renderMsg(langPropsService.get("allowZipOnlyLabel"));
              return;
          }
          final String fileName = file.getFilename();
          String suffix = StringUtils.substringAfterLast(fileName, ".");
          if (!StringUtils.equalsIgnoreCase(suffix, "zip")) {
              context.renderMsg(langPropsService.get("allowZipOnlyLabel"));
              return;
          }
  
          try {
              final byte[] bytes = file.getData();
              final String tmpDir = System.getProperty("java.io.tmpdir");
              final String date = DateFormatUtils.format(new Date(), "yyyyMMddHHmmss");
              final String zipPath = tmpDir + File.separator + "solo-import-" + date + ".zip";
              final File zipFile = new File(zipPath);
              FileUtils.writeByteArrayToFile(zipFile, bytes);
              final String unzipPath = tmpDir + File.separator + "solo-import-" + date;
              final File unzipDir = new File(unzipPath);
              ZipUtil.unzip(zipFile, unzipDir);
              final JSONObject result = importService.importMarkdownDir(unzipDir);
              final int succCount = result.optInt("succCount");
              final int failCount = result.optInt("failCount");
              FileUtils.deleteQuietly(zipFile);
              FileUtils.deleteQuietly(unzipDir);
              context.renderJSONValue(Keys.CODE, StatusCodes.SUCC);
              String msg = langPropsService.get("importSuccLabel");
              msg = msg.replace("${succCount}", succCount + "");
              if (0 < failCount) {
                  msg = langPropsService.get("importFailLabel");
                  msg = msg.replace("${failCount}", failCount + "");
              }
              context.renderMsg(msg);
          } catch (final Exception e) {
              LOGGER.log(Level.ERROR, "Imports markdown file failed", e);
              context.renderMsg(langPropsService.get("importFailedSeeLogLabel"));
          }
      }
  
      /**
       * Exports data as SQL zip file.
       *
       * @param context the specified request context
       */
      public void exportSQL(final RequestContext context) {
          final Response response = context.getResponse();
  
          if (!Solos.isAdminLoggedIn(context)) {
              context.sendError(401);
              return;
          }
  
          try {
              Thread.sleep(550); // 前端会发两次请求，文件名又是按秒生成，所以两次请求需要错开至少 1 秒避免文件名冲突
          } catch (final Exception e) {
              // ignored
          }
  
          final byte[] zipData = exportService.exportSQL();
          if (null == zipData) {
              context.sendError(500);
              return;
          }
  
          final String date = DateFormatUtils.format(new Date(), "yyyyMMddHHmmss");
          response.setContentType("application/zip");
          final String fileName = "solo-sql-" + date + ".zip";
          response.setHeader("Content-Disposition", "attachment; filename=\"" + fileName + "\"");
          response.sendBytes(zipData);
      }
  
      /**
       * Exports data as JSON zip file.
       *
       * @param context the specified request context
       */
      public void exportJSON(final RequestContext context) {
          final Response response = context.getResponse();
          if (!Solos.isAdminLoggedIn(context)) {
              context.sendError(401);
              return;
          }
  
          try {
              Thread.sleep(550);
          } catch (final Exception e) {
              // ignored
          }
  
          final String tmpDir = System.getProperty("java.io.tmpdir");
          final String date = DateFormatUtils.format(new Date(), "yyyyMMddHHmmss");
          String localFilePath = tmpDir + File.separator + "solo-" + date + ".json";
          LOGGER.trace(localFilePath);
          final File localFile = new File(localFilePath);
  
          try {
              final JSONObject json = exportService.getJSONs();
              final byte[] data = json.toString(4).getBytes(StandardCharsets.UTF_8);
  
              try (final OutputStream output = new FileOutputStream(localFile)) {
                  IOUtils.write(data, output);
              }
  
              try (final FileInputStream inputStream = new FileInputStream(ZipUtil.zip(localFile))) {
                  final byte[] zipData = IOUtils.toByteArray(inputStream);
                  response.setContentType("application/zip");
                  final String fileName = "solo-json-" + date + ".zip";
                  response.setHeader("Content-Disposition", "attachment; filename=\"" + fileName + "\"");
                  response.sendBytes(zipData);
              }
          } catch (final Exception e) {
              LOGGER.log(Level.ERROR, "Export failed", e);
              context.renderJSON(StatusCodes.ERR).renderMsg("Export failed, please check log");
          }
      }
  
      /**
       * Exports data as Hexo markdown zip file.
       *
       * @param context the specified request context
       */
      public void exportHexo(final RequestContext context) {
          final Response response = context.getResponse();
          if (!Solos.isAdminLoggedIn(context)) {
              context.sendError(401);
              return;
          }
  
          try {
              Thread.sleep(550);
          } catch (final Exception e) {
              // ignored
          }
  
          final String tmpDir = System.getProperty("java.io.tmpdir");
          final String date = DateFormatUtils.format(new Date(), "yyyyMMddHHmmss");
          String localFilePath = tmpDir + File.separator + "solo-hexo-" + date;
          LOGGER.trace(localFilePath);
          final File localFile = new File(localFilePath);
  
          final File postDir = new File(localFilePath + File.separator + "posts");
          final File passwordDir = new File(localFilePath + File.separator + "passwords");
          final File draftDir = new File(localFilePath + File.separator + "drafts");
  
          try {
              if (!postDir.mkdirs()) {
                  throw new Exception("Create dir [" + postDir.getPath() + "] failed");
              }
              if (!passwordDir.mkdirs()) {
                  throw new Exception("Create dir [" + passwordDir.getPath() + "] failed");
              }
              if (!draftDir.mkdirs()) {
                  throw new Exception("Create dir [" + draftDir.getPath() + "] failed");
              }
  
              final JSONObject result = exportService.exportHexoMDs();
              final List<JSONObject> posts = (List<JSONObject>) result.opt("posts");
              exportService.exportHexoMd(posts, postDir.getPath());
              final List<JSONObject> passwords = (List<JSONObject>) result.opt("passwords");
              exportService.exportHexoMd(passwords, passwordDir.getPath());
              final List<JSONObject> drafts = (List<JSONObject>) result.opt("drafts");
              exportService.exportHexoMd(drafts, draftDir.getPath());
  
              final File zipFile = ZipUtil.zip(localFile);
              byte[] zipData;
              try (final FileInputStream inputStream = new FileInputStream(zipFile)) {
                  zipData = IOUtils.toByteArray(inputStream);
                  response.setContentType("application/zip");
                  final String fileName = "solo-hexo-" + date + ".zip";
                  response.setHeader("Content-Disposition", "attachment; filename=\"" + fileName + "\"");
              }
  
              response.sendBytes(zipData);
          } catch (final Exception e) {
              LOGGER.log(Level.ERROR, "Export failed", e);
              context.renderJSON(StatusCodes.ERR).renderMsg("Export failed, please check log");
          }
      }
  
      /**
       * Fires FreeMarker action event with the host template name and data model.
       *
       * @param hostTemplateName the specified host template name
       * @param dataModel        the specified data model
       */
      private void fireFreeMarkerActionEvent(final String hostTemplateName, final Map<String, Object> dataModel) {
          final ViewLoadEventData data = new ViewLoadEventData();
  
          data.setViewName(hostTemplateName);
          data.setDataModel(dataModel);
          eventManager.fireEventSynchronously(new Event<>(Keys.FREEMARKER_ACTION, data));
          if (StringUtils.isBlank((String) dataModel.get(Plugin.PLUGINS))) {
              // There is no plugin for this template, fill ${plugins} with blank.
              dataModel.put(Plugin.PLUGINS, "");
          }
      }
  }
  