com.caucho.admin.action.PdfReportAction Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 1998-2018 Caucho Technology -- all rights reserved
 *
 * @author Scott Ferguson
 */

package com.caucho.admin.action;

import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;

import javax.mail.Session;
import javax.mail.internet.InternetAddress;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import com.caucho.config.ConfigException;
import com.caucho.hemp.services.MailService;
import com.caucho.quercus.QuercusContext;
import com.caucho.quercus.env.Env;
import com.caucho.quercus.env.Value;
import com.caucho.quercus.page.QuercusPage;
import com.caucho.quercus.servlet.api.QuercusHttpServletRequest;
import com.caucho.quercus.servlet.api.QuercusHttpServletRequestImpl;
import com.caucho.quercus.servlet.api.QuercusHttpServletResponse;
import com.caucho.quercus.servlet.api.QuercusHttpServletResponseImpl;
import com.caucho.server.http.StubServletRequest;
import com.caucho.server.http.StubServletResponse;
import com.caucho.server.resin.Resin;
import com.caucho.util.CurrentTime;
import com.caucho.util.IoUtil;
import com.caucho.util.L10N;
import com.caucho.util.QDate;
import com.caucho.vfs.Path;
import com.caucho.vfs.TempOutputStream;
import com.caucho.vfs.TempStream;
import com.caucho.vfs.Vfs;
import com.caucho.vfs.WriteStream;

public class PdfReportAction implements AdminAction
{
  private static final L10N L = new L10N(PdfReportAction.class);
  private static final Logger log
    = Logger.getLogger(PdfReportAction.class.getName());

  private static final long HOUR = 3600 * 1000L;
  private static final long DAY = 24 * 3600 * 1000L;

  private String _serverId;
  private String _logDirectory;

  private String _path;
  private long _period;
  private String _report;
  private String _title;

  private MailService _mailService;
  private String _mailTo;
  private String _mailFrom;

  private boolean _isSnapshot;
  private boolean _isSnapshotHeapDump = true;
  private long _profileTime;
  private long _profileTick;

  private boolean _isWatchdog;

  private boolean _isReturnPdf;

  private QuercusContext _quercus;

  private Path _phpPath;
  private Path _logPath;
  private String _fileName;
  private Session _session;
  private boolean _isSnapshotJmx;

  public String getPath()
  {
    return _path;
  }

  public void setPath(String path)
  {
    _path = path;
  }

  public String getReport()
  {
    return _report;
  }

  public void setReport(String report)
  {
    _report = report;
  }

  public void setServerId(String serverId)
  {
    _serverId = serverId;
  }

  public String getTitle()
  {
    return _title;
  }

  public void setTitle(String title)
  {
    _title = title;
  }

  public long getPeriod()
  {
    return _period;
  }

  public void setPeriod(long period)
  {
    _period = period;
  }

  public boolean isSnapshot()
  {
    return _isSnapshot;
  }

  public void setSnapshot(boolean isSnapshot)
  {
    _isSnapshot = isSnapshot;
  }

  public void setSnapshotHeapDump(boolean isHeapDump)
  {
    _isSnapshotHeapDump = isHeapDump;
  }

  public boolean isSnapshotHeapDump()
  {
    return _isSnapshotHeapDump;
  }

  public void setSnapshotJmx(boolean isJmx)
  {
    _isSnapshotJmx = isJmx;
  }

  public boolean isSnapshotJmx()
  {
    return _isSnapshotJmx;
  }

  public void setWatchdog(boolean isWatchdog)
  {
    _isWatchdog = isWatchdog;
  }

  public boolean isWatchdog()
  {
    return _isWatchdog;
  }

  public long getProfileTime()
  {
    return _profileTime;
  }

  public void setProfileTime(long profileTime)
  {
    _profileTime = profileTime;
  }

  public long getProfileTick()
  {
    return _profileTick;
  }

  public void setProfileTick(long profileTick)
  {
    _profileTick = profileTick;
  }

  public String getLogDirectory()
  {
    return _logDirectory;
  }

  public Path getLogPath()
  {
    return _logPath;
  }

  public void setLogDirectory(String logDirectory)
  {
    _logDirectory = logDirectory;
  }

  public String getMailTo()
  {
    return _mailTo;
  }

  public void setMailTo(String mailTo)
  {
    if (! "".equals(mailTo))
      _mailTo = mailTo;
  }

  public String getMailFrom()
  {
    return _mailFrom;
  }

  public void setMailFrom(String mailFrom)
  {
    if (! "".equals(mailFrom))
      _mailFrom = mailFrom;
  }

  public void setMailSession(Session session)
  {
    _session = session;
  }

  public boolean isReturnPdf()
  {
    return _isReturnPdf;
  }

  public void setReturnPdf(boolean returnPdf)
  {
    _isReturnPdf = returnPdf;
  }

  private String calculateReport()
  {
    if (_report != null)
      return _report;
    else if (isWatchdog())
      return "Watchdog";
    else
      return "Snapshot";
  }

  private String calculateTitle()
  {
    if (_title != null)
      return _title;
    else
      return calculateReport();
  }

  private long calculatePeriod()
  {
    if (_period != 0)
      return _period;
    else if (isWatchdog())
      return 2 * HOUR;
    else
      return DAY;
  }


  public void init()
  {
    Resin resin = Resin.getCurrent();
    
    if (resin != null) {
      if (_serverId == null) {
        _serverId = resin.getServerId();
      }

      if (_logDirectory == null)
        _logPath = resin.getLogDirectory();
    } else {
      if (_serverId == null) {
        _serverId = "unknown";
      }

      if (_logDirectory == null)
        _logPath = Vfs.getPwd();
    }

    // If Resin is running then path is optional and should default
    // to ${resin.home}/doc/admin/pdf-gen.php
    //
    // If Resin is not running, then path is required

    if (_path != null) {
      _phpPath = Vfs.lookup(_path);
    }
    else if (resin != null) {
      if (_path == null) {
        Path path = resin.getRootDirectory().lookup("doc/admin/pdf-gen.php");

        if (path.canRead()) {
          _path = path.getNativePath();
        }
      }

      if (_path == null) {
        Path path = resin.getResinHome().lookup("doc/admin/pdf-gen.php");

        if (path.canRead()) {
          _path = path.getNativePath();
        }
      }

      if (_path == null) {
        Path path = resin.getResinHome().lookup("php/admin/pdf-gen.php");

        if (path.canRead())
          _path = path.getNativePath();
      }

      if (_path != null)
        _phpPath = Vfs.lookup(_path);
    }

    if (_phpPath == null) {
      log.warning(L.l("{0} requires a 'path' attribute to a PDF generating .php file or '{1}'",
                      getClass().getSimpleName(),
                      resin.getResinHome().lookup("php/admin/pdf-gen.php").getNativePath()));
    }

    if (_logPath == null)
      _logPath = Vfs.lookup(_logDirectory);
    
    if (_mailService == null) {
      _mailService = new MailService();
    }
    
    if (_mailTo != null) {
      try {
        _mailService.addTo(new InternetAddress(_mailTo));
      } catch (Exception e) {
        log.log(Level.WARNING, e.toString(), e);
      }
    }

    if (_mailFrom != null) {
      try {
        _mailService.addFrom(new InternetAddress(_mailFrom));
      } catch (Exception e) {
        log.log(Level.WARNING, e.toString(), e);
      }
    }
    
    if (_session != null) {
      _mailService.setSession(_session);
    }
    
    if (_mailTo != null || _mailFrom != null) {
      try {
        _mailService.init();
      } catch (Exception e) {
        log.log(Level.WARNING, e.toString(), e);
      }
    }
  }

  public String getReportFileName(long now)
  {
    if (_fileName == null) {
      String date = QDate.formatLocal(now, "%Y%m%dT%H%M");

      String serverId = "default";

      Resin resin = Resin.getCurrent();
      if (resin != null)
        serverId = resin.getServerIdFilePart();

      return String.format("%s-%s-%s.pdf",
                           serverId,
                           calculateTitle(),
                           date);
    }

    return _fileName;
  }

  public PdfReportActionResult execute()
    throws IOException
  {
    Env env = null;
    WriteStream ws = null;
    TempOutputStream pdfOut = null;

    if (_phpPath == null) {
      Resin resin = Resin.getCurrent();

      Path path = resin.getRootDirectory().lookup("doc/admin/pdf-gen.php");

      throw new ConfigException(L.l("{0} report generation failed because the PHP file cannot be found.\n  Expected {1}",
                                     calculateReport(),
                                     path.getNativePath()));
    }

    try {
      QuercusPage page = getQuercusContext().parse(_phpPath);

      TempStream ts = new TempStream();
      ts.openWrite();
      ws = new WriteStream(ts);
      
      long now = CurrentTime.getCurrentTime();

      HttpServletRequest request = new StubServletRequest();
      HttpServletResponse response = new StubServletResponse();

      QuercusHttpServletRequest qRequest = new QuercusHttpServletRequestImpl(request);
      QuercusHttpServletResponse qResponse = new QuercusHttpServletResponseImpl(response);

      env = _quercus.createEnv(page, ws, qRequest, qResponse);
      //env.setGlobalValue("health_service", env.wrapJava(healthService));
      
      if (_serverId != null && ! _serverId.equals("unknown")) {
        env.setGlobalValue("g_server_id", env.wrapJava(_serverId));
      }

      env.setGlobalValue("time", env.wrapJava(now / 1000));
      
      env.setGlobalValue("g_report", env.wrapJava(calculateReport()));
      env.setGlobalValue("g_title", env.wrapJava(calculateTitle()));
      env.setGlobalValue("period", env.wrapJava(calculatePeriod() / 1000));

      env.setGlobalValue("g_is_snapshot", env.wrapJava(isSnapshot()));
      env.setGlobalValue("g_is_snapshot_heapdump", env.wrapJava(isSnapshotHeapDump()));
      env.setGlobalValue("g_is_snapshot_jmx", env.wrapJava(isSnapshotJmx()));
      env.setGlobalValue("g_is_watchdog", env.wrapJava(isWatchdog()));

      if (getProfileTime() > 0) {
        env.setGlobalValue("profile_time",
                           env.wrapJava(getProfileTime() / 1000));
      }

      if (getProfileTick() > 0) {
        env.setGlobalValue("profile_tick", env.wrapJava(getProfileTick()));
      }

      env.start();

      Value result = env.executeTop();

      if (! result.toString().equals("ok")) {
        throw new RuntimeException(L.l("{0} report generation failed: {1}",
                                       calculateReport(),
                                       result.toString()));
      }

      ws.flush();

      if (_mailTo != null && ! "".equals(_mailTo)) {
        mailPdf(ts, now);

        String message = L.l("{0} report mailed to {1}",
                             calculateReport(),
                             _mailTo);

        PdfReportActionResult actionResult =
          new PdfReportActionResult(message, null, null);

        return actionResult;
      }

      Path path = writePdfToFile(ts, now);

      if (_isReturnPdf) {
        pdfOut = new TempOutputStream();
        ts.writeToStream(pdfOut);
      }

      String message = L.l("{0} report generated at {1}",
                           calculateReport(),
                           path);

      PdfReportActionResult actionResult
        = new PdfReportActionResult(message, path.getPath(), pdfOut);

      return actionResult;
    } finally {
      IoUtil.close(ws);
      IoUtil.close(pdfOut);

      if (env != null)
        env.close();

    }
  }

  private QuercusContext getQuercusContext()
  {
    synchronized (this) {
      if (_quercus == null) {
        _quercus = new QuercusContext();
        _quercus.setPwd(_phpPath.getParent());
        _quercus.init();
        _quercus.start();
      }
    }

    return _quercus;
  }

  private void mailPdf(TempStream ts, long now)
    throws IOException
  {
    String fileName = getReportFileName(now);

    String userDate = QDate.formatLocal(now,
                                        "%Y-%m-%d %H:%M");

    String subject = "[Resin] PDF Report: " + calculateTitle() + "@" + _serverId
                     + " " + userDate;

    StringBuilder text = new StringBuilder();

    text.append("Resin generated PDF Report");
    text.append("\n");
    text.append("\nReport: ").append(calculateReport());
    text.append("\nGenerated: ").append(userDate);
    text.append("\nServer: ").append(_serverId);

    _mailService.sendWithAttachment(subject,
                                    text.toString(),
                                    "application/pdf",
                                    fileName,
                                    ts.openInputStream());
  }

  private Path writePdfToFile(TempStream ts, long now)
    throws IOException
  {
    String fileName = getReportFileName(now);

    Path path = _logPath.lookup(fileName);

    path.getParent().mkdirs();

    WriteStream os = path.openWrite();
    try {
      ts.writeToStream(os);
    } finally {
      IoUtil.close(os);
    }

    return path;
  }

  public static class PdfReportActionResult
  {
    private String _message;
    private String _fileName;
    private TempOutputStream _pdfOutputStream;

    public PdfReportActionResult(String message,
                                 String fileName,
                                 TempOutputStream out)
    {
      _message = message;
      _fileName = fileName;
      _pdfOutputStream = out;
    }

    public String getMessage()
    {
      return _message;
    }

    public TempOutputStream getPdfOutputStream()
    {
      return _pdfOutputStream;
    }

    public String getFileName()
    {
      return _fileName;
    }
  }
}