path: root/src-qt5/desktop-utils/lumina-pdf/Renderer-mupdf.cpp

#include "Renderer.h" 
#include "TextData.h" 
#include <QDateTime>
#include <mupdf/fitz.h>
#include <mupdf/pdf.h>
#include <QMutex>
#include <QFuture>
#include <QtConcurrent>

class Annot{
  public:
    Annot(fz_context *_ctx, pdf_annot *_fzAnnot, char *_text, char *_author, QRectF _loc = QRectF()) : fzAnnot(_fzAnnot), ctx(_ctx), loc(_loc) {
      author = (_author) ? QString::fromLocal8Bit(_author) : QString(); 
      text = (_text) ? QString::fromLocal8Bit(_text) : QString(); 
    }

    ~Annot() {
      fz_drop_annot(ctx, (fz_annot*)fzAnnot);
    }

    QString getAuthor() { return author; }
    QString getText() { return text; }
    QRectF getLoc() { return loc; }

  private:
    pdf_annot *fzAnnot;
    fz_context *ctx;
    QString author;
    QString text;
    QRectF loc;
};

class Link {
  public:
    Link(fz_context *_ctx, fz_link *_fzLink, char *_uri, int _page, QRectF _loc = QRectF()) : fzLink(_fzLink), ctx(_ctx) {
      QString uri = QString::fromLocal8Bit(_uri); 
      data = new TextData(_loc, _page, uri);
    }

    ~Link() {
      fz_drop_link(ctx, fzLink);
      delete data;
    }

    TextData* getData() { return data; }

  private:
    TextData *data;
    fz_link *fzLink;
    fz_context *ctx;
};

class Data {
  public:
    Data(int _pagenum, fz_context *_ctx, fz_display_list *_list, fz_rect _bbox, fz_matrix _ctm, double _sf, fz_link *_link, QList<Annot*> &_annot) : pagenumber(_pagenum), ctx(_ctx), list(_list), bbox(_bbox), ctm(_ctm), sf(_sf), annotList(_annot) {

      while(_link) {
        QRectF rect(sf*_link->rect.x0, sf*_link->rect.y0, sf*(_link->rect.x1 - _link->rect.x0), sf*(_link->rect.y1 - _link->rect.y0));
        Link *link = new Link(_ctx, _link, _link->uri, _pagenum, rect);
        linkList.append(link);
        _link = _link->next;
      }

    }

    ~Data() { 
      fz_drop_pixmap(ctx, pix);
      fz_drop_display_list(ctx, list);
      qDeleteAll(linkList);
      linkList.clear();
      qDeleteAll(annotList);
      annotList.clear();
    }

    int getPage() { return pagenumber; }
    QList<Link*> getLinkList() { return linkList; }
    QList<Annot*> getAnnotList() { return annotList; }
    fz_context* getContext() { return ctx; }
    fz_display_list* getDisplayList() { return list; }
    QRectF getScaledRect() { return QRectF(sf*bbox.x0, sf*bbox.y0, sf*(bbox.x1-bbox.x0), sf*(bbox.y1 - bbox.y0)); }
    fz_rect getBoundingBox() { return bbox; }
    fz_matrix getMatrix() { return ctm; }
    QImage getImage() { return img; }

    void setImage(QImage _img) { img = _img; }
    void setRenderThread(QFuture<void> thread) { renderThread = thread; }
    void setPixmap(fz_pixmap *_pix) { pix = _pix; }
    
  private:
    int pagenumber;
    fz_context *ctx;
    fz_display_list *list;
    fz_rect bbox;
    fz_matrix ctm;
    QList<Link*> linkList;
    double sf;
    QList<Annot*> annotList;

    fz_pixmap *pix;
    QImage img;
    QFuture<void> renderThread;
};

fz_document *DOC;
fz_context *CTX;
QHash<int, Data*> dataHash;
QMutex mutex[FZ_LOCK_MAX];
fz_locks_context locks;

inline QString getTextInfo(QString str) {
  char infoBuff[1000];
  int size = DOC->lookup_metadata(CTX, DOC, ("info:"+str).toLocal8Bit().data(), infoBuff, 1000);
  if(size != -1){ return QString::fromLatin1(infoBuff); }
  return "";
}

void lock_mutex(void *user, int lock) {
  QMutex *mutex = (QMutex*) user;
  mutex[lock].lock();
}

void unlock_mutex(void *user, int lock) {
  QMutex *mutex = (QMutex*) user;
  mutex[lock].unlock();
}

Renderer::Renderer(){
  locks.user = mutex;
  locks.lock = lock_mutex;
  locks.unlock = unlock_mutex;

  DOC = 0;
  qDebug() << "Creating Context";
  CTX = fz_new_context(NULL, &locks, FZ_STORE_UNLIMITED);
  needpass = false;
  degrees = 0;
}

Renderer::~Renderer(){
  qDebug() << "Dropping Context";
  clearHash();
  fz_drop_document(CTX, DOC);
  DOC = NULL;
  fz_drop_context(CTX);
  CTX = NULL;
}

bool Renderer::loadMultiThread(){ return false; }

void Renderer::handleLink(QString link) {
  float xp = 0.0, yp = 0.0;
  int pagenum = 0;

  QByteArray linkData = link.toLocal8Bit();
  char *uri = linkData.data();

  if(!link.isEmpty()) {
    pagenum = fz_resolve_link(CTX, DOC, uri, &xp, &yp);
    if(pagenum != -1)
      emit goToPosition(pagenum+1, xp, yp);
  }
}

//Traverse the outline tree through Preorder traversal
void Renderer::traverseOutline(void *link, int level) {
  fz_outline *olink = (fz_outline*)link;

  Bookmark *bm = new Bookmark(olink->title, olink->uri, olink->page, level);
  bookmarks.push_back(bm);

  if(olink->down)
    traverseOutline(olink->down, level+1);
  
  if(olink->next)
    traverseOutline(olink->next, level); 
}

bool Renderer::loadDocument(QString path, QString password){
  //first time through
  if(path != docpath) {
    if(DOC != 0) {
      qDebug() << "New document";
      fz_drop_document(CTX, DOC);
      DOC = NULL;
      needpass = false;
      docpath = path;
      if(bookmarks.size() > 0) {
        qDeleteAll(bookmarks);
        bookmarks.clear();
      }
    }else if(DOC==0){ 
      fz_register_document_handlers(CTX); 
      qDebug() << "Document handlers registered";
    }

    docpath = path;
    DOC = fz_open_document(CTX, path.toLocal8Bit().data());
    qDebug() << "File opened" << DOC;
    if(DOC==0){
      qDebug() << "Could not open file:" << path;
      return false;
    }
    needpass = (fz_needs_password(CTX, DOC) != 0);

    if(needpass && password.isEmpty()){ 
      return false; 
    }else if(needpass){
      needpass = !fz_authenticate_password(CTX, DOC, password.toLocal8Bit());
      if(needpass){ return false; } //incorrect password
    }

    qDebug() << "Password Check cleared";
    pnum = fz_count_pages(CTX, DOC);
    qDebug() << "Page count: " << pnum;

    doctitle.clear();

    qDebug() << "Opening File:" << path;
    jobj.insert("subject", getTextInfo("Subject") );
    jobj.insert("author", getTextInfo("Author") );
    jobj.insert("creator", getTextInfo("Creator") );
    jobj.insert("producer", getTextInfo("Producer") );
    jobj.insert("keywords", getTextInfo("Keywords") );
    jobj.insert("dt_created", QDateTime::fromString( getTextInfo("CreationDate").left(16), "'D:'yyyyMMddHHmmss").toString() );
    jobj.insert("dt_modified", QDateTime::fromString( getTextInfo("ModDate").left(16), "'D:'yyyyMMddHHmmss").toString() );

    if(!jobj["title"].toString().isEmpty())
      doctitle = jobj["title"].toString();
    else
      doctitle = path.section("/",-1);

    //Possibly check Page orientation

    fz_outline *outline = fz_load_outline(CTX, DOC);
    if(outline) 
      traverseOutline(outline, 0);
    else
      qDebug() << "No Bookmarks";

    fz_drop_outline(CTX, outline);

    return true;
  }
  return false;
}

void renderer(Data *data, Renderer *obj)
{
  int pagenum = data->getPage();
  //qDebug() << "Rendering:" << pagenum;
  fz_context *ctx = data->getContext();
  fz_rect bbox = data->getBoundingBox();
  fz_matrix ctm = data->getMatrix();
  fz_device *dev;
  fz_irect rbox;

  ctx = fz_clone_context(ctx);
  fz_pixmap *pixmap = fz_new_pixmap_with_bbox(ctx, fz_device_rgb(ctx), fz_round_rect(&rbox, &bbox), NULL, 0);
  fz_clear_pixmap_with_value(ctx, pixmap, 0xff);

  dev = fz_new_draw_device(ctx, &fz_identity, pixmap);
  fz_run_display_list(ctx, data->getDisplayList(), dev, &ctm, &bbox, NULL);

  data->setImage(QImage(pixmap->samples, pixmap->w, pixmap->h, pixmap->stride, QImage::Format_RGB888));
  data->setPixmap(pixmap);
  dataHash.insert(pagenum, data);

  fz_close_device(ctx, dev);
  fz_drop_device(ctx, dev);
  fz_drop_context(ctx);

  //qDebug() << "Finished rendering:" << pagenum;
  emit obj->PageLoaded(pagenum);
}

void Renderer::renderPage(int pagenum, QSize DPI, int degrees){
  //qDebug() << "- Rendering Page:" << pagenum << degrees;
  Data *data;
  fz_matrix matrix;
  fz_rect bbox;
  fz_display_list *list;

  //double pageDPI = 96.0;
  //double sf = DPI.width() / pageDPI;
  double sf = 1;
  //fz_scale(&matrix, sf, sf);
  fz_rotate(&matrix, degrees);

  fz_page *PAGE = fz_load_page(CTX, DOC, pagenum);
  fz_bound_page(CTX, PAGE, &bbox);
  emit OrigSize(QSizeF(bbox.x1 - bbox.x0, bbox.y1 - bbox.y0));

  fz_transform_rect(&bbox, &matrix);
  list = fz_new_display_list(CTX, &bbox);
  fz_device *dev = fz_new_list_device(CTX, list);
  fz_run_page(CTX, PAGE, dev, &fz_identity, NULL);  

  fz_link *link = fz_load_links(CTX, PAGE); 
  pdf_annot *_annot = pdf_first_annot(CTX, (pdf_page*)PAGE);
  QList<Annot*> annotList;

  //qDebug() << "Starting annotations for:" << pagenum;
  while(_annot) {
    pdf_run_annot(CTX, _annot, dev, &fz_identity, NULL);
    fz_rect anotBox;
    pdf_bound_annot(CTX, _annot, &anotBox);
    QRectF rect(sf*anotBox.x0, sf*anotBox.y0, sf*(anotBox.x1-anotBox.x0), sf*(anotBox.y1 - anotBox.y0));
    char *contents = NULL, *author = NULL; 
    fz_try(CTX)
      contents = pdf_copy_annot_contents(CTX, _annot);
    fz_catch(CTX) { }
    fz_try(CTX)
      author = pdf_copy_annot_author(CTX, _annot);
    fz_catch(CTX) { }
   
    Annot *annot = new Annot(CTX, _annot, contents, author, rect);
    annotList.append(annot);
    _annot = _annot->next;
  }

  fz_close_device(CTX, dev);
  fz_drop_device(CTX, dev);
  fz_drop_page(CTX, PAGE);

  data = new Data(pagenum, CTX, list, bbox, matrix, sf, link, annotList);
  data->setRenderThread(QtConcurrent::run(&renderer, data, this));
}

QList<TextData*> Renderer::searchDocument(QString text, bool matchCase){
  fz_rect rectBuffer[1000];
  QList<TextData*> results;
  for(int i = 0; i < pnum; i++) {
    int count = fz_search_display_list(CTX, dataHash[i]->getDisplayList(), text.toLocal8Bit().data(), rectBuffer, 1000);
    //qDebug() << "Page " << i+1 << ": Count, " << count;
    for(int j = 0; j < count; j++) {
      TextData *t = new TextData(dataHash[i]->getScaledRect(), i+1, text);
      //MuPDF search does not match case, so retrieve the exact text at the location found and determine whether or not it matches the case of the search text if the user selected to match case
      if(matchCase){
        fz_stext_page *sPage = fz_new_stext_page_from_display_list(CTX, dataHash[i]->getDisplayList(), NULL);
        QString currentStr = QString(fz_copy_selection(CTX, sPage, *fz_rect_min(&rectBuffer[j]), *fz_rect_max(&rectBuffer[j]), false));
        if(currentStr.contains(text, Qt::CaseSensitive)){ results.append(t); }
      }else{
          results.append(t);
      }
    }
  }
  return results;
}

QImage Renderer::imageHash(int pagenum) {
  return dataHash[pagenum]->getImage();
}

int Renderer::hashSize() {
  return dataHash.size();
}

void Renderer::clearHash() {
  qDeleteAll(dataHash);
  dataHash.clear();
}

TextData* Renderer::linkList(int pagenum, int entry) {
  return dataHash[pagenum]->getLinkList()[entry]->getData();
}

int Renderer::linkSize(int pagenum) {
  return dataHash[pagenum]->getLinkList().size();
}

QList<QString> Renderer::annotList(int pagenum, int entry) {
  return QList<QString>() << dataHash[pagenum]->getAnnotList()[entry]->getAuthor() << dataHash[pagenum]->getAnnotList()[entry]->getText();
}

QRectF Renderer::annotLoc(int pagenum, int entry) {
  return dataHash[pagenum]->getAnnotList()[entry]->getLoc();
}

int Renderer::annotSize(int pagenum) {
  return dataHash[pagenum]->getAnnotList().size();
}

bool Renderer::isExternalLink(int pagenum, QString text) { 
  QList<Link*> linkList = dataHash[pagenum]->getLinkList();
  foreach(Link *link, linkList) {
    if(link->getData()->text() == text)
      return fz_is_external_link(CTX, link->getData()->text().toLocal8Bit().data());
  }
  return false;
}

bool Renderer::supportsExtraFeatures() { return true; }